Python 文档目录

Python的新变化

Python 3.10 有什么新变化

摘要 -- 发布重点

新的特性

带圆括号的上下文管理器

更清楚的错误消息

SyntaxError

IndentationError

AttributeError

NameError

PEP 626：在调试和其他工具中使用精确的行号

PEP 634：结构化模式匹配

语法与操作

声明性方式

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

无通配符的行为

带有字面值和变量的模式

模式和类

带有位置参数的模式

嵌套模式

复杂模式和通配符

约束项

其他关键特性

可选的 EncodingWarning 和 encoding="locale" 选项

有关类型提示的新增特性

PEP 604: 新的类型联合运算符

PEP 612: 形参规格变量

PEP 613: 类型别名

PEP 647: 用户自定义的类型保护器

其他语言特性修改

新增模块

改进的模块

asyncio

argparse

array

asynchat、asyncore 和 smtpd

base64

bdb

bisect

编码器

collections.abc

contextlib

curses

dataclasses

__slots__

仅限关键字字段

distutils

doctest

encodings

fileinput

faulthandler

gc

glob

hashlib

hmac

IDLE 与 idlelib

importlib.metadata

inspect

itertools

linecache

os

os.path

pathlib

平台

pprint

py_compile

pyclbr

shelve

statistics

site

socket

ssl

sqlite3

sys

tempfile

_thread

threading

回溯

types

typing

unittest

urllib.parse

xml

zipimport

性能优化

弃用

移除

移植到 Python 3.10

Python 语法中的变化

Python API 的变化

C API 的变化

CPython 字节码的改变

构建的改变

C API 的改变

PEP 652：稳定版 ABI 的维护

新的特性

移植到 Python 3.10

弃用

移除

3.10.7 中的重要安全特性

3.10.8 中的重要安全特性

Notable Changes in 3.10.12

tarfile

Notable changes in 3.10.15

ipaddress

email

Notable changes in 3.10.18

os.path

tarfile

Python 3.9 有什么新变化

摘要 -- 发布重点

请检查代码中的 DeprecationWarning。

新的特性

字典合并与更新运算符

新增用于移除前缀和后缀的字符串方法

标准多项集中的类型标注泛型

新的解析器

其他语言特性修改

新增模块

zoneinfo

graphlib

改进的模块

ast

asyncio

compileall

concurrent.futures

curses

datetime

distutils

fcntl

ftplib

gc

hashlib

http

IDLE 与 idlelib

imaplib

importlib

inspect

ipaddress

math

multiprocessing

nntplib

os

pathlib

pdb

poplib

pprint

pydoc

random

signal

smtplib

socket

time

sys

tracemalloc

typing

unicodedata

venv

xml

性能优化

弃用

移除

移植到 Python 3.9

Python API 的变化

C API 的变化

CPython 字节码的改变

构建的改变

C API 的改变

新的特性

移植到 Python 3.9

移除

Python 3.9.1 中的重要变化

typing

macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持

Python 3.9.2 中的重要变化

collections.abc

urllib.parse

Python 3.8 有什么新变化

摘要 -- 发布重点

新的特性

赋值表达式

仅限位置形参

用于已编译字节码文件的并行文件系统缓存

调试构建使用与发布构建相同的 ABI

f-字符串支持 = 用于自动记录表达式和调试文档

PEP 578: Python 运行时审核钩子

PEP 587: Python 初始化配置

PEP 590: Vectorcall: 用于 CPython 的快速调用协议

具有外部数据缓冲区的 pickle 协议 5

其他语言特性修改

新增模块

改进的模块

ast

asyncio

builtins

collections

cProfile

csv

curses

ctypes

datetime

functools

gc

gettext

gzip

IDLE 与 idlelib

inspect

io

itertools

json.tool

logging

math

mmap

multiprocessing

os

os.path

pathlib

pickle

plistlib

pprint

py_compile

shlex

shutil

socket

ssl

statistics

sys

tarfile

threading

tokenize

tkinter

time

typing

unicodedata

unittest

venv

weakref

xml

xmlrpc

性能优化

构建和 C API 的改变

弃用

API 与特性的移除

移植到 Python 3.8

Python 行为的改变

Python API 的变化

C API 的变化

CPython 字节码的改变

演示和工具

Python 3.8.1 中的重要变化

Python 3.8.8 中的重要变化

Python 3.8.12 中的重要变化

Python 3.7 有什么新变化

摘要 - 发布重点

新的特性

PEP 563：延迟的标注求值

PEP 538: 传统 C 区域强制转换

PEP 540: 强制 UTF-8 运行时模式

PEP 553: 内置的 breakpoint()

PEP 539: 用于线程局部存储的新 C API

PEP 562: 定制对模块属性的访问

PEP 564: 具有纳秒级精度的新时间函数

PEP 565: 在 __main__ 中显示 DeprecationWarning

PEP 560: 对 typing 模块和泛型类型的核心支持

PEP 552: 基于哈希值的 .pyc 文件

PEP 545: Python 文档翻译

Python 开发模式 (-X dev)

其他语言特性修改

新增模块

contextvars

dataclasses

importlib.resources

改进的模块

argparse

asyncio

binascii

calendar

collections

compileall

concurrent.futures

contextlib

cProfile

crypt

datetime

dbm

decimal

dis

distutils

enum

functools

gc

hmac

http.client

http.server

idlelib 与 IDLE

importlib

io

ipaddress

itertools

locale

logging

math

mimetypes

msilib

multiprocessing

os

pathlib

pdb

py_compile

pydoc

queue

re

signal

socket

socketserver

sqlite3

ssl

string

subprocess

sys

time

tkinter

tracemalloc

types

unicodedata

unittest

unittest.mock

urllib.parse

uu

uuid

warnings

xml.etree

xmlrpc.server

zipapp

zipfile

C API 的改变

构建的改变

性能优化

其他 CPython 实现的改变

已弃用的 Python 行为

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

aifc

asyncio

collections

dbm

enum

gettext

importlib

locale

macpath

threading

socket

ssl

sunau

sys

wave

已弃用的 C API 函数和类型

平台支持的移除

API 与特性的移除

移除的模块

Windows 专属的改变

移植到 Python 3.7

Python 行为的更改

Python API 的变化

C API 的变化

CPython 字节码的改变

Windows 专属的改变

其他 CPython 实现的改变

Python 3.7.1 中的重要变化

Python 3.7.2 中的重要变化

Python 3.7.6 中的重要变化

Python 3.7.10 中的重要变化

Python 3.6 有什么新变化

摘要 -- 发布重点

新的特性

PEP 498: 格式化字符串字面值

PEP 526: 变量标注的语法

PEP 515: 数字字面值中的下划线。

PEP 525: 异步生成器

PEP 530: 异步推导式

PEP 487: 更简单的自定义类创建

PEP 487: 描述器协议的增强

PEP 519: 添加文件系统路径协议

PEP 495: 消除本地时间的歧义

PEP 529: 将 Windows 文件系统编码格式更改为 UTF-8

PEP 528: 将 Windows 控制台编码格式更改为 UTF-8

PEP 520: 保留类属性定义顺序

PEP 468: 保留关键字参数顺序

新的 dict 实现

PEP 523: 向 CPython 添加帧求值 API

PYTHONMALLOC 环境变量

DTrace 和 SystemTap 探测支持

其他语言特性修改

新增模块

secrets

改进的模块

array

ast

asyncio

binascii

cmath

collections

concurrent.futures

contextlib

datetime

decimal

distutils

email

encodings

enum

faulthandler

fileinput

hashlib

http.client

idlelib 与 IDLE

importlib

inspect

json

logging

math

multiprocessing

os

pathlib

pdb

pickle

pickletools

pydoc

random

re

readline

rlcompleter

shlex

site

sqlite3

socket

socketserver

ssl

statistics

struct

subprocess

sys

telnetlib

time

timeit

tkinter

回溯

tracemalloc

typing

unicodedata

unittest.mock

urllib.request

urllib.robotparser

venv

warnings

winreg

winsound

xmlrpc.client

zipfile

zlib

性能优化

构建和 C API 的改变

其他改进

弃用

新关键字

已弃用的 Python 行为

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

asynchat

asyncore

dbm

distutils

grp

importlib

os

re

ssl

tkinter

venv

已弃用的 C API 函数和类型

弃用的构建选项

移除

API 与特性的移除

移植到Python 3.6

 'python' 命令行为的变化

Python API 的变化

C API 的变化

CPython 字节码的改变

Python 3.6.2 中的重要变化

新增 make regen-all 构建目标

移除了 make touch 构建目标

Python 3.6.4 中的重要变化

Python 3.6.5 中的重要变化

Python 3.6.7 中的重要变化

Python 3.6.10 中的重要变化

Python 3.6.13 中的重要变化

Python 3.5 有什么新变化

摘要 -- 发布重点

新的特性

PEP 492 - 使用 async 和 await 语法实现协程

PEP 465 - 用于矩阵乘法的专用中缀运算符

PEP 448 - 进一步的解包标准化

PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持

PEP 484 —— 类型提示

PEP 471 - os.scandir() 函数 -- 一个更好且更快的目录迭代器

PEP 475: 重试返回 EINTR 失败码的系统调用

PEP 479：更改生成器内部的 StopIteration 处理

PEP 485：用于测试近似相等的函数

PEP 486：让 Python 启动器识别虚拟环境

PEP 488：去除 PYO 文件

PEP 489：多阶段扩展模块初始化

其他语言特性修改

新增模块

typing

zipapp

改进的模块

argparse

asyncio

bz2

cgi

cmath

code

collections

collections.abc

compileall

concurrent.futures

configparser

contextlib

csv

curses

dbm

difflib

distutils

doctest

email

enum

faulthandler

functools

glob

gzip

heapq

http

http.client

idlelib 与 IDLE

imaplib

imghdr

importlib

inspect

io

ipaddress

json

linecache

locale

logging

lzma

math

multiprocessing

operator

os

pathlib

pickle

poplib

re

readline

selectors

shutil

signal

smtpd

smtplib

sndhdr

socket

ssl

内存 BIO 支持

应用层协议协商支持

其他改变

sqlite3

subprocess

sys

sysconfig

tarfile

threading

time

timeit

tkinter

回溯

types

unicodedata

unittest

unittest.mock

urllib

wsgiref

xmlrpc

xml.sax

zipfile

其他模块级更改

性能优化

构建和 C API 的改变

弃用

新关键字

已弃用的 Python 行为

不支持的操作系统

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

移除

API 与特性的移除

移植到Python 3.5

Python 行为的改变

Python API 的变化

C API 的变化

Python 3.5.4 的显著变化

新增 make regen-all 构建目标

移除了 make touch 构建目标

Python 3.4 有什么新变化

摘要 - 发布重点

新的特性

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

默认对 pip 进行初始设置

文档更改

PEP 446: 新创建的文件描述符将设为不可继承

编解码器处理方式的改进

PEP 451: 针对导入系统的 ModuleSpec 类型

其他语言特性修改

新增模块

asyncio

ensurepip

enum

pathlib

selectors

statistics

tracemalloc

改进的模块

abc

aifc

argparse

audioop

base64

collections

colorsys

contextlib

dbm

dis

doctest

email

filecmp

functools

gc

glob

hashlib

hmac

html

http

idlelib 与 IDLE

importlib

inspect

ipaddress

logging

marshal

mmap

multiprocessing

operator

os

pdb

pickle

plistlib

poplib

pprint

pty

pydoc

re

resource

select

shelve

shutil

smtpd

smtplib

socket

sqlite3

ssl

stat

struct

subprocess

sunau

sys

tarfile

textwrap

threading

回溯

types

urllib

unittest

venv

wave

weakref

xml.etree

zipfile

CPython 实现的变化

PEP 445: 自定义 CPython 内存分配器

PEP 442: 安全的对象最终化

PEP 456: 安全且可互换的哈希算法

PEP 436: Argument Clinic

其他的构建和 C API 的改变

其他改进

显著的优化

弃用

Python API 中的弃用

弃用的特性

移除

不再支持的操作系统

API 与特性的移除

代码清理

移植到 Python 3.4

 'python' 命令行为的变化

Python API 的变化

C API 的变化

3.4.3 的变化

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

Python 3.3 有什么新变化

摘要 -- 发布重点

PEP 405: 虚拟环境

PEP 420: 隐式命名空间包

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

相关特性

API 的变化

PEP 393: 灵活的字符串表示

功能

性能和资源使用情况

PEP 397: 适用于Windows的Python启动器

PEP 3151: 重写 OS 和 IO 异常的层次结构

PEP 380: 委托给子生成器的语法

PEP 409: 清除异常上下文

PEP 414: 显式的Unicode文本

PEP 3155: 类和函数的限定名称

PEP 412: Key-Sharing Dictionary

PEP 362: 函数签名对象

PEP 421: 添加 sys.implementation

SimpleNamespace

使用 importlib 作为导入的实现

新的API

可见的改变

其他语言特性修改

更细粒度的导入锁

内置函数和类型

新增模块

faulthandler

ipaddress

lzma

改进的模块

abc

array

base64

binascii

bz2

编码器

collections

contextlib

crypt

curses

datetime

decimal

相关特性

API 的变化

email

策略框架

带有新头部API的暂行策略

其他API更改

ftplib

functools

gc

hmac

http

html

imaplib

inspect

io

itertools

logging

math

mmap

multiprocessing

nntplib

os

pdb

pickle

pydoc

re

sched

select

shlex

shutil

signal

smtpd

smtplib

socket

socketserver

sqlite3

ssl

stat

struct

subprocess

sys

tarfile

tempfile

textwrap

threading

time

types

unittest

urllib

webbrowser

xml.etree.ElementTree

zlib

性能优化

构建和 C API 的改变

弃用

不支持的操作系统

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

已弃用的 C API 函数和类型

弃用的功能

移植到 Python 3.3

移植 Python 代码

移植 C 代码

构建 C 扩展

命令行开关的变化

Python 3.2 有什么新变化

PEP 384: 定义稳定的ABI

PEP 389: Argparse 命令行解析模块

PEP 391: 基于字典的日志配置

PEP 3148: concurrent.futures 模块

PEP 3147: PYC 仓库目录

PEP 3149: 带有 ABI 版本标签的 .so 文件

PEP 3333: Python Web服务器网关接口v1.0.1

其他语言特性修改

新增，改进和弃用的模块

email

elementtree

functools

itertools

collections

threading

datetime 和 time

math

abc

io

reprlib

logging

csv

contextlib

decimal 和 fractions

ftp

popen

select

gzip 和 zipfile

tarfile

hashlib

ast

os

shutil

sqlite3

html

socket

ssl

nntp

certificates

imaplib

http.client

unittest

random

poplib

asyncore

tempfile

inspect

pydoc

dis

dbm

ctypes

site

sysconfig

pdb

configparser

urllib.parse

mailbox

turtledemo

多线程

性能优化

Unicode

编解码器

文档

IDLE

代码库

构建和 C API 的改变

移植到 Python 3.2

Python 3.1 有什么新变化

PEP 372: 有序字典

PEP 378: 千位分隔符的格式说明符

其他语言特性修改

新增，改进和弃用的模块

性能优化

IDLE

构建和 C API 的改变

移植到 Python 3.1

Python 3.0 有什么新变化

常见的绊脚石

Print 是函数

用视图和迭代器取代列表

排序比较

整数

文本与数据而不是 Unicode 与 8 比特位

语法变化概述

新语法

语法变化

移除的语法

已存在于 Python 2.6 中的改变

库的修改

PEP 3101: 字符串格式化的新方式

对异常的修改

其他杂项修改

运算符与特殊方法

内置对象

构建和 C API 的改变

性能

移植到 Python 3.0

Python 2.7 有什么新变化

Python 2.x的未来

对于弃用警告处理方式的改变

Python 3.1 特性

PEP 372：将有序字典 添加到收藏集

PEP 378: 千位分隔符的格式说明符

PEP 389：用于解析命令行的 argparse 模块

PEP 391: 基于字典的日志配置

PEP 3106: 字典视图

PEP 3137: memoryview 对象

其他语言特性修改

解释器改动

性能优化

新增和改进的模块

新模块：importlib

新模块：sysconfig

ttk：Tk 主题组件

更新的模块：unittest

更新的模块：ElementTree 1.3

构建和 C API 的改变

Capsule 对象

特定于 Windows 的更改：

特定于 Mac OS X 的更改：

特定于 FreeBSD 的更改：

其他的改变和修正

移植到 Python 2.7

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

调试模式的两个新环境变量

PEP 434：针对所有分支的 IDLE 增强功能豁免提案

PEP 466: 针对 Python 2.7 的网络安全加固

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

默认对 pip 进行初始设置

文档更改

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

PEP 493：适用于Python 2.7 的 HTTPS 验证迁移工具

新增 make regen-all 构建目标

移除了 make touch 构建目标

致谢

Python 2.6 有什么新变化

Python 3.0

开发过程的变化

新问题追踪：简述

新的文档格式：使用 Sphinx 的 reStructuredText

PEP 343: "with" 语句

编写上下文管理器

contextlib 模块

PEP 366: 从主模块显式相对导入

PEP 370: 分用户的 site-packages 目录

PEP 371: 多任务处理包

PEP 3101: 高级字符串格式

PEP 3105: print 改为函数

PEP 3110: 异常处理的变更

PEP 3112: 字节字面值

PEP 3116: 新 I/O 库

PEP 3118: 修改缓冲区协议

PEP 3119: 抽象基类

PEP 3127: 整型文字支持和语法

PEP 3129: 类装饰器

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

fractions 模块

其他语言特性修改

性能优化

解释器改动

新增和改进的模块

ast 模块

future_builtins 模块

json 模块: JavaScript Object Notation

plistlib 模块：属性列表解析器

ctypes 增强

改进的 SSL 支持

弃用和移除

构建和 C API 的改变

特定于 Windows 的更改：

特定于 Mac OS X 的更改：

特定于 IRIX 的更改：

移植到Python 2.6

致谢

Python 2.5 有什么新变化

PEP 308: 条件表达式

PEP 309: 部分功能应用

PEP 314: Python软件包的元数据 v1.1

PEP 328: 绝对导入和相对导入

PEP 338: 将模块作为脚本执行

PEP 341: 统一 try/except/finally

PEP 342: 生成器的新特性

PEP 343: "with" 语句

编写上下文管理器

contextlib 模块

PEP 352: 异常作为新型的类

PEP 353: 使用ssize_t作为索引类型

PEP 357: '__index__' 方法

其他语言特性修改

交互解释器变更

性能优化

新增，改进和删除的模块

ctypes 包

ElementTree 包

hashlib 包

sqlite3 包

wsgiref 包

构建和 C API 的改变

移植专属的改变

移植到Python 2.5

致谢

Python 2.4 有什么新变化

PEP 218: 内置集合对象

PEP 237: 统一长整数和整数

PEP 289: 生成器表达式

PEP 292: 更简单的字符串替换

PEP 318: 函数和方法的装饰器

PEP 322: 反向迭代

PEP 324: 新的子进程模块

PEP 327: 十进制数据类型

为什么需要十进制？

Decimal 类型

Context 类型

PEP 328: 多行导入

PEP 331: 与区域设置无关的浮点数/字符串转换

其他语言特性修改

性能优化

新增，改进和弃用的模块

cookielib

doctest

构建和 C API 的改变

移植专属的改变

移植到 Python 2.4

致谢

Python 2.3 有什么新变化

PEP 218: 标准集合数据类型

PEP 255: 简单的生成器

PEP 263: 源代码的字符编码格式

PEP 273: 从ZIP压缩包导入模块

PEP 277: 针对 Windows NT 的 Unicode 文件名支持

PEP 278: 通用换行支持

PEP 279: enumerate()

PEP 282: logging 包

PEP 285: 布尔类型

PEP 293: 编解码器错误处理回调

PEP 301: Distutils的软件包索引和元数据

PEP 302: 新导入钩子

PEP 305: 逗号分隔文件

PEP 307：对 pickle 的改进

扩展切片

其他语言特性修改

字符串的改变

性能优化

新增，改进和弃用的模块

Date/Time 类型

optparse 模块

Pymalloc：一种专用对象分配器

构建和 C API 的改变

移植专属的改变

其他的改变和修正

移植到 Python 2.3

致谢

Python 2.2 有什么新变化

概述

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

旧式类和新式类

描述器

多重继承：钻石规则

属性访问

相关链接

PEP 234: 迭代器

PEP 255: 简单的生成器

PEP 237: 统一长整数和整数

PEP 238：修改除法运算符

Unicode 的改变

PEP 227: 嵌套的作用域

新增和改进的模块

解释器的改变和修正

其他的改变和修正

致谢

Python 2.1 有什么新变化

概述

PEP 227: 嵌套的作用域

PEP 236: __future__ 指令

PEP 207: 富比较

PEP 230: 警告框架

PEP 229: 新的构建系统

PEP 205: 弱引用

PEP 232: 函数属性

PEP 235: 在大小写不敏感的平台上导入模块

PEP 217: 交互模式显示钩子

PEP 208: 新的强制转换模型

PEP 241: Python 包中的元数据

新增和改进的模块

其他的改变和修正

致谢

Python 2.0 有什么新变化

概述

Python 1.6 将会怎样？

新开发流程

Unicode

列表推导式

增强赋值

字符串的方法

循环的垃圾回收

其他核心变化

细微的语言特性修改

对于内置函数的修改

移植 Python 2.0

扩展/嵌入更改

Distutils：使模块易于安装

XML 模块

SAX2 支持

DOM 支持

与 PyXML 的关系

模块更改

新增模块

IDLE 改进

删除和弃用的模块

致谢

更新日志

Python 3.10.20 final

安全性

库

核心与内置函数

Python 3.10.19 final

安全性

库

Python 3.10.18 final

安全性

库

Python 3.10.17 final

安全性

库

文档

Python 3.10.16 final

测试

安全性

库

Python 3.10.15 final

Windows

测试

安全性

库

核心与内置函数

Python 3.10.14 final

安全性

核心与内置函数

库

文档

Windows

工具/示例

Python 3.10.13 final

安全性

库

工具/示例

C API

Python 3.10.12 final

安全性

库

文档

构建

Python 3.10.11 final

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

Python 3.10.10 final

核心与内置函数

库

文档

测试

构建

Windows

macOS

C API

Python 3.10.9 final

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

Python 3.10.8 final

安全性

核心与内置函数

库

文档

构建

Windows

macOS

Python 3.10.7 final

安全性

核心与内置函数

库

文档

测试

构建

IDLE

Python 3.10.6 final

安全性

核心与内置函数

库

文档

测试

构建

Windows

IDLE

工具/示例

C API

Python 3.10.5 final

核心与内置函数

库

文档

测试

构建

Windows

工具/示例

Python 3.10.4 final

核心与内置函数

库

Python 3.10.3 final

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.10.2 final

核心与内置函数

库

文档

测试

构建

macOS

C API

Python 3.10.1 final

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.10.0 final

核心与内置函数

库

文档

测试

构建

IDLE

C API

Python 3.10.0 release candidate 2

安全性

核心与内置函数

库

文档

测试

Windows

macOS

Python 3.10.0 release candidate 1

安全性

核心与内置函数

库

文档

测试

Windows

macOS

工具/示例

C API

Python 3.10.0 beta 4

安全性

核心与内置函数

库

文档

测试

构建

Windows

C API

Python 3.10.0 beta 3

核心与内置函数

库

文档

测试

构建

IDLE

C API

Python 3.10.0 beta 2

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.10.0 beta 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.10.0 alpha 7

安全性

核心与内置函数

库

文档

测试

构建

Windows

IDLE

C API

Python 3.10.0 alpha 6

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.10.0 alpha 5

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.10.0 alpha 4

核心与内置函数

库

文档

测试

构建

macOS

工具/示例

C API

Python 3.10.0 alpha 3

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.10.0 alpha 2

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.10.0 alpha 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.9.0 beta 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

工具/示例

C API

Python 3.9.0 alpha 6

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.9.0 alpha 5

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.9.0 alpha 4

安全性

核心与内置函数

库

文档

测试

构建

Windows

IDLE

C API

Python 3.9.0 alpha 3

核心与内置函数

库

文档

构建

IDLE

C API

Python 3.9.0 alpha 2

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

C API

Python 3.9.0 alpha 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.8.0 beta 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.8.0 alpha 4

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.8.0 alpha 3

安全性

核心与内置函数

库

文档

测试

构建

Windows

IDLE

工具/示例

C API

Python 3.8.0 alpha 2

核心与内置函数

库

文档

测试

Windows

IDLE

Python 3.8.0 alpha 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.7.0 正式版

库

C API

Python 3.7.0 rc1

核心与内置函数

库

文档

构建

Windows

IDLE

Python 3.7.0 beta 5

核心与内置函数

库

文档

测试

构建

macOS

IDLE

Python 3.7.0 beta 4

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

Python 3.7.0 beta 3

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.7.0 beta 2

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

Python 3.7.0 beta 1

核心与内置函数

库

文档

测试

构建

Windows

macOS

C API

Python 3.7.0 alpha 4

核心与内置函数

库

文档

测试

Windows

工具/示例

C API

Python 3.7.0 alpha 3

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.7.0 alpha 2

核心与内置函数

库

文档

构建

IDLE

C API

Python 3.7.0 alpha 1

安全性

核心与内置函数

库

文档

测试

构建

Windows

IDLE

工具/示例

C API

Python 3.6.6 正式版

Python 3.6.6 rc1

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.6.5 正式版

测试

构建

Python 3.6.5 rc1

安全性

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.6.4 正式版

Python 3.6.4 rc1

核心与内置函数

库

文档

测试

构建

Windows

macOS

IDLE

工具/示例

C API

Python 3.6.3 正式版

库

构建

Python 3.6.3 rc1

安全性

核心与内置函数

库

文档

测试

构建

Windows

IDLE

工具/示例

Python 3.6.2 正式版

Python 3.6.2 rc2

安全性

Python 3.6.2 rc1

安全性

核心与内置函数

库

IDLE

C API

构建

文档

工具/示例

测试

Windows

Python 3.6.1 正式版

核心与内置函数

构建

Python 3.6.1 rc1

核心与内置函数

库

IDLE

Windows

C API

文档

测试

构建

Python 3.6.0 正式版

Python 3.6.0 rc2

核心与内置函数

工具/示例

Windows

构建

Python 3.6.0 rc1

核心与内置函数

库

C API

文档

工具/示例

Python 3.6.0 beta 4

核心与内置函数

库

文档

测试

构建

Python 3.6.0 beta 3

核心与内置函数

库

Windows

构建

测试

Python 3.6.0 beta 2

核心与内置函数

库

Windows

C API

构建

测试

Python 3.6.0 beta 1

核心与内置函数

库

IDLE

C API

测试

构建

工具/示例

Windows

Python 3.6.0 alpha 4

核心与内置函数

库

IDLE

测试

Windows

构建

Python 3.6.0 alpha 3

安全性

核心与内置函数

库

IDLE

C API

构建

工具/示例

文档

测试

Python 3.6.0 alpha 2

安全性

核心与内置函数

库

IDLE

文档

测试

Windows

构建

C API

工具/示例

Python 3.6.0 alpha 1

安全性

核心与内置函数

库

IDLE

文档

测试

构建

Windows

工具/示例

C API

Python 3.5.5 正式版

Python 3.5.5 rc1

安全性

核心与内置函数

库

Python 3.5.4 正式版

库

Python 3.5.4 rc1

安全性

核心与内置函数

库

文档

测试

构建

Windows

C API

Python 3.5.3 正式版

Python 3.5.3 rc1

安全性

核心与内置函数

库

IDLE

C API

文档

测试

工具/示例

Windows

构建

Python 3.5.2 正式版

核心与内置函数

测试

IDLE

Python 3.5.2 rc1

安全性

核心与内置函数

库

IDLE

文档

测试

构建

Windows

工具/示例

Python 3.5.1 正式版

核心与内置函数

Windows

Python 3.5.1 rc1

核心与内置函数

库

IDLE

文档

测试

构建

Windows

工具/示例

Python 3.5.0 正式版

构建

Python 3.5.0 rc4

库

构建

Python 3.5.0 rc3

核心与内置函数

库

Python 3.5.0 rc2

核心与内置函数

库

Python 3.5.0 rc1

核心与内置函数

库

IDLE

文档

测试

Python 3.5.0 beta 4

核心与内置函数

库

构建

Python 3.5.0 beta 3

核心与内置函数

库

测试

文档

构建

Python 3.5.0 beta 2

核心与内置函数

库

Python 3.5.0 beta 1

核心与内置函数

库

IDLE

测试

文档

工具/示例

Python 3.5.0 alpha 4

核心与内置函数

库

构建

测试

工具/示例

C API

Python 3.5.0 alpha 3

核心与内置函数

库

构建

测试

工具/示例

Python 3.5.0 alpha 2

核心与内置函数

库

构建

C API

Windows

Python 3.5.0 alpha 1

核心与内置函数

库

IDLE

构建

C API

文档

测试

工具/示例

Windows

Python 教程

1. 课前甜点

2. 使用 Python 的解释器

2.1. 唤出解释器

2.1.1. 传入参数

2.1.2. 交互模式

2.2. 解释器的运行环境

2.2.1. 源文件的字符编码

3. Python 速览

3.1. Python 用作计算器

3.1.1. 数字

3.1.2. 字符串

3.1.3. 列表

3.2. 走向编程的第一步

4. 更多控制流工具

4.1. if 语句

4.2. for 语句

4.3. range() 函数

4.4. 循环中的 break、continue 语句及 else 子句

4.5. pass 语句

4.6. match 语句

4.7. 定义函数

4.8. 函数定义详解

4.8.1. 默认值参数

4.8.2. 关键字参数

4.8.3. 特殊参数

4.8.3.1. 位置或关键字参数

4.8.3.2. 仅位置参数

4.8.3.3. 仅限关键字参数

4.8.3.4. 函数示例

4.8.3.5. 小结

4.8.4. 任意实参列表

4.8.5. 解包实参列表

4.8.6. Lambda 表达式

4.8.7. 文档字符串

4.8.8. 函数注解

4.9. 小插曲：编码风格

5. 数据结构

5.1. 列表详解

5.1.1. 用列表实现堆栈

5.1.2. 用列表实现队列

5.1.3. 列表推导式

5.1.4. 嵌套的列表推导式

5.2. del 语句

5.3. 元组和序列

5.4. 集合

5.5. 字典

5.6. 循环的技巧

5.7. 深入条件控制

5.8. 序列和其他类型的比较

6. 模块

6.1. 模块详解

6.1.1. 以脚本方式执行模块

6.1.2. 模块搜索路径

6.1.3. “已编译的” Python 文件

6.2. 标准模块

6.3. dir() 函数

6.4. 包

6.4.1. 从包中导入 *

6.4.2. 相对导入

6.4.3. 多目录中的包

7. 输入与输出

7.1. 更复杂的输出格式

7.1.1. 格式化字符串字面值

7.1.2. 字符串 format() 方法

7.1.3. 手动格式化字符串

7.1.4. 旧式字符串格式化方法

7.2. 读写文件

7.2.1. 文件对象的方法

7.2.2. 使用 json 保存结构化数据

8. 错误和异常

8.1. 语法错误

8.2. 异常

8.3. 异常的处理

8.4. 触发异常

8.5. 异常链

8.6. 用户自定义异常

8.7. 定义清理操作

8.8. 预定义的清理操作

9. 类

9.1. 名称和对象

9.2. Python 作用域和命名空间

9.2.1. 作用域和命名空间示例

9.3. 初探类

9.3.1. 类定义语法

9.3.2. Class 对象

9.3.3. 实例对象

9.3.4. 方法对象

9.3.5. 类和实例变量

9.4. 补充说明

9.5. 继承

9.5.1. 多重继承

9.6. 私有变量

9.7. 杂项说明

9.8. 迭代器

9.9. 生成器

9.10. 生成器表达式

10. 标准库简介

10.1. 操作系统接口

10.2. 文件通配符

10.3. 命令行参数

10.4. 错误输出重定向和程序终止

10.5. 字符串模式匹配

10.6. 数学

10.7. 互联网访问

10.8. 日期和时间

10.9. 数据压缩

10.10. 性能测量

10.11. 质量控制

10.12. 自带电池

11. 标准库简介 —— 第二部分

11.1. 格式化输出

11.2. 模板

11.3. 使用二进制数据记录格式

11.4. 多线程

11.5. 日志记录

11.6. 弱引用

11.7. 用于操作列表的工具

11.8. 十进制浮点运算

12. 虚拟环境和包

12.1. 概述

12.2. 创建虚拟环境

12.3. 使用pip管理包

13. 接下来？

14. 交互式编辑和编辑历史

14.1. Tab 补全和编辑历史

14.2. 默认交互式解释器的替代品

15. 浮点算术：争议和限制

15.1. 表示性错误

16. 附录

16.1. 交互模式

16.1.1. 错误处理

16.1.2. 可执行的Python脚本

16.1.3. 交互式启动文件

16.1.4. 定制模块

Python安装和使用

1. 命令行与环境

1.1. 命令行

1.1.1. 接口选项

1.1.2. 通用选项

1.1.3. 其他选项

1.1.4. 不应当使用的选项

1.2. 环境变量

1.2.1. 调试模式变量

2. 在类Unix环境下使用Python

2.1. 获得并安装Python的最新版本

2.1.1. 在Linux中

2.1.2. 在FreeBSD和OpenBSD上

2.1.3. 在OpenSolaris系统上

2.2. 构建Python

2.3. 与Python相关的路径和文件

2.4. 杂项

2.5. 自定义 OpenSSL

3. 配置 Python

3.1. 配置选项

3.1.1. 通用选项

3.1.2. 安装时的选项

3.1.3. 性能选项

3.1.4. Python 调试级编译

3.1.5. 调试选项

3.1.6. 链接器选项

3.1.7. 库选项

3.1.8. 安全性选项

3.1.9. macOS 选项

3.2. Python 构建系统

3.2.1. 构建系统的主要文件

3.2.2. 主要构建步骤

3.2.3. 主要 Makefile 目标

3.2.4. C 扩展

3.3. 编译器和链接器的标志

3.3.1. 预处理器的标志

3.3.2. 编译器标志

3.3.3. 链接器标志位

4. 在Windows上使用 Python

4.1. 完整安装程序

4.1.1. 安装步骤

4.1.2. 删除 MAX_PATH 限制

4.1.3. 无UI 安装

4.1.4. 免下载安装

4.1.5. 修改安装

4.2. Microsoft Store包

4.2.1. 已知的问题

4.2.1.1. 本地数据、注册表项和临时路径的重定向

4.3. nuget.org 安装包

4.4. 可嵌入的包

4.4.1. Python 应用程序

4.4.2. 嵌入Python

4.5. 替代捆绑包

4.6. 配置Python

4.6.1. 附录：设置环境变量

4.6.2. 查找Python可执行文件

4.7. UTF-8 模式

4.8. 适用于Windows的Python启动器

4.8.1. 入门

4.8.1.1. 从命令行

4.8.1.2. 从虚拟环境

4.8.1.3. 从脚本

4.8.1.4. 从文件关联

4.8.2. Shebang 行

4.8.3. shebang 行的参数

4.8.4. 自定义

4.8.4.1. 通过INI文件自定义

4.8.4.2. 自定义默认的Python版本

4.8.5. 诊断

4.9. 查找模块

4.10. 附加模块

4.10.1. PyWin32

4.10.2. cx_Freeze

4.11. 在Windows上编译Python

4.12. 其他平台

5. 在 Mac 上使用 Python

5.1. 获取和安装 MacPython

5.1.1. 如何运行 Python 脚本

5.1.2. 运行有图形界面的脚本

5.1.3. 配置

5.2. IDE

5.3. 安装额外的 Python 包

5.4. Mac 上的图形界面编程

5.5. 在 Mac 上分发 Python 应用程序

5.6. 其他资源

6. 编辑器和集成开发环境

Python 语言参考手册

1. 概述

1.1. 其他实现

1.2. 标注

2. 词法分析

2.1. 行结构

2.1.1. 逻辑行

2.1.2. 物理行

2.1.3. 注释

2.1.4. 编码声明

2.1.5. 显式拼接行

2.1.6. 隐式拼接行

2.1.7. 空白行

2.1.8. 缩进

2.1.9. 形符间的空白字符

2.2. 其他形符

2.3. 标识符和关键字

2.3.1. 关键字

2.3.2. 软关键字

2.3.3. 保留的标识符类

2.4. 字面值

2.4.1. 字符串与字节串字面值

2.4.2. 字符串字面值合并

2.4.3. 格式字符串字面值

2.4.4. 数值字面值

2.4.5. 整数字面值

2.4.6. 浮点数字面值

2.4.7. 虚数字面值

2.5. 运算符

2.6. 分隔符

3. 数据模型

3.1. 对象、值与类型

3.2. 标准类型层级结构

3.3. 特殊方法名称

3.3.1. 基本定制

3.3.2. 自定义属性访问

3.3.2.1. 自定义模块属性访问

3.3.2.2. 实现描述器

3.3.2.3. 调用描述器

3.3.2.4. __slots__

3.3.2.4.1. 使用 __slots__ 的注意事项

3.3.3. 自定义类创建

3.3.3.1. 元类

3.3.3.2. 解析 MRO 条目

3.3.3.3. 确定适当的元类

3.3.3.4. 准备类命名空间

3.3.3.5. 执行类主体

3.3.3.6. 创建类对象

3.3.3.7. 元类的作用

3.3.4. 自定义实例及子类检查

3.3.5. 模拟泛型类型

3.3.5.1. __class_getitem__ 的目的

3.3.5.2. __class_getitem__ 与 __getitem__

3.3.6. 模拟可调用对象

3.3.7. 模拟容器类型

3.3.8. 模拟数字类型

3.3.9. with 语句上下文管理器

3.3.10. 定制类模式匹配中的位置参数

3.3.11. 特殊方法查找

3.4. 协程

3.4.1. 可等待对象

3.4.2. 协程对象

3.4.3. 异步迭代器

3.4.4. 异步上下文管理器

4. 执行模型

4.1. 程序的结构

4.2. 命名与绑定

4.2.1. 名称的绑定

4.2.2. 名称的解析

4.2.3. 内置命名空间和受限的执行

4.2.4. 与动态特性的交互

4.3. 异常

5. 导入系统

5.1. importlib

5.2. 包

5.2.1. 常规包

5.2.2. 命名空间包

5.3. 搜索

5.3.1. 模块缓存

5.3.2. 查找器和加载器

5.3.3. 导入钩子

5.3.4. 元路径

5.4. 加载

5.4.1. 加载器

5.4.2. 子模块

5.4.3. 模块规格说明

5.4.4. 导入相关的模块属性

5.4.5. module.__path__

5.4.6. 模块的 repr

5.4.7. 已缓存字节码的失效

5.5. 基于路径的查找器

5.5.1. 路径条目查找器

5.5.2. 路径条目查找器协议

5.6. 替换标准导入系统

5.7. 包相对导入

5.8. 有关 __main__ 的特殊事项

5.8.1. __main__.__spec__

5.9. 参考文献

6. 表达式

6.1. 算术转换

6.2. 原子

6.2.1. 标识符（名称）

6.2.2. 字面值

6.2.3. 带圆括号的形式

6.2.4. 列表、集合与字典的显示

6.2.5. 列表显示

6.2.6. 集合显示

6.2.7. 字典显示

6.2.8. 生成器表达式

6.2.9. yield 表达式

6.2.9.1. 生成器-迭代器的方法

6.2.9.2. 例子

6.2.9.3. 异步生成器函数

6.2.9.4. 异步生成器-迭代器方法

6.3. 原型

6.3.1. 属性引用

6.3.2. 抽取

6.3.3. 切片

6.3.4. 调用

6.4. await 表达式

6.5. 幂运算符

6.6. 一元算术和位运算

6.7. 二元算术运算符

6.8. 移位运算

6.9. 二元位运算

6.10. 比较运算

6.10.1. 值比较

6.10.2. 成员检测运算

6.10.3. 标识号比较

6.11. 布尔运算

6.12. 赋值表达式

6.13. 条件表达式

6.14. lambda 表达式

6.15. 表达式列表

6.16. 求值顺序

6.17. 运算符优先级

7. 简单语句

7.1. 表达式语句

7.2. 赋值语句

7.2.1. 增强赋值语句

7.2.2. 带标注的赋值语句

7.3. assert 语句

7.4. pass 语句

7.5. del 语句

7.6. return 语句

7.7. yield 语句

7.8. raise 语句

7.9. break 语句

7.10. continue 语句

7.11. import 语句

7.11.1. future 语句

7.12. global 语句

7.13. nonlocal 语句

8. 复合语句

8.1. if 语句

8.2. while 语句

8.3. for 语句

8.4. try 语句

8.5. with 语句

8.6. match 语句

8.6.1. 概述

8.6.2. 约束项

8.6.3. 必定匹配的 case 块

8.6.4. 模式

8.6.4.1. 或模式

8.6.4.2. AS 模式

8.6.4.3. 字面值模式

8.6.4.4. 捕获模式

8.6.4.5. 通配符模式

8.6.4.6. 值模式

8.6.4.7. 组模式

8.6.4.8. 序列模式

8.6.4.9. 映射模式

8.6.4.10. 类模式

8.7. 函数定义

8.8. 类定义

8.9. 协程

8.9.1. 协程函数定义

8.9.2. async for 语句

8.9.3. async with 语句

9. 顶级组件

9.1. 完整的 Python 程序

9.2. 文件输入

9.3. 交互式输入

9.4. 表达式输入

10. 完整的语法规范

Python 标准库

概述

可用性注释

内置函数

内置常量

由 site 模块添加的常量

内置类型

逻辑值检测

布尔运算 --- and, or, not

比较运算

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

整数类型的按位运算

整数类型的附加方法

浮点类型的附加方法

数字类型的哈希运算

迭代器类型

生成器类型

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

通用序列操作

不可变序列类型

可变序列类型

列表

元组

range 对象

文本序列类型 --- str

字符串的方法

printf 风格的字符串格式化

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

bytes 对象

bytearray 对象

bytes 和 bytearray 操作

printf 风格的字节串格式化

内存视图

集合类型 --- set, frozenset

映射类型 --- dict

字典视图对象

上下文管理器类型

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

GenericAlias 类型

标准泛型类

GenericAlias 对象的特殊属性

union 类型

其他内置类型

模块

类与类实例

函数

方法

代码对象

类型对象

空对象

省略符对象

未实现对象

布尔值

内部对象

特殊属性

整数字符串转换长度限制

受影响的 API

配置限制值

推荐配置

内置异常

异常上下文

从内置异常继承

基类

具体异常

OS 异常

警告

异常层次结构

文本处理服务

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

字符串常量

自定义字符串格式化

格式字符串语法

格式规格迷你语言

格式示例

模板字符串

辅助函数

re --- 正则表达式操作

正则表达式语法

模块内容

标志

函数

异常

正则表达式对象 （正则对象）

匹配对象

正则表达式例子

检查对子

模拟 scanf()

search() vs. match()

制作一个电话本

文字整理

查找所有副词

查找所有的副词及其位置

原始字符串标记

写一个词法分析器

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

SequenceMatcher 对象

SequenceMatcher 的示例

Differ 对象

Differ 示例

difflib 的命令行接口

textwrap --- 文本自动换行与填充

unicodedata --- Unicode 数据库

stringprep --- 因特网字符串预备

readline --- GNU readline 接口

初始化文件

行缓冲区

历史文件

历史列表

启动钩子

Completion

示例

rlcompleter --- GNU readline 的补全函数

Completer 对象

二进制数据服务

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

函数和异常

格式字符串

字节顺序，大小和对齐方式

格式字符

例子

应用

原生格式

标准格式

类

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

编解码器基类

错误处理方案

无状态的编码和解码

增量式的编码和解码

IncrementalEncoder 对象

IncrementalDecoder 对象

流式的编码和解码

StreamWriter 对象

StreamReader 对象

StreamReaderWriter 对象

StreamRecoder 对象

编码格式与 Unicode

标准编码

Python 专属的编码格式

文字编码

二进制转换

文字转换

encodings.idna --- 应用程序中的国际化域名

encodings.mbcs --- Windows ANSI代码页

encodings.utf_8_sig --- 带BOM签名的UTF-8编解码器

数据类型

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

感知型对象和简单型对象

常量

有效的类型

通用的特征属性

确定一个对象是感知型还是简单型

timedelta 类对象

timedelta 用法示例

date 对象

date 用法示例

datetime 对象

用法示例: datetime

time 对象

用法示例: time

tzinfo 对象

timezone 对象

strftime() 和 strptime() 的行为

strftime() 和 strptime() Format Codes

技术细节

zoneinfo --- IANA 时区支持

使用 ZoneInfo

数据源

配置数据源

编译时配置

环境配置

运行时配置

ZoneInfo 类

字符串表示

封存序列化

函数

全局变量

异常与警告

calendar --- 日历相关函数

collections --- 容器数据类型

ChainMap 对象

ChainMap 例子和方法

Counter 对象

deque 对象

deque 用法

defaultdict 对象

defaultdict 例子

namedtuple() 命名元组的工厂函数

OrderedDict 对象

OrderedDict 例子和用法

UserDict 对象

UserList 对象

UserString 对象

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

容器抽象基类

多项集抽象基类 -- 详细描述

例子和配方

heapq --- 堆队列算法

基本示例

优先队列实现说明

理论

bisect --- 数组二分查找算法

性能说明

搜索有序列表

例子

array --- 高效的数字数组

weakref --- 弱引用

弱引用对象

示例

终结器对象

比较终结器与 __del__() 方法

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

动态类型创建

标准解释器类型

附加工具类和函数

协程工具函数

copy --- 浅层 (shallow) 和深层 (deep) 复制操作

pprint --- 数据美化输出

PrettyPrinter 对象

示例

reprlib --- 另一种 repr() 实现

Repr 对象

子类化 Repr 对象

enum --- 对枚举的支持

模块内容

创建 Enum

枚举成员及其属性的编程访问

重复的枚举成员和值

确保枚举值唯一

使用自动设定的值

迭代

比较运算

合法的枚举成员和属性

受限的 Enum 子类化

打包（pickle）

函数式 API

派生的枚举

IntEnum

IntFlag

标志位

其他事项

何时使用 __new__() 与 __init__()

有趣的示例

省略值

使用 auto

使用 object

使用描述性字符串

使用自定义的 __new__()

OrderedEnum

DuplicateFreeEnum

Planet

TimePeriod

各种枚举有何区别？

枚举类

枚举成员（即实例）

细节要点

支持的 __dunder__ 名称

支持的 _sunder_ 名称

_Private__names

Enum 成员类型

Enum 类和成员的布尔值

带有方法的 Enum 类

组合 Flag 的成员

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

异常

数字和数学模块

numbers --- 数字的抽象基类

数字的层次

类型接口注释。

加入更多数字的ABC

实现算术运算

math --- 数学函数

数论与表示函数

幂函数与对数函数

三角函数

角度转换

双曲函数

特殊函数

常量

cmath --- 关于复数的数学函数

到极坐标和从极坐标的转换

幂函数与对数函数

三角函数

双曲函数

分类函数

常量

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

快速入门教程

Decimal 对象

逻辑操作数

上下文对象

常量

舍入模式

信号

浮点数说明

通过提升精度来解决舍入错误

特殊的值

使用线程

例程

Decimal 常见问题

fractions --- 分数

random --- 生成伪随机数

簿记功能

用于字节数据的函数

整数用函数

序列用函数

实值分布

替代生成器

关于再现性的说明

例子

例程

statistics --- 数学统计函数

平均值以及对中心位置的评估

对分散程度的评估

对两个输入之间关系的统计

函数细节

异常

NormalDist 对象

NormalDist 示例和用法

函数式编程模块

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

Itertool函数

itertools 配方

functools --- 高阶函数和可调用对象上的操作

partial 对象

operator --- 标准运算符替代函数

将运算符映射到函数

原地运算符

文件和目录访问

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

基础使用

纯路径

通用性质

运算符

访问个别部分

方法和特征属性

具体路径

方法

对应的 os 模块的工具

os.path --- 常用路径操作

fileinput --- 迭代来自多个输入流的行

stat --- 解析 stat() 结果

filecmp --- 文件及目录的比较

dircmp 类

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

例子

已弃用的函数和变量

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

fnmatch --- Unix 文件名模式匹配

linecache --- 随机读写文本行

shutil --- 高阶文件操作

目录和文件操作

依赖于具体平台的高效拷贝操作

copytree 示例

rmtree 示例

归档操作

归档程序示例

使用 base_dir 的归档程序示例

查询输出终端的尺寸

数据持久化

pickle --- Python 对象序列化

与其他 Python 模块间的关系

与 marshal 间的关系

与 json 模块的比较

数据流格式

模块接口

可以被封存/解封的对象

封存类实例

持久化外部对象

Dispatch 表

处理有状态的对象

类型，函数和其他对象的自定义归约

外部缓冲区

提供方 API

使用方 API

示例

限制全局变量

性能

例子

copyreg --- 注册配合 pickle 模块使用的函数

示例

shelve --- Python 对象持久化

限制

示例

marshal --- 内部 Python 对象序列化

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

dbm.gnu --- GNU 对 dbm 的重解析

dbm.ndbm --- 基于 ndbm 的接口

dbm.dumb --- 便携式 DBM 实现

sqlite3 --- SQLite 数据库 DB-API 2.0 接口模块

教程

参考

模块函数

模块常量

连接对象

游标对象

Row 对象

PrepareProtocol 对象

异常

SQLite 与 Python 类型

默认适配器和转换器

常用方案指引

如何在 SQL 查询中使用占位符来绑定值

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

如何编写可适配对象

如何注册适配器可调用对象

如何将 SQLite 值转换为自定义 Python 类型

适配器和转换器范例程序

如何使用连接快捷方法

如何使用连接上下文管理器

如何使用 SQLite URI

如何创建并使用行工厂对象

说明

事务控制

数据压缩和存档

zlib --- 与 gzip 兼容的压缩

gzip --- 对 gzip 格式的支持

用法示例

命令行界面

命令行选项

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

文件压缩和解压

增量压缩和解压

一次性压缩或解压缩

用法示例

lzma --- 用 LZMA 算法压缩

读写压缩文件

在内存中压缩和解压缩数据

杂项

指定自定义的过滤器链

例子

zipfile --- 使用ZIP存档

ZipFile 对象

Path 对象

PyZipFile 对象

ZipInfo 对象

命令行接口

命令行选项

解压缩的障碍

由于文件本身

文件系统限制

资源限制

中断

提取的默认行为

tarfile --- 读写tar归档文件

TarFile 对象

TarInfo 对象

解压缩过滤器

默认的命名过滤器

过滤器错误

进一步核验的提示

支持较早的 Python 版本

有状态的提取过滤器示例

命令行接口

命令行选项

例子

受支持的 tar 格式

Unicode 问题

文件格式

csv --- CSV 文件读写

模块内容

变种与格式参数

Reader 对象

Writer 对象

例子

configparser --- 配置文件解析器

快速起步

支持的数据类型

回退值

受支持的 INI 文件结构

值的插值

映射协议访问

定制解析器行为

旧式 API 示例

ConfigParser 对象

RawConfigParser 对象

异常

netrc --- netrc 文件处理

netrc 对象

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

例子

加密服务

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

哈希算法

SHAKE 可变长度摘要

密钥派生

BLAKE2

创建哈希对象

常量

例子

简单哈希

使用不同的摘要大小

密钥哈希

随机哈希

个性化

树形模式

开发人员

hmac --- 基于密钥的消息验证

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

随机数

生成 Token

Token 应当使用多少个字节？

其他功能

应用技巧与最佳实践

通用操作系统服务

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

文件名，命令行参数，以及环境变量。

Python UTF-8 模式

进程参数

创建文件对象

文件描述符操作

查询终端的尺寸

文件描述符的继承

文件和目录

Linux 扩展属性

进程管理

调度器接口

其他系统信息

随机数

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

概述

文本 I/O

二进制 I/O

原始 I/O

文本编码格式

选择性的 EncodingWarning

高阶模块接口

类的层次结构

I/O 基类

原始文件 I/O

缓冲流

文本 I/O

性能

二进制 I/O

文本 I/O

多线程

可重入性

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

函数

Clock ID 常量

时区常量

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

示例

创建一个解析器

添加参数

解析参数

ArgumentParser 对象

prog

usage（用法）

description

epilog

parents

formatter_class

prefix_chars

fromfile_prefix_chars

argument_default

allow_abbrev

conflict_handler

add_help

exit_on_error

add_argument() 方法

name or flags

action

nargs

const

默认值

type

choices

required

help

metavar

dest

Action 类

parse_args() 方法

选项值语法

无效的参数

包含 - 的参数

参数缩写（前缀匹配）

在 sys.argv 以外

命名空间对象

其它实用工具

子命令

FileType 对象

参数组

互斥

解析器默认值

打印帮助

部分解析

自定义文件解析

退出方法

混合解析

升级 optparse 代码

getopt --- C 风格的命令行选项解析器

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

记录器对象

日志级别

处理器对象

格式器对象

过滤器对象

LogRecord 属性

LogRecord 属性

LoggerAdapter 对象

线程安全

模块级函数

模块级属性

与警告模块集成

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

配置函数

安全考量

配置字典架构

字典架构细节

增量配置

对象连接

用户定义对象

处理器配置顺序

访问外部对象

访问内部对象

导入解析与定制导入器

配置文件格式

logging.handlers --- 日志处理程序

StreamHandler

FileHandler

NullHandler

WatchedFileHandler

BaseRotatingHandler

RotatingFileHandler

TimedRotatingFileHandler

SocketHandler

DatagramHandler

SysLogHandler

NTEventLogHandler

SMTPHandler

MemoryHandler

HTTPHandler

QueueHandler

QueueListener

getpass --- 便携式密码输入工具

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

函数

Window 对象

常量

curses.textpad --- 用于 curses 程序的文本输入控件

文本框对象

curses.ascii --- 用于 ASCII 字符的工具

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

函数

Panel 对象

platform --- 获取底层平台的标识数据

跨平台

Java平台

Windows平台

macOS 平台

Unix 平台

Linux 平台

errno --- 标准 errno 系统符号

ctypes --- Python 的外部函数库

ctypes 教程

载入动态连接库

操作导入的动态链接库中的函数

调用函数

基础数据类型

调用函数，继续

调用可变函数

使用自定义的数据类型调用函数

指定必选参数的类型(函数原型)

返回类型

传递指针（或以引用方式传递形参）

结构体和联合

结构体/联合字段对齐及字节顺序

结构体和联合中的位域

数组

指针

类型转换

不完整类型

回调函数

访问 dll 的导出变量

意外

变长数据类型

ctypes 参考手册

寻找动态链接库

加载动态链接库

外部函数

函数原型

工具函数

数据类型

基础数据类型

结构化数据类型

数组与指针

并发执行

threading --- 基于线程的并行

线程本地数据

线程对象

锁对象

递归锁对象

条件对象

信号量对象

Semaphore 例子

事件对象

定时器对象

栅栏对象

在 with 语句中使用锁、条件和信号量

multiprocessing --- 基于进程的并行

概述

Process 类

上下文和启动方法

在进程之间交换对象

进程间同步

进程间共享状态

使用工作进程

参考

Process 和异常

管道和队列

杂项

连接对象（Connection）

同步原语

共享 ctypes 对象

multiprocessing.sharedctypes 模块

管理器

自定义管理器

使用远程管理器

代理对象

清理

进程池

监听器及客户端

地址格式

认证密码

日志记录

multiprocessing.dummy 模块

编程指导

所有start方法

spawn 和 forkserver 启动方式

例子

multiprocessing.shared_memory --- 可跨进程直接访问的共享内存

concurrent 包

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

Executor 对象

ThreadPoolExecutor

ThreadPoolExecutor 例子

ProcessPoolExecutor

ProcessPoolExecutor 例子

Future 对象

模块函数

Exception 类

subprocess --- 子进程管理

使用 subprocess 模块

常用参数

Popen 构造函数

异常

安全考量

Popen 对象

Windows Popen 助手

Windows 常数

较旧的高阶 API

使用 subprocess 模块替换旧函数

替代 /bin/sh shell 命令替换

替代 shell 管道

替代 os.system()

替代 os.spawn 函数族

替代 os.popen(), os.popen2(), os.popen3()

来自 popen2 模块的替代函数

旧式的 Shell 发起函数

备注

在 Windows 上将参数列表转换为一个字符串

sched --- 事件调度器

调度器对象

queue --- 一个同步的队列类

Queue对象

SimpleQueue 对象

contextvars --- 上下文变量

上下文变量

手动上下文管理

asyncio 支持

_thread --- 底层多线程 API

网络和进程间通信

asyncio --- 异步 I/O

协程与任务

协程

可等待对象

运行 asyncio 程序

创建任务

休眠

并发运行任务

屏蔽取消操作

超时

简单等待

在线程中运行

跨线程调度

内省

Task 对象

基于生成器的协程

流

StreamReader

StreamWriter

例子

使用流的 TCP 回显客户端

使用流的 TCP 回显服务器

获取 HTTP 标头

注册一个打开的套接字以等待使用流的数据

同步原语

Lock

事件

Condition

Semaphore

BoundedSemaphore

子进程集

创建子进程

常量

与子进程交互

子进程和线程

例子

队列集

Queue

优先级队列

后进先出队列

异常

例子

异常

事件循环

事件循环方法集

运行和停止循环

安排回调

调度延迟回调

创建 Future 和 Task

打开网络连接

创建网络服务

传输文件

TLS 升级

监控文件描述符

直接使用 socket 对象

DNS

使用管道

Unix 信号

在线程或者进程池中执行代码。

错误处理API

开启调试模式

运行子进程

回调处理

Server 对象

事件循环实现

例子

call_soon() 的 Hello World 示例。

使用 call_later() 来展示当前的日期

监控一个文件描述符的读事件

为SIGINT和SIGTERM设置信号处理器

Futures

Future 函数

Future 对象

传输和协议

传输

传输层级

基础传输

只读传输

只写传输

数据报传输

子进程传输

协议

基础协议

基础协议

流式协议

缓冲流协议

数据报协议

子进程协议

例子

TCP 回显服务器

TCP 回显客户端

UDP 回显服务器

UDP 回显客户端

链接已存在的套接字

loop.subprocess_exec() 与 SubprocessProtocol

策略

获取和设置策略

策略对象

进程监视器

自定义策略

平台支持

所有平台

Windows

Windows的子进程支持

macOS

高层级 API 索引

任务

队列集

子进程集

流

同步

异常

低层级 API 索引

获取事件循环

事件循环方法集

传输

协议

事件循环策略

用 asyncio 开发

Debug 模式

并发性和多线程

运行阻塞的代码

日志记录

检测 never-awaited 协同程序

检测就再也没异常

socket --- 底层网络接口

套接字协议族

模块内容

异常

常量

函数

创建套接字

其他功能

套接字对象

关于套接字超时的说明

超时与 connect 方法

超时与 accept 方法

示例

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

方法、常量和异常处理

套接字创建

上下文创建

异常

随机生成

证书处理

常量

SSL 套接字

SSL 上下文

证书

证书链

CA 证书

合并的密钥和证书

自签名证书

例子

检测 SSL 支持

客户端操作

服务器端操作

关于非阻塞套接字的说明

内存 BIO 支持

SSL 会话

安全考量

最佳默认值

手动设置

验证证书

协议版本

密码选择

多进程

TLS 1.3

select --- 等待 I/O 完成

/dev/poll 轮询对象

边缘触发和水平触发的轮询 (epoll) 对象

Poll 对象

Kqueue 对象

Kevent 对象

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

概述

类

例子

signal --- 设置异步事件处理程序

一般规则

执行 Python 信号处理程序

信号与线程

模块内容

示例

对于 SIGPIPE 的说明

有关信号处理器和异常的注释

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

MADV_* 常量

MAP_* 常量

互联网数据处理

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

email.message: 表示一封电子邮件信息

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

FeedParser API

Parser API

附加说明

email.generator: 生成 MIME 文档

email.policy: Policy 对象

email.errors: 异常和缺陷类

email.headerregistry: 自定义标头对象

email.contentmanager: 管理 MIME 内容

内容管理器实例

email: 示例

email.message.Message: 使用 compat32 API 来表示电子邮件消息

email.mime: 从头创建电子邮件和 MIME 对象

email.header: 国际化标头

email.charset: 表示字符集

email.encoders: 编码器

email.utils: 其他工具

email.iterators: 迭代器

json --- JSON 编码和解码器

基本使用

编码器和解码器

异常

标准符合性和互操作性

字符编码

Infinite 和 NaN 数值

对象中的重复名称

顶级非对象，非数组值

实现限制

命令行界面

命令行选项

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

Mailbox 对象

Maildir

mbox

MH

Babyl

MMDF

Message 对象

MaildirMessage

mboxMessage

MHMessage

BabylMessage

MMDFMessage

异常

例子

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

MimeTypes 对象

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

安全考量

binhex --- 对binhex4文件进行编码和解码

备注

binascii --- 二进制和 ASCII 码互转

quopri --- 编码与解码经过 MIME 转码的可打印数据

结构化标记处理工具

html --- 超文本标记语言支持

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

HTML 解析器的示例程序

HTMLParser 方法

例子

html.entities --- HTML 一般实体的定义

XML处理模块

XML 漏洞

defusedxml 包

xml.etree.ElementTree --- ElementTree XML API

教程

XML 树和元素

解析 XML

用于非阻塞解析的拉取 API

查找感兴趣的元素

修改XML文件

构建 XML 文档

解析带有命名空间的 XML

XPath支持

示例

支持的XPath语法

参考

函数

XInclude 支持

示例

参考

函数

元素对象

ElementTree 对象

QName 对象

TreeBuilder 对象

XMLParser对象

XMLPullParser对象

异常

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

模块内容

DOM 中的对象

DOMImplementation 对象

节点对象

节点列表对象

文档类型对象

Document 对象

元素对象

Attr 对象

NamedNodeMap 对象

注释对象

Text 和 CDATASection 对象

ProcessingInstruction 对象

异常

一致性

类型映射

访问器方法

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.saxutils --- SAX 工具集

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

XMLReader 对象

IncrementalParser 对象

Locator 对象

InputSource 对象

Attributes 接口

AttributesNS 接口

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

XMLParser对象

ExpatError 异常

示例

内容模型描述

Expat 错误常量

互联网协议和支持

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

浏览器控制器对象

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

wsgiref.util -- WSGI 环境工具

wsgiref.headers -- WSGI 响应标头工具

wsgiref.simple_server -- 一个简单的 WSGI HTTP 服务器

wsgiref.validate --- WSGI 一致性检查器

wsgiref.handlers -- 服务器/网关基类

例子

urllib --- URL 处理模块

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 对象

例子

已停用的接口

urllib.request 的限制

urllib.response --- urllib 使用的 Response 类

urllib.parse 用于解析 URL

URL 解析

URL 解析安全

解析ASCII编码字节

结构化解析结果

URL 转码

urllib.error --- urllib.request 引发的异常类

urllib.robotparser --- robots.txt 语法分析程序

http --- HTTP 模块

HTTP 状态码

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

HTTPConnection 对象

HTTPResponse 对象

例子

HTTPMessage 对象

ftplib --- FTP 协议客户端

FTP 对象

FTP_TLS 对象

poplib --- POP3 协议客户端

POP3 对象

POP3 示例

imaplib --- IMAP4 协议客户端

IMAP4 对象

IMAP4 示例

smtplib --- SMTP 协议客户端

SMTP 对象

SMTP 示例

uuid --- RFC 4122 定义的UUID对象

示例

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

服务器创建的说明

Server 对象

请求处理器对象

例子

socketserver.TCPServer 示例

socketserver.UDPServer 示例

异步混合类

http.server --- HTTP 服务器

安全考量

http.cookies --- HTTP状态管理

Cookie 对象

Morsel 对象

示例

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

CookieJar 和 FileCookieJar 对象

FileCookieJar 的子类及其与 Web 浏览器的协同

CookiePolicy 对象

DefaultCookiePolicy 对象

Cookie 对象

例子

xmlrpc --- XMLRPC 服务端与客户端模块

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

ServerProxy 对象

DateTime 对象

Binary 对象

Fault 对象

ProtocolError 对象

MultiCall 对象

便捷函数

客户端用法的示例

客户端与服务器用法的示例

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

SimpleXMLRPCServer 对象

SimpleXMLRPCServer 示例

CGIXMLRPCRequestHandler

文档 XMLRPC 服务器

DocXMLRPCServer 对象

DocCGIXMLRPCRequestHandler

ipaddress --- IPv4/IPv6 操作库

方便的工厂函数

IP 地址

地址对象

转换字符串和整数

运算符

比较运算符

算术运算符

IP网络的定义

前缀、网络掩码和主机掩码

网络对象

运算符

逻辑运算符

迭代

作为地址容器的网络

接口对象

运算符

逻辑运算符

其他模块级别函数

自定义异常

多媒体服务

wave --- 读写WAV格式文件

Wave_read对象

Wave_write 对象

colorsys --- 颜色系统间的转换

国际化

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

GNU gettext API

基于类的 API

NullTranslations 类

GNUTranslations 类

Solaris 消息编目支持

编目构造器

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

本地化你的模块

本地化你的应用程序

即时更改语言

延迟翻译

致谢

locale --- 国际化服务

背景、细节、提示、技巧和注意事项

针对扩展程序编写人员和嵌入Python 运行的程序

访问消息目录

程序框架

turtle --- 海龟绘图

概述

可用的 Turtle 和 Screen 方法概览

Turtle 方法

TurtleScreen/Screen 方法

RawTurtle/Turtle 方法和对应函数

海龟动作

获取海龟的状态

度量单位设置

画笔控制

绘图状态

颜色控制

填充

更多绘图控制

海龟状态

可见性

外观

使用事件

特殊海龟方法

复合形状

TurtleScreen/Screen 方法及对应函数

窗口控制

动画控制

使用屏幕事件

输入方法

设置与特殊方法

Screen 专有方法, 而非继承自 TurtleScreen

公共类

帮助与配置

如何使用帮助

文档字符串翻译为不同的语言

如何配置 Screen 和 Turtle

turtledemo --- 演示脚本集

Python 2.6 之后的变化

Python 3.0 之后的变化

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

Cmd 对象

Cmd 例子

shlex —— 简单的词法分析

shlex 对象

解析规则

改进的 shell 兼容性

Tk图形用户界面(GUI)

tkinter —— Tcl/Tk 的 Python 接口

架构

Tkinter 模块

Tkinter 拾遗

Hello World 程序

重要的 Tk 概念

了解 Tkinter 如何封装 Tcl/Tk

我该如何...？这个选项会做...？

浏览 Tcl/Tk 参考手册

线程模型

快速参考

可选配置项

包装器

包装器的参数

部件与变量的关联

窗口管理器

Tk 参数的数据类型

绑定和事件

index 参数

图片

文件处理程序

tkinter.colorchooser --- 颜色选择对话框

tkinter.font --- Tkinter 字体封装

Tkinter 对话框

tkinter.simpledialog --- 标准 Tkinter 输入对话框

tkinter.filedialog --- 文件选择对话框.

原生的载入/保存对话框.

tkinter.commondialog --- 对话窗口模板

tkinter.messagebox --- Tkinter 消息提示

tkinter.scrolledtext --- 滚动文字控件

tkinter.dnd --- 拖放操作支持

tkinter.ttk --- Tk 风格的控件

ttk 的用法

ttk 控件

控件

标准属性

可滚动控件的属性

标签控件的属性

兼容性属性

控件状态

ttk.Widget

Combobox

属性

虚拟事件

ttk.Combobox

Spinbox

属性

虚拟事件

ttk.Spinbox

Notebook

属性

Tab 属性

Tab ID

虚拟事件

ttk.Notebook

Progressbar

属性

ttk.Progressbar

Separator

属性

Sizegrip

与平台相关的注意事项

Bug

Treeview

属性

数据项的属性

tag 属性

列标识

虚拟事件

ttk.Treeview

Ttk 样式

布局

tkinter.tix --- TK扩展包

使用 Tix

Tix 部件

基本部件

文件选择器

层级式列表框

表格式列表框

管理器部件

图像类型

其他部件

表单布局管理器

Tix 命令

IDLE

目录

文件菜单 （命令行和编辑器）

编辑菜单（命令行和编辑器）

格式菜单（仅 window 编辑器）

运行菜单（仅 window 编辑器）

Shell 菜单（仅限 Shell 窗口）

调试菜单（仅限 Shell 窗口）

选项菜单（命令行和编辑器）

Window 菜单（命令行和编辑器）

帮助菜单（命令行和编辑器）

上下文菜单

编辑和导航

编辑窗口

按键绑定

自动缩进

搜索和替换

补全

提示

代码上下文

Shell 窗口

文本颜色

启动和代码执行

命令行语法

启动失败

运行用户代码

Shell中的用户输出

开发 tkinter 应用程序

在没有子进程的情况下运行

帮助和首选项Help and Preferences

帮助源

首选项设置

macOS 上的IDLE

扩展

idlelib

开发工具

typing —— 对类型提示的支持

相关的 PEP

类型别名

NewType

可调对象（Callable）

泛型（Generic）

用户定义的泛型类型

Any 类型

名义子类型 vs 结构子类型

模块内容

特殊类型原语

特殊类型

特殊形式

构建泛型类型

其他特殊指令

泛型具象容器

对应的内置类型

collections 对应类型

其他具象类型

抽象基类

collections.abc 对应的容器

collections.abc 对应的其他类型

异步编程

上下文管理器类型

协议

函数与装饰器

内省辅助器

常量

pydoc --- 文档生成器和在线帮助系统

Python 开发模式

Python 开发模式的效果

ResourceWarning 示例

文件描述符错误示例

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

简单用法：检查Docstrings中的示例

简单的用法：检查文本文件中的例子

它是如何工作的

哪些文件串被检查了？

文档串的例子是如何被识别的？

什么是执行上下文？

异常如何处理？

选项标记

指令

警告

基本API

Unittest API

高级 API

DocTest 对象

Example 对象

DocTestFinder 对象

DocTestParser 对象

DocTestRunner 对象

OutputChecker 对象

调试

肥皂盒

unittest --- 单元测试框架

基本实例

命令行接口

命令行选项

探索性测试

组织你的测试代码

复用已有的测试代码

跳过测试与预计的失败

使用子测试区分测试迭代

类与函数

测试用例

一些已被弃用的别名

分组测试

加载和运行测试

load_tests 协议

类与模块设定

setUpClass 和 tearDownClass

setUpModule 和 tearDownModule

信号处理

unittest.mock --- 模拟对象库

快速上手

Mock 类

调用

删除属性

Mock 的名称与 name 属性

附加 Mock 作为属性

patch 装饰器

patch

patch.object

patch.dict

patch.multiple

补丁方法: start 和 stop

为内置函数打补丁

TEST_PREFIX

嵌套补丁装饰器

补丁的位置

对描述器和代理对象打补丁

MagicMock 与魔术方法支持

模拟魔术方法

MagicMock

辅助对象

sentinel

DEFAULT

call

create_autospec

ANY

FILTER_DIR

mock_open

自动 spec

将 mock 封包

unittest.mock --- 上手指南

使用 mock

模拟方法调用

对象上的方法调用的 mock

模拟类

命名你的 mock

追踪所有的调用

设置返回值和属性

通过 mock 引发异常

附带影响函数和可迭代对象

模拟异步迭代器

模拟异步上下文管理器

基于现有对象创建模拟对象

补丁装饰器

更多示例

模拟链式调用

部分模拟

模拟生成器方法

对每个测试方法应用相同的补丁

模拟未绑定方法

通过 mock 检查多次调用

处理可变参数

嵌套补丁

使用 MagicMock 模拟字典

模拟子类及其属性

通过 patch.dict 模拟导入

追踪调用顺序和不太冗长的调用断言

更复杂的参数匹配

2to3 --- 自动化的 Python 2 到 3 代码转写

使用 2to3

修复器

lib2to3 --- 2to3 的库

test --- Python 回归测试包

为 test 包编写单元测试

使用命令行界面运行测试

test.support --- 针对 Python 测试套件的工具

test.support.socket_helper --- 用于套接字测试的工具

test.support.script_helper --- 用于 Python 执行测试工具

test.support.bytecode_helper --- 用于测试正确字节码生成的支持工具

test.support.threading_helper --- 用于线程测试的工具

test.support.os_helper --- 用于操作系统测试的工具

test.support.import_helper --- 用于导入测试的工具

test.support.warnings_helper --- 用于警告测试的工具

调试和分析

审计事件表

bdb --- 调试器框架

faulthandler —— 转储 Python 的跟踪信息

转储跟踪信息

故障处理程序的状态

一定时间后转储跟踪数据。

转储用户信号的跟踪信息。

文件描述符相关话题

示例

pdb --- Python 的调试器

调试器命令

Python 性能分析器

性能分析器简介

实时用户手册

profile 和 cProfile 模块参考

Stats 类

什么是确定性性能分析？

局限性

准确估量

使用自定义计时器

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

基本示例

Python 接口

命令行接口

例子

trace —— 跟踪 Python 语句的执行

命令行用法

主要的可选参数

修饰器

过滤器

编程接口

tracemalloc --- 跟踪内存分配

例子

显示前10项

计算差异

获取一个内存块的溯源

美化的 top

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

API

函数

域过滤器

过滤器

帧

快照

统计

StatisticDiff

跟踪

回溯

软件打包和分发

distutils 构建和安装 Python 模块

ensurepip --- 引导 pip 安装器

命令行界面

模块 API

venv --- 创建虚拟环境

创建虚拟环境

虚拟环境是如何实现的

API

一个扩展 EnvBuilder 的例子

zipapp —— 管理可执行的 Python zip 打包文件

简单示例

命令行接口

Python API

例子

指定解释器程序

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

制作 Windows 可执行文件

注意事项

Python 打包应用程序的格式

Python 运行时服务

sys --- 系统相关的形参和函数

sysconfig —— 提供对 Python 配置信息的访问支持

配置变量

安装路径

其他功能

将 sysconfig 作为脚本使用

builtins --- 内建对象

__main__ ——顶层代码环境

__name__ == '__main__'

什么是“顶层代码环境”？

惯用法

打包考量

Python 包中的 __main__.py

惯用法

import __main__

warnings ——控制警告信息

警告类别

警告过滤器

警告过滤器的介绍

默认警告过滤器

重写默认的过滤器

暂时禁止警告

测试警告

为新版本的依赖关系更新代码

可用的函数

可用的上下文管理器

dataclasses --- 数据类

模块内容

初始化后处理

类变量

仅初始化变量

冻结的实例

继承

__init__() 中仅限关键字字段的重新排序

默认工厂函数

可变的默认值

描述器类型的字段

contextlib --- 为 with语句上下文提供的工具

工具

例子和配方

支持可变数量的上下文管理器

捕获 __enter__ 方法产生的异常

在一个 __enter__ 方法的实现中进行清理

替换任何对 try-finally 和旗标变量的使用

将上下文管理器作为函数装饰器使用

单独使用，可重用并可重进入的上下文管理器

重进入上下文管理器

可重用的上下文管理器

abc --- 抽象基类

atexit --- 退出处理器

atexit 示例

traceback —— 打印或读取栈回溯信息

TracebackException 对象

StackSummary 对象

FrameSummary 对象

回溯示例

__future__ --- Future 语句定义

gc --- 垃圾回收器接口

inspect --- 检查对象

类型和成员

获取源代码

使用 Signature 对象对可调用对象进行内省

类与函数

解释器栈

静态地获取属性

生成器和协程的当前状态

代码对象位标志

命令行界面

site —— 指定域的配置钩子

Readline 配置

模块内容

命令行界面

自定义 Python 解释器

code --- 解释器基类

交互解释器对象

交互式控制台对象

codeop --- 编译Python代码

导入模块

zipimport --- 从 Zip 存档中导入模块

zipimporter 对象

例子

pkgutil --- 包扩展工具

modulefinder --- 查找脚本使用的模块

ModuleFinder 的示例用法

runpy ——查找并执行 Python 模块

importlib --- import 的实现

概述

函数

importlib.abc —— 关于导入的抽象基类

importlib.resources -- 资源

importlib.machinery —— 导入器和路径钩子函数。

importlib.util —— 导入器的工具程序代码

例子

用编程方式导入

检查某模块可否导入。

直接导入源码文件。

实现延迟导入

导入器的配置

importlib.import_module() 的近似实现

使用 importlib.metadata

概述

函数式 API

入口点

分发的元数据

分发包的版本

分发包的文件

分发包的依赖

包的分发

分发包对象

扩展搜索算法

Python 语言服务

ast --- 抽象语法树

抽象文法

节点类

字面值

变量

表达式

抽取

推导式

语句

导入

控制流

模式匹配

函数与类定义

async 与 await

ast 中的辅助函数

编译器旗标

命令行用法

symtable ——访问编译器的符号表

符号表的生成

符号表的查看

token --- 与Python解析树一起使用的常量

keyword --- 检验Python关键字

tokenize --- 对 Python 代码使用的标记解析器

对输入进行解析标记

命令行用法

例子

tabnanny --- 模糊缩进检测

pyclbr --- Python 模块浏览器支持

Function 对象

Class 对象

py_compile --- 编译 Python 源文件

命令行接口

compileall --- 字节编译 Python 库

使用命令行

公有函数

dis --- Python 字节码反汇编器

字节码分析

分析函数

Python字节码说明

操作码集合

pickletools --- pickle 开发者工具集

命令行语法

命令行选项

编程接口

Windows系统相关模块

msvcrt --- 来自 MS VC++ 运行时的有用例程

文件操作

控制台 I/O

其他函数

winreg --- 访问 Windows 注册表

函数

常量

HKEY_* 常量

访问权限

64 位系统特有

注册表值的类型

注册表句柄对象

winsound —— Windows 系统的音频播放接口

Unix 专有服务

posix --- 最常见的 POSIX 系统调用

大文件支持

重要的模块内容

pwd --- 用户密码数据库

grp --- 组数据库

termios --- POSIX 风格的 tty 控制

示例

tty --- 终端控制功能

pty --- 伪终端工具

示例

fcntl —— 系统调用 fcntl 和 ioctl

resource --- 资源使用信息

资源限制

资源用量

Unix syslog 库例程

例子

简单示例

被取代的模块

aifc --- 读写 AIFF 和 AIFC 文件

asynchat --- 异步套接字指令/响应处理程序

asynchat 示例

asyncore --- 异步套接字处理器

asyncore 示例基本 HTTP 客户端

asyncore 示例基本回显服务器

audioop --- 处理原始音频数据

cgi --- 通用网关接口支持

概述

使用 cgi 模块

更高层级的接口

函数

对于安全性的关注

在 Unix 系统上安装你的 CGI 脚本

测试你的 CGI 脚本

调试 CGI 脚本

常见问题和解决方案

cgitb --- 用于 CGI 脚本的回溯管理器

chunk --- 读取 IFF 分块数据

crypt —— 验证 Unix 口令的函数

哈希方法

模块属性

模块函数

例子

imghdr --- 推测图像类型

imp --- 访问 import 内部对象

例子

mailcap --- Mailcap 文件处理

msilib --- 读写 Microsoft Installer 文件

数据对象

视图对象

对象总览

记录对象

错误

CAB 对象

目录对象

相关特性

GUI 类

预计算的表

nis --- Sun 的 NIS (黄页) 接口

nntplib --- NNTP 协议客户端

NNTP 对象

属性

方法

工具函数

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

背景

术语

选项的作用是什么？

位置参数有什么用？

教程

理解选项动作

store 动作

处理布尔值（旗标）选项

其他动作

默认值

生成帮助

选项分组

打印版本字符串

optparse 如何处理错误handles errors

合并所有代码

参考指南

创建解析器

填充解析器

定义选项

选项属性

标准选项动作

标准选项类型

解析参数

查询和操纵你的选项解析器

选项之间的冲突

清理

其他方法

选项回调

定义回调选项

回调应当如何调用

在回调中引发错误

回调示例 1：最简回调

回调示例 2：检查选项顺序

回调示例 3：检查选项顺序（通用）

回调示例 4：检查任意条件

回调示例 5：固定的参数

回调示例 6：可变的参数

扩展 optparse

添加新的类型

添加新的动作

ossaudiodev --- 访问兼容OSS的音频设备

音频设备对象

混音器设备对象

pipes --- 终端管道接口

模板对象

smtpd --- SMTP 服务器

SMTPServer 对象

DebuggingServer 对象

PureProxy 对象

MailmanProxy 对象

SMTPChannel 对象

sndhdr --- 推测声音文件的类型

spwd —— shadow 密码库

sunau --- 读写 Sun AU 文件

AU_read 对象

AU_write 对象

telnetlib -- Telnet 客户端

Telnet 对象

Telnet 示例

uu --- 对 uuencode 文件进行编码与解码

xdrlib --- 编码与解码 XDR 数据

Packer 对象

Unpacker 对象

异常

安全考量

扩展和嵌入 Python 解释器

推荐的第三方工具

不使用第三方工具创建扩展

1. 使用 C 或 C++ 扩展 Python

1.1. 一个简单的例子

1.2. 关于错误和异常

1.3. 回到例子

1.4. 模块方法表和初始化函数

1.5. 编译和链接

1.6. 在C中调用Python函数

1.7. 提取扩展函数的参数

1.8. 给扩展函数的关键字参数

1.9. 构造任意值

1.10. 引用计数

1.10.1. Python中的引用计数

1.10.2. 拥有规则

1.10.3. 危险的薄冰

1.10.4. NULL指针

1.11. 在C++中编写扩展

1.12. 给扩展模块提供C API

2. 自定义扩展类型：教程

2.1. 基础

2.2. 向基本示例添加数据和方法

2.3. 提供对于数据属性的更精细控制

2.4. 支持循环垃圾回收

2.5. 子类化其他类型

3. 定义扩展类型：已分类主题

3.1. 终结和内存释放

3.2. 对象展示

3.3. 属性管理

3.3.1. 泛型属性管理

3.3.2. 类型专属的属性管理

3.4. 对象比较

3.5. 抽象协议支持

3.6. 弱引用支持

3.7. 更多建议

4. 构建C/C++扩展

4.1. 使用distutils构建C和C++扩展

4.2. 发布你的扩展模块

5. 在 Windows 上构建 C 和 C++ 扩展

5.1. 菜谱式说明

5.2. Unix 和 Windows 之间的差异

5.3. DLL 的实际使用

在更大的应用程序中嵌入 CPython 运行时

1. 在其它应用程序嵌入 Python

1.1. 高层次的嵌入

1.2. 突破高层次嵌入的限制：概述

1.3. 只做嵌入

1.4. 对嵌入 Python 功能进行扩展

1.5. 在 C++ 中嵌入 Python

1.6. 在类 Unix 系统中编译和链接

Python/C API 参考手册

概述

代码标准

包含文件

有用的宏

对象、类型和引用计数

引用计数

引用计数细节

类型

异常

嵌入Python

调试构建

C API 的稳定性

应用程序二进制接口的稳定版

受限 API 的作用域和性能

受限 API 警示

平台的考虑

受限 API 的内容

极高层级 API

引用计数

异常处理

打印和清理

抛出异常

发出警告

查询错误指示器

信号处理

Exception 类

异常对象

Unicode 异常对象

递归控制

标准异常

标准警告类别

工具

操作系统实用工具

系统功能

过程控制

导入模块

数据 marshal 操作支持

解析参数并构建值变量

解析参数

字符串和缓存区

数字

其他对象

API 函数

创建变量

字符串转换与格式化

反射

编解码器注册与支持功能

Codec 查找API

用于Unicode编码错误处理程序的注册表API

抽象对象层

对象协议

调用协议

tp_call 协议

Vectorcall 协议

递归控制

Vectorcall 支持 API

调用对象的 API

调用支持 API

数字协议

序列协议

映射协议

迭代器协议

缓冲协议

缓冲区结构

缓冲区请求的类型

与请求无关的字段

只读，格式

形状，步幅，子偏移量

连续性的请求

复合请求

复杂数组

NumPy-风格：形状和步幅

PIL-风格：形状，步幅和子偏移量

缓冲区相关函数

旧缓冲协议

具体的对象层

基本对象

类型对象

创建堆分配类型

None 对象

数值对象

整数型对象

布尔对象

浮点数对象

复数对象

表示复数的C结构体

表示复数的Python对象

序列对象

bytes 对象

字节数组对象

类型检查宏

直接 API 函数

宏

Unicode对象和编解码器

Unicode对象

Unicode类型

Unicode字符属性

创建和访问 Unicode 字符串

已弃用的 Py_UNICODE API

语言区域编码格式

文件系统编码格式

wchar_t 支持

内置编解码器

泛型编解码器

UTF-8 编解码器

UTF-32 编解码器

UTF-16 编解码器

UTF-7 编解码器

Unicode-Escape 编解码器

Raw-Unicode-Escape 编解码器

Latin-1 编解码器

ASCII 编解码器

字符映射编解码器

Windows 中的 MBCS 编解码器

方法和槽位

方法与槽位函数

元组对象

结构序列对象

列表对象

容器对象

字典对象

集合对象

Function 对象

Function 对象

实例方法对象

方法对象

Cell 对象

代码对象

其他对象

文件对象

模块对象

初始化 C 模块

单阶段初始化

多阶段初始化

底层模块创建函数

支持函数

查找模块

迭代器对象

描述符对象

切片对象

Ellipsis 对象

MemoryView 对象

弱引用对象

Capsule 对象

生成器对象

协程对象

上下文变量对象

DateTime 对象

类型注解对象

初始化，最终化和线程

在Python初始化之前

全局配置变量

初始化和最终化解释器

进程级参数

线程状态和全局解释器锁

从扩展扩展代码中释放 GIL

非Python创建的线程

有关 fork() 的注意事项

高阶 API

底层级 API

子解释器支持

错误和警告

异步通知

分析和跟踪

高级调试器支持

线程本地存储支持

线程专属存储 (TSS) API

动态分配

方法

线程本地存储 (TLS) API

Python初始化配置

示例

PyWideStringList

PyStatus

PyPreConfig

使用 PyPreConfig 预初始化 Python

PyConfig

使用 PyConfig 初始化

隔离配置

Python 配置

Python 路径配置

Py_RunMain()

Py_GetArgcArgv()

多阶段初始化私有暂定 API

内存管理

概述

分配器域

原始内存接口

内存接口

对象分配器

默认内存分配器

自定义内存分配器

Python 内存分配器的调试钩子

pymalloc 分配器

自定义 pymalloc Arena 分配器

tracemalloc C API

例子

对象实现支持

在堆上分配对象

公用对象结构体

基本的对象类型和宏

实现函数和方法

访问扩展类型的属性

类型对象

快速参考

"tp 槽位"

子槽位

槽位 typedef

PyTypeObject 定义

PyObject 槽位

PyVarObject 槽位

PyTypeObject 槽

静态类型

堆类型

数字对象结构体

映射对象结构体

序列对象结构体

缓冲区对象结构体

异步对象结构体

槽位类型 typedef

例子

使对象类型支持循环垃圾回收

控制垃圾回收器状态

API 和 ABI 版本管理

分发 Python 模块

关键术语

开源许可与协作

安装相关工具

阅读 Python 打包用户指南

我该如何...？

...为我的项目选择一个名字？

...创建和分发二进制扩展？

安装 Python 模块

关键术语

基本使用

我应如何 ...？

... 在 Python 3.4 之前的 Python 版本中安装 pip ？

... 只为当前用户安装软件包？

... 安装科学计算类 Python 软件包？

... 使用并行安装的多个 Python 版本？

常见的安装问题

在 Linux 的系统 Python 版本上安装

未安装 pip

安装二进制编译扩展

Python 指南

将 Python 2 代码迁移到 Python 3

简要说明

详情

删除对Python 2.6及更早版本的支持

确保你在你的 setup.py 文件中指定适当的版本支持

良好的测试覆盖率

了解Python 2 和 3之间的区别

更新代码

除法

文本与二进制数据

使用特征检测而不是版本检测

防止兼容性退步

检查哪些依赖性会阻碍你的过渡

更新你的 setup.py 文件以表示对Python 3的兼容

使用持续集成以保持兼容

考虑使用可选的静态类型检查

将扩展模块移植到 Python 3

用 Python 进行 Curses 编程

curses 是什么？

Python 的 curses 模块

开始和结束 curses 应用程序

窗口和面板

显示文字

属性和颜色

用户输入

更多的信息

描述器使用指南

入门

简单示例：返回常量的描述器

动态查找

托管属性

定制名称

结束语

完整的实际例子

验证器类

自定义验证器

实际应用

技术教程

摘要

定义与介绍

描述器协议

描述器调用概述

通过实例调用

通过类调用

通过 super 调用

调用逻辑总结

自动名称通知

ORM （对象关系映射）示例

纯 Python 等价实现

属性

函数和方法

方法的种类

静态方法

类方法

成员对象和 __slots__

函数式编程指引

概述

形式证明

模块化

易于调试和测试

组合性

迭代器

支持迭代器的数据类型

生成器表达式和列表推导式

生成器

向生成器传递值

内置函数

itertools 模块

创建新的迭代器

对元素使用函数

选择元素

组合函数

为元素分组

functools 模块

operator 模块

小函数和 lambda 表达式

修订记录和致谢

参考文献

通用文献

Python 相关

Python 文档

日志指南

日志基础教程

什么时候使用日志

一个简单的例子

记录日志到文件

从多个模块记录日志

记录变量数据

更改显示消息的格式

在消息中显示日期/时间

后续步骤

进阶日志教程

记录流程

记录器

处理器

格式器

配置日志记录

如果没有提供配置会发生什么

为库配置日志

日志级别

自定义级别

有用的处理器

记录日志时引发的异常

使用任意对象作为消息

优化

日志专题手册

在多模块中使用日志

在多个线程中记录日志

多个 handler 和多种 formatter

在多个地方记录日志

自定义处理级别

日志配置服务器示例

处理日志 handler 的阻塞

通过网络收发日志事件

在生产中运行日志套接字侦听器

在自己的输出日志中添加上下文信息

利用 LoggerAdapter 传递上下文信息

使用除字典之外的其它对象传递上下文信息

使用过滤器传递上下文信息

contextvars 的使用

在处理器中传递上下文信息

从多个进程记录至单个文件

concurrent.futures.ProcessPoolExecutor 的用法

使用 Gunicorn 和 uWSGI 来部署 Web 应用程序

轮换日志文件

使用其他日志格式化方式

自定义 LogRecord

子类化 QueueHandler - ZeroMQ 示例

子类化 QueueListener —— ZeroMQ 示例

基于字典进行日志配置的示例

利用 rotator 和 namer 自定义日志轮换操作

更加详细的多道处理示例

在发送给 SysLogHandler 的信息中插入一个 BOM。

结构化日志的实现代码

利用 dictConfig() 自定义 handler

生效于整个应用程序的格式化样式

LogRecord 工厂的用法

自定义信息对象的使用

利用 dictConfig() 定义过滤器

异常信息的自定义格式化

语音播报日志信息

缓冲日志消息并有条件地输出它们

将日志消息发送至电子邮件，附带缓存支持

通过配置使用UTC (GMT) 格式化时间

使用上下文管理器的可选的日志记录

命令行日志应用起步

Qt GUI 日志示例

将日志记录到带有 RFC5424 支持的 syslog

如何将日志记录器作为输出流

理应避免的用法

多次打开同一个日志文件

将日志对象用作属性或传递参数

给日志库代码添加 NullHandler 之外的其他 handler

创建大量的日志对象

其它资源

正则表达式指南

概述

简单正则

匹配字符

重复

使用正则表达式

编译正则表达式

反斜杠灾难

应用匹配

模块级函数

编译标志

更多模式能力

更多元字符

分组

非捕获和命名组

前视断言

修改字符串

分割字符串

搜索和替换

常见问题

使用字符串方法

match() 和 search()

贪婪与非贪婪

使用 re.VERBOSE

反馈

套接字编程指南

套接字

历史

创建套接字

进程间通信

使用一个套接字

二进制数据

断开连接

套接字何时销毁

非阻塞的套接字

排序指南

排序的基础知识

键函数

Operator 模块函数

升序与降序

排序稳定性与复杂排序

使用装饰-排序-去装饰的旧方法

使用 cmp 参数的旧方法

其它

Unicode 指南

Unicode 概述

定义

编码

参考文献

Python对Unicode的支持

字符串类型

转换为字节

Python 源代码中的 Unicode 文字

Unicode属性

字符串比较

Unicode 正则表达式

参考文献

Unicode 数据的读写

Unicode 文件名

识别 Unicode 的编程技巧

在文件编码格式之间进行转换

编码格式未知的文件

参考文献

致谢

如何利用 urllib 包获取网络资源

概述

获取 URL 资源

数据

HTTP 头部信息

异常的处理

URLError

HTTPError

错误代码

总之

第一种方案

第二种方案

info 和 geturl 方法

Opener 和 Handler

基本认证

代理

套接字与分层

备注

argparse 教程

概念

基础

位置参数介绍

可选参数介绍

短选项

结合位置参数和可选参数

进行一些小小的改进

矛盾的选项

后记

ipaddress模块介绍

创建 Address/Network/Interface 对象

关于IP版本的说明

IP主机地址

定义网络

主机接口

审查 Address/Network/Interface 对象

Network 作为 Address 列表

比较运算

将IP地址与其他模块一起使用

实例创建失败时获取更多详细信息

Argument Clinic 的用法

Argument Clinic 的设计目标

基本概念和用法

函数的转换

进阶

符号化默认值

对 Argument Clinic 生成的 C 函数和变量进行重命名

函数转换会用到 PyArg_UnpackTuple

可选参数组

采用真正的 Argument Clinic 转换器，而不是 “传统转换器”

Py_buffer

高级转换器

参数的默认值

默认值 NULL

设为默认值的表达式

返回值转换器

克隆已有的函数

调用 Python 代码

self 转换器的用法

“定义类”转换器

编写自定义转换器

编写自定义的返回值转换器

METH_O 和 METH_NOARGS

tp_new 和 tp_init functions

改变和重定向 Clinic 的输出

#ifdef 使用技巧

在 Python 文件中使用 Argument Clinic

使用 DTrace 和 SystemTap 检测CPython

启用静态标记

静态DTrace探针

静态SystemTap标记

可用的静态标记

SystemTap Tapsets

例子

注解最佳实践

在 3.10 及更高版本的 Python 中访问对象的注解字典

在 3.9 及更低版本的 Python 中访问对象的注解字典

解析字符串形式的注解

任何版本 Python 中使用 __annotations__ 的最佳实践

__annotations__ 的一些“坑”

Python 常见问题

Python常见问题

一般信息

现实世界中的 Python

编程常见问题

一般问题

语言核心内容

数字和字符串

性能

序列（元组/列表）

对象

模块

设计和历史常见问题

为什么 Python 使用缩进来分组语句？

为什么简单的算术运算得到奇怪的结果？

为什么浮点计算不准确？

为什么Python字符串是不可变的？

为什么必须在方法定义和调用中显式使用“self”？

为什么不能在表达式中赋值？

为什么Python对某些功能（例如list.index()）使用方法来实现，而其他功能（例如len(List)）使用函数实现？

为什么 join() 是一个字符串方法而不是列表或元组方法？

异常有多快？

为什么Python中没有switch或case语句？

难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？

为什么lambda表达式不能包含语句？

可以将Python编译为机器代码，C或其他语言吗？

Python如何管理内存？

为什么CPython不使用更传统的垃圾回收方案？

CPython退出时为什么不释放所有内存？

为什么有单独的元组和列表数据类型？

列表是如何在CPython中实现的？

字典是如何在CPython中实现的？

为什么字典key必须是不可变的？

为什么 list.sort() 没有返回排序列表？

如何在Python中指定和实施接口规范？

为什么没有goto？

为什么原始字符串（r-strings）不能以反斜杠结尾？

为什么Python没有属性赋值的“with”语句？

生成器为什么不支持 with 语句？

为什么 if/while/def/class语句需要冒号？

为什么Python在列表和元组的末尾允许使用逗号？

代码库和插件 FAQ

通用的代码库问题

通用任务

线程相关

输入与输出

网络 / Internet 编程

数据库

数学和数字

扩展/嵌入常见问题

可以使用 C 语言创建自己的函数吗？

可以使用 C++ 语言创建自己的函数吗？

C很难写，有没有其他选择？

如何在 C 中执行任意 Python 语句？

如何在 C 中对任意 Python 表达式求值？

如何从Python对象中提取C的值？

如何使用Py_BuildValue()创建任意长度的元组？

如何从C调用对象的方法？

如何捕获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 文件相同吗？

我怎样将 Python 嵌入一个 Windows 程序？

如何让编辑器不要在我的 Python 源代码中插入 tab ？

如何在不阻塞的情况下检查按键？

我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0.dll 错误？

图形用户界面（GUI）常见问题

图形界面常见问题

Python 有哪些 GUI 工具包？

有关Tkinter的问题

“为什么我的电脑上安装了 Python ？”

什么是 Python？

为什么我的电脑上安装了 Python ？

我能删除 Python 吗？

术语对照表

文档说明

Python 文档的贡献者

处理错误

文档错误

使用 Python 的问题追踪系统

开始为 Python 贡献您的知识

版权所有

历史和许可证

该软件的历史

获取或以其他方式使用 Python 的条款和条件

用于 PYTHON 3.10.20 的 PSF 许可协议

用于 PYTHON 2.0 的 BEOPEN.COM 许可协议

用于 PYTHON 1.6.1 的 CNRI 许可协议

用于 PYTHON 0.9.0 至 1.2 的 CWI 许可协议

ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON 3.10.20 DOCUMENTATION

收录软件的许可与鸣谢

Mersenne Twister

套接字

异步套接字服务

Cookie 管理

执行追踪

UUencode 与 UUdecode 函数

XML 远程过程调用

test_epoll

Select kqueue

SipHash24

strtod 和 dtoa

OpenSSL

expat

libffi

zlib

cfuhash

libmpdec

W3C C14N 测试套件

audioop

Python的新变化

这个“Python 有什么新变化？”系列内容会带您浏览 Python 大版本之间重要的变化。在新版发布后，如果您希望掌握最新变化，请务必阅读这些内容。

Python 3.10 有什么新变化

摘要 -- 发布重点

新的特性

有关类型提示的新增特性

其他语言特性修改

新增模块

改进的模块

性能优化

弃用

移除

移植到 Python 3.10

CPython 字节码的改变

构建的改变

C API 的改变

3.10.7 中的重要安全特性

3.10.8 中的重要安全特性

Notable Changes in 3.10.12

Notable changes in 3.10.15

Notable changes in 3.10.18

Python 3.9 有什么新变化

摘要 -- 发布重点

请检查代码中的 DeprecationWarning。

新的特性

其他语言特性修改

新增模块

改进的模块

性能优化

弃用

移除

移植到 Python 3.9

构建的改变

C API 的改变

Python 3.9.1 中的重要变化

Python 3.9.2 中的重要变化

Python 3.8 有什么新变化

摘要 -- 发布重点

新的特性

其他语言特性修改

新增模块

改进的模块

性能优化

构建和 C API 的改变

弃用

API 与特性的移除

移植到 Python 3.8

Python 3.8.1 中的重要变化

Python 3.8.8 中的重要变化

Python 3.8.12 中的重要变化

Python 3.7 有什么新变化

摘要 - 发布重点

新的特性

其他语言特性修改

新增模块

改进的模块

C API 的改变

构建的改变

性能优化

其他 CPython 实现的改变

已弃用的 Python 行为

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

已弃用的 C API 函数和类型

平台支持的移除

API 与特性的移除

移除的模块

Windows 专属的改变

移植到 Python 3.7

Python 3.7.1 中的重要变化

Python 3.7.2 中的重要变化

Python 3.7.6 中的重要变化

Python 3.7.10 中的重要变化

Python 3.6 有什么新变化

摘要 -- 发布重点

新的特性

其他语言特性修改

新增模块

改进的模块

性能优化

构建和 C API 的改变

其他改进

弃用

移除

移植到Python 3.6

Python 3.6.2 中的重要变化

Python 3.6.4 中的重要变化

Python 3.6.5 中的重要变化

Python 3.6.7 中的重要变化

Python 3.6.10 中的重要变化

Python 3.6.13 中的重要变化

Python 3.5 有什么新变化

摘要 -- 发布重点

新的特性

其他语言特性修改

新增模块

改进的模块

其他模块级更改

性能优化

构建和 C API 的改变

弃用

移除

移植到Python 3.5

Python 3.5.4 的显著变化

Python 3.4 有什么新变化

摘要 - 发布重点

新的特性

新增模块

改进的模块

CPython 实现的变化

弃用

移除

移植到 Python 3.4

3.4.3 的变化

Python 3.3 有什么新变化

摘要 -- 发布重点

PEP 405: 虚拟环境

PEP 420: 隐式命名空间包

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

PEP 393: 灵活的字符串表示

PEP 397: 适用于Windows的Python启动器

PEP 3151: 重写 OS 和 IO 异常的层次结构

PEP 380: 委托给子生成器的语法

PEP 409: 清除异常上下文

PEP 414: 显式的Unicode文本

PEP 3155: 类和函数的限定名称

PEP 412: Key-Sharing Dictionary

PEP 362: 函数签名对象

PEP 421: 添加 sys.implementation

使用 importlib 作为导入的实现

其他语言特性修改

更细粒度的导入锁

内置函数和类型

新增模块

改进的模块

性能优化

构建和 C API 的改变

弃用

移植到 Python 3.3

Python 3.2 有什么新变化

PEP 384: 定义稳定的ABI

PEP 389: Argparse 命令行解析模块

PEP 391: 基于字典的日志配置

PEP 3148: concurrent.futures 模块

PEP 3147: PYC 仓库目录

PEP 3149: 带有 ABI 版本标签的 .so 文件

PEP 3333: Python Web服务器网关接口v1.0.1

其他语言特性修改

新增，改进和弃用的模块

多线程

性能优化

Unicode

编解码器

文档

IDLE

代码库

构建和 C API 的改变

移植到 Python 3.2

Python 3.1 有什么新变化

PEP 372: 有序字典

PEP 378: 千位分隔符的格式说明符

其他语言特性修改

新增，改进和弃用的模块

性能优化

IDLE

构建和 C API 的改变

移植到 Python 3.1

Python 3.0 有什么新变化

常见的绊脚石

语法变化概述

已存在于 Python 2.6 中的改变

库的修改

PEP 3101: 字符串格式化的新方式

对异常的修改

其他杂项修改

构建和 C API 的改变

性能

移植到 Python 3.0

Python 2.7 有什么新变化

Python 2.x的未来

对于弃用警告处理方式的改变

Python 3.1 特性

PEP 372：将有序字典 添加到收藏集

PEP 378: 千位分隔符的格式说明符

PEP 389：用于解析命令行的 argparse 模块

PEP 391: 基于字典的日志配置

PEP 3106: 字典视图

PEP 3137: memoryview 对象

其他语言特性修改

新增和改进的模块

构建和 C API 的改变

其他的改变和修正

移植到 Python 2.7

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

致谢

Python 2.6 有什么新变化

Python 3.0

开发过程的变化

PEP 343: "with" 语句

PEP 366: 从主模块显式相对导入

PEP 370: 分用户的 site-packages 目录

PEP 371: 多任务处理包

PEP 3101: 高级字符串格式

PEP 3105: print 改为函数

PEP 3110: 异常处理的变更

PEP 3112: 字节字面值

PEP 3116: 新 I/O 库

PEP 3118: 修改缓冲区协议

PEP 3119: 抽象基类

PEP 3127: 整型文字支持和语法

PEP 3129: 类装饰器

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

其他语言特性修改

新增和改进的模块

弃用和移除

构建和 C API 的改变

移植到Python 2.6

致谢

Python 2.5 有什么新变化

PEP 308: 条件表达式

PEP 309: 部分功能应用

PEP 314: Python软件包的元数据 v1.1

PEP 328: 绝对导入和相对导入

PEP 338: 将模块作为脚本执行

PEP 341: 统一 try/except/finally

PEP 342: 生成器的新特性

PEP 343: "with" 语句

PEP 352: 异常作为新型的类

PEP 353: 使用ssize_t作为索引类型

PEP 357: '__index__' 方法

其他语言特性修改

新增，改进和删除的模块

构建和 C API 的改变

移植到Python 2.5

致谢

Python 2.4 有什么新变化

PEP 218: 内置集合对象

PEP 237: 统一长整数和整数

PEP 289: 生成器表达式

PEP 292: 更简单的字符串替换

PEP 318: 函数和方法的装饰器

PEP 322: 反向迭代

PEP 324: 新的子进程模块

PEP 327: 十进制数据类型

PEP 328: 多行导入

PEP 331: 与区域设置无关的浮点数/字符串转换

其他语言特性修改

新增，改进和弃用的模块

构建和 C API 的改变

移植到 Python 2.4

致谢

Python 2.3 有什么新变化

PEP 218: 标准集合数据类型

PEP 255: 简单的生成器

PEP 263: 源代码的字符编码格式

PEP 273: 从ZIP压缩包导入模块

PEP 277: 针对 Windows NT 的 Unicode 文件名支持

PEP 278: 通用换行支持

PEP 279: enumerate()

PEP 282: logging 包

PEP 285: 布尔类型

PEP 293: 编解码器错误处理回调

PEP 301: Distutils的软件包索引和元数据

PEP 302: 新导入钩子

PEP 305: 逗号分隔文件

PEP 307：对 pickle 的改进

扩展切片

其他语言特性修改

新增，改进和弃用的模块

Pymalloc：一种专用对象分配器

构建和 C API 的改变

其他的改变和修正

移植到 Python 2.3

致谢

Python 2.2 有什么新变化

概述

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

PEP 234: 迭代器

PEP 255: 简单的生成器

PEP 237: 统一长整数和整数

PEP 238：修改除法运算符

Unicode 的改变

PEP 227: 嵌套的作用域

新增和改进的模块

解释器的改变和修正

其他的改变和修正

致谢

Python 2.1 有什么新变化

概述

PEP 227: 嵌套的作用域

PEP 236: __future__ 指令

PEP 207: 富比较

PEP 230: 警告框架

PEP 229: 新的构建系统

PEP 205: 弱引用

PEP 232: 函数属性

PEP 235: 在大小写不敏感的平台上导入模块

PEP 217: 交互模式显示钩子

PEP 208: 新的强制转换模型

PEP 241: Python 包中的元数据

新增和改进的模块

其他的改变和修正

致谢

Python 2.0 有什么新变化

概述

Python 1.6 将会怎样？

新开发流程

Unicode

列表推导式

增强赋值

字符串的方法

循环的垃圾回收

其他核心变化

移植 Python 2.0

扩展/嵌入更改

Distutils：使模块易于安装

XML 模块

模块更改

新增模块

IDLE 改进

删除和弃用的模块

致谢

这个“更新日志”是 Misc/NEWS.d [https://github.com/python/cpython/tree/3.10/Misc/NEWS.d] 目录下文件 构建 [https://pypi.org/project/blurb] 的 HTML 版本，它包含了对当前 Python 版本进行的 所有 重要的更改。

更新日志

Python 3.10.20 final

Python 3.10.19 final

Python 3.10.18 final

Python 3.10.17 final

Python 3.10.16 final

Python 3.10.15 final

Python 3.10.14 final

Python 3.10.13 final

Python 3.10.12 final

Python 3.10.11 final

Python 3.10.10 final

Python 3.10.9 final

Python 3.10.8 final

Python 3.10.7 final

Python 3.10.6 final

Python 3.10.5 final

Python 3.10.4 final

Python 3.10.3 final

Python 3.10.2 final

Python 3.10.1 final

Python 3.10.0 final

Python 3.10.0 release candidate 2

Python 3.10.0 release candidate 1

Python 3.10.0 beta 4

Python 3.10.0 beta 3

Python 3.10.0 beta 2

Python 3.10.0 beta 1

Python 3.10.0 alpha 7

Python 3.10.0 alpha 6

Python 3.10.0 alpha 5

Python 3.10.0 alpha 4

Python 3.10.0 alpha 3

Python 3.10.0 alpha 2

Python 3.10.0 alpha 1

Python 3.9.0 beta 1

Python 3.9.0 alpha 6

Python 3.9.0 alpha 5

Python 3.9.0 alpha 4

Python 3.9.0 alpha 3

Python 3.9.0 alpha 2

Python 3.9.0 alpha 1

Python 3.8.0 beta 1

Python 3.8.0 alpha 4

Python 3.8.0 alpha 3

Python 3.8.0 alpha 2

Python 3.8.0 alpha 1

Python 3.7.0 正式版

Python 3.7.0 rc1

Python 3.7.0 beta 5

Python 3.7.0 beta 4

Python 3.7.0 beta 3

Python 3.7.0 beta 2

Python 3.7.0 beta 1

Python 3.7.0 alpha 4

Python 3.7.0 alpha 3

Python 3.7.0 alpha 2

Python 3.7.0 alpha 1

Python 3.6.6 正式版

Python 3.6.6 rc1

Python 3.6.5 正式版

Python 3.6.5 rc1

Python 3.6.4 正式版

Python 3.6.4 rc1

Python 3.6.3 正式版

Python 3.6.3 rc1

Python 3.6.2 正式版

Python 3.6.2 rc2

Python 3.6.2 rc1

Python 3.6.1 正式版

Python 3.6.1 rc1

Python 3.6.0 正式版

Python 3.6.0 rc2

Python 3.6.0 rc1

Python 3.6.0 beta 4

Python 3.6.0 beta 3

Python 3.6.0 beta 2

Python 3.6.0 beta 1

Python 3.6.0 alpha 4

Python 3.6.0 alpha 3

Python 3.6.0 alpha 2

Python 3.6.0 alpha 1

Python 3.5.5 正式版

Python 3.5.5 rc1

Python 3.5.4 正式版

Python 3.5.4 rc1

Python 3.5.3 正式版

Python 3.5.3 rc1

Python 3.5.2 正式版

Python 3.5.2 rc1

Python 3.5.1 正式版

Python 3.5.1 rc1

Python 3.5.0 正式版

Python 3.5.0 rc4

Python 3.5.0 rc3

Python 3.5.0 rc2

Python 3.5.0 rc1

Python 3.5.0 beta 4

Python 3.5.0 beta 3

Python 3.5.0 beta 2

Python 3.5.0 beta 1

Python 3.5.0 alpha 4

Python 3.5.0 alpha 3

Python 3.5.0 alpha 2

Python 3.5.0 alpha 1

Python 3.10 有什么新变化

发布版本

3.10.20

日期

三月 09, 2026

编者

Pablo Galindo Salgado

这篇文章介绍了 Python 3.10 相比 3.9 增加的新特性。 Python 3.10 发布于 2021 年 10 月 14 日。 更详细的信息可参阅 更新日志。

摘要 -- 发布重点

新的语法特性：

PEP 634 [https://www.python.org/dev/peps/pep-0634], 结构化模式匹配: 规范说明

PEP 635 [https://www.python.org/dev/peps/pep-0635], 结构化模式匹配: 动机与理由

PEP 636 [https://www.python.org/dev/peps/pep-0636], 结构化模式匹配: 教程

bpo-12782 [https://bugs.python.org/issue?@action=redirect&bpo=12782]，加圆括号的上下文管理器现在正式被允许使用。

标准库中的新特性:

PEP 618 [https://www.python.org/dev/peps/pep-0618]，向 zip 添加可选的长度检查。

解释器的改进:

PEP 626 [https://www.python.org/dev/peps/pep-0626]，在调试和其他工具中使用精确的行号。

新的类型标注特性：

PEP 604 [https://www.python.org/dev/peps/pep-0604]，允许 X | Y 形式的联合类型写法

PEP 612 [https://www.python.org/dev/peps/pep-0612]，形参规格变量

PEP 613 [https://www.python.org/dev/peps/pep-0613]，显式类型别名

PEP 647 [https://www.python.org/dev/peps/pep-0647]，用户自定义的类型保护器

重要的弃用、移除或限制：

PEP 644 [https://www.python.org/dev/peps/pep-0644]，要求 OpenSSL 1.1.1 或更新的版本

PEP 632 [https://www.python.org/dev/peps/pep-0632]，弃用 distutils 模块。

PEP 623 [https://www.python.org/dev/peps/pep-0623]，弃用并准备移除 PyUnicodeObject 中的 wstr 成员。

PEP 624 [https://www.python.org/dev/peps/pep-0624]，移除 Py_UNICODE 编码器 API

PEP 597 [https://www.python.org/dev/peps/pep-0597]，增加可选的 EncodingWarning

新的特性

带圆括号的上下文管理器

现在已支持使用外层圆括号来使多个上下文管理器可以连续多行地书写。 这允许将过长的上下文管理器集能够以与之前 import 语句类似的方式格式化为多行的形式。 例如，以下这些示例写法现在都是有效的:

with (CtxManager() as example):
    ...

with (
    CtxManager1(),
    CtxManager2()
):
    ...

with (CtxManager1() as example,
      CtxManager2()):
    ...

with (CtxManager1(),
      CtxManager2() as example):
    ...

with (
    CtxManager1() as example1,
    CtxManager2() as example2
):
    ...

在被包含的分组末尾过可以使用一个逗号作为结束：

with (
    CtxManager1() as example1,
    CtxManager2() as example2,
    CtxManager3() as example3,
):
    ...

这个新语法使用了新解析器的非 LL(1) 功能。 请查看 PEP 617 [https://www.python.org/dev/peps/pep-0617] 来了解更多细节。

（由 Guido van Rossum, Pablo Galindo 和 Lysandros Nikolaou 在 bpo-12782 [https://bugs.python.org/issue?@action=redirect&bpo=12782] 和 bpo-40334 [https://bugs.python.org/issue?@action=redirect&bpo=40334] 中贡献。）

更清楚的错误消息

SyntaxError

现在当解析包含有未关闭括号的代码时解释器会包括未关闭括号的位置而不是显示 SyntaxError: unexpected EOF while parsing 并指向某个不正确的位置。 例如，考虑以下代码（注意未关闭的 “ { ”）：

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()

之前版本的解释器会报告令人迷惑的语法错误位置：

File "example.py", line 3
    some_other_code = foo()
                    ^
SyntaxError: invalid syntax

但在 Python 3.10 中则会发出信息量更多的错误提示：

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

类似地，涉及未关闭字符串字面值 (单重引号和三重引号) 的错误现在会指向字符串的开头而不是报告 EOF/EOL。

这些改进的灵感来自 PyPy 解释器之前所进行的工作。

（由 Pablo Galindo 在 bpo-42864 [https://bugs.python.org/issue?@action=redirect&bpo=42864] 以及 Batuhan Taskaya 在 bpo-40176 [https://bugs.python.org/issue?@action=redirect&bpo=40176] 中贡献。）

解释器所引发的 SyntaxError 异常现在将高亮构成语法错误本身的完整异常错误内容，而不是仅提示检测到问题的位置。 这样，不再（同 Python 3.10 之前那样）仅显示：

>>> 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

现在 Python 3.10 将这样显示异常：

>>> 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

这个改进是由 Pablo Galindo 在 bpo-43914 [https://bugs.python.org/issue?@action=redirect&bpo=43914] 中贡献的。

大量新增的专门化 SyntaxError 异常消息已被添加。 其中最主要的一些如下所示：

在代码块之前缺失 :：

>>> if rocket.position > event_horizon
  File "<stdin>", line 1
    if rocket.position > event_horizon
                                      ^
SyntaxError: expected ':'

（由 Pablo Galindo 在 bpo-42997 [https://bugs.python.org/issue?@action=redirect&bpo=42997] 中贡献。）

在推导式的目标中有不带圆括号的元组:

>>> {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?

（由 Pablo Galindo 在 bpo-43017 [https://bugs.python.org/issue?@action=redirect&bpo=43017] 中贡献。）

在多项集字面值中和表达式之间缺失逗号:

>>> items = {
... x: 1,
... y: 2
... z: 3,
  File "<stdin>", line 3
    y: 2
       ^
SyntaxError: invalid syntax. Perhaps you forgot a comma?

（由 Pablo Galindo 在 bpo-43822 [https://bugs.python.org/issue?@action=redirect&bpo=43822] 中贡献。）

多个异常类型不带圆括号：

>>> try:
...     build_dyson_sphere()
... except NotEnoughScienceError, NotEnoughResourcesError:
  File "<stdin>", line 3
    except NotEnoughScienceError, NotEnoughResourcesError:
           ^
SyntaxError: multiple exception types must be parenthesized

（由 Pablo Galindo 在 bpo-43149 [https://bugs.python.org/issue?@action=redirect&bpo=43149] 中贡献。）

字典字面值中缺失 : 和值：

>>> 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

（由 Pablo Galindo 在 bpo-43823 [https://bugs.python.org/issue?@action=redirect&bpo=43823] 中贡献。）

try 代码块不带 except 或 finally 代码块:

>>> try:
...     x = 2
... something = 3
  File "<stdin>", line 3
    something  = 3
    ^^^^^^^^^
SyntaxError: expected 'except' or 'finally' block

（由 Pablo Galindo 在 bpo-44305 [https://bugs.python.org/issue?@action=redirect&bpo=44305] 中贡献。）

在比较中使用 = 而不是 ==：

>>> 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 '='?

（由 Pablo Galindo 在 bpo-43797 [https://bugs.python.org/issue?@action=redirect&bpo=43797] 中贡献。）

在 f-字符串中使用 *：

>>> f"Black holes {*all_black_holes} and revelations"
  File "<stdin>", line 1
    (*all_black_holes)
     ^
SyntaxError: f-string: cannot use starred expression here

（由 Pablo Galindo 在 bpo-41064 [https://bugs.python.org/issue?@action=redirect&bpo=41064] 中贡献。）

IndentationError

许多 IndentationError 异常现在具有更多上下文来提示是何种代码块需要缩进，包括语句的位置：

>>> def foo():
...    if lel:
...    x = 2
  File "<stdin>", line 3
    x = 2
    ^
IndentationError: expected an indented block after 'if' statement in line 2

AttributeError

当打印 AttributeError 时，PyErr_Display() 将提供引发异常的对象中类似属性名称的建议：

>>> collections.namedtoplo
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'collections' has no attribute 'namedtoplo'. Did you mean: namedtuple?

（由 Pablo Galindo 在 bpo-38530 [https://bugs.python.org/issue?@action=redirect&bpo=38530] 中贡献。）

警告

请注意如果未调用 PyErr_Display() 来显示错误则此特性将没有效果，这可能发生在使用了某些其他自定义错误显示函数的时候。 这在某些 REPL 例如 IPython 上是一种常见的情况。

NameError

当打印解释器所引发的 NameError 时，PyErr_Display() 将提供引发异常的函数中类似变量名称的建议：

>>> 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?

（由 Pablo Galindo 在 bpo-38530 [https://bugs.python.org/issue?@action=redirect&bpo=38530] 中贡献。）

警告

请注意如果未调用 PyErr_Display() 来显示错误则此特性将没有效果，这可能发生在使用了某些其他自定义错误显示函数的时候。 这在某些 REPL 例如 IPython 中是一种常见的情况。

PEP 626：在调试和其他工具中使用精确的行号

PEP 626 带来了更精确可靠的行号用于调试、性能分析和测试工具。 所有被执行的代码行都会并且只有被执行的代码行才会生成带有正确行号的追踪事件。

帧对象的 f_lineno 属性将总是包含预期的行号。

代码对象的 co_lnotab 属性已被弃用并将在 3.12 中被移除。 需要从偏移量转换为行号的代码应改用新的 co_lines() 方法。

PEP 634：结构化模式匹配

增加了采用模式加上相应动作的 match 语句 和 case 语句 的形式的结构化模式匹配。 模式由序列、映射、基本数据类型以及类实例构成。 模式匹配使得程序能够从复杂的数据类型中提取信息、根据数据结构实现分支，并基于不同的数据形式应用特定的动作。

语法与操作

模式匹配的通用语法如下:

match subject:
    case <pattern_1>:
        <action_1>
    case <pattern_2>:
        <action_2>
    case <pattern_3>:
        <action_3>
    case _:
        <action_wildcard>

match 语句接受一个表达式并将其值与以一个或多个 case 语句块形式给出的一系列模式进行比较。 具体来说，模式匹配的操作如下：

使用具有特定类型和形状的数据 (subject)

针对 subject 在 match 语句中求值

从上到下对 subject 与 case 语句中的每个模式进行比较直到确认匹配到一个模式。

执行与被确认匹配的模式相关联的动作。

如果没有确认到一个完全的匹配，则如果提供了使用通配符 _ 的最后一个 case 语句，则它将被用作已匹配模式。 如果没有确认到一个完全的匹配并且不存在使用通配符的 case 语句，则整个 match 代码块不执行任何操作。

声明性方式

读者可能是通过 C, Java 或 JavaScript (以及其他许多语言) 中的 switch 语句将一个目标 (数据对象) 与一个字面值 (模式) 进行匹配的简单例子了解到模式匹配的概念的。 switch 语句常常被用来将一个对象/表达式与包含在 case 语句中的字面值进行比较。

更强大的模式匹配例子可以在 Scala 和 Elixir 等语言中找到。 这种结构化模式匹配方式是“声明性”的并且会显式地为所要匹配的数据指定条件（模式）。

虽然使用嵌套的“if”语句的“命令性”系列指令可以被用来完成类似结构化模式匹配的效果，但它没有“声明性”方式那样清晰。 相反地，“声明性”方式指定了一个匹配所要满足的条件，并且通过其显式的模式使之更为易读。 虽然结构化模式匹配可以采取将一个变量与一个 case 语句中的字面值进行比较的最简单形式来使用，但它对于 Python 的真正价值在于其针对目标类型和形状的处理操作。

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

让我们把这个例子看作是模式匹配的最简单形式：一个值，即主词，被匹配到几个字面值，即模式。在下面的例子中，status 是匹配语句的主词。模式是每个 case 语句，字面值代表请求状态代码。匹配后，将执行与该 case 相关的动作：

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"

如果传给上述函数的 status 为 418，则会返回 "I'm a teapot"。 如果传给上述函数的 status 为 500，则带有 _ 的 case 语句将作为通配符匹配，并会返回 "Something's wrong with the internet"。 请注意最后一个代码块：变量名 _ 将作为 通配符 并确保目标将总是被匹配。 _ 的使用是可选的。

你可以使用 | （“ or ”）在一个模式中组合几个字面值:

case 401 | 403 | 404:
    return "Not allowed"

无通配符的行为

如果我们修改上面的例子，去掉最后一个 case 块，这个例子就变成:

def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"

如果不在 case 语句中使用 _，可能会出现不存在匹配的情况。如果不存在匹配，则行为是一个 no-op。例如，如果传入了值为 500 的 status ，就会发生 no-op。

带有字面值和变量的模式

模式可以看起来像解包形式，而且模式可以用来绑定变量。在这个例子中，一个数据点可以被解包为它的 x 坐标和 y 坐标:

# point is an (x, y) tuple
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")

第一个模式有两个字面值 (0, 0) ，可以看作是上面所示字面值模式的扩展。接下来的两个模式结合了一个字面值和一个变量，而变量 绑定 了一个来自主词的值（point）。 第四种模式捕获了两个值，这使得它在概念上类似于解包赋值 (x, y) = point 。

模式和类

如果你使用类来结构化你的数据，你可以使用类的名字，后面跟一个类似构造函数的参数列表，作为一种模式。这种模式可以将类的属性捕捉到变量中:

class Point:
    x: int
    y: int

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")

带有位置参数的模式

你可以在某些为其属性提供了排序的内置类（例如 dataclass）中使用位置参数。 你也可以通过在你的类中设置 __match_args__ 特殊属性来为模式中的属性定义一个专门的位置。 如果它被设为 ("x", "y")，则以下模式均为等价的（并且都是将 y 属性绑定到 var 变量）:

Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)

嵌套模式

模式可以任意地嵌套。 例如，如果我们的数据是由点组成的短列表，则它可以这样被匹配:

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.")

复杂模式和通配符

到目前为止，这些例子仅在最后一个 case 语句中使用了 _。 但通配符可以被用在更复杂的模式中，例如 ('error', code, _)。 举例来说:

match test_variable:
    case ('warning', code, 40):
        print("A warning has been received.")
    case ('error', code, _):
        print(f"An error {code} occurred.")

在上述情况下，test_variable 将可匹配 ('error', code, 100) 和 ('error', code, 800)。

约束项

我们可以向一个模式添加 if 子句，称为“约束项”。 如果约束项为假值，则 match 将继续尝试下一个 case 语句块。 请注意值的捕获发生在约束项被求值之前。:

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.")

其他关键特性

一些其他关键特性:

类似于解包赋值，元组和列表模式具有完全相同的含义，而且实际上能匹配任意序列。 从技术上说，目标必须为一个序列。 因而，一个重要的例外是模式不能匹配迭代器。 而且，为了避免一个常见的错误，序列模式不能匹配字符串。

序列模式支持通配符: [x, y, *rest] 和 (x, y, *rest) 的作用类似于解包赋值中的通配符。 在 * 之后的名称也可以为 _，因此 (x, y, *_) 可以匹配包含两个条目的序列而不必绑定其余的条目。

映射模式: {"bandwidth": b, "latency": l} 会从一个字典中捕获 "bandwidth" 和 "latency" 值。 与序列模式不同，额外的键会被忽略。 也支持通配符 **rest。 （但 **_ 是冗余的，因而不被允许。）

子模式可使用 as 关键字来捕获:

case (Point(x1, y1), Point(x2, y2) as p2): ...

x1, y1, x2, y2 等绑定就如你在没有 as 子句的情况下所期望的，而 p2 会绑定目标的整个第二项。

大多数字面值是按相等性比较的。 但是，单例对象 True, False 和 None 则是按标识号比较的。

命名常量也可以在模式中使用。 这些命名常量必须为带点号的名称以防止常量被解读为捕获变量:

from enum import Enum
class Color(Enum):
    RED = 0
    GREEN = 1
    BLUE = 2

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 :(")

完整规格说明参见 PEP 634 [https://www.python.org/dev/peps/pep-0634]。 动机与理由参见 PEP 635 [https://www.python.org/dev/peps/pep-0635]，更详细的教程参见 PEP 636 [https://www.python.org/dev/peps/pep-0636]。

可选的 EncodingWarning 和 encoding="locale" 选项

TextIOWrapper 和 open() 的默认编码格式取决于具体的平台和语言区域设置。 由于 UTF-8 被用于大多数 Unix 平台，当打开 UTF-8 文件 (例如 JSON, YAML, TOML, Markdown) 时省略 encoding 选项是一个非常常见的错误。 例如:

# BUG: "rb" mode or encoding="utf-8" should be used.
with open("data.json") as f:
    data = json.load(f)

为了便于查找此类错误，增加了可选的 EncodingWarning。 它会在 sys.flags.warn_default_encoding 为真值并使用了语言区域指定的默认编码格式时被发出。

增加了 -X warn_default_encoding 选项和 PYTHONWARNDEFAULTENCODING 来启用相应警告。

请参阅 文本编码格式 了解更多信息。

有关类型提示的新增特性

本节介绍了涉及 PEP 484 [https://www.python.org/dev/peps/pep-0484] 类型提示和 typing 模块的主要更改。

PEP 604: 新的类型联合运算符

引入了启用 X | Y 语法的类型联合运算符。 这提供了一种表示 '类型 X 或类型 Y' 的相比使用 typing.Union 更清晰的方式，特别是在类型提示中。

在之前的 Python 版本中，要为可接受多种类型参数的函数应用类型提示，使用的是 typing.Union:

def square(number: Union[int, float]) -> Union[int, float]:
    return number ** 2

类型提示现在可以使用更简洁的写法:

def square(number: int | float) -> int | float:
    return number ** 2

这个新增语法也被接受作为 isinstance() 和 issubclass() 的第二个参数:

>>> isinstance(1, int | str)
True

详情参见 union 类型 和 PEP 604 [https://www.python.org/dev/peps/pep-0604]。

（由 Maggie Moss 和 Philippe Prados 在 bpo-41428 [https://bugs.python.org/issue?@action=redirect&bpo=41428] 中贡献，并由 Yurii Karabas 和 Serhiy Storchaka 在 bpo-44490 [https://bugs.python.org/issue?@action=redirect&bpo=44490] 中补充。）

PEP 612: 形参规格变量

在 typing 模块中新增了两个选项以改进用于 PEP 484 [https://www.python.org/dev/peps/pep-0484] 的 Callable 提供给静态类型检查器的信息。

第一个选项是形参规格变量。 它们被用来将一个可调用对象的形参类型转发给另一个可调用对象 —— 这种模式常见于高阶函数和装饰器。 使用示例可在 typing.ParamSpec 中找到。 在之前版本中，没有一种简单办法能以如此精确的方式对形参类型的依赖性进行类型标注。

第二个选项是新的 Concatenate 运算符。 它与形参规格变量一起使用以便对增加或移除了其他可调用对象的高阶可调用对象进行类型标注。 使用示例可以在 typing.Concatenate 中找到。

请参阅 typing.Callable, typing.ParamSpec, typing.Concatenate, typing.ParamSpecArgs, typing.ParamSpecKwargs 和 PEP 612 [https://www.python.org/dev/peps/pep-0612] 来了解更多细节。

（由 Ken Jin 在 bpo-41559 [https://bugs.python.org/issue?@action=redirect&bpo=41559] 中贡献，并由 Jelle Zijlstra 在 bpo-43783 [https://bugs.python.org/issue?@action=redirect&bpo=43783] 中加以少量改进。 PEP 由 Mark Mendoza 撰写。）

PEP 613: 类型别名

PEP 484 [https://www.python.org/dev/peps/pep-0484] 引入了类型别名的概念，只要求它们是不带标注的最高层级赋值。 这种简单性有时会使得类型检查器难以区分类型别名和普通赋值，特别是当涉及到前向引用或无效类型的时候。 例如在比较:

StrCache = 'Cache[str]'  # a type alias
LOG_PREFIX = 'LOG[DEBUG]'  # a module constant

现在 typing 模块具有一个特殊值 TypeAlias 可让你更明确地声明类型别名:

StrCache: TypeAlias = 'Cache[str]'  # a type alias
LOG_PREFIX = 'LOG[DEBUG]'  # a module constant

请参阅 PEP 613 [https://www.python.org/dev/peps/pep-0613] 了解详情。

（由 Mikhail Golubev 在 bpo-41923 [https://bugs.python.org/issue?@action=redirect&bpo=41923] 中贡献。）

PEP 647: 用户自定义的类型保护器

TypeGuard 已被添加到 typing 模块用来标注类型保护器函数并改进在类型细化期间提供给静态类型分析器的信息。 要了解更多信息，请参阅 TypeGuard 的文档以及 PEP 647 [https://www.python.org/dev/peps/pep-0647]。

（由 Ken Jin 和 Guido van Rossum 在 bpo-43766 [https://bugs.python.org/issue?@action=redirect&bpo=43766] 中贡献。 PEP 由 Eric Traut 撰写。）

其他语言特性修改

int 类型新增了一个方法 int.bit_count()，返回给定整数的二进制展开中值为一的位数，或称“比特计量”。 （由 Niklas Fiekas 在 bpo-29882 [https://bugs.python.org/issue?@action=redirect&bpo=29882] 中贡献。）

现在 dict.keys(), dict.values() 和 dict.items() 所返回的视图都有一个 mapping 属性，它给出包装了原始字典的 types.MappingProxyType 对象。 （由 Dennis Sweeney 在 bpo-40890 [https://bugs.python.org/issue?@action=redirect&bpo=40890] 中贡献。）

PEP 618 [https://www.python.org/dev/peps/pep-0618]: 现在 zip() 函数有一个可选的 strict 旗标，用于要求所有可迭代对象的长度都相等。

接受整数参数的内置和扩展函数不再接受 Decimal, Fraction 以及其他可被转换为整数但会丢失精度（即具有 __int__() 方法但没有 __index__() 方法）的对象。 （由 Serhiy Storchaka 在 bpo-37999 [https://bugs.python.org/issue?@action=redirect&bpo=37999] 中贡献。）

如果 object.__ipow__() 返回 NotImplemented，该运算符将正确地按照预期回退至 object.__pow__() 和 object.__rpow__()。 （由 Alex Shkop 在 bpo-38302 [https://bugs.python.org/issue?@action=redirect&bpo=38302] 中贡献。）

现在赋值表达式可以不带圆括号地在集合字面值和集合推导式中使用，也可以在序列索引号中使用（但不能用于切片）。

函数具有一个新的 __builtins__ 属性，当函数被执行时它会被用于查找内置符号，而不是在 __globals__['__builtins__'] 中查找。 如果 __globals__["__builtins__"] 存在则该属性将基于它来初始化，否则将基于当前的内置函数。 （由 Mark Shannon 在 bpo-42990 [https://bugs.python.org/issue?@action=redirect&bpo=42990] 中贡献。）

增加了两个新的内置函数 —— aiter() 和 anext() 以分别提供与 iter() 和 next() 对应的异步版本。 （由 Joshua Bronson, Daniel Pope 和 Justin Wang 在 bpo-31861 [https://bugs.python.org/issue?@action=redirect&bpo=31861] 中贡献。）

静态方法 (@staticmethod) 和类方法 (@classmethod) 现在会继承方法属性 (__module__, __name__, __qualname__, __doc__, __annotations__) 并具有一个新的 __wrapped__ 属性。 此外，静态方法现在还是与常规函数一样的可调用对象。 （由 Victor Stinner 在 bpo-43682 [https://bugs.python.org/issue?@action=redirect&bpo=43682] 中贡献。）

复杂目标的注解（ PEP 526 [https://www.python.org/dev/peps/pep-0526] 定义的除 simple name 之外的一切复杂目标）在运行时不再受 from __future__ import annotations 的影响。（由Batuhan Taskaya 在 bpo-42737 [https://bugs.python.org/issue?@action=redirect&bpo=42737] 中贡献）。

类和模块对象现在可以按需创建空的注解字典。为保证向下兼容，这些注解数据将存储于对象的 __dict__ 中。这改进了 __annotations__ 的最佳用法；更多信息请参阅 注解最佳实践 。（由 Larry Hastings 在 bpo-43901 [https://bugs.python.org/issue?@action=redirect&bpo=43901] 中贡献）

由于会产生副作用，现在 from __future__ import annotations 时禁止使用包含 yield 、 yield from 、 await 或已命名表达式的注解。（由 Batuhan Taskaya 在 bpo-42725 [https://bugs.python.org/issue?@action=redirect&bpo=42725] 中贡献）

未绑定变量、super() 和其他可能改变符号表处理的表达式，现在在 from __future__ import annotations 时不能用作注解。（由 Batuhan Taskaya 在 bpo-42725 [https://bugs.python.org/issue?@action=redirect&bpo=42725] 中贡献）

float 类型和 decimal.Decimal 类型的 NaN 值的哈希值现在取决于对象身份。以前，即便 NaN 值彼此不等，也都是哈希为 0。在创建包含多个 NaN 的字典和集合时，由于哈希冲突过度，导致了运行代价可能会二次方增长。（由 Raymond Hettinger 在 bpo-43475 [https://bugs.python.org/issue?@action=redirect&bpo=43475] 中贡献）

当删除 __debug__ 常量时，将产生一个 SyntaxError （而不是 NameError ）。 (由 Dong-hee Na 在 bpo-45000 [https://bugs.python.org/issue?@action=redirect&bpo=45000] 中贡献。)

SyntaxError 异常现在有 end_lineno 和 end_offset 属性。 如果不确定的话，它们将是 None 。(由 Pablo Galindo 在 bpo-43914 [https://bugs.python.org/issue?@action=redirect&bpo=43914] 中贡献。)

新增模块

无。

改进的模块

asyncio

加入了缺失的 connect_accepted_socket() 方法。（由 Alex Grönholm 在 bpo-41332 [https://bugs.python.org/issue?@action=redirect&bpo=41332] 中贡献）

argparse

在 argparse 的帮助中，将“可选参数”这一误导性短语改为“可选项”。某些测试代码如果依赖精确的输出匹配，可能需要调整。（由 Raymond Hettinger 在 bpo-9694 [https://bugs.python.org/issue?@action=redirect&bpo=9694] 中贡献）

array

现在， array.array 的 index() 方法拥有可选的 start 和 stop 参数。（由 Anders Lorentsen 和 Zackery Spytz 在 bpo-31956 [https://bugs.python.org/issue?@action=redirect&bpo=31956] 中贡献）

asynchat、asyncore 和 smtpd

从 Python 3.6 开始，这些模块在其文档中已被标为废弃。现在这三个模块都增加了一个导入时警告 DeprecationWarning。

base64

增加 base64.b32hexencode() 和 base64.b32hexdecode() 以支持带有扩展十六进制字母的 Base32 编码。

bdb

增加 clearBreakpoints() ，用于重置所有已设断点。（由 Irit Katriel 在 bpo-24160 [https://bugs.python.org/issue?@action=redirect&bpo=24160] 中贡献）

bisect

增加了为 bisect 模块中的 API 提供 key 函数的可能性。(由 Raymond Hettinger 在 bpo-4356 [https://bugs.python.org/issue?@action=redirect&bpo=4356] 中贡献。)

编码器

增加一个 codecs.unregister() 函数，用于取消对编解码器搜索函数的注册。（由 Hai Shi 在 bpo-41842 [https://bugs.python.org/issue?@action=redirect&bpo=41842] 中贡献）

collections.abc

现在， parameterized generic 的 collections.abc.Callable 的 __args__ 与 typing.Callable 一致了。 collections.abc.Callable generic 现在将类型参数扁平化了，类似于 typing.Callable 当前的做法。这意味着 collections.abc.Callable[[int, str], str] 将带有 (int, str, str) 的参数 __args__；以前是 ([int, str], str) 。为了做到这一变化， types.GenericAlias 现在可以被子类化，当对 collections.abc.Callable 类型进行下标访问时，将返回一个子类。注意，collections.abc.Callable 非法的参数化形式可能会触发 TypeError ，而在 Python 3.9 中可能就静默了。（由 Ken Jin 在 bpo-42195 [https://bugs.python.org/issue?@action=redirect&bpo=42195] 中贡献）

contextlib

增加了一个上下文管理器 contextlib.aclosing() ，以便能安全关闭异步生成器和代表异步释放资源的对象。（由 Joongi Kim 和 John Belmonte 在 bpo-41229 [https://bugs.python.org/issue?@action=redirect&bpo=41229] 中贡献）

为 contextlib.nullcontext() 加入异步上下文管理器支持。由 Tom Gringauz 在 bpo-41543 [https://bugs.python.org/issue?@action=redirect&bpo=41543] 中贡献）

加入 AsyncContextDecorator，以便支持用异步上下文管理器作为装饰器。

curses

在 ncurses 6.1 中增加的扩展颜色函数将会由 curses.color_content() 、 curses.init_color() 、 curses.init_pair() 和 curses.pair_content() 透明地使用。新增的函数 curses.has_extended_color_support() 将指明下层的 ncurses 库是否提供了扩展颜色支持。（由 Jeffrey Kintscher 和 Hans Petter Jansson 在 bpo-36982 [https://bugs.python.org/issue?@action=redirect&bpo=36982] 中贡献）

现在常量 BUTTON5_* 如果是由底层的 curses 库提供的，则会在 curses 模块中体现。（由 Zackery Spytz 在 bpo-39273 [https://bugs.python.org/issue?@action=redirect&bpo=39273] 中贡献）

dataclasses

__slots__

在 dataclasses.dataclass() 装饰器中添加 slots 参数。(由 Yurii Karabas 在 bpo-42269 [https://bugs.python.org/issue?@action=redirect&bpo=42269] 中贡献)

仅限关键字字段

数据类现在支持在生成的 __init__ 方法中只用关键字的字段。 有许多方法可以指定只用关键字的字段。

你可以说每一个字段都是仅限关键字的:

from dataclasses import dataclass

@dataclass(kw_only=True)
class Birthday:
    name: str
    birthday: datetime.date

name 和 birthday 都是生成的 __init__ 方法的仅限关键字的参数。

你可以在每个字段的基础上指定仅限关键字：

from dataclasses import dataclass

@dataclass
class Birthday:
    name: str
    birthday: datetime.date = field(kw_only=True)

这里的只有 birthday 是仅限关键字。如果你在单个字段上设置 kw_only ，要注意由于仅限关键字的字段需要跟在非仅限关键字的字段后面，所以有关于重新排序的规则。 详情请看完整的数据类文件。

你也可以指定 KW_ONLY 标记后面的所有字段都是仅限关键字的。 这可能是最常见的用法：

from dataclasses import dataclass, KW_ONLY

@dataclass
class Point:
    x: float
    y: float
    _: KW_ONLY
    z: float = 0.0
    t: float = 0.0

在这里，z 和 t 是仅限关键字形参，而 x 和 y 不是。 （由 Eric V. Smith 在 bpo-43532 [https://bugs.python.org/issue?@action=redirect&bpo=43532] 中贡献。）

distutils

整个 distutils 包已被废弃，将在 Python 3.12 中移除。其用指定包构建程序的功能已被第三方软件包 setuptools 和 packaging 完全取代，而且大多数其他常用的 API 在标准库的其他地方都可以调用（如 platform 、 shutil 、 subprocess 或 sysconfig）。目前没有迁移 distutils 其他功能的计划，用到其他功能的应用程序应该准备好自己保留一份拷贝。请参考 PEP 632 [https://www.python.org/dev/peps/pep-0632] 。

在 Python 3.8 中废弃的 bdist_wininst 命令已被移除。现在在 Windows 中发布二进制包推荐采用 bdist_wheel 命令。（由 Victor Stinner 在 bpo-42802 [https://bugs.python.org/issue?@action=redirect&bpo=42802] 中贡献）

doctest

若模块中没有定义 __loader__ ，则回退至使用 __spec__.loader 。（由 Brett Cannon 在 bpo-42133 [https://bugs.python.org/issue?@action=redirect&bpo=42133] 中贡献）

encodings

现在 encodings.normalize_encoding() 会忽略非 ASCII 字符。（由 Hai Shi 在 bpo-39337 [https://bugs.python.org/issue?@action=redirect&bpo=39337] 中贡献）

fileinput

在 fileinput.input() 和 fileinput.FileInput 中增加了 encoding 和 errors 形参。 （由 Inada Naoki 在 bpo-43712 [https://bugs.python.org/issue?@action=redirect&bpo=43712] 中贡献。）

现在 fileinput.hook_compressed() 会在 mode 为 "r" 且文件被压缩时返回 TextIOWrapper，与未压缩文件一致。 （由 Inada Naoki 在 bpo-5758 [https://bugs.python.org/issue?@action=redirect&bpo=5758] 中贡献。）

faulthandler

现在 faulthandler 模块会检测在垃圾回收期间是否发生严重错误。 （由 Victor Stinner 在 bpo-44466 [https://bugs.python.org/issue?@action=redirect&bpo=44466] 中贡献）

gc

为 gc.get_objects(), gc.get_referrers() 和 gc.get_referents() 添加了审计钩子。 （由 Pablo Galindo 在 bpo-43439 [https://bugs.python.org/issue?@action=redirect&bpo=43439] 中贡献。）

glob

在 glob() 和 iglob() 中增加了 root_dir 和 dir_fd 形参，用于指定搜索的根目录。（由 Serhiy Storchaka 在 bpo-38144 [https://bugs.python.org/issue?@action=redirect&bpo=38144] 中贡献）

hashlib

hashlib 模块要求 OpenSSL 1.1.1 或更新版本。 （由 Christian Heimes 在 PEP 644 [https://www.python.org/dev/peps/pep-0644] 和 bpo-43669 [https://bugs.python.org/issue?@action=redirect&bpo=43669] 中贡献。）

hashlib 模块已初步支持 OpenSSL 3.0.0。 （由 Christian Heimes 在 bpo-38820 [https://bugs.python.org/issue?@action=redirect&bpo=38820] 及其他问题事项中贡献。）

纯 Python 的回退版 pbkdf2_hmac() 已被弃用。 未来 PBKDF2-HMAC 将仅在 Python 带有 OpenSSL 编译时才可用。（由 Christian Heimes 在 bpo-43880 [https://bugs.python.org/issue?@action=redirect&bpo=43880] 中贡献）

hmac

现在 hmac 模块会在内部使用 OpenSSL 的 HMAC 实现。 （由 Christian Heimes 在 bpo-40645 [https://bugs.python.org/issue?@action=redirect&bpo=40645] 中贡献。）

IDLE 与 idlelib

使 IDLE 调用 sys.excepthook() （当启动时没有 '-n' ）。用户钩子以前是被忽略的。 (由 Ken Hilton 在 bpo-43008 [https://bugs.python.org/issue?@action=redirect&bpo=43008] 中贡献。)

重新安排设置对话框。 将常规选项卡分成 Windows 和 Shell/Ed 选项卡。 将扩展帮助菜单的帮助源移至扩展标签。为新选项留出空间，并缩短对话框。后者使对话框更适合小屏幕。 (由 Terry Jan Reedy 贡献于 bpo-40468 [https://bugs.python.org/issue?@action=redirect&bpo=40468] 。) 将缩进空间设置从字体标签移到新的 Windows 标签。 (由 Mark Roseman 和 Terry Jan Reedy 在 bpo-33962 [https://bugs.python.org/issue?@action=redirect&bpo=33962] 中提供)。

上述变化已被反向移植到 3.9 维护版本中。

增加了 Shell 侧栏。 将主提示符（“>>>”）移至侧栏。二级提示符（“...”）也加入侧栏。在编辑器的行号侧栏上鼠标单击和可选的拖动，会选定一行或多行文本。在选定文本行后右击将显示包含“copy with prompts”的上下文菜单。这会将侧栏的提示符与选定文本行合并。该选项也会在文本的上下文菜单中显示。（由 Tal Einat 在 bpo-37903 [https://bugs.python.org/issue?@action=redirect&bpo=37903] 中贡献）

使用空格而不是制表符来缩进交互式代码。 这使得交互式代码条目 "看起来很正确"。 使之可行是增加 shell 侧边栏的一个主要动机。 (由 Terry Jan Reedy 在 bpo-37892 [https://bugs.python.org/issue?@action=redirect&bpo=37892] 中贡献。)

在模式匹配语句中高亮显示新的 软关键字 match 、 case 和 _。 但这种高亮显示并不完美，某些极端情况下还会出现错误，包括 case 模式中的一些 _。 （由 Tal Einat 在 bpo-44010 [https://bugs.python.org/issue?@action=redirect&bpo=44010] 中贡献。）

3.10 维护版本中的新内容。

对 .pyi 文件应用语法高亮。 （由 Alex Waygood 和 Terry Jan Reedy 在 bpo-45447 [https://bugs.python.org/issue?@action=redirect&bpo=45447] 中贡献。）

当附带输入和输出地保存 Shell 时将包括提示符。 （由 Terry Jan Reedy 在 gh-95191 [https://github.com/python/cpython/issues/95191] 中贡献。）

importlib.metadata

与 importlib_metadata 4.6（history [https://importlib-metadata.readthedocs.io/en/latest/history.html]）的功能一致。

现在 importlib.metadata entry points 通过一个新的 importlib.metadata.EntryPoints 类，为由组和名称选择入口点提供了更好的体验。关于废弃之处和用法的更多信息，请参见文档中的兼容性说明。

添加了 importlib.metadata.packages_distributions()，用于将顶级 Python 模块和包解析为其 importlib.metadata.Distributions。

inspect

若模块中没有定义 __loader__ ，则回退至使用 __spec__.loader 。（由 Brett Cannon 在 bpo-42133 [https://bugs.python.org/issue?@action=redirect&bpo=42133] 中贡献）

加入了 inspect.get_annotations()，以便安全地对对象中定义的注解进行求值。inspect.get_annotations() 也可以正确地解析字符串化的注解。 inspect.get_annotations() 现在应是访问任何 Python 对象注解字典的最佳实践；关于注解最佳用法的更多信息，请参见 注解最佳实践。与之关联的， inspect.signature() 、 inspect.Signature.from_callable() 和 inspect.Signature.from_function() 现在也调用 inspect.get_annotations() 来获取注解信息。这意味着 inspect.signature() 和 inspect.Signature.from_callable() 现在也可以解析字符串化的注解了。（由 Larry Hastings 在 bpo-43817 [https://bugs.python.org/issue?@action=redirect&bpo=43817] 中贡献）

itertools

添加了 itertools.pairwise() （由 Raymond Hettinger 在 bpo-38200 [https://bugs.python.org/issue?@action=redirect&bpo=38200] 中贡献。）

linecache

若模块中没有定义 __loader__ ，则回退至使用 __spec__.loader 。（由 Brett Cannon 在 bpo-42133 [https://bugs.python.org/issue?@action=redirect&bpo=42133] 中贡献）

os

为 VxWorks 实时操作系统加入 os.cpu_count() 的支持。（由 Peixing Xin 在 bpo-41440 [https://bugs.python.org/issue?@action=redirect&bpo=41440] 中贡献）

加入一个新函数 os.eventfd() 及其助手函数，以封装 Linux 的系统调用 eventfd2 。(由 Christian Heimes 在 bpo-41001 [https://bugs.python.org/issue?@action=redirect&bpo=41001] 中贡献）

加入 os.splice()，以便在两个文件描述符之间移动数据，而无需在内核地址空间和用户地址空间之间进行复制，其中一个文件描述符必须指向某个管道。（由 Pablo Galindo 在 bpo-41625 [https://bugs.python.org/issue?@action=redirect&bpo=41625] 中贡献）

为 macOS 加入 O_EVTONLY 、O_FSYNC 、 O_SYMLINK 和 O_NOFOLLOW_ANY 。（由 Dong-hee Na 在 bpo-43106 [https://bugs.python.org/issue?@action=redirect&bpo=43106] 中贡献）

As of 3.10.15, os.mkdir() and os.makedirs() on Windows now support passing a mode value of 0o700 to apply access control to the new directory. This implicitly affects tempfile.mkdtemp() and is a mitigation for CVE-2024-4030. Other values for mode continue to be ignored. (Contributed by Steve Dower in gh-118486 [https://github.com/python/cpython/issues/118486].)

os.path

现在 os.path.realpath() 可接受一个关键字参数 strict。 若设为 True ，则在路径不存在或遭遇循环符号链接时，会触发 OSError。 （由 Barney Gale 在 bpo-43757 [https://bugs.python.org/issue?@action=redirect&bpo=43757] 中贡献。）

pathlib

为 PurePath.parents 增加切片支持。 （由 Joshua Cannon 在 bpo-35498 [https://bugs.python.org/issue?@action=redirect&bpo=35498] 中贡献。）

为 PurePath.parents 增加负序列号支持。 （由 Yaroslav Pankovych 在 bpo-21041 [https://bugs.python.org/issue?@action=redirect&bpo=21041] 中贡献。）

加入 Path.hardlink_to 方法，取代 link_to()。该新方法的参数顺序与 symlink_to() 相同。（由 Barney Gale 贡献于 bpo-39950 [https://bugs.python.org/issue?@action=redirect&bpo=39950] 中）

现在 pathlib.Path.stat() 和 chmod() 接受一个关键字参数 follow_symlinks ，以便与 os 模块中的对应函数保持一致。（由 Barney Gale 贡献于 bpo-39906 [https://bugs.python.org/issue?@action=redirect&bpo=39906] ）

平台

对从 freedesktop.org os-release [https://www.freedesktop.org/software/systemd/man/os-release.html] 标准文件提取操作系统标识增加 platform.freedesktop_os_release()。 （由 Christian Heimes 在 bpo-28468 [https://bugs.python.org/issue?@action=redirect&bpo=28468] 中贡献。）

pprint

现在 pprint.pprint() 接受一个新的关键字参数 underscore_numbers。（由 sblondon 贡献于 bpo-42914 [https://bugs.python.org/issue?@action=redirect&bpo=42914] ）

现在 pprint 可以完美打印 dataclasses.dataclass 实例。（由 Lewis Gaul 贡献于 bpo-43080 [https://bugs.python.org/issue?@action=redirect&bpo=43080] ）

py_compile

py_compile' 的命令行界面加入 `--quiet`` 选项。（由 Gregory Schevchenko 贡献于 bpo-38731 [https://bugs.python.org/issue?@action=redirect&bpo=38731] ）

pyclbr

在 pyclbr.readline() 和 pyclbr.readline_ex() 返回的结果树中的 Function 和 Class 对象上增加一个 end_lineno 属性。与现有的（开始） lineno 相匹配。（由 Aviral Srivastava 贡献于 bpo-38307 [https://bugs.python.org/issue?@action=redirect&bpo=38307]）

shelve

现在 shelve 模块在创建打包时，默认采用 pickle.DEFAULT_PROTOCOL，而不是 pickle 协议 3 。（由 Zackery Spytz 贡献于 bpo-34204 [https://bugs.python.org/issue?@action=redirect&bpo=34204] ）

statistics

加入 covariance() 、Pearson 的 correlation() 和简单的 linear_regression() 函数。（由 Tymoteusz Wołodźko 贡献于 bpo-38490 [https://bugs.python.org/issue?@action=redirect&bpo=38490] ）

site

若模块中没有定义 __loader__ ，则回退至使用 __spec__.loader 。（由 Brett Cannon 在 bpo-42133 [https://bugs.python.org/issue?@action=redirect&bpo=42133] 中贡献）

socket

现在异常 socket.timeout 是 TimeoutError 的别名。（由 Christian Heimes 在 bpo-42413 [https://bugs.python.org/issue?@action=redirect&bpo=42413] 中贡献。）

加入用 IPPROTO_MPTCP 创建 MPTCP 套接字的选项（由 Rui Cunha 贡献于 bpo-43571 [https://bugs.python.org/issue?@action=redirect&bpo=43571] ）

加入 IP_RECVTOS 选项，以便接收服务类型（ToS）或 DSCP/ECN 字段（由 Georg Sauthoff 贡献于 bpo-44077 [https://bugs.python.org/issue?@action=redirect&bpo=44077] ）

ssl

ssl 模块要求 OpenSSL 1.1.1 或更新版本。 （由 Christian Heimes 在 PEP 644 [https://www.python.org/dev/peps/pep-0644] 和 bpo-43669 [https://bugs.python.org/issue?@action=redirect&bpo=43669] 中贡献。）

ssl 模块已初步支持 OpenSSL 3.0.0 和新选项 OP_IGNORE_UNEXPECTED_EOF。 （由 Christian Heimes 在 bpo-38820 [https://bugs.python.org/issue?@action=redirect&bpo=38820], bpo-43794 [https://bugs.python.org/issue?@action=redirect&bpo=43794], bpo-43788 [https://bugs.python.org/issue?@action=redirect&bpo=43788], bpo-43791 [https://bugs.python.org/issue?@action=redirect&bpo=43791], bpo-43799 [https://bugs.python.org/issue?@action=redirect&bpo=43799], bpo-43920 [https://bugs.python.org/issue?@action=redirect&bpo=43920], bpo-43789 [https://bugs.python.org/issue?@action=redirect&bpo=43789] 和 bpo-43811 [https://bugs.python.org/issue?@action=redirect&bpo=43811] 中贡献。）

现在，已弃用函数和使用已弃用常量会导致 DeprecationWarning。 ssl.SSLContext.options 默认设置了 OP_NO_SSLv2 和 OP_NO_SSLv3 ，因而设置此标记无法再次发出警告了。 弃用部分 列出了已弃用的特性。 （由 Christian Heimes 贡献于 bpo-43880 [https://bugs.python.org/issue?@action=redirect&bpo=43880] ）

现在，ssl 模块默认设置的安全性提高了。默认情况下，不具备前向安全性或 SHA-1 MAC 的加密算法会被禁用。二级安全禁止安全性低于 112 位的弱 RSA、DH 和 ECC 密钥。 SSLContext 默认的最低版本协议为 TLS 1.2。这些设置是基于 Hynek Schlawack 的研究。（由 Christian Heimes 贡献于 bpo-43998 [https://bugs.python.org/issue?@action=redirect&bpo=43998] ）

已弃用的协议 SSL 3.0, TLS 1.0 和 TLS 1.1 不再受到官方支持。Python 不会直接禁用。但 OpenSSL 编译选项、发行版配置、厂商补丁和加密套件可能会阻止握手成功。

为 ssl.get_server_certificate() 函数加入 timeout 形参。（由 Zackery Spytz 贡献于 bpo-31870 [https://bugs.python.org/issue?@action=redirect&bpo=31870] ）

ssl 模块用到了堆类型和多阶段初始化。（由 Christian Heimes 贡献于 bpo-42333 [https://bugs.python.org/issue?@action=redirect&bpo=42333] ）

加入一个新的校验标记 VERIFY_X509_PARTIAL_CHAIN。（由 l0x 贡献于 bpo-40849 [https://bugs.python.org/issue?@action=redirect&bpo=40849] ）

sqlite3

为 connect/handle() 、 enable_load_extension() 和 load_extension() 加入审计事件。（由 Erlend E. Aasland 贡献于 bpo-43762 [https://bugs.python.org/issue?@action=redirect&bpo=43762]）

sys

加入了 sys.orig_argv 属性：传给 Python 可执行文件的初始命令行参数列表。（由 Victor Stinner 贡献于 bpo-23427 [https://bugs.python.org/issue?@action=redirect&bpo=23427] ）

添加了 sys.stdlib_module_names，包含标准库模块名称的列表。 （由 Victor Stinner 在 bpo-42955 [https://bugs.python.org/issue?@action=redirect&bpo=42955] 中贡献。）

tempfile

As of 3.10.15 on Windows, the default mode 0o700 used by tempfile.mkdtemp() now limits access to the new directory due to changes to os.mkdir(). This is a mitigation for CVE-2024-4030. (Contributed by Steve Dower in gh-118486 [https://github.com/python/cpython/issues/118486].)

_thread

现在， _thread.interrupt_main() 接受一个可选的信号值参数进行模拟（默认仍为 signal.SIGINT）。（由 Antoine Pitrou 贡献于 bpo-43356 [https://bugs.python.org/issue?@action=redirect&bpo=43356] ）

threading

加入 threading.gettrace() 和 threading.getprofile() ，分别用于获取 threading.settrace() 和 threading.setprofile() 设置的函数。（由Mario Corchero 贡献于 bpo-42251 [https://bugs.python.org/issue?@action=redirect&bpo=42251] ）

加入 threading.__excepthook__ ，用于获取 threading.excepthook() 的初始值，以防被设为一个差劲或其他的值。（由 Mario Corchero 贡献于 bpo-42308 [https://bugs.python.org/issue?@action=redirect&bpo=42308] ）

回溯

现在，format_exception() 、 format_exception_only() 和 print_exception() 函数可以接受一个异常对象，作为唯一的位置参数。（由 Zackery Spytz 和 Matthias Bussonnier 贡献于 bpo-26389 [https://bugs.python.org/issue?@action=redirect&bpo=26389]）

types

重新引入 types.EllipsisType 、 types.NoneType 和 types.NotImplementedType 类，以提供一套新的类型，可供类型检查程序解释。（由 Bas van Beek 贡献于 bpo-41810 [https://bugs.python.org/issue?@action=redirect&bpo=41810]）

typing

主要的变化参阅 有关类型提示的新增特性 。

typing.Literal 的行为被改为遵循 PEP 586 [https://www.python.org/dev/peps/pep-0586] 并匹配该 PEP 所描述的静态类型检查器的行为。

Literal 现在将是去重复的形参。

Literal 对象间的相等性比较现在将是顺序无关的。

Literal 比较现在会考虑类型。 例如 Literal[0] == Literal[False] 之前的结果值为 True。 现在则为 False。 为支持此改变，内部使用的类型缓存现在也支持区分类型。

现在，如果 Literal 对象的任何参数都不是 hashable ，在相等性比较时将引发 TypeError 异常。请注意，在声明 Literal 时，参数不可哈希不会抛出错误：

>>> 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'

（由 Yurii Karabas 在 bpo-42345 [https://bugs.python.org/issue?@action=redirect&bpo=42345] 中贡献。）

加入新函数 typing.is_typeddict() 用于内部检查标注是否为 typing.TypedDict。 （由 Patrick Reader 在 bpo-41792 [https://bugs.python.org/issue?@action=redirect&bpo=41792] 中贡献。）

现在只声明了数据变量的 typing.Protocol 子类当使用 isinstance 检查时将引发 TypeError 除非是带有 runtime_checkable() 装饰器。 在之前版本中，这些检查是静默通过的。 如果用户需要运行时协议则应当对其子类设置 runtime_checkable() 装饰器。 （由 Yurii Karabas 在 bpo-38908 [https://bugs.python.org/issue?@action=redirect&bpo=38908] 中贡献。）

从 typing.io 和 typing.re 子模块导入现在将发出 DeprecationWarning。 这些子模块从 Python 3.8 开始已被弃用并将在未来的某个 Python 版本中被移除。 任何属于这些子模块的东西都应当改为直接从 typing 导入。 （由 Sebastian Rittau 在 bpo-38291 [https://bugs.python.org/issue?@action=redirect&bpo=38291] 中贡献。）

unittest

加入新方法 assertNoLogs() ，以补充现有的 assertLogs()。（由 Kit Yan Choi 贡献于 bpo-39385 [https://bugs.python.org/issue?@action=redirect&bpo=39385] ）

urllib.parse

Python 3.10 以下版本允许在 urllib.parse.parse_qs() 和 urllib.parse.parse_qsl() 中同时使用 ; 和 & 作为查询参数分隔符。出于安全考虑，并符合 W3C 最新的建议，这已经被修改为只允许用一种分隔符，默认值为 &。 这一改变也影响到了 cgi.parse() 和 cgi.parse_multipart()，因为他们内部用到了这些函数。更多细节，请参阅各自的文档。（由 Adam Goldschmidt 、 Senthil Kumaran 和 Ken Jin 贡献于 bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967] ）

在 URL 中存在换行符或制表符，可能会导致某些形式的攻击。根据 WHATWG 的规范更新了:rfc:3986， urllib.parse 中的解析器将从 URL 中移除 ASCII 换行符 \n 、\r 和 \t``字符，以防止这种攻击。将移除的字符由一个新的模块级变量``urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE 控制。（参阅 bpo-43882 [https://bugs.python.org/issue?@action=redirect&bpo=43882] ）

xml

在 xml.sax.handler 模块中加入一个 LexicalHandler 类。（由 Jonathan Gossage 和 Zackery Spytz 贡献于 bpo-35018 [https://bugs.python.org/issue?@action=redirect&bpo=35018] ）

zipimport

加入 PEP 451 [https://www.python.org/dev/peps/pep-0451] 相关的方法： find_spec() 、zipimport.zipimporter.create_module() 和 zipimport.zipimporter.exec_module()。（由 Brett Cannon 贡献于 bpo-42131 [https://bugs.python.org/issue?@action=redirect&bpo=42131] ）

加入 invalidate_caches() 方法。（由 Desmond Cheong 贡献于 bpo-14678 [https://bugs.python.org/issue?@action=redirect&bpo=14678] ）

性能优化

现在，构造函数 str() 、 bytes() 和 bytearray() 速度更快了（小对象大约提速 30-40%）。（由 Serhiy Storchaka 贡献于 bpo-41334 [https://bugs.python.org/issue?@action=redirect&bpo=41334] ）

现在， runpy 导入的模块变少了。python3 -m module-name 命令的启动时间平均加快 1.4 倍。在 Linux 上，Python 3.9 的 python3 -I -m module-name 导入了69个模块，而 Python 3.10 只导入了 51个模块（少了 18 个）。（由 Victor Stinner 贡献于 bpo-41006 [https://bugs.python.org/issue?@action=redirect&bpo=41006] 和 bpo-41718 [https://bugs.python.org/issue?@action=redirect&bpo=41718]）

现在， LOAD_ATTR 指令会使用新的“单独操作码缓存”机制。对于常规属性大约会提速 36%，而对于槽位属性会加快 44%。（由 Pablo Galindo 和 Yury Selivanov 贡献于 bpo-42093 [https://bugs.python.org/issue?@action=redirect&bpo=42093] ），并由 Guido van Rossum 贡献于 bpo-42927 [https://bugs.python.org/issue?@action=redirect&bpo=42927]，基于最初在 PyPy 和 MicroPython 中实现的思路。）

现在，当用 --enable-optimizations 构建 Python 时，会在编译和链接命令行中添加 -fno-semantic-interposition。 这会让用带参数 --enable-shared 的 gcc 构建 Python 解释器时提速 30%。详情请参阅`这篇文章 <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 [https://bugs.python.org/issue?@action=redirect&bpo=38980] ）

bz2 / lzma / zlib 模块用了新的输出缓冲区管理代码，并在 _compression.DecompressReader 类中添加 .readall() 函数。现在，bz2 解压过程提速了 1.09 倍 ~ 1.17 倍，lzma 解压快了 1.20 倍 ~ 1.32 倍， GzipFile.read(-1) 快了 1.11 倍 ~ 1.18 倍。（由 Ma Lin 贡献，由 Gregory P. Smith 审查， bpo-41486 [https://bugs.python.org/issue?@action=redirect&bpo=41486]）

当使用字符串化的标注时，函数的标注字典不再是在创建函数时被创建。 它们被改为存储为字符串元组，并且函数对象会在需要时延迟转换为标注字典。 这一优化可将定义带标注函数的 CPU 时间减少一半。 （由 Yurii Karabas 和 Inada Naoki 在 bpo-42202 [https://bugs.python.org/issue?@action=redirect&bpo=42202] 中贡献。）

现在，子串搜索函数，如 str1 in str2 和 str2.find(str1) ，有时会采用Crochemore & Perrin的“二路归并”字符串搜索算法，以避免长字符串的二次检索行为。（由 Dennis Sweeney 贡献于 bpo-41972 [https://bugs.python.org/issue?@action=redirect&bpo=41972] ）

为 _PyType_Lookup() 增加微幅优化以提高类型属性缓存查询在常见缓存命中情况下的性能。 这使得解释器的平均速度提升至 1.04 倍。 （由 Dino Viehland 在 bpo-43452 [https://bugs.python.org/issue?@action=redirect&bpo=43452] 中贡献。）

下列内置函数现在支持更快速的 PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall 调用约定: map(), filter(), reversed(), bool() 和 float()。 （由 Dong-hee Na 和 Jeroen Demeyer 在 bpo-43575 [https://bugs.python.org/issue?@action=redirect&bpo=43575], bpo-43287 [https://bugs.python.org/issue?@action=redirect&bpo=43287], bpo-41922 [https://bugs.python.org/issue?@action=redirect&bpo=41922], bpo-41873 [https://bugs.python.org/issue?@action=redirect&bpo=41873] 和 bpo-41870 [https://bugs.python.org/issue?@action=redirect&bpo=41870] 中贡献。）

BZ2File 的性能通过移除内部的 RLock 获得改善。 这使得 BZ2File 在面对多个同时的读取器和写入器不再是线程安全的，，就像 gzip 和 lzma 中的对应类一直以来的情况一样。 （由 Inada Naoki 在 bpo-43785 [https://bugs.python.org/issue?@action=redirect&bpo=43785] 中贡献。）

弃用

目前 Python 接受数字类字面值后面紧跟关键字的写法，例如 0in x, 1or x, 0if 1else 2。 它将允许像 [0x1for x in y] 这样令人困惑且模棱两可的表达式 (它可以被解读为 [0x1 for x in y] 或者 [0x1f or x in y])。 从本发布版开始，如果数字类字面值后面紧跟关键字 and, else, for, if, in, is 和 or 中的一个将会引发弃用警告。 在未来的版本中它将改为语法警告，最终将改为语法错误。 （由 Serhiy Storchaka 在 bpo-43833 [https://bugs.python.org/issue?@action=redirect&bpo=43833] 中贡献。）

从本发布版开始，将发起一次协同行动来清理为兼容 Python 2.7 而保留的旧导入语义。 具体内容如下，find_loader()/find_module() (被 find_spec() 取代), load_module() (被 exec_module() 取代), module_repr() (由导入系统负责处理), __package__ 属性 (被 __spec__.parent 取代), __loader__ 属性 (被 __spec__.loader 取代), 以及 __cached__ 属性 (被 __spec__.cached 取代) 将被逐步移除 (还包括 importlib 中的其他类和方法)。 ImportWarning 和/或 DeprecationWarning 将被相应地引发以帮助在过渡期间识别需要更新的代码。

整个 distutils 命名空间已被弃用，并将在 Python 3.12 中被移除。 请参阅 模块的变化 一节了解更多信息。

random.randrange() 的非整数参数已被弃用。 ValueError 已被弃用而应改用 TypeError。（由 Serhiy Storchaka 和 Raymond Hettinger 贡献于 bpo-37319 [https://bugs.python.org/issue?@action=redirect&bpo=37319] ）

importlib 的各种 load_module() 方法自 Python 3.6 起就已被记录为弃用，现在还会触发 DeprecationWarning。请改用 exec_module()。（由 Brett Cannon 贡献于 bpo-26131 [https://bugs.python.org/issue?@action=redirect&bpo=26131] ）

zimport.zipimporter.load_module() 已弃用并被 exec_module() 代替。 （由 Brett Cannon 在 bpo-26131 [https://bugs.python.org/issue?@action=redirect&bpo=26131] 中贡献。）

现在导入时使用 load_module() 会引发 ImportWarning ，应改用 exec_module()。 （由 Brett Cannon 贡献于 bpo-26131 [https://bugs.python.org/issue?@action=redirect&bpo=26131] ）

现在导入系统使用 importlib.abc.MetaPathFinder.find_module() 和 importlib.abc.PathEntryFinder.find_module() 会引发 ImportWarning 而应分别改用 importlib.abc.MetaPathFinder.find_spec() 和 importlib.abc.PathEntryFinder.find_spec()。 你可以使用 importlib.util.spec_from_loader() 来帮助移植。 （由 Brett Cannon 在 bpo-42134 [https://bugs.python.org/issue?@action=redirect&bpo=42134] 中贡献。）

现在导入系统使用 importlib.abc.PathEntryFinder.find_loader() 会引发 ImportWarning 而应改用 importlib.abc.PathEntryFinder.find_spec()。 你可以使用 importlib.util.spec_from_loader() 来帮助移植。 （由 Brett Cannon 在 bpo-43672 [https://bugs.python.org/issue?@action=redirect&bpo=43672] 中贡献。）

现在 importlib.abc.MetaPathFinder.find_module() ( importlib.machinery.BuiltinImporter.find_module(), importlib.machinery.FrozenImporter.find_module(), importlib.machinery.WindowsRegistryFinder.find_module(), importlib.machinery.PathFinder.find_module(), importlib.abc.MetaPathFinder.find_module()), importlib.abc.PathEntryFinder.find_module() ( importlib.machinery.FileFinder.find_module() ), 和 importlib.abc.PathEntryFinder.find_loader() ( importlib.machinery.FileFinder.find_loader() ) 的各个实现会引发 DeprecationWarning 并预定在 Python 3.12 中被移除（之前它们在 Python 3.4 中就被记录为已弃用）。 （由 Brett Cannon 在 bpo-42135 [https://bugs.python.org/issue?@action=redirect&bpo=42135] 中贡献。）

importlib.abc.Finder 已被弃用 (包括它唯一的方法 find_module())。 importlib.abc.MetaPathFinder 和 importlib.abc.PathEntryFinder 都不再继承该类。 用户应当改为继承这两个类中的一个。 （由 Brett Cannon 在 bpo-42135 [https://bugs.python.org/issue?@action=redirect&bpo=42135] 中贡献。）

imp, importlib.find_loader(), importlib.util.set_package_wrapper(), importlib.util.set_loader_wrapper(), importlib.util.module_for_loader(), pkgutil.ImpImporter 和 pkgutil.ImpLoader 的弃用状态已被更新以将 Python 3.12 列为预定要移除它们的版本 (它们在之前的 Python 版本中已开始引发 DeprecationWarning)。 （由 Brett Cannon 在 bpo-43720 [https://bugs.python.org/issue?@action=redirect&bpo=43720] 中贡献。）.)

现在导入系统会先使用模块上的 __spec__ 属性再回退到 module_repr() 来使用模块的 __repr__() 方法。 对 module_repr() 的使用预定在 Python 3.12 中移除。 （由 Brett Cannon 在 bpo-42137 [https://bugs.python.org/issue?@action=redirect&bpo=42137] 中贡献。）

importlib.abc.Loader.module_repr(), importlib.machinery.FrozenLoader.module_repr() 和 importlib.machinery.BuiltinLoader.module_repr() 已被弃用并预定在 Python 3.12 中移除。 （由 Brett Cannon 在 bpo-42136 [https://bugs.python.org/issue?@action=redirect&bpo=42136] 中贡献。）

sqlite3.OptimizedUnicode 自 Python 3.3 起就被移出文档并设为过时，当时它是被设为 str 的别名。 现在它已被弃用，预定在 Python 3.12 中移除。 （由 Erlend E. Aasland 在 bpo-42264 [https://bugs.python.org/issue?@action=redirect&bpo=42264] 中贡献。）

未记入文档的内置函数 sqlite3.enable_shared_cache 现在已被弃用，预定在 Python 3.12 中移除。 SQLite3 强烈不建议使用它。 请参阅 SQLite3 文档 [https://sqlite.org/c3ref/enable_shared_cache.html] 了解详情。 如果必须要使用共享缓冲区，请使用 cache=shared 查询参数来以 URI 模式打开数据库。 （由 Erlend E. Aasland 在 bpo-24464 [https://bugs.python.org/issue?@action=redirect&bpo=24464] 中贡献。）

以下 threading 方法已被弃用:

threading.currentThread => threading.current_thread()

threading.activeCount => threading.active_count()

threading.Condition.notifyAll => threading.Condition.notify_all()

threading.Event.isSet => threading.Event.is_set()

threading.Thread.setName => threading.Thread.name

threading.thread.getName => threading.Thread.name

threading.Thread.isDaemon => threading.Thread.daemon

threading.Thread.setDaemon => threading.Thread.daemon

（由 Jelle Zijlstra 在 gh-87889 [https://github.com/python/cpython/issues/87889] 中贡献。）

pathlib.Path.link_to() 已被弃用并预定在 Python 3.12 中移除。 请改用 pathlib.Path.hardlink_to()。 （由 Barney Gale 在 bpo-39950 [https://bugs.python.org/issue?@action=redirect&bpo=39950] 中贡献。）

cgi.log() 已被弃用并预定在 Python 3.12 中移除。 （由 Inada Naoki 在 bpo-41139 [https://bugs.python.org/issue?@action=redirect&bpo=41139] 中贡献。）

以下 ssl 特性自 Python 3.6, Python 3.7 或 OpenSSL 1.1.0 起已被弃用并将在 3.11 中移除:

OP_NO_SSLv2, OP_NO_SSLv3, OP_NO_TLSv1, OP_NO_TLSv1_1, OP_NO_TLSv1_2 及 OP_NO_TLSv1_3 会被 sslSSLContext.minimum_version 和 sslSSLContext.maximum_version 代替。

PROTOCOL_SSLv2, PROTOCOL_SSLv3, PROTOCOL_SSLv23, PROTOCOL_TLSv1, PROTOCOL_TLSv1_1, PROTOCOL_TLSv1_2 及 PROTOCOL_TLS 已被弃用并会被 PROTOCOL_TLS_CLIENT 和 PROTOCOL_TLS_SERVER 代替

wrap_socket() 会被 ssl.SSLContext.wrap_socket() 代替

match_hostname()

RAND_pseudo_bytes(), RAND_egd()

NPN 特性如 ssl.SSLSocket.selected_npn_protocol() 和 ssl.SSLContext.set_npn_protocols() 会被 ALPN 代替。

线程调试 (PYTHONTHREADDEBUG 环境变量) 在 Python 3.10 中已被弃用并将在 Python 3.12 中移除。 此特性需要 Python 的调试编译版。 （由 Victor Stinner 在 bpo-44584 [https://bugs.python.org/issue?@action=redirect&bpo=44584] 中贡献。）

从 typing.io 和 typing.re 子模块导入现在将发出 DeprecationWarning。 这些子模块将在未来的 Python 版本中被移除。 任何属于这些子模块的东西都应当改为直接从 typing 导入。 （由 Sebastian Rittau 在 bpo-38291 [https://bugs.python.org/issue?@action=redirect&bpo=38291] 中贡献。）

移除

移除了 complex 类的特殊方法 __int__, __float__, __floordiv__, __mod__, __divmod__, __rfloordiv__, __rmod__ 和 __rdivmod__。 它们总是会引发 TypeError。 （由 Serhiy Storchaka 在 bpo-41974 [https://bugs.python.org/issue?@action=redirect&bpo=41974] 中贡献。）

ParserBase.error() 方法（来自私有且未记入文档的 _markupbase 模块）已被移除。 html.parser.HTMLParser 是 ParserBase 的唯一子类并且它的 error() 实现在 Python 3.5 中已被移除。 （由 Berker Peksag 在 bpo-31844 [https://bugs.python.org/issue?@action=redirect&bpo=31844] 中贡献。）

移除了 unicodedata.ucnhash_CAPI 属性，它是一个内部 PyCapsule 对象。 相关联的私有 _PyUnicode_Name_CAPI 结构体已被移至内部 C API。 （由 Victor Stinner 在 bpo-42157 [https://bugs.python.org/issue?@action=redirect&bpo=42157] 中贡献。）

移除了 parser 模块，它在 3.9 中由于切换到新的 PEG 解析器而与仅被旧解析器所使用的 C 源文件和头文件一起被弃用，包括 node.h, parser.h, graminit.h 和 grammar.h。

移除了公有 C API 函数 PyParser_SimpleParseStringFlags, PyParser_SimpleParseStringFlagsFilename, PyParser_SimpleParseFileFlags 和 PyNode_Compile，它们在 3.9 中由于切换到新的 PEG 解析器而被弃用。

移除了 formatter 模块，它在 Python 3.4 中已被弃用。 它相当过时、极少被使用，并且未经测试。 它最初计划在 Python 3.6 中移除，但此移除被改为延迟到 Python 2.7 生命期结束之后。 现有用户应当将他们用到的所有类都拷贝到自己的代码中。 （由 Dong-hee Na 和 Terry J. Reedy 在 bpo-42299 [https://bugs.python.org/issue?@action=redirect&bpo=42299] 中贡献。）

移除了 PyModule_GetWarningsModule() 函数，现在它由于 _warnings 模块在 2.6 中被转换为内置模块而变得没有用处。 （由 Hai Shi 在 bpo-42599 [https://bugs.python.org/issue?@action=redirect&bpo=42599] 中贡献。）

从 collections 模块中移除了已被弃用的 容器抽象基类 的别名。 （由 Victor Stinner 在 bpo-37324 [https://bugs.python.org/issue?@action=redirect&bpo=37324] 中贡献。）

loop 形参已从大部分 asyncio 的 高层级 API 中被移除，之前它们在 Python 3.8 中已被弃用。 这一改变的动机是多方面的:

这简化了高层级 API。

高层级 API 中的这些函数自 Python 3.7 起已经会隐式地获取当前线程正在运行的事件循环。 在大多数正常使用场景中都没有必要向 API 传入事件循环。

在处理不同线程中运行的事件循环时传递事件循环特别容易产生错误。

请注意低层级 API 仍将接受 loop。 请参阅 Python API 的变化 来获取有关如何替换现有代码的示例。

（由 Yurii Karabas, Andrew Svetlov, Yury Selivanov 和 Kyle Stanley 在 bpo-42392 [https://bugs.python.org/issue?@action=redirect&bpo=42392] 中贡献。）

移植到 Python 3.10

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

Python 语法中的变化

现在当编译之前有效的语法时如果数字类字面值后面紧跟一个关键字（如在 0in x 中）则会发出弃用警告。 在未来的版本中它将被改为语法警告，最终会改为语法错误。 要避免警告并使代码与未来的版本保持兼容只需在数字和后面的关键字之间添加一个空格。 （由 Serhiy Storchaka 在 bpo-43833 [https://bugs.python.org/issue?@action=redirect&bpo=43833] 中贡献。）

Python API 的变化

traceback 模块中的 format_exception() 、 format_exception_only() 和 print_exception() 函数的 etype 参数已更名为 exc 。（由 Zackery Spytz 和 Matthias Bussonnier 贡献于 bpo-26389 [https://bugs.python.org/issue?@action=redirect&bpo=26389] ）

atexit ： 在 Python 退出时，若用 atexit.register() 注册的回调失败，现在会记录其异常。以前，只有部分异常被记录，最后一个异常总是被静默忽略。（由 Victor Stinner 贡献于 bpo-42639 [https://bugs.python.org/issue?@action=redirect&bpo=42639] ）

现在，泛型 collections.abc.Callable 的类型参数扁平化了，类似于 typing.Callable 目前的做法。这意味着 collections.abc.Callable[[int, str], str] 的 __args__ 将为 (int, str, str)；而以前是 ([int, str], str)。 通过 typing.get_args() 或 __args__ 访问参数的代码需要考虑到这一变化。此外，为 collections.abc.Callable 给出无效参数可能会引发 TypeError ，而在 Python 3.9 中则可能会静默传入。（由 Ken Jin 贡献于 bpo-42195 [https://bugs.python.org/issue?@action=redirect&bpo=42195]）

现在，如果给定的形参不是 16 位无符号整数， socket.htons() 和 socket.ntohs() 会引发 OverflowError 而非 DeprecationWarning。 （由 Erlend E. Aasland 在 bpo-42393 [https://bugs.python.org/issue?@action=redirect&bpo=42393] 中贡献。）

The loop parameter has been removed from most of asyncio's high-level API following deprecation in Python 3.8.

现在如下协程：

async def foo(loop):
    await asyncio.sleep(1, loop=loop)

应替换为：

async def foo():
    await asyncio.sleep(1)

如果 foo() 被特别设计成 不 运行于当前线程的运行事件循环中（比如运行在另一个线程的事件循环中），请考虑使用 asyncio.run_coroutine_threadsafe() 来代替。

（由 Yurii Karabas, Andrew Svetlov, Yury Selivanov 和 Kyle Stanley 在 bpo-42392 [https://bugs.python.org/issue?@action=redirect&bpo=42392] 中贡献。）

如果 globals 字典中没有 "__builtins__" 键，那么 types.FunctionType 构造器现在将继承当前值，而不是用 {"None": None}，这与 eval() 和 exec() 函数一致。 利用 def function(...): ... 定义一个 Python 函数则不受影响，globals 无法被这种语法覆盖：它也是继承了当前值。 （由 Victor Stinner 在 bpo-42990 [https://bugs.python.org/issue?@action=redirect&bpo=42990] 中贡献。）

C API 的变化

由于换成了新的 PEG 解析程序，C 语言 API 函数 PyParser_SimpleParseStringFlags 、PyParser_SimpleParseStringFlagsFilename 、PyParser_SimpleParseFileFlags 、PyNode_Compile 以及这些函数用到的类型 struct _node 已被删除。

现在应该用 Py_CompileString() 将源代码直接编译为代码对象。然后可以用 PyEval_EvalCode() 之类的东西来对其求值。

特别地：

先 PyParser_SimpleParseStringFlags 再 PyNode_Compile 的调用，可以由 Py_CompileString() 代替。

PyParser_SimpleParseFileFlags 没有直接替代品。要从 FILE * 参数编译代码，需要先用 C 语言读取文件，然后将结果缓冲区传给 Py_CompileString()。

要编译一个 char * 给定文件名的文件，先显式打开该文件，再读取并进行编译。一种方法是利用 io 模块的 PyImport_ImportModule() 、 PyObject_CallMethod() 、 PyBytes_AsString() 和 Py_CompileString()，如下图所示。（省略了声明和错误处理部分）

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);

对于 FrameObject 对象， f_lasti 成员现在代表一个字码偏移，而不是字节码字符串的简单偏移。这意味着这个数字需要乘以 2 才能用于期望用字节偏移的 API （例如 PyCode_Addr2Line() ）。也请注意， FrameObject 对象的 f_lasti 成员不被认为是稳定的：请使用 PyFrame_GetLineNumber() 代替。

CPython 字节码的改变

现在 MAKE_FUNCTION 指令将接受一个字典或字符串元组作为函数的标注。 （由 Yurii Karabas 和 Inada Naoki 在 bpo-42202 [https://bugs.python.org/issue?@action=redirect&bpo=42202] 中贡献。）

构建的改变

PEP 644 [https://www.python.org/dev/peps/pep-0644] ：Python 现在要求 OpenSSL 1.1.1 以上版本。不再支持 OpenSSL 1.0.2。（由 Christian Heimes 贡献于 bpo-43669 [https://bugs.python.org/issue?@action=redirect&bpo=43669] ）

编译 Python 现在需要用到 C99 函数 snprintf() 和 vsnprintf() 。(由 Victor Stinner 贡献于 bpo-36020 [https://bugs.python.org/issue?@action=redirect&bpo=36020] ）

sqlite3 需要 SQLite 3.7.15 以上版本。（由 Sergey Fedoseev 和 Erlend E. Aasland 贡献于 bpo-40744 [https://bugs.python.org/issue?@action=redirect&bpo=40744] 和 bpo-40810 [https://bugs.python.org/issue?@action=redirect&bpo=40810] ）

现在， atexit 模块必须编译为内置模块。（由 Victor Stinner 贡献于 bpo-42639 [https://bugs.python.org/issue?@action=redirect&bpo=42639] ）

在 configure 脚本中加入 --disable-test-modules 选项：不编译也不安装 test 模块。（由 Xavier de Gaye、Thomas Petazzoni 和 Peixing Xin 贡献于 bpo-27640 [https://bugs.python.org/issue?@action=redirect&bpo=27640]）

在 ./configure 脚本中加入 --with-wheel-pkg-dir=PATH 选项。如果指定了该选项， ensurepip 模块会在该目录下查找 setuptools 和 pip 包：如果两者都存在，就会使用这些包，而不是surepip 绑定的包。

某些 Linux 发行版的打包策略建议不要绑定依赖关系。比如 Fedora 在 /usr/share/python-wheels/ 目录下安装 wheel 包，而不安装 ensurepip._bundled 包。

（由 Victor Stinner 贡献于 bpo-42856 [https://bugs.python.org/issue?@action=redirect&bpo=42856]）

增加了新的 configure --without-static-libpython 选项 ，用于标明不编译 libpythonMAJOR.MINOR.a 静态库并且不安装 python.o 对象文件。

（由 Victor Stinner 在 bpo-43103 [https://bugs.python.org/issue?@action=redirect&bpo=43103] 中贡献。）

现在， configure 脚本会利用 pkg-config 工具检测 Tcl/Tk 头文件和库的位置。此前，这些文件的位置可通过 --with-tcltk-includes 和 --with-tcltk-libs 选项显式指定。（由 Manolis Stamatogiannakis 贡献于 bpo-42603 [https://bugs.python.org/issue?@action=redirect&bpo=42603] ）

为 configure 脚本加入 --with-openssl-rpath 选项。该选项简化了用定制版本 OpenSSL 编译 Python 的过程，例如 ./configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto。（由 Christian Heimes 贡献于 bpo-43466 [https://bugs.python.org/issue?@action=redirect&bpo=43466] ）

C API 的改变

PEP 652：稳定版 ABI 的维护

现在，用于扩展模块或嵌入 Python 的稳定版 ABI （应用程序二进制接口）已有显式的定义。 C API 的稳定性 描述了 C API 和 ABI 稳定性保证和稳定版 ABI 的最佳实践。

（由 Petr Viktorin 在 PEP 652 [https://www.python.org/dev/peps/pep-0652] 和 bpo-43795 [https://bugs.python.org/issue?@action=redirect&bpo=43795] 中贡献。）.)

新的特性

现在 PyNumber_Index() 的结果一定是 int 类型。此前可能是 int 的子类实例。（由 Serhiy Storchaka 贡献于 bpo-40792 [https://bugs.python.org/issue?@action=redirect&bpo=40792] ）

Add a new orig_argv member to the PyConfig structure: the list of the original command line arguments passed to the Python executable. (Contributed by Victor Stinner in bpo-23427 [https://bugs.python.org/issue?@action=redirect&bpo=23427].)

加入宏 PyDateTime_DATE_GET_TZINFO() 和 PyDateTime_TIME_GET_TZINFO() ，用于访问 datetime.datetime 和 datetime.time 对象的 tzinfo 属性。 （由 Zackery Spytz 贡献于 bpo-30155 [https://bugs.python.org/issue?@action=redirect&bpo=30155] ）

加入 PyCodec_Unregister() 函数，用于注销编解码器检索函数。（由 Hai Shi 贡献于 bpo-41842 [https://bugs.python.org/issue?@action=redirect&bpo=41842] ）

加入 PyIter_Send() 函数，可不触发 StopIteration 异常地向迭代器发送数据。（由 Vladimir Matveev 贡献于 bpo-41756 [https://bugs.python.org/issue?@action=redirect&bpo=41756] ）

受限 C API 中加入了 PyUnicode_AsUTF8AndSize() 。（由 Alex Gaynor 贡献于 bpo-41784 [https://bugs.python.org/issue?@action=redirect&bpo=41784] ）

加入 PyModule_AddObjectRef() 函数：类似于 PyModule_AddObject() 但在成功后不会偷取参数对象的引用计数。（由 Victor Stinner 贡献于 bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741] ）

加入 Py_NewRef() 和 Py_XNewRef() 函数，用于递增指定对象的引用计数并返回该对象。（由 Victor Stinner 贡献于 bpo-42262 [https://bugs.python.org/issue?@action=redirect&bpo=42262] ）

现在， PyType_FromSpecWithBases() 和 PyType_FromModuleAndSpec() 函数可接受一个类作为 bases 参数。（由 Serhiy Storchaka 贡献于 bpo-42423 [https://bugs.python.org/issue?@action=redirect&bpo=42423] ）

PyType_FromModuleAndSpec() 函数现在接受 NULL tp_doc 槽位。 （由 Hai Shi 在 bpo-41832 [https://bugs.python.org/issue?@action=redirect&bpo=41832] 中贡献。）

PyType_GetSlot() 函数现在可以接受 静态类型。 （由 Hai Shi 和 Petr Viktorin 在 bpo-41073 [https://bugs.python.org/issue?@action=redirect&bpo=41073] 中贡献。）

新增 PySet_CheckExact() 函数到 C-API 用于检查一个对象是否是 set 的实例但不是其子类型的实例。 （由 Pablo Galindo 在 bpo-43277 [https://bugs.python.org/issue?@action=redirect&bpo=43277] 中贡献。）

增加了 PyErr_SetInterruptEx()，它允许传入一个信号序号用于进行模拟。 （由 Antoine Pitrou 在 bpo-43356 [https://bugs.python.org/issue?@action=redirect&bpo=43356] 中贡献。）

现在，Python 以调试模式编译 时也支持受限 C API 的使用了（需先定义 Py_DEBUG 宏）。在受限 C API 中，如果 Python 是以调试模式编译的，且 Py_LIMITED_API 宏以 Python 3.10 以上版本为目标，那么现在 Py_INCREF() 和 Py_DECREF() 函数实现为非透明的函数调用，而非直接访问 PyObject.ob_refcnt 成员。在调试模式下支持受限 C API 成为可能，是因为自 Python 3.8 起 PyObject 结构体在发布模式和调试模式下是相同的（参见 bpo-36465 [https://bugs.python.org/issue?@action=redirect&bpo=36465] ）。

在 --with-trace-refs 特殊编译方式下（Py_TRACE_REFS 宏），仍不支持使用受限 C API 。（由 Victor Stinner 贡献于 bpo-43688 [https://bugs.python.org/issue?@action=redirect&bpo=43688] ）

加入 Py_Is(x, y) 函数，用于测试 x 对象是否是 y 对象，等价于 Python 中的 x is y。还加入了 Py_IsNone() 、 Py_IsTrue() 、 Py_IsFalse() 函数，分别用于测试某对象是否为 None 单例、True 单例或 False 单例。（由 Victor Stinner 贡献于 bpo-43753 [https://bugs.python.org/issue?@action=redirect&bpo=43753] ）

新增由 C 代码控制垃圾回收器的函数: PyGC_Enable(), 、PyGC_Disable() 、 PyGC_IsEnabled()。这些函数允许从 C 代码激活、停止和查询垃圾回收器的状态，而不必导入 gc 模块。

新增 Py_TPFLAGS_DISALLOW_INSTANTIATION 类型标记，用于禁止创建类型实例。（由 Victor Stinner 贡献于 bpo-43916 [https://bugs.python.org/issue?@action=redirect&bpo=43916] ）

新增 Py_TPFLAGS_IMMUTABLETYPE 类型标记，用于创建不可变类型对象：类型的属性不可设置或删除。（由 Victor Stinner 和 Erlend E. Aasland 贡献于 bpo-43908 [https://bugs.python.org/issue?@action=redirect&bpo=43908] ）

移植到 Python 3.10

现在必须定义 PY_SSIZE_T_CLEAN 宏才能使用 PyArg_ParseTuple() 和 Py_BuildValue() 格式，这些格式会使用 #: es#, et#, s#, u#, y#, z#, U# 和 Z#。 参见 解析参数并构建值变量 和 PEP 353 [https://www.python.org/dev/peps/pep-0353]。 （由 Victor Stinner 在 bpo-40943 [https://bugs.python.org/issue?@action=redirect&bpo=40943] 中贡献。）

由于 Py_REFCNT() 已改为内联静态函数，Py_REFCNT(obj) = new_refcnt 必须换成 Py_SET_REFCNT(obj, new_refcnt): 参见 Py_SET_REFCNT() （自 Python 3.9 起提供）。为保持向下兼容，可用此宏：

#if PY_VERSION_HEX < 0x030900A4
#  define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
#endif

（由 Victor Stinner 在 bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573] 中贡献。）

由于历史原因，曾经允许调用 PyDict_GetItem() 时不带 GIL 。 现在则不行了。（由 Victor Stinner 贡献于 bpo-40839 [https://bugs.python.org/issue?@action=redirect&bpo=40839] ）

现在， PyUnicode_FromUnicode(NULL, size) 和 PyUnicode_FromStringAndSize(NULL, size) 会引发 DeprecationWarning。 请利用 PyUnicode_New() 获得不带初始数据的 Unicode 对象。（由 Inada Naoki 贡献于 bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346] ）

私有结构体 _PyUnicode_Name_CAPI （PyCapsule API unicodedata.ucnhash_CAPI ）已被移入内部 C API。（由 Victor Stinner 贡献于 bpo-42157 [https://bugs.python.org/issue?@action=redirect&bpo=42157] ）

现在 Py_GetPath(), Py_GetPrefix(), Py_GetExecPrefix(), Py_GetProgramFullPath(), Py_GetPythonHome() 和 Py_GetProgramName() 函数如果在 Py_Initialize() 之前（在 Python 被初始化之前）被调用将返回 NULL。 请使用新的 Python初始化配置 API 来获取 Python 路径配置。 （由 Victor Stinner 在 bpo-42260 [https://bugs.python.org/issue?@action=redirect&bpo=42260] 中贡献。）

宏 PyList_SET_ITEM() 、 PyTuple_SET_ITEM() 和 PyCell_SET() 不可再用作左值或右值。例如，现在 x = PyList_SET_ITEM(a, b, c) 和 PyList_SET_ITEM(a, b, c) = x 会失败并提示编译器错误。 这可以防止 if (PyList_SET_ITEM (a, b, c) < 0) ... 之类的检测发生问题。（由 Zackery Spytz 和 Victor Stinner 贡献于 bpo-30459 [https://bugs.python.org/issue?@action=redirect&bpo=30459] ）

非受限 API 文件 odictobject.h, parser_interface.h, picklebufobject.h, pyarena.h, pyctype.h, pydebug.h, pyfpe.h 和 pytime.h 已被移至 Include/cpython 目录。 这些文件不可被直接包括，因为它们已经在 Python.h 中被包括了；参见 包含文件。 如果它们已被直接包括，请考虑改为包括 Python.h。 （由 Nicholas Sim 在 bpo-35134 [https://bugs.python.org/issue?@action=redirect&bpo=35134] 中贡献。）

请用 Py_TPFLAGS_IMMUTABLETYPE 类型标记来创建不可变对象。 不要依赖 Py_TPFLAGS_HEAPTYPE 来确定类型对象是否可变；请改为检查是否设置了 Py_TPFLAGS_IMMUTABLETYPE。（由 Victor Stinner 和 Erlend E. Aasland 贡献于 bpo-43908 [https://bugs.python.org/issue?@action=redirect&bpo=43908] ）

未被加入文档的函数 Py_FrozenMain 已从受限 API 中移除。 该函数主要适用于 Python 的定制版本。 （由 Petr Viktorin 在 bpo-26241 [https://bugs.python.org/issue?@action=redirect&bpo=26241] 中贡献。）

弃用

现在 PyUnicode_InternImmortal() 函数已被弃用，并将在 Python 3.12 中移除：请改用 PyUnicode_InternInPlace()。（由 Victor Stinner 贡献于 bpo-41692 [https://bugs.python.org/issue?@action=redirect&bpo=41692] ）

移除

移除了 Py_UNICODE_str* 函数，它被用于控制 Py_UNICODE* 字符串。 （由 Inada Naoki 在 bpo-41123 [https://bugs.python.org/issue?@action=redirect&bpo=41123] 中贡献。）

Py_UNICODE_strlen: 使用 PyUnicode_GetLength() 或 PyUnicode_GET_LENGTH

Py_UNICODE_strcat: 使用 PyUnicode_CopyCharacters() 或 PyUnicode_FromFormat()

Py_UNICODE_strcpy, Py_UNICODE_strncpy: 使用 PyUnicode_CopyCharacters() 或 PyUnicode_Substring()

Py_UNICODE_strcmp: 使用 PyUnicode_Compare()

Py_UNICODE_strncmp: 使用 PyUnicode_Tailmatch()

Py_UNICODE_strchr, Py_UNICODE_strrchr: 使用 PyUnicode_FindChar()

移除了 PyUnicode_GetMax()。 请迁移到新的 (PEP 393 [https://www.python.org/dev/peps/pep-0393]) API。 （由 Inada Naoki 在 bpo-41103 [https://bugs.python.org/issue?@action=redirect&bpo=41103] 中贡献。）

移除了 PyLong_FromUnicode()。 请迁移到 PyLong_FromUnicodeObject()。 （由 Inada Naoki 在 bpo-41103 [https://bugs.python.org/issue?@action=redirect&bpo=41103] 中贡献。）

移除了 PyUnicode_AsUnicodeCopy()。 请使用 PyUnicode_AsUCS4Copy() 或 PyUnicode_AsWideCharString() （由 Inada Naoki 在 bpo-41103 [https://bugs.python.org/issue?@action=redirect&bpo=41103] 中贡献。）

移除了 _Py_CheckRecursionLimit 变量：它已被 PyInterpreterState 结构体的 ceval.recursion_limit 所取代。 （由 Victor Stinner 在 bpo-41834 [https://bugs.python.org/issue?@action=redirect&bpo=41834] 中贡献。）

移除了未记入文档的宏 Py_ALLOW_RECURSION 和 Py_END_ALLOW_RECURSION 以及 PyInterpreterState 结构体的 recursion_critical 字段。 （由 Serhiy Storchaka 在 bpo-41936 [https://bugs.python.org/issue?@action=redirect&bpo=41936] 中贡献。）

移除了未记入文档的 PyOS_InitInterrupts() 函数。Python 初始化时已隐式安装了信号处理 handler：参见 PyConfig.install_signal_handlers。（由 Victor Stinner 贡献于 bpo-41713 [https://bugs.python.org/issue?@action=redirect&bpo=41713] ）

移除了 PyAST_Validate() 函数。不能再使用公有 C API 来构建 AST 对象（mod_ty 类型）了。该函数已不属于受限 C API（PEP 384 [https://www.python.org/dev/peps/pep-0384] ）。（由 Victor Stinner 贡献于 bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244] ）

移除了 symtable.h 头文件及未写入文档的函数:

PyST_GetScope()

PySymtable_Build()

PySymtable_BuildObject()

PySymtable_Free()

Py_SymtableString()

Py_SymtableStringObject()

Py_SymtableString() 函数误为稳定版 ABI 却无法使用，因为 symtable.h 头文件不属于受限 C API。

请改用 Python symtable 模块。 （由 Victor Stinner 在 bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244] 中贡献。）

PyOS_ReadlineFunctionPointer() 已从受限 C API 头文件和 python3.dll 中移除，此 dll 为 Windows 中的稳定版 ABI 库。由于该函数可接受一个 FILE* 参数，所以无法保证其 ABI 稳定性。（由 Petr Viktorin 贡献于 bpo-43868 [https://bugs.python.org/issue?@action=redirect&bpo=43868] ）

移除了 ast.h, asdl.h 和 Python-ast.h 头文件。 这些函数未入文档且不属于受限 C API。这些头文件中定义的大多数名称都不带 Py 前缀，因此可能会造成命名冲突。比如 Python-ast.h 定义了一个 Yield 宏，就会与另一个Windows <winbase.h> 头文件中的 Yield 冲突。请改用 Python ast 模块。（由 Victor Stinner 贡献于 bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244] ）

移除了用到 struct _mod 类型的编译器和解析器函数，因为公共的 AST C API 已被移除：

PyAST_Compile()

PyAST_CompileEx()

PyAST_CompileObject()

PyFuture_FromAST()

PyFuture_FromASTObject()

PyParser_ASTFromFile()

PyParser_ASTFromFileObject()

PyParser_ASTFromFilename()

PyParser_ASTFromString()

PyParser_ASTFromStringObject()

这些函数未入文档且不属于受限 C API。（由 Victor Stinner 贡献于 bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244] ）

移除了包含下列函数的头文件 pyarena.h ：

PyArena_New()

PyArena_Free()

PyArena_Malloc()

PyArena_AddPyObject()

这些函数未记入文档，且不属于受限 C API，仅由编译器内部使用。（由 Victor Stinner 贡献于 bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244] ）

PyThreadState.use_tracing 成员已被删除，以优化 Python 。(由 Mark Shannon 在 bpo-43760 [https://bugs.python.org/issue?@action=redirect&bpo=43760] 中贡献。)

3.10.7 中的重要安全特性

使用十进制以外的底，如 2（二进制）、4、8（八进制）、16（十六进制）、32 以外作为基数在 int 和 str 之间进行转换，如果字符串形式的数字数量超过一个限制，会抛出 ValueError，以避免因算法复杂而导致的潜在拒绝服务攻击。这是对 CVE-2020-10735 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735] 的缓解方案。这个限制可以通过环境变量、命令行旗标或 sys API 进行配置或禁用。参见 integer string conversion length limitation 文档。默认限制是字符串形式的 4300 位数字。

3.10.8 中的重要安全特性

The deprecated mailcap module now refuses to inject unsafe text (filenames, MIME types, parameters) into shell commands. Instead of using such text, it will warn and act as if a match was not found (or for test commands, as if the test failed). (Contributed by Petr Viktorin in gh-98966 [https://github.com/python/cpython/issues/98966].)

Notable Changes in 3.10.12

tarfile

tarfile 中的提取方法和 shutil.unpack_archive() 都新增了 filter 参数以允许限制可能令人意外或危险的 tar 特性，例如在目标目录之外创建文件。 相关细节参见 解压缩过滤器。 在 Python 3.12 中，不带 filter 参数的用法将显示 DeprecationWarning。 在 Python 3.14 中，默认值将切换为 'data'。 （由 Petr Viktorin 在 PEP 706 [https://www.python.org/dev/peps/pep-0706] 中贡献。）

Notable changes in 3.10.15

ipaddress

修正了 IPv4Address, IPv6Address, IPv4Network 和 IPv6Network 中的 is_global 和 is_private 行为。

email

带有嵌入的换行符的标头现在输出时会加引号。

现在 generator 会拒绝序列化（写入）不正确地折叠或分隔的标头，例如将被解析为多个标头或与相邻数据合并的标头等。 如果你需要禁用此安全特性，请设置 verify_generated_headers。 （由 Bas Bloemsaat 和 Petr Viktorin 在 gh-121650 [https://github.com/python/cpython/issues/121650] 中贡献。）

email.utils.getaddresses() and email.utils.parseaddr() now return ('', '') 2-tuples in more situations where invalid email addresses are encountered, instead of potentially inaccurate values. An optional strict parameter was added to these two functions: use strict=False to get the old behavior, accepting malformed inputs. getattr(email.utils, 'supports_strict_parsing', False) can be used to check if the strict paramater is available. (Contributed by Thomas Dwyer and Victor Stinner for gh-102988 [https://github.com/python/cpython/issues/102988] to improve the CVE-2023-27043 fix.)

Notable changes in 3.10.18

os.path

The strict parameter to os.path.realpath() accepts a new value, os.path.ALLOW_MISSING. If used, errors other than FileNotFoundError will be re-raised; the resulting path can be missing but it will be free of symlinks. (Contributed by Petr Viktorin for CVE 2025-4517.)

tarfile

data_filter() now normalizes symbolic link targets in order to avoid path traversal attacks. (Contributed by Petr Viktorin in gh-127987 [https://github.com/python/cpython/issues/127987] and CVE 2025-4138.)

extractall() now skips fixing up directory attributes when a directory was removed or replaced by another kind of file. (Contributed by Petr Viktorin in gh-127987 [https://github.com/python/cpython/issues/127987] and CVE 2024-12718.)

extract() and extractall() now (re-)apply the extraction filter when substituting a link (hard or symbolic) with a copy of another archive member, and when fixing up directory attributes. The former raises a new exception, LinkFallbackError. (Contributed by Petr Viktorin for CVE 2025-4330 and CVE 2024-12718.)

extract() and extractall() no longer extract rejected members when errorlevel() is zero. (Contributed by Matt Prodani and Petr Viktorin in gh-112887 [https://github.com/python/cpython/issues/112887] and CVE 2025-4435.)

Python 3.9 有什么新变化

编者

Łukasz Langa

本文介绍了 Python 3.9 相比 3.8 的新特性。 Python 3.9 发布于 2020 年 10 月 5 日。

详情请参阅 更新日志。

参见

PEP 596 [https://www.python.org/dev/peps/pep-0596] - Python 3.9 发布计划

摘要 -- 发布重点

新的语法特性：

PEP 584 [https://www.python.org/dev/peps/pep-0584]，为 dict 增加合并运算符；

PEP 585 [https://www.python.org/dev/peps/pep-0585]，标准多项集中的类型标注泛型。

PEP 614 [https://www.python.org/dev/peps/pep-0614]，放宽对装饰器的语法限制。

新的内置特性：

PEP 616 [https://www.python.org/dev/peps/pep-0616]，移除前缀和后缀的字符串方法。

标准库中的新特性:

PEP 593 [https://www.python.org/dev/peps/pep-0593]，灵活函数和变量注解；

添加了 os.pidfd_open() 以允许不带竞争和信号的进程管理。

解释器的改进:

PEP 573 [https://www.python.org/dev/peps/pep-0573]，从 C 扩展类型的方法快速访问模块状态；

PEP 617 [https://www.python.org/dev/peps/pep-0617]，CPython 现在使用基于 PEG 的新解析器；

一些 Python 内置类型（range、tuple、set、frozenset、list、dict）现已使用 PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall 加速；

垃圾回收不会因恢复的对象而阻塞；

一些 Python 模块（_abc、audioop、_bz2、_codecs、_contextvars、_crypt、_functools、_json、_locale、math、operator、resource、time、_weakref）现已使用 PEP 489 中定义的多段初始化；

一些标准库模块 (audioop、ast、grp、_hashlib、pwd、_posixsubprocess、random、select、struct、termios、zlib) 现已使用 PEP 384 中定义的稳定 ABI。

新的库模块：

PEP 615 [https://www.python.org/dev/peps/pep-0615]，标准库的 zoneinfo 模块现已支持 IANA 时区数据库；

图的拓扑排序实现现在已由新的 graphlib 模块提供。

发布进程的变化:

PEP 602 [https://www.python.org/dev/peps/pep-0602]，CPython 采用年度发布周期。

请检查代码中的 DeprecationWarning。

Python 2.7 支持未终止时，为了实现向下兼容 Python 2.7，Python 3 保留了许多旧版功能。Python 2 的支持终止后，已经移除了一部分向下兼容层，剩余部分很快也会被移除。这几年，大部分兼容层都会触发 DeprecationWarning 警告。例如，2012 年发布 Python 3.3 后，用 collections.Mapping 替代 collections.abc.Mapping 就会触发 DeprecationWarning。

请用 -W default 命令行选项测试应用程序来查看 DeprecationWarning 和 PendingDeprecationWarning，甚至可以用 -W error 将它们视为错误。 可以用 警告过滤器 忽略来自第三方代码的警告。

Python 3.9 是最后一个提供 Python 2 向下兼容层的版本，以给予 Python 项目维护者更多时间移除 Python 2 支持，添加 Python 3.9 支持。

collections 模块中 抽象基类 的别名，例如 collections.abc.Mapping 的别名 collections.Mapping 会为向下兼容最后保留一个发行版。 这些内容将在 Python 3.10 中移除。

更通俗的说法是，请在 Python 开发模式 下运行测试，这样做有助于让代码兼容 Python 的后续版本。

注：一些前期已弃用的内容也将在此 Python 版本中移除。 详见 移除 一节。

新的特性

字典合并与更新运算符

合并 (|) 与更新 (|=) 运算符已被加入内置的 dict 类。 它们为现有的 dict.update 和 {**d1, **d2} 字典合并方法提供了补充。

示例:

>>> 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'}

详见 PEP 584 [https://www.python.org/dev/peps/pep-0584]。（Brandt Bucher 在 bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144] 中的贡献。）

新增用于移除前缀和后缀的字符串方法

增加了 str.removeprefix(prefix) 和 str.removesuffix(suffix) 用于方便地从字符串移除不需要的前缀或后缀。 也增加了 bytes, bytearray 以及 collections.UserString 的对应方法。 请参阅 PEP 616 [https://www.python.org/dev/peps/pep-0616] 了解详情。 （由 Dennis Sweeney 在 bpo-39939 [https://bugs.python.org/issue?@action=redirect&bpo=39939] 中贡献。）

标准多项集中的类型标注泛型

在类型标注中现在你可以使用内置多项集类型例如 list 和 dict 作为通用类型而不必从 typing 导入对应的大写形式类型名 (例如 List 和 Dict)。 标准库中的其他一些类型现在同样也是通用的，例如 queue.Queue。

示例:

def greet_all(names: list[str]) -> None:
    for name in names:
        print("Hello", name)

详见 PEP 585 [https://www.python.org/dev/peps/pep-0585]。（由 Guido van Rossum、Ethan Smith 和 Batuhan Taşkaya 在 bpo-39481 [https://bugs.python.org/issue?@action=redirect&bpo=39481] 中贡献。）

新的解析器

Python 3.9 使用于基于 PEG [https://en.wikipedia.org/wiki/Parsing_expression_grammar] 的新解析器替代 LL(1) [https://en.wikipedia.org/wiki/LL_parser]。 新解析器的性能与旧解析器大致相当，但 PEG 在设计新语言特性时的形式化比 LL(1) 更灵活。 我们将在 Python 3.10 及之后版本中开始使用这种灵活性。

ast 模块会使用新解析器并会生成与旧解析器一致的 AST。

在 Python 3.10 中，旧解析器将被移除，依赖于它的所有功能也将被移除（主要是 parser 模块，它早已被弃用）。 只有 在 Python 3.9 中，你可以使用命令行开关 (-X oldparser) 或环境变量 (PYTHONOLDPARSER=1) 切换回 LL(1) 解析器。

请参阅 PEP 617 [https://www.python.org/dev/peps/pep-0617] 了解详情。 （由 Guido van Rossum, Pablo Galindo 和 Lysandros Nikolaou 在 bpo-40334 [https://bugs.python.org/issue?@action=redirect&bpo=40334] 中贡献。）

其他语言特性修改

__import__() 现在会引发 ImportError 而不是 ValueError，后者曾经会在相对导入超出其最高层级包时发生。 （由 Ngalim Siregar 在 bpo-37444 [https://bugs.python.org/issue?@action=redirect&bpo=37444] 中贡献。）

Python 现在会获取命令行中指定的脚本文件名 (例如: python3 script.py) 的绝对路径: __main__ 模块的 __file__ 属性将是一个绝对路径，而不是相对路径。 现在此路径在当前目录通过 os.chdir() 被改变后仍将保持有效。 作为附带效果，回溯信息也将在此情况下为 __main__ 模块帧显示绝对路径。 （由 Victor Stinner 在 bpo-20443 [https://bugs.python.org/issue?@action=redirect&bpo=20443] 中贡献。）

在 Python 开发模式 以及 调试编译版本 中，现在会针对字符串编码和解码操作检查 encoding 和 errors 参数。 例如: open(), str.encode() 和 bytes.decode()。

默认设置下，为保证性能，errors 参数只会在第一次发生编码/解码错误时被检查，并且对于空字符串 encoding 参数有时会被忽略。 （由 Victor Stinner 在 bpo-37388 [https://bugs.python.org/issue?@action=redirect&bpo=37388] 中贡献。）

"".replace("", s, n) 对于所有非零的 n 都将返回 s 而不是空字符串。 现在此方法会与 "".replace("", s) 保持一致。 对于 bytes 和 bytearray 对象也有类似的修改。 （由 Serhiy Storchaka 在 bpo-28029 [https://bugs.python.org/issue?@action=redirect&bpo=28029] 中贡献。）

任何有效的表达式现在都可被用作 decorator。 在之前版本中，相关语法则更为严格。 请参阅 PEP 614 [https://www.python.org/dev/peps/pep-0614] 了解详情。 （由 Brandt Bucher 在 bpo-39702 [https://bugs.python.org/issue?@action=redirect&bpo=39702] 中贡献。）

改进了 typing 模块的帮助信息。 现在将为所有特殊形式和特殊通用别名 (例如 Union 和 List) 显示文档字符串。 使用 help() 时传入通用别名例如 List[int] 将显示对应实体类型 (这里对应的是 list) 的帮助信息。 （由 Serhiy Storchaka 在 bpo-40257 [https://bugs.python.org/issue?@action=redirect&bpo=40257] 中贡献。）

aclose() / asend() / athrow() 的并行运行现在已被禁止，且 ag_running 现在会反映异步生成器的实际运行状态。 （由 Yury Selivanov 在 bpo-30773 [https://bugs.python.org/issue?@action=redirect&bpo=30773] 中贡献。）

调用 __iter__ 方法时发生的非预期错误不会再被 in 运算符以及 operator 的 contains(), indexOf() 和 countOf() 中的 TypeError 所掩盖。 （由 Serhiy Storchaka 在 bpo-40824 [https://bugs.python.org/issue?@action=redirect&bpo=40824] 中贡献。）

未加圆括号的 lambda 表达式不能再作为推导式和生成器表达式的 if 子句的表达式部分。 请参阅 bpo-41848 [https://bugs.python.org/issue?@action=redirect&bpo=41848] 和 bpo-43755 [https://bugs.python.org/issue?@action=redirect&bpo=43755] 了解详情。

新增模块

zoneinfo

zoneinfo 模块为标准库引入了 IANA 时区数据库。 它添加了 zoneinfo.ZoneInfo，这是一个基于系统时区数据的实体 datetime.tzinfo 实现。

示例:

>>> from zoneinfo import ZoneInfo
>>> from datetime import datetime, timedelta

>>> # Daylight saving time
>>> dt = datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-10-31 12:00:00-07:00
>>> dt.tzname()
'PDT'

>>> # Standard time
>>> dt += timedelta(days=7)
>>> print(dt)
2020-11-07 12:00:00-08:00
>>> print(dt.tzname())
PST

作为不包含 IANA 数据库的平台的一个回退数据源，还以第一方软件包的形式发布了 tzdata [https://pypi.org/project/tzdata/] 模块 -- 通过 PyPI 发行并由 CPython 核心团队维护。

参见

PEP 615 [https://www.python.org/dev/peps/pep-0615] -- 在标准库中支持 IANA 时区数据库

PEP 由 Paul Ganssle 撰写并实现

graphlib

添加了新的 graphlib 模块，其中包含 graphlib.TopologicalSorter 类来提供图的拓扑排序功能。 （由 Pablo Galindo, Tim Peters 和 Larry Hastings 在 bpo-17005 [https://bugs.python.org/issue?@action=redirect&bpo=17005] 中贡献。）

改进的模块

ast

将 indent 选项添加到 dump()，这允许它产生多行缩进的输出。 （由 Serhiy Storchaka 在 bpo-37995 [https://bugs.python.org/issue?@action=redirect&bpo=37995] 中贡献。）

添加了 ast.unparse() 作为 ast 模块中的一个函数，它可被用来反解析 ast.AST 对象并产生相应的代码字符串，当它被解析时将会产生一个等价的 ast.AST 对象。 （由 Pablo Galindo 和 Batuhan Taskaya 在 bpo-38870 [https://bugs.python.org/issue?@action=redirect&bpo=38870] 中贡献。）

为 AST 节点添加了文档字符串，其中包含 ASDL 签名，可被用来构造对应的节点。 （由 Batuhan Taskaya 在 bpo-39638 [https://bugs.python.org/issue?@action=redirect&bpo=39638] 中贡献。）

asyncio

出于重要的安全性考量，asyncio.loop.create_datagram_endpoint() 的 reuse_address 形参不再被支持。 这是由 UDP 中的套接字选项 SO_REUSEADDR 的行为导致的。 更多细节请参阅 loop.create_datagram_endpoint() 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228 [https://bugs.python.org/issue?@action=redirect&bpo=37228] 中贡献。。）

添加了新的 coroutine shutdown_default_executor()，它可为等待 ThreadPoolExecutor 结束关闭的默认执行器安排关闭日程操作。 此外，asyncio.run() 已被更新以使用新的 coroutine。 （由 Kyle Stanley 在 bpo-34037 [https://bugs.python.org/issue?@action=redirect&bpo=34037] 中贡献。）

添加了 asyncio.PidfdChildWatcher，这是一个 Linux 专属的子监视器实现，它负责轮询进程的文件描述符。 (bpo-38692 [https://bugs.python.org/issue?@action=redirect&bpo=38692])

添加了新的 coroutine asyncio.to_thread()。 它主要被用于在单独线程中运行 IO 密集型函数以避免阻塞事件循环，实质上就相当于是 run_in_executor() 的高层级版本，可直接接受关键字参数。 （由 Kyle Stanley 和 Yury Selivanov 在 bpo-32309 [https://bugs.python.org/issue?@action=redirect&bpo=32309] 中贡献。）

当由于超时而取消任务时，asyncio.wait_for() 现在将会等待直到也在 timeout 值 <= 0 的情况下完成取消。 就像 timeout 值为正数时一样。 （由 Elvis Pranskevichus 在 bpo-32751 [https://bugs.python.org/issue?@action=redirect&bpo=32751] 中贡献。）

当附带 ssl.SSLSocket 套接字调用不兼容的方法时 asyncio 现在会引发 TyperError。 （由 Ido Michael 在 bpo-37404 [https://bugs.python.org/issue?@action=redirect&bpo=37404] 中贡献。）

compileall

为重复的 .pyc 文件添加了使用硬软件的可能性: hardlink_dupes 形参以及 --hardlink-dupes 命令行选项。 （由 Lumír 'Frenzy' Balhar 在 bpo-40495 [https://bugs.python.org/issue?@action=redirect&bpo=40495] 中贡献。）

新增了一些用于在结果 .pyc 文件中操纵路径的选项: stripdir, prependdir, limit_sl_dest 形参以及 -s, -p, -e 命令行选项。 并使得为优化等级多次指定选项成为可能。 （由 Lumír 'Frenzy' Balhar 在 bpo-38112 [https://bugs.python.org/issue?@action=redirect&bpo=38112] 中贡献。）

concurrent.futures

将新的 cancel_futures 形参添加到 concurrent.futures.Executor.shutdown()，可以取消尚未开始运行的所有挂起的 Future，而不必等待它们完成运行再关闭执行器。 （由 Kyle Stanley 在 bpo-39349 [https://bugs.python.org/issue?@action=redirect&bpo=39349] 中贡献。）

从 ThreadPoolExecutor 和 ProcessPoolExecutor 中移除了守护线程。 这改善与与子解释器的兼容性及它们在关闭进程时的可预测性。 （由 Kyle Stanley 在 bpo-39812 [https://bugs.python.org/issue?@action=redirect&bpo=39812] 中贡献。）

现在 ProcessPoolExecutor 中的工作进程仅会在没有可重用的空闲工作进程时按需产生。 这优化了启动开销并减少了由空闲工作进程导致的 CPU 时间损失。 （由 Kyle Stanley 在 bpo-39207 [https://bugs.python.org/issue?@action=redirect&bpo=39207] 中贡献。）

curses

增加了 curses.get_escdelay(), curses.set_escdelay(), curses.get_tabsize() 以及 curses.set_tabsize() 函数。（由 Anthony Sottile 在 bpo-38312 [https://bugs.python.org/issue?@action=redirect&bpo=38312] 中贡献。）

datetime

datetime.date 的 isocalendar() 以及 datetime.datetime 的 isocalendar() 等方法现在将返回 namedtuple() 而不是 tuple。 （由 Dong-hee Na 在 bpo-24416 [https://bugs.python.org/issue?@action=redirect&bpo=24416] 中贡献。）

distutils

upload 命令现在会创建 SHA2-256 和 Blake2b-256 哈希摘要。 它会在禁用 MD5 摘要的平台上跳过 MD5。 （由 Christian Heimes 在 bpo-40698 [https://bugs.python.org/issue?@action=redirect&bpo=40698] 中贡献。）

fcntl

增加了 F_OFD_GETLK, F_OFD_SETLK 和 F_OFD_SETLKW 等常量。 （由 Dong-hee Na 在 bpo-38602 [https://bugs.python.org/issue?@action=redirect&bpo=38602] 中贡献。）

ftplib

现在 FTP 和 FTP_TLS 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 ValueError。 （由 Dong-hee Na 在 bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259] 中贡献。）

gc

当垃圾回收器进行某些复活对象的收集时（在终结器被执行之后这些对象可以在隔离周期之外被访问），不会阻止对所有仍然无法访问的对象的收集。 （由 Pablo Galindo 和 Tim Peters 在 bpo-38379 [https://bugs.python.org/issue?@action=redirect&bpo=38379] 中贡献。）

增加了一个新的函数 gc.is_finalized() 用来检测一个对象是否已被垃圾回收器所终结。 （由 Pablo Galindo 在 bpo-39322 [https://bugs.python.org/issue?@action=redirect&bpo=39322] 中贡献。）

hashlib

hashlib 模块现在会在可能的情况下使用 OpenSSL 中的 SHA3 哈希和 SHAKE XOF。 （由 Christian Heimes 在 bpo-37630 [https://bugs.python.org/issue?@action=redirect&bpo=37630] 中贡献。）

内置的哈希模块现在可通过 ./configure --without-builtin-hashlib-hashes 禁用或通过 ./configure --with-builtin-hashlib-hashes=sha3,blake2 这样的形式有选择地启用以强制使用基于 OpenSSL 的实现。 （由 Christian Heimes 在 bpo-40479 [https://bugs.python.org/issue?@action=redirect&bpo=40479] 中贡献）

http

添加 HTTP 状态码 103 EARLY_HINTS, 418 IM_A_TEAPOT 和 425 TOO_EARLY 到 http.HTTPStatus。 （由 Dong-hee Na 在 bpo-39509 [https://bugs.python.org/issue?@action=redirect&bpo=39509] 以及 Ross Rhodes 在 bpo-39507 [https://bugs.python.org/issue?@action=redirect&bpo=39507] 中贡献。）

IDLE 与 idlelib

添加了切换光标闪烁停止的选项。 （由 Zackery Spytz 在 bpo-4603 [https://bugs.python.org/issue?@action=redirect&bpo=4603] 中贡献。）

Esc 键现在会关闭 IDLE 补全提示窗口。 （由 Johnny Najera 在 bpo-38944 [https://bugs.python.org/issue?@action=redirect&bpo=38944] 中贡献。）

添加关键字到模块名称补全列表。 （由 Terry J. Reedy 在 bpo-37765 [https://bugs.python.org/issue?@action=redirect&bpo=37765] 中贡献。）

3.9 维护版本中的新内容

使 IDLE 调用 sys.excepthook() （当启动时没有 '-n' ）。用户钩子以前是被忽略的。 (由 Ken Hilton 在 bpo-43008 [https://bugs.python.org/issue?@action=redirect&bpo=43008] 中贡献。)

上述修改已被反向移植到 3.8 维护发行版中。

重新安排设置对话框。 将常规选项卡分成 Windows 和 Shell/Ed 选项卡。 将扩展帮助菜单的帮助源移至扩展标签。为新选项留出空间，并缩短对话框。后者使对话框更适合小屏幕。 (由 Terry Jan Reedy 贡献于 bpo-40468 [https://bugs.python.org/issue?@action=redirect&bpo=40468] 。) 将缩进空间设置从字体标签移到新的 Windows 标签。 (由 Mark Roseman 和 Terry Jan Reedy 在 bpo-33962 [https://bugs.python.org/issue?@action=redirect&bpo=33962] 中提供)。

对 .pyi 文件应用语法高亮。 （由 Alex Waygood 和 Terry Jan Reedy 在 bpo-45447 [https://bugs.python.org/issue?@action=redirect&bpo=45447] 中贡献。）

imaplib

现在 IMAP4 和 IMAP4_SSL 的构造器具有可选的 timeout 形参。 并且，现在 open() 方法也具有可选的 timeout 形参提供同样的修改。 IMAP4_SSL 和 IMAP4_stream 中被重载的方法也应用了这个修改。 （由 Dong-hee Na 在 bpo-38615 [https://bugs.python.org/issue?@action=redirect&bpo=38615] 中贡献。）

增加了 imaplib.IMAP4.unselect()。 imaplib.IMAP4.unselect() 会释放关联到选定邮箱的服务器资源并将服务器返回到已认证状态。 此命令会执行与 imaplib.IMAP4.close() 相同的动作，区别在于它不会从当前选定邮箱中永久性地移除消息。 （由 Dong-hee Na 在 bpo-40375 [https://bugs.python.org/issue?@action=redirect&bpo=40375] 中贡献。）

importlib

为提升与 import 语句的一致性，现在 importlib.util.resolve_name() 对于无效的相对导入尝试会引发 ImportError 而不是 ValueError。 （由 Ngalim Siregar 在 bpo-37444 [https://bugs.python.org/issue?@action=redirect&bpo=37444] 中贡献。）

发布不可变模块对象的导入加载器除了发布单独模块以外现在也可以发布不可变包。 （由 Dino Viehland 在 bpo-39336 [https://bugs.python.org/issue?@action=redirect&bpo=39336] 中贡献。）

添加了带有对包数据中子目录支持的 importlib.resources.files() 函数，与 importlib_resources 1.5 版的反向端口相匹配。（由 Jason R. Coombs 在 bpo-39791 [https://bugs.python.org/issue?@action=redirect&bpo=39791] 中贡献。）

来自 importlib_metadata 1.6.1 版的已更新 importlib.metadata。

inspect

inspect.BoundArguments.arguments 已从 OrderedDict 改为常规字典。 （由 Inada Naoki 在 bpo-36350 [https://bugs.python.org/issue?@action=redirect&bpo=36350] 和 bpo-39775 [https://bugs.python.org/issue?@action=redirect&bpo=39775] 中贡献。）

ipaddress

ipaddress 现在支持 IPv6 作用域地址（即带有 %<scope_id> 前缀的 IPv6 地址）。

IPv6 作用域地址可使用 ipaddress.IPv6Address 来解析。 作用域的区 ID 如果存在，可通过 scope_id 属性来获取。 （由 Oleksandr Pavliuk 在 bpo-34788 [https://bugs.python.org/issue?@action=redirect&bpo=34788] 中贡献。）

从 Python 3.9.5 开始 ipaddress 模块不再接受 IPv4 地址字符串中有任何前缀的零。 （由 Christian Heimes 在 bpo-36384 [https://bugs.python.org/issue?@action=redirect&bpo=36384] 中贡献。）

math

对 math.gcd() 函数进行了扩展以处理多个参数。 在之前版本中，它只支持两个参数。 （由 Serhiy Storchaka 在 bpo-39648 [https://bugs.python.org/issue?@action=redirect&bpo=39648] 中贡献。）

增加了 math.lcm(): 返回指定参数的最小公倍数。 （由 Mark Dickinson, Ananthakrishnan 和 Serhiy Storchaka 在 bpo-39479 [https://bugs.python.org/issue?@action=redirect&bpo=39479] 和 bpo-39648 [https://bugs.python.org/issue?@action=redirect&bpo=39648] 中贡献。）

增加了 math.nextafter(): 返回从 x 往 y 方向的下一个浮点数值。 （由 Victor Stinner 在 bpo-39288 [https://bugs.python.org/issue?@action=redirect&bpo=39288] 中贡献。）

增加了 math.ulp(): 返回一个浮点数的最小有效比特位。 （由 Victor Stinner 在 bpo-39310 [https://bugs.python.org/issue?@action=redirect&bpo=39310] 中贡献。）

multiprocessing

multiprocessing.SimpleQueue 类新增了 close() 方法用来显式地关闭队列。 （由 Victor Stinner 在 bpo-30966 [https://bugs.python.org/issue?@action=redirect&bpo=30966] 中贡献。）

nntplib

现在 NNTP 和 NNTP_SSL 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 ValueError。 （由 Dong-hee Na 在 bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259] 中贡献。）

os

增加了 CLD_KILLED 和 CLD_STOPPED 作为 si_code。 （由 Dong-hee Na 在 bpo-38493 [https://bugs.python.org/issue?@action=redirect&bpo=38493] 中贡献。）

对外公开了 Linux 专属的 os.pidfd_open() (bpo-38692 [https://bugs.python.org/issue?@action=redirect&bpo=38692]) 和 os.P_PIDFD (bpo-38713 [https://bugs.python.org/issue?@action=redirect&bpo=38713]) 用于文件描述符的进程管理。

现在 os.unsetenv() 函数在 Windows 上也已可用。 （由 Victor Stinner 在 bpo-39413 [https://bugs.python.org/issue?@action=redirect&bpo=39413] 中贡献。）

现在 os.putenv() 和 os.unsetenv() 函数将总是可用。 （由 Victor Stinner 在 bpo-39395 [https://bugs.python.org/issue?@action=redirect&bpo=39395] 中贡献。）

增加了 os.waitstatus_to_exitcode() 函数：将等待状态转换为退出码。 （由 Victor Stinner 在 bpo-40094 [https://bugs.python.org/issue?@action=redirect&bpo=40094] 中贡献。）

pathlib

增加了 pathlib.Path.readlink()，其行为类似于 os.readlink()。 （由 Girts Folkmanis 在 bpo-30618 [https://bugs.python.org/issue?@action=redirect&bpo=30618] 中贡献。）

pdb

在 Windows 上 Pdb 现在支持 ~/.pdbrc。 （由 Tim Hopper 和 Dan Lidral-Porter 在 bpo-20523 [https://bugs.python.org/issue?@action=redirect&bpo=20523] 中贡献。）

poplib

现在 POP3 和 POP3_SSL 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 ValueError。 （由 Dong-hee Na 在 bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259] 中贡献。）

pprint

现在 pprint 能美化打印 types.SimpleNamespace。 （由 Carl Bordum Hansen 在 bpo-37376 [https://bugs.python.org/issue?@action=redirect&bpo=37376] 中贡献。）

pydoc

文档字符串的显示现在不仅针对类、函数、方法等，也针对任何具有自己的 __doc__ 属性的对象。 （由 Serhiy Storchaka 在 bpo-40257 [https://bugs.python.org/issue?@action=redirect&bpo=40257] 中贡献。）

random

增加了新的 random.Random.randbytes 方法：生成随机字节串。 （由 Victor Stinner 在 bpo-40286 [https://bugs.python.org/issue?@action=redirect&bpo=40286] 中贡献。）

signal

对外公开了 Linux 专属的 signal.pidfd_send_signal() 用于向使用文件描述符而非 pid 的进程发送信号。 (bpo-38712 [https://bugs.python.org/issue?@action=redirect&bpo=38712])

smtplib

现在 SMTP 和 SMTP_SSL 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 ValueError。 （由 Dong-hee Na 在 bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259] 中贡献。）

现在 LMTP 构造器具有可选的 timeout 形参。 （由 Dong-hee Na 在 bpo-39329 [https://bugs.python.org/issue?@action=redirect&bpo=39329] 中贡献。）

socket

socket 模块现在会在 Linux 4.1 或更高版本上导出 CAN_RAW_JOIN_FILTERS 常量。 （由 Stefan Tatschner 和 Zackery Spytz 在 bpo-25780 [https://bugs.python.org/issue?@action=redirect&bpo=25780] 中贡献。）

现在 socket 模块会在支持的平台上支持 CAN_J1939 协议。 （由 Karl Ding 在 bpo-40291 [https://bugs.python.org/issue?@action=redirect&bpo=40291] 上贡献。）

现在 socket 模块具有 socket.send_fds() 和 socket.recv_fds() 函数。 （由 Joannah Nanjekye, Shinya Okano 和 Victor Stinner 在 bpo-28724 [https://bugs.python.org/issue?@action=redirect&bpo=28724] 中贡献。）

time

在 AIX 上，现在 thread_time() 是使用具有纳秒级精度的 thread_cputime() 实现，而不再是只有 10 毫秒精度的 clock_gettime(CLOCK_THREAD_CPUTIME_ID)。 （由 Batuhan Taskaya 在 bpo-40192 [https://bugs.python.org/issue?@action=redirect&bpo=40192] 中贡献。）

sys

增加了新的 sys.platlibdir 属性：平台专属库目录的名称。 它被用于构建标准库的路径以及已安装扩展模块的路径。 它在大多数平台上等于 "lib"。 在 Fedora 和 SuSE 上，它等于 64 位平台上的 "lib64"。 （由 Jan Matějek, Matěj Cepl, Charalampos Stratakis 和 Victor Stinner 在 bpo-1294959 [https://bugs.python.org/issue?@action=redirect&bpo=1294959] 中贡献。）

之前的版本中，sys.stderr 在非交互模式时是带块缓冲的。 现在 stderr 默认总是为行缓冲的。 （由 Jendrik Seipp 在 bpo-13601 [https://bugs.python.org/issue?@action=redirect&bpo=13601] 中贡献。）

tracemalloc

增加了 tracemalloc.reset_peak() 用于将跟踪的内存块峰值大小设为当前大小，以测量特定代码段的峰值。 （由 Huon Wilson 在 bpo-40630 [https://bugs.python.org/issue?@action=redirect&bpo=40630] 中贡献。）

typing

PEP 593 [https://www.python.org/dev/peps/pep-0593] 引入了一种 typing.Annotated 类型以使用上下文专属的元数据来装饰现有类型，并将新的 include_extras 形参添加到 typing.get_type_hints() 以在运行时访问元数据。 （由 Till Varoquaux 和 Konstantin Kashin 贡献。）

unicodedata

Unicode 数据库已更新到 13.0.0 版。 (bpo-39926 [https://bugs.python.org/issue?@action=redirect&bpo=39926])。

venv

由 venv 所提供的激活脚本现在总是会使用 __VENV_PROMPT__ 设置的值来一致地指明它们的自定义提示符。 在之前版本中某些脚本会无条件地使用 __VENV_PROMPT__，而另一些脚本只在其恰好被设置时（这是默认情况）才会使用，还有的脚本会改用 __VENV_NAME__。 （由 Brett Cannon 在 bpo-37663 [https://bugs.python.org/issue?@action=redirect&bpo=37663] 中贡献。）

xml

当把 xml.etree.ElementTree 序列化为 XML 文件时属性内部的空白字符现在将被保留。 不同的行结束符不会再被正规化为 "n"。 这是对于如何解读 XML 规范 2.11 节的相关讨论的最终结果。 （由 Mefistotelis 在 bpo-39011 [https://bugs.python.org/issue?@action=redirect&bpo=39011] 中贡献。）

性能优化

优化了在推导式中为临时变量赋值的惯用方式。 现在推导式中的 for y in [expr] 会与简单赋值语句 y = expr 一样快速。 例如:

sums = [s for s in [0] for x in data for s in [s + x]]

不同于 := 运算符，这个惯用方式不会使变量泄露到外部作用域中。

（由 Serhiy Storchaka 在 bpo-32856 [https://bugs.python.org/issue?@action=redirect&bpo=32856] 中贡献。）

优化了多线程应用中的信号处理。 如果一个线程不是获得信号的主线程，字节码求值循环不会在每条字节码指令上被打断以检查无法被处理的挂起信号。 只有主解释器的主线程能够处理信号。

在之前版本中，字节码求值循环会在每条指令上被打断直到主线程处理了信号。 （由 Victor Stinner 在 bpo-40010 [https://bugs.python.org/issue?@action=redirect&bpo=40010] 上贡献。）

在 FreeBSD 上使用 closefrom() 优化了 subprocess 模块。 （由 Ed Maste, Conrad Meyer, Kyle Evans, Kubilay Kocak 和 Victor Stinner 在 bpo-38061 [https://bugs.python.org/issue?@action=redirect&bpo=38061] 中贡献。）

现在 PyLong_FromDouble() 对于 long 范围内值的执行速度提升至 1.87 倍。 （由 Sergey Fedoseev 在 bpo-37986 [https://bugs.python.org/issue?@action=redirect&bpo=37986] 中贡献。）

多个 Python 内置类型 (range, tuple, set, frozenset, list, dict) 现在通过使用 PEP 590 [https://www.python.org/dev/peps/pep-0590] 向量调用协议得到加速。 （由 Dong-hee Na, Mark Shannon, Jeroen Demeyer 和 Petr Viktorin 在 bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207] 中贡献。）

当另一集合远大于基础集合的情况下优化了 difference_update() 的性能。 （由 Evgeny Kapun 提议，由 Michele Orrù 在 bpo-8425 [https://bugs.python.org/issue?@action=redirect&bpo=8425] 中贡献代码。）

Python 的小对象分配器 (obmalloc.c) 现在允许（至多）一个空位可用于立即重用，而不必将其返回给 OS。 这可以防止简单循环中的多余消耗，在每次迭代中可以创建和销毁全新的空位。 （由 Tim Peters 在 bpo-37257 [https://bugs.python.org/issue?@action=redirect&bpo=37257] 中贡献。）

浮点数运算中的 floor division 现在会有更好的性能。 并且此运算的 ZeroDivisionError 的消息也已更新。 （由 Dong-hee Na 在 bpo-39434 [https://bugs.python.org/issue?@action=redirect&bpo=39434] 中贡献。）

使用 UTF-8 和 ascii 编解码器解码短 ASCII 字符串现在会加快大约 15%。 （由 Inada Naoki 在 bpo-37348 [https://bugs.python.org/issue?@action=redirect&bpo=37348] 中贡献。）

以下是对从 Python 3.4 到 Python 3.9 的提升提升情况的总结:

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

以上结果是由以下变量访问基准测试脚本所生成的: Tools/scripts/var_access_benchmark.py。 该基准测试脚本以纳秒为单位显示时间。 基准测试数据是在一块 Intel® Core™ i7-4960HQ 处理器 [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 [https://www.python.org/downloads/mac-osx/] 获取的 macOS 64 位编译版本所得到的。

弃用

distutils 的 bdist_msi 命令现在已被弃用，请改用 bdist_wheel (wheel 包)。 （由 Hugo van Kemenade 在 bpo-39586 [https://bugs.python.org/issue?@action=redirect&bpo=39586] 中贡献。）

目前 math.factorial() 接受具有非负整数值的 float 实例 (如 5.0)。 对于非整数和负浮点数它会引发 ValueError。 此行为现在已被弃用。 在未来的 Python 版本中对所有浮点数都将引发 TypeError。 （由 Serhiy Storchaka 在 bpo-37315 [https://bugs.python.org/issue?@action=redirect&bpo=37315] 中贡献。）

parser 和 symbol 模块已被弃用并将在未来的 Python 版本中移除。 对于大多数用例，用户都可以使用 ast 模块来控制抽象语法树 (AST) 的生成和编译阶段。

公有 C API 函数 PyParser_SimpleParseStringFlags(), PyParser_SimpleParseStringFlagsFilename(), PyParser_SimpleParseFileFlags() 和 PyNode_Compile() 已被弃用并将在 Python 3.10 版与旧解析器一起被移除。

在布尔运算中使用 NotImplemented 已被弃用，因为它几乎必定是不正确的富比较运算符实现的结果。 它将在未来的 Python 版本中引发 TypeError。 （由 Josh Rosenberg 在 bpo-35712 [https://bugs.python.org/issue?@action=redirect&bpo=35712] 中贡献。）

random 模块目前接受任何可哈希类型作为可能的种子值。 不幸的是，某些这样的类型并不保证具有确定性的哈希值。 在 Python 3.9 之后，该模块将限定其种子值为 None, int, float, str, bytes 以及 bytearray。

打开 GzipFile 文件用于写入而不指定 mode 参数的特性已被弃用。 在未来的 Python 版本中将总是默认打开用于读取。 在打开文件用于写入时请指定 mode 参数以静默相关警告信息。 （由 Serhiy Storchaka 在 bpo-28286 [https://bugs.python.org/issue?@action=redirect&bpo=28286] 中贡献。）

弃用了 _tkinter.TkappType 的 split() 方法而改用 splitlist() 方法，此方法具有更稳定且可预测的行为。 （由 Serhiy Storchaka 在 bpo-38371 [https://bugs.python.org/issue?@action=redirect&bpo=38371] 中贡献。）

将协程对象显式传递给 asyncio.wait() 的做法已被弃用并且将在 3.11 版中被移除。 （由 Yury Selivanov 和 Kyle Stanley 在 bpo-34790 [https://bugs.python.org/issue?@action=redirect&bpo=34790] 中贡献。）

binhex4 和 hexbin4 标准现已被弃用。 binhex 模块和下列 binascii 函数现已被弃用:

b2a_hqx(), a2b_hqx()

rlecode_hqx(), rledecode_hqx()

（由 Victor Stinner 在 bpo-39353 [https://bugs.python.org/issue?@action=redirect&bpo=39353] 中贡献。）

ast 类 slice, Index 和 ExtSlice 被视为已弃用并将在未来的 Python 版本中被移除。 应当使用 value 本身而不再是 Index(value)。 应当使用 Tuple(slices, Load()) 而不再是 ExtSlice(slices)。 （由 Serhiy Storchaka 在 bpo-34822 [https://bugs.python.org/issue?@action=redirect&bpo=34822] 中贡献。）

ast 类 Suite, Param, AugLoad 和 AugStore 被视为已弃用并将在未来的 Python 版本中被移除。 它们不会被解析器所生成且不会被 Python 3 中的代码生成器所接受。 （由 Batuhan Taskaya 在 bpo-39639 [https://bugs.python.org/issue?@action=redirect&bpo=39639] 和 bpo-39969 [https://bugs.python.org/issue?@action=redirect&bpo=39969] 中以及 Serhiy Storchaka 在 bpo-39988 [https://bugs.python.org/issue?@action=redirect&bpo=39988] 中贡献。）

PyEval_InitThreads() 和 PyEval_ThreadsInitialized() 函数现已被弃用并将在 Python 3.11 中被移除。 调用 PyEval_InitThreads() 现在没有任何效果。 自 Python 3.7 起 GIL 会由 Py_Initialize() 初始化。 （由 Victor Stinner 在 bpo-39877 [https://bugs.python.org/issue?@action=redirect&bpo=39877] 中贡献。）

传入 None 作为 shlex.split() 函数的第一个参数的做法已被弃用。 （由 Zackery Spytz 在 bpo-33262 [https://bugs.python.org/issue?@action=redirect&bpo=33262] 中贡献。）

smtpd.MailmanProxy() 现在已被弃用，因为它在没有外部模块 mailman 的情况下无法使用。 （由 Samuel Colvin 在 bpo-35800 [https://bugs.python.org/issue?@action=redirect&bpo=35800] 中贡献。）

现在 lib2to3 模块将发出 PendingDeprecationWarning。 Python 3.9 已切换到 PEG 解析器 (参见 PEP 617 [https://www.python.org/dev/peps/pep-0617])，Python 3.10 可以会包含 lib2to3 的 LL(1) 解析器所不能解析的新语法。 lib2to3 模块可能会在未来的 Python 版本中被移出标准库。 请考虑使用第三方替换例如 LibCST [https://libcst.readthedocs.io/] 或 parso [https://parso.readthedocs.io/]。 （由 Carl Meyer 在 bpo-40360 [https://bugs.python.org/issue?@action=redirect&bpo=40360] 中贡献。）

random.shuffle() 的 random 形参已被弃用。 （由 Raymond Hettinger 在 bpo-40465 [https://bugs.python.org/issue?@action=redirect&bpo=40465] 中贡献。）

移除

unittest.mock.__version__ 上的错误版本已经被移除。

nntplib.NNTP: xpath() 和 xgtitle() 方法已被移除。 这些方法自 Python 3.3 起已被弃用。 一般来说，这些扩展都不再为 NNTP 服务管理员所支持或启用。 对于 xgtitle()，请改用 nntplib.NNTP.descriptions() 或 nntplib.NNTP.description()。 （由 Dong-hee Na 在 bpo-39366 [https://bugs.python.org/issue?@action=redirect&bpo=39366] 中贡献。）

array.array: tostring() 和 fromstring() 方法已被移除。 它们分别是 tobytes() 和 frombytes() 的别名，自 Python 3.2 起已被弃用。 （由 Victor Stinner 在 bpo-38916 [https://bugs.python.org/issue?@action=redirect&bpo=38916] 中贡献。）

未写入文档的 sys.callstats() 函数已被移除。 自 Python 3.7 起它就已被弃用并且总是会返回 None。 它需要一个特殊的构建选项 CALL_PROFILE 而该选项在 Python 3.7 中已被移除。 （由 Victor Stinner 在 bpo-37414 [https://bugs.python.org/issue?@action=redirect&bpo=37414] 中贡献。）

sys.getcheckinterval() 和 sys.setcheckinterval() 函数已被移除。 它们自 Python 3.2 起已被弃用。 请改用 sys.getswitchinterval() 和 sys.setswitchinterval()。 （由 Victor Stinner 在 bpo-37392 [https://bugs.python.org/issue?@action=redirect&bpo=37392] 中贡献。）

C 函数 PyImport_Cleanup() 已被移除。 它原本的文档为: "清空模块表。 仅限内部使用。" （由 Victor Stinner 在 bpo-36710 [https://bugs.python.org/issue?@action=redirect&bpo=36710] 中贡献。）

_dummy_thread 和 dummy_threading 模块已被移除。 这些模块自 Python 3.7 起已被弃用，它们需要线程支持。 （由 Victor Stinner 在 bpo-37312 [https://bugs.python.org/issue?@action=redirect&bpo=37312] 中贡献。）

aifc.open() 的别名 aifc.openfp()，sunau.open() 的别名 sunau.openfp()，以及 wave.open() 的别名 wave.openfp() 已被移除。 它们自 Python 3.7 起已被弃用。 （由 Victor Stinner 在 bpo-37320 [https://bugs.python.org/issue?@action=redirect&bpo=37320] 中贡献。）

threading.Thread 的 isAlive() 方法已被移除。 它自 Python 3.8 起已被弃用。 请改用 is_alive()。 （由 Dong-hee Na 在 bpo-37804 [https://bugs.python.org/issue?@action=redirect&bpo=37804] 中贡献。）

ElementTree 模块中 ElementTree 和 Element 等类的 getchildren() 和 getiterator() 方法已被移除。 它们在 Python 3.2 中已被弃用。 请使用 iter(x) 或 list(x) 替代 x.getchildren() 并用 x.iter() 或 list(x.iter()) 替代 x.getiterator()。 （由 Serhiy Storchaka 在 bpo-36543 [https://bugs.python.org/issue?@action=redirect&bpo=36543] 中贡献。）

旧的 plistlib API 已被移除，它自 Python 3.4 起已被弃用。 请使用 load(), loads(), dump() 和 dumps() 等函数。 此外，use_builtin_types 形参已被移除而总是会使用 bytes 对象。 （由 Jon Janzen 在 bpo-36409 [https://bugs.python.org/issue?@action=redirect&bpo=36409] 中贡献。）

C 函数 PyGen_NeedsFinalizing 已被移除。 它未被写入文档、未经测试，且自 PEP 442 [https://www.python.org/dev/peps/pep-0442] 实现之后未在 CPython 的任何地方被使用。 由 Joannah Nanjekye 提供补丁。 （由 Joannah Nanjekye 在 bpo-15088 [https://bugs.python.org/issue?@action=redirect&bpo=15088] 中贡献。）

自 Python 3.1 起被弃用的别名 base64.encodestring() 和 base64.decodestring() 已被移除：请改用 base64.encodebytes() 和 base64.decodebytes()。 （由 Victor Stinner 在 bpo-39351 [https://bugs.python.org/issue?@action=redirect&bpo=39351] 中贡献。）

fractions.gcd() 函数已被移除，它自 Python 3.5 起被弃用 (bpo-22486 [https://bugs.python.org/issue?@action=redirect&bpo=22486])：请改用 math.gcd()。 （由 Victor Stinner 在 bpo-39350 [https://bugs.python.org/issue?@action=redirect&bpo=39350] 中贡献。）

bz2.BZ2File 的 buffering 形参已被移除。 它自 Python 3.0 起即被忽略，使用它将会引发 DeprecationWarning。 请传入一个打开文件对象来控制文件的打开方式。 （由 Victor Stinner 在 bpo-39357 [https://bugs.python.org/issue?@action=redirect&bpo=39357] 中贡献。）

json.loads() 的 encoding 形参已被移除。 它在 Python 3.1 中已被弃用和忽略；自 Python 3.8 起使用它将会引发 DeprecationWarning。 （由 Inada Naoki 在 bpo-39377 [https://bugs.python.org/issue?@action=redirect&bpo=39377] 中贡献。）

with (await asyncio.lock): 和 with (yield from asyncio.lock): 语句已不再受支持，请改用 async with lock。 asyncio.Condition 和 asyncio.Semaphore 也同样如此。 （由 Andrew Svetlov 在 bpo-34793 [https://bugs.python.org/issue?@action=redirect&bpo=34793] 中贡献。）

sys.getcounts() 函数，-X showalloccount 命令行选项以及 C 结构体 PyConfig 的 show_alloc_count 字段已被移除。 它们需要使用定义了 COUNT_ALLOCS 宏的特殊 Python 编译版本。 （由 Victor Stinner 在 bpo-39489 [https://bugs.python.org/issue?@action=redirect&bpo=39489] 中贡献。）

typing.NamedTuple 类的 _field_types 属性已被移除。 它自 Python 3.8 起已被弃用。 请改用 __annotations__ 属性。 （由 Serhiy Storchaka 在 bpo-40182 [https://bugs.python.org/issue?@action=redirect&bpo=40182] 中贡献。）

symtable.SymbolTable.has_exec() 方法已被移除。 它自 2006 年起已被弃用，当被调用时仅会返回 False。 （由 Batuhan Taskaya 在 bpo-40208 [https://bugs.python.org/issue?@action=redirect&bpo=40208] 中贡献。）

asyncio.Task.current_task() 和 asyncio.Task.all_tasks() 已被移除。 它们自 Python 3.7 起已被弃用，你可以改用 asyncio.current_task() 和 asyncio.all_tasks()。 （由 Rémi Lapeyre 在 bpo-40967 [https://bugs.python.org/issue?@action=redirect&bpo=40967] 中贡献。）

html.parser.HTMLParser 类的 unescape() 方法已被移除（它自 Python 3.4 起已被弃用）。 应当使用 html.unescape() 来将字符引用转换为对应的 unicode 字符。

移植到 Python 3.9

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

Python API 的变化

__import__() 和 importlib.util.resolve_name() 现在会引发 ImportError 取代之前所引发的 ValueError。 捕获特定异常类型并同时支持 Python 3.9 和更早版本的调用者将需要使用 except (ImportError, ValueError): 来同时捕获两者。

venv 激活脚本不再将 __VENV_PROMPT__ 被设为 "" 的情况作为特例处理。

select.epoll.unregister() 方法不会再忽略 EBADF 错误。 （由 Victor Stinner 在 bpo-39239 [https://bugs.python.org/issue?@action=redirect&bpo=39239] 中贡献。）

bz2.BZ2File 的 compresslevel 形参已成为仅限关键字形参，因为 buffering 形参已被移除。 （由 Victor Stinner 在 bpo-39357 [https://bugs.python.org/issue?@action=redirect&bpo=39357] 中贡献。）

简化了 AST 的抽取操作。 简单索引将以它们的值来代表，扩展切片将以元组形式来代表。 Index(value) 将返回 value 本身，ExtSlice(slices) 将返回 Tuple(slices, Load())。 （由 Serhiy Storchaka 在 bpo-34822 [https://bugs.python.org/issue?@action=redirect&bpo=34822] 中贡献。）

当使用了 -E 或 -I 命令行参数时 importlib 模块现在会忽略 PYTHONCASEOK 环境变量。

encoding 形参已作为仅限关键字形参被添加到 ftplib.FTP 和 ftplib.FTP_TLS 类，并且默认编码格式由 Latin-1 改为 UTF-8 以遵循 RFC 2640 [https://datatracker.ietf.org/doc/html/rfc2640.html]。

asyncio.loop.shutdown_default_executor() 已被添加到 AbstractEventLoop，这意味着继承自它的替代事件循环应当定义此方法。 （由 Kyle Stanley 在 bpo-34037 [https://bugs.python.org/issue?@action=redirect&bpo=34037] 中贡献。）

更新了 __future__ 模块中未来特性旗标的常量值以防止与编译器旗标相冲突。 在之前版本中 PyCF_ALLOW_TOP_LEVEL_AWAIT 会与 CO_FUTURE_DIVISION 发生冲突。 （由 Batuhan Taskaya 在 bpo-39562 [https://bugs.python.org/issue?@action=redirect&bpo=39562] 中贡献。）

array('u') 现在使用 wchar_t 作为 C 类型而不是 Py_UNICODE。 这个改变不会影响其行为，因为自 Python 3.3 起 Py_UNICODE 是 wchar_t 的别名。 （由 Inada Naoki 在 bpo-34538 [https://bugs.python.org/issue?@action=redirect&bpo=34538] 中贡献。）

现在 logging.getLogger() API 当传入名称 'root' 时将返回根日志记录器，而在之前它则返回一个名为 'root' 的非根日志记录器。 这可能会影响到用户代码明确希望使用一个名为 'root' 的非根日志记录器，或在某个名为 'root.py' 的最高层级模块中使用 logging.getLogger(__name__) 来实例化日志记录器的情况。 （由 Vinay Sajip 在 bpo-37742 [https://bugs.python.org/issue?@action=redirect&bpo=37742] 中贡献。）

现在 PurePath 的拆分处理当传入 str 或 PurePath 的实例以外的对象时会返回 NotImplemented 而不是引发 TypeError。 这将允许创建不继承自上述类型的兼容类。 （由 Roger Aiudi 在 bpo-34775 [https://bugs.python.org/issue?@action=redirect&bpo=34775] 中贡献。）

从 Python 3.9.5 开始 ipaddress 模块不再接受 IPv4 地址字符串中有任何前缀的零。 前缀的零有歧义且会被某些库解读为八进制数字。 例如旧版函数 socket.inet_aton() 就瘵前缀的零视为八进制数字。 最新 inet_pton() 的 glibc 实现则不接受任何前缀的零。 （由 Christian Heimes 在 bpo-36384 [https://bugs.python.org/issue?@action=redirect&bpo=36384] 中贡献）。

codecs.lookup() 现在会以与 encodings.normalize_encoding() 相同的方式正规化编码格式名称，不同之处在于 codecs.lookup() 还会将名称转换为小写形式。 例如 "latex+latin1" 编写格式名称现在会被正规化为 "latex_latin1"。 （由 Jordon Xu 在 bpo-37751 [https://bugs.python.org/issue?@action=redirect&bpo=37751] 中贡献。）

C API 的变化

Instances of 堆分配类型 的实例（例如使用 PyType_FromSpec() 和类似 API 创建的实例）自 Python 3.8 起会带有一个对其类型对象的引用。 正如 Python 3.8 的 "C API 的变化" 部分所述，对于大多数情况来说，这应当不会有任何副作用，但对于具有自定义 tp_traverse 函数的类型来说，则要确保所有堆分配类型的自定义 tp_traverse 函数可访问对象的类型。

示例:

int
foo_traverse(foo_struct *self, visitproc visit, void *arg) {
// Rest of the traverse function
#if PY_VERSION_HEX >= 0x03090000
    // This was not needed before Python 3.9 (Python issue 35810 and 40217)
    Py_VISIT(Py_TYPE(self));
#endif
}

如果你的遍历函数委托给了其基类（或其他类）的 tp_traverse，则要确保 Py_TYPE(self) 只被访问一次。 请注意应当只有 堆类型 可访问 tp_traverse 中的类型。

举例来说，如果你的 tp_traverse 函数包括以下内容:

base->tp_traverse(self, visit, arg)

则要添加:

#if PY_VERSION_HEX >= 0x03090000
    // This was not needed before Python 3.9 (bpo-35810 and bpo-40217)
    if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) {
        // a heap type's tp_traverse already visited Py_TYPE(self)
    } else {
        Py_VISIT(Py_TYPE(self));
    }
#else

（参阅 bpo-35810 [https://bugs.python.org/issue?@action=redirect&bpo=35810] 和 bpo-40217 [https://bugs.python.org/issue?@action=redirect&bpo=40217] 了解更多信息。）

PyEval_CallObject, PyEval_CallFunction, PyEval_CallMethod 和 PyEval_CallObjectWithKeywords 函数已被弃用。 请改用 PyObject_Call() 及其变化形式。 （详情参见 bpo-29548 [https://bugs.python.org/issue?@action=redirect&bpo=29548]。）

CPython 字节码的改变

添加了 LOAD_ASSERTION_ERROR 操作码用于处理 assert 语句。 在之前的版本中，如果 AssertionError 异常被屏蔽则 assert 语句将不能正常运作。 （由 Zackery Spytz 在 bpo-34880 [https://bugs.python.org/issue?@action=redirect&bpo=34880] 中贡献。）

COMPARE_OP 操作码已被拆分为四个单独指令:

COMPARE_OP 用于富比较

IS_OP 用于 'is' 和 'is not' 检测

CONTAINS_OP 用于 'in' 和 'not in' 检测

JUMP_IF_NOT_EXC_MATCH 用于检查 'try-except' 语句中的异常。

（由 Mark Shannon 在 bpo-39156 [https://bugs.python.org/issue?@action=redirect&bpo=39156] 中贡献。）

构建的改变

将 --with-platlibdir 选项添加到 configure 脚本：平台专属库目录的名称，保存在新的 sys.platlibdir 属性中。 请参阅 sys.platlibdir 属性了解详情。 （由 Jan Matějek, Matěj Cepl, Charalampos Stratakis 和 Victor Stinner 在 bpo-1294959 [https://bugs.python.org/issue?@action=redirect&bpo=1294959] 中贡献。）

COUNT_ALLOCS 特殊构建宏已被移除。 （由 Victor Stinner 在 bpo-39489 [https://bugs.python.org/issue?@action=redirect&bpo=39489] 中贡献。）

在非 Windows 平台上，现在需要用 setenv() 和 unsetenv() 函数来构建 Python。 （由 Victor Stinner 在 bpo-39395 [https://bugs.python.org/issue?@action=redirect&bpo=39395] 中贡献。）

在非 Windows 平台上，创建 bdist_wininst 安装器现在已不受官方支持。 （详情参见 bpo-10945 [https://bugs.python.org/issue?@action=redirect&bpo=10945]。）

当在 macOS 上用源代码编译 Python 时，_tkinter 现在会链接到非系统的 Tcl 和 Tk 框架，如果它们被安装到 /Library/Frameworks 的话，就如在较旧的 macOS 发行版上的情况一样。 如果通过使用 --enable-universalsdk 或 -isysroot 显式地配置了 macOS SDK，则只会搜索 SDK 本身。 该默认行为仍可通过 --with-tcltk-includes 和 --with-tcltk-libs 来重载。 （由 Ned Deily 在 bpo-34956 [https://bugs.python.org/issue?@action=redirect&bpo=34956] 中贡献。）

Python 现在可以针对 Windows 10 ARM64 进行编译。 （由 Steve Dower 在 bpo-33125 [https://bugs.python.org/issue?@action=redirect&bpo=33125] 中贡献。）

现在当使用 --pgo 时一些单独的测试会被跳过。 这些测试显著增加了 PGO 任务的时间并且可能无助于提升最终可执行文件的优化程度。 这样能使任务加速大约 15 倍。 运行完整的单元测试是很慢的。 这个改变可能导致优化程序稍差的构建，因为将被执行的代码分支不够多。 如果你愿意等待更缓慢的构建，则可以使用 ./configure [..] PROFILE_TASK="-m test --pgo-extended" 来恢复旧版本的行为。 我们不保证哪个 PGO 任务集能产生更快的构建。 关心此问题的用户应当自行运行相关基准测试，因为结果可能取决于具体环境、工作负载以及编译工具链。 （请参阅 bpo-36044 [https://bugs.python.org/issue?@action=redirect&bpo=36044] 和 bpo-37707 [https://bugs.python.org/issue?@action=redirect&bpo=37707] 了解详情。）

C API 的改变

新的特性

PEP 573 [https://www.python.org/dev/peps/pep-0573]: 添加了 PyType_FromModuleAndSpec() 用于通过类来关联一个模块；PyType_GetModule() 和 PyType_GetModuleState() 用于获取模块及其状态；以及 PyCMethod 和 METH_METHOD 用于允许一个方法访问其定义所在的类。 （由 Marcel Plch 和 Petr Viktorin 在 bpo-38787 [https://bugs.python.org/issue?@action=redirect&bpo=38787] 中贡献。）

增加了 PyFrame_GetCode() 函数：获取帧代码。 增加了 PyFrame_GetBack() 函数：获取帧的下一个外部帧。 （由 Victor Stinner 在 bpo-40421 [https://bugs.python.org/issue?@action=redirect&bpo=40421] 中贡献。）

将 PyFrame_GetLineNumber() 添加到受限的 C API。 （由 Victor Stinner 在 bpo-40421 [https://bugs.python.org/issue?@action=redirect&bpo=40421] 中贡献。）

增加了 PyThreadState_GetInterpreter() 和 PyInterpreterState_Get() 函数用于获取解释器。 增加了 PyThreadState_GetFrame() 函数用于获取 Python 线程状态的当前帧。 增加了 PyThreadState_GetID() 函数：获取 Python 线程状态的唯一标识符。 （由 Victor Stinner 在 bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947] 中贡献。）

将新的公有 PyObject_CallNoArgs() 函数添加到 C API，该函数可不带任何参数调用一个 Python 可调用对象。 它是不带参数调用 Python 可调用对象最有效率的方式。 （由 Victor Stinner 在 bpo-37194 [https://bugs.python.org/issue?@action=redirect&bpo=37194] 中贡献。）

受限 C API 中的改变（如果定义了 Py_LIMITED_API 宏）:

提供 Py_EnterRecursiveCall() 和 Py_LeaveRecursiveCall() 作为常规函数用于受限 API。 在之前版本中是使用宏定义，但这些宏不能与无法访问 PyThreadState.recursion_depth 字段的受限 C API 一同编译（该结构体在受限 C API 中是不透明的）。

PyObject_INIT() 和 PyObject_INIT_VAR() 已成为常规“不透明”函数以隐藏实现细节。

（由 Victor Stinner 在 bpo-38644 [https://bugs.python.org/issue?@action=redirect&bpo=38644] 和 bpo-39542 [https://bugs.python.org/issue?@action=redirect&bpo=39542] 中贡献。）

增加了 PyModule_AddType() 函数以协助将类型加入到模块中。 （由 Dong-hee Na 在 bpo-40024 [https://bugs.python.org/issue?@action=redirect&bpo=40024] 中贡献。）

将 PyObject_GC_IsTracked() 和 PyObject_GC_IsFinalized() 函数添加到公有 API 以允许分别查询 Python 对象当前是正在被追踪还是已经被垃圾回收器所终结。 （由 Pablo Galindo Salgado 在 bpo-40241 [https://bugs.python.org/issue?@action=redirect&bpo=40241] 中贡献。）

增加了 _PyObject_FunctionStr() 以获取函数类对象的用户友好的表示形式。 （由 Jeroen Demeyer 在 bpo-37645 [https://bugs.python.org/issue?@action=redirect&bpo=37645] 中修正。）

增加了 PyObject_CallOneArg() 用于调用具有一个位置参数的对象（由 Jeroen Demeyer 在 bpo-37483 [https://bugs.python.org/issue?@action=redirect&bpo=37483] 中修正。）

移植到 Python 3.9

PyInterpreterState.eval_frame (PEP 523 [https://www.python.org/dev/peps/pep-0523]) 现在需要有新的强制性形参 tstate (PyThreadState*)。 （由 Victor Stinner 在 bpo-38500 [https://bugs.python.org/issue?@action=redirect&bpo=38500] 中贡献。）

扩展模块: PyModuleDef 的 m_traverse, m_clear 和 m_free 等函数在模块状态被请求但尚未被分配时将不会再被调用。 这种情况出现在模块被创建之后且模块被执行 (Py_mod_exec 函数) 之前的时刻。 更准确地说，这些函数在 m_size 大于 0 并且模块状态（即 PyModule_GetState() 的返回值）为 NULL 时将不会被调用。

没有模块状态的扩展模块 (m_size <= 0) 不会受到影响。

现在如果 Py_AddPendingCall() 是在子解释器内部被调用，该函数会被排入子解释器的调用日程，而不是由主解释器调用。 每个子解释器现在都拥有它们自己的调用日程列表。 （由 Victor Stinner 在 bpo-39984 [https://bugs.python.org/issue?@action=redirect&bpo=39984] 中贡献。）

当 -E 选项被使用 (如果 PyConfig.use_environment 设为 0) 时将不再使用 Windows 注册表来初始化 sys.path。 这会影响在 Windows 上嵌入 Python 的操作。 （由 Zackery Spytz 在 bpo-8901 [https://bugs.python.org/issue?@action=redirect&bpo=8901] 中贡献。）

全局变量 PyStructSequence_UnnamedField 现在为常量并且指向一个字符串常量。 （由 Serhiy Storchaka 在 bpo-38650 [https://bugs.python.org/issue?@action=redirect&bpo=38650] 中贡献。）

现在 PyGC_Head 结构是不透明的。 它只在内部 C API (pycore_gc.h) 中定义。 （由 Victor Stinner 在 bpo-40241 [https://bugs.python.org/issue?@action=redirect&bpo=40241] 中贡献。）

Py_UNICODE_COPY, Py_UNICODE_FILL, PyUnicode_WSTR_LENGTH, PyUnicode_FromUnicode(), PyUnicode_AsUnicode(), _PyUnicode_AsUnicode 以及 PyUnicode_AsUnicodeAndSize() 在 C 中被标记为已弃用。 它们自 Python 3.3 起就已被 PEP 393 [https://www.python.org/dev/peps/pep-0393] 弃用。 （由 Inada Naoki 在 bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346] 中贡献。）

Py_FatalError() 函数会被一个自动记录当前函数名称的宏所替代，除非已定义了 Py_LIMITED_API 宏。 （由 Victor Stinner 在 bpo-39882 [https://bugs.python.org/issue?@action=redirect&bpo=39882] 中贡献。）

vectorcall 协议现在要求调用者只传入字符串作为键名。 （请参阅 bpo-37540 [https://bugs.python.org/issue?@action=redirect&bpo=37540] 了解详情。）

多个宏和函数的实现细节现在已被隐藏:

PyObject_IS_GC() 宏已被转换为函数。

PyObject_NEW() 宏已成为 PyObject_New() 宏的别名，而 PyObject_NEW_VAR() 宏已成为 PyObject_NewVar() 宏的别名。 它们将不再直接访问 PyTypeObject.tp_basicsize 成员。

PyObject_GET_WEAKREFS_LISTPTR() 宏已被转换为函数：该宏会直接访问 PyTypeObject.tp_weaklistoffset 成员。

PyObject_CheckBuffer() 宏已被转换为函数：该宏会直接访问 PyTypeObject.tp_as_buffer 成员。

现在 PyIndex_Check() 总是被声明为不透明函数以隐藏实现细节；PyIndex_Check() 宏已被移除。 该宏会直接访问 PyTypeObject.tp_as_number 成员。

（详情请参阅 bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]。）

移除

pyfpe.h 的 PyFPE_START_PROTECT() 和 PyFPE_END_PROTECT() 宏已从受限的 C API 中被排除。 （由 Victor Stinner 在 bpo-38835 [https://bugs.python.org/issue?@action=redirect&bpo=38835] 中贡献。）

PyTypeObject 的 tp_print 空位已被移除。 它在 Python 2.7 及之前的版本中被用来将对象打印到文件。 自 Python 3.0 起，它已被忽略并且不再使用。 （由 Jeroen Demeyer 在 bpo-36974 [https://bugs.python.org/issue?@action=redirect&bpo=36974] 中贡献。）

受限 C API 中的改变（如果定义了 Py_LIMITED_API 宏）:

以下函数已从受限 C API 中排除:

PyThreadState_DeleteCurrent() （由 Joannah Nanjekye 在 bpo-37878 [https://bugs.python.org/issue?@action=redirect&bpo=37878] 中贡献。）

_Py_CheckRecursionLimit

_Py_NewReference()

_Py_ForgetReference()

_PyTraceMalloc_NewReference()

_Py_GetRefTotal()

在受限 C API 中从未使用的垃圾箱机制。

PyTrash_UNWIND_LEVEL

Py_TRASHCAN_BEGIN_CONDITION

Py_TRASHCAN_BEGIN

Py_TRASHCAN_END

Py_TRASHCAN_SAFE_BEGIN

Py_TRASHCAN_SAFE_END

已将下列函数和定义移至内部 C API:

_PyDebug_PrintTotalRefs()

_Py_PrintReferences()

_Py_PrintReferenceAddresses()

_Py_tracemalloc_config

_Py_AddToAllObjects() (Py_TRACE_REFS 构建专属)

（由 Victor Stinner 在 bpo-38644 [https://bugs.python.org/issue?@action=redirect&bpo=38644] 和 bpo-39542 [https://bugs.python.org/issue?@action=redirect&bpo=39542] 中贡献。）

移除了 _PyRuntime.getframe 钩子并移除了 _PyThreadState_GetFrame 宏，该宏是 _PyRuntime.getframe 的一个别名。 它们仅由内部 C API 对外公开。 同样地移除了 PyThreadFrameGetter 类型。 （由 Victor Stinner 在 bpo-39946 [https://bugs.python.org/issue?@action=redirect&bpo=39946] 中贡献。）

从 C API 移除了下列函数。 请显式地调用 PyGC_Collect() 来清空所有自由列表。 （由 Inada Naoki 和 Victor Stinner 在 bpo-37340 [https://bugs.python.org/issue?@action=redirect&bpo=37340], bpo-38896 [https://bugs.python.org/issue?@action=redirect&bpo=38896] 和 bpo-40428 [https://bugs.python.org/issue?@action=redirect&bpo=40428] 中贡献。）

PyAsyncGen_ClearFreeLists()

PyContext_ClearFreeList()

PyDict_ClearFreeList()

PyFloat_ClearFreeList()

PyFrame_ClearFreeList()

PyList_ClearFreeList()

PyMethod_ClearFreeList() 和 PyCFunction_ClearFreeList(): 绑定方法对象的自由列表已被移除。

PySet_ClearFreeList(): 集合自由列表已在 Python 3.4 中被移除。

PyTuple_ClearFreeList()

PyUnicode_ClearFreeList(): Unicode 自由列表已在 Python 3.3 中被移除。

移除了 _PyUnicode_ClearStaticStrings() 函数。 （由 Victor Stinner 在 bpo-39465 [https://bugs.python.org/issue?@action=redirect&bpo=39465] 中贡献。）

移除了 Py_UNICODE_MATCH。 它已被 PEP 393 [https://www.python.org/dev/peps/pep-0393] 所弃用，并自 Python 3.3 起不再可用。 可以改用 PyUnicode_Tailmatch() 函数。 （由 Inada Naoki 在 bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346] 中贡献。）

清除了已定义但未实现的接口的头文件。 被移除了公共 API 符号有: _PyBytes_InsertThousandsGroupingLocale, _PyBytes_InsertThousandsGrouping, _Py_InitializeFromArgs, _Py_InitializeFromWideArgs, _PyFloat_Repr, _PyFloat_Digits, _PyFloat_DigitsInit, PyFrame_ExtendStack, _PyAIterWrapper_Type, PyNullImporter_Type, PyCmpWrapper_Type, PySortWrapper_Type, PyNoArgsFunction。 （由 Pablo Galindo Salgado 在 bpo-39372 [https://bugs.python.org/issue?@action=redirect&bpo=39372] 中贡献。）

Python 3.9.1 中的重要变化

typing

typing.Literal 的行为被改为遵循 PEP 586 [https://www.python.org/dev/peps/pep-0586] 并匹配该 PEP 所描述的静态类型检查器的行为。

Literal 现在将是去重复的形参。

Literal 对象间的相等性比较现在将是顺序无关的。

Literal 比较现在会考虑类型。 例如 Literal[0] == Literal[False] 之前的结果值为 True。 现在则为 False。 为支持此改变，内部使用的类型缓存现在也支持区分类型。

现在如果有任何一个参数不为 hashable，Literal 对象将在相等性比较期间引发 TypeError。 请注意使用可变参数声明 Literal 将不会抛出异常:

>>> 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'

（由 Yurii Karabas 在 bpo-42345 [https://bugs.python.org/issue?@action=redirect&bpo=42345] 中贡献。）

macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持

对于 3.9.1 版来说，Python 现在完全支持在 macOS 11.0 (Big Sur) 和 Apple Silicon Macs (基于 ARM64 架构) 上构建和运行。 现在提供了一个新的通用构建类型 universal2，用于在一组可执行文件上原生支持 ARM64 和 Intel 64。 二进制文件现在也可以在当前版本的 macOS 上编译以部署到多种较旧的 macOS 版本上 (已测试 10.9)，同时会基于运行时所使用的操作系统版本让某些较新的 OS 功能和选项有条件地可用 ("弱链接") 。

（由 Ronald Oussoren 和 Lawrence D'Anna 在 bpo-41100 [https://bugs.python.org/issue?@action=redirect&bpo=41100] 中贡献。）

Python 3.9.2 中的重要变化

collections.abc

现在 collections.abc.Callable 泛型会将类型形参展平，类似于 typing.Callable 当前所做的那样。 这意味着 collections.abc.Callable[[int, str], str] 的 __args__ 将为 (int, str, str)；之前则为 ([int, str], str)。 为了允许这个改变，types.GenericAlias 现在可以被子类化，并且在抽取 collections.abc.Callable 类型时将返回一个子类。 通过 typing.get_args() 或 __args__ 访问参数的代码需要考虑到这个改变。 对于无效的 collections.abc.Callable 参数化形式可能会发出 DeprecationWarning，这在 Python 3.9.1 中可能会静默地传递。 这个 DeprecationWarning 将在 Python 3.10 中变为 TypeError。 （由 Ken Jin 在 bpo-42195 [https://bugs.python.org/issue?@action=redirect&bpo=42195] 中贡献。）

urllib.parse

早先的 Python 版本允许使用 ; 和 & 作为 urllib.parse.parse_qs() 和 urllib.parse.parse_qsl() 中 query 形参的分隔键。 出于安全考虑，也为了遵循更新的 W3C 推荐设置，这已被改为只允许单个分隔键，默认为 &。 这一改变还会影响 cgi.parse() 和 cgi.parse_multipart() 因为它们在内部使用了受影响的函数。 要了解更多细节，请查看它们各自的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967] 中贡献。）

Python 3.8 有什么新变化

编者

Raymond Hettinger（译者：wh2099 at outlook dot com）

这篇文章介绍了 Python 3.8 相比 3.7 增加的新特性。 Python 3.8 发布于 2019 年 10 月 14 日。 更详细的信息可参阅 更新日志。

摘要 -- 发布重点

新的特性

赋值表达式

新增的语法 := 可在表达式内部为变量赋值。 它被昵称为“海象运算符”因为它很像是 海象的眼睛和长牙 [https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg]。

在这个示例中，赋值表达式可以避免调用 len() 两次:

if (n := len(a)) > 10:
    print(f"List is too long ({n} elements, expected <= 10)")

类似的益处还可出现在正则表达式匹配中需要使用两次匹配对象的情况中，一次检测用于匹配是否发生，另一次用于提取子分组:

discount = 0.0
if (mo := re.search(r'(\d+)% discount', advertisement)):
    discount = float(mo.group(1)) / 100.0

此运算符也适用于配合 while 循环计算一个值来检测循环是否终止，而同一个值又在循环体中再次被使用的情况:

# Loop over fixed length blocks
while (block := f.read(256)) != '':
    process(block)

另一个值得介绍的用例出现于列表推导式中，在筛选条件中计算一个值，而同一个值又在表达式中需要被使用:

[clean_name.title() for name in names
 if (clean_name := normalize('NFC', name)) in allowed_names]

请尽量将海象运算符的使用限制在清晰的场合中，以降低复杂性并提升可读性。

请参阅 PEP 572 [https://www.python.org/dev/peps/pep-0572] 了解详情。

（由 Morehouse 在 bpo-35224 [https://bugs.python.org/issue?@action=redirect&bpo=35224] 中贡献。）

仅限位置形参

新增了一个函数形参语法 / 用来指明某些函数形参必须为仅限位置而非关键字参数。 这种标记语法与通过 help() 所显示的使用 Larry Hastings 的 Argument Clinic 工具标记的 C 函数相同。

在下面的例子中，形参 a 和 b 为仅限位置形参，c 或 d 可以是位置形参或关键字形参，而 e 或 f 要求为关键字形参:

def f(a, b, /, c, d, *, e, f):
    print(a, b, c, d, e, f)

以下均为合法的调用:

f(10, 20, 30, d=40, e=50, f=60)

但是，以下均为不合法的调用:

f(10, b=20, c=30, d=40, e=50, f=60)   # b cannot be a keyword argument
f(10, 20, 30, 40, 50, f=60)           # e must be a keyword argument

这种标记形式的一个用例是它允许纯 Python 函数完整模拟现有的用 C 代码编写的函数的行为。 例如，内置的 divmod() 函数不接受关键字参数:

def divmod(a, b, /):
    "Emulate the built in divmod() function"
    return (a // b, a % b)

另一个用例是在不需要形参名称时排除关键字参数。 例如，内置的 len() 函数的签名为 len(obj, /)。 这可以排除如下这种笨拙的调用形式:

len(obj='hello')  # The "obj" keyword argument impairs readability

另一个益处是将形参标记为仅限位置形参将允许在未来修改形参名而不会破坏客户的代码。 例如，在 statistics 模块中，形参名 dist 在未来可能被修改。 这使得以下函数描述成为可能:

def quantiles(dist, /, *, n=4, method='exclusive')
    ...

由于在 / 左侧的形参不会被公开为可用关键字，其他形参名仍可在 **kwargs 中使用:

>>> def f(a, b, /, **kwargs):
...     print(a, b, kwargs)
...
>>> f(10, 20, a=1, b=2, c=3)         # a and b are used in two ways
10 20 {'a': 1, 'b': 2, 'c': 3}

这极大地简化了需要接受任意关键字参数的函数和方法的实现。 例如，以下是一段摘自 collections 模块的代码:

class Counter(dict):

    def __init__(self, iterable=None, /, **kwds):
        # Note "iterable" is a possible keyword argument

请参阅 PEP 570 [https://www.python.org/dev/peps/pep-0570] 了解详情。

（由 Pablo Galindo 在 bpo-36540 [https://bugs.python.org/issue?@action=redirect&bpo=36540] 中贡献。）

用于已编译字节码文件的并行文件系统缓存

新增的 PYTHONPYCACHEPREFIX 设置 (也可使用 -X pycache_prefix) 可将隐式的字节码缓存配置为使用单独的并行文件系统树，而不是默认的每个源代码目录下的 __pycache__ 子目录。

缓存的位置会在 sys.pycache_prefix 中报告 (None 表示默认位置即 __pycache__ 子目录)。

（由 Carl Meyer 在 bpo-33499 [https://bugs.python.org/issue?@action=redirect&bpo=33499] 中贡献。）

调试构建使用与发布构建相同的 ABI

Python 现在不论是以发布模式还是调试模式进行构建都将使用相同的 ABI。 在 Unix 上，当 Python 以调试模式构建时，现在将可以加载以发布模式构建的 C 扩展和使用稳定版 ABI 构建的 C 扩展。

发布编译版和 调试编译版 现在都是 ABI 兼容的：定义 Py_DEBUG 宏不会再应用 Py_TRACE_REFS 宏，它引入 了唯一的 ABI 不兼容性。 Py_TRACE_REFS 宏添加了 sys.getobjects() 函数和 PYTHONDUMPREFS 环境变量，它可以使用新的 ./configure --with-trace-refs 编译选项来设置。 （由 Victor Stinner 在 bpo-36465 [https://bugs.python.org/issue?@action=redirect&bpo=36465] 中贡献。）

在 Unix 上，C 扩展不会再被链接到 libpython，但 Android 和 Cygwin 例外。 现在静态链接的 Python 将可以加载使用共享库 Python 构建的 C 扩展。 （由 Victor Stinner 在 bpo-21536 [https://bugs.python.org/issue?@action=redirect&bpo=21536] 中贡献。）

在 Unix 上，当 Python 以调试模式构建时，导入操作现在也会查找在发布模式下编译的 C 扩展以及使用稳定版 ABI 编译的 C 扩展。 （由 Victor Stinner 在 bpo-36722 [https://bugs.python.org/issue?@action=redirect&bpo=36722] 中贡献。）

要将 Python 嵌入到一个应用中，必须将新增的 --embed 选项传给 python3-config --libs --embed 以获得 -lpython3.8 (将应用链接到 libpython)。 要同时支持 3.8 和旧版本，请先尝试 python3-config --libs --embed 并在此命令失败时回退到 python3-config --libs (即不带 --embed)。

增加一个 pkg-config python-3.8-embed 模块用来将 Python 嵌入到一个应用中: pkg-config python-3.8-embed --libs 包含 -lpython3.8。 要同时支持 3.8 和旧版本，请先尝试 pkg-config python-X.Y-embed --libs 并在此命令失败时回退到 pkg-config python-X.Y --libs (即不带 --embed) （请将 X.Y 替换为 Python 版本号）。

另一方面，pkg-config python3.8 --libs 不再包含 -lpython3.8。 C 扩展不可被链接到 libpython (但 Android 和 Cygwin 例外，这两者的情况由脚本处理)；此改变是故意被设为向下不兼容的。 （由 Victor Stinner 在 bpo-36721 [https://bugs.python.org/issue?@action=redirect&bpo=36721] 中贡献。）

f-字符串支持 = 用于自动记录表达式和调试文档

增加 = 说明符用于 f-string。 形式为 f'{expr=}' 的 f-字符串将扩展表示为表达式文本，加一个等于号，再加表达式的求值结果。 例如：

>>> user = 'eric_idle'
>>> member_since = date(1975, 7, 31)
>>> f'{user=} {member_since=}'
"user='eric_idle' member_since=datetime.date(1975, 7, 31)"

通常的 f-字符串格式说明符 允许更细致地控制所要显示的表达式结果:

>>> delta = date.today() - member_since
>>> f'{user=!s}  {delta.days=:,d}'
'user=eric_idle  delta.days=16,075'

= 说明符将输出整个表达式，以便详细演示计算过程:

>>> print(f'{theta=}  {cos(radians(theta))=:.3f}')
theta=30  cos(radians(theta))=0.866

（由 Eric V. Smith 和 Larry Hastings 在 bpo-36817 [https://bugs.python.org/issue?@action=redirect&bpo=36817] 中贡献。）

PEP 578: Python 运行时审核钩子

此 PEP 添加了审核钩子和已验证开放钩子。 两者在 Python 与本机代码中均可用。允许以纯 Python 代码编写的应用和框架利用额外的通知，同时允许嵌入开发人员或系统管理员部署始终启用审核的 Python 版本。

请参阅 PEP 578 [https://www.python.org/dev/peps/pep-0578] 了解详情。

PEP 587: Python 初始化配置

PEP 587 [https://www.python.org/dev/peps/pep-0587] 增加了一个新的 C API 用来配置 Python 初始化，提供对整个配置过程的更细致控制以及更好的错误报告。

新的结构：

PyConfig

PyPreConfig

PyStatus

PyWideStringList

新的函数：

PyConfig_Clear()

PyConfig_InitIsolatedConfig()

PyConfig_InitPythonConfig()

PyConfig_Read()

PyConfig_SetArgv()

PyConfig_SetBytesArgv()

PyConfig_SetBytesString()

PyConfig_SetString()

PyPreConfig_InitIsolatedConfig()

PyPreConfig_InitPythonConfig()

PyStatus_Error()

PyStatus_Exception()

PyStatus_Exit()

PyStatus_IsError()

PyStatus_IsExit()

PyStatus_NoMemory()

PyStatus_Ok()

PyWideStringList_Append()

PyWideStringList_Insert()

Py_BytesMain()

Py_ExitStatusException()

Py_InitializeFromConfig()

Py_PreInitialize()

Py_PreInitializeFromArgs()

Py_PreInitializeFromBytesArgs()

Py_RunMain()

此 PEP 还为这些内部结构添加了 _PyRuntimeState.preconfig (PyPreConfig 类型) 和 PyInterpreterState.config (PyConfig 类型) 字段。 PyInterpreterState.config 成为新的引用配置，替代全局配置变量和其他私有变量。

请参阅 Python 初始化配置 获取详细文档。

请参阅 PEP 587 [https://www.python.org/dev/peps/pep-0587] 了解详情。

（由 Victor Stinner 在 bpo-36763 [https://bugs.python.org/issue?@action=redirect&bpo=36763] 中贡献。）

PEP 590: Vectorcall: 用于 CPython 的快速调用协议

将 Vectorcall 协议 添加到 Python/C API。 它的目标是对已被应用于多个类的现有优先进行正式化。 任何实现了可调用对象的 静态类型 均可使用此协议。

此特性目前为暂定状态，计划在 Python 3.9 将其完全公开。

请参阅 PEP 590 [https://www.python.org/dev/peps/pep-0590] 了解详情。

（由 Jeroen Demeyer, Mark Shannon 和 Petr Viktorin 在 bpo-36974 [https://bugs.python.org/issue?@action=redirect&bpo=36974] 中贡献。）

具有外部数据缓冲区的 pickle 协议 5

当使用 pickle 在 Python 进程间传输大量数据以充分发挥多核或多机处理的优势时，非常重要一点是通过减少内存拷贝来优化传输效率，并可能应用一些定制技巧例如针对特定数据的压缩。

pickle 协议 5 引入了对于外部缓冲区的支持，这样 PEP 3118 [https://www.python.org/dev/peps/pep-3118] 兼容的数据可以与主 pickle 流分开进行传输，这是由通信层来确定的。

请参阅 PEP 574 [https://www.python.org/dev/peps/pep-0574] 了解详情。

（由 Antoine Pitrou 在 bpo-36785 [https://bugs.python.org/issue?@action=redirect&bpo=36785] 中贡献。）

其他语言特性修改

在之前版本中 continue 语句不允许在 finally 子句中使用，这是因为具体实现存在一个问题。 在 Python 3.8 中此限制已被取消。 （由 Serhiy Storchaka 在 bpo-32489 [https://bugs.python.org/issue?@action=redirect&bpo=32489] 中贡献。）

bool, int 和 fractions.Fraction 类型现在都有一个 as_integer_ratio() 方法，与 float 和 decimal.Decimal 中的已有方法类似。 这个微小的 API 扩展使得 numerator, denominator = x.as_integer_ratio() 这样的写法在多种数字类型上通用成为可能。 （由 Lisa Roach 在 bpo-33073 [https://bugs.python.org/issue?@action=redirect&bpo=33073] 和 Raymond Hettinger 在 bpo-37819 [https://bugs.python.org/issue?@action=redirect&bpo=37819] 中贡献。）

int, float 和 complex 的构造器现在会使用 __index__() 特殊方法，如果该方法可用而对应的方法 method __int__(), __float__() 或 __complex__() 方法不可用的话。 （由 Serhiy Storchaka 在 bpo-20092 [https://bugs.python.org/issue?@action=redirect&bpo=20092] 中贡献。）

添加 \N{name} 转义符在 正则表达式 中的支持:

>>> notice = 'Copyright © 2019'
>>> copyright_year_pattern = re.compile(r'\N{copyright sign}\s*(\d{4})')
>>> int(copyright_year_pattern.search(notice).group(1))
2019

（由 Jonathan Eunice 和 Serhiy Storchaka 在 bpo-30688 [https://bugs.python.org/issue?@action=redirect&bpo=30688] 中贡献。）

现在 dict 和 dictview 可以使用 reversed() 按插入顺序反向迭代。 （由 Rémi Lapeyre 在 bpo-33462 [https://bugs.python.org/issue?@action=redirect&bpo=33462] 中贡献。）

在函数调用中允许使用的关键字名称语法受到进一步的限制。 特别地，f((keyword)=arg) 不再被允许。 关键字参数赋值形式的左侧绝不允许一般标识符以外的其他内容。 （由 Benjamin Peterson 在 bpo-34641 [https://bugs.python.org/issue?@action=redirect&bpo=34641] 中贡献。）

在 yield 和 return 语句中的一般可迭代对象解包不再要求加圆括号。 这使得 yield 和 return 的语法与正常的赋值语法更为一致:

>>> def parse(family):
        lastname, *members = family.split()
        return lastname.upper(), *members

>>> parse('simpsons homer marge bart lisa maggie')
('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'maggie')

（由 David Cuthbert 和 Jordan Chapman 在 bpo-32117 [https://bugs.python.org/issue?@action=redirect&bpo=32117] 中贡献。）

当类似 [(10, 20) (30, 40)] 这样在代码中少了一个逗号时，编译器将显示 SyntaxWarning 并附带更有帮助的提示。 这相比原来用 TypeError 来提示第一个元组是不可调用的更容易被理解。 （由 Serhiy Storchaka 在 bpo-15248 [https://bugs.python.org/issue?@action=redirect&bpo=15248] 中贡献。）

datetime.date 或 datetime.datetime 和 datetime.timedelta 对象之间的算术运算现在将返回相应子类的实例而不是基类的实例。 这也会影响到在具体实现中（直接或间接地）使用了 datetime.timedelta 算术运算的返回类型，例如 astimezone()。 （由 Paul Ganssle 在 bpo-32417 [https://bugs.python.org/issue?@action=redirect&bpo=32417] 中贡献。）

当 Python 解释器通过 Ctrl-C (SIGINT) 被中断并且所产生的 KeyboardInterrupt 异常未被捕获，Python 进程现在会通过一个 SIGINT 信号或是使得唤起的进程能检测到它是由 Ctrl-C 操作杀死的正确退出代码来退出。 POSIX 和 Windows 上的终端会相应地使用此代码在交互式会话中终止脚本。 （由 Google 的 Gregory P. Smith 在 bpo-1054041 [https://bugs.python.org/issue?@action=redirect&bpo=1054041] 中贡献。）

某些高级编程风格要求为现有的函数更新 types.CodeType 对象。 由于代码对象是不可变的，需要基于现有代码对象模型创建一个新的代码对象。 使用 19 个形参将会相当繁琐。 现在，新的 replace() 方法使得通过少量修改的形参创建克隆对象成为可能。

下面是一个修改 statistics.mean() 函数来防止 data 形参被用作关键字参数的例子:

>>> 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'

（由 Victor Stinner 在 bpo-37032 [https://bugs.python.org/issue?@action=redirect&bpo=37032] 中贡献。）

对于整数，现在 pow() 函数的三参数形式在底数与模数不可约的情况下允许指数为负值。 随后它会在指数为 -1 时计算底数的模乘逆元，并对其他负指数计算反模的适当幂次。 例如，要计算 38 模 137 的 模乘逆元 [https://en.wikipedia.org/wiki/Modular_multiplicative_inverse] 则可写为:

>>> pow(38, -1, 137)
119
>>> 119 * 38 % 137
1

模乘逆元在求解 线性丢番图方程 [https://en.wikipedia.org/wiki/Diophantine_equation] 会被用到。 例如，想要求出 4258𝑥 + 147𝑦 = 369 的整数解，首先应重写为 4258𝑥 ≡ 369 (mod 147) 然后求解：

>>> x = 369 * pow(4258, -1, 147) % 147
>>> y = (4258 * x - 369) // -147
>>> 4258 * x + 147 * y
369

（由 Mark Dickinson 在 bpo-36027 [https://bugs.python.org/issue?@action=redirect&bpo=36027] 中贡献。）

字典推导式已与字典字面值实现同步，会先计算键再计算值:

>>> # Dict comprehension
>>> cast = {input('role? '): input('actor? ') for i in range(2)}
role? King Arthur
actor? Chapman
role? Black Knight
actor? Cleese

>>> # Dict literal
>>> cast = {input('role? '): input('actor? ')}
role? Sir Robin
actor? Eric Idle

对执行顺序的保证对赋值表达式来说很有用，因为在键表达式中赋值的变量将可在值表达式中被使用:

>>> 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'}

（由 Jörn Heissler 在 bpo-35224 [https://bugs.python.org/issue?@action=redirect&bpo=35224] 中贡献。）

object.__reduce__() 方法现在可返回长度为二至六个元素的元组。 之前的上限为五个。 新增的第六个可选元素是签名为 (obj, state) 的可调用对象。 这样就允许直接控制特定对象的状态更新。 如果元素值不为 None，该可调用对象将优先于对象的 __setstate__() 方法。 （由 Pierre Glaser 和 Olivier Grisel 在 bpo-35900 [https://bugs.python.org/issue?@action=redirect&bpo=35900] 中贡献。）

新增模块

新增的 importlib.metadata 模块提供了从第三方包读取元数据的（临时）支持。 例如，它可以提取一个已安装软件包的版本号、入口点列表等等:

>>> # Note following example requires that the popular "requests"
>>> # package has been installed.
>>>
>>> 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')]

（由 Barry Warsaw 和 Jason R. Coombs 在 bpo-34632 [https://bugs.python.org/issue?@action=redirect&bpo=34632] 中贡献）。

改进的模块

ast

AST 节点现在具有 end_lineno 和 end_col_offset 属性，它们给出节点结束的精确位置。 （这只适用于具有 lineno 和 col_offset 属性的节点。）

新增函数 ast.get_source_segment() 返回指定 AST 节点的源代码。

（由 Ivan Levkivskyi 在 bpo-33416 [https://bugs.python.org/issue?@action=redirect&bpo=33416] 中贡献。）

ast.parse() 函数具有一些新的旗标：

type_comments=True 导致其返回与特定 AST 节点相关联的 PEP 484 [https://www.python.org/dev/peps/pep-0484] 和 PEP 526 [https://www.python.org/dev/peps/pep-0526] 类型注释文本；

mode='func_type' 可被用于解析 PEP 484 [https://www.python.org/dev/peps/pep-0484] "签名类型注释" (为函数定义 AST 节点而返回)；

feature_version=(3, N) 允许指定一个更早的 Python 3 版本。 例如，feature_version=(3, 4) 将把 async 和 await 视为非保留字。

（由 Guido van Rossum 在 bpo-35766 [https://bugs.python.org/issue?@action=redirect&bpo=35766] 中贡献。）

asyncio

asyncio.run() 已经从暂定状态晋级为稳定 API。 此函数可被用于执行一个 coroutine 并返回结果，同时自动管理事件循环。 例如:

import asyncio

async def main():
    await asyncio.sleep(0)
    return 42

asyncio.run(main())

这 大致 等价于:

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()

实际的实现要更复杂许多。 因此 asyncio.run() 应该作为运行 asyncio 程序的首选方式。

（由 Yury Selivanov 在 bpo-32314 [https://bugs.python.org/issue?@action=redirect&bpo=32314] 中贡献。）

运行 python -m asyncio 将启动一个原生异步 REPL。 这允许快速体验具有最高层级 await 的代码。 这时不再需要直接调用 asyncio.run()，因为此操作会在每次唤起时产生一个新事件循环：

$ 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

（由 Yury Selivanov 在 bpo-37028 [https://bugs.python.org/issue?@action=redirect&bpo=37028] 中贡献。）

异常 asyncio.CancelledError 现在继承自 BaseException 而不是 Exception 并且不再继承自 concurrent.futures.CancelledError。 （由 Yury Selivanov 在 bpo-32528 [https://bugs.python.org/issue?@action=redirect&bpo=32528] 中贡献。）

在 Windows 上，现在默认的事件循环为 ProactorEventLoop。 （由 Victor Stinner 在 bpo-34687 [https://bugs.python.org/issue?@action=redirect&bpo=34687] 中贡献。）

ProactorEventLoop 现在也支持 UDP。 （由 Adam Meily 和 Andrew Svetlov 在 bpo-29883 [https://bugs.python.org/issue?@action=redirect&bpo=29883] 中贡献。）

ProactorEventLoop 现在可通过 KeyboardInterrupt ("CTRL+C") 来中断。 （由 Vladimir Matveev 在 bpo-23057 [https://bugs.python.org/issue?@action=redirect&bpo=23057] 中贡献。）

添加了 asyncio.Task.get_coro() 用来获取 asyncio.Task 中的已包装协程。 （由 Alex Grönholm 在 bpo-36999 [https://bugs.python.org/issue?@action=redirect&bpo=36999] 中贡献。）

asyncio 任务现在可以被命名，或者是通过将 name 关键字参数传给 asyncio.create_task() 或 create_task() 事件循环方法，或者是通过在任务对象上调用 set_name() 方法。 任务名称在 asyncio.Task 的 repr() 输出中可见，并且还可以使用 get_name() 方法来获取。 （由 Alex Grönholm 在 bpo-34270 [https://bugs.python.org/issue?@action=redirect&bpo=34270] 中贡献。）

将对 Happy Eyeballs [https://en.wikipedia.org/wiki/Happy_Eyeballs] 的支持添加到 asyncio.loop.create_connection()。 要指定此行为，已增加了两个新的形参: happy_eyeballs_delay 和 interleave。 Happy Eyeballs 算法可提升支持 IPv4 和 IPv6 的应用的响应速度，具体做法是尝试同时使用两者进行连接。 （由 twisteroid ambassador 在 bpo-33530 [https://bugs.python.org/issue?@action=redirect&bpo=33530] 中贡献。）

builtins

内置的 compile() 已改进为可接受 ast.PyCF_ALLOW_TOP_LEVEL_AWAIT 旗标。 当传入此新旗标时，compile() 将允许通常被视为无效语法的最高层级 await, async for 和 async with 构造。 此后将可返回带有 CO_COROUTINE 旗标的异步代码对象。 （由 Matthias Bussonnier 在 bpo-34616 [https://bugs.python.org/issue?@action=redirect&bpo=34616] 中贡献。）

collections

collections.namedtuple() 的 _asdict() 方法现在将返回 dict 而不是 collections.OrderedDict。 此项更改是由于普通字典自 Python 3.7 起已保证具有确定的元素顺序。 如果还需要 OrderedDict 的额外特性，建议的解决方案是将结果转换为需要的类型: OrderedDict(nt._asdict())。 （由 Raymond Hettinger 在 bpo-35864 [https://bugs.python.org/issue?@action=redirect&bpo=35864] 中贡献。）

cProfile

cProfile.Profile 类现在可被用作上下文管理器。 在运行时对一个代码块实现性能分析:

import cProfile

with cProfile.Profile() as profiler:
      # code to be profiled
      ...

（由 Scott Sanderson 在 bpo-29235 [https://bugs.python.org/issue?@action=redirect&bpo=29235] 中贡献。）

csv

csv.DictReader 现在将返回 dict 而不是 collections.OrderedDict。 此工具现在会更快速且消耗更少内存同时仍然保留字段顺序。 （由 Michael Selik 在 bpo-34003 [https://bugs.python.org/issue?@action=redirect&bpo=34003] 中贡献。）

curses

添加了一个新变量用于保存下层 ncurses 库的结构版信息: ncurses_version。 （由 Serhiy Storchaka 在 bpo-31680 [https://bugs.python.org/issue?@action=redirect&bpo=31680] 中贡献。）

ctypes

在 Windows 上，CDLL 及其子类现在接受 winmode 形参来指定用于底层 LoadLibraryEx 调用的旗标。 默认旗标被设为仅加载来自可信任位置的 DLL 依赖项，包括 DLL 的存放路径（如果加载初始 DLL 时使用了完整或部分路径）以及通过 add_dll_directory() 添加的路径。 （由 Steve Dower 在 bpo-36085 [https://bugs.python.org/issue?@action=redirect&bpo=36085] 中贡献。）

datetime

添加了新的替代构造器 datetime.date.fromisocalendar() 和 datetime.datetime.fromisocalendar()，它们分别基于 ISO 年份、周序号和周内日序号来构造 date 和 datetime 对象；这两者分别是其所对应类中 isocalendar 方法的逆操作。 （由 Paul Ganssle 在 bpo-36004 [https://bugs.python.org/issue?@action=redirect&bpo=36004] 中贡献。）

functools

functools.lru_cache() 现在可直接作为装饰器而不是作为返回装饰器的函数。 因此这两种写法现在都被支持:

@lru_cache
def f(x):
    ...

@lru_cache(maxsize=256)
def f(x):
    ...

（由 Raymond Hettinger 在 bpo-36772 [https://bugs.python.org/issue?@action=redirect&bpo=36772] 中贡献。）

添加了新的 functools.cached_property() 装饰器，用于在实例生命周期内缓存的已计算特征属性。

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)

（由 Carl Meyer 在 bpo-21145 [https://bugs.python.org/issue?@action=redirect&bpo=21145] 中贡献）

添加了新的 functools.singledispatchmethod() 装饰器可使用 single dispatch 将方法转换为 泛型函数:

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]

（由 Ethan Smith 在 bpo-32380 [https://bugs.python.org/issue?@action=redirect&bpo=32380] 中贡献）

gc

get_objects() 现在能接受一个可选的 generation 形参来指定一个用于获取对象的生成器。 （由 Pablo Galindo 在 bpo-36016 [https://bugs.python.org/issue?@action=redirect&bpo=36016] 中贡献。）

gettext

添加了 pgettext() 及其变化形式。 （由 Franz Glasner, Éric Araujo 和 Cheryl Sabella 在 bpo-2504 [https://bugs.python.org/issue?@action=redirect&bpo=2504] 中贡献。）

gzip

添加 mtime 形参到 gzip.compress() 用于可重现的输出。 （由 Guo Ci Teo 在 bpo-34898 [https://bugs.python.org/issue?@action=redirect&bpo=34898] 中贡献。）

对于特定类型的无效或已损坏 gzip 文件现在将引发 BadGzipFile 而不是 OSError。 （由 Filip Gruszczyński, Michele Orrù 和 Zackery Spytz 在 bpo-6584 [https://bugs.python.org/issue?@action=redirect&bpo=6584] 中贡献。）

IDLE 与 idlelib

超过 N 行（默认值为 50）的输出将被折叠为一个按钮。 N 可以在 Settings 对话框的 General 页的 PyShell 部分中进行修改。 数量较少但是超长的行可以通过在输出上右击来折叠。 被折叠的输出可通过双击按钮来展开，或是通过右击按钮来放入剪贴板或是单独的窗口。 （由 Tal Einat 在 bpo-1529353 [https://bugs.python.org/issue?@action=redirect&bpo=1529353] 中贡献。）

在 Run 菜单中增加了 "Run Customized" 以使用自定义设置来运行模块。 输入的任何命令行参数都会被加入 sys.argv。 它们在下次自定义运行时会再次显示在窗体中。 用户也可以禁用通常的 Shell 主模块重启。 （由 Cheryl Sabella, Terry Jan Reedy 等人在 bpo-5680 [https://bugs.python.org/issue?@action=redirect&bpo=5680] 和 bpo-37627 [https://bugs.python.org/issue?@action=redirect&bpo=37627] 中贡献。）

在 IDLE 编辑器窗口中增加了可选的行号。 窗口打开时默认不显示行号，除非在配置对话框的 General 选项卡中特别设置。 已打开窗口中的行号可以在 Options 菜单中显示和隐藏。 （由 Tal Einat 和 Saimadhav Heblikar 在 bpo-17535 [https://bugs.python.org/issue?@action=redirect&bpo=17535] 中贡献。）

现在会使用 OS 本机编码格式在 Python 字符串和 Tcl 对象间进行转换。 这允许在 IDLE 中处理 emoji 和其他非 BMP 字符。 这些字符将可被显示或是从剪贴板复制和粘贴。 字符串从 Tcl 到 Python 的来回转换现在不会再发生失败。 （过去八年有许多人都为此付出过努力，问题最终由 Serhiy Storchaka 在 bpo-13153 [https://bugs.python.org/issue?@action=redirect&bpo=13153] 中解决。）

在 3.8.1 中新增:

添加切换光标闪烁停止的选项。 （由 Zackery Spytz 在 bpo-4603 [https://bugs.python.org/issue?@action=redirect&bpo=4603] 中贡献。）

Esc 键现在会关闭 IDLE 补全提示窗口。 （由 Johnny Najera 在 bpo-38944 [https://bugs.python.org/issue?@action=redirect&bpo=38944] 中贡献。）

上述修改已被反向移植到 3.7 维护发行版中。

添加关键字到模块名称补全列表。 （由 Terry J. Reedy 在 bpo-37765 [https://bugs.python.org/issue?@action=redirect&bpo=37765] 中贡献。）

inspect

inspect.getdoc() 函数现在可以找到 __slots__ 的文档字符串，如果该属性是一个元素值为文档字符串的 dict 的话。 这提供了类似于目前已有的 property(), classmethod() 和 staticmethod() 等函数的文档选项:

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)

（由 Raymond Hettinger 在 bpo-36326 [https://bugs.python.org/issue?@action=redirect&bpo=36326] 中贡献。）

io

在开发模式 (-X env) 和 调试编译版 中，io.IOBase 终结器现在会在 close() 方法失败时将异常写入日志。 发生的异常在发布编译版中会被静默地忽略。 （由 Victor Stinner 在 bpo-18748 [https://bugs.python.org/issue?@action=redirect&bpo=18748] 中贡献。）

itertools

itertools.accumulate() 函数增加了可选的 initial 关键字参数用来指定一个初始值:

>>> from itertools import accumulate
>>> list(accumulate([10, 5, 30, 15], initial=1000))
[1000, 1010, 1015, 1045, 1060]

（由 Lisa Roach 在 bpo-34659 [https://bugs.python.org/issue?@action=redirect&bpo=34659] 中贡献。）

json.tool

添加选项 --json-lines 用于将每个输入行解析为单独的 JSON 对象。 （由 Weipeng Hong 在 bpo-31553 [https://bugs.python.org/issue?@action=redirect&bpo=31553] 中贡献。）

logging

为 logging.basicConfig() 添加了 force 关键字参数，当设为真值时，关联到根日志记录器的任何现有处理程序都将在执行由其他参数所指定的配置之前被移除并关闭。

这解决了一个长期存在的问题。 当一个日志处理器或 basicConfig() 被调用时，对 basicConfig() 的后续调用会被静默地忽略。 这导致使用交互提示符或 Jupyter 笔记本更新、试验或讲解各种日志配置选项变得相当困难。

（由 Raymond Hettinger 提议，由 Dong-hee Na 实现，并由 Vinay Sajip 在 bpo-33897 [https://bugs.python.org/issue?@action=redirect&bpo=33897] 中完成审核。）

math

添加了新的函数 math.dist() 用于计算两点之间的欧几里得距离。 （由 Raymond Hettinger 在 bpo-33089 [https://bugs.python.org/issue?@action=redirect&bpo=33089] 中贡献。）

扩展了 math.hypot() 函数以便处理更多的维度。 之前它仅支持 2-D 的情况。 （由 Raymond Hettinger 在 bpo-33089 [https://bugs.python.org/issue?@action=redirect&bpo=33089] 中贡献。）

添加了新的函数 math.prod() 作为的 sum() 同类，该函数返回 'start' 值 (默认值: 1) 乘以一个数字可迭代对象的积:

>>> prior = 0.8
>>> likelihoods = [0.625, 0.84, 0.30]
>>> math.prod(likelihoods, start=prior)
0.126

（由 Pablo Galindo 在 bpo-35606 [https://bugs.python.org/issue?@action=redirect&bpo=35606] 中贡献。）

添加了两个新的组合函数 math.perm() 和 math.comb():

>>> math.perm(10, 3)    # Permutations of 10 things taken 3 at a time
720
>>> math.comb(10, 3)    # Combinations of 10 things taken 3 at a time
120

（由 Yash Aggarwal, Keller Fuchs, Serhiy Storchaka 和 Raymond Hettinger 在 bpo-37128 [https://bugs.python.org/issue?@action=redirect&bpo=37128], bpo-37178 [https://bugs.python.org/issue?@action=redirect&bpo=37178] 和 bpo-35431 [https://bugs.python.org/issue?@action=redirect&bpo=35431] 中贡献。）

添加了一个新函数 math.isqrt() 用于计算精确整数平方根而无需转换为浮点数。 该新函数支持任意大整数。 它的执行速度比 floor(sqrt(n)) 快但是比 math.sqrt() 慢:

>>> r = 650320427
>>> s = r ** 2
>>> isqrt(s - 1)         # correct
650320426
>>> floor(sqrt(s - 1))   # incorrect
650320427

（由 Mark Dickinson 在 bpo-36887 [https://bugs.python.org/issue?@action=redirect&bpo=36887] 中贡献。）

函数 math.factorial() 不再接受非整数类参数。 （由 Pablo Galindo 在 bpo-33083 [https://bugs.python.org/issue?@action=redirect&bpo=33083] 中贡献。）

mmap

mmap.mmap 类现在具有一个 madvise() 方法用于访问 madvise() 系统调用。 （由 Zackery Spytz 在 bpo-32941 [https://bugs.python.org/issue?@action=redirect&bpo=32941] 中贡献。）

multiprocessing

添加了新的 multiprocessing.shared_memory 模块。 （由 Davin Potts 在 bpo-35813 [https://bugs.python.org/issue?@action=redirect&bpo=35813] 中贡献。）

在macOS上，现在默认使用的启动方式是*spawn*启动方式。（由 Victor Stinner 在 bpo-33725 [https://bugs.python.org/issue?@action=redirect&bpo=33725] 中贡献。）

os

在 Windows 上添加了新函数 add_dll_directory() 用于在导入扩展模块或使用 ctypes 加载 DLL 时为本机依赖提供额外搜索路径 。 （由 Steve Dower 在 bpo-36085 [https://bugs.python.org/issue?@action=redirect&bpo=36085] 中贡献。）

添加了新的 os.memfd_create() 函数用于包装 memfd_create() 系统调用。 （由 Zackery Spytz 和 Christian Heimes 在 bpo-26836 [https://bugs.python.org/issue?@action=redirect&bpo=26836] 中贡献。）

在 Windows 上，大部分用于处理重解析点,（包括符号链接和目录连接）的手动逻辑已被委托给操作系统。 特别地，os.stat() 现在将会遍历操作系统所支持的任何内容，而 os.lstat() 将只打开被标识为“名称代理”的重解析点，而其要由 os.stat() 打开其他的重解析点。 在所有情况下，stat_result.st_mode 将只为符号链接而非其他种类的重解析点设置 S_IFLNK。 要标识其他种类的重解析点，请检查新的 stat_result.st_reparse_tag 属性。

在 Windows 上，os.readlink() 现在能够读取目录连接。 请注意 islink() 会对目录连接返回 False，因此首先检查 islink 的代码将连续把连接视为目录，而会处理 os.readlink() 所引发错误的代码现在会把连接视为链接。

（由 Steve Dower 在 bpo-37834 [https://bugs.python.org/issue?@action=redirect&bpo=37834] 中贡献。）

os.path

返回布尔值结果的 os.path 函数例如 exists(), lexists(), isdir(), isfile(), islink(), 以及 ismount() 现在对于包含在 OS 层级无法表示的字符或字节的路径将会返回 False 而不是引发 ValueError 或其子类 UnicodeEncodeError 和 UnicodeDecodeError。 （由 Serhiy Storchaka 在 bpo-33721 [https://bugs.python.org/issue?@action=redirect&bpo=33721] 中贡献。）

expanduser() 在 Windows 上现在改用 USERPROFILE 环境变量而不再使用 HOME，后者通常不会为一般用户账户设置。 （由 Anthony Sottile 在 bpo-36264 [https://bugs.python.org/issue?@action=redirect&bpo=36264] 中贡献。）

isdir() 在 Windows 上将不再为不存在的目录的链接返回 True。

realpath() 在 Windows 上现在会识别重解析点，包括符号链接和目录连接。

（由 Steve Dower 在 bpo-37834 [https://bugs.python.org/issue?@action=redirect&bpo=37834] 中贡献。）

pathlib

返回布尔值结果的 pathlib.Path 方法例如 exists(), is_dir(), is_file(), is_mount(), is_symlink(), is_block_device(), is_char_device(), is_fifo(), is_socket() 现在对于包含在 OS 层级无法表示的字符或字节的路径将会返回 False 而不是引发 ValueError 或其子类 UnicodeEncodeError。 （由 Serhiy Storchaka 在 bpo-33721 [https://bugs.python.org/issue?@action=redirect&bpo=33721] 中贡献。）

增加了 pathlib.Path.link_to() 用于创建指向路径的硬链接。 （由 Joannah Nanjekye 在 bpo-26978 [https://bugs.python.org/issue?@action=redirect&bpo=26978] 中贡献。）

pickle

pickle 扩展子类化针对 C 优化的 Pickler 现在可通过定义特殊的 reducer_override() 方法来重载函数和类的封存逻辑。 （由 Pierre Glaser 和 Olivier Grisel 在 bpo-35900 [https://bugs.python.org/issue?@action=redirect&bpo=35900] 中贡献。）

plistlib

添加了新的 plistlib.UID 并启动了对读取和写入经过 NSKeyedArchiver 编码的二进制 plists 的支持。 （由 Jon Janzen 在 bpo-26707 [https://bugs.python.org/issue?@action=redirect&bpo=26707] 中贡献。）

pprint

pprint 模块为一些函数添加了 sort_dicts 形参。 默认情况下，这些函数会继续在渲染或打印之前对字典进行排序。 但是，如果 sort_dicts 设为假值，则字典将保持键插入时的顺序。 这在调试期间与 JSON 输入进行比较时会很有用。

除此之外，还增加了一个方便的新函数 pprint.pp()，它类似于 pprint.pprint() 但它的 sort_dicts 默认为 False:

>>> from pprint import pprint, pp
>>> d = dict(source='input.txt', operation='filter', destination='output.txt')
>>> pp(d, width=40)                  # Original order
{'source': 'input.txt',
 'operation': 'filter',
 'destination': 'output.txt'}
>>> pprint(d, width=40)              # Keys sorted alphabetically
{'destination': 'output.txt',
 'operation': 'filter',
 'source': 'input.txt'}

（由 Rémi Lapeyre 在 bpo-30670 [https://bugs.python.org/issue?@action=redirect&bpo=30670] 中贡献。）

py_compile

py_compile.compile() 现在支持静默模式。 （由 Joannah Nanjekye 在 bpo-22640 [https://bugs.python.org/issue?@action=redirect&bpo=22640] 中贡献。）

shlex

新增了 shlex.join() 函数作为 shlex.split() 的逆操作。 （由 Bo Bayles 在 bpo-32102 [https://bugs.python.org/issue?@action=redirect&bpo=32102] 中贡献。）

shutil

shutil.copytree() 现在接受新的 dirs_exist_ok 关键字参数。 （由 Josh Bronson 在 bpo-20849 [https://bugs.python.org/issue?@action=redirect&bpo=20849] 中贡献。）

shutil.make_archive() 现在对新的归档默认使用 modern pax (POSIX.1-2001) 格式以提升可移植性和标准一致性，此特性继承自对 tarfile 模块的相应更改。 （由 C.A.M. Gerlach 在 bpo-30661 [https://bugs.python.org/issue?@action=redirect&bpo=30661] 中贡献。）

shutil.rmtree() 在 Windows 上现在会移除目录连接而不会递归地先移除其中的内容。 （由 Steve Dower 在 bpo-37834 [https://bugs.python.org/issue?@action=redirect&bpo=37834] 中贡献。）

socket

添加了便捷的 create_server() 和 has_dualstack_ipv6() 函数以自动化在创建服务器套接字时通常情况下所必须的任务，包括在同一套接字中同时接受 IPv4 和 IPv6 连接。 （由 Giampaolo Rodolà 在 bpo-17561 [https://bugs.python.org/issue?@action=redirect&bpo=17561] 中贡献。）

socket.if_nameindex(), socket.if_nametoindex() 和 socket.if_indextoname() 函数已经在 Windows 上实现。 （由 Zackery Spytz 在 bpo-37007 [https://bugs.python.org/issue?@action=redirect&bpo=37007] 中贡献。）

ssl

增加了 post_handshake_auth 和 verify_client_post_handshake() 分别启用和初始化 TLS 1.3 握手后验证。 （由 Christian Heimes 在 bpo-34670 [https://bugs.python.org/issue?@action=redirect&bpo=34670] 中贡献。）

statistics

添加了 statistics.fmean() 作为 statistics.mean() 的更快速的浮点数版版本。 （由 Raymond Hettinger 和 Steven D'Aprano 在 bpo-35904 [https://bugs.python.org/issue?@action=redirect&bpo=35904] 中贡献。）

添加了 statistics.geometric_mean() （由 Raymond Hettinger 在 bpo-27181 [https://bugs.python.org/issue?@action=redirect&bpo=27181] 中贡献。）

添加了 statistics.multimode() 用于返回最常见值的列表。 （由 Raymond Hettinger 在 bpo-35892 [https://bugs.python.org/issue?@action=redirect&bpo=35892] 中贡献。）

添加了 statistics.quantiles() 用于将数据或分布划分为多个等概率区间（例如四分位、十分位或百分位）。 （由 Raymond Hettinger 在 bpo-36546 [https://bugs.python.org/issue?@action=redirect&bpo=36546] 中贡献。）

添加了 statistics.NormalDist 用于创建和操纵随机变量的正态分布。 （由 Raymond Hettinger 在 bpo-36018 [https://bugs.python.org/issue?@action=redirect&bpo=36018] 中贡献。）

>>> 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)            # Chance of being under 3 degrees
0.3184678262814532
>>> # Relative chance of being 7 degrees versus 10 degrees
>>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
1.2039930378537762

>>> el_niño = NormalDist(4, 2.5)
>>> temperature_feb += el_niño        # Add in a climate effect
>>> temperature_feb
NormalDist(mu=10.0, sigma=6.830080526611674)

>>> temperature_feb * (9/5) + 32      # Convert to Fahrenheit
NormalDist(mu=50.0, sigma=12.294144947901014)
>>> temperature_feb.samples(3)        # Generate random samples
[7.672102882379219, 12.000027119750287, 4.647488369766392]

sys

添加了新的 sys.unraisablehook() 函数，可被重载以便控制如何处理“不可引发的异常”。 它会在发生了一个异常但 Python 没有办法处理时被调用。 例如，当一个析构器在垃圾回收时 (gc.collect()) 所引发的异常。 （由 Victor Stinner 在 bpo-36829 [https://bugs.python.org/issue?@action=redirect&bpo=36829] 中贡献。）

tarfile

tarfile 模块现在对新的归档默认使用 modern pax (POSIX.1-2001) 格式而不再是之前的 GNU 专属格式。 这通过标准化和可扩展格式的统一编码 (UTF-8) 提升了跨平台可移植性，还提供了其他一些益处。 （由 C.A.M. Gerlach 在 bpo-36268 [https://bugs.python.org/issue?@action=redirect&bpo=36268] 中贡献。）

threading

添加了新的 threading.excepthook() 函数用来处理未捕获的 threading.Thread.run() 异常。 它可被重载以便控制如何处理未捕获的 threading.Thread.run() 异常。 （由 Victor Stinner 在 bpo-1230540 [https://bugs.python.org/issue?@action=redirect&bpo=1230540] 中贡献。）

添加了新的 threading.get_native_id() 函数以及 threading.Thread 类的 native_id 属性。 它们会返回内核所分配给当前线程的原生整数线程 ID。 此特性仅在特定平台上可用，参见 get_native_id 了解详情。 （由 Jake Tesler 在 bpo-36084 [https://bugs.python.org/issue?@action=redirect&bpo=36084] 中贡献。）

tokenize

当提供不带末尾新行的输入时，tokenize 模块现在会隐式地添加 NEWLINE 形符。 此行为现在已与 C 词法分析器的内部行为相匹配。 （由 Ammar Askar 在 bpo-33899 [https://bugs.python.org/issue?@action=redirect&bpo=33899] 中贡献。）

tkinter

在 tkinter.Spinbox 中添加了方法 selection_from(), selection_present(), selection_range() 和 selection_to()。 （由 Juliette Monsel 在 bpo-34829 [https://bugs.python.org/issue?@action=redirect&bpo=34829] 中贡献。）

在 tkinter.Canvas 类中添加了方法 moveto()。 （由 Juliette Monsel 在 bpo-23831 [https://bugs.python.org/issue?@action=redirect&bpo=23831] 中贡献。）

tkinter.PhotoImage 类现在具有 transparency_get() 和 transparency_set() 方法。 （由 Zackery Spytz 在 bpo-25451 [https://bugs.python.org/issue?@action=redirect&bpo=25451] 中贡献。）

time

为 macOS 10.12 添加了新的时钟 CLOCK_UPTIME_RAW。 （由 Joannah Nanjekye 在 bpo-35702 [https://bugs.python.org/issue?@action=redirect&bpo=35702] 中贡献。）

typing

typing 模块加入了一些新特性：

一个带有键专属类型的字典类型。 参见 PEP 589 [https://www.python.org/dev/peps/pep-0589] 和 typing.TypedDict。 TypedDict 只使用字符串作为键。 默认情况下每个键都要求提供。 指定 "total=False" 以允许键作为可选项:

class Location(TypedDict, total=False):
    lat_long: tuple
    grid_square: str
    xy_coordinate: tuple

Literal 类型。 参见 PEP 586 [https://www.python.org/dev/peps/pep-0586] 和 typing.Literal。 Literal 类型指明一个形参或返回值被限定为一个或多个特定的字面值:

def get_status(port: int) -> Literal['connected', 'disconnected']:
    ...

"Final" 变量、函数、方法和类。 参见 PEP 591 [https://www.python.org/dev/peps/pep-0591], typing.Final 和 typing.final()。 final 限定符会指示静态类型检查器限制进行子类化、重载或重新赋值:

pi: Final[float] = 3.1415926536

协议定义。 参见 PEP 544 [https://www.python.org/dev/peps/pep-0544], typing.Protocol 和 typing.runtime_checkable()。 简单的 ABC 例如 typing.SupportsInt 现在是 Protocol 的子类。

新的协议类 typing.SupportsIndex。

新的函数 typing.get_origin() 和 typing.get_args()。

unicodedata

unicodedata 模块现在已升级为使用 Unicode 12.1.0 [https://blog.unicode.org/2019/05/unicode-12-1-en.html] 发布版。

新的函数 is_normalized() 可被用来验证字符串是否为特定正规形式，通常会比实际进行字符串正规化要快得多。 （由 Max Belanger, David Euresti 和 Greg Price 在 bpo-32285 [https://bugs.python.org/issue?@action=redirect&bpo=32285] 和 bpo-37966 [https://bugs.python.org/issue?@action=redirect&bpo=37966] 中贡献。）

unittest

添加了 AsyncMock 以支持异步版本的 Mock。 同时也添加了相应的断言函数用于测试。 （由 Lisa Roach 在 bpo-26467 [https://bugs.python.org/issue?@action=redirect&bpo=26467] 中贡献。）

unittest 添加了 addModuleCleanup() 和 addClassCleanup() 以支持对 setUpModule() 和 setUpClass() 进行清理。 （由 Lisa Roach 在 bpo-24412 [https://bugs.python.org/issue?@action=redirect&bpo=24412] 中贡献。）

一些模拟断言函数现在也会在失败时打印一个实际调用列表。 （由 Petter Strandmark 在 bpo-35047 [https://bugs.python.org/issue?@action=redirect&bpo=35047] 中贡献。）

unittest 模块已支持通过 unittest.IsolatedAsyncioTestCase 来使用协程作为测试用例。 （由 Andrew Svetlov 在 bpo-32972 [https://bugs.python.org/issue?@action=redirect&bpo=32972] 中贡献。）

示例:

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()

venv

现在 venv 在所有平台上都会包含 Activate.ps1 脚本用于在 PowerShell Core 6.1 下激活虚拟环境。 （由 Brett Cannon 在 bpo-32718 [https://bugs.python.org/issue?@action=redirect&bpo=32718] 中贡献。）

weakref

由 weakref.proxy() 返回的代理对象现在除其他算术运算符外也支持矩阵乘法运算符 @ 和 @=。 （由 Mark Dickinson 在 bpo-36669 [https://bugs.python.org/issue?@action=redirect&bpo=36669] 中贡献。）

xml

作为对 DTD 和外部实体检索的缓解，在默认情况下 xml.dom.minidom 和 xml.sax 模块不再处理外部实体。 （由 Christian Heimes 在 bpo-17239 [https://bugs.python.org/issue?@action=redirect&bpo=17239] 中贡献。）

xml.etree.ElementTree 模块中的 .find*() 方法支持通配符搜索例如 {*}tag，此搜索会忽略命名空间以及返回给定命名空间中所有标签的 {namespace}*。 （由 Stefan Behnel 在 bpo-28238 [https://bugs.python.org/issue?@action=redirect&bpo=28238] 中贡献。）

xml.etree.ElementTree 模块提供了实现 C14N 2.0 的新函数 –xml.etree.ElementTree.canonicalize()。 （由 Stefan Behnel 在 bpo-13611 [https://bugs.python.org/issue?@action=redirect&bpo=13611] 中贡献。）

xml.etree.ElementTree.XMLParser 的目标对象可通过新的回调方法 start_ns() 和 end_ns() 来接受命名空间声明事件。 此外，xml.etree.ElementTree.TreeBuilder 目标可被配置为处理有关注释和处理指令事件以将它们包含在所生成的树当中。 （由 Stefan Behnel 在 bpo-36676 [https://bugs.python.org/issue?@action=redirect&bpo=36676] 和 bpo-36673 [https://bugs.python.org/issue?@action=redirect&bpo=36673] 中贡献。）

xmlrpc

xmlrpc.client.ServerProxy 现在支持可选的 headers 关键字参数作为随同每次请求发送的 HTTP 标头序列。 此特征的作用之一是使得从默认的基础认证升级到更快速的会话认证成为可能。 （由 Cédric Krier 在 bpo-35153 [https://bugs.python.org/issue?@action=redirect&bpo=35153] 中贡献。）

性能优化

subprocess 模块现在能在某些情况下使用 os.posix_spawn() 函数以获得更好的性能。 目前，它的使用仅限 macOS 和 Linux（使用 glibc 2.24 或更新版本），并要求满足以下条件：

close_fds 为假值；

preexec_fn, pass_fds, cwd 和 start_new_session 形参未设置；

executable 路径包含一个目录。

（由 Joannah Nanjekye 和 Victor Stinner 在 bpo-35537 [https://bugs.python.org/issue?@action=redirect&bpo=35537] 中贡献。）

shutil.copyfile(), shutil.copy(), shutil.copy2(), shutil.copytree() 和 shutil.move() 在 Linux 和 macOS 上会使用平台专属的 "fast-copy" 系统调用以提高效率。 "fast-copy" 意味着拷贝操作发生于内核中，从而避免在进行 "outfd.write(infd.read())" 等操作时使用 Python 中的用户空间缓冲区。 在 Windows 上 shutil.copyfile() 会使用更大的默认缓冲区（1 MiB 而不是 16 KiB）并且使用基于 memoryview() 的 shutil.copyfileobj() 版本。 在同一分区内拷贝一个 512 MiB 文件的速度提升在 Linux 上约为 +26%，在 macOS 上为 +50%，在 Windows 上为 +40%。 此外还将消耗更少的 CPU 周期。 参见 依赖于具体平台的高效拷贝操作 一节。 （由 Giampaolo Rodolà 在 bpo-33671 [https://bugs.python.org/issue?@action=redirect&bpo=33671] 中贡献。）

shutil.copytree() 会根据其所用缓存的 os.stat() 值使用 os.scandir() 函数及所有拷贝函数。 拷贝一个包含 8000 文件的目录的速度提升在 Linux 上约为 +9%，在 Windows 上为 +20%，对于 Windows SMB 共享目录则为 +30%。 此外 os.stat() 系统调用的次数也减少了 38%，使得 shutil.copytree() 在网络文件系统上会特别快速。 （由Giampaolo Rodolà 在 bpo-33695 [https://bugs.python.org/issue?@action=redirect&bpo=33695] 中贡献。）

pickle 模块使用的默认协议现在为 Protocol 4，最早在 Python 3.4 中被引入。 它提供了比自 Python 3.0 起可用的 Protocol 3 更好的性能和更小的数据尺寸。

从 PyGC_Head 移除了一个 Py_ssize_t 成员。 所有跟踪 GC 的对象（例如 tuple, list, dict）大小减少了 4 或 8 字节。 （由 Inada Naoki 在 bpo-33597 [https://bugs.python.org/issue?@action=redirect&bpo=33597] 中贡献。）

uuid.UUID 现在会使用 __slots__ 以减少内存足迹。 （由 Wouter Bolsterlee 和 Tal Einat 在 bpo-30977 [https://bugs.python.org/issue?@action=redirect&bpo=30977] 中贡献。）

operator.itemgetter() 的性能提升了 33%。 优化了参数处理，并为常见的在元组中单个非负整数索引的情况新增了一条快速路径（这是标准库中的典型用例）。 （由 Raymond Hettinger 在 bpo-35664 [https://bugs.python.org/issue?@action=redirect&bpo=35664] 中贡献。

加快了在 collections.namedtuple() 中的字段查找。 它们现在的速度快了两倍以上，成为 Python 中最快的实例变量查找形式。 （由 Raymond Hettinger, Pablo Galindo 和 Joe Jevnik, Serhiy Storchaka 在 bpo-32492 [https://bugs.python.org/issue?@action=redirect&bpo=32492] 中贡献。）

如果输入的可迭代对象的长度已知 (即输入对象实现了 __len__)，list 构造器不会过度分配内部项缓冲区。 这使得所创建的列表资源占用平均减少了 12%。 （由 Raymond Hettinger 和 Pablo Galindo 在 bpo-33234 [https://bugs.python.org/issue?@action=redirect&bpo=33234] 中贡献。）

类变量写入速度加倍。 当一个非冗余属性被更新时，之前存在一个更新 slots 的非必要调用。 （由 Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger, Neil Schemenauer, 和 Serhiy Storchaka 在 bpo-36012 [https://bugs.python.org/issue?@action=redirect&bpo=36012] 中贡献。）

减少了传递给许多内置函数和方法的参数转换的开销。 这使得某些简单内置函数和方法的速度提升了 20--50%。 （由 Serhiy Storchaka 在 bpo-23867 [https://bugs.python.org/issue?@action=redirect&bpo=23867], bpo-35582 [https://bugs.python.org/issue?@action=redirect&bpo=35582] 和 bpo-36127 [https://bugs.python.org/issue?@action=redirect&bpo=36127] 中贡献。）

LOAD_GLOBAL 指令现在会使用新的 "per opcode cache" 机制。 它的速度现在提升了大约 40%。 （由 Yury Selivanov 和 Inada Naoki 在 bpo-26219 [https://bugs.python.org/issue?@action=redirect&bpo=26219] 中贡献。）

构建和 C API 的改变

默认的 sys.abiflags 成为一个空字符串：pymalloc 的 m 旗标不再有意义（无论是否启用 pymalloc 构建都是兼容 ABI 的）因此已被移除。 （由 Victor Stinner 在 bpo-36707 [https://bugs.python.org/issue?@action=redirect&bpo=36707] 中贡献。）

改变的例子：

只会安装 python3.8 程序，不再有 python3.8m 程序。

只会安装 python3.8-config 脚本，不再有 python3.8m-config 脚本。

m 旗标已经从动态库文件名后缀中移除：包括标准库中的扩展模块以及第三方包所产生和安装的模块例如从 PyPI 下载的模块。 以 Linux 为例，Python 3.7 的后缀 .cpython-37m-x86_64-linux-gnu.so 在 Python 3.8 中改为 .cpython-38-x86_64-linux-gnu.so。

重新组织了所有头文件以更好地区分不同种类的 API：

Include/*.h 应为可移植的公有稳定版 C API。

Include/cpython/*.h 应为 CPython 专属的不稳定版 C API；公有 API，部分私有 API 附加 _Py or _PY 前缀。

Include/internal/*.h 应为 CPython 特别专属的私有内部 C API。 此 API 不具备向下兼容保证并且不应在 CPython 以外被使用。 它们的公开仅适用于特别限定的需求例如调试器和性能分析等必须直接访问 CPython 内部数据而不通过调用函数的应用。 此 API 现在是通过 make install 安装的。

（由 Victor Stinner 在 bpo-35134 [https://bugs.python.org/issue?@action=redirect&bpo=35134] 和 bpo-35081 [https://bugs.python.org/issue?@action=redirect&bpo=35081] 中贡献，相关工作由 Eric Snow 在 Python 3.7 中发起。）

某些宏已被转换为静态内联函数：形参类型和返回类型定义良好，它们不再会有与宏相关的问题，变量具有局部作用域。 例如：

Py_INCREF(), Py_DECREF()

Py_XINCREF(), Py_XDECREF()

PyObject_INIT(), PyObject_INIT_VAR()

私有函数: _PyObject_GC_TRACK(), _PyObject_GC_UNTRACK(), _Py_Dealloc()

（由 Victor Stinner 在 bpo-35059 [https://bugs.python.org/issue?@action=redirect&bpo=35059] 中贡献。）

PyByteArray_Init() 和 PyByteArray_Fini() 函数已被移除。 它们自 Python 2.7.4 和 Python 3.2.0 起就没有任何用处，被排除在受限 API (稳定版 ABI) 之外，并且未被写入文档。 （由 Victor Stinner 在 bpo-35713 [https://bugs.python.org/issue?@action=redirect&bpo=35713] 中贡献。）

PyExceptionClass_Name() 的结果类型现在是 const char * 而非 char *。 （由 Serhiy Storchaka 在 bpo-33818 [https://bugs.python.org/issue?@action=redirect&bpo=33818] 中贡献。）

Modules/Setup.dist 与 Modules/Setup 两者的共存已被移除。 之前在更新 CPython 源码树时，开发者必须手动拷贝 Modules/Setup.dist (在源码树内) 到 Modules/Setup (在构建树内) 以反映上游的任何改变。 旧特性对打包者来说有一点益处，但代价是对追踪 CPython 开发进程的开发者造成经常性的麻烦，因为忘记拷贝该文件可能导致构建失败。

现在构建系统总是会从源码树内的 Modules/Setup 读取数据。 建议希望定制该文件的开发者在 CPython 的一个 git 分叉或补丁文件中维护他们的更改，就如他们对源码树做任何其他改变时一样。

（由 Antoine Pitrou 在 bpo-32430 [https://bugs.python.org/issue?@action=redirect&bpo=32430] 中贡献。）

将 Python 数字转换为 C 整型的函数例如 PyLong_AsLong() 以及带有 'i' 之类整型转换格式单元的参数解析函数例如 PyArg_ParseTuple() 现在如果可能将会使用 __index__() 特殊方法而不是 __int__()。 对于带有 __int__() 方法但没有 __index__() 方法的对象 (例如 Decimal 和 Fraction) 将会发出弃用警告。 对于实现了 __index__() 的对象 PyNumber_Check() 现在将返回 1。 PyNumber_Long(), PyNumber_Float() 和 PyFloat_AsDouble() 现在如果可能也将会使用 __index__() 方法。 （由 Serhiy Storchaka 在 bpo-36048 [https://bugs.python.org/issue?@action=redirect&bpo=36048] 和 bpo-20092 [https://bugs.python.org/issue?@action=redirect&bpo=20092] 中贡献。）

堆分配类型对象现在将增加它们在 PyObject_Init() (及其对应的宏 PyObject_INIT) 中的引用计数而不是在 PyType_GenericAlloc() 中。 修改实例分配或中止分配的类型可能需要进行调整。 （由 Elizondo 在 bpo-35810 [https://bugs.python.org/issue?@action=redirect&bpo=35810] 中贡献。）

新增函数 PyCode_NewWithPosOnlyArgs() 允许创建代码对象例如 PyCode_New()，但带有一个额外的 posonlyargcount 形参以指明仅限位置参数的数量。 （由 Pablo Galindo 在 bpo-37221 [https://bugs.python.org/issue?@action=redirect&bpo=37221] 中贡献。）

Py_SetPath() 现在会将 sys.executable 设为程序完整路径 (Py_GetProgramFullPath()) 而不是程序名称 (Py_GetProgramName())。 （由 Victor Stinner 在 bpo-38234 [https://bugs.python.org/issue?@action=redirect&bpo=38234] 中贡献。）

弃用

distutils 的 bdist_wininst 命令现在已弃用，请改用 bdist_wheel (wheel 包)。 （由 Victor Stinner 在 bpo-37481 [https://bugs.python.org/issue?@action=redirect&bpo=37481] 中贡献。）

ElementTree 模块中的已弃用方法 getchildren() 和 getiterator() 现在会引发 DeprecationWarning 而不是 PendingDeprecationWarning。 它们将在 Python 3.9 中被移除。 （由 Serhiy Storchaka 在 bpo-29209 [https://bugs.python.org/issue?@action=redirect&bpo=29209] 中贡献。）

将不是 concurrent.futures.ThreadPoolExecutor 的实例的对象传给 loop.set_default_executor() 已被弃用，并将在 Python 3.9 中被禁止。 （由 Elvis Pranskevichus 在 bpo-34075 [https://bugs.python.org/issue?@action=redirect&bpo=34075] 中贡献。）

xml.dom.pulldom.DOMEventStream, wsgiref.util.FileWrapper 和 fileinput.FileInput 的 __getitem__() 方法已被弃用。

这些方法的实现会忽略它们的 index 形参，并改为返回下一条目。 （由 Berker Peksag 在 bpo-9372 [https://bugs.python.org/issue?@action=redirect&bpo=9372] 中贡献。）

typing.NamedTuple 类已弃用了 _field_types 属性而改用具有同样信息的 __annotations__ 属性。 （由 Raymond Hettinger 在 bpo-36320 [https://bugs.python.org/issue?@action=redirect&bpo=36320] 中贡献。）

ast 类 Num, Str, Bytes, NameConstant 和 Ellipsis 被视为已弃用并将在未来的 Python 版本中被移除。 应当改用 Constant。 （由 Serhiy Storchaka 在 bpo-32892 [https://bugs.python.org/issue?@action=redirect&bpo=32892] 中贡献。）

ast.NodeVisitor 的方法 visit_Num(), visit_Str(), visit_Bytes(), visit_NameConstant() 和 visit_Ellipsis() 现在已被弃用，并且在未来的 Python 版本中将不再被调用。 添加 visit_Constant() 方法来处理所有常量节点。 （由 Serhiy Storchaka 在 bpo-36917 [https://bugs.python.org/issue?@action=redirect&bpo=36917] 中贡献。）

asyncio.coroutine() decorator 已弃用并将在 3.10 版中被移除。 原有的 @asyncio.coroutine 请改用 async def 来替代。 （由 Andrew Svetlov 在 bpo-36921 [https://bugs.python.org/issue?@action=redirect&bpo=36921] 中贡献。）

在 asyncio 中，loop 参数的显式传递已被弃用并且到 3.10 版时将会在以下函数中被移除: asyncio.sleep(), asyncio.gather(), asyncio.shield(), asyncio.wait_for(), asyncio.wait(), asyncio.as_completed(), asyncio.Task, asyncio.Lock, asyncio.Event, asyncio.Condition, asyncio.Semaphore, asyncio.BoundedSemaphore, asyncio.Queue, asyncio.create_subprocess_exec() 以及 asyncio.create_subprocess_shell()。

将协程对象显式传递给 asyncio.wait() 的做法已被弃用并且将在 3.11 版中被移除。 （由 Yury Selivanov 在 bpo-34790 [https://bugs.python.org/issue?@action=redirect&bpo=34790] 中贡献。）

gettext 模块中的下列函数和方法已被弃用: lgettext(), ldgettext(), lngettext() 和 ldngettext()。 它们返回已编码的字节串，如果转换后的字符串存在编码问题你将可能遭遇预期之外的异常。 更好的做法是使用 Python 3 中返回 Unicode 字符串的操作作为替代。 前面的函数都早已不宜使用。

函数 bind_textdomain_codeset()，方法 output_charset() 和 set_output_charset()，以及函数 translation() 和 install() 的 codeset 形参也已被弃用，因为它们仅适用于 l*gettext() 函数。 （由 Serhiy Storchaka 在 bpo-33710 [https://bugs.python.org/issue?@action=redirect&bpo=33710] 中贡献。）

threading.Thread 的 isAlive() 方法已弃用。 （由 Dong-hee Na 在 bpo-35283 [https://bugs.python.org/issue?@action=redirect&bpo=35283] 中贡献。）

许多接受整数参数的内置和扩展模块的函数现在将对传入 Decimal, Fraction 以及任何其他可被转换为整数但会丢失精度（即具有 __int__() 方法但没有 __index__() 方法）的对象发出弃用警告。 在未来的版本中则将报错。 （由 Serhiy Storchaka 在 bpo-36048 [https://bugs.python.org/issue?@action=redirect&bpo=36048] 中贡献。）

以下参数作为关键字参数传递的方式已被弃用：

functools.partialmethod(), weakref.finalize(), profile.Profile.runcall(), cProfile.Profile.runcall(), bdb.Bdb.runcall(), trace.Trace.runfunc() 与 curses.wrapper() 中的 func。

unittest.TestCase.addCleanup() 中的 function。

concurrent.futures.ThreadPoolExecutor 和 concurrent.futures.ProcessPoolExecutor 的 submit() 方法中的 fn。

contextlib.ExitStack.callback(), contextlib.AsyncExitStack.callback() 和 contextlib.AsyncExitStack.push_async_callback() 中的 callback。

multiprocessing.managers.Server 和 multiprocessing.managers.SharedMemoryServer 的 create() 方法中的 c 和 typeid。

weakref.finalize() 中的 obj。

在未来版本的 Python 中，它们将成为 仅限位置参数。 （由 Serhiy Storchaka 在 bpo-36492 [https://bugs.python.org/issue?@action=redirect&bpo=36492] 中贡献。）

API 与特性的移除

下列特性与 API 已从 Python 3.8 中移除：

自 Python 3.3 起，从 collections 导入 ABC 的做法已弃用，而应当从 collections.abc 执行导入。 从 collections 导入的操作在 3.8 中已标记为被移除，但将推迟到 3.9 中实施。 （参见 bpo-36952 [https://bugs.python.org/issue?@action=redirect&bpo=36952]。）

macpath 模块，在 Python 3.7 中弃用，现已被移除。 （由 Victor Stinner 在 bpo-35471 [https://bugs.python.org/issue?@action=redirect&bpo=35471] 中贡献。）

函数 platform.popen() 已被移除，它自 Python 3.3 起就已被弃用：请改用 os.popen()。 （由 Victor Stinner 在 bpo-35345 [https://bugs.python.org/issue?@action=redirect&bpo=35345] 中贡献。）

函数 time.clock() 已被移除，它自 Python 3.3 起就已被弃用：请根据具体需求改用 time.perf_counter() 或 time.process_time() 以获得具有良好定义的行为。 （由 Matthias Bussonnier 在 bpo-36895 [https://bugs.python.org/issue?@action=redirect&bpo=36895] 中贡献。）

pyvenv 脚本已被移除，推荐改用 python3.8 -m venv 来帮助消除容易混淆 pyvenv 脚本所关联的 Python 解释器这一问题。 （由 Brett Cannon 在 bpo-25427 [https://bugs.python.org/issue?@action=redirect&bpo=25427] 中贡献。）

parse_qs, parse_qsl 和 escape 已从 cgi 模块中被移除。 这些函数自 Python 3.2 或更早就已被弃用。 它们应改为从 urllib.parse 和 html 模块导入。

filemode 函数已从 tarfile 模块中被移除。 该函数未被写入文档，自 Python 3.3 起就已弃用。

XMLParser 构造器不再接受 html 参数。 它从来没有任何作用并在 Python 3.4 中已被弃用。 所有其他形参现在都是 仅限关键字参数。 （由 Serhiy Storchaka 在 bpo-29209 [https://bugs.python.org/issue?@action=redirect&bpo=29209] 中贡献。）

XMLParser 的 doctype() 方法已被移除。 （由 Serhiy Storchaka 在 bpo-29209 [https://bugs.python.org/issue?@action=redirect&bpo=29209] 中贡献。）

"unicode_internal" 编解码器已被移除。 （由 Inada Naoki 在 bpo-36297 [https://bugs.python.org/issue?@action=redirect&bpo=36297] 中贡献。）

sqlite3 模块的 Cache 和 Statement 对象已不再公开给用户。 （由 Aviv Palivoda 在 bpo-30262 [https://bugs.python.org/issue?@action=redirect&bpo=30262] 中贡献。）

fileinput.input() 和 fileinput.FileInput() 中自 Python 3.6 起就已被忽略并弃用的 bufsize 关键字参数已被移除。 由 Matthias Bussonnier 在 bpo-36952 [https://bugs.python.org/issue?@action=redirect&bpo=36952] 中贡献。）

在 Python 3.7 中弃用的函数 sys.set_coroutine_wrapper() 和 sys.get_coroutine_wrapper() 已被移除。 （由 Matthias Bussonnier 在 bpo-36933 [https://bugs.python.org/issue?@action=redirect&bpo=36933] 中贡献。）

移植到 Python 3.8

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

Python 行为的改变

yield 表达式（包括 yield 和 yield from 子句）现在不允许在推导式和生成器表达式中使用（但最左边的 for 子句中的可迭代对象表达式除外）。 （由 Serhiy Storchaka 在 bpo-10544 [https://bugs.python.org/issue?@action=redirect&bpo=10544] 中贡献。）

当标识号检测 (is 和 is not) 与特定类型的字面值 (例如字符串和数字) 一同使用时编译器现在会产生 SyntaxWarning。 这在 CPython 中通常是可行的，但并不被语言定义所保证。 该警告会建议用户改用相等性检测 (== and !=)。 （由 Serhiy Storchaka 在 bpo-34850 [https://bugs.python.org/issue?@action=redirect&bpo=34850] 中贡献。）

CPython 解释器在某些情况下可以忽略异常。 在 Python 3.8 中这种情况会更少发生。 特别地，从类型字典获取属性时引发的异常不会再被忽略。 （由 Serhiy Storchaka 在 bpo-35459 [https://bugs.python.org/issue?@action=redirect&bpo=35459] 中贡献。）

从内置类型 bool, int, float, complex 和标准库的一些类中移除了 __str__ 实现。 它们现在会从 object 继承 __str__()。 作为结果，在这些类的子类中定义 __repr__() 方法将会影响它们的字符串表示。 （由 Serhiy Storchaka 在 bpo-36793 [https://bugs.python.org/issue?@action=redirect&bpo=36793] 中贡献。）

在 AIX 上，sys.platform 将不再包含主要版本号。 它将总是 'aix' 而不再是 'aix3' .. 'aix7'。 由于较旧的 Python 版本会包含该版本号，因此推荐总是使用 sys.platform.startswith('aix')。 （由 M. Felt 在 bpo-36588 [https://bugs.python.org/issue?@action=redirect&bpo=36588] 中贡献。）

现在 PyEval_AcquireLock() 和 PyEval_AcquireThread() 如果当解释器终结化时被调用将会终结当前线程，以使它们与 PyEval_RestoreThread(), Py_END_ALLOW_THREADS() 以及 PyGILState_Ensure() 保持一致。 如果不想要这样的行为，请通过检测 _Py_IsFinalizing() 或 sys.is_finalizing() 来保护该调用。 （由 Joannah Nanjekye 在 bpo-36475 [https://bugs.python.org/issue?@action=redirect&bpo=36475] 中贡献。）

Python API 的变化

在 Windows 上 os.getcwdb() 函数现在会使用 UTF-8 编码格式而不是 ANSI 代码页：请参看 PEP 529 [https://www.python.org/dev/peps/pep-0529] 了解具体原因。 该函数在 Windows 上不再被弃用。 （由 Victor Stinner 在 bpo-37412 [https://bugs.python.org/issue?@action=redirect&bpo=37412] 中贡献。）

现在 subprocess.Popen 在某些情况下会使用 os.posix_spawn() 以获得更好的性能。 在适用于 Linux 的 Windows 子系统和 QEMU 用户模拟器上，使用 os.posix_spawn() 的 Popen 构造器不会再因为“找不到程序”这样的错误引发异常。 而是让子进程失败并返回一个非零的 returncode。 （由 Joannah Nanjekye 和 Victor Stinner 在 bpo-35537 [https://bugs.python.org/issue?@action=redirect&bpo=35537] 中贡献。）

The preexec_fn argument of * subprocess.Popen is no longer compatible with subinterpreters. The use of the parameter in a subinterpreter now raises RuntimeError. (Contributed by Eric Snow in bpo-34651 [https://bugs.python.org/issue?@action=redirect&bpo=34651], modified by Christian Heimes in bpo-37951 [https://bugs.python.org/issue?@action=redirect&bpo=37951].)

imap.IMAP4.logout() 方法不会再静默地忽略任意异常。 （由 Victor Stinner 在 bpo-36348 [https://bugs.python.org/issue?@action=redirect&bpo=36348] 中贡献。）

函数 platform.popen() 已被移除，它自 Python 3.3 起就已被弃用：请改用 os.popen()。 （由 Victor Stinner 在 bpo-35345 [https://bugs.python.org/issue?@action=redirect&bpo=35345] 中贡献。）

当传入多模数据时 statistics.mode() 函数不会再引发异常。 它将改为返回在输入数据中遇到的第一个模式。 （由 Raymond Hettinger 在 bpo-35892 [https://bugs.python.org/issue?@action=redirect&bpo=35892] 中贡献。）

tkinter.ttk.Treeview 类的 selection() 方法不再接受参数。 带参数调用该方法来改变选择在 Python 3.6 中已弃用。 请使用专门方法例如 selection_set() 来改变选择。 （由 Serhiy Storchaka 在 bpo-31508 [https://bugs.python.org/issue?@action=redirect&bpo=31508] 中贡献。）

xml.dom.minidom 的 writexml(), toxml() 和 toprettyxml() 方法以及 xml.etree 的 write() 方法现在会保留用户指定的属性顺序。 （由 Diego Rojas 和 Raymond Hettinger 在 bpo-34160 [https://bugs.python.org/issue?@action=redirect&bpo=34160] 中贡献。）

附带 'r' 旗标打开的 dbm.dumb 数据库现在将是只读的。 如果数据库不存在，附带 'r' 和 'w' 旗标的 dbm.dumb.open() 不会再创建数据库。 （由 Serhiy Storchaka 在 bpo-32749 [https://bugs.python.org/issue?@action=redirect&bpo=32749] 中贡献。）

在 XMLParser 的子类中定义的 doctype() 方法将不会再被调用，并将导致发出 RuntimeWarning 而不是 DeprecationWarning。 请在目标上定义 doctype() 方法来处理 XML doctype 声明。 （由 Serhiy Storchaka 在 bpo-29209 [https://bugs.python.org/issue?@action=redirect&bpo=29209] 中贡献。）

现在当自定义元类未在传给 type.__new__ 的命名空间中提供 __classcell__ 入口时将引发 RuntimeError。 在 Python 3.6--3.7 中是则是引发 DeprecationWarning。 （由 Serhiy Storchaka 在 bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722] 中贡献。）

cProfile.Profile 类现在可被用作上下文管理器。 （由 Scott Sanderson 在 bpo-29235 [https://bugs.python.org/issue?@action=redirect&bpo=29235] 中贡献。）

shutil.copyfile(), shutil.copy(), shutil.copy2(), shutil.copytree() 和 shutil.move() 会使用平台专属的 "fast-copy" 系统调用（参见 依赖于具体平台的高效拷贝操作 一节）。

shutil.copyfile() 在 Windows 上的默认缓冲区大小从 16 KiB 改为 1 MiB。

PyGC_Head 结构已被完全改变。 所有接触到该结构的代码都应当被重写。 （参见 bpo-33597 [https://bugs.python.org/issue?@action=redirect&bpo=33597]。）

PyInterpreterState 结构已被移入 "internal" 头文件（特别是 Include/internal/pycore_pystate.h）。 不透明的 PyInterpreterState 作为仅有 API（以及稳定版 ABI）的一部分仍然可用。 文档指明该结构的任何字段都不是公有的，因此我们希望没人在使用它们。 但是，如果你确实依赖其中某一个或更多个私有字段并且没有其他替代选项，则请开一个 BPO 问题。 我们将尽力帮助你进行调整（可能包括向公有 API 添加访问器函数）。 （参见 bpo-35886 [https://bugs.python.org/issue?@action=redirect&bpo=35886]。）

现在所有平台下的 mmap.flush() 方法都会在成功时返回 None 并在错误时引发异常。 之前它的行为取决于具体平台： Windows 下会在成功时返回非零值；在失败时返回零。 Unix 下会在成功时返回零；在失败时引发错误。 （由 Berker Peksag 在 bpo-2122 [https://bugs.python.org/issue?@action=redirect&bpo=2122] 中贡献。）

xml.dom.minidom 和 xml.sax 模块默认将不再处理外部实体。 （由 Christian Heimes 在 bpo-17239 [https://bugs.python.org/issue?@action=redirect&bpo=17239] 中贡献。）

从只读的 dbm 数据库 (dbm.dumb, dbm.gnu 或 dbm.ndbm) 删除键将会引发 error (dbm.dumb.error, dbm.gnu.error 或 dbm.ndbm.error) 而不是 KeyError。 （由 Xiang Zhang 在 bpo-33106 [https://bugs.python.org/issue?@action=redirect&bpo=33106] 中贡献。）

简化了字面值的 AST。 所有常量将被表示为 ast.Constant 的实例。 实例化旧类 Num, Str, Bytes, NameConstant 和 Ellipsis 都将返回 Constant 的实例。 （由 Serhiy Storchaka 在 bpo-32892 [https://bugs.python.org/issue?@action=redirect&bpo=32892] 中贡献。）

expanduser() 在 Windows 上现在改用 USERPROFILE 环境变量而不再使用 HOME，后者通常不会为一般用户账户设置。 （由 Anthony Sottile 在 bpo-36264 [https://bugs.python.org/issue?@action=redirect&bpo=36264] 中贡献。）

异常 asyncio.CancelledError 现在继承自 BaseException 而不是 Exception 并且不再继承自 concurrent.futures.CancelledError。 （由 Yury Selivanov 在 bpo-32528 [https://bugs.python.org/issue?@action=redirect&bpo=32528] 中贡献。）

当使用 asyncio.Task 的实例时，函数 asyncio.wait_for() 现在会正确地等待撤销。 在此之前当达到 timeout 时，它会被撤销并立即返回。 （由 Elvis Pranskevichus 在 bpo-32751 [https://bugs.python.org/issue?@action=redirect&bpo=32751] 中贡献。）

当将 'socket' 作为 name 形参传入时，函数 asyncio.BaseTransport.get_extra_info() 现在会返回一个可安全使用的套接字对象。 （由 Yury Selivanov 在 bpo-37027 [https://bugs.python.org/issue?@action=redirect&bpo=37027] 中贡献。）

asyncio.BufferedProtocol 已经晋级为稳定 API。

在 Windows 上对扩展模块的 DLL 依赖以及通过 ctypes 加载的 DLL 的解析现在将更为安全。 只有系统路径、包含相信 DLL 或 PYD 文件的路径以及通过 add_dll_directory() 添加的目录才会被作为加载时依赖的搜索位置。 特别地，PATH 和当前工作目录将不再被使用，对它们的修改将不再对正常的 DLL 解析产生影响。 如果你的应用依赖于这些机制，你应当先检查 add_dll_directory()，如果它存在就用它在加载你的库时添加你的 DLL 目录。 请注意 Windows 7 用户还需要确保 Windows 更新包 KB2533623 已安装（这一点也会由安装器进行验证）。 （由 Steve Dower 在 bpo-36085 [https://bugs.python.org/issue?@action=redirect&bpo=36085] 中贡献。）

关联到 pgen 的头文件和函数在其被纯 Python 实现取代后已被移除。 （由 Pablo Galindo 在 bpo-36623 [https://bugs.python.org/issue?@action=redirect&bpo=36623] 中贡献。）

types.CodeType 在构造器的第二个位置新增了一个形参 (posonlyargcount) 以支持在 PEP 570 [https://www.python.org/dev/peps/pep-0570] 中定义的仅限位置参数。 第一个参数 (argcount) 现在表示位置参数的总数量 (包括仅限位置参数)。 types.CodeType 中新增的 replace() 方法可用于让代码支持 future 特性。

hmac.new() 的 digestmod 形参不再默认使用 MD5 摘要。

C API 的变化

PyCompilerFlags 结构体增加了一个新的 cf_feature_version 字段。 它应当被初始化为 PY_MINOR_VERSION。 该字段默认会被忽略，当且仅当在 cf_flags 中设置了 PyCF_ONLY_AST 旗标时才会被使用。 （由 Guido van Rossum 在 bpo-35766 [https://bugs.python.org/issue?@action=redirect&bpo=35766] 中贡献。）

PyEval_ReInitThreads() 函数已从 C API 中移除。 它不应当被显式地调用；请改用 PyOS_AfterFork_Child()。 （由 Victor Stinner 在 bpo-36728 [https://bugs.python.org/issue?@action=redirect&bpo=36728] 中贡献。）

在 Unix 上，C 扩展不会再被链接到 libpython，但 Android 和 Cygwin 例外。 当 Python 被嵌入时，libpython 不可使用 RTLD_LOCAL 加载，而要改用 RTLD_GLOBAL。 之前使用 RTLD_LOCAL 已经不可能加载未链接到 libpython 的 C 扩展了，例如通过 Modules/Setup 的 *shared* 部分构建的标准库 C 扩展。 （由 Victor Stinner 在 bpo-21536 [https://bugs.python.org/issue?@action=redirect&bpo=21536] 中贡献。）

在解析或构建值时（例如 PyArg_ParseTuple(), Py_BuildValue(), PyObject_CallFunction() 等等）使用形如 # 的格式而不定义 PY_SSIZE_T_CLEAN 现在将会引发 DeprecationWarning。 它将在 3.10 或 4.0 中被移除。 请参阅 解析参数并构建值变量 了解详情。 （由 Inada Naoki 在 bpo-36381 [https://bugs.python.org/issue?@action=redirect&bpo=36381] 中贡献。）

堆分配类型的实例（例如使用 PyType_FromSpec() 创建的实例）会保存一个对其类型对象的引用。 提升这些类型对象引用计数的操作已从 PyType_GenericAlloc() 移至更低层级的函数 PyObject_Init() 和 PyObject_INIT()。 这使用通过This makes types created through PyType_FromSpec() 所创建类型的行为与管理代码中的其他类保持一致。

静态分配类型 将不受影响。

在大部分情况下，这应该都不会有附带影响。 但是，在分配实例后手动提升引用计数的类型（也许是为了绕过漏洞）现在可能永远不会被销毁。 要避免这种情况，这些类需要在实例撤销分配期间在类型对象上调用 Py_DECREF。

要正确地将这些类型移植到 3.8，请应用以下修改：

在分配实例之后在类型对象上移除 Py_INCREF —— 如果有的话。 这可以发生在调用 PyObject_New(), PyObject_NewVar(), PyObject_GC_New(), PyObject_GC_NewVar() 或任何其他使用 PyObject_Init() 或 PyObject_INIT() 的自定义分配器之后。

示例:

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;
}

确保所有堆分配类型的自定义 tp_dealloc 函数会减少类型的引用计数。

示例:

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
}

（由 Eddie Elizondo 在 bpo-35810 [https://bugs.python.org/issue?@action=redirect&bpo=35810] 中贡献。）

Py_DEPRECATED() 宏已经针对 MSVC 实现。 这个宏现在必须放在符号名称之前。

示例:

Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);

（由 Zackery Spytz 在 bpo-33407 [https://bugs.python.org/issue?@action=redirect&bpo=33407] 中贡献。）

解释器将不再假装支持跨发布版本的扩展类型二进制兼容性。 由第三方扩展模块所导出的 PyTypeObject 应该具有当前 Python 版本所要求的所有空位，包括 tp_finalize (Py_TPFLAGS_HAVE_FINALIZE 不会再在读取 tp_finalize 之前被检查)。

（由 Antoine Pitrou 在 bpo-32388 [https://bugs.python.org/issue?@action=redirect&bpo=32388] 中贡献。）

函数 PyNode_AddChild() 和 PyParser_AddToken() 现在接受两个额外的 int 参数 end_lineno 和 end_col_offset。

允许 MinGW 工具直接链接到 python38.dll 的 libpython38.a 文件已不再包含于标准的 Windows 分发包中。 如果你需要此文件，可使用 gendef 和 dlltool 工具来生成它，这些工具是 MinGW binutils 包的一部分：

gendef - python38.dll > tmp.def
dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a

已安装的 pythonXY.dll 所在位置将取决于安装选项以及 Windows 的版本和语言。 请参阅 在Windows上使用 Python 了解更多信息。 该结果库应当放在与 pythonXY.lib 相同的目录下，这通常是你的 Python 安装路径下的 libs 目录。

（由 Steve Dower 在 bpo-37351 [https://bugs.python.org/issue?@action=redirect&bpo=37351] 中贡献。）

CPython 字节码的改变

解释器循环已通过将块堆栈展开逻辑移入编译器获得了简化。 编译器现在会发出显式指令来调整值堆栈并为 break, continue 和 return 调用清除代码。

移除了操作码 BREAK_LOOP, CONTINUE_LOOP, SETUP_LOOP 和 SETUP_EXCEPT。 添加了新的操作码 ROT_FOUR, BEGIN_FINALLY, CALL_FINALLY 和 POP_FINALLY。 修改了 END_FINALLY 和 WITH_CLEANUP_START 的行为。

（由 Mark Shannon, Antoine Pitrou 和 Serhiy Storchaka 在 bpo-17611 [https://bugs.python.org/issue?@action=redirect&bpo=17611] 中贡献。）

添加了新的操作码 END_ASYNC_FOR 用于处理当等待 async for 循环的下一项时引发的异常。 （由 Serhiy Storchaka 在 bpo-33041 [https://bugs.python.org/issue?@action=redirect&bpo=33041] 中贡献。）

MAP_ADD 现在会预期值为栈的第一个元素而键为第二个元素。 作出此改变以使得字典推导式能如 PEP 572 [https://www.python.org/dev/peps/pep-0572] 所提议的那样，键总是会在值之前被求值。 （由 Jörn Heissler 在 bpo-35224 [https://bugs.python.org/issue?@action=redirect&bpo=35224] 中贡献。）

演示和工具

添加了一个检测脚本用于对访问变量的不同方式进行计时: Tools/scripts/var_access_benchmark.py。 （由 Raymond Hettinger 在 bpo-35884 [https://bugs.python.org/issue?@action=redirect&bpo=35884] 中贡献。）

以下是自 Python 3.3 以来性能提升情况的总结:

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

基准测试是在 Intel® Core™ i7-4960HQ 处理器 [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 [https://www.python.org/downloads/mac-osx/] 获取的 macOS 64 位版得到的数据。 基准测试脚本显示时间以纳秒为单位。

Python 3.8.1 中的重要变化

出于重要的安全性考量，asyncio.loop.create_datagram_endpoint() 的 reuse_address 形参不再被支持。 这是由 UDP 中的套接字选项 SO_REUSEADDR 的行为导致的。 更多细节请参阅 loop.create_datagram_endpoint() 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228 [https://bugs.python.org/issue?@action=redirect&bpo=37228] 中贡献。。）

Python 3.8.8 中的重要变化

早先的 Python 版本允许使用 ; 和 & 作为 urllib.parse.parse_qs() 和 urllib.parse.parse_qsl() 中 query 形参的分隔键。 出于安全考虑，也为了遵循更新的 W3C 推荐设置，这已被改为只允许单个分隔键，默认为 &。 这一改变还会影响 cgi.parse() 和 cgi.parse_multipart() 因为它们在内部使用了受影响的函数。 要了解更多细节，请查看它们各自的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967] 中贡献。）

Python 3.8.12 中的重要变化

从 Python 3.8.12 开始 ipaddress 模块不再接受 IPv4 地址字符串中有任何前缀的零。 前缀的零有歧义且会被某些库解读为八进制数字。 例如旧版函数 socket.inet_aton() 就将前缀的零视为八进制数字。 最新 inet_pton() 的 glibc 实现则不接受任何前缀的零。

（最初由 Christian Heimes 在 bpo-36384 [https://bugs.python.org/issue?@action=redirect&bpo=36384] 中贡献，并由 Achraf Merzouki 向下移植到 3.8。）

Python 3.7 有什么新变化

编者

Elvis Pranskevichus <elvis@magic.io>

本文解释了 Python 3.7 相比 3.6 的新增特性。Python 3.7 于 2018 年 6 月 27 日发布。完整的详情可参阅 更新日志。

摘要 - 发布重点

新的语法特性：

PEP 563，类型标注延迟求值。

向后不兼容的语法更改：

async 和 await 现在是保留的关键字。

新的库模块：

contextvars: PEP 567 -- 上下文变量

dataclasses: PEP 557 -- 数据类

importlib.resources

新的内置特性：

PEP 553, 新的 breakpoint() 函数。

对 Python 数据模型的改进：

PEP 562, 自定义可访问的模块属性。

PEP 560, typing模块和泛型类型的核心支持。

dict 对象会保持插入时的顺序这个特性 正式宣布 [https://mail.python.org/pipermail/python-dev/2017-December/151283.html] 成为 Python 语言官方规范的一部分。

标准库中的重大改进：

asyncio 模块添加了新的功能，重大改进请参阅 可用性与性能提升。

time 模块现在提供 纳秒级精度函数 的支持。

CPython 实现的改进：

避免使用 ASCII 作为默认的文本编码：

PEP 538，传统 C 区域强制转换

PEP 540，强制 UTF-8 运行时模式

PEP 552，确定性的 .pyc 文件

新的 Python 开发模式

PEP 565，改进的 DeprecationWarning 处理

C API 的改进：

PEP 539，用于线程本地存储的新 C API

文档的改进：

PEP 545, Python 文档翻译

新的文档翻译：Japanese [https://docs.python.org/ja/]，French [https://docs.python.org/fr/] 和 Korean [https://docs.python.org/ko/]。

此版本在诸多方面有显著的性能改进。性能优化 章节详细列出了它们。

和之前的 Python 版本存在兼容性的更改列表，请参阅 移植到 Python 3.7 章节。

新的特性

PEP 563：延迟的标注求值

随着 PEP 3107 [https://www.python.org/dev/peps/pep-3107] 加入标注功能并在 PEP 526 [https://www.python.org/dev/peps/pep-0526] 进一步细化，Python 中类型提示的出现揭示了两个明显的可用性问题：

标注只能使用在当前作用域中已经存在的名称，也就是说，它们不支持任何形式的前向引用；而且——

标注源码对 Python 程序的启动时间有不利的影响。

这两个问题都可以通过延迟标注求值来解决。在定义标注的时候，编译器并不会编译执行相应表达式的代码，而是保存与相应表达式的 AST 等价的字符串形式。如果有需要，标注可以在运行时使用 typing.get_type_hints() 进行解析。在不需要这种解析的通常情况下，标注的存储成本更低（因为解析器只需处理较短的字符串）且启动时间更短。

在可用性方面，标注现在支持向前引用，以使以下句法有效:

class C:
    @classmethod
    def from_string(cls, source: str) -> C:
        ...

    def validate_b(self, obj: B) -> bool:
        ...

class B:
    ...

由于此修改会破坏兼容性，在 Python 3.7 中此种新的行为需要在每个模块层级上使用 __future__ 导入来启用:

from __future__ import annotations

它将在 Python 3.10 中成为默认行为。

参见

PEP 563 [https://www.python.org/dev/peps/pep-0563] -- 延迟的标注求值

PEP 由 Łukasz Langa 撰写并实现。

PEP 538: 传统 C 区域强制转换

Python 3 系列有一个持续的挑战就是为处理 7 比特位 ASCII 文本的假定编码确定合理的默认策略，目前的设定是在非 Windows 平台上使用默认的 C 或 POSIX 区域设置。

PEP 538 [https://www.python.org/dev/peps/pep-0538] 更新了默认的解释器命令行接口，以自动将上述区域强制转换为可用的基于 UTF-8 的区域，具体描述可参见有关新增环境变量 PYTHONCOERCECLOCALE 的文档。 以这种方式自动设置 LC_CTYPE 意味着核心解释器和能感知区域的 C 扩展 (例如 readline) 都将会假定 UTF-8 已被用作默认的文本编码，而不再是 ASCII。

PEP 11 [https://www.python.org/dev/peps/pep-0011] 中的平台支持定义也已被更新以限制完整文本处理支持适当配置的基于非 ASCII 的语言区域。

作为此更改的一部分，当使用任何已定义的强制转换目标区域时 (目前为 C.UTF-8, C.utf8 和 UTF-8) stdin 和 stdout 默认的处理器现在将为 surrogateescape (而不是 strict)。 而无论是什么区域，stderr 默认的处理器仍为 backslashreplace。

默认情况下区域强制转换会静默进行，但为了辅助调试潜在的区域相关集成问题，可以通过设置 PYTHONCOERCECLOCALE=warn 来请求显式地启用警告信息（直接在 stderr 上发出）。 此设置还会使得 Python 运行时在核心解释器初始化时如果传统 C 区域仍然处于激活状态时发出警告。

虽然 PEP 538 [https://www.python.org/dev/peps/pep-0538] 的区域强制转换的好处在于它还会同时影响扩展模块 (例如 GNU readline) 以及子进程 (包括运行非 Python 应用和旧版本 Python 的子进程)，但它也存在需要所运行系统必须存在适合的目标区域的缺点。 为了更好地处理没有可用适合的目标区域的情况 (例如在 RHEL/CentOS 7 上就会出现此情况)，Python 3.7 还实现了 PEP 540: 强制 UTF-8 运行时模式。

参见

PEP 538 [https://www.python.org/dev/peps/pep-0538] -- 强制转换传统 C 区域到基于 UTF-8 的区域

PEP 由 Nick Coghlan 撰写并实现。

PEP 540: 强制 UTF-8 运行时模式

新的 -X utf8 命令行选项和 PYTHONUTF8 环境变量可被用来启用 Python UTF-8 模式。

当处于 UTF-8 模式时，CPython 会忽略区域设置，并默认使用 UTF-8 编码。 用于 sys.stdin 和 sys.stdout 流的错误处理器将设置为 surrogateescape。

强制 UTF-8 模式可被用来在嵌入的 Python 解释器中改变文本处理行为，而不会改变嵌入方应用的区域设置。

PEP 540 [https://www.python.org/dev/peps/pep-0540] 的 UTF-8 模式的好处是不必关心运行所在系统中有哪些可用区域即可工作，但它也存在对扩展模块 (例如 GNU readline)、运行非 Python 应用的子进程以及运行旧版本 Python 的子进程不起作用的缺点。 为了减小与这些组件通信时破坏文本数据的风险，Python 3.7 还实现了 PEP 540: 强制 UTF-8 运行时模式)。

UTF-8 模式在语言区域为 C 或 POSIX 并且 PEP 538 [https://www.python.org/dev/peps/pep-0538] 区域强制转换特性无法将其修改为某种基于 UTF-8 的替代项时会被默认启用（无论修改失败是由于设置了 PYTHONCOERCECLOCALE=0, LC_ALL 还是由于缺少适合的目标区域）。

参见

PEP 540 [https://www.python.org/dev/peps/pep-0540] -- 增加了新的 UTF-8 模式

PEP 由 Victor Stinner 撰写并实现

PEP 553: 内置的 breakpoint()

Python 3.7 包含了新的内置 breakpoint() 函数，作为一种简单方便地进入 Python 调试器的方式。

内置 breakpoint() 会调用 sys.breakpointhook()。 在默认情况下后者会导入 pdb 然后再调用 pdb.set_trace()，但是通过将 sys.breakpointhook() 绑定到你选定的函数，breakpoint() 可以进入任何调试器。 此外，环境变量 PYTHONBREAKPOINT 可被设置为你选定的调试器的可调用对象。 设置 PYTHONBREAKPOINT=0 会完全禁用内置 breakpoint()。

参见

PEP 553 [https://www.python.org/dev/peps/pep-0553] -- 内置的 breakpoint()

PEP 由 Barry Warsaw 撰写并实现

PEP 539: 用于线程局部存储的新 C API

虽然 Python 提供了用于线程存储支持的 C API；但原有的 线程局部存储 (TLS) API 已使用 int 来表示所有平台上的 TLS 密钥。 对于官方支持的平台而言这通常不是问题，但这即不符合 POSIX 标准，也不具备任何实际意义上的可移植性。

PEP 539 [https://www.python.org/dev/peps/pep-0539] 通过向 CPython 提供一个取代 CPython 解释器内部的现有 TLS API 的使用的新的 线程专属存储 (TSS) API 来改变这一点，同时弃用了现有的 API。 TSS API 使用一种新类型 Py_tss_t 而非 int 来表示 TSS 密钥 -- 这是一种具体定义依赖于下层 TLS 实现的不透明类型。 因此，这将允许在以无法安全地转换为 int 的方式定义原生 TLS 密钥的平台上构建 CPython。

请注意在 TLS 密钥定义方式使其无法被安全地转换为 int 的平台上，现有 TLS API 中的全部函数将无法执行并会立即返回失败信息。 这样可以清楚地表明原有 API 在无法可选使用的平台上不受支持，并且也不准备添加此种支持。

参见

PEP 539 [https://www.python.org/dev/peps/pep-0539] -- 在 CPython 中用于线程局部存储的新 C-API

PEP 由 Erik M. Bray 撰写；由 Masayuki Yamamoto 实现。

PEP 562: 定制对模块属性的访问

Python 3.7 允许在模块上定义 __getattr__() 并且当以其他方式找不到某个模块属性时将会调用它。 在模块上定义 __dir__() 现在也是允许的。

一个典型的可能有用的例子是已弃用模块属性和惰性加载。

参见

PEP 562 [https://www.python.org/dev/peps/pep-0562] -- 模块的 __getattr__ 和 __dir__

PEP 由 Ivan Levkivskyi 撰写并实现

PEP 564: 具有纳秒级精度的新时间函数

现代系统的时钟精度可以超过由 time.time() 函数及其变化形式所返回的浮点数的有限精度。 为了避免精度损失，PEP 564 [https://www.python.org/dev/peps/pep-0564] 在 time 模块中增加了原有计时器函数的六个新“纳秒版”变化形式:

time.clock_gettime_ns()

time.clock_settime_ns()

time.monotonic_ns()

time.perf_counter_ns()

time.process_time_ns()

time.time_ns()

这些新函数会以整数值的形式返回纳秒数。

测量 [https://www.python.org/dev/peps/pep-0564/#annex-clocks-resolution-in-python] 表明在 Linux 和 Windows 上 time.time_ns() 的精度大约比 time.time() 要高 3 倍。

参见

PEP 564 [https://www.python.org/dev/peps/pep-0564] -- 增加具有纳秒级精度的新时间函数

PEP 由 Victor Stinner 撰写并实现

PEP 565: 在 __main__ 中显示 DeprecationWarning

DeprecationWarning 的默认处理方式已经被更改，这此警告默认只显示一次，仅有当直接在 __main__ 模块中运行的代码触发它们时才会再次显示。 因此，单文件脚本开发者以及 Python 交互模式使用者应该会再次开始看到针对他们所使用 API 的已弃用警告，但被导入应用、库和框架模块所触发的已弃用警告默认将继续隐藏。

作为此项更改的结果，标准库现在允许开发者在三种不同的已弃用警告行为之间进行选择:

FutureWarning: 默认情况下总是会显示，建议用于应用程序最终用户应该看到的警告信息（例如对于已弃用的应用程序配置的设置选项）。

DeprecationWarning: 默认情况下仅在 __main__ 中以及当运行测试时会显示，建议用于其他 Python 开发者应该看到的警告信息，提示版本升级可能导致行为改变或者错误。

PendingDeprecationWarning: 默认情况下仅在运行测试时会显示，可用于提示未来版本升级将会改变警告类别为 DeprecationWarning 或 FutureWarning 的情况。

在此之前 DeprecationWarning 和 PendingDeprecationWarning 都仅在运行测试时可见，这意味着主要编写单文件脚本或使用 Python 交互模式的开发者可能会因他们所用 API 突然出现的改变而感到惊讶。

参见

PEP 565 [https://www.python.org/dev/peps/pep-0565] -- 在 __main__ 中显示 DeprecationWarning

PEP 由 Nick Coghlan 撰写并实现

PEP 560: 对 typing 模块和泛型类型的核心支持

PEP 484 [https://www.python.org/dev/peps/pep-0484] 最初的设计方式使其不会向核心 CPython 解释器引入 任何 更改。 现在类型提示和 typing 模块已被社区广泛使用，因此这个限制已被取消。 这个 PEP 引入了两个特殊方法 __class_getitem__() 和 __mro_entries__，这些方法现在被 typing 中的大多数类和特殊构造所使用。 结果就是与类型相关的各类操作的速度提升了 7 倍，泛型类型可以在没有元类冲突的情况下被使用，而 typing 模块中几个长期存在的错误也已被修正。

参见

PEP 560 [https://www.python.org/dev/peps/pep-0560] -- 对 typing 模块和泛型类型的核心支持

PEP 由 Ivan Levkivskyi 撰写并实现

PEP 552: 基于哈希值的 .pyc 文件

传统上 Python 检查字节码缓存文件 (即 .pyc 文件) 是否最新的方式是通过对源码元数据 (最后更改的时间戳和大小）和生成缓存时保存在其文件头中的源码元数据进行比较。 这种检查方法虽然有效，但也存在缺点。 当文件系统的时间戳太粗糙时，Python 有可能错过源码更新，导致用户感到困惑。 此外，在缓存文件中存在时间戳对于 构建可再现 [https://reproducible-builds.org/] 并且基于内容的构建系统来说是有问题的。

PEP 552 [https://www.python.org/dev/peps/pep-0552] 扩展了 pyc 格式以允许使用源文件的哈希值而非源文件的时间戳来检查有效性。 这种 .pyc 文件就称为“基于哈希值的”。 默认情况下，Python 仍然使用基于时间戳的有效性检查，不会在运行时生成基于哈希值的 .pyc 文件。 基于哈希值的 .pyc 文件可以使用 py_compile 或 compileall 来生成。

基于哈希值的 .pyc 文件包含两种变体：已选定和未选定。 Python 会在运行时针对相应源码文件验证已选定基于哈希值的 .pyc 文件，但对未选定基于哈希值的 pyc 文件则不会这样做。 未选定基于哈希值的 .pyc 文件对于需要由 Python 外部的系统（例如构建系统）负责使 .pyc 文件保持最新的环境来说是一种有用的性能优化。

请参阅 已缓存字节码的失效 了解更多信息。

参见

PEP 552 [https://www.python.org/dev/peps/pep-0552] -- 确定性的 pyc 文件

PEP 由 Benjamin Peterson 撰写并实现

PEP 545: Python 文档翻译

PEP 545 [https://www.python.org/dev/peps/pep-0545] 描述了创建和维护 Python 文档翻译的整个过程。

新增了三个新的翻译版本:

日语: https://docs.python.org/ja/

法语: https://docs.python.org/fr/

韩语: https://docs.python.org/ko/

参见

PEP 545 [https://www.python.org/dev/peps/pep-0545] -- Python 文档翻译

PEP 由 Julien Palard, Inada Naoki 和 Victor Stinner 撰写并实现。

Python 开发模式 (-X dev)

新的 -X dev 命令行选项或新的 PYTHONDEVMODE 环境变量可被用来启用 Python 开发模式。 在开发模式下，Python 将执行额外的如果默认启用会导致开销过大的运行时检查。 请参阅 Python 开发模式 文档查看完整说明。

其他语言特性修改

await 表达式和包含 async for 子句的推导式不允许在 格式化字符串字面值 的表达式中使用。 在 Python 3.7 中此限制已被取消。

现在可以将超过 255 个参数传递给一个函数，而现在一个函数也可以拥有超过 255 个形参。 （由 Serhiy Storchaka 在 bpo-12844 [https://bugs.python.org/issue?@action=redirect&bpo=12844] 和 bpo-18896 [https://bugs.python.org/issue?@action=redirect&bpo=18896] 中贡献。）

现在 bytes.fromhex() 和 bytearray.fromhex() 会忽略所有 ASCII 空白符，而非仅是空格符. （由 Robert Xiao 在 bpo-28927 [https://bugs.python.org/issue?@action=redirect&bpo=28927] 中贡献。）

str, bytes 和 bytearray 获得了对新 isascii() 方法的支持，该方法可被用来测试是个字符串或字节串是否仅包含 ASCII 字符。 （由 INADA Naoki 在 bpo-32677 [https://bugs.python.org/issue?@action=redirect&bpo=32677] 中贡献。）

现在当 from ... import ... 失败时 ImportError 会显示模块名称和模块 __file__ 路径。 （由 Matthias Bussonnier 在 bpo-29546 [https://bugs.python.org/issue?@action=redirect&bpo=29546] 中贡献。）

现在已支持涉及将子模块绑定到一个名称的绝对导入的循环导入。 （由 Serhiy Storchaka 在 bpo-30024 [https://bugs.python.org/issue?@action=redirect&bpo=30024] 中贡献。）

现在 object.__format__(x, '') 等价于 str(x) 而非 format(str(self), '')。 （由 Serhiy Storchaka d bpo-28974 [https://bugs.python.org/issue?@action=redirect&bpo=28974] 中贡献。）

为更好地支持栈跟踪的动态创建，现在 types.TracebackType 可以从 Python 代码中被实例化，并且 回溯对象 的 tb_next 属性现在是可写的。 （由 Nathaniel J. Smith 在 bpo-30579 [https://bugs.python.org/issue?@action=redirect&bpo=30579] 中贡献。）

当使用 -m 开关时，现在 sys.path[0] 会主动扩展为完整的起始目录路径，而不是保持为空目录（这将允许在发生导入时从 当前 工作目录导入） （由 Nick Coghlan 在 bpo-33053 [https://bugs.python.org/issue?@action=redirect&bpo=33053] 中贡献。）

新的 -X importtime 选项或 PYTHONPROFILEIMPORTTIME 环境变量可被用来显示每次模块导入的时间。 （由 Inada Naoki 在 bpo-31415 [https://bugs.python.org/issue?@action=redirect&bpo=31415] 中贡献。）

新增模块

contextvars

新的 contextvars 模块和一组 新的 C API 引入了对 上下文变量 的支持。 上下文变量在概念上类似于线程局部变量。 与 TLS 不同，上下文变量能正确地支持异步代码。

asyncio 和 decimal 已得到更新以使用和支持开箱即用的上下文变量。 特别是激活的 decimal 上下文现在将存储在上下文变量中，它允许十进制运算在异步代码中使用正确的上下文。

参见

PEP 567 [https://www.python.org/dev/peps/pep-0567] -- 上下文变量

PEP 由 Yury Selivanov 撰写并实现

dataclasses

新的 dataclass() 装饰器提供了一种声明 数据类 的方式。 数据类使用变量标注来描述其属性。 它的构造器和其他魔术方法例如 __repr__(), __eq__() 以及 __hash__() 会自动地生成。

示例:

@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)"

参见

PEP 557 [https://www.python.org/dev/peps/pep-0557] -- 数据类

PEP 由 Eric V. Smith 撰写并实现

importlib.resources

新的 importlib.resources 模块提供了一些新的 API 和一个新的 ABC 用于访问、打开和读取包内的 资源。 资源基本上类似于包内的文件，但它们不一定是物理文件系统中实际的文件。 模块加载器可以提供 get_resource_reader() 函数，它会返回一个 importlib.abc.ResourceReader 实例来支持这个新 API。 内置的文件路径加载器和 zip 文件加载器都支持此特性。

由 Barry Warsaw 和 Brett Cannon 在 bpo-32248 [https://bugs.python.org/issue?@action=redirect&bpo=32248] 中贡献。

参见

importlib_resources [https://importlib-resources.readthedocs.io/en/latest/] -- 用于较早版本 Python 的 PyPI 向下移植包。

改进的模块

argparse

新的 ArgumentParser.parse_intermixed_args() 方法允许混合选项与位置参数。 （由 paul.j3 在 bpo-14191 [https://bugs.python.org/issue?@action=redirect&bpo=14191] 中提供。）

asyncio

asyncio 模块获得了许多新的特性、可用性和 性能提升。 重要的改变包括:

新的 暂定 asyncio.run() 函数可被用于通过自动创建和销毁事件循环来基于同步代码运行协程。 （由 Yury Selivanov 在 bpo-32314 [https://bugs.python.org/issue?@action=redirect&bpo=32314] 中贡献。）

asyncio 增加支持 contextvars. loop.call_soon(), loop.call_soon_threadsafe(), loop.call_later(), loop.call_at() 并且 Future.add_done_callback() 具有新的可选仅关键字参数 context。 现在 Tasks 会自动跟踪其上下文。 详情参见 PEP 567 [https://www.python.org/dev/peps/pep-0567]。 （由 Yury Selivanov 在 bpo-32436 [https://bugs.python.org/issue?@action=redirect&bpo=32436] 中贡献。）

增加了新的 asyncio.create_task() 函数作为 asyncio.get_event_loop().create_task() 的快捷方式。 （由 Andrew Svetlov 在 bpo-32311 [https://bugs.python.org/issue?@action=redirect&bpo=32311] 中贡献。）

新的 loop.start_tls() 方法可用于升级现有的 TLS 连接。 （由 Yury Selivanov 在 bpo-23749 [https://bugs.python.org/issue?@action=redirect&bpo=23749] 中贡献。）

新的 loop.sock_recv_into() 方法允许直接从套接字读取数据放入所提供的缓冲区，从而可以减少数据复制。 （由 Antoine Pitrou 在 bpo-31819 [https://bugs.python.org/issue?@action=redirect&bpo=31819] 中贡献。）

新的 asyncio.current_task() 函数可返回当前运行的 Task 实例，以及新的 asyncio.all_tasks() 函数可返回给定循环中所有现存 Task 实例的集合。 Task.current_task() 和 Task.all_tasks() 方法已弃用。 （由 Andrew Svetlov 在 bpo-32250 [https://bugs.python.org/issue?@action=redirect&bpo=32250] 中贡献。）

新的 暂定 BufferedProtocol 类允许通过手动控制接收缓冲区来实现流式协议。 （由 Yury Selivanov 在 bpo-32251 [https://bugs.python.org/issue?@action=redirect&bpo=32251] 中贡献。）

新的 asyncio.get_running_loop() 函数可返回当前运行的循环，如果没有循环在运行则引发 RuntimeError。 这与 asyncio.get_event_loop() 不同，后者在没有循环在运行时将 创建 一个新的事件循环。 （由 Yury Selivanov 在 bpo-32269 [https://bugs.python.org/issue?@action=redirect&bpo=32269] 中提供。）

新的 StreamWriter.wait_closed() 协程方法允许执行等待直到流写入器被关闭。 新的 StreamWriter.is_closing() 方法可用于确定写入器是否被关闭。 （由 Andrew Svetlov 在 bpo-32391 [https://bugs.python.org/issue?@action=redirect&bpo=32391] 中贡献。）

新的 loop.sock_sendfile() 协程方法允许在可能的情况下使用 os.sendfile 发送文件。 （由 Andrew Svetlov 在 bpo-32410 [https://bugs.python.org/issue?@action=redirect&bpo=32410] 中贡献。）

新的 Future.get_loop() 和 Task.get_loop() 方法会返回创建 task 或 future 对象的事件循环的实例。 Server.get_loop() 允许为 asyncio.Server 对象执行同样操作。 （由 Yury Selivanov 在 bpo-32415 [https://bugs.python.org/issue?@action=redirect&bpo=32415] 中，以及由 Srinivas Reddy Thatiparthy 在 bpo-32418 [https://bugs.python.org/issue?@action=redirect&bpo=32418] 中贡献。）

现在可以控制 asyncio.Server 的实例如何开启服务。 之前，服务在创建后将立即开启服务。 新的 start_serving 关键字参数已添加到 loop.create_server() 和 loop.create_unix_server()，并且 Server.start_serving(), 和 Server.serve_forever() 可被用来分离服务的实例化和服务的开启。 新的 Server.is_serving() 方法会在服务开启时返回 True。 现在 Server 对象已是异步上下文管理器:

srv = await loop.create_server(...)

async with srv:
    # some code

# At this point, srv is closed and no longer accepts new connections.

（由 Yury Selivanov 在 bpo-32662 [https://bugs.python.org/issue?@action=redirect&bpo=32662] 中贡献。）

由 loop.call_later() 所返回的回调对象已获得新的 when() 方法，该方法会返回一个排入计划日程的绝对时间戳。 （由 Andrew Svetlov 在 bpo-32741 [https://bugs.python.org/issue?@action=redirect&bpo=32741] 中贡献。）

loop.create_datagram_endpoint() 方法已获得对 Unix 套接字的支持。 （由 Quentin Dawans 在 bpo-31245 [https://bugs.python.org/issue?@action=redirect&bpo=31245] 中贡献。）

asyncio.open_connection(), asyncio.start_server() functions, loop.create_connection(), loop.create_server(), loop.create_accepted_socket() 方法及其对应的 UNIX 套接字变体现在接受 ssl_handshake_timeout 关键字参数。 （由 Neil Aspinall 在 bpo-29970 [https://bugs.python.org/issue?@action=redirect&bpo=29970] 中贡献。）

新的 Handle.cancelled() 方法会在回调被取消时返回 True。 （由 Marat Sharafutdinov 在 bpo-31943 [https://bugs.python.org/issue?@action=redirect&bpo=31943] 中贡献。）

asyncio 源已被转换为使用 async/await 语法。 （由 Andrew Svetlov 在 bpo-32193 [https://bugs.python.org/issue?@action=redirect&bpo=32193] 中贡献。）

新的 ReadTransport.is_reading() 方法可用于确定传输的读取状态。 此外，对 ReadTransport.resume_reading() 和 ReadTransport.pause_reading() 的调用现在是幂等的。 （由 Yury Selivanov 在 bpo-32356 [https://bugs.python.org/issue?@action=redirect&bpo=32356] 中贡献。）

接受套接字路径的循环方法现在支持传入 路径类对象。 （由 Yury Selivanov 在 bpo-32066 [https://bugs.python.org/issue?@action=redirect&bpo=32066] 中贡献。）

在 asyncio 中，Linux 上的 TCP 套接字现在创建时默认带有 TCP_NODELAY 旗标设置。 （由 Yury Selivanov 和 Victor Stinner 在 bpo-27456 [https://bugs.python.org/issue?@action=redirect&bpo=27456] 中贡献。）

在被取消任务中发生的异常不会再被记录。 （由 Yury Selivanov 在 bpo-30508 [https://bugs.python.org/issue?@action=redirect&bpo=30508] 中贡献。）

新的 WindowsSelectorEventLoopPolicy 和 WindowsProactorEventLoopPolicy 类。 （由 Yury Selivanov 在 bpo-33792 [https://bugs.python.org/issue?@action=redirect&bpo=33792] 中贡献。）

部分 asyncio API 改为 已弃用。

binascii

b2a_uu() 函数现在接受可选的 backtick 关键字参数。 当其为真值时，零会以 '`' 而非空格来表示。 （由 Xiang Zhang 在 bpo-30103 [https://bugs.python.org/issue?@action=redirect&bpo=30103] 中贡献。）

calendar

HTMLCalendar 类具有新的类属性，可以简化所生成 HTML 日历中 CSS 类的自定义。 （由 Oz Tiram 在 bpo-30095 [https://bugs.python.org/issue?@action=redirect&bpo=30095] 中贡献。）

collections

collections.namedtuple() 现在支持默认值。 （由 Raymond Hettinger 在 bpo-32320 [https://bugs.python.org/issue?@action=redirect&bpo=32320] 中贡献。）

compileall

compileall.compile_dir() 增加了新的 invalidation_mode 形参，可用于启用 基于哈希值的 .pyc 有效性检测。 失效模式也可以在命令行中使用新的 --invalidation-mode 参数来指定。 （由 Benjamin Peterson 在 bpo-31650 [https://bugs.python.org/issue?@action=redirect&bpo=31650] 中贡献。）

concurrent.futures

ProcessPoolExecutor 和 ThreadPoolExecutor 现在支持新的 初始化器 以及 initargs 构造器参数。 （由 Antoine Pitrou 在 bpo-21423 [https://bugs.python.org/issue?@action=redirect&bpo=21423] 中贡献。）

ProcessPoolExecutor 现在能通过新的 mp_context 参数来接受多进程上下文。 （由 Thomas Moreau 在 bpo-31540 [https://bugs.python.org/issue?@action=redirect&bpo=31540] 中贡献。）

contextlib

新的 nullcontext() 是一个比 ExitStack 更简单和快速的无操作上下文管理器。 （由 Jesse-Bakker 在 bpo-10049 [https://bugs.python.org/issue?@action=redirect&bpo=10049] 中贡献。）

增加了新的 asynccontextmanager(), AbstractAsyncContextManager 和 AsyncExitStack 以补充它们所对应的同步项。 （由 Jelle Zijlstra 在 bpo-29679 [https://bugs.python.org/issue?@action=redirect&bpo=29679] 和 bpo-30241 [https://bugs.python.org/issue?@action=redirect&bpo=30241] 中，以及由 Alexander Mohr 和 Ilya Kulakov 在 bpo-29302 [https://bugs.python.org/issue?@action=redirect&bpo=29302] 中贡献。）

cProfile

cProfile 命令行现在接受 -m module_name 作为脚本路径的替代。 （由 Sanyam Khurana 在 bpo-21862 [https://bugs.python.org/issue?@action=redirect&bpo=21862] 中贡献。）

crypt

crypt 模块现在支持 Blowfish 哈希方法。 （由 Serhiy Storchaka 在 bpo-31664 [https://bugs.python.org/issue?@action=redirect&bpo=31664] 中贡献。）

mksalt() 函数现在允许指定哈希操作的轮数。 （由 Serhiy Storchaka 在 bpo-31702 [https://bugs.python.org/issue?@action=redirect&bpo=31702] 中贡献。）

datetime

新的 datetime.fromisoformat() 方法会基于由 datetime.isoformat() 所输出的某一特定格式字符串构建 datetime 对象。 （由 Paul Ganssle 在 bpo-15873 [https://bugs.python.org/issue?@action=redirect&bpo=15873] 中贡献。）

tzinfo 类现在支持小于一分钟的偏移量。 （由 Alexander Belopolsky 在 bpo-5288 [https://bugs.python.org/issue?@action=redirect&bpo=5288] 中贡献。）

dbm

dbm.dumb 现在支持读取只读文件，并且在其未改变时不再写入索引文件。

decimal

decimal 模块现在使用 上下文变量 来储存十进制值上下文。 （由 Yury Selivanov 在 bpo-32630 [https://bugs.python.org/issue?@action=redirect&bpo=32630] 中贡献。）

dis

dis() 函数现在能够反汇编嵌套的代码对象（推导式、生成器表达式和嵌套函数的代码，以及用于构建嵌套类的代码）。 反汇编递归的最大深度由新的 depth 形参来控制。 （由 Serhiy Storchaka 在 bpo-11822 [https://bugs.python.org/issue?@action=redirect&bpo=11822] 中贡献。）

distutils

README.rst 现在包含在 distutils 的标准 README 列表之中，因而也包含在源码发布之中。 （由 Ryan Gonzalez 在 bpo-11913 [https://bugs.python.org/issue?@action=redirect&bpo=11913] 中贡献。）

enum

Enum 增加了新的 _ignore_ 类特征属性，该属性允许列出不应当成为枚举成员的特征属性名称。 （由 Ethan Furman 在 bpo-31801 [https://bugs.python.org/issue?@action=redirect&bpo=31801] 中贡献。）

在 Python 3.8 中，尝试在 Enum 类中检查非 Enum 对象将引发 TypeError (例如 1 in Color)；类似地，尝试在 Flag 成员中检查非 Flag 对象也将引发 TypeError (例如 1 in Perm.RW)；目前，两种操作均会返回 False 并且已弃用。 （由 Ethan Furman 在 bpo-33217 [https://bugs.python.org/issue?@action=redirect&bpo=33217] 中贡献。）

functools

functools.singledispatch() 现在支持使用类型标注来注册实现。 （由 Łukasz Langa 在 bpo-32227 [https://bugs.python.org/issue?@action=redirect&bpo=32227] 中贡献。）

gc

新的 gc.freeze() 函数允许冻结由垃圾回收器所跟踪的所有对象，并将它们从未来的集合中排除。 这可以在 POSIX fork() 调用之前使用以令 GC 友好地进行写入时复制或加速收集。 新的 gc.unfreeze() 函数会反转此操作。 此外，gc.get_freeze_count() 可被用于获取冻结对象的数量。 （由 Li Zekun 在 bpo-31558 [https://bugs.python.org/issue?@action=redirect&bpo=31558] 中贡献。）

hmac

hmac 现在具有经优化的一次性 digest() 函数，其速度比 HMAC() 要快三倍。 （由 Christian Heimes 在 bpo-32433 [https://bugs.python.org/issue?@action=redirect&bpo=32433] 中贡献。）

http.client

HTTPConnection 和 HTTPSConnection 现在支持新的 blocksize 参数以提升上传吞吐量。 （由 Nir Soffer 在 bpo-31945 [https://bugs.python.org/issue?@action=redirect&bpo=31945] 中贡献。）

http.server

SimpleHTTPRequestHandler 现在支持 HTTP If-Modified-Since 标头。 如果目标文件在该标点指定的时间之后未被修改则服务器会返回 304 响应状态。 （由 Pierre Quentel 在 bpo-29654 [https://bugs.python.org/issue?@action=redirect&bpo=29654] 中贡献。）

SimpleHTTPRequestHandler 接受新的 directory 参数并增加了新的 --directory 命令行参数。 通过此形参，服务器可以对服务指定目录，默认情况下它使用当前工作目录。 （由 Stéphane Wirtel 和 Julien Palard 在 bpo-28707 [https://bugs.python.org/issue?@action=redirect&bpo=28707] 中贡献。）

新的 ThreadingHTTPServer 类使用线程来处理使用 ThreadingMixin 的请求。 它会在 http.server 附带 -m 运行时被使用。 （由 Julien Palard 在 bpo-31639 [https://bugs.python.org/issue?@action=redirect&bpo=31639] 中贡献。）

idlelib 与 IDLE

多个对自动补全的修正。 （由 Louie Lu 在 bpo-15786 [https://bugs.python.org/issue?@action=redirect&bpo=15786] 中贡献。）

Module Browser (在 File 菜单中，之前称为 Class Browser) 现在会在最高层级函数和类之外显示嵌套的函数和类。 （由 Guilherme Polo, Cheryl Sabella 和 Terry Jan Reedy 在 bpo-1612262 [https://bugs.python.org/issue?@action=redirect&bpo=1612262] 中贡献。）

Settings 对话框 (Options 中的 Configure IDLE) 已经被部分重写以改进外观和功能。 （由 Cheryl Sabella 和 Terry Jan Reedy 在多个问题项中贡献。）

字体样本现在包括一组非拉丁字符以便用户能更好地查看所选特定字体的效果。 （由 Terry Jan Reedy 在 bpo-13802 [https://bugs.python.org/issue?@action=redirect&bpo=13802] 中贡献。） 样本可以被修改以包括其他字符。 （由 Serhiy Storchaka 在 bpo-31860 [https://bugs.python.org/issue?@action=redirect&bpo=31860] 中贡献。）

之前以扩展形式实现的 IDLE 特性已作为正常特性重新实现。 它们的设置已从 Extensions 选项卡移至其他对话框选项卡。 （由 Charles Wohlganger 和 Terry Jan Reedy 在 bpo-27099 [https://bugs.python.org/issue?@action=redirect&bpo=27099] 中实现。）

编辑器代码上下文选项已经过修改。 Box 会显示所有上下文行直到最大行数。 点击一个上下文行会使编辑器跳转到该行。 自定义主题的上下文颜色已添加到 Settings 对话框的 Highlights 选项卡。 （由 Cheryl Sabella 和 Terry Jan Reedy 在 bpo-33642 [https://bugs.python.org/issue?@action=redirect&bpo=33642], bpo-33768 [https://bugs.python.org/issue?@action=redirect&bpo=33768] 和 bpo-33679 [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 [https://bugs.python.org/issue?@action=redirect&bpo=33656] 中贡献。）

在 3.7.1 中新增:

超过 N 行（默认值为 50）的输出将被折叠为一个按钮。 N 可以在 Settings 对话框的 General 页的 PyShell 部分中进行修改。 数量较少但是超长的行可以通过在输出上右击来折叠。 被折叠的输出可通过双击按钮来展开，或是通过右击按钮来放入剪贴板或是单独的窗口。 （由 Tal Einat 在 bpo-1529353 [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 [https://bugs.python.org/issue?@action=redirect&bpo=5680] 和 bpo-37627 [https://bugs.python.org/issue?@action=redirect&bpo=37627] 中贡献。）

在 3.7.5 中新增:

在 IDLE 编辑器窗口中增加了可选的行序号。 窗口打开时默认不带行序号，除非在配置对话框的 General 选项卡中进行设置。 已打开窗口中的行序号可以在 Options 菜单中显示和隐藏。 （由 Tal Einat 和 Saimadhav Heblikar 在 bpo-17535 [https://bugs.python.org/issue?@action=redirect&bpo=17535] 中贡献。）

importlib

引入了 importlib.abc.ResourceReader ABC 以支持从包中加载资源。 另请参阅 importlib.resources。 （由 Barry Warsaw, Brett Cannon 在 bpo-32248 [https://bugs.python.org/issue?@action=redirect&bpo=32248] 中贡献。）

如果模块缺少规格描述 importlib.reload() 现在会引发 ModuleNotFoundError。 （由 Garvit Khatri 在 bpo-29851 [https://bugs.python.org/issue?@action=redirect&bpo=29851] 中贡献。）

如果指定的父模块不是一个包 (即缺少 __path__ 属性) importlib.find_spec() 现在会引发 ModuleNotFoundError 而非 AttributeError。 （由 Milan Oberkirch 在 bpo-30436 [https://bugs.python.org/issue?@action=redirect&bpo=30436] 中贡献。）

新的 importlib.source_hash() 可被用来计算传入源的哈希值。 基于哈希值的 .pyc 文件 会嵌入此函数所返回的值。

io

新的 TextIOWrapper.reconfigure() 方法可用于根据新的设置重新配置文本流。 （由 Antoine Pitrou 在 bpo-30526 [https://bugs.python.org/issue?@action=redirect&bpo=30526] 以及 INADA Naoki 在 bpo-15216 [https://bugs.python.org/issue?@action=redirect&bpo=15216] 中贡献。）

ipaddress

methods of ipaddress.IPv6Network 和 ipaddress.IPv4Network 中新的 subnet_of() 以及 supernet_of() 方法可用于网络包含测试。 （由 Michel Albert 和 Cheryl Sabella 在 bpo-20825 [https://bugs.python.org/issue?@action=redirect&bpo=20825] 中贡献。）

itertools

itertools.islice() 现在接受 类整数对象 作为 start, stop 和 slice 参数。 （由 Will Roberts 在 bpo-30537 [https://bugs.python.org/issue?@action=redirect&bpo=30537] 中贡献。）

locale

locale.format_string() 中新的 monetary 参数可用于转换所使用的千位分隔符和分组字符串。 （由 Garvit 在 bpo-10379 [https://bugs.python.org/issue?@action=redirect&bpo=10379] 中贡献。）

现在 locale.getpreferredencoding() 函数在 Android 上或是在 强制 UTF-8 模式 下总是返回 'UTF-8' 。

logging

Logger 实例现在可以被 pickle。 （由 Vinay Sajip 在 bpo-30520 [https://bugs.python.org/issue?@action=redirect&bpo=30520] 中贡献。）

新的 StreamHandler.setStream() 方法可用于在句柄创建之后替换日志流。 （由 Vinay Sajip 在 bpo-30522 [https://bugs.python.org/issue?@action=redirect&bpo=30522] 中创建。）

现在可以在传递给 logging.config.fileConfig() 的配置信息中对句柄构造器指定关键字参数。 （由 Preston Landers 在 bpo-31080 [https://bugs.python.org/issue?@action=redirect&bpo=31080] 中贡献。)

math

新的 math.remainder() 函数实现了 IEEE 754 风格的余数运算。 （由 Mark Dickinson 在 bpo-29962 [https://bugs.python.org/issue?@action=redirect&bpo=29962] 中贡献。）

mimetypes

.bmp 的 MIME type 从 'image/x-ms-bmp' 改为 'image/bmp'。 （由 Nitish Chandra 在 bpo-22589 [https://bugs.python.org/issue?@action=redirect&bpo=22589] 中贡献。）

msilib

新的 Database.Close() 方法可用于关闭 MSI 数据库。 （由 Berker Peksag 在 bpo-20486 [https://bugs.python.org/issue?@action=redirect&bpo=20486] 中贡献。）

multiprocessing

新的 Process.close() 方法会显式地关闭进程对象并释放与其关联的所有资源。 如果底层进程仍在运行则将引发 ValueError。 （由 Antoine Pitrou 在 bpo-30596 [https://bugs.python.org/issue?@action=redirect&bpo=30596] 中贡献。）

新的 Process.kill() 方法可用于在 Unix 上使用 SIGKILL 信号来终止进程。 （由 Vitor Pereira 在 bpo-30794 [https://bugs.python.org/issue?@action=redirect&bpo=30794] 中贡献。）

由 Process 所创建的非守护线程现在会在进程退出时被合并。 （由 Antoine Pitrou 在 bpo-18966 [https://bugs.python.org/issue?@action=redirect&bpo=18966] 中贡献。）

os

os.fwalk() 现在接受 bytes 类型的 path 参数。 （由 Serhiy Storchaka 在 bpo-28682 [https://bugs.python.org/issue?@action=redirect&bpo=28682] 中贡献。）

os.scandir() 已获得对 文件描述器 的支持。 （由 Serhiy Storchaka 在 bpo-25996 [https://bugs.python.org/issue?@action=redirect&bpo=25996] 中贡献。）

新的 register_at_fork() 函数允许注册 Python 回调以便在进程分叉中执行。 （由 Antoine Pitrou 在 bpo-16500 [https://bugs.python.org/issue?@action=redirect&bpo=16500] 中贡献。）

增加了 os.preadv() (结合了 os.readv() 与 os.pread() 的功能) 以及 os.pwritev() 函数 (结合了 os.writev() 和 os.pwrite() 的功能)。 （由 Pablo Galindo 在 bpo-31368 [https://bugs.python.org/issue?@action=redirect&bpo=31368] 中贡献。）

os.makedirs() 的 mode 参数不再会影响新创建的中间层级目录的权限位。 （由 Serhiy Storchaka 在 bpo-19930 [https://bugs.python.org/issue?@action=redirect&bpo=19930] 中贡献。）

os.dup2() 现在会返回新的文件描述器。 之前，返回的总是 None。 （由 Benjamin Peterson 在 bpo-32441 [https://bugs.python.org/issue?@action=redirect&bpo=32441] 中贡献。）

在 Solaris 及其派生系统上 os.stat() 所返回的结构现在会包含 st_fstype 属性。 （由 Jesús Cea Avión 在 bpo-32659 [https://bugs.python.org/issue?@action=redirect&bpo=32659] 中贡献。）

pathlib

在 POSIX 类系统上新的 Path.is_mount() 方法现在可用于确定一个路径是否为挂载点。 （由 Cooper Ry Lees 在 bpo-30897 [https://bugs.python.org/issue?@action=redirect&bpo=30897] 中贡献。）

pdb

pdb.set_trace() 现在接受一个可选的限关键字参数 header。 如果给出，它会在调试开始之前被打印到控制台。 （由 Barry Warsaw 在 bpo-31389 [https://bugs.python.org/issue?@action=redirect&bpo=31389] 中贡献。）

pdb 命令行现在接受 -m module_name 作为对脚本文件的替代。 （由 Mario Corchero 在 bpo-32206 [https://bugs.python.org/issue?@action=redirect&bpo=32206] 中贡献。）

py_compile

py_compile.compile() -- 及其扩展形式 compileall -- 现在会通过无条件地为基于哈希值的有效性验证创建 .pyc 文件来支持 SOURCE_DATE_EPOCH 环境变量。 这样可以确保当 .pyc 文件被主动创建时 可重现的生成 [https://reproducible-builds.org/]。 （由 Bernhard M. Wiedemann 在 bpo-29708 [https://bugs.python.org/issue?@action=redirect&bpo=29708] 中贡献。）

pydoc

pydoc 服务器现在可以绑定到由新的 -n 命令行参数所指定的任意主机名。 （由 Feanil Patel 在 bpo-31128 [https://bugs.python.org/issue?@action=redirect&bpo=31128] 中贡献。）

queue

新的 SimpleQueue 类是一个无界的 FIFO 队列。 （由 Antoine Pitrou 在 bpo-14976 [https://bugs.python.org/issue?@action=redirect&bpo=14976] 中贡献。）

re

旗标 re.ASCII, re.LOCALE 和 re.UNICODE 可以在组的范围内设置。 （由 Serhiy Storchaka 在 bpo-31690 [https://bugs.python.org/issue?@action=redirect&bpo=31690] 中贡献。）

re.split() 现在支持基于匹配一个空字符串的模式例如 r'\b', '^$' 或 (?=-) 进行拆分。 （由 Serhiy Storchaka 在 bpo-25054 [https://bugs.python.org/issue?@action=redirect&bpo=25054] 中贡献。）

使用 re.LOCALE 旗标编译的正则表达式不再依赖于编译时的区域设置。 区域设置仅在已编译正则表达式被使用时才被应用。 （由 Serhiy Storchaka 在 bpo-30215 [https://bugs.python.org/issue?@action=redirect&bpo=30215] 中贡献。）

现在如果一个正则表达式包含语义将在未来发生改变的字符集构造，则会引发 FutureWarning，例如嵌套集与集合操作等。 （由 Serhiy Storchaka 在 bpo-30349 [https://bugs.python.org/issue?@action=redirect&bpo=30349] 中贡献。）

已编译正则表达式和匹配对象现在可以使用 copy.copy() 和 copy.deepcopy() 进行拷贝。 （由 Serhiy Storchaka 在 bpo-10076 [https://bugs.python.org/issue?@action=redirect&bpo=10076] 中贡献。）

signal

signal.set_wakeup_fd() 函数新增的 warn_on_full_buffer 参数可以指定当唤醒缓冲区溢出时 Python 是否要在 stderr 上打印警告信息。 （由 Nathaniel J. Smith 在 bpo-30050 [https://bugs.python.org/issue?@action=redirect&bpo=30050] 中贡献。）

socket

新增的 socket.getblocking() 方法会在套接字处于阻塞模式时返回 True，否则返回 False。 （由 Yury Selivanov 在 bpo-32373 [https://bugs.python.org/issue?@action=redirect&bpo=32373] 中贡献。）

新的 socket.close() 函数可关闭所传入的套接字文件描述符。 应该用此函数来代替 os.close() 以获得更好的跨平台兼容性。 （由 Christian Heimes 在 bpo-32454 [https://bugs.python.org/issue?@action=redirect&bpo=32454] 中贡献。）

socket 模块现在会公开 socket.TCP_CONGESTION (Linux 2.6.13), socket.TCP_USER_TIMEOUT (Linux 2.6.37) 以及 socket.TCP_NOTSENT_LOWAT (Linux 3.12) 常量。 （由 Omar Sandoval 在 bpo-26273 [https://bugs.python.org/issue?@action=redirect&bpo=26273] 以及 Nathaniel J. Smith 在 bpo-29728 [https://bugs.python.org/issue?@action=redirect&bpo=29728] 中贡献。）

已加入对 socket.AF_VSOCK 套接字的支持以允许在虚拟机及其宿主机之间进行通讯。 （由 Cathy Avery 在 bpo-27584 [https://bugs.python.org/issue?@action=redirect&bpo=27584] 中贡献。）

套接字现在默认会根据文件描述符自动检测所属族、类型和协议。 （由 Christian Heimes 在 bpo-28134 [https://bugs.python.org/issue?@action=redirect&bpo=28134] 中贡献。）

socketserver

socketserver.ThreadingMixIn.server_close() 现在会等待所有非守护线程完成。 socketserver.ForkingMixIn.server_close() 现在会等待所有子进程完成。

为 socketserver.ForkingMixIn 和 socketserver.ThreadingMixIn 类增加了新的 socketserver.ForkingMixIn.block_on_close 类属性。 该类属性值设为 False 以保持 3.7 之前的行为。

sqlite3

现在当下层的 SQLite 库版本为 3.6.11 及以上时 sqlite3.Connection 会开放 backup() 方法。 （由 Lele Gaifax 在 bpo-27645 [https://bugs.python.org/issue?@action=redirect&bpo=27645] 中贡献。）

sqlite3.connect() 的 database 参数现在接受任何 path-like object，而不是只接受字符串。 （由 Anders Lorentsen 在 bpo-31843 [https://bugs.python.org/issue?@action=redirect&bpo=31843] 中贡献。）

ssl

ssl 模块现在使用 OpenSSL 的内置 API 代替 match_hostname() 来检查主机名或 IP 地址。 值的验证会在 TLS 握手期间进行。 任何证书验证错误包括主机名检查失败现在将引发 SSLCertVerificationError 并使用正确的 TLS Alert 消息中止握手过程。 这个新异常包含有额外的信息。 主机名验证可通过 SSLContext.hostname_checks_common_name 进行自定义。 （由 Christian Heimes 在 bpo-31399 [https://bugs.python.org/issue?@action=redirect&bpo=31399] 中贡献。）

注解

改进的主机名检测需要有兼容 OpenSSL 1.0.2 或 1.1 的 libssl 实现。 因此，OpenSSL 0.9.8 和 1.0.1 不再被支持（请参阅 平台支持的移除 了解详情）。 目前 ssl 模块主要兼容 LibreSSL 2.7.2 及更高版本。

ssl 模块不再以 SNI TLS 扩展发送 IP 地址。 （由 Christian Heimes 在 bpo-32185 [https://bugs.python.org/issue?@action=redirect&bpo=32185] 中贡献。）

match_hostname() 不再支持部分通配符例如 www*.example.org。 （由 Mandeep Singh 在 bpo-23033 [https://bugs.python.org/issue?@action=redirect&bpo=23033] 以及 Christian Heimes 在 bpo-31399 [https://bugs.python.org/issue?@action=redirect&bpo=31399] 中贡献。）

ssl 模块默认的加密套件选择现在是使用黑名单方式而非硬编码的白名单。 Python 不会再重新启用已经被 OpenSSL 安全更新所阻止的加密。 默认的加密套件选择可以在编译时进行配置。 （由 Christian Heimes 在 bpo-31429 [https://bugs.python.org/issue?@action=redirect&bpo=31429] 中贡献。）

现在已支持包含国际化域名 (IDN) 的服务器证书验证。 作为此更改的一部分，SSLSocket.server_hostname 属性现在会以预期的 A 标签形式 ("xn--pythn-mua.org") 而不是以 U 标签形式 ("pythön.org") 存储。 （由 Nathaniel J. Smith 与 Christian Heimes 在 bpo-28414 [https://bugs.python.org/issue?@action=redirect&bpo=28414] 中贡献。）

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 及更早的版本略有差异，请参阅 TLS 1.3。 （由 Christian Heimes 在 bpo-32947 [https://bugs.python.org/issue?@action=redirect&bpo=32947], bpo-20995 [https://bugs.python.org/issue?@action=redirect&bpo=20995], bpo-29136 [https://bugs.python.org/issue?@action=redirect&bpo=29136], bpo-30622 [https://bugs.python.org/issue?@action=redirect&bpo=30622] 以及 bpo-33618 [https://bugs.python.org/issue?@action=redirect&bpo=33618] 中贡献。）

SSLSocket 和 SSLObject 不再具有公共构造器。 直接实例化从未成为有文档和受支持的特性。 实际必须通过 SSLContext 的方法 wrap_socket() 和 wrap_bio() 来创建。 （由 Christian Heimes 在 bpo-32951 [https://bugs.python.org/issue?@action=redirect&bpo=32951] 中贡献。）

用于设置最小和最大 TLS 协议版本的 OpenSSL 1.1 API 现已可用，名称分别为 SSLContext.minimum_version 和 SSLContext.maximum_version。 受支持的协议由几个新增旗标指定，例如 HAS_TLSv1_1。 （由 Christian Heimes 在 bpo-32609 [https://bugs.python.org/issue?@action=redirect&bpo=32609] 中贡献。）

string

string.Template 现在允许你有选择地分别修改带大括号的占位符和不带大括号的占位符所对应的正则表达式模式。 （由 Barry Warsaw 在 bpo-1198569 [https://bugs.python.org/issue?@action=redirect&bpo=1198569] 中贡献。）

subprocess

subprocess.run() 函数接受新的 capture_output 关键字参数。 当其为真值时，将会捕获 stdout 和 stderr。 这相当于将 subprocess.PIPE 作为 stdout 和 stderr 参数传入。 （由 Bo Bayles 在 bpo-32102 [https://bugs.python.org/issue?@action=redirect&bpo=32102] 中贡献。）

subprocess.run 函数和 subprocess.Popen 构造器现在接受 text 关键字参数作为 universal_newlines 的别名。 （由 Andrew Clegg 在 bpo-31756 [https://bugs.python.org/issue?@action=redirect&bpo=31756] 中贡献。）

在 Windows 中当重定向标准句柄时 close_fds 的默认值由 False 改为 True。 现在可以在重定向标准句柄时将 close_fds 设为真值。 参阅 subprocess.Popen。 这意味着现在 close_fds 在所有受支持的平台上默认值均为 True。 （由 Segev Finer 在 bpo-19764 [https://bugs.python.org/issue?@action=redirect&bpo=19764] 中贡献。）

在 subprocess.call(), subprocess.run() 期间或在 Popen 上下文管理器中，subprocess 模块现在能更优雅地处理 KeyboardInterrupt。 它现在会等待一小段时间以便子进程退出，然后再继续处理 KeyboardInterrupt 异常。 （由 Gregory P. Smith 在 bpo-25942 [https://bugs.python.org/issue?@action=redirect&bpo=25942] 中贡献。）

sys

新增 sys.breakpointhook() 钩子函数，供内置的 breakpoint() 进行调用。 （由 Barry Warsaw 在 bpo-31353 [https://bugs.python.org/issue?@action=redirect&bpo=31353] 中贡献。）

在 Android 中新增的 sys.getandroidapilevel() 会返回构建时的 Android API 版本。 （由 Victor Stinner 在 bpo-28740 [https://bugs.python.org/issue?@action=redirect&bpo=28740] 中贡献。）

新的 sys.get_coroutine_origin_tracking_depth() 函数会返回当前协程的由新的 sys.set_coroutine_origin_tracking_depth() 所设定的原始跟踪深度。 asyncio 已转换为使用这个新 API 代替已弃用的 sys.set_coroutine_wrapper()。 （由 Nathaniel J. Smith 在 bpo-32591 [https://bugs.python.org/issue?@action=redirect&bpo=32591] 中贡献。）

time

PEP 564 [https://www.python.org/dev/peps/pep-0564] 向 time 模块增加六个具有纳秒级精度的新函数:

time.clock_gettime_ns()

time.clock_settime_ns()

time.monotonic_ns()

time.perf_counter_ns()

time.process_time_ns()

time.time_ns()

增加了新的时钟标识符:

time.CLOCK_BOOTTIME (Linux): 与 time.CLOCK_MONOTONIC 相似，不同点在于它还包括任何系统挂起的时间。

time.CLOCK_PROF (FreeBSD, NetBSD 和 OpenBSD): 高精度的分进程 CPU 计时器。

time.CLOCK_UPTIME (FreeBSD, OpenBSD): 该时间的绝对值是系统运行且未挂起的时间，提供准确的正常运行时间度量。

新的 time.thread_time() 和 time.thread_time_ns() 函数可用于获取每线程的 CPU 时间度量。 （由 Antoine Pitrou 在 bpo-32025 [https://bugs.python.org/issue?@action=redirect&bpo=32025] 中贡献。）

新的 time.pthread_getcpuclockid() 函数会返回特定线程中 CPU 时钟的时钟 ID。

tkinter

新的 tkinter.ttk.Spinbox 类现已可用。 （由 Alan Moore 在 bpo-32585 [https://bugs.python.org/issue?@action=redirect&bpo=32585] 中贡献。）

tracemalloc

tracemalloc.Traceback 的行为更接近正规的回溯，会对所有帧按从最旧到最新来排序。 Traceback.format() 现在接受负的 limit，并会将结果截短至排在第 abs(limit) 位的旧帧。 如果要获得旧的行为，请在 Traceback.format() 中使用新的 most_recent_first 参数。 （由 Jesse Bakker 在 bpo-32121 [https://bugs.python.org/issue?@action=redirect&bpo=32121] 中贡献。）

types

新的 WrapperDescriptorType, MethodWrapperType, MethodDescriptorType 和 ClassMethodDescriptorType 类现已可用。 （由 Manuel Krebber 和 Guido van Rossum 在 bpo-29377 [https://bugs.python.org/issue?@action=redirect&bpo=29377] 以及 Serhiy Storchaka 在 bpo-32265 [https://bugs.python.org/issue?@action=redirect&bpo=32265] 中贡献。）

新的 types.resolve_bases() 函数会以 PEP 560 [https://www.python.org/dev/peps/pep-0560] 所规定的方式动态解析 MRO 条目。 （由 Ivan Levkivskyi 在 bpo-32717 [https://bugs.python.org/issue?@action=redirect&bpo=32717] 中贡献。）

unicodedata

内部 unicodedata 数据库已升级为使用 Unicode 11 [https://www.unicode.org/versions/Unicode11.0.0/]。 （由 Benjamin Peterson 贡献。）

unittest

新的 -k 命令行选项允许通过名称子字符串或类似于 Unix shell 的模式来筛选测试项。 例如，python -m unittest -k foo 将运行 foo_tests.SomeTest.test_something, bar_tests.SomeTest.test_foo，但不会运行 bar_tests.FooTest.test_something。 （由 Jonas Haag 在 bpo-32071 [https://bugs.python.org/issue?@action=redirect&bpo=32071] 中贡献。）

unittest.mock

现在 sentinel 属性会在它们被 复制 或 封存 时保存其标识。 （由 Serhiy Storchaka 在 bpo-20804 [https://bugs.python.org/issue?@action=redirect&bpo=20804] 中贡献。）

新的 seal() 函数允许 Mock 对实例进行密封，这将禁止进一步创建属性模拟。 密封会以递归方式应用于自身模拟的所有属性。 （由 Mario Corchero 在 bpo-30541 [https://bugs.python.org/issue?@action=redirect&bpo=30541] 中贡献。）

urllib.parse

urllib.parse.quote() 已经从 RFC 2396 [https://datatracker.ietf.org/doc/html/rfc2396.html] 更新为 RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html]，将 ~ 添加到默认情况下从未引用的字符集。 （由 Christian Theune 和 Ratnadeep Debnath 在 bpo-16285 [https://bugs.python.org/issue?@action=redirect&bpo=16285] 中贡献。）

uu

uu.encode() 函数现在接受可选的 backtick 关键字参数。 当其为真时，零会以 '`' 而非空格来表示。 （由 Xiang Zhang 在 bpo-30103 [https://bugs.python.org/issue?@action=redirect&bpo=30103] 中贡献。）

uuid

新的 UUID.is_safe 属性会从平台中继有关是否使用多进程安全模式来生成所需 UUID 的信息。 （由 Barry Warsaw 在 bpo-22807 [https://bugs.python.org/issue?@action=redirect&bpo=22807] 中贡献。）

uuid.getnode() 现在更倾向于统一管理的 MAC 地址而不是本地管理的 MAC 地址。 这样可以更好地保证从 uuid.uuid1() 返回的 UUID 的全局唯一性。 如果只有本地管理的 MAC 地址可用，则返回首个找到的此类地址。 （由 Barry Warsaw 在 bpo-32107 [https://bugs.python.org/issue?@action=redirect&bpo=32107] 中贡献。）

warnings

默认警告过滤器的初始化已进行以下更改:

通过命令行选项（包括 -b 以及新的 CPython 专属的 -X dev 选项）启用的警告总是会通过 sys.warnoptions 属性被传递给警告机制。

通过命令行或环境变量启用的警告过滤器现在具有以下优先顺序:

用于 -b (或 -bb) 的 BytesWarning 过滤器

通过 -W 选项指定的任何过滤器

通过 PYTHONWARNINGS 环境变量指定的任何过滤器

任何其他 CPython 专属过滤器（例如 -X dev 模式中新增的 default 过滤器）

由警告机制所定义的任何隐式过滤器

在 CPython 调试版本 中，现在默认情况下会显示所有警告（隐式过滤器列表为空）

（由 Nick Coghlan 和 Victor Stinner 在 bpo-20361 [https://bugs.python.org/issue?@action=redirect&bpo=20361], bpo-32043 [https://bugs.python.org/issue?@action=redirect&bpo=32043] 以及 bpo-32230 [https://bugs.python.org/issue?@action=redirect&bpo=32230] 中贡献。）

在单文件脚本和交互式提示符中，默认情况下会再次显示已弃用警告。 详情参见 PEP 565: 在 __main__ 中显示 DeprecationWarning。 （由 Nick Coghlan 在 bpo-31975 [https://bugs.python.org/issue?@action=redirect&bpo=31975] 中贡献。）

xml.etree

find() 方法中的 ElementPath 描述词现在可以将当前节点文本与 [. = "text"] 进行比较，而不仅是子节点中的文本。 描述词还允许添加空格以提高可读性。 （由 Stefan Behnel 在 bpo-31648 [https://bugs.python.org/issue?@action=redirect&bpo=31648] 中贡献。）

xmlrpc.server

SimpleXMLRPCDispatcher.register_function 现在可以被用作装饰器。 （由 Xiang Zhang 在 bpo-7769 [https://bugs.python.org/issue?@action=redirect&bpo=7769] 中贡献。）

zipapp

函数 create_archive() 现在接受可选的 filter 参数，以允许用户选择哪些文件应被加入归档包。 （由 Irmen de Jong 在 bpo-31072 [https://bugs.python.org/issue?@action=redirect&bpo=31072] 中贡献。）

函数 create_archive() 现在接受可选的 compressed 参数，以生成压缩归档包。 另外也加入了命令行选项 --compress 以支持压缩。 （由 Zhiming Wang 在 bpo-31638 [https://bugs.python.org/issue?@action=redirect&bpo=31638] 中贡献。）

zipfile

ZipFile 现在接受新的 compresslevel 形参，以控制压缩级别。 （由 Bo Bayles 在 bpo-21417 [https://bugs.python.org/issue?@action=redirect&bpo=21417] 中贡献。）

ZipFile 所创建的归档包中的子目录现在会按字母表顺序保存。 （由 Bernhard M. Wiedemann 在 bpo-30693 [https://bugs.python.org/issue?@action=redirect&bpo=30693] 中贡献。）

C API 的改变

已实现了用于线程本地存储的新 API。 相关概述请参阅 PEP 539: 用于线程局部存储的新 C API，完整参考文档请查看 线程专属存储 (TSS) API。 （由 Masayuki Yamamoto 在 bpo-25658 [https://bugs.python.org/issue?@action=redirect&bpo=25658] 中贡献。)

新的 上下文变量 功能开放了许多 新的 C API。

新的 PyImport_GetModule() 函数会返回之前所导入的具有给定名称的模块。 （由 Eric Snow 在 bpo-28411 [https://bugs.python.org/issue?@action=redirect&bpo=28411] 中贡献。）

新的 Py_RETURN_RICHCOMPARE 宏可以简化丰富比较函数的编写。 （由 Petr Victorin 在 bpo-23699 [https://bugs.python.org/issue?@action=redirect&bpo=23699] 中贡献。）

新的 Py_UNREACHABLE 宏可用于标记不可到达的代码路径。 （由 Barry Warsaw 在 bpo-31338 [https://bugs.python.org/issue?@action=redirect&bpo=31338] 中贡献。）

tracemalloc 现在通过新的 PyTraceMalloc_Track() 和 PyTraceMalloc_Untrack() 函数公开了一个 C API。 （由 Victor Stinner 在 bpo-30054 [https://bugs.python.org/issue?@action=redirect&bpo=30054] 中贡献。）

新的 import__find__load__start() 和 import__find__load__done() 静态标记可用于跟踪模块导入。 （由 Christian Heimes 在 bpo-31574 [https://bugs.python.org/issue?@action=redirect&bpo=31574] 中贡献。）

结构体 PyMemberDef, PyGetSetDef, PyStructSequence_Field, PyStructSequence_Desc 和 wrapperbase 的字段 name 和 doc 现在的类型为 const char * 而不是 char *。 （由 Serhiy Storchaka 在 bpo-28761 [https://bugs.python.org/issue?@action=redirect&bpo=28761] 中贡献。）

PyUnicode_AsUTF8AndSize() 和 PyUnicode_AsUTF8() 的结果类型现在是 const char * 而非 char *。 （由 Serhiy Storchaka 在 bpo-28769 [https://bugs.python.org/issue?@action=redirect&bpo=28769] 中贡献。）

PyMapping_Keys(), PyMapping_Values() 和 PyMapping_Items() 的结果现在肯定是列表，而非可能是列表也可能是元组。 （由 Oren Milman 在 bpo-28280 [https://bugs.python.org/issue?@action=redirect&bpo=28280] 中贡献。）

添加了函数 PySlice_Unpack() 和 PySlice_AdjustIndices()。 （由 Serhiy Storchaka 在 bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867] 中贡献。）

PyOS_AfterFork() 已弃用，建议改用新的 functions PyOS_BeforeFork(), PyOS_AfterFork_Parent() 和 PyOS_AfterFork_Child()。 （由 Antoine Pitrou 在 bpo-16500 [https://bugs.python.org/issue?@action=redirect&bpo=16500] 中贡献。）

曾经作为公共 API 一部分的 PyExc_RecursionErrorInst 单例已被移除，因为它的成员永远不会被清理，可能在解释器的最终化过程中导致段错误。 由 Xavier de Gaye 在 bpo-22898 [https://bugs.python.org/issue?@action=redirect&bpo=22898] 和 bpo-30697 [https://bugs.python.org/issue?@action=redirect&bpo=30697] 中贡献。

添加 C API 对使用 timezone 的构造器 PyTimeZone_FromOffset() 和 PyTimeZone_FromOffsetAndName() 的时区的支持，以及通常 PyDateTime_TimeZone_UTC 使用 UTC 单例。 由 Paul Ganssle 在 bpo-10381 [https://bugs.python.org/issue?@action=redirect&bpo=10381] 中贡献。

PyThread_start_new_thread() 和 PyThread_get_thread_ident() 的结果类型以及 PyThreadState_SetAsyncExc() 的 id 形参类型由 long 改为 unsigned long。 （由 Serhiy Storchaka 在 bpo-6532 [https://bugs.python.org/issue?@action=redirect&bpo=6532] 中贡献。）

现在 PyUnicode_AsWideCharString() 在第二个参数为 NULL 且 wchar_t* 字符串包含空字符时会引发 ValueError。 （由 Serhiy Storchaka 在 bpo-30708 [https://bugs.python.org/issue?@action=redirect&bpo=30708] 中贡献。）

对启动顺序以及动态内存分配器管理的更改意味着早已记录在案的，对在调用大多数 C API 函数之前调用 Py_Initialize() 的要求的依赖现在变得更加强烈，未遵循此要求可能导致嵌入式应用程序中的段错误。 请参阅此文档的 移植到 Python 3.7 一节以及 C API 文档的 在Python初始化之前 一节了解更多细节。

新的 PyInterpreterState_GetID() 会返回给定解释器的唯一 ID。 （由 Eric Snow 在 bpo-29102 [https://bugs.python.org/issue?@action=redirect&bpo=29102] 中贡献。）

现在当启用 UTF-8 模式 时 Py_DecodeLocale(), Py_EncodeLocale() 会使用 UTF-8 编码。 （由 Victor Stinner 在 bpo-29240 [https://bugs.python.org/issue?@action=redirect&bpo=29240] 中贡献。）

PyUnicode_DecodeLocaleAndSize() 和 PyUnicode_EncodeLocale() 现在会为 surrogateescape 错误句柄使用当前区域编码。 （由 Victor Stinner 在 bpo-29240 [https://bugs.python.org/issue?@action=redirect&bpo=29240] 中贡献。）

PyUnicode_FindChar() 的 start 和 end 形参的行为现在调整为与字符串切片类似。 （由 Xiang Zhang 在 bpo-28822 [https://bugs.python.org/issue?@action=redirect&bpo=28822] 中贡献。）

构建的改变

对于 --without-threads 构建的支持已被移除。 threading 模块现在将总是可用。 （由 Antoine Pitrou 在 bpo-31370 [https://bugs.python.org/issue?@action=redirect&bpo=31370] 中贡献。）

在非 OSX UNIX 平台上已不再包含用于构建 _ctypes 模块的完整 libffi 副本。 现在当在此类平台上构建 _ctypes 时需要事先装有 libffi 的副本。 （由 Zachary Ware 在 bpo-27979 [https://bugs.python.org/issue?@action=redirect&bpo=27979] 中贡献。）

Windows 构建过程不再依赖 Subversion 来拉取外部源码，而是改用一段 Python 脚本从 GitHub 下载 zip 文件。 如果未在系统中找到 Python 3.6 (通过 py -3.6)，则会使用 NuGet 下载一份 32 位的 Python 副本用于此目的。 （由 Zachary Ware 在 bpo-30450 [https://bugs.python.org/issue?@action=redirect&bpo=30450] 中贡献。）

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。

性能优化

通过移植更多代码来使用 METH_FASTCALL 的约定，可以显著地减少调用 C 代码中实现的各类标准库的很多方法的开销。 （由 Victor Stinner 在 bpo-29300 [https://bugs.python.org/issue?@action=redirect&bpo=29300]、bpo-29507 [https://bugs.python.org/issue?@action=redirect&bpo=29507]、bpo-29452 [https://bugs.python.org/issue?@action=redirect&bpo=29452] 以及 bpo-29286 [https://bugs.python.org/issue?@action=redirect&bpo=29286] 中贡献。）

通过各种优化方式，使 Python 在 Linux 上的启动时间缩短了 10%，在 macOS 上缩短了 30%。 （由 Victor Stinner, INADA Naoki 在 bpo-29585 [https://bugs.python.org/issue?@action=redirect&bpo=29585] 中，以及 Ivan Levkivskyi 在 bpo-31333 [https://bugs.python.org/issue?@action=redirect&bpo=31333] 中贡献。）

由于避免创建绑定方法案例的字节码更改，方法调用速度现在加快了 20%。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26110 [https://bugs.python.org/issue?@action=redirect&bpo=26110] 中贡献。）

对 asyncio 模块里面的一些常用函数做了显著的性能优化。

asyncio.get_event_loop() 函数已经改用 C 重新实现，使其执行速度加快了 15 倍。 （由 Yury Selivanov 在 bpo-32296 [https://bugs.python.org/issue?@action=redirect&bpo=32296] 中贡献。）

asyncio.Future 回调管理已经过优化。 （由 Yury Selivanov 在 bpo-32348 [https://bugs.python.org/issue?@action=redirect&bpo=32348] 中贡献。）

asyncio.gather() 的执行速度现在加快了 15%。 （由 Yury Selivanov 在 bpo-32355 [https://bugs.python.org/issue?@action=redirect&bpo=32355] 中贡献。）

当 delay 参数为零或负值时 asyncio.sleep() 的执行速度现在加快了 2 倍。 （由 Andrew Svetlov 在 bpo-32351 [https://bugs.python.org/issue?@action=redirect&bpo=32351] 中贡献。）

asyncio 调试模式的执行开销已获减轻。 （由 Antoine Pitrou 在 bpo-31970 [https://bugs.python.org/issue?@action=redirect&bpo=31970] 中贡献。）

作为 PEP 560 工作 的结果，typing 的导入时间已减少了 7 倍，许多与类型相关的操作现在会执行得更快。 （由 Ivan Levkivskyi 在 bpo-32226 [https://bugs.python.org/issue?@action=redirect&bpo=32226] 中贡献。）

sorted() 和 list.sort() 已经过优化，在通常情况下执行速度可提升 40-75%。 （由 Elliot Gorokhovsky 在 bpo-28685 [https://bugs.python.org/issue?@action=redirect&bpo=28685] 中贡献。）

dict.copy() 的执行速度现在加快了 5.5 倍。 （由 Yury Selivanov 在 bpo-31179 [https://bugs.python.org/issue?@action=redirect&bpo=31179] 中贡献。）

当 name 未找到并且 obj 未重载 object.__getattr__() 或 object.__getattribute__() 时 hasattr() 和 getattr() 现在会比原来快大约 4 倍。 （由 INADA Naoki 在 bpo-32544 [https://bugs.python.org/issue?@action=redirect&bpo=32544] 中贡献。）

在字符串中搜索特定的 Unicode 字符（例如乌克兰语字母“Є”）会比搜索其他字符慢上 25 倍。 而现在最坏情况下也只会慢上 3 倍。 （由 Serhiy Storchaka 在 bpo-24821 [https://bugs.python.org/issue?@action=redirect&bpo=24821] 中贡献。）

collections.namedtuple() 工厂对象已经重写实现，使得创建具名元组的速度加快了 4 到 6 倍。 （由 Jelle Zijlstra 在 bpo-28638 [https://bugs.python.org/issue?@action=redirect&bpo=28638] 中贡献，进一步的改进由 INADA Naoki, Serhiy Storchaka 和 Raymond Hettinger 贡献。）

现在 date.fromordinal() 和 date.fromtimestamp() 在通常情况下执行速度可提升 30%。 （由 Paul Ganssle 在 bpo-32403 [https://bugs.python.org/issue?@action=redirect&bpo=32403] 中贡献。）

由于使用了 os.scandir()，现在 os.fwalk() 函数执行速度提升了 2 倍。 （由 Serhiy Storchaka 在 bpo-25996 [https://bugs.python.org/issue?@action=redirect&bpo=25996] 中贡献。）

由于使用了 os.scandir() 函数，shutil.rmtree() 函数的执行速度已经提升了 20--40%。 （由 Serhiy Storchaka 在 bpo-28564 [https://bugs.python.org/issue?@action=redirect&bpo=28564] 中贡献。）

正则表达式 忽略大小写的匹配和搜索已获得优化。 现在搜索某些模式的速度提升了 20 倍。 （由 Serhiy Storchaka 在 bpo-30285 [https://bugs.python.org/issue?@action=redirect&bpo=30285] 中贡献。）

re.compile() 现在会将 flags 形参转换为 int 对象，如果它是 RegexFlag 的话。 它现在会和 Python 3.5 一样快，而比 Python 3.6 快大约 10%，实际速度取决于具体的模式。 （由 INADA Naoki 在 bpo-31671 [https://bugs.python.org/issue?@action=redirect&bpo=31671] 中贡献。）

selectors.EpollSelector, selectors.PollSelector 和 selectors.DevpollSelector 这几个类的 modify() 方法在重负载下可以加快 10% 左右。 （由 Giampaolo Rodola' 在 bpo-30014 [https://bugs.python.org/issue?@action=redirect&bpo=30014] 中贡献。）

常量折叠已经从窥孔优化器迁移至新的 AST 优化器，后者可以以更高的一致性来执行优化。 （由 Eugene Toder 和 INADA Naoki 在 bpo-29469 [https://bugs.python.org/issue?@action=redirect&bpo=29469] 和 bpo-11549 [https://bugs.python.org/issue?@action=redirect&bpo=11549] 中贡献。）

abc 中的大部分函数和方法已经用 C 重写。 这使得创建抽像基类以及调用其 isinstance() 和 issubclass() 的速度加快了 1.5 倍。 这也使得 Python 启动耗时减少了 10%。 （由 Ivan Levkivskyi 和 INADA Naoki 在 bpo-31333 [https://bugs.python.org/issue?@action=redirect&bpo=31333] 中贡献。）

在不构造子类时，通过使用快速路径构造器使得 datetime.date 和 datetime.datetime 的替代构造器获得了显著的速度提升。 （由 Paul Ganssle 在 bpo-32403 [https://bugs.python.org/issue?@action=redirect&bpo=32403] 中贡献。）

在特定情况下 array.array 实例的比较速度已获得很大提升。 现在当比较存放相同的整数类型的值的数组时会比原来快 10 到 70 倍。 （由 Adrian Wielgosik 在 bpo-24700 [https://bugs.python.org/issue?@action=redirect&bpo=24700] 中贡献。）

在大多数平台上 math.erf() 和 math.erfc() 函数现在使用（更快的）C 库实现。 （由 Serhiy Storchaka 在 bpo-26121 [https://bugs.python.org/issue?@action=redirect&bpo=26121] 中贡献。）

其他 CPython 实现的改变

跟踪钩子现在可以选择不接收 line 而是选择从解释器接收 opcode 事件，具体做法是在被跟踪的帧上相应地设置新的 f_trace_lines 和 f_trace_opcodes 属性。 （由 Nick Coghlan 在 bpo-31344 [https://bugs.python.org/issue?@action=redirect&bpo=31344] 中贡献。）

修复了一些命名空间包模块属性的一致性问题。 命名空间模块对象的 __file__ 被设置为 None (原先未设置)，对象的 __spec__.origin 也被设置为 None (之前为字符串 "namespace")。 参见 bpo-32305 [https://bugs.python.org/issue?@action=redirect&bpo=32305]。 而且，命名空间模块对象的 __spec__.loader 被设置的值与 __loader__ 相同 (原先前者被设置为 None)。 参见 bpo-32303 [https://bugs.python.org/issue?@action=redirect&bpo=32303]。

locals() 字典现在以变量定义的词法顺序显示。 原先未定义顺序。 （由 Raymond Hettinger 在 bpo-32690 [https://bugs.python.org/issue?@action=redirect&bpo=32690] 中贡献。）

distutils upload 命令不会再试图将行结束字符 CR 改为 CRLF。 这修复了 sdists 的一个以与 CR 等价的字节结束的数据损坏问题。 （由 Bo Bayles 在 bpo-32304 [https://bugs.python.org/issue?@action=redirect&bpo=32304] 中贡献。）

已弃用的 Python 行为

在推导式和生成器表达式中的 yield 语句（包括 yield 和 yield from 子句）现在已弃用（最左端的 for 子句中的可迭代对象表达式除外）。 这确保了推导式总是立即返回适当类型的容器（而不是有可能返回 generator iterator 对象），这样生成器表达式不会试图将它们的隐式输出与任何来自显式 yield 表达式的输出交错起来。 在 Python 3.7 中，这样的表达式会在编译时引发 DeprecationWarning，在 Python 3.8 中则将引发 SyntaxError。 （由 Serhiy Storchaka 在 bpo-10544 [https://bugs.python.org/issue?@action=redirect&bpo=10544] 中贡献。）

从 object.__complex__() 返回一个 complex 的子类的行为已弃用并将在未来的 Python 版本中引发错误。 这使得 __complex__() 的行为与 object.__int__() 和 object.__float__() 保持一致。 （由 Serhiy Storchaka 在 bpo-28894 [https://bugs.python.org/issue?@action=redirect&bpo=28894] 中贡献。）

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

aifc

aifc.openfp() 已弃用并将在 Python 3.9 中被移除。 请改用 aifc.open()。 （由 Brian Curtin 在 bpo-31985 [https://bugs.python.org/issue?@action=redirect&bpo=31985] 中贡献。）

asyncio

对 asyncio.Lock 和其他 asyncio 同步原语的 await 实例的直接支持已弃用。 想要获取并释放同步资源必须使用异步上下文管理器。 （由 Andrew Svetlov 在 bpo-32253 [https://bugs.python.org/issue?@action=redirect&bpo=32253] 中贡献。）

asyncio.Task.current_task() 和 asyncio.Task.all_tasks() 方法已弃用。 （由 Andrew Svetlov 在 bpo-32250 [https://bugs.python.org/issue?@action=redirect&bpo=32250] 中贡献。）

collections

在 Python 3.8 中，collections.abc 内的抽象基类将不会再通过常规的 collections 模块公开。 这有助于更清晰地区别具体类与抽象基类。 （由 Serhiy Storchaka 在 bpo-25988 [https://bugs.python.org/issue?@action=redirect&bpo=25988] 中贡献。）

dbm

dbm.dumb 现在支持读取只读文件，且当其未被更改时不会再写入索引文件。 现在如果索引文件丢失并在 'r' 与 'w' 模式下被重新创建，则会发出已弃用警告（在未来的 Python 发布版中将改为错误）。 （由 Serhiy Storchaka 在 bpo-28847 [https://bugs.python.org/issue?@action=redirect&bpo=28847] 中贡献。）

enum

在 Python 3.8 中，尝试在 Enum 类中检查非 Enum 对象将引发 TypeError (例如 1 in Color)；类似地，尝试在 Flag 成员中检查非 Flag 对象也将引发 TypeError (例如 1 in Perm.RW)；目前，两种操作均会返回 False。 （由 Ethan Furman 在 bpo-33217 [https://bugs.python.org/issue?@action=redirect&bpo=33217] 中贡献。）

gettext

使用非整数值在 gettext 中选择复数形式现在已弃用。 它从未正确地发挥作用。 （由 Serhiy Storchaka 在 bpo-28692 [https://bugs.python.org/issue?@action=redirect&bpo=28692] 中贡献。）

importlib

下列方法 MetaPathFinder.find_module() (被 MetaPathFinder.find_spec() 替代) 和 PathEntryFinder.find_loader() (被 PathEntryFinder.find_spec() 替代) 都在 Python 3.4 中已弃用，现在会引发 DeprecationWarning。 （由 Matthias Bussonnier 在 bpo-29576 [https://bugs.python.org/issue?@action=redirect&bpo=29576] 中贡献）

importlib.abc.ResourceLoader ABC 已弃用，推荐改用 importlib.abc.ResourceReader。

locale

locale.format() 已弃用，请改用 locale.format_string()。 （由 Garvit 在 bpo-10379 [https://bugs.python.org/issue?@action=redirect&bpo=10379] 中贡献。）

macpath

macpath 现在已弃用，将在 Python 3.8 中被移除。 （由 Chi Hsuan Yen 在 bpo-9850 [https://bugs.python.org/issue?@action=redirect&bpo=9850] 中贡献。）

threading

dummy_threading 和 _dummy_thread 已弃用。 构建禁用线程的 Python 已不再可能。 请改用 threading。 （由 Antoine Pitrou 在 bpo-31370 [https://bugs.python.org/issue?@action=redirect&bpo=31370] 中贡献。）

socket

socket.htons() 和 socket.ntohs() 中的静默参数截断已弃用。 在未来的 Python 版本中，如果传入的参数长度大于 16 比特位，将会引发异常。 （由 Oren Milman 在 bpo-28332 [https://bugs.python.org/issue?@action=redirect&bpo=28332] 中贡献。）

ssl

ssl.wrap_socket() 已弃用。 请改用 ssl.SSLContext.wrap_socket()。 （由 Christian Heimes 在 bpo-28124 [https://bugs.python.org/issue?@action=redirect&bpo=28124] 中贡献。）

sunau

sunau.openfp() 已弃用并将在 Python 3.9 中被移除。 请改用 sunau.open()。 （由 Brian Curtin 在 bpo-31985 [https://bugs.python.org/issue?@action=redirect&bpo=31985] 中贡献。）

sys

已弃用 sys.set_coroutine_wrapper() 和 sys.get_coroutine_wrapper()。

未写入文档的 sys.callstats() 函数已弃用并将在未来的 Python 版本中被移除。 （由 Victor Stinner 在 bpo-28799 [https://bugs.python.org/issue?@action=redirect&bpo=28799] 中贡献。）

wave

wave.openfp() 已弃用并将在 Python 3.9 中被移除。 请改用 wave.open()。 （由 Brian Curtin 在 bpo-31985 [https://bugs.python.org/issue?@action=redirect&bpo=31985] 中贡献。）

已弃用的 C API 函数和类型

如果 Py_LIMITED_API 未设定或设定为范围在 0x03050400 和 0x03060000 (不含) 之间，或为 0x03060100 或更高的值，函数 PySlice_GetIndicesEx() 已弃用并被一个宏所替代。 （由 Serhiy Storchaka 在 bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867] 中贡献。）

PyOS_AfterFork() 已弃用。 请改用 PyOS_BeforeFork(), PyOS_AfterFork_Parent() 或 PyOS_AfterFork_Child()。 （由 Antoine Pitrou 在 bpo-16500 [https://bugs.python.org/issue?@action=redirect&bpo=16500] 中贡献。）

平台支持的移除

官方已不再支持 FreeBSD 9 及更旧的版本。

为了完整的 Unicode 支持，包括在扩展模块之内，*nix 平台现在至少应当提供 C.UTF-8 (完整区域), C.utf8 (完整区域) 或 UTF-8 (LC_CTYPE 专属区域) 中的一个作为基于 ASCII 的传统 C 区域的替代。

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 配置文件 [https://github.com/python/cpython/blob/v3.7.13/.travis.yml] 提供了一个使用 CPython 测试套件中的 SSL 兼容性测试架构 [https://github.com/python/cpython/tree/3.10/Tools/ssl/multissltests.py] 基于 OpenSSL 1.1.0 而非系统所提供的过时 OpenSSL 进行构建和链接的例子。

API 与特性的移除

下列特性与 API 已从 Python 3.7 中移除:

os.stat_float_times() 函数已被移除。 它在 Python 2.3 中被引入用于向下兼容 Python 2.2，并自 Python 3.1 起就已弃用。

在 re.sub() 的替换模块中由 '\' 与一个 ASCII 字母构成的未知转义在 Python 3.5 中已弃用，现在将会引发错误。

在 tarfile.TarFile.add() 中移除了对 exclude 参数的支持。 它在 Python 2.7 和 3.2 中已弃用。 请改用 filter 参数。

ntpath 模块中的 splitunc() 函数在 Python 3.1 中已弃用，现在已被移除。 请改用 splitdrive() 函数。

collections.namedtuple() 不再支持 verbose 形参或 _source 属性，该属性会显示为具名元组类所生成的源代码。 这是加速类创建的设计优化的一部分。 （由 Jelle Zijlstra 在 bpo-28638 [https://bugs.python.org/issue?@action=redirect&bpo=28638] 中贡献，进一步的改进由 INADA Naoki, Serhiy Storchaka 和 Raymond Hettinger 贡献。）

函数 bool(), float(), list() 和 tuple() 不再接受关键字参数。 int() 的第一个参数现在只能作为位置参数传入。

移除了之前在 Python 2.4 中已弃用的 plistlib 模块的类 Plist, Dict 和 _InternalDict。 作为函数 readPlist() 和 readPlistFromBytes() 返回结果的 Dict 值现在为普通 dict。 你不能再使用属性访问来获取这些字典的项。

asyncio.windows_utils.socketpair() 函数已被移除。 请改用 socket.socketpair() 函数，它自 Python 3.5 起就在所有平台上可用。 asyncio.windows_utils.socketpair 在 Python 3.5 及更新版本上只是 socket.socketpair 的别名。

asyncio 不再将 selectors 和 _overlapped 模块导出为 asyncio.selectors 和 asyncio._overlapped。 请将 from asyncio import selectors 替换为 import selectors。

现在已禁止直接实例化 ssl.SSLSocket 和 ssl.SSLObject 对象。 相应构造器从未写入文档、也从未作为公有构造器进行测试或设计。 用户应当使用 ssl.wrap_socket() 或 ssl.SSLContext。 （由 Christian Heimes 在 bpo-32951 [https://bugs.python.org/issue?@action=redirect&bpo=32951] 中贡献。）

未被使用的 distutils install_misc 命令已被移除。 （由 Eric N. Vander Weele 在 bpo-29218 [https://bugs.python.org/issue?@action=redirect&bpo=29218] 中贡献。）

移除的模块

fpectl 模块已被移除。 它从未被默认启用，从未在 x86-64 上正确发挥效果，并且它对 Python ABI 的改变会导致 C 扩展的意外损坏。 （由 Nathaniel J. Smith 在 bpo-29137 [https://bugs.python.org/issue?@action=redirect&bpo=29137] 中贡献。）

Windows 专属的改变

Python 启动器（py.exe）可以接受 32 位或 64 位标记而 不必 同时指定一个小版本。 因此 py -3-32 和 py -3-64 与 py -3.7-32 均为有效，并且现在还接受 -m-64 和 -m.n-64 来强制使用 64 位 python 命令，即使是本应使用 32 位的时候。 如果指定版本不可用则 py.exe 将报错退出。 （由 Steve Barnes 在 bpo-30291 [https://bugs.python.org/issue?@action=redirect&bpo=30291] 中贡献。）

启动器可以运行 py -0 来列出已安装的所有 python，默认版本会以星号标出。 运行 py -0p 将同时列出相应的路径。 如果运行 py 时指定了无法匹配的版本，它将显示 简短形式 的可用版本列表。 （由 Steve Barnes 在 bpo-30362 [https://bugs.python.org/issue?@action=redirect&bpo=30362] 中贡献。）

移植到 Python 3.7

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

Python 行为的更改

async 和 await 现在是保留关键字。 使用了这些名称作为标识符的代码现在将引发 SyntaxError。 （由 Jelle Zijlstra 在 bpo-30406 [https://bugs.python.org/issue?@action=redirect&bpo=30406] 中贡献。）

PEP 479 [https://www.python.org/dev/peps/pep-0479] 在 Python 3.7 中对所有代码启用，在协程和生成器中直接或间接引发的 StopIteration 异常会被转换为 RuntimeError 异常。 （由 Yury Selivanov 在 bpo-32670 [https://bugs.python.org/issue?@action=redirect&bpo=32670] 中贡献。）

object.__aiter__() 方法不再能被声明为异步的。 （由 Yury Selivanov 在 bpo-31709 [https://bugs.python.org/issue?@action=redirect&bpo=31709] 中贡献。）

由于一个疏忽，之前的 Python 版本会错误地接受以下语法:

f(1 for x in [1],)

class C(1 for x in [1]):
    pass

现在 Python 3.7 会正确地引发 SyntaxError，因为生成器表达式总是必须直接包含于一对括号之内， 且前后都不能有逗号，仅在调用时可以忽略重复的括号。 （由 Serhiy Storchaka 在 bpo-32012 [https://bugs.python.org/issue?@action=redirect&bpo=32012] 和 bpo-32023 [https://bugs.python.org/issue?@action=redirect&bpo=32023] 中贡献。）

现在当使用 -m 开关时，会将初始工作目录添加到 sys.path，而不再是一个空字符串（即在每次导入时动态地指明当前工作目录）。 任何会检测该空字符串，或是以其他方式依赖之前行为的的程序将需要进行相应的更新（例如改为还要检测 os.getcwd() 或 os.path.dirname(__main__.__file__)，具体做法首先要取决于为何要对代码执行空字符串检测）。

Python API 的变化

socketserver.ThreadingMixIn.server_close() 现在会等待所有非守护线程完成。 将新增的 socketserver.ThreadingMixIn.block_on_close 类属性设为 False 可获得 3.7 之前版本的行为。 （由 Victor Stinner 在 bpo-31233 [https://bugs.python.org/issue?@action=redirect&bpo=31233] 和 bpo-33540 [https://bugs.python.org/issue?@action=redirect&bpo=33540] 中贡献。）

socketserver.ForkingMixIn.server_close() 现在会等等所有子进程完成。 将新增的 socketserver.ForkingMixIn.block_on_close 类属性设为 False 可获得 3.7 之前版本的行为。 （由 Victor Stinner 在 bpo-31151 [https://bugs.python.org/issue?@action=redirect&bpo=31151] 和 bpo-33540 [https://bugs.python.org/issue?@action=redirect&bpo=33540] 中贡献。）

某些情况下 locale.localeconv() 函数现在会临时将 LC_CTYPE 区域设置为 LC_NUMERIC 的值。 （由 Victor Stinner 在 bpo-31900 [https://bugs.python.org/issue?@action=redirect&bpo=31900] 中贡献。）

如果 path 为字符串 pkgutil.walk_packages() 现在会引发 ValueError。 之前则是返回一个空列表。 （由 Sanyam Khurana 在 bpo-24744 [https://bugs.python.org/issue?@action=redirect&bpo=24744] 中贡献。）

string.Formatter.format() 的格式字符串参数现在为 仅限位置 参数。 将其作为关键字参数传入的方式自 Python 3.5 起已弃用。 （由 Serhiy Storchaka 在 bpo-29193 [https://bugs.python.org/issue?@action=redirect&bpo=29193] 中贡献。）

类 http.cookies.Morsel 的属性 key, value 和 coded_value 现在均为只读。 对其赋值的操作自 Python 3.5 起已弃用。 要设置它们的值请使用 set() 方法。 （由 Serhiy Storchaka 在 bpo-29192 [https://bugs.python.org/issue?@action=redirect&bpo=29192] 中贡献。）

os.makedirs() 的 mode 参数不会再影响新建中间层级目录的权限位。 要设置它们的文件权限你可以在唤起 makedirs() 之前设置 umask。 （由 Serhiy Storchaka 在 bpo-19930 [https://bugs.python.org/issue?@action=redirect&bpo=19930] 中贡献。）

struct.Struct.format 的类型现在是 str 而非 bytes。 （由 Victor Stinner 在 bpo-21071 [https://bugs.python.org/issue?@action=redirect&bpo=21071] 中贡献。）

parse_multipart() 现在接受 encoding 和 errors 参数并返回与 FieldStorage 同样的结果：对于非文件字段，与键相关联的值是一个字符串列表，而非字节串。 （由 Pierre Quentel 在 bpo-29979 [https://bugs.python.org/issue?@action=redirect&bpo=29979] 中贡献。）

由于 socket 中的内部更改，在由旧版 Python 中的 socket.share 所创建的套接字上调用 socket.fromshare() 已不受支持。

BaseException 的 repr 已更改为不包含末尾的逗号。 大多数异常都会受此更改影响。 （由 Serhiy Storchaka 在 bpo-30399 [https://bugs.python.org/issue?@action=redirect&bpo=30399] 中贡献。）

datetime.timedelta 的 repr 已更改为在输出中包含关键字参数。 （由 Utkarsh Upadhyay 在 bpo-30302 [https://bugs.python.org/issue?@action=redirect&bpo=30302] 中贡献。）

因为 shutil.rmtree() 现在是使用 os.scandir() 函数实现的，用户指定的句柄 onerror 现在被调用时如果列目录失败会附带第一个参数 os.scandir 而不是 os.listdir。

未来可能加入在正则表达式中对 Unicode 技术标准 #18 [https://unicode.org/reports/tr18/] 中嵌套集合与集合操作的支持。 这会改变现有语法。 为了推动这项未来的改变，目前在有歧义的情况下会引发 FutureWarning。 这包括以字面值 '[' 开头或包含字面值字符序列 '--', '&&', '~~' 以及 '||' 的集合。 要避免警告，请用反斜杠对其进行转义。 （由 Serhiy Storchaka 在 bpo-30349 [https://bugs.python.org/issue?@action=redirect&bpo=30349] 中贡献。）

基于可以匹配空字符串的 正则表达式 对字符串进行拆分的结果已被更改。 例如基于 r'\s*' 的拆分现在不仅会像原先那样拆分空格符，而且会拆分所有非空格字符之前和字符串结尾处的空字符串。 通过将模式修改为 r'\s+' 可以恢复原先的行为。 自 Python 3.5 开始此类模式将会引发 FutureWarning。

对于同时匹配空字符串和非空字符串的模式，在其他情况下搜索所有匹配的结果也可能会被更改。 例如在字符串 'a\n\n' 中，模式 r'(?m)^\s*?$' 将不仅会匹配位置 2 和 3 上的空字符串，还会匹配位置 2--3 上的字符串 '\n'。 想要只匹配空行，模式应当改写为 r'(?m)^[^\S\n]*$'。

re.sub() 现在会替换与前一个的非空匹配相邻的空匹配。 例如 re.sub('x*', '-', 'abxd') 现在会返回 '-a-b--d-' 而不是 '-a-b-d-' ('b' 和 'd' 之间的第一个减号是替换 'x'，而第二个减号则是替换 'x' 和 'd' 之间的空字符串)。

（由 Serhiy Storchaka 在 bpo-25054 [https://bugs.python.org/issue?@action=redirect&bpo=25054] 和 bpo-32308 [https://bugs.python.org/issue?@action=redirect&bpo=32308] 中贡献。）

re.escape() 更改为只转义正则表达式特殊字符，而不转义 ASCII 字母、数字和 '_' 以外的所有字符。 （由 Serhiy Storchaka 在 bpo-29995 [https://bugs.python.org/issue?@action=redirect&bpo=29995] 中贡献。）

tracemalloc.Traceback 帧现在是按从最旧到最新排序，以便与 traceback 更为一致。 （由 Jesse Bakker 在 bpo-32121 [https://bugs.python.org/issue?@action=redirect&bpo=32121] 中贡献。）

在支持 socket.SOCK_NONBLOCK 或 socket.SOCK_CLOEXEC 标志位的操作系统上，socket.type 不再应用它们。 因此，像 if sock.type == socket.SOCK_STREAM 之类的检测会在所有平台上按预期的方式工作。 （由 Yury Selivanov 在 bpo-32331 [https://bugs.python.org/issue?@action=redirect&bpo=32331] 中贡献。）

在 Windows 上当重定向标准句柄时，subprocess.Popen 的 close_fds 参数的默认值从 False 更改为 True。 如果你以前依赖于在使用带有标准 io 重定向的 subprocess.Popen 时所继承的句柄，则必须传入 close_fds=False 以保留原先的行为，或是使用 STARTUPINFO.lpAttributeList。

importlib.machinery.PathFinder.invalidate_caches() -- 此方法隐式地影响 importlib.invalidate_caches() -- 现在会删除 sys.path_importer_cache 中被设为 None 的条目。 （由 Brett Cannon 在 bpo-33169 [https://bugs.python.org/issue?@action=redirect&bpo=33169] 中贡献。）

在 asyncio 中，loop.sock_recv(), loop.sock_sendall(), loop.sock_accept(), loop.getaddrinfo(), loop.getnameinfo() 已被更改为正确的协程方法以与培训五日文档相匹配。 之前，这些方法会返回 asyncio.Future 实例。 （由 Yury Selivanov 在 bpo-32327 [https://bugs.python.org/issue?@action=redirect&bpo=32327] 中贡献。）

asyncio.Server.sockets 现在会返回服务器套接字列表的副本，而不是直接地返回它。 （由 Yury Selivanov 在 bpo-32662 [https://bugs.python.org/issue?@action=redirect&bpo=32662] 中贡献。）

Struct.format 现在是一个 str 实例而非 bytes 实例。 （由 Victor Stinner 在 bpo-21071 [https://bugs.python.org/issue?@action=redirect&bpo=21071] 中贡献。）

现在可以通过将 required=True 传给 ArgumentParser.add_subparsers() 使得 argparse 子解析器成为必需的。 （由 Anthony Sottile 在 bpo-26510 [https://bugs.python.org/issue?@action=redirect&bpo=26510] 中贡献。）

ast.literal_eval() 现在更为严格。 任意地加减数字已不再被允许。 （由 Serhiy Storchaka 在 bpo-31778 [https://bugs.python.org/issue?@action=redirect&bpo=31778] 中贡献。）

当一个日期超出 0001-01-01 到 9999-12-31 范围时 Calendar.itermonthdates 现在将始终如一地引发异常，以便支持不能容忍此类异常的应用程序，可以使用新增的 Calendar.itermonthdays3 和 Calendar.itermonthdays4。 这些新方法返回元组，并且其不受 datetime.date 所支持的范围限制。 （由 Alexander Belopolsky 在 bpo-28292 [https://bugs.python.org/issue?@action=redirect&bpo=28292] 中贡献。）

collections.ChainMap 现在会保留底层映射的顺序。 （由 Raymond Hettinger 在 bpo-32792 [https://bugs.python.org/issue?@action=redirect&bpo=32792] 中贡献。）

如果在解释器关闭期间被调用，concurrent.futures.ThreadPoolExecutor 和 concurrent.futures.ProcessPoolExecutor 的 submit() 方法现在会引发 RuntimeError。 （由 Mark Nemec 在 bpo-33097 [https://bugs.python.org/issue?@action=redirect&bpo=33097] 中贡献。）

configparser.ConfigParser 构造器现在使用 read_dict() 来处理默认值，以使其行为与解析器的其余部分保持致。 在默认字典中的非字符串键和值现在会被隐式地转换为字符串。 （由 James Tocknell 在 bpo-23835 [https://bugs.python.org/issue?@action=redirect&bpo=23835] 中贡献。）

一些未写入文档的内部导入已被移除。 一个例子是 os.errno 已不再可用；应改为直接使用 import errno。 请注意此类未写入文档的内部导入可能未经通知地随时被移除，甚至是在微版本号发行版中移除。

C API 的变化

函数 PySlice_GetIndicesEx() 被认为对于大小可变的序列来说并不安全。 如果切片索引不是 int 的实例，而是实现了 __index__() 方法的对象，则序列可以在其长度被传给 PySlice_GetIndicesEx() 之后调整大小。 这可能导致返回超出序列长度的索引号。 为了避免可能的问题，请使用新增的函数 PySlice_Unpack() 和 PySlice_AdjustIndices()。 （由 Serhiy Storchaka 在 bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867] 中贡献。）

CPython 字节码的改变

新增了两个操作码: LOAD_METHOD 和 CALL_METHOD。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26110 [https://bugs.python.org/issue?@action=redirect&bpo=26110] 中贡献。）

STORE_ANNOTATION 操作码已被移除。 （由 Mark Shannon 在 bpo-32550 [https://bugs.python.org/issue?@action=redirect&bpo=32550] 中贡献。）

Windows 专属的改变

用于重载 sys.path 的文件现在命名为 <python-executable>._pth 而不是 'sys.path'。 请参阅 查找模块 了解更多信息。 （由 Steve Dower 在 bpo-28137 [https://bugs.python.org/issue?@action=redirect&bpo=28137] 中贡献。）

其他 CPython 实现的改变

为了准备在未来对公开的 CPython 运行时初始化 API 进行潜在更改（请参阅 PEP 432 [https://www.python.org/dev/peps/pep-0432] 获取最初但略为过时的文稿），CPython 内部的启动和配置管理逻辑已经过大幅重构。 虽然这些更新旨在对嵌入式应用程序和常规的 CPython CLI 用户都完全透明，但它们在这里被提及是因为重构会改变解释器启动期间许多操作的内部顺序，因此可能提示出原先隐藏的缺陷，这可能存在于嵌入式应用程序中，或是在 CPython 自身内部。 （最初由 Nick Coghlan 和 Eric Snow 作为 bpo-22257 [https://bugs.python.org/issue?@action=redirect&bpo=22257] 的一部分贡献，并由 Nick, Eric 和 Victor Stinner 在一系列其他问题报告中进一步更新）。 已知会受到影响的一些细节：

目前 PySys_AddWarnOptionUnicode() 对嵌入式应用程序不可用，因为在调用 Py_Initialize 之前需要创建一个 Unicode 对象。 请改用 PySys_AddWarnOption()。

嵌入式应用程序通过 PySys_AddWarnOption() 所添加的警告过滤器现在应该以更高的一致性优先于由解释器所设置的默认过滤器

由于默认警告过滤器的配置方式发生了变化，将 Py_BytesWarningFlag 设置为大于一的值不再足以在发出 BytesWarning 消息的同时将其转换为异常。 而是改为必须设置旗标（以便首先发出警告），以及添加显式的 error::BytesWarning 警告过滤器来将其转换为异常。

由于编译器处理文档字符串的方式发生了变化，一个仅由文档字符串构成的函数体中隐式的 return None 现在被标记为在与文档字符串相同的行，而不是在函数的标题行。

当前异常状态已从帧对象移到协程对象。 这会简化解释器并修正由于在进入或退出生成器时具有交换异常状态而导致的一些模糊错误。 （由 Mark Shannon 在 bpo-25612 [https://bugs.python.org/issue?@action=redirect&bpo=25612] 中贡献。）

Python 3.7.1 中的重要变化

从 3.7.1 开始，Py_Initialize() 现在始终会读取并遵循与 Py_Main() 相同的环境设置（在更早的 Python 版本中，它会遵循一个错误定义的环境变量子集，而在 Python 3.7.0 中则会由于 bpo-34247 [https://bugs.python.org/issue?@action=redirect&bpo=34247] 而完全不读取它们）。 如果不想要此行为，请在调用 Py_Initialize() 之前将 Py_IgnoreEnvironmentFlag 设为 1。

在 3.7.1 中，上下文变量的 C API 已 获得更新 以使用 PyObject 指针。 另请参阅 bpo-34762 [https://bugs.python.org/issue?@action=redirect&bpo=34762]。

在 3.7.1 中，当提供不带末尾新行的输入时 tokenize 模块现在会隐式地添加 NEWLINE 形符。 此行为现在已与 C 词法分析器的内部行为相匹配。 （由 Ammar Askar 在 bpo-33899 [https://bugs.python.org/issue?@action=redirect&bpo=33899] 中贡献。）

Python 3.7.2 中的重要变化

在 3.7.2 中，Windows 下的 venv 不再复制原来的二进制文件，而是改为创建名为 python.exe 和 pythonw.exe 的重定向脚本。 这解决了一个长期存在的问题，即所有虚拟环境在每次 Python 升级后都必须进行升级或是重新创建。 然而，要注意此发布版仍然要求重新创建虚拟环境以获得新的脚本。

Python 3.7.6 中的重要变化

出于重要的安全性考量，asyncio.loop.create_datagram_endpoint() 的 reuse_address 形参不再被支持。 这是由 UDP 中的套接字选项 SO_REUSEADDR 的行为导致的。 更多细节请参阅 loop.create_datagram_endpoint() 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228 [https://bugs.python.org/issue?@action=redirect&bpo=37228] 中贡献。。）

Python 3.7.10 中的重要变化

早先的 Python 版本允许使用 ; 和 & 作为 urllib.parse.parse_qs() 和 urllib.parse.parse_qsl() 中 query 形参的分隔键。 出于安全考虑，也为了遵循更新的 W3C 推荐设置，这已被改为只允许单个分隔键，默认为 &。 这一改变还会影响 cgi.parse() 和 cgi.parse_multipart() 因为它们在内部使用了受影响的函数。 要了解更多细节，请查看它们各自的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967] 中贡献。）

Python 3.6 有什么新变化

编者

Elvis Pranskevichus <elvis@magic.io>, Yury Selivanov <yury@magic.io>

本文解释了与3.5相比，Python 3.6中的新功能。 Python 3.6于2016年12月23日发布。请参阅 changelog [https://docs.python.org/3.6/whatsnew/changelog.html] 以获取完整的更改列表。

参见

PEP 494 [https://www.python.org/dev/peps/pep-0494] - Python 3.6 发布计划

摘要 -- 发布重点

新的语法特性：

PEP 498, 格式化字符串字面值

PEP 515, 数字字面值中的下划线。

PEP 526 , 变量标注语法。

PEP 525，异步生成器。

PEP 530: 异步推导式。

新的库模块：

secrets: PEP 506 -- Python 标准库增加一个密码模块。

CPython 实现的改进：

根据 Raymond Hettinger 的提议 [https://mail.python.org/pipermail/python-dev/2012-December/123028.html] 已将 dict 类型重新实现为使用 更紧凑的表示形式 并类似于 PyPy dict implementation [https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html]。 这使得字典所使用的内存相对于 Python 3.5 版减少了 20% 到 25%。

类创建的定制过程通过 新协议 得到了简化。

类属性的定义顺序 现在会被保留。

现在 **kwargs 中的元素会与传给函数的关键字参数 保持对应顺序。

添加了 DTrace 和 SystemTap 探测支持

新的 PYTHONMALLOC 环境变量可被用来调试解释器的内存分配和访问错误。

标准库中的重大改进：

asyncio 模块获得了许多新特性，显著的可用性和性能提升，以及大量的问题修正。 从 Python 3.6 开始 asyncio 模块不再处于待定状态，它已被视为稳定 API。

实现了新的 文件系统路径协议 以支持 路径类对象。 所有操作路径的标准库函数已被更新为使用新的协议。

datetime 模块已获得对 本地时间消歧义 的支持。

typing 模块获得了大量的 改进。

tracemalloc 模块已被大幅重写，现在将被用于为 ResourceWarning 提供更好的输出，并为内存分配错误提供更好的诊断。 请参阅 PYTHONMALLOC 一节 来了解详情。

安全改进：

添加了 secrets 模块以简化适用于密码管理的高加密强度伪随机数的生成，例如账户验证、安全凭据等场景。

在 Linux 上，现在 os.urandom() 会阻塞直到系统的 urandom 熵池被初始化以提升安全性。 其理由参见 PEP 524 [https://www.python.org/dev/peps/pep-0524]。

hashlib 和 ssl 模块现在支持 OpenSSL 1.1.0。

ssl 模块的默认设置和特性集已得到改进。

hashlib 模块获得了对 BLAKE2, SHA-3 和 SHAKE 哈希算法以及 scrypt() 密钥派生函数的支持。

Windows改进：

PEP 528 和 PEP 529, 将Windows文件系统和控制台的编码更改为UTF-8

在交互式地使用 py.exe 启动器时，当用户未（通过命令行参数或配置文件）指定版本时不再优先选择 Python 2 而是选择 Python 3。 对声明行的处理则保持不变 —— 在这种情况下 "python" 还是指 Python 2。

python.exe 和 pythonw.exe 已被标记为支持长路径，这意味着不再有 260 个字符的路径长度限制。 详情参见 移除 MAX_PATH 限制。

可以添加一个 ._pth 文件来强制使用隔离模式和完整指定所有搜索路径来避免注册表和环境查找。 更多信息请参阅 相关文档。

现在 python36.zip 文件可以作为推断 PYTHONHOME 的标志。 更多信息请参阅 相关文档。

新的特性

PEP 498: 格式化字符串字面值

PEP 498 [https://www.python.org/dev/peps/pep-0498] 引入了一种新型的字符串字面值: f-字符串，或称 格式化字符串字面值。

格式化字符串字面值带有 'f' 前缀并且类似于 str.format() 所接受的格式字符串。 其中包含由花括号包围的替换字段。 替换字段属于表达式，它们会在运行时被求值，然后使用 format() 协议进行格式化:

>>> 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'

参见

PEP 498 [https://www.python.org/dev/peps/pep-0498] -- 字符串字面值插值。

PEP 由 Eric V. Smith 撰写并实现

特性文档。

PEP 526: 变量标注的语法

PEP 484 [https://www.python.org/dev/peps/pep-0484] 引入了函数形参类型标注即类型提示的标准。 这个 PEP 为 Python 添加了标注变量类型的语法，包括类变量和实例变量:

primes: List[int] = []

captain: str  # Note: no initial value!

class Starship:
    stats: Dict[str, int] = {}

与函数标注一样，Python 解释器不会为变量标注附加任何特殊含义，仅会将其保存在类或模块的 __annotations__ 属性中。

与静态类型语法的变量声明不同，标注语法的目的是通过抽象语法树和 __annotations__ 属性提供一个简单方式来为第三方工具和库指定结构化类型元数据。

参见

PEP 526 [https://www.python.org/dev/peps/pep-0526] -- 变量标注的语法。

PEP 由 Ryan Gonzalez, Philip House, Ivan Levkivskyi, Lisa Roach, 和 Guido van Rossum 撰写，由 Ivan Levkivskyi 实现。

使用或将要使用此新语法的工具有: mypy [http://www.mypy-lang.org/], pytype [https://github.com/google/pytype], PyCharm 等等。

PEP 515: 数字字面值中的下划线。

PEP 515 [https://www.python.org/dev/peps/pep-0515] 增加了在数字字面值中使用下划线的能力以改善可读性。 例如:

>>> 1_000_000_000_000_000
1000000000000000
>>> 0x_FF_FF_FF_FF
4294967295

单个下划线允许用在数码之间和任何数制指示符之后。 一行内不允许有开头、末尾或多个下划线。

字符串格式化 微语言现在也支持以 '_' 选项来表示用下划线作为浮点表示类型和整数表示类型 'd' 的千位分隔符。 对于整数表示类型 'b', 'o', 'x' 和 'X'，将每隔 4 个数码插入一个下划线:

>>> '{:_}'.format(1000000)
'1_000_000'
>>> '{:_x}'.format(0xFFFFFFFF)
'ffff_ffff'

参见

PEP 515 [https://www.python.org/dev/peps/pep-0515] -- 数字字面值中的下划线。

PEP 由 Georg Brandl 和 Serhiy Storchaka 撰写

PEP 525: 异步生成器

PEP 492 [https://www.python.org/dev/peps/pep-0492] 将对原生协程和 async / await 语法的支持引入到 Python 3.5 中。 但 Python 3.5 实现的一个明显限制是不可能在同一函数体中同时使用 await 和 yield。 在 Python 3.6 中此限制已被解除，这样就就能够定义 异步生成器:

async def ticker(delay, to):
    """Yield numbers from 0 to *to* every *delay* seconds."""
    for i in range(to):
        yield i
        await asyncio.sleep(delay)

这个新语法允许更快速且更精简的代码。

参见

PEP 525 [https://www.python.org/dev/peps/pep-0525] -- 异步生成器

PEP 由 Yury Selivanov 撰写并实现

PEP 530: 异步推导式

PEP 530 [https://www.python.org/dev/peps/pep-0530] 添加了对在列表、集合与字典推导式和生成器表达式中使用 async for 的支持:

result = [i async for i in aiter() if i % 2]

此外，await 表达式也在所有种类的推导式中得到支持:

result = [await fun() for fun in funcs if await condition()]

参见

PEP 530 [https://www.python.org/dev/peps/pep-0530] -- 异步推导式

PEP 由 Yury Selivanov 撰写并实现

PEP 487: 更简单的自定义类创建

现在可以在不使用元类的情况下自定义子类的创建。 当一个新的子类被创建时将在基类上调用新的 __init_subclass__ 类方法:

class PluginBase:
    subclasses = []

    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.subclasses.append(cls)

class Plugin1(PluginBase):
    pass

class Plugin2(PluginBase):
    pass

为了让来自 __init_subclass__() 实现的零参数 super() 调用能正确工作，自定义元类必须保证新的 __classcell__ 命名空间入口被传播到 type.__new__ (如 创建类对象 中所描述)。

参见

PEP 487 [https://www.python.org/dev/peps/pep-0487] -- 更简单的自定义类创建

PEP 由 Martin Teichmann 撰写并实现。

特性文档

PEP 487: 描述器协议的增强

PEP 487 [https://www.python.org/dev/peps/pep-0487] 扩展了描述器协议以包括新的可选方法 __set_name__()。 当创建一个新类时，这个新方法将在定义中包括的所有描述器上被调用，为它们提供对所定义类的引用以及在类命名中间中给予描述器的名称。 换句话说，描述器的实例现在能知道描述器在所有者类中的属性名称:

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

    # this is the new initializer:
    def __set_name__(self, owner, name):
        self.name = name

class Model:
    int_field = IntField()

参见

PEP 487 [https://www.python.org/dev/peps/pep-0487] -- 更简单的自定义类创建

PEP 由 Martin Teichmann 撰写并实现。

特性文档

PEP 519: 添加文件系统路径协议

文件系统路径历来被表示为 str 或 bytes 对象。 这使得编写对文件系统路径进行操作的代码的人会假定这种对象只能是这两种类型之一（不考虑表示文件描述符的 int 因为它不是文件路径）。 不幸的是，这种假定阻止了像 pathlib 这样的文件系统路径的替代对象表示形式与包括 Python 标准库在内的现有代码协同工作。

为了修正这种情况，一个由 os.PathLike 表示的新接口被定义出来。 通过实现 __fspath__() 方法，对象可以表明它代表一个路径。 这样一个对象就能以 str 或 bytes 对象的形式提供文件系统路径的低层级表示。 这意味着如果一个对象实现了 os.PathLike 或者是表示文件系统路径的 str 或 bytes 对象它就会被当作是 路径型对象。 代码可以使用 os.fspath()、os.fsdecode() 或 os.fsencode() 来显式地获取一个路径型对象的 str 和/或 bytes 表示形式。

内置 open() 函数已被更新为接受 os.PathLike 对象，就像 os 和 os.path 模块中的所有相关函数和标准库中的大多数其他函数和类一样。 os.DirEntry 类和 pathlib 中的相关类也已被更新以实现 os.PathLike。

希望对于针对文件系统路径操作的基本函数的更新将会使得第三方代码都能隐式地支持所有 路径型对象 而无须修改任何代码，或者至少只需极少的修改（例如当对路径型对象进行操作之前在代码的开头调用 os.fspath() 即可）。

下面的这些示例说明了新的接口是如何让 pathlib.Path 被更容易、更透明地用于已有代码的:

>>> 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'

（由 Brett Cannon, Ethan Furman, Dusty Phillips 和 Jelle Zijlstra 实现。）

参见

PEP 519 [https://www.python.org/dev/peps/pep-0519] -- 添加文件系统路径协议

PEP 由 Brett Cannon 和 Koos Zevenhoven 撰写。

PEP 495: 消除本地时间的歧义

在世界上大多数地方，过去和将来都会存在本地时钟后移的时候。 在这种时候，本地时钟会在同一天内两次显示相同的时间。 对于这些情况，本地时钟所显示的（或存储在 Python datetime 实例中的）信息将不足以标识某个特定的时间点。

PEP 495 [https://www.python.org/dev/peps/pep-0495] 为 datetime.datetime 和 datetime.time 类的实例添加了新的 fold 属性以在本地时间相同的两个时间点之间进行区分:

>>> 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

fold 属性的值在大多数实例上均为 0，只有在代表存在歧义的时间的第二个（按发生顺序）实例上例外。

参见

PEP 495 [https://www.python.org/dev/peps/pep-0495] -- 消除本地时间的歧义

PEP 由 Alexander Belopolsky 和 Tim Peters 撰写，由 Alexander Belopolsky 实现。

PEP 529: 将 Windows 文件系统编码格式更改为 UTF-8

在表示文件系统路径时最好是使用 str (Unicode) 而不是 bytes。 不过，在某些情况下使用 bytes 就是足够而且正确的。

在 Python 3.6 之前，在 Windows 上使用 bytes 路径值可能会导致数据丢失。 有了这一更改，现在 Windows 上将支持使用 bytes 来表示路径，前提是这些 bytes 值是用 sys.getfilesystemencoding() 所返回的编码格式来编码的，现在此编码格式默认为 'utf-8'。

不使用 str 来表示路径的应用程序应当使用 os.fsencode() 和 os.fsdecode() 来确保 bytes 被正确地编码。 要恢复以前的行为，请设置 PYTHONLEGACYWINDOWSFSENCODING 或调用 sys._enablelegacywindowsfsencoding()。

有关详细信息和可能需要的代码修改的讨论，请参见 PEP 529 [https://www.python.org/dev/peps/pep-0529] 。

PEP 528: 将 Windows 控制台编码格式更改为 UTF-8

现在，Windows 上的默认控制台将接受所有 Unicode 字符并为 Python 代码提供正确读取的 str 对象。sys.stdin, sys.stdout 和 sys.stderr 现在默认使用 utf-8 编码格式。

此更改仅在使用交互式控制台时适用，而不适用于重定向文件或管道。 要恢复以前使用交互式控制台时的行为，请设置 PYTHONLEGACYWINDOWSSTDIO。

参见

PEP 528 [https://www.python.org/dev/peps/pep-0528] -- 将 Windows 控制台编码格式更改为 UTF-8

PEP 由 Steve Dower 撰写并实现。

PEP 520: 保留类属性定义顺序

类定义体中的属性具有自然的排序：与名称在源代码中出现的顺序相同。 现在此排序会在新类的 __dict__ 属性中被保留。

并且，实际的默认类 execution 命名空间 (从 type.__prepare__() 返回) 现在将是一个保留插入顺序的映射对象。

参见

PEP 520 [https://www.python.org/dev/peps/pep-0520] -- 保留类属性定义顺序

PEP 由 Eric Snow 撰写并实现

PEP 468: 保留关键字参数顺序

函数签名中的 **kwargs 现在将保证是一个保留插入顺序的映射对象。

参见

PEP 468 [https://www.python.org/dev/peps/pep-0468] -- 保留关键字参数顺序

PEP 由 Eric Snow 撰写并实现

新的 dict 实现

dict 类型现在会使用一种基于 Raymond Hettinger 的提议 [https://mail.python.org/pipermail/python-dev/2012-December/123028.html] 的“紧凑”表示形式，该表示形式 最初由 PyPy 实现 [https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html]。 新的The memory usage of the new dict() 的内存占用相比 Python 3.5 减少了 20% 到 25%。

这个新实现对原始顺序的保留被认为是一个实现细节而不应当被依赖（这在将来可能会改变，但我们希望在改变语言规范以强制所有当前和将来的 Python 实现都使用保留顺序的语义之前先在几个发布版的语言内部使用这个新的 dict 实现；这也有助于让仍在使用随机迭代顺序的旧版本语言例如 Python 3.5 保持向下兼容性）。

（由 INADA Naoki 在 bpo-27350 [https://bugs.python.org/issue?@action=redirect&bpo=27350] 中贡献。 该特性 最初由 Raymond Hettinger 提议 [https://mail.python.org/pipermail/python-dev/2012-December/123028.html]。）

PEP 523: 向 CPython 添加帧求值 API

虽然 Python 为自定义代码执行方式提供了广泛的支持，但有一个地方它没有这样做，那就是帧对象的求值。 如果您想在 Python 中拦截帧的求值，那么确实没有除了直接操纵自定义函数的函数指针以外的任何办法。

PEP 523 [https://www.python.org/dev/peps/pep-0523] 通过提供使帧求值在 C 语言层级上可插入的 API 从而改变了这一状况。 这将允许调试器和 JIT 等工具在 Python 代码开始执行之前拦截帧求值。 这样就能允许 Python 代码使用替代性求值实现，跟踪帧求值等做法。

这个 API 并不是受限 C API 的组成部分，它被标记为私有以表明该 API 的使用受到限制并且只适用于非常少的、低层级的用例。 这个 API 的语义将根据需要随 Python 的一起发生变化。

参见

PEP 523 [https://www.python.org/dev/peps/pep-0523] -- 向 CPython 添加帧求值 API

PEP 由 Brett Cannon 和 Dino Viehland 撰写。

PYTHONMALLOC 环境变量

新的 PYTHONMALLOC 环境变量允许设置 Python 内存分配器并安装调试钩子。

现在将可以使用 PYTHONMALLOC=debug 在以发布模式编译的 Python 上为 Python 内存分配器安装调试钩子。 调试钩子的效果:

新分配的内存中填充字节 0xCB

释放的内存中填充了字节 0xDB

检测违反 Python 内存分配器 API 的操作。 例如，PyObject_Free() 在 PyMem_Malloc() 所分配的内存块上被调用。

在缓冲区开始之前检测写操作（缓冲区下溢）

在缓冲区结束后检测写操作（缓冲区溢出）

检测当调用 PYMEM_DOMAIN_OBJ (如: PyObject_Malloc()) 和 PYMEM_DOMAIN_MEM (如: PyMem_Malloc()) 域的分配器函数时 GIL 已被持有。

检查是否保留了 GIL 也是Python 3.6 的新特性。

请参阅 PyMem_SetupDebugHooks() 函数来了解 Python 内存分配器上的调试钩子。

现在还可以使用 PYTHONMALLOC=malloc 为所有的 Python 内存分配强制使用 C 库的 malloc() 分配器。 这在以发布模式编译的 Python 上使用外部内存调试器如 Valgrind 时会很有用处。

发生错误时，Python 内存分配器上的调试钩子现在会使用 tracemalloc 模块来获取内存块被分配所在位置上的回溯。

使用 python3.6 -X tracemalloc=5 (在回溯中存储 5 帧) 的缓冲区溢出的致命错误示例:

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__
  ...

（由 Victor Stinner 在 bpo-26516 [https://bugs.python.org/issue?@action=redirect&bpo=26516] 和 bpo-26564 [https://bugs.python.org/issue?@action=redirect&bpo=26564] 中贡献。）

DTrace 和 SystemTap 探测支持

Python 现在可以附带 --with-dtrace 来构建以便为解释器中的下列事件启用静态标记:

函数调用/返回

垃圾收集开始/完成

执行的代码行。

这可被用来在生产环境中控制正在运行的解释器，而无需重新编译特定的 调试版本 或提供应用专属的性能分析/调试代码。

更多信息，请参见 使用 DTrace 和 SystemTap 检测CPython 。

当前的实现已在 Linux 和 macOS 上进行了测试。将来可能会添加其他标记。

（由 Łukasz Langa 在 bpo-21590 [https://bugs.python.org/issue?@action=redirect&bpo=21590] 中贡献，基于 Jesús Cea Avión, David Malcolm 和 Nikhil Benesch 的补丁。）

其他语言特性修改

对Python 语言核心进行的小改动：

现在 global 或 nonlocal 语句必须以文本形式出现在同一作用域中首次使用受影响的名称之前。 在之前版本中这只是 SyntaxWarning。

现在可以将某个 特殊方法 设为 None 来表示相应操作不可用。 举例来说，如果某个类将 __iter__() 设为 None，则该类就将不可迭代。 （由 Andrew Barnert 和 Ivan Levkivskyi 在 bpo-25958 [https://bugs.python.org/issue?@action=redirect&bpo=25958] 中贡献。）

由重复的回溯行组成的长序列现在将被简化为 "[Previous line repeated {count} more times]" （请参阅 回溯 获取样例）。 （由 Emanuel Barry 在 bpo-26823 [https://bugs.python.org/issue?@action=redirect&bpo=26823] 中贡献。）

现在导入操作在无法找到模块时将引发新的异常 ModuleNotFoundError (ImportError 的子类)。 目前 (在 try-except 中) 检测 ImportError 的代码仍将有效。 （由 Eric Snow 在 bpo-15767 [https://bugs.python.org/issue?@action=redirect&bpo=15767] 中贡献。）

现在依赖于零参数形式 super() 的类方法在类创建期间从元类方法调用时将正确地生效。 （由 Martin Teichmann 在 bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722] 中贡献。）

新增模块

secrets

新的 secrets 模块的主要目的是提供一种直观的方式来可靠地生成适用于密码管理的高加密强度的伪随机值，如账户验证、安全凭据等等。

警告

注意 random 模块中的伪随机数发生器 不应 被用于安全目的。 请在 Python 3.6+ 上使用 secrets 而在 Python 3.5 及更早的版本上使用 os.urandom()。

参见

PEP 506 [https://www.python.org/dev/peps/pep-0506] -- Secrets模块被加入Python标准库

PEP 由 Steven D'Aprano 撰写并实现。

改进的模块

array

现在已被耗尽的输出 array.array 的迭代器将保持耗尽状态，即使迭代后的数组被扩展时也是如此。 这将与其他可变序列的行为保持一致。

由 Serhiy Storchaka 在 bpo-26492 [https://bugs.python.org/issue?@action=redirect&bpo=26492] 中贡献。

ast

新增了 ast.Constant AST 节点。 它可被外部 AST 优化器用于常量折叠操作。

由 Victor Stinner 在 bpo-26146 [https://bugs.python.org/issue?@action=redirect&bpo=26146] 中贡献。

asyncio

从 Python 3.6 开始 asyncio 模块不再处于暂定状态，其 API 被认为已经稳定。

自 Python 3.5.0 以来 asyncio 模块中值得注意的变化（由于暂定状态所有变化都已反向移植到 3.5.x）:

get_event_loop() 函数已更改为当在例程和回调中被调用时始终返回当前正在运行的循环。（由 Yury Selivanov 在 bpo-28613 [https://bugs.python.org/issue?@action=redirect&bpo=28613] 中贡献。）

ensure_future() 函数以及所有用到它的函数，比如 loop.run_until_complete()，现在将接受所有种类的 可等待对象。 （由 Yury Selivanov 贡献。）

新增 run_coroutine_threadsafe() 函数用于从其他线程向事件循环提交协程。（由 Vincent Michel 贡献。）

新增 Transport.is_closing() 方法用于检查传输是否正在关闭或已经关闭。 （由 Yury Selivanov 贡献。）

loop.create_server() 方法现在可以接受一个主机列表。 （由 Yann Sionneau 贡献。）

新增 loop.create_future() 方法用来创建 Future 对象。 这允许替代性的事件循环实现，比如 uvloop [https://github.com/MagicStack/uvloop]，以提供更快速的 asyncio.Future 实现。 （由 Yury Selivanov 在 bpo-27041 [https://bugs.python.org/issue?@action=redirect&bpo=27041] 中贡献。）

新增 loop.get_exception_handler() 方法用于获取当前异常处理器。 （由 Yury Selivanov 在 bpo-27040 [https://bugs.python.org/issue?@action=redirect&bpo=27040] 中贡献。）

新增 StreamReader.readuntil() 方法用于从流读取数据直到出现作为分隔符的字节序列。 （由 Mark Korenberg 贡献。）

StreamReader.readexactly() 的性能已获得提升。 （由 Mark Korenberg 在 bpo-28370 [https://bugs.python.org/issue?@action=redirect&bpo=28370] 中贡献。）

loop.getaddrinfo() 方法已获得优化已避免当地址已被解析时调用系统 getaddrinfo 函数。 （由 A. Jesse Jiryu Davis 贡献。）

loop.stop() 方法已被更改为在当前迭代之后立即停止循环。 任何作为上次迭代的结果被加入计划任务的新回调都将被丢弃。 （由 Guido van Rossum 在 bpo-25593 [https://bugs.python.org/issue?@action=redirect&bpo=25593] 中贡献。）

现在 Future.set_exception 在传入一个 StopIteration 异常的实例时将引发 TypeError。 （由 Chris Angelico 在 bpo-26221 [https://bugs.python.org/issue?@action=redirect&bpo=26221] 中贡献。）

新增 loop.connect_accepted_socket() 方法供接受 asyncio 以外的连接，但使用 asyncio 来处理它们的服务器使用。 （由 Jim Fulton 在 bpo-27392 [https://bugs.python.org/issue?@action=redirect&bpo=27392] 中贡献。）

现在 TCP_NODELAY 旗标将默认针对所有 TCP 传输进行设置。 （由 Yury Selivanov 在 bpo-27456 [https://bugs.python.org/issue?@action=redirect&bpo=27456] 中贡献。）

新增 loop.shutdown_asyncgens() 用来在结束循环之前正确地关闭现有的异步生成器。 （由 Yury Selivanov 在 bpo-28003 [https://bugs.python.org/issue?@action=redirect&bpo=28003] 中贡献。）

Future 和 Task 类现在已有经优化过的 C 实现使得 asyncio 代码加速至多 30%。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26081 [https://bugs.python.org/issue?@action=redirect&bpo=26081] 和 bpo-28544 [https://bugs.python.org/issue?@action=redirect&bpo=28544] 中贡献。）

binascii

b2a_base64() 函数现在接受可选的 newline 关键字参数用来控制是否要在返回值中添加换行符。 （由 Victor Stinner 在 bpo-25357 [https://bugs.python.org/issue?@action=redirect&bpo=25357] 中贡献。）

cmath

新增 cmath.tau (τ) 常量。 （由 Lisa Roach 在 bpo-12345 [https://bugs.python.org/issue?@action=redirect&bpo=12345] 中贡献，详情见 PEP 628 [https://www.python.org/dev/peps/pep-0628]。）

新增常量: cmath.inf 和 cmath.nan 用于匹配 math.inf 和 math.nan，以及 cmath.infj 和 cmath.nanj 用于匹配由 complex 的 repr 所使用的格式。 （由 Mark Dickinson 在 bpo-23229 [https://bugs.python.org/issue?@action=redirect&bpo=23229] 中贡献。）

collections

添加了新的 Collection 抽象基类用于表示有具体大小的可迭代容器类。 （由 Ivan Levkivskyi 在 bpo-27598 [https://bugs.python.org/issue?@action=redirect&bpo=27598] 中贡献并由 Neil Girdhar 撰写文档。）

添加了新的 Reversible 抽象基类用于表示同时提供 __reversed__() 方法的可迭代类。 （由 Ivan Levkivskyi 在 bpo-25987 [https://bugs.python.org/issue?@action=redirect&bpo=25987] 中贡献。）

新增代表异步生成器的 AsyncGenerator 抽象基类。 （由 Yury Selivanov 在 bpo-28720 [https://bugs.python.org/issue?@action=redirect&bpo=28720] 中贡献。）

namedtuple() 函数现在接受可选的关键字参数 module，当指定该参数时，它将被用作所返回的具名元组类的 __module__ 属性。 （由 Raymond Hettinger 在 bpo-17941 [https://bugs.python.org/issue?@action=redirect&bpo=17941] 中贡献。）

namedtuple() 的 verbose 和 rename 参数现在是仅限关键字参数。 （由 Raymond Hettinger 在 bpo-25628 [https://bugs.python.org/issue?@action=redirect&bpo=25628] 中贡献。）

递归的 collections.deque 实例现在可以被 pickle。 （由 Serhiy Storchaka 在 bpo-26482 [https://bugs.python.org/issue?@action=redirect&bpo=26482] 中贡献。）

concurrent.futures

ThreadPoolExecutor 类构造器现在接受可选的 thread_name_prefix 参数以便能够自定义由线程池所创建的线程的名称。 （由 Gregory P. Smith 在 bpo-27664 [https://bugs.python.org/issue?@action=redirect&bpo=27664] 中贡献。）

contextlib

增加了 contextlib.AbstractContextManager 类用来提供上下文管理器的抽象基类。 它为 __enter__() 提供了一个合理的默认实现，该实现将返回 self 并将 __exit__() 设为抽象方法。 在 typing 中增加了对应的类 typing.ContextManager。 （由 Brett Cannon 在 bpo-25609 [https://bugs.python.org/issue?@action=redirect&bpo=25609] 中贡献。）

datetime

datetime 和 time 类新增了 fold 属性用来在必要时消除本地时间的歧义。 在 datetime 中的许多函数已被更新为支持本地时间的消除歧义。 请参阅 本地时间消歧义 一节了解更多信息。 （由 Alexander Belopolsky 在 bpo-24773 [https://bugs.python.org/issue?@action=redirect&bpo=24773] 中贡献。）

现在 datetime.strftime() 和 date.strftime() 方法将支持 ISO 8601 日期指令符 %G, %u 和 %V。 （由 Ashley Anderson 在 bpo-12006 [https://bugs.python.org/issue?@action=redirect&bpo=12006] 中贡献。）.)

datetime.isoformat() 函数现在接受可选的 timespec 参数用来指定时间值要包括的额外组件数量。 （由 Alessandro Cucci 和 Alexander Belopolsky 在 bpo-19475 [https://bugs.python.org/issue?@action=redirect&bpo=19475] 中贡献。）

datetime.combine() 现在接受可选的 tzinfo 参数。 （由 Alexander Belopolsky 在 bpo-27661 [https://bugs.python.org/issue?@action=redirect&bpo=27661] 中贡献。）

decimal

新增 Decimal.as_integer_ratio() 方法，它返回一对整数 (n, d) 将给定的 Decimal 实例表示为一个最简形式且分母为正值的分数:

>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)

（由 Stefan Krah 和 Mark Dickinson 在 bpo-25928 [https://bugs.python.org/issue?@action=redirect&bpo=25928] 中贡献。）

distutils

The default_format attribute has been removed from distutils.command.sdist.sdist and the formats attribute defaults to ['gztar']. Although not anticipated, any code relying on the presence of default_format may need to be adapted. See bpo-27819 [https://bugs.python.org/issue?@action=redirect&bpo=27819] for more details.

email

通过多个构造器的 policy 关键字来启用的新 email API 已不再为暂定状态。 email 文档已被重新组织并重新撰写以聚集新 API，同时保留旧式 API 的原有文档。 （由 R. David Murray 在 bpo-24277 [https://bugs.python.org/issue?@action=redirect&bpo=24277] 中贡献。）

email.mime 中的类现在都接受可选的 policy 关键字参数。 （由 Berker Peksag 在 bpo-27331 [https://bugs.python.org/issue?@action=redirect&bpo=27331] 中贡献。）.)

DecodedGenerator 现在支持 policy 关键字。

新增 policy 属性，message_factory 控制当解析器新建消息对象时默认要使用的类。 对于 email.policy.compat32 策略来说将为 Message，对于新策略来说将为 EmailMessage。 （由 R. David Murray 在 bpo-20476 [https://bugs.python.org/issue?@action=redirect&bpo=20476] 中贡献。）

encodings

在 Windows 上，增加了 'oem' 编码格式用于 CP_OEMCP，以及 'ansi' 别名用于现有的 'mbcs' 编码格式，它使用 CP_ACP 代码页。 （由 Steve Dower 在 bpo-27959 [https://bugs.python.org/issue?@action=redirect&bpo=27959] 中贡献。）

enum

在 enum 模块中新增了两个枚举基类: Flag 和 IntFlags。 两者均被用于定义可使用按位运算符进行组合的常量。 （由 Ethan Furman 在 bpo-23591 [https://bugs.python.org/issue?@action=redirect&bpo=23591] 中贡献。）

许多标准库模块已被更新以使用 IntFlags 类作为其常量。

新增的 enum.auto 值可被用于自动为枚举成员赋值:

>>> 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>]

faulthandler

在 Windows 上，faulthandler 模块现在会为 Windows 异常安装处理器：参见 faulthandler.enable()。 （由 Victor Stinner 在 bpo-23848 [https://bugs.python.org/issue?@action=redirect&bpo=23848] 中贡献。）

fileinput

hook_encoded() 现在支持 errors 参数。 （由 Joseph Hackman 在 bpo-25788 [https://bugs.python.org/issue?@action=redirect&bpo=25788] 中贡献。）

hashlib

hashlib 已支持 OpenSSL 1.1.0。 最低的建议版本为 1.0.2。 （由 Christian Heimes 在 bpo-26470 [https://bugs.python.org/issue?@action=redirect&bpo=26470] 中贡献。）

本模块增加了 BLAKE2 哈希函数。 blake2b() 和 blake2s() 将始终可用并支持 BLAKE2 的完整特性集。 （由 Christian Heimes 在 bpo-26798 [https://bugs.python.org/issue?@action=redirect&bpo=26798] 中基于 Dmitry Chestnykh 和 Samuel Neves 的代码贡献。 文档由 Dmitry Chestnykh 撰写。）

增加了 SHA-3 哈希函数 sha3_224(), sha3_256(), sha3_384(), sha3_512()，以及 SHAKE 哈希函数 shake_128() 和 shake_256()。 （由 Christian Heimes 在 bpo-16113 [https://bugs.python.org/issue?@action=redirect&bpo=16113] 中贡献。 Keccak 代码包由 Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche 和 Ronny Van Keer 编写。）

基于密码的密钥推导函数 scrypt() 现可用于 OpenSSL 1.1.0 及更新版本。 （由 Christian Heimes 在 bpo-27928 [https://bugs.python.org/issue?@action=redirect&bpo=27928] 中贡献。）

http.client

HTTPConnection.request() 和 endheaders() 现在都支持分块编码格式请求体。 （由 Demian Brecht 和 Rolf Krahl 在 bpo-12319 [https://bugs.python.org/issue?@action=redirect&bpo=12319] 中贡献。）

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 [https://bugs.python.org/issue?@action=redirect&bpo=24225] 中贡献。 大多数 idlelib 补丁都是已经是或即将纳入该处理过程。）

作为补偿，最终的结果是一些 idlelib 类将更会易于使用，并有更好的 API 和文档字符串加以说明。 附加的有用信息准备好后将被添加到 idlelib 中。

在 3.6.2 中新增:

多个对自动补全的修正。 （由 Louie Lu 在 bpo-15786 [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 [https://bugs.python.org/issue?@action=redirect&bpo=1612262] 中贡献。）

之前以扩展形式实现的 IDLE 特性已作为正常特性重新实现。 它们的设置已从 Extensions 选项卡移至其他对话框选项卡。 （由 Charles Wohlganger 和 Terry Jan Reedy 在 bpo-27099 [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 [https://bugs.python.org/issue?@action=redirect&bpo=13802] 中贡献。） 样本可以被修改以包括其他字符。 （由 Serhiy Storchaka 在 bpo-31860 [https://bugs.python.org/issue?@action=redirect&bpo=31860] 中贡献。）

在 3.6.6 中新增:

编辑器代码上下文选项已经过修改。 Box 会显示所有上下文行直到最大行数。 点击一个上下文行会使编辑器跳转到该行。 自定义主题的上下文颜色已添加到 Settings 对话框的 Highlights 选项卡。 （由 Cheryl Sabella 和 Terry Jan Reedy 在 bpo-33642 [https://bugs.python.org/issue?@action=redirect&bpo=33642], bpo-33768 [https://bugs.python.org/issue?@action=redirect&bpo=33768] 和 bpo-33679 [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 [https://bugs.python.org/issue?@action=redirect&bpo=33656] 中贡献。）

在 3.6.7 中新增:

超过 N 行（默认值为 50）的输出将被折叠为一个按钮。 N 可以在 Settings 对话框的 General 页的 PyShell 部分中进行修改。 数量较少但是超长的行可以通过在输出上右击来折叠。 被折叠的输出可通过双击按钮来展开，或是通过右击按钮来放入剪贴板或是单独的窗口。 （由 Tal Einat 在 bpo-1529353 [https://bugs.python.org/issue?@action=redirect&bpo=1529353] 中贡献。）

importlib

现在导入操作在无法找到模块时将引发新的异常 ModuleNotFoundError (ImportError 的子类)。 目前 (在 try-except 中) 检测 ImportError 的代码仍将有效。 （由 Eric Snow 在 bpo-15767 [https://bugs.python.org/issue?@action=redirect&bpo=15767] 中贡献。）

importlib.util.LazyLoader 现在将调用被包装的加载器上的 create_module()，移除了 importlib.machinery.BuiltinImporter 和 importlib.machinery.ExtensionFileLoader 不能用于 importlib.util.LazyLoader 的限制。

importlib.util.cache_from_source(), importlib.util.source_from_cache() 和 importlib.util.spec_from_file_location() 现在将接受 path-like object。

inspect

inspect.signature() 函数现在会报告编译器为推导式和生成器表达式作用域生成的隐式 .0 形参，就像它们是调用``implicit0`` 时的仅限位置形参一样。 （由 Jelle Zijlstra 在 bpo-19611 [https://bugs.python.org/issue?@action=redirect&bpo=19611] 中贡献。）

为了减少从 Python 2.7 和旧式 inspect.getargspec() API 升级时的代码问题，先前被写入文档的对 inspect.getfullargspec() 的弃用已被撤销。 虽然这个函数对于单/源 Python 2/3 代码库来说很方便，但对于新代码来说功能更丰富的 inspect.signature() 接口仍然是推荐的方式。 （由 Nick Coghlan 在 bpo-27172 [https://bugs.python.org/issue?@action=redirect&bpo=27172] 中贡献。）

json

现在 json.load() 和 json.loads() 均支持二进制输入。 已编码的 JSON 应当使用 UTF-8, UTF-16 或 UTF-32 来表示。 （由 Serhiy Storchaka 在 bpo-17909 [https://bugs.python.org/issue?@action=redirect&bpo=17909] 中贡献。）

logging

新增 WatchedFileHandler.reopenIfNeeded() 方法以添加检测日志文件是否需要被重新打开的能力。 （由 Marian Horban 在 bpo-24884 [https://bugs.python.org/issue?@action=redirect&bpo=24884] 中贡献。）.)

math

为 math 和 cmath 模块增加了 tau (τ) 常量。 （由 Lisa Roach 在 bpo-12345 [https://bugs.python.org/issue?@action=redirect&bpo=12345] 中贡献，详情见 PEP 628 [https://www.python.org/dev/peps/pep-0628]。）

multiprocessing

由 multiprocessing.Manager() 返回的 代理对象 现在可以被嵌套。 （由 Davin Potts 在 bpo-6766 [https://bugs.python.org/issue?@action=redirect&bpo=6766] 中贡献。）

os

请参阅 PEP 519 的概览了解现在 os 和 os.path 模块如何支持 路径型对象 的详情。

现在 scandir() 支持 Windows 上的 bytes 路径。

新增的 close() 方法允许显式地关闭 scandir() 迭代器。 scandir() 迭代器现在支持 context manager 协议。 如果一个 scandir() 迭代器既没有被耗尽也没有被显式地关闭则会在其析构器中发出 ResourceWarning。 （由 Serhiy Storchaka 在 bpo-25994 [https://bugs.python.org/issue?@action=redirect&bpo=25994] 中贡献。）

在 Linux 上，现在 os.urandom() 会阻塞直到系统的 urandom 熵池被初始化以提升安全性。 其理由参见 PEP 524 [https://www.python.org/dev/peps/pep-0524]。

Linux getrandom() 系统调用（获取随机字节数据）现在被暴露为新的 os.getrandom() 函数。 （由 Victor Stinner 贡献，为 PEP 524 [https://www.python.org/dev/peps/pep-0524] 的一部分）

pathlib

pathlib 现在支持 路径型对象。 （由 Brett Cannon 在 bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186] 中贡献。）

请参阅 PEP 519 的概览了解详情。

pdb

Pdb 类构造器新增可选的 readrc 参数用来控制是否应当读取 .pdbrc 文件。

pickle

需要附带关键字参数调用 __new__ 的对象现在可以使用早于协议版本 4 的 pickle 协议 来 pickle。 协议版本 4 之前已支持此场景。 （由 Serhiy Storchaka 在 bpo-24164 [https://bugs.python.org/issue?@action=redirect&bpo=24164] 中贡献。）

pickletools

现在 pickletools.dis() 将为 MEMOIZE 操作码输出隐式的 memo 索引。 （由 Serhiy Storchaka 在 bpo-25382 [https://bugs.python.org/issue?@action=redirect&bpo=25382] 中贡献。）

pydoc

pydoc 模块将能遵守 MANPAGER 环境变量的设置。 （由 Matthias Klose 在 bpo-8637 [https://bugs.python.org/issue?@action=redirect&bpo=8637] 中贡献。）

help() 和 pydoc 现在将以具名元组字段被定义的顺序而非字母顺序列出它们。 （由 Raymond Hettinger 在 bpo-24879 [https://bugs.python.org/issue?@action=redirect&bpo=24879] 中贡献。）

random

新增 choices() 函数用于从给定的总体中返回指定大小的元素列表并有可选权重。 （由 Raymond Hettinger 在 bpo-18844 [https://bugs.python.org/issue?@action=redirect&bpo=18844] 中贡献。）

re

在正则表达式中增加了对修饰符区段的支持。 示例: '(?i:p)ython' 匹配 'python' 和 'Python'，但不匹配 'PYTHON'；'(?i)g(?-i:v)r' 匹配 'GvR' 和 'gvr'，但不匹配 'GVR'。 （由 Serhiy Storchaka 在 bpo-433028 [https://bugs.python.org/issue?@action=redirect&bpo=433028] 中贡献。）

Match 对象分组可通过 __getitem__ 来访问，这等价于 group()。 因此 mo['name'] 现在将等价于 mo.group('name')。 （由 Eric Smith 在 bpo-24454 [https://bugs.python.org/issue?@action=redirect&bpo=24454] 中贡献。）

Match 对象现在支持将 索引型对象 作为分组索引。 （由 Jeroen Demeyer 和 Xiang Zhang 在 bpo-27177 [https://bugs.python.org/issue?@action=redirect&bpo=27177] 中贡献。）

readline

新增 set_auto_history() 来启用或禁用历史列表输入的自动添加。 （由 Tyler Crompton 在 bpo-26870 [https://bugs.python.org/issue?@action=redirect&bpo=26870] 中贡献。）

rlcompleter

私有和特殊属性名称现在会被省略除非带有以下划线开头的前缀。 在某些已完成的关键字后会加上空格或冒号。 （由 Serhiy Storchaka 在 bpo-25011 [https://bugs.python.org/issue?@action=redirect&bpo=25011] 和 bpo-25209 [https://bugs.python.org/issue?@action=redirect&bpo=25209] 中贡献。）

shlex

shlex 通过新的 punctuation_chars 参数来控制哪些字符会被当作标点符号大幅度地 改进了 shell 兼容性。 （由 Vinay Sajip 在 bpo-1521950 [https://bugs.python.org/issue?@action=redirect&bpo=1521950] 中贡献。）

site

When specifying paths to add to sys.path in a .pth file, you may now specify file paths on top of directories (e.g. zip files). (Contributed by Wolfgang Langner in bpo-26587 [https://bugs.python.org/issue?@action=redirect&bpo=26587]).

sqlite3

sqlite3.Cursor.lastrowid 现在支持 REPLACE 语句。 （由 Alex LordThorsen 在 bpo-16864 [https://bugs.python.org/issue?@action=redirect&bpo=16864] 中贡献。）

socket

The ioctl() function now supports the SIO_LOOPBACK_FAST_PATH control code. (Contributed by Daniel Stokes in bpo-26536 [https://bugs.python.org/issue?@action=redirect&bpo=26536].)

getsockopt() 常量 SO_DOMAIN, SO_PROTOCOL, SO_PEERSEC 和 SO_PASSSEC 现在已得到支持。 （由 Christian Heimes 在 bpo-26907 [https://bugs.python.org/issue?@action=redirect&bpo=26907] 中贡献。）

setsockopt() 现在支持 setsockopt(level, optname, None, optlen: int) 的形式。 （由 Christian Heimes 在 bpo-27744 [https://bugs.python.org/issue?@action=redirect&bpo=27744] 中贡献。）

The socket module now supports the address family AF_ALG to interface with Linux Kernel crypto API. ALG_*, SOL_ALG and sendmsg_afalg() were added. (Contributed by Christian Heimes in bpo-27744 [https://bugs.python.org/issue?@action=redirect&bpo=27744] with support from Victor Stinner.)

新增 Linux 常量 TCP_USER_TIMEOUT 和 TCP_CONGESTION。 （由 Omar Sandoval 在 bpo-26273 [https://bugs.python.org/issue?@action=redirect&bpo=26273] 中贡献。）

socketserver

基于 socketserver 模块的服务器，包括在 http.server、xmlrpc.server 和 wsgiref.simple_server 中定义的服务器，现在都支持 context manager 协议。（由 Aviv Palivoda 在 bpo-26404 [https://bugs.python.org/issue?@action=redirect&bpo=26404] 中贡献。）

StreamRequestHandler 类的 wfile 属性现在实现了 io.BufferedIOBase 可写接口。 特别地，现在调用 write() 会保证完整地发送数据。 （由 Martin Panter 在 bpo-26721 [https://bugs.python.org/issue?@action=redirect&bpo=26721] 中贡献。）

ssl

ssl 已支持 OpenSSL 1.1.0。 最低的建议版本为 1.0.2。 （由 Christian Heimes 在 bpo-26470 [https://bugs.python.org/issue?@action=redirect&bpo=26470] 中贡献。）

已从默认的密码套件中删除 3DES 并添加了 ChaCha20 Poly1305 密码套件。 （由 Christian Heimes 在 bpo-27850 [https://bugs.python.org/issue?@action=redirect&bpo=27850] 和 bpo-27766 [https://bugs.python.org/issue?@action=redirect&bpo=27766] 中贡献。）

SSLContext 已具有更好的选项和密码配置。 （由 Christian Heimes 在 bpo-28043 [https://bugs.python.org/issue?@action=redirect&bpo=28043] 中贡献。）.)

SSL 会话可以通过新的 SSLSession 类从一个客户端连接复制到另一个。 TLS 会话恢复可以加快初始握手过程、减少延迟并提升性能。 （由 Christian Heimes 根据 Alex Warhawk 的草案在 bpo-19500 [https://bugs.python.org/issue?@action=redirect&bpo=19500] 中贡献。）

新的 get_ciphers() 方法可被用来获取按密码优先级排序的已启用密码列表。

所有常量和旗标都已被转换为 IntEnum 和 IntFlags。 （由 Christian Heimes 在 bpo-28025 [https://bugs.python.org/issue?@action=redirect&bpo=28025] 中贡献。）

为 SSLContext 添加了服务器和客户端专属的 TLS 协议。 （由 Christian Heimes 在 bpo-28085 [https://bugs.python.org/issue?@action=redirect&bpo=28085] 中贡献。）

statistics

新增 harmonic_mean() 函数。 （由 Steven D'Aprano 在 bpo-27181 [https://bugs.python.org/issue?@action=redirect&bpo=27181] 中贡献。）

struct

现在 struct 可通过 'e' 格式说明符支持 IEEE 754 半精度浮点数。 （由 Eli Stevens 和 Mark Dickinson 在 bpo-11734 [https://bugs.python.org/issue?@action=redirect&bpo=11734] 中贡献。）

subprocess

现在 subprocess.Popen 析构器会在子进程仍然运行时发出 ResourceWarning 警告。 请使用上下文管理器协议 (with proc: ...) 或显式地调用 wait() 方法来读取子进程的退出状态。 （由 Victor Stinner 在 bpo-26741 [https://bugs.python.org/issue?@action=redirect&bpo=26741] 中贡献。）

subprocess.Popen 构造器以及所有会向其传递参数的函数现在可接受 encoding 和 errors 参数。 指定这两者中的任何一个都将为 stdin, stdout 和 stderr 流启用文本模式。 （由 Steve Dower 在 bpo-6135 [https://bugs.python.org/issue?@action=redirect&bpo=6135] 中贡献。）

sys

新的 getfilesystemencodeerrors() 函数可返回在 Unicode 文件名和 bytes 文件名之间进行转换时使用的错误模式的名称。 （由 Steve Dower 在 bpo-27781 [https://bugs.python.org/issue?@action=redirect&bpo=27781] 中贡献。）

在 Windows 上 getwindowsversion() 函数的返回值现在将包括 platform_version 字段，该字段包含当前操作系统准确的主版本、次版本和构建版本号，而不是进行所模拟的版本信息。 （由 Steve Dower 在 bpo-27932 [https://bugs.python.org/issue?@action=redirect&bpo=27932] 中提供贡献。）

telnetlib

Telnet 现在是一个上下文管理器。 （由 Stéphane Wirtel 在 bpo-25485 [https://bugs.python.org/issue?@action=redirect&bpo=25485] 中贡献。）

time

现在 struct_time 的属性 tm_gmtoff 和 tm_zone 在所有平台上均可用。

timeit

新增的 Timer.autorange() 便捷方法会重复调用 Timer.timeit() 以使总运行时间大于等于 200 毫秒。 （由 Steven D'Aprano 在 bpo-6422 [https://bugs.python.org/issue?@action=redirect&bpo=6422] 中贡献。）

现在 timeit 在最佳时间和最差时间之间存在显著（4 倍）差异时将会发出警告。 （由 Serhiy Storchaka 在 bpo-23552 [https://bugs.python.org/issue?@action=redirect&bpo=23552] 中贡献。）

tkinter

在 tkinter.Variable 类中添加了方法 trace_add(), trace_remove() 和 trace_info()。 它们取代了使用过时 Tcl 命令的旧方法 trace_variable(), trace(), trace_vdelete() 和 trace_vinfo()，旧方法在未来版本的 Tcl 中可能会无法使用。 （由 Serhiy Storchaka 在 bpo-22115 [https://bugs.python.org/issue?@action=redirect&bpo=22115] 中贡献。）

回溯

traceback 模块和解释器的内置异常显示现在都会对回溯中重复行的长序列进行缩写，如下面的例子所示:

>>> 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

（由 Emanuel Barry在 bpo-26823 [https://bugs.python.org/issue?@action=redirect&bpo=26823] 中贡献。）

tracemalloc

tracemalloc 模块现在支持跟踪在多个不同地址空间中的内存分配情况。

新增 DomainFilter 过滤器类用于按地址空间（域）过滤块跟踪信息。

（由 Victor Stinner 在 bpo-26588 [https://bugs.python.org/issue?@action=redirect&bpo=26588] 中贡献。）

typing

由于 typing 模块处于 暂定状态，在 Python 3.6 中引入的所有改变都已被反向移植到 Python 3.5.x。

typing 模块对泛型类别名的支持得到大幅改进。 例如 Dict[str, Tuple[S, T]] 现在将是有效的类型标注。 （由 Guido van Rossum 在 Github #195 中贡献 [https://github.com/python/typing/pull/195]。）

增加 typing.ContextManager 类用来表示 contextlib.AbstractContextManager。 （由 Brett Cannon 在 bpo-25609 [https://bugs.python.org/issue?@action=redirect&bpo=25609] 中贡献。）

增加 typing.Collection 类用来表示 collections.abc.Collection。 （由 Ivan Levkivskyi 在 bpo-27598 [https://bugs.python.org/issue?@action=redirect&bpo=27598] 中贡献。）

增加 typing.ClassVar 类型结构体用来标记类变量。 变量标注在 PEP 526 [https://www.python.org/dev/peps/pep-0526] 中被引入，包装在 ClassVar 中的变量标注表示给定的属性将被用作类变量而不应在该类的实例上设置。 （由 Ivan Levkivskyi 在 Github #280 中贡献 [https://github.com/python/typing/pull/280]。)

新增 TYPE_CHECKING 常量将被静态类型检查器视为 True，但在运行时将为 False。 （由 Guido van Rossum 在 Github #230 中贡献 [https://github.com/python/typing/issues/230]。）

新增 NewType() 辅助函数用来创建针对标注的轻量级单独类型:

from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)

静态类型检查器将把新类型当作原始类型的子类来处理。 （由 Ivan Levkivskyi 在 Github #189 中贡献 [https://github.com/python/typing/issues/189]。）

unicodedata

unicodedata 模块现在使用来自 Unicode 9.0.0 [https://unicode.org/versions/Unicode9.0.0/] 的数据。 （由 Benjamin Peterson 贡献。）

unittest.mock

Mock 类具有以下改进：

两个新方法，Mock.assert_called() 和 Mock.assert_called_once() 用于检测 mock 对象是否已被调用。 （由 Amit Saha 在 bpo-26323 [https://bugs.python.org/issue?@action=redirect&bpo=26323] 中贡献。）

Mock.reset_mock() 方法现在有两个可选的仅限关键字参数: return_value 和 side_effect。 （由 Kushal Das 在 bpo-21271 [https://bugs.python.org/issue?@action=redirect&bpo=21271] 中贡献。）

urllib.request

如果一个 HTTP 请求具有文件或可迭代对象请求体（而不是 bytes 对象）但没有 Content-Length 标头，AbstractHTTPHandler 现在将不会抛出错误，而是回退为使用分块传输编码格式。 （由 Demian Brecht 和 Rolf Krahl 在 bpo-12319 [https://bugs.python.org/issue?@action=redirect&bpo=12319] 中贡献。）

urllib.robotparser

RobotFileParser 现在将支持 Crawl-delay 和 Request-rate 扩展。 （由 Nikolay Bogoychev 在 bpo-16099 [https://bugs.python.org/issue?@action=redirect&bpo=16099] 中贡献。）

venv

venv 接受一个新的形参 --prompt。 此形参提供了用于虚拟环境的替代前缀。 （由 Łukasz Balcerzak 提议并由 Stéphane Wirtel 在 bpo-22829 [https://bugs.python.org/issue?@action=redirect&bpo=22829] 中移植到 3.6。）

warnings

为 warnings.warn_explicit() 新增可选的 source 形参：被销毁的对象将发出 ResourceWarning。 还为 warnings.WarningMessage 增加了 source 属性。 （由 Victor Stinner 在 bpo-26568 [https://bugs.python.org/issue?@action=redirect&bpo=26568] 和 bpo-26567 [https://bugs.python.org/issue?@action=redirect&bpo=26567] 中贡献。）

当一个 ResourceWarning 警告被记入日志时，现在会使用 tracemalloc 模块来尝试提取分配给已销毁对象的回溯信息。

使用 example.py 脚本的示例:

import warnings

def func():
    return open(__file__)

f = func()
f = None

命令 python3.6 -Wd -X tracemalloc=5 example.py 的输出:

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()

"Object allocated at" 回溯信息是新增的并且仅当 tracemalloc 在跟踪 Python 内存分配且 warnings 模块已被导入时才会显示。

winreg

增加了 64 位整数类型 REG_QWORD。 （由 Clement Rouault 在 bpo-23026 [https://bugs.python.org/issue?@action=redirect&bpo=23026] 中贡献。）

winsound

允许将关键字参数传给 Beep, MessageBeep 和 PlaySound (bpo-27982 [https://bugs.python.org/issue?@action=redirect&bpo=27982])。

xmlrpc.client

xmlrpc.client 模块现在支持反 marshall 由 Apache XML-RPC 的数字和 None 实现所使用的附加数据类型。 （由 Serhiy Storchaka 在 bpo-26885 [https://bugs.python.org/issue?@action=redirect&bpo=26885] 中贡献。）

zipfile

新增的 ZipInfo.from_file() 类方法允许基于文件系统中的文件创建 ZipInfo 实例。 新增的 ZipInfo.is_dir() 方法可被用来检测 ZipInfo 实例是否代表一个目录。 （由 Thomas Kluyver 在 bpo-26039 [https://bugs.python.org/issue?@action=redirect&bpo=26039] 中贡献。）

现在 ZipFile.open() 方法可被用来将数据写入 ZIP 文件，以及提取数据。 （由 Thomas Kluyver 在 bpo-26039 [https://bugs.python.org/issue?@action=redirect&bpo=26039] 中贡献。）

zlib

现在 compress() 和 decompress() 函数均可接受关键字参数。 （分别由 Aviv Palivoda 在 bpo-26243 [https://bugs.python.org/issue?@action=redirect&bpo=26243] 以及 Xiang Zhang 在 bpo-16764 [https://bugs.python.org/issue?@action=redirect&bpo=16764] 中贡献。）

性能优化

Python 解释器现在使用 16 位字代码而不是字节代码，这使得许多操作码优化成为可能。 （由 Demur Rumed 在 bpo-26647 [https://bugs.python.org/issue?@action=redirect&bpo=26647] 和 bpo-28050 [https://bugs.python.org/issue?@action=redirect&bpo=28050] 中贡献并得到来自 Serhiy Storchaka 和 Victor Stinner 的协助和评估。）

现在 asyncio.Future 类已拥有经优化的 C 实现。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26081 [https://bugs.python.org/issue?@action=redirect&bpo=26081] 中贡献。）

现在 asyncio.Task 类已拥有经优化的 C 实现。 （由 Yury Selivanov 在 bpo-28544 [https://bugs.python.org/issue?@action=redirect&bpo=28544] 中贡献。）

在 typing 模块中多项对实现的改进（如泛型类型的缓存）获得至多 30 倍的运行效率提升并降低了内存消耗。

现在 ASCII 解码器使用 surrogateescape, ignore 和 replace 错误处理器时可提速至多 60 倍。 （由 Victor Stinner 在 bpo-24870 [https://bugs.python.org/issue?@action=redirect&bpo=24870] 中贡献。）

现在 ASCII 和 Latin1 解码器使用 surrogateescape 错误处理器时可提速至多 3 倍。 （由 Victor Stinner 在 bpo-25227 [https://bugs.python.org/issue?@action=redirect&bpo=25227] 中贡献。）

现在 UTF-8 解码器使用 ignore, replace, surrogateescape, surrogatepass 错误处理器时可提速至多 75 倍。 （由 Victor Stinner 在 bpo-25267 [https://bugs.python.org/issue?@action=redirect&bpo=25267] 中贡献。）

现在 UTF-8 解码器使用 ignore, replace 和 surrogateescape 错误处理器时可提速至多 15 倍。 （由 Victor Stinner 在 bpo-25301 [https://bugs.python.org/issue?@action=redirect&bpo=25301] 中贡献。）

现在 bytes % args 可提速至多 2 倍。 （由 Victor Stinner 在 bpo-25349 [https://bugs.python.org/issue?@action=redirect&bpo=25349] 中贡献。）

现在 bytearray % args 可提速 2.5 至 5 倍。 （由 Victor Stinner 在 bpo-25399 [https://bugs.python.org/issue?@action=redirect&bpo=25399] 中贡献。）

优化 bytes.fromhex() 和 bytearray.fromhex(): 现在它们获得了 2x 和 3.5x 的提速。 （由 Victor Stinner 在 bpo-25401 [https://bugs.python.org/issue?@action=redirect&bpo=25401] 中贡献。）

优化 bytes.replace(b'', b'.') 和 bytearray.replace(b'', b'.'): 提速至多 80%。 （由 Josh Snider 在 bpo-26574 [https://bugs.python.org/issue?@action=redirect&bpo=26574] 中贡献。）

Allocator functions of the PyMem_Malloc() domain (PYMEM_DOMAIN_MEM) now use the pymalloc memory allocator instead of malloc() function of the C library. The pymalloc allocator is optimized for objects smaller or equal to 512 bytes with a short lifetime, and use malloc() for larger memory blocks. (Contributed by Victor Stinner in bpo-26249 [https://bugs.python.org/issue?@action=redirect&bpo=26249]).

现在 pickle.load() 和 pickle.loads() 在反序列化许多小对象时可提速多至 10%。 （由 Victor Stinner 在 bpo-27056 [https://bugs.python.org/issue?@action=redirect&bpo=27056] 中贡献。）

向函数传入 关键字参数 相比传入 位置参数 会有额外的开销。 现在对于使用 Argument Clinic 实现的扩展函数此开销已显著降低。 （由 Serhiy Storchaka 在 bpo-27574 [https://bugs.python.org/issue?@action=redirect&bpo=27574] 中贡献。）

优化了 glob 模块中的 glob() 和 iglob() 函数；现在它们可提速约 3--6 倍。 （由 Serhiy Storchaka 在 bpo-25596 [https://bugs.python.org/issue?@action=redirect&bpo=25596] 中贡献。）

通过使用 os.scandir() 优化了 pathlib 中的 glob 操作；现在它可提速约 1.5--4 倍。 （由 Serhiy Storchaka 在 bpo-26032 [https://bugs.python.org/issue?@action=redirect&bpo=26032] 中贡献。）

xml.etree.ElementTree 解析、迭代和深拷贝效率已获得显著提升。 （由 Serhiy Storchaka 在 bpo-25638 [https://bugs.python.org/issue?@action=redirect&bpo=25638], bpo-25873 [https://bugs.python.org/issue?@action=redirect&bpo=25873] 和 bpo-25869 [https://bugs.python.org/issue?@action=redirect&bpo=25869] 中贡献。）

基于 float 和 decimal 创建 fractions.Fraction 实例现已提速 2 至 3 倍。 （由 Serhiy Storchaka 在 bpo-25971 [https://bugs.python.org/issue?@action=redirect&bpo=25971] 中贡献。）

构建和 C API 的改变

Python 现在需要在工具链中提供一些 C99 支持来进行构建 。 最值得注意的是，Python 现在使用标准的整数类型和宏来代替像 PY_LONG_LONG 这样的自定义宏。 要获取更多信息，参见 PEP 7 [https://www.python.org/dev/peps/pep-0007] 和 bpo-17884 [https://bugs.python.org/issue?@action=redirect&bpo=17884]。

使用 Android NDK 和将 Android API 设为 21（Android 5.0 Lollipop）或更高级别的交叉编译 CPython 可成功运行。 虽然 Android 还不是一个受支持的平台，但 Python 测试套件在 Android 模拟器上运行时只有约 16 次测试失败。 请参见 Android meta-issue bpo-26865 [https://bugs.python.org/issue?@action=redirect&bpo=26865]。

已添加 --enable-optimizations 配置旗标 。 打开它将激活 PGO 等高消耗的优化功能。 （原始补丁由 Intel 的 Alecsandru Patrascu 在 bpo-26359 [https://bugs.python.org/issue?@action=redirect&bpo=26359] 中贡献。）

The GIL must now be held when allocator functions of PYMEM_DOMAIN_OBJ (ex: PyObject_Malloc()) and PYMEM_DOMAIN_MEM (ex: PyMem_Malloc()) domains are called.

新增 Py_FinalizeEx() API 用于提示缓冲数据的刷新是否失败。 （由 Martin Panter 在 bpo-5319 [https://bugs.python.org/issue?@action=redirect&bpo=5319] 中贡献。）

PyArg_ParseTupleAndKeywords() 现在支持 仅限位置形参，仅限位置形参是不带名称定义的。 （由 Serhiy Storchaka 在 bpo-26282 [https://bugs.python.org/issue?@action=redirect&bpo=26282] 中贡献。）

现在 PyTraceback_Print 方法会将由重复行组成的长序列缩写为 "[Previous line repeated {count} more times]"。 （由 Emanuel Barry 在 bpo-26823 [https://bugs.python.org/issue?@action=redirect&bpo=26823] 中贡献。）

新增的 PyErr_SetImportErrorSubclass() 函数允许指定一个要引发的 ImportError 子类。 （由 Eric Snow 在 bpo-15767 [https://bugs.python.org/issue?@action=redirect&bpo=15767] 中贡献。）

新增的 PyErr_ResourceWarning() 函数可被用于生成提供资源分配来源的 ResourceWarning。（由 Victor Stinner 在 bpo-26567 [https://bugs.python.org/issue?@action=redirect&bpo=26567] 中贡献。）

新增的 PyOS_FSPath() 函数可返回一个 path-like object 的文件系统表示形式。 （由 Brett Cannon 在 bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186] 中贡献。）

现在 PyUnicode_FSConverter() 和 PyUnicode_FSDecoder() 函数将接受 路径类对象。

其他改进

当 --version (简短形式: -V) 提供了两次时，Python 将针对细节信息打印 sys.version。

$ ./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)]

弃用

新关键字

不建议将 async 和 await 作为变量、类、函数或模块的名称。 它们通过 PEP 492 [https://www.python.org/dev/peps/pep-0492] 在 Python 3.5 中被引入，并将在 Python 3.7 成为保留关键字。 从 Python 3.6 开始，使用 async 或 await 作为名称将会产生 DeprecationWarning。

已弃用的 Python 行为

在生成器内部引发 StopIteration 异常现在将产生 DeprecationWarning，并将在 Python 3.7 中触发 RuntimeError。 详情参见 PEP 479：更改生成器内部的 StopIteration 处理。

现在 __aiter__() 方法应当直接返回一个异步迭代器而非如之前那样返回一个可等待对象。 继续返回可等待对象将触发 DeprecationWarning。 向下兼容将在 Python 3.7 中被移除。 （由 Yury Selivanov 在 bpo-27243 [https://bugs.python.org/issue?@action=redirect&bpo=27243] 中贡献。）

现在如果一个反斜杠-字符对不是有效的转义序列则会产生 DeprecationWarning。 虽然这最终会改为 SyntaxError，但在近几个 Python 发布版都不会实施。 （由 Emanuel Barry 在 bpo-27364 [https://bugs.python.org/issue?@action=redirect&bpo=27364] 中贡献。）

当执行相对导入时，现在当 __spec__ 或 __package__ 未被定义时从调用方模块回退到 __name__ 和 __path__ 会引发 ImportWarning。 （由 Rose Ames 在 bpo-25791 [https://bugs.python.org/issue?@action=redirect&bpo=25791] 中贡献。）

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

asynchat

The asynchat has been deprecated in favor of asyncio. (Contributed by Mariatta in bpo-25002 [https://bugs.python.org/issue?@action=redirect&bpo=25002].)

asyncore

The asyncore has been deprecated in favor of asyncio. (Contributed by Mariatta in bpo-25002 [https://bugs.python.org/issue?@action=redirect&bpo=25002].)

dbm

与其他 dbm 实现不同，dbm.dumb 模块会以 'rw' 模式创建数据库并允许修改以 'r' 模式打开的数据库。 此行为现在已被弃用并将在 3.8 中移除。 （由 Serhiy Storchaka 在 bpo-21708 [https://bugs.python.org/issue?@action=redirect&bpo=21708] 中贡献。）

distutils

The undocumented extra_path argument to the Distribution constructor is now considered deprecated and will raise a warning if set. Support for this parameter will be removed in a future Python release. See bpo-27919 [https://bugs.python.org/issue?@action=redirect&bpo=27919] for details.

grp

在 getgrgid() 中对非整数参数的支持已被弃用。 （由 Serhiy Storchaka 在 bpo-26129 [https://bugs.python.org/issue?@action=redirect&bpo=26129] 中贡献。）

importlib

现在 importlib.machinery.SourceFileLoader.load_module() 和 importlib.machinery.SourcelessFileLoader.load_module() 方法已被弃用。 它们是 importlib 中仅存的尚未在之前的 Python 版本中被弃用并改为 importlib.abc.Loader.exec_module() 的 importlib.abc.Loader.load_module() 实现。

The importlib.machinery.WindowsRegistryFinder class is now deprecated. As of 3.6.0, it is still added to sys.meta_path by default (on Windows), but this may change in future releases.

os

未写入文档的对于将普通 字节型对象 作为 os 的函数, compile() 及类似函数中的路径的支持现已被弃用。 （由 Serhiy Storchaka 在 bpo-25791 [https://bugs.python.org/issue?@action=redirect&bpo=25791] 和 bpo-26754 [https://bugs.python.org/issue?@action=redirect&bpo=26754] 中贡献。）

re

对于在正则表达式中间使用内联旗标 (?letters) 的支持已被弃用并将在未来的 Python 版本中移除。 在正则表达式开头的旗标仍然被允许。 （由 Serhiy Storchaka 在 bpo-22493 [https://bugs.python.org/issue?@action=redirect&bpo=22493] 中贡献。）

ssl

OpenSSL 0.9.8, 1.0.0 和 1.0.1 已被弃用并不再受支持。 未来的 ssl 模块将至少需要 OpenSSL 1.0.2 或 1.1.0。

ftplib, http.client, imaplib, poplib 和 smtplib 中的 SSL 相关参数如 certfile, keyfile 和 check_hostname 已被弃用而应改用 context。 （由 Christian Heimes 在 bpo-28022 [https://bugs.python.org/issue?@action=redirect&bpo=28022] 中贡献。）

ssl 模块中的多个协议和函数现已被弃用。 某些特性在未来的 OpenSSL 版本中将不再可用。 另一些特性则因建议使用不同的 API 而被弃用。 （由 Christian Heimes 在 bpo-28022 [https://bugs.python.org/issue?@action=redirect&bpo=28022] 和 bpo-26470 [https://bugs.python.org/issue?@action=redirect&bpo=26470] 中贡献。）

tkinter

tkinter.tix 模块现已被弃用。 tkinter 用户应当改用 tkinter.ttk。

venv

pyvenv 脚本已被弃用而应改用 python3 -m venv。 这可以避免 pyvenv 容易混淆所连接的 Python 解释器从而导致弄错虚拟环境所使用的 Python 解释器这样的问题。 （由 Brett Cannon 在 bpo-25154 [https://bugs.python.org/issue?@action=redirect&bpo=25154] 中贡献。）

已弃用的 C API 函数和类型

Undocumented functions PyUnicode_AsEncodedObject(), PyUnicode_AsDecodedObject(), PyUnicode_AsEncodedUnicode() and PyUnicode_AsDecodedUnicode() are deprecated now. Use the generic codec based API instead.

弃用的构建选项

现在 --with-system-ffi 配置旗标在非 macOS UNIX 平台上将默认启用。 它可以通过 --without-system-ffi 来禁用，但该旗标已被弃用并将在 Python 3.7 中不再被接受。 macOS 不会受此变化的影响。 请注意许多 OS 发布方在构建它们的系统 Python 时已经使用了 --with-system-ffi 旗标。

移除

API 与特性的移除

正则表达式中由 '\' 和一个 ASCII 字母组成的未知转义序列现在将导致报错。 它们在 re.sub() 的替换模板中仍被允许，但已被弃用。 现在 re.LOCALE 旗标只能用于二进制模式。

inspect.getmoduleinfo() 已被移除（自 CPython 3.3 起已被弃用）。 应当使用 inspect.getmodulename() 来获取对应于给定路径的模块名称。 （由 Yury Selivanov 在 bpo-13248 [https://bugs.python.org/issue?@action=redirect&bpo=13248] 中贡献。）

traceback.Ignore 类和 traceback.usage, traceback.modname, traceback.fullmodname, traceback.find_lines_from_code, traceback.find_lines, traceback.find_strings, traceback.find_executable_lines 等方法已从 traceback 模块中移除。 它们是自 Python 3.2 起即已被弃用的未写入文档的方法并可通过私有方法使用等价的功能。

tkinter 控件类中的 tk_menuBar() 和 tk_bindForTraversal() 虚拟方法已被移除（相应的 Tk 命令自 Tk 4.0 起即已过时）。

zipfile.ZipFile 类的 open() 方法已不再支持 'U' 模式（自 Python 3.4 起已被弃用）。 请使用 io.TextIOWrapper 以 universal newlines 模式读取压缩文本文件。

未写入文档的 IN, CDROM, DLFCN, TYPES, CDIO 和 STROPTS 模块已被移除。 它们在平台专属的 Lib/plat-*/ 目录下可用，但是早已过时，在各平台上访问方式不一致，并且无人维护。 创建这些模块的脚本仍可在源代码发布包的 Tools/scripts/h2py.py [https://github.com/python/cpython/blob/v3.6.15/Tools/scripts/h2py.py] 中获取。

已弃用的 asynchat.fifo 类现已被移除。

移植到Python 3.6

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

 'python' 命令行为的变化

带有 COUNT_ALLOCS, SHOW_ALLOC_COUNT 或 SHOW_TRACK_COUNT 宏定义的特殊 Python 编译版的输出现在默认被关闭。 可以使用 -X showalloccount 选项重新启用它。 现在它将输出到 stderr 而不是 stdout。 （由 Serhiy Storchaka 在 bpo-23034 [https://bugs.python.org/issue?@action=redirect&bpo=23034] 中贡献。）

Python API 的变化

open() 将不再允许组合使用 'U' 模式旗标与 '+'。 （由 Jeff Balogh 和 John O'Connor 在 bpo-2091 [https://bugs.python.org/issue?@action=redirect&bpo=2091] 中贡献。）

sqlite3 将不再隐式地在 DDL 语句之前提交未完成的事务。

在 Linux 上，现在 os.urandom() 会阻塞直到系统的 urandom 熵池被初始化以提升安全性。

当 importlib.abc.Loader.exec_module() 被定义时，importlib.abc.Loader.create_module() 也必须被定义。

现在 PyErr_SetImportError() 当其 msg 参数未被设置时将设置 TypeError。 在之前版本中仅返回 NULL。

The format of the co_lnotab attribute of code objects changed to support a negative line number delta. By default, Python does not emit bytecode with a negative line number delta. Functions using frame.f_lineno, PyFrame_GetLineNumber() or PyCode_Addr2Line() are not affected. Functions directly decoding co_lnotab should be updated to use a signed 8-bit integer type for the line number delta, but this is only required to support applications using a negative line number delta. See Objects/lnotab_notes.txt for the co_lnotab format and how to decode it, and see the PEP 511 [https://www.python.org/dev/peps/pep-0511] for the rationale.

现在 compileall 模块中的函数将返回布尔值而不是 1 或 0 来分别表示成功或失败。 由于布尔值是整数的子类，这应当只有在你对 1 或 0 执行标识号检测时才会出现问题。 参见 bpo-25768 [https://bugs.python.org/issue?@action=redirect&bpo=25768]。

现在读取 urllib.parse.urlsplit() 和 urlparse() 结果的 port 属性对于超出范围的值将引发 ValueError，而不是返回 None。 参见 bpo-20059 [https://bugs.python.org/issue?@action=redirect&bpo=20059]。

The imp module now raises a DeprecationWarning instead of PendingDeprecationWarning.

The following modules have had missing APIs added to their __all__ attributes to match the documented APIs: calendar, cgi, csv, ElementTree, enum, fileinput, ftplib, logging, mailbox, mimetypes, optparse, plistlib, smtpd, subprocess, tarfile, threading and wave. This means they will export new symbols when import * is used. (Contributed by Joel Taddei and Jacek Kołodziej in bpo-23883 [https://bugs.python.org/issue?@action=redirect&bpo=23883].)

当执行相对导入时，如果 __package__ 与 __spec__.parent 的比较结果不相等则会引发 ImportWarning。 （由 Brett Cannon 在 bpo-25791 [https://bugs.python.org/issue?@action=redirect&bpo=25791] 中贡献。）

当执行相对导入而上级包未知时，则会引发 ImportError。 在之前版本中，可能会引发 SystemError。 （由 Brett Cannon 在 bpo-18018 [https://bugs.python.org/issue?@action=redirect&bpo=18018] 中贡献。）

基于 socketserver 模块的服务器，包括在 http.server, xmlrpc.server 和 wsgiref.simple_server 定义的服务器，现在将只捕获派生自 Exception 的异常。 因此如果一个请求处理器引发了 SystemExit 或 KeyboardInterrupt 之类的异常，handle_error() 不再会被调用，异常将会停止单线程的服务器。 （由 Martin Panter 在 bpo-23430 [https://bugs.python.org/issue?@action=redirect&bpo=23430] 中贡献。）

如果用户没有权限， spwd.getspnam() 现在会抛出 PermissionError 而非之前的 KeyError 。

现在 socket.socket.close() 方法当下层系统调用报告错误 (例如 EBADF) 时将会引发一个异常。 （由 Martin Panter 在 bpo-26685 [https://bugs.python.org/issue?@action=redirect&bpo=26685] 中贡献。）

The decode_data argument for the smtpd.SMTPChannel and smtpd.SMTPServer constructors is now False by default. This means that the argument passed to process_message() is now a bytes object by default, and process_message() will be passed keyword arguments. Code that has already been updated in accordance with the deprecation warning generated by 3.5 will not be affected.

现在 json 模块中 dump(), dumps(), load() 和 loads() 函数以及 JSONEncoder 和 JSONDecoder 类构造器的所有可选参数都是 仅限关键字参数。 （由 Serhiy Storchaka 在 bpo-18726 [https://bugs.python.org/issue?@action=redirect&bpo=18726] 中贡献。）

type 的子类如果未重载 type.__new__，将不再能使用一个参数的形式来获取对象的类型。

作为 PEP 487 [https://www.python.org/dev/peps/pep-0487] 的一部分，对传递给 type 的关键字参数的处理（元类提示 metaclass 除外）现在统一委托给 object.__init_subclass__()。 这意味着 type.__new__() 和 type.__init__() 现在都接受任意的关键字参数，但 object.__init_subclass__() （从 type.__new__() 调用）默认将拒绝它们。 接受额外关键字参数的自定义元类需要相应调整对 type.__new__() 的调用（无论是直接调用还是通过 super 间接调用）。

In distutils.command.sdist.sdist, the default_format attribute has been removed and is no longer honored. Instead, the gzipped tarfile format is the default on all platforms and no platform-specific selection is made. In environments where distributions are built on Windows and zip distributions are required, configure the project with a setup.cfg file containing the following:

[sdist]
formats=zip

此行为已通过 Setuptools 26.0.0 反向移植到更早的 Python 版本中。

在 urllib.request 模块和 http.client.HTTPConnection.request() 方法中，如果没有指定 Content-Length 标头字段并且请求体是一个文件对象，现在它将使用 HTTP 1.1 分块编码格式发送。 如果必须要将一个文件对象发送给 HTTP 1.0 服务器，那么现在必须由调用方指定 Content-Length 值。 （由 Demian Brecht 和 Rolf Krahl 在 bpo-12319 [https://bugs.python.org/issue?@action=redirect&bpo=12319] 中贡献并由 Martin Panter 进行修改。）

现在 DictReader 将返回类型为 OrderedDict 的行。 （由 Steve Holden 在 bpo-27842 [https://bugs.python.org/issue?@action=redirect&bpo=27842] 中贡献。）

crypt.METHOD_CRYPT 如果不受平台支持将不再被添加到 crypt.methods。 （由 Victor Stinner 在 bpo-25287 [https://bugs.python.org/issue?@action=redirect&bpo=25287] 中贡献。）

namedtuple() 的 verbose 和 rename 参数现在是仅限关键字参数。 （由 Raymond Hettinger 在 bpo-25628 [https://bugs.python.org/issue?@action=redirect&bpo=25628] 中贡献。）

在 Linux 上，ctypes.util.find_library() 现在会到 LD_LIBRARY_PATH 中查找共享库。 （由 Vinay Sajip 在 bpo-9998 [https://bugs.python.org/issue?@action=redirect&bpo=9998] 中贡献。）

imaplib.IMAP4 类现在可以处理服务器发送的消息中包含 ']' 字符的旗标，以改善在现实世界中的兼容性。 （由 Lita Cho 在 bpo-21815 [https://bugs.python.org/issue?@action=redirect&bpo=21815] 中贡献。）

现在 mmap.write() 函数将像其他写入方法一样返回写入的字节数。 （由 Jakub Stasiak 在 bpo-26335 [https://bugs.python.org/issue?@action=redirect&bpo=26335] 中贡献。）

现在 pkgutil.iter_modules() 和 pkgutil.walk_packages() 函数将返回 ModuleInfo 具名元组。 （由 Ramchandra Apte 在 bpo-17211 [https://bugs.python.org/issue?@action=redirect&bpo=17211] 中贡献。）

现在 re.sub() 即使未在字符串中找到模式也会针对替换模板中无效的数字分组引用引发错误。 针对无效分组引用的错误消息现在将包括分组索引和引用位置。 （由 SilentGhost, Serhiy Storchaka 在 bpo-25953 [https://bugs.python.org/issue?@action=redirect&bpo=25953] 中贡献。）

现在 zipfile.ZipFile 对于无法识别的压缩值将引发 NotImplementedError。 在之前版本中是引发简单的 RuntimeError。 此外，在已关闭的 ZipFile 上调用 ZipFile 或者在使用 'r' 模式创建的 ZipFile 上调用 write() 将引发 ValueError。 在之前版本中，对于这些场景是引发 RuntimeError。

当自定义元类与零参数的 super() 或从方法到隐式的 __class__ 闭包变量的直接引用相结合时，隐式的 __classcell__ 命名空间条目现在必须传到 type.__new__ 进行初始化。 如果不这样做那么在 Python 3.6 中将会导致 DeprecationWarning 而在 Python 3.8 中将会导致 RuntimeError。

随着 ModuleNotFoundError 的引入，导入系统的消费方可能会开始期望导入系统的替代品在能适当的时候引发更具体的异常，而非不够具体的 ImportError。 为了在未来向此类消费方提供兼容性，完全取代 __import__() 的替代导入系统的实现者需要更新其实现以便在完全未找到模块时引发新的子类。 兼容默认导入系统的插件的实现者不需要做任何更改，因为默认导入系统会在适当的时候引发新的子类。

C API 的变化

现在 PyMem_Malloc() 分配器族将使用 pymalloc 分配器 而不是系统 malloc()。 调用 PyMem_Malloc() 时未持有 GIL 的应用程序现在可能发生崩溃。 请将 PYTHONMALLOC 环境变量设为 debug 以便在你的应用程序中验证内存分配器的使用。 参见 bpo-26249 [https://bugs.python.org/issue?@action=redirect&bpo=26249]。

现在如果缓冲数据刷新失败 Py_Exit() (以及主解释器) 会将退出状态重写为 120。 参见 bpo-5319 [https://bugs.python.org/issue?@action=redirect&bpo=5319]。

CPython 字节码的改变

在 Python 3.6 中对 bytecode 进行了一些重大修改。

Python 解释器现在使用 16 位字代码而不是字节代码。 （由 Demur Rumed 在 bpo-26647 [https://bugs.python.org/issue?@action=redirect&bpo=26647] 和 bpo-28050 [https://bugs.python.org/issue?@action=redirect&bpo=28050] 中贡献并得到来自 Serhiy Storchaka 和 Victor Stinner 的协助和评估。）

新增 FORMAT_VALUE 和 BUILD_STRING 操作码作为 格式化字符串字面值 实现的组成部分。 （由 Eric Smith 在 bpo-25483 [https://bugs.python.org/issue?@action=redirect&bpo=25483] 以及 Serhiy Storchaka 在 bpo-27078 [https://bugs.python.org/issue?@action=redirect&bpo=27078] 中贡献。）

新增的 BUILD_CONST_KEY_MAP 操作码用于优化具有常量键的字典的创建。 （由 Serhiy Storchaka 在 bpo-27140 [https://bugs.python.org/issue?@action=redirect&bpo=27140] 中创建。）

函数调用操作码进行了大幅改进以提升效率并简化实现。 MAKE_FUNCTION, CALL_FUNCTION, CALL_FUNCTION_KW 和 BUILD_MAP_UNPACK_WITH_CALL 操作码已被修改，新增了 CALL_FUNCTION_EX 和 BUILD_TUPLE_UNPACK_WITH_CALL，并移除了 CALL_FUNCTION_VAR, CALL_FUNCTION_VAR_KW 和 MAKE_CLOSURE 操作码。 （由 Demur Rumed 在 bpo-27095 [https://bugs.python.org/issue?@action=redirect&bpo=27095] 中，以及 Serhiy Storchaka 在 bpo-27213 [https://bugs.python.org/issue?@action=redirect&bpo=27213], bpo-28257 [https://bugs.python.org/issue?@action=redirect&bpo=28257] 中贡献。）

新增了 SETUP_ANNOTATIONS 和 STORE_ANNOTATION 操作码以支持新的 variable annotation 语法。 （由 Ivan Levkivskyi 在 bpo-27985 [https://bugs.python.org/issue?@action=redirect&bpo=27985] 中贡献。）

Python 3.6.2 中的重要变化

新增 make regen-all 构建目标

为了简化交叉编译，并确保 CPython 能够可靠地编译而不需要已存在可用的 Python 版本，基于 autotools 的构建系统将不再尝试根据文件修改时间隐式地重新编译已生成的文件。

取而代之的是，新增了一个 make regen-all 命令以便在需要时强制重新生成这些文件（例如在基于预生成版本构建了 Python 的初始版本之后）。

还定义了其他一些更具选择性的重生成目标 —— 详情参见 Makefile.pre.in [https://github.com/python/cpython/tree/3.10/Makefile.pre.in]。

（由 Victor Stinner 在 bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404] 中贡献。）

3.6.2 新版功能.

移除了 make touch 构建目标

之前用于通过更新生成文件的修改时间来请求隐式的重新生成这些文件的 make touch 构建目标已被移除。

它已被新的 make regen-all 目标所替代。

（由 Victor Stinner 在 bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404] 中贡献。）

在 3.6.2 版更改.

Python 3.6.4 中的重要变化

曾经作为 API 一部分的 PyExc_RecursionErrorInst 单例已被移除，因为它的成员永远不会被清理，可能在解释器的最终化过程中导致段错误。 （由 Xavier de Gaye 在 bpo-22898 [https://bugs.python.org/issue?@action=redirect&bpo=22898] 和 bpo-30697 [https://bugs.python.org/issue?@action=redirect&bpo=30697] 中贡献。）

Python 3.6.5 中的重要变化

在某些情况下 locale.localeconv() 函数现在会临时将 LC_CTYPE 语言区域设为 LC_NUMERIC 语言区域。 （由 Victor Stinner 在 bpo-31900 [https://bugs.python.org/issue?@action=redirect&bpo=31900] 中贡献。）

Python 3.6.7 中的重要变化

在 3.6.7 中当提供不带末尾换行符的输入时 tokenize 模块现在会隐式地发出 NEWLINE 形符。 此行为现在已与 C 分词器的内部行为相匹配。 （由 Ammar Askar 在 bpo-33899 [https://bugs.python.org/issue?@action=redirect&bpo=33899] 中贡献。）

Python 3.6.10 中的重要变化

出于重要的安全性考量，asyncio.loop.create_datagram_endpoint() 的 reuse_address 形参不再被支持。 这是由 UDP 中的套接字选项 SO_REUSEADDR 的行为导致的。 更多细节请参阅 loop.create_datagram_endpoint() 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228 [https://bugs.python.org/issue?@action=redirect&bpo=37228] 中贡献。。）

Python 3.6.13 中的重要变化

早先的 Python 版本允许使用 ; 和 & 作为 urllib.parse.parse_qs() 和 urllib.parse.parse_qsl() 中 query 形参的分隔键。 出于安全考虑，也为了遵循更新的 W3C 推荐设置，这已被改为只允许单个分隔键，默认为 &。 这一改变还会影响 cgi.parse() 和 cgi.parse_multipart() 因为它们在内部使用了受影响的函数。 要了解更多细节，请查看它们各自的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967] 中贡献。）

Python 3.5 有什么新变化

编者

Elvis Pranskevichus <elvis@magic.io>, Yury Selivanov <yury@magic.io>

这篇文章介绍了 Python 3.5 相比 3.4 增加的新特性。 Python 3.5 发布于 2015 年 9 月 13 日。 更完整的变化清单请参阅 changelog [https://docs.python.org/3.5/whatsnew/changelog.html]。

参见

PEP 478 [https://www.python.org/dev/peps/pep-0478] - Python 3.5 发布计划

摘要 -- 发布重点

新的语法特性：

PEP 492, 使用 async 和 await 语法实现协程。

PEP 465, 新的矩阵乘法运算符: a @ b.

PEP 448, 额外的解包通用化。

新的库模块：

typing: PEP 484 —— 类型注解.

zipapp: PEP 441 改进Python ZIP应用程序支持.

新的内置特性：

bytes % args, bytearray % args: PEP 461 -- 为字节串和字节数组增加 % 格式化。

新增 bytes.hex(), bytearray.hex() 和 memoryview.hex() 方法。 （由 Arnon Yaari 在 bpo-9951 [https://bugs.python.org/issue?@action=redirect&bpo=9951] 中贡献。）

memoryview 现在支持元组索引（包括多维度）。 （由 Antoine Pitrou 在 bpo-23632 [https://bugs.python.org/issue?@action=redirect&bpo=23632] 中贡献。）

生成器具有一个新的 gi_yieldfrom 属性，它将返回 yield from 表达式所迭代的对象。 （由 Benno Leslie 和 Yury Selivanov 在 bpo-24450 [https://bugs.python.org/issue?@action=redirect&bpo=24450] 中贡献。）

现在当达到最大递归尝试时将引发新的 RecursionError 异常。 （由 Georg Brandl 在 bpo-19235 [https://bugs.python.org/issue?@action=redirect&bpo=19235] 中贡献。）

CPython 实现的改进：

当 LC_TYPE 语言区域为 POSIX 语言区域（即 C 语言区域）时，sys.stdin 和 sys.stdout 现在将使用 surrogateescape 错误处理器，而不是 strict 错误处理器。 （由 Victor Stinner 在 bpo-19977 [https://bugs.python.org/issue?@action=redirect&bpo=19977] 中贡献。）

.pyo 文件已不再被使用而是被替换为一个更灵活的方案即在 .pyc 名称中显式地包括优化级别。 （参见 PEP 488 概览。）

内置与扩展模块现在将经过多阶段的过程被初始化，这类似于 Python 模块的加载方式。 （参见 PEP 489 概览。）

标准库中的重大改进：

collections.OrderedDict 现在已 用 C 实现，这使它的速度快了 4 到 100 部。

The ssl 模块获得了 对内存 BIO 的支持，它使得 SSL 协议处理与网络 IO 实现了解耦。

新的 os.scandir() 函数提供了对于目录遍历 更好和明显更快速的方式。

functools.lru_cache() 已经大部分 用 C 重新实现，产生了更好的性能。

新的 subprocess.run() 函数提供了一个 运行子进程的简便方式。

traceback 模块已被显著 增强 以改善性能和开发者便捷度。

安全改进：

SSLv3 目前在整个标准库中被禁用。 它仍然可以通过手动实例化一个 ssl.SSLContext 来启用。 （请参阅 bpo-22638 [https://bugs.python.org/issue?@action=redirect&bpo=22638] 了解详情；此修改已向下移植到 CPython 3.4 和 2.7。）

HTTP cookie 解析现在将更严格，以防止潜在的注入攻击。 （由 Antoine Pitrou 在 bpo-22796 [https://bugs.python.org/issue?@action=redirect&bpo=22796] 中贡献。）

Windows改进：

使用新的 Windows 安装器替代了旧版 MSI。 请参阅 在Windows上使用 Python 了解详情。

Windows 编译版现在使用 Microsoft Visual C++ 14.0，扩展模块也应当使用同一版本。

请继续阅读有关针对用户的改变的完整清单，包括许多其他较小的改进、CPython 优化、弃用以及潜在的移植问题。

新的特性

PEP 492 - 使用 async 和 await 语法实现协程

PEP 492 [https://www.python.org/dev/peps/pep-0492] 通过添加 可等待对象, 协程函数, 异步迭代 和 异步上下文管理器 极大地改善了 Python 对异步编程的支持。

协程函数是使用新的 async def 语法来声明的:

>>> async def coro():
...     return 'spam'

在协程函数内部，新的 await 表达式可用于挂起协程的执行直到其结果可用。 任何对象都可以被 等待，只要它通过定义 __await__() 方法实现了 awaitable 协议。

PEP 492 还增加了 async for 语句用于方便地迭代异步可迭代对象。

一个使用新语法编写的基本 HTTP 客户端示例:

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'', b''
    ]))

    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()

与异步迭代类似，增加了用于异步上下文管理器的新语法。 以下代码:

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()

将输出：

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

请注意 async for 和 async with 都只能在通过 async def 声明的协程函数中使用。

协程函数应当在兼容的事件循环内部运行，例如 asyncio 循环。

注解

在 3.5.2 版更改: 从 CPython 3.5.2 开始，__aiter__ 可以直接返回 异步迭代器。 返回 awaitable 对象将会导致 PendingDeprecationWarning。

详情参见文档的 异步迭代器 一节。

参见

PEP 492 [https://www.python.org/dev/peps/pep-0492] -- 使用 async 和 await 语法实现协程

PEP 由 Yury Selivanov 撰写并实现

PEP 465 - 用于矩阵乘法的专用中缀运算符

PEP 465 [https://www.python.org/dev/peps/pep-0465] 增加了用于矩阵乘法的 @ 中缀运算符。 目前，还没有内置的 Python 类型实现这个新运算符，不过，它可通过定义 __matmul__(), __rmatmul__() 和 __imatmul__() 分别用于常规、反射和原地矩阵乘法来实现。 这些方法的语义与定义其他中缀算术运算符的方法类似。

矩阵乘法在数学，科学，工程学的许多领域中是一种常见的操作，使用 @ 运算符可以编写更简洁的代码：

S = (H @ beta - r).T @ inv(H @ V @ H.T) @ (H @ beta - r)

代替：

S = dot((dot(H, beta) - r).T,
        dot(inv(dot(dot(H, V), H.T)), dot(H, beta) - r))

NumPy 1.10 支持新的运算符：

>>> 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.])

参见

PEP 465 [https://www.python.org/dev/peps/pep-0465] -- 用于矩阵乘法的专用中缀运算符

PEP 由 Nathaniel J. Smith 撰写，由 Benjamin Peterson 实现。

PEP 448 - 进一步的解包标准化

PEP 448 [https://www.python.org/dev/peps/pep-0448] 扩展了 * 可迭代对象解包操作符和 ** 字典解包操作符的允许使用范围。 现在将可以在 函数调用 中使用任意数量的解包操作:

>>> 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

类似地，元组、列表、集合与字典表示形式也允许多重解包 (参见 表达式列表 和 字典显示):

>>> *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}

参见

PEP 448 [https://www.python.org/dev/peps/pep-0448] -- 进一步的解包标准化

PEP 由 Joshua Landau 撰写 ，由 Neil Girdhar，Thomas Wouters 和 Joshua Landau 实现。

PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持

PEP 461 [https://www.python.org/dev/peps/pep-0461] 增加了 % 插值运算符 对 bytes 和 bytearray 的支持。

虽然插值通常被认为是一种字符串操作，但在某些情况下针对 bytes 或 bytearrays 的插值操作也是有意义，而弥补这种功能缺失所需的工作可能会影响代码的整体可读性。 在处理通常会混合二进制和 ASCII 兼容文本的 wire 格式化协议时，这个问题尤为重要。

示例:

>>> b'Hello %b!' % b'World'
b'Hello World!'

>>> b'x=%i y=%f' % (1, 2.5)
b'x=1 y=2.500000'

Unicode 对于 %b 来说是不允许的，但对 %a 来说则是可接受的 (等价于 repr(obj).encode('ascii', 'backslashreplace')):

>>> 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'"

请注意 %s 和 %r 转换类型虽然受到支持，但应当只被用于需要与 Python 2 保持兼容性的代码中。

参见

PEP 461 [https://www.python.org/dev/peps/pep-0461] -- 为 bytes 和 bytearray 添加 % 格式化

PEP 由 Ethan Furman 撰写 ，由 Neil Schemenauer 和 Ethan Furman 实现。

PEP 484 —— 类型提示

函数标注语法自 3.0 版起即已成为 Python 的特性 (PEP 3107 [https://www.python.org/dev/peps/pep-3107])，标注的语义尚未得到定义。

经验表明大多数函数标注的使用都是为了向函数形参和返回值提供类型提示。 很显然如果标准库可以包括用于类型标注的基本定义和工具，对 Python 用户来说将大有裨益。

PEP 484 [https://www.python.org/dev/peps/pep-0484] 引入了一个 暂定模块 来提供这些标准定义和工具，以及针对标注不可用的场合的一些惯例。

例如，以下是一个在标注中声明了参数和返回值类型的简单函数:

def greeting(name: str) -> str:
    return 'Hello ' + name

While these annotations are available at runtime through the usual __annotations__ attribute, no automatic type checking happens at runtime. Instead, it is assumed that a separate off-line type checker (e.g. mypy [http://mypy-lang.org]) will be used for on-demand source code analysis.

类型系统支持合并、泛型类型以及名为 Any 的能够适用于所有类型（即作为赋值的来源和目标）的特殊类型。

参见

typing 模块文档

PEP 484 [https://www.python.org/dev/peps/pep-0484] —— 类型提示

PEP 由 Guido van Rossum，Jukka Lehtosalo 和 Łukasz Langa 撰写；由 Guido van Rossum 实现。

PEP 483 [https://www.python.org/dev/peps/pep-0483] -- 类型提示理论

PEP 由 Yury Selivanov 撰写

PEP 471 - os.scandir() 函数 -- 一个更好且更快的目录迭代器

PEP 471 [https://www.python.org/dev/peps/pep-0471] 向标准库添加了一个新的目录迭代函数 os.scandir()。 此外，os.walk() 现在是使用 scandir 来实现，这使它在 POSIX 系统上可提速 3 至 5 倍而在 Windows 系统上可提速 7 至 20 倍。 这样的效果主要是通过大幅减少遍历目录树所需调用 os.stat() 的次数来达成的。

此外，scandir 是返回一个迭代器，而不是返回一个文件名列表，这提升了迭代非常大的目录时的内存效率。

下面的例子演示了 os.scandir() 的简单用法，显示给定 path 中所有不以 '.' 开头的文件（不包括目录）。 entry.is_file() 调用通常不会执行额外的系统调用:

for entry in os.scandir(path):
    if not entry.name.startswith('.') and entry.is_file():
        print(entry.name)

参见

PEP 471 [https://www.python.org/dev/peps/pep-0471] -- os.scandir() 函数 -- 一个更好且更快的目录迭代器

PEP 由 Ben Hoyt 在 Victor Stinner 的帮助下撰写并实现

PEP 475: 重试返回 EINTR 失败码的系统调用

An errno.EINTR error code is returned whenever a system call, that is waiting for I/O, is interrupted by a signal. Previously, Python would raise InterruptedError in such cases. This meant that, when writing a Python application, the developer had two choices:

忽略 InterruptedError。

处理 InterruptedError 并在每个调用位置尝试重新启动被中断的系统调用。

第一个选项会使应用程序中途出错。 第二个选项添加了大量的额外处理使得代码几乎不可读。 比较:

print("Hello World")

和:

while True:
    try:
        print("Hello World")
        break
    except InterruptedError:
        continue

PEP 475 [https://www.python.org/dev/peps/pep-0475] 实现了在 EINTR 时自动重试系统调用。 这移除了大部分场合下在用户代码中处理 EINTR 或 InterruptedError 的负担，并使得 Python 程序，包括标准库的程序更为健壮。 请注意只有在信号处理器未引发异常时系统调用才会被重试。

以下是现在当被信号中断时会被重试的函数的列表：

open() 和 io.open();

faulthandler 模块的功能

os 函数: fchdir(), fchmod(), fchown(), fdatasync(), fstat(), fstatvfs(), fsync(), ftruncate(), mkfifo(), mknod(), open(), posix_fadvise(), posix_fallocate(), pread(), pwrite(), read(), readv(), sendfile(), wait3(), wait4(), wait(), waitid(), waitpid(), write(), writev();

特例: os.close() 和 os.dup2() 现在会忽略 EINTR 错误; 不重试系统调用（请参阅PEP了解基本原理）

select 函数: devpoll.poll(), epoll.poll(), kqueue.control(), poll.poll(), select();

socket 类的方法: accept(), connect() （除了非阻塞套接字）, recv(), recvfrom(), recvmsg(), send(), sendall(), sendmsg(), sendto();

signal.sigtimedwait() 和 signal.sigwaitinfo();

time.sleep().

参见

PEP 475 [https://www.python.org/dev/peps/pep-0475] -- 重试返回 EINTR 失败码的系统调用

PEP 和具体实现由 Charles-François Natali 和 Victor Stinner 撰写，并获得 Antoine Pitrou 的协助（同为法国人）。

PEP 479：更改生成器内部的 StopIteration 处理

生成器与 StopIteration 的交互在 Python 3.4 及更早版本中有时会令人惊讶，并可能隐藏难以觉察的程序错误。 在之前版本中，一个生成器函数内部意外引发的 StopIteration 会被驱动该生成器的循环构造解读为迭代的结束。

PEP 479 [https://www.python.org/dev/peps/pep-0479] 更改了生成器的行为：当一个 StopIteration 异常在生成器内部被引发时，它会在其退出生成器所在帧时被替换为 RuntimeError。 这一更改的主要目的是方便在无防护的 next() 调用引发了 StopIteration 并导致生成器所控制的迭代静默地终结的情况下进行调试。 此情况在与 yield from 构造相结合时会特别令人困扰。

这是一个向下不兼容的更改，所以想要启用这个新行为，必须执行 __future__ 导入:

>>> from __future__ import generator_stop

>>> def gen():
...     next(iter([]))
...     yield
...
>>> next(gen())
Traceback (most recent call last):
  File "<stdin>", line 2, in gen
StopIteration

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: generator raised StopIteration

如果未执行 __future__ 导入，当在生成器内部引发 StopIteration 异常时将导致 PendingDeprecationWarning 被引发。

参见

PEP 479 [https://www.python.org/dev/peps/pep-0479] -- 更改生成器内部的 StopIteration 处理

PEP 由 Chris Angelico 和 Guido van Rossum 撰写，由 Chris Angelico，Yury Selivanov 和 Nick Coghlan 实现。

PEP 485：用于测试近似相等的函数

PEP 485 [https://www.python.org/dev/peps/pep-0485] 增加了 math.isclose() 和 cmath.isclose() 函数用于检测两个值是否近似相等或称“接近”。 两个值是否接近是根据给定的绝对和相对范围来确定的。 相对范围是 isclose 参数之间的最大允许差值，即相对于较大的那个绝对数值的距离:

>>> 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

也可以使用绝对范围来比较两个值，它必须是一个非负数值:

>>> 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

参见

PEP 485 [https://www.python.org/dev/peps/pep-0485] —— 用于测试近似相等的函数

PEP 由 Christopher Barker 撰写，由 Chris Barker 和 Tal Einat 实现。

PEP 486：让 Python 启动器识别虚拟环境

PEP 486 [https://www.python.org/dev/peps/pep-0486] 让 Windows 版启动器 (参见 PEP 397 [https://www.python.org/dev/peps/pep-0397]) 能够识别激活的虚拟环境。 当要使用默认解释器并且设置了 VIRTUAL_ENV 环境变量时，将使用虚拟环境中的解释器。

参见

PEP 486 [https://www.python.org/dev/peps/pep-0486] -- 让 Python 启动器识别虚拟环境

PEP 由 Paul Moore 撰写并实现

PEP 488：去除 PYO 文件

PEP 488 [https://www.python.org/dev/peps/pep-0488] 取消了 .pyo 文件的概念。 这意味着 .pyc 文件将同时代表未优化和已优化的字节码。 为了防止经常需要重新生成字节码文件，现在 .pyc 文件可以在其名称中设置可选的 opt- 标签来表示已优化字节码。 该设置的附带效果是当以 -O 和 -OO 运行时将不会有字节码文件名冲突。 其结果是，使用 -O 和 -OO 生成的字节码现在可以同时存在。 importlib.util.cache_from_source() 专门针对此项变化更新了 API。

参见

PEP 488 [https://www.python.org/dev/peps/pep-0488] -- 去除 PYO 文件

PEP 由 Brett Cannon 撰写并实现。

PEP 489：多阶段扩展模块初始化

PEP 489 [https://www.python.org/dev/peps/pep-0489] 更新了扩展模块初始化操作以便利用 Python 3.4 中通过 PEP 451 [https://www.python.org/dev/peps/pep-0451] 引入的两步模块加载机制的优势。

这一变化让选择使用新机制的扩展模块的导入语义与 Python 源代码和字节码模块的更为接近，包括可以使用任何有效标识符作为模块名称，而不是仅限于 ASCII。

参见

PEP 489 [https://www.python.org/dev/peps/pep-0489] -- 多阶段扩展模块初始化

PEP 由 Petr Viktorin , Stefan Behnel 和 Nick Coghlan 撰写，由 Petr Viktorin 实现。

其他语言特性修改

对Python 语言核心进行的小改动：

增加了 "namereplace" 错误处理器。 "backslashreplace" 错误处理器现在可用于解码和转译。 （由 Serhiy Storchaka 在 bpo-19676 [https://bugs.python.org/issue?@action=redirect&bpo=19676] 和 bpo-22286 [https://bugs.python.org/issue?@action=redirect&bpo=22286] 中贡献。）

现在 -b 选项会影响 bytes 与 int 的比较。 （由 Serhiy Storchaka 在 bpo-23681 [https://bugs.python.org/issue?@action=redirect&bpo=23681] 中贡献。）

新增 Kazakh kz1048 和 Tajik koi8_t 编解码器。 （由 Serhiy Storchaka 在 bpo-22682 [https://bugs.python.org/issue?@action=redirect&bpo=22682] 和 bpo-22681 [https://bugs.python.org/issue?@action=redirect&bpo=22681] 中贡献。）

特征属性文档字符串现在将是可写的。 这对于 collections.namedtuple() 文档字符串特别适用。 （由 Berker Peksag 在 bpo-24064 [https://bugs.python.org/issue?@action=redirect&bpo=24064] 中贡献。）

涉及相对导入的环形导入现在已受到支持。 （由 Brett Cannon 和 Antoine Pitrou 在 bpo-17636 [https://bugs.python.org/issue?@action=redirect&bpo=17636] 中贡献。）

新增模块

typing

新增的 typing 暂定 模块提供了对函数类型标注的标准定义和工具。 详情参见 类型提示。

zipapp

新增的 zipapp 模块（在 PEP 441 [https://www.python.org/dev/peps/pep-0441] 中描述）提供了用于创建可执行 Python Zip 应用程序的 API 和命令行工具，它是根据 bpo-1739468 [https://bugs.python.org/issue?@action=redirect&bpo=1739468] 在 Python 2.6 中引入的，但在当时和之后都没有足够的推广。

使用这个新模块，想要打包你的应用程序只需简单地将所有文件，包括一个 __main__.py 文件放到一个目录 myapp 中并运行：

$ python -m zipapp myapp
$ python myapp.pyz

该模块的实现由 Paul Moore 在 bpo-23491 [https://bugs.python.org/issue?@action=redirect&bpo=23491] 中贡献。

参见

PEP 441 [https://www.python.org/dev/peps/pep-0441] -- 改进 Python ZIP 应用程序支持

改进的模块

argparse

现在 ArgumentParser 类允许通过将 allow_abbrev 设为 False 来禁用长选项的 缩写用法。 （由 Jonathan Paugh, Steven Bethard, paul j3 和 Daniel Eriksson 在 bpo-14910 [https://bugs.python.org/issue?@action=redirect&bpo=14910] 中贡献。）

asyncio

由于 asyncio 模块处于 暂定状态，在 Python 3.5 中引入的所有改变都已被向下移植到 Python 3.4.x。

自 Python 3.4.0 开始 asyncio 模块中的重要变化：

新增的调试 API: loop.set_debug() 和 loop.get_debug() 方法。 （由 Victor Stinner 贡献。）

现在 proactor 事件循环已支持 SSL。 （由 Antoine Pitrou 和 Victor Stinner 在 bpo-22560 [https://bugs.python.org/issue?@action=redirect&bpo=22560] 中贡献。）

新增的 loop.is_closed() 方法可检测事件循环是否已关闭。 （由 Victor Stinner 在 bpo-21326 [https://bugs.python.org/issue?@action=redirect&bpo=21326] 中贡献。）.)

新增的 loop.create_task() 用来方便地新建一个 Task 并将其排入协程的计划任务。 create_task 方法还可供所有将协程包装为任务的 asyncio 函数使用，例如 asyncio.wait(), asyncio.gather() 等。 （由 Victor Stinner 贡献。）

新增的 transport.get_write_buffer_limits() 方法用于查询流程控制的 高 与 低 水位限制。 （由 Victor Stinner 贡献。）

async() 函数已被弃用并由 ensure_future() 取代。 （由 Yury Selivanov 贡献。）

新增 loop.set_task_factory() 和 loop.get_task_factory() 方法用于自定义供 loop.create_task() 方法使用的任务工厂。 （由 Yury Selivanov 贡献。）

新增 Queue.join() 和 Queue.task_done() 队列方法。 （由 Victor Stinner 贡献。）

移除了 JoinableQueue 类，建议改用 asyncio.Queue 类。 （由 Victor Stinner 贡献。）

3.5.1 中的更新：

ensure_future() 函数以及所有用到它的函数，比如 loop.run_until_complete()，现在将接受所有种类的 可等待对象。 （由 Yury Selivanov 贡献。）

新增 run_coroutine_threadsafe() 函数用于从其他线程向事件循环提交协程。（由 Vincent Michel 贡献。）

新增 Transport.is_closing() 方法用于检查传输是否正在关闭或已经关闭。 （由 Yury Selivanov 贡献。）

loop.create_server() 方法现在可以接受一个主机列表。 （由 Yann Sionneau 贡献。）

3.5.2 中的更新：

新增 loop.create_future() 方法用来创建 Future 对象。 这允许替代性的事件循环实现，比如 uvloop [https://github.com/MagicStack/uvloop]，以提供更快速的 asyncio.Future 实现。 （由 Yury Selivanov 贡献。）

新增 loop.get_exception_handler() 方法用于获取当前异常处理器。 （由 Yury Selivanov 贡献。）

新增 StreamReader.readuntil() 方法用于从流读取数据直到出现作为分隔符的字节序列。 （由 Mark Korenberg 贡献。）

loop.create_connection() 和 loop.create_server() 方法已获得优化以避免当地址已被解析时调用系统的 getaddrinfo 函数。 （由 A. Jesse Jiryu Davis 贡献。）

loop.sock_connect(sock, address) 不再要求在其被调用之前已解析 address。 （由 A. Jesse Jiryu Davis 贡献。）

bz2

现在 BZ2Decompressor.decompress 方法接受可选的 max_length 参数用来限制解压缩数据的大小上限。 （由 Nikolaus Rath 在 bpo-15955 [https://bugs.python.org/issue?@action=redirect&bpo=15955] 中贡献。）

cgi

现在 FieldStorage 类已支持 context manager 协议。 （由 Berker Peksag 在 bpo-20289 [https://bugs.python.org/issue?@action=redirect&bpo=20289] 中贡献。）

cmath

新增函数 isclose() 提供了一种测试近似相等的方式。 （由 Chris Barker 和 Tal Einat 在 bpo-24270 [https://bugs.python.org/issue?@action=redirect&bpo=24270] 中贡献。）

code

现在 InteractiveInterpreter.showtraceback() 方法将打印完整的回溯链，就像在交互模式解释器中一样。 （由 Claudiu Popa 在 bpo-17442 [https://bugs.python.org/issue?@action=redirect&bpo=17442] 中贡献。）

collections

现在 OrderedDict 类使用 C 来实现，令其可提速 4 至 100 倍。 （由 Eric Snow 在 bpo-16991 [https://bugs.python.org/issue?@action=redirect&bpo=16991] 中贡献。）

OrderedDict.items(), OrderedDict.keys(), OrderedDict.values() 等视图现在支持 reversed() 迭代。 （由 Serhiy Storchaka 在 bpo-19505 [https://bugs.python.org/issue?@action=redirect&bpo=19505] 中贡献。）

deque 类现在定义了 index(), insert() 和 copy()，并且支持 + 和 * 运算符。 这允许 deque 被识别为 MutableSequence 并提升其替代列表的能力。 （由 Raymond Hettinger 在 bpo-23704 [https://bugs.python.org/issue?@action=redirect&bpo=23704] 中贡献。）

由 namedtuple() 产生的文档字符串现在可以被更新:

Point = namedtuple('Point', ['x', 'y'])
Point.__doc__ += ': Cartesian coodinate'
Point.x.__doc__ = 'abscissa'
Point.y.__doc__ = 'ordinate'

（由 Berker Peksag 在 bpo-24064 [https://bugs.python.org/issue?@action=redirect&bpo=24064] 中贡献。）

现在 UserString 类已实现 __getnewargs__(), __rmod__(), casefold(), format_map(), isprintable() 和 maketrans() 类以与对应的 str 方法相匹配。 （由 Joe Jevnik 在 bpo-22189 [https://bugs.python.org/issue?@action=redirect&bpo=22189] 中贡献。）

collections.abc

现在 Sequence.index() 方法接受 start 和 stop 参数以与对应的 tuple, list 等的方法相匹配。 （由 Devin Jeanpierre 在 bpo-23086 [https://bugs.python.org/issue?@action=redirect&bpo=23086] 中贡献。）

新增 Generator 抽象基类。 （由 Stefan Behnel 在 bpo-24018 [https://bugs.python.org/issue?@action=redirect&bpo=24018] 中贡献。）

新增 Awaitable, Coroutine, AsyncIterator 和 AsyncIterable 抽象基类。 （由 Yury Selivanov 在 bpo-24184 [https://bugs.python.org/issue?@action=redirect&bpo=24184] 中贡献。）

对于更早的 Python，这些新 ABC 的向下移植版可通过一个外部的 PyPI 包 [https://pypi.org/project/backports_abc] 来获取。

compileall

新增 compileall 选项 -j N，允许同时运行 N 个工作进程来执行并行的字节码编译。 compile_dir() 函数增加了相应的 workers 形参。 （由 Claudiu Popa 在 bpo-16104 [https://bugs.python.org/issue?@action=redirect&bpo=16104] 中贡献。）

另一个新选项 -r，允许控制最大的子目录递归层级。 （由 Claudiu Popa 在 bpo-19628 [https://bugs.python.org/issue?@action=redirect&bpo=19628] 中贡献。）

现在可以多次指定 -q 命令行选项，在此情况下，所有输出包括错误都将被抑制。 在 compile_dir(), compile_file() 和 compile_path() 中相应的 quiet 形参现在可接受一个整数值来指明输出抑制的级别。 （由 Thomas Kluyver 在 bpo-21338 [https://bugs.python.org/issue?@action=redirect&bpo=21338] 中贡献。）

concurrent.futures

现在 Executor.map() 方法接受一个 chunksize 参数以允许在使用 ProcessPoolExecutor() 设置任务批次来提升运行效率。 （由 Dan O'Reilly 在 bpo-11271 [https://bugs.python.org/issue?@action=redirect&bpo=11271] 中贡献。）

现在 ThreadPoolExecutor 构造器中的工作线程数量是可选的。 默认值为 CPU 数量的 5 倍。 （由 Claudiu Popa 在 bpo-21527 [https://bugs.python.org/issue?@action=redirect&bpo=21527] 中贡献。）

configparser

现在 configparser 提供了一种方式通过在 ConfigParser 构造器中指定一个由转换器组成的字典，或将它们定义为 ConfigParser 子类中的方法来定制值的转换。 在解析器实例中定义的转换器将被它的节代理所继承。

示例:

>>> 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']

（由 Łukasz Langa 在 bpo-18159 [https://bugs.python.org/issue?@action=redirect&bpo=18159] 中贡献。）

contextlib

新增的 redirect_stderr() context manager (类似于 redirect_stdout()) 使得工具脚本更容易处理那些将输出写入到 sys.stderr 并且不提供任何重定向选项的不灵活 API。

>>> import contextlib, io, logging
>>> f = io.StringIO()
>>> with contextlib.redirect_stderr(f):
...     logging.warning('warning')
...
>>> f.getvalue()
'WARNING:root:warning\n'

（由 Berker Peksag 在 bpo-22389 [https://bugs.python.org/issue?@action=redirect&bpo=22389] 中贡献。）

csv

现在 writerow() 方法可支持任意可迭代对象，而不仅是序列。 （由 Serhiy Storchaka 在 bpo-23171 [https://bugs.python.org/issue?@action=redirect&bpo=23171] 中贡献。）

curses

The new update_lines_cols() function updates the LINES and COLS environment variables. This is useful for detecting manual screen resizing. (Contributed by Arnon Yaari in bpo-4254 [https://bugs.python.org/issue?@action=redirect&bpo=4254].)

dbm

当设置旗标值为 "n" 时 dumb.open 将总是创建新的数据库。 （由 Claudiu Popa 在 bpo-18039 [https://bugs.python.org/issue?@action=redirect&bpo=18039] 中贡献。）

difflib

由 HtmlDiff.make_file() 生成的 HTML 文档的字符集现在可通过使用新增的 charset 仅限关键字参数来自定义。 HTML 文档的默认字符集已从 "ISO-8859-1" 改为 "utf-8"。 （由 Berker Peksag 在 bpo-2052 [https://bugs.python.org/issue?@action=redirect&bpo=2052] 中贡献。）

现在 diff_bytes() 函数可能比较字节串的列表。 这修复了一个来自 Python 2 遗留总是。 （由 Terry J. Reedy 和 Greg Ward 在 bpo-17445 [https://bugs.python.org/issue?@action=redirect&bpo=17445] 中贡献。）

distutils

现在 build 和 build_ext 命令都接受一个 -j 选项以启用扩展模块的并行编译。 （由 Antoine Pitrou 在 bpo-5309 [https://bugs.python.org/issue?@action=redirect&bpo=5309] 中贡献。）

The distutils module now supports xz compression, and can be enabled by passing xztar as an argument to bdist --format. (Contributed by Serhiy Storchaka in bpo-16314 [https://bugs.python.org/issue?@action=redirect&bpo=16314].)

doctest

如果 module 不包含任何文档字符串则 DocTestSuite() 函数将返回一个空的 unittest.TestSuite，而不是引发 ValueError。 （由 Glenn Jones 在 bpo-15916 [https://bugs.python.org/issue?@action=redirect&bpo=15916] 中贡献。）

email

新增的策略选项 Policy.mangle_from_ 可控制生成器是否要为电子邮件消息体中以controls whether or not lines that start with "From " 打头的行添加 ">" 字符前缀。 默认 compat32 为 True 而所有其他策略均为 False。 （由 Milan Oberkirch 在 bpo-20098 [https://bugs.python.org/issue?@action=redirect&bpo=20098] 中贡献。）

新增的 Message.get_content_disposition() 方法可提供对 Content-Disposition 标头规范值的便捷访问。 （由 Abhilash Raj 在 bpo-21083 [https://bugs.python.org/issue?@action=redirect&bpo=21083] 中贡献。）

新增的策略选项 EmailPolicy.utf8 可被设为 True 以使用 UTF-8 字符集而不是使用已编码的字来编码电子邮件标头。 这将允许根据 RFC 6532 [https://datatracker.ietf.org/doc/html/rfc6532.html] 来格式化 Messages 并配合支持 RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html] SMTPUTF8 扩展的 SMTP 服务器使用。 （由 R. David Murray 在 bpo-24211 [https://bugs.python.org/issue?@action=redirect&bpo=24211] 中贡献。）

现在 mime.text.MIMEText 构造器可接受一个 charset.Charset 实例。 （由 Claude Paroz 和 Berker Peksag 在 bpo-16324 [https://bugs.python.org/issue?@action=redirect&bpo=16324] 中贡献。）

enum

Enum 可调用对象新增了一个形参 start 用于在只提供了 names 的情况下指定枚举值的初始数量:

>>> Animal = enum.Enum('Animal', 'cat dog', start=10)
>>> Animal.cat
<Animal.cat: 10>
>>> Animal.dog
<Animal.dog: 11>

（由 Ethan Furman 在 bpo-21706 [https://bugs.python.org/issue?@action=redirect&bpo=21706] 中贡献。）

faulthandler

现在 enable(), register(), dump_traceback() 和 dump_traceback_later() 函数除了接受文件型对象以外也接受文件描述符。 （由 Wei Wu 在 bpo-23566 [https://bugs.python.org/issue?@action=redirect&bpo=23566] 中贡献。）

functools

现在大部分 lru_cache() 机制已使用 C 实现，使其速度显著提升。 （由 Matt Joiner, Alexey Kachayev 和 Serhiy Storchaka 在 bpo-14373 [https://bugs.python.org/issue?@action=redirect&bpo=14373] 中贡献。）

glob

现在 iglob() 和 glob() 函数支持通过使用 "**" 模式在子目录中递归搜索。 （由 Serhiy Storchaka 在 bpo-13968 [https://bugs.python.org/issue?@action=redirect&bpo=13968] 中贡献。）

gzip

现在 GzipFile 构造器的 mode 参数可接受 "x" 来请求独占式的创建。 （由 Tim Heaney 在 bpo-19222 [https://bugs.python.org/issue?@action=redirect&bpo=19222] 中贡献。）

heapq

现在 merge() 中的元素比较可通过在新增的可选关键字参数 key 中传入一个 key function 来进行定制，并且新增了可选关键字参数 reverse 用于反向的元素比较:

>>> 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']

（由 Raymond Hettinger 在 bpo-13742 [https://bugs.python.org/issue?@action=redirect&bpo=13742] 中贡献。）

http

新增的 HTTPStatus 枚举定义了一组 HTTP 状态码、英文短说明和长描述。 （由 Demian Brecht 在 bpo-21793 [https://bugs.python.org/issue?@action=redirect&bpo=21793] 中贡献。）

http.client

现在 HTTPConnection.getresponse() 在远程服务器连接被意外关闭时会引发 RemoteDisconnected 异常。 此外，如果引发了 ConnectionError (RemoteDisconnected 是其子类)，客户端套接字现在会自动关闭，并将在下次请求时重新连接:

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

（由 Martin Panter 在 bpo-3566 [https://bugs.python.org/issue?@action=redirect&bpo=3566] 中贡献。）

idlelib 与 IDLE

由于 idlelib 实现了 IDLE 命令行界面和编辑器且不应被其他程序导入，它将随每个发布版获得不断改进。 请参阅 Lib/idlelib/NEWS.txt 查看 3.4.0 以来的累积改变列表，以及未来 3.5.x 发布版将进行的改变。 此文件也可通过 IDLE Help ‣ About IDLE 对话框查看。

imaplib

现在 IMAP4 类已支持 context manager 协议。 当用于 with 语句时，IMAP4 LOGOUT 命令将在代码块的末尾被自动调用。 （由 Tarek Ziadé 和 Serhiy Storchaka 在 bpo-4972 [https://bugs.python.org/issue?@action=redirect&bpo=4972] 中贡献。）

现在 imaplib 模块已通过 IMAP4.enable() 方法支持 RFC 5161 [https://datatracker.ietf.org/doc/html/rfc5161.html] (ENABLE 扩展) 和 RFC 6855 [https://datatracker.ietf.org/doc/html/rfc6855.html] (UTF-8 支持)。 新增的 IMAP4.utf8_enabled 属性可跟踪 RFC 6855 [https://datatracker.ietf.org/doc/html/rfc6855.html] 支持是否被启用。 （由 Milan Oberkirch, R. David Murray 和 Maciej Szulik 在 bpo-21800 [https://bugs.python.org/issue?@action=redirect&bpo=21800] 中贡献。）

现在 imaplib 模块会自动使用 UTF-8 自动编码非 ASCII 字符串的用户名和密码，如 RFC 所建议的那样。 （由 Milan Oberkirch 在 bpo-21800 [https://bugs.python.org/issue?@action=redirect&bpo=21800] 中贡献。）

imghdr

现在 what() 函数可识别 OpenEXR [https://www.openexr.com] 格式（由 Martin Vignali 和 Claudiu Popa 在 bpo-20295 [https://bugs.python.org/issue?@action=redirect&bpo=20295] 中贡献），以及 WebP [https://en.wikipedia.org/wiki/WebP] 格式（由 Fabrice Aneche 和 Claudiu Popa 在 bpo-20197 [https://bugs.python.org/issue?@action=redirect&bpo=20197] 中贡献。）

importlib

util.LazyLoader 类允许在对启动时间敏感的应用程序中使用模块的惰性加载。 （由 Brett Cannon 在 bpo-17621 [https://bugs.python.org/issue?@action=redirect&bpo=17621] 中贡献。）

现在 abc.InspectLoader.source_to_code() 方法属于静态方法。 这样将可更方便地通过运行 exec(code, module.__dict__) 基于字符串编译的代码来初始化模块。 （由 Brett Cannon 在 bpo-21156 [https://bugs.python.org/issue?@action=redirect&bpo=21156] 中贡献。）

新增的 util.module_from_spec() 函数现在是创建新模块的首先方式。 相比直接创建 types.ModuleType 实例，这个新函数将基于传入的规格说明对象设置各种导入控制的属性。 （由 Brett Cannon 在 bpo-20383 [https://bugs.python.org/issue?@action=redirect&bpo=20383] 中贡献。）

inspect

现在 Signature 和 Parameter 类都是可封存和可哈希的对象。 （由 Yury Selivanov 在 bpo-20726 [https://bugs.python.org/issue?@action=redirect&bpo=20726] 和 bpo-20334 [https://bugs.python.org/issue?@action=redirect&bpo=20334] 中贡献。）

新增的 BoundArguments.apply_defaults() 方法提供了一种为缺失的参数设置默认值的方式:

>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])

（由 Yury Selivanov 在 bpo-24190 [https://bugs.python.org/issue?@action=redirect&bpo=24190] 中贡献。）

新增的类方法 Signature.from_callable() 使得 Signature 的子类化更为容易。 （由 Yury Selivanov 和 Eric Snow 在 bpo-17373 [https://bugs.python.org/issue?@action=redirect&bpo=17373] 中贡献。）

现在 signature() 函数接受 follow_wrapped 可选关键字参数，当其设为 False 时，将禁用 __wrapped__ 链接的自动跟随。 （由 Yury Selivanov 在 bpo-20691 [https://bugs.python.org/issue?@action=redirect&bpo=20691] 中贡献。）

新增了一组用于检查 协程函数 和 协程对象 的函数: iscoroutine(), iscoroutinefunction(), isawaitable(), getcoroutinelocals() 和 getcoroutinestate()。 （由 Yury Selivanov 在 bpo-24017 [https://bugs.python.org/issue?@action=redirect&bpo=24017] 和 bpo-24400 [https://bugs.python.org/issue?@action=redirect&bpo=24400] 中贡献。）

现在 stack(), trace(), getouterframes() 和 getinnerframes() 函数将返回具名元组的列表。 （由 Daniel Shahaf 在 bpo-16808 [https://bugs.python.org/issue?@action=redirect&bpo=16808] 中贡献。）

io

新增 BufferedIOBase.readinto1() 方法，该方法会使用至少一次对下层原始流的调用 RawIOBase.read() 或 RawIOBase.readinto() 方法。 （由 Nikolaus Rath 在 bpo-20578 [https://bugs.python.org/issue?@action=redirect&bpo=20578] 中贡献。）

ipaddress

现在 IPv4Network 和 IPv6Network 类均接受一个 (address, netmask) 元组参数，可以根据现有地址方便地构造网络对象:

>>> 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')

（由 Peter Moody 和 Antoine Pitrou 在 bpo-16531 [https://bugs.python.org/issue?@action=redirect&bpo=16531] 中贡献。）

新增 IPv4Network 和 IPv6Network 类的 reverse_pointer 属性用于返回 DNS PTR 反向记录的名称:

>>> 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'

（由 Leon Weber 在 bpo-20480 [https://bugs.python.org/issue?@action=redirect&bpo=20480] 中贡献。）

json

现在 json.tool 命令行接口会保留输入中传入的 JSON 对象中键的顺序。 新的 --sort-keys 选项可用于按字母顺序对键进行排序。 （由 Berker Peksag 在 bpo-21650 [https://bugs.python.org/issue?@action=redirect&bpo=21650] 中贡献。）

现在 JSON 解码器会引发 JSONDecodeError 而不是 ValueError 以提供有关错误的更好的上下文信息。 （由 Serhiy Storchaka 在 bpo-19361 [https://bugs.python.org/issue?@action=redirect&bpo=19361] 中贡献。）

linecache

新增的 lazycache() 函数可用于捕获非基于文件的模块 的信息以允许在此后通过 getline() 获取其行数据。 这样就可以避免在实际需要某一行之前执行 I/O 操作，从而不需要无限期地持有模块 globals。 （由 Robert Collins 在 bpo-17911 [https://bugs.python.org/issue?@action=redirect&bpo=17911] 中贡献。）

locale

新增的 delocalize() 函数可用于将字符串转换为表示规范化数字的字符串 ，并会考虑 LC_NUMERIC 的设置:

>>> 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'

（由 Cédric Krier 在 bpo-13918 [https://bugs.python.org/issue?@action=redirect&bpo=13918] 中贡献。）

logging

所有日志记录方法（如 Logger log(), exception(), critical(), debug() 等）的 exc_info 参数现在除接受布尔值和异常元组以外，也接受异常实例:

>>> import logging
>>> try:
...     1/0
... except ZeroDivisionError as ex:
...     logging.error('exception', exc_info=ex)
ERROR:root:exception

（由 Yury Selivanov 在 bpo-20537 [https://bugs.python.org/issue?@action=redirect&bpo=20537] 中贡献。）

现在 handlers.HTTPHandler 类接受一个可选的 ssl.SSLContext 实例来配置在 HTTP 连接中使用的 SSL 设置。 （由 Alex Gaynor 在 bpo-22788 [https://bugs.python.org/issue?@action=redirect&bpo=22788] 中贡献。）

现在 handlers.QueueListener 类接受一个 respect_handler_level 关键字参数，如果将该参数设为 True，会向处理器传递消息以将处理器级别纳入考量。 （由 Vinay Sajip 贡献。）

lzma

现在 LZMADecompressor.decompress() 方法接受一个可选的 max_length 参数用来限制解压缩数据的大小上限。 （由 Martin Panter 在 bpo-15955 [https://bugs.python.org/issue?@action=redirect&bpo=15955] 中贡献。）

math

向 math 模块增加了两个新常量: inf 和 nan。 （由 Mark Dickinson 在 bpo-23185 [https://bugs.python.org/issue?@action=redirect&bpo=23185] 中贡献。）

新增函数 isclose() 提供了一种测试近似相等的方式。 （由 Chris Barker 和 Tal Einat 在 bpo-24270 [https://bugs.python.org/issue?@action=redirect&bpo=24270] 中贡献。）

新增 gcd() 函数。 现在 fractions.gcd() 函数已被弃用。 （由 Mark Dickinson 和 Serhiy Storchaka 在 bpo-22486 [https://bugs.python.org/issue?@action=redirect&bpo=22486] 中贡献。）

multiprocessing

现在 sharedctypes.synchronized() 对象支持 context manager 协议。 （由 Charles-François Natali 在 bpo-21565 [https://bugs.python.org/issue?@action=redirect&bpo=21565] 中贡献。）

operator

现在 attrgetter(), itemgetter() 和 methodcaller() 对象支持封存操作。 （由 Josh Rosenberg 和 Serhiy Storchaka 在 bpo-22955 [https://bugs.python.org/issue?@action=redirect&bpo=22955] 中贡献。）

新增 matmul() 和 imatmul() 函数用于执行矩阵乘法。 （由 Benjamin Peterson 在 bpo-21176 [https://bugs.python.org/issue?@action=redirect&bpo=21176] 中贡献。）

os

新增 scandir() 函数可返回一个 DirEntry 对象的迭代器。 如有可能，scandir() 会在扫描目录时提取文件属性，不必再执行后续的系统调用来确定文件类型或属性，这可以显著提升运行效率。 （由 Ben Hoyt 在 bpo-22524 [https://bugs.python.org/issue?@action=redirect&bpo=22524] 并得到 Victor Stinner 的协助。）

在 Windows 上，现在可使用新的 stat_result.st_file_attributes 属性。 它对应于 GetFileInformationByHandle() 所返回的 BY_HANDLE_FILE_INFORMATION 结构体的 dwFileAttributes 成员。 （由 Ben Hoyt 在 bpo-21719 [https://bugs.python.org/issue?@action=redirect&bpo=21719] 中贡献。）

现在 urandom() 函数在 Linux 3.17 或更新的系统上会使用 getrandom() 系统调用，而在 OpenBSD 5.6 或更新的系统上会使用 getentropy()，不必再使用 /dev/urandom 并避免由于潜在的文件描述符耗尽导致的执行失败。 （由 Victor Stinner 在 bpo-22181 [https://bugs.python.org/issue?@action=redirect&bpo=22181] 中贡献。）

New get_blocking() and set_blocking() functions allow getting and setting a file descriptor's blocking mode (O_NONBLOCK.) (Contributed by Victor Stinner in bpo-22054 [https://bugs.python.org/issue?@action=redirect&bpo=22054].)

现在 truncate() 和 ftruncate() 函数在 Windows 上已受到支持。 （由 Steve Dower 在 bpo-23668 [https://bugs.python.org/issue?@action=redirect&bpo=23668] 中贡献。）

新增的 os.path.commonpath() 函数可返回所传入的每个路径名的最长共同子路径。 与 os.path.commonprefix() 函数不同，该函数总是会返回一个有效的路径:

>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'

（由 Rafik Draoui 和 Serhiy Storchaka 在 bpo-10395 [https://bugs.python.org/issue?@action=redirect&bpo=10395] 中贡献。）

pathlib

新增的 Path.samefile() 方法可被用来检查一个路径是否与另一个路径指向相同的文件，两个路径可以是 Path 对象，也可以是字符串:

>>> import pathlib
>>> p1 = pathlib.Path('/etc/hosts')
>>> p2 = pathlib.Path('/etc/../etc/hosts')
>>> p1.samefile(p2)
True

（由 Vajrasky Kok 和 Antoine Pitrou 在 bpo-19775 [https://bugs.python.org/issue?@action=redirect&bpo=19775] 中贡献。）

现在 Path.mkdir() 方法接受一个新的 exist_ok 可选参数以与 mkdir -p 和 os.makedirs() 的功能相匹配。 （由 Berker Peksag 在 bpo-21539 [https://bugs.python.org/issue?@action=redirect&bpo=21539] 中贡献。）

新增了一个 Path.expanduser() 方法用于扩展 ~ 和 ~user 前缀。 （由 Serhiy Storchaka 和 Claudiu Popa 在 bpo-19776 [https://bugs.python.org/issue?@action=redirect&bpo=19776] 中贡献。）

新增的 Path.home() 类方法可被用于获取代表用户家目录的 Path 实例。 （由 Victor Salgado 和 Mayank Tripathi 在 bpo-19777 [https://bugs.python.org/issue?@action=redirect&bpo=19777] 中贡献。）

新增 Path.write_text(), Path.read_text(), Path.write_bytes(), Path.read_bytes() 方法用于简化对文件的读/写操作。

以下代码片段将创建或重写现有的文件 ~/spam42:

>>> import pathlib
>>> p = pathlib.Path('~/spam42')
>>> p.expanduser().write_text('ham')
3

（由 Christopher Welborn 在 bpo-20218 [https://bugs.python.org/issue?@action=redirect&bpo=20218] 中贡献。）

pickle

嵌套的对象，例如未绑定方法或嵌套的类，现在可以使用早于协议版本 4 的 pickle 协议。 协议版本 4 在此前已支持此种场景。 （由 Serhiy Storchaka 在 bpo-23611 [https://bugs.python.org/issue?@action=redirect&bpo=23611] 中贡献。）

poplib

新增 POP3.utf8() 命令可以启用 RFC 6856 [https://datatracker.ietf.org/doc/html/rfc6856.html] (国际化 Email) 支持，如果 POP 服务器支持的话。 （由 Milan OberKirch 在 bpo-21804 [https://bugs.python.org/issue?@action=redirect&bpo=21804] 中贡献。）

re

现在对固定长度分组的引用和有条件引用在后视断言中已被允许:

>>> 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'>

（由 Serhiy Storchaka 在 bpo-9179 [https://bugs.python.org/issue?@action=redirect&bpo=9179] 中贡献。）

在正则表达式中捕获分组的数量不再有 100 个的上限。 （由 Serhiy Storchaka 在 bpo-22437 [https://bugs.python.org/issue?@action=redirect&bpo=22437] 中贡献。）

现在 sub() 和 subn() 函数将用空字符串替换不匹配的分组而不是引发异常。 （由 Serhiy Storchaka 在 bpo-1519638 [https://bugs.python.org/issue?@action=redirect&bpo=1519638] 中贡献。）

re.error 异常添加了新的属性 msg, pattern, pos, lineno 和 colno，以提供更详细的错误上下文信息:

>>> re.compile("""
...     (?x)
...     .++
... """)
Traceback (most recent call last):
   ...
sre_constants.error: multiple repeat at position 16 (line 3, column 7)

（由 Serhiy Storchaka 在 bpo-22578 [https://bugs.python.org/issue?@action=redirect&bpo=22578] 中贡献。）

readline

新增的 append_history_file() 函数可被用于将历史数据中指定数量的末尾元素添加到给定的文件中。 （由 Bruno Cauet 在 bpo-22940 [https://bugs.python.org/issue?@action=redirect&bpo=22940] 中贡献。）

selectors

新增的 DevpollSelector 在 Solaris 上支持高效的 /dev/poll 轮询。 （由 Giampaolo Rodola' 在 bpo-18931 [https://bugs.python.org/issue?@action=redirect&bpo=18931] 中贡献。）

shutil

现在 move() 函数现在接受一个 copy_function 参数，举例来说，如果需要在移动文件时忽略其元数据，可以使用 copy() 函数来代替默认的 copy2()。 （由 Claudiu Popa 在 bpo-19840 [https://bugs.python.org/issue?@action=redirect&bpo=19840] 中贡献。）

现在 make_archive() 函数已支持 xztar 格式。 （由 Serhiy Storchaka 在 bpo-5411 [https://bugs.python.org/issue?@action=redirect&bpo=5411] 中贡献。）

signal

在 Windows 上，现在 set_wakeup_fd() 函数还可以支持套接字句柄。 （由 Victor Stinner 在 bpo-22018 [https://bugs.python.org/issue?@action=redirect&bpo=22018] 中贡献。）

signal 模块中的各个 SIG* 常量已被转换为 枚举。 这允许在调试期间打印有意义的名称，而不是整数类型的“魔法数字”。 （由 Giampaolo Rodola' 在 bpo-21076 [https://bugs.python.org/issue?@action=redirect&bpo=21076] 中贡献。）

smtpd

Both the SMTPServer and SMTPChannel classes now accept a decode_data keyword argument to determine if the DATA portion of the SMTP transaction is decoded using the "utf-8" codec or is instead provided to the SMTPServer.process_message() method as a byte string. The default is True for backward compatibility reasons, but will change to False in Python 3.6. If decode_data is set to False, the process_message method must be prepared to accept keyword arguments. (Contributed by Maciej Szulik in bpo-19662 [https://bugs.python.org/issue?@action=redirect&bpo=19662].)

The SMTPServer class now advertises the 8BITMIME extension (RFC 6152 [https://datatracker.ietf.org/doc/html/rfc6152.html]) if decode_data has been set True. If the client specifies BODY=8BITMIME on the MAIL command, it is passed to SMTPServer.process_message() via the mail_options keyword. (Contributed by Milan Oberkirch and R. David Murray in bpo-21795 [https://bugs.python.org/issue?@action=redirect&bpo=21795].)

The SMTPServer class now also supports the SMTPUTF8 extension (RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html]: Internationalized Email). If the client specified SMTPUTF8 BODY=8BITMIME on the MAIL command, they are passed to SMTPServer.process_message() via the mail_options keyword. It is the responsibility of the process_message method to correctly handle the SMTPUTF8 data. (Contributed by Milan Oberkirch in bpo-21725 [https://bugs.python.org/issue?@action=redirect&bpo=21725].)

It is now possible to provide, directly or via name resolution, IPv6 addresses in the SMTPServer constructor, and have it successfully connect. (Contributed by Milan Oberkirch in bpo-14758 [https://bugs.python.org/issue?@action=redirect&bpo=14758].)

smtplib

新增的 SMTP.auth() 方法为实现自定义身份验证机制提供了一个便捷的方式。 （由 Milan Oberkirch 在 bpo-15014 [https://bugs.python.org/issue?@action=redirect&bpo=15014] 中贡献。）

现在 SMTP.set_debuglevel() 方法可接受额外的 debuglevel (2)，它将在调试消息中启用时间戳。 （由 Gavin Chappell 和 Maciej Szulik 在 bpo-16914 [https://bugs.python.org/issue?@action=redirect&bpo=16914] 中贡献。）

现在 SMTP.sendmail() 和 SMTP.send_message() 方法均支持 RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html] (SMTPUTF8)。 （由 Milan Oberkirch 和 R. David Murray 在 bpo-22027 [https://bugs.python.org/issue?@action=redirect&bpo=22027] 中贡献。）

sndhdr

现在 what() 和 whathdr() 函数将返回 namedtuple()。 （由 Claudiu Popa 在 bpo-18615 [https://bugs.python.org/issue?@action=redirect&bpo=18615] 中贡献。）.)

socket

现在函数的超时设置将使用单调时钟，而不是系统时钟。 （由 Victor Stinner 在 bpo-22043 [https://bugs.python.org/issue?@action=redirect&bpo=22043] 中贡献。）

新增的 socket.sendfile() 方法允许在 UNIX 上使用高性能的 os.sendfile() 函数通过套接字发送文件，使得上传速度比使用简单的 socket.send() 快 2 至 3 倍。 （由 Giampaolo Rodola' 在 bpo-17552 [https://bugs.python.org/issue?@action=redirect&bpo=17552] 中贡献。）

socket.sendall() 方法每次接受或发送字节数据时将不再重置套接字超时。 现在套接字超时将为发送所有数据最大总计持续时间。 （由 Victor Stinner 在 bpo-23853 [https://bugs.python.org/issue?@action=redirect&bpo=23853] 中贡献。）

现在 socket.listen() 方法的 backlog 参数将是可选的。 在默认情况下它会被设为 SOMAXCONN 或 128，取其中的较小值。 （由 Charles-François Natali 在 bpo-21455 [https://bugs.python.org/issue?@action=redirect&bpo=21455] 中贡献。）

ssl

内存 BIO 支持

（由 Geert Jansen 在 bpo-21965 [https://bugs.python.org/issue?@action=redirect&bpo=21965] 中贡献。）

新增了 SSLObject 类以针对 SSLSocket 的网络 I/O 能力是非必要或未优化的情况提供 SSL 协议支持。 SSLObject 代表一个 SSL 协议实例，但不实现任何网络 I/O 方法，而是提供一个内存缓冲区接口。 新增的 MemoryBIO 类可被用于在 Python 和 SSL 协议实例之间传递数据。

内存 BIO SSL 支持主要被用来为对 SSLSocket 的就绪模型（"选择/轮询"）来说效率较低的框架实现异步 I/O。

新增的 SSLContext.wrap_bio() 方法可被用于创建新的 SSLObject 实例。

应用层协议协商支持

（由 Benjamin Peterson 在 bpo-20188 [https://bugs.python.org/issue?@action=redirect&bpo=20188] 中贡献。）

如果有 OpenSSL 支持，现在 ssl 模块可实现 RFC 7301 [https://datatracker.ietf.org/doc/html/rfc7301.html] 中描述的 应用层协议协商 TLS 扩展。

新增的 SSLContext.set_alpn_protocols() 可被用来指定在 TLS 握手期间套接字所要应用的协议。

The new SSLSocket.selected_alpn_protocol() returns the protocol that was selected during the TLS handshake. The HAS_ALPN flag indicates whether ALPN support is present.

其他改变

新增 SSLSocket.version() 方法以便查询实际使用的协议。 （由 Antoine Pitrou 在 bpo-20421 [https://bugs.python.org/issue?@action=redirect&bpo=20421] 中贡献。）

现在 SSLSocket 类已实现了 SSLSocket.sendfile() 方法。 （由 Giampaolo Rodola' 在 bpo-17552 [https://bugs.python.org/issue?@action=redirect&bpo=17552] 中贡献。）

现在当操作将要阻塞时 SSLSocket.send() 方法将在非阻塞的套接字上引发 ssl.SSLWantReadError 或 ssl.SSLWantWriteError 异常。 在之前版本中，它将返回 0。 （由 Nikolaus Rath 在 bpo-20951 [https://bugs.python.org/issue?@action=redirect&bpo=20951] 中贡献。）

根据 RFC 5280 [https://datatracker.ietf.org/doc/html/rfc5280.html]，现在 cert_time_to_seconds() 函数会将输入的时间解读为 UTC 而不是本地时间。 此外，其返回值必定为 int。 （由 Akira Li 在 bpo-19940 [https://bugs.python.org/issue?@action=redirect&bpo=19940] 中贡献。）

新增的 SSLObject.shared_ciphers() 和 SSLSocket.shared_ciphers() 方法将返回客户端在握手期间中发送的密码列表。 （由 Benjamin Peterson 在 bpo-23186 [https://bugs.python.org/issue?@action=redirect&bpo=23186] 中贡献。）

SSLSocket 类的 SSLSocket.do_handshake(), SSLSocket.read(), SSLSocket.shutdown() 和 SSLSocket.write() 方法在每次接收或发送字节数据时将不再重置套接字超时。 现在套接字超时将为方法的最长运行时间。 （由 Victor Stinner 在 bpo-23853 [https://bugs.python.org/issue?@action=redirect&bpo=23853] 中贡献。）

现在 match_hostname() 函数也支持 IP 地址的匹配。 （由 Antoine Pitrou 在 bpo-23239 [https://bugs.python.org/issue?@action=redirect&bpo=23239] 中贡献。）

sqlite3

现在 Row 类可完整支持序列协议，特别是 reversed() 迭代和切片索引。 （由 Claudiu Popa 在 bpo-10203 [https://bugs.python.org/issue?@action=redirect&bpo=10203] 中贡献；由 Lucas Sinclair, Jessica McKellar 和 Serhiy Storchaka 在 bpo-13583 [https://bugs.python.org/issue?@action=redirect&bpo=13583] 中贡献。）

subprocess

新增了 run() 函数。 它可运行指定的命令并返回一个 CompletedProcess 对象，该对象表示已结束的进程。 这个新 API 有更好的一致性并且是在 Python 中唤起子进程的推荐方式，它不需要维持与更早的 Python 的兼容性。 （由 Thomas Kluyver 在 bpo-23342 [https://bugs.python.org/issue?@action=redirect&bpo=23342] 中贡献。）

示例:

>>> subprocess.run(["ls", "-l"])  # doesn't capture output
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')

sys

新增的 set_coroutine_wrapper() 函数允许设置一个要在 协程对象 被 async def 函数创建时被调用的全局钩子。 可以使用相应的 get_coroutine_wrapper() 来获取当前设置的包装器。 这两个函数均为 暂定状态，并应当仅用于调试目的。 （由 Yury Selivanov 在 bpo-24017 [https://bugs.python.org/issue?@action=redirect&bpo=24017] 中贡献。）

新增的 is_finalizing() 函数可用于检测 Python 解释器是否 正在关闭。 （由 Antoine Pitrou 在 bpo-22696 [https://bugs.python.org/issue?@action=redirect&bpo=22696] 中贡献。）

sysconfig

在 Windows 上用户脚本的名称现在将包括 Python 版本号的前两个数字。 （由 Paul Moore 在 bpo-23437 [https://bugs.python.org/issue?@action=redirect&bpo=23437] 中贡献。）

tarfile

现在 open() 函数的 mode 参数可接受 "x" 来请求独占式的创建。 （由 Berker Peksag 在 bpo-21717 [https://bugs.python.org/issue?@action=redirect&bpo=21717] 中贡献。）

现在 TarFile.extractall() 和 TarFile.extract() 方法可接受关键字参数 numeric_owner。 如果设为 True，解压的文件和目录将归属于 tar 文件保存的数字 uid 和 gid。 如果设为 False (默认值，也是 3.5 之前版本的行为)，则它们将归属于 tar 文件保存的用户和组名称。 （由 Michael Vogt 和 Eric Smith 在 bpo-23193 [https://bugs.python.org/issue?@action=redirect&bpo=23193] 中贡献。）

现在 TarFile.list() 接受可选的 members 关键字参数，它可被设为 TarFile.getmembers() 所返回的列表的一个子集。 （由 Serhiy Storchaka 在 bpo-21549 [https://bugs.python.org/issue?@action=redirect&bpo=21549] 中贡献。）

threading

现在 Lock.acquire() 和 RLock.acquire() 方法均使用单调时钟进行超时管理。 （由 Victor Stinner 在 bpo-22043 [https://bugs.python.org/issue?@action=redirect&bpo=22043] 中贡献。）

time

现在 monotonic() 函数将总是可用。 （由 Victor Stinner 在 bpo-22043 [https://bugs.python.org/issue?@action=redirect&bpo=22043] 中贡献。）

timeit

新增的命令行选项 -u 或 --unit=U 可被用于指定计时器输出的时间单位。 受支持的选项有 usec, msec 或 sec。 （由 Julian Gindi 在 bpo-18983 [https://bugs.python.org/issue?@action=redirect&bpo=18983] 中贡献。）

timeit() 函数新增了 globals 形参用于指定代码运行所在的命名空间。 （由 Ben Roberts 在 bpo-2527 [https://bugs.python.org/issue?@action=redirect&bpo=2527] 中贡献。）.)

tkinter

用于在 Windows 上设置 Tcl/Tk 环境的 tkinter._fix 模块已被 _tkinter 模块中的私有函数所替换，该函数不会永久性修改环境变量。 （由 Zachary Ware 在 bpo-20035 [https://bugs.python.org/issue?@action=redirect&bpo=20035] 中贡献。）

回溯

New walk_stack() and walk_tb() functions to conveniently traverse frame and traceback objects. (Contributed by Robert Collins in bpo-17911 [https://bugs.python.org/issue?@action=redirect&bpo=17911].)

新增轻量级的类: TracebackException, StackSummary 和 FrameSummary。 （由 Robert Collins 在 bpo-17911 [https://bugs.python.org/issue?@action=redirect&bpo=17911] 中贡献。）

现在 print_tb() 和 print_stack() 函数均支持 limit 参数使用负值。 （由 Dmitry Kazakov 在 bpo-22619 [https://bugs.python.org/issue?@action=redirect&bpo=22619] 中贡献。）.)

types

新增 coroutine() 函数用于将 生成器 和 生成器型 对象转换为 可等待对象。 （由 Yury Selivanov 在 bpo-24017 [https://bugs.python.org/issue?@action=redirect&bpo=24017] 中贡献。）

新增一个名为 CoroutineType 的类型，用于由 async def 函数创建的 coroutine 对象。 （由 Yury Selivanov 在 bpo-24400 [https://bugs.python.org/issue?@action=redirect&bpo=24400] 中贡献。）

unicodedata

现在 unicodedata 模块使用来自 Unicode 8.0.0 [https://unicode.org/versions/Unicode8.0.0/] 的数据。

unittest

现在 TestLoader.loadTestsFromModule() 方法可接受仅限关键字参数 pattern，它将作为传给 load_tests 的第三个参数。 找到的包无论其路径是否匹配 pattern 都会针对 load_tests 进行检查，因为包名不可能与默认模式相匹配。 （由 Robert Collins 和 Barry A. Warsaw 在 bpo-16662 [https://bugs.python.org/issue?@action=redirect&bpo=16662] 中贡献。）

单元测试发现错误现在将会暴露为 TestLoader 的 TestLoader.errors 属性。 （由 Robert Collins 在 bpo-19746 [https://bugs.python.org/issue?@action=redirect&bpo=19746] 中贡献。）

新增的命令行选项 --locals 可显示回溯中的局部变量。 （由 Robert Collins 在 bpo-22936 [https://bugs.python.org/issue?@action=redirect&bpo=22936] 中贡献。）

unittest.mock

Mock 类具有以下改进：

类构造器新增了 unsafe 形参，它可导致模拟对象在名称以 "assert" 打头的属性名上引发 AttributeError。 （由 Kushal Das 在 bpo-21238 [https://bugs.python.org/issue?@action=redirect&bpo=21238] 中贡献。）

新增了 Mock.assert_not_called() 方法用于检测模拟对象是否已被调用。 （由 Kushal Das 在 bpo-21262 [https://bugs.python.org/issue?@action=redirect&bpo=21262] 中贡献。）

现在 MagicMock 类已支持 __truediv__(), __divmod__() 和 __matmul__() 运算符。 （由 Johannes Baiter 在 bpo-20968 [https://bugs.python.org/issue?@action=redirect&bpo=20968] 中贡献，并由 Håkan Lövdahl 在 bpo-23581 [https://bugs.python.org/issue?@action=redirect&bpo=23581] 和 bpo-23568 [https://bugs.python.org/issue?@action=redirect&bpo=23568] 中贡献。）

在对内置名称打补丁时不再需要显式地将 create=True 传给 patch() 函数。 （由 Kushal Das 在 bpo-17660 [https://bugs.python.org/issue?@action=redirect&bpo=17660] 中贡献。）

urllib

新增的 request.HTTPPasswordMgrWithPriorAuth 类允许对 HTTP 基本认证凭据进行管理以消除不必要的 401 响应处理，或在第一次请求时无条件地发送凭据，以便与返回 404 响应的服务器通信而不是在未发送 Authorization 头信息的情况下发送 401。 （由 Matej Cepl 在 bpo-19494 [https://bugs.python.org/issue?@action=redirect&bpo=19494] 以及 Akshit Khurana 在 bpo-7159 [https://bugs.python.org/issue?@action=redirect&bpo=7159] 中贡献。）

为 parse.urlencode() 函数新增的 quote_via 参数提供了一种在需要时控制查询部分的编码格式的手段。 （由 Samwyse 和 Arnon Yaari 在 bpo-13866 [https://bugs.python.org/issue?@action=redirect&bpo=13866] 中贡献。）

request.urlopen() 函数接受 ssl.SSLContext 对象作为 context 参数，它将被用于 HTTPS 连接。 （由 Alex Gaynor 在 bpo-22366 [https://bugs.python.org/issue?@action=redirect&bpo=22366] 中贡献。）.)

parse.urljoin() 已获得更新已使用 RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html] 语义来解析相对 URL，而不是 RFC 1808 [https://datatracker.ietf.org/doc/html/rfc1808.html] 和 RFC 2396 [https://datatracker.ietf.org/doc/html/rfc2396.html]。 （由 Demian Brecht 和 Senthil Kumaran 在 bpo-22118 [https://bugs.python.org/issue?@action=redirect&bpo=22118] 中贡献。）

wsgiref

现在 headers.Headers 类构造器的 headers 参数将是可选的。 （由 Pablo Torres Navarrete 和 SilentGhost 在 bpo-5800 [https://bugs.python.org/issue?@action=redirect&bpo=5800] 中贡献。）

xmlrpc

现在 client.ServerProxy 类已支持 context manager 协议。 （由 Claudiu Popa 在 bpo-20627 [https://bugs.python.org/issue?@action=redirect&bpo=20627] 中贡献。）

现在 client.ServerProxy 构造器接受可选的 ssl.SSLContext 实例。 （由 Alex Gaynor 在 bpo-22960 [https://bugs.python.org/issue?@action=redirect&bpo=22960] 中贡献。）

xml.sax

现在 SAX 解析器已支持 xmlreader.InputSource 对象的字符流。 （由 Serhiy Storchaka 在 bpo-2175 [https://bugs.python.org/issue?@action=redirect&bpo=2175] 中贡献。）

现在 parseString() 接受 str 实例。 （由 Serhiy Storchaka 在 bpo-10590 [https://bugs.python.org/issue?@action=redirect&bpo=10590] 中贡献。）

zipfile

现在可以将 ZIP 输出写入到不可定位的流。 （由 Serhiy Storchaka 在 bpo-23252 [https://bugs.python.org/issue?@action=redirect&bpo=23252] 中贡献。）

现在 ZipFile.open() 方法的 mode 参数可接受 "x" 来请求独占式的创建。 （由 Serhiy Storchaka 在 bpo-21717 [https://bugs.python.org/issue?@action=redirect&bpo=21717] 中贡献。）

其他模块级更改

现在 mmap, ossaudiodev, socket, ssl 和 codecs 模块中的许多函数都接受可写的 字节型对象。 （由 Serhiy Storchaka 在 bpo-23001 [https://bugs.python.org/issue?@action=redirect&bpo=23001] 中贡献。）

性能优化

os.walk() 函数在 POSIX 系统上可提速 3 至 5 倍，而在 Windows 上可提速 7 至 20 倍。 这是因为使用了新的 os.scandir() 函数，它可以暴露来自下层 readdir 或 FindFirstFile/FindNextFile 系统调用的文件信息。 （由 Ben Hoyt 在 bpo-23605 [https://bugs.python.org/issue?@action=redirect&bpo=23605] 中贡献并得到 Victor Stinner 的协助。）

对于大对象 bytes(int) (以零字节填充) 的构建速度更快且使用更少内存。 将使用 calloc() 而不是 malloc() 为这些对象分配内存。 （由 Victor Stinner 在 bpo-21233 [https://bugs.python.org/issue?@action=redirect&bpo=21233] 中贡献。）

ipaddress 中的 IPv4Network 和 IPv6Network 等操作获得了大幅度的加速，比如 subnets(), supernet(), summarize_address_range(), collapse_addresses()。 加速幅度从 3 到 15 倍不等。 （由 Antoine Pitrou, Michel Albert 和 Markus 在 bpo-21486 [https://bugs.python.org/issue?@action=redirect&bpo=21486], bpo-21487 [https://bugs.python.org/issue?@action=redirect&bpo=21487], bpo-20826 [https://bugs.python.org/issue?@action=redirect&bpo=20826], bpo-23266 [https://bugs.python.org/issue?@action=redirect&bpo=23266] 中贡献。）

ipaddress 对象的封存操作获得了优化以产生显著减小的输出。 （由 Serhiy Storchaka 在 bpo-23133 [https://bugs.python.org/issue?@action=redirect&bpo=23133] 中贡献。）

现在 io.BytesIO 上的许多操作可提速 50% 至 100%。 （由 Serhiy Storchaka 在 bpo-15381 [https://bugs.python.org/issue?@action=redirect&bpo=15381] 以及 David Wilson 在 bpo-22003 [https://bugs.python.org/issue?@action=redirect&bpo=22003] 中贡献。）

现在 marshal.dumps() 函数速度可提升：对于典型数据来说版本 3 和 4 为 65--85%，版本 0 至 2 为 20--25%，最佳场景下最多可达 5 倍。 （由 Serhiy Storchaka 在 bpo-20416 [https://bugs.python.org/issue?@action=redirect&bpo=20416] 和 bpo-23344 [https://bugs.python.org/issue?@action=redirect&bpo=23344] 中贡献。）

现在 UTF-32 编码器可提速 3 至 7 倍。 （由 Serhiy Storchaka 在 bpo-15027 [https://bugs.python.org/issue?@action=redirect&bpo=15027] 中贡献。）

现在正则表达式的解析可提速至多 10%。 （由 Serhiy Storchaka 在 bpo-19380 [https://bugs.python.org/issue?@action=redirect&bpo=19380] 中贡献。）.)

json.dumps() 函数已获优化使得设置 ensure_ascii=False 时与设置 ensure_ascii=True 时运行得一样快。 （由 Naoki Inada 在 bpo-23206 [https://bugs.python.org/issue?@action=redirect&bpo=23206] 中贡献。）

PyObject_IsInstance() 和 PyObject_IsSubclass() 函数在第二个参数以 type 作为其元类的常见情况下已获得加速。 （由 Georg Brandl 在 bpo-22540 [https://bugs.python.org/issue?@action=redirect&bpo=22540] 中贡献。）

方法缓存操作已获少量改进，在某些基准测试中可产生至多 5% 的性能提升。 （由 Antoine Pitrou 在 bpo-22847 [https://bugs.python.org/issue?@action=redirect&bpo=22847] 中贡献。）

现在来自 random 模块的对象在 64 位编译版上使用的内存将减少 50%。 （由 Serhiy Storchaka 在 bpo-23488 [https://bugs.python.org/issue?@action=redirect&bpo=23488] 中贡献。）

property() getter 调用可提速 25%。 （由 Joe Jevnik 在 bpo-23910 [https://bugs.python.org/issue?@action=redirect&bpo=23910] 中贡献。）

现在 fractions.Fraction 的实例化可提速至多 30%。 （由 Stefan Behnel 在 bpo-22464 [https://bugs.python.org/issue?@action=redirect&bpo=22464] 中贡献。）

现在字符串方法 find(), rfind(), split(), partition() 和 in 字符串运算符在搜索 1 个字符的子字符串时将显著提速。 （由 Serhiy Storchaka 在 bpo-23573 [https://bugs.python.org/issue?@action=redirect&bpo=23573] 中贡献。）

构建和 C API 的改变

增加了 calloc 函数

PyMem_RawCalloc(),

PyMem_Calloc(),

PyObject_Calloc().

(Victor Stinner 贡献于 bpo-21233 [https://bugs.python.org/issue?@action=redirect&bpo=21233].)

新的 encoding/decoding 帮助函数:

Py_DecodeLocale() (替代 _Py_char2wchar()),

Py_EncodeLocale() (替代 _Py_wchar2char()).

（由 Victor Stinner 在 bpo-18395 [https://bugs.python.org/issue?@action=redirect&bpo=18395] 中贡献。）

新增的 PyCodec_NameReplaceErrors() 函数可以将 unicode 编码错误替换为 \N{...} 转义符号。 （由 Serhiy Storchaka 在 bpo-19676 [https://bugs.python.org/issue?@action=redirect&bpo=19676] 中贡献。）

A new PyErr_FormatV() function similar to PyErr_Format(), but accepts a va_list argument. (Contributed by Antoine Pitrou in bpo-18711 [https://bugs.python.org/issue?@action=redirect&bpo=18711].)

新增 PyExc_RecursionError 异常。 （由 Georg Brandl 在 bpo-19235 [https://bugs.python.org/issue?@action=redirect&bpo=19235] 中贡献。）

新增 PyModule_FromDefAndSpec(), PyModule_FromDefAndSpec2() 和 PyModule_ExecDef() 函数，来自 PEP 489 [https://www.python.org/dev/peps/pep-0489] -- 多阶段扩展模块初始化。 （由 Petr Viktorin 在 bpo-24268 [https://bugs.python.org/issue?@action=redirect&bpo=24268] 中贡献。）

新增 PyNumber_MatrixMultiply() 和 PyNumber_InPlaceMatrixMultiply() 函数用于执行矩阵乘法。 （由 Benjamin Peterson 在 bpo-21176 [https://bugs.python.org/issue?@action=redirect&bpo=21176] 中贡献。 另请参阅 PEP 465 [https://www.python.org/dev/peps/pep-0465] 了解详情。）

现在 PyTypeObject.tp_finalize 槽位已成为稳定 ABI 的一部分。

Windows builds now require Microsoft Visual C++ 14.0, which is available as part of Visual Studio 2015 [https://www.visualstudio.com/].

现在扩展模块在某些平台上的文件名将包括平台信息标签（该标签是可选的，即使没有它 CPython 也会导入扩展，但是如果存在不匹配的标签，扩展将不会被加载）：

在 Linux 上，扩展模块文件名将以 .cpython-<major><minor>m-<architecture>-<os>.pyd 结束：

<major> 为 Python 主版本号；对于 Python 3.5 即为 3。

<minor> 为 Python 次版本号；对于 Python 3.5 即为 5。

<architecture> 为扩展模块构建在运行时所使用的硬件架构。 最常见的值是 i386 表示 32 位 Intel 平台或 x86_64 表示 64 位 Intel (和 AMD) 平台。

<os> 将始终为 linux-gnu，除非扩展构建是针对 64 位平台上的 32 位 ABI，在此情况下它将为 linux-gnu32 (而 <architecture> 将为 x86_64)。

在 Windows 上，扩展模块文件名将以 <debug>.cp<major><minor>-<platform>.pyd 结束：

<major> 为 Python 主版本号；对于 Python 3.5 即为 3。

<minor> 为 Python 次版本号；对于 Python 3.5 即为 5。

<platform> 是扩展模块构建所针对的平台，可以为 win32 表示 Win32，win_amd64 表示 Win64，win_ia64 表示 Windows Itanium 64，win_arm 表示 ARM 版 Windows。

如果以调试模式构建，则 <debug> 将为 _d，在其他情况下将为空白。

在 OS X 平台上，扩展模块文件名现在将以 -darwin.so 结束。

在所有其他平台上，扩展模块文件名与 Python 3.4 时一样。

弃用

新关键字

不建议将 async 和 await 用作变量、类、函数或模块的名称。 它们根据 PEP 492 [https://www.python.org/dev/peps/pep-0492] 在 Python 3.5 中被引入，并将在 Python 3.7 成为保留关键字。

已弃用的 Python 行为

在生成器内部引发 StopIteration 异常现在将静默生成一个 PendingDeprecationWarning，这将在 Python 3.6 中改为非静默的弃用警告并在 Python 3.7 中触发 RuntimeError。 请参阅 PEP 479: 修改生成器内部的 StopIteration 处理方式 了解详情。

不支持的操作系统

Windows XP 已不再被 Microsoft 所支持，因此根据 PEP 11 [https://www.python.org/dev/peps/pep-0011]，CPython 3.5 不再对该操作系统提供官方支持。

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

现在 formatter 模块状态已转为完全弃用并仍计划在 Python 3.6 中移除。

asyncio.async() 函数已被弃用并由 of ensure_future() 取代。

The smtpd module has in the past always decoded the DATA portion of email messages using the utf-8 codec. This can now be controlled by the new decode_data keyword to SMTPServer. The default value is True, but this default is deprecated. Specify the decode_data keyword with an appropriate value to avoid the deprecation warning.

直接向 http.cookies.Morsel 对象的 key, value 和 coded_value 赋值操作已弃用。 请改用 set()。 此外，set() 未写入文档的 LegalChars 形参也已弃用，现在将会被忽略。

将格式字符串作为关键字参数 format_string 传给 string.Formatter 类的 format() 方法的操作已被弃用。 （由 Serhiy Storchaka 在 bpo-23671 [https://bugs.python.org/issue?@action=redirect&bpo=23671] 贡献。）

现在 platform.dist() 和 platform.linux_distribution() 函数已被弃用。 各种 Linux 发行版使用太多不同的方式来描述自己，所以此功能将留给具体的包来实现。 （由 Vajrasky Kok 和 Berker Peksag 在 bpo-1322 [https://bugs.python.org/issue?@action=redirect&bpo=1322] 中贡献。）

之前未写入文档的 inspect.Signature 的 from_function 和 from_builtin 方法已被弃用。 请改用新的 Signature.from_callable() 方法。 （由 Yury Selivanov 在 bpo-24248 [https://bugs.python.org/issue?@action=redirect&bpo=24248] 中贡献。）

inspect.getargspec() 函数已被弃用并计划在 Python 3.6 中移除。 （请参阅 bpo-20438 [https://bugs.python.org/issue?@action=redirect&bpo=20438] 了解详情。）

inspect 的 getfullargspec(), getcallargs() 和 formatargspec() 函数已被弃用而应改用 inspect.signature() API。 （由 Yury Selivanov 在 bpo-20438 [https://bugs.python.org/issue?@action=redirect&bpo=20438] 中贡献。）

在 Python 3.5.0 发布时 getargvalues() 和 formatargvalues() 函数被误标记为已弃用。

在 str 模式中使用 re.LOCALE 旗标或 re.ASCII 的做法现在已被弃用。 （由 Serhiy Storchaka 在 bpo-22407 [https://bugs.python.org/issue?@action=redirect&bpo=22407] 中贡献。）

在正则表达式模式和替换模式中使用不可识别的由 '\' 加一个 ASCII 字母组成的序列的做法现在会引发弃用警告并将在 Python 3.6 中被禁止。 （由 Serhiy Storchaka 在 bpo-23622 [https://bugs.python.org/issue?@action=redirect&bpo=23622] 中贡献。）

现在 unittest.TestLoader.loadTestsFromModule() 方法未写入文档的非官方 use_load_tests 默认参数已被弃用并会被忽略。 （由 Robert Collins 和 Barry A. Warsaw 在 bpo-16662 [https://bugs.python.org/issue?@action=redirect&bpo=16662] 中贡献。）

移除

API 与特性的移除

以下过时并在之前版本中弃用的 API 和特性现已被移除：

__version__ 属性已从 mail 包中被去除。 email 包的代码已经很久没有与 stdlib 分开发布了，而 __version__ 字符串在最近几次发布版中也没有被更新。

在 ftplib 模块中的内部 Netrc 类在 3.4 中被弃用，现在已被移除。 （由 Matt Chaput 在 bpo-6623 [https://bugs.python.org/issue?@action=redirect&bpo=6623] 中贡献。）

.pyo 文件的概念已被移除。

暂定的 asyncio 模块中的 JoinableQueue 类在 3.4.4 中被弃用，现在已被移除。 （由 A. Jesse Jiryu Davis 在 bpo-23464 [https://bugs.python.org/issue?@action=redirect&bpo=23464] 中贡献。）

移植到Python 3.5

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

Python 行为的改变

由于一个疏忽，之前的 Python 版本会错误地接受以下语法:

f(1 for x in [1], *args)
f(1 for x in [1], **kwargs)

对于生成器表达式不是传给函数的唯一参数时必须放在圆括号内的情况，Python 3.5 现在会正确地引发 SyntaxError。

Python API 的变化

PEP 475 [https://www.python.org/dev/peps/pep-0475]: 现在当系统调用被信号中断时如果 Python 信号处理器没有引发异常则会执行重试而不是引发 InterruptedError。

在 Python 3.5 之前，如果一个 datetime.time 对象是表示 UTC 时间的午夜则会被视为假值。 此行为被认为容易造成困惑和错误因而在 Python 3.5 中已被去除。 详情参见 bpo-13936 [https://bugs.python.org/issue?@action=redirect&bpo=13936]。

现在当操作将要阻塞时 ssl.SSLSocket.send() 方法将在非阻塞的套接字上引发 ssl.SSLWantReadError 或 ssl.SSLWantWriteError。 在之前版本中，它将返回 0。 （由 Nikolaus Rath 在 bpo-20951 [https://bugs.python.org/issue?@action=redirect&bpo=20951] 中贡献。）

现在生成器的 __name__ 属性是根据函数名设置的，而不是根据代码名设置的。 请使用 gen.gi_code.co_name 来获取代码名。 生成器还有一个新的 __qualname__ 属性，即限定名称，它现在用于生成器的表示形式 (repr(gen))。 （由 Victor Stinner 在 bpo-21205 [https://bugs.python.org/issue?@action=redirect&bpo=21205] 中贡献。）

The deprecated "strict" mode and argument of HTMLParser, HTMLParser.error(), and the HTMLParserError exception have been removed. (Contributed by Ezio Melotti in bpo-15114 [https://bugs.python.org/issue?@action=redirect&bpo=15114].) The convert_charrefs argument of HTMLParser is now True by default. (Contributed by Berker Peksag in bpo-21047 [https://bugs.python.org/issue?@action=redirect&bpo=21047].)

虽然不是 API 的正式组成部分，但对于移植目的（例如：修复测试）来说需要注意之前 "'sometype' does not support the buffer protocol" 形式的错误消息现在将为 "a bytes-like object is required, not 'sometype'" 形式。 （由 Ezio Melotti 在 bpo-16518 [https://bugs.python.org/issue?@action=redirect&bpo=16518] 中贡献。）

在当前目录被设为已不存在的目录时将不再引发 FileNotFoundError 而是改为 find_spec() 返回 None 并且 不在 sys.path_importer_cache 中缓存 None，这与典型的场景存在区别 (bpo-22834 [https://bugs.python.org/issue?@action=redirect&bpo=22834])。

http.client 和 http.server 中的 HTTP 状态码和消息被重构为一个通用的 HTTPStatus 枚举。 http.client 和 http.server 中的值仍可被用于向下兼容性。 （由 Demian Brecht 在 bpo-21793 [https://bugs.python.org/issue?@action=redirect&bpo=21793] 中贡献。）

现在当一个导入加载器定义了 importlib.machinery.Loader.exec_module() 时它也应该定义 create_module() (现在会引发 DeprecationWarning，在 Python 3.6 中将引发错误)。 如果加载器是继承自 importlib.abc.Loader 那么就不需要做什么，在其他情况下只须定义 create_module() 来返回 None。 （由 Brett Cannon 在 bpo-23014 [https://bugs.python.org/issue?@action=redirect&bpo=23014] 中贡献。）

re.split() 函数总是会忽略空的模式匹配，因此 "x*" 模式的效果与 "x+" 相同，而 "\b" 模式则没有效果。 现在当模式将匹配空字符串时 re.split() 会引发一个警告。 为保持兼容性，请使用绝不会匹配空字符串的模式 (例如使用 "x+" 而不是 "x*")。 只匹配空字符串的模式 (例如 "\b") 现在会引发一个错误。 （由 Serhiy Storchaka 在 bpo-22818 [https://bugs.python.org/issue?@action=redirect&bpo=22818] 中贡献。）

http.cookies.Morsel 字典型接口已更为自洽：morsel 比较现在会将 key 和 value 都纳入考虑，copy() 现在将得到一个 Morsel 实例而不是 dict，而 update() 现在当更新字典中的任一个键无效时将引发一个异常。 此外，set() 中未写入文档的 LegalChars 形参已被弃用并且现在会被忽略。 （由 Demian Brecht 在 bpo-2211 [https://bugs.python.org/issue?@action=redirect&bpo=2211] 中贡献。）

PEP 488 [https://www.python.org/dev/peps/pep-0488] 从 Python 中移除了``.pyo`` 文件并在 .pyc 文件名中引入可选的 opt- 标签。 importlib.util.cache_from_source() 增加了 optimization 形参以协助控制 opt- 标签。 为此，该函数的 debug_override 形参现在已被弃用。 .pyo 文件也已不再可以作为传给 Python 解释器的文件参数并且在单独分发（即不带源码的代码分发）时将不起作用。 由于在 Python 3.5 中字节码的魔术数字已被改变，即使在不考虑此 PEP 的情况下所有之前版本的 Python 的旧 .pyo 文件都已不可用。

The socket module now exports the CAN_RAW_FD_FRAMES constant on linux 3.6 and greater.

根据 RFC 5280 [https://datatracker.ietf.org/doc/html/rfc5280.html]，现在 ssl.cert_time_to_seconds() 函数会将输入的时间解读为 UTC 而不是本地时间。 此外，其返回值必须为 int。 （由 Akira Li 在 bpo-19940 [https://bugs.python.org/issue?@action=redirect&bpo=19940] 中贡献。）

现在 pygettext.py 工具将为 POT-Creation-Date 标头中的时区使用标准的 +NNNN 格式。

现在 smtplib 模块对于调试输出将使用 sys.stderr 而不是之前的模块级 stderr 变量。 如果你的（测试）程序依赖于对模块级变量打补丁来捕获调试输出，你将需要更新代码将其改为捕获 sys.stderr。

当发现空字符串且索引完全超出范围时 str.startswith() 和 str.endswith() 方法将不再返回 True。 （由 Serhiy Storchaka 在 bpo-24284 [https://bugs.python.org/issue?@action=redirect&bpo=24284] 中贡献。）

现在 inspect.getdoc() 将返回从基类继承的文档字符串。 如果继承的文档字符串可用就不需要再复制文档字符串。 要屏蔽继承的字符串，必须指定一个空字符串（否则将会填充文档）。 此项改变将影响 pydoc 模块和 help() 函数的输出。 （由 Serhiy Storchaka 在 bpo-15582 [https://bugs.python.org/issue?@action=redirect&bpo=15582] 中贡献。）

嵌套的 functools.partial() 调用现在已被展平。 如果你需要之前的行为，现在你可以为 functools.partial() 对象添加一个属性或者创建一个 functools.partial() 的子类。 （由 Alexander Belopolsky 在 bpo-7830 [https://bugs.python.org/issue?@action=redirect&bpo=7830] 中贡献。）

C API 的变化

The undocumented format member of the (non-public) PyMemoryViewObject structure has been removed. All extensions relying on the relevant parts in memoryobject.h must be rebuilt.

The PyMemAllocator structure was renamed to PyMemAllocatorEx and a new calloc field was added.

Removed non-documented macro PyObject_REPR which leaked references. Use format character %R in PyUnicode_FromFormat()-like functions to format the repr() of the object. (Contributed by Serhiy Storchaka in bpo-22453 [https://bugs.python.org/issue?@action=redirect&bpo=22453].)

由于缺少 __module__ 属性会破坏封存和内省特性，现在对于没有 __module__ 属性的内置类型会引发弃用警告。 这在将来会改为 AttributeError。 （由 Serhiy Storchaka 在 bpo-20204 [https://bugs.python.org/issue?@action=redirect&bpo=20204] 中贡献。）

As part of the PEP 492 [https://www.python.org/dev/peps/pep-0492] implementation, the tp_reserved slot of PyTypeObject was replaced with a tp_as_async slot. Refer to 协程对象 for new types, structures and functions.

Python 3.5.4 的显著变化

新增 make regen-all 构建目标

为了简化交叉编译，并确保 CPython 能够可靠地编译而不需要已存在可用的 Python 版本，基于 autotools 的构建系统将不再尝试根据文件修改时间隐式地重新编译已生成的文件。

取而代之的是，新增了一个 make regen-all 命令以便在需要时强制重新生成这些文件（例如在基于预生成版本构建了 Python 的初始版本之后）。

还定义了其他一些更具选择性的重生成目标 —— 详情参见 Makefile.pre.in [https://github.com/python/cpython/tree/3.10/Makefile.pre.in]。

（由 Victor Stinner 在 bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404] 中贡献。）

3.5.4 新版功能.

移除了 make touch 构建目标

之前用于通过更新生成文件的修改时间来请求隐式的重新生成这些文件的 make touch 构建目标已被移除。

它已被新的 make regen-all 目标所替代。

（由 Victor Stinner 在 bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404] 中贡献。）

在 3.5.4 版更改.

Python 3.4 有什么新变化

作者

R. David Murray <rdmurray@bitdance.com> (Editor)

这篇文章介绍了 Python 3.4 相比 3.3 增加的新特性。 Python 3.4 发布于 2014 年 3 月 16 日。 对于完整的细节，请参见 更新日志 [https://docs.python.org/3.4/whatsnew/changelog.html]。

参见

PEP 429 [https://www.python.org/dev/peps/pep-0429] -- Python 3.4 发布计划

摘要 - 发布重点

新的语法特性：

Python 3.4 中没有增加新的语法特性。

其他的新特性

pip 能够随时可用 (PEP 453 [https://www.python.org/dev/peps/pep-0453]).

新创建的文件描述符是不可继承的 (PEP 446 [https://www.python.org/dev/peps/pep-0446])。

对应 隔离模式 的命令行选项 (bpo-16499 [https://bugs.python.org/issue?@action=redirect&bpo=16499])。

针对非文本编码格式的 编解码器处理方式的改进 (多个相关问题)。

针对导入系统的 ModuleSpec 类型 (PEP 451 [https://www.python.org/dev/peps/pep-0451])。 （将影响导入器的作者。）

marshal 格式已被改进为 更为紧凑与高效 (bpo-16475 [https://bugs.python.org/issue?@action=redirect&bpo=16475])。

新的库模块：

asyncio: 针对异步 IO 的新版暂定 API (PEP 3156 [https://www.python.org/dev/peps/pep-3156])。

ensurepip: 引导设置 pip 安装器 (PEP 453 [https://www.python.org/dev/peps/pep-0453])。

enum: 对枚举类型的支持 (PEP 435 [https://www.python.org/dev/peps/pep-0435])。

pathlib: 面向对象的文件系统路径 (PEP 428 [https://www.python.org/dev/peps/pep-0428])。

selectors: 高层级且高效率的 I/O 复用，在 select 模块的基础之上建立（为 PEP 3156 [https://www.python.org/dev/peps/pep-3156] 的组成部分）。

statistics: 基础 数字领域稳定统计库 (PEP 450 [https://www.python.org/dev/peps/pep-0450])。

tracemalloc: 追踪 Python 内存分配 (PEP 454 [https://www.python.org/dev/peps/pep-0454])。

显著改进的库模块:

functools 中的 单一调度泛型函数 (PEP 443 [https://www.python.org/dev/peps/pep-0443])。

新的 pickle 协议 4 (PEP 3154 [https://www.python.org/dev/peps/pep-3154])。

multiprocessing 现在包含 一个避免在 Unix 上使用 os.fork 的选项 (bpo-8713 [https://bugs.python.org/issue?@action=redirect&bpo=8713])。

email 增加新的子模块 contentmanager 和新的子类型 Message (EmailMessage) 用以 简化 MIME 处理 (bpo-18891 [https://bugs.python.org/issue?@action=redirect&bpo=18891])。

inspect 和 pydoc 模块现在能够自省更多种类的可调用对象，这改进了 Python help() 系统的输出。

ipaddress 模块 API 已被声明为稳定状态

安全改进：

安全且可互换的哈希算法 (PEP 456 [https://www.python.org/dev/peps/pep-0456])。

将新创建的文件描述符设为不可继承 (PEP 446 [https://www.python.org/dev/peps/pep-0446]) 以避免将文件描述符泄露给子进程。

新增对应 隔离模式 的命令行选项。 (bpo-16499 [https://bugs.python.org/issue?@action=redirect&bpo=16499])。

现在 multiprocessing 具有 一个在 Unix 上避免使用 os.fork 的选项。 spawn 和 forkserver 更为安全因为它们会避免与子进程共享数据。

在 Windows 上 multiprocessing 子进程将不再继承父进程的所有可继承句柄，而仅继承必需的几个。

新增的 hashlib.pbkdf2_hmac() 函数可提供 PKCS#5 基于口令的密钥派生函数 2 [https://en.wikipedia.org/wiki/PBKDF2]。

在 ssl 中对于 TLSv1.1 和 TLSv1.2 的支持。

在 ssl 中对于 从 Windows 系统证书库获取证书的支持。

在 ssl 中对于 服务端 SNI (Server Name Indication) 的支持。

ssl.SSLContext 类具有 大量改进。

标准库中所有支持 SSL 的模块现在都支持服务器证书验证，包括主机名匹配 (ssl.match_hostname()) 和 CRL (Certificate Revocation Lists，参见 ssl.SSLContext.load_verify_locations())。

CPython 实现的改进：

安全的对象最终化 (PEP 442 [https://www.python.org/dev/peps/pep-0442])。

通过应用 PEP 442 [https://www.python.org/dev/peps/pep-0442]，在大多数情况下 模块的 globals 在最终化期间将不再被设为 None (bpo-18214 [https://bugs.python.org/issue?@action=redirect&bpo=18214])。

可配置的内存分配器 (PEP 445 [https://www.python.org/dev/peps/pep-0445])。

Argument Clinic (PEP 436 [https://www.python.org/dev/peps/pep-0436])。

请继续阅读有关针对用户的改变的完整清单，包括许多其他较小的改进、CPython 优化、弃用以及潜在的移植问题。

新的特性

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

默认对 pip 进行初始设置

新增的 ensurepip 模块（在 PEP 453 [https://www.python.org/dev/peps/pep-0453] 中定义）提供了一个在 Python 安装版和虚拟环境中初始设置 pip 安装器的标准跨平台机制。 包括在 Python 3.4.0 中的 pip 版本是 pip 1.5.4，未来的 3.4.x 维护发布版会将附带版本升级为创建候选发布版时的 pip 最新版本。

在默认情况下，将在所有平台上安装 pipX 和 pipX.Y 等命令（其中 X.Y 表示 Python 安装包的版本），并包括 pip Python 包及其依赖。 在 Windows 中以及所有平台的虚拟环境中，还将安装不带版本号的 pip 命令。 在其他平台中，系统层级上不带版本号的 pip 命令通常是指向单独安装的 Python 2 版本。

pyvenv 命令行工具和 venv 模块可利用 ensurepip 模块在虚拟环境中准备好 pip。 当使用命令行工具时，会默认安装 pip，而当使用 venv 模块的 API 安装版时必须显式地安装 pip。

对于 CPython 在 POSIX 系统上的源代码编译版，make install 和 make altinstall 命令默认会初始设置 pip。 此行为可通过配置选项来控制，并通过 Makefile 选项来重写。

在 Windows 和 Mac OS X 上，现在 CPython 安装程序默认会将 pip 与 CPython 本身一同安装（用户可以在安装过程中选择不安装它）。 Window 用户需要选择执行 PATH 修改以使 pip 在命令行中默认可用，在其他情况下它仍然可以通过 Windows 版 Python 启动器以 py -m pip 的方式使用。

正如 在 PEP 中已讨论的 [https://www.python.org/dev/peps/pep-0453/#recommendations-for-downstream-distributors]，平台打包者可以选择默认不安装这些命令，只需要在它们被发起调用时，能够提供有关如何在该平台上安装它们的简单清晰的指引（通常是使用系统包管理器）。

注解

为了避免同时存在的 Python 2 和 Python 3 安装版之前的冲突，当 ensurepip 被直接唤起时默认只会初始设置带版本号的 pip3 和 pip3.4 命令 —— 需要添加 --default-pip 选项来请求设置不带版本号的 pip 命令。 pyvenv 和 Windows 安装程序会确保未限定版本的 pip 命令在环境中可用，并且 pip 始终可以通过 -m 选项开关而不是直接唤起以避免在具有多个 Python 安装版的系统中造成歧义。

文档更改

作为此项更改的一部分，文档的 安装 Python 模块 和 分发 Python 模块 章节已经完全重新设计，快速入门和 FAQ 文档也是如此。 大部分打包指南文档现在都已被移至由 Python Packaging Authority 维护的 Python Packaging User Guide [https://packaging.python.org] 以及相应的独立项目文档。

However, as this migration is currently still incomplete, the legacy versions of those guides remaining available as 安装Python模块（旧版） and 分发 Python 模块（遗留版本）.

参见

PEP 453 [https://www.python.org/dev/peps/pep-0453] -- Python 安装版中对 pip 的显式初始设置

PEP 由Donald Stufft 和 Nick Coghlan 撰写，由 Donald Stufft，Nick Coghlan，Martin von Löwis 和 Ned Deily 实现。

PEP 446: 新创建的文件描述符将设为不可继承

PEP 446 [https://www.python.org/dev/peps/pep-0446] 将新创建的文件描述符设为 不可继承的。 通常，这就是应用程序所需要的行为：当启动一个新进程时，让当前打开的文件也在新进程里打开可能导致各种难以查找的程序错误以及潜在的安全问题。

不过，也存在一些需要继承行为的情况。 为了支持这些情况，可以使用以下的新增函数和方法：

os.get_inheritable(), os.set_inheritable()

os.get_handle_inheritable(), os.set_handle_inheritable()

socket.socket.get_inheritable(), socket.socket.set_inheritable()

参见

PEP 446 [https://www.python.org/dev/peps/pep-0446] -- 将新创建的文件描述符设为不可继承

PEP 由 Victor Stinner 撰写并实现。

编解码器处理方式的改进

自首次被引入以来，codecs 模块始终是作为一个类型中立的动态编码和解码系统来运作的。 然而，它与 Python 文本模型，尤其是内置 str、bytes 和 bytearray 类型上的限定类型的便捷方法的紧密耦合，在历史上掩盖了这一事实。

作为明晰情况的关键一步，现在 codecs.encode() 和 codecs.decode() 便捷函数在 Python 2.7、3.3 和 3.4 中都正确地写入了文档。 自 Python 2.4 以来这些函数即已存在于 codecs 模块中（并已被回归测试套件所覆盖），但在此前只能通过运行时自省才能发现。

不同于 str, bytes 和 bytearray 上的便捷方法，codecs 的便捷函数同时支持 Python 2 和 Python 3 中的任意编解码器，而非仅限于 Unicode 文本编码格式（在 Python 3 中) 或 basestring <-> basestring 转换（在 Python 2 中）。

在 Python 3.4 中，解释器能够识别标准库中提供的已知非文本编码格式并会在适当的时候引导用户找到这些通用型便捷函数:

>>> 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

在相关的改变中，只要在不破坏向下兼容性 的情况下是可行的，则在编码和解码操作期间引发的异常都会被包装在一个特定类型的链式异常中，该类型的名称与产生错误的相应编解码器一致:

>>> 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)

最后，正如上面的例子所示，这些改进允许恢复非 Unicode 编解码器的便捷别名，这些别名在 Python 3.2 中已被恢复。 这意味着（举例来说）二进制数据到其十六进制表示形式的编码转换现在可以写成:

>>> from codecs import encode, decode
>>> encode(b"hello", "hex")
b'68656c6c6f'
>>> decode(b"68656c6c6f", "hex")
b'hello'

在标准库中提供的二进制和文本转换操作详见 二进制转换 和 文字转换。

（由 Nick Coghlan 在 bpo-7475 [https://bugs.python.org/issue?@action=redirect&bpo=7475], bpo-17827 [https://bugs.python.org/issue?@action=redirect&bpo=17827], bpo-17828 [https://bugs.python.org/issue?@action=redirect&bpo=17828] 和 bpo-19619 [https://bugs.python.org/issue?@action=redirect&bpo=19619] 中贡献。）

PEP 451: 针对导入系统的 ModuleSpec 类型

PEP 451 [https://www.python.org/dev/peps/pep-0451] 提供了对模块相关信息的封装，导入机制将使用这些信息来加载它（即模块规范说明）。 这有助于简化导入的实现和几个导入相关的 API。 这一改动也是 某些未来导入相关改进 [https://mail.python.org/pipermail/python-dev/2013-November/130111.html] 的基石。

PEP 中面向公众的修改是完全向下兼容的。 并且，它们应当对除导入器开发者之外的其他所有人都可见。 主要查找器和加载器方法已被弃用，但它们将继续工作。 新的导入器应当使用 PEP 中描述的新方法。 现有的导入器应当被更新以实现这些新方法。 请参阅 弃用 一节获取应当被替代的方法及其替代物的列表。

其他语言特性修改

对Python 语言核心进行的小改动：

Unicode 数据库更新至 UCD 版本 6.3。

现在 min() 和 max() 均接受一个 default 仅限关键字参数可被用来指定当它们要求值的可迭代对象中没有任何元素时要返回的值。 （由 Julian Berman 在 bpo-18111 [https://bugs.python.org/issue?@action=redirect&bpo=18111] 中贡献。）

Module objects are now weakref'able.

模块的 __file__ 属性（以及相关的值）现在应当总是默认包含绝对路径，唯一的例外是当使用相对路径直接执行一个脚本时的 __main__.__file__。 （由 Brett Cannon 在 bpo-18416 [https://bugs.python.org/issue?@action=redirect&bpo=18416] 中贡献。）

现在所有 UTF-* 编解码器（UTF-7 除外）在编码和解码期间都将拒绝替代符除非使用 surrogatepass 错误处理器，例外情况有 UTF-16 解码器（接受有效的替代符对）和 UTF-16 编码器（在编码非 BMP 字符时会产生替代符）。 （由 Victor Stinner, Kang-Hao (Kenny) Lu 和 Serhiy Storchaka 在 bpo-12892 [https://bugs.python.org/issue?@action=redirect&bpo=12892] 中贡献。）

新增 German EBCDIC 编解码器 cp273。 （由 Michael Bierenfeld 和 Andrew Kuchling 在 bpo-1097797 [https://bugs.python.org/issue?@action=redirect&bpo=1097797] 中贡献。）

新增 Ukrainian 编解码器 cp1125。 （由 Serhiy Storchaka 在 bpo-19668 [https://bugs.python.org/issue?@action=redirect&bpo=19668] 中贡献。）

现在 bytes.join() 和 bytearray.join() 接受任意缓冲区对象作为参数。 （由 Antoine Pitrou 在 bpo-15958 [https://bugs.python.org/issue?@action=redirect&bpo=15958] 中贡献。）

现在 int 构造器接受任何具有 __index__ 方法的对象作为其 base 参数。 （由 Mark Dickinson 在 bpo-16772 [https://bugs.python.org/issue?@action=redirect&bpo=16772] 中贡献。）

帧对象现在具有 clear() 方法用来从帧中清除所有对局部变量的引用。 （由 Antoine Pitrou 在 bpo-17934 [https://bugs.python.org/issue?@action=redirect&bpo=17934] 中贡献。）

现在 memoryview 被注册为 序列，并支持 reversed() 内置函数。 （由 Nick Coghlan 和 Claudiu Popa 在 bpo-18690 [https://bugs.python.org/issue?@action=redirect&bpo=18690] 和 bpo-19078 [https://bugs.python.org/issue?@action=redirect&bpo=19078] 中贡献。）

作为对引入 Argument Clinic 以及对 inspect 和 pydoc 模块的其他修改的结果，在各种场合下由 help() 所报告的签名信息已获得修改和提升。

现在 __length_hint__() 已成为正式语言规范的一部分 (参见 PEP 424 [https://www.python.org/dev/peps/pep-0424])。 （由 Armin Ronacher 在 bpo-16148 [https://bugs.python.org/issue?@action=redirect&bpo=16148] 中贡献。）

新增模块

asyncio

新增的 asyncio 模块（在 PEP 3156 [https://www.python.org/dev/peps/pep-3156] 中定义）为 Python 提供了一个标准的可插入事件循环模型，在标准库中提供了坚实的异步 IO 支持，并使得其他事件循环的实现与标准库和其他库的相互操作更为容易。

对于 Python 3.4，此模块被视为属于 provisional API。

参见

PEP 3156 [https://www.python.org/dev/peps/pep-3156] -- 异步 IO 支持的重启: "asyncio" 模块

PEP 由 Guido van Rossum 领导编写和实现。

ensurepip

新增的 ensurepip 模块是用于 PEP 453 [https://www.python.org/dev/peps/pep-0453] 实现的主要基础设施。 在正常情况下最终用户不需要与此模块进行交互，但如果对安装版或虚拟环境的自动初始设置遭到拒绝则可使用它来手动初始设置 pip。

ensurepip 包括了一个捆绑的 pip 副本，其版本更新时间即 CPython 发布包的第一个候选发布版的发布时间（此规则同样适用于维护发布版和新特性发布版）。 ensurepip 不会访问因特网。 如果安装版可以访问因特网，则在运行 ensurepip 之后可以使用所捆绑的 pip 来将 pip 升级为比所捆绑版本更高的版本。 （请注意这样得到的 pip 升级版本将被视为一个单独安装的软件包并且在 Python 被卸载时将不会被移除。）

该模块被命名为 ensurepip 是因为如果在已安装 pip 的情况下被调用，它将不做任何操作。 它还有一个 --upgrade 选项可以在当前已安装的 pip 版本比所捆绑的副本更旧的情况下安装所捆绑的 pip 副本。

enum

新增的 enum 模块（在 PEP 435 [https://www.python.org/dev/peps/pep-0435] 中定义）提供了枚举类型的标准实现，允许其他模块（如 socket 等）通过将含义不清晰的整数常量替换为可向下兼容的枚举值来提供更具信息量的错误消息和更好的调试支持。

参见

PEP 435 [https://www.python.org/dev/peps/pep-0435] -- 为 Python 标准库增加了 Enum 类型

PEP 由 Barry Warsaw，Eli Bendersky 和 Ethan Furman 撰写 ，由 Ethan Furman 实现。

pathlib

新增的 pathlib 模块提供了代表文件系统路径的类，其语义适用于不同的操作系统。 路径类被划分为提供不带 I/O 的纯计算操作的 纯路径，以及继承自纯路径但提供 I/O 操作的 实体路径。

对于 Python 3.4，此模块被视为属于 provisional API。

参见

PEP 428 [https://www.python.org/dev/peps/pep-0428] -- pathlib 模块 -- 面向对象的文件系统路径

PEP 由 Antoine Pitrou 撰写并实现

selectors

新增的 selectors 模块（作为 PEP 3156 [https://www.python.org/dev/peps/pep-3156] 实现的一部分被创建）允许高层级且高效的 I/O 多路复用，它是在 select 模块的基础上构建的。

statistics

新增的 statistics 模块（在 PEP 450 [https://www.python.org/dev/peps/pep-0450] 中定义）直接在标准库中提供了一些核心统计功能。 该模块支持计算数据系列的平均值、中位数、模式、方差和标准差等。

参见

PEP 450 [https://www.python.org/dev/peps/pep-0450] -- 为标准库增加 statistics 模块

PEP 由 Steven D'Aprano 撰写并实现。

tracemalloc

新增的 tracemalloc 模块（在 PEP 454 [https://www.python.org/dev/peps/pep-0454] 中定义）是用于追踪由 Python 所分配的内存块的调试工具。 它提供了以下信息：

追踪对象被分配所在的位置

按文件、按行统计python的内存块分配情况: 总大小、块的数量以及块平均大小。

对比两个内存快照的差异，以便排查内存泄漏

参见

PEP 454 [https://www.python.org/dev/peps/pep-0454] -- 新增 tracemalloc 模块用于追踪 Python 内存分配

PEP 由 Victor Stinner 撰写并实现

改进的模块

abc

新增的函数 abc.get_cache_token() 可被用来获知何时使得受到对象图改变影响的缓存失效。 （由 Łukasz Langa 在 bpo-16832 [https://bugs.python.org/issue?@action=redirect&bpo=16832] 中贡献。）

新增的类型 ABC 以 ABCMeta 作为其元类。 使用 ABC 作为基类的效果实际上相当于指定 metaclass=abc.ABCMeta，但其写法更简单也更易读。 （由 Bruno Dupuis 在 bpo-16049 [https://bugs.python.org/issue?@action=redirect&bpo=16049] 中贡献。）

aifc

现在 getparams() 将返回一个具名元组而不是普通元组。 （由 Claudiu Popa 在 bpo-17818 [https://bugs.python.org/issue?@action=redirect&bpo=17818] 中贡献。）

现在 aifc.open() 已支持上下文管理协议：当在 with 代码块中使用时，所返回对象的 close() 方法将在代码块结束时被自动调用。 （由 Serhiy Storchacha 在 bpo-16486 [https://bugs.python.org/issue?@action=redirect&bpo=16486] 中贡献。）

现在 writeframesraw() 和 writeframes() 方法将接受任意 bytes-like object。 （由 Serhiy Storchaka 在 bpo-8311 [https://bugs.python.org/issue?@action=redirect&bpo=8311] 中贡献。）

argparse

现在 FileType 类可接受 encoding 和 errors 参数，它们将被传递给 open()。 （由 Lucas Maystre 在 bpo-11175 [https://bugs.python.org/issue?@action=redirect&bpo=11175] 中贡献。）

audioop

现在 audioop 可支持 24 位采样。 （由 Serhiy Storchaka 在 bpo-12866 [https://bugs.python.org/issue?@action=redirect&bpo=12866] 中贡献。）

新增的 byteswap() 函数可将大端序样本转换为小端序，并可反向转换。 （由 Serhiy Storchaka 在 bpo-19641 [https://bugs.python.org/issue?@action=redirect&bpo=19641] 中贡献。）

所有 audioop 函数现在均接受任意 bytes-like object。 字符串将不被接受：它们在之前也不可用，现在它们将立即引发错误。 （由 Serhiy Storchaka 在 bpo-16685 [https://bugs.python.org/issue?@action=redirect&bpo=16685] 中贡献。）

base64

现在 base64 中的编码和解码函数在之前需要 bytes 或 bytearray 实例的场合下均接受任意 bytes-like object。 （由 Nick Coghlan 在 bpo-17839 [https://bugs.python.org/issue?@action=redirect&bpo=17839] 中贡献。）

新增的函数 a85encode(), a85decode(), b85encode() 以及 b85decode() 分别提供针对 Ascii85 以及 git/mercurial Base85 格式的二进制数据进行编码和解码的能力。 a85 函数具有可被用于使其与 Ascii85 编码格式的变种，包括 Adobe 变种相互兼容的选项。 （由 Martin Morrison, Mercurial 项目, Serhiy Storchaka 和 Antoine Pitrou 在 bpo-17618 [https://bugs.python.org/issue?@action=redirect&bpo=17618] 中贡献。）

collections

现在 ChainMap.new_child() 方法接受一个 m 参数用于指定要向链结构中添加的子映射表。 这允许将现有的映射和/或自定义映射类型用于子映射表。 （由 Vinay Sajip 在 bpo-16613 [https://bugs.python.org/issue?@action=redirect&bpo=16613] 中贡献。）

colorsys

用于 RGB --- YIQ 转换系数的数码位数已被扩展以使其与 FCC NTSC 版本匹配。 结果中的变化应当少于 1% 并可与在其他地方找到的结果更好地匹配。 （由 Brian Landers 和 Serhiy Storchaka 在 bpo-14323 [https://bugs.python.org/issue?@action=redirect&bpo=14323] 中贡献。）

contextlib

新增的 contextlib.suppress 上下文管理器可以帮助澄清故意抑制来自单条语句的异常的代码的意图。 （由 Raymond Hettinger 在 bpo-15806 [https://bugs.python.org/issue?@action=redirect&bpo=15806] 和 Zero Piraeus 在 bpo-19266 [https://bugs.python.org/issue?@action=redirect&bpo=19266] 中贡献。）

新增的 contextlib.redirect_stdout() 上下文管理器使得工具脚本能更容易地处理将输出写入 sys.stdout 并且不提供任何重定向选项的不灵活 API。 使用该上下文管理器，可以将 sys.stdout 的输出重定向到任何其他流，或者配合使用 io.StringIO 来重定向到字符串。 后一种方式有时会特别有用，例如写入函数的输出来实现 命令行接口。 由于它会影响 sys.stdout 的全局状态因此只推荐用于工具脚本。 （由 Raymond Hettinger 在 bpo-15805 [https://bugs.python.org/issue?@action=redirect&bpo=15805] 中贡献。）

contextlib 文档也已获得更新以包括有关仅单用、可重用与可重入上下文管理器之间的区别的 讨论。

dbm

现在 dbm.open() 对象已支持上下文管理器协议。 当在 with 语句中使用时，数据库对象的 close 方法将在代码块结束时被自动调用。 （由 Claudiu Popa 和 Nick Coghlan 在 bpo-19282 [https://bugs.python.org/issue?@action=redirect&bpo=19282] 中贡献。）

dis

现在 show_code(), dis(), distb() 和 disassemble() 等函数可接受仅限关键字参数 file 来控制其输出的写入目标。

现在 dis 模块是围绕 Instruction 类来构建的，该类以面向对象的访问方式提供对于每个单独字节码操作的细节。

新增的方法 get_instructions() 提供了一个为给定 Python 代码段产生 Instruction 流的迭代器。 这使得现在可以编写以不同于由 dis 模块本身所提供的方式检查和操纵字节码对象的程序。 例如:

>>> import dis
>>> for instr in dis.get_instructions(lambda x: x + 1):
...     print(instr.opname)
LOAD_FAST
LOAD_CONST
BINARY_ADD
RETURN_VALUE

dis 模块中的各种显示工具已被重新编写以使用这些新组件。

此外，新增的对应用程序友好的类 Bytecode 提供了一个面向对象的 API 用于以人类可读的形式检查字节码并对指令进行迭代。 Bytecode 构造器接受与 get_instruction() 相同的参数（外加一个可选的 current_offset 参数），其结果对象可被迭代以产生 Instruction 对象。 但它还有一个 dis 方法，相当于在构造器参数上调用 dis，但是返回一个多行字符串:

>>> 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']

Bytecode 还有一个类方法 from_traceback()，它提供了操纵回溯对象的能力（也就是说，print(Bytecode.from_traceback(tb).dis()) 等价于 distb(tb)。）

（由 Nick Coghlan, Ryan Kelly 和 Thomas Kluyver 在 bpo-11816 [https://bugs.python.org/issue?@action=redirect&bpo=11816] 并由 Claudiu Popa 在 bpo-17916 [https://bugs.python.org/issue?@action=redirect&bpo=17916] 中贡献。）

新增的函数 stack_effect() 可在给定操作码和参数的 Python 栈上计算其效果，相关信息是无法以其他方式获得的。 （由 Larry Hastings 在 bpo-19722 [https://bugs.python.org/issue?@action=redirect&bpo=19722] 中贡献。）

doctest

A new option flag, FAIL_FAST, halts test running as soon as the first failure is detected. (Contributed by R. David Murray and Daniel Urban in bpo-16522 [https://bugs.python.org/issue?@action=redirect&bpo=16522].)

现在 doctest 的命令行接口使用 argparse，并新增了两个选项 -o 和 -f。 -o 允许在命令行中指定 doctest 选项，而 -f 是 -o FAIL_FAST 的简写形式（与 unittest CLI 所支持的类似选项相对应）。 （由 R. David Murray 在 bpo-11390 [https://bugs.python.org/issue?@action=redirect&bpo=11390] 中贡献。）

现在 doctest 会在扩展模块的 __doc__ 字符串中查找文档测试。 （由 Zachary Ware 在 bpo-3158 [https://bugs.python.org/issue?@action=redirect&bpo=3158] 中贡献。）

email

现在 as_string() 接受一个 policy 参数用于在生成其字符串表示形式时重写默认的消息策略。 这意味着 as_string 现在可以在更多情况下被使用，而不必创建和使用 generator 来将已格式化的形参传递给其 flatten 方法。 （由 R. David Murray 在 bpo-18600 [https://bugs.python.org/issue?@action=redirect&bpo=18600] 中贡献。）

新增方法 as_bytes() 用于产生消息的与 as_string 所产生的字符串表示形式类似的字节串表示形式。 它不接受 maxheaderlen 参数，但接受 unixfrom 和 policy 参数。 Message 的 __bytes__() 方法将调用它，这意味着现在 bytes(mymsg) 将产生直观的结果：一个包含完整已格式化消息的字节串对象。 （由 R. David Murray 在 bpo-18600 [https://bugs.python.org/issue?@action=redirect&bpo=18600] 中贡献。）

现在 Message.set_param() 消息接受一个 replace 关键字参数。 当指定该参数时，关联的标头将被更新而不会修改其在标头列表中的位置。 为了保持向下兼容，该参数默认值为 False。 （由 R. David Murray 在 bpo-18891 [https://bugs.python.org/issue?@action=redirect&bpo=18891] 中贡献。）

新增了一对 Message 的子类 (EmailMessage 和 MIMEPart)，以及新的子模块 contentmanager 和新的 policy 属性 content_manager。 所有文档目前都在新模块中，它是作为 email 的新 provisional API 的一部分添加的。 这些类提供了多个使从内容提取邮件消息和插入内容到消息更容易的新方法。 相关细节，请参阅 contentmanager 文档和 email: 示例。 这些 API 的加入完成了作为 email6 项目计划组成部分的大部分工作。 目前的暂定 API 计划在 Python 3.5 最终确定 (可能在错误处理方面再增加少量内容)。 （由 R. David Murray 在 bpo-18891 [https://bugs.python.org/issue?@action=redirect&bpo=18891] 中贡献。）

filecmp

新增的 clear_cache() 函数提供了清除 filecmp 比较缓存的功能，它使用 os.stat() 信息来确定文件自上次比较后是否发生了更改。 例如，如果文件被修改和重新检查的时间短于特定文件系统文件修改时间的精度就可使用这一功能。 （由 Mark Levitt 在 bpo-18149 [https://bugs.python.org/issue?@action=redirect&bpo=18149] 中贡献。）

New module attribute DEFAULT_IGNORES provides the list of directories that are used as the default value for the ignore parameter of the dircmp() function. (Contributed by Eli Bendersky in bpo-15442 [https://bugs.python.org/issue?@action=redirect&bpo=15442].)

functools

新增的 partialmethod() 描述器提供了对描述器的部分参数应用，就像 partial() 为普通可调用对象提供的一样。 新的描述器还可以让任意可调用对象 （包括 partial() 实例）在包括在类定义中时表现得像普通的实例方法一样。 （由 Alon Horev 和 Nick Coghlan 在 bpo-4331 [https://bugs.python.org/issue?@action=redirect&bpo=4331] 中贡献。）

新增的 singledispatch() 装饰器为 Python 标准库带来了对单分派泛型函数的支持。 面向对象编程侧重于将对一组共同数据的多种操作组合到一个类中，而泛型函数则侧重于将一种操作的多个实现组合在一起使其能够处理 不同 种类的数据。

参见

PEP 443 [https://www.python.org/dev/peps/pep-0443] -- 单分派泛型函数

PEP 由 Łukasz Langa 撰写并实现。

total_ordering() now supports a return value of NotImplemented from the underlying comparison function. (Contributed by Katie Miller in bpo-10042 [https://bugs.python.org/issue?@action=redirect&bpo=10042].)

现在标准库中增加了 partial() 函数的纯 Python 版本；在 CPython 中它会被 C 加速版本覆盖，但它以供其他实现来使用。 （由 Brian Thorne 在 bpo-12428 [https://bugs.python.org/issue?@action=redirect&bpo=12428] 中贡献。）

gc

新增的函数 get_stats() 可返回由三个单独生成字典组成的列表，每个字典均包含自解释器启动以来收集的统计信息。 （由 Antoine Pitrou 在 bpo-16351 [https://bugs.python.org/issue?@action=redirect&bpo=16351] 中贡献。）

glob

新增函数 escape() 提供了为文件名中的特殊字符进行转义的方式以使它们不会成为 glob 扩展的组成部分而是按字面值来匹配。 （由 Serhiy Storchaka 在 bpo-8402 [https://bugs.python.org/issue?@action=redirect&bpo=8402] 中贡献。）

hashlib

新增的 hashlib.pbkdf2_hmac() 函数提供了 PKCS#5 基于口令的密钥派生函数 2 [https://en.wikipedia.org/wiki/PBKDF2]。 （由 Christian Heimes 在 bpo-18582 [https://bugs.python.org/issue?@action=redirect&bpo=18582] 中贡献。）

现在 hashlib 哈希对象的 name 属性已成为受正式支持的接口。 它一直存在于 CPython 的 hashlib 中（尽管它没有返回所有受支持的哈希算法的小写名称），但它不是一个公开的接口因此其他一些 Python 实现以前并不支持它。 （由 Jason R. Coombs 在 bpo-18532 [https://bugs.python.org/issue?@action=redirect&bpo=18532] 中提供。）

hmac

现在 hmac 可接受 bytearray 和 bytes 作为传给 new() 函数的 key 参数，而传给 new() 函数和 update() 方法的 msg 形参现在可接受 hashlib 模块所支持的任何类型。 （由 Jonas Borgström 的 bpo-18240 [https://bugs.python.org/issue?@action=redirect&bpo=18240] 中贡献。）

传给 hmac.new() 函数的 digestmod 参数现在可以是 hashlib 能识别的任何哈希摘要名称。 此外，当前将 digestmod 默认值设为 MD5 的行为已被弃用：在未来的 Python 版本中将没有默认值。 （由 Christian Heimes 在 bpo-17276 [https://bugs.python.org/issue?@action=redirect&bpo=17276] 中贡献。）

由于增加了 block_size 和 name 属性 （以及 digest_size 属性的正式文档），hmac 模块现在已完全符合 PEP 247 [https://www.python.org/dev/peps/pep-0247] API。 （由 Christian Heimes 在 bpo-18775 [https://bugs.python.org/issue?@action=redirect&bpo=18775] 中贡献。）

html

新增的函数 unescape() 用于将 HTML5 字符引用转换为相应的 Unicode 字符。 （由 Ezio Melotti 在 bpo-2927 [https://bugs.python.org/issue?@action=redirect&bpo=2927] 中贡献。）.)

HTMLParser 接受新的关键字参数 convert_charrefs，当其为 True 时，会自动转换所有字符引用。 为了保持向下兼容，其值默认为 False，但在未来的 Python 版本中将改为 True，因此建议你显式地设置它并更新代码以使用这个新特性。 （由 Ezio Melotti 在 bpo-13633 [https://bugs.python.org/issue?@action=redirect&bpo=13633] 中贡献。）

现在 HTMLParser 的 strict 参数已被弃用。 （由 Ezio Melotti 在 bpo-15114 [https://bugs.python.org/issue?@action=redirect&bpo=15114] 中贡献。）

http

现在 send_error() 接受可选的附加形参 explain 用于提供扩展的错误描述，覆盖可能存在的硬编码的默认值。 这个扩展的描述将使用 error_message_format 进行格式化并作为错误响应体发送。 （由 Karl Cow 在 bpo-12921 [https://bugs.python.org/issue?@action=redirect&bpo=12921] 中贡献。）

现在 http.server 命令行界面 增加了一个 -b/--bind 选项用于让服务器在指定的地址上进行监听。 （由 Malte Swart 在 bpo-17764 [https://bugs.python.org/issue?@action=redirect&bpo=17764] 中贡献。）

idlelib 与 IDLE

由于 idlelib 实现了 IDLE 命令行界面和编辑器且不应被其他程序导入，它将随每个发布版获得改进。 请参阅 Lib/idlelib/NEWS.txt 查看 3.3.0 以来的累积变化列表，以及未来 3.4.x 发布版即将发生的变化。 此文件也可通过 IDLE Help ‣ About IDLE 对话框来查看。

importlib

InspectLoader ABC 定义了一个新方法 source_to_code()，它接受源数据和一个路径并返回一个代码对象。 其默认实现等价于 compile(data, path, 'exec', dont_inherit=True)。 （由 Eric Snow 和 Brett Cannon 在 bpo-15627 [https://bugs.python.org/issue?@action=redirect&bpo=15627] 中贡献。）

现在 InspectLoader 也具有 get_code() 方法的默认实现。 不过，出于性能原因通常需要重写默认实现。 （由 Brett Cannon 在 bpo-18072 [https://bugs.python.org/issue?@action=redirect&bpo=18072] 中贡献。）

The reload() function has been moved from imp to importlib as part of the imp module deprecation. (Contributed by Berker Peksag in bpo-18193 [https://bugs.python.org/issue?@action=redirect&bpo=18193].)

importlib.util now has a MAGIC_NUMBER attribute providing access to the bytecode version number. This replaces the get_magic() function in the deprecated imp module. (Contributed by Brett Cannon in bpo-18192 [https://bugs.python.org/issue?@action=redirect&bpo=18192].)

New importlib.util functions cache_from_source() and source_from_cache() replace the same-named functions in the deprecated imp module. (Contributed by Brett Cannon in bpo-18194 [https://bugs.python.org/issue?@action=redirect&bpo=18194].)

现在 importlib 将以符合 InspectLoader ABC 的方式初始设置 NamespaceLoader，这意味着 runpy `` 和``python -m 现在可以与命名空间包一起使用。 （由 Brett Cannon 在 bpo-18058 [https://bugs.python.org/issue?@action=redirect&bpo=18058] 中贡献。）

importlib.util 中新增的函数 decode_source() 可使用通用换行处理方式从字节数据中解码源代码。 这适用于实现 InspectLoader.get_source() 方法。

现在 importlib.machinery.ExtensionFileLoader 增加了 get_filename() 方法。 此方法在最初的实现中意外缺失。 （由 Eric Snow 在 bpo-19152 [https://bugs.python.org/issue?@action=redirect&bpo=19152] 中贡献。）

inspect

现在 inspect 模块提供了一个基本的 命令行界面 用于快速显示模块、类和函数的源代码以及其他信息。 （由 Claudiu Popa 和 Nick Coghlan 在 bpo-18626 [https://bugs.python.org/issue?@action=redirect&bpo=18626] 中贡献。）

unwrap() 用于方便地解开由 functools.wraps() (以及任何在包装器函数上设置 __wrapped__ 属性的 API) 创建的包装器函数链。 （由 Daniel Urban, Aaron Iles 和 Nick Coghlan 在 bpo-13266 [https://bugs.python.org/issue?@action=redirect&bpo=13266] 中贡献。）

作为新的 enum 模块实现的一部分，现在 inspect 模块通过元类为自定义 __dir__ 方法和动态类属性提供了更好的支持。 （由 Ethan Furman 在 bpo-18929 [https://bugs.python.org/issue?@action=redirect&bpo=18929] 和 bpo-19030 [https://bugs.python.org/issue?@action=redirect&bpo=19030] 中贡献。）

现在 getfullargspec() 和 getargspec() 将使用 signature() API。 这允许它们支持更多种类的可调用对象，包括具有 __signature__ 属性的、具有通过 argument clinic 提供元数据的、functools.partial() 对象等等。 请注意，不同于 signature()，这些函数仍然会忽略 __wrapped__ 属性，并会报告绑定方法已绑定的第一个参数，所以如果想要这些特性的话你仍然需要更新你的代码以直接使用 signature()。 （由 Yury Selivanov 在 bpo-17481 [https://bugs.python.org/issue?@action=redirect&bpo=17481] 中贡献。）

现在 signature() 支持 CPython 函数的鸭子类型，它增加了对使用 Cython 编译的函数的支持。 （由 Stefan Behnel 和 Yury Selivanov 在 bpo-17159 [https://bugs.python.org/issue?@action=redirect&bpo=17159] 中贡献。）

ipaddress

ipaddress 已在 Python 3.3 中作为 provisional API 被添加到标准库。 随着 Python 3.4 的发布，此限定已被移除：现在 ipaddress 属于稳定 API，由常规的标准库需求所覆盖以维护向下兼容性。

如果一个地址是全局可路由的则新增的 is_global 属性将为 True。 （由 Peter Moody 在 bpo-17400 [https://bugs.python.org/issue?@action=redirect&bpo=17400] 中贡献。）

logging

TimedRotatingFileHandler 新增的 atTime 形参可被用于指定每日要执行日志文件轮转的时间。 （由 Ronald Oussoren 在 bpo-9556 [https://bugs.python.org/issue?@action=redirect&bpo=9556] 中贡献。）

现在 SocketHandler 和 DatagramHandler 已支持 Unix 域套接字 (通过将 port 设为 None)。 （由 Vinay Sajip 在 commit ce46195b56a9 中贡献。）

现在 fileConfig() 接受一个 configparser.RawConfigParser 子类实例作为 fname 形参。 这有助于在日志配置只是整体应用程序配置的一部分，或者在将配置传递给 fileConfig() 之前对其进行了修改时使用配置文件。 （由 Vinay Sajip 在 bpo-16110 [https://bugs.python.org/issue?@action=redirect&bpo=16110] 中贡献。）

现在通过 logging.config.listen() 函数从套接字接收的日志配置数据可以在处理前以将验证函数作为参数提供给新的 verify 关键字参数 的方式执行验证。 （由 Vinay Sajip 在 bpo-15452 [https://bugs.python.org/issue?@action=redirect&bpo=15452] 中贡献。）

marshal

默认的 marshal 版本已被提升至 3。 新版本的代码实现恢复了 Python2 行为即只记录内联字符串的一份副本并在反序列化时保留内联状态，并将此“一份副本”功能扩展到任何对象类型（包括处理递归引用）。 这既减少了 .pyc 文件的大小也减少了模块从 .pyc (或``.pyo``) 文件加载时占用的内存量。 （由 Kristján Valur Jónsson 在 bpo-16475 [https://bugs.python.org/issue?@action=redirect&bpo=16475] 中贡献，并由 Antoine Pitrou 在 bpo-19219 [https://bugs.python.org/issue?@action=redirect&bpo=19219] 中提供进一步的加速。）

mmap

mmap objects can now be weakrefed. (Contributed by Valerie Lambert in bpo-4885 [https://bugs.python.org/issue?@action=redirect&bpo=4885].)

multiprocessing

在 Unix 上新增了两个 启动方法 spawn 和 forkserver 可使用 multiprocessing 来启动进程。 这两个方法使得进程和线程的混合更为健壮，并且 spawn 方法可以匹配 multiprocessing 在 Windows 上一直使用的语法。 新增的函数 get_all_start_methods() 可报告平台上可用的所有启动方法，get_start_method() 可报告当前的启动方法，而 set_start_method() 可设置启动方法。 （由 Richard Oudkerk 在 bpo-8713 [https://bugs.python.org/issue?@action=redirect&bpo=8713] 中贡献。）

现在 multiprocessing 还具有 上下文 的概念，它决定了子进程的创建方式。 新增的函数 get_context() 可返回一个使用指定启动方法的上下文。 它具有与 multiprocessing 模块本身一致的 API，因此你可以使用它来创建 Pool 和其他在上下文中执行操作的对象。 这允许一个框架和某个应用程序或相同应用程序的不同部分使用多进程而不会彼此干扰。 （由 Richard Oudkerk 在 bpo-18999 [https://bugs.python.org/issue?@action=redirect&bpo=18999] 中贡献。）

除非是在使用旧的 fork 启动方法，子进程将不再从其父进程继承不需要的句柄/文件描述符 (bpo-8713 [https://bugs.python.org/issue?@action=redirect&bpo=8713] 的一部分)。

现在当使用 spawn 或 forkserver 启动方法时 multiprocessing 依赖于 runpy (它实现了 -m 开关) 在子进程中正确地初始化 __main__。 这解决了一些合并多进程操作中，-m 命令行开关和显式相对导入可能在子进程中导致失败的边缘场景问题。 （由 Nick Coghlan 在 bpo-19946 [https://bugs.python.org/issue?@action=redirect&bpo=19946] 中贡献。）

operator

新增的函数 length_hint() 提供了应当如何使用 __length_hint__() 特殊方法的规范实现，作为该语言特性的 PEP 424 [https://www.python.org/dev/peps/pep-0424] 正式规范说明的一部分。 （由 Armin Ronacher 在 bpo-16148 [https://bugs.python.org/issue?@action=redirect&bpo=16148] 中贡献。）

现在提供了一个纯 Python 版本的 operator 模块，可用于参考并由 Python 的其他实现使用。 （由 Zachary Ware 在 bpo-16694 [https://bugs.python.org/issue?@action=redirect&bpo=16694] 中贡献。）

os

新增一些函数用于获取和设置文件描述符或 Windows 句柄的 可继承旗标 (os.get_inheritable(), os.set_inheritable()) 或 (os.get_handle_inheritable(), os.set_handle_inheritable())。

新增函数 cpu_count() 可报告 Python 运行所在平台上可用 CPU 的数量 (如果无法确定数量则为 None)。 现在 multiprocessing.cpu_count() 函数是根据此函数实现的。 （由 Trent Nelson, Yogesh Chaudhari, Victor Stinner 和 Charles-François Natali 在 bpo-17914 [https://bugs.python.org/issue?@action=redirect&bpo=17914] 中贡献。）

现在 os.path.samestat() 将在 Windows 平台上可用（并且现在 os.path.samefile() 实现可在 Unix 和 Windows 间共享）。 （由 Brian Curtin 在 bpo-11939 [https://bugs.python.org/issue?@action=redirect&bpo=11939] 中贡献。）

现在 os.path.ismount() 可识别 Windows 中在驱动器根目录下加载的卷。 （由 Tim Golden 在 bpo-9035 [https://bugs.python.org/issue?@action=redirect&bpo=9035] 中贡献。）

os.open() supports two new flags on platforms that provide them, O_PATH (un-opened file descriptor), and O_TMPFILE (unnamed temporary file; as of 3.4.0 release available only on Linux systems with a kernel version of 3.11 or newer that have uapi headers). (Contributed by Christian Heimes in bpo-18673 [https://bugs.python.org/issue?@action=redirect&bpo=18673] and Benjamin Peterson, respectively.)

pdb

pdb 已被增强以通过更有用的方式来处理生成器, yield 和 yield from。 这在调试基于 asyncio 的程序时特别有帮助。 （由 Andrew Svetlov 和 Xavier de Gaye 在 bpo-16596 [https://bugs.python.org/issue?@action=redirect&bpo=16596] 中贡献。）

print 命令已从 pdb 中移除，恢复了从 pdb 命令行对 Python print() 函数的访问。 Python2 的 pdb 没有 print 命令；而是会在输入 print 时执行 print 语句。 在 Python3 中 print 被错误地设为 pdb p 命令的别名。 然而，p 会打印其参数的 repr，而不是像 Python2 print 命令那样打印其参数的 str。 更糟糕的是，Python3 pdb print 命令会覆盖 Python3 print 函数，导致其在 pdb 提示符下无法被访问。 （由 Connor Osborn 在 bpo-18764 [https://bugs.python.org/issue?@action=redirect&bpo=18764] 中贡献。）

pickle

现在 pickle 支持（但默认不使用）新的 pickle 协议即协议 4。 这个新协议解决了在之前版本中存在的多个问题，例如嵌套类、超长字符串和容器、以及 __new__() 方法接受仅限关键字参数的类的序列化。 它还提供了一些效率上的改进。

参见

PEP 3154 [https://www.python.org/dev/peps/pep-3154] -- pickle 协议 4

PEP 由 Antoine Pitrou 撰写，并由 Alexandre Vassalotti 实现

plistlib

plistlib now has an API that is similar to the standard pattern for stdlib serialization protocols, with new load(), dump(), loads(), and dumps() functions. (The older API is now deprecated.) In addition to the already supported XML plist format (FMT_XML), it also now supports the binary plist format (FMT_BINARY). (Contributed by Ronald Oussoren and others in bpo-14455 [https://bugs.python.org/issue?@action=redirect&bpo=14455].)

poplib

在 poplib 中新增了两个方法: capa()，它将返回 POP 服务器公开的功能列表，以及 stls()，它将在 POP 支持的情况下将明文 POP3 会话切换为加密 POP3 会话。 （由 Lorenzo Catucci 在 bpo-4473 [https://bugs.python.org/issue?@action=redirect&bpo=4473] 中贡献。）

pprint

pprint 模块的 PrettyPrinter 类以及 pformat() 和 pprint() 函数新增了一个选项 compact，它可控制输出所使用的格式。 目前将 compact 设为 True 表示打印序列时将在每个（缩进的）行中放入 width 所允许的尽可能多的元素。 （由 Serhiy Storchaka 在 bpo-19132 [https://bugs.python.org/issue?@action=redirect&bpo=19132] 中贡献。）

长字符串现在将使用 Python 的常规续行语法进行包装。 （由 Antoine Pitrou 在 bpo-17150 [https://bugs.python.org/issue?@action=redirect&bpo=17150] 中贡献。）

pty

现在 pty.spawn() 将返回来自子进程上 os.waitpid() 的状态值，而不是 None。 （由 Gregory P. Smith 贡献。）

pydoc

现在 pydoc 模块是直接基于 inspect.signature() 内省 API，这允许它提供更多可调用对象的签名信息。 这一改变也意味着现在当显示帮助信息时 __wrapped__ 属性也会被纳入考虑。 （由 Larry Hastings 在 bpo-19674 [https://bugs.python.org/issue?@action=redirect&bpo=19674] 中贡献。）

pydoc 模块将不再显示已绑定方法的 self 形参。 现在，它总是会显示所提供可调用对象实际的当前签名。 （由 Larry Hastings 在 bpo-20710 [https://bugs.python.org/issue?@action=redirect&bpo=20710] 中贡献。）

除了 pydoc 已有的直接修改，它对自定义 __dir__ 方法和各种描述器行为的处理也通过对下层 inspect 模块的修改获得了显著的改进。

由于 help() 内置函数是基于 pydoc 的，上述的变化也会影响 help() 的行为。

re

新增的 fullmatch() 函数和 regex.fullmatch() 方法可将模式锚定到要匹配的字符串的两端。 这提供了一种明确匹配目标的方式，从而避免了一类微妙的错误错误，即在代码更改或为现有正则表达式添加替代项时丢失 $ 字符。 （由 Matthew Barnett 在 bpo-16203 [https://bugs.python.org/issue?@action=redirect&bpo=16203] 中贡献。）

正则表达式对象 的 repr 现在将包括模式和旗标；匹配对象 的 repr 现在将包括已匹配字符串的开头、末尾和组成。 （由 Hugo Lopes Tavares 和 Serhiy Storchaka 在 bpo-13592 [https://bugs.python.org/issue?@action=redirect&bpo=13592] 和 bpo-17087 [https://bugs.python.org/issue?@action=redirect&bpo=17087] 中贡献。）

resource

新增的 prlimit() 函数，在内核版本 2.6.36 以上的 Linux 平台及 glibc 版本 2.13 以上可用，提供了查询或设置执行调用的进程以外的进程的资源限制的功能。 （由 Christian Heimes 在 bpo-16595 [https://bugs.python.org/issue?@action=redirect&bpo=16595] 中贡献。）

On Linux kernel version 2.6.36 or later, there are also some new Linux specific constants: RLIMIT_MSGQUEUE, RLIMIT_NICE, RLIMIT_RTPRIO, RLIMIT_RTTIME, and RLIMIT_SIGPENDING. (Contributed by Christian Heimes in bpo-19324 [https://bugs.python.org/issue?@action=redirect&bpo=19324].)

On FreeBSD version 9 and later, there some new FreeBSD specific constants: RLIMIT_SBSIZE, RLIMIT_SWAP, and RLIMIT_NPTS. (Contributed by Claudiu Popa in bpo-19343 [https://bugs.python.org/issue?@action=redirect&bpo=19343].)

select

现在 epoll 对象可支持上下文管理协议。 当在 with 语句中使用时，close() 方法将在代码块结束时被自动调用。 （由 Serhiy Storchaka 在 bpo-16488 [https://bugs.python.org/issue?@action=redirect&bpo=16488] 中贡献。）

现在 devpoll 对象具有 fileno() 和 close() 方法，以及新的属性 closed。 （由 Victor Stinner 在 bpo-18794 [https://bugs.python.org/issue?@action=redirect&bpo=18794] 中贡献。）

shelve

现在 Shelf 实例可以在 with 语句中使用，并将在 with 代码块结束时自动关闭。 （由 Filip Gruszczyński 在 bpo-13896 [https://bugs.python.org/issue?@action=redirect&bpo=13896] 中贡献。）

shutil

现在当源和目标为相同文件时 copyfile() 会引发专门的 Error 子类 SameFileError，这允许应用程序针对这个特定错误采取适当的动作。 （由 Atsuo Ishimoto 和 Hynek Schlawack 在 bpo-1492704 [https://bugs.python.org/issue?@action=redirect&bpo=1492704] 中贡献。）

smtpd

The SMTPServer and SMTPChannel classes now accept a map keyword argument which, if specified, is passed in to asynchat.async_chat as its map argument. This allows an application to avoid affecting the global socket map. (Contributed by Vinay Sajip in bpo-11959 [https://bugs.python.org/issue?@action=redirect&bpo=11959].)

smtplib

现在 SMTPException 是 OSError 的子类，它允许仅需关注是否有错误发生的代码在一个 try/except 语句中同时捕获套接字级错误和 SMTP 协议级错误。 （由 Ned Jackson Lovely 在 bpo-2118 [https://bugs.python.org/issue?@action=redirect&bpo=2118] 中贡献。）

socket

The socket module now supports the CAN_BCM protocol on platforms that support it. (Contributed by Brian Thorne in bpo-15359 [https://bugs.python.org/issue?@action=redirect&bpo=15359].)

Socket 对象新增了用于获取或设置其 可继承旗标 的方法，get_inheritable() 和 set_inheritable()。

现在 socket.AF_* 和 socket.SOCK_* 常量是使用了新增的 enum 模块的枚举值。 这允许在调试期间打印有意义的名称，而不是整数形式的“魔法数字”。

The AF_LINK constant is now available on BSD and OSX.

现在 inet_pton() 和 inet_ntop() 在 Windows 上已受到支持。 （由 Atsuo Ishimoto 在 bpo-7171 [https://bugs.python.org/issue?@action=redirect&bpo=7171] 中贡献。）

sqlite3

connect() 函数新增布尔值形参 uri，它可被用来指明 database 形参是一个 uri (参见 SQLite URI 文档 [https://www.sqlite.org/uri.html])。 （由 poq 在 bpo-13773 [https://bugs.python.org/issue?@action=redirect&bpo=13773] 中贡献。）

ssl

添加了 PROTOCOL_TLSv1_1 和 PROTOCOL_TLSv1_2 (TLSv1.1 和 TLSv1.2 支持)；对这些协议的支持仅在 Python 使用 OpenSSL 1.0.1 或更高版本链接时可用。 （由 Michele Orrù 和 Antoine Pitrou 在 bpo-16692 [https://bugs.python.org/issue?@action=redirect&bpo=16692] 中贡献。）

新增的函数 create_default_context() 提供了获取 SSLContext 的标准方式，其设置旨在合理兼顾兼容性和安全性。 这些设置比 SSLContext 构造器所提供的默认设置更为严格，如果最佳实践的安全要求发生变化，将来可能会对其进行调整，而不预先提示弃用。 对于使用支持 SSL 的 stdlib 库来新推荐的最佳实践是使用 create_default_context() 来获取 SSLContext 对象，必要时对其进行修改，然后将其作为相应 stdlib API 的 contex 参数传入。 （由 Christian Heimes 在 bpo-19689 [https://bugs.python.org/issue?@action=redirect&bpo=19689] 中贡献。）

SSLContext 方法 load_verify_locations() 接受新增的可选参数 cadata，它可被来分别通过字符串或字节串来直接提供 PEM 或 DER 编码的证书。 （由 Christian Heimes 在 bpo-18138 [https://bugs.python.org/issue?@action=redirect&bpo=18138] 中贡献。）

新增的函数 get_default_verify_paths() 可返回一个由路径和环境变量组成的具名元组， 供 set_default_verify_paths() 方法用来设置 OpenSSL 的默认 cafile 和``capath``。 这有助于对默认的验证问题进行调试。 （由 Christian Heimes 在 bpo-18143 [https://bugs.python.org/issue?@action=redirect&bpo=18143] 中贡献。）

SSLContext 增加了一个新方法 cert_store_stats()，用来报告已加载的 X.509 证书, X.509 CA 证书数量和证书吊销列表 (crls)，以及 get_ca_certs() 方法用来返回已加载的 CA 证书列表。 （由 Christian Heimes 在 bpo-18147 [https://bugs.python.org/issue?@action=redirect&bpo=18147] 中贡献。）

If OpenSSL 0.9.8 or later is available, SSLContext has a new attribute verify_flags that can be used to control the certificate verification process by setting it to some combination of the new constants VERIFY_DEFAULT, VERIFY_CRL_CHECK_LEAF, VERIFY_CRL_CHECK_CHAIN, or VERIFY_X509_STRICT. OpenSSL does not do any CRL verification by default. (Contributed by Christien Heimes in bpo-8813 [https://bugs.python.org/issue?@action=redirect&bpo=8813].)

新增的 SSLContext 方法 load_default_certs() 可从默认位置加载一组默认的“证书颁发机构”（CA）证书，此位置随平台而异。 它可被用于加载 TLS Web 服务器验证证书 (purpose=SERVER_AUTH ) 供客户端用来验证服务器，或加载证书供服务器用来验证客户端证书 (purpose=CLIENT_AUTH )。 （由 Christian Heimes 在 bpo-19292 [https://bugs.python.org/issue?@action=redirect&bpo=19292] 中贡献。）

新增的两个 Windows 专属函数 enum_certificates() 和 enum_crls() 提供了从 Windows 证书存储库提取证书、证书信息和 CRL 的功能。 （由 Christian Heimes 在 bpo-17134 [https://bugs.python.org/issue?@action=redirect&bpo=17134] 中贡献。）

使用新增的 ssl.SSLContext.set_servername_callback() 方法来支持服务器端 SNI (Server Name Indication)。 （由 Daniel Black 在 bpo-8109 [https://bugs.python.org/issue?@action=redirect&bpo=8109] 中贡献。）

由 SSLSocket.getpeercert() 返回的字典包含额外的 X509v3 扩展条目: crlDistributionPoints, calIssuers 和 OCSP URI。 （由 Christian Heimes 在 bpo-18379 [https://bugs.python.org/issue?@action=redirect&bpo=18379] 中贡献。）

stat

现在 stat 模块以 _stat 中的 C 实现作为后端。 C 实现是必需的因为大多数值都未被标准化并且依赖于平台。 （由 Christian Heimes 在 bpo-11016 [https://bugs.python.org/issue?@action=redirect&bpo=11016] 中贡献。）

The module supports new ST_MODE flags, S_IFDOOR, S_IFPORT, and S_IFWHT. (Contributed by Christian Hiemes in bpo-11016 [https://bugs.python.org/issue?@action=redirect&bpo=11016].)

struct

新增函数 iter_unpack 和在已编译格式上的新增方法 struct.Struct.iter_unpack() 提供了对包含给定格式数据的重复实例的缓冲区的流式解包功能。 （由 Antoine Pitrou 在 bpo-17804 [https://bugs.python.org/issue?@action=redirect&bpo=17804] 中贡献。）

subprocess

现在 check_output() 接受一个 input 参数用于为所运行的命令提供 stdin 的内容。 （由 Zack Weinberg 在 bpo-16624 [https://bugs.python.org/issue?@action=redirect&bpo=16624] 中贡献。）

现在 getstatus() 和 getstatusoutput() 已适用于 Windows。 这一修改是在 3.3.4 中意外实施的。 （由 Tim Golden 在 bpo-10197 [https://bugs.python.org/issue?@action=redirect&bpo=10197] 中贡献。）

sunau

现在 getparams() 方法将返回一个具名元组而不是普通元组。 （由 Claudiu Popa 在 bpo-18901 [https://bugs.python.org/issue?@action=redirect&bpo=18901] 中贡献。）

现在 sunau.open() 已支持上下文管理协议：当在 with 代码块中使用时，所返回对象的 close 方法将在代码块结束时被自动调用。 （由 Serhiy Storchaka 在 bpo-18878 [https://bugs.python.org/issue?@action=redirect&bpo=18878] 中贡献。）

现在 AU_write.setsampwidth() 已支持 24 位采样，因此增加了使用该模块写入 24 位采样的支持。 （由 Serhiy Storchaka 在 bpo-19261 [https://bugs.python.org/issue?@action=redirect&bpo=19261] 中贡献。）

现在 writeframesraw() 和 writeframes() 方法将接受任意 bytes-like object。 （由 Serhiy Storchaka 在 bpo-8311 [https://bugs.python.org/issue?@action=redirect&bpo=8311] 中贡献。）

sys

新增函数 sys.getallocatedblocks() 可返回当前由解释器所分配的内存块数量。 （在使用默认 --with-pymalloc 设置的 CPython 中，这将是通过 PyObject_Malloc() API 执行的分配。） 这在追踪内存泄漏时会很有用处，特别是对于通过测试套件自动追踪的场景。 （由 Antoine Pitrou 在 bpo-13390 [https://bugs.python.org/issue?@action=redirect&bpo=13390] 中贡献。）

当 Python 解释器以 交互模式 启动时，它会检查 sys 模块中的 __interactivehook__ 属性。 如果该属性存在，它的值将在交互模式启动之前不附带参数地被调用。 这个检查是在读取 PYTHONSTARTUP 文件之后进行的，因此可以在那里设置它。 site 模块会在平台支持 readline 的情况下 把它设置为 一个启用制表符补全和历史记录保存（在 ~/.python-history 中）的函数。 如果你不想要这个（新增的）行为，可以通过从 sys 中删除这个属性（或将其设为其他可调用对象）在 PYTHONSTARTUP, sitecustomize 或 usercustomize 中覆盖它。 （由 Éric Araujo 和 Antoine Pitrou 在 bpo-5845 [https://bugs.python.org/issue?@action=redirect&bpo=5845] 中贡献。）

tarfile

现在 tarfile 模块当直接作为脚本或通过 -m 调用时将支持简单的 命令行接口。 这可被用来创建和提取 tar 归档文件。 （由 Berker Peksag 在 bpo-13477 [https://bugs.python.org/issue?@action=redirect&bpo=13477] 中贡献。）

textwrap

TextWrapper 类新增了两个属性/构造器参数: max_lines，用来限制输出的行数，以及 placeholder，它是一个当输出由于 max_lines 限制被截断时将出现在输出末尾处的字符串。 一个在此功能之上新增的便捷函数 shorten() 可将输入中的所有空格压缩为单个空格并产生一个宽度为 width 并以 placeholder (默认为 [...]) 结束的单独行。 （由 Antoine Pitrou 和 Serhiy Storchaka 在 bpo-18585 [https://bugs.python.org/issue?@action=redirect&bpo=18585] 和 bpo-18725 [https://bugs.python.org/issue?@action=redirect&bpo=18725] 中贡献。）

threading

代表可通过新增的 main_thread() 函数来获取的主线程的 Thread 对象。 在通常条件下这将是启动 Python 解释器所在的线程。 （由 Andrew Svetlov 在 bpo-18882 [https://bugs.python.org/issue?@action=redirect&bpo=18882] 中贡献。）

回溯

新增的 traceback.clear_frames() 函数可接受一个回溯对象清除它所引用的所有帧中的局部变量，以减少内存消耗量。 （由 Andrew Kuchling 在 bpo-1565525 [https://bugs.python.org/issue?@action=redirect&bpo=1565525] 中贡献。）

types

新增的 DynamicClassAttribute() 描述器提供了一种定义属性的方式，这种属性可正常地在实例对象中查找，但在类中查找时会被导向 类的 __getattr__。 这将允许设置在类上激活的特征属性，并在相同名称的类上具有虚拟属性（参见 Enum 的例子）。 （由 Ethan Furman 在 bpo-19030 [https://bugs.python.org/issue?@action=redirect&bpo=19030] 中贡献。）

urllib

现在 urllib.request 支持 data: 使用 DataHandler 类的 URL。 （由 Mathias Panzenböck 在 bpo-16423 [https://bugs.python.org/issue?@action=redirect&bpo=16423] 中贡献。）

由 Request 类使用的 http 方法现在可通过在子类上设置 method 类属性来指定。 （由 Jason R Coombs 在 bpo-18978 [https://bugs.python.org/issue?@action=redirect&bpo=18978] 中贡献。）

现在 Request 对象是可重用的：如果 full_url 或 data 属性被修改，所有相关的内部特征属性都将被更新。 例如，这意味着现在可以在多个使用不同 data 参数的 OpenerDirector.open() 调用中使用相同的 Request 对象，或者修改 Request 的 url 而不必从头重新计算它们。 此外还有新增的 remove_header() 方法可被用来从 Request 中移除标头。 （由 Alexey Kachayev 在 bpo-16464 [https://bugs.python.org/issue?@action=redirect&bpo=16464] 中，Daniel Wozniak 在 bpo-17485 [https://bugs.python.org/issue?@action=redirect&bpo=17485] 中，以及 Damien Brecht 和 Senthil Kumaran 在 bpo-17272 [https://bugs.python.org/issue?@action=redirect&bpo=17272] 中贡献。）

现在 HTTPError 对象具有一个 headers 属性可提供对与错误相关的 HTTP 响应的访问。 （由 Berker Peksag 在 bpo-15701 [https://bugs.python.org/issue?@action=redirect&bpo=15701] 中贡献。）

unittest

TestCase 类有一个新方法 subTest()，它可产生一个以 with 代码块作为“子测试”的上下文管理器。 这个上下文管理器允许测试方法通过调用一个循环内的 subTest 上下文管理器这样的方式动态生成子测试。 这样单个测试方法就可以产生无限多个单独标识并单独计数的测试，这些测试即使在其中一个或多个测试失败的情况下仍然会全部运行。 例如:

class NumbersTest(unittest.TestCase):
    def test_even(self):
        for i in range(6):
            with self.subTest(i=i):
                self.assertEqual(i % 2, 0)

将得到六个子测试，在单元测试详细输出中各自以变量名 i 加该变量专属的值来标识 (i=0, i=1 等等)。 该示例的完整版本见 使用子测试区分测试迭代。 （由 Antoine Pitrou 在 bpo-16997 [https://bugs.python.org/issue?@action=redirect&bpo=16997] 中贡献。）

现在 unittest.main() 接受一个包含测试名称的可迭代对象作为 defaultTest，而在之前版本中它只接受单个字符串形式的测试名称。 （由 Jyrki Pulliainen 在 bpo-15132 [https://bugs.python.org/issue?@action=redirect&bpo=15132] 中贡献。）

如果在测试发现期间（即在测试文件中的模块层级）引发了 SkipTest，现在它将被报告为跳过而不是错误。 （由 Zach Ware 在 bpo-16935 [https://bugs.python.org/issue?@action=redirect&bpo=16935] 中贡献。）

现在 discover() 会对所发现的文件进行排序以提供一致的测试顺序。 （由 Martin Melin 和 Jeff Ramnani 在 bpo-16709 [https://bugs.python.org/issue?@action=redirect&bpo=16709] 中贡献。）

如果测试成功，现在 TestSuite 会在测试完成运行时立即丢弃对测试的引用。 在支持垃圾回收的 Python 解释器上，这允许当没有其他对象持有对测试的引用时将该测试作为垃圾回收。 可以通过创建一个定义了自定义 _removeTestAtIndex 方法的 TestSuite 子类来覆盖此行为。 （由 Tom Wardill, Matt McClure 和 Andrew Svetlov 在 bpo-11798 [https://bugs.python.org/issue?@action=redirect&bpo=11798] 中贡献。）

新增的测试断言上下文管理器 assertLogs() 将确保给定的代码块使用 logging 模块发出日志记录消息。 在默认情况下消息可来自任意日志记录器并具有 INFO 或更高的优先级，但要指明日志记录器名称和替代的最低日志级别。 可以在该上下文管理器所返回的对象中查询 LogRecord 和/或所记录的已格式化消息。 （由 Antoine Pitrou 在 bpo-18937 [https://bugs.python.org/issue?@action=redirect&bpo=18937] 中贡献。）

现在测试发现将可用于命名空间包（由 Claudiu Popa 在 bpo-17457 [https://bugs.python.org/issue?@action=redirect&bpo=17457] 中贡献。）.)

现在 unittest.mock 对象可以在匹配调用时检查其规范签名，这意味着现在可以通过位置或名称来匹配参数，而不是仅能通过位置。 （由 Antoine Pitrou 在 bpo-17015 [https://bugs.python.org/issue?@action=redirect&bpo=17015] 中贡献。）

现在 mock_open() 对象具有 readline 和 readlines 方法。 （由 Toshio Kuratomi 在 bpo-17467 [https://bugs.python.org/issue?@action=redirect&bpo=17467] 中贡献。）

venv

现在 venv 包括了用于 csh 和 fish shell 的激活脚本。 （由 Andrew Svetlov 在 bpo-15417 [https://bugs.python.org/issue?@action=redirect&bpo=15417] 中贡献。）

EnvBuilder 和 create() 便捷函数接受新的关键字参数 with_pip，默认值为 False，它控制 EnvBuilder 是否确保 pip 在虚拟环境中安装。 （作为 PEP 453 [https://www.python.org/dev/peps/pep-0453] 实现的组成部分由 Nick Coghlan 在 bpo-19552 [https://bugs.python.org/issue?@action=redirect&bpo=19552] 中贡献。）

wave

现在 getparams() 方法将返回一个具名元组而不是普通元组。 （由 Claudiu Popa 在 bpo-17487 [https://bugs.python.org/issue?@action=redirect&bpo=17487] 中贡献。）

现在 wave.open() 已支持上下文管理器协议。 （由 Claudiu Popa 在 bpo-17616 [https://bugs.python.org/issue?@action=redirect&bpo=17616] 中贡献。）

现在 wave 可以 将输出写入到不可定位的文件。 （由 David Jones, Guilherme Polo 和 Serhiy Storchaka 在 bpo-5202 [https://bugs.python.org/issue?@action=redirect&bpo=5202] 中贡献。）

现在 writeframesraw() 和 writeframes() 方法将接受任意 bytes-like object。 （由 Serhiy Storchaka 在 bpo-8311 [https://bugs.python.org/issue?@action=redirect&bpo=8311] 中贡献。）

weakref

新增的 WeakMethod 类可模拟指向绑定方法的弱引用。 （由 Antoine Pitrou 在 bpo-14631 [https://bugs.python.org/issue?@action=redirect&bpo=14631] 中贡献。）

新增的 finalize 类使得注册一个当对象被作为垃圾回收时唤起的回调成为可能，而无需小心地管理弱引用本身的生命周期。 （由 Richard Oudkerk 在 bpo-15528 [https://bugs.python.org/issue?@action=redirect&bpo=15528] 中贡献。）

如果存在任何与 ref 相关联的回调，现在将通过 __callback__ 属性对外公开。 （由 Mark Dickinson 在 bpo-17643 [https://bugs.python.org/issue?@action=redirect&bpo=17643] 中贡献。）

xml.etree

新增的解析器 XMLPullParser 允许用非阻塞的应用程序来解析 XML 文档。 相关示例可参见 用于非阻塞解析的拉取 API。 （由 Antoine Pitrou 在 bpo-17741 [https://bugs.python.org/issue?@action=redirect&bpo=17741] 中贡献。）

现在 xml.etree.ElementTree tostring() 和 tostringlist() 函数，以及 ElementTree 的 write() 方法都具有一个 short_empty_elements 仅限关键字形参 用来提供对于无内容的元素要采取缩写 (<tag />) 还是扩展 (<tag></tag>) 形式的控制。 （由 Ariel Poliak 和 Serhiy Storchaka 在 bpo-14377 [https://bugs.python.org/issue?@action=redirect&bpo=14377] 中贡献。）

zipfile

PyZipFile 类的 writepy() 方法新增的 filterfunc 选项可用来控制要将哪些目录添加到归档中。 例如，可以用它将测试文件排除在归档之外。 （由 Christian Tismer 在 bpo-19274 [https://bugs.python.org/issue?@action=redirect&bpo=19274] 中贡献。）

现在 ZipFile 和 PyZipfile 的 allowZip64 形参默认值为 True。 （由 William Mallard 在 bpo-17201 [https://bugs.python.org/issue?@action=redirect&bpo=17201] 中贡献。）

CPython 实现的变化

PEP 445: 自定义 CPython 内存分配器

PEP 445 [https://www.python.org/dev/peps/pep-0445] 添加了新的 C 层级接口用来在 CPython 解释器中对内存分配进行自定义。

参见

PEP 445 [https://www.python.org/dev/peps/pep-0445] -- 新增用于自定义 Python 内存分配器的 API

PEP 由 Victor Stinner 撰写并实现。

PEP 442: 安全的对象最终化

PEP 442 [https://www.python.org/dev/peps/pep-0442] 移除了 CPython 中有关对象最终化的限制和特殊处理。 有了它，具有 __del__() 方法的对象，以及具有 finally 子句的生成器在有循环引用的情况下也可以被最终化。

作为此项改变的一部分，大多数情况下在解释器关闭期间模块的全局变量不会被强制设为 None，而是取决于循环垃圾回收器的正常操作。 这避免了大量的解释器关闭时错误，这类错误通常都涉及 __del__ 方法，它们自循环 GC 首次被引入起就一直困扰着 Python。

参见

PEP 442 [https://www.python.org/dev/peps/pep-0442] -- 安全的对象最终化

PEP 由 Antoine Pitrou 撰写并实现

PEP 456: 安全且可互换的哈希算法

PEP 456 [https://www.python.org/dev/peps/pep-0456] 在早先对 Python 的哈希算法所做安全修复上更进一步以解决特定的 DOS 攻击问题，以字典查找为基础的对外公开的 API 可能面临此种攻击。（请参阅 bpo-14621 [https://bugs.python.org/issue?@action=redirect&bpo=14621] 了解此轮改进的缘起。） 该 PEP 统一了 CPython 的哈希代码以使打包者能更容易地用不同哈希算法进行替换，并在具有 64 位数据类型的平台上将 Python 的默认实现切换为 SipHash 实现。 与旧版 FNV 算法相比只有很小的性能差异。

The PEP adds additional fields to the sys.hash_info named tuple to describe the hash algorithm in use by the currently executing binary. Otherwise, the PEP does not alter any existing CPython APIs.

PEP 436: Argument Clinic

现在 "Argument Clinic" (PEP 436 [https://www.python.org/dev/peps/pep-0436]) 是 CPython 构建过程的一部分并可被用于简化为内置对象和以 C 实现的标准库扩展模块定义和维护准确签名的过程。

在 Python 3.4 中有一些标准库模块已被转换为使用 Argument Clinic，而 pydoc 和 inspect 也进行了相应的更新。

预期针对程序化内省的签名元数据将被添加到更多的以 C 实现的可调用对象中作为 Python 3.4 维护发布版的组成部分。

注解

Argument Clinic PEP 尚未完整更新到与具体实现的状态相一致。 这种情况被发布版管理者和核心开发团队认为是可接受的，因为 Argument Clinic 在 Python 3.4 中将不会作为公有 API 提供给第三方。

参见

PEP 436 [https://www.python.org/dev/peps/pep-0436] -- The Argument Clinic DSL

PEP 由 Larry Hastings 撰写并实现

其他的构建和 C API 的改变

新的 PyType_GetSlot() 函数已被添加到稳定 ABI，以允许在使用受限 API 时从指定的类型槽位提取函数指针。 （由 Martin von Löwis 在 bpo-17162 [https://bugs.python.org/issue?@action=redirect&bpo=17162] 中贡献。）

The new Py_SetStandardStreamEncoding() pre-initialization API allows applications embedding the CPython interpreter to reliably force a particular encoding and error handler for the standard streams. (Contributed by Bastien Montagne and Nick Coghlan in bpo-16129 [https://bugs.python.org/issue?@action=redirect&bpo=16129].)

大多数不修改字符串参数的 Python C API 现在已被正确地标记为接受 const char * 而不是 char *。 （由 Serhiy Storchaka 在 bpo-1772673 [https://bugs.python.org/issue?@action=redirect&bpo=1772673] 中贡献。）

一个新的 python-config 的 shell 版本即使在 python 解释器不可用时仍可被使用（例如，在交叉编译的场景中）。

现在 PyUnicode_FromFormat() 支持为 %s, %A, %U, %V, %S 和 %R 使用宽度和精度说明符。 （由 Ysj Ray 和 Victor Stinner 在 bpo-7330 [https://bugs.python.org/issue?@action=redirect&bpo=7330] 中贡献。）

新的函数 PyStructSequence_InitType2() 为现有的 PyStructSequence_InitType() 函数提供了补充。 其不同之处在于它会在成功时返回 0 而在失败时返回 -1。

现在 CPython 源代码可以使用最近版本的 GCC 和 clang 的地址确定性检查特性进行编译：小对象分配器中的假警报已被消除。 （由 Dhiru Kholia 在 bpo-18596 [https://bugs.python.org/issue?@action=redirect&bpo=18596] 中贡献。）

Windows 构建版现在会使用 寻址空间布局随机化 [https://en.wikipedia.org/wiki/Address_space_layout_randomization] 和 数据执行保护 [https://en.wikipedia.org/wiki/Data_Execution_Prevention]。 （由 Christian Heimes 在 bpo-16632 [https://bugs.python.org/issue?@action=redirect&bpo=16632] 中贡献。）

新的函数 PyObject_LengthHint() 是 operator.length_hint() 的 C API 等价形式。 （由 Armin Ronacher 在 bpo-16148 [https://bugs.python.org/issue?@action=redirect&bpo=16148] 中贡献。）

其他改进

The python command has a new option, -I, which causes it to run in "isolated mode", which means that sys.path contains neither the script's directory nor the user's site-packages directory, and all PYTHON* environment variables are ignored (it implies both -s and -E). Other restrictions may also be applied in the future, with the goal being to isolate the execution of a script from the user's environment. This is appropriate, for example, when Python is used to run a system script. On most POSIX systems it can and should be used in the #! line of system scripts. (Contributed by Christian Heimes in bpo-16499 [https://bugs.python.org/issue?@action=redirect&bpo=16499].)

在支持 readline 的系统上的交互模式中现在将默认启用 Tab 键补全。 历史记录也将默认启用，并会写入到 ~/.python-history 文件（也会从中读取）。 （由 Antoine Pitrou 和 Éric Araujo 在 bpo-5845 [https://bugs.python.org/issue?@action=redirect&bpo=5845] 中贡献。）

现在附带 --version 唤起 Python 解释器将会把版本信息输出到标准输出而不是标准错误 (bpo-18338 [https://bugs.python.org/issue?@action=redirect&bpo=18338])。 对于 argparse (bpo-18920 [https://bugs.python.org/issue?@action=redirect&bpo=18920]) 和其他具有脚本类唤起功能的模块也做了类似的修改 (bpo-18922 [https://bugs.python.org/issue?@action=redirect&bpo=18922])。

现在 CPython Windows 安装程序会在注册扩展名时将 .py 添加到 PATHEXT 变量，以允许用户在 windows 命令提示符下直接键入不带 .py 扩展名的 python 脚本名称来运行它。 （由 Paul Moore 在 bpo-18569 [https://bugs.python.org/issue?@action=redirect&bpo=18569] 中贡献。）

A new make target coverage-report [https://devguide.python.org/coverage/#measuring-coverage-of-c-code-with-gcov-and-lcov] will build python, run the test suite, and generate an HTML coverage report for the C codebase using gcov and lcov [https://ltp.sourceforge.net/coverage/lcov.php].

The -R option to the python regression test suite now also checks for memory allocation leaks, using sys.getallocatedblocks(). (Contributed by Antoine Pitrou in bpo-13390 [https://bugs.python.org/issue?@action=redirect&bpo=13390].)

现在 python -m 将可用于命名空间包。

现在 stat 模块是用 C 实现的，这意味着它将从 C 头文件中获取其常量值，而不是像之前版本中那样将值码编码在 python 模块中。

现在将能够正确地从单个 OS 模块加载多个 (.so, .dll) python 模块（在之前版本中则会静默地返回文件中的第一个 python 模块）。 （由 Václav Šmilauer 在 bpo-16421 [https://bugs.python.org/issue?@action=redirect&bpo=16421] 中贡献。）

增加了新的操作码 LOAD_CLASSDEREF，用于修复一个在类体中加载自由变量的程序错误，它可能因 __prepare__ 的特定用法而触发。 （由 Benjamin Peterson 在 bpo-17853 [https://bugs.python.org/issue?@action=redirect&bpo=17853] 中贡献。）

多个有关 MemoryError 的崩溃问题被 Victor Stinner 使用他基于 PEP 445 [https://www.python.org/dev/peps/pep-0445] 的 pyfailmalloc 工具加以确定并修复 (bpo-18408 [https://bugs.python.org/issue?@action=redirect&bpo=18408], bpo-18520 [https://bugs.python.org/issue?@action=redirect&bpo=18520])。

现在 pyvenv 命令接受一个 --copies 选项以使用拷贝而不是符号链接，即使在默认使用符号链接的系统上也是如此。 （由 Vinay Sajip 在 bpo-18807 [https://bugs.python.org/issue?@action=redirect&bpo=18807] 中贡献。）

pyvenv 命令也接受一个 --without-pip 选项用来抑制在其他情况下将自动将 pip 初始设置到虚拟环境中。 （作为 PEP 453 [https://www.python.org/dev/peps/pep-0453] 实现的一部分由 Nick Coghlan 在 bpo-19552 [https://bugs.python.org/issue?@action=redirect&bpo=19552] 中贡献。）

现在编码格式名称在 PYTHONIOENCODING 环境变量的设置值中将为可选项。 这使得只设置错误处理器而不改变默认编码格式成为可能。 （由 Serhiy Storchaka 在 bpo-18818 [https://bugs.python.org/issue?@action=redirect&bpo=18818] 中贡献。）

现在 bz2, lzma, and gzip 模块的 open 函数已支持 x (独占式创建) 模式。 （由 Tim Heaney 和 Vajrasky Kok 在 bpo-19201 [https://bugs.python.org/issue?@action=redirect&bpo=19201], bpo-19222 [https://bugs.python.org/issue?@action=redirect&bpo=19222] 和 bpo-19223 [https://bugs.python.org/issue?@action=redirect&bpo=19223] 中贡献。）

显著的优化

现在 UTF-32 解码器获得了 3x 至 4x 的提速。 （由 Serhiy Storchaka 在 bpo-14625 [https://bugs.python.org/issue?@action=redirect&bpo=14625] 中贡献。）

针对集合的哈希碰撞的耗费现在已被降低。 每次哈希表检测现在会先检查一系列连续的、相邻的键/哈希值对再继续对整个哈希表执行随机检测。 这将利用缓存本地化来使得碰撞求解付出较少代价。 这种碰撞求解方案可被描述为线性检测和开放寻址的结合。 额外的线性检测数默认为九次。 这可以在编译时通过将 LINEAR_PROBES 定义为任意值来修改。 设置 LINEAR_PROBES=0 可完全关闭线性检测。 （由 Raymond Hettinger 在 bpo-18771 [https://bugs.python.org/issue?@action=redirect&bpo=18771] 中贡献。）

解释器启动速度加快了约 30%。 多项措施促成了此次加速。 解释器在启动时加载的模块有所减少，例如 re, collections 和 locale 模块及其依赖默认不再被导入。 marshal 模块得到改进以便更快速地加载已编译的 Python 代码。 （由 Antoine Pitrou, Christian Heimes 和 Victor Stinner 在 bpo-19219 [https://bugs.python.org/issue?@action=redirect&bpo=19219], bpo-19218 [https://bugs.python.org/issue?@action=redirect&bpo=19218], bpo-19209 [https://bugs.python.org/issue?@action=redirect&bpo=19209], bpo-19205 [https://bugs.python.org/issue?@action=redirect&bpo=19205] 和 bpo-9548 [https://bugs.python.org/issue?@action=redirect&bpo=9548] 中贡献。）

现在 bz2.BZ2File 在多数情况下相比 Python2 版本速度都一样快更快或。 lzma.LZMAFile 也获得了优化。 （由 Serhiy Storchaka 和 Nadeem Vawda 在 bpo-16034 [https://bugs.python.org/issue?@action=redirect&bpo=16034] 中贡献。）

random.getrandbits() 对于小整数（最常见的应用场景）可加速 20%-40%。 （由 Serhiy Storchaka 在 bpo-16674 [https://bugs.python.org/issue?@action=redirect&bpo=16674] 中贡献。）

得益于字符串的新存储格式，对字符串执行 pickle 操作现在将有明显加速。 （由 Victor Stinner 和 Antoine Pitrou 在 bpo-15596 [https://bugs.python.org/issue?@action=redirect&bpo=15596] 中贡献。）

一个 io.FileIO.readall() 中的性能问题已被解决。 这对 Windows 有更具体的情况，将显著地提升通过 subprocess 以管道方式传递大量数据这一应用场景下的速度。 （由 Richard Oudkerk 在 bpo-15758 [https://bugs.python.org/issue?@action=redirect&bpo=15758] 中贡献。）

现在 html.escape() 获得了 10x 速度提升。 （由 Matt Bryant 在 bpo-18020 [https://bugs.python.org/issue?@action=redirect&bpo=18020] 中贡献。）

在 Windows 上，现在将使用原生的 VirtualAlloc 而不是 obmalloc 中的 CRT malloc。 人工基准测试显示可节省约 3% 的内存。

现在 os.urandom() 会使用延迟打开的持久性文件描述符以避免在从多个线程并行时使用过多的文件描述符。 （由 Antoine Pitrou 在 bpo-18756 [https://bugs.python.org/issue?@action=redirect&bpo=18756] 中贡献。）

弃用

本小节列出了已在 Python 3.4 中弃用，并将在 Python 3.5 或之后的版本中移除的各种 API 和其他特性。 在大多数（但并非全部）情况下，在解释器运行时设置了弃用警告时（例如通过使用 -Wd 选项）使用已弃用的 API 将产生 DeprecationWarning。

Python API 中的弃用

As mentioned in PEP 451: 针对导入系统的 ModuleSpec 类型, a number of importlib methods and functions are deprecated: importlib.find_loader() is replaced by importlib.util.find_spec(); importlib.machinery.PathFinder.find_module() is replaced by importlib.machinery.PathFinder.find_spec(); importlib.abc.MetaPathFinder.find_module() is replaced by importlib.abc.MetaPathFinder.find_spec(); importlib.abc.PathEntryFinder.find_loader() and find_module() are replaced by importlib.abc.PathEntryFinder.find_spec(); all of the xxxLoader ABC load_module methods (importlib.abc.Loader.load_module(), importlib.abc.InspectLoader.load_module(), importlib.abc.FileLoader.load_module(), importlib.abc.SourceLoader.load_module()) should no longer be implemented, instead loaders should implement an exec_module method (importlib.abc.Loader.exec_module(), importlib.abc.InspectLoader.exec_module() importlib.abc.SourceLoader.exec_module()) and let the import system take care of the rest; and importlib.abc.Loader.module_repr(), importlib.util.module_for_loader(), importlib.util.set_loader(), and importlib.util.set_package() are no longer needed because their functions are now handled automatically by the import system.

The imp module is pending deprecation. To keep compatibility with Python 2/3 code bases, the module's removal is currently not scheduled.

formatter 模块已被弃用并计划在 Python 3.6 中移除。

将 MD5 作为 hmac.new() 函数的默认 digestmod 的设置已被弃用。 Python 3.6 将要求以一个显式的摘要名称或构造器作为 digestmod 参数。

很长一段时间以来 ftplib 模块中的内部 Netrc 类在其文档字符串中被声明为已弃用。 现在它将发出 DeprecationWarning 并将在 Python 3.5 中完全移除。

传给 subprocess.Popen.wait() 的未写入文档的 endtime 参数不应被公开也不应被使用；它已被弃用并很可能在 Python 3.5 中移除。

HTMLParser 的 strict 参数已被弃用。

plistlib readPlist(), writePlist(), readPlistFromBytes() 和 writePlistToBytes() 等函数已被弃用而应改用相应的新函数 load(), dump(), loads() 和 dumps()。 Data() 已被弃用而应直接使用 bytes 构造器。

sysconfig 的键 SO 已被弃用，它已被 EXT_SUFFIX 所替代。

各种 open 函数所接受的 U 模式已被弃用。 在 Python3 中它已不再有任何实际作用，并应当改用适当的 io.TextIOWrapper (如有必要) 及其 newline 参数。

xml.etree.ElementTree.iterparse() 的 parser 参数，就如 XMLParser() 的 html 参数一样。 要对后者的移除做好准备，所有 XMLParser 的参数都应当以关键字形式传入。

弃用的特性

运行 IDLE 时附带 -n 旗标（无子进程）的做法已被弃用。 但是，该特性在 bpo-18823 [https://bugs.python.org/issue?@action=redirect&bpo=18823] 解决之前将不会被移除。

site 模块在 "site-python" 目录存在的情况下 sys.path 添加该目录的做法已被弃用 (bpo-19375 [https://bugs.python.org/issue?@action=redirect&bpo=19375])。

移除

不再支持的操作系统

从源代码和构建工具中删除了对以下操作系统的支持：

OS/2 (bpo-16135 [https://bugs.python.org/issue?@action=redirect&bpo=16135]).

Windows 2000（变更集e52df05b496a）。

Windows系统中 COMSPEC 指向 command.com 的版本（ bpo-14470 [https://bugs.python.org/issue?@action=redirect&bpo=14470] ）。

VMS (bpo-16136 [https://bugs.python.org/issue?@action=redirect&bpo=16136]).

API 与特性的移除

以下过时并在之前版本中弃用的 API 和特性现已被移除：

不再继续维护的 Misc/TextMate 和 Misc/vim 目录已被移除（请参阅 devguide [https://devguide.python.org] 了解相关替代器的使用建议）。

SO makefile 宏已被移除（被 SHLIB_SUFFIX 和 EXT_SUFFIX 宏所替代） (bpo-16754 [https://bugs.python.org/issue?@action=redirect&bpo=16754])。

PyThreadState.tick_counter 字段已被移除；该字段值自 Python 3.2 即 "新 GIL" 被引入时起就不再有意义了 (bpo-19199 [https://bugs.python.org/issue?@action=redirect&bpo=19199])。

PyLoader 和 PyPycLoader 已从 importlib 中移除。 （由 Taras Lyapun 在 bpo-15641 [https://bugs.python.org/issue?@action=redirect&bpo=15641] 中贡献。）

HTTPConnection 和 HTTPSConnection 的 strict 参数已被移除。 HTTP 0.9 风格的 "简单响应" 不再受到支持。

被弃用的 urllib.request.Request 读取和设置方法 add_data, has_data, get_data, get_type, get_host, get_selector, set_proxy, get_origin_req_host 和 is_unverifiable 已被移除（请改为直接属性访问）。

对加载已弃用的 TYPE_INT64 的支持已从 marshal 中被移除。 （由 Dan Riti 在 bpo-15480 [https://bugs.python.org/issue?@action=redirect&bpo=15480] 中贡献。）

inspect.Signature: 仅限位置形参现在需要有一个合法的名称。

object.__format__() 不再接受非空格式字符串，它现在会改为引发 TypeError。 使用非空字符串自 Python 3.2 起已被弃用。 做出此项改变是为了防止当对象获得 __format__ 方法时之前可用（但不正确）的代码执行失败的情况，这意味着现在当你对没有用于处理 's' 的 __format__ 方法的对象使用该格式代码时你的代码可能会引发 TypeError。 请参阅 bpo-7994 [https://bugs.python.org/issue?@action=redirect&bpo=7994] 了解相关背景。

difflib.SequenceMatcher.isbjunk() 和 difflib.SequenceMatcher.isbpopular() 已在 3.2 中被弃用，现在已被移除：请使用 x in sm.bjunk 和 x in sm.bpopular，其中 sm 是一个 SequenceMatcher 对象 (bpo-13248 [https://bugs.python.org/issue?@action=redirect&bpo=13248])。

代码清理

未被使用并且未写入文档的内部 Scanner 类已从 pydoc 模块中移除。

私有并且实际未使用的 _gestalt 模块已被移除，同时移除了私有的 platform 函数 _mac_ver_lookup, _mac_ver_gstalt 和 _bcd2str，它们仅会在严重过时的 OSX 系统上被调用 (参见 bpo-18393 [https://bugs.python.org/issue?@action=redirect&bpo=18393])。

曾经包括于 tarfile 模块命名空间的某些 stat 常量的硬编码副本已被移除。

移植到 Python 3.4

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

 'python' 命令行为的变化

在 posix shell 中，将 PATH 环境变量设为空值就等于完全不设置。 不过，将 PYTHONPATH 设为空值则 不等于 完全不设置：将 PYTHONPATH 设为空值等于将其设为 .，这在类 PATH 运作方式来进行理解时会导致困惑。 现在的行为将与 posix 中 PATH 的惯例保持一致。

现在 CPython 解释器的调试构建版 (--with-pydebug) 的 [X refs, Y blocks] 输出默认将关闭。 可以使用 -X showrefcount 选项来重新启用它。 （由 Ezio Melotti 在 bpo-17323 [https://bugs.python.org/issue?@action=redirect&bpo=17323] 中贡献。）

现在 python 命令和大多数标准库脚本（和 argparse 一样）会将 --version 信息输出到 stdout 而不是 stderr (相关问题列表参见上面的 其他改进)。

Python API 的变化

在 importlib.abc 中定义的 ABC 现在将会引发适当的异常或是返回默认值而不是无脑引发 NotImplementedError。 这将只影响调用 super() 并一路下落到这些 ABC 的代码。 为保持兼容性，NotImplementedError 和所需的相应异常都要被捕获。

The module type now initializes the __package__ and __loader__ attributes to None by default. To determine if these attributes were set in a backwards-compatible fashion, use e.g. getattr(module, '__loader__', None) is not None. (bpo-17115 [https://bugs.python.org/issue?@action=redirect&bpo=17115].)

importlib.util.module_for_loader() now sets __loader__ and __package__ unconditionally to properly support reloading. If this is not desired then you will need to set these attributes manually. You can use importlib.util.module_to_load() for module management.

当重载时 import 操作现在会无条件地重置相关属性 (例如 __name__, __loader__, __package__, __file__, __cached__)。 请注意在模块重载时会被重发现这一点上该操作恢复了 3.3 之前的行为 (bpo-19413 [https://bugs.python.org/issue?@action=redirect&bpo=19413])。

冻结的包将不再把 __path__ 设为一个包含包名的列表，它们现在会把它设为一个空列表。 当存在与冻结的包同名的目录时之前版本的行为可能会使导入系统错误地处理子模块。 确定一个模块是否属于包的正确方式是使用 hasattr(module, '__path__') (bpo-18065 [https://bugs.python.org/issue?@action=redirect&bpo=18065])。

Frozen modules no longer define a __file__ attribute. It's semantically incorrect for frozen modules to set the attribute as they are not loaded from any explicit location. If you must know that a module comes from frozen code then you can see if the module's __spec__.location is set to 'frozen', check if the loader is a subclass of importlib.machinery.FrozenImporter, or if Python 2 compatibility is necessary you can use imp.is_frozen().

现在 py_compile.compile() 在它要写入的文件路径是符号链接或非常规文件时会引发 FileExistsError。 这是为了提示导入系统将用一个常规文件覆盖相应文件而不管原始文件路径是什么类型而发出的警告。

当被加载的源代码触发了 SyntaxError 或 UnicodeDecodeError 时 importlib.abc.SourceLoader.get_source() 将不再引发 ImportError。 因为 ImportError 本意只是在应该找到源代码但却找不到时被引发，而在源代码已找到但结构不正确时使用此异常会感觉有些过度/过载。 如果你在之前是捕获 ImportError 并希望继续忽略语法或解码问题，现在应当捕获所有这三个异常。

现在 functools.update_wrapper() 和 functools.wraps() 会正确地将 __wrapped__ 属性设为被包装的函数，即使该函数同样设置了 __wrapped__ 属性。 这意味着 __wrapped__ 属性现在会正确地链接由被装饰函数组成的栈而不是链中指向最内层函数的的每个 __wrapped__ 属性。 确定要沿袭之前版本行为的内省库可以使用 inspect.unwrap() 来访问链中没有 __wrapped__ 属性的第一个函数。

inspect.getfullargspec() 已在 inspect.signature() 之上重新实现因而能够处理比之前更多种类的可调用对象。 预计在 Python 3.4 系列发布过程中将会有更多内置和扩展模块的可调用对象获得签名元数据。 假定 inspect.getfullargspec() 会在非 Python 可调用对象上出错的代码可能需要做相应的调整。

对于空字符串 importlib.machinery.PathFinder 现在会将当前工作目录传给 sys.path_hooks 中的对象。 这导致 sys.path_importer_cache 绝不会包含 ''，因此基于 sys.path 迭代 sys.path_importer_cache 将不无找出所有的键。 当从当前工作目录导入时模块的 __file__ 现在也将是一个绝对路径，包括在命令行中指定解释器使用 -m 的情况（但当一个脚本已经直接使用相对路径被执行时的 __main__.__file__ 除外） （由 Brett Cannon 在 bpo-18416 [https://bugs.python.org/issue?@action=redirect&bpo=18416] 中贡献）。 (bpo-18416 [https://bugs.python.org/issue?@action=redirect&bpo=18416])。

传给 HTTPConnection 和 HTTPSConnection 的 strict 参数被移除会改变剩余参数的含义，如果你是以位置参数而不是关键字参数方式指定它们的话。 如果你已经注意到弃用警告那么你的代码应当已经通过关键字参数方式指定所有额外参数了。

现在 from __future__ import ... 语句之间的字符串 总是 会引发 SyntaxError。 在之前版本中如果没有开头的文档字符串，则中间的字符串有时会被忽略。 这使得 CPython 与语言规范保持一致；Jython 和 PyPy 已经是这样了。 (bpo-17434 [https://bugs.python.org/issue?@action=redirect&bpo=17434])。

当 SSLSocket 未连接时 ssl.SSLSocket.getpeercert() 和 ssl.SSLSocket.do_handshake() 现在会引发 OSError 并附带 ENOTCONN，而非如之前版本的行为那样引发 AttributeError。 此外，当握手尚未完成时 getpeercert() 将会引发 ValueError。

当输入字符串包含 non-b32-alphabet 字符时 base64.b32decode() 现在会引发 binascii.Error，而不是 TypeError。 之前在其他 TypeError 被转换时这个 TypeError 被忽略了。 （由 Serhiy Storchaka 在 bpo-18011 [https://bugs.python.org/issue?@action=redirect&bpo=18011] 中贡献。） 注意：这项修改也被非故意地应用到了 Python 3.3.3。

The file attribute is now automatically closed when the creating cgi.FieldStorage instance is garbage collected. If you were pulling the file object out separately from the cgi.FieldStorage instance and not keeping the instance alive, then you should either store the entire cgi.FieldStorage instance or read the contents of the file before the cgi.FieldStorage instance is garbage collected.

在已关闭的 SSL 套接字上调用 read 或 write 现在会引发更具信息量的 ValueError 而非之前更令人困惑的 AttributeError (bpo-9177 [https://bugs.python.org/issue?@action=redirect&bpo=9177])。

对于巨大数值 slice.indices() 将不再产生 OverflowError。 作为此项修复的结果，当给予负的长度时 slice.indices() 现在会引发 ValueError；在之前版本中它会返回无意义的值 (bpo-14794 [https://bugs.python.org/issue?@action=redirect&bpo=14794])。

与 cmath 中的函数不同，当一个对象的 __complex__ 特殊方法返回 float 值时 complex 构造器会不正确地接受它。 现在这会引发 TypeError。 (bpo-16290 [https://bugs.python.org/issue?@action=redirect&bpo=16290]。)

在 3.2 和 3.3 中的 int 构造器会错误地接受 float 值作为 base 形参。 多数人不太可能这样做，但如果真的如此，现在它将引发 TypeError (bpo-16772 [https://bugs.python.org/issue?@action=redirect&bpo=16772])。

现在仅限关键字参数的默认值将在常规关键字参数的默认值 之后 被求值，而非之前。 希望没有人写过任何依赖于之前的有缺陷行为的代码 (bpo-16967 [https://bugs.python.org/issue?@action=redirect&bpo=16967])。

现在陈旧的线程状态将在 fork() 之后被清除。 这可能导致某些之前被不正确地保持永久存活的系统资源（例如，保存在本线程存储中的数据库连接）被释放。 (bpo-17094 [https://bugs.python.org/issue?@action=redirect&bpo=17094]。)

Parameter names in __annotations__ dicts are now mangled properly, similarly to __kwdefaults__. (Contributed by Yury Selivanov in bpo-20625 [https://bugs.python.org/issue?@action=redirect&bpo=20625].)

现在 hashlib.hash.name 将总是返回小写形式的标识符。 在之前版本中某些内置哈希具有大写的名称，但现在它已成为命名方式保持一致的正式公有接口 (bpo-18532 [https://bugs.python.org/issue?@action=redirect&bpo=18532])。

Because unittest.TestSuite now drops references to tests after they are run, test harnesses that re-use a TestSuite to re-run a set of tests may fail. Test suites should not be re-used in this fashion since it means state is retained between test runs, breaking the test isolation that unittest is designed to provide. However, if the lack of isolation is considered acceptable, the old behavior can be restored by creating a TestSuite subclass that defines a _removeTestAtIndex method that does nothing (see TestSuite.__iter__()) (bpo-11798 [https://bugs.python.org/issue?@action=redirect&bpo=11798]).

现在 unittest 会使用 argparse 执行命令行解析。 有些过去可用的不合法命令形式将不再被允许；理论上说这不会导致向下兼容性问题因为这些不允许的命令形式没有任何意义也不大可能会被使用。

现在当要匹配的对象类型为 bytes-like object 时 re.split(), re.findall() 和 re.sub() 等函数，以及 match 对象的 group() 和 groups() 方法将总是返回 bytes 对象。 在之前版本中返回类型将与输入类型相匹配，因此如果你的代码依赖于返回值必须为 bytearray 之类的行为，你将需要修改你的代码。

audioop functions now raise an error immediately if passed string input, instead of failing randomly later on (bpo-16685 [https://bugs.python.org/issue?@action=redirect&bpo=16685]).

新增的传给 HTMLParser 的 convert_charrefs 参数目前默认为 False 以保持向下兼容，但最终将修改成默认为 True。 建议你在你的代码中为所有 HTMLParser 调用添加此关键字，并设置适当的值 (bpo-13633 [https://bugs.python.org/issue?@action=redirect&bpo=13633])。

由于传给 hmac.new() 函数的 digestmod 参数在未来将不设默认值，所有对 hmac.new() 的调用都应当修改为显式地指定 digestmod (bpo-17276 [https://bugs.python.org/issue?@action=redirect&bpo=17276])。

附带 SO 键调用 sysconfig.get_config_var()，或者在对 sysconfig.get_config_vars() 的调用结果中查找 SO 的做法已被弃用。 该键应当被 EXT_SUFFIX 或 SHLIB_SUFFIX 替代，由具体场景决定 (bpo-19555 [https://bugs.python.org/issue?@action=redirect&bpo=19555])。

任何指定了 U 的 open 函数调用都应当被修改。 U 在 Python3 将没有效果并且最终会在被使用时引发错误。 对于该函数，要得到与它的旧 Python2 行为相同的效果可以使用 newline 参数，或者在必要时将流包装在 TextIOWrapper 以使用其 newline 参数 (bpo-15204 [https://bugs.python.org/issue?@action=redirect&bpo=15204])。

如果你在脚本中使用 pyvenv 并且希望 不要 安装 pip，你必须在你的唤起命令中添加 --without-pip。

json.dump() 和 json.dumps() 在指定了缩进值时的默认行为已被改变：它不会在行末的条目分隔逗号后面再附加空格。 此项改变仅在你使用了对这样的输出执行空格敏感比较的测试时才会有影响 (bpo-16333 [https://bugs.python.org/issue?@action=redirect&bpo=16333])。

现在 doctest 会在扩展模块的 __doc__ 字符串中寻找 doctest，因此如果你的 doctest 测试发现包括具有类似 doctest 内容的扩展模块那么你可能会遇到在你之前运行测试时从未遇到过的测试失败 (bpo-3158 [https://bugs.python.org/issue?@action=redirect&bpo=3158])。

作为 Python 启动过程改进的一部分 collections.abc 模块进行了小幅度的重构。 作为此项重构的结果，导入 collections 将不再自动导入 collections.abc。 如果你的程序依赖于这个（未写入文档的）隐式导入，你将需要添加显式的 import collections.abc (bpo-20784 [https://bugs.python.org/issue?@action=redirect&bpo=20784])。

C API 的变化

现在 PyEval_EvalFrameEx(), PyObject_Repr() 和 PyObject_Str() 以及其他一些内部 C API 都包括了一个调试断言，以确保它们不会在可能会静默地丢弃当前活动异常的情况下使用。 在预期并且希望丢弃活动异常的情况下（例如，由于已通过 PyErr_Fetch() 将其保存在本地或是有意将其替换为不同的异常 ），则需调用显式的 PyErr_Clear() 以避免在（直接或间接）唤起这些操作和针对启用断言编译的 Python 的版本运行时触发断言。

现在 PyErr_SetImportError() 在其 msg 参数未被设置时会设置 TypeError。 在之前版本中仅会返回 NULL 而不设置异常。

现在 PyOS_ReadlineFunctionPointer 回调的结果必须是一个由 PyMem_RawMalloc() 或 PyMem_RawRealloc() 分配的字符串，或者如果发生错误则为 NULL，而不是由 PyMem_Malloc() 或 PyMem_Realloc() 分配的字符串 (bpo-16742 [https://bugs.python.org/issue?@action=redirect&bpo=16742])

现在 PyThread_set_key_value() 总是会设置值。 在 Python 3.3 中，如果键已存在（如果当前值为非 NULL 指针）该函数将不执行任何操作。

PyFrameObject 结构体的 f_tstate (线程状态) 字段已被移除以修复一个程序错误；相关理由参见 bpo-14432 [https://bugs.python.org/issue?@action=redirect&bpo=14432]。

3.4.3 的变化

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

http.client 及其他依赖它的模块，比如 urllib.request 和 xmlrpc.client，现在将验证服务器是否提供了由平台信任的仓库中的 CA 签名的证书并且其主机名与默认被请求的主机名相匹配，这将显著提升许多应用程序的安全性。

对于需要之前版本的旧有行为的应用程序，可以传入一个替代的上下文:

import urllib.request
import ssl

# This disables all verification
context = ssl._create_unverified_context()

# This allows using a specific certificate for the host, which doesn't need
# to be in the trust store
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib.request.urlopen("https://invalid-cert", context=context)

Python 3.3 有什么新变化

本文介绍了 Python 3.3 相比 3.2 的新增特性。 Python 3.3 于 2012 年 9 月 29 日 发布。 有关完整详细信息，请参见 changelog [https://docs.python.org/3.3/whatsnew/changelog.html]。

参见

PEP 398 [https://www.python.org/dev/peps/pep-0398] - Python 3.3 发布计划

摘要 -- 发布重点

新的语法特性：

新增 yield from 表达式用于 生成器委托。

u'unicode' 语法重新被接受用于 str 对象。

新的库模块：

faulthandler (帮助调试低层级的崩溃)

ipaddress (代表 IP 地址和掩码的高层级对象)

lzma (使用 XZ / LZMA 算法压缩数据)

unittest.mock (使用模拟对象替换你的受测试系统中的某些部分)

venv (Python 虚拟环境，类似于流行的 virtualenv 包)

新的内置特性：

重写 I/O 异常的层次结构.

实现的改进：

基于 importlib 重写 import machinery

更紧凑的 Unicode 字符串。

更紧凑的 属性字典。

显著改进的库模块：

针对 decimal 模块的 C 加速器。

email 模块中更好的 Unicode 处理 (暂定)。

安全改进：

哈希随机化被默认启用。

请继续阅读有关面向用户的改变的详细清单。

PEP 405: 虚拟环境

虚拟环境有助于创建 独立的 Python 设置，同时共享全系统的基础安装，便于维护。 虚拟环境有自己的私有站点包（即本地安装的库），并可选择与系统范围的站点包分离。 虚拟环境的概念和实现 受到流行的``virtualenv`` 第三方 包 的启发，但受益于与解释器 核心更紧密的集成。

本 PEP 添加了 venv 模块用于编程访问，以及 pyvenv 脚本用于命令在线访问和管理。 Python 解释器会检查 pyvenv.cfg，文件的存在标志着虚拟环境目录树的基础。

参见

PEP 405 [https://www.python.org/dev/peps/pep-0405] - Python虚拟环境

PEP 由 Carl Meyer 撰写 ; 由 Carl Meyer 和 Vinay Sajip 实现。

PEP 420: 隐式命名空间包

原生支持不要求 __init__.py 标记文件和可以自动跨越多个路径节的包目录（灵感来自多个命名空间包的第三方方案，如 PEP 420 [https://www.python.org/dev/peps/pep-0420] 中所述）

参见

PEP 420 [https://www.python.org/dev/peps/pep-0420] - 隐式命名空间包

PEP 由 Eric V. Smith 撰写，由 Eric V. Smith 和 Barry Warsaw 实现

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

PEP 3118 [https://www.python.org/dev/peps/pep-3118] 的实现已获得大幅改进。

新的 memoryview 实现全面修复了 Py_buffer 结构体中曾导致多起崩溃报告的动态分配字段的所有权和生命周期问题。 此外，还修复了多个函数在非连续或多维输入时崩溃或返回不正确结果的问题。

现在 memoryview 对象具有符合 PEP-3118 标准的 getbufferproc()，可以检查使用者的请求类型。 新增了许多新的特性，其中的大部分已适用于非连续数组和带有子偏移量的数组。

文档已进行更新，清楚地列出了导出方和使用方的责任。 缓冲区请求旗标志被划分为基本旗标和复合旗标。 对非连续和多维的 NumPy 风格数组的内存布局进行了说明。

相关特性

现在 struct 模块语法中所有原生单字符格式指示符（可以选择添加 '@' 前缀）均受到支持。

在某些限制条件下，cast() 方法允许改变 C 连续数组的格式和形状。

任何数组类型都支持多维列表的表示形式。

任何数组类型都支持多维比较操作。

格式为 B、b 或 c 的可哈希（只读）类型的一维 memoryview 现在将是可哈希的。 （由 Antoine Pitrou 在 bpo-13411 [https://bugs.python.org/issue?@action=redirect&bpo=13411] 中贡献。）

Arbitrary slicing of any 1-D arrays type is supported. For example, it is now possible to reverse a memoryview in O(1) by using a negative step.

API 的变化

官方的最大维度数量限制已更改为 64。

空形状、区间和子偏移量的表示形式现在是空元组而不是 None。

现在对格式为 'B' (无符号字节型) 的 memoryview 元素的访问将返回一个整数（遵循结构体模块语法）。 要返回字节串对象则必须先将视图强制转换为 'c'。

现在 memoryview 比较将使用操作数的逻辑结构并会按值来比较所有数组元素。 结构体模块语法中的所有格式化字符串均受到支持。 带有不可识别的格式化字符串的视图仍然被允许，但无论视图内容如何比较结果总是不相等。

更多改变请参阅 Build and C API Changes 和 Porting C code。

（由 Stefan Krah 在 bpo-10181 [https://bugs.python.org/issue?@action=redirect&bpo=10181] 中贡献。）

参见

PEP 3118 [https://www.python.org/dev/peps/pep-3118] - 修改缓冲区协议

PEP 393: 灵活的字符串表示

Unicode字符串类型已改为支持多种内部表示法，具体取决于所表示的字符串中具有最大 Unicode 序号（1、2 或 4 字节）的字符 。 这样，在常见情况下可以节省空间，但在所有系统上都能使用完整的 UCS-4。 对于使用现有应用程序接口的兼容性 来说，可能会并行存在几种表示法；随着时间的推移，这种兼容性 应逐步淘汰。

在 Python 一方，此项改变应当没有任何缺点。

在 C API 方面，PEP 393 [https://www.python.org/dev/peps/pep-0393] 完全向下兼容。 旧的 API 至少还能使用五年。 使用传统 API 的应用程序不会完全受益于内存的减少，或者更糟的是，可能会使用更多的内存，因为 Python 可能需要维护每个字符串的两个版本（传统格式和新的高效存储）。

功能

由 PEP 393 [https://www.python.org/dev/peps/pep-0393] 引入的改变如下:

Python 现在始终支持全部 Unicode 码位，包括非 BMP 码位 (即从``U+0000`` 到 U+10FFFF)。 窄编译版本和宽编译版本之间的区别已不复存在，Python 现在的行为就像宽编译版本，甚至在 Windows 下也是如此。

随着窄编译版本的消亡，窄编译版本特有的问题也得到了解决，例如：

现在 len() 对于非 BMP 字符总是返回 1，因此 len('\U0010FFFF') == 1；

替换对不会在字符串字面值中重新合并，因此 '\uDBFF\uDFFF' != '\U0010FFFF'；

索引或切分非 BMP 字符会返回预期的值，因此 '\U0010FFFF'[0] 现在会返回 '\U0010FFFF' 而不是 '\uDBFF'；

标准库中的所有其他函数现在都能正确处理非 BMP 代码点。

The value of sys.maxunicode is now always 1114111 (0x10FFFF in hexadecimal). The PyUnicode_GetMax() function still returns either 0xFFFF or 0x10FFFF for backward compatibility, and it should not be used with the new Unicode API (see bpo-13054 [https://bugs.python.org/issue?@action=redirect&bpo=13054]).

./configure 标志 --with-wide-unicode 已被移除。

性能和资源使用情况

现在，Unicode 字符串的存储取决于字符串中的最高码位：

纯 ASCII 和 Latin1 字符串 (U+0000-U+00FF) 每个码位使用 1 个字节；

BMP 字符串 (U+0000-U+FFFF) 每个码位使用 2 个字节；

非 BMP 字符串 (U+10000-U+10FFFF) 每个码位使用 4 个字节。

这样做的效果是，对于大多数应用而言，字符串存储的内存使用量应该会大幅减少 —— 尤其是与以前的宽 unicode 版本相比 —— 因为在许多情况下，即使在国际环境中，字符串也将是纯 ASCII 格式（因为许多字符串存储的是非人类语言数据，如 XML 片段、HTTP 标头、JSON 编码数据等）。 出于同样的原因，我们还希望它能提高非小应用程序的 CPU 缓存效率。 在 Django 基准测试中，Python 3.3 的内存使用量比 Python 3.2 少两到三倍，比 Python 2.7 略好一些（详情请参见 PEP）。

参见

PEP 393 [https://www.python.org/dev/peps/pep-0393] - 灵活的字符串表示

PEP 由 Martin von Löwis 撰写 ; 由 Torsten Becker 和 Martin von Löwis 实现。

PEP 397: 适用于Windows的Python启动器

Python 3.3 的 Windows 安装程序现在包含一个 py 启动程序，可用于以版本无关的方式启动 Python 应用程序。

双击 *.py 文件时会隐式调用该启动器。 如果系统中只安装了一个 Python 版本，则将使用该版本运行文件。 如果安装了多个版本，则默认使用最新版本，但也可以通过在 Python 脚本中加入 Unix 风格的“shebang 行”来覆盖该版本。

启动器也可以作为 py 应用程序在命令行中显式使用。运行 py 遵循与隐式启动脚本相同的版本选择规则，但可以通过传递适当的参数来选择更具体的版本（例如，当 Python 2 也已安装时，使用 -3 来请求 Python 3；当安装了较新的 Python 版本时，使用 -2.6 来特别请求较早的 Python 版本）。

除了启动器之外，Windows 安装程序现在还包含一个选项，可将新安装的 Python 添加到系统 PATH 中。 （由 Brian Curtin 在 bpo-3561 [https://bugs.python.org/issue?@action=redirect&bpo=3561] 中贡献）。

参见

PEP 397 [https://www.python.org/dev/peps/pep-0397] - 适用于Windows的Python启动器

PEP 由 Mark Hammond 和 Martin v. Löwis 撰写 ; 由 Vinay Sajip实现。

启动器文档: 适用于Windows的Python启动器

安装器 PATH 修改: 查找Python可执行文件

PEP 3151: 重写 OS 和 IO 异常的层次结构

现在，由操作系统错误引发的异常层次结构既得到了简化，又更加精细。

您不必再为在 OSError、IOError、EnvironmentError、WindowsError、mmap.error、socket.error 或 select.error 之间选择合适的异常类型而烦恼。 所有这些异常类型现在都只有一个: OSError。 出于兼容性考虑，其他名称将作为别名保留。

此外，现在捕捉特定错误条件也更容易了。无需从 errno 模块中检查 errno 属性（或 args[0] ）中的特定常量，您可以捕捉适当的 OSError 子类。可用的子类如下：

BlockingIOError

ChildProcessError

ConnectionError

FileExistsError

FileNotFoundError

InterruptedError

IsADirectoryError

NotADirectoryError

PermissionError

ProcessLookupError

TimeoutError

并且 ConnectionError 本身具有细粒度的子类:

BrokenPipeError

ConnectionAbortedError

ConnectionRefusedError

ConnectionResetError

有了新的异常，现在就可以避免 errno 的常见用法了。 例如，下面是为 Python 3.2 编写的代码：

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

现在无需导入 errno，也无需手动检查异常属性：

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")

参见

PEP 3151 [https://www.python.org/dev/peps/pep-3151] - 重写 OS 和 IO 异常的层次结构

PEP 由 Antoine Pitrou 撰写并实现

PEP 380: 委托给子生成器的语法

PEP 380 增加了 yield from 表达式，允许 generator 将其部分操作委托给另一个生成器。 这样，包含 yield 的代码部分就可以被分解出来，放在另一个生成器中。 此外，还允许子生成器返回一个值，并将该值提供给委托生成器。

虽然 yield from 表达式主要用于委托给子生成器，但它实际上允许委托给任意子生成器。

对于简单的迭代器而言，yield from iterable 本质上只是 for item in iterable: yield item 的简写形式：

>>> 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]

但是，与普通的循环不同，yield from 允许子生成器直接从调用方作用域获取、发送和抛出值，并向外层生成器返回一个最终值:

>>> 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)  # Ensure the accumulator is ready to accept values
>>> for i in range(4):
...     acc.send(i)
...
>>> acc.send(None)  # Finish the first tally
>>> for i in range(5):
...     acc.send(i)
...
>>> acc.send(None)  # Finish the second tally
>>> tallies
[6, 10]

推动这项改变的主要原则是允许即便被设计用来配合 send 和 throw 方法使用的生成器也能像一个大函数能拆分成多个子函数那样容易地拆分为多个子生成器。

参见

PEP 380 [https://www.python.org/dev/peps/pep-0380] - 委托给子生成器的语法

PEP 由 Greg Ewing 撰写，由 Greg Ewing 实现。由 Renaud Blanch，Ryan Kelly 和 Nick Coghlan 集成到3.3，由 Zbigniew Jędrzejewski-Szmek 和 Nick Coghlan 编写文档

PEP 409: 清除异常上下文

PEP 409 引入了允许禁用串连的异常上下文显示的新语法。 这允许在不同异常类型间进行转换的应用程序具有更清晰的错误消息:

>>> 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

如果后面没有 from None 来屏蔽异常原因，则默认原始异常将被显示:

>>> 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

调试功能并未丢失，因为原始异常上下文在需要时仍然可用（举例来说，如果某个中间库不正确地抑制了有价值的下层细节）:

>>> try:
...     D({}).x
... except AttributeError as exc:
...     print(repr(exc.__context__))
...
KeyError('x',)

参见

PEP 409 [https://www.python.org/dev/peps/pep-0409] - 清除异常上下文

PEP 由 Ethan Furman 撰写 ，由 Ethan Furman 和 Nick Coghlan 实现。

PEP 414: 显式的Unicode文本

为使从 Python 2 迁移重度使用 Unicode 字面值的 Unicode 自适应型 Python 应用程序更为容易，Python 3.3 重新支持字符串字面值使用 "u" 前缀。 该前缀在 Python 3 中并无语法意义，提供它只是为了减少在迁移到 Python 3 时纯粹机械性的修改数量，让开发者能更轻松的关注更重要的语法变化（比如默认更严格的二进制和文本数据的区分）。

参见

PEP 414 [https://www.python.org/dev/peps/pep-0414] - 显式的Unicode文本

PEP 由 Armin Ronacher 撰写

PEP 3155: 类和函数的限定名称

Functions and class objects have a new __qualname__ attribute representing the "path" from the module top-level to their definition. For global functions and classes, this is the same as __name__. For other functions and classes, it provides better information about where they were actually defined, and how they might be accessible from the global scope.

包含（未绑定）方法的示例:

>>> class C:
...     def meth(self):
...         pass
>>> C.meth.__name__
'meth'
>>> C.meth.__qualname__
'C.meth'

包含嵌套类的示例:

>>> 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'

包含嵌套函数的示例:

>>> def outer():
...     def inner():
...         pass
...     return inner
...
>>> outer().__name__
'inner'
>>> outer().__qualname__
'outer.<locals>.inner'

这些对象的字符串表示形式也被修改以包括新的更准确的信息:

>>> str(C.D)
"<class '__main__.C.D'>"
>>> str(C.D.meth)
'<function C.D.meth at 0x7f46b9fe31e0>'

参见

PEP 3155 [https://www.python.org/dev/peps/pep-3155] - 类和函数的限定名称

PEP 由 Antoine Pitrou 撰写并实现

PEP 412: Key-Sharing Dictionary

用于存储对象属性的字典现在能够在彼此之间共享部分内部存储（比如说，存储键及其对应哈希值的部分）。 这减少了程序创建多个非内置类型实例的内存消耗。

参见

PEP 412 [https://www.python.org/dev/peps/pep-0412] - Key-Sharing Dictionary

PEP 由 Mark Shannon 撰写并实现。

PEP 362: 函数签名对象

新增的函数 inspect.signature() 使得对 python 可调用对象的内省更为简单直观。 多种可调用对象均受到支持：不论是否带装饰器的 python 函数，类以及 functools.partial() 对象。 新增的类 inspect.Signature, inspect.Parameter 和 inspect.BoundArguments 保存了有关调用签名的信息，如标注、默认值、形参类别和绑定参数等，这极大地简化了编写装饰器和其他任何验证或修改调用签名或参数的工作。

参见

PEP 362 [https://www.python.org/dev/peps/pep-0362]: - 函数签名对象

PEP 由 Brett Cannon，Yury Selivanov，Larry Hastings，Jiwon Seo 撰写，由 Yury Selivanov 实现

PEP 421: 添加 sys.implementation

A new attribute on the sys module exposes details specific to the implementation of the currently running interpreter. The initial set of attributes on sys.implementation are name, version, hexversion, and cache_tag.

sys.implementation 的目的是将标准库所使用的具体实现专属数据合并到一个命名空间中。 这允许不同的 Python 实现能更方便地共享同一个标准库基准代码。 在其初始状态中，sys.implementation 只保持具体实现专属数据的一小部分。 随着时间推移这个比例将进行调整以使标准库具有更好的可移植性。

标准库可移植性提高的一个例子是 cache_tag。 在 Python 3.3 中，sys.implementation.cache_tag 被 importlib 用来支持与 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 的一致性。 任何使用 importlib 来处理内置导入系统的 Python 实现都可使用 cache_tag 来控制各个模块的缓存行为。

SimpleNamespace

sys.implementation 的实现还为 Python 引入了一个新类型: types.SimpleNamespace。 相比基于映射的命名空间像是 dict，SimpleNamespace 是基于属性的，像是 object。 不过，与 object 不同，SimpleNamespace 实例是可写的。 这意味着你可以通过常规的属性访问来添加、移除和修改命名空间。

参见

PEP 421 [https://www.python.org/dev/peps/pep-0421] - 添加 sys.implementation

PEP 由 Eric Snow 撰写并实现

使用 importlib 作为导入的实现

bpo-2377 [https://bugs.python.org/issue?@action=redirect&bpo=2377] - Replace __import__ w/ importlib.__import__ bpo-13959 [https://bugs.python.org/issue?@action=redirect&bpo=13959] - Re-implement parts of imp in pure Python bpo-14605 [https://bugs.python.org/issue?@action=redirect&bpo=14605] - Make import machinery explicit bpo-14646 [https://bugs.python.org/issue?@action=redirect&bpo=14646] - Require loaders set __loader__ and __package__

现在 __import__() 函数是由 importlib.__import__() 驱动的。 这项工作标志着 PEP 302 [https://www.python.org/dev/peps/pep-0302] 的“第 2 阶段”的结束。 这一变化带来了许多好处。 首先，它允许更多驱动导入的机制对外公开而不是保持隐式并藏在 C 代码内部。 它还提供了单一的实现给所有支持 Python 3.3 的 Python VM 使用，有助于结束导入语义中有关特定 VM 的偏差。 最后它还减轻了导入的维护负担，以允许未来的更多改进。

对于普通用户来说，语义上的变化应该是不可见的。 对于目前直接操纵 import 或以程序方式调用 import 的代码来说，可能需要进行的代码修改将在本文档的 Porting Python code 一节中阐述。

新的API

此项工作的一个好处是对外公开了实现 import 语句所涉及的机制。 这意味着过去保持隐式的各种导入器现在都作为 importlib 包的组成部分被完整暴露出来。

The abstract base classes defined in importlib.abc have been expanded to properly delineate between meta path finders and path entry finders by introducing importlib.abc.MetaPathFinder and importlib.abc.PathEntryFinder, respectively. The old ABC of importlib.abc.Finder is now only provided for backwards-compatibility and does not enforce any method requirements.

In terms of finders, importlib.machinery.FileFinder exposes the mechanism used to search for source and bytecode files of a module. Previously this class was an implicit member of sys.path_hooks.

对于加载器，新的抽象基类 importlib.abc.FileLoader 可帮助编写使用文件系统作为模块代码的存储机制的加载器。 针对源代码的 (importlib.machinery.SourceFileLoader), 不带源代码的字节码文件的 (importlib.machinery.SourcelessFileLoader) 以及扩展模块的 (importlib.machinery.ExtensionFileLoader) 加载器现在均可被直接使用。

现在 ImportError 具有 name 和 path 属性并会在有相关数据要提供时被设置。 针对导入失败的消息现在也会提供模块的完整名称而不是仅有模块名称的末尾部分。

The importlib.invalidate_caches() function will now call the method with the same name on all finders cached in sys.path_importer_cache to help clean up any stored state as necessary.

可见的改变

对于可能需要修改的代码，请参阅 Porting Python code 一节。

Beyond the expanse of what importlib now exposes, there are other visible changes to import. The biggest is that sys.meta_path and sys.path_hooks now store all of the meta path finders and path entry hooks used by import. Previously the finders were implicit and hidden within the C code of import instead of being directly exposed. This means that one can now easily remove or change the order of the various finders to fit one's needs.

另一个变化是所有模块都具有 __loader__ 属性，它储存被用于创建该模块的加载器。 PEP 302 [https://www.python.org/dev/peps/pep-0302] 已被更新以强制要求加载器实现该属性，因此未来的第 3 方加载器一旦被更新人们将能确定该属性的存在。 但在此之前，import 都需要在加载之后设置模块。

加载器现在还需要根据 PEP 366 [https://www.python.org/dev/peps/pep-0366] 设置 __package__ 属性。 同样地，import 本身已经在所有来自 importlib 的加载器上设置了该属性并且 import 是在加载之后自行设置该属性。

None is now inserted into sys.path_importer_cache when no finder can be found on sys.path_hooks. Since imp.NullImporter is not directly exposed on sys.path_hooks it could no longer be relied upon to always be available to use as a value representing no finder found.

有关语法变化的所有其他修改在为 Python 3.3 更新代码时都应当被纳入考虑，因此应当仔细阅读本文档的 Porting Python code 章节。

（由 Brett Cannon 编写的实现）

其他语言特性修改

对Python 语言核心进行的小改动：

Added support for Unicode name aliases and named sequences. Both unicodedata.lookup() and '\N{...}' now resolve name aliases, and unicodedata.lookup() resolves named sequences too.

（由 Ezio Melotti 在 bpo-12753 [https://bugs.python.org/issue?@action=redirect&bpo=12753] 中贡献。）

Unicode 数据库更新至 UCD 版本 6.1.0

现在 range() 对象的相等性比较将返回反映下层的由这些 range 对象生成的序列的相等性的结果。 (bpo-13201 [https://bugs.python.org/issue?@action=redirect&bpo=13201])

现在 bytes 和 bytearray 对象的 count(), find(), rfind(), index() 和 rindex() 方法将接受一个 0 到 255 范围内的整数作为其第一个参数。

（由 Petri Lehtinen 在 bpo-12170 [https://bugs.python.org/issue?@action=redirect&bpo=12170] 中贡献。）

现在 bytes 和 bytearray 的 rjust(), ljust() 和 center() 方法将接受一个 bytearray 作为 fill 参数。 （由 Petri Lehtinen 在 bpo-12380 [https://bugs.python.org/issue?@action=redirect&bpo=12380] 中贡献。）

New methods have been added to list and bytearray: copy() and clear() (bpo-10516 [https://bugs.python.org/issue?@action=redirect&bpo=10516]). Consequently, MutableSequence now also defines a clear() method (bpo-11388 [https://bugs.python.org/issue?@action=redirect&bpo=11388]).

原始字节串字面值现在可以写成 rb"..." 也可以写成 br"..."。

（由 Antoine Pitrou 在 bpo-13748 [https://bugs.python.org/issue?@action=redirect&bpo=13748] 中贡献。）

现在 dict.setdefault() 对给定的键将只执行一次查找，这使其在配合内置类型使用时是原子化的。

（由 Filip Gruszczyński 在 bpo-13521 [https://bugs.python.org/issue?@action=redirect&bpo=13521] 中贡献。）

当函数调用与函数签名不匹配时产生的错误消息已获得大幅改进。

（由 Benjamin Peterson 贡献。）

更细粒度的导入锁

之前版本的 CPython 是始终依赖于全局导入锁的。 这会导致预料之外的困扰，比如当导入一个模块会触发代码在其他线程中执行作为附带影响导致的死锁。 有时需要应用一些笨拙的绕过方式，比如 PyImport_ImportModuleNoBlock() C API 函数。

在 Python 3.3 中，导入一个模块会使用单独的模块级锁。 这能正确地从多个线程序列化给定模块的导入操作（防止出现被不完整初始化的模块），同时消除之前提到的困扰。

（由 Antoine Pitrou 在 bpo-9260 [https://bugs.python.org/issue?@action=redirect&bpo=9260] 中贡献。）

内置函数和类型

open() gets a new opener parameter: the underlying file descriptor for the file object is then obtained by calling opener with (file, flags). It can be used to use custom flags like os.O_CLOEXEC for example. The 'x' mode was added: open for exclusive creation, failing if the file already exists.

print(): 增加了 flush 关键字参数。 如果 flush 关键字参数为真值，流会被强制刷新。

hash(): 默认将启用哈希随机化，参见 object.__hash__() 和 PYTHONHASHSEED。

str 类型新增了一个 casefold() 方法：返回字符串的大小写折叠副本，大小写折叠形式的字符串可被用于不区分大小写的匹配。 例如，'ß'.casefold() 将返回 'ss'。

序列的文档已被大幅重写以更好地解释二进制/序列的区别并为各种内置序列类型提供专属的文档章节 (bpo-4966 [https://bugs.python.org/issue?@action=redirect&bpo=4966])。

新增模块

faulthandler

新增的调试模块 faulthandler 包含用于在发生错误（如段错误之类的程序崩溃），达到超时限制或收到用户信号时显式转储 Python 回溯的函数。 调用 faulthandler.enable() 可安装针对 SIGSEGV, SIGFPE, SIGABRT, SIGBUS, 和 SIGILL 信号的错误处理器。 你还可以在启动时通过设置 PYTHONFAULTHANDLER 环境变量或使用 -X faulthandler 命令行选项来启用它们。

Linux 上的段错误示例:

$ 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

ipaddress

新的 ipaddress 模块提供了用于创建和操作代表 IPv4 和 IPv6 地址、网络和接口（即关联到特定 IP 子网的 IP 地址）的工具。

（由 Google 和 Peter Moody 在 bpo-3144 [https://bugs.python.org/issue?@action=redirect&bpo=3144] 中贡献。）

lzma

新增的 lzma 模块提供了使用 LZMA 算法的数据压缩和解压，包括对 .xz 和 .lzma 文件格式的支持。

（由 Nadeem Vawda 和 Per Øyvind Karlsen 在 bpo-6715 [https://bugs.python.org/issue?@action=redirect&bpo=6715] 中贡献。）

改进的模块

abc

Improved support for abstract base classes containing descriptors composed with abstract methods. The recommended approach to declaring abstract descriptors is now to provide __isabstractmethod__ as a dynamically updated property. The built-in descriptors have been updated accordingly.

abc.abstractproperty 已被弃用，改为 property 配合 abc.abstractmethod() 使用。

abc.abstractclassmethod 已被弃用，改为 classmethod 配合 abc.abstractmethod() 使用。

abc.abstractstaticmethod 已被弃用，改为 staticmethod 配合 abc.abstractmethod() 使用。

（由 Pablo Galindo 在 bpo-11610 [https://bugs.python.org/issue?@action=redirect&bpo=11610] 中贡献。）

现在 abc.ABCMeta.register() 将返回已注册的子类，这意味着它现在可被用作类装饰器 (bpo-10868 [https://bugs.python.org/issue?@action=redirect&bpo=10868])。

array

array 模块可使用 q 和 Q 类型码支持 long long 类型。

（由 Oren Tirosh 和 Hirokazu Yamamoto 在 bpo-1172711 [https://bugs.python.org/issue?@action=redirect&bpo=1172711] 中贡献。）

base64

现在 base64 现代接口的解码函数可接受仅包含 ASCII 字符的 Unicode 字符串。 例如，base64.b64decode('YWJj') 将返回 b'abc'。 （由 Catalin Iacob 在 bpo-13641 [https://bugs.python.org/issue?@action=redirect&bpo=13641] 中贡献。）

binascii

除了它们通常接受的二进制对象，a2b_ 现在还接受仅包含 ASCII 字符的字符串作为输入。 （由 Antoine Pitrou 在 bpo-13637 [https://bugs.python.org/issue?@action=redirect&bpo=13637] 中贡献。）

bz2

bz2 模块已被重新编写。 在此过程中，添加了一些新的特征:

新的 bz2.open() 函数：以二进制或文本模式打开 bzip2 压缩文件。

bz2.BZ2File 现在可以读写任意文件型对象，具体方式是通过其构造器的 fileobj 参数。

（由 Nadeem Vawda 在 bpo-5863 [https://bugs.python.org/issue?@action=redirect&bpo=5863] 中贡献。）

现在 bz2.BZ2File 和 bz2.decompress() 能解压缩多流输入（比如由 pbzip2 工具所产生的输入）。 bz2.BZ2File 现在还可被用来创建这种类型的文件，具体做法是使用 'a' (append) 模式。

（由 Nir Aides 在 bpo-1625 [https://bugs.python.org/issue?@action=redirect&bpo=1625] 中贡献。）

bz2.BZ2File now implements all of the io.BufferedIOBase API, except for the detach() and truncate() methods.

编码器

mbcs 编解码器被重写以能够在所有 Windows 版本上正确处理 replace 和 ignore 错误处理器。 mbcs 编解码器现在支持所有错误处理器，而不是仅支持将 replace 用于编码并将 ignore 用于解码。

新增了一个 Windows 专属的编解码器: cp65001 (bpo-13216 [https://bugs.python.org/issue?@action=redirect&bpo=13216])。 即 Windows 代码页 65001 (Windows UTF-8, CP_UTF8)。 举例来说，如果控制台输出代码页被设为 cp65001（例如使用 chcp 65001 命令）则 sys.stdout 就会使用它。

多字节 CJK 解码器现在能更快地进行再同步。 它们将只忽略非法字节序列的第一个字节。 例如，现在 b'\xff\n'.decode('gb2312', 'replace') 将在替换字符后返回一个 \n。

(bpo-12016 [https://bugs.python.org/issue?@action=redirect&bpo=12016])

增量式 CJK 编解码器的编码器在每次调用其 encode() 方法时将不再重置。 例如:

>>> import codecs
>>> encoder = codecs.getincrementalencoder('hz')('strict')
>>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
b'~{NpJ)l6HK!#~} Bye.'

对于旧版 Python 此示例将给出 b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'。

(bpo-12100 [https://bugs.python.org/issue?@action=redirect&bpo=12100])

unicode_internal 编解码器已被弃用。

collections

新增了一个 ChainMap 类以允许将多个映射当作一个单元来处理。 （由 Raymond Hettinger 针对 bpo-11089 [https://bugs.python.org/issue?@action=redirect&bpo=11089] 编写，在 bpo-11297 [https://bugs.python.org/issue?@action=redirect&bpo=11297] 中对外公开。）

抽象基类已被移至新的 collections.abc 模块，以便更好地区分抽象和具体集合类。为了保留现有的导入，ABC 的别名仍然存在于 collections 模块中。(bpo-11085 [https://bugs.python.org/issue?@action=redirect&bpo=11085])

Counter 类现在支持一元 + 和 - 运算符，以及就地运算符 +=、-=、|= 和 &=。（由 Raymond Hettinger在 bpo-13121 [https://bugs.python.org/issue?@action=redirect&bpo=13121] 中贡献。）

contextlib

ExitStack 现在为程序化操作上下文管理器及类似的清理功能提供了坚实的基础。与之前的 contextlib.nested API（已被弃用并移除）不同，新 API 设计为上下文管理器无论是在其 __init__ 方法中获取资源（例如，文件对象）还是在 __enter__ 方法中获取资源（例如，来自 threading 模块的同步对象）都能正确工作。

(bpo-13585 [https://bugs.python.org/issue?@action=redirect&bpo=13585])

crypt

Addition of salt and modular crypt format (hashing method) and the mksalt() function to the crypt module.

(bpo-10924 [https://bugs.python.org/issue?@action=redirect&bpo=10924])

curses

If the curses module is linked to the ncursesw library, use Unicode functions when Unicode strings or characters are passed (e.g. waddwstr()), and bytes functions otherwise (e.g. waddstr()).

使用区域设置编码而不是 utf-8 来编码 Unicode 字符串。

curses.window 添加了新的 curses.window.encoding 属性。

curses.window 类有一个新的 get_wch() 方法用来获取一个宽字符。

curses 模块有一个新的 unget_wch() 函数用来推入一个宽字符以便下一个 get_wch() 将返回它。

（由 Iñigo Serna 在 bpo-6755 [https://bugs.python.org/issue?@action=redirect&bpo=6755] 中贡献。）

datetime

在朴素型（naive-无时区）和感知型（aware-带时区）的 datetime 实例之间进行相等比较时，现在会直接返回 False，而不再抛出 TypeError 异常（参见 bpo-15006 [https://bugs.python.org/issue?@action=redirect&bpo=15006]）。

新的 datetime.datetime.timestamp() 方法：返回与 datetime 实例对应的 POSIX 时间戳。

datetime.datetime.strftime() 方法支持格式化早于 1000 年的年份。

datetime.datetime.astimezone() 方法现在可以不带参数调用，以将 datetime 实例转换为系统时区。

decimal

bpo-7652 [https://bugs.python.org/issue?@action=redirect&bpo=7652] - 集成了快速的本地十进制算术。

C模块和libmpdec由Stefan Krah编写。

The new C version of the decimal module integrates the high speed libmpdec library for arbitrary precision correctly rounded decimal floating point arithmetic. libmpdec conforms to IBM's General Decimal Arithmetic Specification.

Performance gains range from 10x for database applications to 100x for numerically intensive applications. These numbers are expected gains for standard precisions used in decimal floating point arithmetic. Since the precision is user configurable, the exact figures may vary. For example, in integer bignum arithmetic the differences can be significantly higher.

下表只用于简单展示。 基准测试详情参见 https://www.bytereef.org/mpdecimal/quickstart.html。

| decimal.py | _decimal | 加速
pi | 42.02秒 | 0.345秒 | 120倍
telco | 172.19秒 | 5.68秒 | 30倍
psycopg | 3.57秒 | 0.29秒 | 12倍

相关特性

FloatOperation 信号可选择启用针对混用 float 和 Decimal 时更严格的语义限制。

If Python is compiled without threads, the C version automatically disables the expensive thread local context machinery. In this case, the variable HAVE_THREADS is set to False.

API 的变化

C模块上下文限制（如下表），具体取决于计算机体系结构：

| 32位 | 64位
MAX_PREC | 425000000 | 999999999999999999
MAX_EMAX | 425000000 | 999999999999999999
MIN_EMIN | -425000000 | -999999999999999999

In the context templates (DefaultContext, BasicContext and ExtendedContext) the magnitude of Emax and Emin has changed to 999999.

decimal.py中的 Decimal 构造函数不遵守上下文限制，并精确转换具有任意指数或精度的值。由于C版本有内部限制，采用以下方案：如果可能，值将精确转换，否则会引发 InvalidOperation 异常，结果为NaN。在后一种情况下，总是可以使用 create_decimal() 来获得一个四舍五入或不精确的值。

decimal.py中的幂函数总是正确四舍五入的。在C版本中，它是根据正确四舍五入的 exp() 和 ln() 函数定义的，但最终结果只是“几乎总是正确四舍五入”。

在C版本中，包含信号的上下文字典是一个 MutableMapping。出于速度原因，flags 和 traps 始终引用与上下文初始化时相同的 MutableMapping。如果分配了新的信号字典，flags 和 traps 会使用新值进行更新，但不引用右侧的字典。

对 Context 进行序列化会产生不同的输出，以便为 Python 和 C 版本提供一个通用的交换格式。

Context 构造函数中的参数顺序已更改，以匹配 repr() 显示的顺序。

quantize() 方法的 watchexp 形参已被弃用。

email

策略框架

电子邮件包现在有一个 policy 框架。Policy 是一个具有多个方法和属性的对象，用于控制电子邮件包的行为。Python 3.3 的主要策略是 Compat32 策略，它提供了与 Python 3.2 中的电子邮件包的向后兼容性。可以在解析电子邮件消息时通过 parser 指定 policy，或在创建 Message 对象时指定，或在通过 generator 序列化电子邮件时指定。除非被覆盖，否则传递给 parser 的策略将由该 parser 创建的所有 Message 对象和子对象继承。默认情况下，generator 将使用其序列化的 Message 对象的策略。默认策略是 compat32。

所有 policy 对象实现的最小控制集是：

max_line_length | 当 Message 被序列化时，单个行的最大长度（不包括行分隔符字符）。默认为 78。
linesep | 当 Message 被序列化时，用于分隔单个行的字符。默认为 \n。
cte_type | 7bit 或 8bit。8bit 仅适用于 Bytes generator，意味着在协议允许的情况下（或原始输入中存在时）可以使用非 ASCII 字符。
raise_on_defect | 导致一个 parser 在遇到缺陷时引发错误而不是将它们添加到 Message 对象的 defects 列表。

使用策略对象的 clone() 方法可以创建一个具有新设置的新策略实例。clone 方法接受上述任何控制作为关键字参数。在调用中未指定的任何控制将保留其默认值。因此，您可以创建一个使用 \r\n 行分隔符字符的策略，如下所示：

mypolicy = compat32.clone(linesep='\r\n')

策略可用于简化生成符合应用程序所需格式的消息的过程。您不必在所有调用“生成器”的地方都记住指定 linesep='\r\n'，而可以在设置“解析器”或“消息”使用的策略时一次性指定，无论您的程序使用哪一个来创建“消息”对象。另一方面，如果需要生成多种格式的消息，您仍然可以在相应的“生成器”调用中指定参数。或者，您可以为不同情况创建自定义策略实例，并在创建“生成器”时传递这些实例。

带有新头部API的暂行策略

尽管策略框架本身很有价值，但引入它的主要动机是允许创建新策略，这些策略以保持向后兼容性的方式为电子邮件包实现新功能，适用于那些不使用新策略的用户。由于新策略引入了新的 API，我们在 Python 3.3 中将其作为 暂行策略 发布。如果核心开发人员认为有必要，可能会发生向后不兼容的更改（包括代码的移除）。

新策略是 EmailPolicy 的实例，并添加了以下附加控制：

refold_source | 控制是否由 parser 解析的头部由 generator 重新折叠。它可以设置为 none、long 或 all。默认值为 long，意味着源头部中长度超过 max_line_length 的行将被重新折叠。none 表示没有行被重新折叠，all 表示所有行都被重新折叠。
header_factory | 一个可调用对象，它接受一个``name``和``value``，并生成一个自定义的头部对象。

header_factory 是新策略提供新功能的关键。当使用其中一个新策略时，从 Message 对象检索到的任何头部都是一个由 header_factory 产生的对象，并且每次在 Message 上设置头部时，它都会变成一个由 header_factory 产生的对象。所有这些头部对象都有一个等于头部名称的 name 属性。地址和日期头部有额外的属性，可以让你访问头部的解析数据。这意味着你现在可以做一些类似以下的事情：

>>> 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

你会注意到，当消息被序列化时，unicode 显示名称会自动编码为 utf-8，但当直接访问头部时，你会得到 unicode 版本。这消除了处理 email.header 的 decode_header() 或 make_header() 函数的任何需要。

你也可以从部分创建地址：

>>> 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>

自动进行解码到 unicode：

>>> m2 = message_from_string(str(m))
>>> m2['to']
'Éric <foo@example.com>'

当您解析消息时，可以使用头部对象的“addresses”和“groups”属性来访问组和单个地址:

>>> 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'),))

总结来说，如果您使用新的策略之一，头部操作将按预期工作：您的应用程序使用unicode字符串，而email包透明地将unicode编码和解码为RFC标准内容传输编码。

其他API更改

新增 BytesHeaderParser，添加到 parser 模块中，以补充 HeaderParser 并完善Bytes API。

新实用函数：

format_datetime()：给定一个 datetime，生成一个格式化的字符串，用于电子邮件头部。

parsedate_to_datetime()：给定一个来自电子邮件头部的日期字符串，将其转换为带时区的 datetime，如果偏移量为“-0000”，则转换为不带时区的 datetime。

localtime()：无参数时，返回当前本地时间作为一个带时区的 datetime，使用本地 timezone。给定一个带时区的 datetime，将其转换为使用本地 timezone 的带时区的 datetime。

ftplib

现在 ftplib.FTP 接受一个 source_address 关键字参数用于在创建外发套接字时指定 (host, port) 作为绑定调用中的源地址。 （由 Giampaolo Rodolà 在 bpo-8594 [https://bugs.python.org/issue?@action=redirect&bpo=8594] 中贡献。）

FTP_TLS 类现在提供了一个新的 ccc() 函数，用于将控制通道恢复为明文。这对于利用知道如何处理非安全 FTP 的 NAT 防火墙而无需打开固定端口非常有用。（由 Giampaolo Rodolà 在 bpo-12139 [https://bugs.python.org/issue?@action=redirect&bpo=12139] 中贡献。）

添加了 ftplib.FTP.mlsd() 方法，该方法提供了一种可解析的目录列表格式，并弃用了 ftplib.FTP.nlst() 和 ftplib.FTP.dir() 方法。（由 Giampaolo Rodolà 在 bpo-11072 [https://bugs.python.org/issue?@action=redirect&bpo=11072] 中贡献。）

functools

functools.lru_cache() 装饰器现在接受一个 typed 关键字参数（默认为 False），以确保将比较相等的不同类型的值缓存在单独的缓存槽中。（由 Raymond Hettinger 在 bpo-13227 [https://bugs.python.org/issue?@action=redirect&bpo=13227] 中贡献。）

gc

现在可以通过新的 callbacks 列表注册垃圾收集器在收集前后调用的回调函数。

hmac

添加了新的 compare_digest() 函数，以防止通过时间分析对摘要进行侧信道攻击。（由 Nick Coghlan 和 Christian Heimes 在 bpo-15061 [https://bugs.python.org/issue?@action=redirect&bpo=15061] 中贡献。）

http

http.server.BaseHTTPRequestHandler 现在缓冲头部信息，并在调用 end_headers() 时一次性写入所有头部信息。新的方法 flush_headers() 可以用于直接管理累积头部信息的发送时间。（由 Andrew Schaaf 在 bpo-3709 [https://bugs.python.org/issue?@action=redirect&bpo=3709] 中贡献。）

http.server 现在生成有效的 HTML 4.01 strict 输出。（由 Ezio Melotti 在 bpo-13295 [https://bugs.python.org/issue?@action=redirect&bpo=13295] 中贡献。）

http.client.HTTPResponse 现在有一个 readinto() 方法，这意味着它可以作为 io.RawIOBase 类使用。（由 John Kuhn 在 bpo-13464 [https://bugs.python.org/issue?@action=redirect&bpo=13464] 中贡献。）

html

html.parser.HTMLParser is now able to parse broken markup without raising errors, therefore the strict argument of the constructor and the HTMLParseError exception are now deprecated. The ability to parse broken markup is the result of a number of bug fixes that are also available on the latest bug fix releases of Python 2.7/3.2. (Contributed by Ezio Melotti in bpo-15114 [https://bugs.python.org/issue?@action=redirect&bpo=15114], and bpo-14538 [https://bugs.python.org/issue?@action=redirect&bpo=14538], bpo-13993 [https://bugs.python.org/issue?@action=redirect&bpo=13993], bpo-13960 [https://bugs.python.org/issue?@action=redirect&bpo=13960], bpo-13358 [https://bugs.python.org/issue?@action=redirect&bpo=13358], bpo-1745761 [https://bugs.python.org/issue?@action=redirect&bpo=1745761], bpo-755670 [https://bugs.python.org/issue?@action=redirect&bpo=755670], bpo-13357 [https://bugs.python.org/issue?@action=redirect&bpo=13357], bpo-12629 [https://bugs.python.org/issue?@action=redirect&bpo=12629], bpo-1200313 [https://bugs.python.org/issue?@action=redirect&bpo=1200313], bpo-670664 [https://bugs.python.org/issue?@action=redirect&bpo=670664], bpo-13273 [https://bugs.python.org/issue?@action=redirect&bpo=13273], bpo-12888 [https://bugs.python.org/issue?@action=redirect&bpo=12888], bpo-7311 [https://bugs.python.org/issue?@action=redirect&bpo=7311].)

新增了一个 html5 字典，该字典将 HTML5 命名字符引用映射到等效的 Unicode 字符（例如 html5['gt;'] == '>'），已添加到 html.entities 模块中。该字典现在也被 HTMLParser 使用。（由 Ezio Melotti 贡献，相关 issue：bpo-11113 [https://bugs.python.org/issue?@action=redirect&bpo=11113] 和 bpo-15156 [https://bugs.python.org/issue?@action=redirect&bpo=15156]。）

imaplib

IMAP4_SSL 构造函数现在接受一个 SSLContext 参数，用于控制安全通道的参数。

（由 Sijin Joseph 在 bpo-8808 [https://bugs.python.org/issue?@action=redirect&bpo=8808] 中贡献。）

inspect

新增了一个 getclosurevars() 函数。此函数报告从函数体中引用的所有名称的当前绑定以及这些名称的解析位置，使得在测试依赖于有状态闭包的代码时，更容易验证正确的内部状态。

（由 Meador Inge 和 Nick Coghlan 在 bpo-13062 [https://bugs.python.org/issue?@action=redirect&bpo=13062] 中贡献。）

新增了一个 getgeneratorlocals() 函数。此函数报告生成器堆栈帧中局部变量的当前绑定，使得在测试生成器时，更容易验证正确的内部状态。

（由 Meador Inge 在 bpo-15153 [https://bugs.python.org/issue?@action=redirect&bpo=15153] 中贡献。）

io

open() 函数新增了一个 'x' 模式，可用于独占地创建新文件，如果文件已存在，则引发 FileExistsError。它基于 C11 中 fopen() 的 'x' 模式。

（由 David Townshend 在 bpo-12760 [https://bugs.python.org/issue?@action=redirect&bpo=12760] 中贡献。）

The constructor of the TextIOWrapper class has a new write_through optional argument. If write_through is True, calls to write() are guaranteed not to be buffered: any data written on the TextIOWrapper object is immediately handled to its underlying binary buffer.

itertools

accumulate() 现在接受一个可选的 func 参数，用于提供用户定义的二元函数。

logging

basicConfig() 函数现在支持一个可选的 handlers 参数，该参数接受一个可迭代的处理器列表，用于添加到根记录器。

A class level attribute append_nul has been added to SysLogHandler to allow control of the appending of the NUL (\000) byte to syslog records, since for some daemons it is required while for others it is passed through to the log.

math

math 模块新增了一个函数 log2()，它返回 x 的以 2 为底的对数。

（由 Mark Dickinson 在 bpo-11888 [https://bugs.python.org/issue?@action=redirect&bpo=11888] 中编写。）

mmap

现在 read() 方法能更好地兼容其他文件型对象：如果参数被省略或指定为 None，它将返回从当前文件位置到映射对象末尾的字节数据。 （由 Petri Lehtinen 在 bpo-12021 [https://bugs.python.org/issue?@action=redirect&bpo=12021] 中贡献。）

multiprocessing

新增的 multiprocessing.connection.wait() 函数允许附带超时限制轮询多个对象（如连接、套接字和管道）。 （由 Richard Oudkerk 在 bpo-12328 [https://bugs.python.org/issue?@action=redirect&bpo=12328] 中贡献。）

现在 multiprocessing.Connection 对象可通过多进程连接进行传输。 （由 Richard Oudkerk 在 bpo-4892 [https://bugs.python.org/issue?@action=redirect&bpo=4892] 中贡献。）

现在 multiprocessing.Process 可接受 daemon 关键字参数来覆盖继承来自父进程的 daemon 旗标的默认行为 (bpo-6064 [https://bugs.python.org/issue?@action=redirect&bpo=6064])。

新增的属性 multiprocessing.Process.sentinel 允许程序使用适当的 OS 原语来同时等待多个 Process 对象 (例如，在 posix 系统上是使用 select )。

新增的方法 multiprocessing.pool.Pool.starmap() 和 starmap_async() 提供了针对现有 multiprocessing.pool.Pool.map() 和 map_async() 函数的 itertools.starmap() 对应物。 （由 Hynek Schlawack 在 bpo-12708 [https://bugs.python.org/issue?@action=redirect&bpo=12708] 中贡献。）

nntplib

The nntplib.NNTP class now supports the context management protocol to unconditionally consume socket.error exceptions and to close the NNTP connection when done:

>>> 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')
>>>

（由 Giampaolo Rodolà 在 bpo-9795 [https://bugs.python.org/issue?@action=redirect&bpo=9795] 中贡献。）

os

The os module has a new pipe2() function that makes it possible to create a pipe with O_CLOEXEC or O_NONBLOCK flags set atomically. This is especially useful to avoid race conditions in multi-threaded programs.

os 模块新增了一个 sendfile() 函数，提供了一种高效的“零拷贝”方式来将数据从一个文件（或套接字）描述符复制到另一个描述符。所谓“零拷贝”是指所有数据在两个描述符之间的复制完全由内核完成，无需将数据复制到用户空间缓冲区。sendfile() 可用于高效地将磁盘上的文件数据复制到网络套接字，例如用于下载文件。

（由 Ross Lagerwall 和 Giampaolo Rodolà 在 bpo-10882 [https://bugs.python.org/issue?@action=redirect&bpo=10882] 中提交的补丁。）

为了避免诸如符号链接攻击和临时文件及目录的问题，操作文件描述符比操作文件名更可靠（也更快）。Python 3.3 增强了现有函数并引入了新函数来处理文件描述符（bpo-4761 [https://bugs.python.org/issue?@action=redirect&bpo=4761]，bpo-10755 [https://bugs.python.org/issue?@action=redirect&bpo=10755] 和 bpo-14626 [https://bugs.python.org/issue?@action=redirect&bpo=14626]）。

os 模块新增了一个 fwalk() 函数，类似于 walk()，但它还会生成引用访问过的目录的文件描述符。这对于避免符号链接竞争条件特别有用。

The following functions get new optional dir_fd (paths relative to directory descriptors) and/or follow_symlinks (not following symlinks): access(), chflags(), chmod(), chown(), link(), lstat(), mkdir(), mkfifo(), mknod(), open(), readlink(), remove(), rename(), replace(), rmdir(), stat(), symlink(), unlink(), utime(). Platform support for using these parameters can be checked via the sets os.supports_dir_fd and os.supports_follows_symlinks.

以下函数现在支持使用文件描述符作为其路径参数：chdir()，chmod()，chown()，execve()，listdir()，pathconf()，exists()，stat()，statvfs()，utime()。平台对此的支持可以通过集合 os.supports_fd 检查。

access() 接受一个 effective_ids 关键字参数，以在访问检查中使用有效 uid/gid 而不是真实 uid/gid。平台对此的支持可以通过集合 supports_effective_ids 检查。

os 模块新增了两个函数：getpriority() 和 setpriority()。它们可以用来获取或设置进程的优先级/友好度，类似于 os.nice()，但扩展到所有进程而不仅仅是当前进程。

（由 Giampaolo Rodolà 在 bpo-10784 [https://bugs.python.org/issue?@action=redirect&bpo=10784] 中提交的补丁。）

新的 os.replace() 函数允许跨平台重命名文件，并覆盖目标文件。使用 os.rename() 时，在 POSIX 下会覆盖现有目标文件，但在 Windows 下会引发错误。（由 Antoine Pitrou 在 bpo-8828 [https://bugs.python.org/issue?@action=redirect&bpo=8828] 中贡献。）

stat 系列函数（stat()，fstat() 和 lstat()）现在支持以纳秒精度读取文件的时间戳。相应地，utime() 现在可以以纳秒精度写入文件时间戳。（由 Larry Hastings 贡献，见 bpo-14127 [https://bugs.python.org/issue?@action=redirect&bpo=14127]。）

新的 os.get_terminal_size() 函数查询附加到文件描述符的终端大小。另请参见 shutil.get_terminal_size()。（由 Zbigniew Jędrzejewski-Szmek 贡献，见 bpo-13609 [https://bugs.python.org/issue?@action=redirect&bpo=13609]。）

支持 Linux 扩展属性的新函数（bpo-12720 [https://bugs.python.org/issue?@action=redirect&bpo=12720]）：getxattr()，listxattr()，removexattr()，setxattr()。

新的调度器接口。这些函数控制操作系统如何为进程分配 CPU 时间。新函数包括：sched_get_priority_max()，sched_get_priority_min()，sched_getaffinity()，sched_getparam()，sched_getscheduler()，sched_rr_get_interval()，sched_setaffinity()，sched_setparam()，sched_setscheduler()，sched_yield()，

控制文件系统的新函数：

posix_fadvise()：宣布以特定模式访问数据的意图，从而允许内核进行优化。

posix_fallocate()：确保为文件分配足够的磁盘空间。

sync()：强制将所有内容写入磁盘。

其他新的 POSIX 函数：

lockf()：对打开的文件描述符应用、测试或移除 POSIX 锁。

pread()：从文件描述符的偏移量处读取，文件偏移量保持不变。

pwrite()：从偏移量处写入文件描述符，文件偏移量保持不变。

readv()：从文件描述符读取到多个可写缓冲区。

truncate()：截断与 path 对应的文件，使其大小最多为 length 字节。

waitid(): 等待一个或多个子进程的完成。

writev(): 将*buffers*的内容写入文件描述符，其中*buffers*是任意序列的缓冲区。

getgrouplist() (bpo-9344 [https://bugs.python.org/issue?@action=redirect&bpo=9344]): 返回指定用户所属的组ID列表。

times() 和 uname(): 返回类型从元组更改为具有命名属性的类元组对象。

一些平台现在支持 lseek() 函数的额外常量，例如 os.SEEK_HOLE 和 os.SEEK_DATA。

New constants RTLD_LAZY, RTLD_NOW, RTLD_GLOBAL, RTLD_LOCAL, RTLD_NODELETE, RTLD_NOLOAD, and RTLD_DEEPBIND are available on platforms that support them. These are for use with the sys.setdlopenflags() function, and supersede the similar constants defined in ctypes and DLFCN. (Contributed by Victor Stinner in bpo-13226 [https://bugs.python.org/issue?@action=redirect&bpo=13226].)

os.symlink() 现在接受（并忽略）非Windows平台上的 target_is_directory 关键字参数，以简化跨平台支持。

pdb

Tab 补全现在不仅适用于命令名称，也适用于它们的参数。 例如，对于 break 命令，函数和文件名将被补全。

（由 Georg Brandl 在 bpo-14210 [https://bugs.python.org/issue?@action=redirect&bpo=14210] 中贡献）

pickle

现在 pickle.Pickler 对象具有一个可选的 dispatch_table 属性以允许针对每个 pickler 设置缩减函数。

（由 Richard Oudkerk 在 bpo-14166 [https://bugs.python.org/issue?@action=redirect&bpo=14166] 中贡献。）

pydoc

The Tk GUI and the serve() function have been removed from the pydoc module: pydoc -g and serve() have been deprecated in Python 3.2.

re

现在 str 正则表达式已支持 \u 和 \U 转义符。

（由 Serhiy Storchaka 在 bpo-3665 [https://bugs.python.org/issue?@action=redirect&bpo=3665] 中贡献。）

sched

run() 现在接受一个 blocking 参数，当设置为 false 时，该方法执行即将到期的计划事件（如果有）并立即返回。这在您希望使用 scheduler 在非阻塞应用程序中时非常有用。（由 Giampaolo Rodolà 在 bpo-13449 [https://bugs.python.org/issue?@action=redirect&bpo=13449] 中贡献。）

scheduler 类现在可以安全地在多线程环境中使用。（由 Josiah Carlson 和 Giampaolo Rodolà 在 bpo-8684 [https://bugs.python.org/issue?@action=redirect&bpo=8684] 中贡献。）

scheduler 类构造函数的 timefunc 和 delayfunct 参数现在是可选的，默认分别为 time.time() 和 time.sleep()。（由 Chris Clark 在 bpo-13245 [https://bugs.python.org/issue?@action=redirect&bpo=13245] 中贡献。）

enter() 和 enterabs() 的 argument 参数现在是可选的。 (由 Chris Clark 在 bpo-13245 [https://bugs.python.org/issue?@action=redirect&bpo=13245] 中贡献)

enter() 和 enterabs() 现在接受一个 kwargs 参数。 (由 Chris Clark 在 bpo-13245 [https://bugs.python.org/issue?@action=redirect&bpo=13245] 中贡献)

select

Solaris 及其衍生平台新增了一个类 select.devpoll，用于通过 /dev/poll 实现高性能异步套接字。 (由 Jesús Cea Avión 在 bpo-6397 [https://bugs.python.org/issue?@action=redirect&bpo=6397] 中贡献)

shlex

The previously undocumented helper function quote from the pipes modules has been moved to the shlex module and documented. quote() properly escapes all characters in a string that might be otherwise given special meaning by the shell.

shutil

新的函数：

disk_usage()：提供总、已用和可用磁盘空间统计信息。 (由 Giampaolo Rodolà 在 bpo-12442 [https://bugs.python.org/issue?@action=redirect&bpo=12442] 中贡献)

chown()：允许更改给定路径的用户和/或组，同时可以指定用户/组名称，而不仅限于其数字 ID。 (由 Sandro Tosi 在 bpo-12191 [https://bugs.python.org/issue?@action=redirect&bpo=12191] 中贡献)

shutil.get_terminal_size()：返回解释器所连接的终端窗口的大小。 (由 Zbigniew Jędrzejewski-Szmek 在 bpo-13609 [https://bugs.python.org/issue?@action=redirect&bpo=13609] 中贡献)

copy2() 和 copystat() 现在在支持的平台中可以保留纳秒精度的文件时间戳。它们还保留 Linux 上的文件“扩展属性”。 (由 Larry Hastings 在 bpo-14127 [https://bugs.python.org/issue?@action=redirect&bpo=14127] 和 bpo-15238 [https://bugs.python.org/issue?@action=redirect&bpo=15238] 中贡献)

多个函数现在接受一个可选的 symlinks 参数：当该参数为真时，不解析符号链接，操作直接作用于符号链接本身（或在相关情况下创建一个）。 (由 Hynek Schlawack 在 bpo-12715 [https://bugs.python.org/issue?@action=redirect&bpo=12715] 中贡献)

当将文件复制到不同的文件系统时，move() 现在处理符号链接的方式与 POSIX 的 mv 命令相同，即重新创建符号链接而不是复制目标文件内容。(由 Jonathan Niehof 在 bpo-9993 [https://bugs.python.org/issue?@action=redirect&bpo=9993] 中贡献。) move() 现在还返回 dst 参数作为其结果。

rmtree() 现在对符号链接攻击具有抵抗力，适用于支持 os.open() 和 os.unlink() 中新 dir_fd 参数的平台。（由 Martin von Löwis 和 Hynek Schlawack 在 bpo-4489 [https://bugs.python.org/issue?@action=redirect&bpo=4489] 中贡献。）

signal

signal 模块新增的函数:

pthread_sigmask(): 获取和/或改变调用方线程的信号掩码（由 Jean-Paul Calderone 在 bpo-8407 [https://bugs.python.org/issue?@action=redirect&bpo=8407] 中贡献）；

pthread_kill(): 向指定线程发送信号；

sigpending(): 检查挂起的函数；

sigwait(): 等待一个信号;

sigwaitinfo(): 等待信号，返回相关的详细信息；

sigtimedwait()：类似于 sigwaitinfo()，但带有超时。

信号处理程序将信号号码作为一个字节而不是空字节写入唤醒文件描述符。因此，可以等待多个信号并知道哪些信号被触发。

signal.signal() 和 signal.siginterrupt() 引发 OSError，而不是 RuntimeError：OSError 具有 errno 属性。

smtpd

The smtpd module now supports RFC 5321 [https://datatracker.ietf.org/doc/html/rfc5321.html] (extended SMTP) and RFC 1870 [https://datatracker.ietf.org/doc/html/rfc1870.html] (size extension). Per the standard, these extensions are enabled if and only if the client initiates the session with an EHLO command.

（初始 ELHO 支持由 Alberto Trevino 提供。大小扩展由 Juhana Jauhiainen 提供。Michele Orrù 和 Dan Boswell 对补丁做出了大量额外贡献。bpo-8739 [https://bugs.python.org/issue?@action=redirect&bpo=8739]）

smtplib

SMTP、SMTP_SSL 和 LMTP 类现在接受 source_address 关键字参数，用于指定在创建传出套接字时绑定调用中使用的 (host, port) 源地址。（由 Paulo Scardine 在 bpo-11281 [https://bugs.python.org/issue?@action=redirect&bpo=11281] 中贡献。）

SMTP 现在支持上下文管理协议，允许 SMTP 实例在 with 语句中使用。（由 Giampaolo Rodolà 在 bpo-11289 [https://bugs.python.org/issue?@action=redirect&bpo=11289] 中贡献。）

SMTP_SSL 构造函数和 starttls() 方法现在接受一个 SSLContext 参数，用于控制安全通道的参数。（由 Kasun Herath 在 bpo-8809 [https://bugs.python.org/issue?@action=redirect&bpo=8809] 中贡献。）

socket

socket 类现在公开了额外的方法，用于在底层平台支持时处理辅助数据：

sendmsg()

recvmsg()

recvmsg_into()

（由 David Watson 在 bpo-6560 [https://bugs.python.org/issue?@action=redirect&bpo=6560] 中贡献，基于 Heiko Wundram 的早期补丁。）

socket 类现在支持 Linux 上的 PF_CAN 协议族（https://en.wikipedia.org/wiki/Socketcan）。（https://lwn.net/Articles/253425）

（由 Matthias Fuchs 贡献，Tiago Gonçalves 在 bpo-10141 [https://bugs.python.org/issue?@action=redirect&bpo=10141] 中更新。）

The socket class now supports the PF_RDS protocol family (https://en.wikipedia.org/wiki/Reliable_Datagram_Sockets and https://oss.oracle.com/projects/rds/).

socket 类现在支持 OS X 上的 PF_SYSTEM 协议族。（由 Michael Goderbauer 在 bpo-13777 [https://bugs.python.org/issue?@action=redirect&bpo=13777] 中贡献。）

新函数 sethostname() 允许在 Unix 系统上设置主机名，如果调用进程具有足够权限。（由 Ross Lagerwall 在 bpo-10866 [https://bugs.python.org/issue?@action=redirect&bpo=10866] 中贡献。）

socketserver

BaseServer 现在有一个可重写的方法 service_actions()，该方法由 serve_forever() 方法在服务循环中调用。ForkingMixIn 现在使用此方法来清理僵尸子进程。（由 Justin Warkentin 在 bpo-11109 [https://bugs.python.org/issue?@action=redirect&bpo=11109] 中贡献。）

sqlite3

新增的 sqlite3.Connection 方法 set_trace_callback() 可被用于捕获由 sqlite 处理的所有 sql 命令的追踪信息。 （由 Torsten Landschoff 在 bpo-11688 [https://bugs.python.org/issue?@action=redirect&bpo=11688] 中贡献。）

ssl

ssl 新增了两个随机生成函数：

RAND_bytes(): 生成高加密强度的伪随机字节数据。

RAND_pseudo_bytes(): 生成伪随机字节。

（由 Victor Stinner 在 bpo-12049 [https://bugs.python.org/issue?@action=redirect&bpo=12049] 中贡献。）

ssl 模块现在公开了一个更细粒度的异常层次结构，以便更容易检查各种错误类型。（由 Antoine Pitrou 在 bpo-11183 [https://bugs.python.org/issue?@action=redirect&bpo=11183] 中贡献。）

load_cert_chain() 现在接受一个 password 参数，用于如果私钥被加密时使用。（由 Adam Simpkins 在 bpo-12803 [https://bugs.python.org/issue?@action=redirect&bpo=12803] 中贡献。)

现在支持通过 load_dh_params() 和 set_ecdh_curve() 方法实现常规和基于椭圆曲线的 Diffie-Hellman 密钥交换。（由 Antoine Pitrou 贡献于 bpo-13626 [https://bugs.python.org/issue?@action=redirect&bpo=13626] 和 bpo-13627 [https://bugs.python.org/issue?@action=redirect&bpo=13627]。）

SSL 套接字新增了 get_channel_binding() 方法，允许实现某些认证机制，例如 SCRAM-SHA-1-PLUS。（由 Jacek Konieczny 贡献于 bpo-12551 [https://bugs.python.org/issue?@action=redirect&bpo=12551]。）

You can query the SSL compression algorithm used by an SSL socket, thanks to its new compression() method. The new attribute OP_NO_COMPRESSION can be used to disable compression. (Contributed by Antoine Pitrou in bpo-13634 [https://bugs.python.org/issue?@action=redirect&bpo=13634].)

已添加对使用 ssl.SSLContext.set_npn_protocols() 方法的 Next Protocol Negotiation 扩展的支持。（由 Colin Marc 贡献于 bpo-14204 [https://bugs.python.org/issue?@action=redirect&bpo=14204]。）

由于 library 和 reason 属性，现在可以更轻松地检查 SSL 错误。（由 Antoine Pitrou 贡献于 bpo-14837 [https://bugs.python.org/issue?@action=redirect&bpo=14837]。）

get_server_certificate() 函数现在支持 IPv6。（由 Charles-François Natali 贡献于 bpo-11811 [https://bugs.python.org/issue?@action=redirect&bpo=11811]。）

New attribute OP_CIPHER_SERVER_PREFERENCE allows setting SSLv3 server sockets to use the server's cipher ordering preference rather than the client's (bpo-13635 [https://bugs.python.org/issue?@action=redirect&bpo=13635]).

stat

未文档化的 tarfile.filemode 函数已移至 stat.filemode()。它可用于将文件的模式转换为形式为 '-rwxrwxrwx' 的字符串。

（由 Giampaolo Rodolà 在 bpo-14807 [https://bugs.python.org/issue?@action=redirect&bpo=14807] 中贡献。）

struct

The struct module now supports ssize_t and size_t via the new codes n and N, respectively. (Contributed by Antoine Pitrou in bpo-3163 [https://bugs.python.org/issue?@action=redirect&bpo=3163].)

subprocess

在 POSIX 平台上，命令字符串现在可以是字节对象。（由 Victor Stinner 在 bpo-8513 [https://bugs.python.org/issue?@action=redirect&bpo=8513] 中贡献。）

A new constant DEVNULL allows suppressing output in a platform-independent fashion. (Contributed by Ross Lagerwall in bpo-5870 [https://bugs.python.org/issue?@action=redirect&bpo=5870].)

sys

sys 模块新增了一个 thread_info 具名元组，包含有关线程实现的信息（bpo-11223 [https://bugs.python.org/issue?@action=redirect&bpo=11223]）。

tarfile

tarfile 现在通过 lzma 模块支持 lzma 编码。（由 Lars Gustäbel 在 bpo-5689 [https://bugs.python.org/issue?@action=redirect&bpo=5689] 中贡献。）

tempfile

tempfile.SpooledTemporaryFile's truncate() method now accepts a size parameter. (Contributed by Ryan Kelly in bpo-9957 [https://bugs.python.org/issue?@action=redirect&bpo=9957].)

textwrap

textwrap 模块新增了一个 indent() 函数，可以方便地为文本块中的选定行添加一个公共前缀（bpo-13857 [https://bugs.python.org/issue?@action=redirect&bpo=13857]）。

threading

threading.Condition、threading.Semaphore、threading.BoundedSemaphore、threading.Event 和 threading.Timer，这些原本是返回类实例的工厂函数，现在都变成了类，并且可以被子类化。（由 Éric Araujo 在 bpo-10968 [https://bugs.python.org/issue?@action=redirect&bpo=10968] 中贡献。）

threading.Thread 构造函数现在接受一个 daemon 关键字参数，以覆盖从父线程继承 daemon 标志值的默认行为（bpo-6064 [https://bugs.python.org/issue?@action=redirect&bpo=6064]）。

原本私有的函数 _thread.get_ident 现在作为公共函数 threading.get_ident() 提供。这消除了标准库中直接访问 _thread 模块的几种情况。使用 _thread.get_ident 的第三方代码也应改为使用新的公共接口。

time

PEP 418 [https://www.python.org/dev/peps/pep-0418] 向 time 模块添加了新函数：

get_clock_info()：获取时钟信息。

monotonic()：单调时钟（不会倒退），不受系统时钟更新影响。

perf_counter()：具有最高可用分辨率的性能计数器，用于测量短时间间隔。

process_time(): 当前进程的系统CPU时间和用户CPU时间之和。

其他新函数：

clock_getres(), clock_gettime() and clock_settime() functions with CLOCK_xxx constants. (Contributed by Victor Stinner in bpo-10278 [https://bugs.python.org/issue?@action=redirect&bpo=10278].)

为了提高跨平台一致性，sleep() 现在在传入负数睡眠值时会引发 ValueError。之前在posix上是错误，但在Windows上会导致无限睡眠。

types

添加新的 types.MappingProxyType 类：映射的只读代理。（见 bpo-14386 [https://bugs.python.org/issue?@action=redirect&bpo=14386]）

新函数 types.new_class() 和 types.prepare_class() 提供了对 PEP 3115 [https://www.python.org/dev/peps/pep-3115] 兼容的动态类型创建的支持。（见 bpo-14588 [https://bugs.python.org/issue?@action=redirect&bpo=14588]）

unittest

assertRaises()，assertRaisesRegex()，assertWarns() 和 assertWarnsRegex() 现在接受一个关键字参数 msg，当用作上下文管理器时。（由Ezio Melotti和Winston Ewert贡献，见 bpo-10775 [https://bugs.python.org/issue?@action=redirect&bpo=10775]。）

unittest.TestCase.run() 现在返回 TestResult 对象。

urllib

Request 类现在接受一个 method 参数，由 get_method() 用于确定应使用哪种HTTP方法。例如，这将发送一个 'HEAD' 请求：

>>> urlopen(Request('https://www.python.org', method='HEAD'))

（见 bpo-1673007 [https://bugs.python.org/issue?@action=redirect&bpo=1673007]）

webbrowser

webbrowser 模块支持更多的“浏览器”：Google Chrome（根据版本和操作系统命名为 chrome，chromium，chrome-browser 或 chromium-browser），以及通用的启动器 xdg-open (来自FreeDesktop.org项目) 和 gvfs-open`（GNOME 3的默认URI处理程序）。（前者由Arnaud Calmettes贡献，见 :issue:`13620，后者由Matthias Klose贡献，见 bpo-14493 [https://bugs.python.org/issue?@action=redirect&bpo=14493]。）

xml.etree.ElementTree

The xml.etree.ElementTree module now imports its C accelerator by default; there is no longer a need to explicitly import xml.etree.cElementTree (this module stays for backwards compatibility, but is now deprecated). In addition, the iter family of methods of Element has been optimized (rewritten in C). The module's documentation has also been greatly improved with added examples and a more detailed reference.

zlib

新属性 zlib.Decompress.eof 使得可以区分正确形成的压缩流和不完整或截断的压缩流。（由 Nadeem Vawda 在 bpo-12646 [https://bugs.python.org/issue?@action=redirect&bpo=12646] 中贡献。）

New attribute zlib.ZLIB_RUNTIME_VERSION reports the version string of the underlying zlib library that is loaded at runtime. (Contributed by Torsten Landschoff in bpo-12306 [https://bugs.python.org/issue?@action=redirect&bpo=12306].)

性能优化

已增加的主要性能改善:

得益于:pep:393 ，Unicode 字符串的某些操作已得到优化：

内存占用根据文本内容减少到原来的 1/2 到 1/4。

将 ASCII 字符串编码为 UTF-8 不再需要对字符进行编码，UTF-8 的表示法与 ASCII 的表示法是共享的

UTF-8 编码器已优化。

重复单个 ASCII 字母和获取 ASCII 字符串的子字符串的速度提高了 4 倍。

UTF-8 编码现在快 2 到 4 倍。 UTF-16 编码的速度现在提高了 10 倍。

（由 Serhiy Storchaka 在 bpo-14624 [https://bugs.python.org/issue?@action=redirect&bpo=14624], bpo-14738 [https://bugs.python.org/issue?@action=redirect&bpo=14738] 和 bpo-15026 [https://bugs.python.org/issue?@action=redirect&bpo=15026] 中贡献）。

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

新的 PEP 3118 [https://www.python.org/dev/peps/pep-3118] 相关功能：

PyMemoryView_FromMemory()

PEP 393 [https://www.python.org/dev/peps/pep-0393] 添加了新的 Unicode 类型，宏和函数

高阶 API

PyUnicode_CopyCharacters()

PyUnicode_FindChar()

PyUnicode_GetLength(), PyUnicode_GET_LENGTH

PyUnicode_New()

PyUnicode_Substring()

PyUnicode_ReadChar(), PyUnicode_WriteChar()

低阶 API:

Py_UCS1, Py_UCS2, Py_UCS4 类型

PyASCIIObject 和 PyCompactUnicodeObject 结构

PyUnicode_READY

PyUnicode_FromKindAndData()

PyUnicode_AsUCS4(), PyUnicode_AsUCS4Copy()

PyUnicode_DATA, PyUnicode_1BYTE_DATA, PyUnicode_2BYTE_DATA, PyUnicode_4BYTE_DATA

PyUnicode_KIND 使用 PyUnicode_Kind 枚举: PyUnicode_WCHAR_KIND, PyUnicode_1BYTE_KIND, PyUnicode_2BYTE_KIND, PyUnicode_4BYTE_KIND

PyUnicode_READ, PyUnicode_READ_CHAR, PyUnicode_WRITE

PyUnicode_MAX_CHAR_VALUE

PyArg_ParseTuple 现在接受 c 格式的 bytearray (bpo-12380 [https://bugs.python.org/issue?@action=redirect&bpo=12380])。

弃用

不支持的操作系统

由于缺少维护人员，不再支持 OS/2 和 VMS 系统 。

由于维护负担，将 COMSPEC 设置为 command.com 的 Windows平台（含Windows 2000）不再受支持。

OSF支持在3.2中被弃用，现在已经被完全删除。

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

向 object.__format__() 传递非空字符串的做法已被弃用，在 Python 3.4 中会产生一个 TypeError (bpo-9856 [https://bugs.python.org/issue?@action=redirect&bpo=9856])。

由于:pep:393，unicode_internal 编解码器已被弃用 。请使用 UTF-8、UTF-16 (utf-16-le 或``utf-16-be``) 或 UTF-32 (utf-32-le 或``utf-32-be``)

ftplib.FTP.nlst() 和 ftplib.FTP.dir()：使用 ftplib.FTP.mlsd()。

platform.popen(): use the subprocess module. Check especially the 使用 subprocess 模块替换旧函数 section (bpo-11377 [https://bugs.python.org/issue?@action=redirect&bpo=11377]).

bpo-13374 [https://bugs.python.org/issue?@action=redirect&bpo=13374]：在 os 模块中，Windows 字节 API 已不推荐使用。使用 Unicode 文件名，而不是字节文件名，以便不再依赖 ANSI 代码页并支持任何文件名。

bpo-13988 [https://bugs.python.org/issue?@action=redirect&bpo=13988]: The xml.etree.cElementTree module is deprecated. The accelerator is used automatically whenever available.

The behaviour of time.clock() depends on the platform: use the new time.perf_counter() or time.process_time() function instead, depending on your requirements, to have a well defined behaviour.

os.stat_float_times() 函数已被弃用。

abc 模块：

abc.abstractproperty 已被弃用，改为 property 配合 abc.abstractmethod() 使用。

abc.abstractclassmethod 已被弃用，改为 classmethod 配合 abc.abstractmethod() 使用。

abc.abstractstaticmethod 已被弃用，改为 staticmethod 配合 abc.abstractmethod() 使用。

importlib 包：

现在 importlib.abc.SourceLoader.path_mtime() 已被弃用而应改用 importlib.abc.SourceLoader.path_stats() 因为字节码文件现在会同时储存修改时间和编译出该字节码文件的源文件的大小。

已弃用的 C API 函数和类型

Py_UNICODE 已经在 PEP 393 [https://www.python.org/dev/peps/pep-0393] 弃用，并将于 Python 4 中移除。所有使用此类型的函数都已弃用：

使用 Py_UNICODE 和 Py_UNICODE* 类型的 Unicode 函数和方法：

PyUnicode_FromUnicode: 使用 PyUnicode_FromWideChar() 或 PyUnicode_FromKindAndData()

PyUnicode_AS_UNICODE, PyUnicode_AsUnicode(), PyUnicode_AsUnicodeAndSize(): 使用 PyUnicode_AsWideCharString()

PyUnicode_AS_DATA: 使用 PyUnicode_DATA 以及 PyUnicode_READ 和 PyUnicode_WRITE

PyUnicode_GET_SIZE, PyUnicode_GetSize(): 使用 PyUnicode_GET_LENGTH 或 PyUnicode_GetLength()

PyUnicode_GET_DATA_SIZE: 使用 PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str) (仅适用于现成的字符串)

PyUnicode_AsUnicodeCopy(): 使用 PyUnicode_AsUCS4Copy() 或 PyUnicode_AsWideCharString()

PyUnicode_GetMax()

操作 Py_UNICODE* 字符串的函数和宏：

Py_UNICODE_strlen: 使用 PyUnicode_GetLength() 或 PyUnicode_GET_LENGTH

Py_UNICODE_strcat: 使用 PyUnicode_CopyCharacters() 或 PyUnicode_FromFormat()

Py_UNICODE_strcpy, Py_UNICODE_strncpy, Py_UNICODE_COPY: 使用 PyUnicode_CopyCharacters() 或 PyUnicode_Substring()

Py_UNICODE_strcmp: 使用 PyUnicode_Compare()

Py_UNICODE_strncmp: 使用 PyUnicode_Tailmatch()

Py_UNICODE_strchr, Py_UNICODE_strrchr: 使用 PyUnicode_FindChar()

Py_UNICODE_FILL: 使用 PyUnicode_Fill()

Py_UNICODE_MATCH

编码器:

PyUnicode_Encode(): 使用 PyUnicode_AsEncodedObject()

PyUnicode_EncodeUTF7()

PyUnicode_EncodeUTF8(): 使用 PyUnicode_AsUTF8() 或 PyUnicode_AsUTF8String()

PyUnicode_EncodeUTF32()

PyUnicode_EncodeUTF16()

PyUnicode_EncodeUnicodeEscape() use PyUnicode_AsUnicodeEscapeString()

PyUnicode_EncodeRawUnicodeEscape() use PyUnicode_AsRawUnicodeEscapeString()

PyUnicode_EncodeLatin1(): 使用 PyUnicode_AsLatin1String()

PyUnicode_EncodeASCII(): 使用 PyUnicode_AsASCIIString()

PyUnicode_EncodeCharmap()

PyUnicode_TranslateCharmap()

PyUnicode_EncodeMBCS(): 使用 PyUnicode_AsMBCSString() 或 PyUnicode_EncodeCodePage() (和 CP_ACP code_page)

PyUnicode_EncodeDecimal(), PyUnicode_TransformDecimalToASCII()

弃用的功能

array 模块的``'u'`` 格式代码现已弃用，将在 Python 4 中与 (Py_UNICODE) API 的其他部分一起删除。

移植到 Python 3.3

本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

移植 Python 代码

默认启用哈希随机化。 将 PYTHONHASHSEED 环境变量设为 0 可禁用哈希随机化。 另请参阅 object.__hash__() 方法。

bpo-12326 [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'。

bpo-13847 [https://bugs.python.org/issue?@action=redirect&bpo=13847], bpo-14180 [https://bugs.python.org/issue?@action=redirect&bpo=14180]: time 和 datetime: 现在如果时间戳超出范围将会引发 OverflowError 而不是 ValueError。 现在如果 C 函数 gmtime() 或 localtime() 失败 将会引发 OSError。

import 使用的默认查找器现在利用特定目录内容的缓存。如果您创建了一个 Python 源文件或无源字节码文件，请确保调用 importlib.invalidate_caches() 以清除缓存，以便查找器能够注意到新文件。

ImportError 现在使用尝试导入的模块的完整名称。检查 ImportError 消息的 doctest 需要更新为使用模块的完整名称，而不仅仅是名称的尾部。

__import__() 函数的 index 参数现在默认值为 0，而不是 -1，并且不再支持负值。在实现 PEP 328 [https://www.python.org/dev/peps/pep-0328] 时，默认值仍为 -1 是一个疏忽。如果你需要继续执行相对导入后再进行绝对导入，可以使用索引为 1 的相对导入，然后再使用索引为 0 的另一个导入。不过，建议使用 importlib.import_module() 而不是直接调用 __import__()。

__import__() 不再允许对顶层模块使用除 0 以外的索引值。例如，__import__('sys', level=1) 现在是一个错误。

Because sys.meta_path and sys.path_hooks now have finders on them by default, you will most likely want to use list.insert() instead of list.append() to add to those lists.

Because None is now inserted into sys.path_importer_cache, if you are clearing out entries in the dictionary of paths that do not have a finder, you will need to remove keys paired with values of None and imp.NullImporter to be backwards-compatible. This will lead to extra overhead on older versions of Python that re-insert None into sys.path_importer_cache where it represents the use of implicit finders, but semantically it should not change anything.

importlib.abc.Finder no longer specifies a find_module() abstract method that must be implemented. If you were relying on subclasses to implement that method, make sure to check for the method's existence first. You will probably want to check for find_loader() first, though, in the case of working with path entry finders.

pkgutil 已内部转换为使用 importlib。这消除了许多边缘情况，在这些情况下，旧的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟行为未能与真实导入系统的行为匹配。导入模拟本身仍然存在，但现在已被弃用。pkgutil.iter_importers() 和 pkgutil.walk_packages() 函数特别处理标准导入钩子，因此它们仍然受支持，尽管它们不提供非标准的 iter_modules() 方法。

在 email.header.decode_header() 所做的解析中，一个长期存在的 RFC 兼容性错误 (bpo-1079 [https://bugs.python.org/issue?@action=redirect&bpo=1079]) 已被修复。使用标准习惯用法将编码的头部转换为 unicode（str(make_header(decode_header(h)))）的代码将看不到任何变化，但查看 decode_header 返回的各个元组的代码将看到，现在 ASCII 部分前后的空白符被包含在 ASCII 部分中。使用 make_header 构建头部的代码也应继续工作而无需更改，因为 make_header 在输入字符串中未显式包含空白字符时，仍会继续在 ASCII 和非 ASCII 部分之间添加空白符。

email.utils.formataddr() 现在在传递非 ASCII 显示名称时执行正确的内容传输编码。任何依赖于以前错误行为（在格式化的输出字符串中保留非 ASCII unicode）的代码都需要更改 (bpo-1690608 [https://bugs.python.org/issue?@action=redirect&bpo=1690608])。

poplib.POP3.quit() 现在可能会像所有其他 poplib 方法一样引发协议错误。假设 quit 不引发 poplib.error_proto 错误的代码，如果特定应用程序在 quit 时遇到错误，可能需要更改 (bpo-11291 [https://bugs.python.org/issue?@action=redirect&bpo=11291])。

自 Python 2.4 起被弃用的 email.parser.Parser 的 strict 参数已被最终移除。

已被弃用的方法 unittest.TestCase.assertSameElements 已被移除。

已被弃用的变量 time.accept2dyear 已被移除。

被弃用的 Context._clamp 属性已从 decimal 模块中移除。 在此之前它已被公有属性 clamp 取代。 （参见 bpo-8540 [https://bugs.python.org/issue?@action=redirect&bpo=8540]。）

未记录的内部辅助类 SSLFakeFile 已从 smtplib 中移除，因为其功能早已直接由 socket.socket.makefile() 提供。

在 Windows 上向 time.sleep() 传递负值现在会引发错误，而不是永远休眠。在 POSIX 上它一直会引发错误。

The ast.__version__ constant has been removed. If you need to make decisions affected by the AST version, use sys.version_info to make the decision.

过去那些通过继承私有类来绕过 threading 模块使用工厂函数限制的代码，现在需要调整为继承新公开的类。

threading 模块中未记录的调试机制已被移除，简化了代码。这对生产代码应无影响，但在此提及以防有应用程序调试框架与其交互 (bpo-13550 [https://bugs.python.org/issue?@action=redirect&bpo=13550])。

移植 C 代码

In the course of changes to the buffer API the undocumented smalltable member of the Py_buffer structure has been removed and the layout of the PyMemoryViewObject has changed.

所有依赖于 memoryobject.h 或 object.h 中相关部分的扩展必须重新构建。

由于 PEP 393，Py_UNICODE 类型及所有使用此类型的功能已被弃用（但至少在未来五年内仍将可用）。如果您曾使用低级 Unicode API 来构造和访问 Unicode 对象，并希望受益于 PEP 393 [https://www.python.org/dev/peps/pep-0393] 提供的内存占用减少，您必须将代码转换为新的 Unicode API。

然而，如果您仅使用过高级函数如 PyUnicode_Concat()、PyUnicode_Join() 或 PyUnicode_FromFormat()，您的代码将自动利用新的 Unicode 表示形式。

PyImport_GetMagicNumber() 在失败时现在返回 -1。

由于 level 参数的负值对 __import__() 已不再有效，同样的情况现在也适用于 PyImport_ImportModuleLevel()。这也意味着 PyImport_ImportModuleEx() 使用的 level 值现在是 0 而不是 -1。

构建 C 扩展

C 扩展的可能文件名范围已经缩小。非常少用的拼写已被抑制：在 POSIX 下，名为 xxxmodule.so、xxxmodule.abi3.so 和 xxxmodule.cpython-*.so 的文件不再被识别为实现了 xxx 模块。如果你之前生成了这样的文件，你必须切换到其他拼写（即，从文件名中移除 module 字符串）。

（在 bpo-14040 [https://bugs.python.org/issue?@action=redirect&bpo=14040] 中实现。）

命令行开关的变化

删除了 -Q命令-line旗标 和相关工具。 检查 sys.flags.division_warning 的代码需要更新。

（bpo-10998 [https://bugs.python.org/issue?@action=redirect&bpo=10998]，由 Éric Araujo 贡献。）

当 python 附带 -S 启动时，import site 将不再向模块搜索路径添加 site 专属路径。 在之前版本中则会这样做。

（由 Carl Meyer 在 bpo-11591 [https://bugs.python.org/issue?@action=redirect&bpo=11591] 中贡献并由 Éric Araujo 进行修改。）

Python 3.2 有什么新变化

作者

Raymond Hettinger（译者：wh2099 at outlook dot com）

This article explains the new features in Python 3.2 as compared to 3.1. Python 3.2 was released on February 20, 2011. It focuses on a few highlights and gives a few examples. For full details, see the Misc/NEWS [https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS] file.

参见

PEP 392 [https://www.python.org/dev/peps/pep-0392] - Python 3.2 发布计划

PEP 384: 定义稳定的ABI

过去，为一个 Python 版本所构建的扩展模块通常无法用于其他 Python 版本。 特别是在 Windows 上，每一个 Python 新特性发布版都必须重新构建想要使用的所有扩展模块。 之所以有这样的要求是因为扩展模块可以任意访问 Python 解释器的内部对象。

在 Python 3.2 中，则有了一种替代方式：扩展模块将自己约束于一个受限 API（通过定义 Py_LIMITED_API）因而不能使用许多内部对象，仅限使用一组承诺会在多个发布版中保持稳定的 API 函数。 作为其结果，在这种模式下为 3.2 构建的扩展模块也将能在 3.3、3.4 等版本中运行。 使用了内存结构体细节数据的扩展模块仍然可以被构建，但将需要为每个新特性发布版重新编译。

参见

PEP 384 [https://www.python.org/dev/peps/pep-0384] - 定义稳定的ABI

PEP 由 Martin von Löwis 撰写

PEP 389: Argparse 命令行解析模块

引入了一个新的 argparse 模块用于命令行解析，以克服 optparse 的局限性，后者不支持位置参数（不仅仅是选项）、子命令、必需选项以及其他常见的选项指定和验证模式。

该模块作为一个第三方模块已在社区中取得了广泛的成功。相比其前身，argparse 模块功能更加全面，现在是处理命令行的首选模块。出于对大量依赖该模块的遗留代码的考虑，旧模块仍被保留使用。

以下是一个带注释的示例解析器，展示了诸如限制结果到一组选项、在帮助屏幕中指定 metavar、验证一个或多个位置参数是否存在以及创建一个必需选项等功能：

import argparse
parser = argparse.ArgumentParser(
            description = 'Manage servers',         # main description for help
            epilog = 'Tested on Solaris and Linux') # displayed after help
parser.add_argument('action',                       # argument name
            choices = ['deploy', 'start', 'stop'],  # three allowed values
            help = 'action on each target')         # help msg
parser.add_argument('targets',
            metavar = 'HOSTNAME',                   # var name used in help msg
            nargs = '+',                            # require one or more targets
            help = 'url for target machines')       # help msg explanation
parser.add_argument('-u', '--user',                 # -u or --user option
            required = True,                        # make it a required argument
            help = 'login as user')

在命令字符串中调用解析器的示例:

>>> 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'

解释器自动生成的帮助示例:

>>> 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

一个非常好的 argparse 特性是可以定义子解析器，每个子解析器拥有它们自己的参数模式和帮助显示:

import argparse
parser = argparse.ArgumentParser(prog='HELM')
subparsers = parser.add_subparsers()

parser_l = subparsers.add_parser('launch', help='Launch Control')   # first subgroup
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',        # second subgroup
                                 aliases=('steer', 'turn'))         # equivalent names
parser_m.add_argument('-c', '--course', type=int, required=True)
parser_m.add_argument('-s', '--speed', type=int, default=0)

$ ./helm.py --help                         # top level help (launch and move)
$ ./helm.py launch --help                  # help for launch options
$ ./helm.py launch --missiles              # set missiles=True and torpedos=False
$ ./helm.py steer --course 180 --speed 5   # set movement parameters

参见

PEP 389 [https://www.python.org/dev/peps/pep-0389] - 新的命令行解析模块

PEP 由 Steven Bethard 撰写

参阅 升级 optparse 代码 了解与 optparse 的差异的细节。

PEP 391: 基于字典的日志配置

The logging module provided two kinds of configuration, one style with function calls for each option or another style driven by an external file saved in a ConfigParser format. Those options did not provide the flexibility to create configurations from JSON or YAML files, nor did they support incremental configuration, which is needed for specifying logger options from a command line.

为了支持更灵活的配置方式，该模块现在提供了 logging.config.dictConfig()，用于通过普通的 Python 字典指定日志配置。配置选项包括格式化器、处理器、过滤器和日志记录器。以下是一个配置字典的工作示例：

{"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"]}}

如果将该字典存储在一个名为 conf.json 的文件中，可以使用如下代码加载并调用它：

>>> 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

参见

PEP 391 [https://www.python.org/dev/peps/pep-0391] - 基于字典的日志配置

PEP 由 Vinay Sajip 撰写

PEP 3148: concurrent.futures 模块

用于创建和管理并发性的代码正在被收集到一个新的顶级命名空间 concurrent 中。其第一个成员是一个 futures 包，该包提供了一个统一的高级接口，用于管理线程和进程。

concurrent.futures 的设计灵感来自 java.util.concurrent 包。在该模型中，一个正在运行的调用及其结果由一个 Future 对象表示，该对象抽象了线程、进程和远程过程调用共有的特性。该对象支持状态检查（运行中或已完成）、超时、取消、添加回调以及访问结果或异常。

新模块的核心功能是提供了一对执行器类，用于启动和管理调用任务。这些执行器的设计目标是简化现有并行调用工具的使用流程，它们能够帮助开发者省去以下繁琐操作：配置资源池、发起调用任务、创建结果队列、添加超时处理机制，以及限制线程、进程或远程过程调用的总数量。

理想情况下，每个应用程序应该在多个组件之间共享单个执行器，以便可以集中管理进程和线程限制。这解决了当每个组件都有自己的资源管理竞争策略时出现的设计挑战。

这两个类共享一个通用接口，包含三个方法：submit() 用于调度可调用对象并返回一个 Future 对象；map() 用于一次性调度多个异步调用；shutdown() 用于释放资源。该类是一个 上下文管理器，可以在 with 语句中使用，以确保在当前挂起的futures对象执行完毕时自动释放资源。

ThreadPoolExecutor 的一个简单示例是启动四个并行线程来复制文件：

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')

参见

PEP 3148 [https://www.python.org/dev/peps/pep-3148] -- futures - 异步执行指令

PEP 由 Brian Quinlan 撰写

使用线程并行 URL 读取的代码示例，展示了如何利用线程并发获取多个网页内容。

并行计算质数的代码示例，展示了 ProcessPoolExecutor 的用法。

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__" 的目录中，该目录存放在包目录下。

除了文件名和目标目录之外，新方案还有几个方面是程序员可见的：

Imported modules now have a __cached__ attribute which stores the name of the actual file that was imported:

>>> import collections
>>> collections.__cached__
'c:/py32/lib/__pycache__/collections.cpython-32.pyc'

针对每个解释器的唯一标签可以从 imp 模块访问:

>>> import imp
>>> imp.get_tag()
'cpython-32'

Scripts that try to deduce source filename from the imported file now need to be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc" filename. Instead, use the new functions in the imp module:

>>> 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'

py_compile 和 compileall 模块已更新以反映新的命名约定和目标目录。compileall 的命令行调用有了新选项：-i 用于指定要编译的文件和目录列表，-b 使字节码文件写入其传统位置而非 __pycache__。

The importlib.abc module has been updated with new abstract base classes for loading bytecode files. The obsolete ABCs, PyLoader and PyPycLoader, have been deprecated (instructions on how to stay Python 3.1 compatible are included with the documentation).

参见

PEP 3147 [https://www.python.org/dev/peps/pep-3147] - PYC 仓库目录

PEP 由 Barry Warsaw 撰写

PEP 3149: 带有 ABI 版本标签的 .so 文件

PYC存储库目录允许多个字节码缓存文件共存。此PEP通过为共享对象文件提供一个公共目录并为每个版本提供不同的名称，实现了类似的机制。

通用目录为 "pyshared"，文件名通过识别 Python 实现方式（如 CPython、PyPy、Jython 等）、主版本号和次版本号以及可选的构建标志（如 "d" 表示调试、"m" 表示 pymalloc、"u" 表示宽Unicode）来区分。对于任意包 "foo"，当分发包安装时，您可能会看到这些文件：

/usr/share/pyshared/foo.cpython-32m.so
/usr/share/pyshared/foo.cpython-33md.so

对于 Python 本身，可以通过 sysconfig 模块中的函数来访问这些标签:

>>> import sysconfig
>>> sysconfig.get_config_var('SOABI')       # find the version tag
'cpython-32mu'
>>> sysconfig.get_config_var('EXT_SUFFIX')  # find the full filename extension
'.cpython-32mu.so'

参见

PEP 3149 [https://www.python.org/dev/peps/pep-3149] - 带有 ABI 版本标签的 .so 文件

PEP 由 Barry Warsaw 撰写

PEP 3333: Python Web服务器网关接口v1.0.1

本信息性 PEP 阐明了 WSGI 协议如何处理字节/文本问题。挑战在于，尽管 HTTP 协议本身是基于字节的，但 Python 3 中的字符串处理最方便的方式是使用 str 类型。

该 PEP 规范区分了用于请求/响应头和元数据的所谓 原生字符串 (native strings)，与用于请求和响应正文的 字节字符串 (byte strings)。

The native strings are always of type str but are restricted to code points between U+0000 through U+00FF which are translatable to bytes using Latin-1 encoding. These strings are used for the keys and values in the environment dictionary and for response headers and statuses in the start_response() function. They must follow RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] with respect to encoding. That is, they must either be ISO-8859-1 characters or use RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] MIME encoding.

对于从 Python 2 迁移 WSGI 应用程序的开发者，以下是关键点：

如果应用程序在 Python 2 中已经使用字符串作为请求/响应头，则无需更改。

如果应用程序对输出头进行编码或对输入头进行解码，则头需要重新编码为 Latin-1。例如，一个使用 utf-8 编码的输出头原本使用 h.encode('utf-8')，现在需要转换为字节到原生字符串，使用 h.encode('utf-8').decode('latin-1')。

Values yielded by an application or sent using the write() method must be byte strings. The start_response() function and environ must use native strings. The two cannot be mixed.

For server implementers writing CGI-to-WSGI pathways or other CGI-style protocols, the users must to be able access the environment using native strings even though the underlying platform may have a different convention. To bridge this gap, the wsgiref module has a new function, wsgiref.handlers.read_environ() for transcoding CGI variables from os.environ into native strings and returning a new dictionary.

参见

PEP 3333 [https://www.python.org/dev/peps/pep-3333] - Python Web服务器网关接口v1.0.1

PEP 由 Phillip Eby 撰写

其他语言特性修改

对Python 语言核心进行的小改动：

format() 函数和 str.format() 方法的字符串格式化功能为格式字符 # 新增了能力。此前，对于二进制、八进制或十六进制的整数，该字符会使输出分别带有 '0b'、'0o' 或 '0x' 前缀。现在，它还能处理浮点数、复数和 Decimal 类型，确保输出始终包含小数点——即使后续没有数字跟随。

>>> format(20, '#o')
'0o24'
>>> format(12.34, '#5.0f')
'  12.'

（由 Mark Dickinson 建议，Eric Smith 在 bpo-7094 [https://bugs.python.org/issue?@action=redirect&bpo=7094] 中实现。）

还有一个新的 str.format_map() 方法，它通过接受任意的 mapping 对象，扩展了现有 str.format() 方法的功能。这个新方法使得可以使用字符串格式化与Python的许多字典类对象，如 defaultdict、Shelf、ConfigParser 或 dbm。它也适用于在查找前标准化键的自定义 dict 子类，或者为未知键提供 __missing__() 方法的自定义类:

>>> 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>'

（由 Raymond Hettinger 提议并由 Eric Smith 在 bpo-6081 [https://bugs.python.org/issue?@action=redirect&bpo=6081] 中贡献。）

The interpreter can now be started with a quiet option, -q, to prevent the copyright and version information from being displayed in the interactive mode. The option can be introspected using the sys.flags attribute:

$ 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)

（由 Marcin Wojdyr 在 bpo-1772833 [https://bugs.python.org/issue?@action=redirect&bpo=1772833] 中贡献。）

The hasattr() function works by calling getattr() and detecting whether an exception is raised. This technique allows it to detect methods created dynamically by __getattr__() or __getattribute__() which would otherwise be absent from the class dictionary. Formerly, hasattr would catch any exception, possibly masking genuine errors. Now, hasattr has been tightened to only catch AttributeError and let other exceptions pass through:

>>> 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

（由 Yury Selivanov 发现并由 Benjamin Peterson 修正；bpo-9666 [https://bugs.python.org/issue?@action=redirect&bpo=9666]。）

浮点数或复数的 str() 现在与它的 repr() 相同。以前，str() 形式更短，但这只会造成混淆，因此现在默认显示最短的 repr():

>>> import math
>>> repr(math.pi)
'3.141592653589793'
>>> str(math.pi)
'3.141592653589793'

（由 Mark Dickinson 提议并实现；bpo-9337 [https://bugs.python.org/issue?@action=redirect&bpo=9337]。）

memoryview objects now have a release() method and they also now support the context management protocol. This allows timely release of any resources that were acquired when requesting a buffer from the original object.

>>> with memoryview(b'abcdefgh') as v:
...     print(v.tolist())
[97, 98, 99, 100, 101, 102, 103, 104]

（由 Antoine Pitrou 添加；bpo-9757 [https://bugs.python.org/issue?@action=redirect&bpo=9757]。）

此前，如果名称在嵌套块中作为自由变量出现，删除局部命名空间中的名称是非法的:

def outer(x):
    def inner():
        return x
    inner()
    del x

现在允许这样做。请记住，except 子句的目标是被清除的，所以这段代码在 Python 2.6 中可以工作，但在 Python 3.1 中会引发 SyntaxError，现在又再次可以工作:

def f():
    def print_error():
        print(e)
    try:
        something
    except Exception as e:
        print_error()
        # implicit "del e" here

（参见 bpo-4617 [https://bugs.python.org/issue?@action=redirect&bpo=4617]。）

The internal structsequence tool now creates subclasses of tuple. This means that C structures like those returned by os.stat(), time.gmtime(), and sys.version_info now work like a named tuple and now work with functions and methods that expect a tuple as an argument. This is a big step forward in making the C structures as flexible as their pure Python counterparts:

>>> import sys
>>> isinstance(sys.version_info, tuple)
True
>>> 'Version %d.%d.%d %s(%d)' % sys.version_info
'Version 3.2.0 final(0)'

（由 Arfrever Frehtes Taifersar Arahesis 建议，Benjamin Peterson 在 bpo-8413 [https://bugs.python.org/issue?@action=redirect&bpo=8413] 中实现。）

现在可以使用 PYTHONWARNINGS 环境变量来更轻松地控制警告，作为在命令行中使用 -W 的替代方案:

$ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'

（由Barry Warsaw建议，Philip Jenvey在 bpo-7301 [https://bugs.python.org/issue?@action=redirect&bpo=7301] 中实现。）

新增了一个警告类别: ResourceWarning。当检测到资源消耗或清理的潜在问题时会发出此警告。在正常发布版本中，该警告默认被禁用，但可以通过 warnings 模块提供的方式或通过命令行启用。

A ResourceWarning is issued at interpreter shutdown if the gc.garbage list isn't empty, and if gc.DEBUG_UNCOLLECTABLE is set, all uncollectable objects are printed. This is meant to make the programmer aware that their code contains object finalization issues.

当一个 文件对象 在没有显式关闭的情况下被销毁时，也会发出 ResourceWarning。尽管此类对象的析构函数确保关闭底层的操作系统资源（通常是文件描述符），但对象释放的延迟可能导致各种问题，特别是在 Windows 系统下。以下是通过命令行启用该警告的示例：

$ python -q -Wdefault
>>> f = open("foo", "wb")
>>> del f
__main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>

（由 Antoine Pitrou 和 Georg Brandl 在 bpo-10093 [https://bugs.python.org/issue?@action=redirect&bpo=10093] 和 bpo-477863 [https://bugs.python.org/issue?@action=redirect&bpo=477863] 中添加。）

range objects now support index and count methods. This is part of an effort to make more objects fully implement the collections.Sequence abstract base class. As a result, the language will have a more uniform API. In addition, range objects now support slicing and negative indices, even with values larger than sys.maxsize. This makes range more interoperable with lists:

>>> 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)

（由 Daniel Stutzbach 在 bpo-9213 [https://bugs.python.org/issue?@action=redirect&bpo=9213] 中贡献，由 Alexander Belopolsky 在 bpo-2690 [https://bugs.python.org/issue?@action=redirect&bpo=2690] 中贡献，由 Nick Coghlan 在 bpo-10889 [https://bugs.python.org/issue?@action=redirect&bpo=10889] 中贡献。）

callable() 内置函数从 Py2.x 中恢复。它提供了一个简洁、可读的替代方案，用于在类似 isinstance(x, collections.Callable) 的表达式中使用 抽象基类：

>>> callable(max)
True
>>> callable(20)
False

（参见 bpo-10518 [https://bugs.python.org/issue?@action=redirect&bpo=10518]。）

Python 的导入机制现在可以加载路径名中包含非 ASCII 字符的目录中安装的模块。这解决了一个令人烦恼的问题，即用户主目录中包含非 ASCII 字符的用户名。

（需要 Victor Stinner 在 bpo-9425 [https://bugs.python.org/issue?@action=redirect&bpo=9425] 中做大量工作。）

新增，改进和弃用的模块

Python 标准库经过了大量的维护工作和质量改进。

The biggest news for Python 3.2 is that the email package, mailbox module, and nntplib modules now work correctly with the bytes/text model in Python 3. For the first time, there is correct handling of messages with mixed encodings.

在整个标准库中，对编码和文本与字节问题的关注更加细致。特别是，与操作系统的交互现在能够更好地使用 Windows MBCS 编码、区域感知编码或 UTF-8 交换非 ASCII 数据。

另一个重要的改进是大幅提升了 SSL 连接和安全证书的支持。

此外，更多的类现在实现了 上下文管理器，以支持使用 with 语句进行方便且可靠的资源清理。

email

Python 3 中 email 包的可用性已基本由 R. David Murray 的极大努力修复。问题在于电子邮件通常以 bytes 而不是 str 文本的形式读取和存储，并且单个电子邮件中可能包含多种编码。因此，必须扩展电子邮件包以解析和生成字节格式的电子邮件消息。

新函数 message_from_bytes() 和 message_from_binary_file()，以及新类 BytesFeedParser 和 BytesParser 允许将二进制消息数据解析为模型对象。

给定模型的字节输入，get_payload() 默认将解码具有 Content-Transfer-Encoding 为 8bit 的消息正文，使用 MIME 头中指定的字符集，并返回结果字符串。

给定模型的字节输入，Generator 将把具有 Content-Transfer-Encoding 为 8bit 的消息正文转换为具有 7bit 的 Content-Transfer-Encoding。

包含未编码的非 ASCII 字节的邮件头，将被视为使用 unknown-8bit 字符集按照 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 标准进行编码。

一个新的类 BytesGenerator 生成字节输出，保留输入中未更改的任何非 ASCII 数据，包括具有 Content-Transfer-Encoding 为 8bit 的消息正文。

smtplib 的 SMTP 类现在接受字节字符串作为 sendmail() 方法的 msg 参数，并且一个新的方法 send_message() 接受一个 Message 对象，并可以可选地从对象中直接获取 from_addr 和 to_addrs 地址。

（由 R. David Murray 在 bpo-4661 [https://bugs.python.org/issue?@action=redirect&bpo=4661] 和 bpo-10321 [https://bugs.python.org/issue?@action=redirect&bpo=10321] 中提议并实现。）

elementtree

xml.etree.ElementTree 包及其对应的 xml.etree.cElementTree 已更新至 1.3 版。

新增了几个有用的函数和方法：

xml.etree.ElementTree.fromstringlist() 可根据一系列片段生成 XML 文档

xml.etree.ElementTree.register_namespace() 用于注册全局命名空间前缀

xml.etree.ElementTree.tostringlist() 用于字符串表示包括所有子列表

xml.etree.ElementTree.Element.extend() 用于添加包含零个或多个元素的序列

xml.etree.ElementTree.Element.iterfind() 可搜索元素和子元素

xml.etree.ElementTree.Element.itertext() 创建一个包含指定元素及其子元素的文本迭代器。

xml.etree.ElementTree.TreeBuilder.end() 关闭当前元素

xml.etree.ElementTree.TreeBuilder.doctype() 处理 doctype 声明

两个方法被弃用：

xml.etree.ElementTree.getchildren() 被 list(elem) 替代。

xml.etree.ElementTree.getiterator() 被 Element.iter 替代。

有关更新的详细信息，请参阅 Fredrik Lundh 网站上的 Introducing ElementTree [https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm]。

（由 Florent Xicluna 和 Fredrik Lundh 在 bpo-6472 [https://bugs.python.org/issue?@action=redirect&bpo=6472] 中贡献。）

functools

functools 模块包含一个新的装饰器用于缓存函数调用。functools.lru_cache() 可以在预期结果相同的情况下，保存对外部资源的重复查询。

例如，向数据库查询函数添加缓存装饰器可以节省热门搜索的数据库访问：

>>> 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]

>>> for name in user_requests:
...     get_phone_number(name)        # cached lookup

为了帮助选择有效的缓存大小，包装函数被用于跟踪缓存统计信息：

>>> get_phone_number.cache_info()
CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)

如果 phonelist 表被更新，过时的缓存内容可以通过以下方式清除：

>>> get_phone_number.cache_clear()

(Contributed by Raymond Hettinger and incorporating design ideas from Jim Baker, Miki Tebeka, and Nick Coghlan; see recipe 498245 [https://code.activestate.com/recipes/498245], recipe 577479 [https://code.activestate.com/recipes/577479], bpo-10586 [https://bugs.python.org/issue?@action=redirect&bpo=10586], and bpo-10593 [https://bugs.python.org/issue?@action=redirect&bpo=10593].)

The functools.wraps() decorator now adds a __wrapped__ attribute pointing to the original callable function. This allows wrapped functions to be introspected. It also copies __annotations__ if defined. And now it also gracefully skips over missing attributes such as __doc__ which might not be defined for the wrapped callable.

在上面的例子中，可以通过恢复原始函数来移除缓存：

>>> get_phone_number = get_phone_number.__wrapped__    # uncached function

（由 Nick Coghlan 和 Terrence Cole 在 bpo-9567 [https://bugs.python.org/issue?@action=redirect&bpo=9567], bpo-3445 [https://bugs.python.org/issue?@action=redirect&bpo=3445] 和 bpo-8814 [https://bugs.python.org/issue?@action=redirect&bpo=8814] 中贡献。)

为帮助编写具有丰富比较方法的类，新增的装饰器 functools.total_ordering() 将使用现有的相等和不相等方法来填充其余的方法。

例如，提供 __eq__ and __lt__ 将启用 total_ordering() 来填充 __le__, __gt__ 和 __ge__:

@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()))

使用 total_ordering 装饰器时，将会自动填充其余的比较方法。

（由 Raymond Hettinger 贡献。）

为帮助移植 Python 2 程序，functools.cmp_to_key() 函数可将旧式的比较函数转换为新式的 key function:

>>> # locale-aware sort order
>>> sorted(iterable, key=cmp_to_key(locale.strcoll))

有关排序示例和简短的排序教程，请参阅 排序的技术 [https://wiki.python.org/moin/HowTo/Sorting/] 教程。

（由 Raymond Hettinger 贡献。）

itertools

itertools 模块有一个新的 accumulate() 函数，该函数模仿 APL 的 scan 运算符和 Numpy 的 accumulate 函数：

>>> from itertools import accumulate
>>> list(accumulate([8, 2, 50]))
[8, 10, 60]

>>> 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]

有关使用 accumulate() 的示例，请参阅 random 模块的示例。

（由 Raymond Hettinger 贡献，并融合了 Mark Dickinson 的设计建议。）

collections

collections.Counter 类现在支持两种形式的原地减法操作：现有的 -= 运算符实现的是 饱和减法 [https://en.wikipedia.org/wiki/Saturation_arithmetic] (即结果不会低于零)，而新增的 subtract() 方法则实现常规减法 (允许结果为负值)。前者适用于 多重集 [https://en.wikipedia.org/wiki/Multiset] (仅包含正计数的场景)，后者更适合允许负计数的使用场景。

>>> from collections import Counter
>>> tally = Counter(dogs=5, cats=3)
>>> tally -= Counter(dogs=2, cats=8)    # saturating subtraction
>>> tally
Counter({'dogs': 3})

>>> tally = Counter(dogs=5, cats=3)
>>> tally.subtract(dogs=2, cats=8)      # regular subtraction
>>> tally
Counter({'dogs': 3, 'cats': -5})

（由 Raymond Hettinger 贡献。）

collections.OrderedDict 类有一个新方法 move_to_end()，它接受一个现有的键并将其移动到有序序列的第一个或最后一个位置。

默认情况下，将项目移动到最后一个位置。这相当于用 od[k] = od.pop(k) 更新一个条目。

快速移动到末尾的操作对于重新排序条目很有用。例如，有序字典可以用来跟踪访问顺序，通过将条目从最旧的更新到最近访问的。

>>> 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']

（由 Raymond Hettinger 贡献。）

collections.deque 类新增了两个方法 count() 和 reverse()，使它们更易于替代 list 对象：

>>> 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'])

（由 Raymond Hettinger 贡献。）

threading

threading 模块有一个新的 Barrier 同步类，用于使多个线程等待，直到它们都达到一个共同的屏障点。屏障对于确保具有多个先决条件的任务在所有前置任务完成之前不运行非常有用。

屏障可以与任意数量的线程一起工作。这是对仅适用于两个线程的 会合点 [https://en.wikipedia.org/wiki/Synchronous_rendezvous] 的泛化。

作为两阶段循环屏障实现，Barrier 对象适用于循环中使用。独立的 填充 和 排空 阶段确保所有线程在任何一个线程循环回并重新进入屏障之前都被释放（排空）。屏障在每个周期后完全重置。

使用屏障的示例：

from threading import Barrier, Thread

def get_votes(site):
    ballots = conduct_election(site)
    all_polls_closed.wait()        # do not count until all polls are closed
    totals = summarize(ballots)
    publish(site, totals)

all_polls_closed = Barrier(len(sites))
for site in sites:
    Thread(target=get_votes, args=(site,)).start()

在这个示例中，屏障强制执行一个规则，即在所有投票站关闭之前，任何投票站都不能计票。请注意，使用屏障的解决方案与使用 threading.Thread.join() 的解决方案类似，但线程在越过屏障点后仍然保持活动状态并继续工作（汇总选票）。

如果任何前置任务可能会挂起或延迟，可以创建一个带有可选 timeout 参数的屏障。然后，如果在超时期限内所有前置任务都没有到达屏障点，所有等待的线程将被释放，并引发 BrokenBarrierError 异常：

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)

在这个示例中，屏障执行了一个更健壮的规则。如果某些选举站在午夜前没有完成，屏障将超时，选票将被封存并放入队列中以供后续处理。

请参阅 屏障同步模式 [https://osl.cs.illinois.edu/media/papers/karmani-2009-barrier_synchronization_pattern.pdf] 了解更多关于如何在并行计算中使用屏障的示例。此外，在 信号量小册子 [https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf] 的 第3.6节 中也有一个简单但详尽的屏障解释。

（由 Kristján Valur Jónsson 贡献，并由 Jeffrey Yasskin 在 bpo-8777 [https://bugs.python.org/issue?@action=redirect&bpo=8777] 中进行 API 审查。）

datetime 和 time

datetime 模块新增了一种类型 timezone，它通过返回固定的 UTC 偏移量和时区名称来实现 tzinfo 接口。这使得创建带有时区信息的 datetime 对象变得更加容易:

>>> from datetime import datetime, timezone

>>> datetime.now(timezone.utc)
datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)

>>> 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)

此外，timedelta 对象现在可以与 float 相乘，并且可以被 float 和 int 对象除。同时，timedelta 对象现在可以相互除。

datetime.date.strftime() 方法不再限制于 1900 年之后的年份。新的支持年份范围是从 1000 年到 9999 年（含）。

Whenever a two-digit year is used in a time tuple, the interpretation has been governed by time.accept2dyear. The default is True which means that for a two-digit year, the century is guessed according to the POSIX rules governing the %y strptime format.

Starting with Py3.2, use of the century guessing heuristic will emit a DeprecationWarning. Instead, it is recommended that time.accept2dyear be set to False so that large date ranges can be used without guesswork:

>>> import time, warnings
>>> warnings.resetwarnings()      # remove the default warning filters

>>> time.accept2dyear = True      # guess whether 11 means 11 or 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     # use the full range of allowable dates
>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
'Fri Jan  1 12:34:56 11'

Several functions now have significantly expanded date ranges. When time.accept2dyear is false, the time.asctime() function will accept any year that fits in a C int, while the time.mktime() and time.strftime() functions will accept the full range supported by the corresponding operating system functions.

（由 Alexander Belopolsky 和 Victor Stinner 在 bpo-1289118 [https://bugs.python.org/issue?@action=redirect&bpo=1289118], bpo-5094 [https://bugs.python.org/issue?@action=redirect&bpo=5094], bpo-6641 [https://bugs.python.org/issue?@action=redirect&bpo=6641], bpo-2706 [https://bugs.python.org/issue?@action=redirect&bpo=2706], bpo-1777412 [https://bugs.python.org/issue?@action=redirect&bpo=1777412], bpo-8013 [https://bugs.python.org/issue?@action=redirect&bpo=8013] 和 bpo-10827 [https://bugs.python.org/issue?@action=redirect&bpo=10827] 中贡献。）

math

math 模块基于 C99 标准增加了六个新函数。

isfinite() 函数提供了一种可靠且快速的方法来检测特殊值。它对常规数字返回 True，对 Nan 或 Infinity 返回 False：

>>> from math import isfinite
>>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
[True, True, False, False]

expm1() 函数用于计算 e**x - 1 (其中 x 为较小数值)，且不会产生因相减两个近似相等数值而导致精度损失的问题。

>>> from math import expm1
>>> expm1(0.013671875)   # more accurate way to compute e**x-1 for a small x
0.013765762467652909

erf() 函数计算概率积分或 高斯误差函数 [https://en.wikipedia.org/wiki/Error_function]。其互补误差函数 erfc() 的计算公式为 1 - erf(x)：

>>> from math import erf, erfc, sqrt
>>> erf(1.0/sqrt(2.0))   # portion of normal distribution within 1 standard deviation
0.682689492137086
>>> erfc(1.0/sqrt(2.0))  # portion of normal distribution outside 1 standard deviation
0.31731050786291404
>>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
1.0

gamma() 函数是阶乘函数的连续扩展。详情请见 https://en.wikipedia.org/wiki/Gamma_function。由于该函数与阶乘相关，即使对于小的 x 值，其值也会变得很大，因此还有一个 lgamma() 函数用于计算伽马函数的自然对数：

>>> from math import gamma, lgamma
>>> gamma(7.0)           # six factorial
720.0
>>> lgamma(801.0)        # log(800 factorial)
4551.950730698041

（由 Mark Dickinson 贡献）

abc

abc 模块现在支持 abstractclassmethod() 和 abstractstaticmethod()。

这些工具使得可以定义一个要求实现特定 classmethod() 或 staticmethod() 的 抽象基类：

class Temperature(metaclass=abc.ABCMeta):
    @abc.abstractclassmethod
    def from_fahrenheit(cls, t):
        ...
    @abc.abstractclassmethod
    def from_celsius(cls, t):
        ...

（补丁由 Daniel Urban 在 bpo-5867 [https://bugs.python.org/issue?@action=redirect&bpo=5867] 中提交。）

io

io.BytesIO 类新增了一个方法 getbuffer()，其功能类似于 memoryview()。该方法会创建一个数据的可编辑视图，且不会生成数据的副本。该缓冲区支持随机访问和切片表示法，非常适合进行原地编辑操作:

>>> 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'

（由 Antoine Pitrou 在 bpo-5506 [https://bugs.python.org/issue?@action=redirect&bpo=5506] 中贡献。）

reprlib

When writing a __repr__() method for a custom container, it is easy to forget to handle the case where a member refers back to the container itself. Python's builtin objects such as list and set handle self-reference by displaying "..." in the recursive part of the representation string.

To help write such __repr__() methods, the reprlib module has a new decorator, recursive_repr(), for detecting recursive calls to __repr__() and substituting a placeholder string instead:

>>> 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'>

（由 Raymond Hettinger 在 bpo-9826 [https://bugs.python.org/issue?@action=redirect&bpo=9826] 和 bpo-9840 [https://bugs.python.org/issue?@action=redirect&bpo=9840] 中贡献。）

logging

除了上述基于字典的配置外，logging 包还有许多其他改进。

日志模块的文档已新增一份 基础教程、一份 高级教程 以及一份包含日志实践案例的 指南。这些文档是学习日志功能的最佳途径。

logging.basicConfig() 配置函数新增了一个 style 参数，用于支持三种不同的字符串格式化方式。该参数默认值为 "%"，表示传统的 %-格式化；可设置为 "{"，采用新的 str.format() 格式化风格；也可设置为 "$"，使用 string.Template 提供的类 shell 风格格式化。以下三种配置方式是等效的:

>>> 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")

If no configuration is set-up before a logging event occurs, there is now a default configuration using a StreamHandler directed to sys.stderr for events of WARNING level or higher. Formerly, an event occurring before a configuration was set-up would either raise an exception or silently drop the event depending on the value of logging.raiseExceptions. The new default handler is stored in logging.lastResort.

过滤器的使用已经简化。现在不再需要创建 Filter 对象，谓词可以是任何返回 True 或 False 的 Python 可调用对象。

还有许多其他改进，增加了灵活性并简化了配置。请参阅模块文档，了解 Python 3.2 中所有更改的完整列表。

csv

csv 模块现在支持一个新的方言，unix_dialect，它对所有字段应用引号，并使用传统的 Unix 风格，以 '\n' 作为行终止符。注册的方言名称为 unix。

csv.DictWriter 有一个新的 writeheader() 方法，用于写入初始行以记录字段名称:

>>> 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"

（新方言由 Jay Talbot 在 bpo-5975 [https://bugs.python.org/issue?@action=redirect&bpo=5975] 中建议，新方法由 Ed Abraham 在 bpo-1537721 [https://bugs.python.org/issue?@action=redirect&bpo=1537721] 中建议。）

contextlib

有一个新的且略显震撼的工具 ContextDecorator，它有助于创建一个既可以作为函数装饰器又可以作为 上下文管理器 的双重用途的上下文管理器。

为了方便起见，这一新功能被 contextmanager() 使用，因此无需额外努力即可支持这两种角色。

基本思想是，上下文管理器和函数装饰器都可以用于前置动作和后置动作的包装器。上下文管理器使用 with 语句包装一组语句，而函数装饰器包装一个函数内的一组语句。因此，有时需要编写一个可以在任一角色中使用的前置动作或后置动作包装器。

例如，有时需要用一个日志记录器包装函数或一组语句，以跟踪进入和退出时间。与其为该任务编写一个函数装饰器和一个上下文管理器，不如使用 contextmanager() 在单一定义中提供这两种能力:

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)

以前，这只能用作上下文管理器:

with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()

现在，它也可以用作装饰器:

@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()

试图同时满足两种角色对技术有一些限制。上下文管理器通常具有返回一个可被 with 语句使用的参数的灵活性，但函数装饰器没有类似的特性。

在上面的示例中，track_entry_and_exit 上下文管理器没有一种简洁的方式来返回一个日志实例，以供封闭语句体中使用。

（由 Michael Foord 在 bpo-9110 [https://bugs.python.org/issue?@action=redirect&bpo=9110] 中贡献。）

decimal 和 fractions

Mark Dickinson 设计了一个优雅且高效的方案，确保不同数值数据类型在实际值相等时具有相同的哈希值（bpo-8188 [https://bugs.python.org/issue?@action=redirect&bpo=8188]）:

assert hash(Fraction(3, 2)) == hash(1.5) == \
       hash(Decimal("1.5")) == hash(complex(1.5, 0))

Some of the hashing details are exposed through a new attribute, sys.hash_info, which describes the bit width of the hash value, the prime modulus, the hash values for infinity and nan, and the multiplier used for the imaginary part of a number:

>>> sys.hash_info
sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003)

An early decision to limit the inter-operability of various numeric types has been relaxed. It is still unsupported (and ill-advised) to have implicit mixing in arithmetic expressions such as Decimal('1.1') + float('1.1') because the latter loses information in the process of constructing the binary float. However, since existing floating point value can be converted losslessly to either a decimal or rational representation, it makes sense to add them to the constructor and to support mixed-type comparisons.

decimal.Decimal 构造函数现在直接接受 float 对象，因此不再需要使用 from_float() 方法（bpo-8257 [https://bugs.python.org/issue?@action=redirect&bpo=8257]）。

现在完全支持混合类型比较，以便 Decimal 对象可以直接与 float 和 fractions.Fraction 进行比较（bpo-2531 [https://bugs.python.org/issue?@action=redirect&bpo=2531] 和 bpo-8188 [https://bugs.python.org/issue?@action=redirect&bpo=8188]）。

Similar changes were made to fractions.Fraction so that the from_float() and from_decimal() methods are no longer needed (bpo-8294 [https://bugs.python.org/issue?@action=redirect&bpo=8294]):

>>> from decimal import Decimal
>>> from fractions import Fraction
>>> Decimal(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')
>>> Fraction(1.1)
Fraction(2476979795053773, 2251799813685248)

Another useful change for the decimal module is that the Context.clamp attribute is now public. This is useful in creating contexts that correspond to the decimal interchange formats specified in IEEE 754 (see bpo-8540 [https://bugs.python.org/issue?@action=redirect&bpo=8540]).

（由 Mark Dickinson 和 Raymond Hettinger贡献。）

ftp

ftplib.FTP 类现在支持上下文管理协议，可以无条件地捕获 socket.error 异常，并在完成操作时关闭 FTP 连接：

>>> 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

其他文件型对象如 mmap.mmap 和 fileinput.input() 也有了支持自动关闭的上下文管理器:

with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
    for line in f:
        process(line)

（由 Tarek Ziadé 和 Giampaolo Rodolà 在 bpo-4972 [https://bugs.python.org/issue?@action=redirect&bpo=4972] 贡献，由 Georg Brandl 在 bpo-8046 [https://bugs.python.org/issue?@action=redirect&bpo=8046] 和 bpo-1286 [https://bugs.python.org/issue?@action=redirect&bpo=1286] 贡献。）

FTP_TLS 类现在接受一个 context 参数，这是一个 ssl.SSLContext 对象，允许将 SSL 配置选项、证书和私钥捆绑到一个单一的（可能是长寿命的）结构体中。

（由 Giampaolo Rodolà 在 bpo-8806 [https://bugs.python.org/issue?@action=redirect&bpo=8806] 中贡献。）

popen

os.popen() 和 subprocess.Popen() 函数现在支持使用 with 语句来自动关闭文件描述符。

（由 Antoine Pitrou 和 Brian Curtin 在 bpo-7461 [https://bugs.python.org/issue?@action=redirect&bpo=7461] 和 bpo-10554 [https://bugs.python.org/issue?@action=redirect&bpo=10554] 中贡献。）

select

The select module now exposes a new, constant attribute, PIPE_BUF, which gives the minimum number of bytes which are guaranteed not to block when select.select() says a pipe is ready for writing.

>>> import select
>>> select.PIPE_BUF
512

（在 Unix 系统上可用。 由 Sébastien Sablé 在 bpo-9862 [https://bugs.python.org/issue?@action=redirect&bpo=9862] 中提供补丁）

gzip 和 zipfile

gzip.GzipFile 现在实现了 io.BufferedIOBase 抽象基类 (除了 truncate())。它还有一个 peek() 方法，并支持不可 seek 的以及零填充的文件对象。

gzip 模块还增加了 compress() 和 decompress() 函数，以便更容易地进行内存中的压缩和解压缩。请记住，文本在压缩和解压缩之前需要编码为 bytes：

>>> 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'

（由 Anand B. Pillai 在 bpo-3488 [https://bugs.python.org/issue?@action=redirect&bpo=3488] 中贡献，由Antoine Pitrou, Nir Aides 和 Brian Curtin 在 bpo-9962 [https://bugs.python.org/issue?@action=redirect&bpo=9962]，bpo-1675951 [https://bugs.python.org/issue?@action=redirect&bpo=1675951] ，bpo-7471 [https://bugs.python.org/issue?@action=redirect&bpo=7471] 和 bpo-2846 [https://bugs.python.org/issue?@action=redirect&bpo=2846] 中贡献。）

Also, the zipfile.ZipExtFile class was reworked internally to represent files stored inside an archive. The new implementation is significantly faster and can be wrapped in an io.BufferedReader object for more speedups. It also solves an issue where interleaved calls to read and readline gave the wrong results.

（补丁由 Nir Aides 在 bpo-7610 [https://bugs.python.org/issue?@action=redirect&bpo=7610] 中提交。）

tarfile

TarFile 类现在可以用作上下文管理器。此外，其 add() 方法有一个新的选项 filter，它控制哪些文件被添加到存档中，并允许编辑文件元数据。

新的 filter 选项取代了旧的、灵活性较差的 exclude 参数，后者现已弃用。如果指定，可选的 filter 参数需要是一个 关键字参数。用户提供的过滤函数接受一个 TarInfo 对象，并返回一个更新的 TarInfo 对象，如果希望排除该文件，函数可以返回 None:

>>> import tarfile, glob

>>> def myfilter(tarinfo):
...     if tarinfo.isfile():             # only save real files
...         tarinfo.uname = 'monty'      # redact the user name
...         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

（由 Tarek Ziadé 提议并由 Lars Gustäbel 在 bpo-6856 [https://bugs.python.org/issue?@action=redirect&bpo=6856] 中实现。）

hashlib

hashlib 模块有两个新的常量属性，列出了在所有实现中保证存在的哈希算法和当前实现中可用的算法:

>>> 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'}

（由 Carl Chenet 在 bpo-7418 [https://bugs.python.org/issue?@action=redirect&bpo=7418] 中建议。）

ast

ast 模块提供了一个用于安全评估表达式字符串的通用工具，使用 Python 字面量语法。ast.literal_eval() 函数作为内置 eval() 函数的安全替代，后者容易被滥用。Python 3.2 将 bytes 和 set 字面量添加到支持的类型列表中：字符串、字节、数字、元组、列表、字典、集合、布尔值和 None。

>>> 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>

（由Benjamin Peterson 和 Georg Brandl 实现。）

os

不同的操作系统对文件名和环境变量使用各种编码。os 模块提供了两个新函数，fsencode() 和 fsdecode()，用于编码和解码文件名：

>>> import os
>>> filename = 'Sehenswürdigkeiten'
>>> os.fsencode(filename)
b'Sehensw\xc3\xbcrdigkeiten'

Some operating systems allow direct access to encoded bytes in the environment. If so, the os.supports_bytes_environ constant will be true.

为了直接访问编码的环境变量（如果可用），使用新的 os.getenvb() 函数，或者使用 os.environb，它是 os.environ 的字节版本。

（由 Victor Stinner 贡献。）

shutil

shutil.copytree() 函数增加了两个新选项:

ignore_dangling_symlinks：当 symlinks=False 时，函数会复制由符号链接指向的文件，而不是符号链接本身。此选项将静默处理文件不存在时引发的错误。

copy_function：是一个用于复制文件的可调用对象。默认使用 shutil.copy2()。

（由 Tarek Ziadé 贡献。）

此外，shutil 模块现在支持对 zip 文件、未压缩的 tar 文件、gzip 压缩的 tar 文件和 bzip 压缩的 tar 文件的 归档操作。还有用于注册其他归档文件格式（如 xz 压缩的 tar 文件或自定义格式）的函数。

主要函数是 make_archive() 和 unpack_archive()。默认情况下，两者操作当前目录（可以通过 os.chdir() 设置）及其任何子目录。归档文件名需要指定完整路径名。归档步骤是非破坏性的（原始文件保持不变）。

>>> import shutil, pprint

>>> os.chdir('mydata')  # change to the source directory
>>> f = shutil.make_archive('/var/backup/mydata',
...                         'zip')      # archive the current directory
>>> f                                   # show the name of archive
'/var/backup/mydata.zip'
>>> os.chdir('tmp')                     # change to an unpacking
>>> shutil.unpack_archive('/var/backup/mydata.zip')  # recover the data

>>> pprint.pprint(shutil.get_archive_formats())  # display known formats
[('bztar', "bzip2'ed tar-file"),
 ('gztar', "gzip'ed tar-file"),
 ('tar', 'uncompressed tar file'),
 ('zip', 'ZIP file')]

>>> shutil.register_archive_format(     # register a new archive format
...     name='xz',
...     function=xz.compress,           # callable archiving function
...     extra_args=[('level', 8)],      # arguments to the function
...     description='xz compression'
... )

（由 Tarek Ziadé 贡献。）

sqlite3

sqlite3 模块被更新至 pysqlite 2.6.0 版。 它拥有两个新功能。

The sqlite3.Connection.in_transit attribute is true if there is an active transaction for uncommitted changes.

sqlite3.Connection.enable_load_extension() 和 sqlite3.Connection.load_extension() 方法允许你从 ".so" 文件加载 SQLite 扩展。一个著名的扩展是随 SQLite 分发的全文搜索扩展。

（由 R. David Murray 和 Shashwat Anand 在 bpo-8845 [https://bugs.python.org/issue?@action=redirect&bpo=8845] 中贡献。）

html

引入了一个新的 html 模块，其中只有一个函数 escape()，用于转义 HTML 标记中的保留字符：

>>> import html
>>> html.escape('x > 2 && x < 7')
'x &gt; 2 &amp;&amp; x &lt; 7'

socket

socket 模块有两项新改进。

Socket objects now have a detach() method which puts the socket into closed state without actually closing the underlying file descriptor. The latter can then be reused for other purposes. (Added by Antoine Pitrou; bpo-8524 [https://bugs.python.org/issue?@action=redirect&bpo=8524].)

socket.create_connection() 现在支持上下文管理协议，以无条件消耗 socket.error 异常，并在完成后关闭套接字。（由 Giampaolo Rodolà 在 bpo-9794 [https://bugs.python.org/issue?@action=redirect&bpo=9794] 中贡献。）

ssl

ssl 模块添加了许多功能以满足安全（加密、认证）互联网连接的常见需求：

一个新的类，SSLContext，用作持久SSL数据的容器，例如协议设置、证书、私钥和各种其他选项。它包括一个 wrap_socket() 方法，用于从SSL上下文创建SSL套接字。

A new function, ssl.match_hostname(), supports server identity verification for higher-level protocols by implementing the rules of HTTPS (from RFC 2818 [https://datatracker.ietf.org/doc/html/rfc2818.html]) which are also suitable for other protocols.

The ssl.wrap_socket() constructor function now takes a ciphers argument. The ciphers string lists the allowed encryption algorithms using the format described in the OpenSSL documentation [https://www.openssl.org/docs/man1.0.2/man1/ciphers.html#CIPHER-LIST-FORMAT].

当与较新版本的 OpenSSL 库链接时，ssl 模块现在支持 TLS 协议的服务器名称指示（Server Name Indication，SNI）扩展。该特性允许在单个 IP 端口上为多个使用不同证书的“虚拟主机”提供服务。需要注意的是，此扩展仅在客户端模式下受支持，并且需要通过向 ssl.SSLContext.wrap_socket() 方法传递 server_hostname 参数来激活。

已向 ssl 模块添加了各种选项，例如 OP_NO_SSLv2，该选项禁用了不安全且已过时的SSLv2协议。

扩展现在加载了所有OpenSSL密码和摘要算法。如果某些SSL证书无法验证，它们将被报告为“未知算法”错误。

The version of OpenSSL being used is now accessible using the module attributes ssl.OPENSSL_VERSION (a string), ssl.OPENSSL_VERSION_INFO (a 5-tuple), and ssl.OPENSSL_VERSION_NUMBER (an integer).

（由 Antoine Pitrou 在 bpo-8850 [https://bugs.python.org/issue?@action=redirect&bpo=8850], bpo-1589 [https://bugs.python.org/issue?@action=redirect&bpo=1589], bpo-8322 [https://bugs.python.org/issue?@action=redirect&bpo=8322], bpo-5639 [https://bugs.python.org/issue?@action=redirect&bpo=5639], bpo-4870 [https://bugs.python.org/issue?@action=redirect&bpo=4870], bpo-8484 [https://bugs.python.org/issue?@action=redirect&bpo=8484] 和 bpo-8321 [https://bugs.python.org/issue?@action=redirect&bpo=8321] 中贡献。）

nntp

The nntplib module has a revamped implementation with better bytes and text semantics as well as more practical APIs. These improvements break compatibility with the nntplib version in Python 3.1, which was partly dysfunctional in itself.

Support for secure connections through both implicit (using nntplib.NNTP_SSL) and explicit (using nntplib.NNTP.starttls()) TLS has also been added.

（由 Antoine Pitrou 在 bpo-9360 [https://bugs.python.org/issue?@action=redirect&bpo=9360] 中贡献，由 Andrew Vant 在 bpo-1926 [https://bugs.python.org/issue?@action=redirect&bpo=1926] 中贡献。）

certificates

http.client.HTTPSConnection、urllib.request.HTTPSHandler 和 urllib.request.urlopen() 现在接受可选参数，以允许对服务器证书进行检查，以验证一组证书颁发机构，这是公共HTTPS使用的推荐做法。

（由 Antoine Pitrou 添加，bpo-9003 [https://bugs.python.org/issue?@action=redirect&bpo=9003]。）

imaplib

通过新的 imaplib.IMAP4.starttls 方法，标准IMAP4连接上增加了显式TLS支持。

（由 Lorenzo M. Catucci 和 Antoine Pitrou 在 bpo-4471 [https://bugs.python.org/issue?@action=redirect&bpo=4471] 中贡献。）

http.client

http.client 模块中进行了一些小的API改进。不再支持旧式HTTP 0.9简单响应，所有类中的 strict 参数已被弃用。

HTTPConnection 和 HTTPSConnection 类现在有一个 source_address 参数，用于指示（主机，端口）元组，表明HTTP连接是从哪里建立的。

为 HTTPSConnection 增加了证书检查和HTTPS虚拟主机的支持。

连接对象上的 request() 方法允许一个可选的 body 参数，以便可以使用 文件对象 来提供请求的内容。方便的是，body 参数现在也接受一个 可迭代 对象，只要它包含一个明确的 Content-Length 头部。这个扩展接口比以前更加灵活。

为了通过代理服务器建立 HTTPS 连接，新增了一个 set_tunnel() 方法，用于设置 HTTP Connect 隧道的主机和端口。

为了与 http.server 的行为保持一致，HTTP 客户端库现在也使用 ISO-8859-1（Latin-1）编码对头部进行编码。它已经对传入的头部这样做了，所以现在传入和传出流量的行为是一致的。（参见 Armin Ronacher 在 bpo-10980 [https://bugs.python.org/issue?@action=redirect&bpo=10980] 中的工作。）

unittest

unittest 模块有许多改进，支持包的测试发现、在交互式提示符下更容易进行实验、新的测试用例方法、改进的测试失败诊断消息以及更好的方法名称。

命令行调用 python -m unittest 现在接受文件路径而不是模块名来运行特定的测试 (bpo-10620 [https://bugs.python.org/issue?@action=redirect&bpo=10620])。新的测试发现可以在包内找到测试，定位从顶级目录可导入的任何测试。顶级目录可以用 -t 选项指定，用 -p 匹配文件的模式，以及用 -s 指定开始发现的目录：

$ python -m unittest discover -s my_proj_dir -p _test.py

（由 Michael Foord 贡献）

Experimentation at the interactive prompt is now easier because the unittest.case.TestCase class can now be instantiated without arguments:

>>> from unittest import TestCase
>>> TestCase().assertEqual(pow(2, 3), 8)

（由 Michael Foord 贡献）

unittest 模块有两个新方法，assertWarns() 和 assertWarnsRegex()，用于验证给定警告类型是否由被测试代码触发：

with self.assertWarns(DeprecationWarning):
    legacy_function('XYZ')

（由 Antoine Pitrou 在 bpo-9754 [https://bugs.python.org/issue?@action=redirect&bpo=9754] 中贡献。）

另一个新方法，assertCountEqual() 用于比较两个可迭代对象，以确定它们的元素计数是否相等（无论顺序如何，相同元素的出现次数是否相同）:

def test_anagram(self):
    self.assertCountEqual('algorithm', 'logarithm')

（由 Raymond Hettinger 贡献。）

unittest 模块的主要特性之一是当测试失败时，努力生成有意义的诊断信息。在可能的情况下，失败记录会附带输出内容的差异。这对于分析失败的测试运行的日志文件特别有帮助。然而，由于差异有时可能非常庞大，因此有一个新的 maxDiff 属性用于设置显示的差异最大长度。

此外，模块中的方法名称已经进行了多项清理。

For example, assertRegex() is the new name for assertRegexpMatches() which was misnamed because the test uses re.search(), not re.match(). Other methods using regular expressions are now named using short form "Regex" in preference to "Regexp" -- this matches the names used in other unittest implementations, matches Python's old name for the re module, and it has unambiguous camel-casing.

（由 Raymond Hettinger 贡献并由 Ezio Melotti 实现。）

为了提高一致性，一些长期存在的方法别名正在被弃用，转而使用首选名称：

旧名称 | 首选名称
assert_() | assertTrue()
assertEquals() | assertEqual()
assertNotEquals() | assertNotEqual()
assertAlmostEquals() | assertAlmostEqual()
assertNotAlmostEquals() | assertNotAlmostEqual()

Likewise, the TestCase.fail* methods deprecated in Python 3.1 are expected to be removed in Python 3.3. Also see the 一些已被弃用的别名 section in the unittest documentation.

（由 Ezio Melotti 在 bpo-9424 [https://bugs.python.org/issue?@action=redirect&bpo=9424] 中贡献。）

The assertDictContainsSubset() method was deprecated because it was misimplemented with the arguments in the wrong order. This created hard-to-debug optical illusions where tests like TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1}) would fail.

（由 Raymond Hettinger 贡献。）

random

random 模块中的整数方法现在能更好地生成均匀分布。之前，它们使用 int(n*random()) 计算选择，这在 n 不是二的幂时存在轻微偏差。现在，从下一个二的幂的范围中进行多次选择，并且只有当选择落在 0 <= x < n 范围内时才保留。受影响的函数和方法包括 randrange()、 randint()、 choice()、 shuffle() 和 sample()。

（由 Raymond Hettinger 在 bpo-9025 [https://bugs.python.org/issue?@action=redirect&bpo=9025] 中贡献。）

poplib

POP3_SSL 类现在接受一个 context 参数，这是一个 ssl.SSLContext 对象，允许将 SSL 配置选项、证书和私钥捆绑到一个单一的（可能是长期存在的）结构体中。

（由 Giampaolo Rodolà 在 bpo-8807 [https://bugs.python.org/issue?@action=redirect&bpo=8807] 中贡献。）

asyncore

asyncore.dispatcher now provides a handle_accepted() method returning a (sock, addr) pair which is called when a connection has actually been established with a new remote endpoint. This is supposed to be used as a replacement for old handle_accept() and avoids the user to call accept() directly.

（由 Giampaolo Rodolà 在 bpo-6706 [https://bugs.python.org/issue?@action=redirect&bpo=6706] 中贡献。）

tempfile

tempfile 模块有一个新的上下文管理器，TemporaryDirectory，它提供了临时目录的简单确定性清理：

with tempfile.TemporaryDirectory() as tmpdirname:
    print('created temporary dir:', tmpdirname)

（由 Neil Schemenauer 和 Nick Coghlan 在 bpo-5178 [https://bugs.python.org/issue?@action=redirect&bpo=5178] 中贡献。）

inspect

inspect 模块有一个新函数 getgeneratorstate() 用来方便地标识一个生成器迭代器的当前状态:

>>> 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'

（由 Rodolpho Eckhardt 和 Nick Coghlan 在 bpo-10220 [https://bugs.python.org/issue?@action=redirect&bpo=10220] 中贡献。）

为了支持查找而不激活动态属性，inspect 模块有一个新函数，getattr_static()。与 hasattr() 不同，这是一个真正的只读搜索，保证在搜索过程中不会改变状态：

>>> class A:
...     @property
...     def f(self):
...         print('Running')
...         return 10
...
>>> a = A()
>>> getattr(a, 'f')
Running
10
>>> inspect.getattr_static(a, 'f')
<property object at 0x1022bd788>

（由 Michael Foord 贡献）

pydoc

pydoc 模块现在提供了一个大幅改进的Web服务器接口，以及一个新的命令行选项 -b，用于自动打开浏览器窗口以显示该服务器：

$ pydoc3.2 -b

（由 Ron Adam 在 bpo-2001 [https://bugs.python.org/issue?@action=redirect&bpo=2001] 中贡献。）

dis

dis 模块新增了两个用于检查代码的函数，code_info() 和 show_code()。两者都为提供的函数、方法、源代码字符串或代码对象提供详细的代码对象信息。前者返回一个字符串，后者将其打印出来：

>>> 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

此外，dis() 函数现在接受字符串参数，以便常用的 dis(compile(s, '', 'eval')) 可以简化为 dis(s)：

>>> 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

综合来看，这些改进使得探索CPython的实现方式以及亲自查看语言语法在底层的作用变得更加容易。

（由 Nick Coghlan 在 bpo-9147 [https://bugs.python.org/issue?@action=redirect&bpo=9147] 中贡献。）

dbm

所有数据库模块现在都支持 get() 和 setdefault() 方法。

（由 Ray Allen 在 bpo-9523 [https://bugs.python.org/issue?@action=redirect&bpo=9523] 中建议。）

ctypes

一个新类型 ctypes.c_ssize_t 用来表示 C ssize_t 数据类型。

site

site 模块新增了三个用于报告给定 Python 安装版详细信息的函数。

getsitepackages() 列出所有全局 site-packages 目录。

getuserbase() 报告可用来存储数据的用户基准目录。

getusersitepackages() 将揭示用户专属的 site-packages 目录路径。

>>> 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'

部分 site 功能可方便地直接通过命令行访问：

$ python -m site --user-base
/Users/raymondhettinger/.local
$ python -m site --user-site
/Users/raymondhettinger/.local/lib/python3.2/site-packages

（由 Tarek Ziadé 在 bpo-6693 [https://bugs.python.org/issue?@action=redirect&bpo=6693] 中贡献。）

sysconfig

新增的 sysconfig 模块使得发现依赖于不同系统平台和安装版的安装路径和配置变量更为简单直观。

该模块提供了对平台和版本信息获取函数的访问：

get_platform() 将返回 linux-i586 或 macosx-10.6-ppc 形式的值。

get_python_version() 将返回 Python 版本字符串如 "3.2"。

It also provides access to the paths and variables corresponding to one of seven named schemes used by distutils. Those include posix_prefix, posix_home, posix_user, nt, nt_user, os2, os2_home:

get_paths() 返回一个包含当前安装方案安装路径的字典。

get_config_vars() 返回一个包含平台特定变量的字典。

还有一个方便的命令行界面：

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"

（由TarekZiadé 移出Distutils。）

pdb

pdb 调试器模块获得了一些可用性改进：

pdb.py 现在有一个 -c 选项，用于执行 .pdbrc 脚本文件中给出的命令。

一个 .pdbrc 脚本文件可以包含 continue 和 next 命令，用于继续调试。

The Pdb class constructor now accepts a nosigint argument.

新命令：l(list)、ll(long list) 和 source 用于列出源代码。

新命令：display 和 undisplay 用于显示或隐藏表达式值的变化。

新命令：interact 用于启动一个包含当前作用域中全局和局部名称的交互式解释器。

可以通过断点编号清除断点。

（由Georg Brandl, Antonio Cuni 和 Ilya Sandler 贡献。）

configparser

The configparser module was modified to improve usability and predictability of the default parser and its supported INI syntax. The old ConfigParser class was removed in favor of SafeConfigParser which has in turn been renamed to ConfigParser. Support for inline comments is now turned off by default and section or option duplicates are not allowed in a single configuration source.

配置解析器获得了一个基于映射协议的新 API：

>>> 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)'

新 API 是在经典 API 之上实现的，因此自定义解析器子类应能够无修改地使用它。

配置解析器接受的 INI 文件结构体现在可以自定义。用户可以指定替代的选项/值分隔符和注释前缀，更改 DEFAULT 部分的名称或切换插值语法。

支持可插拔插值，包括一个额外的插值处理程序 ExtendedInterpolation：

>>> 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'

此外还引入了一些较小的功能特性，例如：支持在读取操作中指定编码格式、为获取函数（get-functions）指定回退值，以及直接从字典和字符串中读取数据。

（所有改变均由 Łukasz Langa 贡献。）

urllib.parse

对 urllib.parse 模块进行了一些可用性改进。

urlparse() 函数现在支持 IPv6 [https://en.wikipedia.org/wiki/IPv6] 地址，如 RFC 2732 [https://datatracker.ietf.org/doc/html/rfc2732.html] 中所述：

>>> 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='',
            query='',
            fragment='')

urldefrag() 函数现在返回一个 具名元组:

>>> 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'

此外，urlencode() 函数现在更加灵活，可以接受字符串或字节类型作为 query 参数。如果是字符串，那么 safe、encoding 和 error 参数将被传递给 quote_plus() 进行编码:

>>> urllib.parse.urlencode([
...      ('type', 'telenovela'),
...      ('name', '¿Dónde Está Elisa?')],
...      encoding='latin-1')
'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F'

如 解析ASCII编码字节 中所述，所有 urllib.parse 函数现在都接受 ASCII 编码的字节字符串作为输入，只要它们不与普通字符串混合。如果给定 ASCII 编码的字节字符串作为参数，返回类型也将是 ASCII 编码的字节字符串:

>>> 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'', query=b'', fragment=b'')

（由 Nick Coghlan、Dan Mahn 和 Senthil Kumaran 在 bpo-2987 [https://bugs.python.org/issue?@action=redirect&bpo=2987]、bpo-5468 [https://bugs.python.org/issue?@action=redirect&bpo=5468] 和 bpo-9873 [https://bugs.python.org/issue?@action=redirect&bpo=9873] 中提供。）

mailbox

由于 R. David Murray 的共同努力，mailbox 模块已修复以适用于 Python 3.2。挑战在于 mailbox 最初是使用文本接口设计的，但电子邮件消息最好用 bytes 表示，因为消息的不同部分可能具有不同的编码。

解决方案利用了 email 包的二进制支持来解析任意电子邮件消息。此外，解决方案还需要进行一些 API 更改。

如预期的那样，mailbox.Mailbox 对象的 add() 方法现在接受二进制输入。

StringIO 和文本文件输入已被弃用。此外，如果使用非 ASCII 字符，字符串输入将提前失败。此前它会在后续步骤处理电子邮件时失败。

还支持二进制输出。get_file() 方法现在以二进制模式返回文件（以前错误地将文件设置为文本模式）。还有一个新的 get_bytes() 方法，它返回与给定 key 对应的 bytes 消息表示。

使用旧API的 get_string() 方法仍然可以获得非二进制输出，但这种方法并不非常有用。相反，最好是从 Message 对象中提取消息，或者从二进制输入中加载它们。

（由R. David Murray贡献，Steffen Daode Nurpmeso参与努力，Victor Stinner在 bpo-9124 [https://bugs.python.org/issue?@action=redirect&bpo=9124] 中提供初始补丁。）

turtledemo

The demonstration code for the turtle module was moved from the Demo directory to main library. It includes over a dozen sample scripts with lively displays. Being on sys.path, it can now be run directly from the command-line:

$ python -m turtledemo

（由Alexander Belopolsky从Demo目录移至主库，见 bpo-10199 [https://bugs.python.org/issue?@action=redirect&bpo=10199]。）

多线程

The mechanism for serializing execution of concurrently running Python threads (generally known as the GIL or Global Interpreter Lock) has been rewritten. Among the objectives were more predictable switching intervals and reduced overhead due to lock contention and the number of ensuing system calls. The notion of a "check interval" to allow thread switches has been abandoned and replaced by an absolute duration expressed in seconds. This parameter is tunable through sys.setswitchinterval(). It currently defaults to 5 milliseconds.

有关该实现的更多详细信息可以从 python-dev 邮件列表消息 [https://mail.python.org/pipermail/python-dev/2009-October/093321.html] 中阅读（但需注意：该消息中提到的"优先级请求"机制并未被最终采纳）。

（由 Antoine Pitrou 贡献。）

常规和递归锁现在在其 acquire() 方法中接受一个可选的 timeout 参数。（由 Antoine Pitrou 在 bpo-7316 [https://bugs.python.org/issue?@action=redirect&bpo=7316] 中贡献。）

同样，threading.Semaphore.acquire() 也增加了一个 timeout 参数。（由 Torsten Landschoff 在 bpo-850728 [https://bugs.python.org/issue?@action=redirect&bpo=850728] 中贡献。)

在使用 Pthreads 的平台上，常规锁和递归锁的获取操作现在可以被信号中断。这意味着Python 程序在获取锁时发生死锁，可以通过反复向该进程发送 SIGINT 信号（在大多数 shell 中按下 Ctrl+C）来成功终止程序。（由 Reid Kleckner 在 bpo-8844 [https://bugs.python.org/issue?@action=redirect&bpo=8844] 中贡献。）

性能优化

添加了一些小的性能提升：

Python 的窥孔优化器（peephole optimizer）现在能够识别诸如 x in {1, 2, 3} 这样的模式，将其判定为对常量集合的成员资格测试。优化器会将 set (集合) 重新转换为 frozenset (不可变集合) ，并存储这个预先构建的常量。

既然速度开销已不复存在，现在可以放心地开始使用集合表示法来编写成员资格测试了。这种写法不仅语义清晰，而且执行高效：

extension = name.rpartition('.')[2]
if extension in {'xml', 'html', 'xhtml', 'css'}:
    handle(name)

（补丁和附加测试由 Dave Malcolm 在 bpo-6690 [https://bugs.python.org/issue?@action=redirect&bpo=6690] 中贡献）。

使用 pickle 模块序列化和反序列化数据的速度现在快了几倍。

（由 Alexandre Vassalotti, Antoine Pitrou 和 Unladen Swallow 团队在 bpo-9410 [https://bugs.python.org/issue?@action=redirect&bpo=9410] 和 bpo-3873 [https://bugs.python.org/issue?@action=redirect&bpo=3873] 中贡献。）

在 list.sort() 和 sorted() 中使用的 Timsort 算法 [https://en.wikipedia.org/wiki/Timsort] 现在在有 键函数 的情况下运行更快且使用更少内存。之前，列表的每个元素都会被一个临时对象包裹，该对象记住与每个元素关联的键值。现在，键和值的两个数组并行排序。这节省了排序包装器消耗的内存，并节省了委托比较所花费的时间。

（由 Daniel Stutzbach 在 bpo-9915 [https://bugs.python.org/issue?@action=redirect&bpo=9915] 中提交补丁。）

JSON 解码性能得到提升，且当同一字符串被用作多个键值时内存消耗降低。此外，当 sort_keys 参数为 True 时，JSON 编码现会启用 C 语言加速模块。

（由Antoine Pitrou 在 bpo-7451 [https://bugs.python.org/issue?@action=redirect&bpo=7451] 中贡献，由 Raymond Hettinger 和 Antoine Pitrou 在 bpo-10314 [https://bugs.python.org/issue?@action=redirect&bpo=10314] 中贡献。）

递归锁（使用 threading.RLock() API 创建）现在受益于 C 实现，这使得它们与常规锁一样快，并且比之前的纯 Python 实现快 10 到 15 倍。

（由 Antoine Pitrou 在 bpo-3001 [https://bugs.python.org/issue?@action=redirect&bpo=3001] 中贡献。）

The fast-search algorithm in stringlib is now used by the split(), rsplit(), splitlines() and replace() methods on bytes, bytearray and str objects. Likewise, the algorithm is also used by rfind(), rindex(), rsplit() and rpartition().

（由 Florent Xicluna 在 bpo-7622 [https://bugs.python.org/issue?@action=redirect&bpo=7622] 和 bpo-7462 [https://bugs.python.org/issue?@action=redirect&bpo=7462] 中提交补丁。）

整型转字符串操作现在改为每次处理两个"数字位"，从而减少了除法和取模运算的次数。

（由 Gawain Bolton、Mark Dickinson 和 Victor Stinner 在 bpo-6713 [https://bugs.python.org/issue?@action=redirect&bpo=6713] 中提交。）

There were several other minor optimizations. Set differencing now runs faster when one operand is much larger than the other (patch by Andress Bennetts in bpo-8685 [https://bugs.python.org/issue?@action=redirect&bpo=8685]). The array.repeat() method has a faster implementation (bpo-1569291 [https://bugs.python.org/issue?@action=redirect&bpo=1569291] by Alexander Belopolsky). The BaseHTTPRequestHandler has more efficient buffering (bpo-3709 [https://bugs.python.org/issue?@action=redirect&bpo=3709] by Andrew Schaaf). The operator.attrgetter() function has been sped-up (bpo-10160 [https://bugs.python.org/issue?@action=redirect&bpo=10160] by Christos Georgiou). And ConfigParser loads multi-line arguments a bit faster (bpo-7113 [https://bugs.python.org/issue?@action=redirect&bpo=7113] by Łukasz Langa).

Unicode

Python 已更新到 Unicode 6.0.0 [https://unicode.org/versions/Unicode6.0.0/]。此次更新新增了超过 2000 个字符，包括对手机重要的 emoji [https://en.wikipedia.org/wiki/Emoji] 符号。

此外，更新后的标准修改了两个卡纳达文字符（U+0CF1、U+0CF2）和一个新傣仂数字字符（U+19DA）的字符属性：前者现在可用于标识符，而后者则不再符合标识符使用要求。更多详细信息请参阅 Unicode字符数据库变更说明 [https://www.unicode.org/versions/Unicode6.0.0/#Database_Changes]。

编解码器

添加了对 cp720 阿拉伯 DOS 编码的支持（bpo-1616979 [https://bugs.python.org/issue?@action=redirect&bpo=1616979]）。

MBCS 编码不再忽略错误处理程序参数。在默认的严格模式下，当遇到无法解码的字节序列时，它会引发 UnicodeDecodeError 异常；当遇到无法编码的字符时，会引发 UnicodeEncodeError 异常。

多字节字符集编解码器（MBCS codec）在解码时支持 'strict' (严格模式) 和 'ignore' (忽略模式) 两种错误处理器，在编码时则支持 'strict' (严格模式) 和 'replace' (替换模式) 。

若需模拟 Python 3.1 版本的 MBCS 编码行为，应在解码时选用 'ignore' (忽略模式) 错误处理器，而在编码时选用 'replace' (替换模式) 错误处理器。

在 Mac OS X 上，Python 使用 'utf-8' 而不是区域设置编码来解码命令行参数。

默认情况下，tarfile 在 Windows 上使用 'utf-8' 编码格式 (而不是 'mbcs') 并在所有操作系统上使用 'surrogateescape' 错误处理器。

文档

文档继续得到改进。

在长篇幅的章节（如 内置函数）顶部添加了一个快速链接表。以 itertools 为例，这些链接旁边附有速查表风格的摘要表格，无需通读完整文档即可快速掌握要点、唤醒记忆。

在某些情况下，纯 Python 源代码可以作为文档的有益补充，因此现在许多模块都提供了指向最新版本源代码的快速链接。例如，functools 模块文档顶部有一个快速链接，标记为：

源代码 Lib/functools.py [https://github.com/python/cpython/tree/3.10/Lib/functools.py].

（由 Raymond Hettinger 贡献，参见 rationale [https://rhettinger.wordpress.com/2011/01/28/open-your-source-more/]。）

当前文档现包含更多实用示例与技巧指南。特别地，re 模块新增了内容详尽的正则表达式示例专章 正则表达式例子；同样地，itertools 模块也持续更新，不断增添新的迭代器工具配方 itertools 配方。

datetime 模块现在有一个纯 Python 的辅助实现。功能没有变化。这只是为了提供一个更易读的替代实现。

（由 Alexander Belopolsky 在 bpo-9528 [https://bugs.python.org/issue?@action=redirect&bpo=9528] 中贡献。）

未维护的 Demo 目录已被删除。一些演示被整合到文档中，一些被移动到 Tools/demo 目录，其他的则被完全删除。

（由 Georg Brandl 在 bpo-7962 [https://bugs.python.org/issue?@action=redirect&bpo=7962] 中贡献）

IDLE

格式菜单现在有一个选项，用于通过删除尾部空格来清理源文件。

（由 Raymond Hettinger 在 bpo-5150 [https://bugs.python.org/issue?@action=redirect&bpo=5150] 中贡献。）

Mac OS X 上的 IDLE 现在既支持 Carbon AquaTk 也支持 Cocoa AquaTk。

（由 Kevin Walzer, Ned Deily 和 Ronald Oussoren 在 bpo-6075 [https://bugs.python.org/issue?@action=redirect&bpo=6075] 中贡献。）

代码库

除了现有的 Subversion 代码仓库位于 https://svn.python.org 外，现在还有一个 Mercurial [https://www.mercurial-scm.org/] 仓库位于 https://hg.python.org/。

在 3.2 版本发布后，计划将 Mercurial 作为主要仓库。这种分布式版本控制系统应使社区成员更容易创建和共享外部更改集。详见 PEP 385 [https://www.python.org/dev/peps/pep-0385]。

要学习使用新的版本控制系统，请参阅 Quick Start [https://www.mercurial-scm.org/wiki/QuickStart] 或 Guide to Mercurial Workflows [https://www.mercurial-scm.org/guide]。

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

现在 idle, pydoc 和 2to3 脚本的安装将在 make altinstall 中附带特定版本的后缀 (bpo-10679 [https://bugs.python.org/issue?@action=redirect&bpo=10679])。

访问 Unicode 数据库的 C 函数现在接受并返回完整 Unicode 范围内的字符，即使在窄 Unicode 构建中也是如此（Py_UNICODE_TOLOWER、Py_UNICODE_ISDECIMAL 等）。在 Python 中可见的区别是 unicodedata.numeric() 现在为大代码点返回正确的值，而 repr() 可能有更多字符被视为可打印。

（由 Bupjoe Lee 报告，Amaury Forgeot D'Arc 修复；参见 bpo-5127 [https://bugs.python.org/issue?@action=redirect&bpo=5127] 。）

计算跳转（computed gotos）现在在支持的编译器（支持情况由配置脚本检测）上默认启用。仍可通过指定 --without-computed-gotos 选择性禁用。

（由 Antoine Pitrou 在 bpo-9203 [https://bugs.python.org/issue?@action=redirect&bpo=9203] 中贡献。）

选项 --with-wctype-functions 已被移除。内置的 Unicode 数据库现在用于所有函数。

（由 Amaury Forgeot d'Arc 在 bpo-9210 [https://bugs.python.org/issue?@action=redirect&bpo=9210] 中贡献。）

哈希值现在采用一种新类型 Py_hash_t 的值，该类型被定义为与指针具有相同的大小。此前，哈希值的类型为 long，在某些 64 位操作系统上，long 仍然只有 32 位长。得益于这一改进，set 和 dict 现在可以在使用 64 位指针的构建版本中容纳超过 2**32 个条目（此前，虽然它们能够增长到该规模，但其性能会急剧下降）。

（由 Raymond Hettinger 建议，Benjamin Peterson 实现；参见 bpo-9778 [https://bugs.python.org/issue?@action=redirect&bpo=9778]。）

A new macro Py_VA_COPY copies the state of the variable argument list. It is equivalent to C99 va_copy but available on all Python platforms (bpo-2443 [https://bugs.python.org/issue?@action=redirect&bpo=2443]).

A new C API function PySys_SetArgvEx() allows an embedded interpreter to set sys.argv without also modifying sys.path (bpo-5753 [https://bugs.python.org/issue?@action=redirect&bpo=5753]).

PyEval_CallObject is now only available in macro form. The function declaration, which was kept for backwards compatibility reasons, is now removed -- the macro was introduced in 1997 (bpo-8276 [https://bugs.python.org/issue?@action=redirect&bpo=8276]).

新增函数 PyLong_AsLongLongAndOverflow()，它与 PyLong_AsLongAndOverflow() 类似。它们都用于将 Python int 转换为本地固定宽度类型，并提供检测转换不匹配的情况 (bpo-7767 [https://bugs.python.org/issue?@action=redirect&bpo=7767])。

PyUnicode_CompareWithASCIIString() 函数现在在 Python 字符串以 NUL 结尾时返回 不相等。

新增函数 PyErr_NewExceptionWithDoc()，类似于 PyErr_NewException()，但允许指定文档字符串。这使得 C 语言实现的异常能够像纯 Python 异常一样具备自文档化能力 (bpo-7033 [https://bugs.python.org/issue?@action=redirect&bpo=7033])。

当使用 --with-valgrind 选项编译时，pymalloc 分配器在 Valgrind 下运行时会自动禁用。这提高了在 Valgrind 下运行时的内存泄漏检测能力，同时在其他时候利用 pymalloc (bpo-2422 [https://bugs.python.org/issue?@action=redirect&bpo=2422])。

从 PyArg_Parse 函数中移除了 O? 格式。该格式不再使用，且从未被文档化 (bpo-8837 [https://bugs.python.org/issue?@action=redirect&bpo=8837])。

There were a number of other small changes to the C-API. See the Misc/NEWS [https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS] file for a complete list.

Also, there were a number of updates to the Mac OS X build, see Mac/BuildScript/README.txt [https://github.com/python/cpython/blob/v3.2.6/Mac/BuildScript/README.txt] for details. For users running a 32/64-bit build, there is a known problem with the default Tcl/Tk on Mac OS X 10.6. Accordingly, we recommend installing an updated alternative such as ActiveState Tcl/Tk 8.5.9 [https://www.activestate.com/activetcl/downloads]. See https://www.python.org/download/mac/tcltk/ for additional details.

移植到 Python 3.2

本节列出了先前描述的改变以及可能需要修改你的代码的其他问题修正:

The configparser module has a number of clean-ups. The major change is to replace the old ConfigParser class with long-standing preferred alternative SafeConfigParser. In addition there are a number of smaller incompatibilities:

插值语法现在在 get() 和 set() 操作中进行验证。在默认的插值方案中，只有两个带有百分号的标记是有效的：%(name)s 和 %%，后者是转义后的百分号。

set() 和 add_section() 方法现在验证值是否为实际的字符串。以前，可能会无意引入不支持的类型。

来自单个源的重复节或选项现在会引发 DuplicateSectionError 或 DuplicateOptionError。此前，重复项会默默地覆盖先前的条目。

内联注释现在默认禁用，因此现在可以安全地在值中使用 ; 字符。

注释现在可以缩进。因此，为了在多行值的行首出现 ; 或 #，必须进行插值。这样可以防止值中的注释前缀字符被误认为是注释。

"" 现在是一个有效值，不再自动转换为空字符串。对于空字符串，请在行中使用 "option ="。

The nntplib module was reworked extensively, meaning that its APIs are often incompatible with the 3.1 APIs.

bytearray 对象不能再用作文件名；相反，它们应该转换为 bytes。

The array.tostring() and array.fromstring() have been renamed to array.tobytes() and array.frombytes() for clarity. The old names have been deprecated. (See bpo-8990 [https://bugs.python.org/issue?@action=redirect&bpo=8990].)

PyArg_Parse*() 函数:

"t#" 格式已被移除：改用 "s#" 或 "s*"

"w" 和 "w#" 格式已被移除：改用 "w*"

The PyCObject type, deprecated in 3.1, has been removed. To wrap opaque C pointers in Python objects, the PyCapsule API should be used instead; the new type has a well-defined interface for passing typing safety information and a less complicated signature for calling a destructor.

The sys.setfilesystemencoding() function was removed because it had a flawed design.

random.seed() 函数和方法现在使用 sha512 哈希函数对字符串种子进行加盐。为了访问以前版本的 seed 以重现 Python 3.1 序列，将 version 参数设置为 1，即 random.seed(s, version=1)。

The previously deprecated string.maketrans() function has been removed in favor of the static methods bytes.maketrans() and bytearray.maketrans(). This change solves the confusion around which types were supported by the string module. Now, str, bytes, and bytearray each have their own maketrans and translate methods with intermediate translation tables of the appropriate type.

（由Georg Brandl在 bpo-5675 [https://bugs.python.org/issue?@action=redirect&bpo=5675] 中贡献）

The previously deprecated contextlib.nested() function has been removed in favor of a plain with statement which can accept multiple context managers. The latter technique is faster (because it is built-in), and it does a better job finalizing multiple context managers when one of them raises an exception:

with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
    for line in infile:
        if '<critical>' in line:
            outfile.write(line)

（由 Georg Brandl 和 Mattias Brändström 贡献; appspot issue 53094 [https://codereview.appspot.com/53094]。）

struct.pack() 现在只允许使用字节类型（bytes）作为 s 字符串打包代码的参数。此前，该函数会接受文本类型（text）参数，并隐式地使用 UTF-8 编码将其转换为字节类型。这种做法存在两个问题：一是它对正确的编码方式做了预设假设；二是在将变长编码写入结构的固定长度字段时可能会导致失败。

类似于 struct.pack('<6sHHBBB', 'GIF87a', x, y) 的代码应重写为使用字节串而不是文本，即 struct.pack('<6sHHBBB', b'GIF87a', x, y)。

（由 David Beazley 发现，并由 Victor Stinner 修复；参见 bpo-10783 [https://bugs.python.org/issue?@action=redirect&bpo=10783]。）

xml.etree.ElementTree 类在解析失败时现在会抛出 xml.etree.ElementTree.ParseError。之前，它会抛出 xml.parsers.expat.ExpatError。

新的、更长的浮点数 str() 输出格式可能会导致依赖旧输出格式的 doctest 测试用例失效。

在 subprocess.Popen 中，close_fds 的默认值在 Unix 上现在为 True；在 Windows 上，如果三个标准流均设置为 None，则为 True，否则为 False。之前，close_fds 默认总是 False，这会导致打开的文件描述符泄露到子进程中，产生难以解决的错误或竞争条件。

对旧式 HTTP 0.9 的支持已从 urllib.request 和 http.client 中移除。 此项支持仍然存在于服务器端（在 http.server 中）。

（由 Antoine Pitrou 在 bpo-10711 [https://bugs.python.org/issue?@action=redirect&bpo=10711] 中贡献。）

超时模式下的 SSL 套接字现在如发生超时则会引发 socket.timeout，而不是一般性的 SSLError。

（由 Antoine Pitrou 在 bpo-10272 [https://bugs.python.org/issue?@action=redirect&bpo=10272] 中贡献。）

The misleading functions PyEval_AcquireLock() and PyEval_ReleaseLock() have been officially deprecated. The thread-state aware APIs (such as PyEval_SaveThread() and PyEval_RestoreThread()) should be used instead.

Due to security risks, asyncore.handle_accept() has been deprecated, and a new function, asyncore.handle_accepted(), was added to replace it.

（由 Giampaolo Rodola 在 bpo-6706 [https://bugs.python.org/issue?@action=redirect&bpo=6706] 中贡献。）

由于新的 GIL 实现，PyEval_InitThreads() 将不再能在 Py_Initialize() 之前被调用。

Python 3.1 有什么新变化

作者

Raymond Hettinger（译者：wh2099 at outlook dot com）

本文介绍了 Python 3.1 相比 3.0 的新特性。 Python 3.1 发布于 2009 年 6 月 27 日。

PEP 372: 有序字典

常规的 Python 字典会以任意顺序迭代键/值对。 多年以来，有好几位作者编写了可以记住键的初始插入顺序的替代实现。 基于这些实现的经验，现在引入了新的 collections.OrderedDict 类。

OrderedDict API 与常规字典基本相同，但将根据每个键首次插入的时间以有保证的顺序来迭代键和值。 如果一个新条目覆盖了现有的条目，则原始插入位置会保持不变。 删除条目并重新插入则会将其移至末尾。

标准库现在支持在某些模块中使用有序字典。 configparser 模块会默认使用它们。 这使得配置文件将以其原始顺序被读取、修改和重新写入。 collections.namedtuple() 的 _asdict() 方法现在会返回一个值的出现顺序与下层的元组索引号相同的有序字典。 json 模块已使用 object_pairs_hook 来构建以允许由解码器生成有序字典。 还添加了对第三方工具的支持如 PyYAML [https://pyyaml.org/]。

参见

PEP 372 [https://www.python.org/dev/peps/pep-0372] - 有序字典

PEP 由 Armin Ronacher 和 Raymond Hettinger 撰写，由 Raymond Hettinger 实现。

PEP 378: 千位分隔符的格式说明符

内置的 format() 函数和 str.format() 方法使用的迷你语言现在包括一种以千位分隔符格式化数字的简单、不可感知语言区域的方式。 这提供了更为人性化的程序输出，提升了外观专业程度与可读性:

>>> 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'

支持的类型有 int, float, complex 和 decimal.Decimal。

目前还在讨论要如何指定替代分隔符如点号、空格、撇号或下划线等。 可感知语言区域的应用程序应当使用现有的支持千位分隔符的 n 格式说明符。

参见

PEP 378 [https://www.python.org/dev/peps/pep-0378] - 千位分隔符的格式说明符

PEP 由 Raymond Hettinger 撰写，并由 Eric Smith 和 Mark Dickinson 实现

其他语言特性修改

对Python 语言核心进行的小改动：

包括 __main__.py 文件的目录和 zip 归档文件现在可通过将其名称传给解释器来直接执行。 这样的目录/zip 文件会自动作为 sys.path 的第一个条目插入。 （由 Andy Chu 提议并编写初始补丁；由 Phillip J. Eby 和 Nick Coghlan 改进补丁；bpo-1739468 [https://bugs.python.org/issue?@action=redirect&bpo=1739468]。）

int() 类型增加了一个 bit_length 方法用来返回以二进制代表其参数值所需的比特位数量:

>>> n = 37
>>> bin(37)
'0b100101'
>>> n.bit_length()
6
>>> n = 2**123-1
>>> n.bit_length()
123
>>> (n+1).bit_length()
124

（由 Fredrik Johansson, Victor Stinner, Raymond Hettinger 和 Mark Dickinson 在 bpo-3439 [https://bugs.python.org/issue?@action=redirect&bpo=3439] 中贡献。）

format() 字符串中的字段现在可被自动编号:

>>> 'Sir {} of {}'.format('Gallahad', 'Camelot')
'Sir Gallahad of Camelot'

之前，字符串应当具有所需的编号字段例如: 'Sir {0} of {1}'。

（由 Eric Smith在 bpo-5237 [https://bugs.python.org/issue?@action=redirect&bpo=5237] 中贡献）

string.maketrans() 函数已被弃用并由新的静态方法 bytes.maketrans() 和 bytearray.maketrans() 取代。 这项修改解决了对于 string 模块支持类型的困惑。 现在，str, bytes 和 bytearray 分别拥有它们自己的附带适当类型的中间转写表的 maketrans 和 translate 方法。

（由Georg Brandl在 bpo-5675 [https://bugs.python.org/issue?@action=redirect&bpo=5675] 中贡献）

The syntax of the with 语句的语法现在允许单个语句中存在多个上下文管理器:

>>> with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
...     for line in infile:
...         if '<critical>' in line:
...             outfile.write(line)

有了这个新语法，contextlib.nested() 函数已不再必要因而现在已被弃用。

（由 Georg Brandl 和 Mattias Brändström 贡献; appspot issue 53094 [https://codereview.appspot.com/53094]。）

现在 round(x, n) 当 x 为整数时将返回整数。 之前是返回浮点数:

>>> round(1123, -2)
1100

（由 Mark Dickinson在 bpo-4707 [https://bugs.python.org/issue?@action=redirect&bpo=4707] 贡献）

Python 现在使用 David Gay 的算法来查找不会改变实际值的最短浮点表示形式。 这应当有助于缓解某些对于二进制浮点数的困惑。

这项改进的优点对于 1.1 这样无法用二进制浮点精确表示的数来说是很明显的。 由于没有完全等价的表示，float('1.1') 这样的表达式会被求解为最接近的可表示值即十六进制的 0x1.199999999999ap+0 或十进制的 1.100000000000000088817841970012523233890533447265625。 这个最接近的值过去和现在仍然会在后续的浮点运算中被使用。

新的改变针对的是如何显示数字。 在之前，Python 使用了一种简单的方式。 repr(1.1) 的值会被计算为 format(1.1, '.17g') 并将被求解为 '1.1000000000000001'。 使用 17 个数位的优点是它将凭借 IEEE-754 标准来确保 eval(repr(1.1)) 将恰好被舍入到其原始值。 缺点则是会让许多人感觉这样的输出令人困惑（将二进制浮点表示形式的内在局限性误认为是 Python 本身的问题）。

用于 repr(1.1) 的新算法更为智能并将返回 '1.1'。 在实际上，它会搜索所有等价的字符串表示形式（使用相同的下层浮点值进行排序）并返回其中最短的表示形式。

新算法倾向于尽可能放出更为清晰的表示形式，但它并不改变下层的值。 因此仍然会是 1.1 + 2.2 != 3.3 虽然从表示形式上看情况不是这样。

这个新算法依赖于下层浮点实现的某些特性。 如果未找到所需的特性，则将继续使用旧算法。 此外，文本 pickle 协议也会通过使用旧算法来保证跨平台的可移植性。

（由 Eric Smith 和 Mark Dickinson 在 bpo-1580 [https://bugs.python.org/issue?@action=redirect&bpo=1580] 贡献）

新增，改进和弃用的模块

增加了一个 collections.Counter 类以支持方便地统计一个序列或可迭代对象中的唯一条目数量。:

>>> Counter(['red', 'blue', 'red', 'green', 'blue', 'blue'])
Counter({'blue': 3, 'red': 2, 'green': 1})

（由 Raymond Hettinger 在 bpo-1696199 [https://bugs.python.org/issue?@action=redirect&bpo=1696199] 中贡献。）

半圆了一个新模块 tkinter.ttk 用于访问带主题的 Tk 部件集。 ttk 的基本设计思路，就是尽可能地把实现部件行为的代码与实现其外观的代码分离开来。

（由 Guilherme Polo 在 bpo-2983 [https://bugs.python.org/issue?@action=redirect&bpo=2983] 中贡献。）

gzip.GzipFile 和 bz2.BZ2File 类现在已支持上下文管理协议:

>>> # Automatically close file after writing
>>> with gzip.GzipFile(filename, "wb") as f:
...     f.write(b"xxx")

（由 Antoine Pitrou 贡献。）

decimal 模块现在支持基于一个二进制 float 来创建 decimal 对象。 转换是准确的但有时也会令人吃惊:

>>> Decimal.from_float(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')

这个长长的 decimal 结果值显示了 1.1 所保存的实际二进制分数。 这个分数有许多位因为 1.1 无法用二进制来精确表示。

（由Raymond Hettinger 和 Mark Dickinson贡献。）

itertools 模块增加了两个新函数。 itertools.combinations_with_replacement() 函数是生成组合数学结果包括排列与笛卡尔积的四个函数之一。 itertools.compress() 函数模仿了 APL 中的同名函数。 此外，现有的 itertools.count() 函数现在有一个可选的 step 参数并可接受任意类型的计数序列包括 fractions.Fraction 和 decimal.Decimal:

>>> [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)]

（由 Raymond Hettinger 贡献。）

collections.namedtuple() 现在支持关键字参数 rename，它允许将无效的字段名自动转换为 _0, _1 等形式的位置名称。 这在字段名是由外部源如 CSV 标头、SQL 字段列表或用户输入创建的时候会很有用处:

>>> 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)]

（由 Raymond Hettinger 在 bpo-1818 [https://bugs.python.org/issue?@action=redirect&bpo=1818] 中贡献。）

re.sub(), re.subn() 和 re.split() 函数现在可接受一个 flags 形参。

（由 Gregory Smith 贡献）

logging 模块现在为不使用 logging 但是调用了使用它的库代码的应用程序实现了一个简单的 logging.NullHandler 类。 设置一个空处理器将会屏蔽诸如 "找不到日志记录器 foo 的处理器" 这样的虚假警告:

>>> h = logging.NullHandler()
>>> logging.getLogger("foo").addHandler(h)

（由 Vinay Sajip 在 bpo-4384 [https://bugs.python.org/issue?@action=redirect&bpo=4384] 中贡献。）

支持 -m 命令行开关的 runpy 模块现在也支持当提供包名称时通过查找并执行 __main__ 子模块来执行包。

（由 Andi Vajda 在 bpo-4195 [https://bugs.python.org/issue?@action=redirect&bpo=4195] 中贡献。）

pdb 模块现在可以访问并显示通过 zipimport (或其他符合规范的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 加载器) 加载的源代码。

（由 Alexander Belopolsky 在 bpo-4201 [https://bugs.python.org/issue?@action=redirect&bpo=4201] 中贡献。）

functools.partial 对象现在可以被封存。

（由 Antoine Pitrou 和 Jesse Noller 提议，由 Jack Diederich 实现; bpo-5228 [https://bugs.python.org/issue?@action=redirect&bpo=5228]。）

为符号增加 pydoc 帮助主题以使得在交互环境下 help('@') 能符合预期的效果。

（由 David Laban 在 bpo-4739 [https://bugs.python.org/issue?@action=redirect&bpo=4739] 中贡献。）

unittest 模块现在支持跳过单个测试或测试类。 并且它还支持将一个测试标记为已预期会失败，即已经知道不可用，但不应在 TestResult 上被计为一次失败:

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):
        ...

此外，还创建了一些针对异常的测试以便与使用 with 语句的上下文管理器一起工作:

def test_division_by_zero(self):
    with self.assertRaises(ZeroDivisionError):
        x / 0

此外，还增加了一些新的断言方法包括 assertSetEqual(), assertDictEqual(), assertDictContainsSubset(), assertListEqual(), assertTupleEqual(), assertSequenceEqual(), assertRaisesRegexp(), assertIsNone() 以及 assertIsNotNone()。

（由Benjamin Peterson 和 Antoine Pitrou 贡献。）

io 模块新增了三个常量来代表 seek() 方法 SEEK_SET, SEEK_CUR 和 SEEK_END。

sys.version_info 元组现在是一个具名元组:

>>> sys.version_info
sys.version_info(major=3, minor=1, micro=0, releaselevel='alpha', serial=2)

（由 Ross Light 在 bpo-4285 [https://bugs.python.org/issue?@action=redirect&bpo=4285] 中贡献。）

nntplib 和 imaplib 模块现在支持 IPv6。

（由 Derek Morr 在 bpo-1655 [https://bugs.python.org/issue?@action=redirect&bpo=1655] 和 bpo-1664 [https://bugs.python.org/issue?@action=redirect&bpo=1664] 中贡献。）

当使用协议 2 或更低的版本时，pickle 模块已被调适以获得与 Python 2.x 更好的互操作性。 标准库的重组改变了对于许多对象的正式引用。 例如，Python 2 中的 __builtin__.set 在 Python 3 中称为 builtins.set。 这一改变使得在不同版本的 Python 之间共享数据的努力陷入混乱。 但是现在当选择协议 2 或更低的版本时，封存器将自动使用旧的 Python 2 名称进行加载和转储。 这样的重映射将默认启用但可以通过 fix_imports 选项来禁用:

>>> 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.'

这项改变的一个不幸但无可避免的副作用是由 Python 3.1 所产生的协议 2 版本的 pickle 对象对于 Python 3.0 将不可读。 当在 Python 3.x 实现之间迁移数据时，应当使用最新的协议 3 版本的 pickle 协议，因为它不会试图与 Python 2.x 保持兼容。

（由 Alexandre Vassalotti 和 Antoine Pitrou 在 bpo-6137 [https://bugs.python.org/issue?@action=redirect&bpo=6137] 中贡献。）

增加了一个新模块 importlib。 它提供了针对 import 语句及其对应物 __import__() 函数的完整、可移植的纯 Python 引用实现。 它代表了在记录和定义导入期间所发生的行动中实质性的一步。

（由 Brett Cannon 贡献。）

性能优化

已增加的主要性能改善:

新的 I/O 库（如 PEP 3116 [https://www.python.org/dev/peps/pep-3116] 所定义的）主要是用 Python 编写并很快被证明是 Python 3.0 中的一个问题瓶颈。 在 Python 3.1 中，I/O 库已完全用 C 重写并根据具体任务的不同有 2 到 20 倍的速度提升。 纯 Python 版本仍然可通过 _pyio 模块访问以用于实验性目的。

（由 Amaury Forgeot d'Arc 和 Antoine Pitrou 贡献。）

添加了一个启发式的工具以使仅包含不可追踪对象的元组和字典不会被垃圾回收器所追踪。 这可以减少收集数据的大小从而减少长时间运行的程序的垃圾收集开销，具体取决于它们对类型类型的使用方式。

（由 Antoine Pitrou 在 bpo-4688 [https://bugs.python.org/issue?@action=redirect&bpo=4688] 中贡献。）

通过在受支持的编译器（主要有: gcc, SunPro, icc）上启用名为 --with-computed-gotos 的配置选项，字节码求值循环会使用新的分派机制进行编译，根据系统、编译器和基准测试工具的不同，该机制可获得至多 20% 的速度提升。

（由 Antoine Pitrou 以及其他一些参与者在 bpo-4753 [https://bugs.python.org/issue?@action=redirect&bpo=4753] 中贡献。）

UTF-8, UTF-16 和 LATIN-1 的解码速度现已提升了二至四倍。

（由 Antoine Pitrou 和 Amaury Forgeot d'Arc 在 bpo-4868 [https://bugs.python.org/issue?@action=redirect&bpo=4868] 中贡献。）

json 模块现在有了一个可显著提升其性能的 C 扩展。 此外，还对 API 进行了修改以使 json 只适用于 str，而不再适用于 bytes。 这一修改使得该模块能与基于 Unicode 的 JSON 规范 [https://json.org/] 紧密匹配。

（由 Bob Ippolito 在 bpo-4136 [https://bugs.python.org/issue?@action=redirect&bpo=4136] 中贡献。并由 Antoine Pitrou 和 Benjamin Peterson 转换为Py3.1）

解封操作现在将固定已封存对象的属性名称。 这可以节省内存并让封存对象变得更小。

（由 Jake McGuire 和 Antoine Pitrou 在 bpo-5084 [https://bugs.python.org/issue?@action=redirect&bpo=5084] 中贡献。）

IDLE

IDLE 的格式菜单现在提供了一个从源文件中去除尾部空格的选项。

（由 Roger D. Serwy 在 bpo-5150 [https://bugs.python.org/issue?@action=redirect&bpo=5150] 中贡献。）

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

现在整数在内部是以 2**15 为基数或以 2**30 为基数来存储的，这个基数会在构建时被确定。 在之前版本中，它们总是以 2**15 为基数来存储。 在 64 位机器上使用 2**30 为基数可显著提升性能，但在 32 位机器上的基准测试结果则好坏参半。 因此，默认会在 64 位机器上使用 2**30 为基数而在 32 位机器上使用 2**15 为基数；在 Unix 上，有一个新的配置选项 --enable-big-digits 可被用于覆盖此默认值。

Apart from the performance improvements this change should be invisible to end users, with one exception: for testing and debugging purposes there's a new sys.int_info that provides information about the internal format, giving the number of bits per digit and the size in bytes of the C type used to store each digit:

>>> import sys
>>> sys.int_info
sys.int_info(bits_per_digit=30, sizeof_digit=4)

（由 Mark Dickinson在 bpo-4258 [https://bugs.python.org/issue?@action=redirect&bpo=4258] 贡献）

PyLong_AsUnsignedLongLong() 函数现在将通过引发 OverflowError 而不是 TypeError 来处理负的 pylong。

（由 Mark Dickinson 和 Lisandro Dalcrin 在 bpo-5175 [https://bugs.python.org/issue?@action=redirect&bpo=5175] 中贡献。）

已弃用 PyNumber_Int() 。请改用 PyNumber_Long() 。

（由 Mark Dickinson在 bpo-4910 [https://bugs.python.org/issue?@action=redirect&bpo=4910] 贡献）

增加了一个新的 PyOS_string_to_double() 函数来替代已弃用的函数 PyOS_ascii_strtod() 和 PyOS_ascii_atof()。

（由 Mark Dickinson 在 bpo-5914 [https://bugs.python.org/issue?@action=redirect&bpo=5914] 贡献）

增加了 PyCapsule 作为 PyCObject API 的替代。 主要区别在于新类型拥有一个定义良好的接口用来传递类型安全信息并拥有一个较低复杂度的签名用来调用析构器。 旧类型的 API 存在问题且现在已被弃用。

（由 Larry Hastings 在 bpo-5630 [https://bugs.python.org/issue?@action=redirect&bpo=5630] 中贡献。）

移植到 Python 3.1

本节列出了先前描述的改变以及可能需要修改你的代码的其他问题修正:

新的浮点字符串表示形式可能会破坏现有的 doctest。 例如:

def e():
    '''Compute the base of natural logarithms.

    >>> e()
    2.7182818284590451

    '''
    return sum(1/math.factorial(x) for x in reversed(range(30)))

doctest.testmod()

**********************************************************************
Failed example:
    e()
Expected:
    2.7182818284590451
Got:
    2.718281828459045
**********************************************************************

在 pickle 模块中用于协议 2 或更低版本的自动名称重映射会使得 Python 3.1 的 pickle 在 Python 3.0 中无法读取。 一种解决方案是使用协议 3。 另一种解决方案是将 fix_imports 选项设为 False。 请参阅上面的讨论来了解更多细节。

Python 3.0 有什么新变化

作者

Guido van Rossum

本文介绍 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 通常不会保持更新。

由于时间有限，本文档不够完整。 对于新发布的版本，源代码发行版中的 Misc/NEWS 文件总是包含大量关于每一个细小改动的详细信息。

常见的绊脚石

本节列出了在你已习惯了 Python 2.5 的情况下最有可能让您感到困惑的几处更改。

Print 是函数

print 语句已被 print() 函数取代，其关键字参数取代了旧 print 语句 (PEP 3105 [https://www.python.org/dev/peps/pep-3105]) 的大部分特殊语法。 示例:

Old: print "The answer is", 2*2
New: print("The answer is", 2*2)

Old: print x,           # Trailing comma suppresses newline
New: print(x, end=" ")  # Appends a space instead of a newline

Old: print              # Prints a newline
New: print()            # You must call the function!

Old: print >>sys.stderr, "fatal error"
New: print("fatal error", file=sys.stderr)

Old: print (x, y)       # prints repr((x, y))
New: print((x, y))      # Not the same as print(x, y)!

你还可以自定义条目间的分隔符，例如

print("There are <", 2**32, "> possibilities!", sep="")

这将产生如下结果:

There are <4294967296> possibilities!

注意

print() 函数不支持旧 print 语句的 "softspace" 功能。例如，在 Python 2.x 中，print "A\n", "B" 会写入 "A\nB\n"；但在 Python 3.0 中，print("A\n", "B") 会写入 "A\n B\n"。

最初，您会发现自己在交互模式下经常输入旧的 print x 。是时候重新训练你的手指以输入 print(x) 了！

使用 2to3 源代码到源代码转换工具时，所有 print 语句都会自动转换为 print() 函数调用，因此对于大型项目来说，这基本上不是问题。

用视图和迭代器取代列表

某些知名的 API 将不再返回列表:

dict 方法 dict.keys()、dict.items() 和 dict.values() 返回 “视图” 而不是列表。 例如，这个写法不再有效: k = d.keys(); k.sort()。 请使用 k = sorted(d) 代替（这在 Python 2.5 中也有效，而且同样高效）。

此外，不再支持 dict.iterkeys()、dict.iteritems() 和 dict.itervalues() 方法。

map() 和 filter() 均返回迭代器。 如果你确实需要一个列表并且所有输入序列的长度相等，简单的解决办法是将 map() 包装在 list() 中，例如 list(map(...))，但更好的办法通常是使用列表推导式（特别是当原始代码使用了 lambda 的时候），或是重写代码使得它完全不需要列表。 还有一种特殊技巧是将 map() 作为函数的附带影响被唤起；正确的转换方式是使用一个常规的 for 循环（因为创建列表会浪费资源）。

如果输入序列的长度不相等，map() 将在最短序列的终点停止。 为了与 Python 2.x 中的 map() 完全兼容，也可将序列包装在 itertools.zip_longest() 中，例如将 map(func, *sequences) 变成 list(map(func, itertools.zip_longest(*sequences)))。

现在 range() 的行为与过去 xrange() 的行为类似，区别在于它可以处理任意大小的值。 后者已不复存在。

zip() 现在将返回一个迭代器。

排序比较

Python 3.0 简化了排序比较的规则：

当操作数不存在有意义的自然排序时，排序比较操作符 (<, <=, >=, >) 会引发 TypeError 异常。 因此，像 1 < '', 0 > None 或 len <= len 这样的表达式不再有效，例如 None < None 会引发 TypeError 而不是返回 False。 由此推论，对异构列表进行排序不再有意义 —— 所有元素必须相互可比。 请注意，这不适用于 == 和 != 操作符：不同的不可比类型的对象总是互不相等的。

builtin.sorted() 和 list.sort() 不再接受提供比较函数的 cmp 参数。 请使用 key 参数。 注意 key 和 reverse 参数现在是“仅限关键字”参数。

cmp() 函数应视为已不复存在，而 __cmp__() 特殊方法也不再支持。 请使用 __lt__() 进行排序，使用 __eq__() 与 __hash__() 进行比较，并根据需要使用其他的丰富比较方法。 （如果确实需要 cmp() 功能，可以使用表达式 (a > b) - (a < b) 以实现 cmp(a, b)。）

整数

PEP 237 [https://www.python.org/dev/peps/pep-0237]: 在实质上，long 已被重命名为 int。 也就是说，现在只有一种内置整数类型，叫做 int；但其行为更像是旧的 long 类型。

PEP 238 [https://www.python.org/dev/peps/pep-0238]: 像 1/2 这样的表达式将返回一个浮点数。 请使用 1//2 来得到取整的行为。 （后面这种语法已存在多年，至少从 Python 2.2 起就有了。）

sys.maxint 常量已被删除，因为整数值不再有限制。 不过，sys.maxsize 仍可用作大于任何实际列表或字符串索引的整数。 它符合实现的“自然”整数大小，通常与同一平台上以前版本中的 sys.maxint 相同（假设使用相同的构建选项）。

长整数的 repr() 不再包括尾部的 L，因此无条件地删除该字符的代码会删除最后一位数字。 （请使用 str() 代替。）

八进制数字面值不再是 0720 的形式；而是改用 0o720 的形式。

文本与数据而不是 Unicode 与 8 比特位

你对二进制数据和 Unicode 的所有认知都已改变。

Python 3.0 使用 文本 和 (二进制) 数据 等概念来替代 Unicode 字符串和 8 位字符串。 所有文本均使用 Unicode；不过 已编码 Unicode 是以二进制数据来表示的。 用于存放文本的类型是 str，用于存放数据的类型是 bytes。 与 2.x 场景的最大区别是在 Python 3.0 中任何混用文本和数据的尝试都将引发 TypeError，而当你在 Python 2.x 中混用 Unicode 和 8 位字符串时，如果 8 位字符串恰好仅包含 7 位 (ASCII) 字节数据那就没有问题，但是如果包含非 ASCII 值则将引发 UnicodeDecodeError。 这种依赖于特定值的行为多年来造成了无数的苦恼。

As a consequence of this change in philosophy, pretty much all code that uses Unicode, encodings or binary data most likely has to change. The change is for the better, as in the 2.x world there were numerous bugs having to do with mixing encoded and unencoded text. To be prepared in Python 2.x, start using unicode for all unencoded text, and str for binary or encoded data only. Then the 2to3 tool will do most of the work for you.

你不能再使用 u"..." 字面值来表示 Unicode 文本。 不过，你必须使用 b"..." 字面值来表示二进制数据。

由于 str 和 bytes 类型无法混用，你必须始终在它们之间执行显式转换。 使用 str.encode() 将 str 转为 bytes，并使用 bytes.decode() 将 bytes 转为 str。 你也可以分别使用 bytes(s, encoding=...) 和 str(b, encoding=...)。

与 str 一样，bytes 类型是不可变的。 还有一个单独的 mutable 类型用于保存缓冲二进制数据，即 bytearray。 几乎所有接受 bytes 的应用程序接口也接受 bytearray。 可变 API 基于 collections.MutableSequence。

原始字符串字面中的所有反斜线均按字面解释。 这意味着原始字符串中的 '\U' 和 '\u' 转义符不会被特殊处理。 例如，在 Python 3.0 中，r'\u20ac' 是一个包含 6 个字符的字符串，而在 2.6 中，ur'\u20ac' 是一个 “欧元” 字符。 （当然，这种变化只影响原始字符串的字面意义；在 Python 3.0 中，欧元字符是 '\u20ac'。）

内置的 basestring 抽象类型已被移除，请使用 str 代替。 str 和 bytes 类型在功能上没有足够的共通性，因此不需要共享基类。 2to3 工具（见下文）用 str 替换了每一个 basestring。

作为文本文件打开的文件（仍然是 open() 的默认模式）总是会使用一个编码格式在（内存中的）字符串和（磁盘中的）字节串之间建立映射。 二进制文件（将 mode 参数设为 b 来打开）在内存中总是会使用数字串。 这意味着如果一个文件是使用不正确的模式或编码格式打开的，I/O 操作很可能会报告失败，而不是静默地产生不正确的数据。 这也意味着即使是 Unix 用户在打开文件时也必须指定正确的模式（文本或二进制）。 存在一个依赖于具体平台的默认编码格式，在类 Unix 平台上可以通过 LANG 环境变量来设置（有时也会使用其他一些平台专属的语言区域相关的环境变量）。 在多数情况下，系统默认使用 UTF-8，但并非全都如此；你绝不应该依赖这个默认值。 任何读写超出纯 ASCII 文本范围的内容的应用程序都应该提供重写编码格式的选项。 现在已不再需要使用 codecs 模块中可感知编码格式的流。

sys.stdin、sys.stdout 和 sys.stderr 的初始值现在是仅 Unicode 的文本文件（即它们是 io.TextIOBase 的实例）。 要使用这些数据流读写字节数据，需要使用它们的 io.TextIOBase.buffer 属性。

文件名是以（Unicode）字符串的形式传给 API 并返回的。 这可能产生特定平台专属的问题因为在某些平台上文件名强制使用字节串。 （另一方面，在 Windows 上文件名则原生存储为 Unicode。） 为绕过此问题，多数接受文件名的 API（例如 open() 和 os 模块中的许多函数）都同时接受 bytes 对象和字符串，而少数 API 会发出要求 bytes 返回值的提示。 因而，当参数为 bytes 的实例时 os.listdir() 会返回由 bytes 实例组成的列表，os.getcwdb() 则会将当前工作目录作为 bytes 实例返回。 请注意当 os.listdir() 返回字符串的列表时，无法被正确解码的文件名会被忽略而不是引发 UnicodeError。

当系统提供的字节无法使用默认编码进行解释时，一些系统 API，如 os.environ 和 sys.argv，也会出现问题。 最好的办法可能是设置 LANG 变量并重新运行程序。

PEP 3138 [https://www.python.org/dev/peps/pep-3138]: 字符串的 repr() 将不再转义非 ASCII 字符。 不过，它仍然会转义控制字符和在 Unicode 标准中具有不可打印状态的码位。

PEP 3120 [https://www.python.org/dev/peps/pep-3120]：现在默认的源码编码格式是UTF-8。

PEP 3131 [https://www.python.org/dev/peps/pep-3131]: 现在允许在标识符中使用非 ASCII 字符（不过，标准库中的异常和注释中的贡献者名字仍然只使用 ASCII 字符）。

The StringIO and cStringIO modules are gone. Instead, import the io module and use io.StringIO or io.BytesIO for text and data respectively.

另请参阅 Unicode 指南，其内容已针对 Python 3.0 进行更新。

语法变化概述

本节提供了 Python 3.0 中每个 语法 变化的简要说明。

新语法

PEP 3107 [https://www.python.org/dev/peps/pep-3107]: Function argument and return value annotations. This provides a standardized way of annotating a function's parameters and return value. There are no semantics attached to such annotations except that they can be introspected at runtime using the __annotations__ attribute. The intent is to encourage experimentation through metaclasses, decorators or frameworks.

PEP 3102 [https://www.python.org/dev/peps/pep-3102]：仅限关键字参数。在参数列表``*args`` 之后出现的命名参数 必须 在调用中使用关键字语法指定。也可以在参数列表中使用``*``来表示不接受长度可变的参数列表，但可以使用只包含关键字的参数。

类定义中的基类列表后允许使用关键字参数。 这是用于指定元类的新约定（见下一节），但也可用于其他目的，只要元类支持它。

PEP 3104 [https://www.python.org/dev/peps/pep-3104]: nonlocal 语句。 现在你可以使用 nonlocal x 直接赋值到一个外层（但非全局）作用域。 nonlocal 是新的保留字。

PEP 3132 [https://www.python.org/dev/peps/pep-3132]: 扩展可迭代对象解包。 你现在可以编写像 a, b, *rest = some_sequence 这样的代码。 甚至 *rest, a = stuff。 rest 对象将总是为一个（可能为空的）列表；右侧的对象可以是任意可迭代对象。 例如:

(a, *rest, b) = range(5)

这会将 a 设为 0，b 设为 4，而将 rest 设为 [1, 2, 3]。

新增字典推导式: {k: v for k, v in stuff} 的含义与 dict(stuff) 相同但是更为灵活。 (对此特性的解释见 PEP 274 [https://www.python.org/dev/peps/pep-0274]。 :-)

新增集合字面值，例如 {1, 2}。 请注意 {} 是空字典；要用 set() 表示空集合。 集合推导式也受到支持；例如 {x for x in stuff} 的含义与 set(stuff) 相同但是更为灵活。

新增八进制字面值，例如 0o720 (已存在于 2.6 中)。 旧的八进制字面值 (0720) 已不复存在。

新增二进制字面值，例如 0b1010 (已存在于 2.6 中)，还有对应的新增内置函数 bin()。

引入了带有 b 或 B 前缀的字节串字面值，还有对应的新增内置函数 bytes()。

语法变化

PEP 3109 [https://www.python.org/dev/peps/pep-3109] 和 PEP 3134 [https://www.python.org/dev/peps/pep-3134]: 新增 raise 语句的语法: raise [expr [from expr]]。 见下文。

现在 as 和 with 是保留关键字。 （实际是从 2.6 开始。）

True, False 和 None 已成为保留关键字。 （2.6 已经对 None 部分强制应用限制。）

将 except exc, var 改为 except exc as var。 参见 PEP 3110 [https://www.python.org/dev/peps/pep-3110]。

PEP 3115 [https://www.python.org/dev/peps/pep-3115]: 新的元类语法。 替换:

class C:
    __metaclass__ = M
    ...

你现在需要使用:

class C(metaclass=M):
    ...

不再支持全局模块变量 __metaclass__。 (它是一个“拐杖”，可以使默认使用新风格类变得更容易，而无需从 object 派生每个类。）

列表推导式不再支持 [... for var in item1, item2, ...] 这样的语法形式。 请改用 [... for var in (item1, item2, ...)]。 还要注意列表推导式具有不同的句法：它们更像是 list() 构造器内部用于生成器表达式的语法糖，具体来说就是循环控制变量将不会再泄漏到外层作用域中。

ellipsis (...) 可以在任何地方作为原子表达式使用。（以前只允许在片段中使用。）另外，现在 必须 拼写为``...`` 。（以前也可以拼写为``. . .`` ，这只是一个偶然的语法。）

移除的语法

PEP 3113 [https://www.python.org/dev/peps/pep-3113]: 元组形参解包已被移除。 你不能再使用 def foo(a, (b, c)): ... 的写法。 请改用 def foo(a, b_c): b, c = b_c。

移除了反引号（请使用 repr() 代替）。

移除了 <> (请改用 !=)。

移除的关键字: exec() 不再是一个关键字；它仍是一个函数。 （幸运的是该函数语法也在 2.x 中被接受。） 还要注意 exec() 将不再接受流作为参数；你可以将原来的 exec(f) 改为使用 exec(f.read())。

整数字面值不再支持 l 或 L 后缀。

字符串字面值不再支持 u 或 U 前缀。

from module import * 语法仅允许在模块层级使用，不再允许出现于函数内部。

唯一可接受的相对导入语法为 from .[module] import name。 所有不以 . 开头的 import 形式都将被解读为绝对导入。 (PEP 328 [https://www.python.org/dev/peps/pep-0328])

经典类已不复存在。

已存在于 Python 2.6 中的改变

由于许多用户可能会直接从 Python 2.5 跳到 Python 3.0，因此本节提醒读者注意最初为 Python 3.0 设计但后来移植到 Python 2.6 的新特性。 如需更详细的说明请参阅 Python 2.6 有什么新变化 中的相应章节。

PEP 343: "with" 语句。 现在 with 语句已是一个标准特性而不再需要从 __future__ 导入。 另请参阅 编写上下文管理器 和 contextlib 模块。

PEP 366: 从主模块显式相对导入。 这增强了 -m 选项在被引用的模块位于包中时的实用性。

PEP 370: 分用户的 site-packages 目录.

PEP 371: 多任务处理包.

PEP 3101: 高级字符串格式。 注意：2.6 说明文档提到 format() 方法同时适用于 8 位和 Unicode 字符串。 在 3.0 中，只有 str 类型（带有 Unicode 支持的文本字符串）才支持此方法；bytes 类型并不支持。 最终的计划是使其成为仅针对字符串格式化的 API，并在 Python 3.1 中开始弃用 % 字符串运算符。

PEP 3105: print 改为函数。 现在这已是一个标准特性而不再需要从 __future__ 导入。 更多详情见上文。

PEP 3110: 异常处理的变更。 现在 except exc as var 语法已成为标准而 except exc, var 不再受到支持。 （当然，as var 部分仍为可选项。）

PEP 3112: 字节字面值。 现在 b"..." 字节串字面值标记法（及其变化形式如 b'...', b"""...""" 和 br"..." 等将产生 bytes 类型的字面值。

PEP 3116: 新 I/O 库: io 模块现在是进行文件输入/输出的标准方法。 内置的 open() 函数现在是 io.open() 的别名，并增加了 encoding、errors、newline 和 closefd 等关键字参数。 还要注意的是，无效的 mode 参数现在会引发 ValueError，而不是 IOError。 文本文件对象底层的二进制文件对象可以像 f.buffer 一样访问（但要注意，文本对象会为自己保留一个缓冲区，以加快编码和解码操作。）

PEP 3118: 修改缓冲区协议. The old builtin buffer() is now really gone; the new builtin memoryview() provides (mostly) similar functionality.

PEP 3119: 抽象基类. The abc module and the ABCs defined in the collections module plays a somewhat more prominent role in the language now, and built-in collection types like dict and list conform to the collections.MutableMapping and collections.MutableSequence ABCs, respectively.

PEP 3127: 整型文字支持和语法。 如上文所述，新的八进制字面值标记法是唯一受支持的形式，并增加了二进制字面值。

PEP 3129: 类装饰器.

PEP 3141: 数字的类型层级结构。 numbers 模块是 ABC 的另一个新用例，它定义了 Python 的“数字层级塔”。 另请注意新的 fractions 模块，它实现了 numbers.Rational。

库的修改

由于时间有限，本文档并未完全覆盖标准库的所有变化内容。 PEP 3108 [https://www.python.org/dev/peps/pep-3108] 提供了对标准库主要修改的引用列表。 以下是精简版的预览：

Many old modules were removed. Some, like gopherlib (no longer used) and md5 (replaced by hashlib), were already deprecated by PEP 4 [https://www.python.org/dev/peps/pep-0004]. Others were removed as a result of the removal of support for various platforms such as Irix, BeOS and Mac OS 9 (see PEP 11 [https://www.python.org/dev/peps/pep-0011]). Some modules were also selected for removal in Python 3.0 due to lack of use or because a better replacement exists. See PEP 3108 [https://www.python.org/dev/peps/pep-3108] for an exhaustive list.

The bsddb3 package was removed because its presence in the core standard library has proved over time to be a particular burden for the core developers due to testing instability and Berkeley DB's release schedule. However, the package is alive and well, externally maintained at https://www.jcea.es/programacion/pybsddb.htm.

一些模块名称已被修改因为它们的旧名称不符合 PEP 8 [https://www.python.org/dev/peps/pep-0008]，或是出于各种其他理由。 具体列表如下：

旧名称 | 新名称
_winreg | winreg
ConfigParser | configparser
copy_reg | copyreg
Queue | queue
SocketServer | socketserver
markupbase | _markupbase
repr | reprlib
test.test_support | test.support

A common pattern in Python 2.x is to have one version of a module implemented in pure Python, with an optional accelerated version implemented as a C extension; for example, pickle and cPickle. This places the burden of importing the accelerated version and falling back on the pure Python version on each user of these modules. In Python 3.0, the accelerated versions are considered implementation details of the pure Python versions. Users should always import the standard version, which attempts to import the accelerated version and falls back to the pure Python version. The pickle / cPickle pair received this treatment. The profile module is on the list for 3.1. The StringIO module has been turned into a class in the io module.

一些有关联的模块已被组织为包，通常其子模块名也得到了简化。 这样产生的新包有：

dbm (anydbm, dbhash, dbm, dumbdbm, gdbm, whichdb).

html (HTMLParser, htmlentitydefs).

http (httplib, BaseHTTPServer, CGIHTTPServer, SimpleHTTPServer, Cookie, cookielib).

tkinter (all Tkinter-related modules except turtle). The target audience of turtle doesn't really care about tkinter. Also note that as of Python 2.6, the functionality of turtle has been greatly enhanced.

urllib (urllib, urllib2, urlparse, robotparse).

xmlrpc (xmlrpclib, DocXMLRPCServer, SimpleXMLRPCServer).

其他一些针对标准库模块的改变，未被 PEP 3108 [https://www.python.org/dev/peps/pep-3108] 覆盖：

Killed sets. Use the built-in set() class.

Cleanup of the sys module: removed sys.exitfunc(), sys.exc_clear(), sys.exc_type, sys.exc_value, sys.exc_traceback. (Note that sys.last_type etc. remain.)

Cleanup of the array.array type: the read() and write() methods are gone; use fromfile() and tofile() instead. Also, the 'c' typecode for array is gone -- use either 'b' for bytes or 'u' for Unicode characters.

Cleanup of the operator module: removed sequenceIncludes() and isCallable().

Cleanup of the thread module: acquire_lock() and release_lock() are gone; use acquire() and release() instead.

Cleanup of the random module: removed the jumpahead() API.

The new module is gone.

The functions os.tmpnam(), os.tempnam() and os.tmpfile() have been removed in favor of the tempfile module.

tokenize 模块已被修改以适用于字节串。 主入口点现在是 tokenize.tokenize()，而不是 generate_tokens。

string.letters and its friends (string.lowercase and string.uppercase) are gone. Use string.ascii_letters etc. instead. (The reason for the removal is that string.letters and friends had locale-specific behavior, which is a bad idea for such attractively named global "constants".)

Renamed module __builtin__ to builtins (removing the underscores, adding an 's'). The __builtins__ variable found in most global namespaces is unchanged. To modify a builtin, you should use builtins, not __builtins__!

PEP 3101 [https://www.python.org/dev/peps/pep-3101]: 字符串格式化的新方式

一种针对内置字符串格式化操作的新系统替代了 % 字符串格式化运算符。 （不过，% 运算符仍然受到支持；它将在 Python 3.1 中被弃用并在今后某一时刻从语言特性中移除。） 请参阅 PEP 3101 [https://www.python.org/dev/peps/pep-3101] 了解详情。

对异常的修改

用于引发和捕获异常的 API 已经过清理并增加了强大的新特性：

PEP 352 [https://www.python.org/dev/peps/pep-0352]: 所有异常都必须（直接或间接地）派生自 BaseException。 这是异常层级结构的根对象。 作为推荐方式这并不是新的变化，但 必须 从 BaseException 继承是新的变化。 （Python 2.6 仍然允许引发经典类，并且不限制你能捕获的异常。） 作为此变化的结果，字符串异常终于真正彻底地死亡了。

几乎所有异常实际上都应当派生自 Exception；BaseException 仅应当被用作那些仅应当在最高层级中处理的异常的基类，如 SystemExit 或 KeyboardInterrupt。 处理除了后面这一类之外的所有异常的推荐写法是使用 except Exception。

StandardError was removed.

Exceptions no longer behave as sequences. Use the args attribute instead.

PEP 3109 [https://www.python.org/dev/peps/pep-3109]: Raising exceptions. You must now use raise Exception(args) instead of raise Exception, args. Additionally, you can no longer explicitly specify a traceback; instead, if you have to do this, you can assign directly to the __traceback__ attribute (see below).

PEP 3110 [https://www.python.org/dev/peps/pep-3110]: 捕获异常。 你现在必须使用 except SomeException as variable 而不是 except SomeException, variable。 此外，variable 会在离开 except 代码块时被显式地删除。

PEP 3134 [https://www.python.org/dev/peps/pep-3134]: Exception chaining. There are two cases: implicit chaining and explicit chaining. Implicit chaining happens when an exception is raised in an except or finally handler block. This usually happens due to a bug in the handler block; we call this a secondary exception. In this case, the original exception (that was being handled) is saved as the __context__ attribute of the secondary exception. Explicit chaining is invoked with this syntax:

raise SecondaryException() from primary_exception

(where primary_exception is any expression that produces an exception object, probably an exception that was previously caught). In this case, the primary exception is stored on the __cause__ attribute of the secondary exception. The traceback printed when an unhandled exception occurs walks the chain of __cause__ and __context__ attributes and prints a separate traceback for each component of the chain, with the primary exception at the top. (Java users may recognize this behavior.)

PEP 3134 [https://www.python.org/dev/peps/pep-3134]: Exception objects now store their traceback as the __traceback__ attribute. This means that an exception object now contains all the information pertaining to an exception, and there are fewer reasons to use sys.exc_info() (though the latter is not removed).

一些提示 Windows 载入扩展模块失败的异常消息得到了改进。 例如，error code 193 现在是 %1 is not a valid Win32 application。 字符串现在可处理非英语的语言区域。

其他杂项修改

运算符与特殊方法

现在 != 将返回与 == 相反的结果，除非 == 是返回 NotImplemented。

“未绑定方法”的概念已从语言中移除。 现在当把一个方法作为类属性来引用时，你将得到一个基本函数对象。

__getslice__(), __setslice__() and __delslice__() were killed. The syntax a[i:j] now translates to a.__getitem__(slice(i, j)) (or __setitem__() or __delitem__(), when used as an assignment or deletion target, respectively).

PEP 3114 [https://www.python.org/dev/peps/pep-3114]: 标准的 next() 方法已被重命名为 __next__()。

The __oct__() and __hex__() special methods are removed -- oct() and hex() use __index__() now to convert the argument to an integer.

Removed support for __members__ and __methods__.

The function attributes named func_X have been renamed to use the __X__ form, freeing up these names in the function attribute namespace for user-defined attributes. To wit, func_closure, func_code, func_defaults, func_dict, func_doc, func_globals, func_name were renamed to __closure__, __code__, __defaults__, __dict__, __doc__, __globals__, __name__, respectively.

__nonzero__() is now __bool__().

内置对象

PEP 3135 [https://www.python.org/dev/peps/pep-3135]: 新的 super()。 现在你可以不带参数地唤起 super() 这样（假定这发生在定义于 class 语句内部的常规实例方法中）将会自动选择正确的类和实例。 附带参数时，super() 的行为保持不变。

PEP 3111 [https://www.python.org/dev/peps/pep-3111]: raw_input() was renamed to input(). That is, the new input() function reads a line from sys.stdin and returns it with the trailing newline stripped. It raises EOFError if the input is terminated prematurely. To get the old behavior of input(), use eval(input()).

新增内置函数 next() 用于在对象上调用 __next__() 方法。

round() 函数的舍入策略和返回类型已有改变。 对于两边差值相同的情况现在将会舍入到最接近的偶数结果而不是远离零值的结果。 （例如，round(2.5) 现在将返回 2 而不是 3。） 现在 round(x[, n]) 将委托给 x.__round__([n]) 而不是始终返回一个浮点数。 它通常会在附带一个参数调用时返回整数而在附带两个参数调用时返回与 x 相同类型的值。

Moved intern() to sys.intern().

Removed: apply(). Instead of apply(f, args) use f(*args).

Removed callable(). Instead of callable(f) you can use isinstance(f, collections.Callable). The operator.isCallable() function is also gone.

Removed coerce(). This function no longer serves a purpose now that classic classes are gone.

Removed execfile(). Instead of execfile(fn) use exec(open(fn).read()).

Removed the file type. Use open(). There are now several different kinds of streams that open can return in the io module.

Removed reduce(). Use functools.reduce() if you really need it; however, 99 percent of the time an explicit for loop is more readable.

Removed reload(). Use imp.reload().

Removed. dict.has_key() -- use the in operator instead.

构建和 C API 的改变

由于时间约束，下面 C API 的变化列表 非常 不完整。

已放弃对某些平台的支持，包括但不限于 Mac OS 9, BeOS, RISCOS, Irix 和 Tru64。

PEP 3118 [https://www.python.org/dev/peps/pep-3118]: 新的缓冲区 API。

PEP 3121 [https://www.python.org/dev/peps/pep-3121]: 扩展模块初始化与最终化。

PEP 3123 [https://www.python.org/dev/peps/pep-3123]: 使 PyObject_HEAD 与标准 C 一致。

已去除对受限执行的 C API 支持。

PyNumber_Coerce(), PyNumber_CoerceEx(), PyMember_Get(), and PyMember_Set() C API 已被移除。

新的 C API PyImport_ImportModuleNoBlock()，类似于 PyImport_ImportModule() 但不会因导入锁而阻塞（改为返回错误）。

重命名布尔转换的 C 层级槽位和方法: nb_nonzero 现在改为 nb_bool。

从 C API 中移除 METH_OLDARGS 和 WITH_CYCLE_GC。

性能

综合而言 3.0 的改变使得 Python 3.0 运行 pystone 基准测试的速度比 Python 2.5 慢了约 10%。 其中最大的原因可能是移除了针对小整数的特别场景的处理。 虽然存在改进空间，但这将在 3.0 发布之后再进行！

移植到 Python 3.0

对于将现有 Python 2.5 或 2.6 源代码移植到 Python 3.0，最佳的策略如下：

（必要前提：）启动良好的测试覆盖。

移植到 Python 2.6。 这应该不会比从 Python 2.x 到 Python 2.(x+1) 的正常移植更麻烦。 请确保所有的测试均能通过。

（仍然使用 2.6：） 打开 -3 命令行开关。 这将启用针对将在 3.0 中被移除（或修改）的特性的警告。 再次运行你的测试套件，并修复你收到相关警告的代码直至不再有任何警告，并且所有的测试仍然能通过。

Run the 2to3 source-to-source translator over your source code tree. (See 2to3 --- 自动化的 Python 2 到 3 代码转写 for more on this tool.) Run the result of the translation under Python 3.0. Manually fix up any remaining issues, fixing problems until all tests pass again.

不建议尝试编写可不加修改地同时运行于 Python 2.6 和 3.0 的源代码；你将不得不使用一种非常扭曲的代码风格，例如避免 print 语句、元类和许多其他特性。 如果你正在维护需要同时支持 Python 2.6 和 Python 3.0 的库，最佳做法是将上述的步骤 3 修改为编辑源代码的 2.6 版本并再次运行 2to3 翻译器，而不是修改源代码的 3.0 版本。

有关如何将 C 扩展移植到 Python 3.0，请参阅 将扩展模块移植到 Python 3。

Python 2.7 有什么新变化

作者

A.M. Kuchling (amk at amk.ca)

本文介绍了Python 2.7 的新功能。 Python 2.7 于2010年7月3日发布。

数字处理在许多方面得到了改进，包括浮点数和 Decimal 类。标准库中有一些有用的补充，例如大大增强的 unittest 模块，用于解析命令行选项的 argparse 模块，在 collections 模块中方便的 OrderedDict 和 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”链接到每个更改的错误修正/补丁项。

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系列的预期完整生命周期在 PEP 373 [https://www.python.org/dev/peps/pep-0373] 中有详细介绍。

长期保留 2.7 版的的一些关键后果：

如上所述，与早期的2.x版本相比，2.7版本的维护时间更长。目前，预计核心开发团队将继续支持Python 2.7（接收安全更新和其他错误修复），直到至少2020年（首次发布后10年，相比之下，通常的支持期为18--24个月）。

随着 Python 2.7 标准库的老化，有效地利用 Python 包索引（直接或通过重新分发者）对 Python 2 用户来说变得更加重要。除了各种任务的第三方包之外，可用的包还包括与 Python 2 兼容的 Python 3 标准库中的新模块和功能的后端移植，以及各种工具和库，这些工具和库可以让用户更容易迁移到 Python 3。 Python 包用户指南 [https://packaging.python.org] 提供了从 Python 包索引的下载和安装软件的指导。

虽然现在增强 Python 2 的首选方法是在Python包索引上发布新包，但这种方法不一定适用于所有情况，尤其是与网络安全相关的情况。在一些特殊情况下，如果在PyPI上发布新的或更新的包无法得到充分的处理，则可以使用Python增强建议过程来提出直接在Python 2标准库中添加新功能。任何此类添加及其添加的维护版本将在下面的 Python 2.7 维护版本中添加的新特性 部分中注明。

对于希望从 Python2 迁移到 Python3 的项目，或者对于希望同时支持 Python2 和 Python3 用户的库和框架开发人员，可以使用各种工具和指南来帮助决定合适的方法并管理所涉及的一些技术细节。建议从 将 Python 2 代码迁移到 Python 3 操作指南开始。

对于弃用警告处理方式的改变

对于 Python 2.7，一个策略决定是默认情况下禁止只对开发人员有兴趣的警告。 现在，除非另有要求，否则将忽略 DeprecationWarning 及其子类，以防止用户看到应用程序触发的警告。 这个更改也在成为Python 3.2 的分歧点上进行了。 （在 stdlib-sig 上进行了讨论，并在 bpo-7319 [https://bugs.python.org/issue?@action=redirect&bpo=7319] 中执行。）

在以前的版本中，默认情况下启用了 DeprecationWarning 消息，为 Python 开发人员提供了一个明确的指示，说明他们的代码可能在未来的 Python 主要版本中出现问题。

然而，越来越多基于 Python 的应用程序的用户并不直接参与这些应用程序的开发。 DeprecationWarning 消息与这些用户无关，这让他们担心应用能否真正正常工作，并让应用开发人员承担起回应这些担忧的负担。

显示通过使用 -Wdefault (简写: -Wd) 开关运行 Python，或者在运行 Python 之前将 PYTHONWARNINGS 环境变量设置为 "default" (或 "d")，可以重新启用 DeprecationWarning 消息。 Python 代码也可以通过调用 warnings.simplefilter('default') 重新启用它们。

unittest 模块还会在运行测试时自动重新启用弃用警告。

Python 3.1 特性

就像 Python2.6 集成了 Python3.0 的特性一样，2.7版也集成了 Python3.1 中的一些新特性。2.x 系列继续提供迁移到3.x系列的工具。

3.1 功能的部分列表，这些功能已反向移植到 2.7：

用于集合字面值的语法 ({1,2,3} 是一个可变集合)。

字典与集合推导式 ({i: i*2 for i in range(3)})。

单个 with 语句中使用多个上下文管理器。

一个 io 库的新版本，用 C 重写以提升性能。

PEP 372：将有序字典 添加到收藏集 所描述的有序字典类型。

PEP 378: 千位分隔符的格式说明符 所描述的新的 "," 格式说明符。

memoryview 对象。

importlib 模块的一个较小子集，described below。

在很多情况下，浮点数 x 的 repr() 更短：现在它基于最短的十进制字符串 ，保证四舍五入到 x。 与 Python 以前的版本一样，保证 float(repr(x)) 能恢复到 x。

浮点数到字符串和字符串到浮点数的转换已正确舍入。 round() 函数现在也能正确舍入。

PyCapsule 类型，用于为扩展模块提供 C API 。

PyLong_AsLongAndOverflow() C API 函数 。

其他新的 Python3 模式警告包括：

operator.isCallable() and operator.sequenceIncludes(), which are not supported in 3.x, now trigger warnings.

-3 开关现在会自动启用:option:!-Qwarn 开关，该开关会在使用经典整除法处理整数和长整数时发出警告。

PEP 372：将有序字典 添加到收藏集

常规 Python 字典以任意顺序遍历键/值对。 多年来，许多作者编写了替代实现，以记住键最初插入的顺序。 基于这些实现的经验，2.7 在 collections 模块中引入了一个新的 OrderedDict 类。

OrderedDict API 提供与普通字典相同的接口 ，但会根据键首次插入的时间，按一定顺序遍历键和值：：

>>> from collections import OrderedDict
>>> d = OrderedDict([('first', 1),
...                  ('second', 2),
...                  ('third', 3)])
>>> d.items()
[('first', 1), ('second', 2), ('third', 3)]

如果新条目覆盖了现有条目，则原插入位置保持不变

>>> d['second'] = 4
>>> d.items()
[('first', 1), ('second', 4), ('third', 3)]

删除条目并重新插入会将其移至末尾

>>> del d['second']
>>> d['second'] = 5
>>> d.items()
[('first', 1), ('third', 3), ('second', 5)]

popitem() 方法有一个可选 last 参数 ，默认为 True 。如果 last 为真 ，则返回并删除最近添加的密钥；如果为 false ，则选择最旧的密钥

>>> 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)

比较两个有序字典会同时检查键和值，并要求插入顺序相同

>>> od1 = OrderedDict([('first', 1),
...                    ('second', 2),
...                    ('third', 3)])
>>> od2 = OrderedDict([('third', 3),
...                    ('first', 1),
...                    ('second', 2)])
>>> od1 == od2
False
>>> # Move 'third' key to the end
>>> del od2['third']; od2['third'] = 3
>>> od1 == od2
True

将 OrderedDict 与普通字典进行比较时，会忽略插入顺序，只比较键和值。

How does the OrderedDict work? It maintains a doubly linked list of keys, appending new keys to the list as they're inserted. A secondary dictionary maps keys to their corresponding list node, so deletion doesn't have to traverse the entire linked list and therefore remains O(1).

现在，标准库支持在多个模块 中使用有序字典。

The ConfigParser module uses them by default, meaning that configuration files can now be read, modified, and then written back in their original order.

collections.namedtuple() 的 _asdict() 方法现在会返回一个有序字典，其值的出现顺序与底层元组的索引相同。

json 模块的 JSONDecoder 类构造器扩展了一个 object_pairs_hook 形参 ，允许解码器构建 OrderedDict 实例。此外，还添加了对第三方工具的支持，如 PyYAML [https://pyyaml.org/] 。

参见

PEP 372 [https://www.python.org/dev/peps/pep-0372] - 将有序词典添加到集合中

PEP 由 Armin Ronacher 和 Raymond Hettinger 撰写，由 Raymond Hettinger 实现。

PEP 378: 千位分隔符的格式说明符

为了使程序输出更易读，可以在大数字上添加分隔符，将其显示为 18,446,744,073,709,551,616 而不是 18446744073709551616。

完全通用的解决方案是 locale 模块 ，它可以使用不同的分隔符（北美为","，欧洲为"."）和不同的分组大小，但 locale 使用起来比较复杂，而且不适合多线程应用程序，因为不同的线程会为不同的本地生成输出。

因此，在 str.format() 方法使用的迷你语言中添加了一个简单的逗号分组机制。 在格式化浮点数时，只需在宽度和精度之间加上逗号

>>> '{:20,.2f}'.format(18446744073709551616.0)
'18,446,744,073,709,551,616.00'

格式化整数时，在宽度后面加上逗号：

>>> '{:20,d}'.format(18446744073709551616)
'18,446,744,073,709,551,616'

这种机制完全没有适应性；逗号总是用作分隔符，分组总是以三位数为一组。 逗号格式机制不如 locale 模块通用，但使用起来更方便。

参见

PEP 378 [https://www.python.org/dev/peps/pep-0378] - 千位分隔符的格式说明符

PEP 由 Raymond Hettinger 撰写，由 Eric Smith 实现

PEP 389：用于解析命令行的 argparse 模块

用于解析命令-line参数的 argparse 模块是作为 optparse 模块更强大的替代功能而添加的。

This means Python now supports three different modules for parsing command-line arguments: getopt, optparse, and argparse. The getopt module closely resembles the C library's getopt() function, so it remains useful if you're writing a Python prototype that will eventually be rewritten in C. optparse becomes redundant, but there are no plans to remove it because there are many scripts still using it, and there's no automated way to update these scripts. (Making the argparse API consistent with optparse's interface was discussed but rejected as too messy and difficult.)

简而言之，如果你是在编写新脚本并且不需要担心与 Python 较早版本的兼容性，请使用 argparse 而不是 optparse。

以下是为示例代码:

import argparse

parser = argparse.ArgumentParser(description='Command-line example.')

# Add optional switches
parser.add_argument('-v', action='store_true', dest='is_verbose',
                    help='produce verbose output')
parser.add_argument('-o', action='store', dest='output',
                    metavar='FILE',
                    help='direct output to FILE instead of stdout')
parser.add_argument('-C', action='store', type=int, dest='context',
                    metavar='NUM', default=0,
                    help='display NUM lines of added context')

# Allow any number of additional arguments.
parser.add_argument(nargs='*', action='store', dest='inputs',
                    help='input filenames (default is stdin)')

args = parser.parse_args()
print args.__dict__

除非你覆盖它，否则会自动添加 -h 和 --help 开关，并产生格式化良好的输出:

-> ./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

与 optparse 一样，命令行开关和参数将返回为一个具有通过 dest 形参所指定的属性的对象:

-> ./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']}

argparse 模块提供了比 optparse 更强大的参数验证功能：你可以通过指定整数来要求精确数量的参数，使用 '*' 表示接受零个或多个参数，使用 '+' 表示接受一个或多个参数，或者使用 '?' 表示可选参数。顶层解析器还可以包含子解析器，用于定义具有不同开关选项集的子命令（例如 svn commit、svn checkout 等）。此外，你可以将参数类型指定为 FileType，该类型会自动为你打开文件，并理解 '-' 表示标准输入或输出。

参见

argparse 文档

argparse 模块的文档页面。

升级 optparse 代码

Python 文档的一部分，描述如何转换使用了 optparse 的代码。

PEP 389 [https://www.python.org/dev/peps/pep-0389] - argparse - 新的命令行解析模块

PEP 由 Steven Bethard 撰写并实现。

PEP 391: 基于字典的日志配置

logging 模块非常灵活；应用程序可以定义一个日志子系统树，树中的每个记录器可以过滤掉某些消息，以不同的方式格式化它们，并将消息定向到不同数量的处理器。

All this flexibility can require a lot of configuration. You can write Python statements to create objects and set their properties, but a complex set-up requires verbose but boring code. logging also supports a fileConfig() function that parses a file, but the file format doesn't support configuring filters, and it's messier to generate programmatically.

Python 2.7 adds a dictConfig() function that uses a dictionary to configure logging. There are many ways to produce a dictionary from different sources: construct one with code; parse a file containing JSON; or use a YAML parsing library if one is installed. For more information see 配置函数.

以下示例配置了两个日志记录器，根日志记录器和一个名为 "network" 的日志记录器。发送到根日志记录器的消息将使用 syslog 协议发送到系统日志，而发送到 "network" 日志记录器的消息将写入一个 network.log 文件，当日志达到 1MB 时将进行轮转。

import logging
import logging.config

configdict = {
 'version': 1,    # Configuration schema in use; must be 1 for now
 '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'}},

 # Specify all the subordinate loggers
 'loggers': {
             'network': {
                         'handlers': ['netlog']
             }
 },
 # Specify properties of the root logger
 'root': {
          'handlers': ['syslog']
 },
}

# Set up configuration
logging.config.dictConfig(configdict)

# As an example, log two error messages
logger = logging.getLogger('/')
logger.error('Database not found')

netlogger = logging.getLogger('network')
netlogger.error('Connection failed')

Vinay Sajip 实现的对 logging 模块的三项较小增强是：

SysLogHandler 类现在支持通过 TCP 进行系统日志记录。构造函数有一个 socktype 参数，用于指定要使用的套接字类型，可以是 socket.SOCK_DGRAM 用于 UDP 或 socket.SOCK_STREAM 用于 TCP。默认协议仍然是 UDP。

Logger 实例新增了一个 getChild() 方法，用于通过相对路径检索子日志记录器。例如，一旦通过 log = getLogger('app') 获取日志记录器，调用 log.getChild('network.listen') 等同于 getLogger('app.network.listen')。

The LoggerAdapter class gained an isEnabledFor() method that takes a level and returns whether the underlying logger would process a message of that level of importance.

参见

PEP 391 [https://www.python.org/dev/peps/pep-0391] - 基于字典的日志配置

PEP 由 Vinay Sajip 撰写并实现

PEP 3106: 字典视图

字典方法 keys(), values(), and items() 在 Python 3.x 有所不同。 它们将返回名为 view 的对象而不是完整的列表。

It's not possible to change the return values of keys(), values(), and items() in Python 2.7 because too much code would break. Instead the 3.x versions were added under the new names viewkeys(), viewvalues(), and viewitems().

>>> 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])

视图可以被迭代，但键和条目视图的行为也很像是集合。 & 运算符执行交集运算，| 执行并集运算:

>>> 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])

视图会追踪字典及字典被修改时的内容变化:

>>> vk = d.viewkeys()
>>> vk
dict_keys([0, 130, 10, ..., 250])
>>> d[260] = '&'
>>> vk
dict_keys([0, 130, 260, 10, ..., 250])

但是，请注意在对视图进行迭代时你是不能添加或移除键的:

>>> 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

你可以在 Python 2.x 代码中使用视图方法，2to3 转换器会将它们更改为标准的 keys()、values() 和 items() 方法。

参见

PEP 3106 [https://www.python.org/dev/peps/pep-3106] - 改造 dict.keys(), .values() 和 .items()

PEP 由 Guido van Rossum 撰写。 由 Alexandre Vassalotti 反向移植到 2.7； bpo-1967 [https://bugs.python.org/issue?@action=redirect&bpo=1967]。

PEP 3137: memoryview 对象

memoryview 对象提供与 bytes 类型的接口相匹配的另一个对象的内存内容的视图。

>>> import string
>>> m = memoryview(string.letters)
>>> m
<memory at 0x37f850>
>>> len(m)           # Returns length of underlying object
52
>>> m[0], m[25], m[26]   # Indexing returns one byte
('a', 'z', 'A')
>>> m2 = m[0:26]         # Slicing returns another memoryview
>>> m2
<memory at 0x37f080>

视图的内容可被转换为一个字节串或整数列表：

>>> m2.tobytes()
'abcdefghijklmnopqrstuvwxyz'
>>> m2.tolist()
[97, 98, 99, 100, 101, 102, 103, ... 121, 122]
>>>

memoryview 对象允许对属于可变对象的下层对象进行修改。

>>> m2[0] = 75
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot modify read-only memory
>>> b = bytearray(string.letters)  # Creating a mutable object
>>> b
bytearray(b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
>>> mb = memoryview(b)
>>> mb[0] = '*'         # Assign to view, changing the bytearray.
>>> b[0:5]              # The bytearray has been changed.
bytearray(b'*bcde')
>>>

参见

PEP 3137 [https://www.python.org/dev/peps/pep-3137] - 不变字节和可变缓冲区

PEP 由 Guido van Rossum 撰写。 由 Travis Oliphant, Antoine Pitrou 等人实现。 由 Antoine Pitrou 向下移植到 2.7; bpo-2396 [https://bugs.python.org/issue?@action=redirect&bpo=2396]。

其他语言特性修改

对Python 语言核心进行的小改动：

已从 Python 3.x 向下移植了集合字面值语法。 使用花括号来标记可变集合的内容；集合与字典的区别在于它不包含冒号及映射的值。 {} 仍然表示空字典；请使用 set() 来表示空集合。

>>> {1, 2, 3, 4, 5}
set([1, 2, 3, 4, 5])
>>> set() # empty set
set([])
>>> {}    # empty dict
{}

由 Alexandre Vassalotti 向下移植; bpo-2335 [https://bugs.python.org/issue?@action=redirect&bpo=2335]。

字典与集合推导式是另一个从 3.x 向下移植的特性，对列表/生成器推导式进行一般化以针对集合与字典使用字面值语法。

>>> {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(['', 'a', 'aa', 'aaa', 'aaaa', 'aaaaa'])

由 Alexandre Vassalotti 向下移植; bpo-2333 [https://bugs.python.org/issue?@action=redirect&bpo=2333]。

现在 with 语句可以在一个语句中使用多个上下文管理器。 上下文管理器将按从左到右的顺序处理并且每个都会被视为开始一个新的 with 语句。 这意味着:

with A() as a, B() as b:
    ... suite of statements ...

相当于:

with A() as a:
    with B() as b:
        ... suite of statements ...

The contextlib.nested() function provides a very similar function, so it's no longer necessary and has been deprecated.

（提议于 https://codereview.appspot.com/53094；由 Georg Brandl 实现。）

在大多数平台上，浮点数和字符串之间的转换现在正确地四舍五入。这些转换发生在许多不同的地方：对浮点数和复数的 str()；float 和 complex 构造函数；数值格式化；使用 marshal、pickle 和 json 模块序列化和反序列化浮点数和复数；在 Python 代码中解析浮点数和虚数字面量；以及 Decimal 到浮点数的转换。

与此相关，浮点数 x 的 repr() 现在返回基于最短十进制字符串的结果，该字符串保证在正确四舍五入（采用四舍六入五成双模式）的情况下能返回到 x。之前它给出的是基于将 x 四舍五入到 17 位小数的字符串。

负责此改进的舍入库在Windows和Unix平台上使用gcc、icc或suncc编译器工作。可能有一些平台无法保证此代码的正确运行，因此在这些系统上不使用此代码。你可以通过检查 sys.float_repr_style 来了解正在使用的代码，如果使用新代码则为``short``，未使用则为``legacy``。

由Eric Smith和Mark Dickinson实现，使用David Gay的 dtoa.c 库；参见 bpo-7117 [https://bugs.python.org/issue?@action=redirect&bpo=7117]。

从长整数和普通整数转换为浮点数现在有不同的舍入方式，返回最接近该数的浮点数。对于可以精确转换的小整数，这无关紧要，但对于不可避免会丢失精度的大数，Python 2.7现在更接近真实值。例如，Python 2.6计算如下：

>>> n = 295147905179352891391
>>> float(n)
2.9514790517935283e+20
>>> n - long(float(n))
65535L

Python 2.7的浮点结果更大，但更接近真实值：

>>> n = 295147905179352891391
>>> float(n)
2.9514790517935289e+20
>>> n - long(float(n))
-1L

（由Mark Dickinson实现；参见 bpo-3166 [https://bugs.python.org/issue?@action=redirect&bpo=3166]。）

整数除法在舍入行为上也更准确。（也由Mark Dickinson实现；参见 bpo-1811 [https://bugs.python.org/issue?@action=redirect&bpo=1811]。）

Implicit coercion for complex numbers has been removed; the interpreter will no longer ever attempt to call a __coerce__() method on complex objects. (Removed by Meador Inge and Mark Dickinson; bpo-5211 [https://bugs.python.org/issue?@action=redirect&bpo=5211].)

str.format() 方法现在支持替换字段的自动编号。这使得使用 str.format() 更类似于使用``%s``格式化：

>>> '{}:{}:{}'.format(2009, 04, 'Sunday')
'2009:4:Sunday'
>>> '{}:{}:{day}'.format(2009, 4, day='Sunday')
'2009:4:Sunday'

自动编号从左到右获取字段，因此第一个 {...} 指定符将使用 str.format() 的第一个参数，下一个指定符将使用下一个参数，依此类推。不能混合使用自动编号和显式编号——要么为所有指定符字段编号，要么不编号——但可以混合使用自动编号和命名字段，如上第二个示例所示。（由 Eric Smith 贡献；参见 bpo-5237 [https://bugs.python.org/issue?@action=redirect&bpo=5237]。）

复数现在正确支持与 format() 的使用，并默认右对齐。指定精度或逗号分隔适用于数字的实部和虚部，但指定的字段宽度和对齐应用于整个 1.5+3j 输出。（由 Eric Smith 贡献；参见 bpo-1588 [https://bugs.python.org/issue?@action=redirect&bpo=1588] 和 bpo-7988 [https://bugs.python.org/issue?@action=redirect&bpo=7988]。）

“F”格式代码现在总是使用大写字符格式化其输出，因此它现在将产生“INF”和“NAN”。（由 Eric Smith 贡献；参见 bpo-3382 [https://bugs.python.org/issue?@action=redirect&bpo=3382]。）

A low-level change: the object.__format__() method now triggers a PendingDeprecationWarning if it's passed a format string, because the __format__() method for object converts the object to a string representation and formats that. Previously the method silently applied the format string to the string representation, but that could hide mistakes in Python code. If you're supplying formatting information such as an alignment or precision, presumably you're expecting the formatting to be applied in some object-specific way. (Fixed by Eric Smith; bpo-7994 [https://bugs.python.org/issue?@action=redirect&bpo=7994].)

The int() and long() types gained a bit_length method that returns the number of bits necessary to represent its argument in binary:

>>> n = 37
>>> bin(n)
'0b100101'
>>> n.bit_length()
6
>>> n = 2**123-1
>>> n.bit_length()
123
>>> (n+1).bit_length()
124

（由 Fredrik Johansson 和 Victor Stinner 贡献；参见 bpo-3439 [https://bugs.python.org/issue?@action=redirect&bpo=3439]。）

如果相对导入（例如 from .os import sep）失败，import 语句将不再尝试绝对导入。这修复了一个错误，但可能会破坏某些仅凭偶然才工作的 import 语句。（由 Meador Inge 修复；参见 bpo-7902 [https://bugs.python.org/issue?@action=redirect&bpo=7902]。）

It's now possible for a subclass of the built-in unicode type to override the __unicode__() method. (Implemented by Victor Stinner; bpo-1583863 [https://bugs.python.org/issue?@action=redirect&bpo=1583863].)

bytearray 类型的 translate() 方法现在接受 None 作为其第一个参数。（由 Georg Brandl 修复；参见 bpo-4759 [https://bugs.python.org/issue?@action=redirect&bpo=4759]。）

When using @classmethod and @staticmethod to wrap methods as class or static methods, the wrapper object now exposes the wrapped function as their __func__ attribute. (Contributed by Amaury Forgeot d'Arc, after a suggestion by George Sakkis; bpo-5982 [https://bugs.python.org/issue?@action=redirect&bpo=5982].)

当使用 __slots__ 设置一组受限属性时，删除未设置的属性不会像预期那样引发 AttributeError。（由 Benjamin Peterson 修复；参见 bpo-7604 [https://bugs.python.org/issue?@action=redirect&bpo=7604]。）

现在支持两种新的编码："cp720"，主要用于阿拉伯文本；以及 "cp858"，是 CP 850 的变体，增加了欧元符号。（CP720 由 Alexander Belchenko 和 Amaury Forgeot d'Arc 在 bpo-1616979 [https://bugs.python.org/issue?@action=redirect&bpo=1616979] 中贡献；CP858 由 Tim Hatch 在 bpo-8016 [https://bugs.python.org/issue?@action=redirect&bpo=8016] 中贡献。）

The file object will now set the filename attribute on the IOError exception when trying to open a directory on POSIX platforms (noted by Jan Kaliszewski; bpo-4764 [https://bugs.python.org/issue?@action=redirect&bpo=4764]), and now explicitly checks for and forbids writing to read-only file objects instead of trusting the C library to catch and report the error (fixed by Stefan Krah; bpo-5677 [https://bugs.python.org/issue?@action=redirect&bpo=5677]).

Python 词法分析器现在会自行处理行尾符，因此内置函数 compile() 现在可以接受采用任意行尾约定（如 Windows 的 CRLF、Unix 的 LF 或旧版 Mac 的 CR）的代码。此外，该函数不再强制要求代码必须以换行符结尾。

在Python 3.x中，函数定义中的额外括号是非法的，这意味着你会从``def f((x)): pass``中得到一个语法错误。在Python3警告模式下，Python 2.7现在会警告这种奇怪的用法。（由James Lingard指出；参见 bpo-7362 [https://bugs.python.org/issue?@action=redirect&bpo=7362]。）

现在可以创建对旧式类对象的弱引用。新式类始终可以弱引用。（由 Antoine Pitrou 修复；参见 bpo-8268 [https://bugs.python.org/issue?@action=redirect&bpo=8268]。）

当一个模块对象被垃圾回收时，该模块的字典现在只有在没有其他引用时才会被清除（参见 bpo-7140 [https://bugs.python.org/issue?@action=redirect&bpo=7140]）。

解释器改动

一个新的环境变量，PYTHONWARNINGS，允许控制警告。它应设置为包含警告设置的字符串，等同于使用 -W 开关的设置，用逗号分隔。（由 Brian Curtin 贡献；参见 bpo-7301 [https://bugs.python.org/issue?@action=redirect&bpo=7301]。）

For example, the following setting will print warnings every time they occur, but turn warnings from the Cookie module into an error. (The exact syntax for setting an environment variable varies across operating systems and shells.)

export PYTHONWARNINGS=all,error:::Cookie:0

性能优化

已添加多项性能优化改进：

A new opcode was added to perform the initial setup for with statements, looking up the __enter__() and __exit__() methods. (Contributed by Benjamin Peterson.)

垃圾回收器现在对一种常见使用模式表现更好：当大量对象被分配而没有释放任何对象时。此前，垃圾回收需要二次方时间，但现在随着堆中对象数量的增长，完整垃圾回收的次数减少了。新逻辑仅在中间代被收集10次且中间代幸存对象数量超过最老代对象数量的10%时，才执行一次完整的垃圾回收。 （由 Martin von Löwis 建议，Antoine Pitrou 实现；参见 bpo-4074 [https://bugs.python.org/issue?@action=redirect&bpo=4074]。）

垃圾回收器会尽量避免追踪那些不可能形成循环引用的简单容器对象。在 Python 2.7 中，对于仅包含原子类型（如整数、字符串等）的元组和字典，现在均符合这一特性。由此推及，包含原子类型元组的字典同样不会被追踪。这一优化通过减少垃圾回收器需要处理和遍历的对象数量，有效降低了每次垃圾回收的开销。（由 Antoine Pitrou 贡献；参见 bpo-4688 [https://bugs.python.org/issue?@action=redirect&bpo=4688]。）

长整型数值现在在内部存储时采用 2**15 或 2**30 作为基数，具体采用哪种基数在构建（编译）时确定。此前，长整型数值始终采用 2**15 作为存储基数。使用 2**30 作为基数能在 64 位机器上带来显著的性能提升，但在 32 位机器上的基准测试结果则好坏参半。因此，默认情况下，在 64 位机器上使用 2**30 作为基数，在 32 位机器上使用 2**15 作为基数；在 Unix 系统上，新增了一个配置选项 --enable-big-digits`（对应选项标记为 :option:!--enable-big-digits`），可用于覆盖这一默认设置。

Apart from the performance improvements this change should be invisible to end users, with one exception: for testing and debugging purposes there's a new structseq sys.long_info that provides information about the internal format, giving the number of bits per digit and the size in bytes of the C type used to store each digit:

>>> import sys
>>> sys.long_info
sys.long_info(bits_per_digit=30, sizeof_digit=4)

（由 Mark Dickinson在 bpo-4258 [https://bugs.python.org/issue?@action=redirect&bpo=4258] 贡献）

另一组更改使长对象缩小了几字节：在32位系统上缩小了2字节，在64位系统上缩小了6字节。（由Mark Dickinson贡献；参见 bpo-5260 [https://bugs.python.org/issue?@action=redirect&bpo=5260]。）

通过收紧内循环、进行位移而不是乘法以及修复不必要的额外迭代，长整数的除法算法已经变得更快。各种基准测试显示，长整数除法和取模操作的加速在50%到150%之间。（由Mark Dickinson贡献；参见 bpo-5512 [https://bugs.python.org/issue?@action=redirect&bpo=5512]。）位运算也显著更快（初始补丁由Gregory Smith提供；参见 bpo-1087418 [https://bugs.python.org/issue?@action=redirect&bpo=1087418]）。

% 的实现检查左侧操作数是否为 Python 字符串并进行特殊处理；这使频繁使用 % 与字符串的应用程序（如模板库）的性能提高了 1% 到 3%。（由 Collin Winter 实现；参见 bpo-5176 [https://bugs.python.org/issue?@action=redirect&bpo=5176]。）

带有``if``条件的列表推导被编译成更快的字节码。（由Antoine Pitrou提供补丁，Jeffrey Yasskin向下移植到2.7；参见 bpo-4715 [https://bugs.python.org/issue?@action=redirect&bpo=4715]。）

通过特殊处理基数10而不是使用支持任意基数的通用转换函数，将整数或长整数转换为十进制字符串的速度得到了提升。（由Gawain Bolton提供补丁；参见 bpo-6713 [https://bugs.python.org/issue?@action=redirect&bpo=6713]。）

The split(), replace(), rindex(), rpartition(), and rsplit() methods of string-like types (strings, Unicode strings, and bytearray objects) now use a fast reverse-search algorithm instead of a character-by-character scan. This is sometimes faster by a factor of 10. (Added by Florent Xicluna; bpo-7462 [https://bugs.python.org/issue?@action=redirect&bpo=7462] and bpo-7622 [https://bugs.python.org/issue?@action=redirect&bpo=7622].)

The pickle and cPickle modules now automatically intern the strings used for attribute names, reducing memory usage of the objects resulting from unpickling. (Contributed by Jake McGuire; bpo-5084 [https://bugs.python.org/issue?@action=redirect&bpo=5084].)

The cPickle module now special-cases dictionaries, nearly halving the time required to pickle them. (Contributed by Collin Winter; bpo-5670 [https://bugs.python.org/issue?@action=redirect&bpo=5670].)

新增和改进的模块

与每个版本一样，Python 的标准库收到了许多增强和 bug 修复。以下是一些最显著变化的的部分列表，按模块名称字母顺序排序。查阅源树中的 Misc/NEWS 文件以获取更完整的变化列表，或通过 Subversion 日志查看所有详细信息。

bdb 模块的基调试类 Bdb 增加了一个跳过模块的功能。构造函数现在接受一个包含 glob 风格模式（如 django.*）的可迭代对象；调试器将不会进入与这些模式之一匹配的模块的堆栈帧。（由 Maru Newby 在 Senthil Kumaran 的建议后贡献；参见 bpo-5142 [https://bugs.python.org/issue?@action=redirect&bpo=5142]。）

binascii 模块现在支持缓冲区 API，因此可以与 memoryview 实例和其他类似的缓冲区对象一起使用。（由 Florent Xicluna 从 3.x 向下移植；参见 bpo-7703 [https://bugs.python.org/issue?@action=redirect&bpo=7703]。）

Updated module: the bsddb module has been updated from 4.7.2devel9 to version 4.8.4 of the pybsddb package [https://www.jcea.es/programacion/pybsddb.htm]. The new version features better Python 3.x compatibility, various bug fixes, and adds several new BerkeleyDB flags and methods. (Updated by Jesús Cea Avión; bpo-8156 [https://bugs.python.org/issue?@action=redirect&bpo=8156]. The pybsddb changelog can be read at https://hg.jcea.es/pybsddb/file/tip/ChangeLog.)

bz2 模块的 BZ2File 现在支持上下文管理协议，因此你可以编写 with bz2.BZ2File(...) as f:。（由 Hagen Fürstenau 贡献；参见 bpo-3860 [https://bugs.python.org/issue?@action=redirect&bpo=3860]。）

新增类：collections 模块中的 Counter 类适用于统计数据。Counter 实例的行为大多类似于字典，但对于缺失的键返回零而不是引发 KeyError：

>>> 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

有三个额外的 Counter 方法。most_common() 返回最常见的 N 个元素及其计数。elements() 返回一个迭代器，遍历包含的元素，每个元素重复的次数与其计数相同。subtract() 接受一个可迭代对象，并为每个元素减一而不是加一；如果参数是字典或另一个 Counter，则减去相应的计数。:

>>> 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 is now lower
-1

由 Raymond Hettinger 贡献；参见 bpo-1696199 [https://bugs.python.org/issue?@action=redirect&bpo=1696199]。

新增类：OrderedDict 在之前的章节 PEP 372：将有序字典 添加到收藏集 中有描述。

新方法：deque 数据类型现在有一个 count() 方法，返回等于提供的参数 x 的元素数量，以及一个 reverse() 方法，原地反转 deque 中的元素。deque 还将其最大长度暴露为只读的 maxlen 属性。（这两个特性均由 Raymond Hettinger 添加。)

namedtuple 类现在有一个可选的 rename 参数。如果 rename 为真，则由于重复或不是合法的 Python 标识符而无效的字段名将被重命名为基于字段在字段列表中的位置的合法名称：

>>> from collections import namedtuple
>>> T = namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
>>> T._fields
('field1', '_1', '_2', 'field2')

（由 Raymond Hettinger 添加；参见 bpo-1818 [https://bugs.python.org/issue?@action=redirect&bpo=1818]。）

Finally, the Mapping abstract base class now returns NotImplemented if a mapping is compared to another type that isn't a Mapping. (Fixed by Daniel Stutzbach; bpo-8729 [https://bugs.python.org/issue?@action=redirect&bpo=8729].)

Constructors for the parsing classes in the ConfigParser module now take an allow_no_value parameter, defaulting to false; if true, options without values will be allowed. For 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'

（由 Mats Kindahl 贡献；参见 bpo-7005 [https://bugs.python.org/issue?@action=redirect&bpo=7005]。）

Deprecated function: contextlib.nested(), which allows handling more than one context manager with a single with statement, has been deprecated, because the with statement now supports multiple context managers.

The cookielib module now ignores cookies that have an invalid version field, one that doesn't contain an integer value. (Fixed by John J. Lee; bpo-3924 [https://bugs.python.org/issue?@action=redirect&bpo=3924].)

copy 模块的 deepcopy() 函数现在将正确复制绑定的实例方法。（由 Robert Collins 实现；参见 bpo-1515 [https://bugs.python.org/issue?@action=redirect&bpo=1515]。）

ctypes 模块现在总是将 None 转换为 C 的 NULL 指针，用于声明为指针的参数。（由 Thomas Heller 改动；参见 bpo-4606 [https://bugs.python.org/issue?@action=redirect&bpo=4606]。）底层的 libffi 库 [https://sourceware.org/libffi/] 已更新至版本 3.0.9，包含对不同平台的多项修复。（由 Matthias Klose 更新；参见 bpo-8142 [https://bugs.python.org/issue?@action=redirect&bpo=8142]。）

新方法：datetime 模块的 timedelta 类增加了一个 total_seconds() 方法，返回持续时间中的秒数。（由 Brian Quinlan 贡献；参见 bpo-5788 [https://bugs.python.org/issue?@action=redirect&bpo=5788]。）

New method: the Decimal class gained a from_float() class method that performs an exact conversion of a floating-point number to a Decimal. This exact conversion strives for the closest decimal approximation to the floating-point representation's value; the resulting decimal value will therefore still include the inaccuracy, if any. For example, Decimal.from_float(0.1) returns Decimal('0.1000000000000000055511151231257827021181583404541015625'). (Implemented by Raymond Hettinger; bpo-4796 [https://bugs.python.org/issue?@action=redirect&bpo=4796].)

Comparing instances of Decimal with floating-point numbers now produces sensible results based on the numeric values of the operands. Previously such comparisons would fall back to Python's default rules for comparing objects, which produced arbitrary results based on their type. Note that you still cannot combine Decimal and floating-point in other operations such as addition, since you should be explicitly choosing how to convert between float and Decimal. (Fixed by Mark Dickinson; bpo-2531 [https://bugs.python.org/issue?@action=redirect&bpo=2531].)

Decimal 的构造函数现在接受浮点数（由 Raymond Hettinger 添加；参见 bpo-8257 [https://bugs.python.org/issue?@action=redirect&bpo=8257]）和非欧洲 Unicode 字符，如阿拉伯-印度数字（由 Mark Dickinson 贡献；参见 bpo-6595 [https://bugs.python.org/issue?@action=redirect&bpo=6595]）。

Context 类的大多数方法现在既接受整数也接受 Decimal 实例；唯一的例外是 canonical() 和 is_canonical() 方法。 (由 Juan José Conti 提交补丁；参见 bpo-7633 [https://bugs.python.org/issue?@action=redirect&bpo=7633])

当使用 Decimal 实例与字符串的 format() 方法时，之前的默认对齐方式是左对齐。这已被更改为右对齐，这对于数值类型更为合理。 (由 Mark Dickinson 更改；参见 bpo-6857 [https://bugs.python.org/issue?@action=redirect&bpo=6857])

Comparisons involving a signaling NaN value (or sNAN) now signal InvalidOperation instead of silently returning a true or false value depending on the comparison operator. Quiet NaN values (or NaN) are now hashable. (Fixed by Mark Dickinson; bpo-7279 [https://bugs.python.org/issue?@action=redirect&bpo=7279].)

difflib 模块现在通过一个小改动，使其输出与现代 diff/patch 工具更加兼容，即在头部给出文件名时使用制表符而不是空格作为分隔符。 (由 Anatoly Techtonik 修复；参见 bpo-7585 [https://bugs.python.org/issue?@action=redirect&bpo=7585])

Distutils 的 sdist 命令现在总是重新生成 MANIFEST 文件，因为即使 MANIFEST.in 或 setup.py 文件没有被修改，用户也可能创建了一些应该包含的新文件。 (由 Tarek Ziadé 修复；参见 bpo-8688 [https://bugs.python.org/issue?@action=redirect&bpo=8688])

The doctest module's IGNORE_EXCEPTION_DETAIL flag will now ignore the name of the module containing the exception being tested. (Patch by Lennart Regebro; bpo-7490 [https://bugs.python.org/issue?@action=redirect&bpo=7490].)

The email module's Message class will now accept a Unicode-valued payload, automatically converting the payload to the encoding specified by output_charset. (Added by R. David Murray; bpo-1368247 [https://bugs.python.org/issue?@action=redirect&bpo=1368247].)

Fraction 类现在接受单个浮点数或 Decimal 实例，或两个有理数作为其构造函数的参数。（由 Mark Dickinson 实现；有理数在 bpo-5812 [https://bugs.python.org/issue?@action=redirect&bpo=5812] 中添加，浮点数/小数在 bpo-8294 [https://bugs.python.org/issue?@action=redirect&bpo=8294] 中添加。）

分数和复数之间的排序比较（<, <=, >, >=）现在会引发 TypeError。这一改进修复了一处疏漏，使得 Fraction 类型的行为与其他数值类型保持一致。

新增类：ftplib 模块中的 FTP_TLS 类提供使用 TLS 封装的认证以及后续控制和数据传输的安全 FTP 连接。（由 Giampaolo Rodola 贡献；参见 bpo-2054 [https://bugs.python.org/issue?@action=redirect&bpo=2054]。）

storbinary() 方法用于二进制上传，现在可以通过新增的 rest 参数重新启动上传（由 Pablo Mouzo 提交补丁；参见 bpo-6845 [https://bugs.python.org/issue?@action=redirect&bpo=6845]。）

New class decorator: total_ordering() in the functools module takes a class that defines an __eq__() method and one of __lt__(), __le__(), __gt__(), or __ge__(), and generates the missing comparison methods. Since the __cmp__() method is being deprecated in Python 3.x, this decorator makes it easier to define ordered classes. (Added by Raymond Hettinger; bpo-5479 [https://bugs.python.org/issue?@action=redirect&bpo=5479].)

新增函数：cmp_to_key() 将接受一个期望两个参数的旧式比较函数，并返回一个新的可调用对象，该对象可以用作 sorted()、 min() 和 max() 等函数的 key 参数。其主要用途是帮助代码兼容 Python 3.x。（由 Raymond Hettinger 添加。）

新增函数：gc 模块的 is_tracked() 在给定实例被垃圾回收器跟踪时返回 true，否则返回 false。（由 Antoine Pitrou 贡献；参见 bpo-4688 [https://bugs.python.org/issue?@action=redirect&bpo=4688]。）

gzip 模块的 GzipFile 现在支持上下文管理协议，因此你可以写 with gzip.GzipFile(...) as f: (由 Hagen Fürstenau 贡献;参见 bpo-3860 [https://bugs.python.org/issue?@action=redirect&bpo=3860]) ，并且它现在实现了 io.BufferedIOBase ABC，因此你可以用 io.BufferedReader 包装它以加快处理速度（由 Nir Aides 贡献;参见 bpo-7471 [https://bugs.python.org/issue?@action=redirect&bpo=7471]）。现在还可以通过在构造函数中提供可选的时间戳来覆盖 gzip 文件中记录的修改时间。（由 Jacques Frechet 贡献;参见 bpo-4272 [https://bugs.python.org/issue?@action=redirect&bpo=4272]。）

gzip 格式的文件可以用尾随零字节填充；gzip 模块现在将消耗这些尾随字节。（由 Tadek Pietraszek 和 Brian Curtin 修复;参见 bpo-2846 [https://bugs.python.org/issue?@action=redirect&bpo=2846]。）

New attribute: the hashlib module now has an algorithms attribute containing a tuple naming the supported algorithms. In Python 2.7, hashlib.algorithms contains ('md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512'). (Contributed by Carl Chenet; bpo-7418 [https://bugs.python.org/issue?@action=redirect&bpo=7418].)

The default HTTPResponse class used by the httplib module now supports buffering, resulting in much faster reading of HTTP responses. (Contributed by Kristján Valur Jónsson; bpo-4879 [https://bugs.python.org/issue?@action=redirect&bpo=4879].)

The HTTPConnection and HTTPSConnection classes now support a source_address parameter, a (host, port) 2-tuple giving the source address that will be used for the connection. (Contributed by Eldon Ziegler; bpo-3972 [https://bugs.python.org/issue?@action=redirect&bpo=3972].)

The ihooks module now supports relative imports. Note that ihooks is an older module for customizing imports, superseded by the imputil module added in Python 2.0. (Relative import support added by Neil Schemenauer.)

imaplib 模块现在支持 IPv6 地址。（由 Derek Morr 贡献;参见 bpo-1655 [https://bugs.python.org/issue?@action=redirect&bpo=1655]。）

新功能：inspect 模块的 getcallargs() 函数接受一个可调用对象及其位置和关键字参数，并确定该可调用对象的哪些参数将接收每个参数，返回一个将参数名映射到其值的字典。例如：

>>> 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)

由 Georg Sakkis 在 bpo-3135 [https://bugs.python.org/issue?@action=redirect&bpo=3135] 中贡献。

Updated module: The io library has been upgraded to the version shipped with Python 3.1. For 3.1, the I/O library was entirely rewritten in C and is 2 to 20 times faster depending on the task being performed. The original Python version was renamed to the _pyio module.

One minor resulting change: the io.TextIOBase class now has an errors attribute giving the error setting used for encoding and decoding errors (one of 'strict', 'replace', 'ignore').

io.FileIO 类在传递无效文件描述符时现在会引发 OSError。(由 Benjamin Peterson 实现；参见 bpo-4991 [https://bugs.python.org/issue?@action=redirect&bpo=4991]。) truncate() 方法现在保留文件位置；之前它会将文件位置更改为新文件的末尾。(由 Pascal Chambon 修复；参见 bpo-6939 [https://bugs.python.org/issue?@action=redirect&bpo=6939]。)

新增函数：itertools.compress(data, selectors) 接受两个迭代器。如果 selectors 中对应的值为真，则返回 data 中的元素：

itertools.compress('ABCDEF', [1,0,1,0,1,1]) =>
  A, C, E, F

新增函数：itertools.combinations_with_replacement(iter, r) 返回可迭代对象 iter 中所有可能的 r 长度组合。与 combinations() 不同，生成组合中的单个元素可以重复：

itertools.combinations_with_replacement('abc', 2) =>
  ('a', 'a'), ('a', 'b'), ('a', 'c'),
  ('b', 'b'), ('b', 'c'), ('c', 'c')

请注意，元素被视为唯一是根据它们在输入中的位置，而不是它们的实际值。

itertools.count() 函数现在有一个 step 参数，允许以非1的值递增。count() 也现在允许关键字参数，并使用非整数值，例如浮点数或 Decimal 实例。（由 Raymond Hettinger 实现；参见 bpo-5032 [https://bugs.python.org/issue?@action=redirect&bpo=5032]。）

itertools.combinations() 和 itertools.product() 函数此前在参数 r 的值大于输入可迭代对象长度时会引发 ValueError 异常。经认定这是规范定义上的错误，因此现在当出现这种情况时，这两个函数会返回一个空迭代器。（由 Raymond Hettinger 修复；参见 bpo-4816 [https://bugs.python.org/issue?@action=redirect&bpo=4816]。）

更新模块：json 模块已升级到 simplejson 包的 2.0.9 版本，该版本包括一个 C 扩展，使编码和解码更快。（由 Bob Ippolito 贡献；参见 bpo-4136 [https://bugs.python.org/issue?@action=redirect&bpo=4136]。）

为了支持新的 collections.OrderedDict 类型，json.load() 现在有一个可选的 object_pairs_hook 参数，它将用任何解码为对列表的对象字面量调用。（由 Raymond Hettinger 贡献；参见 bpo-5381 [https://bugs.python.org/issue?@action=redirect&bpo=5381]。）

mailbox 模块的 Maildir 类现在记录它读取的目录的时间戳，并且只有在修改时间随后发生变化时才重新读取它们。这通过避免不必要的目录扫描来提高性能。（由 A.M. Kuchling 和 Antoine Pitrou 修复；参见 bpo-1607951 [https://bugs.python.org/issue?@action=redirect&bpo=1607951]、 bpo-6896 [https://bugs.python.org/issue?@action=redirect&bpo=6896]。）

新增函数：math 模块新增了 erf() 和 erfc() 用于计算误差函数和互补误差函数，expm1() 用于更精确地计算 e**x - 1 而不是使用 exp() 并减去 1，gamma() 用于计算伽马函数，以及 lgamma() 用于计算伽马函数的自然对数。（由 Mark Dickinson 和 nirinA raseliarison 贡献；参见 bpo-3366 [https://bugs.python.org/issue?@action=redirect&bpo=3366]。）

The multiprocessing module's Manager* classes can now be passed a callable that will be called whenever a subprocess is started, along with a set of arguments that will be passed to the callable. (Contributed by lekma; bpo-5585 [https://bugs.python.org/issue?@action=redirect&bpo=5585].)

The Pool class, which controls a pool of worker processes, now has an optional maxtasksperchild parameter. Worker processes will perform the specified number of tasks and then exit, causing the Pool to start a new worker. This is useful if tasks may leak memory or other resources, or if some tasks will cause the worker to become very large. (Contributed by Charles Cazabon; bpo-6963 [https://bugs.python.org/issue?@action=redirect&bpo=6963].)

The nntplib module now supports IPv6 addresses. (Contributed by Derek Morr; bpo-1664 [https://bugs.python.org/issue?@action=redirect&bpo=1664].)

新增函数：os 模块封装了以下 POSIX 系统调用：getresgid() 和 getresuid()，它们返回实际、有效和保存的 GID 和 UID；setresgid() 和 setresuid()，它们将实际、有效和保存的 GID 和 UID 设置为新值；initgroups()，用于初始化当前进程的组访问列表。（GID/UID 函数由 Travis H. 贡献；参见 bpo-6508 [https://bugs.python.org/issue?@action=redirect&bpo=6508]。initgroups 支持由 Jean-Paul Calderone 添加；参见 bpo-7333 [https://bugs.python.org/issue?@action=redirect&bpo=7333]。）

os.fork() 函数现在在子进程中重新初始化导入锁；这解决了在 Solaris 上从线程中调用 fork() 时的问题。（由 Zsolt Cserna 修复；参见 bpo-7242 [https://bugs.python.org/issue?@action=redirect&bpo=7242]。）

在 os.path 模块中，normpath() 和 abspath() 函数现在可以保留 Unicode；如果它们的输入路径是 Unicode 字符串，返回值也是 Unicode 字符串。(normpath() 由 Matt Giuca 在 bpo-5827 [https://bugs.python.org/issue?@action=redirect&bpo=5827] 中修复；abspath() 由 Ezio Melotti 在 bpo-3426 [https://bugs.python.org/issue?@action=redirect&bpo=3426] 修复。)

pydoc 模块现在提供了 Python 使用的各种符号的帮助信息。例如，你现在可以执行 help('<<') 或 help('@')。（由 David Laban 贡献；参见 bpo-4739 [https://bugs.python.org/issue?@action=redirect&bpo=4739]）

re 模块的 split()、sub() 和 subn() 现在接受一个可选的 flags 参数，以便与其他模块中的函数保持一致。（由 Gregory P. Smith 添加）

新增函数：runpy 模块中的 run_path() 将执行提供的 path 参数中的代码。path 可以是 Python 源文件路径 (example.py)、编译的字节码文件路径 (example.pyc)、目录 (./package/) 或 zip 归档文件路径 (example.zip)。如果提供的是目录或 zip 路径，它将被添加到 sys.path 的前面，并导入模块 __main__。预期目录或 zip 包含一个 __main__.py；如果没有，可能会从 sys.path 中后面的位置导入其他 __main__.py。这使得脚本能够利用 runpy 模块的更多机制，从而模拟 Python 命令行处理显式路径名称的方式。（由 Nick Coghlan 添加；参见 bpo-6816 [https://bugs.python.org/issue?@action=redirect&bpo=6816]）

新增函数：在 shutil 模块中，make_archive() 接受一个文件名、归档类型（zip 或 tar 格式）和目录路径，并创建一个包含目录内容的归档文件。（由 Tarek Ziadé 添加）

shutil 模块的 copyfile() 和 copytree() 函数现在在尝试复制命名管道时将引发 SpecialFileError 异常。此前代码会将命名管道视为普通文件并尝试打开它们进行读取，这会导致无限阻塞。（由 Antoine Pitrou 修复；参见 bpo-3002 [https://bugs.python.org/issue?@action=redirect&bpo=3002]。）

signal 模块现在不再重新安装信号处理程序，除非确实必要，这修复了一个可能导致无法稳健捕获 EINTR 信号的错误。（由 Charles-Francois Natali 修复；参见 bpo-8354 [https://bugs.python.org/issue?@action=redirect&bpo=8354]。）

New functions: in the site module, three new functions return various site- and user-specific paths. getsitepackages() returns a list containing all global site-packages directories, getusersitepackages() returns the path of the user's site-packages directory, and getuserbase() returns the value of the USER_BASE environment variable, giving the path to a directory that can be used to store data. (Contributed by Tarek Ziadé; bpo-6693 [https://bugs.python.org/issue?@action=redirect&bpo=6693].)

site 模块现在会报告在导入 sitecustomize 模块时发生的异常，并且不再捕获并吞掉 KeyboardInterrupt 异常。（由 Victor Stinner 修复；参见 bpo-3137 [https://bugs.python.org/issue?@action=redirect&bpo=3137]。）

create_connection() 函数新增了一个 source_address 参数，这是一个 (host, port) 2元组，指定用于连接的源地址。（由 Eldon Ziegler 贡献；参见 bpo-3972 [https://bugs.python.org/issue?@action=redirect&bpo=3972]。）

recv_into() 和 recvfrom_into() 方法现在支持将接收的数据写入实现了缓冲区 API 的对象，最常用的是 bytearray 和 memoryview 对象。（由 Antoine Pitrou 实现；参见 bpo-8104 [https://bugs.python.org/issue?@action=redirect&bpo=8104]。）

The SocketServer module's TCPServer class now supports socket timeouts and disabling the Nagle algorithm. The disable_nagle_algorithm class attribute defaults to False; if overridden to be true, new request connections will have the TCP_NODELAY option set to prevent buffering many small sends into a single TCP packet. The timeout class attribute can hold a timeout in seconds that will be applied to the request socket; if no request is received within that time, handle_timeout() will be called and handle_request() will return. (Contributed by Kristján Valur Jónsson; bpo-6192 [https://bugs.python.org/issue?@action=redirect&bpo=6192] and bpo-6267 [https://bugs.python.org/issue?@action=redirect&bpo=6267].)

更新模块：sqlite3 模块已更新到 pysqlite 包 [https://github.com/ghaering/pysqlite] 的 2.6.0 版本。2.6.0 版本包括多项 bug 修复，并增加了从共享库加载 SQLite 扩展的能力。调用 enable_load_extension(True) 方法以启用扩展，然后调用 load_extension() 以加载特定的共享库。（由 Gerhard Häring 更新。）

The ssl module's SSLSocket objects now support the buffer API, which fixed a test suite failure (fix by Antoine Pitrou; bpo-7133 [https://bugs.python.org/issue?@action=redirect&bpo=7133]) and automatically set OpenSSL's SSL_MODE_AUTO_RETRY, which will prevent an error code being returned from recv() operations that trigger an SSL renegotiation (fix by Antoine Pitrou; bpo-8222 [https://bugs.python.org/issue?@action=redirect&bpo=8222]).

The ssl.wrap_socket() constructor function now takes a ciphers argument that's a string listing the encryption algorithms to be allowed; the format of the string is described in the OpenSSL documentation [https://www.openssl.org/docs/man1.0.2/man1/ciphers.html]. (Added by Antoine Pitrou; bpo-8322 [https://bugs.python.org/issue?@action=redirect&bpo=8322].)

另一项更改使扩展加载了所有OpenSSL的加密算法和摘要算法，以便它们全部可用。一些SSL证书无法验证，会报告“未知算法”错误。（由Beda Kosata报告，Antoine Pitrou修复；参见 bpo-8484 [https://bugs.python.org/issue?@action=redirect&bpo=8484]。）

The version of OpenSSL being used is now available as the module attributes ssl.OPENSSL_VERSION (a string), ssl.OPENSSL_VERSION_INFO (a 5-tuple), and ssl.OPENSSL_VERSION_NUMBER (an integer). (Added by Antoine Pitrou; bpo-8321 [https://bugs.python.org/issue?@action=redirect&bpo=8321].)

The struct module will no longer silently ignore overflow errors when a value is too large for a particular integer format code (one of bBhHiIlLqQ); it now always raises a struct.error exception. (Changed by Mark Dickinson; bpo-1523 [https://bugs.python.org/issue?@action=redirect&bpo=1523].) The pack() function will also attempt to use __index__() to convert and pack non-integers before trying the __int__() method or reporting an error. (Changed by Mark Dickinson; bpo-8300 [https://bugs.python.org/issue?@action=redirect&bpo=8300].)

新增函数：subprocess 模块的 check_output() 运行一个带有指定参数集的命令，并在命令无错误运行时返回命令的输出作为字符串，否则引发 CalledProcessError 异常。

>>> 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

（由 Gregory P. Smith 贡献）

The subprocess module will now retry its internal system calls on receiving an EINTR signal. (Reported by several people; final patch by Gregory P. Smith in bpo-1068268 [https://bugs.python.org/issue?@action=redirect&bpo=1068268].)

新增函数：在 symtable 模块中的 is_declared_global() 函数，对于明确声明为全局变量的变量返回 true，对于隐式全局变量返回 false。（由 Jeremy Hylton 贡献。）

syslog 模块现在将使用 sys.argv[0] 的值作为标识符，而不是之前的默认值 'python'。（由 Sean Reifschneider 更改；参见 bpo-8451 [https://bugs.python.org/issue?@action=redirect&bpo=8451]。）

The sys.version_info value is now a named tuple, with attributes named major, minor, micro, releaselevel, and serial. (Contributed by Ross Light; bpo-4285 [https://bugs.python.org/issue?@action=redirect&bpo=4285].)

sys.getwindowsversion() also returns a named tuple, with attributes named major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. (Contributed by Brian Curtin; bpo-7766 [https://bugs.python.org/issue?@action=redirect&bpo=7766].)

tarfile 模块的默认错误处理已更改，不再抑制致命错误。之前的默认错误级别为 0，这意味着错误只会导致一条消息被写入调试日志，但由于调试日志默认不激活，这些错误会被忽略。现在的默认错误级别为 1，如果出现错误会引发异常。（由 Lars Gustäbel 改变；参见 bpo-7357 [https://bugs.python.org/issue?@action=redirect&bpo=7357]。）

tarfile 现在支持过滤添加到 tar 文件中的 TarInfo 对象。当你调用 add() 时，可以提供一个可选的 filter 参数，该参数是一个可调用的函数。filter 可调用函数将为每个被添加的文件传递 TarInfo，并可以修改并返回它。如果可调用函数返回 None，该文件将被排除在最终归档之外。这比现有的 exclude 参数更强大，因此 exclude 参数已被弃用。(由 Lars Gustäbel 添加；参见 bpo-6856 [https://bugs.python.org/issue?@action=redirect&bpo=6856]。) TarFile 类现在也支持上下文管理协议。（由 Lars Gustäbel 添加；参见 bpo-7232 [https://bugs.python.org/issue?@action=redirect&bpo=7232]。）

threading.Event 类的 wait() 方法现在在退出时返回内部标志。这意味着该方法通常会返回 true，因为 wait() 应该阻塞直到内部标志变为 true。只有在提供了超时并且操作超时时，返回值才会是 false。（由 Tim Lesher 贡献；参见 bpo-1674032 [https://bugs.python.org/issue?@action=redirect&bpo=1674032]。）

unicodedata 模块提供的 Unicode 数据库现在用于内部确定哪些字符是数字、空格或表示换行。该数据库还包括来自 Unihan.txt 数据文件的信息（由 Anders Chrigström 和 Amaury Forgeot d'Arc 提交的补丁；参见 bpo-1571184 [https://bugs.python.org/issue?@action=redirect&bpo=1571184]），并已更新到版本 5.2.0（由 Florent Xicluna 更新；参见 bpo-8024 [https://bugs.python.org/issue?@action=redirect&bpo=8024]。）

The urlparse module's urlsplit() now handles unknown URL schemes in a fashion compliant with RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html]: if the URL is of the form "<something>://...", the text before the :// is treated as the scheme, even if it's a made-up scheme that the module doesn't know about. This change may break code that worked around the old behaviour. For example, Python 2.6.4 or 2.5 will return the following:

>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '', '//host/filename?query', '', '')

Python 2.7（以及Python 2.6.5）将返回：

>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '', '')

（Python 2.7实际上产生的输出略有不同，因为它返回的是一个具名元组而不是标准元组。）

The urlparse module also supports IPv6 literal addresses as defined by RFC 2732 [https://datatracker.ietf.org/doc/html/rfc2732.html] (contributed by Senthil Kumaran; bpo-2987 [https://bugs.python.org/issue?@action=redirect&bpo=2987]).

>>> urlparse.urlparse('http://[1080::8:800:200C:417A]/foo')
ParseResult(scheme='http', netloc='[1080::8:800:200C:417A]',
            path='/foo', params='', query='', fragment='')

新增类：weakref 模块中的 WeakSet 类是一个集合，它只对其元素保持弱引用；一旦没有引用指向这些元素，它们将被移除。（最初由 Raymond Hettinger 在 Python 3.x 中实现，并由 Michael Foord 向下移植到2.7。）

The ElementTree library, xml.etree, no longer escapes ampersands and angle brackets when outputting an XML processing instruction (which looks like <?xml-stylesheet href="#style1"?>) or comment (which looks like <!-- comment -->). (Patch by Neil Muller; bpo-2746 [https://bugs.python.org/issue?@action=redirect&bpo=2746].)

The XML-RPC client and server, provided by the xmlrpclib and SimpleXMLRPCServer modules, have improved performance by supporting HTTP/1.1 keep-alive and by optionally using gzip encoding to compress the XML being exchanged. The gzip compression is controlled by the encode_threshold attribute of SimpleXMLRPCRequestHandler, which contains a size in bytes; responses larger than this will be compressed. (Contributed by Kristján Valur Jónsson; bpo-6267 [https://bugs.python.org/issue?@action=redirect&bpo=6267].)

zipfile 模块的 ZipFile 现在支持上下文管理协议，因此你可以写 with zipfile.ZipFile(...) as f:。（由 Brian Curtin 贡献；参见 bpo-5511 [https://bugs.python.org/issue?@action=redirect&bpo=5511]。）

zipfile now also supports archiving empty directories and extracts them correctly. (Fixed by Kuba Wieczorek; bpo-4710 [https://bugs.python.org/issue?@action=redirect&bpo=4710].) Reading files out of an archive is faster, and interleaving read() and readline() now works correctly. (Contributed by Nir Aides; bpo-7610 [https://bugs.python.org/issue?@action=redirect&bpo=7610].)

is_zipfile() 函数现在接受文件对象，除了早期版本中接受的路径名。（由 Gabriel Genellina 贡献；参见 bpo-4756 [https://bugs.python.org/issue?@action=redirect&bpo=4756]。）

writestr() 方法现在有一个可选的 compress_type 参数，允许你覆盖在 ZipFile 构造函数中指定的默认压缩方法。（由 Ronald Oussoren 贡献；参见 bpo-6003 [https://bugs.python.org/issue?@action=redirect&bpo=6003]。）

新模块：importlib

Python 3.1 includes the importlib package, a re-implementation of the logic underlying Python's import statement. importlib is useful for implementors of Python interpreters and to users who wish to write new importers that can participate in the import process. Python 2.7 doesn't contain the complete importlib package, but instead has a tiny subset that contains a single function, import_module().

import_module(name, package=None) 导入一个模块。name 是一个包含模块或包名称的字符串。可以通过提供一个以 . 字符开头的字符串来进行相对导入，例如 ..utils.errors。对于相对导入，必须提供 package 参数，它是将用作相对导入锚点的包名称。import_module() 既将导入的模块插入到 sys.modules 中，也返回模块对象。

这是一些例子:

>>> from importlib import import_module
>>> anydbm = import_module('anydbm')  # Standard absolute import
>>> anydbm
<module 'anydbm' from '/p/python/Lib/anydbm.py'>
>>> # Relative import
>>> file_util = import_module('..file_util', 'distutils.command')
>>> file_util
<module 'distutils.file_util' from '/python/Lib/distutils/file_util.pyc'>

importlib 由 Brett Cannon 实现，并在 Python 3.1 中引入。

新模块：sysconfig

sysconfig 模块已从 Distutils 包中提取出来，成为一个新的顶级模块。sysconfig 提供了用于获取有关 Python 构建过程信息的函数：编译器开关、安装路径、平台名称以及 Python 是否从其源目录运行。

该模块中的部分函数:

get_config_var() 返回来自 Python 的 Makefile 和 pyconfig.h 文件的变量。

get_config_vars() 返回一个包含所有配置变量的字典。

get_path() 返回特定模块类型的配置路径：标准库、站点专属模块、平台专属模块等等。

is_python_build() 会在你从 Python 源码树运行二进制可执行文件时返回真值，而在其他情况下返回假值。

请参阅 sysconfig 文档以获取更多详细信息以及完整的函数列表。

Distutils 包和 sysconfig 现由 Tarek Ziadé 维护，他还启动了一个 Distutils2 包（源代码仓库位于 https://hg.python.org/distutils2/），用于开发 Distutils 的下一代版本。

ttk：Tk 主题组件

Tcl/Tk 8.5 包含一组主题化的小部件，这些小部件重新实现了基本的 Tk 小部件，但具有更可定制的外观，因此可以更接近本地平台的小部件。这个小部件集最初称为 Tile，但在添加到 Tcl/Tk 8.5 版本时被重命名为 Ttk（意为“主题化 Tk”）。

To learn more, read the ttk module documentation. You may also wish to read the Tcl/Tk manual page describing the Ttk theme engine, available at https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.htm. Some screenshots of the Python/Ttk code in use are at https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki.

The ttk module was written by Guilherme Polo and added in bpo-2983 [https://bugs.python.org/issue?@action=redirect&bpo=2983]. An alternate version called Tile.py, written by Martin Franklin and maintained by Kevin Walzer, was proposed for inclusion in bpo-2618 [https://bugs.python.org/issue?@action=redirect&bpo=2618], but the authors argued that Guilherme Polo's work was more comprehensive.

更新的模块：unittest

The unittest module was greatly enhanced; many new features were added. Most of these features were implemented by Michael Foord, unless otherwise noted. The enhanced version of the module is downloadable separately for use with Python versions 2.4 to 2.6, packaged as the unittest2 package, from https://pypi.org/project/unittest2.

当从命令行使用时，该模块可以自动发现测试。它不如 py.test [https://pytest.org] 或 nose [https://nose.readthedocs.io/] 那么花哨，但提供了一种简单的方式来运行保存在一组包目录中的测试。例如，以下命令将搜索 test/ 子目录中名为 test*.py 的任何可导入测试文件：

python -m unittest discover -s test

更多详细信息，请参阅 unittest 模块文档。（开发于 bpo-6001 [https://bugs.python.org/issue?@action=redirect&bpo=6001]。）

main() 函数支持一些其他新选项：

-b 或 --buffer 将在每个测试期间缓冲标准输出和标准错误流。如果测试通过，任何生成的输出将被丢弃；如果失败，缓冲的输出将被显示。

-c 或 --catch 将使 control-C 中断处理得更为优雅。而不是立即中断测试进程，当前运行的测试将被完成，然后报告中断前的部分结果。如果你不耐烦，再次按下 control-C 将导致立即中断。

此 Control-C 处理程序尝试避免在测试的代码或运行的测试已定义了自己的信号处理程序时引发问题，通过检测到已设置信号处理程序并调用它来实现。如果这对你不起作用，可以使用 removeHandler() 装饰器来标记应禁用 Control-C 处理的测试。

-f 或 --failfast 选项使测试执行在测试失败时立即停止，而不是继续执行后续测试。（由 Cliff Dyer 建议，Michael Foord 实现；参见 bpo-8074 [https://bugs.python.org/issue?@action=redirect&bpo=8074]。）

在详细模式下运行时，进度消息现在会用 'x' 表示预期失败，用 'u' 表示意外成功。（由 Benjamin Peterson 贡献。）

测试用例可以引发 SkipTest 异常来跳过测试（参见 bpo-1034053 [https://bugs.python.org/issue?@action=redirect&bpo=1034053]）。

assertEqual()、assertTrue() 和 assertFalse() 失败的错误消息现在提供更多信息。如果你将 longMessage 属性在你的 TestCase 类中设置为 true，那么标准错误消息和你提供的任何附加消息都将在失败时打印出来。（由 Michael Foord 添加；参见 bpo-5663 [https://bugs.python.org/issue?@action=redirect&bpo=5663]。）

assertRaises() 方法在调用时如果不提供可调用对象来运行，现在返回一个上下文处理程序。例如，你可以这样写：

with self.assertRaises(KeyError):
    {}['foo']

（由 Antoine Pitrou 实现；参见 bpo-4444 [https://bugs.python.org/issue?@action=redirect&bpo=4444]。）

现在支持模块级和类级的初始化（setup）与清理（teardown）夹具（fixture）。模块中可以包含 setUpModule() 和 tearDownModule() 函数；类中可以定义 setUpClass() 和 tearDownClass() 方法，这些方法必须声明为类方法（使用 @classmethod 或等效方式）。当测试运行器切换到不同模块或类中的测试用例时，这些函数和方法会被调用。

添加了 addCleanup() 和 doCleanups() 方法。addCleanup() 允许你添加清理函数，这些函数将无条件调用（如果 setUp() 失败，则在 setUp() 之后调用，否则在 tearDown() 之后调用）。这大大简化了测试期间的资源分配和释放（参见 bpo-5679 [https://bugs.python.org/issue?@action=redirect&bpo=5679]）。

新增了多个提供更专业测试功能的方法。其中许多方法由谷歌工程师编写，用于他们内部的测试套件；Gregory P. Smith、Michael Foord 和 GvR 参与了将这些方法合并到 Python 版 unittest 模块的工作。

assertIsNone() 和 assertIsNotNone() 接受一个表达式，并验证结果是否为 None。

assertIs() 和 assertIsNot() 接受两个值，并检查这两个值是否评估为同一个对象。（由 Michael Foord 添加；参见 bpo-2578 [https://bugs.python.org/issue?@action=redirect&bpo=2578]。）

assertIsInstance() 和 assertNotIsInstance() 检查结果对象是否是特定类的实例，或是否是类元组中的一个类的实例。（由 Georg Brandl 添加；参见 bpo-7031 [https://bugs.python.org/issue?@action=redirect&bpo=7031]。）

assertGreater()、assertGreaterEqual()、assertLess() 和 assertLessEqual() 比较两个数量。

assertMultiLineEqual() 比较两个字符串，如果不相等，会显示一个有用的比较结果，突出显示两个字符串中的差异。这种比较现在默认用于比较 Unicode 字符串时与 assertEqual()。

assertRegexpMatches() and assertNotRegexpMatches() checks whether the first argument is a string matching or not matching the regular expression provided as the second argument (bpo-8038 [https://bugs.python.org/issue?@action=redirect&bpo=8038]).

assertRaisesRegexp() checks whether a particular exception is raised, and then also checks that the string representation of the exception matches the provided regular expression.

assertIn() 和 assertNotIn() 测试 first 是否在 second 中。

assertItemsEqual() tests whether two provided sequences contain the same elements.

assertSetEqual() 比较两个集合是否相等，在错误情况下仅报告集合之间的差异。

同样，assertListEqual() 和 assertTupleEqual() 比较指定的类型并解释任何差异，而不一定打印它们的完整值；这些方法现在默认用于使用 assertEqual() 比较列表和元组。更一般地，assertSequenceEqual() 比较两个序列，并可以可选地检查两个序列是否为特定类型。

assertDictEqual() compares two dictionaries and reports the differences; it's now used by default when you compare two dictionaries using assertEqual(). assertDictContainsSubset() checks whether all of the key/value pairs in first are found in second.

assertAlmostEqual() 和 assertNotAlmostEqual() 测试 first 和 second 是否近似相等。此方法可以将其差异四舍五入到可选指定的 places 数（默认为 7）并与零比较，或者要求差异小于提供的 delta 值。

loadTestsFromName() 正确地尊重 TestLoader 的 suiteClass 属性。（由 Mark Roddy 修复；参见 bpo-6866 [https://bugs.python.org/issue?@action=redirect&bpo=6866]。）

一个新的钩子允许你扩展 assertEqual() 方法以处理新的数据类型。addTypeEqualityFunc() 方法接受一个类型对象和一个函数。当比较的两个对象都是指定类型时，将使用该函数。此函数应比较两个对象，并在它们不匹配时引发异常；建议该函数提供关于两个对象为什么不匹配的额外信息，就像新的序列比较方法一样。

unittest.main() 现在接受一个可选的 exit 参数。如果为假，main() 不调用 sys.exit()，允许从交互式解释器中使用 main()。（由 J. Pablo Fernández 贡献；参见 bpo-3379 [https://bugs.python.org/issue?@action=redirect&bpo=3379]。）

TestResult 有新的 startTestRun() 和 stopTestRun() 方法，它们分别在测试运行之前和之后立即被调用。（由 Robert Collins 贡献；参见 bpo-5728 [https://bugs.python.org/issue?@action=redirect&bpo=5728]。）

随着所有这些更改，unittest.py 变得异常庞大，因此该模块被转换为一个包，代码被分割成几个文件（由 Benjamin Peterson 完成）。这不会影响模块的导入或使用。

参见

https://web.archive.org/web/20210619163128/http://www.voidspace.org.uk/python/articles/unittest2.shtml

描述新特性、如何使用它们以及各种设计决策的合理性。（由 Michael Foord 撰写。）

更新的模块：ElementTree 1.3

Python自带的ElementTree库已更新至1.3版本。一些新特性包括：

各种解析函数现在接受一个*parser*关键字参数，该参数提供一个 XMLParser 实例用于解析。这使得可以覆盖文件的内部编码：

p = ET.XMLParser(encoding='utf-8')
t = ET.XML("""<root/>""", parser=p)

Errors in parsing XML now raise a ParseError exception, whose instances have a position attribute containing a (line, column) tuple giving the location of the problem.

ElementTree's code for converting trees to a string has been significantly reworked, making it roughly twice as fast in many cases. The ElementTree.write() and Element.write() methods now have a method parameter that can be "xml" (the default), "html", or "text". HTML mode will output empty elements as <empty></empty> instead of <empty/>, and text mode will skip over elements and only output the text chunks. If you set the tag attribute of an element to None but leave its children in place, the element will be omitted when the tree is written out, so you don't need to do more extensive rearrangement to remove a single element.

Namespace handling has also been improved. All xmlns:<whatever> declarations are now output on the root element, not scattered throughout the resulting XML. You can set the default namespace for a tree by setting the default_namespace attribute and can register new prefixes with register_namespace(). In XML mode, you can use the true/false xml_declaration parameter to suppress the XML declaration.

新的 Element 方法： extend() 将序列中的项追加到元素的子元素中。元素本身表现得像序列，因此可以轻松地将子元素从一个元素移动到另一个元素:

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)

# Outputs <root><item>1</item>...</root>
print ET.tostring(new)

New Element method: iter() yields the children of the element as a generator. It's also possible to write for child in elem: to loop over an element's children. The existing method getiterator() is now deprecated, as is getchildren() which constructs and returns a list of children.

New Element method: itertext() yields all chunks of text that are descendants of the element. For example:

t = ET.XML("""<list>
  <item>1</item> <item>2</item>  <item>3</item>
</list>""")

# Outputs ['\n  ', '1', ' ', '2', '  ', '3', '\n']
print list(t.itertext())

已弃用：使用元素作为布尔值（即 if elem:）如果元素有任何子元素则返回真，如果没有子元素则返回假。这种行为是令人困惑的——None 是假，但无子元素的元素也是假？——因此现在会触发 FutureWarning。在你的代码中，应该明确：如果你关心子元素的数量，写 len(elem) != 0；如果你想检查元素是否为空，写 elem is not None。

Fredrik Lundh 开发了 ElementTree 并制作了 1.3 版本；你可以在 https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm 阅读他描述 1.3 的文章。Florent Xicluna 在 python-dev 上的讨论和在 bpo-6472 [https://bugs.python.org/issue?@action=redirect&bpo=6472] 中更新了包含在 Python 中的版本。

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

The latest release of the GNU Debugger, GDB 7, can be scripted using Python [https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html]. When you begin debugging an executable program P, GDB will look for a file named P-gdb.py and automatically read it. Dave Malcolm contributed a python-gdb.py that adds a number of commands useful when debugging Python itself. For example, py-up and py-down go up or down one Python stack frame, which usually corresponds to several C stack frames. py-print prints the value of a Python variable, and py-bt prints the Python stack trace. (Added as a result of bpo-8032 [https://bugs.python.org/issue?@action=redirect&bpo=8032].)

如果你使用Python提供的 .gdbinit 文件，2.7版本中的 "pyo" 宏现在在调试的线程不持有GIL时也能正确工作；该宏现在在打印之前会获取GIL。（由 Victor Stinner 贡献；参见 bpo-3632 [https://bugs.python.org/issue?@action=redirect&bpo=3632]。）

Py_AddPendingCall() 现在线程安全，允许任何工作线程向主Python线程提交通知。这对于异步IO操作特别有用。（由 Kristján Valur Jónsson 贡献；参见 bpo-4293 [https://bugs.python.org/issue?@action=redirect&bpo=4293]。）

New function: PyCode_NewEmpty() creates an empty code object; only the filename, function name, and first line number are required. This is useful for extension modules that are attempting to construct a more useful traceback stack. Previously such extensions needed to call PyCode_New(), which had many more arguments. (Added by Jeffrey Yasskin.)

新增函数：PyErr_NewExceptionWithDoc() 创建一个新的异常类，就像现有的 PyErr_NewException() 一样，但多了一个包含新异常类文档字符串的 char * 参数。（由 'lekma' 在Python错误跟踪器中添加；参见 bpo-7033 [https://bugs.python.org/issue?@action=redirect&bpo=7033]。})

新增函数：PyFrame_GetLineNumber() 接受一个帧对象，并返回该帧当前执行的行号。之前需要获取当前执行的字节码指令的索引，然后查找对应地址的行号。（由 Jeffrey Yasskin 添加。）

新增函数：PyLong_AsLongAndOverflow() 和 PyLong_AsLongLongAndOverflow() 可将 Python 长整型数值近似转换为 C 语言的 long 或 long long 类型。若数值过大而无法容纳于目标输出类型中，则会设置 溢出 标志位，并将该标志返回给调用者。（由 Case Van Horsen 贡献；参见 bpo-7528 [https://bugs.python.org/issue?@action=redirect&bpo=7528] 和 bpo-7767 [https://bugs.python.org/issue?@action=redirect&bpo=7767]。）

New function: stemming from the rewrite of string-to-float conversion, a new PyOS_string_to_double() function was added. The old PyOS_ascii_strtod() and PyOS_ascii_atof() functions are now deprecated.

New function: PySys_SetArgvEx() sets the value of sys.argv and can optionally update sys.path to include the directory containing the script named by sys.argv[0] depending on the value of an updatepath parameter.

This function was added to close a security hole for applications that embed Python. The old function, PySys_SetArgv(), would always update sys.path, and sometimes it would add the current directory. This meant that, if you ran an application embedding Python in a directory controlled by someone else, attackers could put a Trojan-horse module in the directory (say, a file named os.py) that your application would then import and run.

If you maintain a C/C++ application that embeds Python, check whether you're calling PySys_SetArgv() and carefully consider whether the application should be using PySys_SetArgvEx() with updatepath set to false.

Security issue reported as CVE-2008-5983 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983]; discussed in bpo-5753 [https://bugs.python.org/issue?@action=redirect&bpo=5753], and fixed by Antoine Pitrou.

新增的宏：Python 头文件现在定义了以下的宏: Py_ISALNUM, Py_ISALPHA, Py_ISDIGIT, Py_ISLOWER, Py_ISSPACE, Py_ISUPPER, Py_ISXDIGIT, Py_TOLOWER 和 Py_TOUPPER。 所有这些函数都类似于用于对字符归类的 C 标准宏，但忽略当前语言区域设置，因为在一些场合下 Python 需要以语言区域无关的方式分析字符。 （由 Eric Smith 添加；参见 bpo-5793 [https://bugs.python.org/issue?@action=redirect&bpo=5793]。）

Removed function: PyEval_CallObject is now only available as a macro. A function version was being kept around to preserve ABI linking compatibility, but that was in 1997; it can certainly be deleted by now. (Removed by Antoine Pitrou; bpo-8276 [https://bugs.python.org/issue?@action=redirect&bpo=8276].)

New format codes: the PyFormat_FromString(), PyFormat_FromStringV(), and PyErr_Format() functions now accept %lld and %llu format codes for displaying C's long long types. (Contributed by Mark Dickinson; bpo-7228 [https://bugs.python.org/issue?@action=redirect&bpo=7228].)

线程和进程分叉之间的复杂交互已更改。之前，由 os.fork() 创建的子进程可能会失败，因为子进程仅有一个线程在运行，即执行 os.fork() 的线程。如果其他线程在执行分叉时持有锁（例如 Python 的导入锁），则该锁在新进程中仍会标记为“已持有”。但在子进程中，由于其他线程未复制，子进程将无法释放该锁，从而无法再执行导入。

Python 2.7 在执行 os.fork() 之前获取导入锁，并清理使用 threading 模块创建的任何锁。具有内部锁的 C 扩展模块，或自行调用 fork() 的模块，将不会受益于这种清理。

（由 Thomas Wouters 修复；参见 bpo-1590864 [https://bugs.python.org/issue?@action=redirect&bpo=1590864]。）

The Py_Finalize() function now calls the internal threading._shutdown() function; this prevents some exceptions from being raised when an interpreter shuts down. (Patch by Adam Olsen; bpo-1722344 [https://bugs.python.org/issue?@action=redirect&bpo=1722344].)

When using the PyMemberDef structure to define attributes of a type, Python will no longer let you try to delete or set a T_STRING_INPLACE attribute.

由 ctypes 模块定义的全局符号现在以 Py 或 _ctypes 为前缀。（由 Thomas Heller 实现；参见 bpo-3102 [https://bugs.python.org/issue?@action=redirect&bpo=3102]。）

New configure option: the --with-system-expat switch allows building the pyexpat module to use the system Expat library. (Contributed by Arfrever Frehtes Taifersar Arahesis; bpo-7609 [https://bugs.python.org/issue?@action=redirect&bpo=7609].)

新增配置选项：--with-valgrind 选项现在将禁用 pymalloc 分配器，该分配器难以被 Valgrind 内存错误检测器正确分析。因此，Valgrind 将更好地检测内存泄漏和溢出。（由 James Henstridge 贡献；参见 bpo-2422 [https://bugs.python.org/issue?@action=redirect&bpo=2422]。）

新增配置选项：你现在可以提供一个空字符串给 --with-dbmliborder= 以禁用所有各种 DBM 模块。（由 Arfrever Frehtes Taifersar Arahesis 添加；参见 bpo-6491 [https://bugs.python.org/issue?@action=redirect&bpo=6491]。）

The configure script now checks for floating-point rounding bugs on certain 32-bit Intel chips and defines a X87_DOUBLE_ROUNDING preprocessor definition. No code currently uses this definition, but it's available if anyone wishes to use it. (Added by Mark Dickinson; bpo-2937 [https://bugs.python.org/issue?@action=redirect&bpo=2937].)

configure also now sets a LDCXXSHARED Makefile variable for supporting C++ linking. (Contributed by Arfrever Frehtes Taifersar Arahesis; bpo-1222585 [https://bugs.python.org/issue?@action=redirect&bpo=1222585].)

构建过程现在创建必要的文件以支持 pkg-config。（由 Clinton Roy 贡献；参见 bpo-3585 [https://bugs.python.org/issue?@action=redirect&bpo=3585]。）

构建过程现在支持 Subversion 1.7。（由 Arfrever Frehtes Taifersar Arahesis 贡献；参见 bpo-6094 [https://bugs.python.org/issue?@action=redirect&bpo=6094]。）

Capsule 对象

Python 3.1 新增了一种 C 数据类型 PyCapsule，用于为扩展模块提供 C 语言 API 接口。胶囊（capsule）本质上是 C 语言中 void * 指针的封装载体，并作为模块属性对外暴露；例如，socket 模块的 API 通过 socket.CAPI 暴露，而 unicodedata 模块则暴露了 ucnhash_CAPI。其他扩展模块可以导入该模块，访问其字典以获取胶囊对象，进而获取其中的 void * 指针——该指针通常指向一个指针数组，其中包含模块各类 API 函数的地址。

There is an existing data type already used for this, PyCObject, but it doesn't provide type safety. Evil code written in pure Python could cause a segmentation fault by taking a PyCObject from module A and somehow substituting it for the PyCObject in module B. Capsules know their own name, and getting the pointer requires providing the name:

void *vtable;

if (!PyCapsule_IsValid(capsule, "mymodule.CAPI") {
        PyErr_SetString(PyExc_ValueError, "argument type invalid");
        return NULL;
}

vtable = PyCapsule_GetPointer(capsule, "mymodule.CAPI");

你可以确信 vtable 指向你所期望的内容。如果传递了不同的胶囊，PyCapsule_IsValid() 会检测到不匹配的名称并返回 false。有关使用这些对象的更多信息，请参阅 给扩展模块提供C API。

Python 2.7 now uses capsules internally to provide various extension-module APIs, but the PyCObject_AsVoidPtr() was modified to handle capsules, preserving compile-time compatibility with the CObject interface. Use of PyCObject_AsVoidPtr() will signal a PendingDeprecationWarning, which is silent by default.

在 Python 3.1 中实现并向下移植到 2.7，由 Larry Hastings 完成；在 bpo-5630 [https://bugs.python.org/issue?@action=redirect&bpo=5630] 中讨论。

特定于 Windows 的更改：

The msvcrt module now contains some constants from the crtassem.h header file: CRT_ASSEMBLY_VERSION, VC_ASSEMBLY_PUBLICKEYTOKEN, and LIBRARIES_ASSEMBLY_NAME_PREFIX. (Contributed by David Cournapeau; bpo-4365 [https://bugs.python.org/issue?@action=redirect&bpo=4365].)

The _winreg module for accessing the registry now implements the CreateKeyEx() and DeleteKeyEx() functions, extended versions of previously supported functions that take several extra arguments. The DisableReflectionKey(), EnableReflectionKey(), and QueryReflectionKey() were also tested and documented. (Implemented by Brian Curtin: bpo-7347 [https://bugs.python.org/issue?@action=redirect&bpo=7347].)

The new _beginthreadex() API is used to start threads, and the native thread-local storage functions are now used. (Contributed by Kristján Valur Jónsson; bpo-3582 [https://bugs.python.org/issue?@action=redirect&bpo=3582].)

The os.kill() function now works on Windows. The signal value can be the constants CTRL_C_EVENT, CTRL_BREAK_EVENT, or any integer. The first two constants will send Control-C and Control-Break keystroke events to subprocesses; any other value will use the TerminateProcess() API. (Contributed by Miki Tebeka; bpo-1220212 [https://bugs.python.org/issue?@action=redirect&bpo=1220212].)

os.listdir() 函数现在在空路径时正确地失败。（由 Hirokazu Yamamoto 修复；参见 bpo-5913 [https://bugs.python.org/issue?@action=redirect&bpo=5913]。）

The mimelib module will now read the MIME database from the Windows registry when initializing. (Patch by Gabriel Genellina; bpo-4969 [https://bugs.python.org/issue?@action=redirect&bpo=4969].)

特定于 Mac OS X 的更改：

路径 /Library/Python/2.7/site-packages 现在附加到 sys.path，以便在系统安装和用户安装的同一版本的副本之间共享添加的包。（由 Ronald Oussoren 更改；参见 bpo-4865 [https://bugs.python.org/issue?@action=redirect&bpo=4865]。）

在 2.7.13 版更改: 自2.7.13版本起，这一变更已被移除。/Library/Python/2.7/site-packages，即Apple提供的系统Python 2.7所使用的site-packages目录，不再被追加到用户安装的Python（例如通过python.org安装器安装的Python）的 sys.path 中。自 macOS 10.12 起，Apple 更改了系统 site-packages 目录的配置方式，这可能导致安装pip组件（如setuptools）失败。为系统 Python 安装的包将不再与用户安装的 Python 共享。(参见 bpo-28440 [https://bugs.python.org/issue?@action=redirect&bpo=28440])

特定于 FreeBSD 的更改：

FreeBSD 7.1's SO_SETFIB constant, used with getsockopt()/setsockopt() to select an alternate routing table, is now available in the socket module. (Added by Kyle VanderBeek; bpo-8235 [https://bugs.python.org/issue?@action=redirect&bpo=8235].)

其他的改变和修正

两个基准测试脚本，iobench 和 ccbench，已被添加到 Tools 目录中。iobench 用于测量内置文件I/O对象（由 open() 返回）在进行各种操作时的速度，而 ccbench 是一个并发基准测试，旨在测量在使用不同数量线程执行多个任务时的计算吞吐量、线程切换延迟和IO处理带宽。

Tools/i18n/msgfmt.py 脚本现在能够理解 .po 文件中的复数形式。（由 Martin von Löwis 修复;参见 bpo-5464 [https://bugs.python.org/issue?@action=redirect&bpo=5464]。）

When importing a module from a .pyc or .pyo file with an existing .py counterpart, the co_filename attributes of the resulting code objects are overwritten when the original filename is obsolete. This can happen if the file has been renamed, moved, or is accessed through different paths. (Patch by Ziga Seilnacht and Jean-Paul Calderone; bpo-1180193 [https://bugs.python.org/issue?@action=redirect&bpo=1180193].)

regrtest.py 脚本现在接受一个 --randseed= 开关，该开关需要一个整数作为随机种子，用于 -r 选项以随机顺序执行测试。-r 选项还会报告所使用的种子（由 Collin Winter 添加）。

另一个 regrtest.py 开关是 -j，它需要一个整数来指定并行运行的测试数量。这可以减少多核机器上的总运行时间。此选项与多个其他选项兼容，包括已知会产生长运行时间的 -R 开关（由 Antoine Pitrou 添加，参见 bpo-6152 [https://bugs.python.org/issue?@action=redirect&bpo=6152]）。这也可以与新的 -F 开关一起使用，该开关会循环运行选定的测试，直到它们失败为止（由 Antoine Pitrou 添加；参见 bpo-7312 [https://bugs.python.org/issue?@action=redirect&bpo=7312]）。

当作为脚本执行时，py_compile.py 模块现在接受 '-' 作为参数，这将从标准输入读取要编译的文件名列表（由 Piotr Ożarowski 贡献；参见 bpo-8233 [https://bugs.python.org/issue?@action=redirect&bpo=8233]）。

移植到 Python 2.7

本节列出了先前描述的改变以及可能需要修改你的代码的其他问题修正:

The range() function processes its arguments more consistently; it will now call __int__() on non-float, non-integer arguments that are supplied to it. (Fixed by Alexander Belopolsky; bpo-1533 [https://bugs.python.org/issue?@action=redirect&bpo=1533].)

字符串的 format() 方法将浮点数和复数的默认精度从 6 小数位改为 12 小数位，这与 str() 使用的精度一致（由 Eric Smith 更改；参见 bpo-5920 [https://bugs.python.org/issue?@action=redirect&bpo=5920]）。

Because of an optimization for the with statement, the special methods __enter__() and __exit__() must belong to the object's type, and cannot be directly attached to the object's instance. This affects new-style classes (derived from object) and C extension types. (bpo-6101 [https://bugs.python.org/issue?@action=redirect&bpo=6101].)

Due to a bug in Python 2.6, the exc_value parameter to __exit__() methods was often the string representation of the exception, not an instance. This was fixed in 2.7, so exc_value will be an instance as expected. (Fixed by Florent Xicluna; bpo-7853 [https://bugs.python.org/issue?@action=redirect&bpo=7853].)

当使用 __slots__ 设置一组受限属性时，删除未设置的属性不会像预期那样引发 AttributeError。（由 Benjamin Peterson 修复；参见 bpo-7604 [https://bugs.python.org/issue?@action=redirect&bpo=7604]。）

在标准库中:

涉及 datetime 实例的操作，如果结果年份超出支持范围，并不总是引发 OverflowError。现在此类错误将更仔细地检查，并会引发异常。（由 Mark Leander 报告，Anand B. Pillai 和 Alexander Belopolsky 提供补丁；参见 bpo-7150 [https://bugs.python.org/issue?@action=redirect&bpo=7150]。）

当使用 Decimal 实例与字符串的 format() 方法时，默认对齐方式之前是左对齐。这已更改为右对齐，可能会改变你的程序输出。（由 Mark Dickinson 更改；参见 bpo-6857 [https://bugs.python.org/issue?@action=redirect&bpo=6857]。）

涉及信号 NaN 值（或 sNAN）的比较现在会触发 InvalidOperation，而不是根据比较运算符静默地返回真或假值。静默 NaN 值（或 NaN）现在可以被哈希。 (由 Mark Dickinson 修复；参见 bpo-7279 [https://bugs.python.org/issue?@action=redirect&bpo=7279])

The ElementTree library, xml.etree, no longer escapes ampersands and angle brackets when outputting an XML processing instruction (which looks like <?xml-stylesheet href="#style1"?>) or comment (which looks like <!-- comment -->). (Patch by Neil Muller; bpo-2746 [https://bugs.python.org/issue?@action=redirect&bpo=2746].)

The readline() method of StringIO objects now does nothing when a negative length is requested, as other file-like objects do. (bpo-7348 [https://bugs.python.org/issue?@action=redirect&bpo=7348]).

syslog 模块现在将使用 sys.argv[0] 的值作为标识符，而不是之前的默认值 'python'。（由 Sean Reifschneider 更改；参见 bpo-8451 [https://bugs.python.org/issue?@action=redirect&bpo=8451]。）

tarfile 模块的默认错误处理已更改，不再抑制致命错误。之前的默认错误级别为 0，这意味着错误只会导致一条消息被写入调试日志，但由于调试日志默认不激活，这些错误会被忽略。现在的默认错误级别为 1，如果出现错误会引发异常。（由 Lars Gustäbel 改变；参见 bpo-7357 [https://bugs.python.org/issue?@action=redirect&bpo=7357]。）

The urlparse module's urlsplit() now handles unknown URL schemes in a fashion compliant with RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html]: if the URL is of the form "<something>://...", the text before the :// is treated as the scheme, even if it's a made-up scheme that the module doesn't know about. This change may break code that worked around the old behaviour. For example, Python 2.6.4 or 2.5 will return the following:

>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '', '//host/filename?query', '', '')

Python 2.7（以及Python 2.6.5）将返回：

>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '', '')

（Python 2.7实际上产生的输出略有不同，因为它返回的是一个具名元组而不是标准元组。）

对于C 扩展模块：

使用整数格式代码与 PyArg_Parse* 函数族的 C 扩展现在将引发 TypeError 异常，而不是触发 DeprecationWarning (参见 bpo-5080 [https://bugs.python.org/issue?@action=redirect&bpo=5080]。)

Use the new PyOS_string_to_double() function instead of the old PyOS_ascii_strtod() and PyOS_ascii_atof() functions, which are now deprecated.

对于嵌入Python的应用程序：

The PySys_SetArgvEx() function was added, letting applications close a security hole when the existing PySys_SetArgv() function was used. Check whether you're calling PySys_SetArgv() and carefully consider whether the application should be using PySys_SetArgvEx() with updatepath set to false.

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

当情况确实需要时，新特性可能会添加到 Python 2.7 的维护版本中。任何此类添加必须经过 Python 增强提案（PEP）流程，并充分说明为什么不能仅通过将新功能添加到 Python 3 或将其发布到 Python 包索引来妥善解决。

除了下面列出的具体提案外，还有一个一般性豁免，允许在任何 Python 2.7 维护版本中添加新的 -3 警告。

调试模式的两个新环境变量

In debug mode, the [xxx refs] statistic is not written by default, the PYTHONSHOWREFCOUNT environment variable now must also be set. (Contributed by Victor Stinner; bpo-31733 [https://bugs.python.org/issue?@action=redirect&bpo=31733].)

When Python is compiled with COUNT_ALLOC defined, allocation counts are no longer dumped by default anymore: the PYTHONSHOWALLOCCOUNT environment variable must now also be set. Moreover, allocation counts are now dumped into stderr, rather than stdout. (Contributed by Victor Stinner; bpo-31692 [https://bugs.python.org/issue?@action=redirect&bpo=31692].)

2.7.15 新版功能.

PEP 434：针对所有分支的 IDLE 增强功能豁免提案

PEP 434 [https://www.python.org/dev/peps/pep-0434] 描述了对随 Python 一起提供的 IDLE 开发环境所做的更改的一般性豁免。此豁免使 IDLE 开发人员能够在所有受支持的 Python 2 和 3 版本中提供更一致的用户体验。

有关 IDLE 任何变更的详细信息，请参考特定版本的 NEWS 文件。

PEP 466: 针对 Python 2.7 的网络安全加固

PEP 466 [https://www.python.org/dev/peps/pep-0466] 描述了一系列已获批准纳入 Python 2.7 维护版本的网络安全增强提案，其中首个变更出现在 Python 2.7.7 版本中。

PEP 466 [https://www.python.org/dev/peps/pep-0466] Python 2.7.7 中添加的相关功能：

hmac.compare_digest() 从 Python 3 向下移植，以向 Python 2 应用提供抵抗定时攻击的比较操作。（由 Alex Gaynor 贡献；参见 bpo-21306 [https://bugs.python.org/issue?@action=redirect&bpo=21306]。）

官方 Windows 安装程序中的 OpenSSL 1.0.1g 已在 python.org 上升级。（由 Zachary Ware 贡献；参见 bpo-21462 [https://bugs.python.org/issue?@action=redirect&bpo=21462]。）

PEP 466 [https://www.python.org/dev/peps/pep-0466] Python 2.7.8 中添加的相关功能：

hashlib.pbkdf2_hmac() 从 Python 3 向下移植，以向 Python 2 应用广泛提供适用于安全密码存储的哈希算法。（由 Alex Gaynor 贡献；参见 bpo-21304 [https://bugs.python.org/issue?@action=redirect&bpo=21304]。）

OpenSSL 1.0.1h was upgraded for the official Windows installers published on python.org. (contributed by Zachary Ware in bpo-21671 [https://bugs.python.org/issue?@action=redirect&bpo=21671] for CVE-2014-0224)

PEP 466 [https://www.python.org/dev/peps/pep-0466] Python 2.7.9 中添加的相关功能：

大部分 Python 3.4 的 ssl 模块已向下移植。这意味着 ssl 现在支持服务器名称指示、TLS1.x 设置、访问平台证书存储、SSLContext 类以及其他特性。（由 Alex Gaynor 和 David Reid 贡献；参见 bpo-21308 [https://bugs.python.org/issue?@action=redirect&bpo=21308]。）

有关具体细节，请参阅模块文档中标记为"Version added: 2.7.9"的说明注释。

os.urandom() 已更改，以缓存对 /dev/urandom 的文件描述符，而不是在每次调用时重新打开 /dev/urandom。（由 Alex Gaynor 贡献；参见 bpo-21305 [https://bugs.python.org/issue?@action=redirect&bpo=21305]。）

hashlib.algorithms_guaranteed 和 hashlib.algorithms_available 从 Python 3 向下移植，以简化 Python 2 应用选择最强可用哈希算法的过程。（由 Alex Gaynor 在 bpo-21307 [https://bugs.python.org/issue?@action=redirect&bpo=21307] 中贡献）

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

PEP 477 [https://www.python.org/dev/peps/pep-0477] 批准将 PEP 453 [https://www.python.org/dev/peps/pep-0453] ensurepip 模块及其启用的新增文档纳入 Python 2.7 维护版本，首次出现在 Python 2.7.9 版本中。

默认对 pip 进行初始设置

新的 ensurepip 模块（定义于 PEP 453 [https://www.python.org/dev/peps/pep-0453]）提供了一个标准的跨平台机制，用于将 pip 安装程序引导到 Python 安装中。Python 2.7.9 中包含的 pip 版本是 pip 1.5.6，未来的 2.7.x 维护版本将更新捆绑版本为创建发布候选时最新的 pip 版本。

默认情况下，命令 pip、pipX 和 pipX.Y 将在所有平台上安装（其中 X.Y 代表 Python 安装的版本），同时安装 pip Python 包及其依赖项。

对于 CPython 在 POSIX 系统上的源代码构建，make install 和 make altinstall 命令默认不会自动安装 pip。这种行为可以通过配置选项控制，并通过 Makefile 选项覆盖。

在 Windows 和 Mac OS X 上，现在 CPython 安装程序默认会将 pip 与 CPython 本身一同安装（用户可以在安装过程中选择不安装它）。 Window 用户需要选择执行 PATH 修改以使 pip 在命令行中默认可用，在其他情况下它仍然可以通过 Windows 版 Python 启动器以 py -m pip 的方式使用。

正如 在 PEP 中已讨论的 [https://www.python.org/dev/peps/pep-0477/#disabling-ensurepip-by-downstream-distributors]，平台打包者可以选择默认不安装这些命令，只需要在它们被发起调用时，能够提供有关如何在该平台上安装它们的简单清晰的指引（通常是使用系统包管理器）。

文档更改

作为此项更改的一部分，文档的 安装 Python 模块 和 分发 Python 模块 章节已经完全重新设计，快速入门和 FAQ 文档也是如此。 大部分打包指南文档现在都已被移至由 Python Packaging Authority 维护的 Python Packaging User Guide [https://packaging.python.org] 以及相应的独立项目文档。

However, as this migration is currently still incomplete, the legacy versions of those guides remaining available as 安装Python模块（旧版） and 分发 Python 模块（遗留版本）.

参见

PEP 453 [https://www.python.org/dev/peps/pep-0453] -- Python 安装版中对 pip 的显式初始设置

PEP 由Donald Stufft 和 Nick Coghlan 撰写，由 Donald Stufft，Nick Coghlan，Martin von Löwis 和 Ned Deily 实现。

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

PEP 476 [https://www.python.org/dev/peps/pep-0476] updated httplib and modules which use it, such as urllib2 and xmlrpclib, to now verify that the server presents a certificate which is signed by a Certificate Authority in the platform trust store and whose hostname matches the hostname being requested by default, significantly improving security for many applications. This change was made in the Python 2.7.9 release.

对于需要之前版本的旧有行为的应用程序，可以传入一个替代的上下文:

import urllib2
import ssl

# This disables all verification
context = ssl._create_unverified_context()

# This allows using a specific certificate for the host, which doesn't need
# to be in the trust store
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib2.urlopen("https://invalid-cert", context=context)

PEP 493：适用于Python 2.7 的 HTTPS 验证迁移工具

PEP 493 [https://www.python.org/dev/peps/pep-0493] 提供了额外的迁移工具，以支持对包含依赖历史宽松服务器证书处理的应用程序和服务的环境进行更渐进的基础设施升级过程。这些添加内容在 Python 2.7.12 版本中实现。

这些工具旨在用于那些无法修改以显式传递更宽松 SSL 上下文的应用程序和服务，在建立连接时使用。

对于完全无法修改的应用程序和服务，可以设置新的 PYTHONHTTPSVERIFY 环境变量为 0，以将整个 Python 进程恢复到 Python 2.7.8 及早期版本的默认宽松行为。

For cases where the connection establishment code can't be modified, but the overall application can be, the new ssl._https_verify_certificates() function can be used to adjust the default behaviour at runtime.

新增 make regen-all 构建目标

为了简化交叉编译，并确保 CPython 能够可靠地编译而不需要已存在可用的 Python 版本，基于 autotools 的构建系统将不再尝试根据文件修改时间隐式地重新编译已生成的文件。

取而代之的是，新增了一个 make regen-all 命令以便在需要时强制重新生成这些文件（例如在基于预生成版本构建了 Python 的初始版本之后）。

还定义了其他一些更具选择性的重生成目标 —— 详情参见 Makefile.pre.in [https://github.com/python/cpython/tree/3.10/Makefile.pre.in]。

（由 Victor Stinner 在 bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404] 中贡献。）

2.7.14 新版功能.

移除了 make touch 构建目标

之前用于通过更新生成文件的修改时间来请求隐式的重新生成这些文件的 make touch 构建目标已被移除。

它已被新的 make regen-all 目标所替代。

（由 Victor Stinner 在 bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404] 中贡献。）

在 2.7.14 版更改.

致谢

作者要感谢以下人员为本文的各种草案提供建议，更正和帮助： Nick Coghlan, Philip Jenvey, Ryan Lovett, R. David Murray, Hugh Secker-Walker.

Python 2.6 有什么新变化

作者

A.M. Kuchling (amk at amk.ca)

本文介绍了 Python 2.6 的新特性，它发布于 2008 年 10 月 1 日。发布日程说明见 PEP 361 [https://www.python.org/dev/peps/pep-0361]。

Python 2.6 的主题是为迁移到 Python 3.0 做准备，这是 Python 语言的一次重大重新设计。 只要有可能，Python 2.6 就会纳入 3.0 的新特性和语法，同时通过不删除旧特性或语法来保持与现有代码的兼容。 当无法做到这一点时，Python 2.6 会尽力而为，在 future_builtins 模块中添加兼容性函数，并通过 -3 开关来警告将在 3.0 中变得不支持的用法。

标准库中增加了一些重要的新包，如 multiprocessing 和 json 模块等，但与 Python 3.0 完全无关联的新特性并不多。

Python 2.6 还对整个源代码进行了大量改进和错误修复。 通过搜索更改日志我们发现在 Python 2.5 和 2.6 之间应用了 259 个补丁并修复了 612 个错误。 这两个数字可能都被低估了。

本文并不试图提供新特性的完整规范说明，而是提供一个方便的概览。 要了解完整的细节，请参阅 Python 2.6 的文档。 如果你想了解有关设计和实现的具体考量，请参阅特定新特性 的 PEP。 在可能的情况下，“Python 有什么新变化”为每个更改的错误修正/补丁项提供链接。

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 衍生功能包括:

用于将对象转换为复数的 __complex__() 方法。

用于捕获异常的替代语法: except TypeError as exc。

增加 functools.reduce() 作为内置 reduce() 函数的同义词。

Python 3.0 新增了一些内置函数并对部分现有内置函数的语法进行了修改。 在 3.0 中新增的函数如 bin() 已直接添加到 Python 2.6 中，但现有内置函数则未修改；替代做法是在 future_builtins 模块中包含具有 3.0 新语法的版本。 要与 3.0 兼容的代码可以在必要时执行 from future_builtins import hex, map。

一个新的命令行开关 -3 可以对 Python 3.0 将移除的特性发出警告。 您可以使用该开关运行代码，以了解将代码移植到 3.0 所需的工作量。 Python 代码可以使用 sys.py3kwarning 访问该开关的值，C 扩展代码可以使用 Py_Py3kWarningFlag 访问该开关的值。

参见

The 3xxx series of PEPs, which contains proposals for Python 3.0. PEP 3000 [https://www.python.org/dev/peps/pep-3000] describes the development process for Python 3.0. Start with PEP 3100 [https://www.python.org/dev/peps/pep-3100] that describes the general goals for Python 3.0, and then explore the higher-numbered PEPS that propose specific features.

开发过程的变化

在开发2.6时，Python开发过程经历了两个重大变化：我们从SourceForge的问题跟踪程序切换到定制的Roundup安装，文档从LaTeX转换为reStructuredText。

新问题追踪：简述

很长一段时间以来，Python开发人员对SourceForge的bug跟踪器越来越恼火。SourceForge的托管解决方案不允许进行大量定制；例如，无法定制问题的生命周期。

Python软件基金会的基础设施委员会因此发布了一个问题跟踪器的征集公告，邀请志愿者设置不同的产品，并从SourceForge导入一些错误和补丁。评估了四种不同的跟踪器：Jira [https://www.atlassian.com/software/jira/]，Launchpad [https://launchpad.net/]，Roundup <https://roundup.sourceforge.io/>`__和`Trac [https://trac.edgewall.org/]。委员会最终确定Jira和Roundup为两个候选方案。Jira是一个商业产品，为自由软件项目提供免费托管实例；Roundup是一个开源项目，需要志愿者来管理，并需要一个服务器来托管。

在发出志愿者号召后，在https://bugs.python.org的一个Roundup的安装可以托管多个跟踪器，现在该服务器还托管Jython和Python网站的问题跟踪器。它肯定会在未来找到其他用途。在可能的情况下，此版本的“What's New in Python”链接到每个更改的bug/补丁项。

Hosting of the Python bug tracker is kindly provided by Upfront Systems [http://www.upfrontsoftware.co.za] of Stellenbosch, South Africa. Martin von Löwis put a lot of effort into importing existing bugs and patches from SourceForge; his scripts for this import operation are at https://svn.python.org/view/tracker/importer/ and may be useful to other projects wishing to move from SourceForge to Roundup.

参见

https://bugs.python.org

Python 的错误追踪器

https://bugs.jython.org:

Jython 的错误追踪器

https://roundup.sourceforge.io/

Roundup 下载和文档。

https://svn.python.org/view/tracker/importer/

Martin von Löwis 的转换脚本。

新的文档格式：使用 Sphinx 的 reStructuredText

自 1989 年左右项目启动以来，Python 文档一直使用 LaTeX 编写。在 1980 年代和 1990 年代早期，大多数文档都是打印出来供日后学习的，而不是在网上查看。 LaTeX 被广泛使用，因为它既能提供美观的打印输出，又能在掌握了标记的基本规则后直接进行编写。

如今 LaTeX 仍被用于编写印刷出版物，但编程工具的格局已经发生了变化。 我们不再打印成堆的文档，取而代之的是在线浏览，HTML 已成为最重要的支持格式。 不幸的是，将 LaTeX 转换为 HTML 相当复杂，长期担任 Python 文档编辑的 Fred L. Drake Jr. 花了许多时间在维护转换过程上。 偶尔有人会建议将文档转换成 SGML，之后再转换成 XML，但进行良好的转换是一项艰巨的任务，从来没有人投入所需的时间来完成这项工作。

在 2.6 开发周期中，Georg Brandl 投入了大量精力来构建一个新的工具链，用于处理文档。由此产生的软件包名为 Sphinx，可从 https://www.sphinx-doc.org/ 获取。

Sphinx 专注于 HTML 输出，可生成吸引人风格的现代 HTML；通过转换为 LaTeX，仍可支持打印输出。输入格式是 reStructuredText，这是一种支持自定义扩展和指令的标记语法，在 Python 社区很常用。

Sphinx 是一个可用于写文档的独立软件包，将近二十多个其他项目 (列在 Sphinx 网站 [https://www.sphinx-doc.org/en/master/examples.html] 上) 已采用 Sphinx 作为其文档工具。

参见

Documenting Python [https://devguide.python.org/documenting/]

描述如何编写Python文档。

Sphinx [https://www.sphinx-doc.org/]

Sphinx工具链的文档和代码。

Docutils [https://docutils.sourceforge.io]

reStructuredText 的基础解析器和工具集。

PEP 343: "with" 语句

在 Python 2.5 之前的版本中，"with" 语句是一个可选功能，可以通过 from __future__ import with_statement 指令启用。 在 2.6 中，该语句不再需要特别启用；这意味着 with 现在总是一个关键字。 本节的其余部分是“Python 2.5 新特性”文档中相应部分的复制；如果您熟悉 Python 2.5 中的 'with' 语句，可以跳过本节。

'with' 语句澄清了以前使用 try...finally 块来确保执行清理代码的代码。在本节中，我将讨论该语句的常见用法。在下一节中，我将探讨实现细节，并展示如何编写与该语句一起使用的对象。

The 'with' 语是一种基本结构如下所示的流程控制结构:

with expression [as variable]:
    with-block

The expression is evaluated, and it should result in an object that supports the context management protocol (that is, has __enter__() and __exit__() methods).

The object's __enter__() is called before with-block is executed and therefore can run set-up code. It also may return a value that is bound to the name variable, if given. (Note carefully that variable is not assigned the result of expression.)

After execution of the with-block is finished, the object's __exit__() method is called, even if the block raised an exception, and can therefore run clean-up code.

一些标准 Python 对象现在已支持上下文管理协议并可被用于 'with' 语句。 文件对象就是一个例子:

with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... more processing code ...

在此语句被执行之后，文件对象 f 将被自动关闭，即使是当 for 循环在代码块中间引发了异常的时候也是如此。

注解

In this case, f is the same object created by open(), because file.__enter__() returns self.

threading 模块的加锁和条件变量也支持 'with' 语句:

lock = threading.Lock()
with lock:
    # Critical section of code
    ...

这个锁会在代码块被执行之前锁定并总是会在代码块完成之后释放。

decimal 模块中的 localcontext() 函数可以轻松保存和恢复当前的十进制上下文，该上下文封装了计算所需的精度和舍入特性:

from decimal import Decimal, Context, localcontext

# Displays with default precision of 28 digits
v = Decimal('578')
print v.sqrt()

with localcontext(Context(prec=16)):
    # All code in this block uses a precision of 16 digits.
    # The original context is restored on exiting the block.
    print v.sqrt()

编写上下文管理器

在底层，'with' 语句相当复杂。大多数人只会与现有对象一起使用 'with'，不需要了解这些细节，所以如果你愿意，可以跳过本节的其余部分。新对象的作者需要理解底层实现的细节，应该继续阅读。

在更高层级上对于上下文管理器协议的解释:

The expression is evaluated and should result in an object called a "context manager". The context manager must have __enter__() and __exit__() methods.

The context manager's __enter__() method is called. The value returned is assigned to VAR. If no as VAR clause is present, the value is simply discarded.

BLOCK 中的代码会被执行。

If BLOCK raises an exception, the context manager's __exit__() method is called with three arguments, the exception details (type, value, traceback, the same values returned by sys.exc_info(), which can also be None if no exception occurred). The method's return value controls whether an exception is re-raised: any false value re-raises the exception, and True will result in suppressing it. You'll only rarely want to suppress the exception, because if you do the author of the code containing the 'with' statement will never realize anything went wrong.

If BLOCK didn't raise an exception, the __exit__() method is still called, but type, value, and traceback are all None.

让我们通过一个例子来思考。我不会展示详细的代码，而只会概述支持事务的数据库所需的方法。

（对于不熟悉数据库术语的人来说：对数据库的一组更改被组合成一个事务。事务可以被提交，意味着所有更改都被写入数据库，或者被回滚，意味着所有更改都被丢弃，数据库保持不变。更多信息请参阅任何数据库教材。）

假设有一个表示数据库连接的对象。我们的目标将允许用户编写如下代码：

db_connection = DatabaseConnection()
with db_connection as cursor:
    cursor.execute('insert into ...')
    cursor.execute('delete from ...')
    # ... more operations ...

如果块中的代码完美运行，则应提交事务；如果出现异常，则应回滚事务。以下是假设的 DatabaseConnection 的基本接口：

class DatabaseConnection:
    # Database interface
    def cursor(self):
        "Returns a cursor object and starts a new transaction"
    def commit(self):
        "Commits current transaction"
    def rollback(self):
        "Rolls back current transaction"

The __enter__() method is pretty easy, having only to start a new transaction. For this application the resulting cursor object would be a useful result, so the method will return it. The user can then add as cursor to their 'with' statement to bind the cursor to a variable name.

class DatabaseConnection:
    ...
    def __enter__(self):
        # Code to start a new transaction
        cursor = self.cursor()
        return cursor

The __exit__() method is the most complicated because it's where most of the work has to be done. The method has to check if an exception occurred. If there was no exception, the transaction is committed. The transaction is rolled back if there was an exception.

在下面的代码中，执行将直接从函数末尾跳出，返回默认值 None。None 为假值，因此异常将自动重新抛出。如果你希望更明确，可以在标记的位置添加一个 return 语句。:

class DatabaseConnection:
    ...
    def __exit__(self, type, value, tb):
        if tb is None:
            # No exception, so commit
            self.commit()
        else:
            # Exception occurred, so rollback.
            self.rollback()
            # return False

contextlib 模块

contextlib 模块提供了一些函数和一个装饰器，这些在编写用于与'with'语句一起使用的对象时非常有用。

The decorator is called contextmanager(), and lets you write a single generator function instead of defining a new class. The generator should yield exactly one value. The code up to the yield will be executed as the __enter__() method, and the value yielded will be the method's return value that will get bound to the variable in the 'with' statement's as clause, if any. The code after the yield will be executed in the __exit__() method. Any exception raised in the block will be raised by the yield statement.

使用这个装饰器，我们上一节中的数据库示例可以写成:

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:
    ...

contextlib 模块还有一个``nested(mgr1, mgr2, ...)``函数，它可以将多个上下文管理器组合在一起，这样你就不需要编写嵌套的'with'语句。在这个例子中，单个'with'语句既启动数据库事务又获取线程锁:

lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...

最后，closing() 函数返回其参数，以便它可以绑定到变量，并在块结束时调用参数的 .close() 方法。:

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)

参见

PEP 343 [https://www.python.org/dev/peps/pep-0343] - "with" 语句

PEP由Guido van Rossum和Nick Coghlan撰写；由Mike Bland、Guido van Rossum和Neal Norwitz实现。PEP展示了为'with'语句生成的代码，这对于学习该语句的工作原理很有帮助。

contextlib 模块的文档。

PEP 366: 从主模块显式相对导入

Python 的 -m 开关允许将一个模块作为脚本来运行。 当你运行一个位于某个包内的模块时，相对导入将无法正确运作。

The fix for Python 2.6 adds a __package__ attribute to modules. When this attribute is present, relative imports will be relative to the value of this attribute instead of the __name__ attribute.

PEP 302-style importers can then set __package__ as necessary. The runpy module that implements the -m switch now does this, so relative imports will now work correctly in scripts running from inside a package.

PEP 370: 分用户的 site-packages 目录

当你运行Python时，模块搜索路径 sys.path 通常包括一个路径以 "site-packages" 结尾的目录。这个目录旨在存放本地安装的、对所有使用该机器或特定站点安装的用户可用的包。

Python 2.6 引入了一个用于用户专属站点目录的惯例。 该目录根据具体系统平台各不相同:

Unix 和 Mac OS X: ~/.local/

Windows: %APPDATA%/Python

在此目录中，会有特定版本的子目录，例如在Unix/Mac OS上的 lib/python2.6/site-packages 和在Windows上的 Python26/site-packages。

如果你不喜欢默认目录，可以通过环境变量覆盖它。PYTHONUSERBASE 设置支持此功能的所有Python版本使用的根目录。在Windows上，可以通过设置 APPDATA 环境变量来更改应用程序特定数据的目录。你也可以修改你的Python安装中的 site.py 文件。

此功能可以通过使用 -s 选项运行Python或设置 PYTHONNOUSERSITE 环境变量来完全禁用。

参见

PEP 370 [https://www.python.org/dev/peps/pep-0370] - 分用户的 site-packages 目录

PEP 由 Christian Heimes 撰写并实现

PEP 371: 多任务处理包

新的 multiprocessing 包让Python程序可以创建新进程来执行计算并返回结果给父进程。父进程和子进程可以使用队列和管道进行通信，使用锁和信号量同步它们的操作，并且可以共享简单的数据数组。

multiprocessing 模块最初是作为 threading 模块的精确模拟，使用进程而不是线程。这个目标在 Python 2.6 的开发过程中被放弃了，但模块的总体方法仍然相似。基本类是 Process，它接收一个可调用对象和一组参数。start() 方法在子进程中启动可调用对象，之后你可以调用 is_alive() 方法来检查子进程是否仍在运行，以及调用 join() 方法来等待进程退出。

下面是一个简单的示例，子进程将计算阶乘。执行计算的函数写得很奇怪，以便当输入参数是 4 的倍数时，它会花费更长的时间。

import time
from multiprocessing import Process, Queue

def factorial(queue, N):
    "Compute a factorial."
    # If N is a multiple of 4, this function will take much longer.
    if (N % 4) == 0:
        time.sleep(.05 * N/4)

    # Calculate the result
    fact = 1L
    for i in range(1, N+1):
        fact = fact * i

    # Put the result on the queue
    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

使用 Queue 来传递阶乘的结果。Queue 对象存储在一个全局变量中。子进程将使用创建子进程时的变量值；因为它是 Queue，父进程和子进程可以使用该对象进行通信。（如果父进程更改全局变量的值，子进程的值不会受影响，反之亦然。）

另外两个类，Pool 和 Manager，提供了更高级别的接口。Pool 将创建固定数量的工作进程，然后可以通过调用 apply() 或 apply_async() 来添加单个请求，通过调用 map() 或 map_async() 来添加多个请求。以下代码使用 Pool 将请求分散到 5 个工作进程并获取结果列表:

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

这会产生以下输出:

1
39916800
51090942171709440000
8222838654177922817725562880000000
33452526613163807108170062053440751665152000000000
...

另一个高级接口，Manager 类，创建一个单独的服务器进程，可以持有 Python 数据结构的主副本。其他进程然后可以通过代理对象访问和修改这些数据结构。以下示例通过调用 dict() 方法创建一个共享字典；工作进程然后将值插入到字典中。（锁定不会自动为你完成，这在示例中无关紧要。Manager 的方法还包括 Lock()、RLock() 和 Semaphore()，用于创建共享锁。）

import time
from multiprocessing import Pool, Manager

def factorial(N, dictionary):
    "Compute a factorial."
    # Calculate the result
    fact = 1L
    for i in range(1, N+1):
        fact = fact * i

    # Store result in dictionary
    dictionary[N] = fact

if __name__ == '__main__':
    p = Pool(5)
    mgr = Manager()
    d = mgr.dict()         # Create shared dictionary

    # Run tasks using the pool
    for N in range(1, 1000, 10):
        p.apply_async(factorial, (N, d))

    # Mark pool as closed -- no more tasks can be added.
    p.close()

    # Wait for tasks to exit
    p.join()

    # Output results
    for k, v in sorted(d.items()):
        print k, v

这将产生如下输出:

1 1
11 39916800
21 51090942171709440000
31 8222838654177922817725562880000000
41 33452526613163807108170062053440751665152000000000
51 15511187532873822802242430164693032110632597200169861120000...

参见

multiprocessing 模块的文档。

PEP 371 [https://www.python.org/dev/peps/pep-0371] - 添加多任务处理包

PEP 由 Jesse Noller 和 Richard Oudkerk 撰写，由 Richard Oudkerk 和 Jesse Noller 实现

PEP 3101: 高级字符串格式

在 Python 3.0 中，% 运算符被更强大的字符串格式化方法 format() 所补充。对 str.format() 方法的支持已经回溯到 Python 2.6。

在2.6版本中，8位字符串和Unicode字符串都有一个 .format() 方法，该方法将字符串视为模板，并接受要格式化的参数。格式化模板使用大括号（{, }）作为特殊字符：

>>> # Substitute positional argument 0 into the string.
>>> "User ID: {0}".format("root")
'User ID: root'
>>> # Use the named keyword arguments
>>> "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'

大括号可以通过双写来转义：

>>> "Empty dict: {{}}".format()
"Empty dict: {}"

字段名可以是表示位置参数的整数，如 {0}、{1} 等，或者是关键字参数的名称。你还可以提供复合字段名来读取属性或访问字典键：

>>> 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'

请注意，当使用类似 [.mp4] 的字典样式表示法时，你不需要在字符串周围加任何引号；它将使用 .mp4 作为键来查找值。以数字开头的字符串将被转换为整数。你不能在格式字符串内编写更复杂的表达式。

到目前为止，我们已经展示了如何指定要替换到结果字符串中的字段。精确的格式化方式也可以通过添加一个冒号后跟一个格式说明符来控制。例如：

>>> # Field 0: left justify, pad to 15 characters
>>> # Field 1: right justify, pad to 6 characters
>>> fmt = '{0:15} ${1:>6}'
>>> fmt.format('Registration', 35)
'Registration    $    35'
>>> fmt.format('Tutorial', 50)
'Tutorial        $    50'
>>> fmt.format('Banquet', 125)
'Banquet         $   125'

格式说明符可以通过嵌套来引用其他字段:

>>> fmt = '{0:{1}}'
>>> width = 15
>>> fmt.format('Invoice #1234', width)
'Invoice #1234  '
>>> width = 35
>>> fmt.format('Invoice #1234', width)
'Invoice #1234                      '

可以指定所需宽度内的字段对齐方式：

字符 | 效果
< (默认) | 左对齐
> | 右对齐
^ | 居中对齐
= | （仅适用于数字类型）在符号后加空格。

格式说明符还可以包括一个表示类型，它控制值的格式化方式。例如，浮点数可以格式化为常规数字或指数表示法：

>>> '{0:g}'.format(3.75)
'3.75'
>>> '{0:e}'.format(3.75)
'3.750000e+00'

有多种展示类型可供选择。请参考2.6版文档中的 完整列表；以下是一个示例：

b | 二进制。输出以2为底的数字。
c | 字符。在打印之前将整数转换为相应的Unicode字符。
d | 十进制整数。 输出以 10 为基数的数字。
o | 八进制格式。 输出以 8 为基数的数字。
x | 十六进制格式。 输出以 16 为基数的数字，使用小写字母表示 9 以上的数码。
e | 指数表示法。用字母 'e' 以科学计数法打印数字以表示指数。
g | 通用格式。这会将数字打印为定点数，除非数字过大，在这种情况下会切换到 'e' 指数表示法。
n | 数字。这与 'g'（对于浮点数）或 'd'（对于整数）相同，不同之处在于它使用当前区域设置来插入适当的数字分隔符字符。
% | 百分比。将数字乘以100并以固定 ('f') 格式显示，后跟一个百分号。

类和类型可以定义一个 __format__() 方法来控制它们的格式化方式。它接收一个参数，即格式说明符：

def __format__(self, format_spec):
    if isinstance(format_spec, unicode):
        return unicode(str(self))
    else:
        return str(self)

还有一个内置的 format() 函数，用于格式化单个值。它调用类型的 __format__() 方法，并传入提供的说明符：

>>> format(75.6564, '.2f')
'75.66'

参见

格式字符串语法

格式字段的参考文档。

PEP 3101 [https://www.python.org/dev/peps/pep-3101] - 高级字符串格式

PEP 由 Eric V. Smith 撰写并实现

PEP 3105: print 改为函数

在 Python 3.0 中 print 语句变成了 print() 函数。 将 print() 变成函数使得可以通过 def print(...) 或从其他地方导入一个新函数来替换该函数。

Python 2.6 提供了 __future__ 导入语句来移除 print 语法，让你可以改用函数形式。 例如:

>>> from __future__ import print_function
>>> print('# of entries', len(dictionary), file=sys.stderr)

新函数的签名为:

def print(*args, sep=' ', end='\n', file=None)

形参包括:

args: 相应值将会被打印的位置参数。

sep: 分隔符，它将在参数之间被打印。

end: 结束文本，它将在所有参数输出完毕之后被打印。

file: 将被作为输出发送目标的文件对象。

参见

PEP 3105 [https://www.python.org/dev/peps/pep-3105] - print 改为函数

PEP 由 Georg Brandl 撰写

PEP 3110: 异常处理的变更

Python 程序员偶尔会犯的一个错误是编写这样的代码:

try:
    ...
except TypeError, ValueError:  # Wrong!
    ...

作者可能试图捕获 TypeError 和 ValueError 异常，但这段代码实际上做了不同的事情：它会捕获 TypeError 并将生成的异常对象绑定到局部名称 "ValueError"。 ValueError 异常根本不会被捕获。正确的代码应指定一个异常元组：

try:
    ...
except (TypeError, ValueError):
    ...

这个错误发生是因为这里逗号的使用是模糊的：它是表示解析树中的两个不同节点，还是表示一个元组节点？

Python 3.0 通过将逗号替换为单词 "as" 来使这一点明确。要捕获异常并将异常对象存储在变量 exc 中，你必须写成：

try:
    ...
except TypeError as exc:
    ...

Python 3.0 将仅支持使用 "as"，因此将第一个示例解释为捕获两个不同的异常。Python 2.6 同时支持逗号和 "as"，因此现有代码将继续工作。因此，我们建议在编写仅在 2.6 上执行的新的 Python 代码时使用 "as"。

参见

PEP 3110 [https://www.python.org/dev/peps/pep-3110] - 在 Python 3000 中捕获异常

PEP 由 Collin Winter 撰写并实现

PEP 3112: 字节字面值

Python 3.0 采用 Unicode 作为语言的基本字符串类型，并以不同的方式表示 8 位字面量，要么作为 b'string'，要么使用 bytes 构造器。为了未来的兼容性，Python 2.6 添加了 bytes 作为 str 类型的同义词，并且也支持 b'' 表示法。

2.6 的 str 与 3.0 的 bytes 类型在多方面存在差异；最显著的是，构造器完全不同。在 3.0 中，bytes([65, 66, 67]) 长度为 3，包含表示 ABC 的字节；在 2.6 中，bytes([65, 66, 67]) 返回表示列表的 str() 的 12 字节字符串。

在 2.6 中，bytes 的主要用途将是编写对象类型测试，例如 isinstance(x, bytes)。这将有助于 2to3 转换器，因为它无法判断 2.x 代码中的字符串是否意图包含字符或 8 位字节；现在你可以使用 bytes 或 str 来准确表示你的意图，并且生成的代码在 Python 3.0 中也是正确的。

还有一个 __future__ 导入，它使所有字符串字面量变为 Unicode 字符串。这意味着可以使用 \u 转义序列来包含 Unicode 字符：

from __future__ import unicode_literals

s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
     '\u3081\u3000\u751f\u305f\u307e\u3054')

print len(s)               # 12 Unicode characters

At the C level, Python 3.0 will rename the existing 8-bit string type, called PyStringObject in Python 2.x, to PyBytesObject. Python 2.6 uses #define to support using the names PyBytesObject(), PyBytes_Check(), PyBytes_FromStringAndSize(), and all the other functions and macros used with strings.

bytes 类型的实例与字符串一样属于不可变对象。 新增的 bytearray 类型则用于存储可变的字节序列:

>>> 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'

字节数组支持大部分的字符串类型方法，如 startswith()/endswith(), find()/rfind()，以及列表的某些方法，如 append(), pop() 和 reverse()。

>>> b = bytearray('ABC')
>>> b.append('d')
>>> b.append(ord('e'))
>>> b
bytearray(b'ABCde')

也有一个相应的 C API，包含 PyByteArray_FromObject(), PyByteArray_FromStringAndSize() 以及各种其他函数。

参见

PEP 3112 [https://www.python.org/dev/peps/pep-3112] - Python 3000 中的字节字面值

PEP 由 Jason Orendorff 撰写， 补丁2.6 由 Christian Heimes 撰写。

PEP 3116: 新 I/O 库

Python 的内置文件对象支持多种方法，但类似文件的对象并不一定支持所有这些方法。模仿文件的对象通常支持 read() 和 write()，但它们可能不支持 readline()，例如。Python 3.0 在 io 模块中引入了一个分层的 I/O 库，将缓冲和文本处理功能从基本的读写操作中分离出来。

io 模块提供了三个层次的抽象基类：

RawIOBase 定义了原始 I/O 操作：read()、readinto()、write()、seek()、tell()、truncate() 和 close()。这个类的大部分方法通常映射到单个系统调用。还有 readable()、writable() 和 seekable() 方法，用于确定给定对象允许哪些操作。

Python 3.0 为文件和套接字提供了这个类的具体实现，但 Python 2.6 并没有以这种方式重新组织其文件和套接字对象。

BufferedIOBase 是一个抽象基类，它在内存中缓冲数据，以减少使用的系统调用数量，使 I/O 处理更高效。它支持 RawIOBase 的所有方法，并添加了一个 raw 属性，用于持有底层的原始对象。

有五个具体类实现了这个 ABC。BufferedWriter 和 BufferedReader 用于支持只写或只读使用的对象，这些对象具有用于随机访问的 seek() 方法。BufferedRandom 对象支持对同一底层流的读写访问，而 BufferedRWPair 用于像 TTY 这样的对象，它们的读写操作作用于未连接的数据流。BytesIO 类支持在内存缓冲区上进行读取、写入和查找。

TextIOBase：提供用于读写字符串的函数（记住，在Python 3.0中字符串将是Unicode），并支持 universal newlines。TextIOBase 定义了 readline() 方法，并支持对对象进行迭代。

有两个具体实现。TextIOWrapper 包装了一个缓冲I/O对象，支持所有文本I/O方法，并添加了一个 buffer 属性以访问底层对象。StringIO 简单地在内存中缓冲所有内容，而不将任何内容写入磁盘。

(In Python 2.6, io.StringIO is implemented in pure Python, so it's pretty slow. You should therefore stick with the existing StringIO module or cStringIO for now. At some point Python 3.0's io module will be rewritten into C for speed, and perhaps the C implementation will be backported to the 2.x releases.)

在Python 2.6中，底层实现尚未重构以建立在 io 模块的类之上。提供该模块是为了更容易编写与3.0向前兼容的代码，并节省开发者编写自己的缓冲和文本I/O实现的努力。

参见

PEP 3116 [https://www.python.org/dev/peps/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等人编写代码。

PEP 3118: 修改缓冲区协议

缓冲协议是一个C级API，允许Python类型交换指向其内部表示的指针。例如，内存映射文件可以被视为字符缓冲区，这使得另一个模块如 re 可以将内存映射文件视为要搜索的字符字符串。

缓冲区协议的主要用户是像NumPy这样的数值处理包，它们暴露数组的内部表示，以便调用者可以直接写入数组数据，而不是通过较慢的API。这个PEP根据NumPy开发的经验更新了缓冲区协议，增加了一些新功能，例如指示数组形状或锁定内存区域。

最重要的新C API函数是 PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)，它接受一个对象和一组标志，并填充 Py_buffer 结构，包含对象内存表示的信息。对象可以使用此操作锁定内存，而外部调用者可能正在修改内容，因此有一个相应的 PyBuffer_Release(Py_buffer *view) 来指示外部调用者已完成。

The flags argument to PyObject_GetBuffer() specifies constraints upon the memory returned. Some examples are:

PyBUF_WRITABLE 指定内存必须为可写。

PyBUF_LOCK requests a read-only or exclusive lock on the memory.

PyBUF_C_CONTIGUOUS and PyBUF_F_CONTIGUOUS requests a C-contiguous (last dimension varies the fastest) or Fortran-contiguous (first dimension varies the fastest) array layout.

两个用于 PyArg_ParseTuple() 的新参数代码 s* 和 z*，将为形参返回锁定的缓冲区对象。

参见

PEP 3118 [https://www.python.org/dev/peps/pep-3118] - 修改缓冲区协议

PEP 由 Travis Oliphant 和 Carl Banks 撰写，由 Travis Oliphant 实现。

PEP 3119: 抽象基类

一些面向对象的语言，如Java，支持接口，声明一个类具有一组给定方法或支持给定的访问协议。抽象基类（Abstract Base Classes，简称ABCs）是Python中的等效功能。ABC支持包括一个名为 abc 的模块，其中包含一个名为 ABCMeta 的元类，isinstance() 和 issubclass() 内置函数对此元类的特殊处理，以及Python开发者认为将广泛有用的一系列基本ABCs。未来版本的Python可能会添加更多的ABCs。

假设你有一个特定的类，想知道它是否支持字典式访问。然而，“字典式”这个短语是模糊的。它可能意味着使用 obj[1] 访问项是有效的。这是否意味着使用 obj[2] = value 设置项也有效？或者对象将有 keys()、values() 和 items() 方法？那么迭代变体如 iterkeys() 呢？copy() 和 update() 呢？使用 iter() 迭代对象呢？

Python 2.6 的 collections 模块包含多种不同的抽象基类（ABC），这些类代表了这些区别。Iterable 表示一个类定义了 __iter__() 方法，而 Container 表示该类定义了 __contains__() 方法，因此支持 x in y 表达式。基本的字典接口，包括获取项目、设置项目以及 keys()、values() 和 items() 方法，由 MutableMapping 抽象基类定义。

你可以从特定的抽象基类派生自己的类，以表明它们支持该抽象基类的接口：

import collections

class Storage(collections.MutableMapping):
    ...

或者，你可以不从一个期望的抽象基类派生类，而是通过调用抽象基类的 register() 方法来注册该类：

import collections

class Storage:
    ...

collections.MutableMapping.register(Storage)

对于你编写的类，从抽象基类派生可能更清晰。register() 方法在你编写了一个新的抽象基类，可以描述一个现有类型或类，或者你想声明某个第三方类实现了抽象基类时很有用。例如，如果你定义了一个 PrintableType 抽象基类，可以这样操作：

# Register Python's types
PrintableType.register(int)
PrintableType.register(float)
PrintableType.register(str)

类应该遵守抽象基类指定的语义，但 Python 无法检查这一点；这取决于类作者理解抽象基类的要求并相应地实现代码。

要检查一个对象是否支持特定接口，你现在可以编写：

def func(d):
    if not isinstance(d, collections.MutableMapping):
        raise ValueError("Mapping object expected, not %r" % d)

不要觉得你必须像上面例子那样开始编写大量检查。Python 有一种强烈的鸭子类型传统，在这种传统中，从不进行显式类型检查，代码只是简单地调用对象上的方法，相信这些方法会存在，如果不存在则会引发异常。在检查 ABC 时要明智，并且只在绝对必要时才进行检查。

你可以通过在类定义中使用 abc.ABCMeta 作为元类来编写自己的 ABC:

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):
        ...

在上面的 Drawable ABC 中，draw_doubled() 方法以两倍大小渲染对象，并且可以依据 Drawable 中描述的其他方法来实现。因此，实现此 ABC 的类不需要提供自己的 draw_doubled() 实现，尽管它们可以这样做。但是必须实现 draw()；ABC 不能提供有用的通用实现。

你可以将 @abstractmethod 装饰器应用于必须实现的诸如 draw() 这样的方法；Python 将对未定义该方法的类引发异常。请注意，只有在实际尝试创建缺少该方法的子类实例时，才会引发异常:

>>> 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
>>>

可以使用 @abstractproperty 装饰器声明抽象数据属性:

from abc import abstractproperty
...

@abstractproperty
def readonly(self):
   return self._x

子类必须定义一个 readonly() 属性。

参见

PEP 3119 [https://www.python.org/dev/peps/pep-3119] - 引入抽象基类

PEP 由 Guido van Rossum 和 Talin 编写。由 Guido van Rossum 实现。由 Benjamin Aranguren 回退到 2.6 版本，Alex Martelli 协助。

PEP 3127: 整型文字支持和语法

Python 3.0 改变了八进制（基数为8）整数的语法，使用 "0o" 或 "0O" 作为前缀，而不是以零开头，并增加了对二进制（基数为2）整数的支持，使用 "0b" 或 "0B" 作为前缀。

Python 2.6 并没有放弃以零开头表示八进制数的支持，但增加了对 "0o" 和 "0b" 的支持:

>>> 0o21, 2*8 + 1
(17, 17)
>>> 0b101111
47

内置的 oct() 函数仍然返回以零开头的数字，而新的 bin() 函数返回数字的二进制表示:

>>> oct(42)
'052'
>>> future_builtins.oct(42)
'0o52'
>>> bin(173)
'0b10101101'

内置的 int() 和 long() 函数现在接受 "0o" 和 "0b" 前缀，当请求基数为8或2时，或者当 base 参数为零（表示应从字符串确定使用的基数）:

>>> int ('0o52', 0)
42
>>> int('1101', 2)
13
>>> int('0b1101', 2)
13
>>> int('0b1101', 0)
13

参见

PEP 3127 [https://www.python.org/dev/peps/pep-3127] - 整型文字支持和语法

PEP 由 Patrick Maupin 编写；由 Eric Smith 回退到 2.6 版本。

PEP 3129: 类装饰器

装饰器已从函数扩展到类。 现在可以合法地编写:

@foo
@bar
class A:
  pass

这相当于：

class A:
  pass

A = foo(bar(A))

参见

PEP 3129 [https://www.python.org/dev/peps/pep-3129] - 类装饰器

PEP 由 Collin Winter 撰写

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

Python 3.0 增加了几种受 Scheme 数值塔启发的数值类型的抽象基类。这些类已回退到 2.6 版本，作为 numbers 模块。

最通用的 ABC 是 Number。它定义了没有任何操作，仅用于通过 isinstance(obj, Number) 检查对象是否为数字。

Complex 是 Number 的子类。复数可以进行加法、减法、乘法、除法和指数运算，并且可以检索实部和虚部以及获得一个数的共轭。Python 内置的复数类型是 Complex 的实现。

Real 进一步从 Complex 派生，并添加了仅适用于实数的操作：floor()，trunc()，四舍五入，取模 N 的余数，地板除法以及比较操作。

Rational 数从 Real 派生，具有 numerator 和 denominator 属性，并且可以转换为浮点数。Python 2.6 在 fractions 模块中添加了一个简单的有理数类，Fraction。（它被称为 Fraction 而不是 Rational，以避免与 numbers.Rational 名称冲突。）

Integral 数从 Rational 派生，可以使用 << 和 >> 进行左右移位，通过按位操作（如 & 和 |）进行组合，并且可以用作数组索引和切片边界。

在 Python 3.0 中，PEP 稍微重新定义了现有的内置函数 round()，math.floor()，math.ceil()，并添加了一个新的函数 math.trunc()，该函数已被回移植到 Python 2.6。math.trunc() 向零舍入，返回介于函数参数和零之间的最接近的 Integral。

参见

PEP 3141 [https://www.python.org/dev/peps/pep-3141] - 数字的类型层次结构

PEP 由 Jeffrey Yasskin 撰写

Scheme 的数值塔 [https://www.gnu.org/software/guile/manual/html_node/Numerical-Tower.html#Numerical-Tower]，来自 Guile 手册。

Scheme's number datatypes [https://schemers.org/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2] from the R5RS Scheme specification.

fractions 模块

为了完善数值类型的层次结构，fractions 模块提供了一个有理数类。有理数将它们的值存储为一个分数的分子和分母，可以精确表示诸如 2/3 这样的数，而浮点数只能近似表示。

Fraction 构造函数接受两个 Integral 值，这两个值将分别是结果分数的分子和分母。

>>> 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)

For converting floating-point numbers to rationals, the float type now has an as_integer_ratio() method that returns the numerator and denominator for a fraction that evaluates to the same floating-point value:

>>> (2.5) .as_integer_ratio()
(5, 2)
>>> (3.1415) .as_integer_ratio()
(7074029114692207L, 2251799813685248L)
>>> (1./3) .as_integer_ratio()
(6004799503160661L, 18014398509481984L)

请注意，只能由浮点数近似表示的值，例如 1./3，不会被简化为被近似的数；分数尝试**精确**匹配浮点值。

fractions 模块基于 Sjoerd Mullender 的实现，该实现曾在 Python 的 Demo/classes/ 目录中存在很长时间。这一实现由 Jeffrey Yasskin 进行了显著更新。

其他语言特性修改

对Python 语言核心进行的小改动：

包含 __main__.py 文件的目录和 zip 存档现在可以通过将其名称传递给解释器来直接执行。目录或 zip 存档会自动插入到 sys.path 的第一个条目中。（建议和初始补丁由 Andy Chu 提出，随后由 Phillip J. Eby 和 Nick Coghlan 修订；bpo-1739468 [https://bugs.python.org/issue?@action=redirect&bpo=1739468]。）

hasattr() 函数在假设所有错误意味着 __getattr__() 方法以某种方式失败，并且 hasattr() 的返回值因此为 False 的情况下，会捕获并忽略所有错误。然而，这种逻辑不应适用于 KeyboardInterrupt 和 SystemExit；Python 2.6 在 hasattr() 遇到这些异常时将不再丢弃它们。（由 Benjamin Peterson 修复；bpo-2196 [https://bugs.python.org/issue?@action=redirect&bpo=2196]。）

当使用 ** 语法调用函数以提供关键字参数时，你不再需要使用 Python 字典；现在任何映射都将有效:

>>> def f(**kw):
...    print sorted(kw)
...
>>> ud=UserDict.UserDict()
>>> ud['a'] = 1
>>> ud['b'] = 'string'
>>> f(**ud)
['a', 'b']

（由 Alexander Belopolsky 在 bpo-1686487 [https://bugs.python.org/issue?@action=redirect&bpo=1686487] 中贡献。）

在函数调用的 *args 参数之后提供关键字参数也是合法的。

>>> def f(*args, **kw):
...     print args, kw
...
>>> f(1,2,3, *(4,5,6), keyword=13)
(1, 2, 3, 4, 5, 6) {'keyword': 13}

在之前版本中这会导致语法错误。 （由 Amaury Forgeot d'Arc 贡献；bpo-3473 [https://bugs.python.org/issue?@action=redirect&bpo=3473]。）

一个新的内置函数 next(iterator, [default]) 返回指定迭代器的下一个项目。如果提供了 default 参数，当 iterator 耗尽时会返回该值；否则，将引发 StopIteration 异常。（已在 bpo-2719 [https://bugs.python.org/issue?@action=redirect&bpo=2719] 中回溯。）

Tuples now have index() and count() methods matching the list type's index() and count() methods:

>>> t = (0,1,2,3,4,0,1,2)
>>> t.index(3)
3
>>> t.count(0)
2

（由 Raymond Hettinger 贡献）

内置类型现在改进了对扩展切片语法的支持，接受各种 (start, stop, step) 的组合。之前，支持是部分的，某些边缘情况无法工作。（由 Thomas Wouters 实现。）

属性现在有三个属性，getter、setter 和 deleter，这些是装饰器，提供了向现有属性添加获取器、设置器或删除器函数的有用快捷方式。你可以像这样使用它们:

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

内置集合类型的几种方法现在接受多个可迭代对象：intersection()、intersection_update()、union()、update()、difference() 和 difference_update()。

>>> s=set('1234567890')
>>> s.intersection('abc123', 'cdf246')  # Intersection between all inputs
set(['2'])
>>> s.difference('246', '789')
set(['1', '0', '3', '5'])

（由 Raymond Hettinger 贡献。）

添加了许多浮点特性。float() 函数现在会将字符串 nan 转换为 IEEE 754 非数值，将 +inf 和 -inf 转换为正无穷或负无穷。这适用于任何具有 IEEE 754 语义的平台。（由 Christian Heimes 贡献；bpo-1635 [https://bugs.python.org/issue?@action=redirect&bpo=1635]。）

math 模块中的其他函数，isinf() 和 isnan()，如果它们的浮点参数是无穷大或非数值，则返回真。（bpo-1640 [https://bugs.python.org/issue?@action=redirect&bpo=1640]）

添加了转换函数，用于将浮点数转换为十六进制字符串（bpo-3008 [https://bugs.python.org/issue?@action=redirect&bpo=3008]）。这些函数在将浮点数转换为字符串表示形式以及从字符串表示形式转换回浮点数时，不会引入十进制和二进制之间的转换误差。浮点数有一个 hex() 方法，返回其字符串表示形式，而 float.fromhex() 方法将字符串转换回数字：

>>> a = 3.75
>>> a.hex()
'0x1.e000000000000p+1'
>>> float.fromhex('0x1.e000000000000p+1')
3.75
>>> b=1./3
>>> b.hex()
'0x1.5555555555555p-2'

一个数值上的细节：在支持有符号零（-0 和 +0）的系统上，从两个浮点数创建复数时，complex() 构造函数现在将保留零的符号。（由 Mark T. Dickinson 修复；bpo-1507 [https://bugs.python.org/issue?@action=redirect&bpo=1507]。）

从父类继承 __hash__() 方法的类可以通过设置 __hash__ = None 来表示该类不可哈希。这将使 hash(obj) 抛出 TypeError，并且该类不会被视为实现了 Hashable ABC。

当你定义了 __cmp__() 或 __eq__() 方法，且这些方法通过值而不是身份比较对象时，应该这样做。所有对象都有一个默认的哈希方法，使用 id(obj) 作为哈希值。没有简洁的方法来移除从父类继承的 __hash__() 方法，因此将 None 赋值作为覆盖实现。在 C 语言层面，扩展可以将 tp_hash 设置为 PyObject_HashNotImplemented()。（由 Nick Coghlan 和 Amaury Forgeot d'Arc 修复；bpo-2235 [https://bugs.python.org/issue?@action=redirect&bpo=2235]。）

GeneratorExit 异常现在继承自 BaseException 而不是 Exception。这意味着 except Exception: 的异常处理程序不会意外捕获 GeneratorExit。（由 Chad Austin 贡献；bpo-1537 [https://bugs.python.org/issue?@action=redirect&bpo=1537]。）

生成器对象现在具有一个 gi_code 属性，该属性引用支持生成器的原始代码对象。（由 Collin Winter 贡献；bpo-1473257 [https://bugs.python.org/issue?@action=redirect&bpo=1473257]。）

compile() 内置函数现在接受关键字参数以及位置参数。（由 Thomas Wouters 贡献；bpo-1444529 [https://bugs.python.org/issue?@action=redirect&bpo=1444529]。）

complex() 构造函数现在接受包含括号内复数的字符串，这意味着 complex(repr(cplx)) 现在将进行往返值。例如，complex('(3+4j)') 现在返回值 (3+4j)。（bpo-1491866 [https://bugs.python.org/issue?@action=redirect&bpo=1491866]）

字符串 translate() 方法现在接受 None 作为翻译表参数，这被视为身份转换。这使得仅删除字符的操作更容易进行。（由 Bengt Richter 贡献并由 Raymond Hettinger 实现；bpo-1193128 [https://bugs.python.org/issue?@action=redirect&bpo=1193128]。）

内置的 dir() 函数现在检查其接收对象上的 __dir__() 方法。该方法必须返回包含对象有效属性名称的字符串列表，并让对象控制 dir() 产生的值。具有 __getattr__() 或 __getattribute__() 方法的对象可以使用此方法来宣传它们将支持的伪属性。（bpo-1591665 [https://bugs.python.org/issue?@action=redirect&bpo=1591665]）

Instance method objects have new attributes for the object and function comprising the method; the new synonym for im_self is __self__, and im_func is also available as __func__. The old names are still supported in Python 2.6, but are gone in 3.0.

一个不为人知的变化：当你在 class 语句内使用 locals() 函数时，生成的字典不再返回自由变量。（在这种情况下，自由变量是指在 class 语句中引用的但不是类属性的变量。）

性能优化

warnings 模块已用 C 语言重写。这使得从解析器中调用警告成为可能，也可能使解释器的启动更快。（由 Neal Norwitz 和 Brett Cannon 贡献；bpo-1631171 [https://bugs.python.org/issue?@action=redirect&bpo=1631171]。）

类型对象现在有一个方法缓存，可以减少查找特定类的正确方法实现所需的工作；一旦缓存，解释器无需遍历基类来确定要调用的正确方法。如果基类或类本身被修改，缓存将被清除，因此即使在 Python 的动态特性面前，缓存也应保持正确。（最初的优化由 Armin Rigo 实现，由 Kevin Jacobs 更新以适用于 Python 2.6；bpo-1700288 [https://bugs.python.org/issue?@action=redirect&bpo=1700288]。）

默认情况下，此更改仅应用于包含在 Python 核心中的类型。扩展模块可能不兼容此缓存，因此它们必须显式将 Py_TPFLAGS_HAVE_VERSION_TAG 添加到模块的 tp_flags 字段以启用方法缓存。（为了与方法缓存兼容，扩展模块的代码不得直接访问和修改其实现的任何类型的 tp_dict 成员。大多数模块不会这样做，但 Python 解释器无法确定这一点。参见 bpo-1878 [https://bugs.python.org/issue?@action=redirect&bpo=1878] 以了解一些讨论。）

使用关键字参数的函数调用通过进行快速指针比较而显著加快，通常节省了完整字符串比较的时间。（由 Raymond Hettinger 贡献，基于 Antoine Pitrou 的初始实现；bpo-1819 [https://bugs.python.org/issue?@action=redirect&bpo=1819]。）

由于在 Need For Speed sprint 中的工作，struct 模块中的所有函数都已用 C 语言重写。（由 Raymond Hettinger 贡献。）

一些标准内置类型现在在其类型对象中设置了一个位。这加快了检查对象是否为这些类型的子类的速度。（由 Neal Norwitz 贡献。）

Unicode 字符串现在使用更快的代码来检测空白字符和换行符；这使得 split() 方法的速度提高了约 25%，splitlines() 方法的速度提高了约 35%。(由 Antoine Pitrou 贡献。) 通过使用 pymalloc 为 Unicode 字符串的数据分配内存，减少了内存使用。

The with statement now stores the __exit__() method on the stack, producing a small speedup. (Implemented by Jeffrey Yasskin.)

为了减少内存使用，垃圾收集器现在在收集最高代对象的垃圾时将清除内部空闲列表。这可能会更快地将内存返回给操作系统。

解释器改动

有两个命令行选项被保留给其他 Python 实现来使用。 -J 开关被保留给 Jython 用于 Jython 专属的选项，如传递给底层 JVM 的开关。 -X 被保留用于特定 Python 实现如 CPython, Jython 或 IronPython 专属的选项。 如果其中某个选项被用于 Python 2.6，解释器将报告该选项当前未被使用。

现在可以通过向 Python 解释器提供 -B 开关，或在运行解释器之前设置 PYTHONDONTWRITEBYTECODE 环境变量，来阻止 Python 写入 .pyc 或 .pyo 文件。此设置作为 sys.dont_write_bytecode 变量对 Python 程序可用，Python 代码可以更改该值以修改解释器的行为。(由 Neal Norwitz 和 Georg Brandl 贡献)

可以通过在运行解释器之前设置 PYTHONIOENCODING 环境变量来指定标准输入、输出和标准错误的编码。值应为形如 <编码> 或 <编码>:<错误处理器> 的字符串。编码 部分指定编码的名称，例如 utf-8 或 latin-1；可选的 错误处理器 部分指定对无法由编码处理的字符的处理方式，应为 "error"、"ignore" 或 "replace" 之一。（由 Martin von Löwis 贡献。）

新增和改进的模块

与每个版本一样，Python 的标准库收到了许多增强和 bug 修复。以下是一些最显著变化的的部分列表，按模块名称字母顺序排序。查阅源树中的 Misc/NEWS 文件以获取更完整的变化列表，或通过 Subversion 日志查看所有详细信息。

The asyncore and asynchat modules are being actively maintained again, and a number of patches and bugfixes were applied. (Maintained by Josiah Carlson; see bpo-1736190 [https://bugs.python.org/issue?@action=redirect&bpo=1736190] for one patch.)

bsddb 模块也有了新的维护者 Jesús Cea Avión，该包现在可作为独立包使用。该包的网页为 www.jcea.es/programacion/pybsddb.htm [https://www.jcea.es/programacion/pybsddb.htm]。计划在 Python 3.0 中从标准库中移除该包，因为其发布频率远高于 Python。

bsddb.dbshelve 模块现在使用最高可用的序列化协议，而不是限制自己使用协议 1。（由 W. Barnes 贡献。）

The cgi module will now read variables from the query string of an HTTP POST request. This makes it possible to use form actions with URLs that include query strings such as "/cgi-bin/add.py?category=1". (Contributed by Alexandre Fiori and Nubis; bpo-1817 [https://bugs.python.org/issue?@action=redirect&bpo=1817].)

The parse_qs() and parse_qsl() functions have been relocated from the cgi module to the urlparse module. The versions still available in the cgi module will trigger PendingDeprecationWarning messages in 2.6 (bpo-600362 [https://bugs.python.org/issue?@action=redirect&bpo=600362]).

cmath 模块经历了广泛的修订，由 Mark Dickinson 和 Christian Heimes 贡献。新增了五个函数：

polar() 将复数转换为极坐标形式，返回复数的模和辐角。

rect() 执行相反的操作，将模和辐角对转换回相应的复数。

phase() 返回复数的辐角（也称为角度）。

isnan() 如果其参数的实部或虚部为 NaN，则返回 True。

isinf() 如果其参数的实部或虚部为无穷大，则返回 True。

这些修订还提高了 cmath 模块的数值稳定性。对于所有函数，结果的实部和虚部在可能的情况下都精确到几个最小精度单位（ulps）。详情请见 bpo-1381 [https://bugs.python.org/issue?@action=redirect&bpo=1381]。asinh()、atanh() 和 atan() 的分支切割也已修正。

该模块的测试已大幅扩展；近 2000 个新测试用例对代数函数进行了测试。

在 IEEE 754 平台上，cmath 模块现在以符合 C99 标准附录 'G' 的方式处理 IEEE 754 特殊值和浮点异常。

A new data type in the collections module: namedtuple(typename, fieldnames) is a factory function that creates subclasses of the standard tuple whose fields are accessible by name as well as index. For example:

>>> var_type = collections.namedtuple('variable',
...             'id name type size')
>>> # Names are separated by spaces or commas.
>>> # 'id, name, type, size' would also work.
>>> var_type._fields
('id', 'name', 'type', 'size')

>>> var = var_type(1, 'frequency', 'int', 4)
>>> print var[0], var.id    # Equivalent
1 1
>>> print var[2], var.type  # Equivalent
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)

Several places in the standard library that returned tuples have been modified to return namedtuple instances. For example, the Decimal.as_tuple() method now returns a named tuple with sign, digits, and exponent fields.

（由 Raymond Hettinger 贡献。）

collections 模块的另一个变化是 deque 类型现在支持可选的 maxlen 参数；如果提供，deque 的大小将被限制为不超过 maxlen 项。向已满的 deque 添加更多项会导致旧项被丢弃。

>>> 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)

（由 Raymond Hettinger 贡献。）

The Cookie module's Morsel objects now support an httponly attribute. In some browsers. cookies with this attribute set cannot be accessed or manipulated by JavaScript code. (Contributed by Arvin Schnell; bpo-1638033 [https://bugs.python.org/issue?@action=redirect&bpo=1638033].)

curses 模块中的一个新窗口方法 chgat()，用于更改单行上一定数量字符的显示属性。（由 Fabian Kreutz 贡献。）

# Boldface text starting at y=0,x=21
# and affecting the rest of the line.
stdscr.chgat(0, 21, curses.A_BOLD)

curses.textpad 模块中的 Textbox 类现在支持在插入模式和覆盖模式下编辑。通过在创建 Textbox 实例时为 insert_mode 参数提供真值来启用插入模式。

datetime 模块的 strftime() 方法现在支持 %f 格式代码，该代码扩展为对象中的微秒数，左侧用零填充至六位。 (由 Skip Montanaro 贡献; bpo-1158 [https://bugs.python.org/issue?@action=redirect&bpo=1158].)

decimal 模块已更新至 通用小数规范 [https://speleotrove.com/decimal/decarith.html] 的 1.66 版本。新特性包括一些基本数学函数的方法，例如 exp() 和 log10():

>>> Decimal(1).exp()
Decimal("2.718281828459045235360287471")
>>> Decimal("2.7182818").ln()
Decimal("0.9999999895305022877376682436")
>>> Decimal(1000).log10()
Decimal("3")

现在 Decimal 对象的 as_tuple() 方法将返回一个由 sign, digits 和 exponent 字段组成的具名元组。

（由 Facundo Batista 和 Mark Dickinson 实现。 具名元组支持由 Raymond Hettinger 添加。）

现在 difflib 模块的 SequenceMatcher 类将返回代表匹配结果的具名元组，包含 a, b 和 size 等属性。 （由 Raymond Hettinger 贡献。）

在 ftplib.FTP 类构造函数以及 connect() 方法中添加了一个可选的 timeout 参数，用于指定以秒为单位的超时时间。 (由 Facundo Batista 添加。)此外，FTP 类的 storbinary() 和 storlines() 方法现在接受一个可选的 callback 参数，该参数在数据发送后会对每个数据块进行调用。 (由 Phil Schwartz 贡献; bpo-1221598 [https://bugs.python.org/issue?@action=redirect&bpo=1221598].)

内置函数 reduce() 也在 functools 模块中提供。在 Python 3.0 中，内置函数已被移除，reduce() 只能从 functools 中获取；目前没有计划在 2.x 系列中移除该内置函数。 (由 Christian Heimes 修复; bpo-1739906 [https://bugs.python.org/issue?@action=redirect&bpo=1739906].)

在可能的情况下，getpass 模块现在将使用 /dev/tty 来打印提示信息并读取密码，如果无法使用则回退到标准错误和标准输入。如果密码可能在终端上回显，则在显示提示之前会打印一条警告信息。 (由 Gregory P. Smith 贡献)

glob.glob() 函数现在可以在使用 Unicode 路径并在目录中匹配到 Unicode 文件名时返回 Unicode 文件名。 (bpo-1001604 [https://bugs.python.org/issue?@action=redirect&bpo=1001604])

heapq 模块中的新函数 merge(iter1, iter2, ...) 接受任意数量的返回已排序数据的可迭代对象，并返回一个新的生成器，该生成器返回所有迭代器的内容，同样按顺序排序。例如:

>>> list(heapq.merge([1, 3, 5, 9], [2, 8, 16]))
[1, 2, 3, 5, 8, 9, 16]

另一个新函数，heappushpop(heap, item)，将 item 推入 heap，然后弹出并返回最小的元素。这比先调用 heappush() 再调用 heappop() 更高效。

heapq 现在实现为仅使用小于比较，而不是之前使用的小于或等于比较。这使得 heapq 对类型的用法与 list.sort() 方法一致。（由 Raymond Hettinger 贡献。）

An optional timeout parameter, specifying a timeout measured in seconds, was added to the httplib.HTTPConnection and HTTPSConnection class constructors. (Added by Facundo Batista.)

大多数 inspect 模块的函数，如 getmoduleinfo() 和 getargs()，现在返回命名元组。除了像元组一样行为，返回值的元素也可以作为属性访问。（由 Raymond Hettinger 贡献。）

此模块中的新增函数包括 isgenerator(), isgeneratorfunction() 和 isabstract()。

itertools 模块增加了几个新函数。

izip_longest(iter1, iter2, ...[, fillvalue]) 将基于每个元素创建元组；如果某些可迭代对象长度小于其他的，缺失的值将被设为 fillvalue。 例如:

>>> tuple(itertools.izip_longest([1,2,3], [1,2,3,4,5]))
((1, 1), (2, 2), (3, 3), (None, 4), (None, 5))

product(iter1, iter2, ..., [repeat=N]) 将返回所提供可迭代对象的笛卡尔积，即包含从每个可迭代对象返回的元素的每种可能组合的元组的集合。:

>>> 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)]

可选的*repeat*关键字参数用于计算一个可迭代对象或一组可迭代对象与其自身重复*N*次后的乘积。对于单个可迭代对象参数，返回*N*-元组:

>>> 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)]

对于两个可迭代对象，返回*2N*-元组。:

>>> 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)]

combinations(iterable, r) 基于 iterable 的元素返回长度为 r 的子序列。

>>> 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')]

permutations(iter[, r]) 返回可迭代对象元素长度为 r 的所有排列。如果未指定 r，则默认为可迭代对象产生的元素数量。:

>>> 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)]

itertools.chain(*iterables) 是 itertools 模块中已有的一个函数，在 Python 2.6 中新增了一个构造器。itertools.chain.from_iterable(iterable) 接受一个应返回其他可迭代对象的单一可迭代对象。chain() 将依次返回第一个可迭代对象的所有元素，然后是第二个可迭代对象的所有元素，依此类推。:

>>> list(itertools.chain.from_iterable([[1,2,3], [4,5,6]]))
[1, 2, 3, 4, 5, 6]

（全部由 Raymond Hettinger 贡献。）

logging 模块的 FileHandler 类及其子类 WatchedFileHandler、RotatingFileHandler 和 TimedRotatingFileHandler 现在在其构造器中有一个可选的 delay 参数。如果 delay 为真，日志文件的打开将被延迟，直到第一次调用 emit()。 (由 Vinay Sajip 贡献)

TimedRotatingFileHandler 还有一个 utc 构造器参数。如果该参数为真，将使用 UTC 时间来确定午夜时刻和生成文件名；否则将使用本地时间。

为 math 模块添加了一些新函数:

isinf() 和 isnan() 分别用于判断给定浮点数是否为（正或负）无穷大或 NaN（非数字）。

copysign() 复制 IEEE 754 数的符号位，返回 x 的绝对值与 y 的符号位组合的结果。例如，math.copysign(1, -0.0) 返回 -1.0。 (由 Christian Heimes 贡献)

factorial() 计算一个数的阶乘。 (由 Raymond Hettinger 贡献；bpo-2138 [https://bugs.python.org/issue?@action=redirect&bpo=2138])

fsum() 将可迭代对象中的数字流相加，并小心避免通过使用部分和来损失精度。 (由 Jean Brouwers、Raymond Hettinger 和 Mark Dickinson 贡献；bpo-2819 [https://bugs.python.org/issue?@action=redirect&bpo=2819])

acosh()、asinh() 和 atanh() 计算反双曲函数。

log1p() 返回 1+x (以 e 为底) 的自然对数。

trunc() 将数字四舍五入至零，返回介于函数参数和零之间的最接近的 Integral。作为 PEP 3141 数字类型层次结构 的回退部分添加。

math 模块已改进，以在不同平台上提供更一致的行为，特别是在处理浮点异常和 IEEE 754 特殊值方面。

在可能的情况下，该模块遵循 C99 标准关于 754 特殊值的建议。例如，sqrt(-1.) 现在应在几乎所有平台上引发 ValueError，而 sqrt(float('NaN')) 应在所有 IEEE 754 平台上返回 NaN。在 C99 标准附件 'F' 建议发出 '除以零' 或 '无效' 信号的地方，Python 将引发 ValueError。在 C99 标准附件 'F' 建议发出 '溢出' 信号的地方，Python 将引发 OverflowError。（参见 bpo-711019 [https://bugs.python.org/issue?@action=redirect&bpo=711019] 和 bpo-1640 [https://bugs.python.org/issue?@action=redirect&bpo=1640]。）

（由 Christian Heimes 和 Mark Dickinson 贡献。）

mmap 对象现在有一个 rfind() 方法，从字符串末尾开始向后搜索子字符串。find() 方法还增加了一个 end 参数，用于指定停止搜索的索引。（由 John Lenton 贡献。）

operator 模块增加了一个 methodcaller() 函数，它接受一个名称和一组可选的参数，返回一个可调用的对象，该对象将对传递给它的任何参数调用指定的函数。例如：

>>> # Equivalent to lambda s: s.replace('old', 'new')
>>> replacer = operator.methodcaller('replace', 'old', 'new')
>>> replacer('old wine in old bottles')
'new wine in new bottles'

（由 Gregory Petrosyan 提供建议，之后由 Georg Brandl 贡献。）

现在 attrgetter() 函数可接受带点号的名称并执行相应的属性查找:

>>> inst_name = operator.attrgetter(
...        '__class__.__name__')
>>> inst_name('')
'str'
>>> inst_name(help)
'_Helper'

（由 Barry Warsaw 提供建议，之后由 Georg Brandl 贡献。）

os 模块现在包装了几个新的系统调用。fchmod(fd, mode) 和 fchown(fd, uid, gid) 更改已打开文件的模式和所有权，lchmod(path, mode) 更改符号链接的模式。（由 Georg Brandl 和 Christian Heimes 贡献。）

chflags() 和 lchflags() 是对应系统调用（在可用的情况下）的封装，用于更改文件上的标志。标志值的常量在 stat 模块中定义；一些可能的值包括 UF_IMMUTABLE 表示文件不可更改，以及 UF_APPEND 表示数据只能追加到文件中。（由 M. Levinson 贡献。）

os.closerange(low, high) 高效地关闭从 low 到 high 的所有文件描述符，忽略任何错误，并且不包括 high 本身。此函数现在被 subprocess 模块使用，以加快启动进程的速度。（由 Georg Brandl 贡献；bpo-1663329 [https://bugs.python.org/issue?@action=redirect&bpo=1663329]。）

os.environ 对象的 clear() 方法现在除了清除对象的键之外，还会使用 os.unsetenv() 来取消设置环境变量。（由 Martin Horcicka 贡献；bpo-1181 [https://bugs.python.org/issue?@action=redirect&bpo=1181]。）

os.walk() 函数现在有一个 followlinks 参数。如果设置为 True，它将跟随指向目录的符号链接并访问目录的内容。为了向后兼容，该参数的默认值为 false。请注意，如果存在指向父目录的符号链接，该函数可能会陷入无限递归。（bpo-1273829 [https://bugs.python.org/issue?@action=redirect&bpo=1273829]）

在 os.path 模块中，splitext() 函数已更改，不再在开头的句点字符处分割。这在处理 Unix 的点文件时会产生更好的结果。例如，os.path.splitext('.ipython') 现在返回 ('.ipython', '') 而不是 ('', '.ipython')。（bpo-1115886 [https://bugs.python.org/issue?@action=redirect&bpo=1115886]）

一个新的函数，os.path.relpath(path, start='.')，返回从 start 路径（如果提供）或从当前工作目录到目标 path 的相对路径。（由 Richard Barran 贡献；bpo-1339796 [https://bugs.python.org/issue?@action=redirect&bpo=1339796]。）

在Windows上，os.path.expandvars() 现在可以展开形如 "%var%" 的环境变量，并且 "~user" 将被展开为用户的主目录路径。（由 Josiah Carlson 贡献；bpo-957650 [https://bugs.python.org/issue?@action=redirect&bpo=957650]。）

pdb 模块提供的 Python 调试器新增了一个命令："run" 可以重新启动正在调试的 Python 程序，并且可以可选地接受新的命令行参数。（由 Rocky Bernstein 贡献；bpo-1393667 [https://bugs.python.org/issue?@action=redirect&bpo=1393667]。）

用于开始调试回溯的 pdb.post_mortem() 函数，现在如果没有提供回溯，将使用 sys.exc_info() 返回的回溯。（由 Facundo Batista 贡献；bpo-1106316 [https://bugs.python.org/issue?@action=redirect&bpo=1106316]。）

pickletools 模块现在有一个 optimize() 函数，它接受一个包含 pickle 的字符串，并移除一些未使用的操作码，返回一个包含相同数据结构的更短的 pickle。（由 Raymond Hettinger 贡献。）

在 pkgutil 模块中添加了一个 get_data() 函数，它返回随安装的 Python 包一起包含的资源文件的内容。例如：

>>> import pkgutil
>>> print pkgutil.get_data('test', 'exception_hierarchy.txt')
BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration
      +-- StandardError
 ...

（由 Paul Moore 在 bpo-2439 [https://bugs.python.org/issue?@action=redirect&bpo=2439] 中贡献。）

pyexpat 模块的 Parser 对象现在允许设置它们的 buffer_size 属性，以改变用于保存字符数据的缓冲区大小。（由 Achim Gaedke 贡献；bpo-1137 [https://bugs.python.org/issue?@action=redirect&bpo=1137]。）

Queue 模块现在提供了不同顺序检索条目的队列变体。PriorityQueue 类将排队项存储在堆中并按优先级顺序检索它们，而 LifoQueue 首先检索最近添加的条目，这意味着它表现得像一个栈。（由 Raymond Hettinger 贡献。）

random 模块的 Random 对象现在可以在32位系统上被序列化，并在64位系统上反序列化，反之亦然。不幸的是，这一变化也意味着 Python 2.6 的 Random 对象无法在早期版本的 Python 上正确反序列化。（由 Shawn Ligocki 贡献；bpo-1727780 [https://bugs.python.org/issue?@action=redirect&bpo=1727780]。）

新的 triangular(low, high, mode) 函数返回遵循三角分布的随机数。返回值介于 low 和 high 之间，不包括 high 本身，且 mode 为分布中最频繁出现的值。（由 Wladmir van der Laan 和 Raymond Hettinger 贡献；bpo-1681432 [https://bugs.python.org/issue?@action=redirect&bpo=1681432]。）

re 模块执行的长正则表达式搜索将检查是否有信号传递，因此耗时搜索现在可以被中断。（由 Josh Hoyt 和 Ralf Schmitt 贡献；bpo-846388 [https://bugs.python.org/issue?@action=redirect&bpo=846388]。）

正则表达式模块通过为一个小型正则表达式专用虚拟机编译字节码来实现。未受信任的代码可能直接创建恶意的字节码字符串并导致崩溃，因此 Python 2.6 包含了一个用于验证正则表达式字节码的验证器。（由 Guido van Rossum 基于为 Google App Engine 的工作贡献；bpo-3487 [https://bugs.python.org/issue?@action=redirect&bpo=3487]。）

The rlcompleter module's Completer.complete() method will now ignore exceptions triggered while evaluating a name. (Fixed by Lorenz Quack; bpo-2250 [https://bugs.python.org/issue?@action=redirect&bpo=2250].)

sched 模块的 scheduler 实例现在有一个只读的 queue 属性，返回调度器队列的内容，表示为一个命名元组列表，字段为 (time, priority, action, argument)。（由 Raymond Hettinger 贡献；bpo-1861 [https://bugs.python.org/issue?@action=redirect&bpo=1861]。）

The select module now has wrapper functions for the Linux epoll() and BSD kqueue() system calls. modify() method was added to the existing poll objects; pollobj.modify(fd, eventmask) takes a file descriptor or file object and an event mask, modifying the recorded event mask for that file. (Contributed by Christian Heimes; bpo-1657 [https://bugs.python.org/issue?@action=redirect&bpo=1657].)

函数 shutil.copytree() 现在有一个可选的 ignore 参数，该参数接收一个可调用对象。这个可调用对象将接收每个目录路径和目录内容的列表，并返回一个将被忽略、不进行复制的名称列表。

模块 shutil 还提供了一个 ignore_patterns() 函数，用于与这个新参数一起使用。ignore_patterns() 接收任意数量的 glob-style 模式，并返回一个可调用对象，该对象将忽略匹配这些模式中的任何一个的文件和目录。以下示例复制一个目录树，但跳过 .svn 目录和以 '~' 结尾的 Emacs 备份文件：

shutil.copytree('Doc/library', '/tmp/library',
                ignore=shutil.ignore_patterns('*~', '.svn'))

（由 Tarek Ziadé 在 bpo-2663 [https://bugs.python.org/issue?@action=redirect&bpo=2663] 中贡献。）

将信号处理与 Tkinter 或 GTk+ 使用的 GUI 事件循环集成长期以来一直是一个问题；大多数软件最终采用轮询方式，每隔一小段时间唤醒一次以检查是否有任何 GUI 事件发生。模块 signal 现在可以使这更高效。调用 signal.set_wakeup_fd(fd) 设置一个文件描述符；当接收到信号时，向该文件描述符写入一个字节。还有一个 C 级函数 PySignal_SetWakeupFd()，用于设置描述符。

Event loops will use this by opening a pipe to create two descriptors, one for reading and one for writing. The writable descriptor will be passed to set_wakeup_fd(), and the readable descriptor will be added to the list of descriptors monitored by the event loop via select() or poll(). On receiving a signal, a byte will be written and the main event loop will be woken up, avoiding the need to poll.

（由 Adam Olsen 在 bpo-1583 [https://bugs.python.org/issue?@action=redirect&bpo=1583] 中贡献。）

siginterrupt() 函数现在可以从 Python 代码中使用，允许更改信号是否可以中断系统调用。（由 Ralf Schmitt 贡献。）

还添加了 setitimer() 和 getitimer() 函数（在可用的情况下）。setitimer() 允许设置间隔定时器，该定时器将在指定时间后向进程发送信号，时间测量可以是墙钟时间、消耗的进程时间或进程+系统时间之和。（由 Guilherme Polo 贡献；bpo-2240 [https://bugs.python.org/issue?@action=redirect&bpo=2240]。）

smtplib 模块现在支持通过 SSL 的 SMTP，这得益于 SMTP_SSL 类的添加。这个类支持与现有 SMTP 类相同的接口。（由 Monty Taylor 贡献。）这两个类构造函数还有一个可选的 timeout 参数，用于指定初始连接尝试的超时时间，以秒为单位。（由 Facundo Batista 贡献。）

模块中还添加了 LMTP 协议（RFC 2033 [https://datatracker.ietf.org/doc/html/rfc2033.html]）的实现。当在不需要管理邮件队列的代理之间传输电子邮件时，使用 LMTP 代替 SMTP。（LMTP 由 Leif Hedstrom 实现；bpo-957003 [https://bugs.python.org/issue?@action=redirect&bpo=957003]。）

SMTP.starttls() 现在符合 RFC 3207 [https://datatracker.ietf.org/doc/html/rfc3207.html] 标准，并忘记从服务器获得的任何非 TLS 协商本身获得的知识。（补丁由 Bill Fenner 贡献；bpo-829951 [https://bugs.python.org/issue?@action=redirect&bpo=829951]。）

The socket module now supports TIPC (http://tipc.sourceforge.net/), a high-performance non-IP-based protocol designed for use in clustered environments. TIPC addresses are 4- or 5-tuples. (Contributed by Alberto Bertogli; bpo-1646 [https://bugs.python.org/issue?@action=redirect&bpo=1646].)

新函数 create_connection() 接收一个地址并使用可选的超时值进行连接，返回已连接的套接字对象。此函数还会查找地址的类型，并使用 IPv4 或 IPv6 适当地进行连接。将代码改为使用 create_connection() 而不是 socket(socket.AF_INET, ...) 可能是使代码支持 IPv6 所需的全部工作。

The base classes in the SocketServer module now support calling a handle_timeout() method after a span of inactivity specified by the server's timeout attribute. (Contributed by Michael Pomraning.) The serve_forever() method now takes an optional poll interval measured in seconds, controlling how often the server will check for a shutdown request. (Contributed by Pedro Werneck and Jeffrey Yasskin; bpo-742598 [https://bugs.python.org/issue?@action=redirect&bpo=742598], bpo-1193577 [https://bugs.python.org/issue?@action=redirect&bpo=1193577].)

由 Gerhard Häring 维护的 sqlite3 模块已从 Python 2.5 中的版本 2.3.2 更新到版本 2.4.1。

struct 模块现在支持 C99 的 _Bool 类型，使用格式字符 '?'。（由 David Remahl 贡献。）

The Popen objects provided by the subprocess module now have terminate(), kill(), and send_signal() methods. On Windows, send_signal() only supports the SIGTERM signal, and all these methods are aliases for the Win32 API function TerminateProcess(). (Contributed by Christian Heimes.)

在 sys 模块中新增了一个变量 float_info，它是一个包含从 float.h 文件中获取的关于平台浮点支持信息的对象。该对象的属性包括 mant_dig (尾数的位数) 、epsilon (1.0 与下一个可表示的最大值之间的最小差值) 以及其他几个属性。（由 Christian Heimes 贡献；bpo-1534 [https://bugs.python.org/issue?@action=redirect&bpo=1534]。）

另一个新变量 dont_write_bytecode 控制着 Python 在导入模块时是否写入任何 .pyc 或 .pyo 文件。如果该变量为真，则不写入编译文件。该变量在启动时通过向 Python 解释器提供 -B 开关或通过在运行解释器之前设置 PYTHONDONTWRITEBYTECODE 环境变量来初始设置。Python 代码随后可以更改此变量的值，以控制是否写入字节码文件。（由 Neal Norwitz 和 Georg Brandl 贡献。）

通过读取名为 sys.flags 的命名元组的属性，可以获取提供给 Python 解释器的命令行参数信息。例如，如果 Python 以详细模式执行，则 verbose 属性为真，debug 在调试模式下为真，等等。这些属性都是只读的。（由 Christian Heimes 贡献。）

新增了一个函数 getsizeof()，它接受一个 Python 对象并返回该对象使用的内存量，以字节为单位。内置对象返回正确结果；第三方扩展可能不会，但可以定义一个 __sizeof__() 方法来返回对象的大小。（由 Robert Schuppenies 贡献；bpo-2898 [https://bugs.python.org/issue?@action=redirect&bpo=2898]。）

现在可以通过调用 sys.getprofile() 和 sys.gettrace() 来确定当前的剖析器和跟踪器函数。（由 Georg Brandl 贡献；bpo-1648 [https://bugs.python.org/issue?@action=redirect&bpo=1648]。）

模块 tarfile 现在除了已支持的 POSIX.1-1988 (ustar) 和 GNU tar 格式外，还支持 POSIX.1-2001 (pax) tar文件。默认格式为 GNU tar；可以通过指定 format 参数来使用不同的格式打开文件:

tar = tarfile.open("output.tar", "w",
                   format=tarfile.PAX_FORMAT)

新的 encoding 和 errors 参数用于指定字符转换的编码和错误处理方案。'strict'、'ignore' 和 'replace' 是 Python 处理错误的三个标准方式；'utf-8' 是一个特殊值，它会将错误的字符替换为它们的 UTF-8 表示形式。（字符转换是因为 PAX 格式支持 Unicode 文件名，默认使用 UTF-8 编码。）

方法 TarFile.add() 现在接受一个 exclude 参数，该参数是一个函数，用于排除某些文件名不存入归档。该函数必须接受一个文件名，并在文件应被排除时返回 true，在文件应被归档时返回 false。该函数应用于最初传递给 add() 的名称以及递归添加的目录中的文件名。

（所有改变均由 Lars Gustäbel 贡献）。

为 telnetlib.Telnet 类构造器增加了可选的 timeout 形参，指定以秒为单位的超时设置。 （由 Facundo Batista 添加。）

类 tempfile.NamedTemporaryFile 通常在文件关闭时删除其创建的临时文件。现在可以通过向构造函数传递 delete=False 来改变此行为。（由 Damien Miller 贡献；bpo-1537850 [https://bugs.python.org/issue?@action=redirect&bpo=1537850]。）

新增类 SpooledTemporaryFile，其行为类似于临时文件，但会在内存中存储数据，直到超过最大大小。达到该限制后，内容将被写入磁盘上的临时文件。（由 Dustin J. Mitchell 贡献。）

NamedTemporaryFile 和 SpooledTemporaryFile 类都可作为上下文管理器使用，因此你可以编写 with tempfile.NamedTemporaryFile() as tmp: ...。 (由 Alexander Belopolsky 贡献; bpo-2021 [https://bugs.python.org/issue?@action=redirect&bpo=2021].)

The test.test_support module gained a number of context managers useful for writing tests. EnvironmentVarGuard() is a context manager that temporarily changes environment variables and automatically restores them to their old values.

另一个上下文管理器 TransientResource 可以围绕对可能可用或不可用的资源的调用；它将捕获并忽略指定的异常列表。例如，网络测试在连接到外部网站时可能会忽略某些失败情况:

with test_support.TransientResource(IOError,
                                errno=errno.ETIMEDOUT):
    f = urllib.urlopen('https://sf.net')
    ...

最后，check_warnings() 重置 warning 模块的警告过滤器，并返回一个将记录所有触发的警告消息的对象 (bpo-3781 [https://bugs.python.org/issue?@action=redirect&bpo=3781]):

with test_support.check_warnings() as wrec:
    warnings.simplefilter("always")
    # ... code that triggers a warning ...
    assert str(wrec.message) == "function is outdated"
    assert len(wrec.warnings) == 1, "Multiple warnings raised"

（由 Brett Cannon 贡献。）

textwrap 模块现在可以通过指定 drop_whitespace=False 作为参数来保留新创建行首尾的现有空白:

>>> 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.
>>>

（由 Dwayne Bailey 在 bpo-1581073 [https://bugs.python.org/issue?@action=redirect&bpo=1581073] 中贡献。）

模块 threading 的 API 正在被修改，以使用属性如 daemon 而不是 setDaemon() 和 isDaemon() 方法，并且一些方法已被重命名，使用下划线而不是驼峰命名法；例如，activeCount() 方法被重命名为 active_count()。模块的 2.6 和 3.0 版本都支持相同的属性和重命名的方法，但不删除旧方法。Python 3.x 中旧 API 的弃用日期尚未确定；旧 API 不会在任何 2.x 版本中被移除。（由多人执行，最著名的是 Benjamin Peterson。）

模块 threading 的 Thread 对象获得了一个 ident 属性，该属性返回线程的标识符，一个非零整数。（由 Gregory P. Smith 贡献；bpo-2871 [https://bugs.python.org/issue?@action=redirect&bpo=2871]。）

模块 timeit 现在接受可调用对象以及字符串作为被计时的语句和设置代码。添加了两个便捷函数用于创建 Timer 实例：repeat(stmt, setup, time, repeat, number) 和 timeit(stmt, setup, time, number) 创建一个实例并调用相应的方法。（由 Erik Demaine 贡献；bpo-1533909 [https://bugs.python.org/issue?@action=redirect&bpo=1533909]。）

模块 Tkinter 现在接受列表和元组作为选项，在将结果值传递给 Tcl/Tk 之前用空格分隔元素。（由 Guilherme Polo 贡献；bpo-2906 [https://bugs.python.org/issue?@action=redirect&bpo=2906]。）

模块 turtle 用于海龟图形，由 Gregor Lingl 大大增强。模块中的新功能包括：

改进了海龟移动和旋转的动画。

使用新的 delay()、tracer() 和 speed() 方法控制海龟移动。

能够为海龟设置新形状，并定义新的坐标系。

Turtles now have an undo() method that can roll back actions.

简单支持对鼠标和键盘活动等输入事件做出反应，使得编写简单游戏成为可能。

turtle.cfg 文件可被用来定制海龟绘图屏幕的初始外观。

模块的文档字符串可以被替换为已翻译成另一种语言的新文档字符串。

(bpo-1513695 [https://bugs.python.org/issue?@action=redirect&bpo=1513695])

An optional timeout parameter was added to the urllib.urlopen() function and the urllib.ftpwrapper class constructor, as well as the urllib2.urlopen() function. The parameter specifies a timeout measured in seconds. For example:

>>> u = urllib2.urlopen("http://slow.example.com",
                        timeout=3)
Traceback (most recent call last):
  ...
urllib2.URLError: <urlopen error timed out>
>>>

（由 Facundo Batista 添加。）

unicodedata 模块提供的Unicode数据库已更新至版本5.1.0。（由Martin von Löwis更新；bpo-3811 [https://bugs.python.org/issue?@action=redirect&bpo=3811]。）

warnings 模块的 formatwarning() 和 showwarning() 增加了一个可选的 line 参数，用于提供源代码行。（作为 bpo-1631171 [https://bugs.python.org/issue?@action=redirect&bpo=1631171] 的一部分添加，该问题重新实现了 warnings 模块的C代码部分。）

新增函数 catch_warnings() 是一个用于测试目的的上下文管理器，允许你临时修改警告过滤器，然后恢复其原始值（bpo-3781 [https://bugs.python.org/issue?@action=redirect&bpo=3781]）。

The XML-RPC SimpleXMLRPCServer and DocXMLRPCServer classes can now be prevented from immediately opening and binding to their socket by passing False as the bind_and_activate constructor parameter. This can be used to modify the instance's allow_reuse_address attribute before calling the server_bind() and server_activate() methods to open the socket and begin listening for connections. (Contributed by Peter Parente; bpo-1599845 [https://bugs.python.org/issue?@action=redirect&bpo=1599845].)

SimpleXMLRPCServer 还有一个 _send_traceback_header 属性；如果为真，异常和格式化的回溯将作为 HTTP 头部 "X-Exception" 和 "X-Traceback" 返回。此功能仅用于调试目的，不应在生产服务器上使用，因为回溯可能会泄露密码或其他敏感信息。（由 Alan McIntyre 作为其 Google 2007 年夏季代码项目的一部分贡献。）

The xmlrpclib module no longer automatically converts datetime.date and datetime.time to the xmlrpclib.DateTime type; the conversion semantics were not necessarily correct for all applications. Code using xmlrpclib should convert date and time instances. (bpo-1330538 [https://bugs.python.org/issue?@action=redirect&bpo=1330538]) The code can also handle dates before 1900 (contributed by Ralf Schmitt; bpo-2014 [https://bugs.python.org/issue?@action=redirect&bpo=2014]) and 64-bit integers represented by using <i8> in XML-RPC responses (contributed by Riku Lindblad; bpo-2985 [https://bugs.python.org/issue?@action=redirect&bpo=2985]).

zipfile 模块的 ZipFile 类现在有 extract() 和 extractall() 方法，可以将单个文件或存档中的所有文件解压到当前目录，或指定目录:

z = zipfile.ZipFile('python-251.zip')

# Unpack a single file, writing it relative
# to the /tmp directory.
z.extract('Python/sysmodule.c', '/tmp')

# Unpack all the files in the archive.
z.extractall()

（由 Alan McIntyre 在 bpo-467924 [https://bugs.python.org/issue?@action=redirect&bpo=467924] 中贡献。）

open()、read() 和 extract() 方法现在可以接受文件名或 ZipInfo 对象。这在存档意外包含重复文件名时很有用。（由 Graham Horler 贡献；bpo-1775025 [https://bugs.python.org/issue?@action=redirect&bpo=1775025]。）

最后，zipfile 现在支持使用 Unicode 文件名存档文件。（由 Alexey Borzenkov 贡献；bpo-1734346 [https://bugs.python.org/issue?@action=redirect&bpo=1734346]。）

ast 模块

ast 模块提供了 Python 代码的抽象语法树（Abstract Syntax Tree）表示，Armin Ronacher 贡献了一组辅助函数，用于执行各种常见任务。这些函数对于 HTML 模板包、代码分析器以及处理 Python 代码的类似工具将非常有用。

parse() 函数接受一个表达式并返回一个 AST。dump() 函数输出树的表示，适用于调试:

import ast

t = ast.parse("""
d = {}
for i in 'abcdefghijklm':
    d[i + i] = ord(i) - ord('a') + 1
print d
""")
print ast.dump(t)

输出是一棵深度嵌套的树:

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)
 ])

literal_eval() 方法接受一个字符串或表示字面量表达式的 AST，解析并评估它，并返回结果值。字面量表达式是只包含字符串、数字、字典等，但不包含语句或函数调用的 Python 表达式。如果你需要评估一个表达式，但不能接受使用 eval() 调用的安全风险，literal_eval() 将安全地处理它:

>>> 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

该模块还包括 NodeVisitor 和 NodeTransformer 类，用于遍历和修改 AST，以及用于常见转换（如更改行号）的函数。

future_builtins 模块

Python 3.0 对内置函数库进行了许多更改，大多数更改无法在 Python 2.x 系列中引入，因为它们会破坏兼容性。future_builtins 模块提供了这些内置函数的版本，可以在编写 3.0 兼容代码时导入。

目前此模块中的函数包括:

ascii(obj): 等同于 repr()。在 Python 3.0 中，repr() 将返回一个 Unicode 字符串，而 ascii() 将返回一个纯 ASCII 字节串。

filter(predicate, iterable), map(func, iterable1, ...): 3.0 版本返回迭代器，与返回列表的 2.x 内置函数不同。

hex(value), oct(value): 这些版本将调用 __index__() 方法而不是 __hex__() 或 __oct__() 方法，并将结果转换为十六进制或八进制。oct() 将使用新的 0o 表示法来表示其结果。

json 模块: JavaScript Object Notation

新的 json 模块支持将 Python 类型编码和解码为 JSON（JavaScript 对象表示法）。JSON 是一种轻量级的数据交换格式，常用于 Web 应用程序。有关 JSON 的更多信息，请参见 http://www.json.org。

json 模块支持对大多数内置 Python 类型进行解码和编码。以下示例展示了如何编码和解码字典:

>>> import json
>>> data = {"spam": "foo", "parrot": 42}
>>> in_json = json.dumps(data) # Encode the data
>>> in_json
'{"parrot": 42, "spam": "foo"}'
>>> json.loads(in_json) # Decode into a Python object
{"spam": "foo", "parrot": 42}

你还可以编写自己的解码器和编码器以支持更多类型。还支持对 JSON 字符串进行美化打印。

json (最初称为 simplejson) 由 Bob Ippolito 编写。

plistlib 模块：属性列表解析器

.plist 格式通常在 Mac OS X 上用于存储基本数据类型（数字、字符串、列表和字典），通过将它们序列化成基于 XML 的格式。它类似于 XML-RPC 数据类型的序列化。

尽管该格式主要在 Mac OS X 上使用，但它本身并没有特定于 Mac 的内容，Python 实现在任何支持 Python 的平台上都能工作，因此 plistlib 模块已被提升到标准库中。

此模块的用法很简单:

import sys
import plistlib
import datetime

# Create data structure
data_struct = dict(lastAccessed=datetime.datetime.now(),
                   version=1,
                   categories=('Personal','Shared','Private'))

# Create string containing XML.
plist_str = plistlib.writePlistToString(data_struct)
new_struct = plistlib.readPlistFromString(plist_str)
print data_struct
print new_struct

# Write data structure to a file and read it back.
plistlib.writePlist(data_struct, '/tmp/customizations.plist')
new_struct = plistlib.readPlist('/tmp/customizations.plist')

# read/writePlist accepts file-like objects as well as paths.
plistlib.writePlist(data_struct, sys.stdout)

ctypes 增强

Thomas Heller 继续维护和增强 ctypes 模块。

ctypes 现在支持 c_bool 数据类型，它表示 C99 的 bool 类型。（由 David Remahl 贡献；bpo-1649190 [https://bugs.python.org/issue?@action=redirect&bpo=1649190]。）

ctypes 模块的字符串、缓冲区和数组类型已改进对扩展切片语法的支持，可以提供各种 (start, stop, step) 组合。（由 Thomas Wouters 实现。）

所有 ctypes 数据类型现在支持 from_buffer() 和 from_buffer_copy() 方法，这些方法基于提供的缓冲区对象创建 ctypes 实例。from_buffer_copy() 方法复制对象的内容，而 from_buffer() 方法将共享同一内存区域。

新的调用约定指示 ctypes 在每次包装调用的开始清除 errno 或 Win32 LastError 变量。（由 Thomas Heller 实现；bpo-1798 [https://bugs.python.org/issue?@action=redirect&bpo=1798]。）

现在可以在函数调用后检索 Unix errno 变量。在创建包装函数时，可以将 use_errno=True 作为关键字参数提供给 DLL() 函数，然后调用模块级方法 set_errno() 和 get_errno() 来设置和检索错误值。

Win32 LastError 变量同样由 DLL()、OleDLL() 和 WinDLL() 函数支持。提供 use_last_error=True 作为关键字参数，然后调用模块级方法 set_last_error() 和 get_last_error()。

byref() 函数用于检索指向 ctypes 实例的指针，现在有一个可选的 offset 参数，该参数是一个字节计数，将添加到返回的指针中。

改进的 SSL 支持

Bill Janssen 对 Python 2.6 的安全套接字层（SSL）支持进行了大量改进，通过添加一个新的模块 ssl，该模块构建在 OpenSSL [https://www.openssl.org/] 库之上。这个新模块提供了对协商协议、使用的 X.509 证书的更多控制，并更好地支持在 Python 中编写 SSL 服务器（而不是客户端）。socket 模块中现有的 SSL 支持没有被移除，继续有效，但将在 Python 3.0 中被移除。

要使用新模块，你必须首先以常规方式创建一个TCP连接，然后将其传递给 ssl.wrap_socket() 函数。可以指定是否需要证书，并通过调用 getpeercert() 方法获取证书信息。

参见

ssl 模块的文档。

弃用和移除

字符串异常已被移除。尝试使用它们将引发 TypeError。

Changes to the Exception interface as dictated by PEP 352 [https://www.python.org/dev/peps/pep-0352] continue to be made. For 2.6, the message attribute is being deprecated in favor of the args attribute.

（3.0警告模式）Python 3.0将提供一个重新组织的标准库，该库将删除许多过时的模块并重命名其他模块。在3.0警告模式下运行的Python 2.6将在导入这些模块时发出警告。

The list of deprecated modules is: audiodev, bgenlocations, buildtools, bundlebuilder, Canvas, compiler, dircache, dl, fpformat, gensuitemodule, ihooks, imageop, imgfile, linuxaudiodev, mhlib, mimetools, multifile, new, pure, statvfs, sunaudiodev, test.testall, and toaiff.

gopherlib 模块已被移除。

The MimeWriter module and mimify module have been deprecated; use the email package instead.

The md5 module has been deprecated; use the hashlib module instead.

The posixfile module has been deprecated; fcntl.lockf() provides better locking.

The popen2 module has been deprecated; use the subprocess module.

rgbimg 模块已被移除。

The sets module has been deprecated; it's better to use the built-in set and frozenset types.

The sha module has been deprecated; use the hashlib module instead.

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

Python now must be compiled with C89 compilers (after 19 years!). This means that the Python source tree has dropped its own implementations of memmove() and strerror(), which are in the C89 standard library.

Python 2.6可以使用Microsoft Visual Studio 2008（版本9.0）构建，这也是新的默认编译器。请查看 PCbuild 目录以获取构建文件。（由Christian Heimes实现。）

在Mac OS X上，Python 2.6可以编译为四路通用构建。configure 脚本可以接受一个 --with-universal-archs=[32-bit|64-bit|all] 开关，控制生成的二进制文件是为32位架构（x86，PowerPC）、64位（x86-64和PPC-64）还是两者都支持。（由Ronald Oussoren贡献。）

BerkeleyDB模块现在有一个C API对象，作为 bsddb.db.api 提供。这个对象可以被其他希望使用 bsddb 模块实现自己目的的C扩展使用。（由Duncan Grisby贡献。）

新的缓冲区接口，之前在 PEP 3118 部分 中描述，增加了 PyObject_GetBuffer() 和 PyBuffer_Release()，以及其他一些函数。

Python's use of the C stdio library is now thread-safe, or at least as thread-safe as the underlying library is. A long-standing potential bug occurred if one thread closed a file object while another thread was reading from or writing to the object. In 2.6 file objects have a reference count, manipulated by the PyFile_IncUseCount() and PyFile_DecUseCount() functions. File objects can't be closed unless the reference count is zero. PyFile_IncUseCount() should be called while the GIL is still held, before carrying out an I/O operation using the FILE * pointer, and PyFile_DecUseCount() should be called immediately after the GIL is re-acquired. (Contributed by Antoine Pitrou and Gregory P. Smith.)

在两个不同线程中同时导入模块不再会导致死锁；现在会引发一个 ImportError。一个新的 API 函数 PyImport_ImportModuleNoBlock()，首先会在 sys.modules 中查找模块，然后在获取导入锁后尝试导入它。如果导入锁被另一个线程持有，则会引发 ImportError。（由 Christian Heimes 贡献。）

Several functions return information about the platform's floating-point support. PyFloat_GetMax() returns the maximum representable floating point value, and PyFloat_GetMin() returns the minimum positive value. PyFloat_GetInfo() returns an object containing more information from the float.h file, such as "mant_dig" (number of digits in the mantissa), "epsilon" (smallest difference between 1.0 and the next largest value representable), and several others. (Contributed by Christian Heimes; bpo-1534 [https://bugs.python.org/issue?@action=redirect&bpo=1534].)

使用 PyComplex_AsCComplex() 的 C 函数和方法现在将接受具有 __complex__() 方法的参数。特别是，cmath 模块中的函数现在将接受具有此方法的对象。这是 Python 3.0 变更的一个回退版本。（由 Mark Dickinson 贡献；bpo-1675423 [https://bugs.python.org/issue?@action=redirect&bpo=1675423]。）

Python 的 C API 现在包括两个用于不区分大小写的字符串比较函数，PyOS_stricmp(char*, char*) 和 PyOS_strnicmp(char*, char*, Py_ssize_t)。（由 Christian Heimes 贡献；bpo-1635 [https://bugs.python.org/issue?@action=redirect&bpo=1635]。）

许多 C 扩展在 init* 函数中定义了自己的小宏，用于将整数和字符串添加到模块的字典中。Python 2.6 终于定义了用于向模块添加值的标准宏，PyModule_AddStringMacro 和 PyModule_AddIntMacro()。（由 Christian Heimes 贡献。）

Some macros were renamed in both 3.0 and 2.6 to make it clearer that they are macros, not functions. Py_Size() became Py_SIZE(), Py_Type() became Py_TYPE(), and Py_Refcnt() became Py_REFCNT(). The mixed-case macros are still available in Python 2.6 for backward compatibility. (bpo-1629 [https://bugs.python.org/issue?@action=redirect&bpo=1629])

Distutils 在运行调试版本的 Python 时，现在将构建的 C 扩展放置在不同的目录中。（由 Collin Winter 贡献；bpo-1530959 [https://bugs.python.org/issue?@action=redirect&bpo=1530959]。）

几种基本数据类型，如整数和字符串，维护内部的对象自由列表，这些对象可以重复使用。这些自由列表的数据结构现在遵循命名约定：变量始终命名为 free_list，计数器始终命名为 numfree，并且始终定义一个宏 Py<typename>_MAXFREELIST。

一个新的Makefile目标，"make patchcheck"，用于准备Python源代码树以生成补丁：它会修复所有修改过的".py"文件中的尾部空白，检查文档是否已更改，并报告 Misc/ACKS 和 Misc/NEWS 文件是否已更新。（由 Brett Cannon 贡献。）

另一个新目标，"make profile-opt"，使用GCC的基于配置的优化来编译Python二进制文件。它会启用配置编译Python，运行测试套件以获取一组配置结果，然后使用这些结果进行优化编译。（由 Gregory P. Smith 贡献。）

特定于 Windows 的更改：

对Windows 95、98、ME和NT4的支持已被放弃。Python 2.6至少需要Windows 2000 SP4。

Windows上的新默认编译器是Visual Studio 2008（版本9.0）。Visual Studio 2003（版本7.1）和2005（版本8.0）的构建目录已被移至PC/目录。新的 PCbuild 目录支持X64的交叉编译、调试构建和配置引导优化（PGO）。PGO构建比普通构建大约快10%。 （由 Christian Heimes 贡献，Amaury Forgeot d'Arc 和 Martin von Löwis 提供帮助。）

The msvcrt module now supports both the normal and wide char variants of the console I/O API. The getwch() function reads a keypress and returns a Unicode value, as does the getwche() function. The putwch() function takes a Unicode character and writes it to the console. (Contributed by Christian Heimes.)

os.path.expandvars() 现在将展开形式为 "%var%"的环境变量，而 "~user" 将被展开为用户的主目录路径。（由 Josiah Carlson 贡献；bpo-957650 [https://bugs.python.org/issue?@action=redirect&bpo=957650]。）

The socket module's socket objects now have an ioctl() method that provides a limited interface to the WSAIoctl() system interface.

The _winreg module now has a function, ExpandEnvironmentStrings(), that expands environment variable references such as %NAME% in an input string. The handle objects provided by this module now support the context protocol, so they can be used in with statements. (Contributed by Christian Heimes.)

_winreg also has better support for x64 systems, exposing the DisableReflectionKey(), EnableReflectionKey(), and QueryReflectionKey() functions, which enable and disable registry reflection for 32-bit processes running on 64-bit systems. (bpo-1753245 [https://bugs.python.org/issue?@action=redirect&bpo=1753245])

The msilib module's Record object gained GetInteger() and GetString() methods that return field values as an integer or a string. (Contributed by Floris Bruynooghe; bpo-2125 [https://bugs.python.org/issue?@action=redirect&bpo=2125].)

特定于 Mac OS X 的更改：

现在，在编译Python的框架版本时，可以为 configure 脚本添加 --with-framework-name= 选项来指定要使用的框架名称。

macfs 模块已被删除。这反过来要求删除 macostools.touched() 函数，因为它依赖于 macfs 模块。 (bpo-1490190 [https://bugs.python.org/issue?@action=redirect&bpo=1490190])

许多其他 Mac OS 模块已弃用并将在 Python 3.0 中被删除: _builtinSuites, aepack, aetools, aetypes, applesingle, appletrawmain, appletrunner, argvemulator, Audio_mac, autoGIL, Carbon, cfmfile, CodeWarrior, ColorPicker, EasyDialogs, Explorer, Finder, FrameWork, findertools, ic, icglue, icopen, macerrors, MacOS, macfs, macostools, macresource, MiniAEFrame, Nav, Netscape, OSATerminology, pimp, PixMapWrapper, StdSuites, SystemEvents, Terminal 和 terminalcommand。

特定于 IRIX 的更改：

许多旧的 IRIX 专用模块已被弃用，并将在Python 3.0中删除： al 和 AL, cd, cddb, cdplayer, CL 和 cl, DEVICE, ERRNO, FILE, FL 和 fl, flp, fm, GET, GLWS, GL 和 gl, IN, IOCTL, jpeg, panelparser, readcd, SV 和 sv, torgb, videoreader, 和 WAIT.

移植到Python 2.6

本节列出了先前描述的改变以及可能需要修改你的代码的其他问题修正:

预期为不可哈希的类应当在其定义中设置 __hash__ = None 来指明这一点。

字符串异常已被移除。尝试使用它们将引发 TypeError。

collections.deque 的 __init__() 方法现在会在从可迭代对象添加元素之前清空deque中的任何现有内容。这一改变使得其行为与 list.__init__() 相匹配。

以前 object.__init__() 接受任意参数和关键字参数，并忽略它们。在Python 2.6中，这不再被允许，并将导致 TypeError。这将影响最终调用 object 上相应方法（可能通过使用 super()）的 __init__() 方法。参见 bpo-1683368 [https://bugs.python.org/issue?@action=redirect&bpo=1683368] 进行讨论。

Decimal 构造函数现在在接受字符串时允许前导和尾随空格。以前它会引发 InvalidOperation 异常。另一方面，Context 对象的 create_decimal() 方法现在明确禁止额外空格，并引发 ConversionSyntax 异常。

由于实现上的意外，如果你将文件路径传递给内置的 __import__() 函数，它实际上会导入指定的文件。这从未打算工作，然而，现在的实现明确检查这种情况并引发 ImportError。

C API：PyImport_Import() 和 PyImport_ImportModule() 函数现在默认为绝对导入，而不是相对导入。这将影响导入其他模块的C扩展。

C API：不应可哈希的扩展数据类型应将其 tp_hash 插槽定义为 PyObject_HashNotImplemented()。

socket 模块的异常 socket.error 现在继承自 IOError。以前它不是 StandardError 的子类，但现在通过 IOError 继承了。（由 Gregory P. Smith 实现；bpo-1706815 [https://bugs.python.org/issue?@action=redirect&bpo=1706815]。）

The xmlrpclib module no longer automatically converts datetime.date and datetime.time to the xmlrpclib.DateTime type; the conversion semantics were not necessarily correct for all applications. Code using xmlrpclib should convert date and time instances. (bpo-1330538 [https://bugs.python.org/issue?@action=redirect&bpo=1330538])

(3.0 警告模式) Exception 类在被切片或索引访问时会产生警告。Exception 像元组一样的行为正在被逐步淘汰。

（3.0 警告模式）两个字典或两个未实现比较方法的对象之间的不等比较会被报告为警告。dict1 == dict2 仍然有效，但 dict1 < dict2 正在被逐步淘汰。

单元格之间的比较，这是 Python 作用域规则的实现细节，也会导致警告，因为在 3.0 中完全禁止此类比较。

致谢

作者感谢以下人员对本文各种草稿给予的建议，更正和协助： Georg Brandl, Steve Brown, Nick Coghlan, Ralph Corderoy, Jim Jewett, Kent Johnson, Chris Lambacher, Martin Michlmayr, Antoine Pitrou, Brian Warner.

Python 2.5 有什么新变化

作者

A.M. Kuchling

本文介绍了 Python 2.5 的新增特性。 Python 2.5 预定的最终发布时间为 2006 年 8 月；PEP 356 [https://www.python.org/dev/peps/pep-0356] 描述了预定的发布日程。 Python 2.5 实际发布于 2006 年 9 月 19 日。

Python 2.5 中的变化是语言本身和标准库改进的有趣混合。 我想，库的加强对 Python 的用户社区来说会更重要一些，因为增加了多个被广泛应用的包。 新增模块包括用于 XML 处理的 ElementTree (xml.etree)，SQLite 数据库模块 (sqlite)，以及用于调用 C 函数的 ctypes 模块。

语言变更具有中等重要性。一些令人愉悦的新功能被添加进来，但其中大多数并不是你每天都会使用的功能。条件表达式终于以新颖的语法被添加到语言中；参见章节 PEP 308: 条件表达式。新的 'with' 语句将使编写清理代码变得更容易（章节 PEP 343: "with" 语句）。现在可以将值传递给生成器（章节 PEP 342: 生成器的新特性）。导入现在可以明确为绝对或相对（章节 PEP 328: 绝对导入和相对导入）。一些异常处理的边缘情况得到了更好的处理（章节 PEP 341: 统一 try/except/finally）。所有这些改进都是有价值的，但它们都是对特定语言功能的改进； none of them are broad modifications to Python's semantics.

除了语言和库的添加之外，整个源代码树中还进行了其他改进和错误修复。通过搜索SVN变更日志发现，在Python 2.4和2.5之间应用了353个补丁并修复了458个错误。（这两个数字都可能是低估的。）

本文并不试图成为新功能的完整规范；相反，通过有帮助的示例简要介绍了这些变更。有关完整详情，你应始终参考Python 2.5的文档，网址为https://docs.python.org。如果你想了解完整的实现和设计原理，请参考特定新功能的PEP。

欢迎对本文档提出评论、建议和错误报告；请通过电子邮件发送给作者或在Python错误跟踪器中打开一个错误报告。

PEP 308: 条件表达式

长期以来，人们一直要求有一种方法来编写条件表达式，这种表达式根据布尔值的真或假返回值A或值B。条件表达式允许你编写一个赋值语句，其效果与以下相同:

if condition:
    x = true_value
else:
    x = false_value

在python-dev和comp.lang.python上，关于语法的无尽乏味讨论已经屡见不鲜。甚至进行了一次投票，发现大多数投票者希望以某种形式引入条件表达式，但没有一种语法获得了明显多数的支持。候选语法包括C语言的``cond ? true_v : false_v``、if cond then true_v else false_v 以及16种其他变体。

Guido van Rossum 最终选择了一种令人惊讶的语法：

x = true_value if condition else false_value

评估仍然像现有的布尔表达式一样是惰性的，因此评估顺序会有些跳跃。中间的 condition 表达式首先被评估，true_value 表达式只有在条件为真时才会被评估。同样，false_value 表达式只有在条件为假时才会被评估。

这种语法可能看起来奇怪且倒置；为什么条件要放在表达式的*中间*，而不是像C语言中的``c ? x : y``那样放在前面？这一决定是通过将新语法应用于标准库中的模块，并查看生成的代码的可读性来验证的。在许多使用条件表达式的情况下，一个值似乎是'常见情况'，而另一个值是'特殊情况'，仅在条件不满足的罕见情况下使用。条件语法使这种模式更加明显:

contents = ((doc + '\n') if doc else '')

我将上述声明理解为“通常 contents 被赋值为 doc+'\n'；有时 doc 为空，在这种情况下返回空字符串。”我怀疑在不存在明显常见和不常见情况的地方，我不会经常使用条件表达式。

曾经有过一些讨论，关于是否应该要求在条件表达式周围加上括号。决定是不在 Python 语言的语法中要求括号，但出于风格考虑，我认为你应该总是使用它们。考虑以下两个语句:

# First version -- no parens
level = 1 if logging else 0

# Second version -- with parens
level = (1 if logging else 0)

在第一个版本中，我认为读者的视线可能会将语句分为'level = 1'、'if logging'、'else 0'，并认为条件决定了是否对*level*进行赋值。在我看来，第二个版本读起来更好，因为它清楚地表明赋值始终执行，只是在两个值之间进行选择。

包含括号还有一个原因：一些列表推导式和lambda表达式的奇怪组合可能看起来像错误的条件表达式。参见 PEP 308 [https://www.python.org/dev/peps/pep-0308] 了解一些示例。如果你在条件表达式周围加上括号，就不会遇到这种情况。

参见

PEP 308 [https://www.python.org/dev/peps/pep-0308] - 条件表达式

PEP 由 Guido van Rossum 和 Raymond D 撰写，由 Thomas Wouters 实现。

PEP 309: 部分功能应用

functools 模块旨在包含用于函数式编程风格的工具。

这个模块中一个有用的工具是 partial() 函数。对于用函数式风格编写的程序，有时你会想要构造一些现有函数的变体，其中部分参数已填充。考虑一个Python函数``f(a, b, c)``；你可以创建一个新函数``g(b, c)``，它等同于``f(1, b, c)``。这被称为“部分函数应用”。

partial() 接受参数 (function, arg1, arg2, ... kwarg1=value1, kwarg2=value2)。生成的对象是可调用的，因此你可以直接调用它来使用填充的参数调用*function*。

这里有一个很小但很现实的例子:

import functools

def log (message, subsystem):
    "Write the contents of 'message' to the specified subsystem."
    print '%s: %s' % (subsystem, message)
    ...

server_log = functools.partial(log, subsystem='server')
server_log('Unable to open socket')

这里还有一个例子，来自一个使用PyGTK的程序。这里正在动态构建一个上下文敏感的弹出菜单。为菜单选项提供的回调是一个部分应用的 open_item() 方法版本，其中第一个参数已经提供。

...
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) )

在 functools 模块中，另一个函数是 update_wrapper(wrapper, wrapped)，它可以帮助你编写行为良好的装饰器。update_wrapper() 将名称、模块和文档字符串属性复制到包装函数中，以便更容易理解包装函数内的追溯信息。例如，你可能这样写:

def my_decorator(f):
    def wrapper(*args, **kwds):
        print 'Calling decorated function'
        return f(*args, **kwds)
    functools.update_wrapper(wrapper, f)
    return wrapper

wraps() 是一个装饰器，可以在你自己的装饰器中使用，以复制被包装函数的信息。上一个示例的另一种版本可能是:

def my_decorator(f):
    @functools.wraps(f)
    def wrapper(*args, **kwds):
        print 'Calling decorated function'
        return f(*args, **kwds)
    return wrapper

参见

PEP 309 [https://www.python.org/dev/peps/pep-0309] - 部分函数应用

PEP由 Peter Harris 提出并撰写；由 Hye-Shik Chang 和 Nick Coghlan 实现，并由 Raymond Hettinger 适配。

PEP 314: Python软件包的元数据 v1.1

Distutils 中添加了一些简单的依赖支持。setup() 函数现在有了 requires、provides 和 obsoletes 关键字参数。当你使用 sdist 命令构建源代码分发时，依赖信息将被记录在 PKG-INFO 文件中。

另一个新的关键字参数是 download_url，它应该设置为包源代码的 URL。这意味着现在可以查找包索引中的条目，确定包的依赖关系，并下载所需的包。:

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),
     )

Python 包索引 https://pypi.org 的另一个新增强功能是存储包的源代码和二进制存档。新的 upload Distutils 命令将上传包到仓库。

在包可以上传之前，你必须能够使用 sdist Distutils 命令构建分发。一旦那个工作完成，你可以运行 python setup.py upload 将你的包添加到 PyPI 存档中。可选地，你可以通过提供 --sign 和 --identity 选项来对包进行 GPG 签名。

包上传操作由 Martin von Löwis 和 Richard Jones 实现。

参见

PEP 314 [https://www.python.org/dev/peps/pep-0314] - Python软件包的元数据 v1.1

PEP 由 A.M. Kuchling, Richard Jones 和 Fred Drake 提出并撰写，由 Richard Jones 和 Fred Drake 实现

PEP 328: 绝对导入和相对导入

PEP 328 [https://www.python.org/dev/peps/pep-0328] 的较简单部分已在 Python 2.4 中实现：现在可以用圆括号将使用 from ... import ... 语句导入的名称括起来，以便能够更容易地导入大量不同的名称。

更复杂的部分已在 Python 2.5 中实现：可以指定使用绝对的或相对于包的导入方式来导入模块。 计划在未来的 Python 版本中将绝对导入方式设为默认。

比如说你有这样一个包目录:

pkg/
pkg/__init__.py
pkg/main.py
pkg/string.py

这定义了一个名为 pkg 的包，其中包含 pkg.main 和 pkg.string 子模块。

考虑在 main.py 模块中的代码。如果它执行了语句 import string 会发生什么？在 Python 2.4 及更早版本中，它首先会在包的目录中查找以进行相对导入，找到 pkg/string.py，将该文件的内容导入为 pkg.string 模块，并且该模块绑定到 pkg.main 模块命名空间中的名称 string。

如果 pkg.string 是你想要的，那没问题。但如果你想要的是 Python 的标准 string 模块呢？没有一种干净的方法来忽略 pkg.string 并查找标准模块；通常你需要查看 sys.modules 的内容，这稍微有些不干净。Holger Krekel 的 py.std 包提供了一种更整洁的方式来从标准库进行导入，import py; py.std.string.join()，但该包并非在所有 Python 安装中都可用。

阅读依赖相对导入的代码也不够清晰，因为读者可能会对意图使用哪个模块，string 还是 pkg.string，感到困惑。Python 用户很快学会了不要在他们的包子模块名称中重复标准库模块的名称，但你无法防止你的子模块名称被用于未来版本 Python 中添加的新模块。

在 Python 2.5 中，你可以通过使用 from __future__ import absolute_import 指令将 import 的行为切换为绝对导入。这种绝对导入行为将在未来版本（可能是 Python 2.7）中成为默认行为。一旦绝对导入成为默认行为，import string 将始终找到标准库的版本。建议用户尽可能开始使用绝对导入，因此最好在代码中开始写 from pkg import string。

通过在使用 from ... import 形式时在模块名称前添加一个前导点，仍然可以进行相对导入：

# Import names from pkg.string
from .string import name1, name2
# Import pkg.string
from . import string

这会相对当前包导入 string 模块，所以在 pkg.main 中这将导入 name1 和 name2 来自 pkg.string。额外的前导点号从当前包的父包开始执行相对导入。例如，在 A.B.C 模块中的代码可以这样做:

from . import D                 # Imports A.B.D
from .. import E                # Imports A.E
from ..F import G               # Imports A.F.G

开头的句点不可用于 import 语句的 import modname 形式，只能用于 from ... import 形式。

参见

PEP 328 [https://www.python.org/dev/peps/pep-0328] - 导入：多行和绝对/相对导入

PEP 由 Aahz 撰写，由 Thomas Wouters 实现。

https://pylib.readthedocs.io/

由 Holger Krekel 编写 py 库，其中包含 py.std 包。

PEP 338: 将模块作为脚本执行

Python 2.4 中添加的 -m 开关用于将模块作为脚本执行，获得了一些新能力。这个开关现在不再使用 Python 解释器内部的 C 代码实现，而是使用一个新模块 runpy 中的实现。

runpy 模块实现了一个更复杂的导入机制，现在可以运行包中的模块，例如 pychecker.checker。该模块还支持其他导入机制，例如 zipimport 模块。这意味着你可以将 .zip 归档的路径添加到 sys.path 中，然后使用 -m 开关来执行归档中的代码。

参见

PEP 338 [https://www.python.org/dev/peps/pep-0338] - 将模块作为脚本执行

PEP 由 Nick Coghlan 撰写并实现。

PEP 341: 统一 try/except/finally

直到 Python 2.5，try 语句有两种形式。你可以使用 finally 块确保代码总是被执行，或者使用一个或多个 except 块来捕获特定异常。你不能同时组合 except 块和 finally 块，因为生成正确字节码的合并版本很复杂，并且不清楚合并语句的语义应该是什么。

Guido van Rossum 花了一些时间研究 Java，后者支持组合 except 块和 finally 块的等价物，这澄清了该语句应该是什么意思。在 Python 2.5 中，你现在可以写:

try:
    block-1 ...
except Exception1:
    handler-1 ...
except Exception2:
    handler-2 ...
else:
    else-block
finally:
    final-block

执行 block-1 中的代码。如果代码引发异常，将测试各个 except 块：如果异常属于 Exception1 类，则执行 handler-1；否则，如果它属于 Exception2 类，则执行 handler-2，依此类推。如果没有引发异常，则执行 else-block。

无论之前发生了什么，一旦代码块完成并且处理了任何引发的异常，final-block 都会被执行一次。即使异常处理程序或 else-block 中出现错误并引发了新的异常，final-block 中的代码仍然会运行。

参见

PEP 341 [https://www.python.org/dev/peps/pep-0341] - 统一 try-except 和 try-finally

PEP 由 Georg Brandl 撰写，由 Thomas Lee 实现。

PEP 342: 生成器的新特性

Python 2.5 添加了一种简单的方法来将值 传入 生成器。如在 Python 2.3 中引入的，生成器仅产生输出；一旦生成器的代码被调用以创建迭代器，当其执行恢复时，无法将任何新信息传递到函数中。有时能够传递一些信息会很有用。对此的权宜之计包括让生成器的代码查看全局变量，然后更改全局变量的值，或者传入一些可变对象，然后调用者修改它。

为了刷新你对基本生成器的记忆，这里有一个简单的例子：

def counter (maximum):
    i = 0
    while i < maximum:
        yield i
        i += 1

当你调用 counter(10) 时，结果是一个迭代器，它返回从 0 到 9 的值。在遇到 yield 语句时，迭代器返回提供的值并挂起函数的执行，保留局部变量。执行在下次调用迭代器的 next() 方法时恢复，从 yield 语句之后开始。

在 Python 2.3 中，yield 是一个语句；它不返回任何值。在 2.5 中，yield 现在是一个表达式，返回一个可以赋值给变量或进行其他操作的值：

val = (yield i)

我建议在处理返回值时，总是将 yield 表达式用括号括起来，如上例所示。括号并非总是必要，但总是添加它们比记住何时需要它们要容易。

(PEP 342 [https://www.python.org/dev/peps/pep-0342] 解释了确切的规则，即 yield-表达式必须总是括起来，除非它出现在赋值右侧的顶层表达式中。这意味着你可以写 val = yield i，但在有操作时必须使用括号，如 val = (yield i) + 12。）

通过调用生成器的 send(value) 方法将值发送到生成器中。然后生成器的代码继续执行，yield 表达式返回指定的 value。如果调用常规的 next() 方法，yield 返回 None。

以下是修改后的示例，允许更改内部计数器的值。

def counter (maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # If value provided, change counter
        if val is not None:
            i = val
        else:
            i += 1

以下是更改计数器的示例:

>>> 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

yield 通常会返回 None，因此你应该总是检查这种情况。不要仅在表达式中使用它的值，除非你确信 send() 方法将是唯一用于恢复生成器函数的方法。

除了 send()，生成器上还有另外两个新方法：

throw(type, value=None, traceback=None) 用于在生成器内部引发异常；异常由 yield 表达式在生成器执行暂停的地方引发。

close() 方法在生成器内部引发一个新的 GeneratorExit 异常以终止迭代。接收到此异常时，生成器的代码必须要么引发 GeneratorExit，要么引发 StopIteration。捕获 GeneratorExit 异常并返回值是不合法的，将会触发 RuntimeError；如果函数引发其他异常，该异常将传播给调用者。close() 方法还将在生成器被垃圾回收时由 Python 的垃圾回收器调用。

如果你需要在 GeneratorExit 发生的时候运行清理代码，我建议使用 try: ... finally: 组合来代替捕获 GeneratorExit。

这些改变的累积效应是，让生成器从单向的信息生产者变成了既是生产者，又是消费者。

生成器还可以成为 协程，这是一种更通用的子程序形式。子程序从一个点进入并在另一个点退出（函数顶部和 return 语句），但协程可以在许多不同的点进入、退出和恢复（yield 语句）。我们需要找出在 Python 中有效使用协程的模式。

添加 close() 方法有一个不明显的影响。当生成器被垃圾回收时，会调用 close()，这意味着生成器的代码在生成器被销毁之前有最后一次运行的机会。这最后一次机会意味着生成器中的 try...finally 语句现在可以保证工作；finally 子句现在总能得到运行的机会。因此，之前的语法限制——不能将 yield 语句与 try...finally 块混合使用——已经被移除。这看起来像是语言的小细节，但实际上使用生成器和 try...finally 对于实现 PEP 343 [https://www.python.org/dev/peps/pep-0343] 中描述的 with 语句是必要的。我将在下一节中探讨这个新语句。

这个变化的另一个更神秘的影响是：以前，生成器的 gi_frame 属性总是一个帧对象。现在，一旦生成器耗尽，gi_frame 有可能变为 None。

参见

PEP 342 [https://www.python.org/dev/peps/pep-0342] - 通过增强型生成器实现协程

PEP 由 Guido van Rossum 和 Phillip J. Eby 撰写，由 Phillip J. Eby 实现。包括一些更高级的使用生成器作为协程的示例。

这些功能的早期版本在 PEP 288 [https://www.python.org/dev/peps/pep-0288] （由 Raymond Hettinger 撰写） 和 PEP 325 [https://www.python.org/dev/peps/pep-0325] （由 Samuele Pedroni 撰写）中提出。

https://en.wikipedia.org/wiki/Coroutine

协程的Wikipedia条目。

https://web.archive.org/web/20160321211320/http://www.sidhe.org/~dan/blog/archives/000178.html

基于 Perl 视角对协程的介绍，由 Dan Sugalski 撰写。

PEP 343: "with" 语句

'with' 语句澄清了以前使用 try...finally 块来确保执行清理代码的代码。在本节中，我将讨论该语句的常见用法。在下一节中，我将探讨实现细节，并展示如何编写与该语句一起使用的对象。

'with' 语句是一个新的控制流结构，其基本结构如下:

with expression [as variable]:
    with-block

The expression is evaluated, and it should result in an object that supports the context management protocol (that is, has __enter__() and __exit__() methods.

The object's __enter__() is called before with-block is executed and therefore can run set-up code. It also may return a value that is bound to the name variable, if given. (Note carefully that variable is not assigned the result of expression.)

After execution of the with-block is finished, the object's __exit__() method is called, even if the block raised an exception, and can therefore run clean-up code.

要在 Python 2.5 中启用该语句，你需要向你的模块添加以下指令:

from __future__ import with_statement

该语句在Python 2.6 中始终启用。

一些标准 Python 对象现在已支持上下文管理协议并可被用于 'with' 语句。 文件对象就是一个例子:

with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... more processing code ...

在此语句被执行之后，文件对象 f 将被自动关闭，即使是当 for 循环在代码块中间引发了异常的时候也是如此。

注解

In this case, f is the same object created by open(), because file.__enter__() returns self.

threading 模块的加锁和条件变量也支持 'with' 语句:

lock = threading.Lock()
with lock:
    # Critical section of code
    ...

这个锁会在代码块被执行之前锁定并总是会在代码块完成之后释放。

在 decimal 模块中的新 localcontext() 函数可以轻松保存和恢复当前的十进制上下文，该上下文封装了计算所需的精度和舍入特性:

from decimal import Decimal, Context, localcontext

# Displays with default precision of 28 digits
v = Decimal('578')
print v.sqrt()

with localcontext(Context(prec=16)):
    # All code in this block uses a precision of 16 digits.
    # The original context is restored on exiting the block.
    print v.sqrt()

编写上下文管理器

在底层，'with' 语句相当复杂。大多数人只会与现有对象一起使用 'with'，不需要了解这些细节，所以如果你愿意，可以跳过本节的其余部分。新对象的作者需要理解底层实现的细节，应该继续阅读。

在更高层级上对于上下文管理器协议的解释:

The expression is evaluated and should result in an object called a "context manager". The context manager must have __enter__() and __exit__() methods.

The context manager's __enter__() method is called. The value returned is assigned to VAR. If no 'as VAR' clause is present, the value is simply discarded.

BLOCK 中的代码会被执行。

如果 BLOCK 引发异常，将调用 __exit__(type, value, traceback) 方法，并传入异常详细信息，这些值与 sys.exc_info() 返回的值相同。该方法的返回值控制是否重新抛出异常：任何假值将重新抛出异常，而 True 将导致异常被抑制。通常情况下，你很少会想要抑制异常，因为如果你这么做，包含 'with' 语句的代码作者将永远不会意识到出了问题。

If BLOCK didn't raise an exception, the __exit__() method is still called, but type, value, and traceback are all None.

让我们通过一个例子来思考。我不会展示详细的代码，而只会概述支持事务的数据库所需的方法。

（对于不熟悉数据库术语的人来说：对数据库的一组更改被组合成一个事务。事务可以被提交，意味着所有更改都被写入数据库，或者被回滚，意味着所有更改都被丢弃，数据库保持不变。更多信息请参阅任何数据库教材。）

假设有一个表示数据库连接的对象。我们的目标将允许用户编写如下代码：

db_connection = DatabaseConnection()
with db_connection as cursor:
    cursor.execute('insert into ...')
    cursor.execute('delete from ...')
    # ... more operations ...

如果块中的代码完美运行，则应提交事务；如果出现异常，则应回滚事务。以下是假设的 DatabaseConnection 的基本接口：

class DatabaseConnection:
    # Database interface
    def cursor (self):
        "Returns a cursor object and starts a new transaction"
    def commit (self):
        "Commits current transaction"
    def rollback (self):
        "Rolls back current transaction"

The __enter__() method is pretty easy, having only to start a new transaction. For this application the resulting cursor object would be a useful result, so the method will return it. The user can then add as cursor to their 'with' statement to bind the cursor to a variable name.

class DatabaseConnection:
    ...
    def __enter__ (self):
        # Code to start a new transaction
        cursor = self.cursor()
        return cursor

The __exit__() method is the most complicated because it's where most of the work has to be done. The method has to check if an exception occurred. If there was no exception, the transaction is committed. The transaction is rolled back if there was an exception.

在下面的代码中，执行将直接从函数末尾跳出，返回默认值 None。None 为假值，因此异常将自动重新抛出。如果你希望更明确，可以在标记的位置添加一个 return 语句。:

class DatabaseConnection:
    ...
    def __exit__ (self, type, value, tb):
        if tb is None:
            # No exception, so commit
            self.commit()
        else:
            # Exception occurred, so rollback.
            self.rollback()
            # return False

contextlib 模块

新的 contextlib 模块提供了一些函数和一个装饰器，用于编写与 'with' 语句一起使用的对象。

The decorator is called contextmanager(), and lets you write a single generator function instead of defining a new class. The generator should yield exactly one value. The code up to the yield will be executed as the __enter__() method, and the value yielded will be the method's return value that will get bound to the variable in the 'with' statement's as clause, if any. The code after the yield will be executed in the __exit__() method. Any exception raised in the block will be raised by the yield statement.

上一节中的数据库示例可以使用这个装饰器编写为:

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:
    ...

contextlib 模块还有一个``nested(mgr1, mgr2, ...)``函数，它可以将多个上下文管理器组合在一起，这样你就不需要编写嵌套的'with'语句。在这个例子中，单个'with'语句既启动数据库事务又获取线程锁:

lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...

最后，closing(object) 函数返回 object，以便它可以绑定到变量，并在块的末尾调用 object.close。:

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)

参见

PEP 343 [https://www.python.org/dev/peps/pep-0343] - "with" 语句

PEP由Guido van Rossum和Nick Coghlan撰写；由Mike Bland、Guido van Rossum和Neal Norwitz实现。PEP展示了为'with'语句生成的代码，这对于学习该语句的工作原理很有帮助。

contextlib 模块的文档。

PEP 352: 异常作为新型的类

异常类现在可以是新式类，而不仅仅是经典类，内置的 Exception 类和所有标准内置异常（NameError、ValueError 等）现在都是新式类。

异常的继承层次结构已经稍微重新排列了一下。在2.5中，继承关系如下:

BaseException       # New in Python 2.5
|- KeyboardInterrupt
|- SystemExit
|- Exception
   |- (all other current built-in exceptions)

这种重新排列是因为人们通常希望捕获所有表示程序错误的异常。然而，KeyboardInterrupt 和 SystemExit 并不是错误，它们通常表示用户执行了明确的操作，例如按下 Control-C 或代码调用 sys.exit()。一个裸露的 except: 会捕获所有异常，因此通常需要列出 KeyboardInterrupt 和 SystemExit 以重新抛出它们。通常的模式是:

try:
    ...
except (KeyboardInterrupt, SystemExit):
    raise
except:
    # Log error...
    # Continue running program...

在 Python 2.5 中，你现在可以写 except Exception 来达到同样的效果，捕获所有通常表示错误的异常，但不包括 KeyboardInterrupt 和 SystemExit。与之前的版本一样，裸露的 except: 仍然会捕获所有异常。

Python 3.0 的目标要求任何作为异常抛出的类都必须从 BaseException 或 BaseException 的子类派生，未来 Python 2.x 系列的版本可能会开始强制执行这一约束。因此，我建议你现在就开始让你的所有异常类从 Exception 派生。有人建议在 Python 3.0 中移除裸露的 except: 形式，但 Guido van Rossum 还未决定是否这样做。

在 Python 2.5 中，将字符串作为异常抛出，如 raise "Error occurred"，已被弃用，并会触发警告。目标是在几个版本后能够移除字符串异常功能。

参见

PEP 352 [https://www.python.org/dev/peps/pep-0352] - 异常所需的超类

PEP 由 Brett Cannon 和 Guido van Rossum 撰写，由 Brett Cannon 实现

PEP 353: 使用ssize_t作为索引类型

对 Python 的 C API 进行了广泛的更改，使用新的 Py_ssize_t 类型定义代替 int，这将允许解释器在 64 位平台上处理更多数据。这一更改不影响 Python 在 32 位平台上的能力。

Python解释器的各个部分使用C语言的 int 类型来存储大小或计数；例如，列表或元组中的项目数量存储在一个 int 中。大多数64位平台的C编译器仍然将 int 定义为32位类型，这意味着列表最多只能容纳 2**31 - 1 = 2147483647个项目。（实际上，64位C编译器可以使用几种不同的编程模型——参见 https://unix.org/version2/whatsnew/lp64_wp.html 进行讨论——但最常用的模型将 int 保留为32位。）

在32位平台上，2147483647个项目的限制实际上并不重要，因为在达到长度限制之前你就会耗尽内存。每个列表项需要为指针分配空间，指针为4字节，再加上表示该项的 PyObject 所需的空间。2147483647*4已经超过了32位地址空间所能容纳的字节数。

然而，在64位平台上，可以寻址这么多的内存。这么大列表的指针只需要16 GiB的空间，因此Python程序员可能会构造如此大的列表，这是合理的。因此，Python解释器必须改为使用某种不同于 int 的类型，并且在64位平台上这将是一个64位类型。这一变更将在64位机器上引起不兼容，因此现在进行过渡被认为是值得的，因为64位用户数量仍然相对较少。（在5年或10年后，我们可能 都 在使用64位机器，届时过渡会更加痛苦。）

这一变更对C扩展模块的作者影响最大。Python字符串和容器类型（如列表和元组）现在使用 Py_ssize_t 来存储其大小。诸如 PyList_Size() 之类的函数现在返回 Py_ssize_t。因此，扩展模块中的代码可能需要将一些变量改为 Py_ssize_t。

PyArg_ParseTuple() 和 Py_BuildValue() 函数新增了一个转换代码 n，用于 Py_ssize_t。PyArg_ParseTuple() 的 s# 和 t# 默认仍输出 int，但你可以在包含 Python.h 之前定义宏 PY_SSIZE_T_CLEAN，以使它们返回 Py_ssize_t。

PEP 353 [https://www.python.org/dev/peps/pep-0353] 中有一节关于转换指南的内容，扩展作者应阅读以了解如何支持64位平台。

参见

PEP 353 [https://www.python.org/dev/peps/pep-0353] - 使用ssize_t作为索引类型

PEP 由 Martin von Löwis 撰写并实现。

PEP 357: '__index__' 方法

NumPy 开发者遇到了一个问题，只能通过添加一个新的特殊方法 __index__() 来解决。在使用切片表示法时，如 [start:stop:step]，start、stop 和 step 索引的值都必须是整数或长整数。NumPy 定义了多种专门的整数类型，对应于8、16、32和64位的无符号和有符号整数，但没有方法表明这些类型可以用作切片索引。

切片不能直接使用现有的 __int__() 方法，因为该方法也用于实现强制转换为整数。如果切片使用 __int__()，浮点数也将成为合法的切片索引，这显然是不希望的行为。

相反，添加了一个新的特殊方法 __index__()。它不接受任何参数，返回一个整数，给出要使用的切片索引。例如：

class C:
    def __index__ (self):
        return self.value

返回值必须是 Python 整数或长整数。解释器将检查返回的类型是否正确，如果不满足此要求，将引发 TypeError。

A corresponding nb_index slot was added to the C-level PyNumberMethods structure to let C extensions implement this protocol. PyNumber_Index(obj) can be used in extension code to call the __index__() function and retrieve its result.

参见

PEP 357 [https://www.python.org/dev/peps/pep-0357] - 允许将任何对象用于切片

PEP 由 Travis Oliphant 撰写并实现。

其他语言特性修改

以下是 Python 2.5 针对核心 Python 语言的所有改变。

dict 类型新增了一个钩子，允许子类在字典中不包含某个键时提供默认值。当找不到键时，将调用字典的 __missing__(key) 方法。这个钩子用于在 collections 模块中实现新的 defaultdict 类。以下示例定义了一个字典，对于任何缺失的键返回零:

class zerodict (dict):
    def __missing__ (self, key):
        return 0

d = zerodict({1:1, 2:2})
print d[1], d[2]   # Prints 1, 2
print d[3], d[4]   # Prints 0, 0

8位字符串和Unicode字符串都新增了 partition(sep) 和 rpartition(sep) 方法，简化了常见的用例。

find(S) 方法通常用于获取一个索引，然后使用该索引来切片字符串，获取分隔符之前和之后的部分。partition(sep) 将这种模式浓缩为单个方法调用，返回一个包含分隔符之前子字符串、分隔符本身和分隔符之后子字符串的3元组。如果找不到分隔符，元组的第一个元素是整个字符串，其他两个元素为空。rpartition(sep) 也返回一个3元组，但从字符串末尾开始搜索；r 代表 'reverse'。

示例如下：

>>> ('http://www.python.org').partition('://')
('http', '://', 'www.python.org')
>>> ('file:/usr/share/doc/index.html').partition('://')
('file:/usr/share/doc/index.html', '', '')
>>> (u'Subject: a quick question').partition(':')
(u'Subject', u':', u' a quick question')
>>> 'www.python.org'.rpartition('.')
('www.python', '.', 'org')
>>> 'www.python.org'.rpartition(':')
('', '', 'www.python.org')

（由 Fredrik Lundh 在 Raymond Hettinger 的建议下实现。）

现在字符串类型的 startswith() 和 endswith() 方法可接受字符串元组供检查。

def is_image_file (filename):
    return filename.endswith(('.gif', '.jpg', '.tiff'))

（由 Georg Brandl 实现，基于 Tom Lynn 的建议。）

min() 和 max() 内置函数新增了一个 key 关键字参数，类似于 sort() 的 key 参数。这个参数提供一个函数，该函数接受单个参数，并对列表中的每个值调用；min()/max() 将返回该函数返回值最小/最大的元素。例如，要找到列表中最长的字符串，可以这样做:

L = ['medium', 'longest', 'short']
# Prints 'longest'
print max(L, key=len)
# Prints 'short', because lexicographically 'short' has the largest value
print max(L)

（由 Steven Bethard 和 Raymond Hettinger 贡献。）

两个新的内置函数，any() 和 all()，用于评估迭代器中是否包含任何真值或假值。any() 如果迭代器返回的任何值为真，则返回 True；否则返回 False。all() 只有当迭代器返回的所有值都为真时，才返回 True。（由 Guido van Rossum 建议，Raymond Hettinger 实现。）

类的 __hash__() 方法的返回结果现在可以是长整数或常规整数。如果返回的是长整数，则取该值的哈希。在早期版本中，哈希值必须是常规整数，但在 2.5 版中，id() 内置函数被改为总是返回非负数，用户通常在 __hash__() 方法中使用 id(self) (尽管不推荐这样做) 。

ASCII 现在是模块的默认编码。如果模块包含带有 8 位字符的字符串字面量但没有编码声明，则会引发语法错误。在 Python 2.4 中，这会触发警告，而不是语法错误。参见 PEP 263 [https://www.python.org/dev/peps/pep-0263] 了解如何声明模块的编码；例如，你可以在源文件顶部附近添加如下行：

# -*- coding: latin1 -*-

一个新的警告，UnicodeWarning，在你尝试比较一个 Unicode 字符串和一个无法使用默认 ASCII 编码转换为 Unicode 的 8 位字符串时触发。比较的结果为假：

>>> chr(128) == unichr(128)   # Can't convert chr(128) to Unicode
__main__:1: UnicodeWarning: Unicode equal comparison failed
  to convert both arguments to Unicode - interpreting them
  as being unequal
False
>>> chr(127) == unichr(127)   # chr(127) can be converted
True

以前这会引发一个 UnicodeDecodeError 异常，但在2.5版本中，这可能会导致在访问字典时出现令人困惑的问题。如果你查找 unichr(128) 而 chr(128) 被用作键，你会得到一个 UnicodeDecodeError 异常。2.5版本中的其他更改导致这个异常被抛出，而不是被实现字典的 dictobject.c 中的代码抑制。

对于这种比较引发异常是严格正确的，但这个更改可能会破坏代码，所以引入了 UnicodeWarning。

（由 Marc-André Lemburg 实现。）

Python程序员有时会犯的一个错误是忘记在包目录中包含一个 __init__.py 模块。调试这个错误可能会令人困惑，通常需要使用 -v 开关运行Python来记录所有搜索的路径。在Python 2.5中，当导入操作本应将一个目录作为包但未找到 __init__.py 时，会触发新的 ImportWarning 警告。默认情况下，这个警告被静默忽略；在运行Python可执行文件时提供 -Wd 选项来显示警告消息。（由 Thomas Wouters 实现。）

类定义中的基类列表现在可以是空的。例如，以下现在是合法的:

class C():
    pass

（由 Brett Cannon 实现。）

交互解释器变更

在交互式解释器中，quit 和 exit 长期以来一直是字符串，以便新用户在尝试退出时得到一些有帮助的消息:

>>> quit
'Use Ctrl-D (i.e. EOF) to exit.'

在Python 2.5中，quit 和 exit 现在是对象，它们仍然产生自己的字符串表示，但也是可调用的。新手尝试 quit() 或 exit() 现在将如他们所期望的那样退出解释器。（由Georg Brandl实现。）

Python可执行文件现在接受标准的长选项 --help 和 --version；在Windows上，它还接受 /? 选项来显示帮助消息。（由 Georg Brandl 实现。）

性能优化

多项优化是在2006年5月21日至28日在冰岛雷克雅未克举行的NeedForSpeed冲刺活动中开发的。该冲刺活动专注于提升CPython实现的速度，由EWT LLC资助，并得到了CCP Games的本地支持。在此冲刺中添加的优化在以下列表中特别标注。

在Python 2.4中引入时，内置的 set 和 frozenset 类型是基于Python的字典类型构建的。在2.5中，内部数据结构已为实现集合进行了定制，因此集合将使用少三分之一的内存，并且速度有所提高。（由 Raymond Hettinger 实现。）

一些Unicode操作的速度，如查找子字符串、字符串分割以及字符映射的编码和解码，已得到提升。（子字符串搜索和分割改进由Fredrik Lundh和Andrew Dalke在NeedForSpeed冲刺中添加。字符映射由Walter Dörwald和Martin von Löwis改进。）

long(str, base) 函数现在在处理长数字字符串时更快，因为计算的中间结果更少。峰值出现在约 800 到 1000 位的字符串上，此时函数速度提升了 6 倍。（由 Alan McIntyre 贡献，并在 NeedForSpeed 冲刺中提交。）

It's now illegal to mix iterating over a file with for line in file and calling the file object's read()/readline()/readlines() methods. Iteration uses an internal buffer and the read*() methods don't use that buffer. Instead they would return the data following the buffer, causing the data to appear out of order. Mixing iteration and these methods will now trigger a ValueError from the read*() method. (Implemented by Thomas Wouters.)

struct 模块现在将结构格式字符串编译成内部表示并缓存此表示，从而提高了20%的速度。（由Bob Ippolito在NeedForSpeed冲刺中贡献。）

re 模块通过切换到 Python 的分配器函数而不是系统的 malloc() 和 free()，获得了 1% 到 2% 的速度提升。（由 Jack Diederich 在 NeedForSpeed sprint 中贡献。）

代码生成器的窥孔优化器现在可以在表达式中执行简单的常量折叠。如果你写类似 a = 2+3 的代码，代码生成器将进行算术运算并生成对应于 a = 5 的代码。（由 Raymond Hettinger 提议并实现。）

函数调用现在更快了，因为代码对象现在将最近完成的帧（一个“僵尸帧”）保存在代码对象的内部字段中，下次调用代码对象时重用它。（原始补丁由 Michael Hudson 提供，由 Armin Rigo 和 Richard Jones 修改；在 NeedForSpeed sprint 中提交。）帧对象也稍微变小了，这可能会改善缓存局部性并略微减少内存使用。（由 Neal Norwitz 贡献。）

Python 的内置异常现在都是新式类，这一改变显著加快了实例化速度。因此，Python 2.5 中的异常处理比 2.4 快约 30%。（由 Richard Jones、Georg Brandl 和 Sean Reifschneider 在 NeedForSpeed sprint 中贡献。）

导入现在会缓存尝试过的路径，记录它们是否存在，以便解释器在启动时减少对 open() 和 stat() 的调用。（由 Martin von Löwis 和 Georg Brandl 贡献。）

新增，改进和删除的模块

Python 2.5 中的标准库收到了许多增强和 bug 修复。以下是按模块名称字母顺序排序的最显著变化的部分列表。查阅源树中的 Misc/NEWS 文件以获取更完整的变化列表，或通过 SVN 日志查看所有详细信息。

The audioop module now supports the a-LAW encoding, and the code for u-LAW encoding has been improved. (Contributed by Lars Immisch.)

codecs 模块增加了对增量编解码器的支持。codec.lookup() 函数现在返回一个 CodecInfo 实例，而不是一个元组。CodecInfo 实例表现得像一个4元组，以保持向后兼容性，但同时也具有以下属性：encode、decode、incrementalencoder、incrementaldecoder、streamwriter 和 streamreader。增量编解码器可以分多次接收输入并生成输出；输出与非增量编解码器一次性接收全部输入的输出相同。详细信息请参阅 codecs 模块文档。（由 Walter Dörwald 设计并实现。）

collections 模块新增了一种类型，defaultdict，它是标准 dict 类型的子类。这种新类型在大多数情况下表现得像字典，但当键不存在时，会构造一个默认值，并自动将其添加到字典中，对应请求的键值。

defaultdict 构造函数的第一个参数是一个工厂函数，当请求的键未找到时，会调用此函数。这个工厂函数不接受任何参数，因此你可以使用内置类型构造函数，如 list() 或 int()。例如，你可以按首字母创建一个单词索引，如下所示：

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)

打印 index 导致以下输出:

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']}

（由 Guido van Rossum 贡献。）

deque 双端队列类型由 collections 模块提供，现在新增了 remove(value) 方法，用于移除队列中第一次出现的 value，如果未找到该值则抛出 ValueError。（由 Raymond Hettinger 贡献。）

新模块：contextlib 模块包含用于新 'with' 语句的辅助函数。更多信息请参见 contextlib 模块 部分。

新模块：cProfile 模块是现有 profile 模块的 C 语言实现，具有更低的开销。该模块的接口与 profile 相同：你可以通过运行 cProfile.run('main()') 来分析函数，可以将分析数据保存到文件等。目前尚不清楚 Hotshot 分析器（同样用 C 语言编写，但接口与 profile 模块不匹配）是否会在 Python 的未来版本中继续维护。（由 Armin Rigo 贡献。）

此外，用于分析分析器测量数据的 pstats 模块现在支持通过向 Stats 构造函数提供 stream 参数来将输出定向到任何文件对象。（由 Skip Montanaro 贡献。）

csv 模块用于解析逗号分隔值格式的文件，收到了多项增强和多个 bug 修复。你现在可以通过调用 csv.field_size_limit(new_limit) 函数来设置字段的最大字节数；省略 new_limit 参数将返回当前设置的限值。reader 类现在有一个 line_num 属性，用于计数从源文件读取的物理行数；记录可以跨越多个物理行，因此 line_num 与读取的记录数不同。

CSV解析器现在对多行引号字段更为严格。之前，如果在引号字段内一行结束而没有终止换行符，会在返回的字段中插入一个换行符。这种行为在读取字段内包含回车字符的文件时会导致问题，因此代码已更改，返回字段时不插入换行符。因此，如果字段内嵌入的换行符很重要，输入应在保持换行符的方式下拆分成行。

（由Skip Montanaro 和 Andrew McNamara 贡献。）

datetime 模块中的 datetime 类现在有一个 strptime(string, format) 方法用于解析日期字符串，由Josh Spoerri贡献。它使用与 time.strptime() 和 time.strftime() 相同的格式字符：

from datetime import datetime

ts = datetime.strptime('10:13:15 2006-03-07',
                       '%H:%M:%S %Y-%m-%d')

difflib 模块中的 SequenceMatcher.get_matching_blocks() 方法现在保证返回描述匹配子序列的最小块列表。之前，算法偶尔会将一个匹配元素块拆分成两个列表条目。（由Tim Peters增强。）

doctest 模块增加了一个 SKIP 选项，用于完全跳过示例的执行。这是为了那些作为读者使用示例的代码片段，而不是实际的测试用例。

在 testfile() 函数和 DocFileSuite 类中添加了 encoding 参数，用于指定文件的编码。这使得在文档字符串中包含的测试中使用非ASCII字符变得更加容易。（由Bjorn Tillenius贡献。)

email 包已经升级到 4.0版 （由 Barry Warsaw 贡献）

The fileinput module was made more flexible. Unicode filenames are now supported, and a mode parameter that defaults to "r" was added to the input() function to allow opening files in binary or universal newlines mode. Another new parameter, openhook, lets you use a function other than open() to open the input files. Once you're iterating over the set of files, the FileInput object's new fileno() returns the file descriptor for the currently opened file. (Contributed by Georg Brandl.)

在 gc 模块中，新的 get_count() 函数返回一个包含三个 GC 世代当前收集计数的 3 元组。这是垃圾收集器的统计信息；当这些计数达到指定阈值时，将进行垃圾收集扫描。现有的 gc.collect() 函数现在接受一个可选的 generation 参数，值为 0、1 或 2，以指定要收集的世代。（由 Barry Warsaw 贡献。）

heapq 模块中的 nsmallest() 和 nlargest() 函数现在支持类似于 min()/max() 函数和 sort() 方法提供的 key 关键字参数。例如：

>>> import heapq
>>> L = ["short", 'medium', 'longest', 'longer still']
>>> heapq.nsmallest(2, L)  # Return two lowest elements, lexicographically
['longer still', 'longest']
>>> heapq.nsmallest(2, L, key=len)   # Return two shortest elements
['short', 'medium']

（由 Raymond Hettinger 贡献。）

itertools.islice() 函数现在接受 None 作为 start 和 step 参数。这使得它与切片对象的属性更加兼容，因此你现在可以写出以下代码：

s = slice(5)     # Create slice object
itertools.islice(iterable, s.start, s.stop, s.step)

（由 Raymond Hettinger 贡献。）

locale 模块中的 format() 函数已被修改，并添加了两个新函数：format_string() 和 currency()。

format() 函数的 val 参数以前可以是字符串，只要不超过一个 %char 指定符；现在该参数必须正好是一个 %char 指定符，且周围没有文本。还添加了一个可选的 monetary 参数，如果为 True，将使用区域设置的规则来格式化货币，在每三位数字之间放置分隔符。

要格式化带有多个 %char 指定符的字符串，请使用新的 format_string() 函数，它类似于 format()，但还支持将 %char 指定符与任意文本混合。

还添加了一个新的 currency() 函数，它根据当前区域设置的规则来格式化数字。

（由Georg Brandl 贡献。）

mailbox 模块进行了大规模重写，以增加修改邮箱的能力，而不仅仅是读取邮箱。一组新的类，包括 mbox、MH 和 Maildir，用于读取邮箱，并具有 add(message) 方法来添加消息，remove(key) 来删除消息，以及 lock()/unlock() 来锁定/解锁邮箱。以下示例将 maildir 格式的邮箱转换为 mbox 格式的邮箱：

import mailbox

# 'factory=None' uses email.Message.Message as the class representing
# individual messages.
src = mailbox.Maildir('maildir', factory=None)
dest = mailbox.mbox('/tmp/mbox')

for msg in src:
    dest.add(msg)

（由 Gregory K. Johnson 贡献。资金由 Google 2005 年夏季代码提供。）

New module: the msilib module allows creating Microsoft Installer .msi files and CAB files. Some support for reading the .msi database is also included. (Contributed by Martin von Löwis.)

The nis module now supports accessing domains other than the system default domain by supplying a domain argument to the nis.match() and nis.maps() functions. (Contributed by Ben Bell.)

operator 模块的 itemgetter() 和 attrgetter() 函数现在支持多个字段。例如，调用 operator.attrgetter('a', 'b') 将返回一个函数，该函数检索 a 和 b 属性。结合这一新特性与 sort() 方法的 key 参数，可以轻松地使用多个字段对列表进行排序。（由 Raymond Hettinger 贡献。）

optparse 模块已更新至 Optik 库的 1.5.1 版本。OptionParser 类新增了 epilog 属性，该字符串将在帮助信息后打印，并新增了 destroy() 方法以打破对象创建的引用循环。（由 Greg Ward 贡献。）

os 模块进行了多项更改。stat_float_times 变量现在默认为 true，意味着 os.stat() 将返回浮点数形式的时间值。（这并不一定意味着 os.stat() 返回的时间精确到秒的小数部分；并非所有系统都支持这种精度。）

Constants named os.SEEK_SET, os.SEEK_CUR, and os.SEEK_END have been added; these are the parameters to the os.lseek() function. Two new constants for locking are os.O_SHLOCK and os.O_EXLOCK.

添加了两个新函数 wait3() 和 wait4()。它们类似于 waitpid() 函数，后者等待子进程退出并返回进程 ID 及其退出状态的元组，但 wait3() 和 wait4() 返回更多信息。wait3() 不接受进程 ID 作为输入，因此它等待任何子进程退出并返回一个 3 元组，包括 process-id、exit-status 和 resource-usage，这些信息来自 resource.getrusage() 函数。wait4(pid) 接受进程 ID。（由 Chad J. Schroeder 贡献。）

在 FreeBSD 上，os.stat() 函数现在返回具有纳秒分辨率的时间，返回的对象现在包含 st_gen 和 st_birthtime。如果平台支持，st_flags 属性也可用。（由 Antti Louko 和 Diego Pettenò 贡献。）

pdb 模块提供的 Python 调试器现在可以存储一系列命令，当达到断点并停止执行时执行这些命令。一旦创建了断点 #1，输入 commands 1 并输入一系列要执行的命令，最后用 end 结束列表。命令列表可以包括恢复执行的命令，如 continue 或 next。（由 Grégoire Dooms 贡献。）

The pickle and cPickle modules no longer accept a return value of None from the __reduce__() method; the method must return a tuple of arguments instead. The ability to return None was deprecated in Python 2.4, so this completes the removal of the feature.

pkgutil 模块包含用于查找包的各种实用函数，已增强以支持 PEP 302 [https://www.python.org/dev/peps/pep-0302] 的导入钩子，现在也适用于存储在 ZIP 格式归档中的包。（由 Phillip J. Eby 贡献。）

Marc-André Lemburg 开发的 pybench 基准测试套件现在包含在 Tools/pybench 目录中。pybench 套件是对常用的 pystone.py 程序的改进，因为 pybench 提供了对解释器速度的更详细测量。它计时特定操作，如函数调用、元组切片、方法查找和数值操作，而不是执行许多不同操作并将结果简化为一个数字，如 pystone.py 所做的那样。

pyexpat 模块现在使用 Expat 解析器的 2.0 版。 （由 Trent Mick 贡献。）

Queue 类由 Queue 模块提供，新增了两个方法。join() 方法会阻塞，直到队列中的所有项都被检索并完成所有处理工作。工作线程调用另一个新方法 task_done()，以指示某项的处理已完成。（由 Raymond Hettinger 贡献。）

自 Python 2.0 起已被弃用的旧模块 regex 和 regsub 终于被删除。其他被删除的模块包括：statcache、tzparse、whrandom。

同样被删除的还有 lib-old 目录，该目录包含古老的模块如 dircmp 和 ni，已被移除。lib-old 不在默认的 sys.path 中，因此除非你的程序显式将该目录添加到 sys.path，否则此次移除不应影响你的代码。

rlcompleter 模块不再依赖于导入 readline 模块，因此现在可以在非 Unix 平台上工作。（由 Robert Kiendl 提供的补丁。）

The SimpleXMLRPCServer and DocXMLRPCServer classes now have a rpc_paths attribute that constrains XML-RPC operations to a limited set of URL paths; the default is to allow only '/' and '/RPC2'. Setting rpc_paths to None or an empty tuple disables this path checking.

由于 Philippe Biondi 提供的补丁，socket 模块现在在 Linux 上支持 AF_NETLINK 套接字。Netlink 套接字是 Linux 特有的用户空间进程与内核代码之间的通信机制；关于它们的入门文章见 https://www.linuxjournal.com/article/7356。在 Python 代码中，netlink 地址表示为两个整数的元组 (pid, group_mask)。

套接字对象上的两个新方法 recv_into(buffer) 和 recvfrom_into(buffer) 将接收到的数据存储在支持缓冲协议的对象中，而不是将数据作为字符串返回。这意味着你可以直接将数据放入数组或内存映射文件中。

套接字对象还增加了 getfamily()、gettype() 和 getproto() 访问器方法，用于检索套接字的族、类型和协议值。

New module: the spwd module provides functions for accessing the shadow password database on systems that support shadow passwords.

struct 模块现在更快了，因为它将格式字符串编译成具有 pack() 和 unpack() 方法的 Struct 对象。这类似于 re 模块允许你创建编译后的正则表达式对象。你仍然可以使用模块级别的 pack() 和 unpack() 函数；它们会创建并缓存 Struct 对象。或者你可以直接使用 Struct 实例：

s = struct.Struct('ih3s')

data = s.pack(1972, 187, 'abc')
year, number, name = s.unpack(data)

你还可以使用 pack_into(buffer, offset, v1, v2, ...) 和 unpack_from(buffer, offset) 方法直接将数据打包和解包到缓冲对象中。这允许你直接将数据存储到数组或内存映射文件中。

（Struct 对象由 Bob Ippolito 在 NeedForSpeed sprint 中实现。缓冲对象的支持由 Martin Blais 在同一 sprint 中添加。）

Python 开发者在 2.5 开发过程中从 CVS 切换到 Subversion。关于确切构建版本的信息可通过 sys.subversion 变量获取，这是一个包含 (解释器名称, 分支名称, 版本范围) 的 3 元组。例如，在撰写本文时，我的 2.5 版本报告为 ('CPython', 'trunk', '45313:45315')。

此信息也可通过 Py_GetBuildInfo() 函数供 C 扩展使用，该函数返回一个构建信息字符串，例如："trunk:45355:45356M, Apr 13 2006, 07:42:19"。 (由 Barry Warsaw 贡献。)

另一个新函数 sys._current_frames() 返回所有运行线程的当前堆栈帧，作为字典映射，其中线程标识符映射到在该函数调用时该线程中当前活动的最顶层堆栈帧。 (由 Tim Peters 贡献。)

tarfile 模块中的 TarFile 类现在有一个 extractall() 方法，用于将存档中的所有成员提取到当前工作目录。也可以设置不同的目录作为提取目标，并且可以选择仅解压存档的子集成员。

在流模式下打开的 tarfile 的压缩类型现在可以通过模式 'r|*' 自动检测。 (由 Lars Gustäbel 贡献。)

threading 模块现在允许你设置创建新线程时使用的堆栈大小。stack_size([*size*]) 函数返回当前配置的堆栈大小，提供可选的 size 参数可以设置新值。并非所有平台都支持更改堆栈大小，但 Windows、POSIX 线程和 OS/2 都支持。 (由 Andrew MacIntyre 贡献。)

The unicodedata module has been updated to use version 4.1.0 of the Unicode character database. Version 3.2.0 is required by some specifications, so it's still available as unicodedata.ucd_3_2_0.

新模块：uuid 模块根据 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 生成通用唯一标识符（UUID）。RFC 定义了几种不同的 UUID 版本，这些版本可以从起始字符串、系统属性或纯随机生成。此模块包含一个 UUID 类和名为 uuid1()、uuid3()、uuid4() 和 uuid5() 的函数，用于生成不同版本的 UUID。（版本 2 的 UUID 在 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 中未指定，且此模块不支持。）:

>>> 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')

（由 Ka-Ping Yee 贡献。）

weakref 模块的 WeakKeyDictionary 和 WeakValueDictionary 类型新增了用于迭代字典中包含的弱引用的方法。WeakKeyDictionary 添加了 iterkeyrefs() 和 keyrefs() 方法，WeakValueDictionary 添加了 itervaluerefs() 和 valuerefs() 方法。（由 Fred L. Drake, Jr. 贡献。）

webbrowser 模块获得了一系列增强。现在可以作为脚本使用，通过 python -m webbrowser 命令，并接受一个 URL 作为参数；还有一些开关用于控制行为（-n 用于新浏览器窗口，-t 用于新标签页）。新增了模块级别的函数 open_new() 和 open_new_tab() 以支持这一功能。模块的 open() 函数支持一个附加特性，即 autoraise 参数，用于指示是否在可能的情况下提升打开的窗口。支持的浏览器列表中新增了 Firefox、Opera、Konqueror 和 elinks 等浏览器。（由 Oleg Broytmann 和 Georg Brandl 贡献。）

The xmlrpclib module now supports returning datetime objects for the XML-RPC date type. Supply use_datetime=True to the loads() function or the Unmarshaller class to enable this feature. (Contributed by Skip Montanaro.)

zipfile 模块现在支持 ZIP64 版本的格式，这意味着 .zip 归档文件现在可以大于 4 GiB，并且可以包含大于 4 GiB 的单个文件。（由 Ronald Oussoren 贡献。）

zlib 模块的 Compress 和 Decompress 对象现在支持 copy() 方法，该方法复制对象的内部状态并返回一个新的 Compress 或 Decompress 对象。（由 Chris AtLee 贡献。）

ctypes 包

The ctypes package, written by Thomas Heller, has been added to the standard library. ctypes lets you call arbitrary functions in shared libraries or DLLs. Long-time users may remember the dl module, which provides functions for loading shared libraries and calling functions in them. The ctypes package is much fancier.

要加载共享库或DLL，你必须创建一个 CDLL 类的实例，并提供共享库或DLL的名称或路径。完成后，你可以通过将其作为 CDLL 对象的属性来调用任意函数。

import ctypes

libc = ctypes.CDLL('libc.so.6')
result = libc.printf("Line of output\n")

为各种C类型提供了类型构造器：c_int()、c_float()、c_double()、c_char_p() (等同于 char*) 等等。与Python的类型不同，C版本都是可变的；你可以分配给它们的 value 属性来更改包装的值。Python整数和字符串将自动转换为相应的C类型，但对于其他类型，你必须调用正确的类型构造器。（我是说 必须；弄错了通常会导致解释器崩溃，出现段错误。）

当C函数将修改内存区域时，你不应该使用 c_char_p() 与Python字符串，因为Python字符串应该是不可变的；违反这一规则会导致令人困惑的bug。当你需要一个可修改的内存区域时，请使用 create_string_buffer():

s = "this is a string"
buf = ctypes.create_string_buffer(s)
libc.strfry(buf)

C函数默认返回整数，但你可以设置函数对象的 restype 属性来更改这一点:

>>> libc.atof('2.71828')
-1783957616
>>> libc.atof.restype = ctypes.c_double
>>> libc.atof('2.71828')
2.71828

ctypes also provides a wrapper for Python's C API as the ctypes.pythonapi object. This object does not release the global interpreter lock before calling a function, because the lock must be held when calling into the interpreter's code. There's a py_object() type constructor that will create a PyObject* pointer. A simple usage:

import ctypes

d = {}
ctypes.pythonapi.PyObject_SetItem(ctypes.py_object(d),
          ctypes.py_object("abc"),  ctypes.py_object(1))
# d is now {'abc', 1}.

Don't forget to use py_object(); if it's omitted you end up with a segmentation fault.

ctypes 已经存在一段时间了，但人们仍然编写和分发手工编码的扩展模块，因为你不能依赖 ctypes 的存在。也许开发者现在会开始编写通过 ctypes 访问库的 Python 包装器，而不是扩展模块，因为 ctypes 已包含在核心 Python 中。

参见

https://web.archive.org/web/20180410025338/http://starship.python.net/crew/theller/ctypes/

pre-stdlib ctypes 网页，包括教程、参考资料和常见问题。

ctypes 模块的文档。

ElementTree 包

Fredrik Lundh 的 ElementTree 库用于处理 XML 的一个子集已被添加到标准库中，作为 xml.etree。可用的模块有 ElementTree、ElementPath 和来自 ElementTree 1.2.6 的 ElementInclude。cElementTree 加速模块也包括在内。

本节的剩余部分将提供使用 ElementTree 的简要说明。 要获取 ElementTree 的完整文档可访问 https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm。

ElementTree 将 XML 文档表示为元素节点的树。文档的文本内容存储为 (这是 ElementTree 和文档对象模型之间的主要区别之一；在 DOM 中有许多不同类型的节点，包括 TextNode。) 的 text 和 tail 属性。

最常用的解析函数是 parse()，它接受一个字符串（假设包含文件名）或文件类对象，并返回一个 ElementTree 实例:

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)

一旦你有一个 ElementTree 实例，你可以调用它的 getroot() 方法来获取根 Element 节点。

还有一个 XML() 函数，它接受一个字符串字面量并返回一个 Element 节点（而不是一个 ElementTree）。这个函数提供了一种整洁的方式来嵌入 XML 片段，接近于 XML 字面量的便利性：

svg = ET.XML("""<svg width="10px" version="1.0">
             </svg>""")
svg.set('height', '320px')
svg.append(elem1)

每个 XML 元素都支持一些类似字典和类似列表的访问方法。类似字典的操作用于访问属性值，而类似列表的操作用于访问子节点。

运算 | 结果：
elem[n] | 返回第n个子元素
elem[m:n] | 返回第m至第n个子元素的列表。
len(elem) | 返回子元素的个数
list(elem) | 返回子元素的列表
elem.append(elem2) | 将 elem2 添加为子级。
elem.insert(index, elem2) | 在指定位置插入 elem2 。
del elem[n] | 删除第n个子元素
elem.keys() | 返回属性名称的列表。
elem.get(name) | 返回 name 属性的值。
elem.set(name, value) | 为 name 属性设置新值
elem.attrib | 检索包含属性的字典。
del elem.attrib[name] | 删除 元素 name 的属性

注释和处理指令也以 Element 节点的形式表示。要检查一个节点是否是注释或处理指令：

if elem.tag is ET.Comment:
    ...
elif elem.tag is ET.ProcessingInstruction:
    ...

要生成 XML 输出，应调用 ElementTree.write() 方法。与 parse() 类似，它既可以接受一个字符串，也可以接受一个类似文件的对象：

# Encoding is US-ASCII
tree.write('output.xml')

# Encoding is UTF-8
f = open('output.xml', 'w')
tree.write(f, encoding='utf-8')

（注意：输出的默认编码是 ASCII。对于一般的 XML 工作，其中元素的名称可能包含任意的 Unicode 字符，ASCII 不是一个非常有用的编码，因为它会在元素名称包含任何值大于 127 的字符时引发异常。因此，最好指定一个不同的编码，如 UTF-8，它可以处理任何 Unicode 字符。）

本节仅对 ElementTree 接口进行了部分描述。请阅读包的官方文档以获取更多详细信息。

参见

https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm

ElementTree 的官方文档

hashlib 包

A new hashlib module, written by Gregory P. Smith, has been added to replace the md5 and sha modules. hashlib adds support for additional secure hashes (SHA-224, SHA-256, SHA-384, and SHA-512). When available, the module uses OpenSSL for fast platform optimized implementations of algorithms.

The old md5 and sha modules still exist as wrappers around hashlib to preserve backwards compatibility. The new module's interface is very close to that of the old modules, but not identical. The most significant difference is that the constructor functions for creating new hashing objects are named differently.

# Old versions
h = md5.md5()
h = md5.new()

# New version
h = hashlib.md5()

# Old versions
h = sha.sha()
h = sha.new()

# New version
h = hashlib.sha1()

# Hash that weren't previously available
h = hashlib.sha224()
h = hashlib.sha256()
h = hashlib.sha384()
h = hashlib.sha512()

# Alternative form
h = hashlib.new('md5')          # Provide algorithm as a string

一旦创建了哈希对象，其方法与之前相同：update(string) 将指定的字符串哈希到当前摘要状态中，digest() 和 hexdigest() 分别返回二进制字符串或十六进制数字字符串的摘要值，copy() 返回具有相同摘要状态的新哈希对象。

参见

hashlib 模块的文档。

sqlite3 包

pysqlite 模块 (https://www.pysqlite.org) 是 SQLite 嵌入式数据库的封装器，已添加到标准库中，软件包名称为 sqlite3。

SQLite 是一个C语言库，它可以提供一种轻量级的基于磁盘的数据库，这种数据库不需要独立的服务器进程，也允许需要使用一种非标准的 SQL 查询语言来访问它。一些应用程序可以使用 SQLite 作为内部数据存储。可以用它来创建一个应用程序原型，然后再迁移到更大的数据库，比如 PostgreSQL 或 Oracle。

pysqlite 由 Gerhard Häßing 编写，提供了一个符合 PEP 249 [https://www.python.org/dev/peps/pep-0249] 描述的 DB-API 2.0 规范的 SQL 接口。

如果您自己编译 Python 源代码，请注意源代码树不包含 SQLite 代码，只包含封装模块。在编译 Python 之前，您需要安装 SQLite 库和头文件，当必要的头文件可用时，编译过程将编译模块。

要使用该模块，你必须首先创建一个表示数据库的 Connection 对象。这里数据将存储在 /tmp/example 文件中:

conn = sqlite3.connect('/tmp/example')

你也可以使用 :memory: 来创建一个内存中的数据库

一旦你有了 Connection，你可以创建一个 Cursor 对象并调用其 execute() 方法来执行 SQL 命令:

c = conn.cursor()

# Create table
c.execute('''create table stocks
(date text, trans text, symbol text,
 qty real, price real)''')

# Insert a row of data
c.execute("""insert into stocks
          values ('2006-01-05','BUY','RHAT',100,35.14)""")

通常，您的 SQL 操作需要使用来自 Python 变量的值。 您不应该使用 Python 的字符串操作来组装您的查询，因为这样做是不安全的，它会使您的程序容易受到 SQL 注入攻击。

相反，使用 DB-API 的参数替换。在需要使用值的任何位置放置 ? 作为占位符，然后将值的元组作为第二个参数传递给游标的 execute() 方法。（其他数据库模块可能使用不同的占位符，例如 %s 或 :1。）例如：

# Never do this -- insecure!
symbol = 'IBM'
c.execute("... where symbol = '%s'" % symbol)

# Do this instead
t = (symbol,)
c.execute('select * from stocks where symbol=?', t)

# Larger example
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)

在执行 SELECT 语句后检索数据，可以将游标视为迭代器，调用游标的 fetchone() 方法检索单个匹配行，或者调用 fetchall() 获取匹配行的列表。

下面是一个使用迭代器形式的例子：

>>> 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)
>>>

有关 SQLite 所支持的 SQL 方法的更多信息，请参阅 https://www.sqlite.org。

参见

https://www.pysqlite.org

pysqlite 的主页

https://www.sqlite.org

SQLite的主页；它的文档详细描述了它所支持的 SQL 方言的语法和可用的数据类型。

sqlite3 模块的文档。

PEP 249 [https://www.python.org/dev/peps/pep-0249] - DB-API 2.0 规范

PEP 由 Marc-André Lemburg 撰写。

wsgiref 包

Web 服务器网关接口 (WSGI) v1.0 定义了 Web 服务器和 Python Web 应用程序之间的标准接口，并在 PEP 333 [https://www.python.org/dev/peps/pep-0333] 中进行了描述。wsgiref 包是 WSGI 规范的参考实现。

该软件包包含一个基本 HTTP 服务器，可运行 WSGI 应用程序；该服务器可用于调试，但不打算用于生产环境。设置服务器只需几行代码：

from wsgiref import simple_server

wsgi_app = ...

host = ''
port = 8000
httpd = simple_server.make_server(host, port, wsgi_app)
httpd.serve_forever()

参见

https://web.archive.org/web/20160331090247/http://wsgi.readthedocs.org/en/latest/

WSGI相关资源的核心网站。

PEP 333 [https://www.python.org/dev/peps/pep-0333] - Python Web服务器网关接口 v1.0

PEP 由 Phillip J. Eby 撰写

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

Python 源代码树从 CVS 转换为 Subversion，这一复杂的迁移过程由 Martin von Löwis 监督并完美执行。该过程按 PEP 347 [https://www.python.org/dev/peps/pep-0347] 进行了开发。

Coverity 公司，一家销售名为 Prevent 的源代码分析工具的公司，提供了他们对 Python 源代码的检查结果。分析发现了大约 60 个错误，这些错误很快被修复。许多错误是引用计数问题，通常出现在错误处理代码中。详见 https://scan.coverity.com 了解统计数据。

C API 最大的变化来自 PEP 353 [https://www.python.org/dev/peps/pep-0353]，该提案修改了解释器，使其使用 Py_ssize_t 类型定义而不是 int。详见前文 PEP 353: 使用ssize_t作为索引类型 部分对此变化的讨论。

字节码编译器的设计发生了很大变化，不再通过遍历解析树生成字节码。相反，解析树被转换为抽象语法树（AST），然后遍历抽象语法树来生成字节码。

Python 代码可以通过使用内置的 compile() 函数并指定 _ast.PyCF_ONLY_AST 作为 flags 参数的值来获取 AST 对象:

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]

No official documentation has been written for the AST code yet, but PEP 339 [https://www.python.org/dev/peps/pep-0339] discusses the design. To start learning about the code, read the definition of the various AST nodes in Parser/Python.asdl. A Python script reads this file and generates a set of C structure definitions in Include/Python-ast.h. The PyParser_ASTFromString() and PyParser_ASTFromFile(), defined in Include/pythonrun.h, take Python source as input and return the root of an AST representing the contents. This AST can then be turned into a code object by PyAST_Compile(). For more information, read the source code, and then ask questions on 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 短暂开发活动的参与者。

Evan Jones 提出的 obmalloc 补丁，最初在 PyCon DC 2005 的一次演讲中描述，已被应用。Python 2.4 在 256K 大小的区域中分配小对象，但不释放这些区域。有了这个补丁，Python 将在区域为空时释放它们。净效果是，在某些平台上，当你分配许多对象时，删除这些对象后 Python 的内存使用可能会实际减少，并且内存可能会返回给操作系统。（由 Evan Jones 实现，并由 Tim Peters 重构。）

请注意，这一变化意味着扩展模块在分配内存时必须更加小心。Python 的 API 有许多不同的内存分配函数，它们被分组到不同的家族中。例如，PyMem_Malloc()、PyMem_Realloc() 和 PyMem_Free() 是一个用于分配原始内存的家族，而 PyObject_Malloc()、PyObject_Realloc() 和 PyObject_Free() 是另一个用于创建 Python 对象的家族。

Previously these different families all reduced to the platform's malloc() and free() functions. This meant it didn't matter if you got things wrong and allocated memory with the PyMem() function but freed it with the PyObject() function. With 2.5's changes to obmalloc, these families now do different things and mismatches will probably result in a segfault. You should carefully test your C extension modules with Python 2.5.

内置集合类型现在拥有官方的C API。调用 PySet_New() 和 PyFrozenSet_New() 创建新集合，使用 PySet_Add() 和 PySet_Discard() 添加和移除元素，以及使用 PySet_Contains() 和 PySet_Size() 检查集合的状态。（由 Raymond Hettinger 贡献。）

C代码现在可以通过调用 Py_GetBuildInfo() 函数获取Python解释器的确切修订信息，该函数返回一个包含构建信息的字符串，例如："trunk:45355:45356M, Apr 13 2006, 07:42:19"。（由 Barry Warsaw 贡献。）

Two new macros can be used to indicate C functions that are local to the current file so that a faster calling convention can be used. Py_LOCAL(type) declares the function as returning a value of the specified type and uses a fast-calling qualifier. Py_LOCAL_INLINE(type) does the same thing and also requests the function be inlined. If PY_LOCAL_AGGRESSIVE() is defined before python.h is included, a set of more aggressive optimizations are enabled for the module; you should benchmark the results to find out if these optimizations actually make the code faster. (Contributed by Fredrik Lundh at the NeedForSpeed sprint.)

PyErr_NewException(name, base, dict) 现在可以接受一个基类元组作为其 base 参数。（由 Georg Brandl 贡献。）

The PyErr_Warn() function for issuing warnings is now deprecated in favour of PyErr_WarnEx(category, message, stacklevel) which lets you specify the number of stack frames separating this function and the caller. A stacklevel of 1 is the function calling PyErr_WarnEx(), 2 is the function above that, and so forth. (Added by Neal Norwitz.)

CPython解释器仍然用C语言编写，但现在代码可以用C++编译器编译而不会出错。（由 Anthony Baxter、Martin von Löwis、Skip Montanaro 实现。）

The PyRange_New() function was removed. It was never documented, never used in the core code, and had dangerously lax error checking. In the unlikely case that your extensions were using it, you can replace it by something like the following:

range = PyObject_CallFunction((PyObject*) &PyRange_Type, "lll",
                              start, stop, step);

移植专属的改变

MacOS X (10.3 及更高版本): 模块的动态加载现在会使用 dlopen() 函数而不是 MacOS 专属的函数。

MacOS X：在 configure 脚本中添加了 --enable-universalsdk 开关，用于将解释器编译为通用二进制文件，能够在 PowerPC 和 Intel 处理器上运行。（由 Ronald Oussoren 贡献；bpo-2573 [https://bugs.python.org/issue?@action=redirect&bpo=2573]。）

Windows：.dll 已不再作为扩展模块的文件名扩展名支持。现在只搜索 .pyd 作为文件名扩展名。

移植到Python 2.5

本节列出了先前描述的可能需要修改你的代码的改变：

ASCII 现在是模块的默认编码。如果一个模块包含带有 8 位字符的字符串字面量但没有编码声明，现在会引发语法错误。在 Python 2.4 中，这会触发警告，而不是语法错误。

之前，生成器的 gi_frame 属性始终是一个帧对象。由于 PEP 342 [https://www.python.org/dev/peps/pep-0342] 中描述的更改（见 PEP 342: 生成器的新特性 部分），现在 gi_frame 可能是 None。

新增警告 UnicodeWarning，当尝试比较一个 Unicode 字符串和一个无法使用默认 ASCII 编码转换为 Unicode 的 8 位字符串时触发。之前此类比较会引发 UnicodeDecodeError 异常。

库：csv 模块现在对多行引用字段更为严格。如果你的文件中包含嵌入字段中的换行符，输入应按保留换行符的方式拆分为行。

库：locale 模块的 format() 函数之前会接受任何字符串，只要不超过一个 %char 指定符。在 Python 2.5 中，参数必须正好是一个 %char 指定符，且周围没有文本。

Library: The pickle and cPickle modules no longer accept a return value of None from the __reduce__() method; the method must return a tuple of arguments instead. The modules also no longer accept the deprecated bin keyword parameter.

Library: The SimpleXMLRPCServer and DocXMLRPCServer classes now have a rpc_paths attribute that constrains XML-RPC operations to a limited set of URL paths; the default is to allow only '/' and '/RPC2'. Setting rpc_paths to None or an empty tuple disables this path checking.

C API：许多函数现在使用 Py_ssize_t 而不是 int，以允许在 64 位机器上处理更多数据。扩展代码可能需要做出相同的更改，以避免警告并支持 64 位机器。有关此更改的讨论，请参阅前面的章节 PEP 353: 使用ssize_t作为索引类型。

C API：obmalloc 的更改意味着你必须小心，不要混合使用 PyMem_* 和 PyObject_* 系列函数。使用一个系列的 *_Malloc 分配的内存必须使用相应系列的 *_Free 函数释放。

致谢

作者感谢以下人员对本文各种草稿给予的建议，更正和协助： 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.

Python 2.4 有什么新变化

作者

A.M. Kuchling

本文介绍了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 以了解有关具体实现和设计原理的说明。

PEP 218: 内置集合对象

Python 2.3 引入了 sets 模块。 现在集合数据类型的 C 语言实现作为两个新的内置类型 set(iterable) 和 frozenset(iterable) 被添加到 Python 内核中。 它们为成员测试、消除序列中的重复数据以及并集、交集、差集和对称差集等数学运算提供了高速操作。

>>> a = set('abracadabra')              # form a set from a string
>>> 'z' in a                            # fast membership testing
False
>>> a                                   # unique letters in a
set(['a', 'r', 'b', 'c', 'd'])
>>> ''.join(a)                          # convert back into a string
'arbcd'

>>> b = set('alacazam')                 # form a second set
>>> a - b                               # letters in a but not in b
set(['r', 'd', 'b'])
>>> a | b                               # letters in either a or b
set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
>>> a & b                               # letters in both a and b
set(['a', 'c'])
>>> a ^ b                               # letters in a or b but not both
set(['r', 'd', 'b', 'm', 'z', 'l'])

>>> a.add('z')                          # add a new element
>>> a.update('wxy')                     # add multiple new elements
>>> a
set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
>>> a.remove('x')                       # take one element out
>>> a
set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])

frozenset() 类型是 set() 的不可变版本。 由于它是不可变且不可哈希的对象，因而可被用作字典的键或另一个集合的成员。

sets 模块仍被保留在标准库中，如果你想要子类化 Set 或 ImmutableSet 类时会很有用处。 目前还没有弃用该模块的计划。

参见

PEP 218 [https://www.python.org/dev/peps/pep-0218] - 添加内置Set对象类型

最初由 Greg Wilson 提出，由 Raymond Hettinger 最终实现。

PEP 237: 统一长整数和整数

这个PEP的漫长过渡过程始于Python 2.2，在Python 2.4中又向前迈出了一步。在2.3中，某些在int/long统一后行为不同的整数操作会触发 FutureWarning 警告，并返回限于32位或64位（取决于您的平台）的值。在2.4中，这些表达式不再产生警告，而是产生一个通常为长整数的不同结果。

问题表达式主要是左移和长十六进制和八进制常量。例如，2 << 32 在2.3中会引发警告，在32位平台上评估为0。在Python 2.4中，这个表达式现在返回正确答案，8589934592。

参见

PEP 237 [https://www.python.org/dev/peps/pep-0237] - 统一长整数和整数

原始PEP由 Moshe Zadka 和 GvR 撰写，2.4 的变更由 Kalle Svensson 实现。

PEP 289: 生成器表达式

Python 2.2中引入的迭代器特性和 itertools 模块使得编写循环遍历大数据集的程序变得更加容易，而无需将整个数据集一次性加载到内存中。列表推导式并不很适合这种场景，因为它们会产生一个包含所有项的Python列表对象。这不可避免地将所有对象拉入内存，如果数据集非常大，这可能会成为问题。当尝试编写函数式风格的程序时，自然会写出类似以下代码：

links = [link for link in get_all_links() if not link.followed]
for link in links:
    ...

代替：

for link in get_all_links():
    if link.followed:
        continue
    ...

第一种形式更简洁，可能也更易读，但如果你正在处理大量的链接对象，为了避免同时将所有链接对象加载到内存中，你将不得不编写第二种形式。

生成器表达式的工作方式类似于列表推导式，但不生成整个列表；相反，它们创建一个生成器，逐个返回元素。上述示例可以改写为：

links = (link for link in get_all_links() if not link.followed)
for link in links:
    ...

生成器表达式必须像上述示例那样写在括号内。函数调用所用的括号也算在内，因此如果你想要创建一个将立即传递给函数的迭代器，可以写成：

print sum(obj.count for obj in list_all_objects())

生成器表达式与列表推导式在各方面有细微的不同。最显著的是，循环变量（上述示例中的*obj*）在生成器表达式外部是不可访问的。列表推导式会将变量赋值为最后一个值；Python的未来版本将改变这一点，使列表推导式在这方面与生成器表达式一致。

参见

PEP 289 [https://www.python.org/dev/peps/pep-0289] - 生成器表达式

由Raymond Hettinger提出，Jiwon Seo实现，Hye-Shik Chang在早期进行了指导。

PEP 292: 更简单的字符串替换

标准库中的一些新类提供了将变量替换到字符串中的替代机制；这种替换风格可能更适合那些未经训练的用户需要编辑模板的应用程序。

按名称替换变量的常用方式是 % 运算符:

>>> '%(page)i: %(title)s' % {'page':2, 'title': 'The Best of Times'}
'2: The Best of Times'

在编写模板字符串时，很容易忘记在闭合括号后加上 i 或 s。如果模板在 Python 模块中，这并不是一个大问题，因为你可以运行代码，得到一个“不支持的格式字符” ValueError，然后修复这个问题。然而，考虑像 Mailman 这样的应用程序，其中模板字符串或翻译是由不了解 Python 语言的用户编辑的。向这些用户解释格式字符串的语法是很复杂的，如果他们犯了错误，很难向他们提供有用的反馈。

PEP 292 给 string 模块增加了一个 Template，它使用 $ 来表示替换:

>>> import string
>>> t = string.Template('$page: $title')
>>> t.substitute({'page':2, 'title': 'The Best of Times'})
'2: The Best of Times'

如果某个键在字典中找不到，substitute() 方法将引发 KeyError。 还有一个 safe_substitute() 方法则会忽略找不到的键:

>>> t = string.Template('$page: $title')
>>> t.safe_substitute({'page':3})
'3: $title'

参见

PEP 292 [https://www.python.org/dev/peps/pep-0292] - 更简单的字符串替换

由 Barry Warsaw 撰写并实现

PEP 318: 函数和方法的装饰器

Python 2.2 通过添加静态方法和类方法扩展了 Python 的对象模型，但它并没有扩展 Python 的语法来提供任何定义静态方法或类方法的新方式。相反，你必须以通常的方式编写一个 def 语句，并将生成的函数传递给一个 staticmethod() 或 classmethod() 函数，该函数会将函数包装成新类型的方法。你的代码会像这样:

class C:
   def meth (cls):
       ...

   meth = classmethod(meth)   # Rebind name to wrapped-up class method

如果方法非常长，很容易错过或忘记在函数体后调用 classmethod()。

初衷一直是添加一些语法来使这样的定义更易读，但在 2.2 发布时，一个好的语法并不明显。今天，一个好的语法 仍然 不明显，但用户希望更方便地访问这个特性；为了满足这一需求，添加了一个新的语法特性。

这个新特性被称为“函数装饰器”。这个名字源于 classmethod()、staticmethod() 及其同类函数在函数对象上存储额外信息的想法；它们在用更多细节 装饰 函数。

这种表示法借鉴了 Java，并使用 '@' 字符作为指示符。使用新语法，上面的例子会写成:

class C:

   @classmethod
   def meth (cls):
       ...

@classmethod 是 meth=classmethod(meth) 赋值的简写。更一般地，如果你有以下代码：

@A
@B
@C
def f ():
    ...

它等价于以下无装饰器的代码:

def f(): ...
f = A(B(C(f)))

装饰器必须放在函数定义的前一行，每行一个装饰器，不能与 def 语句在同一行，这意味着 @A def f(): ... 是非法的。你只能装饰模块级别或类内部的函数定义；不能装饰类定义。

装饰器只是一个函数，它接受要装饰的函数作为参数，并返回相同的函数或某个新对象。装饰器的返回值不一定是可调用的（尽管通常是这样），除非将进一步应用装饰器到结果上。编写自己的装饰器很容易。以下简单示例只是在函数对象上设置一个属性：

>>> def deco(func):
...    func.attr = 'decorated'
...    return func
...
>>> @deco
... def f(): pass
...
>>> f
<function f at 0x402ef0d4>
>>> f.attr
'decorated'
>>>

作为一个稍微更现实的例子，以下装饰器检查提供的参数是否为整数：

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

在 PEP 318 [https://www.python.org/dev/peps/pep-0318] 中的一个示例包含了一个更复杂的版本，它允许你同时指定所需类型并检查返回类型。

装饰器函数可以接受参数。如果提供了参数，你的装饰器函数仅用这些参数调用，并且必须返回一个新的装饰器函数；这个函数必须接受单个函数并返回一个函数，如前所述。换句话说，@A @B @C(args) 变为：

def f(): ...
_deco = C(args)
f = A(B(_deco(f)))

理解这一点可能有点费脑筋，但并不太困难。

A small related change makes the func_name attribute of functions writable. This attribute is used to display function names in tracebacks, so decorators should change the name of any new function that's constructed and returned.

参见

PEP 318 [https://www.python.org/dev/peps/pep-0318] - 函数、方法和类的装饰器

由 Kevin D. Smith、Jim Jewett 和 Skip Montanaro 编写。有几个人编写了实现函数装饰器的补丁，但实际被合并的是补丁 #979728，由 Mark Russell 编写。

https://wiki.python.org/moin/PythonDecoratorLibrary

该Wiki页面包含几个装饰器示例。

PEP 322: 反向迭代

一个新的内置函数 reversed(seq)，接受一个序列并返回一个以相反顺序遍历序列元素的迭代器。

>>> for i in reversed(xrange(1,4)):
...    print i
...
3
2
1

与扩展切片（如 range(1,4)[::-1]）相比，reversed() 更易读，运行更快，且显著减少内存使用。

请注意，reversed() 只接受序列，不接受任意迭代器。如果你想反转一个迭代器，首先使用 list() 将其转换为列表。

>>> input = open('/etc/passwd', 'r')
>>> for line in reversed(list(input)):
...   print line
...
root:*:0:0:System Administrator:/var/root:/bin/tcsh
  ...

参见

PEP 322 [https://www.python.org/dev/peps/pep-0322] - 反向迭代

由 Raymond Hettinger 撰写并实现。

PEP 324: 新的子进程模块

The standard library provides a number of ways to execute a subprocess, offering different features and different levels of complexity. os.system(command) is easy to use, but slow (it runs a shell process which executes the command) and dangerous (you have to be careful about escaping the shell's metacharacters). The popen2 module offers classes that can capture standard output and standard error from the subprocess, but the naming is confusing. The subprocess module cleans this up, providing a unified interface that offers all the features you might need.

Instead of popen2's collection of classes, subprocess contains a single class called Popen whose constructor supports a number of different keyword arguments.

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):

args 通常是一个字符串序列，用作子进程要执行的程序的参数。 (如果 shell 参数为真，args 可以是一个字符串，然后会传递给 shell 进行解释，就像 os.system() 所做的那样。)

stdin、stdout 和 stderr 指定子进程的输入、输出和错误流将会是什么。 你可以提供一个文件对象或文件描述符，或者你可以使用常量 subprocess.PIPE 来在子进程和父进程之间创建一个管道。

此构造器有几个方便的选项:

close_fds 将在运行子进程之前请求关闭所有文件描述符。

cwd 指定执行子进程将使用的工作目录（默认为父进程的工作目录）。

env 是一个指定环境变量的字典。

preexec_fn 是将在子进程启动之前被调用的函数。

universal_newlines 使用 Python 的 universal newlines 特性打开子进程的输入和输出。

一旦你创建了 Popen 实例，你可以调用它的 wait() 方法来暂停直到子进程退出，poll() 来检查它是否已退出而不暂停，或者 communicate(data) 来将字符串 data 发送到子进程的标准输入。 communicate(data) 然后读取子进程发送到其标准输出或标准错误的任何数据，返回一个元组 (stdout_data, stderr_data)。

call() 是一个快捷方式，它将其参数传递给 Popen 构造函数，等待命令完成，并返回子进程的状态码。 它可以作为 os.system() 的更安全替代:

sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
if sts == 0:
    # Success
    ...
else:
    # dpkg returned an error
    ...

命令在不使用 shell 的情况下被调用。 如果你确实想使用 shell，你可以添加 shell=True 作为关键字参数，并提供一个字符串而不是序列:

sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)

PEP 提供了各种 shell 和 Python 代码示例，并展示了它们如何被翻译成使用 subprocess 的 Python 代码。强烈建议阅读 PEP 的这一部分。

参见

PEP 324 [https://www.python.org/dev/peps/pep-0324] - 子进程 - 新的进程模块

由 Peter Åstrand 在 Fredrik Lundh 等人的协助下撰写并实现。

PEP 327: 十进制数据类型

Python 一直支持基于底层 C 语言 double 类型的浮点数（FP）作为数据类型。然而，尽管大多数编程语言提供了浮点数类型，但许多人（甚至程序员）并不知道浮点数不能准确表示某些十进制分数。新的 Decimal 类型可以准确表示这些分数，直至用户指定的精度限制。

为什么需要十进制？

这些限制源于浮点数的表示方式。FP 数由三个部分组成：

符号，可以是正或负。

尾数，是一个单数字的二进制数后跟一个小数部分。例如，二进制表示的 1.01 是 1 + 0/2 + 1/4，即十进制表示的 1.25。

指数，指示数字表示中十进制点的位置。

例如，数字 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在二进制中是``1.0001100110011 ...``；0.1 = 1/16 + 1/32 + 1/256加上无限多个额外项。IEEE 754必须在52位后截断这个无限重复的小数，因此表示略有误差。

有时在打印数字时可以看到这种不准确性：

>>> 1.1
1.1000000000000001

这种不准确性在打印数字时不总是可见，因为浮点数到十进制字符串的转换由C库提供，大多数C库会尝试生成合理的输出。即使没有显示出来，不准确性仍然存在，后续操作可能会放大这个误差。

对于许多应用来说，这并不重要。如果我在绘制点并在显示器上显示它们，1.1和1.1000000000000001之间的差异太小，无法察觉。报告通常限制输出到一定的小数位数，如果你将数字四舍五入到两位、三位甚至八位小数，误差永远不会显现。然而，对于确实重要的应用，实现自己的自定义算术例程是一项大量工作。

因此，创建了 Decimal 类型。

Decimal 类型

Python标准库中添加了一个新模块 decimal 。它包含两个类，Decimal 和 Context。Decimal 实例表示数字，而 Context 实例用于封装各种设置，例如精度和默认舍入模式。

Decimal 实例是不可变的，就像常规的 Python 整数和浮点数一样；一旦创建，就无法更改实例所表示的值。Decimal 实例可以从整数或字符串创建：

>>> import decimal
>>> decimal.Decimal(1972)
Decimal("1972")
>>> decimal.Decimal("1.1")
Decimal("1.1")

你也可以提供包含符号、以十进制数字元组表示的尾数和指数的元组：

>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
Decimal("-14.75")

注意事项：符号位是一个布尔值，所以 0 表示正数，1 表示负数。

从浮点数转换会带来一些问题：表示 1.1 的浮点数应该转换为精确的 1.1 的十进制数，还是 1.1 加上引入的任何不准确度？决定是回避这个问题，不将此类转换包含在 API 中。相反，你应该将浮点数转换为字符串，使用所需的精度，并将字符串传递给 Decimal 构造函数：

>>> f = 1.1
>>> decimal.Decimal(str(f))
Decimal("1.1")
>>> decimal.Decimal('%.12f' % f)
Decimal("1.100000000000")

一旦你有了 Decimal 实例，你可以在它们上执行常规的数学运算。一个限制：指数运算需要整数指数：

>>> 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 ** (non-integer)

你可以将 Decimal 实例与整数组合，但不能与浮点数组合：

>>> a + 4
Decimal("39.72")
>>> a + 4.5
Traceback (most recent call last):
  ...
TypeError: You can interact Decimal only with int, long or Decimal data types.
>>>

Decimal 数字可以与 math 和 cmath 模块一起使用，但请注意，在进行操作之前，它们会立即转换为浮点数，这可能导致精度和准确性的损失。你也会得到一个普通的浮点数，而不是 Decimal。

>>> import math, cmath
>>> d = decimal.Decimal('123456789012.345')
>>> math.sqrt(d)
351364.18288201344
>>> cmath.sqrt(-d)
351364.18288201344j

Decimal 实例有一个 sqrt() 方法，返回一个 Decimal，但如果你需要其他函数，比如三角函数，你将不得不自己实现它们。

>>> d.sqrt()
Decimal("351364.1828820134592177245001")

Context 类型

Context 类的实例封装了小数操作的几种设置：

prec 是精度，即小数点后的位数。

rounding 指定舍入模式。decimal 模块为各种可能性提供了常量：ROUND_DOWN、ROUND_CEILING、ROUND_HALF_EVEN 以及其他几种。

traps 是一个字典，指定在遇到某些错误条件时会发生什么：要么抛出异常，要么返回一个值。一些错误条件的例子包括除以零、精度损失和溢出。

通过调用 getcontext() 可以获得线程本地的默认上下文；你可以更改此上下文的属性来改变默认的精度、舍入或错误处理。以下示例显示了更改默认上下文精度的效果:

>>> 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")

错误条件的默认行为是可选择的；模块可以返回特殊值，如无穷大或非数字，或者可以抛出异常:

>>> 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")
>>>

Context 实例还包含多种用于格式化数字的方法，例如 to_eng_string() 和 to_sci_string()。

更多信息请参阅 decimal 模块的文档，其中包含快速入门教程和参考手册。

参见

PEP 327 [https://www.python.org/dev/peps/pep-0327] - 十进数据类型

由 Facundo Batista 撰写，由Facundo Batista, Eric Price, Raymond Hettinger, Aahz 和 Tim Peters 实现。

http://www.lahey.com/float.htm

该文章使用 Fortran 代码演示了浮点精度问题可能导致的许多问题。

http://speleotrove.com/decimal/

描述了一种基于十进制的表示法。这种表示法已被提议作为标准，并且是新的 Python decimal 类型的基础。大部分内容由 Rexx 语言的设计者 Mike Cowlishaw 撰写。

PEP 328: 多行导入

一个语言改动是针对从模块中导入多个名称的小语法调整。在 from module import names 语句中，names 是由逗号分隔的名称序列。如果序列非常长，您可以要么从同一模块多次导入，要么使用反斜杠转义行尾，如下所示:

from SimpleXMLRPCServer import SimpleXMLRPCServer,\
            SimpleXMLRPCRequestHandler,\
            CGIXMLRPCRequestHandler,\
            resolve_dotted_attribute

Python 2.4 中的语法改动允许将名称放在括号内。Python 忽略括号表达式中的换行符，因此不再需要反斜杠:

from SimpleXMLRPCServer import (SimpleXMLRPCServer,
                                SimpleXMLRPCRequestHandler,
                                CGIXMLRPCRequestHandler,
                                resolve_dotted_attribute)

PEP还提议所有 import 语句应为绝对导入，使用前导的 . 字符表示相对导入。这部分PEP在Python 2.4中未实现，但在Python 2.5中完成了。

参见

PEP 328 [https://www.python.org/dev/peps/pep-0328] - 导入：多行和绝对/相对导入

由 Aahz 撰写，多行导入由 Dima Dorfman 实现。

PEP 331: 与区域设置无关的浮点数/字符串转换

locale 模块让Python软件选择针对特定国家或语言的多种转换和显示约定。然而，该模块小心翼翼地不更改数字区域设置，因为Python实现中的各种函数要求数字区域设置保持为 'C' 区域。这通常是因为代码使用了C库的 atof() 函数。

不设置数字区域设置给使用第三方C库的扩展带来了麻烦，因为它们不会有正确的区域设置。动机示例是GTK+，其用户界面小部件未在当前区域显示数字。

PEP中描述的解决方案是在Python API中添加三个新函数，执行仅ASCII的转换，忽略区域设置：

PyOS_ascii_strtod(str, ptr) 和 PyOS_ascii_atof(str, ptr) 都将字符串转换为C double。

PyOS_ascii_formatd(buffer, buf_len, format, d) 将 double 转换为ASCII字符串。

The code for these functions came from the GLib library (https://developer.gnome.org/glib/stable/), whose developers kindly relicensed the relevant functions and donated them to the Python Software Foundation. The locale module can now change the numeric locale, letting extensions such as GTK+ produce the correct results.

参见

PEP 331 [https://www.python.org/dev/peps/pep-0331] - 与区域设置无关的浮点数/字符串转换

由Christian R. Reis撰写，由 Gustavo Carneiro 实现。

其他语言特性修改

以下是 Python 2.4 针对核心 Python 语言的所有改变。

增加了用于函数和方法的装饰器 (PEP 318 [https://www.python.org/dev/peps/pep-0318])。

内置的 set() 和 frozenset() 类型被添加（PEP 218 [https://www.python.org/dev/peps/pep-0218]）。其他新内置函数包括 reversed(seq) 函数（PEP 322 [https://www.python.org/dev/peps/pep-0322]）。

增加了生成器表达式 (PEP 289 [https://www.python.org/dev/peps/pep-0289])。

某些数值表达式不再返回限于32位或64位的结果 (PEP 237 [https://www.python.org/dev/peps/pep-0237])。

现在可以在 from module import names 语句中的名称列表周围加上括号 (PEP 328 [https://www.python.org/dev/peps/pep-0328])。

dict.update() 方法现在接受与 dict 构造函数相同的参数形式。这包括任何映射、任何键/值对的迭代器以及关键字参数。（由 Raymond Hettinger 贡献。）

字符串方法 ljust()、rjust() 和 center() 现在接受一个可选参数，用于指定除空格以外的填充字符。（由 Raymond Hettinger 贡献。）

字符串还增加了一个 rsplit() 方法，其工作方式类似于 split() 方法，但从字符串末尾开始分割。（由 Sean Reifschneider 贡献。）

>>> 'www.python.org'.split('.', 1)
['www', 'python.org']
'www.python.org'.rsplit('.', 1)
['www.python', 'org']

列表的 sort() 方法增加了三个关键字参数：cmp、key 和 reverse。这些参数使一些常见的 sort() 用法变得更简单。所有这些参数都是可选的。

对于 cmp 参数，其值应为一个比较函数，该函数接受两个参数，根据参数的比较结果返回 -1、0 或 +1。然后使用此函数对列表进行排序。以前这是唯一可以提供给 sort() 的参数。

key 应该是一个单参数函数，该函数接受一个列表元素并返回该元素的比较键。然后使用比较键对列表进行排序。以下示例按不区分大小写的方式对列表进行排序:

>>> L = ['A', 'b', 'c', 'D']
>>> L.sort()                 # Case-sensitive sort
>>> L
['A', 'D', 'b', 'c']
>>> # Using 'key' parameter to sort list
>>> L.sort(key=lambda x: x.lower())
>>> L
['A', 'b', 'c', 'D']
>>> # Old-fashioned way
>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
>>> L
['A', 'b', 'c', 'D']

最后一个示例使用了 cmp 参数，这是旧方法来进行不区分大小写的排序。它可以工作，但比使用 key 参数慢。使用 key 参数会对列表中的每个元素调用一次 lower() 方法，而使用 cmp 参数则会在每次比较时调用两次，因此使用 key 参数可以减少对 lower() 方法的调用。

对于简单的键函数和比较函数，通常可以通过使用未绑定方法来避免使用 lambda 表达式。例如，上述不区分大小写的排序最好写成：

>>> L.sort(key=str.lower)
>>> L
['A', 'b', 'c', 'D']

最后，reverse 参数接受一个布尔值。如果值为真，列表将按逆序排序。现在你可以用 L.sort(reverse=True) 替代 L.sort(); L.reverse()。

排序结果现在保证是稳定的。这意味着具有相同键的两个条目将按照它们输入的顺序返回。例如，你可以先按名字对人员列表进行排序，然后再按年龄排序，结果是一个按年龄排序的列表，其中同年龄的人员按名字排序。

（所有对 sort() 方法的更改由 Raymond Hettinger 贡献。）

有一个新的内置函数 sorted(iterable)，它类似于原地 list.sort() 方法，但可以在表达式中使用。区别在于：

输入可以是任意可迭代对象;

新生成的副本被排序，原始列表保持不变；以及

表达式返回新的已排序副本

>>> L = [9,7,8,3,2,4,1,6,5]
>>> [10+i for i in sorted(L)]       # usable in a list comprehension
[11, 12, 13, 14, 15, 16, 17, 18, 19]
>>> L                               # original is left unchanged
[9,7,8,3,2,4,1,6,5]
>>> sorted('Monty Python')          # any iterable may be an input
[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']

>>> # List the contents of a dict sorted by key values
>>> 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

（由 Raymond Hettinger 贡献。）

整数运算将不再触发 OverflowWarning。OverflowWarning 警告将在 Python 2.5 中消失。

解释器新增了一个开关 -m，它接受一个名称，在 sys.path 上搜索相应的模块，并将该模块作为脚本运行。例如，你现在可以使用 python -m profile 运行 Python 分析器。（由 Nick Coghlan 贡献。）

eval(expr, globals, locals) 和 execfile(filename, globals, locals) 函数以及 exec 语句现在接受任何映射类型作为 locals 参数。以前这必须是一个普通的 Python 字典。（由 Raymond Hettinger 贡献。）

zip() 内置函数和 itertools.izip() 现在在无参数调用时返回一个空列表。以前它们会引发 TypeError 异常。这使得它们更适合用于可变长度参数列表:

>>> def transpose(array):
...    return zip(*array)
...
>>> transpose([(1,2,3), (4,5,6)])
[(1, 4), (2, 5), (3, 6)]
>>> transpose([])
[]

（由 Raymond Hettinger 贡献。）

在导入模块时遇到失败将不再在 sys.modules 中留下部分初始化的模块对象。留下的不完整模块对象会导致后续导入同一模块时误以为成功，进而引发混淆的错误。（由 Tim Peters 修复。）

None 现在是一个常量；将一个新值绑定到名称 None 的代码现在会造成语法错误。 （由 Raymond Hettinger 贡献。）

性能优化

列表和元组切片的内部循环经过优化，现在运行速度大约提高了三分之一。字典的内部循环也进行了优化，使得 keys()、values()、items()、iterkeys()、itervalues() 和 iteritems() 的性能得到提升。（由 Raymond Hettinger 贡献。）

用于列表增长和缩小的机制进行了速度和空间效率的优化。由于更高效的代码路径和更少地使用底层系统 realloc()，向列表追加和弹出元素现在运行得更快。列表推导也从中受益。list.extend() 也进行了优化，不再将其参数转换为临时列表后再扩展基础列表。（由 Raymond Hettinger 贡献。）

list()、tuple()、map()、filter() 和 zip() 在使用提供 __len__() 方法的非序列参数时，现在运行速度提高了数倍。（由 Raymond Hettinger 贡献。）

list.__getitem__()、dict.__getitem__() 和 dict.__contains__() 方法现在实现为 method_descriptor 对象，而不是 wrapper_descriptor 对象。这种访问形式使它们的性能翻倍，更适合作为函数式编程的参数使用：map(mydict.__getitem__, keylist)。（由 Raymond Hettinger 贡献。）

添加了一个新的操作码 LIST_APPEND，简化了列表推导生成的字节码，并使其速度提高了大约三分之一。（由 Raymond Hettinger 贡献。）

窥孔字节码优化器得到了改进，能够生成更短、更快的字节码；值得注意的是，生成的字节码更易读。（由 Raymond Hettinger 增强。）

在形式为 s = s + "abc" 和 s += "abc" 的语句中，字符串连接现在在某些情况下会更高效地执行。这种优化不会出现在其他Python实现中，例如Jython，因此你不应依赖它；当你需要高效地连接大量字符串时，仍然推荐使用字符串的 join() 方法。（由Armin Rigo贡献。）

2.4版本优化的净结果是，Python 2.4运行pystone基准测试比Python 2.3快约5%，比Python 2.2快35%。（pystone并不是一个特别好的基准测试，但它是衡量Python性能最常用的方法。你的应用程序可能从Python 2.4中获得更大或更小的收益。）

新增，改进和弃用的模块

一如既往，Python的标准库获得了一些增强和错误修复。以下是一些最显著变化的部分列表，按模块名称字母顺序排序。请查阅源树中的 Misc/NEWS 文件以获取更完整的变化列表，或通过CVS日志查看所有细节。

The asyncore module's loop() function now has a count parameter that lets you perform a limited number of passes through the polling loop. The default is still to loop forever.

base64 模块现在更完整地支持 RFC 3548 [https://datatracker.ietf.org/doc/html/rfc3548.html] 中的Base64、Base32和Base16编码和解码，包括可选的大小写折叠和可选的替代字母表。（由Barry Warsaw贡献。）

bisect 模块现在有底层的C实现，以提升性能。（由Dmitry Vasiliev贡献。）

由 Hye-Shik Chang 维护的东亚编解码器的 CJKCodecs 集合已集成到 2.4 中。新的编码为：

汉语（大陆）: gb2312, gbk, gb18030, big5hkscs, hz

汉语（台湾）: big5, cp950

日语: 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

韩语: cp949, euc-kr, johab, iso-2022-kr

添加了其他一些新的编码：HP Roman8, ISO_8859-11, ISO_8859-16, PCTP-154 和 TIS-620

UTF-8和UTF-16编解码器现在更好地处理接收部分输入的情况。以前，StreamReader 类会尝试读取更多数据，使得无法从流中恢复解码。read() 方法现在将返回尽可能多的数据，后续调用将从之前停止的地方恢复解码。（由Walter Dörwald实现。）

有一个新的 collections 模块，用于各种专业化的集合数据类型。目前它只包含一种类型，deque，这是一个双端队列，支持高效地从两端添加和移除元素:

>>> from collections import deque
>>> d = deque('ghi')        # make a new deque with three items
>>> d.append('j')           # add a new entry to the right side
>>> d.appendleft('f')       # add a new entry to the left side
>>> d                       # show the representation of the deque
deque(['f', 'g', 'h', 'i', 'j'])
>>> d.pop()                 # return and remove the rightmost item
'j'
>>> d.popleft()             # return and remove the leftmost item
'f'
>>> list(d)                 # list the contents of the deque
['g', 'h', 'i']
>>> 'h' in d                # search the deque
True

多个模块，如 Queue 和 threading 模块，现在利用 collections.deque 来提高性能。（由 Raymond Hettinger 贡献。）

The ConfigParser classes have been enhanced slightly. The read() method now returns a list of the files that were successfully parsed, and the set() method raises TypeError if passed a value argument that isn't a string. (Contributed by John Belmonte and David Goodger.)

curses 模块现在支持 ncurses 扩展 use_default_colors()。在终端支持透明度的平台上，这使得使用透明背景成为可能。（由 Jörg Lehmann 贡献。）

difflib 模块现在包含一个 HtmlDiff 类，该类创建一个 HTML 表格，显示两个文本版本的并列比较。（由 Dan Gass 贡献。）

email 包已更新至 3.0 版本，该版本移除了多种已弃用的 API，并取消了对于 Python 2.3 之前版本的支持。3.0 版本的包使用了一个新的增量解析器来处理 MIME 消息，该解析器位于 email.FeedParser 模块中。新解析器不需要将整个消息读入内存，且在消息格式不正确时不会抛出异常；相反，它会将任何问题记录在消息的 defect 属性中。（由 Anthony Baxter、Barry Warsaw、Thomas Wouters 等人开发。）

heapq 模块已被转换为 C 语言实现。由此带来的速度提升达十倍，使得该模块适合处理大量数据。此外，该模块新增了两个函数 nlargest() 和 nsmallest()，它们使用堆来查找数据集中的 N 个最大或最小值，而无需进行完整的排序。（由 Raymond Hettinger 贡献。）

The httplib module now contains constants for HTTP status codes defined in various HTTP-related RFC documents. Constants have names such as OK, CREATED, CONTINUE, and MOVED_PERMANENTLY; use pydoc to get a full list. (Contributed by Andrew Eland.)

imaplib 模块现在支持 IMAP 的 THREAD 命令（由 Yves Dionne 贡献）以及新的 deleteacl() 和 myrights() 方法（由 Arnaud Mazin 贡献）。

itertools 模块新增了 groupby(iterable[, *func*]) 函数。iterable 是可以迭代以返回元素流的对象，可选的 func 参数是一个函数，它接受一个元素并返回一个键值；如果省略，键即为元素本身。groupby() 然后将元素分组为具有匹配键值的子序列，并返回一系列包含键值和子序列迭代器的 2 元组。

以下是一个示例，以便更清晰地说明这一点。key 函数 simply 返回一个数字是奇数还是偶数，因此 groupby() 的结果就是返回连续的奇数或偶数序列。:

>>> 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]
>>>

groupby() 通常用于处理已排序的输入。groupby() 的逻辑类似于 Unix 的 uniq 过滤器，这使得它非常适合用于消除、计数或识别重复元素:

>>> word = 'abracadabra'
>>> letters = sorted(word)   # Turn string into a sorted list of letters
>>> 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']
>>> # List unique letters
>>> [k for k, g in groupby(letters)]
['a', 'b', 'c', 'd', 'r']
>>> # Count letter occurrences
>>> [(k, len(list(g))) for k, g in groupby(letters)]
[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]

（由 Hye-Shik Chang 贡献。）

itertools 还增加了一个名为 tee(iterator, N) 的函数，它返回 N 个独立迭代器，这些迭代器复制 iterator。如果省略 N，默认值为 2。:

>>> L = [1,2,3]
>>> i1, i2 = itertools.tee(L)
>>> i1,i2
(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
>>> list(i1)               # Run the first iterator to exhaustion
[1, 2, 3]
>>> list(i2)               # Run the second iterator to exhaustion
[1, 2, 3]

请注意，tee() 需要保留由迭代器返回的值的副本；在最坏的情况下，它可能需要保留所有这些值。因此，如果领先迭代器在长输入流中远远领先于滞后迭代器，应谨慎使用此功能。如果分离较大，那么您可能还不如使用 list()。当迭代器彼此紧密跟踪时，tee() 是理想的。可能的用例包括书签、窗口化或前瞻迭代器。（由 Raymond Hettinger 贡献。）

A number of functions were added to the locale module, such as bind_textdomain_codeset() to specify a particular encoding and a family of l*gettext() functions that return messages in the chosen encoding. (Contributed by Gustavo Niemeyer.)

logging 包的 basicConfig() 函数添加了一些关键字参数，以简化日志配置。默认行为是将消息记录到标准错误，但可以指定各种关键字参数以将日志记录到特定文件、更改日志格式或设置日志级别。例如：

import logging
logging.basicConfig(filename='/var/log/application.log',
    level=0,  # Log all messages
    format='%(levelname):%(process):%(thread):%(message)')

logging 包的其他添加内容包括一个 log(level, msg) 便捷方法，以及一个 TimedRotatingFileHandler 类，该类在定时间隔旋转其日志文件。模块已经有一个 RotatingFileHandler，它在文件超过特定大小时旋转日志。这两个类都派生自一个新的 BaseRotatingHandler 类，该类可用于实现其他旋转处理程序。

（更改由 Vinay Sajip 实现。）

marshal 模块现在在解包数据结构时共享内部字符串。这可能会缩小某些 pickle 字符串的大小，但主要效果是使 .pyc 文件显著变小。（由 Martin von Löwis 贡献。）

The nntplib module's NNTP class gained description() and descriptions() methods to retrieve newsgroup descriptions for a single group or for a range of groups. (Contributed by Jürgen A. Erhard.)

operator 模块新增了两个函数，attrgetter(attr) 和 itemgetter(index)。这两个函数都返回一个接受单个参数并返回相应属性或项的可调用对象；这些可调用对象在与 map() 或 sorted() 一起使用时，是非常优秀的数据提取器。例如：

>>> 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)) # Sort list by second tuple item
[('d', 1), ('c', 2), ('b', 3), ('a', 4)]

（由 Raymond Hettinger 贡献。）

optparse 模块进行了多项更新。该模块现在通过 gettext.gettext() 传递其消息，使得可以国际化 Optik 的帮助和错误消息。选项的帮助消息现在可以包含字符串 '%default'，该字符串将被选项的默认值替换。（由 Greg Ward 贡献。）

The long-term plan is to deprecate the rfc822 module in some future Python release in favor of the email package. To this end, the email.Utils.formatdate() function has been changed to make it usable as a replacement for rfc822.formatdate(). You may want to write new e-mail processing code with this in mind. (Change implemented by Anthony Baxter.)

os 模块新增了 urandom(n) 函数，返回一个包含 n 字节随机数据的字符串。该函数提供了对平台特定随机源（如 Linux 上的 /dev/urandom 或 Windows CryptoAPI）的访问。（由 Trevor Perrin 贡献。）

另一个新函数：os.path.lexists(path) 如果指定的文件存在（无论是否为符号链接）则返回 true。这与现有的 os.path.exists(path) 函数不同，后者在 path 是指向不存在目标的符号链接时返回 false。（由 Beni Cherniavsky 贡献。）

在 os 之下 posix 模块中新增了一个 getsid() 函数。 （由 J. Raynor 贡献。）

poplib 模块现在已支持 SSL 上的 POP。 （由 Hector Urtubia 贡献。）

现在 profile 模块将可对 C 扩展函数执行性能分析。 （由 Nick Bastin 贡献。）

random 模块有一个新方法 getrandbits(N)，返回一个长度为 N 位的长整数。现有的 randrange() 方法现在在适当的情况下使用 getrandbits()，使得生成任意大的随机数更加高效。（由 Raymond Hettinger 贡献。）

re 模块接受的正则表达式语言扩展了简单的条件表达式，写作 (?(group)A|B)。group 可以是数字组 ID 或用 (?P<group>...) 在表达式中提前定义的组名。如果指定的组匹配，正则表达式模式 A 将被用于测试字符串；如果组未匹配，则使用模式 B。（由 Gustavo Niemeyer 贡献。）

由于 Gustavo Niemeyer 大量工作，re 模块也不再是递归的。在递归正则表达式引擎中，某些模式会导致大量 C 栈空间被消耗，甚至可能溢出栈。例如，如果你将一个 30000 字节的 a 字符串与表达式 (a|b)+ 匹配，每个字符会消耗一个栈帧。Python 2.3 试图检查栈溢出并抛出 RuntimeError 异常，但某些模式可以绕过检查，如果你运气不好，Python 可能会段错误。Python 2.4 的正则表达式引擎可以无问题地匹配此模式。

signal 模块现在对 signal.signal() 函数的参数进行更严格的错误检查。例如，你不能在 SIGKILL 信号上设置处理程序；之前的 Python 版本会默默接受这一点，但 2.4 版本将引发一个 RuntimeError 异常。

socket 模块新增了两个函数。socketpair() 返回一对已连接的套接字，而 getservbyport(port) 用于查找给定端口号的服务名称。（由 Dave Cole 和 Barry Warsaw 贡献。）

sys.exitfunc() 函数已被弃用。代码应使用现有的 atexit 模块，它能正确处理调用多个退出函数。最终 sys.exitfunc() 将成为一个纯内部接口，仅由 atexit 访问。

现在 tarfile 模块默认将生成 GNU 格式的 tar 文件。 （由 Lars Gustäbel 贡献。）

threading 模块现在有了一种优雅简洁的方式来支持线程本地数据。该模块包含一个 local 类，其属性值对不同线程是本地的。:

import threading

data = threading.local()
data.number = 42
data.url = ('www.python.org', 80)

其他线程可以为 number 和 url 属性分配和检索它们自己的值。你可以子类化 local 来初始化属性或添加方法。（由 Jim Fulton 贡献。）

timeit 模块现在在计时循环中自动禁用周期性垃圾收集。这一改变使得连续计时更具可比性。（由 Raymond Hettinger 贡献。）

weakref 模块现在支持更多种类的对象，包括 Python 函数、类实例、集合、冻结集合、双端队列、数组、文件、套接字和正则表达式模式对象。（由 Raymond Hettinger 贡献。）

The xmlrpclib module now supports a multi-call extension for transmitting multiple XML-RPC calls in a single HTTP operation. (Contributed by Brian Quinlan.)

mpz, rotor 和 xreadlines 模块已被移除。

cookielib

The cookielib library supports client-side handling for HTTP cookies, mirroring the Cookie module's server-side cookie support. Cookies are stored in cookie jars; the library transparently stores cookies offered by the web server in the cookie jar, and fetches the cookie from the jar when connecting to the server. As in web browsers, policy objects control whether cookies are accepted or not.

为了跨会话存储 Cookie，提供了两种 Cookie 罐的实现：一种以 Netscape 格式存储 Cookie，以便应用程序可以使用 Mozilla 或 Lynx 的 Cookie 文件，另一种以与 Perl libwww 库相同的格式存储 Cookie。

urllib2 has been changed to interact with cookielib: HTTPCookieProcessor manages a cookie jar that is used when accessing URLs.

该模块由 John J. Lee 贡献。

doctest

由于 Edward Loper 和 Tim Peters 的贡献，doctest 模块进行了大量重构。测试仍然可以简单到只需运行 doctest.testmod()，但重构允许以各种方式自定义模块的操作。

新的 DocTestFinder 类从给定对象的文档字符串中提取测试：

def f (x, y):
    """>>> f(2,2)
4
>>> f(3,2)
6
    """
    return x*y

finder = doctest.DocTestFinder()

# Get list of DocTest instances
tests = finder.find(f)

新的 DocTestRunner 类然后运行单个测试并可以生成结果摘要：

runner = doctest.DocTestRunner()
for t in tests:
    tried, failed = runner.run(t)

runner.summarize(verbose=1)

上述示例生成以下输出：

1 items passed all tests:
   2 tests in f
2 tests in 1 items.
2 passed and 0 failed.
Test passed.

DocTestRunner 使用一个 OutputChecker 类的实例来比较预期输出和实际输出。这个类接受多个不同的标志来定制其行为；有野心的用户也可以编写一个全新的 OutputChecker 子类。

默认的输出检查器提供了一些方便的功能。例如，使用 doctest.ELLIPSIS 选项标志，预期输出中的省略号（...）可以匹配任何子字符串，这使得更容易适应在细小方面有所变化的输出:

def o (n):
    """>>> o(1)
<__main__.C instance at 0x...>
>>>
"""

另一个特殊字符串，<BLANKLINE>, 匹配一个空行:

def p (n):
    """>>> p(1)
<BLANKLINE>
>>>
"""

另一个新功能是通过指定 doctest.REPORT_UDIFF (统一差异) 、doctest.REPORT_CDIFF (上下文差异) 或 doctest.REPORT_NDIFF (增量式差异) 选项标志，生成输出差异风格的显示。例如:

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

在指定 doctest.REPORT_UDIFF 的情况下运行上述函数的测试，你会得到以下输出：

**********************************************************************
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
**********************************************************************

构建和 C API 的改变

对于 Python 构建过程和 C API 的一些修改:

为常见扩展函数返回值添加了三个新的便利宏：Py_RETURN_NONE、Py_RETURN_TRUE 和 Py_RETURN_FALSE。（由 Brett Cannon 贡献。）

另一个新宏，Py_CLEAR，减少 obj 的引用计数并将 obj 设置为空指针。（由 Jim Fulton 贡献。)

一个新的函数 PyTuple_Pack(N, obj1, obj2, ..., objN)，可以从一个可变长度的Python对象参数列表中构造元组。（由Raymond Hettinger贡献。）

一个新的函数 PyDict_Contains(d, k)，实现了快速的字典查找，而不会掩盖查找过程中引发的异常。（由Raymond Hettinger贡献。）

宏 Py_IS_NAN(X) 如果其浮点或双精度参数 X 是NaN，则返回1。（由Tim Peters贡献。）

C code can avoid unnecessary locking by using the new PyEval_ThreadsInitialized() function to tell if any thread operations have been performed. If this function returns false, no lock operations are needed. (Contributed by Nick Coghlan.)

一个新的函数 PyArg_VaParseTupleAndKeywords()，与 PyArg_ParseTupleAndKeywords() 相同，但接受一个 va_list 而不是参数数量。（由Greg Chapman贡献。）

A new method flag, METH_COEXISTS, allows a function defined in slots to co-exist with a PyCFunction having the same name. This can halve the access time for a method such as set.__contains__(). (Contributed by Raymond Hettinger.)

Python现在可以内置对解释器本身的额外分析功能，旨在帮助开发Python核心的人员。向 configure 脚本提供 --enable-profiling 选项将允许您使用 gprof 对解释器进行分析，提供 --with-tsc 开关则启用使用Pentium的时间戳计数器寄存器进行分析。请注意，--with-tsc 开关命名略有不当，因为该分析功能在PowerPC平台上也能工作，尽管该处理器架构不将该寄存器称为“TSC寄存器”。（由Jeremy Hylton贡献。）

The tracebackobject type has been renamed to PyTracebackObject.

移植专属的改变

Windows端口现在可以在MSVC++ 7.1以及版本6下构建。（由Martin von Löwis贡献。）

移植到 Python 2.4

本节列出了先前描述的可能需要修改你的代码的改变：

左移操作和过大的十六进制/八进制常量不再触发 FutureWarning，并且返回一个限制在32或64位的值；相反，它们返回一个长整数。

整数运算将不再触发 OverflowWarning。OverflowWarning 警告将在 Python 2.5 中消失。

zip() 内置函数和 itertools.izip() 现在在无参数调用时返回一个空列表，而不是抛出 TypeError 异常。

您不能再比较由 datetime 模块提供的 date 和 datetime 实例。不同类的两个实例现在将始终不相等，并且相对比较（<，>）将抛出 TypeError。

dircache.listdir() now passes exceptions to the caller instead of returning empty lists.

LexicalHandler.startDTD() 过去接收公共和系统 ID 的顺序错误。这已被纠正；依赖错误顺序的应用程序需要修复。

现在 fcntl.ioctl() 会在 mutate 参数被省略并且将造成影响时发出警告。

现在 tarfile 模块默认将生成 GNU 格式的 tar 文件。

在导入模块时遭遇失败不会再将部分初始化的模块对象留在 sys.modules 中。

现在 None 是一个常量；将一个新值绑定到 None 将导致语法错误。

现在对于某些非法的值 signals.signal() 函数将引发 RuntimeError 异常；在之前版本中这些错误会静默地放过。 例如，你将不能在 SIGKILL 信号上设置处理器。

致谢

作者感谢以下人员对本文各种草稿给予的建议，更正和协助：Koray Can, Hye-Shik Chang, Michael Dyck, Raymond Hettinger, Brian Hurt, Hamish Lawson, Fredrik Lundh, Sean Reifschneider, Sadruddin Rejeb.

Python 2.3 有什么新变化

作者

A.M. Kuchling

本文介绍了 Python 2.3 的新特性。 Python 2.3 发布于 2003 年 7 月 29 日。

Python 2.3 的主要主题是完善在 2.2 中添加的一些功能、为核心语言添加各种小但实用的增强功能，以及扩展标准库。 上一版本引入的新对象模型已经受益于 18 个月的错误修复和优化努力，这些优化提升了新式类的性能。 新增了几个内置函数，例如 sum() 和 enumerate()。 in 操作符现在可以用于子字符串搜索 (例如，"ab" in "abc" 将返回 True)。

许多新库功能包括布尔值、集合、堆、日期/时间数据类型，从ZIP格式的归档文件中导入模块的能力，期待已久的 Python 目录的元数据支持，更新版本的 IDLE，以及用于日志记录、文本包装、解析 CSV 文件、处理命令行选项、使用 BerkeleyDB 数据库的模块…… 新模块和增强模块的列表相当长。

本文并不试图提供对新功能的完整规范，而是提供了一个方便的概览。 有关详细信息，你应该参考 Python 2.3 的文档，例如 Python 库参考和 Python 参考手册。 如果你想了解完整的实现和设计原理，请参阅特定新功能的 PEP。

PEP 218: 标准集合数据类型

The new sets module contains an implementation of a set datatype. The Set class is for mutable sets, sets that can have members added and removed. The ImmutableSet class is for sets that can't be modified, and instances of ImmutableSet can therefore be used as dictionary keys. Sets are built on top of dictionaries, so the elements within a set must be hashable.

这是一个简单的示例：

>>> 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])
>>>

The union and intersection of sets can be computed with the union() and intersection() methods; an alternative notation uses the bitwise operators & and |. Mutable sets also have in-place versions of these methods, union_update() and intersection_update().

>>> S1 = sets.Set([1,2,3])
>>> S2 = sets.Set([4,5,6])
>>> S1.union(S2)
Set([1, 2, 3, 4, 5, 6])
>>> S1 | S2                  # Alternative notation
Set([1, 2, 3, 4, 5, 6])
>>> S1.intersection(S2)
Set([])
>>> S1 & S2                  # Alternative notation
Set([])
>>> S1.union_update(S2)
>>> S1
Set([1, 2, 3, 4, 5, 6])
>>>

It's also possible to take the symmetric difference of two sets. This is the set of all elements in the union that aren't in the intersection. Another way of putting it is that the symmetric difference contains all elements that are in exactly one set. Again, there's an alternative notation (^), and an in-place version with the ungainly name symmetric_difference_update().

>>> 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])
>>>

另外还有 issubset() 和 issuperset() 方法用来检查一个集合是否为另一个集合的子集或超集:

>>> S1 = sets.Set([1,2,3])
>>> S2 = sets.Set([2,3])
>>> S2.issubset(S1)
True
>>> S1.issubset(S2)
False
>>> S1.issuperset(S2)
True
>>>

参见

PEP 218 [https://www.python.org/dev/peps/pep-0218] - 添加内置Set对象类型

PEP 由 Greg V. Wilson 撰写 ; 由 Greg V. Wilson, Alex Martelli 和 GvR 实现。

PEP 255: 简单的生成器

在 Python 2.2 中，生成器作为一个可选特性被添加，需要通过 from __future__ import generators 指令来启用。 在 2.3 版本中，生成器不再需要特别启用，现在总是存在；这意味着 yield 现在始终是一个关键字。 本节的其余部分是从《Python 2.2的新特性》文档中复制的生成器描述；如果你在 Python 2.2 发布时已经阅读过，可以跳过本节的其余部分。

你一定熟悉在 Python 或 C 语言中函数调用的工作方式。 当你调用一个函数时，它会获得一个私有命名空间，在这个命名空间中创建其局部变量。 当函数执行到 return 语句时，这些局部变量会被销毁，并将结果值返回给调用者。 稍后对同一个函数的调用将获得一套全新的局部变量。 但是，如果局部变量在函数退出时不被丢弃呢？如果你可以在函数停止的地方稍后恢复执行呢？这就是生成器所提供的功能；它们可以被视为可恢复的函数。

这里是一个生成器函数的最简示例:

def generate_ints(N):
    for i in range(N):
        yield i

一个新的关键字 yield 被引入用于生成器。 任何包含 yield 语句的函数都是生成器函数；这由 Python 的字节码编译器检测到，并因此对函数进行特殊编译。

当您调用生成器函数时，它不会返回一个单独的值；相反，它会返回一个支持迭代器协议的生成器对象。在执行 yield 语句时，生成器会输出 i 的值 ，类似于 return 语句。 yield 与 return 语句之间的最大区别在于，在到达 yield 时，生成器的执行状态会暂停，并保留本地变量。 在下一次调用生成器 的 .next() 方法时，函数将在 yield 语句之后立即恢复执行。 （由于复杂的原因，yield 语句不允许在 try...finally 语句的 try 代码块内出现；有关 yield 和异常之间交互的完整解释，请阅读 PEP 255 [https://www.python.org/dev/peps/pep-0255]。）

这里是 generate_ints() 生成器的用法示例:

>>> 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

你可以等价地写成 for i in generate_ints(5) 或 a,b,c = generate_ints(3)。

在生成器函数内部， return 语句只能不带值使用，并表示值的生成过程结束；之后，生成器不能再返回任何值。在生成器函数内部，带值的 return，例如 return 5，是语法错误。生成器结果的结束也可以通过手动引发 StopIteration 异常来指示，或者只是让执行流自然地从函数底部流出。

你可以通过编写自己的类并将生成器的所有局部变量存储为实例变量，手动实现生成器的效果。例如，返回一个整数列表可以通过将 self.count 设置为0，并让 next() 方法递增 self.count 并返回它。然而，对于一个中等复杂的生成器，编写一个相应的类将会更加混乱。Lib/test/test_generators.py 包含了一些更有趣的例子。其中最简单的一个使用生成器递归实现了树的中序遍历：

# A recursive generator that generates Tree leaves in in-order.
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x
        yield t.label
        for x in inorder(t.right):
            yield x

在 Lib/test/test_generators.py 中还有另外两个例子，它们分别解决了N皇后问题（在$NxN$的棋盘上放置$N$个皇后，使得没有任何皇后威胁到其他皇后）和骑士巡游问题（在$NxN$的棋盘上，骑士访问每一个方格且不重复访问任何方格的路径）。

The idea of generators comes from other programming languages, especially Icon (https://www.cs.arizona.edu/icon/), where the idea of generators is central. In Icon, every expression and function call behaves like a generator. One example from "An Overview of the Icon Programming Language" at https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks like:

sentence := "Store it in the neighboring harbor"
if (i := find("or", sentence)) > 5 then write(i)

In Icon the find() function returns the indexes at which the substring "or" is found: 3, 23, 33. In the if statement, i is first assigned a value of 3, but 3 is less than 5, so the comparison fails, and Icon retries it with the second value of 23. 23 is greater than 5, so the comparison now succeeds, and the code prints the value 23 to the screen.

Python并不像Icon那样将生成器作为核心概念来采用。生成器被视为Python核心语言的一部分，但学习或使用它们并不是强制的；如果它们不能解决你遇到的问题，可以完全忽略它们。与Icon相比，Python接口的一个新颖特性是生成器的状态表示为一个具体的对象（迭代器），可以传递给其他函数或存储在数据结构中。

参见

PEP 255 [https://www.python.org/dev/peps/pep-0255] - 简单生成器

由 Neil Schemenauer, Tim Peters, Magnus Lie Hetland 撰写。 主要由 Neil Schemenauer 和 Tim Peters 实现，并包含来自 Python Labs 团队的修正。

PEP 263: 源代码的字符编码格式

现在可以声明Python源文件使用不同的字符集编码。通过在源文件的第一行或第二行包含特定格式的注释来声明编码。例如，一个UTF-8文件可以这样声明：

#!/usr/bin/env python
# -*- coding: UTF-8 -*-

如果没有这样的编码声明，默认使用7位ASCII编码。执行或导入包含8位字符的字符串字面量且没有编码声明的模块时，在Python 2.3中会触发 DeprecationWarning 警告；而在Python 2.4中，这将成为语法错误

编码声明只影响Unicode字符串字面量，这些字面量将使用指定的编码转换为Unicode。请注意，Python的标识符仍然限制为ASCII字符，因此变量名不能使用超出常规字母数字字符范围的字符。

参见

PEP 263 [https://www.python.org/dev/peps/pep-0263] - 定义 Python 源代码的编码格式

由 Marc-André Lemburg 和 Martin von Löwis 撰写 ; 由 Suzuki Hisao 和 Martin von Löwis 实现。

PEP 273: 从ZIP压缩包导入模块

通过新的 zipimport 模块增加了从 ZIP 格式归档文件导入模块的支持。 你不需要显式地导入模块；它将在 ZIP 归档文件名被添加到 sys.path 的情况下自动导入。 例如：

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')  # Add .zip file to front of path
>>> import jwzthreading
>>> jwzthreading.__file__
'/tmp/example.zip/jwzthreading.py'
>>>

sys.path 中的一个条目现在可以是 ZIP 归档文件的文件名。ZIP 归档可以包含任何类型的文件，但只有名为 *.py、*.pyc 或 *.pyo 的文件可以被导入。如果归档仅包含 *.py 文件，Python 不会尝试通过添加相应的 *.pyc 文件来修改归档，这意味着如果 ZIP 归档不包含 *.pyc 文件，导入可能会相当慢。

也可以指定归档内的路径，以仅从子目录导入；例如，路径 /tmp/example.zip/lib/ 将仅从归档中的 lib/ 子目录导入。

参见

PEP 273 [https://www.python.org/dev/peps/pep-0273] - 从 ZIP 压缩包导入模块

由James C. Ahlstrom撰写，并提供了一个实现。Python 2.3遵循 PEP 273 [https://www.python.org/dev/peps/pep-0273] 中的规范，但使用了Just van Rossum编写的实现，该实现利用了 PEP 302 [https://www.python.org/dev/peps/pep-0302] 中描述的导入钩子。有关新导入钩子的描述，请参见 PEP 302: 新导入钩子 的相关部分。

PEP 277: 针对 Windows NT 的 Unicode 文件名支持

在Windows NT、2000和XP上，系统将文件名存储为Unicode字符串。传统上，Python将文件名表示为字节字符串，这种方式不够完善，因为它会导致某些文件名无法访问。

Python now allows using arbitrary Unicode strings (within the limitations of the file system) for all functions that expect file names, most notably the open() built-in function. If a Unicode string is passed to os.listdir(), Python now returns a list of Unicode strings. A new function, os.getcwdu(), returns the current directory as a Unicode string.

字节串仍可被用作文件名，并且在 Windows 上 Python 将透明地使用 mbcs 编码格式将其转换为 Unicode。

Other systems also allow Unicode strings as file names but convert them to byte strings before passing them to the system, which can cause a UnicodeError to be raised. Applications can test whether arbitrary Unicode strings are supported as file names by checking os.path.supports_unicode_filenames, a Boolean value.

在 MacOS 下，os.listdir() 现在可以返回 Unicode 文件名。

参见

PEP 277 [https://www.python.org/dev/peps/pep-0277] - 针对 Windows NT 的 Unicode 文件名支持

由 Neil Hodgson 撰写 ; 由 Neil Hodgson, Martin von Löwis 和 Mark Hammond 实现。

PEP 278: 通用换行支持

目前使用的三大操作系统是微软的 Windows、苹果的 Macintosh OS 和各种 Unix 衍生系统。跨平台工作的一个小麻烦是，这三个平台都使用不同的字符来标记文本文件中的行结束。Unix 使用换行符（ASCII 字符 10），MacOS 使用回车符（ASCII 字符 13），Windows 使用回车符加换行符的双字符序列。

Python's file objects can now support end of line conventions other than the one followed by the platform on which Python is running. Opening a file with the mode 'U' or 'rU' will open a file for reading in universal newlines mode. All three line ending conventions will be translated to a '\n' in the strings returned by the various file methods such as read() and readline().

Universal newline support is also used when importing modules and when executing a file with the execfile() function. This means that Python modules can be shared between all three operating systems without needing to convert the line-endings.

在编译 Python 时，可以通过在运行 Python 的 configure 脚本时指定 --without-universal-newlines 开关禁用该功能。

参见

PEP 278 [https://www.python.org/dev/peps/pep-0278] - 通用换行支持

由 Jack Jansen 撰写并实现。

PEP 279: enumerate()

新的内置函数 enumerate() 将使某些循环更加清晰。 在 enumerate(thing) 中，如果 thing 是迭代器或序列，则返回一个迭代器，该迭代器将返回 (0, thing[0])，(1, thing[1])，(2, thing[2])，以此类推。

改变一个列表中每个元素的常见写法看起来像是这样:

for i in range(len(L)):
    item = L[i]
    # ... compute some result based on item ...
    L[i] = result

可以使用 enumerate() 重写为：

for i, item in enumerate(L):
    # ... compute some result based on item ...
    L[i] = result

参见

PEP 279 [https://www.python.org/dev/peps/pep-0279] - 内置函数 enumerate()

由 Raymond D. Hettinger 撰写并实现。

PEP 282: logging 包

Python 2.3 中新增了一个用于编写日志的标准软件包 logging。 它为生成日志输出提供了一个强大而灵活的机制，这些输出可以通过各种方式进行过滤和处理。用标准格式编写的配置文件可以用来控制程序的日志行为。 Python 包含的处理器可以将日志记录写入标准错误、文件或套接字，发送到系统日志，甚至通过电子邮件发送到特定地址；当然，您也可以编写自己的处理器类。

The Logger class is the primary class. Most application code will deal with one or more Logger objects, each one used by a particular subsystem of the application. Each Logger is identified by a name, and names are organized into a hierarchy using . as the component separator. For example, you might have Logger instances named server, server.auth and server.network. The latter two instances are below server in the hierarchy. This means that if you turn up the verbosity for server or direct server messages to a different handler, the changes will also apply to records logged to server.auth and server.network. There's also a root Logger that's the parent of all other loggers.

为了简化使用，logging 包提供了一些始终使用根日志的便捷函数:

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')

这会产生以下输出:

WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down

In the default configuration, informational and debugging messages are suppressed and the output is sent to standard error. You can enable the display of informational and debugging messages by calling the setLevel() method on the root logger.

Notice the warning() call's use of string formatting operators; all of the functions for logging messages take the arguments (msg, arg1, arg2, ...) and log the string resulting from msg % (arg1, arg2, ...).

There's also an exception() function that records the most recent traceback. Any of the other functions will also record the traceback if you specify a true value for the keyword argument exc_info.

def f():
    try:    1/0
    except: logging.exception('Problem recorded')

f()

这会产生以下输出:

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

稍微高级一些的程序将使用除根记录器之外的记录器。getLogger(name) 函数用于获取特定的日志，如果该日志尚不存在则创建它。getLogger(None) 返回根记录器。:

log = logging.getLogger('server')
 ...
log.info('Listening on port %i', port)
 ...
log.critical('Disk full')
 ...

Log records are usually propagated up the hierarchy, so a message logged to server.auth is also seen by server and root, but a Logger can prevent this by setting its propagate attribute to False.

There are more classes provided by the logging package that can be customized. When a Logger instance is told to log a message, it creates a LogRecord instance that is sent to any number of different Handler instances. Loggers and handlers can also have an attached list of filters, and each filter can cause the LogRecord to be ignored or can modify the record before passing it along. When they're finally output, LogRecord instances are converted to text by a Formatter class. All of these classes can be replaced by your own specially written classes.

logging 软件包具有所有这些功能，即使是最复杂的应用程序也能灵活运用。 本文仅是对其功能的不完整概述，因此请参阅软件包的参考文档了解所有细节。 阅读 PEP 282 [https://www.python.org/dev/peps/pep-0282] 也会有所帮助。

参见

PEP 282 [https://www.python.org/dev/peps/pep-0282] - Logging 系统

由 Vinay Sajip 和 Trent Mick 撰写 ; 由 Vinay Sajip 实现。

PEP 285: 布尔类型

A Boolean type was added to Python 2.3. Two new constants were added to the __builtin__ module, True and False. (True and False constants were added to the built-ins in Python 2.2.1, but the 2.2.1 versions are simply set to integer values of 1 and 0 and aren't a different type.)

这个新类型的类型对象名为 bool；它的构造函数接收任何 Python 值，并将其转换为 True 或 False。:

>>> bool(1)
True
>>> bool(0)
False
>>> bool([])
False
>>> bool( (1,) )
True

大多数标准库模块和内置函数都改为返回布尔值：

>>> obj = []
>>> hasattr(obj, 'append')
True
>>> isinstance(obj, list)
True
>>> isinstance(obj, tuple)
False

添加 Python 布尔运算的主要目的是使代码更清晰。 例如，如果您在阅读一个函数时遇到 return 1 语句，您可能会想知道 1 代表的是布尔真值、索引还是乘以其他量的系数。 然而，如果语句是 return True，返回值的含义就非常清楚了。

Python 的布尔值 不是 为了严格的类型检查而添加的。 像 Pascal 这样非常严格的语言也会阻止您使用布尔进行算术运算，并要求 if 语句中的表达式总是求布尔结果。 正如 PEP 285 [https://www.python.org/dev/peps/pep-0285] 所明确指出的，Python 没有这么严格，以后也不会有。 这意味着您仍然可以在 if 语句中使用任何表达式，甚至是求值为 list、tuple 或一些随机对象的表达式。 布尔类型是 int 类的子类，因此使用布尔值进行算术运算仍然有效：

>>> True + 1
2
>>> False + 1
1
>>> False * 75
0
>>> True * 75
75

用一句话概括 True 和 False: 它们是拼写整数值 1 和 0 的另一种方式，唯一不同的是 str() 和 repr() 返回的字符串是 'True' 和 'False'，而不是 '1' 和 '0'。

参见

PEP 285 [https://www.python.org/dev/peps/pep-0285] - 添加布尔类型

由 GvR 撰写并实现。

PEP 293: 编解码器错误处理回调

将 Unicode 字符串编码为字节字符串时，可能会遇到无法编码的字符。 到目前为止，Python 允许将错误处理指定为 "strict" (引发 UnicodeError)、"ignore" (跳过该字符) 或 "replace" (在输出字符串中使用问号)，其中 "strict" 是默认行为。 可能需要指定对此类错误的其他处理方式，例如在转换后的字符串中插入 XML 字符引用或 HTML 实体引用。

Python 现在有一个灵活的框架，可以添加不同的处理策略。可以通过 codecs.register_error() 添加新的错误处理器，然后编解码器可以通过 codecs.lookup_error() 访问错误处理器。 错误处理器会获取必要的状态信息，如正在转换的字符串、字符串中检测到错误的位置以及目标编码。 然后，处理器可以引发异常或返回替换字符串。

使用该框架还实现了两个额外的错误处理器: "backslashreplace" 使用 Python 反斜杠引号来表示无法编码的字符，而 "xmlcharrefreplace" 则转换为 XML 字符引用。

参见

PEP 293 [https://www.python.org/dev/peps/pep-0293] - 编解码器错误处理回调

由 Walter Dörwald 撰写并实现。

PEP 301: Distutils的软件包索引和元数据

广受期待的对 Python 编目的支持在 2.3 版中首次出现。

编目功能的核心是新的 Distutils register 命令。 运行 python setup.py register 将会收集描述软件包的元数据，例如其名称、版本、维护者、描述信息等等，并将其发送给中央编目服务器。 结果编目数据可在 https://pypi.org 获取。

To make the catalog a bit more useful, a new optional classifiers keyword argument has been added to the Distutils setup() function. A list of Trove [http://catb.org/~esr/trove/]-style strings can be supplied to help classify the software.

下面是一个带有分类器的 setup.py 示例，其编写是为了兼容旧版本的 Distutils：

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)

完整的 classifiers 列表可通过运行 python setup.py register --list-classifiers 来获取。

参见

PEP 301 [https://www.python.org/dev/peps/pep-0301] - Distutils 的软件包索引和元数据

由 Richard Jones 撰写并实现。

PEP 302: 新导入钩子

While it's been possible to write custom import hooks ever since the ihooks module was introduced in Python 1.3, no one has ever been really happy with it because writing new import hooks is difficult and messy. There have been various proposed alternatives such as the imputil and iu modules, but none of them has ever gained much acceptance, and none of them were easily usable from C code.

PEP 302 [https://www.python.org/dev/peps/pep-0302] borrows ideas from its predecessors, especially from Gordon McMillan's iu module. Three new items are added to the sys module:

sys.path_hooks 是一个可调用对象列表，通常是类。 每个可调用对象都接收一个包含路径的字符串，然后返回一个可处理从该路径导入的导入器对象，如果不能处理该路径，则引发 ImportError 异常。

sys.path_importer_cache 会缓存每条路径的导入器对象，因此 sys.path_hooks 只需为每条路径遍历一次。

sys.meta_path 是一个导入器对象列表，在检查 sys.path 之前将遍历该列表。 该列表最初为空，但用户代码可以向其中添加对象。 其他内置模块和冻结模块可以通过添加到该列表中的对象导入。

Importer objects must have a single method, find_module(fullname, path=None). fullname will be a module or package name, e.g. string or distutils.core. find_module() must return a loader object that has a single method, load_module(fullname), that creates and returns the corresponding module object.

因此，Python 新导入逻辑的伪代码如下 (略有简化；详情请参见 PEP 302 [https://www.python.org/dev/peps/pep-0302])：

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, so try the other path hooks
            pass
        else:
            loader = importer.find_module(fullname)
            <module> = loader.load_module(fullname)

# Not found!
raise ImportError

参见

PEP 302 [https://www.python.org/dev/peps/pep-0302] - 新导入钩

由 Just van Rossum 和 Paul Moore 撰写 ; 由 Just van Rossum 实现。

PEP 305: 逗号分隔文件

以逗号作为分隔符的文件是一种常用于从数据库和电子表格导出数据的格式。 Python 2.3 增加了一个针对逗号分隔文件的解析器。

逗号分隔文件乍一看非常简单:

Costs,150,200,3.95

读取一行并调用 line.split(','): 再简单不过了吧？ 但是考虑到可能包含逗号的字符串数据，事件就变得复杂起来:

"Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"

一个大的丑陋的正则表达式可以解析这些内容，但使用新的 csv 软件包要简单得多：

import csv

input = open('datafile', 'rb')
reader = csv.reader(input)
for line in reader:
    print line

The reader() function takes a number of different options. The field separator isn't limited to the comma and can be changed to any character, and so can the quoting and line-ending characters.

可以定义和注册不同的逗号分隔文件方言；目前有两种方言，均由 Microsoft Excel 使用。一个单独的 csv.writer 类将从一系列元组或列表生成逗号分隔文件，并对包含分隔符的字符串进行引用。

参见

该实现在“Python 增强提议” - PEP 305 (CSV 文件 API) 中被提出

由 Kevin Altis, Dave Cole, Andrew McNamara, Skip Montanaro, Cliff Wells 撰写并实现。

PEP 307：对 pickle 的改进

The pickle and cPickle modules received some attention during the 2.3 development cycle. In 2.2, new-style classes could be pickled without difficulty, but they weren't pickled very compactly; PEP 307 [https://www.python.org/dev/peps/pep-0307] quotes a trivial example where a new-style class results in a pickled string three times longer than that for a classic class.

解决办法就是发明一种新的 pickle 协议。 pickle.dumps() 函数很早就支持文本或二进制标志。 在 2.3 中，该标志从布尔值重新定义为整数：0 表示旧的文本模式 pickle 格式，1 表示旧的二进制格式，现在 2 表示新的 2.3 专用格式。 一个新常量 pickle.HIGHEST_PROTOCOL 可用来选择最先进的协议。

Unpickling is no longer considered a safe operation. 2.2's pickle provided hooks for trying to prevent unsafe classes from being unpickled (specifically, a __safe_for_unpickling__ attribute), but none of this code was ever audited and therefore it's all been ripped out in 2.3. You should not unpickle untrusted data in any version of Python.

To reduce the pickling overhead for new-style classes, a new interface for customizing pickling was added using three special methods: __getstate__(), __setstate__(), and __getnewargs__(). Consult PEP 307 [https://www.python.org/dev/peps/pep-0307] for the full semantics of these methods.

为了进一步压缩 pickle 类，现在可以使用整数代码而不是长字符串来标识 pickle 类。 Python 软件基金会将维护一个标准化代码列表；还有一系列供私人使用的代码。 目前还没有指定任何代码。

参见

PEP 307 [https://www.python.org/dev/peps/pep-0307] - pickle 协议的扩展

PEP 由 Guido van Rossum 和 Tim Peters 撰写和实现。

扩展切片

从 Python 1.4 开始，切片语法支持可选的第三个“step”或“stride”参数。例如，这些都是合法的 Python 语法: L[1:10:2]，L[:-1:1]，L[::-1]。 这是应 Numerical Python 开发者的要求添加到 Python 中的，因为 Numerical Python 广泛使用第三个参数。 然而，Python 内置的 list、tuple 和字符串序列类型从未支持过这一特性，如果您尝试使用，会引发 TypeError。 Michael Hudson 提供了一个补丁来修复这一缺陷。

例如，您现在可以轻松地提取出具有偶数索引的列表元素：

>>> L = range(10)
>>> L[::2]
[0, 2, 4, 6, 8]

也可以用负值以按相反顺序复制相同的列表：

>>> L[::-1]
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]

这也适用于元组、数组和字符串：

>>> s='abcd'
>>> s[::2]
'ac'
>>> s[::-1]
'dcba'

如果你有一个可变序列如列表或数组，你可以对扩展切片进行赋值或删除，但对扩展切片的赋值与对常规切片的赋值有一些区别。对常规片段的赋值可以用来改变序列的长度：

>>> a = range(3)
>>> a
[0, 1, 2]
>>> a[1:3] = [4, 5, 6]
>>> a
[0, 4, 5, 6]

扩展分片则没有这种灵活性。 在为扩展分片赋值时，语句右侧的列表必须包含与要替换的分片相同数量的项目：

>>> 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

删除操作更为直观：

>>> a = range(4)
>>> a
[0, 1, 2, 3]
>>> a[::2]
[0, 2]
>>> del a[::2]
>>> a
[1, 3]

One can also now pass slice objects to the __getitem__() methods of the built-in sequences:

>>> range(10).__getitem__(slice(0, 5, 2))
[0, 2, 4]

或者直接在下标中使用切片对象：

>>> range(10)[slice(0, 5, 2)]
[0, 2, 4]

To simplify implementing sequences that support extended slicing, slice objects now have a method indices(length) which, given the length of a sequence, returns a (start, stop, step) tuple that can be passed directly to range(). indices() handles omitted and out-of-bounds indices in a manner consistent with regular slices (and this innocuous phrase hides a welter of confusing details!). The method is intended to be used like this:

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)

从这个例子中还可以看到，内置的 slice 对象现在是 slice 类型的类型对象，而不再是函数。 这与 Python 2.2 是一致的，在 Python 2.2 中，int，str 等也经历了同样的变化。

其他语言特性修改

以下是 Python 2.3 针对核心 Python 语言的所有改变。

yield 语句现在将始终是关键字，如本文档的 PEP 255: 简单的生成器 一节所描述的。

新增内置函数 enumerate()，如本文档的 PEP 279: enumerate() 一节所描述的。

新增两个常量 True 和 False 以及内置的 bool 类型，如本文档的 PEP 285: 布尔类型 一节所描述的。

int() 类型构造函数现在会返回一个长整数，而不会在字符串或浮点数太大而无法放入整数时引发 OverflowError。 这可能会导致 isinstance(int(expression), int) 为假的矛盾结果，但在实践中似乎不太可能造成问题。

内置类型现在支持扩展的切分语法，详见本文档 扩展切片 一节。

一个新的内置函数 sum(iterable, start=0) 用于对可迭代对象中的数值项进行求和并返回其总和。sum() 只接受数字，意味着你不能用它来连接一堆字符串。（由 Alex Martelli 贡献。）

以前 list.insert(pos, value) 在 pos 为负值时会将 value 插入到列表的前面。 现在，该行为已被修改为与切片索引一致，因此当 pos 为 -1 时，值将被插入最后一个元素之前，以此类推。

list.index(value) 会在列表中搜索 value，并返回其索引，现在可以使用可选的 start 和 stop 参数，将搜索范围限制在列表的一部分。

字典有一个新方法 pop(key[, *default*])，可返回 key 对应的值，并从字典中删除该键/值对。如果请求的键不在字典中，如果指定了 default，则返回 default，如果没有指定则会引发 KeyError。

>>> 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
{}
>>>

还有一个新的类方法 dict.fromkeys(iterable, value)，用于创建一个字典，其键取自所提供的迭代器 iterable，所有值设置为 value，默认为 None。

（由 Raymond Hettinger 贡献补丁。）

此外，现在 dict() 构建器可接受关键字参数以简化小型字典的创建:

>>> dict(red=1, blue=2, green=3, black=4)
{'blue': 2, 'black': 4, 'green': 3, 'red': 1}

（由 Just van Rossum 贡献。）

assert 语句将不再检查 __debug__ 旗标，因此你无法再通过为 __debug__ 赋值来禁用断言。 使用 -O 开关运行 Python 仍会生成不执行任何断言的代码。

Most type objects are now callable, so you can use them to create new objects such as functions, classes, and modules. (This means that the new module can be deprecated in a future Python version, because you can now use the type objects available in the types module.) For example, you can create a new module object with the following code:

>>> import types
>>> m = types.ModuleType('abc','docstring')
>>> m
<module 'abc' (built-in)>
>>> m.__doc__
'docstring'

添加了一个新的警告 PendingDeprecationWarning，用于指示正在被废弃的功能。 默认情况下 不会 打印该警告。 要检查是否使用了将来会被废弃的功能，可在命令行中提供 -Walways::PendingDeprecationWarning:: 或使用 warnings.filterwarnings()。

与 raise "Error occurred" 一样，基于字符串的异常的废弃过程已经开始。 现在，引发字符串异常将触发 PendingDeprecationWarning。

现在使用 None 作为变量名将导致 SyntaxWarning 警告。 在未来的 Python 版本中，None 将最终成为一个保留关键字。

The xreadlines() method of file objects, introduced in Python 2.1, is no longer necessary because files now behave as their own iterator. xreadlines() was originally introduced as a faster way to loop over all the lines in a file, but now you can simply write for line in file_obj. File objects also have a new read-only encoding attribute that gives the encoding used by the file; Unicode strings written to the file will be automatically converted to bytes using the given encoding.

The method resolution order used by new-style classes has changed, though you'll only notice the difference if you have a really complicated inheritance hierarchy. Classic classes are unaffected by this change. Python 2.2 originally used a topological sort of a class's ancestors, but 2.3 now uses the C3 algorithm as described in the paper "A Monotonic Superclass Linearization for Dylan" [https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.19.3910]. To understand the motivation for this change, read Michele Simionato's article "Python 2.3 Method Resolution Order" [http://www.phyast.pitt.edu/~micheles/mro.html], or read the thread on python-dev starting with the message at https://mail.python.org/pipermail/python-dev/2002-October/029035.html. Samuele Pedroni first pointed out the problem and also implemented the fix by coding the C3 algorithm.

Python runs multithreaded programs by switching between threads after executing N bytecodes. The default value for N has been increased from 10 to 100 bytecodes, speeding up single-threaded applications by reducing the switching overhead. Some multithreaded applications may suffer slower response time, but that's easily fixed by setting the limit back to a lower number using sys.setcheckinterval(N). The limit can be retrieved with the new sys.getcheckinterval() function.

One minor but far-reaching change is that the names of extension types defined by the modules included with Python now contain the module and a '.' in front of the type name. For example, in Python 2.2, if you created a socket and printed its __class__, you'd get this output:

>>> s = socket.socket()
>>> s.__class__
<type 'socket'>

在 2.3 中，您会得到以下信息：

>>> s.__class__
<type '_socket.socket'>

旧式和新式类之间的不兼容问题之一已被消除：您现在可以为新式类的 __name__ 和 __bases__ 属性赋值。 对 __bases__ 的赋值有一些限制，与对实例的 __class__ 属性的赋值类似。

字符串的改变

in 运算符现在对字符串的作用不同了。 以前，当计算 X in Y 时，X 和 Y 都是字符串，X 只能是单字符。 现在情况有所改变；X 可以是任意长度的字符串，如果 X 是 Y 的子串，X in Y 将返回 True。 如果 X 是空字符串，结果总是 True。

>>> 'ab' in 'abcd'
True
>>> 'ad' in 'abcd'
False
>>> '' in 'abcd'
True

Note that this doesn't tell you where the substring starts; if you need that information, use the find() string method.

The strip(), lstrip(), and rstrip() string methods now have an optional argument for specifying the characters to strip. The default is still to remove all whitespace characters:

>>> '   abc '.strip()
'abc'
>>> '><><abc<><><>'.strip('<>')
'abc'
>>> '><><abc<><><>\n'.strip('<>')
'abc<><><>\n'
>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
u'\u4001abc'
>>>

（由 Simon Brunning 提议并由 Walter Dörwald 实现。）

The startswith() and endswith() string methods now accept negative numbers for the start and end parameters.

Another new string method is zfill(), originally a function in the string module. zfill() pads a numeric string with zeros on the left until it's the specified width. Note that the % operator is still more flexible and powerful than zfill().

>>> '45'.zfill(4)
'0045'
>>> '12345'.zfill(4)
'12345'
>>> 'goofy'.zfill(6)
'0goofy'

（由 Walter Dörwald 贡献。）

A new type object, basestring, has been added. Both 8-bit strings and Unicode strings inherit from this type, so isinstance(obj, basestring) will return True for either kind of string. It's a completely abstract type, so you can't create basestring instances.

内部字符串不再是不朽的，现在当它们唯一的引用来自内部字符串字典时，将按照通常的方式进行垃圾回收。（由 Oren Tirosh 实现。）

性能优化

新式类实例的创建速度获得大幅提升；现在已经比经典类更快了！

The sort() method of list objects has been extensively rewritten by Tim Peters, and the implementation is significantly faster.

Multiplication of large long integers is now much faster thanks to an implementation of Karatsuba multiplication, an algorithm that scales better than the O(n*n) required for the grade-school multiplication algorithm. (Original patch by Christopher A. Craig, and significantly reworked by Tim Peters.)

SET_LINENO 操作码现已移除。这可能提供小幅速度提升，具体取决于你编译器的特性。详见 其他的改变和修正 部分的详细解释。（由Michael Hudson移除。）

xrange() objects now have their own iterator, making for i in xrange(n) slightly faster than for i in range(n). (Patch by Raymond Hettinger.)

在多个热点区域进行了一些小的调整以提升性能，例如内联函数或移除部分代码。（主要由GvR实现，但许多人都贡献了单个更改。）

2.3 优化的总体结果是 Python 2.3 运行 pystone 基准测试的速度比 Python 2.2 加快了大约 25%。

新增，改进和弃用的模块

一如既往，Python的标准库获得了一些增强和错误修复。以下是一些最显著变化的部分列表，按模块名称字母顺序排序。请查阅源树中的 Misc/NEWS 文件以获取更完整的变化列表，或通过CVS日志查看所有细节。

array 模块现在支持使用 'u' 格式字符的Unicode字符数组。数组还支持使用 += 赋值运算符来添加另一个数组的内容，以及使用 *= 赋值运算符来重复数组。（由 Jason Orendorff 贡献。）

The bsddb module has been replaced by version 4.1.6 of the PyBSDDB [https://pybsddb.sourceforge.net] package, providing a more complete interface to the transactional features of the BerkeleyDB library.

The old version of the module has been renamed to bsddb185 and is no longer built automatically; you'll have to edit Modules/Setup to enable it. Note that the new bsddb package is intended to be compatible with the old module, so be sure to file bugs if you discover any incompatibilities. When upgrading to Python 2.3, if the new interpreter is compiled with a new version of the underlying BerkeleyDB library, you will almost certainly have to convert your database files to the new version. You can do this fairly easily with the new scripts db2pickle.py and pickle2db.py which you will find in the distribution's Tools/scripts directory. If you've already been using the PyBSDDB package and importing it as bsddb3, you will have to change your import statements to import it as bsddb.

新的 bz2 模块是 bz2 数据压缩库的接口。bz2 压缩的数据通常比相应的 zlib-压缩数据更小。（由 Gustavo Niemeyer 贡献。）

在新的 datetime 模块中添加了一组标准日期/时间类型。更多详细信息请参见下一节。

The Distutils Extension class now supports an extra constructor argument named depends for listing additional source files that an extension depends on. This lets Distutils recompile the module if any of the dependency files are modified. For example, if sampmodule.c includes the header file sample.h, you would create the Extension object like this:

ext = Extension("samp",
                sources=["sampmodule.c"],
                depends=["sample.h"])

修改 sample.h 将导致模块被重新编译。 （由 Jeremy Hylton 贡献。）

Other minor changes to Distutils: it now checks for the CC, CFLAGS, CPP, LDFLAGS, and CPPFLAGS environment variables, using them to override the settings in Python's configuration (contributed by Robert Weber).

Previously the doctest module would only search the docstrings of public methods and functions for test cases, but it now also examines private ones as well. The DocTestSuite() function creates a unittest.TestSuite object from a set of doctest tests.

新的 gc.get_referents(object) 函数将返回由 object 引用的所有对象组成的列表。

The getopt module gained a new function, gnu_getopt(), that supports the same arguments as the existing getopt() function but uses GNU-style scanning mode. The existing getopt() stops processing options as soon as a non-option argument is encountered, but in GNU-style mode processing continues, meaning that options and arguments can be mixed. For 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', '')], ['output'])

（由 Peter Åstrand 贡献。）

现在 grp, pwd 和 resource 模块将返回加强版的元组:

>>> import grp
>>> g = grp.getgrnam('amk')
>>> g.gr_name, g.gr_gid
('amk', 500)

现在 gzip 模块能够处理超过 2 GiB 的文件。

The new heapq module contains an implementation of a heap queue algorithm. A heap is an array-like data structure that keeps items in a partially sorted order such that, for every index k, heap[k] <= heap[2*k+1] and heap[k] <= heap[2*k+2]. This makes it quick to remove the smallest item, and inserting a new item while maintaining the heap property is O(lg n). (See https://xlinux.nist.gov/dads//HTML/priorityque.html for more information about the priority queue data structure.)

The heapq module provides heappush() and heappop() functions for adding and removing items while maintaining the heap property on top of some other mutable Python sequence type. Here's an example that uses a Python list:

>>> 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]

（由 Kevin O'Connor 贡献。）

The IDLE integrated development environment has been updated using the code from the IDLEfork project (http://idlefork.sourceforge.net). The most notable feature is that the code being developed is now executed in a subprocess, meaning that there's no longer any need for manual reload() operations. IDLE's core code has been incorporated into the standard library as the idlelib package.

模块 imaplib 现在支持通过 SSL 的 IMAP。（由 Piers Lauder 和 Tino Lange 贡献。）

The itertools contains a number of useful functions for use with iterators, inspired by various functions provided by the ML and Haskell languages. For example, itertools.ifilter(predicate, iterator) returns all elements in the iterator for which the function predicate() returns True, and itertools.repeat(obj, N) returns obj N times. There are a number of other functions in the module; see the package's reference documentation for details. (Contributed by Raymond Hettinger.)

模块 math 中新增了两个函数，degrees(rads) 和 radians(degs)，用于在弧度和度之间进行转换。模块 math 中的其他函数，如 math.sin() 和 math.cos()，一直需要以弧度为单位输入值。此外，math.log() 函数增加了一个可选的 base 参数，以便更容易计算除 e 和 10 以外的对数。（由 Raymond Hettinger 贡献。）

Several new POSIX functions (getpgid(), killpg(), lchown(), loadavg(), major(), makedev(), minor(), and mknod()) were added to the posix module that underlies the os module. (Contributed by Gustavo Niemeyer, Geert Jansen, and Denis S. Otkidach.)

In the os module, the *stat() family of functions can now report fractions of a second in a timestamp. Such time stamps are represented as floats, similar to the value returned by time.time().

During testing, it was found that some applications will break if time stamps are floats. For compatibility, when using the tuple interface of the stat_result time stamps will be represented as integers. When using named fields (a feature first introduced in Python 2.2), time stamps are still represented as integers, unless os.stat_float_times() is invoked to enable float return values:

>>> os.stat("/tmp").st_mtime
1034791200
>>> os.stat_float_times(True)
>>> os.stat("/tmp").st_mtime
1034791200.6335014

在 Python 2.4 中，默认将改为总是返回浮点数。

Application developers should enable this feature only if all their libraries work properly when confronted with floating point time stamps, or if they use the tuple API. If used, the feature should be activated on an application level instead of trying to enable it on a per-use basis.

optparse 模块包含一个新的命令行参数解析器，可以将选项值转换为特定的Python类型，并自动生成使用说明。更多详情请参见下一节。

The old and never-documented linuxaudiodev module has been deprecated, and a new version named ossaudiodev has been added. The module was renamed because the OSS sound drivers can be used on platforms other than Linux, and the interface has also been tidied and brought up to date in various ways. (Contributed by Greg Ward and Nicholas FitzRoy-Dale.)

新的 platform 模块包含多个函数，尝试确定你正在运行的平台的各项属性。有获取架构、CPU类型、Windows操作系统版本，甚至Linux发行版版本的函数。（由Marc-André Lemburg贡献。）

The parser objects provided by the pyexpat module can now optionally buffer character data, resulting in fewer calls to your character data handler and therefore faster performance. Setting the parser object's buffer_text attribute to True will enable buffering.

The sample(population, k) function was added to the random module. population is a sequence or xrange object containing the elements of a population, and sample() chooses k elements from the population without replacing chosen elements. k can be any value up to len(population). For example:

>>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
>>> random.sample(days, 3)      # Choose 3 elements
['St', 'Sn', 'Th']
>>> random.sample(days, 7)      # Choose 7 elements
['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
>>> random.sample(days, 7)      # Choose 7 again
['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
>>> random.sample(days, 8)      # Can't choose eight
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]

现在 random 模块使用新的“梅森旋转”算法，并以 C 实现。 它的速度更快并且与之前的算法相比研究更充分。

（所有改变均由 Raymond Hettinger 贡献。）

The readline module also gained a number of new functions: get_history_item(), get_current_history_length(), and redisplay().

The rexec and Bastion modules have been declared dead, and attempts to import them will fail with a RuntimeError. New-style classes provide new ways to break out of the restricted execution environment provided by rexec, and no one has interest in fixing them or time to do so. If you have applications using rexec, rewrite them to use something else.

(Sticking with Python 2.2 or 2.1 will not make your applications any safer because there are known bugs in the rexec module in those versions. To repeat: if you're using rexec, stop using it immediately.)

The rotor module has been deprecated because the algorithm it uses for encryption is not believed to be secure. If you need encryption, use one of the several AES Python modules that are available separately.

shutil 模块新增了一个 move(src, dest) 函数，用于递归地将文件或目录移动到新位置。

对更高级的 POSIX 信号处理的支持已添加到 signal 模块中，但随后又因无法在各个平台间可靠地工作而被移除。

socket 模块现在支持超时设置。你可以在套接字对象上调用 settimeout(t) 方法来设置 t 秒的超时时间。后续的套接字操作如果超过 t 秒未完成将被中止，并引发 socket.timeout 异常。

最初的超时实现由 Tim O'Malley 完成。Michael Gilfix 将其集成到 Python 的 socket 模块中，并经过长时间的审查。代码提交后，Guido van Rossum 重写了部分内容。（这是一个协作开发过程的良好示例。）

在 Windows，socket 模块现在将附带安全套接字层（SSL）支持。

现在 C PYTHON_API_VERSION 宏的值将在 Python 层级上暴露为 sys.api_version。 当前的异常可通过调用新的 sys.exc_clear() 函数来清除。

新的 tarfile 模块允许读取和写入 tar格式的归档文件。（由 Lars Gustäbel 贡献。)

The new textwrap module contains functions for wrapping strings containing paragraphs of text. The wrap(text, width) function takes a string and returns a list containing the text split into lines of no more than the chosen width. The fill(text, width) function returns a single string, reformatted to fit into lines no longer than the chosen width. (As you can guess, fill() is built on top of wrap(). For 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.
>>>

The module also contains a TextWrapper class that actually implements the text wrapping strategy. Both the TextWrapper class and the wrap() and fill() functions support a number of additional keyword arguments for fine-tuning the formatting; consult the module's documentation for details. (Contributed by Greg Ward.)

The thread and threading modules now have companion modules, dummy_thread and dummy_threading, that provide a do-nothing implementation of the thread module's interface for platforms where threads are not supported. The intention is to simplify thread-aware modules (ones that don't rely on threads to run) by putting the following code at the top:

try:
    import threading as _threading
except ImportError:
    import dummy_threading as _threading

In this example, _threading is used as the module name to make it clear that the module being used is not necessarily the actual threading module. Code can call functions and use classes in _threading whether or not threads are supported, avoiding an if statement and making the code slightly clearer. This module will not magically make multithreaded code run without threads; code that waits for another thread to return or to do something will simply hang forever.

The time module's strptime() function has long been an annoyance because it uses the platform C library's strptime() implementation, and different platforms sometimes have odd bugs. Brett Cannon contributed a portable implementation that's written in pure Python and should behave identically on all platforms.

The new timeit module helps measure how long snippets of Python code take to execute. The timeit.py file can be run directly from the command line, or the module's Timer class can be imported and used directly. Here's a short example that figures out whether it's faster to convert an 8-bit string to Unicode by appending an empty Unicode string to it or by using the unicode() function:

import timeit

timer1 = timeit.Timer('unicode("abc")')
timer2 = timeit.Timer('"abc" + u""')

# Run three trials
print timer1.repeat(repeat=3, number=100000)
print timer2.repeat(repeat=3, number=100000)

# On my laptop this outputs:
# [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
# [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]

The Tix module has received various bug fixes and updates for the current version of the Tix package.

The Tkinter module now works with a thread-enabled version of Tcl. Tcl's threading model requires that widgets only be accessed from the thread in which they're created; accesses from another thread can cause Tcl to panic. For certain Tcl interfaces, Tkinter will now automatically avoid this when a widget is accessed from a different thread by marshalling a command, passing it to the correct thread, and waiting for the results. Other interfaces can't be handled automatically but Tkinter will now raise an exception on such an access so that you can at least find out about the problem. See https://mail.python.org/pipermail/python-dev/2002-December/031107.html for a more detailed explanation of this change. (Implemented by Martin von Löwis.)

Calling Tcl methods through _tkinter no longer returns only strings. Instead, if Tcl returns other objects those objects are converted to their Python equivalent, if one exists, or wrapped with a _tkinter.Tcl_Obj object if no Python equivalent exists. This behavior can be controlled through the wantobjects() method of tkapp objects.

When using _tkinter through the Tkinter module (as most Tkinter applications will), this feature is always activated. It should not cause compatibility problems, since Tkinter would always convert string results to Python types where possible.

If any incompatibilities are found, the old behavior can be restored by setting the wantobjects variable in the Tkinter module to false before creating the first tkapp object.

import Tkinter
Tkinter.wantobjects = 0

由此更改引起的任何问题都应作为错误报告。

The UserDict module has a new DictMixin class which defines all dictionary methods for classes that already have a minimum mapping interface. This greatly simplifies writing classes that need to be substitutable for dictionaries, such as the classes in the shelve module.

Adding the mix-in as a superclass provides the full dictionary interface whenever the class defines __getitem__(), __setitem__(), __delitem__(), and keys(). For 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']

（由 Raymond Hettinger 贡献。）

The DOM implementation in xml.dom.minidom can now generate XML output in a particular encoding by providing an optional encoding argument to the toxml() and toprettyxml() methods of DOM nodes.

The xmlrpclib module now supports an XML-RPC extension for handling nil data values such as Python's None. Nil values are always supported on unmarshalling an XML-RPC response. To generate requests containing None, you must supply a true value for the allow_none parameter when creating a Marshaller instance.

The new DocXMLRPCServer module allows writing self-documenting XML-RPC servers. Run it in demo mode (as a program) to see it in action. Pointing the web browser to the RPC server produces pydoc-style documentation; pointing xmlrpclib to the server allows invoking the actual methods. (Contributed by Brian Quinlan.)

已添加对国际化域名（RFC 3454、3490、3491 和 3492）的支持。可以使用 "idna" 编码在 Unicode 域名和该名称的 ASCII 兼容编码（ACE）之间进行转换。:

>{}>{}> u"www.Alliancefrançaise.nu".encode("idna")
'www.xn--alliancefranaise-npb.nu'

The socket module has also been extended to transparently convert Unicode hostnames to the ACE version before passing them to the C library. Modules that deal with hostnames such as httplib and ftplib) also support Unicode host names; httplib also sends HTTP Host headers using the ACE version of the domain name. urllib supports Unicode URLs with non-ASCII host names as long as the path part of the URL is ASCII only.

为实现此项更改，增加了 stringprep 模块，mkstringprep 工具以及 punycode 编码格式。

Date/Time 类型

通过 datetime 模块增加了适用于表示时间戳的日期和时间类型。 这些类型并不支持其他的历法或很多丰富的特性，只专注于简单地表示时间。

The three primary types are: date, representing a day, month, and year; time, consisting of hour, minute, and second; and datetime, which contains all the attributes of both date and time. There's also a timedelta class representing differences between two points in time, and time zone logic is implemented by classes inheriting from the abstract tzinfo class.

You can create instances of date and time by either supplying keyword arguments to the appropriate constructor, e.g. datetime.date(year=1972, month=10, day=15), or by using one of a number of class methods. For example, the date.today() class method returns the current local date.

一旦创建，日期/时间类的实例都是不可变的。有几种方法可以从对象生成格式化字符串：

>>> import datetime
>>> now = datetime.datetime.now()
>>> now.isoformat()
'2002-12-30T21:27:03.994956'
>>> now.ctime()  # Only available on date, datetime
'Mon Dec 30 21:27:03 2002'
>>> now.strftime('%Y %d %b')
'2002 30 Dec'

The replace() method allows modifying one or more fields of a date or datetime instance, returning a new instance:

>>> d = datetime.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)
>>>

Instances can be compared, hashed, and converted to strings (the result is the same as that of isoformat()). date and datetime instances can be subtracted from each other, and added to timedelta instances. The largest missing feature is that there's no standard library support for parsing strings and getting back a date or datetime.

更多相关信息，请参阅模块的参考文档。 （由 Tim Peters 贡献。）

optparse 模块

getopt 模块提供了简单的命令行参数解析。新的 optparse 模块（原名Optik）提供了更复杂的命令行解析，遵循Unix约定，自动创建 --help 的输出，并且可以为不同的选项执行不同的操作。

You start by creating an instance of OptionParser and telling it what your program's options are.

import sys
from optparse import OptionParser

op = OptionParser()
op.add_option('-i', '--input',
              action='store', type='string', dest='input',
              help='set input filename')
op.add_option('-l', '--length',
              action='store', type='int', dest='length',
              help='set maximum length of output')

Parsing a command line is then done by calling the parse_args() method.

options, args = op.parse_args(sys.argv[1:])
print options
print args

这将返回一个包含所有选项值的对象，以及一个包含剩余参数的字符串列表。

现在，使用各种参数调用脚本将按预期工作。请注意，长度参数会自动转换为整数。

$ ./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}>
[]
$

帮助信息会自动为你生成：

$ ./python opt.py --help
usage: opt.py [options]

options:
  -h, --help            show this help message and exit
  -iINPUT, --input=INPUT
                        set input filename
  -lLENGTH, --length=LENGTH
                        set maximum length of output
$

有关更多详细信息，请参见模块的文档。

Optik 由 Greg Ward 编写，吸收了 Getopt SIG 读者的建议。

Pymalloc：一种专用对象分配器

Pymalloc 是由 Vladimir Marangozov 编写的一种专用对象分配器，作为特性添加到 Python 2.1 中。Pymalloc 旨在比系统的 malloc() 更快，并且对于典型的 Python 程序分配模式具有更低的内存开销。该分配器使用 C 的 malloc() 函数获取大内存池，然后从这些池中满足较小的内存请求。

在 2.1 和 2.2 版中，pymalloc 是一个实验性特性，默认不启用；你必须在编译 Python 时通过向 configure 脚本提供 --with-pymalloc 选项来显式启用它。在 2.3 版中，pymalloc 进行了进一步改进，现在默认启用；你需要提供 --without-pymalloc 选项来禁用它。

这一更改对用 Python 编写的代码是透明的；然而，pymalloc 可能会暴露 C 扩展中的错误。C 扩展模块的作者应该测试其代码在 pymalloc 启用时的表现，因为一些不正确的代码可能导致运行时核心转储。

有一个特别常见的错误会导致问题。Python的C API中有许多内存分配函数，之前只是C库中 malloc() 和 free() 的别名，这意味着如果你不小心调用了不匹配的函数，错误可能不会被注意到。当对象分配器启用时，这些函数不再是 malloc() 和 free() 的别名，调用错误的函数来释放内存可能会导致核心转储。例如，如果内存是使用 PyObject_Malloc() 分配的，它必须使用 PyObject_Free() 来释放，而不是 free()。Python自带的一些模块就遇到了这个问题，并且必须修复；毫无疑问，还有更多的第三方模块也会存在同样的问题。

作为这一变化的一部分，令人困惑的多种内存分配接口已被整合为两个API家族。使用一个家族分配的内存不得使用另一个家族的函数进行操作。有一个家族用于分配内存块，另一个家族的函数专门用于分配Python对象。

要分配和释放一个普通的内存块，使用“原始内存”家族：PyMem_Malloc()，PyMem_Realloc() 和 PyMem_Free()。

“对象内存”家族是上述pymalloc设施的接口，偏向于大量“小”分配：PyObject_Malloc()，PyObject_Realloc() 和 PyObject_Free()。

To allocate and free Python objects, use the "object" family PyObject_New(), PyObject_NewVar(), and PyObject_Del().

感谢Tim Peters的大量工作，2.3中的pymalloc还提供了调试功能，用于捕获扩展模块和解释器本身的内存覆盖和双重释放。要启用此支持，请通过运行带:option:!--with-pydebug`选项的 :program:`configure 命令来编译Python解释器的调试版本。

为了帮助扩展开发者，Python 2.3的源代码中分发了一个头文件:file:Misc/pymemcompat.h，它允许Python扩展在编译针对自1.5.2以来的任何版本的Python时使用2.3的内存分配接口。你需要从Python的源代码分发中复制该文件，并将其与你的扩展源代码捆绑在一起。

参见

https://hg.python.org/cpython/file/default/Objects/obmalloc.c

有关pymalloc实现的详细信息，请参阅Python源代码中 Objects/obmalloc.c 文件顶部的注释。上述链接指向python.org SVN浏览器中的该文件。

构建和 C API 的改变

针对 Python 构建过程和 C API 的改变包括:

垃圾收集使用的循环检测实现已被证明是稳定的，因此现在已被设为强制性。你不能再编译不带此功能的Python，且 configure 中的 --with-cycle-gc 选项已被移除。

现在可以可选地将Python构建为共享库(libpython2.3.so)，方法是在运行Python的 configure 脚本时提供 --enable-shared 选项。（由 Ondrej Palkovsky 贡献。）

The DL_EXPORT and DL_IMPORT macros are now deprecated. Initialization functions for Python extension modules should now be declared using the new macro PyMODINIT_FUNC, while the Python core will generally use the PyAPI_FUNC and PyAPI_DATA macros.

通过向 configure 脚本提供 --without-doc-strings 选项，可以编译不带任何内置函数和模块文档字符串的解释器。这使得Python可执行文件大约减小了10%，但也意味着你无法获取Python内置函数的帮助。（由 Gustavo Niemeyer 贡献。）

The PyArg_NoArgs() macro is now deprecated, and code that uses it should be changed. For Python 2.2 and later, the method definition table can specify the METH_NOARGS flag, signalling that there are no arguments, and the argument checking can then be removed. If compatibility with pre-2.2 versions of Python is important, the code could use PyArg_ParseTuple(args, "") instead, but this will be slower than using METH_NOARGS.

PyArg_ParseTuple() 接受新的格式字符来表示各种大小的无符号整数：B 表示 unsigned char，H 表示 unsigned short int，I 表示 unsigned int，以及 K 表示 unsigned long long。

新增了一个函数 PyObject_DelItemString(mapping, char *key)，作为 PyObject_DelItem(mapping, PyString_New(key)) 的简写。

文件对象现在以不同的方式管理其内部字符串缓冲区，需要在时按指数增加。这导致 Lib/test/test_bufio.py 中的基准测试速度显著提升（根据一次测量，从 57 秒提升到 1.7 秒）。

It's now possible to define class and static methods for a C extension type by setting either the METH_CLASS or METH_STATIC flags in a method's PyMethodDef structure.

Python 现在包含 Expat XML 解析器的源代码副本，消除了对系统版本或本地安装的 Expat 的依赖。

If you dynamically allocate type objects in your extension, you should be aware of a change in the rules relating to the __module__ and __name__ attributes. In summary, you will want to ensure the type's dictionary contains a '__module__' key; making the module name the part of the type name leading up to the final period will no longer have the desired effect. For more detail, read the API reference documentation or the source.

移植专属的改变

Support for a port to IBM's OS/2 using the EMX runtime environment was merged into the main Python source tree. EMX is a POSIX emulation layer over the OS/2 system APIs. The Python port for EMX tries to support all the POSIX-like capability exposed by the EMX runtime, and mostly succeeds; fork() and fcntl() are restricted by the limitations of the underlying emulation layer. The standard OS/2 port, which uses IBM's Visual Age compiler, also gained support for case-sensitive import semantics as part of the integration of the EMX port into CVS. (Contributed by Andrew MacIntyre.)

在 MacOS 上，大多数工具箱模块已经通过弱链接来提高向后兼容性。这意味着如果当前 OS 版本中缺少单个例程，模块将不再加载失败。相反，调用缺失的例程将引发异常。（由 Jack Jansen 贡献。）

位于 Python 源代码分发版中的 Misc/RPM/ 目录中的 RPM 规范文件已更新为 2.3 版。（由 Sean Reifschneider 贡献。）

Python 现在支持的其他新平台包括 AtheOS（http://www.atheos.cx/）、GNU/Hurd 和 OpenVMS。

其他的改变和修正

一如既往，源代码树中散布着许多其他改进和错误修复。通过搜索 CVS 更改日志，发现在 Python 2.2 和 2.3 之间应用了 523 个补丁并修复了 514 个错误。这两个数字可能都被低估了。

一些较为重要的改变:

如果设置了 PYTHONINSPECT 环境变量，Python 解释器在运行 Python 程序后会进入交互式提示符，就像使用 -i 选项调用 Python 一样。环境变量可以在运行 Python 解释器之前设置，也可以由 Python 程序在其执行过程中设置。

regrtest.py 脚本现在提供了一种方法，允许“所有资源除了 foo。”传递给 -u 选项的资源名现在可以以连字符（'-'）为前缀，表示“移除此资源”。例如，选项 '-uall,-bsddb' 可以用来启用除 bsddb 以外的所有资源。

用于构建文档的工具现在在 Cygwin 和 Unix 下都能工作。

SET_LINENO 操作码已被移除。在很久以前，这个操作码用于在追溯中生成行号和支持跟踪函数（例如，pdb）。自 Python 1.5 起，追溯中的行号已通过不同的机制计算，该机制与“python -O”兼容。对于 Python 2.3，Michael Hudson 实现了一个类似的方案来确定何时调用跟踪函数，完全移除了对 SET_LINENO 的需求。

从 Python 代码中很难检测到由此产生的差异，除非在未使用 -O 的情况下运行 Python 时会有轻微的速度提升。

C extensions that access the f_lineno field of frame objects should instead call PyCode_Addr2Line(f->f_code, f->f_lasti). This will have the added effect of making the code work as desired under "python -O" in earlier versions of Python.

A nifty new feature is that trace functions can now assign to the f_lineno attribute of frame objects, changing the line that will be executed next. A jump command has been added to the pdb debugger taking advantage of this new feature. (Implemented by Richie Hindle.)

移植到 Python 2.3

本节列出了先前描述的可能需要修改你的代码的改变：

现在 yield 始终是一个关键字；如果它在你的代码中被用作变量名，则必须选择不同的名称。

对于字符串 X 和 Y，X in Y 现在当 X 长度超过一个字符时也是有效的。

现在 int() 类型构造器在字符串或浮点数因太大而无法以整数类型来容纳时将返回一个长整数而不是引发 OverflowError。

如果你的 Unicode 字符串包含 8 位字符，你必须通过在文件顶部添加注释来声明文件的编码（UTF-8、Latin-1 或其他）。更多信息请参见 PEP 263: 源代码的字符编码格式 部分。

Calling Tcl methods through _tkinter no longer returns only strings. Instead, if Tcl returns other objects those objects are converted to their Python equivalent, if one exists, or wrapped with a _tkinter.Tcl_Obj object if no Python equivalent exists.

像 0xffffffff 这样的大型八进制和十六进制字面量现在会触发 FutureWarning。目前它们被存储为 32 位数字，并导致负值，但在 Python 2.4 中，它们将变为正的长整数。

有几种方法可以修复这个警告。如果你确实需要一个正数，只需在字面量末尾添加一个 L。如果你试图获取一个低位设置的 32 位整数，并且之前使用了类似 ~(1 << 31) 的表达式，最清晰的方法是从所有位都设置开始，然后清除所需的高位。例如，要仅清除最高位（位 31），你可以写 0xffffffffL &~(1L<<31)。

你不能再通过赋值给 __debug__ 来禁用断言。

The Distutils setup() function has gained various new keyword arguments such as depends. Old versions of the Distutils will abort if passed unknown keywords. A solution is to check for the presence of the new get_distutil_options() function in your setup.py and only uses the new keywords with a version of the Distutils that supports them:

from distutils import core

kw = {'sources': 'foo.c', ...}
if hasattr(core, 'get_distutil_options'):
    kw['depends'] = ['foo.h']
ext = Extension(**kw)

现在使用 None 作为变量名将会导致 SyntaxWarning 警告。

由 Python 包含的模块定义的扩展类型名称现在包含模块和一个在类型名称前的 '.'。

致谢

作者感谢以下人员为本文的各种草案提供建议，更正和帮助： 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.

Python 2.2 有什么新变化

作者

A.M. Kuchling

概述

本文本介绍了 Python 2.2.2 的新增特性，该版本发布于 2002 年 10 月 14日。 Python 2.2.2 是 Python 2.2 的问题修正发布版，最初发布于 2001 年 12 月 21 日。

Python 2.2 可以被看作是 "清理发布版"。 有一些特性如生成器和迭代器等是全新的，但大多数变化，尽管可能是重大而深远的，都是为了清理语言设计中的不规范和阴暗角落。

本文并不试图提供对新特性的完整规范说明，而是提供一个便捷的概览。 要获取全部细节，你应该参阅 Python 2.2 的文档，比如 Python 库参考 [https://docs.python.org/2.2/lib/lib.html] 和 Python 参考指南 [https://docs.python.org/2.2/ref/ref.html]。 如果你想要了解某项更改的完整实现和设计理念，请参阅特定新特性的 PEP。

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

Python 2.2 中最大且影响最深远的改变是针对 Python 的对象和类模型。 这些变化应该是向下兼容的，因此你的代码将能继续运行而无需修改，但这些变化提供了一些很棒的新功能。 在开始本文最长和最复杂的部分之前，我提供对这些变化的概览并附带一些注释。

A long time ago I wrote a web page listing flaws in Python's design. One of the most significant flaws was that it's impossible to subclass Python types implemented in C. In particular, it's not possible to subclass built-in types, so you can't just subclass, say, lists in order to add a single useful method to them. The UserList module provides a class that supports all of the methods of lists and that can be subclassed further, but there's lots of C code that expects a regular Python list and won't accept a UserList instance.

Python 2.2 修正了此问题，并在此过程中添加了一些令人激动的新功能。 简明概述如下:

你可以继承内置类型，例如列表和整数，并且你的子类应该在任何需要原始类型的地方正常工作。这使得 Python 的面向对象编程更加灵活和强大。

现在，除了之前版本的 Python 中可用的实例方法外，还可以定义静态方法和类方法。这使得你可以更灵活地组织类的行为。

It's also possible to automatically call methods on accessing or setting an instance attribute by using a new mechanism called properties. Many uses of __getattr__() can be rewritten to use properties instead, making the resulting code simpler and faster. As a small side benefit, attributes can now have docstrings, too.

可以使用 __slots__ 限制实例的合法属性列表，从而防止拼写错误，并且在未来的 Python 版本中可能进行更多的优化。

一些用户对这些变化表示担忧。确实，他们说，新功能很棒，可以实现以前版本的 Python 无法做到的各种技巧，但它们也使语言变得更加复杂。一些人表示，他们一直推荐 Python 是因为它的简单性，现在感觉这种简单性正在丧失。

个人而言，我认为没有必要担心。许多新功能相当深奥，你可以编写大量 Python 代码而不需要了解它们。编写一个简单的类并不比以前更难，因此除非确实需要，否则你不必费心去学习或教授这些新功能。一些以前只有在 C 语言中才能实现的非常复杂的任务，现在可以用纯 Python 实现，在我看来，这一切都更好了。

我不会尝试涵盖所有为了使新功能生效而需要的每一个边缘情况和小改动。相反，本节将只勾勒出大致的轮廓。有关 Python 2.2 新对象模型的更多信息，请参见 相关链接 的“相关链接”部分。

旧式类和新式类

首先，你应该知道 Python 2.2 实际上有两种类型的类：经典类（或旧式类）和新式类。旧式类模型与早期版本的 Python 中的类模型完全相同。本节描述的所有新功能仅适用于新式类。这种分歧并不是永久的；最终，旧式类将被淘汰，可能在 Python 3.0 中被移除。

那么如何定义一个新式类呢？你可以通过继承一个现有的新式类来实现。大多数 Python 内置类型，如整数、列表、字典，甚至文件，现在都是新式类。此外，还添加了一个名为 object 的新式类，它是所有内置类型的基类，因此如果没有合适的内置类型，你可以直接继承 object 类：

class C(object):
    def __init__ (self):
        ...
    ...

This means that class statements that don't have any base classes are always classic classes in Python 2.2. (Actually you can also change this by setting a module-level variable named __metaclass__ --- see PEP 253 [https://www.python.org/dev/peps/pep-0253] for the details --- but it's easier to just subclass object.)

内置类型的类型对象在 Python 2.2 中作为内置对象提供，使用了一种巧妙的技巧命名。Python 一直有名为 int()、float() 和 str() 的内置函数。在 Python 2.2 中，它们不再是函数，而是作为被调用时表现为工厂的类型对象。

>>> int
<type 'int'>
>>> int('123')
123

To make the set of types complete, new type objects such as dict() and file() have been added. Here's a more interesting example, adding a lock() method to file objects:

class LockableFile(file):
    def lock (self, operation, length=0, start=0, whence=0):
        import fcntl
        return fcntl.lockf(self.fileno(), operation,
                           length, start, whence)

The now-obsolete posixfile module contained a class that emulated all of a file object's methods and also added a lock() method, but this class couldn't be passed to internal functions that expected a built-in file, something which is possible with our new LockableFile.

描述器

In previous versions of Python, there was no consistent way to discover what attributes and methods were supported by an object. There were some informal conventions, such as defining __members__ and __methods__ attributes that were lists of names, but often the author of an extension type or a class wouldn't bother to define them. You could fall back on inspecting the __dict__ of an object, but when class inheritance or an arbitrary __getattr__() hook were in use this could still be inaccurate.

新类模型的一个核心理念是正式化了使用描述符来描述对象属性的 API。描述符指定属性的值，说明它是方法还是字段。通过描述符 API，静态方法和类方法成为可能，以及其他更复杂的构造。

属性描述符是存在于类对象内部的对象，它们自身具有一些属性。描述符协议由三个主要方法组成：

__name__ 是属性的名称。

__doc__ 是属性的文档字符串。

__get__(object) 是一个从 object 中提取属性值的方法。

__set__(object, value) 将 object 上的属性设为 value。

__delete__(object, value) 将删除 object 的 value 属性。

例如，当你写下 obj.x，Python 实际要执行的步骤是:

descriptor = obj.__class__.x
descriptor.__get__(obj)

For methods, descriptor.__get__() returns a temporary object that's callable, and wraps up the instance and the method to be called on it. This is also why static methods and class methods are now possible; they have descriptors that wrap up just the method, or the method and the class. As a brief explanation of these new kinds of methods, static methods aren't passed the instance, and therefore resemble regular functions. Class methods are passed the class of the object, but not the object itself. Static and class methods are defined like this:

class C(object):
    def f(arg1, arg2):
        ...
    f = staticmethod(f)

    def g(cls, arg1, arg2):
        ...
    g = classmethod(g)

The staticmethod() function takes the function f(), and returns it wrapped up in a descriptor so it can be stored in the class object. You might expect there to be special syntax for creating such methods (def static f, defstatic f(), or something like that) but no such syntax has been defined yet; that's been left for future versions of Python.

更多的新功能，如 __slots__ 和属性，也作为新类型的描述符实现。编写一个实现新功能的描述符类并不困难。例如，可以编写一个描述符类，使其能够为方法编写类似 Eiffel 风格的前置条件和后置条件。使用该功能的类可能定义如下：

from eiffel import eiffelmethod

class C(object):
    def f(self, arg1, arg2):
        # The actual function
        ...
    def pre_f(self):
        # Check preconditions
        ...
    def post_f(self):
        # Check postconditions
        ...

    f = eiffelmethod(f, pre_f, post_f)

Note that a person using the new eiffelmethod() doesn't have to understand anything about descriptors. This is why I think the new features don't increase the basic complexity of the language. There will be a few wizards who need to know about it in order to write eiffelmethod() or the ZODB or whatever, but most users will just write code on top of the resulting libraries and ignore the implementation details.

多重继承：钻石规则

通过改变名称解析规则，多重继承也变得更加有用。 请看下面这组类（图表摘自 PEP 253 [https://www.python.org/dev/peps/pep-0253] ，作者 Guido van Rossum）：

      class A:
        ^ ^  def save(self): ...
       /   \
      /     \
     /       \
    /         \
class B     class C:
    ^         ^  def save(self): ...
     \       /
      \     /
       \   /
        \ /
      class D

The lookup rule for classic classes is simple but not very smart; the base classes are searched depth-first, going from left to right. A reference to D.save() will search the classes D, B, and then A, where save() would be found and returned. C.save() would never be found at all. This is bad, because if C's save() method is saving some internal state specific to C, not calling it will result in that state never getting saved.

新式类遵循一种不同的算法，虽然解释起来有点复杂，但在这种情况下能做正确的事情。（请注意，Python 2.3 改变了这个算法，在大多数情况下会产生相同的结果，但对于非常复杂的继承图会产生更有用的结果。）

List all the base classes, following the classic lookup rule and include a class multiple times if it's visited repeatedly. In the above example, the list of visited classes is [D, B, A, C, A].

Scan the list for duplicated classes. If any are found, remove all but one occurrence, leaving the last one in the list. In the above example, the list becomes [D, B, C, A] after dropping duplicates.

Following this rule, referring to D.save() will return C.save(), which is the behaviour we're after. This lookup rule is the same as the one followed by Common Lisp. A new built-in function, super(), provides a way to get at a class's superclasses without having to reimplement Python's algorithm. The most commonly used form will be super(class, obj), which returns a bound superclass object (not the actual class object). This form will be used in methods to call a method in the superclass; for example, D's save() method would look like this:

class D (B,C):
    def save (self):
        # Call superclass .save()
        super(D, self).save()
        # Save D's private information here
        ...

super() 在以 super(class) 或 super(class1, class2) 形式调用时也可以返回未绑定的超类对象，但这可能并不常用。

属性访问

A fair number of sophisticated Python classes define hooks for attribute access using __getattr__(); most commonly this is done for convenience, to make code more readable by automatically mapping an attribute access such as obj.parent into a method call such as obj.get_parent. Python 2.2 adds some new ways of controlling attribute access.

首先，新式类仍然支持 __getattr__(attr_name)，关于它的任何内容都没有改变。 和以前一样，当试图访问 obj.foo 时，如果在实例的字典中找不到名为 foo 的属性，就会调用它。

New-style classes also support a new method, __getattribute__(attr_name). The difference between the two methods is that __getattribute__() is always called whenever any attribute is accessed, while the old __getattr__() is only called if foo isn't found in the instance's dictionary.

However, Python 2.2's support for properties will often be a simpler way to trap attribute references. Writing a __getattr__() method is complicated because to avoid recursion you can't use regular attribute accesses inside them, and instead have to mess around with the contents of __dict__. __getattr__() methods also end up being called by Python when it checks for other methods such as __repr__() or __coerce__(), and so have to be written with this in mind. Finally, calling a function on every attribute access results in a sizable performance loss.

property is a new built-in type that packages up three functions that get, set, or delete an attribute, and a docstring. For example, if you want to define a size attribute that's computed, but also settable, you could write:

class C(object):
    def get_size (self):
        result = ... computation ...
        return result
    def set_size (self, size):
        ... compute something based on the size
        and set internal state appropriately ...

    # Define a property.  The 'delete this attribute'
    # method is defined as None, so the attribute
    # can't be deleted.
    size = property(get_size, set_size,
                    None,
                    "Storage size of this instance")

That is certainly clearer and easier to write than a pair of __getattr__()/__setattr__() methods that check for the size attribute and handle it specially while retrieving all other attributes from the instance's __dict__. Accesses to size are also the only ones which have to perform the work of calling a function, so references to other attributes run at their usual speed.

最后，可以使用新的类属性 __slots__ 来限制对象上可以引用的属性列表。Python 对象通常非常动态，可以随时通过简单地 obj.new_attr=1 来定义一个新属性。新式类可以定义一个名为 __slots__ 的类属性，以将合法属性限制为特定的一组名称。一个例子可以更清楚地说明这一点：

>>> 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'

注意，当尝试为未列在 __slots__ 中的属性赋值时，会引发 AttributeError。

相关链接

本节只是对新特性进行了简要概述，提供了足够的解释以帮助你开始编程，但许多细节已被简化或忽略。想要获得更全面的了解，你可以去哪里呢？

描述器使用指南 是由 Guido van Rossum 编写的一篇介绍描述器特性详细教程。 如果我的描述激起了你的兴趣，请继续阅读这篇教程，因为它更加详细地介绍了这些新功能，同时仍然保持了相当的易读性。

接下来，有两个相关的 PEP，即 PEP 252 [https://www.python.org/dev/peps/pep-0252] 和 PEP 253 [https://www.python.org/dev/peps/pep-0253]。PEP 252 [https://www.python.org/dev/peps/pep-0252] 标题为“使类型更像类”，涵盖了描述符 API。PEP 253 [https://www.python.org/dev/peps/pep-0253] 标题为“内置类型的子类型化”，描述了使内置对象可以进行子类型化的类型对象的更改。PEP 253 [https://www.python.org/dev/peps/pep-0253] 是这两个 PEP 中更复杂的一个，在某些点上，必要的类型和元类型解释可能会让人感到头疼。两个 PEP 都由 Guido van Rossum 编写和实现，并得到了 Zope Corp. 团队其他成员的实质性协助。

最后，还有最终的权威来源：源代码。大部分类型处理的机制都在 Objects/typeobject.c 中，但只有在所有其他途径都用尽之后，包括在 python-list 或 python-dev 上发布问题后，才应求助于源代码。

PEP 234: 迭代器

Python 2.2 的另一个重要新增功能是在 C 和 Python 两个层面上引入了迭代接口。对象可以定义如何被调用者循环遍历。

In Python versions up to 2.1, the usual way to make for item in obj work is to define a __getitem__() method that looks something like this:

def __getitem__(self, index):
    return <next item>

__getitem__() is more properly used to define an indexing operation on an object so that you can write obj[5] to retrieve the sixth element. It's a bit misleading when you're using this only to support for loops. Consider some file-like object that wants to be looped over; the index parameter is essentially meaningless, as the class probably assumes that a series of __getitem__() calls will be made with index incrementing by one each time. In other words, the presence of the __getitem__() method doesn't mean that using file[5] to randomly access the sixth element will work, though it really should.

In Python 2.2, iteration can be implemented separately, and __getitem__() methods can be limited to classes that really do support random access. The basic idea of iterators is simple. A new built-in function, iter(obj) or iter(C, sentinel), is used to get an iterator. iter(obj) returns an iterator for the object obj, while iter(C, sentinel) returns an iterator that will invoke the callable object C until it returns sentinel to signal that the iterator is done.

Python classes can define an __iter__() method, which should create and return a new iterator for the object; if the object is its own iterator, this method can just return self. In particular, iterators will usually be their own iterators. Extension types implemented in C can implement a tp_iter function in order to return an iterator, and extension types that want to behave as iterators can define a tp_iternext function.

总结一下，迭代器实际上做什么？它们有一个必需的方法 next()，该方法不接受任何参数并返回下一个值。当没有更多的值可以返回时，调用 next() 应该引发 StopIteration 异常。以下是一个简单的例子来说明迭代器的工作原理：

>>> 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
>>>

In 2.2, Python's for statement no longer expects a sequence; it expects something for which iter() will return an iterator. For backward compatibility and convenience, an iterator is automatically constructed for sequences that don't implement __iter__() or a tp_iter slot, so for i in [1,2,3] will still work. Wherever the Python interpreter loops over a sequence, it's been changed to use the iterator protocol. This means you can do things like this:

>>> L = [1,2,3]
>>> i = iter(L)
>>> a,b,c = i
>>> a,b,c
(1, 2, 3)

迭代器支持已被添加到Python的一些基本类型中。对字典调用 iter() 会返回一个迭代器，该迭代器遍历字典的键，如下所示：

>>> 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

That's just the default behaviour. If you want to iterate over keys, values, or key/value pairs, you can explicitly call the iterkeys(), itervalues(), or iteritems() methods to get an appropriate iterator. In a minor related change, the in operator now works on dictionaries, so key in dict is now equivalent to dict.has_key(key).

文件也提供了一个迭代器，它会调用 readline() 方法，直到文件中没有更多的行。这意味着你现在可以使用类似这样的代码来读取文件的每一行：

for line in file:
    # do something for each line
    ...

请注意，你只能在迭代器中向前移动；没有办法获取前一个元素、重置迭代器或复制迭代器。一个迭代器对象可以提供这些额外的功能，但迭代器协议只要求有一个 next() 方法。

参见

PEP 234 [https://www.python.org/dev/peps/pep-0234] - 迭代器

由 Ka-Ping Yee 和 GvR 撰写；由 Python Labs 小组（主要由 GvR 和 Tim Peters）实现。

PEP 255: 简单的生成器

生成器是另一个新增特性，它是与迭代器的引入相互关联的。

你一定熟悉在Python或C语言中函数调用的工作方式。当你调用一个函数时，它会获得一个私有命名空间，在这个命名空间中创建其局部变量。当函数执行到 return 语句时，这些局部变量会被销毁，并将结果值返回给调用者。稍后对同一个函数的调用将获得一套全新的局部变量。但，如果局部变量在函数退出时不被丢弃呢？如果你可以在函数停止的地方稍后恢复执行呢？这就是生成器所提供的功能；它们可以被视为可恢复的函数。

这里是一个生成器函数的最简示例:

def generate_ints(N):
    for i in range(N):
        yield i

一个新的关键字 yield 被引入用于生成器。任何包含 yield 语句的函数都是生成器函数；这由Python的字节码编译器检测到，并因此对函数进行特殊编译。由于引入了一个新的关键字，生成器必须通过在模块的源代码顶部附近包含一条 from __future__ import generators 语句来显式启用。在Python 2.3中，这条语句将变得不再必要。

当你调用一个生成器函数时，它不会返回单个值；相反，它返回一个支持迭代器协议的生成器对象。在执行 yield 语句时，生成器输出 i 的值，类似于 return 语句。yield 和 return 语句之间的重大区别在于，当到达 yield 时，生成器的执行状态被挂起，并且局部变量被保留。在下一次调用生成器的 next() 方法时，函数将立即在 yield 语句之后恢复执行。（由于复杂的原因，yield 语句不允许在 try ... finally 语句的 try 块中使用；请阅读 PEP 255 [https://www.python.org/dev/peps/pep-0255] 以获得关于 yield 和异常交互的详细解释。）

这里是 generate_ints() 生成器的用法示例:

>>> 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

你可以等价地写成 for i in generate_ints(5) 或 a,b,c = generate_ints(3)。

在生成器函数内部， return 语句只能不带值使用，并表示值的生成过程结束；之后，生成器不能再返回任何值。在生成器函数内部，带值的 return，例如 return 5，是语法错误。生成器结果的结束也可以通过手动引发 StopIteration 异常来指示，或者只是让执行流自然地从函数底部流出。

你可以通过编写自己的类并将生成器的所有局部变量存储为实例变量，手动实现生成器的效果。例如，返回一个整数列表可以通过将 self.count 设置为0，并让 next() 方法递增 self.count 并返回它。然而，对于一个中等复杂的生成器，编写一个相应的类将会更加混乱。Lib/test/test_generators.py 包含了一些更有趣的例子。其中最简单的一个使用生成器递归实现了树的中序遍历：

# A recursive generator that generates Tree leaves in in-order.
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x
        yield t.label
        for x in inorder(t.right):
            yield x

在 Lib/test/test_generators.py 中还有另外两个例子，它们分别解决了N皇后问题（在$NxN$的棋盘上放置$N$个皇后，使得没有任何皇后威胁到其他皇后）和骑士巡游问题（在$NxN$的棋盘上，骑士访问每一个方格且不重复访问任何方格的路径）。

The idea of generators comes from other programming languages, especially Icon (https://www.cs.arizona.edu/icon/), where the idea of generators is central. In Icon, every expression and function call behaves like a generator. One example from "An Overview of the Icon Programming Language" at https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks like:

sentence := "Store it in the neighboring harbor"
if (i := find("or", sentence)) > 5 then write(i)

In Icon the find() function returns the indexes at which the substring "or" is found: 3, 23, 33. In the if statement, i is first assigned a value of 3, but 3 is less than 5, so the comparison fails, and Icon retries it with the second value of 23. 23 is greater than 5, so the comparison now succeeds, and the code prints the value 23 to the screen.

Python 并没有像 Icon 那样将生成器作为核心概念来采纳。生成器被认为是 Python 核心语言的一部分，但学习或使用它们并不是强制性的；如果它们不能解决你的问题，可以完全忽略它们。与 Icon 相比，Python 的一个新颖特性是生成器的状态表示为一个具体对象（迭代器），该对象可以传递给其他函数或存储在数据结构中。

参见

PEP 255 [https://www.python.org/dev/peps/pep-0255] - 简单生成器

由 Neil Schemenauer, Tim Peters, Magnus Lie Hetland 撰写。 主要由 Neil Schemenauer 和 Tim Peters 实现，并包含来自 Python Labs 团队的修正。

PEP 237: 统一长整数和整数

In recent versions, the distinction between regular integers, which are 32-bit values on most machines, and long integers, which can be of arbitrary size, was becoming an annoyance. For example, on platforms that support files larger than 2**32 bytes, the tell() method of file objects has to return a long integer. However, there were various bits of Python that expected plain integers and would raise an error if a long integer was provided instead. For example, in Python 1.5, only regular integers could be used as a slice index, and 'abc'[1L:] would raise a TypeError exception with the message 'slice index must be int'.

Python 2.2 将根据需要将数值从短整数转换为长整数。'L' 后缀不再需要用于表示长整数字面量，因为现在编译器会自动选择适当的类型。（在未来的 2.x 版本的 Python 中，使用 'L' 后缀将被不鼓励，并在 Python 2.4 中触发警告，可能在 Python 3.0 中被移除。）许多以前会引发 OverflowError 的操作现在会返回一个长整数作为结果。例如：

>>> 1234567890123
1234567890123L
>>> 2 ** 64
18446744073709551616L

在大多数情况下，整数和长整数现在将被视为相同。你仍然可以使用内置的 type() 函数区分它们，但这很少需要。

参见

PEP 237 [https://www.python.org/dev/peps/pep-0237] - 统一长整数和整数

由 Moshe Zadka 和 Guido van Rossum 撰写 ; 大部分由 Guido van Rossum 实现。

PEP 238：修改除法运算符

Python 2.2中最具争议的变化预示着修复一个自Python诞生以来的旧设计缺陷的努力的开始。目前，Python的除法操作符 / 在接收两个整数参数时表现得像C语言的除法操作符：它返回一个被截断为整数的结果。例如，3/2 是1，而不是1.5，(-1)/2 是-1，而不是-0.5。这意味着除法的结果可能会根据两个操作数的类型而意外变化，并且由于Python是动态类型的，确定操作数的可能类型可能会很困难。

（争议在于这是否*真的*算是一个设计缺陷，以及是否值得为了修复它而破坏现有代码。这在python-dev上引发了无休止的讨论，并在2001年7月爆发成一场在 comp.lang.python 的充满讽刺性言辞的风暴。我不会在这里为任何一方辩护，只会描述在2.2中实现的内容。请阅读 PEP 238 [https://www.python.org/dev/peps/pep-0238] 以获取争论和反驳的摘要。）

由于这一变化可能会破坏现有代码，因此它正在非常逐步地引入。Python 2.2 开始了这一过渡，但直到 Python 3.0 这一转换才会完全完成。

首先，我将借用一些来自 PEP 238 [https://www.python.org/dev/peps/pep-0238] 的术语。“真除法”是大多数非程序员所熟悉的除法：3/2是1.5，1/4是0.25，等等。“地板除法”是Python的 / 操作符在给定整数操作数时当前执行的操作；其结果是真除法返回值的地板值。“经典除法”是当前 / 操作符的混合行为；当操作数是整数时，它返回地板除法的结果，而当其中一个操作数是浮点数时，它返回真除法的结果。

Python 2.2 引入了以下变化：

一个新的操作符，// 是地板除法操作符。 （是的，我们知道它看起来像 C++ 的注释符号。） // 始终 执行地板除法，无论其操作数的类型是什么，因此 1 // 2 是 0，1.0 // 2.0 也是0.0。

// 操作符在Python 2.2中始终可用；你不需要通过 __future__ 语句来启用它。

通过在模块中包含 from __future__ import division，/``操作符将被更改为返回真除法的结果，因此 ``1/2 是0.5。如果没有这条 __future__ 语句，/ 仍然表示经典除法。/ 的默认含义在Python 3.0之前不会改变。

Classes can define methods called __truediv__() and __floordiv__() to overload the two division operators. At the C level, there are also slots in the PyNumberMethods structure so extension types can define the two operators.

Python 2.2 支持一些命令行参数，用于测试代码是否能在除法语义改变的情况下正常工作。运行 Python 并使用 -Q warn 选项时，当对两个整数应用除法时会发出警告。你可以利用这个功能找到受影响的代码并进行修复。默认情况下，Python 2.2 会执行经典除法而不会发出警告；在 Python 2.3 中，警告将默认开启。

参见

PEP 238 [https://www.python.org/dev/peps/pep-0238]：改变除法运算符

由 Moshe Zadka 和 Guido van Rossum 撰写 ; 由 Guido van Rossum 实现。

Unicode 的改变

Python的Unicode支持在2.2版本中有所增强。Unicode字符串通常以UCS-2形式存储，即16位无符号整数。通过向配置脚本提供 --enable-unicode=ucs4 选项，Python 2.2也可以编译为使用UCS-4（32位无符号整数）作为其内部编码。（也可以指定 --disable-unicode 选项来完全禁用Unicode支持。）

When built to use UCS-4 (a "wide Python"), the interpreter can natively handle Unicode characters from U+000000 to U+110000, so the range of legal values for the unichr() function is expanded accordingly. Using an interpreter compiled to use UCS-2 (a "narrow Python"), values greater than 65535 will still cause unichr() to raise a ValueError exception. This is all described in PEP 261 [https://www.python.org/dev/peps/pep-0261], "Support for 'wide' Unicode characters"; consult it for further details.

Another change is simpler to explain. Since their introduction, Unicode strings have supported an encode() method to convert the string to a selected encoding such as UTF-8 or Latin-1. A symmetric decode([*encoding*]) method has been added to 8-bit strings (though not to Unicode strings) in 2.2. decode() assumes that the string is in the specified encoding and decodes it, returning whatever is returned by the codec.

利用这一新特性，编解码器被添加用于与Unicode不直接相关的任务。例如，已经添加了用于uu编码、MIME的base64编码以及使用 zlib 模块进行压缩的编解码器：

>>> 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'

To convert a class instance to Unicode, a __unicode__() method can be defined by a class, analogous to __str__().

encode(), decode(), and __unicode__() were implemented by Marc-André Lemburg. The changes to support using UCS-4 internally were implemented by Fredrik Lundh and Martin von Löwis.

参见

PEP 261 [https://www.python.org/dev/peps/pep-0261] - 对 '宽' Unicode 字符的支持

由 Paul Prescod 编写。

PEP 227: 嵌套的作用域

在Python 2.1中，静态嵌套作用域作为一个可选特性被添加，需要通过 from __future__ import nested_scopes 指令来启用。在2.2版本中，嵌套作用域不再需要特别启用，现在总是存在。本节的其余部分是从我的《Python 2.1的新特性》文档中复制的嵌套作用域描述；如果你在2.1发布时已经阅读过，可以跳过本节的其余部分。

Python 2.1 中的最大改变是 Python 的作用域规则，在Python 2.2中得到完善。 在 Python 2.0 中，任意给定的时刻至多使用三个命名空间来查找变量名称：局部、模块和内置命名空间。 这往往会导致令人吃惊的结果因为它与人们直觉上的预期不相匹配。 例如，一个嵌套的递归函数将不起作用:

def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...

The function g() will always raise a NameError exception, because the binding of the name g isn't in either its local namespace or in the module-level namespace. This isn't much of a problem in practice (how often do you recursively define interior functions like this?), but this also made using the lambda expression clumsier, and this was a problem in practice. In code which uses lambda you can often find local variables being copied by passing them as the default values of arguments.

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

结果将会严重损害以高度函数式风格编写的 Python 代码的可读性。

Python 2.2 最显著的改变是增加了静态作用域这一语言特征来解决此问题。 作为它的第一项影响，在上述示例中的 name=name 默认参数现在将不再必要。 简单地说，当一个函数内部的给定变量名没有被赋值时（通过赋值语句，或者 def, class 或 import 语句），对该变量的引用将在外层作用域的局部命名空间中查找。 对于该规则的更详细解释，以及具体实现的分析，请参阅相应的 PEP。

对于同时在模块层级和包含下层函数定义的函数内部局部变量使用了相同变量名的代码来说这项改变可能会导致一些兼容性问题。 不过这看来不太可能发生，因为阅读这样的代码本来就会相当令人困惑。

此项改变的一个附带影响是在特定条件下函数作用域内部 from module import * 和 exec 语句将不允许使用。 Python 参考手册已经写明 from module import * 仅在模块最高层级上是可用的，但此前 CPython 解释器从未强制实施此规则。 作为嵌套作用域具体实现的一部分，将 Python 源码转为字节码的编译器会生成不同的代码来访问某个包含作用域内的变量。 from module import * 和 exec 会使得编译器无法正确执行，因为它们会向局部命名空间添加在编译时还不存在的名称。 为此，如果一个函数包含带有自由变量的函数定义或 lambda 表达式，编译器将通过引发 SyntaxError 异常来提示。

为了使前面的解释更清楚，下面是一个例子:

x = 1
def f():
    # The next line is a syntax error
    exec 'x=2'
    def g():
        return x

包含 exec 语句的第 4 行有语法错误，因为 exec 将定义一个名为 x 的新局部变量，它的值应当被 g() 访问。

这应该不会是太大的限制，因为 exec 在多数 Python 代码中都极少被使用（而当它被使用时，往往也是个存在糟糕设计的信号）。

参见

PEP 227 [https://www.python.org/dev/peps/pep-0227] - 静态嵌套作用域

由 Jeremy Hylton 撰写并实现。

新增和改进的模块

The xmlrpclib module was contributed to the standard library by Fredrik Lundh, providing support for writing XML-RPC clients. XML-RPC is a simple remote procedure call protocol built on top of HTTP and XML. For example, the following snippet retrieves a list of RSS channels from the O'Reilly Network, and then lists the recent headlines for one channel:

import xmlrpclib
s = xmlrpclib.Server(
      'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
channels = s.meerkat.getChannels()
# channels is a list of dictionaries, like this:
# [{'id': 4, 'title': 'Freshmeat Daily News'}
#  {'id': 190, 'title': '32Bits Online'},
#  {'id': 4549, 'title': '3DGamers'}, ... ]

# Get the items for one channel
items = s.meerkat.getItems( {'channel': 4} )

# 'items' is another list of dictionaries, like this:
# [{'link': 'http://freshmeat.net/releases/52719/',
#   'description': 'A utility which converts HTML to XSL FO.',
#   'title': 'html2fo 0.3 (Default)'}, ... ]

The SimpleXMLRPCServer module makes it easy to create straightforward XML-RPC servers. See http://xmlrpc.scripting.com/ for more information about XML-RPC.

新的 hmac 模块实现了由 RFC 2104 [https://datatracker.ietf.org/doc/html/rfc2104.html] 描述的HMAC算法。（由Gerhard Häring贡献。）

Several functions that originally returned lengthy tuples now return pseudo-sequences that still behave like tuples but also have mnemonic attributes such as memberst_mtime or tm_year. The enhanced functions include stat(), fstat(), statvfs(), and fstatvfs() in the os module, and localtime(), gmtime(), and strptime() in the time module.

例如，使用旧的元组来获取文件的大小时，你可能会写成 file_size = os.stat(filename)[stat.ST_SIZE] ，但现在可以更清晰地写成 file_size = os.stat(filename).st_size。

此特性的初始补丁由 Nick Mathewson 贡献。

Python 的分析器进行了大量的重构，并纠正了其输出中的各种错误。（由 Fred L. Drake, Jr. 和 Tim Peters 贡献。）

socket 模块可以编译为支持IPv6；为Python的配置脚本指定 --enable-ipv6 选项。（由Jun-ichiro "itojun" Hagino贡献。）

在支持 C 语言 long long 类型的平台上，为 64 位整数添加了两个新的格式字符到 struct 模块。 q 用于有符号 64 位整数，Q 用于无符号 64 位整数。返回的值是 Python 的长整数类型。（由 Tim Peters 贡献。）

在解释器的交互模式下，有一个新的内置函数 help()，它使用在Python 2.1 中引入的 pydoc 模块来提供交互式帮助。 help(object) 显示关于*object*的任何可用帮助文本。不带参数调用 help() 会进入一个在线帮助工具，在那里你可以输入函数、类或模块的名称来阅读它们的帮助文本。（由Guido van Rossum贡献，使用Ka-Ping Yee的 pydoc 模块。）

Various bugfixes and performance improvements have been made to the SRE engine underlying the re module. For example, the re.sub() and re.split() functions have been rewritten in C. Another contributed patch speeds up certain Unicode character ranges by a factor of two, and a new finditer() method that returns an iterator over all the non-overlapping matches in a given string. (SRE is maintained by Fredrik Lundh. The BIGCHARSET patch was contributed by Martin von Löwis.)

smtplib 模块现在支持 RFC 2487 [https://datatracker.ietf.org/doc/html/rfc2487.html]："Secure SMTP over TLS"，因此现在可以加密Python程序与接收消息的邮件传输代理之间的SMTP流量。smtplib 还支持SMTP身份验证。（由Gerhard Häring贡献。）

imaplib 模块由 Piers Lauder 维护，支持几个新扩展: RFC 2342 [https://datatracker.ietf.org/doc/html/rfc2342.html] 中定义的 NAMESPACE 扩展、SORT、GETACL和SETACL。（由 Anthony Baxter 和 Michel Pelletier 贡献。）

The rfc822 module's parsing of email addresses is now compliant with RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html], an update to RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html]. (The module's name is not going to be changed to rfc2822.) A new package, email, has also been added for parsing and generating e-mail messages. (Contributed by Barry Warsaw, and arising out of his work on Mailman.)

The difflib module now contains a new Differ class for producing human-readable lists of changes (a "delta") between two sequences of lines of text. There are also two generator functions, ndiff() and restore(), which respectively return a delta from two sequences, or one of the original sequences from a delta. (Grunt work contributed by David Goodger, from ndiff.py code by Tim Peters who then did the generatorization.)

New constants ascii_letters, ascii_lowercase, and ascii_uppercase were added to the string module. There were several modules in the standard library that used string.letters to mean the ranges A-Za-z, but that assumption is incorrect when locales are in use, because string.letters varies depending on the set of legal characters defined by the current locale. The buggy modules have all been fixed to use ascii_letters instead. (Reported by an unknown person; fixed by Fred L. Drake, Jr.)

The mimetypes module now makes it easier to use alternative MIME-type databases by the addition of a MimeTypes class, which takes a list of filenames to be parsed. (Contributed by Fred L. Drake, Jr.)

A Timer class was added to the threading module that allows scheduling an activity to happen at some future time. (Contributed by Itamar Shtull-Trauring.)

解释器的改变和修正

有些变化只会影响那些在 C 级别处理 Python 解释器的人，因为他们正在编写 Python 扩展模块、嵌入解释器或仅仅是在修改解释器本身。如果你只编写 Python 代码，这里描述的变化对你几乎没有影响。

性能分析和追踪函数现在可以用 C 语言来实现，相比基于 Python 的函数能够显著提高运行速度并能够减少性能分析和追踪的资源开销。 Python 开发环境的编写者对此将会很感兴趣。 Python 的 API 增加了两个新的 C 函数，PyEval_SetProfile() 和 PyEval_SetTrace()。 现有的 sys.setprofile() 和 sys.settrace() 函数仍然存在，并已简单地更改为使用新的 C 层级接口。 （由 Fred L. Drake, Jr. 贡献。）

Another low-level API, primarily of interest to implementors of Python debuggers and development tools, was added. PyInterpreterState_Head() and PyInterpreterState_Next() let a caller walk through all the existing interpreter objects; PyInterpreterState_ThreadHead() and PyThreadState_Next() allow looping over all the thread states for a given interpreter. (Contributed by David Beazley.)

垃圾收集器的 C 级接口已经发生了变化，使得编写支持垃圾收集的扩展类型和调试函数误用变得更容易。各种函数的语义略有不同，因此需要重命名一系列函数。使用旧 API 的扩展仍然可以编译，但不会参与垃圾收集，因此应优先考虑将它们更新为 2.2 版本。

要将一个扩展模块升级至新 API，请执行下列步骤:

将 Py_TPFLAGS_GC() 重命名为 PyTPFLAGS_HAVE_GC()。

使用 PyObject_GC_New() 或 PyObject_GC_NewVar() 来分配

对象，并使用 PyObject_GC_Del() 来释放它们。

将 PyObject_GC_Init() 重命名为 PyObject_GC_Track() 并

将 PyObject_GC_Fini() 重命名为 PyObject_GC_UnTrack()。

将 PyGC_HEAD_SIZE() 从对象大小计算中移除。

移除对 PyObject_AS_GC() 和 PyObject_FROM_GC() 的调用。

向 PyArg_ParseTuple() 添加了一个新的 et 格式序列；et 接受一个形参和一个编码格式名称，如果该形参值是一个 Unicode 字符串则将其转换为给定的编码格式，或者如果它是一个 8 比特位字符串则让其保持原样，即假定它已经使用了适当的编码格式。 这不同于 es 格式字符，它假定该 8 比特位字符串是使用 Python 默认的 ASCII 编码格式并将其转换为指定的新编码格式。 （由 M.-A. Lemburg 贡献，用于下一节所描述的 Windows 上的 MBCS 支持。）

增加了一个不同的解析函数 PyArg_UnpackTuple()，它更为简单并且应该也更为快速。 调用方不必再指定格式字符串，而是简单地给出所预期参数的最小和最大数量，以及一组指向将以这些参数值来填充的 PyObject* 变量的指针。

Two new flags METH_NOARGS and METH_O are available in method definition tables to simplify implementation of methods with no arguments or a single untyped argument. Calling such methods is more efficient than calling a corresponding method that uses METH_VARARGS. Also, the old METH_OLDARGS style of writing C methods is now officially deprecated.

Two new wrapper functions, PyOS_snprintf() and PyOS_vsnprintf() were added to provide cross-platform implementations for the relatively new snprintf() and vsnprintf() C lib APIs. In contrast to the standard sprintf() and vsprintf() functions, the Python versions check the bounds of the buffer used to protect against buffer overruns. (Contributed by M.-A. Lemburg.)

_PyTuple_Resize() 函数去掉了一个未使用的形参，因此现在它接受 2 个形参而不是 3 个。 第三个参数从未被使用，在将代码从较早的版本移植到 Python 2.2 时可以简单地丢弃它。

其他的改变和修正

像往常一样，源代码树中散布着许多其他改进和错误修复。通过搜索 CVS 更改日志，可以发现 Python 2.1 到 2.2 之间应用了 527 个补丁并修复了 683 个错误；2.2.1 应用了 139 个补丁并修复了 143 个错误；2.2.2 应用了 106 个补丁并修复了 82 个错误。这些数字可能是低估的。

一些较为重要的改变:

适用于 MacOS 的 Python 移植代码现在保存在主 Python CVS 树中，由 Jack Jansen 维护，并且为了支持 MacOS X，进行了许多更改。

最重要的变化是能够将 Python 作为框架来进行构建，这可以通过在编译 Python 时向配置脚本提供 --enable-framework 选项来启用。 根据 Jack Jansen 的说法，“这会将一个独立的 Python 安装版加上 OS X 框架‘粘合起来’放到 /Library/Frameworks/Python.framework 中（或者其他选定的位置）。 就目前而言这样做并没有什么直接的额外好处（实际上，这样做还存在必须更改 PATH 才能找到Python 的坏处），但它是创建完整的 Python 应用程序、移植 MacPython IDE、并可能使用 Python 作为标准 OSA 脚本语言及其他更多功能的基础。”

作为 MacOS API 如 windowing, QuickTime, scripting 等的接口的许多 MacPython 工具箱模块已被移植到 OS X，但它们在 setup.py 中被注释掉了。 希望尝试这些模块的人可以手动取消注释它们。

现在将关键字参数传给不接受它们的内置函数会导致引发 TypeError 异常，并附带消息 "function takes no keyword arguments"。

在 Python 2.1 中作为扩展模块加入的弱引用现在已成为核心组成部分，因为它们被用于新式类的实现。 为此 ReferenceError 异常也已从 weakref 模块移出成为一个内置异常。

由 Tim Peters 编写的新脚本 Tools/scripts/cleanfuture.py 可自动从 Python 源代码移除过时的 __future__ 语句。

向内置函数 compile() 添加了一个额外的 flags 参数，以便现在 __future__ 语句的行为能在模拟的 shell，例如由 IDLE 和其他开发环境所提供的此类工具中被正确地观察。 此特性的描述参见 PEP 264 [https://www.python.org/dev/peps/pep-0264]。 （由 Michael Hudson 贡献。）

Python 1.6 引入的新许可证与 GPL 不兼容。通过对 2.2 许可证进行一些小的文本修改，这个问题得以解决，因此现在可以合法地将 Python 嵌入到 GPL 授权的程序中。请注意，Python 本身并不是在 GPL 授权下，而是采用一个与 BSD 许可证本质上等效的许可证，这与之前的情况一样。这些许可证更改也应用到了 Python 2.0.1 和 2.1.1 版本中。

在 Windows 上，当 Python 遇到一个 Unicode 文件名时，现在会将其转换为 MBCS 编码的字符串，这种编码由 Microsoft 文件 API 使用。由于文件 API 明确使用 MBCS 编码，Python 默认选择 ASCII 作为编码方式显得很不方便。在 Unix 上，如果 locale.nl_langinfo(CODESET) 可用，Python 将使用本地字符集。（Windows 支持由 Mark Hammond 提供，Marc-André Lemburg 提供协助。Unix 支持由 Martin von Löwis 添加。）

大文件支持目前已在 Windows 上启用。 （由 Tim Peters 贡献。）

Tools/scripts/ftpmirror.py 脚本现在会解析 .netrc 文件，如果存在的话。 （由 Mike Romberg 贡献。）

Some features of the object returned by the xrange() function are now deprecated, and trigger warnings when they're accessed; they'll disappear in Python 2.3. xrange objects tried to pretend they were full sequence types by supporting slicing, sequence multiplication, and the in operator, but these features were rarely used and therefore buggy. The tolist() method and the start, stop, and step attributes are also being deprecated. At the C level, the fourth argument to the PyRange_New() function, repeat, has also been deprecated.

字典实现中有一堆补丁，主要是为了修复潜在的核心转储问题，这些问题发生在字典中包含的对象悄悄改变其哈希值，或者在它们所包含的字典中发生突变时。那段时间，python-dev 邮件列表进入了一个微妙的节奏：Michael Hudson 发现一个导致核心转储的案例，Tim Peters 修复这个 bug，接着 Michael 又发现另一个案例，如此反复循环。

在 Windows 上，Python 现在可以使用 Borland C 编译，这要归功于 Stephen Hansen 提供的多个补丁，尽管结果还不完全可用。（但这*确实*是一个进步……）

另一个 Windows 改进：Wise Solutions 慷慨地向 PythonLabs 提供了他们的 InstallerMaster 8.1 系统。早期的 PythonLabs Windows 安装程序使用的是 Wise 5.0a，已经开始显得过时。（由 Tim Peters 打包。）

在 Windows 上现在将会导入以 .pyw 结尾的文件。 .pyw 是 Windows 专属的，用来指明一个脚本需要使用 PYTHONW.EXE 而不是 PYTHON.EXE 来运行以避免弹出 DOS 控制台来显示输出。 该补丁使得导入这样的脚本成为可能，让它们也可以作为模块来使用。 （由 David Bolen 实现。）

在 Python 会使用 C dlopen() 函数来加载扩展模块的平台上，现在可以使用 sys.getdlopenflags() 和 sys.setdlopenflags() 等函数来设置 dlopen() 所使用的旗标。 （由 Bram Stolk 贡献。）

The pow() built-in function no longer supports 3 arguments when floating-point numbers are supplied. pow(x, y, z) returns (x**y) % z, but this is never useful for floating point numbers, and the final result varies unpredictably depending on the platform. A call such as pow(2.0, 8.0, 7.0) will now raise a TypeError exception.

致谢

作者感谢以下人员为本文的各种草案提供建议，更正和帮助： 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.

Python 2.1 有什么新变化

作者

A.M. Kuchling

概述

本文介绍了 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日发布。

PEP 227: 嵌套的作用域

Python 2.1 中的最大改变是 Python 的作用域规则。 在 Python 2.0 中，任意给定的时刻至多使用三个命名空间来查找变量名称：局部、模块和内置命名空间。 这往往会导致令人吃惊的结果因为它与人们直觉上的预期不相匹配。 例如，一个嵌套的递归函数将不起作用:

def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...

函数 g() 将总是引发 NameError 异常，因为名称 g 的绑定既不在局部命名空间中也不在模块级命名空间中。 这在实践上不会有太大问题（你会经常这样递归地定义内部函数吗？），但是这也会让 lambda 表达式的使用更为笨拙，这在实践上是有问题的。 在使用了 lambda 的代码中你经常能发现局部变量通过作为参数的默认值被拷贝。

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

结果将会严重损害以高度函数式风格编写的 Python 代码的可读性。

Python 2.1 最显著的改变是增加了静态作用域这一语言特征来解决此问题。 作为它的第一项影响，在上述示例中的 name=name 默认参数现在将不再必要。 简单地说，当一个函数内部的给定变量名没有被赋值时（通过赋值语句，或者 def, class 或 import 语句），对该变量的引用将在外层作用域的局部命名空间中查找。 对于该规则的更详细解释，以及具体实现的分析，请参阅相应的 PEP。

对于同时在模块层级和包含下层函数定义的函数内部局部变量使用了相同变量名的代码来说这项改变可能会导致一些兼容性问题。 不过这看来不太可能发生，因为阅读这样的代码本来就会相当令人困惑。

此项改变的一个附带影响是在特定条件下函数作用域内部 from module import * 和 exec 语句将不允许使用。 Python 参考手册已经写明 from module import * 仅在模块最高层级上是可用的，但此前 CPython 解释器从未强制实施此规则。 作为嵌套作用域具体实现的一部分，将 Python 源码转为字节码的编译器会生成不同的代码来访问某个包含作用域内的变量。 from module import * 和 exec 会使得编译器无法正确执行，因为它们会向局部命名空间添加在编译时还不存在的名称。 为此，如果一个函数包含带有自由变量的函数定义或 lambda 表达式，编译器将通过引发 SyntaxError 异常来提示。

为了使前面的解释更清楚，下面是一个例子:

x = 1
def f():
    # The next line is a syntax error
    exec 'x=2'
    def g():
        return x

包含 exec 语句的第 4 行有语法错误，因为 exec 将定义一个名为 x 的新局部变量，它的值应当被 g() 访问。

这应该不会是太大的限制，因为 exec 在多数 Python 代码中都极少被使用（而当它被使用时，往往也是个存在糟糕设计的信号）。

由于兼容性问题，嵌套作用域被逐步引入；在 Python 2.1 中，它们默认未启用，但可以通过在模块中使用 future 语句来开启，如 PEP 236 [https://www.python.org/dev/peps/pep-0236] 所述。 （参见下一节对 PEP 236 [https://www.python.org/dev/peps/pep-0236] 的进一步讨论。） 在 Python 2.2 中，嵌套作用域将成为默认设置，并且无法关闭，但用户将有整个 2.1 版本的生命周期来修复因引入嵌套作用域而导致的任何问题。

参见

PEP 227 [https://www.python.org/dev/peps/pep-0227] - 静态嵌套作用域

由 Jeremy Hylton 撰写并实现。

PEP 236: __future__ 指令

对嵌套作用域的反应引起了广泛关注，人们担心在 Python 2.1 版本发布时会破坏现有代码，强烈的反应促使 Python 开发者采取了更保守的策略。这个策略包括引入一种约定，在版本 N 中启用可选功能，该功能将在版本 N+1 中成为强制功能。

语法使用 from...import 语句，使用保留模块名 __future__。可以通过以下语句启用嵌套作用域:

from __future__ import nested_scopes

虽然它看起来像一个普通的 import 语句，但实际上并不是；关于此类 future 语句的位置有严格的规定。它们只能放在模块的顶部，必须位于任何 Python 代码或常规 import 语句之前。这是因为这样的语句会影响 Python 字节码编译器解析代码和生成字节码的方式，因此它们必须在任何会生成字节码的语句之前出现。

参见

PEP 236 [https://www.python.org/dev/peps/pep-0236] - 回到 __future__

由 Tim Peters 撰写，主要由 Jeremy Hylton 实现。

PEP 207: 富比较

In earlier versions, Python's support for implementing comparisons on user-defined classes and extension types was quite simple. Classes could implement a __cmp__() method that was given two instances of a class, and could only return 0 if they were equal or +1 or -1 if they weren't; the method couldn't raise an exception or return anything other than a Boolean value. Users of Numeric Python often found this model too weak and restrictive, because in the number-crunching programs that numeric Python is used for, it would be more useful to be able to perform elementwise comparisons of two matrices, returning a matrix containing the results of a given comparison for each element. If the two matrices are of different sizes, then the compare has to be able to raise an exception to signal the error.

在 Python 2.1 中增加了富比较操作以支持这一需求。 Python 类现在可以单独重载 <, <=, >, >=, == 和 != 中的每个操作。 新的魔术方法名称如下：

运算 | 方法名称
< | __lt__()
<= | __le__()
> | __gt__()
>= | __ge__()
== | __eq__()
!= | __ne__()

（这些魔术方法是以对应的 Fortran 操作符命名的，如 .LT.、.LE. 等。 数值程序员几乎肯定对这些名称非常熟悉，并且会发现它们易于记忆。）

每个这样的魔术方法的形式都是 method(self, other)，其中 self 是操作符左侧的对象，而 other 是操作符右侧的对象。 例如，表达式 A < B 会调用 A.__lt__(B)。

这些魔术方法可以返回任何类型的值：布尔值、矩阵、列表或任何其他 Python 对象。或者，如果比较是不可能的、不一致的或没有意义的，它们也可以引发异常。

The built-in cmp(A,B) function can use the rich comparison machinery, and now accepts an optional argument specifying which comparison operation to use; this is given as one of the strings "<", "<=", ">", ">=", "==", or "!=". If called without the optional third argument, cmp() will only return -1, 0, or +1 as in previous versions of Python; otherwise it will call the appropriate method and can return any Python object.

对于 C 程序员来说，也有相应的变更；类型对象中有一个新的槽位 tp_richcmp 以及一个用于执行指定富比较的 API。 这里我不会涉及 C API 的具体内容，完整的相关函数列表请参阅 PEP 207 [https://www.python.org/dev/peps/pep-0207] 或 2.1 的 C API 文档。

参见

PEP 207 [https://www.python.org/dev/peps/pep-0207] - 富比较

由 Guido van Rossum 编写，大量参考 David Ascher 的先期工作，并由 Guido van Rossum 实现。

PEP 230: 警告框架

在过去的 10 年中，Python 积累了一定数量的过时模块和功能。 由于无法确切知道某个功能被使用的程度：可能没有程序依赖该功能，也可能有很多程序依赖，因此很难确定何时可以安全地移除某个功能，为了以更结构化的方式移除旧功能，添加了一个警告框架。 当 Python 开发者想要废弃某个功能时，它会在下一个 Python 版本中首先触发一个警告。 然后，在随后的Python版本中可以移除该功能，这样用户将有一个完整的发布周期来删除对旧功能的使用。

Python 2.1 增加了警告框架以用于此方案。 它增加了一个 warnings 模块，该模块提供了发出警告的函数，以及过滤掉不想显示的警告的功能。 第三方模块也可以使用这个框架来弃用它们不再希望支持的旧功能。

例如，在 Python 2.1 中 regex 模块已被弃用，因此导入它时会打印一条警告信息:

>>> import regex
__main__:1: DeprecationWarning: the regex module
         is deprecated; please use the re module
>>>

警告可以通过调用 warnings.warn() 函数来发出:

warnings.warn("feature X no longer supported")

第一个形参是警告消息；额外的可选形参可被用来指定一个专门的警告类别。

Filters can be added to disable certain warnings; a regular expression pattern can be applied to the message or to the module name in order to suppress a warning. For example, you may have a program that uses the regex module and not want to spare the time to convert it to use the re module right now. The warning can be suppressed by calling

import warnings
warnings.filterwarnings(action = 'ignore',
                        message='.*regex module is deprecated',
                        category=DeprecationWarning,
                        module = '__main__')

This adds a filter that will apply only to warnings of the class DeprecationWarning triggered in the __main__ module, and applies a regular expression to only match the message about the regex module being deprecated, and will cause such warnings to be ignored. Warnings can also be printed only once, printed every time the offending code is executed, or turned into exceptions that will cause the program to stop (unless the exceptions are caught in the usual way, of course).

Python 的 C API 也增加了用于发出警告的函数；详情请参阅 PEP 230 或 Python 的 API 文档。

参见

PEP 5 [https://www.python.org/dev/peps/pep-0005] - 语言演化的准则

该文档由 Paul Prescod 撰写，旨在规定移除 Python 旧功能时应遵循的程序。 尽管本文描述的政策尚未被正式采纳，但最终的政策可能不会与 Prescod 的提议有太大不同。

PEP 230 [https://www.python.org/dev/peps/pep-0230] - 警告框架

由 Guido van Rossum 撰写并实现。

PEP 229: 新的构建系统

在编译 Python 时，用户必须进入并编辑 Modules/Setup 文件以启用各种附加模块；默认集相对较小，并且仅限于在大多数 Unix 平台上编译的模块。这意味着在具有更多功能的 Unix 平台上，特别是 Linux，Python 安装通常不包含所有可能有用的模块。

Python 2.0 添加了 Distutils，一组用于分发和安装扩展模块的模块。在 Python 2.1 中，Distutils 被用于编译大部分标准库扩展模块，自动检测当前机器上支持哪些模块。希望这将使 Python 的安装更加容易并具有更多功能。

不再需要编辑 Modules/Setup 文件来启用模块，而是在 Python 源代码分发包的顶层目录运行一个 setup.py 脚本，该脚本在构建时尝试通过检查系统上的模块和头文件来发现可以启用那些模块。 如果某个模块已在 Modules/Setup 中配置，则 setup.py 脚本不会尝试编译该模块，并会遵从 Modules/Setup 文件中的内容。 这提供了一种方式来指定特定平台所需的任何奇怪的命令行旗标或库。

在对构建机制的另一项重大更改中，Neil Schemenauer 对其进行了重组，现在 Python 使用单一的非递归 makefile，而不是在顶层目录和 Python/、Parser/、Objects/`和 :file:`Modules/ 子目录中的多个 makefile。这使得构建 Python 更快，同时也使修改 Makefile 更加清晰和简单。

参见

PEP 229 [https://www.python.org/dev/peps/pep-0229] - 使用 Distutils 来构建 Python

由 A.M. Kuchling 撰写并实现。

PEP 205: 弱引用

弱引用，通过 weakref 模块提供，是 Python 程序员工具箱中一种较小但有用的新数据类型。

存储一个指向对象的引用（例如，在字典或列表中）会导致该对象永久存活。 在某些特定情况下，这种行为是不符合需要的，最常见的是对象缓存，另一个是像树这样的数据结构中的循环引用。

例如，考虑一个记忆化函数，它通过将函数的参数及其结果存储在字典中来缓存另一个函数 f(x) 的结果:

_cache = {}
def memoize(x):
    if _cache.has_key(x):
        return _cache[x]

    retval = f(x)

    # Cache the returned object
    _cache[x] = retval

    return retval

This version works for simple things such as integers, but it has a side effect; the _cache dictionary holds a reference to the return values, so they'll never be deallocated until the Python process exits and cleans up. This isn't very noticeable for integers, but if f() returns an object, or a data structure that takes up a lot of memory, this can be a problem.

弱引用提供了一种实现缓存的方法，不会让对象在其生命周期结束后仍然存活。 如果一个对象仅通过弱引用访问，该对象将被释放，并且弱引用将指示它所引用的对象不再存在。 通过调用 wr = weakref.ref(obj) 来创建对对象 obj 的弱引用。 通过调用弱引用，就像调用函数一样，可以返回被引用的对象: wr()。 如果对象仍然存在，它将返回被引用的对象；如果对象不再存在，则返回 None。

This makes it possible to write a memoize() function whose cache doesn't keep objects alive, by storing weak references in the cache.

_cache = {}
def memoize(x):
    if _cache.has_key(x):
        obj = _cache[x]()
        # If weak reference object still exists,
        # return it
        if obj is not None: return obj

    retval = f(x)

    # Cache a weak reference
    _cache[x] = weakref.ref(retval)

    return retval

The weakref module also allows creating proxy objects which behave like weak references --- an object referenced only by proxy objects is deallocated -- but instead of requiring an explicit call to retrieve the object, the proxy transparently forwards all operations to the object as long as the object still exists. If the object is deallocated, attempting to use a proxy will cause a weakref.ReferenceError exception to be raised.

proxy = weakref.proxy(obj)
proxy.attr   # Equivalent to obj.attr
proxy.meth() # Equivalent to obj.meth()
del obj
proxy.attr   # raises weakref.ReferenceError

参见

PEP 205 [https://www.python.org/dev/peps/pep-0205] - 弱引用

由 Fred L. Drake, Jr 撰写并实现。

PEP 232: 函数属性

In Python 2.1, functions can now have arbitrary information attached to them. People were often using docstrings to hold information about functions and methods, because the __doc__ attribute was the only way of attaching any information to a function. For example, in the Zope web application server, functions are marked as safe for public access by having a docstring, and in John Aycock's SPARK parsing framework, docstrings hold parts of the BNF grammar to be parsed. This overloading is unfortunate, since docstrings are really intended to hold a function's documentation; for example, it means you can't properly document functions intended for private use in Zope.

现在可以使用常规的 Python 语法在函数上设置和检索任意属性:

def f(): pass

f.publish = 1
f.secure = 1
f.grammar = "A ::= B (C D)*"

The dictionary containing attributes can be accessed as the function's __dict__. Unlike the __dict__ attribute of class instances, in functions you can actually assign a new dictionary to __dict__, though the new value is restricted to a regular Python dictionary; you can't be tricky and set it to a UserDict instance, or any other random object that behaves like a mapping.

参见

PEP 232 [https://www.python.org/dev/peps/pep-0232] - 函数属性

由 Barry Warsaw 撰写并实现

PEP 235: 在大小写不敏感的平台上导入模块

一些操作系统的文件系统是大小写不敏感的，MacOS 和 Windows 是主要的例子；在这些系统上，无法区分文件名 FILE.PY 和 file.py，尽管它们确实以原始大小写存储文件名（它们也是保留大小写的）。

在 Python 2.1 中，import 语句可以在不区分大小写的平台上模拟大小写敏感性。 现在，Python 默认搜索第一个大小写敏感匹配的文件，如果找不到这样的文件，就会引发 ImportError，因此 import file 不会导入名为 FILE.PY 的模块。 在启动 Python 解释器之前，可以通过设置 PYTHONCASEOK 环境变量来请求大小写不敏感匹配。

PEP 217: 交互模式显示钩子

在交互模式下使用 Python 解释器时，命令的输出是通过内置的 repr() 函数显示的。 在 Python 2.1 中，可以将变量 sys.displayhook() 设置为一个可调用对象，该对象将在代替 repr() 函数被调用。 例如，你可以将其设置为一个特殊的美化打印函数:

>>> # Create a recursive data structure
... L = [1,2,3]
>>> L.append(L)
>>> L # Show Python's default output
[1, 2, 3, [...]]
>>> # Use pprint.pprint() as the display function
... import sys, pprint
>>> sys.displayhook = pprint.pprint
>>> L
[1, 2, 3,  <Recursion on list with id=135143996>]
>>>

参见

PEP 217 [https://www.python.org/dev/peps/pep-0217] - 用于交互模式的显示钩子

由 Moshe Zadka 撰写并实现

PEP 208: 新的强制转换模型

在 C 级别上的数值类型转换方法进行了重大修改。 这只会影响编写 Python C 扩展的作者，使他们在编写支持数值运算的扩展类型时有更多的灵活性。

扩展类型现在可以在其 PyTypeObject 结构中设置类型标志 Py_TPFLAGS_CHECKTYPES，以表明它们支持新的强制模型。 在此类扩展类型中，数字槽函数不再假定它们将得到两个相同类型的参数；相反，它们可能会得到两个不同类型的参数，然后可以执行自己的内部强制。如果槽函数传递给它一个无法处理的类型，它可以通过返回一个指向 Py_NotImplemented 单一值的引用来表示失败。 然后将尝试其他类型的数值函数，也许它们可以处理该操作；如果其他类型也返回 Py_NotImplemented，那么将引发 TypeError。 用 Python 写的数值方法也可以返回 Py_NotImplemented，导致解释器当作该方法不存在（也许会引发 TypeError，也许会尝试另一个对象的数值方法）。

参见

PEP 208 [https://www.python.org/dev/peps/pep-0208] - 改写强制转换模型

由 Neil Schemenauer 编写和实现，基于 Marc-André Lemburg 的早期工作。阅读这部分内容可以了解数值运算在 C 级别上现在如何处理的细节。

PEP 241: Python 包中的元数据

Python 用户经常抱怨的一个问题是不存在包含所有 Python 模块的单一类目。 位于 www.vex.net/parnassus/ 上 T. Middleton 的 Vaults of Parnassus (2009 年 2 月已停用，可在 Internet Archive Wayback Machine [https://web.archive.org/web/20090130140102/http://www.vex.net/parnassus/] 上查阅) 是最大的 Python 模块类目，但在 Vaults 上注册软件只是个可选项，很多人都懒得这样做。

作为解决这个问题的第一步，使用 Distutils sdist 命令打包的 Python 软件将包含一个名为 PKG-INFO 的文件，其中包含有关包的信息，如名称、版本和作者（在目录编制术语中称为元数据）。PKG-INFO 文件可以包含的字段的完整列表见 PEP 241 [https://www.python.org/dev/peps/pep-0241]。随着人们开始使用 Python 2.1 打包他们的软件，越来越多的包将包含元数据，从而使得构建自动化目录系统并进行实验成为可能。通过积累经验，也许有可能设计一个真正好的目录系统，然后在 Python 2.2 中支持它。例如，Distutils 的 sdist 和 bdist_* 命令可以支持一个 upload 选项，自动将你的包上传到目录服务器。

即使你不使用 Python 2.1，你也可以开始创建包含 PKG-INFO 的包，因为 Distutils 的新版本将为早期 Python 版本的用户发布。Distutils 1.0.2 版本包含了 PEP 241 [https://www.python.org/dev/peps/pep-0241] 所描述的更改，以及各种错误修复和增强功能。可以从 Distutils SIG 上获取该版本 https://www.python.org/community/sigs/current/distutils-sig/ 。

参见

PEP 241 [https://www.python.org/dev/peps/pep-0241] - 针对 Python 软件包的元数据

由 A.M. Kuchling 撰写并实现。

PEP 243 [https://www.python.org/dev/peps/pep-0243] - 模块仓库上传机制

由 Sean Reifschneider 撰写，这个 PEP 草案描述了用于将 Python 软件包上传到一个中心服务器的建议机制。

新增和改进的模块

Ka-Ping Yee contributed two new modules: inspect.py, a module for getting information about live Python code, and pydoc.py, a module for interactively converting docstrings to HTML or text. As a bonus, Tools/scripts/pydoc, which is now automatically installed, uses pydoc.py to display documentation given a Python module, package, or class name. For example, pydoc xml.dom displays the following:

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:
      ...

pydoc 还包括一个基于 Tk 的交互式帮助浏览器。pydoc 很快会让人上瘾；试试看！

Two different modules for unit testing were added to the standard library. The doctest module, contributed by Tim Peters, provides a testing framework based on running embedded examples in docstrings and comparing the results against the expected output. PyUnit, contributed by Steve Purcell, is a unit testing framework inspired by JUnit, which was in turn an adaptation of Kent Beck's Smalltalk testing framework. See http://pyunit.sourceforge.net/ for more information about PyUnit.

The difflib module contains a class, SequenceMatcher, which compares two sequences and computes the changes required to transform one sequence into the other. For example, this module can be used to write a tool similar to the Unix diff program, and in fact the sample program Tools/scripts/ndiff.py demonstrates how to write such a script.

curses.panel，是 ncurses 和 SYSV curses 一部分的 panel 库的包装器，由 Thomas Gellekum 贡献。panel 库为窗口提供了深度特性。窗口可以在深度顺序中向上或向下移动，panel 库会计算出面板的重叠位置和哪些部分是可见的。

The PyXML package has gone through a few releases since Python 2.0, and Python 2.1 includes an updated version of the xml package. Some of the noteworthy changes include support for Expat 1.2 and later versions, the ability for Expat parsers to handle files in any encoding supported by Python, and various bugfixes for SAX, DOM, and the minidom module.

Ka-Ping Yee 还贡献了另一个用于处理未捕获异常的钩子。sys.excepthook() 可以设置为一个可调用对象。当异常未被任何 try...except 块捕获时，异常将传递给 sys.excepthook()，它可以执行任何需要的操作。在第九届 Python 会议上，他演示了这个钩子的一个应用：打印扩展的回溯信息，不仅列出堆栈帧，还列出每个帧的函数参数和局部变量。

Various functions in the time module, such as asctime() and localtime(), require a floating point argument containing the time in seconds since the epoch. The most common use of these functions is to work with the current time, so the floating point argument has been made optional; when a value isn't provided, the current time will be used. For example, log file entries usually need a string containing the current time; in Python 2.1, time.asctime() can be used, instead of the lengthier time.asctime(time.localtime(time.time())) that was previously required.

此更改由 Thomas Wouters 提出并实现。

ftplib 模块现在默认以被动模式检索文件，因为被动模式在防火墙后面更可能正常工作。这一请求来自 Debian 错误跟踪系统，因为其他 Debian 包使用 ftplib 来检索文件，但在防火墙后面无法正常工作。由于 Netscape 默认使用被动模式且几乎没有人抱怨，因此认为这不太可能会对任何人造成问题。但如果被动模式不适合你的应用程序或网络设置，可以调用 FTP 对象的 set_pasv(0) 来禁用被动模式。

对原始套接字访问的支持已添加到 socket 模块中，由 Grant Edwards 贡献。

pstats 模块现在包含一个简单的交互式统计浏览器，用于显示 Python 程序的时间分析结果，当该模块作为脚本运行时调用。此功能由 Eric S. Raymond 贡献。

新增了一个依赖于实现的函数 sys._getframe([depth])，用于从当前调用堆栈中返回给定的帧对象。sys._getframe`返回调用堆栈顶部的帧对象；如果提供了可选的整数参数 depth，则该函数返回堆栈顶部以下 depth 层的帧。例如，``sys._getframe(1)`() 返回调用者的帧对象。

这个函数仅存在于 CPython 中，不存在于 Jython 或 .NET 实现中。请将其用于调试，并避免将其放入生产代码中。

其他的改变和修正

由于较短的发布周期，Python 2.1 中的较小更改相对较少。通过搜索 CVS 更改日志，发现应用了 117 个补丁并修复了 136 个错误；这两个数字都可能是低估的。一些较为显著的更改包括：

A specialized object allocator is now optionally available, that should be faster than the system malloc() and have less memory overhead. The allocator uses C's malloc() function to get large pools of memory, and then fulfills smaller memory requests from these pools. It can be enabled by providing the --with-pymalloc option to the configure script; see Objects/obmalloc.c for the implementation details.

Authors of C extension modules should test their code with the object allocator enabled, because some incorrect code may break, causing core dumps at runtime. There are a bunch of memory allocation functions in Python's C API that have previously been just aliases for the C library's malloc() and free(), meaning that if you accidentally called mismatched functions, the error wouldn't be noticeable. When the object allocator is enabled, these functions aren't aliases of malloc() and free() any more, and calling the wrong function to free memory will get you a core dump. For example, if memory was allocated using PyMem_New(), it has to be freed using PyMem_Del(), not free(). A few modules included with Python fell afoul of this and had to be fixed; doubtless there are more third-party modules that will have the same problem.

对象分配器由 Vladimir Marangozov 贡献。

The speed of line-oriented file I/O has been improved because people often complain about its lack of speed, and because it's often been used as a naïve benchmark. The readline() method of file objects has therefore been rewritten to be much faster. The exact amount of the speedup will vary from platform to platform depending on how slow the C library's getc() was, but is around 66%, and potentially much faster on some particular operating systems. Tim Peters did much of the benchmarking and coding for this change, motivated by a discussion in comp.lang.python.

A new module and method for file objects was also added, contributed by Jeff Epler. The new method, xreadlines(), is similar to the existing xrange() built-in. xreadlines() returns an opaque sequence object that only supports being iterated over, reading a line on every iteration but not reading the entire file into memory as the existing readlines() method does. You'd use it like this:

for line in sys.stdin.xreadlines():
    # ... do something for each line ...
    ...

有关行 I/O 更改的更详细讨论，请参阅 2001 年 1 月 1 日至 15 日的 python-dev 摘要 https://mail.python.org/pipermail/python-dev/2001-January/ 。

A new method, popitem(), was added to dictionaries to enable destructively iterating through the contents of a dictionary; this can be faster for large dictionaries because there's no need to construct a list containing all the keys or values. D.popitem() removes a random (key, value) pair from the dictionary D and returns it as a 2-tuple. This was implemented mostly by Tim Peters and Guido van Rossum, after a suggestion and preliminary patch by Moshe Zadka.

模块现在可以通过定义一个 __all__ 属性来控制使用 from module import * 时导入的名称。 一个常见的抱怨是，如果模块导入了其他模块，例如 sys 或 string，使用 from module import * 会将它们添加到导入模块的命名空间中。 为了解决这个问题，只需在 __all__ 模块中列出公共名称即可:

# List public names
__all__ = ['Database', 'open']

此补丁的更严格版本最初由 Ben Wolfson 提出并实现，但在经过一些 python-dev 讨论后，最终版本被修改为较弱的版本并提交。

以前对字符串应用 repr() 时，对于不可打印字符使用八进制转义符；例如，换行符表示为 '\012'。这是 Python 从 C 语言继承而来的遗留特性，但如今八进制的实际用途非常有限。Ka-Ping Yee 建议使用十六进制转义符代替八进制，并使用 \n、\t、\r 等转义符表示适当的字符，并实现了这种新的格式。

在编译时检测到的语法错误现在可以引发包含错误文件名和行号的异常，这是 Jeremy Hylton 进行的编译器重组的一个令人愉快的副作用。

C extensions which import other modules have been changed to use PyImport_ImportModule(), which means that they will use any import hooks that have been installed. This is also encouraged for third-party extensions that need to import some other module from C code.

由于 Fredrik Lundh 的努力，Unicode 字符数据库的大小又减少了 340K。

一些新移植版本被贡献：MacOS X（由 Steven Majewski 贡献），Cygwin（由 Jason Tishler 贡献），RISCOS（由 Dietmar Schwertberger 贡献），以及 Unixware 7（由 Billy G. Allie 贡献）。

此外还有一份由次要的程序错误修复、次要的内存泄漏、文档字符串编辑和其他调整组成的常规清单，因过于冗长而不值得逐项列出；如果你想了解完整细节请参阅 CVS 日志。

致谢

作者感谢以下人员对本文的各种草案提出建议： Graeme Cross, David Goodger, Jay Graves, Michael Hudson, Marc-André Lemburg, Fredrik Lundh, Neil Schemenauer, Thomas Wouters.

Python 2.0 有什么新变化

作者

A.M. Kuchling 和 Moshe Zadka

概述

A new release of Python, version 2.0, was released on October 16, 2000. This article covers the exciting new features in 2.0, highlights some other useful changes, and points out a few incompatible changes that may require rewriting code.

Python 的开发工作在版本发布之间绝不会完全停止，总是会有错误修复和改进被持续地提交。 2.0 中包含了大量的小问题修正、一些性能优化、额外的文档字符串和更完善的错误消息；要列出所有这些是不可能的，但它们确实带来了明显的变化。 如果你想查看完整清单可以参阅公开的 CVS 日志。 这些进展归功于为 PythonLabs 工作的五位开发者，他们现在可以付出时间修复问题并获得报酬，同时也归功于迁移到 SourceForge 后在沟通方面的改善。

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 月之间完成的。

新开发流程

Python 2.0 中最重要的变化可能根本不是代码，而是 Python 的开发方式：在 2000 年 5 月，Python 开发者开始使用 SourceForge 提供的工具来存储源代码、跟踪错误报告以及管理补丁提交队列。 要报告 Python 2.0 的错误或提交补丁，请使用位于 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 是描述拟议新特性的草案文件，并不断修改，直到社区达成共识，接受或拒绝该提案。 引用自 PEP 1 [https://www.python.org/dev/peps/pep-0001] 的介绍部分 "PEP Purpose and Guidelines"：

PEP 是 Python Enhancement Proposal 的缩写。 一个 PEP 就是一份设计文档，用来向 Python 社区提供信息，或描述一个 Python 新增特性。 PEP 应当提供对所提议特性的精确的技术规格和原理说明。

我们打算将 PEP 作为提出新特性建议、收集社区对特定问题意见以及为必须加入 Python 的设计决策编写文档的首选机制。 PEP 的作者有责任在社区内部建立共识，并应将对立的观点也记入文档。

Read the rest of PEP 1 [https://www.python.org/dev/peps/pep-0001] for the details of the PEP editorial process, style, and format. PEPs are kept in the Python CVS tree on SourceForge, though they're not part of the Python 2.0 distribution, and are also available in HTML form from https://www.python.org/dev/peps/. As of September 2000, there are 25 PEPS, ranging from PEP 201 [https://www.python.org/dev/peps/pep-0201], "Lockstep Iteration", to PEP 225, "Elementwise/Objectwise Operators".

Unicode

Python 2.0 中最大的新特性是引入了一种新的基本数据类型：Unicode 字符串。 Unicode 使用 16 位二进制数表示字符，而不是 ASCII 所使用的 8 位，这意味着可以支持 65,536 个不同的字符。

Unicode 支持的最终接口是通过在 python-dev 邮件列表上无数次激烈的讨论达成的，主要由 Marc-André Lemburg 基于 Fredrik Lundh 的 Unicode 字符串类型实现来完成。 详细的接口说明被写成了 PEP 100 [https://www.python.org/dev/peps/pep-0100] "Python Unicode Integration"。 这篇文章只简单地涵盖关于 Unicode 接口的最重要信息。

In Python source code, Unicode strings are written as u"string". Arbitrary Unicode characters can be written using a new escape sequence, \uHHHH, where HHHH is a 4-digit hexadecimal number from 0000 to FFFF. The existing \xHHHH escape sequence can also be used, and octal escapes can be used for characters up to U+01FF, which is represented by \777.

Unicode 字符串和常规字符串一样，是一种不可变的序列类型。 它们可以被索引和切片，但不能原地修改。 Unicode 字符串有一个 encode( [encoding] ) 方法，该方法返回一个以所需编码格式表示的 8 位字符串。 编码格式通过字符串命名，如 'ascii'、'utf-8'、'iso-8859-1' 等等。 为实现和注册新的编码格式定义了一个编解码器 API，这些编码格式随后可在整个 Python 程序中使用。 如果未指定编码格式，默认编码格式通常是 7 位 ASCII，不过这可以通过在自定义版本的 site.py 模块中调用 sys.setdefaultencoding(encoding) 函数来更改。

将 8 比特位和 Unicode 的字符串结合使用时将总是会使用默认 ASCII 编码格式强制转换到 Unicode；'a' + u'bc' 的结果将为 u'abc'。

新增了一批内置函数，现有的内置函数也被修改为支持 Unicode：

unichr(ch) 将返回长度为 1 个字符的 Unicode 字符串，其中包含字符 ch。

ord(u)，其中 u 是长度为 1 个字符的常规或 Unicode 字符串，将以整数形式返回该字符的码位值。

函数 unicode(string [, encoding] [, errors] ) 从 8 位字符串创建一个 Unicode 字符串。 encoding 是一个指定使用编码格式的字符串。errors 参数指定如何处理当前编码格式中无效的字符；传入 'strict' 作为参数值会在有任何编码错误时引发异常，而 'ignore' 会静默忽略错误，'replace' 则在出现问题时使用 U+FFFD 即官方的替换字符。

exec 语句，以及各种内置函数如 eval()，getattr() 和 setattr() 也会接受 Unicode 字符串和普通字符串。 （修复过程中可能会遗漏一些内置函数；如果你发现一个接受字符串但完全不接受 Unicode 字符串的内置函数，请报告此错误。）

一个新的模块 unicodedata 提供了对 Unicode 字符属性的接口。 例如，unicodedata.category(u'A') 返回 2 个字符的字符串 'Lu'，其中 'L' 表示这是一个字母，'u' 表示这是一个大写字母。 unicodedata.bidirectional(u'\u0660') 返回 'AN'，表示 U+0660 是一个阿拉伯数字。

codecs 模块包含查找现有编码格式和注册新编码格式的函数。 除非你想实现一个新的编码格式，否则你最常使用的是 codecs.lookup(encoding) 函数，它返回一个 4 元素的元组: (encode_func, decode_func, stream_reader, stream_writer)。

encode_func 是一个接受 Unicode 字符串的函数，并返回一个 2 元组 (string, length)。 string 是一个包含部分（可能是全部） Unicode 字符串转换为指定编码的 8 位字符串，length 告诉你转换了多少 Unicode 字符串。

decode_func 与 encode_func 相反，它接受一个 8 位字符串并返回一个 2 元组 (ustring, length)，其中 ustring 是转换得到的 Unicode 字符串，length 是一个整数，表示消耗了多少 8 位字符串。

stream_reader is a class that supports decoding input from a stream. stream_reader(file_obj) returns an object that supports the read(), readline(), and readlines() methods. These methods will all translate from the given encoding and return Unicode strings.

stream_writer, similarly, is a class that supports encoding output to a stream. stream_writer(file_obj) returns an object that supports the write() and writelines() methods. These methods expect Unicode strings, translating them to the given encoding on output.

例如，以下的代码将 Unicode 字符串写入一个 UTF-8 编码的文件:

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()

以下的代码则可以从文件中读取 UTF-8 输入:

input = UTF8_streamreader( open( '/tmp/output', 'rb') )
print repr(input.read())
input.close()

支持 Unicode 的正则表达式可以通过 re 模块使用，该模块有一个新的底层实现称为 SRE，由 Secret Labs AB 的 Fredrik Lundh 编写。

添加了一个 -U 命令行选项，使 Python 编译器将所有字符串字面量解释为 Unicode 字符串字面量。 这用于测试和为你的 Python 代码提供未来保障，因为未来某个版本的 Python 可能会取消对 8 位字符串的支持，只提供 Unicode 字符串。

列表推导式

列表是 Python 中的一种主力数据类型，许多程序在某个时候都会处理列表。 对列表的两种常见操作是遍历它们，并筛选出符合某个条件的元素，或对每个元素应用某个函数。 例如，给定一个字符串列表，你可能想要提取出所有包含特定子字符串的字符串，或去掉每行的尾随空白。

现有的 map() 和 filter() 函数可以用于此目的，但它们需要一个函数作为参数之一。 如果有一个现有的内置函数可以直接传递，这是很好的，但如果没有，你必须创建一个小函数来完成所需的工作。 而 Python 的作用域规则会使结果变得丑陋，特别是如果这个小函数需要额外的信息。 以上一段中的第一个例子为例，找到列表中所有包含给定子字符串的字符串。 你可以写如下代码来实现:

# Given the list L, make a list of all strings
# containing the substring S.
sublist = filter( lambda s, substring=S:
                     string.find(s, substring) != -1,
                  L)

由于 Python 的作用域规则，将会使用默认参数以使由 lambda 表达式创建的匿名函数知道正在搜索哪个子字符串。 列表推导能使这个过程更简洁:

sublist = [ s for s in L if string.find(s, S) != -1 ]

列表推导式的形式如下:

[ expression for expr in sequence1
             for expr2 in sequence2 ...
             for exprN in sequenceN
             if condition ]

for...:keyword:!in 子句包含要迭代的序列。 这些序列不必具有相同的长度，因为它们 不是 并行迭代的，而是从左到右依次迭代；这一点将在以下段落中更清楚地解释。 生成列表的元素将是 表达式 的连续值。 最后的 if 子句是可选的；如果存在，只有当 condition 为真时，表达式 才会被求值并添加到结果中。

为了使语义更为清晰，列表推导相当于以下 Python 代码:

for expr1 in sequence1:
    for expr2 in sequence2:
    ...
        for exprN in sequenceN:
             if (condition):
                  # Append the value of
                  # the expression to the
                  # resulting list.

这意味着当有多个 for...:keyword:!in 子句时，生成的列表将等于所有序列长的的乘积。 如果你有两个长度为 3 的列表，输出列表将有 9 个元素:

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)]

为了避免在 Python 的语法中引入歧义，如果 表达式 创建的是一个元组，它必须用括号括起来。 下面的第一个列表推导式有语法错误，而第二个则是正确的:

# Syntax error
[ x,y for x in seq1 for y in seq2]
# Correct
[ (x,y) for x in seq1 for y in seq2]

列表推导的概念最初来自函数式编程语言 Haskell (https://www.haskell.org)。 Greg Ewing 最有力地提出了将其添加到 Python 中的建议，并编写了最初的列表推导式补丁，然后在 python-dev 邮件列表上进行了看似无休止的讨论，并由 Skip Montanaro 保持更新。

增强赋值

增强赋值运算符，另一个长期以来要求添加的功能，已经被加入到 Python 2.0 中。 增强赋值运算符包括 +=，-=，*= 等。例如，语句 a += 2 将变量 a 的值增加 2，等同于稍长一些的 a = a + 2。

The full list of supported assignment operators is +=, -=, *=, /=, %=, **=, &=, |=, ^=, >>=, and <<=. Python classes can override the augmented assignment operators by defining methods named __iadd__(), __isub__(), etc. For example, the following Number class stores a number and supports using += to create a new instance with an incremented value.

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

The __iadd__() special method is called with the value of the increment, and should return a new instance with an appropriately modified value; this return value is bound as the new value of the variable on the left-hand side.

增强赋值运算符最早在 C 编程语言中引入，大多数 C 派生语言，如 awk，C++，Java 和 PHP 也支持它们。 增强赋值补丁由 Thomas Wouters 实现。

字符串的方法

Until now string-manipulation functionality was in the string module, which was usually a front-end for the strop module written in C. The addition of Unicode posed a difficulty for the strop module, because the functions would all need to be rewritten in order to accept either 8-bit or Unicode strings. For functions such as string.replace(), which takes 3 string arguments, that means eight possible permutations, and correspondingly complicated code.

相反，Python 2.0 将这个问题推给了字符串类型，使字符串操作功能通过 8 位字符串和 Unicode 字符串上的方法来实现。

>>> 'andrew'.capitalize()
'Andrew'
>>> 'hostname'.replace('os', 'linux')
'hlinuxtname'
>>> 'moshe'.find('sh')
2

有一件事没有改变，即使是值得注意的愚人节玩笑，Python 字符串仍然是不可变的。 因此，字符串方法返回的是新的字符串，而不是修改他们操作的原字符串。

旧的 string 模块仍然存在以保持向向兼容，但它主要作为新字符串方法的前端。

Two methods which have no parallel in pre-2.0 versions, although they did exist in JPython for quite some time, are startswith() and endswith(). s.startswith(t) is equivalent to s[:len(t)] == t, while s.endswith(t) is equivalent to s[-len(t):] == t.

One other method which deserves special mention is join(). The join() method of a string receives one parameter, a sequence of strings, and is equivalent to the string.join() function from the old string module, with the arguments reversed. In other words, s.join(seq) is equivalent to the old string.join(seq, s).

循环的垃圾回收

Python 的 C 实现使用引用技术来实现垃圾回收。 每个 Python 对象维护一个指向自身的引用数量，并在引用创建或销毁时调整该计数。 一旦引用计数达到零，对象就不再可访问，因为访问对象需要一个引用，然后如果计数为零，就不再存在任何引用。

引用计数有一些令人愉快的特性：它易于理解和实现，结果实现是可移植的，相当快，并且与其他实现自己内存处理方案的库良好互动。引用计数的主要问题是有时它无法识别对象不再可访问，从而导致内存泄露，这发生在存在引用循环时。

考虑最简单的循环，一个类实例引用自身:

instance = SomeClass()
instance.myself = instance

在执行完上述两行代码后，instance 的引用计数是 2；一个引用来自名为 'instance' 的变量，另一个引用来自该实例的 myself 属性。

如果下一行代码是 del instance，会发生什么？ instance 的引用计数会减少 1，所以它的引用计数变为 1；myself 属性中的引用仍然存在。 然而，该实例不能再通过 Python 代码访问，并且它可以被删除。 如果多个对象相互引用，它们可以参与一个循环，导致所有对象都无法被垃圾回收，从而导致内存泄漏。

Python 2.0 通过周期性的执行一个循环检测算法来解决这个问题，该算法查找不可访问的循环并删除涉及的对象。 一个新的 gc 模块提供了执行垃圾回收、获取调试统计信息和调整回收器参数的功能。

运行循环检测算法需要一些时间，因此会带来一些额外的开销，希望在使用 2.0 版本的循环收集经验之后，Python 2.1 可以通过精细调整来尽量减少开销。 目前还不清楚性能损失有多大，因为对此进行精准测试很棘手，而且关键在于程序创建和销毁对象的频率。 如果你不能接受哪怕是微小的速度损失，或者怀疑循环收集存在问题，可以在编译 Python 时禁用循环检测，通过在运行 configure 脚本时指定 --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” 的帖子中。

其他核心变化

Python 的语法和内置函数进行了各种小改动。 虽然这些改动都不是非常深远，但它们都是很方便的改进。

细微的语言特性修改

A new syntax makes it more convenient to call a given function with a tuple of arguments and/or a dictionary of keyword arguments. In Python 1.5 and earlier, you'd use the apply() built-in function: apply(f, args, kw) calls the function f() with the argument tuple args and the keyword arguments in the dictionary kw. apply() is the same in 2.0, but thanks to a patch from Greg Ewing, f(*args, **kw) is a shorter and clearer way to achieve the same effect. This syntax is symmetrical with the syntax for defining functions:

def f(*args, **kw):
    # args is a tuple of positional args,
    # kw is a dictionary of keyword args
    ...

The print statement can now have its output directed to a file-like object by following the print with >> file, similar to the redirection operator in Unix shells. Previously you'd either have to use the write() method of the file-like object, which lacks the convenience and simplicity of print, or you could assign a new value to sys.stdout and then restore the old value. For sending output to standard error, it's much easier to write this:

print >> sys.stderr, "Warning: action field not supplied"

模块现在可以在导入时重命名，使用语法 import module as name 或 from module import name as othername。这个补丁是由 Thomas Wouters 提交的。

当使用 % 操作符时有一种新的格式样式可用；'%r' 将插入其参数的 repr() 表示。 这也是为了对称性，这次是为了与现有的 %s 格式样式对称，后者插入其参数的 str() 表示。例如，'%r %s' % ('abc', 'abc') 返回一个包含 'abc' abc 的字符串。

Previously there was no way to implement a class that overrode Python's built-in in operator and implemented a custom version. obj in seq returns true if obj is present in the sequence seq; Python computes this by simply trying every index of the sequence until either obj is found or an IndexError is encountered. Moshe Zadka contributed a patch which adds a __contains__() magic method for providing a custom implementation for in. Additionally, new built-in objects written in C can define what in means for them via a new slot in the sequence protocol.

早期版本的 Python 使用递归算法来删除对象。深度嵌套的数据结构可能导致解释器填满 C 栈并崩溃。 Christian Tismer 重写了删除逻辑来解决这个问题。 相关地，比较递归对象时会导致无线递归并崩溃。Jeremy Hylton 重写了代码，使其不再崩溃，而是产生有用的结果。 例如，在以下代码之后:

a = []
b = []
a.append(a)
b.append(b)

The comparison a==b returns true, because the two recursive data structures are isomorphic. See the thread "trashcan and PR#7" in the April 2000 archives of the python-dev mailing list for the discussion leading up to this implementation, and some useful relevant links. Note that comparisons can now also raise exceptions. In earlier versions of Python, a comparison operation such as cmp(a,b) would always produce an answer, even if a user-defined __cmp__() method encountered an error, since the resulting exception would simply be silently swallowed.

来自 ActiveState 的 Trent Mick 主要负责将 Python 移植到 Itanium 处理器上的 64 位 Windows 上。 （令人困惑的是，在 Win64 上，sys.platform 类型仍然是 'win32' 的，因为为了便于移植，MS Visual C++ 在 Itanium 上将代码视为 32 位。） PythonWin 还支持 Windows CE；更多信息请参见 https://pythonce.sourceforge.net/ 的 Python CE 页面。

另一个新的平台是 Darwin/MacOS X；Python 2.0 中提供了初步支持。如果你指定 "configure --with-dyld --with-suffix=.x"，动态加载是可行的。 有关更多说明，请参阅 Python 源代码分发中的 README 文件。

已经尝试解决 Python 的一个问题，即当代码在局部变量赋值之前引用该变量时，会引发经常令人困惑的 NameError 异常。例如，以下代码在 1.5.2 和 2.0 中都会在 print 语句上引发异常；在 1.5.2 中，会引发 NameError 异常，而在 2.0 中，会引发一个新的 UnboundLocalError 异常。 UnboundLocalError 是 NameError 的子类，因此任何期望引发 NameError 的现有代码应该仍然可以正常工作。

def f():
    print "i=",i
    i = i + 1
f()

新引入了两个异常 TabError 和 IndentationError。 它们均为 SyntaxError 的子类，并会在发现 Python 代码缩进不正确时被引发。

对于内置函数的修改

添加了一个新的内置函数 zip(seq1, seq2, ...)。zip() 返回一个包含元组的列表，每个元组包含每个参数序列的第i个元素。zip() 和 map(None, seq1, seq2) 的区别在于，如果序列长度不一致，map() 会用 None 填充序列，而 zip() 会将返回的列表截短到最短的参数序列的长度。

The int() and long() functions now accept an optional "base" parameter when the first argument is a string. int('123', 10) returns 123, while int('123', 16) returns 291. int(123, 16) raises a TypeError exception with the message "can't convert non-string with explicit base".

在 sys 模块中添加了一个新变量，用于保存更详细的版本信息。 sys.version_info 是一个包含五个元素的元组 (major, minor, micro, level, serial)。 例如，在假设的 2.0.1beta1 版本中，sys.version_info 将是 (2, 0, 1, 'beta', 1)。 level 是一个字符串，如 "alpha"、"beta" 或代表最终发布版本的 "final"。

Dictionaries have an odd new method, setdefault(key, default), which behaves similarly to the existing get() method. However, if the key is missing, setdefault() both returns the value of default as get() would do, and also inserts it into the dictionary as the value for key. Thus, the following lines of code:

if dict.has_key( key ): return dict[key]
else:
    dict[key] = []
    return dict[key]

可以简化为单个``return dict.setdefault(key, [])``语句。

解释器设置了一个最大递归深度，以便在填满 C 栈并导致核心储存或 GPF 之前捕获失控递归。以前这个限制是在编译 Python 时固定的，但在 2.0 中最大递归深度可以使用 sys.getrecursionlimit() 和 sys.setrecursionlimit() 读取和修改。 默认值是 1000，可以通过运行一个新脚本 Misc/find_recursionlimit.py 来找到给定平台的大致的最大值。

移植 Python 2.0

新的 Python 版本尽力与之前的版本兼容，而且兼容性记录相当不错。 然而，有些变化被认为足够有用，通常是因为他们修正了最终设计中的错误决定，因此有时无法避免打破向后兼容性。 本节列出了 Python 2.0 中可能导致旧 Python 代码中断的更改。

The change which will probably break the most code is tightening up the arguments accepted by some methods. Some methods would take multiple arguments and treat them as a tuple, particularly various list methods such as append() and insert(). In earlier versions of Python, if L is a list, L.append( 1,2 ) appends the tuple (1,2) to the list. In Python 2.0 this causes a TypeError exception to be raised, with the message: 'append requires exactly 1 argument; 2 given'. The fix is to simply add an extra set of parentheses to pass both values as a tuple: L.append( (1,2) ).

The earlier versions of these methods were more forgiving because they used an old function in Python's C interface to parse their arguments; 2.0 modernizes them to use PyArg_ParseTuple(), the current argument parsing function, which provides more helpful error messages and treats multi-argument calls as errors. If you absolutely must use 2.0 but can't fix your code, you can edit Objects/listobject.c and define the preprocessor symbol NO_STRICT_LIST_APPEND to preserve the old behaviour; this isn't recommended.

Some of the functions in the socket module are still forgiving in this way. For example, socket.connect( ('hostname', 25) )() is the correct form, passing a tuple representing an IP address, but socket.connect( 'hostname', 25 )() also works. socket.connect_ex() and socket.bind() are similarly easy-going. 2.0alpha1 tightened these functions up, but because the documentation actually used the erroneous multiple argument form, many people wrote code which would break with the stricter checking. GvR backed out the changes in the face of public reaction, so for the socket module, the documentation was fixed and the multiple argument form is simply marked as deprecated; it will be tightened up again in a future Python version.

字符串字面量中的 \x 转义现在必须精确地使用2个十六进制数字。之前它会消耗 x 后面的所有十六进制数字，并取结果的最低8位，所以 \x123456 等同于 \x56。

AttributeError 和 NameError 异常现在有了更友好的错误消息，其文本内容类似于 'Spam' instance has no attribute 'eggs' 或 name 'eggs' is not defined。 之前的错误消息只是缺少的属性名称，如 eggs，因此利用这一事实编写的代码在 2.0 中会中断。

Some work has been done to make integers and long integers a bit more interchangeable. In 1.5.2, large-file support was added for Solaris, to allow reading files larger than 2 GiB; this made the tell() method of file objects return a long integer instead of a regular integer. Some code would subtract two file offsets and attempt to use the result to multiply a sequence or slice a string, but this raised a TypeError. In 2.0, long integers can be used to multiply or slice a sequence, and it'll behave as you'd intuitively expect it to; 3L * 'abc' produces 'abcabcabc', and (0,1,2,3)[2L:4L] produces (2,3). Long integers can also be used in various contexts where previously only integers were accepted, such as in the seek() method of file objects, and in the formats supported by the % operator (%d, %i, %x, etc.). For example, "%d" % 2L**64 will produce the string 18446744073709551616.

最微妙的长整数变化是，长整数的 str() 表示不再有尾随的 'L' 字符，尽管 repr() 表示仍然包含它。许多人在打印长整数时不希望看到 'L' 字符，因为他们不得不专门去掉这个字符。在2.0中，这不再是一个问题，但那些使用 str(longval)[:-1] 并假设存在 'L' 的代码，现在将丢失最后一个数字。

Taking the repr() of a float now uses a different formatting precision than str(). repr() uses %.17g format string for C's sprintf(), while str() uses %.12g as before. The effect is that repr() may occasionally show more decimal places than str(), for certain numbers. For example, the number 8.1 can't be represented exactly in binary, so repr(8.1) is '8.0999999999999996', while str(8.1) is '8.1'.

The -X command-line option, which turned all standard exceptions into strings instead of classes, has been removed; the standard exceptions will now always be classes. The exceptions module containing the standard exceptions was translated from Python to a built-in C module, written by Barry Warsaw and Fredrik Lundh.

扩展/嵌入更改

有些更改是在底层进行的，仅对编写 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，因此现在支持 isinstance() 和 issubclass()。 这意味着你不再需要记住编写类似 if type(obj) == myExtensionClass 这样的代码，而可以使用更自然的 if isinstance(obj, myExtensionClass)。

Python/importdl.c 文件，它充满了用于支持在许多不同平台上动态加载的 #ifdef，已被 Greg Stein 清理和重组。现在 importdl.c 非常小，平台特定的代码已被移入一组特定的 Python/dynload_*.c 文件中。 另一个清理工作是：Include/ 目录中有许多包含各种可移植性修改的 my*.h 文件；它们已被合并到一个文件中，即 Include/pyport.h。

Vladimir Marangozov's long-awaited malloc restructuring was completed, to make it easy to have the Python interpreter use a custom allocator instead of C's standard malloc(). For documentation, read the comments in Include/pymem.h and Include/objimpl.h. For the lengthy discussions during which the interface was hammered out, see the web archives of the 'patches' and 'python-dev' lists at python.org.

最新版本的 MacOS GUSI 开发环境支持 POSIX 线程。 因此，现在 Python 的 POSIX 线程支持在 Macintosh 上也可以使用。 还贡献了使用用户空间 GNU 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 的补丁将这个限制从 2**16 提高到 2**32。

Three new convenience functions intended for adding constants to a module's dictionary at module initialization time were added: PyModule_AddObject(), PyModule_AddIntConstant(), and PyModule_AddStringConstant(). Each of these functions takes a module object, a null-terminated C string containing the name to be added, and a third argument for the value to be assigned to the name. This third argument is, respectively, a Python object, a C long, or a C string.

A wrapper API was added for Unix-style signal handlers. PyOS_getsig() gets a signal handler and PyOS_setsig() will set a new handler.

Distutils：使模块易于安装

在 Python 2.0 之前，安装模块是一件繁琐的事情 —— 没有办法自动确定 Python 的安装位置，或者用于扩展模块的编译器选项。 软件作者不得不经历一套繁琐的程序来编辑 Makefile 和配置文件，这些只在 Unix 上真正有效，而 Windows 和 Mac OS 不受支持。 Python 用户面对不同扩展包之间大相径庭的安装说明，这使得管理 Python 成了一件麻烦事。

The SIG for distribution utilities, shepherded by Greg Ward, has created the Distutils, a system to make package installation much easier. They form the distutils package, a new part of Python's standard library. In the best case, installing a Python module from source will require the same steps: first you simply mean unpack the tarball or zip archive, and the run "python setup.py install". The platform will be automatically detected, the compiler will be recognized, C extension modules will be compiled, and the distribution installed into the proper directory. Optional command-line arguments provide more control over the installation process, the distutils package offers many places to override defaults -- separating the build from the install, building or installing in non-default directories, and more.

为了使用 Distutils，你需要编写一个 setup.py 脚本。 在简单场景下，当软件仅包含 .py 文件时，最小化的 setup.py 可以只有几行代码:

from distutils.core import setup
setup (name = "foo", version = "1.0",
       py_modules = ["module1", "module2"])

如果软件是由几个包组成的 setup.py 文件也不会太过复杂:

from distutils.core import setup
setup (name = "foo", version = "1.0",
       packages = ["package", "package.subpackage"])

最复杂的情况可能是 C 扩展；下面是一个来自 PyXML 包的示例:

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 ] )

Distutils 还可以负责创建源代码和二进制分发包。运行 python setup.py sdist 的 "sdist" 命令构建一个源代码分发包，如 foo-1.0.tar.gz。添加新命令并不困难，已经有 "bdist_rpm" 和 "bdist_wininst" 命令，分别用于创建软件的 RPM 分发包和 Windows 安装程序。创建其他分发格式的命令，如 Debian 包和 Solaris .pkg 文件，也在开发的不同阶段。

所有这些都记录在一个新手册中，Distributing Python Modules，它加入了Python文档的基本集合中。

XML 模块

Python 1.5.2 included a simple XML parser in the form of the xmllib module, contributed by Sjoerd Mullender. Since 1.5.2's release, two different interfaces for processing XML have become common: SAX2 (version 2 of the Simple API for XML) provides an event-driven interface with some similarities to xmllib, and the DOM (Document Object Model) provides a tree-based interface, transforming an XML document into a tree of nodes that can be traversed and modified. Python 2.0 includes a SAX2 interface and a stripped-down DOM interface as part of the xml package. Here we will give a brief overview of these new interfaces; consult the Python documentation or the source code for complete details. The Python XML SIG is also working on improved documentation.

SAX2 支持

SAX defines an event-driven interface for parsing XML. To use SAX, you must write a SAX handler class. Handler classes inherit from various classes provided by SAX, and override various methods that will then be called by the XML parser. For example, the startElement() and endElement() methods are called for every starting and end tag encountered by the parser, the characters() method is called for every chunk of character data, and so forth.

事件驱动方法的优点是整个文档不必同时驻留在内存中，这在处理非常大的文档时尤其重要。然而，如果你试图以某种复杂的方式修改文档结构，编写 SAX 处理程序类可能会变得非常复杂。

例如，这个小示例程序定义了一个处理器，它为每个开始和结束标签打印一条消息，然后使用它来解析文件 hamlet.xml:

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

# Create a parser object
parser = sax.make_parser()

# Tell it what handler to use
handler = SimpleHandler()
parser.setContentHandler( handler )

# Parse a file!
parser.parse( 'hamlet.xml' )

For more information, consult the Python documentation, or the XML HOWTO at http://pyxml.sourceforge.net/topics/howto/xml-howto.html.

DOM 支持

The Document Object Model is a tree-based representation for an XML document. A top-level Document instance is the root of the tree, and has a single child which is the top-level Element instance. This Element has children nodes representing character data and any sub-elements, which may have further children of their own, and so forth. Using the DOM you can traverse the resulting tree any way you like, access element and attribute values, insert and delete nodes, and convert the tree back into XML.

DOM 在修改 XML 文档方面非常有用，因为你可以创建一个 DOM 树，通过添加新节点或重新排列子树来修改它，然后生成一个新的 XML 文档作为输出。你还可以手动构建一个 DOM 树并将其转换为 XML，这比简单地将``<tag1>``...``</tag1>``写入文件更灵活。

The DOM implementation included with Python lives in the xml.dom.minidom module. It's a lightweight implementation of the Level 1 DOM with support for XML namespaces. The parse() and parseString() convenience functions are provided for generating a DOM tree:

from xml.dom import minidom
doc = minidom.parse('hamlet.xml')

doc is a Document instance. Document, like all the other DOM classes such as Element and Text, is a subclass of the Node base class. All the nodes in a DOM tree therefore support certain common methods, such as toxml() which returns a string containing the XML representation of the node and its children. Each class also has special methods of its own; for example, Element and Document instances have a method to find all child elements with a given tag name. Continuing from the previous 2-line example:

perslist = doc.getElementsByTagName( 'PERSONA' )
print perslist[0].toxml()
print perslist[1].toxml()

对于 Hamlet XML 文件，上面几行代码输出:

<PERSONA>CLAUDIUS, king of Denmark. </PERSONA>
<PERSONA>HAMLET, son to the late, and nephew to the present king.</PERSONA>

文件的根元素可以通过 doc.documentElement 访问，并且可以通过删除、添加或一处节点来听松修改节点来轻松修改其子元素:

root = doc.documentElement

# Remove the first child
root.removeChild( root.childNodes[0] )

# Move the new first child to the end
root.appendChild( root.childNodes[0] )

# Insert the new first child (originally,
# the third child) before the 20th child.
root.insertBefore( root.childNodes[0], root.childNodes[20] )

Again, I will refer you to the Python documentation for a complete listing of the different Node classes and their various methods.

与 PyXML 的关系

XML 特别兴趣小组已经致力于与 XML 相关的 Python 代码有一段时间了。 其代码分发包称为 PyXML，可以从 SIG 的网页 https://www.python.org/community/sigs/current/xml-sig 获取。 PyXML 分发包也使用了 xml 作为包名。 如果你编写了使用 PyXML 的程序，可能会担心它与 Python 2.0 的 xml 包的兼容性。

答案是 Python 2.0 的 xml 包与 PyXML 不兼容，但可以通过安装最新版本的 PyXML 来使其兼容。 许多应用程序可以依赖 Python 2.0 中包含的 XML 支持，但更复杂的应用程序需要安装完整的 PyXML 包。 安装后，版本为 0.6.0 或更高的 PyXML 将替换随 Python 一起发布的 xml 包，并且将是标准包的严格超集，添加许多额外的功能。 PyXML 中的一些附加功能包括：

4DOM，一个来自 FourThought, Inc. 的完整 DOM 实现。

xmlproc 验证解析器，由 Lars Marius Garshol 编写。

sgmlop 解析器加速器模块，由 Fredrik Lundh 编写。

模块更改

Lots of improvements and bugfixes were made to Python's extensive standard library; some of the affected modules include readline, ConfigParser, cgi, calendar, posix, readline, xmllib, aifc, chunk, wave, random, shelve, and nntplib. Consult the CVS logs for the exact patch-by-patch details.

Brian Gallew contributed OpenSSL support for the socket module. OpenSSL is an implementation of the Secure Socket Layer, which encrypts the data being sent over a socket. When compiling Python, you can edit Modules/Setup to include SSL support, which adds an additional function to the socket module: socket.ssl(socket, keyfile, certfile), which takes a socket object and returns an SSL socket. The httplib and urllib modules were also changed to support https:// URLs, though no one has implemented FTP or SMTP over SSL.

The httplib module has been rewritten by Greg Stein to support HTTP/1.1. Backward compatibility with the 1.5 version of httplib is provided, though using HTTP/1.1 features such as pipelining will require rewriting code to use a different set of interfaces.

The Tkinter module now supports Tcl/Tk version 8.1, 8.2, or 8.3, and support for the older 7.x versions has been dropped. The Tkinter module now supports displaying Unicode strings in Tk widgets. Also, Fredrik Lundh contributed an optimization which makes operations like create_line and create_polygon much faster, especially when using lots of coordinates.

curses 模块在 Oliver Andrich 增强版本的基础上得到了极大的扩展，提供了许多来自 ncurses 和 SYSV curses 的附加功能，如颜色、替代字符集支持、手写板和鼠标支持等。 这意味着该模块不再兼容仅有 BSD curses 的操作系统，但目前似乎没有任何属于这一类别的操作系统正在维护中。

如前面讨论的 Python 2.0 对 Unicode 的支持所提到的，re 模块提供的正则表达式的底层实现已经更改。 SRE，一个新的正则表达式引擎，由 Ferdrik Lundh 编写，部分由惠普资助，支持匹配 8 位字符串和 Unicode 字符串。

新增模块

添加了许多新模块，我们将简单列出它们并附上简要概述；有关特定模块的详细信息，请查阅 2.0 文档。

atexit 模块用于注册在 Python 解释器退出之前调用的函数。当前直接设置 sys.exitfunc 的代码应改为使用 atexit 模块，导入 atexit 并使用 atexit.register() 调用要在退出时调用的函数。 （由 Skip Montanaro 贡献。）

codecs, encodings, unicodedata: Added as part of the new Unicode support.

filecmp: Supersedes the old cmp, cmpcache and dircmp modules, which have now become deprecated. (Contributed by Gordon MacMillan and Moshe Zadka.)

gettext: 这个模块通过提供 GNU gettext 消息目录库的接口，为 Python 程序提供国际化（I18N）和本地化（L10N）支持。 （由 Barry Warsaw 整合，来自 Martin von Löwis, Peter Funk 和 James Henstridge 的独立贡献。）

linuxaudiodev: Support for the /dev/audio device on Linux, a twin to the existing sunaudiodev module. (Contributed by Peter Bosch, with fixes by Jeremy Hylton.)

mmap: 提供对内存映射文件的接口，支持 Windows 和 Unix。文件的内容可以直接映射到内存中，此时它表现得像一个可变字符串，因此可以读取和修改其内容。它们甚至可以传递给期望普通字符串的函数，例如 re 模块。（由 Sam Rushing 贡献，并由 A.M. Kuchling 提供一些扩展。）

pyexpat: An interface to the Expat XML parser. (Contributed by Paul Prescod.)

robotparser: Parse a robots.txt file, which is used for writing web spiders that politely avoid certain areas of a web site. The parser accepts the contents of a robots.txt file, builds a set of rules from it, and can then answer questions about the fetchability of a given URL. (Contributed by Skip Montanaro.)

tabnanny: 一个模块/脚本，用于检查 Python 源代码中不歧义的缩进。 （由 Tim Peters 贡献。）

UserString: A base class useful for deriving objects that behave like strings.

webbrowser 模块提供了一种平台独立的方式来在特定 URL 上启动 web 浏览器。对于每个平台，模块会按特定顺序尝试各种浏览器。用户可以通过设置 BROWSER 环境变量来更改启动的浏览器。（最初的灵感来自 Eric S. Raymond 对 urllib 的补丁，该补丁增加了类似的功能，但最终的模块来自 Fred Drake 最初实现的代码 Tools/idle/BrowserControl.py，并由 Fred 适配到标准库中。）

_winreg: An interface to the Windows registry. _winreg is an adaptation of functions that have been part of PythonWin since 1995, but has now been added to the core distribution, and enhanced to support Unicode. _winreg was written by Bill Tutt and Mark Hammond.

zipfile 模块：用于读取和写入 ZIP 格式的归档文件。 这些归档文件是由 DOS/Windows 上的 PKZIP 或 Unix 上的 zip 生成的，不要与 gzip 格式文件（由 gzip 支持）混淆。 （由 James C. Ahlstrom 贡献。）

imputil: A module that provides a simpler way for writing customized import hooks, in comparison to the existing ihooks module. (Implemented by Greg Stein, with much discussion on python-dev along the way.)

IDLE 改进

IDLE 是官方的 Python 跨平台 IDE，使用 Tkinter 编写。 Python 2.0 包括了 IDLE 0.6，它增加了许多新特性和改进。 部分新内容列表：

界面改进和优化，特别是在语法高亮和自动缩进方面。

类浏览器现在将显示更多信息，例如一个模块中最高层级的函数。

制表符宽度现在是一个用户可设置的选项。在打开现有的 Python 文件时，IDLE 会自动检测缩进约定并进行适应。

现在支持在各种平台上调用浏览器，用于在浏览器中打开 Python 文档。

IDLE 现在有一个命令行，它与原版 Python 解释器大致相同。

在许多地方添加了调用提示。

IDLE 现在可以作为一个包被安装。

在编辑器窗口中，目前在底部位置增加了一个行/列显示栏。

三个新的键盘快捷键：检查模块 (Alt-F5)，导入模块 (F5) 和执行脚本 (Ctrl-F5)。

删除和弃用的模块

A few modules have been dropped because they're obsolete, or because there are now better ways to do the same thing. The stdwin module is gone; it was for a platform-independent windowing toolkit that's no longer developed.

多个模块已被移至 lib-old 子目录: cmp, cmpcache, dircmp, dump, find, grep, packmail, poly, util, whatsound, zmod。 如果你还有依赖于被移至 lib-old 的模块的代码，你可以简单地将该目录添加到 sys.path 来恢复它们，但建议你对任何使用这些模块的代码进行更新。

致谢

作者感谢以下人士对本文的各种草稿提出建议： 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.

更新日志

Python 3.10.20 final

Release date: 2026-03-03

安全性

gh-144125 [https://github.com/python/cpython/issues/144125]: BytesGenerator 现在将拒绝序列化（写入）不安全折叠或分隔的标头；参见 verify_generated_headers。（由 Bas Bloemsaat 和 Petr Viktorin 在 gh-121650 [https://github.com/python/cpython/issues/121650] 中贡献。）

gh-143935 [https://github.com/python/cpython/issues/143935]: 修复了使用现代邮件策略扁平化电子邮件消息时注释折叠中的程序缺陷。由很长的不可折叠字符序列组成的注释可能会触发强制换行，而该换行会省略续行所需的前导空格，导致注释的剩余部分被解释为新的标头字段。这使得通过精心构造的输入实现标头注入成为可能。

gh-143925 [https://github.com/python/cpython/issues/143925]: 拒绝 data: URL 媒体类型中的控制字符。

gh-143919 [https://github.com/python/cpython/issues/143919]: 拒绝 http.cookies.Morsel 字段和值中的控制字符。

gh-143916 [https://github.com/python/cpython/issues/143916]: 拒绝 wsgiref.headers.Headers 字段、值和参数之内的 C0 控制字符。

gh-142145 [https://github.com/python/cpython/issues/142145]: Remove quadratic behavior in xml.minidom node ID cache clearing. In order to do this without breaking existing users, we also add the ownerDocument attribute to xml.dom.minidom elements and attributes created by directly instantiating the Element or Attr class. Note that this way of creating nodes is not supported; creator functions like xml.dom.Document.documentElement() should be used instead.

gh-137836 [https://github.com/python/cpython/issues/137836]: 在 html.parser.HTMLParser 中增加对“纯文本”元素, RAWTEXT 元素 "xmp", "iframe", "noembed" 和 "noframes"，以及可选的 RAWTEXT 元素 "noscript" 的支持。

gh-136063 [https://github.com/python/cpython/issues/136063]: email.message: 确保旧式 HTTP 形参解析为线性复杂度。 由 Bénédikt Tran 编写补丁。

gh-136065 [https://github.com/python/cpython/issues/136065]: 修复 os.path.expandvars() 中的二次幂复杂度问题。

gh-119451 [https://github.com/python/cpython/issues/119451]: 修正 http.client 模块中一个潜在的内存拒绝服务问题。 当连接到一个恶意服务器时，它可能导致分配任意大小的内存。 这会造成多种问题包括 MemoryError、消耗交换空间、内存不足（OOM）杀死进程或容器，甚至系统崩溃。

gh-119452 [https://github.com/python/cpython/issues/119452]: 修正 http.server 模块中一个潜在的内存拒绝服务问题。 当一个恶意用户连接到 Windows 上的 CGI 服务器时，它可能导致分配任意大小的内存。 这会造成多种问题包括 MemoryError、消耗交换空间、内存不足（OOM）杀死进程或容器，甚至系统崩溃。

gh-119342 [https://github.com/python/cpython/issues/119342]: 修正a potential memory denial of service in the plistlib 模块中一个潜在的内存拒绝服务问题。 当读取从不受信任的源接收的 Plist 文件时，它可能导致分配任意大小的内存。 这会造成多种问题包括 MemoryError、消耗交换空间、内存不足（OOM）杀死进程或容器，甚至系统崩溃。

库

gh-144833 [https://github.com/python/cpython/issues/144833]: 修复在 ssl 中当 newPySSLSocket() 的 SSL_new() 返回 NULL 时的一个释放后再使用的问题。 此错误是在对象已被释放后通过一个悬空指针来报告的。

gh-144363 [https://github.com/python/cpython/issues/144363]: 将捆绑的 libexpat [https://libexpat.github.io/] 更新至 2.7.4

gh-90949 [https://github.com/python/cpython/issues/90949]: 为 xmlparser 对象添加 SetAllocTrackerActivationThreshold() 和 SetAllocTrackerMaximumAmplification() 以防止在一个 Expat 解析器内部使用不适当大小的动态内存。 由 Bénédikt Tran 编写补丁。

核心与内置函数

gh-120384 [https://github.com/python/cpython/issues/120384]: Fix an array out of bounds crash in list_ass_subscript, which could be invoked via some specificly tailored input: including concurrent modification of a list object, where one thread assigns a slice and another clears it.

gh-120298 [https://github.com/python/cpython/issues/120298]: Fix use-after free in list_richcompare_impl which can be invoked via some specificly tailored evil input.

Python 3.10.19 final

Release date: 2025-10-09

安全性

gh-139700 [https://github.com/python/cpython/issues/139700]: 检测 zip64 中央目录记录末尾的一致性。 在没有字节数据被附加到 ZIP 文件时支持使用 "zip64 可扩展数据" 的记录。

gh-139400 [https://github.com/python/cpython/issues/139400]: xml.parsers.expat: 确保父级 Expat 解析器当其不再被 ExternalEntityParserCreate() 所创建的子解析器所引用时只会被作为垃圾回收一次。 由 Sebastian Pipping 编写补丁。

gh-135661 [https://github.com/python/cpython/issues/135661]: 根据HTML5标准修复 html.parser.HTMLParser 中开始和结束标签的解析。

不再接受在 </ 和标签名之间的空格。例如，</ script> 不会结束脚本部分。

垂直制表符(\v)和非ASCII空格不再被识别为空白符。空白符只有 \t\n\r\f 和空格。

空字符(U+0000)不再结束标签名。

现在会忽略结束标签中标签名后的属性和斜杠，而不再在带引号的属性值中的第一个 > 处终止解析。例如：</script/foo=">"/>。

现在在开始和结束标签中忽略最后一个属性和闭合 > 之间的多个斜杠和空白符。例如，<a foo=bar/ //>。

属性名与属性值之间多个连续的 = 符号将不再被合并处理。例如：<a foo==bar> 会生成属性名为 "foo"、属性值为 "=bar" 的标签。

gh-135661 [https://github.com/python/cpython/issues/135661]：根据 HTML5 标准修复了 html.parser.HTMLParser 中的 CDATA 段解析问题：] ]> 和 ]] > 不再终止 CDATA 段。新增私有方法 _set_support_cdata()，可用于指定如何解析 <[CDATA[ —— 在外部内容（SVG 或 MathML）中作为 CDATA 段解析，或在 HTML 命名空间中作为伪注释解析。

gh-102555 [https://github.com/python/cpython/issues/102555]: 根据HTML5标准修复 html.parser.HTMLParser 中的注释解析。--!> 现在结束注释。-- > 不再结束注释。支持异常结束的空注释 <--> 和 <--->。

gh-135462 [https://github.com/python/cpython/issues/135462]: 修复 html.parser.HTMLParser 在处理特制输入时的二次方复杂度问题。现根据HTML5规范处理文件结束错误——自动闭合注释和声明，忽略标签。

gh-118350 [https://github.com/python/cpython/issues/118350]：修复 html.parser.HTMLParser 对可转义原始文本模式（"textarea" 和 "title" 元素）的支持问题。

gh-86155 [https://github.com/python/cpython/issues/86155]: html.parser.HTMLParser.close() 现在在 <script> 标签未关闭时不再丢失数据。由 Waylan Limberg 提供补丁。

库

gh-139312 [https://github.com/python/cpython/issues/139312]: 将捆绑的 libexpat 升级至 2.7.3

gh-138998 [https://github.com/python/cpython/issues/138998]: 将捆绑的 libexpat 更新至 2.7.2

gh-130577 [https://github.com/python/cpython/issues/130577]: tarfile 现在可验证归档以确保成员偏移量为非负值。 （由 Alexander Enrique Urieles Nieto 在 gh-130577 [https://github.com/python/cpython/issues/130577] 中贡献。）

gh-135374 [https://github.com/python/cpython/issues/135374]: Update the bundled copy of setuptools to 79.0.1.

Python 3.10.18 final

发布日期: 2025-06-03

安全性

gh-135034 [https://github.com/python/cpython/issues/135034]: 修复了多个问题，这些问题允许使用精心构造的符号链接和硬链接绕过 tarfile 提取过滤器（filter="data" 和 filter="tar"）。

Addresses CVE 2024-12718, CVE 2025-4138, CVE 2025-4330, and CVE 2025-4517.

gh-133767 [https://github.com/python/cpython/issues/133767]: 修复在非"严格"错误处理程序中使用"unicode-escape"解码器时的释放后使用问题。

gh-128840 [https://github.com/python/cpython/issues/128840]: 在 ipaddress 中早期短路处理长IPv6地址，以防止过多的内存消耗和轻微的拒绝服务。

库

gh-128840 [https://github.com/python/cpython/issues/128840]: 修复了解析包含嵌入式IPv4地址的长IPv6地址的问题。

gh-134062 [https://github.com/python/cpython/issues/134062]: ipaddress: 修复 __hash__() 中 IPv4Network 和 IPv6Network 对象的冲突。

gh-123409 [https://github.com/python/cpython/issues/123409]: 根据 RFC 3596, §2.5 [https://datatracker.ietf.org/doc/html/rfc3596.html#section-2.5] 修复 ipaddress.IPv6Address.reverse_pointer 的输出。由 Bénédikt Tran 提供补丁。

bpo-43633 [https://bugs.python.org/issue?@action=redirect&bpo=43633]: 改进 ipaddress 中 IPv4 映射的 IPv6 地址 (RFC 4291 [https://datatracker.ietf.org/doc/html/rfc4291.html] 第 2.2, 2.5.5.2 节) 的文本表示。由 Oleksandr Pavliuk 提交补丁。

Python 3.10.17 final

发布日期: 2025-04-08

安全性

gh-131809 [https://github.com/python/cpython/issues/131809]: 将捆绑的 libexpat 更新至 2.7.1

gh-131261 [https://github.com/python/cpython/issues/131261]: 更新至 libexpat 2.7.0

gh-105704 [https://github.com/python/cpython/issues/105704]: 当使用 urllib.parse.urlsplit() 和 urllib.parse.urlparse() 时主机解析将不会拒绝包含方括号 ([ 和 ]) 的主机名。 根据 `RFC 3986 第 3.2.2 节 <https://www.rfc-editor.org/rfc/rfc3986#section-3.2.2>`__方括号仅适用于 IPv6 和 IPvFuture 主机。

gh-121284 [https://github.com/python/cpython/issues/121284]: 修复了在使用现代电子邮件策略扁平化电子邮件消息时，rfc2047 编码词的折叠错误。以前，当一个编码词对于一行来说太长时，它会被解码、跨行分割并重新编码。但是原始文本中的逗号和其他特殊字符可能会被保留未编码和未引用。如果生成的渲染电子邮件被传输或重新解析，理论上可以利用精心构造的编码词来欺骗标题行。

gh-80222 [https://github.com/python/cpython/issues/80222]: 修复在使用现代电子邮件策略扁平化电子邮件消息时引用字符串折叠的错误。之前，当一个引用字符串被折叠以至于跨越多行时，周围的引号和内部转义将被省略。理论上，如果生成的渲染电子邮件被传输或重新解析，这可能会被用来使用精心构造的引用字符串欺骗标题行。

gh-119511 [https://github.com/python/cpython/issues/119511]: 修复 imaplib 模块中潜在的拒绝服务问题。当连接到恶意服务器时，可能导致分配任意数量的内存。在许多系统上，这是无害的，因为未使用的虚拟内存只是一个映射，但如果这达到了虚拟地址大小限制，可能会导致 MemoryError 或其他进程崩溃。在不寻常的系统或构建中，所有分配的内存都被触及并由实际 RAM 或存储支持，这可能会消耗资源，直到类似崩溃。

库

gh-127257 [https://github.com/python/cpython/issues/127257]: 在 ssl 中，OpenSSL 报告使用 ERR_LIB_SYS 的系统调用失败现在将作为 OSError 被引发。

文档

gh-121277 [https://github.com/python/cpython/issues/121277]: CPython文档的作者现在可以使用 next 作为 versionchanged、versionadded、``deprecated``指令的版本。

Python 3.10.16 final

发布日期: 2024-12-03

测试

gh-125041 [https://github.com/python/cpython/issues/125041]: 在s390x架构上重新启用对 zlib 的跳过测试：仅跳过压缩字节的检查，这些在zlib的软件实现和硬件加速实现之间可能不同。

gh-109396 [https://github.com/python/cpython/issues/109396]: 修复 FIPS 模式下的 test_socket.test_hmac_sha1()。使用更长的密钥：FIPS 模式要求至少 112 位。之前的密钥只有 32 位。由 Victor Stinner 提供补丁。

安全性

gh-126623 [https://github.com/python/cpython/issues/126623]: 将 libexpat 升级到 2.6.4 版本

gh-122792 [https://github.com/python/cpython/issues/122792]: 修改了IPv4映射的 ipaddress.IPv6Address，使其一致使用映射的IPv4地址值来决定属性。行为被修复的属性包括 is_multicast、is_reserved、is_link_local、is_global 和 is_unspecified。

库

gh-124651 [https://github.com/python/cpython/issues/124651]: 在 venv 激活脚本中正确引用模板字符串。

gh-103848 [https://github.com/python/cpython/issues/103848]: 添加检查以确保 urllib.parse.urlsplit() 找到的 [ 括号 ] 主机是 IPv6 或 IPvFuture 格式。

Python 3.10.15 final

Release date: 2024-09-07

Windows

gh-119690 [https://github.com/python/cpython/issues/119690]: Fixes data type confusion in audit events raised by _winapi.CreateFile and _winapi.CreateNamedPipe.

gh-116773 [https://github.com/python/cpython/issues/116773]: 修复``<_overlapped.Overlapped object at 0xXXX> still has pending operation at deallocation, the process may crash``的实例。

测试

gh-112769 [https://github.com/python/cpython/issues/112769]: 现在，当 zlib.ZLIB_RUNTIME_VERSION 包含非整数后缀时，测试正确比较 zlib 版本。例如，zlib-ng 将版本定义为 1.3.0.zlib-ng。

gh-117187 [https://github.com/python/cpython/issues/117187]: 修复对 vanilla Expat <2.6.0 的XML测试。

gh-100454 [https://github.com/python/cpython/issues/100454]: Fix SSL tests CI for OpenSSL 3.1+

安全性

gh-123678 [https://github.com/python/cpython/issues/123678]: 将libexpat升级到2.6.3版本

gh-121957 [https://github.com/python/cpython/issues/121957]: Fixed missing audit events around interactive use of Python, now also properly firing for python -i, as well as for python -m asyncio. The event in question is cpython.run_stdin.

gh-122133 [https://github.com/python/cpython/issues/122133]: 在 AF_UNIX 不可用的平台（如Windows）上，为 socket.socketpair() 后备方案验证套接字连接。

由Gregory P. Smith <greg@krypto.org> 和 Seth Larson <seth@python.org>提供补丁。由Ellie <el@horse64.org>报告。

gh-121285 [https://github.com/python/cpython/issues/121285]: 在 tarfile 头解析中移除对 hdrcharset、PAX 和 GNU 稀疏头的回溯。

gh-118486 [https://github.com/python/cpython/issues/118486]: os.mkdir() on Windows now accepts mode of 0o700 to restrict the new directory to the current user. This fixes CVE-2024-4030 affecting tempfile.mkdtemp() in scenarios where the base temporary directory is more permissive than the default.

gh-116741 [https://github.com/python/cpython/issues/116741]: 更新捆绑的 libexpat 到 2.6.2

库

gh-123693 [https://github.com/python/cpython/issues/123693]: Use platform-agnostic behavior when computing zipfile.Path.name.

gh-123270 [https://github.com/python/cpython/issues/123270]: 对 zipfile.Path 中导致无限循环的畸形负载应用了更为精确的修复（gh-122905 [https://github.com/python/cpython/issues/122905]），而不会破坏使用合法字符的内容。

gh-123067 [https://github.com/python/cpython/issues/123067]: 通过 http.cookies 修复解析带有反斜杠的 " 引号包围的 cookie 值时的二次复杂度问题。

gh-122905 [https://github.com/python/cpython/issues/122905]: zipfile.Path 对象现在会对来自 zipfile 的名称进行清理。

gh-121650 [https://github.com/python/cpython/issues/121650]: 现在，带有嵌入换行符的 email 标题在输出时会被引用。generator 现在会拒绝序列化（写入）不安全折叠或分隔的标题；参见 verify_generated_headers。（由Bas Bloemsaat和Petr Viktorin在 gh-121650 [https://github.com/python/cpython/issues/121650] 中贡献。）

gh-113171 [https://github.com/python/cpython/issues/113171]: 修复了以下属性判断中的各类误报（false positives）和漏报（false negatives）问题

ipaddress.IPv4Address.is_private (详见相关文档说明)

ipaddress.IPv4Address.is_global

ipaddress.IPv6Address.is_private

ipaddress.IPv6Address.is_global

同样适用于相应的 ipaddress.IPv4Network 和 ipaddress.IPv6Network 属性。

gh-102988 [https://github.com/python/cpython/issues/102988]: email.utils.getaddresses() and email.utils.parseaddr() now return ('', '') 2-tuples in more situations where invalid email addresses are encountered instead of potentially inaccurate values. Add optional strict parameter to these two functions: use strict=False to get the old behavior, accept malformed inputs. getattr(email.utils, 'supports_strict_parsing', False) can be use to check if the strict paramater is available. Patch by Thomas Dwyer and Victor Stinner to improve the CVE-2023-27043 fix.

gh-67693 [https://github.com/python/cpython/issues/67693]: 修复了 urllib.parse.urlunparse() 和 urllib.parse.urlunsplit() 对于路径以多个斜杠开始且没有权限的 URI 的处理。基于 Ashwin Ramaswami 的补丁。

核心与内置函数

gh-112275 [https://github.com/python/cpython/issues/112275]: A deadlock involving pystate.c's HEAD_LOCK in posixmodule.c at fork is now fixed. Patch by ChuBoning based on previous Python 3.12 fix by Victor Stinner.

Python 3.10.14 final

Release date: 2024-03-19

安全性

gh-115398 [https://github.com/python/cpython/issues/115398]: Allow controlling Expat >=2.6.0 reparse deferral (CVE-2023-52425) by adding five new methods:

xml.etree.ElementTree.XMLParser.flush()

xml.etree.ElementTree.XMLPullParser.flush()

xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()

xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()

xml.sax.expatreader.ExpatParser.flush()

gh-115399 [https://github.com/python/cpython/issues/115399]: 将捆绑的 libexpat 更新到 2.6.0

gh-114572 [https://github.com/python/cpython/issues/114572]: ssl.SSLContext.cert_store_stats() 和 ssl.SSLContext.get_ca_certs() 现在在 ssl.SSLContext 被多个线程共享时正确锁定对证书存储的访问。

gh-113659 [https://github.com/python/cpython/issues/113659]: 跳过名称以点开头或具有隐藏文件属性的 .pth 文件。

核心与内置函数

gh-102388 [https://github.com/python/cpython/issues/102388]: 修复 iso2022_jp_3 和 iso2022_jp_2004 编解码器读取越界的错误

库

gh-115197 [https://github.com/python/cpython/issues/115197]: urllib.request 在 macOS 和 Windows 上不再在检查系统代理绕过列表之前解析主机名。

gh-115133 [https://github.com/python/cpython/issues/115133]: 修复与Expat 2.6.0兼容的 XMLPullParser 测试。

gh-81194 [https://github.com/python/cpython/issues/81194]: 修复了 socket.if_indextoname() 在特定值（UINT_MAX）下的崩溃问题。修复了64位非Windows平台上 socket.if_indextoname() 的整数溢出问题。

gh-109858 [https://github.com/python/cpython/issues/109858]: 保护 zipfile 免受“引用覆盖”zip炸弹攻击。现在在尝试读取与其他条目或中央目录重叠的条目时会引发 BadZipFile。

gh-91133 [https://github.com/python/cpython/issues/91133]: 修复了 tempfile.TemporaryDirectory 清理中的一个错误，现在在解决文件系统权限错误时不再解引用符号链接。

文档

gh-115399 [https://github.com/python/cpython/issues/115399]: Document CVE-2023-52425 of Expat <2.6.0 under "XML vulnerabilities".

Windows

gh-111239 [https://github.com/python/cpython/issues/111239]: 更新 Windows 构建以使用 zlib v1.3.1。

gh-109991 [https://github.com/python/cpython/issues/109991]: Windows builds now use OpenSSL 1.1.1w. Note that OpenSSL 1.1 has reached its end of life and no future fixes will be made, and this version of Python is no longer receiving maintenance fixes and will not be updated to OpenSSL 3.0.

工具/示例

gh-109991 [https://github.com/python/cpython/issues/109991]: 更新GitHub CI工作流以使用OpenSSL 3.0.11，并使multissltests使用1.1.1w、3.0.11和3.1.3版本。

Python 3.10.13 final

Release date: 2023-08-24

安全性

gh-108310 [https://github.com/python/cpython/issues/108310]: Fixed an issue where instances of ssl.SSLSocket were vulnerable to a bypass of the TLS handshake and included protections (like certificate verification) and treating sent unencrypted data as if it were post-handshake TLS encrypted data. Security issue reported as CVE-2023-40217 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2023-40217] by Aapo Oksman. Patch by Gregory P. Smith.

库

gh-107845 [https://github.com/python/cpython/issues/107845]: tarfile.data_filter() 现在在确定符号链接的目标时会考虑其位置，因此不再会因 LinkOutsideDestinationError 拒绝一些有效的 tarball。

工具/示例

gh-107565 [https://github.com/python/cpython/issues/107565]: Update multissltests and GitHub CI workflows to use OpenSSL 1.1.1v, 3.0.10, and 3.1.2.

C API

gh-99612 [https://github.com/python/cpython/issues/99612]: 修复 PyUnicode_DecodeUTF8Stateful() 对于仅ASCII数据的问题：*consumed 未被设置。

Python 3.10.12 final

Release date: 2023-06-06

安全性

gh-103142 [https://github.com/python/cpython/issues/103142]: The version of OpenSSL used in our binary builds has been upgraded to 1.1.1u to address several CVEs.

gh-99889 [https://github.com/python/cpython/issues/99889]: Fixed a security in flaw in uu.decode() that could allow for directory traversal based on the input if no out_file was specified.

gh-104049 [https://github.com/python/cpython/issues/104049]: 在 http.client.SimpleHTTPRequestHandler 生成的目录索引中不暴露本地的磁盘位置。

gh-102153 [https://github.com/python/cpython/issues/102153]: urllib.parse.urlsplit() now strips leading C0 control and space characters following the specification for URLs defined by WHATWG in response to CVE-2023-24329. Patch by Illia Volochii.

库

gh-103935 [https://github.com/python/cpython/issues/103935]: 对要执行的文件使用 io.open_code() 而不是原始的 open()。

gh-102953 [https://github.com/python/cpython/issues/102953]: tarfile 中的提取方法，以及 shutil.unpack_archive()，新增了一个 filter 参数，允许限制可能令人惊讶或危险的tar特性，例如在目标目录之外创建文件。详情请见 解压缩过滤器。

文档

gh-89412 [https://github.com/python/cpython/issues/89412]: 为 traceback.TracebackException 类的 end_lineno 和 end_offset 属性添加缺失的文档。

构建

gh-103262 [https://github.com/python/cpython/issues/103262]: Fixes Windows installer build to work with latest compilers.

Python 3.10.11 final

发布日期：2023-04-04

安全性

gh-101727 [https://github.com/python/cpython/issues/101727]: Updated the OpenSSL version used in Windows and macOS binary release builds to 1.1.1t to address CVE-2023-0286, CVE-2022-4303, and CVE-2022-4303 per the OpenSSL 2023-02-07 security advisory [https://www.openssl.org/news/secadv/20230207.txt].

gh-101283 [https://github.com/python/cpython/issues/101283]: subprocess.Popen 现在使用更安全的方法在 shell=True 启动时查找 cmd.exe。由 Eryk Sun 基于 Oleg Iarygin 的补丁提供补丁。

核心与内置函数

gh-102416 [https://github.com/python/cpython/issues/102416]: 不记忆解析器中自动生成的错误循环规则。由 Pablo Galindo 提供补丁。

gh-102356 [https://github.com/python/cpython/issues/102356]: 修复了一个在释放深度嵌套的过滤器对象时导致崩溃的 bug。由 Marta Gómez Macías 提供补丁。

gh-102397 [https://github.com/python/cpython/issues/102397]: 修复垃圾收集过程中信号处理竞争条件导致的段错误。由 Kumar Aditya 提供补丁。

gh-102126 [https://github.com/python/cpython/issues/102126]: 修复在关闭时清除线程状态时如果任何终结器尝试获取运行时头锁导致的死锁。由Kumar Aditya提供补丁。

gh-102027 [https://github.com/python/cpython/issues/102027]: 修复 _blake2 内部模块中的SSE2和SSE3检测。由Max Bachmann提交补丁。

gh-101967 [https://github.com/python/cpython/issues/101967]: 修复在 positional_only_passed_as_keyword 函数中创建新列表时可能发生的段错误。

gh-101765 [https://github.com/python/cpython/issues/101765]: 修复在迭代 __reduce__ 中当 builtins.__dict__ 键的内部访问改变迭代对象时的SystemError / 段错误。

库

gh-102947 [https://github.com/python/cpython/issues/102947]: 当在非数据类上调用 dataclasses.fields() 时，改进回溯。由Alex Waygood提交补丁。

gh-101979 [https://github.com/python/cpython/issues/101979]: 修复了一个错误，其中 argparse.ArgumentParser.add_argument() 的 metavar 参数中的括号被丢弃。由 Yeojin Kim 提供补丁。

gh-102179 [https://github.com/python/cpython/issues/102179]: 修复 os.dup2() 对于负文件描述符的错误消息。

gh-101961 [https://github.com/python/cpython/issues/101961]: 对于二进制模式，fileinput.hookcompressed() 即使值为 None 也不设置 encoding 值。由 Gihwan Kim 提供补丁。

gh-101936 [https://github.com/python/cpython/issues/101936]: 如果 HTTPError 初始化时没有指定 fp 参数，则 fp 的默认值变为 io.BytesIO。由 Long Vo 提供补丁。

gh-101566 [https://github.com/python/cpython/issues/101566]: In zipfile, apply fix for extractall on the underlying zipfile after being wrapped in Path.

gh-101997 [https://github.com/python/cpython/issues/101997]: 升级与 ensurepip 捆绑的 pip wheel (pip 23.0.1)

gh-101892 [https://github.com/python/cpython/issues/101892]: 可调用迭代器在可调用对象耗尽迭代器但忘记返回哨兵值或引发 StopIteration 时不再引发 SystemError。

gh-97786 [https://github.com/python/cpython/issues/97786]: 修复浮点数到时间转换在极端情况下潜在的未定义行为。

gh-101517 [https://github.com/python/cpython/issues/101517]: 修复了 bdb 使用 lineno=None 与 linecache 查找源代码行时导致未处理异常失败的 bug。

gh-101673 [https://github.com/python/cpython/issues/101673]: 修复 pdb 中的一个错误，其中 ll 清除对局部变量的更改。

gh-96931 [https://github.com/python/cpython/issues/96931]: 修复了 ssl.SSLSocket.shared_ciphers() 返回不正确结果的问题。

gh-88233 [https://github.com/python/cpython/issues/88233]: 无论 "extra" 字段相对于 zip64 "extra" 的顺序如何，都能正确保留 zipfile 中的 "extra" 字段。

gh-95495 [https://github.com/python/cpython/issues/95495]: When built against OpenSSL 3.0, the ssl module had a bug where it reported unauthenticated EOFs (i.e. without close_notify) as a clean TLS-level EOF. It now raises SSLEOFError, matching the behavior in previous versions of OpenSSL. The options attribute on SSLContext also no longer includes OP_IGNORE_UNEXPECTED_EOF by default. This option may be set to specify the previous OpenSSL 3.0 behavior.

gh-94440 [https://github.com/python/cpython/issues/94440]: 修复了 concurrent.futures.process 中的一个错误，即在快速提交并取消一个 future 后，ProcessPoolExecutor 关闭可能会挂起。

文档

gh-103112 [https://github.com/python/cpython/issues/103112]: 向 http.client.HTTPResponse.read() 添加了文档字符串以修复 pydoc 输出。

gh-85417 [https://github.com/python/cpython/issues/85417]: 更新 cmath 文档以澄清分支切割的行为。

gh-97725 [https://github.com/python/cpython/issues/97725]: 修复 asyncio.Task.print_stack() 对于 file=None 的描述。由Oleg Iarygin提供补丁。

测试

gh-102980 [https://github.com/python/cpython/issues/102980]: 提高了 pdb 的测试覆盖率。

gh-102537 [https://github.com/python/cpython/issues/102537]: 调整了 test_zoneinfo.TzPathTest.python_tzpath_context 中的错误处理策略。由 Paul Ganssle 提供补丁。

gh-101377 [https://github.com/python/cpython/issues/101377]: 改进了 calendar 的 test_locale_calendar_formatweekday。

构建

gh-102711 [https://github.com/python/cpython/issues/102711]: 修复 -Wstrict-prototypes 编译器警告。

Windows

gh-101759 [https://github.com/python/cpython/issues/101759]: 更新Windows安装程序中的SQLite至3.40.1版本。

gh-101614 [https://github.com/python/cpython/issues/101614]: 正确处理引用 python3_d.dll 的调试二进制文件构建的扩展。

macOS

gh-103207 [https://github.com/python/cpython/issues/103207]: Add instructions to the macOS installer welcome display on how to workaround the macOS 13 Ventura “The installer encountered an error” failure.

gh-101759 [https://github.com/python/cpython/issues/101759]: 更新macOS安装程序中的SQLite至3.40.1版本。

gh-87235 [https://github.com/python/cpython/issues/87235]: 在macOS上 python3 /dev/fd/9 9</path/to/script.py 对于任何超过几个字节的脚本都会失败。

Python 3.10.10 final

发布日期：2023-02-07

核心与内置函数

gh-101400 [https://github.com/python/cpython/issues/101400]: Fix wrong lineno in exception message on continue or break which are not in a loop. Patch by Dong-hee Na.

gh-101372 [https://github.com/python/cpython/issues/101372]: Fix is_normalized() to properly handle the UCD 3.2.0 cases. Patch by Dong-hee Na.

gh-101046 [https://github.com/python/cpython/issues/101046]: 修复解析器在引发 MemoryError 时可能的内存泄漏。由 Pablo Galindo 提供补丁。

gh-100942 [https://github.com/python/cpython/issues/100942]: 修复了当属性子类覆盖 __new__ 方法以返回非属性实例时，在 property.getter/setter/deleter 中发生的段错误。

gh-100892 [https://github.com/python/cpython/issues/100892]: 修复在清除 threading.local 时迭代线程状态的竞争。由 Kumar Aditya 提供补丁。

gh-100776 [https://github.com/python/cpython/issues/100776]: 修正了 input() 的 __text_signature__ 中误导性的默认值。

gh-100374 [https://github.com/python/cpython/issues/100374]: 修正了 socket.getfqdn() 的错误结果和延迟。由Dominic Socular提供的补丁。

gh-100050 [https://github.com/python/cpython/issues/100050]: 在标记器中搜索不匹配的括号时，尊重现有的错误。由 Pablo Galindo 提供补丁

bpo-32782 [https://bugs.python.org/issue?@action=redirect&bpo=32782]: 从 ctypes 长度为0的数组构建 memoryview 时，现在会报告正确的itemsize，而不是总是给出0的值。

库

gh-100795 [https://github.com/python/cpython/issues/100795]: 在 socket 中避免潜在的意外 freeaddrinfo 调用（双重释放），当 libc 的 getaddrinfo() 实现在返回错误时在输出指针中留下垃圾时。原始由 Sergey G. Brester 提供补丁。

gh-101143 [https://github.com/python/cpython/issues/101143]: 在 asyncio.base_events.BaseEventLoop._add_callback 中移除对 TimerHandle 的未使用引用。

gh-101144 [https://github.com/python/cpython/issues/101144]: Make zipfile.Path.open() and zipfile.Path.read_text() also accept encoding as a positional argument. This was the behavior in Python 3.9 and earlier. Earlier 3.10 versions had a regression where supplying it as a positional argument would lead to a TypeError.

gh-100573 [https://github.com/python/cpython/issues/100573]: 修复 Windows 上 asyncio 的一个关于命名管道的 bug，其中客户端对管道执行 os.stat() 会导致服务器中禁用未来请求服务的错误。

gh-90104 [https://github.com/python/cpython/issues/90104]: 如果数据类字段定义有循环引用，则在 repr 上避免 RecursionError。

gh-100689 [https://github.com/python/cpython/issues/100689]: 通过静态分配 PyExpat_CAPI 胶囊来修复 pyexpat 中的崩溃。

gh-100740 [https://github.com/python/cpython/issues/100740]: 修复 unittest.mock.Mock 不尊重以 assert 前缀开头的属性名的规范。

gh-86508 [https://github.com/python/cpython/issues/86508]: 修复 asyncio.open_connection() 跳过绑定到不同族的本地地址。由 Kumar Aditya 提供补丁。

gh-100287 [https://github.com/python/cpython/issues/100287]: 修复了 unittest.mock.seal() 与 unittest.mock.AsyncMock 的交互问题。

gh-100474 [https://github.com/python/cpython/issues/100474]: http.server 现在在尝试提供索引页面之前会检查它是否确实是一个常规文件。这避免了名为 index.html 的目录引起的问题。

gh-100160 [https://github.com/python/cpython/issues/100160]: Remove any deprecation warnings in asyncio.get_event_loop(). They are deferred to Python 3.12.

gh-99952 [https://github.com/python/cpython/issues/99952]: 修复 ctypes.Structure 中 from_param() 结果大于 C 指针时的引用计数不足问题。

gh-98778 [https://github.com/python/cpython/issues/98778]: Update HTTPError to be initialized properly, even if the fp is None. Patch by Dong-hee Na.

gh-83035 [https://github.com/python/cpython/issues/83035]: 修复 inspect.getsource() 对带有嵌套括号的装饰器调用的处理。

gh-99240 [https://github.com/python/cpython/issues/99240]: 通过将内存清理提取到新的 post_parsing 部分来修复 Argument Clinic 的 str_converter 中的双重释放错误。

gh-85267 [https://github.com/python/cpython/issues/85267]: 对 inspect.signature() 处理 __text_signature__ 的多项改进。 - 修复了 inspect.signature() 丢弃参数的情况 - 修复了 inspect.signature() 引发 tokenize.TokenError 的情况 - 允许 inspect.signature() 理解涉及常量二元运算的默认值 - inspect.signature() 文档说明仅引发 TypeError 或 ValueError，但有时会引发 RuntimeError。这些情况现在会引发 ValueError - 移除了一个死代码路径

gh-96192 [https://github.com/python/cpython/issues/96192]: Fix handling of bytes path-like objects in os.ismount().

bpo-44817 [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)。

bpo-40447 [https://bugs.python.org/issue?@action=redirect&bpo=40447]: 在 compileall.compile_file() 和 compileall.compile_dir() 的 stripdir 参数中接受 os.PathLike (如 pathlib.Path) 。

bpo-36880 [https://bugs.python.org/issue?@action=redirect&bpo=36880]: 修复了当 ctypes 回调返回类型为 py_object 且返回 None 时的引用计数问题，该问题可能导致崩溃。

文档

gh-100616 [https://github.com/python/cpython/issues/100616]: 在 curses 模块中，为 curses.window.vline() 函数记录现有的 attr 参数。

gh-100472 [https://github.com/python/cpython/issues/100472]: 从文档中移除关于 compileall.compile_dir() 和 compileall.compile_file() 函数的 stripdir、prependdir 和 limit_sl_dest 参数可以是 bytes 类型的声明。

测试

gh-101334 [https://github.com/python/cpython/issues/101334]: test_tarfile 已更新，以便在高 UID 下运行时通过。

gh-96002 [https://github.com/python/cpython/issues/96002]: 为 Argument Clinic 添加功能测试。

构建

gh-101522 [https://github.com/python/cpython/issues/101522]: 允许使用 MSBuild 属性覆盖 Windows 依赖项的版本和路径。

Windows

gh-82052 [https://github.com/python/cpython/issues/82052]: 修复了向控制台屏幕一次性写入超过 32K Unicode 输出可能导致乱码的问题。

gh-100180 [https://github.com/python/cpython/issues/100180]: 将 Windows 安装程序更新至 OpenSSL 1.1.1s。

bpo-43984 [https://bugs.python.org/issue?@action=redirect&bpo=43984]: 现在，winreg.SetValueEx() 在转换错误的情况下会保持目标值不变。此前，此类错误会写入 -1。

macOS

gh-100180 [https://github.com/python/cpython/issues/100180]: 将 macOS 安装程序更新至 OpenSSL 1.1.1s

C API

gh-99240 [https://github.com/python/cpython/issues/99240]: 在参数解析中，释放新分配的内存后，将其指针重置为 NULL。

Python 3.10.9 final

发布日期：2022-12-06

安全性

gh-100001 [https://github.com/python/cpython/issues/100001]: python -m http.server 不再允许垃圾请求中发送的终端控制字符被打印到 stderr 服务器日志中。

This is done by changing the http.server BaseHTTPRequestHandler .log_message method to replace control characters with a \xHH hex escape before printing.

gh-87604 [https://github.com/python/cpython/issues/87604]: 避免通过 gc 模块发布每个解释器的活动审计钩子列表

gh-98433 [https://github.com/python/cpython/issues/98433]: The IDNA codec decoder used on DNS hostnames by socket or asyncio related name resolution functions no longer involves a quadratic algorithm. This prevents a potential CPU denial of service if an out-of-spec excessive length hostname involving bidirectional characters were decoded. Some protocols such as urllib http 3xx redirects potentially allow for an attacker to supply such a name.

gh-98739 [https://github.com/python/cpython/issues/98739]: 更新捆绑的 libexpat 到 2.5.0

gh-98517 [https://github.com/python/cpython/issues/98517]: Port XKCP's fix for the buffer overflows in SHA-3 (CVE-2022-37454).

gh-97514 [https://github.com/python/cpython/issues/97514]: 在Linux系统上，multiprocessing 模块恢复使用基于文件系统的Unix域套接字与 forkserver 进程通信，而不是使用Linux抽象套接字命名空间。只有选择使用 "forkserver"启动方法 的代码会受到影响。

抽象套接字没有权限设置，可能允许同一`网络命名空间 <https://man7.org/linux/man-pages/man7/network_namespaces.7.html>`_（通常是整个系统）内的任何用户向multiprocessing的 forkserver 进程注入代码。这是一个潜在的特权提升风险。基于文件系统的套接字权限将这一行为限制为 forkserver 进程的用户，这是Python 3.8及更早版本的默认行为。

This prevents Linux CVE-2022-42919 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-42919].

核心与内置函数

gh-99578 [https://github.com/python/cpython/issues/99578]: Fix a reference bug in _imp.create_builtin() after the creation of the first sub-interpreter for modules builtins and sys. Patch by Victor Stinner.

gh-99581 [https://github.com/python/cpython/issues/99581]: Fixed a bug that was causing a buffer overflow if the tokenizer copies a line missing the newline caracter from a file that is as long as the available tokenizer buffer. Patch by Pablo galindo

gh-96055 [https://github.com/python/cpython/issues/96055]: Update faulthandler to emit an error message with the proper unexpected signal number. Patch by Dong-hee Na.

gh-98852 [https://github.com/python/cpython/issues/98852]: Fix subscription of types.GenericAlias instances containing bare generic types: for example tuple[A, T][int], where A is a generic type, and T is a type variable.

gh-98415 [https://github.com/python/cpython/issues/98415]: 修复了在某些操作系统上对 uuid 的 MAC 地址检测。补丁由 Chaim Sanders 提供

gh-92119 [https://github.com/python/cpython/issues/92119]: 在从 ctypes 调用引发错误时，打印异常类名而不是其字符串表示。

gh-93696 [https://github.com/python/cpython/issues/93696]: 允许 pdb 定位标准库中冻结模块的源代码。

bpo-31718 [https://bugs.python.org/issue?@action=redirect&bpo=31718]: 当调用未初始化的 io.IncrementalNewlineDecoder 对象的方法时，抛出 ValueError 而不是 SystemError。由 Oren Milman 提供补丁。

bpo-38031 [https://bugs.python.org/issue?@action=redirect&bpo=38031]: 修复 io.FileIO 中当开启器返回无效文件描述符时可能出现的断言失败。

库

gh-100001 [https://github.com/python/cpython/issues/100001]: Also escape s in the http.server BaseHTTPRequestHandler.log_message so that it is technically possible to parse the line and reconstruct what the original data was. Without this a xHH is ambiguious as to if it is a hex replacement we put in or the characters r"x" came through in the original request line.

gh-93453 [https://github.com/python/cpython/issues/93453]: asyncio.get_event_loop() now only emits a deprecation warning when a new event loop was created implicitly. It no longer emits a deprecation warning if the current event loop was set.

gh-51524 [https://github.com/python/cpython/issues/51524]: 修复在调用 trace.CoverageResults 时使用有效的 infile 时的错误。

gh-99645 [https://github.com/python/cpython/issues/99645]: 修复 unittest.TestCase 中处理类清理时的错误。现在 addClassCleanup() 为不同的 TestCase 子类使用单独的列表，而 doClassCleanups() 只清理特定的类。

gh-97001 [https://github.com/python/cpython/issues/97001]: 在调用 termios API 时释放 GIL 以避免阻塞线程。

gh-99341 [https://github.com/python/cpython/issues/99341]: 修复 ast.increment_lineno()，使其在更改行号时也能覆盖 ast.TypeIgnore。

gh-74044 [https://github.com/python/cpython/issues/74044]: 修复了 inspect.signature() 报告装饰方法参数不正确的问题。

gh-99275 [https://github.com/python/cpython/issues/99275]: 修复 ctypes 中的 SystemError，当 __initsubclass__ 期间未设置异常时。

gh-99155 [https://github.com/python/cpython/issues/99155]: 修复 statistics.NormalDist 使用 0 和 1 协议时的 pickle 问题。

gh-99134 [https://github.com/python/cpython/issues/99134]: 将捆绑的 pip 更新到版本 22.3.1。

gh-99130 [https://github.com/python/cpython/issues/99130]: Apply bugfixes from importlib_metadata 4.11.4 [https://importlib-metadata.readthedocs.io/en/latest/history.html#v4-11-4], namely: In PathDistribution._name_from_stem, avoid including parts of the extension in the result. In PathDistribution._normalized_name, ensure names loaded from the stem of the filename are also normalized, ensuring duplicate entry points by packages varying only by non-normalized name are hidden.

gh-83004 [https://github.com/python/cpython/issues/83004]: Clean up refleak on failed module initialisation in _zoneinfo

gh-83004 [https://github.com/python/cpython/issues/83004]: Clean up refleaks on failed module initialisation in in _pickle

gh-83004 [https://github.com/python/cpython/issues/83004]: Clean up refleak on failed module initialisation in _io.

gh-98897 [https://github.com/python/cpython/issues/98897]: 修复当两个点不具有相同维度时 math.dist() 中的内存泄漏。由 Kumar Aditya 提供补丁。

gh-98793 [https://github.com/python/cpython/issues/98793]: 修复 _overlapped.WSAConnect() 和 _overlapped.Overlapped.WSASendTo() 函数中的参数类型检查。

gh-98740 [https://github.com/python/cpython/issues/98740]: 修复 re 模块中的内部错误，该错误在极少数情况下阻止编译包含 条件表达式 而没有 "else" 分支的正则表达式。

gh-98703 [https://github.com/python/cpython/issues/98703]: 修复 asyncio.StreamWriter.drain() 以在 Windows 上仅调用 protocol.connection_lost 回调一次。

gh-98624 [https://github.com/python/cpython/issues/98624]: 向 unittest.mock.NonCallableMock 添加互斥锁以保护对模拟属性的并发访问。

gh-89237 [https://github.com/python/cpython/issues/89237]: 修复了在 Windows 上使用 ProactorEventLoop 时，asyncio 中 subprocess.wait_closed() 的挂起问题。由 Kumar Aditya 提供补丁。

gh-98458 [https://github.com/python/cpython/issues/98458]: 修复 unittest 中当引发自引用链式异常时的无限循环问题

gh-97928 [https://github.com/python/cpython/issues/97928]: tkinter.Text.count() 现在会对以 "-" 开头的选项抛出异常，而不是静默忽略它们。

gh-97966 [https://github.com/python/cpython/issues/97966]: 在 uname_result 上，恢复了 _fields 和 _asdict 包括所有六个属性（包括 processor）的期望。

gh-98331 [https://github.com/python/cpython/issues/98331]: 将捆绑的 pip 和 setuptools 的副本分别更新到 22.3 和 65.5.0 版本。

gh-96035 [https://github.com/python/cpython/issues/96035]: 修复了 urllib.parse.urlparse() 中的一个错误，该错误导致某些包含空格、下划线、加号和减号或非ASCII数字的端口号被错误地接受。

gh-98251 [https://github.com/python/cpython/issues/98251]: Allow venv to pass along PYTHON* variables to ensurepip and pip when they do not impact path resolution

gh-98178 [https://github.com/python/cpython/issues/98178]: 在 macOS 上，修复 syslog.syslog() 在多线程应用程序中的崩溃问题。在 macOS 上，libc syslog() 函数不是线程安全的，因此 syslog.syslog() 不再释放 GIL 来调用它。由 Victor Stinner 提供补丁。

gh-96151 [https://github.com/python/cpython/issues/96151]: 允许 BUILTINS 作为冻结数据类的有效字段名。

gh-98086 [https://github.com/python/cpython/issues/98086]: 确保 patch.dict() 可以应用于异步函数。

gh-88863 [https://github.com/python/cpython/issues/88863]: 为了避免 asyncio.open_connection() 引发时出现明显的内存泄漏，打破由局部异常和 future 实例（其成员变量为异常实例）生成的引用循环。由 Dong Uk, Kang 提供补丁。

gh-93858 [https://github.com/python/cpython/issues/93858]: 防止在嵌套的 fish 实例中激活 venv 时出错。

bpo-46364 [https://bugs.python.org/issue?@action=redirect&bpo=46364]: 限制使用套接字而不是管道作为 asyncio 创建的子进程的标准输入，仅限于 AIX 平台。

bpo-38523 [https://bugs.python.org/issue?@action=redirect&bpo=38523]: shutil.copytree() 现在递归应用 ignore_dangling_symlinks 参数。

bpo-36267 [https://bugs.python.org/issue?@action=redirect&bpo=36267]: 修复了当 store_true 动作被赋予显式参数时，在 argparse.ArgumentParser 中出现的 IndexError。

文档

gh-92892 [https://github.com/python/cpython/issues/92892]: 文档说明在 macOS/arm64（以及其他可能的平台）上使用 ctypes 调用可变参数函数需要特别注意。

测试

gh-99892 [https://github.com/python/cpython/issues/99892]: 如果无法从 pythontest.net 下载 NormalizationTest.txt 文件，则跳过 test_unicodedata 的 test_normalization()。由 Victor Stinner 提供补丁。

bpo-34272 [https://bugs.python.org/issue?@action=redirect&bpo=34272]: 一些 C API 测试被移到了新的 Lib/test/test_capi/ 目录。

构建

gh-99086 [https://github.com/python/cpython/issues/99086]: 修复 configure 检查中的 -Wimplicit-int、-Wstrict-prototypes 和 -Wimplicit-function-declaration 编译器警告。

gh-99086 [https://github.com/python/cpython/issues/99086]: 修复了在 configure 检查 PTHREAD_SCOPE_SYSTEM 时的 -Wimplicit-int 编译器警告。

gh-97731 [https://github.com/python/cpython/issues/97731]: 为 make docclean 指定了源位置的完整路径（跨构建所需）。

gh-98671 [https://github.com/python/cpython/issues/98671]: Fix NO_MISALIGNED_ACCESSES being not defined for the SHA3 extension when HAVE_ALIGNED_REQUIRED is set. Allowing builds on hardware that unaligned memory accesses are not allowed.

Windows

gh-99345 [https://github.com/python/cpython/issues/99345]: 使用更快的初始化函数来检测Windows Store包的安装位置

gh-98689 [https://github.com/python/cpython/issues/98689]: Update Windows builds to zlib v1.2.13. v1.2.12 has CVE-2022-37434, but the vulnerable inflateGetHeader API is not used by Python.

gh-94328 [https://github.com/python/cpython/issues/94328]: 更新Windows安装程序以使用SQLite 3.39.4。

bpo-40882 [https://bugs.python.org/issue?@action=redirect&bpo=40882]: 修复Windows上 multiprocessing.shared_memory.SharedMemory 中的内存泄漏问题。

macOS

gh-94328 [https://github.com/python/cpython/issues/94328]: 更新macOS安装程序至SQLite 3.39.4。

IDLE

gh-97527 [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 从未受到影响。

工具/示例

gh-95731 [https://github.com/python/cpython/issues/95731]: 修复 Tools/i18n/pygettext.py 中模块文档字符串的处理。

Python 3.10.8 final

Release date: 2022-10-11

安全性

gh-97616 [https://github.com/python/cpython/issues/97616]: 修复列表乘以整数(list *= int)的问题：当新分配的长度接近最大大小时检测整数溢出。问题由Jordan Limor报告，由Victor Stinner提供补丁。

gh-97612 [https://github.com/python/cpython/issues/97612]: Fix a shell code injection vulnerability in the get-remote-certificate.py example script. The script no longer uses a shell to run openssl commands. Issue reported and initial fix by Caleb Shortt. Patch by Victor Stinner.

gh-68966 [https://github.com/python/cpython/issues/68966]: 已弃用的mailcap模块现在拒绝将不安全的文本（文件名、MIME类型、参数）注入到shell命令中。它将发出警告并视为未找到匹配（或对于测试命令，视为测试失败），而不是使用此类文本。

核心与内置函数

gh-96078 [https://github.com/python/cpython/issues/96078]: os.sched_yield() now release the GIL while calling sched_yield(2). Patch by Dong-hee Na.

gh-97943 [https://github.com/python/cpython/issues/97943]: Bugfix: PyFunction_GetAnnotations() should return a borrowed reference. It was returning a new reference.

gh-97591 [https://github.com/python/cpython/issues/97591]: Fixed a missing incref/decref pair in Exception.__setstate__(). Patch by Ofey Chan.

gh-96848 [https://github.com/python/cpython/issues/96848]: 修复命令行解析：当 PYTHONINTMAXSTRDIGITS 环境变量设置为有效限制时，拒绝没有值的 -X int_max_str_digits 选项（无效）。由Victor Stinner提供补丁。

gh-95921 [https://github.com/python/cpython/issues/95921]: 修复用作分支条件的链式比较的过于宽泛的源位置信息。

gh-96821 [https://github.com/python/cpython/issues/96821]: 修复 _testcapimodule.c 中的未定义行为。

gh-95778 [https://github.com/python/cpython/issues/95778]: 当整数超过限制时引发 ValueError 时，在错误消息中提到 sys.set_int_max_str_digits() 函数。由 Victor Stinner 提供补丁。

gh-96387 [https://github.com/python/cpython/issues/96387]: 在 Python 退出时，有时持有 GIL 的线程会永远等待一个（通常是守护线程）请求放弃 GIL 的线程，而该线程已经退出。为了修复这个竞态条件，请求放弃 GIL 的线程现在在退出前重置其请求。问题由 Mingliang ZHAO 发现并分析。由 Victor Stinner 提供补丁。

gh-96864 [https://github.com/python/cpython/issues/96864]: 修复当操作码跟踪启用时，行跟踪事件引发异常可能导致断言失败、致命错误或 SystemError 的问题。

gh-96678 [https://github.com/python/cpython/issues/96678]: 修复 C 代码中的空指针算术未定义行为。

gh-96641 [https://github.com/python/cpython/issues/96641]: Do not expose KeyWrapper in _functools.

gh-96611 [https://github.com/python/cpython/issues/96611]: 当在多行字符串中加载包含无效 UTF-8 的文件时，会发出正确的 SyntaxError。

gh-95196 [https://github.com/python/cpython/issues/95196]: 禁用对 C 实现的类方法描述符的错误 pickling。

gh-96352 [https://github.com/python/cpython/issues/96352]: 修复 AttributeError 在 object.__getattribute__() 中缺少 name 和 obj 属性的问题。由 Philip Georgi 提供补丁。

bpo-42316 [https://bugs.python.org/issue?@action=redirect&bpo=42316]: 记录一些需要括号的赋值表达式的地方。

库

gh-87730 [https://github.com/python/cpython/issues/87730]: 在 urllib FTP 支持中一致地包装网络错误，因此当网络可用但无法访问公共互联网时，测试套件不会失败。

gh-97825 [https://github.com/python/cpython/issues/97825]: 修复了当 subprocess.check_output() 与参数 input=None 以及 encoding 或 errors 参数一起使用时引发的 AttributeError。

gh-96827 [https://github.com/python/cpython/issues/96827]: 当默认执行器清理被延迟到事件循环关闭之后（例如，由于键盘中断的结果）时，避免来自 asyncio 的虚假回溯。

gh-97592 [https://github.com/python/cpython/issues/97592]: 当传递恶意参数时，避免 C 版本的 asyncio.Future.remove_done_callback() 崩溃。

gh-97639 [https://github.com/python/cpython/issues/97639]: 从 tabnanny 中移除 tokenize.NL 检查。

gh-97545 [https://github.com/python/cpython/issues/97545]: 使 Semaphore 运行得更快。

gh-73588 [https://github.com/python/cpython/issues/73588]: 修复 tkinter.Checkbutton 的默认名称生成。以前，如果未指定参数 "name" 和 "variable"，不同父部件中的复选框可以有相同的短名称并共享相同的状态。现在它们是全局唯一的。

gh-97005 [https://github.com/python/cpython/issues/97005]: 将捆绑的 libexpat 更新到 2.4.9

gh-85760 [https://github.com/python/cpython/issues/85760]: 修复 asyncio 中的竞争条件，其中 process_exited() 在 pipe_data_received() 之前被调用，导致输出不一致。补丁由 Kumar Aditya 提供。

gh-96819 [https://github.com/python/cpython/issues/96819]: 修复 multiprocessing.resource_tracker 中的检查，确保写入管道的长度不大于 PIPE_BUF。

gh-96741 [https://github.com/python/cpython/issues/96741]: 修正了数据类属性 pstats.FunctionProfile.ncalls 的类型注解为 str。

gh-96652 [https://github.com/python/cpython/issues/96652]: 如果 sigaction() 函数不可用，则修复 faulthandler.register(signal, chain=True) 的 faulthandler 实现：如果之前的信号处理器为 NULL，则不调用它。由 Victor Stinner 提供补丁。

gh-96073 [https://github.com/python/cpython/issues/96073]: 在 inspect 中，修复格式化注解中过度替换 "typing." 的问题。

gh-90467 [https://github.com/python/cpython/issues/90467]: 修复 asyncio.streams.StreamReaderProtocol 以保持对创建的任务的强引用，从而避免被垃圾回收。

gh-96052 [https://github.com/python/cpython/issues/96052]: 在 codeop.compile_command() 中检查不完整输入时修复处理编译器警告（SyntaxWarning 和 DeprecationWarning）的问题。以前它会发出警告并引发 SyntaxError。现在对于不完整输入，它总是返回 None，而不发出任何警告。

gh-91212 [https://github.com/python/cpython/issues/91212]: 修复当追踪器关闭时 turtle 窗口的闪烁问题。由 Shin-myoung-serp 提供补丁。

gh-74116 [https://github.com/python/cpython/issues/74116]: 允许 asyncio.StreamWriter.drain() 被多个任务并发等待。由 Kumar Aditya 提供补丁。

gh-90155 [https://github.com/python/cpython/issues/90155]: 修复当获取被取消时损坏的 asyncio.Semaphore。

gh-92986 [https://github.com/python/cpython/issues/92986]: Fix ast.unparse() when ImportFrom.level is None

gh-91539 [https://github.com/python/cpython/issues/91539]: 当有许多环境变量时，提高 urllib.request.getproxies_environment 的性能。

文档

gh-97741 [https://github.com/python/cpython/issues/97741]: 通过 conf.py 补丁修复了 c 域引用目标语法中的 !，使其按预期禁用引用目标解析。

gh-95588 [https://github.com/python/cpython/issues/95588]: 澄清了 ast 文档中关于 ast.literal_eval() 对不可信输入“安全”使用的冲突建议，同时警告它可能会崩溃进程。后一种说法是正确的，并且被认为在不适合 bugfix 的大量工作下无法修复。因此我们保留警告，不再声称 literal_eval 是安全的。

gh-93031 [https://github.com/python/cpython/issues/93031]: 更新教程介绍输出，以使用 3.10+ 的 SyntaxError 无效范围。

构建

gh-96729 [https://github.com/python/cpython/issues/96729]: 确保使用 Tools\msi\buildrelease.bat 构建的 Windows 版本可以升级到官方 Python 版本，也可以从官方 Python 版本升级。

Windows

gh-97728 [https://github.com/python/cpython/issues/97728]: 修复了在Windows上 os.system() 和Windows特定模块（如 winreg）中传递无效参数时使用未初始化变量可能导致的崩溃。

gh-90989 [https://github.com/python/cpython/issues/90989]: Clarify some text in the Windows installer.

gh-96577 [https://github.com/python/cpython/issues/96577]: Fixes a potential buffer overrun in msilib.

macOS

gh-97897 [https://github.com/python/cpython/issues/97897]: macOS 13 SDK 包含对 mkfifoat 和 mknodat 系统调用的支持。如果在使用 macOS 13 SDK 构建的 cpython 但在较早版本的 macOS 上运行时，使用 dir_fd 选项与 os.mkfifo() 或 os.mknod() 可能导致段错误。通过添加对这些系统调用的运行时支持检测（“弱链接”）来防止这种情况，就像在 macOS 上对其他更新的系统调用所做的那样。

Python 3.10.7 final

Release date: 2022-09-05

安全性

gh-95778 [https://github.com/python/cpython/issues/95778]: Converting between int and str in bases other than 2 (binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal) now raises a ValueError if the number of digits in string form is above a limit to avoid potential denial of service attacks due to the algorithmic complexity. This is a mitigation for CVE-2020-10735 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735].

This new limit can be configured or disabled by environment variable, command line flag, or sys APIs. See the integer string conversion length limitation documentation. The default limit is 4300 digits in string form.

Patch by Gregory P. Smith [Google] and Christian Heimes [Red Hat] with feedback from Victor Stinner, Thomas Wouters, Steve Dower, Ned Deily, and Mark Dickinson.

核心与内置函数

gh-96187 [https://github.com/python/cpython/issues/96187]: 修复了一个导致 _PyCode_GetExtra 对于负索引返回垃圾值的 bug。由 Pablo Galindo 提供补丁

gh-95876 [https://github.com/python/cpython/issues/95876]: 修复 _PyPegen_raise_error_known_location 中的格式字符串，该字符串在某些64位系统上可能导致内存损坏。该函数在为Py_ssize_t参数构建元组时使用了 i (int) 而不是 n (Py_ssize_t) 。

gh-95605 [https://github.com/python/cpython/issues/95605]: 修复将全空白字符串转换为 float 时错误消息内容误导性的问题。

gh-93592 [https://github.com/python/cpython/issues/93592]: coroutine.throw() now properly initializes the frame.f_back when resuming a stack of coroutines. This allows e.g. traceback.print_stack() to work correctly when an exception (such as CancelledError) is thrown into a coroutine.

gh-94996 [https://github.com/python/cpython/issues/94996]: ast.parse() 在传递的 feature_version 小于 (3, 8) 时，将不再解析带有位置唯一参数（positional-only params）的函数定义。由 Shantanu Jain 提供补丁。

库

gh-68163 [https://github.com/python/cpython/issues/68163]: 修正 numbers.Rational 到 float 的转换。

gh-96159 [https://github.com/python/cpython/issues/96159]: 修复日志 TimedRotatingFileHandler 中的性能回归问题。仅在滚动时间过去时检查特殊文件。

gh-96175 [https://github.com/python/cpython/issues/96175]: 修复 xml.dom.minidom 中 Attr 类未使用的 localName 参数。

gh-95609 [https://github.com/python/cpython/issues/95609]: 更新捆绑的 pip 到 22.2.2 版本。

gh-95231 [https://github.com/python/cpython/issues/95231]: Fail gracefully if EPERM or ENOSYS is raised when loading crypt methods. This may happen when trying to load MD5 on a Linux kernel with FIPS enabled.

文档

gh-96098 [https://github.com/python/cpython/issues/96098]: 通过从较低级别的 threading 和 multiprocessing 模块提供更清晰的链接，提高了较高层次 concurrent.futures 模块的可发现性。

gh-95789 [https://github.com/python/cpython/issues/95789]: Update the default RFC base URL from deprecated tools.ietf.org to datatracker.ietf.org

gh-91207 [https://github.com/python/cpython/issues/91207]: Fix stylesheet not working in Windows CHM htmlhelp docs. Contributed by C.A.M. Gerlach.

bpo-47115 [https://bugs.python.org/issue?@action=redirect&bpo=47115]: 文档现在列出了C结构体的哪些成员是 Limited API/Stable ABI 的一部分。

测试

gh-95243 [https://github.com/python/cpython/issues/95243]: 通过在失败前尝试多次找到未使用的端口，缓解了在 testSockName() 中使用 find_unused_port() 固有的竞态条件。由 Ross Burton 提供补丁。

构建

gh-94682 [https://github.com/python/cpython/issues/94682]: 使用 OpenSSL 1.1.1q 进行构建和测试

IDLE

gh-65802 [https://github.com/python/cpython/issues/65802]: 记录在另存为对话框中处理扩展名的方法。

gh-95191 [https://github.com/python/cpython/issues/95191]: 保存 Shell（交互式输入和输出）时包括提示。

Python 3.10.6 final

Release date: 2022-08-01

安全性

gh-87389 [https://github.com/python/cpython/issues/87389]: http.server: 修复了HTTP服务器中当URI路径以 // 开头时的开放重定向漏洞。漏洞由Hamza Avvan发现并提出了初步修复方案。

gh-92888 [https://github.com/python/cpython/issues/92888]: 修复了在某些情况下访问底层缓冲区时的 memoryview 释放后使用问题。

核心与内置函数

gh-95355 [https://github.com/python/cpython/issues/95355]: _PyPegen_Parser_New 现在能正确检测令牌内存分配错误。补丁由Honglin Zhu提供。

gh-94938 [https://github.com/python/cpython/issues/94938]: 修复当关键字参数名称是重载了 __eq__ 和 __hash__ 的 str 子类实例时，某些内置函数中的错误检测。之前这可能导致 SystemError 或其他不希望的行为。

gh-94949 [https://github.com/python/cpython/issues/94949]: ast.parse() 在传递的 feature_version 小于 (3, 9) 时，将不再解析带括号的上下文管理器。由 Shantanu Jain 提供补丁。

gh-94947 [https://github.com/python/cpython/issues/94947]: ast.parse() 在传递的 feature_version 小于 (3, 8) 时，将不再解析赋值表达式。由 Shantanu Jain 提供补丁。

gh-94869 [https://github.com/python/cpython/issues/94869]: 修复多行 f-字符串 ast 节点中某些表达式的列偏移。由 Pablo Galindo 提供补丁。

gh-91153 [https://github.com/python/cpython/issues/91153]: 修复 bytearray 项赋值在通过新值的 __index__() 方法调整大小时可能崩溃的问题。

gh-94329 [https://github.com/python/cpython/issues/94329]: 编译并运行具有极大序列（1000多个元素）解包的代码。此类代码之前无法编译。现在可以正确编译并运行。

gh-94360 [https://github.com/python/cpython/issues/94360]: 修复了当从 stdin 读取带有语法错误的非utf-8编码文本文件时，分词器崩溃的问题。由Pablo Galindo提供补丁。

gh-94192 [https://github.com/python/cpython/issues/94192]: 修复了字典字面量中值表达式无效时的错误。

gh-93964 [https://github.com/python/cpython/issues/93964]: Strengthened compiler overflow checks to prevent crashes when compiling very large source files.

gh-93671 [https://github.com/python/cpython/issues/93671]: 修复在匹配语句中深度嵌套序列模式时发生的一些指数回溯情况。由 Pablo Galindo 提供补丁。

gh-93021 [https://github.com/python/cpython/issues/93021]: 修复了在 C 中实现的 __get__() 方法的 __text_signature__。补丁由 Jelle Zijlstra 提供。

gh-92930 [https://github.com/python/cpython/issues/92930]: 修复了在 __reduce__ 或 persistent_id 期间修改集合导致的 _pickle.c 崩溃。

gh-92914 [https://github.com/python/cpython/issues/92914]: 总是将列表的分配大小向上舍入到最近的偶数。

gh-92858 [https://github.com/python/cpython/issues/92858]: 改进在 ':' 之前有语法错误的某些套件的错误消息。

库

gh-95339 [https://github.com/python/cpython/issues/95339]: 更新捆绑的 pip 到 22.2.1。

gh-95045 [https://github.com/python/cpython/issues/95045]: 通过在调用任何回调之前取消跟踪，修复在释放 _lsprof.Profiler 时的 GC 崩溃。由 Kumar Aditya 提供补丁。

gh-95087 [https://github.com/python/cpython/issues/95087]: 修复 email 模块中解析无效日期时的 IndexError。

gh-95199 [https://github.com/python/cpython/issues/95199]: 更新捆绑的 setuptools 到 63.2.0。

gh-95194 [https://github.com/python/cpython/issues/95194]: 更新捆绑的 pip 到 22.2。

gh-93899 [https://github.com/python/cpython/issues/93899]: Fix check for existence of os.EFD_CLOEXEC, os.EFD_NONBLOCK and os.EFD_SEMAPHORE flags on older kernel versions where these flags are not present. Patch by Kumar Aditya.

gh-95166 [https://github.com/python/cpython/issues/95166]: 修复 concurrent.futures.Executor.map()，使其在错误（例如 TimeoutError 或 KeyboardInterrupt）时取消当前等待的 future。

gh-93157 [https://github.com/python/cpython/issues/93157]: 修复 fileinput 模块在 inplace 为 true 时不支持 errors 选项的问题。

gh-94821 [https://github.com/python/cpython/issues/94821]: 修复 Linux 上 Unix 套接字绑定到空地址时使用抽象命名空间中的可用地址，而不是 "0"。

gh-94736 [https://github.com/python/cpython/issues/94736]: 修复在释放 _multiprocessing.SemLock 子类实例时的崩溃问题。由 Kumar Aditya 提供补丁。

gh-94637 [https://github.com/python/cpython/issues/94637]: SSLContext.set_default_verify_paths() 现在在 SSL_CTX_set_default_verify_paths 调用周围释放 GIL。该函数调用执行 I/O 和 CPU 密集型工作。

gh-94510 [https://github.com/python/cpython/issues/94510]: 对 sys.setprofile() 和 sys.settrace() 的重新进入调用现在会引发 RuntimeError。由 Pablo Galindo 提供补丁。

gh-92336 [https://github.com/python/cpython/issues/92336]: 修复了 linecache.getline() 在坏文件上因 UnicodeDecodeError 或 SyntaxError 而失败的错误。根据文档，现在它返回一个空字符串。

gh-89988 [https://github.com/python/cpython/issues/89988]: 修复 pickle.Pickler 在查找 dispatch_table 时的内存泄漏。补丁由 Kumar Aditya 提供。

gh-94254 [https://github.com/python/cpython/issues/94254]: 修正 struct 模块的类型为不可变。由 Kumar Aditya 提供补丁。

gh-94245 [https://github.com/python/cpython/issues/94245]: Fix pickling and copying of typing.Tuple[()].

gh-94207 [https://github.com/python/cpython/issues/94207]: Made _struct.Struct GC-tracked in order to fix a reference leak in the _struct module.

gh-94101 [https://github.com/python/cpython/issues/94101]: 不再允许手动实例化 ssl.SSLSession 对象，因为这会导致配置错误的实例，在访问其属性时解释器崩溃。

gh-84753 [https://github.com/python/cpython/issues/84753]: inspect.iscoroutinefunction()、inspect.isgeneratorfunction() 和 inspect.isasyncgenfunction() 现在能正确地为鸭子类型的函数式对象（如 unittest.mock.AsyncMock 的实例）返回 True。

这使得 inspect.iscoroutinefunction() 的行为与 asyncio.iscoroutinefunction() 保持一致。由 Mehdi ABAAKOUK 提供补丁。

gh-83499 [https://github.com/python/cpython/issues/83499]: 修复 tempfile 中文件描述符的双重关闭问题。

gh-79512 [https://github.com/python/cpython/issues/79512]: 修复了 weakref 模块中 ReferenceType、ProxyType、CallableProxyType 类的名称和 __module__ 值，使它们可以被 pickle。

gh-90494 [https://github.com/python/cpython/issues/90494]: 如果 __reduce__() 返回长度为6的元组，copy.copy() 和 copy.deepcopy() 现在总是会引发 TypeError，而不是静默忽略第6项或产生不正确的结果。

gh-90549 [https://github.com/python/cpython/issues/90549]: 修复了一个多进程错误，其中在创建子进程（与 fork 相对）时，全局命名资源（如信号量）可能会泄漏。

gh-79579 [https://github.com/python/cpython/issues/79579]: sqlite3 现在能正确检测带有前导注释的 DML 查询。由 Erlend E. Aasland 提供补丁。

gh-93421 [https://github.com/python/cpython/issues/93421]: 当 DML 语句运行完成时更新 sqlite3.Cursor.rowcount。这修复了像 UPDATE ... RETURNING 这样的 SQL 查询的行计数。由 Erlend E. Aasland 提供补丁。

gh-91810 [https://github.com/python/cpython/issues/91810]: 在使用 encoding='unicode' 和 xml_declaration=None 的 ElementTree.write() 中，抑制在打开的文件中写入 XML 声明。

gh-93353 [https://github.com/python/cpython/issues/93353]: 修复 importlib.resources.as_file() 上下文管理器，在Python最终化过程中如果被延迟销毁则删除临时文件：保留对 os.remove() 函数的本地引用。由 Victor Stinner 提供补丁。

gh-83658 [https://github.com/python/cpython/issues/83658]: 如果 maxtasksperchild 不是 None 或正整数，则使 multiprocessing.Pool 抛出异常。

gh-74696 [https://github.com/python/cpython/issues/74696]: shutil.make_archive() 在创建标准 .zip 或 tar 归档文件时不再临时更改当前工作目录。

gh-91577 [https://github.com/python/cpython/issues/91577]: 将 SharedMemory 方法中的导入移动到模块级别，以便它们可以在Python终止的后期执行。

bpo-47231 [https://bugs.python.org/issue?@action=redirect&bpo=47231]: 修复了tarfile长名字目录中不一致的尾部斜杠问题。

bpo-46755 [https://bugs.python.org/issue?@action=redirect&bpo=46755]: 在 QueueHandler 中，清除 LogRecord 中的 stack_info 以防止堆栈跟踪被写入两次。

bpo-46053 [https://bugs.python.org/issue?@action=redirect&bpo=46053]: 修复 NetBSD 上的 OSS 音频支持。

bpo-46197 [https://bugs.python.org/issue?@action=redirect&bpo=46197]: 修复了 ensurepip 对运行 pip 的子进程的环境隔离。

bpo-45924 [https://bugs.python.org/issue?@action=redirect&bpo=45924]: 修复了 asyncio 在多次引发 future 的异常时的错误回溯。由 Kumar Aditya 提供补丁。

bpo-34828 [https://bugs.python.org/issue?@action=redirect&bpo=34828]: sqlite3.Connection.iterdump() 现在可以处理在一个或多个表中使用 AUTOINCREMENT 的数据库。

文档

gh-94321 [https://github.com/python/cpython/issues/94321]: 文档化 PEP 246 [https://www.python.org/dev/peps/pep-0246] 风格的协议类型 sqlite3.PrepareProtocol。

gh-86128 [https://github.com/python/cpython/issues/86128]: 文档化 ThreadPoolExecutor 中的一个限制，即其退出处理程序在任何 atexit 处理程序之前执行。

gh-61162 [https://github.com/python/cpython/issues/61162]: 澄清 sqlite3 在 如何使用连接上下文管理器 时的行为。

gh-87260 [https://github.com/python/cpython/issues/87260]: 将 sqlite3 的参数规范与实际实现对齐。

gh-86986 [https://github.com/python/cpython/issues/86986]: 构建文档所需的最低 Sphinx 版本现在是 3.2。

gh-88831 [https://github.com/python/cpython/issues/88831]: 增加了 asyncio.create_task() 的文档。明确了需要保持对任务的强引用，并添加了一个代码片段详细说明如何做到这一点。

bpo-47161 [https://bugs.python.org/issue?@action=redirect&bpo=47161]: 文档说明 pathlib.PurePath 不会合并开头的双斜杠，因为它们表示 UNC 路径。

测试

gh-95280 [https://github.com/python/cpython/issues/95280]: 修复了在需要完美前向保密（PFS）密码的系统上 test_ssl test_get_ciphers 的问题。

gh-95212 [https://github.com/python/cpython/issues/95212]: 使多进程测试用例 test_shared_memory_recreate 并行安全。

gh-91330 [https://github.com/python/cpython/issues/91330]: 为 dataclasses 添加了更多测试，以覆盖基于数据描述符的字段的行为。

gh-94208 [https://github.com/python/cpython/issues/94208]: test_ssl 现在在更多测试中检查支持的 TLS 版本和协议。

gh-93951 [https://github.com/python/cpython/issues/93951]: 在 test_bdb.StateTestCase.test_skip 中，避免包括辅助导入器。

gh-93957 [https://github.com/python/cpython/issues/93957]: 在 test_venv.EnsurePipTest.test_with_pip 中提供来自子进程的更友好的错误报告。

gh-57539 [https://github.com/python/cpython/issues/57539]: 增加 calendar.LocaleTextCalendar.formatweekday() 的日历测试覆盖率。

gh-92886 [https://github.com/python/cpython/issues/92886]: 修复在 test_zipimport.py 中使用优化 (-O) 运行时失败的测试。

bpo-47016 [https://bugs.python.org/issue?@action=redirect&bpo=47016]: 创建一个 GitHub Actions 工作流用于验证捆绑的 pip 和 setuptools。由 Illia Volochii 和 Adam Turner 提供补丁。

构建

gh-94841 [https://github.com/python/cpython/issues/94841]: 修复了使用 MSVC 版本 1932 编译的 PyObject_Free() 可能的性能回归。

bpo-45816 [https://bugs.python.org/issue?@action=redirect&bpo=45816]: Python 现在支持使用 Visual Studio 2022 (MSVC v143, VS 版本 17.0) 构建。补丁由 Jeremiah Vivian 提供。

Windows

gh-90844 [https://github.com/python/cpython/issues/90844]: 允许虚拟环境在路径中有空格时正确启动。

gh-92841 [https://github.com/python/cpython/issues/92841]: asyncio 在异步套接字活动后解释器退出时不再抛出 RuntimeError: Event loop is closed。由 Oleg Iarygin 提供补丁。

bpo-42658 [https://bugs.python.org/issue?@action=redirect&bpo=42658]: Support native Windows case-insensitive path comparisons by using LCMapStringEx instead of str.lower() in ntpath.normcase(). Add LCMapStringEx to the _winapi module.

IDLE

gh-95511 [https://github.com/python/cpython/issues/95511]: 修复 Shell 上下文菜单复制带提示的 bug，即当选择整行时会复制额外的行。

gh-95471 [https://github.com/python/cpython/issues/95471]: 在编辑菜单中，移动 Select All 并添加一个新的分隔符。

gh-95411 [https://github.com/python/cpython/issues/95411]: 启用IDLE的模块浏览器以支持.pyw文件。

gh-89610 [https://github.com/python/cpython/issues/89610]: 在macOS上为IDLE添加.pyi作为已识别的扩展名。这允许通过双击Finder中的存根文件来打开它们。

工具/示例

gh-94538 [https://github.com/python/cpython/issues/94538]: 修复Argument Clinic输出到自定义文件目的地的问题。补丁由Erlend E. Aasland提供。

gh-94430 [https://github.com/python/cpython/issues/94430]: 允许在Argument Clinic中使用名为 module 和 self 的参数，并带有自定义C名称。由Erlend E. Aasland提供补丁。

C API

gh-94930 [https://github.com/python/cpython/issues/94930]: 修复了当 PyArg_ParseTupleAndKeywords() 与 # 在 (...) 中一起使用但未定义 PY_SSIZE_T_CLEAN 时引发的 SystemError。

gh-94864 [https://github.com/python/cpython/issues/94864]: Fix PyArg_Parse* with deprecated format units "u" and "Z". It returned 1 (success) when warnings are turned into exceptions.

Python 3.10.5 final

Release date: 2022-06-06

核心与内置函数

gh-93418 [https://github.com/python/cpython/issues/93418]: 修复了一个断言错误，其中 f-string 在表达式后有一个等号 '='，但没有尾随的大括号。例如，f"{i="。

gh-91924 [https://github.com/python/cpython/issues/91924]: Fix __ltrace__ debug feature if the stdout encoding is not UTF-8. Patch by Victor Stinner.

gh-93061 [https://github.com/python/cpython/issues/93061]: async for 循环后的向后跳转不再赋予可疑的行号。

gh-93065 [https://github.com/python/cpython/issues/93065]: 修复了 contextvars HAMT 实现以处理对深树的迭代。

该错误由 Eli Libman 发现并修复。更多详情请见 MagicStack/immutables#84 [https://github.com/MagicStack/immutables/issues/84]。

gh-92311 [https://github.com/python/cpython/issues/92311]: Fixed a bug where setting frame.f_lineno to jump over a list comprehension could misbehave or crash.

gh-92112 [https://github.com/python/cpython/issues/92112]: 修复由元类上的恶意自定义 mro() 触发的崩溃。

gh-92036 [https://github.com/python/cpython/issues/92036]: 修复了与垃圾收集器相关的子解释器崩溃问题。当删除子解释器时，取消跟踪其垃圾收集器跟踪的所有对象。为了防止在期望对象被垃圾收集器跟踪的析构函数中崩溃，有意泄露这些对象的强引用，这样它们就永远不会被删除，它们的析构函数也不会被调用。由Victor Stinner提供补丁。

gh-91421 [https://github.com/python/cpython/issues/91421]: 修复了 _Py_DecodeUTF8Ex 中潜在的整数溢出问题。

bpo-47212 [https://bugs.python.org/issue?@action=redirect&bpo=47212]: 对于没有后续缩进的裸 except，抛出 IndentationError 而不是 SyntaxError。对于用作参数的无括号生成器，改进 SyntaxError 的位置。由 Matthieu Dartiailh 提供补丁。

bpo-47182 [https://bugs.python.org/issue?@action=redirect&bpo=47182]: 修复在主解释器第二次初始化后使用命名Unicode字符如 "\N{digit nine}" 时崩溃的问题。

bpo-46775 [https://bugs.python.org/issue?@action=redirect&bpo=46775]: Some Windows system error codes(>= 10000) are now mapped into the correct errno and may now raise a subclass of OSError. Patch by Dong-hee Na.

bpo-47117 [https://bugs.python.org/issue?@action=redirect&bpo=47117]: 修复在交互模式下如果分词器缓冲区未初始化时解码字符失败导致的崩溃。由Pablo Galindo提供补丁。

bpo-39829 [https://bugs.python.org/issue?@action=redirect&bpo=39829]: 移除了初始化列表时的 __len__() 调用，并将初始化移至 list_extend。由 Jeremiah Pascual 提供补丁。

bpo-46962 [https://bugs.python.org/issue?@action=redirect&bpo=46962]: Classes and functions that unconditionally declared their docstrings ignoring the --without-doc-strings compilation flag no longer do so.

受影响的类有 ctypes.UnionType、pickle.PickleBuffer、testcapi.RecursingInfinitelyError 和 types.GenericAlias。

受影响的函数是 ctypes 中的24个方法。

由 Oleg Iarygin 提供补丁。

bpo-36819 [https://bugs.python.org/issue?@action=redirect&bpo=36819]: 修复内置编码器中错误处理程序返回的位置小于或等于不可编码字符起始位置时的崩溃问题。

库

gh-93156 [https://github.com/python/cpython/issues/93156]: 使用负索引值访问绝对路径的 pathlib.PurePath.parents 序列会产生不正确的结果。

gh-89973 [https://github.com/python/cpython/issues/89973]: 修复了如果在模式中包含上限低于下限的字符范围（例如 [c-a]）时 fnmatch 中引发的 re.error。现在这样的范围被解释为空范围。

gh-93010 [https://github.com/python/cpython/issues/93010]: 在一种非常特殊的情况下，email 包尝试将不存在的 InvalidHeaderError 添加到缺陷列表中。应该是 InvalidHeaderDefect。

gh-92839 [https://github.com/python/cpython/issues/92839]: Fixed crash resulting from calling bisect.insort() or bisect.insort_left() with the key argument not equal to None.

gh-91581 [https://github.com/python/cpython/issues/91581]: utcfromtimestamp() 在纯Python实现中不再尝试解析 fold，因为在UTC中fold永远不会是1。除了在常见情况下稍微快一些之外，这还防止了当时间戳接近 datetime.min 时的一些错误。由Paul Ganssle提供补丁。

gh-92530 [https://github.com/python/cpython/issues/92530]: 修复了在中断 threading.Condition.notify() 后出现的问题。

gh-92049 [https://github.com/python/cpython/issues/92049]: 禁止pickling常量 re._constants.SUCCESS 等。之前，pickling不会失败，但结果无法被unpickle。

bpo-47029 [https://bugs.python.org/issue?@action=redirect&bpo=47029]: 在向管道的写入端最后一次写入缓冲数据*之后*，始终关闭 multiprocessing.Queue 使用的管道的读取端，以避免在垃圾回收和调用 multiprocessing.Queue.close() 时出现 BrokenPipeError。补丁由 Géry Ogam 提供。

gh-91401 [https://github.com/python/cpython/issues/91401]: Provide a fail-safe way to disable subprocess use of vfork() via a private subprocess._USE_VFORK attribute. While there is currently no known need for this, if you find a need please only set it to False. File a CPython issue as to why you needed it and link to that from a comment in your code. This attribute is documented as a footnote in 3.11.

gh-91910 [https://github.com/python/cpython/issues/91910]: 在 multiprocessing 和 asyncio 模块的错误消息中，为 f-字符串添加缺失的 f 前缀。

gh-91810 [https://github.com/python/cpython/issues/91810]: ElementTree 方法 write() 和函数 tostring() 现在在指定 encoding="unicode" 时使用文本文件的编码（如果不可用则为 "UTF-8"）而不是 XML 声明中的区域设置编码。

gh-91832 [https://github.com/python/cpython/issues/91832]: 在 argparse.Action 的 repr 输出中添加 required 属性。

gh-91734 [https://github.com/python/cpython/issues/91734]: 修复Solaris上的OSS音频支持。

gh-91700 [https://github.com/python/cpython/issues/91700]: 现在，包含条件表达式 (?(group)...) 的正则表达式的编译，如果组号引用未定义的组，将引发适当的 re.error。之前会引发内部RuntimeError。

gh-91676 [https://github.com/python/cpython/issues/91676]: Fix unittest.IsolatedAsyncioTestCase to shutdown the per test event loop executor before returning from its run method so that a not yet stopped or garbage collected executor state does not persist beyond the test.

gh-90568 [https://github.com/python/cpython/issues/90568]: 在 regular expression 中解析Unicode命名字符序列的 \N 转义现在会引发 re.error 而不是 TypeError。

gh-91595 [https://github.com/python/cpython/issues/91595]: 修复 Tools.gdb.libpython.write_repr() 中字符和整数的比较。由 Yu Liu 提交的补丁。

gh-90622 [https://github.com/python/cpython/issues/90622]: 当多进程上下文启动方法为 ``"fork"``时，concurrent.futures.ProcessPoolExecutor 的工作进程不再按需生成（这是3.9版本中添加的特性），因为这可能会导致子进程中的死锁，因为在线程运行时发生了fork。

gh-91575 [https://github.com/python/cpython/issues/91575]: 将 re 模块中的大小写不敏感匹配更新至最新的 Unicode 版本。

gh-91581 [https://github.com/python/cpython/issues/91581]: 移除了在调用没有时区的 datetime.fromtimestamp 的C实现中未处理的错误情况（即从epoch时间戳获取本地时间）。这除了在调用落在本地时间10000-01-01的时间戳时可能给出更准确的错误消息外，应该不会对用户产生影响。由Paul Ganssle提供补丁。

bpo-47260 [https://bugs.python.org/issue?@action=redirect&bpo=47260]: 修复 os.closerange() 在 Linux seccomp 沙箱中可能不执行任何操作的问题。

bpo-39064 [https://bugs.python.org/issue?@action=redirect&bpo=39064]: zipfile.ZipFile 现在在读取损坏的 zip 文件时，如果中央目录偏移为负，会引发 zipfile.BadZipFile 而不是 ValueError。

bpo-47151 [https://bugs.python.org/issue?@action=redirect&bpo=47151]: 当子进程尝试使用vfork时，如果vfork返回错误，现在会回退到fork。这允许在操作系统内核不允许vfork的情况下使用。

bpo-27929 [https://bugs.python.org/issue?@action=redirect&bpo=27929]: 修复 asyncio.loop.sock_connect() 仅解析 socket.AF_INET 或 socket.AF_INET6 家族的名称。对于其他家族，如 socket.AF_BLUETOOTH 和 socket.AF_UNIX，解析可能没有意义。

bpo-43323 [https://bugs.python.org/issue?@action=redirect&bpo=43323]: 修复 email 模块中如果字符集本身包含不可解码/不可编码字符时的错误。

bpo-47101 [https://bugs.python.org/issue?@action=redirect&bpo=47101]: hashlib.algorithms_available 现在仅列出由OpenSSL 3.0上激活的加密提供者提供的算法。除非将遗留提供者加载到默认的OSSL上下文中，否则不会列出遗留算法。

bpo-46787 [https://bugs.python.org/issue?@action=redirect&bpo=46787]: 修复 concurrent.futures.ProcessPoolExecutor 异常内存泄漏

bpo-45393 [https://bugs.python.org/issue?@action=redirect&bpo=45393]: 在使用 help() 系统时，修复了操作符优先级表中 await x 和 not x 的格式化。

bpo-46415 [https://bugs.python.org/issue?@action=redirect&bpo=46415]: 修复 ipaddress.ip_{address,interface,network} 在给定无效元组作为地址参数时抛出 TypeError 而不是 ValueError 的问题。

bpo-28249 [https://bugs.python.org/issue?@action=redirect&bpo=28249]: Set doctest.DocTest.lineno to None when object does not have __doc__.

bpo-45138 [https://bugs.python.org/issue?@action=redirect&bpo=45138]: 修复 sqlite3 跟踪回调中的一处回归问题，其中绑定参数未在传递的语句字符串中展开。此回归问题由 Python 3.10 中的 bpo-40318 [https://bugs.python.org/issue?@action=redirect&bpo=40318] 引入。补丁由 Erlend E. Aasland 提供。

bpo-44493 [https://bugs.python.org/issue?@action=redirect&bpo=44493]: 在 sockaddr_un 的长度中添加缺失的终止 NUL。

当使用非抽象的 AF_UNIX 数据报套接字与用另一种编程语言编写的进程通信时，这个问题可能被观察到。

bpo-42627 [https://bugs.python.org/issue?@action=redirect&bpo=42627]: 修复了 Windows 注册表代理设置的错误解析。

bpo-36073 [https://bugs.python.org/issue?@action=redirect&bpo=36073]: 在 sqlite3 转换器中递归使用游标时，引发 ProgrammingError 而不是段错误。由 Sergey Fedoseev 提供补丁。

文档

gh-86438 [https://github.com/python/cpython/issues/86438]: 澄清了在 warnings 中，-W 和 PYTHONWARNINGS 是字面匹配且不区分大小写的，而不是作为正则表达式匹配。

gh-92240 [https://github.com/python/cpython/issues/92240]: 为 "Python 3.X 中的新特性" 添加了 3.0、3.1、3.2、3.8 和 3.10 版本的发布日期。

gh-91888 [https://github.com/python/cpython/issues/91888]: 向文档添加一个新的 gh 角色，以链接到 GitHub 问题。

gh-91783 [https://github.com/python/cpython/issues/91783]: 记录关于使用函数 shutil.unpack_archive() 的安全问题。

gh-91547 [https://github.com/python/cpython/issues/91547]: 移除“未记录模块”页面。

bpo-44347 [https://bugs.python.org/issue?@action=redirect&bpo=44347]: 澄清了 dirs_exist_ok 的含义，这是 shutil.copytree() 的一个关键字参数。

bpo-38668 [https://bugs.python.org/issue?@action=redirect&bpo=38668]: 更新 os.path 文档的引言，移除在实现了 PEP 383 [https://www.python.org/dev/peps/pep-0383] 和 PEP 529 [https://www.python.org/dev/peps/pep-0529] 后变得无关紧要的警告。

bpo-47138 [https://bugs.python.org/issue?@action=redirect&bpo=47138]: Pin Jinja to a version compatible with Sphinx version 3.2.1.

bpo-46962 [https://bugs.python.org/issue?@action=redirect&bpo=46962]: All docstrings in code snippets are now wrapped into PyDoc_STR() to follow the guideline of PEP 7's Documentation Strings paragraph [https://www.python.org/dev/peps/pep-0007/#documentation-strings]. Patch by Oleg Iarygin.

bpo-26792 [https://bugs.python.org/issue?@action=redirect&bpo=26792]: 改进 runpy.run_module() 和 runpy.run_path() 的文档字符串。原始补丁由Andrew Brezovsky提供。

bpo-40838 [https://bugs.python.org/issue?@action=redirect&bpo=40838]: 文档说明 inspect.getdoc()、inspect.getmodule() 和 inspect.getsourcefile() 可能会返回 None。

bpo-45790 [https://bugs.python.org/issue?@action=redirect&bpo=45790]: 调整 自定义扩展类型：教程 中关于 ob_base 字段和用于访问其内容的宏的不准确措辞。

bpo-42340 [https://bugs.python.org/issue?@action=redirect&bpo=42340]: 记录在某些情况下 KeyboardInterrupt 可能导致代码进入不一致状态。如果需要，提供了一个示例解决方法以避免这种情况。

bpo-41233 [https://bugs.python.org/issue?@action=redirect&bpo=41233]: 将 Doc/library/exceptions.rst 中引用的 errnos 链接到它们在 Doc/library/errno.rst 中的相应部分，反之亦然。之前这仅对 EINTR 和 InterruptedError 进行了操作。由 Yan "yyyyyyyan" Orestes 提供补丁。

bpo-38056 [https://bugs.python.org/issue?@action=redirect&bpo=38056]: 全面修改了 codecs 中的 错误处理方案 文档。

bpo-13553 [https://bugs.python.org/issue?@action=redirect&bpo=13553]: 文档说明 tkinter.Tk 的参数。

测试

gh-92886 [https://github.com/python/cpython/issues/92886]: 修复在 test_imaplib.py 中使用优化 (-O) 运行时失败的测试。

gh-92670 [https://github.com/python/cpython/issues/92670]: 在 AIX 上跳过 test_shutil.TestCopy.test_copyfile_nonexistent_dir 测试，因为测试使用尾部斜杠强制操作系统将路径视为目录，但在 AIX 上尾部斜杠没有效果，被视为文件。

gh-91904 [https://github.com/python/cpython/issues/91904]: 修复 PYTHONREGRTEST_UNICODE_GUARD 的初始化，该问题阻止了在非UTF-8语言环境下运行回归测试。

gh-91607 [https://github.com/python/cpython/issues/91607]: 修复 test_concurrent_futures，在测试逻辑混淆的情况下测试正确的多进程启动方法上下文。

bpo-47205 [https://bugs.python.org/issue?@action=redirect&bpo=47205]: 在 FreeBSD 上跳过 sched_getaffinity() 和 sched_setaffinity() 错误情况的测试。

bpo-47104 [https://bugs.python.org/issue?@action=redirect&bpo=47104]: 重写 asyncio.to_thread() 测试以使用 unittest.IsolatedAsyncioTestCase。

bpo-29890 [https://bugs.python.org/issue?@action=redirect&bpo=29890]: 为 ipaddress.IPv4Interface 和 ipaddress.IPv6Interface 添加了使用元组参数构造的测试。原始补丁和测试由louisom提供。

构建

bpo-47103 [https://bugs.python.org/issue?@action=redirect&bpo=47103]: Windows PGInstrument 构建现在会将一个必需的 DLL 复制到输出目录，使得运行 PGO 构建的分析阶段更加容易。

Windows

gh-92984 [https://github.com/python/cpython/issues/92984]: 明确为非调试构建禁用增量链接

bpo-47194 [https://bugs.python.org/issue?@action=redirect&bpo=47194]: Update zlib to v1.2.12 to resolve CVE-2018-25032.

bpo-46785 [https://bugs.python.org/issue?@action=redirect&bpo=46785]: 通过适当在 win32_xstat_impl 中使用 FindFirstFileW() 返回的错误代码，修复了 Windows 上 os.stat() 和取消链接文件之间的竞态条件。

bpo-40859 [https://bugs.python.org/issue?@action=redirect&bpo=40859]: 更新 Windows 构建以使用 xz-5.2.5。

工具/示例

gh-91583 [https://github.com/python/cpython/issues/91583]: 修复了 Argument Clinic 为带有 defining_class 参数的函数生成的代码中的回归问题。

Python 3.10.4 final

Release date: 2022-03-23

核心与内置函数

bpo-46968 [https://bugs.python.org/issue?@action=redirect&bpo=46968]: 在 faulthandler 中检查 "sys/auxv.h" 头文件的存在，以避免在不存在此头文件的系统中出现编译问题。由 Pablo Galindo 提供补丁。

库

bpo-23691 [https://bugs.python.org/issue?@action=redirect&bpo=23691]: 保护 re.finditer() 迭代器不被重新进入。

bpo-42369 [https://bugs.python.org/issue?@action=redirect&bpo=42369]: 修复 zipfile._SharedFile.tell() 的线程安全性，以避免在多线程读取 ZipFile 时出现 "zipfile.BadZipFile: Bad CRC-32 for file" 异常。

bpo-38256 [https://bugs.python.org/issue?@action=redirect&bpo=38256]: 修复了当编译使用 zlib 的 crc32 时的 binascii.crc32()，使其正确处理长度超过 4GiB 的输入而不是返回错误结果。在此之前的解决方法是始终以小于 4GiB 的增量向函数提供数据，或直接调用 zlib 模块函数。

bpo-39394 [https://bugs.python.org/issue?@action=redirect&bpo=39394]: 关于不在正则表达式开头的内联标志的警告现在包含标志的位置。

bpo-47061 [https://bugs.python.org/issue?@action=redirect&bpo=47061]: 弃用 PEP 594 [https://www.python.org/dev/peps/pep-0594] 中列出的各种模块：

aifc, asynchat, asyncore, audioop, cgi, cgitb, chunk, crypt, imghdr, msilib, nntplib, nis, ossaudiodev, pipes, smtpd, sndhdr, spwd, sunau, telnetlib, uu, xdrlib

bpo-2604 [https://bugs.python.org/issue?@action=redirect&bpo=2604]: 修复了使用全局变量的doctests在多次运行时失败的bug。

bpo-45997 [https://bugs.python.org/issue?@action=redirect&bpo=45997]: 修复 asyncio.Semaphore 重新获取FIFO顺序的问题。

bpo-47022 [https://bugs.python.org/issue?@action=redirect&bpo=47022]: The asynchat, asyncore and smtpd modules have been deprecated since at least Python 3.6. Their documentation and deprecation warnings and have now been updated to note they will removed in Python 3.12 (PEP 594 [https://www.python.org/dev/peps/pep-0594]).

bpo-46421 [https://bugs.python.org/issue?@action=redirect&bpo=46421]: 修复了一个 unittest 问题，即如果命令以 python -m unittest 形式调用且文件名以点（.）开头，会返回 ValueError。

bpo-40296 [https://bugs.python.org/issue?@action=redirect&bpo=40296]: 修复 pydoc 中支持泛型别名的问题。

Python 3.10.3 final

Release date: 2022-03-16

核心与内置函数

bpo-46940 [https://bugs.python.org/issue?@action=redirect&bpo=46940]: 避免覆盖嵌套属性访问调用的 AttributeError 元数据信息。由 Pablo Galindo 提供补丁。

bpo-46852 [https://bugs.python.org/issue?@action=redirect&bpo=46852]: 将私有的未文档化的 float.__set_format__() 方法重命名为 float.__setformat__()，以修复 Python 3.7 中引入的拼写错误。该方法仅由 test_float 使用。由 Victor Stinner 提供补丁。

bpo-46794 [https://bugs.python.org/issue?@action=redirect&bpo=46794]: 将 libexpat 版本提升至 2.4.6。

bpo-46820 [https://bugs.python.org/issue?@action=redirect&bpo=46820]: 修复在数字字面量后紧跟着（无空格）"not in" 关键字时的解析问题，例如 1not in x。现在解析器仅发出警告，而非语法错误。

bpo-46762 [https://bugs.python.org/issue?@action=redirect&bpo=46762]: 修复在调试版本中，当 '<'、'>' 或 '=' 是 f 字符串中缺失右大括号的最后一个字符时的断言失败。

bpo-46724 [https://bugs.python.org/issue?@action=redirect&bpo=46724]: 确保所有向后跳转都使用 JUMP_ABSOLUTE 指令，而不是使用参数为 (2**32)+offset 的 JUMP_FORWARD。

bpo-46732 [https://bugs.python.org/issue?@action=redirect&bpo=46732]: Correct the docstring for the __bool__() method. Patch by Jelle Zijlstra.

bpo-46707 [https://bugs.python.org/issue?@action=redirect&bpo=46707]: 避免在产生涉及大量括号的某些语法错误时可能出现的指数级回溯。由 Pablo Galindo 提供补丁。

bpo-40479 [https://bugs.python.org/issue?@action=redirect&bpo=40479]: 在 Modules/_hashopenssl.c 中添加一个遗漏的 va_end() 调用。

bpo-46615 [https://bugs.python.org/issue?@action=redirect&bpo=46615]: 在 setobject.c 中内部迭代集合时，对集合中的结果项获取强引用。这防止了在各种集合操作的边角情况下集合被修改导致的崩溃。

bpo-45773 [https://bugs.python.org/issue?@action=redirect&bpo=45773]: 从字节码编译器中移除两个无效的 "peephole" 优化。

bpo-43721 [https://bugs.python.org/issue?@action=redirect&bpo=43721]: 修复 getter, setter, 和 deleter 的文档字符串，以明确它们创建属性的新副本。

bpo-46503 [https://bugs.python.org/issue?@action=redirect&bpo=46503]: 修复在解析 f-strings 中一些无效的 N 转义序列时的断言。

bpo-46417 [https://bugs.python.org/issue?@action=redirect&bpo=46417]: 修复设置类型 __bases__ 属性时的竞争条件：内部函数 add_subclass() 现在在调用 PyWeakref_NewRef() 后获取 PyTypeObject.tp_subclasses 成员，这可以触发垃圾回收，间接修改 PyTypeObject.tp_subclasses。由 Victor Stinner 提供补丁。

bpo-46383 [https://bugs.python.org/issue?@action=redirect&bpo=46383]: 修复 _zoneinfo 的 module_free 函数的无效签名，以解决wasm32-emscripten平台上的崩溃问题。

bpo-46070 [https://bugs.python.org/issue?@action=redirect&bpo=46070]: Py_EndInterpreter() now explicitly untracks all objects currently tracked by the GC. Previously, if an object was used later by another interpreter, calling PyObject_GC_UnTrack() on the object crashed if the previous or the next object of the PyGC_Head structure became a dangling pointer. Patch by Victor Stinner.

bpo-46339 [https://bugs.python.org/issue?@action=redirect&bpo=46339]: 修复解析器在检索多行f-strings表达式的错误文本时崩溃的问题，这些表达式不在字符串的第一行开始。由Pablo Galindo提供补丁。

bpo-46240 [https://bugs.python.org/issue?@action=redirect&bpo=46240]: 当错误报告时，如果标记器未到达源代码的末尾，则修正未闭合括号的错误消息。补丁由 Pablo Galindo 提供。

bpo-46091 [https://bugs.python.org/issue?@action=redirect&bpo=46091]: 正确计算以行继续字符结尾的带有空白字符的行的缩进级别。由Pablo Galindo提供补丁。

库

bpo-43253 [https://bugs.python.org/issue?@action=redirect&bpo=43253]: 修复在Proactor事件循环中关闭传输时底层套接字句柄已无效导致的崩溃问题。

bpo-47004 [https://bugs.python.org/issue?@action=redirect&bpo=47004]: 应用来自importlib_metadata 4.11.3的错误修复，包括修复EntryPoint.extras返回匹配对象而非额外字符串的问题。

bpo-46985 [https://bugs.python.org/issue?@action=redirect&bpo=46985]: 升级与ensurepip捆绑的pip wheel（pip 22.0.4）。

bpo-46968 [https://bugs.python.org/issue?@action=redirect&bpo=46968]: faulthandler: 在Linux 5.14及更新版本上，动态确定CPython使用 getauxval(AT_MINSIGSTKSZ) 分配的信号处理程序堆栈大小。这一变化允许Python扩展请求Linux内核在Sapphire Rapids Xeon处理器上使用AMX_TILE指令集成功，解除了该ISA在框架中使用的阻碍。

bpo-46955 [https://bugs.python.org/issue?@action=redirect&bpo=46955]: 将 asyncio.base_events.Server 作为 asyncio.Server 公开。由Stefan Zabka提供补丁。

bpo-23325 [https://bugs.python.org/issue?@action=redirect&bpo=23325]: signal 模块不再假设 SIG_IGN 和 SIG_DFL 是小的int单例。

bpo-46932 [https://bugs.python.org/issue?@action=redirect&bpo=46932]: 更新捆绑的libexpat到2.4.7版本。

bpo-25707 [https://bugs.python.org/issue?@action=redirect&bpo=25707]: 修复了 xml.etree.ElementTree.iterparse() 中当迭代器未被耗尽时的文件泄露问题。由 Jacob Walls 提供补丁。

bpo-44886 [https://bugs.python.org/issue?@action=redirect&bpo=44886]: 将 asyncio proactor 数据报传输继承自 asyncio.DatagramTransport。

bpo-46827 [https://bugs.python.org/issue?@action=redirect&bpo=46827]: 在基于选择器的事件循环中支持 asyncio.loop.sock_connect() 的 UDP 套接字。由 Thomas Grainger 提供补丁。

bpo-46811 [https://bugs.python.org/issue?@action=redirect&bpo=46811]: 使测试套件支持 Expat >=2.4.5。

bpo-46252 [https://bugs.python.org/issue?@action=redirect&bpo=46252]: 如果 ssl.SSLSocket 被传递给基于传输的 API，则抛出 TypeError。

bpo-46784 [https://bugs.python.org/issue?@action=redirect&bpo=46784]: 修复了在嵌入式 Python 中与用户动态加载或静态链接的 libexpat 库的符号冲突。

bpo-39327 [https://bugs.python.org/issue?@action=redirect&bpo=39327]: shutil.rmtree() 现在可以在客户操作系统中运行时与 VirtualBox 共享文件夹一起工作。

bpo-46756 [https://bugs.python.org/issue?@action=redirect&bpo=46756]: 修复了 urllib.request.HTTPPasswordMgr.find_user_password() 和 urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated() 中的一个漏洞，该漏洞允许绕过授权。例如，如果用户被授权访问 URI example.org/foo，则允许访问 URI example.org/foobar。

bpo-46643 [https://bugs.python.org/issue?@action=redirect&bpo=46643]: 在 typing.get_type_hints() 中，支持评估字符串化的 ParamSpecArgs 和 ParamSpecKwargs 注解。由 Gregory Beauregard 提供补丁。

bpo-45863 [https://bugs.python.org/issue?@action=redirect&bpo=45863]: 当 tarfile 模块创建 pax 格式的存档时，它会在 ustar 头中放置时间戳的整数表示（如果可能的话），以便于旧的解档工具使用，此外还会在 pax 扩展头中放置现有的全精度时间戳。

bpo-46676 [https://bugs.python.org/issue?@action=redirect&bpo=46676]: 使 typing.ParamSpec 的 args 和 kwargs 等于它们自己。由 Gregory Beauregard 提供补丁。

bpo-46672 [https://bugs.python.org/issue?@action=redirect&bpo=46672]: 修复 asyncio.gather() 中初始类型检查失败时的 NameError。

bpo-46655 [https://bugs.python.org/issue?@action=redirect&bpo=46655]: 在 typing.get_type_hints() 中，支持评估裸字符串化的 TypeAlias 注解。由 Gregory Beauregard 提供补丁。

bpo-45948 [https://bugs.python.org/issue?@action=redirect&bpo=45948]: 修复了 xml.etree.ElementTree 模块 C 实现中的一个不一致之处。现在，实例化 xml.etree.ElementTree.XMLParser 时使用 target=None 关键字参数会像 Python 实现一样提供一个默认的 xml.etree.ElementTree.TreeBuilder 目标。

bpo-46521 [https://bugs.python.org/issue?@action=redirect&bpo=46521]: 修复了 codeop 模块中的一个 bug，该 bug 错误地将涉及字符串引号的无效代码识别为有效代码。

bpo-46581 [https://bugs.python.org/issue?@action=redirect&bpo=46581]: 使 GenericAlias 的 ParamSpec 传播与 Concatenate (及其他) 保持一致。

bpo-46591 [https://bugs.python.org/issue?@action=redirect&bpo=46591]: 使About IDLE对话框中的IDLE文档URL可点击。

bpo-46400 [https://bugs.python.org/issue?@action=redirect&bpo=46400]: expat: 将 libexpat 从 2.4.1 更新至 2.4.4

bpo-46487 [https://bugs.python.org/issue?@action=redirect&bpo=46487]: 在 asyncio.transports.WriteTransport 和 SSL 传输中添加 get_write_buffer_limits 方法。

bpo-45173 [https://bugs.python.org/issue?@action=redirect&bpo=45173]: 注意 configparser 的弃用将在 Python 3.12 中移除。

bpo-46539 [https://bugs.python.org/issue?@action=redirect&bpo=46539]: 在 typing.get_type_hints() 中，支持在 Annotated 内部评估字符串化的 ClassVar 和 Final 注解。由 Gregory Beauregard 提供补丁。

bpo-46491 [https://bugs.python.org/issue?@action=redirect&bpo=46491]: 允许 typing.Annotated 包装 typing.Final 和 typing.ClassVar。由 Gregory Beauregard 提供补丁。

bpo-46436 [https://bugs.python.org/issue?@action=redirect&bpo=46436]: 修复模块 http.server 中的命令行选项 -d/--directory，当与命令行选项 --cgi 结合使用时被忽略的问题。由 Géry Ogam 提供补丁。

bpo-41403 [https://bugs.python.org/issue?@action=redirect&bpo=41403]: 使 mock.patch() 在无效参数上引发带有相关错误信息的 TypeError。之前它允许一个难以理解的 AttributeError 逃逸。

bpo-46474 [https://bugs.python.org/issue?@action=redirect&bpo=46474]: 在 importlib.metadata.EntryPoint.pattern 中，通过限制连续空白字符的歧义性来避免潜在的 REDoS。

bpo-46469 [https://bugs.python.org/issue?@action=redirect&bpo=46469]: asyncio 泛型类现在在 __class_getitem__ 中返回 types.GenericAlias 而不是同一个类。

bpo-46434 [https://bugs.python.org/issue?@action=redirect&bpo=46434]: pdb now gracefully handles help when __doc__ is missing, for example when run with pregenerated optimized .pyc files.

bpo-46333 [https://bugs.python.org/issue?@action=redirect&bpo=46333]: typing.ForwardRef 的 __eq__() 和 __hash__() 方法现在尊重 typing.ForwardRef 的 module 参数。现在可以区分来自不同模块的前向引用。

bpo-46246 [https://bugs.python.org/issue?@action=redirect&bpo=46246]: 为 importlib.metadata.DeprecatedList 添加了缺失的 __slots__。由 Arie Bovenberg 提供补丁。

bpo-46266 [https://bugs.python.org/issue?@action=redirect&bpo=46266]: 改进 calendar 中的日常量。

Now all constants (MONDAY ... SUNDAY) are documented, tested, and added to __all__.

bpo-46232 [https://bugs.python.org/issue?@action=redirect&bpo=46232]: ssl 模块现在能正确处理 DN 中包含位字符串的证书。

bpo-43118 [https://bugs.python.org/issue?@action=redirect&bpo=43118]: 修复 inspect.signature() 中的一个 bug，该 bug 导致它在某些引用模块全局的 __text_signature__ 的类的子类上失败。由 Weipeng Hong 提供补丁。

bpo-26552 [https://bugs.python.org/issue?@action=redirect&bpo=26552]: 修复了 asyncio.ensure_future() 失败时未关闭协程的情况。由 Kumar Aditya 提供补丁。

bpo-21987 [https://bugs.python.org/issue?@action=redirect&bpo=21987]: 修复 tarfile.TarFile.getmember() 获取带有尾随斜杠的目录名的问题。

bpo-20392 [https://bugs.python.org/issue?@action=redirect&bpo=20392]: 修复 MimeTypes.guess_type() 中大写文件扩展名的不一致问题。由 Kumar Aditya 提供补丁。

bpo-46080 [https://bugs.python.org/issue?@action=redirect&bpo=46080]: 修复了如果 argparse.BooleanOptionalAction 参数的默认值为 argparse.SUPPRESS 并且指定了 help 时，在 argparse 帮助文本生成中出现的异常。补丁由 Felix Fontein 提供。

bpo-44439 [https://bugs.python.org/issue?@action=redirect&bpo=44439]: 修复 ZipFile 中成员文件的 .write() 方法，当输入数据是支持缓冲协议的对象时，文件长度可能错误的问题。

bpo-45703 [https://bugs.python.org/issue?@action=redirect&bpo=45703]: 当在程序运行时，一个命名空间包在另一个来自同一命名空间的模块被创建/安装在不同的 sys.path 位置之前被导入时，调用 importlib.invalidate_caches() 函数现在也能保证新模块被注意到。

bpo-24959 [https://bugs.python.org/issue?@action=redirect&bpo=24959]: 修复 unittest 中有时会从测试中引发的异常的追溯中丢弃帧的错误。

bpo-44791 [https://bugs.python.org/issue?@action=redirect&bpo=44791]: 修复了在不同参数表达式中 ParamSpec 在 Concatenate 中的替换问题。现在用类型列表替换会返回一个类型元组。用 Concatenate 替换现在会返回一个带有连接参数列表的 Concatenate。

bpo-14156 [https://bugs.python.org/issue?@action=redirect&bpo=14156]: argparse.FileType 现在支持二进制模式下的 '-' 参数，根据情况返回 sys.stdin/sys.stdout 的 .buffer 属性。当参数为 '-' 时，包含 'x' 和 'a' 的模式被视为等同于 'w'。补丁由 Josh Rosenberg 贡献

文档

bpo-46463 [https://bugs.python.org/issue?@action=redirect&bpo=46463]: 修复了构建 CHM 文档文件时使用的 escape4chm.py 脚本。

测试

bpo-46913 [https://bugs.python.org/issue?@action=redirect&bpo=46913]: 如果 Python 是用未定义行为消毒剂 (UBSAN) 构建的，修复 test_faulthandler.test_sigfpe()：在 faulthandler_sigfpe() 函数上禁用 UBSAN。由 Victor Stinner 提供补丁。

bpo-46708 [https://bugs.python.org/issue?@action=redirect&bpo=46708]: 防止 test_asyncio 执行后默认 asyncio 事件循环策略修改警告。

bpo-46678 [https://bugs.python.org/issue?@action=redirect&bpo=46678]: Lib/test/support/import_helper.py 中的函数 make_legacy_pyc 不再在 PYTHONPYCACHEPREFIX 设置为与存储临时文件不同的设备上的目录时失败。

bpo-46616 [https://bugs.python.org/issue?@action=redirect&bpo=46616]: 确保 test_importlib.test_windows 在完成后清理注册表键。

bpo-44359 [https://bugs.python.org/issue?@action=redirect&bpo=44359]: test_ftplib 现在默默地忽略套接字错误，以防止记录未处理的线程异常。由 Victor Stinner 提供补丁。

bpo-46542 [https://bugs.python.org/issue?@action=redirect&bpo=46542]: 修复了在使用调试模式构建的 Python 中 test_lib2to3 的 Python 崩溃：限制递归限制。由 Victor Stinner 提供补丁。

bpo-46576 [https://bugs.python.org/issue?@action=redirect&bpo=46576]: test_peg_generator 现在在测试其自己的 C 扩展的编译时禁用编译器优化，以显著加快在 CPython 的非调试构建上的测试速度。

bpo-46542 [https://bugs.python.org/issue?@action=redirect&bpo=46542]: 修复 test_json 测试中对 RecursionError 的检查：修改这些测试以使用 support.infinite_recursion()。由 Victor Stinner 提供补丁。

bpo-13886 [https://bugs.python.org/issue?@action=redirect&bpo=13886]: Skip test_builtin PTY tests on non-ASCII characters if the readline module is loaded. The readline module changes input() behavior, but test_builtin is not intented to test the readline module. Patch by Victor Stinner.

构建

bpo-47032 [https://bugs.python.org/issue?@action=redirect&bpo=47032]: 确保当构建的一部分失败时，Windows 安装构建能够正确地以非零退出码失败。

bpo-47024 [https://bugs.python.org/issue?@action=redirect&bpo=47024]: 为 macOS 安装程序和所有 Windows 构建更新 OpenSSL 到 1.1.1n。

bpo-38472 [https://bugs.python.org/issue?@action=redirect&bpo=38472]: 修复交叉编译时 setup.py 中的 GCC 检测。现在 C 编译器以 LC_ALL=C 运行。之前，检测在德语环境下会失败。

bpo-46513 [https://bugs.python.org/issue?@action=redirect&bpo=46513]: configure 不再使用 AC_C_CHAR_UNSIGNED 宏，且 pyconfig.h 不再定义保留符号 __CHAR_UNSIGNED__。

bpo-45925 [https://bugs.python.org/issue?@action=redirect&bpo=45925]: 更新 Windows 安装程序以使用 SQLite 3.37.2。

Windows

bpo-44549 [https://bugs.python.org/issue?@action=redirect&bpo=44549]: Update bzip2 to 1.0.8 in Windows builds to mitigate CVE-2016-3189 and CVE-2019-12900

bpo-46948 [https://bugs.python.org/issue?@action=redirect&bpo=46948]: Prevent CVE-2022-26488 by ensuring the Add to PATH option in the Windows installer uses the correct path when being repaired.

bpo-46638 [https://bugs.python.org/issue?@action=redirect&bpo=46638]: 确保注册表虚拟化一致禁用。对于3.10及更早版本，它保持启用（某些注册表写入受到保护），而对于3.11及更高版本，它被禁用（注册表修改影响所有应用程序）。

macOS

bpo-45925 [https://bugs.python.org/issue?@action=redirect&bpo=45925]: 更新 macOS 安装程序到 SQLite 3.37.2。

IDLE

bpo-46630 [https://bugs.python.org/issue?@action=redirect&bpo=46630]: 使 Windows 上的查询对话框开始时光标在输入框中。

bpo-45296 [https://bugs.python.org/issue?@action=redirect&bpo=45296]: 在 IDLE 中明确了关闭、退出和退出的区别。在文件菜单中，'关闭' 和 '退出' 现在是 '关闭窗口'（当前窗口）和 '退出 IDLE'（通过关闭所有窗口）。在 Shell 中，'quit()' 和 'exit()' 意思是 '关闭 Shell'。如果没有其他窗口，这也将退出 IDLE。

bpo-45447 [https://bugs.python.org/issue?@action=redirect&bpo=45447]: Apply IDLE syntax highlighting to pyi files. Patch by Alex Waygood and Terry Jan Reedy.

C API

bpo-46433 [https://bugs.python.org/issue?@action=redirect&bpo=46433]: 内部函数 _PyType_GetModuleByDef 现在正确处理涉及静态类型的继承模式。

bpo-14916 [https://bugs.python.org/issue?@action=redirect&bpo=14916]: 修复了 tokenizer 中的一个错误，该错误阻止了 PyRun_InteractiveOne 从提供的 FD 解析。

Python 3.10.2 final

发布日期: 2022-01-13

核心与内置函数

bpo-46347 [https://bugs.python.org/issue?@action=redirect&bpo=46347]: 修复PyEval_EvalCodeEx中的内存泄漏。

bpo-46289 [https://bugs.python.org/issue?@action=redirect&bpo=46289]: FormattedValue 的ASDL声明已更改，以反映 conversion 字段不是可选的。

bpo-46237 [https://bugs.python.org/issue?@action=redirect&bpo=46237]: 修复f-strings内部标记器错误的行号。由Pablo Galindo提供补丁。

bpo-46006 [https://bugs.python.org/issue?@action=redirect&bpo=46006]: 修复当类型方法如 __init__() 在子解释器中被修改时的回归问题。修复 _PyUnicode_EqualToASCIIId() 和类型 update_slot() 中的回归问题。恢复使Unicode内部字符串字典与子解释器兼容的更改：内部内部字符串字典再次由所有解释器共享。由Victor Stinner提供补丁。

bpo-46085 [https://bugs.python.org/issue?@action=redirect&bpo=46085]: 修复 OrderedDict 的迭代器缓存机制。

bpo-46110 [https://bugs.python.org/issue?@action=redirect&bpo=46110]: 向 PEG 解析器添加最大递归检查以避免堆栈溢出。由 Pablo Galindo 提供补丁。

bpo-46054 [https://bugs.python.org/issue?@action=redirect&bpo=46054]: 修复解析源文件中非utf8字符时的解析器错误。由Pablo Galindo提供补丁。

bpo-46042 [https://bugs.python.org/issue?@action=redirect&bpo=46042]: 改进符号表发出的 SyntaxError 异常中插入符号的位置。由Pablo Galindo提供补丁。

bpo-46025 [https://bugs.python.org/issue?@action=redirect&bpo=46025]: 修复 atexit 模块中的一个崩溃问题，涉及在引发异常前自行注销的函数。由Pablo Galindo提供补丁。

bpo-46009 [https://bugs.python.org/issue?@action=redirect&bpo=46009]: 恢复3.9及更早版本中向新启动的生成器发送非None时的行为。在3.9中，这不影响生成器的状态。在3.10.0和3.10.1中，gen_func().send(0)``等同于``gen_func().throw(TypeError(...)，这会耗尽生成器。在3.10.2及以后版本中，行为已恢复到3.9的状态。

bpo-46000 [https://bugs.python.org/issue?@action=redirect&bpo=46000]: 提高 curses 模块与NetBSD curses的兼容性。

bpo-46004 [https://bugs.python.org/issue?@action=redirect&bpo=46004]: 修复了涉及带有无效目标的for循环的 SyntaxError 位置错误。由Pablo Galindo提供补丁。

bpo-42918 [https://bugs.python.org/issue?@action=redirect&bpo=42918]: 修复内置 compile() 函数在'single'模式下传递多个语句时并不总是引发 SyntaxError 的错误。由Weipeng Hong提供补丁。

库

bpo-40479 [https://bugs.python.org/issue?@action=redirect&bpo=40479]: 修复 hashlib usedforsecurity 选项，使其在 FIPS 模式下与 OpenSSL 3.0.0 正确工作。

bpo-46070 [https://bugs.python.org/issue?@action=redirect&bpo=46070]: 修复了从不同的子解释器并行导入 asyncio 模块时可能出现的段错误。补丁由 Erlend E. Aasland 提供。

bpo-46278 [https://bugs.python.org/issue?@action=redirect&bpo=46278]: 在 AbstractEventLoop.call_*() 方法中反映 context 参数。循环实现已经支持它。

bpo-46239 [https://bugs.python.org/issue?@action=redirect&bpo=46239]: 在非 Windows 系统上导入 asyncio.windows_events 时改进了错误消息。

bpo-20369 [https://bugs.python.org/issue?@action=redirect&bpo=20369]: 当给定重复的 Futures 时，concurrent.futures.wait() 不再永远阻塞。由 Kumar Aditya 提供补丁。

bpo-46105 [https://bugs.python.org/issue?@action=redirect&bpo=46105]: 在使用 URL 和 extras 生成需求规范时遵循规范（importlib_metadata 4.8.3）。

bpo-26952 [https://bugs.python.org/issue?@action=redirect&bpo=26952]: argparse raises ValueError with clear message when trying to render usage for an empty mutually-exclusive group. Previously it raised a cryptic IndexError.

bpo-27718 [https://bugs.python.org/issue?@action=redirect&bpo=27718]: 修复 signal 模块的帮助文档。一些函数（例如 signal() 和 getsignal()）被遗漏了。

bpo-46032 [https://bugs.python.org/issue?@action=redirect&bpo=46032]: functools.singledispatch() 函数的 registry() 方法现在会检查第一个参数或第一个参数注解，并在不支持时抛出 TypeError。之前不支持的“类型”被忽略（例如 typing.List[int]）或在调用时引发错误（例如 list[int]）。

bpo-46018 [https://bugs.python.org/issue?@action=redirect&bpo=46018]: 确保 math.expm1() 在下溢时不抛出异常。

bpo-45755 [https://bugs.python.org/issue?@action=redirect&bpo=45755]: 现在，当传递给 dir() 时，typing 泛型别名会显示原始泛型类的类属性。这是 Python 3.6 之前的行为，但在 3.7-3.9 中有所改变。

bpo-13236 [https://bugs.python.org/issue?@action=redirect&bpo=13236]: unittest.TextTestResult 和 unittest.TextTestRunner 现在更频繁地刷新输出流。

bpo-42378 [https://bugs.python.org/issue?@action=redirect&bpo=42378]: 修复了当 logging.FileHandler 在 atexit 中使用且 filemode 设置为 'w' 时日志文件被覆盖的问题。注意，如果日志流由于日志关闭已经关闭，这将导致 atexit 中的消息不被记录。

文档

bpo-46120 [https://bugs.python.org/issue?@action=redirect&bpo=46120]: 在 typing 文档中说明 | 在可读性上优于 Union。

bpo-46040 [https://bugs.python.org/issue?@action=redirect&bpo=46040]: Fix removal Python version for @asyncio.coroutine, the correct value is 3.11.

bpo-19737 [https://bugs.python.org/issue?@action=redirect&bpo=19737]: 更新 globals() 函数的文档。

bpo-45840 [https://bugs.python.org/issue?@action=redirect&bpo=45840]: 改进数据模型文档中的交叉引用。

测试

bpo-46205 [https://bugs.python.org/issue?@action=redirect&bpo=46205]: 修复由于竞态条件导致的runtest_mp中的挂起问题。

bpo-46263 [https://bugs.python.org/issue?@action=redirect&bpo=46263]: 在FreeBSD 14-dev上修复test_capi：指示jemalloc不要用垃圾字节填充释放的内存。

bpo-46150 [https://bugs.python.org/issue?@action=redirect&bpo=46150]: 现在检查 test_pathlib.PosixPathTest.test_expanduser 中的 fakename 是否不存在。

bpo-46129 [https://bugs.python.org/issue?@action=redirect&bpo=46129]: 使用 unittest.IsolatedAsyncioTestCase 重写 asyncio.locks 测试。

bpo-46114 [https://bugs.python.org/issue?@action=redirect&bpo=46114]: 修复针对 OpenSSL 3.0.1 版本的测试用例。OpenSSL 3.0 使用 0xMNN00PP0L。

构建

bpo-46263 [https://bugs.python.org/issue?@action=redirect&bpo=46263]: configure 不再在 FreeBSD 平台上设置 MULTIARCH。

bpo-46106 [https://bugs.python.org/issue?@action=redirect&bpo=46106]: 在 Windows 构建、macOS 安装包构建和 CI 中更新 OpenSSL 到 1.1.1m。由 Kumar Aditya 提供补丁。

macOS

bpo-40477 [https://bugs.python.org/issue?@action=redirect&bpo=40477]: macOS的Python启动器应用程序现在能正确启动脚本，并在必要时在最近的macOS版本上运行终端应用程序。

C API

bpo-46236 [https://bugs.python.org/issue?@action=redirect&bpo=46236]: 修复了 PyFunction_GetAnnotations() 中的一个错误，该错误导致它返回一个 tuple 而不是 dict。

Python 3.10.1 final

Release date: 2021-12-06

核心与内置函数

bpo-42268 [https://bugs.python.org/issue?@action=redirect&bpo=42268]: 如果所选编译器不支持内存清理器，则配置步骤失败。由Pablo Galindo提供补丁

bpo-45727 [https://bugs.python.org/issue?@action=redirect&bpo=45727]: 改进了自定义语法错误，只有当表达式在括号或方括号之间被检测到时，才触发可能缺少逗号的建议。由Pablo Galindo提供补丁

bpo-45614 [https://bugs.python.org/issue?@action=redirect&bpo=45614]: 修复了 traceback 对于模块名称无效的异常的显示。

bpo-45848 [https://bugs.python.org/issue?@action=redirect&bpo=45848]: 允许解析器直接从编码文件中获取错误行。由Pablo Galindo提供补丁

bpo-45826 [https://bugs.python.org/issue?@action=redirect&bpo=45826]: 修复了在 NameError 上调用 .with_traceback(None) 时发生的崩溃。这内部发生在 unittest.TestCase.assertRaises() 中。

bpo-45822 [https://bugs.python.org/issue?@action=redirect&bpo=45822]: 修复了解析器中的一个错误，该错误导致在没有提供标志时不尊重 PEP 263 [https://www.python.org/dev/peps/pep-0263] 编码声明。由Pablo Galindo提供补丁

bpo-45820 [https://bugs.python.org/issue?@action=redirect&bpo=45820]: 修复了当解析器在未读取任何输入时失败时的段错误。由Pablo Galindo提供补丁

bpo-42540 [https://bugs.python.org/issue?@action=redirect&bpo=42540]: 修复了在调用 os.fork() 时存在活跃的非默认内存分配器时的崩溃。

bpo-45738 [https://bugs.python.org/issue?@action=redirect&bpo=45738]: 修复解析器中无效连续字符错误位置的计算。由Pablo Galindo提供补丁。

bpo-45773 [https://bugs.python.org/issue?@action=redirect&bpo=45773]: 修复尝试优化某些跳转模式时的编译器挂起问题。

bpo-45716 [https://bugs.python.org/issue?@action=redirect&bpo=45716]: 改进在函数调用中使用 True、None 或 False 作为关键字时的 SyntaxError 消息。由Pablo Galindo提供补丁。

bpo-45688 [https://bugs.python.org/issue?@action=redirect&bpo=45688]: sys.stdlib_module_names now contains the macOS-specific module _scproxy.

bpo-30570 [https://bugs.python.org/issue?@action=redirect&bpo=30570]: 修复了在搜索病态的 __bases__ 元组时 issubclass() 因无限递归而崩溃的问题。

bpo-45521 [https://bugs.python.org/issue?@action=redirect&bpo=45521]: 修复obmalloc基数树代码中的一个错误。在64位机器上，该错误导致树持有46位的虚拟地址，而不是预期的48位。

bpo-45494 [https://bugs.python.org/issue?@action=redirect&bpo=45494]: 修复报告涉及无效延续字符错误时的解析器崩溃。由Pablo Galindo提供补丁。

bpo-45408 [https://bugs.python.org/issue?@action=redirect&bpo=45408]: 修复解析器在报告与未闭合括号同时发生的分词器错误时崩溃的问题。由Pablo Galindo提供补丁。

bpo-45385 [https://bugs.python.org/issue?@action=redirect&bpo=45385]: Fix reference leak from descr_check. Patch by Dong-hee Na.

bpo-45167 [https://bugs.python.org/issue?@action=redirect&bpo=45167]: 修复了 types.GenericAlias 对象的深拷贝问题。

bpo-44219 [https://bugs.python.org/issue?@action=redirect&bpo=44219]: 在执行任意文件描述符的 isatty 系统调用时释放GIL。这特别影响了 os.isatty()、os.device_encoding() 和 io.TextIOWrapper。间接地，文本模式下的 io.open() 也受到影响。此更改解决了 os.isatty() 中的一个死锁问题。由Vincent Michel在 bpo-44219 [https://bugs.python.org/issue?@action=redirect&bpo=44219] 中提供补丁。

bpo-44959 [https://bugs.python.org/issue?@action=redirect&bpo=44959]: 在HP-UX系统上添加了对'.sl'后缀扩展模块的回退支持。

bpo-44050 [https://bugs.python.org/issue?@action=redirect&bpo=44050]: 通过设置 m_size 为-1来表明使用全局状态的扩展可以再次在多个解释器中使用。这恢复到Python 3.8的行为。

bpo-45121 [https://bugs.python.org/issue?@action=redirect&bpo=45121]: 修复了当直接调用或通过 super() 调用时，Protocol.__init__ 会引发``RecursionError``的问题。由Yurii Karabas提供补丁。

bpo-45083 [https://bugs.python.org/issue?@action=redirect&bpo=45083]: 当解释器渲染异常时，其名称现在具有完整的限定名。以前只有类名被连接到模块名，这有时会导致显示的全名不正确。

（此问题仅影响C代码异常渲染，traceback 模块已经使用了限定名）。

bpo-45056 [https://bugs.python.org/issue?@action=redirect&bpo=45056]: 编译器现在会从co_consts中移除未使用的尾随常量。

库

bpo-27946 [https://bugs.python.org/issue?@action=redirect&bpo=27946]: Fix possible crash when getting an attribute of class:xml.etree.ElementTree.Element simultaneously with replacing the attrib dict.

bpo-37658 [https://bugs.python.org/issue?@action=redirect&bpo=37658]: 修复了在某些条件下 asyncio.wait_for() 可能允许协程成功完成，但未能返回结果，可能导致内存泄漏或其他问题的问题。

bpo-44649 [https://bugs.python.org/issue?@action=redirect&bpo=44649]: 处理了dataclass(slots=True)与一个字段有默认值，但init=False的情况。

bpo-45803 [https://bugs.python.org/issue?@action=redirect&bpo=45803]: 向dataclasses.make_dataclass()添加了缺失的kw_only参数。

bpo-45831 [https://bugs.python.org/issue?@action=redirect&bpo=45831]: faulthandler 现在可以在转储回溯时，通过一次 write() 系统调用写入仅包含 ASCII 的字符串（如文件名和函数名）。这减少了当两个线程或两个进程同时向同一文件（如 stderr）转储回溯时，产生不可读转储的风险。由 Victor Stinner 提供补丁。

bpo-41735 [https://bugs.python.org/issue?@action=redirect&bpo=41735]: 在 PyObject_GetBuffer 之前修复了 zlib.Decompress.flush() 方法中的线程锁。

bpo-45235 [https://bugs.python.org/issue?@action=redirect&bpo=45235]: 恢复了 argparse 的一个错误修复，该修复导致了处理子解析器默认参数时的回归。这防止了叶级参数优先于根级参数。

bpo-45765 [https://bugs.python.org/issue?@action=redirect&bpo=45765]: 在 importlib.metadata 中，修复了对于空路径的发行版发现。

bpo-45757 [https://bugs.python.org/issue?@action=redirect&bpo=45757]: 修复了一个 bug，其中 dis 在 EXTENDED_ARG 后跟一个不使用其参数的操作码时会产生错误的 oparg。

bpo-45644 [https://bugs.python.org/issue?@action=redirect&bpo=45644]: 使用 python3 -m json.tool infile infile 进行原地 JSON 文件格式化现在可以正常工作，之前会导致文件为空。由 Chris Wesseling 提供补丁。

bpo-45679 [https://bugs.python.org/issue?@action=redirect&bpo=45679]: 修复多值 typing.Literal 的缓存问题。Literal[True, 2] 不再等于``Literal[1, 2]``。

bpo-45664 [https://bugs.python.org/issue?@action=redirect&bpo=45664]: 修复 types.resolve_bases() 和 types.new_class() 对于作为基类的 types.GenericAlias 实例的处理。

bpo-45663 [https://bugs.python.org/issue?@action=redirect&bpo=45663]: 修复 dataclasses.is_dataclass() 对于是 types.GenericAlias 子类的数据类的处理。

bpo-45662 [https://bugs.python.org/issue?@action=redirect&bpo=45662]: 修复 dataclasses.InitVar 与内置类类型别名的 repr，例如 InitVar[list[int]]。

bpo-45438 [https://bugs.python.org/issue?@action=redirect&bpo=45438]: 修复泛型内置类型的typing.Signature字符串表示。

bpo-45574 [https://bugs.python.org/issue?@action=redirect&bpo=45574]: 修复关于 print_escape 未使用的警告。

bpo-45581 [https://bugs.python.org/issue?@action=redirect&bpo=45581]: sqlite3.connect() 现在在底层SQLite API发出内存错误信号时正确引发 MemoryError。由Erlend E. Aasland提供补丁。

bpo-45557 [https://bugs.python.org/issue?@action=redirect&bpo=45557]: pprint.pprint() now handles underscore_numbers correctly. Previously it was always setting it to False.

bpo-45515 [https://bugs.python.org/issue?@action=redirect&bpo=45515]: 在 datetime 文档中添加了对 zoneinfo 的引用，主要替换了对 dateutil.tz 的过时引用。由 Paul Ganssle 更改。

bpo-45475 [https://bugs.python.org/issue?@action=redirect&bpo=45475]: 撤回了对 gzip.GzipFile、bz2.BZ2File 和 lzma.LZMAFile 迭代的优化（参见 bpo-43787 [https://bugs.python.org/issue?@action=redirect&bpo=43787]），因为在用户迭代它们时没有保持它们的引用导致回归。由 Inada Naoki 提供补丁。

bpo-45428 [https://bugs.python.org/issue?@action=redirect&bpo=45428]: 修复了在从标准输入读取文件名时 py_compile 中的回归问题。

bpo-45467 [https://bugs.python.org/issue?@action=redirect&bpo=45467]: 修复了 "raw-unicode-escape" 编解码器中的增量解码器和流读取器。之前如果转义序列被分割，它们会失败。

bpo-45461 [https://bugs.python.org/issue?@action=redirect&bpo=45461]: 修复了 "unicode-escape" 编解码器中的增量解码器和流读取器。之前如果转义序列被分割，它们会失败。

bpo-45239 [https://bugs.python.org/issue?@action=redirect&bpo=45239]: 修复了 email.utils.parsedate_tz() 在某些无效输入上崩溃并抛出 UnboundLocalError 而不是返回 None 的问题。由 Ben Hoyt 提供补丁。

bpo-45249 [https://bugs.python.org/issue?@action=redirect&bpo=45249]: 修复了当异常中的 end_offset 设置为 0 时，traceback.print_exc() 在显示插入符号时的行为。由 Pablo Galindo 提供补丁。

bpo-45416 [https://bugs.python.org/issue?@action=redirect&bpo=45416]: 修复了与显式 asyncio.Lock 对象一起使用 asyncio.Condition 的问题，这是由于移除了显式循环参数导致的回归。由 Joongi Kim 提供补丁。

bpo-45419 [https://bugs.python.org/issue?@action=redirect&bpo=45419]: Correct interfaces on DegenerateFiles.Path.

bpo-44904 [https://bugs.python.org/issue?@action=redirect&bpo=44904]: 修复了 doctest 模块中的一个错误，该错误会在文档字符串包含一个带有 classmethod property 的示例时导致失败。由 Alex Waygood 提供补丁。

bpo-45406 [https://bugs.python.org/issue?@action=redirect&bpo=45406]: Make inspect.getmodule() catch FileNotFoundError raised by :'func:inspect.getabsfile, and return None to indicate that the module could not be determined.

bpo-45262 [https://bugs.python.org/issue?@action=redirect&bpo=45262]: 防止 asyncio 中的 use-after-free。确保缓存的运行循环持有人在释放时被清除，以防止在 get_running_loop 中出现 use-after-free。

bpo-45386 [https://bugs.python.org/issue?@action=redirect&bpo=45386]: 使 xmlrpc.client 对 C 运行时更加健壮，其中底层的 C strftime 函数在测试年份格式化选项时会导致 ValueError。

bpo-45371 [https://bugs.python.org/issue?@action=redirect&bpo=45371]: Fix clang rpath issue in distutils. The UnixCCompiler now uses correct clang option to add a runtime library directory (rpath) to a shared library.

bpo-20028 [https://bugs.python.org/issue?@action=redirect&bpo=20028]: Improve error message of csv.Dialect when initializing. Patch by Vajrasky Kok and Dong-hee Na.

bpo-45343 [https://bugs.python.org/issue?@action=redirect&bpo=45343]: 将捆绑的 pip 更新到 21.2.4，setuptools 更新到 58.1.0。

bpo-45329 [https://bugs.python.org/issue?@action=redirect&bpo=45329]: 修复当使用已安装的 expat 库 <= 2.2.0 构建 pyexpat.xmlparser 时访问已释放内存的问题。

bpo-41710 [https://bugs.python.org/issue?@action=redirect&bpo=41710]: On Unix, if the sem_clockwait() function is available in the C library (glibc 2.30 and newer), the threading.Lock.acquire() method now uses the monotonic clock (time.CLOCK_MONOTONIC) for the timeout, rather than using the system clock (time.CLOCK_REALTIME), to not be affected by system clock changes. Patch by Victor Stinner.

bpo-45328 [https://bugs.python.org/issue?@action=redirect&bpo=45328]: 修复了 http.client.HTTPConnection 在不支持 TCP_NODELAY 套接字选项的操作系统中正常工作的问题。

bpo-1596321 [https://bugs.python.org/issue?@action=redirect&bpo=1596321]: 修复当 threading 模块首次从非主线程导入时 threading._shutdown() 函数的问题：在 Python 退出时不再记录错误。

bpo-45274 [https://bugs.python.org/issue?@action=redirect&bpo=45274]: 修复 threading 模块中 Thread.join() 方法的竞态条件。如果函数被信号中断并且信号处理程序引发异常，确保线程保持在一个一致的状态以防止死锁。由 Victor Stinner 提供补丁。

bpo-45238 [https://bugs.python.org/issue?@action=redirect&bpo=45238]: 修复 unittest.IsolatedAsyncioTestCase.debug()：现在可以运行异步方法和回调。

bpo-36674 [https://bugs.python.org/issue?@action=redirect&bpo=36674]: unittest.TestCase.debug() 现在如果类或测试方法被跳过装饰器装饰，会引发 unittest.SkipTest。

bpo-45235 [https://bugs.python.org/issue?@action=redirect&bpo=45235]: 修复了一个问题，即当使用带有默认值的子解析器时，argparse不会保留提供的命名空间中的值。

bpo-45183 [https://bugs.python.org/issue?@action=redirect&bpo=45183]: 让 zipimport.zipimporter.find_spec() 在底层的zip文件已被删除且内部缓存已通过 invalidate_cache() 重置时不抛出异常。

bpo-45234 [https://bugs.python.org/issue?@action=redirect&bpo=45234]: 修复了 copyfile(), copy(), copy2() 中的一个回归问题，当源是目录时不应抛出 FileNotFoundError 而应抛出 IsADirectoryError。

bpo-45228 [https://bugs.python.org/issue?@action=redirect&bpo=45228]: 修复解析J1939网络地址时的栈缓冲区溢出问题。

bpo-45192 [https://bugs.python.org/issue?@action=redirect&bpo=45192]: 修复 tempfile._infer_return_type 函数，使得 tempfile 函数的 dir 参数接受实现 os.PathLike 协议的对象。

由 Kyungmin Lee 提供补丁。

bpo-42135 [https://bugs.python.org/issue?@action=redirect&bpo=42135]: 修复拼写错误：importlib.find_loader 实际上计划在Python 3.12中移除，而不是3.10，与PR 25169中的其他内容一样。

由 Hugo van Kemenade 提供补丁。

bpo-45160 [https://bugs.python.org/issue?@action=redirect&bpo=45160]: 当追踪被 ttk OptionMenu 使用的 tkinter 变量时，回调不再被调用两次。

bpo-35474 [https://bugs.python.org/issue?@action=redirect&bpo=35474]: 使用 strict=False 调用 mimetypes.guess_all_extensions() 不再影响后续使用 strict=True 调用的结果。同时，修改返回的列表不再影响全局状态。

bpo-45166 [https://bugs.python.org/issue?@action=redirect&bpo=45166]: typing.get_type_hints() 现在可以与 Final 包裹在 ForwardRef 中的情况一起工作。

bpo-20499 [https://bugs.python.org/issue?@action=redirect&bpo=20499]: 提高 statistics.pvariance() 的速度和准确性。

bpo-24444 [https://bugs.python.org/issue?@action=redirect&bpo=24444]: 修复了 argparse 帮助显示中当选项的帮助设置为 1+ 个空格或当 choices 参数为空容器时引发的错误。

bpo-45021 [https://bugs.python.org/issue?@action=redirect&bpo=45021]: 修复了在使用 concurrent.futures 模块时，fork 的子进程在关闭时可能出现的死锁问题。

bpo-39039 [https://bugs.python.org/issue?@action=redirect&bpo=39039]: 当文件提取过程中发生 zlib 错误时，tarfile.open 会引发 ReadError。

bpo-44594 [https://bugs.python.org/issue?@action=redirect&bpo=44594]: 修复了 ExitStack 和 AsyncExitStack 异常链的一个边缘情况。当异常在传播过程中 __context__ 被显式设置为 None 时，它们现在将匹配 with 块的行为。

bpo-44295 [https://bugs.python.org/issue?@action=redirect&bpo=44295]: Ensure deprecation warning from assertDictContainsSubset() points at calling code - by Anthony Sottile.

bpo-43498 [https://bugs.python.org/issue?@action=redirect&bpo=43498]: 避免在调整 ProcessPoolExecutor 的进程计数时可能出现的*“RuntimeError: dictionary changed size during iteration”*。

文档

bpo-45640 [https://bugs.python.org/issue?@action=redirect&bpo=45640]: 文档中正确标记的语法标记现在可点击，并带你到给定语法部分的定义。由Arthur Milchior提供补丁。

bpo-45788 [https://bugs.python.org/issue?@action=redirect&bpo=45788]: 将sys.prefix的文档链接到sysconfig文档的安装路径部分。

bpo-45772 [https://bugs.python.org/issue?@action=redirect&bpo=45772]: socket.socket 的文档被从函数更正为类。

bpo-45392 [https://bugs.python.org/issue?@action=redirect&bpo=45392]: 更新内置 type 的文档字符串，移除冗余行并提及构造器的关键字参数。

bpo-45726 [https://bugs.python.org/issue?@action=redirect&bpo=45726]: 改进 functools.singledispatch() 和 functools.singledispatchmethod 的文档。

bpo-45680 [https://bugs.python.org/issue?@action=redirect&bpo=45680]: 修改关于 GenericAlias 对象的文档，以澄清非容器类也可以实现``__class_getitem__``。由Alex Waygood提供补丁。

bpo-45655 [https://bugs.python.org/issue?@action=redirect&bpo=45655]: 在 typing 模块文档的顶部新增一个“相关的 Python 增强提案（PEP）”部分。由Alex Waygood提供补丁。

bpo-45604 [https://bugs.python.org/issue?@action=redirect&bpo=45604]: 在 multiprocessing.log_to_stderr 函数的文档中添加 level 参数。

bpo-45250 [https://bugs.python.org/issue?@action=redirect&bpo=45250]: 更新文档以说明CPython不总是要求迭代器定义 __iter__。

bpo-45464 [https://bugs.python.org/issue?@action=redirect&bpo=45464]: 在 Built-in Exceptions 文档中提到，由于可能存在内存布局不兼容问题，不建议在单个子类中继承多个异常类型。

bpo-45449 [https://bugs.python.org/issue?@action=redirect&bpo=45449]: 在 collections.abc 中添加关于 PEP 585 [https://www.python.org/dev/peps/pep-0585] 的说明。

bpo-45516 [https://bugs.python.org/issue?@action=redirect&bpo=45516]: 在 importlib.abc.Traversable 文档中添加协议描述。

bpo-20692 [https://bugs.python.org/issue?@action=redirect&bpo=20692]: 添加编程FAQ条目，解释整数字面量属性访问需要在字面量后加空格或使用括号。

bpo-45216 [https://bugs.python.org/issue?@action=redirect&bpo=45216]: 移除 difflib 中额外的方法文档列表。它在pydoc中渲染两次，并且在某些地方已经过时。

bpo-45024 [https://bugs.python.org/issue?@action=redirect&bpo=45024]: collections.abc 文档已扩展，明确涵盖实例和子类检查的工作原理，添加了额外的doctest示例和一个详尽的ABC列表，这些ABC仅通过存在正确的 special methods来测试成员资格。由Raymond Hettinger提供补丁。

bpo-25381 [https://bugs.python.org/issue?@action=redirect&bpo=25381]: 在扩展文档的扩展章节中，更新了一段关于包含异常信息的全局变量的段落。

bpo-43905 [https://bugs.python.org/issue?@action=redirect&bpo=43905]: 扩展了 astuple() 和 asdict() 的文档，警告应用了deepcopy并提供了解决方法。

测试

bpo-19460 [https://bugs.python.org/issue?@action=redirect&bpo=19460]: Add new Test for email.mime.nonmultipart.MIMENonMultipart.

bpo-45835 [https://bugs.python.org/issue?@action=redirect&bpo=45835]: 修复了test_queue测试中多个“feeder”线程的竞态条件。

bpo-45678 [https://bugs.python.org/issue?@action=redirect&bpo=45678]: 添加测试场景，其中 functools.singledispatchmethod 堆叠在已经被两个其他装饰器包装的方法上。由Alex Waygood提供补丁。

bpo-45578 [https://bugs.python.org/issue?@action=redirect&bpo=45578]: 为 dis.distb() 添加测试。

bpo-45678 [https://bugs.python.org/issue?@action=redirect&bpo=45678]: 添加测试以确保 functools.singledispatchmethod 正确包装目标函数的属性。

bpo-45577 [https://bugs.python.org/issue?@action=redirect&bpo=45577]: 在 test_zoneinfo 中为所有 pickle 协议添加子测试。

bpo-45566 [https://bugs.python.org/issue?@action=redirect&bpo=45566]: 修复 test_frozen_pickle``在 ``test_dataclasses 中检查所有 pickle 版本的问题。

bpo-43592 [https://bugs.python.org/issue?@action=redirect&bpo=43592]: test.libregrtest 现在会在默认值对我们的测试套件来说太低时（如经常在macOS上的情况）提高文件描述符的最大数量的软资源限制。

bpo-39679 [https://bugs.python.org/issue?@action=redirect&bpo=39679]: Add more test cases for @functools.singledispatchmethod when combined with @classmethod or @staticmethod.

bpo-45400 [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提交的补丁。

bpo-40173 [https://bugs.python.org/issue?@action=redirect&bpo=40173]: 修复 test.support.import_helper.import_fresh_module()。

bpo-45280 [https://bugs.python.org/issue?@action=redirect&bpo=45280]: 为空的 typing.NamedTuple 添加测试用例。

bpo-45269 [https://bugs.python.org/issue?@action=redirect&bpo=45269]: 覆盖当向 c_make_encoder 提供无效 markers 类型的情况。

bpo-45128 [https://bugs.python.org/issue?@action=redirect&bpo=45128]: 修复由于 test_logging 和 sys.modules 操作导致的 test_multiprocessing_fork 失败。

bpo-45209 [https://bugs.python.org/issue?@action=redirect&bpo=45209]: 修复 _test_multiprocessing._TestSharedMemory.test_shared_memory_cleaned_after_process_termination 中的 UserWarning: resource_tracker 警告。

bpo-45195 [https://bugs.python.org/issue?@action=redirect&bpo=45195]: 修复 test_readline.test_nonascii()：有时，换行符不会在末尾写入，因此不要期望在输出中看到它。Victor Stinner 提供的补丁。

bpo-45156 [https://bugs.python.org/issue?@action=redirect&bpo=45156]: 修复了由 create_autospec() 创建的模拟在 unittest.mock.seal() 上的无限循环问题。

bpo-45125 [https://bugs.python.org/issue?@action=redirect&bpo=45125]: 改进了 SharedMemory 和 SharableList 对象的序列化测试和文档。

bpo-44860 [https://bugs.python.org/issue?@action=redirect&bpo=44860]: 为 posix_user 方案更新 test_sysconfig.test_user_similar()：platlib 不使用 sys.platlibdir。Victor Stinner 提供的补丁。

bpo-25130 [https://bugs.python.org/issue?@action=redirect&bpo=25130]: 在测试中添加 gc.collect() 的调用以支持 PyPy。

构建

bpo-44035 [https://bugs.python.org/issue?@action=redirect&bpo=44035]: CI现在验证autoconf文件是否已使用当前且未打补丁的autoconf包重新生成。

bpo-33393 [https://bugs.python.org/issue?@action=redirect&bpo=33393]: 更新 config.guess 至 2021-06-03 和 config.sub 至 2021-08-14。Makefile 现在有一个 update-config 目标，使更新更加方便。

bpo-45866 [https://bugs.python.org/issue?@action=redirect&bpo=45866]: make regen-all 现在在源树之外的目录运行时产生相同的输出：当在源树之外构建 Python 时。pegen 现在去除 "generated by pygen from <FILENAME>" 头部的目录。由 Victor Stinner 提供的补丁。

bpo-41498 [https://bugs.python.org/issue?@action=redirect&bpo=41498]: Python 现在可以在没有 sigset_t 的平台上编译。当 sigset_t 缺失时，signal 中的几个函数不可用。

基于 Roman Yurchak 为 pyodide 提供的补丁。

bpo-45881 [https://bugs.python.org/issue?@action=redirect&bpo=45881]: setup.py 现在首先使用环境中的 CC 来发现多架构和交叉编译路径。

bpo-43158 [https://bugs.python.org/issue?@action=redirect&bpo=43158]: setup.py 现在使用来自配置脚本的值来构建 _uuid 扩展模块。配置现在也能检测util-linux的 libuuid。

bpo-45571 [https://bugs.python.org/issue?@action=redirect&bpo=45571]: Modules/Setup 现在使用 PY_CFLAGS_NODIST 而不是 PY_CFLAGS 来编译共享模块。

bpo-45561 [https://bugs.python.org/issue?@action=redirect&bpo=45561]: 从 $(srcdir) 运行 smelly.py 工具。

bpo-45532 [https://bugs.python.org/issue?@action=redirect&bpo=45532]: 更新 sys.version 使用 main 作为后备信息。由 Jeong YunWon 提供补丁。

bpo-45536 [https://bugs.python.org/issue?@action=redirect&bpo=45536]: configure 脚本现在检查 OpenSSL 头文件和库是否提供所需的 API。大多数常见的 API 都经过验证。此检查能检测到过时或缺失的 OpenSSL。失败不会停止 configure。

bpo-45221 [https://bugs.python.org/issue?@action=redirect&bpo=45221]: 修复了处理 LDFLAGS 和 CPPFLAGS 选项时的回归问题，其中 argparse.parse_known_args() 可能会将选项解释为内置命令行参数之一，例如 -h 寻求帮助。

bpo-45405 [https://bugs.python.org/issue?@action=redirect&bpo=45405]: 防止在使用非 Apple clang 的近期版本运行 configure 时出现 internal configure error。由 David Bohman 提供补丁。

bpo-45220 [https://bugs.python.org/issue?@action=redirect&bpo=45220]: 避免自动使用Windows 11 SDK预览版构建。可以通过在构建前设置``DefaultWindowsSDKVersion``环境变量来覆盖此设置。

bpo-45067 [https://bugs.python.org/issue?@action=redirect&bpo=45067]: ncurses函数extended_color_content是在2017年引入的

(https://invisible-island.net/ncurses/NEWS.html#index-t20170401)。

CentOS 7中的ncurses-devel包有一个较旧版本的ncurses，导致编译错误。为了编译支持扩展颜色的ncurses，我们验证ncurses库的版本>=20170401。

Windows

bpo-45901 [https://bugs.python.org/issue?@action=redirect&bpo=45901]: 当通过 Microsoft Store 安装并设置为 *.py 文件的默认应用时，现在在调用脚本时无需显式启动 Python（即 script.py args 而非 python script.py args）即可将命令行参数传递给 Python。

bpo-45616 [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。

bpo-45732 [https://bugs.python.org/issue?@action=redirect&bpo=45732]: 更新捆绑的 Tcl/Tk 至 8.6.12。

bpo-45720 [https://bugs.python.org/issue?@action=redirect&bpo=45720]: 移除了对 shlwapi.dll 的内部引用以帮助提高启动时间。此 DLL 将不再在每个 Python 进程启动时加载。

bpo-43652 [https://bugs.python.org/issue?@action=redirect&bpo=43652]: 这次真的更新 Tcl/Tk 到 8.6.11。之前的更新错误地包含了 8.6.10。

bpo-45337 [https://bugs.python.org/issue?@action=redirect&bpo=45337]: venv 现在会在创建的环境可能需要通过不同的路径访问时发出警告，由于重定向、链接或连接点。现在它还能在需要替代路径时正确安装或升级组件。

macOS

bpo-45732 [https://bugs.python.org/issue?@action=redirect&bpo=45732]: 更新 python.org macOS 安装程序以使用 Tcl/Tk 8.6.12。

bpo-44828 [https://bugs.python.org/issue?@action=redirect&bpo=44828]: 避免在使用python.org macOS安装程序提供的Tk 8.6.11时，在macOS 12 Monterey上出现tkinter文件对话框失败的问题。由Tk项目的Marc Culler提供补丁。

bpo-34602 [https://bugs.python.org/issue?@action=redirect&bpo=34602]: 在 macOS 上使用 ./configure --with-undefined-behavior-sanitizer --with-pydebug 构建 CPython 时，现在将栈大小翻两番以允许整个测试套件通过。

IDLE

bpo-45495 [https://bugs.python.org/issue?@action=redirect&bpo=45495]: 将上下文关键词'case'和'match'添加到补全列表中。

bpo-45296 [https://bugs.python.org/issue?@action=redirect&bpo=45296]: 在 Windows 上，将退出/退出的提示信息改为建议使用 Ctrl-D（这是有效的），而不是 <Ctrl-Z Return>（在 IDLE 中无效）。

bpo-45193 [https://bugs.python.org/issue?@action=redirect&bpo=45193]: 使完成框在 Ubuntu 上再次出现。

工具/示例

bpo-44786 [https://bugs.python.org/issue?@action=redirect&bpo=44786]: 修复c-analyzer脚本中正则表达式的警告。

C API

bpo-39026 [https://bugs.python.org/issue?@action=redirect&bpo=39026]: 修复 Python.h 以使用 Xcode 构建 C 扩展：从 Include/cpython/pystate.h 中移除一个相对包含。

bpo-45307 [https://bugs.python.org/issue?@action=redirect&bpo=45307]: Restore the private C API function _PyImport_FindExtensionObject(). It will be removed in Python 3.11.

bpo-44687 [https://bugs.python.org/issue?@action=redirect&bpo=44687]: BufferedReader.peek() 在文件已全部缓冲时不再引发 ValueError。

bpo-44751 [https://bugs.python.org/issue?@action=redirect&bpo=44751]: 从公共 Python.h 头文件中移除 crypt.h 包含。

Python 3.10.0 final

Release date: 2021-10-04

核心与内置函数

bpo-45121 [https://bugs.python.org/issue?@action=redirect&bpo=45121]: 修复了当直接调用或通过 super() 调用时，Protocol.__init__ 会引发``RecursionError``的问题。由Yurii Karabas提供补丁。

库

bpo-45234 [https://bugs.python.org/issue?@action=redirect&bpo=45234]: 修复了 copyfile(), copy(), copy2() 中的一个回归问题，当源是目录时不应抛出 FileNotFoundError 而应抛出 IsADirectoryError。

文档

bpo-45216 [https://bugs.python.org/issue?@action=redirect&bpo=45216]: 移除 difflib 中额外的方法文档列表。它在pydoc中渲染两次，并且在某些地方已经过时。

bpo-45024 [https://bugs.python.org/issue?@action=redirect&bpo=45024]: collections.abc 文档已扩展，明确涵盖实例和子类检查的工作原理，添加了额外的doctest示例和一个详尽的ABC列表，这些ABC仅通过存在正确的 special methods来测试成员资格。由Raymond Hettinger提供补丁。

测试

bpo-45128 [https://bugs.python.org/issue?@action=redirect&bpo=45128]: 修复由于 test_logging 和 sys.modules 操作导致的 test_multiprocessing_fork 失败。

bpo-44860 [https://bugs.python.org/issue?@action=redirect&bpo=44860]: 为 posix_user 方案更新 test_sysconfig.test_user_similar()：platlib 不使用 sys.platlibdir。Victor Stinner 提供的补丁。

构建

bpo-45067 [https://bugs.python.org/issue?@action=redirect&bpo=45067]: ncurses函数extended_color_content是在2017年引入的

(https://invisible-island.net/ncurses/NEWS.html#index-t20170401)。

CentOS 7中的ncurses-devel包有一个较旧版本的ncurses，导致编译错误。为了编译支持扩展颜色的ncurses，我们验证ncurses库的版本>=20170401。

IDLE

bpo-45193 [https://bugs.python.org/issue?@action=redirect&bpo=45193]: 使完成框在 Ubuntu 上再次出现。

C API

bpo-45307 [https://bugs.python.org/issue?@action=redirect&bpo=45307]: Restore the private C API function _PyImport_FindExtensionObject(). It will be removed in Python 3.11.

Python 3.10.0 release candidate 2

Release date: 2021-09-07

安全性

bpo-42278 [https://bugs.python.org/issue?@action=redirect&bpo=42278]: 将 tempfile.mktemp() 的使用替换为 TemporaryDirectory，以避免潜在的竞态条件。

bpo-44394 [https://bugs.python.org/issue?@action=redirect&bpo=44394]: Update the vendored copy of libexpat to 2.4.1 (from 2.2.8) to get the fix for the CVE-2013-0340 "Billion Laughs" vulnerability. This copy is most used on Windows and macOS.

bpo-43124 [https://bugs.python.org/issue?@action=redirect&bpo=43124]: 在 smtplib 中的内部函数 putcmd 现在会对输入进行 \r 和 \n 字符的清理，以避免（不太可能的）命令注入。

核心与内置函数

bpo-45123 [https://bugs.python.org/issue?@action=redirect&bpo=45123]: 修复PyAiter_Check仅检查__anext__的存在（不检查__aiter__）。将PyAiter_Check重命名为PyAIter_Check，PyObject_GetAiter -> PyObject_GetAIter。

bpo-45018 [https://bugs.python.org/issue?@action=redirect&bpo=45018]: Fixed pickling of range iterators that iterated for over 2**32 times.

bpo-45000 [https://bugs.python.org/issue?@action=redirect&bpo=45000]: A SyntaxError is now raised when trying to delete __debug__. Patch by Dong-hee Na.

bpo-44963 [https://bugs.python.org/issue?@action=redirect&bpo=44963]: 为 anext_awaitable``对象实现 ``send() 和 throw() 方法。由Pablo Galindo提供补丁。

bpo-44962 [https://bugs.python.org/issue?@action=redirect&bpo=44962]: 修复了WeakKeyDictionary、WeakValueDictionary和WeakSet中当两个线程尝试提交最后一个待处理的移除时的竞争条件。这修复了asyncio.create_task并修复了asyncio.run中shutdown_asyncgens未运行导致的数据丢失问题。

bpo-44954 [https://bugs.python.org/issue?@action=redirect&bpo=44954]: 修复了一个边界情况下的bug，即 float.fromhex('0x.8p-1074') 的结果错误地四舍五入。

bpo-44947 [https://bugs.python.org/issue?@action=redirect&bpo=44947]: 改进了导入语句中尾随逗号的语法错误提示。由Pablo Galindo提供补丁。

bpo-44698 [https://bugs.python.org/issue?@action=redirect&bpo=44698]: 恢复了类型为 float 或 complex 的整数值指数的复数幂运算行为。

bpo-44885 [https://bugs.python.org/issue?@action=redirect&bpo=44885]: 修正了带有格式规范和重复表达式的f字符串的ast位置。补丁由Pablo Galindo提供。

bpo-44872 [https://bugs.python.org/issue?@action=redirect&bpo=44872]: 在 frameobject.c 中使用新的 trashcan 宏（Py_TRASHCAN_BEGIN/END）代替旧的宏（Py_TRASHCAN_SAFE_BEGIN/END）。

bpo-33930 [https://bugs.python.org/issue?@action=redirect&bpo=33930]: 修复了在清理方法对象时因深度递归导致的段错误。由 Augusto Goulart 和 Pablo Galindo 提供补丁。

bpo-25782 [https://bugs.python.org/issue?@action=redirect&bpo=25782]: 修复了当当前异常的上下文链中存在循环时，PyErr_SetObject 挂起的错误。

bpo-44856 [https://bugs.python.org/issue?@action=redirect&bpo=44856]: 修复了 update_bases() 和 __build_class__ 错误路径中的引用泄漏问题。由 Pablo Galindo 提供补丁。

bpo-44838 [https://bugs.python.org/issue?@action=redirect&bpo=44838]: 修复了一个导致解析器为无效的 'if' 表达式引发不正确自定义 SyntaxError 的错误。由 Pablo Galindo 提供补丁。

bpo-44584 [https://bugs.python.org/issue?@action=redirect&bpo=44584]: The threading debug (PYTHONTHREADDEBUG environment variable) is deprecated in Python 3.10 and will be removed in Python 3.12. This feature requires a debug build of Python. Patch by Victor Stinner.

bpo-39091 [https://bugs.python.org/issue?@action=redirect&bpo=39091]: 修复向生成器的 throw() 方法传递非异常对象时导致的崩溃。由 Noah Oxer 提供补丁。

库

bpo-45081 [https://bugs.python.org/issue?@action=redirect&bpo=45081]: 修复了继承自 typing.Protocol 子类的数据类具有错误 __init__ 的问题。由 Yurii Karabas 提供补丁。

bpo-41620 [https://bugs.python.org/issue?@action=redirect&bpo=41620]: run() 现在总是返回一个 TestResult 实例。之前如果测试类或方法使用了跳过装饰器，它会返回 None。

bpo-43913 [https://bugs.python.org/issue?@action=redirect&bpo=43913]: 修复了在 unittest 中清理类和模块时的错误：

使用 addModuleCleanup() 注册的函数不会被调用，除非用户在测试模块中定义了 tearDownModule()。

如果 tearDownClass 设置为 None，使用 addClassCleanup() 注册的函数不会被调用。

TestResult 中的缓冲功能对使用 addClassCleanup() 和 addModuleCleanup() 注册的函数无效。

在缓冲和调试模式下，使用 addClassCleanup() 和 addModuleCleanup() 注册的函数中的错误未被正确处理。

setUpModule() 和使用 addModuleCleanup() 注册的函数中的错误以错误的顺序报告。

以及几个较小的错误。

bpo-45030 [https://bugs.python.org/issue?@action=redirect&bpo=45030]: 修复了在序列化和复制 range 迭代器时的整数溢出问题。

bpo-45001 [https://bugs.python.org/issue?@action=redirect&bpo=45001]: 使电子邮件日期解析对格式错误的输入更加健壮，特别是针对仅包含空白的 Date: 头。由 Wouter Bolsterlee 提供补丁。

bpo-44449 [https://bugs.python.org/issue?@action=redirect&bpo=44449]: Fix a crash in the signal handler of the faulthandler module: no longer modify the reference count of frame objects. Patch by Victor Stinner.

bpo-44955 [https://bugs.python.org/issue?@action=redirect&bpo=44955]: 对于 run() 中隐式创建的 TestResult 对象，方法 stopTestRun() 现在总是与方法 startTestRun() 成对调用。之前，对于使用跳过装饰器装饰的测试方法和类，它不会被调用。

bpo-44935 [https://bugs.python.org/issue?@action=redirect&bpo=44935]: subprocess on Solaris now also uses os.posix_spawn() for better performance.

bpo-44911 [https://bugs.python.org/issue?@action=redirect&bpo=44911]: IsolatedAsyncioTestCase 在取消泄漏任务时将不再抛出异常。由 Bar Harel 提供补丁。

bpo-44524 [https://bugs.python.org/issue?@action=redirect&bpo=44524]: 当从 typing 特殊形式别名子类化时，使异常消息更有用。由 Yurii Karabas 提供补丁。

bpo-38956 [https://bugs.python.org/issue?@action=redirect&bpo=38956]: 当与 argparse.ArgumentDefaultsHelpFormatter 一起使用时，argparse.BooleanOptionalAction 的默认值不再打印两次。

bpo-44860 [https://bugs.python.org/issue?@action=redirect&bpo=44860]: 修复 sysconfig 中的 posix_user 方案，使其不依赖于 sys.platlibdir。

bpo-44581 [https://bugs.python.org/issue?@action=redirect&bpo=44581]: 将捆绑的 pip 升级到 21.2.3 和 setuptools 到 57.4.0。

bpo-44849 [https://bugs.python.org/issue?@action=redirect&bpo=44849]: Fix the os.set_inheritable() function on FreeBSD 14 for file descriptor opened with the O_PATH flag: ignore the EBADF error on ioctl(), fallback on the fcntl() implementation. Patch by Victor Stinner.

bpo-44605 [https://bugs.python.org/issue?@action=redirect&bpo=44605]: @functools.total_ordering() 装饰器现在可以与元类一起工作。

bpo-44524 [https://bugs.python.org/issue?@action=redirect&bpo=44524]: 修复了一个问题，其中订阅的特殊形式的 __name__ 和 __qualname__ 属性可能是 None。

bpo-44822 [https://bugs.python.org/issue?@action=redirect&bpo=44822]: sqlite3 用户定义的函数和聚合器返回带有嵌入 NUL 字符的 strings 不再被截断。由 Erlend E. Aasland 提供补丁。

bpo-44801 [https://bugs.python.org/issue?@action=redirect&bpo=44801]: 确保 Callable 中的 ParamSpec 变量只能被参数表达式（类型列表、省略号、ParamSpec 或 Concatenate）替换。

bpo-27334 [https://bugs.python.org/issue?@action=redirect&bpo=27334]: sqlite3 上下文管理器现在在提交失败时执行回滚（从而释放数据库锁）。补丁由Luca Citi和Erlend E. Aasland提供。

bpo-41402 [https://bugs.python.org/issue?@action=redirect&bpo=41402]: 修复 email.message.EmailMessage.set_content() 当使用二进制数据和 7bit 内容传输编码调用时的问题。

bpo-32695 [https://bugs.python.org/issue?@action=redirect&bpo=32695]: tarfile.open() 的 compresslevel 和 preset 关键字参数现在都已记录并测试。

bpo-34990 [https://bugs.python.org/issue?@action=redirect&bpo=34990]: 修复了 compileall 模块中的一个 Y2k38 错误，该错误会导致在 2038 年后修改的文件编译失败。

bpo-38840 [https://bugs.python.org/issue?@action=redirect&bpo=38840]: 在没有共享内存实现的平台上修复 test___all__。

bpo-26228 [https://bugs.python.org/issue?@action=redirect&bpo=26228]: pty.spawn在FreeBSD、macOS和Solaris上不再挂起。

bpo-33349 [https://bugs.python.org/issue?@action=redirect&bpo=33349]: lib2to3现在在任何地方都能识别异步生成器。

文档

bpo-44957 [https://bugs.python.org/issue?@action=redirect&bpo=44957]: 尽可能使用PEP 604联合语法来推广它。此外，在关于 Union 的部分更突出地提到``X | Y``，并在关于 Optional 的部分提到 X | None。

bpo-44903 [https://bugs.python.org/issue?@action=redirect&bpo=44903]: Removed the othergui.rst file, any references to it, and the list of GUI frameworks in the FAQ. In their place I've added links to the Python Wiki page on GUI frameworks.

bpo-33479 [https://bugs.python.org/issue?@action=redirect&bpo=33479]: Tkinter文档大幅扩展，新增了“架构”和“线程模型”部分。

bpo-36700 [https://bugs.python.org/issue?@action=redirect&bpo=36700]: base64 RFC引用已更新指向 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html]；新增了一个部分指向用户RFC的新“安全考虑”部分。

bpo-44756 [https://bugs.python.org/issue?@action=redirect&bpo=44756]: Reverted automated virtual environment creation on make html when building documentation. It turned out to be disruptive for downstream distributors.

bpo-42958 [https://bugs.python.org/issue?@action=redirect&bpo=42958]: 更新了 filecmp.cmp() 的文档字符串和文档，使其更加准确且不易混淆，特别是关于 shallow 参数的部分。

bpo-43066 [https://bugs.python.org/issue?@action=redirect&bpo=43066]: 向 zipfile 文档添加警告：带有前导斜杠的文件名参数可能导致在Windows系统上无法打开存档。

bpo-39452 [https://bugs.python.org/issue?@action=redirect&bpo=39452]: 重写了 Doc/library/__main__.rst。扩大了文档的范围，明确讨论并区分了包中的 __main__.py 与 __name__ == '__main__' 表达式（及其周围的惯用法）。

bpo-27752 [https://bugs.python.org/issue?@action=redirect&bpo=27752]: csv.Dialect的文档更加描述性。

bpo-41576 [https://bugs.python.org/issue?@action=redirect&bpo=41576]: 记录了BaseException优于裸except

bpo-39498 [https://bugs.python.org/issue?@action=redirect&bpo=39498]: 添加一个“安全考虑”索引，链接到有明确记录安全考虑的标准库模块。

bpo-33479 [https://bugs.python.org/issue?@action=redirect&bpo=33479]: 移除了关于 tkinter 线程安全的未经证实的声明。这一说法已经多年不成立，可能从来就不是真的。关于什么是真的解释可能会在更多的讨论之后，甚至可能在修补 _tkinter.c 之后添加。

测试

bpo-45052 [https://bugs.python.org/issue?@action=redirect&bpo=45052]: WithProcessesTestSharedMemory.test_shared_memory_basics 测试被忽略，因为 self.assertEqual(sms.size, sms2.size) 行失败。现在这一行被移除，测试不再跳过。

从测试中移除这一行的主要动机是 SharedMemory 的 size 并不保证总是相同。它由平台决定。

bpo-45042 [https://bugs.python.org/issue?@action=redirect&bpo=45042]: 修复了使用 @hashlib_helper.requires_hashdigest 装饰的测试类总是被跳过的问题。

bpo-45011 [https://bugs.python.org/issue?@action=redirect&bpo=45011]: Made tests relying on the _asyncio C extension module optional to allow running on alternative Python implementations. Patch by Serhiy Storchaka.

bpo-44949 [https://bugs.python.org/issue?@action=redirect&bpo=44949]: 修复 test_readline 的自动历史测试：有时，换行符不会在末尾写入，因此不要期望它在输出中出现。

bpo-44891 [https://bugs.python.org/issue?@action=redirect&bpo=44891]: 添加了测试以澄清当在 str 和 bytes 对象上使用 obj * 1 时 id() 被保留。由 Nikita Sobolev 提供补丁。

bpo-44852 [https://bugs.python.org/issue?@action=redirect&bpo=44852]: 添加了在运行回归测试套件时全面静默 DeprecationWarnings 的能力。

bpo-40928 [https://bugs.python.org/issue?@action=redirect&bpo=40928]: 通知在 macOS 上运行 test_decimal 回归测试的用户，test_decimal 可能会输出无害的“malloc can't allocate region”消息。

Windows

bpo-45007 [https://bugs.python.org/issue?@action=redirect&bpo=45007]: 在Windows构建中更新到OpenSSL 1.1.1l

macOS

bpo-45007 [https://bugs.python.org/issue?@action=redirect&bpo=45007]: 更新 macOS 安装程序构建以使用 OpenSSL 1.1.1l。

bpo-44689 [https://bugs.python.org/issue?@action=redirect&bpo=44689]: ctypes.util.find_library() 现在在 macOS 11 Big Sur 上即使是在旧版 macOS 上构建的 Python 也能正确工作。之前，当在旧版 macOS 系统上构建时，由于系统库存储方式的改变，find_library 在 Big Sur 上运行时无法找到 macOS 系统库。

Python 3.10.0 release candidate 1

Release date: 2021-08-02

安全性

bpo-44600 [https://bugs.python.org/issue?@action=redirect&bpo=44600]: 修复在 match 语句中跟踪某些失败模式时的错误行号。由 Charles Burkland 提供补丁。

核心与内置函数

bpo-44792 [https://bugs.python.org/issue?@action=redirect&bpo=44792]: 为 if 表达式改进语法错误。由 Miguel Brito 提供补丁

bpo-34013 [https://bugs.python.org/issue?@action=redirect&bpo=34013]: 将无效的旧版语句自定义错误消息（如调用 "print" 时未加括号生成的消息）泛化，以包含更通用的表达式。由 Pablo Galindo 提供补丁

bpo-44732 [https://bugs.python.org/issue?@action=redirect&bpo=44732]: 将 types.Union 重命名为 types.UnionType。

bpo-44698 [https://bugs.python.org/issue?@action=redirect&bpo=44698]: 修复复杂对象求幂中的未定义行为。

bpo-44653 [https://bugs.python.org/issue?@action=redirect&bpo=44653]: 在联合类型中的参数替换中支持 typing 类型。

bpo-44676 [https://bugs.python.org/issue?@action=redirect&bpo=44676]: 增加序列化 types.Union 对象的能力。由 Yurii Karabas 提供补丁。

bpo-44633 [https://bugs.python.org/issue?@action=redirect&bpo=44633]: Parameter substitution of the union type with wrong types now raises TypeError instead of returning NotImplemented.

bpo-44662 [https://bugs.python.org/issue?@action=redirect&bpo=44662]: 向 types.Union 添加 __module__。这也修复了 types.Union 与 typing.Annotated 的问题。由 Yurii Karabas 提供补丁。

bpo-44655 [https://bugs.python.org/issue?@action=redirect&bpo=44655]: 在未设置的 __slots__ 属性错误中包括类型名称。由 Pablo Galindo 提供补丁。

bpo-44655 [https://bugs.python.org/issue?@action=redirect&bpo=44655]: 当为缺失属性提供建议时，不包括与失败属性同名的缺失属性。由 Pablo Galindo 提供补丁。

bpo-44646 [https://bugs.python.org/issue?@action=redirect&bpo=44646]: 修复联合类型的哈希值：它不再依赖于参数的顺序。

bpo-44636 [https://bugs.python.org/issue?@action=redirect&bpo=44636]: 合并相同类型的联合。例如，int | int 的结果现在是 int。修复与非可哈希对象的联合类型比较。例如，int | str == {} 不再引发 TypeError。

bpo-44635 [https://bugs.python.org/issue?@action=redirect&bpo=44635]: 在联合类型构造函数中将 None 转换为 type(None)。

bpo-44589 [https://bugs.python.org/issue?@action=redirect&bpo=44589]: match 语句中具有两个或更多相等字面键的映射模式现在会在编译时引发 SyntaxError。

bpo-44606 [https://bugs.python.org/issue?@action=redirect&bpo=44606]: 修复联合类型的 __instancecheck__ 和 __subclasscheck__。

bpo-42073 [https://bugs.python.org/issue?@action=redirect&bpo=42073]: @classmethod 装饰器现在可以包装其他类似 classmethod 的描述符。

bpo-44490 [https://bugs.python.org/issue?@action=redirect&bpo=44490]: typing 现在会在 types.Union 对象中搜索类型参数。get_type_hints``也将正确解析带有嵌套 ``types.Union 对象的注解。由Yurii Karabas提供补丁。

bpo-44490 [https://bugs.python.org/issue?@action=redirect&bpo=44490]: 向 types.Union 添加 __parameters__ 属性和 __getitem__ 操作符。由 Yurii Karabas 提供补丁。

bpo-44472 [https://bugs.python.org/issue?@action=redirect&bpo=44472]: 修复当异常被抛出时的 ltrace 功能。由 Pablo Galindo 提供补丁。

库

bpo-44806 [https://bugs.python.org/issue?@action=redirect&bpo=44806]: typing.Protocol 的非协议子类现在会忽略从协议基类继承的 __init__ 方法。

bpo-44793 [https://bugs.python.org/issue?@action=redirect&bpo=44793]: 修复在订阅带有 ParamSpec 参数的泛型类型时检查参数数量的问题。

bpo-44784 [https://bugs.python.org/issue?@action=redirect&bpo=44784]: 在 importlib.metadata 测试中，覆盖在预期的 DeprecationWarnings 下的警告行为（importlib_metadata 4.6.3）。

bpo-44667 [https://bugs.python.org/issue?@action=redirect&bpo=44667]: tokenize.tokenize() 不会在源代码不以换行符结束但最后一行是注释时错误地生成 NEWLINE 令牌，因为该函数已经生成了一个 NL 令牌。由 Pablo Galindo 提供补丁。

bpo-44752 [https://bugs.python.org/issue?@action=redirect&bpo=44752]: rcompleter 不在 property 对象上调用 getattr() 以避免评估相应方法的副作用。

bpo-44720 [https://bugs.python.org/issue?@action=redirect&bpo=44720]: weakref.proxy 对象引用非迭代器现在会引发 TypeError，而不是解引用空的 tp_iternext 槽并崩溃。

bpo-44704 [https://bugs.python.org/issue?@action=redirect&bpo=44704]: collections.abc.Set._hash() 的实现现在与 frozenset.__hash__() 的实现匹配。

bpo-44666 [https://bugs.python.org/issue?@action=redirect&bpo=44666]: 修复了当 sys.stdout 被重定向时 compileall.compile_file() 的问题。由 Stefan Hölzl 提供补丁。

bpo-42854 [https://bugs.python.org/issue?@action=redirect&bpo=42854]: Fixed a bug in the _ssl module that was throwing OverflowError when using _ssl._SSLSocket.write() and _ssl._SSLSocket.read() for a big value of the len parameter. Patch by Pablo Galindo

bpo-44353 [https://bugs.python.org/issue?@action=redirect&bpo=44353]: 将 typing.NewType 从函数重构为可调用类。由Yurii Karabas提供补丁。

bpo-44524 [https://bugs.python.org/issue?@action=redirect&bpo=44524]: 为 typing 模块类添加缺失的 __name__ 和 __qualname__ 属性。补丁由Yurii Karabas提供。

bpo-40897 [https://bugs.python.org/issue?@action=redirect&bpo=40897]: 在 inspect.signature() 中优先使用当前类的构造函数。由Weipeng Hong提供补丁。

bpo-44648 [https://bugs.python.org/issue?@action=redirect&bpo=44648]: 修复了 inspect.getsource() 在检查交互式会话中的类时抛出的错误。应该是带有适当错误消息的 OSError，而不是 TypeError。

bpo-44608 [https://bugs.python.org/issue?@action=redirect&bpo=44608]: Fix memory leak in _tkinter._flatten() if it is called with a sequence or set, but not list or tuple.

bpo-44559 [https://bugs.python.org/issue?@action=redirect&bpo=44559]: [Enum] module reverted to 3.9; 3.10 changes pushed until 3.11

bpo-41928 [https://bugs.python.org/issue?@action=redirect&bpo=41928]: 更新 shutil.copyfile()，当以 os.path.sep 结尾的路径不存在时，抛出 FileNotFoundError 而不是混淆的 IsADirectoryError；shutil.copy() 和 shutil.copy2() 也会受到影响。

bpo-44566 [https://bugs.python.org/issue?@action=redirect&bpo=44566]: 处理由 @contextlib.contextmanager 生成器引发的 StopIteration 子类。

bpo-41249 [https://bugs.python.org/issue?@action=redirect&bpo=41249]: 修正 TypedDict 以使其能与 typing.get_type_hints() 和跨模块的注解延迟求值一起工作。

bpo-44461 [https://bugs.python.org/issue?@action=redirect&bpo=44461]: 修复 pdb 处理由于包没有 __main__ 模块而导致的导入错误的 bug。

bpo-43625 [https://bugs.python.org/issue?@action=redirect&bpo=43625]: 修复 csv.Sniffer.has_header() 检测 CSV 文件头时的 bug，并改进相关文档。

bpo-42892 [https://bugs.python.org/issue?@action=redirect&bpo=42892]: 修复 email.message.EmailMessage 在解析格式错误的多部分邮件时抛出的异常。

bpo-27827 [https://bugs.python.org/issue?@action=redirect&bpo=27827]: pathlib.PureWindowsPath.is_reserved() 现在能识别更多保留文件名，包括那些带有尾部空格或冒号的文件名。

bpo-38741 [https://bugs.python.org/issue?@action=redirect&bpo=38741]: configparser：在节标题中使用 ']' 将不再在 ']' 处截断节名称。

bpo-27513 [https://bugs.python.org/issue?@action=redirect&bpo=27513]: email.utils.getaddresses() 现在接受 email.header.Header 对象以及字符串值。由Zackery Spytz提供补丁。

bpo-29298 [https://bugs.python.org/issue?@action=redirect&bpo=29298]: 修复没有 dest 的必需子解析器未接收到参数时的 TypeError。由Anthony Sottile提供补丁。

文档

bpo-44740 [https://bugs.python.org/issue?@action=redirect&bpo=44740]: Replaced occurences of uppercase "Web" and "Internet" with lowercase versions per the 2016 revised Associated Press Style Book.

bpo-44693 [https://bugs.python.org/issue?@action=redirect&bpo=44693]: 通过替换混淆的词汇"伪模块"为更准确的描述，更新了术语表中__future__的定义。

bpo-35183 [https://bugs.python.org/issue?@action=redirect&bpo=35183]: 向os.path.splitext文档添加典型示例

bpo-30511 [https://bugs.python.org/issue?@action=redirect&bpo=30511]: 澄清由于依赖改变当前工作目录，shutil.make_archive() 不是线程安全的。

bpo-44561 [https://bugs.python.org/issue?@action=redirect&bpo=44561]: 更新Doc/distributing/index.rst中三个过期的超链接："项目结构"、"构建和打包项目"以及"将项目上传到Python包索引"。

bpo-44613 [https://bugs.python.org/issue?@action=redirect&bpo=44613]: importlib.metadata不再处于临时状态。

bpo-44544 [https://bugs.python.org/issue?@action=redirect&bpo=44544]: 列出 textwrap.wrap()、textwrap.fill() 和 textwrap.shorten() 的所有kwargs。现在，有导航链接指向 TextWrap 的属性，这使得在文档中导航更加容易，同时最小化了重复。

bpo-44453 [https://bugs.python.org/issue?@action=redirect&bpo=44453]: 修复了 sysconfig.get_path() 返回类型的文档。

测试

bpo-44734 [https://bugs.python.org/issue?@action=redirect&bpo=44734]: Fixed floating point precision issue in turtle tests.

bpo-44708 [https://bugs.python.org/issue?@action=redirect&bpo=44708]: 回归测试现在在使用 -w 运行时，仅重新运行受影响的测试方法，而不是重新运行整个测试文件。

bpo-44647 [https://bugs.python.org/issue?@action=redirect&bpo=44647]: 向回归测试添加了一个永久的 Unicode 值环境变量，以确保它们将来能处理这种用例。如果您的测试环境因此中断，请向我们报告错误，并在测试环境中临时设置 PYTHONREGRTEST_UNICODE_GUARD=0。

bpo-44515 [https://bugs.python.org/issue?@action=redirect&bpo=44515]: 调整最近添加的contextlib测试，避免假设使用引用计数的垃圾回收。

Windows

bpo-44572 [https://bugs.python.org/issue?@action=redirect&bpo=44572]: 避免在 platform 模块中消耗标准输入

bpo-40263 [https://bugs.python.org/issue?@action=redirect&bpo=40263]: 这是 https://bugs.python.org/issue26903 的后续错误。一旦应用了该修复，我们会遇到一个差一的断言问题。该断言不正确。

macOS

bpo-41972 [https://bugs.python.org/issue?@action=redirect&bpo=41972]: 修改框架构建在 sysconfig 中的用户头文件路径，添加 'pythonX.Y' 组件以匹配 distutils 的行为。

bpo-34932 [https://bugs.python.org/issue?@action=redirect&bpo=34932]: 为 macOS 添加 socket.TCP_KEEPALIVE 支持。由 Shane Harvey 提供补丁。

工具/示例

bpo-44756 [https://bugs.python.org/issue?@action=redirect&bpo=44756]: In the Makefile for documentation (Doc/Makefile), the build rule is dependent on the venv rule. Therefore, html, latex, and other build-dependent rules are also now dependent on venv. The venv rule only performs an action if $(VENVDIR) does not exist. Doc/README.rst was updated; most users now only need to type make html.

C API

bpo-41103 [https://bugs.python.org/issue?@action=redirect&bpo=41103]: 恢复旧缓冲区协议的移除，因为它们是稳定 ABI 的一部分。

bpo-42747 [https://bugs.python.org/issue?@action=redirect&bpo=42747]: Py_TPFLAGS_HAVE_VERSION_TAG 类型标志现在不做任何事情。Py_TPFLAGS_HAVE_AM_SEND 标志（在 3.10 中添加）被移除。这两者都是不必要的，因为不可能有相关字段缺失的类型对象。

Python 3.10.0 beta 4

Release date: 2021-07-10

安全性

bpo-41180 [https://bugs.python.org/issue?@action=redirect&bpo=41180]: 向 marshal 模块添加审计事件，并停止为每个解组的代码对象引发 code.__init__ 事件。直接实例化的代码对象将继续引发事件，审计事件处理程序应检查或收集原始 marshal 数据。这减少了从 .pyc 文件加载时的显著性能开销。

核心与内置函数

bpo-44562 [https://bugs.python.org/issue?@action=redirect&bpo=44562]: 在初始化 types.GenericAlias 时，错误路径中移除 PyObject_GC_Del() 的使用。

bpo-41486 [https://bugs.python.org/issue?@action=redirect&bpo=41486]: 修复了早期3.10 beta版本中，如果有人在输入数据扩展超过4GiB时使用大于4GiB的输出缓冲区与zlib.decompress一起使用时出现的内存消耗和复制性能回归。

bpo-44553 [https://bugs.python.org/issue?@action=redirect&bpo=44553]: 为 types.Union 实现 GC 方法以打破引用循环并防止内存泄漏。

bpo-44523 [https://bugs.python.org/issue?@action=redirect&bpo=44523]: 移除 hash() 对 weakref.proxy 对象的透传，以防止当原始引用对象死亡而代理是可哈希对象的一部分时产生意外后果。由 Pablo Galindo 提供补丁。

bpo-44483 [https://bugs.python.org/issue?@action=redirect&bpo=44483]: 修复在创建具有不良 __module__ 字段的对象的联合时 types.Union 对象的崩溃问题。

bpo-44297 [https://bugs.python.org/issue?@action=redirect&bpo=44297]: Make sure that the line number is set when entering a comprehension scope. Ensures that backtraces inclusing generator expressions show the correct line number.

bpo-44456 [https://bugs.python.org/issue?@action=redirect&bpo=44456]: 改进当混合位置和关键字模式时的语法错误。由 Pablo Galindo 提供补丁。

bpo-44368 [https://bugs.python.org/issue?@action=redirect&bpo=44368]: 改进无效 "as" 目标的语法错误。由 Pablo Galindo 提供补丁

bpo-44317 [https://bugs.python.org/issue?@action=redirect&bpo=44317]: 使用改进的位置信息改进分词器错误。由 Pablo Galindo 提供补丁。

bpo-43667 [https://bugs.python.org/issue?@action=redirect&bpo=43667]: 在 Oracle Solaris 上的非 UTF 语言环境中改进 Unicode 支持。此问题不影响其他 Solaris 系统。

库

bpo-44558 [https://bugs.python.org/issue?@action=redirect&bpo=44558]: Make the implementation consistency of indexOf() between C and Python versions. Patch by Dong-hee Na.

bpo-34798 [https://bugs.python.org/issue?@action=redirect&bpo=34798]: 拆分关于 pprint.PrettyPrinter 构造参数的段落，使其更易于阅读。

bpo-44516 [https://bugs.python.org/issue?@action=redirect&bpo=44516]: 将捆绑的 pip 更新至 21.1.3 版本。

bpo-44468 [https://bugs.python.org/issue?@action=redirect&bpo=44468]: typing.get_type_hints() 现在可以在类和基类中查找带有意外 __module__ 的注解。之前，它会跳过这些MRO元素。

bpo-43977 [https://bugs.python.org/issue?@action=redirect&bpo=43977]: Set the proper Py_TPFLAGS_MAPPING and Py_TPFLAGS_SEQUENCE flags for subclasses created before a parent has been registered as a collections.abc.Mapping or collections.abc.Sequence.

bpo-44482 [https://bugs.python.org/issue?@action=redirect&bpo=44482]: 修复在替代Python实现中 glob 极不可能发生的资源泄漏。

bpo-44466 [https://bugs.python.org/issue?@action=redirect&bpo=44466]: faulthandler 模块现在能检测到在垃圾回收器收集期间是否发生致命错误。由Victor Stinner提供补丁。

bpo-44404 [https://bugs.python.org/issue?@action=redirect&bpo=44404]: tkinter 的 after() 方法现在支持没有 __name__ 属性的可调用对象。

bpo-44458 [https://bugs.python.org/issue?@action=redirect&bpo=44458]: BUFFER_BLOCK_SIZE 现在被声明为静态的，以避免在bz2、lmza或zlib被静态链接时发生链接冲突。

bpo-44464 [https://bugs.python.org/issue?@action=redirect&bpo=44464]: 在弃用的importlib.metadata接口中移除对flake8的异常。与importlib_metadata 4.6同步。

bpo-44446 [https://bugs.python.org/issue?@action=redirect&bpo=44446]: 在 traceback.FrameSummary 中考虑 lineno 可能为 None 的情况。

bpo-44439 [https://bugs.python.org/issue?@action=redirect&bpo=44439]: 修复 bz2.BZ2File.write() / lzma.LZMAFile.write() 方法，当输入数据是支持缓冲协议的对象时，文件长度可能错误的问题。

bpo-44434 [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 提供补丁。

bpo-44395 [https://bugs.python.org/issue?@action=redirect&bpo=44395]: Fix as_string() to pass unixfrom properly. Patch by Dong-hee Na.

bpo-34266 [https://bugs.python.org/issue?@action=redirect&bpo=34266]: 处理解析 pdb 的 run/restart 命令参数时的异常。

bpo-44077 [https://bugs.python.org/issue?@action=redirect&bpo=44077]: It's now possible to receive the type of service (ToS), a.k.a. differentiated services (DS), a.k.a. differenciated services code point (DSCP) and excplicit congestion notification (ECN) IP header fields with socket.IP_RECVTOS.

bpo-43024 [https://bugs.python.org/issue?@action=redirect&bpo=43024]: 改进了 traceback.print_exception()、traceback.format_exception() 和 traceback.format_exception_only() 的帮助签名。

bpo-30256 [https://bugs.python.org/issue?@action=redirect&bpo=30256]: 通过AutoProxy传递multiprocessing BaseProxy参数 manager_owned。

文档

bpo-44558 [https://bugs.python.org/issue?@action=redirect&bpo=44558]: 使 countOf() 的文档字符串和Python实现与其C实现的行为相匹配。

bpo-38062 [https://bugs.python.org/issue?@action=redirect&bpo=38062]: 澄清atexit在内部使用相等比较。

bpo-40620 [https://bugs.python.org/issue?@action=redirect&bpo=40620]: 将教程controlflow.rst第4.3节中的示例转换为解释器演示样式。

bpo-13814 [https://bugs.python.org/issue?@action=redirect&bpo=13814]: 在设计FAQ中，回答了“为什么生成器不支持with语句？”

bpo-41621 [https://bugs.python.org/issue?@action=redirect&bpo=41621]: Document that collections.defaultdict parameter default_factory defaults to None and is positional-only.

测试

bpo-44287 [https://bugs.python.org/issue?@action=redirect&bpo=44287]: 通过使用更长的超时时间来修复asyncio的test_popen()测试_windows_utils。使用军用级经过实战检验的 test.support.SHORT_TIMEOUT 超时而不是硬编码的10秒超时：默认为30秒，但在慢速构建机器人上会更长。由Victor Stinner提供补丁。

bpo-44451 [https://bugs.python.org/issue?@action=redirect&bpo=44451]: 在``test.test_importlib.test_metadata_api.APITests.test_entry_points_by_index``中重置``DeprecationWarning``过滤器，以避免如果 DeprecationWarnings 被忽略时出现``StopIteration``错误。

bpo-30256 [https://bugs.python.org/issue?@action=redirect&bpo=30256]: 添加嵌套队列的测试，当在 ListProxy 和 DictProxy 中使用``multiprocessing``共享对象 AutoProxy[Queue] 时。

构建

bpo-44535 [https://bugs.python.org/issue?@action=redirect&bpo=44535]: 支持在Windows上使用Visual Studio 2022安装进行构建。

bpo-43298 [https://bugs.python.org/issue?@action=redirect&bpo=43298]: 改进了在没有安装Windows SDK时构建的错误消息。

Windows

bpo-44582 [https://bugs.python.org/issue?@action=redirect&bpo=44582]: 使用原生实现加速 mimetypes 模块初始化时的注册表扫描速度。

bpo-41299 [https://bugs.python.org/issue?@action=redirect&bpo=41299]: Fix 16ms jitter when using timeouts in threading, such as with threading.Lock.acquire() or threading.Condition.wait().

C API

bpo-44441 [https://bugs.python.org/issue?@action=redirect&bpo=44441]: 现在 Py_RunMain() 会在退出时将 PyImport_Inittab 重围为其初始值。 必须能够在每次 Python 初始化时调用 PyImport_AppendInittab() 或 PyImport_ExtendInittab()。 由 Victor Stinner 编写补丁。

bpo-40939 [https://bugs.python.org/issue?@action=redirect&bpo=40939]: 移除了关于已移除的 PyParser_* C API的文档。

Python 3.10.0 beta 3

Release date: 2021-06-17

核心与内置函数

bpo-44409 [https://bugs.python.org/issue?@action=redirect&bpo=44409]: 修复在初始化分词器时抛出的分词器错误的位置信息。补丁由 Pablo Galindo 提供。

bpo-44396 [https://bugs.python.org/issue?@action=redirect&bpo=44396]: 修复分词器在抛出未闭合字符串的语法错误时可能崩溃的问题。由 Pablo Galindo 提供补丁。

bpo-44349 [https://bugs.python.org/issue?@action=redirect&bpo=44349]: 修复在显示编码文件中的文本时语法错误的一个边缘情况。由 Pablo Galindo 提供补丁。

bpo-44335 [https://bugs.python.org/issue?@action=redirect&bpo=44335]: 修复识别语法错误中不正确字符时的回归问题。由 Pablo Galindo 提供补丁

bpo-44304 [https://bugs.python.org/issue?@action=redirect&bpo=44304]: 修复 sqlite3 模块中垃圾回收器清除 sqlite.Statement 对象时发生的崩溃。由 Pablo Galindo 提供补丁

bpo-44305 [https://bugs.python.org/issue?@action=redirect&bpo=44305]: 为没有 except 或 finally 块的 try 块改进错误消息。由 Pablo Galindo 提供补丁。

bpo-43833 [https://bugs.python.org/issue?@action=redirect&bpo=43833]: 如果数字字面量紧跟着关键字之一：and、else、for、if、in、is、or，则发出弃用警告。如果紧跟着其他关键字或标识符，则引发带有更丰富信息的语法错误。

bpo-11105 [https://bugs.python.org/issue?@action=redirect&bpo=11105]: 当通过 compile() 编译带有递归引用的 ast.AST 对象时，解释器不再崩溃，而是引发 RecursionError。

库

bpo-42972 [https://bugs.python.org/issue?@action=redirect&bpo=42972]: The _thread.RLock type now fully implement the GC protocol: add a traverse function and the Py_TPFLAGS_HAVE_GC flag. Patch by Victor Stinner.

bpo-44422 [https://bugs.python.org/issue?@action=redirect&bpo=44422]: threading.enumerate() 函数现在使用可重入锁以防止在可重入调用上挂起。由 Victor Stinner 提供补丁。

bpo-44389 [https://bugs.python.org/issue?@action=redirect&bpo=44389]: 修复 ssl.OP_NO_TLSv1_3 的弃用问题

bpo-44362 [https://bugs.python.org/issue?@action=redirect&bpo=44362]: 改进 ssl 模块的弃用消息、错误报告和弃用文档。

bpo-44342 [https://bugs.python.org/issue?@action=redirect&bpo=44342]: [Enum] 将 pickle 从按值改为按名称。

bpo-44356 [https://bugs.python.org/issue?@action=redirect&bpo=44356]: [Enum] 如果所有数据类型混合都是相同的，则允许多个数据类型混合。

bpo-44351 [https://bugs.python.org/issue?@action=redirect&bpo=44351]: Restore back parse_makefile() in distutils.sysconfig because it behaves differently than the similar implementation in sysconfig.

bpo-44242 [https://bugs.python.org/issue?@action=redirect&bpo=44242]: 从 Enum 创建中移除缺失标志检查，并将其移至 verify 装饰器中。

bpo-44246 [https://bugs.python.org/issue?@action=redirect&bpo=44246]: 在 importlib.metadata 中，恢复 Distribution.entry_points (EntryPoints) 结果的兼容性，以符合旧实现的期望，并对以下情况发出弃用警告：A. EntryPoints 对象再次可变，允许 sort() 和其他基于列表的变异操作。通过转换为可变序列（例如 list(dist.entry_points).sort()）避免弃用警告。B. EntryPoints 结果再次允许通过索引访问。为避免弃用警告，首先将结果转换为 Sequence（例如 tuple(dist.entry_points)[0]）。

bpo-44246 [https://bugs.python.org/issue?@action=redirect&bpo=44246]: 在 importlib.metadata.entry_points 中，去重分布不再需要为 PathDistribution 对象加载完整的元数据，将入口点加载性能提高了约10倍。

bpo-43853 [https://bugs.python.org/issue?@action=redirect&bpo=43853]: 改进了 sqlite3 用户定义函数和聚合函数的字符串处理：

现在可以将含有嵌入空字符的字符串传递给 UDFs

转换失败现在会正确引发 MemoryError

由 Erlend E. Aasland 提交的补丁。

bpo-43318 [https://bugs.python.org/issue?@action=redirect&bpo=43318]: 修复了一个错误，其中 pdb 并不总是回显清除的断点。

bpo-37022 [https://bugs.python.org/issue?@action=redirect&bpo=37022]: pdb 现在通过其 p 和 pp 命令显示来自 repr() 的异常。

文档

bpo-44392 [https://bugs.python.org/issue?@action=redirect&bpo=44392]: 在C API文档中新增了一个关于类型提示中使用的类型的部分。记录了``Py_GenericAlias``和 Py_GenericAliasType。

bpo-38291 [https://bugs.python.org/issue?@action=redirect&bpo=38291]: 在文档中标记 typing.io 和 typing.re 为自Python 3.8起弃用。它们从未得到类型检查器的适当支持。

bpo-44322 [https://bugs.python.org/issue?@action=redirect&bpo=44322]: 记录了SyntaxError的参数有一个details元组，并且对于f-string字段替换表达式中的错误调整了details。

测试

bpo-44363 [https://bugs.python.org/issue?@action=redirect&bpo=44363]: 在test_capi中考虑地址消毒器。当运行GCC地址消毒器时，test_capi现在可以通过。

bpo-43921 [https://bugs.python.org/issue?@action=redirect&bpo=43921]: 修复test_ssl.test_wrong_cert_tls13()：使用 suppress_ragged_eofs=False，因为在Windows上 read() 可能会引发 ssl.SSLEOFError。由Victor Stinner提供补丁。

bpo-43921 [https://bugs.python.org/issue?@action=redirect&bpo=43921]: 修复test_ssl的test_pha_required_nocert()：捕获另外两种EOF情况（当``recv()``方法返回一个空字符串时）。由Victor Stinner提供补丁。

构建

bpo-44381 [https://bugs.python.org/issue?@action=redirect&bpo=44381]: Windows构建现在接受 EnableControlFlowGuard 设置为 guard 以启用CFG。

IDLE

bpo-40128 [https://bugs.python.org/issue?@action=redirect&bpo=40128]: 主要修复在 macOS 上不使用 tcl/tk 8.6.11（如 3.9 版本）时的补全问题。添加的 update_idletask 调用应该是无害的，可能在其他情况下也有帮助。

bpo-33962 [https://bugs.python.org/issue?@action=redirect&bpo=33962]: 将缩进空格设置从字体选项卡移至新的Windows选项卡。由Mark Roseman和Terry Jan Reedy提供补丁。

bpo-40468 [https://bugs.python.org/issue?@action=redirect&bpo=40468]: 将设置对话框的常规选项卡拆分为Windows和Shell/ED选项卡。将扩展帮助菜单的帮助源移至扩展选项卡。为新选项腾出空间并缩短对话框。后者使对话框更好地适应小屏幕。

C API

bpo-43795 [https://bugs.python.org/issue?@action=redirect&bpo=43795]: The list in 受限 API 的内容 now shows the public name PyFrameObject rather than _frame. The non-existing entry _node no longer appears in the list.

bpo-44378 [https://bugs.python.org/issue?@action=redirect&bpo=44378]: Py_IS_TYPE() 不再使用 Py_TYPE() 以避免编译器警告：不再将``const PyObject*``强制转换为 PyObject*。由Victor Stinner提供补丁。

Python 3.10.0 beta 2

Release date: 2021-05-31

安全性

bpo-44022 [https://bugs.python.org/issue?@action=redirect&bpo=44022]: mod:http.client now avoids infinitely reading potential HTTP headers after a 100 Continue status response from the server.

核心与内置函数

bpo-43667 [https://bugs.python.org/issue?@action=redirect&bpo=43667]: 在 Oracle Solaris 上的非 UTF 语言环境中改进 Unicode 支持。此问题不影响其他 Solaris 系统。

bpo-44232 [https://bugs.python.org/issue?@action=redirect&bpo=44232]: 修复了当元类引发异常时 type() 的回归问题。C 函数 type_new() 必须在元类构造函数引发异常且获胜类不是元类时正确报告异常。由 Victor Stinner 提供补丁。

bpo-44201 [https://bugs.python.org/issue?@action=redirect&bpo=44201]: 避免在 REPL 中检查特殊语法错误时的副作用，这些副作用导致在检测到语法错误后要求额外的标记。由 Pablo Galindo 提供补丁。

bpo-44184 [https://bugs.python.org/issue?@action=redirect&bpo=44184]: 修复了当解构函数移除堆类型最后一个强引用时 Python 退出的崩溃问题。由 Victor Stinner 提供补丁。

bpo-44180 [https://bugs.python.org/issue?@action=redirect&bpo=44180]: 解析器不再报告在首次到达位置更远处发生的通用语法错误。由 Pablo Galindo 提供补丁。

bpo-44168 [https://bugs.python.org/issue?@action=redirect&bpo=44168]: 修复了解析器中涉及带有无效表达式的关键字参数的错误消息。由 Pablo Galindo 提供补丁。

bpo-44143 [https://bugs.python.org/issue?@action=redirect&bpo=44143]: 修复了当存在现有异常时引发标记化错误时出现的解析器崩溃问题。由 Pablo Galindo 提供补丁。

bpo-44114 [https://bugs.python.org/issue?@action=redirect&bpo=44114]: 修复 C 代码中错误的 dictkeys_reversed 和 dictitems_reversed 函数签名，这破坏了 webassembly 构建。

bpo-43149 [https://bugs.python.org/issue?@action=redirect&bpo=43149]: Corrent the syntax error message regarding multiple exception types to not refer to "exception groups". Patch by Pablo Galindo

bpo-44056 [https://bugs.python.org/issue?@action=redirect&bpo=44056]: Syntax errors when default except is not the last except are reported with the correct location. Patch by Mark Shannon.

bpo-43822 [https://bugs.python.org/issue?@action=redirect&bpo=43822]: 当引发异常时，解析器将优先考虑分词器错误而非自定义语法错误。由 Pablo Galindo 提供补丁。

bpo-28146 [https://bugs.python.org/issue?@action=redirect&bpo=28146]: 修复 str.format() 中一个令人困惑的错误信息。

库

bpo-44254 [https://bugs.python.org/issue?@action=redirect&bpo=44254]: 在 Mac 上，为 turtledemo 按钮文本提供一种在亮或暗背景下都能工作的颜色。程序员无法控制后者。

bpo-38693 [https://bugs.python.org/issue?@action=redirect&bpo=38693]: 在 importlib.resources 中优先使用 f-strings 而非 .format。

bpo-33693 [https://bugs.python.org/issue?@action=redirect&bpo=33693]: Importlib.metadata 现在优先使用 f-strings 而非 .format。

bpo-44241 [https://bugs.python.org/issue?@action=redirect&bpo=44241]: 从 importlib_metadata 4.1 中引入小调整：SimplePath 协议，支持 Metadata 2.2。

bpo-44210 [https://bugs.python.org/issue?@action=redirect&bpo=44210]: 将importlib.metadata._meta.PackageMetadata公开。

bpo-43643 [https://bugs.python.org/issue?@action=redirect&bpo=43643]: 根据规范，将readers.MultiplexedPath.name声明为属性。

bpo-33433 [https://bugs.python.org/issue?@action=redirect&bpo=33433]: 对于IPv4映射的IPv6地址（RFC 4291 [https://datatracker.ietf.org/doc/html/rfc4291.html] 第2.5.5.2节），ipaddress.IPv6Address.is_private 检查被推迟到映射的IPv4地址。这解决了一个bug，其中公共映射的IPv4地址被IPv6检查视为私有地址。

bpo-44145 [https://bugs.python.org/issue?@action=redirect&bpo=44145]: hmac 计算在调用OpenSSL HMAC_Update C API时（3.9中的新功能）没有释放GIL。这无意中阻止了并行计算，而其他 hashlib 算法支持并行计算。

bpo-37788 [https://bugs.python.org/issue?@action=redirect&bpo=37788]: 修复了一个当 Thread 对象从未被 join 时的引用泄漏问题。

bpo-38908 [https://bugs.python.org/issue?@action=redirect&bpo=38908]: 只有数据变量声明的 typing.Protocol 子类现在在被 isinstance 检查时会抛出 TypeError，除非它们被 runtime_checkable() 装饰。之前，这些检查会静默通过。由 Yurii Karabas 提供补丁。

bpo-44098 [https://bugs.python.org/issue?@action=redirect&bpo=44098]: typing.ParamSpec 将不再出现在大多数 typing 泛型的 __parameters__ 中，除非是在 PEP 612 [https://www.python.org/dev/peps/pep-0612] 指定的有效使用位置。这防止了像 typing.List[P][int] 这样的错误用法。这一变化意味着在 3.10 beta 1 及更早版本中可能静默通过的错误用法现在会报错。

bpo-44089 [https://bugs.python.org/issue?@action=redirect&bpo=44089]: 在 3.10 中允许继承 ``csv.Error``（在 3.9 及更早版本中是被允许的，但在 3.10 的早期版本中被禁止）。

bpo-44059 [https://bugs.python.org/issue?@action=redirect&bpo=44059]: 在 webbrowser 模块中注册 SerenityOS 浏览器。

bpo-36515 [https://bugs.python.org/issue?@action=redirect&bpo=36515]: 当为 ARM 平台编译时，hashlib 模块不再进行非对齐的内存访问。

bpo-44018 [https://bugs.python.org/issue?@action=redirect&bpo=44018]: random.seed() 不再改变 bytearray 输入。

bpo-38352 [https://bugs.python.org/issue?@action=redirect&bpo=38352]: 将 IO, BinaryIO, TextIO, Match, 和 Pattern 添加到 typing.__all__。由 Jelle Zijlstra 提供补丁。

bpo-43972 [https://bugs.python.org/issue?@action=redirect&bpo=43972]: When http.server.SimpleHTTPRequestHandler sends a 301 (Moved Permanently) for a directory path not ending with /, add a Content-Length: 0 header. This improves the behavior for certain clients.

bpo-28528 [https://bugs.python.org/issue?@action=redirect&bpo=28528]: 修复 pdb 中的一个错误，其中 checkline() 如果在 reset() 之后调用会引发 AttributeError。

bpo-43650 [https://bugs.python.org/issue?@action=redirect&bpo=43650]: 修复 shutil.unpack_archive() 中的 MemoryError，该错误在 shutil._unpack_zipfile() 处理大文件时发生。由 Igor Bolshakov 提供补丁。

bpo-41730 [https://bugs.python.org/issue?@action=redirect&bpo=41730]: 当导入 tkinter.tix 时，现在会引发 DeprecationWarning，该模块自Python 3.6以来在文档中已被弃用。

文档

bpo-42392 [https://bugs.python.org/issue?@action=redirect&bpo=42392]: 记录了 asyncio 中许多函数和类的 loop 参数的弃用和移除。

bpo-44195 [https://bugs.python.org/issue?@action=redirect&bpo=44195]: 更正了文档中对 TraversableResources 的引用。没有 TraversableReader。

bpo-41963 [https://bugs.python.org/issue?@action=redirect&bpo=41963]: 记录了 ConfigParser 在读取配置文件时会去掉注释。

bpo-44072 [https://bugs.python.org/issue?@action=redirect&bpo=44072]: 更正了在数字ABC层次结构中 ** 支持被添加的位置，即numbers.Complex，而非numbers.Integral。

bpo-43558 [https://bugs.python.org/issue?@action=redirect&bpo=43558]: 在 dataclasses 的文档中添加了备注，说明任何基类的 __init__() 必须在 __post_init__() 中被调用，并附带了一个代码示例。

bpo-44025 [https://bugs.python.org/issue?@action=redirect&bpo=44025]: 澄清了在match语句中，何时'_'是关键字，何时不是。

测试

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: Ignore error string case in test_py_compile test_file_not_exists().

bpo-42083 [https://bugs.python.org/issue?@action=redirect&bpo=42083]: 添加测试以检查 PyStructSequence_NewType 是否接受 doc 字段设置为``NULL``的 PyStructSequence_Desc。

bpo-35753 [https://bugs.python.org/issue?@action=redirect&bpo=35753]: 通过跳过那些函数来修复doctest在解析包含不可包装函数的模块时的崩溃。

构建

bpo-41282 [https://bugs.python.org/issue?@action=redirect&bpo=41282]: 修复了导致标准库扩展模块在cpython的安装阶段不必要且错误地重新构建的``make install``问题。

Windows

bpo-42686 [https://bugs.python.org/issue?@action=redirect&bpo=42686]: 启用数学函数构建 sqlite3 模块。由 Erlend E. Aasland 提供补丁。

macOS

bpo-43109 [https://bugs.python.org/issue?@action=redirect&bpo=43109]: 允许 --with-lto 配置选项与 Apple 提供的 Xcode 或 Command Line Tools 一起工作。

IDLE

bpo-41611 [https://bugs.python.org/issue?@action=redirect&bpo=41611]: 避免在 AutoCompleteWindow.winconfig_event() 中出现未捕获的异常。

bpo-41611 [https://bugs.python.org/issue?@action=redirect&bpo=41611]: 修复在macOS上有时因标签补全导致IDLE冻结的问题。

bpo-44010 [https://bugs.python.org/issue?@action=redirect&bpo=44010]: 高亮显示新的 match 语句的 soft keywords：match、case 和 _。然而，这种高亮显示并不完美，在某些罕见情况下会不正确，包括一些 case 模式中的 _。

bpo-44026 [https://bugs.python.org/issue?@action=redirect&bpo=44026]: 在NameErrors和AttributeErrors的消息行中包含解释器的拼写修正建议。由E. Paine提供补丁。

工具/示例

bpo-44074 [https://bugs.python.org/issue?@action=redirect&bpo=44074]: 使patchcheck自动检测正确的基础分支名称（之前硬编码为'master'）

C API

bpo-43795 [https://bugs.python.org/issue?@action=redirect&bpo=43795]: 未记录的函数 Py_FrozenMain() 已从有限API中移除。

bpo-43795 [https://bugs.python.org/issue?@action=redirect&bpo=43795]: PyCodec_Unregister() 现在作为Windows稳定ABI DLL中的函数被正确导出。

Python 3.10.0 beta 1

发布日期: 2021-05-03

安全性

bpo-43434 [https://bugs.python.org/issue?@action=redirect&bpo=43434]: 现在创建 sqlite3.Connection 对象时也会产生 sqlite3.connect 和 sqlite3.connect/handle auditing events。之前这些事件仅由 sqlite3.connect() 调用产生。由 Erlend E. Aasland 提供补丁。

bpo-43998 [https://bugs.python.org/issue?@action=redirect&bpo=43998]: ssl 模块设置了更安全的密码套件默认值。默认禁用不具有前向保密性和使用 SHA-1 MAC 的密码。安全级别 2 禁止使用安全性低于 112 位的弱 RSA、DH 和 ECC 密钥。SSLContext 默认最低协议版本为 TLS 1.2。设置基于 Hynek Schlawack 的研究。

bpo-43882 [https://bugs.python.org/issue?@action=redirect&bpo=43882]: URL 部分中存在的换行符或制表符可能允许某些形式的攻击。

遵循 WHATWG 定义的 URL 控制规范，urllib.parse() 现在从 URL 中移除 ASCII 换行符和制表符，防止此类攻击。

bpo-43472 [https://bugs.python.org/issue?@action=redirect&bpo=43472]: 确保解释器级审计钩子在通过 _xxsubinterpreters 模块调用时接收到 cpython.PyInterpreterState_New 事件。

bpo-43362 [https://bugs.python.org/issue?@action=redirect&bpo=43362]: 修复 _sha3 模块中的无效释放。此问题在 3.10.0a1 中引入。Python 3.9 及更早版本不受影响。

bpo-43762 [https://bugs.python.org/issue?@action=redirect&bpo=43762]: 为 sqlite3.connect/handle()、sqlite3.Connection.enable_load_extension() 和 sqlite3.Connection.load_extension() 添加审计事件。由 Erlend E. Aasland 提供补丁。

bpo-43756 [https://bugs.python.org/issue?@action=redirect&bpo=43756]: 添加新的审计事件 glob.glob/2 以包含新增的 root_dir 和 dir_fd 参数，这些参数已添加到 glob.glob() 和 glob.iglob() 中。

bpo-36384 [https://bugs.python.org/issue?@action=redirect&bpo=36384]: ipaddress module no longer accepts any leading zeros in IPv4 address strings. Leading zeros are ambiguous and interpreted as octal notation by some libraries. For example the legacy function socket.inet_aton() treats leading zeros as octal notatation. glibc implementation of modern inet_pton() does not accept any leading zeros. For a while the ipaddress module used to accept ambiguous leading zeros.

bpo-43075 [https://bugs.python.org/issue?@action=redirect&bpo=43075]: 修复 urllib.request.AbstractBasicAuthHandler 中的正则表达式拒绝服务（ReDoS）漏洞。易受 ReDoS 攻击的正则表达式具有二次最坏情况复杂度，当识别精心制作的无效 RFC 时，它可能导致拒绝服务。此 ReDoS 问题位于客户端，需要远程攻击者控制 HTTP 服务器。

bpo-42800 [https://bugs.python.org/issue?@action=redirect&bpo=42800]: 现在为 frame.f_code、traceback.tb_frame 和生成器代码/帧属性访问触发审计钩子。

bpo-37363 [https://bugs.python.org/issue?@action=redirect&bpo=37363]: 向 http.client 模块添加审计事件。

核心与内置函数

bpo-43977 [https://bugs.python.org/issue?@action=redirect&bpo=43977]: 防止类在模式匹配时同时是序列和映射。

bpo-43977 [https://bugs.python.org/issue?@action=redirect&bpo=43977]: 在模式匹配时，使用 tp_flags 在类对象上确定主题是序列还是映射。避免在模式匹配时需要导入 collections.abc。

bpo-43892 [https://bugs.python.org/issue?@action=redirect&bpo=43892]: 在解析 match 块时，恢复对复杂字面值模式的正确验证。

bpo-43933 [https://bugs.python.org/issue?@action=redirect&bpo=43933]: 在执行 __exit__ 调用时，将 frame.f_lineno 设置为 'with' 关键字的行号。

bpo-43933 [https://bugs.python.org/issue?@action=redirect&bpo=43933]: 如果帧中的当前位置没有行号，则将 f_lineno 属性设置为 None，而不是 -1，以符合 PEP 626。这通常不应该发生，但在一些不寻常的情况下可能会出现。

bpo-43963 [https://bugs.python.org/issue?@action=redirect&bpo=43963]: Importing the _signal module in a subinterpreter has no longer side effects.

bpo-42739 [https://bugs.python.org/issue?@action=redirect&bpo=42739]: 行号表的内部表示已更改为不使用哨兵，并且向进程外 API 函数 PyLineTable_InitAddressRange 添加了一个显式的长度参数。这使得在某些情况下处理行号表更加健壮。

bpo-43908 [https://bugs.python.org/issue?@action=redirect&bpo=43908]: 使 re 类型不可变。由 Erlend E. Aasland 提供补丁。

bpo-43908 [https://bugs.python.org/issue?@action=redirect&bpo=43908]: 使 array.array 类型不可变。由 Erlend E. Aasland 提供补丁。

bpo-43901 [https://bugs.python.org/issue?@action=redirect&bpo=43901]: 更改类和模块对象以按需延迟创建空的注释字典。为了向后兼容，注释字典存储在对象的 __dict__ 中。

bpo-43892 [https://bugs.python.org/issue?@action=redirect&bpo=43892]: 匹配模式现在使用新的专用 AST 节点（MatchValue、MatchSingleton、MatchSequence、MatchStar、MatchMapping、MatchClass），而不是重用表达式 AST 节点。MatchAs 和 MatchOr 现在被定义为模式节点而不是表达式节点。由 Nick Coghlan 提供补丁。

bpo-42725 [https://bugs.python.org/issue?@action=redirect&bpo=42725]: 当 PEP 563 被激活时，现在禁止在注释中使用 await/yield/yield from 和命名表达式。

bpo-43754 [https://bugs.python.org/issue?@action=redirect&bpo=43754]: 在执行结构化模式匹配（PEP 634 [https://www.python.org/dev/peps/pep-0634]）时，捕获的名称现在在整个模式成功匹配之前保持未绑定状态。

bpo-42737 [https://bugs.python.org/issue?@action=redirect&bpo=42737]: 对于复杂目标（除了简单名称之外的所有内容）的注释，在使用 from __future__ import annotations 时不再产生任何运行时效果。

bpo-43914 [https://bugs.python.org/issue?@action=redirect&bpo=43914]: SyntaxError exceptions raised by the interpreter will highlight the full error range of the expression that consistutes the syntax error itself, instead of just where the problem is detected. Patch by Pablo Galindo.

bpo-38605 [https://bugs.python.org/issue?@action=redirect&bpo=38605]: 撤销将 from __future__ import annotations 设为默认值。这一决定遵循了指导委员会的决定，将 PEP 563 的更改推迟到至少 Python 3.11。有关该决定的更多信息，请参阅原始邮件：https://mail.python.org/archives/list/python-dev@python.org/thread/CLVXXPQ2T2LQ5MP2Y53VVQFCXYWQJHKZ/。由 Pablo Galindo 提供补丁。

bpo-43475 [https://bugs.python.org/issue?@action=redirect&bpo=43475]: NaN 值的哈希现在依赖于对象身份。以前，它们总是哈希为 0，即使 NaN 值彼此不相等。为不相等的值使用相同的哈希会导致哈希表中的堆积。

bpo-43859 [https://bugs.python.org/issue?@action=redirect&bpo=43859]: 改进了 IndentationError 异常的错误消息。由 Pablo Galindo 提供补丁。

bpo-41323 [https://bugs.python.org/issue?@action=redirect&bpo=41323]: 字节码优化器中的常量元组折叠现在重用常量表中的元组。

bpo-43846 [https://bugs.python.org/issue?@action=redirect&bpo=43846]: 对于大型字面量和调用表达式，数据堆栈的使用大大减少。

bpo-38530 [https://bugs.python.org/issue?@action=redirect&bpo=38530]: 当打印解释器引发的 NameError 时，PyErr_Display() 将提供函数中相似变量名的建议。由 Pablo Galindo 提供补丁。

bpo-43823 [https://bugs.python.org/issue?@action=redirect&bpo=43823]: 改进了无效字典字面量的语法错误。由 Pablo Galindo 提供补丁。

bpo-43822 [https://bugs.python.org/issue?@action=redirect&bpo=43822]: 改进了解析器中表达式间缺少逗号的语法错误。由 Pablo Galindo 提供补丁。

bpo-43798 [https://bugs.python.org/issue?@action=redirect&bpo=43798]: ast.alias 节点现在包含源位置元数据属性，例如 lineno、col_offset。

bpo-43797 [https://bugs.python.org/issue?@action=redirect&bpo=43797]: 改进了无效比较的 SyntaxError 错误消息。由 Pablo Galindo 提供补丁。

bpo-43760 [https://bugs.python.org/issue?@action=redirect&bpo=43760]: 将检查是否启用跟踪的标志从堆移动到 C 堆栈。应该可以加速解释器中的调度。

bpo-43682 [https://bugs.python.org/issue?@action=redirect&bpo=43682]: 静态方法 (@staticmethod) 和类方法 (@classmethod) 现在继承方法属性 (__module__, __name__, __qualname__, __doc__, __annotations__) 并有一个新的 __wrapped__ 属性。由 Victor Stinner 提交的补丁。

bpo-43751 [https://bugs.python.org/issue?@action=redirect&bpo=43751]: 修复了 anext(ait, default) 错误返回 None 的 bug。

bpo-42128 [https://bugs.python.org/issue?@action=redirect&bpo=42128]: __match_args__ 不再允许为列表。

bpo-43683 [https://bugs.python.org/issue?@action=redirect&bpo=43683]: 添加 GEN_START 操作码。标记生成器的开始，包括异步或协程，并处理向新创建的生成器或协程发送值。

bpo-43105 [https://bugs.python.org/issue?@action=redirect&bpo=43105]: Importlib 现在在从文件位置创建模块规范对象时解析相对路径。

bpo-43682 [https://bugs.python.org/issue?@action=redirect&bpo=43682]: 静态方法 (@staticmethod) 现在可以像常规函数一样调用。由 Victor Stinner 提交的补丁。

bpo-42609 [https://bugs.python.org/issue?@action=redirect&bpo=42609]: 防止在编译某些极端长的表达式如 "+0"*1000000 时 AST 验证器和优化器崩溃。现在会抛出 RecursionError。

bpo-38530 [https://bugs.python.org/issue?@action=redirect&bpo=38530]: 当打印 AttributeError 时，PyErr_Display() 将提供引发异常的对象的相似属性名称的建议。由 Pablo Galindo 提交的补丁

库

bpo-44015 [https://bugs.python.org/issue?@action=redirect&bpo=44015]: 在 @dataclass() 中，如果多次指定 KW_ONLY，则抛出 TypeError。

bpo-25478 [https://bugs.python.org/issue?@action=redirect&bpo=25478]: 为 collections.Counter() 添加了一个 total() 方法，用于计算计数的总和。

bpo-43733 [https://bugs.python.org/issue?@action=redirect&bpo=43733]: 修改 netrc.netrc 在使用区域设置编码之前使用 UTF-8 编码。

bpo-43979 [https://bugs.python.org/issue?@action=redirect&bpo=43979]: Removed an unnecessary list comprehension before looping from urllib.parse.parse_qsl(). Patch by Christoph Zwerschke and Dong-hee Na.

bpo-43993 [https://bugs.python.org/issue?@action=redirect&bpo=43993]: 更新捆绑的 pip 到 21.1.1。

bpo-43957 [https://bugs.python.org/issue?@action=redirect&bpo=43957]: [枚举] 弃用当非成员用于包含检查时抛出 TypeError 的行为；在 3.12 版本中，将返回 True 或 False，如果该值是枚举的成员或其成员的值之一，则包含检查将返回 True。

bpo-42904 [https://bugs.python.org/issue?@action=redirect&bpo=42904]: 为了与之前次要版本的 Python 向后兼容，如果 typing.get_type_hints() 没有接收到命名空间字典参数，typing.get_type_hints() 将在评估类中字符串化的类型注释（字符串前向引用）时搜索全局然后局部命名空间。

bpo-43945 [https://bugs.python.org/issue?@action=redirect&bpo=43945]: [枚举] 弃用非标准的混合格式()行为：在 3.12 版本中，将使用枚举成员而非成员的值进行 format() 调用。

bpo-41139 [https://bugs.python.org/issue?@action=redirect&bpo=41139]: 弃用未记录的 cgi.log() API。

bpo-43937 [https://bugs.python.org/issue?@action=redirect&bpo=43937]: 修复了 turtle 模块与非默认根窗口一起工作的问题。

bpo-43930 [https://bugs.python.org/issue?@action=redirect&bpo=43930]: 更新捆绑的 pip 到 21.1 和 setuptools 到 56.0.0

bpo-43907 [https://bugs.python.org/issue?@action=redirect&bpo=43907]: 修复了在使用协议 5 时纯 Python pickle 实现中的一个 bug，其中在 pickled 对象图中多次出现的 bytearray 实例会错误地 unpickle 为 bytearray 对象的重复副本。

bpo-43926 [https://bugs.python.org/issue?@action=redirect&bpo=43926]: 在 importlib.metadata 中，为 Description 提供统一接口，允许任何字段编码为多行值，从多行值中移除续行，并添加 .json 属性以便轻松访问 PEP 566 JSON 兼容形式。与 importlib_metadata 4.0 同步。

bpo-43920 [https://bugs.python.org/issue?@action=redirect&bpo=43920]: OpenSSL 3.0.0: 当 cadata 不包含有效证书时，load_verify_locations() 现在返回一致的错误消息。

bpo-43607 [https://bugs.python.org/issue?@action=redirect&bpo=43607]: urllib 现在可以将带有 \\?\ 前缀的 Windows 路径转换为 URL 路径。

bpo-43817 [https://bugs.python.org/issue?@action=redirect&bpo=43817]: 添加 inspect.get_annotations()，该函数安全地计算对象上定义的注解。它解决了从各类对象访问注解时的怪癖，并对传入的对象做出极少假设。inspect.get_annotations() 还能正确反字符串化字符串化的注解。

inspect.signature()、inspect.from_callable() 和 inspect.from_function() 现在调用 inspect.get_annotations() 来检索注解。这意味着 inspect.signature() 和 inspect.from_callable() 现在也能反字符串化字符串化的注解。

bpo-43284 [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 私有函数来确定版本，以返回准确的版本。

bpo-42854 [https://bugs.python.org/issue?@action=redirect&bpo=42854]: ssl 模块现在内部使用 SSL_read_ex 和 SSL_write_ex。这些函数支持读写大于 2 GB 的数据。写入零长度数据不再因协议违规错误而失败。

bpo-42333 [https://bugs.python.org/issue?@action=redirect&bpo=42333]: 将 _ssl 扩展模块移植到多阶段初始化。

bpo-43880 [https://bugs.python.org/issue?@action=redirect&bpo=43880]: ssl 现在对 OP_NO_SSL/TLS* 选项、旧 TLS 版本、旧协议以及自 Python 3.6、3.7 或 OpenSSL 1.1.0 以来已弃用的其他功能发出 DeprecationWarning。

bpo-41559 [https://bugs.python.org/issue?@action=redirect&bpo=41559]: PEP 612 [https://www.python.org/dev/peps/pep-0612] 现在仅在 Python 中实现；内置的 types.GenericAlias 对象不再在 __parameters__ 中包含 typing.ParamSpec``（除了 ``collections.abc.Callable 的 GenericAlias）。这意味着之前无效的 ParamSpec 使用（如 list[P]）在 Python 3.10 alpha 早期版本中有效，现在在替换过程中会引发 TypeError。

bpo-43867 [https://bugs.python.org/issue?@action=redirect&bpo=43867]: multiprocessing 的 Server 类现在明确捕获 SystemExit 并在这种情况下关闭客户端连接。当 Server.serve_client() 方法到达文件末尾 (EOF) 时会发生这种情况。

bpo-40443 [https://bugs.python.org/issue?@action=redirect&bpo=40443]: 移除未使用的导入：pyclbr 不再使用 copy，typing 不再使用 ast。由 Victor Stinner 提供补丁。

bpo-43820 [https://bugs.python.org/issue?@action=redirect&bpo=43820]: 移除了传递给 dataclasses.make_dataclass() 的命名空间的一个不需要的副本。

bpo-43787 [https://bugs.python.org/issue?@action=redirect&bpo=43787]: 向 bz2.BZ2File、gzip.GzipFile 和 lzma.LZMAFile 添加了 __iter__() 方法。这使得迭代它们快约 2 倍。由 Inada Naoki 提供补丁。

bpo-43680 [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()。

bpo-43680 [https://bugs.python.org/issue?@action=redirect&bpo=43680]: The Python _pyio.open() function becomes a static method to behave as io.open() built-in function: don't become a bound method when stored as a class variable. It becomes possible since static methods are now callable in Python 3.10. Moreover, _pyio.OpenWrapper() becomes a simple alias to _pyio.open(). Patch by Victor Stinner.

bpo-41515 [https://bugs.python.org/issue?@action=redirect&bpo=41515]: 修复了由于不显示在 sys.modules 中的合成模块而在 typing.get_type_hints() 中引发的 KeyError。

bpo-43776 [https://bugs.python.org/issue?@action=redirect&bpo=43776]: 当 subprocess.Popen 的参数以字符串或 pathlib.Path 形式提供时，Popen 实例的 repr 现在显示正确的内容。

bpo-42248 [https://bugs.python.org/issue?@action=redirect&bpo=42248]: [枚举] 确保在 _missing__ 中引发的异常被释放

bpo-43744 [https://bugs.python.org/issue?@action=redirect&bpo=43744]: 修复了枚举成员名称与私有变量名称开头匹配的问题

bpo-43772 [https://bugs.python.org/issue?@action=redirect&bpo=43772]: 修复了 TypeVar.__ror__ 的返回值。由 Jelle Zijlstra 提供补丁。

bpo-43764 [https://bugs.python.org/issue?@action=redirect&bpo=43764]: 为@dataclass装饰器添加match_args参数以允许抑制__match_args__的生成。

bpo-43799 [https://bugs.python.org/issue?@action=redirect&bpo=43799]: OpenSSL 3.0.0：定义 OPENSSL_API_COMPAT 为1.1.1以抑制弃用警告。Python需要OpenSSL 1.1.1的API。

bpo-43478 [https://bugs.python.org/issue?@action=redirect&bpo=43478]: Mock对象不能再作为其他Mock对象的specs使用。因此，已经mock的对象不能使用``autospec=True``来mock一个属性，也不能成为 create_autospec(...) 调用的对象。这可能会在测试中暴露出bug，因为这些由Mock派生的Mock总是能通过某些测试（例如 isinstance()），并且内置的断言函数（例如assert_called_once_with）将无条件通过。

bpo-43794 [https://bugs.python.org/issue?@action=redirect&bpo=43794]: Add ssl.OP_IGNORE_UNEXPECTED_EOF constants (OpenSSL 3.0.0)

bpo-43785 [https://bugs.python.org/issue?@action=redirect&bpo=43785]: 通过从BZ2File中移除RLock来提高 bz2.BZ2File 的性能。这使得BZ2File在面对多个同时进行的读取或写入操作时线程不安全，就像 gzip 和 lzma 中的等效类一直以来那样。由Inada Naoki提供补丁。

bpo-43789 [https://bugs.python.org/issue?@action=redirect&bpo=43789]: OpenSSL 3.0.0：当第一次调用已经发出错误信号时，不再第二次调用密码回调函数。

bpo-43788 [https://bugs.python.org/issue?@action=redirect&bpo=43788]: ssl 错误代码的头文件现在是特定于OpenSSL版本的。异常现在会显示正确的原因和库代码。``make_ssl_data.py``脚本已被重写，以使用OpenSSL带有错误代码的文本文件。

bpo-43766 [https://bugs.python.org/issue?@action=redirect&bpo=43766]: 在 typing 模块中通过添加 TypeGuard 来实现 PEP 647 [https://www.python.org/dev/peps/pep-0647]。

bpo-25264 [https://bugs.python.org/issue?@action=redirect&bpo=25264]: os.path.realpath() 现在接受一个仅限关键词的 strict 参数。当设置为``True``时，如果路径不存在或遇到符号链接循环，将引发 OSError。

bpo-43780 [https://bugs.python.org/issue?@action=redirect&bpo=43780]: 在 importlib.metadata 中，整合了importlib_metadata 3.10的更改：在分发发现期间添加基于mtime的缓存。标记使用 entry_points() 返回的字典结果为已弃用。

gh-47383 [https://github.com/python/cpython/issues/47383]: typing.ParamSpec 的 P.args 和 P.kwargs 属性现在是新类 typing.ParamSpecArgs 和 typing.ParamSpecKwargs 的实例，这使得 repr() 更加有用。由 Jelle Zijlstra 提供补丁。

bpo-43731 [https://bugs.python.org/issue?@action=redirect&bpo=43731]: Add an encoding parameter logging.fileConfig().

bpo-43712 [https://bugs.python.org/issue?@action=redirect&bpo=43712]: 为 fileinput.input() 和 fileinput.FileInput 添加了 encoding 和 errors 参数。

bpo-38659 [https://bugs.python.org/issue?@action=redirect&bpo=38659]: 向 enum 模块添加了一个 simple_enum 装饰器，用于将普通类转换为 Enum。添加了 test_simple_enum 来测试简单枚举与相应的普通枚举。更新了标准库模块以使用 simple_enum。

bpo-43764 [https://bugs.python.org/issue?@action=redirect&bpo=43764]: 修复了某些 dataclasses 中 __match_args__ 生成可能失败的问题。

bpo-43752 [https://bugs.python.org/issue?@action=redirect&bpo=43752]: 修复了带有转换器的零大小 blob 的 sqlite3 回归问题，其中返回了 b"" 而不是 None。这个回归是由 PR 24723 引入的。由 Erlend E. Aasland 提供补丁。

bpo-43655 [https://bugs.python.org/issue?@action=redirect&bpo=43655]: tkinter 对话框窗口现在被 macOS 和 X Window 上的窗口管理器识别为对话框。

bpo-43723 [https://bugs.python.org/issue?@action=redirect&bpo=43723]: 以下 threading 方法现在已被弃用，应替换为：

currentThread => threading.current_thread()

activeCount => threading.active_count()

Condition.notifyAll => threading.Condition.notify_all()

Event.isSet => threading.Event.is_set()

Thread.setName => threading.Thread.name

thread.getName => threading.Thread.name

Thread.isDaemon => threading.Thread.daemon

Thread.setDaemon => threading.Thread.daemon

由 Jelle Zijlstra 提供补丁。

bpo-2135 [https://bugs.python.org/issue?@action=redirect&bpo=2135]: 弃用了 importlib 和 zipimport 中的 find_module() 和 find_loader() 实现。

bpo-43534 [https://bugs.python.org/issue?@action=redirect&bpo=43534]: turtle.textinput() 和 turtle.numinput() 现在创建了一个代表画布窗口工作的瞬态窗口。

bpo-43532 [https://bugs.python.org/issue?@action=redirect&bpo=43532]: 添加了为数据类指定仅关键字字段的功能。这些字段将成为生成的 __init__ 方法的仅关键字参数。

bpo-43522 [https://bugs.python.org/issue?@action=redirect&bpo=43522]: 修复了 hostname_checks_common_name 的问题。OpenSSL 不会将主机标志从 struct SSL_CTX 复制到 struct SSL。

bpo-8978 [https://bugs.python.org/issue?@action=redirect&bpo=8978]: 当 lzma / bz2 不可用时，改进了 tarfile.open() 的错误消息。由 Anthony Sottile 提供补丁。

bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967]: 在解析 str 查询字符串时，允许 bytes separator 参数在 urllib.parse.parse_qs 和 urllib.parse.parse_qsl 中使用。之前这会引发 TypeError。

bpo-43296 [https://bugs.python.org/issue?@action=redirect&bpo=43296]: 改进了 sqlite3 的错误处理：设置 SQLITE_NOMEM 的 sqlite3_value_blob() 错误现在会引发 MemoryError。补丁由 Erlend E. Aasland 提供。

bpo-43312 [https://bugs.python.org/issue?@action=redirect&bpo=43312]: 新增函数 sysconfig.get_preferred_scheme() 和 sysconfig.get_default_scheme()，用于查询平台的首选“用户”、“家”和“前缀”（默认）方案名称。

bpo-43265 [https://bugs.python.org/issue?@action=redirect&bpo=43265]: 改进了 sqlite3.Connection.backup() 的错误处理。现在对于不存在的目标数据库名称的错误消息是 unknown database <database name> 而不是 SQL logic error。补丁由 Erlend E. Aasland 提供。

bpo-41282 [https://bugs.python.org/issue?@action=redirect&bpo=41282]: Install schemes in distutils.command.install are now loaded from sysconfig.

bpo-41282 [https://bugs.python.org/issue?@action=redirect&bpo=41282]: distutils.sysconfig has been merged to sysconfig.

bpo-43176 [https://bugs.python.org/issue?@action=redirect&bpo=43176]: 修复了继承自无字段冻结数据类的数据类的处理。现在能正确检测为错误。

bpo-43080 [https://bugs.python.org/issue?@action=redirect&bpo=43080]: pprint 现在支持 dataclasses.dataclass。由 Lewis Gaul 提供补丁。

bpo-39950 [https://bugs.python.org/issue?@action=redirect&bpo=39950]: Add pathlib.Path.hardlink_to() method that supersedes link_to(). The new method has the same argument order as symlink_to().

bpo-42904 [https://bugs.python.org/issue?@action=redirect&bpo=42904]: typing.get_type_hints() 现在在评估类中的 PEP 563 [https://www.python.org/dev/peps/pep-0563] 注解时会检查该类的本地命名空间。

bpo-42269 [https://bugs.python.org/issue?@action=redirect&bpo=42269]: 向 dataclasses.dataclass 装饰器添加 slots 参数以自动为类生成 __slots__。由 Yurii Karabas 提供补丁。

bpo-39529 [https://bugs.python.org/issue?@action=redirect&bpo=39529]: 弃用在未运行事件循环的情况下使用 asyncio.get_event_loop()。对于 asyncio 模块中在没有运行事件循环且未传递显式 loop 参数时隐式创建 Future 或 Task 对象的函数发出弃用警告：ensure_future()、wrap_future()、gather()、shield()、as_completed() 以及 Future、Task、StreamReader、StreamReaderProtocol 的构造函数。

bpo-18369 [https://bugs.python.org/issue?@action=redirect&bpo=18369]: 向 ssl 模块添加了 Certificate 和 PrivateKey 类。现在也可以从内存缓冲区加载证书和密钥。

bpo-41486 [https://bugs.python.org/issue?@action=redirect&bpo=41486]: 为 bz2 / lzma / zlib 模块使用新的输出缓冲区管理代码，并向 _compression.DecompressReader 类添加 .readall() 函数。这些带来了一些性能改进。由 Ma Lin 提供补丁。

bpo-31870 [https://bugs.python.org/issue?@action=redirect&bpo=31870]: ssl.get_server_certificate() 函数现在有一个 timeout 参数。

bpo-41735 [https://bugs.python.org/issue?@action=redirect&bpo=41735]: 修复 zlib 模块中的线程锁在极少数情况下可能出错的问题。由 Ma Lin 提供补丁。

bpo-36470 [https://bugs.python.org/issue?@action=redirect&bpo=36470]: Fix dataclasses with InitVars and replace(). Patch by Claudiu Popa.

bpo-40849 [https://bugs.python.org/issue?@action=redirect&bpo=40849]: 公开 X509_V_FLAG_PARTIAL_CHAIN ssl 标志

bpo-35114 [https://bugs.python.org/issue?@action=redirect&bpo=35114]: ssl.RAND_status() 现在返回一个布尔值（如文档所述）而不是 1 或 0。

bpo-39906 [https://bugs.python.org/issue?@action=redirect&bpo=39906]: pathlib.Path.stat() 和 chmod() 现在接受一个仅关键字参数 follow_symlinks 以与 os 模块中的相应函数保持一致。

bpo-39899 [https://bugs.python.org/issue?@action=redirect&bpo=39899]: os.path.expanduser() now refuses to guess Windows home directories if the basename of current user's home directory does not match their username.

pathlib.Path.expanduser() and home() now consistently raise RuntimeError exception when a home directory cannot be resolved. Previously a KeyError exception could be raised on Windows when the "USERNAME" environment variable was unset.

bpo-36076 [https://bugs.python.org/issue?@action=redirect&bpo=36076]: 为 ssl.get_server_certificate() 添加了 SNI 支持。

bpo-38490 [https://bugs.python.org/issue?@action=redirect&bpo=38490]: 向 statistics 模块添加了协方差、皮尔逊相关系数和简单线性回归功能。由 Tymoteusz Wołodźko 提供补丁。

bpo-33731 [https://bugs.python.org/issue?@action=redirect&bpo=33731]: 提供了一个 locale.localize() 函数，用于将规范化的数字字符串转换为区域格式。

bpo-32745 [https://bugs.python.org/issue?@action=redirect&bpo=32745]: 修复了处理 ctypes 的 ctypes.c_wchar_p 类型时的一个回归问题：嵌入的空字符会导致抛出 ValueError。由 Zackery Spytz 提供补丁。

文档

bpo-43987 [https://bugs.python.org/issue?@action=redirect&bpo=43987]: 添加“注释最佳实践”文档作为新的 HOWTO。

bpo-43977 [https://bugs.python.org/issue?@action=redirect&bpo=43977]: Document the new Py_TPFLAGS_MAPPING and Py_TPFLAGS_SEQUENCE type flags.

bpo-43959 [https://bugs.python.org/issue?@action=redirect&bpo=43959]: 澄清了关于 PyContextVar C-API 的文档。

bpo-43938 [https://bugs.python.org/issue?@action=redirect&bpo=43938]: 更新 dataclasses 文档以表达 FrozenInstanceError 派生自 AttributeError。

bpo-43778 [https://bugs.python.org/issue?@action=redirect&bpo=43778]: 修复 Sphinx glossary_search 扩展：如果 _static/ 子目录不存在则创建它。

bpo-43755 [https://bugs.python.org/issue?@action=redirect&bpo=43755]: 更新文档以反映自 Python 3.9 起，无括号的 lambda 表达式不能再作为理解和生成器表达式中 if 子句的表达式部分。

bpo-43739 [https://bugs.python.org/issue?@action=redirect&bpo=43739]: 修复 Doc/extending/extending.rst 中的示例代码，声明并初始化 pmodule 变量为正确的类型。

测试

bpo-43961 [https://bugs.python.org/issue?@action=redirect&bpo=43961]: 在 Windows 上修复 test_logging.test_namer_rotator_inheritance()：使用 os.replace() 而不是 os.rename()。由 Victor Stinner 提供补丁。

bpo-43842 [https://bugs.python.org/issue?@action=redirect&bpo=43842]: 修复test_logging的SMTP测试中的竞态条件。不要在asyncore.loop()轮询文件描述符时，从另一个线程关闭文件描述符（套接字）。由Victor Stinner提供补丁。

bpo-43843 [https://bugs.python.org/issue?@action=redirect&bpo=43843]: test.libregrtest 现在如果一个线程抛出异常但没有捕获它，则将测试标记为ENV_CHANGED（改变了执行环境）。它在 threading.excepthook() 上设置了一个钩子。使用``--fail-env-changed``选项将测试标记为失败。由Victor Stinner提供补丁。

bpo-43811 [https://bugs.python.org/issue?@action=redirect&bpo=43811]: 在GitHub Actions上测试多个OpenSSL版本。使用ccache加速测试。

bpo-43791 [https://bugs.python.org/issue?@action=redirect&bpo=43791]: OpenSSL 3.0.0：禁用对旧协议TLS 1.0和1.1的测试。测试因TLSV1_ALERT_INTERNAL_ERROR而失败。

构建

bpo-43567 [https://bugs.python.org/issue?@action=redirect&bpo=43567]: 改进了Windows上生成的代码刷新（AST/tokens/opcodes/keywords）。

bpo-43669 [https://bugs.python.org/issue?@action=redirect&bpo=43669]: 实现 PEP 644 [https://www.python.org/dev/peps/pep-0644]。Python现在需要OpenSSL 1.1.1或更新版本。

Windows

bpo-35306 [https://bugs.python.org/issue?@action=redirect&bpo=35306]: 向 os.startfile() 函数添加额外的参数。

bpo-43538 [https://bugs.python.org/issue?@action=redirect&bpo=43538]: Avoid raising errors from pathlib.Path.exists() when passed an invalid filename.

bpo-38822 [https://bugs.python.org/issue?@action=redirect&bpo=38822]: 修复了 os.stat() 在无法访问的目录（带有尾部斜杠）上失败的问题，而不是回退到父目录的元数据。这隐式影响了 os.path.exists() 和 os.path.isdir()。

bpo-26227 [https://bugs.python.org/issue?@action=redirect&bpo=26227]: 修复了 socket.gethostbyaddr() 和 socket.gethostbyname_ex() 中主机名的解码。

bpo-40432 [https://bugs.python.org/issue?@action=redirect&bpo=40432]: 更新了Windows上的pegen再生脚本，以查找并使用Python 3.8或更高版本。在此之前，pegen再生已经需要3.8或更高版本，但脚本可能使用了较低版本的Python。

bpo-43745 [https://bugs.python.org/issue?@action=redirect&bpo=43745]: 实际上将Windows版本更新到OpenSSL 1.1.1k。早期的版本被错误标记，实际上再次包含了1.1.1i。

bpo-43652 [https://bugs.python.org/issue?@action=redirect&bpo=43652]: 在Windows安装程序中更新Tcl和Tk到8.6.11版本。

bpo-43492 [https://bugs.python.org/issue?@action=redirect&bpo=43492]: 升级Windows安装程序以使用SQLite 3.35.5。

bpo-30555 [https://bugs.python.org/issue?@action=redirect&bpo=30555]: 修复在存在文件描述符重定向时的 WindowsConsoleIO 错误。由Segev Finer提供补丁。

macOS

bpo-42119 [https://bugs.python.org/issue?@action=redirect&bpo=42119]: 修复构建Python时对macOS SDK路径的检查。缩小搜索范围以匹配SDKs的内容，即仅包括 /System/Library、/System/IOSSupport``和 ``/usr 中除 /usr/local 外的文件。之前，任何在 /System 下的内容都被假定为在SDK中，这在10.15+的新文件系统布局中会导致问题，因为用户文件系统可能看似挂载在 /System 下。/Library 中的路径也被错误地视为SDK位置。

bpo-43568 [https://bugs.python.org/issue?@action=redirect&bpo=43568]: 放弃对MACOSX_DEPLOYMENT_TARGET < 10.3的支持

bpo-44009 [https://bugs.python.org/issue?@action=redirect&bpo=44009]: 提供"python3.x-intel64"可执行文件，以便在Apple Silicon Mac上可靠地强制macOS universal2框架构建在Rosetta 2 Intel-64仿真下运行。这对于测试或当universal2 wheel尚不可用时非常有用。

bpo-43851 [https://bugs.python.org/issue?@action=redirect&bpo=43851]: 在macOS上使用 SQLITE_OMIT_AUTOINIT 构建SQLite。由Erlend E. Aasland提供补丁。

bpo-43492 [https://bugs.python.org/issue?@action=redirect&bpo=43492]: 更新macOS安装程序以使用SQLite 3.35.4。

bpo-42235 [https://bugs.python.org/issue?@action=redirect&bpo=42235]: Mac/BuildScript/build-installer.py 现在在macOS 10.15或更高版本上构建时将使用"--enable-optimizations"和 --with-lto。

IDLE

bpo-37903 [https://bugs.python.org/issue?@action=redirect&bpo=37903]: 向shell侧边栏添加鼠标操作。左键点击和可选拖动选择一个或多个行，与编辑器行号侧边栏相同。选择后右键点击会弹出一个带有'copy with prompts'的上下文菜单。这将侧边栏的提示与所选文本的行压缩在一起。

bpo-43981 [https://bugs.python.org/issue?@action=redirect&bpo=43981]: 修复test_sidebar和test_squeezer中的引用泄漏。由Terry Jan Reedy和Pablo Galindo提供补丁

bpo-37892 [https://bugs.python.org/issue?@action=redirect&bpo=37892]: 使用空格而非制表符缩进IDLE Shell输入

bpo-43655 [https://bugs.python.org/issue?@action=redirect&bpo=43655]: IDLE对话框窗口现在被macOS和X Window的窗口管理器识别为对话框。

bpo-37903 [https://bugs.python.org/issue?@action=redirect&bpo=37903]: IDLE的shell现在在一个单独的侧边栏中显示提示。

C API

bpo-43916 [https://bugs.python.org/issue?@action=redirect&bpo=43916]: Add a new Py_TPFLAGS_DISALLOW_INSTANTIATION type flag to disallow creating type instances. Patch by Victor Stinner.

bpo-43774 [https://bugs.python.org/issue?@action=redirect&bpo=43774]: 移除现在未使用的 PYMALLOC_DEBUG 宏。如果Python是以调试模式构建的（如果定义了 Py_DEBUG 宏），现在默认安装内存分配器的调试钩子。此外，它们现在可以在发布模式的Python构建中使用（例如：使用 PYTHONMALLOC=debug 环境变量）。

bpo-43962 [https://bugs.python.org/issue?@action=redirect&bpo=43962]: _PyInterpreterState_IDIncref() 现在调用 _PyInterpreterState_IDInitref() 并且总是增加 id_refcount。之前，调用 _xxsubinterpreters.get_current() 在 _xxsubinterpreters.InterpreterID 对象被释放时可能会创建一个 id_refcount 不一致。由Victor Stinner提供补丁。

bpo-28254 [https://bugs.python.org/issue?@action=redirect&bpo=28254]: 添加新的C-API函数来控制垃圾收集器的状态：PyGC_Enable()、PyGC_Disable()、PyGC_IsEnabled()，对应于 gc 模块中的函数。

bpo-43908 [https://bugs.python.org/issue?@action=redirect&bpo=43908]: Introduce Py_TPFLAGS_IMMUTABLETYPE flag for immutable type objects, and modify PyType_Ready() to set it for static types. Patch by Erlend E. Aasland.

bpo-43795 [https://bugs.python.org/issue?@action=redirect&bpo=43795]: PyMem_Calloc() 现在在有限C API（Py_LIMITED_API）中可用。

bpo-43868 [https://bugs.python.org/issue?@action=redirect&bpo=43868]: PyOS_ReadlineFunctionPointer() 不再由有限C API头文件和Windows上的 python3.dll 导出。像任何接受 FILE* 的函数一样，它不是稳定ABI的一部分。

bpo-43795 [https://bugs.python.org/issue?@action=redirect&bpo=43795]: 稳定的ABI和有限API定义现在从一个中心清单生成（PEP 652 [https://www.python.org/dev/peps/pep-0652]）。

bpo-43753 [https://bugs.python.org/issue?@action=redirect&bpo=43753]: 添加 Py_Is(x, y) 函数来测试 x 对象是否为 y 对象，等同于Python中的 x is y。还添加了 Py_IsNone()、Py_IsTrue()、Py_IsFalse() 函数来分别测试对象是否为 None 单例、True 单例或 False 单例。由Victor Stinner提供补丁。

Python 3.10.0 alpha 7

发布日期: 2021-04-05

安全性

bpo-42988 [https://bugs.python.org/issue?@action=redirect&bpo=42988]: CVE-2021-3426: Remove the getfile feature of the pydoc module which could be abused to read arbitrary files on the disk (directory traversal vulnerability). Moreover, even source code of Python modules can contain sensitive data like passwords. Vulnerability reported by David Schwörer.

bpo-43285 [https://bugs.python.org/issue?@action=redirect&bpo=43285]: ftplib 默认不再信任服务器响应 PASV 命令返回的 IP 地址值。这可以防止恶意 FTP 服务器利用响应探测客户端网络的 IPv4 地址和端口组合。

需要之前易受攻击行为的代码可以在它们的 ftplib.FTP 实例上设置 trust_server_pasv_ipv4_address 属性为 True 以重新启用它。

bpo-43439 [https://bugs.python.org/issue?@action=redirect&bpo=43439]: 为 gc.get_objects()、gc.get_referrers() 和 gc.get_referents() 添加审计钩子。由 Pablo Galindo 提供补丁。

核心与内置函数

bpo-27129 [https://bugs.python.org/issue?@action=redirect&bpo=27129]: 更新 CPython 字节码魔法数字。

bpo-43672 [https://bugs.python.org/issue?@action=redirect&bpo=43672]: 当调用 find_loader() 时，发出 ImportWarning。

bpo-43660 [https://bugs.python.org/issue?@action=redirect&bpo=43660]: 修复在替换 sys.stderr 为一个可在打印异常时删除对象的可调用对象时发生的崩溃。由 Pablo Galindo 提供补丁。

bpo-27129 [https://bugs.python.org/issue?@action=redirect&bpo=27129]: 字节码解释器内部使用指令偏移而非字节偏移。这减少了所需的 EXTENDED_ARG 指令数量并稍微简化了指令分发。

bpo-40645 [https://bugs.python.org/issue?@action=redirect&bpo=40645]: Fix reference leak in the _hashopenssl extension. Patch by Pablo Galindo.

bpo-42134 [https://bugs.python.org/issue?@action=redirect&bpo=42134]: 导入系统对 find_module() 的调用现在会发出 ImportWarning。

bpo-41064 [https://bugs.python.org/issue?@action=redirect&bpo=41064]: 改进了在 f-strings 中无效使用双星号元素（'**'）的语法错误提示。由 Pablo Galindo 提供补丁。

bpo-43575 [https://bugs.python.org/issue?@action=redirect&bpo=43575]: Speed up calls to map() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-42137 [https://bugs.python.org/issue?@action=redirect&bpo=42137]: 导入系统现在更倾向于使用 __spec__ 而非 module_repr() 来进行 ModuleType.__repr__。

bpo-43452 [https://bugs.python.org/issue?@action=redirect&bpo=43452]: 对 _PyType_Lookup() 进行了微优化，以提高缓存命中的常见情况下的查找性能。

bpo-43555 [https://bugs.python.org/issue?@action=redirect&bpo=43555]: 为无效的行继续字符报告 SyntaxError 的列偏移。由 Pablo Galindo 提供补丁。

bpo-43517 [https://bugs.python.org/issue?@action=redirect&bpo=43517]: 修复了在使用 from pkg.mod import attr 时循环导入的错误检测，这导致了非平凡的多线程代码中的假阳性。

bpo-43497 [https://bugs.python.org/issue?@action=redirect&bpo=43497]: 对带有元组常量的断言发出 SyntaxWarnings，这是在 python3.7 中引入的回归问题。

bpo-39316 [https://bugs.python.org/issue?@action=redirect&bpo=39316]: Tracing now has correct line numbers for attribute accesses when the the attribute is on a different line from the object. Improves debugging and profiling for multi-line method chains.

bpo-35883 [https://bugs.python.org/issue?@action=redirect&bpo=35883]: 如果命令行参数包含无效的 Unicode 字符，Python 不再在启动时以致命错误失败。Py_DecodeLocale() 函数现在会转义将被解码为 [U+0000; U+10ffff] 范围之外的 Unicode 字符的字节序列。

bpo-43410 [https://bugs.python.org/issue?@action=redirect&bpo=43410]: 修复了一个在从标准输入读取输入时发出语法错误导致解析器崩溃的错误。由 Pablo Galindo 提供补丁。

bpo-43406 [https://bugs.python.org/issue?@action=redirect&bpo=43406]: 修复了一个可能的竞态条件，其中 PyErr_CheckSignals 尝试执行非 Python 信号处理程序。

bpo-42128 [https://bugs.python.org/issue?@action=redirect&bpo=42128]: Add __match_args__ to structsequence based classes. Patch by Pablo Galindo.

bpo-43390 [https://bugs.python.org/issue?@action=redirect&bpo=43390]: CPython 现在在 PyOS_setsig 中为 VM 的默认信号处理程序设置了 SA_ONSTACK 标志。这对于扩展模块或嵌入使用可能引入的其他进程内代码（如 Golang 的 cgo）更为友好，其中小线程栈是常态，并且使用了 sigaltstack() 来为信号处理程序提供支持。对于绝大多数不使用 sigaltstack 的进程来说，这是一个无操作更改。

bpo-43287 [https://bugs.python.org/issue?@action=redirect&bpo=43287]: Speed up calls to filter() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-37448 [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注释。这些注释不再需要。

To disable the radix tree map, set a preprocessor flag as follows: -DWITH_PYMALLOC_RADIX_TREE=0.

合著者：Tim Peters <tim.peters@gmail.com>

bpo-29988 [https://bugs.python.org/issue?@action=redirect&bpo=29988]: Only handle asynchronous exceptions and requests to drop the GIL when returning from a call or on the back edges of loops. Makes sure that __exit__() is always called in with statements, even for interrupts.

库

bpo-43720 [https://bugs.python.org/issue?@action=redirect&bpo=43720]：记录imp、pkgutil和importlib.util中各种标准库的弃用，计划在Python 3.12中移除。

bpo-43433 [https://bugs.python.org/issue?@action=redirect&bpo=43433]：xmlrpc.client.ServerProxy 不再忽略服务器URL中的查询和片段。

bpo-31956 [https://bugs.python.org/issue?@action=redirect&bpo=31956]：array.array 的 index() 方法现在有可选的 start*和*stop 形参。

bpo-40066 [https://bugs.python.org/issue?@action=redirect&bpo=40066]：Enum：调整 repr() 仅显示枚举和成员名称（不显示值，也不显示尖括号），``str()``仅显示成员名称。更新并改进文档以匹配。

bpo-42136 [https://bugs.python.org/issue?@action=redirect&bpo=42136]：弃用importlib中找到的所有module_repr()方法，因为它们的使用将在Python 3.12中逐步淘汰。

bpo-35930 [https://bugs.python.org/issue?@action=redirect&bpo=35930]：在“future”实例中引发的异常将创建引用循环。

bpo-41369 [https://bugs.python.org/issue?@action=redirect&bpo=41369]：完成更新vendored libmpdec到版本2.5.1。由Stefan Krah提供补丁。

bpo-43422 [https://bugs.python.org/issue?@action=redirect&bpo=43422]：恢复在问题编号`41324`中添加的_decimal C API。

bpo-43577 [https://bugs.python.org/issue?@action=redirect&bpo=43577]: 修复了在使用 ssl.SSLContext 调试回调与 ssl.SSLContext.sni_callback() 时出现的死锁问题。

bpo-43571 [https://bugs.python.org/issue?@action=redirect&bpo=43571]: 现在可以使用 IPPROTO_MPTCP 创建 MPTCP 套接字。

bpo-43542 [https://bugs.python.org/issue?@action=redirect&bpo=43542]: image/heic 和 image/heif 已被添加到 mimetypes。

bpo-40645 [https://bugs.python.org/issue?@action=redirect&bpo=40645]: 当 digestmod 参数是哈希名称或内置哈希函数时，hmac 模块现在使用 OpenSSL 的 HMAC 实现。

bpo-43510 [https://bugs.python.org/issue?@action=redirect&bpo=43510]: 实现了 PEP 597 [https://www.python.org/dev/peps/pep-0597]: 添加了 EncodingWarning 警告，-X warn_default_encoding 选项，PYTHONWARNDEFAULTENCODING 环境变量和 encoding="locale" 参数值。

bpo-43521 [https://bugs.python.org/issue?@action=redirect&bpo=43521]: ast.unparse 现在可以渲染 NaNs 和空集。

bpo-42914 [https://bugs.python.org/issue?@action=redirect&bpo=42914]: pprint.pprint() 新增了一个布尔型 underscore_numbers 可选参数，用于输出用下划线分隔千位的整数以提高可读性（例如 1_000_000 而不是 1000000）。

bpo-41361 [https://bugs.python.org/issue?@action=redirect&bpo=41361]: 由于参数解析速度的提升，rotate() 调用现在稍微快一些。

bpo-43423 [https://bugs.python.org/issue?@action=redirect&bpo=43423]: 在 Windows 上超时期间，当 stdout 或 stderr IO 缓冲区为空时，subprocess.communicate() 不再引发 IndexError。

bpo-27820 [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。

bpo-43445 [https://bugs.python.org/issue?@action=redirect&bpo=43445]: 将冻结模块添加到 sys.stdlib_module_names。例如，添加 "_frozen_importlib" 和 "_frozen_importlib_external" 名称。

bpo-43245 [https://bugs.python.org/issue?@action=redirect&bpo=43245]: 向 ChainMap.new_child() 添加了关键字参数支持。

bpo-29982 [https://bugs.python.org/issue?@action=redirect&bpo=29982]: 向 tempfile.TemporaryDirectory() 添加了可选参数 ignore_cleanup_errors，并允许多次 cleanup() 尝试。由 C.A.M. Gerlach 贡献。

bpo-43428 [https://bugs.python.org/issue?@action=redirect&bpo=43428]: 包含来自 importlib_metadata 3.7 [https://importlib-metadata.readthedocs.io/en/latest/history.html#v3-7-0] 的更改：

性能优化以改进发行版发现。

entry_points 现在只返回唯一的发行版。

引入了新的 EntryPoints 对象，用于包含一组入口点，并提供了便捷方法来按组或名称选择入口点。如果提供了选择参数，entry_points 现在会返回此对象，但为了兼容性，继续返回字典对象。鼓励用户依赖选择接口。字典对象的结果将来可能会被弃用。

添加了 packages_distributions 函数，返回包到提供它们的发行版的映射。

bpo-43332 [https://bugs.python.org/issue?@action=redirect&bpo=43332]: 通过 set_tunnel() 使用代理时，提高了 http.client 的网络效率。在连接设置过程中减少了小发送调用的次数。

bpo-43420 [https://bugs.python.org/issue?@action=redirect&bpo=43420]: 提高 fractions.Fraction 对大组件的算术性能。由 Sergey B. Kirpichev 贡献。

bpo-43356 [https://bugs.python.org/issue?@action=redirect&bpo=43356]: 允许传递信号编号给 _thread.interrupt_main()。

bpo-43399 [https://bugs.python.org/issue?@action=redirect&bpo=43399]: 修复 ElementTree.extend 在使用 Python 实现时不适用于迭代器的问题。

bpo-43369 [https://bugs.python.org/issue?@action=redirect&bpo=43369]: 改进 sqlite3 错误处理：如果 sqlite3_column_text() 和 sqlite3_column_blob() 设置 SQLITE_NOMEM，现在会引发 MemoryError。由 Erlend E. Aasland 提供补丁。

bpo-43368 [https://bugs.python.org/issue?@action=redirect&bpo=43368]: 修复 PR 24562 引入的回归问题，其中在 sqlite3 中，空字节串被获取为 None 而不是 b''。由 Mariusz Felisiak 提供补丁。

bpo-41282 [https://bugs.python.org/issue?@action=redirect&bpo=41282]: 修复了从 import distutils 发出的 DeprecationWarning 的堆栈级别。

bpo-42129 [https://bugs.python.org/issue?@action=redirect&bpo=42129]: importlib.resources 现在尊重命名空间包，合并来自命名空间中每个位置的资源，如 importlib_resources 3.2 中引入的，包括通过 5.0.3 的附带更改。

bpo-43295 [https://bugs.python.org/issue?@action=redirect&bpo=43295]: datetime.datetime.strptime() 现在在匹配 'z' 和 %z 格式说明符时引发 ValueError 而不是 IndexError。

bpo-43125 [https://bugs.python.org/issue?@action=redirect&bpo=43125]: 如果 base64mime.body_encode 接收到空字节，返回空字符串。

bpo-43084 [https://bugs.python.org/issue?@action=redirect&bpo=43084]: curses.window.enclose() 现在返回 True 或 False (如文档所述) 而不是 1 或 0。

bpo-42994 [https://bugs.python.org/issue?@action=redirect&bpo=42994]: 为 opus、AAC、3gpp 和 3gpp2 添加 MIME 类型。

bpo-14678 [https://bugs.python.org/issue?@action=redirect&bpo=14678]: 向 zipimport.zipimporter 类添加 invalidate_caches() 方法以支持 importlib.invalidate_caches()。由 Desmond Cheong 提供补丁。

bpo-42782 [https://bugs.python.org/issue?@action=redirect&bpo=42782]: Fail fast in shutil.move() to avoid creating destination directories on failure.

bpo-40066 [https://bugs.python.org/issue?@action=redirect&bpo=40066]: Enum's repr() and str() have changed: repr() is now EnumClass.MemberName and str() is MemberName. Additionally, stdlib Enum's whose contents are available as module attributes, such as RegexFlag.IGNORECASE, have their repr() as module.name, e.g. re.IGNORECASE.

bpo-26053 [https://bugs.python.org/issue?@action=redirect&bpo=26053]: 修复了 pdb 交互式运行命令回显 shell 命令行参数的错误，即使这些参数已在 pdb 提示符下被覆盖。

bpo-24160 [https://bugs.python.org/issue?@action=redirect&bpo=24160]: 修复了在 pdb 的交互模式下断点不跨多个调试会话持续的 bug。

bpo-40701 [https://bugs.python.org/issue?@action=redirect&bpo=40701]: When the tempfile.tempdir global variable is set to a value of type bytes, it is now handled consistently. Previously exceptions could be raised from some tempfile APIs when the directory did not already exist in this situation. Also ensures that the tempfile.gettempdir() and tempfile.gettempdirb() functions always return str and bytes respectively.

bpo-39342 [https://bugs.python.org/issue?@action=redirect&bpo=39342]: Expose X509_V_FLAG_ALLOW_PROXY_CERTS as VERIFY_ALLOW_PROXY_CERTS to allow proxy certificate validation as explained in https://www.openssl.org/docs/man1.1.1/man7/proxy-certificates.html.

bpo-31861 [https://bugs.python.org/issue?@action=redirect&bpo=31861]: 添加 builtins.aiter 和 builtins.anext。由 Joshua Bronson (@jab)、Daniel Pope (@lordmauve) 和 Justin Wang (@justin39) 提供补丁。

文档

bpo-43199 [https://bugs.python.org/issue?@action=redirect&bpo=43199]: 在设计与历史常见问题中回答“为什么没有 goto？”。

bpo-43407 [https://bugs.python.org/issue?@action=redirect&bpo=43407]: 明确了 time.monotonic()、time.perf_counter()、time.process_time() 或 time.thread_time() 的结果可以与任何后续调用同一函数的结果进行比较 - 不仅仅是下一个立即调用。

bpo-43354 [https://bugs.python.org/issue?@action=redirect&bpo=43354]: 修复 Fault.faultCode 的类型文档；类型必须是 int 而不是 str。

bpo-41933 [https://bugs.python.org/issue?@action=redirect&bpo=41933]: 澄清了 Common Sequence Operations 中 s * n 的措辞。

测试

bpo-37945 [https://bugs.python.org/issue?@action=redirect&bpo=37945]: 修复 test_locale 的 test_getsetlocale_issue1813()：如果 setlocale() 失败，跳过测试。由 Victor Stinner 提供补丁。

bpo-41561 [https://bugs.python.org/issue?@action=redirect&bpo=41561]: 为 Ubuntu 自定义的 OpenSSL 安全级别策略添加变通方案。

构建

bpo-43179 [https://bugs.python.org/issue?@action=redirect&bpo=43179]: 在优化字符串例程的对齐相关代码中引入并正确使用 ALIGNOF_X 代替 SIZEOF_X。补丁由 Jessica Clarke 提供。

bpo-43631 [https://bugs.python.org/issue?@action=redirect&bpo=43631]: 将 macOS、Windows 和 CI 更新至 OpenSSL 1.1.1k。

bpo-43617 [https://bugs.python.org/issue?@action=redirect&bpo=43617]: 改进 configure.ac：检查 autoconf-archive 包的存在并移除我们拷贝的 M4 宏。

bpo-43466 [https://bugs.python.org/issue?@action=redirect&bpo=43466]: configure 脚本现在支持 --with-openssl-rpath 选项。

bpo-43372 [https://bugs.python.org/issue?@action=redirect&bpo=43372]: 使用 _freeze_importlib 为 __hello__ 模块生成代码。这种方法确保代码与解释器版本匹配。之前使用 PYTHON_FOR_REGEN 生成代码，可能是错误的。代码对象的 marshal 格式已随 bpo-42246 [https://bugs.python.org/issue?@action=redirect&bpo=42246]，提交 877df851 更改。更新代码和 ctypes test_frozentable 中的预期代码大小。

Windows

bpo-43440 [https://bugs.python.org/issue?@action=redirect&bpo=43440]: 构建启用了 R*Tree 模块的 sqlite3。补丁由 Erlend E. Aasland 提供。

IDLE

bpo-42225 [https://bugs.python.org/issue?@action=redirect&bpo=42225]: 文档说明 IDLE 在 Unix 上可能因配置错误的 IP 伪装规则或无法显示复杂的彩色（非 ASCII）字符而失败。

C API

bpo-43688 [https://bugs.python.org/issue?@action=redirect&bpo=43688]: 如果 Python 是以调试模式构建的（如果定义了 Py_DEBUG 宏），现在支持有限的 C API。在有限的 C API 中，如果 Python 是以调试模式构建的，并且 Py_LIMITED_API 宏的目标是 Python 3.10 或更新版本，Py_INCREF() 和 Py_DECREF() 函数现在被实现为不透明的函数调用，而不是直接访问 PyObject.ob_refcnt 成员。之所以能够在调试模式下支持有限的 C API，是因为从 Python 3.8 开始，PyObject 结构在发布和调试模式下是相同的（见 bpo-36465 [https://bugs.python.org/issue?@action=redirect&bpo=36465]）。

在 --with-trace-refs 特殊构建（Py_TRACE_REFS 宏）中，仍然不支持有限的 C API。

由Victor Stinner提供补丁。

bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244]: 移除 pyarena.h 头文件及其函数：

PyArena_New()

PyArena_Free()

PyArena_Malloc()

PyArena_AddPyObject()

这些函数未被文档化，被排除在有限的 C API 之外，并且仅由编译器内部使用。由 Victor Stinner 提供补丁。

bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244]: 移除使用 struct _mod 类型的编译器和解析器函数，因为公共的 AST C API 已被移除：

PyAST_Compile()

PyAST_CompileEx()

PyAST_CompileObject()

PyFuture_FromAST()

PyFuture_FromASTObject()

PyParser_ASTFromFile()

PyParser_ASTFromFileObject()

PyParser_ASTFromFilename()

PyParser_ASTFromString()

PyParser_ASTFromStringObject()

这些函数未被文档化，并且被排除在有限的 C API 之外。由 Victor Stinner 提供补丁。

bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244]: 移除 ast.h、asdl.h 和 Python-ast.h 头文件。这些函数未被文档化，并且被排除在有限的 C API 之外。这些头文件定义的大多数名称没有以 Py 为前缀，因此可能会造成名称冲突。例如，Python-ast.h 定义了一个 Yield 宏，与 Windows <winbase.h> 头文件中使用的 Yield 名称冲突。请使用 Python 的 ast 模块代替。由 Victor Stinner 提供补丁。

bpo-43541 [https://bugs.python.org/issue?@action=redirect&bpo=43541]: 修复 PyEval_EvalCodeEx() 的回归问题：修正内置函数的引用计数。由 Victor Stinner 提供补丁。

bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244]: 移除 symtable.h 头文件及未文档化的函数：

PyST_GetScope()

PySymtable_Build()

PySymtable_BuildObject()

PySymtable_Free()

Py_SymtableString()

Py_SymtableStringObject()

Py_SymtableString() 函数误为稳定版 ABI 却无法使用，因为 symtable.h 头文件不属于受限 C API。

Python 的 symtable 模块仍然可用且未改变。

由Victor Stinner提供补丁。

bpo-43244 [https://bugs.python.org/issue?@action=redirect&bpo=43244]: 移除 PyAST_Validate() 函数。现在已无法通过公共C API构建AST对象（mod_ty 类型）。该函数已被排除在有限C API（PEP 384 [https://www.python.org/dev/peps/pep-0384]）之外。补丁由Victor Stinner提供。

Python 3.10.0 alpha 6

发布日期: 2021-03-01

安全性

bpo-42967 [https://bugs.python.org/issue?@action=redirect&bpo=42967]: 通过默认将查询参数分隔符设置为 &，并允许用户选择自定义分隔符，修复了web缓存中毒漏洞。

核心与内置函数

bpo-43321 [https://bugs.python.org/issue?@action=redirect&bpo=43321]: 修复了当 PyArg_Parse*() 与 # 一起使用但未定义 PY_SSIZE_T_CLEAN 时引发的 SystemError。

bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346]: 当使用 u 或 Z 格式时，PyArg_Parse*() 函数现在会发出 DeprecationWarning。详情见 PEP 623 [https://www.python.org/dev/peps/pep-0623]。

bpo-43277 [https://bugs.python.org/issue?@action=redirect&bpo=43277]: 向C-API添加了一个新的 PySet_CheckExact() 函数，用于检查对象是否是 set 的实例而非子类型的实例。由Pablo Galindo提供补丁。

bpo-42990 [https://bugs.python.org/issue?@action=redirect&bpo=42990]: 现在，如果 globals 字典中没有 "__builtins__" 键，types.FunctionType 构造函数会继承当前的builtins，而不是使用 {"None": None} 作为builtins：与 eval() 和 exec() 函数的行为相同。在Python中使用 def function(...): ... 定义函数不受影响，无法通过此语法覆盖globals：它也会继承当前的builtins。由Victor Stinner提供补丁。

bpo-42990 [https://bugs.python.org/issue?@action=redirect&bpo=42990]: 函数现在有一个新的 __builtins__ 属性，用于在执行函数时查找内置符号，而不是查找 __globals__['__builtins__']。由Mark Shannon和Victor Stinner提供补丁。

bpo-43149 [https://bugs.python.org/issue?@action=redirect&bpo=43149]: 改进了解析器中对于没有括号的异常组的错误消息。由Pablo Galindo提供补丁。

bpo-43121 [https://bugs.python.org/issue?@action=redirect&bpo=43121]: 修复了字面量中缺少逗号时的错误 SyntaxError 消息。由Pablo Galindo提供补丁。

问题`42819`：在交互式解释器中明确禁用`readline`模块的括号粘贴功能，即使它在inputrc中被设置、默认启用（例如GNU Readline 8.1）或用户调用了 readline.read_init_file()。Python REPL尚未实现括号粘贴支持。此外，括号模式会将 "\x1b[?2004h" 转义序列写入stdout，导致不支持该功能的应用程序测试失败。用户仍可通过调用``readline.parse_and_bind("set enable-bracketed-paste on")``显式启用该功能。由Dustin Rodrigues提供补丁。

问题`42808`：由于采用了 vectorcall 调用约定，现在对 type(object) 的简单调用更快了。补丁由Dennis Sweeney提供。

问题`42217`：使编译器像已经对co_consts做的那样，合并模块中相同的co_code和co_linetable对象。

问题`41972`：子字符串搜索函数如 str1 in str2 和 str2.find(str1) 现在有时会使用"双向"字符串比较算法，以避免在长字符串上出现二次行为。

问题`42128`：实现了PEP 634（结构化模式匹配）。由Brandt Bucher提供补丁。

问题`40692`：在 concurrent.futures.ProcessPoolExecutor 中，验证 multiprocess.synchronize() 在给定平台上是否可用，并在 concurrent.futures 测试套件中依赖该检查，以便我们可以在这些平台上运行与 ProcessPoolExecutor 无关的测试。

bpo-38302 [https://bugs.python.org/issue?@action=redirect&bpo=38302]: If object.__ipow__() returns NotImplemented, the operator will correctly fall back to object.__pow__() and object.__rpow__() as expected.

库

问题`43316`：``python -m gzip``命令行应用程序现在在检测到不支持的扩展时会正确失败。它会以非零退出码退出，并向stderr打印错误消息。

问题`43317`：将 gzip 模块主函数的块大小设置为io.DEFAULT_BUFFER_SIZE。这比之前使用的1024字节常量略快。

bpo-43146 [https://bugs.python.org/issue?@action=redirect&bpo=43146]: 在 print_exception() 和 format_exception() 的单参数版本中处理None。

bpo-43260 [https://bugs.python.org/issue?@action=redirect&bpo=43260]: 修复在写入非常大的文本后，TextIOWrapper无法永远刷新内部缓冲区的问题。

bpo-43258 [https://bugs.python.org/issue?@action=redirect&bpo=43258]: 防止在没有行匹配聚合查询时无谓地分配 sqlite3 聚合函数上下文。由Erlend E. Aasland提供补丁。

bpo-43251 [https://bugs.python.org/issue?@action=redirect&bpo=43251]: 改进 sqlite3 错误处理：sqlite3_column_name() 失败现在会导致 MemoryError。由Erlend E. Aasland提供补丁。

bpo-40956 [https://bugs.python.org/issue?@action=redirect&bpo=40956]: 修复在未提供参数时 sqlite3.Connection.backup() 中的段错误。该回归由PR 23838引入。由Erlend E. Aasland提供补丁。

bpo-43172 [https://bugs.python.org/issue?@action=redirect&bpo=43172]: readline模块现在在直接针对libedit构建时通过其测试。基于libreadline与libedit使用的 readline.get_begidx() 和 readline.get_endidx() 行为中现有的不可调和的API差异仍然存在。

bpo-43163 [https://bugs.python.org/issue?@action=redirect&bpo=43163]: 修复 codeop 中的一个bug，该bug导致它在多行片段有未闭合的括号时不请求更多输入。由Pablo Galindo提供补丁。

bpo-43162 [https://bugs.python.org/issue?@action=redirect&bpo=43162]: 弃用不支持的能力，即访问枚举成员作为其他枚举成员的属性。

bpo-43146 [https://bugs.python.org/issue?@action=redirect&bpo=43146]: 修复 traceback 模块函数中None参数处理的最近回归。

bpo-43102 [https://bugs.python.org/issue?@action=redirect&bpo=43102]: namedtuple __new__方法的__builtins__设置为None而不是实际的字典。这给内省工具带来了问题。

bpo-43106 [https://bugs.python.org/issue?@action=redirect&bpo=43106]: Added O_EVTONLY, O_FSYNC, O_SYMLINK and O_NOFOLLOW_ANY for macOS. Patch by Dong-hee Na.

bpo-42960 [https://bugs.python.org/issue?@action=redirect&bpo=42960]: Adds resource.RLIMIT_KQUEUES constant from FreeBSD to the resource module.

bpo-42151 [https://bugs.python.org/issue?@action=redirect&bpo=42151]: Make the pure Python implementation of xml.etree.ElementTree behave the same as the C implementation (_elementree) regarding default attribute values (by not setting specified_attributes=1).

bpo-29753 [https://bugs.python.org/issue?@action=redirect&bpo=29753]: 在ctypes中，现在正确计算了打包位字段，并且打包位字段的第一项现在正确地缩小了。

文档

bpo-27646 [https://bugs.python.org/issue?@action=redirect&bpo=27646]: 澄清了'yield from <expr>'可以与任何可迭代对象一起使用，而不仅仅是迭代器。

bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346]: 更新了一些被标记为“将在4.0中移除”的不推荐使用的Unicode API，改为“3.12”。详见 PEP 623 [https://www.python.org/dev/peps/pep-0623]。

测试

bpo-43288 [https://bugs.python.org/issue?@action=redirect&bpo=43288]: 修复了test_importlib，如果文件系统不支持Unicode文件测试，则正确跳过。

构建

bpo-43174 [https://bugs.python.org/issue?@action=redirect&bpo=43174]: Windows构建现在使用 /utf-8 编译器选项。

bpo-43103 [https://bugs.python.org/issue?@action=redirect&bpo=43103]: 添加了一个新的配置选项 --without-static-libpython，用于不构建``libpythonMAJOR.MINOR.a``静态库且不安装 python.o 对象文件。

bpo-13501 [https://bugs.python.org/issue?@action=redirect&bpo=13501]: 配置脚本现在可以使用命令行选项 --with-readline=editline 来使用 libedit 代替 readline。

bpo-42603 [https://bugs.python.org/issue?@action=redirect&bpo=42603]: 使配置脚本使用pkg-config来检测Tcl/Tk头文件和库的位置，用于构建tkinter。

在macOS上，由pkg-config提供的Tcl/Tk配置将优先于安装在 /{System/,}Library/Frameworks 中的Tcl/Tk框架。如果两者都存在且后者优先，则需要明确设置适当的 --with-tcltk-* 配置选项。

bpo-39448 [https://bugs.python.org/issue?@action=redirect&bpo=39448]: 添加了“regen-frozen”makefile目标，用于重新生成冻结的 __hello__ 模块的代码。

Windows

bpo-43155 [https://bugs.python.org/issue?@action=redirect&bpo=43155]: PyCMethod_New() 现在存在于 python3.lib 中。

macOS

bpo-41837 [https://bugs.python.org/issue?@action=redirect&bpo=41837]: 更新macOS安装程序构建以使用OpenSSL 1.1.1j。

IDLE

bpo-43283 [https://bugs.python.org/issue?@action=redirect&bpo=43283]: 文档说明了为什么打印到IDLE的Shell通常比打印到系统终端慢，以及通过打印前预格式化单个字符串可以使其更快。

C API

bpo-43278 [https://bugs.python.org/issue?@action=redirect&bpo=43278]: 始终将编译器和系统信息放在REPL欢迎消息的第一行。

bpo-43270 [https://bugs.python.org/issue?@action=redirect&bpo=43270]: 移除了私有的 _PyErr_OCCURRED() 宏：改用公共的 PyErr_Occurred() 函数。

bpo-35134 [https://bugs.python.org/issue?@action=redirect&bpo=35134]: 将odictobject.h、parser_interface.h、picklebufobject.h、pydebug.h和pyfpe.h移动到cpython/目录中。它们不应被直接包含，因为这些文件已经被Python.h包含：参见 包含文件。

bpo-35134 [https://bugs.python.org/issue?@action=redirect&bpo=35134]: 将pyarena.h、pyctype.h和pytime.h移动到cpython/目录中。它们不应被直接包含，因为这些文件已经被Python.h包含：参见 包含文件。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: PyExceptionClass_Name() 现在总是被声明为一个函数，以隐藏实现细节。该宏直接访问了 PyTypeObject.tp_name。由Erlend E. Aasland提供补丁。

bpo-43239 [https://bugs.python.org/issue?@action=redirect&bpo=43239]: 当使用 -fvisibility=hidden 编译时，PyCFunction_New() 函数现在被导出到ABI中。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: PyIter_Check() 现在总是被声明为一个函数，以隐藏实现细节。该宏直接访问了 PyTypeObject.tp_iternext。由Erlend E. Aasland提供补丁。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: 将 PyDescr_IsData() 宏转换为函数以隐藏实现细节：该宏直接访问了 PyTypeObject.tp_descr_set。由Erlend E. Aasland提供补丁。

bpo-43181 [https://bugs.python.org/issue?@action=redirect&bpo=43181]: 将 PyObject_TypeCheck() 宏转换为静态内联函数。由Erlend E. Aasland提供补丁。

Python 3.10.0 alpha 5

发布日期: 2021-02-02

安全性

bpo-42938 [https://bugs.python.org/issue?@action=redirect&bpo=42938]: 在计算 ctypes.c_double 和 ctypes.c_longdouble 值的repr时避免使用静态缓冲区。

核心与内置函数

bpo-42990 [https://bugs.python.org/issue?@action=redirect&bpo=42990]: 重构 PyEval_ 系列函数。

新增函数 _PyEval_Vector 以简化从C调用Python的过程。

``_PyEval_EvalCodeWithName``已被移除

``PyEval_EvalCodeEx``作为API的一部分被保留，但在内部未被使用

bpo-38631 [https://bugs.python.org/issue?@action=redirect&bpo=38631]: 将编译器中的 Py_FatalError() 调用替换为常规的 SystemError 异常。由Victor Stinner提供补丁。

bpo-42997 [https://bugs.python.org/issue?@action=redirect&bpo=42997]: 为块前缺少的":"改进错误信息。由Pablo Galindo提供补丁。

bpo-43017 [https://bugs.python.org/issue?@action=redirect&bpo=43017]: 在解析器中使用未加括号的元组时改善了错误信息。由Pablo Galindo提供补丁。

bpo-42986 [https://bugs.python.org/issue?@action=redirect&bpo=42986]: 修复了在报告包含换行符的f字符串中的语法错误时解析器崩溃的问题。由Pablo Galindo提供补丁。

bpo-40176 [https://bugs.python.org/issue?@action=redirect&bpo=40176]: 现在，对于未终止的字符串字面量的语法错误会指向字符串的开始，而不是报告EOF/EOL。

bpo-42927 [https://bugs.python.org/issue?@action=redirect&bpo=42927]: LOAD_ATTR 的内联缓存现在也优化了对通过 __slots__ 定义的属性的访问。这使得读取此类属性的速度提高了30%。

bpo-42864 [https://bugs.python.org/issue?@action=redirect&bpo=42864]: 当括号未关闭时，改善了解析器中的错误信息。由Pablo Galindo提供补丁。

bpo-42924 [https://bugs.python.org/issue?@action=redirect&bpo=42924]: 修复了 bytearray 重复错误地从缓冲区开始复制数据的问题，即使数据在缓冲区中偏移（例如，在将 bytearray 开始的切片重新分配给较短的字节字符串后）。

bpo-42882 [https://bugs.python.org/issue?@action=redirect&bpo=42882]: Fix the _PyUnicode_FromId() function (_Py_IDENTIFIER(var) API) when Py_Initialize() / Py_Finalize() is called multiple times: preserve _PyRuntime.unicode_ids.next_index value.

bpo-42827 [https://bugs.python.org/issue?@action=redirect&bpo=42827]: 修复了在某些多行表达式中处理 SyntaxError 的错误行时崩溃的问题。

bpo-42823 [https://bugs.python.org/issue?@action=redirect&bpo=42823]: 即使frame.f_trace被设置为True，frame.f_lineno也是正确的

bpo-37324 [https://bugs.python.org/issue?@action=redirect&bpo=37324]: 从 collections 模块中移除了对 容器抽象基类 的废弃别名。

bpo-41994 [https://bugs.python.org/issue?@action=redirect&bpo=41994]: 当 sys.modules``不是 ``dict 时，修复了 import 中可能的泄漏。

bpo-27772 [https://bugs.python.org/issue?@action=redirect&bpo=27772]: 在字符串格式化中，在 width 字段前加 '0' 不再影响字符串的默认对齐方式。

库

bpo-43108 [https://bugs.python.org/issue?@action=redirect&bpo=43108]: 修复了 curses 模块中的一个引用泄漏。由Pablo Galindo提供补丁

bpo-43077 [https://bugs.python.org/issue?@action=redirect&bpo=43077]: 将捆绑的pip更新到21.0.1，setuptools更新到52.0.0。

bpo-41282 [https://bugs.python.org/issue?@action=redirect&bpo=41282]: 在文档中弃用 distutils 并在导入时添加警告。

bpo-43014 [https://bugs.python.org/issue?@action=redirect&bpo=43014]: 通过20-30%的性能提升改进了 tokenize。由Anthony Sottile提供补丁。

bpo-42323 [https://bugs.python.org/issue?@action=redirect&bpo=42323]: 修复 AIX 上 math.nextafter() 对于 NaN 的处理。

bpo-42955 [https://bugs.python.org/issue?@action=redirect&bpo=42955]: 添加 sys.stdlib_module_names，包含标准库模块名称的列表。由 Victor Stinner 提交补丁。

bpo-42944 [https://bugs.python.org/issue?@action=redirect&bpo=42944]: 修复 random.Random.sample 当 counts 参数不为 None 时的问题。

bpo-42934 [https://bugs.python.org/issue?@action=redirect&bpo=42934]: 在 TestResult 中使用 TracebackException 的新 compact 参数，以减少回溯格式化消耗的时间和内存。

bpo-42931 [https://bugs.python.org/issue?@action=redirect&bpo=42931]: 将 randbytes() 添加到 random.__all__ 中。

bpo-38250 [https://bugs.python.org/issue?@action=redirect&bpo=38250]: [Enum] 由单个位组成的标志现在被认为是规范的，并且将是唯一从 Flag 类或 Flag 成员的列表和迭代中返回的标志。多位标志被认为是别名；它们将从查找和操作中返回，这些操作导致了它们的值。Flag 和 Flag 成员的迭代都是按照定义顺序进行的。

bpo-42877 [https://bugs.python.org/issue?@action=redirect&bpo=42877]: 向 traceback.TracebackException 的构造函数添加了 compact 参数，以减少仅需要调用 TracebackException.format() 和 TracebackException.format_exception_only() 的使用情况下的时间和内存消耗。

bpo-42923 [https://bugs.python.org/issue?@action=redirect&bpo=42923]: Py_FatalError() 函数和 faulthandler 模块现在会在致命错误时转储扩展模块列表。

bpo-42848 [https://bugs.python.org/issue?@action=redirect&bpo=42848]: 从 TracebackException 中移除了递归，以允许其处理长的异常链。

bpo-42901 [https://bugs.python.org/issue?@action=redirect&bpo=42901]: [Enum] 将成员创建从 EnumMeta.__new__ 移动到 _proto_member.__set_name__，允许成员在 __init_subclass__ 中被创建并可见。

bpo-42780 [https://bugs.python.org/issue?@action=redirect&bpo=42780]: 修复 Linux 上 O_PATH 文件描述符的 os.set_inheritable()。

bpo-42866 [https://bugs.python.org/issue?@action=redirect&bpo=42866]: 修复 CJK 编解码器的 getcodec() 函数中的一个引用泄漏。由 Victor Stinner 提交补丁。

bpo-42846 [https://bugs.python.org/issue?@action=redirect&bpo=42846]: 将 6 个 CJK 编解码器扩展模块（_codecs_cn, _codecs_hk, _codecs_iso2022, _codecs_jp, _codecs_kr 和 _codecs_tw）转换为多阶段初始化 API (PEP 489 [https://www.python.org/dev/peps/pep-0489])。由 Victor Stinner 提交补丁。

bpo-42851 [https://bugs.python.org/issue?@action=redirect&bpo=42851]: 移除对枚举成员的 __init_subclass__ 支持

bpo-42834 [https://bugs.python.org/issue?@action=redirect&bpo=42834]: 使 _json 模块的内部缓存与子解释器兼容

bpo-41748 [https://bugs.python.org/issue?@action=redirect&bpo=41748]: 修复 HTMLParser 解析包含逗号和空格的元素属性的规则。补丁由 Karl Dubost 提供

bpo-40810 [https://bugs.python.org/issue?@action=redirect&bpo=40810]: 要求 SQLite 3.7.15 或更新版本。由 Erlend E. Aasland 提供补丁

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _multibytecodec 扩展模块（CJK 编解码器）转换为多阶段初始化（PEP 489 [https://www.python.org/dev/peps/pep-0489]）。由 Erlend E. Aasland 提供补丁

bpo-42802 [https://bugs.python.org/issue?@action=redirect&bpo=42802]: Python 3.8 中弃用的 distutils bdist_wininst 命令已被移除。现在推荐使用 distutils bdist_wheel 命令在 Windows 上分发二进制包

bpo-24464 [https://bugs.python.org/issue?@action=redirect&bpo=24464]: 未记录的 built-in 函数 sqlite3.enable_shared_cache 现已弃用，计划在 Python 3.12 中移除。SQLite3 文档强烈反对使用该函数。由 Erlend E. Aasland 提供补丁

bpo-42384 [https://bugs.python.org/issue?@action=redirect&bpo=42384]: 使 pdb 填充 sys.path[0] 的方式与常规 python 执行完全相同

bpo-42383 [https://bugs.python.org/issue?@action=redirect&bpo=42383]: 修复 pdb：如果调试目标使用相对路径指定且当前目录发生变化，pdb 将无法重新启动调试目标的问题

bpo-42005 [https://bugs.python.org/issue?@action=redirect&bpo=42005]: 修复 cProfile 和 profile 的 CLI 以捕获 BrokenPipeError

bpo-41604 [https://bugs.python.org/issue?@action=redirect&bpo=41604]: 当 set_panel_userptr 失败时，不减少先前 user_ptr 的引用计数

bpo-41149 [https://bugs.python.org/issue?@action=redirect&bpo=41149]: 允许执行传递给 Threading.thread 作为目标的可调用对象，即使其布尔值为 False。由 Barney Stratford 提供补丁

bpo-38307 [https://bugs.python.org/issue?@action=redirect&bpo=38307]: 为 pyclbr 函数返回的树中出现的类和函数对象添加 'end_lineno' 属性。此属性与现有的 'lineno' 属性共同定义类和 def 语句的范围。由 Aviral Srivastava 提供补丁

bpo-39273 [https://bugs.python.org/issue?@action=redirect&bpo=39273]: 现在如果可用，将 curses 模块中的 BUTTON5_* 常量暴露出来

bpo-33289 [https://bugs.python.org/issue?@action=redirect&bpo=33289]: 修正对 tkinter.colorchooser 的调用，使其返回整型RGB三元组而非浮点数。由 Cheryl Sabella 提供补丁。

文档

bpo-40304 [https://bugs.python.org/issue?@action=redirect&bpo=40304]: 修正 type(name, bases, dict) 的文档。由 Boris Verkhovskiy 和 Éric Araujo 提供补丁。

bpo-42811 [https://bugs.python.org/issue?@action=redirect&bpo=42811]: Updated importlib.utils.resolve_name() doc to use __spec__.parent instead of __package__. (Thanks Yair Frid.)

测试

bpo-40823 [https://bugs.python.org/issue?@action=redirect&bpo=40823]: 在 sqlite3 测试中使用 unittest.TestLoader().loadTestsFromTestCase() 而非 unittest.makeSuite()。补丁由 Erlend E. Aasland 提供。

bpo-40810 [https://bugs.python.org/issue?@action=redirect&bpo=40810]: 在 sqlite3 中，为 SQLite 3.7.15 之前版本修复 CheckTraceCallbackContent。

构建

bpo-43031 [https://bugs.python.org/issue?@action=redirect&bpo=43031]: 将 --timeout=$(TESTTIMEOUT) 选项传递给默认配置文件任务 ./python -m test --pgo 命令。

bpo-36143 [https://bugs.python.org/issue?@action=redirect&bpo=36143]: make regen-all 现在也会运行 regen-keyword。由 Victor Stinner 提供补丁。

bpo-42874 [https://bugs.python.org/issue?@action=redirect&bpo=42874]: 在配置脚本的 tzpath 验证部分移除了 grep -q 和 -E 标志，以更好地适应某些平台（特别是 Solaris 10）的用户。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为 VxWorks 在 add_cross_compiling_paths() 中添加库搜索路径，由 wr-cc 提供。

bpo-42856 [https://bugs.python.org/issue?@action=redirect&bpo=42856]: 向 ./configure 脚本添加 --with-wheel-pkg-dir=PATH 选项。如果指定，ensurepip 模块会在此目录中查找 setuptools 和 pip 轮包：如果两者都存在，则使用这些轮包而非 ensurepip 捆绑的轮包。

某些 Linux 发行版的打包策略建议不要绑定依赖关系。比如 Fedora 在 /usr/share/python-wheels/ 目录下安装 wheel 包，而不安装 ensurepip._bundled 包。

Windows

bpo-41837 [https://bugs.python.org/issue?@action=redirect&bpo=41837]: 更新 Windows 安装程序以包含 OpenSSL 1.1.1i。

bpo-42584 [https://bugs.python.org/issue?@action=redirect&bpo=42584]: 升级 Windows 安装程序以使用 SQLite 3.34.0。

macOS

bpo-42504 [https://bugs.python.org/issue?@action=redirect&bpo=42504]: 确保 sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET') 的值始终为字符串，即使在值可解析为整数时也是如此。

IDLE

bpo-43008 [https://bugs.python.org/issue?@action=redirect&bpo=43008]: 使 IDLE 在正常的双进程模式下调用 sys.excepthook()。由 Ken Hilton 提供补丁。

bpo-33065 [https://bugs.python.org/issue?@action=redirect&bpo=33065]: 修复调试带有 __repr__ 方法的用户类时的问题。

bpo-23544 [https://bugs.python.org/issue?@action=redirect&bpo=23544]: 当用户代码正在运行或调试器处于活动状态时，禁用 Debug=>Stack Viewer，以防止挂起或崩溃。由 Zackery Spytz 提供补丁。

bpo-32631 [https://bugs.python.org/issue?@action=redirect&bpo=32631]: 完成zzdummy示例扩展模块：使菜单条目正常工作；添加文档字符串和覆盖率为100%的测试。

C API

bpo-42979 [https://bugs.python.org/issue?@action=redirect&bpo=42979]: 当Python在调试模式下构建（带有C断言）时，调用类型槽如 sq_length``（Python中的 ``__len__()）现在如果槽成功但设置了异常，或失败但未设置异常，会以致命错误失败。错误消息包含槽、类型名称和当前异常（如果设置了异常）。由Victor Stinner提供补丁。

bpo-43030 [https://bugs.python.org/issue?@action=redirect&bpo=43030]: Fixed a compiler warning in Py_UNICODE_ISSPACE() on platforms with signed wchar_t.

Python 3.10.0 alpha 4

发布日期: 2021-01-04

核心与内置函数

bpo-42814 [https://bugs.python.org/issue?@action=redirect&bpo=42814]: 修复 Objects/genericaliasobject.c 中的未定义行为。

bpo-42806 [https://bugs.python.org/issue?@action=redirect&bpo=42806]: 修复被括号包围的f-字符串 ast 节点和跨越多行节点的列偏移。由Pablo Galindo提供补丁。

bpo-40631 [https://bugs.python.org/issue?@action=redirect&bpo=40631]: 修复回归，其中单个括号包围的星号表达式是有效的赋值目标。

bpo-27794 [https://bugs.python.org/issue?@action=redirect&bpo=27794]: 改进对属性对象写入/删除失败的错误消息。在可能的情况下，现在会显示属性名称。由Yurii Karabas提供补丁。

bpo-42745 [https://bugs.python.org/issue?@action=redirect&bpo=42745]: 使类型属性查找缓存为每个解释器。由Victor Stinner提供补丁。

bpo-42246 [https://bugs.python.org/issue?@action=redirect&bpo=42246]: 当会破坏PEP 626时，不会消除跳转到跳转。

bpo-42246 [https://bugs.python.org/issue?@action=redirect&bpo=42246]: 确保在引发或重新引发异常时，帧的 f_lasti 和 f_lineno 属性设置正确。PEP 626所需。

bpo-32381 [https://bugs.python.org/issue?@action=redirect&bpo=32381]: 现在在传递给 -c 命令行选项的命令中忽略编码cookie（例如：# coding: latin1）。由Victor Stinner提供补丁。

bpo-30858 [https://bugs.python.org/issue?@action=redirect&bpo=30858]: 改进包含赋值的表达式中的错误位置。由Pablo Galindo和Lysandros Nikolaou提供补丁。

bpo-42615 [https://bugs.python.org/issue?@action=redirect&bpo=42615]: 删除由于删除不可达字节码块而变得冗余的跳转命令。

bpo-42639 [https://bugs.python.org/issue?@action=redirect&bpo=42639]: Make the atexit module state per-interpreter. It is now safe have more than one atexit module instance. Patch by Dong-hee Na and Victor Stinner.

bpo-32381 [https://bugs.python.org/issue?@action=redirect&bpo=32381]: 修复在 Windows 上运行 .pyc 文件时的编码名称问题：PyRun_SimpleFileExFlags() 现在使用正确的编码来解码文件名。

bpo-42195 [https://bugs.python.org/issue?@action=redirect&bpo=42195]: typing.Callable 和 collections.abc.Callable 的参数化泛型的 __args__ 现在保持一致。collections.abc.Callable 的 __args__ 现在被扁平化，而 typing.Callable 的则保持不变。为了允许这一变化，types.GenericAlias 现在可以被继承，并且 collections.abc.Callable 的 __class_getitem__ 现在会返回一个 types.GenericAlias 的子类。类型测试也被更新，不再继承像 Callable[..., T] 这样的东西，因为那不是有效的基类。最后，两个 Callable 都不再验证它们的 argtypes，在 Callable[[argtypes], resulttype] 中，为 PEP 612 [https://www.python.org/dev/peps/pep-0612] 做准备。由 Ken Jin 提供补丁。

bpo-40137 [https://bugs.python.org/issue?@action=redirect&bpo=40137]: 将 functools 模块转换为使用 PyType_FromModuleAndSpec()。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: 将 array 转换为使用堆类型，并为这些建立模块状态。

bpo-42008 [https://bugs.python.org/issue?@action=redirect&bpo=42008]: 修复 _random.Random() 的种子设置。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 pyexpat 扩展模块移植到多阶段初始化（PEP 489 [https://www.python.org/dev/peps/pep-0489]）。

bpo-40521 [https://bugs.python.org/issue?@action=redirect&bpo=40521]: 使内联字符串的 Unicode 字典与子解释器兼容。由 Victor Stinner 提供补丁。

bpo-39465 [https://bugs.python.org/issue?@action=redirect&bpo=39465]: Make _PyUnicode_FromId() function compatible with subinterpreters. Each interpreter now has an array of identifier objects (interned strings decoded from UTF-8). Patch by Victor Stinner.

库

bpo-42257 [https://bugs.python.org/issue?@action=redirect&bpo=42257]: 在 platform.libc_ver() 中处理变量可执行文件中的空字符串

bpo-42772 [https://bugs.python.org/issue?@action=redirect&bpo=42772]: randrange() 现在在指定步长而没有停止参数时引发 TypeError。以前，它会默默地忽略步长参数。

bpo-42759 [https://bugs.python.org/issue?@action=redirect&bpo=42759]: 修复了 tkinter.Variable 和 tkinter.font.Font 的相等比较问题。现在，属于不同 Tcl 解释器的对象即使名称相同也会被视为不同。

bpo-42756 [https://bugs.python.org/issue?@action=redirect&bpo=42756]: 当未明确提供超时时间时，配置 LMTP Unix 域套接字使用套接字全局默认超时。

bpo-23328 [https://bugs.python.org/issue?@action=redirect&bpo=23328]: 允许在 _PROXY 环境变量的用户名和密码字段中使用 / 字符。

bpo-42740 [https://bugs.python.org/issue?@action=redirect&bpo=42740]: typing.get_args() 和 typing.get_origin() 现在支持 PEP 604 [https://www.python.org/dev/peps/pep-0604] 联合类型和 PEP 612 [https://www.python.org/dev/peps/pep-0612] 对 Callable 的补充。

bpo-42655 [https://bugs.python.org/issue?@action=redirect&bpo=42655]: subprocess 的 extra_groups 现在正确地传递到 setgroups() 系统调用中。

bpo-42727 [https://bugs.python.org/issue?@action=redirect&bpo=42727]: EnumMeta.__prepare__ 现在接受 **kwds 以正确支持 __init_subclass__。

bpo-38308 [https://bugs.python.org/issue?@action=redirect&bpo=38308]: 向 statistics.harmonic_mean() 添加了可选的 weights 参数。

bpo-42721 [https://bugs.python.org/issue?@action=redirect&bpo=42721]: 当创建简单查询对话框 (tkinter.simpledialog)、消息框 (tkinter.messagebox) 或颜色选择对话框 (tkinter.colorchooser) 时，如果没有提供 master 和 parent 参数，且默认根窗口尚未创建，并且未调用 NoDefaultRoot()，将自动创建一个新的临时隐藏根窗口。它不会被设置为默认根窗口，并在对话框窗口关闭后立即销毁。这将有助于在不需要其他 GUI 的程序中使用这些简单对话框窗口。

bpo-25246 [https://bugs.python.org/issue?@action=redirect&bpo=25246]: 优化了 collections.deque.remove()。

bpo-35728 [https://bugs.python.org/issue?@action=redirect&bpo=35728]: 向 tkinter.font.nametofont() 添加了一个 root 参数。

bpo-15303 [https://bugs.python.org/issue?@action=redirect&bpo=15303]: tkinter 现在支持值为布尔 False 的小部件。

bpo-42681 [https://bugs.python.org/issue?@action=redirect&bpo=42681]: 修复了 curses 中颜色和配对数字的范围检查。

bpo-42685 [https://bugs.python.org/issue?@action=redirect&bpo=42685]: 改进了 Tkinter 中简单查询窗口（如 tkinter.simpledialog.askinteger()）的放置位置。如果指定了父窗口并显示，则现在将窗口居中于父窗口的中心，否则居中于屏幕中心。

bpo-9694 [https://bugs.python.org/issue?@action=redirect&bpo=9694]: Argparse 帮助不再使用令人困惑的短语“可选参数”，而是使用“选项”。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _thread extension module to the multiphase initialization API (PEP 489 [https://www.python.org/dev/peps/pep-0489]) and convert its static types to heap types.

bpo-37961 [https://bugs.python.org/issue?@action=redirect&bpo=37961]: 修复 tracemalloc.Traceback.__repr__() 中的崩溃问题（在 Python 3.9 中回归）。

bpo-42630 [https://bugs.python.org/issue?@action=redirect&bpo=42630]: 需要默认根窗口的 tkinter 函数和构造函数现在会引发带有描述性消息的 RuntimeError，而不是晦涩的 AttributeError 或 NameError，如果它尚未创建或无法自动创建。

bpo-42639 [https://bugs.python.org/issue?@action=redirect&bpo=42639]: atexit._run_exitfuncs() 现在使用 sys.unraisablehook 记录回调异常，而不是直接将它们记录到 sys.stderr 并引发最后一个异常。

bpo-42644 [https://bugs.python.org/issue?@action=redirect&bpo=42644]: logging.disable will now validate the types and value of its parameter. It also now accepts strings representing the levels (as does loging.setLevel) instead of only the numerical values.

bpo-42639 [https://bugs.python.org/issue?@action=redirect&bpo=42639]: 在 Python 退出时，如果使用 atexit.register() 注册的回调失败，现在会记录其异常。以前，只有一些异常被记录，最后一个异常总是被默默忽略。

bpo-36541 [https://bugs.python.org/issue?@action=redirect&bpo=36541]: 修复了 lib2to3.pgen2 能够解析 PEP-570 仅位置参数语法的问题。

bpo-42382 [https://bugs.python.org/issue?@action=redirect&bpo=42382]: 在 importlib.metadata 中： - EntryPoint 对象现在在从 Distribution 构造时公开一个 .dist 对象引用 Distribution。 - 添加了对包发现规则下的包发现的支持。 - 由 metadata() 返回的对象现在有一个正式定义的协议，称为 PackageMetadata，并声明支持 .get_all() 方法。 - 与 importlib_metadata 3.3 同步。

bpo-41877 [https://bugs.python.org/issue?@action=redirect&bpo=41877]: 添加了对拼写错误的 autospect、auto_spec 和 set_spec 作为参数传递给 patch、patch.object 和 create_autospec 的检查。

bpo-39717 [https://bugs.python.org/issue?@action=redirect&bpo=39717]: [tarfile] 更新嵌套异常抛出，使用 from None 或 from e

bpo-41877 [https://bugs.python.org/issue?@action=redirect&bpo=41877]: 对于模拟对象上疑似断言拼写错误的 AttributeError，现在会指出原因是拼写错误的断言，并说明如果拼写实际上是预期的属性名时应该怎么做。unittest.mock 文档也已更新，以反映当前识别出的拼写错误集合。

bpo-41559 [https://bugs.python.org/issue?@action=redirect&bpo=41559]: 实现了 PEP 612 [https://www.python.org/dev/peps/pep-0612]：将 ParamSpec 和 Concatenate 添加到 typing 模块。由 Ken Jin 提供补丁。

bpo-42385 [https://bugs.python.org/issue?@action=redirect&bpo=42385]: StrEnum：修复 _generate_next_value_ 方法以返回字符串

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为 VxWorks 定义 THREAD_STACK_SIZE。

bpo-34750 [https://bugs.python.org/issue?@action=redirect&bpo=34750]: [Enum] _EnumDict.update() is now supported

bpo-42517 [https://bugs.python.org/issue?@action=redirect&bpo=42517]: Enum：私有名称不会成为成员/不会生成错误——它们保持为普通属性

bpo-42678 [https://bugs.python.org/issue?@action=redirect&bpo=42678]: Enum：在成员被添加后调用 __init_subclass__ 方法

bpo-28964 [https://bugs.python.org/issue?@action=redirect&bpo=28964]: ast.literal_eval() 为格式错误的节点在错误消息中添加行号信息（如果可用）。

bpo-42470 [https://bugs.python.org/issue?@action=redirect&bpo=42470]: random.sample() 不再对同时也是集合的序列发出警告。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: posixpath.expanduser() 如果用户主目录在 VxWorks 上为 None，则返回输入 path 不变。

bpo-42388 [https://bugs.python.org/issue?@action=redirect&bpo=42388]: 修复 subprocess.check_output(..., input=None) 当 text=True 时的行为，使其与文档和 universal_newlines=True 的行为一致。

bpo-34463 [https://bugs.python.org/issue?@action=redirect&bpo=34463]: 修复了 traceback 和解释器在格式化未设置 lineno 的 SyntaxError 时的不一致（traceback 被更改为匹配解释器）。

bpo-42393 [https://bugs.python.org/issue?@action=redirect&bpo=42393]: 在 socket.ntohs() 和 socket.htons() 中抛出 OverflowError 而不是静默截断。静默截断在 Python 3.7 中已被弃用。由 Erlend E. Aasland 提供补丁

bpo-42222 [https://bugs.python.org/issue?@action=redirect&bpo=42222]: 统一 random.randrange() 的参数处理以匹配 range()。

randrange() 中的整数测试和转换现在使用 operator.index()。

randrange() 函数的非整数参数已被弃用。

ValueError 已被弃用，改为使用 TypeError。

现在它比以前运行得更快一些。

（由 Raymond Hettinger 和 Serhiy Storchaka 贡献。）

bpo-42163 [https://bugs.python.org/issue?@action=redirect&bpo=42163]: 恢复 uname_result 在 deepcopy 和 _replace 时的兼容性。

bpo-42090 [https://bugs.python.org/issue?@action=redirect&bpo=42090]: zipfile.Path.joinpath 现在接受任意参数，与 pathlib.Path.joinpath 相同。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _csv 模块移植到多阶段初始化 API (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-42059 [https://bugs.python.org/issue?@action=redirect&bpo=42059]: 使用替代调用样式语法创建的 typing.TypedDict 类型现在在设置其 __required_keys__ 和 __optional_keys__ 类属性时正确尊重 total 关键字参数。

bpo-41960 [https://bugs.python.org/issue?@action=redirect&bpo=41960]: 向 inspect.signature() 和 inspect.Signature.from_callable() 添加 globalns 和 localns 参数。

bpo-41907 [https://bugs.python.org/issue?@action=redirect&bpo=41907]: 修复 IntFlag 的 format() 行为

bpo-41891 [https://bugs.python.org/issue?@action=redirect&bpo=41891]: 确保 asyncio.wait_for 等待任务完成

bpo-24792 [https://bugs.python.org/issue?@action=redirect&bpo=24792]: 修复了 zipimporter 有时报告导入错误错误原因的 bug。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为没有主目录的 VxWorks RTOS 修复 site 和 sysconfig 模块。

bpo-41462 [https://bugs.python.org/issue?@action=redirect&bpo=41462]: Add os.set_blocking() support for VxWorks RTOS.

bpo-40219 [https://bugs.python.org/issue?@action=redirect&bpo=40219]: 降低 tkinter.ttk.LabeledScale 虚拟小部件以防止隐藏部分内容标签。

bpo-37193 [https://bugs.python.org/issue?@action=redirect&bpo=37193]: 修复了 Python 3.7 中引入的 socketserver.ThreadingMixIn 内存泄漏。

bpo-39068 [https://bugs.python.org/issue?@action=redirect&bpo=39068]: 修复 base64 中 a85encode() 和 b85encode() 的初始化竞争条件。由 Brandon Stansbury 提供补丁。

文档

bpo-17140 [https://bugs.python.org/issue?@action=redirect&bpo=17140]: 为 multiprocessing.pool.ThreadPool 类添加文档。

bpo-34398 [https://bugs.python.org/issue?@action=redirect&bpo=34398]: 在文档搜索结果中突出显示词汇表中的列表。由 Ammar Askar 提供补丁。

测试

bpo-42794 [https://bugs.python.org/issue?@action=redirect&bpo=42794]: Update test_nntplib to use official group name of news.aioe.org for testing. Patch by Dong-hee Na.

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在 VxWorks 上跳过一些 asyncio 测试。

bpo-42641 [https://bugs.python.org/issue?@action=redirect&bpo=42641]: Enhance test_select.test_select(): it now takes 500 ms rather than 10 seconds. Use Python rather than a shell to make the test more portable.

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上跳过 _test_all_chown_common() 中的一些测试。

bpo-42199 [https://bugs.python.org/issue?@action=redirect&bpo=42199]: 修复字节码助手 assertNotInBytecode。

bpo-41443 [https://bugs.python.org/issue?@action=redirect&bpo=41443]: 在 test_posix.py 中添加更多属性检查。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上禁用 os.popen 和受影响的测试。

bpo-41439 [https://bugs.python.org/issue?@action=redirect&bpo=41439]: 将 test_ssl 和 test_uuid 移植到VxWorks RTOS。

构建

bpo-42692 [https://bugs.python.org/issue?@action=redirect&bpo=42692]: 修复旧编译器上的 __builtin_available 检查。由Joshua Root提供补丁。

bpo-27640 [https://bugs.python.org/issue?@action=redirect&bpo=27640]: 向 configure 脚本添加 --disable-test-modules 选项：不构建也不安装测试模块。由Xavier de Gaye、Thomas Petazzoni和Peixing Xin提供补丁。

bpo-42604 [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"。

bpo-42598 [https://bugs.python.org/issue?@action=redirect&bpo=42598]: 修复configure中的隐式函数声明，这可能导致错误的配置检查。由Joshua Root提供补丁。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为VxWorks启用 libpython3.so。

bpo-29076 [https://bugs.python.org/issue?@action=redirect&bpo=29076]: 向macOS安装程序添加fish shell支持。

macOS

bpo-42361 [https://bugs.python.org/issue?@action=redirect&bpo=42361]: 更新macOS安装程序构建以使用Tcl/Tk 8.6.11（rc2，预计为最终版本）。

bpo-41837 [https://bugs.python.org/issue?@action=redirect&bpo=41837]: 更新macOS安装程序构建以使用OpenSSL 1.1.1i。

bpo-42584 [https://bugs.python.org/issue?@action=redirect&bpo=42584]: 更新macOS安装程序以使用SQLite 3.34.0。

工具/示例

bpo-42726 [https://bugs.python.org/issue?@action=redirect&bpo=42726]: 修复了Python 3与gdb/libpython.py处理属性字典时的兼容性问题。

bpo-42613 [https://bugs.python.org/issue?@action=redirect&bpo=42613]: 修复 freeze.py 工具以使用正确的配置和库目录。补丁由Victor Stinner提供。

C API

bpo-42591 [https://bugs.python.org/issue?@action=redirect&bpo=42591]: 导出 Py_FrozenMain() 函数：修复Python 3.9.0的回归问题。Python 3.9使用 -fvisibility=hidden 并且该函数未被显式导出，因此未被导出。

bpo-32381 [https://bugs.python.org/issue?@action=redirect&bpo=32381]: Remove the private _Py_fopen() function which is no longer needed. Use _Py_wfopen() or _Py_fopen_obj() instead. Patch by Victor Stinner.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 resource 扩展模块移植到模块状态

bpo-42111 [https://bugs.python.org/issue?@action=redirect&bpo=42111]: 更新 xxlimited 模块，使其成为如何使用有限 C API 的更好示例。

bpo-40052 [https://bugs.python.org/issue?@action=redirect&bpo=40052]: 修复函数 PyVectorcall_Function() 中的对齐构建警告/错误。补丁由 Andreas Schneider、Antoine Pitrou 和 Petr Viktorin 提交。

Python 3.10.0 alpha 3

发布日期: 2020-12-07

安全性

bpo-40791 [https://bugs.python.org/issue?@action=redirect&bpo=40791]: 在 hmac.compare_digest 中为累加器变量添加 volatile，减少破坏恒定时间优化的可能性。

核心与内置函数

bpo-42576 [https://bugs.python.org/issue?@action=redirect&bpo=42576]: types.GenericAlias 现在会在尝试使用关键字参数初始化时引发 TypeError。之前，如果解释器编译时包含调试符号，这将导致解释器崩溃。这不影响为发布编译的解释器。补丁由 Ken Jin 提交。

bpo-42536 [https://bugs.python.org/issue?@action=redirect&bpo=42536]: 现在，几个内置和标准库类型确保它们的内部结果元组总是被 垃圾收集器 跟踪:

collections.OrderedDict.items()

dict.items()

enumerate()

functools.reduce()

itertools.combinations()

itertools.combinations_with_replacement()

itertools.permutations()

itertools.product()

itertools.zip_longest()

zip()

之前，它们可能会被前一次垃圾回收取消追踪。 由 Brandt Bucher 提供补丁。

bpo-42500 [https://bugs.python.org/issue?@action=redirect&bpo=42500]: 改进递归限制附近的异常处理。将一些致命错误转换为 RecursionErrors。

bpo-42246 [https://bugs.python.org/issue?@action=redirect&bpo=42246]: PEP 626: 在返回后，帧的 f_lineno 属性总是最后执行的行。

bpo-42435 [https://bugs.python.org/issue?@action=redirect&bpo=42435]: 当指定选项 -b 时，加快 bytes 对象与非 bytes 对象的比较速度。加快 bytearray 对象与非缓冲对象的比较速度。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _warnings 扩展模块移植到多阶段初始化 API (PEP 489 [https://www.python.org/dev/peps/pep-0489])。补丁由 Victor Stinner 提交。

bpo-41686 [https://bugs.python.org/issue?@action=redirect&bpo=41686]: 在 Windows 上，即使 Python 配置为不安装信号处理程序（如果 PyConfig.install_signal_handlers 等于 0，或 Py_InitializeEx(0)），现在也会创建 SIGINT 事件 _PyOS_SigintEvent()。

bpo-42381 [https://bugs.python.org/issue?@action=redirect&bpo=42381]: 根据PEP 572，允许在集合字面量和集合推导式中使用赋值表达式。由Pablo Galindo提供补丁。

bpo-42202 [https://bugs.python.org/issue?@action=redirect&bpo=42202]: 将函数参数注解的内部表示更改为字符串元组。由Yurii Karabas提供补丁。

bpo-42374 [https://bugs.python.org/issue?@action=redirect&bpo=42374]: 修复了新解析器引入的一个回归问题，即在生成器表达式中不允许使用未加括号的海象运算符。

bpo-42316 [https://bugs.python.org/issue?@action=redirect&bpo=42316]: 允许在下标索引中使用未加括号的海象运算符。

bpo-42349 [https://bugs.python.org/issue?@action=redirect&bpo=42349]: Make sure that the compiler front-end produces a well-formed control flow graph. Be be more aggressive in the compiler back-end, as it is now safe to do so.

bpo-42296 [https://bugs.python.org/issue?@action=redirect&bpo=42296]: 在Windows上，修复了信号处理中的一个回归问题，该问题阻止了使用CTRL+C中断程序。信号处理程序可以在与Python线程不同的线程中运行，在这种情况下，判断线程是否可以处理信号的测试是错误的。

bpo-42332 [https://bugs.python.org/issue?@action=redirect&bpo=42332]: types.GenericAlias 对象现在可以作为弱引用的目标。

bpo-42282 [https://bugs.python.org/issue?@action=redirect&bpo=42282]: 优化作为命名表达式一部分出现的常量子表达式（之前AST优化器没有深入到命名表达式中）。由Nick Coghlan提供补丁。

bpo-42266 [https://bugs.python.org/issue?@action=redirect&bpo=42266]: 修复了LOAD_ATTR操作码缓存的一个错误，该错误没有尊重将一个类级别属性猴子补丁为描述符。由Pablo Galindo提供补丁。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: 将 queue 转换为使用堆类型。

bpo-42246 [https://bugs.python.org/issue?@action=redirect&bpo=42246]: 提高了行跟踪事件和Frame对象的f_lineno属性的准确性。详见PEP 626。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: 将 mmap 转换为使用堆类型。

bpo-42233 [https://bugs.python.org/issue?@action=redirect&bpo=42233]: 允许 GenericAlias 对象使用 union type expressions。这使得像 list[int] | dict[float, str] 这样的表达式成为可能，而之前会抛出 TypeError。这也修复了联合类型表达式未去重 GenericAlias 对象的问题。（由Ken Jin在 bpo-42233 [https://bugs.python.org/issue?@action=redirect&bpo=42233] 中贡献。）

bpo-26131 [https://bugs.python.org/issue?@action=redirect&bpo=26131]: The import system triggers a ImportWarning when it falls back to using load_module().

库

bpo-5054 [https://bugs.python.org/issue?@action=redirect&bpo=5054]: CGIHTTPRequestHandler.run_cgi() 中 HTTP_ACCEPT 解析不当。用通用的 get_all 方法替换特殊用途的 getallmatchingheaders，并添加相关测试。

原始由 Martin Panter 提供补丁，由 Senthil Kumaran 修改。

bpo-42562 [https://bugs.python.org/issue?@action=redirect&bpo=42562]: 修复了当 dis 无法解析没有行号的函数时的问题。由 Yurii Karabas 提供补丁。

bpo-17735 [https://bugs.python.org/issue?@action=redirect&bpo=17735]: inspect.findsource() 现在在代码对象的 co_lineno 大于文件长度时，会引发 OSError 而不是 IndexError。例如，当文件在导入后被编辑时可能会发生此情况。PR 由 Irit Katriel 提供。

bpo-42116 [https://bugs.python.org/issue?@action=redirect&bpo=42116]: 修复了 inspect.getsource() 处理尾部注释的问题。

bpo-42532 [https://bugs.python.org/issue?@action=redirect&bpo=42532]: 当向 Mock 传递 spec_arg 参数时，移除了对 __bool__ 的意外调用。

bpo-38200 [https://bugs.python.org/issue?@action=redirect&bpo=38200]: 添加了 itertools.pairwise()

bpo-41818 [https://bugs.python.org/issue?@action=redirect&bpo=41818]: 修复了 test_master_read()，使其在所有平台上都能成功，这些平台在从主设备读取时要么引发 OSError，要么返回 b""。

bpo-42487 [https://bugs.python.org/issue?@action=redirect&bpo=42487]: ChainMap.__iter__ 不再调用底层映射的 __getitem__

bpo-42482 [https://bugs.python.org/issue?@action=redirect&bpo=42482]: TracebackException 不再持有对异常回溯对象的引用。因此，对于等效但不相等的异常，TracebackException 的实例现在比较为相等。

bpo-41818 [https://bugs.python.org/issue?@action=redirect&bpo=41818]: 使 test_openpty() 避免由于行数和/或列数 == 0 而导致的意外成功。

bpo-42392 [https://bugs.python.org/issue?@action=redirect&bpo=42392]: 从 asyncio.subprocess 和 asyncio.tasks 函数中移除 loop 参数。补丁由 Yurii Karabas 提供。

bpo-42392 [https://bugs.python.org/issue?@action=redirect&bpo=42392]: 从 asyncio.open_connection 和 asyncio.start_server 函数中移除 loop 参数。由 Yurii Karabas 提供补丁。

bpo-28468 [https://bugs.python.org/issue?@action=redirect&bpo=28468]: 添加了 platform.freedesktop_os_release() 函数以解析 freedesktop.org 的 os-release 文件。

bpo-42299 [https://bugs.python.org/issue?@action=redirect&bpo=42299]: Removed the formatter module, which was deprecated in Python 3.4. It is somewhat obsolete, little used, and not tested. It was originally scheduled to be removed in Python 3.6, but such removals were delayed until after Python 2.7 EOL. Existing users should copy whatever classes they use into their code. Patch by Dong-hee Na and and Terry J. Reedy.

bpo-26131 [https://bugs.python.org/issue?@action=redirect&bpo=26131]: 弃用zipimport.zipimporter.load_module()，推荐使用exec_module()。

bpo-41818 [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从其复制循环中退出。

bpo-42392 [https://bugs.python.org/issue?@action=redirect&bpo=42392]: 从所有 asyncio.locks``和 ``asyncio.Queue 类的 __init__ 中移除loop参数。由Yurii Karabas提供补丁。

bpo-15450 [https://bugs.python.org/issue?@action=redirect&bpo=15450]: 使 filecmp.dircmp 尊重子类化。现在 filecmp.dircmp.subdirs 在子类化dircmp时的行为符合预期。

bpo-42413 [https://bugs.python.org/issue?@action=redirect&bpo=42413]: 异常 socket.timeout 现在是 TimeoutError 的别名。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上支持signal模块。

bpo-42406 [https://bugs.python.org/issue?@action=redirect&bpo=42406]: We fixed an issue in pickle.whichmodule in which importing multiprocessing could change the how pickle identifies which module an object belongs to, potentially breaking the unpickling of those objects.

bpo-42403 [https://bugs.python.org/issue?@action=redirect&bpo=42403]: Simplify the importlib external bootstrap code: importlib._bootstrap_external now uses regular imports to import builtin modules. When it is imported, the builtin __import__() function is already fully working and so can be used to import builtin modules like sys. Patch by Victor Stinner.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将_sre模块类型转换为堆类型（PEP 384）。由Erlend E. Aasland提供补丁。

bpo-42375 [https://bugs.python.org/issue?@action=redirect&bpo=42375]: subprocess 模块更新以支持 DragonFlyBSD。

bpo-41713 [https://bugs.python.org/issue?@action=redirect&bpo=41713]: 将 _signal 扩展模块移植到多阶段初始化 API (PEP 489 [https://www.python.org/dev/peps/pep-0489])。由 Victor Stinner 和 Mohamed Koubaa 提供补丁。

bpo-37205 [https://bugs.python.org/issue?@action=redirect&bpo=37205]: time.time(), time.perf_counter() and time.monotonic() functions can no longer fail with a Python fatal error, instead raise a regular Python exception on failure.

bpo-42328 [https://bugs.python.org/issue?@action=redirect&bpo=42328]: 修复了 tkinter.ttk.Style.map()。该函数现在接受默认状态的表示为空序列（由 Style.map() 返回）。结果的结构现在在所有平台上都是相同的，不依赖于 wantobjects 的值。

bpo-42345 [https://bugs.python.org/issue?@action=redirect&bpo=42345]: 修复了 typing.Literal 参数处理中的各种问题（扁平化、去重、使用类型缓存键）。由 Yurii Karabas 提供补丁。

bpo-37205 [https://bugs.python.org/issue?@action=redirect&bpo=37205]: time.perf_counter() on Windows and time.monotonic() on macOS are now system-wide. Previously, they used an offset computed at startup to reduce the precision loss caused by the float type. Use time.perf_counter_ns() and time.monotonic_ns() added in Python 3.7 to avoid this precision loss.

bpo-42318 [https://bugs.python.org/issue?@action=redirect&bpo=42318]: 在 macOS 上修复了 tkinter 中对非 BMP 字符的支持。

bpo-42350 [https://bugs.python.org/issue?@action=redirect&bpo=42350]: 修复了 threading.Thread 类在 fork 时的问题：如果线程已经停止（例如：在 Python 退出时调用 fork），则不执行任何操作。以前，在子进程中会记录一个错误。

bpo-42333 [https://bugs.python.org/issue?@action=redirect&bpo=42333]: 将 _ssl 扩展模块移植到堆类型。

bpo-42014 [https://bugs.python.org/issue?@action=redirect&bpo=42014]: 现在，当 os.open 失败时，shutil.rmtree 的 onerror 回调会接收到正确的函数。

bpo-42237 [https://bugs.python.org/issue?@action=redirect&bpo=42237]: Fix os.sendfile() on illumos.

bpo-42308 [https://bugs.python.org/issue?@action=redirect&bpo=42308]: 添加 threading.__excepthook__ 以允许在 threading.excepthook() 被设置为损坏或不同的值时检索其原始值。由 Mario Corchero 提供补丁。

bpo-42131 [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()的文档化弃用。

bpo-41877 [https://bugs.python.org/issue?@action=redirect&bpo=41877]：非不安全的Mock对象现在如果访问带有前缀asert、aseert或assrt的属性，将引发AttributeError，此外，对于前缀assert或assret，这种情况已经发生。

bpo-42264 [https://bugs.python.org/issue?@action=redirect&bpo=42264]：``sqlite3.OptimizedUnicode``自Python 3.3起已无文档且过时，当时它被设为 str 的别名。现在它已被弃用，计划在Python 3.12中移除。

bpo-42251 [https://bugs.python.org/issue?@action=redirect&bpo=42251]：添加了 threading.gettrace() 和 threading.getprofile() 以分别获取由 threading.settrace() 和 threading.setprofile() 设置的函数。由Mario Corchero提供的补丁。

bpo-42249 [https://bugs.python.org/issue?@action=redirect&bpo=42249]：修复了写入大于4 GiB的二进制Plist文件的问题。

bpo-42236 [https://bugs.python.org/issue?@action=redirect&bpo=42236]：在Unix上，如果启用了 Python UTF-8模式，os.device_encoding() 函数现在返回 'UTF-8' 而不是设备编码。

bpo-41754 [https://bugs.python.org/issue?@action=redirect&bpo=41754]：webbrowser：调用 xdg-settings 时忽略*NotADirectoryError*。

bpo-42183 [https://bugs.python.org/issue?@action=redirect&bpo=42183]：修复了asyncio任务或Future的repr()导致的堆栈溢出错误。

在 Task 或 Future 递归返回自身的情形下会导致栈溢出。

bpo-42140 [https://bugs.python.org/issue?@action=redirect&bpo=42140]：改进asyncio.wait函数，使其仅创建一次futures集合。

bpo-42133 [https://bugs.python.org/issue?@action=redirect&bpo=42133]: Update various modules in the stdlib to fall back on __spec__.loader when __loader__ isn't defined on a module.

bpo-26131 [https://bugs.python.org/issue?@action=redirect&bpo=26131]: The load_module() methods found in importlib now trigger a DeprecationWarning.

bpo-39825 [https://bugs.python.org/issue?@action=redirect&bpo=39825]：Windows：将 sysconfig.get_config_var('EXT_SUFFIX') 更改为预期的完整``platform_tag.extension``格式。之前它被硬编码为 .pyd，现在它与 distutils.sysconfig``兼容，将产生类似 ``.cp38-win_amd64.pyd 的结果。这使Windows与其他平台一致。

bpo-26389 [https://bugs.python.org/issue?@action=redirect&bpo=26389]: traceback.format_exception()、traceback.format_exception_only() 和 traceback.print_exception() 函数现在可以接受异常对象作为仅位置参数。

bpo-41889 [https://bugs.python.org/issue?@action=redirect&bpo=41889]: Enum: 修复涉及继承多重继承枚举的回归问题

bpo-41861 [https://bugs.python.org/issue?@action=redirect&bpo=41861]: 将 sqlite3 转换为使用堆类型（PEP 384）。由Erlend E. Aasland提供补丁。

bpo-40624 [https://bugs.python.org/issue?@action=redirect&bpo=40624]: 在xml.etree中增加了对XPath != 操作符的支持

bpo-28850 [https://bugs.python.org/issue?@action=redirect&bpo=28850]: 修复 pprint.PrettyPrinter.format() 对小容器内容的覆盖被忽略的问题。pprint._safe_repr() 函数已被移除。

bpo-41625 [https://bugs.python.org/issue?@action=redirect&bpo=41625]: 将 splice() 作为 os.splice() 暴露在 os 模块中。由Pablo Galindo提供补丁。

bpo-34215 [https://bugs.python.org/issue?@action=redirect&bpo=34215]: 当 expected 为 None 时，澄清 asyncio.IncompleteReadError 的错误消息。

bpo-41543 [https://bugs.python.org/issue?@action=redirect&bpo=41543]: 为contextlib.nullcontext添加异步上下文管理器支持。

bpo-21041 [https://bugs.python.org/issue?@action=redirect&bpo=21041]: pathlib.PurePath.parents 现在支持负索引。补丁由Yaroslav Pankovych贡献。

bpo-41332 [https://bugs.python.org/issue?@action=redirect&bpo=41332]: 向 asyncio.AbstractEventLoop 添加了缺失的connect_accepted_socket()方法。

bpo-12800 [https://bugs.python.org/issue?@action=redirect&bpo=12800]: 从tarball中提取符号链接应该成功，并在符号链接已存在时覆盖它。修复方法是在提取前移除现有的文件或符号链接。基于Chris AtLee、Jeffrey Kintscher和Senthil Kumaran的补丁。

bpo-40968 [https://bugs.python.org/issue?@action=redirect&bpo=40968]: urllib.request 和 http.client 现在在没有提供自定义上下文时，在TLS握手期间发送 http/1.1 ALPN扩展。

bpo-41001 [https://bugs.python.org/issue?@action=redirect&bpo=41001]: Add func:os.eventfd to provide a low level interface for Linux's event notification file descriptor.

bpo-40816 [https://bugs.python.org/issue?@action=redirect&bpo=40816]: 向contextlib添加AsyncContextDecorator以支持异步上下文管理器作为装饰器。

bpo-40550 [https://bugs.python.org/issue?@action=redirect&bpo=40550]: 修复subprocess.Popen.send_signal中的检查时间/动作时间问题。

bpo-39411 [https://bugs.python.org/issue?@action=redirect&bpo=39411]: 向 pyclbr 的 Function 对象添加一个 is_async 标识符。由Batuhan Taskaya提供补丁。

bpo-35498 [https://bugs.python.org/issue?@action=redirect&bpo=35498]: 为 pathlib.PurePath.parents 添加切片支持。

文档

bpo-42238 [https://bugs.python.org/issue?@action=redirect&bpo=42238]: 尝试通过首先从CI和文档构建中移除 make suspicious 来弃用它，但仍保留供手动使用。

bpo-42153 [https://bugs.python.org/issue?@action=redirect&bpo=42153]: 修复IMAP协议文档的URL。

bpo-41028 [https://bugs.python.org/issue?@action=redirect&bpo=41028]: 语言和版本切换器之前由每个cpython分支维护，现在由docsbuild-script处理。

测试

bpo-41473 [https://bugs.python.org/issue?@action=redirect&bpo=41473]: 在gdb 9.2及更新版本上重新启用test_gdb：https://bugzilla.redhat.com/show_bug.cgi?id=1866884 在gdb 10.1中修复。

bpo-42553 [https://bugs.python.org/issue?@action=redirect&bpo=42553]: 修复 test_asyncio.test_call_later() 的竞争条件：不在 call_later() 单元测试中测量asyncio性能。测试在CI上随机失败。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上修复test_netrc：使用temp_cwd()创建临时目录。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上跳过test_getaddrinfo_ipv6_scopeid_symbolic和test_getnameinfo_ipv6_scopeid_symbolic。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上跳过test_test的test_mailcap。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为test_pipes添加shell要求。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上跳过一些与fifo相关的测试。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 修复VxWorks的test_doctest.py失败。

bpo-40754 [https://bugs.python.org/issue?@action=redirect&bpo=40754]: 在Windows安装程序中包含 _testinternalcapi 模块用于测试套件。

bpo-41561 [https://bugs.python.org/issue?@action=redirect&bpo=41561]: test_ssl：当TLS 1.0不可用时跳过test_min_max_version_mismatch。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 修复VxWorks RTOS的os模块失败。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 修复VxWorks RTOS的fifo测试用例。

构建

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为VxWorks的detect_socket()移除libnet依赖。

bpo-42398 [https://bugs.python.org/issue?@action=redirect&bpo=42398]: 当使用make -jN选项并行运行作业时，修复"make regen-all"中的竞争条件。clinic.py脚本现在仅使用原子写入来写入文件。此外，如果内容未更改，则生成的文件现在保持不变，以不更改文件修改时间。

bpo-41617 [https://bugs.python.org/issue?@action=redirect&bpo=41617]: 修复在旧版 clang（如 Mac OS X 10.7 上的 Xcode 4.6.3）没有 __builtin_bswap16() 时构建 pycore_bitutils.h 内部头文件的问题。由 Joshua Root 和 Victor Stinner 提供补丁。

bpo-38823 [https://bugs.python.org/issue?@action=redirect&bpo=38823]: 现在没有 wchar_t 类型就无法构建 _ctypes 扩展模块：移除了 CTYPES_UNICODE 宏。无论如何，构建 Python 需要 wchar_t 类型。由 Victor Stinner 提供补丁。

bpo-42087 [https://bugs.python.org/issue?@action=redirect&bpo=42087]: 移除了对 AIX 5.3 及以下版本的支持。参见 bpo-40680 [https://bugs.python.org/issue?@action=redirect&bpo=40680]。

bpo-40998 [https://bugs.python.org/issue?@action=redirect&bpo=40998]: 解决了未定义行为消毒器（ubsan）发现的三个编译器警告。

Windows

bpo-42120 [https://bugs.python.org/issue?@action=redirect&bpo=42120]: 移除了头文件中 copysign (到 _copysign) 的宏定义。

bpo-38506 [https://bugs.python.org/issue?@action=redirect&bpo=38506]: Windows 启动器现在在列出已安装的 Python 版本时正确处理 Python 3.10。

macOS

bpo-42504 [https://bugs.python.org/issue?@action=redirect&bpo=42504]: 修复了在 MACOSX_DEPLOYMENT_TARGET=11 时在 macOS Big Sur 上的构建问题。

bpo-41116 [https://bugs.python.org/issue?@action=redirect&bpo=41116]: 确保 distutils.unixxcompiler.find_library_file 可以在 macOS 11 上找到系统提供的库。

bpo-41100 [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 及更高版本测试的。

bpo-42232 [https://bugs.python.org/issue?@action=redirect&bpo=42232]: 向 mmap 模块添加了 Darwin 特定的 madvise 选项。

bpo-38443 [https://bugs.python.org/issue?@action=redirect&bpo=38443]: 配置脚本的 --enable-universalsdk 和 --with-universal-archs 选项现在检查指定的架构是否可以使用。

IDLE

bpo-42508 [https://bugs.python.org/issue?@action=redirect&bpo=42508]: 保持 IDLE 在 macOS 上运行。移除在使用 macOS 11 上构建的新 universal2 安装程序时阻止使用快捷方式运行文件的过时解决方法。

bpo-42426 [https://bugs.python.org/issue?@action=redirect&bpo=42426]: 修复了在搜索引擎中报告 RE 错误的偏移量。

bpo-42415 [https://bugs.python.org/issue?@action=redirect&bpo=42415]: 通过使用 inspect.getdoc 更频繁地获取 IDLE 调用提示的文档字符串。

工具/示例

bpo-42212 [https://bugs.python.org/issue?@action=redirect&bpo=42212]: smelly.py 脚本现在不仅检查 Python 静态库，还会检查 Python 动态库和扩展模块。同时使脚本输出更详细：解释其功能。

bpo-36310 [https://bugs.python.org/issue?@action=redirect&bpo=36310]: 允许 Tools/i18n/pygettext.py 检测 f-strings 中对 gettext 的调用。

C API

bpo-42423 [https://bugs.python.org/issue?@action=redirect&bpo=42423]: PyType_FromSpecWithBases() 和 PyType_FromModuleAndSpec() 函数现在接受单个类作为 bases 参数。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 select 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _posixsubprocess 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _posixshmem 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _struct 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port spwd extension module to multiphase initialization (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 gc 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _queue 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: 将 Py_TYPE() 和 Py_SIZE() 转换回宏，以允许将它们用作左值。许多第三方 C 扩展模块依赖于使用 Py_TYPE() 和 Py_SIZE() 来设置对象类型和大小的能力：Py_TYPE(obj) = type; 和 Py_SIZE(obj) = size;。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 symtable 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 grp 和 pwd 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _random 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _hashlib 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])

bpo-41713 [https://bugs.python.org/issue?@action=redirect&bpo=41713]: 移除了未文档化的 PyOS_InitInterrupts() 函数。初始化 Python 已经隐式安装了信号处理器：参见 PyConfig.install_signal_handlers。由 Victor Stinner 提供补丁。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: The Py_TRASHCAN_BEGIN macro no longer accesses PyTypeObject attributes, but now can get the condition by calling the new private _PyTrash_cond() function which hides implementation details.

bpo-42260 [https://bugs.python.org/issue?@action=redirect&bpo=42260]: 如果在 Py_Initialize() 之前（即 Python 初始化之前）调用 Py_GetPath()、Py_GetPrefix()、Py_GetExecPrefix()、Py_GetProgramFullPath()、Py_GetPythonHome() 和 Py_GetProgramName() 函数，这些函数现在会返回 NULL。使用新的 Python 初始化配置 API 来获取 Python 路径配置。由 Victor Stinner 提供补丁。

bpo-42260 [https://bugs.python.org/issue?@action=redirect&bpo=42260]: PyConfig_Read() 函数现在只解析 PyConfig.argv 参数一次：参数解析后 PyConfig.parse_argv 被设为 2。由于 Python 参数已从 PyConfig.argv 中剥离，解析参数两次会将应用程序选项作为 Python 选项解析。

bpo-42262 [https://bugs.python.org/issue?@action=redirect&bpo=42262]: 添加了 Py_NewRef() 和 Py_XNewRef() 函数，用于增加对象的引用计数并返回该对象。由 Victor Stinner 提供补丁。

bpo-42260 [https://bugs.python.org/issue?@action=redirect&bpo=42260]: 当 Py_Initialize() 被调用两次时，第二次调用现在会更新更多配置相关的 sys 属性，而不仅仅是 sys.argv。由 Victor Stinner 提供补丁。

bpo-41832 [https://bugs.python.org/issue?@action=redirect&bpo=41832]: PyType_FromModuleAndSpec() 函数现在接受 NULL tp_doc 槽。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 添加了 PyModule_AddObjectRef() 函数：类似于 PyModule_AddObject()，但在成功时不窃取对值的引用。由 Victor Stinner 提供补丁。

bpo-42171 [https://bugs.python.org/issue?@action=redirect&bpo=42171]: The METH_FASTCALL calling convention is added to the limited API. The functions PyModule_AddType(), PyType_FromModuleAndSpec(), PyType_GetModule() and PyType_GetModuleState() are added to the limited API on Windows.

bpo-42085 [https://bugs.python.org/issue?@action=redirect&bpo=42085]: 为发送值添加了 PyAsyncMethods 的专用条目

bpo-41073 [https://bugs.python.org/issue?@action=redirect&bpo=41073]: PyType_GetSlot() 现在可以接受静态类型。

bpo-30459 [https://bugs.python.org/issue?@action=redirect&bpo=30459]: PyList_SET_ITEM(), PyTuple_SET_ITEM() 和 PyCell_SET() 宏不能再被用作左值或右值。例如，x = PyList_SET_ITEM(a, b, c) 和 PyList_SET_ITEM(a, b, c) = x 现在会引发编译器错误。这防止了像 if (PyList_SET_ITEM (a, b, c) < 0) ... 这样的测试。由 Zackery Spytz 和 Victor Stinner 提供补丁。

Python 3.10.0 alpha 2

发布日期: 2020-11-03

安全性

bpo-42103 [https://bugs.python.org/issue?@action=redirect&bpo=42103]: 防止了处理格式错误的二进制格式Apple属性列表文件时可能通过CPU和RAM耗尽导致的DoS攻击。

bpo-42051 [https://bugs.python.org/issue?@action=redirect&bpo=42051]: plistlib 模块不再接受XML plist文件中的实体声明，以避免XML漏洞。这对用户应该没有影响，因为实体声明在常规的plist文件中并未使用。

核心与内置函数

bpo-42236 [https://bugs.python.org/issue?@action=redirect&bpo=42236]: 如果 nl_langinfo(CODESET) 函数返回空字符串，Python现在使用UTF-8作为文件系统编码。由 Victor Stinner 提供补丁。

bpo-42218 [https://bugs.python.org/issue?@action=redirect&bpo=42218]: 修复了PEG解析器中导致调试模式下崩溃的一个错误。现在在左递归规则中检查错误，以避免这些错误未能及时处理并在其他地方表现为长距离崩溃的情况。

bpo-42214 [https://bugs.python.org/issue?@action=redirect&bpo=42214]: 修复了在 barry_as_flufl 规则中检查 '!=' 标记时PEG解析器可能崩溃的问题。由 Pablo Galindo 提供补丁。

bpo-42206 [https://bugs.python.org/issue?@action=redirect&bpo=42206]: 在解析器中传播并引发由 PyAST_Validate() 引起的错误。

bpo-41796 [https://bugs.python.org/issue?@action=redirect&bpo=41796]: ast 模块的内部状态现在是每个解释器独立的。补丁由 Victor Stinner 提供。

bpo-42143 [https://bugs.python.org/issue?@action=redirect&bpo=42143]: 修复了在创建 PyFunctionObject 过程中错误处理的问题，该问题导致了对未初始化内存的操作。由 Yonatan Goldschmidt 提供补丁。

bpo-41659 [https://bugs.python.org/issue?@action=redirect&bpo=41659]: Fix a bug in the parser, where a curly brace following a primary didn't fail immediately. This led to invalid expressions like a {b} to throw a SyntaxError with a wrong offset, or invalid expressions ending with a curly brace like a { to not fail immediately in the REPL.

bpo-42150 [https://bugs.python.org/issue?@action=redirect&bpo=42150]: 修复新解析器在检查续行时可能出现的缓冲区溢出。由 Pablo Galindo 提供补丁。

bpo-42123 [https://bugs.python.org/issue?@action=redirect&bpo=42123]: 运行解析器两次。第一次运行时，禁用所有仅生成更好错误消息的规则以提高性能。如果解析失败，则第二次运行时启用这些规则。

bpo-42093 [https://bugs.python.org/issue?@action=redirect&bpo=42093]: LOAD_ATTR 指令现在使用新的“每个操作码缓存”机制，速度提高了约 36%。补丁由 Pablo Galindo 和 Yury Selivanov 提供。

bpo-42030 [https://bugs.python.org/issue?@action=redirect&bpo=42030]: 移除了对旧版 AIX 特定共享库加载的支持。自 4.3 版本以来，所有 AIX 版本都支持并默认使用通用的 Unix 机制。

bpo-41984 [https://bugs.python.org/issue?@action=redirect&bpo=41984]: 垃圾收集器现在跟踪所有用户定义的类。由 Brandt Bucher 提供补丁。

bpo-41993 [https://bugs.python.org/issue?@action=redirect&bpo=41993]: 修复了在导入失败时从 sys.modules 中删除未完全初始化的模块可能引发的问题。

bpo-41979 [https://bugs.python.org/issue?@action=redirect&bpo=41979]: PEG 解析器现在允许在 with 项目的目标中使用星号解包。

bpo-41974 [https://bugs.python.org/issue?@action=redirect&bpo=41974]: 移除了 complex 类的特殊方法 __int__, __float__, __floordiv__, __mod__, __divmod__, __rfloordiv__, __rmod__ 和 __rdivmod__。这些方法总是抛出 TypeError。

bpo-41902 [https://bugs.python.org/issue?@action=redirect&bpo=41902]: Micro optimization when compute sq_item and mp_subscript of range. Patch by Dong-hee Na.

bpo-41894 [https://bugs.python.org/issue?@action=redirect&bpo=41894]: 在加载本地模块并且加载失败时，防止在不使用 UTF-8 语言环境运行时可能出现的 UnicodeDecodeError，通过使用当前语言环境的编码解码加载错误消息。

bpo-41902 [https://bugs.python.org/issue?@action=redirect&bpo=41902]: Micro optimization for range.index if step is 1. Patch by Dong-hee Na.

bpo-41435 [https://bugs.python.org/issue?@action=redirect&bpo=41435]: Add sys._current_exceptions() function to retrieve a dictionary mapping each thread's identifier to the topmost exception currently active in that thread at the time the function is called.

bpo-38605 [https://bugs.python.org/issue?@action=redirect&bpo=38605]: Enable from __future__ import annotations (PEP 563 [https://www.python.org/dev/peps/pep-0563]) by default. The values found in __annotations__ dicts are now strings, e.g. {"x": "int"} instead of {"x": int}.

库

bpo-35455 [https://bugs.python.org/issue?@action=redirect&bpo=35455]: 在Solaris上，thread_time() 现在通过 gethrvtime() 实现，因为``clock_gettime(CLOCK_THREAD_CPUTIME_ID)``并不总是可用。由Jakub Kulik提供补丁。

bpo-42233 [https://bugs.python.org/issue?@action=redirect&bpo=42233]:对于包含 Generic Alias Types 的 typing 类型，其 repr() 表示形式此前不会在 GenericAlias 中显示参数化类型。现在这一行为已调整为会显示参数化类型。

bpo-29566 [https://bugs.python.org/issue?@action=redirect&bpo=29566]: binhex.binhex() 一致地写入macOS 9行结束符。

bpo-26789 [https://bugs.python.org/issue?@action=redirect&bpo=26789]: logging.FileHandler 类现在保留对内置 open() 函数的引用，以便在Python终止期间能够打开或重新打开文件。修复如 NameError: name 'open' is not defined 的错误。由Victor Stinner提供补丁。

bpo-42157 [https://bugs.python.org/issue?@action=redirect&bpo=42157]: 移除了 unicodedata.ucnhash_CAPI 属性，这是一个内部的PyCapsule对象。相关的私有 _PyUnicode_Name_CAPI 结构被移动到内部C API。由Victor Stinner提供补丁。

bpo-42157 [https://bugs.python.org/issue?@action=redirect&bpo=42157]: 将 unicodedata 扩展模块转换为多阶段初始化API (PEP 489 [https://www.python.org/dev/peps/pep-0489])，并将``unicodedata.UCD``静态类型转换为堆类型。由Mohamed Koubaa和Victor Stinner提供补丁。

bpo-42146 [https://bugs.python.org/issue?@action=redirect&bpo=42146]: Fix memory leak in subprocess.Popen() in case an uid (gid) specified in user (group, extra_groups) overflows uid_t (gid_t).

bpo-42103 [https://bugs.python.org/issue?@action=redirect&bpo=42103]: InvalidFileException 和 RecursionError 现在是加载损坏的二进制 Plist 文件时仅会引发的错误（在之前的一些特定情况下可能会引发 ValueError 和 TypeError）。

bpo-41490 [https://bugs.python.org/issue?@action=redirect&bpo=41490]: 在 importlib.resources 中，.path 方法更加积极地提前释放对 zipfile 对象的句柄，使得像 certifi 这样的用例可以在保持上下文打开的同时删除底层的 zip 文件。

bpo-41052 [https://bugs.python.org/issue?@action=redirect&bpo=41052]: 现在，使用协议 0 和 1 对 C 中实现的堆类型进行 Pickle 操作会引发错误，而不是产生不正确的数据。

bpo-42089 [https://bugs.python.org/issue?@action=redirect&bpo=42089]: 在 importlib.metadata.PackageNotFoundError 中，引用缺失的包元数据以改善用户体验。

bpo-41491 [https://bugs.python.org/issue?@action=redirect&bpo=41491]: plistlib: 修复解析带有十六进制整数值的 XML plists 的问题

bpo-42065 [https://bugs.python.org/issue?@action=redirect&bpo=42065]: Fix an incorrectly formatted error from _codecs.charmap_decode() when called with a mapped value outside the range of valid Unicode code points. PR by Max Bernstein.

bpo-41966 [https://bugs.python.org/issue?@action=redirect&bpo=41966]: 修复纯 Python datetime.time 子类的 Pickle 操作。由 Dean Inwood 提供的补丁。

bpo-19270 [https://bugs.python.org/issue?@action=redirect&bpo=19270]: sched.scheduler.cancel() will now cancel the correct event, if two events with same priority are scheduled for the same time. Patch by Bar Harel.

bpo-28660 [https://bugs.python.org/issue?@action=redirect&bpo=28660]: textwrap.wrap() 现在在 break_long_words=True 和 break_on_hyphens=True 时尝试在连字符后断开长单词。

bpo-35823 [https://bugs.python.org/issue?@action=redirect&bpo=35823]: 在 Linux 上为 subprocess.Popen() 使用 vfork() 替代 fork()，以提高在认为安全的情况下的性能。

bpo-42043 [https://bugs.python.org/issue?@action=redirect&bpo=42043]: 添加对 zipfile.Path 继承的支持。zipfile.Path.is_file() 现在对于不存在的名称返回 False。zipfile.Path 对象现在暴露一个 .filename 属性，并依赖该属性在 Path 对象位于 zipfile 根目录时解析 .name 和 .parent。

bpo-42021 [https://bugs.python.org/issue?@action=redirect&bpo=42021]: 修复 sqlite3 模块初始化中可能的内存泄漏问题。

bpo-39101 [https://bugs.python.org/issue?@action=redirect&bpo=39101]: 修复了使用 IsolatedAsyncioTestCase 的测试在遇到 BaseExceptions 时挂起的问题。

bpo-41976 [https://bugs.python.org/issue?@action=redirect&bpo=41976]: 修复了一个导致 ctypes.util.find_library() 在尝试在 gcc>=9 可用但 ldconfig 不可用的环境中定位库时返回 None 的 bug。由 Pablo Galindo 提供补丁。

bpo-41943 [https://bugs.python.org/issue?@action=redirect&bpo=41943]: 修复了 TestCase.assertLogs 不能正确按级别过滤消息的 bug。

bpo-41923 [https://bugs.python.org/issue?@action=redirect&bpo=41923]: 实现了 PEP 613 [https://www.python.org/dev/peps/pep-0613]，引入了 typing.TypeAlias 注解。

bpo-41905 [https://bugs.python.org/issue?@action=redirect&bpo=41905]: 在 abc 中添加了一个新函数 update_abstractmethods 以重新计算抽象类的抽象状态。此外，dataclass 已被修改为调用此函数。

bpo-23706 [https://bugs.python.org/issue?@action=redirect&bpo=23706]: 为 pathlib.Path.write_text() 添加了 newline 参数。

bpo-41876 [https://bugs.python.org/issue?@action=redirect&bpo=41876]: Tkinter 字体类的 repr 使用字体名称。

bpo-41831 [https://bugs.python.org/issue?@action=redirect&bpo=41831]: tkinter.Event 对象的 type 属性的 str() 现在总是返回由 Tk 返回的数字代码，而不是事件类型的名称。

bpo-39337 [https://bugs.python.org/issue?@action=redirect&bpo=39337]: encodings.normalize_encoding() 现在忽略非 ASCII 字符。

bpo-41747 [https://bugs.python.org/issue?@action=redirect&bpo=41747]: 确保所有由 dataclasses.dataclass() 对象生成的方法现在都有正确的 __qualname__ 属性，引用它们所属的类。由 Batuhan Taskaya 提供补丁。

bpo-30681 [https://bugs.python.org/issue?@action=redirect&bpo=30681]: 在使用 email "default" 策略时处理由不可解析的日期头引起的异常。由 Tim Bell 和 Georges Toth 提供补丁。

bpo-41586 [https://bugs.python.org/issue?@action=redirect&bpo=41586]: 向 fcntl 模块添加 F_SETPIPE_SZ 和 F_GETPIPE_SZ。允许在 subprocess.Popen 上设置管道大小。

bpo-41229 [https://bugs.python.org/issue?@action=redirect&bpo=41229]: 添加 contextlib.aclosing 用于异步生成器的确定性清理，类似于 contextlib.closing 对于非异步生成器的作用。由 Joongi Kim 和 John Belmonte 提供补丁。

bpo-16396 [https://bugs.python.org/issue?@action=redirect&bpo=16396]: 允许在非 Windows 系统上导入 ctypes.wintypes。

bpo-4356 [https://bugs.python.org/issue?@action=redirect&bpo=4356]: 向 bisect 模块添加一个键函数。

bpo-40592 [https://bugs.python.org/issue?@action=redirect&bpo=40592]: shutil.which() 现在忽略 PATHEXT 中的空条目，而不是将它们视为匹配项。

bpo-40492 [https://bugs.python.org/issue?@action=redirect&bpo=40492]: 修复当被分析的程序更改工作目录时，cProfile / profile 的 --outfile 不在原始目录中写入输出文件的问题。PR由Anthony Sottile提供。

bpo-34204 [https://bugs.python.org/issue?@action=redirect&bpo=34204]: The shelve module now uses pickle.DEFAULT_PROTOCOL by default instead of pickle protocol 3.

bpo-27321 [https://bugs.python.org/issue?@action=redirect&bpo=27321]: 修复了将电子邮件扁平化为字符串时尝试替换不存在的Content-Transfer-Encoding头时引发的KeyError异常。

bpo-38976 [https://bugs.python.org/issue?@action=redirect&bpo=38976]: http.cookiejar 模块现在支持在所有平台上通过MozillaCookieJar解析CURL样式的cookiejar文件中的cookie。之前，加载包含此类条目的cookiejar时会静默忽略此类cookie条目。

此外，HTTP Only属性在对象中持续存在，并且如果随后转储MozillaCookieJar对象，将正确写入文件。

文档

bpo-42061 [https://bugs.python.org/issue?@action=redirect&bpo=42061]: 记录IP地址的__format__功能。

bpo-41910 [https://bugs.python.org/issue?@action=redirect&bpo=41910]: Document the default implementation of object.__eq__.

bpo-42010 [https://bugs.python.org/issue?@action=redirect&bpo=42010]: 澄清订阅表达式对于标准库中的某些 类 也有效，并且如果提供了类方法 __class_getitem__()，则对于用户定义的类和类型也有效。

bpo-41805 [https://bugs.python.org/issue?@action=redirect&bpo=41805]: 记录了 generic alias type 和 types.GenericAlias。还在词汇表中添加了 泛型类型 的条目。

bpo-39693 [https://bugs.python.org/issue?@action=redirect&bpo=39693]: 修复tarfile的extractfile文档

bpo-39416 [https://bugs.python.org/issue?@action=redirect&bpo=39416]: 记录一些关于数字类默认字符串表示的限制。

测试

bpo-41739 [https://bugs.python.org/issue?@action=redirect&bpo=41739]: 修复test_logging.test_race_between_set_target_and_flush()：测试现在等待所有线程完成，以避免运行线程泄漏。

bpo-41970 [https://bugs.python.org/issue?@action=redirect&bpo=41970]: 如果模块在测试执行时已经导入，避免在 test_lib2to3 中出现测试失败。由Pablo Galindo提供补丁。

bpo-41944 [https://bugs.python.org/issue?@action=redirect&bpo=41944]: CJK编解码器的测试不再对通过HTTP接收的内容调用 eval()。

bpo-41306 [https://bugs.python.org/issue?@action=redirect&bpo=41306]: 修复了在执行使用Tk 8.6.10的测试时 test_tk.test_widgets.ScaleTest 中出现的失败。

构建

bpo-38980 [https://bugs.python.org/issue?@action=redirect&bpo=38980]: 在使用 --enable-optimizations 构建时，将 ``-fno-semantic-interposition``添加到编译和链接行。由Victor Stinner和Pablo Galindo提供补丁。

Windows

bpo-38439 [https://bugs.python.org/issue?@action=redirect&bpo=38439]: 更新了Windows商店包中IDLE的图标。

bpo-38252 [https://bugs.python.org/issue?@action=redirect&bpo=38252]: 在64位Windows构建中使用8字节步长来检测ASCII序列。

bpo-39107 [https://bugs.python.org/issue?@action=redirect&bpo=39107]: 在Windows安装程序中更新Tcl和Tk至8.6.10版本。

bpo-41557 [https://bugs.python.org/issue?@action=redirect&bpo=41557]: 更新Windows安装程序以使用SQLite 3.33.0。

bpo-38324 [https://bugs.python.org/issue?@action=redirect&bpo=38324]: 在Windows上访问某些区域设置数据时避免Unicode错误。

macOS

bpo-41471 [https://bugs.python.org/issue?@action=redirect&bpo=41471]: 忽略系统代理排除中的无效前缀长度。

IDLE

bpo-33987 [https://bugs.python.org/issue?@action=redirect&bpo=33987]: 主要完成了对编辑器、设置和搜索使用ttk小部件的工作。部分由Mark Roseman提供补丁。

bpo-40511 [https://bugs.python.org/issue?@action=redirect&bpo=40511]: 在函数调用的括号内键入开闭括号将不再导致现有的调用提示不必要地“闪烁”开关，例如在字符串字面量中键入时。

bpo-38439 [https://bugs.python.org/issue?@action=redirect&bpo=38439]: 向Windows .ico文件添加一个256×256像素的IDLE图标。由Andrew Clover创建。从.ico文件中移除低色彩gif变体。

C API

bpo-42157 [https://bugs.python.org/issue?@action=redirect&bpo=42157]: PyCapsule API unicodedata.ucnhash_CAPI 的私有 _PyUnicode_Name_CAPI 结构已移至内部C API。由Victor Stinner提供补丁。

bpo-42015 [https://bugs.python.org/issue?@action=redirect&bpo=42015]: Fix potential crash in deallocating method objects when dynamically allocated PyMethodDef's lifetime is managed through the self argument of a PyCFunction.

bpo-40423 [https://bugs.python.org/issue?@action=redirect&bpo=40423]: subprocess 模块和 os.closerange 现在将在可用时使用``close_range(low, high, flags)``系统调用来更高效地关闭描述符范围。

bpo-41845 [https://bugs.python.org/issue?@action=redirect&bpo=41845]: PyObject_GenericGetDict() 在针对3.10或更高版本时再次在有限API中可用。

bpo-40422 [https://bugs.python.org/issue?@action=redirect&bpo=40422]: Add _Py_closerange function to provide performant closing of a range of file descriptors.

bpo-41986 [https://bugs.python.org/issue?@action=redirect&bpo=41986]: Py_FileSystemDefaultEncodeErrors and Py_UTF8Mode are available again in limited API.

bpo-41756 [https://bugs.python.org/issue?@action=redirect&bpo=41756]: Add PyIter_Send function to allow sending value into generator/coroutine/iterator without raising StopIteration exception to signal return.

bpo-41784 [https://bugs.python.org/issue?@action=redirect&bpo=41784]: 将 PyUnicode_AsUTF8AndSize 添加到有限的 C API 中。

Python 3.10.0 alpha 1

发布日期: 2020-10-05

安全性

bpo-41304 [https://bugs.python.org/issue?@action=redirect&bpo=41304]: Fixes python3x._pth being ignored on Windows, caused by the fix for bpo-29778 [https://bugs.python.org/issue?@action=redirect&bpo=29778] (CVE-2020-15801).

bpo-41162 [https://bugs.python.org/issue?@action=redirect&bpo=41162]: 审计钩子现在在最终化过程的后期被清除，以避免错过事件。

bpo-29778 [https://bugs.python.org/issue?@action=redirect&bpo=29778]: Ensure python3.dll is loaded from correct locations when Python is embedded (CVE-2020-15523).

bpo-41004 [https://bugs.python.org/issue?@action=redirect&bpo=41004]: ipaddress.IPv4Interface 和 ipaddress.IPv6Interface 的 __hash__() 方法错误地生成了分别为 32 和 128 的常量哈希值。这导致了总是发生哈希冲突。修复使用 hash() 来为 (地址, 掩码长度, 网络地址) 的元组生成哈希值。

bpo-39603 [https://bugs.python.org/issue?@action=redirect&bpo=39603]: 通过拒绝 http.client.putrequest(...) 中的控制字符来防止 http 头注入。

核心与内置函数

bpo-41909 [https://bugs.python.org/issue?@action=redirect&bpo=41909]: 修复了在 issubclass() 和 isinstance() 中当获取 __bases__ 属性导致无限递归时的堆栈溢出问题。

bpo-41922 [https://bugs.python.org/issue?@action=redirect&bpo=41922]: Speed up calls to reversed() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-41873 [https://bugs.python.org/issue?@action=redirect&bpo=41873]: 由于 vectorcall 调用约定，对 float() 的调用现在更快。由 Dennis Sweeney 提供补丁。

bpo-41870 [https://bugs.python.org/issue?@action=redirect&bpo=41870]: Speed up calls to bool() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _bisect module to the multi-phase initialization API (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-39934 [https://bugs.python.org/issue?@action=redirect&bpo=39934]: 在编译器中正确计算 'except' 中的控制块。确保对于深层嵌套的命名异常处理程序产生语法错误而非致命错误。

bpo-41780 [https://bugs.python.org/issue?@action=redirect&bpo=41780]: 修复 types.GenericAlias 的 __dir__() 方法。由 Batuhan Taskaya 提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _lsprof extension module to multi-phase initialization (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 cmath 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _scproxy extension module to multi-phase initialization (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 termios 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Convert the _sha256 extension module types to heap types.

bpo-41690 [https://bugs.python.org/issue?@action=redirect&bpo=41690]: 修复解析器在解析具有大量参数的函数和类时可能出现的栈溢出问题。由 Pablo Galindo 提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _overlapped extension module to multi-phase initialization (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _curses_panel extension module to multi-phase initialization (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _opcode extension module to multi-phase initialization (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-41681 [https://bugs.python.org/issue?@action=redirect&bpo=41681]: Fixes the wrong error description in the error raised by using 2 , in format string in f-string and str.format().

bpo-41675 [https://bugs.python.org/issue?@action=redirect&bpo=41675]: The implementation of signal.siginterrupt() now uses sigaction() (if it is available in the system) instead of the deprecated siginterrupt(). Patch by Pablo Galindo.

bpo-41670 [https://bugs.python.org/issue?@action=redirect&bpo=41670]: 防止在未编译 USE_COMPUTED_GOTOS 的平台上跳过行跟踪。修复了 Windows 上 try-except 块内某些行未被跟踪的问题。

bpo-41654 [https://bugs.python.org/issue?@action=redirect&bpo=41654]: 修复销毁 MemoryError 子类时发生的崩溃问题。由 Pablo Galindo 提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 zlib 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-41631 [https://bugs.python.org/issue?@action=redirect&bpo=41631]: _ast 模块再次使用了全局状态。每个模块实例使用模块状态会导致一些微妙的实际问题。例如，Mercurial 项目替换了 __import__() 函数以实现延迟导入，而 Python 期望 import _ast 总是返回一个完全初始化的 _ast 模块。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: Convert _operator to use PyType_FromSpec().

bpo-1653741 [https://bugs.python.org/issue?@action=redirect&bpo=1653741]: Port _sha3 to multi-phase init. Convert static types to heap types.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _blake2 extension module to the multi-phase initialization API (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-41533 [https://bugs.python.org/issue?@action=redirect&bpo=41533]: 如果 do_mkstack 失败且堆栈不是 small_stack，则释放 va_build_stack 中分配的堆栈。

bpo-41531 [https://bugs.python.org/issue?@action=redirect&bpo=41531]: 修复了一个在编译包含超过 0xFFFF 个元素的字典字面量时会丢失键的错误。由 Pablo Galindo 提供补丁。

bpo-41525 [https://bugs.python.org/issue?@action=redirect&bpo=41525]: python --help 的输出现在仅包含 ASCII 字符。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port the _sha1, _sha512, and _md5 extension modules to multi-phase initialization API (PEP 489 [https://www.python.org/dev/peps/pep-0489]).

bpo-41431 [https://bugs.python.org/issue?@action=redirect&bpo=41431]: 为复制字典（例如 dict(d) 和 {}.update(d)）优化 dict_merge()。

bpo-41428 [https://bugs.python.org/issue?@action=redirect&bpo=41428]: 实现 PEP 604。这支持使用 (int | str) 等替代 Union[str, int]。

bpo-41340 [https://bugs.python.org/issue?@action=redirect&bpo=41340]: 移除了 strdup 的回退实现。

bpo-38156 [https://bugs.python.org/issue?@action=redirect&bpo=38156]: 正确处理在 PyOS_StdioReadline 中 EOF 之后到来的中断。

bpo-41342 [https://bugs.python.org/issue?@action=redirect&bpo=41342]: 现在使用整数参数的 round() 更快（9--60%）。

bpo-41334 [https://bugs.python.org/issue?@action=redirect&bpo=41334]: 构造函数 str()、bytes() 和 bytearray() 现在更快（对于小对象大约快 30--40%）。

bpo-41295 [https://bugs.python.org/issue?@action=redirect&bpo=41295]: 解决了 CPython 3.8.4 中的一个回归问题，即在多重继承设置中定义 "__setattr__" 并调用层次链时，如果基类型涉及内置/扩展类型，可能会失败。

bpo-41323 [https://bugs.python.org/issue?@action=redirect&bpo=41323]: 字节码优化直接在控制流图上执行。这将在某些情况下使代码对象稍微更紧凑。

bpo-41247 [https://bugs.python.org/issue?@action=redirect&bpo=41247]: 运行 asyncio.set_running_loop 时，始终缓存运行循环持有者。

bpo-41252 [https://bugs.python.org/issue?@action=redirect&bpo=41252]: 修复 _ssl.c 中 _servername_callback() 的错误引用计数。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 multiprocessing 移植到多阶段初始化。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 winapi 移植到多阶段初始化。

bpo-41215 [https://bugs.python.org/issue?@action=redirect&bpo=41215]: 在 PEG 解析器的关键字列表中使用非 NULL 默认值，以克服在使用 XLC 编译器时阻止 Python 正确编译的错误。由 Pablo Galindo 提供补丁。

bpo-41218 [https://bugs.python.org/issue?@action=redirect&bpo=41218]: Python 3.8.3 有一个回归问题，即使用 ast.PyCF_ALLOW_TOP_LEVEL_AWAIT 编译时，会激进地将列表推导标记为 CO_COROUTINE。现在只有使用 async/await 的列表推导才会被这样标记。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 faulthandler 移植到多阶段初始化。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 sha256 移植到多阶段初始化。

bpo-41175 [https://bugs.python.org/issue?@action=redirect&bpo=41175]: 防止 bytearray() + bytearray() 操作触发的 bytearrayobject 内的 NULL 指针解引用。

bpo-41100 [https://bugs.python.org/issue?@action=redirect&bpo=41100]: 在 mpdecimal.h 中将 arm64 添加到允许的 Mac OS 架构中。

bpo-41094 [https://bugs.python.org/issue?@action=redirect&bpo=41094]: 修复在非 UTF-8 语言环境下打开非 ASCII 名称文件时的解码错误。

bpo-39960 [https://bugs.python.org/issue?@action=redirect&bpo=39960]: 防止通过调用超类方法绕过类型的 __setattr__() 的“hackcheck”被重写，以允许 C 实现的堆类型。

bpo-41084 [https://bugs.python.org/issue?@action=redirect&bpo=41084]: 在解析抛出 SyntaxError 的 f-string 表达式时，在错误消息前加上 'f-string: '。

bpo-40521 [https://bugs.python.org/issue?@action=redirect&bpo=40521]: 空的 frozensets 不再是单例。

bpo-41076 [https://bugs.python.org/issue?@action=redirect&bpo=41076]: 预填充解析器时提供 f-string 表达式的位置，而不是 f-string 本身，这允许我们在解析完成后跳过 AST 节点位置的移动。

bpo-41056 [https://bugs.python.org/issue?@action=redirect&bpo=41056]: 修复了在启动时通过 -c 提供代码时，涉及相对符号链接构造 sys.path 过程中引用已释放堆栈空间的问题。（通过 Coverity 发现）

bpo-41061 [https://bugs.python.org/issue?@action=redirect&bpo=41061]: 修复了哈希表代码和测试中的错误表达式和断言。

bpo-41052 [https://bugs.python.org/issue?@action=redirect&bpo=41052]: 为 _random.Random 选择退出序列化/反序列化。

bpo-40939 [https://bugs.python.org/issue?@action=redirect&bpo=40939]: Rename PyPegen* functions to PyParser*, so that we can remove the old set of PyParser* functions that were using the old parser, but keep everything backwards-compatible.

bpo-35975 [https://bugs.python.org/issue?@action=redirect&bpo=35975]: Stefan Behnel 报告称，即使 PyCF_ONLY_AST 未设置，也会使用 cf_feature_version。这与意图和文档行为相违背，因此已修复。

bpo-40939 [https://bugs.python.org/issue?@action=redirect&bpo=40939]: 移除旧解析器和 symbol 模块的剩余文件。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: Convert _bz2 to use PyType_FromSpec().

bpo-41006 [https://bugs.python.org/issue?@action=redirect&bpo=41006]: encodings.latin_1 模块不再在启动时导入。现在仅当它是文件系统编码或 stdio 编码时才导入。

bpo-40636 [https://bugs.python.org/issue?@action=redirect&bpo=40636]: zip() 现在支持 PEP 618 [https://www.python.org/dev/peps/pep-0618] 的 strict 参数，如果参数长度不同，则会引发 ValueError。由 Brandt Bucher 提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port _gdbm to multiphase initialization.

bpo-40985 [https://bugs.python.org/issue?@action=redirect&bpo=40985]: 修复了一个导致文件以行继续字符（即反斜杠）结尾时，SyntaxError 文本为空的错误。错误文本应包含最后一行的文本。

bpo-40958 [https://bugs.python.org/issue?@action=redirect&bpo=40958]: 修复了 PEG 解析器在收集信息以发出语法错误时可能存在的缓冲区溢出。由 Pablo Galindo 提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port _dbm to multiphase initialization.

bpo-40957 [https://bugs.python.org/issue?@action=redirect&bpo=40957]: 修复 _Py_fopen_obj() 在 PySys_Audit() 失败时的反射泄漏

bpo-40950 [https://bugs.python.org/issue?@action=redirect&bpo=40950]: Add a state to the nis module (PEP 3121 [https://www.python.org/dev/peps/pep-3121]) and apply the multiphase initialization. Patch by Dong-hee Na.

bpo-40947 [https://bugs.python.org/issue?@action=redirect&bpo=40947]: Python 的 Path Configuration 现在考虑了 PyConfig.platlibdir。

bpo-40939 [https://bugs.python.org/issue?@action=redirect&bpo=40939]: 移除了旧解析器、parser 模块以及所有相关的支持代码、命令行选项和环境变量。由 Pablo Galindo 提供补丁。

bpo-40847 [https://bugs.python.org/issue?@action=redirect&bpo=40847]: Fix a bug where a line with only a line continuation character is not considered a blank line at tokenizer level. In such cases, more than a single NEWLINE token was emitted. The old parser was working around the issue, but the new parser threw a SyntaxError for valid input due to this. For example, an empty line following a line continuation character was interpreted as a SyntaxError.

bpo-40890 [https://bugs.python.org/issue?@action=redirect&bpo=40890]: 现在每个字典视图都有一个 mapping 属性，该属性提供了一个包装原始字典的 types.MappingProxyType。补丁由 Dennis Sweeney 贡献。

bpo-40889 [https://bugs.python.org/issue?@action=redirect&bpo=40889]: 改进了字典项视图上对称差异操作的性能。由 Dennis Sweeney 提供补丁。

bpo-40904 [https://bugs.python.org/issue?@action=redirect&bpo=40904]: 修复了在解析包含无值 yield 语句的 f-string（如 f"{yield}"）时，新的 PEG 解析器可能出现的段错误。由 Pablo Galindo 提供补丁。

bpo-40903 [https://bugs.python.org/issue?@action=redirect&bpo=40903]: 修复了新的 PEG 解析器在为形式如 p=p= 的无效赋值生成错误消息时可能出现的段错误。由 Pablo Galindo 提供补丁。

bpo-40880 [https://bugs.python.org/issue?@action=redirect&bpo=40880]: 修复了在检查字符串字面量中的换行符时，新解析器中的无效内存读取问题。补丁由 Pablo Galindo 提供。

bpo-40883 [https://bugs.python.org/issue?@action=redirect&bpo=40883]: 修复了在新解析器中解析 f-strings 时的内存泄漏问题。补丁由 Pablo Galindo 提供。

bpo-40870 [https://bugs.python.org/issue?@action=redirect&bpo=40870]: 在验证自定义 AST 时，如果常量 True、False 和 None 在 ast.Name 节点中使用，则抛出 ValueError。

bpo-40854 [https://bugs.python.org/issue?@action=redirect&bpo=40854]: 允许通过新的环境变量 PYTHONPLATLIBDIR 覆盖 sys.platlibdir。

bpo-40826 [https://bugs.python.org/issue?@action=redirect&bpo=40826]: 修复 PyOS_Readline() 中的GIL使用：锁定GIL以设置异常，并在检查是否有待处理信号时传递Python线程状态。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 fcntl 移植到多阶段初始化。

bpo-19468 [https://bugs.python.org/issue?@action=redirect&bpo=19468]: 删除 importlib.reload() 中不必要的实例检查。由Furkan Önder提供补丁。

bpo-40824 [https://bugs.python.org/issue?@action=redirect&bpo=40824]: 在 in 操作符和 operator 模块的函数 contains()、indexOf() 和 countOf() 中，调用 __iter__ 方法时不再因 TypeError 而掩盖意外错误。

bpo-40792 [https://bugs.python.org/issue?@action=redirect&bpo=40792]: range 对象的属性 start、stop 和 step 现在总是具有确切的 int 类型。之前，它们可能是 int 子类的实例。

bpo-40780 [https://bugs.python.org/issue?@action=redirect&bpo=40780]: 修复了浮点数g风格字符串格式化未能移除尾部零的一个边缘情况。

bpo-38964 [https://bugs.python.org/issue?@action=redirect&bpo=38964]: 当fstring的表达式部分出现 SyntaxError 时，SyntaxError 的filename属性现在被正确设置为fstring所在文件的名称。

bpo-40750 [https://bugs.python.org/issue?@action=redirect&bpo=40750]: 在新的PEG解析器中支持 "-d" 调试标志。由Pablo Galindo提供补丁

bpo-40217 [https://bugs.python.org/issue?@action=redirect&bpo=40217]: 使用 PyType_FromSpecWithBases() 创建的类型实例在垃圾收集器中遍历引用时将不再自动访问其类对象。用户需要手动访问对象的类。由Pablo Galindo提供补丁。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: Py_TYPE() is changed to the inline static function. Patch by Dong-hee Na.

bpo-40696 [https://bugs.python.org/issue?@action=redirect&bpo=40696]: 修复了由于异常上下文链中的循环而在 generator.throw() 后可能出现的挂起问题。

bpo-40521 [https://bugs.python.org/issue?@action=redirect&bpo=40521]: 每个解释器现在都有自己的空闲列表、单例和缓存：

空闲列表：float、tuple、list、dict、frame、context、异步生成器、MemoryError。

单例：空元组、空字节字符串、空Unicode字符串、单字节字符、单个Unicode（latin1）字符。

切片缓存。

它们不再被所有解释器共享。

bpo-40679 [https://bugs.python.org/issue?@action=redirect&bpo=40679]: 某些关于缺少或多余参数的 TypeError 消息现在包括函数的 qualified name。由 Dennis Sweeney 提供补丁。

bpo-29590 [https://bugs.python.org/issue?@action=redirect&bpo=29590]: 在生成器上调用 generator.throw() 后，使堆栈跟踪正确，该生成器已经从 yield from 中产出。

bpo-4022 [https://bugs.python.org/issue?@action=redirect&bpo=4022]: 通过不引发内部 StopIteration 来提高生成器的性能。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 mmap 移植到多阶段初始化。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: Port _lzma to multiphase initialization.

bpo-37999 [https://bugs.python.org/issue?@action=redirect&bpo=37999]: 接受整数参数的内置和扩展函数不再接受 Decimals、Fractions 和其他只能以损失方式转换为整数的对象（例如，具有 __int__() 方法但不具有 __index__() 方法的对象）。

bpo-29882 [https://bugs.python.org/issue?@action=redirect&bpo=29882]: Add int.bit_count(), counting the number of ones in the binary representation of an integer. Patch by Niklas Fiekas.

bpo-36982 [https://bugs.python.org/issue?@action=redirect&bpo=36982]: 当可用时使用 ncurses 扩展颜色功能以支持具有256色的终端，并添加新函数 curses.has_extended_color_support() 以指示底层 ncurses 库是否提供扩展颜色支持。

bpo-19569 [https://bugs.python.org/issue?@action=redirect&bpo=19569]: 添加私有宏 _Py_COMP_DIAG_PUSH、_Py_COMP_DIAG_IGNORE_DEPR_DECLS 和 _Py_COMP_DIAG_POP。

bpo-26680 [https://bugs.python.org/issue?@action=redirect&bpo=26680]: int 类型现在支持 x.is_integer() 方法以与 float 兼容。

库

bpo-41900 [https://bugs.python.org/issue?@action=redirect&bpo=41900]: 在 xml.etree.ElementTree 中的 C14N 2.0 序列化在定义了默认命名空间时，对于未加前缀的属性失败。

bpo-41887 [https://bugs.python.org/issue?@action=redirect&bpo=41887]: 在 ast.literal_eval() 上移除前导空格和制表符。同时记录 eval() 对空格和制表符的移除。

bpo-41773 [https://bugs.python.org/issue?@action=redirect&bpo=41773]: 在文档中注明 random.choices() 不支持非有限权重，当给定非有限权重时引发 ValueError。

bpo-41840 [https://bugs.python.org/issue?@action=redirect&bpo=41840]: 修复 symtable 模块中的一个 bug，该 bug 导致模块作用域的全局变量未被同时报告为局部和全局。由 Pablo Galindo 提供补丁。

bpo-41842 [https://bugs.python.org/issue?@action=redirect&bpo=41842]: 添加 codecs.unregister() 函数以注销编解码器搜索函数。

bpo-40564 [https://bugs.python.org/issue?@action=redirect&bpo=40564]: 在 zipfile.Path 中，改变传递的 ZipFile 对象类型而不是制作副本。防止本地副本和调用者的副本尝试关闭同一个文件句柄时出现问题。

bpo-40670 [https://bugs.python.org/issue?@action=redirect&bpo=40670]: 对 timeit.Timer 中的语句进行更可靠的验证。现在接受“空”语句（仅空白和注释）并拒绝缩进错误的语句。

bpo-41833 [https://bugs.python.org/issue?@action=redirect&bpo=41833]: threading.Thread 构造函数现在在指定 target 参数但省略 name 参数时使用目标名称。

bpo-41817 [https://bugs.python.org/issue?@action=redirect&bpo=41817]: fix tkinter.EventType Enum so all members are strings, and none are tuples

bpo-41810 [https://bugs.python.org/issue?@action=redirect&bpo=41810]: 重新引入了 types.EllipsisType、types.NotImplementedType 和 types.NoneType，提供了一组新的类型，静态类型检查器可以轻松解释。

bpo-41815 [https://bugs.python.org/issue?@action=redirect&bpo=41815]: 修复 SQLite3 在备份已关闭数据库时的段错误。补丁由 Peter David McCormick 提供。

bpo-41816 [https://bugs.python.org/issue?@action=redirect&bpo=41816]: 添加了 StrEnum：确保所有成员已经是字符串或字符串候选。

bpo-41517 [https://bugs.python.org/issue?@action=redirect&bpo=41517]: 修复允许通过多重继承扩展枚举的 bug。

bpo-39587 [https://bugs.python.org/issue?@action=redirect&bpo=39587]: 在构造枚举时使用正确的混合数据类型。

bpo-41792 [https://bugs.python.org/issue?@action=redirect&bpo=41792]: 在 typing.py 中添加 is_typeddict 函数以检查类型是否为 TypedDict 类。

Previously there was no way to check that without using private API. See the relevant issue in python/typing

bpo-41789 [https://bugs.python.org/issue?@action=redirect&bpo=41789]: Honor object overrides in Enum class creation (specifically, __str__, __repr__, __format__, and __reduce_ex__).

bpo-32218 [https://bugs.python.org/issue?@action=redirect&bpo=32218]: enum.Flag and enum.IntFlag members are now iterable

bpo-39651 [https://bugs.python.org/issue?@action=redirect&bpo=39651]: 修复了 asyncio.ProactorEventLoop 的 call_soon_threadsafe() 方法中的一个竞态条件：如果自管道套接字已关闭，则不执行任何操作。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 mashal 扩展模块移植到多阶段初始化API (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _string 扩展模块移植到多阶段初始化API (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-41732 [https://bugs.python.org/issue?@action=redirect&bpo=41732]: 为 memoryview 添加了一个迭代器`。

bpo-41720 [https://bugs.python.org/issue?@action=redirect&bpo=41720]: 修复了:turtle.Vec2D.__rmul__`对于非int或float参数的处理。

bpo-41696 [https://bugs.python.org/issue?@action=redirect&bpo=41696]: 修复了在 asyncio.run() 中调试模式的处理。现在可以通过设置``PYTHONASYNCIODEBUG``或 -X dev 来在使用 asyncio.run() 时启用asyncio调试模式。

bpo-41687 [https://bugs.python.org/issue?@action=redirect&bpo=41687]: 修复了sendfile的实现以兼容Solaris。

bpo-41662 [https://bugs.python.org/issue?@action=redirect&bpo=41662]: 不再覆盖在 sqlite3 中参数序列的 __len__() 中引发的异常，而是使用 ProgrammingError。

bpo-39010 [https://bugs.python.org/issue?@action=redirect&bpo=39010]: 在Windows上重启 ProactorEventLoop 不再记录虚假的``ConnectionResetErrors``。

bpo-41638 [https://bugs.python.org/issue?@action=redirect&bpo=41638]: 当参数以字典形式提供时，sqlite3 中对于缺少参数的 ProgrammingError 消息现在包含参数名称而不是其索引。

bpo-41662 [https://bugs.python.org/issue?@action=redirect&bpo=41662]: 修复了在 sqlite3 中迭代期间突变参数列表时崩溃的问题。

bpo-41513 [https://bugs.python.org/issue?@action=redirect&bpo=41513]: 提高了math.hypot()的准确性。内部每一步计算都使用额外的精度，因此结果现在几乎总是正确舍入。

bpo-41609 [https://bugs.python.org/issue?@action=redirect&bpo=41609]: pdb的whatis命令现在正确地将实例方法报告为'Method'而不是'Function'。

bpo-39994 [https://bugs.python.org/issue?@action=redirect&bpo=39994]: 修复了pprint对于重写__repr__的dict子类的处理。

bpo-32751 [https://bugs.python.org/issue?@action=redirect&bpo=32751]: 当由于超时取消任务时，asyncio.wait_for() 现在也会在*timeout* <= 0的情况下等待取消完成，就像对正超时那样。

bpo-37658 [https://bugs.python.org/issue?@action=redirect&bpo=37658]: asyncio.wait_for() 现在正确处理了自身取消与包装的可等待对象完成之间的竞争条件。

bpo-40782 [https://bugs.python.org/issue?@action=redirect&bpo=40782]: 将方法 asyncio.AbstractEventLoop.run_in_executor 改为不是协程。

bpo-41520 [https://bugs.python.org/issue?@action=redirect&bpo=41520]: 修复 codeop 回归问题，该问题阻止了将编译警告转为错误。

bpo-41528 [https://bugs.python.org/issue?@action=redirect&bpo=41528]: turtle 使用数学模块函数来转换度与弧度，以及计算向量范数。

bpo-41513 [https://bugs.python.org/issue?@action=redirect&bpo=41513]: 对 math.hypot() 和 math.dist() 进行了小的算法改进，略微提高了速度和准确性。

bpo-41503 [https://bugs.python.org/issue?@action=redirect&bpo=41503]: 修复了 logging.handlers.MemoryHandler 中 setTarget 和 flush 之间的竞争条件。

bpo-41497 [https://bugs.python.org/issue?@action=redirect&bpo=41497]: 修复 dis 模块中潜在的 UnicodeDecodeError。

bpo-41467 [https://bugs.python.org/issue?@action=redirect&bpo=41467]: 在 Windows 上，修复 asyncio recv_into() 当套接字/管道关闭时的返回值 (BrokenPipeError): 返回 0 而不是空字节串 (b'')。

bpo-41425 [https://bugs.python.org/issue?@action=redirect&bpo=41425]: 使 tkinter 文档示例可运行。

bpo-41421 [https://bugs.python.org/issue?@action=redirect&bpo=41421]: 对 random.paretovariate() 进行了代数简化。现在它略微减少了舍入误差，速度也略有提升。之前导致 ZeroDivisionError 的输入现在会导致 OverflowError。

bpo-41440 [https://bugs.python.org/issue?@action=redirect&bpo=41440]: Add os.cpu_count() support for VxWorks RTOS.

bpo-41316 [https://bugs.python.org/issue?@action=redirect&bpo=41316]: 修复 tarfile 模块，使其仅将 TAR 文件的基本名写入 GZIP 压缩头。

bpo-41384 [https://bugs.python.org/issue?@action=redirect&bpo=41384]: 当向 tkinter.OptionMenu 传递未知选项时，抛出 TclError 而不是 TypeError。

bpo-41317 [https://bugs.python.org/issue?@action=redirect&bpo=41317]: 在 asyncio.loop.sock_accept() 中使用 add_done_callback() 以在取消时尽早取消订阅读取器。

bpo-41364 [https://bugs.python.org/issue?@action=redirect&bpo=41364]: 减少 uuid 的导入开销。

bpo-35328 [https://bugs.python.org/issue?@action=redirect&bpo=35328]: 在 venv 激活时设置环境变量 VIRTUAL_ENV_PROMPT。

bpo-41341 [https://bugs.python.org/issue?@action=redirect&bpo=41341]: Recursive evaluation of typing.ForwardRef in get_type_hints.

bpo-41344 [https://bugs.python.org/issue?@action=redirect&bpo=41344]: 防止创建 size=0 的 shared_memory.SharedMemory 对象。

bpo-41333 [https://bugs.python.org/issue?@action=redirect&bpo=41333]: collections.OrderedDict.pop() 现在速度提高了 2 倍。

bpo-41288 [https://bugs.python.org/issue?@action=redirect&bpo=41288]: 使用C实现时，反序列化无效的NEWOBJ_EX操作码现在会引发UnpicklingError，而不是崩溃。

bpo-39017 [https://bugs.python.org/issue?@action=redirect&bpo=39017]: Avoid infinite loop when reading specially crafted TAR files using the tarfile module (CVE-2019-20907).

bpo-41273 [https://bugs.python.org/issue?@action=redirect&bpo=41273]: 通过调用 recv_into 而非 recv，加快使用 _ProactorReadPipeTransport``的任何传输速度，从而不在传输的读取循环中为每次 ``recv 调用创建新缓冲区。

bpo-41235 [https://bugs.python.org/issue?@action=redirect&bpo=41235]: 修复了 ssl.SSLContext.load_dh_params() 中的错误处理。

bpo-41207 [https://bugs.python.org/issue?@action=redirect&bpo=41207]: 在distutils.spawn中，恢复了当命令未找到时引发DistutilsExecError的预期行为。

bpo-29727 [https://bugs.python.org/issue?@action=redirect&bpo=29727]: 将 array.array 注册为 MutableSequence。由Pablo Galindo提供补丁。

bpo-39168 [https://bugs.python.org/issue?@action=redirect&bpo=39168]: 移除了 typing.Generic 的 __new__ 方法。

bpo-41194 [https://bugs.python.org/issue?@action=redirect&bpo=41194]: 修复了 _ast 模块中的崩溃问题：它现在不能被多次加载。它现在使用全局状态而非模块状态。

bpo-41195 [https://bugs.python.org/issue?@action=redirect&bpo=41195]: 添加了只读的ssl.SSLContext.security_level属性，用于检索上下文的安全级别。

bpo-41193 [https://bugs.python.org/issue?@action=redirect&bpo=41193]: readline completer的 write_history() atexit函数现在忽略任何 OSError，以在文件系统为只读时忽略错误，而不仅仅是忽略 FileNotFoundError 和 PermissionError。

bpo-41182 [https://bugs.python.org/issue?@action=redirect&bpo=41182]: selector: 根据实现使用DefaultSelector

bpo-41161 [https://bugs.python.org/issue?@action=redirect&bpo=41161]: decimal模块现在需要libmpdec-2.5.0。使用--with-system-libmpdec的用户应更新其系统库。

bpo-40874 [https://bugs.python.org/issue?@action=redirect&bpo=40874]: decimal模块现在需要libmpdec-2.5.0。

bpo-41138 [https://bugs.python.org/issue?@action=redirect&bpo=41138]: 修复了 trace 模块CLI对于非UTF-8编码的Python源文件的问题。

bpo-31082 [https://bugs.python.org/issue?@action=redirect&bpo=31082]: 在 functools.reduce() 的文档字符串中使用术语“可迭代对象”。

bpo-40521 [https://bugs.python.org/issue?@action=redirect&bpo=40521]: 从collections.deque()中移除freelist。

bpo-31938 [https://bugs.python.org/issue?@action=redirect&bpo=31938]: 修复了 select 模块中几个函数的默认值签名 - 由Anthony Sottile提供。

bpo-41068 [https://bugs.python.org/issue?@action=redirect&bpo=41068]: 修复了直接从ZIP存档中读取非ASCII名称文件后立即写入的问题。

bpo-41058 [https://bugs.python.org/issue?@action=redirect&bpo=41058]: pdb.find_function() 现在能正确确定源文件的编码。

bpo-41056 [https://bugs.python.org/issue?@action=redirect&bpo=41056]: 现在阻止将无效的文件描述符值传递给os.fpathconf。(由Coverity发现)

bpo-41056 [https://bugs.python.org/issue?@action=redirect&bpo=41056]: 修复了ssl模块中在keylog回调中发生MemoryError时的NULL指针解引用问题。(由Coverity发现)

bpo-41056 [https://bugs.python.org/issue?@action=redirect&bpo=41056]: 修复了zoneinfo模块中MemoryError可能未被报告或未在其源头报告的情况。(由Coverity发现)

bpo-41048 [https://bugs.python.org/issue?@action=redirect&bpo=41048]: mimetypes.read_mime_types() 函数现在使用UTF-8编码而非本地编码读取规则文件。由Srinivas Reddy Thatiparthy提供补丁。

bpo-41043 [https://bugs.python.org/issue?@action=redirect&bpo=41043]: 修复了stdlib中 glob() 的使用：路径的字面部分现在总是被正确转义。

bpo-41025 [https://bugs.python.org/issue?@action=redirect&bpo=41025]: 修复了阻止 zoneinfo.ZoneInfo 的C实现被子类化的问题。

bpo-35018 [https://bugs.python.org/issue?@action=redirect&bpo=35018]: 添加了其他SAX XML实现中存在的 xml.sax.handler.LexicalHandler 类。

bpo-41002 [https://bugs.python.org/issue?@action=redirect&bpo=41002]: 提高了HTTPResponse.read在给定数量下的性能。由Bruce Merry提供补丁。

bpo-40448 [https://bugs.python.org/issue?@action=redirect&bpo=40448]: ensurepip now disables the use of pip cache when installing the bundled versions of pip and setuptools. Patch by Krzysztof Konopko.

bpo-40967 [https://bugs.python.org/issue?@action=redirect&bpo=40967]: Removed asyncio.Task.current_task() and asyncio.Task.all_tasks(). Patch contributed by Rémi Lapeyre.

bpo-40924 [https://bugs.python.org/issue?@action=redirect&bpo=40924]: 确保 importlib.resources.path 为SourceFileLoader的资源阅读器返回一个存在的路径。在制定长期解决方案的同时避免了在主分支中发现的回归。

bpo-40955 [https://bugs.python.org/issue?@action=redirect&bpo=40955]: 修复了 subprocess 模块中在指定extra_groups时的一个小内存泄漏。

bpo-40855 [https://bugs.python.org/issue?@action=redirect&bpo=40855]: statistics模块中的标准差和方差函数忽略了它们的mu和xbar参数。

bpo-40939 [https://bugs.python.org/issue?@action=redirect&bpo=40939]: 在生成标准库 keyword 模块时使用新的PEG解析器。

bpo-23427 [https://bugs.python.org/issue?@action=redirect&bpo=23427]: 添加 sys.orig_argv 属性：传递给Python可执行文件的原始命令行参数列表。

bpo-33689 [https://bugs.python.org/issue?@action=redirect&bpo=33689]: 忽略.pth文件中的空行或仅包含空白的行。这与文档中描述的行为相匹配。在此之前，空行会导致site-packages目录在sys.path中多次出现。由Ido Michael贡献，贡献者包括Malcolm Smith和Tal Einat。

bpo-40884 [https://bugs.python.org/issue?@action=redirect&bpo=40884]: Added a defaults parameter to logging.Formatter, to allow specifying default values for custom fields. Patch by Asaf Alon and Bar Harel.

bpo-40876 [https://bugs.python.org/issue?@action=redirect&bpo=40876]: 澄清 csv 模块中的错误消息。

bpo-39791 [https://bugs.python.org/issue?@action=redirect&bpo=39791]: 从importlib_metadata 1.6.1刷新importlib.metadata。

bpo-40807 [https://bugs.python.org/issue?@action=redirect&bpo=40807]: 停止codeop._maybe_compile（由code.InteractiveInterpreter（和IDLE）使用）每次发出三次警告。

bpo-32604 [https://bugs.python.org/issue?@action=redirect&bpo=32604]: 修复 select 模块在子解释器中导入时的引用泄漏问题。

bpo-39791 [https://bugs.python.org/issue?@action=redirect&bpo=39791]: 内置加载器（SourceFileLoader和ZipImporter）现在为 ResourceReader 提供 TraversableResources 实现，并且移除了回退函数。

bpo-39314 [https://bugs.python.org/issue?@action=redirect&bpo=39314]: rlcompleter.Completer 和标准Python shell现在为不带参数的函数闭合括号。由Rémi Lapeyre提供补丁。

bpo-17005 [https://bugs.python.org/issue?@action=redirect&bpo=17005]: 最初在 functools 模块中引入的拓扑排序功能已被移动到一个新的 graphlib 模块，以更好地适应新工具并保持 functools 模块的原始范围。由Pablo Galindo提供补丁

bpo-40834 [https://bugs.python.org/issue?@action=redirect&bpo=40834]: 修复在发送str对象时使用_xxsubinterpreters.channel_send的截断问题。

bpo-40755 [https://bugs.python.org/issue?@action=redirect&bpo=40755]: 向collections.Counter()添加富比较方法。

bpo-26407 [https://bugs.python.org/issue?@action=redirect&bpo=26407]: 在 csv.reader(), csv.writer.writerow() 和 csv.writer.writerows() 中调用 __iter__ 方法时不再因 TypeError 掩盖意外错误。

bpo-39384 [https://bugs.python.org/issue?@action=redirect&bpo=39384]: 修复了email.contentmanager，允许set_content()设置空字符串。

bpo-40744 [https://bugs.python.org/issue?@action=redirect&bpo=40744]: sqlite3 模块使用了需要SQLite v3.7.3或更高版本的SQLite API函数。此补丁移除了对旧版本SQLite的支持，并在构建、编译和运行时明确要求SQLite 3.7.3。由Sergey Fedoseev和Erlend E. Aasland提供补丁。

bpo-40777 [https://bugs.python.org/issue?@action=redirect&bpo=40777]: 在运行时初始化PyDateTime_IsoCalendarDateType.tp_base，以避免在某些编译器上出现错误。

bpo-38488 [https://bugs.python.org/issue?@action=redirect&bpo=38488]: 更新ensurepip以安装pip 20.1.1和setuptools 47.1.0。

bpo-40792 [https://bugs.python.org/issue?@action=redirect&bpo=40792]: operator.index() 的结果现在总是具有确切的 int 类型。以前，结果可能是 int 子类的实例。

bpo-40767 [https://bugs.python.org/issue?@action=redirect&bpo=40767]: webbrowser 现在通过检查WAYLAND_DISPLAY环境变量，在纯Wayland系统中正确找到默认浏览器。补丁由Jérémy Attali贡献。

bpo-40791 [https://bugs.python.org/issue?@action=redirect&bpo=40791]: 当OpenSSL可用时，hashlib.compare_digest() 使用OpenSSL的``CRYPTO_memcmp()``函数。

bpo-40795 [https://bugs.python.org/issue?@action=redirect&bpo=40795]: ctypes 模块：如果ctypes未能转换回调的结果，或者如果ctypes回调函数引发异常，现在会调用带有异常设置的sys.unraisablehook。以前，错误由 PyErr_Print() 记录到stderr。

bpo-16995 [https://bugs.python.org/issue?@action=redirect&bpo=16995]: 添加 base64.b32hexencode() 和 base64.b32hexdecode() 以支持使用扩展十六进制字母表的Base32编码。

bpo-30008 [https://bugs.python.org/issue?@action=redirect&bpo=30008]: 修复 ssl 代码以兼容使用 no-deprecated 和 --api=1.1.0 构建的OpenSSL 1.1.x。

bpo-30064 [https://bugs.python.org/issue?@action=redirect&bpo=30064]: 修复asyncio loop.sock_* 竞争条件问题

bpo-40759 [https://bugs.python.org/issue?@action=redirect&bpo=40759]: 弃用 symbol 模块。

bpo-40756 [https://bugs.python.org/issue?@action=redirect&bpo=40756]: LoggerAdapter.__init__ 的第二个参数(extra)现在默认为None。

bpo-37129 [https://bugs.python.org/issue?@action=redirect&bpo=37129]: Add a new os.RWF_APPEND flag for os.pwritev().

bpo-40737 [https://bugs.python.org/issue?@action=redirect&bpo=40737]: 修复 sqlite3 初始化时可能的引用泄漏。

bpo-40726 [https://bugs.python.org/issue?@action=redirect&bpo=40726]: 处理在 ast.increment_lineno() 中 end_lineno 为 None 的情况。

bpo-40698 [https://bugs.python.org/issue?@action=redirect&bpo=40698]: distutils upload creates SHA2-256 and Blake2b-256 digests. MD5 digests is skipped if platform blocks MD5.

bpo-40695 [https://bugs.python.org/issue?@action=redirect&bpo=40695]: hashlib 不再在 OpenSSL 提供哈希摘要且算法被安全策略阻止时回退到内置哈希实现。

bpo-9216 [https://bugs.python.org/issue?@action=redirect&bpo=9216]: func:hashlib.new passed usedforsecurity to OpenSSL EVP constructor _hashlib.new(). test_hashlib and test_smtplib handle strict security policy better.

bpo-40614 [https://bugs.python.org/issue?@action=redirect&bpo=40614]: ast.parse() 在传递的 feature_version 小于 (3, 8) 时不会解析 f-strings 中的自文档化表达式。

bpo-40626 [https://bugs.python.org/issue?@action=redirect&bpo=40626]: 根据 HDF Group 对 HDF5 格式化数据文件的建议，添加 h5 文件扩展名作为 MIME 类型 application/x-hdf5。补丁由 Mark Schwab 贡献。

bpo-25920 [https://bugs.python.org/issue?@action=redirect&bpo=25920]: 在 macOS 上，当为 macOS 10.4 及更早版本构建 Python 时（这不是 python.org macOS 安装程序的情况），socket.getaddrinfo() 不再使用内部锁来防止在调用 getaddrinfo() 时出现竞争条件，因为自 macOS 10.5 起它就是线程安全的。Python 3.9 需要 macOS 10.6 或更新版本。当另一个线程调用 socket.getaddrinfo() 时，内部锁会导致 fork 时随机挂起。该锁也用于比 5.3 旧的 FreeBSD，比 201311 旧的 OpenBSD 和比 4 旧的 NetBSD。

bpo-40671 [https://bugs.python.org/issue?@action=redirect&bpo=40671]: 为 PEP 489 [https://www.python.org/dev/peps/pep-0489] 准备 _hashlib 并使用 PyModule_AddType()。

bpo-32309 [https://bugs.python.org/issue?@action=redirect&bpo=32309]: 添加了一个新的 coroutine asyncio.to_thread()。它主要用于在单独的线程中运行 IO 密集型函数以避免阻塞事件循环，本质上是一个可以直接接受关键字参数的高级版本的 run_in_executor()。

bpo-36543 [https://bugs.python.org/issue?@action=redirect&bpo=36543]: 恢复了已弃用的 xml.etree.cElementTree 模块。

bpo-40611 [https://bugs.python.org/issue?@action=redirect&bpo=40611]: MAP_POPULATE constant has now been added to the list of exported mmap module flags.

bpo-39881 [https://bugs.python.org/issue?@action=redirect&bpo=39881]: 在测试套件中使用PEP 554。（由Joannah Nanjekye提供补丁）

bpo-13097 [https://bugs.python.org/issue?@action=redirect&bpo=13097]: ctypes 现在在回调函数被调用时传递超过1024个参数时会引发 ArgumentError。

bpo-39385 [https://bugs.python.org/issue?@action=redirect&bpo=39385]: 一个新的测试断言上下文管理器 unittest.assertNoLogs() 将确保给定的代码块不产生任何使用日志模块的日志消息。由Kit Yan Choi贡献。

bpo-23082 [https://bugs.python.org/issue?@action=redirect&bpo=23082]: 更新了PurePath.relative_to()的错误信息和文档，以更好地反映函数行为。

bpo-40318 [https://bugs.python.org/issue?@action=redirect&bpo=40318]: 如果可用，使用SQLite3跟踪v2 API。

bpo-40105 [https://bugs.python.org/issue?@action=redirect&bpo=40105]: 在附加（"a"）模式下提供较短的注释时，ZipFile会截断文件以避免损坏。由Jan Mazur提供补丁。

bpo-40084 [https://bugs.python.org/issue?@action=redirect&bpo=40084]: 修复了 Enum.__dir__: dir(Enum.member) 现在包括属性和方法。

bpo-31122 [https://bugs.python.org/issue?@action=redirect&bpo=31122]: ssl.wrap_socket() 现在在TLS协商期间对等方关闭连接时引发ssl.SSLEOFError而不是OSError。

bpo-39728 [https://bugs.python.org/issue?@action=redirect&bpo=39728]: fix default _missing_ so a duplicate ValueError is not set as the __context__ of the original ValueError

bpo-39244 [https://bugs.python.org/issue?@action=redirect&bpo=39244]: 修复了 multiprocessing.context.get_all_start_methods，以在macOS上正确首先返回默认方法。

bpo-39040 [https://bugs.python.org/issue?@action=redirect&bpo=39040]: 通过折叠裸引号字符串中编码字词之间的空白，修复了无效mime头参数的解析。

bpo-38731 [https://bugs.python.org/issue?@action=redirect&bpo=38731]: 向 py_compile 的命令行界面添加了 --quiet 选项。由Gregory Schevchenko提供补丁。

bpo-35714 [https://bugs.python.org/issue?@action=redirect&bpo=35714]: 如果 struct 格式字符串中有空字符，现在会引发 struct.error。

bpo-38144 [https://bugs.python.org/issue?@action=redirect&bpo=38144]: 在 glob.glob() 中添加了 root_dir 和 dir_fd 参数。

bpo-26543 [https://bugs.python.org/issue?@action=redirect&bpo=26543]: Fix IMAP4.noop() when debug mode is enabled (ex: imaplib.Debug = 3).

bpo-12178 [https://bugs.python.org/issue?@action=redirect&bpo=12178]: csv.writer() 现在在输入包含 escapechar 时正确转义 escapechar。补丁由Catalin Iacob、Berker Peksag和Itay Elbirt提供。

bpo-36290 [https://bugs.python.org/issue?@action=redirect&bpo=36290]: AST节点现在在关键字参数冲突时抛出 TypeError。补丁由Rémi Lapeyre提供。

bpo-33944 [https://bugs.python.org/issue?@action=redirect&bpo=33944]: 在详细模式下增加了site.py对site-packages的追踪。

bpo-35078 [https://bugs.python.org/issue?@action=redirect&bpo=35078]: 重构calendar模块中LocaleHTMLCalendar和LocaleTextCalendar类的formatweekday、formatmonthname方法，以调用基类方法。这使得LocaleHTMLCalendar的CSS类可定制。由Srinivas Reddy Thatiparthy提供补丁。

bpo-29620 [https://bugs.python.org/issue?@action=redirect&bpo=29620]: assertWarns() 在访问模块的 __warningregistry__``导致新模块导入或另一线程中导入新模块时不再引发 ``RuntimeException。由Kernc提供补丁。

bpo-31844 [https://bugs.python.org/issue?@action=redirect&bpo=31844]: 从私有的、未文档化的 _markupbase 模块中移除 ParserBase.error() 方法。html.parser.HTMLParser 是 ParserBase 的唯一子类，其 error() 实现在Python 3.4中被弃用，在Python 3.5中被移除。

bpo-34226 [https://bugs.python.org/issue?@action=redirect&bpo=34226]: Fix cgi.parse_multipart without content_length. Patch by Roger Duran

bpo-33660 [https://bugs.python.org/issue?@action=redirect&bpo=33660]: 修复pathlib.PosixPath正确解析位于根目录的相对路径。

bpo-28557 [https://bugs.python.org/issue?@action=redirect&bpo=28557]: 改进 rawio.readinto 行为异常时的错误信息。

bpo-26680 [https://bugs.python.org/issue?@action=redirect&bpo=26680]: 为Decimal类型添加d.is_integer()方法，以与其他数字类型兼容。

bpo-26680 [https://bugs.python.org/issue?@action=redirect&bpo=26680]: 将x.is_integer()方法纳入数字塔的抽象类型Real、Rational和Integral中，并提供适当的默认实现。

文档

bpo-41428 [https://bugs.python.org/issue?@action=redirect&bpo=41428]: 为 PEP 604 [https://www.python.org/dev/peps/pep-0604] (允许将联合类型写作 X | Y) 添加文档。

bpo-41774 [https://bugs.python.org/issue?@action=redirect&bpo=41774]: 在编程FAQ的“序列（元组/列表）”部分添加“如何从列表中删除多个项目”。

bpo-35293 [https://bugs.python.org/issue?@action=redirect&bpo=35293]: Fix RemovedInSphinx40Warning when building the documentation. Patch by Dong-hee Na.

bpo-37149 [https://bugs.python.org/issue?@action=redirect&bpo=37149]: 将Shipman tkinter文档链接从archive.org更改为TkDocs。（该文档已从NMT服务器移除。）新链接响应更快，并包含简短说明。

bpo-41726 [https://bugs.python.org/issue?@action=redirect&bpo=41726]: 更新 PyType_FromModuleAndSpec 的引用计数信息。

bpo-41624 [https://bugs.python.org/issue?@action=redirect&bpo=41624]: 修正 typing.Coroutine 的签名。

bpo-40204 [https://bugs.python.org/issue?@action=redirect&bpo=40204]: 启用Sphinx 3.2的 c_allow_pre_v3 选项并禁用 c_warn_on_allowed_pre_v3 选项，使文档兼容Sphinx 2和Sphinx 3。

bpo-41045 [https://bugs.python.org/issue?@action=redirect&bpo=41045]: 添加f-strings调试功能的文档。

bpo-41314 [https://bugs.python.org/issue?@action=redirect&bpo=41314]: 将 from __future__ import annotations 成为默认的发布版本从 4.0 改为``3.10`` (遵循PEP 563的变更) 。

bpo-40979 [https://bugs.python.org/issue?@action=redirect&bpo=40979]: 重构typing.rst，将超过70个类、函数和装饰器安排到新的子章节中。

bpo-40552 [https://bugs.python.org/issue?@action=redirect&bpo=40552]: 修正教程4.2节的代码片段，现在代码正确。

bpo-39883 [https://bugs.python.org/issue?@action=redirect&bpo=39883]: 使Python文档中的代码、示例和配方除了现有的Python 2.0许可证外，还采用更宽松的BSD0许可证。

bpo-37703 [https://bugs.python.org/issue?@action=redirect&bpo=37703]: 更新文档，全面阐述gather.cancel()的行为。

测试

bpo-41939 [https://bugs.python.org/issue?@action=redirect&bpo=41939]: 修复test_site.test_license_exists_at_url()：调用``urllib.request.urlcleanup()``以重置全局 urllib.request._opener。由Victor Stinner提供补丁。

bpo-41731 [https://bugs.python.org/issue?@action=redirect&bpo=41731]: 使test_cmd_line_script在使用选项'-vv'时通过。

bpo-41602 [https://bugs.python.org/issue?@action=redirect&bpo=41602]: 为runpy模块中的SIGINT处理添加测试。

bpo-41521 [https://bugs.python.org/issue?@action=redirect&bpo=41521]: test.support: 将 check__all__() 的 blacklist 参数重命名为 not_exported。

bpo-41477 [https://bugs.python.org/issue?@action=redirect&bpo=41477]: 在test_genericalias中使ctypes可选。

bpo-41085 [https://bugs.python.org/issue?@action=redirect&bpo=41085]: 在64位Windows上修复 array.array.index() 方法对于大于 2**31 的索引的整数溢出问题。

bpo-41069 [https://bugs.python.org/issue?@action=redirect&bpo=41069]: test.support.TESTFN 和通过 test.regrtest 运行测试时的当前目录现在尽可能包含非ASCII字符。

bpo-38377 [https://bugs.python.org/issue?@action=redirect&bpo=38377]: 在Linux上，如果当前用户无法在 /dev/shm/ 目录中创建文件，则跳过使用多进程的测试。将 skip_if_broken_multiprocessing_synchronize() 函数添加到 test.support 模块中。

bpo-41009 [https://bugs.python.org/issue?@action=redirect&bpo=41009]: 修复了将 support.require_{linux|mac|freebsd}_version() 装饰器用作类装饰器时的问题。

bpo-41003 [https://bugs.python.org/issue?@action=redirect&bpo=41003]: 修复了当安装 numpy``时 ``test_copyreg 的问题：test.pickletester 现在在导入 numpy 时保存/恢复警告过滤器，以忽略由 numpy 安装的过滤器。

bpo-40964 [https://bugs.python.org/issue?@action=redirect&bpo=40964]: 禁用远程 imaplib 测试，主机cyrus.andrew.cmu.edu正在阻止传入连接。

bpo-40927 [https://bugs.python.org/issue?@action=redirect&bpo=40927]: 修复了test_binhex在运行两次时的问题：现在使用import_fresh_module()确保每次都引发DeprecationWarning。

bpo-17258 [https://bugs.python.org/issue?@action=redirect&bpo=17258]: 当MD5哈希摘要被阻止时，跳过一些 multiprocessing 测试。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为VxWorks RTOS将LOOPBACK_TIMEOUT增加到10。

bpo-38169 [https://bugs.python.org/issue?@action=redirect&bpo=38169]: 增加SharedMemory和ShareableList的代码覆盖率

bpo-34401 [https://bugs.python.org/issue?@action=redirect&bpo=34401]: 使test_gdb在HP-UX上正确运行。由Michael Osipov提供补丁。

构建

bpo-38249 [https://bugs.python.org/issue?@action=redirect&bpo=38249]: Update Py_UNREACHABLE to use __builtin_unreachable() if only the compiler is able to use it. Patch by Dong-hee Na.

bpo-41617 [https://bugs.python.org/issue?@action=redirect&bpo=41617]: 修复 pycore_bitutils.h 头文件以支持旧版本的clang：``__builtin_bswap16()``在LLVM clang 3.0中不可用。

bpo-40204 [https://bugs.python.org/issue?@action=redirect&bpo=40204]: 在 Doc/Makefile 中将Sphinx版本固定为2.3.1。

bpo-36020 [https://bugs.python.org/issue?@action=redirect&bpo=36020]: 现在构建Python需要C99函数 snprintf() 和 vsnprintf()。

bpo-40684 [https://bugs.python.org/issue?@action=redirect&bpo=40684]: make install 现在在使用 ./configure --with-platlibdir 时，为目标``lib-dynload/目录使用 ``PLATLIBDIR 变量。

bpo-40683 [https://bugs.python.org/issue?@action=redirect&bpo=40683]: 修复了当使用 make 安装Python时，zoneinfo 模块及其测试未被包含的问题。

Windows

bpo-41744 [https://bugs.python.org/issue?@action=redirect&bpo=41744]: 修复使用Nuget包时props文件的自动导入问题。

bpo-41627 [https://bugs.python.org/issue?@action=redirect&bpo=41627]: 32位用户站点目录现在包含一个 -32 后缀，以区别于64位解释器的目录。

bpo-41526 [https://bugs.python.org/issue?@action=redirect&bpo=41526]: 通过移除对Mark Hammond的特别感谢（获得他的许可），修复了安装程序最后一页的布局问题。

bpo-41492 [https://bugs.python.org/issue?@action=redirect&bpo=41492]: 修复了出现在UAC提示中的描述。

bpo-40948 [https://bugs.python.org/issue?@action=redirect&bpo=40948]: 改进安装后消息，引导人们使用"py"命令。

bpo-41412 [https://bugs.python.org/issue?@action=redirect&bpo=41412]: 安装程序现在将无法在Windows 7和Windows 8上安装。此外，UCRT依赖现在总是按需下载。

bpo-40741 [https://bugs.python.org/issue?@action=redirect&bpo=40741]: 更新Windows版本，包括SQLite 3.32.3。

bpo-41142 [https://bugs.python.org/issue?@action=redirect&bpo=41142]: msilib now supports creating CAB files with non-ASCII file path and adding files with non-ASCII file path to them.

bpo-41074 [https://bugs.python.org/issue?@action=redirect&bpo=41074]: Fixed support of non-ASCII names in functions msilib.OpenDatabase() and msilib.init_database() and non-ASCII SQL in method msilib.Database.OpenView().

bpo-41039 [https://bugs.python.org/issue?@action=redirect&bpo=41039]: 稳定的ABI重定向DLL（python3.dll）现在使用 #pragma comment(linker) 进行重新导出。

bpo-40164 [https://bugs.python.org/issue?@action=redirect&bpo=40164]: 将Windows上的OpenSSL更新至1.1.1g。

bpo-39631 [https://bugs.python.org/issue?@action=redirect&bpo=39631]: 将Windows上 .py 文件的注册MIME类型更改为 text/x-python，而不是``text/plain``。

bpo-40677 [https://bugs.python.org/issue?@action=redirect&bpo=40677]: 手动定义IO_REPARSE_TAG_APPEXECLINK，以防某些旧的Windows SDK没有它。

bpo-37556 [https://bugs.python.org/issue?@action=redirect&bpo=37556]: 扩展py.exe帮助，提及通过venv、shebang、环境变量和ini文件进行的覆盖。

macOS

bpo-41557 [https://bugs.python.org/issue?@action=redirect&bpo=41557]: 更新macOS安装程序，使用SQLite 3.33.0。

bpo-39580 [https://bugs.python.org/issue?@action=redirect&bpo=39580]: 如果从命令行运行安装程序，避免打开Finder窗口。补丁由Rick Heil贡献。

bpo-41100 [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。

bpo-40741 [https://bugs.python.org/issue?@action=redirect&bpo=40741]: 更新 macOS 安装程序以使用 SQLite 3.32.3。

bpo-41005 [https://bugs.python.org/issue?@action=redirect&bpo=41005]: 修复了 webbrowser.py 中不允许 macOS 打开浏览器的 XDG 设置问题。

bpo-40741 [https://bugs.python.org/issue?@action=redirect&bpo=40741]: 更新 macOS 安装程序以使用 SQLite 3.32.2。

IDLE

bpo-41775 [https://bugs.python.org/issue?@action=redirect&bpo=41775]: 使用 'IDLE Shell' 作为 shell 标题。

bpo-35764 [https://bugs.python.org/issue?@action=redirect&bpo=35764]: 重写 Calltips 文档部分。

bpo-40181 [https://bugs.python.org/issue?@action=redirect&bpo=40181]: 在 calltips 中，停止提醒 '/' 标记仅位置参数的结束。

bpo-41468 [https://bugs.python.org/issue?@action=redirect&bpo=41468]: 改进 IDLE 运行崩溃错误消息（用户应该永远不会看到）。

bpo-41373 [https://bugs.python.org/issue?@action=redirect&bpo=41373]: 通过将其行结束符设置为系统默认值，保存没有行结束符加载的文件，如空白或不同行结束符。修复 3.8.4 和 3.9.0b4 中的回归。

bpo-41300 [https://bugs.python.org/issue?@action=redirect&bpo=41300]: 保存含有非 ASCII 字符的文件。修复 3.9.0b4 和 3.8.4 中发布的回归。

bpo-37765 [https://bugs.python.org/issue?@action=redirect&bpo=37765]: 将关键字添加到模块名称完成列表。重写 IDLE 文档的 Completions 部分。

bpo-41152 [https://bugs.python.org/issue?@action=redirect&bpo=41152]: IDLE 中 stdin、stdout 和 stderr 的编码现在始终为 UTF-8。

bpo-41144 [https://bugs.python.org/issue?@action=redirect&bpo=41144]: 使 Open Module 可以打开特殊模块如 os.path。

bpo-39885 [https://bugs.python.org/issue?@action=redirect&bpo=39885]: 使上下文菜单中的剪切和复制在右击选择内容时再次工作。

bpo-40723 [https://bugs.python.org/issue?@action=redirect&bpo=40723]: 使 test_idle 在导入后运行时通过。

C API

bpo-41936 [https://bugs.python.org/issue?@action=redirect&bpo=41936]: 移除了未文档化的宏 Py_ALLOW_RECURSION 和 Py_END_ALLOW_RECURSION 以及 PyInterpreterState 结构的 recursion_critical 字段。

bpo-41692 [https://bugs.python.org/issue?@action=redirect&bpo=41692]: PyUnicode_InternImmortal() 函数现在已被弃用，并将在 Python 3.12 中移除：改用 PyUnicode_InternInPlace()。由 Victor Stinner 提供补丁。

bpo-41842 [https://bugs.python.org/issue?@action=redirect&bpo=41842]: 添加 PyCodec_Unregister() 函数以取消注册一个编解码器搜索函数。

bpo-41834 [https://bugs.python.org/issue?@action=redirect&bpo=41834]: 移除 _Py_CheckRecursionLimit 变量：它已被 PyInterpreterState 结构的 ceval.recursion_limit 取代。由 Victor Stinner 提供补丁。

bpo-41689 [https://bugs.python.org/issue?@action=redirect&bpo=41689]: 使用 PyType_FromSpec() 创建的类型现在可以从 __text_signature__ 访问其 tp_doc 槽中的任何签名。

bpo-41524 [https://bugs.python.org/issue?@action=redirect&bpo=41524]: 修复 PyOS_mystrnicmp 和 PyOS_mystricmp 中增加指针超出字符串末尾的 bug。

bpo-41324 [https://bugs.python.org/issue?@action=redirect&bpo=41324]: 添加一个最小的十进制胶囊 API。该 API 支持最多 38 位数字的 Decimal 与其作为 C 结构体的三元表示之间的快速转换。

bpo-30155 [https://bugs.python.org/issue?@action=redirect&bpo=30155]: 添加 PyDateTime_DATE_GET_TZINFO() 和 PyDateTime_TIME_GET_TZINFO() 宏，用于访问 datetime.datetime 和 datetime.time 对象的 tzinfo 属性。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: 回滚 PyType_HasFeature() 更改：当不使用有限的 C API 时，它再次直接读取 PyTypeObject.tp_flags 成员，而不是总是调用隐藏实现细节的 PyType_GetFlags()。

bpo-41123 [https://bugs.python.org/issue?@action=redirect&bpo=41123]: 移除 PyUnicode_AsUnicodeCopy。

bpo-41123 [https://bugs.python.org/issue?@action=redirect&bpo=41123]: 移除 PyLong_FromUnicode()。

bpo-41123 [https://bugs.python.org/issue?@action=redirect&bpo=41123]: 移除 PyUnicode_GetMax()。

bpo-41123 [https://bugs.python.org/issue?@action=redirect&bpo=41123]: 移除操作 Py_UNICODE* 字符串的 Py_UNICODE_str* 函数。

bpo-41103 [https://bugs.python.org/issue?@action=redirect&bpo=41103]: 移除 PyObject_AsCharBuffer()、PyObject_AsReadBuffer()、PyObject_CheckReadBuffer() 和 PyObject_AsWriteBuffer()。请迁移到新的缓冲区协议；PyObject_GetBuffer() 和 PyBuffer_Release()。

bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346]: 对于 PyUnicode_FromUnicode(NULL, size) 和 PyUnicode_FromStringAndSize(NULL, size) 当 size > 0 时引发 DeprecationWarning。

bpo-36346 [https://bugs.python.org/issue?@action=redirect&bpo=36346]: 在 C 中标记 Py_UNICODE_COPY、Py_UNICODE_FILL、PyUnicode_WSTR_LENGTH、PyUnicode_FromUnicode、PyUnicode_AsUnicode 和 PyUnicode_AsUnicodeAndSize 为弃用。移除自 Python 3.3 以来已被弃用且损坏的 Py_UNICODE_MATCH。

bpo-40989 [https://bugs.python.org/issue?@action=redirect&bpo=40989]: PyObject_INIT() 和 PyObject_INIT_VAR() 宏分别成为 PyObject_Init() 和 PyObject_InitVar() 函数的别名。

bpo-36020 [https://bugs.python.org/issue?@action=redirect&bpo=36020]: 在 Windows 上，#include "pyerrors.h" 不再定义 snprintf 和 vsnprintf 宏。

bpo-40943 [https://bugs.python.org/issue?@action=redirect&bpo=40943]: 现在必须定义 PY_SSIZE_T_CLEAN 宏才能使用 PyArg_ParseTuple() 和 Py_BuildValue() 格式，这些格式使用 #: es#、 et#、 s#、 u#、 y#、 z#、 U# 和 Z#。参见 Parsing arguments and building values 和 PEP 353 [https://www.python.org/dev/peps/pep-0353]。

bpo-40910 [https://bugs.python.org/issue?@action=redirect&bpo=40910]: 显式地将 Py_GetArgcArgv() 函数导出到 C API 并记录该函数。之前，它是隐式导出的，由于 Python 是用 -fvisibility=hidden 构建的，这种方式不再有效。

bpo-40724 [https://bugs.python.org/issue?@action=redirect&bpo=40724]: 允许在类型规范中定义缓冲区槽。

bpo-40679 [https://bugs.python.org/issue?@action=redirect&bpo=40679]: 修复了如果 qualname 参数为 NULL 时 _PyEval_EvalCode() 的崩溃问题。

bpo-40839 [https://bugs.python.org/issue?@action=redirect&bpo=40839]: 由于历史原因，允许在不持有 GIL 的情况下调用 PyDict_GetItem()。现在不再允许这样做。

bpo-40826 [https://bugs.python.org/issue?@action=redirect&bpo=40826]: 现在如果在 GIL 释放的情况下调用 PyOS_InterruptOccurred()，将会失败并产生致命错误。

bpo-40792 [https://bugs.python.org/issue?@action=redirect&bpo=40792]: PyNumber_Index() 的结果现在总是具有确切的 int 类型。以前，结果可能是 int 的子类的实例。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: 将 Py_REFCNT() 和 Py_SIZE() 宏转换为静态内联函数。它们不能再被用作左值：使用 Py_SET_REFCNT() 和 Py_SET_SIZE() 来设置对象的引用计数和大小。这一变化是有意为之的不兼容更改，目的是为 C API 准备一个不透明的 PyObject 结构。

bpo-40703 [https://bugs.python.org/issue?@action=redirect&bpo=40703]: PyType_FromSpec*() 函数不再覆盖类型的 "__module__" 属性，如果该属性是通过 "Py_tp_members" 或 "Py_tp_getset" 设置的。

bpo-39583 [https://bugs.python.org/issue?@action=redirect&bpo=39583]: 从 Include/cpython/*.h 中删除了多余的 "extern C" 声明。

Python 3.9.0 beta 1

发布日期: 2020-05-19

安全性

bpo-40501 [https://bugs.python.org/issue?@action=redirect&bpo=40501]: uuid 不再使用 ctypes 在运行时加载 libuuid 或 rpcrt4.dll。

核心与内置函数

bpo-40663 [https://bugs.python.org/issue?@action=redirect&bpo=40663]: 正确生成省略了括号但需要的地方的注释（例如：Type[(str, int, *other))]）。

bpo-40596 [https://bugs.python.org/issue?@action=redirect&bpo=40596]: 修复了 Windows 上 str.isidentifier() 对于包含非 BMP 字符的非规范化字符串的处理。

bpo-40593 [https://bugs.python.org/issue?@action=redirect&bpo=40593]: 改进了源代码中无效字符的语法错误提示。

bpo-40585 [https://bugs.python.org/issue?@action=redirect&bpo=40585]: 修复了使用 codeop.compile_command() 时的一个 bug，该 bug 导致新解析器吞没了异常。由 Pablo Galindo 提供补丁。

bpo-40566 [https://bugs.python.org/issue?@action=redirect&bpo=40566]: 将 PEP 573 [https://www.python.org/dev/peps/pep-0573] 应用到 abc。

bpo-40502 [https://bugs.python.org/issue?@action=redirect&bpo=40502]: 初始化 n->n_col_offset。（由 Joannah Nanjekye 提供补丁）

bpo-40527 [https://bugs.python.org/issue?@action=redirect&bpo=40527]: 修复命令行参数解析：不再多次将错误写入 stderr。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 errno 移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-40523 [https://bugs.python.org/issue?@action=redirect&bpo=40523]: 为 weakref.proxy 对象添加 hash() 和 reversed() 的透传。由 Pablo Galindo 提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 syslog 移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-40246 [https://bugs.python.org/issue?@action=redirect&bpo=40246]: Reporting a specialised error message for invalid string prefixes, which was introduced in bpo-40246 [https://bugs.python.org/issue?@action=redirect&bpo=40246], is being reverted due to backwards compatibility concerns for strings that immediately follow a reserved keyword without whitespace between them. Constructs like bg="#d00" if clear else"#fca" were failing to parse, which is not an acceptable breakage on such short notice.

bpo-40417 [https://bugs.python.org/issue?@action=redirect&bpo=40417]: 修复了当调用 PyImport_ReloadModule 时 imp 模块的弃用警告。由 Robert Rouhani 提供补丁。

bpo-40408 [https://bugs.python.org/issue?@action=redirect&bpo=40408]: 修复了在 GenericAlias 中嵌套类型变量（如 list[list[T]]）的支持。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _stat 模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-29587 [https://bugs.python.org/issue?@action=redirect&bpo=29587]: 在调用 generator.throw() 时启用隐式异常链。

bpo-40328 [https://bugs.python.org/issue?@action=redirect&bpo=40328]: 为 CJKCodecs 添加生成映射头文件的工具。

bpo-40228 [https://bugs.python.org/issue?@action=redirect&bpo=40228]: 现在设置 frame.f_lineno 对于源代码到字节码编译器的变化是健壮的。

bpo-38880 [https://bugs.python.org/issue?@action=redirect&bpo=38880]: 在内置子解释器模块中添加了列出与通道端相关联的解释器的能力。

bpo-37986 [https://bugs.python.org/issue?@action=redirect&bpo=37986]: 对于适合 long 的值，提高 PyLong_FromDouble() 的性能。

库

bpo-40662 [https://bugs.python.org/issue?@action=redirect&bpo=40662]: 修复了 ast.get_source_segment() 对于具有不完整位置信息的 ast 节点的问题。由 Irit Katriel 提供补丁。

bpo-40665 [https://bugs.python.org/issue?@action=redirect&bpo=40665]: 转换 bisect 以使用 Argument Clinic。

bpo-40536 [https://bugs.python.org/issue?@action=redirect&bpo=40536]: 在 zoneinfo 模块中增加了 available_timezones() 函数。由 Paul Ganssle 提供补丁。

bpo-40645 [https://bugs.python.org/issue?@action=redirect&bpo=40645]: hmac.HMAC 暴露了内部实现细节。属性 digest_cons、inner 和 outer 已被弃用，并将在未来移除。

bpo-40645 [https://bugs.python.org/issue?@action=redirect&bpo=40645]: 内部模块 _hashlib 包装并暴露了 OpenSSL 的 HMAC API。新的代码将在 Python 3.10 中使用，在纯 Python HMAC 模块的内部实现细节不再作为公共 API 的一部分之后。

bpo-40637 [https://bugs.python.org/issue?@action=redirect&bpo=40637]: 现在可以通过 configure --with-builtin-hashlib-hashes=sha3,blake1 或 --without-builtin-hashlib-hashes 禁用或有选择地启用内置哈希模块。

bpo-37630 [https://bugs.python.org/issue?@action=redirect&bpo=37630]: hashlib 模块现在可以在可用时使用 OpenSSL 的 SHA3 哈希和 SHAKE XOF。

bpo-40479 [https://bugs.python.org/issue?@action=redirect&bpo=40479]: hashlib 现在可以与 OpenSSL 3.0.0-alpha2 一起编译。

bpo-40257 [https://bugs.python.org/issue?@action=redirect&bpo=40257]: 恢复对 inspect.getdoc() 的更改。

bpo-40607 [https://bugs.python.org/issue?@action=redirect&bpo=40607]: 当由于超时取消任务时，asyncio.wait_for() 现在会在取消过程中发生错误时传播异常。由 Roman Skurikhin 提供补丁。

bpo-40612 [https://bugs.python.org/issue?@action=redirect&bpo=40612]: 修复了 SyntaxError 格式化中的边缘情况。如果偏移量 <= 0，则不打印插入符号。如果偏移量 > 行长度，则打印指向最后一个字符之后的插入符号。

bpo-40597 [https://bugs.python.org/issue?@action=redirect&bpo=40597]: 如果文本内容行比 policy.max_line_length 长，则始终使用内容编码以确保它们被换行。

bpo-40571 [https://bugs.python.org/issue?@action=redirect&bpo=40571]: 添加了 functools.cache() 作为访问 lru_cache(maxsize=None) 的无界缓存变体的更简单、更易发现的方式。

bpo-40503 [https://bugs.python.org/issue?@action=redirect&bpo=40503]: PEP 615 [https://www.python.org/dev/peps/pep-0615]，zoneinfo 模块。增加了对 IANA 时区数据库的支持。

bpo-40397 [https://bugs.python.org/issue?@action=redirect&bpo=40397]: 从特殊泛型别名如 typing.List (未下标) 中移除了属性 __args__ 和 __parameters__。

bpo-40549 [https://bugs.python.org/issue?@action=redirect&bpo=40549]: 将 posixmodule.c（"posix" 或 "nt" 模块）转换为多阶段初始化（PEP 489）。

bpo-31033 [https://bugs.python.org/issue?@action=redirect&bpo=31033]: 向 Future.cancel() 和 Task.cancel() 添加了一个 msg 参数。

bpo-40541 [https://bugs.python.org/issue?@action=redirect&bpo=40541]: 向 random.sample() 添加了一个可选的 counts 参数。

bpo-40515 [https://bugs.python.org/issue?@action=redirect&bpo=40515]: ssl 和 hashlib 模块现在主动检查 OpenSSL 是否构建了线程支持。Python 3.7.0 使线程支持成为强制性要求，不再安全地工作于无线程构建。

bpo-31033 [https://bugs.python.org/issue?@action=redirect&bpo=31033]: 当一个 asyncio.Task 被取消时，异常回溯现在一直链接回任务首次被中断的地方。

bpo-40504 [https://bugs.python.org/issue?@action=redirect&bpo=40504]: functools.lru_cache() 对象现在可以是弱引用的目标。

bpo-40559 [https://bugs.python.org/issue?@action=redirect&bpo=40559]: 修复了 asyncio.Task 的 C 实现中可能的内存泄漏。

bpo-40480 [https://bugs.python.org/issue?@action=redirect&bpo=40480]: fnmatch.fnmatch() 在存在多个 * 模式字符时可能花费指数时间。通过生成更复杂的正则表达式来避免无用的回溯，修复了这一问题。

bpo-40495 [https://bugs.python.org/issue?@action=redirect&bpo=40495]: compileall 现在能够使用硬链接来防止在不同优化级别的 .pyc 文件内容相同的情况下产生重复。

bpo-40457 [https://bugs.python.org/issue?@action=redirect&bpo=40457]: ssl 模块现在支持不包含 TLS 1.0 和 1.1 方法的 OpenSSL 构建。

bpo-40355 [https://bugs.python.org/issue?@action=redirect&bpo=40355]: 在存在格式错误的 ast.Dict 节点时，改进 ast.literal_eval() 的错误报告，而不是静默忽略任何不符合要求的元素。由 Curtis Bucher 提供补丁。

bpo-40465 [https://bugs.python.org/issue?@action=redirect&bpo=40465]: 弃用了 random.shuffle() 的可选 random 参数。

bpo-40459 [https://bugs.python.org/issue?@action=redirect&bpo=40459]: platform.win32_ver() 现在生成正确的 ptype 字符串而不是空字符串。

bpo-39435 [https://bugs.python.org/issue?@action=redirect&bpo=39435]: pickle.loads() 的第一个参数现在是仅位置参数。

bpo-39305 [https://bugs.python.org/issue?@action=redirect&bpo=39305]: Update nntplib to merge nntplib.NNTP and nntplib._NNTPBase. Patch by Dong-hee Na.

bpo-32494 [https://bugs.python.org/issue?@action=redirect&bpo=32494]: Update dbm.gnu to use gdbm_count if possible when calling len(). Patch by Dong-hee Na.

bpo-40453 [https://bugs.python.org/issue?@action=redirect&bpo=40453]: 添加 isolated=True 关键字参数到 _xxsubinterpreters.create()。一个孤立的子解释器不能生成线程、生成子进程或调用 os.fork()。

bpo-40286 [https://bugs.python.org/issue?@action=redirect&bpo=40286]: 移除 _random.Random.randbytes()：randbytes() 的 C 实现。为实现子类化，该方法现在直接在 Python 中实现：randbytes() 现在直接重用 getrandbits()。

bpo-40394 [https://bugs.python.org/issue?@action=redirect&bpo=40394]: Added default arguments to difflib.SequenceMatcher.find_longest_match().

bpo-39995 [https://bugs.python.org/issue?@action=redirect&bpo=39995]: 修复 concurrent.futures._ThreadWakeup 中的竞争条件：现在对 _ThreadWakeup 的访问受到关闭锁的保护。

bpo-30966 [https://bugs.python.org/issue?@action=redirect&bpo=30966]: concurrent.futures 的 Process.shutdown(wait=True) 现在显式关闭结果队列。

bpo-30966 [https://bugs.python.org/issue?@action=redirect&bpo=30966]: 为 SimpleQueue 类添加一个新的 close() 方法以显式关闭队列。

bpo-39966 [https://bugs.python.org/issue?@action=redirect&bpo=39966]: 撤销 bpo-25597 [https://bugs.python.org/issue?@action=redirect&bpo=25597]。设置了 wraps 的 unittest.mock.MagicMock 对魔术方法使用默认返回值。

bpo-39791 [https://bugs.python.org/issue?@action=redirect&bpo=39791]: 向 importlib.resources 添加了 files() 函数，支持包数据中的子目录，与 importlib_resources 1.5 中的回传匹配。

bpo-40375 [https://bugs.python.org/issue?@action=redirect&bpo=40375]: imaplib.IMAP4.unselect() is added. Patch by Dong-hee Na.

bpo-40389 [https://bugs.python.org/issue?@action=redirect&bpo=40389]: repr() 现在当被调用于 typing.Union 两个类型之一为 NoneType 时返回 typing.Optional[T]。

bpo-40291 [https://bugs.python.org/issue?@action=redirect&bpo=40291]: 添加对 CAN_J1939 套接字的支持（Linux 5.4+ 可用）

bpo-40273 [https://bugs.python.org/issue?@action=redirect&bpo=40273]: types.MappingProxyType 现在是可逆的。

bpo-39075 [https://bugs.python.org/issue?@action=redirect&bpo=39075]: types.SimpleNamespace 的 repr 现在是插入顺序而非字母顺序。

bpo-40192 [https://bugs.python.org/issue?@action=redirect&bpo=40192]: On AIX, thread_time() is now implemented with thread_cputime() which has nanosecond resolution, rather than clock_gettime(CLOCK_THREAD_CPUTIME_ID) which has a resolution of 10 ms. Patch by Batuhan Taskaya.

bpo-40025 [https://bugs.python.org/issue?@action=redirect&bpo=40025]: 当_generate_next_value_在成员之后定义时，抛出TypeError。由Ethan Onstott提供补丁。

bpo-39058 [https://bugs.python.org/issue?@action=redirect&bpo=39058]: 在argparse模块中，Namespace()和其他参数持有者的repr现在按照属性添加的顺序显示。以前，尽管模块的用户可见部分保留了参数顺序，但它是按字母顺序显示的。

bpo-24416 [https://bugs.python.org/issue?@action=redirect&bpo=24416]: datetime.date 和 datetime.datetime 的 isocalendar() 方法现在返回一个 named tuple 而不是 tuple。

文档

bpo-34790 [https://bugs.python.org/issue?@action=redirect&bpo=34790]: Add version of removal for explicit passing of coros to asyncio.wait()'s documentation

bpo-40561 [https://bugs.python.org/issue?@action=redirect&bpo=40561]: 为webbrowser的open函数提供文档字符串。

bpo-40499 [https://bugs.python.org/issue?@action=redirect&bpo=40499]: 提到 asyncio.wait() 需要一个非空的awaitables集合。

bpo-39705 [https://bugs.python.org/issue?@action=redirect&bpo=39705]: 在循环技术部分，为sorted()的教程示例提供了更好的解释。还包括一个新示例来解释sorted()的基本行为。

bpo-39435 [https://bugs.python.org/issue?@action=redirect&bpo=39435]: 修正了文档中 pickle.loads() 的错误签名。

测试

bpo-40055 [https://bugs.python.org/issue?@action=redirect&bpo=40055]: distutils.tests现在保存/恢复警告过滤器，使其保持不变。导入测试会导入docutils，后者导入pkg_resources，这会添加一个警告过滤器。

bpo-40436 [https://bugs.python.org/issue?@action=redirect&bpo=40436]: test_gdb和test.pythoninfo现在检查gdb命令的退出代码。

构建

bpo-40653 [https://bugs.python.org/issue?@action=redirect&bpo=40653]: 将_dirnameW移出HAVE_SYMLINK以修复潜在的编译问题。

bpo-40514 [https://bugs.python.org/issue?@action=redirect&bpo=40514]: 向 configure 添加 --with-experimental-isolated-subinterpreters 构建选项：更好地隔离子解释器，实验性构建模式。

Windows

bpo-40650 [https://bugs.python.org/issue?@action=redirect&bpo=40650]: 在pytime.c中包含winsock2.h以获取timeval。

bpo-40458 [https://bugs.python.org/issue?@action=redirect&bpo=40458]: 增加保留堆栈空间以防止Windows上的溢出崩溃。

bpo-39148 [https://bugs.python.org/issue?@action=redirect&bpo=39148]: 为ProactorEventLoop中的 asyncio 数据报端点添加IPv6支持。将未知地址族引发的异常更改为ValueError，因为它不是来自Windows API。

macOS

bpo-34956 [https://bugs.python.org/issue?@action=redirect&bpo=34956]: 当在macOS上从源代码构建Python时，_tkinter``现在链接到非系统的Tcl和Tk框架，如果它们安装在 ``/Library/Frameworks 中，就像旧版macOS上的情况一样。如果通过使用``--enable-universalsdk=``或 -isysroot 明确配置了macOS SDK，则仅搜索SDK本身。默认行为仍然可以通过 --with-tcltk-includes 和 --with-tcltk-libs 覆盖。

bpo-35569 [https://bugs.python.org/issue?@action=redirect&bpo=35569]: 公开RFC 3542 IPv6套接字选项。

工具/示例

bpo-40479 [https://bugs.python.org/issue?@action=redirect&bpo=40479]: 更新multissltest助手以测试最新的OpenSSL 1.0.2、1.1.0、1.1.1和3.0.0-alpha。

bpo-40431 [https://bugs.python.org/issue?@action=redirect&bpo=40431]: 修复 turtledemo 中的一个语法错误，现在会引发 SyntaxError。

bpo-40163 [https://bugs.python.org/issue?@action=redirect&bpo=40163]: 修复multissltest工具。OpenSSL已更改旧版本的下载URL。multissltest工具现在尝试从当前和旧的下载URL下载。

C API

bpo-39465 [https://bugs.python.org/issue?@action=redirect&bpo=39465]: 从C API中移除 _PyUnicode_ClearStaticStrings() 函数。

bpo-38787 [https://bugs.python.org/issue?@action=redirect&bpo=38787]: 添加PyCFunction_CheckExact()宏用于精确类型检查，现在我们允许PyCFunction的子类型，以及PyCMethod_CheckExact()和PyCMethod_Check()用于新的PyCMethod子类型。

bpo-40545 [https://bugs.python.org/issue?@action=redirect&bpo=40545]: 使用 PyAPI_FUNC() 声明 _PyErr_GetTopmostException() 以在C API中正确导出函数。该函数保持私有（``_Py``前缀）。

bpo-40412 [https://bugs.python.org/issue?@action=redirect&bpo=40412]: 在最终化期间将inittab_copy置空，防止在嵌入式情况下未来的解释器初始化崩溃。由Gregory Szorc提供补丁。

bpo-40429 [https://bugs.python.org/issue?@action=redirect&bpo=40429]: PyThreadState_GetFrame() 函数现在返回一个对帧的强引用。

bpo-40428 [https://bugs.python.org/issue?@action=redirect&bpo=40428]: 从C API中移除以下函数。显式调用 PyGC_Collect() 以释放所有自由列表。

PyAsyncGen_ClearFreeLists()

PyContext_ClearFreeList()

PyDict_ClearFreeList()

PyFloat_ClearFreeList()

PyFrame_ClearFreeList()

PyList_ClearFreeList()

PySet_ClearFreeList()

PyTuple_ClearFreeList()

bpo-40421 [https://bugs.python.org/issue?@action=redirect&bpo=40421]: 新增 PyFrame_GetBack() 函数：获取外层框架的下一个框架。

bpo-40421 [https://bugs.python.org/issue?@action=redirect&bpo=40421]: 新增 PyFrame_GetCode() 函数：返回框架代码的一个借用引用。

bpo-40217 [https://bugs.python.org/issue?@action=redirect&bpo=40217]: 确保使用 PyType_FromSpecWithBases() 创建的类型实例在垃圾收集器中遍历引用时会访问其类对象（作为提供的 tp_traverse 的扩展实现）。由 Pablo Galindo 提供补丁。

bpo-38787 [https://bugs.python.org/issue?@action=redirect&bpo=38787]: 现在可以从C定义的堆类型方法访问模块C状态（PEP 573 [https://www.python.org/dev/peps/pep-0573]）。由 Marcel Plch 和 Petr Viktorin 提供补丁。

Python 3.9.0 alpha 6

发布日期: 2020-04-27

安全性

bpo-40121 [https://bugs.python.org/issue?@action=redirect&bpo=40121]: 修复了在创建新套接字时引发的审计事件。

bpo-39073 [https://bugs.python.org/issue?@action=redirect&bpo=39073]: 禁止在 email.headerregistry.Address 参数中使用 CR 或 LF，以防止头部注入攻击。

bpo-39503 [https://bugs.python.org/issue?@action=redirect&bpo=39503]: CVE-2020-8492: The AbstractBasicAuthHandler class of the urllib.request module uses an inefficient regular expression which can be exploited by an attacker to cause a denial of service. Fix the regex to prevent the catastrophic backtracking. Vulnerability reported by Ben Caller and Matt Schwager.

核心与内置函数

bpo-40313 [https://bugs.python.org/issue?@action=redirect&bpo=40313]: 提高 bytes.hex() 的性能。

bpo-40334 [https://bugs.python.org/issue?@action=redirect&bpo=40334]: 切换到基于 PEG 的新解析器。更多详情见 PEP 617。要暂时切换回旧解析器，使用 -X oldparser 或 PYTHONOLDPARSER=1。在 Python 3.10 中，我们将完全移除旧解析器，包括 parser 模块（已弃用）以及依赖于它的任何内容。

bpo-40267 [https://bugs.python.org/issue?@action=redirect&bpo=40267]: Fix the tokenizer to display the correct error message, when there is a SyntaxError on the last input character and no newline follows. It used to be unexpected EOF while parsing, while it should be invalid syntax.

bpo-39522 [https://bugs.python.org/issue?@action=redirect&bpo=39522]: 当激活注释的延迟评估时，正确反解析字符串的显式 u 前缀。由 Batuhan Taskaya 提供补丁。

bpo-40246 [https://bugs.python.org/issue?@action=redirect&bpo=40246]: Report a specialized error message, invalid string prefix, when the tokenizer encounters a string with an invalid prefix.

bpo-40082 [https://bugs.python.org/issue?@action=redirect&bpo=40082]: 修复信号处理程序：现在总是使用主解释器，而不是尝试获取当前的Python线程状态。

bpo-37388 [https://bugs.python.org/issue?@action=redirect&bpo=37388]: str.encode()和str.decode()在开发模式或Python终止期间的调试模式下不再检查编码和错误。编解码器机制在非常晚调用str.encode()和str.decode()时不再工作。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: Fix possible refleaks in _json, memo of PyScannerObject should be traversed.

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: 通过使用 PEP 590 [https://www.python.org/dev/peps/pep-0590] 的“vectorcall”调用约定，加速对“dict()”的调用。

bpo-40141 [https://bugs.python.org/issue?@action=redirect&bpo=40141]: 向“ast.keyword”节点添加列和行信息。由Pablo Galindo提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 resource 移植到多阶段初始化(PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 math 移植到多阶段初始化(PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将_uuid模块移植到多阶段初始化(PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-40077 [https://bugs.python.org/issue?@action=redirect&bpo=40077]: 将json模块转换为使用 PyType_FromSpec()。

bpo-40067 [https://bugs.python.org/issue?@action=redirect&bpo=40067]: 改进赋值中多个星号表达式的错误消息。由Furkan Onder提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将_functools模块移植到多阶段初始化(PEP 489)。由Paulo Henrique Silva提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将operator模块移植到多阶段初始化(PEP 489)。由Paulo Henrique Silva提供补丁。

bpo-20526 [https://bugs.python.org/issue?@action=redirect&bpo=20526]: 修复 PyThreadState_Clear()。“PyThreadState.frame”是一个借用引用，不是强引用：“PyThreadState_Clear()”不能调用“Py_CLEAR(tstate->frame)”。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将time模块移植到多阶段初始化(PEP 489 [https://www.python.org/dev/peps/pep-0489])。由Paulo Henrique Silva提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将_weakref扩展模块移植到多阶段初始化(PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-40020 [https://bugs.python.org/issue?@action=redirect&bpo=40020]: 修复parsetok.c中由于在罕见代码路径上错误使用realloc导致的泄漏和随后的崩溃。

bpo-39939 [https://bugs.python.org/issue?@action=redirect&bpo=39939]: 添加了str.removeprefix和str.removesuffix方法以及相应的bytes、bytearray和collections.UserString方法，用于移除字符串中可能存在的前缀和后缀。完整描述请参见 PEP 616 [https://www.python.org/dev/peps/pep-0616]。由Dennis Sweeney提供补丁。

bpo-39481 [https://bugs.python.org/issue?@action=redirect&bpo=39481]: 实现了PEP 585。这支持了list[int]、tuple[str, ...]等类型注解。

bpo-32894 [https://bugs.python.org/issue?@action=redirect&bpo=32894]: 支持在延迟注解中解析无穷大数。由Batuhan Taşkaya提供补丁。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: 通过使用 PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall 调用约定，加快了对 list() 的调用速度。由Mark Shannon提供补丁。

库

bpo-40398 [https://bugs.python.org/issue?@action=redirect&bpo=40398]: typing.get_args() 现在对于特殊的通用别名总是返回一个空元组。

bpo-40396 [https://bugs.python.org/issue?@action=redirect&bpo=40396]: 函数 typing.get_origin()、typing.get_args() 和 typing.get_type_hints() 现在支持如 list[int] 这样的通用别名。

bpo-38061 [https://bugs.python.org/issue?@action=redirect&bpo=38061]: 在FreeBSD上使用 closefrom() 优化了 subprocess 模块。单个 close(fd) 系统调用是廉价的，但当 sysconf(_SC_OPEN_MAX) 很高时，循环调用 close(fd) 在每个文件描述符上可能会花费几毫秒。

在FreeBSD上提高性能的解决方法是加载并挂载fdescfs内核模块，但默认情况下未启用此功能。

初始由Ed Maste (emaste)、Conrad Meyer (cem)、Kyle Evans (kevans) 和 Kubilay Kocak (koobs) 提供补丁：https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=242274

bpo-38061 [https://bugs.python.org/issue?@action=redirect&bpo=38061]: 在FreeBSD上，os.closerange(fd_low, fd_high) 现在如果 fd_high 大于或等于 sysconf(_SC_OPEN_MAX) 则调用 closefrom(fd_low)。

初始由Ed Maste (emaste)、Conrad Meyer (cem)、Kyle Evans (kevans) 和 Kubilay Kocak (koobs) 提供补丁：https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=242274

bpo-40360 [https://bugs.python.org/issue?@action=redirect&bpo=40360]: The lib2to3 module is pending deprecation due to PEP 617 [https://www.python.org/dev/peps/pep-0617].

bpo-40138 [https://bugs.python.org/issue?@action=redirect&bpo=40138]: 修复了 os.waitpid() 在Windows上对于退出码大于 INT_MAX >> 8 的实现。退出状态现在被解释为一个无符号数。

bpo-39942 [https://bugs.python.org/issue?@action=redirect&bpo=39942]: 当 typing.TypeVar 中缺少 "__name__" 时，将 "__main__" 设置为默认模块名。由Weipeng Hong提供补丁。

bpo-40275 [https://bugs.python.org/issue?@action=redirect&bpo=40275]: 现在，logging 包在 unittest 中仅当使用 assertLogs() 断言时才会被延迟导入。

bpo-40275 [https://bugs.python.org/issue?@action=redirect&bpo=40275]: 现在，asyncio 包在 unittest 中仅当使用 IsolatedAsyncioTestCase 类时才会被延迟导入。

bpo-40330 [https://bugs.python.org/issue?@action=redirect&bpo=40330]: 在 ShareableList.__setitem__() 中，检查新字符串项的大小是在将其编码为 utf-8 之后，而不是之前。

bpo-40148 [https://bugs.python.org/issue?@action=redirect&bpo=40148]: Added pathlib.Path.with_stem() to create a new Path with the stem replaced.

bpo-40325 [https://bugs.python.org/issue?@action=redirect&bpo=40325]: 弃用了在 random.sample() 中对集合对象的支持。

bpo-40257 [https://bugs.python.org/issue?@action=redirect&bpo=40257]: 改进了 typing 模块的帮助信息。现在所有特殊形式和特殊泛型别名（如 Union 和 List）的文档字符串都会被显示。使用 help() 查看像 List[int] 这样的泛型别名时，会显示相应具体类型（在这个例子中是 list）的帮助信息。

bpo-40257 [https://bugs.python.org/issue?@action=redirect&bpo=40257]: func:inspect.getdoc no longer returns docstring inherited from the type of the object or from parent class if it is a class if it is not defined in the object itself. In pydoc the documentation string is now shown not only for class, function, method etc, but for any object that has its own __doc__ attribute.

bpo-40287 [https://bugs.python.org/issue?@action=redirect&bpo=40287]: 修复了 SpooledTemporaryFile.seek() 返回位置的问题。

bpo-40290 [https://bugs.python.org/issue?@action=redirect&bpo=40290]: 在 statistics.NormalDist() 中添加了 zscore() 方法。

bpo-40282 [https://bugs.python.org/issue?@action=redirect&bpo=40282]: 允许 random.getrandbits(0) 成功执行并返回 0。

bpo-40286 [https://bugs.python.org/issue?@action=redirect&bpo=40286]: 新增了 random.randbytes() 函数和 random.Random.randbytes() 方法来生成随机字节。

bpo-40277 [https://bugs.python.org/issue?@action=redirect&bpo=40277]: collections.namedtuple() 现在为其字段访问器提供了一个人类可读的 repr。

bpo-40270 [https://bugs.python.org/issue?@action=redirect&bpo=40270]: 现在 Windows 上包含的 sqlite3 编译时带有 json 扩展。这使得可以使用诸如 json_object 这样的函数。

bpo-29255 [https://bugs.python.org/issue?@action=redirect&bpo=29255]: Wait in KqueueSelector.select when no fds are registered

bpo-40260 [https://bugs.python.org/issue?@action=redirect&bpo=40260]: 确保 modulefinder 使用 io.open_code() 并遵守编码注释。

bpo-40234 [https://bugs.python.org/issue?@action=redirect&bpo=40234]: 再次允许在子解释器中生成守护线程（撤销之前禁止它们的更改）。

bpo-39207 [https://bugs.python.org/issue?@action=redirect&bpo=39207]: 现在 ProcessPoolExecutor 中的工作器是按需生成的，只有在没有可用的空闲工作器可以重用时才会生成。这优化了启动开销并减少了因空闲工作器而损失的CPU时间。由Kyle Stanley提供补丁。

bpo-40091 [https://bugs.python.org/issue?@action=redirect&bpo=40091]: 修复了日志模块中的fork挂起问题：现在使用新的私有方法 _at_fork_reinit() 在子进程中fork时重新初始化锁。

bpo-40149 [https://bugs.python.org/issue?@action=redirect&bpo=40149]: 在 _abc._abc_data 类型中实现了遍历和清除槽。

bpo-40208 [https://bugs.python.org/issue?@action=redirect&bpo=40208]: Remove deprecated symtable.SymbolTable.has_exec().

bpo-40196 [https://bugs.python.org/issue?@action=redirect&bpo=40196]: 修复了 symtable 模块中的一个错误，该错误导致错误地将全局变量报告为局部变量。由Pablo Galindo提供补丁。

bpo-40190 [https://bugs.python.org/issue?@action=redirect&bpo=40190]: 向 posix.sysconf() 添加了对 _SC_AIX_REALMEM 的支持。

bpo-40182 [https://bugs.python.org/issue?@action=redirect&bpo=40182]: 移除了 typing.NamedTuple 类的 _field_types 属性。

bpo-36517 [https://bugs.python.org/issue?@action=redirect&bpo=36517]: 现在使用 typing.NamedTuple 进行多重继承时会引发错误，而不是静默忽略其他类型。

bpo-40126 [https://bugs.python.org/issue?@action=redirect&bpo=40126]: 修复了在unittest.mock中还原多个补丁的问题。如果补丁的 __enter__() 失败，其 __exit__() 现在永远不会被调用。现在从 __exit__() 返回true会静默异常。

bpo-40094 [https://bugs.python.org/issue?@action=redirect&bpo=40094]: http.server的CGIHTTPRequestHandler现在记录CGI脚本的退出代码，而不是os.waitpid()的CGI脚本退出状态。例如，如果脚本被信号11杀死，现在会记录：“CGI脚本退出代码 -11。”

bpo-40108 [https://bugs.python.org/issue?@action=redirect&bpo=40108]: Improve the error message when triying to import a module using runpy and incorrently use the ".py" extension at the end of the module name. Patch by Pablo Galindo.

bpo-40094 [https://bugs.python.org/issue?@action=redirect&bpo=40094]: 添加了 os.waitstatus_to_exitcode() 函数：将等待状态转换为退出代码。

bpo-40089 [https://bugs.python.org/issue?@action=redirect&bpo=40089]: 修复 threading._after_fork(): 如果 fork 不是由 threading.Thread 生成的线程调用的，threading._after_fork() 现在会为 _main_thread 创建一个 _MainThread 实例，而不是 _DummyThread 实例。

bpo-40089 [https://bugs.python.org/issue?@action=redirect&bpo=40089]: Add a private _at_fork_reinit() method to _thread.Lock, _thread.RLock, threading.RLock and threading.Condition classes: reinitialize the lock at fork in the child process, reset the lock to the unlocked state. Rename also the private _reset_internal_locks() method of threading.Event to _at_fork_reinit().

bpo-25780 [https://bugs.python.org/issue?@action=redirect&bpo=25780]: Expose CAN_RAW_JOIN_FILTERS in the socket module.

bpo-39503 [https://bugs.python.org/issue?@action=redirect&bpo=39503]: urllib.request 的 AbstractBasicAuthHandler 现在解析所有 WWW-Authenticate HTTP 头部，并接受每个头部多个挑战：使用第一个 Basic 挑战的领域。

bpo-39812 [https://bugs.python.org/issue?@action=redirect&bpo=39812]: Removed daemon threads from concurrent.futures by adding an internal threading._register_atexit(), which calls registered functions prior to joining all non-daemon threads. This allows for compatibility with subinterpreters, which don't support daemon threads.

bpo-40050 [https://bugs.python.org/issue?@action=redirect&bpo=40050]: 修复 importlib._bootstrap_external: 如果 winreg 内置模块已经在 sys.modules 中可用，避免创建新的 winreg 内置模块，并移除冗余导入。

bpo-40014 [https://bugs.python.org/issue?@action=redirect&bpo=40014]: 修复 os.getgrouplist(): 如果 getgrouplist() 函数因为组列表太小而失败，尝试使用更大的组列表。在失败时，glibc 实现的 getgrouplist() 将 ngroups 设置为组的总数。对于其他实现，将组列表大小加倍。

bpo-40017 [https://bugs.python.org/issue?@action=redirect&bpo=40017]: Add time.CLOCK_TAI constant if the operating system support it.

bpo-40016 [https://bugs.python.org/issue?@action=redirect&bpo=40016]: 在 re 文档字符串中，阐明内联和参数编译标志之间的关系。

bpo-39953 [https://bugs.python.org/issue?@action=redirect&bpo=39953]: 更新 ssl 模块中 OpenSSL 错误代码的内部表。

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: 在 weakref.WeakValueDictionary 中添加了 PEP 584 [https://www.python.org/dev/peps/pep-0584] 运算符。

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: 在 weakref.WeakKeyDictionary 中添加了 PEP 584 [https://www.python.org/dev/peps/pep-0584] 运算符。

bpo-38891 [https://bugs.python.org/issue?@action=redirect&bpo=38891]: Fix linear runtime behaviour of the __getitem__ and __setitem__ methods in multiprocessing.shared_memory.ShareableList. This avoids quadratic performance when iterating a ShareableList. Patch by Thomas Krennwallner.

bpo-39682 [https://bugs.python.org/issue?@action=redirect&bpo=39682]: Remove undocumented support for closing a pathlib.Path object via its context manager. The context manager magic methods remain, but they are now a no-op, making Path objects immutable.

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: 在 collections.ChainMap 中添加了 PEP 584 [https://www.python.org/dev/peps/pep-0584] 运算符（| 和 |=）。

bpo-39011 [https://bugs.python.org/issue?@action=redirect&bpo=39011]: 移除了 ElementTree 属性中的行尾规范化，因为被实体编号替换的行尾应保留其原始形式。

bpo-38410 [https://bugs.python.org/issue?@action=redirect&bpo=38410]: 在 sys.set_asyncgen_hooks() 中正确处理 sys.audit() 失败。

bpo-36541 [https://bugs.python.org/issue?@action=redirect&bpo=36541]: lib2to3 现在可以识别命名赋值表达式（海象运算符，:=）。

bpo-35967 [https://bugs.python.org/issue?@action=redirect&bpo=35967]: 在平台中，延迟调用 'uname -p' 直到请求处理器属性。

bpo-35113 [https://bugs.python.org/issue?@action=redirect&bpo=35113]: inspect.getsource() 现在为与模块级别类同名的内部类返回正确的源代码。装饰器也作为类源代码的一部分返回。由 Karthikeyan Singaravelan 提供补丁。

bpo-33262 [https://bugs.python.org/issue?@action=redirect&bpo=33262]: Deprecate passing None as an argument for shlex.split()'s s parameter. Patch by Zackery Spytz.

bpo-31758 [https://bugs.python.org/issue?@action=redirect&bpo=31758]: 防止使用未初始化的 _elementtree.XMLParser 对象时崩溃。由 Oren Milman 提供补丁。

文档

bpo-27635 [https://bugs.python.org/issue?@action=redirect&bpo=27635]: pickle 文档错误地声称在反序列化时默认不调用 __new__。

bpo-39879 [https://bugs.python.org/issue?@action=redirect&bpo=39879]: 更新了 数据模型 文档，包括 dict() 插入顺序的保留。由 Furkan Onder 和 Samy Lahfa 提供补丁。

bpo-38387 [https://bugs.python.org/issue?@action=redirect&bpo=38387]: 在 C-API 参考中记录了 PyDoc_STRVAR 宏。

bpo-13743 [https://bugs.python.org/issue?@action=redirect&bpo=13743]: xml.dom.minidom.Element 类中的一些方法现在有了更好的文档记录。

测试

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在 test_c_locale_coercion.py 中为 VxWorks RTOS 设置预期的默认编码。

bpo-40162 [https://bugs.python.org/issue?@action=redirect&bpo=40162]: 更新 Travis CI 配置至 OpenSSL 1.1.1f。

bpo-40146 [https://bugs.python.org/issue?@action=redirect&bpo=40146]: 在 Azure Pipelines 中更新 OpenSSL 至 1.1.1f。

bpo-40094 [https://bugs.python.org/issue?@action=redirect&bpo=40094]: 添加 test.support.wait_process() 函数。

bpo-40003 [https://bugs.python.org/issue?@action=redirect&bpo=40003]: test.bisect_cmd 现在会复制 Python 命令行选项如 -O 或 -W。此外，如果 test.bisect_cmd 与 -w/--verbose2 选项一起使用，会发出警告。

bpo-39380 [https://bugs.python.org/issue?@action=redirect&bpo=39380]: 将编码作为仅关键字参数添加至 ftplib.FTP 和 ftplib.FTP_TLS 的构造函数中，并将默认编码从 latin-1 更改为 utf-8 以遵循 RFC 2640 [https://datatracker.ietf.org/doc/html/rfc2640.html]。

bpo-39793 [https://bugs.python.org/issue?@action=redirect&bpo=39793]: 在测试 make_msgid 时使用相同的域。由 Batuhan Taskaya 提供补丁。

bpo-1812 [https://bugs.python.org/issue?@action=redirect&bpo=1812]: 修复了在从具有 get_data 方法的包加载时，doctest.testfile 中的新行处理。由 Peter Donis 提供补丁。

构建

bpo-38360 [https://bugs.python.org/issue?@action=redirect&bpo=38360]: 支持 macOS -isysroot 标志的单参数形式。

bpo-40158 [https://bugs.python.org/issue?@action=redirect&bpo=40158]: 修复 NuGet 包中的 CPython MSBuild 属性（build/native/python.props）。

bpo-38527 [https://bugs.python.org/issue?@action=redirect&bpo=38527]: 修复 Solaris 上对“浮点字序”的配置检查：有时未使用正确的“grep”命令。由 Arnon Yaari 提供补丁。

Windows

bpo-40164 [https://bugs.python.org/issue?@action=redirect&bpo=40164]: 将 Windows 更新至 OpenSSL 1.1.1f。

bpo-8901 [https://bugs.python.org/issue?@action=redirect&bpo=8901]: 当使用 -E 选项时，忽略 Windows 注册表。

macOS

bpo-38329 [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 更加容易。

bpo-40164 [https://bugs.python.org/issue?@action=redirect&bpo=40164]: 更新 macOS 安装程序构建以使用 OpenSSL 1.1.1g。

IDLE

bpo-38439 [https://bugs.python.org/issue?@action=redirect&bpo=38439]: 添加一个 256×256 像素的 IDLE 图标以支持更多现代环境。由 Andrew Clover 创建。删除未使用的 macOS idle.icns 图标文件。

bpo-38689 [https://bugs.python.org/issue?@action=redirect&bpo=38689]: 当获取调用提示时inspect.signature失败时，IDLE将不再冻结。

工具/示例

bpo-40385 [https://bugs.python.org/issue?@action=redirect&bpo=40385]: 移除了checkpyc.py工具。请考虑使用不带force模式的compileall作为潜在替代方案。

bpo-40179 [https://bugs.python.org/issue?@action=redirect&bpo=40179]: 修复了Argument Clinic中 #elif 的翻译问题。

bpo-40094 [https://bugs.python.org/issue?@action=redirect&bpo=40094]: 修复了 which.py 脚本的退出码：现在使用 os.waitstatus_to_exitcode() 将 os.system() 的退出状态转换为退出码。

C API

bpo-40241 [https://bugs.python.org/issue?@action=redirect&bpo=40241]: Move the PyGC_Head structure to the internal C API.

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: 将 PyObject_IS_GC() 宏转换为函数以隐藏实现细节。

bpo-40241 [https://bugs.python.org/issue?@action=redirect&bpo=40241]: 向公共API添加函数 PyObject_GC_IsTracked() 和 PyObject_GC_IsFinalized()，以分别查询Python对象是否正在被跟踪或已经被垃圾收集器终结。由Pablo Galindo提供补丁。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: The PyObject_NEW() macro becomes an alias to the PyObject_New() macro, and the PyObject_NEW_VAR() macro becomes an alias to the PyObject_NewVar() macro, to hide implementation details. They no longer access directly the PyTypeObject.tp_basicsize member.

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: PyType_HasFeature() 现在总是调用 PyType_GetFlags() 以隐藏实现细节。以前，当不使用有限C API时，它直接访问 PyTypeObject.tp_flags 成员。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: Convert the PyObject_GET_WEAKREFS_LISTPTR() macro to a function to hide implementation details: the macro accessed directly to the PyTypeObject.tp_weaklistoffset member.

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: 将 PyObject_CheckBuffer() 宏转换为函数以隐藏实现细节：该宏直接访问 PyTypeObject.tp_as_buffer 成员。

bpo-40170 [https://bugs.python.org/issue?@action=redirect&bpo=40170]: 始终将 PyIndex_Check() 声明为不透明函数以隐藏实现细节：移除 PyIndex_Check() 宏。该宏直接访问了 PyTypeObject.tp_as_number 成员。

bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947]: 添加 PyThreadState_GetID() 函数：获取 Python 线程状态的唯一标识符。

Python 3.9.0 alpha 5

发布日期: 2020-03-23

安全性

bpo-38576 [https://bugs.python.org/issue?@action=redirect&bpo=38576]: Disallow control characters in hostnames in http.client, addressing CVE-2019-18348. Such potentially malicious header injection URLs now cause a InvalidURL to be raised.

核心与内置函数

bpo-40010 [https://bugs.python.org/issue?@action=redirect&bpo=40010]: 优化多线程应用中的待处理调用。如果非主线程调度了一个待处理调用（Py_AddPendingCall()），字节码评估循环不再在每条字节码指令处中断以检查无法执行的待处理调用。只有主线程可以执行待处理调用。

此前，字节码评估循环在每条指令处中断，直到主线程执行待处理调用。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将_weakref扩展模块移植到多阶段初始化(PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _collections 模块移植到多阶段初始化（PEP 489 [https://www.python.org/dev/peps/pep-0489]）。

bpo-40010 [https://bugs.python.org/issue?@action=redirect&bpo=40010]: 优化多线程应用中的信号处理。如果非主线程接收到信号，字节码评估循环不再在每条字节码指令处中断以检查无法处理的待处理信号。只有主解释器的主线程可以处理信号。

此前，字节码评估循环在每条指令处中断，直到主线程处理信号。

bpo-39984 [https://bugs.python.org/issue?@action=redirect&bpo=39984]: 如果在子解释器中调用 Py_AddPendingCall()，现在该函数将被安排从子解释器调用，而不是从主解释器调用。每个子解释器现在都有自己预定的调用列表。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _heapq 模块移植到多阶段初始化。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 itertools 模块移植到多阶段初始化（PEP 489 [https://www.python.org/dev/peps/pep-0489]）。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: Speed up calls to frozenset() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-39984 [https://bugs.python.org/issue?@action=redirect&bpo=39984]: 子解释器：将 _PyRuntimeState.ceval.tracing_possible 移动到 PyInterpreterState.ceval.tracing_possible：每个解释器现在拥有自己的变量。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: Speed up calls to set() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _statistics 模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-39968 [https://bugs.python.org/issue?@action=redirect&bpo=39968]: 使用内联函数替换扩展模块的 get_module_state 宏。

bpo-39965 [https://bugs.python.org/issue?@action=redirect&bpo=39965]: 如果在非异步函数内部使用 await 并且设置了 PyCF_ALLOW_TOP_LEVEL_AWAIT``（如在 asyncio REPL 中），则正确引发 ``SyntaxError。由 Pablo Galindo 提供补丁。

bpo-39562 [https://bugs.python.org/issue?@action=redirect&bpo=39562]: 当给定 PyCF_ALLOW_TOP_LEVEL_AWAIT 标志时，允许在顶层执行异步推导式。补丁由 Batuhan Taskaya 提供。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: Speed up calls to tuple() by using the PEP 590 [https://www.python.org/dev/peps/pep-0590] vectorcall calling convention. Patch by Dong-hee Na.

bpo-38373 [https://bugs.python.org/issue?@action=redirect&bpo=38373]: 更改了列表的超额分配策略。如果新大小更接近超额分配的大小而不是旧大小，并且添加了填充，则不再进行超额分配。

bpo-39926 [https://bugs.python.org/issue?@action=redirect&bpo=39926]: 将 Unicode 数据库更新到 Unicode 版本 13.0.0。

bpo-19466 [https://bugs.python.org/issue?@action=redirect&bpo=19466]: 在 Python 关闭期间更早地清除守护线程的帧以调用对象析构函数。因此，现在可以更可靠地为守护线程发出“未关闭文件”资源警告。

bpo-38894 [https://bugs.python.org/issue?@action=redirect&bpo=38894]: 修复了一个错误，该错误在存在指向用户没有读取权限的文件的符号链接时，调用 pathlib.Path.glob 会导致结果不完整。由 Pablo Galindo 和 Matt Wozniski 提供补丁。

bpo-39877 [https://bugs.python.org/issue?@action=redirect&bpo=39877]: 修复 PyEval_RestoreThread() 在退出时由于守护线程导致的随机崩溃问题。现在直接访问 _PyRuntime 变量，而不是使用 tstate->interp->runtime，因为在调用 Py_Finalize() 后 tstate 可能成为悬垂指针。此外，守护线程现在在尝试获取 GIL 之前退出。

bpo-39871 [https://bugs.python.org/issue?@action=redirect&bpo=39871]: 修复 math.{atan2,copysign,remainder}() 中当第一个参数无法转换为 float 时可能出现的 SystemError。由 Zackery Spytz 提供补丁。

bpo-39776 [https://bugs.python.org/issue?@action=redirect&bpo=39776]: 修复由 PyGILState_Ensure() 创建的线程可能获得重复 ID 的竞态条件。

这影响了像 contextvar 缓存机制这样的 tstate->id 的消费者，在高线程负载下（在嵌入场景中观察到）可能返回无效的缓存对象。

bpo-39778 [https://bugs.python.org/issue?@action=redirect&bpo=39778]: 修复了由于 collections.OrderedDict 类中弱引用处理不当导致的崩溃。补丁由 Pablo Galindo 提供。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 audioop 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-39702 [https://bugs.python.org/issue?@action=redirect&bpo=39702]: 放宽 decorator 语法限制，允许任何有效的表达式 (PEP 614 [https://www.python.org/dev/peps/pep-0614])。

bpo-38091 [https://bugs.python.org/issue?@action=redirect&bpo=38091]: 调整导入死锁检测代码以避免自身死锁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _locale 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-39087 [https://bugs.python.org/issue?@action=redirect&bpo=39087]: 在需要创建内部 UTF-8 缓存时，轻微优化 PyUnicode_AsUTF8() 和 PyUnicode_AsUTF8AndSize()。

bpo-39520 [https://bugs.python.org/issue?@action=redirect&bpo=39520]: 修复无项的外部切片（foo[:,]）的反解析问题。补丁由 Batuhan Taskaya 提供。

bpo-39220 [https://bugs.python.org/issue?@action=redirect&bpo=39220]: 如果使用了 'from __future__ import annotations'，则不优化注释。由 Pablo Galindo 提供补丁。

bpo-35712 [https://bugs.python.org/issue?@action=redirect&bpo=35712]: 在布尔上下文中使用 NotImplemented 已被弃用。补丁由 Josh Rosenberg 贡献。

bpo-22490 [https://bugs.python.org/issue?@action=redirect&bpo=22490]: 在 macOS 上，不将环境变量 __PYVENV_LAUNCHER__ 泄漏到解释器会话中。

库

bpo-39830 [https://bugs.python.org/issue?@action=redirect&bpo=39830]: 在 zipfile 模块的 __all__ 中添加 zipfile.Path。

bpo-40000 [https://bugs.python.org/issue?@action=redirect&bpo=40000]: 改进了对 ast.Constant 节点验证的错误消息。由 Batuhan Taskaya 提供补丁。

bpo-39999 [https://bugs.python.org/issue?@action=redirect&bpo=39999]: AST 节点类的 __module__ 现在设置为 "ast" 而不是 "_ast"。为虚拟 AST 节点类和弃用的属性添加了文档字符串。

bpo-39991 [https://bugs.python.org/issue?@action=redirect&bpo=39991]: uuid.getnode() 现在跳过与 MAC 地址相同字符串长度（17个字符）的 IPv6 地址：仅使用 MAC 地址。

bpo-39988 [https://bugs.python.org/issue?@action=redirect&bpo=39988]: 弃用了 ast.AugLoad 和 ast.AugStore 节点类，因为它们不再被使用。

bpo-39656 [https://bugs.python.org/issue?@action=redirect&bpo=39656]: 确保在 POSIX 平台的虚拟环境中始终存在 bin/python3.# - 由 Anthony Sottile 提供。

bpo-39969 [https://bugs.python.org/issue?@action=redirect&bpo=39969]: 弃用了 ast.Param 节点类，因为它不再被使用。由 Batuhan Taskaya 提供补丁。

bpo-39360 [https://bugs.python.org/issue?@action=redirect&bpo=39360]: 确保所有工作线程在通过多处理模块的最终化处理程序隐式完成 multiprocessing.Pool 时退出。这修复了当 Pool 没有通过上下文管理器或调用 multiprocessing.Pool.terminate 正确完成时可能遇到的死锁情况。由 Batuhan Taskaya 和 Pablo Galindo 提供补丁。

bpo-35370 [https://bugs.python.org/issue?@action=redirect&bpo=35370]: sys.settrace()、sys.setprofile() 和 _lsprof.Profiler.enable() 现在如果 "sys.setprofile" 或 "sys.settrace" 审计事件被拒绝，会正确报告 PySys_Audit() 错误。

bpo-39936 [https://bugs.python.org/issue?@action=redirect&bpo=39936]: AIX：在从头构建 Python 时，修复了当子进程不可用时的 _aix_support 模块。现在它使用新的私有 _bootsubprocess 模块，而不是根据子进程是否可用有两个实现。因此，_aix_support.aix_platform() 的结果现在在子进程是否可用时是相同的。

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: collections.OrderedDict 现在实现了 | 和 |= (PEP 584 [https://www.python.org/dev/peps/pep-0584])。

bpo-39652 [https://bugs.python.org/issue?@action=redirect&bpo=39652]: 在 sqlite3.Cursor.description 中找到的列名现在仅在设置了 PARSE_COLNAMES 选项时在第一个 '[' 处截断。

bpo-39915 [https://bugs.python.org/issue?@action=redirect&bpo=39915]: 确保 unittest.mock.AsyncMock.await_args_list 中的调用对象按照等待参数的顺序排列，而不是使用 unittest.mock.Mock.call_args，后者具有调用的最后一个值。由 Karthikeyan Singaravelan 提供补丁。

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: 更新了 os.environ 和 os.environb 以支持 PEP 584 [https://www.python.org/dev/peps/pep-0584] 的合并（|）和更新（|=）操作符。

bpo-38662 [https://bugs.python.org/issue?@action=redirect&bpo=38662]: ensurepip 模块现在通过 runpy 模块调用 pip。因此，它不再与捆绑的 pip 版本的内部 API 紧密耦合，使得内部和分发者都更容易更新到新版本的 pip。

bpo-38075 [https://bugs.python.org/issue?@action=redirect&bpo=38075]: 修复了当 bool 作为种子传递时 random.Random.seed() 方法的问题。

bpo-39916 [https://bugs.python.org/issue?@action=redirect&bpo=39916]: 在 Path.glob() 中更可靠地使用 os.scandir()。当被中断时，它不再发出 ResourceWarning。

bpo-39850 [https://bugs.python.org/issue?@action=redirect&bpo=39850]: multiprocessing 现在支持抽象套接字地址（如果运行的平台支持抽象套接字）。在创建任意地址时（如默认构造 multiprocessing.connection.Listener 对象时），优先选择抽象套接字以避免临时文件生成的地址对于 AF_UNIX 套接字地址来说过大的情况。由 Pablo Galindo 提供补丁。

bpo-36287 [https://bugs.python.org/issue?@action=redirect&bpo=36287]: ast.dump() no longer outputs optional fields and attributes with default values. The default values for optional fields and attributes of AST nodes are now set as class attributes (e.g. Constant.kind is set to None).

bpo-39889 [https://bugs.python.org/issue?@action=redirect&bpo=39889]: 修复了 ast.unparse() 对于包含单个元素的扩展切片（例如 a[i:j,]）的问题。当使用元组索引时（例如 a[i, j]），移除冗余的元组。

bpo-39828 [https://bugs.python.org/issue?@action=redirect&bpo=39828]: Fix json.tool to catch BrokenPipeError. Patch by Dong-hee Na.

bpo-13487 [https://bugs.python.org/issue?@action=redirect&bpo=13487]: Avoid a possible "RuntimeError: dictionary changed size during iteration" from inspect.getmodule() when it tried to loop through sys.modules.

bpo-39674 [https://bugs.python.org/issue?@action=redirect&bpo=39674]: 恢复 "bpo-37330 [https://bugs.python.org/issue?@action=redirect&bpo=37330]: open() 不再接受文件模式中的 'U'"。为了便于从 Python 2.7 过渡，Python 3.9 中保留了 open() 的 "U" 模式，但将在 Python 3.10 中移除。

bpo-28577 [https://bugs.python.org/issue?@action=redirect&bpo=28577]: 32位前缀长度的 IPv4Networks 和 128位前缀的 IPv6Networks 的 hosts 方法现在返回包含单个 Address 的列表，而不是空列表。

bpo-39826 [https://bugs.python.org/issue?@action=redirect&bpo=39826]: 向 logging HTTPHandler 添加 getConnection 方法，以启用自定义连接。

bpo-39763 [https://bugs.python.org/issue?@action=redirect&bpo=39763]: Reimplement distutils.spawn.spawn() function with the subprocess module.

bpo-39794 [https://bugs.python.org/issue?@action=redirect&bpo=39794]: 添加 --without-decimal-contextvar 构建选项。这启用了线程本地而非协程本地的上下文。

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: collections.defaultdict 现在实现了 | 操作符 (PEP 584 [https://www.python.org/dev/peps/pep-0584])。

bpo-39517 [https://bugs.python.org/issue?@action=redirect&bpo=39517]: 修复 runpy.run_path() 在使用路径类对象时的问题。

bpo-39775 [https://bugs.python.org/issue?@action=redirect&bpo=39775]: 将 inspect.Signature.parameters 改回 collections.OrderedDict。在 Python 3.9.0a4 中，这被改为 dict。

bpo-39678 [https://bugs.python.org/issue?@action=redirect&bpo=39678]: 重构 concurrent.futures.ProcessPoolExecutor 中的 queue_manager，使其更易于维护。

bpo-39764 [https://bugs.python.org/issue?@action=redirect&bpo=39764]: 修复在 PyAsyncGenObject Task 上调用 get_stack 时的 AttributeError。

bpo-39769 [https://bugs.python.org/issue?@action=redirect&bpo=39769]: The compileall.compile_dir() function's ddir parameter and the compileall command line flag -d no longer write the wrong pathname to the generated pyc file for submodules beneath the root of the directory tree being compiled. This fixes a regression introduced with Python 3.5.

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: types.MappingProxyType 对象现在支持来自 PEP 584 [https://www.python.org/dev/peps/pep-0584] 的合并 (|) 操作符。

bpo-38691 [https://bugs.python.org/issue?@action=redirect&bpo=38691]: 当使用 -E 或 -I 命令行选项时，importlib 模块现在忽略 PYTHONCASEOK 环境变量。

bpo-39719 [https://bugs.python.org/issue?@action=redirect&bpo=39719]: 移除 tempfile.SpooledTemporaryFile.softspace()，因为文件在 Python 3 中不再有 softspace 属性。由 Shantanu 提供补丁。

bpo-39667 [https://bugs.python.org/issue?@action=redirect&bpo=39667]: 提升zipfile.Path与pathlib.Path的兼容性，并修复zipp 3.0中发现的性能下降问题。

bpo-39638 [https://bugs.python.org/issue?@action=redirect&bpo=39638]: 保留 AST 节点文档字符串中的ASDL签名。由Batuhan Taskaya提供补丁。

bpo-39639 [https://bugs.python.org/issue?@action=redirect&bpo=39639]: 弃用 ast.Suite 节点类，因为它不再被使用。由Batuhan Taskaya提供补丁。

bpo-39609 [https://bugs.python.org/issue?@action=redirect&bpo=39609]: 向默认的asyncio执行器添加thread_name_prefix。

bpo-39548 [https://bugs.python.org/issue?@action=redirect&bpo=39548]: 修复 urllib.request.AbstractDigestAuthHandler 中当可选参数 qop 不存在时的头部处理问题。

bpo-39509 [https://bugs.python.org/issue?@action=redirect&bpo=39509]: HTTP status codes 103 EARLY_HINTS and 425 TOO_EARLY are added to http.HTTPStatus. Patch by Dong-hee Na.

bpo-39507 [https://bugs.python.org/issue?@action=redirect&bpo=39507]: 向http库的HTTPStatus添加HTTP状态418 "I'm a Teapot"。由Ross Rhodes提供补丁。

bpo-39495 [https://bugs.python.org/issue?@action=redirect&bpo=39495]: 为保持Python和C实现之间的一致性，移除 xml.etree.ElementTree.TreeBuilder.start() 中 attrs 参数的默认值。

bpo-38971 [https://bugs.python.org/issue?@action=redirect&bpo=38971]: BPO中的开放问题表明希望使codecs.open()的实现与io.open()保持一致，后者实现了try/except以确保在引发异常之前关闭文件流。

bpo-38641 [https://bugs.python.org/issue?@action=redirect&bpo=38641]: 向 lib2to3``添加了对 ``return 和 yield 语句中星号表达式的支持。由Vlad Emelianov提供补丁。

bpo-37534 [https://bugs.python.org/issue?@action=redirect&bpo=37534]: 使用minidom模块生成XML文档时，增加了添加独立文档声明的能力。所有更改均旨在生成符合可扩展标记语言(XML)1.0(第五版)W3C推荐标准的文档(参见：https://www.w3.org/TR/xml/#sec-prolog-dtd)。

bpo-34788 [https://bugs.python.org/issue?@action=redirect&bpo=34788]: 为 ipaddress 添加对范围限定IPv6地址的支持。由Oleksandr Pavliuk提供补丁。

bpo-34822 [https://bugs.python.org/issue?@action=redirect&bpo=34822]: 简化了订阅的AST。简单索引现在由其值表示，扩展切片表示为元组。ast 类 Index 和 ExtSlice 被认为已弃用，将在未来的Python版本中移除。在此期间，Index(value) 现在返回 value 本身，ExtSlice(slices) 返回 Tuple(slices, Load())。

文档

bpo-39868 [https://bugs.python.org/issue?@action=redirect&bpo=39868]: 更新了语言参考以符合 PEP 572 [https://www.python.org/dev/peps/pep-0572]。

bpo-13790 [https://bugs.python.org/issue?@action=redirect&bpo=13790]: 在格式文档中将'string'改为'specification'。

bpo-17422 [https://bugs.python.org/issue?@action=redirect&bpo=17422]: 语言参考不再将默认类命名空间限制为仅字典。

bpo-39530 [https://bugs.python.org/issue?@action=redirect&bpo=39530]: 修正了关于混合类型数值比较的误导性文档。

bpo-39718 [https://bugs.python.org/issue?@action=redirect&bpo=39718]: 更新 token 文档以反映Python 3.8中的新增内容。

bpo-39677 [https://bugs.python.org/issue?@action=redirect&bpo=39677]: 将模块 dis 中 MAKE_FUNCTION 的操作数名称从 argc 改为 flags。

测试

bpo-40019 [https://bugs.python.org/issue?@action=redirect&bpo=40019]: 如果检测到gdb因Python二进制文件被优化而未能读取调试信息，test_gdb现在会跳过测试。

bpo-27807 [https://bugs.python.org/issue?@action=redirect&bpo=27807]: 如果 sys.path 的路径包含 .pth 文件，test_site.test_startup_imports() 现在会跳过。

bpo-26067 [https://bugs.python.org/issue?@action=redirect&bpo=26067]: 在无法将用户的uid或gid解析为名称时，不使test_shutil test_chown测试失败。

bpo-39855 [https://bugs.python.org/issue?@action=redirect&bpo=39855]: test_subprocess.test_user() 现在在用户名不存在时跳过测试。例如，在Linux上如果用户"nobody"不存在，则跳过测试。

构建

bpo-39761 [https://bugs.python.org/issue?@action=redirect&bpo=39761]: 修复了在没有额外DFLAGS的情况下使用DTrace构建的问题。

bpo-39763 [https://bugs.python.org/issue?@action=redirect&bpo=39763]: 如果 subprocess 模块不可用，setup.py 现在使用 subprocess 模块的基本实现：在构建所需的C扩展模块之前。

bpo-1294959 [https://bugs.python.org/issue?@action=redirect&bpo=1294959]: Add --with-platlibdir option to the configure script: name of the platform-specific library directory, stored in the new sys.platlibdir attribute. It is used to build the path of platform-specific extension modules and the path of the standard library. It is equal to "lib" on most platforms. On Fedora and SuSE, it is equal to "lib64" on 64-bit platforms. Patch by Jan Matějek, Matěj Cepl, Charalampos Stratakis and Victor Stinner.

Windows

bpo-39930 [https://bugs.python.org/issue?@action=redirect&bpo=39930]: 确保安装包中包含所需的 vcruntime140.dll。

bpo-39847 [https://bugs.python.org/issue?@action=redirect&bpo=39847]: 避免在计算机休眠时等待互斥锁（用于来自 threading 的锁相关对象）时挂起，大约49天的运行时间。

bpo-38597 [https://bugs.python.org/issue?@action=redirect&bpo=38597]: distutils will no longer statically link vcruntime140.dll when a redistributable version is unavailable. All future releases of CPython will include a copy of this DLL to ensure distributed extensions can continue to load.

bpo-38380 [https://bugs.python.org/issue?@action=redirect&bpo=38380]: 更新 Windows 构建以使用 SQLite 3.31.1。

bpo-39789 [https://bugs.python.org/issue?@action=redirect&bpo=39789]: 更新 Windows 发布构建机器到 Visual Studio 2019 (MSVC 14.2)。

bpo-34803 [https://bugs.python.org/issue?@action=redirect&bpo=34803]: 现在为 nuget.org 提供的包包括存储库引用和捆绑的图标图像。

macOS

bpo-38380 [https://bugs.python.org/issue?@action=redirect&bpo=38380]: 更新 macOS 构建以使用 SQLite 3.31.1。

IDLE

bpo-27115 [https://bugs.python.org/issue?@action=redirect&bpo=27115]: 对于 '转到行'，使用具有 IDLE 标准行为和改进错误检查的查询框子类。

bpo-39885 [https://bugs.python.org/issue?@action=redirect&bpo=39885]: 由于点击获取 IDLE 上下文菜单会移动光标，任何文本选择都应被清除，现在确实如此。

bpo-39852 [https://bugs.python.org/issue?@action=redirect&bpo=39852]: 编辑 "转到行" 现在会清除任何选择，防止意外删除。它还会更新状态栏上的 Ln 和 Col。

bpo-39781 [https://bugs.python.org/issue?@action=redirect&bpo=39781]: 选择代码上下文行不再导致跳转。

工具/示例

bpo-36184 [https://bugs.python.org/issue?@action=redirect&bpo=36184]: 将 python-gdb.py 移植到 FreeBSD。python-gdb.py 现在检查 "take_gil" 函数名来检查帧是否尝试获取 GIL，而不是检查特定于 Linux 的 "pthread_cond_timedwait"，这可能是与 GIL 不同的条件。

bpo-38080 [https://bugs.python.org/issue?@action=redirect&bpo=38080]: Added support to fix getproxies in the lib2to3.fixes.fix_urllib module. Patch by José Roberto Meza Cabrera.

C API

bpo-40024 [https://bugs.python.org/issue?@action=redirect&bpo=40024]: Add PyModule_AddType() helper function: add a type to a module. Patch by Dong-hee Na.

bpo-39946 [https://bugs.python.org/issue?@action=redirect&bpo=39946]: 移除 _PyRuntime.getframe 钩子并移除作为 _PyRuntime.getframe 别名的 _PyThreadState_GetFrame 宏。它们仅由内部 C API 暴露。同时移除 PyThreadFrameGetter 类型。

bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947]: 添加 PyThreadState_GetFrame() 函数：获取 Python 线程状态的当前帧。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: Add _PyArg_NoKwnames helper function. Patch by Dong-hee Na.

bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947]: 添加 PyThreadState_GetInterpreter()：获取 Python 线程状态的解释器。

bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947]: 将 PyInterpreterState_Get() 函数添加到有限的 C API 中。

bpo-35370 [https://bugs.python.org/issue?@action=redirect&bpo=35370]: 如果在 PyEval_SetProfile() 或 PyEval_SetTrace() 中 PySys_Audit() 失败，将错误记录为不可引发的异常。

bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947]: 将 Py_EnterRecursiveCall() 和 Py_LeaveRecursiveCall() 的静态内联函数版本移至内部 C API：它们访问 PyThreadState 属性。有限的 C API 提供了隐藏实现细节的常规函数。

bpo-39947 [https://bugs.python.org/issue?@action=redirect&bpo=39947]: Py_TRASHCAN_BEGIN_CONDITION 和 Py_TRASHCAN_END 宏不再访问 PyThreadState 属性，而是调用新的私有 _PyTrash_begin() 和 _PyTrash_end() 函数，这些函数隐藏了实现细节。

bpo-39884 [https://bugs.python.org/issue?@action=redirect&bpo=39884]: PyDescr_NewMethod() 和 PyCFunction_NewEx() 现在在 SystemError "bad call flags" 错误消息中包含方法名称，以方便调试。

bpo-39877 [https://bugs.python.org/issue?@action=redirect&bpo=39877]: Deprecated PyEval_InitThreads() and PyEval_ThreadsInitialized(). Calling PyEval_InitThreads() now does nothing.

bpo-38249 [https://bugs.python.org/issue?@action=redirect&bpo=38249]: Py_UNREACHABLE 现在在发布模式下使用 __builtin_unreachable() 和类似实现。

bpo-38643 [https://bugs.python.org/issue?@action=redirect&bpo=38643]: PyNumber_ToBase() 现在在被调用时使用无效的基数会引发 SystemError 而不是崩溃。

bpo-39882 [https://bugs.python.org/issue?@action=redirect&bpo=39882]: Py_FatalError() 函数被一个宏替换，该宏自动记录当前函数的名称，除非定义了 Py_LIMITED_API 宏。

bpo-39824 [https://bugs.python.org/issue?@action=redirect&bpo=39824]: 扩展模块：如果模块状态被请求但尚未分配，m_traverse、m_clear 和 m_free 函数将不再被调用。这种情况发生在模块创建后立即和模块执行前（Py_mod_exec 函数）。更准确地说，如果 m_size 大于 0 且模块状态（由 PyModule_GetState() 返回）为 NULL，这些函数不会被调用。

没有模块状态的扩展模块 (m_size <= 0) 不会受到影响。

bpo-38913 [https://bugs.python.org/issue?@action=redirect&bpo=38913]: 修复了在设置了异常的情况下，使用包含 "#" 且未定义 PY_SSIZE_T_CLEAN 的格式调用 Py_BuildValue() 时的段错误。

bpo-38500 [https://bugs.python.org/issue?@action=redirect&bpo=38500]: 添加了一个私有 API 来获取和设置帧评估函数：添加了 _PyInterpreterState_GetEvalFrameFunc() 和 _PyInterpreterState_SetEvalFrameFunc() C 函数。_PyFrameEvalFunction 函数类型现在接受一个 tstate 参数。

Python 3.9.0 alpha 4

发布日期: 2020-02-25

安全性

bpo-39184 [https://bugs.python.org/issue?@action=redirect&bpo=39184]: Add audit events to functions in fcntl, msvcrt, os, resource, shutil, signal and syslog.

bpo-39401 [https://bugs.python.org/issue?@action=redirect&bpo=39401]: 避免在 Windows 7 及更早版本上启动时不安全的 DLL 加载。

bpo-39184 [https://bugs.python.org/issue?@action=redirect&bpo=39184]: 向 os 和 pty 模块中的命令执行函数添加审计事件。

核心与内置函数

bpo-39382 [https://bugs.python.org/issue?@action=redirect&bpo=39382]: 修复了 issubclass() 单继承路径中的一个释放后使用问题，当对象的 __bases__ 有一个单一引用时，其第一个项目也是如此。由 Yonatan Goldschmidt 提供补丁。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: Update clinic tool to use Py_IS_TYPE(). Patch by Dong-hee Na.

bpo-39619 [https://bugs.python.org/issue?@action=redirect&bpo=39619]: 在 HP-UX 系统上启用 os.chroot() 的使用。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: 添加 Py_IS_TYPE() 静态内联函数，用于检查对象 o 的类型是否为 type。

bpo-39606 [https://bugs.python.org/issue?@action=redirect&bpo=39606]: 修复由 bpo-39386 [https://bugs.python.org/issue?@action=redirect&bpo=39386] 的修复引起的回归问题，该问题阻止了对已经关闭或耗尽的异步生成器调用 aclose。

bpo-39579 [https://bugs.python.org/issue?@action=redirect&bpo=39579]: Change the ending column offset of Attribute nodes constructed in ast_for_dotted_name to point at the end of the current node and not at the end of the last NAME node.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _crypt 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _contextvars 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-39510 [https://bugs.python.org/issue?@action=redirect&bpo=39510]: 修复在已关闭的 BufferedReader 上的 readinto() 方法中的段错误。

bpo-39502 [https://bugs.python.org/issue?@action=redirect&bpo=39502]: 修复 64 位 AIX 上的 time.localtime()，以支持 1902 年之前和 2038 年之后的年份。由 M Felt 提供补丁。

bpo-39492 [https://bugs.python.org/issue?@action=redirect&bpo=39492]: 修复 C Pickler 中的一个引用循环，该循环阻止了被删除、腌制的对象的垃圾回收。

bpo-39453 [https://bugs.python.org/issue?@action=redirect&bpo=39453]: Fixed a possible crash in list.__contains__() when a list is changed during comparing items. Patch by Dong-hee Na.

bpo-39434 [https://bugs.python.org/issue?@action=redirect&bpo=39434]: floor division of float operation now has a better performance. Also the message of ZeroDivisionError for this operation is updated. Patch by Dong-hee Na.

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _codecs 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _bz2 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将 _abc 扩展模块移植到多阶段初始化 (PEP 489 [https://www.python.org/dev/peps/pep-0489])。

bpo-39320 [https://bugs.python.org/issue?@action=redirect&bpo=39320]: 用两个更简单的字节码替换构建字典的两个复杂字节码。添加了新的字节码 DICT_MERGE 和 DICT_UPDATE，移除了旧的字节码 BUILD_MAP_UNPACK 和 BUILD_MAP_UNPACK_WITH_CALL。

bpo-39219 [https://bugs.python.org/issue?@action=redirect&bpo=39219]: 分词器中引发的语法错误现在总是设置正确的 "text" 和 "offset" 属性。

bpo-36051 [https://bugs.python.org/issue?@action=redirect&bpo=36051]: 在大型 bytes.join 操作期间释放 GIL。由 Bruce Merry 提供补丁。

bpo-38960 [https://bugs.python.org/issue?@action=redirect&bpo=38960]: 修复 FreeBSD 上的 DTrace 构建问题。由 David Carlier 提供补丁。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: 通过使用 PEP 590 的 vectorcall 调用约定，将 range() 的调用速度提高约 30%。由 Mark Shannon 提供补丁。

bpo-36144 [https://bugs.python.org/issue?@action=redirect&bpo=36144]: dict (和 collections.UserDict) 对象现在支持 PEP 584 的合并（|）和更新（|=）操作符。由 Brandt Bucher 提供补丁。

bpo-32856 [https://bugs.python.org/issue?@action=redirect&bpo=32856]: 优化了在推导式中赋值临时变量的惯用法。现在在推导式中使用 for y in [expr] 与简单赋值 y = expr 一样快。

库

bpo-30566 [https://bugs.python.org/issue?@action=redirect&bpo=30566]: 修复尝试使用 punycode 编解码器解码无效字符串时的 IndexError。

bpo-39649 [https://bugs.python.org/issue?@action=redirect&bpo=39649]: Remove obsolete check for __args__ in bdb.Bdb.format_stack_entry.

bpo-39648 [https://bugs.python.org/issue?@action=redirect&bpo=39648]: 扩展 math.gcd() 和 math.lcm() 以处理多个参数。

bpo-39681 [https://bugs.python.org/issue?@action=redirect&bpo=39681]: 修复一个回归问题，即 C pickle 模块不允许从没有暴露 readinto() 方法的类文件对象中反序列化。

bpo-35950 [https://bugs.python.org/issue?@action=redirect&bpo=35950]: 在只读的 io.BufferedReader 实例上调用 io.BufferedReader.truncate() 时抛出 io.UnsupportedOperation。

bpo-39479 [https://bugs.python.org/issue?@action=redirect&bpo=39479]: 添加 math.lcm() 函数：最小公倍数。

bpo-39674 [https://bugs.python.org/issue?@action=redirect&bpo=39674]: 撤销“不在 collections 模块中暴露抽象集合类”的更改（bpo-25988 [https://bugs.python.org/issue?@action=redirect&bpo=25988]）。像 collections.Mapping 这样的 ABC 别名在 Python 3.9 中保留以方便从 Python 2.7 过渡，但将在 Python 3.10 中移除。

bpo-39104 [https://bugs.python.org/issue?@action=redirect&bpo=39104]: 修复当任务序列化失败时 shutdown(wait=False) 上的 ProcessPoolExecutor 挂起问题。

bpo-39627 [https://bugs.python.org/issue?@action=redirect&bpo=39627]: 修复了 TypedDict 对继承键的总体验证。

bpo-39474 [https://bugs.python.org/issue?@action=redirect&bpo=39474]: 修复了像 (a)(b)、(a)[b] 和 (a).b 这类表达式的 AST 起始位置。

bpo-21016 [https://bugs.python.org/issue?@action=redirect&bpo=21016]: pydoc 和 trace 模块现在使用 sysconfig 模块来获取 Python 标准库的路径，以支持像 Fedora 上的 /usr/lib64/python3.9/ 这样的不常见安装路径。由 Jan Matějek 提供补丁。

bpo-39590 [https://bugs.python.org/issue?@action=redirect&bpo=39590]: Collections.deque 现在在 deque.__contains__ 和 deque.count 期间保持强引用，修复了崩溃问题。

bpo-39586 [https://bugs.python.org/issue?@action=redirect&bpo=39586]: Python 3.9 中已弃用 distutils 的 bdist_msi 命令，改用 bdist_wheel (wheel 包) 。

bpo-39595 [https://bugs.python.org/issue?@action=redirect&bpo=39595]: Improved performance of zipfile.Path for files with a large number of entries. Also improved performance and fixed minor issue as published with importlib_metadata 1.5 [https://importlib-metadata.readthedocs.io/en/latest/changelog%20(links).html#v1-5-0].

bpo-39350 [https://bugs.python.org/issue?@action=redirect&bpo=39350]: 修复了 fractions.Fraction 如果分子和/或分母是 int 子类时的回归问题。现在使用 math.gcd() 函数来规范化 分子 和 分母。math.gcd() 总是返回 int 类型。以前，GCD 类型依赖于 分子 和 分母。

bpo-39567 [https://bugs.python.org/issue?@action=redirect&bpo=39567]: 为 os.walk()、os.fwalk()、pathlib.Path.glob() 和 pathlib.Path.rglob() 添加了审计。

bpo-39559 [https://bugs.python.org/issue?@action=redirect&bpo=39559]: 从 uuid.getnode() 中移除了未使用的、未记录的参数 getters。

bpo-38149 [https://bugs.python.org/issue?@action=redirect&bpo=38149]: 现在每次调用 glob.glob() 和 glob.iglob() 时，sys.audit() 只被调用一次。

bpo-39546 [https://bugs.python.org/issue?@action=redirect&bpo=39546]: 修复了 ArgumentParser 中的一个回归问题，其中 allow_abbrev=False 对于使用除 "-" 之外的前缀字符的长选项被忽略。

bpo-39450 [https://bugs.python.org/issue?@action=redirect&bpo=39450]: 在从 unittest.case.shortDescription() 返回之前，去除了文档字符串中的空白。

bpo-12915 [https://bugs.python.org/issue?@action=redirect&bpo=12915]: 在 pkgutil 模块中添加了一个新函数 resolve_name。该函数将形如 'a.b.c.d' 或 'a.b:c.d' 的字符串解析为一个对象。在示例中，a.b 是一个包/模块，而 c.d 是通过递归属性访问到达的该包/模块内的一个对象。

bpo-39353 [https://bugs.python.org/issue?@action=redirect&bpo=39353]: binascii.crc_hqx() 函数不再被弃用。

bpo-39493 [https://bugs.python.org/issue?@action=redirect&bpo=39493]: 将 typing.IO.closed 标记为属性

bpo-39491 [https://bugs.python.org/issue?@action=redirect&bpo=39491]: 添加 typing.Annotated 和 include_extras 参数到 typing.get_type_hints() 作为 PEP 593 [https://www.python.org/dev/peps/pep-0593] 的一部分。由 Till Varoquaux 提供补丁，文档由 Till Varoquaux 和 Konstantin Kashin 编写。

bpo-39485 [https://bugs.python.org/issue?@action=redirect&bpo=39485]: 修复 unittest.mock.create_autospec() 中的一个错误，该错误会抱怨在扩展模块中定义的自定义描述符返回函数时的参数数量不正确。

bpo-38932 [https://bugs.python.org/issue?@action=redirect&bpo=38932]: Mock 在 reset_mock() 时完全重置子对象。由 Vegard Stikbakke 提供补丁

bpo-39082 [https://bugs.python.org/issue?@action=redirect&bpo=39082]: 允许 AsyncMock 正确修补静态/类方法

bpo-39432 [https://bugs.python.org/issue?@action=redirect&bpo=39432]: 在 distutils 中实现了 PEP-489 算法，用于非 ASCII "PyInit_..." 符号名称，以确保在 Windows 上也导出正确的初始化符号。

bpo-18819 [https://bugs.python.org/issue?@action=redirect&bpo=18819]: 在 tarfile 存档中为非设备文件省略 devmajor 和 devminor 字段，实现与 GNU tar(1) 的比特级兼容。

bpo-39349 [https://bugs.python.org/issue?@action=redirect&bpo=39349]: 向 concurrent.futures.Executor.shutdown() 添加了一个新的 cancel_futures 参数，该参数会取消所有尚未开始运行的待处理期货，而不是在关闭执行器之前等待它们完成。

bpo-39274 [https://bugs.python.org/issue?@action=redirect&bpo=39274]: bool(fraction.Fraction) 现在即使 (numerator != 0) 不返回布尔值（例如 numpy 数字），也会返回一个布尔值。

bpo-34793 [https://bugs.python.org/issue?@action=redirect&bpo=34793]: 移除了对 with (await asyncio.lock): 和 with (yield from asyncio.lock): 的支持。对于 asyncio.Condition 和 asyncio.Semaphore 同样适用。

bpo-25597 [https://bugs.python.org/issue?@action=redirect&bpo=25597]: 确保在向 unittest.mock.MagicMock 提供 wraps 时，它被用于计算魔术方法的返回值，而不是使用默认返回值。由Karthikeyan Singaravelan提供的补丁。

bpo-36350 [https://bugs.python.org/issue?@action=redirect&bpo=36350]: inspect.Signature.parameters and inspect.BoundArguments.arguments are now dicts instead of OrderedDicts. Patch contributed by Rémi Lapeyre.

bpo-35727 [https://bugs.python.org/issue?@action=redirect&bpo=35727]: 修复了在multiprocessing.Process中使用sys.exit()和sys.exit(None)时的退出代码传播问题。

bpo-32173 [https://bugs.python.org/issue?@action=redirect&bpo=32173]: * Add lazycache function to __all__. * Use dict.clear to clear the cache. * Refactoring getline function and checkcache function.

文档

bpo-17422 [https://bugs.python.org/issue?@action=redirect&bpo=17422]: 语言参考现在指定了对类命名空间的限制。基于Ethan Furman的补丁改编。

bpo-39572 [https://bugs.python.org/issue?@action=redirect&bpo=39572]: 更新了 TypedDict 的 total 标志的文档。

bpo-39654 [https://bugs.python.org/issue?@action=redirect&bpo=39654]: 在pyclbr文档中，将'class'更新为'module'并在适当的地方添加readmodule注释。由Hakan Çelik提供的补丁。

bpo-39153 [https://bugs.python.org/issue?@action=redirect&bpo=39153]: 澄清了以下函数的引用计数语义：- PyObject_SetItem - PyMapping_SetItemString - PyDict_SetItem - PyDict_SetItemString

bpo-39392 [https://bugs.python.org/issue?@action=redirect&bpo=39392]: 解释在使用turtle填充时，重叠区域可能不会被填充。

bpo-39369 [https://bugs.python.org/issue?@action=redirect&bpo=39369]: 更新mmap readline方法的描述。readline方法确实会更新文件位置，这一点不应被忽视，因为这可能会给程序员留下它不更新的印象。

bpo-9056 [https://bugs.python.org/issue?@action=redirect&bpo=9056]: 在文档的PDF版本中为子章节添加目录。

测试

bpo-38325 [https://bugs.python.org/issue?@action=redirect&bpo=38325]: 在test_winconsoleio的非BMP字符测试中跳过测试。

bpo-39502 [https://bugs.python.org/issue?@action=redirect&bpo=39502]: 如果 time.localtime() 因 OverflowError 失败，则跳过test_zipfile.test_add_file_after_2107()。例如在AIX 6.1上就是这种情况。

构建

bpo-39489 [https://bugs.python.org/issue?@action=redirect&bpo=39489]: 移除 COUNT_ALLOCS 特殊构建。

Windows

bpo-39553 [https://bugs.python.org/issue?@action=redirect&bpo=39553]: 删除与SxS清单相关的未使用代码。

bpo-39439 [https://bugs.python.org/issue?@action=redirect&bpo=39439]: 在Windows上激活virtualenv时，尊重Python路径。

bpo-39393 [https://bugs.python.org/issue?@action=redirect&bpo=39393]: 改进尝试加载具有未解决依赖项的DLL时的错误消息。

bpo-38883 [https://bugs.python.org/issue?@action=redirect&bpo=38883]: home() and expanduser() on Windows now prefer USERPROFILE and no longer use HOME, which is not normally set for regular user accounts. This makes them again behave like os.path.expanduser(), which was changed to ignore HOME in 3.8, see bpo-36264 [https://bugs.python.org/issue?@action=redirect&bpo=36264].

bpo-39185 [https://bugs.python.org/issue?@action=redirect&bpo=39185]: build.bat脚本新增了非常安静的输出选项(-q)和非常详细的输出选项(-vv)。

IDLE

bpo-39663 [https://bugs.python.org/issue?@action=redirect&bpo=39663]: 为pyparse的find_good_parse_start()添加测试。

bpo-39600 [https://bugs.python.org/issue?@action=redirect&bpo=39600]: 在字体配置窗口中，移除重复的字体名称。

bpo-30780 [https://bugs.python.org/issue?@action=redirect&bpo=30780]: 为按钮、高亮和键标签页添加剩余的配置对话框测试。

bpo-39388 [https://bugs.python.org/issue?@action=redirect&bpo=39388]: IDLE设置的取消按钮现在会取消待处理的更改。

bpo-38792 [https://bugs.python.org/issue?@action=redirect&bpo=38792]: 如果发生 KeyboardInterrupt 或shell重启，关闭IDLE shell的调用提示。由Zackery Spytz提供补丁。

C API

bpo-35081 [https://bugs.python.org/issue?@action=redirect&bpo=35081]: 将 bytes_methods.h 头文件移动到内部C API中，更名为 pycore_bytes_methods.h：它仅包含私有符号（前缀为 _Py），除了 PyDoc_STRVAR_shared() 宏。

bpo-35081 [https://bugs.python.org/issue?@action=redirect&bpo=35081]: 将 dtoa.h 头文件移动到内部C API中，更名为 pycore_dtoa.h：它仅包含私有函数（前缀为 _Py）。现在编译 math 和 cmath 模块时必须定义 Py_BUILD_CORE 宏。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: 添加 Py_SET_SIZE() 函数以设置对象的大小。

bpo-39500 [https://bugs.python.org/issue?@action=redirect&bpo=39500]: PyUnicode_IsIdentifier() 不再在字符串未准备好时调用 Py_FatalError()。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: 添加 Py_SET_TYPE() 函数以设置对象的类型。

bpo-39573 [https://bugs.python.org/issue?@action=redirect&bpo=39573]: 添加 Py_SET_REFCNT() 函数以设置对象的引用计数器。

bpo-39542 [https://bugs.python.org/issue?@action=redirect&bpo=39542]: 将 PyType_HasFeature()、PyType_Check() 和 PyType_CheckExact() 宏转换为静态内联函数。

bpo-39542 [https://bugs.python.org/issue?@action=redirect&bpo=39542]: 在受限 C API 中，PyObject_INIT() 和 PyObject_INIT_VAR() 现在被定义为 PyObject_Init() 和 PyObject_InitVar() 的别名，以使它们的实现变得不透明。这避免了在受限 C API 中泄露实现细节。将以下函数从受限 C API 中排除：_Py_NewReference()、_Py_ForgetReference()、_PyTraceMalloc_NewReference() 和 _Py_GetRefTotal()。

bpo-39542 [https://bugs.python.org/issue?@action=redirect&bpo=39542]: 将垃圾回收机制从受限 C API 中排除：它需要访问 PyTypeObject 和 PyThreadState 结构体字段，而这些结构在受限 C API 中是不透明的。

bpo-39511 [https://bugs.python.org/issue?@action=redirect&bpo=39511]: PyThreadState_Clear() 函数现在会调用 PyThreadState.on_delete 回调。在此之前，这是在 PyThreadState_Delete() 中进行的。

bpo-38076 [https://bugs.python.org/issue?@action=redirect&bpo=38076]: 修复了仅在清除模块全局变量后清除解释器状态的问题，以保证在运行时销毁期间从 C 扩展访问模块状态。

bpo-39245 [https://bugs.python.org/issue?@action=redirect&bpo=39245]: Vectorcall API (PEP 590) 被公开，增加了函数 PyObject_Vectorcall、PyObject_VectorcallMethod、PyVectorcall_Function、PyObject_CallOneArg、PyObject_CallMethodNoArgs、PyObject_CallMethodOneArg、PyObject_FastCallDict，以及标志 Py_TPFLAGS_HAVE_VECTORCALL。

Python 3.9.0 alpha 3

发布日期: 2020-01-24

核心与内置函数

bpo-39427 [https://bugs.python.org/issue?@action=redirect&bpo=39427]: 在命令行帮助部分记录了 -X 选项的所有可能性。由 Pablo Galindo 提供补丁。

bpo-39421 [https://bugs.python.org/issue?@action=redirect&bpo=39421]: 修复了在使用 heapq 模块中的函数和自定义比较运算符时可能出现的崩溃问题。

bpo-39386 [https://bugs.python.org/issue?@action=redirect&bpo=39386]: 防止异步迭代器的双重等待。

bpo-17005 [https://bugs.python.org/issue?@action=redirect&bpo=17005]: 向 functools 模块添加 functools.TopologicalSorter，以提供执行图拓扑排序的功能。由 Pablo Galindo、Tim Peters 和 Larry Hastings 提供补丁。

bpo-39320 [https://bugs.python.org/issue?@action=redirect&bpo=39320]: 用三个更简单的字节码替换四个用于构建序列的复杂字节码。

以下四个字节码已被移除：

BUILD_LIST_UNPACK

BUILD_TUPLE_UNPACK

BUILD_SET_UNPACK

BUILD_TUPLE_UNPACK_WITH_CALL

新增了以下三个字节码：

LIST_TO_TUPLE

LIST_EXTEND

SET_UPDATE

bpo-39336 [https://bugs.python.org/issue?@action=redirect&bpo=39336]: 发布不可变模块对象的导入加载器现在除了可以发布单个模块外，还可以发布不可变包。

bpo-39322 [https://bugs.python.org/issue?@action=redirect&bpo=39322]: 新增了一个函数 gc.is_finalized() 用于检查对象是否已被垃圾收集器终结。由Pablo Galindo提供补丁。

bpo-39048 [https://bugs.python.org/issue?@action=redirect&bpo=39048]: 通过查找 __aenter__() 特殊方法在 __aexit__() 特殊方法之前进入异步上下文管理器时，改进了当传递错误类型给 async with 语句时显示的错误消息。由Géry Ogam提供补丁。

bpo-39235 [https://bugs.python.org/issue?@action=redirect&bpo=39235]: 修复了函数调用中单独生成器表达式的AST结束位置，例如 f(i for i in a)。

bpo-39209 [https://bugs.python.org/issue?@action=redirect&bpo=39209]: 正确处理交互模式下的多行令牌。由Pablo Galindo提供补丁。

bpo-1635741 [https://bugs.python.org/issue?@action=redirect&bpo=1635741]: 将_json扩展模块移植到多阶段初始化（PEP 489 [https://www.python.org/dev/peps/pep-0489]）。

bpo-39216 [https://bugs.python.org/issue?@action=redirect&bpo=39216]: 修复了仅位置参数的常量折叠优化 - 由Anthony Sottile提供。

bpo-39215 [https://bugs.python.org/issue?@action=redirect&bpo=39215]: 修复了当嵌套函数在仅位置参数上有注释时引发的 SystemError - 由Anthony Sottile提供。

bpo-39200 [https://bugs.python.org/issue?@action=redirect&bpo=39200]: Correct the error message when calling the min() or max() with no arguments. Patch by Dong-hee Na.

bpo-39200 [https://bugs.python.org/issue?@action=redirect&bpo=39200]: 修正了尝试在没有参数的情况下构造 range 对象时的错误消息。由Pablo Galindo提供补丁。

bpo-39166 [https://bugs.python.org/issue?@action=redirect&bpo=39166]: 修复了在跟踪异步for循环的最后一次迭代时，跟踪函数中错误的行执行报告。补丁由Pablo Galindo提供。

bpo-39114 [https://bugs.python.org/issue?@action=redirect&bpo=39114]: 修复了在跟踪带有名称绑定的异常处理程序时，跟踪函数中错误的行执行报告。补丁由Pablo Galindo提供。

bpo-39156 [https://bugs.python.org/issue?@action=redirect&bpo=39156]: 将COMPARE_OP字节码指令拆分成四个不同的指令。

用于富比较的COMPARE_OP

用于'is'和'is not'测试的IS_OP

用于'in'和'is not'测试的CONTAINS_OP

JUMP_IF_NOT_EXC_MATCH 用于在 'try-except' 语句中检查异常。

这提高了解释器的清晰度，并应提供适度的加速。

bpo-38588 [https://bugs.python.org/issue?@action=redirect&bpo=38588]: 修复了在调用 PyObject_RichCompareBool() 时 dict 和 list 可能崩溃的问题。

bpo-13601 [https://bugs.python.org/issue?@action=redirect&bpo=13601]: 默认情况下，sys.stderr 现在是行缓冲的，即使 stderr 被重定向到文件。你仍然可以通过传递 -u 命令行选项或设置 PYTHONUNBUFFERED 环境变量来使 sys.stderr 无缓冲。

(由 Jendrik Seipp 在 bpo-13601 [https://bugs.python.org/issue?@action=redirect&bpo=13601] 中贡献。)

bpo-38610 [https://bugs.python.org/issue?@action=redirect&bpo=38610]: 通过在调用 PyObject_RichCompareBool() 时保持对列表元素的强引用，修复了几个列表方法可能崩溃的问题。

bpo-32021 [https://bugs.python.org/issue?@action=redirect&bpo=32021]: 在 mimetypes encodings_map 中包括 brotli .br 编码。

库

bpo-39430 [https://bugs.python.org/issue?@action=redirect&bpo=39430]: 修复了 tarfile 中懒加载导入的竞态条件。

bpo-39413 [https://bugs.python.org/issue?@action=redirect&bpo=39413]: os.unsetenv() 函数现在在 Windows 上也可用。

bpo-39390 [https://bugs.python.org/issue?@action=redirect&bpo=39390]: Fixed a regression with the ignore callback of shutil.copytree(). The argument types are now str and List[str] again.

bpo-39395 [https://bugs.python.org/issue?@action=redirect&bpo=39395]: os.putenv() 和 os.unsetenv() 函数现在总是可用。

bpo-39406 [https://bugs.python.org/issue?@action=redirect&bpo=39406]: 如果 setenv() C 函数可用，os.putenv() 现在用 setenv() 而不是 putenv() 实现，因此 Python 不必处理环境变量内存。

bpo-39396 [https://bugs.python.org/issue?@action=redirect&bpo=39396]: 在 AIX 7.1 上修复 math.nextafter(-0.0, +0.0)。

bpo-29435 [https://bugs.python.org/issue?@action=redirect&bpo=29435]: 允许 tarfile.is_tarfile() 与文件和类文件对象一起使用，就像 zipfile.is_zipfile() 一样。由 William Woodruff 提供补丁。

bpo-39377 [https://bugs.python.org/issue?@action=redirect&bpo=39377]: 从 json.loads() 中移除了 encoding 选项。自 Python 3.1 起已被弃用。

bpo-39389 [https://bugs.python.org/issue?@action=redirect&bpo=39389]: 在 gzip 存档中写入准确的压缩级别元数据，而不是总是信号最大压缩。

bpo-39366 [https://bugs.python.org/issue?@action=redirect&bpo=39366]: The previously deprecated xpath() and xgtitle() methods of nntplib.NNTP have been removed.

bpo-39357 [https://bugs.python.org/issue?@action=redirect&bpo=39357]: 移除 bz2.BZ2File 的 buffering 参数。自 Python 3.0 起，该参数被忽略，使用它会发出 DeprecationWarning。传递一个已打开的文件对象以控制文件的打开方式。compresslevel 参数变为仅关键字参数。

bpo-39353 [https://bugs.python.org/issue?@action=redirect&bpo=39353]: 弃用 binhex4 和 hexbin4 标准。弃用 binhex 模块以及以下 binascii 函数：b2a_hqx()、a2b_hqx()、rlecode_hqx()、rledecode_hqx()、crc_hqx()。

bpo-39351 [https://bugs.python.org/issue?@action=redirect&bpo=39351]: 移除 base64.encodestring() 和 base64.decodestring()，这两个别名自 Python 3.1 起已被弃用：改用 base64.encodebytes() 和 base64.decodebytes()。

bpo-39350 [https://bugs.python.org/issue?@action=redirect&bpo=39350]: 移除 fractions.gcd() 函数，该函数自 Python 3.5 起已被弃用 (bpo-22486 [https://bugs.python.org/issue?@action=redirect&bpo=22486])：改用 math.gcd()。

bpo-39329 [https://bugs.python.org/issue?@action=redirect&bpo=39329]: LMTP constructor now has an optional timeout parameter. Patch by Dong-hee Na.

bpo-39313 [https://bugs.python.org/issue?@action=redirect&bpo=39313]: 为 RefactoringTool 添加一个新的 exec_function 选项（CLI 中的 --exec-function）以使 exec 成为函数。由 Batuhan Taskaya 提供补丁。

bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259]: FTP_TLS and FTP_TLS now raise a ValueError if the given timeout for their constructor is zero to prevent the creation of a non-blocking socket. Patch by Dong-hee Na.

bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259]: SMTP and SMTP_SSL now raise a ValueError if the given timeout for their constructor is zero to prevent the creation of a non-blocking socket. Patch by Dong-hee Na.

bpo-39310 [https://bugs.python.org/issue?@action=redirect&bpo=39310]: 添加 math.ulp()：返回一个浮点数的最低有效位的值。

bpo-39297 [https://bugs.python.org/issue?@action=redirect&bpo=39297]: 提高了 importlib.metadata 分发发现的性能以及对无法访问的 sys.path 条目的恢复能力（importlib_metadata v1.4.0）。

bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259]: NNTP and NNTP_SSL now raise a ValueError if the given timeout for their constructor is zero to prevent the creation of a non-blocking socket. Patch by Dong-hee Na.

bpo-38901 [https://bugs.python.org/issue?@action=redirect&bpo=38901]: 当您指定prompt='.'或等效地使用python -m venv --prompt . ...时，当前目录的basename将被用来设置创建的venv在激活时的提示符。

bpo-39288 [https://bugs.python.org/issue?@action=redirect&bpo=39288]: 添加 math.nextafter(): 返回 x 向 y 方向的下一个浮点数值。

bpo-39259 [https://bugs.python.org/issue?@action=redirect&bpo=39259]: POP3 and POP3_SSL now raise a ValueError if the given timeout for their constructor is zero to prevent the creation of a non-blocking socket. Patch by Dong-hee Na.

bpo-39242 [https://bugs.python.org/issue?@action=redirect&bpo=39242]: Updated the Gmane domain from news.gmane.org to news.gmane.io which is used for examples of NNTP news reader server and nntplib tests.

bpo-35292 [https://bugs.python.org/issue?@action=redirect&bpo=35292]: Proxy the SimpleHTTPRequestHandler.guess_type to mimetypes.guess_type so the mimetypes.init is called lazily to avoid unnecessary costs when http.server module is imported.

bpo-39239 [https://bugs.python.org/issue?@action=redirect&bpo=39239]: select.epoll.unregister() 方法不再忽略 EBADF 错误。

bpo-38907 [https://bugs.python.org/issue?@action=redirect&bpo=38907]: 在http.server脚本中，恢复在Windows上绑定到IPv4。

bpo-39152 [https://bugs.python.org/issue?@action=redirect&bpo=39152]: 修复ttk.Scale.configure([name])返回名称或所有选项的配置元组。Giovanni Lombardo贡献了部分补丁。

bpo-39198 [https://bugs.python.org/issue?@action=redirect&bpo=39198]: If an exception were to be thrown in Logger.isEnabledFor (say, by asyncio timeouts or stopit) , the logging global lock may not be released appropriately, resulting in deadlock. This change wraps that block of code with try...finally to ensure the lock is released.

bpo-39191 [https://bugs.python.org/issue?@action=redirect&bpo=39191]: 在 loop.run_until_complete() 中开始新任务前检查是否有运行循环，以快速失败；它防止在引发异常之前新任务产生的副作用。

bpo-38871 [https://bugs.python.org/issue?@action=redirect&bpo=38871]: Correctly parenthesize filter-based statements that contain lambda expressions in mod:lib2to3. Patch by Dong-hee Na.

bpo-39142 [https://bugs.python.org/issue?@action=redirect&bpo=39142]：对 logging.config.dictConfig 进行了更改，以避免将具名元组的实例转换为 ConvertingTuple。假设命名元组过于专门化，不能像普通元组那样处理；如果具名元组的用户需要 ConvertingTuple 的功能，他们必须自己在具名元组类中实现。

bpo-39158 [https://bugs.python.org/issue?@action=redirect&bpo=39158]：ast.literal_eval() 现在支持空集合。

bpo-39129 [https://bugs.python.org/issue?@action=redirect&bpo=39129]：修复了 asyncio.TimeoutError 的导入路径。

bpo-39057 [https://bugs.python.org/issue?@action=redirect&bpo=39057]：urllib.request.proxy_bypass_environment() 现在忽略前导点，并且不再忽略尾随换行符。

bpo-39056 [https://bugs.python.org/issue?@action=redirect&bpo=39056]：修复了在 -W 选项中处理无效警告类别的问题。如果不需要，不再导入 re 模块。

bpo-39055 [https://bugs.python.org/issue?@action=redirect&bpo=39055]：当输入以单个 \n 结尾时，带有 validate=True 的 base64.b64decode() 现在会引发 binascii.Error。

bpo-21600 [https://bugs.python.org/issue?@action=redirect&bpo=21600]：修复 mock.patch.stopall() 以停止使用 mock.patch.dict() 创建的活跃补丁。

bpo-39019 [https://bugs.python.org/issue?@action=redirect&bpo=39019]：为 tempfile.SpooledTemporaryFile 实现了虚拟的 __class_getitem__。

bpo-39019 [https://bugs.python.org/issue?@action=redirect&bpo=39019]：为 subprocess.Popen, subprocess.CompletedProcess 实现了虚拟的 __class_getitem__。

bpo-38914 [https://bugs.python.org/issue?@action=redirect&bpo=38914]：调整了 distutils 的 check 命令在提供 author 和 maintainer 字段但未找到相应电子邮件字段（author_email 或 maintainer_email）时发出的警告的措辞。措辞现在反映了这些字段是建议的，但不是必需的。由 Juergen Gmach 提供补丁。

bpo-38878 [https://bugs.python.org/issue?@action=redirect&bpo=38878]：修复了 os.PathLike 的 __subclasshook__ 以在继承时返回正确的结果。由 Bar Harel 提供补丁。

bpo-38615 [https://bugs.python.org/issue?@action=redirect&bpo=38615]: IMAP4 and IMAP4_SSL now have an optional timeout parameter for their constructors. Also, the open() method now has an optional timeout parameter with this change. The overridden methods of IMAP4_SSL and IMAP4_stream were applied to this change. Patch by Dong-hee Na.

bpo-35182 [https://bugs.python.org/issue?@action=redirect&bpo=35182]: 修复了当子进程已经关闭了任何管道标准流但仍然继续运行时，Popen.communicate() 后续调用崩溃的问题。由 Andriy Maletsky 提供补丁。

bpo-38630 [https://bugs.python.org/issue?@action=redirect&bpo=38630]: 在 Unix 上，subprocess.Popen.send_signal() 现在会轮询进程状态。轮询减少了在进程已完成但 subprocess.Popen.returncode 属性仍为 None 且 pid 已被重新分配（回收）给一个新的不同进程时向错误进程发送信号的风险。

bpo-38536 [https://bugs.python.org/issue?@action=redirect&bpo=38536]: Removes trailing space in formatted currency with international=True and a locale with symbol following value. E.g. locale.currency(12.34, international=True) returned '12,34 EUR ' instead of '12,34 EUR'.

bpo-38473 [https://bugs.python.org/issue?@action=redirect&bpo=38473]: 对通过 unittest.mock.attach_mock() 附加的自动指定方法使用内部模拟的签名。由 Karthikeyan Singaravelan 提供补丁。

bpo-38361 [https://bugs.python.org/issue?@action=redirect&bpo=38361]: 修复了一个问题，即在没有参数调用 syslog.openlog() 时，ident 可能包含前导路径分隔符。

bpo-38293 [https://bugs.python.org/issue?@action=redirect&bpo=38293]: 向 property() 对象添加 copy.copy() 和 copy.deepcopy() 支持。

bpo-37958 [https://bugs.python.org/issue?@action=redirect&bpo=37958]: 添加了 pstats.Stats.get_profile_dict() 方法，以 StatsProfile 实例的形式返回分析数据。

bpo-28367 [https://bugs.python.org/issue?@action=redirect&bpo=28367]: 以下波特率的 Termios 魔法常量： - B500000 - B576000 - B921600 - B1000000 - B1152000 - B1500000 - B2000000 - B2500000 - B3000000 - B3500000 - B4000000 由 Andrey Smirnov 提供补丁。

文档

bpo-39381 [https://bugs.python.org/issue?@action=redirect&bpo=39381]: 在文档中说明 asyncio.get_event_loop() 仅在主线程调用时隐式创建新的事件循环。

bpo-38918 [https://bugs.python.org/issue?@action=redirect&bpo=38918]: 在 inspect 模块文档的 类型和成员 表格的"函数"和"方法"部分添加 __module__ 条目。

bpo-3530 [https://bugs.python.org/issue?@action=redirect&bpo=3530]: 在 ast 模块文档中，修正一个误导性的 NodeTransformer 示例，并添加关于何时使用 fix_missing_locations 函数的建议。

构建

bpo-39395 [https://bugs.python.org/issue?@action=redirect&bpo=39395]: 在非Windows平台上，setenv() 和 unsetenv() 函数现在是构建Python所必需的。

bpo-39160 [https://bugs.python.org/issue?@action=redirect&bpo=39160]: Updated the documentation in /configure --help to show default values, reference documentation where required and add additional explanation where needed.

bpo-39144 [https://bugs.python.org/issue?@action=redirect&bpo=39144]: ctags 和 etags 的构建目标都包括 Modules/_ctypes 和 Python 标准库源文件。

IDLE

bpo-39050 [https://bugs.python.org/issue?@action=redirect&bpo=39050]: 使IDLE设置对话框的帮助按钮重新工作。

bpo-34118 [https://bugs.python.org/issue?@action=redirect&bpo=34118]: 在库手册内置函数列表中，将 memoryview、range 和 tuple 标记为类，与 list 等相同。

bpo-32989 [https://bugs.python.org/issue?@action=redirect&bpo=32989]: 为编辑器 newline_and_indent_event 方法添加测试。从 pyparse find_good_parse_start 方法中删除死代码。

C API

bpo-39372 [https://bugs.python.org/issue?@action=redirect&bpo=39372]: 清理定义了但未实现的接口的头文件。被移除的公共API符号有：_PyBytes_InsertThousandsGroupingLocale、_PyBytes_InsertThousandsGrouping、_Py_InitializeFromArgs、_Py_InitializeFromWideArgs、_PyFloat_Repr、_PyFloat_Digits、_PyFloat_DigitsInit、PyFrame_ExtendStack、_PyAIterWrapper_Type、PyNullImporter_Type、PyCmpWrapper_Type、PySortWrapper_Type、PyNoArgsFunction。

bpo-39164 [https://bugs.python.org/issue?@action=redirect&bpo=39164]: 添加一个私有的 _PyErr_GetExcInfo() 函数来检索指定Python线程状态的异常信息。

Python 3.9.0 alpha 2

发布日期: 2019-12-18

安全性

bpo-38945 [https://bugs.python.org/issue?@action=redirect&bpo=38945]: 为了防止换行符溢出到编码文件的内容部分，在进行uu编码时已对换行符进行了转义。这可以防止在解码过程中数据被恶意或意外修改。

bpo-37228 [https://bugs.python.org/issue?@action=redirect&bpo=37228]: 由于重大的安全问题，asyncio.loop.create_datagram_endpoint() 的 reuse_address 参数不再被支持。这是因为UDP中 SO_REUSEADDR 的行为。更多详情，请参见 loop.create_datagram_endpoint() 的文档。（由Kyle Stanley、Antoine Pitrou和Yury Selivanov在 bpo-37228 [https://bugs.python.org/issue?@action=redirect&bpo=37228] 中贡献。）

bpo-38804 [https://bugs.python.org/issue?@action=redirect&bpo=38804]: 修复了 http.cookiejar 中的一个ReDoS漏洞。由Ben Caller提供补丁。

核心与内置函数

bpo-39028 [https://bugs.python.org/issue?@action=redirect&bpo=39028]: 通过加强kwargs是interned字符串的假设，略微提高了在有许多kwargs时关键字参数解析的速度。

bpo-39080 [https://bugs.python.org/issue?@action=redirect&bpo=39080]: 当Starred Expression AST节点位于Call AST节点的 args 属性中的元素之间时，修复了 end_col_offset 的值。

bpo-39031 [https://bugs.python.org/issue?@action=redirect&bpo=39031]: 当解析一个"elif"节点时，节点的lineno和col_offset现在指向"elif"关键字而不是其条件，使其与"if"节点保持一致。由Lysandros Nikolaou提供补丁。

bpo-20443 [https://bugs.python.org/issue?@action=redirect&bpo=20443]: 在Python 3.9.0a1中，如果在命令行中指定了文件名，sys.argv[0]会被设置为绝对路径。撤销这一更改，因为大多数用户期望sys.argv保持不变。

bpo-39008 [https://bugs.python.org/issue?@action=redirect&bpo=39008]: PySys_Audit() 现在要求在格式字符串中使用 Py_ssize_t 作为大小参数，不管在包含时是否定义了 PY_SSIZE_T_CLEAN。

bpo-38673 [https://bugs.python.org/issue?@action=redirect&bpo=38673]: 在REPL模式下，如果行以注释或空白开始，不切换到PS2。基于Batuhan Taşkaya的工作。

bpo-38922 [https://bugs.python.org/issue?@action=redirect&bpo=38922]: 现在在代码对象上调用 replace 会引发 code.__new__ 审计事件。

bpo-38920 [https://bugs.python.org/issue?@action=redirect&bpo=38920]: 添加了当 sys.excepthook() 和 sys.unraisablehook() 被调用时的审计钩子。

bpo-38892 [https://bugs.python.org/issue?@action=redirect&bpo=38892]: 改进审计事件表格和函数的文档。

bpo-38852 [https://bugs.python.org/issue?@action=redirect&bpo=38852]: 在安卓平台的调试版本中将线程堆栈大小设置为8 Mb。

bpo-38858 [https://bugs.python.org/issue?@action=redirect&bpo=38858]: 每个Python子解释器现在都有自己的“小整数单例”：范围在[-5; 257]的数字。现在不再可能通过在构建时覆盖 NSMALLNEGINTS 和 NSMALLPOSINTS 宏来更改小整数的数量：宏现在应该在 pycore_pystate.h 头文件中手动修改。

bpo-36854 [https://bugs.python.org/issue?@action=redirect&bpo=36854]: 垃圾收集器状态变为每个解释器（PyInterpreterState.gc），而不是全局的（_PyRuntimeState.gc）。

bpo-38835 [https://bugs.python.org/issue?@action=redirect&bpo=38835]: PyFPE_START_PROTECT() 和 PyFPE_END_PROTECT() 宏为空：它们在过去一年中什么也没做，因此停止使用它们。

bpo-38328 [https://bugs.python.org/issue?@action=redirect&bpo=38328]: 加速了常量 list 和 set 显示的创建时间。由Brandt Bucher提供补丁。

bpo-38707 [https://bugs.python.org/issue?@action=redirect&bpo=38707]: MainThread.native_id 现在在使用 multiprocessing.Process 生成的子进程中被正确重置，而不是保留父进程的值。

bpo-38629 [https://bugs.python.org/issue?@action=redirect&bpo=38629]: 向float对象添加了 __floor__ 和 __ceil__ 方法。由Batuhan Taşkaya提供补丁。

bpo-27145 [https://bugs.python.org/issue?@action=redirect&bpo=27145]: int + int和int - int操作符现在可以返回小整数单例。由hongweipeng提供补丁。

bpo-38021 [https://bugs.python.org/issue?@action=redirect&bpo=38021]: 为AIX提供一个足以用于PEP425二进制分发识别的平台标签。由Michael Felt提供补丁。

bpo-35409 [https://bugs.python.org/issue?@action=redirect&bpo=35409]: 在向异步生成器的aclose协程抛出异常时忽略GeneratorExit异常。

bpo-33387 [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'主体的每次退出复制。

库

bpo-39033 [https://bugs.python.org/issue?@action=redirect&bpo=39033]: 修复 zipimport 中的 NameError。由Karthikeyan Singaravelan提供补丁。

bpo-39022 [https://bugs.python.org/issue?@action=redirect&bpo=39022]: 更新importlib.metadata以包含来自importlib_metadata 1.3的改进，包括EntryPoints的更好的序列化和自定义查找器的改进文档。

bpo-39006 [https://bugs.python.org/issue?@action=redirect&bpo=39006]: 修复当ssl模块缺失时的asyncio问题：仅在ssl模块可用时检查ssl.SSLSocket实例。

bpo-38708 [https://bugs.python.org/issue?@action=redirect&bpo=38708]: 修复电子邮件解析器在解析空msg-id时可能出现的IndexError。

bpo-38698 [https://bugs.python.org/issue?@action=redirect&bpo=38698]: 向电子邮件解析器添加一个新的 InvalidMessageID 标记，以表示无效的Message-ID头。此外，在解析头之后还有剩余值时添加缺陷。

bpo-38994 [https://bugs.python.org/issue?@action=redirect&bpo=38994]: 为 os.PathLike、pathlib.Path 实现 __class_getitem__。

bpo-38979 [https://bugs.python.org/issue?@action=redirect&bpo=38979]: 从 ContextVar.__class_getitem__ 返回类以简化子类化。

bpo-38978 [https://bugs.python.org/issue?@action=redirect&bpo=38978]: 在asyncio对象（Future, Task, Queue）上实现 __class_getitem__。由Batuhan Taskaya提供补丁。

bpo-38916 [https://bugs.python.org/issue?@action=redirect&bpo=38916]: array.array: 移除 tostring() 和 fromstring() 方法。它们是``tobytes()``和 frombytes() 的别名，自Python 3.2起已弃用。

bpo-38986 [https://bugs.python.org/issue?@action=redirect&bpo=38986]: 使C加速的TaskWakeupMethWrapper的repr与纯Python版本的相同。

bpo-38982 [https://bugs.python.org/issue?@action=redirect&bpo=38982]: 修复asyncio PidfdChildWatcher：处理 waitpid() 错误。如果在其他地方调用 waitpid()，waitpid() 调用会失败并抛出 ChildProcessError：在这种情况下使用返回码255，并记录一个警告。这确保了如果此错误发生，pidfd文件描述符会被关闭。

bpo-38529 [https://bugs.python.org/issue?@action=redirect&bpo=38529]: 取消关于未显式调用 .close() 删除流的过于嘈杂的asyncio警告。

bpo-27413 [https://bugs.python.org/issue?@action=redirect&bpo=27413]: 增加了在 json.tool 命令行界面中将 ensure_ascii 选项传递给json.dumps的能力。

bpo-38634 [https://bugs.python.org/issue?@action=redirect&bpo=38634]: readline 模块现在在所有平台上运行时检测Python是否链接到libedit。以前，此检查仅在macOS上进行。

bpo-33684 [https://bugs.python.org/issue?@action=redirect&bpo=33684]: 修复当区域编码不是UTF-8时，json.tool 无法读取包含非ASCII字符的JSON文件的问题。

bpo-38698 [https://bugs.python.org/issue?@action=redirect&bpo=38698]: 防止在parse_message_id中出现UnboundLocalError。

parse_message_id() was improperly using a token defined inside an exception handler, which was raising UnboundLocalError on parsing an invalid value. Patch by Claudiu Popa.

bpo-38927 [https://bugs.python.org/issue?@action=redirect&bpo=38927]: 在venv中使用 python -m pip 而不是 pip 来升级依赖。

bpo-26730 [https://bugs.python.org/issue?@action=redirect&bpo=26730]: 修复 SpooledTemporaryFile.rollover() 在文本模式下可能会损坏文件的问题。由Serhiy Storchaka提供补丁。

bpo-38881 [https://bugs.python.org/issue?@action=redirect&bpo=38881]: 当所有权重为零时，random.choices() 现在会引发 ValueError。

bpo-38876 [https://bugs.python.org/issue?@action=redirect&bpo=38876]: 当从memo加载无效输入的项时，引发pickle.UnpicklingError。

The previous code was raising a KeyError for both the Python and C implementation. This was caused by the specified index of an invalid input which did not exist in the memo structure, where the pickle stores what objects it has seen. The malformed input would have caused either a BINGET or LONG_BINGET load from the memo, leading to a KeyError as the determined index was bogus. Patch by Claudiu Popa

bpo-38688 [https://bugs.python.org/issue?@action=redirect&bpo=38688]: Calling func:shutil.copytree to copy a directory tree from one directory to another subdirectory resulted in an endless loop and a RecursionError. A fix was added to consume an iterator and create the list of the entries to be copied, avoiding the recursion for newly created directories. Patch by Bruno P. Kinoshita.

bpo-38863 [https://bugs.python.org/issue?@action=redirect&bpo=38863]: 改进 http.server 中的 is_cgi() 函数，使其能够处理cgi目录是除根目录外的另一个目录的子目录的情况。

bpo-37838 [https://bugs.python.org/issue?@action=redirect&bpo=37838]: typing.get_type_hints() 正确处理了用 functools.wraps() 装饰的函数。

bpo-38870 [https://bugs.python.org/issue?@action=redirect&bpo=38870]: 将 ast.unparse() 作为 ast 模块的一个函数公开，可用于反解析一个 ast.AST 对象，并生成一个字符串，该字符串在被解析时会生成一个等效的 ast.AST 对象。由 Pablo Galindo 和 Batuhan Taskaya 提供补丁。

bpo-38859 [https://bugs.python.org/issue?@action=redirect&bpo=38859]: AsyncMock 现在在 side_effects 可迭代对象耗尽时返回 StopAsyncIteration。由于 PEP-479，从协程中引发 StopIteration 异常是不可能的。

bpo-38857 [https://bugs.python.org/issue?@action=redirect&bpo=38857]: AsyncMock 修复了返回值为可等待类型的问题。这还包括了那些恰好是可等待的 side_effect 可迭代值，并包装了返回可等待类型的可调用对象。在此之前，这些可等待对象是被等待而不是原样返回。

bpo-38834 [https://bugs.python.org/issue?@action=redirect&bpo=38834]: typing.TypedDict 子类现在使用 __required_keys__ 和 __optional_keys__ 属性来跟踪哪些键是可选的，以便下游项目进行运行时验证。由 Zac Hatfield-Dodds 提供补丁。

bpo-38821 [https://bugs.python.org/issue?@action=redirect&bpo=38821]: 修复了 argparse 在国际化错误消息时对于 nargs 设置为特殊（非整数）值的参数未处理的异常。由 Federico Bond 提供补丁。

bpo-38820 [https://bugs.python.org/issue?@action=redirect&bpo=38820]: 使 Python 与 OpenSSL 3.0.0 兼容。ssl.SSLSocket.getpeercert() 不再返回带有尾随换行符的 IPv6 地址。

bpo-38811 [https://bugs.python.org/issue?@action=redirect&bpo=38811]: 修复了 pathlib 在 os.link() 缺失时的未处理异常。由 Toke Høiland-Jørgensen 提供补丁。

bpo-38686 [https://bugs.python.org/issue?@action=redirect&bpo=38686]: 在 urllib.request.AbstractDigestAuthHandler 中添加了对多个 qop 值的支持。

bpo-38712 [https://bugs.python.org/issue?@action=redirect&bpo=38712]: 添加了 Linux 特有的 signal.pidfd_send_signal() 函数，该函数允许向由文件描述符而非 pid 标识的进程发送信号。

bpo-38348 [https://bugs.python.org/issue?@action=redirect&bpo=38348]: 向 ast 解析工具添加了 -i 和 --indent (缩进级别) 以及 --no-type-comments (类型注释) 命令行选项。

bpo-37523 [https://bugs.python.org/issue?@action=redirect&bpo=37523]: 修改 zipfile.ZipExtFile 在尝试访问已关闭的底层文件对象时抛出 ValueError。这一新行为与 Python 其他部分处理访问已关闭文件的方式保持一致。

bpo-38045 [https://bugs.python.org/issue?@action=redirect&bpo=38045]: 提高 enum 中 enum._decompose() 的性能。由 hongweipeng 提供补丁。

bpo-36820 [https://bugs.python.org/issue?@action=redirect&bpo=36820]: 在 socket.py、codeop.py 和 dyld.py 中保存异常时生成的循环被打破，因为它们不仅通过 __traceback__ 属性保持异常活跃，还保持了用户对象。由 Mario Corchero 提供补丁。

bpo-36406 [https://bugs.python.org/issue?@action=redirect&bpo=36406]: 在 doctest 中处理命名空间包。由 Karthikeyan Singaravelan 提供补丁。

bpo-34776 [https://bugs.python.org/issue?@action=redirect&bpo=34776]: 修复数据类以支持类型注解中的前向引用。

bpo-20928 [https://bugs.python.org/issue?@action=redirect&bpo=20928]: ElementTree 支持递归 XInclude 处理。由 Stefan Behnel 提供补丁。

bpo-29636 [https://bugs.python.org/issue?@action=redirect&bpo=29636]: 为 json.tool CLI 添加格式化 JSON 的空格选项。现在支持以下互斥选项：--indent 用于设置空格缩进级别；--tab 用于使用制表符缩进；--no-indent 用于抑制换行；--compact 用于抑制所有空格。默认行为仍与 --indent=4 相同。

文档

bpo-38928 [https://bugs.python.org/issue?@action=redirect&bpo=38928]: 更正 venv 的 upgrade_dependencies() 和 --upgrade-deps 的添加时机。

bpo-38899 [https://bugs.python.org/issue?@action=redirect&bpo=38899]: Update documentation to state that to activate virtual environments under fish one should use source, not as documented at https://fishshell.com/docs/current/commands.html#source.

bpo-22377 [https://bugs.python.org/issue?@action=redirect&bpo=22377]: 改进 datetime.datetime.strptime() 接受的 %Z 值的文档。由 Karl Dubost 提供补丁。

测试

bpo-38546 [https://bugs.python.org/issue?@action=redirect&bpo=38546]: 修复 test_concurrent_futures 的 test_ressources_gced_in_workers()：显式停止管理器以防止测试完成后泄漏在后台运行的子进程。

bpo-38546 [https://bugs.python.org/issue?@action=redirect&bpo=38546]: 多处理和 concurrent.futures 测试现在在测试完成时停止资源跟踪器进程。

bpo-38614 [https://bugs.python.org/issue?@action=redirect&bpo=38614]: 在测试中用新的 test.support 常量替换硬编码的超时常量：LOOPBACK_TIMEOUT、INTERNET_TIMEOUT、SHORT_TIMEOUT 和 LONG_TIMEOUT。这样更容易一次性为所有测试调整这四个超时常量，而不必调整每一个测试文件。

bpo-38547 [https://bugs.python.org/issue?@action=redirect&bpo=38547]: 修复 test_pty：如果进程是会话领导者，关闭主文件描述符会引发 SIGHUP 信号：在运行测试时简单地忽略 SIGHUP。

bpo-38992 [https://bugs.python.org/issue?@action=redirect&bpo=38992]: 修复一个因常数折叠而失败的 math.fsum() 测试。

bpo-38991 [https://bugs.python.org/issue?@action=redirect&bpo=38991]: test.support：run_python_until_end()、assert_python_ok() 和 assert_python_failure() 函数不再从 stderr 中去除空格。移除 test.support.strip_python_stderr() 函数。

bpo-38965 [https://bugs.python.org/issue?@action=redirect&bpo=38965]: 在 GCC 10 上修复 test_faulthandler。在 faulthandler._stack_overflow() 中使用 "volatile" 关键字来防止在任何编译器上进行尾调用优化，而不是依赖于编译器特定的编译指示。

bpo-38875 [https://bugs.python.org/issue?@action=redirect&bpo=38875]: test_capi：垃圾回收测试现在需要测试 "cpu" 资源。

bpo-38841 [https://bugs.python.org/issue?@action=redirect&bpo=38841]: 在缺乏对命名 Unix 域套接字有功能 bind() 的平台上跳过 asyncio test_create_datagram_endpoint_existing_sock_unix。

bpo-38692 [https://bugs.python.org/issue?@action=redirect&bpo=38692]: 如果 os.pidfd_open() 因为 PermissionError 失败，则跳过 test_posix.test_pidfd_open() 测试。这种情况可能发生在使用系统调用白名单但不允许 pidfd_open() 系统调用的 Linux 沙箱中。

bpo-38839 [https://bugs.python.org/issue?@action=redirect&bpo=38839]: 修复测试中一些未使用的函数。由 Adam Johnson 提供补丁。

bpo-38669 [https://bugs.python.org/issue?@action=redirect&bpo=38669]: 当用字符串传递目标时，unittest.mock.patch.object() 抛出 TypeError。

bpo-37957 [https://bugs.python.org/issue?@action=redirect&bpo=37957]: test.regrtest 现在可以接收一个要忽略的测试模式列表（使用 -i/--ignore 参数）或一个包含要忽略模式列表的文件（使用 --ignore-file 参数）。由 Pablo Galindo 提供补丁。

构建

bpo-37404 [https://bugs.python.org/issue?@action=redirect&bpo=37404]: asyncio now raises TyperError when calling incompatible methods with an ssl.SSLSocket socket. Patch by Ido Michael.

bpo-36500 [https://bugs.python.org/issue?@action=redirect&bpo=36500]: 在 Visual Studio 解决方案中添加了一个可选的 "regen" 项目，该项目将重新生成所有语法、标记和操作码。

Windows

bpo-39007 [https://bugs.python.org/issue?@action=redirect&bpo=39007]: 向 winreg 中的函数添加审计事件。

bpo-33125 [https://bugs.python.org/issue?@action=redirect&bpo=33125]: 添加对构建和发布 Windows ARM64 包的支持。

macOS

bpo-37931 [https://bugs.python.org/issue?@action=redirect&bpo=37931]: Fixed a crash on OSX dynamic builds that occurred when re-initializing the posix module after a Py_Finalize if the environment had changed since the previous import posix. Patch by Benoît Hudson.

IDLE

bpo-38944 [https://bugs.python.org/issue?@action=redirect&bpo=38944]: 现在按 Escape 键可以关闭 IDLE 的补全窗口。由 Johnny Najera 提供补丁。

bpo-38943 [https://bugs.python.org/issue?@action=redirect&bpo=38943]: 修复了在某些系统上 IDLE 自动补全窗口不总是出现的问题。由 Johnny Najera 提供补丁。

bpo-38862 [https://bugs.python.org/issue?@action=redirect&bpo=38862]: 格式菜单上的 '去除尾部空白' 现在会去除非 shell 文件末尾的额外换行符。

bpo-38636 [https://bugs.python.org/issue?@action=redirect&bpo=38636]: 修复 IDLE 格式菜单的标签切换和文件缩进宽度。这些功能（默认快捷键 Alt-T 和 Alt-U）在 3.7.5 和 3.8.0 中被错误地禁用。

C API

bpo-38896 [https://bugs.python.org/issue?@action=redirect&bpo=38896]: 移除 PyUnicode_ClearFreeList() 函数：Unicode 空闲列表已在 Python 3.3 中移除。

bpo-37340 [https://bugs.python.org/issue?@action=redirect&bpo=37340]: 移除 PyMethod_ClearFreeList() 和 PyCFunction_ClearFreeList() 函数：绑定方法对象的空闲列表已被移除。

bpo-38835 [https://bugs.python.org/issue?@action=redirect&bpo=38835]: 从 Py_LIMITED_API (稳定 API) 中排除 pyfpe.h 的 PyFPE_START_PROTECT() 和 PyFPE_END_PROTECT() 宏。

Python 3.9.0 alpha 1

发布日期: 2019-11-19

安全性

bpo-38722 [https://bugs.python.org/issue?@action=redirect&bpo=38722]: runpy 现在使用 io.open_code() 来打开代码文件。由 Jason Killen 提供补丁。

bpo-38622 [https://bugs.python.org/issue?@action=redirect&bpo=38622]: 为 ctypes 模块添加额外的审计事件。

bpo-38418 [https://bugs.python.org/issue?@action=redirect&bpo=38418]: 修复 os.system() 的审计事件名称为 os.system。

bpo-38243 [https://bugs.python.org/issue?@action=redirect&bpo=38243]: Escape the server title of xmlrpc.server.DocXMLRPCServer when rendering the document page as HTML. (Contributed by Dong-hee Na in bpo-38243 [https://bugs.python.org/issue?@action=redirect&bpo=38243].)

bpo-38174 [https://bugs.python.org/issue?@action=redirect&bpo=38174]: Update vendorized expat library version to 2.2.8, which resolves CVE-2019-15903.

bpo-37764 [https://bugs.python.org/issue?@action=redirect&bpo=37764]: 修复了 email._header_value_parser.get_unstructured 在特定情况下进入无限循环的问题，这些情况包括电子邮件头部没有尾随空白，以及包含无效编码字的情况。由 Ashwin Ramaswami 提供补丁。

bpo-37461 [https://bugs.python.org/issue?@action=redirect&bpo=37461]: 修复解析特别构造的电子邮件头部时出现的无限循环问题。补丁由 Abhilash Raj 提供。

bpo-37363 [https://bugs.python.org/issue?@action=redirect&bpo=37363]: 为一系列支持的运行命令添加审计事件（参见 命令行与环境）。

bpo-37463 [https://bugs.python.org/issue?@action=redirect&bpo=37463]: ssl.match_hostname() 不再接受 IPv4 地址后面附加额外文本，且仅接受不带尾随空格的四点表示法。某些 inet_aton() 实现会忽略空格及空格后的所有数据，例如 '127.0.0.1 whatever'。

bpo-37363 [https://bugs.python.org/issue?@action=redirect&bpo=37363]: Adds audit events for ensurepip, ftplib, glob, imaplib, nntplib, pdb, poplib, shutil, smtplib, sqlite3, subprocess, telnetlib, tempfile and webbrowser, as well as os.listdir(), os.scandir() and breakpoint().

bpo-37364 [https://bugs.python.org/issue?@action=redirect&bpo=37364]: 现在在读取 .pth 文件时使用 io.open_code()。

bpo-34631 [https://bugs.python.org/issue?@action=redirect&bpo=34631]: 在 Windows 安装程序中更新 OpenSSL 至 1.1.1c。

bpo-34155 [https://bugs.python.org/issue?@action=redirect&bpo=34155]: 修复解析包含多个 @ 的无效电子邮件地址（例如 a@b@c.com）时的问题，确保不会将第二个 @ 之前的部分作为有效电子邮件地址返回。由 maxking 和 jpic 提供补丁。

核心与内置函数

bpo-38631 [https://bugs.python.org/issue?@action=redirect&bpo=38631]: 在 float.__getformat__() 中将 Py_FatalError() 调用替换为常规的 RuntimeError 异常。

bpo-38639 [https://bugs.python.org/issue?@action=redirect&bpo=38639]: Optimized math.floor(), math.ceil() and math.trunc() for floats.

bpo-38640 [https://bugs.python.org/issue?@action=redirect&bpo=38640]: 修复了编译器中的一个bug，该bug在总是为假的while循环中存在break语句和continue语句时会引发错误。由Pablo Galindo提供补丁。

bpo-38613 [https://bugs.python.org/issue?@action=redirect&bpo=38613]: 优化了 dict_keys 的一些集合操作（例如 |、^、和 -）。d.keys() | other``之前比 ``set(d) | other 慢，但现在它们的性能几乎相同。

bpo-28029 [https://bugs.python.org/issue?@action=redirect&bpo=28029]: "".replace("", s, n)``现在对于所有非零 ``n 返回 s 而不是空字符串。bytes 和 bytearray 对象也有类似的更改。

bpo-38535 [https://bugs.python.org/issue?@action=redirect&bpo=38535]: 修复了装饰器中无参数调用的AST节点的行号和列偏移。

bpo-38525 [https://bugs.python.org/issue?@action=redirect&bpo=38525]: Fix a segmentation fault when using reverse iterators of empty dict objects. Patch by Dong-hee Na and Inada Naoki.

bpo-38465 [https://bugs.python.org/issue?@action=redirect&bpo=38465]: bytearray、array 和 mmap 对象现在允许一次导出超过 2**31 个缓冲区。

bpo-38469 [https://bugs.python.org/issue?@action=redirect&bpo=38469]: 修复了一个bug，即在存在 global 关键字时，命名表达式的作用域未被正确解析。由Pablo Galindo提供补丁。

bpo-38437 [https://bugs.python.org/issue?@action=redirect&bpo=38437]: 为解释器的调试版本（当设置 Py_DEBUG 时）激活 GC_DEBUG 宏。由Pablo Galindo提供补丁。

bpo-38379 [https://bugs.python.org/issue?@action=redirect&bpo=38379]: 当垃圾回收器进行回收时，其中一些对象复活（在执行完终结器后可以从隔离的循环外部访问），不要阻止回收所有仍然无法访问的对象。由Pablo Galindo和Tim Peters提供补丁。

bpo-38379 [https://bugs.python.org/issue?@action=redirect&bpo=38379]: 当循环垃圾回收（gc）运行终结器使无法访问的对象复活时，当前的gc运行结束，不收集任何循环垃圾。然而，collect()``和 ``get_stats() 报告的统计信息声称所有发现的循环垃圾都被回收了，并且复活的对象也被回收了。更改了统计信息以报告没有收集到任何对象。

bpo-38392 [https://bugs.python.org/issue?@action=redirect&bpo=38392]: 在调试模式下，PyObject_GC_Track() 现在会调用对象类型的 tp_traverse() 以确保对象有效：测试被 tp_traverse() 访问的对象是否有效。

bpo-38210 [https://bugs.python.org/issue?@action=redirect&bpo=38210]: Remove unnecessary intersection and update set operation in dictview with empty set. (Contributed by Dong-hee Na in bpo-38210 [https://bugs.python.org/issue?@action=redirect&bpo=38210].)

bpo-38402 [https://bugs.python.org/issue?@action=redirect&bpo=38402]: 检查系统底层 crypt 或 crypt_r 的错误。

bpo-37474 [https://bugs.python.org/issue?@action=redirect&bpo=37474]: On FreeBSD, Python no longer calls fedisableexcept() at startup to control the floating point control mode. The call became useless since FreeBSD 6: it became the default mode.

bpo-38006 [https://bugs.python.org/issue?@action=redirect&bpo=38006]: 修复了一个由于弱引用和循环垃圾收集器交互导致的错误。我们必须清除垃圾中的任何弱引用，以防止它们的回调执行并导致崩溃。

bpo-38317 [https://bugs.python.org/issue?@action=redirect&bpo=38317]: 修复警告选项的优先级：PyConfig.warnoptions 拥有最高优先级，如 PEP 587 [https://www.python.org/dev/peps/pep-0587] 所述。

bpo-38310 [https://bugs.python.org/issue?@action=redirect&bpo=38310]: 在主解释器循环中预测 BUILD_MAP_UNPACK_WITH_CALL -> CALL_FUNCTION_EX 操作码对。由 Brandt Bucher 提供补丁。

bpo-36871 [https://bugs.python.org/issue?@action=redirect&bpo=36871]: 改进了对模拟的 assert_has_calls 和 assert_has_awaits 方法的错误处理。修复了一个错误，其中在将预期调用绑定到模拟的规范时遇到的任何错误都被静默吞噬，导致误导性的错误输出。

bpo-11410 [https://bugs.python.org/issue?@action=redirect&bpo=11410]: 通过使用 gcc >= 4.0 中可用的可见性属性，在 POSIX 和 Windows 上以统一的方式提供了更好的符号可见性控制。POSIX 构建文件已更新，以使用 -fvisibility=hidden 编译，最小化导出的符号。

bpo-38219 [https://bugs.python.org/issue?@action=redirect&bpo=38219]: 针对参数为字典的情况优化了 dict 构造函数和 update() 方法。

bpo-38236 [https://bugs.python.org/issue?@action=redirect&bpo=38236]: 如果 Python 无法导入文件系统和标准 IO 编码的 Python 编解码器，现在会转储路径配置。

bpo-38013 [https://bugs.python.org/issue?@action=redirect&bpo=38013]: 允许为未启动的异步生成器助手调用 async_generator_athrow().throw(...)。这修复了在 asyncio.run() 调用结束时出现的烦人警告。

bpo-38124 [https://bugs.python.org/issue?@action=redirect&bpo=38124]: 修复了 PyState_AddModule 中的一个差一错误，该错误可能导致内存越界访问。

bpo-38116 [https://bugs.python.org/issue?@action=redirect&bpo=38116]: select 模块现在符合 PEP-384 标准，不再有静态状态。

bpo-38113 [https://bugs.python.org/issue?@action=redirect&bpo=38113]: ast 模块已更新至 PEP-384 标准，所有静态内容已被移除。

bpo-38076 [https://bugs.python.org/issue?@action=redirect&bpo=38076]: struct 模块现在兼容 PEP-384。

bpo-38075 [https://bugs.python.org/issue?@action=redirect&bpo=38075]: random 模块现在兼容 PEP-384。

bpo-38074 [https://bugs.python.org/issue?@action=redirect&bpo=38074]: zlib 模块已兼容 PEP-384。

bpo-38073 [https://bugs.python.org/issue?@action=redirect&bpo=38073]: 使 pwd 扩展模块兼容 PEP-384。

bpo-38072 [https://bugs.python.org/issue?@action=redirect&bpo=38072]: grp 模块已兼容 PEP-384。

bpo-38069 [https://bugs.python.org/issue?@action=redirect&bpo=38069]: 使 _posixsubprocess 兼容 PEP-384。

bpo-38071 [https://bugs.python.org/issue?@action=redirect&bpo=38071]: 使 termios 扩展模块兼容 PEP-384。

bpo-38005 [https://bugs.python.org/issue?@action=redirect&bpo=38005]: 修复了 InterpreterID 和 ChannelID 的比较和创建。

bpo-36946 [https://bugs.python.org/issue?@action=redirect&bpo=36946]: 修复了处理切片时可能发生的有符号整数溢出。由 hongweipeng 提供补丁。

bpo-37994 [https://bugs.python.org/issue?@action=redirect&bpo=37994]: 修复了在多个站点中如果属性查找失败时静默任意错误的问题。只有 AttributeError 应该被静默。

bpo-8425 [https://bugs.python.org/issue?@action=redirect&bpo=8425]: 优化了当另一个集合远大于基础集合时的集合 difference_update 操作。（由 Evgeny Kapun 建议，Michele Orrù 贡献代码）。

bpo-37966 [https://bugs.python.org/issue?@action=redirect&bpo=37966]: is_normalized() 的实现对于未规范化的字符串已经大大加速，这是通过实现 Unicode 标准中的完整规范化快速检查算法完成的。

bpo-37947 [https://bugs.python.org/issue?@action=redirect&bpo=37947]: 正确调整了命名表达式符号表生成中的递归级别。由 Pablo Galindo 提供补丁。

bpo-37812 [https://bugs.python.org/issue?@action=redirect&bpo=37812]: Object/longobject.c 中使用的 CHECK_SMALL_INT 宏已被替换为在每个调用站点显式的 return。

bpo-37751 [https://bugs.python.org/issue?@action=redirect&bpo=37751]: 修复 codecs.lookup() 以与 encodings.normalize_encoding() 相同的方式标准化编码名称，除了 codecs.lookup() 还将名称转换为小写。

bpo-37830 [https://bugs.python.org/issue?@action=redirect&bpo=37830]: 修复了当相应的 try 块包含带有非常量值的 return 时，在 finally 块中编译 break 和 continue 的问题。

bpo-20490 [https://bugs.python.org/issue?@action=redirect&bpo=20490]: 通过Anthony Sottile的贡献，改进了循环 from 导入时部分初始化模块的导入错误消息。

bpo-37840 [https://bugs.python.org/issue?@action=redirect&bpo=37840]: 修复了 bytearray 的 sq_item 中负索引的处理。由Sergey Fedoseev提供补丁。

bpo-37802 [https://bugs.python.org/issue?@action=redirect&bpo=37802]: 略微提高了 PyLong_FromUnsignedLong()、PyLong_FromUnsignedLongLong() 和 PyLong_FromSize_t() 的性能。由Sergey Fedoseev提供补丁。

bpo-37409 [https://bugs.python.org/issue?@action=redirect&bpo=37409]: 确保在交互式会话和没有父包的脚本中，显式相对导入总是引发ImportError，而不是将当前模块视为包。由Ben Lewis提供补丁。

bpo-32912 [https://bugs.python.org/issue?@action=redirect&bpo=32912]: 回退了 bpo-32912 [https://bugs.python.org/issue?@action=redirect&bpo=32912]：对于字符串和字节字面量中的无效转义序列，现在发出 SyntaxWarning 而不是 DeprecationWarning。

bpo-37757 [https://bugs.python.org/issue?@action=redirect&bpo=37757]: PEP 572 [https://www.python.org/dev/peps/pep-0572]: 如PEP所述，当赋值表达式与理解作用域的交互导致目标作用域不明确时，现在会引发 SyntaxError。

最初由PEP提出的 TargetScopeError 子类已被移除，改为仅对不允许的情况引发常规语法错误。

bpo-36279 [https://bugs.python.org/issue?@action=redirect&bpo=36279]: 修复了 os.wait3() 中可能使用未初始化内存的问题。

bpo-36311 [https://bugs.python.org/issue?@action=redirect&bpo=36311]: 解码大于2GiB的字节对象更快，并且当多字节字符跨越块边界时不再失败。

bpo-34880 [https://bugs.python.org/issue?@action=redirect&bpo=34880]: 如果 AssertionError 异常被遮蔽，assert 语句现在可以正常工作。由Zackery Spytz提供补丁。

bpo-37340 [https://bugs.python.org/issue?@action=redirect&bpo=37340]: 移除了绑定方法对象（free_list）的对象缓存。由于 LOAD_METHOD 操作码和 _PyObject_VectorcallMethod C API 的存在，临时绑定方法对象的使用比以前少。

bpo-37648 [https://bugs.python.org/issue?@action=redirect&bpo=37648]: 修复了 list.__contains__()、tuple.__contains__() 及其他几处的小不一致性。集合的项现在始终位于 == 的左侧，而针位于右侧。

bpo-37444 [https://bugs.python.org/issue?@action=redirect&bpo=37444]: 更新了 builtins.__import__() 和 importlib.__import__() 之间的异常差异。

bpo-37619 [https://bugs.python.org/issue?@action=redirect&bpo=37619]: 当将包装描述符从一个类添加到另一个类时（例如，在 int 子类上设置 __add__ = str.__add__），调用操作符时会正确引发异常。

bpo-37593 [https://bugs.python.org/issue?@action=redirect&bpo=37593]: 在 ast.parameters 节点的构造函数中交换了 posonlyargs 和 args 参数的位置。

bpo-37543 [https://bugs.python.org/issue?@action=redirect&bpo=37543]: 为非 PGO 构建优化了 pymalloc。

bpo-37537 [https://bugs.python.org/issue?@action=redirect&bpo=37537]: 在 _Py_GetAllocatedBlocks() 内部计算分配的 pymalloc 块。这减慢了 _Py_GetAllocatedBlocks() 的速度，但为 _PyObject_Malloc() 和 _PyObject_Free() 带来了小幅加速。

bpo-37467 [https://bugs.python.org/issue?@action=redirect&bpo=37467]: 修复了 sys.excepthook() 和 PyErr_Display()，如果文件名是字节字符串。例如，对于文件名属性是字节字符串的 SyntaxError 异常。

bpo-37433 [https://bugs.python.org/issue?@action=redirect&bpo=37433]: 修复了 SyntaxError 指示器在多行字符串中打印过多空格的问题 - 由 Anthony Sottile 提供。

bpo-37417 [https://bugs.python.org/issue?@action=redirect&bpo=37417]: bytearray.extend() 现在正确处理了迭代过程中出现的错误。由 Brandt Bucher 提供补丁。

bpo-37414 [https://bugs.python.org/issue?@action=redirect&bpo=37414]: 未文档化的 sys.callstats() 函数已被移除。自 Python 3.7 起，它已被弃用，并总是返回 None。它需要一个特殊的构建选项 CALL_PROFILE，该选项已在 Python 3.7 中移除。

bpo-37392 [https://bugs.python.org/issue?@action=redirect&bpo=37392]: 移除 sys.getcheckinterval() 和 sys.setcheckinterval() 函数。这两个函数自 Python 3.2 起已被弃用。请改用 sys.getswitchinterval() 和 sys.setswitchinterval()。同时移除 PyInterpreterState 结构中的 check_interval 字段。

bpo-37388 [https://bugs.python.org/issue?@action=redirect&bpo=37388]: 在开发模式和调试构建中，现在会对字符串编码和解码操作的 encoding 和 errors 参数进行检查。例如：open()、str.encode() 和 bytes.decode()。

默认情况下，为了获得最佳性能，errors 参数仅在第一次编码/解码错误时检查，encoding 参数有时会为空字符串忽略。

bpo-37348 [https://bugs.python.org/issue?@action=redirect&bpo=37348]: 优化了使用 UTF-8 和 ASCII 编解码器解码短 ASCII 字符串的性能。b"foo".decode() 大约快了 15%。由 Inada Naoki 提供补丁。

bpo-24214 [https://bugs.python.org/issue?@action=redirect&bpo=24214]: 改进了 UTF-8 和 UTF-16 增量解码器中对 surrogatepass 错误处理程序的支持。

bpo-37330 [https://bugs.python.org/issue?@action=redirect&bpo=37330]: open()、io.open()、codecs.open() 和 fileinput.FileInput 不再接受文件模式中的 'U' ("通用换行") 。此标志自 Python 3.3 起已被弃用。

bpo-35224 [https://bugs.python.org/issue?@action=redirect&bpo=35224]: 按照 PEP 572 的提议，反向评估字典推导式中 key: value 的求值顺序。即在 {k: v for ...} 中，k 将在 v 之前被评估。

bpo-37316 [https://bugs.python.org/issue?@action=redirect&bpo=37316]: 修复了 mmap.mmap 中的 PySys_Audit() 调用。

bpo-37300 [https://bugs.python.org/issue?@action=redirect&bpo=37300]: 移除了 classobject.c 中一个不必要的 Py_XINCREF。

bpo-37269 [https://bugs.python.org/issue?@action=redirect&bpo=37269]: 修复了窥孔优化器中的一个错误，该错误未正确处理带有二元运算符的常量条件。补丁由 Pablo Galindo 提供。

bpo-20443 [https://bugs.python.org/issue?@action=redirect&bpo=20443]: Python 现在获取命令行中指定的脚本文件名的绝对路径（例如：“python3 script.py”）：__main__ 模块的 __file__ 属性和 sys.path[0] 现在变为绝对路径，而非相对路径。

bpo-37257 [https://bugs.python.org/issue?@action=redirect&bpo=37257]: Python的小对象分配器（obmalloc.c）现在允许（不超过）一个空arena保持可用以便立即重用，而不将其返回给操作系统。这防止了在简单循环中可能每次迭代都创建和销毁一个新arena的颠簸现象。

bpo-37231 [https://bugs.python.org/issue?@action=redirect&bpo=37231]: 类型槽到特殊方法的派发（例如在执行 x * y 时调用 __mul__）已经变得更快。

bpo-36974 [https://bugs.python.org/issue?@action=redirect&bpo=36974]: 为内置函数和方法的所有调用约定实现了单独的vectorcall函数。这提高了调用的性能。

bpo-37213 [https://bugs.python.org/issue?@action=redirect&bpo=37213]: 在窥孔优化器中正确处理负的行偏移。由Pablo Galindo提供补丁。

bpo-37219 [https://bugs.python.org/issue?@action=redirect&bpo=37219]: 移除了空集差异的错误优化。

bpo-15913 [https://bugs.python.org/issue?@action=redirect&bpo=15913]: 实现了 PyBuffer_SizeFromFormat() 函数（之前有文档记录但未实现）：调用 struct.calcsize()。由Joannah Nanjekye提供补丁。

bpo-36922 [https://bugs.python.org/issue?@action=redirect&bpo=36922]: 槽函数优化了任何带有 Py_TPFLAGS_METHOD_DESCRIPTOR 的可调用对象，而不仅仅是 function 的实例。

bpo-36974 [https://bugs.python.org/issue?@action=redirect&bpo=36974]: 槽 tp_vectorcall_offset 被无条件继承以支持当基类使用vectorcall时的``super().__call__()``。

bpo-37160 [https://bugs.python.org/issue?@action=redirect&bpo=37160]: threading.get_native_id() 现在也支持NetBSD。

bpo-37077 [https://bugs.python.org/issue?@action=redirect&bpo=37077]: 为AIX添加了 threading.get_native_id() 支持。由M. Felt提供补丁

bpo-36781 [https://bugs.python.org/issue?@action=redirect&bpo=36781]: sum() 已经为布尔值进行了优化。

bpo-34556 [https://bugs.python.org/issue?@action=redirect&bpo=34556]: 向venv模块添加了 --upgrade-deps。由Cooper Ry Lees提供补丁

bpo-20523 [https://bugs.python.org/issue?@action=redirect&bpo=20523]: pdb.Pdb 支持Windows 7中的~/.pdbrc。由Tim Hopper和Dan Lidral-Porter提供补丁。

bpo-35551 [https://bugs.python.org/issue?@action=redirect&bpo=35551]: 更新了编码：- 移除了“tis260”编码，这是一个不存在的“tactis”编解码器的别名。- 添加了“mac_centeuro”作为mac_latin2编码的别名。

bpo-19072 [https://bugs.python.org/issue?@action=redirect&bpo=19072]: classmethod 装饰器现在可以包装其他描述符，如property对象。根据Graham Dumpleton编写的补丁改编。

bpo-27575 [https://bugs.python.org/issue?@action=redirect&bpo=27575]: 通过直接使用集合交集逻辑提高字典视图交集的速度。由David Su提供补丁。

bpo-30773 [https://bugs.python.org/issue?@action=redirect&bpo=30773]: 禁止并行运行aclose() / asend() / athrow()。修复ag_running以反映AG的实际运行状态。

库

bpo-36589 [https://bugs.python.org/issue?@action=redirect&bpo=36589]: 现在，curses.update_lines_cols() 函数在成功时返回 None 而不是``1``。

bpo-38807 [https://bugs.python.org/issue?@action=redirect&bpo=38807]: 更新 TypeError 消息，为 os.path.join() 包括 os.PathLike 对象作为可接受的输入类型。

bpo-38724 [https://bugs.python.org/issue?@action=redirect&bpo=38724]: 为 subprocess.Popen 对象添加repr。由Andrey Doroschenko提供补丁。

bpo-38786 [https://bugs.python.org/issue?@action=redirect&bpo=38786]: pydoc现在可以识别并解析HTTPS URL。由python273提供补丁。

bpo-38785 [https://bugs.python.org/issue?@action=redirect&bpo=38785]: 如果从 asyncio.Future 派生的对象的构造函数中没有调用父 __init__，则防止asyncio崩溃。

bpo-38723 [https://bugs.python.org/issue?@action=redirect&bpo=38723]: pdb 现在使用 io.open_code() 来触发审计事件。

bpo-27805 [https://bugs.python.org/issue?@action=redirect&bpo=27805]: 允许以追加模式打开管道和其他不可寻址的文件，使用 open()。

bpo-38438 [https://bugs.python.org/issue?@action=redirect&bpo=38438]: 简化 argparse 对于 nargs="*" 的使用信息。

bpo-38761 [https://bugs.python.org/issue?@action=redirect&bpo=38761]: WeakSet现在被注册为collections.abc.MutableSet。

bpo-38716 [https://bugs.python.org/issue?@action=redirect&bpo=38716]: logging: 将RotatingHandler的namer和rotator更改为类级别属性。这会阻止__init__在子类用同名方法定义它们的情况下将它们设置为None。

bpo-38713 [https://bugs.python.org/issue?@action=redirect&bpo=38713]: Add os.P_PIDFD constant, which may be passed to os.waitid() to wait on a Linux process file descriptor.

bpo-38692 [https://bugs.python.org/issue?@action=redirect&bpo=38692]: 添加 asyncio.PidfdChildWatcher，一个特定于Linux的子监视器实现，它轮询进程文件描述符。

bpo-38692 [https://bugs.python.org/issue?@action=redirect&bpo=38692]: 将Linux的 pidfd_open 系统调用暴露为 os.pidfd_open()。

bpo-38602 [https://bugs.python.org/issue?@action=redirect&bpo=38602]: Added constants F_OFD_GETLK, F_OFD_SETLK and F_OFD_SETLKW to the fcntl module. Patch by Dong-hee Na.

bpo-38334 [https://bugs.python.org/issue?@action=redirect&bpo=38334]: 修复了在加密的 zipfile.ZipExtFile 上向后查找的问题。

bpo-38312 [https://bugs.python.org/issue?@action=redirect&bpo=38312]: 添加 curses.get_escdelay()、curses.set_escdelay()、curses.get_tabsize() 和 curses.set_tabsize() 函数 - 由 Anthony Sottile 提供。

bpo-38586 [https://bugs.python.org/issue?@action=redirect&bpo=38586]: 现在 fileConfig() 正确设置了加载的处理程序的 .name。

bpo-38565 [https://bugs.python.org/issue?@action=redirect&bpo=38565]: 为 functools.lru_cache() 添加新的 cache_parameters() 方法，以更好地支持 pickle。

bpo-34679 [https://bugs.python.org/issue?@action=redirect&bpo=34679]: asynci.ProactorEventLoop.close() 现在只在主线程中调用 signal.set_wakeup_fd()。

bpo-31202 [https://bugs.python.org/issue?@action=redirect&bpo=31202]: pathlib.WindowsPath.glob() 的结果现在匹配字面部分的大小写。

bpo-36321 [https://bugs.python.org/issue?@action=redirect&bpo=36321]: 移除拼写错误的属性。3.8 的变更日志指出这将在 3.9 中移除。

bpo-38521 [https://bugs.python.org/issue?@action=redirect&bpo=38521]: 修复了 statistics.NormalDist() 中的错误等式比较。

bpo-38493 [https://bugs.python.org/issue?@action=redirect&bpo=38493]: Added CLD_KILLED and CLD_STOPPED for si_code. Patch by Dong-hee Na.

bpo-38478 [https://bugs.python.org/issue?@action=redirect&bpo=38478]: 修复了 inspect.signature.bind() 中的一个 bug，该 bug 导致处理与位置唯一参数同名的关键字参数时失败。由 Pablo Galindo 提供补丁。

bpo-33604 [https://bugs.python.org/issue?@action=redirect&bpo=33604]: Fixed hmac.new and hmac.HMAC to raise TypeError instead of ValueError when the digestmod parameter, now required in 3.8, is omitted. Also clarified the hmac module documentation and docstrings.

bpo-38378 [https://bugs.python.org/issue?@action=redirect&bpo=38378]: os.sendfile() 的参数 out 和 in 被重命名为 out_fd 和 in_fd。

bpo-38417 [https://bugs.python.org/issue?@action=redirect&bpo=38417]: 在 POSIX 系统上为子进程添加了设置 umask 的支持到 subprocess 模块。

bpo-38449 [https://bugs.python.org/issue?@action=redirect&bpo=38449]: 撤销 PR 15522，由于对文件名作为 url 的不正确处理，导致 mimetypes.guess_type() 中的回归。

bpo-38431 [https://bugs.python.org/issue?@action=redirect&bpo=38431]: 修复 dataclasses.InitVar 的 __repr__ 方法以支持类型对象，补丁由 Samuel Colvin 提供。

bpo-38109 [https://bugs.python.org/issue?@action=redirect&bpo=38109]: Add missing stat.S_IFDOOR, stat.S_IFPORT, stat.S_IFWHT, stat.S_ISDOOR(), stat.S_ISPORT(), and stat.S_ISWHT() values to the Python implementation of stat.

bpo-38422 [https://bugs.python.org/issue?@action=redirect&bpo=38422]: 澄清 pathlib 后缀(es) 的文档字符串。

bpo-38405 [https://bugs.python.org/issue?@action=redirect&bpo=38405]: 现在 typing.NamedTuple 的嵌套子类可以被 pickle。

bpo-38332 [https://bugs.python.org/issue?@action=redirect&bpo=38332]: Prevent KeyError thrown by _encoded_words.decode() when given an encoded-word with invalid content-type encoding from propagating all the way to email.message.get().

bpo-38371 [https://bugs.python.org/issue?@action=redirect&bpo=38371]: Deprecated the split() method in _tkinter.TkappType in favour of the splitlist() method which has more consistent and predicable behavior.

bpo-38341 [https://bugs.python.org/issue?@action=redirect&bpo=38341]: 将 smtplib.SMTPNotSupportedError 添加到 smtplib 的导出名称中。

bpo-38319 [https://bugs.python.org/issue?@action=redirect&bpo=38319]: 在 socket 和 shutil 模块中使用的 sendfile() 在 32 位架构上对于 >= 2GiB 的文件会引发 OverflowError。（由 Giampaolo Rodola 提供补丁）

bpo-38242 [https://bugs.python.org/issue?@action=redirect&bpo=38242]: 回滚新的 asyncio Streams API

bpo-13153 [https://bugs.python.org/issue?@action=redirect&bpo=13153]: 现在使用操作系统原生编码在 Python 字符串和 Tcl 对象之间进行转换。这允许显示、复制和粘贴到剪贴板的 emoji 和其他非 BMP 字符。从现在开始，从 Tcl 到 Python 以及反向的字符串转换永远不会失败（除了 MemoryError）。

bpo-38019 [https://bugs.python.org/issue?@action=redirect&bpo=38019]: 正确处理已关闭的 asyncio unix 管道的暂停/恢复读取。

bpo-38163 [https://bugs.python.org/issue?@action=redirect&bpo=38163]: 子 mock 现在会检测它们的类型是同步还是异步的，异步子 mock 将是 AsyncMocks，同步子 mock 将是 MagicMock 或 Mock（取决于它们的父类型）。

bpo-38161 [https://bugs.python.org/issue?@action=redirect&bpo=38161]: 从 AsyncMock 中移除 _AwaitEvent。

bpo-38216 [https://bugs.python.org/issue?@action=redirect&bpo=38216]: Allow the rare code that wants to send invalid http requests from the http.client library a way to do so. The fixes for bpo-30458 [https://bugs.python.org/issue?@action=redirect&bpo=30458] led to breakage for some projects that were relying on this ability to test their own behavior in the face of bad requests.

bpo-28286 [https://bugs.python.org/issue?@action=redirect&bpo=28286]: 弃用隐式打开 GzipFile 进行写入的操作。 写入时始终指定 mode 参数。

bpo-38108 [https://bugs.python.org/issue?@action=redirect&bpo=38108]: 现在，AsyncMock 上的任何同步魔术方法都返回一个 MagicMock。MagicMock 上的任何异步魔术方法都返回一个 AsyncMock。

bpo-38265 [https://bugs.python.org/issue?@action=redirect&bpo=38265]: 更新 os.pread() 的 length 参数，接受 Py_ssize_t 而不是 int。

bpo-38112 [https://bugs.python.org/issue?@action=redirect&bpo=38112]: compileall 具有更高的默认递归限制和新的命令行参数，用于路径操作、符号链接处理和多级优化。

bpo-38248 [https://bugs.python.org/issue?@action=redirect&bpo=38248]: asyncio: 修复了立即任务取消不一致的问题

bpo-38237 [https://bugs.python.org/issue?@action=redirect&bpo=38237]: 内置 pow 函数的参数更具描述性。现在也可以通过关键字传递这些参数。

bpo-34002 [https://bugs.python.org/issue?@action=redirect&bpo=34002]: 通过将 while-pop 改为 for 循环，使用 isdisjoint 而不是集合交集，提高了 email 包中部分的效率。

bpo-38191 [https://bugs.python.org/issue?@action=redirect&bpo=38191]: NamedTuple 和 TypedDict 类型的构造函数现在接受任意关键字参数名称，包括 "cls"、"self"、"typename"、"_typename"、"fields" 和 "_fields"。

bpo-38155 [https://bugs.python.org/issue?@action=redirect&bpo=38155]: 向 datetime 添加 __all__。由 Tahia Khan 提供补丁。

bpo-38185 [https://bugs.python.org/issue?@action=redirect&bpo=38185]: 修复了 sqlite3.Row 索引中不区分大小写的字符串比较。

bpo-38136 [https://bugs.python.org/issue?@action=redirect&bpo=38136]: 将 AsyncMock 的调用计数和等待计数更改为两个不同的计数器。现在等待计数仅在协程被等待时计数，而不是在被调用时，反之亦然。更新了相关文档。

bpo-37828 [https://bugs.python.org/issue?@action=redirect&bpo=37828]: 修复了 unittest.mock.Mock.assert_called() 异常中的默认模拟名称。补丁由 Abraham Toriz Cruz 提供。

bpo-38175 [https://bugs.python.org/issue?@action=redirect&bpo=38175]: 修复了 sqlite3.Row 对象比较中的内存泄漏。

bpo-33936 [https://bugs.python.org/issue?@action=redirect&bpo=33936]: _hashlib 不再调用 OpenSSL 1.1.0+ 中过时的 OpenSSL 初始化函数。

bpo-34706 [https://bugs.python.org/issue?@action=redirect&bpo=34706]: 在 inspect.Signature.from_callable 中保留子类化。

bpo-38153 [https://bugs.python.org/issue?@action=redirect&bpo=38153]: OpenSSL的哈希算法名称现在被规范化以遵循Python的命名约定。例如，OpenSSL使用sha3-512而不是sha3_512，或使用blake2b512而不是blake2b。

bpo-38115 [https://bugs.python.org/issue?@action=redirect&bpo=38115]: 修复了dis.findlinestarts()中的一个错误，该错误会导致返回无效的字节码偏移量。记录了代码对象的co_lnotab可能包含无效字节码偏移量的情况。

bpo-38148 [https://bugs.python.org/issue?@action=redirect&bpo=38148]: 向 asyncio 传输类添加插槽，可以减少内存使用。

bpo-38142 [https://bugs.python.org/issue?@action=redirect&bpo=38142]: _hashlib OpenSSL包装器扩展模块现在符合PEP-384标准。

bpo-9216 [https://bugs.python.org/issue?@action=redirect&bpo=9216]: hashlib构造函数现在支持usedforsecurity标志，以指示哈希算法不用于安全上下文。

bpo-36991 [https://bugs.python.org/issue?@action=redirect&bpo=36991]: 修复了在某些不支持的输入错误情况下，ZipFile.extract()可能错误地抛出AttributeError异常的问题。

bpo-38134 [https://bugs.python.org/issue?@action=redirect&bpo=38134]: 移除了过时的PBKDF2_HMAC_fast副本。所有支持的OpenSSL版本都包含快速实现。

bpo-38132 [https://bugs.python.org/issue?@action=redirect&bpo=38132]: OpenSSL的hashlib包装器使用了更简单的实现。几个宏和无用的缓存已被移除。哈希名称现在来自OpenSSL的EVP。算法名称保持不变，除了现在总是小写。

bpo-38008 [https://bugs.python.org/issue?@action=redirect&bpo=38008]: 修复了协议中的父类检查，以正确识别提供内置协议的模块，而不是假设它们都来自 collections.abc 模块。

bpo-34037 [https://bugs.python.org/issue?@action=redirect&bpo=34037]: 对于 asyncio，添加了一个新的协程 loop.shutdown_default_executor()。这个新协程提供了一个API来安排执行器的关闭，等待线程池关闭完成。此外，asyncio.run() 已被更新以利用这个新协程。补丁由Kyle Stanley提供。

bpo-37405 [https://bugs.python.org/issue?@action=redirect&bpo=37405]: 通过返回1元组而不是字符串，修复了非CAN_ISOTP AF_CAN地址族套接字的socket.getsockname()的回归错误。

bpo-38121 [https://bugs.python.org/issue?@action=redirect&bpo=38121]: 更新了importlib.metadata中函数的参数名称，与importlib_metadata 0.22版本的更改相匹配。

bpo-38110 [https://bugs.python.org/issue?@action=redirect&bpo=38110]: os.closewalk() 实现现在在可用平台上使用 libc fdwalk() API。

bpo-38093 [https://bugs.python.org/issue?@action=redirect&bpo=38093]: 修复 AsyncMock，使其在使用 AsyncContextManagers 或 AsyncIterators 时不会崩溃。

bpo-37488 [https://bugs.python.org/issue?@action=redirect&bpo=37488]: 向 datetime.utctimetuple(), datetime.utcnow() 和 datetime.utcfromtimestamp() 添加警告。

bpo-35640 [https://bugs.python.org/issue?@action=redirect&bpo=35640]: 允许将 path-like object 作为 directory 参数传递给 http.server.SimpleHTTPRequestHandler 类。由 Géry Ogam 提供的补丁。

bpo-38086 [https://bugs.python.org/issue?@action=redirect&bpo=38086]: 使用来自 importlib_metadata 0.21 [https://gitlab.com/python-devs/importlib_metadata/blob/0.21/importlib_metadata/docs/changelog.rst] 的更改更新 importlib.metadata。

bpo-37251 [https://bugs.python.org/issue?@action=redirect&bpo=37251]: Remove __code__ check in AsyncMock that incorrectly evaluated function specs as async objects but failed to evaluate classes with __await__ but no __code__ attribute defined as async objects.

bpo-38037 [https://bugs.python.org/issue?@action=redirect&bpo=38037]: 修复 signal 模块中的引用计数器。

bpo-38066 [https://bugs.python.org/issue?@action=redirect&bpo=38066]: 隐藏 asyncio.Stream 的内部方法：feed_eof(), feed_data(), set_exception() 和 set_transport()。

bpo-38059 [https://bugs.python.org/issue?@action=redirect&bpo=38059]: inspect.py 现在使用 sys.exit() 而不是 exit()。

bpo-38049 [https://bugs.python.org/issue?@action=redirect&bpo=38049]: 为 ast 模块添加了命令行界面。

bpo-37953 [https://bugs.python.org/issue?@action=redirect&bpo=37953]: 在 typing 中，改进了 ForwardReferences 的 __hash__ 和 __eq__ 方法。

bpo-38026 [https://bugs.python.org/issue?@action=redirect&bpo=38026]: 修复了 inspect.getattr_static() 在使用 isinstance 时应避免动态查找的问题。

bpo-35923 [https://bugs.python.org/issue?@action=redirect&bpo=35923]: Update importlib.machinery.BuiltinImporter to use loader._ORIGIN instead of a hardcoded value. Patch by Dong-hee Na.

bpo-38010 [https://bugs.python.org/issue?@action=redirect&bpo=38010]: 在 importlib.metadata 中与 importlib_metadata 0.20 同步，澄清 files() 的行为并修复 requires() 在 dist-info 包上只返回一个要求的问题。

bpo-38006 [https://bugs.python.org/issue?@action=redirect&bpo=38006]: weakref.WeakValueDictionary 定义了一个局部 remove() 函数，用作弱引用的回调。这个函数是通过闭包创建的。修改实现以避免闭包。

bpo-37995 [https://bugs.python.org/issue?@action=redirect&bpo=37995]: 向 ast.dump() 添加了 indent 选项，允许其产生多行缩进的输出。

bpo-34410 [https://bugs.python.org/issue?@action=redirect&bpo=34410]: 修复了重新进入 tee() 迭代器时的崩溃问题。现在在这种情况下会抛出 RuntimeError。

bpo-37140 [https://bugs.python.org/issue?@action=redirect&bpo=37140]: 修复了 Python 3.8 的一个 ctypes 回归问题。当 ctypes.Structure 通过拷贝传递给函数时，ctypes 内部创建了一个临时对象，这个临时对象的副作用是调用了结构体的终结器（__del__）两次。Python 语义要求终结器只被调用一次。修复 ctypes 内部不再两次调用终结器。

bpo-37587 [https://bugs.python.org/issue?@action=redirect&bpo=37587]: 当 JSON 字符串中有许多反斜杠转义字符时，_json.scanstring 现在快了多达 3 倍。

bpo-37834 [https://bugs.python.org/issue?@action=redirect&bpo=37834]: 防止在没有 fd 系统调用支持的非 Windows 系统（如旧版本的 macOS）上构建时 shutil.rmtree 抛出异常。

bpo-10978 [https://bugs.python.org/issue?@action=redirect&bpo=10978]: 信号量和 BoundedSemaphores 现在可以一次释放多个等待的线程。

bpo-37972 [https://bugs.python.org/issue?@action=redirect&bpo=37972]: Subscripts to the unittest.mock.call objects now receive the same chaining mechanism as any other custom attributes, so that the following usage no longer raises a TypeError:

call().foo().__getitem__('bar')

由 blhsing 提供补丁

bpo-37965 [https://bugs.python.org/issue?@action=redirect&bpo=37965]: 修复由 distutils.ccompiler.CCompiler.has_function 引起的 C 编译器警告。

bpo-37964 [https://bugs.python.org/issue?@action=redirect&bpo=37964]: 向 fcntl 添加 F_GETPATH 命令。

bpo-37960 [https://bugs.python.org/issue?@action=redirect&bpo=37960]: 缓冲流和文本流的 repr() 现在在获取 "name" 和 "mode" 属性值时只静默预期的异常。

bpo-37961 [https://bugs.python.org/issue?@action=redirect&bpo=37961]: 向 tracemalloc 模块收集的跟踪添加一个 total_nframe 字段。这个字段表示在被截断之前的原始帧数。

bpo-37951 [https://bugs.python.org/issue?@action=redirect&bpo=37951]: subprocess模块的大部分功能现在在子解释器中再次可用。仅在子解释器中限制了*preexec_fn*。

bpo-36205 [https://bugs.python.org/issue?@action=redirect&bpo=36205]: 修复time.process_time()的rusage实现，正确报告系统和用户CPU时间的总和。

bpo-37950 [https://bugs.python.org/issue?@action=redirect&bpo=37950]: 修复 ast.dump() 在调用未完全初始化的节点时的行为。

bpo-34679 [https://bugs.python.org/issue?@action=redirect&bpo=34679]: 恢复从非主线程实例化Windows IOCP事件循环的能力。

bpo-36917 [https://bugs.python.org/issue?@action=redirect&bpo=36917]: Add default implementation of the ast.NodeVisitor.visit_Constant() method which emits a deprecation warning and calls corresponding methody visit_Num(), visit_Str(), etc.

bpo-37798 [https://bugs.python.org/issue?@action=redirect&bpo=37798]: Update test_statistics.py to verify that the statistics module works well for both C and Python implementations. Patch by Dong-hee Na

bpo-26589 [https://bugs.python.org/issue?@action=redirect&bpo=26589]: 向http模块添加了一个新的状态码：451 UNAVAILABLE_FOR_LEGAL_REASONS。

bpo-37915 [https://bugs.python.org/issue?@action=redirect&bpo=37915]: 修复在比较 datetime.timezone 和 datetime.tzinfo 对象实例时出现的段错误。由Pablo Galindo提供补丁。

bpo-32554 [https://bugs.python.org/issue?@action=redirect&bpo=32554]: 弃用在random.seed()中对任意类型调用hash的行为。

bpo-9938 [https://bugs.python.org/issue?@action=redirect&bpo=9938]: 为 ArgumentParser 添加可选关键字参数 exit_on_error。

bpo-37851 [https://bugs.python.org/issue?@action=redirect&bpo=37851]: faulthandler 模块不再在Python启动时分配其替代堆栈。现在堆栈仅在首次使用faulthandler时分配。

bpo-32793 [https://bugs.python.org/issue?@action=redirect&bpo=32793]: 修复当调用 smtplib.SMTP.connect() 时出现的重复调试消息。

bpo-37885 [https://bugs.python.org/issue?@action=redirect&bpo=37885]: venv: 在deactivate时不生成未设置变量警告。

bpo-37868 [https://bugs.python.org/issue?@action=redirect&bpo=37868]: 修复dataclasses.is_dataclass，当给定一个在__getattr__中从不引发AttributeError的实例时。也就是说，一个对象即使不是dataclass，也为__dataclass_fields__返回某些内容。

bpo-37811 [https://bugs.python.org/issue?@action=redirect&bpo=37811]: 修复 socket 模块的 socket.connect(address) 函数在系统调用中断时无法建立连接的问题。此问题在所有 poll(2) 系统调用仅接受非负整数和-1作为超时值的操作系统上观察到。

bpo-37863 [https://bugs.python.org/issue?@action=redirect&bpo=37863]: Tim Peters 提出的对 Fraction.__hash__ 的优化建议。

bpo-21131 [https://bugs.python.org/issue?@action=redirect&bpo=21131]: 修复 faulthandler.register(chain=True) 堆栈。faulthandler 现在分配一个专用的 SIGSTKSZ*2 字节堆栈，而不是仅 SIGSTKSZ 字节。在某些平台上，调用 faulthandler 信号处理程序中的先前信号处理程序使用的堆栈内存超过 SIGSTKSZ 字节。

bpo-37798 [https://bugs.python.org/issue?@action=redirect&bpo=37798]: Add C fastpath for statistics.NormalDist.inv_cdf() Patch by Dong-hee Na

bpo-37804 [https://bugs.python.org/issue?@action=redirect&bpo=37804]: Remove the deprecated method threading.Thread.isAlive(). Patch by Dong-hee Na.

bpo-37819 [https://bugs.python.org/issue?@action=redirect&bpo=37819]: 添加 Fraction.as_integer_ratio() 以匹配 bool、int、float 和 decimal 中的相应方法。

bpo-14465 [https://bugs.python.org/issue?@action=redirect&bpo=14465]: 为美化打印 XML 树添加 xml.etree.ElementTree.indent() 函数。由 Stefan Behnel 贡献。

bpo-37810 [https://bugs.python.org/issue?@action=redirect&bpo=37810]: 修复 difflib 在处理制表符时 diff 输出中的 ? 提示。由 Anthony Sottile 提供补丁。

bpo-37772 [https://bugs.python.org/issue?@action=redirect&bpo=37772]: 在 zipfile.Path 中，添加隐式目录时，确保添加祖先目录并排除重复项。

bpo-18578 [https://bugs.python.org/issue?@action=redirect&bpo=18578]: Renamed and documented test.bytecode_helper as test.support.bytecode_helper. Patch by Joannah Nanjekye.

bpo-37785 [https://bugs.python.org/issue?@action=redirect&bpo=37785]: 修复 argparse 中的 xgettext 警告。

bpo-34488 [https://bugs.python.org/issue?@action=redirect&bpo=34488]: io.BytesIO 的 writelines() 方法在传递许多小行时现在稍微快一些。由 Sergey Fedoseev 提供补丁。

bpo-37449 [https://bugs.python.org/issue?@action=redirect&bpo=37449]: ensurepip now uses importlib.resources.read_binary() to read data instead of pkgutil.get_data(). Patch by Joannah Nanjekye.

bpo-28292 [https://bugs.python.org/issue?@action=redirect&bpo=28292]: 将calendar.py中的辅助函数标记为私有。这遵循了PEP 8的指导原则，保持了模块中的风格约定，并解决了一个已知的用户困惑案例。

bpo-18049 [https://bugs.python.org/issue?@action=redirect&bpo=18049]: 在Python/thread_pthread.h中为AIX添加THREAD_STACK_SIZE的定义。默认的线程堆栈大小导致了在默认递归限制下的崩溃。由M Felt提供补丁。

bpo-37742 [https://bugs.python.org/issue?@action=redirect&bpo=37742]: logging.getLogger() API现在在传递名称'root'时返回根日志记录器，而之前它返回一个名为'root'的非根日志记录器。这可能会影响那些明确需要一个名为'root'的非根日志记录器，或者在某些名为'root.py'的顶级模块中使用logging.getLogger(__name__)实例化日志记录器的用户代码。

bpo-37738 [https://bugs.python.org/issue?@action=redirect&bpo=37738]: 修复curses addch(str, color_pair) 的实现：将颜色对传递给``setcchar()``，而不是总是传递0作为颜色对。

bpo-37723 [https://bugs.python.org/issue?@action=redirect&bpo=37723]: 修复了在解析包含巨大字符集的正则表达式时的性能回归。补丁由Yann Vaginay提供。

bpo-35943 [https://bugs.python.org/issue?@action=redirect&bpo=35943]: 函数 PyImport_GetModule() 现在确保它返回的任何模块都已完全初始化。补丁由Joannah Nanjekye提供。

bpo-32178 [https://bugs.python.org/issue?@action=redirect&bpo=32178]: 修复了 email 包中尝试解析以 : 开头的无效地址字段时的IndexError。

bpo-37268 [https://bugs.python.org/issue?@action=redirect&bpo=37268]: parser 模块已被弃用，并将在Python的未来版本中移除。

bpo-11953 [https://bugs.python.org/issue?@action=redirect&bpo=11953]: 在 socket 中完成WSA*错误代码。

bpo-37685 [https://bugs.python.org/issue?@action=redirect&bpo=37685]: 修复了 datetime.timedelta 和 datetime.timezone 的比较。

bpo-37697 [https://bugs.python.org/issue?@action=redirect&bpo=37697]: 将 importlib.metadata 与`importlib_metadata 0.19 <https://gitlab.com/python-devs/importlib_metadata/-/milestones/20>`_同步，改进了对EGG-INFO文件的处理，并修复了当入口点名称包含冒号时的崩溃问题。

bpo-37695 [https://bugs.python.org/issue?@action=redirect&bpo=37695]: 更正 curses.unget_wch() 的错误信息。由Anthony Sottile提供补丁。

bpo-37689 [https://bugs.python.org/issue?@action=redirect&bpo=37689]: 在 PurePath 中添加 is_relative_to() 方法，以确定一个路径是否相对于另一个路径。

bpo-29553 [https://bugs.python.org/issue?@action=redirect&bpo=29553]: 修复了 argparse.ArgumentParser.format_usage() 对于互斥组的情况。补丁由 Andrew Nester 提供。

bpo-37691 [https://bugs.python.org/issue?@action=redirect&bpo=37691]: 让 math.dist() 接受序列（或可迭代对象）而不仅仅是元组作为坐标。

bpo-37685 [https://bugs.python.org/issue?@action=redirect&bpo=37685]: 修复了一些类中的 __eq__, __lt__ 等实现。对于不支持的其他操作数类型，现在返回 NotImplemented。这允许其他操作数发挥作用（例如与 ANY 的相等比较将返回 True）。

bpo-37354 [https://bugs.python.org/issue?@action=redirect&bpo=37354]: 将 Activate.ps1 Powershell 脚本设为静态，以允许对其进行签名。

bpo-37664 [https://bugs.python.org/issue?@action=redirect&bpo=37664]: 更新了与 ensurepip 捆绑的 wheels（pip 19.2.3 和 setuptools 41.2.0）。

bpo-37663 [https://bugs.python.org/issue?@action=redirect&bpo=37663]: 通过始终使用 __VENV_PROMPT__ 来使 venv shell 激活脚本保持一致。

bpo-37642 [https://bugs.python.org/issue?@action=redirect&bpo=37642]: 允许 datetime.timezone 的纯 Python 实现在接近最小和最大边界时表示亚分钟偏移，特别是在 (23:59, 24:00) 和 (-23:59, 24:00) 的范围内。补丁由 Ngalim Siregar 提供。

bpo-36161 [https://bugs.python.org/issue?@action=redirect&bpo=36161]: 在 posix 中，使用 ttyname_r 代替 ttyname 以实现线程安全。

bpo-36324 [https://bugs.python.org/issue?@action=redirect&bpo=36324]: 将 statistics.NormalDist() 的内部属性设为私有。

bpo-37555 [https://bugs.python.org/issue?@action=redirect&bpo=37555]: Fix NonCallableMock._call_matcher returning tuple instead of _Call object when self._spec_signature exists. Patch by Elizabeth Uselton

bpo-29446 [https://bugs.python.org/issue?@action=redirect&bpo=29446]: Make from tkinter import * import only the expected objects.

bpo-16970 [https://bugs.python.org/issue?@action=redirect&bpo=16970]: 当传递无效值给 nargs 时添加一个值错误。由 Robert Leenders 提供补丁。

bpo-34443 [https://bugs.python.org/issue?@action=redirect&bpo=34443]: enum 的异常现在在异常消息中使用枚举类的 __qualname__ 而不是 __name__。

bpo-37491 [https://bugs.python.org/issue?@action=redirect&bpo=37491]: 修复在解析具有意外结束的裸引用字符串值的电子邮件头时出现的 IndexError。由 Abhilash Raj 提供补丁。

bpo-37587 [https://bugs.python.org/issue?@action=redirect&bpo=37587]: 使 json.loads 对长字符串的处理更快。（由 Marco Paolini 提供补丁）

bpo-18378 [https://bugs.python.org/issue?@action=redirect&bpo=18378]: 将 "UTF-8" 识别为 locale._parse_localename 中 LC_CTYPE 的有效值。

bpo-37579 [https://bugs.python.org/issue?@action=redirect&bpo=37579]: 在Python的 __eq__ 实现中，当比较的对象不是同一类型时，对于 timedelta 和 time 返回 NotImplemented，以匹配C实现。由Karthikeyan Singaravelan提供补丁。

bpo-21478 [https://bugs.python.org/issue?@action=redirect&bpo=21478]: 当使用 unittest.mock.attach_mock() 将自动模拟对象附加到模拟时，记录对父级的调用。由Karthikeyan Singaravelan提供补丁。

bpo-37531 [https://bugs.python.org/issue?@action=redirect&bpo=37531]: "python3 -m test -jN --timeout=TIMEOUT" 现在会在工作进程运行超过 TIMEOUT 秒时终止该进程。

bpo-37482 [https://bugs.python.org/issue?@action=redirect&bpo=37482]: 修复了在发件人或收件人地址字段中同时包含编码字和特殊字符时显示名称的序列化问题。

bpo-36993 [https://bugs.python.org/issue?@action=redirect&bpo=36993]: 改进了对带有坏zip64额外数据的损坏zip文件的错误报告。补丁由Daniel Hillier提供。

bpo-37502 [https://bugs.python.org/issue?@action=redirect&bpo=37502]: 当buffers参数设置为None时，pickle.loads() 不再抛出TypeError。

bpo-37520 [https://bugs.python.org/issue?@action=redirect&bpo=37520]: 修正了当路径对象标识子目录时zipfile.Path.parent的行为。

bpo-18374 [https://bugs.python.org/issue?@action=redirect&bpo=18374]: 修复了在某些情况下，嵌套的 ast.BinOp 实例的 .col_offset 属性值过大的问题。

bpo-37424 [https://bugs.python.org/issue?@action=redirect&bpo=37424]: Fixes a possible hang when using a timeout on subprocess.run() while capturing output. If the child process spawned its own children or otherwise connected its stdout or stderr handles with another process, we could hang after the timeout was reached and our child was killed when attempting to read final output from the pipes.

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: 修复 multiprocessing.util.get_temp_dir() 的终结器：同时清除当前进程的'tempdir'配置，以便下次调用 get_temp_dir() 时将创建新的临时目录，而不是重用已删除的临时目录。

bpo-37481 [https://bugs.python.org/issue?@action=redirect&bpo=37481]: Python 3.8中已弃用distutils的 bdist_wininst 命令，改用 bdist_wheel (wheel包) 。

bpo-37479 [https://bugs.python.org/issue?@action=redirect&bpo=37479]: When Enum.__str__ is overridden in a derived class, the override will be used by Enum.__format__ regardless of whether mixin classes are present.

bpo-37440 [https://bugs.python.org/issue?@action=redirect&bpo=37440]: http.client 现在为默认上下文或如果向 HTTPSConnection 传递了 cert_file，则启用 TLS 1.3 握手后认证。

bpo-37437 [https://bugs.python.org/issue?@action=redirect&bpo=37437]: 更新了供应商化的 expat 版本到 2.2.7。

bpo-37428 [https://bugs.python.org/issue?@action=redirect&bpo=37428]: SSLContext.post_handshake_auth = True 不再为客户端连接设置 SSL_VERIFY_POST_HANDSHAKE 验证标志。虽然该选项被记录为对客户端忽略，但当该标志设置时，OpenSSL 隐式启用了证书链验证。

bpo-37420 [https://bugs.python.org/issue?@action=redirect&bpo=37420]: os.sched_setaffinity() 现在正确处理了在其 mask 参数迭代过程中出现的错误。由 Brandt Bucher 提供补丁。

bpo-37412 [https://bugs.python.org/issue?@action=redirect&bpo=37412]: os.getcwdb() 函数现在在 Windows 上使用 UTF-8 编码，而不是 ANSI 代码页：参见 PEP 529 [https://www.python.org/dev/peps/pep-0529] 的理由。该函数在 Windows 上不再被弃用。

bpo-37406 [https://bugs.python.org/issue?@action=redirect&bpo=37406]: 如果操作参数类型不是 str，sqlite3 模块现在会抛出 TypeError，而不是 ValueError：execute()、executemany() 和调用连接时。

bpo-29412 [https://bugs.python.org/issue?@action=redirect&bpo=29412]: 修复了在解析意外结束的头值时引发的 IndexError。由 Abhilash Raj 提供补丁。

bpo-36546 [https://bugs.python.org/issue?@action=redirect&bpo=36546]: statistics.quantiles() 的 dist 参数现在仅为位置参数。当前名称没有反映该参数可以是数据集或分布。将参数标记为位置参数避免了混淆，并使得以后可以更改名称。

bpo-37394 [https://bugs.python.org/issue?@action=redirect&bpo=37394]: 修复了一个导致 queue 模块在加速器模块不可用时失败的 bug。由 Pablo Galindo 提供补丁。

bpo-37376 [https://bugs.python.org/issue?@action=redirect&bpo=37376]: pprint 现在支持 types.SimpleNamespace。由 Carl Bordum Hansen 提供补丁。

bpo-26967 [https://bugs.python.org/issue?@action=redirect&bpo=26967]: 一个带有 allow_abbrev=False 的 ArgumentParser 不再禁用短标志的分组，例如 -vv，但仅禁用长标志的缩写，如文档所述。由 Zac Hatfield-Dodds 提交的补丁。

bpo-37212 [https://bugs.python.org/issue?@action=redirect&bpo=37212]: unittest.mock.call() 现在保留关键字参数在 repr 输出中的顺序。由 Karthikeyan Singaravelan 提交的补丁。

bpo-37372 [https://bugs.python.org/issue?@action=redirect&bpo=37372]: 修复从 Python 2 中解封秒数>=24 的 datetime.time 对象时的错误。由 Justin Blanchard 提交的补丁。

bpo-37345 [https://bugs.python.org/issue?@action=redirect&bpo=37345]: Add formal support for UDPLITE sockets. Support was present before, but it is now easier to detect support with hasattr(socket, 'IPPROTO_UDPLITE') and there are constants defined for each of the values needed: socket.IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, and UDPLITE_RECV_CSCOV. Patch by Gabe Appleton.

bpo-37358 [https://bugs.python.org/issue?@action=redirect&bpo=37358]: 通过使用 vectorcall 优化了 functools.partial。

bpo-37347 [https://bugs.python.org/issue?@action=redirect&bpo=37347]: 如果 sqlite3.Connection.create_aggregate()、sqlite3.Connection.create_function()、sqlite3.Connection.set_authorizer()、sqlite3.Connection.set_progress_handler() 和 sqlite3.Connection.set_trace_callback() 方法被用相同的对象但不是同一个对象调用两次，会导致段错误。现在回调的存储更加谨慎。由 Aleksandr Balezin 提交的补丁。

bpo-37163 [https://bugs.python.org/issue?@action=redirect&bpo=37163]: dataclasses.replace() 的 obj 参数现在是仅位置参数。

bpo-37085 [https://bugs.python.org/issue?@action=redirect&bpo=37085]: 在 socket 模块中添加了可选的 Linux SocketCAN 广播管理器常量，用作配置 BCM 行为的标志。由 Karl Ding 提交的补丁。

bpo-37328 [https://bugs.python.org/issue?@action=redirect&bpo=37328]: HTMLParser.unescape 已被移除。它自 Python 3.4 起未记录且被弃用。

bpo-37305 [https://bugs.python.org/issue?@action=redirect&bpo=37305]: 将 .webmanifest -> application/manifest+json 添加到识别的文件类型和内容类型头列表中。

bpo-37320 [https://bugs.python.org/issue?@action=redirect&bpo=37320]: aifc.openfp() 到 aifc.open() 的别名、sunau.openfp() 到 sunau.open() 的别名、以及 wave.openfp() 到 wave.open() 的别名已被移除。它们自 Python 3.7 起被弃用。

bpo-37315 [https://bugs.python.org/issue?@action=redirect&bpo=37315]: 弃用在 math.factorial() 中接受整数值的浮点数（如 5.0）。

bpo-37312 [https://bugs.python.org/issue?@action=redirect&bpo=37312]: _dummy_thread 和 dummy_threading 模块已被移除。这些模块自 Python 3.7 起已被弃用，因为 Python 3.7 需要线程支持。

bpo-33972 [https://bugs.python.org/issue?@action=redirect&bpo=33972]: 对于设置为 multipart/* 但只有单一部分的电子邮件，不再引发 AttributeError。

bpo-37280 [https://bugs.python.org/issue?@action=redirect&bpo=37280]: 在 sendfile 后备模式中，使用线程池从文件读取。

bpo-37279 [https://bugs.python.org/issue?@action=redirect&bpo=37279]: 修复在 sendfile 后备模式中发送额外数据时的 asyncio sendfile 支持。

bpo-19865 [https://bugs.python.org/issue?@action=redirect&bpo=19865]: ctypes.create_unicode_buffer() now also supports non-BMP characters on platforms with 16-bit wchar_t (for example, Windows and AIX).

bpo-37266 [https://bugs.python.org/issue?@action=redirect&bpo=37266]: 在子解释器中，现在尝试生成守护线程会引发异常。子解释器从未支持守护线程。之前，如果守护线程仍在运行，子解释器终止时会因 Python 致命错误而崩溃。

bpo-37210 [https://bugs.python.org/issue?@action=redirect&bpo=37210]: Allow pure Python implementation of pickle to work even when the C _pickle module is unavailable.

bpo-21872 [https://bugs.python.org/issue?@action=redirect&bpo=21872]: 修复 lzma 模块解压数据不完整的问题。当解压 FORMAT_ALONE 格式的文件且没有结束标记时，有时最后的一些字节无法输出。由马林提供补丁。

bpo-35922 [https://bugs.python.org/issue?@action=redirect&bpo=35922]: 修复 RobotFileParser.crawl_delay() 和 RobotFileParser.request_rate()，当 robots.txt 文件中没有定义相关规则时返回 None 而不是引发 AttributeError。由 Rémi Lapeyre 提供补丁。

bpo-35766 [https://bugs.python.org/issue?@action=redirect&bpo=35766]: 将 feature_version 的格式更改为 (major, minor) 元组。

bpo-36607 [https://bugs.python.org/issue?@action=redirect&bpo=36607]: Eliminate RuntimeError raised by asyncio.all_tasks() if internal tasks weak set is changed by another thread during iteration.

bpo-18748 [https://bugs.python.org/issue?@action=redirect&bpo=18748]: _pyio.IOBase destructor now does nothing if getting the closed attribute fails to better mimic _io.IOBase finalizer.

bpo-36402 [https://bugs.python.org/issue?@action=redirect&bpo=36402]: 修复 Python 关闭时等待线程的竞争条件。等待所有非守护线程的 Python 线程状态被删除（加入所有非守护线程），而不仅仅是等待非守护 Python 线程完成。

bpo-37206 [https://bugs.python.org/issue?@action=redirect&bpo=37206]: 无法表示为 Python 对象的默认值不再在函数签名中错误地表示为 None。

bpo-37111 [https://bugs.python.org/issue?@action=redirect&bpo=37111]: 向 logging.basicConfig 添加了 encoding 和 errors 关键字参数。

bpo-12144 [https://bugs.python.org/issue?@action=redirect&bpo=12144]: 确保在 CookieJar.make_cookies() 中处理带有 expires 属性的 cookies。

bpo-34886 [https://bugs.python.org/issue?@action=redirect&bpo=34886]: Fix an unintended ValueError from subprocess.run() when checking for conflicting input and stdin or capture_output and stdout or stderr args when they were explicitly provided but with None values within a passed in **kwargs dict rather than as passed directly by name. Patch contributed by Rémi Lapeyre.

bpo-37173 [https://bugs.python.org/issue?@action=redirect&bpo=37173]: inspect.getfile() 的异常消息现在正确地报告传递的类而非 builtins 模块。

bpo-37178 [https://bugs.python.org/issue?@action=redirect&bpo=37178]: 给 math.perm() 添加了一个单参数形式，其含义与 math.factorial() 相同。

bpo-37178 [https://bugs.python.org/issue?@action=redirect&bpo=37178]: 对于 math.perm(n, k)，让 k 默认为 n，给出与阶乘相同的结果。

bpo-37165 [https://bugs.python.org/issue?@action=redirect&bpo=37165]: 将 _collections._count_elements 转换为使用 Argument Clinic。

bpo-34767 [https://bugs.python.org/issue?@action=redirect&bpo=34767]: 不在 asyncio.Lock 中总是创建一个 collections.deque。

bpo-37158 [https://bugs.python.org/issue?@action=redirect&bpo=37158]: 通过从函数切换到生成器来加速 statistics.fmean()。

bpo-34282 [https://bugs.python.org/issue?@action=redirect&bpo=34282]: 移除 Enum._convert 方法，已在 3.8 版本中弃用。

bpo-37150 [https://bugs.python.org/issue?@action=redirect&bpo=37150]: argparse._ActionsContainer.add_argument now throws error, if someone accidentally pass FileType class object instead of instance of FileType as type argument

bpo-28724 [https://bugs.python.org/issue?@action=redirect&bpo=28724]: socket 模块现在有 socket.send_fds() 和 socket.recv.fds() 方法。由 Joannah Nanjekye、Shinya Okano 和 Victor Stinner 贡献。

bpo-35621 [https://bugs.python.org/issue?@action=redirect&bpo=35621]: 支持在UNIX上线程中运行事件循环时执行asyncio子进程。

bpo-36520 [https://bugs.python.org/issue?@action=redirect&bpo=36520]: 现在，带有UTF-8字符的长电子邮件头在折叠时能够正确编码。由Jeffrey Kintscher提供补丁。

bpo-30835 [https://bugs.python.org/issue?@action=redirect&bpo=30835]: 修复了电子邮件解析中的一个错误，其中多部分消息中内容传输编码含有无效字节可能导致AttributeError。由Andrew Donnellan提供补丁。

bpo-31163 [https://bugs.python.org/issue?@action=redirect&bpo=31163]: pathlib.Path实例的rename和replace方法现在返回新的Path实例。

bpo-25068 [https://bugs.python.org/issue?@action=redirect&bpo=25068]: urllib.request.ProxyHandler 现在将传递的字典的键转换为小写。

bpo-26185 [https://bugs.python.org/issue?@action=redirect&bpo=26185]: 修复空 ZipInfo 对象上的 repr()。由Mickaël Schoentgen提供补丁。

bpo-21315 [https://bugs.python.org/issue?@action=redirect&bpo=21315]: 即使缺少空白，也会解析包含RFC2047编码词的电子邮件头，并记录一个缺陷。现在，编码词后缺少尾随空白也会被记录为缺陷。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 将test_datetime移植到VxWorks：在VxWorks上跳过zoneinfo测试

bpo-35805 [https://bugs.python.org/issue?@action=redirect&bpo=35805]: 添加Message-ID头的解析器并将其添加到默认HeaderRegistry中。这应该可以防止使用RFC 2048编码词折叠Message-ID。

bpo-36871 [https://bugs.python.org/issue?@action=redirect&bpo=36871]: 确保在断言模拟对象对方法调用时使用方法签名而不是类的构造函数签名。由Karthikeyan Singaravelan提供补丁。

bpo-35070 [https://bugs.python.org/issue?@action=redirect&bpo=35070]: 当用户属于NGROUPS_MAX补充组时，posix.getgrouplist()现在可以正常工作。补丁由Jeffrey Kintscher提供。

bpo-31783 [https://bugs.python.org/issue?@action=redirect&bpo=31783]: 修复ThreadPoolExecutor中在解释器关闭期间创建工作线程时的竞争条件。

bpo-36582 [https://bugs.python.org/issue?@action=redirect&bpo=36582]: 修复 UserString.encode()``以正确返回 ``bytes 而不是 UserString 实例。

bpo-32424 [https://bugs.python.org/issue?@action=redirect&bpo=32424]: 弃用xml.etree.ElementTree.Element.copy()，推荐使用copy.copy()。

由Gordon P. Hemsley提供补丁

问题`36564`: 修复了当邮件策略的max_line_length不足以包含所需标记和消息中的任何值时触发的电子邮件头折叠逻辑中的无限循环。由Paul Ganssle提供补丁。

问题`36543`: 移除了Element.getchildren()、Element.getiterator()和ElementTree.getiterator()方法以及xml.etree.cElementTree模块。

问题`36409`: 移除了在Python 3.4中已弃用的旧plistlib API。

问题`36302`: distutils对源文件列表进行排序，使得默认情况下Extension .so文件的构建更具可重复性。

问题`36250`: 在非主线程中，忽略来自`signal`与`interaction`的`ValueError`。

问题`36046`: 向subprocess.Popen构造函数添加了`user`、`group`和`extra_groups`参数。由Patrick McLean提供补丁。

问题`32627`: 修复了当包含冲突的`_uuid`头时导致的编译错误。

问题`35800`: 弃用`smtpd.MailmanProxy`，为将来移除做准备。

问题`35168`: shlex.shlex.punctuation_chars 现在是一个只读属性。

问题`8538`: 向argparse添加了对布尔动作的支持，如`--foo`和`--no-foo`。由Rémi Lapeyre提供补丁。

bpo-20504 [https://bugs.python.org/issue?@action=redirect&bpo=20504]: Fixes a bug in cgi module when a multipart/form-data request has no Content-Length header.

问题`25988`: collections.abc 中的抽象基类不再暴露在常规的 collections 模块中。

问题`11122`: Distutils不会仅在指定的路径中检查rpmbuild。

问题`34775`: 当传递的不是str或PurePath的实例时，PurePath的除法处理现在返回NotImplemented而不是引发TypeError。由Roger Aiudi提供补丁。

问题`34749`: binascii.a2b_base64() 现在快了2倍。由Sergey Fedoseev提供补丁。

问题`34519`: 为HP Roman 8添加了额外的别名。由Michael Osipov提供补丁。

bpo-28009 [https://bugs.python.org/issue?@action=redirect&bpo=28009]: 修复在MAC地址分隔符为'.'的平台以及MAC地址值中省略前导0的MAC地址格式情况下uuid.getnode()的问题。目前，AIX是唯一已知具有这些设置的平台。由Michael Felt提供补丁。

bpo-30618 [https://bugs.python.org/issue?@action=redirect&bpo=30618]: 添加 readlink()。由Girts Folkmanis提供补丁。

bpo-32498 [https://bugs.python.org/issue?@action=redirect&bpo=32498]: Made urllib.parse.unquote() accept bytes in addition to strings. Patch by Stein Karlsen.

bpo-33348 [https://bugs.python.org/issue?@action=redirect&bpo=33348]: lib2to3 now recognizes expressions after * and ** like in f(*[] or []).

bpo-32689 [https://bugs.python.org/issue?@action=redirect&bpo=32689]: 更新 shutil.move() 函数以允许使用Path对象作为源参数。由Emily Morehouse和Maxwell "5.13b" McKinnon提供补丁。

bpo-32820 [https://bugs.python.org/issue?@action=redirect&bpo=32820]: Added __format__ to IPv4 and IPv6 classes. Always outputs a fully zero- padded string. Supports b/x/n modifiers (bin/hex/native format). Native format for IPv4 is bin, native format for IPv6 is hex. Also supports '#' and '_' modifiers.

bpo-27657 [https://bugs.python.org/issue?@action=redirect&bpo=27657]: 修复带有数字路径的urllib.parse.urlparse()。像"path:80"这样的字符串不再被解析为路径，而是被解析为方案（"path"）和路径（"80"）。

bpo-4963 [https://bugs.python.org/issue?@action=redirect&bpo=4963]: 修复了与mimetypes扩展映射和模块重新初始化相关的非确定性行为。

文档

bpo-21767 [https://bugs.python.org/issue?@action=redirect&bpo=21767]: 在functools.singledispatch中明确提及abc支持。

bpo-38816 [https://bugs.python.org/issue?@action=redirect&bpo=38816]: 提供了关于 fork() 与CPython运行时之间交互的更多细节，仅关注C-API。这包括关于在何处应该和不应该调用 fork() 的警告。

bpo-38351 [https://bugs.python.org/issue?@action=redirect&bpo=38351]: 将 email 示例从%-格式化更新为f-strings。

bpo-38778 [https://bugs.python.org/issue?@action=redirect&bpo=38778]: 记录了如果在子解释器中调用 os.fork() 会引发 RuntimeError 的事实。

bpo-38592 [https://bugs.python.org/issue?@action=redirect&bpo=38592]: 在Python文档网站的语言切换器中添加巴西葡萄牙语。

bpo-38294 [https://bugs.python.org/issue?@action=redirect&bpo=38294]: 将不再转义的字符列表添加到re.escape文档中。

bpo-38053 [https://bugs.python.org/issue?@action=redirect&bpo=38053]: 更新了plistlib文档。

bpo-26868 [https://bugs.python.org/issue?@action=redirect&bpo=26868]: 修复 PyModule_AddObject() 的示例用法以正确处理错误。

bpo-36797 [https://bugs.python.org/issue?@action=redirect&bpo=36797]: 修复 distutils API 参考中的死链接。

bpo-37977 [https://bugs.python.org/issue?@action=redirect&bpo=37977]: 更强烈和明确地警告关于 pickle 的不安全性。

bpo-37979 [https://bugs.python.org/issue?@action=redirect&bpo=37979]: 在 datetime.fromisoformat 文档中添加了到 dateutil.parser.isoparse 的链接。由 Paul Ganssle 提供补丁。

bpo-12707 [https://bugs.python.org/issue?@action=redirect&bpo=12707]: 弃用 info()、geturl()、getcode() 方法，分别推荐使用 headers、url 和 status 属性，针对 HTTPResponse 和 addinfourl。同时弃用 addinfourl 的 code 属性，推荐使用 status 属性。由 Ashwin Ramaswami 提供补丁。

bpo-37937 [https://bugs.python.org/issue?@action=redirect&bpo=37937]: 在 sys.settrace() 文档中提及 frame.f_trace。

bpo-37878 [https://bugs.python.org/issue?@action=redirect&bpo=37878]: 使 PyThreadState_DeleteCurrent() 内部化。

bpo-37759 [https://bugs.python.org/issue?@action=redirect&bpo=37759]: 开始编辑 Whatsnew 3.8。

bpo-37726 [https://bugs.python.org/issue?@action=redirect&bpo=37726]: 停止在教程中推荐使用 getopt 进行命令行参数解析，并推广 argparse。

bpo-32910 [https://bugs.python.org/issue?@action=redirect&bpo=32910]: 移除关于 venv 的 Deactivate 如何工作的实现特定行为。

bpo-37256 [https://bugs.python.org/issue?@action=redirect&bpo=37256]: 修正 urllib.request 中 Request 的参数措辞。

bpo-37284 [https://bugs.python.org/issue?@action=redirect&bpo=37284]: 添加简短说明，指出任何新的 sys.implementation 必需属性必须经过 PEP 流程。

bpo-30088 [https://bugs.python.org/issue?@action=redirect&bpo=30088]: 文档说明 mailbox.Maildir 构造函数不尝试验证 maildir 文件夹布局的正确性。由 Sviatoslav Sydorenko 提供补丁。

bpo-37521 [https://bugs.python.org/issue?@action=redirect&bpo=37521]: Fix importlib examples to insert any newly created modules via importlib.util.module_from_spec() immediately into sys.modules instead of after calling loader.exec_module().

感谢 Benjamin Mintz 发现这个错误。

bpo-37456 [https://bugs.python.org/issue?@action=redirect&bpo=37456]: 斜杠 ('/') 现在成为语法的一部分。

bpo-37487 [https://bugs.python.org/issue?@action=redirect&bpo=37487]: 修正 PyList_GetItem 索引描述以包含 0。

bpo-37149 [https://bugs.python.org/issue?@action=redirect&bpo=37149]: 将死链接 Tkinter 8.5 参考（作者：John Shipman, New Mexico Tech）替换为 archive.org 的副本链接。

bpo-37478 [https://bugs.python.org/issue?@action=redirect&bpo=37478]: 在 os.chdir() 的描述中添加了可能的异常。

bpo-34903 [https://bugs.python.org/issue?@action=redirect&bpo=34903]: Documented that in datetime.datetime.strptime(), the leading zero in some two-digit formats is optional. Patch by Mike Gleen.

bpo-36260 [https://bugs.python.org/issue?@action=redirect&bpo=36260]: 在 zipfile 模块文档中添加了解压缩的陷阱。

bpo-37004 [https://bugs.python.org/issue?@action=redirect&bpo=37004]: 在 difflib 的文档中，添加了一个明确警告，指出 SequenceMatcher 的 ratio 方法的结果可能依赖于输入字符串的顺序。

bpo-36960 [https://bugs.python.org/issue?@action=redirect&bpo=36960]: 重构了 datetime 文档，旨在使其更加用户友好并提高可读性。由 Brad Solomon 提供补丁。

bpo-36487 [https://bugs.python.org/issue?@action=redirect&bpo=36487]: 在 C-API 文档中明确了“主”解释器的含义。

bpo-23460 [https://bugs.python.org/issue?@action=redirect&bpo=23460]: The documentation for decimal string formatting using the :g specifier has been updated to reflect the correct exponential notation cutoff point. Original patch contributed by Tuomas Suutari.

bpo-35803 [https://bugs.python.org/issue?@action=redirect&bpo=35803]: 记录并测试了 tempfile 函数可能接受一个 path-like object 作为 dir 参数。由 Anthony Sottile 提供补丁。

bpo-33944 [https://bugs.python.org/issue?@action=redirect&bpo=33944]: 添加了关于 .pth 文件中代码预期用途的说明。

bpo-34293 [https://bugs.python.org/issue?@action=redirect&bpo=34293]: 修复了 Doc/Makefile 关于 PAPER 环境变量和 PDF 构建的问题。

bpo-25237 [https://bugs.python.org/issue?@action=redirect&bpo=25237]: 为 tkinter 模块添加文档。

测试

bpo-38614 [https://bugs.python.org/issue?@action=redirect&bpo=38614]: 修复了 test_asyncio.test_subprocess 的 test_communicate()：使用 support.LONG_TIMEOUT (5 分钟) 而不是仅 1 分钟。

bpo-38614 [https://bugs.python.org/issue?@action=redirect&bpo=38614]: 向 test.support 添加超时常量：LOOPBACK_TIMEOUT、INTERNET_TIMEOUT、SHORT_TIMEOUT 和 LONG_TIMEOUT。

bpo-38502 [https://bugs.python.org/issue?@action=redirect&bpo=38502]: 如果进程组可用（os.setsid() 和 os.killpg() 函数可用），test.regrtest 现在在多进程模式（-jN 命令行选项）中使用进程组。

bpo-35998 [https://bugs.python.org/issue?@action=redirect&bpo=35998]: 修复 test_asyncio.test_start_tls_server_1() 中的竞态条件。之前，测试 main() 函数替换协议和测试 ServerProto 协议在收到 HELLO 后发送 ANSWER 之间存在竞态条件。现在，只有测试 main() 函数负责发送数据，ServerProto 不再发送数据。

bpo-38470 [https://bugs.python.org/issue?@action=redirect&bpo=38470]: 在没有长路径支持的 Windows 上修复 test_compileall.test_compile_dir_maxlevels()：仅创建 3 个子目录，而不是创建 20 到 100 个子目录。

bpo-37531 [https://bugs.python.org/issue?@action=redirect&bpo=37531]: 在超时时，regrtest 不再尝试再次调用 popen.communicate()：它可能会挂起，直到所有使用 stdout 和 stderr 管道的子进程完成。杀死工作进程并忽略其输出。还将主进程的 faulthandler 超时从 1 分钟更改为 5 分钟，以适应 Python 最慢的构建机器人。

bpo-38239 [https://bugs.python.org/issue?@action=redirect&bpo=38239]: 为链接时优化 (LTO) 构建修复 test_gdb。

bpo-38275 [https://bugs.python.org/issue?@action=redirect&bpo=38275]: test_ssl 现在更好地处理禁用的 TLS/SSL 版本。识别 OpenSSL 的加密策略和运行时设置，并跳过禁用版本的测试。测试还接受更多的 TLS minimum_versions，以适应那些用严格设置覆盖 OpenSSL 默认值的平台。

bpo-38271 [https://bugs.python.org/issue?@action=redirect&bpo=38271]: test_ssl 的私钥之前是用 3DES 加密的传统 PKCS#5 格式。一些严格的加密策略会阻止 3DES 和 PKCS#5 的摘要算法。现在改用 PKCS#8 格式并使用 AES256 加密。

bpo-38270 [https://bugs.python.org/issue?@action=redirect&bpo=38270]: test.support 现在有一个辅助函数来检查哈希摘要函数的可用性。重构了几个测试以避免使用 MD5 并使用 SHA256 代替。其他测试被标记为使用 MD5，并在 MD5 被禁用时跳过。

bpo-37123 [https://bugs.python.org/issue?@action=redirect&bpo=37123]: 多处理测试 test_mymanager() 现在也期望 -SIGTERM，不仅仅是退出码 0。如果管理器进程停止时间超过 1 秒，BaseManager._finalize_manager() 会向管理器进程发送 SIGTERM，这在慢速构建机器人上会发生。

bpo-38212 [https://bugs.python.org/issue?@action=redirect&bpo=38212]: 多进程测试：将 test_queue_feeder_donot_stop_onexc() 的超时时间从 1 秒增加到 60 秒。

bpo-38117 [https://bugs.python.org/issue?@action=redirect&bpo=38117]: 使用 OpenSSL 1.1.1d 进行测试

bpo-38018 [https://bugs.python.org/issue?@action=redirect&bpo=38018]: 提高 multiprocessing.shared_memory 的代码覆盖率。

bpo-37805 [https://bugs.python.org/issue?@action=redirect&bpo=37805]: Add tests for json.dump(..., skipkeys=True). Patch by Dong-hee Na.

bpo-37531 [https://bugs.python.org/issue?@action=redirect&bpo=37531]: 增强 regrtest 多进程超时功能：在终止工作进程时写入消息，捕获 popen.kill() 和 popen.wait() 异常，对第二次调用 popen.communicate() 设置超时。

bpo-37876 [https://bugs.python.org/issue?@action=redirect&bpo=37876]: 为 ROT-13 编解码器添加测试。

bpo-36833 [https://bugs.python.org/issue?@action=redirect&bpo=36833]: Added tests for PyDateTime_xxx_GET_xxx() macros of the C API of the datetime module. Patch by Joannah Nanjekye.

bpo-37558 [https://bugs.python.org/issue?@action=redirect&bpo=37558]: 修复 test_shared_memory_cleaned_after_process_termination 名称处理

bpo-37526 [https://bugs.python.org/issue?@action=redirect&bpo=37526]: 添加 test.support.catch_threading_exception()：使用 threading.excepthook() 捕获 threading.Thread 异常的上下文管理器。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: test_concurrent_futures 现在如果 ForkServer 实例正在运行，则明确停止它。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: 多进程测试现在如果 ForkServer 实例正在运行，则停止它：关闭“alive”文件描述符以请求服务器停止，然后移除其 UNIX 地址。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: test_distutils.test_build_ext() 现在能够在 Windows 上移除临时目录：不在当前进程中导入新构建的 C 扩展（“xx”），而是在一个单独的进程中测试它。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: test_concurrent_futures 现在清理多进程以立即移除由 multiprocessing.util.get_temp_dir() 创建的临时目录。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: test_winconsoleio 不再泄漏临时文件：使用 tempfile.TemporaryFile() 在测试完成时移除它。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: 多进程测试现在明确调用 _run_finalizers() 以立即移除测试创建的临时目录。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: urllib.request 测试现在调用 urlcleanup() 来移除由 urlretrieve() 测试创建的临时文件，并清除由 urlopen() 和间接调用 urlopen() 的函数设置的 _opener 全局变量。

bpo-37472 [https://bugs.python.org/issue?@action=redirect&bpo=37472]: 移除 Lib/test/outstanding_bugs.py。

bpo-37199 [https://bugs.python.org/issue?@action=redirect&bpo=37199]: 修复当 IPv6 不可用或禁用时的测试失败问题。

bpo-19696 [https://bugs.python.org/issue?@action=redirect&bpo=19696]: 在 "test_pkg_import.py" 中用 "random.choice" 替换已弃用的方法 "random.choose"。

bpo-37335 [https://bugs.python.org/issue?@action=redirect&bpo=37335]: 从 c 语言环境强制测试中移除不再必要的代码。

bpo-37421 [https://bugs.python.org/issue?@action=redirect&bpo=37421]: 修复 test_shutil 以不再泄漏临时文件。

bpo-37411 [https://bugs.python.org/issue?@action=redirect&bpo=37411]: 修复 test_wsgiref.testEnviron() 以不再依赖环境变量（如果设置了 "X" 变量也不会失败）。

bpo-37400 [https://bugs.python.org/issue?@action=redirect&bpo=37400]: 修复 test_os.test_chown()：使用 os.getgroups() 而不是 grp.getgrall() 来获取组。同时将测试重命名为 test_chown_gid()。

bpo-37359 [https://bugs.python.org/issue?@action=redirect&bpo=37359]: 向 python3 -m test 添加 --cleanup 选项以移除之前失败作业的 test_python_* 目录。添加 "make cleantest" 以运行 python3 -m test --cleanup。

bpo-37362 [https://bugs.python.org/issue?@action=redirect&bpo=37362]: 如果 test_gdb 在 stderr 上接收到“意外”消息，它不再失败：现在它会忽略 stderr。test_gdb 的目的是测试 python-gdb.py 命令是否按预期工作，而不是测试 gdb。

bpo-35998 [https://bugs.python.org/issue?@action=redirect&bpo=35998]: 在 test_asyncio: test_start_tls_server_1() 中避免 TimeoutError。

bpo-37278 [https://bugs.python.org/issue?@action=redirect&bpo=37278]: 修复 test_asyncio ProactorLoopCtrlC：加入线程以防止泄漏运行中的线程和引用。

bpo-37261 [https://bugs.python.org/issue?@action=redirect&bpo=37261]: 修复 test.support.catch_unraisable_exception()：它的 __exit__() 方法现在忽略在清除其 unraisable 属性时引发的不可捕获异常。

bpo-37069 [https://bugs.python.org/issue?@action=redirect&bpo=37069]: regrtest 现在使用 sys.unraisablehook() 来标记测试为“环境已更改”（ENV_CHANGED），如果它发出了“不可捕获的异常”。此外，regrtest 在这种情况下会记录一个警告。

使用 python3 -m test --fail-env-changed 来捕获测试中的不可捕获异常。

bpo-37252 [https://bugs.python.org/issue?@action=redirect&bpo=37252]: 修复devpoll测试中 test_close 和 test_events_mask_overflow 的断言。

bpo-37169 [https://bugs.python.org/issue?@action=redirect&bpo=37169]: 重写 _PyObject_IsFreed() 单元测试。

bpo-37153 [https://bugs.python.org/issue?@action=redirect&bpo=37153]: test_venv.test_multiprocessing() 现在显式调用 pool.terminate() 以等待池完成。

bpo-34001 [https://bugs.python.org/issue?@action=redirect&bpo=34001]: 使test_ssl能够与LibreSSL一起通过。LibreSSL处理最小和最大TLS版本的方式与OpenSSL不同。

bpo-36919 [https://bugs.python.org/issue?@action=redirect&bpo=36919]: 使 test_source_encoding.test_issue2301 实现独立。该测试现在适用于CPython和IronPython。

bpo-30202 [https://bugs.python.org/issue?@action=redirect&bpo=30202]: 更新 test.test_importlib.test_abc 以测试 find_spec()。

bpo-28009 [https://bugs.python.org/issue?@action=redirect&bpo=28009]: 修改test_uuid逻辑，以测试当程序可用且可用于获取MACADDR作为UUID基础时的情况。由M. Felt提供补丁。

bpo-34596 [https://bugs.python.org/issue?@action=redirect&bpo=34596]: 当 unittest.skip() 未被调用时，回退到默认原因。由Naitree Zhu提供补丁。

构建

bpo-38809 [https://bugs.python.org/issue?@action=redirect&bpo=38809]: 在Windows上，构建脚本现在可以识别并使用活动虚拟环境中的python.exe。

bpo-38684 [https://bugs.python.org/issue?@action=redirect&bpo=38684]: 当Blake2被禁用但OpenSSL支持它时，修复_hashlib构建。

bpo-38468 [https://bugs.python.org/issue?@action=redirect&bpo=38468]: Misc/python-config.in now uses getvar() for all still existing sysconfig.get_config_var() calls. Patch by Joannah Nanjekye.

bpo-37415 [https://bugs.python.org/issue?@action=redirect&bpo=37415]: 修复ICC编译器的stdatomic.h头文件检查：ICC实现缺少Python所需的atomic_uintptr_t类型。

bpo-38301 [https://bugs.python.org/issue?@action=redirect&bpo=38301]: 在Solaris系列中，我们必须确保使用 -D_REENTRANT。由Jesús Cea Avión提供补丁。

bpo-36002 [https://bugs.python.org/issue?@action=redirect&bpo=36002]: 使用 AC_PATH_TOOL``而非 ``AC_PATH_TARGET_TOOL 定位 llvm-profdata 和``llvm-ar``二进制文件。

bpo-37936 [https://bugs.python.org/issue?@action=redirect&bpo=37936]: .gitignore 文件系统地“根植”所有规则，规则末尾不带斜杠，这些规则旨在应用于仓库中特定位置的文件。以前，当要忽略的文件恰好在仓库的根目录时，我们经常会意外地忽略树中任何地方同名的文件和目录。

bpo-37760 [https://bugs.python.org/issue?@action=redirect&bpo=37760]: 用于将Unicode字符数据库中的信息转换为由 str 方法和 unicodedata 模块使用的生成代码和数据的脚本 Tools/unicode/makeunicodedata.py，现在将每个字符的数据作为一个具有命名属性的 dataclass 处理，而不是一个长度为18的不同字段列表。

bpo-37936 [https://bugs.python.org/issue?@action=redirect&bpo=37936]: .gitignore 文件不再适用于实际上在Git仓库中被跟踪的任何文件。由Greg Price提供补丁。

bpo-37725 [https://bugs.python.org/issue?@action=redirect&bpo=37725]: 更改“clean”makefile目标，以同时清除程序引导优化(PGO)数据。以前，您必须使用“make clean”和“make profile-removal”，或者“make clobber”。

bpo-37707 [https://bugs.python.org/issue?@action=redirect&bpo=37707]: 标记一些单独的测试在使用--pgo时跳过。标记的测试显著增加PGO任务时间，并且可能无助于改进最终可执行文件的优化。

bpo-36044 [https://bugs.python.org/issue?@action=redirect&bpo=36044]: 减少为PGO生成任务运行的单元测试数量。这使任务速度提高了约15倍。运行完整的单元测试套件很慢。这一变化可能导致构建稍微不那么优化，因为不会执行那么多代码分支。如果您愿意等待更慢的构建，可以使用'./configure [..] PROFILE_TASK="-m test --pgo-extended"'恢复旧行为。我们不保证哪个PGO任务集会产生更快的构建。关心的用户应该运行自己的相关基准测试，因为结果可能依赖于环境、工作负载和编译器工具链。

bpo-37468 [https://bugs.python.org/issue?@action=redirect&bpo=37468]: make install 不再安装distutils bdist_wininst使用的 wininst-*.exe 文件：bdist_wininst仅在Windows上工作。

bpo-37189 [https://bugs.python.org/issue?@action=redirect&bpo=37189]: Many PyRun_XXX() functions like PyRun_String() were no longer exported in libpython38.dll by mistake. Export them again to fix the ABI compatibility.

bpo-25361 [https://bugs.python.org/issue?@action=redirect&bpo=25361]: 在Windows 32位构建中启用SSE2指令的使用。

bpo-36210 [https://bugs.python.org/issue?@action=redirect&bpo=36210]: 更新AIX的可选扩展模块检测。osssaudiodev和spwd不适用于AIX，不再报告为缺失。第三方打包的ncurses（支持ASIS）与官方支持的AIX curses库冲突，因此配置AIX使用libcurses.a。但是，跳过尝试构建_curses_panel。

由M Felt提供补丁

Windows

bpo-38589 [https://bugs.python.org/issue?@action=redirect&bpo=38589]: 修复当Windows未安装在C盘时的HTML帮助快捷方式

bpo-38453 [https://bugs.python.org/issue?@action=redirect&bpo=38453]: 确保ntpath.realpath()正确解析相对路径。

bpo-38519 [https://bugs.python.org/issue?@action=redirect&bpo=38519]: 恢复nuget.org和Microsoft Store包中缺失的内部C头文件。

bpo-38492 [https://bugs.python.org/issue?@action=redirect&bpo=38492]: 移除 pythonw.exe 对Microsoft C++运行时的依赖。

bpo-38344 [https://bugs.python.org/issue?@action=redirect&bpo=38344]: 修复activate.bat中的错误消息

bpo-38359 [https://bugs.python.org/issue?@action=redirect&bpo=38359]: 确保 pyw.exe 启动器读取正确的注册表键。

bpo-38355 [https://bugs.python.org/issue?@action=redirect&bpo=38355]: 修复 ntpath.realpath 在 sys.executable 上失败的问题。

bpo-38117 [https://bugs.python.org/issue?@action=redirect&bpo=38117]: 更新捆绑的OpenSSL至1.1.1d

bpo-38092 [https://bugs.python.org/issue?@action=redirect&bpo=38092]: 减少在Windows虚拟环境中使用多进程时的开销。

bpo-38133 [https://bugs.python.org/issue?@action=redirect&bpo=38133]: 允许py.exe启动器定位来自Microsoft Store的安装，并改进活动虚拟环境的显示。

bpo-38114 [https://bugs.python.org/issue?@action=redirect&bpo=38114]: pip.ini 不再包含在Nuget包中。

bpo-32592 [https://bugs.python.org/issue?@action=redirect&bpo=32592]: 将Windows 8设置为API支持的最低要求版本

bpo-36634 [https://bugs.python.org/issue?@action=redirect&bpo=36634]: os.cpu_count() 现在返回活动处理器而非最大处理器。

bpo-36634 [https://bugs.python.org/issue?@action=redirect&bpo=36634]: 当现有变量包含双引号字符时，venv activate.bat现在可以工作。

bpo-38081 [https://bugs.python.org/issue?@action=redirect&bpo=38081]: 防止在 'NUL' 上调用 os.path.realpath() 时出错。

bpo-38087 [https://bugs.python.org/issue?@action=redirect&bpo=38087]: 修复test_pathlib和test_ntpath中的大小写敏感性。

bpo-38088 [https://bugs.python.org/issue?@action=redirect&bpo=38088]: 修复仅安装v142工具集时，distutils找不到vcruntime140.dll的问题。

bpo-37283 [https://bugs.python.org/issue?@action=redirect&bpo=37283]: 确保命令行和unattend.xml设置覆盖Windows安装程序中先前检测到的状态。

bpo-38030 [https://bugs.python.org/issue?@action=redirect&bpo=38030]: 修复 os.stat() 在Windows上对块设备失败的问题。

bpo-38020 [https://bugs.python.org/issue?@action=redirect&bpo=38020]: 修复在调用 os.readlink() (或间接通过 realpath()) 时，如果文件不是支持的链接可能导致崩溃的问题。

bpo-37705 [https://bugs.python.org/issue?@action=redirect&bpo=37705]: 改进 winerror_to_errno() 的实现。

bpo-37549 [https://bugs.python.org/issue?@action=redirect&bpo=37549]: os.dup() 在 Windows 7 上不再为标准流失败。

bpo-1311 [https://bugs.python.org/issue?@action=redirect&bpo=1311]: Windows 上的 nul 文件现在从 exists() 返回 True，并从 os.stat() 返回一个有效结果，设置了 S_IFCHR。

bpo-9949 [https://bugs.python.org/issue?@action=redirect&bpo=9949]: 在 os.realpath() 中启用对符号链接的支持。

bpo-37834 [https://bugs.python.org/issue?@action=redirect&bpo=37834]: 在 os.lstat() 中将 Windows 上的所有名称代理重解析点和其他重解析点在 os.stat() 中视为常规文件。

bpo-36266 [https://bugs.python.org/issue?@action=redirect&bpo=36266]: 在 _PyImport_FindSharedFuncptrWindows() 中模块导入期间发生 DLL 加载失败时，在格式化的错误消息中添加模块名称。由 Srinivas Nyayapati 提供补丁。

bpo-25172 [https://bugs.python.org/issue?@action=redirect&bpo=25172]: Trying to import the crypt module on Windows will result in an ImportError with a message explaining that the module isn't supported on Windows. On other platforms, if the underlying _crypt module is not available, the ImportError will include a message explaining the problem.

bpo-37778 [https://bugs.python.org/issue?@action=redirect&bpo=37778]: 修复用于 Microsoft Store 包的文件关联的图标。

bpo-37734 [https://bugs.python.org/issue?@action=redirect&bpo=37734]: 修复使用注册表值从 Microsoft Store 应用启动 Python 的问题。

bpo-37702 [https://bugs.python.org/issue?@action=redirect&bpo=37702]: Fix memory leak on Windows in creating an SSLContext object or running urllib.request.urlopen('https://...').

bpo-37672 [https://bugs.python.org/issue?@action=redirect&bpo=37672]: 将 Windows Store 包的 pip 切换到使用捆绑的 pip.ini 而不是 PIP_USER 变量。

bpo-10945 [https://bugs.python.org/issue?@action=redirect&bpo=10945]: 正式放弃在非 Windows 系统上创建 bdist_wininst 安装程序的支持。

bpo-37445 [https://bugs.python.org/issue?@action=redirect&bpo=37445]: 在 FormatMessageW() 调用中包含 FORMAT_MESSAGE_IGNORE_INSERTS 标志。

bpo-37369 [https://bugs.python.org/issue?@action=redirect&bpo=37369]: 修复从 Microsoft Store 运行时 sys.executable 的路径。

bpo-37380 [https://bugs.python.org/issue?@action=redirect&bpo=37380]: 在Windows上，不再通过 subprocess._active 收集未完成的进程以供后续清理。由Ruslan Kuprieiev提供补丁。

bpo-37351 [https://bugs.python.org/issue?@action=redirect&bpo=37351]: 从标准的Windows发行版中移除libpython38.a。

bpo-35360 [https://bugs.python.org/issue?@action=redirect&bpo=35360]: 更新Windows构建以使用SQLite 3.28.0。

bpo-37267 [https://bugs.python.org/issue?@action=redirect&bpo=37267]: 在Windows上，os.dup() 处理字符文件时不再创建可继承的文件描述符。

bpo-36779 [https://bugs.python.org/issue?@action=redirect&bpo=36779]: 确保在活动代码页设置为CP_UTF7或CP_UTF8时，Windows上的 time.tzname 是正确的。

bpo-32587 [https://bugs.python.org/issue?@action=redirect&bpo=32587]: Make winreg.REG_MULTI_SZ support zero-length strings.

bpo-28269 [https://bugs.python.org/issue?@action=redirect&bpo=28269]: Replace use of strcasecmp() for the system function _stricmp(). Patch by Minmin Gong.

bpo-36590 [https://bugs.python.org/issue?@action=redirect&bpo=36590]: 向socket模块添加原生蓝牙RFCOMM支持。

macOS

bpo-38117 [https://bugs.python.org/issue?@action=redirect&bpo=38117]: 在macOS安装程序中更新OpenSSL至1.1.1d。

bpo-38089 [https://bugs.python.org/issue?@action=redirect&bpo=38089]: 将Azure Pipelines迁移至最新的VM版本，并使macOS测试变为可选。

bpo-18049 [https://bugs.python.org/issue?@action=redirect&bpo=18049]: 在macOS上将线程的默认堆栈大小从5MB增加到16MB，以匹配主线程的堆栈大小。这避免了线程深度递归时的崩溃。

bpo-34602 [https://bugs.python.org/issue?@action=redirect&bpo=34602]: 通过在运行时不再调用resource.setrlimit来增加进程堆栈大小限制，避免在macOS上的测试套件失败。由于解释器正在构建为更大的默认堆栈大小，运行时更改不再需要。

bpo-35360 [https://bugs.python.org/issue?@action=redirect&bpo=35360]: 更新macOS安装程序以使用SQLite 3.28.0。

bpo-34631 [https://bugs.python.org/issue?@action=redirect&bpo=34631]: 在macOS安装程序中更新OpenSSL至1.1.1c。

IDLE

bpo-26353 [https://bugs.python.org/issue?@action=redirect&bpo=26353]: 停止在保存IDLE shell窗口时添加新行。

bpo-4630 [https://bugs.python.org/issue?@action=redirect&bpo=4630]: 添加一个选项来切换IDLE的shell、编辑器和输出窗口的光标闪烁。参见设置、常规、窗口首选项、光标闪烁。由Zackery Spytz提供补丁。

bpo-38598 [https://bugs.python.org/issue?@action=redirect&bpo=38598]: 不尝试编译IDLE shell或输出窗口

bpo-36698 [https://bugs.python.org/issue?@action=redirect&bpo=36698]: IDLE在向stderr写入不可编码的字符时不再失败。现在它会像常规的Python解释器一样用反斜杠转义它们。添加了标准流的 errors 字段。

bpo-35379 [https://bugs.python.org/issue?@action=redirect&bpo=35379]: 退出IDLE时，捕获任何AttributeError。当EditorWindow.close被调用两次时会发生一次。当IDLE从终端运行时，打印回溯是无用且烦人的。

bpo-38183 [https://bugs.python.org/issue?@action=redirect&bpo=38183]: 为避免问题，test_idle忽略用户配置目录。它不再尝试创建或访问.idlerc或其中的任何文件。用户必须运行IDLE来发现保存设置时的问题。

bpo-38077 [https://bugs.python.org/issue?@action=redirect&bpo=38077]: IDLE在初始化用户命名空间时不再添加'argv'。此错误仅影响3.7.4和3.8.0b2至3.8.0b4版本。

bpo-38041 [https://bugs.python.org/issue?@action=redirect&bpo=38041]: Shell重启行现在填满窗口宽度，始终以'='开头，并避免不必要的换行。如果包含的文件名相对于宽度较长，行仍会换行。

bpo-35771 [https://bugs.python.org/issue?@action=redirect&bpo=35771]: 为避免在较慢的机器上偶尔出现的虚假test_idle失败，增加test_tooltip中的``hover_delay``。

bpo-37824 [https://bugs.python.org/issue?@action=redirect&bpo=37824]: 正确处理IDLE shell中的用户输入警告。停止将SyntaxWarnings转为SyntaxErrors。

bpo-37929 [https://bugs.python.org/issue?@action=redirect&bpo=37929]: 当没有shell窗口时，IDLE设置对话框现在能正确关闭。

bpo-37902 [https://bugs.python.org/issue?@action=redirect&bpo=37902]: 为IDLE模块、路径和堆栈浏览器添加鼠标滚轮滚动。由George Zhang提供补丁。

bpo-37849 [https://bugs.python.org/issue?@action=redirect&bpo=37849]: 修复了补全列表在当前行上方显示时过高或过低的问题。

bpo-36419 [https://bugs.python.org/issue?@action=redirect&bpo=36419]: 重构IDLE自动补全并改进测试。

bpo-37748 [https://bugs.python.org/issue?@action=redirect&bpo=37748]: 重新排序运行菜单。将最常见的选择，运行模块，放在顶部。

bpo-37692 [https://bugs.python.org/issue?@action=redirect&bpo=37692]: 通过示例shell交互和改进的shell元素标签来改善高亮配置示例。

bpo-37628 [https://bugs.python.org/issue?@action=redirect&bpo=37628]: 设置对话框不再随字体大小扩展。

bpo-37627 [https://bugs.python.org/issue?@action=redirect&bpo=37627]: 使用最近一次输入的命令行参数初始化自定义运行对话框。用户可以在提交前选择编辑。

bpo-33610 [https://bugs.python.org/issue?@action=redirect&bpo=33610]: 修复首次切换时代码上下文未显示正确上下文的问题。

bpo-37530 [https://bugs.python.org/issue?@action=redirect&bpo=37530]: 优化代码上下文以减少不必要的后台活动。字体和高亮更改现在与文本更改同时进行，而不是在随机延迟后。

bpo-27452 [https://bugs.python.org/issue?@action=redirect&bpo=27452]: 通过内联 RemoveFile 和简化 CreateConfigHandlers 中 file 的处理来清理 config.py。

bpo-37325 [https://bugs.python.org/issue?@action=redirect&bpo=37325]: 修复帮助源和自定义运行对话框的标签焦点遍历顺序。

bpo-37321 [https://bugs.python.org/issue?@action=redirect&bpo=37321]: 现在，两个子进程连接错误消息都指向IDLE文档的'启动失败'部分。

bpo-17535 [https://bugs.python.org/issue?@action=redirect&bpo=17535]: 为IDLE编辑器窗口添加可选的行号。除非在配置对话框的常规标签中设置，否则窗口打开时不显示行号。

bpo-26806 [https://bugs.python.org/issue?@action=redirect&bpo=26806]: 为了补偿由IDLE添加的堆栈帧并避免低递归限制可能带来的问题，用户代码执行过程中的限制增加了30。报告递归限制时减去30，使这一增加大部分透明。

bpo-37177 [https://bugs.python.org/issue?@action=redirect&bpo=37177]: 正确地将搜索对话框'附加'到其主窗口，使其行为类似于其他对话框，并且不会隐藏在主窗口后面。

bpo-37039 [https://bugs.python.org/issue?@action=redirect&bpo=37039]: 通过首次使用特定屏幕时暂时最大化窗口来调整“缩放高度”以适应单个屏幕。更改屏幕设置可能会使保存的高度无效。窗口最大化时，“缩放高度”无效。

bpo-35763 [https://bugs.python.org/issue?@action=redirect&bpo=35763]: 通过仅在首行有空间时添加关于'/'仅表示位置的提示，使调用提示提醒不那么显眼。

bpo-5680 [https://bugs.python.org/issue?@action=redirect&bpo=5680]: 在运行菜单中添加'运行...定制'以使用定制设置运行模块。输入的任何'命令行参数'都会添加到sys.argv。可以抑制正常的Shell主模块重启。

bpo-36390 [https://bugs.python.org/issue?@action=redirect&bpo=36390]: 将格式菜单功能收集到format.py中。合并paragraph.py、rstrip.py和editor.py中的格式方法。

工具/示例

bpo-38118 [https://bugs.python.org/issue?@action=redirect&bpo=38118]: 更新Valgrind抑制文件以忽略在使用GCC内置strcmp()时 PyUnicode_Decode() 中的误报。

bpo-38347 [https://bugs.python.org/issue?@action=redirect&bpo=38347]: pathfix.py：递归工作时，假设所有以'.py'结尾的文件都是Python脚本。

bpo-37803 [https://bugs.python.org/issue?@action=redirect&bpo=37803]: pdb的 --help 和 --version 长选项现在可以工作了。

bpo-37942 [https://bugs.python.org/issue?@action=redirect&bpo=37942]: 改进ArgumentClinic对浮点数的转换器。

bpo-37704 [https://bugs.python.org/issue?@action=redirect&bpo=37704]: 移除 Tools/scripts/h2py.py：使用cffi在Python中访问C API。

bpo-37675 [https://bugs.python.org/issue?@action=redirect&bpo=37675]: 2to3现在可以从压缩的标准库中运行。

bpo-37034 [https://bugs.python.org/issue?@action=redirect&bpo=37034]: Argument Clinic现在在使用仅关键字参数的错误时使用参数名称而不是它们的位置。补丁由Rémi Lapeyre贡献。

bpo-37064 [https://bugs.python.org/issue?@action=redirect&bpo=37064]: 向pathscript.py脚本添加选项-k：保留shebang标志。向pathscript.py脚本添加选项-a：添加标志。

C API

bpo-37633 [https://bugs.python.org/issue?@action=redirect&bpo=37633]: 重新导出 pythonrun.h 中一些宏的函数兼容性包装器。

bpo-38644 [https://bugs.python.org/issue?@action=redirect&bpo=38644]: 为有限API提供 Py_EnterRecursiveCall() 和 Py_LeaveRecursiveCall() 作为常规函数。之前，它们被定义为宏，但这些宏无法与有限API一起工作，因为有限API无法访问 PyThreadState.recursion_depth 字段。从稳定ABI中移除``_Py_CheckRecursionLimit``。

bpo-38650 [https://bugs.python.org/issue?@action=redirect&bpo=38650]: 全局变量 PyStructSequence_UnnamedField 现在是一个常量，并引用一个常量字符串。

bpo-38540 [https://bugs.python.org/issue?@action=redirect&bpo=38540]: 修复了在未定义宏 PY_SSIZE_T_CLEAN 时，PyArg_Parse() 及类似函数对于格式单元 "es#" 和 "et#" 可能的内存泄漏。

bpo-38395 [https://bugs.python.org/issue?@action=redirect&bpo=38395]: 修复了由于在调用可能删除代理引用的对象的最后一个引用的某些关联方法时，weakref.proxy 对象的生命周期管理不正确而导致的崩溃。由Pablo Galindo提供补丁。

bpo-36389 [https://bugs.python.org/issue?@action=redirect&bpo=36389]: _PyObject_CheckConsistency() 函数现在在发布模式下也可用。例如，它可以用于调试GC中 visit_decref() 函数的崩溃。

bpo-38266 [https://bugs.python.org/issue?@action=redirect&bpo=38266]: 恢复PyThreadState_DeleteCurrent()的移除，并附带文档。

bpo-38303 [https://bugs.python.org/issue?@action=redirect&bpo=38303]: 更新audioop扩展模块以使用稳定的ABI（PEP-384）。由Tyler Kieft提供补丁。

bpo-38234 [https://bugs.python.org/issue?@action=redirect&bpo=38234]: Py_SetPath() now sets sys.executable to the program full path (Py_GetProgramFullPath()) rather than to the program name (Py_GetProgramName()).

bpo-38234 [https://bugs.python.org/issue?@action=redirect&bpo=38234]: Python ignored arguments passed to Py_SetPath(), Py_SetPythonHome() and Py_SetProgramName(): fix Python initialization to use specified arguments.

bpo-38205 [https://bugs.python.org/issue?@action=redirect&bpo=38205]: Py_UNREACHABLE() 宏现在调用 Py_FatalError()。

bpo-38140 [https://bugs.python.org/issue?@action=redirect&bpo=38140]: 通过PyMemberDef传递偏移量，使dict和weakref的偏移量对于C堆类型变得不透明。

bpo-15088 [https://bugs.python.org/issue?@action=redirect&bpo=15088]: C函数 PyGen_NeedsFinalizing 已被移除。它没有被记录、测试或在CPython中任何地方使用，在 PEP 442 [https://www.python.org/dev/peps/pep-0442] 的实现之后。由Joannah Nanjekye提供补丁。（由Joannah Nanjekye提供补丁）

bpo-36763 [https://bugs.python.org/issue?@action=redirect&bpo=36763]: 由 PySys_AddXOption() 添加的选项现在与 PyConfig.xoptions 和命令行 -X 选项以相同的方式处理。

bpo-37926 [https://bugs.python.org/issue?@action=redirect&bpo=37926]: 修复 PySys_SetArgvEx(0, NULL, 0) 中的崩溃。

bpo-37879 [https://bugs.python.org/issue?@action=redirect&bpo=37879]: 修复subtype_dealloc以在基类型为C堆类型时抑制类型递减引用计数。

bpo-37645 [https://bugs.python.org/issue?@action=redirect&bpo=37645]: Add _PyObject_FunctionStr() to get a user-friendly string representation of a function-like object. Patch by Jeroen Demeyer.

bpo-29548 [https://bugs.python.org/issue?@action=redirect&bpo=29548]: 函数 PyEval_CallObject、PyEval_CallFunction、PyEval_CallMethod 和 PyEval_CallObjectWithKeywords 已被弃用。请改用 PyObject_Call() 及其变体。

bpo-37151 [https://bugs.python.org/issue?@action=redirect&bpo=37151]: PyCFunction_Call 现在是 PyObject_Call() 的弃用别名。

bpo-37540 [https://bugs.python.org/issue?@action=redirect&bpo=37540]: vectorcall协议现在要求调用者仅将字符串作为关键字名称传递。

bpo-37207 [https://bugs.python.org/issue?@action=redirect&bpo=37207]: vectorcall协议现在对 type 对象启用：将 tp_vectorcall 设置为一个vectorcall函数，用于在调用类本身时替代 tp_new 和 tp_init。

bpo-21120 [https://bugs.python.org/issue?@action=redirect&bpo=21120]: 将Python-ast.h、ast.h和asdl.h排除在有限API之外。

bpo-37483 [https://bugs.python.org/issue?@action=redirect&bpo=37483]: 新增函数 _PyObject_CallOneArg，用于调用带有一个位置参数的对象。

bpo-36763 [https://bugs.python.org/issue?@action=redirect&bpo=36763]: Add PyConfig_SetWideStringList() function.

bpo-37337 [https://bugs.python.org/issue?@action=redirect&bpo=37337]: Add fast functions for calling methods: _PyObject_VectorcallMethod(), _PyObject_CallMethodNoArgs() and _PyObject_CallMethodOneArg().

bpo-28805 [https://bugs.python.org/issue?@action=redirect&bpo=28805]: The METH_FASTCALL calling convention has been documented.

bpo-37221 [https://bugs.python.org/issue?@action=redirect&bpo=37221]: The new function PyCode_NewWithPosOnlyArgs() allows to create code objects like PyCode_New(), but with an extra posonlyargcount parameter for indicating the number of positonal-only arguments.

bpo-37215 [https://bugs.python.org/issue?@action=redirect&bpo=37215]: 修复由 bpo-36842 [https://bugs.python.org/issue?@action=redirect&bpo=36842] 引入的dtrace问题。

bpo-37194 [https://bugs.python.org/issue?@action=redirect&bpo=37194]: 向C API添加一个新的公共 PyObject_CallNoArgs() 函数：调用一个可调用的Python对象而不带任何参数。这是调用不带任何参数的回调函数的最有效方式。例如，在x86-64上，``PyObject_CallFunctionObjArgs(func, NULL)``每次调用在栈上分配960字节，而``PyObject_CallNoArgs(func)``每次调用仅分配624字节。

bpo-37170 [https://bugs.python.org/issue?@action=redirect&bpo=37170]: 修复 PyLong_AsUnsignedLongLongMask() 中的错误转换。

bpo-35381 [https://bugs.python.org/issue?@action=redirect&bpo=35381]: 将posixmodule.c中静态分配的类型 DirEntryType 和 ScandirIteratorType 转换为堆分配类型。

bpo-34331 [https://bugs.python.org/issue?@action=redirect&bpo=34331]: Use singular/plural noun in error message when instantiating an abstract class with non-overriden abstract method(s).

Python 3.8.0 beta 1

发布日期: 2019-06-04

安全性

bpo-35907 [https://bugs.python.org/issue?@action=redirect&bpo=35907]: CVE-2019-9948: Avoid file reading by disallowing local-file:// and local_file:// URL schemes in URLopener().open() and URLopener().retrieve() of urllib.request.

bpo-33529 [https://bugs.python.org/issue?@action=redirect&bpo=33529]: 防止在电子邮件头编码中使用的fold函数在头中有太多非ASCII字符时进入无限循环。

bpo-33164 [https://bugs.python.org/issue?@action=redirect&bpo=33164]: 更新了blake2实现，使用平台提供的安全memset实现。

核心与内置函数

bpo-35814 [https://bugs.python.org/issue?@action=redirect&bpo=35814]: 允许在带注释的赋值的右侧进行解包。特别是，现在允许``t: Tuple[int, ...] = x, y, z``。

bpo-37126 [https://bugs.python.org/issue?@action=redirect&bpo=37126]: 现在所有structseq对象都由垃圾收集器跟踪。由Pablo Galindo提交的补丁。

bpo-37122 [https://bugs.python.org/issue?@action=redirect&bpo=37122]: 使代码对象的 co_argcount 属性表示位置参数的总数（包括仅限位置参数）。co_posonlyargcount 的值可用于区分哪些参数是仅限位置的，而差值（co_argcount - co_posonlyargcount）是位置或关键字参数的数量。由Pablo Galindo提交的补丁。

bpo-20092 [https://bugs.python.org/issue?@action=redirect&bpo=20092]: int、float 和 complex 的构造函数现在将使用 __index__() 特殊方法，如果可用且相应的 __int__()、__float__() 或 __complex__() 方法不可用。

bpo-37087 [https://bugs.python.org/issue?@action=redirect&bpo=37087]: 向OpenBSD添加原生线程ID（TID）支持。

bpo-26219 [https://bugs.python.org/issue?@action=redirect&bpo=26219]: 实现了每操作码缓存机制，``LOAD_GLOBAL``指令使用它。``LOAD_GLOBAL``现在快了约40%。由Yury Selivanov和Inada Naoki贡献。

bpo-37072 [https://bugs.python.org/issue?@action=redirect&bpo=37072]: 当flags为NULL时，修复PyAST_FromNodeObject()中的崩溃。

bpo-37029 [https://bugs.python.org/issue?@action=redirect&bpo=37029]: 由于使用线性搜索来保持 obmalloc.c 的可用的arena列表按空闲内存池数量的顺序排序，释放大量小对象可能需要与arena数量的平方成正比的时间。现在无需搜索即可完成，使最坏情况下的时间与arena数量成线性关系。对于这一点非常明显的程序（通常同时有超过10万个小对象存活），这可以大大减少释放其内存所需的时间。

bpo-26423 [https://bugs.python.org/issue?@action=redirect&bpo=26423]: 当 sizeof(long) < sizeof(Py_ssize_t) (例如，64位Windows) 时，修复``wrap_lenfunc()``中可能的溢出。

bpo-37050 [https://bugs.python.org/issue?@action=redirect&bpo=37050]: 改进用于“调试”f字符串的AST，这些字符串使用'='来打印出正在评估的表达式的源代码。从FormattedValue节点中删除expr_text，转而使用一个Constant字符串节点（可能与f字符串内部的相邻常量表达式合并）。

bpo-22385 [https://bugs.python.org/issue?@action=redirect&bpo=22385]: The bytes.hex, bytearray.hex, and memoryview.hex methods as well as the binascii.hexlify and b2a_hex functions now have the ability to include an optional separator between hex bytes. This functionality was inspired by MicroPython's hexlify implementation.

bpo-26836 [https://bugs.python.org/issue?@action=redirect&bpo=26836]: 添加 os.memfd_create()。

bpo-37032 [https://bugs.python.org/issue?@action=redirect&bpo=37032]: 向代码类型(types.CodeType)添加了新的 replace() 方法。

bpo-37007 [https://bugs.python.org/issue?@action=redirect&bpo=37007]: Implement socket.if_nameindex(), socket.if_nametoindex(), and socket.if_indextoname() on Windows.

bpo-36829 [https://bugs.python.org/issue?@action=redirect&bpo=36829]: PyErr_WriteUnraisable() 现在在没有当前回溯的情况下创建一个回溯对象。此外，调用 PyErr_NormalizeException() 和 PyException_SetTraceback() 以规范化异常值。忽略任何错误。

bpo-36878 [https://bugs.python.org/issue?@action=redirect&bpo=36878]: Only accept text after # type: ignore if the first character is ASCII. This is to disallow things like # type: ignoreé.

bpo-36878 [https://bugs.python.org/issue?@action=redirect&bpo=36878]: Store text appearing after a # type: ignore comment in the AST. For example a type ignore like # type: ignore[E1000] will have the string "[E1000]" stored in its AST node.

bpo-2180 [https://bugs.python.org/issue?@action=redirect&bpo=2180]: 由Anthony Sottile处理的，将EOF处的行延续视为 SyntaxError。

bpo-36907 [https://bugs.python.org/issue?@action=redirect&bpo=36907]: 修复了在调用带有关键字字典(f(**kwargs))的C函数并在该函数运行时更改字典``kwargs``时崩溃的问题。

bpo-36946 [https://bugs.python.org/issue?@action=redirect&bpo=36946]: 修复处理切片时可能出现的带符号整数溢出。

bpo-36826 [https://bugs.python.org/issue?@action=redirect&bpo=36826]: 向ast_unparse.c添加NamedExpression种类支持。

bpo-1875 [https://bugs.python.org/issue?@action=redirect&bpo=1875]: 如果将被优化掉的代码块（例如总是为假的if条件）包含语法错误，现在会引发 SyntaxError。由Pablo Galindo提供补丁。

bpo-36027 [https://bugs.python.org/issue?@action=redirect&bpo=36027]: 允许通过三参数 pow 计算模逆：现在在第一个和第三个参数互质的情况下，允许第二个参数为负数。

bpo-36861 [https://bugs.python.org/issue?@action=redirect&bpo=36861]: 更新Unicode数据库至版本12.1.0。

bpo-28866 [https://bugs.python.org/issue?@action=redirect&bpo=28866]: 避免缓存类型定义了mro()的类的属性，以避免硬缓存无效问题。

bpo-36851 [https://bugs.python.org/issue?@action=redirect&bpo=36851]: 如果执行以返回结束且堆栈不为空，现在会正确清理 FrameType 堆栈。

bpo-34616 [https://bugs.python.org/issue?@action=redirect&bpo=34616]: compile() 内置函数现在支持 ast.PyCF_ALLOW_TOP_LEVEL_AWAIT 标志，该标志允许编译包含顶层 await、async with 或 async for 的源代码。这在已经异步的函数中评估异步代码时非常有用；例如在自定义REPL中。

bpo-36842 [https://bugs.python.org/issue?@action=redirect&bpo=36842]: 实现PEP 578，添加sys.audit、io.open_code及相关API。

bpo-27639 [https://bugs.python.org/issue?@action=redirect&bpo=27639]: 修正UserList切片操作的返回类型。由Michael Blahay、Erick Cervantes和vaultah提供补丁。

bpo-36737 [https://bugs.python.org/issue?@action=redirect&bpo=36737]: 将PyRuntimeState.warnings移动到每个解释器状态（通过“模块状态”）。

bpo-36793 [https://bugs.python.org/issue?@action=redirect&bpo=36793]: 从内置类型 bool、int、float、complex 和标准库中的几个类中移除 __str__ 实现。它们现在从 object 继承 __str__()。

bpo-36817 [https://bugs.python.org/issue?@action=redirect&bpo=36817]: 为调试目的在f-字符串中添加 =``特性。这可以放在 ``!s、!r 或 !a 之前。它会生成表达式的文本，后跟等号，然后是表达式值的repr。因此，f'{3*9+15=}'``将等于字符串 ``'3*9+15=42'。如果指定了 =，则默认转换设置为 !r，除非给出了格式说明符，在这种情况下，格式化行为不变，将使用__format__。

bpo-24048 [https://bugs.python.org/issue?@action=redirect&bpo=24048]: 在import.c的 remove_module() 期间保存实时异常。

bpo-27987 [https://bugs.python.org/issue?@action=redirect&bpo=27987]: 在64位平台上，pymalloc返回的内存块对齐方式由8字节改为16字节，以符合x86-64 ABI。最近的编译器更频繁地假设这种对齐方式。由Inada Naoki提供补丁。

bpo-36601 [https://bugs.python.org/issue?@action=redirect&bpo=36601]: 从Python内部的C信号处理器中移除了一个早已无意义的 ``getpid() == main_pid``检查。

bpo-36594 [https://bugs.python.org/issue?@action=redirect&bpo=36594]: 修复了格式字符串中 %p 的错误使用。由Zackery Spytz提供补丁。

bpo-36045 [https://bugs.python.org/issue?@action=redirect&bpo=36045]: builtins.help() now prefixes async for async functions

bpo-36084 [https://bugs.python.org/issue?@action=redirect&bpo=36084]: 向threading.Thread对象添加原生线程ID（TID）（支持的平台：Windows、FreeBSD、Linux、macOS）

bpo-36035 [https://bugs.python.org/issue?@action=redirect&bpo=36035]: 添加了针对与pathlib组合使用的损坏符号链接的修复。

bpo-35983 [https://bugs.python.org/issue?@action=redirect&bpo=35983]: Added new trashcan macros to deal with a double deallocation that could occur when the tp_dealloc of a subclass calls the tp_dealloc of a base class and that base class uses the trashcan mechanism. Patch by Jeroen Demeyer.

bpo-20602 [https://bugs.python.org/issue?@action=redirect&bpo=20602]: 在关闭期间不清除 sys.flags 和 sys.float_info。由Zackery Spytz提供补丁。

bpo-26826 [https://bugs.python.org/issue?@action=redirect&bpo=26826]: 将 copy_file_range() 作为低级API暴露在 os 模块中。

bpo-32388 [https://bugs.python.org/issue?@action=redirect&bpo=32388]: 移除tp_flags中的跨版本二进制兼容性要求。

bpo-31862 [https://bugs.python.org/issue?@action=redirect&bpo=31862]: 将binascii移植到PEP 489多阶段初始化。由Marcel Plch提供补丁。

库

bpo-37128 [https://bugs.python.org/issue?@action=redirect&bpo=37128]: 添加了 math.perm()。

bpo-37120 [https://bugs.python.org/issue?@action=redirect&bpo=37120]: 添加SSLContext.num_tickets以控制TLSv1.3会话票证的数量。

bpo-12202 [https://bugs.python.org/issue?@action=redirect&bpo=12202]: Fix the error handling in msilib.SummaryInformation.GetProperty(). Patch by Zackery Spytz.

bpo-26835 [https://bugs.python.org/issue?@action=redirect&bpo=26835]: fcntl 模块现在包含了用于 memfd 密封的文件密封常量。

bpo-29262 [https://bugs.python.org/issue?@action=redirect&bpo=29262]: 向 typing 模块添加了 get_origin() 和 get_args() 内省辅助函数。

bpo-12639 [https://bugs.python.org/issue?@action=redirect&bpo=12639]: msilib.Directory.start_component() no longer fails if keyfile is not None.

bpo-36999 [https://bugs.python.org/issue?@action=redirect&bpo=36999]: 添加了 asyncio.Task.get_coro() 方法，以公开暴露任务的协程对象。

bpo-35246 [https://bugs.python.org/issue?@action=redirect&bpo=35246]: 使 asyncio.create_subprocess_exec() 接受路径类参数。

bpo-35279 [https://bugs.python.org/issue?@action=redirect&bpo=35279]: 将 ThreadPoolExecutor 的默认 max_workers 从 cpu_count() * 5 改为 min(32, cpu_count() + 4)。之前的值在多核机器上不合理地大。

bpo-37076 [https://bugs.python.org/issue?@action=redirect&bpo=37076]: _thread.start_new_thread() 现在使用 sys.unraisablehook() 而非 sys.excepthook() 记录函数抛出的未捕获异常，以便钩子能够访问抛出异常的函数。

bpo-33725 [https://bugs.python.org/issue?@action=redirect&bpo=33725]: 在 macOS 上，multiprocessing 模块现在默认使用 spawn 启动方法。

bpo-37054 [https://bugs.python.org/issue?@action=redirect&bpo=37054]: Fix destructor _pyio.BytesIO and _pyio.TextIOWrapper: initialize their _buffer attribute as soon as possible (in the class body), because it's used by __del__() which calls close().

bpo-37058 [https://bugs.python.org/issue?@action=redirect&bpo=37058]: PEP 544：向 typing 模块添加了 Protocol 和 @runtime_checkable。

bpo-36933 [https://bugs.python.org/issue?@action=redirect&bpo=36933]: 已在 3.8 版本中弃用并标记为移除的函数 sys.set_coroutine_wrapper 和 sys.get_coroutine_wrapper 已被移除。

bpo-37047 [https://bugs.python.org/issue?@action=redirect&bpo=37047]: 在 unittest.mock.AsyncMock 设置中处理延迟绑定和属性访问以进行自动规范。记录在 unittest.mock.MagicMock 中新实现的异步方法。

bpo-37049 [https://bugs.python.org/issue?@action=redirect&bpo=37049]: PEP 589：向 typing 模块添加了 TypedDict。

bpo-37046 [https://bugs.python.org/issue?@action=redirect&bpo=37046]: PEP 586：向 typing 模块添加了 Literal。

bpo-37045 [https://bugs.python.org/issue?@action=redirect&bpo=37045]: PEP 591: 向 typing 模块添加 Final 限定符和 @final 装饰器。

bpo-37035 [https://bugs.python.org/issue?@action=redirect&bpo=37035]: 如果 asyncio 传输中发生致命错误，则不要记录基于 OSError 的异常。对端可以生成几乎任何 OSError，用户无法通过修复自己的代码来避免这些异常。错误仍然会传播到用户代码，只是记录它们没有意义，并且会污染 asyncio 日志。

bpo-37001 [https://bugs.python.org/issue?@action=redirect&bpo=37001]: symtable.symtable() 现在接受与内置 compile() 函数相同的源代码输入类型。由 Dino Viehland 提供补丁。

bpo-37028 [https://bugs.python.org/issue?@action=redirect&bpo=37028]: 实现 asyncio REPL

bpo-37027 [https://bugs.python.org/issue?@action=redirect&bpo=37027]: 从 transport.get_extra_info('socket') 返回安全使用的代理套接字对象

bpo-32528 [https://bugs.python.org/issue?@action=redirect&bpo=32528]: 使 asyncio.CancelledError 成为 BaseException。

这将解决许多 asyncio 用户常犯的一个错误：一个“except Exception”子句破坏了任务的取消。

除了这一变更，我们还将停止让 asyncio.TimeoutError 和 asyncio.InvalidStateError 继承自它们的 concurrent.futures.* 对应项。这些异常共享继承链没有意义。

bpo-1230540 [https://bugs.python.org/issue?@action=redirect&bpo=1230540]: 添加一个新的 threading.excepthook() 函数，用于处理未捕获的 threading.Thread.run() 异常。可以重写此函数以控制如何处理未捕获的 threading.Thread.run() 异常。

bpo-36996 [https://bugs.python.org/issue?@action=redirect&bpo=36996]: 处理 unittest.mock.patch() 用作异步函数装饰器的情况。

bpo-37008 [https://bugs.python.org/issue?@action=redirect&bpo=37008]: 添加支持对由 unittest.mock.mock_open() 产生的 mock 调用 next()

bpo-27737 [https://bugs.python.org/issue?@action=redirect&bpo=27737]: 在 email.header 中允许仅包含空白的头编码 - 由 Batuhan Taskaya 提供

bpo-36969 [https://bugs.python.org/issue?@action=redirect&bpo=36969]: PDB command args now display positional only arguments. Patch contributed by Rémi Lapeyre.

bpo-36969 [https://bugs.python.org/issue?@action=redirect&bpo=36969]: PDB command args now display keyword only arguments. Patch contributed by Rémi Lapeyre.

bpo-36983 [https://bugs.python.org/issue?@action=redirect&bpo=36983]: 向 typing.__all__ 添加缺失的名称：ChainMap、ForwardRef、OrderedDict - 由 Anthony Sottile 提供。

bpo-36972 [https://bugs.python.org/issue?@action=redirect&bpo=36972]: Add SupportsIndex protocol to the typing module to allow type checking to detect classes that can be passed to hex(), oct() and bin().

bpo-32972 [https://bugs.python.org/issue?@action=redirect&bpo=32972]: 实现 unittest.IsolatedAsyncioTestCase 以帮助测试基于 asyncio 的代码。

bpo-36952 [https://bugs.python.org/issue?@action=redirect&bpo=36952]: fileinput.input() 和 fileinput.FileInput 的 bufsize 参数已被移除（自 Python 3.6 起已弃用并被忽略），因此 mode 和 openhook 参数已被设为仅关键字参数。

bpo-36952 [https://bugs.python.org/issue?@action=redirect&bpo=36952]: 从 Python 3.3 开始，从 collections 导入 ABCs 已被弃用，应从 collections.abc 导入。仍然能够从 collections 导入的功能原计划在 3.8 中移除，但已推迟到 3.9；文档和 DeprecationWarning 已明确说明。

bpo-36949 [https://bugs.python.org/issue?@action=redirect&bpo=36949]: 为 WeakSet 对象实现 __repr__。

bpo-36948 [https://bugs.python.org/issue?@action=redirect&bpo=36948]: 修复 urllib.request.URLopener.retrieve() 中的 NameError。补丁由 Karthikeyan Singaravelan 提供。

bpo-33524 [https://bugs.python.org/issue?@action=redirect&bpo=33524]: 当 max_line_length 为 0 或 None 且标题包含非 ASCII 字符时，修复电子邮件标题的折叠。由 Licht Takeuchi (@Licht-T) 贡献。

bpo-24564 [https://bugs.python.org/issue?@action=redirect&bpo=24564]: shutil.copystat() 现在忽略 os.setxattr() 上的 errno.EINVAL，这可能在复制不支持扩展属性的文件系统上的文件时发生。

原始由 Giampaolo Rodola 提供补丁，由 Ying Wang 更新。

bpo-36888 [https://bugs.python.org/issue?@action=redirect&bpo=36888]: Python 子进程现在可以使用 multiprocessing.process.parent_process 访问其父进程的状态。

bpo-36921 [https://bugs.python.org/issue?@action=redirect&bpo=36921]: 弃用 @coroutine 以支持 async def。

bpo-25652 [https://bugs.python.org/issue?@action=redirect&bpo=25652]: 修复 UserString 的 __rmod__ 中的错误 - 由 Batuhan Taskaya 提供。

bpo-36916 [https://bugs.python.org/issue?@action=redirect&bpo=36916]: 当 writer.write() 在没有 await 的情况下使用且 writer.drain() 因异常失败时，移除关于任务中未处理异常的消息。

bpo-36889 [https://bugs.python.org/issue?@action=redirect&bpo=36889]: 引入 asyncio.Stream 类，合并了 asyncio.StreamReader 和 asyncio.StreamWriter 的功能。asyncio.Stream 可以在只读、只写和读写模式下工作。提供 asyncio.connect()、asyncio.connect_unix()、asyncio.connect_read_pipe() 和 asyncio.connect_write_pipe() 工厂函数来打开 asyncio.Stream 连接。提供 asyncio.StreamServer 和 UnixStreamServer 来使用 asyncio.Stream API 服务服务器。修改 asyncio.create_subprocess_shell() 和 asyncio.create_subprocess_exec() 以使用 asyncio.Stream 替代已弃用的 StreamReader 和 StreamWriter。弃用 asyncio.StreamReader 和 asyncio.StreamWriter。弃用在 asyncio 包之外使用私有类，例如 asyncio.FlowControlMixing 和 asyncio.StreamReaderProtocol。

bpo-36845 [https://bugs.python.org/issue?@action=redirect&bpo=36845]: 在 ipaddress 模块中增加了对 IP 网络和接口构造时的整数前缀的验证。

bpo-23378 [https://bugs.python.org/issue?@action=redirect&bpo=23378]: 向 argparser 添加了一个扩展动作。

bpo-36867 [https://bugs.python.org/issue?@action=redirect&bpo=36867]: 修复了一个错误，该错误使得 SharedMemoryManager 实例及其父进程使用两个独立的 resource_tracker 进程。

bpo-23896 [https://bugs.python.org/issue?@action=redirect&bpo=23896]: 向 lib2to3.pygram 添加了一个语法，其中包含作为函数而非语句的 exec。

bpo-36895 [https://bugs.python.org/issue?@action=redirect&bpo=36895]: 函数 time.clock() 在 3.3 版本中被弃用，推荐使用 time.perf_counter()，并在 3.8 版本中标记为移除，现已被移除。

bpo-35545 [https://bugs.python.org/issue?@action=redirect&bpo=35545]: 修复 asyncio 在内部确保主机名解析时丢弃 IPv6 范围的问题。

bpo-36887 [https://bugs.python.org/issue?@action=redirect&bpo=36887]: 添加新函数 math.isqrt() 来计算整数平方根。

bpo-34632 [https://bugs.python.org/issue?@action=redirect&bpo=34632]: 引入 importlib.metadata 模块，提供（临时）支持从第三方包读取元数据。

bpo-36878 [https://bugs.python.org/issue?@action=redirect&bpo=36878]: When using type_comments=True in ast.parse, treat # type: ignore followed by a non-alphanumeric character and then arbitrary text as a type ignore, instead of requiring nothing but whitespace or another comment. This is to permit formations such as # type: ignore[E1000].

bpo-36778 [https://bugs.python.org/issue?@action=redirect&bpo=36778]: cp65001 编码（Windows 代码页 65001）成为 utf_8 编码的别名。

bpo-36867 [https://bugs.python.org/issue?@action=redirect&bpo=36867]: multiprocessing.resource_tracker 替换了 multiprocessing.semaphore_tracker 模块。除了信号量，resource_tracker 还跟踪 shared_memory 段。

bpo-30262 [https://bugs.python.org/issue?@action=redirect&bpo=30262]: sqlite3 模块的 Cache 和 Statement 对象不向用户公开。由 Aviv Palivoda 提供补丁。

bpo-24538 [https://bugs.python.org/issue?@action=redirect&bpo=24538]: In shutil.copystat(), first copy extended file attributes and then file permissions, since extended attributes can only be set on the destination while it is still writeable.

bpo-36829 [https://bugs.python.org/issue?@action=redirect&bpo=36829]: 新增 sys.unraisablehook() 函数，可被重写以控制如何处理“无法处理的异常”。当异常发生但 Python 无法处理时调用该函数。例如，当析构函数引发异常或垃圾回收期间（gc.collect()）。

bpo-36832 [https://bugs.python.org/issue?@action=redirect&bpo=36832]: 引入 zipfile.Path，一个兼容 pathlib 的包装器，用于遍历 zip 文件。

bpo-36814 [https://bugs.python.org/issue?@action=redirect&bpo=36814]: 修复 os.posix_spawnp() 在 file_actions 为 None 时错误地引发 TypeError 的问题。

bpo-33110 [https://bugs.python.org/issue?@action=redirect&bpo=33110]: 当 Future 已经完成时，正确处理由 concurrent.futures 的 add_done_callback 添加的函数引发的异常。

bpo-26903 [https://bugs.python.org/issue?@action=redirect&bpo=26903]: Limit max_workers in ProcessPoolExecutor to 61 to work around a WaitForMultipleObjects limitation.

bpo-36813 [https://bugs.python.org/issue?@action=redirect&bpo=36813]: 修复 QueueListener 在停止时调用 queue.task_done() 的问题。由 Bar Harel 提供补丁。

bpo-36806 [https://bugs.python.org/issue?@action=redirect&bpo=36806]: 禁止在asyncio包之外创建像StreamReader、StreamWriter、Process这样的异步流对象及其协议。

bpo-36802 [https://bugs.python.org/issue?@action=redirect&bpo=36802]: 为StreamWriter.write()和StreamWriter.close()提供同步和异步调用。

bpo-36801 [https://bugs.python.org/issue?@action=redirect&bpo=36801]: 在asyncio StreamWriter.drain()调用中正确处理SSL连接的关闭。

bpo-36785 [https://bugs.python.org/issue?@action=redirect&bpo=36785]: 实现PEP 574（带有带外缓冲区的pickle协议5）。

bpo-36772 [https://bugs.python.org/issue?@action=redirect&bpo=36772]: functools.lru_cache()现在可以直接用作装饰器，除了它现有的作为返回装饰器的函数的用法。

bpo-6584 [https://bugs.python.org/issue?@action=redirect&bpo=6584]: 在 gzip 模块中添加一个 BadGzipFile 异常。

bpo-36748 [https://bugs.python.org/issue?@action=redirect&bpo=36748]: 在 TextIOWrapper 的C实现中优化了写缓冲。使用ascii、latin1或utf-8编码向``TextIOWrapper``写入ASCII字符串的速度提高了约20%。由Inada Naoki提供补丁。

bpo-8138 [https://bugs.python.org/issue?@action=redirect&bpo=8138]: 不要将 wsgiref.simple_server.SimpleServer 标记为多线程，因为``wsgiref.simple_server.WSGIServer``是单线程的。

bpo-22640 [https://bugs.python.org/issue?@action=redirect&bpo=22640]: py_compile.compile() 现在支持静默模式。由Joannah Nanjekye提供补丁。

bpo-29183 [https://bugs.python.org/issue?@action=redirect&bpo=29183]: 通过仅在未引发异常时调用 close() 方法，修复了 wsgiref.handlers.BaseHandler 中的双重异常。

bpo-36548 [https://bugs.python.org/issue?@action=redirect&bpo=36548]: 改进了正则表达式标志的repr。

bpo-36542 [https://bugs.python.org/issue?@action=redirect&bpo=36542]: 现在可以通过指定 __text_signature__ 属性来覆盖Python函数的签名。

bpo-36533 [https://bugs.python.org/issue?@action=redirect&bpo=36533]: 在fork的子进程中重新初始化logging.Handler锁，而不是尝试在父进程中获取所有锁，仅在子进程中释放。获取/释放模式导致在实现了任何形式的相互依赖的链式日志处理程序的代码中出现死锁，因为无法保证锁的获取顺序。

bpo-35252 [https://bugs.python.org/issue?@action=redirect&bpo=35252]: 当使用singledispatch时，如果类型注释无效，抛出TypeError而不是AssertionError。

bpo-35900 [https://bugs.python.org/issue?@action=redirect&bpo=35900]: 允许缩减方法返回一个6项元组，其中第6项指定一个自定义的状态设置方法，该方法将被调用以替代常规的 __setstate__ 方法。

bpo-35900 [https://bugs.python.org/issue?@action=redirect&bpo=35900]: 在_pickle.c中为函数和类启用自定义缩减回调注册，使用新的Pickler属性``reducer_override``

bpo-36368 [https://bugs.python.org/issue?@action=redirect&bpo=36368]: 修复在交互式会话中发送ctrl-c（KeyboardInterrupt）后导致SharedMemoryManager实例崩溃的错误

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 修复VxWorks的mmap失败问题

bpo-27497 [https://bugs.python.org/issue?@action=redirect&bpo=27497]: csv.DictWriter.writeheader() 现在返回底层 csv.Writer.writerow() 方法的返回值。补丁由Ashish Nitin Patil贡献。

bpo-36239 [https://bugs.python.org/issue?@action=redirect&bpo=36239]: 解析.mo文件时现在忽略以#-#-#-#-#开头和结尾的注释。

bpo-26707 [https://bugs.python.org/issue?@action=redirect&bpo=26707]: 使plistlib能够读写作为KeyedArchive文件创建的二进制plist文件。具体来说，这允许plistlib处理0x80令牌作为UID对象。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为VxWorks添加posix模块支持。

bpo-35125 [https://bugs.python.org/issue?@action=redirect&bpo=35125]: Asyncio: 在shield中移除外部取消时的内部回调

bpo-35721 [https://bugs.python.org/issue?@action=redirect&bpo=35721]: Fix asyncio.SelectorEventLoop.subprocess_exec() leaks file descriptors if Popen fails and called with stdin=subprocess.PIPE. Patch by Niklas Fiekas.

bpo-31855 [https://bugs.python.org/issue?@action=redirect&bpo=31855]: unittest.mock.mock_open() 结果现在尊重read([size])的参数。补丁由Rémi Lapeyre贡献。

bpo-35431 [https://bugs.python.org/issue?@action=redirect&bpo=35431]: 实现 math.comb() 函数，返回二项式系数，计算从n个项目中无重复且无序地选择k个项目的方式数。由Yash Aggarwal和Keller Fuchs提供补丁。

bpo-26660 [https://bugs.python.org/issue?@action=redirect&bpo=26660]: 修复 TemporaryDirectory 清理中的权限错误。之前当在临时目录中创建了不可写或不可搜索的文件或目录时，``TemporaryDirectory.cleanup()``会失败。

bpo-34271 [https://bugs.python.org/issue?@action=redirect&bpo=34271]: 向ssl模块添加调试辅助功能。现在可以转储密钥材料并跟踪TLS协议。默认和stdlib上下文也支持SSLKEYLOGFILE环境变量。

bpo-26467 [https://bugs.python.org/issue?@action=redirect&bpo=26467]: 添加了AsyncMock以支持使用unittest来模拟asyncio协程。由Lisa Roach提供补丁。

bpo-33569 [https://bugs.python.org/issue?@action=redirect&bpo=33569]: dataclasses.InitVar: 暴露用于创建init变量的类型。

bpo-34424 [https://bugs.python.org/issue?@action=redirect&bpo=34424]: 修复了当policy.linesep设置为多字符字符串时，包含编码字符串的消息的序列化问题。由Jens Troeger提供补丁。

bpo-34303 [https://bugs.python.org/issue?@action=redirect&bpo=34303]: functools.reduce() 的性能略有提升。由Sergey Fedoseev提供补丁。

bpo-33361 [https://bugs.python.org/issue?@action=redirect&bpo=33361]: 修复了 codecs.StreamRecoder 中的一个错误，其中搜索可能会在缓冲区中留下旧数据并破坏后续的读取调用。由Ammar Askar提供补丁。

bpo-22454 [https://bugs.python.org/issue?@action=redirect&bpo=22454]: shlex 模块现在暴露了 shlex.join()，这是 shlex.split() 的反向操作。由Bo Bayles提供补丁。

bpo-31922 [https://bugs.python.org/issue?@action=redirect&bpo=31922]: asyncio.AbstractEventLoop.create_datagram_endpoint(): 当允许广播时，不连接UDP套接字。这允许在UDP广播后接收回复。

bpo-24882 [https://bugs.python.org/issue?@action=redirect&bpo=24882]: 更改ThreadPoolExecutor以在创建新线程之前使用现有的空闲线程。

bpo-31961 [https://bugs.python.org/issue?@action=redirect&bpo=31961]: 在Windows上的 subprocess.Popen() 中添加了对bytes和path-like对象的支持。如果 shell 为 False，args 参数现在接受一个 path-like object 和一个包含bytes和path-like对象的序列。executable 参数现在接受bytes和 path-like object。cwd 参数现在接受bytes对象。基于Anders Lorentsen的补丁。

bpo-33123 [https://bugs.python.org/issue?@action=redirect&bpo=33123]: pathlib.Path.unlink 现在接受一个 missing_ok 参数以避免引发 FileNotFoundError。由Robert Buchholz提供补丁。

bpo-32941 [https://bugs.python.org/issue?@action=redirect&bpo=32941]: 允许 mmap.mmap 对象访问madvise()系统调用（通过 mmap.mmap.madvise()）。

bpo-22102 [https://bugs.python.org/issue?@action=redirect&bpo=22102]: 添加了对磁盘设置为0的ZIP文件的支持。这类文件通常由Windows上的内置工具在使用ZIP64扩展时创建。由Francisco Facioni提供补丁。

bpo-32515 [https://bugs.python.org/issue?@action=redirect&bpo=32515]: trace.py现在可以通过python3 -m trace -t --module module_name来运行模块。

bpo-32299 [https://bugs.python.org/issue?@action=redirect&bpo=32299]: 修改了 unittest.mock.patch.dict()，使其作为上下文管理器使用时返回被修补的字典。由Vadim Tsander提供补丁。

bpo-27141 [https://bugs.python.org/issue?@action=redirect&bpo=27141]: 为 collections.UserList``和 ``collections.UserDict 添加了 __copy__() 方法，以正确实现对象的浅拷贝。由Bar Harel提供补丁。

bpo-31829 [https://bugs.python.org/issue?@action=redirect&bpo=31829]: 现在在协议0的Unicode字符串pickle中，\r、\0``和 ``\x1a (Windows上的文件结束符) 会被转义。这使得可以从Python 2中以文本模式打开的文件中无损失地加载它们。

bpo-23395 [https://bugs.python.org/issue?@action=redirect&bpo=23395]: _thread.interrupt_main() 现在在 SIGINT 信号被忽略或未被Python处理时避免设置Python错误状态。

文档

bpo-36896 [https://bugs.python.org/issue?@action=redirect&bpo=36896]: 澄清了一些类型在Python版本间构造函数签名不稳定。

bpo-36686 [https://bugs.python.org/issue?@action=redirect&bpo=36686]: 改进了 asyncio.subprocess_exec 函数stdin、stdout和stderr参数的文档，指定了哪些值受支持。同时提到不支持作为文本解码。

添加了一些测试来验证传递给std*参数的各种值是否实际工作。

bpo-36984 [https://bugs.python.org/issue?@action=redirect&bpo=36984]: 改进了 typing 模块中添加版本引用的说明 - 由Anthony Sottile提供。

bpo-36868 [https://bugs.python.org/issue?@action=redirect&bpo=36868]: 新变化现在提到SSLContext.hostname_checks_common_name而不是SSLContext.host_flags。

bpo-35924 [https://bugs.python.org/issue?@action=redirect&bpo=35924]: 在 curses.addstr() 文档中添加了一条说明，警告由于ncurses的bug，多行字符串可能导致段错误。

bpo-36783 [https://bugs.python.org/issue?@action=redirect&bpo=36783]: 根据PEP 495，为Time_FromTimeAndFold和PyDateTime_FromDateAndTimeAndFold添加了C API文档。由Edison Abahurire提供补丁。

bpo-36797 [https://bugs.python.org/issue?@action=redirect&bpo=36797]: 更多遗留的distutils文档已被删除，或者更明确地标记为仅在setuptools文档独立覆盖之前保留。

bpo-22865 [https://bugs.python.org/issue?@action=redirect&bpo=22865]: Add detail to the documentation on the pty.spawn function.

bpo-35397 [https://bugs.python.org/issue?@action=redirect&bpo=35397]: 移除弃用并记录urllib.parse.unwrap()。由Rémi Lapeyre提供补丁。

bpo-32995 [https://bugs.python.org/issue?@action=redirect&bpo=32995]: 在词汇表中添加了上下文变量。

bpo-33519 [https://bugs.python.org/issue?@action=redirect&bpo=33519]: Clarify that copy() is not part of the MutableSequence ABC.

bpo-33482 [https://bugs.python.org/issue?@action=redirect&bpo=33482]: Make codecs.StreamRecoder.writelines take a list of bytes.

bpo-25735 [https://bugs.python.org/issue?@action=redirect&bpo=25735]: 为func factorial添加了文档，以表明返回整数值。

bpo-20285 [https://bugs.python.org/issue?@action=redirect&bpo=20285]: 扩展object.__doc__（文档字符串）以使其更清晰。修改pydoc.py，以便help(object)列出对象方法（对于其他类，help省略了object基类的方法）。

测试

bpo-37069 [https://bugs.python.org/issue?@action=redirect&bpo=37069]: 修改test_coroutines、test_cprofile、test_generators、test_raise、test_ssl和test_yield_from，使用 test.support.catch_unraisable_exception() 而非 test.support.captured_stderr()。

bpo-37098 [https://bugs.python.org/issue?@action=redirect&bpo=37098]: 修复旧版Linux内核上的test_memfd_create。

bpo-37081 [https://bugs.python.org/issue?@action=redirect&bpo=37081]: 使用OpenSSL 1.1.1c进行测试。

bpo-36829 [https://bugs.python.org/issue?@action=redirect&bpo=36829]: 添加 test.support.catch_unraisable_exception(): 使用 sys.unraisablehook() 捕获不可报告异常的上下文管理器。

bpo-36915 [https://bugs.python.org/issue?@action=redirect&bpo=36915]: 主regrtest进程现在即使工作进程崩溃或在KeyboardInterrupt（CTRL+c）时被杀死，也会始终移除所有工作进程的临时目录。

bpo-36719 [https://bugs.python.org/issue?@action=redirect&bpo=36719]: "python3 -m test -jN ..."现在在工作者进程崩溃（CHILD_ERROR状态）时继续执行下一个测试。以前，测试套件会立即停止。使用--failfast在第一个错误处停止。

bpo-36816 [https://bugs.python.org/issue?@action=redirect&bpo=36816]: 更新Lib/test/selfsigned_pythontestdotnet.pem以匹配self-signed.pythontest.net的新TLS证书。

bpo-35925 [https://bugs.python.org/issue?@action=redirect&bpo=35925]: 当现代操作系统或发行版默认的OpenSSL策略拒绝连接到证书较弱的服务器时，跳过httplib和nntplib的网络测试。

bpo-36782 [https://bugs.python.org/issue?@action=redirect&bpo=36782]: 为 datetime 模块中的几个C API函数添加测试。补丁由Edison Abahurire提供。

bpo-36342 [https://bugs.python.org/issue?@action=redirect&bpo=36342]: 如果平台缺少可正常工作的sem_open，则在test_venv中修复test_multiprocessing。

构建

bpo-36721 [https://bugs.python.org/issue?@action=redirect&bpo=36721]: 要将Python嵌入到应用程序中，必须向 python3-config --libs --embed 传递一个新的 --embed 选项以获取 -lpython3.8 (将应用程序链接到libpython) 。为了同时支持3.8及更早版本，首先尝试 python3-config --libs --embed，如果前一个命令失败，则回退到``python3-config --libs`` (不带 --embed) 。

增加一个 pkg-config python-3.8-embed 模块用来将 Python 嵌入到一个应用中: pkg-config python-3.8-embed --libs 包含 -lpython3.8。 要同时支持 3.8 和旧版本，请先尝试 pkg-config python-X.Y-embed --libs 并在此命令失败时回退到 pkg-config python-X.Y --libs (即不带 --embed) （请将 X.Y 替换为 Python 版本号）。

另一方面，pkg-config python3.8 --libs``不再包含 ``-lpython3.8。C扩展不应该链接到libpython（除了在Android上，这种情况由脚本处理）；这一变化是有意为之的向后不兼容。

bpo-36786 [https://bugs.python.org/issue?@action=redirect&bpo=36786]: "make install"现在并行运行compileall。

Windows

bpo-36965 [https://bugs.python.org/issue?@action=redirect&bpo=36965]: 包含STATUS_CONTROL_C_EXIT而不依赖于MSC编译器

bpo-35926 [https://bugs.python.org/issue?@action=redirect&bpo=35926]: 为Windows更新到OpenSSL 1.1.1b。

bpo-29883 [https://bugs.python.org/issue?@action=redirect&bpo=29883]: 为Proactor Event Loop添加对UDP传输的Windows支持。由Adam Meily提供补丁。

bpo-33407 [https://bugs.python.org/issue?@action=redirect&bpo=33407]: 对MSVC实现了 Py_DEPRECATED() 宏。

macOS

bpo-36231 [https://bugs.python.org/issue?@action=redirect&bpo=36231]: 支持在macOS上在没有安装/usr/include的情况下构建Python。从macOS 10.14开始，系统头文件仅通过Command Line Tools或Xcode应用程序提供的SDK可用。

IDLE

bpo-35610 [https://bugs.python.org/issue?@action=redirect&bpo=35610]: 用.prompt_last_line替换现在冗余的.context_use_ps1。这完成了在 bpo-31858 [https://bugs.python.org/issue?@action=redirect&bpo=31858] 中开始的更改。

bpo-37038 [https://bugs.python.org/issue?@action=redirect&bpo=37038]: 使idlelib.run可运行；添加测试条款。

bpo-36958 [https://bugs.python.org/issue?@action=redirect&bpo=36958]: 打印传递给SystemExit或sys.exit()的除None或int之外的任何参数。

bpo-36807 [https://bugs.python.org/issue?@action=redirect&bpo=36807]: 保存文件时，调用os.fsync()以便将比特刷新到例如USB驱动器。

bpo-32411 [https://bugs.python.org/issue?@action=redirect&bpo=32411]: 在browser.py中，移除按行号的多余排序，因为字典已经是按行号顺序创建的。

工具/示例

bpo-37053 [https://bugs.python.org/issue?@action=redirect&bpo=37053]: 在Tools/parser/unparse.py中正确处理像u"bar"这样的字符串。由Chih-Hsuan Yen提供补丁。

C API

bpo-36763 [https://bugs.python.org/issue?@action=redirect&bpo=36763]: 实现 PEP 587 [https://www.python.org/dev/peps/pep-0587] "Python初始化配置"。

bpo-36379 [https://bugs.python.org/issue?@action=redirect&bpo=36379]: 修复当在C中实现 __ipow__ 时尝试使用 modulo 参数导致的崩溃。

bpo-37107 [https://bugs.python.org/issue?@action=redirect&bpo=37107]: 更新 PyObject_CallMethodObjArgs() 和``_PyObject_CallMethodIdObjArgs``以使用 _PyObject_GetMethod，避免在许多情况下创建绑定方法对象。由Michael J. Sullivan提供补丁。

bpo-36974 [https://bugs.python.org/issue?@action=redirect&bpo=36974]: 实现 PEP 590 [https://www.python.org/dev/peps/pep-0590]: Vectorcall: CPython的快速调用协议。这是一个新的协议，用于优化自定义可调用对象的调用。

bpo-36763 [https://bugs.python.org/issue?@action=redirect&bpo=36763]: Py_Main() 现在在调用 PyErr_Print() 时如果当前异常类型是 SystemExit``则返回退出码而不是调用 ``Py_Exit(exitcode)。

bpo-36922 [https://bugs.python.org/issue?@action=redirect&bpo=36922]: 为行为类似于未绑定方法的对象添加新的类型标志``Py_TPFLAGS_METHOD_DESCRIPTOR``。这些对象支持由 LOAD_METHOD/CALL_METHOD 操作码给出的优化。参见PEP 590。

bpo-36728 [https://bugs.python.org/issue?@action=redirect&bpo=36728]: The PyEval_ReInitThreads() function has been removed from the C API. It should not be called explicitly: use PyOS_AfterFork_Child() instead.

Python 3.8.0 alpha 4

发布日期: 2019-05-06

安全性

bpo-36742 [https://bugs.python.org/issue?@action=redirect&bpo=36742]: 修复urlsplit()中预规范化字符的处理错误。

bpo-30458 [https://bugs.python.org/issue?@action=redirect&bpo=30458]: Address CVE-2019-9740 by disallowing URL paths with embedded whitespace or control characters through into the underlying http client request. Such potentially malicious header injection URLs now cause an http.client.InvalidURL exception to be raised.

bpo-35755 [https://bugs.python.org/issue?@action=redirect&bpo=35755]: shutil.which() 现在如果可用且 PATH 环境变量未设置时，会使用 os.confstr("CS_PATH")。同时从 posixpath.defpath 中移除当前目录。在 Unix 上，如果 PATH 环境变量未设置，shutil.which() 和 subprocess 模块不再在当前目录中搜索可执行文件。

核心与内置函数

bpo-36722 [https://bugs.python.org/issue?@action=redirect&bpo=36722]: 在调试构建中，导入现在也会查找以发布模式编译的 C 扩展和以稳定 ABI 编译的 C 扩展。

bpo-32849 [https://bugs.python.org/issue?@action=redirect&bpo=32849]: 修复 FreeBSD 上的 Python 初始化代码，以正确检测 stdin 文件描述符（fd 0）何时无效。

bpo-36623 [https://bugs.python.org/issue?@action=redirect&bpo=36623]: 移除解析器头部和移除 pgen 后缺乏实现的函数声明。

bpo-20180 [https://bugs.python.org/issue?@action=redirect&bpo=20180]: 由于 Argument Clinic 的贡献，dict.pop() 现在快了 33%。由 Inada Naoki 提供补丁。

bpo-36611 [https://bugs.python.org/issue?@action=redirect&bpo=36611]: 调试内存分配器：默认从 Python 内存分配器的调试钩子中禁用 serialno 字段，以减少内存占用 5%。当记录致命内存错误时，启用 tracemalloc 以获取内存块分配的跟踪信息，以决定在哪里放置断点。编译 Python 时定义 PYMEM_DEBUG_SERIALNO 以恢复该字段。

bpo-36588 [https://bugs.python.org/issue?@action=redirect&bpo=36588]: On AIX, sys.platform doesn't contain the major version anymore. Always return 'aix', instead of 'aix3' .. 'aix7'. Since older Python versions include the version number, it is recommended to always use sys.platform.startswith('aix'). Contributed by M. Felt.

bpo-36549 [https://bugs.python.org/issue?@action=redirect&bpo=36549]: 将 str.capitalize 改为对第一个字符使用标题大小写而不是大写。

bpo-36540 [https://bugs.python.org/issue?@action=redirect&bpo=36540]: 实现 PEP 570 [https://www.python.org/dev/peps/pep-0570] (Python 位置参数) 。由 Pablo Galindo 提供补丁。

bpo-36475 [https://bugs.python.org/issue?@action=redirect&bpo=36475]: PyEval_AcquireLock() and PyEval_AcquireThread() now terminate the current thread if called while the interpreter is finalizing, making them consistent with PyEval_RestoreThread(), Py_END_ALLOW_THREADS(), and PyGILState_Ensure().

bpo-36504 [https://bugs.python.org/issue?@action=redirect&bpo=36504]: 修复了 _ctypes.c 中 PyCArrayType_new() 的有符号整数溢出问题。

bpo-20844 [https://bugs.python.org/issue?@action=redirect&bpo=20844]: 修复了在 Windows 上运行带有编码 cookie 和 LF 行结尾的脚本可能失败的问题。

bpo-24214 [https://bugs.python.org/issue?@action=redirect&bpo=24214]: 修复了 UTF-8 增量解码器中 surrogatpass 错误处理程序的支持。

bpo-36452 [https://bugs.python.org/issue?@action=redirect&bpo=36452]: Changing dict keys during iteration of the dict itself, keys(), values(), or items() will now be detected in certain corner cases where keys are deleted/added so that the number of keys isn't changed. A RuntimeError will be raised after len(dict) iterations. Contributed by Thomas Perl.

bpo-36459 [https://bugs.python.org/issue?@action=redirect&bpo=36459]: 修复了 tokenizer.c 的 tok_nextc() 可能导致的双重 PyMem_FREE() 问题。

bpo-36433 [https://bugs.python.org/issue?@action=redirect&bpo=36433]: 修复了 classmethoddescr_call 中的 TypeError 消息。

bpo-36430 [https://bugs.python.org/issue?@action=redirect&bpo=36430]: 修复了 itertools.count() 中可能存在的引用泄漏问题。

bpo-36440 [https://bugs.python.org/issue?@action=redirect&bpo=36440]: 在 ParserError 消息中包含节点名称，而不是数字 ID。由 A. Skrobov 提供补丁。

bpo-36143 [https://bugs.python.org/issue?@action=redirect&bpo=36143]: 使用 pgen 从 Grammar 和 Tokens 文件重新生成 keyword。由 Pablo Galindo 提供补丁。

bpo-18372 [https://bugs.python.org/issue?@action=redirect&bpo=18372]: 在 pickle 模块中添加缺失的 PyObject_GC_Track() 调用。由 Zackery Spytz 提供补丁。

库

bpo-35952 [https://bugs.python.org/issue?@action=redirect&bpo=35952]: 修复了当编译器缺失时的 pythoninfo。

bpo-28238 [https://bugs.python.org/issue?@action=redirect&bpo=28238]: xml.etree.ElementTree 的 .find*() 方法现在可以搜索像 {*}tag 和 {ns}* 这样的通配符，它们可以匹配任何命名空间中的标签或命名空间中的所有标签。由 Stefan Behnel 提供补丁。

bpo-26978 [https://bugs.python.org/issue?@action=redirect&bpo=26978]: pathlib.path.link_to() is now implemented. It creates a hard link pointing to a path.

bpo-1613500 [https://bugs.python.org/issue?@action=redirect&bpo=1613500]: 当向构造函数传递 inplace=True 时，fileinput.FileInput 现在使用输入文件模式来正确设置输出文件模式（之前是硬编码为 'w'）。

bpo-36734 [https://bugs.python.org/issue?@action=redirect&bpo=36734]: 修复在 HP-UX 上编译 faulthandler.c 的问题。使用 memset() 将 stack_t current_stack 初始化为零。

bpo-13611 [https://bugs.python.org/issue?@action=redirect&bpo=13611]: xml.etree.ElementTree 包增加了对 C14N 2.0 序列化的支持。由 Stefan Behnel 提供补丁。

bpo-36669 [https://bugs.python.org/issue?@action=redirect&bpo=36669]: 向 weakref.proxy 添加缺失的矩阵乘法运算符支持。

bpo-36676 [https://bugs.python.org/issue?@action=redirect&bpo=36676]: 如果解析器目标定义了回调方法 "start_ns()" 和/或 "end_ns()"，xml.etree.ElementTree 中的 XMLParser() 会向解析器目标提供命名空间前缀上下文。由 Stefan Behnel 提供补丁。

bpo-36673 [https://bugs.python.org/issue?@action=redirect&bpo=36673]: xml.etree.ElementTree 中的 TreeBuilder 和 XMLPullParser 增加了对解析注释和处理指令的支持。由 Stefan Behnel 提供补丁。

bpo-36650 [https://bugs.python.org/issue?@action=redirect&bpo=36650]: functools.lru_cache() 的 C 版本将带有空 **kwargs 字典的调用视为与完全没有关键字的调用不同。这不会导致错误的答案，但确实会触发意外的缓存未命中。

bpo-28552 [https://bugs.python.org/issue?@action=redirect&bpo=28552]: Fix distutils.sysconfig if sys.executable is None or an empty string: use os.getcwd() to initialize project_base. Fix also the distutils build command: don't use sys.executable if it is None or an empty string.

bpo-35755 [https://bugs.python.org/issue?@action=redirect&bpo=35755]: shutil.which() and distutils.spawn.find_executable() now use os.confstr("CS_PATH") if available instead of os.defpath, if the PATH environment variable is not set. Moreover, don't use os.confstr("CS_PATH") nor os.defpath if the PATH environment variable is set to an empty string.

bpo-25430 [https://bugs.python.org/issue?@action=redirect&bpo=25430]: 提高 IPNetwork.__contains__() 的性能。

bpo-30485 [https://bugs.python.org/issue?@action=redirect&bpo=30485]: xml.etree.ElementTree中的路径表达式现在可以通过传递一个空字符串前缀的默认命名空间，避免为标签使用显式的命名空间前缀（或“{命名空间}标签”符号）。

bpo-36613 [https://bugs.python.org/issue?@action=redirect&bpo=36613]: 修复 asyncio wait()在异常情况下不删除回调的问题。

bpo-36598 [https://bugs.python.org/issue?@action=redirect&bpo=36598]: 修复当代码在追踪下执行时，Mock对象与spec的 isinstance 检查。由Karthikeyan Singaravelan提供补丁。

bpo-18748 [https://bugs.python.org/issue?@action=redirect&bpo=18748]: 在开发模式(-X dev)和调试版本中，io.IOBase 析构函数现在会记录 close() 异常。在发布模式下，这些异常默认是静默的。

bpo-36575 [https://bugs.python.org/issue?@action=redirect&bpo=36575]: _lsprof 模块现在默认使用与 time.perf_counter() 相同的内部计时器。Unix上以前使用 gettimeofday(2)。新计时器在大多数Unix平台上具有更好的分辨率，并且由于``perf_counter()``是单调的，计时不再受系统时钟更新的影响。由Inada Naoki提供补丁。

bpo-33461 [https://bugs.python.org/issue?@action=redirect&bpo=33461]: 当指定 encoding 选项时，json.loads 现在会发出 DeprecationWarning。由Matthias Bussonnier提供补丁。

bpo-36559 [https://bugs.python.org/issue?@action=redirect&bpo=36559]: 为了优化导入时间，random模块现在在seed(version=2)时更倾向于使用精简的内部_sha512模块，而不是hashlib。

bpo-17561 [https://bugs.python.org/issue?@action=redirect&bpo=17561]: 将backlog=None设置为socket.create_server的默认值。

bpo-34373 [https://bugs.python.org/issue?@action=redirect&bpo=34373]: 修复 time.mktime() 在AIX上对1970年之前年份的错误处理。

bpo-36232 [https://bugs.python.org/issue?@action=redirect&bpo=36232]: 当尝试打开实际上不存在的现有DBM数据库时，改进错误消息。由Marco Rougeth提供补丁。

bpo-36546 [https://bugs.python.org/issue?@action=redirect&bpo=36546]: 添加statistics.quantiles()

bpo-36050 [https://bugs.python.org/issue?@action=redirect&bpo=36050]: 优化 http.client.HTTPResponse.read() 以处理大响应。补丁由Inada Naoki提供。

bpo-36522 [https://bugs.python.org/issue?@action=redirect&bpo=36522]: 如果在 http.client 中 debuglevel 设置为>0，打印同一头部名称下多个值的所有值。由Matt Houglum提供补丁。

bpo-36492 [https://bugs.python.org/issue?@action=redirect&bpo=36492]: 弃用在应接受任意关键字参数并将其传递给其他函数的函数中，将必需参数（如 func）作为关键字参数传递的做法。现在，如果必需参数作为位置参数传递，则可以向这些函数传递任意关键字参数（即使名称是"self"和"func"）。

bpo-27181 [https://bugs.python.org/issue?@action=redirect&bpo=27181]: 添加 statistics.geometric_mean()。

bpo-30427 [https://bugs.python.org/issue?@action=redirect&bpo=30427]: os.path.normcase() 依赖 os.fspath() 来检查其参数的类型。其 posixpath.normcase() 和 ntpath.normcase() 实现中的冗余检查已被移除。由 Wolfgang Maier 提供补丁。

bpo-36385 [https://bugs.python.org/issue?@action=redirect&bpo=36385]: 停止因IPv4八位组可能为八进制而拒绝它们。前导零被忽略，不再假定为指定八进制八位组。八位组始终是十进制数字。八位组仍必须不超过三位数字，包括前导零。

bpo-36434 [https://bugs.python.org/issue?@action=redirect&bpo=36434]: 写入ZIP文件时的错误不再阻止其正确关闭。

bpo-36407 [https://bugs.python.org/issue?@action=redirect&bpo=36407]: 修复了xml.dom.minidom中CDATA部分写入时的错误缩进。由Vladimir Surjaninov提供补丁。

bpo-36326 [https://bugs.python.org/issue?@action=redirect&bpo=36326]: inspect.getdoc()现在可以在__slots__是字典时为成员对象找到文档字符串。

bpo-36366 [https://bugs.python.org/issue?@action=redirect&bpo=36366]: Calling stop() on an unstarted or stopped unittest.mock.patch() object will now return None instead of raising RuntimeError, making the method idempotent. Patch by Karthikeyan Singaravelan.

bpo-36348 [https://bugs.python.org/issue?@action=redirect&bpo=36348]: imap.IMAP4.logout() 方法不再静默忽略任意异常。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: Add time module support and fix test_time faiures for VxWorks.

bpo-36227 [https://bugs.python.org/issue?@action=redirect&bpo=36227]: Added support for keyword arguments default_namespace and xml_declaration in functions ElementTree.tostring() and ElementTree.tostringlist().

bpo-36004 [https://bugs.python.org/issue?@action=redirect&bpo=36004]: 新增了替代构造函数 datetime.date.fromisocalendar() 和 datetime.datetime.fromisocalendar()，这些函数可以从ISO年、周数和工作日构建日期对象；这些是每个类的 isocalendar 方法的逆操作。由Paul Ganssle提供补丁。

bpo-35936 [https://bugs.python.org/issue?@action=redirect&bpo=35936]: modulefinder 不再依赖于已弃用的 imp 模块，并且 modulefinder.ModuleFinder 的初始化器现在具有不可变的默认参数。由Brandt Bucher提供补丁。

bpo-35376 [https://bugs.python.org/issue?@action=redirect&bpo=35376]: modulefinder 正确处理了与错误包同名的模块。由Brandt Bucher提供补丁。

bpo-17396 [https://bugs.python.org/issue?@action=redirect&bpo=17396]: modulefinder 在遇到跟随导入中的语法错误时不再崩溃。由Brandt Bucher提供补丁。

bpo-35934 [https://bugs.python.org/issue?@action=redirect&bpo=35934]: Added create_server() and has_dualstack_ipv6() convenience functions to automate the necessary tasks usually involved when creating a server socket, including accepting both IPv4 and IPv6 connections on the same socket. (Contributed by Giampaolo Rodola in bpo-17561 [https://bugs.python.org/issue?@action=redirect&bpo=17561].)

bpo-23078 [https://bugs.python.org/issue?@action=redirect&bpo=23078]: 向 unittest.mock.create_autospec() 添加了对 classmethod() 和 staticmethod() 的支持。初始由Felipe Ochoa提供补丁。

bpo-35416 [https://bugs.python.org/issue?@action=redirect&bpo=35416]: 修复了distutils中潜在的资源警告。由Mickaël Schoentgen提供补丁。

bpo-25451 [https://bugs.python.org/issue?@action=redirect&bpo=25451]: 向 tkinter.PhotoImage 添加了透明度方法。由Zackery Spytz提供补丁。

bpo-35082 [https://bugs.python.org/issue?@action=redirect&bpo=35082]: 在调用 unittest.mock.Mock 上的dir时不再返回已删除的属性。

bpo-34547 [https://bugs.python.org/issue?@action=redirect&bpo=34547]: wsgiref.handlers.BaseHandler 现在能够优雅地处理客户端连接的突然终止。由Petter Strandmark提供补丁。

bpo-31658 [https://bugs.python.org/issue?@action=redirect&bpo=31658]: xml.sax.parse() 现在支持 路径类对象。由Mickaël Schoentgen提供补丁。

bpo-34139 [https://bugs.python.org/issue?@action=redirect&bpo=34139]: 在绑定前移除旧的unix数据报套接字。

bpo-33530 [https://bugs.python.org/issue?@action=redirect&bpo=33530]: Implemented Happy Eyeballs in asyncio.create_connection(). Added two new arguments, happy_eyeballs_delay and interleave, to specify Happy Eyeballs behavior.

bpo-33291 [https://bugs.python.org/issue?@action=redirect&bpo=33291]: 当在由任意可调用对象创建的方法上调用inspect函数isgeneratorfunction、iscoroutinefunction、isasyncgenfunction时，不再抛出AttributeError。而是返回False。

bpo-31310 [https://bugs.python.org/issue?@action=redirect&bpo=31310]: 修复multiprocessing.semaphore_tracker，使其被子进程重用。

bpo-31292 [https://bugs.python.org/issue?@action=redirect&bpo=31292]: 修复 setup.py check --restructuredtext 对于包含 include 指令的文件的支持。

文档

bpo-36625 [https://bugs.python.org/issue?@action=redirect&bpo=36625]: 从fractions.Fraction的文档字符串中移除过时的注释。

bpo-30840 [https://bugs.python.org/issue?@action=redirect&bpo=30840]: 文档化相对导入。

bpo-36523 [https://bugs.python.org/issue?@action=redirect&bpo=36523]: 为io.IOBase.writelines()添加文档字符串。

bpo-36425 [https://bugs.python.org/issue?@action=redirect&bpo=36425]: 新增文档翻译：简体中文 [https://docs.python.org/zh-cn/]。

bpo-36345 [https://bugs.python.org/issue?@action=redirect&bpo=36345]: 避免在 wsgiref 文档中使用 literalinclude 指令时从``Tools/scripts/serve.py`` 复制代码。由Stéphane Wirtel贡献。

bpo-36345 [https://bugs.python.org/issue?@action=redirect&bpo=36345]: 在 wsgiref 文档中使用 Tools/scripts/serve.py 脚本的代码作为示例。由Stéphane Wirtel贡献。

bpo-36157 [https://bugs.python.org/issue?@action=redirect&bpo=36157]: Added Documention for PyInterpreterState_Main().

bpo-33043 [https://bugs.python.org/issue?@action=redirect&bpo=33043]: 更新docs.python.org页面，在页面末尾（在'Reporting Bugs'和'About Documentation'之间）添加了一个'Contributing to Docs'链接。在'Found a Bug'页面的文档错误部分添加了额外的链接和信息。

bpo-35581 [https://bugs.python.org/issue?@action=redirect&bpo=35581]: @typing.type_check_only现在允许类型存根标记在运行时不可用的函数和类。

bpo-33832 [https://bugs.python.org/issue?@action=redirect&bpo=33832]: 在术语表中添加了'magic method'条目。

bpo-32913 [https://bugs.python.org/issue?@action=redirect&bpo=32913]: 在正则表达式HOWTO中添加了re.Match.groupdict示例。

测试

bpo-36719 [https://bugs.python.org/issue?@action=redirect&bpo=36719]: regrtest 现在总是检测不可回收的对象。之前，这个检查只在 --findleaks 启用时才进行。现在这个检查也能与 -jN/--multiprocess N 一起工作。--findleaks 成为 --fail-env-changed 的一个弃用别名。

bpo-36725 [https://bugs.python.org/issue?@action=redirect&bpo=36725]: 当使用多进程模式 (-jN) 时，regrtest 现在能更好地报告工作进程失败的错误，并且在工作者线程失败或被中断时立即退出。

bpo-36454 [https://bugs.python.org/issue?@action=redirect&bpo=36454]: 将 test_time.test_monotonic() 改为仅测试睡眠命令后经过时间的下限而非上限。这避免了在慢速构建机器人上不必要的测试失败。由 Victor Stinner 提供补丁。

bpo-32424 [https://bugs.python.org/issue?@action=redirect&bpo=32424]: 提高 xml.etree.ElementTree 的测试覆盖率。由 Gordon P. Hemsley 提供补丁。

bpo-32424 [https://bugs.python.org/issue?@action=redirect&bpo=32424]: 修复 xml.etree.ElementTree 中 test_cyclic_gc() 测试的拼写错误。由 Gordon P. Hemsley 提供补丁。

bpo-36635 [https://bugs.python.org/issue?@action=redirect&bpo=36635]: Add a new _testinternalcapi module to test the internal C API.

bpo-36629 [https://bugs.python.org/issue?@action=redirect&bpo=36629]: Fix test_imap4_host_default_value() of test_imaplib: catch also errno.ENETUNREACH error.

bpo-36611 [https://bugs.python.org/issue?@action=redirect&bpo=36611]: 当 tracemalloc 启用时，修复 test_sys.test_getallocatedblocks()。

bpo-36560 [https://bugs.python.org/issue?@action=redirect&bpo=36560]: 修复 regrtest 中的引用泄漏检测：在热身期间也计算（引用计数、分配的内存块、文件描述符计数的）增量，以确保在开始检测引用泄漏前一切均已初始化。

bpo-36565 [https://bugs.python.org/issue?@action=redirect&bpo=36565]: 当 Python 没有内置的 abc 模块时，修复引用检测（python3 -m test -R 3:3）。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 将 test_resource 移植到 VxWorks：跳过设置 RLIMIT_FSIZE 和 RLIMIT_CPU 的测试用例。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 修复 VxWorks 上的 test_tabnanny：调整 ENOENT 错误消息。

bpo-36436 [https://bugs.python.org/issue?@action=redirect&bpo=36436]: 修复 _testcapi.pymem_buffer_overflow()：处理内存分配失败。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 修复 VxWorks 上的 test_utf8_mode：Python 在 VxWorks 上总是使用 UTF-8。

bpo-36341 [https://bugs.python.org/issue?@action=redirect&bpo=36341]: 修复可能在调用 AF_UNIX 套接字的 bind() 时因 PermissionError 而失败的测试。

构建

bpo-36747 [https://bugs.python.org/issue?@action=redirect&bpo=36747]: 移除陈旧的scriptsinstall Makefile目标。

bpo-21536 [https://bugs.python.org/issue?@action=redirect&bpo=21536]: 在Unix上，除了Android和Cygwin，C扩展不再链接到libpython。

通过共享库的 Python 构建的 C 扩展现在可以被静态链接的 Python 加载了。

当Python被嵌入时，libpython 必须不被 RTLD_LOCAL 加载，而应使用 RTLD_GLOBAL。之前，使用 RTLD_LOCAL 时，已经无法加载未链接到 libpython 的C扩展，例如由 Modules/Setup 的 *shared* 部分构建的标准库的C扩展。

distutils，python-config 和 python-config.py 已被修改。

bpo-36707 [https://bugs.python.org/issue?@action=redirect&bpo=36707]: ./configure --with-pymalloc 不再向SOABI（sys.implementation.cache_tag）添加 m 标志。启用或禁用pymalloc对ABI没有影响。

bpo-36635 [https://bugs.python.org/issue?@action=redirect&bpo=36635]: Change PyAPI_FUNC(type), PyAPI_DATA(type) and PyMODINIT_FUNC macros of pyport.h when Py_BUILD_CORE_MODULE is defined. The Py_BUILD_CORE_MODULE define must be now be used to build a C extension as a dynamic library accessing Python internals: export the PyInit_xxx() function in DLL exports on Windows.

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 不在VxWorks上构建 _crypt 扩展。

bpo-36618 [https://bugs.python.org/issue?@action=redirect&bpo=36618]: 当检测到clang编译器时，向CFLAGS添加 -fmax-type-align=8。pymalloc内存分配器将内存对齐于8字节。在x86-64上，clang默认期望对齐于16字节，因此使用MOVAPS指令，这可能导致分段错误。指示clang Python限制对齐于8字节以使用MOVUPS指令代替：虽然较慢，但如果内存未对齐于16字节，则不会触发SIGSEGV。遗憾的是，该标志必须添加到 CFLAGS 而不仅仅是 CFLAGS_NODIST，因为第三方C扩展也可能有相同的问题。

bpo-36605 [https://bugs.python.org/issue?@action=redirect&bpo=36605]: make tags 和 make TAGS 现在也解析 Modules/_io/*.c 和 Modules/_io/*.h。

bpo-36465 [https://bugs.python.org/issue?@action=redirect&bpo=36465]: 发布版本和调试版本现在ABI兼容：定义 Py_DEBUG 宏不再隐含 Py_TRACE_REFS 宏，后者引入了唯一的ABI不兼容性。Py_TRACE_REFS 宏添加了 sys.getobjects() 函数和 PYTHONDUMPREFS 环境变量，可以通过新的 ./configure --with-trace-refs 构建选项设置。

bpo-36577 [https://bugs.python.org/issue?@action=redirect&bpo=36577]: setup.py 现在再次正确报告缺少的OpenSSL头文件和库。

bpo-36544 [https://bugs.python.org/issue?@action=redirect&bpo=36544]: 修复了在 bpo-36146 [https://bugs.python.org/issue?@action=redirect&bpo=36146] 重构 setup.py 时引入的回归问题。

bpo-36508 [https://bugs.python.org/issue?@action=redirect&bpo=36508]: python-config --ldflags 不再包含 LINKFORSHARED 变量的标志。LINKFORSHARED 变量必须仅用于构建可执行文件。

bpo-36503 [https://bugs.python.org/issue?@action=redirect&bpo=36503]: 移除了对 "aix3" 和 "aix4" 的引用。由 M. Felt 提供补丁。

Windows

bpo-35920 [https://bugs.python.org/issue?@action=redirect&bpo=35920]: 添加了 platform.win32_edition() 和 platform.win32_is_iot()。添加了对为 Windows ARM32 交叉编译包的支持。跳过在 Windows IoT Core ARM32 上预期不工作的测试。

bpo-36649 [https://bugs.python.org/issue?@action=redirect&bpo=36649]: 通过商店安装时，移除注册表键的尾随空格。

bpo-34144 [https://bugs.python.org/issue?@action=redirect&bpo=34144]: 修复了 activate.bat，当 chcp.com 在输出中返回点时正确更新代码页。由 Lorenz Mende 提供补丁。

bpo-36509 [https://bugs.python.org/issue?@action=redirect&bpo=36509]: 为 Windows IoT ARM 容器添加了预设的 IoT 布局。此布局不包含 UI 组件如 tkinter 或 IDLE。也不包含支持在目标上构建的文件，因为在使用 MSVC 时 Windows ARM32 构建必须交叉编译。

bpo-35941 [https://bugs.python.org/issue?@action=redirect&bpo=35941]: ssl模块的enum_certificates函数现在在查询中返回Windows内所有可用证书存储中的证书，而不仅仅是返回系统范围内的证书存储中的证书。这包括来自以下证书存储的证书：本地机器、本地机器企业、本地机器组策略、当前用户、当前用户组策略、服务、用户。ssl.enum_crls()函数以同样的方式更改，以返回Windows证书吊销列表存储中的所有证书吊销列表。

bpo-36441 [https://bugs.python.org/issue?@action=redirect&bpo=36441]: 修复了安装调试二进制文件时创建venv的问题。

bpo-36085 [https://bugs.python.org/issue?@action=redirect&bpo=36085]: 通过使用安全的DLL搜索路径和添加 os.add_dll_directory()，在Windows上启用更好的DLL解析。

bpo-36010 [https://bugs.python.org/issue?@action=redirect&bpo=36010]: 将venv标准库模块添加到Windows的nuget分发中。

bpo-29515 [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

bpo-35947 [https://bugs.python.org/issue?@action=redirect&bpo=35947]: 将当前版本的libffi添加到cpython-source-deps。更改_ctypes以在Windows上使用当前版本的libffi。

bpo-34060 [https://bugs.python.org/issue?@action=redirect&bpo=34060]: 在Windows上运行测试套件时报告系统负载。由Ammar Askar提供补丁。基于Jeremy Kloth的先前工作。

bpo-31512 [https://bugs.python.org/issue?@action=redirect&bpo=31512]: 随着Windows 10 Creators Update的发布，非特权用户现在可以创建符号链接，只要计算机启用了开发者模式。

macOS

bpo-34602 [https://bugs.python.org/issue?@action=redirect&bpo=34602]: 避免在macOS上使用resource.setrlimit设置堆栈资源限制时失败。这恢复了对 bpo-18075 [https://bugs.python.org/issue?@action=redirect&bpo=18075] 的早期修复，该修复在macOS上构建解释器可执行文件时强制使用了非默认堆栈大小。

IDLE

bpo-36429 [https://bugs.python.org/issue?@action=redirect&bpo=36429]: 修复启动IDLE时使用pyshell的问题。在顶部添加idlelib.pyshell别名；移除底部的pyshell别名。移除过时的__name__=='__main__'命令。

工具/示例

bpo-14546 [https://bugs.python.org/issue?@action=redirect&bpo=14546]: 修复Tools/scripts/lll.py中的参数处理问题。

C API

bpo-36763 [https://bugs.python.org/issue?@action=redirect&bpo=36763]: Fix memory leak in Py_SetStandardStreamEncoding(): release memory if the function is called twice.

bpo-36641 [https://bugs.python.org/issue?@action=redirect&bpo=36641]: PyDoc_VAR(name) 和 PyDoc_STRVAR(name, str) 现在创建的是``static const char name[]``而非 static char name[]。由Inada Naoki提供的补丁。

bpo-36389 [https://bugs.python.org/issue?@action=redirect&bpo=36389]: 更改Python内存分配器调试钩子(PyMem_SetupDebugHooks() 函数)中使用的内部常量 CLEANBYTE、DEADDYTE``和 ``FORBIDDENBYTE 的值。字节模式 0xCB、0xDB 和``0xFB``已被替换为 0xCD、0xDD 和 0xFD，以使用与Windows CRT调试 malloc() 和``free()``相同的值。

bpo-36443 [https://bugs.python.org/issue?@action=redirect&bpo=36443]: Since Python 3.7.0, calling Py_DecodeLocale() before Py_Initialize() produces mojibake if the LC_CTYPE locale is coerced and/or if the UTF-8 Mode is enabled by the user configuration. The LC_CTYPE coercion and UTF-8 Mode are now disabled by default to fix the mojibake issue. They must now be enabled explicitly (opt-in) using the new _Py_PreInitialize() API with _PyPreConfig.

bpo-36025 [https://bugs.python.org/issue?@action=redirect&bpo=36025]: 修复了datetime C API中的一个意外更改，其中 PyDate_FromTimestamp() 函数的参数被错误地解释为单个时间戳而非参数元组，这导致现有代码开始引发 TypeError。这一不向后兼容的更改仅出现在Python 3.8的alpha版本中。由Paul Ganssle提供的补丁。

bpo-35810 [https://bugs.python.org/issue?@action=redirect&bpo=35810]: Modify PyObject_Init to correctly increase the refcount of heap- allocated Type objects. Also fix the refcounts of the heap-allocated types that were either doing this manually or not decreasing the type's refcount in tp_dealloc

Python 3.8.0 alpha 3

发布日期： 2019-03-25

安全性

bpo-36216 [https://bugs.python.org/issue?@action=redirect&bpo=36216]: 修改 urlsplit()，当 URL 包含在 IDNA 编码（NFKC 规范化）下分解为影响 URL 解析方式的字符时抛出 ValueError。

bpo-35121 [https://bugs.python.org/issue?@action=redirect&bpo=35121]: 在使用带有 http.cookiejar.DefaultCookiePolicy 策略的 cookiejar 时，不要将没有 Domain 属性的域 A 的 cookies 发送到域 B，当域 A 是域 B 的后缀匹配时。补丁由 Karthikeyan Singaravelan 提供。

核心与内置函数

bpo-36421 [https://bugs.python.org/issue?@action=redirect&bpo=36421]: 修复 _ctypes.c 的 PyCArrayType_new() 中可能出现的双重递减引用。

bpo-36412 [https://bugs.python.org/issue?@action=redirect&bpo=36412]: 修复创建新字典时可能发生的崩溃。

bpo-36398 [https://bugs.python.org/issue?@action=redirect&bpo=36398]: 修复 structseq_repr() 中可能发生的崩溃。

bpo-36256 [https://bugs.python.org/issue?@action=redirect&bpo=36256]: 修复 parsermodule 在解析 DFA 中具有两个或更多相同类型标签弧的状态时的错误。由 Pablo Galindo 提供补丁。

bpo-36365 [https://bugs.python.org/issue?@action=redirect&bpo=36365]: repr(structseq) 不再限制为 512 字节。

bpo-36374 [https://bugs.python.org/issue?@action=redirect&bpo=36374]: 修复 merge_consts_recursive() 中可能的空指针解引用。由 Zackery Spytz 提供补丁。

bpo-36236 [https://bugs.python.org/issue?@action=redirect&bpo=36236]: 在 Python 初始化时，如果当前目录已被移除，则不再将其前置到 sys.path 中。

bpo-36352 [https://bugs.python.org/issue?@action=redirect&bpo=36352]: 如果路径过长，Python 初始化现在会失败并报错，而不是静默截断路径。

bpo-36301 [https://bugs.python.org/issue?@action=redirect&bpo=36301]: 如果启动时解码 pybuilddir.txt 配置文件失败，Python 初始化现在会失败。

bpo-36333 [https://bugs.python.org/issue?@action=redirect&bpo=36333]: 修复 _PyRuntimeState_Fini 中的内存泄漏。由 Stéphane Wirtel 贡献。

bpo-36332 [https://bugs.python.org/issue?@action=redirect&bpo=36332]: 内置的 compile() 现在可以处理包含赋值表达式的 AST 对象。由 Pablo Galindo 提供补丁。

bpo-36282 [https://bugs.python.org/issue?@action=redirect&bpo=36282]: 改进了某些内置函数中位置参数过多的错误消息。

bpo-30040 [https://bugs.python.org/issue?@action=redirect&bpo=30040]: 现在新创建的空字典使用更少的内存。过去它比通过 dict.clear() 创建的空字典使用更多内存。并且空字典的创建和删除速度大约快 2 倍。由 Inada Naoki 提供补丁。

bpo-36262 [https://bugs.python.org/issue?@action=redirect&bpo=36262]: 修复了在由 float(str)、complex(str)、pickle.load()、marshal.load() 等使用的函数 ``_Py_dg_strtod()``中从字符串到浮点数转换时不太可能出现的内存泄漏问题。

bpo-36252 [https://bugs.python.org/issue?@action=redirect&bpo=36252]: 将Unicode数据库更新至12.0.0版本。

bpo-36218 [https://bugs.python.org/issue?@action=redirect&bpo=36218]: 修复了在排序包含异构值的列表时出现的段错误。由Rémi Lapeyre和Elliot Gorokhovsky提供补丁。

bpo-36188 [https://bugs.python.org/issue?@action=redirect&bpo=36188]: 清理了方法对象和文档中遗留的Python 2未绑定方法处理的痕迹。由Martijn Pieters提供补丁。

bpo-36124 [https://bugs.python.org/issue?@action=redirect&bpo=36124]: 添加了一个新的解释器特定的字典，并通过C-API的PyInterpreterState_GetDict()公开。这与PyThreadState_GetDict()并行。不过，扩展模块应继续使用PyModule_GetState()来处理它们自己的内部每个解释器的状态。

bpo-35975 [https://bugs.python.org/issue?@action=redirect&bpo=35975]: 向 ast.parse() (已文档化) 和 compile() (隐藏) 添加了一个``feature_version``标志，允许调整解析器以支持旧版本的语法。特别是，如果 feature_version``是5或6，则重新启用来自PEP 492的 ``async 和 await 关键字的hack。（对于7或更高版本，这些被无条件视为关键字，但它们仍然是特殊的标记，而不是解析器驱动程序识别的 NAME 标记。）

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 在VxWorks上使用UTF-8作为系统编码。

bpo-36048 [https://bugs.python.org/issue?@action=redirect&bpo=36048]: __index__() 特殊方法将代替 __int__() 用于Python数字到C整数的隐式转换。在隐式转换中使用 __int__() 方法已被弃用。

bpo-35808 [https://bugs.python.org/issue?@action=redirect&bpo=35808]: 退役pgen并使用修改版的pgen2来生成解析器。由Pablo Galindo提供补丁。

库

bpo-36401 [https://bugs.python.org/issue?@action=redirect&bpo=36401]: 由pydoc创建的类文档现在有一个单独的部分用于只读属性。

bpo-36320 [https://bugs.python.org/issue?@action=redirect&bpo=36320]: typing.NamedTuple() 类已弃用 _field_types 属性，转而使用携带相同信息的 __annotations__ 属性。同时，这两个属性都已从 OrderedDict 转换为常规 dict。

bpo-34745 [https://bugs.python.org/issue?@action=redirect&bpo=34745]: 修复 asyncio ssl 因循环引用导致的内存问题

bpo-36324 [https://bugs.python.org/issue?@action=redirect&bpo=36324]: 向 statistics.NormalDist 添加计算逆累积正态分布的方法。

bpo-36321 [https://bugs.python.org/issue?@action=redirect&bpo=36321]: collections.namedtuple() 错误拼写了一个属性名。为了与 typing.NamedTuple 保持一致，属性名应为 "_field_defaults" 而非 "_fields_defaults"。为了向后兼容，现在两种拼写都会创建。错误的拼写未来可能会被移除。

:issue:`36297": "unicode_internal" 编解码器已被移除。自 Python 3.3 起已弃用。由 Inada Naoki 提供补丁。

bpo-36298 [https://bugs.python.org/issue?@action=redirect&bpo=36298]: 在 pyclbr 中当模块无法找到时抛出 ModuleNotFoundError。感谢 'mental' 的 bug 报告。

bpo-36268 [https://bugs.python.org/issue?@action=redirect&bpo=36268]: Switch the default format used for writing tars with mod:tarfile to the modern POSIX.1-2001 pax standard, from the vendor-specific GNU. Contributed by C.A.M. Gerlach.

bpo-36285 [https://bugs.python.org/issue?@action=redirect&bpo=36285]: 修复 array 模块中的整数溢出问题。由 Stephan Hohe 提供补丁。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 为 VxWorks 添加 _signal 模块支持。

bpo-36272 [https://bugs.python.org/issue?@action=redirect&bpo=36272]: logging 不再静默忽略 RecursionError。补丁由 Rémi Lapeyre 贡献。

bpo-36280 [https://bugs.python.org/issue?@action=redirect&bpo=36280]: 向 ast.Constant 添加一个 kind 字段。如果字面量有 'u' 前缀（即 Python 2 风格的 unicode 字面量），则为 'u'，否则为 None。

bpo-35931 [https://bugs.python.org/issue?@action=redirect&bpo=35931]: pdb debug 命令现在能够优雅地处理所有异常。

bpo-36251 [https://bugs.python.org/issue?@action=redirect&bpo=36251]: 修复用于 stderrprinter 和 re.Match reprs 的格式字符串。由 Stephan Hohe 提供补丁。

bpo-36235 [https://bugs.python.org/issue?@action=redirect&bpo=36235]: 修复 distutils.sysconfig 的 customize_compiler() 中的 CFLAGS：当定义了 CFLAGS 环境变量时，不再用 OPT 变量覆盖 CFLAGS 变量。初始补丁由 David Malcolm 编写。

bpo-35807 [https://bugs.python.org/issue?@action=redirect&bpo=35807]: 更新ensurepip以安装pip 19.0.3和setuptools 40.8.0。

bpo-36139 [https://bugs.python.org/issue?@action=redirect&bpo=36139]: 在关闭 mmap 对象时释放GIL。

bpo-36179 [https://bugs.python.org/issue?@action=redirect&bpo=36179]: 修复_hashopenssl中两个不太可能的引用泄漏。这些泄漏仅在内存不足的情况下发生。

bpo-36169 [https://bugs.python.org/issue?@action=redirect&bpo=36169]: 向statistics.NormalDist添加overlap()方法。计算两个正态分布的重叠系数。

bpo-36103 [https://bugs.python.org/issue?@action=redirect&bpo=36103]: 在非Windows平台上，``shutil.copyfileobj()``使用的默认缓冲区大小从16 KiB更改为64 KiB，以减少系统调用开销。由Inada Naoki贡献。

bpo-36130 [https://bugs.python.org/issue?@action=redirect&bpo=36130]: 修复当步进到一个没有 __name__``全局变量的帧时，``pdb 与 skip=... 的问题。由Anthony Sottile提供补丁。

bpo-35652 [https://bugs.python.org/issue?@action=redirect&bpo=35652]: shutil.copytree(copy_function=...)错误地传递DirEntry而不是路径字符串。

bpo-35178 [https://bugs.python.org/issue?@action=redirect&bpo=35178]: Ensure custom warnings.formatwarning() function can receive line as positional argument. Based on patch by Tashrif Billah.

bpo-36106 [https://bugs.python.org/issue?@action=redirect&bpo=36106]: 解决与libm的sinpi()潜在的名称冲突。由Dmitrii Pasechnik提供补丁。

bpo-36091 [https://bugs.python.org/issue?@action=redirect&bpo=36091]: 清理Lib/types中对异步生成器的引用。由Henry Chen提供补丁。

bpo-36043 [https://bugs.python.org/issue?@action=redirect&bpo=36043]: FileCookieJar 支持 path-like object。由Stéphane Wirtel贡献。

bpo-35899 [https://bugs.python.org/issue?@action=redirect&bpo=35899]: 修复Enum以正确处理空字符串和非拉丁字符（如'α'、'א'）而不会崩溃。原始补丁由Maxwell贡献。由Stéphane Wirtel协助。

bpo-21269 [https://bugs.python.org/issue?@action=redirect&bpo=21269]: 向模拟调用对象添加 args 和 kwargs 属性。由Kumar Akshay贡献。

bpo-30670 [https://bugs.python.org/issue?@action=redirect&bpo=30670]: pprint.pp has been added to pretty-print objects with dictionary keys being sorted with their insertion order by default. Parameter sort_dicts has been added to pprint.pprint, pprint.pformat and pprint.PrettyPrinter. Contributed by Rémi Lapeyre.

bpo-35843 [https://bugs.python.org/issue?@action=redirect&bpo=35843]: 为 _NamespacePath 实现 __getitem__。由Anthony Sottile提供补丁。

bpo-35802 [https://bugs.python.org/issue?@action=redirect&bpo=35802]: 清理检查 os.stat / os.lstat / os.chmod 存在的代码，这些始终存在。由 Anthony Sottile 提供补丁。

bpo-35715 [https://bugs.python.org/issue?@action=redirect&bpo=35715]: 在不再需要后释放 ProcessPoolExecutor _process_worker 的返回值以释放内存。

bpo-35493 [https://bugs.python.org/issue?@action=redirect&bpo=35493]: 在 multiprocessing.Pool 中使用 multiprocessing.connection.wait() 而不是每 0.2 秒轮询一次工作更新。由 Pablo Galindo 提供补丁。

bpo-35661 [https://bugs.python.org/issue?@action=redirect&bpo=35661]: 将 venv 提示存储在 pyvenv.cfg 中。

bpo-35121 [https://bugs.python.org/issue?@action=redirect&bpo=35121]: 当请求路径是 cookie 路径属性的前缀匹配但不以 "/" 结尾时，不为请求设置 cookie。由 Karthikeyan Singaravelan 提供补丁。

bpo-21478 [https://bugs.python.org/issue?@action=redirect&bpo=21478]: 对使用 unittest.mock.create_autospec() 创建的子函数的调用应传播到父函数。由 Karthikeyan Singaravelan 提供补丁。

bpo-35198 [https://bugs.python.org/issue?@action=redirect&bpo=35198]: 修复 AIX 上的 C++ 扩展编译。

文档

bpo-36329 [https://bugs.python.org/issue?@action=redirect&bpo=36329]: 在执行 make -C Doc/ serve 时，为 Tools/scripts/serve.py 的使用声明 Python 二进制文件的路径。由 Stéphane Wirtel 贡献

bpo-36138 [https://bugs.python.org/issue?@action=redirect&bpo=36138]: 改进关于将 datetime.timedelta 转换为标量的文档。

bpo-21314 [https://bugs.python.org/issue?@action=redirect&bpo=21314]: 在编程 FAQ 的核心语言部分添加了一个新条目，解释了函数签名中斜杠(/)的用法。由 Lysandros Nikolaou 提供补丁。

测试

bpo-36234 [https://bugs.python.org/issue?@action=redirect&bpo=36234]: test_posix.PosixUidGidTests: 添加对无效 uid/gid 类型 (str) 的测试。初始补丁由 David Malcolm 编写。

bpo-29571 [https://bugs.python.org/issue?@action=redirect&bpo=29571]: 修复 test_re.test_locale_flag(): 使用 locale.getpreferredencoding() 而不是 locale.getlocale() 来获取区域编码。对于某些区域设置，locale.getlocale() 返回错误的编码。

bpo-36123 [https://bugs.python.org/issue?@action=redirect&bpo=36123]: 修复 test_socket 中的竞争条件。

构建

bpo-36356 [https://bugs.python.org/issue?@action=redirect&bpo=36356]: 修复导致在配置地址消毒器时构建失败的泄漏问题。

bpo-36146 [https://bugs.python.org/issue?@action=redirect&bpo=36146]: 向 setup.py 添加 TEST_EXTENSIONS 常量，以允许不构建像 _testcapi 这样的测试扩展。

bpo-36146 [https://bugs.python.org/issue?@action=redirect&bpo=36146]: 修复 macOS 上的 setup.py：仅将 /usr/include/ffi 添加到 _ctypes 的包含目录中，而不是所有扩展。

bpo-31904 [https://bugs.python.org/issue?@action=redirect&bpo=31904]: 使构建系统能够为 VxWorks RTOS 进行交叉构建。

Windows

bpo-36312 [https://bugs.python.org/issue?@action=redirect&bpo=36312]: 修复了以下代码页的解码器：50220、50221、50222、50225、50227、50229、57002 至 57011、65000 和 42。

bpo-36264 [https://bugs.python.org/issue?@action=redirect&bpo=36264]: 在 Windows 上的 os.path.expanduser 中不遵循 POSIX HOME。由 Anthony Sottile 提供补丁。

bpo-24643 [https://bugs.python.org/issue?@action=redirect&bpo=24643]: 修复由于 PC/pyconfig.h 中的 #define timezone _timezone 导致的名称冲突。

IDLE

bpo-36405 [https://bugs.python.org/issue?@action=redirect&bpo=36405]: 在 idlelib 中使用字典解包。

bpo-36396 [https://bugs.python.org/issue?@action=redirect&bpo=36396]: 移除 idlelib.config.GetHighlight() 的 fgBg 参数。该参数仅使用了两次，并改变了返回类型。

bpo-36176 [https://bugs.python.org/issue?@action=redirect&bpo=36176]: 修复 IDLE 自动完成和调用提示弹出窗口的颜色。防止与 Linux 深色主题冲突（并稍微调暗调用提示背景）。

bpo-23205 [https://bugs.python.org/issue?@action=redirect&bpo=23205]: 对于 grep 模块，为 findfiles 添加测试，将 findfiles 重构为模块级函数，并重构 findfiles 以使用 os.walk。

bpo-23216 [https://bugs.python.org/issue?@action=redirect&bpo=23216]: 为 IDLE 搜索模块添加文档字符串。

bpo-36152 [https://bugs.python.org/issue?@action=redirect&bpo=36152]: 移除 colorizer.ColorDelegator.close_when_done 和 .close() 的相应参数。在 IDLE 中，自 2007 年以来，两者始终为 None 或 False。

bpo-32129 [https://bugs.python.org/issue?@action=redirect&bpo=32129]: 避免在 macOS 上使用 Tk 8.6 时 IDLE 应用程序图标模糊。由 Kevin Walzer 提供补丁。

bpo-36096 [https://bugs.python.org/issue?@action=redirect&bpo=36096]: 在 colorizer 中将类变量重构为实例变量。

bpo-30348 [https://bugs.python.org/issue?@action=redirect&bpo=30348]: 将 idlelib.autocomplete 的测试覆盖率提高 30%。由 Louie Lu 提供补丁。

工具/示例

bpo-35132 [https://bugs.python.org/issue?@action=redirect&bpo=35132]: 修复 python-gdb.py 在 gdb7 上的 py-list 和 py-bt 命令。

bpo-32217 [https://bugs.python.org/issue?@action=redirect&bpo=32217]: 修复 Windows 上的冻结脚本。

C API

bpo-36381 [https://bugs.python.org/issue?@action=redirect&bpo=36381]: 当在没有 PY_SSIZE_T_CLEAN 的情况下使用 '#' 格式构建或解析值时，引发 DeprecationWarning。

bpo-36142 [https://bugs.python.org/issue?@action=redirect&bpo=36142]: 整个 coreconfig.h 头文件现在被排除在 Py_LIMITED_API 之外。将函数定义移动到一个新的内部 pycore_coreconfig.h 头文件中。

Python 3.8.0 alpha 2

发布日期: 2019-02-25

核心与内置函数

bpo-36052 [https://bugs.python.org/issue?@action=redirect&bpo=36052]: Raise a SyntaxError when assigning a value to __debug__ with the Assignment Operator. Contributed by Stéphane Wirtel and Pablo Galindo.

bpo-36012 [https://bugs.python.org/issue?@action=redirect&bpo=36012]: 类变量写入速度提高了一倍。当更新非双下划线属性时，减少了一次不必要的更新槽的调用。

bpo-35942 [https://bugs.python.org/issue?@action=redirect&bpo=35942]: 改进了在允许传递 PathLike 对象的接口中，从 __fspath__ 返回无效类型时发出的错误信息，现在它会解释错误的来源。

bpo-36016 [https://bugs.python.org/issue?@action=redirect&bpo=36016]: gc.get_objects 现在可以接收一个可选参数，指定从哪个代获取对象。由 Pablo Galindo 提供补丁。

bpo-1054041 [https://bugs.python.org/issue?@action=redirect&bpo=1054041]: 当主解释器由于未捕获的 KeyboardInterrupt 退出时，进程现在会以适当的方式退出，以便其父进程能够检测到是由于 SIGINT 或 ^C 终止的进程。这使得 shell 和批处理脚本能够理解用户要求它们停止。

bpo-35992 [https://bugs.python.org/issue?@action=redirect&bpo=35992]: 修复了在具有自定义不可下标元类的类上不调用 __class_getitem__() 的问题。

bpo-35993 [https://bugs.python.org/issue?@action=redirect&bpo=35993]: 修复了在使用子解释器时 fork 导致的崩溃。由 Stéphane Wirtel 贡献。

bpo-35991 [https://bugs.python.org/issue?@action=redirect&bpo=35991]: 修复了 Modules/_randommodule.c 中的潜在双重释放问题。

bpo-35961 [https://bugs.python.org/issue?@action=redirect&bpo=35961]: 修复了 slice_richcompare() 中的崩溃：对两个临时内部元组使用强引用而非偷取的引用。

bpo-35911 [https://bugs.python.org/issue?@action=redirect&bpo=35911]: 通过添加 cell.__new__ 方法启用 cell 对象的创建，并在 Lib/types.py 中以 CellType 的名称公开 cell 类型。由 Pierre Glaser 提供补丁。

bpo-12822 [https://bugs.python.org/issue?@action=redirect&bpo=12822]: 当 pthread_condattr_setclock 和 CLOCK_MONOTONIC 可用时，使用单调时钟进行 pthread_cond_timedwait。

bpo-15248 [https://bugs.python.org/issue?@action=redirect&bpo=15248]: 编译器现在在可能遗漏逗号之前元组或列表的情况下发出语法警告。

bpo-35886 [https://bugs.python.org/issue?@action=redirect&bpo=35886]: PyInterpreterState 的实现已移至内部头文件中（由 Py_BUILD_CORE 保护）。

bpo-31506 [https://bugs.python.org/issue?@action=redirect&bpo=31506]: 澄清当 object.__new__ 和 object.__init__ 接收到多于一个参数时报告的错误。由 Sanyam Khurana 贡献。

bpo-35724 [https://bugs.python.org/issue?@action=redirect&bpo=35724]: 现在保证信号处理相对于主解释器进行。

bpo-33608 [https://bugs.python.org/issue?@action=redirect&bpo=33608]: 我们新增了一个内部的 _Py_AddPendingCall()，它相对于提供的解释器进行操作。这使得我们可以使用现有的实现来请求另一个解释器执行在当前解释器中无法完成的工作，比如减少另一个解释器拥有的对象的引用计数。现有的 Py_AddPendingCall() 仅相对于主解释器进行操作。

bpo-33989 [https://bugs.python.org/issue?@action=redirect&bpo=33989]: 修复了在 list.sort() 中对 ob_type->tp_richcompare == NULL 的对象进行排序时可能发生的崩溃。由 Zackery Spytz 提供补丁。

库

bpo-35512 [https://bugs.python.org/issue?@action=redirect&bpo=35512]: unittest.mock.patch.dict() 用作装饰器时，字符串目标在函数调用期间而非装饰器构建期间解析目标。由 Karthikeyan Singaravelan 提供补丁。

bpo-36018 [https://bugs.python.org/issue?@action=redirect&bpo=36018]: 添加 statistics.NormalDist，一个用于创建和操作随机变量正态分布的工具。具有一个复合类，将测量数据的平均值和标准差视为单一实体。

bpo-35904 [https://bugs.python.org/issue?@action=redirect&bpo=35904]: Added statistics.fmean() as a faster, floating point variant of the existing mean() function.

bpo-35918 [https://bugs.python.org/issue?@action=redirect&bpo=35918]: 从 multiprocessing.managers.SyncManager.dict 中移除了损坏的 has_key 方法。由 Rémi Lapeyre 贡献。

bpo-18283 [https://bugs.python.org/issue?@action=redirect&bpo=18283]: 添加对 bytes 的支持到 shutil.which()。

bpo-35960 [https://bugs.python.org/issue?@action=redirect&bpo=35960]: 修复 dataclasses.field() 丢弃作为元数据传递的空映射对象的问题。

bpo-35500 [https://bugs.python.org/issue?@action=redirect&bpo=35500]: 在 unittest.mock.Mock.assert_called_with() 断言错误中，将预期和实际的调用参数分别写在单独的行上。由 Susan Su 贡献。

bpo-35931 [https://bugs.python.org/issue?@action=redirect&bpo=35931]: pdb debug 命令现在优雅地处理语法错误。

bpo-24209 [https://bugs.python.org/issue?@action=redirect&bpo=24209]: 在http.server脚本中，依赖getaddrinfo根据bind参数绑定到首选地址。现在默认绑定或绑定到一个名称可能会绑定到IPv6或双栈，取决于环境。

bpo-35321 [https://bugs.python.org/issue?@action=redirect&bpo=35321]: 设置 _frozen_importlib 的 __spec__.origin 为frozen，以匹配``_frozen_importlib_external``的行为。由Nina Zakharenko提供补丁。

bpo-35378 [https://bugs.python.org/issue?@action=redirect&bpo=35378]: 修复 multiprocessing.Pool 内部的一个引用问题，该问题导致如果池在没有显式关闭或终止的情况下被删除，池将保持活动状态。为池迭代器添加了一个新的强引用，将池的生命周期与其迭代器的生命周期联系起来，因此如果池迭代器仍然存活，池不会被销毁。

bpo-34294 [https://bugs.python.org/issue?@action=redirect&bpo=34294]: re模块，在罕见情况下修复错误的捕获组。re.search()、re.findall()、re.sub() 和其他扫描字符串寻找匹配的函数，应在两次匹配尝试之间重置捕获组。由Ma Lin提供补丁。

bpo-35615 [https://bugs.python.org/issue?@action=redirect&bpo=35615]: weakref: 修复在复制WeakKeyDictionary或WeakValueDictionary时由于某些键或值在迭代过程中消失而导致的RuntimeError。

bpo-35606 [https://bugs.python.org/issue?@action=redirect&bpo=35606]: 实现 math.prod() 作为 sum() 的类似函数，返回'start'值（默认：1）乘以数字可迭代对象的乘积。由Pablo Galindo提供补丁。

bpo-32417 [https://bugs.python.org/issue?@action=redirect&bpo=32417]: 在 datetime.datetime 子类和 datetime.timedelta 之间执行算术现在返回与 datetime.datetime 子类相同类型的对象。因此，datetime.datetime.astimezone() 和替代构造函数如 datetime.datetime.now() 和带``tz`` 参数调用的 datetime.fromtimestamp() 现在 也 保留它们的子类。

bpo-35153 [https://bugs.python.org/issue?@action=redirect&bpo=35153]: 向 xmlrpc.client.ServerProxy、xmlrpc.client.Transport 和 xmlrpc.client.SafeTransport 添加 headers 可选仅关键字参数。补丁由Cédric Krier提供。

bpo-34572 [https://bugs.python.org/issue?@action=redirect&bpo=34572]: 修复 pickle.loads 的 C 实现以使用 importlib 的锁定机制，从而避免使用部分加载的模块。由 Tim Burgess 提供补丁。

文档

bpo-36083 [https://bugs.python.org/issue?@action=redirect&bpo=36083]: 修复手册页 Synopsis 中 --check-hash-based-pycs 选项的格式。

bpo-36007 [https://bugs.python.org/issue?@action=redirect&bpo=36007]: 将最低 sphinx 版本提升至 1.8。由 Anthony Sottile 提供补丁。

bpo-22062 [https://bugs.python.org/issue?@action=redirect&bpo=22062]: 更新 pathlib 的文档和文档字符串。原始由 Mike Short 提供补丁。

测试

bpo-27313 [https://bugs.python.org/issue?@action=redirect&bpo=27313]: 避免 test_ttk_guionly ComboboxTest 在 macOS Cocoa Tk 上失败。

bpo-36019 [https://bugs.python.org/issue?@action=redirect&bpo=36019]: 添加 test.support.TEST_HTTP_URL 并用此新常量替换对 http://www.example.com 的引用。由 Stéphane Wirtel 贡献。

bpo-36037 [https://bugs.python.org/issue?@action=redirect&bpo=36037]: 为严格的 OpenSSL 配置（如 RHEL8 严格加密策略）修复 test_ssl。如果需要，为服务器 SSL 上下文的最低 TLS 版本使用较旧的 TLS 版本，以测试比默认最低 TLS 版本更旧的 TLS 版本。

bpo-35798 [https://bugs.python.org/issue?@action=redirect&bpo=35798]: 添加了 test.support.check_syntax_warning()。

bpo-35505 [https://bugs.python.org/issue?@action=redirect&bpo=35505]: 使 test_imap4_host_default_value 不依赖于本地 IMAP 服务器是否运行。

bpo-35917 [https://bugs.python.org/issue?@action=redirect&bpo=35917]: multiprocessing：为 SyncManager 和 SharedMemoryManager 类提供单元测试 + 所有应该由它们支持的共享类型。（由 Giampaolo Rodola 提供补丁）

bpo-35704 [https://bugs.python.org/issue?@action=redirect&bpo=35704]: 跳过 test_shutil.test_unpack_archive_xztar 以防止在 32 位 AIX 上当 MAXDATA 设置小于 0x20000000 时发生 MemoryError。

由 Michael Felt (aixtools) 提供补丁

bpo-34720 [https://bugs.python.org/issue?@action=redirect&bpo=34720]: 断言 m_state != NULL 以模仿 GC 遍历函数，这些函数在模块状态尚未创建时不正确处理模块创建。

Windows

bpo-35976 [https://bugs.python.org/issue?@action=redirect&bpo=35976]: 在 PCBuild 的 Windows 构建文件中添加 ARM 构建支持。

bpo-35692 [https://bugs.python.org/issue?@action=redirect&bpo=35692]: pathlib 在检查未准备好驱动器上的文件和目录存在时不再引发异常

bpo-35872 [https://bugs.python.org/issue?@action=redirect&bpo=35872]: 在虚拟环境中调用 venv 时使用基础 Python 可执行文件

bpo-35873 [https://bugs.python.org/issue?@action=redirect&bpo=35873]: 防止 venv 路径被子进程继承

bpo-35299 [https://bugs.python.org/issue?@action=redirect&bpo=35299]: 修复在PGO分析期间sysconfig对源目录的检测以及distutils对pyconfig.h的处理。

IDLE

bpo-24310 [https://bugs.python.org/issue?@action=redirect&bpo=24310]: IDLE —— 文档设置对话框字体标签示例。

bpo-35833 [https://bugs.python.org/issue?@action=redirect&bpo=35833]: 修订IDLE文档关于发送到Shell的控制码。添加一个代码示例块。

bpo-35689 [https://bugs.python.org/issue?@action=redirect&bpo=35689]: 为colorizer.py添加文档字符串和单元测试。

Python 3.8.0 alpha 1

发布日期: 2019-02-03

安全性

bpo-35746 [https://bugs.python.org/issue?@action=redirect&bpo=35746]: [CVE-2019-5010] Fix a NULL pointer deref in ssl module. The cert parser did not handle CRL distribution points with empty DP or URI correctly. A malicious or buggy certificate can result into segfault. Vulnerability (TALOS-2018-0758) reported by Colin Read and Nicolas Edet of Cisco.

bpo-34812 [https://bugs.python.org/issue?@action=redirect&bpo=34812]: The -I command line option (run Python in isolated mode) is now also copied by the multiprocessing and distutils modules when spawning child processes. Previously, only -E and -s options (enabled by -I) were copied.

bpo-34791 [https://bugs.python.org/issue?@action=redirect&bpo=34791]: 当sys.flags.ignore_environment由-E或-I参数设置时，xml.sax和xml.dom.domreg不再使用环境变量来覆盖解析器实现。

bpo-17239 [https://bugs.python.org/issue?@action=redirect&bpo=17239]: xml.sax和xml.dom.minidom解析器默认不再处理外部实体。外部DTD和ENTITY声明不再加载文件或创建网络连接。

bpo-34623 [https://bugs.python.org/issue?@action=redirect&bpo=34623]: CVE-2018-14647: The C accelerated _elementtree module now initializes hash randomization salt from _Py_HashSecret instead of libexpat's default CSPRNG.

bpo-34405 [https://bugs.python.org/issue?@action=redirect&bpo=34405]: 更新Windows构建的OpenSSL至1.1.0i版本。

bpo-33871 [https://bugs.python.org/issue?@action=redirect&bpo=33871]: 修复在macOS上 os.sendfile() 中发送文件部分的问题。使用 trailers 参数可能导致从输入文件发送的字节数多于指定数量。

bpo-32533 [https://bugs.python.org/issue?@action=redirect&bpo=32533]: 修复_ssl中错误处理的线程安全性。

bpo-33136 [https://bugs.python.org/issue?@action=redirect&bpo=33136]: Harden ssl module against LibreSSL CVE-2018-8970. X509_VERIFY_PARAM_set1_host() is called with an explicit namelen. A new test ensures that NULL bytes are not allowed.

bpo-33001 [https://bugs.python.org/issue?@action=redirect&bpo=33001]: Windows 上 os.symlink 防止缓冲区溢出的最小修复。

bpo-32981 [https://bugs.python.org/issue?@action=redirect&bpo=32981]: Regexes in difflib and poplib were vulnerable to catastrophic backtracking. These regexes formed potential DOS vectors (REDOS). They have been refactored. This resolves CVE-2018-1060 and CVE-2018-1061. Patch by Jamie Davis.

bpo-28414 [https://bugs.python.org/issue?@action=redirect&bpo=28414]: ssl 模块现在允许用户在使用 SNI 时，自行执行 IDN 的编码与解码操作。

核心与内置函数

bpo-35877 [https://bugs.python.org/issue?@action=redirect&bpo=35877]: 允许在 while 语句中的赋值表达式中省略圆括号。补丁由 Karthikeyan Singaravelan 提交。

bpo-35814 [https://bugs.python.org/issue?@action=redirect&bpo=35814]: 允许在带有类型注解的赋值中使用与普通赋值相同的右侧表达式。特别地，现在允许写作``x: Tuple[int, int] = 1, 2`` （右侧不必括号）。

bpo-35766 [https://bugs.python.org/issue?@action=redirect&bpo=35766]: 在 ast 模块中添加了解析 PEP 484 类型注释的选项。（默认关闭）本更改合并了第三方分支项目 [typed_ast](https://github.com/python/typed_ast) 的关键功能。

bpo-35713 [https://bugs.python.org/issue?@action=redirect&bpo=35713]:重新组织 Python 的初始化流程，以便更早地启用异常处理机制和 sys.stderr。

bpo-33416 [https://bugs.python.org/issue?@action=redirect&bpo=33416]: 向 Python AST 节点添加结束行和结束列位置信息。这是一个 C 级别的向后不兼容的更改。

bpo-35720 [https://bugs.python.org/issue?@action=redirect&bpo=35720]: 修复了 Modules/main.c 中 pymain_parse_cmdline_impl 函数的一个小内存泄漏。

bpo-35634 [https://bugs.python.org/issue?@action=redirect&bpo=35634]: func(**kwargs) 现在会在 kwargs 是一个包含多个相同键的映射时引发错误。自 Python 3.6 起，当其他关键字参数在 **kwargs 之前传递时，已经会引发错误。

bpo-35623 [https://bugs.python.org/issue?@action=redirect&bpo=35623]: 修复了排序非常长的列表时的一个崩溃。由 Stephan Hohe 提供补丁。

bpo-35214 [https://bugs.python.org/issue?@action=redirect&bpo=35214]: 添加了 clang Memory Sanitizer 构建工具，以解决来自 posix、socket、time、test_io 和 test_faulthandler 的误报。

bpo-35560 [https://bugs.python.org/issue?@action=redirect&bpo=35560]: Fix an assertion error in format() in debug build for floating point formatting with "n" format, zero padding and small width. Release build is not impacted. Patch by Karthikeyan Singaravelan.

bpo-35552 [https://bugs.python.org/issue?@action=redirect&bpo=35552]: 在 PyUnicode_FromFormat() 中的格式字符 %s 和 %V 以及 PyBytes_FromFormat() 中的 %s 不再读取超过 precision 指定限制的内存。

bpo-35504 [https://bugs.python.org/issue?@action=redirect&bpo=35504]: 修复了删除某些属性时的段错误和 SystemErrors。由 Zackery Spytz 提供补丁。

bpo-35504 [https://bugs.python.org/issue?@action=redirect&bpo=35504]: 修复了删除 OSError 的 characters_written 属性时出现的 SystemError。

bpo-35494 [https://bugs.python.org/issue?@action=redirect&bpo=35494]: 改进了 f-string 中括号不匹配的语法错误消息。

bpo-35444 [https://bugs.python.org/issue?@action=redirect&bpo=35444]: 修复了在无法查找内置 "getattr" 时，pickling 方法中的错误处理。加快了 pickling 迭代器的速度。

bpo-35436 [https://bugs.python.org/issue?@action=redirect&bpo=35436]: 修复了内存分配错误处理中的多个问题。由 Zackery Spytz 提供补丁。

bpo-35423 [https://bugs.python.org/issue?@action=redirect&bpo=35423]: 将 eval 循环中的信号处理触发器与 "pending calls" 机制分离。没有语义上的变化，性能差异也不显著。

bpo-35357 [https://bugs.python.org/issue?@action=redirect&bpo=35357]: unittest.mock._Call 和 unittest.mock.MagicProxy 的内部属性名（name, parent & from_kall）现在以 _mock_ 为前缀，以防止与广泛使用的对象属性冲突。修复了测试函数名称中的小错字。

bpo-35372 [https://bugs.python.org/issue?@action=redirect&bpo=35372]: 修复了对于长度超过 2 GiB 且包含不可解码字节的输入的代码页解码器。

bpo-35336 [https://bugs.python.org/issue?@action=redirect&bpo=35336]: 修复 PYTHONCOERCECLOCALE=1 环境变量：仅当 LC_CTYPE 区域设置为 "C" 时才强制使用 C 区域设置。

bpo-31241 [https://bugs.python.org/issue?@action=redirect&bpo=31241]: 列表推导式、生成器表达式和元组的 AST 节点的 lineno 和 col_offset 属性现在指向开括号或方括号。对于没有括号的元组，它们指向第一个项目的位置。

bpo-33954 [https://bugs.python.org/issue?@action=redirect&bpo=33954]: 对于 str.format()、float.__format__() 和 complex.__format__() 方法，当使用 "n" 格式化器时处理非 ASCII 小数点。

bpo-35269 [https://bugs.python.org/issue?@action=redirect&bpo=35269]: 修复了涉及新创建的协程的可能段错误。由 Zackery Spytz 提供补丁。

bpo-35224 [https://bugs.python.org/issue?@action=redirect&bpo=35224]: 实现了 PEP 572 [https://www.python.org/dev/peps/pep-0572] (赋值表达式) 。由 Emily Morehouse 提供补丁。

bpo-32492 [https://bugs.python.org/issue?@action=redirect&bpo=32492]: Speed up namedtuple attribute access by 1.6x using a C fast-path for the name descriptors. Patch by Pablo Galindo.

bpo-35214 [https://bugs.python.org/issue?@action=redirect&bpo=35214]: 修复了在解析字符串末尾被截断的Unicode转义序列（如 '\N'）时超出边界的内存访问问题。它会读取超出内存分配末尾的一个字节。

bpo-35214 [https://bugs.python.org/issue?@action=redirect&bpo=35214]: 解释器和扩展模块已添加注释，以便它们在clang的内存清理器下正常工作。新增了一个配置标志--with-memory-sanitizer，使得执行此类测试构建更加容易。

bpo-35193 [https://bugs.python.org/issue?@action=redirect&bpo=35193]: 修复了字节码窥孔优化器中的一个偏差一个错误，该错误在移除不可达代码时可能会读取数组边界之外的字节。这个错误在Python 3.6和3.7的每个版本中都存在，直到现在。

bpo-35169 [https://bugs.python.org/issue?@action=redirect&bpo=35169]: 改进了禁止赋值的错误消息。

bpo-34022 [https://bugs.python.org/issue?@action=redirect&bpo=34022]: 修复了在 zipimport 中处理基于哈希的字节码文件的问题。由Elvis Pranskevichus提供补丁。

bpo-28401 [https://bugs.python.org/issue?@action=redirect&bpo=28401]: 调试构建将不再尝试导入为ABI构建的扩展模块，因为它们从一开始就不兼容。补丁由Stefano Rivera提供。

bpo-29341 [https://bugs.python.org/issue?@action=redirect&bpo=29341]: 在 os 方法的文档字符串中明确说明，路径样式的对象也被接受作为输入参数。

bpo-35050 [https://bugs.python.org/issue?@action=redirect&bpo=35050]: socket: 修复了 AF_ALG 名称和类型长度检查中的一个偏差一个错误。

bpo-29743 [https://bugs.python.org/issue?@action=redirect&bpo=29743]: 在 ctypes.Array 子类中，对于负的 _length_，现在会引发 ValueError 而不是 OverflowError。对于非整数的 _length_，也会引发 TypeError 而不是 AttributeError。原始由Oren Milman提供补丁。

bpo-16806 [https://bugs.python.org/issue?@action=redirect&bpo=16806]: 修复了多行字符串标记的 lineno 和 col_offset。

bpo-35029 [https://bugs.python.org/issue?@action=redirect&bpo=35029]: 在代码生成时作为异常引发的 SyntaxWarning 现在将被替换为 SyntaxError，以便更好地报告错误。

bpo-34983 [https://bugs.python.org/issue?@action=redirect&bpo=34983]: 在 symtable 模块中公开 symtable.Symbol.is_nonlocal() 方法。由 Pablo Galindo 提供补丁。

bpo-34974 [https://bugs.python.org/issue?@action=redirect&bpo=34974]: bytes 和 bytearray 构造函数不再将意外异常（如 MemoryError 和 KeyboardInterrupt）转换为 TypeError。

bpo-34939 [https://bugs.python.org/issue?@action=redirect&bpo=34939]: 允许在模块命名空间中使用在注解前声明为全局的注解名称。由 Pablo Galindo 提供补丁。

bpo-34973 [https://bugs.python.org/issue?@action=redirect&bpo=34973]: 修复了在 bytes() 中当 list 参数在迭代时被修改导致的崩溃。

bpo-34876 [https://bugs.python.org/issue?@action=redirect&bpo=34876]: AST 中装饰函数和类的 lineno 和 col_offset 属性现在指向对应的 def、async def 和 class 的位置，而不是第一个装饰器的位置。这使得在跟踪时行号报告更加准确。这是唯一一种子 AST 节点的位置可能先于父 AST 节点位置的情况。

bpo-34879 [https://bugs.python.org/issue?@action=redirect&bpo=34879]: 修复了 bytesobject.c 中可能的空指针解引用问题。由 Zackery Spytz 提供补丁。

bpo-34784 [https://bugs.python.org/issue?@action=redirect&bpo=34784]: 修复了 PyStructSequence_NewType 的实现，以便创建堆分配的 StructSequences。

bpo-32912 [https://bugs.python.org/issue?@action=redirect&bpo=32912]: 现在对于字符串和字节字面量中的无效转义序列，会发出 SyntaxWarning 而不是 DeprecationWarning。

bpo-34854 [https://bugs.python.org/issue?@action=redirect&bpo=34854]: 修复了在编译包含有关键字唯一参数但没有默认值的 lambda 的字符串注解时的崩溃问题。

bpo-34850 [https://bugs.python.org/issue?@action=redirect&bpo=34850]: 当身份检查（is 和 is not）与某些类型的字面量（例如字符串、整数）一起使用时，编译器现在会产生一个 SyntaxWarning。这些在 CPython 中可能偶然工作，但语言规范不保证。警告建议用户改用相等测试（== 和 !=）。

bpo-34824 [https://bugs.python.org/issue?@action=redirect&bpo=34824]: 修复了 Modules/_ssl.c 中可能的空指针解引用问题。补丁由 Zackery Spytz 提供。

bpo-30156 [https://bugs.python.org/issue?@action=redirect&bpo=30156]: The C function property_descr_get() uses a "cached" tuple to optimize function calls. But this tuple can be discovered in debug mode with sys.getobjects(). Remove the optimization, it's not really worth it and it causes 3 different crashes last years.

bpo-34762 [https://bugs.python.org/issue?@action=redirect&bpo=34762]: 修复contextvars C API以使用PyObject*指针类型。

bpo-34751 [https://bugs.python.org/issue?@action=redirect&bpo=34751]: 元组的哈希函数现在基于xxHash，这在（以前的）病态情况下提供了更好的碰撞结果。此外，在64位系统上，它总体上改善了元组的哈希。由Jeroen Demeyer提供补丁，Tim Peters做出了重要贡献。

bpo-34735 [https://bugs.python.org/issue?@action=redirect&bpo=34735]: 修复Modules/timemodule.c中的内存泄漏。由Zackery Spytz提供补丁。

bpo-34683 [https://bugs.python.org/issue?@action=redirect&bpo=34683]: 修复了一个错误，其中一些SyntaxError错误指向了位置偏移一位的位置。

bpo-34651 [https://bugs.python.org/issue?@action=redirect&bpo=34651]: 只允许主解释器进行fork。这避免了影响主解释器的可能性，这对运行时的操作至关重要。

bpo-34653 [https://bugs.python.org/issue?@action=redirect&bpo=34653]: 移除未使用的函数PyParser_SimpleParseStringFilename。

bpo-32236 [https://bugs.python.org/issue?@action=redirect&bpo=32236]: 警告如果以二进制模式和 buffering=1 调用 open()，则不支持行缓冲。

bpo-34641 [https://bugs.python.org/issue?@action=redirect&bpo=34641]: 进一步限制函数调用中关键字参数左侧的语法。特别是，``f((keyword)=arg)``现在是不允许的。

bpo-34637 [https://bugs.python.org/issue?@action=redirect&bpo=34637]: 使 sum() 的 start 参数作为关键字参数可见。

bpo-1621 [https://bugs.python.org/issue?@action=redirect&bpo=1621]: 在执行集合哈希表调整大小时，不假定有符号整数溢出行为（C未定义行为）。

bpo-34588 [https://bugs.python.org/issue?@action=redirect&bpo=34588]: 修复回溯格式化中递归调用修剪特性的一个偏移一位的错误。

bpo-34485 [https://bugs.python.org/issue?@action=redirect&bpo=34485]: 在Windows上，LC_CTYPE现在在启动时设置为用户首选区域设置。以前，LC_CTYPE区域设置在启动时为"C"，但在调用setlocale(LC_CTYPE, "")或setlocale(LC_ALL, "")时会更改。

bpo-34485 [https://bugs.python.org/issue?@action=redirect&bpo=34485]: 在POSIX区域设置（当C区域未被强制且UTF-8模式被禁用时），像sys.stdout这样的标准流现在使用"surrogateescape"错误处理程序，而不是"strict"。

bpo-34485 [https://bugs.python.org/issue?@action=redirect&bpo=34485]: 修复像sys.stdout这样的标准流的错误处理程序：PYTHONIOENCODING=":"现在被忽略，而不是将错误处理程序设置为"strict"。

bpo-34485 [https://bugs.python.org/issue?@action=redirect&bpo=34485]: Python现在使用C代码获取区域编码，以初始化像sys.stdout这样的标准流的编码。此外，编码现在初始化为Python编解码器名称，以获取规范化的编码名称并确保编解码器被加载。这一改变默认避免了在启动时导入_bootlocale和_locale模块。

bpo-34527 [https://bugs.python.org/issue?@action=redirect&bpo=34527]: 在FreeBSD上，如果LC_CTYPE区域是"POSIX"，Py_DecodeLocale()和Py_EncodeLocale()现在也会强制使用ASCII编码，而不仅仅是当LC_CTYPE区域是"C"时。

bpo-34527 [https://bugs.python.org/issue?@action=redirect&bpo=34527]: UTF-8模式现在也由"POSIX"区域启用，而不仅仅是"C"区域。

bpo-34403 [https://bugs.python.org/issue?@action=redirect&bpo=34403]: 在HP-UX上，如果使用C或POSIX区域设置，sys.getfilesystemencoding()现在返回"ascii"而不是"roman8"（当UTF-8模式被禁用且C区域未被强制时）。

bpo-34523 [https://bugs.python.org/issue?@action=redirect&bpo=34523]: Python文件系统编码现在在Python初始化期间更早地读取。

bpo-12458 [https://bugs.python.org/issue?@action=redirect&bpo=12458]: 回溯现在显示多行表达式中子表达式的正确行号。回溯现在显示多行表达式的第一行的行号，而不是最后一个子表达式的行号。

bpo-34408 [https://bugs.python.org/issue?@action=redirect&bpo=34408]: 防止 PyInterpreterState_New() 中的空指针解引用和资源泄漏。

bpo-34400 [https://bugs.python.org/issue?@action=redirect&bpo=34400]: 修复parsetok.c中的未定义行为。由Zackery Spytz提供补丁。

bpo-33073 [https://bugs.python.org/issue?@action=redirect&bpo=33073]: 向ints添加了as_integer_ratio，以使它们更易于与floats互操作。

bpo-34377 [https://bugs.python.org/issue?@action=redirect&bpo=34377]: 更新valgrind抑制列表，使用 _PyObject_Free/_PyObject_Realloc 代替``PyObject_Free``/PyObject_Realloc。

bpo-34353 [https://bugs.python.org/issue?@action=redirect&bpo=34353]: Added the "socket" option in the stat.filemode() Python implementation to match the C implementation.

bpo-34320 [https://bugs.python.org/issue?@action=redirect&bpo=34320]: 修复了 dict(od) 未复制OrderedDict的迭代顺序的问题。

bpo-34113 [https://bugs.python.org/issue?@action=redirect&bpo=34113]: 修复了在调试版本中，当操作码堆栈被调整为负数时崩溃的问题。由Constantin Petrisor提供补丁。

bpo-34100 [https://bugs.python.org/issue?@action=redirect&bpo=34100]: 编译器现在递归合并元组和冻结集合中的常量。代码属性如 co_names 也被合并。

bpo-34151 [https://bugs.python.org/issue?@action=redirect&bpo=34151]: 列表连接、重复和切片操作的性能略有提升。由Sergey Fedoseev提供补丁。

bpo-34170 [https://bugs.python.org/issue?@action=redirect&bpo=34170]: -X dev: 现在即使启用了开发者模式，也可以使用PYTHONMALLOC覆盖内存分配器。

bpo-33237 [https://bugs.python.org/issue?@action=redirect&bpo=33237]: 改进了部分初始化模块的 AttributeError 消息。

bpo-34149 [https://bugs.python.org/issue?@action=redirect&bpo=34149]: 修复min和max函数在key为None时获取默认行为的问题。

bpo-34125 [https://bugs.python.org/issue?@action=redirect&bpo=34125]: 当给出 **kwargs 时，现在可以对未绑定的内置方法进行性能分析。

bpo-34141 [https://bugs.python.org/issue?@action=redirect&bpo=34141]: 优化了原子类型（None, bool, int, float, bytes, str）的pickling。

bpo-34126 [https://bugs.python.org/issue?@action=redirect&bpo=34126]: 修复了在分析某些无效调用的未绑定方法时的崩溃问题。由Jeroen Demeyer提供补丁。

bpo-24618 [https://bugs.python.org/issue?@action=redirect&bpo=24618]: 修复了在创建代码对象时，当varnames元组过小或参数计数过大时读取无效内存的问题。

bpo-34068 [https://bugs.python.org/issue?@action=redirect&bpo=34068]: 在 io.IOBase.close() 中，确保在存在活动异常时不设置 closed 属性。由Zackery Spytz和Serhiy Storchaka提供补丁。

bpo-34087 [https://bugs.python.org/issue?@action=redirect&bpo=34087]: 修复了将unicode转换为数值时的缓冲区溢出问题。

bpo-34080 [https://bugs.python.org/issue?@action=redirect&bpo=34080]: 修复了编译器在词法分析过程中引发一些不常见错误时的内存泄漏问题。

bpo-34066 [https://bugs.python.org/issue?@action=redirect&bpo=34066]: 在 with open() 中，禁止在调用 open() 和进入 with 块之间通过Ctrl-C中断。

bpo-34042 [https://bugs.python.org/issue?@action=redirect&bpo=34042]: 修复dict.copy()以维持正确的总引用计数（如sys.gettotalrefcount()报告的那样）。

bpo-33418 [https://bugs.python.org/issue?@action=redirect&bpo=33418]: 修复了函数对象在创建引用循环时潜在的内存泄漏问题。

bpo-33985 [https://bugs.python.org/issue?@action=redirect&bpo=33985]: 实现 contextvars.ContextVar.name 属性。

bpo-33956 [https://bugs.python.org/issue?@action=redirect&bpo=33956]: 将集成的 Expat 库更新至版本 2.2.5。

bpo-24596 [https://bugs.python.org/issue?@action=redirect&bpo=24596]: 在调用 PyErr_Print() 之前，先在 PyRun_SimpleFileExFlags() 中减少模块对象的引用计数。由 Zackery Spytz 提供补丁。

bpo-33451 [https://bugs.python.org/issue?@action=redirect&bpo=33451]: 在调用 PyEval_EvalCode() 之前关闭直接执行的 pyc 文件。

bpo-1617161 [https://bugs.python.org/issue?@action=redirect&bpo=1617161]: BuiltinMethodType 实例（内置类的方法）的哈希现在依赖于 __self__ 的身份哈希而非其值。ModuleType 和 MethodWrapperType 实例（用户定义类的方法和一些内置类的方法如 str.__add__）的哈希和相等性现在依赖于 __self__ 的身份哈希和相等性而非其值。MethodWrapperType 实例不再支持排序。

bpo-33824 [https://bugs.python.org/issue?@action=redirect&bpo=33824]: 修复 "LC_ALL=C python3.7 -V"：在读取 Python 配置后编码更改时正确重置命令行解析器。

bpo-33803 [https://bugs.python.org/issue?@action=redirect&bpo=33803]: 修复 hamt.c 中的一个崩溃问题，该问题是由于为一个对象启用 GC 跟踪时，其所有字段未设置为 NULL 引起的。

bpo-33738 [https://bugs.python.org/issue?@action=redirect&bpo=33738]: 修复了七个与有限 API 不兼容的宏，并将宏 PyIter_Check()、PyIndex_Check() 和 PyExceptionClass_Name() 作为函数添加。添加了一个用于自动检查宏的脚本。

bpo-33786 [https://bugs.python.org/issue?@action=redirect&bpo=33786]: 修复异步生成器以正确处理 athrow() 中的 GeneratorExit。

bpo-30167 [https://bugs.python.org/issue?@action=redirect&bpo=30167]: PyRun_SimpleFileExFlags 除了移除模块中的 __file__ 外，还移除了 __cached__。

bpo-33706 [https://bugs.python.org/issue?@action=redirect&bpo=33706]: 修复解析命令行选项时 Python 初始化过程中的崩溃问题。感谢 Christoph Gohlke 的报告和修复！

bpo-33597 [https://bugs.python.org/issue?@action=redirect&bpo=33597]: 将 PyGC_Head 的大小从 3 个字减少到 2 个字。

bpo-30654 [https://bugs.python.org/issue?@action=redirect&bpo=30654]: 修复了即使之前设置了自定义处理程序，在解释器关闭时 SIGINT 处理程序重置为 SIG_DFL 的问题。由 Philipp Kerling 提供补丁。

bpo-33622 [https://bugs.python.org/issue?@action=redirect&bpo=33622]: 修复了当垃圾收集器无法将带有 __del__ 方法或被其引用的对象添加到 gc.garbage 列表时的内存泄漏问题。现在可以在设置异常时调用 PyGC_Collect()，并保留异常。

bpo-33462 [https://bugs.python.org/issue?@action=redirect&bpo=33462]: 使字典和字典视图可逆。由 Rémi Lapeyre 提供补丁。

bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722]: 当自定义元类没有在传递给 type.__new__ 的命名空间中提供 __classcell__ 条目时，现在会引发 RuntimeError。在 Python 3.6--3.7 中会发出 DeprecationWarning。

bpo-33499 [https://bugs.python.org/issue?@action=redirect&bpo=33499]: 添加了 PYTHONPYCACHEPREFIX 环境变量和 -X pycache_prefix 命令行选项，用于设置写入模块字节码缓存文件的备用根目录。

bpo-25711 [https://bugs.python.org/issue?@action=redirect&bpo=25711]: zipimport 模块已用纯 Python 重写。

bpo-33509 [https://bugs.python.org/issue?@action=redirect&bpo=33509]: 修复了 warnings.warn_explicit() 的 module_globals 参数：如果 module_globals 不是字典，不会崩溃。

bpo-31849 [https://bugs.python.org/issue?@action=redirect&bpo=31849]: 修复了 pyhash.c 中的有符号/无符号比较警告。

bpo-33475 [https://bugs.python.org/issue?@action=redirect&bpo=33475]: 修复了将注释转换为字符串时的杂项错误，并优化了字符串表示中的括号。

bpo-20104 [https://bugs.python.org/issue?@action=redirect&bpo=20104]: Added support for the setpgroup, resetids, setsigmask, setsigdef and scheduler parameters of posix_spawn. Patch by Pablo Galindo.

bpo-33391 [https://bugs.python.org/issue?@action=redirect&bpo=33391]: 修复了 set_symmetric_difference() 中的内存泄漏。

bpo-33363 [https://bugs.python.org/issue?@action=redirect&bpo=33363]: 对于异步函数外的 async with 和 async for 语句，现在会引发 SyntaxError。

bpo-28055 [https://bugs.python.org/issue?@action=redirect&bpo=28055]: 修复了 siphash24() 中的未对齐访问。由 Rolf Eike Beer 提供补丁。

bpo-33128 [https://bugs.python.org/issue?@action=redirect&bpo=33128]: 修复了一个导致 PathFinder 在 sys.meta_path 上出现两次的 bug。由 Pablo Galindo Salgado 提供补丁。

bpo-33331 [https://bugs.python.org/issue?@action=redirect&bpo=33331]: 现在在解释器关闭时，最后导入的模块会首先被清除。

bpo-33312 [https://bugs.python.org/issue?@action=redirect&bpo=33312]: 通过调整内部结构 _dictkeysobject 共享键结构的声明方式，修复了 dictobject.c 中的 clang ubsan（未定义行为消毒剂）警告。

bpo-33305 [https://bugs.python.org/issue?@action=redirect&bpo=33305]: 改进了无效数值字面量的语法错误提示信息。

bpo-33306 [https://bugs.python.org/issue?@action=redirect&bpo=33306]: 改进了不平衡括号的语法错误提示信息。

bpo-33234 [https://bugs.python.org/issue?@action=redirect&bpo=33234]: 当输入长度已知时，列表构造函数会预分配大小而不会过度分配。

bpo-33270 [https://bugs.python.org/issue?@action=redirect&bpo=33270]: 为所有匿名代码对象内部化名称。由Zackery Spytz提供补丁。

bpo-30455 [https://bugs.python.org/issue?@action=redirect&bpo=30455]: 现在，与令牌相关的C和Python代码以及文档都从一个单一源文件 Grammar/Tokens 生成。

bpo-33176 [https://bugs.python.org/issue?@action=redirect&bpo=33176]: 向memoryviews添加了一个 toreadonly() 方法。

bpo-33231 [https://bugs.python.org/issue?@action=redirect&bpo=33231]: 修复了 normalizestring() 中潜在的内存泄漏问题。

bpo-33205 [https://bugs.python.org/issue?@action=redirect&bpo=33205]: 将字典增长函数从 round_up_to_power_2(used*2+hashtable_size/2) 更改为 round_up_to_power_2(used*3)。 在之前版本中，字典仅在 used == 0 时才收缩。 现在字典有更多机会被收缩。

bpo-29922 [https://bugs.python.org/issue?@action=redirect&bpo=29922]: 改进了'async with'中当 __aenter__() 或 __aexit__() 返回不可等待对象时的错误消息。

bpo-33199 [https://bugs.python.org/issue?@action=redirect&bpo=33199]: 修复了在从键共享字典复制时，字典实现中的 ma_version_tag 未初始化的问题。

bpo-33053 [https://bugs.python.org/issue?@action=redirect&bpo=33053]: 当使用-m开关时，sys.path[0]现在明确扩展为 起始 工作目录，而不是保留为空路径（允许在导入时从当前工作目录导入）。

bpo-33138 [https://bugs.python.org/issue?@action=redirect&bpo=33138]: 更改了不可pickle和不可复制类型的标准错误消息。现在显示"cannot pickle"而不是"can't pickle"或"cannot serialize"。

bpo-33018 [https://bugs.python.org/issue?@action=redirect&bpo=33018]: 提高了当 issubclass() 的第一个参数是非类而第二个参数是抽象基类时引发错误的一致性。由Josh Bronson提供补丁。

bpo-33083 [https://bugs.python.org/issue?@action=redirect&bpo=33083]: math.factorial 不再接受非int-like的参数。由Pablo Galindo提供补丁。

bpo-33041 [https://bugs.python.org/issue?@action=redirect&bpo=33041]: 添加了新操作码 END_ASYNC_FOR 并修复了以下问题：

设置全局 StopAsyncIteration 不再破坏 async for 循环。

跳入一个 async for 循环现在被禁止了。

跳出一个 async for 循环不再会破坏堆栈了。

bpo-25750 [https://bugs.python.org/issue?@action=redirect&bpo=25750]: 修复了由于描述符从类中删除自身时`type_getattro()`中的引用计数错误导致的Python罕见崩溃。由Jeroen Demeyer提供补丁。

bpo-33041 [https://bugs.python.org/issue?@action=redirect&bpo=33041]: 修复了带有复杂目标的“async for”的字节码生成问题。现在，在赋值或解包时引发的StopAsyncIteration将被传播，而不是停止迭代。

bpo-33026 [https://bugs.python.org/issue?@action=redirect&bpo=33026]: 通过设置f_lineno修复了跳出“with”块的问题。

bpo-33005 [https://bugs.python.org/issue?@action=redirect&bpo=33005]: 修复了在使用自定义内存分配器（例如：使用PYTHONMALLOC环境变量）时fork导致的崩溃。_PyGILState_Reinit()和_PyInterpreterState_Enable()现在使用默认的RAW内存分配器在fork时分配新的解释器互斥锁。

bpo-32911 [https://bugs.python.org/issue?@action=redirect&bpo=32911]: 由于在下游beta测试期间发现的意外兼容性问题，恢复了 bpo-29463 [https://bugs.python.org/issue?@action=redirect&bpo=29463]。从Module、ClassDef、FunctionDef和AsyncFunctionDef ast节点中移除了在3.7a1中添加的`docstring` 字段。docstring表达式被恢复为其主体的第一条语句。基于Inada Naoki的补丁。

bpo-17288 [https://bugs.python.org/issue?@action=redirect&bpo=17288]: 防止从'return'和'exception'跟踪事件跳转。

bpo-32946 [https://bugs.python.org/issue?@action=redirect&bpo=32946]: 如果模块不是包，从已导入模块中使用“from ... import ...”导入名称现在快30%。

bpo-32932 [https://bugs.python.org/issue?@action=redirect&bpo=32932]: 当`__all__`中有非str对象时，使错误消息更加揭示问题。

bpo-32925 [https://bugs.python.org/issue?@action=redirect&bpo=32925]: 优化了对由非常量组成的字面列表的迭代和包含测试：x in [a, b]`和`for x in [a, b]。所有元素均为常量的情况已经被优化。

bpo-32889 [https://bugs.python.org/issue?@action=redirect&bpo=32889]: 更新Valgrind抑制列表，以考虑`Py_ADDRESS_IN_RANG`重命名为`address_in_range`的情况。

bpo-32836 [https://bugs.python.org/issue?@action=redirect&bpo=32836]: 在列表/字典/集合推导式的情况下不使用临时变量。

bpo-31356 [https://bugs.python.org/issue?@action=redirect&bpo=31356]: 移除了在 bpo-31356 [https://bugs.python.org/issue?@action=redirect&bpo=31356] 中添加的新API（gc.ensure_disabled()上下文管理器）。

bpo-32305 [https://bugs.python.org/issue?@action=redirect&bpo=32305]: 对于命名空间包，确保`__file__`和`__spec__.origin`都被设置为None。

bpo-32303 [https://bugs.python.org/issue?@action=redirect&bpo=32303]: 确保对于命名空间包，__spec__.loader 与 __loader__ 相匹配。

bpo-32711 [https://bugs.python.org/issue?@action=redirect&bpo=32711]: 修复 Python/ast_unparse.c 中的警告信息。由 Stéphane Wirtel 提供补丁。

bpo-32583 [https://bugs.python.org/issue?@action=redirect&bpo=32583]: 修复在使用自定义解码错误处理程序时，内置 Unicode 解码器可能因越界写入错误而崩溃的问题。

bpo-32489 [https://bugs.python.org/issue?@action=redirect&bpo=32489]: 现在允许在 finally 子句中使用 continue 语句。

bpo-17611 [https://bugs.python.org/issue?@action=redirect&bpo=17611]: 通过将展开块栈的逻辑移至编译器，简化了解释器循环。编译器现在会为调整值栈和调用 break、continue 及 return 的清理代码发出明确的指令。

移除了操作码 BREAK_LOOP、CONTINUE_LOOP、SETUP_LOOP 和 SETUP_EXCEPT。新增了操作码 ROT_FOUR、BEGIN_FINALLY、CALL_FINALLY 和 POP_FINALLY。改变了 END_FINALLY 和 WITH_CLEANUP_START 的行为。

bpo-32285 [https://bugs.python.org/issue?@action=redirect&bpo=32285]: 新增函数 unicodedata.is_normalized，可用于检查字符串是否符合特定的正规形式。

bpo-10544 [https://bugs.python.org/issue?@action=redirect&bpo=10544]: 现在禁止在推导式和生成器表达式中使用 yield 表达式，除了最外层可迭代对象的表达式。

bpo-32117 [https://bugs.python.org/issue?@action=redirect&bpo=32117]: 现在允许在 yield 和 return 语句中不加括号进行可迭代对象的解包，例如 yield 1, 2, 3, *rest。感谢 David Cuthbert 的更改和 Jordan Chapman 增加的测试。

bpo-31902 [https://bugs.python.org/issue?@action=redirect&bpo=31902]: 修复 ast 节点 ast.AsyncFor、ast.AsyncFunctionDef 和 ast.AsyncWith 的 col_offset 属性。之前，col_offset 指向 async 后的关键字。

bpo-25862 [https://bugs.python.org/issue?@action=redirect&bpo=25862]: 修复 io.TextIOWrapper 的 tell() 方法中的断言失败。由 Zackery Spytz 提供补丁。

bpo-21983 [https://bugs.python.org/issue?@action=redirect&bpo=21983]: Fix a crash in ctypes.cast() in case the type argument is a ctypes structured data type. Patch by Eryk Sun and Oren Milman.

bpo-31577 [https://bugs.python.org/issue?@action=redirect&bpo=31577]: Fix a crash in os.utime() in case of a bad ns argument. Patch by Oren Milman.

bpo-29832 [https://bugs.python.org/issue?@action=redirect&bpo=29832]: 从各种socket错误消息中移除对'getsockaddrarg'的引用。补丁由Oren Milman提供。

库

bpo-35845 [https://bugs.python.org/issue?@action=redirect&bpo=35845]: 向memoryview.tobytes()添加'order'参数。

bpo-35864 [https://bugs.python.org/issue?@action=redirect&bpo=35864]: collections.namedtuple的_asdict()方法现在返回一个常规的dict而不是OrderedDict。

bpo-35537 [https://bugs.python.org/issue?@action=redirect&bpo=35537]: 现在subprocess.Popen内部使用ExitStack来清理管道文件句柄。在正常操作中没有行为变化。但如果关闭一个句柄时引发异常，其他句柄现在会被关闭而不是泄露。（由Giampaolo Rodola提供补丁）

bpo-35847 [https://bugs.python.org/issue?@action=redirect&bpo=35847]: RISC-V需要CTYPES_PASS_BY_REF_HACK。修复了ctypes Structure的test_pass_by_value测试。

bpo-35813 [https://bugs.python.org/issue?@action=redirect&bpo=35813]: 向multiprocessing添加了共享内存子模块，以避免进程间需要序列化。

bpo-35780 [https://bugs.python.org/issue?@action=redirect&bpo=35780]: 修复在递归、可重入或多线程代码中出现的lru_cache()错误。这些错误可能导致孤儿链接和缓存被捕获在指定最大链接数更少的状态中。修复了负maxsize的处理，应该被当作零处理。修复了切换“满”状态标志时的错误。修复了遇到错误时链接的错误排序。同步了C代码和纯Python代码，针对具有单个位置参数的函数的空间节省路径。在这种常见情况下，lru缓存条目的空间开销减少了近一半。修复了缓存未命中的计数。在错误情况下，未命中计数与实际调用底层用户函数的次数不同步。

bpo-35537 [https://bugs.python.org/issue?@action=redirect&bpo=35537]: os.posix_spawn() 和 os.posix_spawnp() 现在有一个 setsid 参数。

bpo-23846 [https://bugs.python.org/issue?@action=redirect&bpo=23846]: asyncio.ProactorEventLoop 现在捕获并记录当自管道满时的发送错误。

bpo-34323 [https://bugs.python.org/issue?@action=redirect&bpo=34323]: asyncio: 增强 IocpProactor.close() 日志: 在第一次日志前等待1秒，然后每秒记录一次。同时记录自 close() 调用以来的秒数。

bpo-35674 [https://bugs.python.org/issue?@action=redirect&bpo=35674]: 新增 os.posix_spawnp() 函数。由 Joannah Nanjekye 提供补丁。

bpo-35733 [https://bugs.python.org/issue?@action=redirect&bpo=35733]: ast.Constant(boolean) 不再是 ast.Num 的实例。由 Anthony Sottile 提供补丁。

bpo-35726 [https://bugs.python.org/issue?@action=redirect&bpo=35726]: QueueHandler.prepare() 现在在修改和入队之前复制记录，以避免影响链中的其他处理程序。

bpo-35719 [https://bugs.python.org/issue?@action=redirect&bpo=35719]: 通过 1.3--2.5 倍加速了多参数 math 函数 atan2(), copysign(), remainder() 和 hypot()。

bpo-35717 [https://bugs.python.org/issue?@action=redirect&bpo=35717]: 修复了在使用枚举和编译时引发的 KeyError 异常。由 Rémi Lapeyre 提供补丁。

bpo-35699 [https://bugs.python.org/issue?@action=redirect&bpo=35699]: 修复了 distutils 中对 Visual Studio Build Tools 2017 的检测。

bpo-32710 [https://bugs.python.org/issue?@action=redirect&bpo=32710]: 修复了 asyncio ProactorEventLoop 在重叠操作失败时的内存泄漏。

bpo-35702 [https://bugs.python.org/issue?@action=redirect&bpo=35702]: The time.CLOCK_UPTIME_RAW constant is now available for macOS 10.12.

bpo-32710 [https://bugs.python.org/issue?@action=redirect&bpo=32710]: 修复了 asyncio 中 ProactorEventLoop 在 ReadFile() 或 WSASend() 重叠操作立即失败时的内存泄漏：释放内部缓冲区。

bpo-35682 [https://bugs.python.org/issue?@action=redirect&bpo=35682]: 修复 asyncio.ProactorEventLoop.sendfile(): 如果内部 future 已经完成，不再尝试设置其结果。

bpo-35283 [https://bugs.python.org/issue?@action=redirect&bpo=35283]: Add a deprecated warning for the threading.Thread.isAlive() method. Patch by Dong-hee Na.

bpo-35664 [https://bugs.python.org/issue?@action=redirect&bpo=35664]: 通过优化参数处理和为元组中单个非负整数索引的常见情况添加快速路径（这是标准库中的典型用例），将 operator.itemgetter() 的性能提高了 33%。

bpo-35643 [https://bugs.python.org/issue?@action=redirect&bpo=35643]: 修复了 Modules/_sha3/cleanup.py 中的 SyntaxWarning: 无效的转义序列。补丁由 Mickaël Schoentgen 提供。

bpo-35619 [https://bugs.python.org/issue?@action=redirect&bpo=35619]: 改进了 help() 和 pydoc 中对自定义数据描述符的支持。

bpo-28503 [https://bugs.python.org/issue?@action=redirect&bpo=28503]: The crypt module now internally uses the crypt_r() library function instead of crypt() when available.

bpo-35614 [https://bugs.python.org/issue?@action=redirect&bpo=35614]: 修复了 metaclasses 上的 help()。由 Sanyam Khurana 提供补丁。

bpo-35568 [https://bugs.python.org/issue?@action=redirect&bpo=35568]: Expose raise(signum) as raise_signal

bpo-35588 [https://bugs.python.org/issue?@action=redirect&bpo=35588]: fractions.Fraction 类型上的地板除法和模运算以及 divmod() 函数速度提高了 2--4 倍。由 Stefan Behnel 提供补丁。

bpo-35585 [https://bugs.python.org/issue?@action=redirect&bpo=35585]: 通过值构建枚举的速度提升，例如 http.HTTPStatus(200)。

bpo-30561 [https://bugs.python.org/issue?@action=redirect&bpo=30561]: random.gammavariate(1.0, beta) 现在计算的结果与 random.expovariate(1.0 / beta) 相同。这同步了两种算法并消除了旧实现中的一些特性。然而，它确实产生了与以前不同的随机变量流。

bpo-35537 [https://bugs.python.org/issue?@action=redirect&bpo=35537]: subprocess 模块现在在某些情况下可以使用 os.posix_spawn() 函数以获得更好的性能。

bpo-35526 [https://bugs.python.org/issue?@action=redirect&bpo=35526]: 将 barry_as_FLUFL.mandatory 的'笑话'延迟到 Python 4.0 版本

bpo-35523 [https://bugs.python.org/issue?@action=redirect&bpo=35523]: 移除 ctypes 回调的变通方法：不再在启动时创建回调。避免在 import ctypes 和 import uuid 时触发 SELinux 警报。

bpo-31784 [https://bugs.python.org/issue?@action=redirect&bpo=31784]: uuid.uuid1() 现在调用 time.time_ns() 而不是 int(time.time() * 1e9)。

bpo-35513 [https://bugs.python.org/issue?@action=redirect&bpo=35513]: unittest.runner 的 TextTestRunner 现在使用 time.perf_counter() 而不是 time.time() 来测量测试的执行时间：time.time() 可以倒退，而 time.perf_counter() 是单调的。

bpo-35502 [https://bugs.python.org/issue?@action=redirect&bpo=35502]: 修复了 xml.etree.ElementTree.TreeBuilder 在树构建未完成时（特别是解析 XML 时引发错误的情况下）的引用泄漏问题。

bpo-35348 [https://bugs.python.org/issue?@action=redirect&bpo=35348]: 使 platform.architecture() 解析 file 命令输出更加可靠：向 file 命令添加 -b 选项以省略文件名，强制使用 C 语言环境，并搜索“共享对象”模式。

bpo-35491 [https://bugs.python.org/issue?@action=redirect&bpo=35491]: multiprocessing: 添加 Pool.__repr__() 并增强 BaseProcess.__repr__() (添加 pid 和父 pid) 以便于调试。Pool 的状态常量值现在是字符串而不是整数，例如 RUN 值变为 'RUN' 而不是 0。

bpo-35477 [https://bugs.python.org/issue?@action=redirect&bpo=35477]: multiprocessing.Pool.__enter__() 现在在池未运行时失败：如果多次使用 with pool: 会失败。

bpo-31446 [https://bugs.python.org/issue?@action=redirect&bpo=31446]: 复制传递给 CreateProcessW 的命令行，因为此函数可以更改输入缓冲区的内容。

bpo-35471 [https://bugs.python.org/issue?@action=redirect&bpo=35471]: Python 2.4 放弃了对 MacOS 9 的支持。macpath 模块在 Python 3.7 中被弃用。该模块现已被移除。

bpo-23057 [https://bugs.python.org/issue?@action=redirect&bpo=23057]: 在 Windows 上接收到键盘中断时解除 Proactor 事件循环的阻塞。

bpo-35052 [https://bugs.python.org/issue?@action=redirect&bpo=35052]: 修复了 xml.dom.minidom 在带有实体的文档上的 cloneNode()：向实体的用户数据处理器传递正确的参数。

bpo-20239 [https://bugs.python.org/issue?@action=redirect&bpo=20239]: 允许重复分配删除 unittest.mock.Mock 属性。由 Pablo Galindo 提供补丁。

bpo-17185 [https://bugs.python.org/issue?@action=redirect&bpo=17185]: 在 mock 上设置 __signature__ 以便 inspect 获取签名。由 Karthikeyan Singaravelan 提供补丁。

bpo-35445 [https://bugs.python.org/issue?@action=redirect&bpo=35445]: 创建 posix.environ 时的内存错误不再被忽略。

bpo-35415 [https://bugs.python.org/issue?@action=redirect&bpo=35415]: 验证 socket.socket() 的 fileno= 参数。

bpo-35424 [https://bugs.python.org/issue?@action=redirect&bpo=35424]: multiprocessing.Pool 析构函数现在在池仍在运行时发出 ResourceWarning。

bpo-35330 [https://bugs.python.org/issue?@action=redirect&bpo=35330]: When a Mock instance was used to wrap an object, if side_effect is used in one of the mocks of it methods, don't call the original implementation and return the result of using the side effect the same way that it is done with return_value.

bpo-35346 [https://bugs.python.org/issue?@action=redirect&bpo=35346]: 从 platform 模块中删除对 Mac OS 9 和 Rhapsody 的支持。Rhapsody 的最后一个版本发布于 2000 年。Mac OS 9 的最后一个版本发布于 2001 年。

bpo-10496 [https://bugs.python.org/issue?@action=redirect&bpo=10496]: check_environ() of distutils.utils now catches KeyError on calling pwd.getpwuid(): don't create the HOME environment variable in this case.

bpo-10496 [https://bugs.python.org/issue?@action=redirect&bpo=10496]: posixpath.expanduser() 现在在 HOME 环境变量未设置且当前用户没有家目录（如果当前用户标识在密码数据库中不存在）时，返回输入的 path 不变。这一更改修复了 site 模块在当前用户在密码数据库中不存在（如果用户没有家目录）时的问题。

bpo-35389 [https://bugs.python.org/issue?@action=redirect&bpo=35389]: platform.libc_ver() 现在在可用且未设置 executable 参数时使用 os.confstr('CS_GNU_LIBC_VERSION')。

bpo-35394 [https://bugs.python.org/issue?@action=redirect&bpo=35394]: 向 asyncio 抽象协议添加空槽。

bpo-35310 [https://bugs.python.org/issue?@action=redirect&bpo=35310]: 修复 select.select() 中的一个错误，在某些情况下，文件描述符序列在信号中断后未修改返回，即使文件描述符可能尚未准备就绪。现在，如果发生超时，select.select() 将始终返回空列表。由 Oran Avraham 提供补丁。

bpo-35380 [https://bugs.python.org/issue?@action=redirect&bpo=35380]: 为 proactor asyncio 事件循环在 Windows 上启用 TCP_NODELAY。

bpo-35341 [https://bugs.python.org/issue?@action=redirect&bpo=35341]: 向 typing 模块添加 collections.OrderedDict 的通用版本。由 Ismo Toijala 提供补丁。

bpo-35371 [https://bugs.python.org/issue?@action=redirect&bpo=35371]: 修复了在 Windows 上传递不正确参数时 os.utime() 可能崩溃的问题。

bpo-35346 [https://bugs.python.org/issue?@action=redirect&bpo=35346]: platform.uname() 现在在运行外部程序（如 cmd /c ver）时将 stderr 重定向到 os.devnull。

bpo-35066 [https://bugs.python.org/issue?@action=redirect&bpo=35066]: 之前，在格式字符串中带有尾随 '%' 的 datetime 对象上调用 strftime() 方法会导致异常。然而，这仅在 datetime C 模块被使用时发生；Python 实现不匹配此行为。现在 datetime 符合 PEP-399，不会在尾随 '%' 上抛出异常。

bpo-35345 [https://bugs.python.org/issue?@action=redirect&bpo=35345]: The function platform.popen has been removed, it was deprecated since Python 3.3: use os.popen() instead.

bpo-35344 [https://bugs.python.org/issue?@action=redirect&bpo=35344]: 在 macOS 上，platform.platform() 现在使用 platform.mac_ver()，如果它返回一个非空的发布字符串，以获取 macOS 版本而非 darwin 版本。

bpo-35312 [https://bugs.python.org/issue?@action=redirect&bpo=35312]: 使 lib2to3.pgen2.parse.ParseError 可往返 pickle。由 Anthony Sottile 提供补丁。

bpo-35308 [https://bugs.python.org/issue?@action=redirect&bpo=35308]: 修复 webbrowser 中的回归问题，其中默认浏览器可能优先于 BROWSER 环境变量中的浏览器。

bpo-24746 [https://bugs.python.org/issue?@action=redirect&bpo=24746]: 避免在 doctest 花式差异中去除尾部空格。原始由 R. David Murray 和 Jairo Trad 提供补丁。由 Sanyam Khurana 增强。

bpo-28604 [https://bugs.python.org/issue?@action=redirect&bpo=28604]: locale.localeconv() 现在如果两个区域设置不同且货币字符串非 ASCII，会临时将 LC_CTYPE 区域设置改为 LC_MONETARY 区域设置。这一临时更改会影响其他线程。

bpo-35277 [https://bugs.python.org/issue?@action=redirect&bpo=35277]: 更新 ensurepip 以安装 pip 18.1 和 setuptools 40.6.2。

bpo-24209 [https://bugs.python.org/issue?@action=redirect&bpo=24209]: 直接调用 http.server 时增加 IPv6 支持。

bpo-35226 [https://bugs.python.org/issue?@action=redirect&bpo=35226]: 在测试 unittest.mock.call 对象相等性时递归检查参数，并添加说明，在 mock_calls 中追踪用于创建模拟祖先的参数是不可能的。

bpo-29564 [https://bugs.python.org/issue?@action=redirect&bpo=29564]: warnings 模块现在建议如果指定了源，tracemalloc 模块可用但 tracemalloc 未跟踪内存分配时启用 tracemalloc。

bpo-35189 [https://bugs.python.org/issue?@action=redirect&bpo=35189]: 修改以下 fnctl 函数，在信号中断 (EINTR) 时重试：flock, lockf, fnctl

bpo-30064 [https://bugs.python.org/issue?@action=redirect&bpo=30064]: 在 sock_* asyncio API 中使用 add_done_callback() 以在取消时早期取消订阅 reader/writer。

bpo-35186 [https://bugs.python.org/issue?@action=redirect&bpo=35186]: 移除当 setup.py upload 与 bdist_rpm 或 bdist_dumb 一起使用时添加的“built with”注释。

bpo-35152 [https://bugs.python.org/issue?@action=redirect&bpo=35152]: 允许在非 Windows 系统上的多进程连接中一次发送超过 2 GB 的数据。

bpo-35062 [https://bugs.python.org/issue?@action=redirect&bpo=35062]: Fix incorrect parsing of _io.IncrementalNewlineDecoder's translate argument.

bpo-35065 [https://bugs.python.org/issue?@action=redirect&bpo=35065]: Remove StreamReaderProtocol._untrack_reader. The call to _untrack_reader is currently performed too soon, causing the protocol to forget about the reader before connection_lost can run and feed the EOF to the reader.

bpo-34160 [https://bugs.python.org/issue?@action=redirect&bpo=34160]: ElementTree和minidom现在保留了用户指定的属性顺序。

bpo-35079 [https://bugs.python.org/issue?@action=redirect&bpo=35079]: 通过添加'non-overlapping'和将'!='改为'<'来改进difflib.SequenceManager.get_matching_blocks的文档。

bpo-33710 [https://bugs.python.org/issue?@action=redirect&bpo=33710]: 弃用了 gettext 模块中的 l*gettext() 函数和方法。它们返回编码的字节而不是Unicode字符串，是Python 2时代的产物。同时也弃用了与设置 l*gettext() 函数和方法字符集相关的函数和方法。

bpo-35017 [https://bugs.python.org/issue?@action=redirect&bpo=35017]: 现在，如果 :socketserver.BaseServer.serve_forever`的 shutdown() 方法在轮询新事件时被调用，它会立即退出。

bpo-35024 [https://bugs.python.org/issue?@action=redirect&bpo=35024]: importlib no longer logs wrote redundantly after (created|could not create) is already logged. Patch by Quentin Agren.

bpo-35047 [https://bugs.python.org/issue?@action=redirect&bpo=35047]: 现在，如果 assert_not_called、assert_called_once 或``assert_called_once_with``失败，``unittest.mock``会在异常消息中包含模拟调用。由Petter Strandmark提供的补丁。

bpo-31047 [https://bugs.python.org/issue?@action=redirect&bpo=31047]: 修复了 ntpath.abspath 在Windows上未移除尾部分隔符的回归问题。由Tim Graham提供的补丁。

bpo-35053 [https://bugs.python.org/issue?@action=redirect&bpo=35053]: tracemalloc现在尝试在对象从"自由列表"（用于更快创建对象的优化，例如内置列表类型使用）中重用时更新回溯。

bpo-31553 [https://bugs.python.org/issue?@action=redirect&bpo=31553]: 向json.tool添加了--json-lines选项。由hongweipeng提供的补丁。

bpo-34794 [https://bugs.python.org/issue?@action=redirect&bpo=34794]: 修复了在将Tcl_Obj的Python包装器传回Tcl/Tk时Tkinter中的泄漏问题。

bpo-34909 [https://bugs.python.org/issue?@action=redirect&bpo=34909]: 枚举：修复当父类与具体数据类型混合时子类的子类化问题。

bpo-35022 [https://bugs.python.org/issue?@action=redirect&bpo=35022]: unittest.mock.MagicMock 现在支持 __fspath__ 方法（来自 os.PathLike）。

bpo-35008 [https://bugs.python.org/issue?@action=redirect&bpo=35008]: 修复了在 C 实现中调用已初始化元素的 xml.etree.ElementTree.Element 的 __setstate__() 方法时的引用泄漏问题。

bpo-23420 [https://bugs.python.org/issue?@action=redirect&bpo=23420]: 验证 cProfile CLI 的 '-s' 参数的值。由 Robert Kuska 提供补丁。

bpo-33947 [https://bugs.python.org/issue?@action=redirect&bpo=33947]: 数据类现在可以处理递归 repr 而不会引发 RecursionError。

bpo-34890 [https://bugs.python.org/issue?@action=redirect&bpo=34890]: 使 inspect.iscoroutinefunction()、inspect.isgeneratorfunction() 和 inspect.isasyncgenfunction() 与 functools.partial() 一起工作。由 Pablo Galindo 提供补丁。

bpo-34521 [https://bugs.python.org/issue?@action=redirect&bpo=34521]: 使用 socket.CMSG_SPACE() 而不是 socket.CMSG_LEN() 在 multiprocessing.reduction.recvfds() 中计算辅助数据大小，因为 RFC 3542 [https://datatracker.ietf.org/doc/html/rfc3542.html] 要求便携式应用程序使用前者。

bpo-31522 [https://bugs.python.org/issue?@action=redirect&bpo=31522]: The mailbox.mbox.get_string function from_ parameter can now successfully be set to a non-default value.

bpo-34970 [https://bugs.python.org/issue?@action=redirect&bpo=34970]: 在 asyncio.all_tasks() 中保护任务弱集操作。

bpo-34969 [https://bugs.python.org/issue?@action=redirect&bpo=34969]: gzip：在 gzip CLI 上添加 --fast、--best 参数，这些参数将用于快速压缩方法（quick）或最佳压缩方法（较慢，但文件更小）。同时，将默认压缩级别更改为 6（折中）。

bpo-16965 [https://bugs.python.org/issue?@action=redirect&bpo=16965]: The 2to3 execfile fixer now opens the file with mode 'rb'. Patch by Zackery Spytz.

bpo-34966 [https://bugs.python.org/issue?@action=redirect&bpo=34966]: pydoc 现在不仅支持对最终类中定义的方法的别名，还支持对继承的方法的别名。文档字符串不会为别名重复。

bpo-34926 [https://bugs.python.org/issue?@action=redirect&bpo=34926]: mimetypes.MimeTypes.guess_type() 现在除了接受 URL 字符串外，还接受 path-like object。由 Mayank Asthana 提供补丁。

bpo-23831 [https://bugs.python.org/issue?@action=redirect&bpo=23831]: 向 tkinter.Canvas 小部件添加 moveto() 方法。由 Juliette Monsel 提供补丁。

bpo-34941 [https://bugs.python.org/issue?@action=redirect&bpo=34941]: xml.etree.ElementTree 模块中 Element 类的 find()、findtext() 和 findall() 方法现在能够查找 Element 子类实例的子元素。

bpo-32680 [https://bugs.python.org/issue?@action=redirect&bpo=32680]: smtplib.SMTP objects now always have a sock attribute present

bpo-34769 [https://bugs.python.org/issue?@action=redirect&bpo=34769]: 修复了当事件循环处于调试模式且垃圾收集器在另一个线程中运行时异步生成器未完成的问题。

bpo-34936 [https://bugs.python.org/issue?@action=redirect&bpo=34936]: 修复 tkinter.Spinbox.selection_element() 中的 TclError。由 Juliette Monsel 提供补丁。

bpo-34829 [https://bugs.python.org/issue?@action=redirect&bpo=34829]: 为了与 tkinter.Entry 组件保持一致，向 tkinter.Spinbox 添加了 selection_from、selection_range、selection_present 和 selection_to 方法。由 Juliette Monsel 提供补丁。

bpo-34911 [https://bugs.python.org/issue?@action=redirect&bpo=34911]: 向 http.cookiejar.DefaultCookiePolicy 添加了 secure_protocols 参数，以允许调整协议，并默认支持 wss*（安全的 websocket 协议）。

bpo-34922 [https://bugs.python.org/issue?@action=redirect&bpo=34922]: Fixed integer overflow in the digest() and hexdigest() methods for the SHAKE algorithm in the hashlib module.

bpo-34925 [https://bugs.python.org/issue?@action=redirect&bpo=34925]: bisect 模块中函数的参数解析速度提高了 25%。

bpo-34900 [https://bugs.python.org/issue?@action=redirect&bpo=34900]: 修复了 unittest.TestCase.debug() 在调用带有子测试的测试方法时的问题。由 Bruno Oliveira 提供补丁。

bpo-34844 [https://bugs.python.org/issue?@action=redirect&bpo=34844]: logging.Formatter 增强 - 确保 logging.Formatter 中的样式和 fmt 匹配 - 在每个格式样式类（StrFormatStyle、PercentStyle、StringTemplateStyle）中添加了 validate 方法。 - 此方法在 logging.Formatter 类的构造函数中调用 - 同时在每个样式类的 format 方法中重新引发 KeyError，以便更清楚地表明这是无效格式字段的错误。

bpo-34897 [https://bugs.python.org/issue?@action=redirect&bpo=34897]: 调整 test.support.missing_compiler_executable 检查，以便忽略名义命令名为 "" 的情况。由 Michael Felt 提供补丁。

bpo-34871 [https://bugs.python.org/issue?@action=redirect&bpo=34871]: 修复 inspect 模块在解析可调用对象的 __text_signature__ 时污染 sys.modules 的问题。

bpo-34898 [https://bugs.python.org/issue?@action=redirect&bpo=34898]: Add mtime argument to gzip.compress for reproducible output. Patch by Guo Ci Teo.

bpo-28441 [https://bugs.python.org/issue?@action=redirect&bpo=28441]: 在 Cygwin 和 MinGW 上，确保 sys.executable 始终包含路径中的完整文件名，包括 .exe 后缀（除非它是符号链接）。

bpo-34866 [https://bugs.python.org/issue?@action=redirect&bpo=34866]: 向 cgi.FieldStorage 添加 max_num_fields，通过限制 FieldStorage 创建的 MiniFieldStorage 对象数量来增加 DOS 攻击的难度。

bpo-34711 [https://bugs.python.org/issue?@action=redirect&bpo=34711]: http.server 确保当本地路径以 "/" 结尾且不是目录时报告 HTTPStatus.NOT_FOUND，即使底层操作系统（如 AIX）接受此类路径作为有效文件引用。由 Michael Felt 提交补丁。

bpo-34872 [https://bugs.python.org/issue?@action=redirect&bpo=34872]: 修复 asyncio.Task 的 C 实现中的自我取消问题。

bpo-34849 [https://bugs.python.org/issue?@action=redirect&bpo=34849]: 不在 asyncio 循环迭代中记录等待 selector.select。等待对于任何 asyncio 程序来说都是非常正常的，记录其时间只会给日志添加噪音而不提供任何有用信息。

bpo-34022 [https://bugs.python.org/issue?@action=redirect&bpo=34022]: 环境变量 SOURCE_DATE_EPOCH 不再覆盖 py_compile.compile() 的 invalidation_mode 参数的值，而是决定其默认值。

bpo-34819 [https://bugs.python.org/issue?@action=redirect&bpo=34819]: 在 Executor.map() 和 as_completed() 中使用单调时钟计算超时，以防止系统时钟调整时超时偏离。

bpo-34758 [https://bugs.python.org/issue?@action=redirect&bpo=34758]: 将 .wasm -> application/wasm 添加到识别的文件类型和内容类型头列表中。

bpo-34789 [https://bugs.python.org/issue?@action=redirect&bpo=34789]: xml.sax.make_parser() 现在接受任何可迭代对象作为其 parser_list 参数。由 Andrés Delfino 提交补丁。

bpo-34334 [https://bugs.python.org/issue?@action=redirect&bpo=34334]: In QueueHandler, clear exc_text from LogRecord to prevent traceback from being written twice.

bpo-34687 [https://bugs.python.org/issue?@action=redirect&bpo=34687]: 在 Windows 上，asyncio 现在默认使用 ProactorEventLoop，而不是 SelectorEventLoop。

bpo-5950 [https://bugs.python.org/issue?@action=redirect&bpo=5950]: 支持在 zipimport 中读取带有归档注释的 zip 文件。

bpo-32892 [https://bugs.python.org/issue?@action=redirect&bpo=32892]: 解析器现在将所有常量表示为 ast.Constant，而不是使用特定的常量 AST 类型（Num、Str、Bytes、NameConstant 和 Ellipsis）。这些类被视为已弃用，将在未来的 Python 版本中移除。

bpo-34728 [https://bugs.python.org/issue?@action=redirect&bpo=34728]: Add deprecation warning when loop is used in methods: asyncio.sleep, asyncio.wait and asyncio.wait_for.

bpo-34738 [https://bugs.python.org/issue?@action=redirect&bpo=34738]: ZIP files created by distutils will now include entries for directories.

bpo-34659 [https://bugs.python.org/issue?@action=redirect&bpo=34659]: 向 itertools.accumulate() 添加一个可选的 initial 参数。

bpo-29577 [https://bugs.python.org/issue?@action=redirect&bpo=29577]: 支持在创建 Enums 时使用多个混合类。

bpo-34670 [https://bugs.python.org/issue?@action=redirect&bpo=34670]: 为 TLS 1.3 的握手后认证功能添加 SSLContext.post_handshake_auth 和 SSLSocket.verify_client_post_handshake。

bpo-32718 [https://bugs.python.org/issue?@action=redirect&bpo=32718]: venv 的 Activate.ps1 脚本现在可以与 PowerShell Core 6.1 一起使用，并且在所有操作系统下都可用。

bpo-31177 [https://bugs.python.org/issue?@action=redirect&bpo=31177]: 修复了在使用 reset_mock 时，无法在删除属性的模拟实例上使用的问题。

bpo-34672 [https://bugs.python.org/issue?@action=redirect&bpo=34672]: 添加一个变通方法，使得在某些情况下，musl C 库上的 'Z' time.strftime() 说明符可以工作。

bpo-34666 [https://bugs.python.org/issue?@action=redirect&bpo=34666]: 实现 asyncio.StreamWriter.awrite 和 asyncio.StreamWriter.aclose() 协程。这些方法是为了提供一致的流 API，默认情况下开启控制流。

bpo-6721 [https://bugs.python.org/issue?@action=redirect&bpo=6721]: 在 fork() 过程中获取日志模块常用的内部锁，以避免子进程中的死锁。

bpo-34658 [https://bugs.python.org/issue?@action=redirect&bpo=34658]: 修复了一个罕见的解释器未处理异常状态 SystemError，仅在以下情况下出现：使用 subprocess 与 preexec_fn 同时，os.register_at_fork 注册了 after_parent 处理程序，并且 fork 系统调用失败。

bpo-34652 [https://bugs.python.org/issue?@action=redirect&bpo=34652]: 确保 os.lchmod() 永远不会在 Linux 上定义。

bpo-34638 [https://bugs.python.org/issue?@action=redirect&bpo=34638]: 存储对流读取器的弱引用，以打破读取器和协议之间的强引用循环。这允许在流被删除（垃圾回收）而未调用 close() 时检测并关闭套接字。

bpo-34536 [https://bugs.python.org/issue?@action=redirect&bpo=34536]: Enum._missing_: raise ValueError if None returned and TypeError if non-member is returned.

bpo-34636 [https://bugs.python.org/issue?@action=redirect&bpo=34636]: 加快对字节对象中s w和d的多次不匹配字符的重新扫描。（微优化）

bpo-24412 [https://bugs.python.org/issue?@action=redirect&bpo=24412]: Add addModuleCleanup() and addClassCleanup() to unittest to support cleanups for setUpModule() and setUpClass(). Patch by Lisa Roach.

bpo-34630 [https://bugs.python.org/issue?@action=redirect&bpo=34630]: 不在asyncio代码中记录SSL证书错误（连接错误记录已被跳过）。

bpo-32490 [https://bugs.python.org/issue?@action=redirect&bpo=32490]: 防止在 subprocess 异常消息中文件名重复。由Zackery Spytz提供补丁。

bpo-34363 [https://bugs.python.org/issue?@action=redirect&bpo=34363]: dataclasses.asdict()和.astuple()现在能正确处理命名元组。

bpo-34625 [https://bugs.python.org/issue?@action=redirect&bpo=34625]: 更新供应商化的expat库版本至2.2.6。

bpo-32270 [https://bugs.python.org/issue?@action=redirect&bpo=32270]: subprocess模块不再错误地关闭被重定向的文件描述符，即使它们在pass_fds中且不在默认的{0, 1, 2}集合内。

bpo-34622 [https://bugs.python.org/issue?@action=redirect&bpo=34622]: 创建专用的 asyncio.CancelledError、asyncio.InvalidStateError 和``asyncio.TimeoutError``异常类。使它们继承自 concurrent.futures 包中对应的异常。将``asyncio``异常提取到一个单独的文件中。

bpo-34610 [https://bugs.python.org/issue?@action=redirect&bpo=34610]: 修复了 multiprocessing.managers.DictProxy 的迭代器。

bpo-34421 [https://bugs.python.org/issue?@action=redirect&bpo=34421]: 修复distutils对非ASCII字符串的日志记录。这曾导致Windows上的安装问题。

bpo-34604 [https://bugs.python.org/issue?@action=redirect&bpo=34604]: Fix possible mojibake in the error message of pwd.getpwnam and grp.getgrnam using string representation because of invisible characters or trailing whitespaces. Patch by William Grzybowski.

bpo-30977 [https://bugs.python.org/issue?@action=redirect&bpo=30977]: 使uuid.UUID使用 __slots__ 以减少其内存占用。基于Wouter Bolsterlee的原始补丁。

bpo-34574 [https://bugs.python.org/issue?@action=redirect&bpo=34574]: OrderedDict迭代器在pickling时不再耗尽。由Sergey Fedoseev提供补丁。

bpo-8110 [https://bugs.python.org/issue?@action=redirect&bpo=8110]: 重构 subprocess 以检查Windows特定模块，而非``sys.platform == 'win32'``。

bpo-34530 [https://bugs.python.org/issue?@action=redirect&bpo=34530]: distutils.spawn.find_executable() 现在在没有设置 PATH 环境变量时回退到 os.defpath。

bpo-34563 [https://bugs.python.org/issue?@action=redirect&bpo=34563]: 在Windows上，修复multiprocessing.Connection对于非常大的读取的修复：修复_winapi.PeekNamedPipe()和_winapi.ReadFile()对于大于INT_MAX（通常是 2**31-1）的读取。

bpo-34558 [https://bugs.python.org/issue?@action=redirect&bpo=34558]: 修正Lib/ctypes/_aix.py中的拼写错误。

bpo-34282 [https://bugs.python.org/issue?@action=redirect&bpo=34282]: 将 Enum._convert 移动到 EnumMeta._convert_ 并修复枚举成员被父属性遮蔽的问题。

bpo-22872 [https://bugs.python.org/issue?@action=redirect&bpo=22872]: 当队列关闭时，multiprocessing.Queue.put() 和 multiprocessing.Queue.get() 现在分别抛出 ValueError 而不是 AssertionError 和 OSError。由Zackery Spytz提供补丁。

bpo-34515 [https://bugs.python.org/issue?@action=redirect&bpo=34515]: Fix parsing non-ASCII identifiers in lib2to3.pgen2.tokenize (PEP 3131).

bpo-13312 [https://bugs.python.org/issue?@action=redirect&bpo=13312]: 避免时间模块的年处理代码在传递非常低的负年值时可能出现的整数下溢（未定义行为）。

bpo-34472 [https://bugs.python.org/issue?@action=redirect&bpo=34472]: 提高 zipfile 中流式文件的兼容性。之前未写入可选签名，不支持某些ZIP应用程序。由Silas Sewell提供补丁。

bpo-34454 [https://bugs.python.org/issue?@action=redirect&bpo=34454]: 修复datetime类型的.fromisoformat()方法在给定非UTF-8可编码的Unicode时崩溃的问题。具体来说，datetime.fromisoformat()现在接受用作分隔符的代理Unicode码点。报告和测试由Alexey Izbyshev提供，由Paul Ganssle提供补丁。

bpo-6700 [https://bugs.python.org/issue?@action=redirect&bpo=6700]: 修复inspect.getsourcelines对于模块级别的帧/回溯的问题。由Vladimir Matveev提供补丁。

bpo-34171 [https://bugs.python.org/issue?@action=redirect&bpo=34171]: 运行 trace 模块不再创建 trace.cover 文件。

bpo-34441 [https://bugs.python.org/issue?@action=redirect&bpo=34441]: Fix crash when an ABC-derived class with invalid __subclasses__ is passed as the second argument to issubclass(). Patch by Alexey Izbyshev.

bpo-34427 [https://bugs.python.org/issue?@action=redirect&bpo=34427]: 修复 MutableSequence 子类中 a.extend(a) 导致的无限循环问题。

bpo-34412 [https://bugs.python.org/issue?@action=redirect&bpo=34412]: 使 signal.strsignal() 在 HP-UX 上工作。由 Michael Osipov 提供补丁。

bpo-20849 [https://bugs.python.org/issue?@action=redirect&bpo=20849]: shutil.copytree 现在接受一个新的 dirs_exist_ok 关键字参数。由 Josh Bronson 提供补丁。

bpo-31715 [https://bugs.python.org/issue?@action=redirect&bpo=31715]: 将 .mjs 文件扩展名与 application/javascript MIME 类型关联。

bpo-34384 [https://bugs.python.org/issue?@action=redirect&bpo=34384]: os.readlink() 现在在 Windows 上接受 路径类 和 bytes 对象。

bpo-22602 [https://bugs.python.org/issue?@action=redirect&bpo=22602]: UTF-7 解码器现在对以 "+" 开头的不良序列（如 RFC 2152 中指定）引发 UnicodeDecodeError。由 Zackery Spytz 提供补丁。

bpo-2122 [https://bugs.python.org/issue?@action=redirect&bpo=2122]: mmap.flush() 方法现在在成功时返回 None，在所有平台上的错误时引发异常。

bpo-34341 [https://bugs.python.org/issue?@action=redirect&bpo=34341]: 使用 ZIP64 扩展附加到 ZIP 存档不再增加现有条目的额外字段的大小。

bpo-34333 [https://bugs.python.org/issue?@action=redirect&bpo=34333]: 修复 pathlib.PurePath.with_suffix() 中格式化错误消息时的 %-格式化问题。

bpo-18540 [https://bugs.python.org/issue?@action=redirect&bpo=18540]: imaplib.IMAP4 和 imaplib.IMAP4_SSL 类现在在使用 host 参数的默认值（''）时正确解析到本地主机 IP。

bpo-26502 [https://bugs.python.org/issue?@action=redirect&bpo=26502]: 实现 traceback.FrameSummary.__len__() 方法以保持与旧元组 API 的兼容性。

bpo-34318 [https://bugs.python.org/issue?@action=redirect&bpo=34318]: assertRaises(), assertRaisesRegex(), assertWarns() 和 assertWarnsRegex() 如果传递的可调用对象为 None 则不再成功。它们在上下文管理器模式下不再忽略未知关键字参数。自 Python 3.5 以来，在这些情况下会引发 DeprecationWarning。

bpo-9372 [https://bugs.python.org/issue?@action=redirect&bpo=9372]: Deprecate __getitem__() methods of xml.dom.pulldom.DOMEventStream, wsgiref.util.FileWrapper and fileinput.FileInput.

bpo-33613 [https://bugs.python.org/issue?@action=redirect&bpo=33613]: 修复 multiprocessing.semaphore_tracker 中的竞态条件，该条件发生在追踪器接收到 SIGINT 信号但尚未注册信号处理程序以忽略它之前。

bpo-34248 [https://bugs.python.org/issue?@action=redirect&bpo=34248]: 当由于操作系统相关错误 dbm.gnu.open() 和 dbm.ndbm.open() 无法打开数据库文件时，在引发的异常中报告文件名。由 Zsolt Cserna 提供补丁。

bpo-33089 [https://bugs.python.org/issue?@action=redirect&bpo=33089]: 添加 math.dist() 以计算两点之间的欧几里得距离。

bpo-34246 [https://bugs.python.org/issue?@action=redirect&bpo=34246]: smtplib.SMTP.send_message() 不再修改 mail_options 参数的内容。补丁由 Pablo S. Blum de Aguiar 提供。

bpo-31047 [https://bugs.python.org/issue?@action=redirect&bpo=31047]: 修复 Windows 上无效路径的 ntpath.abspath。由 Franz Woellert 提供补丁。

bpo-32321 [https://bugs.python.org/issue?@action=redirect&bpo=32321]: 为 functools.reduce 添加纯 Python 回退。由 Robert Wright 提供补丁。

bpo-34270 [https://bugs.python.org/issue?@action=redirect&bpo=34270]: The default asyncio task class now always has a name which can be get or set using two new methods (get_name() and set_name()) and is visible in the repr() output. An initial name can also be set using the new name keyword argument to asyncio.create_task() or the create_task() method of the event loop. If no initial name is set, the default Task implementation generates a name like Task-1 using a monotonic counter.

bpo-34263 [https://bugs.python.org/issue?@action=redirect&bpo=34263]: asyncio 的事件循环不会将超过一天的超时传递给 epoll/select 等。

bpo-34035 [https://bugs.python.org/issue?@action=redirect&bpo=34035]: 修复 zipfile seek() 方法中的几个 AttributeError。由 Mickaël Schoentgen 提供补丁。

bpo-32215 [https://bugs.python.org/issue?@action=redirect&bpo=32215]: 修复 sqlite3 中的性能回归，当 DML 语句出现在 SQL 查询的其余部分不同行时。

bpo-34075 [https://bugs.python.org/issue?@action=redirect&bpo=34075]: 弃用将非 ThreadPoolExecutor 实例传递给 AbstractEventLoop.set_default_executor()。

bpo-34251 [https://bugs.python.org/issue?@action=redirect&bpo=34251]: Restore msilib.Win64 to preserve backwards compatibility since it's already used by distutils' bdist_msi command.

bpo-19891 [https://bugs.python.org/issue?@action=redirect&bpo=19891]: 在交互式会话退出时写入历史记录时，忽略由于主目录缺失或不可写导致的错误。补丁由 Anthony Sottile 提供。

bpo-33089 [https://bugs.python.org/issue?@action=redirect&bpo=33089]: 增强了 math.hypot() 以支持超过两个维度。

bpo-34228 [https://bugs.python.org/issue?@action=redirect&bpo=34228]: tracemalloc: PYTHONTRACEMALLOC=0 环境变量和 -X tracemalloc=0 命令行选项现在可以用来在启动时显式禁用 tracemalloc。

bpo-13041 [https://bugs.python.org/issue?@action=redirect&bpo=13041]: 使用 shutil.get_terminal_size() 在 argparse.HelpFormatter 类中正确计算终端宽度。初始由 Zbyszek Jędrzejewski-Szmek 提供补丁。

bpo-34213 [https://bugs.python.org/issue?@action=redirect&bpo=34213]: 允许冻结的数据类有一个名为“object”的字段。之前这与内部使用的“object”冲突。

bpo-34052 [https://bugs.python.org/issue?@action=redirect&bpo=34052]: sqlite3.Connection.create_aggregate(), sqlite3.Connection.create_function(), sqlite3.Connection.set_authorizer(), sqlite3.Connection.set_progress_handler() 方法在传递不可哈希对象作为可调用对象时抛出 TypeError。这些方法现在不会将这样的对象传递给 SQLite API。之前的行为可能导致段错误。由 Sergey Fedoseev 提供补丁。

bpo-34197 [https://bugs.python.org/issue?@action=redirect&bpo=34197]: csv 读取器的 dialect 属性的 skipinitialspace, doublequote 和 strict 属性现在是 bool 实例，而不是整数 0 或 1。

bpo-32788 [https://bugs.python.org/issue?@action=redirect&bpo=32788]: 在 sqlite3 模块中的 __adapt__() 和 __conform__() 方法中引发的除 TypeError 以外的错误现在会传播给用户。

bpo-21446 [https://bugs.python.org/issue?@action=redirect&bpo=21446]: The reload fixer now uses importlib.reload() instead of deprecated imp.reload().

bpo-940286 [https://bugs.python.org/issue?@action=redirect&bpo=940286]: pydoc 的 Helper.showtopic() 方法现在正确打印主题的交叉引用。

bpo-34164 [https://bugs.python.org/issue?@action=redirect&bpo=34164]: base64.b32decode() 可能会因错误的填充引发 UnboundLocalError 或 OverflowError。现在在这些情况下总是引发 base64.Error。

bpo-33729 [https://bugs.python.org/issue?@action=redirect&bpo=33729]: 修复了 hashlib 中参数解析的问题。

bpo-34097 [https://bugs.python.org/issue?@action=redirect&bpo=34097]: ZipFile 现在可以通过新的 strict_timestamps 参数压缩早于 1980-01-01 和晚于 2107-12-31 的文件，代价是将时间戳设置为限制值。

bpo-34108 [https://bugs.python.org/issue?@action=redirect&bpo=34108]: 在 2to3 重构中移除了多余的 CR。

bpo-34070 [https://bugs.python.org/issue?@action=redirect&bpo=34070]: 确保在打开文件时 buffering=-1 的情况下，仅检查句柄是否为 tty。

bpo-27494 [https://bugs.python.org/issue?@action=redirect&bpo=27494]: 恢复了 bpo-27494 [https://bugs.python.org/issue?@action=redirect&bpo=27494]。2to3 现在拒绝在生成器表达式中使用尾随逗号。

bpo-33967 [https://bugs.python.org/issue?@action=redirect&bpo=33967]: functools.singledispatch 现在在没有传递位置参数时抛出 TypeError 而不是 IndexError。

bpo-34041 [https://bugs.python.org/issue?@action=redirect&bpo=34041]: 向 sqlite3.Connection.create_function() 方法添加了 deterministic 参数。由 Sergey Fedoseev 提供补丁。

bpo-34056 [https://bugs.python.org/issue?@action=redirect&bpo=34056]: 确保由 imp.load_module 创建的加载器 shim 总是从其 get_data() 函数返回字节。这修复了 imp.load_module 与基于 PEP 552 [https://www.python.org/dev/peps/pep-0552] 哈希的 pycs 一起使用的问题。

bpo-34054 [https://bugs.python.org/issue?@action=redirect&bpo=34054]: multiprocessing 模块现在使用单调时钟 time.monotonic() 而不是系统时钟 time.time() 来实现超时。

bpo-34043 [https://bugs.python.org/issue?@action=redirect&bpo=34043]: 当使用 gzip 时，优化 tarfile 解压性能约 15%。

bpo-34044 [https://bugs.python.org/issue?@action=redirect&bpo=34044]: subprocess.Popen 现在复制 startupinfo 参数以保持其不变：它将修改副本，因此同一个 STARTUPINFO 对象可以被多次使用。

bpo-34010 [https://bugs.python.org/issue?@action=redirect&bpo=34010]: 修复了使用 tarfile 读取流时的性能回归。缓冲读取应使用列表，而不是追加到字节对象。

bpo-34019 [https://bugs.python.org/issue?@action=redirect&bpo=34019]: webbrowser: 使用 webbrowser 模块打开新 URL 时，正确传递参数给 Opera 浏览器。由 Bumsik Kim 提供补丁。

bpo-34003 [https://bugs.python.org/issue?@action=redirect&bpo=34003]: csv.DictReader 现在创建 dicts 而不是 OrderedDicts。补丁由 Michael Selik 提供。

bpo-33978 [https://bugs.python.org/issue?@action=redirect&bpo=33978]: 在通过 fileConfig 和 dictConfig 重新配置之前关闭现有的日志处理程序。补丁由 Karthikeyan Singaravelan 提供。

bpo-14117 [https://bugs.python.org/issue?@action=redirect&bpo=14117]: 对turtledemo进行小幅调整。'wikipedia'示例现更名为'rosette'，以更准确描述其绘制内容。'penrose'的打印输出已减少。'tree'的'1024'输出已被移除。

bpo-33974 [https://bugs.python.org/issue?@action=redirect&bpo=33974]: 修复了将包含特殊字符 ", \, {, } 和 \n 的字符串列表或元组作为选项传递给 ttk 部件的问题。

bpo-27500 [https://bugs.python.org/issue?@action=redirect&bpo=27500]: 修复getaddrinfo以正确解析IPv6地址。

bpo-24567 [https://bugs.python.org/issue?@action=redirect&bpo=24567]: 改进random.choices()以处理偶尔会触发IndexError的次正规输入权重。

bpo-33871 [https://bugs.python.org/issue?@action=redirect&bpo=33871]: 修复了 os.readv(), os.writev(), os.preadv() 和 os.pwritev() 以及 os.sendfile() (在基于BSD的操作系统和macOS上，带有 headers 或 trailers 参数时) 中的整数溢出问题。

bpo-25007 [https://bugs.python.org/issue?@action=redirect&bpo=25007]: 为zlib压缩器和解压缩器添加 copy.copy() 和 copy.deepcopy() 支持。补丁由Zackery Spytz提供。

bpo-33929 [https://bugs.python.org/issue?@action=redirect&bpo=33929]: 多进程处理：修复了multiprocessing.popen_spawn_win32中Popen的一个竞态条件。子进程现在复制管道的读取端而不是“窃取”它。之前，子进程会“窃取”管道的读取端，但如果子进程在从父进程窃取句柄之前被终止，则会泄漏一个句柄。

bpo-33899 [https://bugs.python.org/issue?@action=redirect&bpo=33899]: Tokenize模块现在在提供的输入没有尾随换行符时隐式发出NEWLINE。此行为现在与C tokenizer内部的行为匹配。由Ammar Askar贡献。

bpo-33897 [https://bugs.python.org/issue?@action=redirect&bpo=33897]: 向logging.basicConfig()添加了一个'force'关键字参数。

bpo-33695 [https://bugs.python.org/issue?@action=redirect&bpo=33695]: shutil.copytree() 使用 os.scandir() 函数以及所有依赖于它的复制函数都使用了缓存的 os.stat() 值。在Linux上复制一个包含8000个文件的目录时，速度提升约+9%，在Windows上约+20%，在Windows SMB共享上约+30%。同时，os.stat() 系统调用的次数减少了38%，使得 shutil.copytree() 在网络文件系统上特别快。（由Giampaolo Rodola'在 bpo-33695 [https://bugs.python.org/issue?@action=redirect&bpo=33695] 中贡献。）

bpo-33916 [https://bugs.python.org/issue?@action=redirect&bpo=33916]: bz2和lzma：当Decompressor.__init__()被调用两次时，释放旧的锁以防止内存泄漏。

bpo-32568 [https://bugs.python.org/issue?@action=redirect&bpo=32568]: 使select.epoll()及其文档在 sizehint 和 flags 方面保持一致。

bpo-33833 [https://bugs.python.org/issue?@action=redirect&bpo=33833]: 修复了asyncio中的一个bug，该bug导致ProactorSocketTransport在写操作期间强制关闭时会记录AssertionError。

bpo-33663 [https://bugs.python.org/issue?@action=redirect&bpo=33663]: 在将内容长度放入头部之前，将其转换为字符串。

bpo-33721 [https://bugs.python.org/issue?@action=redirect&bpo=33721]: os.path functions that return a boolean result like exists(), lexists(), isdir(), isfile(), islink(), and ismount(), and pathlib.Path methods that return a boolean result like exists(), is_dir(), is_file(), is_mount(), is_symlink(), is_block_device(), is_char_device(), is_fifo(), is_socket() now return False instead of raising ValueError or its subclasses UnicodeEncodeError and UnicodeDecodeError for paths that contain characters or bytes unrepresentable at the OS level.

bpo-26544 [https://bugs.python.org/issue?@action=redirect&bpo=26544]: 修正了 platform.libc_ver() 的实现。它几乎总是为glibc返回版本'2.9'。

bpo-33843 [https://bugs.python.org/issue?@action=redirect&bpo=33843]: 移除了已弃用的 cgi.escape, cgi.parse_qs 和 cgi.parse_qsl。

bpo-33842 [https://bugs.python.org/issue?@action=redirect&bpo=33842]: 移除了自Python 3.3以来已弃用的 tarfile.filemode。

bpo-30167 [https://bugs.python.org/issue?@action=redirect&bpo=30167]: 如果设置了PYTHONSTARTUP，防止site.main()异常。由Steve Weber提供补丁。

bpo-33805 [https://bugs.python.org/issue?@action=redirect&bpo=33805]: 当未指定InitVar时，改进dataclasses.replace()的错误消息

bpo-33687 [https://bugs.python.org/issue?@action=redirect&bpo=33687]: 如果给定或解码了模式，修复 uu.decode() 对 os.chmod() 的调用。由Timo Furrer提供补丁。

bpo-33812 [https://bugs.python.org/issue?@action=redirect&bpo=33812]: 对于tzinfo非None但d.tzinfo.utcoffset(d)返回None的Datetime实例d，现在astimezone()方法将其视为naive。

bpo-32108 [https://bugs.python.org/issue?@action=redirect&bpo=32108]: 在configparser中，当节被分配给自己时不清除它。

bpo-27397 [https://bugs.python.org/issue?@action=redirect&bpo=27397]: 使email模块正确处理长度无效的base64字符串。

bpo-33578 [https://bugs.python.org/issue?@action=redirect&bpo=33578]: 实现多字节编码器/解码器状态方法

bpo-30805 [https://bugs.python.org/issue?@action=redirect&bpo=30805]: 避免调试日志记录中的竞态条件

bpo-33476 [https://bugs.python.org/issue?@action=redirect&bpo=33476]: 当地址组缺少最后的';'时，修复_header_value_parser.py。由Enrique Perez-Terron贡献

bpo-33694 [https://bugs.python.org/issue?@action=redirect&bpo=33694]: asyncio: 修复在使用ProactorEventLoop时，pause_reading()/resume_reading()导致数据丢失的竞态条件。

bpo-32493 [https://bugs.python.org/issue?@action=redirect&bpo=32493]: 在 configure.ac 中更正对 uuid_enc_be 可用性的测试。由Michael Felt提供补丁。

bpo-33792 [https://bugs.python.org/issue?@action=redirect&bpo=33792]: 添加asyncio.WindowsSelectorEventLoopPolicy和asyncio.WindowsProactorEventLoopPolicy。

bpo-33274 [https://bugs.python.org/issue?@action=redirect&bpo=33274]: W3C DOM Level 1指定Element.removeAttributeNode()的返回值为"The Attr node that was removed." xml.dom.minidom现在符合这一要求。

bpo-33778 [https://bugs.python.org/issue?@action=redirect&bpo=33778]: 更新 unicodedata 的数据库至Unicode版本11.0.0。

bpo-33165 [https://bugs.python.org/issue?@action=redirect&bpo=33165]: 为日志记录调用添加了stacklevel参数，以允许使用包装器/辅助函数进行日志记录API的调用。

bpo-33770 [https://bugs.python.org/issue?@action=redirect&bpo=33770]: 针对长度无效的编码输入，改进base64异常消息

bpo-33769 [https://bugs.python.org/issue?@action=redirect&bpo=33769]: asyncio/start_tls: 修复错误消息；在未处理错误的情况下取消回调；如果SSLTransport被中止，则标记为已关闭。

bpo-33767 [https://bugs.python.org/issue?@action=redirect&bpo=33767]: 在 mmap.mmap 对象上执行时，连接（+）和重复（*）序列操作现在会引发 TypeError 而不是 SystemError。由 Zackery Spytz 提供补丁。

bpo-33734 [https://bugs.python.org/issue?@action=redirect&bpo=33734]: asyncio/ssl：修复 AttributeError，增加默认的握手超时时间

bpo-31014 [https://bugs.python.org/issue?@action=redirect&bpo=31014]: 修复了当用户在 BROWSER 环境变量中指定条目路径时为 webbrowser 创建控制器的问题。基于 John Still 的补丁。

bpo-2504 [https://bugs.python.org/issue?@action=redirect&bpo=2504]: 添加 gettext.pgettext() 及其变体。

bpo-33197 [https://bugs.python.org/issue?@action=redirect&bpo=33197]: 为 _ParameterKind 添加描述属性

bpo-32751 [https://bugs.python.org/issue?@action=redirect&bpo=32751]: 当由于超时取消任务时，asyncio.wait_for() 现在将等待直到取消完成。

bpo-32684 [https://bugs.python.org/issue?@action=redirect&bpo=32684]: 修复 gather 即使在 return_exceptions 的情况下也能传播自身的取消。

bpo-33654 [https://bugs.python.org/issue?@action=redirect&bpo=33654]: 在 SSLTransport.set_protocol() 中支持协议类型切换。

bpo-33674 [https://bugs.python.org/issue?@action=redirect&bpo=33674]: 尽早暂停传输，以进一步降低在 connection_made() 之前调用 data_received() 的风险。

bpo-33671 [https://bugs.python.org/issue?@action=redirect&bpo=33671]: shutil.copyfile()、shutil.copy()、shutil.copy2()、shutil.copytree() 和 shutil.move() 在 Linux 和 macOS 上使用平台特定的快速复制系统调用，以更高效地复制文件。在 Windows 上，shutil.copyfile() 使用更大的默认缓冲区大小（1 MiB 而不是 16 KiB），并且使用了基于 memoryview() 的 shutil.copyfileobj() 变体。复制 512MiB 文件的速度在 Linux 上提高了约 +26%，在 macOS 上提高了 +50%，在 Windows 上提高了 +40%。同时，消耗的 CPU 周期大大减少。（由 Giampaolo Rodola' 在 bpo-25427 [https://bugs.python.org/issue?@action=redirect&bpo=25427] 中贡献。）

bpo-33674 [https://bugs.python.org/issue?@action=redirect&bpo=33674]: 修复 asyncio.sslproto 中 SSLProtocol.connection_made() 的竞态条件：立即开始握手而不是使用 call_soon()。之前，data_received() 可能在握手开始前被调用，导致握手挂起或失败。

bpo-31647 [https://bugs.python.org/issue?@action=redirect&bpo=31647]: 修复了在 _SelectorSocketTransport 已经关闭后调用 write_eof() 会引发 AttributeError 的错误。

bpo-32610 [https://bugs.python.org/issue?@action=redirect&bpo=32610]: 使 asyncio.all_tasks() 仅返回待处理的任务。

bpo-32410 [https://bugs.python.org/issue?@action=redirect&bpo=32410]: 在 sendfile 回退代码中避免阻塞文件 IO。

bpo-33469 [https://bugs.python.org/issue?@action=redirect&bpo=33469]: 修复了使用 run_in_executor 后关闭循环时引发的 RuntimeError。

bpo-33672 [https://bugs.python.org/issue?@action=redirect&bpo=33672]: 修复 Task.__repr__ 与 Cython 的虚假协程一起使用时崩溃的问题。

bpo-33654 [https://bugs.python.org/issue?@action=redirect&bpo=33654]: 修复 transport.set_protocol() 以支持在 asyncio.Protocol 和 asyncio.BufferedProtocol 之间切换。修复 loop.start_tls() 以支持 asyncio.BufferedProtocols。

bpo-33652 [https://bugs.python.org/issue?@action=redirect&bpo=33652]: 类型变量和下标泛型的 pickle 现在具有未来兼容性，并与旧版 Python 兼容。

bpo-32493 [https://bugs.python.org/issue?@action=redirect&bpo=32493]: 修复了 FreeBSD 上的 uuid.uuid1()。

bpo-33238 [https://bugs.python.org/issue?@action=redirect&bpo=33238]: 将 InvalidStateError 添加到 concurrent.futures。如果 futures 不是待处理或运行状态，Future.set_result 和 Future.set_exception 现在会引发 InvalidStateError。由 Jason Haydaman 提供补丁。

bpo-33618 [https://bugs.python.org/issue?@action=redirect&bpo=33618]: 完成并记录与 OpenSSL 1.1.1 的初步和实验性 TLS 1.3 支持。

bpo-33625 [https://bugs.python.org/issue?@action=redirect&bpo=33625]: Release GIL on grp.getgrnam, grp.getgrgid, pwd.getpwnam and pwd.getpwuid if reentrant variants of these functions are available. Patch by William Grzybowski.

bpo-33623 [https://bugs.python.org/issue?@action=redirect&bpo=33623]: 修复在 __del__ 中创建 asyncio.Future 时可能出现的 SIGSGV。

bpo-11874 [https://bugs.python.org/issue?@action=redirect&bpo=11874]: 当将用法分解为可包装部分时使用更好的正则表达式。避免来自自定义 metavar 字符串的错误断言错误。

bpo-30877 [https://bugs.python.org/issue?@action=redirect&bpo=30877]: 修复了 JSON 解码器 Python 实现中的一个错误，该错误阻止了在完成解码后清除已解析字符串的缓存。基于 c-fos 的补丁。

bpo-33604 [https://bugs.python.org/issue?@action=redirect&bpo=33604]: 移除标记为在 3.8 中移除的 HMAC 默认 md5（原计划在 3.6 中移除，PR 7062 中推迟到 3.8）。

bpo-33582 [https://bugs.python.org/issue?@action=redirect&bpo=33582]: 为 inspect.formatargspec 发出弃用警告。

bpo-21145 [https://bugs.python.org/issue?@action=redirect&bpo=21145]: 添加 functools.cached_property 装饰器，用于计算属性，这些属性在实例的生命周期内被缓存。

bpo-33570 [https://bugs.python.org/issue?@action=redirect&bpo=33570]: 更改 TLS 1.3 密码套件设置，以兼容 OpenSSL 1.1.1-pre6 及更新版本。OpenSSL 1.1.1 将默认启用 TLS 1.3 密码。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: Do not simplify arguments to typing.Union. Now Union[Manager, Employee] is not simplified to Employee at runtime. Such simplification previously caused several bugs and limited possibilities for introspection.

bpo-12486 [https://bugs.python.org/issue?@action=redirect&bpo=12486]: tokenize.generate_tokens() 现在被记录为一个公共 API，用于对 Unicode 字符串进行分词。它之前存在但未被记录。

bpo-33540 [https://bugs.python.org/issue?@action=redirect&bpo=33540]: 向 socketserver 的 ForkingMixIn 和 ThreadingMixIn 类添加一个新的 block_on_close 类属性。

bpo-33548 [https://bugs.python.org/issue?@action=redirect&bpo=33548]: tempfile._candidate_tempdir_list 应考虑常见的 TEMP 位置

bpo-33109 [https://bugs.python.org/issue?@action=redirect&bpo=33109]: argparse 子解析器默认再次不需要，恢复了在 3.7.0a2 中由 bpo-26510 [https://bugs.python.org/issue?@action=redirect&bpo=26510] 引入的行为变化。

bpo-33541 [https://bugs.python.org/issue?@action=redirect&bpo=33541]: 移除未使用的私有方法 _strptime.LocaleTime.__pad``（又名 ``_LocaleTime__pad）。

bpo-33536 [https://bugs.python.org/issue?@action=redirect&bpo=33536]: dataclasses.make_dataclass 现在检查无效的字段名和重复的字段。此外，添加了对无效字段规范的检查。

bpo-33542 [https://bugs.python.org/issue?@action=redirect&bpo=33542]: 防止 uuid.get_node 在 Windows 上使用 DUID 而不是 MAC。由 Zvi Effron 提供补丁

bpo-26819 [https://bugs.python.org/issue?@action=redirect&bpo=26819]: Fix race condition with ReadTransport.resume_reading in Windows proactor event loop.

Fix failure in typing.get_type_hints() when ClassVar was provided as a string forward reference.

bpo-33516 [https://bugs.python.org/issue?@action=redirect&bpo=33516]: unittest.mock.MagicMock 现在支持 __round__ 魔术方法。

bpo-28612 [https://bugs.python.org/issue?@action=redirect&bpo=28612]: 向 urllib 的 RobotFileParser 添加了对站点地图的支持，作为 RobotFileParser.site_maps()。补丁由 Lady Red 提供，基于 Peter Wirtz 的补丁。

bpo-28167 [https://bugs.python.org/issue?@action=redirect&bpo=28167]: 移除自3.5版起已弃用的platform.linux_distribution。

bpo-33504 [https://bugs.python.org/issue?@action=redirect&bpo=33504]: 将 configparser 的默认字典实现从 collections.OrderedDict 切换为标准 dict 类型。

bpo-33505 [https://bugs.python.org/issue?@action=redirect&bpo=33505]: 通过重新排序if检查优化asyncio.ensure_future()：速度提升1.17倍。

bpo-33497 [https://bugs.python.org/issue?@action=redirect&bpo=33497]: 向cgi.parse_multipart添加errors参数，并使FieldStorage中的编码使用给定的errors（Twisted所需）。由Amber Brown提供补丁。

bpo-29235 [https://bugs.python.org/issue?@action=redirect&bpo=29235]: cProfile.Profile 类现在可用作上下文管理器。补丁由Scott Sanderson提供。

bpo-33495 [https://bugs.python.org/issue?@action=redirect&bpo=33495]: 更改dataclasses.Fields的repr以使用其每个成员的repr，而非str。这使得每个字段实际代表的内容更加清晰。这对于'type'成员尤为明显。

bpo-26103 [https://bugs.python.org/issue?@action=redirect&bpo=26103]: 修正 inspect.isdatadescriptor 以查找 __set__ 或 __delete__。由Aaron Hall提供补丁。

bpo-29209 [https://bugs.python.org/issue?@action=redirect&bpo=29209]: 移除了 XMLParser 构造函数的 doctype() 方法和 html 参数。子类中定义的 doctype() 方法将不再被调用。ElementTree 模块中已弃用的方法 getchildren() 和 getiterator() 现在发出 DeprecationWarning 而非 PendingDeprecationWarning。

bpo-33453 [https://bugs.python.org/issue?@action=redirect&bpo=33453]: 修复dataclasses以在使用字面字符串类型注解或使用PEP 563“推迟的注解评估”时工作。仅为ClassVar（"ClassVar"和"typing.ClassVar"）和InitVar（"InitVar"和"dataclasses.InitVar"）检测特定的字符串前缀。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing模块中的小修复：向 NamedTuple.__new__ 添加注解，在``Generic.__new__``中传递 *args 和 **kwds。原始PR由Paulius Šarka和Chad Dombrova提供。

bpo-33365 [https://bugs.python.org/issue?@action=redirect&bpo=33365]: 如果在 http.client 中将 debuglevel 设置为>0，除了头键外还打印头值。补丁由Marco Strigl提供。

bpo-20087 [https://bugs.python.org/issue?@action=redirect&bpo=20087]: 更新了支持glibc 2.27地区设置的别名映射。

bpo-33422 [https://bugs.python.org/issue?@action=redirect&bpo=33422]: 修复在pydoc上查找字节/字符串字面量时尾随引号被删除的问题。由Andrés Delfino提供补丁。

bpo-28167 [https://bugs.python.org/issue?@action=redirect&bpo=28167]: 函数 platform.linux_distribution 和 platform.dist 现在触发``DeprecationWarning``，并已被标记为在Python 3.8中移除。

bpo-33281 [https://bugs.python.org/issue?@action=redirect&bpo=33281]: 修复macOS上ctypes.util.find_library的回归问题。

bpo-33311 [https://bugs.python.org/issue?@action=redirect&bpo=33311]: 由cgitb生成的文本和html输出现在如果当前调用直接在模块中进行时不会显示括号。由Stéphane Blondon提供补丁。

bpo-27300 [https://bugs.python.org/issue?@action=redirect&bpo=27300]: tempfile*中的文件类现在接受一个 *errors 参数，补充了已经存在的 encoding 参数。由Stephan Hohe提供补丁。

bpo-32933 [https://bugs.python.org/issue?@action=redirect&bpo=32933]: unittest.mock.mock_open() 现在支持对文件内容进行迭代。由Tony Flury提供补丁。

bpo-33217 [https://bugs.python.org/issue?@action=redirect&bpo=33217]: 当在Enum类和Enum成员中查找非Enum对象时，抛出 TypeError。

bpo-33197 [https://bugs.python.org/issue?@action=redirect&bpo=33197]: Update error message when constructing invalid inspect.Parameters Patch by Dong-hee Na.

bpo-33383 [https://bugs.python.org/issue?@action=redirect&bpo=33383]: 修复了当使用单个参数调用 dbm.ndbm 数据库对象的get()方法时崩溃的问题。

bpo-33375 [https://bugs.python.org/issue?@action=redirect&bpo=33375]: warnings模块现在从代码对象而非帧的全局命名空间找到与警告相关联的Python文件。这与tracebacks和pdb如何查找文件名一致，应该能更好地处理动态执行的代码。

bpo-33336 [https://bugs.python.org/issue?@action=redirect&bpo=33336]: imaplib``现在允许在 ``IMAP4.uid() 中使用 MOVE 命令（RFC 6851: IMAP MOVE扩展）并可能作为 IMAP4 对象支持的方法名称。

bpo-32455 [https://bugs.python.org/issue?@action=redirect&bpo=32455]: 向 dis.stack_effect() 添加了 jump 参数。

bpo-27485 [https://bugs.python.org/issue?@action=redirect&bpo=27485]: 重命名并弃用 urllib.parse() 中未文档化的函数。

bpo-33332 [https://bugs.python.org/issue?@action=redirect&bpo=33332]: 添加 signal.valid_signals() 以暴露POSIX sigfillset()功能。

bpo-33251 [https://bugs.python.org/issue?@action=redirect&bpo=33251]: ConfigParser.items() was fixed so that key-value pairs passed in via vars are not included in the resulting output.

bpo-33329 [https://bugs.python.org/issue?@action=redirect&bpo=33329]: 修复了在新版 glibc 上的多进程回归问题。

bpo-33334 [https://bugs.python.org/issue?@action=redirect&bpo=33334]: dis.stack_effect() 现在支持所有定义的 opcode，包括 NOP 和 EXTENDED_ARG。

bpo-991266 [https://bugs.python.org/issue?@action=redirect&bpo=991266]: 修复了 http.cookies.SimpleCookie 的 Comment 属性的引用问题。

bpo-33131 [https://bugs.python.org/issue?@action=redirect&bpo=33131]: 将捆绑的 pip 版本升级至 10.0.1。

bpo-33308 [https://bugs.python.org/issue?@action=redirect&bpo=33308]: 修复了 parser 模块在将 ST 对象转换为元组或列表树时，当 line_info=False 且 col_info=True 时的崩溃问题。

bpo-23403 [https://bugs.python.org/issue?@action=redirect&bpo=23403]: lib2to3 现在对预计算的语法使用 pickle 协议 4。

bpo-33266 [https://bugs.python.org/issue?@action=redirect&bpo=33266]: lib2to3 现在能识别 rf'...' 字符串。

bpo-11594 [https://bugs.python.org/issue?@action=redirect&bpo=11594]: 确保在使用 lib2to3 时尊重行尾。

bpo-33254 [https://bugs.python.org/issue?@action=redirect&bpo=33254]: 让 importlib.resources.contents() 和 importlib.abc.ResourceReader.contents() 返回一个 iterable 而不是 iterator。

bpo-33265 [https://bugs.python.org/issue?@action=redirect&bpo=33265]: contextlib.ExitStack 和 contextlib.AsyncExitStack 现在使用方法而不是包装函数来处理退出回调。

bpo-33263 [https://bugs.python.org/issue?@action=redirect&bpo=33263]: Fix FD leak in _SelectorSocketTransport Patch by Vlad Starostin.

bpo-33256 [https://bugs.python.org/issue?@action=redirect&bpo=33256]: 修复了 cgitb.html() 生成的 html 中 <module> 调用的显示问题。补丁由 Stéphane Blondon 提供。

bpo-33144 [https://bugs.python.org/issue?@action=redirect&bpo=33144]: 优化了 random.Random() 及其子类机制，仅在类/子类实例化时检查一次其 getrandbits() 方法是否可以被其他方法（包括 randrange()）依赖，用于生成任意大的随机整数。由 Wolfgang Maier 提供补丁。

bpo-33185 [https://bugs.python.org/issue?@action=redirect&bpo=33185]: 修复了使用 -m 开关运行 pydoc 时的回归问题。（此回归问题由解决 bpo-33053 [https://bugs.python.org/issue?@action=redirect&bpo=33053] 在 3.7.0b3 版本引入）

此修复还改变了 pydoc，使其在必要时将 os.getcwd() 添加到 sys.path 中，而不是添加 "."。

bpo-29613 [https://bugs.python.org/issue?@action=redirect&bpo=29613]: 在 http.cookies 模块中添加了对 SameSite cookie 标志的支持。

bpo-33169 [https://bugs.python.org/issue?@action=redirect&bpo=33169]: 当调用 importlib.machinery.invalidate_caches() 时，删除 sys.path_importer_cache 中的 None 条目。

bpo-33203 [https://bugs.python.org/issue?@action=redirect&bpo=33203]: random.Random.choice() 现在对于空序列会一致地引发 IndexError，即使是从没有 getrandbits() 实现的子类中调用也是如此。

bpo-33224 [https://bugs.python.org/issue?@action=redirect&bpo=33224]: 为 PEP 479 [https://www.python.org/dev/peps/pep-0479] 更新 difflib.mdiff()。将生成器中未捕获的 StopIteration 转换为 return 语句。

bpo-33209 [https://bugs.python.org/issue?@action=redirect&bpo=33209]: 在 pickle.Pickler.dump() 的 C 实现结束时结束帧。

bpo-32861 [https://bugs.python.org/issue?@action=redirect&bpo=32861]: urllib.robotparser 的 __str__ 表示现在包括通配符条目和 "Crawl-delay" 和 "Request-rate" 字段。还移除了被附加到字符串末尾的额外换行符。由 Michael Lazar 提供补丁。

bpo-23403 [https://bugs.python.org/issue?@action=redirect&bpo=23403]: pickle 中的 DEFAULT_PROTOCOL 被提升到 4。协议 4 在 PEP 3154 [https://www.python.org/dev/peps/pep-3154] 中有描述，自 Python 3.4 起可用。与 Python 3.0 中引入的协议 3 相比，它提供了更好的性能和更小的尺寸。

bpo-20104 [https://bugs.python.org/issue?@action=redirect&bpo=20104]: Improved error handling and fixed a reference leak in os.posix_spawn().

bpo-33106 [https://bugs.python.org/issue?@action=redirect&bpo=33106]: 从只读 dbm 数据库中删除键会引发模块特定的错误，而不是 KeyError。

bpo-33175 [https://bugs.python.org/issue?@action=redirect&bpo=33175]: 在数据类中，Field.__set_name__ 现在查找默认值的类上的 __set_name__ 特殊方法，而不是实例上的。

bpo-32380 [https://bugs.python.org/issue?@action=redirect&bpo=32380]: 创建 functools.singledispatchmethod 以支持对描述符和方法的通用单分派。

bpo-33141 [https://bugs.python.org/issue?@action=redirect&bpo=33141]: 如果 Field 对象有自己的 __set_name__，则让它们将 __set_name__ 传递给它们的默认值。

bpo-33096 [https://bugs.python.org/issue?@action=redirect&bpo=33096]: 允许 ttk.Treeview.insert 插入具有假布尔值的 iid。注意 iid=0 和 iid=False 会是相同的。由 Garvit Khatri 提供补丁。

bpo-32873 [https://bugs.python.org/issue?@action=redirect&bpo=32873]: 通过复制和pickle操作将类型变量和特殊类型形式视为不可变。这修复了几个小问题和不一致性，并提高了与Python 3.6的向后兼容性。

bpo-33134 [https://bugs.python.org/issue?@action=redirect&bpo=33134]: 在计算数据类的__hash__时，使用查找表包含返回__hash__值的函数。这比查找字符串然后测试该字符串以决定做什么有所改进。

bpo-33127 [https://bugs.python.org/issue?@action=redirect&bpo=33127]: ssl模块现在可以编译使用LibreSSL 2.7.1。

bpo-32505 [https://bugs.python.org/issue?@action=redirect&bpo=32505]: 如果数据类的成员变量是Field类型但没有类型注解，则抛出TypeError。

bpo-33078 [https://bugs.python.org/issue?@action=redirect&bpo=33078]: 修复了由于测试依赖sem_getvalue而在OSX上导致的失败。

bpo-33116 [https://bugs.python.org/issue?@action=redirect&bpo=33116]: 将'Field'添加到dataclasses.__all__中。

bpo-32896 [https://bugs.python.org/issue?@action=redirect&bpo=32896]: 修复了一个错误，即当子类化一个使用default_factory字段的数据类时会生成一个不正确的类。

bpo-33100 [https://bugs.python.org/issue?@action=redirect&bpo=33100]: 数据类：如果一个字段有一个默认值是MemberDescriptorType，那么它是因为该字段在__slots__中，而不是一个实际的默认值。

bpo-32953 [https://bugs.python.org/issue?@action=redirect&bpo=32953]: 如果一个非数据类继承自一个冻结的数据类，允许向派生类添加属性。只有来自冻结数据类的属性不能被赋值。要求层次结构中的所有数据类要么全部冻结，要么全部非冻结。

bpo-33097 [https://bugs.python.org/issue?@action=redirect&bpo=33097]: 在解释器关闭期间调用 executor.submit 时抛出RuntimeError。

bpo-32968 [https://bugs.python.org/issue?@action=redirect&bpo=32968]: 涉及Fraction和float的模和地板除法应返回float。

bpo-33061 [https://bugs.python.org/issue?@action=redirect&bpo=33061]: 在typing.py的 __all__ 中添加缺失的 NoReturn。

bpo-33078 [https://bugs.python.org/issue?@action=redirect&bpo=33078]: 修复当发生pickling错误时multiprocessing.Queue中的大小处理。

bpo-33064 [https://bugs.python.org/issue?@action=redirect&bpo=33064]: lib2to3现在正确支持函数签名中 *args 和 **kwargs 后的尾随逗号。

bpo-33056 [https://bugs.python.org/issue?@action=redirect&bpo=33056]: 修复concurrent.futures.ProcessPoolExecutor中泄漏的文件描述符未正确关闭的问题。

bpo-33021 [https://bugs.python.org/issue?@action=redirect&bpo=33021]: 在fstat()调用期间释放GIL，避免在调用mmap.mmap()、os.urandom()和random.seed()时所有线程挂起。由Nir Soffer提供补丁。

bpo-31804 [https://bugs.python.org/issue?@action=redirect&bpo=31804]: 避免在标准流在退出时被关闭或为None时，multiprocessing.Process失败。

bpo-33034 [https://bugs.python.org/issue?@action=redirect&bpo=33034]: 当使用 urlparse() 和 urlsplit() 将port属性转换为非整数值时，提供明确的错误消息。由Matt Eaton提供补丁。

bpo-30249 [https://bugs.python.org/issue?@action=redirect&bpo=30249]: 改进struct.unpack_from()在缓冲区大小和偏移量问题上的异常消息。

bpo-33037 [https://bugs.python.org/issue?@action=redirect&bpo=33037]: 在SSL传输关闭后跳过发送/接收数据。

bpo-27683 [https://bugs.python.org/issue?@action=redirect&bpo=27683]: 修复 ipaddress 中的一个回归问题，当网络由包含整数掩码且仅剩1位地址的元组构造时，hosts() 的结果为空。

bpo-22674 [https://bugs.python.org/issue?@action=redirect&bpo=22674]: 在signal模块中添加strsignal()函数，该函数返回给定信号的系统描述，如同strsignal(3)返回的那样。

bpo-32999 [https://bugs.python.org/issue?@action=redirect&bpo=32999]: 修复 ABC.__subclasscheck__(cls, subclass) 的C实现，在 subclass 不是类型对象时崩溃的问题。

bpo-33009 [https://bugs.python.org/issue?@action=redirect&bpo=33009]: 修复inspect.signature()对于单参数partialmethods的处理。

bpo-32969 [https://bugs.python.org/issue?@action=redirect&bpo=32969]: 在zlib中暴露几个缺失的常量并修复相应的文档。

bpo-32056 [https://bugs.python.org/issue?@action=redirect&bpo=32056]: Improved exceptions raised for invalid number of channels and sample width when read an audio file in modules aifc, wave and sunau.

bpo-32970 [https://bugs.python.org/issue?@action=redirect&bpo=32970]: 改进MAKE_FUNCTION指令的反汇编。

bpo-32844 [https://bugs.python.org/issue?@action=redirect&bpo=32844]: 修复在subprocess中如果另一个低描述符被关闭时，将低描述符（0或1）错误重定向到stderr的问题。

bpo-32960 [https://bugs.python.org/issue?@action=redirect&bpo=32960]: 对于数据类，禁止从非冻结类继承冻结类，也禁止从冻结类继承非冻结类。这一限制将在未来放宽。

bpo-32713 [https://bugs.python.org/issue?@action=redirect&bpo=32713]: 修复tarfile.itn对超出界限的浮点值的处理。由Joffrey Fuhrer提供补丁。

bpo-32257 [https://bugs.python.org/issue?@action=redirect&bpo=32257]: ssl模块现在包含OP_NO_RENEGOTIATION常量，适用于OpenSSL 1.1.0h或1.1.1版本。

bpo-32951 [https://bugs.python.org/issue?@action=redirect&bpo=32951]: 现在禁止直接实例化SSLSocket和SSLObject对象。这些构造函数从未被记录、测试或设计为公共构造函数。用户应该使用ssl.wrap_socket()或SSLContext。

bpo-32929 [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曾经是默认值一样。

bpo-32947 [https://bugs.python.org/issue?@action=redirect&bpo=32947]: 添加OP_ENABLE_MIDDLEBOX_COMPAT和测试解决方法，以便未来与OpenSSL 1.1.1兼容的TLSv1.3。

bpo-32146 [https://bugs.python.org/issue?@action=redirect&bpo=32146]: 记录了冻结可执行文件与multiprocessing中spawn和forkserver启动方法之间的交互。

bpo-30622 [https://bugs.python.org/issue?@action=redirect&bpo=30622]: ssl模块现在能检测到LibreSSL中缺少的NPN支持。

bpo-32922 [https://bugs.python.org/issue?@action=redirect&bpo=32922]: dbm.open()现在使用文件系统编码而不是默认编码对文件名进行编码。

bpo-32759 [https://bugs.python.org/issue?@action=redirect&bpo=32759]: 在multiprocessing.heap中释放未使用的竞技场。

bpo-32859 [https://bugs.python.org/issue?@action=redirect&bpo=32859]: 在 os.dup2 中，不再每次调用时检查 dup3 系统调用是否存在。

bpo-32556 [https://bugs.python.org/issue?@action=redirect&bpo=32556]: nt._getfinalpathname、nt._getvolumepathname和nt._getdiskusage现在能正确地从字节转换。

bpo-21060 [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"。

bpo-32857 [https://bugs.python.org/issue?@action=redirect&bpo=32857]: 在 tkinter 中，after_cancel(None) 现在会引发 ValueError 异常，而不是取消第一个预定的函数。由Cheryl Sabella提供补丁。

bpo-32852 [https://bugs.python.org/issue?@action=redirect&bpo=32852]: 确保在运行trace时sys.argv保持为列表。

bpo-31333 [https://bugs.python.org/issue?@action=redirect&bpo=31333]: 添加了 _abc 模块。这是一个加速模块，为 abc 中的各种函数和方法提供了C语言实现。创建ABC子类及调用 isinstance 或 issubclass 与ABC子类的速度提高了1.5倍。此外，这使得Python的启动速度提高了10%。

注意，新实现隐藏了内部注册表和缓存，之前可以通过私有属性 _abc_registry、_abc_cache 和 _abc_negative_cache 访问。有三个调试辅助方法可以替代使用：_dump_registry、_abc_registry_clear 和 _abc_caches_clear。

bpo-32841 [https://bugs.python.org/issue?@action=redirect&bpo=32841]: Fixed asyncio.Condition issue which silently ignored cancellation after notifying and cancelling a conditional lock. Patch by Bar Harel.

bpo-32819 [https://bugs.python.org/issue?@action=redirect&bpo=32819]: ssl.match_hostname() 已被简化，不再依赖 re 和 ipaddress 模块处理通配符和IP地址。对于无效通配符的错误报告已改进。

bpo-19675 [https://bugs.python.org/issue?@action=redirect&bpo=19675]: 如果初始化失败，multiprocessing.Pool 不再泄漏进程。

bpo-32394 [https://bugs.python.org/issue?@action=redirect&bpo=32394]: socket: 在旧版本Windows运行时移除TCP_FASTOPEN、TCP_KEEPCNT、TCP_KEEPIDLE、TCP_KEEPINTVL标志。

bpo-31787 [https://bugs.python.org/issue?@action=redirect&bpo=31787]: 修复了多个模块中 __init__() 方法的内存泄漏问题。(由Oren Milman贡献)

bpo-30157 [https://bugs.python.org/issue?@action=redirect&bpo=30157]: 修复了在只有最后一个字段被引用时，csv.Sniffer.sniff() 中猜测引用和分隔符的问题。由Jake Davis提供补丁。

bpo-30688 [https://bugs.python.org/issue?@action=redirect&bpo=30688]: 在正则表达式中添加了对 \N{name} 转义的支持。基于Jonathan Eunice的补丁。

bpo-32792 [https://bugs.python.org/issue?@action=redirect&bpo=32792]: collections.ChainMap() 保留了底层映射的顺序。

bpo-32775 [https://bugs.python.org/issue?@action=redirect&bpo=32775]: fnmatch.translate() no longer produces patterns which contain set operations. Sets starting with '[' or containing '--', '&&', '~~' or '||' will be interpreted differently in regular expressions in future versions. Currently they emit warnings. fnmatch.translate() now avoids producing patterns containing such sets by accident.

bpo-32622 [https://bugs.python.org/issue?@action=redirect&bpo=32622]: 为Windows proactor事件循环实现原生快速发送文件功能。

bpo-32777 [https://bugs.python.org/issue?@action=redirect&bpo=32777]: 修复了在POSIX系统的子进程中，当标记文件描述符为可继承时，subprocess中一个罕见但潜在的子进程死锁问题。此bug似乎是在3.4版本中引入的。

bpo-32647 [https://bugs.python.org/issue?@action=redirect&bpo=32647]: ctypes模块过去依赖间接链接来使用dlopen。现在，在支持dl的平台上，共享扩展已明确链接到libdl。

bpo-32749 [https://bugs.python.org/issue?@action=redirect&bpo=32749]: 使用'r'标志打开的 dbm.dumb 数据库现在变为只读。使用'r'和'w'标志的 dbm.dumb.open() 如果数据库不存在，将不再创建数据库。

bpo-32741 [https://bugs.python.org/issue?@action=redirect&bpo=32741]: 实现 asyncio.TimerHandle.when() 方法。

bpo-32691 [https://bugs.python.org/issue?@action=redirect&bpo=32691]: 在使用pdb运行模块时使用mod_spec.parent。

bpo-32734 [https://bugs.python.org/issue?@action=redirect&bpo=32734]: 修复了 asyncio.Lock() 的安全问题，该问题允许多次获取和锁定同一个锁，而锁并未释放。由Bar Harel提供补丁。

bpo-32727 [https://bugs.python.org/issue?@action=redirect&bpo=32727]: 不在SMTP信封的发送地址中包含名字字段。由Stéphane Wirtel提供补丁。

bpo-31453 [https://bugs.python.org/issue?@action=redirect&bpo=31453]: Add TLSVersion constants and SSLContext.maximum_version / minimum_version attributes. The new API wraps OpenSSL 1.1 https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html feature.

bpo-24334 [https://bugs.python.org/issue?@action=redirect&bpo=24334]: 清理了ssl模块的内部实现细节。SSLSocket减少了一层间接引用。所有者与会话信息现在由SSLSocket和SSLObject的构造函数处理。通道绑定实现已被简化。

bpo-31848 [https://bugs.python.org/issue?@action=redirect&bpo=31848]: 修复Aifc_read.initfp()中当SSND块未找到时的错误处理。补丁由Zackery Spytz提供。

bpo-32585 [https://bugs.python.org/issue?@action=redirect&bpo=32585]: 向 tkinter.ttk 添加Ttk spinbox小部件。由Alan D Moore提供补丁。

bpo-32512 [https://bugs.python.org/issue?@action=redirect&bpo=32512]: profile CLI accepts -m module_name as an alternative to script path.

bpo-8525 [https://bugs.python.org/issue?@action=redirect&bpo=8525]: 现在，一个类型上的help()会显示内置的子类。这主要是为了帮助通知更具体的异常子类。

由Sanyam Khurana提供补丁。

bpo-31639 [https://bugs.python.org/issue?@action=redirect&bpo=31639]: http.server现在公开了一个ThreadingHTTPServer类，并在使用 -m 运行模块时使用它，以应对web浏览器预打开套接字的情况。

bpo-29877 [https://bugs.python.org/issue?@action=redirect&bpo=29877]: compileall: 仅在需要时导入ProcessPoolExecutor，防止在资源低的平台上挂起

bpo-32221 [https://bugs.python.org/issue?@action=redirect&bpo=32221]: 现在，返回包含IPv6地址的元组的各种函数省略了 %scope 部分，因为相同的信息已经在 scopeid 元组项中编码。特别是这加快了 socket.recvfrom() 在接收多播数据包时的速度，因为省略了无用的网络接口名称解析。

bpo-32147 [https://bugs.python.org/issue?@action=redirect&bpo=32147]: binascii.unhexlify() 现在快了2倍。由Sergey Fedoseev提供补丁。

bpo-30693 [https://bugs.python.org/issue?@action=redirect&bpo=30693]: TarFile类现在以一种可重复的方式递归目录。

bpo-30693 [https://bugs.python.org/issue?@action=redirect&bpo=30693]: ZipFile类现在以一种可重复的方式递归目录。

bpo-31680 [https://bugs.python.org/issue?@action=redirect&bpo=31680]: 添加了 curses.ncurses_version。

bpo-31908 [https://bugs.python.org/issue?@action=redirect&bpo=31908]: 修复了 trace 模块命令行工具的封面文件输出。之前仅在使用了 --missing 选项时才会发出封面文件。由Michael Selik提供补丁。

bpo-31608 [https://bugs.python.org/issue?@action=redirect&bpo=31608]: 如果 collections.deque 子类从 __new__ 返回非队列，现在会引发一个``TypeError``而不是崩溃。由Oren Milman提供补丁。

bpo-31425 [https://bugs.python.org/issue?@action=redirect&bpo=31425]: 添加了对AF_QIPCRTR地址族套接字的支持，这是Linux内核支持的。这用于与运行在Qualcomm设备上的服务（如GPS或无线电）通信。由Bjorn Andersson提供补丁。

bpo-22005 [https://bugs.python.org/issue?@action=redirect&bpo=22005]: 实现了对Python 2腌制的 datetime、date 和 time 实例的解腌。应该使用 encoding='latin1' 以成功解码。

bpo-27645 [https://bugs.python.org/issue?@action=redirect&bpo=27645]: 如果底层的SQLite库版本为3.6.11或更高，sqlite3.Connection 现在公开了一个 backup 方法。由Lele Gaifax提供补丁。

bpo-16865 [https://bugs.python.org/issue?@action=redirect&bpo=16865]: 在 ctypes 中支持>=2GiB的数组。由Segev Finer提供补丁。

bpo-31508 [https://bugs.python.org/issue?@action=redirect&bpo=31508]: Removed support of arguments in tkinter.ttk.Treeview.selection. It was deprecated in 3.6. Use specialized methods like selection_set for changing the selection.

bpo-29456 [https://bugs.python.org/issue?@action=redirect&bpo=29456]: 修复韩文音节标准化中的漏洞：u1176、u11a7和u11c3。

文档

bpo-21257 [https://bugs.python.org/issue?@action=redirect&bpo=21257]: 文档化 http.client.parse_headers()。

bpo-34764 [https://bugs.python.org/issue?@action=redirect&bpo=34764]: 改进了iter()带有第二个哨兵参数的示例。

bpo-35564 [https://bugs.python.org/issue?@action=redirect&bpo=35564]: 为了符合Sphinx 2.0，明确设置了conf.py中的master_doc变量。

bpo-35511 [https://bugs.python.org/issue?@action=redirect&bpo=35511]: 指定了profile.Profile类不支持enable或disable方法。并且详细说明了Profile对象作为上下文管理器仅在cProfile模块中支持。

bpo-10536 [https://bugs.python.org/issue?@action=redirect&bpo=10536]: 增强gettext文档。由Éric Araujo提供补丁。

bpo-35089 [https://bugs.python.org/issue?@action=redirect&bpo=35089]: 移除了对 typing.io 和 typing.re 的提及。它们的类型应该直接从 ``typing``导入。

bpo-35038 [https://bugs.python.org/issue?@action=redirect&bpo=35038]: Fix the documentation about an unexisting f_restricted attribute in the frame object. Patch by Stéphane Wirtel

bpo-35042 [https://bugs.python.org/issue?@action=redirect&bpo=35042]: 用pep角色替换PEP XYZ，并允许直接链接到PEPs。

bpo-35044 [https://bugs.python.org/issue?@action=redirect&bpo=35044]: 修复了文档中使用 exc 角色指向适当异常的错误。由Stéphane Wirtel提供补丁。

bpo-35035 [https://bugs.python.org/issue?@action=redirect&bpo=35035]: 将 email.utils 的文档重命名为 email.utils.rst。

bpo-34967 [https://bugs.python.org/issue?@action=redirect&bpo=34967]: 使用app.add_object_type()代替已弃用的Sphinx函数app.description_unit()。

bpo-34913 [https://bugs.python.org/issue?@action=redirect&bpo=34913]: 添加了关于gzip模块新命令行界面的文档。

bpo-32174 [https://bugs.python.org/issue?@action=redirect&bpo=32174]: chm document displays non-ASCII charaters properly on some MBCS Windows systems.

bpo-11233 [https://bugs.python.org/issue?@action=redirect&bpo=11233]: 为文档创建可用性指令。原始由Georg Brandl提供补丁。

bpo-34790 [https://bugs.python.org/issue?@action=redirect&bpo=34790]: 文档说明将协程传递给 asyncio.wait() 可能会引起混淆。

bpo-34552 [https://bugs.python.org/issue?@action=redirect&bpo=34552]: Make clear that == operator sometimes is equivalent to is. The <, <=, > and >= operators are only defined where they make sense.

bpo-28617 [https://bugs.python.org/issue?@action=redirect&bpo=28617]: 修复了 stdtypes 文档中关于支持成员资格测试的类型的错误信息。

bpo-20177 [https://bugs.python.org/issue?@action=redirect&bpo=20177]: 将 datetime.date.fromtimestamp 迁移到 Argument Clinic。由 Tim Hoffmann 提供补丁。

bpo-34065 [https://bugs.python.org/issue?@action=redirect&bpo=34065]: 修复了 basicConfig 文档标记语法的错误写法。

bpo-33460 [https://bugs.python.org/issue?@action=redirect&bpo=33460]: 在教程第3章中，用正确的错误代码替换了省略号。

bpo-33847 [https://bugs.python.org/issue?@action=redirect&bpo=33847]: 在索引中添加 '@' 操作符条目。

bpo-33409 [https://bugs.python.org/issue?@action=redirect&bpo=33409]: 澄清了 PEP 538 [https://www.python.org/dev/peps/pep-0538] 的 PYTHONCOERCECLOCALE 和 PEP 540 的 PYTHONUTF8 模式之间的关系。

bpo-33197 [https://bugs.python.org/issue?@action=redirect&bpo=33197]: 在 ParameterKind.description 的文档中添加了 versionadded 标签。

bpo-17045 [https://bugs.python.org/issue?@action=redirect&bpo=17045]: 改进了 PyTypeObject 的 C-API 文档。包括添加了几个快速参考表和许多缺失的槽/类型定义条目。现有的条目也被清理，格式更加一致。

bpo-33736 [https://bugs.python.org/issue?@action=redirect&bpo=33736]: 改进了 asyncio.open_connection()、asyncio.start_server() 及其 UNIX 套接字对应函数的文档。

bpo-23859 [https://bugs.python.org/issue?@action=redirect&bpo=23859]: Document that asyncio.wait() does not cancel its futures on timeout.

bpo-32436 [https://bugs.python.org/issue?@action=redirect&bpo=32436]: 文档说明 PEP 567 [https://www.python.org/dev/peps/pep-0567] 对 asyncio 的更改。

bpo-33604 [https://bugs.python.org/issue?@action=redirect&bpo=33604]: 将 HMAC md5 的默认警告更新为 DeprecationWarning，移除时间推迟到 3.8。

bpo-33594 [https://bugs.python.org/issue?@action=redirect&bpo=33594]: 在各自的文档字符串中将 getargspec、from_function 和 from_builtin 标记为已弃用，并在 DeprecationWarning 消息中包含弃用版本。

bpo-33503 [https://bugs.python.org/issue?@action=redirect&bpo=33503]: 修复损坏的 pypi 链接

bpo-33421 [https://bugs.python.org/issue?@action=redirect&bpo=33421]: 为 typing.AsyncContextManager 添加缺失的文档。

bpo-33487 [https://bugs.python.org/issue?@action=redirect&bpo=33487]: 当传递 buffering=None 时，BZ2file 现在会发出 DeprecationWarning，弃用消息和文档现在也明确说明自 3.0 起已弃用。

bpo-33378 [https://bugs.python.org/issue?@action=redirect&bpo=33378]: 为 https://docs.python.org/3/ 添加韩语语言切换器。

bpo-33276 [https://bugs.python.org/issue?@action=redirect&bpo=33276]: 澄清模块上的 __path__ 属性不能是任意值。

bpo-33201 [https://bugs.python.org/issue?@action=redirect&bpo=33201]: 现代化编写 C 扩展类型的文档。

bpo-33195 [https://bugs.python.org/issue?@action=redirect&bpo=33195]: 在 c-api/arg 文档中弃用 Py_UNICODE 的使用。自 Python 3.3 起，Py_UNICODE 相关 API 已被弃用，但文档中遗漏了这一点。

bpo-33126 [https://bugs.python.org/issue?@action=redirect&bpo=33126]: 文档化 PyBuffer_ToContiguous()。

bpo-27212 [https://bugs.python.org/issue?@action=redirect&bpo=27212]: 修改 islice() 函数示例代码的文档说明，使其在起始索引前消耗初始值。

bpo-28247 [https://bugs.python.org/issue?@action=redirect&bpo=28247]: 更新 zipapp 文档，描述如何制作独立应用程序。

bpo-18802 [https://bugs.python.org/issue?@action=redirect&bpo=18802]: ipaddress 的文档更改。由 Jon Foster 和 Berker Peksag 提供补丁。

bpo-27428 [https://bugs.python.org/issue?@action=redirect&bpo=27428]: 更新文档以澄清 WindowsRegistryFinder 实现了 MetaPathFinder。（补丁由 Himanshu Lakhara 提供）

bpo-28124 [https://bugs.python.org/issue?@action=redirect&bpo=28124]: ssl 模块函数 ssl.wrap_socket() 已被弱化并弃用，推荐使用更安全高效的 SSLContext.wrap_socket() 方法。

bpo-17232 [https://bugs.python.org/issue?@action=redirect&bpo=17232]: 澄清 -O 和 -OO 的文档。由 Terry Reedy 提供补丁。

bpo-32436 [https://bugs.python.org/issue?@action=redirect&bpo=32436]: 为 contextvars 模块（PEP 567）添加文档。

bpo-32800 [https://bugs.python.org/issue?@action=redirect&bpo=32800]: 更新 xml 默认命名空间的 w3c 文档链接。

bpo-11015 [https://bugs.python.org/issue?@action=redirect&bpo=11015]: 更新 test.support 文档。

bpo-32613 [https://bugs.python.org/issue?@action=redirect&bpo=32613]: 更新 faq/windows.html，使用 PEP 397 中的 py 命令而非 python。

bpo-8722 [https://bugs.python.org/issue?@action=redirect&bpo=8722]: 文档化当属性 get() 方法引发 AttributeError 时 __getattr__() 的行为。

bpo-32614 [https://bugs.python.org/issue?@action=redirect&bpo=32614]: 修改文档中的正则表达式示例，使用原始字符串以防止 DeprecationWarning，并在正则表达式 HOWTO 中添加文本以突出弃用。

bpo-20709 [https://bugs.python.org/issue?@action=redirect&bpo=20709]: 删除解释 os.utime() 在 Windows 下不支持目录作为路径的段落。由 Jan-Philip Gehrcke 提供补丁。

bpo-32722 [https://bugs.python.org/issue?@action=redirect&bpo=32722]: 移除生成器表达式教程中的不良示例。由 Stéphane Wirtel 提供补丁。

bpo-31972 [https://bugs.python.org/issue?@action=redirect&bpo=31972]: Improve docstrings for pathlib.PurePath subclasses.

bpo-30607 [https://bugs.python.org/issue?@action=redirect&bpo=30607]: 在构建文档时使用外部化的 python-docs-theme 包。

bpo-8243 [https://bugs.python.org/issue?@action=redirect&bpo=8243]: 添加关于 curses.addch 和 curses.addstr 在窗口或 pad 外部写入时的异常行为的注释。

bpo-32337 [https://bugs.python.org/issue?@action=redirect&bpo=32337]: 更新与 dict 顺序相关的文档。

bpo-25041 [https://bugs.python.org/issue?@action=redirect&bpo=25041]: 在 socket 模块中记录 AF_PACKET。

bpo-31432 [https://bugs.python.org/issue?@action=redirect&bpo=31432]: 澄清 ssl.SSLContext.verify_mode 的 CERT_NONE、CERT_OPTIONAL 和 CERT_REQUIRED 标志的含义。

测试

bpo-35772 [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。

bpo-35045 [https://bugs.python.org/issue?@action=redirect&bpo=35045]: 使 ssl 测试不那么严格，也接受 TLSv1 作为系统默认值。这些更改修复了 Fedora 29 上的 test_min_max_version。

bpo-32710 [https://bugs.python.org/issue?@action=redirect&bpo=32710]: test_asyncio/test_sendfile.py 现在像其他测试一样使用 tearDownModule() 重置事件循环策略，以防止在 Windows 上运行测试时出现警告。

bpo-33717 [https://bugs.python.org/issue?@action=redirect&bpo=33717]: test.pythoninfo 现在记录所有时钟的信息，而不仅仅是 time.time() 和 time.perf_counter()。

bpo-35488 [https://bugs.python.org/issue?@action=redirect&bpo=35488]: 向 pathlib 的 Path.match() 添加一个测试，以验证它不支持 glob 风格的 ** 递归模式匹配。

bpo-31731 [https://bugs.python.org/issue?@action=redirect&bpo=31731]: 修复 test_io 的 check_interrupted_write() 中的竞争条件：直接创建带有 SIGALRM 信号阻塞的线程，而不是稍后从线程中阻塞信号。以前，有可能线程在信号被阻塞之前就收到了信号。

bpo-35424 [https://bugs.python.org/issue?@action=redirect&bpo=35424]: 修复 test_multiprocessing_main_handling：使用 multiprocessing.Pool 与上下文管理器，然后显式加入池。

bpo-35519 [https://bugs.python.org/issue?@action=redirect&bpo=35519]: 将 test.bisect 模块重命名为 test.bisect_cmd，以避免在直接运行测试如 ./python Lib/test/test_xmlrpc.py 时与 bisect 模块冲突。

bpo-35513 [https://bugs.python.org/issue?@action=redirect&bpo=35513]: 在测试中用 time.monotonic() 替换 time.time() 来测量时间差。

bpo-34279 [https://bugs.python.org/issue?@action=redirect&bpo=34279]: test.support.run_unittest() 不再在测试结果包含跳过的测试时引发 TestDidNotRun 异常。现在只有在没有运行任何测试且没有跳过任何测试时才会引发该异常。

bpo-35412 [https://bugs.python.org/issue?@action=redirect&bpo=35412]: 向 test_future4 添加测试用例：检查 unicode 字面量。

bpo-26704 [https://bugs.python.org/issue?@action=redirect&bpo=26704]: 添加了演示实例方法双重修补的测试。由 Anthony Sottile 提供补丁。

bpo-33725 [https://bugs.python.org/issue?@action=redirect&bpo=33725]: 在 macOS 的较新版本上，test_multiprocessing_fork 可能会崩溃。在问题解决之前，在 macOS 上跳过该测试。

bpo-35352 [https://bugs.python.org/issue?@action=redirect&bpo=35352]: 修改 test_asyncio 以使用测试目录中的证书集。

bpo-35317 [https://bugs.python.org/issue?@action=redirect&bpo=35317]: 修复 test_email 中的 mktime() 溢出错误：在特定时区下运行 test_localtime_daylight_true_dst_true() 和 test_localtime_daylight_false_dst_true()。

bpo-21263 [https://bugs.python.org/issue?@action=redirect&bpo=21263]: 在多次报告 test_gdb 在 macOS 上无法正常工作后，并且由于 gdb 不再默认附带，当使用 LLVM Clang 编译 Python 时，现在在 macOS 上跳过 test_gdb。由 Lysandros Nikolaou 提供补丁

bpo-34279 [https://bugs.python.org/issue?@action=redirect&bpo=34279]: 当在特定测试文件中没有执行任何测试时，regrtest 发出警告。此外，如果在所有测试文件中没有执行任何测试，则发出新的最终结果状态。由 Pablo Galindo 提供补丁。

bpo-34962 [https://bugs.python.org/issue?@action=redirect&bpo=34962]: Doc 中的 docstest 现在通过了，并且在 CI 中强制执行。

bpo-23596 [https://bugs.python.org/issue?@action=redirect&bpo=23596]: 为 gzip 模块的命令行使用 argparse。由 Antony Lee 提供补丁

bpo-34537 [https://bugs.python.org/issue?@action=redirect&bpo=34537]: 当 LC_ALL=C 且 GDB 是用 Python 3.6 或更早版本编译时，修复 test_gdb.test_strings()。

bpo-34587 [https://bugs.python.org/issue?@action=redirect&bpo=34587]: test_socket: 移除RDSTest.testCongestion()。该测试试图填满接收者的套接字缓冲区并期望出现错误。但RDS协议并不要求这一点。此外，RDS的Linux实现期望消息的生产者降低其速率，触发错误不是接收者的角色。该测试在Fedora 28上按设计失败，因此直接移除它。

bpo-34661 [https://bugs.python.org/issue?@action=redirect&bpo=34661]: 如果unzip不支持-t，修复test_shutil。

bpo-34200 [https://bugs.python.org/issue?@action=redirect&bpo=34200]: 通过不使用可怕的test.support.module_cleanup()逻辑来保存和恢复测试用例之间的sys.modules内容，修复了test_pkg的非确定性波动。

bpo-34569 [https://bugs.python.org/issue?@action=redirect&bpo=34569]: 实验性的PEP 554数据通道现在在32位系统上正确地在子解释器之间传递负的PyLong对象。由Michael Felt提供补丁。

bpo-34594 [https://bugs.python.org/issue?@action=redirect&bpo=34594]: 修复测试中硬编码的 errno 值的使用。

bpo-34579 [https://bugs.python.org/issue?@action=redirect&bpo=34579]: 为AIX修复test_embed，由Michael Felt提供补丁

bpo-34542 [https://bugs.python.org/issue?@action=redirect&bpo=34542]: 使用3072位的RSA密钥和SHA-256签名用于测试证书和密钥。

bpo-11193 [https://bugs.python.org/issue?@action=redirect&bpo=11193]: Remove special condition for AIX in test_subprocess.test_undecodable_env

bpo-34347 [https://bugs.python.org/issue?@action=redirect&bpo=34347]: Fix test_utf8_mode.test_cmd_line for AIX

bpo-34490 [https://bugs.python.org/issue?@action=redirect&bpo=34490]: 在AIX上，使用AF_UNIX家族套接字的getsockname()不提供'sockname'，因此跳过对transport.get_extra_info('sockname')的调用

bpo-34391 [https://bugs.python.org/issue?@action=redirect&bpo=34391]: 通过从数据套接字读取，为TLS 1.3修复ftplib测试。

bpo-11192 [https://bugs.python.org/issue?@action=redirect&bpo=11192]: Fix test_socket on AIX 6.1 and later IPv6 zone id supports only supported by inet_pton6_zone() Switch to runtime-based platform.system() to establish current platform rather than build-time based sys.platform()

bpo-34399 [https://bugs.python.org/issue?@action=redirect&bpo=34399]: 更新所有RSA密钥和DH参数以使用至少2048位。

bpo-34373 [https://bugs.python.org/issue?@action=redirect&bpo=34373]: 为AIX修复 test_mktime 和 test_pthread_getcpuclickid 测试，为AIX添加对``_PyTime_localtime``的范围检查，由Michael Felt提供补丁

bpo-11191 [https://bugs.python.org/issue?@action=redirect&bpo=11191]: 当使用XLC作为编译器时，跳过distutils测试'test_search_cpp'，由aixtools（Michael Felt）提供补丁

改进了当模拟 assert_has_calls 失败时的错误信息。

bpo-33746 [https://bugs.python.org/issue?@action=redirect&bpo=33746]: 修复在详细模式下运行时的 test_unittest。

bpo-33901 [https://bugs.python.org/issue?@action=redirect&bpo=33901]: 在 macOS 上使用 gdbm 1.15 修复 test_dbm_gnu：添加一个更大的值以确保文件大小发生变化。

bpo-33873 [https://bugs.python.org/issue?@action=redirect&bpo=33873]: 修复 regrtest 中的一个错误，该错误在使用了 --huntrleaks/-R 时会导致额外运行一个测试。如果指定了无效的参数给 --huntrleaks/-R（至少必须使用一次预热运行和一次重复运行），则退出并报错。

bpo-33562 [https://bugs.python.org/issue?@action=redirect&bpo=33562]: 检查任何测试是否没有留下全局 asyncio 事件循环策略。

bpo-33655 [https://bugs.python.org/issue?@action=redirect&bpo=33655]: 忽略在可能由于在 ZFS 上运行而导致的 BSD 平台上的 test_posix_fallocate 失败。

bpo-32962 [https://bugs.python.org/issue?@action=redirect&bpo=32962]: 当 Python 使用标志 -mcet -fcf-protection -O0 编译时，修复 test_gdb。

bpo-33358 [https://bugs.python.org/issue?@action=redirect&bpo=33358]: 当解释器使用 --enable-shared 构建时，修复 test_embed.test_pre_initialization_sys_options()。

bpo-32872 [https://bugs.python.org/issue?@action=redirect&bpo=32872]: 避免 regrtest 与命名空间包的兼容性问题。

bpo-32517 [https://bugs.python.org/issue?@action=redirect&bpo=32517]: 修复由于 KqueueSelector 循环的传输未被关闭而在 macOS 10.12.2+ 上失败的 test_asyncio。

bpo-32663 [https://bugs.python.org/issue?@action=redirect&bpo=32663]: Making sure the SMTPUTF8SimTests class of tests gets run in test_smtplib.py.

bpo-27643 [https://bugs.python.org/issue?@action=redirect&bpo=27643]: Test_C 测试用例需要“有符号短”位字段，但 IBM XLC 编译器（在 AIX 上）不支持此功能，当使用 AIX 和 XLC 时跳过代码和测试

适用于 Python2-2.7 及以后版本

bpo-19417 [https://bugs.python.org/issue?@action=redirect&bpo=19417]: 添加 test_bdb.py。

bpo-31809 [https://bugs.python.org/issue?@action=redirect&bpo=31809]: 添加测试以验证与 secp ECDH 曲线的连接。

构建

bpo-34691 [https://bugs.python.org/issue?@action=redirect&bpo=34691]: _contextvars 模块现在被内置到 Windows 上的核心 Python 库中。

bpo-35683 [https://bugs.python.org/issue?@action=redirect&bpo=35683]: 改进了 Azure Pipelines 构建步骤，现在正确验证布局

bpo-35642 [https://bugs.python.org/issue?@action=redirect&bpo=35642]: 从 pythoncore.vcxproj 中移除 asynciomodule.c

bpo-35550 [https://bugs.python.org/issue?@action=redirect&bpo=35550]: 修复编译时错误的 Solaris #ifdef 检查，改为查找 __sun && __SVR4 而不是 sun。

bpo-35499 [https://bugs.python.org/issue?@action=redirect&bpo=35499]: make profile-opt 不再用 CFLAGS 替换 CFLAGS_NODIST。现在它将配置文件引导优化（PGO）标志添加到 CFLAGS_NODIST 中：原有的 CFLAGS_NODIST 标志被保留。

bpo-35257 [https://bugs.python.org/issue?@action=redirect&bpo=35257]: 在编译 C 扩展时，避免将链接时间优化（LTO）的链接器标志泄漏到 distutils 中。

bpo-35351 [https://bugs.python.org/issue?@action=redirect&bpo=35351]: 当使用 clang 和 LTO 构建 Python 时，不再将 LTO 标志传递到 CFLAGS 中，以通过 distutils 构建第三方 C 扩展。

bpo-35139 [https://bugs.python.org/issue?@action=redirect&bpo=35139]: Fix a compiler error when statically linking pyexpat in Modules/Setup.

bpo-35059 [https://bugs.python.org/issue?@action=redirect&bpo=35059]: PCbuild：在 Debug 模式下将 InlineFunctionExpansion 设置为 OnlyExplicitInline（"/Ob1" 选项）在 pyproject.props 中，以展开标记为内联的函数。这一变化应该会使在 Windows 上以 Debug 模式编译的 Python 稍微快一些。

bpo-35011 [https://bugs.python.org/issue?@action=redirect&bpo=35011]: 恢复使用 pyexpatns.h 来隔离我们嵌入的 expat C 库副本，以便其符号在链接或动态加载时不会与嵌入应用程序或其他带有自己版本 libexpat 的扩展模块冲突。

bpo-28015 [https://bugs.python.org/issue?@action=redirect&bpo=28015]: 使 --with-lto 与 clang 正确工作。

bpo-34765 [https://bugs.python.org/issue?@action=redirect&bpo=34765]: 将过时的 install-sh 文件更新至 automake v1.16.1 的最新修订版。

bpo-34585 [https://bugs.python.org/issue?@action=redirect&bpo=34585]: 在 configure.ac 中使用编译测试而不是执行代码来检查浮点字节顺序，以便这些检查在交叉编译构建中工作。

bpo-34710 [https://bugs.python.org/issue?@action=redirect&bpo=34710]: 修复了使用 OpenSSL 和严格 CFLAGS 构建 SSL 模块的问题。

bpo-34582 [https://bugs.python.org/issue?@action=redirect&bpo=34582]: 为回归测试添加 JUnit XML 输出并更新 Azure DevOps 构建。

bpo-34081 [https://bugs.python.org/issue?@action=redirect&bpo=34081]: 在 Docs Makefile 中将 Sphinx 警告视为错误。

bpo-34555 [https://bugs.python.org/issue?@action=redirect&bpo=34555]: 修复了无法同时未定义 HAVE_LINUX_VM_SOCKETS_H 和 HAVE_SOCKADDR_ALG 的情况。

bpo-33015 [https://bugs.python.org/issue?@action=redirect&bpo=33015]: 修复了 PyThread_start_new_thread() 的 pthread 实现中的一个未定义行为：添加一个函数包装器以始终返回 NULL。

bpo-34245 [https://bugs.python.org/issue?@action=redirect&bpo=34245]: Python共享库现在以写权限（模式0755）安装，这是安装此类库的标准方式。

bpo-34121 [https://bugs.python.org/issue?@action=redirect&bpo=34121]: 修复在clang上对C11原子支持的检测。

bpo-32430 [https://bugs.python.org/issue?@action=redirect&bpo=32430]: 将Modules/Setup.dist重命名为Modules/Setup，并消除在更新本地源代码树时需要手动将前者复制到后者的必要性。

bpo-30345 [https://bugs.python.org/issue?@action=redirect&bpo=30345]: 在使用LTO编译时添加-g到LDFLAGS以获取调试符号。

bpo-5755 [https://bugs.python.org/issue?@action=redirect&bpo=5755]: 将 -Wstrict-prototypes 选项从 OPT 移到 CFLAGS_NODIST。此选项在用C++编写扩展模块时会产生烦人的警告。

bpo-33614 [https://bugs.python.org/issue?@action=redirect&bpo=33614]: 确保Windows上稳定ABI的模块定义文件被正确重新生成。

bpo-33648 [https://bugs.python.org/issue?@action=redirect&bpo=33648]: 已移除--with-c-locale-warning配置标志。它已经大约一年没有效果了。

bpo-33522 [https://bugs.python.org/issue?@action=redirect&bpo=33522]: 在https://python.visualstudio.com/cpython上启用Visual Studio Team Services的CI构建。

bpo-33522 [https://bugs.python.org/issue?@action=redirect&bpo=33522]: 配置对"long double"的检查已被简化

bpo-33483 [https://bugs.python.org/issue?@action=redirect&bpo=33483]: 现在可以从标准环境变量中正确检测C编译器。--without-gcc和--with-icc选项已被移除。

bpo-33394 [https://bugs.python.org/issue?@action=redirect&bpo=33394]: 当GNU make在命令行上传递宏时，为扩展模块启用详细构建。

bpo-33393 [https://bugs.python.org/issue?@action=redirect&bpo=33393]: 更新config.guess和config.sub文件。

bpo-33377 [https://bugs.python.org/issue?@action=redirect&bpo=33377]: 为mips r6和riscv变体添加新的三元组（用于扩展后缀）。

bpo-32232 [https://bugs.python.org/issue?@action=redirect&bpo=32232]: By default, modules configured in Modules/Setup are no longer built with -DPy_BUILD_CORE. Instead, modules that specifically need that preprocessor definition include it in their individual entries.

bpo-33182 [https://bugs.python.org/issue?@action=redirect&bpo=33182]: 嵌入测试可以再次用clang 6.0构建。

bpo-33163 [https://bugs.python.org/issue?@action=redirect&bpo=33163]: 将pip升级到9.0.3，setuptools升级到v39.0.1。

bpo-33012 [https://bugs.python.org/issue?@action=redirect&bpo=33012]: gcc 8 新增了一个警告启发式方法来检测无效的函数转换，而标准的 Python 构建似乎经常触发该警告。最常见的是将 METH_NOARGS 函数（仅使用一个参数）转换为 PyCFunction。通过为所有实现 METH_NOARGS 的函数添加一个虚拟参数来解决这个问题。

bpo-32898 [https://bugs.python.org/issue?@action=redirect&bpo=32898]: 修复了在使用 COUNT_ALLOCS 时的 Python 调试构建问题。

bpo-29442 [https://bugs.python.org/issue?@action=redirect&bpo=29442]: 在 setup.py 中用 argparse 替换 optparse。

Windows

bpo-35890 [https://bugs.python.org/issue?@action=redirect&bpo=35890]: 修复 GetVersionEx 和 wcstok 的 API 调用一致性。

bpo-32560 [https://bugs.python.org/issue?@action=redirect&bpo=32560]: py 启动器现在将其 STARTUPINFO 结构转发给子进程。

bpo-35854 [https://bugs.python.org/issue?@action=redirect&bpo=35854]: 在 Windows 上修复 EnvBuilder 和 --symlinks 在 venv 中的问题。

bpo-35811 [https://bugs.python.org/issue?@action=redirect&bpo=35811]: 避免在通过 py.exe 启动时传播 venv 设置。

bpo-35797 [https://bugs.python.org/issue?@action=redirect&bpo=35797]: 修复 multiprocessing 模块使用的默认可执行文件。

bpo-35758 [https://bugs.python.org/issue?@action=redirect&bpo=35758]: 允许在 ARM 上使用 MSVC 进行构建。

bpo-29734 [https://bugs.python.org/issue?@action=redirect&bpo=29734]: 修复 Windows 上 os.stat 中的句柄泄漏问题。

bpo-35596 [https://bugs.python.org/issue?@action=redirect&bpo=35596]: 为嵌入式发行版使用未检查的 PYC，以避免 zipimport 限制。

bpo-35596 [https://bugs.python.org/issue?@action=redirect&bpo=35596]: 修复 vcruntime140.dll 被多次添加到嵌入式发行版的问题。

bpo-35402 [https://bugs.python.org/issue?@action=redirect&bpo=35402]: 更新 Windows 构建以使用 Tcl 和 Tk 8.6.9。

bpo-35401 [https://bugs.python.org/issue?@action=redirect&bpo=35401]: 将 Windows 构建更新至 OpenSSL 1.1.0j。

bpo-34977 [https://bugs.python.org/issue?@action=redirect&bpo=34977]: Windows 上的 venv 现在将使用 python.exe 重定向器，而不是从基础环境中复制实际的二进制文件。

bpo-34977 [https://bugs.python.org/issue?@action=redirect&bpo=34977]: 添加了对构建 Windows 应用商店包的支持。

bpo-35067 [https://bugs.python.org/issue?@action=redirect&bpo=35067]: 移除 _distutils_findvs 模块并改用 vswhere.exe。

bpo-32557 [https://bugs.python.org/issue?@action=redirect&bpo=32557]: 允许 shutil.disk_usage 在 Windows 上接受文件路径。

bpo-34770 [https://bugs.python.org/issue?@action=redirect&bpo=34770]: 修复 pyshellext.cpp 中可能的空指针解引用问题。

bpo-34603 [https://bugs.python.org/issue?@action=redirect&bpo=34603]: 修复由 MSVC 生成的函数返回结构体的问题。

bpo-34581 [https://bugs.python.org/issue?@action=redirect&bpo=34581]: 在 socketmodule.c 中使用 #ifdef _MSC_VER 保护 MSVC 特定代码。

bpo-34532 [https://bugs.python.org/issue?@action=redirect&bpo=34532]: 修复了 py.exe 的列表版本参数的退出代码。

bpo-34062 [https://bugs.python.org/issue?@action=redirect&bpo=34062]: 修复了 py.exe 启动器的 '--list' 和 '--list-paths' 参数。

bpo-34225 [https://bugs.python.org/issue?@action=redirect&bpo=34225]: 确保INCLUDE和LIB目录不以反斜杠结尾。

bpo-34011 [https://bugs.python.org/issue?@action=redirect&bpo=34011]: 一套代码已被更改，这些代码从运行的Python位置复制DLLs和init.tcl到正在创建的venv中。这些复制仅在从Python源代码构建运行时需要，现在复制代码仅在这种情况下运行，而不是在创建venv时总是运行。

bpo-34006 [https://bugs.python.org/issue?@action=redirect&bpo=34006]: 恢复Windows帮助文档的行长度限制。行长度限制不需要，因为页面显示在单独的应用程序中而不是浏览器标签中。它也可能与DPI设置产生不良互动。

bpo-31546 [https://bugs.python.org/issue?@action=redirect&bpo=31546]: 恢复在提示符等待用户输入时运行PyOS_InputHook。这恢复了交互式GUI窗口（如Matplotlib图形）与Windows上提示符的集成。

bpo-30237 [https://bugs.python.org/issue?@action=redirect&bpo=30237]: 当ReadConsole被CancelSynchronousIo取消时输出错误而不是崩溃。

bpo-33895 [https://bugs.python.org/issue?@action=redirect&bpo=33895]: 在调用获取Windows加载器锁的函数时释放GIL。

bpo-33720 [https://bugs.python.org/issue?@action=redirect&bpo=33720]: 减少发布版本上的最大marshal递归深度。

bpo-29097 [https://bugs.python.org/issue?@action=redirect&bpo=29097]: 修复 datetime.fromtimestamp() 在Windows上对0到86400之间的值错误抛出 OSError 的bug。由Ammar Askar提供补丁。

bpo-33316 [https://bugs.python.org/issue?@action=redirect&bpo=33316]: PyThread_release_lock总是失败

bpo-33184 [https://bugs.python.org/issue?@action=redirect&bpo=33184]: 更新Windows安装程序以使用OpenSSL 1.1.0h。

bpo-32890 [https://bugs.python.org/issue?@action=redirect&bpo=32890]: 修复os.execve()和os.truncate()中使用GetLastError()而不是errno的问题。

bpo-33016 [https://bugs.python.org/issue?@action=redirect&bpo=33016]: 修复nt._getfinalpathname中潜在使用未初始化内存的问题。

bpo-32903 [https://bugs.python.org/issue?@action=redirect&bpo=32903]: 修复如果当前目录设置为UNC路径时Windows上os.chdir()的内存泄漏。

bpo-32901 [https://bugs.python.org/issue?@action=redirect&bpo=32901]: 将Tcl和Tk版本更新到8.6.8

bpo-31966 [https://bugs.python.org/issue?@action=redirect&bpo=31966]: 修复WindowsConsoleIO.write()写入空数据的问题。

bpo-32409 [https://bugs.python.org/issue?@action=redirect&bpo=32409]: 确保activate.bat可以处理Unicode内容。

bpo-32457 [https://bugs.python.org/issue?@action=redirect&bpo=32457]: 改进启动Python时对非规范化可执行路径的处理。

bpo-32370 [https://bugs.python.org/issue?@action=redirect&bpo=32370]: 在uuid模块中为ipconfig输出使用正确的编码。由Segev Finer提交补丁。

bpo-29248 [https://bugs.python.org/issue?@action=redirect&bpo=29248]: 修复Windows上的 os.readlink()，它错误地将重新解析数据缓冲区的``PrintNameOffset`` 字段视为字符数而非字节数。由Craig Holmquist和SSE4提交补丁。

bpo-1104 [https://bugs.python.org/issue?@action=redirect&bpo=1104]: 正确处 msilib.SummaryInfo.GetProperty() 中的字符串长度，以防止其截断最后一个字符。

macOS

bpo-35401 [https://bugs.python.org/issue?@action=redirect&bpo=35401]: 更新macOS安装程序以使用OpenSSL 1.1.0j。

bpo-35025 [https://bugs.python.org/issue?@action=redirect&bpo=35025]: 在macOS上正确保护 timemodule 中使用 CLOCK_GETTIME 等宏。

bpo-24658 [https://bugs.python.org/issue?@action=redirect&bpo=24658]: 在macOS上，修复从大小超过2 GiB的文件读取和写入的问题。

bpo-34405 [https://bugs.python.org/issue?@action=redirect&bpo=34405]: 为macOS安装程序构建更新至OpenSSL 1.1.0i。

bpo-33635 [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也扩展了相同的错误忽略模式。

bpo-13631 [https://bugs.python.org/issue?@action=redirect&bpo=13631]: 在macOS上通过editline模拟初始化readline时，现在可以正确处理用户主目录中的.editrc文件。

bpo-33184 [https://bugs.python.org/issue?@action=redirect&bpo=33184]: 更新macOS安装程序构建以使用OpenSSL 1.1.0h。

bpo-32726 [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。

bpo-32901 [https://bugs.python.org/issue?@action=redirect&bpo=32901]: 将macOS 10.9+安装程序更新至Tcl/Tk 8.6.8。

bpo-31903 [https://bugs.python.org/issue?@action=redirect&bpo=31903]: In _scproxy, drop the GIL when calling into SystemConfiguration to avoid deadlocks.

IDLE

bpo-35770 [https://bugs.python.org/issue?@action=redirect&bpo=35770]: IDLE在macosx上删除了选项 => 配置IDLE。之前错误地删除了窗口 => 缩放高度（缩放高度现在在选项菜单中）。在Mac上，设置对话框通过IDLE菜单中的偏好设置访问。

bpo-35769 [https://bugs.python.org/issue?@action=redirect&bpo=35769]: 将IDLE的新文件名从'Untitled'改为'untitled'。

bpo-35660 [https://bugs.python.org/issue?@action=redirect&bpo=35660]: 修复idlelib.window中的导入。

bpo-35641 [https://bugs.python.org/issue?@action=redirect&bpo=35641]: Proper format calltip when the function has no docstring.

bpo-33987 [https://bugs.python.org/issue?@action=redirect&bpo=33987]: 为ttk小部件使用ttk框架。

bpo-34055 [https://bugs.python.org/issue?@action=redirect&bpo=34055]: 修复IDLE Shell中错误的'智能'缩进和换行。

bpo-35591 [https://bugs.python.org/issue?@action=redirect&bpo=35591]: 现在，当未找到选择时，查找选择也能工作。

bpo-35196 [https://bugs.python.org/issue?@action=redirect&bpo=35196]: 加速squeezer的行计数。

bpo-35598 [https://bugs.python.org/issue?@action=redirect&bpo=35598]: 更新config_key：使用PEP 8命名和ttk小部件，使一些对象全局化，并添加测试。

bpo-28097 [https://bugs.python.org/issue?@action=redirect&bpo=28097]: 在Shell菜单中添加上一个/下一个历史记录条目。

bpo-35208 [https://bugs.python.org/issue?@action=redirect&bpo=35208]: Squeezer现在在新行之前正确计算换行。

bpo-35555 [https://bugs.python.org/issue?@action=redirect&bpo=35555]: 当代码上下文菜单条目不适用时，将其置灰。

bpo-35521 [https://bugs.python.org/issue?@action=redirect&bpo=35521]: 记录IDLE编辑器代码上下文功能。在IDLE文档中添加一些内部引用。

bpo-22703 [https://bugs.python.org/issue?@action=redirect&bpo=22703]: 代码上下文菜单标签现在在显示/隐藏代码上下文之间切换。缩放高度菜单现在在缩放/恢复高度之间切换。缩放高度已从窗口菜单移动到选项菜单。

bpo-35213 [https://bugs.python.org/issue?@action=redirect&bpo=35213]: 在适当的地方，在idlelib中使用'macOS'。

bpo-34864 [https://bugs.python.org/issue?@action=redirect&bpo=34864]: 在macOS上，如果系统偏好设置“打开文档时偏好标签页”设置为“总是”，则发出警告。

bpo-34864 [https://bugs.python.org/issue?@action=redirect&bpo=34864]: 记录两个在MacOS上的IDLE问题。系统偏好设置Dock“总是偏好标签页”设置禁用了一些IDLE功能。菜单与Windows和Linux的描述有些不同。

bpo-35202 [https://bugs.python.org/issue?@action=redirect&bpo=35202]: 从lib/idlelib中移除未使用的导入。

bpo-33000 [https://bugs.python.org/issue?@action=redirect&bpo=33000]: 记录IDLE的Shell没有行限制。一个无限运行的程序可能会耗尽内存。

bpo-23220 [https://bugs.python.org/issue?@action=redirect&bpo=23220]: 解释IDLE的Shell如何显示输出。

bpo-35099 [https://bugs.python.org/issue?@action=redirect&bpo=35099]: Improve the doc about IDLE running user code. The section is renamed from "IDLE -- console differences" is renamed "Running user code". It mostly covers the implications of using custom sys.stdxxx objects.

bpo-35097 [https://bugs.python.org/issue?@action=redirect&bpo=35097]: 在IDLE文档中添加解释编辑器窗口的子章节。主题包括打开、标题和状态栏、.py*扩展名以及运行。

bpo-35093 [https://bugs.python.org/issue?@action=redirect&bpo=35093]: 在IDLE文档中记录IDLE文档查看器。在“帮助和偏好设置”中的“帮助来源”子部分添加一段。

bpo-35088 [https://bugs.python.org/issue?@action=redirect&bpo=35088]: 更新idlelib.help.copy_string的文档字符串。我们现在使用git和后向移植而不是hg和前向合并。

bpo-35087 [https://bugs.python.org/issue?@action=redirect&bpo=35087]: 为当前文档构建更新idlelib帮助文件。主要变化是消除了章节-节号。

bpo-34548 [https://bugs.python.org/issue?@action=redirect&bpo=34548]: 为只读文本视图使用配置的颜色主题。

bpo-1529353 [https://bugs.python.org/issue?@action=redirect&bpo=1529353]: 启用shell中长输出的“压缩”，以避免性能下降并在不丢失历史记录的情况下清理历史。压缩的输出可以复制、在单独窗口中查看并“解压”。

bpo-34047 [https://bugs.python.org/issue?@action=redirect&bpo=34047]: 修复了macOS上鼠标滚轮的滚动方向。

bpo-34275 [https://bugs.python.org/issue?@action=redirect&bpo=34275]: 使IDLE的调用提示在Mac上始终可见。某些MacOS-tk组合需要.update_idletasks()。由Kevin Walzer提供的补丁。

bpo-34120 [https://bugs.python.org/issue?@action=redirect&bpo=34120]: 修复关闭某些窗口和对话框后的无响应问题。

bpo-33975 [https://bugs.python.org/issue?@action=redirect&bpo=33975]: 在运行htests时避免小字体。由于人类查看测试的部分目的是确定小部件看起来是否正确，因此重要的是它们在测试时看起来与运行IDLE时相同。

bpo-33905 [https://bugs.python.org/issue?@action=redirect&bpo=33905]: 为idlelib.stackview.StackBrowser添加测试。

bpo-33924 [https://bugs.python.org/issue?@action=redirect&bpo=33924]: 将mainmenu.menudefs键'windows'更改为'window'。每个其他menudef键都是主菜单项的小写版本。

bpo-33906 [https://bugs.python.org/issue?@action=redirect&bpo=33906]: 将idlelib.windows重命名为window，以匹配主菜单上的Window，并移除最后一个复数模块名称。

bpo-33917 [https://bugs.python.org/issue?@action=redirect&bpo=33917]: 修复并记录idlelib/idle_test/template.py。修订后的文件编译、运行和测试均正常。idle_test/README.txt说明了如何使用它来创建新的IDLE测试文件。

bpo-33904 [https://bugs.python.org/issue?@action=redirect&bpo=33904]: IDLE：在rstrip中，将类RstripExtension重命名为Rstrip

bpo-33907 [https://bugs.python.org/issue?@action=redirect&bpo=33907]: 为了保持一致性和清晰度，重命名一个IDLE模块和类。模块calltips及其类CallTips现在更名为calltip和Calltip。在模块calltip_w中，类CallTip现在更名为CalltipWindow。

bpo-33856 [https://bugs.python.org/issue?@action=redirect&bpo=33856]: 在IDLE的欢迎消息中添加“帮助”

bpo-33839 [https://bugs.python.org/issue?@action=redirect&bpo=33839]: IDLE：重构ToolTip和CallTip并添加文档和测试

bpo-33855 [https://bugs.python.org/issue?@action=redirect&bpo=33855]: 对所有IDLE模块进行最小化测试。添加缺失的文件，导入模块，实例化类，并检查覆盖率。检查现有文件。

bpo-33656 [https://bugs.python.org/issue?@action=redirect&bpo=33656]: 在Windows上，添加API调用表明tk针对DPI进行缩放。在Windows 8.1+或10上，Python二进制文件的DPI兼容性属性未更改，且显示器分辨率大于96 DPI时，这应使文本和线条更清晰。否则应无影响。

bpo-33768 [https://bugs.python.org/issue?@action=redirect&bpo=33768]: 点击上下文行将该行移动到编辑器窗口的顶部。

bpo-33763 [https://bugs.python.org/issue?@action=redirect&bpo=33763]: IDLE：使用只读文本小部件代替标签小部件作为代码上下文。

bpo-33664 [https://bugs.python.org/issue?@action=redirect&bpo=33664]: 按行滚动IDLE编辑器文本。之前，鼠标滚轮和滚动条滑块以固定像素数移动文本，导致编辑器盒顶部出现部分行。此更改也适用于shell和grep输出窗口，但不适用于只读文本视图。

bpo-33679 [https://bugs.python.org/issue?@action=redirect&bpo=33679]: 启用代码上下文的主题特定颜色配置。使用“高亮”选项卡查看内置主题的设置或为自定义主题添加设置。

bpo-33642 [https://bugs.python.org/issue?@action=redirect&bpo=33642]: 为代码上下文显示最多maxlines非空行。如果没有当前上下文，则显示单个空行。

bpo-33628 [https://bugs.python.org/issue?@action=redirect&bpo=33628]: IDLE：清理codecontext.py及其测试。

bpo-33564 [https://bugs.python.org/issue?@action=redirect&bpo=33564]: IDLE的代码上下文现在能识别async作为一个块的开头。

bpo-21474 [https://bugs.python.org/issue?@action=redirect&bpo=21474]: 将单词/标识符的定义从ASCII更新为Unicode。在文本和输入框中，这会影响通过双击选择、通过control-left/right左右移动以及通过control-BACKSPACE/DEL左右删除。

bpo-33204 [https://bugs.python.org/issue?@action=redirect&bpo=33204]: IDLE：一致地着色无效的字符串前缀。'u'字符串前缀不能与'r'或'f'配对。从右边开始，尽可能多地着色有效的部分。修订并扩展颜色化器测试。

bpo-32984 [https://bugs.python.org/issue?@action=redirect&bpo=32984]: 在运行启动文件时设置 __file__。与Python一样，IDLE在展示第一个交互式输入提示之前，可选地在Shell窗口中运行一个启动文件。对于IDLE，-s``运行环境变量 :envvar:`IDLESTARTUP` 或 :envvar:`PYTHONSTARTUP` 中命名的文件；-r file`` 运行 file。Python在运行文件之前将 __file__ 设置为启动文件名，并在第一个提示之前取消设置。IDLE现在在没有 -n 选项的情况下正常运行时也会这样做。

bpo-32940 [https://bugs.python.org/issue?@action=redirect&bpo=32940]: 在pyparse中简化并重命名StringTranslatePseudoMapping。

bpo-32916 [https://bugs.python.org/issue?@action=redirect&bpo=32916]: 在pyparse中将 str 更改为 code。

bpo-32905 [https://bugs.python.org/issue?@action=redirect&bpo=32905]: 移除pyparse模块中未使用的代码。

bpo-32874 [https://bugs.python.org/issue?@action=redirect&bpo=32874]: 为pyparse添加测试。

bpo-32837 [https://bugs.python.org/issue?@action=redirect&bpo=32837]: 对于IDLE的系统和位置无关文件，使用系统和位置相关的默认编码对于open()来说是一个坏主意。

bpo-32826 [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字符。

bpo-32831 [https://bugs.python.org/issue?@action=redirect&bpo=32831]: 为codecontext添加文档字符串和测试。

bpo-32765 [https://bugs.python.org/issue?@action=redirect&bpo=32765]: 更新configdialog General标签的文档字符串，将新部件添加到部件列表中。

工具/示例

bpo-35884 [https://bugs.python.org/issue?@action=redirect&bpo=35884]: 添加一个基准测试脚本，用于计时访问变量的各种方式：Tools/scripts/var_access_benchmark.py。

bpo-34989 [https://bugs.python.org/issue?@action=redirect&bpo=34989]: python-gdb.py 现在可以处理计算 Python 帧行号时的错误。

bpo-20260 [https://bugs.python.org/issue?@action=redirect&bpo=20260]: Argument Clinic 现在有了非位无符号整型转换器。

bpo-32962 [https://bugs.python.org/issue?@action=redirect&bpo=32962]: python-gdb 现在在调用 string() 时会捕获 UnicodeDecodeError 异常。

bpo-32962 [https://bugs.python.org/issue?@action=redirect&bpo=32962]: python-gdb 现在会在 read_var() 上捕获 ValueError：例如当 Python 没有调试符号时。

bpo-33189 [https://bugs.python.org/issue?@action=redirect&bpo=33189]: pygettext.py 现在只识别字面字符串作为文档字符串和可翻译字符串，并拒绝字节字面量和 f-string 表达式。

bpo-31920 [https://bugs.python.org/issue?@action=redirect&bpo=31920]: 修复了 pygettext 脚本中将目录作为参数处理的问题。基于 Oleg Krasnikov 的补丁。

bpo-29673 [https://bugs.python.org/issue?@action=redirect&bpo=29673]: 修复 pystackv 和 pystack gdbinit 宏。

bpo-25427 [https://bugs.python.org/issue?@action=redirect&bpo=25427]: 移除 pyvenv 脚本，转而使用 python3 -m venv，以减少关于虚拟环境将为哪个 Python 解释器创建的混淆。

bpo-32885 [https://bugs.python.org/issue?@action=redirect&bpo=32885]: 为 Tools/scripts/pathfix.py 添加 -n 标志以禁用自动备份创建（带有 ~ 后缀的文件）。

bpo-32222 [https://bugs.python.org/issue?@action=redirect&bpo=32222]: 修复 pygettext 不提取带有类型注释参数的函数的文档字符串的问题。由 Toby Harradine 提供的补丁。

bpo-31583 [https://bugs.python.org/issue?@action=redirect&bpo=31583]: 修复 2to3 在使用 --add-suffix 选项但没有 --output-dir 选项时对当前目录中文件的相对路径的处理。

C API

bpo-35713 [https://bugs.python.org/issue?@action=redirect&bpo=35713]: The PyByteArray_Init() and PyByteArray_Fini() functions have been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were excluded from the limited API (stable ABI), and were not documented.

bpo-33817 [https://bugs.python.org/issue?@action=redirect&bpo=33817]: 修复了 _PyBytes_Resize() 对于空字节对象的处理。

bpo-35322 [https://bugs.python.org/issue?@action=redirect&bpo=35322]: 修复 PyUnicode_EncodeLocale() 和 PyUnicode_EncodeFSDefault() 在错误处理中的内存泄漏。

bpo-35059 [https://bugs.python.org/issue?@action=redirect&bpo=35059]: 以下 C 宏已转换为静态内联函数： Py_INCREF(), Py_DECREF(), Py_XINCREF(), Py_XDECREF(), PyObject_INIT(), PyObject_INIT_VAR()。

bpo-35296 [https://bugs.python.org/issue?@action=redirect&bpo=35296]: make install 现在也会安装内部 API：Include/internal/*.h 头文件。

bpo-35081 [https://bugs.python.org/issue?@action=redirect&bpo=35081]: 被 #ifdef Py_BUILD_CORE 包围的内部 API 已经从 Include/*.h 头文件移动到了新的头文件 Include/internal/pycore_*.h 中。

bpo-35259 [https://bugs.python.org/issue?@action=redirect&bpo=35259]: 根据 Py_LIMITED_API 有条件地声明 :c:func:`Py_FinalizeEx()`（3.6 新增）。补丁由 Arthur Neufeld 提供。

bpo-35081 [https://bugs.python.org/issue?@action=redirect&bpo=35081]: The _PyObject_GC_TRACK() and _PyObject_GC_UNTRACK() macros have been removed from the public C API.

bpo-35134 [https://bugs.python.org/issue?@action=redirect&bpo=35134]: 创建了一个新的 Include/cpython/ 子目录。

bpo-34725 [https://bugs.python.org/issue?@action=redirect&bpo=34725]: 添加了 _Py_SetProgramFullPath 以便嵌入者可以覆盖 sys.executable

bpo-34910 [https://bugs.python.org/issue?@action=redirect&bpo=34910]: 确保 PyObject_Print() 在出错时总是返回 -1。由 Zackery Spytz 提供补丁。

bpo-34523 [https://bugs.python.org/issue?@action=redirect&bpo=34523]: 如果 Py_LegacyWindowsFSEncodingFlag 为零，Py_DecodeLocale() 和 Py_EncodeLocale() 现在在 Windows 上使用 UTF-8 编码。

bpo-34193 [https://bugs.python.org/issue?@action=redirect&bpo=34193]: 修复了 getargs.c 和 typeobject.c 中 TypeError 消息的单复数形式：'1 个参数' 代替 '1 个参数s' 和 '1 个元素' 代替 '1 个元素s'。

bpo-34127 [https://bugs.python.org/issue?@action=redirect&bpo=34127]: 根据参数数量返回语法正确的错误消息。由 Karthikeyan Singaravelan 提供补丁。

bpo-23927 [https://bugs.python.org/issue?@action=redirect&bpo=23927]: 修复了当 w* 格式单元用于可选参数时 PyArg_ParseTupleAndKeywords() 中的 SystemError。

bpo-32455 [https://bugs.python.org/issue?@action=redirect&bpo=32455]: 添加了 PyCompile_OpcodeStackEffectWithJump()。

bpo-34008 [https://bugs.python.org/issue?@action=redirect&bpo=34008]: Py_Main() 可以再次在 Py_Initialize() 之后被调用，就像在 Python 3.6 中一样。

bpo-32500 [https://bugs.python.org/issue?@action=redirect&bpo=32500]: 修复了当 PySequence_Size()、PySequence_GetItem()、PySequence_SetItem() 和 PySequence_DelItem() 被映射调用以及 PyMapping_Size() 被序列调用时的错误消息。

bpo-33818 [https://bugs.python.org/issue?@action=redirect&bpo=33818]: PyExceptionClass_Name() 现在将返回 const char * 而不是 char *。

bpo-33042 [https://bugs.python.org/issue?@action=redirect&bpo=33042]: 嵌入应用程序可以再次在调用 Py_Initialize 之前调用 PySys_ResetWarnOptions、PySys_AddWarnOption 和 PySys_AddXOption。

bpo-32374 [https://bugs.python.org/issue?@action=redirect&bpo=32374]: 文档说明多阶段初始化模块的 m_traverse 可以在 m_state=NULL 时调用，并添加健全性检查

bpo-30863 [https://bugs.python.org/issue?@action=redirect&bpo=30863]: PyUnicode_AsWideChar() 和 PyUnicode_AsWideCharString() 不再缓存字符串对象的 wchar_t* 表示。

Python 3.7.0 正式版

发布日期: 2018-06-27

库

bpo-33851 [https://bugs.python.org/issue?@action=redirect&bpo=33851]: 修复 ast.get_docstring() 对于缺少文档字符串的节点的问题。

C API

bpo-33932 [https://bugs.python.org/issue?@action=redirect&bpo=33932]: 调用 Py_Initialize() 两次不做任何操作，而不是以致命错误失败：恢复 Python 3.6 的行为。

Python 3.7.0 rc1

发布日期: 2018-06-12

核心与内置函数

bpo-33803 [https://bugs.python.org/issue?@action=redirect&bpo=33803]: 修复 hamt.c 中的一个崩溃问题，该问题是由于为一个对象启用 GC 跟踪时，其所有字段未设置为 NULL 引起的。

bpo-33706 [https://bugs.python.org/issue?@action=redirect&bpo=33706]: 修复解析命令行选项时 Python 初始化过程中的崩溃问题。感谢 Christoph Gohlke 的报告和修复！

bpo-30654 [https://bugs.python.org/issue?@action=redirect&bpo=30654]: 修复了即使之前设置了自定义处理程序，在解释器关闭时 SIGINT 处理程序重置为 SIG_DFL 的问题。由 Philipp Kerling 提供补丁。

bpo-31849 [https://bugs.python.org/issue?@action=redirect&bpo=31849]: 修复了 pyhash.c 中的有符号/无符号比较警告。

库

bpo-30167 [https://bugs.python.org/issue?@action=redirect&bpo=30167]: 如果设置了PYTHONSTARTUP，防止site.main()异常。由Steve Weber提供补丁。

bpo-33812 [https://bugs.python.org/issue?@action=redirect&bpo=33812]: 对于tzinfo非None但d.tzinfo.utcoffset(d)返回None的Datetime实例d，现在astimezone()方法将其视为naive。

bpo-30805 [https://bugs.python.org/issue?@action=redirect&bpo=30805]: 避免调试日志记录中的竞态条件

bpo-33694 [https://bugs.python.org/issue?@action=redirect&bpo=33694]: asyncio: 修复在使用ProactorEventLoop时，pause_reading()/resume_reading()导致数据丢失的竞态条件。

bpo-32493 [https://bugs.python.org/issue?@action=redirect&bpo=32493]: 在 configure.ac 中更正对 uuid_enc_be 可用性的测试。由Michael Felt提供补丁。

bpo-33792 [https://bugs.python.org/issue?@action=redirect&bpo=33792]: 添加asyncio.WindowsSelectorEventLoopPolicy和asyncio.WindowsProactorEventLoopPolicy。

bpo-33778 [https://bugs.python.org/issue?@action=redirect&bpo=33778]: 更新 unicodedata 的数据库至Unicode版本11.0.0。

bpo-33770 [https://bugs.python.org/issue?@action=redirect&bpo=33770]: 针对长度无效的编码输入，改进base64异常消息

bpo-33769 [https://bugs.python.org/issue?@action=redirect&bpo=33769]: asyncio/start_tls: 修复错误消息；在未处理错误的情况下取消回调；如果SSLTransport被中止，则标记为已关闭。

bpo-33767 [https://bugs.python.org/issue?@action=redirect&bpo=33767]: 在 mmap.mmap 对象上执行时，连接（+）和重复（*）序列操作现在会引发 TypeError 而不是 SystemError。由 Zackery Spytz 提供补丁。

bpo-33734 [https://bugs.python.org/issue?@action=redirect&bpo=33734]: asyncio/ssl：修复 AttributeError，增加默认的握手超时时间

bpo-11874 [https://bugs.python.org/issue?@action=redirect&bpo=11874]: 当将用法分解为可包装部分时使用更好的正则表达式。避免来自自定义 metavar 字符串的错误断言错误。

bpo-33582 [https://bugs.python.org/issue?@action=redirect&bpo=33582]: 为 inspect.formatargspec 发出弃用警告。

文档

bpo-33409 [https://bugs.python.org/issue?@action=redirect&bpo=33409]: 澄清了 PEP 538 [https://www.python.org/dev/peps/pep-0538] 的 PYTHONCOERCECLOCALE 和 PEP 540 的 PYTHONUTF8 模式之间的关系。

bpo-33736 [https://bugs.python.org/issue?@action=redirect&bpo=33736]: 改进了 asyncio.open_connection()、asyncio.start_server() 及其 UNIX 套接字对应函数的文档。

bpo-31432 [https://bugs.python.org/issue?@action=redirect&bpo=31432]: 澄清 ssl.SSLContext.verify_mode 的 CERT_NONE、CERT_OPTIONAL 和 CERT_REQUIRED 标志的含义。

构建

bpo-5755 [https://bugs.python.org/issue?@action=redirect&bpo=5755]: 将 -Wstrict-prototypes 选项从 OPT 移到 CFLAGS_NODIST。此选项在用C++编写扩展模块时会产生烦人的警告。

Windows

bpo-33720 [https://bugs.python.org/issue?@action=redirect&bpo=33720]: 减少发布版本上的最大marshal递归深度。

IDLE

bpo-33656 [https://bugs.python.org/issue?@action=redirect&bpo=33656]: 在Windows上，添加API调用表明tk针对DPI进行缩放。在Windows 8.1+或10上，Python二进制文件的DPI兼容性属性未更改，且显示器分辨率大于96 DPI时，这应使文本和线条更清晰。否则应无影响。

bpo-33768 [https://bugs.python.org/issue?@action=redirect&bpo=33768]: 点击上下文行将该行移动到编辑器窗口的顶部。

bpo-33763 [https://bugs.python.org/issue?@action=redirect&bpo=33763]: IDLE：使用只读文本小部件代替标签小部件作为代码上下文。

bpo-33664 [https://bugs.python.org/issue?@action=redirect&bpo=33664]: 按行滚动IDLE编辑器文本。之前，鼠标滚轮和滚动条滑块以固定像素数移动文本，导致编辑器盒顶部出现部分行。此更改也适用于shell和grep输出窗口，但不适用于只读文本视图。

bpo-33679 [https://bugs.python.org/issue?@action=redirect&bpo=33679]: 启用代码上下文的主题特定颜色配置。使用“高亮”选项卡查看内置主题的设置或为自定义主题添加设置。

bpo-33642 [https://bugs.python.org/issue?@action=redirect&bpo=33642]: 为代码上下文显示最多maxlines非空行。如果没有当前上下文，则显示单个空行。

Python 3.7.0 beta 5

发布日期: 2018-05-30

核心与内置函数

bpo-33622 [https://bugs.python.org/issue?@action=redirect&bpo=33622]: 修复了当垃圾收集器无法将带有 __del__ 方法或被其引用的对象添加到 gc.garbage 列表时的内存泄漏问题。现在可以在设置异常时调用 PyGC_Collect()，并保留异常。

bpo-33509 [https://bugs.python.org/issue?@action=redirect&bpo=33509]: 修复了 warnings.warn_explicit() 的 module_globals 参数：如果 module_globals 不是字典，不会崩溃。

bpo-20104 [https://bugs.python.org/issue?@action=redirect&bpo=20104]: The new os.posix_spawn added in 3.7.0b1 was removed as we are still working on what the API should look like. Expect this in 3.8 instead.

bpo-33475 [https://bugs.python.org/issue?@action=redirect&bpo=33475]: 修复了将注释转换为字符串时的杂项错误，并优化了字符串表示中的括号。

bpo-33391 [https://bugs.python.org/issue?@action=redirect&bpo=33391]: 修复了 set_symmetric_difference() 中的内存泄漏。

bpo-28055 [https://bugs.python.org/issue?@action=redirect&bpo=28055]: 修复了 siphash24() 中的未对齐访问。由 Rolf Eike Beer 提供补丁。

bpo-32911 [https://bugs.python.org/issue?@action=redirect&bpo=32911]: 由于在下游beta测试期间发现的意外兼容性问题，恢复了 bpo-29463 [https://bugs.python.org/issue?@action=redirect&bpo=29463]。从Module、ClassDef、FunctionDef和AsyncFunctionDef ast节点中移除了在3.7a1中添加的`docstring` 字段。docstring表达式被恢复为其主体的第一条语句。基于Inada Naoki的补丁。

bpo-21983 [https://bugs.python.org/issue?@action=redirect&bpo=21983]: Fix a crash in ctypes.cast() in case the type argument is a ctypes structured data type. Patch by Eryk Sun and Oren Milman.

库

bpo-32751 [https://bugs.python.org/issue?@action=redirect&bpo=32751]: 当由于超时取消任务时，asyncio.wait_for() 现在将等待直到取消完成。

bpo-32684 [https://bugs.python.org/issue?@action=redirect&bpo=32684]: 修复 gather 即使在 return_exceptions 的情况下也能传播自身的取消。

bpo-33654 [https://bugs.python.org/issue?@action=redirect&bpo=33654]: 在 SSLTransport.set_protocol() 中支持协议类型切换。

bpo-33674 [https://bugs.python.org/issue?@action=redirect&bpo=33674]: 尽早暂停传输，以进一步降低在 connection_made() 之前调用 data_received() 的风险。

bpo-33674 [https://bugs.python.org/issue?@action=redirect&bpo=33674]: 修复 asyncio.sslproto 中 SSLProtocol.connection_made() 的竞态条件：立即开始握手而不是使用 call_soon()。之前，data_received() 可能在握手开始前被调用，导致握手挂起或失败。

bpo-31647 [https://bugs.python.org/issue?@action=redirect&bpo=31647]: 修复了在 _SelectorSocketTransport 已经关闭后调用 write_eof() 会引发 AttributeError 的错误。

bpo-32610 [https://bugs.python.org/issue?@action=redirect&bpo=32610]: 使 asyncio.all_tasks() 仅返回待处理的任务。

bpo-32410 [https://bugs.python.org/issue?@action=redirect&bpo=32410]: 在 sendfile 回退代码中避免阻塞文件 IO。

bpo-33469 [https://bugs.python.org/issue?@action=redirect&bpo=33469]: 修复了使用 run_in_executor 后关闭循环时引发的 RuntimeError。

bpo-33672 [https://bugs.python.org/issue?@action=redirect&bpo=33672]: 修复 Task.__repr__ 与 Cython 的虚假协程一起使用时崩溃的问题。

bpo-33654 [https://bugs.python.org/issue?@action=redirect&bpo=33654]: 修复 transport.set_protocol() 以支持在 asyncio.Protocol 和 asyncio.BufferedProtocol 之间切换。修复 loop.start_tls() 以支持 asyncio.BufferedProtocols。

bpo-33652 [https://bugs.python.org/issue?@action=redirect&bpo=33652]: 类型变量和下标泛型的 pickle 现在具有未来兼容性，并与旧版 Python 兼容。

bpo-32493 [https://bugs.python.org/issue?@action=redirect&bpo=32493]: 修复了 FreeBSD 上的 uuid.uuid1()。

bpo-33618 [https://bugs.python.org/issue?@action=redirect&bpo=33618]: 完成并记录与 OpenSSL 1.1.1 的初步和实验性 TLS 1.3 支持。

bpo-33623 [https://bugs.python.org/issue?@action=redirect&bpo=33623]: 修复在 __del__ 中创建 asyncio.Future 时可能出现的 SIGSGV。

bpo-30877 [https://bugs.python.org/issue?@action=redirect&bpo=30877]: 修复了 JSON 解码器 Python 实现中的一个错误，该错误阻止了在完成解码后清除已解析字符串的缓存。基于 c-fos 的补丁。

bpo-33570 [https://bugs.python.org/issue?@action=redirect&bpo=33570]: 更改 TLS 1.3 密码套件设置，以兼容 OpenSSL 1.1.1-pre6 及更新版本。OpenSSL 1.1.1 将默认启用 TLS 1.3 密码。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: Do not simplify arguments to typing.Union. Now Union[Manager, Employee] is not simplified to Employee at runtime. Such simplification previously caused several bugs and limited possibilities for introspection.

bpo-33540 [https://bugs.python.org/issue?@action=redirect&bpo=33540]: 向 socketserver 的 ForkingMixIn 和 ThreadingMixIn 类添加一个新的 block_on_close 类属性。

bpo-33548 [https://bugs.python.org/issue?@action=redirect&bpo=33548]: tempfile._candidate_tempdir_list 应考虑常见的 TEMP 位置

bpo-33109 [https://bugs.python.org/issue?@action=redirect&bpo=33109]: argparse 子解析器默认再次不需要，恢复了在 3.7.0a2 中由 bpo-26510 [https://bugs.python.org/issue?@action=redirect&bpo=26510] 引入的行为变化。

bpo-33536 [https://bugs.python.org/issue?@action=redirect&bpo=33536]: dataclasses.make_dataclass 现在检查无效的字段名和重复的字段。此外，添加了对无效字段规范的检查。

bpo-33542 [https://bugs.python.org/issue?@action=redirect&bpo=33542]: 防止 uuid.get_node 在 Windows 上使用 DUID 而不是 MAC。由 Zvi Effron 提供补丁

bpo-26819 [https://bugs.python.org/issue?@action=redirect&bpo=26819]: Fix race condition with ReadTransport.resume_reading in Windows proactor event loop.

Fix failure in typing.get_type_hints() when ClassVar was provided as a string forward reference.

bpo-33505 [https://bugs.python.org/issue?@action=redirect&bpo=33505]: 通过重新排序if检查优化asyncio.ensure_future()：速度提升1.17倍。

bpo-33497 [https://bugs.python.org/issue?@action=redirect&bpo=33497]: 向cgi.parse_multipart添加errors参数，并使FieldStorage中的编码使用给定的errors（Twisted所需）。由Amber Brown提供补丁。

bpo-33495 [https://bugs.python.org/issue?@action=redirect&bpo=33495]: 更改dataclasses.Fields的repr以使用其每个成员的repr，而非str。这使得每个字段实际代表的内容更加清晰。这对于'type'成员尤为明显。

bpo-33453 [https://bugs.python.org/issue?@action=redirect&bpo=33453]: 修复dataclasses以在使用字面字符串类型注解或使用PEP 563“推迟的注解评估”时工作。仅为ClassVar（"ClassVar"和"typing.ClassVar"）和InitVar（"InitVar"和"dataclasses.InitVar"）检测特定的字符串前缀。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing模块中的小修复：向 NamedTuple.__new__ 添加注解，在``Generic.__new__``中传递 *args 和 **kwds。原始PR由Paulius Šarka和Chad Dombrova提供。

bpo-20087 [https://bugs.python.org/issue?@action=redirect&bpo=20087]: 更新了支持glibc 2.27地区设置的别名映射。

bpo-33422 [https://bugs.python.org/issue?@action=redirect&bpo=33422]: 修复在pydoc上查找字节/字符串字面量时尾随引号被删除的问题。由Andrés Delfino提供补丁。

bpo-28167 [https://bugs.python.org/issue?@action=redirect&bpo=28167]: 函数 platform.linux_distribution 和 platform.dist 现在触发``DeprecationWarning``，并已被标记为在Python 3.8中移除。

bpo-33197 [https://bugs.python.org/issue?@action=redirect&bpo=33197]: Update error message when constructing invalid inspect.Parameters Patch by Dong-hee Na.

bpo-33263 [https://bugs.python.org/issue?@action=redirect&bpo=33263]: Fix FD leak in _SelectorSocketTransport Patch by Vlad Starostin.

bpo-32861 [https://bugs.python.org/issue?@action=redirect&bpo=32861]: urllib.robotparser 的 __str__ 表示现在包括通配符条目以及 "Crawl-delay" 和 "Request-rate" 字段。由 Michael Lazar 提供补丁。

bpo-32257 [https://bugs.python.org/issue?@action=redirect&bpo=32257]: ssl模块现在包含OP_NO_RENEGOTIATION常量，适用于OpenSSL 1.1.0h或1.1.1版本。

bpo-16865 [https://bugs.python.org/issue?@action=redirect&bpo=16865]: 在 ctypes 中支持>=2GiB的数组。由Segev Finer提供补丁。

文档

bpo-23859 [https://bugs.python.org/issue?@action=redirect&bpo=23859]: Document that asyncio.wait() does not cancel its futures on timeout.

bpo-32436 [https://bugs.python.org/issue?@action=redirect&bpo=32436]: 文档说明 PEP 567 [https://www.python.org/dev/peps/pep-0567] 对 asyncio 的更改。

bpo-33604 [https://bugs.python.org/issue?@action=redirect&bpo=33604]: 将 HMAC md5 的默认警告更新为 DeprecationWarning，移除时间推迟到 3.8。

bpo-33503 [https://bugs.python.org/issue?@action=redirect&bpo=33503]: 修复损坏的 pypi 链接

bpo-33421 [https://bugs.python.org/issue?@action=redirect&bpo=33421]: 为 typing.AsyncContextManager 添加缺失的文档。

测试

bpo-33655 [https://bugs.python.org/issue?@action=redirect&bpo=33655]: 忽略在可能由于在 ZFS 上运行而导致的 BSD 平台上的 test_posix_fallocate 失败。

bpo-32604 [https://bugs.python.org/issue?@action=redirect&bpo=32604]: 移除 _xxsubinterpreters 模块（用于测试）和相关的辅助工具。此模块最近在 3.7b1 中添加。

构建

bpo-33614 [https://bugs.python.org/issue?@action=redirect&bpo=33614]: 确保Windows上稳定ABI的模块定义文件被正确重新生成。

bpo-33522 [https://bugs.python.org/issue?@action=redirect&bpo=33522]: 在https://python.visualstudio.com/cpython上启用Visual Studio Team Services的CI构建。

bpo-33012 [https://bugs.python.org/issue?@action=redirect&bpo=33012]: 为 gcc 8 添加 -Wno-cast-function-type 以静默关于函数类型转换的警告，如在方法定义列表中转换为 PyCFunction 的警告。

macOS

bpo-13631 [https://bugs.python.org/issue?@action=redirect&bpo=13631]: 在macOS上通过editline模拟初始化readline时，现在可以正确处理用户主目录中的.editrc文件。

IDLE

bpo-33628 [https://bugs.python.org/issue?@action=redirect&bpo=33628]: IDLE：清理codecontext.py及其测试。

bpo-33564 [https://bugs.python.org/issue?@action=redirect&bpo=33564]: IDLE的代码上下文现在能识别async作为一个块的开头。

bpo-32831 [https://bugs.python.org/issue?@action=redirect&bpo=32831]: 为codecontext添加文档字符串和测试。

Python 3.7.0 beta 4

发布日期: 2018-05-02

核心与内置函数

bpo-33363 [https://bugs.python.org/issue?@action=redirect&bpo=33363]: 对于异步函数外的 async with 和 async for 语句，现在会引发 SyntaxError。

bpo-33128 [https://bugs.python.org/issue?@action=redirect&bpo=33128]: 修复了一个导致 PathFinder 在 sys.meta_path 上出现两次的 bug。由 Pablo Galindo Salgado 提供补丁。

bpo-33312 [https://bugs.python.org/issue?@action=redirect&bpo=33312]: 通过调整内部结构 _dictkeysobject 共享键结构的声明方式，修复了 dictobject.c 中的 clang ubsan（未定义行为消毒剂）警告。

bpo-33231 [https://bugs.python.org/issue?@action=redirect&bpo=33231]: 修复了 normalizestring() 中潜在的内存泄漏问题。

bpo-33205 [https://bugs.python.org/issue?@action=redirect&bpo=33205]: 将字典增长函数从 round_up_to_power_2(used*2+hashtable_size/2) 更改为 round_up_to_power_2(used*3)。 在之前版本中，字典仅在 used == 0 时才收缩。 现在字典有更多机会被收缩。

bpo-29922 [https://bugs.python.org/issue?@action=redirect&bpo=29922]: 改进了'async with'中当 __aenter__() 或 __aexit__() 返回不可等待对象时的错误消息。

bpo-33199 [https://bugs.python.org/issue?@action=redirect&bpo=33199]: 修复了在从键共享字典复制时，字典实现中的 ma_version_tag 未初始化的问题。

库

bpo-33281 [https://bugs.python.org/issue?@action=redirect&bpo=33281]: 修复macOS上ctypes.util.find_library的回归问题。

bpo-33383 [https://bugs.python.org/issue?@action=redirect&bpo=33383]: 修复了当使用单个参数调用 dbm.ndbm 数据库对象的get()方法时崩溃的问题。

bpo-33329 [https://bugs.python.org/issue?@action=redirect&bpo=33329]: 修复了在新版 glibc 上的多进程回归问题。

bpo-991266 [https://bugs.python.org/issue?@action=redirect&bpo=991266]: 修复了 http.cookies.SimpleCookie 的 Comment 属性的引用问题。

bpo-33131 [https://bugs.python.org/issue?@action=redirect&bpo=33131]: 将捆绑的 pip 版本升级至 10.0.1。

bpo-33308 [https://bugs.python.org/issue?@action=redirect&bpo=33308]: 修复了 parser 模块在将 ST 对象转换为元组或列表树时，当 line_info=False 且 col_info=True 时的崩溃问题。

bpo-33266 [https://bugs.python.org/issue?@action=redirect&bpo=33266]: lib2to3 现在能识别 rf'...' 字符串。

bpo-11594 [https://bugs.python.org/issue?@action=redirect&bpo=11594]: 确保在使用 lib2to3 时尊重行尾。

bpo-33254 [https://bugs.python.org/issue?@action=redirect&bpo=33254]: 让 importlib.resources.contents() 和 importlib.abc.ResourceReader.contents() 返回一个 iterable 而不是 iterator。

bpo-33256 [https://bugs.python.org/issue?@action=redirect&bpo=33256]: 修复了 cgitb.html() 生成的 html 中 <module> 调用的显示问题。补丁由 Stéphane Blondon 提供。

bpo-33185 [https://bugs.python.org/issue?@action=redirect&bpo=33185]: 修复了使用 -m 开关运行 pydoc 时的回归问题。（此回归问题由 bpo-33053 [https://bugs.python.org/issue?@action=redirect&bpo=33053] 的解决在 3.7.0b3 中引入）此修复还更改了 pydoc，在必要时将 os.getcwd() 添加到 sys.path 中，而不是添加 "."。

bpo-33169 [https://bugs.python.org/issue?@action=redirect&bpo=33169]: 当调用 importlib.machinery.invalidate_caches() 时，删除 sys.path_importer_cache 中的 None 条目。

bpo-33217 [https://bugs.python.org/issue?@action=redirect&bpo=33217]: 弃用在 Enum 类和 Enum 成员中查找非 Enum 对象的行为（在 3.8+ 中将引发 TypeError）。

bpo-33203 [https://bugs.python.org/issue?@action=redirect&bpo=33203]: random.Random.choice() 现在对于空序列会一致地引发 IndexError，即使是从没有 getrandbits() 实现的子类中调用也是如此。

bpo-33224 [https://bugs.python.org/issue?@action=redirect&bpo=33224]: 为 PEP 479 [https://www.python.org/dev/peps/pep-0479] 更新 difflib.mdiff()。将生成器中未捕获的 StopIteration 转换为 return 语句。

bpo-33209 [https://bugs.python.org/issue?@action=redirect&bpo=33209]: 在 pickle.Pickler.dump() 的 C 实现结束时结束帧。

bpo-20104 [https://bugs.python.org/issue?@action=redirect&bpo=20104]: Improved error handling and fixed a reference leak in os.posix_spawn().

bpo-33175 [https://bugs.python.org/issue?@action=redirect&bpo=33175]: 在数据类中，Field.__set_name__ 现在查找默认值的类上的 __set_name__ 特殊方法，而不是实例上的。

bpo-33097 [https://bugs.python.org/issue?@action=redirect&bpo=33097]: 在解释器关闭期间调用 executor.submit 时抛出RuntimeError。

bpo-31908 [https://bugs.python.org/issue?@action=redirect&bpo=31908]: 修复了 trace 模块命令行工具的封面文件输出。之前仅在使用了 --missing 选项时才会发出封面文件。由Michael Selik提供补丁。

文档

bpo-33378 [https://bugs.python.org/issue?@action=redirect&bpo=33378]: 为 https://docs.python.org/3/ 添加韩语语言切换器。

bpo-33276 [https://bugs.python.org/issue?@action=redirect&bpo=33276]: 澄清模块上的 __path__ 属性不能是任意值。

bpo-33201 [https://bugs.python.org/issue?@action=redirect&bpo=33201]: 现代化编写 C 扩展类型的文档。

bpo-33195 [https://bugs.python.org/issue?@action=redirect&bpo=33195]: 在 c-api/arg 文档中弃用 Py_UNICODE 的使用。自 Python 3.3 起，Py_UNICODE 相关 API 已被弃用，但文档中遗漏了这一点。

bpo-8243 [https://bugs.python.org/issue?@action=redirect&bpo=8243]: 添加关于 curses.addch 和 curses.addstr 在窗口或 pad 外部写入时的异常行为的注释。

bpo-32337 [https://bugs.python.org/issue?@action=redirect&bpo=32337]: 更新与 dict 顺序相关的文档。

测试

bpo-33358 [https://bugs.python.org/issue?@action=redirect&bpo=33358]: 当解释器使用 --enable-shared 构建时，修复 test_embed.test_pre_initialization_sys_options()。

构建

bpo-33394 [https://bugs.python.org/issue?@action=redirect&bpo=33394]: 当GNU make在命令行上传递宏时，为扩展模块启用详细构建。

bpo-33393 [https://bugs.python.org/issue?@action=redirect&bpo=33393]: 更新config.guess和config.sub文件。

bpo-33377 [https://bugs.python.org/issue?@action=redirect&bpo=33377]: 为mips r6和riscv变体添加新的三元组（用于扩展后缀）。

bpo-32232 [https://bugs.python.org/issue?@action=redirect&bpo=32232]: By default, modules configured in Modules/Setup are no longer built with -DPy_BUILD_CORE. Instead, modules that specifically need that preprocessor definition include it in their individual entries.

bpo-33182 [https://bugs.python.org/issue?@action=redirect&bpo=33182]: 嵌入测试可以再次用clang 6.0构建。

Windows

bpo-33184 [https://bugs.python.org/issue?@action=redirect&bpo=33184]: 更新Windows安装程序以使用OpenSSL 1.1.0h。

macOS

bpo-33184 [https://bugs.python.org/issue?@action=redirect&bpo=33184]: 更新macOS安装程序构建以使用OpenSSL 1.1.0h。

IDLE

bpo-21474 [https://bugs.python.org/issue?@action=redirect&bpo=21474]: 将单词/标识符的定义从ASCII更新为Unicode。在文本和输入框中，这会影响通过双击选择、通过control-left/right左右移动以及通过control-BACKSPACE/DEL左右删除。

bpo-33204 [https://bugs.python.org/issue?@action=redirect&bpo=33204]: IDLE：一致地着色无效的字符串前缀。'u'字符串前缀不能与'r'或'f'配对。从右边开始，尽可能多地着色有效的部分。修订并扩展颜色化器测试。

工具/示例

bpo-33189 [https://bugs.python.org/issue?@action=redirect&bpo=33189]: pygettext.py 现在只识别字面字符串作为文档字符串和可翻译字符串，并拒绝字节字面量和 f-string 表达式。

bpo-31920 [https://bugs.python.org/issue?@action=redirect&bpo=31920]: 修复了 pygettext 脚本中将目录作为参数处理的问题。基于 Oleg Krasnikov 的补丁。

bpo-29673 [https://bugs.python.org/issue?@action=redirect&bpo=29673]: 修复 pystackv 和 pystack gdbinit 宏。

bpo-31583 [https://bugs.python.org/issue?@action=redirect&bpo=31583]: 修复 2to3 在使用 --add-suffix 选项但没有 --output-dir 选项时对当前目录中文件的相对路径的处理。

Python 3.7.0 beta 3

发布日期: 2018-03-29

安全性

bpo-33136 [https://bugs.python.org/issue?@action=redirect&bpo=33136]: Harden ssl module against LibreSSL CVE-2018-8970. X509_VERIFY_PARAM_set1_host() is called with an explicit namelen. A new test ensures that NULL bytes are not allowed.

bpo-33001 [https://bugs.python.org/issue?@action=redirect&bpo=33001]: Windows 上 os.symlink 防止缓冲区溢出的最小修复。

bpo-32981 [https://bugs.python.org/issue?@action=redirect&bpo=32981]: Regexes in difflib and poplib were vulnerable to catastrophic backtracking. These regexes formed potential DOS vectors (REDOS). They have been refactored. This resolves CVE-2018-1060 and CVE-2018-1061. Patch by Jamie Davis.

核心与内置函数

bpo-33053 [https://bugs.python.org/issue?@action=redirect&bpo=33053]: 当使用-m开关时，sys.path[0]现在明确扩展为 起始 工作目录，而不是保留为空路径（允许在导入时从当前工作目录导入）。

bpo-33018 [https://bugs.python.org/issue?@action=redirect&bpo=33018]: 提高了当 issubclass() 的第一个参数是非类而第二个参数是抽象基类时引发错误的一致性。由Josh Bronson提供补丁。

bpo-33041 [https://bugs.python.org/issue?@action=redirect&bpo=33041]: 修复了当函数包含 async for 循环时的跳转问题。

bpo-33026 [https://bugs.python.org/issue?@action=redirect&bpo=33026]: 通过设置f_lineno修复了跳出“with”块的问题。

bpo-33005 [https://bugs.python.org/issue?@action=redirect&bpo=33005]: 修复了在使用自定义内存分配器（例如：使用PYTHONMALLOC环境变量）时fork导致的崩溃。_PyGILState_Reinit()和_PyInterpreterState_Enable()现在使用默认的RAW内存分配器在fork时分配新的解释器互斥锁。

bpo-17288 [https://bugs.python.org/issue?@action=redirect&bpo=17288]: 防止从'return'和'exception'跟踪事件跳转。

bpo-32836 [https://bugs.python.org/issue?@action=redirect&bpo=32836]: 在列表/字典/集合推导式的情况下不使用临时变量。

库

bpo-33141 [https://bugs.python.org/issue?@action=redirect&bpo=33141]: 如果 Field 对象有自己的 __set_name__，则让它们将 __set_name__ 传递给它们的默认值。

bpo-33096 [https://bugs.python.org/issue?@action=redirect&bpo=33096]: 允许 ttk.Treeview.insert 插入具有假布尔值的 iid。注意 iid=0 和 iid=False 会是相同的。由 Garvit Khatri 提供补丁。

bpo-32873 [https://bugs.python.org/issue?@action=redirect&bpo=32873]: 通过复制和pickle操作将类型变量和特殊类型形式视为不可变。这修复了几个小问题和不一致性，并提高了与Python 3.6的向后兼容性。

bpo-33134 [https://bugs.python.org/issue?@action=redirect&bpo=33134]: 在计算数据类的__hash__时，使用查找表包含返回__hash__值的函数。这比查找字符串然后测试该字符串以决定做什么有所改进。

bpo-33127 [https://bugs.python.org/issue?@action=redirect&bpo=33127]: ssl模块现在可以编译使用LibreSSL 2.7.1。

bpo-32505 [https://bugs.python.org/issue?@action=redirect&bpo=32505]: 如果数据类的成员变量是Field类型但没有类型注解，则抛出TypeError。

bpo-33078 [https://bugs.python.org/issue?@action=redirect&bpo=33078]: 修复了由于测试依赖sem_getvalue而在OSX上导致的失败。

bpo-33116 [https://bugs.python.org/issue?@action=redirect&bpo=33116]: 将'Field'添加到dataclasses.__all__中。

bpo-32896 [https://bugs.python.org/issue?@action=redirect&bpo=32896]: 修复了一个错误，即当子类化一个使用default_factory字段的数据类时会生成一个不正确的类。

bpo-33100 [https://bugs.python.org/issue?@action=redirect&bpo=33100]: 数据类：如果一个字段有一个默认值是MemberDescriptorType，那么它是因为该字段在__slots__中，而不是一个实际的默认值。

bpo-32953 [https://bugs.python.org/issue?@action=redirect&bpo=32953]: 如果一个非数据类继承自一个冻结的数据类，允许向派生类添加属性。只有来自冻结数据类的属性不能被赋值。要求层次结构中的所有数据类要么全部冻结，要么全部非冻结。

bpo-33061 [https://bugs.python.org/issue?@action=redirect&bpo=33061]: 在typing.py的 __all__ 中添加缺失的 NoReturn。

bpo-33078 [https://bugs.python.org/issue?@action=redirect&bpo=33078]: 修复当发生pickling错误时multiprocessing.Queue中的大小处理。

bpo-33064 [https://bugs.python.org/issue?@action=redirect&bpo=33064]: lib2to3现在正确支持函数签名中 *args 和 **kwargs 后的尾随逗号。

bpo-33056 [https://bugs.python.org/issue?@action=redirect&bpo=33056]: 修复concurrent.futures.ProcessPoolExecutor中泄漏的文件描述符未正确关闭的问题。

bpo-33021 [https://bugs.python.org/issue?@action=redirect&bpo=33021]: 在fstat()调用期间释放GIL，避免在调用mmap.mmap()、os.urandom()和random.seed()时所有线程挂起。由Nir Soffer提供补丁。

bpo-31804 [https://bugs.python.org/issue?@action=redirect&bpo=31804]: 避免在标准流在退出时被关闭或为None时，multiprocessing.Process失败。

bpo-33037 [https://bugs.python.org/issue?@action=redirect&bpo=33037]: 在SSL传输关闭后跳过发送/接收数据。

bpo-27683 [https://bugs.python.org/issue?@action=redirect&bpo=27683]: 修复 ipaddress 中的一个回归问题，当网络由包含整数掩码且仅剩1位地址的元组构造时，hosts() 的结果为空。

bpo-32999 [https://bugs.python.org/issue?@action=redirect&bpo=32999]: 修复 ABC.__subclasscheck__(cls, subclass) 的C实现，在 subclass 不是类型对象时崩溃的问题。

bpo-33009 [https://bugs.python.org/issue?@action=redirect&bpo=33009]: 修复inspect.signature()对于单参数partialmethods的处理。

bpo-32969 [https://bugs.python.org/issue?@action=redirect&bpo=32969]: 在zlib中暴露几个缺失的常量并修复相应的文档。

bpo-32056 [https://bugs.python.org/issue?@action=redirect&bpo=32056]: Improved exceptions raised for invalid number of channels and sample width when read an audio file in modules aifc, wave and sunau.

bpo-32844 [https://bugs.python.org/issue?@action=redirect&bpo=32844]: 修复在subprocess中如果另一个低描述符被关闭时，将低描述符（0或1）错误重定向到stderr的问题。

bpo-32857 [https://bugs.python.org/issue?@action=redirect&bpo=32857]: 在 tkinter 中，after_cancel(None) 现在会引发 ValueError 异常，而不是取消第一个预定的函数。由Cheryl Sabella提供补丁。

bpo-31639 [https://bugs.python.org/issue?@action=redirect&bpo=31639]: http.server 现在暴露了一个 ThreadedHTTPServer 类，并在模块使用 -m 运行时使用它以应对网络浏览器预打开套接字的情况。

bpo-27645 [https://bugs.python.org/issue?@action=redirect&bpo=27645]: 如果底层的SQLite库版本为3.6.11或更高，sqlite3.Connection 现在公开了一个 backup 方法。由Lele Gaifax提供补丁。

文档

bpo-33126 [https://bugs.python.org/issue?@action=redirect&bpo=33126]: 文档化 PyBuffer_ToContiguous()。

bpo-27212 [https://bugs.python.org/issue?@action=redirect&bpo=27212]: 修改 islice() 函数示例代码的文档说明，使其在起始索引前消耗初始值。

bpo-28247 [https://bugs.python.org/issue?@action=redirect&bpo=28247]: 更新 zipapp 文档，描述如何制作独立应用程序。

bpo-18802 [https://bugs.python.org/issue?@action=redirect&bpo=18802]: ipaddress 的文档更改。由 Jon Foster 和 Berker Peksag 提供补丁。

bpo-27428 [https://bugs.python.org/issue?@action=redirect&bpo=27428]: 更新文档以澄清 WindowsRegistryFinder 实现了 MetaPathFinder。（补丁由 Himanshu Lakhara 提供）

测试

bpo-32872 [https://bugs.python.org/issue?@action=redirect&bpo=32872]: 避免 regrtest 与命名空间包的兼容性问题。

bpo-32517 [https://bugs.python.org/issue?@action=redirect&bpo=32517]: 修复由于 KqueueSelector 循环的传输未被关闭而在 macOS 10.12.2+ 上失败的 test_asyncio。

bpo-19417 [https://bugs.python.org/issue?@action=redirect&bpo=19417]: 添加 test_bdb.py。

构建

bpo-33163 [https://bugs.python.org/issue?@action=redirect&bpo=33163]: 将pip升级到9.0.3，setuptools升级到v39.0.1。

Windows

bpo-33016 [https://bugs.python.org/issue?@action=redirect&bpo=33016]: 修复nt._getfinalpathname中潜在使用未初始化内存的问题。

bpo-32903 [https://bugs.python.org/issue?@action=redirect&bpo=32903]: 修复如果当前目录设置为UNC路径时Windows上os.chdir()的内存泄漏。

macOS

bpo-32726 [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。

IDLE

bpo-32984 [https://bugs.python.org/issue?@action=redirect&bpo=32984]: 在运行启动文件时设置 __file__。与Python一样，IDLE在展示第一个交互式输入提示之前，可选地在Shell窗口中运行一个启动文件。对于IDLE，-s``运行环境变量 :envvar:`IDLESTARTUP` 或 :envvar:`PYTHONSTARTUP` 中命名的文件；-r file`` 运行 file。Python在运行文件之前将 __file__ 设置为启动文件名，并在第一个提示之前取消设置。IDLE现在在没有 -n 选项的情况下正常运行时也会这样做。

bpo-32940 [https://bugs.python.org/issue?@action=redirect&bpo=32940]: 在pyparse中简化并重命名StringTranslatePseudoMapping。

工具/示例

bpo-32885 [https://bugs.python.org/issue?@action=redirect&bpo=32885]: 为 Tools/scripts/pathfix.py 添加 -n 标志以禁用自动备份创建（带有 ~ 后缀的文件）。

C API

bpo-33042 [https://bugs.python.org/issue?@action=redirect&bpo=33042]: 嵌入应用程序可以再次在调用 Py_Initialize 之前调用 PySys_ResetWarnOptions、PySys_AddWarnOption 和 PySys_AddXOption。

bpo-32374 [https://bugs.python.org/issue?@action=redirect&bpo=32374]: 文档说明多阶段初始化模块的 m_traverse 可以在 m_state=NULL 时调用，并添加健全性检查

Python 3.7.0 beta 2

发布日期: 2018-02-27

安全性

bpo-28414 [https://bugs.python.org/issue?@action=redirect&bpo=28414]: ssl 模块现在允许用户在使用 SNI 时，自行执行 IDN 的编码与解码操作。

核心与内置函数

bpo-32889 [https://bugs.python.org/issue?@action=redirect&bpo=32889]: 更新Valgrind抑制列表，以考虑`Py_ADDRESS_IN_RANG`重命名为`address_in_range`的情况。

bpo-31356 [https://bugs.python.org/issue?@action=redirect&bpo=31356]: 移除了在 bpo-31356 [https://bugs.python.org/issue?@action=redirect&bpo=31356] 中添加的新API（gc.ensure_disabled()上下文管理器）。

bpo-32305 [https://bugs.python.org/issue?@action=redirect&bpo=32305]: 对于命名空间包，确保`__file__`和`__spec__.origin`都被设置为None。

bpo-32303 [https://bugs.python.org/issue?@action=redirect&bpo=32303]: 确保对于命名空间包，__spec__.loader 与 __loader__ 相匹配。

bpo-32711 [https://bugs.python.org/issue?@action=redirect&bpo=32711]: 修复 Python/ast_unparse.c 中的警告信息。由 Stéphane Wirtel 提供补丁。

bpo-32583 [https://bugs.python.org/issue?@action=redirect&bpo=32583]: 修复在使用自定义解码错误处理程序时，内置 Unicode 解码器可能因越界写入错误而崩溃的问题。

库

bpo-32960 [https://bugs.python.org/issue?@action=redirect&bpo=32960]: 对于数据类，禁止从非冻结类继承冻结类，也禁止从冻结类继承非冻结类。这一限制将在未来放宽。

bpo-32713 [https://bugs.python.org/issue?@action=redirect&bpo=32713]: 修复tarfile.itn对超出界限的浮点值的处理。由Joffrey Fuhrer提供补丁。

bpo-32951 [https://bugs.python.org/issue?@action=redirect&bpo=32951]: 现在禁止直接实例化SSLSocket和SSLObject对象。这些构造函数从未被记录、测试或设计为公共构造函数。用户应该使用ssl.wrap_socket()或SSLContext。

bpo-32929 [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曾经是默认值一样。

bpo-32947 [https://bugs.python.org/issue?@action=redirect&bpo=32947]: 添加OP_ENABLE_MIDDLEBOX_COMPAT和测试解决方法，以便未来与OpenSSL 1.1.1兼容的TLSv1.3。

bpo-30622 [https://bugs.python.org/issue?@action=redirect&bpo=30622]: ssl模块现在能检测到LibreSSL中缺少的NPN支持。

bpo-32922 [https://bugs.python.org/issue?@action=redirect&bpo=32922]: dbm.open()现在使用文件系统编码而不是默认编码对文件名进行编码。

bpo-32859 [https://bugs.python.org/issue?@action=redirect&bpo=32859]: 在 os.dup2 中，不再每次调用时检查 dup3 系统调用是否存在。

bpo-32556 [https://bugs.python.org/issue?@action=redirect&bpo=32556]: nt._getfinalpathname、nt._getvolumepathname和nt._getdiskusage现在能正确地从字节转换。

bpo-25988 [https://bugs.python.org/issue?@action=redirect&bpo=25988]: 当使用或直接从 collections 导入 ABC 而不是从 collections.abc 导入时，发出 DeprecationWarning。

bpo-21060 [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"。

bpo-32852 [https://bugs.python.org/issue?@action=redirect&bpo=32852]: 确保在运行trace时sys.argv保持为列表。

bpo-31333 [https://bugs.python.org/issue?@action=redirect&bpo=31333]: 新增了 _abc 模块。这是一个速度优化模块，提供了 abc 中各种函数和方法的 C 语言实现。创建 ABC 子类及使用 ABC 子类调用 isinstance 或 issubclass 的速度提高了 1.5 倍。此外，这还使得 Python 的启动速度提高了 10%。请注意，新实现隐藏了内部注册表和缓存，之前可以通过私有属性 _abc_registry、_abc_cache 和 _abc_negative_cache 访问。现在可以使用三个调试辅助方法 _dump_registry、_abc_registry_clear 和 _abc_caches_clear 来代替。

bpo-32841 [https://bugs.python.org/issue?@action=redirect&bpo=32841]: Fixed asyncio.Condition issue which silently ignored cancellation after notifying and cancelling a conditional lock. Patch by Bar Harel.

bpo-32819 [https://bugs.python.org/issue?@action=redirect&bpo=32819]: ssl.match_hostname() 已被简化，不再依赖 re 和 ipaddress 模块处理通配符和IP地址。对于无效通配符的错误报告已改进。

bpo-32394 [https://bugs.python.org/issue?@action=redirect&bpo=32394]: socket: 在旧版本Windows运行时移除TCP_FASTOPEN、TCP_KEEPCNT、TCP_KEEPIDLE、TCP_KEEPINTVL标志。

bpo-31787 [https://bugs.python.org/issue?@action=redirect&bpo=31787]: 修复了多个模块中 __init__() 方法的内存泄漏问题。(由Oren Milman贡献)

bpo-30157 [https://bugs.python.org/issue?@action=redirect&bpo=30157]: 修复了在只有最后一个字段被引用时，csv.Sniffer.sniff() 中猜测引用和分隔符的问题。由Jake Davis提供补丁。

bpo-32792 [https://bugs.python.org/issue?@action=redirect&bpo=32792]: collections.ChainMap() 保留了底层映射的顺序。

bpo-32775 [https://bugs.python.org/issue?@action=redirect&bpo=32775]: fnmatch.translate() no longer produces patterns which contain set operations. Sets starting with '[' or containing '--', '&&', '~~' or '||' will be interpreted differently in regular expressions in future versions. Currently they emit warnings. fnmatch.translate() now avoids producing patterns containing such sets by accident.

bpo-32622 [https://bugs.python.org/issue?@action=redirect&bpo=32622]: 为Windows proactor事件循环实现原生快速发送文件功能。

bpo-32777 [https://bugs.python.org/issue?@action=redirect&bpo=32777]: 修复了在POSIX系统的子进程中，当标记文件描述符为可继承时，subprocess中一个罕见但潜在的子进程死锁问题。此bug似乎是在3.4版本中引入的。

bpo-32647 [https://bugs.python.org/issue?@action=redirect&bpo=32647]: ctypes模块过去依赖间接链接来使用dlopen。现在，在支持dl的平台上，共享扩展已明确链接到libdl。

bpo-32741 [https://bugs.python.org/issue?@action=redirect&bpo=32741]: 实现 asyncio.TimerHandle.when() 方法。

bpo-32691 [https://bugs.python.org/issue?@action=redirect&bpo=32691]: 在使用pdb运行模块时使用mod_spec.parent。

bpo-32734 [https://bugs.python.org/issue?@action=redirect&bpo=32734]: 修复了 asyncio.Lock() 的安全问题，该问题允许多次获取和锁定同一个锁，而锁并未释放。由Bar Harel提供补丁。

bpo-32727 [https://bugs.python.org/issue?@action=redirect&bpo=32727]: 不在SMTP信封的发送地址中包含名字字段。由Stéphane Wirtel提供补丁。

bpo-31453 [https://bugs.python.org/issue?@action=redirect&bpo=31453]: Add TLSVersion constants and SSLContext.maximum_version / minimum_version attributes. The new API wraps OpenSSL 1.1 https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html feature.

bpo-24334 [https://bugs.python.org/issue?@action=redirect&bpo=24334]: 清理了ssl模块的内部实现细节。SSLSocket减少了一层间接引用。所有者与会话信息现在由SSLSocket和SSLObject的构造函数处理。通道绑定实现已被简化。

bpo-31848 [https://bugs.python.org/issue?@action=redirect&bpo=31848]: 修复Aifc_read.initfp()中当SSND块未找到时的错误处理。补丁由Zackery Spytz提供。

bpo-32585 [https://bugs.python.org/issue?@action=redirect&bpo=32585]: 向 tkinter.ttk 添加Ttk spinbox小部件。由Alan D Moore提供补丁。

bpo-32221 [https://bugs.python.org/issue?@action=redirect&bpo=32221]: 现在，返回包含IPv6地址的元组的各种函数省略了 %scope 部分，因为相同的信息已经在 scopeid 元组项中编码。特别是这加快了 socket.recvfrom() 在接收多播数据包时的速度，因为省略了无用的网络接口名称解析。

bpo-30693 [https://bugs.python.org/issue?@action=redirect&bpo=30693]: TarFile类现在以一种可重复的方式递归目录。

bpo-30693 [https://bugs.python.org/issue?@action=redirect&bpo=30693]: ZipFile类现在以一种可重复的方式递归目录。

文档

bpo-28124 [https://bugs.python.org/issue?@action=redirect&bpo=28124]: ssl 模块函数 ssl.wrap_socket() 已被弱化并弃用，推荐使用更安全高效的 SSLContext.wrap_socket() 方法。

bpo-17232 [https://bugs.python.org/issue?@action=redirect&bpo=17232]: 澄清 -O 和 -OO 的文档。由 Terry Reedy 提供补丁。

bpo-32436 [https://bugs.python.org/issue?@action=redirect&bpo=32436]: 为 contextvars 模块（PEP 567）添加文档。

bpo-32800 [https://bugs.python.org/issue?@action=redirect&bpo=32800]: 更新 xml 默认命名空间的 w3c 文档链接。

bpo-11015 [https://bugs.python.org/issue?@action=redirect&bpo=11015]: 更新 test.support 文档。

bpo-8722 [https://bugs.python.org/issue?@action=redirect&bpo=8722]: 文档化当属性 get() 方法引发 AttributeError 时 __getattr__() 的行为。

bpo-32614 [https://bugs.python.org/issue?@action=redirect&bpo=32614]: 修改文档中的正则表达式示例，使用原始字符串以防止 DeprecationWarning，并在正则表达式 HOWTO 中添加文本以突出弃用。

bpo-31972 [https://bugs.python.org/issue?@action=redirect&bpo=31972]: Improve docstrings for pathlib.PurePath subclasses.

测试

bpo-31809 [https://bugs.python.org/issue?@action=redirect&bpo=31809]: 添加测试以验证与 secp ECDH 曲线的连接。

构建

bpo-32898 [https://bugs.python.org/issue?@action=redirect&bpo=32898]: 修复了在使用 COUNT_ALLOCS 时的 Python 调试构建问题。

Windows

bpo-32901 [https://bugs.python.org/issue?@action=redirect&bpo=32901]: 将Tcl和Tk版本更新到8.6.8

bpo-31966 [https://bugs.python.org/issue?@action=redirect&bpo=31966]: 修复WindowsConsoleIO.write()写入空数据的问题。

bpo-32409 [https://bugs.python.org/issue?@action=redirect&bpo=32409]: 确保activate.bat可以处理Unicode内容。

bpo-32457 [https://bugs.python.org/issue?@action=redirect&bpo=32457]: 改进启动Python时对非规范化可执行路径的处理。

bpo-32370 [https://bugs.python.org/issue?@action=redirect&bpo=32370]: 在uuid模块中为ipconfig输出使用正确的编码。由Segev Finer提交补丁。

bpo-29248 [https://bugs.python.org/issue?@action=redirect&bpo=29248]: 修复Windows上的 os.readlink()，它错误地将重新解析数据缓冲区的``PrintNameOffset`` 字段视为字符数而非字节数。由Craig Holmquist和SSE4提交补丁。

macOS

bpo-32901 [https://bugs.python.org/issue?@action=redirect&bpo=32901]: 将macOS 10.9+安装程序更新至Tcl/Tk 8.6.8。

IDLE

bpo-32916 [https://bugs.python.org/issue?@action=redirect&bpo=32916]: 在pyparse中将 str 更改为 code。

bpo-32905 [https://bugs.python.org/issue?@action=redirect&bpo=32905]: 移除pyparse模块中未使用的代码。

bpo-32874 [https://bugs.python.org/issue?@action=redirect&bpo=32874]: 为pyparse添加测试。

bpo-32837 [https://bugs.python.org/issue?@action=redirect&bpo=32837]: 对于IDLE的系统和位置无关文件，使用系统和位置相关的默认编码对于open()来说是一个坏主意。

bpo-32826 [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字符。

bpo-32765 [https://bugs.python.org/issue?@action=redirect&bpo=32765]: 更新configdialog General标签的文档字符串，将新部件添加到部件列表中。

工具/示例

bpo-32222 [https://bugs.python.org/issue?@action=redirect&bpo=32222]: 修复 pygettext 不提取带有类型注释参数的函数的文档字符串的问题。由 Toby Harradine 提供的补丁。

Python 3.7.0 beta 1

发布日期: 2018-01-30

核心与内置函数

bpo-32703 [https://bugs.python.org/issue?@action=redirect&bpo=32703]: 修复了协程在最终化时存在活动错误集时的 ResourceWarning 问题。

bpo-32650 [https://bugs.python.org/issue?@action=redirect&bpo=32650]: Pdb 和其他依赖于 bdb.py 的调试器现在能够正确地单步跳过（next 命令）原生协程。由 Pablo Galindo 提供补丁。

bpo-28685 [https://bugs.python.org/issue?@action=redirect&bpo=28685]: 通过尽可能使用类型专用比较，优化了 list.sort() 和 sorted()。

bpo-32685 [https://bugs.python.org/issue?@action=redirect&bpo=32685]: 改进了当 Python 2 形式的 print 语句出现在复合语句的同一行或以分号而非换行符终止时的建议。由 Nitish Chandra 提供补丁。

bpo-32697 [https://bugs.python.org/issue?@action=redirect&bpo=32697]: Python 现在明确保留了仅关键字参数的定义顺序。虽然之前总是保留其顺序，但这一行为从未得到保证；现在这一行为得到了保证和测试。

bpo-32690 [https://bugs.python.org/issue?@action=redirect&bpo=32690]: locals() 字典现在按照变量定义的词法顺序显示。之前顺序是相反的。

bpo-32677 [https://bugs.python.org/issue?@action=redirect&bpo=32677]: 向 str、bytes 和 bytearray 添加了 .isascii() 方法。可用于测试字符串是否仅包含 ASCII 字符。

bpo-32670 [https://bugs.python.org/issue?@action=redirect&bpo=32670]: 对所有代码强制执行 PEP 479 [https://www.python.org/dev/peps/pep-0479]。这意味着从生成器中手动引发 StopIteration 异常对所有代码都是禁止的，无论是否使用了 'from __future__ import generator_stop'。

bpo-32591 [https://bugs.python.org/issue?@action=redirect&bpo=32591]: 添加了对跟踪协程对象来源的内置支持；参见 sys.set_coroutine_origin_tracking_depth 和 CoroutineType.cr_origin。这取代了 asyncio 调试模式对原生协程对象使用协程包装的做法。

bpo-31368 [https://bugs.python.org/issue?@action=redirect&bpo=31368]: 在 os 模块中暴露了 preadv 和 pwritev 系统调用。由 Pablo Galindo 提供补丁

bpo-32544 [https://bugs.python.org/issue?@action=redirect&bpo=32544]: hasattr(obj, name) 和 getattr(obj, name, default) 在 name 未找到且 obj 未重写 __getattr__ 或 __getattribute__ 时，速度比以前快了约4倍。

bpo-26163 [https://bugs.python.org/issue?@action=redirect&bpo=26163]: 改进了 frozenset() 的哈希函数，当面对包含许多相似值的数据集时，能生成更多不同的哈希值。

bpo-32550 [https://bugs.python.org/issue?@action=redirect&bpo=32550]: 移除了 STORE_ANNOTATION 字节码。

bpo-20104 [https://bugs.python.org/issue?@action=redirect&bpo=20104]: 在 os 模块中暴露了 posix_spawn 作为低级 API。（在 3.7.0rc1 之前移除）

bpo-24340 [https://bugs.python.org/issue?@action=redirect&bpo=24340]: 修复了代码堆栈大小的估计问题。

bpo-32436 [https://bugs.python.org/issue?@action=redirect&bpo=32436]: 实现了 PEP 567 [https://www.python.org/dev/peps/pep-0567] 上下文变量。

bpo-18533 [https://bugs.python.org/issue?@action=redirect&bpo=18533]: repr() 在包含其自身的 values() 或 items() 的字典上不再引发 RecursionError；OrderedDict 同理。相反，像其他递归结构一样使用 ...。由 Ben North 提供补丁。

bpo-20891 [https://bugs.python.org/issue?@action=redirect&bpo=20891]: Py_Initialize() 现在会创建 GIL。GIL 不再“按需”创建，以修复在非 Python 线程中调用 PyGILState_Ensure() 时的竞态条件。

bpo-32028 [https://bugs.python.org/issue?@action=redirect&bpo=32028]: 在为将 Py2 打印语句转换为 Py3 内置打印函数调用生成建议时，现在正确地忽略了前导空白。由 Sanyam Khurana 提供补丁。

bpo-31179 [https://bugs.python.org/issue?@action=redirect&bpo=31179]: 使 dict.copy() 速度提高了多达5.5倍。

bpo-31113 [https://bugs.python.org/issue?@action=redirect&bpo=31113]: 在编译器中消除了对正常控制流的递归。

库

bpo-25988 [https://bugs.python.org/issue?@action=redirect&bpo=25988]: 弃用在常规 collections 模块中暴露 collections.abc 的内容。

bpo-31429 [https://bugs.python.org/issue?@action=redirect&bpo=31429]: ssl模块的默认密码套件选择现在使用黑名单方法，而不是硬编码的白名单。Python不再重新启用被OpenSSL安全更新阻止的密码。默认密码套件选择可以在编译时配置。

bpo-30306 [https://bugs.python.org/issue?@action=redirect&bpo=30306]: contextlib.contextmanager现在一旦进入上下文管理器，就会释放传递给底层生成器的参数。以前，它会保持它们活跃，只要上下文管理器是活跃的，即使不作为函数装饰器使用。由Martin Teichmann提供补丁。

bpo-21417 [https://bugs.python.org/issue?@action=redirect&bpo=21417]: 增加了对设置zipfile.ZipFile压缩级别的支持。

bpo-32251 [https://bugs.python.org/issue?@action=redirect&bpo=32251]: 实现了asyncio.BufferedProtocol（临时API）。

bpo-32513 [https://bugs.python.org/issue?@action=redirect&bpo=32513]: 在数据类中，允许更容易地覆盖dunder方法，而无需指定装饰器参数。

bpo-32660 [https://bugs.python.org/issue?@action=redirect&bpo=32660]: termios 在Solaris/衍生系统下也提供 FIONREAD, FIONCLEX, FIOCLEX, FIOASYNC 和 FIONBIO。

bpo-27931 [https://bugs.python.org/issue?@action=redirect&bpo=27931]: 修复当用户名为空引号字符串时的电子邮件地址头解析错误。由Xiang Zhang提供补丁。

bpo-32659 [https://bugs.python.org/issue?@action=redirect&bpo=32659]: 在Solaris及其衍生系统下，os.stat_result 提供了一个st_fstype属性。

bpo-32662 [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'关键字参数。

bpo-32391 [https://bugs.python.org/issue?@action=redirect&bpo=32391]: 实现了 asyncio.StreamWriter.wait_closed() 和 asyncio.StreamWriter.is_closing() 方法。

bpo-32643 [https://bugs.python.org/issue?@action=redirect&bpo=32643]: 将Task._step、Task._wakeup和Future._schedule_callbacks方法设为私有。

bpo-32630 [https://bugs.python.org/issue?@action=redirect&bpo=32630]: 重构decimal模块以使用contextvars存储decimal上下文。

bpo-32622 [https://bugs.python.org/issue?@action=redirect&bpo=32622]: 添加 asyncio.AbstractEventLoop.sendfile() 方法。

bpo-32304 [https://bugs.python.org/issue?@action=redirect&bpo=32304]: distutils的上传命令不再损坏以CR字节结尾的tar文件，并且不再尝试在上传的任何文本字段中将CR转换为CRLF。

bpo-32502 [https://bugs.python.org/issue?@action=redirect&bpo=32502]: 当遇到64位硬件地址时，uuid.uuid1不再抛出异常。

bpo-32596 [https://bugs.python.org/issue?@action=redirect&bpo=32596]: concurrent.futures 现在懒加载 ThreadPoolExecutor 和 ProcessPoolExecutor (使用 PEP 562 [https://www.python.org/dev/peps/pep-0562]) 。这使得 import asyncio 大约快15%，因为 asyncio 默认只使用 ThreadPoolExecutor。

bpo-31801 [https://bugs.python.org/issue?@action=redirect&bpo=31801]: 在 Enum 中添加 _ignore_，以便在类构造期间可以使用临时变量而不会将其转换为成员。

bpo-32576 [https://bugs.python.org/issue?@action=redirect&bpo=32576]: 在可以从弱引用回调调用的地方使用 queue.SimpleQueue()。

bpo-32574 [https://bugs.python.org/issue?@action=redirect&bpo=32574]: 修复 asyncio.Queue 中的内存泄漏问题，当队列大小受限且已满时，取消 queue.put() 可能导致内存泄漏。 补丁编写: José Melero。

bpo-32521 [https://bugs.python.org/issue?@action=redirect&bpo=32521]: nis 模块现在与新的 libnsl 和头文件位置兼容。

bpo-32467 [https://bugs.python.org/issue?@action=redirect&bpo=32467]: collections.abc.ValuesView 现在继承自 collections.abc.Collection。

bpo-32473 [https://bugs.python.org/issue?@action=redirect&bpo=32473]: 提高 ABCMeta._dump_registry() 输出的可读性

bpo-32102 [https://bugs.python.org/issue?@action=redirect&bpo=32102]: subprocess.run 的新参数 capture_output

bpo-32521 [https://bugs.python.org/issue?@action=redirect&bpo=32521]: glibc 已移除 Sun RPC。在 nis 模块中使用替代的 libtirpc 头文件和库。

bpo-32493 [https://bugs.python.org/issue?@action=redirect&bpo=32493]: UUID 模块修复了 FreeBSD/OpenBSD 的构建

bpo-32503 [https://bugs.python.org/issue?@action=redirect&bpo=32503]: 使用协议4进行pickle时不再创建过小的帧。

bpo-29237 [https://bugs.python.org/issue?@action=redirect&bpo=29237]: 为 pstats 排序选项创建枚举

bpo-32454 [https://bugs.python.org/issue?@action=redirect&bpo=32454]: 向 socket 模块添加 close(fd) 函数。

bpo-25942 [https://bugs.python.org/issue?@action=redirect&bpo=25942]: subprocess 模块现在在 subprocess.call、subprocess.run 或 Popen 上下文管理器期间处理 Ctrl-C KeyboardInterrupt 时更加优雅。现在它会在继续 KeyboardInterrupt 异常处理之前等待子进程（假设也收到了 SIGINT）短暂退出。这仍然包括在 call() 和 run() API 中的 SIGKILL，但至少子进程有机会首先退出。

bpo-32433 [https://bugs.python.org/issue?@action=redirect&bpo=32433]: hmac 模块现在有了 hmac.digest()，它提供了一个优化的 HMAC 摘要。

bpo-28134 [https://bugs.python.org/issue?@action=redirect&bpo=28134]: 现在默认情况下，套接字会自动从文件描述符中检测家族、类型和协议。

bpo-32404 [https://bugs.python.org/issue?@action=redirect&bpo=32404]: 修复了 datetime.datetime.fromtimestamp() 在 datetime.datetime 子类中不调用 __new__ 的 bug。

bpo-32403 [https://bugs.python.org/issue?@action=redirect&bpo=32403]: 提高了 datetime.date 和 datetime.datetime 替代构造器的速度。

bpo-32228 [https://bugs.python.org/issue?@action=redirect&bpo=32228]: 确保 truncate() 在写入长度超过缓冲区大小后保留文件位置（由 tell() 报告）。

bpo-32410 [https://bugs.python.org/issue?@action=redirect&bpo=32410]: 为 asyncio 事件循环实现了 loop.sock_sendfile。

bpo-22908 [https://bugs.python.org/issue?@action=redirect&bpo=22908]: 向 ZipExtFile 类添加了 seek 和 tell。这仅在用于打开 zipfile 的文件对象可查找时有效。

bpo-32373 [https://bugs.python.org/issue?@action=redirect&bpo=32373]: 添加了 socket.getblocking() 方法。

bpo-32248 [https://bugs.python.org/issue?@action=redirect&bpo=32248]: Add importlib.resources and importlib.abc.ResourceReader as the unified API for reading resources contained within packages. Loaders wishing to support resource reading must implement the get_resource_reader() method. File-based and zipimport-based loaders both implement these APIs. importlib.abc.ResourceLoader is deprecated in favor of these new APIs.

bpo-32320 [https://bugs.python.org/issue?@action=redirect&bpo=32320]: collections.namedtuple() 现在支持默认值。

bpo-29302 [https://bugs.python.org/issue?@action=redirect&bpo=29302]: 添加了 contextlib.AsyncExitStack。由 Alexander Mohr 和 Ilya Kulakov 提供补丁。

bpo-31961 [https://bugs.python.org/issue?@action=redirect&bpo=31961]: 已在 Python 3.7.0b2 中移除。 subprocess.Popen 的 args 参数现在可以是 path-like object。如果 args 以序列形式给出，其第一个元素现在也可以是 path-like object。

bpo-31900 [https://bugs.python.org/issue?@action=redirect&bpo=31900]: 现在 locale.localeconv() 函数会临时将 LC_CTYPE 区域设置改为``LC_NUMERIC``区域设置，以解码 decimal_point 和 thousands_sep 字节字符串，如果它们是非ASCII或长度超过1字节，并且 LC_NUMERIC 区域设置与 LC_CTYPE 区域设置不同。这一临时变更会影响其他线程。对于 str.format() 方法，当使用 n 类型格式化数字（int, float, float 及其子类）时（例如：'{:n}'.format(1234)），也进行了相同的更改。

bpo-31853 [https://bugs.python.org/issue?@action=redirect&bpo=31853]: 在SSLSocket中使用super().method替代socket.method。它们很可能是因为遗留原因而存在。

bpo-31399 [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禁用主题通用名称回退。

bpo-14976 [https://bugs.python.org/issue?@action=redirect&bpo=14976]: 添加了一个queue.SimpleQueue类，这是一个无界的FIFO队列，带有put()的可重入C实现。

文档

bpo-32724 [https://bugs.python.org/issue?@action=redirect&bpo=32724]: 在Pdb的文档中添加了一些命令的引用。由Stéphane Wirtel提供补丁。

bpo-32649 [https://bugs.python.org/issue?@action=redirect&bpo=32649]: 完成了C API文档的性能分析和跟踪部分，新增了每操作码事件的说明。

bpo-17799 [https://bugs.python.org/issue?@action=redirect&bpo=17799]: 解释了sys.settrace和sys.setprofile及其C-API对应项的实际行为，关于在每个函数中接收哪些类型的事件。由Pablo Galindo Salgado提供补丁。

测试

bpo-32721 [https://bugs.python.org/issue?@action=redirect&bpo=32721]: 修复test_hashlib，使其在未构建_md5模块时不会失败。

bpo-28414 [https://bugs.python.org/issue?@action=redirect&bpo=28414]: 为IDNA 2003和2008主机名添加测试用例。自 bpo-31399 [https://bugs.python.org/issue?@action=redirect&bpo=31399] 落地以来，IDNA 2003国际化主机名已经可以工作。IDNA 2008仍然存在问题。

bpo-32604 [https://bugs.python.org/issue?@action=redirect&bpo=32604]: 添加一个新的 "_xxsubinterpreters" 扩展模块，该模块暴露了现有的子解释器 C-API 和一个新的跨解释器数据共享机制。此模块主要用于更彻底地测试现有的子解释器支持。请注意，_xxsubinterpreters 模块已在 3.7.0rc1 中移除。

bpo-32602 [https://bugs.python.org/issue?@action=redirect&bpo=32602]: 添加测试证书和用于 ECDSA 证书及 EC/RSA 双模式的测试。

bpo-32549 [https://bugs.python.org/issue?@action=redirect&bpo=32549]: 在 Travis CI 上，Python 现在编译并使用 OpenSSL 1.1.0g 的本地副本进行测试。

构建

bpo-32635 [https://bugs.python.org/issue?@action=redirect&bpo=32635]: 修复当系统提供的是 libxcrypt 而不是 libcrypt 时 crypt 模块的段错误。

bpo-32598 [https://bugs.python.org/issue?@action=redirect&bpo=32598]: 使用 autoconf 检测 OpenSSL 库、头文件和支持的特性。ax_check_openssl M4 宏使用 pkg-config 定位 OpenSSL，并回退到手动搜索。

bpo-32593 [https://bugs.python.org/issue?@action=redirect&bpo=32593]: 放弃对 FreeBSD 9 及更旧版本的支持。

bpo-29708 [https://bugs.python.org/issue?@action=redirect&bpo=29708]: 如果设置了 SOURCE_DATE_EPOCH 环境变量，py_compile 将始终创建基于哈希的 .pyc 文件。

Windows

bpo-32588 [https://bugs.python.org/issue?@action=redirect&bpo=32588]: 创建独立的 _distutils_findvs 模块，并将缺失的 _queue 模块添加到安装程序中。

bpo-29911 [https://bugs.python.org/issue?@action=redirect&bpo=29911]: 确保显示单独的修改和卸载按钮。

bpo-32507 [https://bugs.python.org/issue?@action=redirect&bpo=32507]: 对于旧版本的 Windows，使用应用本地的 UCRT 安装，而不是正确的更新。

macOS

bpo-32726 [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 副本。

bpo-28440 [https://bugs.python.org/issue?@action=redirect&bpo=28440]: 不再将 /Library/Python/3.x/site-packages 添加到 macOS 框架构建的 sys.path 中，以避免未来的冲突。

C API

bpo-32681 [https://bugs.python.org/issue?@action=redirect&bpo=32681]: 修复 os.dup2 的 C 实现中未初始化的变量 'res'。补丁由 Stéphane Wirtel 提供。

bpo-10381 [https://bugs.python.org/issue?@action=redirect&bpo=10381]: Add C API access to the datetime.timezone constructor and datetime.timzone.UTC singleton.

Python 3.7.0 alpha 4

发布日期: 2018-01-08

核心与内置函数

bpo-31975 [https://bugs.python.org/issue?@action=redirect&bpo=31975]: 默认的警告过滤器列表现在以 "default::DeprecationWarning:__main__" 条目开始，因此在单文件脚本和交互式提示符中，弃用警告默认再次显示。

bpo-32226 [https://bugs.python.org/issue?@action=redirect&bpo=32226]: __class_getitem__ 现在是一个自动类方法。

bpo-32399 [https://bugs.python.org/issue?@action=redirect&bpo=32399]: 使用 libc.a 中的 uuid_create() 为 AIX 添加 RFC4122 uuid 库支持。

bpo-32390 [https://bugs.python.org/issue?@action=redirect&bpo=32390]: 修复在 os.statvfs() 返回的对象中添加 f_fsid 字段后在 AIX 上的编译失败问题 (bpo-32143 [https://bugs.python.org/issue?@action=redirect&bpo=32143])。原始由 Michael Felt 提供补丁。

bpo-32379 [https://bugs.python.org/issue?@action=redirect&bpo=32379]: 当一个类继承自单一基类时，使 MRO 计算更快。

bpo-32259 [https://bugs.python.org/issue?@action=redirect&bpo=32259]: 解包不可迭代对象时引发的 TypeError 错误消息现在更加具体。

bpo-27169 [https://bugs.python.org/issue?@action=redirect&bpo=27169]: __debug__ 常量现在在编译时被优化掉。这也修复了 bpo-22091 [https://bugs.python.org/issue?@action=redirect&bpo=22091]。

bpo-32329 [https://bugs.python.org/issue?@action=redirect&bpo=32329]: 当 PYTHONHASHSEED 环境变量设置为 0 时，-R 选项现在会开启哈希随机化。之前，该选项被忽略。此外，当哈希随机化被 PYTHONHASHSEED=0 关闭时，sys.flags.hash_randomization 现在被正确设置为 0。

bpo-30416 [https://bugs.python.org/issue?@action=redirect&bpo=30416]: 优化器现在受到保护，不会花费大量时间进行复杂计算和在常量折叠中创建大常量时消耗大量内存。增加了在常量折叠中可以产生的常量的限制。

bpo-32282 [https://bugs.python.org/issue?@action=redirect&bpo=32282]: 修复 Windows 上 socketmodule 中 VersionHelpers.h 包含的不必要的 ifdef。

bpo-30579 [https://bugs.python.org/issue?@action=redirect&bpo=30579]: 实现 TracebackType.__new__ 以允许在 Python 级别创建回溯对象，并使 TracebackType.tb_next 可变。

bpo-32260 [https://bugs.python.org/issue?@action=redirect&bpo=32260]: 不要在大端平台上对 SipHash 算法的输入键进行字节交换。这应确保 siphash 在不同平台上给出一致的结果。

bpo-31506 [https://bugs.python.org/issue?@action=redirect&bpo=31506]: 改进 object.__new__ 和 object.__init__ 的错误消息逻辑。由 Sanyam Khurana 提供补丁。

bpo-20361 [https://bugs.python.org/issue?@action=redirect&bpo=20361]: -b 和 -bb 现在会在 sys.warnoptions 中注入 'default::BytesWarning' 和 error::BytesWarning 条目，确保它们优先于通过 -W 选项或 PYTHONWARNINGS 环境变量配置的任何其他警告过滤器。

bpo-32230 [https://bugs.python.org/issue?@action=redirect&bpo=32230]: -X dev now injects a 'default' entry into sys.warnoptions, ensuring that it behaves identically to actually passing -Wdefault at the command line.

bpo-29240 [https://bugs.python.org/issue?@action=redirect&bpo=29240]: 添加新的 UTF-8 模式：实现了 PEP 540 [https://www.python.org/dev/peps/pep-0540]。

bpo-32226 [https://bugs.python.org/issue?@action=redirect&bpo=32226]: PEP 560 [https://www.python.org/dev/peps/pep-0560]: 添加对 __mro_entries__ 和 __class_getitem__ 的支持。由 Ivan Levkivskyi 实现。

bpo-32225 [https://bugs.python.org/issue?@action=redirect&bpo=32225]: PEP 562 [https://www.python.org/dev/peps/pep-0562]: 添加对模块 __getattr__ 和 __dir__ 的支持。由 Ivan Levkivskyi 实现。

bpo-31901 [https://bugs.python.org/issue?@action=redirect&bpo=31901]: The atexit module now has its callback stored per interpreter.

bpo-31650 [https://bugs.python.org/issue?@action=redirect&bpo=31650]: 实现 PEP 552 [https://www.python.org/dev/peps/pep-0552] (确定性 pycs) 。Python 现在支持基于源内容哈希而非源最后修改时间使字节码缓存文件失效。

bpo-29469 [https://bugs.python.org/issue?@action=redirect&bpo=29469]: 将常量折叠从字节码层移动到 AST 层。原始由 Eugene Toder 提供补丁。

库

bpo-32506 [https://bugs.python.org/issue?@action=redirect&bpo=32506]: 既然 dict 被定义为保持插入顺序，那么放弃 OrderedDict，直接使用普通 dict。

bpo-32279 [https://bugs.python.org/issue?@action=redirect&bpo=32279]: 向 dataclasses.make_dataclasses() 添加参数：init、repr、eq、order、hash 和 frozen。将它们传递给 dataclass()。

bpo-32278 [https://bugs.python.org/issue?@action=redirect&bpo=32278]: 使 dataclasses.make_dataclass() 上的类型信息可选。如果省略，则使用字符串 'typing.Any'。

bpo-32499 [https://bugs.python.org/issue?@action=redirect&bpo=32499]: 添加 dataclasses.is_dataclass(obj)，如果 obj 是数据类或其实例，则返回 True。

bpo-32468 [https://bugs.python.org/issue?@action=redirect&bpo=32468]: 改进 frame repr() 以提及文件名、代码名称和当前行号。

bpo-23749 [https://bugs.python.org/issue?@action=redirect&bpo=23749]: asyncio: 实现 loop.start_tls()

bpo-32441 [https://bugs.python.org/issue?@action=redirect&bpo=32441]: 从 os.dup2 返回新的文件描述符（即第二个参数）。以前总是返回 None。

bpo-32422 [https://bugs.python.org/issue?@action=redirect&bpo=32422]: functools.lru_cache 使用更少的内存（每个缓存键3个单词）并且循环GC时间大约减少到1/3。

bpo-31721 [https://bugs.python.org/issue?@action=redirect&bpo=31721]: 防止当Future._log_traceback被手动设置为True时Python崩溃。现在它只能被设置为False，否则会引发ValueError。

bpo-32415 [https://bugs.python.org/issue?@action=redirect&bpo=32415]: asyncio: 添加Task.get_loop()和Future.get_loop()

bpo-26133 [https://bugs.python.org/issue?@action=redirect&bpo=26133]: 在解释器关闭时不要在asyncio UNIX事件循环中取消订阅信号。

bpo-32363 [https://bugs.python.org/issue?@action=redirect&bpo=32363]: 使asyncio.Task.set_exception()和set_result()引发NotImplementedError。Task._step()和Future.__await__()在无效状态时引发适当的异常，而不是AssertionError。

bpo-32357 [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%。现在，后者一样快。

bpo-32356 [https://bugs.python.org/issue?@action=redirect&bpo=32356]: asyncio.transport.resume_reading()和pause_reading()现在是幂等的。新增transport.is_reading()方法。

bpo-32355 [https://bugs.python.org/issue?@action=redirect&bpo=32355]: 优化asyncio.gather(); 现在快达15%。

bpo-32351 [https://bugs.python.org/issue?@action=redirect&bpo=32351]: 如果delay<0，在asyncio.sleep中使用fastpath（2倍加速）

bpo-32348 [https://bugs.python.org/issue?@action=redirect&bpo=32348]: 优化asyncio.Future schedule/add/remove回调。该优化显示async/await代码性能提升3-6%。

bpo-32331 [https://bugs.python.org/issue?@action=redirect&bpo=32331]: 修复socket.settimeout()和socket.setblocking()以保持socket.type不变。修复socket.socket()构造函数以重置应用于socket类型的任何位标志。此更改仅影响具有SOCK_NONBLOCK和/或SOCK_CLOEXEC的操作系统。

bpo-32248 [https://bugs.python.org/issue?@action=redirect&bpo=32248]: 添加 importlib.abc.ResourceReader 作为加载器的ABC，为读取包中包含的资源提供统一的API。同时添加 importlib.resources 作为 importlib_resources 的端口。

bpo-32311 [https://bugs.python.org/issue?@action=redirect&bpo=32311]: 实现asyncio.create_task(coro)快捷方式

bpo-32327 [https://bugs.python.org/issue?@action=redirect&bpo=32327]: 将文档中标记为协程的asyncio函数转换为协程。受影响的函数包括：loop.sock_sendall、loop.sock_recv、loop.sock_accept、loop.getaddrinfo、loop.getnameinfo。

bpo-32323 [https://bugs.python.org/issue?@action=redirect&bpo=32323]: urllib.parse.urlsplit() does not convert zone-id (scope) to lower case for scoped IPv6 addresses in hostnames now.

bpo-32302 [https://bugs.python.org/issue?@action=redirect&bpo=32302]: 修复了distutils的bdist_wininst对于CRT v142的支持：它二进制兼容于CRT v140。

bpo-29711 [https://bugs.python.org/issue?@action=redirect&bpo=29711]: 修复了asyncio proactor循环中的 stop_serving 会杀死所有监听服务器的问题。

bpo-32308 [https://bugs.python.org/issue?@action=redirect&bpo=32308]: re.sub() now replaces empty matches adjacent to a previous non-empty match.

bpo-29970 [https://bugs.python.org/issue?@action=redirect&bpo=29970]: Abort asyncio SSLProtocol connection if handshake not complete within 10s

bpo-32314 [https://bugs.python.org/issue?@action=redirect&bpo=32314]: 实现了asyncio.run()。

bpo-17852 [https://bugs.python.org/issue?@action=redirect&bpo=17852]: 基于对_Py_PyAtExit()语义的误解，撤销了不正确的修复。

bpo-32296 [https://bugs.python.org/issue?@action=redirect&bpo=32296]: 在C中实现了asyncio._get_running_loop()和get_event_loop()。这使得它们的速度提高了4倍。

bpo-32250 [https://bugs.python.org/issue?@action=redirect&bpo=32250]: 实现了 asyncio.current_task() 和 asyncio.all_tasks()。添加了旨在供替代任务实现使用的助手：asyncio._register_task、asyncio._enter_task、asyncio._leave_task``和 ``asyncio._unregister_task。弃用了``asyncio.Task.current_task()``和 asyncio.Task.all_tasks()。

bpo-32255 [https://bugs.python.org/issue?@action=redirect&bpo=32255]: 现在，当写入CSV文件时，单个空字段总是会被引用。这允许区分空行和由单个空字段组成的行。由Licht Takeuchi提供补丁。

bpo-32277 [https://bugs.python.org/issue?@action=redirect&bpo=32277]: 在不支持 chmod(..., follow_symlinks=False) 的平台上，引发``NotImplementedError``而不是 SystemError。由Anthony Sottile提供补丁。

bpo-30050 [https://bugs.python.org/issue?@action=redirect&bpo=30050]: signal.set_wakeup_fd的新参数warn_on_full_buffer让你控制当唤醒fd缓冲区溢出时Python是否在stderr上打印警告。

bpo-29137 [https://bugs.python.org/issue?@action=redirect&bpo=29137]: fpectl 库已被移除。它从未默认启用，在 x86-64 上从未正确工作，并且它以导致 C 扩展意外中断的方式改变了 Python ABI。

bpo-32273 [https://bugs.python.org/issue?@action=redirect&bpo=32273]: 将 asyncio.test_utils 移动到 test.test_asyncio。

bpo-32272 [https://bugs.python.org/issue?@action=redirect&bpo=32272]: 移除 asyncio.async() 函数。

bpo-32269 [https://bugs.python.org/issue?@action=redirect&bpo=32269]: 添加 asyncio.get_running_loop() 函数。

bpo-32265 [https://bugs.python.org/issue?@action=redirect&bpo=32265]: All class and static methods of builtin types now are correctly classified by inspect.classify_class_attrs() and grouped in pydoc ouput. Added types.ClassMethodDescriptorType for unbound class methods of builtin types.

bpo-32253 [https://bugs.python.org/issue?@action=redirect&bpo=32253]: 弃用 yield from lock, await lock, with (yield from lock) 和 with await lock 用于 asyncio 同步原语。

bpo-22589 [https://bugs.python.org/issue?@action=redirect&bpo=22589]: 将 .bmp 的 MIME 类型从 'image/x-ms-bmp' 改为 'image/bmp'。

bpo-32193 [https://bugs.python.org/issue?@action=redirect&bpo=32193]: 将 asyncio 转换为使用 async/await 语法。旧式的 yield from 仍然支持。

bpo-32206 [https://bugs.python.org/issue?@action=redirect&bpo=32206]: 添加支持以使用 pdb 运行模块。

bpo-32227 [https://bugs.python.org/issue?@action=redirect&bpo=32227]: functools.singledispatch 现在支持使用类型注释注册实现。

bpo-15873 [https://bugs.python.org/issue?@action=redirect&bpo=15873]: 添加了新的替代构造函数 datetime.datetime.fromisoformat(), datetime.time.fromisoformat() 和 datetime.date.fromisoformat() 作为各自类 isoformat 方法的逆操作。

bpo-32199 [https://bugs.python.org/issue?@action=redirect&bpo=32199]: getnode() ip 获取器现在使用 'ip link' 而不是 'ip link list'。

bpo-32143 [https://bugs.python.org/issue?@action=redirect&bpo=32143]: os.statvfs() 包含来自 statvfs(2) 的 f_fsid 字段。

bpo-26439 [https://bugs.python.org/issue?@action=redirect&bpo=26439]: 通过实现 ctypes._aix.find_library() 修复 ctypes.util.find_library() 在 AIX 上的问题。补丁由：Michael Felt

bpo-31993 [https://bugs.python.org/issue?@action=redirect&bpo=31993]: 当将大的 bytes 和 str 对象序列化到文件时，pickler 现在使用更少的内存。使用协议 4 创建的 pickle 将需要更少的内存来反序列化大的 bytes 和 str 对象。

bpo-27456 [https://bugs.python.org/issue?@action=redirect&bpo=27456]: 确保在 Linux 上设置 TCP_NODELAY。测试由 Victor Stinner 完成。

bpo-31778 [https://bugs.python.org/issue?@action=redirect&bpo=31778]: 现在ast.literal_eval()更加严格。不再允许任意数字的加减法。

bpo-31802 [https://bugs.python.org/issue?@action=redirect&bpo=31802]: 即使`os`模块尚未导入，导入原生路径模块(posixpath, ntpath)现在也能正常工作。

bpo-30241 [https://bugs.python.org/issue?@action=redirect&bpo=30241]: 添加contextlib.AbstractAsyncContextManager。由Jelle Zijlstra提供补丁。

bpo-31699 [https://bugs.python.org/issue?@action=redirect&bpo=31699]: 修复了当任务参数或结果导致pickling或unpickling错误时 concurrent.futures.ProcessPoolExecutor 中的死锁问题。这应确保对 ProcessPoolExecutor API的调用最终总能返回。

bpo-15216 [https://bugs.python.org/issue?@action=redirect&bpo=15216]: TextIOWrapper.reconfigure() 支持更改*encoding*, errors, 和*newline*。

文档

bpo-32418 [https://bugs.python.org/issue?@action=redirect&bpo=32418]: 向Server和AbstractServer类添加get_loop()方法。

测试

bpo-32252 [https://bugs.python.org/issue?@action=redirect&bpo=32252]: 修复用于在测试崩溃时防止核心转储文件的faulthandler_suppress_crash_report()。getrlimit()在成功时返回零。

bpo-32002 [https://bugs.python.org/issue?@action=redirect&bpo=32002]: 调整C语言环境强制测试，针对空语言环境和POSIX语言环境情况，更容易适应平台依赖行为。

Windows

bpo-19764 [https://bugs.python.org/issue?@action=redirect&bpo=19764]: Implement support for subprocess.Popen(close_fds=True) on Windows. Patch by Segev Finer.

工具/示例

bpo-24960 [https://bugs.python.org/issue?@action=redirect&bpo=24960]: 2to3和lib2to3现在可以使用pkgutil.get_data()读取pickled语法文件，而不是探测文件系统。这使得2to3和lib2to3在从zipfile运行时也能工作。

C API

bpo-32030 [https://bugs.python.org/issue?@action=redirect&bpo=32030]: 如果未设置 PYTHONMALLOC 环境变量，Py_Initialize()不会将内存分配器重置为默认值。

bpo-29084 [https://bugs.python.org/issue?@action=redirect&bpo=29084]: OrderedDict的未记录C API已从有限C API中排除。它是被错误添加的，实际上在有限C API中从未工作过。

bpo-32264 [https://bugs.python.org/issue?@action=redirect&bpo=32264]: 将pygetopt.h头文件移动到internal/，因为它没有公共API。

bpo-32241 [https://bugs.python.org/issue?@action=redirect&bpo=32241]: Py_SetProgramName() and Py_SetPythonHome() now take the const wchar * arguments instead of wchar *.

Python 3.7.0 alpha 3

发布日期: 2017-12-05

核心与内置函数

bpo-32176 [https://bugs.python.org/issue?@action=redirect&bpo=32176]: 现在，代码对象构造函数会根据freevars和cellvars正确设置co_flags.CO_NOFREE，而不是需要调用者正确设置。这确保了当额外的cell引用被注入到修改后的代码对象和函数中时，它会自动清除。

bpo-10544 [https://bugs.python.org/issue?@action=redirect&bpo=10544]: 现在在推导式和生成器表达式中不推荐使用yield表达式。它们仍然允许在最外层可迭代对象的定义中使用，因为那是在封闭作用域中直接评估的。

bpo-32137 [https://bugs.python.org/issue?@action=redirect&bpo=32137]: 现在，深度嵌套字典的repr会引发RecursionError，而不是因为堆栈溢出而崩溃。

bpo-32096 [https://bugs.python.org/issue?@action=redirect&bpo=32096]: 在C API中恢复内存分配器的更改：将结构体从_PyRuntime移回Objects/obmalloc.c。内存分配器再次静态初始化，因此PyMem_RawMalloc()和Py_DecodeLocale()可以在_PyRuntime_Initialize()之前调用。

bpo-32043 [https://bugs.python.org/issue?@action=redirect&bpo=32043]: 添加了一个新的“开发者模式”：新的“-X dev”命令行选项，用于在运行时启用调试检查。

bpo-32023 [https://bugs.python.org/issue?@action=redirect&bpo=32023]: 现在，当在类定义中使用没有括号的生成器表达式代替继承列表时，会正确引发SyntaxError。只有在调用时可以省略括号的重复。

bpo-32012 [https://bugs.python.org/issue?@action=redirect&bpo=32012]: 现在，当传递一个没有括号的生成器表达式作为参数，但后面跟着一个尾随逗号时，会正确引发SyntaxError。生成器表达式总是需要直接在一组括号内，并且不能在两边有任何逗号。

bpo-28180 [https://bugs.python.org/issue?@action=redirect&bpo=28180]: 添加了一个新的内部 _Py_SetLocaleFromEnv(category) 辅助函数，以提高不同``libc``实现之间行为的一致性（例如，Android默认不支持从环境设置区域设置）。

bpo-31949 [https://bugs.python.org/issue?@action=redirect&bpo=31949]: 修复了打印回溯（PyTraceBack_Print()）中的若干问题。现在将sys.tracebacklimit设置为0或更小会抑制回溯的打印。将sys.tracebacklimit设置为None现在会导致使用默认限制。将sys.tracebacklimit设置为大于LONG_MAX的整数现在意味着使用LONG_MAX限制而不是默认限制。修复了Windows上超过 2**31 个回溯项时的整数溢出问题。修复了输出错误处理。

bpo-30696 [https://bugs.python.org/issue?@action=redirect&bpo=30696]: 修复了在没有内存时交互式解释器无限循环的问题。

bpo-20047 [https://bugs.python.org/issue?@action=redirect&bpo=20047]: Bytearray方法partition()和rpartition()现在仅接受类似字节的对象作为分隔符，如文档所述。特别是，现在当传递整数作为分隔符时，它们会引发TypeError而不是返回一个虚假的结果。

bpo-21720 [https://bugs.python.org/issue?@action=redirect&bpo=21720]: 当 __import__() 的 fromlist 参数或模块的 __all__ 属性包含bytes实例时，不再发出BytesWarning。

bpo-31845 [https://bugs.python.org/issue?@action=redirect&bpo=31845]: 环境变量在解释器启动时再次被正确读取。

bpo-28936 [https://bugs.python.org/issue?@action=redirect&bpo=28936]: 确保在给定范围内首先检测到涉及参数和 global 或 nonlocal 的词法上第一个语法错误。由Ivan Levkivskyi提供补丁。

bpo-31825 [https://bugs.python.org/issue?@action=redirect&bpo=31825]: 修复了在解码转义的非ascii字节时'unicode-escape'编解码器和codecs.escape_decode()中的OverflowError。

bpo-31618 [https://bugs.python.org/issue?@action=redirect&bpo=31618]: 3.7a1中添加的每帧跟踪逻辑已更改，以便在发出 "line" 或 "opcode" 事件之前更新 frame->f_lineno。以前，操作码事件首先发出，因此偶尔会在帧上看到过时的行号。此功能的行为因此略有变化：当同时启用 f_trace_lines 和 f_trace_opcodes 时，行事件现在首先发生。

bpo-28603 [https://bugs.python.org/issue?@action=redirect&bpo=28603]: 在解释器退出时打印异常的完整上下文/原因链，即使链中的异常不可哈希或与后面的异常相等。由Zane Bitter提供补丁。

bpo-31786 [https://bugs.python.org/issue?@action=redirect&bpo=31786]: 修复 select 模块中负超时时间在 -1.0 和 0.0 之间的正确舍入问题。现在函数会按预期阻塞等待事件。此前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

bpo-31781 [https://bugs.python.org/issue?@action=redirect&bpo=31781]: 防止在调用未初始化的 zipimport.zipimporter 对象方法时崩溃。由 Oren Milman 提供补丁。

bpo-30399 [https://bugs.python.org/issue?@action=redirect&bpo=30399]: 单一参数的 BaseException 的标准 repr() 不再包含多余的尾随逗号。

bpo-31626 [https://bugs.python.org/issue?@action=redirect&bpo=31626]: 修复了调试内存分配器中的一个错误。在缩小内存块后存在对已释放内存的写入。

bpo-30817 [https://bugs.python.org/issue?@action=redirect&bpo=30817]: PyErr_PrintEx() clears now the ignored exception that may be raised by _PySys_SetObjectId(), for example when no memory.

库

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块的两项小修复：允许浅复制泛型类的实例，改进 __init_subclass__ 与泛型的交互。原始 PR 由 Ivan Levkivskyi 提供。

bpo-32214 [https://bugs.python.org/issue?@action=redirect&bpo=32214]: PEP 557，数据类。提供了一个装饰器，为使用类型注解指定字段的类添加样板方法。

bpo-27240 [https://bugs.python.org/issue?@action=redirect&bpo=27240]: 新电子邮件策略的头部折叠算法已被重写，这也修复了 bpo-30788 [https://bugs.python.org/issue?@action=redirect&bpo=30788]、bpo-31831 [https://bugs.python.org/issue?@action=redirect&bpo=31831] 和 bpo-32182 [https://bugs.python.org/issue?@action=redirect&bpo=32182]。特别是，现在可以正确进行 RFC2231 折叠。

bpo-32186 [https://bugs.python.org/issue?@action=redirect&bpo=32186]: io.FileIO.readall() 和 io.FileIO.read() 现在在获取文件大小时释放 GIL。修复了所有线程因无法访问的 NFS 服务器而挂起的问题。由 Nir Soffer 提供补丁。

bpo-32101 [https://bugs.python.org/issue?@action=redirect&bpo=32101]: 添加 sys.flags.dev_mode 标志

bpo-32154 [https://bugs.python.org/issue?@action=redirect&bpo=32154]: 已移除 asyncio.windows_utils.socketpair() 函数：直接使用 socket.socketpair()，该函数自 Python 3.5 起在所有平台上可用（此前在 Windows 上不可用）。asyncio.windows_utils.socketpair() 在 Python 3.5 及更新版本上只是 socket.socketpair 的别名。

bpo-32089 [https://bugs.python.org/issue?@action=redirect&bpo=32089]: 警告：在开发（-X dev）和调试模式（pydebug 构建）中，默认警告过滤器中对 ResourceWarning 使用“default”操作，而非“always”操作。

bpo-32107 [https://bugs.python.org/issue?@action=redirect&bpo=32107]: uuid.getnode() 现在优先返回普遍管理的 MAC 地址（如果可用），而不是本地管理的 MAC 地址。这为 uuid.uuid1() 返回的 UUID 提供了更好的全局唯一性保证。如果只有本地管理的 MAC 地址可用，则返回找到的第一个此类地址。

bpo-23033 [https://bugs.python.org/issue?@action=redirect&bpo=23033]: 在 ssl.match_hostname() 的第二个参数中，当主机名的最左侧段是且仅是一个字符时，现在支持通配符。由 Mandeep Singh 提供补丁。

bpo-12239 [https://bugs.python.org/issue?@action=redirect&bpo=12239]: Make msilib.SummaryInformation.GetProperty() return None when the value of property is VT_EMPTY. Initial patch by Mark Mc Mahon.

bpo-28334 [https://bugs.python.org/issue?@action=redirect&bpo=28334]: 在 netrc.netrc 中使用 os.path.expanduser() 来查找 ~/.netrc 文件。如果文件不存在，则抛出 FileNotFoundError。由 Dimitri Merejkowsky 提供补丁。

bpo-32121 [https://bugs.python.org/issue?@action=redirect&bpo=32121]: 使 tracemalloc.Traceback 的行为更类似于 traceback 模块，将帧从最旧到最新排序。Traceback.format() 现在接受负的 limit 参数，将结果截断为 abs(limit) 个最旧的帧。要获得旧的行为，可以使用 Traceback.format() 的新参数 most_recent_first。（补丁由 Jesse Bakker 提供。）

bpo-31325 [https://bugs.python.org/issue?@action=redirect&bpo=31325]: 修复了 RobotFileParser.parse() 方法中 collections.namedtuple() 的错误用法。初始由 Robin Wellner 提供补丁。

bpo-12382 [https://bugs.python.org/issue?@action=redirect&bpo=12382]: msilib.OpenDatabase() now raises a better exception message when it couldn't open or create an MSI file. Initial patch by William Tisäter.

bpo-19610 [https://bugs.python.org/issue?@action=redirect&bpo=19610]: setup() 现在会对某些字段的无效类型发出警告。当 classifiers、keywords 和 platforms 字段未指定为列表或字符串时，distutils.dist.Distribution 类现在会发出警告。

bpo-32071 [https://bugs.python.org/issue?@action=redirect&bpo=32071]: 为 python -m unittest 添加了 -k 命令行选项，以仅运行与给定模式匹配的测试。

bpo-10049 [https://bugs.python.org/issue?@action=redirect&bpo=10049]: 向 contextlib 添加了 nullcontext 无操作上下文管理器。这为处理可选上下文管理器时提供了比 ExitStack() 更简单、更快的替代方案。

bpo-28684 [https://bugs.python.org/issue?@action=redirect&bpo=28684]: 这里使用了新的 test.support.skip_unless_bind_unix_socket() 装饰器来跳过 asyncio 测试，这些测试因为平台缺少对 unix 域套接字的功能性 bind() 函数而失败（如在现在以强制模式运行 SELinux 的较新 Android 版本上的非 root 用户就是这种情况）。

bpo-32110 [https://bugs.python.org/issue?@action=redirect&bpo=32110]: codecs.StreamReader.read(n) 现在对于非负的 n，返回不超过 n 个字符/字节。这使得它与其他类似文件对象的 read() 方法兼容。

bpo-27535 [https://bugs.python.org/issue?@action=redirect&bpo=27535]: warnings 模块在警告过滤器的 "ignore" 操作的隐藏警告注册表中不再泄漏内存。warn_explicit() 函数不再为 "ignore" 操作将警告键添加到注册表中。

bpo-32088 [https://bugs.python.org/issue?@action=redirect&bpo=32088]: warnings: 当 Python 以调试模式构建（Py_DEBUG）时，DeprecationWarning、PendingDeprecationWarning 和 ImportWarning 警告现在默认显示。

bpo-1647489 [https://bugs.python.org/issue?@action=redirect&bpo=1647489]: 修复了可以匹配空字符串的正则表达式模式的搜索。现在可以在匹配空字符串后正确找到非空字符串。

bpo-25054 [https://bugs.python.org/issue?@action=redirect&bpo=25054]: 添加了对可以匹配空字符串的模式进行拆分的支持。

bpo-32072 [https://bugs.python.org/issue?@action=redirect&bpo=32072]: 修复了二进制 plists 的问题：修复了保存 bytearrays。相同的对象将只保存一次。相等的引用将作为相同的对象加载。添加了对保存和加载递归数据结构的支持。

bpo-32069 [https://bugs.python.org/issue?@action=redirect&bpo=32069]: 从asyncio中移除遗留的SSL传输，反正总是使用ssl.MemoryBIO。

bpo-32066 [https://bugs.python.org/issue?@action=redirect&bpo=32066]: asyncio: 在create_unix_connection中支持pathlib.Path；sock参数应为可选的

bpo-32046 [https://bugs.python.org/issue?@action=redirect&bpo=32046]: Updates 2to3 to convert from operator.isCallable(obj) to callable(obj). Patch by Dong-hee Na.

bpo-32018 [https://bugs.python.org/issue?@action=redirect&bpo=32018]: inspect.signature should follow PEP 8 [https://www.python.org/dev/peps/pep-0008], if the parameter has an annotation and a default value. Patch by Dong-hee Na.

bpo-32025 [https://bugs.python.org/issue?@action=redirect&bpo=32025]: 添加time.thread_time()和time.thread_time_ns()

bpo-32037 [https://bugs.python.org/issue?@action=redirect&bpo=32037]: 适应有符号32位整数的整数现在将使用协议0的INT操作码进行pickle。这将减少pickle的大小，加快pickle和unpickle的速度，并使这些整数在Python 2中作为int实例被unpickle。

bpo-32034 [https://bugs.python.org/issue?@action=redirect&bpo=32034]: 使asyncio.IncompleteReadError和LimitOverrunError可pickle。

bpo-32015 [https://bugs.python.org/issue?@action=redirect&bpo=32015]: 修复了在等待异步读写套接字期间重新连接套接字时asyncio的循环问题。

bpo-32011 [https://bugs.python.org/issue?@action=redirect&bpo=32011]: 恢复了对加载带有TYPE_INT64代码的marshal文件的支持。这些文件可以在Python 2.7中生成。

bpo-28369 [https://bugs.python.org/issue?@action=redirect&bpo=28369]: 增强add_reader/writer检查，确保套接字未被某些传输使用。之前，仅支持使用int FD调用add_reader/writer的情况。现在，对所有类文件对象都正确实现了检查。

bpo-31976 [https://bugs.python.org/issue?@action=redirect&bpo=31976]: 修复了当文件刷新缓慢时可能导致的竞态条件，如果从另一个线程关闭文件可能会导致段错误。

bpo-31985 [https://bugs.python.org/issue?@action=redirect&bpo=31985]: 正式弃用aifc.openfp、sunau.openfp和wave.openfp。自1993年的变更7bc817d5ba917528e8bd07ec461c635291e7b06a以来，这三个模块中的openfp作为向后兼容性问题，一直指向该模块的open函数，尽管它既未经测试也无文档记录。

bpo-21862 [https://bugs.python.org/issue?@action=redirect&bpo=21862]: cProfile command line now accepts -m module_name as an alternative to script path. Patch by Sanyam Khurana.

bpo-31970 [https://bugs.python.org/issue?@action=redirect&bpo=31970]: 降低asyncio调试模式的性能开销。

bpo-31843 [https://bugs.python.org/issue?@action=redirect&bpo=31843]: sqlite3.connect()的 database 参数现在接受一个 path-like object，而不仅仅是一个字符串。

bpo-31945 [https://bugs.python.org/issue?@action=redirect&bpo=31945]: 为 HTTPConnection 和 HTTPSConnection 添加可配置的 blocksize 以提高上传吞吐量。由Nir Soffer提供补丁。

bpo-31943 [https://bugs.python.org/issue?@action=redirect&bpo=31943]: 向 asyncio.Handle 添加一个 cancelled() 方法。由Marat Sharafutdinov提供补丁。

bpo-9678 [https://bugs.python.org/issue?@action=redirect&bpo=9678]: 修复了uuid模块中确定MAC地址的问题：在NetBSD和OpenBSD上使用ifconfig。在Linux、FreeBSD、NetBSD和OpenBSD上使用arp。基于Takayuki Shimizukawa的补丁。

bpo-30057 [https://bugs.python.org/issue?@action=redirect&bpo=30057]: 修复了signal.signal()中潜在的信号丢失问题。

bpo-31933 [https://bugs.python.org/issue?@action=redirect&bpo=31933]: 修复Blake2参数leaf_size和node_offset在大端平台上的问题。由Jack O'Connor提供补丁。

bpo-21423 [https://bugs.python.org/issue?@action=redirect&bpo=21423]: 向{Process,Thread}PoolExecutor添加一个初始化参数。

bpo-31927 [https://bugs.python.org/issue?@action=redirect&bpo=31927]: 修复了socket模块在NetBSD 8上的编译问题。修复了在NetBSD和DragonFly BSD上解析AF_BLUETOOTH地址时的断言失败或读取任意数据的问题。

bpo-27666 [https://bugs.python.org/issue?@action=redirect&bpo=27666]: 修复了当类型chtype或mmask_t的大小小于C long的大小时，curses.box()和curses.ungetmouse()中的堆栈损坏问题。curses.box()现在接受字符作为参数。基于Steve Fink的补丁。

bpo-31917 [https://bugs.python.org/issue?@action=redirect&bpo=31917]: Add 3 new clock identifiers: time.CLOCK_BOOTTIME, time.CLOCK_PROF and time.CLOCK_UPTIME.

bpo-31897 [https://bugs.python.org/issue?@action=redirect&bpo=31897]: plistlib现在在读取二进制plist时会捕获更多错误，并抛出InvalidFileException而不是意外的异常。

bpo-25720 [https://bugs.python.org/issue?@action=redirect&bpo=25720]: 修复了检查curses WINDOW填充状态的方法。由Masayuki Yamamoto提供补丁。

bpo-31893 [https://bugs.python.org/issue?@action=redirect&bpo=31893]: 修复了OpenBSD和NetBSD上kqueue_event结构的布局。修复了kqueue_event对象的比较。

bpo-31891 [https://bugs.python.org/issue?@action=redirect&bpo=31891]: 修复了在NetBSD上构建curses模块的问题。

bpo-31884 [https://bugs.python.org/issue?@action=redirect&bpo=31884]: 向subprocess模块添加了在Windows上设置优先级所需的常量。

bpo-28281 [https://bugs.python.org/issue?@action=redirect&bpo=28281]: 移除了Calendar.weekday()函数对年份(1-9999)的限制。由Mark Gollahon提供补丁。

bpo-31702 [https://bugs.python.org/issue?@action=redirect&bpo=31702]: crypt.mksalt() 现在允许指定 SHA-256 和 SHA-512 哈希的轮数。

bpo-30639 [https://bugs.python.org/issue?@action=redirect&bpo=30639]: inspect.getfile() 不再计算未知对象的 repr 以显示在错误消息中，以防止不良行为的自定义 repr。

bpo-30768 [https://bugs.python.org/issue?@action=redirect&bpo=30768]: 修复了当 timeout > 0 和 intr_flag=0 时 PyThread_acquire_lock_timed() 的 pthread+semaphore 实现：如果 sem_timedwait() 被信号（EINTR）中断，则重新计算超时。另见 PEP 475 [https://www.python.org/dev/peps/pep-0475]。

bpo-31854 [https://bugs.python.org/issue?@action=redirect&bpo=31854]: 添加 mmap.ACCESS_DEFAULT 常量。

bpo-31834 [https://bugs.python.org/issue?@action=redirect&bpo=31834]: 仅在 SSSE3+ 上使用优化的 BLAKE2 代码。纯 SSE2 实现比纯 C 参考实现慢。

bpo-28292 [https://bugs.python.org/issue?@action=redirect&bpo=28292]: 当日期超出 0001-01-01 到 9999-12-31 范围时，Calendar.itermonthdates() 将始终引发异常。为了支持不能容忍此类异常的应用程序，添加了新方法 itermonthdays3() 和 itermonthdays4()。新方法返回元组，不受 datetime.date 支持的范围限制。

bpo-28564 [https://bugs.python.org/issue?@action=redirect&bpo=28564]: shutil.rmtree() 函数的速度提高了 20--40%。这是通过使用 os.scandir() 函数实现的。

bpo-28416 [https://bugs.python.org/issue?@action=redirect&bpo=28416]: 具有 persistent_id() 方法的 pickle.Pickler 子类和具有 persistent_load() 方法的 pickle.Unpickler 子类的实例不再创建引用循环。

bpo-31653 [https://bugs.python.org/issue?@action=redirect&bpo=31653]: 如果可以立即获取多处理信号量，则不释放 GIL。

bpo-28326 [https://bugs.python.org/issue?@action=redirect&bpo=28326]: 修复当 stdout 和/或 stderr 关闭或为 None 时的 multiprocessing.Process。

bpo-20825 [https://bugs.python.org/issue?@action=redirect&bpo=20825]: Add subnet_of and superset_of containment tests to ipaddress.IPv6Network and ipaddress.IPv4Network. Patch by Michel Albert and Cheryl Sabella.

bpo-31827 [https://bugs.python.org/issue?@action=redirect&bpo=31827]: 移除 os.stat_float_times() 函数。该函数在 Python 2.3 中引入，用于向后兼容 Python 2.2，并从 Python 3.1 开始弃用。

bpo-31756 [https://bugs.python.org/issue?@action=redirect&bpo=31756]: Add a subprocess.Popen(text=False) keyword argument to subprocess functions to be more explicit about when the library should attempt to decode outputs into text. Patch by Andrew Clegg.

bpo-31819 [https://bugs.python.org/issue?@action=redirect&bpo=31819]: 添加 AbstractEventLoop.sock_recv_into()。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: 如果使用嵌套的日志适配器，内部 process() 方法不再被省略。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: LoggerAdapter 对象的 manager 属性现在可以正确设置了。

bpo-31806 [https://bugs.python.org/issue?@action=redirect&bpo=31806]: 修复 time.sleep(), threading.Lock.acquire() 和 socket.socket.settimeout() 中的超时舍入，以正确舍入 -1.0 和 0.0 之间的负超时。这些函数现在会按预期阻塞等待事件。之前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

bpo-31803 [https://bugs.python.org/issue?@action=redirect&bpo=31803]: time.clock() 和 time.get_clock_info('clock') 现在会发出 DeprecationWarning 警告。

bpo-31800 [https://bugs.python.org/issue?@action=redirect&bpo=31800]: 扩展了对解析 UTC 偏移的支持。strptime '%z' 现在可以解析由 datetime.isoformat 生成的输出，包括秒和微秒。

bpo-28603 [https://bugs.python.org/issue?@action=redirect&bpo=28603]: traceback: 修复了在打印异常回溯时，当当前异常或其上下文/原因链中的异常不可哈希时发生的 TypeError。由 Zane Bitter 提供补丁。

bpo-30541 [https://bugs.python.org/issue?@action=redirect&bpo=30541]: 添加新功能以密封模拟对象并防止自动创建子模拟对象。由 Mario Corchero 提供补丁。

bpo-31784 [https://bugs.python.org/issue?@action=redirect&bpo=31784]: 实现 PEP 564 [https://www.python.org/dev/peps/pep-0564]，向 time 模块添加 6 个具有纳秒分辨率的新函数：clock_gettime_ns(), clock_settime_ns(), monotonic_ns(), perf_counter_ns(), process_time_ns(), time_ns()。

bpo-30143 [https://bugs.python.org/issue?@action=redirect&bpo=30143]: 2to3 现在生成的代码使用 collections.abc 中的抽象集合类而不是 collections。

bpo-31770 [https://bugs.python.org/issue?@action=redirect&bpo=31770]: 防止多次调用 sqlite3.Cursor 对象的 __init__() 方法时崩溃。由 Oren Milman 提供补丁。

bpo-31764 [https://bugs.python.org/issue?@action=redirect&bpo=31764]: 防止在 sqlite3.Cursor.close() 中当 Cursor 对象未初始化时发生崩溃。补丁由 Oren Milman 提供。

bpo-31752 [https://bugs.python.org/issue?@action=redirect&bpo=31752]: 修复在调用自定义整数的 timedelta 构造函数时可能发生的崩溃。

bpo-31620 [https://bugs.python.org/issue?@action=redirect&bpo=31620]: 空的 asyncio.Queue 现在在队列获取轮询超时时不会泄漏内存。

bpo-31690 [https://bugs.python.org/issue?@action=redirect&bpo=31690]: 允许将 re.ASCII、re.LOCALE 和 re.UNICODE 标志用作正则表达式的组标志。

bpo-30349 [https://bugs.python.org/issue?@action=redirect&bpo=30349]: 如果正则表达式包含将来会语义变化的字符集构造（嵌套集和集操作），现在会发出 FutureWarning。

bpo-31664 [https://bugs.python.org/issue?@action=redirect&bpo=31664]: 在 crypt 模块中添加了对 Blowfish 哈希的支持。

bpo-31632 [https://bugs.python.org/issue?@action=redirect&bpo=31632]: 修复 asyncio 模块中 _SSLProtocolTransport 类的 set_protocol() 方法。此方法之前修改了错误的协议引用。

bpo-15037 [https://bugs.python.org/issue?@action=redirect&bpo=15037]: 为 ncurses 5.7 及更早版本的 curses 中的 getkey() 添加了一个变通方案。

bpo-31307 [https://bugs.python.org/issue?@action=redirect&bpo=31307]: 允许使用字节对象作为 configparser.ConfigParser.read() 的参数。补丁由 Vincent Michel 提供。

bpo-31334 [https://bugs.python.org/issue?@action=redirect&bpo=31334]: 修复 select 模块中的 poll.poll([timeout])，在所有操作系统上对于任意的负超时值，现在可以仅接受非负整数或 -1。由 Riccardo Coccioli 提供补丁。

bpo-31310 [https://bugs.python.org/issue?@action=redirect&bpo=31310]: 如果崩溃，multiprocessing 的信号量跟踪器应该重新启动。

bpo-31308 [https://bugs.python.org/issue?@action=redirect&bpo=31308]: 使 multiprocessing 的 forkserver 进程免受 Ctrl-C 和其他用户中断的影响。如果崩溃，必要时重启它。

bpo-31245 [https://bugs.python.org/issue?@action=redirect&bpo=31245]: Added support for AF_UNIX socket in asyncio create_datagram_endpoint.

bpo-30553 [https://bugs.python.org/issue?@action=redirect&bpo=30553]: 将 HTTP/2 状态码 421（Misdirected Request）添加到 http.HTTPStatus。由 Vitor Pereira 提供补丁。

文档

bpo-32105 [https://bugs.python.org/issue?@action=redirect&bpo=32105]: 添加了 asyncio.BaseEventLoop.connect_accepted_socket 的 versionadded 标记。

测试

bpo-31380 [https://bugs.python.org/issue?@action=redirect&bpo=31380]: 在 macOS 上跳过 test_httpservers 的 test_undecodable_file 测试：在 APFS 上失败。

bpo-31705 [https://bugs.python.org/issue?@action=redirect&bpo=31705]: 在早于4.5版本的Linux内核上跳过test_socket.test_sha256()测试。该测试在内核3.10（ppc64le架构）上会因ENOKEY而失败。此问题已在4.5内核中修复。

bpo-32138 [https://bugs.python.org/issue?@action=redirect&bpo=32138]: 在Android上跳过引发SIGSEGV的test_faulthandler测试，并移除test.support.requires_android_level装饰器。

bpo-32136 [https://bugs.python.org/issue?@action=redirect&bpo=32136]: 运行时嵌入测试已从 Lib/test/test_capi.py 分离出来，移至新文件``Lib/test/test_embed.py``。

bpo-28668 [https://bugs.python.org/issue?@action=redirect&bpo=28668]: 移除了test.support.requires_multiprocessing_queue。当信号量实现损坏或缺失时，改用test.support.import_module('multiprocessing.synchronize')跳过测试。

bpo-32126 [https://bugs.python.org/issue?@action=redirect&bpo=32126]: 当sem_open()功能不正常时，跳过test.test_asyncio.test_events中的test_get_event_loop_new_process测试。

bpo-31174 [https://bugs.python.org/issue?@action=redirect&bpo=31174]: 修复test_tools.test_unparse：DirectoryTestCase现在存储样本名称以始终测试相同的文件。这避免了在查找引用泄漏时产生误报。

构建

bpo-28538 [https://bugs.python.org/issue?@action=redirect&bpo=28538]: 撤销之前的更改，if_nameindex结构由统一头文件定义。

bpo-28762 [https://bugs.python.org/issue?@action=redirect&bpo=28762]: 撤销最后一次提交，F_LOCK宏由Android统一头文件定义。

bpo-29040 [https://bugs.python.org/issue?@action=redirect&bpo=29040]: 支持使用统一头文件构建Android。首个支持统一头文件的NDK版本是android-ndk-r14。

bpo-32059 [https://bugs.python.org/issue?@action=redirect&bpo=32059]: setup.py 中的 detect_modules() 现在在交叉编译时也会搜索sysroot路径。

bpo-31957 [https://bugs.python.org/issue?@action=redirect&bpo=31957]: 修复为Windows构建时的Windows SDK版本检测。

bpo-31609 [https://bugs.python.org/issue?@action=redirect&bpo=31609]: 修复PCbuild/clean.bat中的引号问题。

bpo-31934 [https://bugs.python.org/issue?@action=redirect&bpo=31934]: 当构建源树不干净时中止构建。

bpo-31926 [https://bugs.python.org/issue?@action=redirect&bpo=31926]: 修复了当.c文件中有多个同名函数和/或方法时，Argument Clinic有时会导致编译错误的问题。

bpo-28791 [https://bugs.python.org/issue?@action=redirect&bpo=28791]: 更新Windows构建以使用SQLite 3.21.0。

bpo-28791 [https://bugs.python.org/issue?@action=redirect&bpo=28791]: 更新OS X安装程序以使用SQLite 3.21.0。

bpo-28643 [https://bugs.python.org/issue?@action=redirect&bpo=28643]: 使用stamp文件记录profile-opt构建进度。

bpo-31866 [https://bugs.python.org/issue?@action=redirect&bpo=31866]: 完成移除对AtheOS的支持。

Windows

bpo-1102 [https://bugs.python.org/issue?@action=redirect&bpo=1102]: 当 View.Fetch() 返回 ERROR_NO_MORE_ITEMS 时返回 None，而不是引发``MSIError``。初始由Anthony Tuininga提供补丁。

bpo-31944 [https://bugs.python.org/issue?@action=redirect&bpo=31944]: 修复应用和功能对话框中的修改按钮。

bpo-20486 [https://bugs.python.org/issue?@action=redirect&bpo=20486]: 实现 Database.Close() 方法以帮助关闭MSI数据库对象。

bpo-31857 [https://bugs.python.org/issue?@action=redirect&bpo=31857]: 在多线程环境中使USE_STACKCHECK的行为变得确定。

macOS

bpo-31392 [https://bugs.python.org/issue?@action=redirect&bpo=31392]: 更新macOS安装程序以使用OpenSSL 1.0.2m。

IDLE

bpo-32207 [https://bugs.python.org/issue?@action=redirect&bpo=32207]: 在IDLE中改进tk事件异常回溯。当tk事件处理由IDLE的运行循环驱动时，不再向tk事件异常回溯中添加令人困惑和分散注意力的queue.EMPTY回溯上下文。现在，回溯与事件处理由用户代码驱动时相同。基于Serhiy Storchaka的建议的补丁。

bpo-32164 [https://bugs.python.org/issue?@action=redirect&bpo=32164]: 删除未使用的文件idlelib/tabbedpages.py。在configdialog中使用TabbedPageSet已被ttk.Notebook替代。

bpo-32100 [https://bugs.python.org/issue?@action=redirect&bpo=32100]: IDLE: 修复pathbrowser中的旧错误和新错误；改进测试。补丁主要由Cheryl Sabella提供。

bpo-31858 [https://bugs.python.org/issue?@action=redirect&bpo=31858]: IDLE -- 将shell提示符操作限制在shell中。编辑器和输出窗口仅看到一个空的最后提示行。这简化了代码并修复了插入换行时的一个小错误。如果存在Sys.ps1，则在Shell启动时读取，但不设置或更改。

bpo-31860 [https://bugs.python.org/issue?@action=redirect&bpo=31860]: IDLE配置对话框中的字体样本现在可编辑。更改在IDLE保持打开时持续存在。

bpo-31836 [https://bugs.python.org/issue?@action=redirect&bpo=31836]: 现在如果在设置ps1的test_idle之后运行，Test_code_module将通过。代码模块如果存在则使用sys.ps1，如果不存在则设置为'>>> '。Test_code_module现在正确测试了这两种行为。ps2同理。

bpo-28603 [https://bugs.python.org/issue?@action=redirect&bpo=28603]: 修复了一个TypeError，该错误在打印包含不可哈希异常的追溯时导致shell重启。补丁由Zane Bitter提供。

bpo-13802 [https://bugs.python.org/issue?@action=redirect&bpo=13802]: 在IDLE的字体设置示例中使用非拉丁字符。即使用户选择的字体仅定义了Unicode基本多语言平面的一个有限子集，tcl/tk也会使用定义了该字符的其他字体。扩展后的示例让使用非拉丁字符的用户更清楚地了解他们在IDLE的shell和编辑器中可能会看到的内容。为了给扩展后的示例腾出空间，字体标签页上的框架被重新排列。字体/标签帮助文档对这些新增内容进行了一些说明。

工具/示例

bpo-32159 [https://bugs.python.org/issue?@action=redirect&bpo=32159]: 移除CVS和Subversion工具：删除svneol.py和treesync.py脚本。CPython已经从CVS迁移到Subversion，再到Mercurial，最后到Git。CVS和Subversion已不再用于CPython的开发。

bpo-30722 [https://bugs.python.org/issue?@action=redirect&bpo=30722]: 使redemo能够在Python 3.6及更新版本中工作。同时，移除 LOCALE 选项，因为它不适用于Python 3中的字符串模式。由Christoph Sarnowski提供补丁。

C API

bpo-20891 [https://bugs.python.org/issue?@action=redirect&bpo=20891]: 修复PyGILState_Ensure()。当PyGILState_Ensure()在非Python线程中且在PyEval_InitThreads()之前被调用时，仅在调用PyThreadState_New()之后调用PyEval_InitThreads()，以修复崩溃问题。

bpo-32125 [https://bugs.python.org/issue?@action=redirect&bpo=32125]: 已移除 Py_UseClassExceptionsFlag 标志。该标志自Python 2.0以来已被弃用且不再使用。

bpo-25612 [https://bugs.python.org/issue?@action=redirect&bpo=25612]: 将当前的异常状态从帧对象移动到协程。这简化了解释器，并修复了一些由于在进入或退出生成器时交换异常状态而导致的晦涩错误。

bpo-23699 [https://bugs.python.org/issue?@action=redirect&bpo=23699]: 添加Py_RETURN_RICHCOMPARE宏以减少富比较函数中的样板代码。

bpo-30697 [https://bugs.python.org/issue?@action=redirect&bpo=30697]: The PyExc_RecursionErrorInst singleton is removed and PyErr_NormalizeException() does not use it anymore. This singleton is persistent and its members being never cleared may cause a segfault during finalization of the interpreter. See also bpo-22898 [https://bugs.python.org/issue?@action=redirect&bpo=22898].

Python 3.7.0 alpha 2

发布日期: 2017-10-16

核心与内置函数

bpo-31558 [https://bugs.python.org/issue?@action=redirect&bpo=31558]: gc.freeze() 是一个新的API，它允许将垃圾收集器当前跟踪的所有对象移动到永久代，从而有效地将它们从未来的收集事件中移除。这可以用来保护这些对象的PyGC_Head不被改变。实际上，这为fork()提供了极佳的写时复制稳定性。

bpo-31642 [https://bugs.python.org/issue?@action=redirect&bpo=31642]: 通过将sys.modules["package.module"]设置为None，恢复了阻塞的"from package import module"。

bpo-31708 [https://bugs.python.org/issue?@action=redirect&bpo=31708]: 允许在同步函数中使用异步生成器表达式。

bpo-31709 [https://bugs.python.org/issue?@action=redirect&bpo=31709]: 放弃对异步__aiter__的支持。

bpo-30404 [https://bugs.python.org/issue?@action=redirect&bpo=30404]: -u选项现在使stdout和stderr流变为无缓冲而非行缓冲。

bpo-31619 [https://bugs.python.org/issue?@action=redirect&bpo=31619]: 修复了将带有大量下划线的字符串转换为二进制基数整数时的ValueError。

bpo-31602 [https://bugs.python.org/issue?@action=redirect&bpo=31602]: Fix an assertion failure in zipimporter.get_source() in case of a bad zlib.decompress(). Patch by Oren Milman.

bpo-31592 [https://bugs.python.org/issue?@action=redirect&bpo=31592]: Fixed an assertion failure in Python parser in case of a bad unicodedata.normalize(). Patch by Oren Milman.

bpo-31588 [https://bugs.python.org/issue?@action=redirect&bpo=31588]: Raise a TypeError with a helpful error message when class creation fails due to a metaclass with a bad __prepare__() method. Patch by Oren Milman.

bpo-31574 [https://bugs.python.org/issue?@action=redirect&bpo=31574]: 为importlib装备了两个dtrace探针以分析导入时间。

bpo-31566 [https://bugs.python.org/issue?@action=redirect&bpo=31566]: Fix an assertion failure in _warnings.warn() in case of a bad __name__ global. Patch by Oren Milman.

bpo-31506 [https://bugs.python.org/issue?@action=redirect&bpo=31506]: Improved the error message logic for object.__new__ and object.__init__.

bpo-31505 [https://bugs.python.org/issue?@action=redirect&bpo=31505]: Fix an assertion failure in json, in case _json.make_encoder() received a bad encoder() argument. Patch by Oren Milman.

bpo-31492 [https://bugs.python.org/issue?@action=redirect&bpo=31492]: 修复了在从具有错误 __name__ 属性的模块导入失败时，以及在访问此类模块的属性失败时的断言失败。由Oren Milman提供补丁。

bpo-31478 [https://bugs.python.org/issue?@action=redirect&bpo=31478]: Fix an assertion failure in _random.Random.seed() in case the argument has a bad __abs__() method. Patch by Oren Milman.

bpo-31336 [https://bugs.python.org/issue?@action=redirect&bpo=31336]: 通过减少必要的特殊方法查找的开销，加快类创建速度10-20%。由 Stefan Behnel 提供补丁。

bpo-31415 [https://bugs.python.org/issue?@action=redirect&bpo=31415]: 添加 -X importtime 选项以显示每个导入花费的时间。可用于优化应用程序的启动时间。支持使用 PYTHONPROFILEIMPORTTIME 作为启用此功能的等效方式。

bpo-31410 [https://bugs.python.org/issue?@action=redirect&bpo=31410]: 优化了调用包装器和类方法描述符。

bpo-31353 [https://bugs.python.org/issue?@action=redirect&bpo=31353]: PEP 553 [https://www.python.org/dev/peps/pep-0553] - 添加一个名为 breakpoint() 的新内置函数，它会调用 sys.breakpointhook()。默认情况下，这会导入 pdb 并调用 pdb.set_trace()，但用户可以覆盖 sys.breakpointhook() 来调用他们想要的任何调试器。钩子的原始值保存在 sys.__breakpointhook__ 中。

bpo-17852 [https://bugs.python.org/issue?@action=redirect&bpo=17852]: 维护一个打开的缓冲文件列表，在退出解释器之前刷新它们。基于 Armin Rigo 的补丁。

bpo-31315 [https://bugs.python.org/issue?@action=redirect&bpo=31315]: 修复 imp.create_dynamic() 中当 spec.name 不是字符串时的断言失败。由 Oren Milman 提供补丁。

bpo-31311 [https://bugs.python.org/issue?@action=redirect&bpo=31311]: Fix a crash in the __setstate__() method of ctypes._CData, in case of a bad __dict__. Patch by Oren Milman.

bpo-31293 [https://bugs.python.org/issue?@action=redirect&bpo=31293]: 修复 timedelta 对象与具有坏的 as_integer_ratio() 方法的浮点数进行真除法和乘法时的崩溃。由 Oren Milman 提供补丁。

bpo-31285 [https://bugs.python.org/issue?@action=redirect&bpo=31285]: Fix an assertion failure in warnings.warn_explicit, when the return value of the received loader's get_source() has a bad splitlines() method. Patch by Oren Milman.

bpo-30406 [https://bugs.python.org/issue?@action=redirect&bpo=30406]: 使 async 和 await 成为合适的关键字，如 PEP 492 [https://www.python.org/dev/peps/pep-0492] 所规定。

库

bpo-30058 [https://bugs.python.org/issue?@action=redirect&bpo=30058]: 修复 select.kqueue.control() 中的缓冲区溢出。

bpo-31672 [https://bugs.python.org/issue?@action=redirect&bpo=31672]: string.Template 中的 idpattern 匹配了一些非ASCII字符。现在它使用 -i 正则表达式本地标志来避免非ASCII字符。

bpo-31701 [https://bugs.python.org/issue?@action=redirect&bpo=31701]: 在Windows上，faulthandler.enable()现在会忽略MSC和COM异常。

bpo-31728 [https://bugs.python.org/issue?@action=redirect&bpo=31728]: Prevent crashes in _elementtree due to unsafe cleanup of Element.text and Element.tail. Patch by Oren Milman.

bpo-31671 [https://bugs.python.org/issue?@action=redirect&bpo=31671]: 现在 re.compile() 在编译前将传递的RegexFlag转换为普通的int对象。bm_regex_compile基准测试显示性能提升了14%。

bpo-30397 [https://bugs.python.org/issue?@action=redirect&bpo=30397]: The types of compiled regular objects and match objects are now exposed as re.Pattern and re.Match. This adds information in pydoc output for the re module.

bpo-31675 [https://bugs.python.org/issue?@action=redirect&bpo=31675]: 修复了Tkinter的splitlist()和split()方法在传递大于2 GiB的字符串时的内存泄漏问题。

bpo-31673 [https://bugs.python.org/issue?@action=redirect&bpo=31673]: 修复了Tkinter方法adderrorinfo()名称中的拼写错误。

bpo-31648 [https://bugs.python.org/issue?@action=redirect&bpo=31648]: 对ElementTree中的路径谓词进行了改进：允许谓词部分周围有空格，例如"[a = 'text']"，而不是要求不太可读的"[a='text']"。添加了对当前节点文本比较的支持，如"[.='text']"。由Stefan Behnel提供补丁。

bpo-30806 [https://bugs.python.org/issue?@action=redirect&bpo=30806]: 修复了netrc对象的字符串表示。

bpo-31638 [https://bugs.python.org/issue?@action=redirect&bpo=31638]: 向 zipapp.create_archive 添加可选参数 compressed，并向 zipapp 的命令行界面添加选项 --compress。

bpo-25351 [https://bugs.python.org/issue?@action=redirect&bpo=25351]: 避免venv激活时因未定义变量而失败。

bpo-20519 [https://bugs.python.org/issue?@action=redirect&bpo=20519]: 尽可能避免使用ctypes并提高uuid的导入时间。

bpo-28293 [https://bugs.python.org/issue?@action=redirect&bpo=28293]: 当正则表达式缓存满时，不再完全清空。

bpo-31596 [https://bugs.python.org/issue?@action=redirect&bpo=31596]: 向time模块添加了pthread_getcpuclockid()。

bpo-27494 [https://bugs.python.org/issue?@action=redirect&bpo=27494]: 使2to3接受生成器表达式中的尾随逗号。例如，现在允许``set(x for x in [],)``。

bpo-30347 [https://bugs.python.org/issue?@action=redirect&bpo=30347]: 修复了在并发迭代itertools.groupby()迭代器时的崩溃问题。

bpo-30346 [https://bugs.python.org/issue?@action=redirect&bpo=30346]: 由itertools.groupby()迭代器生成的迭代器现在在推进groupby迭代器后会耗尽。

bpo-31556 [https://bugs.python.org/issue?@action=redirect&bpo=31556]: 如果超时<=0，则更快地取消asyncio.wait_for未来。

bpo-31540 [https://bugs.python.org/issue?@action=redirect&bpo=31540]: 允许在 concurrent.futures.ProcessPoolExecutor 构造函数中传递上下文对象。同时，提前释放 concurrent.futures.ProcessPoolExecutor 中的作业资源，以改善工作线程等待新作业时的内存使用情况。

bpo-31516 [https://bugs.python.org/issue?@action=redirect&bpo=31516]: threading.current_thread() 在关闭时不应返回一个虚拟线程。

bpo-31525 [https://bugs.python.org/issue?@action=redirect&bpo=31525]: 在 sqlite 模块中，要求 sqlite3_prepare_v2 API。因此，sqlite 模块现在要求 sqlite 版本至少为 3.3.9。

bpo-26510 [https://bugs.python.org/issue?@action=redirect&bpo=26510]: argparse 子解析器现在默认是必需的。这与 Python 2 的行为一致。对于可选的子解析器，使用新参数 add_subparsers(required=False)。由 Anthony Sottile 提供补丁。（截至 3.7.0rc1，默认值更改为非必需，这是自 Python 3.3 以来的情况。）

bpo-27541 [https://bugs.python.org/issue?@action=redirect&bpo=27541]: Reprs of subclasses of some collection and iterator classes (bytearray, array.array, collections.deque, collections.defaultdict, itertools.count, itertools.repeat) now contain actual type name insteads of hardcoded name of the base class.

bpo-31351 [https://bugs.python.org/issue?@action=redirect&bpo=31351]: 如果 pip 引导失败，python -m ensurepip 现在会以非零退出代码退出。

bpo-31389 [https://bugs.python.org/issue?@action=redirect&bpo=31389]: pdb.set_trace() 现在接受一个可选的关键字参数 header。如果提供，这将在调试开始前打印到控制台。

文档

bpo-31537 [https://bugs.python.org/issue?@action=redirect&bpo=31537]: 修复了 readline 文档示例代码中 get_history_length 的不正确用法。补丁由 Brad Smith 提供。

bpo-30085 [https://bugs.python.org/issue?@action=redirect&bpo=30085]: 为了清晰起见，优先使用没有双下划线的操作符函数。带有下划线的仅为了向后兼容而保留。

构建

bpo-31696 [https://bugs.python.org/issue?@action=redirect&bpo=31696]: 当 Python 使用 Clang 构建时，改进 sys.version 中的编译器版本信息。

bpo-31625 [https://bugs.python.org/issue?@action=redirect&bpo=31625]: 停止在静态库上使用 ranlib。相反，我们假设 ar 支持 's' 标志。

bpo-31624 [https://bugs.python.org/issue?@action=redirect&bpo=31624]: 移除对 BSD/OS 的支持。

bpo-22140 [https://bugs.python.org/issue?@action=redirect&bpo=22140]: 防止在 python-config.sh 中双重替换前缀。

bpo-31569 [https://bugs.python.org/issue?@action=redirect&bpo=31569]: 在构建脚本和文档中将PCBuild/更正为PCbuild/。

bpo-31536 [https://bugs.python.org/issue?@action=redirect&bpo=31536]: Avoid wholesale rebuild after make regen-all if nothing changed.

IDLE

bpo-31460 [https://bugs.python.org/issue?@action=redirect&bpo=31460]: 简化IDLE模块浏览器的API。传递一个小部件而不是带有根部件的flist，开启了创建一个仅是窗口一部分的浏览器框架的可能性。传递一个完整的文件名而不是假定来自.py文件的片段，开启了浏览不以.py结尾的python文件的可能性。

bpo-31649 [https://bugs.python.org/issue?@action=redirect&bpo=31649]: IDLE - 使_htest, _utest参数仅关键字。

bpo-31559 [https://bugs.python.org/issue?@action=redirect&bpo=31559]: 在idle_test.test_browser中移除测试顺序依赖。

bpo-31459 [https://bugs.python.org/issue?@action=redirect&bpo=31459]: 将IDLE的模块浏览器从类浏览器重命名为模块浏览器。原始的模块级类和方法浏览器多年前就变成了一个模块浏览器，增加了模块级函数。昨天又增加了嵌套类和函数。为了向后兼容，设置对话框的键标签上出现的虚拟事件<<open-class-browser>>没有被更改。补丁由Cheryl Sabella提供。

bpo-31500 [https://bugs.python.org/issue?@action=redirect&bpo=31500]: 现在默认字体在高DPI显示器上会进行缩放。

bpo-1612262 [https://bugs.python.org/issue?@action=redirect&bpo=1612262]: IDLE模块浏览器现在显示嵌套类和函数。代码和测试的原始补丁分别由Guilherme Polo和Cheryl Sabella提供。

C API

bpo-28280 [https://bugs.python.org/issue?@action=redirect&bpo=28280]: Make PyMapping_Keys(), PyMapping_Values() and PyMapping_Items() always return a list (rather than a list or a tuple). Patch by Oren Milman.

bpo-31532 [https://bugs.python.org/issue?@action=redirect&bpo=31532]: 修复由于在getpath.c中Py_GetPath()和Py_SetPath()之间的分配器混合导致的内存损坏。

bpo-25658 [https://bugs.python.org/issue?@action=redirect&bpo=25658]: 实现线程特定存储（TSS）API的 PEP 539 [https://www.python.org/dev/peps/pep-0539]：这是CPython的一个新的线程本地存储（TLS）API，将取代CPython解释器中现有的TLS API的使用，同时弃用现有的API。PEP由Erik M. Bray撰写，由Masayuki Yamamoto提供补丁。

Python 3.7.0 alpha 1

发布日期: 2017-09-19

安全性

bpo-29781 [https://bugs.python.org/issue?@action=redirect&bpo=29781]: 当尚未通过 BIO 执行握手时，SSLObject.version() 现在正确返回 None。

bpo-29505 [https://bugs.python.org/issue?@action=redirect&bpo=29505]: 为 oss-fuzz 添加 float(str)、int(str)、unicode(str) 的模糊测试。

bpo-30947 [https://bugs.python.org/issue?@action=redirect&bpo=30947]: 将内嵌的 libexpat 从版本 2.2.1 升级到 2.2.3 以获取安全修复。

bpo-30730 [https://bugs.python.org/issue?@action=redirect&bpo=30730]: 在 Windows 上防止子进程中的环境变量注入。防止传递其他环境变量和命令参数。

bpo-30694 [https://bugs.python.org/issue?@action=redirect&bpo=30694]: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple security vulnerabilities including: CVE-2017-9233 (External entity infinite loop DoS), CVE-2016-9063 (Integer overflow, re-fix), CVE-2016-0718 (Fix regression bugs from 2.2.0's fix to CVE-2016-0718) and CVE-2012-0876 (Counter hash flooding with SipHash). Note: the CVE-2016-5300 (Use os-specific entropy sources like getrandom) doesn't impact Python, since Python already gets entropy from the OS to set the expat secret using XML_SetHashSalt().

bpo-30500 [https://bugs.python.org/issue?@action=redirect&bpo=30500]: 修复 urllib.parse.splithost() 正确解析片段。例如，splithost('//127.0.0.1#@evil.com/') 现在正确返回 127.0.0.1 主机，而不是将 @evil.com 视为认证中的主机（login@host）。

bpo-29591 [https://bugs.python.org/issue?@action=redirect&bpo=29591]: Update expat copy from 2.1.1 to 2.2.0 to get fixes of CVE-2016-0718 and CVE-2016-4472. See https://sourceforge.net/p/expat/bugs/537/ for more information.

核心与内置函数

bpo-31490 [https://bugs.python.org/issue?@action=redirect&bpo=31490]: Fix an assertion failure in ctypes class definition, in case the class has an attribute whose name is specified in _anonymous_ but not in _fields_. Patch by Oren Milman.

bpo-31471 [https://bugs.python.org/issue?@action=redirect&bpo=31471]: Fix an assertion failure in subprocess.Popen() on Windows, in case the env argument has a bad keys() method. Patch by Oren Milman.

bpo-31418 [https://bugs.python.org/issue?@action=redirect&bpo=31418]: Fix an assertion failure in PyErr_WriteUnraisable() in case of an exception with a bad __module__ attribute. Patch by Oren Milman.

bpo-31416 [https://bugs.python.org/issue?@action=redirect&bpo=31416]: 修复当warnings.filters或warnings.defaultaction错误时的断言失败。由Oren Milman提供补丁。

bpo-28411 [https://bugs.python.org/issue?@action=redirect&bpo=28411]: 将直接使用PyInterpreterState.modules改为使用PyImport_GetModuleDict()。同时，在处理sys.modules的其他代码中引入更多一致性。这有助于减少在处理sys.modules时的复杂性。

bpo-28411 [https://bugs.python.org/issue?@action=redirect&bpo=28411]: 在处理 PyInterpreterState.modules 时切换到抽象API。这为以后支持所有字典子类和其他映射实现提供了可能。同时添加了一个 PyImport_GetModule() 函数以减少大量重复代码。

bpo-31411 [https://bugs.python.org/issue?@action=redirect&bpo=31411]: 当warnings.onceregistry不是字典时，抛出TypeError而不是SystemError。由Oren Milman提供补丁。

bpo-31344 [https://bugs.python.org/issue?@action=redirect&bpo=31344]: 为了更精细地控制测试解释器时的跟踪行为，添加了两个新的帧属性来控制特定跟踪事件的发出：f_trace_lines``（默认为 ``True）用于关闭每行跟踪事件；f_trace_opcodes (默认为 False) 用于开启每操作码跟踪事件。

bpo-31373 [https://bugs.python.org/issue?@action=redirect&bpo=31373]: 修复了几个由于浮点降级可能导致的未定义行为实例。

bpo-30465 [https://bugs.python.org/issue?@action=redirect&bpo=30465]: f-字符串中的位置信息（lineno``和 ``col_offset）现在（大部分）正确。这修复了像flake8这样的工具在错误行（通常是文件的第一行）显示警告的问题。

bpo-30860 [https://bugs.python.org/issue?@action=redirect&bpo=30860]: 将CPython的全局运行时状态整合到一个结构体中。这提高了运行时状态的可发现性。

bpo-31347 [https://bugs.python.org/issue?@action=redirect&bpo=31347]: 修复了_PyObject_FastCall_Prepend中可能存在的未定义行为。

bpo-31343 [https://bugs.python.org/issue?@action=redirect&bpo=31343]: Include sys/sysmacros.h for major(), minor(), and makedev(). GNU C libray plans to remove the functions from sys/types.h.

bpo-31291 [https://bugs.python.org/issue?@action=redirect&bpo=31291]: Fix an assertion failure in zipimport.zipimporter.get_data on Windows, when the return value of pathname.replace('/','\\') isn't a string. Patch by Oren Milman.

bpo-31271 [https://bugs.python.org/issue?@action=redirect&bpo=31271]: Fix an assertion failure in the write() method of io.TextIOWrapper, when the encoder doesn't return a bytes object. Patch by Oren Milman.

bpo-31243 [https://bugs.python.org/issue?@action=redirect&bpo=31243]: Fix a crash in some methods of io.TextIOWrapper, when the decoder's state is invalid. Patch by Oren Milman.

bpo-30721 [https://bugs.python.org/issue?@action=redirect&bpo=30721]: print 现在显示使用Python 2重定向语法的正确用法提示。由Sanyam Khurana提供补丁。

bpo-31070 [https://bugs.python.org/issue?@action=redirect&bpo=31070]: 修复importlib中_get_module_lock()的竞态条件。

bpo-30747 [https://bugs.python.org/issue?@action=redirect&bpo=30747]: 在MSVC上添加_Py_atomic_store和_Py_atomic_load的非虚拟实现。

bpo-31095 [https://bugs.python.org/issue?@action=redirect&bpo=31095]: 修复由未调用 PyObject_GC_UnTrack() 的 tp_dealloc 引起的GC期间潜在崩溃问题。

bpo-31071 [https://bugs.python.org/issue?@action=redirect&bpo=31071]: 当传递其他参数时，避免在使用*解包调用中掩盖原始TypeError。

bpo-30978 [https://bugs.python.org/issue?@action=redirect&bpo=30978]: str.format_map()现在传递键查找异常。之前任何异常都被替换为KeyError异常。

bpo-30808 [https://bugs.python.org/issue?@action=redirect&bpo=30808]: 对并发敏感的信号状态使用_Py_atomic API。

bpo-30876 [https://bugs.python.org/issue?@action=redirect&bpo=30876]: 从未加载的包中进行相对导入现在会重新导入包，而不是因SystemError失败。从非包中进行相对导入现在会因ImportError而非SystemError失败。

bpo-30703 [https://bugs.python.org/issue?@action=redirect&bpo=30703]: 改进信号传递。避免在信号处理程序中使用Py_AddPendingCall，以避免调用信号不安全函数。这里添加的测试在没有补丁的其他部分的情况下，在Linux和OS X上失败。这意味着我们的信号传递逻辑存在缺陷（某些信号可能会丢失）。

bpo-30765 [https://bugs.python.org/issue?@action=redirect&bpo=30765]: 当PyThread_acquire_lock()被要求不阻塞时，避免在pthread_mutex_lock()中阻塞。

bpo-31161 [https://bugs.python.org/issue?@action=redirect&bpo=31161]: 确保'Missing parentheses'语法错误消息仅应用于SyntaxError，而不是子类。补丁由Martijn Pieters提供。

bpo-30814 [https://bugs.python.org/issue?@action=redirect&bpo=30814]: 修复从包中导入子模块时的竞态条件。

bpo-30736 [https://bugs.python.org/issue?@action=redirect&bpo=30736]: 内部unicodedata数据库已升级到Unicode 10.0。

bpo-30604 [https://bugs.python.org/issue?@action=redirect&bpo=30604]: 将 co_extra_freefuncs 从每线程转移到每解释器以避免崩溃。

bpo-30597 [https://bugs.python.org/issue?@action=redirect&bpo=30597]: print 现在在作为 Python 2 语句使用时，自定义错误消息中显示预期的输入。由 Sanyam Khurana 提供补丁。

bpo-30682 [https://bugs.python.org/issue?@action=redirect&bpo=30682]: 移除了对某些 f-字符串过于严格的断言，例如 eval("f'\n'") 和 eval("f'\r'")。

bpo-30501 [https://bugs.python.org/issue?@action=redirect&bpo=30501]: 编译器现在为 "if"、"while" 和 "assert" 语句、"if" 表达式、生成器表达式和推导式中的复杂条件表达式生成更优化的代码。

bpo-28180 [https://bugs.python.org/issue?@action=redirect&bpo=28180]: 实现 :pep:`538`（传统 C 语言环境强制）。这意味着当有合适的强制目标区域设置可用时，核心解释器和区域设置感知的 C 扩展将假定使用 UTF-8 作为默认文本编码，而不是 ASCII。

bpo-30486 [https://bugs.python.org/issue?@action=redirect&bpo=30486]: 允许为 __closure__ 设置单元格值。由 Lisa Roach 提供补丁。

bpo-30537 [https://bugs.python.org/issue?@action=redirect&bpo=30537]: itertools.islice 现在接受类似整数的对象（具有 __index__ 方法）作为开始、停止和切片参数

bpo-25324 [https://bugs.python.org/issue?@action=redirect&bpo=25324]: Python 解析所需的令牌已移至 C。 COMMENT、NL 和 ENCODING。这样，当导入 tokenize 模块时，token 模块中的令牌和 tok_names 不会被更改。

bpo-29104 [https://bugs.python.org/issue?@action=redirect&bpo=29104]: 修复了 f-字符串中反斜杠的解析。

bpo-27945 [https://bugs.python.org/issue?@action=redirect&bpo=27945]: 修复了在搜索、插入或比较过程中输入集合被修改时，字典的各种段错误。基于 Duane Griffin 和 Tim Mitchell 的补丁。

bpo-25794 [https://bugs.python.org/issue?@action=redirect&bpo=25794]: 修复了 type.__setattr__() 和 type.__delattr__() 对于非 interned 属性名称的问题。基于 Eryk Sun 的补丁。

bpo-30039 [https://bugs.python.org/issue?@action=redirect&bpo=30039]: 如果解释器在恢复一系列嵌套的 'yield from' 或 'await' 调用过程中发生 KeyboardInterrupt，现在会正确地传递到最内层的帧。

bpo-28974 [https://bugs.python.org/issue?@action=redirect&bpo=28974]: object.__format__(x, '') 现在等同于 str(x) 而不是 format(str(self), '')。

bpo-30024 [https://bugs.python.org/issue?@action=redirect&bpo=30024]: 现在支持涉及绝对导入并将子模块绑定到名称的循环导入。

bpo-12414 [https://bugs.python.org/issue?@action=redirect&bpo=12414]: sys.getsizeof() on a code object now returns the sizes which includes the code struct and sizes of objects which it references. Patch by Dong-hee Na.

bpo-29839 [https://bugs.python.org/issue?@action=redirect&bpo=29839]: 如果 __len__() 返回一个大的负整数，len() 现在会引发 ValueError 而不是 OverflowError。

bpo-11913 [https://bugs.python.org/issue?@action=redirect&bpo=11913]: README.rst 现在被包含在 distutils 标准 README 列表中，因此也包含在源代码分发中。

bpo-29914 [https://bugs.python.org/issue?@action=redirect&bpo=29914]: 修复了 __reduce__ 和 __reduce_ex__() 的默认实现。object.__reduce__() 不再接受参数，object.__reduce_ex__() 现在需要一个参数。

bpo-29949 [https://bugs.python.org/issue?@action=redirect&bpo=29949]: 修复了 set 和 frozenset 对象的内存使用回归问题。

bpo-29935 [https://bugs.python.org/issue?@action=redirect&bpo=29935]: 修复了在传递错误类型的索引时，tuple、list 和 deque 的 index() 方法中的错误消息。

bpo-29816 [https://bugs.python.org/issue?@action=redirect&bpo=29816]: 移位操作现在引发 OverflowError 的机会更少。对于负计数，总是引发 ValueError 而不是 OverflowError。用非负计数移位零总是返回零。

bpo-24821 [https://bugs.python.org/issue?@action=redirect&bpo=24821]: 修复了在某些不幸的 Unicode 字符搜索中减慢到 25 倍的问题。

bpo-29102 [https://bugs.python.org/issue?@action=redirect&bpo=29102]: 向 PyInterpreterState 添加了一个唯一 ID。这使得更容易识别每个子解释器。

bpo-29894 [https://bugs.python.org/issue?@action=redirect&bpo=29894]: 如果 __complex__ 返回一个严格子类的实例，则会发出弃用警告。在 Python 的未来版本中，这可能是一个错误。

bpo-29859 [https://bugs.python.org/issue?@action=redirect&bpo=29859]: 当 thread_pthread.h 中的任何 pthread_* 调用失败时，显示正确的错误消息。

bpo-29849 [https://bugs.python.org/issue?@action=redirect&bpo=29849]: 修复了在从导入期间引发 ImportError 时的内存泄漏。

bpo-28856 [https://bugs.python.org/issue?@action=redirect&bpo=28856]: 修复了一个疏忽，即 %b 格式的字节应支持遵循缓冲区协议的对象。

bpo-29723 [https://bugs.python.org/issue?@action=redirect&bpo=29723]: bpo-29139 [https://bugs.python.org/issue?@action=redirect&bpo=29139] 中对 sys.path[0] 初始化的更改导致了一个回归问题，暴露了在执行来自 zip 文件、目录或其他导入位置的 __main__ 时 sys.path 初始化方式的不一致性。解释器现在一致避免将导入位置的父目录添加到 sys.path 中，并确保在插入命令行中指定的导入位置时不会无意中修改其他 sys.path 条目。

bpo-29568 [https://bugs.python.org/issue?@action=redirect&bpo=29568]: 经典字符串格式化格式字符串中的转义百分号 "%%" 不再允许两个百分号之间存在任何字符。

bpo-29714 [https://bugs.python.org/issue?@action=redirect&bpo=29714]: 修复了一个回归问题，即当包含零字节时，字节格式可能会失败。

bpo-29695 [https://bugs.python.org/issue?@action=redirect&bpo=29695]: bool()、float()、list() 和 tuple() 不再接受关键字参数。int() 的第一个参数现在只能作为位置参数传递。

bpo-28893 [https://bugs.python.org/issue?@action=redirect&bpo=28893]: 为从 __aiter__ 和 __anext__ 返回的无效可等待对象引发的错误设置了正确的 __cause__。

bpo-28876 [https://bugs.python.org/issue?@action=redirect&bpo=28876]: 即使 len(range) 引发 OverflowError，bool(range) 也能正常工作。

bpo-29683 [https://bugs.python.org/issue?@action=redirect&bpo=29683]: 修复了 _PyCode_SetExtra 中的内存分配问题。由 Brian Coleman 提供补丁。

bpo-29684 [https://bugs.python.org/issue?@action=redirect&bpo=29684]: 修复了 PyEval_CallObjectWithKeywords 的一个小回归问题。当 kwargs 不是字典时，它应该引发 TypeError。但当 args=NULL 且 kwargs 不是字典时，可能会导致段错误。

bpo-28598 [https://bugs.python.org/issue?@action=redirect&bpo=28598]: 支持在调用 str.__mod__ 之前调用 str 子类的 __rmod__。由 Martijn Pieters 提供补丁。

bpo-29607 [https://bugs.python.org/issue?@action=redirect&bpo=29607]: 修复了 CALL_FUNCTION_EX 的 stack_effect 计算。补丁由 Matthieu Dartiailh 提供。

bpo-29602 [https://bugs.python.org/issue?@action=redirect&bpo=29602]: 修复了在复杂子类的构造函数和具有 __complex__ 方法的输入中对有符号零的错误处理。由 Serhiy Storchaka 提供补丁。

bpo-29347 [https://bugs.python.org/issue?@action=redirect&bpo=29347]: 修复了在创建弱引用对象时可能解引用未定义指针的问题。

bpo-29463 [https://bugs.python.org/issue?@action=redirect&bpo=29463]: 向Module、ClassDef、FunctionDef和AsyncFunctionDef ast节点添加 docstring``字段。docstring不再是它们体中的第一个stmt。这影响了模块和类的代码对象的 ``co_firstlineno``和 ``co_lnotab。（在 bpo-32911 [https://bugs.python.org/issue?@action=redirect&bpo=32911] 中恢复。）

bpo-29438 [https://bugs.python.org/issue?@action=redirect&bpo=29438]: 修复了key sharing dict中的use-after-free问题。

bpo-29546 [https://bugs.python.org/issue?@action=redirect&bpo=29546]: 为 from ... import ... 设置了ImportError的'path'和'name'属性。

bpo-29546 [https://bugs.python.org/issue?@action=redirect&bpo=29546]: 使用位置改进了from-import错误消息

bpo-29478 [https://bugs.python.org/issue?@action=redirect&bpo=29478]: 在使用Compat32策略时，如果指定了max_line_length=None，它将不再被忽略。补丁由Mircea Cosbuc提供。

bpo-29319 [https://bugs.python.org/issue?@action=redirect&bpo=29319]: 防止RunMainFromImporter覆盖sys.path[0]。

bpo-29337 [https://bugs.python.org/issue?@action=redirect&bpo=29337]: 修复了比较代码对象时可能出现的BytesWarning。警告可能在编译时发出。

bpo-29327 [https://bugs.python.org/issue?@action=redirect&bpo=29327]: 修复了将可迭代关键字参数传递给sorted()时崩溃的问题。

bpo-29034 [https://bugs.python.org/issue?@action=redirect&bpo=29034]: 修复了os模块(path_converter)中的内存泄漏和use-after-free问题。

bpo-29159 [https://bugs.python.org/issue?@action=redirect&bpo=29159]: 修复了当x.__index__()引发异常时bytes(x)的回归问题。

bpo-29049 [https://bugs.python.org/issue?@action=redirect&bpo=29049]: 在调用Python函数时懒惰地调用_PyObject_GC_TRACK()。调用函数速度提高了5%。

bpo-28927 [https://bugs.python.org/issue?@action=redirect&bpo=28927]: bytes.fromhex()和bytearray.fromhex()现在忽略所有ASCII空白字符，而不仅仅是空格。由Robert Xiao提供补丁。

bpo-28932 [https://bugs.python.org/issue?@action=redirect&bpo=28932]: 如果不存在<sys/random.h>，则不包含它。

bpo-25677 [https://bugs.python.org/issue?@action=redirect&bpo=25677]: 修正了缩进块语法错误提示符的位置。基于Michael Layzell的补丁。

bpo-29000 [https://bugs.python.org/issue?@action=redirect&bpo=29000]: 修复了八进制数在交替形式下零填充的bytes格式化。

bpo-18896 [https://bugs.python.org/issue?@action=redirect&bpo=18896]: Python函数现在可以有超过255个参数。collections.namedtuple()现在支持超过255个元素的元组。

bpo-28596 [https://bugs.python.org/issue?@action=redirect&bpo=28596]: 在Android上，首选编码是UTF-8。补丁由Chi Hsuan Yen编写。

bpo-22257 [https://bugs.python.org/issue?@action=redirect&bpo=22257]: 清理解释器启动（参见 PEP 432 [https://www.python.org/dev/peps/pep-0432]）。

bpo-26919 [https://bugs.python.org/issue?@action=redirect&bpo=26919]: 在Android上，操作系统数据现在总是以UTF-8编码/解码，而不是使用区域设置编码，以避免与已经使用UTF-8的os.fsencode()和os.fsdecode()不一致。

bpo-28991 [https://bugs.python.org/issue?@action=redirect&bpo=28991]: functools.lru_cache()容易受到一个由猴子补丁len()函数触发的晦涩的重入错误的影响。

bpo-28147 [https://bugs.python.org/issue?@action=redirect&bpo=28147]: 修复了分割表字典中的内存泄漏：setattr()不能将合并表转换为分割表。补丁由INADA Naoki编写。

bpo-28739 [https://bugs.python.org/issue?@action=redirect&bpo=28739]: f字符串表达式不再被接受为文档字符串和由ast.literal_eval()处理，即使它们不包含表达式。

bpo-28512 [https://bugs.python.org/issue?@action=redirect&bpo=28512]: 修复了通过PyErr_SyntaxLocationEx()和PyErr_SyntaxLocationObject()设置SyntaxError的offset属性。

bpo-28918 [https://bugs.python.org/issue?@action=redirect&bpo=28918]: 修复了当Python使用Py_DEBUG定义构建时，xxlimited的交叉编译问题。

bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722]: 而不是无声地产生一个不支持方法中零参数 super() 的类，未能将新的``__classcell__``命名空间条目传递给 type.__new__ 现在会导致一个 DeprecationWarning 和一个支持零参数 super() 的类。

bpo-28797 [https://bugs.python.org/issue?@action=redirect&bpo=28797]: 修改类__dict__在一个描述符的__set_name__方法内部，该描述符在那个类内部使用，不再阻止调用其他描述符的__set_name__方法。

bpo-28799 [https://bugs.python.org/issue?@action=redirect&bpo=28799]: 移除 PyEval_GetCallStats() 函数并弃用未测试和未文档化的``sys.callstats()``函数。移除 CALL_PROFILE 特殊构建：使用 sys.setprofile() 函数、cProfile 或 profile 来分析函数调用。

bpo-12844 [https://bugs.python.org/issue?@action=redirect&bpo=12844]: 现在可以向一个函数传递超过255个参数。

bpo-28782 [https://bugs.python.org/issue?@action=redirect&bpo=28782]: 修复了在检查下一条指令是否为YIELD_FROM时 yield from 实现中的一个错误。由WORDCODE(bpo-26647 [https://bugs.python.org/issue?@action=redirect&bpo=26647])引入的回归问题。

bpo-28774 [https://bugs.python.org/issue?@action=redirect&bpo=28774]: 修复ASCII和Latin1编码器中当错误处理程序返回的字符串包含多个不可编码字符（对于ASCII编解码器是非ASCII字符，对于Latin1是超出U+0000-U+00FF范围的字符）时的错误位置。

bpo-28731 [https://bugs.python.org/issue?@action=redirect&bpo=28731]: 优化_PyDict_NewPresized()以创建正确大小的字典。将具有常量键的字典字面量的速度提高至30%。

bpo-28532 [https://bugs.python.org/issue?@action=redirect&bpo=28532]: 当提供-V选项两次时显示sys.version。

bpo-27100 [https://bugs.python.org/issue?@action=redirect&bpo=27100]: with语句现在在检查__exit__之前先检查__enter__。当两种方法都缺失时，这会给出不那么令人困惑的错误信息。由Jonathan Ellington提供补丁。

bpo-28746 [https://bugs.python.org/issue?@action=redirect&bpo=28746]: 在没有ioctl FIOCLEX和FIONCLEX命令的平台上修复set_inheritable()文件描述符方法。

bpo-26920 [https://bugs.python.org/issue?@action=redirect&bpo=26920]: 在没有langinfo的平台上修复初始化解释器时未获取区域设置的字符集的问题。

bpo-28648 [https://bugs.python.org/issue?@action=redirect&bpo=28648]: 修复了在Mac OS X上调试版本中解码星体字符时Py_DecodeLocale()崩溃的问题。补丁由Xiang Zhang提供。

bpo-28665 [https://bugs.python.org/issue?@action=redirect&bpo=28665]: 将STORE_DEREF操作码的速度提高40%。

bpo-19398 [https://bugs.python.org/issue?@action=redirect&bpo=19398]: 在编译时PYTHONPATH组件为空的情况下，不再向sys.path组件添加额外的斜杠。

bpo-28621 [https://bugs.python.org/issue?@action=redirect&bpo=28621]: 通过重用更快的位数计数实现，加快了将int转换为float的速度。由Adrian Wielgosik提供补丁。

bpo-28580 [https://bugs.python.org/issue?@action=redirect&bpo=28580]: 优化了迭代分割表值。由Xiang Zhang提供补丁。

bpo-28583 [https://bugs.python.org/issue?@action=redirect&bpo=28583]: PyDict_SetDefault在需要时未合并分割表。由Xiang Zhang提供补丁。

bpo-28128 [https://bugs.python.org/issue?@action=redirect&bpo=28128]: 无效的str和byte转义序列的弃用警告现在会打印出关于错误发生位置的更好信息。由Serhiy Storchaka和Eric Smith提供补丁。

bpo-28509 [https://bugs.python.org/issue?@action=redirect&bpo=28509]: dict.update()不再分配不必要的大内存。

bpo-28426 [https://bugs.python.org/issue?@action=redirect&bpo=28426]: 修复了调试版本中PyUnicode_AsDecodedObject()潜在的崩溃问题。

bpo-28517 [https://bugs.python.org/issue?@action=redirect&bpo=28517]: 修复了窥孔优化器中的一个偏移错误，该错误导致保留无法到达的代码。

bpo-28214 [https://bugs.python.org/issue?@action=redirect&bpo=28214]: 改进了对有问题的 __set_name__ 属性的异常报告。

bpo-23782 [https://bugs.python.org/issue?@action=redirect&bpo=23782]: 修复了 _PyTraceback_Add() 中可能的内存泄漏和 PyTraceBack_Here() 中的异常丢失问题。

bpo-28183 [https://bugs.python.org/issue?@action=redirect&bpo=28183]: 优化并清理了字典迭代。

bpo-26081 [https://bugs.python.org/issue?@action=redirect&bpo=26081]: 添加了 asyncio.Future 的 C 实现。原始由 Yury Selivanov 提供补丁。

bpo-28379 [https://bugs.python.org/issue?@action=redirect&bpo=28379]: 为 PyUnicode_CopyCharacters() 添加了健全性检查和测试。由 Xiang Zhang 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: 长范围迭代器的类型现在注册为 Iterator。由 Oren Milman 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: 现在不允许通过调用 range_iterator 类型来创建 range_iterator 实例。调用 iter() 方法是唯一的方式。由 Oren Milman 提供补丁。

bpo-26906 [https://bugs.python.org/issue?@action=redirect&bpo=26906]: 现在解析未初始化类型的特殊方法会导致类型的隐式初始化而不是失败。

bpo-18287 [https://bugs.python.org/issue?@action=redirect&bpo=18287]: PyType_Ready() 现在检查 tp_name 是否为 NULL。原始由 Niklas Koep 提供补丁。

bpo-24098 [https://bugs.python.org/issue?@action=redirect&bpo=24098]: 修复了在编译过程中 AST 被更改时可能发生的崩溃。

bpo-28201 [https://bugs.python.org/issue?@action=redirect&bpo=28201]: 当哈希值具有相同的低位时，字典减少了哈希表中第二次冲突的可能性。

bpo-28350 [https://bugs.python.org/issue?@action=redirect&bpo=28350]: 不再对含有空字符的字符串常量进行内部化。

bpo-26617 [https://bugs.python.org/issue?@action=redirect&bpo=26617]: 修复了在弱引用回调过程中运行垃圾收集时发生的崩溃。

bpo-27942 [https://bugs.python.org/issue?@action=redirect&bpo=27942]: 现在在元组和冻结集合中递归内部化字符串常量。

bpo-28289 [https://bugs.python.org/issue?@action=redirect&bpo=28289]: ImportError.__init__ 现在重置未指定的属性。

bpo-21578 [https://bugs.python.org/issue?@action=redirect&bpo=21578]: 修复了当 ImportError 使用无效关键字参数调用时误导性的错误消息。

bpo-28203 [https://bugs.python.org/issue?@action=redirect&bpo=28203]: 修复了 complex(1.0, {2:3}) 错误消息中的不正确类型。补丁由 Soumya Sharma 提供。

bpo-28086 [https://bugs.python.org/issue?@action=redirect&bpo=28086]: 元组子类型的单个可变位置参数现在被转换为确切的元组，而不是原封不动地传递给 C 定义的函数。

bpo-28214 [https://bugs.python.org/issue?@action=redirect&bpo=28214]: 现在 __set_name__ 是在类上查找而不是在实例上查找。

bpo-27955 [https://bugs.python.org/issue?@action=redirect&bpo=27955]: 当 getrandom() 系统调用因 EPERM 失败时（例如被 SECCOMP 阻止时），回退读取 /dev/urandom 设备。

bpo-28192 [https://bugs.python.org/issue?@action=redirect&bpo=28192]: 在隔离模式下不导入readline。

bpo-27441 [https://bugs.python.org/issue?@action=redirect&bpo=27441]: 移除longobject.c中一些对ob_size的冗余赋值。感谢Oren Milman。

bpo-27222 [https://bugs.python.org/issue?@action=redirect&bpo=27222]: 清理long_rshift函数中的冗余代码。感谢Oren Milman。

升级内部unicode数据库至Unicode 9.0.0版本。

bpo-28131 [https://bugs.python.org/issue?@action=redirect&bpo=28131]: 修复zipimport的compile_source()中的回归问题。zipimport应使用与解释器相同的优化级别。

bpo-28126 [https://bugs.python.org/issue?@action=redirect&bpo=28126]: 用memcpy()替换Py_MEMCPY。Visual Studio能正确优化memcpy()。

bpo-28120 [https://bugs.python.org/issue?@action=redirect&bpo=28120]: Fix dict.pop() for splitted dictionary when trying to remove a "pending key" (Not yet inserted in split-table). Patch by Xiang Zhang.

bpo-26182 [https://bugs.python.org/issue?@action=redirect&bpo=26182]: 当async和await关键字被用作变量/属性/类/函数名时，发出DeprecationWarning。

bpo-26182 [https://bugs.python.org/issue?@action=redirect&bpo=26182]: 修复在引发DeprecationWarning的代码中的内存泄漏。

bpo-28721 [https://bugs.python.org/issue?@action=redirect&bpo=28721]: 修复异步生成器的aclose()和athrow()以正确处理StopAsyncIteration传播。

bpo-26110 [https://bugs.python.org/issue?@action=redirect&bpo=26110]: 加速方法调用：添加LOAD_METHOD和CALL_METHOD操作码。

库

bpo-31499 [https://bugs.python.org/issue?@action=redirect&bpo=31499]: xml.etree：修复当解析器是引用循环的一部分时的崩溃问题。

bpo-31482 [https://bugs.python.org/issue?@action=redirect&bpo=31482]: random.seed() 现在在version=1时可以与bytes一起工作。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing.get_type_hints现在默认（当调用者未指定 globalns 时）为类和模块找到正确的globalns。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块的速度改进。原始PR由Ivan Levkivskyi和Mitar提供。

bpo-31544 [https://bugs.python.org/issue?@action=redirect&bpo=31544]: ElementTree的C加速器模块忽略了在XMLParser()中查找TreeBuilder目标方法时引发的异常。

bpo-31234 [https://bugs.python.org/issue?@action=redirect&bpo=31234]: socket.create_connection()现在手动修复了一个引用循环：成功时清除存储最后一个异常的变量。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: LoggerAdapter对象现在可以嵌套。

bpo-31431 [https://bugs.python.org/issue?@action=redirect&bpo=31431]: SSLContext.check_hostname现在自动将SSLContext.verify_mode设置为ssl.CERT_REQUIRED，而不是以ValueError失败。

bpo-31233 [https://bugs.python.org/issue?@action=redirect&bpo=31233]: socketserver.ThreadingMixIn 现在维护一个非守护线程列表，在 server_close() 中等待所有这些线程完成。

bpo-28638 [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 进一步改进。）

bpo-31400 [https://bugs.python.org/issue?@action=redirect&bpo=31400]: 改进了 SSL 错误处理，避免丢失错误编号。

bpo-27629 [https://bugs.python.org/issue?@action=redirect&bpo=27629]: 使 SSLContext.wrap_bio() 和 SSLContext.wrap_socket() 的返回类型可定制。

bpo-28958 [https://bugs.python.org/issue?@action=redirect&bpo=28958]: ssl.SSLContext() 现在在无法实例化上下文时使用 OpenSSL 错误信息。

bpo-28182 [https://bugs.python.org/issue?@action=redirect&bpo=28182]: 当 OpenSSL 无法验证对等证书时，SSL 模块现在会引发 SSLCertVerificationError 异常。该异常包含更多关于错误的信息。

bpo-27340 [https://bugs.python.org/issue?@action=redirect&bpo=27340]: SSLSocket.sendall() 现在使用 memoryview 来创建数据切片。这修复了对所有类似于字节对象的支持。同时，这也更高效，避免了昂贵的复制。

bpo-14191 [https://bugs.python.org/issue?@action=redirect&bpo=14191]: 新增函数 argparse.ArgumentParser.parse_intermixed_args 提供了解析命令行中用户混合选项和位置参数的能力。

bpo-31178 [https://bugs.python.org/issue?@action=redirect&bpo=31178]: 修复了 subprocess 模块中在罕见错误路径下的字符串连接错误

bpo-31350 [https://bugs.python.org/issue?@action=redirect&bpo=31350]: 对 asyncio._get_running_loop() 进行微优化，使其速度提升高达 10%。

bpo-31170 [https://bugs.python.org/issue?@action=redirect&bpo=31170]: expat: 将 libexpat 从 2.2.3 更新至 2.2.4。修复了 UTF-8 输入部分字符的复制问题（libexpat bug 115）：https://github.com/libexpat/libexpat/issues/115

bpo-29136 [https://bugs.python.org/issue?@action=redirect&bpo=29136]: 添加 TLS 1.3 密码套件和 OP_NO_TLSv1_3。

bpo-1198569 [https://bugs.python.org/issue?@action=redirect&bpo=1198569]: string.Template 子类可以选择性地定义 braceidpattern，如果它们想要在花括号内外指定不同的占位符模式。如果为 None（默认值），则回退到 idpattern。

bpo-31326 [https://bugs.python.org/issue?@action=redirect&bpo=31326]: concurrent.futures.ProcessPoolExecutor.shutdown() 现在显式关闭调用队列。此外，shutdown(wait=True) 现在也会加入调用队列线程，以防止泄漏悬挂线程。

bpo-27144 [https://bugs.python.org/issue?@action=redirect&bpo=27144]: concurrent.futures 中的 map() 和 as_completed() 迭代器现在避免保留对生成对象的引用。

bpo-31281 [https://bugs.python.org/issue?@action=redirect&bpo=31281]: 修复 fileinput.FileInput(files, inplace=True) 当 files 包含 pathlib.Path 对象时的问题。

bpo-10746 [https://bugs.python.org/issue?@action=redirect&bpo=10746]: 修复 ctypes 为整数类型生成错误的 PEP 3118 [https://www.python.org/dev/peps/pep-3118] 类型代码的问题。

bpo-27584 [https://bugs.python.org/issue?@action=redirect&bpo=27584]: AF_VSOCK 已被添加到套接字接口中，允许虚拟机与其主机之间的通信。

bpo-22536 [https://bugs.python.org/issue?@action=redirect&bpo=22536]: 在 POSIX 系统上由于找不到可执行文件或 cwd 而引发 FileNotFoundError 时，子进程模块现在会设置文件名。

bpo-29741 [https://bugs.python.org/issue?@action=redirect&bpo=29741]: 更新 _pyio 模块中的一些方法，以也接受整数类型。由 Oren Milman 提供补丁。

bpo-31249 [https://bugs.python.org/issue?@action=redirect&bpo=31249]: concurrent.futures: ThreadPoolExecutor 使用的 WorkItem.run() 现在打破了异常对象和 WorkItem 对象之间的循环引用。

bpo-31247 [https://bugs.python.org/issue?@action=redirect&bpo=31247]: xmlrpc.server 现在在处理异常的代码中使用 sys.exc_info() 时显式地打破循环引用。

bpo-23835 [https://bugs.python.org/issue?@action=redirect&bpo=23835]: configparser: 现在在 ConfigParser() 构造器中读取默认值使用 read_dict()，使其行为与解析器的其余部分一致。默认字典中的非字符串键和值现在被隐式转换为字符串。由 James Tocknell 提供补丁。

bpo-31238 [https://bugs.python.org/issue?@action=redirect&bpo=31238]: pydoc: 私有 ServerThread 类的 stop() 方法现在会等待 DocServer.serve_until_quit() 完成，然后显式将其 docserver 属性设置为 None 以打破循环引用。

bpo-5001 [https://bugs.python.org/issue?@action=redirect&bpo=5001]: Many asserts in multiprocessing are now more informative, and some error types have been changed to more specific ones.

bpo-31109 [https://bugs.python.org/issue?@action=redirect&bpo=31109]: 将 zipimport 转换为使用 Argument Clinic。

bpo-30102 [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 的研究。

bpo-18966 [https://bugs.python.org/issue?@action=redirect&bpo=18966]: 由 multiprocessing.Process 创建的非守护线程现在在子进程退出时被 join。

bpo-31183 [https://bugs.python.org/issue?@action=redirect&bpo=31183]: dis now works with asynchronous generator and coroutine objects. Patch by George Collins based on diagnosis by Luciano Ramalho.

bpo-5001 [https://bugs.python.org/issue?@action=redirect&bpo=5001]: There are a number of uninformative asserts in the multiprocessing module, as noted in issue 5001. This change fixes two of the most potentially problematic ones, since they are in error-reporting code, in the multiprocessing.managers.convert_to_error function. (It also makes more informative a ValueError message.) The only potentially problematic change is that the AssertionError is now a TypeError; however, this should also help distinguish it from an AssertionError being reported by the function/its caller (such as in issue 31169). - Patch by Allen W. Smith (drallensmith on github).

bpo-31185 [https://bugs.python.org/issue?@action=redirect&bpo=31185]: 修复了 asyncio 加速模块中的杂项错误。

bpo-31151 [https://bugs.python.org/issue?@action=redirect&bpo=31151]: socketserver.ForkingMixIn.server_close() 现在会等待所有子进程完成，以防止僵尸进程泄漏。

bpo-31072 [https://bugs.python.org/issue?@action=redirect&bpo=31072]: 向 zipapp.create_archive() 添加一个 include_file 形参。

bpo-24700 [https://bugs.python.org/issue?@action=redirect&bpo=24700]: 优化 array.array 比较。当比较持有相同整数类型值的数组时，现在速度提高了 10 倍到 70 倍。

bpo-31135 [https://bugs.python.org/issue?@action=redirect&bpo=31135]: ttk：修复LabeledScale和OptionMenu类的destroy()方法。即使使用的属性不存在，也调用父类的destroy()方法。LabeledScale.destroy()方法现在还显式清除了label和scale属性，以帮助垃圾回收器销毁所有小部件。

bpo-31107 [https://bugs.python.org/issue?@action=redirect&bpo=31107]: Fix copyreg._slotnames() mangled attribute calculation for classes whose name begins with an underscore. Patch by Shane Harvey.

bpo-31080 [https://bugs.python.org/issue?@action=redirect&bpo=31080]: Allow logging.config.fileConfig to accept kwargs and/or args.

bpo-30897 [https://bugs.python.org/issue?@action=redirect&bpo=30897]: pathlib.Path 对象现在包含一个 is_mount() 方法（仅在POSIX上实现）。这与 os.path.ismount(p) 类似。由Cooper Ry Lees提供补丁。

bpo-31061 [https://bugs.python.org/issue?@action=redirect&bpo=31061]: 修复了在使用asyncio和线程时的崩溃问题。

bpo-30987 [https://bugs.python.org/issue?@action=redirect&bpo=30987]: 在socket模块中增加了对CAN ISO-TP协议的支持。

bpo-30522 [https://bugs.python.org/issue?@action=redirect&bpo=30522]: 向 logging.StreamHandler 添加了一个 setStream 方法，允许在创建后设置流。

bpo-30502 [https://bugs.python.org/issue?@action=redirect&bpo=30502]: 修复了ssl中长oids的处理。基于Christian Heimes的补丁。

bpo-5288 [https://bugs.python.org/issue?@action=redirect&bpo=5288]: 支持具有不足一分钟偏移的tzinfo对象。

bpo-30919 [https://bugs.python.org/issue?@action=redirect&bpo=30919]: 修复了Python 3.x版本中多进程模块（multiprocessing）的共享内存性能回归问题。在Python 2.x中，共享内存使用匿名内存映射实现，而Python 3.x则改为映射实际文件。本次修复尝试尽可能减少磁盘I/O操作以提升性能。

bpo-26732 [https://bugs.python.org/issue?@action=redirect&bpo=26732]: 修复了使用“forkserver”方法启动的进程中fd过多的问题。子进程会继承与仍在运行的子进程数量一样多的fd。

bpo-29403 [https://bugs.python.org/issue?@action=redirect&bpo=29403]: 修复``unittest.mock``模块的autospec功能，使其不再对绑定到方法的内置函数报错。由Aaron Gallagher提供补丁。

bpo-30961 [https://bugs.python.org/issue?@action=redirect&bpo=30961]: 修复了tracemalloc中借用引用的递减问题。

bpo-19896 [https://bugs.python.org/issue?@action=redirect&bpo=19896]: 修复multiprocessing.sharedctypes以识别类型码 'q' 和 'Q'。

bpo-30946 [https://bugs.python.org/issue?@action=redirect&bpo=30946]: 移除了readline模块中对于GNU readline版本低于2.1或select()不可用平台的过时代码。

bpo-25684 [https://bugs.python.org/issue?@action=redirect&bpo=25684]: 修改 ttk.OptionMenu 单选按钮，使其在不同 OptionMenu 实例间保持唯一。

bpo-30886 [https://bugs.python.org/issue?@action=redirect&bpo=30886]: 修复 multiprocessing.Queue.join_thread()：现在即使线程是由创建队列的同一进程启动的，它也会等待线程完成。

bpo-29854 [https://bugs.python.org/issue?@action=redirect&bpo=29854]: 修复使用 readline 的 history-size 选项时 readline 中的段错误。由 Nir Soffer 提供补丁。

bpo-30794 [https://bugs.python.org/issue?@action=redirect&bpo=30794]: 在 Unix 上添加了 multiprocessing.Process.kill 方法，用于使用 SIGKILL 信号终止。

bpo-30319 [https://bugs.python.org/issue?@action=redirect&bpo=30319]: socket.close() 现在忽略 ECONNRESET 错误。

bpo-30828 [https://bugs.python.org/issue?@action=redirect&bpo=30828]: Fix out of bounds write in asyncio.CFuture.remove_done_callback().

bpo-30302 [https://bugs.python.org/issue?@action=redirect&bpo=30302]: 在 datetime.timedelta 的 repr 中使用关键字。

bpo-30807 [https://bugs.python.org/issue?@action=redirect&bpo=30807]: 当传递一个极小的值时，signal.setitimer() 可能会禁用计时器。极小的值（如 1e-6）是 setitimer() 有效的非零值，它被指定为采取微秒级间隔。然而，在某些平台上，我们的转换例程可能将 1e-6 转换为零间隔，从而禁用计时器而不是（重新）调度它。

bpo-30441 [https://bugs.python.org/issue?@action=redirect&bpo=30441]: 修复在迭代 os.environ 时修改它导致的错误。

bpo-29585 [https://bugs.python.org/issue?@action=redirect&bpo=29585]: 避免从 site 导入 sysconfig 以提高启动速度。Python 在 Linux 上的启动速度提高了约 5%，在 macOS 上提高了约 30%。

bpo-29293 [https://bugs.python.org/issue?@action=redirect&bpo=29293]: 在 multiprocessing.Condition.notify() 上添加缺失的参数 "n"。文档声称 multiprocessing.Condition 的行为类似于 threading.Condition，但其 notify() 方法缺少 threading.Condition.notify() 接受的 "n" 参数（指定要唤醒的睡眠者数量）。

bpo-30532 [https://bugs.python.org/issue?@action=redirect&bpo=30532]: 修复电子邮件头值解析器在某些情况下丢弃折叠空白的问题。

bpo-30596 [https://bugs.python.org/issue?@action=redirect&bpo=30596]: 向 multiprocessing.Process 添加一个 close() 方法。

bpo-9146 [https://bugs.python.org/issue?@action=redirect&bpo=9146]: 修复 _hashopenssl 在链接的 OpenSSL 库中不可用标准哈希函数（如 md5）时的段错误。如在某些特殊的 FIPS-140 构建环境中。

bpo-29169 [https://bugs.python.org/issue?@action=redirect&bpo=29169]: 将 zlib 更新至 1.2.11。

bpo-30119 [https://bugs.python.org/issue?@action=redirect&bpo=30119]: ftplib.FTP.putline() now throws ValueError on commands that contains CR or LF. Patch by Dong-hee Na.

bpo-30879 [https://bugs.python.org/issue?@action=redirect&bpo=30879]: os.listdir() 和 os.scandir() 现在在使用字节类参数调用时会发出字节名称。

bpo-30746 [https://bugs.python.org/issue?@action=redirect&bpo=30746]: 禁止在 os.putenv() 和 os.spawn*() 的环境变量名中使用 '=' 字符。

bpo-30664 [https://bugs.python.org/issue?@action=redirect&bpo=30664]: unittest 子测试的描述现在会保留 TestCase.subTest() 的关键字参数的顺序。

bpo-21071 [https://bugs.python.org/issue?@action=redirect&bpo=21071]: struct.Struct.format 类型现在是 str 而非 bytes。

bpo-29212 [https://bugs.python.org/issue?@action=redirect&bpo=29212]: 修复 concurrent.futures.thread.ThreadPoolExecutor 线程在没有提供 thread_name_prefix 时默认使用非 repr() 基础的线程名。它们现在会自称为 "ThreadPoolExecutor-y_n"。

bpo-29755 [https://bugs.python.org/issue?@action=redirect&bpo=29755]: 修复了 gettext 模块中的 lgettext() 系列函数。它们现在总是返回字节。

bpo-30616 [https://bugs.python.org/issue?@action=redirect&bpo=30616]: Functional API of enum allows to create empty enums. Patched by Dong-hee Na

bpo-30038 [https://bugs.python.org/issue?@action=redirect&bpo=30038]: 修复了信号传递和唤醒文件描述符之间的竞争条件。补丁由 Nathaniel Smith 提供。

bpo-23894 [https://bugs.python.org/issue?@action=redirect&bpo=23894]: lib2to3 现在能识别 rb'...' 和 f'...' 字符串。

bpo-24744 [https://bugs.python.org/issue?@action=redirect&bpo=24744]: pkgutil.walk_packages 函数现在会在 path 是字符串时抛出 ValueError。补丁由 Sanyam Khurana 提供。

bpo-24484 [https://bugs.python.org/issue?@action=redirect&bpo=24484]: 避免多进程清理中的竞争条件。

bpo-30589 [https://bugs.python.org/issue?@action=redirect&bpo=30589]: 修复 multiprocessing.Process.exitcode 在使用 "forkserver" 方法时，当进程被信号杀死时返回信号数的相反数（而不是 255）。

bpo-28994 [https://bugs.python.org/issue?@action=redirect&bpo=28994]: 对于由 atexit 注册的回调中引发的 SystemExit，不再显示回溯。

bpo-30508 [https://bugs.python.org/issue?@action=redirect&bpo=30508]: 如果调用了 Task/Future 的 "cancel()" 方法，则不记录异常。

bpo-30645 [https://bugs.python.org/issue?@action=redirect&bpo=30645]: Fix path calculation in imp.load_package(), fixing it for cases when a package is only shipped with bytecodes. Patch by Alexandru Ardelean.

bpo-11822 [https://bugs.python.org/issue?@action=redirect&bpo=11822]: dis.dis() 函数现在能够反汇编嵌套的代码对象。

bpo-30624 [https://bugs.python.org/issue?@action=redirect&bpo=30624]: selectors 没有考虑到 KeyboardInterrupt 和 SystemExit，导致在出错时文件描述符处于不良状态。由 Giampaolo Rodola' 提供补丁。

bpo-30595 [https://bugs.python.org/issue?@action=redirect&bpo=30595]: multiprocessing.Queue.get() 现在在非阻塞模式下轮询其读取器，如果成功获取锁但获取时间超过了超时时间。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing 模块的更新：添加通用的 AsyncContextManager，为所有版本添加对 ContextManager 的支持。原始 PR 由 Jelle Zijlstra 和 Ivan Levkivskyi 提供。

bpo-30605 [https://bugs.python.org/issue?@action=redirect&bpo=30605]: re.compile() 在编译带有错误放置的内联修饰符的 bytes 实例时不再引发 BytesWarning。由 Roy Williams 提供补丁。

bpo-29870 [https://bugs.python.org/issue?@action=redirect&bpo=29870]: 修复 asyncio/ssl 实现中当连接被中止时 SSL 套接字的泄漏问题。由 Michaël Sghaïer 提供补丁。

bpo-29743 [https://bugs.python.org/issue?@action=redirect&bpo=29743]: 在握手过程中关闭传输会导致打开的套接字泄漏。由 Nikolay Kim 提供补丁。

bpo-27585 [https://bugs.python.org/issue?@action=redirect&bpo=27585]: 修复 asyncio.Lock 中的等待者取消问题。由 Mathieu Sornay 提供补丁。

bpo-30014 [https://bugs.python.org/issue?@action=redirect&bpo=30014]: selectors 模块中基于 poll()、epoll() 和 devpoll() 的类的 modify() 方法现在快了约 10%。由 Giampaolo Rodola' 提供补丁。

bpo-30418 [https://bugs.python.org/issue?@action=redirect&bpo=30418]: 在 Windows 上，如果子进程仍在运行但关闭了管道，subprocess.Popen.communicate() 现在也会忽略 stdin.write() 上的 EINVAL。

bpo-30463 [https://bugs.python.org/issue?@action=redirect&bpo=30463]: Addded empty __slots__ to abc.ABC. This allows subclassers to deny __dict__ and __weakref__ creation. Patch by Aaron Hall.

bpo-30520 [https://bugs.python.org/issue?@action=redirect&bpo=30520]: 现在 Logger 可以被 pickle 序列化。

bpo-30557 [https://bugs.python.org/issue?@action=redirect&bpo=30557]: faulthandler 现在能够正确过滤和显示 Windows 上的异常代码。

bpo-30526 [https://bugs.python.org/issue?@action=redirect&bpo=30526]: 添加了 TextIOWrapper.reconfigure() 和 TextIOWrapper.write_through 属性。

bpo-30245 [https://bugs.python.org/issue?@action=redirect&bpo=30245]: 修复在组织 struct.pack_into 错误消息时可能出现的溢出问题。由 Yuan Liu 提供补丁。

bpo-30378 [https://bugs.python.org/issue?@action=redirect&bpo=30378]: 修复 logging.handlers.SysLogHandler 无法处理 IPv6 地址的问题。

bpo-16500 [https://bugs.python.org/issue?@action=redirect&bpo=16500]: 允许注册 at-fork 处理程序。

bpo-30470 [https://bugs.python.org/issue?@action=redirect&bpo=30470]: 弃用 Windows 上的无效 ctypes 调用保护。由 Mariatta Wijaya 提供补丁。

bpo-30414 [https://bugs.python.org/issue?@action=redirect&bpo=30414]: multiprocessing.Queue._feed 后台运行线程在异常时不从主循环中中断。

bpo-30003 [https://bugs.python.org/issue?@action=redirect&bpo=30003]: 修复HZ编解码器中转义字符的处理。基于Ma Lin的补丁。

bpo-30149 [https://bugs.python.org/issue?@action=redirect&bpo=30149]: inspect.signature() now supports callables with variable-argument parameters wrapped with partialmethod. Patch by Dong-hee Na.

bpo-30436 [https://bugs.python.org/issue?@action=redirect&bpo=30436]: 如果指定的父模块不是一个包（即缺少__path__属性），importlib.find_spec() 现在会引发ModuleNotFoundError而不是AttributeError。

bpo-30301 [https://bugs.python.org/issue?@action=redirect&bpo=30301]: 修复在 spawn 和 forkserver 启动方法下使用SimpleQueue.empty()时的AttributeError。

bpo-30375 [https://bugs.python.org/issue?@action=redirect&bpo=30375]: 编译正则表达式时发出的警告现在总是指向用户代码中的行。之前如果从组或条件内部发出，它们可能指向re模块的内部。

bpo-30329 [https://bugs.python.org/issue?@action=redirect&bpo=30329]: imaplib和poplib现在在shutdown(SHUT_RDWR)时捕获Windows socket WSAEINVAL错误（代码10022）：尝试了无效操作。此错误有时发生在SSL连接上。

bpo-29196 [https://bugs.python.org/issue?@action=redirect&bpo=29196]: 移除了plistlib模块中以前在Python 2.4中弃用的类Plist、Dict和_InternalDict。readPlist()和readPlistFromBytes()函数的结果中的Dict值现在是普通的dict。你不能再使用属性访问来访问这些字典的项目。

bpo-9850 [https://bugs.python.org/issue?@action=redirect&bpo=9850]: macpath 现在已被弃用，并将在Python 3.8中移除。

bpo-30299 [https://bugs.python.org/issue?@action=redirect&bpo=30299]: 在CPython上以调试模式编译正则表达式现在以人类可读的形式显示编译后的字节码。

bpo-30048 [https://bugs.python.org/issue?@action=redirect&bpo=30048]: 修复了当任务运行协程且协程返回而没有任何更多 await 时，``Task.cancel()``可能被忽略的问题。

bpo-30266 [https://bugs.python.org/issue?@action=redirect&bpo=30266]: contextlib.AbstractContextManager现在支持通过设置__enter__ = None或__exit__ = None进行反注册，遵循 bpo-25958 [https://bugs.python.org/issue?@action=redirect&bpo=25958] 中引入的模式。由Jelle Zijlstra提供补丁。

bpo-30340 [https://bugs.python.org/issue?@action=redirect&bpo=30340]: 增强正则表达式优化。这使某些模式的匹配性能提高了25倍。

bpo-30298 [https://bugs.python.org/issue?@action=redirect&bpo=30298]: 放宽内联修饰符的弃用警告条件。现在允许在模式开始处连续使用多个内联修饰符（例如 '(?i)(?s)...'）。在详细模式下，现在允许在内联修饰符之前和之间使用空格和注释（例如 '(?x) (?i) (?s)...'）。

bpo-30285 [https://bugs.python.org/issue?@action=redirect&bpo=30285]: 优化了正则表达式的不区分大小写的匹配和搜索。

bpo-29990 [https://bugs.python.org/issue?@action=redirect&bpo=29990]: 修复GB18030解码器中的范围检查。原由Ma Lin提供补丁。

bpo-29979 [https://bugs.python.org/issue?@action=redirect&bpo=29979]: 重写cgi.parse_multipart，重用FieldStorage类，并使其结果与FieldStorage对于multipart/form-data请求的结果一致。由Pierre Quentel提供补丁。

bpo-30243 [https://bugs.python.org/issue?@action=redirect&bpo=30243]: 移除了_json的扫描器和编码器的__init__方法。误用它们可能导致内存泄漏或崩溃。现在扫描器和编码器对象在__new__方法中完全初始化。

bpo-30215 [https://bugs.python.org/issue?@action=redirect&bpo=30215]: 使用re.LOCALE标志编译的正则表达式对象不再依赖于编译时的区域设置。只有匹配时的区域设置会影响匹配结果。

bpo-30185 [https://bugs.python.org/issue?@action=redirect&bpo=30185]: 在收到Ctrl-C时，避免forkserver辅助进程中的KeyboardInterrupt回溯。

bpo-30103 [https://bugs.python.org/issue?@action=redirect&bpo=30103]: binascii.b2a_uu()和uu.encode()现在支持使用 '`' 代替空格作为零。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对typing模块的各种更新：添加typing.NoReturn类型，使用WrapperDescriptorType，小错误修复。原PR由Jim Fasarakis-Hilliard和Ivan Levkivskyi提供。

bpo-30205 [https://bugs.python.org/issue?@action=redirect&bpo=30205]: 修复Linux上未绑定的AF_UNIX套接字的getsockname()。

bpo-30228 [https://bugs.python.org/issue?@action=redirect&bpo=30228]: io.FileIO的seek()和tell()方法现在设置内部seekable属性，以避免在open()时（在缓冲或文本模式下）进行一次系统调用。

bpo-30190 [https://bugs.python.org/issue?@action=redirect&bpo=30190]: unittest的assertAlmostEqual和assertNotAlmostEqual在失败时提供了更好的消息，包括左右参数的差异。（由Giampaolo Rodola提供补丁）

bpo-30101 [https://bugs.python.org/issue?@action=redirect&bpo=30101]: 添加对curses.A_ITALIC的支持。

bpo-29822 [https://bugs.python.org/issue?@action=redirect&bpo=29822]: inspect.isabstract()现在在__init_subclass__期间工作。补丁由Nate Soares提供。

bpo-29960 [https://bugs.python.org/issue?@action=redirect&bpo=29960]: 当_random.Random.setstate()引发异常时，保留生成器状态。补丁由Bryan Olson提供。

bpo-30070 [https://bugs.python.org/issue?@action=redirect&bpo=30070]: 修复了解析模块中错误处理的内存泄漏和崩溃问题。

bpo-22352 [https://bugs.python.org/issue?@action=redirect&bpo=22352]: dis.dis()的输出中的列宽现在针对大行号和指令偏移进行了调整。

bpo-30061 [https://bugs.python.org/issue?@action=redirect&bpo=30061]: 修复了当readline()或__next__()分别返回不可大小化的对象时，IOBase方法__next__()和readlines()中的崩溃。修复了由不检查PyObject_Size()、PySequence_Size()或PyMapping_Size()的结果可能引起的其他错误。

bpo-30218 [https://bugs.python.org/issue?@action=redirect&bpo=30218]: 修复了shutil.unpack_archive的PathLike支持。由Jelle Zijlstra提供补丁。

bpo-10076 [https://bugs.python.org/issue?@action=redirect&bpo=10076]: re模块中的编译正则表达式和匹配对象现在支持copy.copy()和copy.deepcopy()（它们被认为是原子的）。

bpo-30068 [https://bugs.python.org/issue?@action=redirect&bpo=30068]: 当存在hint时，_io._IOBase.readlines将首先检查是否关闭。

bpo-29694 [https://bugs.python.org/issue?@action=redirect&bpo=29694]: 修复了pathlib mkdir与flags parents=True时的竞争条件。补丁由Armin Rigo提供。

bpo-29692 [https://bugs.python.org/issue?@action=redirect&bpo=29692]: 修复了contextlib.contextmanager中RuntimeError异常的任意解链。由Siddharth Velankar提供补丁。

bpo-26187 [https://bugs.python.org/issue?@action=redirect&bpo=26187]: 测试sqlite3跟踪回调在模式更改时不被多次调用。通过切换到在 bpo-9303 [https://bugs.python.org/issue?@action=redirect&bpo=9303] 中使用sqlite3_prepare_v2()间接修复。由Aviv Palivoda提供补丁。

bpo-30017 [https://bugs.python.org/issue?@action=redirect&bpo=30017]: 允许多次调用zip条目写入器对象的close()方法。向已关闭的写入器写入现在总是产生ValueError。

bpo-29998 [https://bugs.python.org/issue?@action=redirect&bpo=29998]: Pickling和复制ImportError现在保留name和path属性。

bpo-29995 [https://bugs.python.org/issue?@action=redirect&bpo=29995]: re.escape() 现在仅转义正则表达式特殊字符。

bpo-29962 [https://bugs.python.org/issue?@action=redirect&bpo=29962]: 添加 math.remainder 操作，实现 IEEE 754 中规定的余数。

bpo-29649 [https://bugs.python.org/issue?@action=redirect&bpo=29649]: 改进 struct.pack_into() 对于缓冲区大小和偏移量问题的异常消息。由 Andrew Nester 提供补丁。

bpo-29654 [https://bugs.python.org/issue?@action=redirect&bpo=29654]: 支持 If-Modified-Since HTTP 头部（浏览器缓存）。补丁由 Pierre Quentel 提供。

bpo-29931 [https://bugs.python.org/issue?@action=redirect&bpo=29931]: 修复了 ipaddress.ip_interface 对象的比较检查。补丁由 Sanjay Sundaresan 提供。

bpo-29953 [https://bugs.python.org/issue?@action=redirect&bpo=29953]: 修复了当传递超出范围的 fold 参数时，datetime 和 time 对象的 replace() 方法中的内存泄漏问题。

bpo-29942 [https://bugs.python.org/issue?@action=redirect&bpo=29942]: 修复了在遇到长串空可迭代对象时，itertools.chain.from_iterable 的崩溃问题。

bpo-10030 [https://bugs.python.org/issue?@action=redirect&bpo=10030]: 通过加密 ZIP 文件的读取速度提高了2倍。

bpo-29204 [https://bugs.python.org/issue?@action=redirect&bpo=29204]: Element.getiterator() 和 XMLParser() 的 html 参数仅在文档中被弃用（分别自 Python 3.2 和 3.4 起）。现在使用它们会发出弃用警告。

bpo-27863 [https://bugs.python.org/issue?@action=redirect&bpo=27863]: 修复了由竞争条件和错误类型引起的 ElementTree 中的多个崩溃问题。

bpo-25996 [https://bugs.python.org/issue?@action=redirect&bpo=25996]: 在 Unix 上添加了对 os.scandir() 中文件描述符的支持。通过使用 os.scandir()，os.fwalk() 的速度提高了2倍。

bpo-28699 [https://bugs.python.org/issue?@action=redirect&bpo=28699]: 修复了 multiprocessing.pool 中池的一个 bug，即在可迭代对象的最开始引发异常可能会吞掉异常或使程序挂起。由 Davin Potts 和 Xiang Zhang 提供补丁。

bpo-23890 [https://bugs.python.org/issue?@action=redirect&bpo=23890]: unittest.TestCase.assertRaises() 现在手动打破引用循环，以避免对象存活时间超过预期。

bpo-29901 [https://bugs.python.org/issue?@action=redirect&bpo=29901]: zipapp 模块现在支持一般的路径类对象，而不仅仅是 pathlib.Path。

bpo-25803 [https://bugs.python.org/issue?@action=redirect&bpo=25803]: 当操作系统优先考虑如 EACCES 而不是 EEXIST 的错误时，避免 Path.mkdir(exist_ok=True) 引发不正确的错误。

bpo-29861 [https://bugs.python.org/issue?@action=redirect&bpo=29861]: 在 multiprocessing.Pool 中，任务、它们的参数和结果一旦完成就释放引用。

bpo-19930 [https://bugs.python.org/issue?@action=redirect&bpo=19930]: os.makedirs()的mode参数不再影响新创建的中间级别目录的文件权限位。

bpo-29884 [https://bugs.python.org/issue?@action=redirect&bpo=29884]: faulthandler: 在拆卸期间恢复旧的sigaltstack。由Christophe Zeitouny提供补丁。

bpo-25455 [https://bugs.python.org/issue?@action=redirect&bpo=25455]: 修复了递归缓冲文件类对象repr中的崩溃。

bpo-29800 [https://bugs.python.org/issue?@action=redirect&bpo=29800]: 修复了如果partial.keywords的键不是字符串时partial.__repr__的崩溃。由Michael Seifert提供补丁。

bpo-8256 [https://bugs.python.org/issue?@action=redirect&bpo=8256]: 修复了如果sys.stdin或sys.stdout的属性"encoding"或"errors"未设置或不是字符串时可能导致的input()失败或崩溃。

bpo-28692 [https://bugs.python.org/issue?@action=redirect&bpo=28692]: 现在弃用使用非整数值在gettext中选择复数形式。

bpo-26121 [https://bugs.python.org/issue?@action=redirect&bpo=26121]: 使用C库实现math函数erf()和erfc()。

bpo-29619 [https://bugs.python.org/issue?@action=redirect&bpo=29619]: os.stat()和os.DirEntry.inode()现在使用无符号整数转换inode（st_ino）。

bpo-28298 [https://bugs.python.org/issue?@action=redirect&bpo=28298]: 修复了一个阻止数组'Q'、'L'和'I'接受大整数（具有__int__的对象）作为元素的错误。

bpo-29645 [https://bugs.python.org/issue?@action=redirect&bpo=29645]: 加快了导入webbrowser模块的速度。webbrowser.register()现在是线程安全的。

bpo-28231 [https://bugs.python.org/issue?@action=redirect&bpo=28231]: zipfile模块现在接受路径类对象作为外部路径。

bpo-26915 [https://bugs.python.org/issue?@action=redirect&bpo=26915]: collections.abc.Sequence的index()和count()方法在进行比较时现在在检查相等性之前检查身份。

bpo-28682 [https://bugs.python.org/issue?@action=redirect&bpo=28682]: 在 os.fwalk() 中添加了对字节路径的支持。

bpo-29728 [https://bugs.python.org/issue?@action=redirect&bpo=29728]: Add new socket.TCP_NOTSENT_LOWAT (Linux 3.12) constant. Patch by Nathaniel J. Smith.

bpo-29623 [https://bugs.python.org/issue?@action=redirect&bpo=29623]: 允许在 ConfigParser.read() 中使用路径类对象作为单一参数。由 David Ellis 提供补丁。

bpo-9303 [https://bugs.python.org/issue?@action=redirect&bpo=9303]: 将sqlite3模块迁移到 _v2 API。由 Aviv Palivoda 提供补丁。

bpo-28963 [https://bugs.python.org/issue?@action=redirect&bpo=28963]: 修复了在 C 中实现的 asyncio.Future.remove_done_callback 中的越界迭代。

bpo-29704 [https://bugs.python.org/issue?@action=redirect&bpo=29704]: asyncio.subprocess.SubprocessStreamProtocol 在所有管道关闭之前不再关闭。

bpo-29271 [https://bugs.python.org/issue?@action=redirect&bpo=29271]: 修复 Task.current_task 和 Task.all_tasks 在 C 中的实现，使其能够接受 None 参数，如同它们的纯 Python 实现一样。

bpo-29703 [https://bugs.python.org/issue?@action=redirect&bpo=29703]: 修复 asyncio，支持在子进程中实例化新的事件循环。

bpo-29615 [https://bugs.python.org/issue?@action=redirect&bpo=29615]: SimpleXMLRPCDispatcher 不再将 KeyError（或任何其他异常）链接到调度方法中引发的异常。由 Petr Motejlek 提供补丁。

bpo-7769 [https://bugs.python.org/issue?@action=redirect&bpo=7769]: xmlrpc.server.SimpleXMLRPCDispatcher 及其子类的 register_function() 方法现在可以用作装饰器。

bpo-29376 [https://bugs.python.org/issue?@action=redirect&bpo=29376]: 修复 threading._DummyThread.is_alive() 中的断言错误。

bpo-28624 [https://bugs.python.org/issue?@action=redirect&bpo=28624]: 添加一个测试，检查 Popen() 的 cwd 参数是否接受 PathLike 对象。由 Sayan Chowdhury 提供补丁。

bpo-28518 [https://bugs.python.org/issue?@action=redirect&bpo=28518]: 在 DML 语句之前隐式开始一个事务。由 Aviv Palivoda 提供补丁。

bpo-29742 [https://bugs.python.org/issue?@action=redirect&bpo=29742]: 如果 get_extra_info() 在关闭的 ssl 传输上调用，将引发异常。由 Nikolay Kim 提供补丁。

bpo-16285 [https://bugs.python.org/issue?@action=redirect&bpo=16285]: urllib.parse.quote 现在基于 RFC 3986，因此默认情况下不引用 '~' 字符。补丁由 Christian Theune 和 Ratnadeep Debnath 提供。

bpo-29532 [https://bugs.python.org/issue?@action=redirect&bpo=29532]: 修改传递给 functools.partial() 的 kwarg 字典不再影响创建后的 partial 对象。

bpo-29110 [https://bugs.python.org/issue?@action=redirect&bpo=29110]: 修复 aifc.open() 中当文件作为文件系统路径给出且不是有效的 AIFF 格式时的文件对象泄漏问题。由 Anthony Zhang 提供补丁。

bpo-22807 [https://bugs.python.org/issue?@action=redirect&bpo=22807]: 添加 uuid.SafeUUID 和 uuid.UUID.is_safe，以传递平台关于生成的 UUID 是否使用多进程安全方法生成的信息。

bpo-29576 [https://bugs.python.org/issue?@action=redirect&bpo=29576]: 改进了 importlib 中的一些弃用。一些弃用的方法现在会发出 DeprecationWarnings，并有更好的描述性消息。

bpo-29534 [https://bugs.python.org/issue?@action=redirect&bpo=29534]: 修复了 Decimal.from_float() 在 _decimal 和 _pydecimal 中的不同行为。感谢 Andrew Nester。

bpo-10379 [https://bugs.python.org/issue?@action=redirect&bpo=10379]: locale.format_string 现在支持 'monetary' 关键字参数，而 locale.format 已被弃用。

bpo-29851 [https://bugs.python.org/issue?@action=redirect&bpo=29851]: importlib.reload() 现在会在模块缺少 spec 时抛出 ModuleNotFoundError。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块进行了多项更新：typing.Counter、typing.ChainMap、改进的 ABC 缓存等。原始 PR 由 Jelle Zijlstra、Ivan Levkivskyi、Manuel Krebber 和 Łukasz Langa 提供。

bpo-29100 [https://bugs.python.org/issue?@action=redirect&bpo=29100]: 修复了 Python 3.6.0 中引入的 datetime.fromtimestamp() 的回归问题：检查最小和最大年份。

bpo-29416 [https://bugs.python.org/issue?@action=redirect&bpo=29416]: 防止 pathlib.Path.mkdir 中的无限循环。

bpo-29444 [https://bugs.python.org/issue?@action=redirect&bpo=29444]: 修复了 match 对象的 group() 方法中的越界缓冲区访问。基于 WGH 的补丁。

bpo-29377 [https://bugs.python.org/issue?@action=redirect&bpo=29377]: 将 WrapperDescriptorType、MethodWrapperType 和 MethodDescriptorType 内置类型添加到 types 模块。原始由 Manuel Krebber 提供补丁。

bpo-29218 [https://bugs.python.org/issue?@action=redirect&bpo=29218]: 现在移除了未使用的 install_misc 命令。自 2000 年以来，它已被记录为未使用。由 Eric N. Vander Weele 提供补丁。

bpo-29368 [https://bugs.python.org/issue?@action=redirect&bpo=29368]: 现在在反序列化 collections.deque 和其他类似列表的对象时，调用 extend() 方法而不是 append() 方法。这可以将反序列化速度提高至 2 倍。

bpo-29338 [https://bugs.python.org/issue?@action=redirect&bpo=29338]: 现在，如果为类提供了 __text_signature__，内置或扩展类的帮助信息会包括构造函数签名。

bpo-29335 [https://bugs.python.org/issue?@action=redirect&bpo=29335]: 修复了当子进程已退出到停止状态而不是终止状态（例如：在 ptrace 下）时的 subprocess.Popen.wait()。

bpo-29290 [https://bugs.python.org/issue?@action=redirect&bpo=29290]: 修复了 argparse 中帮助消息会在非断行空格处换行的回归问题。

bpo-28735 [https://bugs.python.org/issue?@action=redirect&bpo=28735]: 修复了 mock.MagickMock 与 mock.ANY 的比较。

bpo-29197 [https://bugs.python.org/issue?@action=redirect&bpo=29197]: 移除了已弃用的函数 ntpath.splitunc()。

bpo-29210 [https://bugs.python.org/issue?@action=redirect&bpo=29210]: 移除了对 tarfile.TarFile.add() 中已弃用参数 "exclude" 的支持。

bpo-29219 [https://bugs.python.org/issue?@action=redirect&bpo=29219]: 修复了未初始化的 ctypes.CDLL 实例的 repr 中的无限递归。

bpo-29192 [https://bugs.python.org/issue?@action=redirect&bpo=29192]: 移除了 http.cookies 模块中已弃用的功能。

bpo-29193 [https://bugs.python.org/issue?@action=redirect&bpo=29193]: string.Formatter.format() 的格式字符串参数现在仅为位置参数。

bpo-29195 [https://bugs.python.org/issue?@action=redirect&bpo=29195]: 移除了对正则表达式对象方法中已弃用的未记录关键字参数的支持。

bpo-28969 [https://bugs.python.org/issue?@action=redirect&bpo=28969]: 修复了functools.lru_cache的C实现中的竞态条件。当缓存函数满时，如果同时从不同线程以相同的未缓存参数调用，可能会引发KeyError。

bpo-20804 [https://bugs.python.org/issue?@action=redirect&bpo=20804]: unittest.mock.sentinel属性现在在复制或pickle时保持其身份。

bpo-29142 [https://bugs.python.org/issue?@action=redirect&bpo=29142]: 在urllib.request中，no_proxy环境变量中带有前导点的后缀可以再次匹配相关的主机名（例如.b.c匹配a.b.c）。由Milan Oberkirch提供补丁。

bpo-28961 [https://bugs.python.org/issue?@action=redirect&bpo=28961]: 修复unittest.mock._Call辅助函数：不再忽略name参数。由Jiajun Huang提供补丁。

bpo-15812 [https://bugs.python.org/issue?@action=redirect&bpo=15812]: inspect.getframeinfo()现在正确显示上下文的第行。由Sam Breese提供补丁。

bpo-28985 [https://bugs.python.org/issue?@action=redirect&bpo=28985]: 更新sqlite3模块中的授权者常量。由Dingyuan Wang提供补丁。

bpo-29079 [https://bugs.python.org/issue?@action=redirect&bpo=29079]: 防止pathlib.resolve()在Windows上陷入无限循环。

bpo-13051 [https://bugs.python.org/issue?@action=redirect&bpo=13051]: 修复了大型或调整大小的curses.textpad.Textbox中的递归错误。基于Tycho Andersen的补丁。

bpo-9770 [https://bugs.python.org/issue?@action=redirect&bpo=9770]: curses.ascii谓词现在正确处理负整数。

bpo-28427 [https://bugs.python.org/issue?@action=redirect&bpo=28427]: 当从另一个线程收集时，旧键不应从WeakValueDictionary中移除新值。

bpo-28923 [https://bugs.python.org/issue?@action=redirect&bpo=28923]: 从Tix.py中移除编辑器工件。

bpo-28871 [https://bugs.python.org/issue?@action=redirect&bpo=28871]: 修复了在深度ElementTree释放时的崩溃。

bpo-19542 [https://bugs.python.org/issue?@action=redirect&bpo=19542]: 修复WeakValueDictionary.setdefault()和WeakValueDictionary.pop()中的bug，这些bug在另一个线程发生GC收集时出现。

bpo-20191 [https://bugs.python.org/issue?@action=redirect&bpo=20191]: 修复了resource.prlimit()中的崩溃，当传递一个不拥有其元素的序列作为限制时。

bpo-16255 [https://bugs.python.org/issue?@action=redirect&bpo=16255]: subprocess.Popen在Android上使用/system/bin/sh作为shell，而不是/bin/sh。

bpo-28779 [https://bugs.python.org/issue?@action=redirect&bpo=28779]: 如果预加载的模块实例化了某些多处理对象（如锁），multiprocessing.set_forkserver_preload()会使forkserver进程崩溃。

bpo-26937 [https://bugs.python.org/issue?@action=redirect&bpo=26937]: tarfile.TarFile 类的 chown() 方法现在在无法导入 grp 模块时不会失败，例如在 Android 平台上。

bpo-28847 [https://bugs.python.org/issue?@action=redirect&bpo=28847]: dbm.dumb 现在支持读取只读文件，并且在索引文件未更改时不再写入。如果在 'r' 和 'w' 模式下索引文件丢失并重新创建，现在会发出弃用警告（在未来的 Python 版本中将会是错误）。

bpo-27030 [https://bugs.python.org/issue?@action=redirect&bpo=27030]: 在 re.sub() 替换模板正则表达式中，由 '\' 和一个 ASCII 字母组成的未知转义现在会引发错误。

bpo-28835 [https://bugs.python.org/issue?@action=redirect&bpo=28835]: 修复了 warnings.catch_warnings() 中引入的一个回归问题：如果在上下文管理器内部覆盖了 warnings.showwarning()，则调用它。

bpo-27172 [https://bugs.python.org/issue?@action=redirect&bpo=27172]: 为了协助从 2.7 版本升级，之前文档中关于 inspect.getfullargspec() 的弃用已被撤销。在 Python 2.7 分支不再官方支持后，可能会重新考虑这一决定。

bpo-28740 [https://bugs.python.org/issue?@action=redirect&bpo=28740]: 添加 sys.getandroidapilevel()：返回 Android 的构建时 API 版本作为整数。此函数仅在 Android 上可用。

bpo-26273 [https://bugs.python.org/issue?@action=redirect&bpo=26273]: Add new socket.TCP_CONGESTION (Linux 2.6.13) and socket.TCP_USER_TIMEOUT (Linux 2.6.37) constants. Patch written by Omar Sandoval.

bpo-28752 [https://bugs.python.org/issue?@action=redirect&bpo=28752]: 恢复了 datetime 对象的 __reduce__() 方法。

bpo-28727 [https://bugs.python.org/issue?@action=redirect&bpo=28727]: 正则表达式模式，由 re.compile() 创建的 _sre.SRE_Pattern 对象，现在可以比较（仅限 x==y 和 x!=y 操作符）。这一更改应该修复了 bpo-18383 [https://bugs.python.org/issue?@action=redirect&bpo=18383]：当 warnings 模块重新加载时不要重复警告过滤器（通常只在单元测试中这样做）。

bpo-20572 [https://bugs.python.org/issue?@action=redirect&bpo=20572]: 移除了 subprocess.Popen.wait 的 endtime 参数。它在 3.4 版本中被弃用，在此之前也未在文档中记录。

bpo-25659 [https://bugs.python.org/issue?@action=redirect&bpo=25659]: 在 ctypes 中，防止在抽象类（如 Array）上调用 from_buffer() 和 from_buffer_copy() 方法时崩溃。

bpo-28548 [https://bugs.python.org/issue?@action=redirect&bpo=28548]: 在"http.server"模块中，尽可能解析协议版本，以避免在某些错误响应中使用HTTP 0.9。

bpo-19717 [https://bugs.python.org/issue?@action=redirect&bpo=19717]: 使Path.resolve()在不存在的路径上也能成功。由Vajrasky Kok提供补丁。

bpo-28563 [https://bugs.python.org/issue?@action=redirect&bpo=28563]: 修复了在gettext模块中处理复数形式选择时可能导致的DoS和任意代码执行问题。表达式解析器现在支持GNU gettext所支持的精确语法。

bpo-28387 [https://bugs.python.org/issue?@action=redirect&bpo=28387]: 修复了当垃圾收集器在其他线程中调用时，_io.TextIOWrapper解构器可能崩溃的问题。基于Sebastian Cufre的补丁。

bpo-27517 [https://bugs.python.org/issue?@action=redirect&bpo=27517]: LZMA压缩器和解压器在两次接收到空数据时不再抛出异常。补丁由Benjamin Fogle提供。

bpo-28549 [https://bugs.python.org/issue?@action=redirect&bpo=28549]: 修复了curses的addch()在使用ncurses6时的段错误。

bpo-28449 [https://bugs.python.org/issue?@action=redirect&bpo=28449]: tarfile.open()以模式"r"或"r:"现在会先尝试以压缩方式打开tar文件，再尝试无压缩方式打开。否则在使用ignore_zeros=True时有50%的几率失败。

bpo-23262 [https://bugs.python.org/issue?@action=redirect&bpo=23262]: webbrowser模块现在支持Firefox 36+及衍生浏览器。基于Oleg Broytman的补丁。

bpo-24241 [https://bugs.python.org/issue?@action=redirect&bpo=24241]: 在X环境下，webbrowser现在更倾向于直接使用默认浏览器。此外，webbrowser的register()函数现在有一个文档化的'preferred'参数，用于指定无参数调用get()时返回的浏览器。补丁由David Steele提供。

bpo-27939 [https://bugs.python.org/issue?@action=redirect&bpo=27939]: 修复了tkinter.ttk.LabeledScale和tkinter.Scale中由于在Tk内部将比例表示为浮点值而导致的错误。如果底层Tk变量设置为浮点值，tkinter.IntVar现在可以正常工作。

bpo-28255 [https://bugs.python.org/issue?@action=redirect&bpo=28255]: calendar.TextCalendar.prweek()不再在周历后打印空格。calendar.TextCalendar.pryear()不再在年历后打印多余的换行符。基于Xiang Zhang的补丁。

bpo-28255 [https://bugs.python.org/issue?@action=redirect&bpo=28255]: calendar.TextCalendar.prmonth()在打印月历后的新行开头不再打印空格。由Xiang Zhang提供补丁。

bpo-20491 [https://bugs.python.org/issue?@action=redirect&bpo=20491]: textwrap.TextWrapper 类现在支持不换行空格。基于 Kaarle Ritvanen 的补丁。

bpo-28353 [https://bugs.python.org/issue?@action=redirect&bpo=28353]: os.fwalk() 不再因损坏的链接而失败。

bpo-28430 [https://bugs.python.org/issue?@action=redirect&bpo=28430]: 修复了 C 实现的 asyncio.Future 迭代器不接受非 None 值传递给 it.send(val) 的问题。

bpo-27025 [https://bugs.python.org/issue?@action=redirect&bpo=27025]: 为提升可读性，Tkinter 部件的生成名称现在以 "!" 前缀开头。

bpo-25464 [https://bugs.python.org/issue?@action=redirect&bpo=25464]: 通过为 Tix 库的 bug 添加变通方法，修复了 tkinter.tix 模块中的 HList.header_exists()。

bpo-28488 [https://bugs.python.org/issue?@action=redirect&bpo=28488]: shutil.make_archive() 不再向 ZIP 归档添加 "./" 条目。

bpo-25953 [https://bugs.python.org/issue?@action=redirect&bpo=25953]: re.sub() 现在即使在字符串中未找到模式，也会为替换模板中的无效数字组引用引发错误。无效组引用的错误消息现在包括组索引和引用的位置。基于 SilentGhost 的补丁。

bpo-28469 [https://bugs.python.org/issue?@action=redirect&bpo=28469]: timeit 现在使用 1, 2, 5, 10, 20, 50,... 序列代替 1, 10, 100,... 进行自动范围调整。

bpo-28115 [https://bugs.python.org/issue?@action=redirect&bpo=28115]: zipfile 模块的命令行界面现在使用 argparse。添加了对长选项的支持。

bpo-18219 [https://bugs.python.org/issue?@action=redirect&bpo=18219]: 为大量列优化 csv.DictWriter。Mariatta Wijaya 的补丁。

bpo-28448 [https://bugs.python.org/issue?@action=redirect&bpo=28448]: 修复了 C 实现的 asyncio.Future 在 Windows 上不工作的问题。

bpo-23214 [https://bugs.python.org/issue?@action=redirect&bpo=23214]: 在 "io" 模块中，BufferedReader 和 BytesIO 的 read1() 方法的参数现在是可选的，并且可以是 -1，以匹配 BufferedIOBase 的规范。

bpo-28480 [https://bugs.python.org/issue?@action=redirect&bpo=28480]: 修复在禁用多线程时构建 socket 模块时的错误。

bpo-28240 [https://bugs.python.org/issue?@action=redirect&bpo=28240]: timeit: 移除自 Python 3.3 以来已弃用的 -c/--clock 和 -t/--time 命令行选项。

bpo-28240 [https://bugs.python.org/issue?@action=redirect&bpo=28240]: timeit 现在将基准测试重复 5 次而非仅 3 次，以使基准测试更加可靠。

bpo-28240 [https://bugs.python.org/issue?@action=redirect&bpo=28240]: 如果基准测试耗时少于 10 秒，timeit 自动范围调整现在使用单次循环迭代而非 10 次迭代。"python3 -m timeit -s 'import time' 'time.sleep(1)'" 现在耗时 4 秒而非 40 秒。

Distutils.sdist 现在对 README 和 setup.py 文件的查找区分大小写。这一行为与 Setuptools 6.0 及以后版本中的行为一致。理由参见 setuptools 100 [https://github.com/pypa/setuptools/issues/100]。

bpo-24452 [https://bugs.python.org/issue?@action=redirect&bpo=24452]: 使 webbrowser 支持 Mac OS X 上的 Chrome。由 Ned Batchelder 提供补丁。

bpo-20766 [https://bugs.python.org/issue?@action=redirect&bpo=20766]: 修复了 pdb 在处理 SIGINT 处理器时的引用泄漏问题。

bpo-27998 [https://bugs.python.org/issue?@action=redirect&bpo=27998]: 修复了 Windows 上 os.scandir() 对字节路径的支持。由 Eryk Sun 提供补丁。

bpo-28317 [https://bugs.python.org/issue?@action=redirect&bpo=28317]: 反汇编器现在解码 FORMAT_VALUE 参数。

bpo-28380 [https://bugs.python.org/issue?@action=redirect&bpo=28380]: unittest.mock 的 Mock autospec 函数现在正确支持 assert_called、assert_not_called 和 assert_called_once。

bpo-28229 [https://bugs.python.org/issue?@action=redirect&bpo=28229]: lzma 模块现在支持 pathlib。

bpo-28321 [https://bugs.python.org/issue?@action=redirect&bpo=28321]: 修复了在 plistlib 中使用二进制格式写入非 BMP 字符的问题。

bpo-28225 [https://bugs.python.org/issue?@action=redirect&bpo=28225]: bz2 模块现在支持 pathlib。初始由 Ethan Furman 提供补丁。

bpo-28227 [https://bugs.python.org/issue?@action=redirect&bpo=28227]: gzip 现在支持 pathlib。由 Ethan Furman 提供补丁。

bpo-28332 [https://bugs.python.org/issue?@action=redirect&bpo=28332]: 弃用了 socket.htons 和 socket.ntohs 中的静默截断。原始由 Oren Milman 提供补丁。

bpo-27358 [https://bugs.python.org/issue?@action=redirect&bpo=27358]: 优化了合并可变关键字参数的过程，并改进了当传递非映射作为可变关键字参数时的错误信息。

bpo-28257 [https://bugs.python.org/issue?@action=redirect&bpo=28257]: 改进了当传递非可迭代对象作为可变位置参数时的错误信息。添加了操作码 BUILD_TUPLE_UNPACK_WITH_CALL。

bpo-28322 [https://bugs.python.org/issue?@action=redirect&bpo=28322]: 修复了当从错误的 pickle 数据反序列化 itertools 对象时可能发生的崩溃。基于 John Leitch 的补丁。

bpo-28228 [https://bugs.python.org/issue?@action=redirect&bpo=28228]: imghdr 现在支持 pathlib。

bpo-28226 [https://bugs.python.org/issue?@action=redirect&bpo=28226]: compileall 现在支持 pathlib。

bpo-28314 [https://bugs.python.org/issue?@action=redirect&bpo=28314]: 修复了 xml.etree.ElementTree.Element 的 getiterator() 方法的函数声明（C 标志）。

bpo-28148 [https://bugs.python.org/issue?@action=redirect&bpo=28148]: 停止在 time 模块中使用 localtime() 和 gmtime()。引入了平台无关的 _PyTime_localtime API，该 API 类似于 POSIX 的 localtime_r，但在所有平台上都可用。由 Ed Schouten 提供补丁。

bpo-28253 [https://bugs.python.org/issue?@action=redirect&bpo=28253]: 修复了极端月份（0001-01和9999-12）的日历功能。重新实现了itermonthdays()和itermonthdays2()方法，使其不再调用可能导致datetime.date下溢/溢出的itermonthdates()。

bpo-28275 [https://bugs.python.org/issue?@action=redirect&bpo=28275]: 修复了LZMADecompressor和BZ2Decompressor类中decompress()方法可能存在的释放后使用问题。原始由John Leitch提供补丁。

bpo-27897 [https://bugs.python.org/issue?@action=redirect&bpo=27897]: 修复了如果传递无效的字符串类似对象作为名称时，sqlite3.Connection.create_collation()可能崩溃的问题。由Xiang Zhang提供补丁。

bpo-18844 [https://bugs.python.org/issue?@action=redirect&bpo=18844]: random.choices()现在将k作为仅关键字参数，以提高常见情况的可读性，并与其他语言中使用的签名保持一致。

bpo-18893 [https://bugs.python.org/issue?@action=redirect&bpo=18893]: 修复了Lib/ctypes/macholib/dyld.py中无效的异常处理。由Madison May提供补丁。

bpo-27611 [https://bugs.python.org/issue?@action=redirect&bpo=27611]: 修复了tkinter.tix模块中对默认根窗口的支持。在DisplayStyle构造函数中添加了master参数。

bpo-27348 [https://bugs.python.org/issue?@action=redirect&bpo=27348]: 在traceback模块中，恢复了类似于"Exception: None"的异常消息的格式化。这修复了3.5a2中引入的回归问题。

bpo-25651 [https://bugs.python.org/issue?@action=redirect&bpo=25651]: Allow falsy values to be used for msg parameter of subTest().

bpo-27778 [https://bugs.python.org/issue?@action=redirect&bpo=27778]: 修复了当getrandom()被信号中断且信号处理程序引发Python异常时，os.getrandom()中的内存泄漏问题。

bpo-28200 [https://bugs.python.org/issue?@action=redirect&bpo=28200]: 修复了Windows上os模块中的内存泄漏问题（修复了path_converter()函数）。

bpo-25400 [https://bugs.python.org/issue?@action=redirect&bpo=25400]: RobotFileParser现在正确返回crawl_delay和request_rate的默认值。初始由Peter Wirtz提供补丁。

bpo-27932 [https://bugs.python.org/issue?@action=redirect&bpo=27932]: 防止win32_ver()中的内存泄漏。

修复socket._sendfile_use_sendfile中的UnboundLocalError。

bpo-28075 [https://bugs.python.org/issue?@action=redirect&bpo=28075]: 在Windows的os.stat()实现中检查ERROR_ACCESS_DENIED。由Eryk Sun提供补丁。

bpo-22493 [https://bugs.python.org/issue?@action=redirect&bpo=22493]: 现在，通过在正则表达式中间使用内联标志发出的警告消息包含（截断的）正则表达式模式。由Tim Graham提供补丁。

bpo-25270 [https://bugs.python.org/issue?@action=redirect&bpo=25270]: 防止在传递空字节串时codecs.escape_encode()引发SystemError。

bpo-28181 [https://bugs.python.org/issue?@action=redirect&bpo=28181]: 通过HTTPS获取antigravity。由Kaartic Sivaraam提供补丁。

bpo-25895 [https://bugs.python.org/issue?@action=redirect&bpo=25895]: 在urllib.parse.urljoin中启用WebSocket URL方案。由Gergely Imreh和Markus Holtermann提供补丁。

bpo-28114 [https://bugs.python.org/issue?@action=redirect&bpo=28114]: 修复当env包含字节字符串时parse_envlist()崩溃的问题。由Eryk Sun提供补丁。

bpo-27599 [https://bugs.python.org/issue?@action=redirect&bpo=27599]: 修复binascii.b2a_qp()和binascii.a2b_qp()中的缓冲区溢出问题。

bpo-27906 [https://bugs.python.org/issue?@action=redirect&bpo=27906]: 在高TCP流量期间修复socket接受耗尽问题。由Kevin Conway提供补丁。

bpo-28174 [https://bugs.python.org/issue?@action=redirect&bpo=28174]: 处理当SO_REUSEPORT未被正确支持时的情况。由Seth Michael Larson提供补丁。

bpo-26654 [https://bugs.python.org/issue?@action=redirect&bpo=26654]: 在asyncio.Handle.__repr__中检查functools.partial。由iceboy提供补丁。

bpo-26909 [https://bugs.python.org/issue?@action=redirect&bpo=26909]: 修复asyncio中慢速管道IO的问题。由INADA Naoki提供补丁。

bpo-28176 [https://bugs.python.org/issue?@action=redirect&bpo=28176]: 修复asyncio.SelectorLoop.sock_connect中的回调竞争问题。

bpo-27759 [https://bugs.python.org/issue?@action=redirect&bpo=27759]: 修复选择器错误保留无效文件描述符的问题。由Mark Williams提供补丁。

bpo-28325 [https://bugs.python.org/issue?@action=redirect&bpo=28325]: 移除遗留的MacOS 9 macurl2path模块及其测试。

bpo-28368 [https://bugs.python.org/issue?@action=redirect&bpo=28368]: 如果子监视器没有附加循环，则拒绝监视进程。由Vincent Michel提供补丁。

bpo-28369 [https://bugs.python.org/issue?@action=redirect&bpo=28369]: 当传输的FD与add_reader、add_writer等一起使用时引发RuntimeError。

bpo-28370 [https://bugs.python.org/issue?@action=redirect&bpo=28370]: 加速asyncio.StreamReader.readexactly。由Коренберг Марк提供补丁。

bpo-28371 [https://bugs.python.org/issue?@action=redirect&bpo=28371]: 弃用将asyncio.Handles传递给run_in_executor的做法。

bpo-28372 [https://bugs.python.org/issue?@action=redirect&bpo=28372]: 修复asyncio以支持非python协程的格式化。

bpo-28399 [https://bugs.python.org/issue?@action=redirect&bpo=28399]: 在绑定前从文件系统中移除UNIX套接字。由Коренберг Марк提供补丁。

bpo-27972 [https://bugs.python.org/issue?@action=redirect&bpo=27972]: 禁止Tasks等待自身。

bpo-24142 [https://bugs.python.org/issue?@action=redirect&bpo=24142]: 读取损坏的配置文件会使configparser处于无效状态。原始补丁由Florian Höch提供。

bpo-29581 [https://bugs.python.org/issue?@action=redirect&bpo=29581]: ABCMeta.__new__现在接受 **kwargs，允许抽象基类在__init_subclass__中使用关键字参数。由Nate Soares提供补丁。

bpo-25532 [https://bugs.python.org/issue?@action=redirect&bpo=25532]: inspect.unwrap()现在只会尝试解包对象sys.getrecursionlimit()次，以防止在每次属性访问时创建新对象的对象。

bpo-30177 [https://bugs.python.org/issue?@action=redirect&bpo=30177]: path.resolve(strict=False)不再在文件系统中不存在的第一个元素后截断路径。补丁由Antoine Pietri提供。

文档

bpo-31294 [https://bugs.python.org/issue?@action=redirect&bpo=31294]: 修复ZeroMQSocketListener和ZeroMQSocketHandler示例中的不完整代码片段，并将它们适配到Python 3。

bpo-21649 [https://bugs.python.org/issue?@action=redirect&bpo=21649]: 在SSL文档中添加RFC 7525和Mozilla服务器端TLS链接。

bpo-31128 [https://bugs.python.org/issue?@action=redirect&bpo=31128]: 允许pydoc服务器绑定到任意主机名。

bpo-30803 [https://bugs.python.org/issue?@action=redirect&bpo=30803]: 澄清关于真值测试的文档。原始由Peter Thomassen提供补丁。

bpo-30176 [https://bugs.python.org/issue?@action=redirect&bpo=30176]: 在curses文档中添加缺失的属性相关常量。

bpo-30052 [https://bugs.python.org/issue?@action=redirect&bpo=30052]: bytes() 和 bytearray() 的链接目标现在是它们各自的类型定义，而不是相应的内置函数条目。使用 bytes 和 bytearray 来引用后者。为了确保这一及未来的交叉引用更新能自动应用，每日文档构建现在禁用了Sphinx中的默认输出缓存功能。

bpo-26985 [https://bugs.python.org/issue?@action=redirect&bpo=26985]: 在inspect文档中添加缺失的代码对象信息。

bpo-19824 [https://bugs.python.org/issue?@action=redirect&bpo=19824]: 通过强调模板字符串在国际化中的实用性，并澄清一些使用限制，改进模板字符串的文档和链接。(另见 : bpo-20314 [https://bugs.python.org/issue?@action=redirect&bpo=20314], bpo-12518 [https://bugs.python.org/issue?@action=redirect&bpo=12518])

bpo-28929 [https://bugs.python.org/issue?@action=redirect&bpo=28929]: 将文档链接到其在GitHub上的源文件。

bpo-25008 [https://bugs.python.org/issue?@action=redirect&bpo=25008]: 将smtpd.py文档标记为实际上已弃用，并添加指向aiosmtpd的指针，这是一个基于asyncio的第三方替代品。

bpo-26355 [https://bugs.python.org/issue?@action=redirect&bpo=26355]: 在每个页面上添加指向相应主要版本文档的规范头部链接。由Matthias Bussonnier提供补丁。

bpo-29349 [https://bugs.python.org/issue?@action=redirect&bpo=29349]: 修复构建文档代码中的Python 2语法。

bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722]: 3.6 新特性指南中的数据模型参考和移植部分现在涵盖了自定义元类为实现完全支持 PEP 487 [https://www.python.org/dev/peps/pep-0487] 和无参数 super() 所需的额外 __classcell__ 处理。

bpo-28513 [https://bugs.python.org/issue?@action=redirect&bpo=28513]: 记录了 zipfile 的命令行接口。

测试

bpo-29639 [https://bugs.python.org/issue?@action=redirect&bpo=29639]: test.support.HOST 现在是 "localhost"，新增了一个 HOSTv4 常量用于满足 127.0.0.1 的需求，类似于现有的 HOSTv6 常量。

bpo-31320 [https://bugs.python.org/issue?@action=redirect&bpo=31320]: 在 test_ssl 中静默回溯。

bpo-31346 [https://bugs.python.org/issue?@action=redirect&bpo=31346]: 对于 SSLContext，优先使用 PROTOCOL_TLS_CLIENT 和 PROTOCOL_TLS_SERVER 协议。

bpo-25674 [https://bugs.python.org/issue?@action=redirect&bpo=25674]: 移除 sha256.tbs-internet.com 的 ssl 测试。

bpo-30715 [https://bugs.python.org/issue?@action=redirect&bpo=30715]: 处理 OpenSSL 1.1.0f 的 ALPN 回调变更。最新版本的行为类似于 OpenSSL 1.0.2，不再中止握手。

bpo-30822 [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。

bpo-30695 [https://bugs.python.org/issue?@action=redirect&bpo=30695]: Add the set_nomemory(start, stop) and remove_mem_hooks() functions to the _testcapi module.

bpo-30357 [https://bugs.python.org/issue?@action=redirect&bpo=30357]: test_thread: setUp() 现在使用 support.threading_setup() 和 support.threading_cleanup() 来等待线程完成，以避免对后续测试产生随机副作用。初始补丁由 Grzegorz Grzywacz 编写。

bpo-30197 [https://bugs.python.org/issue?@action=redirect&bpo=30197]: 增强了 test.support 模块中的 swap_attr() 和 swap_item() 函数。它们现在可以在 with 语句内部删除替换的属性或项目时工作。属性或项目的旧值（如果不存在则为 None）现在将被赋值给 "as" 子句的目标，如果有的话。

bpo-24932 [https://bugs.python.org/issue?@action=redirect&bpo=24932]: 在 _testembed 中使用正确的命令行解析。

bpo-28950 [https://bugs.python.org/issue?@action=redirect&bpo=28950]: 在 regrtest 命令行参数中禁止将 -j0 与 -T/-l 结合使用。

bpo-28683 [https://bugs.python.org/issue?@action=redirect&bpo=28683]: 修复在Android上为非root用户绑定Unix socket并引发PermissionError的测试。

bpo-26936 [https://bugs.python.org/issue?@action=redirect&bpo=26936]: 修复Android上的test_socket失败 - getservbyname()、getservbyport()和getaddrinfo()在某些Android API级别上被破坏。

bpo-28666 [https://bugs.python.org/issue?@action=redirect&bpo=28666]: 现在test.support.rmtree能够删除不可写或不可读的目录。

bpo-23839 [https://bugs.python.org/issue?@action=redirect&bpo=23839]: 现在在运行每个测试文件之前清除各种缓存。

bpo-26944 [https://bugs.python.org/issue?@action=redirect&bpo=26944]: 修复Android上的test_posix，其中'id -G'完全错误或缺少有效的gid。

bpo-28409 [https://bugs.python.org/issue?@action=redirect&bpo=28409]: regrtest: 修复命令行参数的解析器。

bpo-28217 [https://bugs.python.org/issue?@action=redirect&bpo=28217]: 添加_testconsole模块以测试控制台输入。

bpo-26939 [https://bugs.python.org/issue?@action=redirect&bpo=26939]: 添加support.setswitchinterval()函数以修复在Android armv7 qemu模拟器上挂起的test_functools。

构建

bpo-31354 [https://bugs.python.org/issue?@action=redirect&bpo=31354]: Allow --with-lto to be used on all builds, not just make profile-opt.

bpo-31370 [https://bugs.python.org/issue?@action=redirect&bpo=31370]: 移除对构建--without-threads的支持。在21世纪，这个选项已经不再真正有用。移除大量条件路径允许我们简化代码库，包括难以维护的低级内部代码。

bpo-31341 [https://bugs.python.org/issue?@action=redirect&bpo=31341]: 根据 PEP 11 [https://www.python.org/dev/peps/pep-0011]，移除了对IRIX操作系统的支持。

bpo-30854 [https://bugs.python.org/issue?@action=redirect&bpo=30854]: 修复编译--without-threads时的编译错误。由Masayuki Yamamoto提供补丁。

bpo-30687 [https://bugs.python.org/issue?@action=redirect&bpo=30687]: 在Windows上构建时定位msbuild.exe而不是vcvarsall.bat。

bpo-20210 [https://bugs.python.org/issue?@action=redirect&bpo=20210]: 支持Setup文件中的 disabled 标记。在此标记之后列出的扩展模块完全不被构建，无论是通过Makefile还是setup.py。

bpo-29941 [https://bugs.python.org/issue?@action=redirect&bpo=29941]: 添加 --with-assertions 配置标志以明确启用C assert() 检查。默认为关闭。--with-pydebug``意味着 ``--with-assertions。

bpo-28787 [https://bugs.python.org/issue?@action=redirect&bpo=28787]: 修复使用 --with--dtrace 配置时Python的树外构建。

bpo-29243 [https://bugs.python.org/issue?@action=redirect&bpo=29243]: 在配置为 --enable-optimizations 时，防止在 make test、``make install``和一些其他make目标期间不必要的Python重新构建。

bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404]: 不再基于文件修改时间重新生成已生成的文件：该操作现在是显式的。用``make regen-all``替换 make touch。

bpo-29643 [https://bugs.python.org/issue?@action=redirect&bpo=29643]: 修复 --enable-optimization 不起作用的问题。

bpo-27593 [https://bugs.python.org/issue?@action=redirect&bpo=27593]: 当从仓库构建时，sys.version和platform模块的python_build()、python_branch()和python_revision()函数现在使用git信息而不是hg。

bpo-29572 [https://bugs.python.org/issue?@action=redirect&bpo=29572]: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2k。

bpo-27659 [https://bugs.python.org/issue?@action=redirect&bpo=27659]: 禁止隐式C函数声明：在可能的情况下使用``-Werror=implicit-function-declaration`` (GCC和Clang，但这取决于编译器版本) 。补丁由Chi Hsuan Yen编写。

bpo-29384 [https://bugs.python.org/issue?@action=redirect&bpo=29384]: 移除旧的Be OS辅助脚本。

bpo-26851 [https://bugs.python.org/issue?@action=redirect&bpo=26851]: 设置Android编译和链接标志。

bpo-28768 [https://bugs.python.org/issue?@action=redirect&bpo=28768]: 修复函数_setmode的隐式声明。由Masayuki Yamamoto提供补丁

bpo-29080 [https://bugs.python.org/issue?@action=redirect&bpo=29080]: 从PCBuild/build.bat中移除对hg.exe的硬依赖

bpo-23903 [https://bugs.python.org/issue?@action=redirect&bpo=23903]: 向PC/python3.def添加遗漏的名称。

bpo-28762 [https://bugs.python.org/issue?@action=redirect&bpo=28762]: lockf()在Android API level 24上可用，但F_LOCK宏在android-ndk-r13中未定义。

bpo-28538 [https://bugs.python.org/issue?@action=redirect&bpo=28538]: 修复因if_nameindex()在Android API level 24上可用但if_nameindex结构未定义而导致的编译错误。

bpo-20211 [https://bugs.python.org/issue?@action=redirect&bpo=20211]: 不要将安装C头文件的目录和安装对象代码库的目录添加到交叉编译搜索路径中。原始由Thomas Petazzoni提供补丁。

bpo-28849 [https://bugs.python.org/issue?@action=redirect&bpo=28849]: 不要在Android上定义sys.implementation._multiarch。

bpo-10656 [https://bugs.python.org/issue?@action=redirect&bpo=10656]: 修复AIX上的树外构建。由Tristan Carel和Michael Haubenwallner提供补丁。

bpo-26359 [https://bugs.python.org/issue?@action=redirect&bpo=26359]: 将--with-optimiations重命名为--enable-optimizations。

bpo-28444 [https://bugs.python.org/issue?@action=redirect&bpo=28444]: 修复交叉编译时缺少扩展模块的问题。

bpo-28208 [https://bugs.python.org/issue?@action=redirect&bpo=28208]: 更新Windows构建和OS X安装程序以使用SQLite 3.14.2。

bpo-28248 [https://bugs.python.org/issue?@action=redirect&bpo=28248]: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2j。

bpo-21124 [https://bugs.python.org/issue?@action=redirect&bpo=21124]: 通过在PyVarObject_HEAD_INIT中传递 NULL 而不是 &PyType_Type 修复在Cygwin上构建_struct模块的问题。由Masayuki Yamamoto提供补丁。

bpo-13756 [https://bugs.python.org/issue?@action=redirect&bpo=13756]: 修复在Cygwin上构建扩展模块的问题。由Roumen Petrov提供补丁，基于Jason Tishler的原始补丁。

bpo-21085 [https://bugs.python.org/issue?@action=redirect&bpo=21085]: 添加对siginfo_t.si_band的配置检查，Cygwin不提供此功能。由Masayuki Yamamoto提供补丁，Erik Bray进行审查和重新基于。

bpo-28258 [https://bugs.python.org/issue?@action=redirect&bpo=28258]: 修复了在爱沙尼亚语言环境下构建的问题（Makefile中的python-config和distclean目标）。由Arfrever Frehtes Taifersar Arahesis提供补丁。

bpo-26661 [https://bugs.python.org/issue?@action=redirect&bpo=26661]: setup.py现在可以检测到带有multiarch包装的系统libffi。

bpo-27979 [https://bugs.python.org/issue?@action=redirect&bpo=27979]: 不再为在非OSX UNIX平台上构建_ctypes捆绑libffi的完整副本。现在在这样的平台上构建_ctypes需要安装libffi。

bpo-15819 [https://bugs.python.org/issue?@action=redirect&bpo=15819]: 移除了为在源码树外构建而冗余的包含搜索目录选项。

bpo-28676 [https://bugs.python.org/issue?@action=redirect&bpo=28676]: 防止在macOS上出现缺失'getentropy'声明的警告。由Gareth Rees提供补丁。

Windows

bpo-31392 [https://bugs.python.org/issue?@action=redirect&bpo=31392]: 更新Windows构建以使用OpenSSL 1.1.0f。

bpo-30389 [https://bugs.python.org/issue?@action=redirect&bpo=30389]: 在Windows上的distutils中添加对Visual Studio 2017的检测。

bpo-31358 [https://bugs.python.org/issue?@action=redirect&bpo=31358]: zlib不再捆绑在CPython源代码中，而是像bz2、lzma、OpenSSL、Tcl/Tk和SQLite一样按需下载。

bpo-31340 [https://bugs.python.org/issue?@action=redirect&bpo=31340]: 更改为使用MSVC v141（包含在Visual Studio 2017中）构建。

bpo-30581 [https://bugs.python.org/issue?@action=redirect&bpo=30581]: os.cpu_count()现在在Windows上当逻辑处理器数量大于64时返回正确的处理器数量。

bpo-30916 [https://bugs.python.org/issue?@action=redirect&bpo=30916]: 预构建OpenSSL、Tcl和Tk，并将二进制文件包含在构建中。

bpo-30731 [https://bugs.python.org/issue?@action=redirect&bpo=30731]: 向python.manifest添加缺失的xmlns，以使其匹配模式。

bpo-30291 [https://bugs.python.org/issue?@action=redirect&bpo=30291]: 允许使用-64后缀从py.exe要求64位解释器。由Steve (Gadget) Barnes贡献。

bpo-30362 [https://bugs.python.org/issue?@action=redirect&bpo=30362]: 向py.exe启动器添加列表选项（-0, -0p）。由Steve Barnes贡献。

bpo-23451 [https://bugs.python.org/issue?@action=redirect&bpo=23451]: 修复 socketmodule.c 中的 socket 弃用警告。由 Segev Finer 提供补丁。

bpo-30450 [https://bugs.python.org/issue?@action=redirect&bpo=30450]: Windows 上的构建过程不再依赖于 Subversion，而是通过 Python 脚本从 GitHub 拉取外部代码。如果系统中未找到 Python 3.6（通过 py -3.6），则使用 NuGet 下载 32 位 Python 的副本。

bpo-29579 [https://bugs.python.org/issue?@action=redirect&bpo=29579]: 从安装程序中移除 readme.txt。

bpo-25778 [https://bugs.python.org/issue?@action=redirect&bpo=25778]: winreg 未正确截断字符串（由 Eryk Sun 提供补丁）

bpo-28896 [https://bugs.python.org/issue?@action=redirect&bpo=28896]: 弃用 WindowsRegistryFinder 并默认禁用它

bpo-28522 [https://bugs.python.org/issue?@action=redirect&bpo=28522]: 修复 getpathp.c 中错误处理的缓冲区重新分配

bpo-28402 [https://bugs.python.org/issue?@action=redirect&bpo=28402]: 为 Windows 上的标准库添加签名目录文件。

bpo-28333 [https://bugs.python.org/issue?@action=redirect&bpo=28333]: 为 ps1/ps2 和 input() 提示启用 Unicode。（由 Eryk Sun 提供补丁）

bpo-28251 [https://bugs.python.org/issue?@action=redirect&bpo=28251]: 改进 Windows 上的帮助手册。

bpo-28110 [https://bugs.python.org/issue?@action=redirect&bpo=28110]: launcher.msi 在 32 位和 64 位之间有不同的产品代码

bpo-28161 [https://bugs.python.org/issue?@action=redirect&bpo=28161]: 以写权限打开 CON 失败

bpo-28162 [https://bugs.python.org/issue?@action=redirect&bpo=28162]: 如果第一行以 Ctrl+Z 开头，WindowsConsoleIO readall() 失败

bpo-28163 [https://bugs.python.org/issue?@action=redirect&bpo=28163]: WindowsConsoleIO fileno() 将错误的标志传递给 _open_osfhandle

bpo-28164 [https://bugs.python.org/issue?@action=redirect&bpo=28164]: 对于各种路径，_PyIO_get_console_type 失败

bpo-28137 [https://bugs.python.org/issue?@action=redirect&bpo=28137]: 将 Windows 路径文件重命名为 ._pth

bpo-28138 [https://bugs.python.org/issue?@action=redirect&bpo=28138]: Windows ._pth 文件应允许导入站点

IDLE

bpo-31493 [https://bugs.python.org/issue?@action=redirect&bpo=31493]: IDLE 代码上下文——修复代码更新和字体更新计时器。取消计时器可以防止 test_idle 完成时出现警告消息。

bpo-31488 [https://bugs.python.org/issue?@action=redirect&bpo=31488]: IDLE - 更新前扩展类中的非键选项。应用配置对话框更改时，为每个特性类调用 .reload。更改 ParenMatch，使更新的选项影响附加到现有编辑器窗口的现有实例。

bpo-31477 [https://bugs.python.org/issue?@action=redirect&bpo=31477]: IDLE - 改进文档中的 rstrip 条目。剥离尾随空白会剥离比空格更多的内容。多行字符串文字不被跳过。

bpo-31480 [https://bugs.python.org/issue?@action=redirect&bpo=31480]: IDLE - 使测试在默认禁用 zzdummy 扩展的情况下通过。

bpo-31421 [https://bugs.python.org/issue?@action=redirect&bpo=31421]: 文档说明IDLE如何运行tkinter程序。IDLE在后台调用tcl/tk更新，以使与tkinter应用程序的实时交互和实验更加容易。

bpo-31414 [https://bugs.python.org/issue?@action=redirect&bpo=31414]: IDLE -- 通过首先删除来修复tk输入框测试。向整数输入框中添加内容与删除并插入不同，因为int('')会失败。

bpo-31051 [https://bugs.python.org/issue?@action=redirect&bpo=31051]: 将IDLE的configdialog GenPage重新排列为窗口、编辑器和帮助部分。

bpo-30617 [https://bugs.python.org/issue?@action=redirect&bpo=30617]: IDLE - 为outwin子类添加文档字符串和测试，这是editor的子类。将一些数据和函数从类移到模块级别。由Cheryl Sabella提供补丁。

bpo-31287 [https://bugs.python.org/issue?@action=redirect&bpo=31287]: IDLE - 在test_configdialog中不要修改tkinter.message。

bpo-27099 [https://bugs.python.org/issue?@action=redirect&bpo=27099]: 将 IDLE 的内置“扩展”功能转换为常规功能。约 10 项 IDLE 功能原本以可选扩展的形式实现，但是，它们的差异行为导致用户困惑甚至更糟，也不利于维护，因此，进行此次转换。对用户的主要区别在于，现在内置功能的可自定义按键绑定将采用统一方式处理。具体表现为：在某个按键集中编辑绑定仅会影响该按键集中的值。所有绑定均在 config-extensions.def 文件中系统预设的默认按键集中统一定义。所有自定义按键集会整体保存在 config-extension.cfg 文件中。点击“应用”或“确定”后所有更改立即生效。受影响的交互事件包括'<<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 提交。

bpo-31206 [https://bugs.python.org/issue?@action=redirect&bpo=31206]: IDLE: 从ConfigDialog中提取HighPage(Frame)类。由Cheryl Sabella提供补丁。

bpo-31001 [https://bugs.python.org/issue?@action=redirect&bpo=31001]: 为configdialog高亮标签添加测试。由Cheryl Sabella提供补丁。

bpo-31205 [https://bugs.python.org/issue?@action=redirect&bpo=31205]: IDLE：从ConfigDialog中提取KeysPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

bpo-31130 [https://bugs.python.org/issue?@action=redirect&bpo=31130]: IDLE -- 修复test_configdialog中的内存泄漏。初始由Victor Stinner提供补丁。

bpo-31002 [https://bugs.python.org/issue?@action=redirect&bpo=31002]: 为configdialog的keys标签页添加测试。由Cheryl Sabella提供补丁。

bpo-19903 [https://bugs.python.org/issue?@action=redirect&bpo=19903]: IDLE: Calltips use inspect.signature instead of inspect.getfullargspec. This improves calltips for builtins converted to use Argument Clinic. Patch by Louie Lu.

bpo-31083 [https://bugs.python.org/issue?@action=redirect&bpo=31083]: IDLE - 在configdialog中添加TabPage类的概要。更新现有类以匹配概要。初始补丁由Cheryl Sabella提供。

bpo-31050 [https://bugs.python.org/issue?@action=redirect&bpo=31050]: 从ConfigDialog中提取GenPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

bpo-31004 [https://bugs.python.org/issue?@action=redirect&bpo=31004]: IDLE - 从ConfigDialog中提取FontPage(Frame)类。经过轻微修改的测试仍然通过。修复通用测试。补丁主要由Cheryl Sabella提供。

bpo-30781 [https://bugs.python.org/issue?@action=redirect&bpo=30781]: IDLE - 在ConfigDialog中使用ttk部件。由Terry Jan Reedy和Cheryl Sabella提供补丁。

bpo-31060 [https://bugs.python.org/issue?@action=redirect&bpo=31060]: IDLE - 完成ConfigDialog中方法的重新排列。将与每个标签页和按钮相关的方法分组有助于编写测试和改进标签页，并将使这些组能够分割成类。

bpo-30853 [https://bugs.python.org/issue?@action=redirect&bpo=30853]: IDLE -- 从ConfigDialog中提取VarTrace类。实例跟踪器管理由tk变量和回调函数组成的对。当跟踪开启时，设置变量会调用函数。新类的测试覆盖率为100%。

bpo-31003 [https://bugs.python.org/issue?@action=redirect&bpo=31003]: IDLE：为通用标签页添加更多测试。

bpo-30993 [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调用的移动。为加载函数添加测试。将所有字体测试放在一个类中，将标签缩进测试放在另一个类中。除了两行代码外，这些测试完全覆盖了相关函数。

bpo-30981 [https://bugs.python.org/issue?@action=redirect&bpo=30981]: IDLE -- 为配置对话框字体页面添加更多测试。

bpo-28523 [https://bugs.python.org/issue?@action=redirect&bpo=28523]: IDLE：在配置对话框中将'colour'替换为'color'。

bpo-30917 [https://bugs.python.org/issue?@action=redirect&bpo=30917]: 为idlelib.config.IdleConf添加测试。将覆盖率从46%提高到96%。由Louie Lu提供补丁。

bpo-30934 [https://bugs.python.org/issue?@action=redirect&bpo=30934]: 记录idlelib测试的覆盖率详情。在idlelib/idle-test/README.txt中添加部分内容。包括检查分支是否双向执行。排除在单元测试期间不运行的IDLE特定代码。

bpo-30913 [https://bugs.python.org/issue?@action=redirect&bpo=30913]: IDLE：在文档字符串中记录ConfigDialog的tk变量、方法和部件。这将有助于改进对话框和分割类。原始由Cheryl Sabella提供补丁。

bpo-30899 [https://bugs.python.org/issue?@action=redirect&bpo=30899]: IDLE：为config中的ConfigParser子类添加测试。由Louie Lu提供补丁。

bpo-30881 [https://bugs.python.org/issue?@action=redirect&bpo=30881]: IDLE：为browser.py添加文档字符串。由Cheryl Sabella提供补丁。

bpo-30851 [https://bugs.python.org/issue?@action=redirect&bpo=30851]: IDLE：移除configdialog中未使用的变量。一个是重复的，一个是设置但用户无法更改的。由Cheryl Sabella提供补丁。

bpo-30870 [https://bugs.python.org/issue?@action=redirect&bpo=30870]: IDLE：在设置对话框中，使用上下键以及鼠标选择字体。初始由Louie Lu提供补丁。

bpo-8231 [https://bugs.python.org/issue?@action=redirect&bpo=8231]: IDLE：仅调用config.IdleConf.GetUserCfgDir一次。

bpo-30779 [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贡献了部分补丁。

bpo-30777 [https://bugs.python.org/issue?@action=redirect&bpo=30777]: IDLE：configdialog - 添加文档字符串并修复注释。由Cheryl Sabella提供补丁。

bpo-30495 [https://bugs.python.org/issue?@action=redirect&bpo=30495]: IDLE：通过添加文档字符串、PEP8命名和更多测试来改进textview。由Cheryl Sabella提供补丁。

bpo-30723 [https://bugs.python.org/issue?@action=redirect&bpo=30723]: IDLE：对parenmatch进行多项改进。添加'parens'风格以同时高亮开启和关闭符号。使'default'风格（非默认）成为'opener'的同义词。使时间延迟在所有风格中工作方式相同。为配置对话框扩展标签添加帮助，包括parenmatch的帮助。添加新测试。原始补丁由Charles Wohlganger提供。

bpo-30674 [https://bugs.python.org/issue?@action=redirect&bpo=30674]: IDLE：向grep模块添加文档字符串。由Cheryl Sabella提供补丁。

bpo-21519 [https://bugs.python.org/issue?@action=redirect&bpo=21519]: IDLE的基本自定义键输入对话框现在能正确检测重复项。原始由Saimadhav Heblikar提供补丁。

bpo-29910 [https://bugs.python.org/issue?@action=redirect&bpo=29910]: IDLE不再通过快捷键注释掉一个区域后删除一个字符。为此添加 ``return 'break'``以及IDLE和默认键绑定之间的其他潜在冲突。

bpo-30728 [https://bugs.python.org/issue?@action=redirect&bpo=30728]: 审查并更改idlelib.configdialog的名称。将方法和属性名称小写。将'colour'替换为'color'，扩展过于隐晦的名称，删除不需要的下划线。用特定的导入替换 import *。由Cheryl Sabella提供补丁。

bpo-6739 [https://bugs.python.org/issue?@action=redirect&bpo=6739]: IDLE：通过尝试用tk绑定用户输入的键序列来验证它们。为所有3个验证函数添加测试。原始由G Polo提供补丁。测试由Cheryl Sabella添加。

bpo-15786 [https://bugs.python.org/issue?@action=redirect&bpo=15786]: 修复IDLE自动完成框的几个问题。现在以下功能应该可以正常工作：点击选择框中的项目；使用滚动条；通过按回车键选择项目。MacOSX上的挂起问题应该不会再发生。补丁由Louie Lu提供。

bpo-25514 [https://bugs.python.org/issue?@action=redirect&bpo=25514]: 添加关于IDLE启动失败的文档子节。无连接弹出消息会引导用户查看此部分。

bpo-30642 [https://bugs.python.org/issue?@action=redirect&bpo=30642]: 修复IDLE测试中的引用泄露。由Louie Lu和Terry Jan Reedy提供补丁。

bpo-30495 [https://bugs.python.org/issue?@action=redirect&bpo=30495]: 为textview.py添加文档字符串并使用PEP8命名。由Cheryl Sabella和Terry Jan Reedy提供补丁。

bpo-30290 [https://bugs.python.org/issue?@action=redirect&bpo=30290]: 帮助-关于：使用pep8命名并添加测试。将覆盖率提高到100%。由Louie Lu、Cheryl Sabella和Terry Jan Reedy提供补丁。

bpo-30303 [https://bugs.python.org/issue?@action=redirect&bpo=30303]: 向textview添加_utest选项；添加新测试。将覆盖率提高到100%。由Louie Lu和Terry Jan Reedy提供补丁。

bpo-29071 [https://bugs.python.org/issue?@action=redirect&bpo=29071]: IDLE为f-字符串前缀着色（但不包括无效的ur前缀）。

bpo-28572 [https://bugs.python.org/issue?@action=redirect&bpo=28572]: 将IDLE的test_configdialog覆盖率提高10%。更新并增强配置系统的描述。

工具/示例

bpo-30983 [https://bugs.python.org/issue?@action=redirect&bpo=30983]: gdb集成命令（py-bt等）现在也可以在优化的共享构建上工作了。PEP 523 [https://www.python.org/dev/peps/pep-0523] 引入了_PyEval_EvalFrameDefault，它在非调试共享构建上内联了PyEval_EvalFrameEx。这破坏了使用py-bt、py-up和其他一些Python特定的gdb集成的能力。问题通过在python-gdb.py中仅查找_PyEval_EvalFrameDefault帧来修复。原始由Bruno "Polaco" Penteado提供补丁。

bpo-29748 [https://bugs.python.org/issue?@action=redirect&bpo=29748]: 在Argument Clinic中添加了切片索引转换器。

bpo-24037 [https://bugs.python.org/issue?@action=redirect&bpo=24037]: Argument Clinic now uses the converter bool(accept={int}) rather than int for semantical booleans. This avoids repeating the default value for Python and C and will help in converting to bool in future.

bpo-29367 [https://bugs.python.org/issue?@action=redirect&bpo=29367]: python-gdb.py现在也支持 method-wrapper (wrapperobject) 对象。

bpo-28023 [https://bugs.python.org/issue?@action=redirect&bpo=28023]: 修复python-gdb.py不支持新字典实现的问题。

bpo-15369 [https://bugs.python.org/issue?@action=redirect&bpo=15369]: The pybench and pystone microbenchmark have been removed from Tools. Please use the new Python benchmark suite https://github.com/python/performance which is more reliable and includes a portable version of pybench working on Python 2 and Python 3.

bpo-28102 [https://bugs.python.org/issue?@action=redirect&bpo=28102]: zipfile模块的CLI现在将用法打印到stderr。由Stephen J. Turnbull提供补丁。

C API

bpo-31338 [https://bugs.python.org/issue?@action=redirect&bpo=31338]: 添加了 Py_UNREACHABLE() 宏，用于永远不会预期到达的代码路径。这个和其他一些有用的宏现在已在C API手册中记录。

bpo-30832 [https://bugs.python.org/issue?@action=redirect&bpo=30832]: 移除了线程本地存储的自实现。CPython在Python/thread.c中提供了线程本地存储（TLS）的自实现，用于平台没有提供原生TLS的情况。然而，当前所有支持的平台（Windows和pthreads）都已提供原生TLS，并且在任何情况下都无条件定义了Py_HAVE_NATIVE_TLS宏。

bpo-30708 [https://bugs.python.org/issue?@action=redirect&bpo=30708]: 如果第二个参数为NULL且wchar_t*字符串包含空字符，PyUnicode_AsWideCharString()现在会引发ValueError。

bpo-16500 [https://bugs.python.org/issue?@action=redirect&bpo=16500]: 弃用PyOS_AfterFork()并添加PyOS_BeforeFork()、PyOS_AfterFork_Parent()和PyOS_AfterFork_Child()。

bpo-6532 [https://bugs.python.org/issue?@action=redirect&bpo=6532]: PyThread_start_new_thread()和PyThread_get_thread_ident()的结果类型，以及PyThreadState_SetAsyncExc()的id参数类型从"long"改为"unsigned long"。

bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867]: 函数PySlice_GetIndicesEx()被弃用，如果Py_LIMITED_API未设置或设置为0x03050400到0x03060000（不包括）或0x03060100或更高的值，则替换为宏。添加了函数PySlice_Unpack()和PySlice_AdjustIndices()。

bpo-29083 [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中不可用。

bpo-28769 [https://bugs.python.org/issue?@action=redirect&bpo=28769]: PyUnicode_AsUTF8AndSize() 和 PyUnicode_AsUTF8() 的结果现在是 const char * 类型，而不是 char *。

bpo-29058 [https://bugs.python.org/issue?@action=redirect&bpo=29058]: 所有在 Python 3.2 之后添加的稳定 API 扩展现在只有在 Py_LIMITED_API 设置为支持此 API 的最低 Python 版本的 PY_VERSION_HEX 值时才可用。

bpo-28822 [https://bugs.python.org/issue?@action=redirect&bpo=28822]: PyUnicode_FindChar() 的索引参数 start 和 end 现在被调整为像 str[start:end] 一样行为。

bpo-28808 [https://bugs.python.org/issue?@action=redirect&bpo=28808]: PyUnicode_CompareWithASCIIString() 现在永远不会引发异常。

bpo-28761 [https://bugs.python.org/issue?@action=redirect&bpo=28761]: 结构体 PyMemberDef、PyGetSetDef、PyStructSequence_Field、PyStructSequence_Desc 和 wrapperbase 的字段 name 和 doc 现在是 const char * 类型，而不是 char *。

bpo-28748 [https://bugs.python.org/issue?@action=redirect&bpo=28748]: 私有变量 _Py_PackageContext 现在是 const char * 类型，而不是 char *。

bpo-19569 [https://bugs.python.org/issue?@action=redirect&bpo=19569]: 如果使用大多数已弃用的函数，现在会发出编译器警告。

bpo-28426 [https://bugs.python.org/issue?@action=redirect&bpo=28426]: 已弃用未记录的函数 PyUnicode_AsEncodedObject()、PyUnicode_AsDecodedObject()、PyUnicode_AsDecodedUnicode() 和 PyUnicode_AsEncodedUnicode()。

Python 3.6.6 正式版

发布日期: 2018-06-27

在 3.6.6 版本中没有新的更改。

Python 3.6.6 rc1

发布日期: 2018-06-11

核心与内置函数

bpo-33786 [https://bugs.python.org/issue?@action=redirect&bpo=33786]: 修复异步生成器以正确处理 athrow() 中的 GeneratorExit。

bpo-30654 [https://bugs.python.org/issue?@action=redirect&bpo=30654]: 修复了即使之前设置了自定义处理程序，在解释器关闭时 SIGINT 处理程序重置为 SIG_DFL 的问题。由 Philipp Kerling 提供补丁。

bpo-33622 [https://bugs.python.org/issue?@action=redirect&bpo=33622]: 修复了当垃圾收集器无法将带有 __del__ 方法或被其引用的对象添加到 gc.garbage 列表时的内存泄漏问题。现在可以在设置异常时调用 PyGC_Collect()，并保留异常。

bpo-31849 [https://bugs.python.org/issue?@action=redirect&bpo=31849]: 修复了 pyhash.c 中的有符号/无符号比较警告。

bpo-33391 [https://bugs.python.org/issue?@action=redirect&bpo=33391]: 修复了 set_symmetric_difference() 中的内存泄漏。

bpo-28055 [https://bugs.python.org/issue?@action=redirect&bpo=28055]: 修复了 siphash24() 中的未对齐访问。由 Rolf Eike Beer 提供补丁。

bpo-33231 [https://bugs.python.org/issue?@action=redirect&bpo=33231]: 修复了 normalizestring() 中潜在的内存泄漏问题。

bpo-29922 [https://bugs.python.org/issue?@action=redirect&bpo=29922]: 改进了'async with'中当 __aenter__() 或 __aexit__() 返回不可等待对象时的错误消息。

bpo-33199 [https://bugs.python.org/issue?@action=redirect&bpo=33199]: 修复了在从键共享字典复制时，字典实现中的 ma_version_tag 未初始化的问题。

bpo-33041 [https://bugs.python.org/issue?@action=redirect&bpo=33041]: 修复了当函数包含 async for 循环时的跳转问题。

bpo-32282 [https://bugs.python.org/issue?@action=redirect&bpo=32282]: 修复 Windows 上 socketmodule 中 VersionHelpers.h 包含的不必要的 ifdef。

bpo-21983 [https://bugs.python.org/issue?@action=redirect&bpo=21983]: Fix a crash in ctypes.cast() in case the type argument is a ctypes structured data type. Patch by Eryk Sun and Oren Milman.

库

bpo-30167 [https://bugs.python.org/issue?@action=redirect&bpo=30167]: 如果设置了PYTHONSTARTUP，防止site.main()异常。由Steve Weber提供补丁。

bpo-33812 [https://bugs.python.org/issue?@action=redirect&bpo=33812]: 对于tzinfo非None但d.tzinfo.utcoffset(d)返回None的Datetime实例d，现在astimezone()方法将其视为naive。

bpo-30805 [https://bugs.python.org/issue?@action=redirect&bpo=30805]: 避免调试日志记录中的竞态条件

bpo-33767 [https://bugs.python.org/issue?@action=redirect&bpo=33767]: 在 mmap.mmap 对象上执行时，连接（+）和重复（*）序列操作现在会引发 TypeError 而不是 SystemError。由 Zackery Spytz 提供补丁。

bpo-32684 [https://bugs.python.org/issue?@action=redirect&bpo=32684]: 修复 gather 即使在 return_exceptions 的情况下也能传播自身的取消。

bpo-33674 [https://bugs.python.org/issue?@action=redirect&bpo=33674]: 修复 asyncio.sslproto 中 SSLProtocol.connection_made() 的竞态条件：立即开始握手而不是使用 call_soon()。之前，data_received() 可能在握手开始前被调用，导致握手挂起或失败。

bpo-31647 [https://bugs.python.org/issue?@action=redirect&bpo=31647]: 修复了在 _SelectorSocketTransport 已经关闭后调用 write_eof() 会引发 AttributeError 的错误。

bpo-33672 [https://bugs.python.org/issue?@action=redirect&bpo=33672]: 修复 Task.__repr__ 与 Cython 的虚假协程一起使用时崩溃的问题。

bpo-33469 [https://bugs.python.org/issue?@action=redirect&bpo=33469]: 修复了使用 run_in_executor 后关闭循环时引发的 RuntimeError。

bpo-11874 [https://bugs.python.org/issue?@action=redirect&bpo=11874]: 当将用法分解为可包装部分时使用更好的正则表达式。避免来自自定义 metavar 字符串的错误断言错误。

bpo-30877 [https://bugs.python.org/issue?@action=redirect&bpo=30877]: 修复了 JSON 解码器 Python 实现中的一个错误，该错误阻止了在完成解码后清除已解析字符串的缓存。基于 c-fos 的补丁。

bpo-33548 [https://bugs.python.org/issue?@action=redirect&bpo=33548]: tempfile._candidate_tempdir_list 应考虑常见的 TEMP 位置

bpo-33542 [https://bugs.python.org/issue?@action=redirect&bpo=33542]: 防止 uuid.get_node 在 Windows 上使用 DUID 而不是 MAC。由 Zvi Effron 提供补丁

bpo-26819 [https://bugs.python.org/issue?@action=redirect&bpo=26819]: Fix race condition with ReadTransport.resume_reading in Windows proactor event loop.

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing模块中的小修复：向 NamedTuple.__new__ 添加注解，在``Generic.__new__``中传递 *args 和 **kwds。原始PR由Paulius Šarka和Chad Dombrova提供。

bpo-20087 [https://bugs.python.org/issue?@action=redirect&bpo=20087]: 更新了支持glibc 2.27地区设置的别名映射。

bpo-33422 [https://bugs.python.org/issue?@action=redirect&bpo=33422]: 修复在pydoc上查找字节/字符串字面量时尾随引号被删除的问题。由Andrés Delfino提供补丁。

bpo-33197 [https://bugs.python.org/issue?@action=redirect&bpo=33197]: Update error message when constructing invalid inspect.Parameters Patch by Dong-hee Na.

bpo-33383 [https://bugs.python.org/issue?@action=redirect&bpo=33383]: 修复了当使用单个参数调用 dbm.ndbm 数据库对象的get()方法时崩溃的问题。

bpo-33329 [https://bugs.python.org/issue?@action=redirect&bpo=33329]: 修复了在新版 glibc 上的多进程回归问题。

bpo-991266 [https://bugs.python.org/issue?@action=redirect&bpo=991266]: 修复了 http.cookies.SimpleCookie 的 Comment 属性的引用问题。

bpo-33131 [https://bugs.python.org/issue?@action=redirect&bpo=33131]: 将捆绑的 pip 版本升级至 10.0.1。

bpo-33308 [https://bugs.python.org/issue?@action=redirect&bpo=33308]: 修复了 parser 模块在将 ST 对象转换为元组或列表树时，当 line_info=False 且 col_info=True 时的崩溃问题。

bpo-33263 [https://bugs.python.org/issue?@action=redirect&bpo=33263]: Fix FD leak in _SelectorSocketTransport Patch by Vlad Starostin.

bpo-33256 [https://bugs.python.org/issue?@action=redirect&bpo=33256]: 修复了 cgitb.html() 生成的 html 中 <module> 调用的显示问题。补丁由 Stéphane Blondon 提供。

bpo-33203 [https://bugs.python.org/issue?@action=redirect&bpo=33203]: random.Random.choice() 现在对于空序列会一致地引发 IndexError，即使是从没有 getrandbits() 实现的子类中调用也是如此。

bpo-33224 [https://bugs.python.org/issue?@action=redirect&bpo=33224]: 为 PEP 479 [https://www.python.org/dev/peps/pep-0479] 更新 difflib.mdiff()。将生成器中未捕获的 StopIteration 转换为 return 语句。

bpo-33209 [https://bugs.python.org/issue?@action=redirect&bpo=33209]: 在 pickle.Pickler.dump() 的 C 实现结束时结束帧。

bpo-32861 [https://bugs.python.org/issue?@action=redirect&bpo=32861]: urllib.robotparser 的 __str__ 表示现在包括通配符条目以及 "Crawl-delay" 和 "Request-rate" 字段。由 Michael Lazar 提供补丁。

bpo-33096 [https://bugs.python.org/issue?@action=redirect&bpo=33096]: 允许 ttk.Treeview.insert 插入具有假布尔值的 iid。注意 iid=0 和 iid=False 会是相同的。由 Garvit Khatri 提供补丁。

bpo-33127 [https://bugs.python.org/issue?@action=redirect&bpo=33127]: ssl模块现在可以编译使用LibreSSL 2.7.1。

bpo-33021 [https://bugs.python.org/issue?@action=redirect&bpo=33021]: 在fstat()调用期间释放GIL，避免在调用mmap.mmap()、os.urandom()和random.seed()时所有线程挂起。由Nir Soffer提供补丁。

bpo-27683 [https://bugs.python.org/issue?@action=redirect&bpo=27683]: 修复 ipaddress 中的一个回归问题，当网络由包含整数掩码且仅剩1位地址的元组构造时，hosts() 的结果为空。

bpo-32844 [https://bugs.python.org/issue?@action=redirect&bpo=32844]: 修复在subprocess中如果另一个低描述符被关闭时，将低描述符（0或1）错误重定向到stderr的问题。

bpo-31908 [https://bugs.python.org/issue?@action=redirect&bpo=31908]: 修复了 trace 模块命令行工具的封面文件输出。之前仅在使用了 --missing 选项时才会发出封面文件。由Michael Selik提供补丁。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: 如果使用嵌套的日志适配器，内部 process() 方法不再被省略。

bpo-16865 [https://bugs.python.org/issue?@action=redirect&bpo=16865]: 在 ctypes 中支持>=2GiB的数组。由Segev Finer提供补丁。

bpo-31238 [https://bugs.python.org/issue?@action=redirect&bpo=31238]: pydoc: 私有 ServerThread 类的 stop() 方法现在会等待 DocServer.serve_until_quit() 完成，然后显式将其 docserver 属性设置为 None 以打破循环引用。

文档

bpo-33503 [https://bugs.python.org/issue?@action=redirect&bpo=33503]: 修复损坏的 pypi 链接

bpo-33421 [https://bugs.python.org/issue?@action=redirect&bpo=33421]: 为 typing.AsyncContextManager 添加缺失的文档。

bpo-33378 [https://bugs.python.org/issue?@action=redirect&bpo=33378]: 为 https://docs.python.org/3/ 添加韩语语言切换器。

bpo-33276 [https://bugs.python.org/issue?@action=redirect&bpo=33276]: 澄清模块上的 __path__ 属性不能是任意值。

bpo-33201 [https://bugs.python.org/issue?@action=redirect&bpo=33201]: 现代化编写 C 扩展类型的文档。

bpo-33195 [https://bugs.python.org/issue?@action=redirect&bpo=33195]: 在 c-api/arg 文档中弃用 Py_UNICODE 的使用。自 Python 3.3 起，Py_UNICODE 相关 API 已被弃用，但文档中遗漏了这一点。

bpo-33126 [https://bugs.python.org/issue?@action=redirect&bpo=33126]: 文档化 PyBuffer_ToContiguous()。

bpo-27212 [https://bugs.python.org/issue?@action=redirect&bpo=27212]: 修改 islice() 函数示例代码的文档说明，使其在起始索引前消耗初始值。

bpo-28247 [https://bugs.python.org/issue?@action=redirect&bpo=28247]: 更新 zipapp 文档，描述如何制作独立应用程序。

bpo-18802 [https://bugs.python.org/issue?@action=redirect&bpo=18802]: ipaddress 的文档更改。由 Jon Foster 和 Berker Peksag 提供补丁。

bpo-27428 [https://bugs.python.org/issue?@action=redirect&bpo=27428]: 更新文档以澄清 WindowsRegistryFinder 实现了 MetaPathFinder。（补丁由 Himanshu Lakhara 提供）

bpo-8243 [https://bugs.python.org/issue?@action=redirect&bpo=8243]: 添加关于 curses.addch 和 curses.addstr 在窗口或 pad 外部写入时的异常行为的注释。

bpo-31432 [https://bugs.python.org/issue?@action=redirect&bpo=31432]: 澄清 ssl.SSLContext.verify_mode 的 CERT_NONE、CERT_OPTIONAL 和 CERT_REQUIRED 标志的含义。

测试

bpo-33655 [https://bugs.python.org/issue?@action=redirect&bpo=33655]: 忽略在可能由于在 ZFS 上运行而导致的 BSD 平台上的 test_posix_fallocate 失败。

bpo-19417 [https://bugs.python.org/issue?@action=redirect&bpo=19417]: 添加 test_bdb.py。

构建

bpo-5755 [https://bugs.python.org/issue?@action=redirect&bpo=5755]: 将 -Wstrict-prototypes 选项从 OPT 移到 CFLAGS_NODIST。此选项在用C++编写扩展模块时会产生烦人的警告。

bpo-33614 [https://bugs.python.org/issue?@action=redirect&bpo=33614]: 确保Windows上稳定ABI的模块定义文件被正确重新生成。

bpo-33522 [https://bugs.python.org/issue?@action=redirect&bpo=33522]: 在https://python.visualstudio.com/cpython上启用Visual Studio Team Services的CI构建。

bpo-33012 [https://bugs.python.org/issue?@action=redirect&bpo=33012]: 为 gcc 8 添加 -Wno-cast-function-type 以静默关于函数类型转换的警告，如在方法定义列表中转换为 PyCFunction 的警告。

bpo-33394 [https://bugs.python.org/issue?@action=redirect&bpo=33394]: 当GNU make在命令行上传递宏时，为扩展模块启用详细构建。

Windows

bpo-33184 [https://bugs.python.org/issue?@action=redirect&bpo=33184]: 将 Windows 安装程序更新到 OpenSSL 1.0.2o。

macOS

bpo-33184 [https://bugs.python.org/issue?@action=redirect&bpo=33184]: 将 macOS 安装程序构建更新为使用 OpenSSL 1.0.2o。

IDLE

bpo-33656 [https://bugs.python.org/issue?@action=redirect&bpo=33656]: 在Windows上，添加API调用表明tk针对DPI进行缩放。在Windows 8.1+或10上，Python二进制文件的DPI兼容性属性未更改，且显示器分辨率大于96 DPI时，这应使文本和线条更清晰。否则应无影响。

bpo-33768 [https://bugs.python.org/issue?@action=redirect&bpo=33768]: 点击上下文行将该行移动到编辑器窗口的顶部。

bpo-33763 [https://bugs.python.org/issue?@action=redirect&bpo=33763]: IDLE：使用只读文本小部件代替标签小部件作为代码上下文。

bpo-33664 [https://bugs.python.org/issue?@action=redirect&bpo=33664]: 按行滚动IDLE编辑器文本。之前，鼠标滚轮和滚动条滑块以固定像素数移动文本，导致编辑器盒顶部出现部分行。此更改也适用于shell和grep输出窗口，但不适用于只读文本视图。

bpo-33679 [https://bugs.python.org/issue?@action=redirect&bpo=33679]: 启用代码上下文的主题特定颜色配置。使用“高亮”选项卡查看内置主题的设置或为自定义主题添加设置。

bpo-33642 [https://bugs.python.org/issue?@action=redirect&bpo=33642]: 为代码上下文显示最多maxlines非空行。如果没有当前上下文，则显示单个空行。

bpo-33628 [https://bugs.python.org/issue?@action=redirect&bpo=33628]: IDLE：清理codecontext.py及其测试。

bpo-33564 [https://bugs.python.org/issue?@action=redirect&bpo=33564]: IDLE的代码上下文现在能识别async作为一个块的开头。

bpo-29706 [https://bugs.python.org/issue?@action=redirect&bpo=29706]: IDLE 现在在 3.6 版本中将 async 和 await 作为关键字着色。它们在 3.7 版本中成为完全的关键字。

bpo-21474 [https://bugs.python.org/issue?@action=redirect&bpo=21474]: 将单词/标识符的定义从ASCII更新为Unicode。在文本和输入框中，这会影响通过双击选择、通过control-left/right左右移动以及通过control-BACKSPACE/DEL左右删除。

bpo-33204 [https://bugs.python.org/issue?@action=redirect&bpo=33204]: IDLE：一致地着色无效的字符串前缀。'u'字符串前缀不能与'r'或'f'配对。从右边开始，尽可能多地着色有效的部分。修订并扩展颜色化器测试。

bpo-32831 [https://bugs.python.org/issue?@action=redirect&bpo=32831]: 为codecontext添加文档字符串和测试。

工具/示例

bpo-33189 [https://bugs.python.org/issue?@action=redirect&bpo=33189]: pygettext.py 现在只识别字面字符串作为文档字符串和可翻译字符串，并拒绝字节字面量和 f-string 表达式。

bpo-31920 [https://bugs.python.org/issue?@action=redirect&bpo=31920]: 修复了 pygettext 脚本中将目录作为参数处理的问题。基于 Oleg Krasnikov 的补丁。

bpo-29673 [https://bugs.python.org/issue?@action=redirect&bpo=29673]: 修复 pystackv 和 pystack gdbinit 宏。

bpo-32885 [https://bugs.python.org/issue?@action=redirect&bpo=32885]: 为 Tools/scripts/pathfix.py 添加 -n 标志以禁用自动备份创建（带有 ~ 后缀的文件）。

bpo-31583 [https://bugs.python.org/issue?@action=redirect&bpo=31583]: 修复 2to3 在使用 --add-suffix 选项但没有 --output-dir 选项时对当前目录中文件的相对路径的处理。

C API

bpo-32374 [https://bugs.python.org/issue?@action=redirect&bpo=32374]: 文档说明多阶段初始化模块的 m_traverse 可以在 m_state=NULL 时调用，并添加健全性检查

Python 3.6.5 正式版

发布日期: 2018-03-28

测试

bpo-32872 [https://bugs.python.org/issue?@action=redirect&bpo=32872]: 避免 regrtest 与命名空间包的兼容性问题。

构建

bpo-33163 [https://bugs.python.org/issue?@action=redirect&bpo=33163]: 将pip升级到9.0.3，setuptools升级到v39.0.1。

Python 3.6.5 rc1

发布日期: 2018-03-13

安全性

bpo-33001 [https://bugs.python.org/issue?@action=redirect&bpo=33001]: Windows 上 os.symlink 防止缓冲区溢出的最小修复。

bpo-32981 [https://bugs.python.org/issue?@action=redirect&bpo=32981]: Regexes in difflib and poplib were vulnerable to catastrophic backtracking. These regexes formed potential DOS vectors (REDOS). They have been refactored. This resolves CVE-2018-1060 and CVE-2018-1061. Patch by Jamie Davis.

核心与内置函数

bpo-33026 [https://bugs.python.org/issue?@action=redirect&bpo=33026]: 通过设置f_lineno修复了跳出“with”块的问题。

bpo-17288 [https://bugs.python.org/issue?@action=redirect&bpo=17288]: 防止从'return'和'exception'跟踪事件跳转。

bpo-32889 [https://bugs.python.org/issue?@action=redirect&bpo=32889]: 更新Valgrind抑制列表，以考虑`Py_ADDRESS_IN_RANG`重命名为`address_in_range`的情况。

bpo-32650 [https://bugs.python.org/issue?@action=redirect&bpo=32650]: Pdb 和其他依赖于 bdb.py 的调试器现在能够正确地单步跳过（next 命令）原生协程。由 Pablo Galindo 提供补丁。

bpo-32685 [https://bugs.python.org/issue?@action=redirect&bpo=32685]: 改进了当 Python 2 形式的 print 语句出现在复合语句的同一行或以分号而非换行符终止时的建议。由 Nitish Chandra 提供补丁。

bpo-32583 [https://bugs.python.org/issue?@action=redirect&bpo=32583]: 修复在使用自定义解码错误处理程序时，内置 Unicode 解码器可能因越界写入错误而崩溃的问题。

bpo-26163 [https://bugs.python.org/issue?@action=redirect&bpo=26163]: 改进了 frozenset() 的哈希函数，当面对包含许多相似值的数据集时，能生成更多不同的哈希值。

bpo-27169 [https://bugs.python.org/issue?@action=redirect&bpo=27169]: __debug__ 常量现在在编译时被优化掉。这也修复了 bpo-22091 [https://bugs.python.org/issue?@action=redirect&bpo=22091]。

bpo-32329 [https://bugs.python.org/issue?@action=redirect&bpo=32329]: 当通过 PYTHONHASHSEED=0 关闭哈希随机化时，sys.flags.hash_randomization 现在被正确设置为 0。

bpo-30416 [https://bugs.python.org/issue?@action=redirect&bpo=30416]: 优化器现在受到保护，不会花费大量时间进行复杂计算和在常量折叠中创建大常量时消耗大量内存。

bpo-18533 [https://bugs.python.org/issue?@action=redirect&bpo=18533]: repr() 在包含其自身的 values() 或 items() 的字典上不再引发 RecursionError；OrderedDict 同理。相反，像其他递归结构一样使用 ...。由 Ben North 提供补丁。

bpo-32028 [https://bugs.python.org/issue?@action=redirect&bpo=32028]: 在为将 Py2 打印语句转换为 Py3 内置打印函数调用生成建议时，现在正确地忽略了前导空白。由 Sanyam Khurana 提供补丁。

bpo-32137 [https://bugs.python.org/issue?@action=redirect&bpo=32137]: 现在，深度嵌套字典的repr会引发RecursionError，而不是因为堆栈溢出而崩溃。

库

bpo-33064 [https://bugs.python.org/issue?@action=redirect&bpo=33064]: lib2to3现在正确支持函数签名中 *args 和 **kwargs 后的尾随逗号。

bpo-31804 [https://bugs.python.org/issue?@action=redirect&bpo=31804]: 避免在标准流在退出时被关闭或为None时，multiprocessing.Process失败。

bpo-33037 [https://bugs.python.org/issue?@action=redirect&bpo=33037]: 在SSL传输关闭后跳过发送/接收数据。

bpo-30353 [https://bugs.python.org/issue?@action=redirect&bpo=30353]: 修复 64 位 Cygwin/MinGW 上结构体的 ctypes 按值传递问题。

bpo-33009 [https://bugs.python.org/issue?@action=redirect&bpo=33009]: 修复inspect.signature()对于单参数partialmethods的处理。

bpo-32969 [https://bugs.python.org/issue?@action=redirect&bpo=32969]: 在zlib中暴露几个缺失的常量并修复相应的文档。

bpo-32713 [https://bugs.python.org/issue?@action=redirect&bpo=32713]: 修复tarfile.itn对超出界限的浮点值的处理。由Joffrey Fuhrer提供补丁。

bpo-30622 [https://bugs.python.org/issue?@action=redirect&bpo=30622]: ssl模块现在能检测到LibreSSL中缺少的NPN支持。

bpo-32922 [https://bugs.python.org/issue?@action=redirect&bpo=32922]: dbm.open()现在使用文件系统编码而不是默认编码对文件名进行编码。

bpo-32859 [https://bugs.python.org/issue?@action=redirect&bpo=32859]: 在 os.dup2 中，不再每次调用时检查 dup3 系统调用是否存在。

bpo-21060 [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"。

bpo-32857 [https://bugs.python.org/issue?@action=redirect&bpo=32857]: 在 tkinter 中，after_cancel(None) 现在会引发 ValueError 异常，而不是取消第一个预定的函数。由Cheryl Sabella提供补丁。

bpo-32852 [https://bugs.python.org/issue?@action=redirect&bpo=32852]: 确保在运行trace时sys.argv保持为列表。

bpo-32841 [https://bugs.python.org/issue?@action=redirect&bpo=32841]: Fixed asyncio.Condition issue which silently ignored cancellation after notifying and cancelling a conditional lock. Patch by Bar Harel.

bpo-31787 [https://bugs.python.org/issue?@action=redirect&bpo=31787]: 修复了多个模块中 __init__() 方法的内存泄漏问题。(由Oren Milman贡献)

bpo-30157 [https://bugs.python.org/issue?@action=redirect&bpo=30157]: 修复了在只有最后一个字段被引用时，csv.Sniffer.sniff() 中猜测引用和分隔符的问题。由Jake Davis提供补丁。

bpo-32394 [https://bugs.python.org/issue?@action=redirect&bpo=32394]: socket: 在运行时移除旧版本 Windows 上的 TCP_FASTOPEN、TCP_KEEPCNT 标志。

bpo-32777 [https://bugs.python.org/issue?@action=redirect&bpo=32777]: 修复了在POSIX系统的子进程中，当标记文件描述符为可继承时，subprocess中一个罕见但潜在的子进程死锁问题。此bug似乎是在3.4版本中引入的。

bpo-32647 [https://bugs.python.org/issue?@action=redirect&bpo=32647]: ctypes模块过去依赖间接链接来使用dlopen。现在，在支持dl的平台上，共享扩展已明确链接到libdl。

bpo-32734 [https://bugs.python.org/issue?@action=redirect&bpo=32734]: 修复了 asyncio.Lock() 的安全问题，该问题允许多次获取和锁定同一个锁，而锁并未释放。由Bar Harel提供补丁。

bpo-32727 [https://bugs.python.org/issue?@action=redirect&bpo=32727]: 不在SMTP信封的发送地址中包含名字字段。由Stéphane Wirtel提供补丁。

bpo-27931 [https://bugs.python.org/issue?@action=redirect&bpo=27931]: 修复当用户名为空引号字符串时的电子邮件地址头解析错误。由Xiang Zhang提供补丁。

bpo-32304 [https://bugs.python.org/issue?@action=redirect&bpo=32304]: distutils的上传命令不再损坏以CR字节结尾的tar文件，并且不再尝试在上传的任何文本字段中将CR转换为CRLF。

bpo-32502 [https://bugs.python.org/issue?@action=redirect&bpo=32502]: 当遇到64位硬件地址时，uuid.uuid1不再抛出异常。

bpo-31848 [https://bugs.python.org/issue?@action=redirect&bpo=31848]: 修复Aifc_read.initfp()中当SSND块未找到时的错误处理。补丁由Zackery Spytz提供。

bpo-32555 [https://bugs.python.org/issue?@action=redirect&bpo=32555]: 在 FreeBSD 和 Solaris 上，os.strerror() 现在总是从当前区域设置编码解码字节字符串，而不是在某些情况下使用 ASCII/替代转义。

bpo-32521 [https://bugs.python.org/issue?@action=redirect&bpo=32521]: nis 模块现在与新的 libnsl 和头文件位置兼容。

bpo-32473 [https://bugs.python.org/issue?@action=redirect&bpo=32473]: 提高 ABCMeta._dump_registry() 输出的可读性

bpo-32521 [https://bugs.python.org/issue?@action=redirect&bpo=32521]: glibc 已移除 Sun RPC。在 nis 模块中使用替代的 libtirpc 头文件和库。

bpo-32228 [https://bugs.python.org/issue?@action=redirect&bpo=32228]: 确保 truncate() 在写入长度超过缓冲区大小后保留文件位置（由 tell() 报告）。

bpo-26133 [https://bugs.python.org/issue?@action=redirect&bpo=26133]: 在解释器关闭时不要在asyncio UNIX事件循环中取消订阅信号。

bpo-32185 [https://bugs.python.org/issue?@action=redirect&bpo=32185]: 在装有OpenSSL 1.0.2+或inet_pton的平台上，SSL模块不再在SNI TLS扩展中发送IP地址。

bpo-32323 [https://bugs.python.org/issue?@action=redirect&bpo=32323]: urllib.parse.urlsplit() does not convert zone-id (scope) to lower case for scoped IPv6 addresses in hostnames now.

bpo-32302 [https://bugs.python.org/issue?@action=redirect&bpo=32302]: 修复了distutils的bdist_wininst对于CRT v142的支持：它二进制兼容于CRT v140。

bpo-32255 [https://bugs.python.org/issue?@action=redirect&bpo=32255]: 现在，当写入CSV文件时，单个空字段总是会被引用。这允许区分空行和由单个空字段组成的行。由Licht Takeuchi提供补丁。

bpo-32277 [https://bugs.python.org/issue?@action=redirect&bpo=32277]: 在不支持 chmod(..., follow_symlinks=False) 的平台上，引发``NotImplementedError``而不是 SystemError。由Anthony Sottile提供补丁。

bpo-32199 [https://bugs.python.org/issue?@action=redirect&bpo=32199]: getnode() ip 获取器现在使用 'ip link' 而不是 'ip link list'。

bpo-27456 [https://bugs.python.org/issue?@action=redirect&bpo=27456]: 确保在 Linux 上设置 TCP_NODELAY。测试由 Victor Stinner 完成。

bpo-31900 [https://bugs.python.org/issue?@action=redirect&bpo=31900]: 现在 locale.localeconv() 函数会临时将 LC_CTYPE 区域设置改为``LC_NUMERIC``区域设置，以解码 decimal_point 和 thousands_sep 字节字符串，如果它们是非ASCII或长度超过1字节，并且 LC_NUMERIC 区域设置与 LC_CTYPE 区域设置不同。这一临时变更会影响其他线程。对于 str.format() 方法，当使用 n 类型格式化数字（int, float, float 及其子类）时（例如：'{:n}'.format(1234)），也进行了相同的更改。

bpo-31802 [https://bugs.python.org/issue?@action=redirect&bpo=31802]: 即使`os`模块尚未导入，导入原生路径模块(posixpath, ntpath)现在也能正常工作。

文档

bpo-17232 [https://bugs.python.org/issue?@action=redirect&bpo=17232]: 澄清 -O 和 -OO 的文档。由 Terry Reedy 提供补丁。

bpo-32800 [https://bugs.python.org/issue?@action=redirect&bpo=32800]: 更新 xml 默认命名空间的 w3c 文档链接。

bpo-8722 [https://bugs.python.org/issue?@action=redirect&bpo=8722]: 文档化当属性 get() 方法引发 AttributeError 时 __getattr__() 的行为。

bpo-32614 [https://bugs.python.org/issue?@action=redirect&bpo=32614]: 修改文档中的正则表达式示例，使用原始字符串以防止 DeprecationWarning，并在正则表达式 HOWTO 中添加文本以突出弃用。

bpo-31972 [https://bugs.python.org/issue?@action=redirect&bpo=31972]: Improve docstrings for pathlib.PurePath subclasses.

bpo-17799 [https://bugs.python.org/issue?@action=redirect&bpo=17799]: 解释了sys.settrace和sys.setprofile及其C-API对应项的实际行为，关于在每个函数中接收哪些类型的事件。由Pablo Galindo Salgado提供补丁。

测试

bpo-32517 [https://bugs.python.org/issue?@action=redirect&bpo=32517]: 修复由于 KqueueSelector 循环的传输未被关闭而在 macOS 10.12.2+ 上失败的 test_asyncio。

bpo-32721 [https://bugs.python.org/issue?@action=redirect&bpo=32721]: 修复test_hashlib，使其在未构建_md5模块时不会失败。

bpo-32252 [https://bugs.python.org/issue?@action=redirect&bpo=32252]: 修复用于在测试崩溃时防止核心转储文件的faulthandler_suppress_crash_report()。getrlimit()在成功时返回零。

bpo-31518 [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上通过。

构建

bpo-32635 [https://bugs.python.org/issue?@action=redirect&bpo=32635]: 修复当系统提供的是 libxcrypt 而不是 libcrypt 时 crypt 模块的段错误。

Windows

bpo-33016 [https://bugs.python.org/issue?@action=redirect&bpo=33016]: 修复nt._getfinalpathname中潜在使用未初始化内存的问题。

bpo-32903 [https://bugs.python.org/issue?@action=redirect&bpo=32903]: 修复如果当前目录设置为UNC路径时Windows上os.chdir()的内存泄漏。

bpo-31966 [https://bugs.python.org/issue?@action=redirect&bpo=31966]: 修复WindowsConsoleIO.write()写入空数据的问题。

bpo-32409 [https://bugs.python.org/issue?@action=redirect&bpo=32409]: 确保activate.bat可以处理Unicode内容。

bpo-32457 [https://bugs.python.org/issue?@action=redirect&bpo=32457]: 改进启动Python时对非规范化可执行路径的处理。

bpo-32370 [https://bugs.python.org/issue?@action=redirect&bpo=32370]: 在uuid模块中为ipconfig输出使用正确的编码。由Segev Finer提交补丁。

bpo-29248 [https://bugs.python.org/issue?@action=redirect&bpo=29248]: 修复Windows上的 os.readlink()，它错误地将重新解析数据缓冲区的``PrintNameOffset`` 字段视为字符数而非字节数。由Craig Holmquist和SSE4提交补丁。

bpo-32588 [https://bugs.python.org/issue?@action=redirect&bpo=32588]: 创建独立的_distutils_findvs模块。

macOS

bpo-32726 [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副本。

IDLE

bpo-32984 [https://bugs.python.org/issue?@action=redirect&bpo=32984]: 在运行启动文件时设置 __file__。与Python一样，IDLE在展示第一个交互式输入提示之前，可选地在Shell窗口中运行一个启动文件。对于IDLE，-s``运行环境变量 :envvar:`IDLESTARTUP` 或 :envvar:`PYTHONSTARTUP` 中命名的文件；-r file`` 运行 file。Python在运行文件之前将 __file__ 设置为启动文件名，并在第一个提示之前取消设置。IDLE现在在没有 -n 选项的情况下正常运行时也会这样做。

bpo-32940 [https://bugs.python.org/issue?@action=redirect&bpo=32940]: 在pyparse中简化并重命名StringTranslatePseudoMapping。

bpo-32916 [https://bugs.python.org/issue?@action=redirect&bpo=32916]: 在pyparse中将 str 更改为 code。

bpo-32905 [https://bugs.python.org/issue?@action=redirect&bpo=32905]: 移除pyparse模块中未使用的代码。

bpo-32874 [https://bugs.python.org/issue?@action=redirect&bpo=32874]: 为pyparse添加测试。

bpo-32837 [https://bugs.python.org/issue?@action=redirect&bpo=32837]: 对于IDLE的系统和位置无关文件，使用系统和位置相关的默认编码对于open()来说是一个坏主意。

bpo-32826 [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字符。

bpo-32765 [https://bugs.python.org/issue?@action=redirect&bpo=32765]: 更新configdialog General标签的文档字符串，将新部件添加到部件列表中。

工具/示例

bpo-24960 [https://bugs.python.org/issue?@action=redirect&bpo=24960]: 2to3和lib2to3现在可以使用pkgutil.get_data()读取pickled语法文件，而不是探测文件系统。这使得2to3和lib2to3在从zipfile运行时也能工作。

bpo-32222 [https://bugs.python.org/issue?@action=redirect&bpo=32222]: 修复 pygettext 不提取带有类型注释参数的函数的文档字符串的问题。由 Toby Harradine 提供的补丁。

C API

bpo-29084 [https://bugs.python.org/issue?@action=redirect&bpo=29084]: OrderedDict的未记录C API已从有限C API中排除。它是被错误添加的，实际上在有限C API中从未工作过。

Python 3.6.4 正式版

发布日期: 2017-12-18

从 3.6.4 rc1 到 3.6.4 正式版中没有新的代码更改。

Python 3.6.4 rc1

发布日期: 2017-12-05

核心与内置函数

bpo-32176 [https://bugs.python.org/issue?@action=redirect&bpo=32176]: 现在，代码对象构造函数会根据freevars和cellvars正确设置co_flags.CO_NOFREE，而不是需要调用者正确设置。这确保了当额外的cell引用被注入到修改后的代码对象和函数中时，它会自动清除。

bpo-31949 [https://bugs.python.org/issue?@action=redirect&bpo=31949]: 修复了打印回溯（PyTraceBack_Print()）中的若干问题。现在将sys.tracebacklimit设置为0或更小会抑制回溯的打印。将sys.tracebacklimit设置为None现在会导致使用默认限制。将sys.tracebacklimit设置为大于LONG_MAX的整数现在意味着使用LONG_MAX限制而不是默认限制。修复了Windows上超过 2**31 个回溯项时的整数溢出问题。修复了输出错误处理。

bpo-30696 [https://bugs.python.org/issue?@action=redirect&bpo=30696]: 修复了在没有内存时交互式解释器无限循环的问题。

bpo-20047 [https://bugs.python.org/issue?@action=redirect&bpo=20047]: Bytearray方法partition()和rpartition()现在仅接受类似字节的对象作为分隔符，如文档所述。特别是，现在当传递整数作为分隔符时，它们会引发TypeError而不是返回一个虚假的结果。

bpo-31852 [https://bugs.python.org/issue?@action=redirect&bpo=31852]: 修复由async软关键字和续行组合引起的段错误。

bpo-21720 [https://bugs.python.org/issue?@action=redirect&bpo=21720]: 当 __import__() 的 fromlist 参数或模块的 __all__ 属性包含bytes实例时，不再发出BytesWarning。

bpo-31825 [https://bugs.python.org/issue?@action=redirect&bpo=31825]: 修复了在解码转义的非ascii字节时'unicode-escape'编解码器和codecs.escape_decode()中的OverflowError。

bpo-28603 [https://bugs.python.org/issue?@action=redirect&bpo=28603]: 在解释器退出时打印异常的完整上下文/原因链，即使链中的异常不可哈希或与后面的异常相等。由Zane Bitter提供补丁。

bpo-31786 [https://bugs.python.org/issue?@action=redirect&bpo=31786]: 修复 select 模块中负超时时间在 -1.0 和 0.0 之间的正确舍入问题。现在函数会按预期阻塞等待事件。此前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

bpo-31642 [https://bugs.python.org/issue?@action=redirect&bpo=31642]: 通过将sys.modules["package.module"]设置为None，恢复了阻塞的"from package import module"。

bpo-31626 [https://bugs.python.org/issue?@action=redirect&bpo=31626]: 修复了调试内存分配器中的一个错误。在缩小内存块后存在对已释放内存的写入。

bpo-31619 [https://bugs.python.org/issue?@action=redirect&bpo=31619]: 修复了将带有大量下划线的字符串转换为二进制基数整数时的ValueError。

bpo-31592 [https://bugs.python.org/issue?@action=redirect&bpo=31592]: Fixed an assertion failure in Python parser in case of a bad unicodedata.normalize(). Patch by Oren Milman.

bpo-31588 [https://bugs.python.org/issue?@action=redirect&bpo=31588]: Raise a TypeError with a helpful error message when class creation fails due to a metaclass with a bad __prepare__() method. Patch by Oren Milman.

bpo-31566 [https://bugs.python.org/issue?@action=redirect&bpo=31566]: Fix an assertion failure in _warnings.warn() in case of a bad __name__ global. Patch by Oren Milman.

bpo-31505 [https://bugs.python.org/issue?@action=redirect&bpo=31505]: Fix an assertion failure in json, in case _json.make_encoder() received a bad encoder() argument. Patch by Oren Milman.

bpo-31492 [https://bugs.python.org/issue?@action=redirect&bpo=31492]: 修复了在从具有错误 __name__ 属性的模块导入失败时，以及在访问此类模块的属性失败时的断言失败。由Oren Milman提供补丁。

bpo-31490 [https://bugs.python.org/issue?@action=redirect&bpo=31490]: Fix an assertion failure in ctypes class definition, in case the class has an attribute whose name is specified in _anonymous_ but not in _fields_. Patch by Oren Milman.

bpo-31478 [https://bugs.python.org/issue?@action=redirect&bpo=31478]: Fix an assertion failure in _random.Random.seed() in case the argument has a bad __abs__() method. Patch by Oren Milman.

bpo-31315 [https://bugs.python.org/issue?@action=redirect&bpo=31315]: 修复 imp.create_dynamic() 中当 spec.name 不是字符串时的断言失败。由 Oren Milman 提供补丁。

bpo-31311 [https://bugs.python.org/issue?@action=redirect&bpo=31311]: Fix a crash in the __setstate__() method of ctypes._CData, in case of a bad __dict__. Patch by Oren Milman.

bpo-31293 [https://bugs.python.org/issue?@action=redirect&bpo=31293]: 修复 timedelta 对象与具有坏的 as_integer_ratio() 方法的浮点数进行真除法和乘法时的崩溃。由 Oren Milman 提供补丁。

bpo-31285 [https://bugs.python.org/issue?@action=redirect&bpo=31285]: Fix an assertion failure in warnings.warn_explicit, when the return value of the received loader's get_source() has a bad splitlines() method. Patch by Oren Milman.

bpo-30817 [https://bugs.python.org/issue?@action=redirect&bpo=30817]: PyErr_PrintEx() clears now the ignored exception that may be raised by _PySys_SetObjectId(), for example when no memory.

库

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块的两项小修复：允许浅复制泛型类的实例，改进 __init_subclass__ 与泛型的交互。原始 PR 由 Ivan Levkivskyi 提供。

bpo-27240 [https://bugs.python.org/issue?@action=redirect&bpo=27240]: 新电子邮件策略的头部折叠算法已被重写，这也修复了 bpo-30788 [https://bugs.python.org/issue?@action=redirect&bpo=30788]、bpo-31831 [https://bugs.python.org/issue?@action=redirect&bpo=31831] 和 bpo-32182 [https://bugs.python.org/issue?@action=redirect&bpo=32182]。特别是，现在可以正确进行 RFC2231 折叠。

bpo-32186 [https://bugs.python.org/issue?@action=redirect&bpo=32186]: io.FileIO.readall() 和 io.FileIO.read() 现在在获取文件大小时释放 GIL。修复了所有线程因无法访问的 NFS 服务器而挂起的问题。由 Nir Soffer 提供补丁。

bpo-12239 [https://bugs.python.org/issue?@action=redirect&bpo=12239]: Make msilib.SummaryInformation.GetProperty() return None when the value of property is VT_EMPTY. Initial patch by Mark Mc Mahon.

bpo-31325 [https://bugs.python.org/issue?@action=redirect&bpo=31325]: 修复了 RobotFileParser.parse() 方法中 collections.namedtuple() 的错误用法。初始由 Robin Wellner 提供补丁。

bpo-12382 [https://bugs.python.org/issue?@action=redirect&bpo=12382]: msilib.OpenDatabase() now raises a better exception message when it couldn't open or create an MSI file. Initial patch by William Tisäter.

bpo-32110 [https://bugs.python.org/issue?@action=redirect&bpo=32110]: codecs.StreamReader.read(n) 现在对于非负的 n，返回不超过 n 个字符/字节。这使得它与其他类似文件对象的 read() 方法兼容。

bpo-32072 [https://bugs.python.org/issue?@action=redirect&bpo=32072]: 修复了二进制 plists 的问题：修复了保存 bytearrays。相同的对象将只保存一次。相等的引用将作为相同的对象加载。添加了对保存和加载递归数据结构的支持。

bpo-32034 [https://bugs.python.org/issue?@action=redirect&bpo=32034]: 使asyncio.IncompleteReadError和LimitOverrunError可pickle。

bpo-32015 [https://bugs.python.org/issue?@action=redirect&bpo=32015]: 修复了在等待异步读写套接字期间重新连接套接字时asyncio的循环问题。

bpo-32011 [https://bugs.python.org/issue?@action=redirect&bpo=32011]: 恢复了对加载带有TYPE_INT64代码的marshal文件的支持。这些文件可以在Python 2.7中生成。

bpo-31970 [https://bugs.python.org/issue?@action=redirect&bpo=31970]: 降低asyncio调试模式的性能开销。

bpo-9678 [https://bugs.python.org/issue?@action=redirect&bpo=9678]: 修复了uuid模块中确定MAC地址的问题：在NetBSD和OpenBSD上使用ifconfig。在Linux、FreeBSD、NetBSD和OpenBSD上使用arp。基于Takayuki Shimizukawa的补丁。

bpo-30057 [https://bugs.python.org/issue?@action=redirect&bpo=30057]: 修复了signal.signal()中潜在的信号丢失问题。

bpo-31933 [https://bugs.python.org/issue?@action=redirect&bpo=31933]: 修复Blake2参数leaf_size和node_offset在大端平台上的问题。由Jack O'Connor提供补丁。

bpo-31927 [https://bugs.python.org/issue?@action=redirect&bpo=31927]: 修复了socket模块在NetBSD 8上的编译问题。修复了在NetBSD和DragonFly BSD上解析AF_BLUETOOTH地址时的断言失败或读取任意数据的问题。

bpo-27666 [https://bugs.python.org/issue?@action=redirect&bpo=27666]: 修复了当类型chtype或mmask_t的大小小于C long的大小时，curses.box()和curses.ungetmouse()中的堆栈损坏问题。curses.box()现在接受字符作为参数。基于Steve Fink的补丁。

bpo-31897 [https://bugs.python.org/issue?@action=redirect&bpo=31897]: plistlib现在在读取二进制plist时会捕获更多错误，并抛出InvalidFileException而不是意外的异常。

bpo-25720 [https://bugs.python.org/issue?@action=redirect&bpo=25720]: 修复了检查curses WINDOW填充状态的方法。由Masayuki Yamamoto提供补丁。

bpo-31893 [https://bugs.python.org/issue?@action=redirect&bpo=31893]: 修复了OpenBSD和NetBSD上kqueue_event结构的布局。修复了kqueue_event对象的比较。

bpo-31891 [https://bugs.python.org/issue?@action=redirect&bpo=31891]: 修复了在NetBSD上构建curses模块的问题。

bpo-28416 [https://bugs.python.org/issue?@action=redirect&bpo=28416]: 具有 persistent_id() 方法的 pickle.Pickler 子类和具有 persistent_load() 方法的 pickle.Unpickler 子类的实例不再创建引用循环。

bpo-28326 [https://bugs.python.org/issue?@action=redirect&bpo=28326]: 修复当 stdout 和/或 stderr 关闭或为 None 时的 multiprocessing.Process。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: 如果使用嵌套的日志适配器，内部 process() 方法不再被省略。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: LoggerAdapter 对象的 manager 属性现在可以正确设置了。

bpo-31806 [https://bugs.python.org/issue?@action=redirect&bpo=31806]: 修复 time.sleep(), threading.Lock.acquire() 和 socket.socket.settimeout() 中的超时舍入，以正确舍入 -1.0 和 0.0 之间的负超时。这些函数现在会按预期阻塞等待事件。之前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

bpo-28603 [https://bugs.python.org/issue?@action=redirect&bpo=28603]: traceback: 修复了在打印异常回溯时，当当前异常或其上下文/原因链中的异常不可哈希时发生的 TypeError。由 Zane Bitter 提供补丁。

bpo-30058 [https://bugs.python.org/issue?@action=redirect&bpo=30058]: 修复 select.kqueue.control() 中的缓冲区溢出。

bpo-31770 [https://bugs.python.org/issue?@action=redirect&bpo=31770]: 防止多次调用 sqlite3.Cursor 对象的 __init__() 方法时崩溃。由 Oren Milman 提供补丁。

bpo-31672 [https://bugs.python.org/issue?@action=redirect&bpo=31672]: string.Template 中的 idpattern 匹配了一些非ASCII字符。现在它使用 -i 正则表达式本地标志来避免非ASCII字符。

bpo-31764 [https://bugs.python.org/issue?@action=redirect&bpo=31764]: 防止在 sqlite3.Cursor.close() 中当 Cursor 对象未初始化时发生崩溃。补丁由 Oren Milman 提供。

bpo-31752 [https://bugs.python.org/issue?@action=redirect&bpo=31752]: 修复在调用自定义整数的 timedelta 构造函数时可能发生的崩溃。

bpo-31701 [https://bugs.python.org/issue?@action=redirect&bpo=31701]: 在Windows上，faulthandler.enable()现在会忽略MSC和COM异常。

bpo-31728 [https://bugs.python.org/issue?@action=redirect&bpo=31728]: Prevent crashes in _elementtree due to unsafe cleanup of Element.text and Element.tail. Patch by Oren Milman.

bpo-31620 [https://bugs.python.org/issue?@action=redirect&bpo=31620]: 空的 asyncio.Queue 现在在队列获取轮询超时时不会泄漏内存。

bpo-31632 [https://bugs.python.org/issue?@action=redirect&bpo=31632]: 修复 asyncio 模块中 _SSLProtocolTransport 类的 set_protocol() 方法。此方法之前修改了错误的协议引用。

bpo-31675 [https://bugs.python.org/issue?@action=redirect&bpo=31675]: 修复了Tkinter的splitlist()和split()方法在传递大于2 GiB的字符串时的内存泄漏问题。

bpo-31673 [https://bugs.python.org/issue?@action=redirect&bpo=31673]: 修复了Tkinter方法adderrorinfo()名称中的拼写错误。

bpo-30806 [https://bugs.python.org/issue?@action=redirect&bpo=30806]: 修复了netrc对象的字符串表示。

bpo-15037 [https://bugs.python.org/issue?@action=redirect&bpo=15037]: 为 ncurses 5.7 及更早版本的 curses 中的 getkey() 添加了一个变通方案。

bpo-25351 [https://bugs.python.org/issue?@action=redirect&bpo=25351]: 避免venv激活时因未定义变量而失败。

bpo-25532 [https://bugs.python.org/issue?@action=redirect&bpo=25532]: inspect.unwrap()现在只会尝试解包对象sys.getrecursionlimit()次，以防止在每次属性访问时创建新对象的对象。

bpo-30347 [https://bugs.python.org/issue?@action=redirect&bpo=30347]: 修复了在并发迭代itertools.groupby()迭代器时的崩溃问题。

bpo-31516 [https://bugs.python.org/issue?@action=redirect&bpo=31516]: threading.current_thread() 在关闭时不应返回一个虚拟线程。

bpo-31351 [https://bugs.python.org/issue?@action=redirect&bpo=31351]: 如果 pip 引导失败，python -m ensurepip 现在会以非零退出代码退出。

bpo-31482 [https://bugs.python.org/issue?@action=redirect&bpo=31482]: random.seed() 现在在version=1时可以与bytes一起工作。

bpo-31334 [https://bugs.python.org/issue?@action=redirect&bpo=31334]: 修复 select 模块中的 poll.poll([timeout])，在所有操作系统上对于任意的负超时值，现在可以仅接受非负整数或 -1。由 Riccardo Coccioli 提供补丁。

bpo-31310 [https://bugs.python.org/issue?@action=redirect&bpo=31310]: 如果崩溃，multiprocessing 的信号量跟踪器应该重新启动。

bpo-31308 [https://bugs.python.org/issue?@action=redirect&bpo=31308]: 使 multiprocessing 的 forkserver 进程免受 Ctrl-C 和其他用户中断的影响。如果崩溃，必要时重启它。

文档

bpo-32105 [https://bugs.python.org/issue?@action=redirect&bpo=32105]: 添加了 asyncio.BaseEventLoop.connect_accepted_socket 的 versionadded 标记。

bpo-31537 [https://bugs.python.org/issue?@action=redirect&bpo=31537]: 修复了 readline 文档示例代码中 get_history_length 的不正确用法。补丁由 Brad Smith 提供。

bpo-30085 [https://bugs.python.org/issue?@action=redirect&bpo=30085]: 为了清晰起见，优先使用没有双下划线的操作符函数。带有下划线的仅为了向后兼容而保留。

测试

bpo-31380 [https://bugs.python.org/issue?@action=redirect&bpo=31380]: 在 macOS 上跳过 test_httpservers 的 test_undecodable_file 测试：在 APFS 上失败。

bpo-31705 [https://bugs.python.org/issue?@action=redirect&bpo=31705]: 在早于4.5版本的Linux内核上跳过test_socket.test_sha256()测试。该测试在内核3.10（ppc64le架构）上会因ENOKEY而失败。此问题已在4.5内核中修复。

bpo-31174 [https://bugs.python.org/issue?@action=redirect&bpo=31174]: 修复test_tools.test_unparse：DirectoryTestCase现在存储样本名称以始终测试相同的文件。这避免了在查找引用泄漏时产生误报。

bpo-30695 [https://bugs.python.org/issue?@action=redirect&bpo=30695]: Add the set_nomemory(start, stop) and remove_mem_hooks() functions to the _testcapi module.

构建

bpo-32059 [https://bugs.python.org/issue?@action=redirect&bpo=32059]: setup.py 中的 detect_modules() 现在在交叉编译时也会搜索sysroot路径。

bpo-31957 [https://bugs.python.org/issue?@action=redirect&bpo=31957]: 修复为Windows构建时的Windows SDK版本检测。

bpo-31609 [https://bugs.python.org/issue?@action=redirect&bpo=31609]: 修复PCbuild/clean.bat中的引号问题。

bpo-31934 [https://bugs.python.org/issue?@action=redirect&bpo=31934]: 当构建源树不干净时中止构建。

bpo-31926 [https://bugs.python.org/issue?@action=redirect&bpo=31926]: 修复了当.c文件中有多个同名函数和/或方法时，Argument Clinic有时会导致编译错误的问题。

bpo-28791 [https://bugs.python.org/issue?@action=redirect&bpo=28791]: 更新Windows构建以使用SQLite 3.21.0。

bpo-28791 [https://bugs.python.org/issue?@action=redirect&bpo=28791]: 更新OS X安装程序以使用SQLite 3.21.0。

bpo-22140 [https://bugs.python.org/issue?@action=redirect&bpo=22140]: 防止在 python-config.sh 中双重替换前缀。

bpo-31536 [https://bugs.python.org/issue?@action=redirect&bpo=31536]: Avoid wholesale rebuild after make regen-all if nothing changed.

Windows

bpo-1102 [https://bugs.python.org/issue?@action=redirect&bpo=1102]: 当 View.Fetch() 返回 ERROR_NO_MORE_ITEMS 时返回 None，而不是引发``MSIError``。初始由Anthony Tuininga提供补丁。

bpo-31944 [https://bugs.python.org/issue?@action=redirect&bpo=31944]: 修复应用和功能对话框中的修改按钮。

macOS

bpo-31392 [https://bugs.python.org/issue?@action=redirect&bpo=31392]: 更新macOS安装程序以使用OpenSSL 1.0.2m。

IDLE

bpo-32207 [https://bugs.python.org/issue?@action=redirect&bpo=32207]: 在IDLE中改进tk事件异常回溯。当tk事件处理由IDLE的运行循环驱动时，不再向tk事件异常回溯中添加令人困惑和分散注意力的queue.EMPTY回溯上下文。现在，回溯与事件处理由用户代码驱动时相同。基于Serhiy Storchaka的建议的补丁。

bpo-32164 [https://bugs.python.org/issue?@action=redirect&bpo=32164]: 删除未使用的文件idlelib/tabbedpages.py。在configdialog中使用TabbedPageSet已被ttk.Notebook替代。

bpo-32100 [https://bugs.python.org/issue?@action=redirect&bpo=32100]: IDLE: 修复pathbrowser中的旧错误和新错误；改进测试。补丁主要由Cheryl Sabella提供。

bpo-31858 [https://bugs.python.org/issue?@action=redirect&bpo=31858]: IDLE -- 将shell提示符操作限制在shell中。编辑器和输出窗口仅看到一个空的最后提示行。这简化了代码并修复了插入换行时的一个小错误。如果存在Sys.ps1，则在Shell启动时读取，但不设置或更改。

bpo-31860 [https://bugs.python.org/issue?@action=redirect&bpo=31860]: IDLE配置对话框中的字体样本现在可编辑。更改在IDLE保持打开时持续存在。

bpo-31836 [https://bugs.python.org/issue?@action=redirect&bpo=31836]: 现在如果在设置ps1的test_idle之后运行，Test_code_module将通过。代码模块如果存在则使用sys.ps1，如果不存在则设置为'>>> '。Test_code_module现在正确测试了这两种行为。ps2同理。

bpo-28603 [https://bugs.python.org/issue?@action=redirect&bpo=28603]: 修复了一个TypeError，该错误在打印包含不可哈希异常的追溯时导致shell重启。补丁由Zane Bitter提供。

bpo-13802 [https://bugs.python.org/issue?@action=redirect&bpo=13802]: 在IDLE的字体设置样本中使用非拉丁字符。即使选择定义Unicode基本多语言平面有限子集的字体，tcl/tk也会使用定义字符的其他字体。扩展的示例为非拉丁字符用户提供了更好的了解他们在IDLE的shell和编辑器中可能会看到的内容。为了给扩展的样本腾出空间，字体标签上的框架被重新排列。字体/标签帮助解释了关于添加的一些内容。

bpo-31460 [https://bugs.python.org/issue?@action=redirect&bpo=31460]: 简化IDLE模块浏览器的API。传递一个小部件而不是带有根部件的flist，开启了创建一个仅是窗口一部分的浏览器框架的可能性。传递一个完整的文件名而不是假定来自.py文件的片段，开启了浏览不以.py结尾的python文件的可能性。

bpo-31649 [https://bugs.python.org/issue?@action=redirect&bpo=31649]: IDLE - 使_htest, _utest参数仅关键字。

bpo-31559 [https://bugs.python.org/issue?@action=redirect&bpo=31559]: 在idle_test.test_browser中移除测试顺序依赖。

bpo-31459 [https://bugs.python.org/issue?@action=redirect&bpo=31459]: 将IDLE的模块浏览器从类浏览器重命名为模块浏览器。原始的模块级类和方法浏览器多年前就变成了一个模块浏览器，增加了模块级函数。昨天又增加了嵌套类和函数。为了向后兼容，设置对话框的键标签上出现的虚拟事件<<open-class-browser>>没有被更改。补丁由Cheryl Sabella提供。

bpo-31500 [https://bugs.python.org/issue?@action=redirect&bpo=31500]: 现在默认字体在高DPI显示器上会进行缩放。

bpo-1612262 [https://bugs.python.org/issue?@action=redirect&bpo=1612262]: IDLE模块浏览器现在显示嵌套类和函数。代码和测试的原始补丁分别由Guilherme Polo和Cheryl Sabella提供。

工具/示例

bpo-30722 [https://bugs.python.org/issue?@action=redirect&bpo=30722]: 使redemo能够在Python 3.6及更新版本中工作。同时，移除 LOCALE 选项，因为它不适用于Python 3中的字符串模式。由Christoph Sarnowski提供补丁。

C API

bpo-20891 [https://bugs.python.org/issue?@action=redirect&bpo=20891]: 修复PyGILState_Ensure()。当PyGILState_Ensure()在非Python线程中且在PyEval_InitThreads()之前被调用时，仅在调用PyThreadState_New()之后调用PyEval_InitThreads()，以修复崩溃问题。

bpo-31532 [https://bugs.python.org/issue?@action=redirect&bpo=31532]: 修复由于在getpath.c中Py_GetPath()和Py_SetPath()之间的分配器混合导致的内存损坏。

bpo-30697 [https://bugs.python.org/issue?@action=redirect&bpo=30697]: The PyExc_RecursionErrorInst singleton is removed and PyErr_NormalizeException() does not use it anymore. This singleton is persistent and its members being never cleared may cause a segfault during finalization of the interpreter. See also bpo-22898 [https://bugs.python.org/issue?@action=redirect&bpo=22898].

Python 3.6.3 正式版

发布日期: 2017-10-03

库

bpo-31641 [https://bugs.python.org/issue?@action=redirect&bpo=31641]: Re-allow arbitrary iterables in concurrent.futures.as_completed(). Fixes regression in 3.6.3rc1.

构建

bpo-31662 [https://bugs.python.org/issue?@action=redirect&bpo=31662]: 修复Windows uploadrelease.bat 脚本中的拼写错误。修复 Doc/make.bat 中的Windows文档构建问题。

bpo-31423 [https://bugs.python.org/issue?@action=redirect&bpo=31423]: 修复使用新版本Sphinx构建PDF文档的问题。

Python 3.6.3 rc1

发布日期: 2017-09-18

安全性

bpo-29781 [https://bugs.python.org/issue?@action=redirect&bpo=29781]: 当尚未通过 BIO 执行握手时，SSLObject.version() 现在正确返回 None。

bpo-30947 [https://bugs.python.org/issue?@action=redirect&bpo=30947]: 将内嵌的 libexpat 从版本 2.2.1 升级到 2.2.3 以获取安全修复。

核心与内置函数

bpo-31471 [https://bugs.python.org/issue?@action=redirect&bpo=31471]: Fix an assertion failure in subprocess.Popen() on Windows, in case the env argument has a bad keys() method. Patch by Oren Milman.

bpo-31418 [https://bugs.python.org/issue?@action=redirect&bpo=31418]: Fix an assertion failure in PyErr_WriteUnraisable() in case of an exception with a bad __module__ attribute. Patch by Oren Milman.

bpo-31416 [https://bugs.python.org/issue?@action=redirect&bpo=31416]: 修复当warnings.filters或warnings.defaultaction错误时的断言失败。由Oren Milman提供补丁。

bpo-31411 [https://bugs.python.org/issue?@action=redirect&bpo=31411]: 当warnings.onceregistry不是字典时，抛出TypeError而不是SystemError。由Oren Milman提供补丁。

bpo-31373 [https://bugs.python.org/issue?@action=redirect&bpo=31373]: 修复了几个由于浮点降级可能导致的未定义行为实例。

bpo-30465 [https://bugs.python.org/issue?@action=redirect&bpo=30465]: f-字符串中的位置信息（lineno``和 ``col_offset）现在（大部分）正确。这修复了像flake8这样的工具在错误行（通常是文件的第一行）显示警告的问题。

bpo-31343 [https://bugs.python.org/issue?@action=redirect&bpo=31343]: Include sys/sysmacros.h for major(), minor(), and makedev(). GNU C libray plans to remove the functions from sys/types.h.

bpo-31291 [https://bugs.python.org/issue?@action=redirect&bpo=31291]: Fix an assertion failure in zipimport.zipimporter.get_data on Windows, when the return value of pathname.replace('/','\\') isn't a string. Patch by Oren Milman.

bpo-31271 [https://bugs.python.org/issue?@action=redirect&bpo=31271]: Fix an assertion failure in the write() method of io.TextIOWrapper, when the encoder doesn't return a bytes object. Patch by Oren Milman.

bpo-31243 [https://bugs.python.org/issue?@action=redirect&bpo=31243]: Fix a crash in some methods of io.TextIOWrapper, when the decoder's state is invalid. Patch by Oren Milman.

bpo-30721 [https://bugs.python.org/issue?@action=redirect&bpo=30721]: print 现在显示使用Python 2重定向语法的正确用法提示。由Sanyam Khurana提供补丁。

bpo-31070 [https://bugs.python.org/issue?@action=redirect&bpo=31070]: 修复importlib中_get_module_lock()的竞态条件。

bpo-31095 [https://bugs.python.org/issue?@action=redirect&bpo=31095]: 修复由未调用 PyObject_GC_UnTrack() 的 tp_dealloc 引起的GC期间潜在崩溃问题。

bpo-31071 [https://bugs.python.org/issue?@action=redirect&bpo=31071]: 当传递其他参数时，避免在使用*解包调用中掩盖原始TypeError。

bpo-30978 [https://bugs.python.org/issue?@action=redirect&bpo=30978]: str.format_map()现在传递键查找异常。之前任何异常都被替换为KeyError异常。

bpo-30808 [https://bugs.python.org/issue?@action=redirect&bpo=30808]: 对并发敏感的信号状态使用_Py_atomic API。

bpo-30876 [https://bugs.python.org/issue?@action=redirect&bpo=30876]: 从未加载的包中进行相对导入现在会重新导入包，而不是因SystemError失败。从非包中进行相对导入现在会因ImportError而非SystemError失败。

bpo-30703 [https://bugs.python.org/issue?@action=redirect&bpo=30703]: 改进信号传递。避免在信号处理程序中使用Py_AddPendingCall，以避免调用信号不安全函数。这里添加的测试在没有补丁的其他部分的情况下，在Linux和OS X上失败。这意味着我们的信号传递逻辑存在缺陷（某些信号可能会丢失）。

bpo-30765 [https://bugs.python.org/issue?@action=redirect&bpo=30765]: 当PyThread_acquire_lock()被要求不阻塞时，避免在pthread_mutex_lock()中阻塞。

bpo-31161 [https://bugs.python.org/issue?@action=redirect&bpo=31161]: 确保'Missing parentheses'语法错误消息仅应用于SyntaxError，而不是子类。补丁由Martijn Pieters提供。

bpo-30814 [https://bugs.python.org/issue?@action=redirect&bpo=30814]: 修复从包中导入子模块时的竞态条件。

bpo-30597 [https://bugs.python.org/issue?@action=redirect&bpo=30597]: print 现在在作为 Python 2 语句使用时，自定义错误消息中显示预期的输入。由 Sanyam Khurana 提供补丁。

库

bpo-31499 [https://bugs.python.org/issue?@action=redirect&bpo=31499]: xml.etree：修复当解析器是引用循环的一部分时的崩溃问题。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing.get_type_hints现在默认（当调用者未指定 globalns 时）为类和模块找到正确的globalns。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块的速度改进。原始PR由Ivan Levkivskyi和Mitar提供。

bpo-31544 [https://bugs.python.org/issue?@action=redirect&bpo=31544]: ElementTree的C加速器模块忽略了在XMLParser()中查找TreeBuilder目标方法时引发的异常。

bpo-31234 [https://bugs.python.org/issue?@action=redirect&bpo=31234]: socket.create_connection()现在手动修复了一个引用循环：成功时清除存储最后一个异常的变量。

bpo-31457 [https://bugs.python.org/issue?@action=redirect&bpo=31457]: LoggerAdapter对象现在可以嵌套。

bpo-31400 [https://bugs.python.org/issue?@action=redirect&bpo=31400]: 改进了 SSL 错误处理，避免丢失错误编号。

bpo-28958 [https://bugs.python.org/issue?@action=redirect&bpo=28958]: ssl.SSLContext() 现在在无法实例化上下文时使用 OpenSSL 错误信息。

bpo-27340 [https://bugs.python.org/issue?@action=redirect&bpo=27340]: SSLSocket.sendall() 现在使用 memoryview 来创建数据切片。这修复了对所有类似于字节对象的支持。同时，这也更高效，避免了昂贵的复制。

bpo-31178 [https://bugs.python.org/issue?@action=redirect&bpo=31178]: 修复了 subprocess 模块中在罕见错误路径下的字符串连接错误

bpo-31350 [https://bugs.python.org/issue?@action=redirect&bpo=31350]: 对 asyncio._get_running_loop() 进行微优化，使其速度提升高达 10%。

bpo-31170 [https://bugs.python.org/issue?@action=redirect&bpo=31170]: expat: 将 libexpat 从 2.2.3 更新至 2.2.4。修复了 UTF-8 输入部分字符的复制问题（libexpat bug 115）：https://github.com/libexpat/libexpat/issues/115

bpo-29136 [https://bugs.python.org/issue?@action=redirect&bpo=29136]: 添加 TLS 1.3 密码套件和 OP_NO_TLSv1_3。

bpo-29212 [https://bugs.python.org/issue?@action=redirect&bpo=29212]: 修复 concurrent.futures.thread.ThreadPoolExecutor 线程在没有提供 thread_name_prefix 时默认使用非 repr() 基础的线程名。它们现在会自称为 "ThreadPoolExecutor-y_n"。

bpo-9146 [https://bugs.python.org/issue?@action=redirect&bpo=9146]: 修复 _hashopenssl 在链接的 OpenSSL 库中不可用标准哈希函数（如 md5）时的段错误。如在某些特殊的 FIPS-140 构建环境中。

bpo-27144 [https://bugs.python.org/issue?@action=redirect&bpo=27144]: concurrent.futures 中的 map() 和 as_completed() 迭代器现在避免保留对生成对象的引用。

bpo-10746 [https://bugs.python.org/issue?@action=redirect&bpo=10746]: 修复 ctypes 为整数类型生成错误的 PEP 3118 [https://www.python.org/dev/peps/pep-3118] 类型代码的问题。

bpo-22536 [https://bugs.python.org/issue?@action=redirect&bpo=22536]: 在 POSIX 系统上由于找不到可执行文件或 cwd 而引发 FileNotFoundError 时，子进程模块现在会设置文件名。

bpo-31249 [https://bugs.python.org/issue?@action=redirect&bpo=31249]: concurrent.futures: ThreadPoolExecutor 使用的 WorkItem.run() 现在打破了异常对象和 WorkItem 对象之间的循环引用。

bpo-31247 [https://bugs.python.org/issue?@action=redirect&bpo=31247]: xmlrpc.server 现在在处理异常的代码中使用 sys.exc_info() 时显式地打破循环引用。

bpo-30102 [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 的研究。

bpo-31185 [https://bugs.python.org/issue?@action=redirect&bpo=31185]: 修复了 asyncio 加速模块中的杂项错误。

bpo-31135 [https://bugs.python.org/issue?@action=redirect&bpo=31135]: ttk：修复LabeledScale和OptionMenu类的destroy()方法。即使使用的属性不存在，也调用父类的destroy()方法。LabeledScale.destroy()方法现在还显式清除了label和scale属性，以帮助垃圾回收器销毁所有小部件。

bpo-31107 [https://bugs.python.org/issue?@action=redirect&bpo=31107]: Fix copyreg._slotnames() mangled attribute calculation for classes whose name begins with an underscore. Patch by Shane Harvey.

bpo-31061 [https://bugs.python.org/issue?@action=redirect&bpo=31061]: 修复了在使用asyncio和线程时的崩溃问题。

bpo-30502 [https://bugs.python.org/issue?@action=redirect&bpo=30502]: 修复了ssl中长oids的处理。基于Christian Heimes的补丁。

bpo-30119 [https://bugs.python.org/issue?@action=redirect&bpo=30119]: ftplib.FTP.putline() now throws ValueError on commands that contains CR or LF. Patch by Dong-hee Na.

bpo-30595 [https://bugs.python.org/issue?@action=redirect&bpo=30595]: multiprocessing.Queue.get() 现在在非阻塞模式下轮询其读取器，如果成功获取锁但获取时间超过了超时时间。

bpo-29403 [https://bugs.python.org/issue?@action=redirect&bpo=29403]: 修复``unittest.mock``模块的autospec功能，使其不再对绑定到方法的内置函数报错。由Aaron Gallagher提供补丁。

bpo-30961 [https://bugs.python.org/issue?@action=redirect&bpo=30961]: 修复了tracemalloc中借用引用的递减问题。

bpo-25684 [https://bugs.python.org/issue?@action=redirect&bpo=25684]: 修改 ttk.OptionMenu 单选按钮，使其在不同 OptionMenu 实例间保持唯一。

bpo-30886 [https://bugs.python.org/issue?@action=redirect&bpo=30886]: 修复 multiprocessing.Queue.join_thread()：现在即使线程是由创建队列的同一进程启动的，它也会等待线程完成。

bpo-29854 [https://bugs.python.org/issue?@action=redirect&bpo=29854]: 修复使用 readline 的 history-size 选项时 readline 中的段错误。由 Nir Soffer 提供补丁。

bpo-30319 [https://bugs.python.org/issue?@action=redirect&bpo=30319]: socket.close() 现在忽略 ECONNRESET 错误。

bpo-30828 [https://bugs.python.org/issue?@action=redirect&bpo=30828]: Fix out of bounds write in asyncio.CFuture.remove_done_callback().

bpo-30807 [https://bugs.python.org/issue?@action=redirect&bpo=30807]: 当传递一个极小的值时，signal.setitimer() 可能会禁用计时器。极小的值（如 1e-6）是 setitimer() 有效的非零值，它被指定为采取微秒级间隔。然而，在某些平台上，我们的转换例程可能将 1e-6 转换为零间隔，从而禁用计时器而不是（重新）调度它。

bpo-30441 [https://bugs.python.org/issue?@action=redirect&bpo=30441]: 修复在迭代 os.environ 时修改它导致的错误。

bpo-30532 [https://bugs.python.org/issue?@action=redirect&bpo=30532]: 修复电子邮件头值解析器在某些情况下丢弃折叠空白的问题。

bpo-30879 [https://bugs.python.org/issue?@action=redirect&bpo=30879]: os.listdir() 和 os.scandir() 现在在使用字节类参数调用时会发出字节名称。

bpo-30746 [https://bugs.python.org/issue?@action=redirect&bpo=30746]: 禁止在 os.putenv() 和 os.spawn*() 的环境变量名中使用 '=' 字符。

bpo-29755 [https://bugs.python.org/issue?@action=redirect&bpo=29755]: 修复了 gettext 模块中的 lgettext() 系列函数。它们现在总是返回字节。

文档

bpo-31294 [https://bugs.python.org/issue?@action=redirect&bpo=31294]: 修复ZeroMQSocketListener和ZeroMQSocketHandler示例中的不完整代码片段，并将它们适配到Python 3。

bpo-21649 [https://bugs.python.org/issue?@action=redirect&bpo=21649]: 在SSL文档中添加RFC 7525和Mozilla服务器端TLS链接。

bpo-30803 [https://bugs.python.org/issue?@action=redirect&bpo=30803]: 澄清关于真值测试的文档。原始由Peter Thomassen提供补丁。

测试

bpo-31320 [https://bugs.python.org/issue?@action=redirect&bpo=31320]: 在 test_ssl 中静默回溯。

bpo-25674 [https://bugs.python.org/issue?@action=redirect&bpo=25674]: 移除 sha256.tbs-internet.com 的 ssl 测试。

bpo-30715 [https://bugs.python.org/issue?@action=redirect&bpo=30715]: 处理 OpenSSL 1.1.0f 的 ALPN 回调变更。最新版本的行为类似于 OpenSSL 1.0.2，不再中止握手。

bpo-30822 [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。

构建

bpo-30854 [https://bugs.python.org/issue?@action=redirect&bpo=30854]: 修复编译--without-threads时的编译错误。由Masayuki Yamamoto提供补丁。

Windows

bpo-30389 [https://bugs.python.org/issue?@action=redirect&bpo=30389]: 在Windows上的distutils中添加对Visual Studio 2017的检测。

bpo-31340 [https://bugs.python.org/issue?@action=redirect&bpo=31340]: 更改为使用MSVC v141（包含在Visual Studio 2017中）构建。

bpo-30581 [https://bugs.python.org/issue?@action=redirect&bpo=30581]: os.cpu_count()现在在Windows上当逻辑处理器数量大于64时返回正确的处理器数量。

bpo-30731 [https://bugs.python.org/issue?@action=redirect&bpo=30731]: 向python.manifest添加缺失的xmlns，以使其匹配模式。

IDLE

bpo-31493 [https://bugs.python.org/issue?@action=redirect&bpo=31493]: IDLE 代码上下文——修复代码更新和字体更新计时器。取消计时器可以防止 test_idle 完成时出现警告消息。

bpo-31488 [https://bugs.python.org/issue?@action=redirect&bpo=31488]: IDLE - 更新前扩展类中的非键选项。应用配置对话框更改时，为每个特性类调用 .reload。更改 ParenMatch，使更新的选项影响附加到现有编辑器窗口的现有实例。

bpo-31477 [https://bugs.python.org/issue?@action=redirect&bpo=31477]: IDLE - 改进文档中的 rstrip 条目。剥离尾随空白会剥离比空格更多的内容。多行字符串文字不被跳过。

bpo-31480 [https://bugs.python.org/issue?@action=redirect&bpo=31480]: IDLE - 使测试在默认禁用 zzdummy 扩展的情况下通过。

bpo-31421 [https://bugs.python.org/issue?@action=redirect&bpo=31421]: 文档说明IDLE如何运行tkinter程序。IDLE在后台调用tcl/tk更新，以使与tkinter应用程序的实时交互和实验更加容易。

bpo-31414 [https://bugs.python.org/issue?@action=redirect&bpo=31414]: IDLE -- 通过首先删除来修复tk输入框测试。向整数输入框中添加内容与删除并插入不同，因为int('')会失败。

bpo-31051 [https://bugs.python.org/issue?@action=redirect&bpo=31051]: 将IDLE的configdialog GenPage重新排列为窗口、编辑器和帮助部分。

bpo-30617 [https://bugs.python.org/issue?@action=redirect&bpo=30617]: IDLE - 为outwin子类添加文档字符串和测试，这是editor的子类。将一些数据和函数从类移到模块级别。由Cheryl Sabella提供补丁。

bpo-31287 [https://bugs.python.org/issue?@action=redirect&bpo=31287]: IDLE - 在test_configdialog中不要修改tkinter.message。

bpo-27099 [https://bugs.python.org/issue?@action=redirect&bpo=27099]: 将 IDLE 的内置“扩展”功能转换为常规功能。约 10 项 IDLE 功能原本以可选扩展的形式实现，但是，它们的差异行为导致用户困惑甚至更糟，也不利于维护，因此，进行此次转换。对用户的主要区别在于，现在内置功能的可自定义按键绑定将采用统一方式处理。具体表现为：在某个按键集中编辑绑定仅会影响该按键集中的值。所有绑定均在 config-extensions.def 文件中系统预设的默认按键集中统一定义。所有自定义按键集会整体保存在 config-extension.cfg 文件中。点击“应用”或“确定”后所有更改立即生效。受影响的交互事件包括'<<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 提交。

bpo-31206 [https://bugs.python.org/issue?@action=redirect&bpo=31206]: IDLE: 从ConfigDialog中提取HighPage(Frame)类。由Cheryl Sabella提供补丁。

bpo-31001 [https://bugs.python.org/issue?@action=redirect&bpo=31001]: 为configdialog高亮标签添加测试。由Cheryl Sabella提供补丁。

bpo-31205 [https://bugs.python.org/issue?@action=redirect&bpo=31205]: IDLE：从ConfigDialog中提取KeysPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

bpo-31130 [https://bugs.python.org/issue?@action=redirect&bpo=31130]: IDLE -- 修复test_configdialog中的内存泄漏。初始由Victor Stinner提供补丁。

bpo-31002 [https://bugs.python.org/issue?@action=redirect&bpo=31002]: 为configdialog的keys标签页添加测试。由Cheryl Sabella提供补丁。

bpo-19903 [https://bugs.python.org/issue?@action=redirect&bpo=19903]: IDLE: Calltips use inspect.signature instead of inspect.getfullargspec. This improves calltips for builtins converted to use Argument Clinic. Patch by Louie Lu.

bpo-31083 [https://bugs.python.org/issue?@action=redirect&bpo=31083]: IDLE - 在configdialog中添加TabPage类的概要。更新现有类以匹配概要。初始补丁由Cheryl Sabella提供。

bpo-31050 [https://bugs.python.org/issue?@action=redirect&bpo=31050]: 从ConfigDialog中提取GenPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

bpo-31004 [https://bugs.python.org/issue?@action=redirect&bpo=31004]: IDLE - 从ConfigDialog中提取FontPage(Frame)类。经过轻微修改的测试仍然通过。修复通用测试。补丁主要由Cheryl Sabella提供。

bpo-30781 [https://bugs.python.org/issue?@action=redirect&bpo=30781]: IDLE - 在ConfigDialog中使用ttk部件。由Terry Jan Reedy和Cheryl Sabella提供补丁。

bpo-31060 [https://bugs.python.org/issue?@action=redirect&bpo=31060]: IDLE - 完成ConfigDialog中方法的重新排列。将与每个标签页和按钮相关的方法分组有助于编写测试和改进标签页，并将使这些组能够分割成类。

bpo-30853 [https://bugs.python.org/issue?@action=redirect&bpo=30853]: IDLE -- 从ConfigDialog中提取VarTrace类。实例跟踪器管理由tk变量和回调函数组成的对。当跟踪开启时，设置变量会调用函数。新类的测试覆盖率为100%。

bpo-31003 [https://bugs.python.org/issue?@action=redirect&bpo=31003]: IDLE：为通用标签页添加更多测试。

bpo-30993 [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调用的移动。为加载函数添加测试。将所有字体测试放在一个类中，将标签缩进测试放在另一个类中。除了两行代码外，这些测试完全覆盖了相关函数。

bpo-30981 [https://bugs.python.org/issue?@action=redirect&bpo=30981]: IDLE -- 为配置对话框字体页面添加更多测试。

bpo-28523 [https://bugs.python.org/issue?@action=redirect&bpo=28523]: IDLE：在配置对话框中将'colour'替换为'color'。

bpo-30917 [https://bugs.python.org/issue?@action=redirect&bpo=30917]: 为idlelib.config.IdleConf添加测试。将覆盖率从46%提高到96%。由Louie Lu提供补丁。

bpo-30934 [https://bugs.python.org/issue?@action=redirect&bpo=30934]: 记录idlelib测试的覆盖率详情。在idlelib/idle-test/README.txt中添加部分内容。包括检查分支是否双向执行。排除在单元测试期间不运行的IDLE特定代码。

bpo-30913 [https://bugs.python.org/issue?@action=redirect&bpo=30913]: IDLE：在文档字符串中记录ConfigDialog的tk变量、方法和部件。这将有助于改进对话框和分割类。原始由Cheryl Sabella提供补丁。

bpo-30899 [https://bugs.python.org/issue?@action=redirect&bpo=30899]: IDLE：为config中的ConfigParser子类添加测试。由Louie Lu提供补丁。

bpo-30881 [https://bugs.python.org/issue?@action=redirect&bpo=30881]: IDLE：为browser.py添加文档字符串。由Cheryl Sabella提供补丁。

bpo-30851 [https://bugs.python.org/issue?@action=redirect&bpo=30851]: IDLE：移除configdialog中未使用的变量。一个是重复的，一个是设置但用户无法更改的。由Cheryl Sabella提供补丁。

bpo-30870 [https://bugs.python.org/issue?@action=redirect&bpo=30870]: IDLE：在设置对话框中，使用上下键以及鼠标选择字体。初始由Louie Lu提供补丁。

bpo-8231 [https://bugs.python.org/issue?@action=redirect&bpo=8231]: IDLE：仅调用config.IdleConf.GetUserCfgDir一次。

bpo-30779 [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贡献了部分补丁。

bpo-30777 [https://bugs.python.org/issue?@action=redirect&bpo=30777]: IDLE：configdialog - 添加文档字符串并修复注释。由Cheryl Sabella提供补丁。

bpo-30495 [https://bugs.python.org/issue?@action=redirect&bpo=30495]: IDLE：通过添加文档字符串、PEP8命名和更多测试来改进textview。由Cheryl Sabella提供补丁。

bpo-30723 [https://bugs.python.org/issue?@action=redirect&bpo=30723]: IDLE：对parenmatch进行多项改进。添加'parens'风格以同时高亮开启和关闭符号。使'default'风格（非默认）成为'opener'的同义词。使时间延迟在所有风格中工作方式相同。为配置对话框扩展标签添加帮助，包括parenmatch的帮助。添加新测试。原始补丁由Charles Wohlganger提供。

bpo-30674 [https://bugs.python.org/issue?@action=redirect&bpo=30674]: IDLE：向grep模块添加文档字符串。由Cheryl Sabella提供补丁。

bpo-21519 [https://bugs.python.org/issue?@action=redirect&bpo=21519]: IDLE的基本自定义键输入对话框现在能正确检测重复项。原始由Saimadhav Heblikar提供补丁。

bpo-29910 [https://bugs.python.org/issue?@action=redirect&bpo=29910]: IDLE不再通过快捷键注释掉一个区域后删除一个字符。为此添加 ``return 'break'``以及IDLE和默认键绑定之间的其他潜在冲突。

bpo-30728 [https://bugs.python.org/issue?@action=redirect&bpo=30728]: 审查并更改idlelib.configdialog的名称。将方法和属性名称小写。将'colour'替换为'color'，扩展过于隐晦的名称，删除不需要的下划线。用特定的导入替换 import *。由Cheryl Sabella提供补丁。

bpo-6739 [https://bugs.python.org/issue?@action=redirect&bpo=6739]: IDLE：通过尝试用tk绑定用户输入的键序列来验证它们。为所有3个验证函数添加测试。原始由G Polo提供补丁。测试由Cheryl Sabella添加。

工具/示例

bpo-30983 [https://bugs.python.org/issue?@action=redirect&bpo=30983]: gdb集成命令（py-bt等）现在也可以在优化的共享构建上工作了。PEP 523 [https://www.python.org/dev/peps/pep-0523] 引入了_PyEval_EvalFrameDefault，它在非调试共享构建上内联了PyEval_EvalFrameEx。这破坏了使用py-bt、py-up和其他一些Python特定的gdb集成的能力。问题通过在python-gdb.py中仅查找_PyEval_EvalFrameDefault帧来修复。原始由Bruno "Polaco" Penteado提供补丁。

Python 3.6.2 正式版

发布日期: 2017-07-17

自rc2起没有更改

Python 3.6.2 rc2

发布日期: 2017-07-07

安全性

bpo-30730 [https://bugs.python.org/issue?@action=redirect&bpo=30730]: 在 Windows 上防止子进程中的环境变量注入。防止传递其他环境变量和命令参数。

bpo-30694 [https://bugs.python.org/issue?@action=redirect&bpo=30694]: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple security vulnerabilities including: CVE-2017-9233 (External entity infinite loop DoS), CVE-2016-9063 (Integer overflow, re-fix), CVE-2016-0718 (Fix regression bugs from 2.2.0's fix to CVE-2016-0718) and CVE-2012-0876 (Counter hash flooding with SipHash). Note: the CVE-2016-5300 (Use os-specific entropy sources like getrandom) doesn't impact Python, since Python already gets entropy from the OS to set the expat secret using XML_SetHashSalt().

bpo-30500 [https://bugs.python.org/issue?@action=redirect&bpo=30500]: 修复 urllib.parse.splithost() 正确解析片段。例如，splithost('//127.0.0.1#@evil.com/') 现在正确返回 127.0.0.1 主机，而不是将 @evil.com 视为认证中的主机（login@host）。

Python 3.6.2 rc1

发布日期: 2017-06-17

安全性

bpo-29591 [https://bugs.python.org/issue?@action=redirect&bpo=29591]: Update expat copy from 2.1.1 to 2.2.0 to get fixes of CVE-2016-0718 and CVE-2016-4472. See https://sourceforge.net/p/expat/bugs/537/ for more information.

核心与内置函数

bpo-30682 [https://bugs.python.org/issue?@action=redirect&bpo=30682]: 移除了对某些 f-字符串过于严格的断言，例如 eval("f'\n'") 和 eval("f'\r'")。

bpo-30604 [https://bugs.python.org/issue?@action=redirect&bpo=30604]: 将co_extra_freefuncs移动到非每线程以避免崩溃

bpo-29104 [https://bugs.python.org/issue?@action=redirect&bpo=29104]: 修复了 f-字符串中反斜杠的解析。

bpo-27945 [https://bugs.python.org/issue?@action=redirect&bpo=27945]: 修复了在搜索、插入或比较过程中输入集合被修改时，字典的各种段错误。基于 Duane Griffin 和 Tim Mitchell 的补丁。

bpo-25794 [https://bugs.python.org/issue?@action=redirect&bpo=25794]: 修复了 type.__setattr__() 和 type.__delattr__() 对于非 interned 属性名称的问题。基于 Eryk Sun 的补丁。

bpo-30039 [https://bugs.python.org/issue?@action=redirect&bpo=30039]: 如果解释器在恢复一系列嵌套的 'yield from' 或 'await' 调用过程中发生 KeyboardInterrupt，现在会正确地传递到最内层的帧。

bpo-12414 [https://bugs.python.org/issue?@action=redirect&bpo=12414]: sys.getsizeof() on a code object now returns the sizes which includes the code struct and sizes of objects which it references. Patch by Dong-hee Na.

bpo-29949 [https://bugs.python.org/issue?@action=redirect&bpo=29949]: 修复了 set 和 frozenset 对象的内存使用回归问题。

bpo-29935 [https://bugs.python.org/issue?@action=redirect&bpo=29935]: 修复了在传递错误类型的索引时，tuple、list 和 deque 的 index() 方法中的错误消息。

bpo-29859 [https://bugs.python.org/issue?@action=redirect&bpo=29859]: 当 thread_pthread.h 中的任何 pthread_* 调用失败时，显示正确的错误消息。

bpo-28876 [https://bugs.python.org/issue?@action=redirect&bpo=28876]: 即使 len(range) 引发 OverflowError，bool(range) 也能正常工作。

bpo-29600 [https://bugs.python.org/issue?@action=redirect&bpo=29600]: 修复在StopIteration中包装协程返回值的问题。

bpo-28856 [https://bugs.python.org/issue?@action=redirect&bpo=28856]: 修复了一个疏忽，即 %b 格式的字节应支持遵循缓冲区协议的对象。

bpo-29714 [https://bugs.python.org/issue?@action=redirect&bpo=29714]: 修复了一个回归问题，即当包含零字节时，字节格式可能会失败。

bpo-29478 [https://bugs.python.org/issue?@action=redirect&bpo=29478]: 在使用Compat32策略时，如果指定了max_line_length=None，它将不再被忽略。补丁由Mircea Cosbuc提供。

库

bpo-30616 [https://bugs.python.org/issue?@action=redirect&bpo=30616]: Functional API of enum allows to create empty enums. Patched by Dong-hee Na

bpo-30038 [https://bugs.python.org/issue?@action=redirect&bpo=30038]: 修复了信号传递和唤醒文件描述符之间的竞争条件。补丁由 Nathaniel Smith 提供。

bpo-23894 [https://bugs.python.org/issue?@action=redirect&bpo=23894]: lib2to3 现在能识别 rb'...' 和 f'...' 字符串。

bpo-23890 [https://bugs.python.org/issue?@action=redirect&bpo=23890]: unittest.TestCase.assertRaises() 现在手动打破引用循环，以避免对象存活时间超过预期。

bpo-30149 [https://bugs.python.org/issue?@action=redirect&bpo=30149]: inspect.signature() now supports callables with variable-argument parameters wrapped with partialmethod. Patch by Dong-hee Na.

bpo-30645 [https://bugs.python.org/issue?@action=redirect&bpo=30645]: 修复imp.load_package()中的路径计算，修复仅随字节码一起提供包的情况。由Alexandru Ardelean提供补丁。

bpo-29931 [https://bugs.python.org/issue?@action=redirect&bpo=29931]: 修复了 ipaddress.ip_interface 对象的比较检查。补丁由 Sanjay Sundaresan 提供。

bpo-30605 [https://bugs.python.org/issue?@action=redirect&bpo=30605]: re.compile() 在编译带有错误放置的内联修饰符的 bytes 实例时不再引发 BytesWarning。由 Roy Williams 提供补丁。

bpo-24484 [https://bugs.python.org/issue?@action=redirect&bpo=24484]: 避免多进程清理中的竞争条件（#2159）

bpo-28994 [https://bugs.python.org/issue?@action=redirect&bpo=28994]: 对于由 atexit 注册的回调中引发的 SystemExit，不再显示回溯。

bpo-30508 [https://bugs.python.org/issue?@action=redirect&bpo=30508]: 如果调用了 Task/Future 的 "cancel()" 方法，则不记录异常。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing 模块的更新：添加通用的 AsyncContextManager，为所有版本添加对 ContextManager 的支持。原始 PR 由 Jelle Zijlstra 和 Ivan Levkivskyi 提供。

bpo-29870 [https://bugs.python.org/issue?@action=redirect&bpo=29870]: 修复 asyncio/ssl 实现中当连接被中止时 SSL 套接字的泄漏问题。由 Michaël Sghaïer 提供补丁。

bpo-29743 [https://bugs.python.org/issue?@action=redirect&bpo=29743]: 在握手过程中关闭传输会导致打开的套接字泄漏。由 Nikolay Kim 提供补丁。

bpo-27585 [https://bugs.python.org/issue?@action=redirect&bpo=27585]: 修复 asyncio.Lock 中的等待者取消问题。由 Mathieu Sornay 提供补丁。

bpo-30418 [https://bugs.python.org/issue?@action=redirect&bpo=30418]: 在 Windows 上，如果子进程仍在运行但关闭了管道，subprocess.Popen.communicate() 现在也会忽略 stdin.write() 上的 EINVAL。

bpo-29822 [https://bugs.python.org/issue?@action=redirect&bpo=29822]: inspect.isabstract()现在在__init_subclass__期间工作。补丁由Nate Soares提供。

bpo-29581 [https://bugs.python.org/issue?@action=redirect&bpo=29581]: ABCMeta.__new__现在接受 **kwargs，允许抽象基类在__init_subclass__中使用关键字参数。由Nate Soares提供补丁。

bpo-30557 [https://bugs.python.org/issue?@action=redirect&bpo=30557]: faulthandler 现在能够正确过滤和显示 Windows 上的异常代码。

bpo-30378 [https://bugs.python.org/issue?@action=redirect&bpo=30378]: 修复 logging.handlers.SysLogHandler 无法处理 IPv6 地址的问题。

bpo-29960 [https://bugs.python.org/issue?@action=redirect&bpo=29960]: 当_random.Random.setstate()引发异常时，保留生成器状态。补丁由Bryan Olson提供。

bpo-30414 [https://bugs.python.org/issue?@action=redirect&bpo=30414]: multiprocessing.Queue._feed 后台运行线程在异常时不从主循环中中断。

bpo-30003 [https://bugs.python.org/issue?@action=redirect&bpo=30003]: 修复HZ编解码器中转义字符的处理。基于Ma Lin的补丁。

bpo-30301 [https://bugs.python.org/issue?@action=redirect&bpo=30301]: 修复在 spawn 和 forkserver 启动方法下使用SimpleQueue.empty()时的AttributeError。

bpo-30329 [https://bugs.python.org/issue?@action=redirect&bpo=30329]: imaplib和poplib现在在shutdown(SHUT_RDWR)时捕获Windows socket WSAEINVAL错误（代码10022）：尝试了无效操作。此错误有时发生在SSL连接上。

bpo-30375 [https://bugs.python.org/issue?@action=redirect&bpo=30375]: 编译正则表达式时发出的警告现在总是指向用户代码中的行。之前如果从组或条件内部发出，它们可能指向re模块的内部。

bpo-30048 [https://bugs.python.org/issue?@action=redirect&bpo=30048]: 修复了当任务运行协程且协程返回而没有任何更多 await 时，``Task.cancel()``可能被忽略的问题。

bpo-30266 [https://bugs.python.org/issue?@action=redirect&bpo=30266]: contextlib.AbstractContextManager现在支持通过设置__enter__ = None或__exit__ = None进行反注册，遵循 bpo-25958 [https://bugs.python.org/issue?@action=redirect&bpo=25958] 中引入的模式。由Jelle Zijlstra提供补丁。

bpo-30298 [https://bugs.python.org/issue?@action=redirect&bpo=30298]: 放宽内联修饰符的弃用警告条件。现在允许在模式开始处连续使用多个内联修饰符（例如 '(?i)(?s)...'）。在详细模式下，现在允许在内联修饰符之前和之间使用空格和注释（例如 '(?x) (?i) (?s)...'）。

bpo-29990 [https://bugs.python.org/issue?@action=redirect&bpo=29990]: 修复GB18030解码器中的范围检查。原由Ma Lin提供补丁。

bpo-26293 [https://bugs.python.org/issue?@action=redirect&bpo=26293]: 由于zipfile损坏导致的变更。（另见：bpo-29094 [https://bugs.python.org/issue?@action=redirect&bpo=29094]）

bpo-30243 [https://bugs.python.org/issue?@action=redirect&bpo=30243]: 移除了_json的扫描器和编码器的__init__方法。误用它们可能导致内存泄漏或崩溃。现在扫描器和编码器对象在__new__方法中完全初始化。

bpo-30185 [https://bugs.python.org/issue?@action=redirect&bpo=30185]: 在收到Ctrl-C时，避免forkserver辅助进程中的KeyboardInterrupt回溯。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对typing模块的各种更新：添加typing.NoReturn类型，使用WrapperDescriptorType，小错误修复。原PR由Jim Fasarakis-Hilliard和Ivan Levkivskyi提供。

bpo-30205 [https://bugs.python.org/issue?@action=redirect&bpo=30205]: 修复Linux上未绑定的AF_UNIX套接字的getsockname()。

bpo-30070 [https://bugs.python.org/issue?@action=redirect&bpo=30070]: 修复了解析模块中错误处理的内存泄漏和崩溃问题。

bpo-30061 [https://bugs.python.org/issue?@action=redirect&bpo=30061]: 修复了当readline()或__next__()分别返回不可大小化的对象时，IOBase方法__next__()和readlines()中的崩溃。修复了由不检查PyObject_Size()、PySequence_Size()或PyMapping_Size()的结果可能引起的其他错误。

bpo-30017 [https://bugs.python.org/issue?@action=redirect&bpo=30017]: 允许多次调用zip条目写入器对象的close()方法。向已关闭的写入器写入现在总是产生ValueError。

bpo-30068 [https://bugs.python.org/issue?@action=redirect&bpo=30068]: 当存在hint时，_io._IOBase.readlines将首先检查是否关闭。

bpo-29694 [https://bugs.python.org/issue?@action=redirect&bpo=29694]: 修复了pathlib mkdir与flags parents=True时的竞争条件。补丁由Armin Rigo提供。

bpo-29692 [https://bugs.python.org/issue?@action=redirect&bpo=29692]: 修复了contextlib.contextmanager中RuntimeError异常的任意解链。由Siddharth Velankar提供补丁。

bpo-29998 [https://bugs.python.org/issue?@action=redirect&bpo=29998]: Pickling和复制ImportError现在保留name和path属性。

bpo-29953 [https://bugs.python.org/issue?@action=redirect&bpo=29953]: 修复了当传递超出范围的 fold 参数时，datetime 和 time 对象的 replace() 方法中的内存泄漏问题。

bpo-29942 [https://bugs.python.org/issue?@action=redirect&bpo=29942]: 修复了在遇到长串空可迭代对象时，itertools.chain.from_iterable 的崩溃问题。

bpo-27863 [https://bugs.python.org/issue?@action=redirect&bpo=27863]: 修复了由竞争条件和错误类型引起的 ElementTree 中的多个崩溃问题。

bpo-28699 [https://bugs.python.org/issue?@action=redirect&bpo=28699]: 修复了 multiprocessing.pool 中池的一个 bug，即在可迭代对象的最开始引发异常可能会吞掉异常或使程序挂起。由 Davin Potts 和 Xiang Zhang 提供补丁。

bpo-25803 [https://bugs.python.org/issue?@action=redirect&bpo=25803]: 当操作系统优先考虑如 EACCES 而不是 EEXIST 的错误时，避免 Path.mkdir(exist_ok=True) 引发不正确的错误。

bpo-29861 [https://bugs.python.org/issue?@action=redirect&bpo=29861]: 在 multiprocessing.Pool 中，任务、它们的参数和结果一旦完成就释放引用。

bpo-29884 [https://bugs.python.org/issue?@action=redirect&bpo=29884]: faulthandler: 在拆卸期间恢复旧的sigaltstack。由Christophe Zeitouny提供补丁。

bpo-25455 [https://bugs.python.org/issue?@action=redirect&bpo=25455]: 修复了递归缓冲文件类对象repr中的崩溃。

bpo-29800 [https://bugs.python.org/issue?@action=redirect&bpo=29800]: 修复了如果partial.keywords的键不是字符串时partial.__repr__的崩溃。由Michael Seifert提供补丁。

bpo-29742 [https://bugs.python.org/issue?@action=redirect&bpo=29742]: 如果 get_extra_info() 在关闭的 ssl 传输上调用，将引发异常。由 Nikolay Kim 提供补丁。

bpo-8256 [https://bugs.python.org/issue?@action=redirect&bpo=8256]: 修复了如果sys.stdin或sys.stdout的属性"encoding"或"errors"未设置或不是字符串时可能导致的input()失败或崩溃。

bpo-28298 [https://bugs.python.org/issue?@action=redirect&bpo=28298]: 修复了一个bug，该bug阻止了数组'Q'、'L'和'I'接受大整数（具有__int__方法的对象）作为元素。由Oren Milman提供补丁。

bpo-28231 [https://bugs.python.org/issue?@action=redirect&bpo=28231]: zipfile模块现在接受路径类对象作为外部路径。

bpo-26915 [https://bugs.python.org/issue?@action=redirect&bpo=26915]: collections.abc.Sequence的index()和count()方法在进行比较时现在在检查相等性之前检查身份。

bpo-29615 [https://bugs.python.org/issue?@action=redirect&bpo=29615]: SimpleXMLRPCDispatcher 不再将 KeyError（或任何其他异常）链接到调度方法中引发的异常。由 Petr Motejlek 提供补丁。

bpo-30177 [https://bugs.python.org/issue?@action=redirect&bpo=30177]: path.resolve(strict=False)不再在文件系统中不存在的第一个元素后截断路径。补丁由Antoine Pietri提供。

IDLE

bpo-15786 [https://bugs.python.org/issue?@action=redirect&bpo=15786]: 修复IDLE自动完成框的几个问题。现在以下功能应该可以正常工作：点击选择框中的项目；使用滚动条；通过按回车键选择项目。MacOSX上的挂起问题应该不会再发生。补丁由Louie Lu提供。

bpo-25514 [https://bugs.python.org/issue?@action=redirect&bpo=25514]: 添加关于IDLE启动失败的文档子节。无连接弹出消息会引导用户查看此部分。

bpo-30642 [https://bugs.python.org/issue?@action=redirect&bpo=30642]: 修复IDLE测试中的引用泄露。由Louie Lu和Terry Jan Reedy提供补丁。

bpo-30495 [https://bugs.python.org/issue?@action=redirect&bpo=30495]: 为textview.py添加文档字符串并使用PEP8命名。由Cheryl Sabella和Terry Jan Reedy提供补丁。

bpo-30290 [https://bugs.python.org/issue?@action=redirect&bpo=30290]: 帮助-关于：使用pep8命名并添加测试。将覆盖率提高到100%。由Louie Lu、Cheryl Sabella和Terry Jan Reedy提供补丁。

bpo-30303 [https://bugs.python.org/issue?@action=redirect&bpo=30303]: 向textview添加_utest选项；添加新测试。将覆盖率提高到100%。由Louie Lu和Terry Jan Reedy提供补丁。

C API

bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867]: 如果未设置Py_LIMITED_API，函数PySlice_GetIndicesEx()不再被宏替换。

构建

bpo-29941 [https://bugs.python.org/issue?@action=redirect&bpo=29941]: 添加 --with-assertions 配置标志以明确启用C assert() 检查。默认为关闭。--with-pydebug``意味着 ``--with-assertions。

bpo-28787 [https://bugs.python.org/issue?@action=redirect&bpo=28787]: 修复使用 --with--dtrace 配置时Python的树外构建。

bpo-29243 [https://bugs.python.org/issue?@action=redirect&bpo=29243]: 在配置为 --enable-optimizations 时，防止在 make test、``make install``和一些其他make目标期间不必要的Python重新构建。

bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404]: 不再基于文件修改时间重新生成已生成的文件：该操作现在是显式的。用``make regen-all``替换 make touch。

bpo-29643 [https://bugs.python.org/issue?@action=redirect&bpo=29643]: 修复 --enable-optimization 不起作用的问题。

文档

bpo-30176 [https://bugs.python.org/issue?@action=redirect&bpo=30176]: 在curses文档中添加缺失的属性相关常量。

bpo-30052 [https://bugs.python.org/issue?@action=redirect&bpo=30052]: bytes() 和 bytearray() 的链接目标现在是它们各自的类型定义，而不是相应的内置函数条目。使用 bytes 和 bytearray 来引用后者。为了确保这一及未来的交叉引用更新能自动应用，每日文档构建现在禁用了Sphinx中的默认输出缓存功能。

bpo-26985 [https://bugs.python.org/issue?@action=redirect&bpo=26985]: 在inspect文档中添加缺失的代码对象信息。

工具/示例

bpo-29367 [https://bugs.python.org/issue?@action=redirect&bpo=29367]: python-gdb.py现在也支持 method-wrapper (wrapperobject) 对象。

测试

bpo-30357 [https://bugs.python.org/issue?@action=redirect&bpo=30357]: test_thread: setUp() 现在使用 support.threading_setup() 和 support.threading_cleanup() 来等待线程完成，以避免对后续测试产生随机副作用。初始补丁由 Grzegorz Grzywacz 编写。

bpo-30197 [https://bugs.python.org/issue?@action=redirect&bpo=30197]: 增强了 test.support 模块中的 swap_attr() 和 swap_item() 函数。它们现在可以在 with 语句内部删除替换的属性或项目时工作。属性或项目的旧值（如果不存在则为 None）现在将被赋值给 "as" 子句的目标，如果有的话。

Windows

bpo-30687 [https://bugs.python.org/issue?@action=redirect&bpo=30687]: 在Windows上构建时定位msbuild.exe而不是vcvarsall.bat。

bpo-30450 [https://bugs.python.org/issue?@action=redirect&bpo=30450]: Windows 上的构建过程不再依赖于 Subversion，而是通过 Python 脚本从 GitHub 拉取外部代码。如果系统中未找到 Python 3.6（通过 py -3.6），则使用 NuGet 下载 32 位 Python 的副本。

Python 3.6.1 正式版

发布日期: 2017-03-21

核心与内置函数

bpo-29723 [https://bugs.python.org/issue?@action=redirect&bpo=29723]: bpo-29139 [https://bugs.python.org/issue?@action=redirect&bpo=29139] 中对 sys.path[0] 初始化的更改导致了一个回归问题，暴露了在执行来自 zip 文件、目录或其他导入位置的 __main__ 时 sys.path 初始化方式的不一致性。解释器现在一致避免将导入位置的父目录添加到 sys.path 中，并确保在插入命令行中指定的导入位置时不会无意中修改其他 sys.path 条目。

构建

bpo-27593 [https://bugs.python.org/issue?@action=redirect&bpo=27593]: 修复了sys.version中使用的git信息格式。

修复python.h中不兼容的注释。

Python 3.6.1 rc1

发布日期: 2017-03-04

核心与内置函数

bpo-28893 [https://bugs.python.org/issue?@action=redirect&bpo=28893]: 为从 __aiter__ 和 __anext__ 返回的无效可等待对象引发的错误设置了正确的 __cause__。

bpo-29683 [https://bugs.python.org/issue?@action=redirect&bpo=29683]: 修复了 _PyCode_SetExtra 中的内存分配问题。由 Brian Coleman 提供补丁。

bpo-29684 [https://bugs.python.org/issue?@action=redirect&bpo=29684]: 修复了 PyEval_CallObjectWithKeywords 的一个小回归问题。当 kwargs 不是字典时，它应该引发 TypeError。但当 args=NULL 且 kwargs 不是字典时，可能会导致段错误。

bpo-28598 [https://bugs.python.org/issue?@action=redirect&bpo=28598]: 支持在调用 str.__mod__ 之前调用 str 子类的 __rmod__。由 Martijn Pieters 提供补丁。

bpo-29607 [https://bugs.python.org/issue?@action=redirect&bpo=29607]: 修复了 CALL_FUNCTION_EX 的 stack_effect 计算。补丁由 Matthieu Dartiailh 提供。

bpo-29602 [https://bugs.python.org/issue?@action=redirect&bpo=29602]: 修复了在复杂子类的构造函数和具有 __complex__ 方法的输入中对有符号零的错误处理。由 Serhiy Storchaka 提供补丁。

bpo-29347 [https://bugs.python.org/issue?@action=redirect&bpo=29347]: 修复了在创建弱引用对象时可能解引用未定义指针的问题。

bpo-29438 [https://bugs.python.org/issue?@action=redirect&bpo=29438]: 修复了key sharing dict中的use-after-free问题。

bpo-29319 [https://bugs.python.org/issue?@action=redirect&bpo=29319]: 防止RunMainFromImporter覆盖sys.path[0]。

bpo-29337 [https://bugs.python.org/issue?@action=redirect&bpo=29337]: 修复了比较代码对象时可能出现的BytesWarning。警告可能在编译时发出。

bpo-29327 [https://bugs.python.org/issue?@action=redirect&bpo=29327]: 修复了将可迭代关键字参数传递给sorted()时崩溃的问题。

bpo-29034 [https://bugs.python.org/issue?@action=redirect&bpo=29034]: 修复了os模块(path_converter)中的内存泄漏和use-after-free问题。

bpo-29159 [https://bugs.python.org/issue?@action=redirect&bpo=29159]: 修复了当x.__index__()引发异常时bytes(x)的回归问题。

bpo-28932 [https://bugs.python.org/issue?@action=redirect&bpo=28932]: 如果不存在<sys/random.h>，则不包含它。

bpo-25677 [https://bugs.python.org/issue?@action=redirect&bpo=25677]: 修正了缩进块语法错误提示符的位置。基于Michael Layzell的补丁。

bpo-29000 [https://bugs.python.org/issue?@action=redirect&bpo=29000]: 修复了八进制数在交替形式下零填充的bytes格式化。

bpo-26919 [https://bugs.python.org/issue?@action=redirect&bpo=26919]: 在Android上，操作系统数据现在总是以UTF-8编码/解码，而不是使用区域设置编码，以避免与已经使用UTF-8的os.fsencode()和os.fsdecode()不一致。

bpo-28991 [https://bugs.python.org/issue?@action=redirect&bpo=28991]: functools.lru_cache()容易受到一个由猴子补丁len()函数触发的晦涩的重入错误的影响。

bpo-28739 [https://bugs.python.org/issue?@action=redirect&bpo=28739]: f字符串表达式不再被接受为文档字符串和由ast.literal_eval()处理，即使它们不包含表达式。

bpo-28512 [https://bugs.python.org/issue?@action=redirect&bpo=28512]: 修复了通过PyErr_SyntaxLocationEx()和PyErr_SyntaxLocationObject()设置SyntaxError的offset属性。

bpo-28918 [https://bugs.python.org/issue?@action=redirect&bpo=28918]: 修复了当Python使用Py_DEBUG定义构建时，xxlimited的交叉编译问题。

bpo-28731 [https://bugs.python.org/issue?@action=redirect&bpo=28731]: 优化_PyDict_NewPresized()以创建正确大小的字典。将具有常量键的字典字面量的速度提高至30%。

库

bpo-29169 [https://bugs.python.org/issue?@action=redirect&bpo=29169]: 将 zlib 更新至 1.2.11。

bpo-29623 [https://bugs.python.org/issue?@action=redirect&bpo=29623]: 允许在 ConfigParser.read() 中使用路径类对象作为单一参数。由 David Ellis 提供补丁。

bpo-28963 [https://bugs.python.org/issue?@action=redirect&bpo=28963]: 修复了在 C 中实现的 asyncio.Future.remove_done_callback 中的越界迭代。

bpo-29704 [https://bugs.python.org/issue?@action=redirect&bpo=29704]: asyncio.subprocess.SubprocessStreamProtocol 在所有管道关闭之前不再关闭。

bpo-29271 [https://bugs.python.org/issue?@action=redirect&bpo=29271]: 修复 Task.current_task 和 Task.all_tasks 在 C 中的实现，使其能够接受 None 参数，如同它们的纯 Python 实现一样。

bpo-29703 [https://bugs.python.org/issue?@action=redirect&bpo=29703]: 修复 asyncio，支持在子进程中实例化新的事件循环。

bpo-29376 [https://bugs.python.org/issue?@action=redirect&bpo=29376]: 修复 threading._DummyThread.is_alive() 中的断言错误。

bpo-28624 [https://bugs.python.org/issue?@action=redirect&bpo=28624]: 添加一个测试，检查 Popen() 的 cwd 参数是否接受 PathLike 对象。由 Sayan Chowdhury 提供补丁。

bpo-28518 [https://bugs.python.org/issue?@action=redirect&bpo=28518]: 在 DML 语句之前隐式开始一个事务。由 Aviv Palivoda 提供补丁。

bpo-29532 [https://bugs.python.org/issue?@action=redirect&bpo=29532]: 修改传递给 functools.partial() 的 kwarg 字典不再影响创建后的 partial 对象。

bpo-29110 [https://bugs.python.org/issue?@action=redirect&bpo=29110]: 修复 aifc.open() 中当文件作为文件系统路径给出且不是有效的 AIFF 格式时的文件对象泄漏问题。由 Anthony Zhang 提供补丁。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块进行了多项更新：typing.Counter、typing.ChainMap、改进的 ABC 缓存等。原始 PR 由 Jelle Zijlstra、Ivan Levkivskyi、Manuel Krebber 和 Łukasz Langa 提供。

bpo-29100 [https://bugs.python.org/issue?@action=redirect&bpo=29100]: 修复了 Python 3.6.0 中引入的 datetime.fromtimestamp() 的回归问题：检查最小和最大年份。

bpo-29519 [https://bugs.python.org/issue?@action=redirect&bpo=29519]: 修复了在与multiprocessing和自定义编解码器的罕见组合使用时，weakref在解释器关闭期间抛出异常的问题。

bpo-29416 [https://bugs.python.org/issue?@action=redirect&bpo=29416]: 防止 pathlib.Path.mkdir 中的无限循环。

bpo-29444 [https://bugs.python.org/issue?@action=redirect&bpo=29444]: 修复了 match 对象的 group() 方法中的越界缓冲区访问。基于 WGH 的补丁。

bpo-29335 [https://bugs.python.org/issue?@action=redirect&bpo=29335]: 修复了当子进程已退出到停止状态而不是终止状态（例如：在 ptrace 下）时的 subprocess.Popen.wait()。

bpo-29290 [https://bugs.python.org/issue?@action=redirect&bpo=29290]: 修复了 argparse 中帮助消息会在非断行空格处换行的回归问题。

bpo-28735 [https://bugs.python.org/issue?@action=redirect&bpo=28735]: 修复了 mock.MagickMock 与 mock.ANY 的比较。

bpo-29316 [https://bugs.python.org/issue?@action=redirect&bpo=29316]: 恢复typing模块的临时状态，向文档添加相应说明。由Ivan L.提供补丁。

bpo-29219 [https://bugs.python.org/issue?@action=redirect&bpo=29219]: 修复了未初始化的 ctypes.CDLL 实例的 repr 中的无限递归。

bpo-29011 [https://bugs.python.org/issue?@action=redirect&bpo=29011]: 通过向typing模块添加Deque来修复一个重要的遗漏。

bpo-28969 [https://bugs.python.org/issue?@action=redirect&bpo=28969]: 修复了functools.lru_cache的C实现中的竞态条件。当缓存函数满时，如果同时从不同线程以相同的未缓存参数调用，可能会引发KeyError。

bpo-29142 [https://bugs.python.org/issue?@action=redirect&bpo=29142]: 在urllib.request中，no_proxy环境变量中带有前导点的后缀可以再次匹配相关的主机名（例如.b.c匹配a.b.c）。由Milan Oberkirch提供补丁。

bpo-28961 [https://bugs.python.org/issue?@action=redirect&bpo=28961]: 修复unittest.mock._Call辅助函数：不再忽略name参数。由Jiajun Huang提供补丁。

bpo-29203 [https://bugs.python.org/issue?@action=redirect&bpo=29203]: functools.lru_cache()现在尊重 PEP 468 [https://www.python.org/dev/peps/pep-0468] 并保留关键字参数的顺序。f(a=1, b=2)现在与f(b=2, a=1)分开缓存，因为这两个调用可能产生不同的结果。

bpo-15812 [https://bugs.python.org/issue?@action=redirect&bpo=15812]: inspect.getframeinfo()现在正确显示上下文的第行。由Sam Breese提供补丁。

bpo-29094 [https://bugs.python.org/issue?@action=redirect&bpo=29094]: 使用外部文件对象和模式"w"和"x"创建的ZIP文件中的偏移量现在相对于文件的开始位置。

bpo-29085 [https://bugs.python.org/issue?@action=redirect&bpo=29085]: 允许random.Random.seed()使用高质量的OS随机性，而不是pid和时间。

bpo-29061 [https://bugs.python.org/issue?@action=redirect&bpo=29061]: 修复了secrets.randbelow()中的一个bug，该bug在给定负输入时会挂起。由Brendan Donegan提供补丁。

bpo-29079 [https://bugs.python.org/issue?@action=redirect&bpo=29079]: 防止pathlib.resolve()在Windows上陷入无限循环。

bpo-13051 [https://bugs.python.org/issue?@action=redirect&bpo=13051]: 修复了大型或调整大小的curses.textpad.Textbox中的递归错误。基于Tycho Andersen的补丁。

bpo-29119 [https://bugs.python.org/issue?@action=redirect&bpo=29119]: 修复collections.OrderedDict move_to_end()方法的纯Python版本中的weakrefs。由Andra Bogildea贡献。

bpo-9770 [https://bugs.python.org/issue?@action=redirect&bpo=9770]: curses.ascii谓词现在正确处理负整数。

bpo-28427 [https://bugs.python.org/issue?@action=redirect&bpo=28427]: 当从另一个线程收集时，旧键不应从WeakValueDictionary中移除新值。

bpo-28923 [https://bugs.python.org/issue?@action=redirect&bpo=28923]: 从Tix.py中移除编辑器工件。

bpo-29055 [https://bugs.python.org/issue?@action=redirect&bpo=29055]: 通过抑制上游异常，清理了random.choice()上的空种群错误。

bpo-28871 [https://bugs.python.org/issue?@action=redirect&bpo=28871]: 修复了在深度ElementTree释放时的崩溃。

bpo-19542 [https://bugs.python.org/issue?@action=redirect&bpo=19542]: 修复WeakValueDictionary.setdefault()和WeakValueDictionary.pop()中的bug，这些bug在另一个线程发生GC收集时出现。

bpo-20191 [https://bugs.python.org/issue?@action=redirect&bpo=20191]: 修复了resource.prlimit()中的崩溃，当传递一个不拥有其元素的序列作为限制时。

bpo-28779 [https://bugs.python.org/issue?@action=redirect&bpo=28779]: 如果预加载的模块实例化了某些多处理对象（如锁），multiprocessing.set_forkserver_preload()会使forkserver进程崩溃。

bpo-28847 [https://bugs.python.org/issue?@action=redirect&bpo=28847]: dbm.dumb现在支持读取只读文件，并且在索引文件未更改时不再写入索引文件。

bpo-26937 [https://bugs.python.org/issue?@action=redirect&bpo=26937]: tarfile.TarFile 类的 chown() 方法现在在无法导入 grp 模块时不会失败，例如在 Android 平台上。

IDLE

bpo-29071 [https://bugs.python.org/issue?@action=redirect&bpo=29071]: IDLE为f-字符串前缀着色（但不包括无效的ur前缀）。

bpo-28572 [https://bugs.python.org/issue?@action=redirect&bpo=28572]: 将IDLE的test_configdialog覆盖率提高10%。更新并增强配置系统的描述。

Windows

bpo-29579 [https://bugs.python.org/issue?@action=redirect&bpo=29579]: 从安装程序中移除readme.txt

bpo-29326 [https://bugs.python.org/issue?@action=redirect&bpo=29326]: 忽略._pth文件中的空行（由Alexey Izbyshev提供补丁）

bpo-28164 [https://bugs.python.org/issue?@action=redirect&bpo=28164]: 正确处理特殊的控制台文件名（由Eryk Sun提供补丁）

bpo-29409 [https://bugs.python.org/issue?@action=redirect&bpo=29409]: 为 io.FileIO 实现 PEP 529 [https://www.python.org/dev/peps/pep-0529] (由 Eryk Sun 提供的补丁)

bpo-29392 [https://bugs.python.org/issue?@action=redirect&bpo=29392]: 防止将无效参数传递到 msvcrt 模块时崩溃。

bpo-25778 [https://bugs.python.org/issue?@action=redirect&bpo=25778]: winreg 未正确截断字符串（由 Eryk Sun 提供补丁）

bpo-28896 [https://bugs.python.org/issue?@action=redirect&bpo=28896]: 弃用 WindowsRegistryFinder 并默认禁用它。

C API

bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867]: 如果未设置 Py_LIMITED_API 或其值设置在 0x03050400 和 0x03060000（不包括）之间或 0x03060100 或更高，则函数 PySlice_GetIndicesEx() 将被宏替换。

bpo-29083 [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中不可用。

bpo-29058 [https://bugs.python.org/issue?@action=redirect&bpo=29058]: 所有在 Python 3.2 之后添加的稳定 API 扩展现在只有在 Py_LIMITED_API 设置为支持此 API 的最低 Python 版本的 PY_VERSION_HEX 值时才可用。

文档

bpo-28929 [https://bugs.python.org/issue?@action=redirect&bpo=28929]: 将文档链接到其在GitHub上的源文件。

bpo-25008 [https://bugs.python.org/issue?@action=redirect&bpo=25008]: 将smtpd.py文档标记为实际上已弃用，并添加指向aiosmtpd的指针，这是一个基于asyncio的第三方替代品。

bpo-26355 [https://bugs.python.org/issue?@action=redirect&bpo=26355]: 在每个页面上添加指向相应主要版本文档的规范头部链接。由Matthias Bussonnier提供补丁。

bpo-29349 [https://bugs.python.org/issue?@action=redirect&bpo=29349]: 修复构建文档代码中的Python 2语法。

测试

bpo-28087 [https://bugs.python.org/issue?@action=redirect&bpo=28087]: 在 macOS 上跳过 test_asyncore 和 test_eintr 的 poll 失败。由于某些 macOS 版本上底层系统 poll 函数的未解决问题，在 macOS 上运行时跳过 select.poll 的一些测试。

bpo-29571 [https://bugs.python.org/issue?@action=redirect&bpo=29571]: 为了匹配 re.LOCALE 标志的行为，test_re.test_locale_flag 现在使用 locale.getpreferredencoding(False) 来确定测试正则表达式的候选编码（允许它在默认区域编码是多字节编码时正确跳过测试）

bpo-28950 [https://bugs.python.org/issue?@action=redirect&bpo=28950]: 在 regrtest 命令行参数中禁止将 -j0 与 -T/-l 结合使用。

bpo-28683 [https://bugs.python.org/issue?@action=redirect&bpo=28683]: 修复在Android上为非root用户绑定Unix socket并引发PermissionError的测试。

bpo-26939 [https://bugs.python.org/issue?@action=redirect&bpo=26939]: 添加support.setswitchinterval()函数以修复在Android armv7 qemu模拟器上挂起的test_functools。

构建

bpo-27593 [https://bugs.python.org/issue?@action=redirect&bpo=27593]: 当从仓库构建时，sys.version和platform模块的python_build()、python_branch()和python_revision()函数现在使用git信息而不是hg。

bpo-29572 [https://bugs.python.org/issue?@action=redirect&bpo=29572]: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2k。

bpo-26851 [https://bugs.python.org/issue?@action=redirect&bpo=26851]: 设置Android编译和链接标志。

bpo-28768 [https://bugs.python.org/issue?@action=redirect&bpo=28768]: 修复函数_setmode的隐式声明。由Masayuki Yamamoto提供补丁

bpo-29080 [https://bugs.python.org/issue?@action=redirect&bpo=29080]: 从PCBuild/build.bat中移除对hg.exe的硬依赖

bpo-23903 [https://bugs.python.org/issue?@action=redirect&bpo=23903]: 向PC/python3.def添加遗漏的名称。

bpo-28762 [https://bugs.python.org/issue?@action=redirect&bpo=28762]: lockf()在Android API level 24上可用，但F_LOCK宏在android-ndk-r13中未定义。

bpo-28538 [https://bugs.python.org/issue?@action=redirect&bpo=28538]: 修复因if_nameindex()在Android API level 24上可用但if_nameindex结构未定义而导致的编译错误。

bpo-20211 [https://bugs.python.org/issue?@action=redirect&bpo=20211]: 不要将安装C头文件的目录和安装对象代码库的目录添加到交叉编译搜索路径中。原始由Thomas Petazzoni提供补丁。

bpo-28849 [https://bugs.python.org/issue?@action=redirect&bpo=28849]: 不要在Android上定义sys.implementation._multiarch。

Python 3.6.0 正式版

发布日期: 2016-12-23

自rc2起没有更改

Python 3.6.0 rc2

发布日期: 2016-12-16

核心与内置函数

bpo-28147 [https://bugs.python.org/issue?@action=redirect&bpo=28147]: 修复了分割表字典中的内存泄漏：setattr()不能将合并表转换为分割表。补丁由INADA Naoki编写。

bpo-28990 [https://bugs.python.org/issue?@action=redirect&bpo=28990]: 修复 asyncio SSL 在握手完成前连接关闭时的挂起问题。（由 HoHo-Ho 提供的补丁）

工具/示例

bpo-28770 [https://bugs.python.org/issue?@action=redirect&bpo=28770]: 修复 python-gdb.py 以支持 fastcalls。

Windows

bpo-28896 [https://bugs.python.org/issue?@action=redirect&bpo=28896]: 弃用 WindowsRegistryFinder。

构建

bpo-28898 [https://bugs.python.org/issue?@action=redirect&bpo=28898]: 防止由于 HAVE_LONG_LONG 重定义导致的 gdb 构建错误。

Python 3.6.0 rc1

发布日期: 2016-12-06

核心与内置函数

bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722]: 而不是无声地产生一个不支持方法中零参数 super() 的类，未能将新的``__classcell__``命名空间条目传递给 type.__new__ 现在会导致一个 DeprecationWarning 和一个支持零参数 super() 的类。

bpo-28797 [https://bugs.python.org/issue?@action=redirect&bpo=28797]: 修改类__dict__在一个描述符的__set_name__方法内部，该描述符在那个类内部使用，不再阻止调用其他描述符的__set_name__方法。

bpo-28782 [https://bugs.python.org/issue?@action=redirect&bpo=28782]: 修复了在检查下一条指令是否为YIELD_FROM时 yield from 实现中的一个错误。由WORDCODE(bpo-26647 [https://bugs.python.org/issue?@action=redirect&bpo=26647])引入的回归问题。

库

bpo-27030 [https://bugs.python.org/issue?@action=redirect&bpo=27030]: 再次允许 re.sub() 替换模板中的未知转义。但它们仍然被弃用，并将在 3.7 中禁用。

bpo-28835 [https://bugs.python.org/issue?@action=redirect&bpo=28835]: 修复了 warnings.catch_warnings() 中引入的一个回归问题：如果在上下文管理器内部覆盖了 warnings.showwarning()，则调用它。

bpo-27172 [https://bugs.python.org/issue?@action=redirect&bpo=27172]: 为了协助从 2.7 版本升级，之前文档中关于 inspect.getfullargspec() 的弃用已被撤销。在 Python 2.7 分支不再官方支持后，可能会重新考虑这一决定。

bpo-26273 [https://bugs.python.org/issue?@action=redirect&bpo=26273]: Add new socket.TCP_CONGESTION (Linux 2.6.13) and socket.TCP_USER_TIMEOUT (Linux 2.6.37) constants. Patch written by Omar Sandoval.

bpo-24142 [https://bugs.python.org/issue?@action=redirect&bpo=24142]: 读取损坏的配置文件会使configparser处于无效状态。原始补丁由Florian Höch提供。

bpo-28843 [https://bugs.python.org/issue?@action=redirect&bpo=28843]: 修复 asyncio C Task 以处理异常的 __traceback__。

C API

bpo-28808 [https://bugs.python.org/issue?@action=redirect&bpo=28808]: PyUnicode_CompareWithASCIIString() 现在永远不会引发异常。

文档

bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722]: 数据模型参考和 What's New 指南中的移植部分现在涵盖了自定义元类为了完全支持 PEP 487 [https://www.python.org/dev/peps/pep-0487] 和零参数 super() 所需的额外 __classcell__ 处理。

工具/示例

bpo-28023 [https://bugs.python.org/issue?@action=redirect&bpo=28023]: 修复python-gdb.py不支持新字典实现的问题。

Python 3.6.0 beta 4

发布日期: 2016-11-21

核心与内置函数

bpo-28532 [https://bugs.python.org/issue?@action=redirect&bpo=28532]: 当提供-V选项两次时显示sys.version。

bpo-27100 [https://bugs.python.org/issue?@action=redirect&bpo=27100]: with语句现在在检查__exit__之前先检查__enter__。当两种方法都缺失时，这会给出不那么令人困惑的错误信息。由Jonathan Ellington提供补丁。

bpo-28746 [https://bugs.python.org/issue?@action=redirect&bpo=28746]: 在没有ioctl FIOCLEX和FIONCLEX命令的平台上修复set_inheritable()文件描述符方法。

bpo-26920 [https://bugs.python.org/issue?@action=redirect&bpo=26920]: 在没有langinfo的平台上修复初始化解释器时未获取区域设置的字符集的问题。

bpo-28648 [https://bugs.python.org/issue?@action=redirect&bpo=28648]: 修复了在Mac OS X上调试版本中解码星体字符时Py_DecodeLocale()崩溃的问题。补丁由Xiang Zhang提供。

bpo-19398 [https://bugs.python.org/issue?@action=redirect&bpo=19398]: 在编译时PYTHONPATH组件为空的情况下，不再向sys.path组件添加额外的斜杠。

bpo-28665 [https://bugs.python.org/issue?@action=redirect&bpo=28665]: 将STORE_DEREF操作码的速度提高40%。

bpo-28583 [https://bugs.python.org/issue?@action=redirect&bpo=28583]: PyDict_SetDefault在需要时未合并分割表。由Xiang Zhang提供补丁。

bpo-27243 [https://bugs.python.org/issue?@action=redirect&bpo=27243]: 将 PendingDeprecationWarning 改为 DeprecationWarning。如问题中达成的共识，__aiter__ 返回一个可等待对象应在 3.5 中导致 PendingDeprecationWarning，在 3.6 中导致 DeprecationWarning。

bpo-26182 [https://bugs.python.org/issue?@action=redirect&bpo=26182]: 修复在引发DeprecationWarning的代码中的内存泄漏。

bpo-28721 [https://bugs.python.org/issue?@action=redirect&bpo=28721]: 修复异步生成器的aclose()和athrow()以正确处理StopAsyncIteration传播。

库

bpo-28752 [https://bugs.python.org/issue?@action=redirect&bpo=28752]: 恢复了 datetime 对象的 __reduce__() 方法。

bpo-28727 [https://bugs.python.org/issue?@action=redirect&bpo=28727]: 正则表达式模式，由 re.compile() 创建的 _sre.SRE_Pattern 对象，现在可以比较（仅限 x==y 和 x!=y 操作符）。这一更改应该修复了 bpo-18383 [https://bugs.python.org/issue?@action=redirect&bpo=18383]：当 warnings 模块重新加载时不要重复警告过滤器（通常只在单元测试中这样做）。

bpo-20572 [https://bugs.python.org/issue?@action=redirect&bpo=20572]: subprocess.Popen.wait 方法的未记录参数 endtime 现在会引发 DeprecationWarning。

bpo-25659 [https://bugs.python.org/issue?@action=redirect&bpo=25659]: 在 ctypes 中，防止在抽象类（如 Array）上调用 from_buffer() 和 from_buffer_copy() 方法时崩溃。

bpo-19717 [https://bugs.python.org/issue?@action=redirect&bpo=19717]: 使Path.resolve()在不存在的路径上也能成功。由Vajrasky Kok提供补丁。

bpo-28563 [https://bugs.python.org/issue?@action=redirect&bpo=28563]: 修复了在gettext模块中处理复数形式选择时可能导致的DoS和任意代码执行问题。表达式解析器现在支持GNU gettext所支持的精确语法。

bpo-28387 [https://bugs.python.org/issue?@action=redirect&bpo=28387]: 修复了当垃圾收集器在其他线程中调用时，_io.TextIOWrapper解构器可能崩溃的问题。基于Sebastian Cufre的补丁。

bpo-28600 [https://bugs.python.org/issue?@action=redirect&bpo=28600]: 优化 loop.call_soon。

bpo-28613 [https://bugs.python.org/issue?@action=redirect&bpo=28613]: 修复 get_event_loop() 在协程/回调中调用时返回当前循环的问题。

bpo-28634 [https://bugs.python.org/issue?@action=redirect&bpo=28634]: 修复 asyncio.isfuture() 以支持 unittest.Mock。

bpo-26081 [https://bugs.python.org/issue?@action=redirect&bpo=26081]: 修复 _asyncio.Future.__iter__().throw 中的 refleak。

bpo-28639 [https://bugs.python.org/issue?@action=redirect&bpo=28639]: 修复 inspect.isawaitable 始终返回布尔值，由 Justin Mayfield 提供补丁。

bpo-28652 [https://bugs.python.org/issue?@action=redirect&bpo=28652]: 使循环方法拒绝它们不支持的套接字类型。

bpo-28653 [https://bugs.python.org/issue?@action=redirect&bpo=28653]: 修复 functools.lru_cache 中的 refleak。

bpo-28703 [https://bugs.python.org/issue?@action=redirect&bpo=28703]: 修复 asyncio.iscoroutinefunction 以处理 Mock 对象。

bpo-28704 [https://bugs.python.org/issue?@action=redirect&bpo=28704]: 修复 create_unix_server 以支持类路径对象 (PEP 519)。

bpo-28720 [https://bugs.python.org/issue?@action=redirect&bpo=28720]: 添加 collections.abc.AsyncGenerator。

文档

bpo-28513 [https://bugs.python.org/issue?@action=redirect&bpo=28513]: 记录了 zipfile 的命令行接口。

测试

bpo-28666 [https://bugs.python.org/issue?@action=redirect&bpo=28666]: 现在test.support.rmtree能够删除不可写或不可读的目录。

bpo-23839 [https://bugs.python.org/issue?@action=redirect&bpo=23839]: 现在在运行每个测试文件之前清除各种缓存。

构建

bpo-10656 [https://bugs.python.org/issue?@action=redirect&bpo=10656]: 修复AIX上的树外构建。由Tristan Carel和Michael Haubenwallner提供补丁。

bpo-26359 [https://bugs.python.org/issue?@action=redirect&bpo=26359]: 将--with-optimiations重命名为--enable-optimizations。

bpo-28676 [https://bugs.python.org/issue?@action=redirect&bpo=28676]: 防止在macOS上出现缺失'getentropy'声明的警告。由Gareth Rees提供补丁。

Python 3.6.0 beta 3

发布日期: 2016-10-31

核心与内置函数

bpo-28128 [https://bugs.python.org/issue?@action=redirect&bpo=28128]: 无效的str和byte转义序列的弃用警告现在会打印出关于错误发生位置的更好信息。由Serhiy Storchaka和Eric Smith提供补丁。

bpo-28509 [https://bugs.python.org/issue?@action=redirect&bpo=28509]: dict.update()不再分配不必要的大内存。

bpo-28426 [https://bugs.python.org/issue?@action=redirect&bpo=28426]: 修复了调试版本中PyUnicode_AsDecodedObject()潜在的崩溃问题。

bpo-28517 [https://bugs.python.org/issue?@action=redirect&bpo=28517]: 修复了窥孔优化器中的一个偏移错误，该错误导致保留无法到达的代码。

bpo-28214 [https://bugs.python.org/issue?@action=redirect&bpo=28214]: 改进了对有问题的 __set_name__ 属性的异常报告。

bpo-23782 [https://bugs.python.org/issue?@action=redirect&bpo=23782]: 修复了 _PyTraceback_Add() 中可能的内存泄漏和 PyTraceBack_Here() 中的异常丢失问题。

bpo-28471 [https://bugs.python.org/issue?@action=redirect&bpo=28471]: 修复 socket.setblocking 中“Python 内存分配器在未持有 GIL 的情况下被调用”的崩溃问题。

库

bpo-27517 [https://bugs.python.org/issue?@action=redirect&bpo=27517]: LZMA压缩器和解压器在两次接收到空数据时不再抛出异常。补丁由Benjamin Fogle提供。

bpo-28549 [https://bugs.python.org/issue?@action=redirect&bpo=28549]: 修复了curses的addch()在使用ncurses6时的段错误。

bpo-28449 [https://bugs.python.org/issue?@action=redirect&bpo=28449]: tarfile.open()以模式"r"或"r:"现在会先尝试以压缩方式打开tar文件，再尝试无压缩方式打开。否则在使用ignore_zeros=True时有50%的几率失败。

bpo-23262 [https://bugs.python.org/issue?@action=redirect&bpo=23262]: webbrowser模块现在支持Firefox 36+及衍生浏览器。基于Oleg Broytman的补丁。

bpo-27939 [https://bugs.python.org/issue?@action=redirect&bpo=27939]: 修复了tkinter.ttk.LabeledScale和tkinter.Scale中由于在Tk内部将比例表示为浮点值而导致的错误。如果底层Tk变量设置为浮点值，tkinter.IntVar现在可以正常工作。

bpo-18844 [https://bugs.python.org/issue?@action=redirect&bpo=18844]: random.choices() 中指定权重的各种方式现在产生相同的结果序列。

bpo-28255 [https://bugs.python.org/issue?@action=redirect&bpo=28255]: calendar.TextCalendar().prmonth() 在打印月历后不再在新行的开头打印空格。由 Xiang Zhang 提供补丁。

bpo-20491 [https://bugs.python.org/issue?@action=redirect&bpo=20491]: textwrap.TextWrapper 类现在支持不换行空格。基于 Kaarle Ritvanen 的补丁。

bpo-28353 [https://bugs.python.org/issue?@action=redirect&bpo=28353]: os.fwalk() 不再因损坏的链接而失败。

bpo-28430 [https://bugs.python.org/issue?@action=redirect&bpo=28430]: 修复了 C 实现的 asyncio.Future 迭代器不接受非 None 值传递给 it.send(val) 的问题。

bpo-27025 [https://bugs.python.org/issue?@action=redirect&bpo=27025]: 为提升可读性，Tkinter 部件的生成名称现在以 "!" 前缀开头。

bpo-25464 [https://bugs.python.org/issue?@action=redirect&bpo=25464]: 通过为 Tix 库的 bug 添加变通方法，修复了 tkinter.tix 模块中的 HList.header_exists()。

bpo-28488 [https://bugs.python.org/issue?@action=redirect&bpo=28488]: shutil.make_archive() 不再向 ZIP 归档添加 "./" 条目。

bpo-25953 [https://bugs.python.org/issue?@action=redirect&bpo=25953]: re.sub() 现在即使在字符串中未找到模式，也会为替换模板中的无效数字组引用引发错误。无效组引用的错误消息现在包括组索引和引用的位置。基于 SilentGhost 的补丁。

bpo-18219 [https://bugs.python.org/issue?@action=redirect&bpo=18219]: 为大量列优化 csv.DictWriter。Mariatta Wijaya 的补丁。

bpo-28448 [https://bugs.python.org/issue?@action=redirect&bpo=28448]: 修复了 C 实现的 asyncio.Future 在 Windows 上不工作的问题。

bpo-28480 [https://bugs.python.org/issue?@action=redirect&bpo=28480]: 修复在禁用多线程时构建 socket 模块时的错误。

bpo-24452 [https://bugs.python.org/issue?@action=redirect&bpo=24452]: 使 webbrowser 支持 Mac OS X 上的 Chrome。

bpo-20766 [https://bugs.python.org/issue?@action=redirect&bpo=20766]: 修复了 pdb 在处理 SIGINT 处理器时的引用泄漏问题。

bpo-28492 [https://bugs.python.org/issue?@action=redirect&bpo=28492]: 修复 _asyncio.Future 中如何引发 StopIteration 异常。

bpo-28500 [https://bugs.python.org/issue?@action=redirect&bpo=28500]: 修复 asyncio 以处理来自另一个线程的异步生成器 GC。

bpo-26923 [https://bugs.python.org/issue?@action=redirect&bpo=26923]: 修复 asyncio.Gather 一旦所有子项完成就拒绝被取消的问题。由 Johannes Ebke 提供补丁。

bpo-26796 [https://bugs.python.org/issue?@action=redirect&bpo=26796]: 不要为默认的线程池执行器配置工作线程数量。初始由 Hans Lawrenz 提供补丁。

bpo-28544 [https://bugs.python.org/issue?@action=redirect&bpo=28544]: 用 C 实现 asyncio.Task。

Windows

bpo-28522 [https://bugs.python.org/issue?@action=redirect&bpo=28522]: 修复 getpathp.c 中错误处理的缓冲区重新分配

构建

bpo-28444 [https://bugs.python.org/issue?@action=redirect&bpo=28444]: 修复交叉编译时缺少扩展模块的问题。

bpo-28208 [https://bugs.python.org/issue?@action=redirect&bpo=28208]: 更新Windows构建和OS X安装程序以使用SQLite 3.14.2。

bpo-28248 [https://bugs.python.org/issue?@action=redirect&bpo=28248]: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2j。

测试

bpo-26944 [https://bugs.python.org/issue?@action=redirect&bpo=26944]: 修复Android上的test_posix，其中'id -G'完全错误或缺少有效的gid。

bpo-28409 [https://bugs.python.org/issue?@action=redirect&bpo=28409]: regrtest: 修复命令行参数的解析器。

Python 3.6.0 beta 2

发布日期: 2016-10-10

核心与内置函数

bpo-28183 [https://bugs.python.org/issue?@action=redirect&bpo=28183]: 优化并清理了字典迭代。

bpo-26081 [https://bugs.python.org/issue?@action=redirect&bpo=26081]: 添加了 asyncio.Future 的 C 实现。原始由 Yury Selivanov 提供补丁。

bpo-28379 [https://bugs.python.org/issue?@action=redirect&bpo=28379]: 为 PyUnicode_CopyCharacters() 添加了健全性检查和测试。由 Xiang Zhang 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: 长范围迭代器的类型现在注册为 Iterator。由 Oren Milman 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: 现在不推荐通过调用 range_iterator 类型来创建 range_iterator 实例。由 Oren Milman 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: range_iterator 的构造函数现在检查步长不为 0。由 Oren Milman 提供补丁。

bpo-26906 [https://bugs.python.org/issue?@action=redirect&bpo=26906]: 现在解析未初始化类型的特殊方法会导致类型的隐式初始化而不是失败。

bpo-18287 [https://bugs.python.org/issue?@action=redirect&bpo=18287]: PyType_Ready() 现在检查 tp_name 是否为 NULL。原始由 Niklas Koep 提供补丁。

bpo-24098 [https://bugs.python.org/issue?@action=redirect&bpo=24098]: 修复了在编译过程中 AST 被更改时可能发生的崩溃。

bpo-28201 [https://bugs.python.org/issue?@action=redirect&bpo=28201]: 当哈希值具有相同的低位时，字典减少了哈希表中第二次冲突的可能性。

bpo-28350 [https://bugs.python.org/issue?@action=redirect&bpo=28350]: 不再对含有空字符的字符串常量进行内部化。

bpo-26617 [https://bugs.python.org/issue?@action=redirect&bpo=26617]: 修复了在弱引用回调过程中运行垃圾收集时发生的崩溃。

bpo-27942 [https://bugs.python.org/issue?@action=redirect&bpo=27942]: 现在在元组和冻结集合中递归内部化字符串常量。

bpo-21578 [https://bugs.python.org/issue?@action=redirect&bpo=21578]: 修复了当 ImportError 使用无效关键字参数调用时误导性的错误消息。

bpo-28203 [https://bugs.python.org/issue?@action=redirect&bpo=28203]: 修复了 complex(1.0, {2:3}) 错误消息中的不正确类型。补丁由 Soumya Sharma 提供。

bpo-28086 [https://bugs.python.org/issue?@action=redirect&bpo=28086]: 元组子类型的单个可变位置参数现在被转换为确切的元组，而不是原封不动地传递给 C 定义的函数。

bpo-28214 [https://bugs.python.org/issue?@action=redirect&bpo=28214]: 现在 __set_name__ 是在类上查找而不是在实例上查找。

bpo-27955 [https://bugs.python.org/issue?@action=redirect&bpo=27955]: 当 getrandom() 系统调用因 EPERM 失败时（例如被 SECCOMP 阻止时），回退读取 /dev/urandom 设备。

bpo-28192 [https://bugs.python.org/issue?@action=redirect&bpo=28192]: 在隔离模式下不导入readline。

升级内部unicode数据库至Unicode 9.0.0版本。

bpo-28131 [https://bugs.python.org/issue?@action=redirect&bpo=28131]: 修复zipimport的compile_source()中的回归问题。zipimport应使用与解释器相同的优化级别。

bpo-28126 [https://bugs.python.org/issue?@action=redirect&bpo=28126]: 用memcpy()替换Py_MEMCPY。Visual Studio能正确优化memcpy()。

bpo-28120 [https://bugs.python.org/issue?@action=redirect&bpo=28120]: Fix dict.pop() for splitted dictionary when trying to remove a "pending key" (Not yet inserted in split-table). Patch by Xiang Zhang.

bpo-26182 [https://bugs.python.org/issue?@action=redirect&bpo=26182]: 当async和await关键字被用作变量/属性/类/函数名时，发出DeprecationWarning。

库

bpo-27998 [https://bugs.python.org/issue?@action=redirect&bpo=27998]: 修复了 Windows 上 os.scandir() 对字节路径的支持。由 Eryk Sun 提供补丁。

bpo-28317 [https://bugs.python.org/issue?@action=redirect&bpo=28317]: 反汇编器现在解码 FORMAT_VALUE 参数。

bpo-26293 [https://bugs.python.org/issue?@action=redirect&bpo=26293]: 修复了不从文件开头开始写入 ZIP 文件的问题。ZIP 文件中的偏移量现在相对于存档的开始，以符合规范。

bpo-28380 [https://bugs.python.org/issue?@action=redirect&bpo=28380]: unittest.mock 的 Mock autospec 函数现在正确支持 assert_called、assert_not_called 和 assert_called_once。

bpo-27181 [https://bugs.python.org/issue?@action=redirect&bpo=27181]: 移除 statistics.geometric_mean 并推迟至 3.7 版本。

bpo-28229 [https://bugs.python.org/issue?@action=redirect&bpo=28229]: lzma 模块现在支持 pathlib。

bpo-28321 [https://bugs.python.org/issue?@action=redirect&bpo=28321]: 修复了在 plistlib 中使用二进制格式写入非 BMP 字符的问题。

bpo-28225 [https://bugs.python.org/issue?@action=redirect&bpo=28225]: bz2 模块现在支持 pathlib。初始由 Ethan Furman 提供补丁。

bpo-28227 [https://bugs.python.org/issue?@action=redirect&bpo=28227]: gzip 现在支持 pathlib。由 Ethan Furman 提供补丁。

bpo-27358 [https://bugs.python.org/issue?@action=redirect&bpo=27358]: 优化了合并可变关键字参数的过程，并改进了当传递非映射作为可变关键字参数时的错误信息。

bpo-28257 [https://bugs.python.org/issue?@action=redirect&bpo=28257]: 改进了当传递非可迭代对象作为可变位置参数时的错误信息。添加了操作码 BUILD_TUPLE_UNPACK_WITH_CALL。

bpo-28322 [https://bugs.python.org/issue?@action=redirect&bpo=28322]: 修复了当从错误的 pickle 数据反序列化 itertools 对象时可能发生的崩溃。基于 John Leitch 的补丁。

bpo-28228 [https://bugs.python.org/issue?@action=redirect&bpo=28228]: imghdr 现在支持 pathlib。

bpo-28226 [https://bugs.python.org/issue?@action=redirect&bpo=28226]: compileall 现在支持 pathlib。

bpo-28314 [https://bugs.python.org/issue?@action=redirect&bpo=28314]: 修复了 xml.etree.ElementTree.Element 的 getiterator() 方法的函数声明（C 标志）。

bpo-28148 [https://bugs.python.org/issue?@action=redirect&bpo=28148]: 停止在 time 模块中使用 localtime() 和 gmtime()。引入了平台无关的 _PyTime_localtime API，该 API 类似于 POSIX 的 localtime_r，但在所有平台上都可用。由 Ed Schouten 提供补丁。

bpo-28253 [https://bugs.python.org/issue?@action=redirect&bpo=28253]: 修复了极端月份（0001-01和9999-12）的日历功能。重新实现了itermonthdays()和itermonthdays2()方法，使其不再调用可能导致datetime.date下溢/溢出的itermonthdates()。

bpo-28275 [https://bugs.python.org/issue?@action=redirect&bpo=28275]: 修复了LZMADecompressor和BZ2Decompressor类中decompress()方法可能存在的释放后使用问题。原始由John Leitch提供补丁。

bpo-27897 [https://bugs.python.org/issue?@action=redirect&bpo=27897]: 修复了如果传递无效的字符串类似对象作为名称时，sqlite3.Connection.create_collation()可能崩溃的问题。由Xiang Zhang提供补丁。

bpo-18844 [https://bugs.python.org/issue?@action=redirect&bpo=18844]: random.choices()现在将k作为仅关键字参数，以提高常见情况的可读性，并与其他语言中使用的签名保持一致。

bpo-18893 [https://bugs.python.org/issue?@action=redirect&bpo=18893]: 修复了Lib/ctypes/macholib/dyld.py中无效的异常处理。由Madison May提供补丁。

bpo-27611 [https://bugs.python.org/issue?@action=redirect&bpo=27611]: 修复了tkinter.tix模块中对默认根窗口的支持。在DisplayStyle构造函数中添加了master参数。

bpo-27348 [https://bugs.python.org/issue?@action=redirect&bpo=27348]: 在traceback模块中，恢复了类似于"Exception: None"的异常消息的格式化。这修复了3.5a2中引入的回归问题。

bpo-25651 [https://bugs.python.org/issue?@action=redirect&bpo=25651]: Allow falsy values to be used for msg parameter of subTest().

bpo-27778 [https://bugs.python.org/issue?@action=redirect&bpo=27778]: 修复了当getrandom()被信号中断且信号处理程序引发Python异常时，os.getrandom()中的内存泄漏问题。

bpo-28200 [https://bugs.python.org/issue?@action=redirect&bpo=28200]: 修复了Windows上os模块中的内存泄漏问题（修复了path_converter()函数）。

bpo-25400 [https://bugs.python.org/issue?@action=redirect&bpo=25400]: RobotFileParser现在正确返回crawl_delay和request_rate的默认值。初始由Peter Wirtz提供补丁。

bpo-27932 [https://bugs.python.org/issue?@action=redirect&bpo=27932]: 防止win32_ver()中的内存泄漏。

修复socket._sendfile_use_sendfile中的UnboundLocalError。

bpo-28075 [https://bugs.python.org/issue?@action=redirect&bpo=28075]: 在Windows的os.stat()实现中检查ERROR_ACCESS_DENIED。由Eryk Sun提供补丁。

bpo-22493 [https://bugs.python.org/issue?@action=redirect&bpo=22493]: 现在，通过在正则表达式中间使用内联标志发出的警告消息包含（截断的）正则表达式模式。由Tim Graham提供补丁。

bpo-25270 [https://bugs.python.org/issue?@action=redirect&bpo=25270]: 防止在传递空字节串时codecs.escape_encode()引发SystemError。

bpo-28181 [https://bugs.python.org/issue?@action=redirect&bpo=28181]: 通过HTTPS获取antigravity。由Kaartic Sivaraam提供补丁。

bpo-25895 [https://bugs.python.org/issue?@action=redirect&bpo=25895]: 在urllib.parse.urljoin中启用WebSocket URL方案。由Gergely Imreh和Markus Holtermann提供补丁。

bpo-28114 [https://bugs.python.org/issue?@action=redirect&bpo=28114]: 修复当env包含字节字符串时parse_envlist()崩溃的问题。由Eryk Sun提供补丁。

bpo-27599 [https://bugs.python.org/issue?@action=redirect&bpo=27599]: 修复binascii.b2a_qp()和binascii.a2b_qp()中的缓冲区溢出问题。

bpo-27906 [https://bugs.python.org/issue?@action=redirect&bpo=27906]: 在高TCP流量期间修复socket接受耗尽问题。由Kevin Conway提供补丁。

bpo-28174 [https://bugs.python.org/issue?@action=redirect&bpo=28174]: 处理当SO_REUSEPORT未被正确支持时的情况。由Seth Michael Larson提供补丁。

bpo-26654 [https://bugs.python.org/issue?@action=redirect&bpo=26654]: 在asyncio.Handle.__repr__中检查functools.partial。由iceboy提供补丁。

bpo-26909 [https://bugs.python.org/issue?@action=redirect&bpo=26909]: 修复asyncio中慢速管道IO的问题。由INADA Naoki提供补丁。

bpo-28176 [https://bugs.python.org/issue?@action=redirect&bpo=28176]: 修复asyncio.SelectorLoop.sock_connect中的回调竞争问题。

bpo-27759 [https://bugs.python.org/issue?@action=redirect&bpo=27759]: 修复选择器错误保留无效文件描述符的问题。由Mark Williams提供补丁。

bpo-28368 [https://bugs.python.org/issue?@action=redirect&bpo=28368]: 如果子监视器没有附加循环，则拒绝监视进程。由Vincent Michel提供补丁。

bpo-28369 [https://bugs.python.org/issue?@action=redirect&bpo=28369]: 当传输的FD与add_reader、add_writer等一起使用时引发RuntimeError。

bpo-28370 [https://bugs.python.org/issue?@action=redirect&bpo=28370]: 加速asyncio.StreamReader.readexactly。由Коренберг Марк提供补丁。

bpo-28371 [https://bugs.python.org/issue?@action=redirect&bpo=28371]: 弃用将asyncio.Handles传递给run_in_executor的做法。

bpo-28372 [https://bugs.python.org/issue?@action=redirect&bpo=28372]: 修复asyncio以支持非python协程的格式化。

bpo-28399 [https://bugs.python.org/issue?@action=redirect&bpo=28399]: 在绑定前从文件系统中移除UNIX套接字。由Коренберг Марк提供补丁。

bpo-27972 [https://bugs.python.org/issue?@action=redirect&bpo=27972]: 禁止Tasks等待自身。

Windows

bpo-28402 [https://bugs.python.org/issue?@action=redirect&bpo=28402]: 为 Windows 上的标准库添加签名目录文件。

bpo-28333 [https://bugs.python.org/issue?@action=redirect&bpo=28333]: 为 ps1/ps2 和 input() 提示启用 Unicode。（由 Eryk Sun 提供补丁）

bpo-28251 [https://bugs.python.org/issue?@action=redirect&bpo=28251]: 改进 Windows 上的帮助手册。

bpo-28110 [https://bugs.python.org/issue?@action=redirect&bpo=28110]: launcher.msi 在 32 位和 64 位之间有不同的产品代码

bpo-28161 [https://bugs.python.org/issue?@action=redirect&bpo=28161]: 以写权限打开 CON 失败

bpo-28162 [https://bugs.python.org/issue?@action=redirect&bpo=28162]: 如果第一行以 Ctrl+Z 开头，WindowsConsoleIO readall() 失败

bpo-28163 [https://bugs.python.org/issue?@action=redirect&bpo=28163]: WindowsConsoleIO fileno() 将错误的标志传递给 _open_osfhandle

bpo-28164 [https://bugs.python.org/issue?@action=redirect&bpo=28164]: 对于各种路径，_PyIO_get_console_type 失败

bpo-28137 [https://bugs.python.org/issue?@action=redirect&bpo=28137]: 将 Windows 路径文件重命名为 ._pth

bpo-28138 [https://bugs.python.org/issue?@action=redirect&bpo=28138]: Windows ._pth 文件应允许导入站点

C API

bpo-28426 [https://bugs.python.org/issue?@action=redirect&bpo=28426]: 已弃用未记录的函数 PyUnicode_AsEncodedObject()、PyUnicode_AsDecodedObject()、PyUnicode_AsDecodedUnicode() 和 PyUnicode_AsEncodedUnicode()。

构建

bpo-28258 [https://bugs.python.org/issue?@action=redirect&bpo=28258]: 修复了在爱沙尼亚语言环境下构建的问题（Makefile中的python-config和distclean目标）。由Arfrever Frehtes Taifersar Arahesis提供补丁。

bpo-26661 [https://bugs.python.org/issue?@action=redirect&bpo=26661]: setup.py现在可以检测到带有multiarch包装的系统libffi。

bpo-15819 [https://bugs.python.org/issue?@action=redirect&bpo=15819]: 移除了为在源码树外构建而冗余的包含搜索目录选项。

测试

bpo-28217 [https://bugs.python.org/issue?@action=redirect&bpo=28217]: 添加_testconsole模块以测试控制台输入。

Python 3.6.0 beta 1

发布日期： 2016-09-12

核心与内置函数

bpo-23722 [https://bugs.python.org/issue?@action=redirect&bpo=23722]: 由零参数 super() 使用的 __class__ 单元现在从 type.__new__ 而不是 __build_class__ 初始化，因此在类创建期间从元类方法调用时，依赖于此的类方法现在将正常工作。由 Martin Teichmann 提供补丁。

bpo-25221 [https://bugs.python.org/issue?@action=redirect&bpo=25221]: 当 Python 编译时设置 NSMALLPOSINTS = 0 时，修复 PyLong_FromLong(0) 的损坏结果。

bpo-27080 [https://bugs.python.org/issue?@action=redirect&bpo=27080]: 实现 PEP 515 [https://www.python.org/dev/peps/pep-0515] 的格式化支持。初始由 Chris Angelico 提供补丁。

bpo-27199 [https://bugs.python.org/issue?@action=redirect&bpo=27199]: 在 tarfile 中，公开 copyfileobj 的 bufsize 以提高吞吐量。由 Jason Fried 提供补丁。

bpo-27948 [https://bugs.python.org/issue?@action=redirect&bpo=27948]: 在 f-字符串中，仅允许在花括号内（表达式所在处）使用反斜杠。这是与 3.6 alpha 版本的破坏性变更，其中反斜杠允许在 f-字符串的任何地方使用。同时，要求 f-字符串内的表达式必须包围在字面花括号内，而不是像 f'\x7b"hi"\x7d' 这样的转义。

bpo-28046 [https://bugs.python.org/issue?@action=redirect&bpo=28046]: 从 sys.path 中移除平台特定的目录。

bpo-28071 [https://bugs.python.org/issue?@action=redirect&bpo=28071]: 为与空集的差异添加早期退出。

bpo-25758 [https://bugs.python.org/issue?@action=redirect&bpo=25758]: 防止 zipimport 不必要地编码文件名（由 Eryk Sun 提供补丁）

bpo-25856 [https://bugs.python.org/issue?@action=redirect&bpo=25856]: 扩展类和函数的 __module__ 属性现在被 interned。这导致协议 4 的 pickle 数据更加紧凑。

bpo-27213 [https://bugs.python.org/issue?@action=redirect&bpo=27213]: 重做 CALL_FUNCTION* 操作码以产生更短更高效的字节码。补丁由 Demur Rumed 提供，设计由 Serhiy Storchaka 完成，由 Serhiy Storchaka 和 Victor Stinner 审核。

bpo-26331 [https://bugs.python.org/issue?@action=redirect&bpo=26331]: 实现 PEP 515 [https://www.python.org/dev/peps/pep-0515] 的词法分析支持。由 Georg Brandl 提供补丁。

bpo-27999 [https://bugs.python.org/issue?@action=redirect&bpo=27999]: 将“使用后全局”设为 SyntaxError，同样适用于 nonlocal。由 Ivan Levkivskyi 提供补丁。

bpo-28003 [https://bugs.python.org/issue?@action=redirect&bpo=28003]: 实现 PEP 525 [https://www.python.org/dev/peps/pep-0525] -- 异步生成器。

bpo-27985 [https://bugs.python.org/issue?@action=redirect&bpo=27985]: 实现 PEP 526 [https://www.python.org/dev/peps/pep-0526] -- 变量注解语法。由 Ivan Levkivskyi 提供补丁。

bpo-26058 [https://bugs.python.org/issue?@action=redirect&bpo=26058]: 为内置字典类型添加一个新的私有版本，每次字典创建和每次字典更改时递增。PEP 509的实现。

bpo-27364 [https://bugs.python.org/issue?@action=redirect&bpo=27364]: 现在，不是一个有效转义序列的反斜杠字符对会生成一个DeprecationWarning。补丁由Emanuel Barry提供。

bpo-27350 [https://bugs.python.org/issue?@action=redirect&bpo=27350]: dict implementation is changed like PyPy. It is more compact and preserves insertion order. (Concept developed by Raymond Hettinger and patch by Inada Naoki.)

bpo-27911 [https://bugs.python.org/issue?@action=redirect&bpo=27911]: 移除 exec_builtin_or_dynamic() 中不必要的错误检查。

bpo-27078 [https://bugs.python.org/issue?@action=redirect&bpo=27078]: 添加了BUILD_STRING操作码。优化了f-字符串的评估。

bpo-17884 [https://bugs.python.org/issue?@action=redirect&bpo=17884]: Python现在要求系统支持inttypes.h和stdint.h。

bpo-27961 [https://bugs.python.org/issue?@action=redirect&bpo=27961]: 要求平台支持 long long。Python多年来已不再编译不支持 long long 的版本，因此这基本上是一个形式上的要求。

bpo-27355 [https://bugs.python.org/issue?@action=redirect&bpo=27355]: 移除了对Windows CE的支持。它从未完成，而且Windows CE不再是Python的相关平台。

实现 PEP 523 [https://www.python.org/dev/peps/pep-0523]。

bpo-27870 [https://bugs.python.org/issue?@action=redirect&bpo=27870]: 零的大整数左移不再尝试分配大量内存。

bpo-25402 [https://bugs.python.org/issue?@action=redirect&bpo=25402]: 在整数到十进制字符串的转换中，改进了对所需中间内存的估计，并移除了一个不必要的严格溢出检查。由Serhiy Storchaka提供补丁。

bpo-27214 [https://bugs.python.org/issue?@action=redirect&bpo=27214]: 在long_invert中，更加小心地修改由long_add返回的对象，并移除了对小long的不必要检查。感谢Oren Milman的分析和补丁。

bpo-27506 [https://bugs.python.org/issue?@action=redirect&bpo=27506]: 支持通过关键字传递bytes/bytearray.translate()的"delete"参数。

bpo-27812 [https://bugs.python.org/issue?@action=redirect&bpo=27812]: 正确清除生成器帧对生成器的反向引用，以防止frame.clear()中的崩溃。

bpo-27811 [https://bugs.python.org/issue?@action=redirect&bpo=27811]: 修复了一个在启用警告即错误时，未等待的协程被最终化时崩溃的问题。

bpo-27587 [https://bugs.python.org/issue?@action=redirect&bpo=27587]: 修复了PVS-Studio发现的另一个问题：在_PyState_AddModule()中使用'def'后的空指针检查。初始由Christian Heimes提供补丁。

bpo-27792 [https://bugs.python.org/issue?@action=redirect&bpo=27792]: 现在对 bool 和其他 int 子类应用的模运算总是返回一个 int。以前返回类型依赖于输入值。由 Xiang Zhang 提供补丁。

bpo-26984 [https://bugs.python.org/issue?@action=redirect&bpo=26984]: int() 现在总是返回一个精确的 int 实例。

bpo-25604 [https://bugs.python.org/issue?@action=redirect&bpo=25604]: 修复了整数真除法中的一个次要错误；这个错误可能导致在具有不可靠 ldexp 实现的平台上出现 off-by-one-ulp 结果。

bpo-24254 [https://bugs.python.org/issue?@action=redirect&bpo=24254]: 默认情况下，使类定义命名空间有序。

bpo-27662 [https://bugs.python.org/issue?@action=redirect&bpo=27662]: 修复了 List_New 中的一个溢出检查：原始代码检查的是 Py_SIZE_MAX 而不是正确的上限 Py_SSIZE_T_MAX。由 Xiang Zhang 提供补丁。

bpo-27782 [https://bugs.python.org/issue?@action=redirect&bpo=27782]: 多阶段扩展模块导入现在正确地允许使用 m_methods 字段来向 Py_create_mod 返回的非模块类型实例添加模块级函数。由 Xiang Zhang 提供补丁。

bpo-27936 [https://bugs.python.org/issue?@action=redirect&bpo=27936]: round() 函数对某些类型接受第二个 None 参数，但对其他类型不接受。通过接受所有数值类型的 None 来修复这种不一致性。

bpo-27487 [https://bugs.python.org/issue?@action=redirect&bpo=27487]: 如果在导入父包之后但在执行子模块之前，在 sys.modules 中找到了 "python -m" 或 runpy.run_module() 的子模块参数，则发出警告。

bpo-27157 [https://bugs.python.org/issue?@action=redirect&bpo=27157]: 使只有 type() 本身接受单参数形式。由 Eryk Sun 和 Emanuel Barry 提供补丁。

bpo-27558 [https://bugs.python.org/issue?@action=redirect&bpo=27558]: 修复 "raise" 语句实现中的一个 SystemError。在一个全新的线程中，引发一个 RuntimeError，因为没有活动的异常可以重新引发。补丁由 Xiang Zhang 编写。

bpo-28008 [https://bugs.python.org/issue?@action=redirect&bpo=28008]: 实现 PEP 530 [https://www.python.org/dev/peps/pep-0530] -- 异步推导式。

bpo-27942 [https://bugs.python.org/issue?@action=redirect&bpo=27942]: 修复 codeobject.c 中的内存泄漏

库

bpo-28732 [https://bugs.python.org/issue?@action=redirect&bpo=28732]: 修复 os.spawnv() 在 args 中没有元素时的崩溃

bpo-28485 [https://bugs.python.org/issue?@action=redirect&bpo=28485]: 对于 compileall.compile_dir(workers=...) 参数的负值，即使多线程不可用，也总是引发 ValueError。

bpo-28037 [https://bugs.python.org/issue?@action=redirect&bpo=28037]: 使用 sqlite3_get_autocommit() 而不是手动设置 Connection->inTransaction。

bpo-25283 [https://bugs.python.org/issue?@action=redirect&bpo=25283]: 现在，在所有平台上，time.localtime() 和 time.gmtime() 的返回值中都提供了属性 tm_gmtoff 和 tm_zone。

bpo-24454 [https://bugs.python.org/issue?@action=redirect&bpo=24454]: 现在可以使用 __getitem__ 访问正则表达式匹配对象组。"mo[x]" 等同于 "mo.group(x)"。

bpo-10740 [https://bugs.python.org/issue?@action=redirect&bpo=10740]: sqlite3 不再在 DDL 语句之前隐式提交一个打开的事务。

bpo-17941 [https://bugs.python.org/issue?@action=redirect&bpo=17941]: 向 collections.namedtuple() 添加了一个 module 参数。

bpo-22493 [https://bugs.python.org/issue?@action=redirect&bpo=22493]: 内联标志现在应该只在正则表达式的开头使用。如果在正则表达式的中间使用它们，则会发出弃用警告。

bpo-26885 [https://bugs.python.org/issue?@action=redirect&bpo=26885]: xmlrpc 现在支持解组 Apache XML-RPC 实现用于数字和 None 的附加数据类型。

bpo-28070 [https://bugs.python.org/issue?@action=redirect&bpo=28070]: 修复了正则表达式中解析内联详细标志的问题。

bpo-19500 [https://bugs.python.org/issue?@action=redirect&bpo=19500]: 向 ssl 模块添加了客户端 SSL 会话恢复功能。

bpo-28022 [https://bugs.python.org/issue?@action=redirect&bpo=28022]: 弃用有利于 SSLContext 的 ssl 相关参数。弃用包括在 ftplib、httplib、imaplib、smtplib、poplib 和 urllib 中手动创建 SSLSocket 和 certfile/keyfile（或类似）。

bpo-28043 [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 密码。

bpo-24693 [https://bugs.python.org/issue?@action=redirect&bpo=24693]: 将 zipfile 模块中的一些 RuntimeError 更改为更合适的类型。改进了一些错误消息和调试输出。

bpo-17909 [https://bugs.python.org/issue?@action=redirect&bpo=17909]: json.load 和 json.loads 现在支持以 UTF-8、UTF-16 或 UTF-32 编码的二进制输入。由 Serhiy Storchaka 提供补丁。

bpo-27137 [https://bugs.python.org/issue?@action=redirect&bpo=27137]: functools.partial 的纯 Python 回退实现现在在子类化、pickling 和文本表示目的方面与其加速的 C 对应物行为匹配。由 Emanuel Barry 和 Serhiy Storchaka 提供补丁。

修复了 mmap 模块中在异常使用模式下可能出现的整数溢出和崩溃问题。

bpo-1703178 [https://bugs.python.org/issue?@action=redirect&bpo=1703178]: 修复了向distutils的build_ext命令传递--link-objects选项的功能。

bpo-28019 [https://bugs.python.org/issue?@action=redirect&bpo=28019]: itertools.count()不再将1.0到2.0之间的非整数步长四舍五入为1。

bpo-18401 [https://bugs.python.org/issue?@action=redirect&bpo=18401]: Pdb现在支持'readrc'关键字参数，以控制是否应读取.pdbrc文件。由Martin Matusiak和Sam Kimbrel提供的补丁。

bpo-25969 [https://bugs.python.org/issue?@action=redirect&bpo=25969]: 更新lib2to3语法以处理3.5中添加的解包泛化。

bpo-14977 [https://bugs.python.org/issue?@action=redirect&bpo=14977]: mailcap现在遵循mailcap文件中的行顺序（“首次匹配”），符合RFC 1542的要求。由Michael Lazar提供的补丁。

bpo-28082 [https://bugs.python.org/issue?@action=redirect&bpo=28082]: 将re标志常量转换为IntFlag。

bpo-28025 [https://bugs.python.org/issue?@action=redirect&bpo=28025]: 将所有ssl模块常量转换为IntEnum和IntFlags。SSLContext属性现在返回标志和枚举。

bpo-23591 [https://bugs.python.org/issue?@action=redirect&bpo=23591]: 向enum模块添加Flag、IntFlag和auto()。

bpo-433028 [https://bugs.python.org/issue?@action=redirect&bpo=433028]: 增加了对正则表达式中修饰符跨度的支持。

bpo-24594 [https://bugs.python.org/issue?@action=redirect&bpo=24594]: 在打开MSI数据库时验证persist参数。

bpo-17582 [https://bugs.python.org/issue?@action=redirect&bpo=17582]: xml.etree.ElementTree现在保留属性中的空白（由Duane Griffin提供补丁。由Stefan Behnel审查和批准。）。

bpo-28047 [https://bugs.python.org/issue?@action=redirect&bpo=28047]: 修复了用于新电子邮件策略中base64 CTE的行长度计算。

bpo-27576 [https://bugs.python.org/issue?@action=redirect&bpo=27576]: 修复OrderedDict.__init__()中的调用顺序。

email.generator.DecodedGenerator现在支持policy关键字。

bpo-28027 [https://bugs.python.org/issue?@action=redirect&bpo=28027]: 从 Lib/plat-* 中移除未记录的模块：IN、CDROM、DLFCN、TYPES、CDIO和STROPTS。

bpo-27445 [https://bugs.python.org/issue?@action=redirect&bpo=27445]: 不将str(_charset)传递给MIMEText.set_payload()。由Claude Paroz提供的补丁。

bpo-24277 [https://bugs.python.org/issue?@action=redirect&bpo=24277]: 新的电子邮件API不再是临时的，文档已经重新组织和重写以强调新API。

bpo-22450 [https://bugs.python.org/issue?@action=redirect&bpo=22450]: urllib现在在默认头中包括一个 Accept: */* 头。这使得REST API请求的结果更加一致和可预测，尤其是在涉及代理服务器时。

lib2to3.pgen3.driver.load_grammar() 现在在相同的Grammar.txt输入下，无论哈希随机化设置如何，都会创建一个稳定的缓存文件。

bpo-28005 [https://bugs.python.org/issue?@action=redirect&bpo=28005]: 允许编码实现中的ImportErrors传播。

bpo-26667 [https://bugs.python.org/issue?@action=redirect&bpo=26667]: 在importlib.util中支持路径类对象。

bpo-27570 [https://bugs.python.org/issue?@action=redirect&bpo=27570]: 在“ctypes”和“array”模块中避免使用空源指针进行零长度memcpy()等调用。

bpo-22233 [https://bugs.python.org/issue?@action=redirect&bpo=22233]: 仅在RFC指定的CR和LF字符上断开电子邮件标题行，而不是在任意Unicode换行符上。这也修复了HTTP标题解析中的一个错误。

bpo-27331 [https://bugs.python.org/issue?@action=redirect&bpo=27331]: email.mime类现在都接受一个可选的policy关键字。

bpo-27988 [https://bugs.python.org/issue?@action=redirect&bpo=27988]: 修复email iter_attachments对payload列表的错误修改。

bpo-16113 [https://bugs.python.org/issue?@action=redirect&bpo=16113]: 向hashlib模块添加SHA-3和SHAKE支持。

消除_scproxy.c中的一个同义指针比较警告。

bpo-27776 [https://bugs.python.org/issue?@action=redirect&bpo=27776]: os.urandom() 函数现在在Linux 3.17及更新版本上会阻塞，直到系统urandom熵池初始化以提高安全性。这一变更是 PEP 524 [https://www.python.org/dev/peps/pep-0524] 的一部分。

bpo-27778 [https://bugs.python.org/issue?@action=redirect&bpo=27778]: 将Linux的 getrandom() 系统调用作为一个新的 os.getrandom() 函数公开。这一变更是 PEP 524 [https://www.python.org/dev/peps/pep-0524] 的一部分。

bpo-27691 [https://bugs.python.org/issue?@action=redirect&bpo=27691]: 修复ssl模块对X.509证书中GEN_RID主题替代名字段的解析。

bpo-18844 [https://bugs.python.org/issue?@action=redirect&bpo=18844]: 添加random.choices()。

bpo-25761 [https://bugs.python.org/issue?@action=redirect&bpo=25761]: 改进了关于C实现解pickler中截断pickle数据的错误报告。在某些情况下，现在会抛出UnpicklingError而不是AttributeError和ValueError。

bpo-26798 [https://bugs.python.org/issue?@action=redirect&bpo=26798]: 向hashlib添加BLAKE2（blake2b和blake2s）。

bpo-26032 [https://bugs.python.org/issue?@action=redirect&bpo=26032]: 通过使用os.scandir()优化了pathlib中的globing；现在大约快了1.5到4倍。

bpo-25596 [https://bugs.python.org/issue?@action=redirect&bpo=25596]: 优化了glob模块中的glob()和iglob()函数；现在大约快了3到6倍。

bpo-27928 [https://bugs.python.org/issue?@action=redirect&bpo=27928]: 向hashlib模块添加scrypt（基于密码的密钥派生函数）（需要OpenSSL 1.1.0）。

bpo-27850 [https://bugs.python.org/issue?@action=redirect&bpo=27850]: Remove 3DES from ssl module's default cipher list to counter measure sweet32 attack (CVE-2016-2183).

bpo-27766 [https://bugs.python.org/issue?@action=redirect&bpo=27766]: 向ssl模块的默认加密列表中添加ChaCha20 Poly1305。（需要OpenSSL 1.1.0或LibreSSL）。

bpo-25387 [https://bugs.python.org/issue?@action=redirect&bpo=25387]: 检查winsound.MessageBeep的返回值。

bpo-27866 [https://bugs.python.org/issue?@action=redirect&bpo=27866]: 添加SSLContext.get_ciphers()方法以获取所有启用的加密列表。

bpo-27744 [https://bugs.python.org/issue?@action=redirect&bpo=27744]: 向socket模块添加AF_ALG（Linux内核加密）。

bpo-26470 [https://bugs.python.org/issue?@action=redirect&bpo=26470]: 将ssl和hashlib模块移植到OpenSSL 1.1.0。

bpo-11620 [https://bugs.python.org/issue?@action=redirect&bpo=11620]: 修复winsound.PlaySound中对SND_MEMORY的支持。基于Tim Lesher的补丁。

bpo-11734 [https://bugs.python.org/issue?@action=redirect&bpo=11734]: 向struct模块添加对IEEE 754半精度浮点数的支持。基于Eli Stevens的补丁。

bpo-27919 [https://bugs.python.org/issue?@action=redirect&bpo=27919]: 弃用distutils打包中的 extra_path 分发选项。

bpo-23229 [https://bugs.python.org/issue?@action=redirect&bpo=23229]: 添加新的 cmath``常量：``cmath.inf``和 ``cmath.nan 以匹配 math.inf 和``math.nan``，以及 cmath.infj 和 cmath.nanj 以匹配复数repr使用的格式。

bpo-27842 [https://bugs.python.org/issue?@action=redirect&bpo=27842]: csv.DictReader现在返回OrderedDict类型的行。（由Steve Holden贡献。）

移除对传递文件描述符给os.access的支持。它从未工作过，但以前不会引发错误。

bpo-12885 [https://bugs.python.org/issue?@action=redirect&bpo=12885]: 修复distutils遇到符号链接时的错误。

bpo-27881 [https://bugs.python.org/issue?@action=redirect&bpo=27881]: 修复了设置sqlite3.Connection.isolation_level时可能的错误。基于Xiang Zhang的补丁。

bpo-27861 [https://bugs.python.org/issue?@action=redirect&bpo=27861]: 修复了当工厂创建的不是游标时sqlite3.Connection.cursor()中的崩溃。由Xiang Zhang提供补丁。

bpo-19884 [https://bugs.python.org/issue?@action=redirect&bpo=19884]: 避免在OS X上使用Gnu Readline时产生虚假输出。

bpo-27706 [https://bugs.python.org/issue?@action=redirect&bpo=27706]: 恢复random.Random().seed()对于使用种子版本1的字符串种子的确定性行为。允许random()的调用序列与Python 2中完全匹配。由Nofar Schnider提供补丁。

bpo-10513 [https://bugs.python.org/issue?@action=redirect&bpo=10513]: 修复Connection.commit()中的回归问题。提交后不应重置语句。

bpo-12319 [https://bugs.python.org/issue?@action=redirect&bpo=12319]: 在http.client.HTTPConnection请求中添加了分块传输编码支持。urllib.request.AbstractHTTPHandler类不再强制要求Content-Length头部。如果一个HTTP请求有一个文件或可迭代体，但没有Content-Length头部，库现在会转而使用分块传输编码。

来自https://github.com/python/typing的typing.py新版本：- Collection（仅适用于3.6）(bpo-27598 [https://bugs.python.org/issue?@action=redirect&bpo=27598]) - 将FrozenSet添加到__all__（上游#261） - 修复_get_type_vars()中的崩溃（上游#259） - 移除ForwardRef._eval_type中的字典约束（上游#252）

bpo-27832 [https://bugs.python.org/issue?@action=redirect&bpo=27832]: 使 _normalize 参数成为 Fraction 构造器的仅关键字参数，这样``Fraction(2, 3, 4)``现在会引发 TypeError。

bpo-27539 [https://bugs.python.org/issue?@action=redirect&bpo=27539]: 修复了在负指数和负基数情况下未归一化的 Fraction.__pow__ 结果。

bpo-21718 [https://bugs.python.org/issue?@action=redirect&bpo=21718]: 现在，使用CTEs的查询可以使用cursor.description了。

bpo-27819 [https://bugs.python.org/issue?@action=redirect&bpo=27819]: 在distutils的sdists中，除非提供了"formats"，否则简单地在所有平台上生成"gztar"（gzip压缩的tar格式）分发。

bpo-2466 [https://bugs.python.org/issue?@action=redirect&bpo=2466]: posixpath.ismount现在能正确识别用户没有权限访问的挂载点。

bpo-9998 [https://bugs.python.org/issue?@action=redirect&bpo=9998]: 在Linux上，ctypes.util.find_library现在会在LD_LIBRARY_PATH中查找共享库。

bpo-27573 [https://bugs.python.org/issue?@action=redirect&bpo=27573]: code.interact的退出消息现在可以配置。

bpo-27930 [https://bugs.python.org/issue?@action=redirect&bpo=27930]: 改进了logging.handlers.QueueListener的行为。感谢Paulo Andrade和Petr Viktorin的分析和补丁。

bpo-6766 [https://bugs.python.org/issue?@action=redirect&bpo=6766]: 向multiprocessing添加了分布式引用计数以支持共享值/代理对象的嵌套。

bpo-21201 [https://bugs.python.org/issue?@action=redirect&bpo=21201]: 提高了multiprocessing错误消息的可读性。感谢Wojciech Walczak的补丁。

asyncio: 在各Transport类中添加了 set_protocol / get_protocol 方法

bpo-27456 [https://bugs.python.org/issue?@action=redirect&bpo=27456]: asyncio：默认设置TCP_NODELAY。

IDLE

bpo-15308 [https://bugs.python.org/issue?@action=redirect&bpo=15308]: 向Shell菜单添加了'中断执行'(^C)。由Roger Serwy提供补丁，由Bayard Randel更新。

bpo-27922 [https://bugs.python.org/issue?@action=redirect&bpo=27922]: 停止IDLE测试在屏幕上'闪烁'gui小部件。

bpo-27891 [https://bugs.python.org/issue?@action=redirect&bpo=27891]: 在idlelib模块中一致地分组和排序导入。

bpo-17642 [https://bugs.python.org/issue?@action=redirect&bpo=17642]: 为教室投影添加更大的字体大小。

在 IDLE 帮助窗口的标题中加入版本号

bpo-25564 [https://bugs.python.org/issue?@action=redirect&bpo=25564]: 在IDLE与控制台差异的部分，提到使用exec意味着每个语句都定义了__builtins__。

bpo-27821 [https://bugs.python.org/issue?@action=redirect&bpo=27821]: 修复3.6.0a3回归，该回归阻止在没有定义自定义主题时选择自定义键集。

C API

bpo-26900 [https://bugs.python.org/issue?@action=redirect&bpo=26900]: 从有限API中排除下划线名称和其他私有API。

bpo-26027 [https://bugs.python.org/issue?@action=redirect&bpo=26027]: 在PyUnicode_FSConverter()和PyUnicode_FSDecoder()中添加对路径类对象的支持。

测试

bpo-27427 [https://bugs.python.org/issue?@action=redirect&bpo=27427]: 为数学模块添加额外测试。由Francisco Couzo提供补丁。

bpo-27953 [https://bugs.python.org/issue?@action=redirect&bpo=27953]: 跳过在OS X 10.4上由于tan函数的libm实现不佳而失败的数学和cmath测试。

bpo-26040 [https://bugs.python.org/issue?@action=redirect&bpo=26040]: 提高test_math和test_cmath的覆盖范围和严谨性。由Jeff Allen提供补丁。

bpo-27787 [https://bugs.python.org/issue?@action=redirect&bpo=27787]: 在检查每个测试的“悬挂线程”之前调用gc.collect()，因为悬挂线程是弱引用。

构建

bpo-27566 [https://bugs.python.org/issue?@action=redirect&bpo=27566]: 修复冻结makefile中的clean目标（Lisa Roach提供补丁）

bpo-27705 [https://bugs.python.org/issue?@action=redirect&bpo=27705]: 更新validate_ucrtbase.py中的消息

bpo-27976 [https://bugs.python.org/issue?@action=redirect&bpo=27976]: 弃用在非OSX UNIX平台上使用捆绑的libffi副本构建_ctypes。

bpo-27983 [https://bugs.python.org/issue?@action=redirect&bpo=27983]: 当启用 --with-optimizations 时，将使用clang作为PGO链接所需的llvm-profdata工具的缺失变为配置时错误，而不是制作时。同时提高我们在MacOS和一些Linux上找到llvm-profdata工具的能力。

bpo-21590 [https://bugs.python.org/issue?@action=redirect&bpo=21590]: 支持DTrace和SystemTap探针。

bpo-26307 [https://bugs.python.org/issue?@action=redirect&bpo=26307]: profile-opt构建现在将PGO应用于内置模块。

bpo-26359 [https://bugs.python.org/issue?@action=redirect&bpo=26359]: 添加--with-optimizations标志以在可用时开启LTO和PGO构建支持。

bpo-27917 [https://bugs.python.org/issue?@action=redirect&bpo=27917]: 为Android构建设置平台三元组。

bpo-25825 [https://bugs.python.org/issue?@action=redirect&bpo=25825]: 更新AIX上对$(LIBPL)安装路径的引用。此路径在3.2a4中更改。

更新 OS X 安装包，使用SQLite 3.14.1 和 XZ 5.2.2版本。

bpo-21122 [https://bugs.python.org/issue?@action=redirect&bpo=21122]: 修复OS X上的LTO构建。

bpo-17128 [https://bugs.python.org/issue?@action=redirect&bpo=17128]: 构建带有OpenSSL私有副本的OS X安装程序。同时提供一个安装证书命令脚本示例，用于从第三方certifi模块安装一组根证书。

工具/示例

bpo-27952 [https://bugs.python.org/issue?@action=redirect&bpo=27952]: 使Tools/scripts/fixcid.py能够在Python 3和当前的"re"模块下工作，避免无效的Python反斜杠转义，并修复解析转义C引号符号时的错误。

Windows

bpo-28065 [https://bugs.python.org/issue?@action=redirect&bpo=28065]: 将xz依赖更新至5.2.2版本并从源代码构建。

bpo-25144 [https://bugs.python.org/issue?@action=redirect&bpo=25144]: 确保在继续自定义安装之前设置TargetDir。

bpo-1602 [https://bugs.python.org/issue?@action=redirect&bpo=1602]: Windows控制台不支持输入或打印Unicode（PEP 528）。

bpo-27781 [https://bugs.python.org/issue?@action=redirect&bpo=27781]: 在Windows上将文件系统编码更改为UTF-8（PEP 529）。

bpo-27731 [https://bugs.python.org/issue?@action=redirect&bpo=27731]: 在Windows 10上选择退出MAX_PATH限制。

bpo-6135 [https://bugs.python.org/issue?@action=redirect&bpo=6135]: 向subprocess添加encoding和errors参数。

bpo-27959 [https://bugs.python.org/issue?@action=redirect&bpo=27959]: 添加oem编码，将ansi别名设为mbcs，将aliasmbcs移动到编解码器查找。

bpo-27982 [https://bugs.python.org/issue?@action=redirect&bpo=27982]: winsound模块的函数现在接受关键字参数。

bpo-20366 [https://bugs.python.org/issue?@action=redirect&bpo=20366]: 在Windows上构建SQLite的全文搜索支持。

bpo-27756 [https://bugs.python.org/issue?@action=redirect&bpo=27756]: 为Windows上的Python文件和进程添加新图标。设计由Cherry Wang提供。

bpo-27883 [https://bugs.python.org/issue?@action=redirect&bpo=27883]: 在Windows上将sqlite更新至3.14.1.0版本。

Python 3.6.0 alpha 4

发布日期: 2016-08-15

核心与内置函数

bpo-27704 [https://bugs.python.org/issue?@action=redirect&bpo=27704]: 优化从字节类对象和可迭代对象创建bytes和bytearray。对于短对象速度提升可达3倍。原始由Naoki Inada提供补丁。

bpo-26823 [https://bugs.python.org/issue?@action=redirect&bpo=26823]: 回溯中大量重复的行现在被内置回溯渲染缩写为"[Previous line repeated {count} more times]"。由Emanuel Barry提供补丁。

bpo-27574 [https://bugs.python.org/issue?@action=redirect&bpo=27574]: 减少了在使用Argument Clinic实现的函数中解析关键字参数的开销。

bpo-22557 [https://bugs.python.org/issue?@action=redirect&bpo=22557]: 现在导入已经导入的模块速度提升可达2.5倍。

bpo-17596 [https://bugs.python.org/issue?@action=redirect&bpo=17596]: 包含<wincrypt.h>以帮助Min GW构建。

bpo-17599 [https://bugs.python.org/issue?@action=redirect&bpo=17599]: 在Windows上，重命名私有定义的REPARSE_DATA_BUFFER结构以避免与Min GW的定义冲突。

bpo-27507 [https://bugs.python.org/issue?@action=redirect&bpo=27507]: 在bytearray.extend()中添加整数溢出检查。由张翔提供补丁。

bpo-27581 [https://bugs.python.org/issue?@action=redirect&bpo=27581]: 在PySequence_Tuple()中不依赖包装进行溢出检查。由张翔提供补丁。

bpo-1621 [https://bugs.python.org/issue?@action=redirect&bpo=1621]: 避免在列表和元组操作中出现有符号整数溢出。由张翔提供补丁。

bpo-27419 [https://bugs.python.org/issue?@action=redirect&bpo=27419]: 标准的__import__()不再在全局或内置变量中查找"__import__"以导入子模块或"from import"。修复了如果从__spec__或__package__无法解析包时发出警告导致崩溃的问题。

bpo-27083 [https://bugs.python.org/issue?@action=redirect&bpo=27083]: 在Windows下尊重PYTHONCASEOK环境变量。

bpo-27514 [https://bugs.python.org/issue?@action=redirect&bpo=27514]: 将静态嵌套块过多的情况改为SyntaxError而非SystemError。

bpo-27366 [https://bugs.python.org/issue?@action=redirect&bpo=27366]: 实现了 PEP 487 [https://www.python.org/dev/peps/pep-0487] (类创建的简化定制) 。在子类化时，__init_subclass__类方法会在基类上调用。描述符在类创建后通过__set_name__初始化。

库

bpo-26027 [https://bugs.python.org/issue?@action=redirect&bpo=26027]: 向os和os.path模块添加 PEP 519 [https://www.python.org/dev/peps/pep-0519]/__fspath__()支持。包含来自Jelle Zijlstra的代码。（另见 bpo-27524 [https://bugs.python.org/issue?@action=redirect&bpo=27524]）

bpo-27598 [https://bugs.python.org/issue?@action=redirect&bpo=27598]: 将Collections添加到collections.abc。由Ivan Levkivskyi提供补丁，文档由Neil Girdhar提供。

bpo-25958 [https://bugs.python.org/issue?@action=redirect&bpo=25958]: 支持从各种ABC中"反注册"特殊方法，如__hash__、__iter__或__len__。所有这些（以及更多）可以在实现类中设置为None，行为将如同方法根本未定义。（以前，这种机制仅存在于__hash__，以使可变类不可哈希。）代码由Andrew Barnert和Ivan Levkivskyi贡献。

bpo-16764 [https://bugs.python.org/issue?@action=redirect&bpo=16764]: 支持zlib.decompress()的关键字参数。由张翔提供补丁。

bpo-27736 [https://bugs.python.org/issue?@action=redirect&bpo=27736]: 防止由于在3.6.0a3中为 bpo-27038 [https://bugs.python.org/issue?@action=redirect&bpo=27038] 引入的代码导致的引用计数问题在解释器重新初始化后出现段错误。由张翔提供补丁。

bpo-25628 [https://bugs.python.org/issue?@action=redirect&bpo=25628]: collections.namedtuple的 verbose 和 rename 参数现在仅为关键字参数。

bpo-12345 [https://bugs.python.org/issue?@action=redirect&bpo=12345]: 向 math 和 cmath 添加数学常数 tau。另见 PEP 628 [https://www.python.org/dev/peps/pep-0628]。

bpo-26823 [https://bugs.python.org/issue?@action=redirect&bpo=26823]: traceback.StackSummary.format 现在将重复行的大段缩写为 "[前一行重复了 {count} 次]"（这一变化进一步影响了模块中的其他 traceback 显示操作）。由 Emanuel Barry 提供补丁。

bpo-27664 [https://bugs.python.org/issue?@action=redirect&bpo=27664]: 向 concurrent.futures.thread.ThreadPoolExecutor() 添加了指定线程名前缀的能力。

bpo-27181 [https://bugs.python.org/issue?@action=redirect&bpo=27181]: 向 statistics 模块添加 geometric_mean 和 harmonic_mean。

bpo-27573 [https://bugs.python.org/issue?@action=redirect&bpo=27573]: code.interact 现在在退出时打印一条消息。

bpo-6422 [https://bugs.python.org/issue?@action=redirect&bpo=6422]: 向 timeit.Timer 对象添加 autorange 方法。

bpo-27773 [https://bugs.python.org/issue?@action=redirect&bpo=27773]: 更正 _ssl.wrap_socket() 中 server_hostname 的一些内存管理错误。

bpo-26750 [https://bugs.python.org/issue?@action=redirect&bpo=26750]: unittest.mock.create_autospec() 现在可以正确用于 property() 和其他数据描述符的子类。移除从未公开使用、从未文档化的 unittest.mock.DescriptorTypes 元组。

bpo-26754 [https://bugs.python.org/issue?@action=redirect&bpo=26754]: 现在弃用 compile() 及类似函数中未文档化的对一般 bytes-like 对象作为路径的支持。

bpo-26800 [https://bugs.python.org/issue?@action=redirect&bpo=26800]: 现在弃用 os 函数中未文档化的对一般 bytes-like 对象作为路径的支持。

bpo-26981 [https://bugs.python.org/issue?@action=redirect&bpo=26981]: 向 enum.Enum 添加 _order_ 兼容性垫片，用于 Python 2/3 代码库。

bpo-27661 [https://bugs.python.org/issue?@action=redirect&bpo=27661]: 向 datetime.combine 添加 tzinfo 关键字参数。

在 curses 模块中，如果向 window.getstr() 或 window.instr() 传递负值，则引发错误。

bpo-27783 [https://bugs.python.org/issue?@action=redirect&bpo=27783]: 修复 operator.methodcaller 中可能使用未初始化内存的问题。

bpo-27774 [https://bugs.python.org/issue?@action=redirect&bpo=27774]: 修复 _sre 中可能对未拥有对象进行 Py_DECREF 的问题。

bpo-27760 [https://bugs.python.org/issue?@action=redirect&bpo=27760]: 修复 binascii.b2a_qp 中可能的整数溢出。

bpo-27758 [https://bugs.python.org/issue?@action=redirect&bpo=27758]: 修复 _csv 模块中对于大记录长度可能的整数溢出。

bpo-27568 [https://bugs.python.org/issue?@action=redirect&bpo=27568]: Prevent HTTPoxy attack (CVE-2016-1000110). Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which indicates that the script is in CGI mode.

bpo-7063 [https://bugs.python.org/issue?@action=redirect&bpo=7063]: 从“array”模块的切片处理中移除无用代码。由Chuck提交补丁。

bpo-27656 [https://bugs.python.org/issue?@action=redirect&bpo=27656]: 不再假设sched.h定义了任何SCHED_*常量。

bpo-27130 [https://bugs.python.org/issue?@action=redirect&bpo=27130]: 在“zlib”模块中，修复了压缩和解压缩大缓冲区（通常为4 GiB）时的处理问题。之前，输入被限制在4 GiB，压缩和解压缩操作未能正确处理4 GiB的结果。

bpo-24773 [https://bugs.python.org/issue?@action=redirect&bpo=24773]: 实现了 PEP 495 [https://www.python.org/dev/peps/pep-0495] (本地时间歧义消除) 。

在select模块中公开EPOLLEXCLUSIVE常量（当它被定义时）。

bpo-27567 [https://bugs.python.org/issue?@action=redirect&bpo=27567]: 在select模块中公开EPOLLRDHUP和POLLRDHUP常量。

bpo-1621 [https://bugs.python.org/issue?@action=redirect&bpo=1621]: 在“audioop”模块中避免有符号整数否定溢出。

bpo-27533 [https://bugs.python.org/issue?@action=redirect&bpo=27533]: 在nt._isdir中释放GIL。

bpo-17711 [https://bugs.python.org/issue?@action=redirect&bpo=17711]: 修复了使用协议0的持久ID进行反序列化的问题。原始补丁由Alexandre Vassalotti提交。

bpo-27522 [https://bugs.python.org/issue?@action=redirect&bpo=27522]: 避免在email.feedparser中无意中创建的引用循环。

bpo-27512 [https://bugs.python.org/issue?@action=redirect&bpo=27512]: 修复了当os.fspath()调用一个引发异常的__fspath__()方法时的段错误。补丁由Xiang Zhang提交。

IDLE

bpo-27714 [https://bugs.python.org/issue?@action=redirect&bpo=27714]: text_textview和test_autocomplete现在在同一个进程中重新运行时通过。这发生在test_idle使用-w选项运行但未使用-jn选项时失败时。修复test_config的警告。

bpo-27621 [https://bugs.python.org/issue?@action=redirect&bpo=27621]: 将查询响应验证错误消息放在查询框本身中，而不是放在单独的消息框中。重做测试以匹配。添加Mac OSX改进。原始补丁由Mark Roseman提交。

bpo-27620 [https://bugs.python.org/issue?@action=redirect&bpo=27620]: 现在按Esc键会取消关闭查询框。

bpo-27609 [https://bugs.python.org/issue?@action=redirect&bpo=27609]: IDLE：在初始空白后按Tab键应制表，而不是自动完成。这解决了至少两次缩进编写文档字符串的问题。

bpo-27609 [https://bugs.python.org/issue?@action=redirect&bpo=27609]: 当也有非None返回时，显式返回None。在少数情况下，反转条件并消除返回。

bpo-25507 [https://bugs.python.org/issue?@action=redirect&bpo=25507]: IDLE不再因为其tkinter导入而运行有bug的代码。用户必须包含直接在Python中运行所需的相同导入。

bpo-27173 [https://bugs.python.org/issue?@action=redirect&bpo=27173]: 将'IDLE Modern Unix'添加到内置键集中。使默认键集依赖于平台。为配置模块的更改添加测试。

bpo-27452 [https://bugs.python.org/issue?@action=redirect&bpo=27452]: 在IDLE configHandler测试转储中添加行计数器和crc。

测试

bpo-25805 [https://bugs.python.org/issue?@action=redirect&bpo=25805]: 在test_pkgutil中根据需要跳过不适用于当 __name__ == __main__ 时的测试。补丁由SilentGhost提供。

bpo-27472 [https://bugs.python.org/issue?@action=redirect&bpo=27472]: 添加test.support.unix_shell作为默认shell的路径。

bpo-27369 [https://bugs.python.org/issue?@action=redirect&bpo=27369]: 在test_pyexpat中，避免测试在Expat 2.2.0中已更改的错误消息详情。

bpo-27594 [https://bugs.python.org/issue?@action=redirect&bpo=27594]: 防止在启用覆盖时运行test_ast时出现断言错误：确保代码对象具有有效的首行号。补丁由Ivan Levkivskyi建议。

Windows

bpo-27647 [https://bugs.python.org/issue?@action=redirect&bpo=27647]: 更新捆绑的Tcl/Tk至8.6.6。

bpo-27610 [https://bugs.python.org/issue?@action=redirect&bpo=27610]: 向Windows安装程序添加 PEP 514 [https://www.python.org/dev/peps/pep-0514] 元数据。

bpo-27469 [https://bugs.python.org/issue?@action=redirect&bpo=27469]: 向启动器添加shell扩展，以便拖放操作能正确工作。

bpo-27309 [https://bugs.python.org/issue?@action=redirect&bpo=27309]: 在python[w].exe清单中启用正确的Windows样式。

构建

bpo-27713 [https://bugs.python.org/issue?@action=redirect&bpo=27713]: 在更新importlib的引导文件时抑制虚假的构建警告。由Xiang Zhang提供补丁。

bpo-25825 [https://bugs.python.org/issue?@action=redirect&bpo=25825]: 更正对Modules/python.exp的引用，这在AIX上是必需的。这些引用在3.5.0a1中意外被更改。

bpo-27453 [https://bugs.python.org/issue?@action=redirect&bpo=27453]: 配置中的CPP调用必须使用CPPFLAGS。由Chi Hsuan Yen提供补丁。

bpo-27641 [https://bugs.python.org/issue?@action=redirect&bpo=27641]: 配置脚本现在在makefile中插入注释，以防止pgen和_freeze_importlib可执行文件被交叉编译。

bpo-26662 [https://bugs.python.org/issue?@action=redirect&bpo=26662]: 在配置中设置PYTHON_FOR_GEN作为构建期间用于文件生成的Python程序。

bpo-10910 [https://bugs.python.org/issue?@action=redirect&bpo=10910]: 避免在FreeBSD和OS X上出现C++编译错误。同时更新FreedBSD版本检查以应对原始的ctype UTF-8变通方案。

Python 3.6.0 alpha 3

发布日期: 2016-07-11

安全性

bpo-27278 [https://bugs.python.org/issue?@action=redirect&bpo=27278]: 修复在Linux上使用getrandom()实现的os.urandom()。将大小截断为INT_MAX，并循环直到收集足够的随机字节，而不是直接将Py_ssize_t转换为int。

bpo-22636 [https://bugs.python.org/issue?@action=redirect&bpo=22636]: 避免 ctypes.util.find_library() 的 shell 注入问题。

核心与内置函数

bpo-27473 [https://bugs.python.org/issue?@action=redirect&bpo=27473]: 修复了 bytes 和 bytearray 连接中可能的整数溢出问题。补丁由 Xiang Zhang 提供。

bpo-23034 [https://bugs.python.org/issue?@action=redirect&bpo=23034]: 现在默认关闭了定义了 COUNT_ALLOCS、SHOW_ALLOC_COUNT 或 SHOW_TRACK_COUNT 宏的特殊 Python 构建的输出。可以通过 "-X showalloccount" 选项重新启用。现在输出到 stderr 而不是 stdout。

bpo-27443 [https://bugs.python.org/issue?@action=redirect&bpo=27443]: bytearray 迭代器的 __length_hint__() 不再为调整大小的 bytearray 返回负整数。

bpo-27007 [https://bugs.python.org/issue?@action=redirect&bpo=27007]: bytes 和 bytearray 子类的 fromhex() 类方法现在返回相应子类的实例。

库

bpo-26844 [https://bugs.python.org/issue?@action=redirect&bpo=26844]: 修复 imp.find_module() 的错误消息，使其引用 'path' 而不是 'name'。由 Lev Maximov 提供补丁。

bpo-23804 [https://bugs.python.org/issue?@action=redirect&bpo=23804]: 修复 SSL 零长度 recv() 调用，使其不阻塞且不引发关于不干净 EOF 的错误。

bpo-27466 [https://bugs.python.org/issue?@action=redirect&bpo=27466]: 更改 http.cookie.time2netscape 返回的时间格式，确认 netscape cookie 格式并使其与文档一致。

bpo-21708 [https://bugs.python.org/issue?@action=redirect&bpo=21708]: 弃用了 dbm.dumb 与常见 dbm 行为不同的行为：在 'r' 和 'w' 模式下创建数据库以及在 'r' 模式下修改数据库。

bpo-26721 [https://bugs.python.org/issue?@action=redirect&bpo=26721]: 将 socketserver.StreamRequestHandler.wfile 属性更改为实现 BufferedIOBase。特别是，write() 方法不再进行部分写入。

bpo-22115 [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" 模式的跟踪现在正常工作。

bpo-26243 [https://bugs.python.org/issue?@action=redirect&bpo=26243]: 现在 zlib.compress() 只有 level 参数是关键字参数。第一个参数是仅位置参数。

bpo-27038 [https://bugs.python.org/issue?@action=redirect&bpo=27038]: 将DirEntry类型公开为os.DirEntry。代码由Jelle Zijlstra提供补丁。

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 更新os.fspath()/PyOS_FSPath()以检查__fspath__()的返回值为str或bytes。

bpo-18726 [https://bugs.python.org/issue?@action=redirect&bpo=18726]: json模块中的dump()、dumps()、load()和loads()函数以及JSONEncoder和JSONDecoder类构造函数的所有可选参数现在仅为关键字参数。

bpo-27319 [https://bugs.python.org/issue?@action=redirect&bpo=27319]: ttk.TreeView的selection_set()、selection_add()、selection_remove()和selection_toggle()方法现在允许将多个项作为多个参数传递，而不是将它们作为元组传递。弃用了selection()方法带参数调用的未记录功能。

bpo-27079 [https://bugs.python.org/issue?@action=redirect&bpo=27079]: 修复了curses.ascii函数isblank()、iscntrl()和ispunct()。

bpo-27294 [https://bugs.python.org/issue?@action=redirect&bpo=27294]: Tkinter事件对象的repr中的数值状态现在表示为已知标志的组合。

bpo-27177 [https://bugs.python.org/issue?@action=redirect&bpo=27177]: re模块中的Match对象现在支持类似索引的对象作为组索引。基于Jeroen Demeyer和Xiang Zhang的补丁。

bpo-26754 [https://bugs.python.org/issue?@action=redirect&bpo=26754]: 一些函数（如compile()等）接受以整数可迭代对象编码的文件名参数。现在只接受字符串和字节类对象。

bpo-26536 [https://bugs.python.org/issue?@action=redirect&bpo=26536]: socket.ioctl现在支持SIO_LOOPBACK_FAST_PATH。由Daniel Stokes提供补丁。

bpo-27048 [https://bugs.python.org/issue?@action=redirect&bpo=27048]: 防止distutils在Windows上因环境变量包含非ASCII字符而失败。

bpo-27330 [https://bugs.python.org/issue?@action=redirect&bpo=27330]: 修复了ctypes模块中可能的泄漏。

bpo-27238 [https://bugs.python.org/issue?@action=redirect&bpo=27238]: 移除了turtle模块中的裸except。原始由Jelle Zijlstra提供补丁。

bpo-27122 [https://bugs.python.org/issue?@action=redirect&bpo=27122]: 当在由contextlib.ExitStack()管理的上下文中引发异常，并且退出堆栈生成器之一捕获并在链中引发它时，退出时不再重新引发原始异常，而是让新的链式异常通过。这避免了issue25782中描述的 PEP 479 [https://www.python.org/dev/peps/pep-0479] 错误。

bpo-16864 [https://bugs.python.org/issue?@action=redirect&bpo=16864]: sqlite3.Cursor.lastrowid现在支持REPLACE语句。初始补丁由Alex LordThorsen提供。

bpo-26386 [https://bugs.python.org/issue?@action=redirect&bpo=26386]: 修复了 ttk.TreeView 选中操作中项目 ID 包含空格的问题。

bpo-8637 [https://bugs.python.org/issue?@action=redirect&bpo=8637]: 优先使用环境变量 MANPAGER 设置的页面浏览程序（而非环境变量 PAGER 设置的）。

bpo-16182 [https://bugs.python.org/issue?@action=redirect&bpo=16182]: 修复 "readline" 模块中的多个函数以使用区域设置编码，并修复 get_begidx() 和 get_endidx() 返回代码点索引。

bpo-27392 [https://bugs.python.org/issue?@action=redirect&bpo=27392]: 添加 loop.connect_accepted_socket()。由 Jim Fulton 提供补丁。

IDLE

bpo-27477 [https://bugs.python.org/issue?@action=redirect&bpo=27477]: IDLE 搜索对话框现在使用 ttk 部件。

bpo-27173 [https://bugs.python.org/issue?@action=redirect&bpo=27173]: 将'IDLE Modern Unix'添加到内置键集中。使默认键集依赖于平台。为配置模块的更改添加测试。

bpo-27452 [https://bugs.python.org/issue?@action=redirect&bpo=27452]: 使命令行 "idle-test> python test_help.py" 正常工作。当 python 在文件目录中启动时，__file__ 是相对的。

bpo-27452 [https://bugs.python.org/issue?@action=redirect&bpo=27452]: 在IDLE configHandler测试转储中添加行计数器和crc。

bpo-27380 [https://bugs.python.org/issue?@action=redirect&bpo=27380]: IDLE：添加 query.py 包含基本查询对话框和 ttk 部件。模块有子类 SectionName、ModuleName 和 HelpSource，用于通过 configdialog 和 file =>Load Module 从用户获取信息。每个子类有其自己的有效性检查。使用 ModuleName 允许用户编辑错误的模块名而不是重新开始。添加测试并删除合并到新文件中的两个文件。

bpo-27372 [https://bugs.python.org/issue?@action=redirect&bpo=27372]: Test_idle 不再更改区域设置。

bpo-27365 [https://bugs.python.org/issue?@action=redirect&bpo=27365]: 允许在 IDLE NEWS.txt 中使用非 ASCII 字符，用于贡献者姓名。

bpo-27245 [https://bugs.python.org/issue?@action=redirect&bpo=27245]: IDLE：干净地删除自定义主题和键绑定。以前，当 IDLE 从控制台或通过导入启动时，会发出一系列警告。由 Serhiy Storchaka 提供补丁。

bpo-24137 [https://bugs.python.org/issue?@action=redirect&bpo=24137]: 运行 IDLE、test_idle 和 htest 时禁用 tkinter 默认根。修复因此限制而失败的代码和测试。修复 htests 不创建第二个冗余的根和主循环。

bpo-27310 [https://bugs.python.org/issue?@action=redirect&bpo=27310]: 修复 IDLE.app 在 OS X 上因遗留导入而无法启动的问题。

C API

bpo-26754 [https://bugs.python.org/issue?@action=redirect&bpo=26754]: PyUnicode_FSDecoder() 接受以整数迭代形式编码的文件名参数。现在只接受字符串和类字节对象。

构建

bpo-28066 [https://bugs.python.org/issue?@action=redirect&bpo=28066]: 修复在源代码树外构建时搜索构建目录中生成的包含文件的逻辑。

bpo-27442 [https://bugs.python.org/issue?@action=redirect&bpo=27442]: 在sysconfig.get_config_vars()中暴露Python构建所针对的Android API级别，作为'ANDROID_API_LEVEL'。

bpo-27434 [https://bugs.python.org/issue?@action=redirect&bpo=27434]: 运行交叉构建的解释器，位于PATH中，现在必须与正在构建的源代码具有相同的特性版本（例如3.6）。

bpo-26930 [https://bugs.python.org/issue?@action=redirect&bpo=26930]: 更新Windows构建以使用OpenSSL 1.0.2h。

bpo-23968 [https://bugs.python.org/issue?@action=redirect&bpo=23968]: 将平台目录从plat-$(MACHDEP)重命名为plat-$(PLATFORM_TRIPLET)。将配置目录(LIBPL)从config-$(LDVERSION)重命名为config-$(LDVERSION)-$(PLATFORM_TRIPLET)。将特定于平台的_sysconfigdata模块安装到平台目录，并重命名以包含ABIFLAGS。

在 GNU/Hurd 系统中不使用大文件支持。

工具/示例

bpo-27332 [https://bugs.python.org/issue?@action=redirect&bpo=27332]: 修复了由Argument Clinic生成的模块级函数的第一个参数的类型。由Petr Viktorin提供补丁。

bpo-27418 [https://bugs.python.org/issue?@action=redirect&bpo=27418]: 修复了Tools/importbench/importbench.py。

文档

bpo-19489 [https://bugs.python.org/issue?@action=redirect&bpo=19489]: 将搜索框从侧边栏移动到每个页面的页眉和页脚。由Ammar Askar提供补丁。

bpo-27285 [https://bugs.python.org/issue?@action=redirect&bpo=27285]: 更新文档以反映 pyvenv 的弃用，并统一使用术语“虚拟环境”。由Steve Piercy提供补丁。

测试

bpo-27027 [https://bugs.python.org/issue?@action=redirect&bpo=27027]: 添加了test.support.is_android，当这是一个Android构建时为True。

Python 3.6.0 alpha 2

发布日期: 2016-06-13

安全性

bpo-26556 [https://bugs.python.org/issue?@action=redirect&bpo=26556]: Update expat to 2.1.1, fixes CVE-2015-1283.

Fix TLS stripping vulnerability in smtplib, CVE-2016-0772. Reported by Team Oststrom.

bpo-26839 [https://bugs.python.org/issue?@action=redirect&bpo=26839]: 在Linux上，os.urandom() 现在调用 getrandom() 与 GRND_NONBLOCK，如果urandom熵池尚未初始化，则回退到读取 /dev/urandom。补丁由Colm Buckley编写。

核心与内置函数

bpo-27095 [https://bugs.python.org/issue?@action=redirect&bpo=27095]: 简化了MAKE_FUNCTION并移除了MAKE_CLOSURE操作码。由Demur Rumed提供补丁。

bpo-27190 [https://bugs.python.org/issue?@action=redirect&bpo=27190]: 如果sqlite3版本低于3.3.1，则引发NotSupportedError。由Dave Sawyer提供补丁。

bpo-27286 [https://bugs.python.org/issue?@action=redirect&bpo=27286]: 修复了编译BUILD_MAP_UNPACK_WITH_CALL操作码的问题。使用广义解包（PEP 448）和冲突的关键字名称调用函数可能导致未定义行为。

bpo-27140 [https://bugs.python.org/issue?@action=redirect&bpo=27140]: 添加了BUILD_CONST_KEY_MAP操作码。

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 为 open() 添加对 os.PathLike 对象的支持（PEP 519 [https://www.python.org/dev/peps/pep-0519] 的一部分）。

bpo-27066 [https://bugs.python.org/issue?@action=redirect&bpo=27066]: 修复了如果自定义 opener（为 open()）返回一个负数而没有设置异常时的 SystemError。

bpo-26983 [https://bugs.python.org/issue?@action=redirect&bpo=26983]: float() 现在总是返回一个精确的 float 实例。如果 __float__ 返回一个 float 的严格子类的实例，将发出弃用警告。在 Python 的未来版本中，这可能是一个错误。

bpo-27097 [https://bugs.python.org/issue?@action=redirect&bpo=27097]: Python 解释器现在由于优化的指令解码而大约快了 7%。基于 Demur Rumed 的补丁。

bpo-26647 [https://bugs.python.org/issue?@action=redirect&bpo=26647]: Python 解释器现在使用 16 位字码代替字节码。由 Demur Rumed 提供补丁。

bpo-23275 [https://bugs.python.org/issue?@action=redirect&bpo=23275]: 允许在圆括号中赋值给空的目标列表：() = iterable。

bpo-27243 [https://bugs.python.org/issue?@action=redirect&bpo=27243]: 更新 __aiter__ 协议：异步迭代器应该直接返回，而不是返回一个解析为异步迭代器的 awaitable。执行前者将触发 PendingDeprecationWarning。

库

注释掉在 API 上暴露的未在 GNU/Hurd 上实现的 socket (SO_REUSEPORT) 和 posix (O_SHLOCK, O_EXLOCK) 常量。无论如何，它们在运行时都不会工作。

bpo-27025 [https://bugs.python.org/issue?@action=redirect&bpo=27025]: 现在 Tkinter 小部件生成的名称更有意义且更易于识别。

bpo-25455 [https://bugs.python.org/issue?@action=redirect&bpo=25455]: 修复了递归 ElementTree.Element 和 functools.partial 对象的 repr 中的崩溃。

bpo-27294 [https://bugs.python.org/issue?@action=redirect&bpo=27294]: 改进了 Tkinter 事件对象的 repr。

bpo-20508 [https://bugs.python.org/issue?@action=redirect&bpo=20508]: 改进了 IPv{4,6}Network.__getitem__ 的异常消息。由 Gareth Rees 提供补丁。

bpo-21386 [https://bugs.python.org/issue?@action=redirect&bpo=21386]: 实现了缺失的 IPv4Address.is_global 属性。自 07a5610bae9d 以来已有文档记录。初始由 Roger Luethi 提供补丁。

bpo-27029 [https://bugs.python.org/issue?@action=redirect&bpo=27029]: 从 ZipFile.open() 中移除了对通用换行模式的已弃用支持。

bpo-27030 [https://bugs.python.org/issue?@action=redirect&bpo=27030]: 现在，由 '\' 和一个 ASCII 字母组成的未知转义在正则表达式中是错误。re.LOCALE 标志现在只能用于字节模式。

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 向 DirEntry 添加 os.PathLike 支持（作为 PEP 519 [https://www.python.org/dev/peps/pep-0519] 的一部分）。初始由 Jelle Zijlstra 提供补丁。

bpo-20900 [https://bugs.python.org/issue?@action=redirect&bpo=20900]: distutils register 命令现在能正确解码 HTTP 响应。初始由 ingrid 提供补丁。

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 向 pathlib 添加 os.PathLike 支持，移除其临时状态（作为 PEP 519 的一部分）。初始由 Dusty Phillips 提供补丁。

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 向 os.fsencode() 和 os.fsdecode() 添加对 os.PathLike 对象的支持（作为 PEP 519 [https://www.python.org/dev/peps/pep-0519] 的一部分）。

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 引入 os.PathLike 和 os.fspath()（作为 PEP 519 [https://www.python.org/dev/peps/pep-0519] 的一部分）。

新版本的 typing.py 提供了几个新类和特性：stubs 外的 @overload、Reversible、DefaultDict、Text、ContextManager、Type[]、NewType()、TYPE_CHECKING，以及众多错误修复（注意，一些新特性尚未在 mypy 或其他静态分析器中实现）。同时，为 PEP 492 [https://www.python.org/dev/peps/pep-0492] (Awaitable、AsyncIterable、AsyncIterator) 添加的类也已加入（实际上它们已在 3.5.1 中实现，但从未被提及）。

bpo-25738 [https://bugs.python.org/issue?@action=redirect&bpo=25738]: 停止 http.server.BaseHTTPRequestHandler.send_error() 为 205 Reset Content 发送消息体。同时，不在没有正文的响应中发送 Content 头字段。由 Susumu Koshiba 提供补丁。

bpo-21313 [https://bugs.python.org/issue?@action=redirect&bpo=21313]: 修复 "platform" 模块以容忍 sys.version 包含截断的构建信息。

bpo-23883 [https://bugs.python.org/issue?@action=redirect&bpo=23883]: 向 __all__ 添加缺失的 API 以匹配以下模块的文档化 API：cgi、mailbox、mimetypes、plistlib 和 smtpd。由 Jacek Kołodziej 提供补丁。

bpo-27164 [https://bugs.python.org/issue?@action=redirect&bpo=27164]: 在 zlib 模块中，允许使用预定义的 zdict 解压原始 Deflate 流。基于 Xiang Zhang 的补丁。

bpo-24291 [https://bugs.python.org/issue?@action=redirect&bpo=24291]: 修复 wsgiref.simple_server.WSGIRequestHandler 以完全向客户端写入数据。之前它可能进行部分写入并截断数据。同时，wsgiref.handler.ServerHandler 现在可以处理 stdout 进行部分写入，但此功能已被弃用。

bpo-21272 [https://bugs.python.org/issue?@action=redirect&bpo=21272]: 使用 _sysconfigdata.py 初始化 distutils.sysconfig。

bpo-19611 [https://bugs.python.org/issue?@action=redirect&bpo=19611]: inspect 现在将编译器为推导式和生成器表达式作用域生成的隐式 .0 参数报告为名为 implicit0 的位置参数。由 Jelle Zijlstra 提供补丁。

bpo-26809 [https://bugs.python.org/issue?@action=redirect&bpo=26809]: 向 string 添加了 __all__。由 Emanuel Barry 提供补丁。

bpo-26373 [https://bugs.python.org/issue?@action=redirect&bpo=26373]: subprocess.Popen.communicate 现在在更多/所有情况下，当子进程在调用 .communicate() 之前死亡时，正确地忽略 BrokenPipeError。

signal、socket 和 ssl 模块的 IntEnum 常量名称查找现在为具有多个名称的值返回一致的名称。例如：signal.Signals(6) 现在自称为 signal.SIGALRM，而不是根据解释器的哈希随机化种子在 signal.SIGALRM 和 signal.SIGIOT 之间切换。

bpo-27167 [https://bugs.python.org/issue?@action=redirect&bpo=27167]: 当子进程因信号死亡时，澄清 subprocess.CalledProcessError 错误消息文本。

bpo-25931 [https://bugs.python.org/issue?@action=redirect&bpo=25931]: 在像 Windows 这样不支持 os.fork() 的平台上不定义 socketserver.Forking* 名称。

bpo-21776 [https://bugs.python.org/issue?@action=redirect&bpo=21776]: distutils.upload 现在正确处理 HTTPError。初始由 Claudiu Popa 提供补丁。

bpo-26526 [https://bugs.python.org/issue?@action=redirect&bpo=26526]: 用简单的 DFA 验证器替换解析器模块中的自定义解析树验证。

bpo-27114 [https://bugs.python.org/issue?@action=redirect&bpo=27114]: 修复 SSLContext._load_windows_store_certs 因 PermissionError 失败的问题。

bpo-18383 [https://bugs.python.org/issue?@action=redirect&bpo=18383]: 避免在使用 filterwarnings 和 simplefilter 时创建重复的过滤器。基于 Alex Shkop 的补丁。

bpo-23026 [https://bugs.python.org/issue?@action=redirect&bpo=23026]: winreg.QueryValueEx() 现在为 REG_QWORD 类型返回一个整数。

bpo-26741 [https://bugs.python.org/issue?@action=redirect&bpo=26741]: 如果子进程仍在运行，subprocess.Popen 析构函数现在会发出 ResourceWarning 警告。

bpo-27056 [https://bugs.python.org/issue?@action=redirect&bpo=27056]: 优化 pickle.load() 和 pickle.loads()，反序列化大量小对象时速度提高高达 10%。

bpo-21271 [https://bugs.python.org/issue?@action=redirect&bpo=21271]: reset_mock 调用中的新关键字参数。

IDLE

bpo-5124 [https://bugs.python.org/issue?@action=redirect&bpo=5124]: 在 X11 上，现在粘贴选中的文本会替换选中内容。这匹配了 Windows、Mac、大多数现代 Linux 应用和 ttk 小部件上的粘贴工作方式。原始由 Serhiy Storchaka 提供补丁。

bpo-24750 [https://bugs.python.org/issue?@action=redirect&bpo=24750]: 将 IDLE 中的所有滚动条切换为 ttk 版本。必要时，添加最小测试以覆盖更改。

bpo-24759 [https://bugs.python.org/issue?@action=redirect&bpo=24759]: IDLE 需要 tk 8.5 及 ttk 小部件的可用性。删除现在不再需要的 tk 版本测试和旧版本代码。添加 IDLE 语法着色器的测试。

bpo-27239 [https://bugs.python.org/issue?@action=redirect&bpo=27239]: idlelib.macosx.isXyzTk 函数按需初始化。

bpo-27262 [https://bugs.python.org/issue?@action=redirect&bpo=27262]: 将 Aqua 解绑代码（启用上下文菜单）移至 macosx。

bpo-24759 [https://bugs.python.org/issue?@action=redirect&bpo=24759]: 在 idlelib.idle_test.__init__ 中明确表示该目录是 test.test_idle 的私有实现和维护者的工具。

bpo-27196 [https://bugs.python.org/issue?@action=redirect&bpo=27196]: 在运行 IDLE 测试时停止 'ThemeChanged' 警告。这些警告在其他警告被 #20567 抑制后仍然存在。将 Serhiy Storchaka 的 update_idletasks 解决方案应用于四个测试文件。在 idle_test/README.txt 中记录这一额外建议。

bpo-20567 [https://bugs.python.org/issue?@action=redirect&bpo=20567]: 修改 idle_test/README.txt，提供避免测试中 tk 警告信息的建议。将建议应用于几个 IDLE 测试。

bpo-24225 [https://bugs.python.org/issue?@action=redirect&bpo=24225]: 使用新文件名和事件处理程序更新 idlelib/README.txt。

bpo-27156 [https://bugs.python.org/issue?@action=redirect&bpo=27156]: 移除 IDLE 未使用的过时代码。

bpo-27117 [https://bugs.python.org/issue?@action=redirect&bpo=27117]: 使颜色器 htest 和 turtledemo 支持深色主题。将配置文本小部件颜色的代码移至新函数。

bpo-24225 [https://bugs.python.org/issue?@action=redirect&bpo=24225]: Rename many idlelib/*.py and idle_test/test_*.py files. Edit files to replace old names with new names when the old name referred to the module rather than the class it contained. See the issue and IDLE section in What's New in 3.6 for more.

bpo-26673 [https://bugs.python.org/issue?@action=redirect&bpo=26673]: 当 tk 报告字体大小为 0 时，更改为大小 10。Linux 上的此类字体阻止了配置对话框的打开。

bpo-21939 [https://bugs.python.org/issue?@action=redirect&bpo=21939]: 添加 IDLE 的渗滤器测试。原始由 Saimadhav Heblikar 提供补丁。

bpo-21676 [https://bugs.python.org/issue?@action=redirect&bpo=21676]: 添加 IDLE 的替换对话框测试。原始由 Saimadhav Heblikar 提供补丁。

bpo-18410 [https://bugs.python.org/issue?@action=redirect&bpo=18410]: 添加 IDLE 的搜索对话框测试。原始由 Westley Martínez 提供补丁。

bpo-21703 [https://bugs.python.org/issue?@action=redirect&bpo=21703]: 添加撤销委托器的测试。补丁主要由 Saimadhav Heblikar 提供。

bpo-27044 [https://bugs.python.org/issue?@action=redirect&bpo=27044]: 添加ConfigDialog.remove_var_callbacks以防止内存泄漏。

bpo-23977 [https://bugs.python.org/issue?@action=redirect&bpo=23977]: 在test_delegator中添加更多断言。

文档

bpo-16484 [https://bugs.python.org/issue?@action=redirect&bpo=16484]: 将默认的PYTHONDOCS URL更改为"https:"，并修复结果链接以使用小写。由Sean Rodman提供补丁，测试由Kaushik Nadikuditi进行。

bpo-24136 [https://bugs.python.org/issue?@action=redirect&bpo=24136]: 文档化新的 PEP 448 [https://www.python.org/dev/peps/pep-0448] 解包语法（3.5版本）。

bpo-22558 [https://bugs.python.org/issue?@action=redirect&bpo=22558]: 将剩余的文档链接添加到Python编码模块的源代码中。由Yoni Lavi提供补丁。

测试

bpo-25285 [https://bugs.python.org/issue?@action=redirect&bpo=25285]: 当使用-j1命令行选项时，regrtest现在使用子进程：每个测试文件在一个新的子进程中运行。之前，-j1选项被忽略。

bpo-25285 [https://bugs.python.org/issue?@action=redirect&bpo=25285]: Tools/buildbot/test.bat脚本现在默认使用-j1来在每个新的子进程中运行测试文件。

Windows

bpo-27064 [https://bugs.python.org/issue?@action=redirect&bpo=27064]: py.exe启动器现在默认使用Python 3。Windows启动器 py.exe 在交互使用时不再默认优先选择已安装的Python 2版本而不是Python 3。

bpo-17500 [https://bugs.python.org/issue?@action=redirect&bpo=17500]: 移除未使用和过时的图标。（另见：https://github.com/python/pythondotorg/issues/945）

构建

bpo-27229 [https://bugs.python.org/issue?@action=redirect&bpo=27229]: 修复树内构建的交叉编译pgen规则。由Xavier de Gaye提供补丁。

bpo-26930 [https://bugs.python.org/issue?@action=redirect&bpo=26930]: 更新OS X 10.5+ 32位仅安装程序以构建并与OpenSSL 1.0.2h链接。

C API

bpo-27186 [https://bugs.python.org/issue?@action=redirect&bpo=27186]: 添加PyOS_FSPath()函数（PEP 519 [https://www.python.org/dev/peps/pep-0519] 的一部分）。

bpo-26282 [https://bugs.python.org/issue?@action=redirect&bpo=26282]: PyArg_ParseTupleAndKeywords()现在支持仅位置参数。

工具/示例

bpo-26282 [https://bugs.python.org/issue?@action=redirect&bpo=26282]: Argument Clinic现在支持在同一函数中的仅位置和关键字参数。

Python 3.6.0 alpha 1

发布日期: 2016-05-16

安全性

bpo-26657 [https://bugs.python.org/issue?@action=redirect&bpo=26657]: 修复Windows上http.server的目录遍历漏洞。这修复了在3.3.4rc1和3.4.0rc1中引入的回归问题。基于Philipp Hagemeister的补丁。

bpo-26313 [https://bugs.python.org/issue?@action=redirect&bpo=26313]: 如果windows证书存储为空，ssl.py _load_windows_store_certs失败。由Baji提供补丁。

bpo-25939 [https://bugs.python.org/issue?@action=redirect&bpo=25939]: 在Windows上以只读方式打开证书存储于ssl.enum_certificates中。

核心与内置函数

bpo-20041 [https://bugs.python.org/issue?@action=redirect&bpo=20041]: 修复当frame.f_trace被设置为None时的TypeError。由Xavier de Gaye提供补丁。

bpo-26168 [https://bugs.python.org/issue?@action=redirect&bpo=26168]: 修复了在使用 "N" 格式化单元时 Py_BuildValue() 失败可能导致的内存泄漏问题。

bpo-26991 [https://bugs.python.org/issue?@action=redirect&bpo=26991]: 修复了创建带有注解的函数时可能出现的内存泄漏问题。

bpo-27039 [https://bugs.python.org/issue?@action=redirect&bpo=27039]: 修复了 bytearray.remove() 对于大于127的值的处理。基于 Joe Jevnik 的补丁。

bpo-23640 [https://bugs.python.org/issue?@action=redirect&bpo=23640]: int.from_bytes() 不再绕过子类的构造函数。

bpo-27005 [https://bugs.python.org/issue?@action=redirect&bpo=27005]: 优化了 float.fromhex() 类方法对于精确浮点数的处理。现在速度提高了2倍。

bpo-18531 [https://bugs.python.org/issue?@action=redirect&bpo=18531]: 单一的可变关键字参数如果是字典子类，将不再原封不动地传递给C定义的函数。现在会被转换为确切的字典。

bpo-26811 [https://bugs.python.org/issue?@action=redirect&bpo=26811]: gc.get_objects() 不再包含带有 NULL 指针的损坏元组。

bpo-20120 [https://bugs.python.org/issue?@action=redirect&bpo=20120]: 使用 RawConfigParser 来解析 .pypirc 文件，移除了无意中随着迁移到 Python 3 而添加的插值支持。现在的行为不会再在 .pypirc 文件中进行任何插值，与 Python 2.7 和 Setuptools 19.0 的行为一致。

bpo-26249 [https://bugs.python.org/issue?@action=redirect&bpo=26249]: Memory functions of the PyMem_Malloc() domain (PYMEM_DOMAIN_MEM) now use the pymalloc allocator rather than system malloc(). Applications calling PyMem_Malloc() without holding the GIL can now crash: use PYTHONMALLOC=debug environment variable to validate the usage of memory allocators in your application.

bpo-26802 [https://bugs.python.org/issue?@action=redirect&bpo=26802]: 优化了仅使用解包的函数调用，如 func(*tuple) (没有其他位置参数，没有关键字参数) ：避免复制元组。补丁由 Joe Jevnik 编写。

bpo-26659 [https://bugs.python.org/issue?@action=redirect&bpo=26659]: 使内置的 slice 类型支持循环回收。

bpo-26718 [https://bugs.python.org/issue?@action=redirect&bpo=26718]: super.__init__ 如果被多次调用，将不再泄露内存。注意：不推荐直接调用 super.__init__！

bpo-27138 [https://bugs.python.org/issue?@action=redirect&bpo=27138]: 修正了 FileFinder.find_spec() 的文档注释。

bpo-27147 [https://bugs.python.org/issue?@action=redirect&bpo=27147]: 在 importlib 文档中提到了 PEP 420 [https://www.python.org/dev/peps/pep-0420]。

bpo-25339 [https://bugs.python.org/issue?@action=redirect&bpo=25339]: 现在在设置 stdin 和 stdout 的错误处理器时，PYTHONIOENCODING 优先于 locale。

bpo-26494 [https://bugs.python.org/issue?@action=redirect&bpo=26494]: 修复了在迭代耗尽迭代器时的崩溃问题。受影响的类包括通用序列迭代器、str、bytes、bytearray、list、tuple、set、frozenset、dict、OrderedDict的迭代器，相应的视图以及os.scandir()迭代器。

bpo-26574 [https://bugs.python.org/issue?@action=redirect&bpo=26574]: 优化了 bytes.replace(b'', b'.') 和 bytearray.replace(b'', b'.')。补丁由Josh Snider编写。

bpo-26581 [https://bugs.python.org/issue?@action=redirect&bpo=26581]: 如果在Python源代码文件中一行内多次指定编码声明，只有第一个会被考虑。

bpo-19711 [https://bugs.python.org/issue?@action=redirect&bpo=19711]: 为重新加载命名空间包添加了测试。

bpo-21099 [https://bugs.python.org/issue?@action=redirect&bpo=21099]: 将适用的importlib测试切换到使用 PEP 451 [https://www.python.org/dev/peps/pep-0451] API。

bpo-26563 [https://bugs.python.org/issue?@action=redirect&bpo=26563]: 如果调用 PyMem_Malloc() 系列函数时没有持有GIL，Python内存分配器的调试钩子现在会引发致命错误。

bpo-26564 [https://bugs.python.org/issue?@action=redirect&bpo=26564]: 在错误时，Python内存分配器的调试钩子现在使用 tracemalloc 模块来获取内存块分配时的回溯。

bpo-26558 [https://bugs.python.org/issue?@action=redirect&bpo=26558]: Python内存分配器 PyObject_Malloc() 的调试钩子现在可以检测到在没有持有GIL时调用函数的情况。

bpo-26516 [https://bugs.python.org/issue?@action=redirect&bpo=26516]: 添加了 PYTHONMALLOC 环境变量来设置Python内存分配器和/或安装调试钩子。

bpo-26516 [https://bugs.python.org/issue?@action=redirect&bpo=26516]: PyMem_SetupDebugHooks() 函数现在也可以在发布模式下编译的Python中使用。

bpo-26516 [https://bugs.python.org/issue?@action=redirect&bpo=26516]: PYTHONMALLOCSTATS 环境变量现在也可以在发布模式下编译的Python中使用。如果设置为空字符串，则现在无效。

bpo-26516 [https://bugs.python.org/issue?@action=redirect&bpo=26516]: 在调试模式下，当Python配置为不使用pymalloc时，调试钩子现在也会安装在Python内存分配器上。

bpo-26464 [https://bugs.python.org/issue?@action=redirect&bpo=26464]: 修复了当字符串为ASCII且第一个替换移除了字符，但下一个替换使用非ASCII字符或长度超过1个字符的字符串时str.translate()的问题。这是在Python 3.5.0中引入的回归问题。

bpo-22836 [https://bugs.python.org/issue?@action=redirect&bpo=22836]: 确保即使格式化产生次要错误时，PyErr_Display()和PyErr_WriteUnraisable()产生的异常报告也是合理的。这影响sys.__excepthook__()产生的报告以及__del__()引发异常时的情况。

bpo-26302 [https://bugs.python.org/issue?@action=redirect&bpo=26302]: 修正行为，拒绝将逗号作为cookie名称的合法字符。

bpo-26136 [https://bugs.python.org/issue?@action=redirect&bpo=26136]: 当生成器引发StopIteration时，将警告从PendingDeprecationWarning升级为DeprecationWarning。由Anish Shah提供补丁。

bpo-26204 [https://bugs.python.org/issue?@action=redirect&bpo=26204]: 编译器现在忽略所有常量语句：bytes、str、int、float、complex、名称常量（None、False、True）、Ellipsis和ast.Constant；不仅仅是str和int。例如，``1.0``现在在``def f(): 1.0``中被忽略。

bpo-4806 [https://bugs.python.org/issue?@action=redirect&bpo=4806]: 在函数调用中使用星号（*）解包时，避免掩盖原始的TypeError异常。基于Hagen Fürstenau和Daniel Urban的补丁。

bpo-26146 [https://bugs.python.org/issue?@action=redirect&bpo=26146]: 添加一种新的AST节点：ast.Constant。它可以被外部AST优化器使用，但编译器不直接发出这样的节点。

bpo-23601 [https://bugs.python.org/issue?@action=redirect&bpo=23601]: 通过使用Python的小对象分配器，加速了字典键对象的分配。（由Julian Taylor贡献。）

bpo-18018 [https://bugs.python.org/issue?@action=redirect&bpo=18018]: 如果尝试在没有已知父包的情况下进行相对导入，导入将引发ImportError而不是SystemError。

bpo-25843 [https://bugs.python.org/issue?@action=redirect&bpo=25843]: 编译代码时，如果常量相等但类型不同，则不合并它们。例如，f1, f2 = lambda: 1, lambda: 1.0``现在被正确编译为两个不同的函数：``f1()``返回 ``1 (int) 和``f2()``返回 1.0 (float) ，即使 1 和 1.0 相等。

bpo-26107 [https://bugs.python.org/issue?@action=redirect&bpo=26107]: 代码对象的 co_lnotab 属性的格式更改以支持负行号增量。

bpo-26154 [https://bugs.python.org/issue?@action=redirect&bpo=26154]: 新增一个私有函数_PyThreadState_UncheckedGet()用于获取当前Python线程状态，但如果其为NULL时不发出致命错误。必须使用此新函数而非直接访问_PyThreadState_Current变量。自Python 3.5.1起，该变量不再暴露以隐藏原子C类型的精确实现，避免编译器问题。

bpo-25791 [https://bugs.python.org/issue?@action=redirect&bpo=25791]: 如果__package__ != __spec__.parent或既未定义__package__也未定义__spec__，则引发ImportWarning。

bpo-22995 [https://bugs.python.org/issue?@action=redirect&bpo=22995]: [更新] 由于在基于Cython的项目中观察到的回归问题，注释掉_PyObject_GetState()中的一个可pickle性测试。

bpo-25961 [https://bugs.python.org/issue?@action=redirect&bpo=25961]: 类型名称中不允许空字符。

bpo-25973 [https://bugs.python.org/issue?@action=redirect&bpo=25973]: 修复当无效的非局部语句绑定一个以两个下划线开头的名称时导致的段错误。

bpo-22995 [https://bugs.python.org/issue?@action=redirect&bpo=22995]: 不是列表或字典的子类且未实现任何与pickle相关的方法（__reduce__、__reduce_ex__、__getnewargs__、__getnewargs_ex__或__getstate__）的扩展类型实例，包括memoryview，将不能再被pickle。

bpo-20440 [https://bugs.python.org/issue?@action=redirect&bpo=20440]: 大量替换不安全的属性设置代码为特殊宏Py_SETREF。

bpo-25766 [https://bugs.python.org/issue?@action=redirect&bpo=25766]: 特殊方法__bytes__()现在在str子类中工作。

bpo-25421 [https://bugs.python.org/issue?@action=redirect&bpo=25421]: 内置类型的__sizeof__方法现在使用动态基本大小。这使得sys.getsize()能够正确工作于定义了__slots__的子类。

bpo-25709 [https://bugs.python.org/issue?@action=redirect&bpo=25709]: 修复了原地字符串连接和utf-8缓存的问题。

bpo-5319 [https://bugs.python.org/issue?@action=redirect&bpo=5319]: 新增Py_FinalizeEx() API，允许Python在刷新缓冲流失败时设置退出状态为120。

bpo-25485 [https://bugs.python.org/issue?@action=redirect&bpo=25485]: telnetlib.Telnet现在是一个上下文管理器。

bpo-24097 [https://bugs.python.org/issue?@action=redirect&bpo=24097]: 修复了如果槽名称在__getattr__内部被释放时object.__reduce__()中的崩溃问题。

bpo-24731 [https://bugs.python.org/issue?@action=redirect&bpo=24731]: 修复了在将具有特殊方法 __bytes__、__trunc__ 和 __float__ 的对象转换为 bytes、int 和 float 的子类时，返回这些子类实例导致的崩溃问题。

bpo-25630 [https://bugs.python.org/issue?@action=redirect&bpo=25630]: 修复了在接受文件系统路径的函数中，参数解析时可能发生的段错误。

bpo-23564 [https://bugs.python.org/issue?@action=redirect&bpo=23564]: 修复了 _posixsubprocess 内部关于如何将 fds_to_pass 传递给子进程的部分损坏的健全性检查。由于 subprocess.py 已经避免了这个问题，这个错误没有实际影响。

bpo-25388 [https://bugs.python.org/issue?@action=redirect&bpo=25388]: 修复了在处理包含空字节的不可解码源代码时，分词器崩溃的问题。

bpo-25462 [https://bugs.python.org/issue?@action=redirect&bpo=25462]: 在 OrderedDict 的 C 实现中，大多数操作现在只计算一次键的哈希值。

bpo-22995 [https://bugs.python.org/issue?@action=redirect&bpo=22995]: __reduce__ 和 __reduce_ex__ 的默认实现现在拒绝那些未定义 __new__ 的内置类型。

bpo-24802 [https://bugs.python.org/issue?@action=redirect&bpo=24802]: 当 int()、float()、compile()、exec() 和 eval() 传递类似字节的对象时，避免缓冲区过度读取。这些对象不一定以空字节终止，但函数假设它们是。

bpo-25555 [https://bugs.python.org/issue?@action=redirect&bpo=25555]: 修复解析器和 AST：当从 Python 对象编译 AST 时，填充 "arg" 节点的 lineno 和 col_offset。

bpo-24726 [https://bugs.python.org/issue?@action=redirect&bpo=24726]: 修复了 OrderedDict 在直接调用 dict 方法后被 repr() 时崩溃和泄漏 NULL 的问题。

bpo-25449 [https://bugs.python.org/issue?@action=redirect&bpo=25449]: 现在在 C 实现和 Python 实现中，迭代具有不稳定哈希键的 OrderedDict 都会引发 KeyError。

bpo-25395 [https://bugs.python.org/issue?@action=redirect&bpo=25395]: 修复了在垃圾回收高度嵌套的 OrderedDict 结构时崩溃的问题。

bpo-25395 [https://bugs.python.org/issue?@action=redirect&bpo=25395]: 优化了 bytes.fromhex() 和 bytearray.fromhex()：它们现在快了 2 到 3.5 倍。

bpo-25399 [https://bugs.python.org/issue?@action=redirect&bpo=25399]: 使用新的私有 _PyBytesWriter API 优化了 bytearray % args 操作。格式化现在快了 2.5 到 5 倍。

bpo-25274 [https://bugs.python.org/issue?@action=redirect&bpo=25274]: sys.setrecursionlimit() 现在如果新的递归限制根据当前递归深度太低会引发 RecursionError。同时修改“低水位标记”公式使其单调。这个标记用于决定何时重置线程状态的溢出标志。

bpo-24402 [https://bugs.python.org/issue?@action=redirect&bpo=24402]: 修复 input() 在 sys.stdout.fileno() 失败时提示重定向的 stdout。

bpo-25349 [https://bugs.python.org/issue?@action=redirect&bpo=25349]: 使用新的私有 _PyBytesWriter API 优化 bytes % args。格式化现在快达2倍。

bpo-24806 [https://bugs.python.org/issue?@action=redirect&bpo=24806]: 防止不允许被继承的内置类型通过多重继承被继承。

bpo-25301 [https://bugs.python.org/issue?@action=redirect&bpo=25301]: UTF-8 解码器现在对于错误处理程序 ignore、replace 和 surrogateescape 快达15倍。

bpo-24848 [https://bugs.python.org/issue?@action=redirect&bpo=24848]: 修复了UTF-7解码畸形数据时的一些错误。

bpo-25267 [https://bugs.python.org/issue?@action=redirect&bpo=25267]: UTF-8 编码器现在对于错误处理程序 ignore、replace、surrogateescape、surrogatepass 快达75倍。补丁与Serhiy Storchaka共同编写。

bpo-25280 [https://bugs.python.org/issue?@action=redirect&bpo=25280]: 在详细模式(-v)下发出的导入跟踪消息不再格式化两次。

bpo-25227 [https://bugs.python.org/issue?@action=redirect&bpo=25227]: 使用 surrogateescape 错误处理程序优化ASCII和latin1编码器：编码器现在快达3倍。初始补丁由Serhiy Storchaka编写。

bpo-25003 [https://bugs.python.org/issue?@action=redirect&bpo=25003]: 在Solaris 11.3或更新版本上，os.urandom() 现在使用 getrandom() 函数而不是 getentropy() 函数。getentropy() 函数为了生成非常高质量的熵是阻塞的，os.urandom() 不需要如此高质量的熵。

bpo-9232 [https://bugs.python.org/issue?@action=redirect&bpo=9232]: 修改Python的语法以允许函数声明的参数列表中的尾随逗号。例如，“def f(*, a = 3,): pass”现在是合法的。补丁来自Mark Dickinson。

bpo-24965 [https://bugs.python.org/issue?@action=redirect&bpo=24965]: 实现 PEP 498 [https://www.python.org/dev/peps/pep-0498] "字面字符串插值"。这允许你在f-字符串中嵌入表达式，这些表达式在运行时被转换为普通字符串。给定x=3，那么 f'value={x}' == 'value=3'。由Eric V. Smith提供补丁。

bpo-26478 [https://bugs.python.org/issue?@action=redirect&bpo=26478]: 修复在使用二进制运算符与字典视图和元组时的语义错误。

bpo-26171 [https://bugs.python.org/issue?@action=redirect&bpo=26171]: 修复zipimporter.get_data()中可能的整数溢出和堆损坏问题。

bpo-25660 [https://bugs.python.org/issue?@action=redirect&bpo=25660]: 修复REPL中使用readline时的TAB键行为。

bpo-26288 [https://bugs.python.org/issue?@action=redirect&bpo=26288]: 优化PyLong_AsDouble。

bpo-26289 [https://bugs.python.org/issue?@action=redirect&bpo=26289]: 优化单数字长整数的地板除和模除运算。微基准测试显示有2-2.5倍的提升。内置的'divmod'函数现在也快了约10%。（另见：bpo-26315 [https://bugs.python.org/issue?@action=redirect&bpo=26315]）

bpo-25887 [https://bugs.python.org/issue?@action=redirect&bpo=25887]: 当协程对象被多次等待时，抛出RuntimeError。

库

bpo-27057 [https://bugs.python.org/issue?@action=redirect&bpo=27057]: 修复Android上的os.set_inheritable()，ioctl()被SELinux阻止并因EACCESS失败。该函数现在回退到使用fcntl()。补丁由Michał Bednarski编写。

bpo-27014 [https://bugs.python.org/issue?@action=redirect&bpo=27014]: 修复使用typing.py时的无限递归问题。感谢Kalle Tuure！

bpo-27031 [https://bugs.python.org/issue?@action=redirect&bpo=27031]: 移除了Tkinter小部件类中的虚拟方法：tk_menuBar()和tk_bindForTraversal()。

bpo-14132 [https://bugs.python.org/issue?@action=redirect&bpo=14132]: 修复urllib.request在目标仅有查询字符串时的重定向处理。原始修复由Ján Janech提供。

bpo-17214 [https://bugs.python.org/issue?@action=redirect&bpo=17214]: "urllib.request"模块现在对重定向目标URL中的非ASCII字节进行百分比编码。一些服务器发送含有非ASCII字节的Location头字段，但"http.client"要求请求目标必须可ASCII编码，否则会抛出UnicodeEncodeError。基于Christian Heimes的补丁。

bpo-27033 [https://bugs.python.org/issue?@action=redirect&bpo=27033]: smtpd.SMTPChannel和smtpd.SMTPServer构造函数的decode_data参数的默认值更改为False。

bpo-27034 [https://bugs.python.org/issue?@action=redirect&bpo=27034]: 移除了已弃用的类asynchat.fifo。

bpo-26870 [https://bugs.python.org/issue?@action=redirect&bpo=26870]: 添加了readline.set_auto_history()，可以阻止条目自动添加到历史列表中。基于Tyler Crompton的补丁。

bpo-26039 [https://bugs.python.org/issue?@action=redirect&bpo=26039]: zipfile.ZipFile.open()现在可用于向ZIP文件中写入数据，以及提取数据。由Thomas Kluyver提供补丁。

bpo-26892 [https://bugs.python.org/issue?@action=redirect&bpo=26892]: 在urllib.request.HTTPHandler中尊重debuglevel标志。补丁由Chi Hsuan Yen贡献。

bpo-22274 [https://bugs.python.org/issue?@action=redirect&bpo=22274]: 在subprocess模块中，即使stdout未被重定向，也允许将stderr重定向到stdout。补丁由Akira Li提供。

bpo-26807 [https://bugs.python.org/issue?@action=redirect&bpo=26807]: mock_open 'files' 在文件末尾的readline操作不再报错。补丁由Yolanda Robla提供。

bpo-25745 [https://bugs.python.org/issue?@action=redirect&bpo=25745]: 修复了curses panel析构函数中userptr的泄漏问题。

bpo-26977 [https://bugs.python.org/issue?@action=redirect&bpo=26977]: 在statistics.pvariance中移除了不必要且被忽略的平方和辅助函数调用。

bpo-26002 [https://bugs.python.org/issue?@action=redirect&bpo=26002]: 在statistics.median中使用二分查找替代线性搜索。由Upendra Kuma提供补丁。

bpo-25974 [https://bugs.python.org/issue?@action=redirect&bpo=25974]: 在统计模块中利用了新的Decimal.as_integer_ratio()方法。补丁由Stefan Krah提供。

bpo-26996 [https://bugs.python.org/issue?@action=redirect&bpo=26996]: 添加了如 PEP 506 [https://www.python.org/dev/peps/pep-0506] 所述的secrets模块。

bpo-26881 [https://bugs.python.org/issue?@action=redirect&bpo=26881]: modulefinder模块现在支持扩展的操作码参数。

bpo-23815 [https://bugs.python.org/issue?@action=redirect&bpo=23815]: 修复了直接创建_tkinter和curses.panel模块中类型实例相关的崩溃问题。

bpo-17765 [https://bugs.python.org/issue?@action=redirect&bpo=17765]: weakref.ref()不再默默忽略关键字参数。由Georg Brandl提供补丁。

bpo-26873 [https://bugs.python.org/issue?@action=redirect&bpo=26873]: xmlrpc现在会在遇到不支持的类型标签时抛出ResponseError，而不是默默返回错误结果。

bpo-26915 [https://bugs.python.org/issue?@action=redirect&bpo=26915]: collections ABCs中的__contains__方法现在在检查相等性之前先检查标识。这更好地匹配了具体类的行为，允许合理处理NaNs，并使容器不变量的推理更加容易。

bpo-26711 [https://bugs.python.org/issue?@action=redirect&bpo=26711]: 修复了plistlib.Data与其他类型的比较问题。

bpo-24114 [https://bugs.python.org/issue?@action=redirect&bpo=24114]: Fix an uninitialized variable in ctypes.util. The bug only occurs on SunOS when the ctypes implementation searches for the crle program. Patch by Xiang Zhang. Tested on SunOS by Kees Bos.

bpo-26864 [https://bugs.python.org/issue?@action=redirect&bpo=26864]: 在urllib.request中，将代理绕过主机检查对no_proxy的匹配改为不区分大小写，并且不匹配那些恰好以后缀形式包含被绕过主机名的无关主机名。由Xiang Zhang提供补丁。

bpo-24902 [https://bugs.python.org/issue?@action=redirect&bpo=24902]: 在http.server启动时打印服务器URL。初始由Felix Kaiser提供补丁。

bpo-25788 [https://bugs.python.org/issue?@action=redirect&bpo=25788]: fileinput.hook_encoded() 现在支持传递一个 "errors" 参数给 open。原始补丁由 Joseph Hackman 提供。

bpo-26634 [https://bugs.python.org/issue?@action=redirect&bpo=26634]: recursive_repr() 现在设置包装器的 __qualname__。由 Xiang Zhang 提供补丁。

bpo-26804 [https://bugs.python.org/issue?@action=redirect&bpo=26804]: urllib.request 现在会优先选择小写的代理环境变量，而不是大写或混合大小写的。补丁由 Hans-Peter Jansen 贡献。

bpo-26837 [https://bugs.python.org/issue?@action=redirect&bpo=26837]: assertSequenceEqual() 现在能正确输出非字符串化的不同项（如 -b 模式下的字节）。这影响了 assertListEqual() 和 assertTupleEqual()。

bpo-26041 [https://bugs.python.org/issue?@action=redirect&bpo=26041]: 从 platform.dist() 和 platform.linux_distribution() 的弃用消息中移除了 "将在 Python 3.7 中移除"。由 Kumaripaba Miyurusara Athukorala 提供补丁。

bpo-26822 [https://bugs.python.org/issue?@action=redirect&bpo=26822]: itemgetter、attrgetter 和 methodcaller 对象不再静默忽略关键字参数。

bpo-26733 [https://bugs.python.org/issue?@action=redirect&bpo=26733]: 反汇编一个类现在会反汇编类和静态方法。由 Xiang Zhang 提供补丁。

bpo-26801 [https://bugs.python.org/issue?@action=redirect&bpo=26801]: 修复 shutil.get_terminal_size() 中的错误处理，捕获 AttributeError 而不是 NameError。补丁由 Emanuel Barry 编写。

bpo-24838 [https://bugs.python.org/issue?@action=redirect&bpo=24838]: tarfile 的 ustar 和 gnu 格式现在能正确计算多字节字符编码（如 utf-8）的名称和链接字段限制。

bpo-26717 [https://bugs.python.org/issue?@action=redirect&bpo=26717]: 停止用 UTF-8 编码拉丁-1 化的 WSGI 路径。由 Anthony Sottile 提供补丁。

bpo-26782 [https://bugs.python.org/issue?@action=redirect&bpo=26782]: 在 Windows 上向 subprocess.__all__ 添加 STARTUPINFO。

bpo-26404 [https://bugs.python.org/issue?@action=redirect&bpo=26404]: 向 socketserver 添加上下文管理器。由 Aviv Palivoda 提供补丁。

bpo-26735 [https://bugs.python.org/issue?@action=redirect&bpo=26735]: 修复 Solaris 11.3 及更新版本上 os.urandom() 当读取超过 1,024 字节时的问题：多次调用 getrandom()，每次调用限制为 1024 字节。

bpo-26585 [https://bugs.python.org/issue?@action=redirect&bpo=26585]: 移除 http.server._quote_html() 并使用 html.escape(quote=False)。由 Xiang Zhang 提供补丁。

bpo-26685 [https://bugs.python.org/issue?@action=redirect&bpo=26685]: 如果关闭套接字失败，则引发 OSError。

bpo-16329 [https://bugs.python.org/issue?@action=redirect&bpo=16329]: 向 mimetypes.types_map 添加 .webm。由 Giampaolo Rodola' 提供补丁。

bpo-13952 [https://bugs.python.org/issue?@action=redirect&bpo=13952]: 向 mimetypes.types_map 添加 .csv。由 Geoff Wilson 提供补丁。

bpo-26587 [https://bugs.python.org/issue?@action=redirect&bpo=26587]: 站点模块现在允许 .pth 文件指定要添加到 sys.path 的文件（例如 zip 文件）。

bpo-25609 [https://bugs.python.org/issue?@action=redirect&bpo=25609]: 引入了 contextlib.AbstractContextManager 和 typing.ContextManager。

bpo-26709 [https://bugs.python.org/issue?@action=redirect&bpo=26709]: 修复了加载二进制 PLists 时的 Y2038 问题。

bpo-23735 [https://bugs.python.org/issue?@action=redirect&bpo=23735]: 通过安装我们自己的 SIGWINCH 处理程序，处理 Readline 6.3+ 的终端调整大小。由 Eric Price 提供补丁。

bpo-25951 [https://bugs.python.org/issue?@action=redirect&bpo=25951]: 将 SSLSocket.sendall() 更改为返回 None，如明文套接字对象文档中明确所述。补丁由 Aviv Palivoda 提供。

bpo-26586 [https://bugs.python.org/issue?@action=redirect&bpo=26586]: 在 http.server 中，如果头字段太多无法解析，则响应 "413 请求头字段太大"，而不是终止连接并引发未处理的异常。由 Xiang Zhang 提供补丁。

bpo-26676 [https://bugs.python.org/issue?@action=redirect&bpo=26676]: 将缺失的 XMLPullParser 添加到 ElementTree.__all__。

bpo-22854 [https://bugs.python.org/issue?@action=redirect&bpo=22854]: 将 BufferedReader.writable() 和 BufferedWriter.readable() 更改为总是返回 False。

bpo-26492 [https://bugs.python.org/issue?@action=redirect&bpo=26492]: array.array 的耗尽迭代器现在与其他可变序列的迭代器行为一致：即使迭代的数组被扩展，它也会保持耗尽状态。

bpo-26641 [https://bugs.python.org/issue?@action=redirect&bpo=26641]: doctest.DocFileTest and doctest.testfile() now support packages (module splitted into multiple directories) for the package parameter.

bpo-25195 [https://bugs.python.org/issue?@action=redirect&bpo=25195]: 修复了 mock.MagicMock 中的一个回归问题。_Call 是 tuple 的子类（changeset 3603bae63c13 仅适用于类），所以我们需要自己实现 __ne__。由 Andrew Plummer 提供补丁。

bpo-26644 [https://bugs.python.org/issue?@action=redirect&bpo=26644]: 当向 SSLSocket.recv() 或 read() 传递负长度时，引发 ValueError 而不是 SystemError。

bpo-23804 [https://bugs.python.org/issue?@action=redirect&bpo=23804]: 修复 SSL recv(0) 和 read(0) 方法返回零字节而不是最多 1024 字节的问题。

bpo-26616 [https://bugs.python.org/issue?@action=redirect&bpo=26616]: 修复了 datetime.astimezone() 方法中的一个错误。

bpo-26637 [https://bugs.python.org/issue?@action=redirect&bpo=26637]: 现在，如果在 Python 关闭过程中尝试 __import__() 但 sys.path 已经被清除（设置为 None），importlib 模块会发出 ImportError 而不是 TypeError。

bpo-21925 [https://bugs.python.org/issue?@action=redirect&bpo=21925]: warnings.formatwarning() 现在在调用 linecache.getline() 和 tracemalloc.get_object_traceback() 时会捕获异常，以便能够记录在Python关闭过程中晚期发出的 ResourceWarning。

bpo-23848 [https://bugs.python.org/issue?@action=redirect&bpo=23848]: 在Windows上，faulthandler.enable() 现在也会安装一个异常处理器，以在任何Windows异常（不仅仅是UNIX信号（SIGSEGV、SIGFPE、SIGABRT））上转储所有Python线程的跟踪信息。

bpo-26530 [https://bugs.python.org/issue?@action=redirect&bpo=26530]: Add C functions _PyTraceMalloc_Track() and _PyTraceMalloc_Untrack() to track memory blocks using the tracemalloc module. Add _PyTraceMalloc_GetTraceback() to get the traceback of an object.

bpo-26588 [https://bugs.python.org/issue?@action=redirect&bpo=26588]: _tracemalloc 现在支持跟踪多个地址空间（域）的内存分配。

bpo-24266 [https://bugs.python.org/issue?@action=redirect&bpo=24266]: 在编译时使用Readline 7的情况下，Readline历史搜索期间的Ctrl+C现在会取消搜索模式。

bpo-26590 [https://bugs.python.org/issue?@action=redirect&bpo=26590]: 为_socket.socket类型实现了一个安全的终结器。它现在会释放GIL来关闭套接字。

bpo-18787 [https://bugs.python.org/issue?@action=redirect&bpo=18787]: 如果用户没有权限，spwd.getspnam() 现在会引发一个PermissionError。

bpo-26560 [https://bugs.python.org/issue?@action=redirect&bpo=26560]: 避免BaseHandler.start_response中潜在的ValueError。初始由Peter Inglesby提供补丁。

bpo-26567 [https://bugs.python.org/issue?@action=redirect&bpo=26567]: 添加一个新函数 PyErr_ResourceWarning() 来传递被销毁的对象。向 warnings.WarningMessage 添加一个 source 属性。添加warnings._showwarnmsg()，它使用tracemalloc来获取源对象分配时的跟踪信息。

bpo-26569 [https://bugs.python.org/issue?@action=redirect&bpo=26569]: 修复 pyclbr.readmodule() 和 pyclbr.readmodule_ex() 以支持导入包。

bpo-26499 [https://bugs.python.org/issue?@action=redirect&bpo=26499]: 在HTTPResponse.readline()和read1()中考虑剩余的Content-Length。基于Silent Ghost的补丁。同时记录HTTPResponse现在支持这些方法。

bpo-25320 [https://bugs.python.org/issue?@action=redirect&bpo=25320]: 处理unittest发现扫描的目录中的套接字。补丁来自Victor van den Elzen。

bpo-16181 [https://bugs.python.org/issue?@action=redirect&bpo=16181]: 现在如果年份高于datetime.MAXYEAR，cookiejar.http2time()会返回None。

bpo-26513 [https://bugs.python.org/issue?@action=redirect&bpo=26513]: 修复了平台模块对Windows Server的检测。

bpo-23718 [https://bugs.python.org/issue?@action=redirect&bpo=23718]: 修复了在1月1日前的第0周解析时间的问题。原始由Tamás Bence Gedai提供补丁。

bpo-26323 [https://bugs.python.org/issue?@action=redirect&bpo=26323]: 向unittest.mock添加了Mock.assert_called()和Mock.assert_called_once()方法。补丁由Amit Saha编写。

bpo-20589 [https://bugs.python.org/issue?@action=redirect&bpo=20589]: 在Windows上调用Path.owner()和Path.group()现在会引发NotImplementedError而不是ImportError。

bpo-26177 [https://bugs.python.org/issue?@action=redirect&bpo=26177]: 修复了Canvas和Scrollbar小部件的keys()方法。

bpo-15068 [https://bugs.python.org/issue?@action=redirect&bpo=15068]: 消除了fileinput中过度的缓冲。bufsize参数现在已被弃用并被忽略。

bpo-19475 [https://bugs.python.org/issue?@action=redirect&bpo=19475]: 向datetime的isoformat()方法添加了一个可选参数timespec，用于选择时间组件的精度。

bpo-2202 [https://bugs.python.org/issue?@action=redirect&bpo=2202]: 修复了AbstractDigestAuthHandler.get_algorithm_impls中的UnboundLocalError。初始由Mathieu Dupuy提供补丁。

bpo-26167 [https://bugs.python.org/issue?@action=redirect&bpo=26167]: 最小化了copy.copy()和copy.deepcopy()的开销。优化了bytearrays、NotImplemented、slices、短列表、元组、字典和集合的复制和深复制。

bpo-25718 [https://bugs.python.org/issue?@action=redirect&bpo=25718]: 修复了当total为None时，对accumulate()迭代器的pickling和复制。

bpo-26475 [https://bugs.python.org/issue?@action=redirect&bpo=26475]: 修复了带有(?x)标志的正则表达式的调试输出。

bpo-26482 [https://bugs.python.org/issue?@action=redirect&bpo=26482]: 允许pickling递归的dequeues。

bpo-26335 [https://bugs.python.org/issue?@action=redirect&bpo=26335]: 使mmap.write()像其他write方法一样返回写入的字节数。补丁由Jakub Stasiak提供。

bpo-26457 [https://bugs.python.org/issue?@action=redirect&bpo=26457]: 修复了当结果前缀长度等于最大前缀长度时，IP网络类中的subnets()方法。基于Xiang Zhang的补丁。

bpo-26385 [https://bugs.python.org/issue?@action=redirect&bpo=26385]: 如果NamedTemporaryFile()中的内部open()调用失败，则删除文件。由Silent Ghost提供补丁。

bpo-26402 [https://bugs.python.org/issue?@action=redirect&bpo=26402]: 修复了XML-RPC客户端在服务器关闭持久连接时重试的问题。这是与3.5.0a4中的新http.client.RemoteDisconnected异常相关的回归问题。

bpo-25913 [https://bugs.python.org/issue?@action=redirect&bpo=25913]: 在adobe=True时，base64.a85decode()中前导的 <~ 现在是可选的。由Swati Jaiswal提供补丁。

bpo-26186 [https://bugs.python.org/issue?@action=redirect&bpo=26186]: 移除importlib.util.LazyLoader中的一个无效类型检查。

bpo-26367 [https://bugs.python.org/issue?@action=redirect&bpo=26367]: 当指定了 level 但没有指定相应的包时，importlib.__import__()会像builtins.__import__()一样引发ImportError。

bpo-26309 [https://bugs.python.org/issue?@action=redirect&bpo=26309]: 在"socketserver"模块中，当verify_request()返回false时，关闭请求（关闭连接的套接字）。由Aviv Palivoda提供补丁。

bpo-23430 [https://bugs.python.org/issue?@action=redirect&bpo=23430]: 更改socketserver模块，只捕获源自Exception（而不是BaseException）的请求处理程序引发的异常。因此，SystemExit和KeyboardInterrupt不再触发handle_error()方法，现在将停止单线程服务器。

bpo-25995 [https://bugs.python.org/issue?@action=redirect&bpo=25995]: os.walk()不再使用与树深度成比例的FDs。

bpo-25994 [https://bugs.python.org/issue?@action=redirect&bpo=25994]: 为os.scandir()迭代器添加了close()方法和上下文管理器协议的支持。

bpo-23992 [https://bugs.python.org/issue?@action=redirect&bpo=23992]: multiprocessing：使MapResult在异常时不快速失败。

bpo-26243 [https://bugs.python.org/issue?@action=redirect&bpo=26243]: 支持zlib.compress()的关键字参数。由Aviv Palivoda提供补丁。

bpo-26117 [https://bugs.python.org/issue?@action=redirect&bpo=26117]: os.scandir()迭代器现在不仅在迭代完成时关闭文件描述符，而且在因错误失败时也关闭。

bpo-25949 [https://bugs.python.org/issue?@action=redirect&bpo=25949]: OrderedDict实例的__dict__现在只在需要时创建。

bpo-25911 [https://bugs.python.org/issue?@action=redirect&bpo=25911]: 恢复了在Windows上os.walk()中对字节路径的支持。

bpo-26045 [https://bugs.python.org/issue?@action=redirect&bpo=26045]: 在使用http.client发布非Latin-1字符串时，向错误消息添加UTF-8建议。

bpo-26039 [https://bugs.python.org/issue?@action=redirect&bpo=26039]: 添加了zipfile.ZipInfo.from_file()和zipinfo.ZipInfo.is_dir()。由Thomas Kluyver提供补丁。

bpo-12923 [https://bugs.python.org/issue?@action=redirect&bpo=12923]: 即使有异常也重置FancyURLopener的重定向计数器。基于Brian Brazil和Daniel Rocco的补丁。

bpo-25945 [https://bugs.python.org/issue?@action=redirect&bpo=25945]: 修复了解除 pickle functools.partial 对象时状态错误导致的崩溃问题。修复了 functools.partial 构造函数失败时的内存泄漏。functools.partial 的 "args" 和 "keywords" 属性现在总是分别具有 tuple 和 dict 类型。

bpo-26202 [https://bugs.python.org/issue?@action=redirect&bpo=26202]: copy.deepcopy() 现在能正确复制具有非原子属性的 range() 对象。

bpo-23076 [https://bugs.python.org/issue?@action=redirect&bpo=23076]: Path.glob() 现在在调用无效模式时会引发 ValueError。补丁由 Thomas Nyberg 提供。

bpo-19883 [https://bugs.python.org/issue?@action=redirect&bpo=19883]: 修复了 zipimport 中可能的整数溢出问题。

bpo-26227 [https://bugs.python.org/issue?@action=redirect&bpo=26227]: 在 Windows 上，socket 模块的 getnameinfo()、gethostbyaddr() 和 gethostbyname_ex() 函数现在从 ANSI 代码页而非 UTF-8 解码主机名。

bpo-26099 [https://bugs.python.org/issue?@action=redirect&bpo=26099]: site 模块现在会在 sitecustomize 模块可以导入但执行该模块时引发 ImportError 时，向 stderr 写入错误信息。对 usercustomize 做了相同的更改。

bpo-26147 [https://bugs.python.org/issue?@action=redirect&bpo=26147]: xmlrpc 现在可以处理无法用所使用的非 UTF-8 编码编码的字符串。

bpo-25935 [https://bugs.python.org/issue?@action=redirect&bpo=25935]: 垃圾回收器现在可以打破 OrderedDict 的引用循环。

bpo-16620 [https://bugs.python.org/issue?@action=redirect&bpo=16620]: 修复了 msilib.Directory.glob() 中的 AttributeError。

bpo-26013 [https://bugs.python.org/issue?@action=redirect&bpo=26013]: 增加了对旧 Python 3 版本（3.4.3 及以下）创建的损坏协议 2 pickle 的兼容性。

bpo-26129 [https://bugs.python.org/issue?@action=redirect&bpo=26129]: 废弃了在 grp.getgrgid() 中接受非整数。

bpo-25850 [https://bugs.python.org/issue?@action=redirect&bpo=25850]: 默认使用交叉编译为 64 位 Windows。

bpo-25822 [https://bugs.python.org/issue?@action=redirect&bpo=25822]: 向 urllib.parse 结果的字段添加了文档字符串。由 Swati Jaiswal 提供补丁。

bpo-22642 [https://bugs.python.org/issue?@action=redirect&bpo=22642]: 将 trace 模块的选项解析机制转换为 argparse。由 SilentGhost 提供补丁。

bpo-24705 [https://bugs.python.org/issue?@action=redirect&bpo=24705]: 修复了 sysconfig._parse_makefile 不扩展出现在 $() 变量之前的 ${} 变量的问题。

bpo-26069 [https://bugs.python.org/issue?@action=redirect&bpo=26069]: 移除了 trace 模块中已弃用的 API。

bpo-22138 [https://bugs.python.org/issue?@action=redirect&bpo=22138]: 修复了 mock.patch 在修补描述符时的行为。修补后恢复原始值。由 Sean McCully 提供补丁。

bpo-25672 [https://bugs.python.org/issue?@action=redirect&bpo=25672]: 在 ssl 模块中，如果安全的话，启用 SSL_MODE_RELEASE_BUFFERS 模式选项。

bpo-26012 [https://bugs.python.org/issue?@action=redirect&bpo=26012]: 在 pathlib.Path.[r]glob() 中不对符号链接进行 ** 模式的遍历。

bpo-24120 [https://bugs.python.org/issue?@action=redirect&bpo=24120]: 在使用 pathlib.Path.[r]glob() 遍历树时忽略 PermissionError。由 Ulrich Petri 提供补丁。

bpo-21815 [https://bugs.python.org/issue?@action=redirect&bpo=21815]: 在 imap 响应的数据部分接受 ] 字符，以处理由 gmail 等服务器接受和产生的带有方括号的标志。

bpo-25447 [https://bugs.python.org/issue?@action=redirect&bpo=25447]: 如果 sys.stdin 没有缓冲区属性，fileinput 现在会直接使用它（恢复了向后兼容性）。

bpo-25971 [https://bugs.python.org/issue?@action=redirect&bpo=25971]: 通过 2 倍的速度优化了从浮点数创建 Fractions，通过 3 倍的速度优化了从 Decimals 创建 Fractions。

bpo-25802 [https://bugs.python.org/issue?@action=redirect&bpo=25802]: 将 importlib.abc.Loader.load_module() 的剩余实现文档化为已弃用。

bpo-25928 [https://bugs.python.org/issue?@action=redirect&bpo=25928]: 添加了 Decimal.as_integer_ratio()。

bpo-25447 [https://bugs.python.org/issue?@action=redirect&bpo=25447]: 复制 lru_cache() 包装器对象现在总是有效，与被包装对象的类型无关（通过返回未更改的原始对象）。

bpo-25768 [https://bugs.python.org/issue?@action=redirect&bpo=25768]: 使 compileall 中的函数返回布尔值而不是整数，并为返回值添加了适当的文档和测试。

bpo-24103 [https://bugs.python.org/issue?@action=redirect&bpo=24103]: 修复了 ElementTree.XMLPullParser 中可能的使用后释放问题。

bpo-25860 [https://bugs.python.org/issue?@action=redirect&bpo=25860]: os.fwalk() 在发生错误时不再跳过剩余的目录。原始由 Samson Lee 提供补丁。

bpo-25914 [https://bugs.python.org/issue?@action=redirect&bpo=25914]: 修复并简化了 OrderedDict.__sizeof__。

bpo-25869 [https://bugs.python.org/issue?@action=redirect&bpo=25869]: 优化了 ElementTree 的深拷贝；现在速度快了 20 倍。

bpo-25873 [https://bugs.python.org/issue?@action=redirect&bpo=25873]: 优化了 ElementTree 的迭代。迭代元素 Element.iter() 现在快了 40%，迭代文本 Element.itertext() 现在快了最多 2.5 倍。

bpo-25902 [https://bugs.python.org/issue?@action=redirect&bpo=25902]: 修复了 ElementTree 迭代中的各种引用计数问题。

bpo-22227 [https://bugs.python.org/issue?@action=redirect&bpo=22227]: TarFile 迭代器使用生成器重新实现。这个实现比使用类更简单。

bpo-25638 [https://bugs.python.org/issue?@action=redirect&bpo=25638]: 优化了 ElementTree.iterparse()；现在快了 2 倍。优化了 ElementTree 解析；现在快了 10%。

bpo-25761 [https://bugs.python.org/issue?@action=redirect&bpo=25761]: 改进了对损坏的 pickle 数据中错误的检测。

bpo-25717 [https://bugs.python.org/issue?@action=redirect&bpo=25717]: 恢复在打开文件时容忍大多数fstat()错误的先前行为。这是3.5a1版本中的一个回归问题，阻止了匿名临时文件在特殊情况下的工作。

bpo-24903 [https://bugs.python.org/issue?@action=redirect&bpo=24903]: 修复了当指定'-d'时compileall接受的参数数量的回归问题。对参数数量的检查已被完全删除，因为它从未正确工作过。

bpo-25764 [https://bugs.python.org/issue?@action=redirect&bpo=25764]: 在subprocess模块中，当使用preexec_fn时，保留由fork()失败引起的任何异常。

bpo-25771 [https://bugs.python.org/issue?@action=redirect&bpo=25771]: 当'package'未指定但必要时，调整importlib.util.resolve_name()的异常消息。

bpo-6478 [https://bugs.python.org/issue?@action=redirect&bpo=6478]: 在更改时区后，_strptime的正则表达式缓存现在会被time.tzset()重置。

bpo-14285 [https://bugs.python.org/issue?@action=redirect&bpo=14285]: 当使用"python -m package"选项执行包且包初始化失败时，现在会报告正确的回溯。"runpy"模块现在让包初始化的异常传递回调用者，而不是引发ImportError。

bpo-19771 [https://bugs.python.org/issue?@action=redirect&bpo=19771]: 同样在runpy和"-m"选项中，如果包甚至无法初始化（例如由于坏的 *.pyc 文件），则省略不相关的消息"...是一个包，不能直接执行"。

bpo-25177 [https://bugs.python.org/issue?@action=redirect&bpo=25177]: 修复了非常小和非常大的数字的平均值问题。作为副作用，statistics.mean和statistics.variance应该会显著更快。

bpo-25718 [https://bugs.python.org/issue?@action=redirect&bpo=25718]: 修复了复制状态为布尔值false的对象的问题。

bpo-10131 [https://bugs.python.org/issue?@action=redirect&bpo=10131]: 修复了minidom文档的深拷贝问题。基于Marian Ganisin的补丁。

bpo-7990 [https://bugs.python.org/issue?@action=redirect&bpo=7990]: ElementTree.Element上的dir()现在列出属性："tag", "text", "tail"和"attrib"。原始由Santoso Wijaya提供补丁。

bpo-25725 [https://bugs.python.org/issue?@action=redirect&bpo=25725]: 修复了在解包含元组指令的无效数据时pickle.loads()中的引用泄漏问题。

bpo-25663 [https://bugs.python.org/issue?@action=redirect&bpo=25663]: 在Readline completer中，避免列出重复的全局名称，并在搜索内置名称之前搜索全局命名空间。

bpo-25688 [https://bugs.python.org/issue?@action=redirect&bpo=25688]: 修复了ElementTree.iterparse()在引发错误时的文件泄露问题。

bpo-23914 [https://bugs.python.org/issue?@action=redirect&bpo=23914]: 修复了解pickle数据损坏时unpickler引发的SystemError。

bpo-25691 [https://bugs.python.org/issue?@action=redirect&bpo=25691]: 修复了删除ElementTree.Element属性时的崩溃问题。

bpo-25624 [https://bugs.python.org/issue?@action=redirect&bpo=25624]: ZipFile现在总是为目录条目写入ZIP_STORED头。由王定远提供补丁。

bpo-25626 [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参数。

bpo-25583 [https://bugs.python.org/issue?@action=redirect&bpo=25583]: 当操作系统优先考虑如EACCES这样的错误而不是EEXIST时，避免os.makedirs(exist_ok=True)引发错误。

bpo-25593 [https://bugs.python.org/issue?@action=redirect&bpo=25593]: 修改了asyncio中EventLoop.stop()的语义。

bpo-6973 [https://bugs.python.org/issue?@action=redirect&bpo=6973]: 当我们知道一个subprocess.Popen进程已经死亡时，不允许send_signal()、terminate()或kill()方法执行任何操作，因为它们可能会信号到不同的进程。

bpo-23883 [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提供补丁。

bpo-25590 [https://bugs.python.org/issue?@action=redirect&bpo=25590]: 在Readline completer中，每个属性只调用一次getattr()。同时完成如属性和槽这样的属性名称，这些属性由dir()列出但尚未在实例上创建。

bpo-25498 [https://bugs.python.org/issue?@action=redirect&bpo=25498]: 修复了在垃圾回收由包装memoryview创建的ctypes对象时的崩溃问题。这是3.5a1中的一个回归。基于Eryksun的补丁。

bpo-25584 [https://bugs.python.org/issue?@action=redirect&bpo=25584]: 将"escape"添加到glob模块的__all__列表中。

bpo-25584 [https://bugs.python.org/issue?@action=redirect&bpo=25584]: 修复了以 ** 开头的递归glob()模式。

bpo-25446 [https://bugs.python.org/issue?@action=redirect&bpo=25446]: 修复 smtplib 的 AUTH LOGIN 支持中的回归问题。

bpo-18010 [https://bugs.python.org/issue?@action=redirect&bpo=18010]: 修复 pydoc web 服务器的模块搜索功能，以处理导入包时的异常。

bpo-25554 [https://bugs.python.org/issue?@action=redirect&bpo=25554]: 消除了正则表达式解析中的循环引用。

bpo-18973 [https://bugs.python.org/issue?@action=redirect&bpo=18973]: 日历模块的命令行界面现在使用 argparse 而不是 optparse。

bpo-25510 [https://bugs.python.org/issue?@action=redirect&bpo=25510]: 如果 FileInput 以二进制模式打开，fileinput.FileInput.readline() 现在在末尾返回 b'' 而不是 ''。由 Ryosuke Ito 提供补丁。

bpo-25503 [https://bugs.python.org/issue?@action=redirect&bpo=25503]: 修复了 inspect.getdoc() 对于属性的继承文档字符串的处理。原始由 John Mark Vandenberg 提供补丁。

bpo-25515 [https://bugs.python.org/issue?@action=redirect&bpo=25515]: 在 uuid.uuid4 中始终使用 os.urandom 作为随机性来源。

bpo-21827 [https://bugs.python.org/issue?@action=redirect&bpo=21827]: 修复了 textwrap.dedent() 当最大公共空白是最小前导空白的子字符串时的情况。基于 Robert Li 的补丁。

bpo-25447 [https://bugs.python.org/issue?@action=redirect&bpo=25447]: lru_cache() 包装器对象现在可以被复制和 pickle（通过返回未更改的原始对象）。

bpo-25390 [https://bugs.python.org/issue?@action=redirect&bpo=25390]: typing: 不因 Union[str, Pattern] 而崩溃。

bpo-25441 [https://bugs.python.org/issue?@action=redirect&bpo=25441]: asyncio: 当套接字关闭时从 drain() 引发错误。

bpo-25410 [https://bugs.python.org/issue?@action=redirect&bpo=25410]: 清理并修复了 OrderedDict 的 C 实现中的小错误。

bpo-25411 [https://bugs.python.org/issue?@action=redirect&bpo=25411]: 通过更好地使用 email 包，改进了 SMTPHandler 中的 Unicode 支持。感谢用户 simon04 的补丁。

将 imp 模块从 PendingDeprecationWarning 移动到 DeprecationWarning。

bpo-25407 [https://bugs.python.org/issue?@action=redirect&bpo=25407]: 移除了关于 formatter 模块在 Python 3.6 中被移除的提及。

bpo-25406 [https://bugs.python.org/issue?@action=redirect&bpo=25406]: 修复了 OrderedDict.move_to_end() 的 C 实现中的一个错误，该错误导致在将几个项目移动到有序字典的开头后在迭代中出现分段错误或挂起。

bpo-25382 [https://bugs.python.org/issue?@action=redirect&bpo=25382]: pickletools.dis() 现在为 MEMOIZE 操作码输出隐式备忘录索引。

bpo-25357 [https://bugs.python.org/issue?@action=redirect&bpo=25357]: 向 binascii.b2a_base64() 添加了一个可选的新行参数。base64.b64encode() 使用它来避免内存拷贝。

bpo-24164 [https://bugs.python.org/issue?@action=redirect&bpo=24164]: 需要使用关键字参数调用 __new__ 的对象，现在可以使用低于协议版本4的pickle协议进行序列化。

bpo-25364 [https://bugs.python.org/issue?@action=redirect&bpo=25364]: zipfile 现在可以在禁用线程的构建中工作。

bpo-25328 [https://bugs.python.org/issue?@action=redirect&bpo=25328]: 如果 decode_data 和 enable_SMTPUTF8 都被设置为 true，smtpd 的 SMTPChannel 现在会正确地引发 ValueError。

bpo-16099 [https://bugs.python.org/issue?@action=redirect&bpo=16099]: RobotFileParser 现在支持 Crawl-delay 和 Request-rate 扩展。由 Nikolay Bogoychev 提供补丁。

bpo-25316 [https://bugs.python.org/issue?@action=redirect&bpo=25316]: 当未安装 MSVC 时，distutils 会引发 OSError 而不是 DistutilsPlatformError。

bpo-25380 [https://bugs.python.org/issue?@action=redirect&bpo=25380]: 修复了 pickletools.opcodes 中 STACK_GLOBAL 操作码的协议。

bpo-23972 [https://bugs.python.org/issue?@action=redirect&bpo=23972]: 更新了 asyncio 的数据报创建方法，允许在绑定套接字之前设置 reuseport 和 reuseaddr 套接字选项。与现有的 asyncio create_server 方法类似，如果操作系统是 'posix'（除非平台是 Cygwin），数据报套接字的 reuseaddr 选项默认为 True。由 Chris Laws 提供补丁。

bpo-25304 [https://bugs.python.org/issue?@action=redirect&bpo=25304]: 添加了 asyncio.run_coroutine_threadsafe()。这让你可以从另一个线程向循环提交一个协程，返回一个 concurrent.futures.Future。由 Vincent Michel 提供。

bpo-25232 [https://bugs.python.org/issue?@action=redirect&bpo=25232]: 修复 CGIRequestHandler，使其在第一个问号 (?) 处而不是最后一个问号处将查询与 URL 分开。补丁来自 Xiang Zhang。

bpo-24657 [https://bugs.python.org/issue?@action=redirect&bpo=24657]: 防止 CGIRequestHandler 像处理路径一样在 URL 的查询部分折叠斜杠。补丁来自 Xiang Zhang。

bpo-25287 [https://bugs.python.org/issue?@action=redirect&bpo=25287]: 如果不支持 crypt.METHOD_CRYPT，则不要将其添加到 crypt.methods 中。检查是否支持，例如在 OpenBSD 上可能不支持。

bpo-23600 [https://bugs.python.org/issue?@action=redirect&bpo=23600]: tzinfo.fromutc() 的默认实现在某些情况下返回了错误的结果。

bpo-25203 [https://bugs.python.org/issue?@action=redirect&bpo=25203]: 失败的 readline.set_completer_delims() 不再使模块处于不一致状态。

bpo-25011 [https://bugs.python.org/issue?@action=redirect&bpo=25011]: rlcompleter 现在会省略私有和特殊属性名称，除非前缀以下划线开头。

bpo-25209 [https://bugs.python.org/issue?@action=redirect&bpo=25209]: rlcompleter 现在可以在完成的关键字后添加空格或冒号。

bpo-22241 [https://bugs.python.org/issue?@action=redirect&bpo=22241]: timezone.utc 名称现在是简单的 'UTC'，而不是 'UTC-00:00'。

bpo-23517 [https://bugs.python.org/issue?@action=redirect&bpo=23517]: datetime.datetime 的 fromtimestamp() 和 utcfromtimestamp() 方法现在将微秒四舍五入到最近的偶数整数（ROUND_HALF_EVEN），如同 round(float)，而不是向负无穷方向舍入（ROUND_FLOOR）。

bpo-23552 [https://bugs.python.org/issue?@action=redirect&bpo=23552]: Timeit 现在在最佳和最差时间之间存在显著（4倍）差异时发出警告。补丁来自 Serhiy Storchaka。

bpo-24633 [https://bugs.python.org/issue?@action=redirect&bpo=24633]: site-packages/README -> README.txt。

bpo-24879 [https://bugs.python.org/issue?@action=redirect&bpo=24879]: help() 和 pydoc 现在可以按照命名元组字段定义的顺序而非字母顺序列出它们。排序由 _fields 属性（如果存在）决定。

bpo-24874 [https://bugs.python.org/issue?@action=redirect&bpo=24874]: 提高 itertools.cycle() 的速度并使其 pickle 更加紧凑。

修复了当第一个参数不是列表时 itertools.cycle.__setstate__() 的崩溃问题。

bpo-20059 [https://bugs.python.org/issue?@action=redirect&bpo=20059]: urllib.parse 在所有无效端口上引发 ValueError。补丁来自 Martin Panter。

bpo-24360 [https://bugs.python.org/issue?@action=redirect&bpo=24360]: 为无效标识符改进 argparse.Namespace() 的 __repr__。补丁来自 Matthias Bussonnier。

bpo-23426 [https://bugs.python.org/issue?@action=redirect&bpo=23426]: distutils 中的 run_setup 被破坏。补丁来自 Alexander Belopolsky。

bpo-13938 [https://bugs.python.org/issue?@action=redirect&bpo=13938]: 2to3 将 StringTypes 转换为元组。补丁来自 Mark Hammond。

bpo-2091 [https://bugs.python.org/issue?@action=redirect&bpo=2091]: open() 接受包含 '+' 的 'U' 模式字符串，但 'U' 只能与 'r' 一起使用。补丁来自 Jeff Balogh 和 John O'Connor。

bpo-8585 [https://bugs.python.org/issue?@action=redirect&bpo=8585]: 改进了 zipimporter2 的测试。补丁来自 Mark Lawrence。

bpo-18622 [https://bugs.python.org/issue?@action=redirect&bpo=18622]: unittest.mock.mock_open().reset_mock 会无限递归。补丁来自 Nicola Palumbo 和 Laurent De Buyst。

bpo-24426 [https://bugs.python.org/issue?@action=redirect&bpo=24426]: 正则表达式中的快速搜索优化现在适用于以捕获组开始的模式。快速搜索优化现在不能在编译时禁用。

bpo-23661 [https://bugs.python.org/issue?@action=redirect&bpo=23661]: unittest.mock 的 side_effects 现在可以再次是异常。这是对 Python 3.4 的一个回归。补丁来自 Ignacio Rossi

bpo-13248 [https://bugs.python.org/issue?@action=redirect&bpo=13248]: 移除已弃用的 inspect.getmoduleinfo 函数。

bpo-25578 [https://bugs.python.org/issue?@action=redirect&bpo=25578]: 修复 SSLSocket.getpeercer() 中的另一个内存泄漏问题。

bpo-25530 [https://bugs.python.org/issue?@action=redirect&bpo=25530]: 默认情况下，在创建 ssl.SSLContext 时禁用易受攻击的 SSLv3 协议。

bpo-25569 [https://bugs.python.org/issue?@action=redirect&bpo=25569]: 修复 SSLSocket.getpeercert() 中的内存泄漏问题。

bpo-25471 [https://bugs.python.org/issue?@action=redirect&bpo=25471]: 从 accept() 返回的套接字不应显示为非阻塞。

bpo-25319 [https://bugs.python.org/issue?@action=redirect&bpo=25319]: 当 threading.Event 被重新初始化时，底层条件应使用常规锁而不是递归锁。

如果主机已解析，则跳过 getaddrinfo。由 A. Jesse Jiryu Davis 提供补丁。

bpo-26050 [https://bugs.python.org/issue?@action=redirect&bpo=26050]: 添加 asyncio.StreamReader.readuntil() 方法。由 Марк Коренберг 提供补丁。

bpo-25924 [https://bugs.python.org/issue?@action=redirect&bpo=25924]: 在 OS X 10.5 或更高版本上避免不必要的 getaddrinfo(3) 调用序列化。原始补丁由 A. Jesse Jiryu Davis 提供。

bpo-26406 [https://bugs.python.org/issue?@action=redirect&bpo=26406]: 在当前版本的 OpenBSD 和 NetBSD 上避免不必要的 getaddrinfo(3) 调用序列化。由 A. Jesse Jiryu Davis 提供补丁。

bpo-26848 [https://bugs.python.org/issue?@action=redirect&bpo=26848]: 修复 asyncio/subprocess.communicate() 以处理空输入。由 Jack O'Connor 提供补丁。

bpo-27040 [https://bugs.python.org/issue?@action=redirect&bpo=27040]: 添加 loop.get_exception_handler 方法

bpo-27041 [https://bugs.python.org/issue?@action=redirect&bpo=27041]: asyncio: 添加 loop.create_future 方法

IDLE

bpo-20640 [https://bugs.python.org/issue?@action=redirect&bpo=20640]: 为 idlelib.configHelpSourceEdit 添加测试。由 Saimadhav Heblikar 提供补丁。

在 IDLE 文档的 'IDLE-控制台差异' 部分，澄清使用 IDLE 运行如何影响 sys.modules 和标准流。

bpo-25507 [https://bugs.python.org/issue?@action=redirect&bpo=25507]: 修复 IOBinding 中阻止打印的错误更改。增强 IOBinding htest 以包括所有主要 IOBinding 功能。

bpo-25905 [https://bugs.python.org/issue?@action=redirect&bpo=25905]: 恢复 README.txt 中 ' 到 ’ 右单引号的不必要转换，并用 'ascii' 打开此文件和 NEWS.txt。将 CREDITS.txt 重新编码为 utf-8 并用 'utf-8' 打开。

bpo-15348 [https://bugs.python.org/issue?@action=redirect&bpo=15348]: 在关闭调试器窗口（在 IDLE 进程中运行）之前停止调试器引擎（通常在用户进程中）。这防止了被捕获并忽略的 RuntimeErrors。

bpo-24455 [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中，允许任何现有的交互首先终止。

在IDLE的'终止程序？'消息中，将'程序'改为'您的程序'，以更清楚地表明所指的是当前运行的用户程序，而不是IDLE本身。

bpo-24750 [https://bugs.python.org/issue?@action=redirect&bpo=24750]: 改善IDLE编辑器窗口状态栏的外观。Patch by Mark Roseman。

bpo-25313 [https://bugs.python.org/issue?@action=redirect&bpo=25313]: 更改新内置文本颜色主题的处理，以更好地解决由IDLE Dark的添加引入的兼容性问题。在idlelib中一致地使用修订后的idleConf.CurrentTheme。

bpo-24782 [https://bugs.python.org/issue?@action=redirect&bpo=24782]: 扩展配置现在是IDLE首选项对话框中的一个标签，而不是一个单独的对话框。原来的标签现在是一个排序列表。Patch by Mark Roseman。

bpo-22726 [https://bugs.python.org/issue?@action=redirect&bpo=22726]: 重新激活配置对话框帮助按钮，包含一些关于其他按钮和新IDLE Dark主题的内容。

bpo-24820 [https://bugs.python.org/issue?@action=redirect&bpo=24820]: IDLE现在有一个'IDLE Dark'内置文本颜色主题。它或多或少是IDLE Classic的反转，背景为钴蓝色。字符串、注释、关键字等仍然是绿色、红色、橙色等。要在2015年11月之前发布的IDLEs中使用它，点击'保存为新的自定义主题'按钮并输入一个新名称，如'Custom Dark'。自定义主题适用于任何IDLE版本，并且可以修改。

bpo-25224 [https://bugs.python.org/issue?@action=redirect&bpo=25224]: README.txt现在是IDLE开发者和好奇用户的idlelib索引。以前的用户内容现在在IDLE文档章节中。'IDLE'现在意味着'集成开发和学习环境'。

bpo-24820 [https://bugs.python.org/issue?@action=redirect&bpo=24820]: 用户现在可以在设置->自定义高亮中设置断点颜色。原始由Mark Roseman提供补丁。

bpo-24972 [https://bugs.python.org/issue?@action=redirect&bpo=24972]: 非活动选择背景现在在所有系统上都与用户配置的活动选择背景相匹配。在Windows上，找到的项目现在总是高亮显示。初始由Mark Roseman提供补丁。

bpo-24570 [https://bugs.python.org/issue?@action=redirect&bpo=24570]: Idle：在受tk回归影响的Mac上显示调用提示和完成框。初始补丁由Mark Roseman提供。

bpo-24988 [https://bugs.python.org/issue?@action=redirect&bpo=24988]: Idle ScrolledList上下文菜单（在调试器中使用）现在在Mac Aqua上工作。由Mark Roseman提供补丁。

bpo-24801 [https://bugs.python.org/issue?@action=redirect&bpo=24801]: 使右键点击上下文菜单在Mac Aqua上工作。由Mark Roseman提供补丁。

bpo-25173 [https://bugs.python.org/issue?@action=redirect&bpo=25173]: 将tkinter消息框与特定小部件关联。对于Mac OSX，使它们成为'表单'。由Mark Roseman提供补丁。

bpo-25198 [https://bugs.python.org/issue?@action=redirect&bpo=25198]: 增强现在用于Idle Help的初始html查看器。正确缩进固定间距文本（由Mark Roseman提供补丁）。给代码片段一个非常类似Sphinx的浅蓝灰色背景。重用用户为shell和编辑器设置的初始宽度和高度。当使用目录（TOC）菜单时，将部分标题放在屏幕顶部。

bpo-25225 [https://bugs.python.org/issue?@action=redirect&bpo=25225]: 压缩并重写Idle文档中关于文本颜色的部分。

bpo-21995 [https://bugs.python.org/issue?@action=redirect&bpo=21995]: 解释IDLE和控制台Python之间的一些差异。

bpo-22820 [https://bugs.python.org/issue?@action=redirect&bpo=22820]: 解释在从Idle编辑器运行文件时需要 print 的原因。

bpo-25224 [https://bugs.python.org/issue?@action=redirect&bpo=25224]: 文档：增加Idle功能列表和无子进程部分。

bpo-25219 [https://bugs.python.org/issue?@action=redirect&bpo=25219]: 更新Idle命令行选项的文档。有些选项缺失，注释也不正确。

bpo-24861 [https://bugs.python.org/issue?@action=redirect&bpo=24861]: 大多数idlelib是私有的，可能会更改。使用idleib.idle.*来启动Idle。参见idlelib.__init__.__doc__。

bpo-25199 [https://bugs.python.org/issue?@action=redirect&bpo=25199]: Idle：为未来的维护者添加同步注释。

bpo-16893 [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 文件已被弃用。

bpo-24199 [https://bugs.python.org/issue?@action=redirect&bpo=24199]: 弃用未使用的 idlelib.idlever，可能在 3.6 中移除。

bpo-24790 [https://bugs.python.org/issue?@action=redirect&bpo=24790]: 移除多余的代码（这也造成了 2 和 3 的冲突）。

文档

bpo-26736 [https://bugs.python.org/issue?@action=redirect&bpo=26736]: 尽可能在文档中使用 HTTPS 作为外部链接。

bpo-6953 [https://bugs.python.org/issue?@action=redirect&bpo=6953]: 重新组织 Readline 模块文档，将相关函数分组，并添加更多细节，如访问哪些底层的 Readline 函数和变量。

bpo-23606 [https://bugs.python.org/issue?@action=redirect&bpo=23606]: 向 ctypes 文档添加关于 cdll.msvcrt 的注释。

bpo-24952 [https://bugs.python.org/issue?@action=redirect&bpo=24952]: 阐明 "threading" 和 "_thread" 模块中 stack_size() 的默认 size 参数。来自 Mattip 的补丁。

bpo-26014 [https://bugs.python.org/issue?@action=redirect&bpo=26014]: 更新 3.x 打包文档：* 现在在旧版页面中提供了指向新文档的 "参见" 链接 * 更新了指向 setuptools 文档的链接

测试

bpo-21916 [https://bugs.python.org/issue?@action=redirect&bpo=21916]: 为 turtle 模块添加了测试。由 ingrid、Gregory Loyse 和 Jelle Zijlstra 提供补丁。

bpo-26295 [https://bugs.python.org/issue?@action=redirect&bpo=26295]: 当使用 "python3 -m test --testdir=TESTDIR" 时，regrtest 不会给测试模块名添加 "test." 前缀。

bpo-26523 [https://bugs.python.org/issue?@action=redirect&bpo=26523]: 多进程线程池（multiprocessing.dummy.Pool）未经测试。

bpo-26015 [https://bugs.python.org/issue?@action=redirect&bpo=26015]: 为可变序列的迭代器的 pickle 操作添加了新测试。

bpo-26325 [https://bugs.python.org/issue?@action=redirect&bpo=26325]: 添加了 test.support.check_no_resource_warning() 来检查是否未发出 ResourceWarning。

bpo-25940 [https://bugs.python.org/issue?@action=redirect&bpo=25940]: 更改 test_ssl 以更多地使用其内部本地服务器。这避免依赖 svn.python.org，后者最近更改了根证书。

bpo-25616 [https://bugs.python.org/issue?@action=redirect&bpo=25616]: OrderedDict 的测试从 test_collections 中提取出来，放入单独的文件 test_ordered_dict 中。

bpo-25449 [https://bugs.python.org/issue?@action=redirect&bpo=25449]: 为 OrderedDict 的子类添加了测试。

bpo-25188 [https://bugs.python.org/issue?@action=redirect&bpo=25188]: 添加 -P/--pgo 到 test.regrtest，以在运行测试套件用于PGO构建时抑制错误输出。初始由Alecsandru Patrascu提供补丁。

bpo-22806 [https://bugs.python.org/issue?@action=redirect&bpo=22806]: 添加 python -m test --list-tests 命令以列出测试。

bpo-18174 [https://bugs.python.org/issue?@action=redirect&bpo=18174]: python -m test --huntrleaks ... 现在也会检查文件描述符的泄漏。补丁由Richard Oudkerk编写。

bpo-25260 [https://bugs.python.org/issue?@action=redirect&bpo=25260]: 修复 python -m test --coverage 在Windows上的问题。移除忽略目录的列表。

PCbuild\rt.bat 现在可以接受无限数量的参数传递给regrtest.py。之前有9个的限制。

bpo-26583 [https://bugs.python.org/issue?@action=redirect&bpo=26583]: 如果无法写入字节码文件，则在test_import中跳过test_timestamp_overflow测试。

构建

bpo-21277 [https://bugs.python.org/issue?@action=redirect&bpo=21277]: 不要试图将_ctypes与ffi_convenience库链接。

bpo-26884 [https://bugs.python.org/issue?@action=redirect&bpo=26884]: 修复交叉构建中扩展模块的链接问题。由Xavier de Gaye提供补丁。

bpo-26932 [https://bugs.python.org/issue?@action=redirect&bpo=26932]: 修复了对定义为枚举值而非宏的RTLD_*常量的支持（特别是在Android上）。由Chi Hsuan Yen提供补丁。

bpo-22359 [https://bugs.python.org/issue?@action=redirect&bpo=22359]: 在交叉编译时禁用运行_freeze_importlib和pgen的规则。这些程序的输出通常与源代码一起保存，并且在本地构建时仍会重新生成。由Xavier de Gaye提供补丁。

bpo-21668 [https://bugs.python.org/issue?@action=redirect&bpo=21668]: 将audioop、_datetime、_ctypes_test模块链接到libm，除了Mac OS X。补丁由Chi Hsuan Yen编写。

bpo-25702 [https://bugs.python.org/issue?@action=redirect&bpo=25702]: 添加了一个--with-lto配置选项，该选项将在make profile-opt期间启用构建时的链接时间优化。已知一些编译器和工具链在使用LTO时不会产生稳定的代码，因此在依赖它之前确保彻底测试。它可以比仅使用profile-opt提供几个%的速度提升。

bpo-26624 [https://bugs.python.org/issue?@action=redirect&bpo=26624]: 添加了对ucrtbase[d].dll版本的验证，并对旧版本发出警告。

bpo-17603 [https://bugs.python.org/issue?@action=redirect&bpo=17603]: 通过使用struct stat中st_blocks的低级检查，避免关于不存在的fileblocks.o文件的错误。

bpo-26079 [https://bugs.python.org/issue?@action=redirect&bpo=26079]: 修复 tix-8.4.3.6 的构建输出文件夹。由 Bjoern Thiel 提交补丁。

bpo-26465 [https://bugs.python.org/issue?@action=redirect&bpo=26465]: 更新 Windows 构建以使用 OpenSSL 1.0.2g。

bpo-25348 [https://bugs.python.org/issue?@action=redirect&bpo=25348]: 添加了 --pgo 和 --pgo-job 参数到 PCbuild\build.bat 以便使用 Profile-Guided Optimization 构建。旧的 PCbuild\build_pgo.bat 脚本已被移除。

bpo-25827 [https://bugs.python.org/issue?@action=redirect&bpo=25827]: 向 configure 添加了对使用 ICC 构建的支持，包括一个新的 --with-icc 标志。

bpo-25696 [https://bugs.python.org/issue?@action=redirect&bpo=25696]: 修复了在 UNIX 上使用 make -j9 安装 Python 的问题。

bpo-24986 [https://bugs.python.org/issue?@action=redirect&bpo=24986]: 现在可以在 Windows 上构建 Python 而不会在没有外部库的情况下出现错误。

bpo-24421 [https://bugs.python.org/issue?@action=redirect&bpo=24421]: 在构建扩展之前，先编译 Modules/_math.c 一次。之前如果数学和 cmath 构建同时进行，可能会导致编译失败。

bpo-26465 [https://bugs.python.org/issue?@action=redirect&bpo=26465]: 更新 OS X 10.5+ 仅 32 位安装程序，以构建和链接 OpenSSL 1.0.2g。

bpo-26268 [https://bugs.python.org/issue?@action=redirect&bpo=26268]: 更新 Windows 构建以使用 OpenSSL 1.0.2f。

bpo-25136 [https://bugs.python.org/issue?@action=redirect&bpo=25136]: 支持 Apple Xcode 7 的新文本 SDK stub 库。

bpo-24324 [https://bugs.python.org/issue?@action=redirect&bpo=24324]: 当使用 gcc 时不启用不可达代码警告，因为该选项在旧版本的 gcc 中不起作用，并且在 gcc-4.5 之后已被静默移除。

Windows

bpo-27053 [https://bugs.python.org/issue?@action=redirect&bpo=27053]: 更新 make_zip.py 以正确生成库 ZIP 文件。

bpo-26268 [https://bugs.python.org/issue?@action=redirect&bpo=26268]: 更新 prepare_ssl.py 脚本以处理不包含 include 目录内容的 OpenSSL 版本（即 1.0.2e 及更高版本）。

bpo-26071 [https://bugs.python.org/issue?@action=redirect&bpo=26071]: bdist_wininst 创建的二进制文件无法启动并找到 32 位 Python

bpo-26073 [https://bugs.python.org/issue?@action=redirect&bpo=26073]: 更新启动器中的魔法数字列表

bpo-26065 [https://bugs.python.org/issue?@action=redirect&bpo=26065]: 在生成可嵌入发行版时从库中排除 venv。

bpo-25022 [https://bugs.python.org/issue?@action=redirect&bpo=25022]: 删除了非常过时的 PC/example_nt/ 目录。

工具/示例

bpo-26799 [https://bugs.python.org/issue?@action=redirect&bpo=26799]: 修复 python-gdb.py：不要在 Python 代码加载时一次性获取 C 类型，而是按需获取 C 类型。如果在 Python 可执行文件之前加载 python-gdb.py，C 类型可以改变。补丁由 Thomas Ilsche 编写。

bpo-26271 [https://bugs.python.org/issue?@action=redirect&bpo=26271]: 修复Freeze工具以正确使用通过configure传递的标志。补丁由Daniel Shaulov提供。

bpo-26489 [https://bugs.python.org/issue?@action=redirect&bpo=26489]: 向Tools/parser/unparse.py添加字典解包支持。由Guo Ci Teo提供补丁。

bpo-26316 [https://bugs.python.org/issue?@action=redirect&bpo=26316]: 修复Argument Clinic中的变量名拼写错误。

bpo-25440 [https://bugs.python.org/issue?@action=redirect&bpo=25440]: 修复python-config --extension-suffix的输出。

bpo-25154 [https://bugs.python.org/issue?@action=redirect&bpo=25154]: The pyvenv script has been deprecated in favour of python3 -m venv.

C API

bpo-26312 [https://bugs.python.org/issue?@action=redirect&bpo=26312]: 现在在所有使用PyArg_ParseTupleAndKeywords()的编程错误中都会引发SystemError。之前在某些编程错误中会引发RuntimeError。

bpo-26198 [https://bugs.python.org/issue?@action=redirect&bpo=26198]: 现在在解析"es#"和"et#"格式单元时发生缓冲区溢出会引发ValueError而不是TypeError。在解析格式字符串时发生编程错误会引发SystemError而不是TypeError。

Python 3.5.5 正式版

发布日期e: 2018-02-04

在 3.5.5 版本中没有新的更改。

Python 3.5.5 rc1

发布日期: 2018-01-23

安全性

bpo-32551 [https://bugs.python.org/issue?@action=redirect&bpo=32551]: bpo-29139 [https://bugs.python.org/issue?@action=redirect&bpo=29139] 中对 sys.path[0] 初始化的更改导致了一个回归问题，揭示了在执行来自zipfile、目录或其他导入位置的 __main__ 时sys.path初始化的不一致性。这被认为是一个潜在的安全问题，因为在之前不会出现的情况下，可能导致特权进程从用户控制的目录意外加载代码。解释器现在一致地避免将导入位置的父目录添加到 sys.path 中，并确保在插入命令行指定的导入位置时不会无意中修改其他 sys.path 条目。（最初作为 bpo-29723 [https://bugs.python.org/issue?@action=redirect&bpo=29723] 针对Python 3.6rc1报告，但当时忽略了即将发布的Python 3.5.4也会受到影响）

bpo-30657 [https://bugs.python.org/issue?@action=redirect&bpo=30657]: Fixed possible integer overflow in PyBytes_DecodeEscape, CVE-2017-1000158. Original patch by Jay Bosamiya; rebased to Python 3 by Miro Hrončok.

bpo-30947 [https://bugs.python.org/issue?@action=redirect&bpo=30947]: 将内嵌的 libexpat 从版本 2.2.1 升级到 2.2.3 以获取安全修复。

核心与内置函数

bpo-31095 [https://bugs.python.org/issue?@action=redirect&bpo=31095]: 修复由未调用 PyObject_GC_UnTrack() 的 tp_dealloc 引起的GC期间潜在崩溃问题。

库

bpo-32072 [https://bugs.python.org/issue?@action=redirect&bpo=32072]: 修复了二进制 plists 的问题：修复了保存 bytearrays。相同的对象将只保存一次。相等的引用将作为相同的对象加载。添加了对保存和加载递归数据结构的支持。

bpo-31170 [https://bugs.python.org/issue?@action=redirect&bpo=31170]: expat: 将 libexpat 从 2.2.3 更新至 2.2.4。修复了 UTF-8 输入部分字符的复制问题（libexpat bug 115）：https://github.com/libexpat/libexpat/issues/115

Python 3.5.4 正式版

发布日期: 2017-08-07

库

bpo-30119 [https://bugs.python.org/issue?@action=redirect&bpo=30119]: ftplib.FTP.putline() now throws ValueError on commands that contains CR or LF. Patch by Dong-hee Na.

Python 3.5.4 rc1

发布日期: 2017-07-23

安全性

bpo-30730 [https://bugs.python.org/issue?@action=redirect&bpo=30730]: 在 Windows 上防止子进程中的环境变量注入。防止传递其他环境变量和命令参数。

bpo-30694 [https://bugs.python.org/issue?@action=redirect&bpo=30694]: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple security vulnerabilities including: CVE-2017-9233 (External entity infinite loop DoS), CVE-2016-9063 (Integer overflow, re-fix), CVE-2016-0718 (Fix regression bugs from 2.2.0's fix to CVE-2016-0718) and CVE-2012-0876 (Counter hash flooding with SipHash). Note: the CVE-2016-5300 (Use os-specific entropy sources like getrandom) doesn't impact Python, since Python already gets entropy from the OS to set the expat secret using XML_SetHashSalt().

bpo-30500 [https://bugs.python.org/issue?@action=redirect&bpo=30500]: 修复 urllib.parse.splithost() 正确解析片段。例如，splithost('//127.0.0.1#@evil.com/') 现在正确返回 127.0.0.1 主机，而不是将 @evil.com 视为认证中的主机（login@host）。

bpo-29591 [https://bugs.python.org/issue?@action=redirect&bpo=29591]: Update expat copy from 2.1.1 to 2.2.0 to get fixes of CVE-2016-0718 and CVE-2016-4472. See https://sourceforge.net/p/expat/bugs/537/ for more information.

核心与内置函数

bpo-30876 [https://bugs.python.org/issue?@action=redirect&bpo=30876]: 从未加载的包中进行相对导入现在会重新导入包，而不是因SystemError失败。从非包中进行相对导入现在会因ImportError而非SystemError失败。

bpo-30765 [https://bugs.python.org/issue?@action=redirect&bpo=30765]: 当PyThread_acquire_lock()被要求不阻塞时，避免在pthread_mutex_lock()中阻塞。

bpo-27945 [https://bugs.python.org/issue?@action=redirect&bpo=27945]: 修复了在搜索、插入或比较过程中输入集合被修改时，字典的各种段错误。基于 Duane Griffin 和 Tim Mitchell 的补丁。

bpo-25794 [https://bugs.python.org/issue?@action=redirect&bpo=25794]: 修复了 type.__setattr__() 和 type.__delattr__() 对于非 interned 属性名称的问题。基于 Eryk Sun 的补丁。

bpo-29935 [https://bugs.python.org/issue?@action=redirect&bpo=29935]: 修复了在传递错误类型的索引时，tuple、list 和 deque 的 index() 方法中的错误消息。

bpo-28876 [https://bugs.python.org/issue?@action=redirect&bpo=28876]: 即使 len(range) 引发 OverflowError，bool(range) 也能正常工作。

bpo-29600 [https://bugs.python.org/issue?@action=redirect&bpo=29600]: 修复在StopIteration中包装协程返回值的问题。

bpo-29537 [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 提供补丁。

bpo-28598 [https://bugs.python.org/issue?@action=redirect&bpo=28598]: 支持在调用 str.__mod__ 之前调用 str 子类的 __rmod__。由 Martijn Pieters 提供补丁。

bpo-29602 [https://bugs.python.org/issue?@action=redirect&bpo=29602]: 修复了在复杂子类的构造函数和具有 __complex__ 方法的输入中对有符号零的错误处理。由 Serhiy Storchaka 提供补丁。

bpo-29347 [https://bugs.python.org/issue?@action=redirect&bpo=29347]: 修复了在创建弱引用对象时可能解引用未定义指针的问题。

bpo-29438 [https://bugs.python.org/issue?@action=redirect&bpo=29438]: 修复了key sharing dict中的use-after-free问题。

bpo-29319 [https://bugs.python.org/issue?@action=redirect&bpo=29319]: 防止RunMainFromImporter覆盖sys.path[0]。

bpo-29337 [https://bugs.python.org/issue?@action=redirect&bpo=29337]: 修复了比较代码对象时可能出现的BytesWarning。警告可能在编译时发出。

bpo-29478 [https://bugs.python.org/issue?@action=redirect&bpo=29478]: 在使用Compat32策略时，如果指定了max_line_length=None，它将不再被忽略。补丁由Mircea Cosbuc提供。

库

bpo-29403 [https://bugs.python.org/issue?@action=redirect&bpo=29403]: 修复``unittest.mock``模块的autospec功能，使其不再对绑定到方法的内置函数报错。由Aaron Gallagher提供补丁。

bpo-30961 [https://bugs.python.org/issue?@action=redirect&bpo=30961]: 修复了tracemalloc中借用引用的递减问题。

bpo-30886 [https://bugs.python.org/issue?@action=redirect&bpo=30886]: 修复 multiprocessing.Queue.join_thread()：现在即使线程是由创建队列的同一进程启动的，它也会等待线程完成。

bpo-29854 [https://bugs.python.org/issue?@action=redirect&bpo=29854]: 修复使用 readline 的 history-size 选项时 readline 中的段错误。由 Nir Soffer 提供补丁。

bpo-30807 [https://bugs.python.org/issue?@action=redirect&bpo=30807]: 当传递一个极小的值时，signal.setitimer() 可能会禁用计时器。极小的值（如 1e-6）是 setitimer() 有效的非零值，它被指定为采取微秒级间隔。然而，在某些平台上，我们的转换例程可能将 1e-6 转换为零间隔，从而禁用计时器而不是（重新）调度它。

bpo-30441 [https://bugs.python.org/issue?@action=redirect&bpo=30441]: 修复在迭代 os.environ 时修改它导致的错误。

bpo-30532 [https://bugs.python.org/issue?@action=redirect&bpo=30532]: 修复电子邮件头值解析器在某些情况下丢弃折叠空白的问题。

bpo-29169 [https://bugs.python.org/issue?@action=redirect&bpo=29169]: 将 zlib 更新至 1.2.11。

bpo-30879 [https://bugs.python.org/issue?@action=redirect&bpo=30879]: os.listdir() 和 os.scandir() 现在在使用字节类参数调用时会发出字节名称。

bpo-30746 [https://bugs.python.org/issue?@action=redirect&bpo=30746]: 禁止在 os.putenv() 和 os.spawn*() 的环境变量名中使用 '=' 字符。

bpo-29755 [https://bugs.python.org/issue?@action=redirect&bpo=29755]: 修复了 gettext 模块中的 lgettext() 系列函数。它们现在总是返回字节。

bpo-30645 [https://bugs.python.org/issue?@action=redirect&bpo=30645]: 修复imp.load_package()中的路径计算，修复仅随字节码一起提供包的情况。由Alexandru Ardelean提供补丁。

bpo-23890 [https://bugs.python.org/issue?@action=redirect&bpo=23890]: unittest.TestCase.assertRaises() 现在手动打破引用循环，以避免对象存活时间超过预期。

bpo-30149 [https://bugs.python.org/issue?@action=redirect&bpo=30149]: inspect.signature() now supports callables with variable-argument parameters wrapped with partialmethod. Patch by Dong-hee Na.

bpo-29931 [https://bugs.python.org/issue?@action=redirect&bpo=29931]: 修复了 ipaddress.ip_interface 对象的比较检查。补丁由 Sanjay Sundaresan 提供。

bpo-24484 [https://bugs.python.org/issue?@action=redirect&bpo=24484]: 避免多进程清理中的竞争条件。

bpo-28994 [https://bugs.python.org/issue?@action=redirect&bpo=28994]: 对于由 atexit 注册的回调中引发的 SystemExit，不再显示回溯。

bpo-30508 [https://bugs.python.org/issue?@action=redirect&bpo=30508]: 如果调用了 Task/Future 的 "cancel()" 方法，则不记录异常。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: typing 模块的更新：添加通用的 AsyncContextManager，为所有版本添加对 ContextManager 的支持。原始 PR 由 Jelle Zijlstra 和 Ivan Levkivskyi 提供。

bpo-29870 [https://bugs.python.org/issue?@action=redirect&bpo=29870]: 修复 asyncio/ssl 实现中当连接被中止时 SSL 套接字的泄漏问题。由 Michaël Sghaïer 提供补丁。

bpo-29743 [https://bugs.python.org/issue?@action=redirect&bpo=29743]: 在握手过程中关闭传输会导致打开的套接字泄漏。由 Nikolay Kim 提供补丁。

bpo-27585 [https://bugs.python.org/issue?@action=redirect&bpo=27585]: 修复 asyncio.Lock 中的等待者取消问题。由 Mathieu Sornay 提供补丁。

bpo-30418 [https://bugs.python.org/issue?@action=redirect&bpo=30418]: 在 Windows 上，如果子进程仍在运行但关闭了管道，subprocess.Popen.communicate() 现在也会忽略 stdin.write() 上的 EINVAL。

bpo-30378 [https://bugs.python.org/issue?@action=redirect&bpo=30378]: 修复 logging.handlers.SysLogHandler 无法处理 IPv6 地址的问题。

bpo-29960 [https://bugs.python.org/issue?@action=redirect&bpo=29960]: 当_random.Random.setstate()引发异常时，保留生成器状态。补丁由Bryan Olson提供。

bpo-30414 [https://bugs.python.org/issue?@action=redirect&bpo=30414]: multiprocessing.Queue._feed 后台运行线程在异常时不从主循环中中断。

bpo-30003 [https://bugs.python.org/issue?@action=redirect&bpo=30003]: 修复HZ编解码器中转义字符的处理。基于Ma Lin的补丁。

bpo-30301 [https://bugs.python.org/issue?@action=redirect&bpo=30301]: 修复在 spawn 和 forkserver 启动方法下使用SimpleQueue.empty()时的AttributeError。

bpo-30329 [https://bugs.python.org/issue?@action=redirect&bpo=30329]: imaplib和poplib现在在shutdown(SHUT_RDWR)时捕获Windows socket WSAEINVAL错误（代码10022）：尝试了无效操作。此错误有时发生在SSL连接上。

bpo-30375 [https://bugs.python.org/issue?@action=redirect&bpo=30375]: 编译正则表达式时发出的警告现在总是指向用户代码中的行。之前如果从组或条件内部发出，它们可能指向re模块的内部。

bpo-30048 [https://bugs.python.org/issue?@action=redirect&bpo=30048]: 修复了当任务运行协程且协程返回而没有任何更多 await 时，``Task.cancel()``可能被忽略的问题。

bpo-29990 [https://bugs.python.org/issue?@action=redirect&bpo=29990]: 修复GB18030解码器中的范围检查。原由Ma Lin提供补丁。

bpo-26293 [https://bugs.python.org/issue?@action=redirect&bpo=26293]: 由于zipfile损坏导致的变更。（另见：bpo-29094 [https://bugs.python.org/issue?@action=redirect&bpo=29094]）

bpo-30243 [https://bugs.python.org/issue?@action=redirect&bpo=30243]: 移除了_json的扫描器和编码器的__init__方法。误用它们可能导致内存泄漏或崩溃。现在扫描器和编码器对象在__new__方法中完全初始化。

bpo-30185 [https://bugs.python.org/issue?@action=redirect&bpo=30185]: 在收到Ctrl-C时，避免forkserver辅助进程中的KeyboardInterrupt回溯。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对typing模块的各种更新：添加typing.NoReturn类型，使用WrapperDescriptorType，小错误修复。原PR由Jim Fasarakis-Hilliard和Ivan Levkivskyi提供。

bpo-30205 [https://bugs.python.org/issue?@action=redirect&bpo=30205]: 修复Linux上未绑定的AF_UNIX套接字的getsockname()。

bpo-30070 [https://bugs.python.org/issue?@action=redirect&bpo=30070]: 修复了解析模块中错误处理的内存泄漏和崩溃问题。

bpo-30061 [https://bugs.python.org/issue?@action=redirect&bpo=30061]: 修复了当readline()或__next__()分别返回不可大小化的对象时，IOBase方法__next__()和readlines()中的崩溃。修复了由不检查PyObject_Size()、PySequence_Size()或PyMapping_Size()的结果可能引起的其他错误。

bpo-30068 [https://bugs.python.org/issue?@action=redirect&bpo=30068]: 当存在hint时，_io._IOBase.readlines将首先检查是否关闭。

bpo-29694 [https://bugs.python.org/issue?@action=redirect&bpo=29694]: 修复了pathlib mkdir与flags parents=True时的竞争条件。补丁由Armin Rigo提供。

bpo-29692 [https://bugs.python.org/issue?@action=redirect&bpo=29692]: 修复了contextlib.contextmanager中RuntimeError异常的任意解链。由Siddharth Velankar提供补丁。

bpo-29998 [https://bugs.python.org/issue?@action=redirect&bpo=29998]: Pickling和复制ImportError现在保留name和path属性。

bpo-29942 [https://bugs.python.org/issue?@action=redirect&bpo=29942]: 修复了在遇到长串空可迭代对象时，itertools.chain.from_iterable 的崩溃问题。

bpo-27863 [https://bugs.python.org/issue?@action=redirect&bpo=27863]: 修复了由竞争条件和错误类型引起的 ElementTree 中的多个崩溃问题。

bpo-28699 [https://bugs.python.org/issue?@action=redirect&bpo=28699]: 修复了 multiprocessing.pool 中池的一个 bug，即在可迭代对象的最开始引发异常可能会吞掉异常或使程序挂起。由 Davin Potts 和 Xiang Zhang 提供补丁。

bpo-25803 [https://bugs.python.org/issue?@action=redirect&bpo=25803]: 当操作系统优先考虑如 EACCES 而不是 EEXIST 的错误时，避免 Path.mkdir(exist_ok=True) 引发不正确的错误。

bpo-29861 [https://bugs.python.org/issue?@action=redirect&bpo=29861]: 在 multiprocessing.Pool 中，任务、它们的参数和结果一旦完成就释放引用。

bpo-29884 [https://bugs.python.org/issue?@action=redirect&bpo=29884]: faulthandler: 在拆卸期间恢复旧的sigaltstack。由Christophe Zeitouny提供补丁。

bpo-25455 [https://bugs.python.org/issue?@action=redirect&bpo=25455]: 修复了递归缓冲文件类对象repr中的崩溃。

bpo-29800 [https://bugs.python.org/issue?@action=redirect&bpo=29800]: 修复了如果partial.keywords的键不是字符串时partial.__repr__的崩溃。由Michael Seifert提供补丁。

bpo-29742 [https://bugs.python.org/issue?@action=redirect&bpo=29742]: 如果 get_extra_info() 在关闭的 ssl 传输上调用，将引发异常。由 Nikolay Kim 提供补丁。

bpo-8256 [https://bugs.python.org/issue?@action=redirect&bpo=8256]: 修复了如果sys.stdin或sys.stdout的属性"encoding"或"errors"未设置或不是字符串时可能导致的input()失败或崩溃。

bpo-28298 [https://bugs.python.org/issue?@action=redirect&bpo=28298]: 修复了一个bug，该bug阻止了数组'Q'、'L'和'I'接受大整数（具有__int__方法的对象）作为元素。由Oren Milman提供补丁。

bpo-29615 [https://bugs.python.org/issue?@action=redirect&bpo=29615]: SimpleXMLRPCDispatcher 不再将 KeyError（或任何其他异常）链接到调度方法中引发的异常。由 Petr Motejlek 提供补丁。

bpo-29704 [https://bugs.python.org/issue?@action=redirect&bpo=29704]: asyncio.subprocess.SubprocessStreamProtocol 在所有管道关闭之前不再关闭。

bpo-29703 [https://bugs.python.org/issue?@action=redirect&bpo=29703]: 修复 asyncio，支持在子进程中实例化新的事件循环。

bpo-29376 [https://bugs.python.org/issue?@action=redirect&bpo=29376]: 修复 threading._DummyThread.is_alive() 中的断言错误。

bpo-29110 [https://bugs.python.org/issue?@action=redirect&bpo=29110]: 修复 aifc.open() 中当文件作为文件系统路径给出且不是有效的 AIFF 格式时的文件对象泄漏问题。由 Anthony Zhang 提供补丁。

bpo-28961 [https://bugs.python.org/issue?@action=redirect&bpo=28961]: 修复unittest.mock._Call辅助函数：不再忽略name参数。由Jiajun Huang提供补丁。

bpo-29532 [https://bugs.python.org/issue?@action=redirect&bpo=29532]: 修改传递给 functools.partial() 的 kwarg 字典不再影响创建后的 partial 对象。

bpo-28556 [https://bugs.python.org/issue?@action=redirect&bpo=28556]: 对 typing 模块进行了多项更新：typing.Counter、typing.ChainMap、改进的 ABC 缓存等。原始 PR 由 Jelle Zijlstra、Ivan Levkivskyi、Manuel Krebber 和 Łukasz Langa 提供。

bpo-29100 [https://bugs.python.org/issue?@action=redirect&bpo=29100]: 修复了 Python 3.6.0 中引入的 datetime.fromtimestamp() 的回归问题：检查最小和最大年份。

bpo-29519 [https://bugs.python.org/issue?@action=redirect&bpo=29519]: 修复了在与multiprocessing和自定义编解码器的罕见组合使用时，weakref在解释器关闭期间抛出异常的问题。

bpo-29416 [https://bugs.python.org/issue?@action=redirect&bpo=29416]: 防止 pathlib.Path.mkdir 中的无限循环。

bpo-29444 [https://bugs.python.org/issue?@action=redirect&bpo=29444]: 修复了 match 对象的 group() 方法中的越界缓冲区访问。基于 WGH 的补丁。

bpo-29335 [https://bugs.python.org/issue?@action=redirect&bpo=29335]: 修复了当子进程已退出到停止状态而不是终止状态（例如：在 ptrace 下）时的 subprocess.Popen.wait()。

bpo-29290 [https://bugs.python.org/issue?@action=redirect&bpo=29290]: 修复了 argparse 中帮助消息会在非断行空格处换行的回归问题。

bpo-28735 [https://bugs.python.org/issue?@action=redirect&bpo=28735]: 修复了 mock.MagickMock 与 mock.ANY 的比较。

bpo-29011 [https://bugs.python.org/issue?@action=redirect&bpo=29011]: 通过向typing模块添加Deque来修复一个重要的遗漏。

bpo-29219 [https://bugs.python.org/issue?@action=redirect&bpo=29219]: 修复了未初始化的 ctypes.CDLL 实例的 repr 中的无限递归。

bpo-28969 [https://bugs.python.org/issue?@action=redirect&bpo=28969]: 修复了functools.lru_cache的C实现中的竞态条件。当缓存函数满时，如果同时从不同线程以相同的未缓存参数调用，可能会引发KeyError。

bpo-29142 [https://bugs.python.org/issue?@action=redirect&bpo=29142]: 在urllib.request中，no_proxy环境变量中带有前导点的后缀可以再次匹配相关的主机名（例如.b.c匹配a.b.c）。由Milan Oberkirch提供补丁。

文档

bpo-30176 [https://bugs.python.org/issue?@action=redirect&bpo=30176]: 在curses文档中添加缺失的属性相关常量。

bpo-26985 [https://bugs.python.org/issue?@action=redirect&bpo=26985]: 在inspect文档中添加缺失的代码对象信息。

bpo-28929 [https://bugs.python.org/issue?@action=redirect&bpo=28929]: 将文档链接到其在GitHub上的源文件。

bpo-25008 [https://bugs.python.org/issue?@action=redirect&bpo=25008]: 将smtpd.py文档标记为实际上已弃用，并添加指向aiosmtpd的指针，这是一个基于asyncio的第三方替代品。

bpo-26355 [https://bugs.python.org/issue?@action=redirect&bpo=26355]: 在每个页面上添加指向相应主要版本文档的规范头部链接。由Matthias Bussonnier提供补丁。

bpo-29349 [https://bugs.python.org/issue?@action=redirect&bpo=29349]: 修复构建文档代码中的Python 2语法。

测试

bpo-30822 [https://bugs.python.org/issue?@action=redirect&bpo=30822]: 修复 regrtest 命令行解析器以允许传递 -u extralargefile 来运行 test_zipfile64。

bpo-30383 [https://bugs.python.org/issue?@action=redirect&bpo=30383]: regrtest: 增强 regrtest 并从主分支回传功能。添加选项：--coverage、--testdir、--list-tests（列出测试文件，不运行它们）、--list-cases（列出测试标识符，不运行它们，bpo-30523 [https://bugs.python.org/issue?@action=redirect&bpo=30523]）、--matchfile（从文本文件加载测试过滤器列表，bpo-30540 [https://bugs.python.org/issue?@action=redirect&bpo=30540]）、--slowest（--slow 的别名）。增强输出：添加时间戳、测试结果、当前运行的测试、“Tests result: xxx”总结与总持续时间等。修复 regrtest 中的引用泄漏狩猎，--huntrleaks：regrtest 现在预热缓存，显式创建所有按需创建的内部单例以防止在检查引用泄漏时出现假阳性。(bpo-30675 [https://bugs.python.org/issue?@action=redirect&bpo=30675])。

bpo-30357 [https://bugs.python.org/issue?@action=redirect&bpo=30357]: test_thread: setUp() 现在使用 support.threading_setup() 和 support.threading_cleanup() 来等待线程完成，以避免对后续测试产生随机副作用。初始补丁由 Grzegorz Grzywacz 编写。

bpo-28087 [https://bugs.python.org/issue?@action=redirect&bpo=28087]: 在 macOS 上跳过 test_asyncore 和 test_eintr 的 poll 失败。由于某些 macOS 版本上底层系统 poll 函数的未解决问题，在 macOS 上运行时跳过 select.poll 的一些测试。

bpo-30197 [https://bugs.python.org/issue?@action=redirect&bpo=30197]: 增强了 test.support 模块中的 swap_attr() 和 swap_item() 函数。它们现在可以在 with 语句内部删除替换的属性或项目时工作。属性或项目的旧值（如果不存在则为 None）现在将被赋值给 "as" 子句的目标，如果有的话。

bpo-29571 [https://bugs.python.org/issue?@action=redirect&bpo=29571]: 为了匹配 re.LOCALE 标志的行为，test_re.test_locale_flag 现在使用 locale.getpreferredencoding(False) 来确定测试正则表达式的候选编码（允许它在默认区域编码是多字节编码时正确跳过测试）

构建

bpo-29243 [https://bugs.python.org/issue?@action=redirect&bpo=29243]: 在配置为 --enable-optimizations 时，防止在 make test、``make install``和一些其他make目标期间不必要的Python重新构建。

bpo-23404 [https://bugs.python.org/issue?@action=redirect&bpo=23404]: 不再基于文件修改时间重新生成已生成的文件：该操作现在是显式的。用``make regen-all``替换 make touch。

bpo-29643 [https://bugs.python.org/issue?@action=redirect&bpo=29643]: 修复 --enable-optimization 不起作用的问题。

Windows

bpo-30687 [https://bugs.python.org/issue?@action=redirect&bpo=30687]: 在Windows上构建时定位msbuild.exe而不是vcvarsall.bat。

bpo-29392 [https://bugs.python.org/issue?@action=redirect&bpo=29392]: 防止将无效参数传递到 msvcrt 模块时崩溃。

C API

bpo-27867 [https://bugs.python.org/issue?@action=redirect&bpo=27867]: 如果 Py_LIMITED_API 设置为介于 0x03050400 和 0x03060000（不包括）或 0x03060100 或更高之间的值，则函数 PySlice_GetIndicesEx() 被替换为宏。

bpo-29083 [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中不可用。

Python 3.5.3 正式版

发布日期: 2017-01-17

在 3.5.3rc1 和 3.5.3 最终版之间没有代码更改。

Python 3.5.3 rc1

发布日期: 2017-01-02

安全性

bpo-27278 [https://bugs.python.org/issue?@action=redirect&bpo=27278]: 修复在Linux上使用getrandom()实现的os.urandom()。将大小截断为INT_MAX，并循环直到收集足够的随机字节，而不是直接将Py_ssize_t转换为int。

bpo-22636 [https://bugs.python.org/issue?@action=redirect&bpo=22636]: 避免 ctypes.util.find_library() 的 shell 注入问题。

核心与内置函数

bpo-29073 [https://bugs.python.org/issue?@action=redirect&bpo=29073]: bytearray 格式化不再在第一个空字节处截断。

bpo-28932 [https://bugs.python.org/issue?@action=redirect&bpo=28932]: 如果不存在<sys/random.h>，则不包含它。

bpo-28147 [https://bugs.python.org/issue?@action=redirect&bpo=28147]: 修复 split-table 字典中的内存泄漏：setattr() 不得将组合表转换为分裂表。

bpo-25677 [https://bugs.python.org/issue?@action=redirect&bpo=25677]: 修正了缩进块语法错误提示符的位置。基于Michael Layzell的补丁。

bpo-29000 [https://bugs.python.org/issue?@action=redirect&bpo=29000]: 修复了八进制数在交替形式下零填充的bytes格式化。

bpo-28512 [https://bugs.python.org/issue?@action=redirect&bpo=28512]: 修复了通过PyErr_SyntaxLocationEx()和PyErr_SyntaxLocationObject()设置SyntaxError的offset属性。

bpo-28991 [https://bugs.python.org/issue?@action=redirect&bpo=28991]: functools.lru_cache() 容易受到由猴子补丁 len() 函数引起的隐蔽重入错误的影响。

bpo-28648 [https://bugs.python.org/issue?@action=redirect&bpo=28648]: 修复了在Mac OS X上调试版本中解码星体字符时Py_DecodeLocale()崩溃的问题。补丁由Xiang Zhang提供。

bpo-19398 [https://bugs.python.org/issue?@action=redirect&bpo=19398]: 在编译时PYTHONPATH组件为空的情况下，不再向sys.path组件添加额外的斜杠。

bpo-28426 [https://bugs.python.org/issue?@action=redirect&bpo=28426]: 修复了调试版本中PyUnicode_AsDecodedObject()潜在的崩溃问题。

bpo-23782 [https://bugs.python.org/issue?@action=redirect&bpo=23782]: 修复了 _PyTraceback_Add() 中可能的内存泄漏和 PyTraceBack_Here() 中的异常丢失问题。

bpo-28379 [https://bugs.python.org/issue?@action=redirect&bpo=28379]: 为 PyUnicode_CopyCharacters() 添加了健全性检查和测试。由 Xiang Zhang 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: 长范围迭代器的类型现在注册为 Iterator。由 Oren Milman 提供补丁。

bpo-28376 [https://bugs.python.org/issue?@action=redirect&bpo=28376]: range_iterator 的构造函数现在检查步长不为 0。由 Oren Milman 提供补丁。

bpo-26906 [https://bugs.python.org/issue?@action=redirect&bpo=26906]: 现在解析未初始化类型的特殊方法会导致类型的隐式初始化而不是失败。

bpo-18287 [https://bugs.python.org/issue?@action=redirect&bpo=18287]: PyType_Ready() 现在检查 tp_name 是否为 NULL。原始由 Niklas Koep 提供补丁。

bpo-24098 [https://bugs.python.org/issue?@action=redirect&bpo=24098]: 修复了在编译过程中 AST 被更改时可能发生的崩溃。

bpo-28350 [https://bugs.python.org/issue?@action=redirect&bpo=28350]: 不再对含有空字符的字符串常量进行内部化。

bpo-26617 [https://bugs.python.org/issue?@action=redirect&bpo=26617]: 修复了在弱引用回调过程中运行垃圾收集时发生的崩溃。

bpo-27942 [https://bugs.python.org/issue?@action=redirect&bpo=27942]: 现在在元组和冻结集合中递归内部化字符串常量。

bpo-21578 [https://bugs.python.org/issue?@action=redirect&bpo=21578]: 修复了当 ImportError 使用无效关键字参数调用时误导性的错误消息。

bpo-28203 [https://bugs.python.org/issue?@action=redirect&bpo=28203]: 修复来自 complex(1.0, {2:3}) 的错误消息中的错误类型。由 Soumya Sharma 提供补丁。

bpo-27955 [https://bugs.python.org/issue?@action=redirect&bpo=27955]: 当 getrandom() 系统调用因 EPERM 失败时（例如被 SECCOMP 阻止时），回退读取 /dev/urandom 设备。

bpo-28131 [https://bugs.python.org/issue?@action=redirect&bpo=28131]: 修复zipimport的compile_source()中的回归问题。zipimport应使用与解释器相同的优化级别。

bpo-25221 [https://bugs.python.org/issue?@action=redirect&bpo=25221]: 当 Python 编译时设置 NSMALLPOSINTS = 0 时，修复 PyLong_FromLong(0) 的损坏结果。

bpo-25758 [https://bugs.python.org/issue?@action=redirect&bpo=25758]: 防止 zipimport 不必要地编码文件名（由 Eryk Sun 提供补丁）

bpo-28189 [https://bugs.python.org/issue?@action=redirect&bpo=28189]: dictitems_contains 不再吞下比较错误。（由 Xiang Zhang 提供补丁）

bpo-27812 [https://bugs.python.org/issue?@action=redirect&bpo=27812]: 正确清除生成器帧对生成器的反向引用，以防止frame.clear()中的崩溃。

bpo-27811 [https://bugs.python.org/issue?@action=redirect&bpo=27811]: 修复了一个在启用警告即错误时，未等待的协程被最终化时崩溃的问题。

bpo-27587 [https://bugs.python.org/issue?@action=redirect&bpo=27587]: 修复了PVS-Studio发现的另一个问题：在_PyState_AddModule()中使用'def'后的空指针检查。初始由Christian Heimes提供补丁。

bpo-26020 [https://bugs.python.org/issue?@action=redirect&bpo=26020]: 集合字面量评估顺序与文档行为不匹配。

bpo-27782 [https://bugs.python.org/issue?@action=redirect&bpo=27782]: 多阶段扩展模块导入现在正确地允许使用 m_methods 字段来向 Py_create_mod 返回的非模块类型实例添加模块级函数。由 Xiang Zhang 提供补丁。

bpo-27936 [https://bugs.python.org/issue?@action=redirect&bpo=27936]: round() 函数对某些类型接受第二个 None 参数，但对其他类型不接受。通过接受所有数值类型的 None 来修复这种不一致性。

bpo-27487 [https://bugs.python.org/issue?@action=redirect&bpo=27487]: 如果在导入父包之后但在执行子模块之前，在 sys.modules 中找到了 "python -m" 或 runpy.run_module() 的子模块参数，则发出警告。

bpo-27558 [https://bugs.python.org/issue?@action=redirect&bpo=27558]: 修复 "raise" 语句实现中的一个 SystemError。在一个全新的线程中，引发一个 RuntimeError，因为没有活动的异常可以重新引发。补丁由 Xiang Zhang 编写。

bpo-27419 [https://bugs.python.org/issue?@action=redirect&bpo=27419]: 标准 __import__() 不再在全局或内置中查找 "__import__" 以导入子模块或 "from import"。修复了非字符串包名错误的处理。

bpo-27083 [https://bugs.python.org/issue?@action=redirect&bpo=27083]: 在Windows下尊重PYTHONCASEOK环境变量。

bpo-27514 [https://bugs.python.org/issue?@action=redirect&bpo=27514]: 将静态嵌套块过多的情况改为SyntaxError而非SystemError。

bpo-27473 [https://bugs.python.org/issue?@action=redirect&bpo=27473]: 修复了 bytes 和 bytearray 连接中可能的整数溢出问题。补丁由 Xiang Zhang 提供。

bpo-27507 [https://bugs.python.org/issue?@action=redirect&bpo=27507]: 在bytearray.extend()中添加整数溢出检查。由张翔提供补丁。

bpo-27581 [https://bugs.python.org/issue?@action=redirect&bpo=27581]: 在PySequence_Tuple()中不依赖包装进行溢出检查。由张翔提供补丁。

bpo-27443 [https://bugs.python.org/issue?@action=redirect&bpo=27443]: bytearray 迭代器的 __length_hint__() 不再为调整大小的 bytearray 返回负整数。

bpo-27942 [https://bugs.python.org/issue?@action=redirect&bpo=27942]: 修复 codeobject.c 中的内存泄漏

库

bpo-15812 [https://bugs.python.org/issue?@action=redirect&bpo=15812]: inspect.getframeinfo()现在正确显示上下文的第行。由Sam Breese提供补丁。

bpo-29094 [https://bugs.python.org/issue?@action=redirect&bpo=29094]: 使用外部文件对象和模式"w"和"x"创建的ZIP文件中的偏移量现在相对于文件的开始位置。

bpo-13051 [https://bugs.python.org/issue?@action=redirect&bpo=13051]: 修复了大型或调整大小的curses.textpad.Textbox中的递归错误。基于Tycho Andersen的补丁。

bpo-29119 [https://bugs.python.org/issue?@action=redirect&bpo=29119]: 修复collections.OrderedDict move_to_end()方法的纯Python版本中的weakrefs。由Andra Bogildea贡献。

bpo-9770 [https://bugs.python.org/issue?@action=redirect&bpo=9770]: curses.ascii谓词现在正确处理负整数。

bpo-28427 [https://bugs.python.org/issue?@action=redirect&bpo=28427]: 当从另一个线程收集时，旧键不应从WeakValueDictionary中移除新值。

bpo-28923 [https://bugs.python.org/issue?@action=redirect&bpo=28923]: 从Tix.py中移除编辑器工件。

bpo-28871 [https://bugs.python.org/issue?@action=redirect&bpo=28871]: 修复了在深度ElementTree释放时的崩溃。

bpo-19542 [https://bugs.python.org/issue?@action=redirect&bpo=19542]: 修复WeakValueDictionary.setdefault()和WeakValueDictionary.pop()中的bug，这些bug在另一个线程发生GC收集时出现。

bpo-20191 [https://bugs.python.org/issue?@action=redirect&bpo=20191]: 修复了当传递一个不拥有其元素的序列作为限制时，resource.prlimit() 崩溃的问题。

bpo-28779 [https://bugs.python.org/issue?@action=redirect&bpo=28779]: 如果预加载的模块实例化了某些多处理对象（如锁），multiprocessing.set_forkserver_preload()会使forkserver进程崩溃。

bpo-28847 [https://bugs.python.org/issue?@action=redirect&bpo=28847]: dbm.dumb现在支持读取只读文件，并且在索引文件未更改时不再写入索引文件。

bpo-25659 [https://bugs.python.org/issue?@action=redirect&bpo=25659]: 在 ctypes 中，防止在抽象类（如 Array）上调用 from_buffer() 和 from_buffer_copy() 方法时崩溃。

bpo-28732 [https://bugs.python.org/issue?@action=redirect&bpo=28732]: 修复 os.spawnv() 在 args 中没有元素时的崩溃

bpo-28485 [https://bugs.python.org/issue?@action=redirect&bpo=28485]: 对于 compileall.compile_dir(workers=...) 参数的负值，即使多线程不可用，也总是引发 ValueError。

bpo-28387 [https://bugs.python.org/issue?@action=redirect&bpo=28387]: 修复了当垃圾收集器在其他线程中调用时，_io.TextIOWrapper解构器可能崩溃的问题。基于Sebastian Cufre的补丁。

bpo-27517 [https://bugs.python.org/issue?@action=redirect&bpo=27517]: LZMA压缩器和解压器在两次接收到空数据时不再抛出异常。补丁由Benjamin Fogle提供。

bpo-28549 [https://bugs.python.org/issue?@action=redirect&bpo=28549]: 修复了curses的addch()在使用ncurses6时的段错误。

bpo-28449 [https://bugs.python.org/issue?@action=redirect&bpo=28449]: tarfile.open()以模式"r"或"r:"现在会先尝试以压缩方式打开tar文件，再尝试无压缩方式打开。否则在使用ignore_zeros=True时有50%的几率失败。

bpo-23262 [https://bugs.python.org/issue?@action=redirect&bpo=23262]: webbrowser模块现在支持Firefox 36+及衍生浏览器。基于Oleg Broytman的补丁。

bpo-27939 [https://bugs.python.org/issue?@action=redirect&bpo=27939]: 修复了tkinter.ttk.LabeledScale和tkinter.Scale中由于在Tk内部将比例表示为浮点值而导致的错误。如果底层Tk变量设置为浮点值，tkinter.IntVar现在可以正常工作。

bpo-28255 [https://bugs.python.org/issue?@action=redirect&bpo=28255]: calendar.TextCalendar().prmonth() 在打印月历后不再在新行的开头打印空格。由 Xiang Zhang 提供补丁。

bpo-20491 [https://bugs.python.org/issue?@action=redirect&bpo=20491]: textwrap.TextWrapper 类现在支持不换行空格。基于 Kaarle Ritvanen 的补丁。

bpo-28353 [https://bugs.python.org/issue?@action=redirect&bpo=28353]: os.fwalk() 不再因损坏的链接而失败。

bpo-25464 [https://bugs.python.org/issue?@action=redirect&bpo=25464]: 通过为 Tix 库的 bug 添加变通方法，修复了 tkinter.tix 模块中的 HList.header_exists()。

bpo-28488 [https://bugs.python.org/issue?@action=redirect&bpo=28488]: shutil.make_archive() 不再向 ZIP 存档添加条目 "./"。

bpo-24452 [https://bugs.python.org/issue?@action=redirect&bpo=24452]: 使 webbrowser 支持 Mac OS X 上的 Chrome。

bpo-20766 [https://bugs.python.org/issue?@action=redirect&bpo=20766]: 修复了 pdb 在处理 SIGINT 处理器时的引用泄漏问题。

bpo-26293 [https://bugs.python.org/issue?@action=redirect&bpo=26293]: 修复了不从文件开头开始写入 ZIP 文件的问题。ZIP 文件中的偏移量现在相对于存档的开始，以符合规范。

bpo-28321 [https://bugs.python.org/issue?@action=redirect&bpo=28321]: 修复了在 plistlib 中使用二进制格式写入非 BMP 字符的问题。

bpo-28322 [https://bugs.python.org/issue?@action=redirect&bpo=28322]: 修复了当从错误的 pickle 数据反序列化 itertools 对象时可能发生的崩溃。基于 John Leitch 的补丁。

修复了 mmap 模块中在异常使用模式下可能出现的整数溢出和崩溃问题。

bpo-1703178 [https://bugs.python.org/issue?@action=redirect&bpo=1703178]: 修复了向distutils的build_ext命令传递--link-objects选项的功能。

bpo-28253 [https://bugs.python.org/issue?@action=redirect&bpo=28253]: 修复了极端月份（0001-01和9999-12）的日历功能。重新实现了itermonthdays()和itermonthdays2()方法，使其不再调用可能导致datetime.date下溢/溢出的itermonthdates()。

bpo-28275 [https://bugs.python.org/issue?@action=redirect&bpo=28275]: 修复了LZMADecompressor和BZ2Decompressor类中decompress()方法可能存在的释放后使用问题。原始由John Leitch提供补丁。

bpo-27897 [https://bugs.python.org/issue?@action=redirect&bpo=27897]: 修复了如果传递无效的字符串类似对象作为名称时，sqlite3.Connection.create_collation()可能崩溃的问题。由Xiang Zhang提供补丁。

bpo-18893 [https://bugs.python.org/issue?@action=redirect&bpo=18893]: 修复了Lib/ctypes/macholib/dyld.py中无效的异常处理。由Madison May提供补丁。

bpo-27611 [https://bugs.python.org/issue?@action=redirect&bpo=27611]: 修复了 tkinter.tix 模块中默认根窗口的支持。

bpo-27348 [https://bugs.python.org/issue?@action=redirect&bpo=27348]: 在traceback模块中，恢复了类似于"Exception: None"的异常消息的格式化。这修复了3.5a2中引入的回归问题。

bpo-25651 [https://bugs.python.org/issue?@action=redirect&bpo=25651]: Allow falsy values to be used for msg parameter of subTest().

bpo-27932 [https://bugs.python.org/issue?@action=redirect&bpo=27932]: 防止win32_ver()中的内存泄漏。

修复socket._sendfile_use_sendfile中的UnboundLocalError。

bpo-28075 [https://bugs.python.org/issue?@action=redirect&bpo=28075]: 在Windows的os.stat()实现中检查ERROR_ACCESS_DENIED。由Eryk Sun提供补丁。

bpo-25270 [https://bugs.python.org/issue?@action=redirect&bpo=25270]: 防止在传递空字节串时codecs.escape_encode()引发SystemError。

bpo-28181 [https://bugs.python.org/issue?@action=redirect&bpo=28181]: 通过HTTPS获取antigravity。由Kaartic Sivaraam提供补丁。

bpo-25895 [https://bugs.python.org/issue?@action=redirect&bpo=25895]: 在urllib.parse.urljoin中启用WebSocket URL方案。由Gergely Imreh和Markus Holtermann提供补丁。

bpo-27599 [https://bugs.python.org/issue?@action=redirect&bpo=27599]: 修复binascii.b2a_qp()和binascii.a2b_qp()中的缓冲区溢出问题。

bpo-19003 [https://bugs.python.org/issue?@action=redirect&bpo=19003]: email.generator 现在按照 RFC，仅替换 \r 和/或 \n 行结束符，而不是所有的 Unicode 行结束符。

bpo-28019 [https://bugs.python.org/issue?@action=redirect&bpo=28019]: itertools.count()不再将1.0到2.0之间的非整数步长四舍五入为1。

bpo-25969 [https://bugs.python.org/issue?@action=redirect&bpo=25969]: 更新lib2to3语法以处理3.5中添加的解包泛化。

bpo-14977 [https://bugs.python.org/issue?@action=redirect&bpo=14977]: mailcap现在遵循mailcap文件中的行顺序（“首次匹配”），符合RFC 1542的要求。由Michael Lazar提供的补丁。

bpo-24594 [https://bugs.python.org/issue?@action=redirect&bpo=24594]: 在打开MSI数据库时验证persist参数。

bpo-17582 [https://bugs.python.org/issue?@action=redirect&bpo=17582]: xml.etree.ElementTree现在保留属性中的空白（由Duane Griffin提供补丁。由Stefan Behnel审查和批准。）。

bpo-28047 [https://bugs.python.org/issue?@action=redirect&bpo=28047]: 修复了用于新电子邮件策略中base64 CTE的行长度计算。

bpo-27445 [https://bugs.python.org/issue?@action=redirect&bpo=27445]: 不将str(_charset)传递给MIMEText.set_payload()。由Claude Paroz提供的补丁。

bpo-22450 [https://bugs.python.org/issue?@action=redirect&bpo=22450]: urllib现在在默认头中包括一个 Accept: */* 头。这使得REST API请求的结果更加一致和可预测，尤其是在涉及代理服务器时。

lib2to3.pgen3.driver.load_grammar() 现在在相同的Grammar.txt输入下，无论哈希随机化设置如何，都会创建一个稳定的缓存文件。

bpo-27570 [https://bugs.python.org/issue?@action=redirect&bpo=27570]: 在“ctypes”和“array”模块中避免使用空源指针进行零长度memcpy()等调用。

bpo-22233 [https://bugs.python.org/issue?@action=redirect&bpo=22233]: 仅在RFC指定的CR和LF字符上断开电子邮件标题行，而不是在任意Unicode换行符上。这也修复了HTTP标题解析中的一个错误。

bpo-27988 [https://bugs.python.org/issue?@action=redirect&bpo=27988]: 修复email iter_attachments对payload列表的错误修改。

bpo-27691 [https://bugs.python.org/issue?@action=redirect&bpo=27691]: 修复ssl模块对X.509证书中GEN_RID主题替代名字段的解析。

bpo-27850 [https://bugs.python.org/issue?@action=redirect&bpo=27850]: Remove 3DES from ssl module's default cipher list to counter measure sweet32 attack (CVE-2016-2183).

bpo-27766 [https://bugs.python.org/issue?@action=redirect&bpo=27766]: 向ssl模块的默认加密列表中添加ChaCha20 Poly1305。（需要OpenSSL 1.1.0或LibreSSL）。

bpo-26470 [https://bugs.python.org/issue?@action=redirect&bpo=26470]: 将ssl和hashlib模块移植到OpenSSL 1.1.0。

移除对传递文件描述符给os.access的支持。它从未工作过，但以前不会引发错误。

bpo-12885 [https://bugs.python.org/issue?@action=redirect&bpo=12885]: 修复distutils遇到符号链接时的错误。

bpo-27881 [https://bugs.python.org/issue?@action=redirect&bpo=27881]: 修复了设置sqlite3.Connection.isolation_level时可能的错误。基于Xiang Zhang的补丁。

bpo-27861 [https://bugs.python.org/issue?@action=redirect&bpo=27861]: 修复了当工厂创建的不是游标时sqlite3.Connection.cursor()中的崩溃。由Xiang Zhang提供补丁。

bpo-19884 [https://bugs.python.org/issue?@action=redirect&bpo=19884]: 避免在OS X上使用Gnu Readline时产生虚假输出。

bpo-27706 [https://bugs.python.org/issue?@action=redirect&bpo=27706]: 恢复random.Random().seed()对于使用种子版本1的字符串种子的确定性行为。允许random()的调用序列与Python 2中完全匹配。由Nofar Schnider提供补丁。

bpo-10513 [https://bugs.python.org/issue?@action=redirect&bpo=10513]: 修复Connection.commit()中的回归问题。提交后不应重置语句。

来自 https://github.com/python/typing 的 typing.py 新版本：Collection（仅适用于 3.6）(bpo-27598 [https://bugs.python.org/issue?@action=redirect&bpo=27598])。将 FrozenSet 添加到 __all__（上游 #261）。修复 _get_type_vars() 中的崩溃（上游 #259）。移除 ForwardRef._eval_type 中的字典约束（上游 #252）。

bpo-27539 [https://bugs.python.org/issue?@action=redirect&bpo=27539]: 修复了在负指数和负基数情况下未归一化的 Fraction.__pow__ 结果。

bpo-21718 [https://bugs.python.org/issue?@action=redirect&bpo=21718]: 现在，使用CTEs的查询可以使用cursor.description了。

bpo-2466 [https://bugs.python.org/issue?@action=redirect&bpo=2466]: posixpath.ismount现在能正确识别用户没有权限访问的挂载点。

bpo-27773 [https://bugs.python.org/issue?@action=redirect&bpo=27773]: 更正 _ssl.wrap_socket() 中 server_hostname 的一些内存管理错误。

bpo-26750 [https://bugs.python.org/issue?@action=redirect&bpo=26750]: unittest.mock.create_autospec() 现在能正确处理 property() 及其他数据描述符的子类。

在 curses 模块中，如果向 window.getstr() 或 window.instr() 传递负值，则引发错误。

bpo-27783 [https://bugs.python.org/issue?@action=redirect&bpo=27783]: 修复 operator.methodcaller 中可能使用未初始化内存的问题。

bpo-27774 [https://bugs.python.org/issue?@action=redirect&bpo=27774]: 修复 _sre 中可能对未拥有对象进行 Py_DECREF 的问题。

bpo-27760 [https://bugs.python.org/issue?@action=redirect&bpo=27760]: 修复 binascii.b2a_qp 中可能的整数溢出。

bpo-27758 [https://bugs.python.org/issue?@action=redirect&bpo=27758]: 修复 _csv 模块中对于大记录长度可能的整数溢出。

bpo-27568 [https://bugs.python.org/issue?@action=redirect&bpo=27568]: Prevent HTTPoxy attack (CVE-2016-1000110). Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which indicates that the script is in CGI mode.

bpo-27656 [https://bugs.python.org/issue?@action=redirect&bpo=27656]: 不再假设sched.h定义了任何SCHED_*常量。

bpo-27130 [https://bugs.python.org/issue?@action=redirect&bpo=27130]: 在“zlib”模块中，修复了压缩和解压缩大缓冲区（通常为4 GiB）时的处理问题。之前，输入被限制在4 GiB，压缩和解压缩操作未能正确处理4 GiB的结果。

bpo-27533 [https://bugs.python.org/issue?@action=redirect&bpo=27533]: 在nt._isdir中释放GIL。

bpo-17711 [https://bugs.python.org/issue?@action=redirect&bpo=17711]: 修复了使用协议0的持久ID进行反序列化的问题。原始补丁由Alexandre Vassalotti提交。

bpo-27522 [https://bugs.python.org/issue?@action=redirect&bpo=27522]: 避免在email.feedparser中无意中创建的引用循环。

bpo-26844 [https://bugs.python.org/issue?@action=redirect&bpo=26844]: 修复 imp.find_module() 的错误消息，使其引用 'path' 而不是 'name'。由 Lev Maximov 提供补丁。

bpo-23804 [https://bugs.python.org/issue?@action=redirect&bpo=23804]: 修复 SSL 零长度 recv() 调用，使其不阻塞且不引发关于不干净 EOF 的错误。

bpo-27466 [https://bugs.python.org/issue?@action=redirect&bpo=27466]: 更改 http.cookie.time2netscape 返回的时间格式，确认 netscape cookie 格式并使其与文档一致。

bpo-26664 [https://bugs.python.org/issue?@action=redirect&bpo=26664]: 通过移除 $ 的错误使用修复 activate.fish。

bpo-22115 [https://bugs.python.org/issue?@action=redirect&bpo=22115]: 修复了跟踪 Tkinter 变量的功能：trace_vdelete() 使用错误的模式不再破坏跟踪，trace_vinfo() 现在总是返回字符串对的列表，"u" 模式下的跟踪现在可以工作。

修复了 importlib.util.LazyLoader 中的一个作用域问题，该问题在懒加载一个已经被放入 sys.modules 的模块时会触发 UnboundLocalError。

bpo-27079 [https://bugs.python.org/issue?@action=redirect&bpo=27079]: 修复了curses.ascii函数isblank()、iscntrl()和ispunct()。

bpo-26754 [https://bugs.python.org/issue?@action=redirect&bpo=26754]: 一些函数（如compile()等）接受以整数可迭代对象编码的文件名参数。现在只接受字符串和字节类对象。

bpo-27048 [https://bugs.python.org/issue?@action=redirect&bpo=27048]: 防止distutils在Windows上因环境变量包含非ASCII字符而失败。

bpo-27330 [https://bugs.python.org/issue?@action=redirect&bpo=27330]: 修复了ctypes模块中可能的泄漏。

bpo-27238 [https://bugs.python.org/issue?@action=redirect&bpo=27238]: 移除了turtle模块中的裸except。原始由Jelle Zijlstra提供补丁。

bpo-27122 [https://bugs.python.org/issue?@action=redirect&bpo=27122]: 当在由contextlib.ExitStack()管理的上下文中引发异常，并且退出堆栈生成器之一捕获并在链中引发它时，退出时不再重新引发原始异常，而是让新的链式异常通过。这避免了issue25782中描述的 PEP 479 [https://www.python.org/dev/peps/pep-0479] 错误。

bpo-26386 [https://bugs.python.org/issue?@action=redirect&bpo=26386]: 修复了 ttk.TreeView 选中操作中项目 ID 包含空格的问题。

bpo-16182 [https://bugs.python.org/issue?@action=redirect&bpo=16182]: 修复 "readline" 模块中的多个函数以使用区域设置编码，并修复 get_begidx() 和 get_endidx() 返回代码点索引。

bpo-27392 [https://bugs.python.org/issue?@action=redirect&bpo=27392]: 添加 loop.connect_accepted_socket()。由 Jim Fulton 提供补丁。

bpo-27930 [https://bugs.python.org/issue?@action=redirect&bpo=27930]: 改进了logging.handlers.QueueListener的行为。感谢Paulo Andrade和Petr Viktorin的分析和补丁。

bpo-21201 [https://bugs.python.org/issue?@action=redirect&bpo=21201]: 提高了multiprocessing错误消息的可读性。感谢Wojciech Walczak的补丁。

bpo-27456 [https://bugs.python.org/issue?@action=redirect&bpo=27456]: asyncio：默认设置TCP_NODELAY。

bpo-27906 [https://bugs.python.org/issue?@action=redirect&bpo=27906]: 在高TCP流量期间修复socket接受耗尽问题。由Kevin Conway提供补丁。

bpo-28174 [https://bugs.python.org/issue?@action=redirect&bpo=28174]: 处理当SO_REUSEPORT未被正确支持时的情况。由Seth Michael Larson提供补丁。

bpo-26654 [https://bugs.python.org/issue?@action=redirect&bpo=26654]: 在asyncio.Handle.__repr__中检查functools.partial。由iceboy提供补丁。

bpo-26909 [https://bugs.python.org/issue?@action=redirect&bpo=26909]: 修复asyncio中慢速管道IO的问题。由INADA Naoki提供补丁。

bpo-28176 [https://bugs.python.org/issue?@action=redirect&bpo=28176]: 修复asyncio.SelectorLoop.sock_connect中的回调竞争问题。

bpo-27759 [https://bugs.python.org/issue?@action=redirect&bpo=27759]: 修复选择器错误保留无效文件描述符的问题。由Mark Williams提供补丁。

bpo-28368 [https://bugs.python.org/issue?@action=redirect&bpo=28368]: 如果子监视器没有附加循环，则拒绝监视进程。由Vincent Michel提供补丁。

bpo-28369 [https://bugs.python.org/issue?@action=redirect&bpo=28369]: 当传输的FD与add_reader、add_writer等一起使用时引发RuntimeError。

bpo-28370 [https://bugs.python.org/issue?@action=redirect&bpo=28370]: 加速asyncio.StreamReader.readexactly。由Коренберг Марк提供补丁。

bpo-28371 [https://bugs.python.org/issue?@action=redirect&bpo=28371]: 弃用将asyncio.Handles传递给run_in_executor的做法。

bpo-28372 [https://bugs.python.org/issue?@action=redirect&bpo=28372]: 修复asyncio以支持非python协程的格式化。

bpo-28399 [https://bugs.python.org/issue?@action=redirect&bpo=28399]: 在绑定前从文件系统中移除UNIX套接字。由Коренберг Марк提供补丁。

bpo-27972 [https://bugs.python.org/issue?@action=redirect&bpo=27972]: 禁止Tasks等待自身。

bpo-26923 [https://bugs.python.org/issue?@action=redirect&bpo=26923]: 修复 asyncio.Gather 一旦所有子项完成就拒绝被取消的问题。由 Johannes Ebke 提供补丁。

bpo-26796 [https://bugs.python.org/issue?@action=redirect&bpo=26796]: 不要为默认的线程池执行器配置工作线程数量。初始由 Hans Lawrenz 提供补丁。

bpo-28600 [https://bugs.python.org/issue?@action=redirect&bpo=28600]: 优化 loop.call_soon()。

bpo-28613 [https://bugs.python.org/issue?@action=redirect&bpo=28613]: 修复 get_event_loop() 在协程/回调中调用时返回当前循环的问题。

bpo-28639 [https://bugs.python.org/issue?@action=redirect&bpo=28639]: 修复 inspect.isawaitable 始终返回布尔值，由 Justin Mayfield 提供补丁。

bpo-28652 [https://bugs.python.org/issue?@action=redirect&bpo=28652]: 使循环方法拒绝它们不支持的套接字类型。

bpo-28653 [https://bugs.python.org/issue?@action=redirect&bpo=28653]: 修复 functools.lru_cache 中的 refleak。

bpo-28703 [https://bugs.python.org/issue?@action=redirect&bpo=28703]: 修复 asyncio.iscoroutinefunction 以处理 Mock 对象。

bpo-24142 [https://bugs.python.org/issue?@action=redirect&bpo=24142]: 读取损坏的配置文件会使解析器处于无效状态。原始由 Florian Höch 提供补丁。

bpo-28990 [https://bugs.python.org/issue?@action=redirect&bpo=28990]: 修复了如果在握手完成前关闭连接会导致 SSL 挂起的问题。（补丁由 HoHo-Ho 提供）

IDLE

bpo-15308 [https://bugs.python.org/issue?@action=redirect&bpo=15308]: 向Shell菜单添加了'中断执行'(^C)。由Roger Serwy提供补丁，由Bayard Randel更新。

bpo-27922 [https://bugs.python.org/issue?@action=redirect&bpo=27922]: 停止IDLE测试在屏幕上'闪烁'gui小部件。

在 IDLE 帮助窗口的标题中加入版本号

bpo-25564 [https://bugs.python.org/issue?@action=redirect&bpo=25564]: 在IDLE与控制台差异的部分，提到使用exec意味着每个语句都定义了__builtins__。

bpo-27714 [https://bugs.python.org/issue?@action=redirect&bpo=27714]: text_textview和test_autocomplete现在在同一个进程中重新运行时通过。这发生在test_idle使用-w选项运行但未使用-jn选项时失败时。修复test_config的警告。

bpo-25507 [https://bugs.python.org/issue?@action=redirect&bpo=25507]: IDLE不再因为其tkinter导入而运行有bug的代码。用户必须包含直接在Python中运行所需的相同导入。

bpo-27452 [https://bugs.python.org/issue?@action=redirect&bpo=27452]: 在IDLE configHandler测试转储中添加行计数器和crc。

bpo-27365 [https://bugs.python.org/issue?@action=redirect&bpo=27365]: 允许在 IDLE NEWS.txt 中使用非 ASCII 字符，用于贡献者姓名。

bpo-27245 [https://bugs.python.org/issue?@action=redirect&bpo=27245]: IDLE：干净地删除自定义主题和键绑定。以前，当 IDLE 从控制台或通过导入启动时，会发出一系列警告。由 Serhiy Storchaka 提供补丁。

C API

bpo-28808 [https://bugs.python.org/issue?@action=redirect&bpo=28808]: PyUnicode_CompareWithASCIIString() 现在永远不会引发异常。

bpo-26754 [https://bugs.python.org/issue?@action=redirect&bpo=26754]: PyUnicode_FSDecoder() 接受一个编码为整数迭代的文件名参数。现在只接受字符串和类字节对象。

文档

bpo-28513 [https://bugs.python.org/issue?@action=redirect&bpo=28513]: 记录了 zipfile 的命令行接口。

测试

bpo-28950 [https://bugs.python.org/issue?@action=redirect&bpo=28950]: 在 regrtest 命令行参数中禁止将 -j0 与 -T/-l/-M 组合使用。

bpo-28666 [https://bugs.python.org/issue?@action=redirect&bpo=28666]: 现在test.support.rmtree能够删除不可写或不可读的目录。

bpo-23839 [https://bugs.python.org/issue?@action=redirect&bpo=23839]: 现在在运行每个测试文件之前清除各种缓存。

bpo-28409 [https://bugs.python.org/issue?@action=redirect&bpo=28409]: regrtest: 修复命令行参数的解析器。

bpo-27787 [https://bugs.python.org/issue?@action=redirect&bpo=27787]: 在检查每个测试的“悬挂线程”之前调用gc.collect()，因为悬挂线程是弱引用。

bpo-27369 [https://bugs.python.org/issue?@action=redirect&bpo=27369]: 在test_pyexpat中，避免测试在Expat 2.2.0中已更改的错误消息详情。

工具/示例

bpo-27952 [https://bugs.python.org/issue?@action=redirect&bpo=27952]: 使Tools/scripts/fixcid.py能够在Python 3和当前的"re"模块下工作，避免无效的Python反斜杠转义，并修复解析转义C引号符号时的错误。

bpo-27332 [https://bugs.python.org/issue?@action=redirect&bpo=27332]: 修复了由Argument Clinic生成的模块级函数的第一个参数的类型。由Petr Viktorin提供补丁。

bpo-27418 [https://bugs.python.org/issue?@action=redirect&bpo=27418]: 修复了Tools/importbench/importbench.py。

Windows

bpo-28251 [https://bugs.python.org/issue?@action=redirect&bpo=28251]: 改进 Windows 上的帮助手册。

bpo-28110 [https://bugs.python.org/issue?@action=redirect&bpo=28110]: launcher.msi 在 32 位和 64 位之间有不同的产品代码

bpo-25144 [https://bugs.python.org/issue?@action=redirect&bpo=25144]: 确保在继续自定义安装之前设置TargetDir。

bpo-27469 [https://bugs.python.org/issue?@action=redirect&bpo=27469]: 向启动器添加shell扩展，以便拖放操作能正确工作。

bpo-27309 [https://bugs.python.org/issue?@action=redirect&bpo=27309]: 在 python[w].exe 清单中启用了适当的 Windows 样式。

构建

bpo-29080 [https://bugs.python.org/issue?@action=redirect&bpo=29080]: 从PCBuild/build.bat中移除对hg.exe的硬依赖

bpo-23903 [https://bugs.python.org/issue?@action=redirect&bpo=23903]: 向PC/python3.def添加遗漏的名称。

bpo-10656 [https://bugs.python.org/issue?@action=redirect&bpo=10656]: 修复AIX上的树外构建。由Tristan Carel和Michael Haubenwallner提供补丁。

bpo-26359 [https://bugs.python.org/issue?@action=redirect&bpo=26359]: 将--with-optimiations重命名为--enable-optimizations。

bpo-28444 [https://bugs.python.org/issue?@action=redirect&bpo=28444]: 修复交叉编译时缺少扩展模块的问题。

bpo-28248 [https://bugs.python.org/issue?@action=redirect&bpo=28248]: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2j。

bpo-28258 [https://bugs.python.org/issue?@action=redirect&bpo=28258]: 修复了在爱沙尼亚语言环境下构建的问题（Makefile中的python-config和distclean目标）。由Arfrever Frehtes Taifersar Arahesis提供补丁。

bpo-26661 [https://bugs.python.org/issue?@action=redirect&bpo=26661]: setup.py现在可以检测到带有multiarch包装的系统libffi。

bpo-28066 [https://bugs.python.org/issue?@action=redirect&bpo=28066]: 修复在源代码树外构建时搜索构建目录中生成的包含文件的逻辑。

bpo-15819 [https://bugs.python.org/issue?@action=redirect&bpo=15819]: 移除了为在源码树外构建而冗余的包含搜索目录选项。

bpo-27566 [https://bugs.python.org/issue?@action=redirect&bpo=27566]: 修复冻结makefile中的clean目标（Lisa Roach提供补丁）

bpo-27705 [https://bugs.python.org/issue?@action=redirect&bpo=27705]: 更新validate_ucrtbase.py中的消息

bpo-27983 [https://bugs.python.org/issue?@action=redirect&bpo=27983]: 当使用clang作为PGO链接所需工具时，由于缺少llvm-profdata工具，在启用--with-optimizations时将配置时错误变为make时错误。同时提高我们在MacOS和一些Linux上找到llvm-profdata工具的能力。

bpo-26307 [https://bugs.python.org/issue?@action=redirect&bpo=26307]: profile-opt构建现在将PGO应用于内置模块。

bpo-26359 [https://bugs.python.org/issue?@action=redirect&bpo=26359]: 添加--with-optimizations配置标志。

bpo-27713 [https://bugs.python.org/issue?@action=redirect&bpo=27713]: 在更新importlib的引导文件时抑制虚假的构建警告。由Xiang Zhang提供补丁。

bpo-25825 [https://bugs.python.org/issue?@action=redirect&bpo=25825]: 更正对Modules/python.exp和ld_so_aix的引用，这些在AIX上是必需的。这更新了对在3.2a4中更改的安装路径的引用，并撤销了在3.5.0a1中对构建树的引用更改。

bpo-27453 [https://bugs.python.org/issue?@action=redirect&bpo=27453]: 配置中的CPP调用必须使用CPPFLAGS。由Chi Hsuan Yen提供补丁。

bpo-27641 [https://bugs.python.org/issue?@action=redirect&bpo=27641]: 配置脚本现在在makefile中插入注释，以防止pgen和_freeze_importlib可执行文件被交叉编译。

bpo-26662 [https://bugs.python.org/issue?@action=redirect&bpo=26662]: 在配置中设置PYTHON_FOR_GEN作为构建期间用于文件生成的Python程序。

bpo-10910 [https://bugs.python.org/issue?@action=redirect&bpo=10910]: 避免在FreeBSD和OS X上出现C++编译错误。同时更新FreedBSD版本检查以应对原始的ctype UTF-8变通方案。

bpo-28676 [https://bugs.python.org/issue?@action=redirect&bpo=28676]: 防止在macOS上出现缺失'getentropy'声明的警告。由Gareth Rees提供补丁。

Python 3.5.2 正式版

发布日期: 2016-06-26

核心与内置函数

bpo-26930 [https://bugs.python.org/issue?@action=redirect&bpo=26930]: 更新Windows构建以使用OpenSSL 1.0.2h。

测试

bpo-26867 [https://bugs.python.org/issue?@action=redirect&bpo=26867]: Ubuntu的openssl OP_NO_SSLv3默认强制开启；修复测试。

IDLE

bpo-27365 [https://bugs.python.org/issue?@action=redirect&bpo=27365]: 允许在idlelib/NEWS.txt中使用非ASCII字符 - 3.5.2的最小部分。

Python 3.5.2 rc1

发布日期: 2016-06-12

安全性

bpo-26556 [https://bugs.python.org/issue?@action=redirect&bpo=26556]: Update expat to 2.1.1, fixes CVE-2015-1283.

Fix TLS stripping vulnerability in smtplib, CVE-2016-0772. Reported by Team Oststrom

bpo-26839 [https://bugs.python.org/issue?@action=redirect&bpo=26839]: 在Linux上，os.urandom() 现在调用 getrandom() 与 GRND_NONBLOCK，如果urandom熵池尚未初始化，则回退到读取 /dev/urandom。补丁由Colm Buckley编写。

bpo-26657 [https://bugs.python.org/issue?@action=redirect&bpo=26657]: 修复Windows上http.server的目录遍历漏洞。这修复了在3.3.4rc1和3.4.0rc1中引入的回归问题。基于Philipp Hagemeister的补丁。

bpo-26313 [https://bugs.python.org/issue?@action=redirect&bpo=26313]: 如果windows证书存储为空，ssl.py _load_windows_store_certs失败。由Baji提供补丁。

bpo-25939 [https://bugs.python.org/issue?@action=redirect&bpo=25939]: 在Windows上以只读方式打开证书存储于ssl.enum_certificates中。

核心与内置函数

bpo-27066 [https://bugs.python.org/issue?@action=redirect&bpo=27066]: 修复了如果自定义 opener（为 open()）返回一个负数而没有设置异常时的 SystemError。

bpo-20041 [https://bugs.python.org/issue?@action=redirect&bpo=20041]: 修复当frame.f_trace被设置为None时的TypeError。由Xavier de Gaye提供补丁。

bpo-26168 [https://bugs.python.org/issue?@action=redirect&bpo=26168]: 修复了在使用 "N" 格式化单元时 Py_BuildValue() 失败可能导致的内存泄漏问题。

bpo-26991 [https://bugs.python.org/issue?@action=redirect&bpo=26991]: 修复了创建带有注解的函数时可能出现的内存泄漏问题。

bpo-27039 [https://bugs.python.org/issue?@action=redirect&bpo=27039]: 修复了bytearray.remove()对于大于127的值的问题。由Joe Jevnik提供补丁。

bpo-23640 [https://bugs.python.org/issue?@action=redirect&bpo=23640]: int.from_bytes() 不再绕过子类的构造函数。

bpo-26811 [https://bugs.python.org/issue?@action=redirect&bpo=26811]: gc.get_objects() 不再包含带有 NULL 指针的损坏元组。

bpo-20120 [https://bugs.python.org/issue?@action=redirect&bpo=20120]: 使用 RawConfigParser 来解析 .pypirc 文件，移除了无意中随着迁移到 Python 3 而添加的插值支持。现在的行为不会再在 .pypirc 文件中进行任何插值，与 Python 2.7 和 Setuptools 19.0 的行为一致。

bpo-26659 [https://bugs.python.org/issue?@action=redirect&bpo=26659]: 使内置的 slice 类型支持循环回收。

bpo-26718 [https://bugs.python.org/issue?@action=redirect&bpo=26718]: super.__init__ 如果被多次调用，将不再泄露内存。注意：不推荐直接调用 super.__init__！

bpo-25339 [https://bugs.python.org/issue?@action=redirect&bpo=25339]: 现在在设置 stdin 和 stdout 的错误处理器时，PYTHONIOENCODING 优先于 locale。

bpo-26494 [https://bugs.python.org/issue?@action=redirect&bpo=26494]: 修复了在迭代耗尽迭代器时的崩溃问题。受影响的类包括通用序列迭代器、str、bytes、bytearray、list、tuple、set、frozenset、dict、OrderedDict的迭代器，相应的视图以及os.scandir()迭代器。

bpo-26581 [https://bugs.python.org/issue?@action=redirect&bpo=26581]: 如果在Python源代码文件中一行内多次指定编码声明，只有第一个会被考虑。

bpo-26464 [https://bugs.python.org/issue?@action=redirect&bpo=26464]: 修复了当字符串为ASCII且第一个替换移除了字符，但下一个替换使用非ASCII字符或长度超过1个字符的字符串时str.translate()的问题。这是在Python 3.5.0中引入的回归问题。

bpo-22836 [https://bugs.python.org/issue?@action=redirect&bpo=22836]: 确保即使格式化产生次要错误时，PyErr_Display()和PyErr_WriteUnraisable()产生的异常报告也是合理的。这影响sys.__excepthook__()产生的报告以及__del__()引发异常时的情况。

bpo-26302 [https://bugs.python.org/issue?@action=redirect&bpo=26302]: 修正行为，拒绝将逗号作为cookie名称的合法字符。

bpo-4806 [https://bugs.python.org/issue?@action=redirect&bpo=4806]: 在函数调用中使用星号（*）解包时，避免掩盖原始的TypeError异常。基于Hagen Fürstenau和Daniel Urban的补丁。

bpo-27138 [https://bugs.python.org/issue?@action=redirect&bpo=27138]: 修正了 FileFinder.find_spec() 的文档注释。

bpo-26154 [https://bugs.python.org/issue?@action=redirect&bpo=26154]: 新增一个私有函数_PyThreadState_UncheckedGet()用于获取当前Python线程状态，但如果其为NULL时不发出致命错误。必须使用此新函数而非直接访问_PyThreadState_Current变量。自Python 3.5.1起，该变量不再暴露以隐藏原子C类型的精确实现，避免编译器问题。

bpo-26194 [https://bugs.python.org/issue?@action=redirect&bpo=26194]: Deque.insert()对于已达到最大大小的有界deque给出了奇怪的结果。现在当尝试向一个已满的deque插入时会引发IndexError。

bpo-25843 [https://bugs.python.org/issue?@action=redirect&bpo=25843]: 编译代码时，如果常量相等但类型不同，则不合并它们。例如，f1, f2 = lambda: 1, lambda: 1.0``现在被正确编译为两个不同的函数：``f1()``返回 ``1 (int) 和``f2()``返回 1.0 (float) ，即使 1 和 1.0 相等。

bpo-22995 [https://bugs.python.org/issue?@action=redirect&bpo=22995]: [更新] 由于在基于Cython的项目中观察到的回归问题，注释掉_PyObject_GetState()中的一个可pickle性测试。

bpo-25961 [https://bugs.python.org/issue?@action=redirect&bpo=25961]: 类型名称中不允许空字符。

bpo-25973 [https://bugs.python.org/issue?@action=redirect&bpo=25973]: 修复当无效的非局部语句绑定一个以两个下划线开头的名称时导致的段错误。

bpo-22995 [https://bugs.python.org/issue?@action=redirect&bpo=22995]: 不是列表或字典的子类且未实现任何与pickle相关的方法（__reduce__、__reduce_ex__、__getnewargs__、__getnewargs_ex__或__getstate__）的扩展类型实例，包括memoryview，将不能再被pickle。

bpo-20440 [https://bugs.python.org/issue?@action=redirect&bpo=20440]: 大量替换不安全的属性设置代码为特殊宏Py_SETREF。

bpo-25766 [https://bugs.python.org/issue?@action=redirect&bpo=25766]: 特殊方法__bytes__()现在在str子类中工作。

bpo-25421 [https://bugs.python.org/issue?@action=redirect&bpo=25421]: 内置类型的__sizeof__方法现在使用动态基本大小。这使得sys.getsize()能够正确工作于定义了__slots__的子类。

bpo-25709 [https://bugs.python.org/issue?@action=redirect&bpo=25709]: 修复了原地字符串连接和utf-8缓存的问题。

bpo-27147 [https://bugs.python.org/issue?@action=redirect&bpo=27147]: 在 importlib 文档中提到了 PEP 420 [https://www.python.org/dev/peps/pep-0420]。

bpo-24097 [https://bugs.python.org/issue?@action=redirect&bpo=24097]: 修复了如果槽名称在__getattr__内部被释放时object.__reduce__()中的崩溃问题。

bpo-24731 [https://bugs.python.org/issue?@action=redirect&bpo=24731]: 修复了在将具有特殊方法 __bytes__、__trunc__ 和 __float__ 的对象转换为 bytes、int 和 float 的子类时，返回这些子类实例导致的崩溃问题。

bpo-26478 [https://bugs.python.org/issue?@action=redirect&bpo=26478]: 修复在使用二进制运算符与字典视图和元组时的语义错误。

bpo-26171 [https://bugs.python.org/issue?@action=redirect&bpo=26171]: 修复zipimporter.get_data()中可能的整数溢出和堆损坏问题。

bpo-25660 [https://bugs.python.org/issue?@action=redirect&bpo=25660]: 修复REPL中使用readline时的TAB键行为。

bpo-25887 [https://bugs.python.org/issue?@action=redirect&bpo=25887]: 当协程对象被多次等待时，抛出RuntimeError。

bpo-27243 [https://bugs.python.org/issue?@action=redirect&bpo=27243]: 更新 __aiter__ 协议：异步迭代器应该直接返回，而不是返回一个解析为异步迭代器的 awaitable。执行前者将触发 PendingDeprecationWarning。

库

bpo-21386 [https://bugs.python.org/issue?@action=redirect&bpo=21386]: 实现了缺失的 IPv4Address.is_global 属性。自 07a5610bae9d 以来已有文档记录。初始由 Roger Luethi 提供补丁。

bpo-20900 [https://bugs.python.org/issue?@action=redirect&bpo=20900]: distutils register 命令现在能正确解码 HTTP 响应。初始由 ingrid 提供补丁。

新版本的 typing.py 提供了几个新类和特性：stubs 外的 @overload、Reversible、DefaultDict、Text、ContextManager、Type[]、NewType()、TYPE_CHECKING，以及众多错误修复（注意，一些新特性尚未在 mypy 或其他静态分析器中实现）。同时，为 PEP 492 [https://www.python.org/dev/peps/pep-0492] (Awaitable、AsyncIterable、AsyncIterator) 添加的类也已加入（实际上它们已在 3.5.1 中实现，但从未被提及）。

bpo-25738 [https://bugs.python.org/issue?@action=redirect&bpo=25738]: 停止 http.server.BaseHTTPRequestHandler.send_error() 为 205 Reset Content 发送消息体。同时，不在没有正文的响应中发送 Content 头字段。由 Susumu Koshiba 提供补丁。

bpo-21313 [https://bugs.python.org/issue?@action=redirect&bpo=21313]: 修复 "platform" 模块以容忍 sys.version 包含截断的构建信息。

bpo-27164 [https://bugs.python.org/issue?@action=redirect&bpo=27164]: 在 zlib 模块中，允许使用预定义的 zdict 解压原始 Deflate 流。基于 Xiang Zhang 的补丁。

bpo-24291 [https://bugs.python.org/issue?@action=redirect&bpo=24291]: 修复 wsgiref.simple_server.WSGIRequestHandler 以完全向客户端写入数据。之前它可能进行部分写入并截断数据。同时，wsgiref.handler.ServerHandler 现在可以处理 stdout 进行部分写入，但此功能已被弃用。

bpo-26809 [https://bugs.python.org/issue?@action=redirect&bpo=26809]: 向 string 添加了 __all__。由 Emanuel Barry 提供补丁。

bpo-26373 [https://bugs.python.org/issue?@action=redirect&bpo=26373]: subprocess.Popen.communicate 现在在更多/所有情况下，当子进程在调用 .communicate() 之前死亡时，正确地忽略 BrokenPipeError。

bpo-21776 [https://bugs.python.org/issue?@action=redirect&bpo=21776]: distutils.upload 现在正确处理 HTTPError。初始由 Claudiu Popa 提供补丁。

bpo-27114 [https://bugs.python.org/issue?@action=redirect&bpo=27114]: 修复 SSLContext._load_windows_store_certs 因 PermissionError 失败的问题。

bpo-18383 [https://bugs.python.org/issue?@action=redirect&bpo=18383]: 避免在使用 filterwarnings 和 simplefilter 时创建重复的过滤器。基于 Alex Shkop 的补丁。

bpo-27057 [https://bugs.python.org/issue?@action=redirect&bpo=27057]: 修复Android上的os.set_inheritable()，ioctl()被SELinux阻止并因EACCESS失败。该函数现在回退到使用fcntl()。补丁由Michał Bednarski编写。

bpo-27014 [https://bugs.python.org/issue?@action=redirect&bpo=27014]: 修复使用typing.py时的无限递归问题。感谢Kalle Tuure！

bpo-14132 [https://bugs.python.org/issue?@action=redirect&bpo=14132]: 修复urllib.request在目标仅有查询字符串时的重定向处理。原始修复由Ján Janech提供。

bpo-17214 [https://bugs.python.org/issue?@action=redirect&bpo=17214]: "urllib.request"模块现在对重定向目标URL中的非ASCII字节进行百分比编码。一些服务器发送含有非ASCII字节的Location头字段，但"http.client"要求请求目标必须可ASCII编码，否则会抛出UnicodeEncodeError。基于Christian Heimes的补丁。

bpo-26892 [https://bugs.python.org/issue?@action=redirect&bpo=26892]: 在urllib.request.HTTPHandler中尊重debuglevel标志。补丁由Chi Hsuan Yen贡献。

bpo-22274 [https://bugs.python.org/issue?@action=redirect&bpo=22274]: 在subprocess模块中，即使stdout未被重定向，也允许将stderr重定向到stdout。补丁由Akira Li提供。

bpo-26807 [https://bugs.python.org/issue?@action=redirect&bpo=26807]: mock_open 'files' 在文件末尾的readline操作不再报错。补丁由Yolanda Robla提供。

bpo-25745 [https://bugs.python.org/issue?@action=redirect&bpo=25745]: 修复了curses panel析构函数中userptr的泄漏问题。

bpo-26977 [https://bugs.python.org/issue?@action=redirect&bpo=26977]: 在statistics.pvariance中移除了不必要且被忽略的平方和辅助函数调用。

bpo-26881 [https://bugs.python.org/issue?@action=redirect&bpo=26881]: modulefinder模块现在支持扩展的操作码参数。

bpo-23815 [https://bugs.python.org/issue?@action=redirect&bpo=23815]: 修复了直接创建_tkinter和curses.panel模块中类型实例相关的崩溃问题。

bpo-17765 [https://bugs.python.org/issue?@action=redirect&bpo=17765]: weakref.ref()不再默默忽略关键字参数。由Georg Brandl提供补丁。

bpo-26873 [https://bugs.python.org/issue?@action=redirect&bpo=26873]: xmlrpc现在会在遇到不支持的类型标签时抛出ResponseError，而不是默默返回错误结果。

bpo-26711 [https://bugs.python.org/issue?@action=redirect&bpo=26711]: 修复了plistlib.Data与其他类型的比较问题。

bpo-24114 [https://bugs.python.org/issue?@action=redirect&bpo=24114]: Fix an uninitialized variable in ctypes.util. The bug only occurs on SunOS when the ctypes implementation searches for the crle program. Patch by Xiang Zhang. Tested on SunOS by Kees Bos.

bpo-26864 [https://bugs.python.org/issue?@action=redirect&bpo=26864]: 在urllib.request中，将代理绕过主机检查对no_proxy的匹配改为不区分大小写，并且不匹配那些恰好以后缀形式包含被绕过主机名的无关主机名。由Xiang Zhang提供补丁。

bpo-26634 [https://bugs.python.org/issue?@action=redirect&bpo=26634]: recursive_repr() 现在设置包装器的 __qualname__。由 Xiang Zhang 提供补丁。

bpo-26804 [https://bugs.python.org/issue?@action=redirect&bpo=26804]: urllib.request 现在会优先选择小写的代理环境变量，而不是大写或混合大小写的。补丁由 Hans-Peter Jansen 贡献。

bpo-26837 [https://bugs.python.org/issue?@action=redirect&bpo=26837]: assertSequenceEqual() 现在能正确输出非字符串化的不同项（如 -b 模式下的字节）。这影响了 assertListEqual() 和 assertTupleEqual()。

bpo-26041 [https://bugs.python.org/issue?@action=redirect&bpo=26041]: 从 platform.dist() 和 platform.linux_distribution() 的弃用消息中移除了 "将在 Python 3.7 中移除"。由 Kumaripaba Miyurusara Athukorala 提供补丁。

bpo-26822 [https://bugs.python.org/issue?@action=redirect&bpo=26822]: itemgetter、attrgetter 和 methodcaller 对象不再静默忽略关键字参数。

bpo-26733 [https://bugs.python.org/issue?@action=redirect&bpo=26733]: 反汇编一个类现在会反汇编类和静态方法。由 Xiang Zhang 提供补丁。

bpo-26801 [https://bugs.python.org/issue?@action=redirect&bpo=26801]: 修复 shutil.get_terminal_size() 中的错误处理，捕获 AttributeError 而不是 NameError。补丁由 Emanuel Barry 编写。

bpo-24838 [https://bugs.python.org/issue?@action=redirect&bpo=24838]: tarfile 的 ustar 和 gnu 格式现在能正确计算多字节字符编码（如 utf-8）的名称和链接字段限制。

bpo-26717 [https://bugs.python.org/issue?@action=redirect&bpo=26717]: 停止用 UTF-8 编码拉丁-1 化的 WSGI 路径。由 Anthony Sottile 提供补丁。

bpo-26735 [https://bugs.python.org/issue?@action=redirect&bpo=26735]: 修复 Solaris 11.3 及更新版本上 os.urandom() 当读取超过 1,024 字节时的问题：多次调用 getrandom()，每次调用限制为 1024 字节。

bpo-16329 [https://bugs.python.org/issue?@action=redirect&bpo=16329]: 向 mimetypes.types_map 添加 .webm。由 Giampaolo Rodola' 提供补丁。

bpo-13952 [https://bugs.python.org/issue?@action=redirect&bpo=13952]: 向 mimetypes.types_map 添加 .csv。由 Geoff Wilson 提供补丁。

bpo-26709 [https://bugs.python.org/issue?@action=redirect&bpo=26709]: 修复了加载二进制 PLists 时的 Y2038 问题。

bpo-23735 [https://bugs.python.org/issue?@action=redirect&bpo=23735]: 通过安装我们自己的 SIGWINCH 处理程序，处理 Readline 6.3+ 的终端调整大小。由 Eric Price 提供补丁。

bpo-26586 [https://bugs.python.org/issue?@action=redirect&bpo=26586]: 在 http.server 中，如果头字段太多无法解析，则响应 "413 请求头字段太大"，而不是终止连接并引发未处理的异常。由 Xiang Zhang 提供补丁。

bpo-22854 [https://bugs.python.org/issue?@action=redirect&bpo=22854]: 将 BufferedReader.writable() 和 BufferedWriter.readable() 更改为总是返回 False。

bpo-25195 [https://bugs.python.org/issue?@action=redirect&bpo=25195]: 修复了 mock.MagicMock 中的一个回归问题。_Call 是 tuple 的子类（changeset 3603bae63c13 仅适用于类），所以我们需要自己实现 __ne__。由 Andrew Plummer 提供补丁。

bpo-26644 [https://bugs.python.org/issue?@action=redirect&bpo=26644]: 当向 SSLSocket.recv() 或 read() 传递负长度时，引发 ValueError 而不是 SystemError。

bpo-23804 [https://bugs.python.org/issue?@action=redirect&bpo=23804]: 修复 SSL recv(0) 和 read(0) 方法返回零字节而不是最多 1024 字节的问题。

bpo-26616 [https://bugs.python.org/issue?@action=redirect&bpo=26616]: 修复了 datetime.astimezone() 方法中的一个错误。

bpo-21925 [https://bugs.python.org/issue?@action=redirect&bpo=21925]: warnings.formatwarning() 现在捕获 linecache.getline(...) 上的异常，以便能够记录在Python关闭过程后期发出的 ResourceWarning。

bpo-24266 [https://bugs.python.org/issue?@action=redirect&bpo=24266]: 在编译时使用Readline 7的情况下，Readline历史搜索期间的Ctrl+C现在会取消搜索模式。

bpo-26560 [https://bugs.python.org/issue?@action=redirect&bpo=26560]: 避免BaseHandler.start_response中潜在的ValueError。初始由Peter Inglesby提供补丁。

bpo-26569 [https://bugs.python.org/issue?@action=redirect&bpo=26569]: 修复 pyclbr.readmodule() 和 pyclbr.readmodule_ex() 以支持导入包。

bpo-26499 [https://bugs.python.org/issue?@action=redirect&bpo=26499]: 在HTTPResponse.readline()和read1()中考虑剩余的Content-Length。基于Silent Ghost的补丁。同时记录HTTPResponse现在支持这些方法。

bpo-25320 [https://bugs.python.org/issue?@action=redirect&bpo=25320]: 处理unittest发现扫描的目录中的套接字。补丁来自Victor van den Elzen。

bpo-16181 [https://bugs.python.org/issue?@action=redirect&bpo=16181]: 现在如果年份高于datetime.MAXYEAR，cookiejar.http2time()会返回None。

bpo-26513 [https://bugs.python.org/issue?@action=redirect&bpo=26513]: 修复了平台模块对Windows Server的检测。

bpo-23718 [https://bugs.python.org/issue?@action=redirect&bpo=23718]: 修复了在1月1日前的第0周解析时间的问题。原始由Tamás Bence Gedai提供补丁。

bpo-20589 [https://bugs.python.org/issue?@action=redirect&bpo=20589]: 在Windows上调用Path.owner()和Path.group()现在会引发NotImplementedError而不是ImportError。

bpo-26177 [https://bugs.python.org/issue?@action=redirect&bpo=26177]: 修复了Canvas和Scrollbar小部件的keys()方法。

bpo-15068 [https://bugs.python.org/issue?@action=redirect&bpo=15068]: 在fileinput模块中去掉了过度的缓冲。bufsize参数不再使用。

bpo-2202 [https://bugs.python.org/issue?@action=redirect&bpo=2202]: 修复了AbstractDigestAuthHandler.get_algorithm_impls中的UnboundLocalError。初始由Mathieu Dupuy提供补丁。

bpo-25718 [https://bugs.python.org/issue?@action=redirect&bpo=25718]: 修复了当total为None时，对accumulate()迭代器的pickling和复制。

bpo-26475 [https://bugs.python.org/issue?@action=redirect&bpo=26475]: 修复了带有(?x)标志的正则表达式的调试输出。

bpo-26457 [https://bugs.python.org/issue?@action=redirect&bpo=26457]: 修复了当结果前缀长度等于最大前缀长度时，IP网络类中的subnets()方法。基于Xiang Zhang的补丁。

bpo-26385 [https://bugs.python.org/issue?@action=redirect&bpo=26385]: 如果NamedTemporaryFile()中的内部open()调用失败，则删除文件。由Silent Ghost提供补丁。

bpo-26402 [https://bugs.python.org/issue?@action=redirect&bpo=26402]: 修复了XML-RPC客户端在服务器关闭持久连接时重试的问题。这是与3.5.0a4中的新http.client.RemoteDisconnected异常相关的回归问题。

bpo-25913 [https://bugs.python.org/issue?@action=redirect&bpo=25913]: 在adobe=True时，base64.a85decode()中前导的 <~ 现在是可选的。由Swati Jaiswal提供补丁。

bpo-26186 [https://bugs.python.org/issue?@action=redirect&bpo=26186]: 移除importlib.util.LazyLoader中的一个无效类型检查。

bpo-26367 [https://bugs.python.org/issue?@action=redirect&bpo=26367]: 当指定了 level 但没有指定相应的包时，importlib.__import__()像builtins.__import__()一样引发SystemError。

bpo-26309 [https://bugs.python.org/issue?@action=redirect&bpo=26309]: 在"socketserver"模块中，当verify_request()返回false时，关闭请求（关闭连接的套接字）。由Aviv Palivoda提供补丁。

bpo-25995 [https://bugs.python.org/issue?@action=redirect&bpo=25995]: os.walk()不再使用与树深度成比例的FDs。

bpo-26117 [https://bugs.python.org/issue?@action=redirect&bpo=26117]: os.scandir()迭代器现在不仅在迭代完成时关闭文件描述符，而且在因错误失败时也关闭。

bpo-25911 [https://bugs.python.org/issue?@action=redirect&bpo=25911]: 恢复了在Windows上os.walk()中对字节路径的支持。

bpo-26045 [https://bugs.python.org/issue?@action=redirect&bpo=26045]: 在使用http.client发布非Latin-1字符串时，向错误消息添加UTF-8建议。

bpo-12923 [https://bugs.python.org/issue?@action=redirect&bpo=12923]: 即使有异常也重置FancyURLopener的重定向计数器。基于Brian Brazil和Daniel Rocco的补丁。

bpo-25945 [https://bugs.python.org/issue?@action=redirect&bpo=25945]: 修复了解除 pickle functools.partial 对象时状态错误导致的崩溃问题。修复了 functools.partial 构造函数失败时的内存泄漏。functools.partial 的 "args" 和 "keywords" 属性现在总是分别具有 tuple 和 dict 类型。

bpo-26202 [https://bugs.python.org/issue?@action=redirect&bpo=26202]: copy.deepcopy() 现在能正确复制具有非原子属性的 range() 对象。

bpo-23076 [https://bugs.python.org/issue?@action=redirect&bpo=23076]: Path.glob() 现在在调用无效模式时会引发 ValueError。补丁由 Thomas Nyberg 提供。

bpo-19883 [https://bugs.python.org/issue?@action=redirect&bpo=19883]: 修复了 zipimport 中可能的整数溢出问题。

bpo-26227 [https://bugs.python.org/issue?@action=redirect&bpo=26227]: 在 Windows 上，socket 模块的 getnameinfo()、gethostbyaddr() 和 gethostbyname_ex() 函数现在从 ANSI 代码页而非 UTF-8 解码主机名。

bpo-26147 [https://bugs.python.org/issue?@action=redirect&bpo=26147]: xmlrpc 现在可以处理无法用所使用的非 UTF-8 编码编码的字符串。

bpo-25935 [https://bugs.python.org/issue?@action=redirect&bpo=25935]: 垃圾回收器现在可以打破 OrderedDict 的引用循环。

bpo-16620 [https://bugs.python.org/issue?@action=redirect&bpo=16620]: 修复了 msilib.Directory.glob() 中的 AttributeError。

bpo-26013 [https://bugs.python.org/issue?@action=redirect&bpo=26013]: 增加了对旧 Python 3 版本（3.4.3 及以下）创建的损坏协议 2 pickle 的兼容性。

bpo-25850 [https://bugs.python.org/issue?@action=redirect&bpo=25850]: 默认使用交叉编译为 64 位 Windows。

bpo-17633 [https://bugs.python.org/issue?@action=redirect&bpo=17633]: 改进zipimport对命名空间包的支持。

bpo-24705 [https://bugs.python.org/issue?@action=redirect&bpo=24705]: 修复了 sysconfig._parse_makefile 不扩展出现在 $() 变量之前的 ${} 变量的问题。

bpo-22138 [https://bugs.python.org/issue?@action=redirect&bpo=22138]: 修复了 mock.patch 在修补描述符时的行为。修补后恢复原始值。由 Sean McCully 提供补丁。

bpo-25672 [https://bugs.python.org/issue?@action=redirect&bpo=25672]: 在 ssl 模块中，如果安全的话，启用 SSL_MODE_RELEASE_BUFFERS 模式选项。

bpo-26012 [https://bugs.python.org/issue?@action=redirect&bpo=26012]: 在 pathlib.Path.[r]glob() 中不对符号链接进行 ** 模式的遍历。

bpo-24120 [https://bugs.python.org/issue?@action=redirect&bpo=24120]: 在使用 pathlib.Path.[r]glob() 遍历树时忽略 PermissionError。由 Ulrich Petri 提供补丁。

bpo-25447 [https://bugs.python.org/issue?@action=redirect&bpo=25447]: 如果 sys.stdin 没有缓冲区属性，fileinput 现在会直接使用它（恢复了向后兼容性）。

bpo-25447 [https://bugs.python.org/issue?@action=redirect&bpo=25447]: 复制 lru_cache() 包装器对象现在总是有效，与被包装对象的类型无关（通过返回未更改的原始对象）。

bpo-24103 [https://bugs.python.org/issue?@action=redirect&bpo=24103]: 修复了 ElementTree.XMLPullParser 中可能的使用后释放问题。

bpo-25860 [https://bugs.python.org/issue?@action=redirect&bpo=25860]: os.fwalk() 在发生错误时不再跳过剩余的目录。原始由 Samson Lee 提供补丁。

bpo-25914 [https://bugs.python.org/issue?@action=redirect&bpo=25914]: 修复并简化了 OrderedDict.__sizeof__。

bpo-25902 [https://bugs.python.org/issue?@action=redirect&bpo=25902]: 修复了 ElementTree 迭代中的各种引用计数问题。

bpo-25717 [https://bugs.python.org/issue?@action=redirect&bpo=25717]: 恢复在打开文件时容忍大多数fstat()错误的先前行为。这是3.5a1版本中的一个回归问题，阻止了匿名临时文件在特殊情况下的工作。

bpo-24903 [https://bugs.python.org/issue?@action=redirect&bpo=24903]: 修复了当指定'-d'时compileall接受的参数数量的回归问题。对参数数量的检查已被完全删除，因为它从未正确工作过。

bpo-25764 [https://bugs.python.org/issue?@action=redirect&bpo=25764]: 在subprocess模块中，当使用preexec_fn时，保留由fork()失败引起的任何异常。

bpo-6478 [https://bugs.python.org/issue?@action=redirect&bpo=6478]: 在更改时区后，_strptime的正则表达式缓存现在会被time.tzset()重置。

bpo-14285 [https://bugs.python.org/issue?@action=redirect&bpo=14285]: 当使用"python -m package"选项执行包且包初始化失败时，现在会报告正确的回溯。"runpy"模块现在让包初始化的异常传递回调用者，而不是引发ImportError。

bpo-19771 [https://bugs.python.org/issue?@action=redirect&bpo=19771]: 同样在runpy和"-m"选项中，如果包甚至无法初始化（例如由于坏的 *.pyc 文件），则省略不相关的消息"...是一个包，不能直接执行"。

bpo-25177 [https://bugs.python.org/issue?@action=redirect&bpo=25177]: 修复了非常小和非常大的数字的平均值问题。作为副作用，statistics.mean和statistics.variance应该会显著更快。

bpo-25718 [https://bugs.python.org/issue?@action=redirect&bpo=25718]: 修复了复制状态为布尔值false的对象的问题。

bpo-10131 [https://bugs.python.org/issue?@action=redirect&bpo=10131]: 修复了minidom文档的深拷贝问题。基于Marian Ganisin的补丁。

bpo-25725 [https://bugs.python.org/issue?@action=redirect&bpo=25725]: 修复了在解包含元组指令的无效数据时pickle.loads()中的引用泄漏问题。

bpo-25663 [https://bugs.python.org/issue?@action=redirect&bpo=25663]: 在Readline completer中，避免列出重复的全局名称，并在搜索内置名称之前搜索全局命名空间。

bpo-25688 [https://bugs.python.org/issue?@action=redirect&bpo=25688]: 修复了ElementTree.iterparse()在引发错误时的文件泄露问题。

bpo-23914 [https://bugs.python.org/issue?@action=redirect&bpo=23914]: 修复了解pickle数据损坏时unpickler引发的SystemError。

bpo-25691 [https://bugs.python.org/issue?@action=redirect&bpo=25691]: 修复了删除ElementTree.Element属性时的崩溃问题。

bpo-25624 [https://bugs.python.org/issue?@action=redirect&bpo=25624]: ZipFile现在总是为目录条目写入ZIP_STORED头。由王定远提供补丁。

如果主机已解析，则跳过 getaddrinfo。由 A. Jesse Jiryu Davis 提供补丁。

bpo-26050 [https://bugs.python.org/issue?@action=redirect&bpo=26050]: 添加 asyncio.StreamReader.readuntil() 方法。由 Марк Коренберг 提供补丁。

bpo-25924 [https://bugs.python.org/issue?@action=redirect&bpo=25924]: 在 OS X 10.5 或更高版本上避免不必要的 getaddrinfo(3) 调用序列化。原始补丁由 A. Jesse Jiryu Davis 提供。

bpo-26406 [https://bugs.python.org/issue?@action=redirect&bpo=26406]: 在当前版本的 OpenBSD 和 NetBSD 上避免不必要的 getaddrinfo(3) 调用序列化。由 A. Jesse Jiryu Davis 提供补丁。

bpo-26848 [https://bugs.python.org/issue?@action=redirect&bpo=26848]: 修复 asyncio/subprocess.communicate() 以处理空输入。由 Jack O'Connor 提供补丁。

bpo-27040 [https://bugs.python.org/issue?@action=redirect&bpo=27040]: 添加 loop.get_exception_handler 方法

bpo-27041 [https://bugs.python.org/issue?@action=redirect&bpo=27041]: asyncio: 添加 loop.create_future 方法

bpo-27223 [https://bugs.python.org/issue?@action=redirect&bpo=27223]: asyncio: 修复_read_ready和_write_ready以尊重_conn_lost。由Łukasz Langa提供补丁。

bpo-22970 [https://bugs.python.org/issue?@action=redirect&bpo=22970]: asyncio：修复取消Condition.wait时的不一致性。由David Coles提供补丁。

IDLE

bpo-5124 [https://bugs.python.org/issue?@action=redirect&bpo=5124]: 在 X11 上，现在粘贴选中的文本会替换选中内容。这匹配了 Windows、Mac、大多数现代 Linux 应用和 ttk 小部件上的粘贴工作方式。原始由 Serhiy Storchaka 提供补丁。

bpo-24759 [https://bugs.python.org/issue?@action=redirect&bpo=24759]: 在 idlelib.idle_test.__init__ 中明确表示该目录是 test.test_idle 的私有实现和维护者的工具。

bpo-27196 [https://bugs.python.org/issue?@action=redirect&bpo=27196]: 在运行 IDLE 测试时停止 'ThemeChanged' 警告。这些警告在其他警告被 #20567 抑制后仍然存在。将 Serhiy Storchaka 的 update_idletasks 解决方案应用于四个测试文件。在 idle_test/README.txt 中记录这一额外建议。

bpo-20567 [https://bugs.python.org/issue?@action=redirect&bpo=20567]: 修改 idle_test/README.txt，提供避免测试中 tk 警告信息的建议。将建议应用于几个 IDLE 测试。

bpo-27117 [https://bugs.python.org/issue?@action=redirect&bpo=27117]: 使颜色器 htest 和 turtledemo 支持深色主题。将配置文本小部件颜色的代码移至新函数。

bpo-26673 [https://bugs.python.org/issue?@action=redirect&bpo=26673]: 当 tk 报告字体大小为 0 时，更改为大小 10。Linux 上的此类字体阻止了配置对话框的打开。

bpo-21939 [https://bugs.python.org/issue?@action=redirect&bpo=21939]: 添加 IDLE 的渗滤器测试。原始由 Saimadhav Heblikar 提供补丁。

bpo-21676 [https://bugs.python.org/issue?@action=redirect&bpo=21676]: 添加 IDLE 的替换对话框测试。原始由 Saimadhav Heblikar 提供补丁。

bpo-18410 [https://bugs.python.org/issue?@action=redirect&bpo=18410]: 添加 IDLE 的搜索对话框测试。原始由 Westley Martínez 提供补丁。

bpo-21703 [https://bugs.python.org/issue?@action=redirect&bpo=21703]: 为IDLE的撤销委托器添加测试。原始由Saimadhav Heblikar提供补丁。

bpo-27044 [https://bugs.python.org/issue?@action=redirect&bpo=27044]: 添加ConfigDialog.remove_var_callbacks以防止内存泄漏。

bpo-23977 [https://bugs.python.org/issue?@action=redirect&bpo=23977]: 在test_delegator中添加更多断言。

bpo-20640 [https://bugs.python.org/issue?@action=redirect&bpo=20640]: 为 idlelib.configHelpSourceEdit 添加测试。由 Saimadhav Heblikar 提供补丁。

在 IDLE 文档的 'IDLE-控制台差异' 部分，澄清使用 IDLE 运行如何影响 sys.modules 和标准流。

bpo-25507 [https://bugs.python.org/issue?@action=redirect&bpo=25507]: 修复 IOBinding 中阻止打印的错误更改。增强 IOBinding htest 以包括所有主要 IOBinding 功能。

bpo-25905 [https://bugs.python.org/issue?@action=redirect&bpo=25905]: 恢复 README.txt 中 ' 到 ’ 右单引号的不必要转换，并用 'ascii' 打开此文件和 NEWS.txt。将 CREDITS.txt 重新编码为 utf-8 并用 'utf-8' 打开。

文档

bpo-19489 [https://bugs.python.org/issue?@action=redirect&bpo=19489]: 将搜索框从侧边栏移动到每个页面的页眉和页脚。由Ammar Askar提供补丁。

bpo-24136 [https://bugs.python.org/issue?@action=redirect&bpo=24136]: 文档化新的 PEP 448 [https://www.python.org/dev/peps/pep-0448] 解包语法（3.5版本）。

bpo-26736 [https://bugs.python.org/issue?@action=redirect&bpo=26736]: 尽可能在文档中使用 HTTPS 作为外部链接。

bpo-6953 [https://bugs.python.org/issue?@action=redirect&bpo=6953]: 重新组织 Readline 模块文档，将相关函数分组，并添加更多细节，如访问哪些底层的 Readline 函数和变量。

bpo-23606 [https://bugs.python.org/issue?@action=redirect&bpo=23606]: 向 ctypes 文档添加关于 cdll.msvcrt 的注释。

bpo-25500 [https://bugs.python.org/issue?@action=redirect&bpo=25500]: 修正文档，不再声称__import__在全局范围内搜索。

bpo-26014 [https://bugs.python.org/issue?@action=redirect&bpo=26014]: 更新 3.x 打包文档：* 现在在旧版页面中提供了指向新文档的 "参见" 链接 * 更新了指向 setuptools 文档的链接

测试

bpo-21916 [https://bugs.python.org/issue?@action=redirect&bpo=21916]: 为 turtle 模块添加了测试。由 ingrid、Gregory Loyse 和 Jelle Zijlstra 提供补丁。

bpo-26523 [https://bugs.python.org/issue?@action=redirect&bpo=26523]: 多进程线程池（multiprocessing.dummy.Pool）未经测试。

bpo-26015 [https://bugs.python.org/issue?@action=redirect&bpo=26015]: 为可变序列的迭代器的 pickle 操作添加了新测试。

bpo-26325 [https://bugs.python.org/issue?@action=redirect&bpo=26325]: 添加了 test.support.check_no_resource_warning() 来检查是否未发出 ResourceWarning。

bpo-25940 [https://bugs.python.org/issue?@action=redirect&bpo=25940]: 将test_ssl改为使用self-signed.pythontest.net。这避免了对svn.python.org的依赖，该网站最近更改了根证书。

bpo-25616 [https://bugs.python.org/issue?@action=redirect&bpo=25616]: OrderedDict 的测试从 test_collections 中提取出来，放入单独的文件 test_ordered_dict 中。

bpo-26583 [https://bugs.python.org/issue?@action=redirect&bpo=26583]: 如果无法写入字节码文件，则在test_import中跳过test_timestamp_overflow测试。

构建

bpo-26884 [https://bugs.python.org/issue?@action=redirect&bpo=26884]: 修复交叉构建中扩展模块的链接问题。由Xavier de Gaye提供补丁。

bpo-22359 [https://bugs.python.org/issue?@action=redirect&bpo=22359]: 在交叉编译时禁用运行_freeze_importlib和pgen的规则。这些程序的输出通常与源代码一起保存，并且在本地构建时仍会重新生成。由Xavier de Gaye提供补丁。

bpo-27229 [https://bugs.python.org/issue?@action=redirect&bpo=27229]: 修复树内构建的交叉编译pgen规则。由Xavier de Gaye提供补丁。

bpo-21668 [https://bugs.python.org/issue?@action=redirect&bpo=21668]: 将audioop、_datetime、_ctypes_test模块链接到libm，Mac OS X除外。补丁由Xavier de Gaye编写。

bpo-25702 [https://bugs.python.org/issue?@action=redirect&bpo=25702]: 添加了一个--with-lto配置选项，该选项将在make profile-opt期间启用构建时的链接时间优化。已知一些编译器和工具链在使用LTO时不会产生稳定的代码，因此在依赖它之前确保彻底测试。它可以比仅使用profile-opt提供几个%的速度提升。

bpo-26624 [https://bugs.python.org/issue?@action=redirect&bpo=26624]: 添加了对ucrtbase[d].dll版本的验证，并对旧版本发出警告。

bpo-17603 [https://bugs.python.org/issue?@action=redirect&bpo=17603]: 通过使用struct stat中st_blocks的低级检查，避免关于不存在的fileblocks.o文件的错误。

bpo-26079 [https://bugs.python.org/issue?@action=redirect&bpo=26079]: 修复 tix-8.4.3.6 的构建输出文件夹。由 Bjoern Thiel 提交补丁。

bpo-26465 [https://bugs.python.org/issue?@action=redirect&bpo=26465]: 更新 Windows 构建以使用 OpenSSL 1.0.2g。

bpo-24421 [https://bugs.python.org/issue?@action=redirect&bpo=24421]: 在构建扩展之前，先编译 Modules/_math.c 一次。之前如果数学和 cmath 构建同时进行，可能会导致编译失败。

bpo-25348 [https://bugs.python.org/issue?@action=redirect&bpo=25348]: 向 PCbuild\build.bat``添加了 ``--pgo 和 --pgo-job 参数，用于构建时进行配置文件引导优化。旧的 PCbuild\build_pgo.bat 脚本现已弃用，仅调用``PCbuildbuild.bat --pgo %*``。

bpo-25827 [https://bugs.python.org/issue?@action=redirect&bpo=25827]: 向 configure 添加了对使用 ICC 构建的支持，包括一个新的 --with-icc 标志。

bpo-25696 [https://bugs.python.org/issue?@action=redirect&bpo=25696]: 修复了在 UNIX 上使用 make -j9 安装 Python 的问题。

bpo-26930 [https://bugs.python.org/issue?@action=redirect&bpo=26930]: 更新OS X 10.5+ 32位仅安装程序以构建并与OpenSSL 1.0.2h链接。

bpo-26268 [https://bugs.python.org/issue?@action=redirect&bpo=26268]: 更新 Windows 构建以使用 OpenSSL 1.0.2f。

bpo-25136 [https://bugs.python.org/issue?@action=redirect&bpo=25136]: 支持 Apple Xcode 7 的新文本 SDK stub 库。

bpo-24324 [https://bugs.python.org/issue?@action=redirect&bpo=24324]: 当使用 gcc 时不启用不可达代码警告，因为该选项在旧版本的 gcc 中不起作用，并且在 gcc-4.5 之后已被静默移除。

Windows

bpo-27053 [https://bugs.python.org/issue?@action=redirect&bpo=27053]: 更新 make_zip.py 以正确生成库 ZIP 文件。

bpo-26268 [https://bugs.python.org/issue?@action=redirect&bpo=26268]: 更新 prepare_ssl.py 脚本以处理不包含 include 目录内容的 OpenSSL 版本（即 1.0.2e 及更高版本）。

bpo-26071 [https://bugs.python.org/issue?@action=redirect&bpo=26071]: bdist_wininst 创建的二进制文件无法启动并找到 32 位 Python

bpo-26073 [https://bugs.python.org/issue?@action=redirect&bpo=26073]: 更新启动器中的魔法数字列表

bpo-26065 [https://bugs.python.org/issue?@action=redirect&bpo=26065]: 在生成可嵌入发行版时从库中排除 venv。

bpo-17500 [https://bugs.python.org/issue?@action=redirect&bpo=17500]: 移除未使用和过时的图标。（另见：https://github.com/python/pythondotorg/issues/945）

工具/示例

bpo-26799 [https://bugs.python.org/issue?@action=redirect&bpo=26799]: 修复 python-gdb.py：不要在 Python 代码加载时一次性获取 C 类型，而是按需获取 C 类型。如果在 Python 可执行文件之前加载 python-gdb.py，C 类型可以改变。补丁由 Thomas Ilsche 编写。

bpo-26271 [https://bugs.python.org/issue?@action=redirect&bpo=26271]: 修复Freeze工具以正确使用通过configure传递的标志。补丁由Daniel Shaulov提供。

bpo-26489 [https://bugs.python.org/issue?@action=redirect&bpo=26489]: 向Tools/parser/unparse.py添加字典解包支持。由Guo Ci Teo提供补丁。

bpo-26316 [https://bugs.python.org/issue?@action=redirect&bpo=26316]: 修复Argument Clinic中的变量名拼写错误。

Python 3.5.1 正式版

发布日期: 2015-12-06

核心与内置函数

bpo-25709 [https://bugs.python.org/issue?@action=redirect&bpo=25709]: 修复了原地字符串连接和utf-8缓存的问题。

Windows

bpo-25715 [https://bugs.python.org/issue?@action=redirect&bpo=25715]: Python 3.5.1安装程序显示错误的升级路径和启动器检测逻辑。

Python 3.5.1 rc1

发布日期: 2015-11-22

核心与内置函数

bpo-25630 [https://bugs.python.org/issue?@action=redirect&bpo=25630]: 修复了在接受文件系统路径的函数中，参数解析时可能发生的段错误。

bpo-23564 [https://bugs.python.org/issue?@action=redirect&bpo=23564]: 修复了 _posixsubprocess 内部关于如何将 fds_to_pass 传递给子进程的部分损坏的健全性检查。由于 subprocess.py 已经避免了这个问题，这个错误没有实际影响。

bpo-25388 [https://bugs.python.org/issue?@action=redirect&bpo=25388]: 修复了在处理包含空字节的不可解码源代码时，分词器崩溃的问题。

bpo-25462 [https://bugs.python.org/issue?@action=redirect&bpo=25462]: 在 OrderedDict 的 C 实现中，大多数操作现在只计算一次键的哈希值。

bpo-22995 [https://bugs.python.org/issue?@action=redirect&bpo=22995]: __reduce__ 和 __reduce_ex__ 的默认实现现在拒绝那些未定义 __new__ 的内置类型。

bpo-25555 [https://bugs.python.org/issue?@action=redirect&bpo=25555]: 修复解析器和 AST：当从 Python 对象编译 AST 时，填充 "arg" 节点的 lineno 和 col_offset。

bpo-24802 [https://bugs.python.org/issue?@action=redirect&bpo=24802]: 当 int()、float()、compile()、exec() 和 eval() 传递类似字节的对象时，避免缓冲区过度读取。这些对象不一定以空字节终止，但函数假设它们是。

bpo-24726 [https://bugs.python.org/issue?@action=redirect&bpo=24726]: 修复了 OrderedDict 在直接调用 dict 方法后被 repr() 时崩溃和泄漏 NULL 的问题。

bpo-25449 [https://bugs.python.org/issue?@action=redirect&bpo=25449]: 现在在 C 实现和 Python 实现中，迭代具有不稳定哈希键的 OrderedDict 都会引发 KeyError。

bpo-25395 [https://bugs.python.org/issue?@action=redirect&bpo=25395]: 修复了在垃圾回收高度嵌套的 OrderedDict 结构时崩溃的问题。

bpo-25274 [https://bugs.python.org/issue?@action=redirect&bpo=25274]: sys.setrecursionlimit() 现在如果新的递归限制根据当前递归深度太低会引发 RecursionError。同时修改“低水位标记”公式使其单调。这个标记用于决定何时重置线程状态的溢出标志。

bpo-24402 [https://bugs.python.org/issue?@action=redirect&bpo=24402]: 修复 input() 在 sys.stdout.fileno() 失败时提示重定向的 stdout。

bpo-24806 [https://bugs.python.org/issue?@action=redirect&bpo=24806]: 防止不允许被继承的内置类型通过多重继承被继承。

bpo-24848 [https://bugs.python.org/issue?@action=redirect&bpo=24848]: 修复了UTF-7解码畸形数据时的一些错误。

bpo-25280 [https://bugs.python.org/issue?@action=redirect&bpo=25280]: 在详细模式(-v)下发出的导入跟踪消息不再格式化两次。

bpo-25003 [https://bugs.python.org/issue?@action=redirect&bpo=25003]: 在Solaris 11.3或更新版本上，os.urandom() 现在使用 getrandom() 函数而不是 getentropy() 函数。getentropy() 函数为了生成非常高质量的熵是阻塞的，os.urandom() 不需要如此高质量的熵。

bpo-25182 [https://bugs.python.org/issue?@action=redirect&bpo=25182]: stdprinter（在启动时导入io模块之前用作sys.stderr）现在使用backslashreplace错误处理程序。

bpo-25131 [https://bugs.python.org/issue?@action=redirect&bpo=25131]: 使集合/字典字面量和推导式的行号和列偏移与开括号对应。

bpo-25150 [https://bugs.python.org/issue?@action=redirect&bpo=25150]: Hide the private _Py_atomic_xxx symbols from the public Python.h header to fix a compilation error with OpenMP. PyThreadState_GET() becomes an alias to PyThreadState_Get() to avoid ABI incompatibilities.

库

bpo-25626 [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参数。

bpo-25583 [https://bugs.python.org/issue?@action=redirect&bpo=25583]: 当操作系统优先考虑如EACCES这样的错误而不是EEXIST时，避免os.makedirs(exist_ok=True)引发错误。

bpo-25593 [https://bugs.python.org/issue?@action=redirect&bpo=25593]: 修改了asyncio中EventLoop.stop()的语义。

bpo-6973 [https://bugs.python.org/issue?@action=redirect&bpo=6973]: 当我们知道一个subprocess.Popen进程已经死亡时，不允许send_signal()、terminate()或kill()方法执行任何操作，因为它们可能会信号到不同的进程。

bpo-25590 [https://bugs.python.org/issue?@action=redirect&bpo=25590]: 在Readline completer中，每个属性只调用一次getattr()。

bpo-25498 [https://bugs.python.org/issue?@action=redirect&bpo=25498]: 修复了在垃圾回收由包装memoryview创建的ctypes对象时的崩溃问题。这是3.5a1中的一个回归。基于Eryksun的补丁。

bpo-25584 [https://bugs.python.org/issue?@action=redirect&bpo=25584]: 将"escape"添加到glob模块的__all__列表中。

bpo-25584 [https://bugs.python.org/issue?@action=redirect&bpo=25584]: 修复了以 ** 开头的递归glob()模式。

bpo-25446 [https://bugs.python.org/issue?@action=redirect&bpo=25446]: 修复 smtplib 的 AUTH LOGIN 支持中的回归问题。

bpo-18010 [https://bugs.python.org/issue?@action=redirect&bpo=18010]: 修复 pydoc web 服务器的模块搜索功能，以处理导入包时的异常。

bpo-25554 [https://bugs.python.org/issue?@action=redirect&bpo=25554]: 消除了正则表达式解析中的循环引用。

bpo-25510 [https://bugs.python.org/issue?@action=redirect&bpo=25510]: 如果 FileInput 以二进制模式打开，fileinput.FileInput.readline() 现在在末尾返回 b'' 而不是 ''。由 Ryosuke Ito 提供补丁。

bpo-25503 [https://bugs.python.org/issue?@action=redirect&bpo=25503]: 修复了 inspect.getdoc() 对于属性的继承文档字符串的处理。原始由 John Mark Vandenberg 提供补丁。

bpo-25515 [https://bugs.python.org/issue?@action=redirect&bpo=25515]: 在 uuid.uuid4 中始终使用 os.urandom 作为随机性来源。

bpo-21827 [https://bugs.python.org/issue?@action=redirect&bpo=21827]: 修复了 textwrap.dedent() 当最大公共空白是最小前导空白的子字符串时的情况。基于 Robert Li 的补丁。

bpo-25447 [https://bugs.python.org/issue?@action=redirect&bpo=25447]: lru_cache() 包装器对象现在可以被复制和 pickle（通过返回未更改的原始对象）。

bpo-25390 [https://bugs.python.org/issue?@action=redirect&bpo=25390]: typing: 不因 Union[str, Pattern] 而崩溃。

bpo-25441 [https://bugs.python.org/issue?@action=redirect&bpo=25441]: asyncio: 当套接字关闭时从 drain() 引发错误。

bpo-25410 [https://bugs.python.org/issue?@action=redirect&bpo=25410]: 清理并修复了 OrderedDict 的 C 实现中的小错误。

bpo-25411 [https://bugs.python.org/issue?@action=redirect&bpo=25411]: 通过更好地使用 email 包，改进了 SMTPHandler 中的 Unicode 支持。感谢用户 simon04 的补丁。

bpo-25407 [https://bugs.python.org/issue?@action=redirect&bpo=25407]: 移除了关于 formatter 模块在 Python 3.6 中被移除的提及。

bpo-25406 [https://bugs.python.org/issue?@action=redirect&bpo=25406]: 修复了 OrderedDict.move_to_end() 的 C 实现中的一个错误，该错误导致在将几个项目移动到有序字典的开头后在迭代中出现分段错误或挂起。

bpo-25364 [https://bugs.python.org/issue?@action=redirect&bpo=25364]: zipfile 现在可以在禁用线程的构建中工作。

bpo-25328 [https://bugs.python.org/issue?@action=redirect&bpo=25328]: 如果 decode_data 和 enable_SMTPUTF8 都被设置为 true，smtpd 的 SMTPChannel 现在会正确地引发 ValueError。

bpo-25316 [https://bugs.python.org/issue?@action=redirect&bpo=25316]: 当未安装 MSVC 时，distutils 会引发 OSError 而不是 DistutilsPlatformError。

bpo-25380 [https://bugs.python.org/issue?@action=redirect&bpo=25380]: 修复了 pickletools.opcodes 中 STACK_GLOBAL 操作码的协议。

bpo-23972 [https://bugs.python.org/issue?@action=redirect&bpo=23972]: 更新了 asyncio 的数据报创建方法，允许在绑定套接字之前设置 reuseport 和 reuseaddr 套接字选项。与现有的 asyncio create_server 方法类似，如果操作系统是 'posix'（除非平台是 Cygwin），数据报套接字的 reuseaddr 选项默认为 True。由 Chris Laws 提供补丁。

bpo-25304 [https://bugs.python.org/issue?@action=redirect&bpo=25304]: 添加了 asyncio.run_coroutine_threadsafe()。这让你可以从另一个线程向循环提交一个协程，返回一个 concurrent.futures.Future。由 Vincent Michel 提供。

bpo-25232 [https://bugs.python.org/issue?@action=redirect&bpo=25232]: 修复 CGIRequestHandler，使其在第一个问号 (?) 处而不是最后一个问号处将查询与 URL 分开。补丁来自 Xiang Zhang。

bpo-24657 [https://bugs.python.org/issue?@action=redirect&bpo=24657]: 防止 CGIRequestHandler 像处理路径一样在 URL 的查询部分折叠斜杠。补丁来自 Xiang Zhang。

bpo-24483 [https://bugs.python.org/issue?@action=redirect&bpo=24483]: functools.lru_cache()的C实现现在只计算一次key的哈希。

bpo-22958 [https://bugs.python.org/issue?@action=redirect&bpo=22958]: weakref.WeakValueDictionary的构造函数和更新方法现在接受self和dict关键字参数。

bpo-22609 [https://bugs.python.org/issue?@action=redirect&bpo=22609]: collections.UserDict的构造函数现在接受self关键字参数。

bpo-25111 [https://bugs.python.org/issue?@action=redirect&bpo=25111]: 修复了traceback.FrameSummary的比较。

bpo-25262 [https://bugs.python.org/issue?@action=redirect&bpo=25262]: 在Python的解pickler实现中增加了对BINBYTES8操作码的支持。在C实现中，对于BINUNICODE8和BINBYTES8操作码的64位大小的高32位不再在32位平台上被静默忽略。

bpo-25034 [https://bugs.python.org/issue?@action=redirect&bpo=25034]: 修复了string.Formatter在自动编号和嵌套format_specs时的问题。由Anthon van der Neut提供补丁。

bpo-25233 [https://bugs.python.org/issue?@action=redirect&bpo=25233]: 重写了asyncio.Queue和asyncio.Semaphore的内部实现，使其更加易懂和正确。

bpo-25203 [https://bugs.python.org/issue?@action=redirect&bpo=25203]: 失败的 readline.set_completer_delims() 不再使模块处于不一致状态。

bpo-23600 [https://bugs.python.org/issue?@action=redirect&bpo=23600]: tzinfo.fromutc() 的默认实现在某些情况下返回了错误的结果。

bpo-23329 [https://bugs.python.org/issue?@action=redirect&bpo=23329]: 允许ssl模块与旧版本的LibreSSL一起构建。

防止_Unpickler_Read中的溢出。

bpo-25047 [https://bugs.python.org/issue?@action=redirect&bpo=25047]: Element Tree写入的XML编码声明现在尊重用户给出的大小写。这恢复了以大写形式写入编码名称（如“UTF-8”）的能力，这在Python 2中是可行的。

bpo-25135 [https://bugs.python.org/issue?@action=redirect&bpo=25135]: 通过在清除前清空deque来使deque_clear()更安全。这有助于避免可能的可重入性问题。

bpo-19143 [https://bugs.python.org/issue?@action=redirect&bpo=19143]: platform模块现在从kernel32.dll读取Windows版本以避免兼容性垫片。

bpo-25092 [https://bugs.python.org/issue?@action=redirect&bpo=25092]: 修复了当errno已经设置为EINVAL时datetime.strftime()失败的问题。

bpo-23517 [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)使用的舍入模式。

bpo-25155 [https://bugs.python.org/issue?@action=redirect&bpo=25155]: 修复了Windows上的datetime.datetime.now()和datetime.datetime.utcnow()以支持2038年之后的日期。这是在Python 3.5.0中引入的回归问题。

bpo-25108 [https://bugs.python.org/issue?@action=redirect&bpo=25108]: 在没有参数的情况下调用traceback函数print_stack()、format_stack()和extract_stack()时省略内部帧。

bpo-25118 [https://bugs.python.org/issue?@action=redirect&bpo=25118]: 修复了Python 3.5.0在Windows上os.waitpid()中的一个回归问题。

bpo-24684 [https://bugs.python.org/issue?@action=redirect&bpo=24684]: socket.socket.getaddrinfo() 现在调用 PyUnicode_AsEncodedString() 而不是调用主机的 encode() 方法，以正确处理具有不返回字节字符串的 encode() 方法的自定义字符串。现在直接调用 IDNA 编解码器的编码器，而不是调用字符串的 encode() 方法。

bpo-25060 [https://bugs.python.org/issue?@action=redirect&bpo=25060]: 正确计算 BUILD_MAP 操作码的堆栈使用情况。

bpo-24857 [https://bugs.python.org/issue?@action=redirect&bpo=24857]: 现在将 call_args 与长序列比较时正确返回布尔结果，而不是引发异常。由 A Kaptur 提供补丁。

bpo-23144 [https://bugs.python.org/issue?@action=redirect&bpo=23144]: 确保即使 convert_charrefs 为 True，HTMLParser.feed() 也能返回所有数据。

bpo-24982 [https://bugs.python.org/issue?@action=redirect&bpo=24982]: 使用 "zip" 格式的 shutil.make_archive() 现在在 ZIP 文件中为目录（包括空目录）添加条目。

bpo-25019 [https://bugs.python.org/issue?@action=redirect&bpo=25019]: 修复了由设置 expat 解析器的非字符串键引起的崩溃。基于 John Leitch 的补丁。

bpo-16180 [https://bugs.python.org/issue?@action=redirect&bpo=16180]: 如果文件有语法错误，退出 pdb，而不是将用户困在无限循环中。由 Xavier de Gaye 提供补丁。

bpo-24891 [https://bugs.python.org/issue?@action=redirect&bpo=24891]: 修复 Python 启动时如果标准输入（0）、标准输出（1）或标准错误（2）的文件描述符在 Python 创建 sys.stdin、sys.stdout 和 sys.stderr 对象时被关闭导致的竞态条件。如果对象创建失败，这些属性现在设置为 None，而不是引发 OSError 异常。初始补丁由 Marco Paolini 编写。

bpo-24992 [https://bugs.python.org/issue?@action=redirect&bpo=24992]: 修复 collections.OrderedDict 构造函数中的错误处理和与垃圾收集相关的竞态条件。

bpo-24881 [https://bugs.python.org/issue?@action=redirect&bpo=24881]: 在 Windows 和 Cygwin 上修复了 Python 实现的 FileIO 中设置二进制模式的问题。补丁来自 Akira Li。

bpo-25578 [https://bugs.python.org/issue?@action=redirect&bpo=25578]: 修复 SSLSocket.getpeercer() 中的另一个内存泄漏问题。

bpo-25530 [https://bugs.python.org/issue?@action=redirect&bpo=25530]: 默认情况下，在创建 ssl.SSLContext 时禁用易受攻击的 SSLv3 协议。

bpo-25569 [https://bugs.python.org/issue?@action=redirect&bpo=25569]: 修复 SSLSocket.getpeercert() 中的内存泄漏问题。

bpo-25471 [https://bugs.python.org/issue?@action=redirect&bpo=25471]: 从 accept() 返回的套接字不应显示为非阻塞。

bpo-25319 [https://bugs.python.org/issue?@action=redirect&bpo=25319]: 当 threading.Event 被重新初始化时，底层条件应使用常规锁而不是递归锁。

bpo-21112 [https://bugs.python.org/issue?@action=redirect&bpo=21112]: 修复 unittest.expectedFailure 在子类上的回归问题。补丁来自 Berker Peksag。

bpo-24764 [https://bugs.python.org/issue?@action=redirect&bpo=24764]: cgi.FieldStorage.read_multi() 现在忽略部分头中的 Content-Length 头。补丁由 Peter Landry 编写，Pierre Quentel 审阅。

bpo-24913 [https://bugs.python.org/issue?@action=redirect&bpo=24913]: 修复 deque.index() 中的溢出错误。由 John Leitch 和 Bryce Darling 发现。

bpo-24774 [https://bugs.python.org/issue?@action=redirect&bpo=24774]: 修复 http.server.test 中的文档字符串。补丁来自 Chiu-Hsiang Hsu。

bpo-21159 [https://bugs.python.org/issue?@action=redirect&bpo=21159]: 改进 configparser.InterpolationMissingOptionError 中的消息。补丁来自 Łukasz Langa。

bpo-20362 [https://bugs.python.org/issue?@action=redirect&bpo=20362]: 在 assertRegex 中正确遵循 TestCase.longMessage。补丁来自 Ilia Kurenkov。

bpo-23572 [https://bugs.python.org/issue?@action=redirect&bpo=23572]: Fixed functools.singledispatch on classes with falsy metaclasses. Patch by Ethan Furman.

asyncio: ensure_future() 现在接受可等待对象。

IDLE

bpo-15348 [https://bugs.python.org/issue?@action=redirect&bpo=15348]: 在关闭调试器窗口（在 IDLE 进程中运行）之前停止调试器引擎（通常在用户进程中）。这防止了被捕获并忽略的 RuntimeErrors。

bpo-24455 [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中，允许任何现有的交互首先终止。

在IDLE的'终止程序？'消息中，将'程序'改为'您的程序'，以更清楚地表明所指的是当前运行的用户程序，而不是IDLE本身。

bpo-24750 [https://bugs.python.org/issue?@action=redirect&bpo=24750]: 改善IDLE编辑器窗口状态栏的外观。Patch by Mark Roseman。

bpo-25313 [https://bugs.python.org/issue?@action=redirect&bpo=25313]: 更改新内置文本颜色主题的处理，以更好地解决由IDLE Dark的添加引入的兼容性问题。在idlelib中一致地使用修订后的idleConf.CurrentTheme。

bpo-24782 [https://bugs.python.org/issue?@action=redirect&bpo=24782]: 扩展配置现在是IDLE首选项对话框中的一个标签，而不是一个单独的对话框。原来的标签现在是一个排序列表。Patch by Mark Roseman。

bpo-22726 [https://bugs.python.org/issue?@action=redirect&bpo=22726]: 重新激活配置对话框帮助按钮，包含一些关于其他按钮和新IDLE Dark主题的内容。

bpo-24820 [https://bugs.python.org/issue?@action=redirect&bpo=24820]: IDLE现在有一个'IDLE Dark'内置文本颜色主题。它或多或少是IDLE Classic的反转，背景为钴蓝色。字符串、注释、关键字等仍然是绿色、红色、橙色等。要在2015年11月之前发布的IDLEs中使用它，点击'保存为新的自定义主题'按钮并输入一个新名称，如'Custom Dark'。自定义主题适用于任何IDLE版本，并且可以修改。

bpo-25224 [https://bugs.python.org/issue?@action=redirect&bpo=25224]: README.txt现在是IDLE开发者和好奇用户的idlelib索引。以前的用户内容现在在IDLE文档章节中。'IDLE'现在意味着'集成开发和学习环境'。

bpo-24820 [https://bugs.python.org/issue?@action=redirect&bpo=24820]: 用户现在可以在设置->自定义高亮中设置断点颜色。原始由Mark Roseman提供补丁。

bpo-24972 [https://bugs.python.org/issue?@action=redirect&bpo=24972]: 非活动选择背景现在在所有系统上都与用户配置的活动选择背景相匹配。在Windows上，找到的项目现在总是高亮显示。初始由Mark Roseman提供补丁。

bpo-24570 [https://bugs.python.org/issue?@action=redirect&bpo=24570]: Idle：在受tk回归影响的Mac上显示调用提示和完成框。初始补丁由Mark Roseman提供。

bpo-24988 [https://bugs.python.org/issue?@action=redirect&bpo=24988]: Idle ScrolledList上下文菜单（在调试器中使用）现在在Mac Aqua上工作。由Mark Roseman提供补丁。

bpo-24801 [https://bugs.python.org/issue?@action=redirect&bpo=24801]: 使右键点击上下文菜单在Mac Aqua上工作。由Mark Roseman提供补丁。

bpo-25173 [https://bugs.python.org/issue?@action=redirect&bpo=25173]: 将tkinter消息框与特定小部件关联。对于Mac OSX，使它们成为'表单'。由Mark Roseman提供补丁。

bpo-25198 [https://bugs.python.org/issue?@action=redirect&bpo=25198]: 增强现在用于Idle Help的初始html查看器。正确缩进固定间距文本（由Mark Roseman提供补丁）。给代码片段一个非常类似Sphinx的浅蓝灰色背景。重用用户为shell和编辑器设置的初始宽度和高度。当使用目录（TOC）菜单时，将部分标题放在屏幕顶部。

bpo-25225 [https://bugs.python.org/issue?@action=redirect&bpo=25225]: 压缩并重写Idle文档中关于文本颜色的部分。

bpo-21995 [https://bugs.python.org/issue?@action=redirect&bpo=21995]: 解释IDLE和控制台Python之间的一些差异。

bpo-22820 [https://bugs.python.org/issue?@action=redirect&bpo=22820]: 解释在从Idle编辑器运行文件时需要 print 的原因。

bpo-25224 [https://bugs.python.org/issue?@action=redirect&bpo=25224]: 文档：增加Idle功能列表和无子进程部分。

bpo-25219 [https://bugs.python.org/issue?@action=redirect&bpo=25219]: 更新Idle命令行选项的文档。有些选项缺失，注释也不正确。

bpo-24861 [https://bugs.python.org/issue?@action=redirect&bpo=24861]: 大多数idlelib是私有的，可能会更改。使用idleib.idle.*来启动Idle。参见idlelib.__init__.__doc__。

bpo-25199 [https://bugs.python.org/issue?@action=redirect&bpo=25199]: Idle：为未来的维护者添加同步注释。

bpo-16893 [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 文件已被弃用。

bpo-24199 [https://bugs.python.org/issue?@action=redirect&bpo=24199]: 弃用未使用的 idlelib.idlever，可能在 3.6 中移除。

bpo-24790 [https://bugs.python.org/issue?@action=redirect&bpo=24790]: 移除多余的代码（这也造成了 2 和 3 的冲突）。

文档

bpo-22558 [https://bugs.python.org/issue?@action=redirect&bpo=22558]: 将剩余的文档链接添加到Python编码模块的源代码中。由Yoni Lavi提供补丁。

bpo-12067 [https://bugs.python.org/issue?@action=redirect&bpo=12067]: 重写语言参考中表达式章节的比较部分。一些关于比较混合类型的细节不正确或含糊。NotImplemented 仅在比表达式章节更低的层次相关。增加了比较 range() 对象的细节，以及用户定义类的默认行为和一致性建议。补丁来自 Andy Maier。

bpo-24952 [https://bugs.python.org/issue?@action=redirect&bpo=24952]: 阐明 "threading" 和 "_thread" 模块中 stack_size() 的默认 size 参数。来自 Mattip 的补丁。

bpo-23725 [https://bugs.python.org/issue?@action=redirect&bpo=23725]: 彻底修改 tempfile 文档。注意 mktemp 的弃用状态。补丁来自 Zbigniew Jędrzejewski-Szmek。

bpo-24808 [https://bugs.python.org/issue?@action=redirect&bpo=24808]: 更新一些 PyTypeObject 字段的类型。补丁来自 Joseph Weston。

bpo-22812 [https://bugs.python.org/issue?@action=redirect&bpo=22812]: 修复 unittest 发现示例。补丁来自 Pam McA'Nulty。

测试

bpo-25449 [https://bugs.python.org/issue?@action=redirect&bpo=25449]: 为 OrderedDict 的子类添加了测试。

bpo-25099 [https://bugs.python.org/issue?@action=redirect&bpo=25099]: 使 test_compileall 在无法写入 sys.path 上的条目时不失败（在 Windows 的管理安装中常见）。

bpo-23919 [https://bugs.python.org/issue?@action=redirect&bpo=23919]: 防止测试套件中出现断言对话框。

PCbuild\rt.bat 现在可以接受无限数量的参数传递给regrtest.py。之前有9个的限制。

构建

bpo-24915 [https://bugs.python.org/issue?@action=redirect&bpo=24915]: 为 PGO 构建添加 LLVM 支持，并使用测试套件生成配置文件数据。初始补丁来自 Intel 的 Alecsandru Patrascu。

bpo-24910 [https://bugs.python.org/issue?@action=redirect&bpo=24910]: Windows MSI 现在具有唯一的显示名称。

bpo-24986 [https://bugs.python.org/issue?@action=redirect&bpo=24986]: 现在可以在 Windows 上构建 Python 而不会在没有外部库的情况下出现错误。

Windows

bpo-25450 [https://bugs.python.org/issue?@action=redirect&bpo=25450]: 更新快捷方式以在安装目录中启动 Python。

bpo-25164 [https://bugs.python.org/issue?@action=redirect&bpo=25164]: 将默认所有用户安装目录更改为与每用户目录匹配。

bpo-25143 [https://bugs.python.org/issue?@action=redirect&bpo=25143]: 改进了对不支持平台的安装程序错误消息。

bpo-25163 [https://bugs.python.org/issue?@action=redirect&bpo=25163]: 在使用非默认设置时，在安装程序中显示正确的目录。

bpo-25361 [https://bugs.python.org/issue?@action=redirect&bpo=25361]: 在Windows 32位构建中禁用SSE2指令的使用。

bpo-25089 [https://bugs.python.org/issue?@action=redirect&bpo=25089]: 在升级时未选择启动器的情况下，为安装程序添加日志记录。

bpo-25165 [https://bugs.python.org/issue?@action=redirect&bpo=25165]: 如果其他版本仍存在，Windows卸载不应移除启动器。

bpo-25112 [https://bugs.python.org/issue?@action=redirect&bpo=25112]: py.exe启动器缺少图标。

bpo-25102 [https://bugs.python.org/issue?@action=redirect&bpo=25102]: Windows安装程序未预编译-O或-OO。

bpo-25081 [https://bugs.python.org/issue?@action=redirect&bpo=25081]: 在升级时，使安装程序中的返回按钮返回到升级页面。

bpo-25091 [https://bugs.python.org/issue?@action=redirect&bpo=25091]: 增加安装程序的字体大小。

bpo-25126 [https://bugs.python.org/issue?@action=redirect&bpo=25126]: 澄清非Web安装程序将下载一些组件。

bpo-25213 [https://bugs.python.org/issue?@action=redirect&bpo=25213]: 恢复manifest中的requestedExecutionLevel以禁用UAC虚拟化。

bpo-25022 [https://bugs.python.org/issue?@action=redirect&bpo=25022]: 删除了非常过时的 PC/example_nt/ 目录。

工具/示例

bpo-25440 [https://bugs.python.org/issue?@action=redirect&bpo=25440]: 修复python-config --extension-suffix的输出。

Python 3.5.0 正式版

发布日期: 2015-09-13

构建

bpo-25071 [https://bugs.python.org/issue?@action=redirect&bpo=25071]: Windows安装程序在静默安装时不应需要TargetDir参数。

Python 3.5.0 rc4

发布日期: 2015-09-09

库

bpo-25029 [https://bugs.python.org/issue?@action=redirect&bpo=25029]: 修复test_strptime中的MemoryError。

构建

bpo-25027 [https://bugs.python.org/issue?@action=redirect&bpo=25027]: 恢复部分静态构建选项并将vcruntime140.dll添加到Windows安装中。

Python 3.5.0 rc3

发布日期: 2015-09-07

核心与内置函数

bpo-24305 [https://bugs.python.org/issue?@action=redirect&bpo=24305]: 防止导入子系统堆栈帧被warnings.warn(stacklevel=)参数计数。

bpo-24912 [https://bugs.python.org/issue?@action=redirect&bpo=24912]: 防止__class__赋值给不可变的内置对象。

bpo-24975 [https://bugs.python.org/issue?@action=redirect&bpo=24975]: 修复AST编译为 PEP 448 [https://www.python.org/dev/peps/pep-0448] 语法。

库

bpo-24917 [https://bugs.python.org/issue?@action=redirect&bpo=24917]: time_strftime()缓冲区过度读取。

bpo-24748 [https://bugs.python.org/issue?@action=redirect&bpo=24748]: 为了解决与py2exe和pywin32发现的兼容性问题，imp.load_dynamic()再次忽略先前加载的模块，以支持Python模块用扩展模块替换自己。由Petr Viktorin提供补丁。

bpo-24635 [https://bugs.python.org/issue?@action=redirect&bpo=24635]: 修复了typing.py中的一个错误，其中isinstance([], typing.Iterable)会返回一次True，然后在后续调用中返回False。

bpo-24989 [https://bugs.python.org/issue?@action=redirect&bpo=24989]: 如果设置的位置超出大小，修复BytesIO.readline()中的缓冲区过度读取。基于John Leitch的补丁。

bpo-24913 [https://bugs.python.org/issue?@action=redirect&bpo=24913]: 修复 deque.index() 中的溢出错误。由 John Leitch 和 Bryce Darling 发现。

Python 3.5.0 rc2

发布日期: 2015-08-25

核心与内置函数

bpo-24769 [https://bugs.python.org/issue?@action=redirect&bpo=24769]: 当动态加载被禁用时，解释器现在可以正常启动。由Petr Viktorin提供补丁。

bpo-21167 [https://bugs.python.org/issue?@action=redirect&bpo=21167]: 现在即使没有指定-fp-model strict，当Python用ICC编译时，NAN操作也能被正确处理。

bpo-24492 [https://bugs.python.org/issue?@action=redirect&bpo=24492]: 当尝试执行 from .. import ... 语句时，缺少__name__属性的“package”将触发ImportError而不是AttributeError。

库

bpo-24847 [https://bugs.python.org/issue?@action=redirect&bpo=24847]: 从Tcl/Tk中移除了vcruntime140.dll依赖。

bpo-24839 [https://bugs.python.org/issue?@action=redirect&bpo=24839]: platform._syscmd_ver现在会引发DeprecationWarning

bpo-24867 [https://bugs.python.org/issue?@action=redirect&bpo=24867]: 修复了'async def'协程的Task.get_stack()

Python 3.5.0 rc1

发布日期: 2015-08-09

核心与内置函数

bpo-24667 [https://bugs.python.org/issue?@action=redirect&bpo=24667]: 在所有底层字典调整大小的情况下调整odict的大小。

库

bpo-24824 [https://bugs.python.org/issue?@action=redirect&bpo=24824]: codecs.encode()和codecs.decode()的签名现在与pydoc兼容。

bpo-24634 [https://bugs.python.org/issue?@action=redirect&bpo=24634]: 在Windows上导入uuid不应该尝试加载libc

bpo-24798 [https://bugs.python.org/issue?@action=redirect&bpo=24798]: _msvccompiler.py没有正确支持清单

bpo-4395 [https://bugs.python.org/issue?@action=redirect&bpo=4395]: 更好的二进制运算符测试和文档。由Martin Panter提供补丁。

bpo-23973 [https://bugs.python.org/issue?@action=redirect&bpo=23973]: 从GitHub仓库更新typing.py。

bpo-23004 [https://bugs.python.org/issue?@action=redirect&bpo=23004]: mock_open()现在当read_data的类型是bytes时能正确读取二进制数据。初始由Aaron Hill提供补丁。

bpo-23888 [https://bugs.python.org/issue?@action=redirect&bpo=23888]: 处理cookie过期时间中的小数时间。由ssh提供补丁。

bpo-23652 [https://bugs.python.org/issue?@action=redirect&bpo=23652]: 使得可以针对Linux标准基础的libc头文件编译select模块，这些头文件不包含一些EPOLL宏。由Matt Frank提供补丁。

bpo-22932 [https://bugs.python.org/issue?@action=redirect&bpo=22932]: 修复email.utils.formatdate中的时区问题。补丁来自Dmitry Shachnev。

bpo-23779 [https://bugs.python.org/issue?@action=redirect&bpo=23779]: 如果认证器尝试中止，imaplib会引发TypeError。补丁来自Craig Holmquist。

bpo-23319 [https://bugs.python.org/issue?@action=redirect&bpo=23319]: 修复ctypes.BigEndianStructure，正确交换字节。补丁由Matthieu Gautier编写。

bpo-23254 [https://bugs.python.org/issue?@action=redirect&bpo=23254]: 记录如何关闭TCPServer监听套接字。补丁来自Martin Panter。

bpo-19450 [https://bugs.python.org/issue?@action=redirect&bpo=19450]: 更新Windows和OS X安装程序构建以使用SQLite 3.8.11。

bpo-17527 [https://bugs.python.org/issue?@action=redirect&bpo=17527]: 向wsgiref.validator添加PATCH。补丁来自Luca Sbardella。

bpo-24791 [https://bugs.python.org/issue?@action=redirect&bpo=24791]: 修复调用语法 'g(*a or b)' 的语法回归问题。

IDLE

bpo-23672 [https://bugs.python.org/issue?@action=redirect&bpo=23672]: 允许Idle编辑和运行名称中包含星体字符的文件。由Mohd Sanad Zaki Rizvi提供补丁。

bpo-24745 [https://bugs.python.org/issue?@action=redirect&bpo=24745]: Idle editor default font. Switch from Courier to platform-sensitive TkFixedFont. This should not affect current customized font selections. If there is a problem, edit $HOME/.idlerc/config-main.cfg and remove 'fontxxx' entries from [Editor Window]. Patch by Mark Roseman.

bpo-21192 [https://bugs.python.org/issue?@action=redirect&bpo=21192]: Idle编辑器。当运行文件时，将其名称放入重启栏。不打印虚假提示。原始由Adnan Umer提供补丁。

bpo-13884 [https://bugs.python.org/issue?@action=redirect&bpo=13884]: Idle菜单。移除撕裂线。由Roger Serwy提供补丁。

文档

bpo-24129 [https://bugs.python.org/issue?@action=redirect&bpo=24129]: 明确名称解析的参考文档。这包括移除读者会熟悉Python在引入函数命名空间的词法作用域之前使用的名称解析方案的假设。由Ivan Levkivskyi提供补丁。

bpo-20769 [https://bugs.python.org/issue?@action=redirect&bpo=20769]: 改进reload()文档。由Dorian Pula提供补丁。

bpo-23589 [https://bugs.python.org/issue?@action=redirect&bpo=23589]: 从FAQ中移除重复句子。由Yongzhi Pan提供补丁。

bpo-24729 [https://bugs.python.org/issue?@action=redirect&bpo=24729]: 更正IO教程以匹配关于open函数编码参数的实现。

测试

bpo-24751 [https://bugs.python.org/issue?@action=redirect&bpo=24751]: 当使用 -w 命令行选项运行regrtest时，如果所有测试在重新运行时成功，则不再将测试运行标记为失败。

Python 3.5.0 beta 4

发布日期: 2015-07-26

核心与内置函数

bpo-23573 [https://bugs.python.org/issue?@action=redirect&bpo=23573]: 在Linux上恢复了bytes.rfind()和bytearray.rfind()对单字节参数的优化。

bpo-24569 [https://bugs.python.org/issue?@action=redirect&bpo=24569]: 使 PEP 448 [https://www.python.org/dev/peps/pep-0448] 字典评估更加一致。

bpo-24583 [https://bugs.python.org/issue?@action=redirect&bpo=24583]: 修复集合在被更新时发生突变导致的崩溃。

bpo-24407 [https://bugs.python.org/issue?@action=redirect&bpo=24407]: 修复字典在被更新时发生突变导致的崩溃。

bpo-24619 [https://bugs.python.org/issue?@action=redirect&bpo=24619]: 新的异步/等待标记化方法。因此，现在可以有一行的'async def foo(): await ..'函数。

bpo-24687 [https://bugs.python.org/issue?@action=redirect&bpo=24687]: 修复函数参数注释中SyntaxError的反射泄漏。

bpo-15944 [https://bugs.python.org/issue?@action=redirect&bpo=15944]: memoryview：在转换为字节时允许任意格式。由Martin Panter提供补丁。

库

bpo-23441 [https://bugs.python.org/issue?@action=redirect&bpo=23441]: rcompleter现在打印一个制表符而不是显示空字的可能完成项。初始由Martin Sekera提供补丁。

bpo-24683 [https://bugs.python.org/issue?@action=redirect&bpo=24683]: 修复了使用不适当类型的参数调用_json函数时的崩溃问题。

bpo-21697 [https://bugs.python.org/issue?@action=redirect&bpo=21697]: shutil.copytree()现在正确处理指向目录的符号链接。由Eduardo Seabra和Thomas Kluyver提供补丁。

bpo-14373 [https://bugs.python.org/issue?@action=redirect&bpo=14373]: 修复了在构建lru_cache（C实现）期间调用gc.collect()时出现的段错误。

bpo-24695 [https://bugs.python.org/issue?@action=redirect&bpo=24695]: 修复了traceback.print_exception()中的一个回归问题。如果exc_traceback为None，我们不应该像文档中描述的那样打印回溯头。

bpo-24620 [https://bugs.python.org/issue?@action=redirect&bpo=24620]: Random.setstate()现在验证state最后一个元素的值。

bpo-22485 [https://bugs.python.org/issue?@action=redirect&bpo=22485]: Fixed an issue that caused inspect.getsource to return incorrect results on nested functions.

bpo-22153 [https://bugs.python.org/issue?@action=redirect&bpo=22153]: 改进unittest文档。补丁来自Martin Panter和evilzero。

bpo-24580 [https://bugs.python.org/issue?@action=redirect&bpo=24580]: 在re模式中，现在明确禁止对开放组的符号组引用以及数字组引用。

bpo-24206 [https://bugs.python.org/issue?@action=redirect&bpo=24206]: 修复了inspect类的__eq__和__ne__方法。

bpo-24631 [https://bugs.python.org/issue?@action=redirect&bpo=24631]: 修复了timeit模块中多行设置的回归问题。

bpo-18622 [https://bugs.python.org/issue?@action=redirect&bpo=18622]: unittest.mock.mock_open().reset_mock 会无限递归。补丁来自 Nicola Palumbo 和 Laurent De Buyst。

bpo-23661 [https://bugs.python.org/issue?@action=redirect&bpo=23661]: unittest.mock 的 side_effects 现在可以再次是异常。这是对 Python 3.4 的一个回归。补丁来自 Ignacio Rossi

bpo-24608 [https://bugs.python.org/issue?@action=redirect&bpo=24608]: chunk.Chunk.read()现在总是返回字节，而不是str。

bpo-18684 [https://bugs.python.org/issue?@action=redirect&bpo=18684]: 修复了re模块中读取缓冲区的问题。

bpo-24259 [https://bugs.python.org/issue?@action=redirect&bpo=24259]: 如果存档在数据段内被截断，tarfile现在会引发ReadError。

bpo-15014 [https://bugs.python.org/issue?@action=redirect&bpo=15014]: SMTP.auth()和SMTP.login()现在支持RFC 4954中SMTP AUTH命令的可选初始响应参数。

bpo-24669 [https://bugs.python.org/issue?@action=redirect&bpo=24669]: 修复inspect.getsource()对于'async def'函数的问题。由Kai Groner提供补丁。

bpo-24688 [https://bugs.python.org/issue?@action=redirect&bpo=24688]: ast.get_docstring()对于'async def'函数。

构建

bpo-24603 [https://bugs.python.org/issue?@action=redirect&bpo=24603]: 更新Windows构建和OS X 10.5安装程序以使用OpenSSL 1.0.2d。

Python 3.5.0 beta 3

发布日期: 2015-07-05

核心与内置函数

bpo-24467 [https://bugs.python.org/issue?@action=redirect&bpo=24467]: 修复了 bytearray 中可能的缓冲区越界读取问题。bytearray 对象现在总是为尾随的空字节分配空间，其缓冲区现在总是以空字符结尾。

升级到 Unicode 8.0.0。

bpo-24345 [https://bugs.python.org/issue?@action=redirect&bpo=24345]: 为稳定 ABI 添加 Py_tp_finalize 插槽。

bpo-24400 [https://bugs.python.org/issue?@action=redirect&bpo=24400]: 为 PEP 492 [https://www.python.org/dev/peps/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 代替。

bpo-24450 [https://bugs.python.org/issue?@action=redirect&bpo=24450]: 向生成器添加 gi_yieldfrom 和向协程添加 cr_await。由 Benno Leslie 和 Yury Selivanov 贡献。

bpo-19235 [https://bugs.python.org/issue?@action=redirect&bpo=19235]: 添加新的 RecursionError 异常。由 Georg Brandl 提供补丁。

库

bpo-21750 [https://bugs.python.org/issue?@action=redirect&bpo=21750]: mock_open.read_data 现在可以从每个实例中读取，就像在 Python 3.3 中一样。

bpo-24552 [https://bugs.python.org/issue?@action=redirect&bpo=24552]: 修复 _pickle 模块在错误情况下的释放后使用问题。

bpo-24514 [https://bugs.python.org/issue?@action=redirect&bpo=24514]: tarfile 现在容忍仅由空白组成的数字字段。

bpo-19176 [https://bugs.python.org/issue?@action=redirect&bpo=19176]: 修复了 ElementTree 的 C 实现中与 doctype() 相关的错误。XMLParser 子类不再发出带有默认 doctype() 方法的弃用警告。直接调用 doctype() 现在会发出警告。如果目标的 doctype() 被调用，解析器的 doctype() 现在不会被调用。基于 Martin Panter 的补丁。

bpo-20387 [https://bugs.python.org/issue?@action=redirect&bpo=20387]: 在 tab 缩进的块中恢复 tokenize/untokenize 的语义往返正确性。

bpo-24456 [https://bugs.python.org/issue?@action=redirect&bpo=24456]: 修复了 audioop 模块的 adpcm2lin() 和 lin2adpcm() 函数中可能的缓冲区越界读取问题。

bpo-24336 [https://bugs.python.org/issue?@action=redirect&bpo=24336]: contextmanager装饰器现在可以与名为"func"和"self"的关键字参数的函数一起工作。由Martin Panter提供补丁。

bpo-24522 [https://bugs.python.org/issue?@action=redirect&bpo=24522]: 修复json加速模块中可能的整数溢出问题。

bpo-24489 [https://bugs.python.org/issue?@action=redirect&bpo=24489]: 确保先前设置的C errno不会干扰cmath.polar()。

bpo-24408 [https://bugs.python.org/issue?@action=redirect&bpo=24408]: 修复了tkinter.Font的measure()和metrics()方法中的AttributeError。

bpo-14373 [https://bugs.python.org/issue?@action=redirect&bpo=14373]: functools.lru_cache()的C实现现在可以与方法一起使用。

bpo-24347 [https://bugs.python.org/issue?@action=redirect&bpo=24347]: 如果PyDict_GetItemWithError返回NULL，则设置KeyError。

bpo-24348 [https://bugs.python.org/issue?@action=redirect&bpo=24348]: 删除多余的incref/decref。

bpo-24359 [https://bugs.python.org/issue?@action=redirect&bpo=24359]: 在迭代期间检查OrderedDict大小的变化。

bpo-24368 [https://bugs.python.org/issue?@action=redirect&bpo=24368]: 支持OrderedDict方法中的关键字参数。

bpo-24362 [https://bugs.python.org/issue?@action=redirect&bpo=24362]: 简化C OrderedDict快速节点调整大小的逻辑。

bpo-24377 [https://bugs.python.org/issue?@action=redirect&bpo=24377]: 修复OrderedDict.__repr__中的引用泄漏。

bpo-24369 [https://bugs.python.org/issue?@action=redirect&bpo=24369]: 防御迭代期间的键变更。

测试

bpo-24373 [https://bugs.python.org/issue?@action=redirect&bpo=24373]: _testmultiphase和xxlimited现在使用tp_traverse和tp_finalize来避免当tp_dealloc与PyType_FromSpec结合时遇到的引用泄漏（详情见 bpo-16690 [https://bugs.python.org/issue?@action=redirect&bpo=16690]）。

文档

bpo-24458 [https://bugs.python.org/issue?@action=redirect&bpo=24458]: 更新文档以涵盖扩展模块的多阶段初始化（PEP 489）。由Petr Viktorin提供补丁。

bpo-24351 [https://bugs.python.org/issue?@action=redirect&bpo=24351]: 澄清在string.Template实例上下文中“标识符”的含义。

构建

bpo-24432 [https://bugs.python.org/issue?@action=redirect&bpo=24432]: 更新Windows构建和OS X 10.5安装程序以使用OpenSSL 1.0.2c。

Python 3.5.0 beta 2

发布日期: 2015-05-31

核心与内置函数

bpo-24284 [https://bugs.python.org/issue?@action=redirect&bpo=24284]: str类的startswith和endswith方法在找到空字符串且索引完全超出范围时不再返回True。

bpo-24115 [https://bugs.python.org/issue?@action=redirect&bpo=24115]: 更新PyObject_IsTrue()、PyObject_Not()、PyObject_IsInstance()、PyObject_RichCompareBool()和_PyDict_Contains()的使用，以正确检查和处错误。

bpo-24328 [https://bugs.python.org/issue?@action=redirect&bpo=24328]: 修复导入单字符扩展模块的问题。

bpo-11205 [https://bugs.python.org/issue?@action=redirect&bpo=11205]: 在字典显示中，先评估键再评估值。

bpo-24285 [https://bugs.python.org/issue?@action=redirect&bpo=24285]: 修复了阻止从包内导入扩展模块的回归问题。由Petr Viktorin提供补丁。

库

bpo-23247 [https://bugs.python.org/issue?@action=redirect&bpo=23247]: 修复了CJK编解码器中StreamWriter.reset()的崩溃问题。

bpo-24270 [https://bugs.python.org/issue?@action=redirect&bpo=24270]: 根据 PEP 485 [https://www.python.org/dev/peps/pep-0485] 添加了math.isclose()和cmath.isclose()函数。由Chris Barker和Tal Einat贡献。

bpo-5633 [https://bugs.python.org/issue?@action=redirect&bpo=5633]: 修复了当语句是字符串而设置不是时的timeit问题。

bpo-24326 [https://bugs.python.org/issue?@action=redirect&bpo=24326]: 修复了audioop.ratecv()使用非默认weightB参数的问题。原始补丁由David Moore提供。

bpo-16991 [https://bugs.python.org/issue?@action=redirect&bpo=16991]: 添加了OrderedDict的C实现。

bpo-23934 [https://bugs.python.org/issue?@action=redirect&bpo=23934]: 修复inspect.signature以正确失败于缺乏签名信息的内置类型。初始由James Powell提供补丁。

Python 3.5.0 beta 1

发布日期: 2015-05-24

核心与内置函数

bpo-24276 [https://bugs.python.org/issue?@action=redirect&bpo=24276]: 修复了属性描述符getter的优化。

bpo-24268 [https://bugs.python.org/issue?@action=redirect&bpo=24268]: PEP 489: 多阶段扩展模块初始化。由Petr Viktorin提供补丁。

bpo-23955 [https://bugs.python.org/issue?@action=redirect&bpo=23955]: 添加pyvenv.cfg选项以抑制在Windows上生成sys.path时的注册表/环境查找。

bpo-24257 [https://bugs.python.org/issue?@action=redirect&bpo=24257]: 修复了伪造的types.SimpleNamespace比较中的系统错误。

bpo-22939 [https://bugs.python.org/issue?@action=redirect&bpo=22939]: 修复了迭代器对象中的整数溢出问题。由Clement Rouault提供补丁。

bpo-23985 [https://bugs.python.org/issue?@action=redirect&bpo=23985]: 修复了从bytearray前端删除一个切片后追加其他字节数据时可能发生的缓冲区溢出问题。

bpo-24102 [https://bugs.python.org/issue?@action=redirect&bpo=24102]: 修复了标准错误处理程序中的异常类型检查。

bpo-15027 [https://bugs.python.org/issue?@action=redirect&bpo=15027]: UTF-32编码器现在快3到7倍。

bpo-23290 [https://bugs.python.org/issue?@action=redirect&bpo=23290]: 为目标为空的情况优化了set_merge()。（由Serhiy Storchaka贡献。）

bpo-2292 [https://bugs.python.org/issue?@action=redirect&bpo=2292]: PEP 448: 额外的解包泛化。

bpo-24096 [https://bugs.python.org/issue?@action=redirect&bpo=24096]: 使warnings.warn_explicit对warnings.filters列表的突变更加健壮。

bpo-23996 [https://bugs.python.org/issue?@action=redirect&bpo=23996]: 避免当委托的生成器引发未标准化的StopIteration异常时崩溃。由Stefan Behnel提供补丁。

bpo-23910 [https://bugs.python.org/issue?@action=redirect&bpo=23910]: 优化property() getter调用。由Joe Jevnik提供补丁。

bpo-23911 [https://bugs.python.org/issue?@action=redirect&bpo=23911]: 将基于路径的importlib引导代码移动到一个单独的冻结模块。

bpo-24192 [https://bugs.python.org/issue?@action=redirect&bpo=24192]: 修复命名空间包的导入问题。

bpo-24022 [https://bugs.python.org/issue?@action=redirect&bpo=24022]: 修复处理不可解码源代码时标记器的崩溃问题。

bpo-9951 [https://bugs.python.org/issue?@action=redirect&bpo=9951]: 为bytes、bytearray和memoryview添加了hex()方法。

bpo-22906 [https://bugs.python.org/issue?@action=redirect&bpo=22906]: PEP 479: 改变生成器内部StopIteration的处理方式。

bpo-24017 [https://bugs.python.org/issue?@action=redirect&bpo=24017]: PEP 492: 使用async和await语法实现协程。

库

bpo-14373 [https://bugs.python.org/issue?@action=redirect&bpo=14373]: 添加了functools.lru_cache()的C实现。基于Matt Joiner和Alexey Kachayev的补丁。

bpo-24230 [https://bugs.python.org/issue?@action=redirect&bpo=24230]: tempfile模块现在接受prefix、suffix和dir参数的bytes类型，并在这种情况下返回bytes（与os模块的API相匹配）。

bpo-22189 [https://bugs.python.org/issue?@action=redirect&bpo=22189]: collections.UserString现在支持__getnewargs__()、__rmod__()、casefold()、format_map()、isprintable()和maketrans()。由Joe Jevnik提供补丁。

bpo-24244 [https://bugs.python.org/issue?@action=redirect&bpo=24244]: 防止在Windows上遇到无效格式字符串时strftime终止。

bpo-23973 [https://bugs.python.org/issue?@action=redirect&bpo=23973]: PEP 484: 添加typing模块。

bpo-23086 [https://bugs.python.org/issue?@action=redirect&bpo=23086]: collections.abc.Sequence()抽象基类为index()混入添加了 start 和 stop 参数。由Devin Jeanpierre提供补丁。

bpo-20035 [https://bugs.python.org/issue?@action=redirect&bpo=20035]: 将用于在Windows上设置Tcl/Tk环境的 tkinter._fix 模块替换为 _tkinter 模块中的私有函数，该函数不会对环境进行永久性更改。

bpo-24257 [https://bugs.python.org/issue?@action=redirect&bpo=24257]: 修复了使用伪造游标类型时sqlite3.Row构造函数中的段错误。

bpo-15836 [https://bugs.python.org/issue?@action=redirect&bpo=15836]: assertRaises()、assertRaisesRegex()、assertWarns()和assertWarnsRegex()断言现在检查第一个参数的类型以防止可能的用户错误。基于Daniel Wagner-Hall的补丁。

bpo-9858 [https://bugs.python.org/issue?@action=redirect&bpo=9858]: 为_io.RawIOBase添加缺失的方法存根。由Laura Rupprecht提供补丁。

bpo-22955 [https://bugs.python.org/issue?@action=redirect&bpo=22955]: operator模块中的attrgetter、itemgetter和methodcaller对象现在支持pickle。为这些对象添加了可读和可评估的repr。基于Josh Rosenberg的补丁。

bpo-22107 [https://bugs.python.org/issue?@action=redirect&bpo=22107]: tempfile.gettempdir() 和 tempfile.mkdtemp() 现在在 Windows 和 Unix 上都会在所选名称的目录已存在时重试。tempfile.mkstemp() 现在在 Windows 上如果父目录无效（不存在或是文件）时会提前失败。

bpo-23780 [https://bugs.python.org/issue?@action=redirect&bpo=23780]: 改进了 os.path.join() 在单个参数时的错误信息。

bpo-6598 [https://bugs.python.org/issue?@action=redirect&bpo=6598]: 提高了 email.utils.make_msgid() 中的时间精度和随机数范围，以增强消息 ID 的唯一性。

bpo-24091 [https://bugs.python.org/issue?@action=redirect&bpo=24091]: 修复了 ElementTree 的 C 实现中各种角落情况的崩溃问题。

bpo-21931 [https://bugs.python.org/issue?@action=redirect&bpo=21931]: msilib.FCICreate() 现在在参数错误的情况下会引发 TypeError 而不是带有虚假 FCI 错误号的 ValueError。由 Jeffrey Armstrong 提供补丁。

bpo-13866 [https://bugs.python.org/issue?@action=redirect&bpo=13866]: 为 urllib.parse.urlencode 添加了 quote_via 参数。

bpo-20098 [https://bugs.python.org/issue?@action=redirect&bpo=20098]: 为 email 添加了新的 mangle_from 策略选项，对于 compat32 默认为 True，但对于所有其他策略默认为 False。

bpo-24211 [https://bugs.python.org/issue?@action=redirect&bpo=24211]: email 库现在支持 RFC 6532：它可以生成使用 utf-8 而不是编码单词的头部。

bpo-16314 [https://bugs.python.org/issue?@action=redirect&bpo=16314]: 在 distutils 中添加了对 LZMA 压缩的支持。

bpo-21804 [https://bugs.python.org/issue?@action=redirect&bpo=21804]: poplib 现在支持 RFC 6856 (UTF8)。

bpo-18682 [https://bugs.python.org/issue?@action=redirect&bpo=18682]: 优化了内置标量类型的 pprint 函数。

bpo-22027 [https://bugs.python.org/issue?@action=redirect&bpo=22027]: smtplib 现在支持 RFC 6531 (SMTPUTF8)。

bpo-23488 [https://bugs.python.org/issue?@action=redirect&bpo=23488]: 随机生成器对象现在在 64 位系统上消耗的内存减少了一半。

bpo-1322 [https://bugs.python.org/issue?@action=redirect&bpo=1322]: platform.dist() 和 platform.linux_distribution() 函数现在已被弃用。初始补丁由 Vajrasky Kok 提供。

bpo-22486 [https://bugs.python.org/issue?@action=redirect&bpo=22486]: 添加了 math.gcd() 函数。fractions.gcd() 函数现在已被弃用。基于 Mark Dickinson 的补丁。

bpo-24064 [https://bugs.python.org/issue?@action=redirect&bpo=24064]: Property() 的文档字符串现在可写。（由 Berker Peksag 提供补丁。）

bpo-22681 [https://bugs.python.org/issue?@action=redirect&bpo=22681]: 添加了对 koi8_t 编码的支持。

bpo-22682 [https://bugs.python.org/issue?@action=redirect&bpo=22682]: 添加了对 kz1048 编码的支持。

bpo-23796 [https://bugs.python.org/issue?@action=redirect&bpo=23796]: BufferedReader 的 peek 和 read1 方法现在在对象已关闭时调用会引发 ValueError。由 John Hergenroeder 提供补丁。

bpo-21795 [https://bugs.python.org/issue?@action=redirect&bpo=21795]: 当新的 decode_data 构造函数参数设置为 False 时，smtpd 现在支持 8BITMIME 扩展。

bpo-24155 [https://bugs.python.org/issue?@action=redirect&bpo=24155]: 优化 heapq.heapify() 以提高在堆化大型列表时的缓存性能。

bpo-21800 [https://bugs.python.org/issue?@action=redirect&bpo=21800]: imaplib 现在支持 RFC 5161（启用）、RFC 6855（utf8/国际化邮件）并自动将非 ASCII 用户名和密码编码为 UTF8。

bpo-20274 [https://bugs.python.org/issue?@action=redirect&bpo=20274]: 当调用 _sqlite.Connection 时，如果传递了任何关键字参数，现在会报错。之前是默默地忽略它们。

bpo-20274 [https://bugs.python.org/issue?@action=redirect&bpo=20274]: 从 _sqlite.Connection 上的三个 METH_VARARGS 方法中移除被忽略和错误的 "kwargs" 参数。

bpo-24134 [https://bugs.python.org/issue?@action=redirect&bpo=24134]: assertRaises()、assertRaisesRegex()、assertWarns() 和 assertWarnsRegex() 检查现在当 callable 为 None 或在上下文管理器模式下传递了除 msg 外的关键字参数时，会发出弃用警告。

bpo-24018 [https://bugs.python.org/issue?@action=redirect&bpo=24018]: 添加 collections.abc.Generator 抽象基类。由 Stefan Behnel 贡献。

bpo-23880 [https://bugs.python.org/issue?@action=redirect&bpo=23880]: Tkinter 的 getint() 和 getdouble() 现在支持 Tcl_Obj。Tkinter 的 getdouble() 现在支持任何数字（特别是整数）。

bpo-22619 [https://bugs.python.org/issue?@action=redirect&bpo=22619]: 在 traceback 模块中添加了对负限制的支持。基于 Dmitry Kazakov 的补丁。

bpo-24094 [https://bugs.python.org/issue?@action=redirect&bpo=24094]: 修复了在 json.encode 中可能因为行为不良的字典子类而导致的崩溃。

bpo-9246 [https://bugs.python.org/issue?@action=redirect&bpo=9246]: 在 POSIX 上，os.getcwd() 现在支持超过 1025 字节的路径。补丁由 William Orr 编写。

bpo-17445 [https://bugs.python.org/issue?@action=redirect&bpo=17445]: 添加 difflib.diff_bytes() 以支持字节字符串的比较（修复了从 Python 2 开始的回归）。

bpo-23917 [https://bugs.python.org/issue?@action=redirect&bpo=23917]: 当 ProcessPoolExecutor 不存在时，回退到顺序编译。补丁由 Claudiu Popa 提供。

bpo-23008 [https://bugs.python.org/issue?@action=redirect&bpo=23008]: 修复了在 pydoc 中解析布尔值为 False 的属性时的错误。

修复 asyncio 问题 235：LifoQueue 和 PriorityQueue 的 put 没有增加未完成任务（这个错误是在 JoinableQueue 与 Queue 合并时引入的）。

bpo-23908 [https://bugs.python.org/issue?@action=redirect&bpo=23908]: os 函数现在在 Windows 上拒绝含有嵌入空字符的路径，而不是默默地截断它们。

bpo-23728 [https://bugs.python.org/issue?@action=redirect&bpo=23728]: 对于空数据，binascii.crc_hqx() 可能返回一个超出 0-0xffff 范围的整数。

bpo-23887 [https://bugs.python.org/issue?@action=redirect&bpo=23887]: urllib.error.HTTPError 现在有了一个正确的 repr() 表示。由 Berker Peksag 提供补丁。

asyncio: 新增事件循环 API: set_task_factory() 和 get_task_factory()。

asyncio: async() 函数已弃用，推荐使用 ensure_future()。

bpo-24178 [https://bugs.python.org/issue?@action=redirect&bpo=24178]: asyncio.Lock、Condition、Semaphore 和 BoundedSemaphore 支持新的 'async with' 语法。由 Yury Selivanov 贡献。

bpo-24179 [https://bugs.python.org/issue?@action=redirect&bpo=24179]: 为 asyncio.StreamReader 支持 'async for'。由 Yury Selivanov 贡献。

bpo-24184 [https://bugs.python.org/issue?@action=redirect&bpo=24184]: 将 AsyncIterator 和 AsyncIterable ABCs 添加到 collections.abc。由 Yury Selivanov 贡献。

bpo-22547 [https://bugs.python.org/issue?@action=redirect&bpo=22547]: 为 inspect.BoundArguments 实现信息丰富的 __repr__。由 Yury Selivanov 贡献。

bpo-24190 [https://bugs.python.org/issue?@action=redirect&bpo=24190]: 实现 inspect.BoundArgument.apply_defaults() 方法。由 Yury Selivanov 贡献。

bpo-20691 [https://bugs.python.org/issue?@action=redirect&bpo=20691]: 向 inspect.Signature.from_callable() 和 inspect.signature() 添加 'follow_wrapped' 参数。由 Yury Selivanov 贡献。

bpo-24248 [https://bugs.python.org/issue?@action=redirect&bpo=24248]: 弃用 inspect.Signature.from_function() 和 inspect.Signature.from_builtin()。

bpo-23898 [https://bugs.python.org/issue?@action=redirect&bpo=23898]: 修复 inspect.classify_class_attrs() 以支持具有重载 __eq__ 和 __bool__ 的属性。由 Mike Bayer 提供补丁。

bpo-24298 [https://bugs.python.org/issue?@action=redirect&bpo=24298]: 修复 inspect.signature() 以正确解包绑定方法的包装器。

IDLE

bpo-23184 [https://bugs.python.org/issue?@action=redirect&bpo=23184]: 移除 idlelib 中未使用的名称和导入。初始由 Al Sweigart 提供补丁。

测试

bpo-21520 [https://bugs.python.org/issue?@action=redirect&bpo=21520]: 如果当前目录名称中出现 'bad' 单词，test_zipfile 不再失败。

bpo-9517 [https://bugs.python.org/issue?@action=redirect&bpo=9517]: 将 script_helper 移动到 support 包中。由 Christie Wilson 提供补丁。

文档

bpo-22155 [https://bugs.python.org/issue?@action=redirect&bpo=22155]: 在 tkinter 文档中添加文件处理程序子章节，包含 createfilehandler。从 FAQ 中移除过时的示例。由 Martin Panter 提供补丁。

bpo-24029 [https://bugs.python.org/issue?@action=redirect&bpo=24029]: 记录子模块导入的名称绑定行为。

bpo-24077 [https://bugs.python.org/issue?@action=redirect&bpo=24077]: 修复 -I 命令选项的手册页中的拼写错误：-s，不是 -S。

工具/示例

bpo-24000 [https://bugs.python.org/issue?@action=redirect&bpo=24000]: 改进了 Argument Clinic 对转换器到旧版“格式单元”的映射。更新了文档以匹配。

bpo-24001 [https://bugs.python.org/issue?@action=redirect&bpo=24001]: Argument Clinic 转换器现在使用 accept={type} 而不是 types={'type'} 来指定转换器接受的类型。

bpo-23330 [https://bugs.python.org/issue?@action=redirect&bpo=23330]: h2py 现在支持在 #include 中使用任意文件名。

bpo-24031 [https://bugs.python.org/issue?@action=redirect&bpo=24031]: make patchcheck 现在也支持 git 检出。

Python 3.5.0 alpha 4

发布日期: 2015-04-19

核心与内置函数

bpo-22980 [https://bugs.python.org/issue?@action=redirect&bpo=22980]: 在 Linux、GNU/KFreeBSD 和 Hurd 下，C 扩展现在在扩展名中包括架构三元组，以便在同一工作树中轻松测试不同 ABI 的构建。在 OS X 下，扩展名现在包括 PEP 3149 [https://www.python.org/dev/peps/pep-3149] 风格的信息。

bpo-22631 [https://bugs.python.org/issue?@action=redirect&bpo=22631]: 添加了 Linux 特定的套接字常量 CAN_RAW_FD_FRAMES。由 Joe Jevnik 提供补丁。

bpo-23731 [https://bugs.python.org/issue?@action=redirect&bpo=23731]: 实现了 PEP 488 [https://www.python.org/dev/peps/pep-0488]: 移除了 .pyo 文件。

bpo-23726 [https://bugs.python.org/issue?@action=redirect&bpo=23726]: 对于没有添加任何新字段的非 GC 类型的用户子类，不启用 GC。由 Eugene Toder 提供补丁。

bpo-23309 [https://bugs.python.org/issue?@action=redirect&bpo=23309]: 如果在关闭时守护线程在被持有缓冲 I/O 对象的锁时被中止，并且主线程尝试使用相同的 I/O 对象（通常是 stdout 或 stderr），则避免死锁。相反，会发出致命错误。

bpo-22977 [https://bugs.python.org/issue?@action=redirect&bpo=22977]: 修复了在 Wine 上格式化 Windows 错误消息的问题。由 Martin Panter 提供补丁。

bpo-23466 [https://bugs.python.org/issue?@action=redirect&bpo=23466]: 在字节格式化中，%c、%o、%x 和 %X 现在对非整数输入引发 TypeError。

bpo-24044 [https://bugs.python.org/issue?@action=redirect&bpo=24044]: 修复了在内存不足情况下 list.sort 中可能的空指针解引用。

bpo-21354 [https://bugs.python.org/issue?@action=redirect&bpo=21354]: PyCFunction_New 函数再次由 python DLL 暴露。

库

bpo-23840 [https://bugs.python.org/issue?@action=redirect&bpo=23840]: tokenize.open() 现在在错误时关闭临时二进制文件以修复资源警告。

bpo-16914 [https://bugs.python.org/issue?@action=redirect&bpo=16914]: smtplib 中的新调试级别 2 在调试输出中添加了时间戳。

bpo-7159 [https://bugs.python.org/issue?@action=redirect&bpo=7159]: urllib.request 现在支持在第一次 401 后自动发送认证凭据。此增强是 bpo-19494 [https://bugs.python.org/issue?@action=redirect&bpo=19494] 增强的超集，并取代了该更改。

bpo-23703 [https://bugs.python.org/issue?@action=redirect&bpo=23703]: 修复在901e4e52b20a中引入的urljoin()回归问题。由Demian Brecht提供补丁。

bpo-4254 [https://bugs.python.org/issue?@action=redirect&bpo=4254]: 添加_curses.update_lines_cols()。由Arnon Yaari提供补丁。

bpo-19933 [https://bugs.python.org/issue?@action=redirect&bpo=19933]: 为round提供ndigits的默认参数。由Vajrasky Kok提供补丁。

bpo-23193 [https://bugs.python.org/issue?@action=redirect&bpo=23193]: 向tarfile.TarFile.extract和tarfile.TarFile.extractall添加numeric_owner参数。由Michael Vogt和Eric Smith提供补丁。

bpo-23342 [https://bugs.python.org/issue?@action=redirect&bpo=23342]: 添加subprocess.run()函数，该函数返回CalledProcess实例，提供了比现有call*函数更一致的API。

bpo-21217 [https://bugs.python.org/issue?@action=redirect&bpo=21217]: inspect.getsourcelines()现在尝试从代码对象计算开始和结束行，修复了当lambda函数用作装饰器参数时的问题。由Thomas Ballinger和Allison Kaptur提供补丁。

bpo-24521 [https://bugs.python.org/issue?@action=redirect&bpo=24521]: 修复pickle模块中可能的整数溢出。

bpo-22931 [https://bugs.python.org/issue?@action=redirect&bpo=22931]: 允许cookie值中包含'['和']'。

functools.partial的keywords属性现在总是一个字典。

bpo-23811 [https://bugs.python.org/issue?@action=redirect&bpo=23811]: 向PyCompileError错误消息添加缺失的换行符。由Alex Shkop提供补丁。

bpo-21116 [https://bugs.python.org/issue?@action=redirect&bpo=21116]: 避免在分配大于可用RAM 50%的多进程共享数组时耗尽内存。由Médéric Boquien提供补丁。

bpo-22982 [https://bugs.python.org/issue?@action=redirect&bpo=22982]: 改进在可写文本文件的多位置查找时的BOM处理。

bpo-23464 [https://bugs.python.org/issue?@action=redirect&bpo=23464]: 移除已弃用的asyncio JoinableQueue。

bpo-23529 [https://bugs.python.org/issue?@action=redirect&bpo=23529]: 限制从GzipFile、BZ2File或LZMAFile读取时的解压数据大小。这防止了使用压缩炸弹（即解压后尺寸巨大的压缩负载）的拒绝服务攻击。由Martin Panter和Nikolaus Rath提供补丁。

bpo-21859 [https://bugs.python.org/issue?@action=redirect&bpo=21859]: 添加了io.FileIO的Python实现。

bpo-23865 [https://bugs.python.org/issue?@action=redirect&bpo=23865]: 多个模块中的close()方法现在在关闭时是幂等的且更健壮。如果需要释放多个资源，即使发生错误，所有资源也会被释放。

bpo-23400 [https://bugs.python.org/issue?@action=redirect&bpo=23400]: 如果sem_open不可用，在Python 2和3上抛出相同的异常。由Davin Potts提供补丁。

bpo-10838 [https://bugs.python.org/issue?@action=redirect&bpo=10838]: subprocess模块现在在其导出的名称列表中包括SubprocessError和TimeoutError，以供那些大胆使用 from subprocess import * 的用户使用。

bpo-23411 [https://bugs.python.org/issue?@action=redirect&bpo=23411]: 将DefragResult、ParseResult、SplitResult、DefragResultBytes、ParseResultBytes和SplitResultBytes添加到urllib.parse.__all__中。由Martin Panter提供补丁。

bpo-23881 [https://bugs.python.org/issue?@action=redirect&bpo=23881]: urllib.request.ftpwrapper构造函数现在会在FTP连接失败时关闭套接字，以修复ResourceWarning。

bpo-23853 [https://bugs.python.org/issue?@action=redirect&bpo=23853]: socket.socket.sendall() 不再在每次数据成功发送时重置套接字超时。套接字超时现在是发送所有数据的最大总持续时间。

bpo-22721 [https://bugs.python.org/issue?@action=redirect&bpo=22721]: 包含可排序和不可排序元素的集合或多行pprint输出的字典的顺序不再依赖于集合或字典的迭代顺序。

bpo-15133 [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。

bpo-10590 [https://bugs.python.org/issue?@action=redirect&bpo=10590]: xml.sax.parseString()现在支持字符串参数。

bpo-23338 [https://bugs.python.org/issue?@action=redirect&bpo=23338]: 修复了在Cygwin上格式化ctypes错误消息的问题。由Makoto Kato提供补丁。

bpo-15582 [https://bugs.python.org/issue?@action=redirect&bpo=15582]: inspect.getdoc()现在遵循继承链。

bpo-2175 [https://bugs.python.org/issue?@action=redirect&bpo=2175]: SAX解析器现在支持InputSource对象的字符流。

bpo-16840 [https://bugs.python.org/issue?@action=redirect&bpo=16840]: Tkinter现在支持Tcl 8.4中添加的64位整数和Tcl 8.5中添加的任意精度整数。

bpo-23834 [https://bugs.python.org/issue?@action=redirect&bpo=23834]: 修复socket.sendto()，使用C Py_ssize_t类型来存储sendto()的结果，而不是C int类型。

bpo-23618 [https://bugs.python.org/issue?@action=redirect&bpo=23618]: socket.socket.connect() 现在等待连接完成，而不是在连接被信号中断时抛出 InterruptedError，前提是信号处理程序没有抛出异常且套接字是阻塞的或具有超时。对于非阻塞套接字，socket.socket.connect() 仍然会抛出 InterruptedError。

bpo-21526 [https://bugs.python.org/issue?@action=redirect&bpo=21526]: Tkinter 现在支持 Tcl 8.5 中的新布尔类型。

bpo-23836 [https://bugs.python.org/issue?@action=redirect&bpo=23836]: 修复 faulthandler 模块以处理对其信号处理程序的可重入调用。

bpo-23838 [https://bugs.python.org/issue?@action=redirect&bpo=23838]: linecache 现在可以在 MemoryError 时清除缓存并返回空结果。

bpo-10395 [https://bugs.python.org/issue?@action=redirect&bpo=10395]: 添加了 os.path.commonpath()。在 posixpath 和 ntpath 中实现。基于 Rafik Draoui 的补丁。

bpo-23611 [https://bugs.python.org/issue?@action=redirect&bpo=23611]: 现在支持使用 pickle 协议 < 4 序列化更多“可查找”对象（如未绑定方法或嵌套类）。

bpo-13583 [https://bugs.python.org/issue?@action=redirect&bpo=13583]: sqlite3.Row 现在支持切片索引。

bpo-18473 [https://bugs.python.org/issue?@action=redirect&bpo=18473]: 修复了 2to3 和 3to2 兼容的 pickle 映射。修复了模糊的反向映射。添加了许多新映射。导入映射不再应用于已使用全名映射的模块。

bpo-23485 [https://bugs.python.org/issue?@action=redirect&bpo=23485]: select.select() 现在在被信号中断时会自动重试，并重新计算超时，除非信号处理程序引发异常。此变更是 PEP 475 [https://www.python.org/dev/peps/pep-0475] 的一部分。

bpo-23752 [https://bugs.python.org/issue?@action=redirect&bpo=23752]: 当从现有文件描述符构建时，io.FileIO() 现在只调用 fstat() 一次。之前 fstat() 被调用了两次，这是不必要的。

bpo-23704 [https://bugs.python.org/issue?@action=redirect&bpo=23704]: collections.deque() 对象现在支持 __add__, __mul__, 和 __imul__()。

bpo-23171 [https://bugs.python.org/issue?@action=redirect&bpo=23171]: csv.Writer.writerow() 现在支持任意可迭代对象。

bpo-23745 [https://bugs.python.org/issue?@action=redirect&bpo=23745]: 新的电子邮件头解析器现在可以无错误地处理重复的 MIME 参数名称，类似于 get_param 的行为。

bpo-22117 [https://bugs.python.org/issue?@action=redirect&bpo=22117]: 修复 os.utime()，现在它将时间戳向负无穷（-inf）舍入，而不是向零舍入。

bpo-23310 [https://bugs.python.org/issue?@action=redirect&bpo=23310]: 修复 MagicMock 的初始化器以与 __methods__ 一起工作，就像 configure_mock() 一样。由 Kasia Jachim 提供的补丁。

构建

bpo-23817 [https://bugs.python.org/issue?@action=redirect&bpo=23817]: FreeBSD 现在像其他操作系统一样在 SOVERSION 中使用 "1.0"，而不仅仅是 "1"。

bpo-23501 [https://bugs.python.org/issue?@action=redirect&bpo=23501]: Argument Clinic 现在默认将代码生成到单独的文件中。

测试

bpo-23799 [https://bugs.python.org/issue?@action=redirect&bpo=23799]: 添加了 test.support.start_threads() 用于运行和清理多个线程。

bpo-22390 [https://bugs.python.org/issue?@action=redirect&bpo=22390]: test.regrtest 现在会在测试运行后如果临时文件或目录未被清理时发出警告。

工具/示例

bpo-18128 [https://bugs.python.org/issue?@action=redirect&bpo=18128]: pygettext 现在在 POT-Creation-Date 头中使用标准的 +NNNN 格式。

bpo-23935 [https://bugs.python.org/issue?@action=redirect&bpo=23935]: Argument Clinic 现在对接受字节、字节数组和缓冲区的格式单元的理解与文档和实现一致。

bpo-23944 [https://bugs.python.org/issue?@action=redirect&bpo=23944]: Argument Clinic 现在在第78列换行长 impl 原型。

bpo-20586 [https://bugs.python.org/issue?@action=redirect&bpo=20586]: Argument Clinic 现在确保没有文档字符串的函数也有签名。

bpo-23492 [https://bugs.python.org/issue?@action=redirect&bpo=23492]: Argument Clinic 现在尽可能使用 PyArg_Parse 而不是 PyArg_ParseTuple 生成参数解析代码。

bpo-23500 [https://bugs.python.org/issue?@action=redirect&bpo=23500]: Argument Clinic 现在更智能地生成 methoddef 宏的“#ifndef”（空）定义：即使 Argument Clinic 多次处理相同的符号，它也只会生成一次，并且是在所有处理完成后而不是在第一次使用后立即发出。

C API

bpo-23998 [https://bugs.python.org/issue?@action=redirect&bpo=23998]: PyImport_ReInitLock() 现在检查锁分配错误

Python 3.5.0 alpha 3

发布日期: 2015-03-28

核心与内置函数

bpo-23573 [https://bugs.python.org/issue?@action=redirect&bpo=23573]: 提高了字符串搜索操作（str.find、str.index、str.count、in 操作符、str.split、str.partition）与不同类型参数（UCS1、UCS2、UCS4）的性能。

bpo-23753 [https://bugs.python.org/issue?@action=redirect&bpo=23753]: Python 不再支持没有 stat() 或 fstat() 的平台，这些函数现在总是必需的。

bpo-23681 [https://bugs.python.org/issue?@action=redirect&bpo=23681]: -b 选项现在影响 bytes 与 int 的比较。

bpo-23632 [https://bugs.python.org/issue?@action=redirect&bpo=23632]: Memoryviews 现在允许元组索引（包括多维 memoryviews）。

bpo-23192 [https://bugs.python.org/issue?@action=redirect&bpo=23192]: 修复了生成器 lambda。由 Bruno Cauet 提供补丁。

bpo-23629 [https://bugs.python.org/issue?@action=redirect&bpo=23629]: 修复了可变大小对象的默认 __sizeof__ 实现。

库

bpo-14260 [https://bugs.python.org/issue?@action=redirect&bpo=14260]: 正则表达式模式对象的 groupindex 属性现在是非可修改的映射。

bpo-23792 [https://bugs.python.org/issue?@action=redirect&bpo=23792]: 当 pydoc 分页器处于活动状态时忽略 KeyboardInterrupt。这模拟了标准 unix 分页器的行为，并防止 pipepager 在分页器本身仍在运行时关闭。

bpo-23775 [https://bugs.python.org/issue?@action=redirect&bpo=23775]: pprint() 现在输出的 OrderedDict 表示与 repr() 相同。

bpo-23765 [https://bugs.python.org/issue?@action=redirect&bpo=23765]: 移除了 ctypes 中的 IsBadStringPtr 调用。

bpo-22364 [https://bugs.python.org/issue?@action=redirect&bpo=22364]: 使用正则表达式提示改进了部分 re 错误消息。

bpo-23742 [https://bugs.python.org/issue?@action=redirect&bpo=23742]: ntpath.expandvars() 不再丢失不平衡的单引号。

bpo-21717 [https://bugs.python.org/issue?@action=redirect&bpo=21717]: zipfile.ZipFile.open 函数现在支持 'x'（独占创建）模式。

bpo-21802 [https://bugs.python.org/issue?@action=redirect&bpo=21802]: 现在，即使写入器关闭失败，BufferedRWPair.close() 中的读取器也会被关闭。

bpo-23622 [https://bugs.python.org/issue?@action=redirect&bpo=23622]: 现在，由 '\' 和 ASCII 字母组成的正则表达式中的未知转义将引发弃用警告，并将在 Python 3.6 中禁止使用。

bpo-23671 [https://bugs.python.org/issue?@action=redirect&bpo=23671]: string.Template 现在允许将 "self" 参数指定为关键字参数。string.Formatter 现在允许将 "self" 和 "format_string" 参数指定为关键字参数。

bpo-23502 [https://bugs.python.org/issue?@action=redirect&bpo=23502]: pprint 模块现在支持映射代理。

bpo-17530 [https://bugs.python.org/issue?@action=redirect&bpo=17530]: pprint 现在会换行显示长的 bytes 对象和 bytearrays。

bpo-22687 [https://bugs.python.org/issue?@action=redirect&bpo=22687]: 修复了 textwrap 中分割单词的一些极端情况。消除了分割长单词时的二次复杂度。

bpo-4727 [https://bugs.python.org/issue?@action=redirect&bpo=4727]: copy 模块现在使用 pickle 协议 4（PEP 3154），并支持复制其 __new__ 方法接受仅关键字参数的类实例。

bpo-23491 [https://bugs.python.org/issue?@action=redirect&bpo=23491]: 添加了一个 zipapp 模块以支持创建 Python 代码的可执行 zip 文件归档。为这些归档在 Windows 上注册了 ".pyz" 和 ".pyzw" 扩展名（PEP 441）。

bpo-23657 [https://bugs.python.org/issue?@action=redirect&bpo=23657]: 避免在 zipapp 中显式检查 str，增加了对 pathlib.Path 对象作为参数的支持。

bpo-23688 [https://bugs.python.org/issue?@action=redirect&bpo=23688]: 添加了对任意字节类对象的支持，并避免了在 gzip.GzipFile.write() 中不必要地复制 memoryview。原始由 Wolfgang Maier 提供补丁。

bpo-23252 [https://bugs.python.org/issue?@action=redirect&bpo=23252]: 添加了对将 ZIP 文件写入不可寻址流的支持。

bpo-23647 [https://bugs.python.org/issue?@action=redirect&bpo=23647]: 增加了 imaplib 的 MAXLINE 以适应现代邮箱大小。

bpo-23539 [https://bugs.python.org/issue?@action=redirect&bpo=23539]: 如果 body 为 None，http.client.HTTPConnection.request 现在会为 PUT、POST 和 PATCH 头设置 Content-Length 为 0，以避免某些 web 服务器返回 411 错误。

bpo-22351 [https://bugs.python.org/issue?@action=redirect&bpo=22351]: nntplib.NNTP 构造函数不再保持连接和 socket 打开直到垃圾回收器清理它们。补丁由 Martin Panter 提供。

bpo-23704 [https://bugs.python.org/issue?@action=redirect&bpo=23704]: collections.deque() 对象现在支持 index()、insert() 和 copy() 方法。这使得 deque 可以注册为 MutableSequence 并且提高了它们替代列表的能力。

bpo-23715 [https://bugs.python.org/issue?@action=redirect&bpo=23715]: signal.sigwaitinfo() 和 signal.sigtimedwait() 现在当被不在 sigset 参数中的信号中断时，如果信号处理器没有引发异常，会重试。signal.sigtimedwait() 在重试时使用单调时钟重新计算超时。

bpo-23001 [https://bugs.python.org/issue?@action=redirect&bpo=23001]: 在 mmap、ossaudiodev、socket、ssl 和 codecs 模块中，一些之前只接受只读 bytes-like 对象的函数现在也接受可写的 bytes-like 对象。

bpo-23646 [https://bugs.python.org/issue?@action=redirect&bpo=23646]: 如果 time.sleep() 被信号中断，现在会使用重新计算的延迟重试睡眠，除非信号处理器引发异常（PEP 475）。

bpo-23136 [https://bugs.python.org/issue?@action=redirect&bpo=23136]: _strptime 现在统一处理第 0 周的所有天，包括上一年的 12 月 30 日。基于 Jim Carroll 的补丁。

bpo-23700 [https://bugs.python.org/issue?@action=redirect&bpo=23700]: NamedTemporaryFile 的迭代器现在保持对 NamedTemporaryFile 实例的引用。补丁由 Bohuslav Kabrda 提供。

bpo-22903 [https://bugs.python.org/issue?@action=redirect&bpo=22903]: unittest.loader 在导入测试模块失败时创建的假测试用例现在可以 pickle。

bpo-22181 [https://bugs.python.org/issue?@action=redirect&bpo=22181]: 在 Linux 上，os.urandom() 现在如果可用会使用新的 getrandom() 系统调用，该系统调用在 Linux 内核 3.17 中引入。它更可靠也更安全，因为它避免了文件描述符的需要，并等待内核有足够的熵。

bpo-2211 [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提供补丁。

bpo-18983 [https://bugs.python.org/issue?@action=redirect&bpo=18983]: 允许在timeit中选择输出单位。由Julian Gindi提供补丁。

bpo-23631 [https://bugs.python.org/issue?@action=redirect&bpo=23631]: 修复traceback.format_list当traceback被修改时的问题。

bpo-23568 [https://bugs.python.org/issue?@action=redirect&bpo=23568]: 向MagicMock()对象添加rdivmod支持。由Håkan Lövdahl提供补丁。

bpo-2052 [https://bugs.python.org/issue?@action=redirect&bpo=2052]: 向HtmlDiff.make_file()添加charset参数。

bpo-23668 [https://bugs.python.org/issue?@action=redirect&bpo=23668]: 在Windows上支持os.truncate和os.ftruncate。

bpo-23138 [https://bugs.python.org/issue?@action=redirect&bpo=23138]: 修复了在cookiejar中解析缺少键或值的cookie的问题。由Demian Brecht提供补丁。

bpo-23051 [https://bugs.python.org/issue?@action=redirect&bpo=23051]: multiprocessing.Pool方法imap()和imap_unordered()现在可以处理迭代器引发的异常。由Alon Diamant和Davin Potts提供补丁。

bpo-23581 [https://bugs.python.org/issue?@action=redirect&bpo=23581]: 向MagicMock添加matmul支持。由Håkan Lövdahl提供补丁。

bpo-23566 [https://bugs.python.org/issue?@action=redirect&bpo=23566]: faulthandler的enable()、register()、dump_traceback()和dump_traceback_later()函数现在接受文件描述符。由Wei Wu提供补丁。

bpo-22928 [https://bugs.python.org/issue?@action=redirect&bpo=22928]: 在http.client中禁用了HTTP头注入。原始由Demian Brecht提供补丁。

bpo-23615 [https://bugs.python.org/issue?@action=redirect&bpo=23615]: 模块bz2、tarfile和tokenize现在可以通过imp.reload()重新加载。由Thomas Kluyver提供补丁。

bpo-23605 [https://bugs.python.org/issue?@action=redirect&bpo=23605]: os.walk()现在调用os.scandir()而不是os.listdir()。使用os.scandir()减少了对os.stat()的调用次数。初始补丁由Ben Hoyt编写。

构建

bpo-23585 [https://bugs.python.org/issue?@action=redirect&bpo=23585]: make patchcheck将确保解释器被构建。

测试

bpo-23583 [https://bugs.python.org/issue?@action=redirect&bpo=23583]: 在IDLE中添加了标准IO流的测试。

bpo-22289 [https://bugs.python.org/issue?@action=redirect&bpo=22289]: 防止由于ftp连接超时导致的test_urllib2net失败。

工具/示例

bpo-22826 [https://bugs.python.org/issue?@action=redirect&bpo=22826]: Tools/freeze/bkfile.py 中的 open() 函数结果现在与常规文件更兼容（特别是现在支持上下文管理协议）。

Python 3.5.0 alpha 2

发布日期: 2015-03-09

核心与内置函数

bpo-23571 [https://bugs.python.org/issue?@action=redirect&bpo=23571]: PyObject_Call() 和 PyCFunction_Call() 现在会在函数返回结果并引发异常时抛出 SystemError。SystemError 会被链接到前一个异常。

库

bpo-22524 [https://bugs.python.org/issue?@action=redirect&bpo=22524]: 新增 os.scandir() 函数，属于 PEP 471 [https://www.python.org/dev/peps/pep-0471]: "os.scandir() 函数 -- 一个更好更快的目录迭代器"。补丁由 Ben Hoyt 编写。

bpo-23103 [https://bugs.python.org/issue?@action=redirect&bpo=23103]: 减少了 IPv4Address 和 IPv6Address 的内存消耗。

bpo-21793 [https://bugs.python.org/issue?@action=redirect&bpo=21793]: BaseHTTPRequestHandler 再次将响应代码记录为数字，而不是字符串化的枚举。补丁由 Demian Brecht 提供。

bpo-23476 [https://bugs.python.org/issue?@action=redirect&bpo=23476]: 在 ssl 模块中，当可用时，在证书存储上启用 OpenSSL 的 X509_V_FLAG_TRUSTED_FIRST 标志。

bpo-23576 [https://bugs.python.org/issue?@action=redirect&bpo=23576]: 当 SSL 层已到达 EOF 但底层连接尚未关闭时，避免在 SSL 读取中停滞。

bpo-23504 [https://bugs.python.org/issue?@action=redirect&bpo=23504]: 在 types 模块中添加了 __all__。

bpo-23563 [https://bugs.python.org/issue?@action=redirect&bpo=23563]: 优化了 urllib.parse 中的实用函数。

bpo-7830 [https://bugs.python.org/issue?@action=redirect&bpo=7830]: 扁平化嵌套的 functools.partial。

bpo-20204 [https://bugs.python.org/issue?@action=redirect&bpo=20204]: 为 _tkinter 类添加了 __module__ 属性。

bpo-19980 [https://bugs.python.org/issue?@action=redirect&bpo=19980]: 改进了对非识别字符串的 help()。help('') 现在显示关于 str 的帮助。help('help') 现在显示关于 help() 的帮助。原始由 Mark Lawrence 提供补丁。

bpo-23521 [https://bugs.python.org/issue?@action=redirect&bpo=23521]: 更正了 timedelta 除法的纯 Python 实现。对于某些浮点数，消除了 timedelta * float 中的 OverflowError；更正了 timedelta 真除法中的舍入。

bpo-21619 [https://bugs.python.org/issue?@action=redirect&bpo=21619]: 如果管道已断开，Popen 对象在 with 语句退出后不再留下僵尸进程。由 Martin Panter 提供补丁。

bpo-22936 [https://bugs.python.org/issue?@action=redirect&bpo=22936]: 使得可以在 traceback 模块和 unittest 中显示跟踪回溯中的局部变量。

bpo-15955 [https://bugs.python.org/issue?@action=redirect&bpo=15955]: 在 bz2.decompress() 中添加了一个选项以限制输出大小。由 Nikolaus Rath 提供补丁。

bpo-6639 [https://bugs.python.org/issue?@action=redirect&bpo=6639]: 关闭窗口后，模块级的turtle函数不再引发TclError。

bpo-814253 [https://bugs.python.org/issue?@action=redirect&bpo=814253]: 现在，在正则表达式的后向断言中，组引用和条件组引用可以正常工作。（另见：bpo-9179 [https://bugs.python.org/issue?@action=redirect&bpo=9179]）

bpo-23215 [https://bugs.python.org/issue?@action=redirect&bpo=23215]: 使用自定义错误处理程序的多字节编解码器在忽略错误时消耗了过多内存并引发了SystemError或MemoryError。原始由Aleksi Torhamo提供补丁。

bpo-5700 [https://bugs.python.org/issue?@action=redirect&bpo=5700]: io.FileIO()在关闭文件后调用了flush()。如果closefd=False，则在close()中不会调用flush()。

bpo-23374 [https://bugs.python.org/issue?@action=redirect&bpo=23374]: 修复了当标准输出编码与文件系统编码不同（例如在Mac OS上）时，pydoc处理非ASCII文件失败的问题。

bpo-23481 [https://bugs.python.org/issue?@action=redirect&bpo=23481]: 从SSL模块的默认密码列表中移除RC4。

bpo-21548 [https://bugs.python.org/issue?@action=redirect&bpo=21548]: 修复了pydoc.synopsis()和pydoc.apropos()在模块文档字符串为空时的行为。

bpo-22885 [https://bugs.python.org/issue?@action=redirect&bpo=22885]: 修复了dbm.dumb模块中的任意代码执行漏洞。原始由Claudiu Popa提供补丁。

bpo-23239 [https://bugs.python.org/issue?@action=redirect&bpo=23239]: ssl.match_hostname()现在支持IP地址的匹配。

bpo-23146 [https://bugs.python.org/issue?@action=redirect&bpo=23146]: 修复了pathlib中处理带有正斜杠的绝对Windows路径时的错误。

bpo-23096 [https://bugs.python.org/issue?@action=redirect&bpo=23096]: 现在，协议0下的浮点数的pickle表示在Python和C实现中是相同的。

bpo-19105 [https://bugs.python.org/issue?@action=redirect&bpo=19105]: pprint现在更有效地利用右侧的自由空间。

bpo-14910 [https://bugs.python.org/issue?@action=redirect&bpo=14910]: 向argparse.ArgumentParser添加了allow_abbrev参数。由Jonathan Paugh、Steven Bethard、paul j3和Daniel Eriksson提供补丁。

bpo-21717 [https://bugs.python.org/issue?@action=redirect&bpo=21717]: tarfile.open()现在支持'x'（独占创建）模式。

bpo-23344 [https://bugs.python.org/issue?@action=redirect&bpo=23344]: marshal.dumps()现在平均快了20-25%。

bpo-20416 [https://bugs.python.org/issue?@action=redirect&bpo=20416]: 使用协议3和4的marshal.dumps()现在平均快了40-50%。

bpo-23421 [https://bugs.python.org/issue?@action=redirect&bpo=23421]: 修复了tarfile CLI中的压缩问题。由wdv4758h提供补丁。

bpo-23367 [https://bugs.python.org/issue?@action=redirect&bpo=23367]: 修复了unicodedata模块中可能的溢出问题。

bpo-23361 [https://bugs.python.org/issue?@action=redirect&bpo=23361]: 修复了Windows子进程创建代码中可能的溢出问题。

logging.handlers.QueueListener 现在接受一个 respect_handler_level 关键字参数，如果设置为 True，将会在考虑处理器级别的情况下将消息传递给处理器。

bpo-19705 [https://bugs.python.org/issue?@action=redirect&bpo=19705]: turtledemo 现在有一个视觉排序算法演示。原始补丁来自 Jason Yeo。

bpo-23801 [https://bugs.python.org/issue?@action=redirect&bpo=23801]: 修复了 cgi.FieldStorage 不总是忽略多部分主体的整个前导部分的问题。

构建

bpo-23445 [https://bugs.python.org/issue?@action=redirect&bpo=23445]: pydebug 构建现在尽可能使用 "gcc -Og"，以使生成的可执行文件更快。

bpo-23686 [https://bugs.python.org/issue?@action=redirect&bpo=23686]: 更新 OS X 10.5 安装程序构建以使用 OpenSSL 1.0.2a。

C API

bpo-20204 [https://bugs.python.org/issue?@action=redirect&bpo=20204]: 现在对于没有 __module__ 属性的内置类型会发出弃用警告。

Windows

bpo-23465 [https://bugs.python.org/issue?@action=redirect&bpo=23465]: 实现 PEP 486 [https://www.python.org/dev/peps/pep-0486] - 使 Python 启动器感知虚拟环境。由 Paul Moore 提供补丁。

bpo-23437 [https://bugs.python.org/issue?@action=redirect&bpo=23437]: 在 Windows 上使用户脚本目录版本化。由 Paul Moore 提供补丁。

Python 3.5.0 alpha 1

发布日期: 2015-02-08

核心与内置函数

bpo-23285 [https://bugs.python.org/issue?@action=redirect&bpo=23285]: PEP 475 - EINTR 处理。

bpo-22735 [https://bugs.python.org/issue?@action=redirect&bpo=22735]: 修复了许多涉及自定义 mro() 实现的边缘情况（包括崩溃）。

bpo-22896 [https://bugs.python.org/issue?@action=redirect&bpo=22896]: 避免使用 PyObject_AsCharBuffer(), PyObject_AsReadBuffer() 和 PyObject_AsWriteBuffer()。

bpo-21295 [https://bugs.python.org/issue?@action=redirect&bpo=21295]: 撤销了一些对 AST 行号和列偏移量的更改（bpo-16795 [https://bugs.python.org/issue?@action=redirect&bpo=16795]），这些更改构成了回归。

bpo-22986 [https://bugs.python.org/issue?@action=redirect&bpo=22986]: 在某些情况下允许更改对象的 __class__ 在动态类型和静态类型之间。

bpo-15859 [https://bugs.python.org/issue?@action=redirect&bpo=15859]: PyUnicode_EncodeFSDefault(), PyUnicode_EncodeMBCS() 和 PyUnicode_EncodeCodePage() 现在如果对象不是 Unicode 对象则会引发异常。对于 PyUnicode_EncodeFSDefault()，在非 Windows 平台上已经是这种情况。补丁由 Campbell Barton 编写。

bpo-21408 [https://bugs.python.org/issue?@action=redirect&bpo=21408]: 默认的 __ne__() 现在如果 __eq__() 返回 NotImplemented 则返回 NotImplemented。原始由 Martin Panter 提供补丁。

bpo-23321 [https://bugs.python.org/issue?@action=redirect&bpo=23321]: 修复了当错误处理程序返回的替换字符串比畸形输入数据长时 str.decode() 中的崩溃。

bpo-22286 [https://bugs.python.org/issue?@action=redirect&bpo=22286]: "backslashreplace" 错误处理程序现在可以用于解码和转换。

bpo-23253 [https://bugs.python.org/issue?@action=redirect&bpo=23253]: 在Windows上延迟加载ShellExecute[AW]以减少os.startfile的启动开销。

bpo-22038 [https://bugs.python.org/issue?@action=redirect&bpo=22038]: pyatomic.h现在使用stdatomic.h或GCC内置函数进行原子内存访问（如果可用）。补丁由Vitor de Lima和Gustavo Temple编写。

bpo-20284 [https://bugs.python.org/issue?@action=redirect&bpo=20284]: 为bytes和bytearray添加了%-插值（即printf）格式化。

bpo-23048 [https://bugs.python.org/issue?@action=redirect&bpo=23048]: 修复了在pdb中跳出无限while循环的问题。

bpo-20335 [https://bugs.python.org/issue?@action=redirect&bpo=20335]: bytes构造函数现在在编码或错误与非字符串参数一起指定时引发TypeError。基于Renaud Blanch的补丁。

bpo-22834 [https://bugs.python.org/issue?@action=redirect&bpo=22834]: 如果当前工作目录最终被设置为不存在的目录，则导入将不再引发FileNotFoundError。

bpo-22869 [https://bugs.python.org/issue?@action=redirect&bpo=22869]: 将解释器启动和关闭代码移动到一个新的专用pylifecycle.c模块中。

bpo-22847 [https://bugs.python.org/issue?@action=redirect&bpo=22847]: 提高方法缓存的效率。

bpo-22335 [https://bugs.python.org/issue?@action=redirect&bpo=22335]: 修复在32位平台上尝试将bytearray扩大到0x7fffffff字节时的崩溃问题。

bpo-22653 [https://bugs.python.org/issue?@action=redirect&bpo=22653]: 修复在调试模式下进行可重入字典插入时的断言失败。

bpo-22643 [https://bugs.python.org/issue?@action=redirect&bpo=22643]: 修复Unicode大小写操作（大写、小写、标题、交换大小写、casefold）中的整数溢出问题。

bpo-17636 [https://bugs.python.org/issue?@action=redirect&bpo=17636]: 现在支持涉及相对导入的循环导入。

bpo-22604 [https://bugs.python.org/issue?@action=redirect&bpo=22604]: 修复在调试模式下将复数除以(nan+0j)时的断言错误。

bpo-21052 [https://bugs.python.org/issue?@action=redirect&bpo=21052]: 当sys.path_hooks或sys.meta_path设置为None时，不引发ImportWarning。

bpo-16518 [https://bugs.python.org/issue?@action=redirect&bpo=16518]: 在错误消息中使用'需要类似字节的对象'，而不是之前使用的更为晦涩的"'x'不支持缓冲区协议"。

bpo-22470 [https://bugs.python.org/issue?@action=redirect&bpo=22470]: 修复了"backslashreplace"、"xmlcharrefreplace"和"surrogatepass"错误处理程序中的整数溢出问题。

bpo-22540 [https://bugs.python.org/issue?@action=redirect&bpo=22540]: speed up PyObject_IsInstance and PyObject_IsSubclass in the common case that the second argument has metaclass type.

bpo-18711 [https://bugs.python.org/issue?@action=redirect&bpo=18711]: Add a new PyErr_FormatV function, similar to PyErr_Format but accepting a va_list argument.

bpo-22520 [https://bugs.python.org/issue?@action=redirect&bpo=22520]: 修复生成 unicode 对象 repr 时的溢出检查。

bpo-22519 [https://bugs.python.org/issue?@action=redirect&bpo=22519]: 修复 PyBytes_Repr 中的溢出检查。

bpo-22518 [https://bugs.python.org/issue?@action=redirect&bpo=22518]: 修复 latin-1 编码中的整数溢出问题。

bpo-16324 [https://bugs.python.org/issue?@action=redirect&bpo=16324]: MIMEText 的 _charset 参数现在也接受 email.charset.Charset 实例。初始补丁由 Claude Paroz 提供。

bpo-1764286 [https://bugs.python.org/issue?@action=redirect&bpo=1764286]: 修复 inspect.getsource() 以支持装饰函数。由 Claudiu Popa 提供补丁。

bpo-18554 [https://bugs.python.org/issue?@action=redirect&bpo=18554]: os.__all__ 包括 posix 函数。

bpo-21391 [https://bugs.python.org/issue?@action=redirect&bpo=21391]: 在 shutil 模块中使用 os.path.abspath。

bpo-11471 [https://bugs.python.org/issue?@action=redirect&bpo=11471]: 避免在 if 块的末尾生成 JUMP_FORWARD 指令，如果没有 else 子句。原始由 Eugene Toder 提供补丁。

bpo-22215 [https://bugs.python.org/issue?@action=redirect&bpo=22215]: 现在当 str 或 bytes 参数包含不允许的空字符或字节时，会引发 ValueError 而不是 TypeError。

bpo-22258 [https://bugs.python.org/issue?@action=redirect&bpo=22258]: 修复 Illumos 上的内部函数 set_inheritable()。该平台暴露了函数 ioctl(FIOCLEX)，但调用它会失败，errno 是 ENOTTY: "Inappropriate ioctl for device"。set_inheritable() 现在回退到较慢的 fcntl() (F_GETFD 然后 F_SETFD)。

bpo-21389 [https://bugs.python.org/issue?@action=redirect&bpo=21389]: 在绑定方法的 repr 中显示底层函数的 __qualname__。

bpo-22206 [https://bugs.python.org/issue?@action=redirect&bpo=22206]: 使用 pthread 时，PyThread_create_key() 现在在整数溢出时将 errno 设置为 ENOMEM 并返回 -1（错误）。

bpo-20184 [https://bugs.python.org/issue?@action=redirect&bpo=20184]: 为 30 个内置函数添加了基于 Argument Clinic 的签名内省。

bpo-22116 [https://bugs.python.org/issue?@action=redirect&bpo=22116]: C 函数和方法（'builtin_function_or_method' 类型）现在可以被弱引用。由 Wei Wu 提供补丁。

bpo-22077 [https://bugs.python.org/issue?@action=redirect&bpo=22077]: 通过添加 'or slices' 改善 bytearrays、bytes、lists 和 tuples 的索引错误消息。为 bytearrays 添加了 ', not <typename>'。原始由 Claudiu Popa 提供补丁。

bpo-20179 [https://bugs.python.org/issue?@action=redirect&bpo=20179]: 将 Argument Clinic 应用于 bytes 和 bytearray。由 Tal Einat 提供补丁。

bpo-22082 [https://bugs.python.org/issue?@action=redirect&bpo=22082]: 清除 slotdefs 中的内部字符串。

升级 Unicode 数据库到 7.0.0 版本。

bpo-21897 [https://bugs.python.org/issue?@action=redirect&bpo=21897]: 修复当 frame.clear() 被调用时带有闭包变量的 f_locals 属性的崩溃问题。

bpo-21205 [https://bugs.python.org/issue?@action=redirect&bpo=21205]: 为生成器添加一个新的 __qualname__ 属性，即限定名称，并在生成器的表示中使用它（repr(gen)）。生成器的默认名称（__name__ 属性）现在从函数中获取，而不是从代码中获取。使用 gen.gi_code.co_name 获取代码的名称。

bpo-21669 [https://bugs.python.org/issue?@action=redirect&bpo=21669]: 借助 SyntaxError.__init__ 中的启发式方法，解析器现在尝试在“exec”和“print”被用作语句时生成更有意义（或至少更搜索引擎友好）的错误消息。

bpo-21642 [https://bugs.python.org/issue?@action=redirect&bpo=21642]: 在条件 if-else 表达式中，允许整数与 else 关键字之间没有空格（例如 True if 42else False）的写法作为有效语法。

bpo-21523 [https://bugs.python.org/issue?@action=redirect&bpo=21523]: 修复了编译器中一些操作码堆栈效应的过度悲观计算。这也修复了当编译包含大量“and”和“or”运算符的代码时明显的二次编译时间问题。

bpo-21418 [https://bugs.python.org/issue?@action=redirect&bpo=21418]: 修复了在没有参数且没有当前帧（例如嵌入式 Python）时调用内置函数 super() 时的崩溃问题。

bpo-21425 [https://bugs.python.org/issue?@action=redirect&bpo=21425]: 修复了交互式解释器中标准流的刷新问题。

bpo-21435 [https://bugs.python.org/issue?@action=redirect&bpo=21435]: 在极少数情况下，对循环垃圾中的对象运行终结器时，由于内部迭代逻辑的微妙缺陷，可能会发生错误的指针解引用。

bpo-21377 [https://bugs.python.org/issue?@action=redirect&bpo=21377]: PyBytes_Concat() 现在尝试在第一个参数的引用计数为1时原地连接。由 Nikolaus Rath 提供补丁。

bpo-20355 [https://bugs.python.org/issue?@action=redirect&bpo=20355]: -W 命令行选项现在比 PYTHONWARNINGS 环境变量具有更高的优先级。由 Arfrever 提供补丁。

bpo-21274 [https://bugs.python.org/issue?@action=redirect&bpo=21274]: 在 Python/pythonrun.c 中为 GNU/Hurd 定义 PATH_MAX。

bpo-20904 [https://bugs.python.org/issue?@action=redirect&bpo=20904]: 支持在 m68k 上设置 FPU 精度。

bpo-21209 [https://bugs.python.org/issue?@action=redirect&bpo=21209]: 修复使用 yield from 语法向自定义生成器对象发送元组的问题。

bpo-21193 [https://bugs.python.org/issue?@action=redirect&bpo=21193]: 当 b 为负数时，pow(a, b, c) 现在会引发 ValueError 而不是 TypeError。补丁由 Josh Rosenberg 提供。

bpo-21176 [https://bugs.python.org/issue?@action=redirect&bpo=21176]: PEP 465: 为矩阵乘法添加'@'运算符。

bpo-21134 [https://bugs.python.org/issue?@action=redirect&bpo=21134]: 修复在未初始化的UnicodeEncodeError、UnicodeDecodeError或UnicodeTranslateError对象上调用str时出现的段错误。

bpo-19537 [https://bugs.python.org/issue?@action=redirect&bpo=19537]: 修复m68k下PyUnicode_DATA()的对齐问题。由Andreas Schwab提供补丁。

bpo-20929 [https://bugs.python.org/issue?@action=redirect&bpo=20929]: 添加类型转换以避免负数移位。

bpo-20731 [https://bugs.python.org/issue?@action=redirect&bpo=20731]: 即使以文本模式打开，也能正确定位源代码文件中的位置。由Serhiy Storchaka提供补丁。

bpo-20637 [https://bugs.python.org/issue?@action=redirect&bpo=20637]: 键共享现在也适用于子类的实例字典。由Peter Ingebretson提供补丁。

bpo-8297 [https://bugs.python.org/issue?@action=redirect&bpo=8297]: 模块中缺失的属性现在在错误文本中包含模块名称。原始由ysj.ray提供补丁。

bpo-19995 [https://bugs.python.org/issue?@action=redirect&bpo=19995]: %c、%o、%x和%X现在对非整数输入引发TypeError。

bpo-19655 [https://bugs.python.org/issue?@action=redirect&bpo=19655]: ASDL解析器 - 用于构建过程中生成用于在C中管理Python AST的代码 - 被重写。新解析器是自包含的，不需要携带spark.py解析器生成器库；spark.py已从源代码库中移除。

bpo-12546 [https://bugs.python.org/issue?@action=redirect&bpo=12546]: 允许在使用str、int、float和complex的__format__方法时使用 \x00 作为填充字符。

bpo-20480 [https://bugs.python.org/issue?@action=redirect&bpo=20480]: 添加ipaddress.reverse_pointer。由Leon Weber提供补丁。

bpo-13598 [https://bugs.python.org/issue?@action=redirect&bpo=13598]: 修改string.Formatter以支持替换字段的自动编号。现在在这方面它与str.format()的行为相匹配。由Phil Elson和Ramchandra Apte提供补丁。

bpo-8931 [https://bugs.python.org/issue?@action=redirect&bpo=8931]: 使类型'c'的替代格式('#')引发异常。在3.5之前的版本中，'#'与'c'一起使用没有效果。现在指定它是一个错误。由Torsten Landschoff提供补丁。

bpo-23165 [https://bugs.python.org/issue?@action=redirect&bpo=23165]: 在_Py_char2wchar函数中分配内存之前执行溢出检查。

库

bpo-23399 [https://bugs.python.org/issue?@action=redirect&bpo=23399]: pyvenv尽可能创建相对符号链接。

bpo-20289 [https://bugs.python.org/issue?@action=redirect&bpo=20289]: cgi.FieldStorage()现在支持上下文管理协议。

bpo-13128 [https://bugs.python.org/issue?@action=redirect&bpo=13128]: 当debuglevel > 0时，打印CONNECT请求的响应头。由Demian Brecht提供补丁。

bpo-15381 [https://bugs.python.org/issue?@action=redirect&bpo=15381]: 优化了 io.BytesIO 以减少分配和复制操作。

bpo-22818 [https://bugs.python.org/issue?@action=redirect&bpo=22818]: 现在，对可能匹配空字符串的模式进行拆分时会发出警告。只能匹配空字符串的模式现已被拒绝。

bpo-23099 [https://bugs.python.org/issue?@action=redirect&bpo=23099]: 现在拒绝关闭带有导出缓冲区的 io.BytesIO，以防止损坏导出的缓冲区。

bpo-23326 [https://bugs.python.org/issue?@action=redirect&bpo=23326]: 移除了 __ne__ 实现。由于在 bpo-21408 [https://bugs.python.org/issue?@action=redirect&bpo=21408] 中修复了默认的 __ne__ 实现，它们现在是多余的。

bpo-23363 [https://bugs.python.org/issue?@action=redirect&bpo=23363]: 修复了 itertools.permutations 中可能的溢出问题。

bpo-23364 [https://bugs.python.org/issue?@action=redirect&bpo=23364]: 修复了 itertools.product 中可能的溢出问题。

bpo-23366 [https://bugs.python.org/issue?@action=redirect&bpo=23366]: 修复了 itertools.combinations 中可能的整数溢出问题。

bpo-23369 [https://bugs.python.org/issue?@action=redirect&bpo=23369]: 修复了 _json.encode_basestring_ascii 中可能的整数溢出问题。

bpo-23353 [https://bugs.python.org/issue?@action=redirect&bpo=23353]: 修复了 PyEval_EvalFrameEx() 中生成器的异常处理。在入口处，即使 PyEval_EvalFrameEx() 以 throwflag=0 调用，也会保存或交换异常状态。在退出时，异常状态现在总是被恢复或交换，不仅当 why 是 WHY_YIELD 或 WHY_RETURN 时。补丁由 Antoine Pitrou 共同编写。

bpo-14099 [https://bugs.python.org/issue?@action=redirect&bpo=14099]: 恢复了对可定位但不可寻址流的 ZIP 文件写入支持。

bpo-14099 [https://bugs.python.org/issue?@action=redirect&bpo=14099]: 现在，写入 ZipFile 和读取多个 ZipExtFiles 是线程安全的。

bpo-19361 [https://bugs.python.org/issue?@action=redirect&bpo=19361]: JSON 解码器现在引发 JSONDecodeError 而不是 ValueError。

bpo-18518 [https://bugs.python.org/issue?@action=redirect&bpo=18518]: timeit 现在拒绝不能在函数或循环外编译的语句（例如 "return" 或 "break"）。

bpo-23094 [https://bugs.python.org/issue?@action=redirect&bpo=23094]: 修复了 pickle 的 Python 实现中带有帧的 readline 问题。

bpo-23268 [https://bugs.python.org/issue?@action=redirect&bpo=23268]: 修复了 ipaddress 类比较中的错误。

bpo-21408 [https://bugs.python.org/issue?@action=redirect&bpo=21408]: 移除了不正确的 __ne__() 实现，这些实现在 __eq__() 返回 NotImplemented 时没有返回 NotImplemented。现在默认的 __ne__() 工作正常。

bpo-19996 [https://bugs.python.org/issue?@action=redirect&bpo=19996]: email.feedparser.FeedParser 现在处理（格式错误的）没有键的头部，而不是假设主体已经开始。

bpo-20188 [https://bugs.python.org/issue?@action=redirect&bpo=20188]: 在ssl模块中支持应用层协议协商(ALPN)。

bpo-23133 [https://bugs.python.org/issue?@action=redirect&bpo=23133]: ipaddress对象的pickle现在生成更紧凑且可移植的表示。

bpo-23248 [https://bugs.python.org/issue?@action=redirect&bpo=23248]: 从最新的OpenSSL git master更新ssl错误代码。

bpo-23266 [https://bugs.python.org/issue?@action=redirect&bpo=23266]: 当存在许多非连续地址时，ipaddress.collapse_addresses()的实现速度大幅提升。

bpo-23098 [https://bugs.python.org/issue?@action=redirect&bpo=23098]: os模块现在支持64位的dev_t。

bpo-21817 [https://bugs.python.org/issue?@action=redirect&bpo=21817]: 当提交给ProcessPoolExecutor的任务中抛出异常时，现在会在父进程中显示远程回溯。由Claudiu Popa提供补丁。

bpo-15955 [https://bugs.python.org/issue?@action=redirect&bpo=15955]: 添加一个选项以限制解压LZMA数据时的输出大小。由Nikolaus Rath和Martin Panter提供补丁。

bpo-23250 [https://bugs.python.org/issue?@action=redirect&bpo=23250]: 在http.cookies模块中，将"HttpOnly"和"Secure"按照标准中的写法大写。

bpo-23063 [https://bugs.python.org/issue?@action=redirect&bpo=23063]: 在distutils的check命令中，修复带有code或code-block指令的reST的解析。

bpo-23209 [https://bugs.python.org/issue?@action=redirect&bpo=23209]: 如果选择器已关闭，selectors.BaseSelector.get_key()现在会抛出RuntimeError。并且selectors.BaseSelector.close()现在会清除其对选择器映射的内部引用以打破引用循环。初始补丁由Martin Richard编写。（另见：bpo-23225 [https://bugs.python.org/issue?@action=redirect&bpo=23225]）

bpo-17911 [https://bugs.python.org/issue?@action=redirect&bpo=17911]: 提供一种方式来为PEP-302模块的linecache播种，而无需实际加载代码。

bpo-17911 [https://bugs.python.org/issue?@action=redirect&bpo=17911]: 为traceback提供一个新的对象API，包括能够不在回溯实际渲染之前查找行，且不保留原始对象的任何痕迹。

bpo-19777 [https://bugs.python.org/issue?@action=redirect&bpo=19777]: 在Path对象上提供一个home()类方法。由Victor Salgado和Mayank Tripathi贡献。

bpo-23206 [https://bugs.python.org/issue?@action=redirect&bpo=23206]: 使 json.dumps(..., ensure_ascii=False) 与默认情况 ensure_ascii=True 一样快。由Naoki Inada提供补丁。

bpo-23185 [https://bugs.python.org/issue?@action=redirect&bpo=23185]: 添加math.inf和math.nan常量。

bpo-23186 [https://bugs.python.org/issue?@action=redirect&bpo=23186]: 添加 ssl.SSLObject.shared_ciphers() 和 ssl.SSLSocket.shared_ciphers() 以获取客户端在握手时发送的加密套件列表。

bpo-23143 [https://bugs.python.org/issue?@action=redirect&bpo=23143]: 移除对早于0.9.8版本的OpenSSL的兼容性支持。

bpo-23132 [https://bugs.python.org/issue?@action=redirect&bpo=23132]: 改进由functool.total_ordering创建的比较方法的性能和内省支持。

bpo-19776 [https://bugs.python.org/issue?@action=redirect&bpo=19776]: 在Path对象上添加expanduser()方法。

bpo-23112 [https://bugs.python.org/issue?@action=redirect&bpo=23112]: 修复SimpleHTTPServer在重定向添加尾部斜杠时正确携带查询字符串和片段的问题。

bpo-21793 [https://bugs.python.org/issue?@action=redirect&bpo=21793]: 添加了http.HTTPStatus枚举（例如HTTPStatus.OK, HTTPStatus.NOT_FOUND）。补丁由Demian Brecht提供。

bpo-23093 [https://bugs.python.org/issue?@action=redirect&bpo=23093]: 在io模块中，允许更多操作在已分离的流上工作。

bpo-23111 [https://bugs.python.org/issue?@action=redirect&bpo=23111]: 在ftplib中，使ssl.PROTOCOL_SSLv23成为默认协议版本。

bpo-22585 [https://bugs.python.org/issue?@action=redirect&bpo=22585]: 在OpenBSD 5.6及更新版本上，os.urandom()现在调用getentropy()，而不是读取/dev/urandom，来获取伪随机字节。

bpo-19104 [https://bugs.python.org/issue?@action=redirect&bpo=19104]: pprint现在为包装的字符串生成可评估的输出。

bpo-23071 [https://bugs.python.org/issue?@action=redirect&bpo=23071]: 向codecs.__all__添加了缺失的名称。由Martin Panter提供补丁。

bpo-22783 [https://bugs.python.org/issue?@action=redirect&bpo=22783]: 如果可能，Pickling现在使用NEWOBJ操作码而不是NEWOBJ_EX操作码。

bpo-15513 [https://bugs.python.org/issue?@action=redirect&bpo=15513]: 为pickle类添加了__sizeof__实现。

bpo-19858 [https://bugs.python.org/issue?@action=redirect&bpo=19858]: pickletools.optimize()现在能够识别MEMOIZE操作码，可以生成更紧凑的结果，并且在输入数据包含与PUT或BINPUT操作码一起的MEMOIZE操作码时不再生成无效输出。

bpo-22095 [https://bugs.python.org/issue?@action=redirect&bpo=22095]: 修复了HTTPConnection.set_tunnel的默认端口问题。主机头中的端口值被设置为"None"。由Demian Brecht提供补丁。

bpo-23016 [https://bugs.python.org/issue?@action=redirect&bpo=23016]: 当程序使用pythonw.exe运行时，警告不再产生AttributeError。

bpo-21775 [https://bugs.python.org/issue?@action=redirect&bpo=21775]: shutil.copytree(): 修复在复制到VFAT时崩溃的问题。异常处理程序假设OSError对象总是有'winerror'属性。但事实并非如此，因此在Linux（以及任何其他非Windows操作系统）上运行时，异常处理程序本身会引发AttributeError。由Greg Ward提供补丁。

bpo-1218234 [https://bugs.python.org/issue?@action=redirect&bpo=1218234]: 修复inspect.getsource()以加载重新加载模块的更新源代码。初始由Berker Peksag提供补丁。

bpo-21740 [https://bugs.python.org/issue?@action=redirect&bpo=21740]: 在doctest中支持包装的可调用对象。由Claudiu Popa提供补丁。

bpo-23009 [https://bugs.python.org/issue?@action=redirect&bpo=23009]: 确保selectors.EpollSelector.select()在没有FD注册时也能工作。

bpo-22959 [https://bugs.python.org/issue?@action=redirect&bpo=22959]: 在http.client.HTTPSConnection的构造函数中，优先使用上下文的check_hostname属性而不是 check_hostname 参数。

bpo-22696 [https://bugs.python.org/issue?@action=redirect&bpo=22696]: 添加函数 sys.is_finalizing() 以了解解释器关闭状态。

bpo-16043 [https://bugs.python.org/issue?@action=redirect&bpo=16043]: Add a default limit for the amount of data xmlrpclib.gzip_decode will return. This resolves CVE-2013-1753.

bpo-14099 [https://bugs.python.org/issue?@action=redirect&bpo=14099]: ZipFile.open()不再重新打开底层文件。ZipFile.open()返回的对象现在可以独立于ZipFile操作，即使ZipFile是通过将类似文件的对象作为构造函数的第一个参数传递而创建的。

bpo-22966 [https://bugs.python.org/issue?@action=redirect&bpo=22966]: 修复当pyc_compile被要求编译包含源文件名中多个点的源文件时，__pycache__ pyc文件名冲突的问题。

bpo-21971 [https://bugs.python.org/issue?@action=redirect&bpo=21971]: 更新turtledemo文档并将模块添加到索引中。

bpo-21032 [https://bugs.python.org/issue?@action=redirect&bpo=21032]: 修复如果HTTPConnection.getresponse()失败时的套接字泄漏问题。原始由Martin Panter提供补丁。

bpo-22407 [https://bugs.python.org/issue?@action=redirect&bpo=22407]: 弃用re.LOCALE标志与str模式或re.ASCII一起使用。它从未工作过。

bpo-22902 [https://bugs.python.org/issue?@action=redirect&bpo=22902]: 在 Linux 上现在会使用 "ip" 命令在 uuid.getnode() 中确定 MAC 地址。 由 Bruno Cauet 编写补丁。

bpo-22960 [https://bugs.python.org/issue?@action=redirect&bpo=22960]: 向xmlrpclib.ServerProxy构造函数添加上下文参数。

bpo-22389 [https://bugs.python.org/issue?@action=redirect&bpo=22389]: 添加contextlib.redirect_stderr()。

bpo-21356 [https://bugs.python.org/issue?@action=redirect&bpo=21356]: 使 ssl.RAND_egd() 成为可选项以支持 LibreSSL。该函数的可用性在编译期间进行检查。补丁由 Bernard Spil 编写。

bpo-22915 [https://bugs.python.org/issue?@action=redirect&bpo=22915]: SAX 解析器现在支持通过文件描述符或字节路径打开的文件。

bpo-22609 [https://bugs.python.org/issue?@action=redirect&bpo=22609]: collections 模块中的映射类的构造函数和更新方法现在接受 self 关键字参数。

bpo-22940 [https://bugs.python.org/issue?@action=redirect&bpo=22940]: 添加 readline.append_history_file。

bpo-19676 [https://bugs.python.org/issue?@action=redirect&bpo=19676]: 添加了 "namereplace" 错误处理程序。

bpo-22788 [https://bugs.python.org/issue?@action=redirect&bpo=22788]: 向 logging.handlers.HTTPHandler 添加 context 参数。

bpo-22921 [https://bugs.python.org/issue?@action=redirect&bpo=22921]: 允许 SSLContext 接受 hostname 参数，即使 OpenSSL 不支持 SNI。

bpo-22894 [https://bugs.python.org/issue?@action=redirect&bpo=22894]: TestCase.subTest() 在 failfast 模式下会导致测试套件停止，即使没有失败。

bpo-22796 [https://bugs.python.org/issue?@action=redirect&bpo=22796]: HTTP cookie 解析现在更加严格，以防范潜在的注入攻击。

bpo-22370 [https://bugs.python.org/issue?@action=redirect&bpo=22370]: pathlib 中的 Windows 检测现在更加健壮。

bpo-22841 [https://bugs.python.org/issue?@action=redirect&bpo=22841]: 在 asyncio add_signal_handler() 中拒绝协程。由 Ludovic.Gasc 提供补丁。

bpo-19494 [https://bugs.python.org/issue?@action=redirect&bpo=19494]: 添加了 urllib.request.HTTPBasicPriorAuthHandler。由 Matej Cepl 提供补丁。

bpo-22578 [https://bugs.python.org/issue?@action=redirect&bpo=22578]: 向 re.error 类添加了属性。

bpo-22849 [https://bugs.python.org/issue?@action=redirect&bpo=22849]: 修复了 io.TextIOWrapper 构造函数中可能的双重释放问题。

bpo-12728 [https://bugs.python.org/issue?@action=redirect&bpo=12728]: 现在在不区分大小写的正则表达式中匹配具有相同大写但不同小写的不同 Unicode 字符。

bpo-22821 [https://bugs.python.org/issue?@action=redirect&bpo=22821]: 修复了在 64 位大端平台上使用整数参数的 fcntl()。

bpo-21650 [https://bugs.python.org/issue?@action=redirect&bpo=21650]: Add an --sort-keys option to json.tool CLI.

bpo-22824 [https://bugs.python.org/issue?@action=redirect&bpo=22824]: 更新了 reprlib 中集合的输出格式以使用集合字面量。补丁由 Berker Peksag 贡献。

bpo-22824 [https://bugs.python.org/issue?@action=redirect&bpo=22824]: 更新了 reprlib 中数组的输出格式，以显示没有不必要空列表的空数组。建议由 Serhiy Storchaka 提出。

bpo-22406 [https://bugs.python.org/issue?@action=redirect&bpo=22406]: 修复了错误移植到 3.x 的 uu_codec 编解码器。基于 Martin Panter 的补丁。

bpo-17293 [https://bugs.python.org/issue?@action=redirect&bpo=17293]: uuid.getnode() 现在在 AIX 上使用 netstat 确定 MAC 地址。基于 Aivars Kalvāns 的补丁。

bpo-22769 [https://bugs.python.org/issue?@action=redirect&bpo=22769]: 修复了 ttk.Treeview.tag_has() 在没有参数调用时的问题。

bpo-22417 [https://bugs.python.org/issue?@action=redirect&bpo=22417]: 在 httplib 中默认验证证书 (PEP 476)。

bpo-22775 [https://bugs.python.org/issue?@action=redirect&bpo=22775]: 修复了使用协议 2 及以上版本对 http.cookies.SimpleCookie 的反序列化。补丁由 Tim Graham 提供。

bpo-22776 [https://bugs.python.org/issue?@action=redirect&bpo=22776]: 在 SysLogHandler.emit() 中将排除的代码移至 try 块的作用域内。

bpo-22665 [https://bugs.python.org/issue?@action=redirect&bpo=22665]: 将缺失的 get_terminal_size 和 SameFileError 添加到 shutil.__all__。

bpo-6623 [https://bugs.python.org/issue?@action=redirect&bpo=6623]: 移除了 ftplib 模块中已弃用的 Netrc 类。由 Matt Chaput 提供补丁。

bpo-17381 [https://bugs.python.org/issue?@action=redirect&bpo=17381]: 修复了正则表达式中不区分大小写范围的处理。

bpo-22410 [https://bugs.python.org/issue?@action=redirect&bpo=22410]: re 模块中的模块级函数现在会缓存考虑到区域的依赖于区域设置的编译后的正则表达式。

bpo-22759 [https://bugs.python.org/issue?@action=redirect&bpo=22759]: pathlib.Path() 上的查询方法 (exists(), is_dir() 等) 现在在底层 stat 调用引发 NotADirectoryError 时返回 False。

bpo-8876 [https://bugs.python.org/issue?@action=redirect&bpo=8876]: distutils 现在在硬链接不起作用时回退到复制文件。这允许使用如 VirtualBox 共享文件夹这样的特殊文件系统。

bpo-22217 [https://bugs.python.org/issue?@action=redirect&bpo=22217]: 实现了 zipfile 模块中类的 reprs。

bpo-22457 [https://bugs.python.org/issue?@action=redirect&bpo=22457]: 在发现的 start_dir 中尊重 load_tests。

bpo-18216 [https://bugs.python.org/issue?@action=redirect&bpo=18216]: gettext 现在在 .mo 文件有不受支持的主版本号时引发错误。由 Aaron Hill 提供补丁。

bpo-13918 [https://bugs.python.org/issue?@action=redirect&bpo=13918]: 提供了一个 locale.delocalize() 函数，可以从表示数字的字符串中移除区域特定的数字格式，而不将其转换为特定类型。由 Cédric Krier 提供补丁。

bpo-22676 [https://bugs.python.org/issue?@action=redirect&bpo=22676]: 使没有 __module__ 属性的全局对象的序列化不那么慢。

bpo-18853 [https://bugs.python.org/issue?@action=redirect&bpo=18853]: 修复了 shlex.__nain__ 中的 ResourceWarning。

bpo-9351 [https://bugs.python.org/issue?@action=redirect&bpo=9351]: 使用 set_defaults 在 argparse 子解析器上设置的默认值不再在父解析器上也设置时被忽略。

bpo-7559 [https://bugs.python.org/issue?@action=redirect&bpo=7559]: unittest 测试加载时的 ImportErrors 现在会在导入失败后作为导入异常报告，而不是属性错误。

bpo-19746 [https://bugs.python.org/issue?@action=redirect&bpo=19746]: Make it possible to examine the errors from unittest discovery without executing the test suite. The new errors attribute on TestLoader exposes these non-fatal errors encountered during discovery.

bpo-21991 [https://bugs.python.org/issue?@action=redirect&bpo=21991]: 使 email.headerregistry 的头 'params' 属性变为只读（MappingProxyType）。之前字典是可修改的，但每次访问属性时都会创建一个新的字典。

bpo-22638 [https://bugs.python.org/issue?@action=redirect&bpo=22638]: 现在整个标准库中 SSLv3 已被禁用。仍然可以通过手动实例化 SSLContext 来启用它。

bpo-22641 [https://bugs.python.org/issue?@action=redirect&bpo=22641]: 在 asyncio 中，客户端连接的默认 SSL 上下文现在使用 ssl.create_default_context() 创建，以提高安全性。

bpo-17401 [https://bugs.python.org/issue?@action=redirect&bpo=17401]: 在 io.FileIO 的 repr 中包含 closefd。

bpo-21338 [https://bugs.python.org/issue?@action=redirect&bpo=21338]: 为 compileall 添加静默模式。compile_{dir, file, path} 函数的 quiet 参数现在具有多级值。此外，CLI 的 -q 选项现在也具有多级值。由 Thomas Kluyver 提供补丁。

bpo-20152 [https://bugs.python.org/issue?@action=redirect&bpo=20152]: 将 array 和 cmath 模块转换为 Argument Clinic。

bpo-18643 [https://bugs.python.org/issue?@action=redirect&bpo=18643]: 在 Windows 上添加 socket.socketpair()。

bpo-22435 [https://bugs.python.org/issue?@action=redirect&bpo=22435]: 修复 socketserver 绑定失败时的文件描述符泄漏问题。

bpo-13096 [https://bugs.python.org/issue?@action=redirect&bpo=13096]: 修复了 CTypes POINTER 处理大值时出现的段错误。

bpo-11694 [https://bugs.python.org/issue?@action=redirect&bpo=11694]: 如文档所述，在 xdrlib 中引发 ConversionError。由 Filip Gruszczyński 和 Claudiu Popa 提供补丁。

bpo-19380 [https://bugs.python.org/issue?@action=redirect&bpo=19380]: 优化了正则表达式的解析。

bpo-1519638 [https://bugs.python.org/issue?@action=redirect&bpo=1519638]: 现在在 re.sub() 和 re.subn() 中，未匹配的组将被空字符串替换。

bpo-18615 [https://bugs.python.org/issue?@action=redirect&bpo=18615]: sndhdr.what/whathdr 现在返回一个 namedtuple。

bpo-22462 [https://bugs.python.org/issue?@action=redirect&bpo=22462]: 修复 pyexpat 创建虚拟帧以使其出现在异常回溯中的问题。

bpo-21965 [https://bugs.python.org/issue?@action=redirect&bpo=21965]: 为 ssl 模块添加对内存中 SSL 的支持。由 Geert Jansen 提供补丁。

bpo-21173 [https://bugs.python.org/issue?@action=redirect&bpo=21173]: 修复了在调用.clear()时有迭代器存活时，对WeakKeyDictionary的len()操作的问题。

bpo-11866 [https://bugs.python.org/issue?@action=redirect&bpo=11866]: 消除了新线程名称计算中的竞态条件。

bpo-21905 [https://bugs.python.org/issue?@action=redirect&bpo=21905]: 在迭代过程中当sys.modules被修改时，避免pickle.whichmodule()中的RuntimeError。由Olivier Grisel提供补丁。

bpo-11271 [https://bugs.python.org/issue?@action=redirect&bpo=11271]: concurrent.futures.Executor.map()现在接受一个 chunksize 参数，允许在子进程中批量处理任务并提高ProcessPoolExecutor的性能。由Dan O'Reilly提供补丁。

bpo-21883 [https://bugs.python.org/issue?@action=redirect&bpo=21883]: os.path.join()和os.path.relpath()现在对于不支持或参数类型不匹配的情况，会抛出带有更有帮助的错误信息的TypeError。

bpo-22219 [https://bugs.python.org/issue?@action=redirect&bpo=22219]: zipfile模块的命令行接口现在为ZIP文件中的目录（包括空目录）添加条目。

bpo-22449 [https://bugs.python.org/issue?@action=redirect&bpo=22449]: 在ssl.SSLContext.load_default_certs中，在Windows上查询环境变量SSL_CERT_DIR和SSL_CERT_FILE。

bpo-22508 [https://bugs.python.org/issue?@action=redirect&bpo=22508]: 移除了email.__version__变量；email代码不再与标准库分开提供，并且__version__在多个版本中未更新。

bpo-20076 [https://bugs.python.org/issue?@action=redirect&bpo=20076]: 向语言环境别名表添加了非派生的UTF-8别名。

bpo-20079 [https://bugs.python.org/issue?@action=redirect&bpo=20079]: 向语言环境别名表添加了glibc 2.18支持的语言环境。

bpo-20218 [https://bugs.python.org/issue?@action=redirect&bpo=20218]: 向pathlib.Path对象添加了便利方法read_text/write_text和read_bytes/write_bytes。

bpo-22396 [https://bugs.python.org/issue?@action=redirect&bpo=22396]: 在32位AIX平台上，不暴露os.posix_fadvise()和os.posix_fallocate()，因为它们在系统头文件中的原型是错误的。

bpo-22517 [https://bugs.python.org/issue?@action=redirect&bpo=22517]: 当io.BufferedRWPair对象被析构时，清除其弱引用。

bpo-22437 [https://bugs.python.org/issue?@action=redirect&bpo=22437]: 正则表达式中的捕获组数量不再限制为100。

bpo-17442 [https://bugs.python.org/issue?@action=redirect&bpo=17442]: InteractiveInterpreter现在在其showtraceback方法中显示完整的链式回溯，以匹配内置的交互式解释器。

bpo-23392 [https://bugs.python.org/issue?@action=redirect&bpo=23392]: 添加了与FILE*一起工作的marshal C API的测试。

bpo-10510 [https://bugs.python.org/issue?@action=redirect&bpo=10510]: distutils的register和upload方法现在使用符合HTML标准的CRLF行尾。

bpo-9850 [https://bugs.python.org/issue?@action=redirect&bpo=9850]: 修复了macpath.join()对于空的第一组件的问题。由Oleg Oshmyan提供补丁。

bpo-5309 [https://bugs.python.org/issue?@action=redirect&bpo=5309]: distutils的build和build_ext命令现在接受一个 -j 选项以启用扩展模块的并行构建。

bpo-22448 [https://bugs.python.org/issue?@action=redirect&bpo=22448]: 改进取消的定时器句柄清理以防止无限制的内存使用。补丁由Joshua Moore-Oliva提供。

bpo-22427 [https://bugs.python.org/issue?@action=redirect&bpo=22427]: 当在生成器中使用with语句时，TemporaryDirectory不再尝试两次清理。

bpo-22362 [https://bugs.python.org/issue?@action=redirect&bpo=22362]: 禁止在正则表达式中使用超出0-0o377范围的模糊八进制转义。

bpo-20912 [https://bugs.python.org/issue?@action=redirect&bpo=20912]: 现在添加到ZIP文件的目录具有正确的Unix和MS-DOS目录属性。

bpo-21866 [https://bugs.python.org/issue?@action=redirect&bpo=21866]: 如果allowZip64为false，ZipFile.close()不再写入ZIP64中央目录记录。

bpo-22278 [https://bugs.python.org/issue?@action=redirect&bpo=22278]: 修复了urljoin在处理相对URL时的问题，这是在提交issue22118的更改后观察到的回归。

bpo-22415 [https://bugs.python.org/issue?@action=redirect&bpo=22415]: 修复了re模块中GROUPREF_EXISTS操作码的调试输出。移除了调试输出中的尾随空格。

bpo-22423 [https://bugs.python.org/issue?@action=redirect&bpo=22423]: 线程中的未处理异常不再导致当sys.stderr为None时未处理的AttributeError。

bpo-21332 [https://bugs.python.org/issue?@action=redirect&bpo=21332]: 确保subprocess.Popen()中的 bufsize=1 选择行缓冲，而不是块缓冲。由Akira Li提供补丁。

bpo-21091 [https://bugs.python.org/issue?@action=redirect&bpo=21091]: 修复API错误：email.message.EmailMessage.is_attachment现在是一个方法。

bpo-21079 [https://bugs.python.org/issue?@action=redirect&bpo=21079]: 修复email.message.EmailMessage.is_attachment以在头部既有参数又有值时返回正确的结果。

bpo-22247 [https://bugs.python.org/issue?@action=redirect&bpo=22247]: 将NNTPError添加到nntplib.__all__。

bpo-22366 [https://bugs.python.org/issue?@action=redirect&bpo=22366]: urllib.request.urlopen将接受一个上下文对象（SSLContext）作为参数，该对象将用于HTTPS连接。由Alex Gaynor提供补丁。

bpo-4180 [https://bugs.python.org/issue?@action=redirect&bpo=4180]: 当过滤器被修改时，警告注册表现在被重置。

bpo-22419 [https://bugs.python.org/issue?@action=redirect&bpo=22419]: 限制 wsgiref 服务器中传入 HTTP 请求的长度为 65536 字节，对于超出此长度的请求发送 414 错误代码。由 Devin Cook 提供补丁。

http.cookies 中的宽松 cookie 解析在与某些网页浏览器的非标准 cookie 处理结合使用时可能成为安全问题。由 Sergey Bobrov 报告。

bpo-20537 [https://bugs.python.org/issue?@action=redirect&bpo=20537]: 日志记录方法现在接受异常实例以及布尔值或异常元组。感谢 Yury Selivanov 提供的补丁。

bpo-22384 [https://bugs.python.org/issue?@action=redirect&bpo=22384]: 当使用 pythonw.exe 运行时，Tkinter 回调中的异常不再导致程序崩溃。

bpo-22168 [https://bugs.python.org/issue?@action=redirect&bpo=22168]: 在 OS X 上使用非默认 Canvas 时防止 turtle 的 AttributeError。

bpo-21147 [https://bugs.python.org/issue?@action=redirect&bpo=21147]: 如果请求包含空字符，sqlite3 现在会引发异常而不是截断它。基于 Victor Stinner 的补丁。

bpo-13968 [https://bugs.python.org/issue?@action=redirect&bpo=13968]: glob 模块现在支持使用 ** 模式在子目录中进行递归搜索。

bpo-21951 [https://bugs.python.org/issue?@action=redirect&bpo=21951]: 修复了在 AIX 上当使用空字符串或元组参数调用 Tcl 命令时 Tkinter 的崩溃问题。

bpo-21951 [https://bugs.python.org/issue?@action=redirect&bpo=21951]: 如果内存分配失败，Tkinter 现在更可能引发 MemoryError 而不是崩溃。

bpo-22338 [https://bugs.python.org/issue?@action=redirect&bpo=22338]: 修复了 json 模块在内存分配失败时的崩溃问题。

bpo-12410 [https://bugs.python.org/issue?@action=redirect&bpo=12410]: imaplib.IMAP4 现在支持上下文管理协议。原始由 Tarek Ziadé 提供补丁。

bpo-21270 [https://bugs.python.org/issue?@action=redirect&bpo=21270]: 我们现在在 mock.call 对象中覆盖元组方法，以便它们可以用作普通的调用属性。

bpo-16662 [https://bugs.python.org/issue?@action=redirect&bpo=16662]: load_tests() is now unconditionally run when it is present in a package's __init__.py. TestLoader.loadTestsFromModule() still accepts use_load_tests, but it is deprecated and ignored. A new keyword-only attribute pattern is added and documented. Patch given by Robert Collins, tweaked by Barry Warsaw.

bpo-22226 [https://bugs.python.org/issue?@action=redirect&bpo=22226]: Treeview.heading() 的结果中 "status" 键的第一个字母不再被剥离。

bpo-19524 [https://bugs.python.org/issue?@action=redirect&bpo=19524]: 修复了在接收到无效响应时HTTP连接的资源泄漏问题。由Martin Panter提供补丁。

bpo-20421 [https://bugs.python.org/issue?@action=redirect&bpo=20421]: 向SSL套接字添加了.version()方法，暴露实际使用的协议版本。

bpo-19546 [https://bugs.python.org/issue?@action=redirect&bpo=19546]: configparser异常不再暴露实现细节。移除了链式KeyErrors，使得跟踪回溯更加清晰。由Claudiu Popa提供补丁。

bpo-22051 [https://bugs.python.org/issue?@action=redirect&bpo=22051]: turtledemo不再重新加载示例来重新运行它们。变量初始化和GUI设置应该在main()中完成，每次运行演示时都会调用main()，但不会在导入时调用。

bpo-21933 [https://bugs.python.org/issue?@action=redirect&bpo=21933]: Turtledemo用户可以通过菜单选择或控制(command) '-'或'+'或控制鼠标滚轮来更改代码字体大小。原始由Lita Cho提供补丁。

bpo-21597 [https://bugs.python.org/issue?@action=redirect&bpo=21597]: 现在可以通过鼠标抓取和拖动turtledemo文本窗格和绘图画布之间的分隔符。可以加宽代码文本窗格以便轻松查看或复制文本的完整宽度。在小屏幕上可以加宽画布。原始由Jan Kanis和Lita Cho提供补丁。

bpo-18132 [https://bugs.python.org/issue?@action=redirect&bpo=18132]: 当窗口缩小时，Turtledemo按钮不再消失。原始由Jan Kanis和Lita Cho提供补丁。

bpo-22043 [https://bugs.python.org/issue?@action=redirect&bpo=22043]: time.monotonic()现在总是可用。threading.Lock.acquire()、``threading.RLock.acquire()``和套接字操作现在在使用超时时使用单调时钟，而不是系统时钟。

bpo-21527 [https://bugs.python.org/issue?@action=redirect&bpo=21527]: 向ThreadPoolExecutor添加了默认的工作线程数，等于CPU数量的5倍。由Claudiu Popa提供补丁。

bpo-22216 [https://bugs.python.org/issue?@action=redirect&bpo=22216]: smtplib现在在退出后更完全地重置其状态。之前行为的最明显后果是在connect/starttls/quit/connect/starttls序列中的STARTTLS失败。

bpo-22098 [https://bugs.python.org/issue?@action=redirect&bpo=22098]: ctypes的BigEndianStructure和LittleEndianStructure现在定义了一个空的__slots__，这样子类不会总是得到一个实例字典。由Claudiu Popa提供补丁。

bpo-22185 [https://bugs.python.org/issue?@action=redirect&bpo=22185]: 修复了threading.Condition.wait()中因不持有锁而修改等待队列导致的偶尔出现的RuntimeError。由Doug Zongker提供补丁。

bpo-22287 [https://bugs.python.org/issue?@action=redirect&bpo=22287]: 在UNIX上，_PyTime_gettimeofday()现在使用clock_gettime(CLOCK_REALTIME)（如果可用）。作为副作用，Python现在在Solaris和Linux上（仅glibc版本低于2.17时）依赖于librt库。

bpo-22182 [https://bugs.python.org/issue?@action=redirect&bpo=22182]: 在distutils.file_util.move_file中正确使用e.args来解包异常。由Claudiu Popa提供补丁。

webbrowser模块现在使用subprocess的start_new_session=True，而不是潜在风险的preexec_fn=os.setsid调用。

bpo-22042 [https://bugs.python.org/issue?@action=redirect&bpo=22042]: 如果文件描述符处于阻塞模式，signal.set_wakeup_fd(fd)现在会引发异常。

bpo-16808 [https://bugs.python.org/issue?@action=redirect&bpo=16808]: inspect.stack()现在返回一个命名元组而不是元组。由Daniel Shahaf提供补丁。

bpo-22236 [https://bugs.python.org/issue?@action=redirect&bpo=22236]: 修复了在NoDefaultRoot模式下的Tkinter图像复制操作。

bpo-2527 [https://bugs.python.org/issue?@action=redirect&bpo=2527]: 向timeit函数添加了一个 globals 参数，以便覆盖执行定时代码的全局命名空间。补丁由Ben Roberts提供。

bpo-22118 [https://bugs.python.org/issue?@action=redirect&bpo=22118]: 将urllib.parse切换到使用RFC 3986语义解析相对URL，而不是RFCs 1808和2396。补丁由Demian Brecht提供。

bpo-21549 [https://bugs.python.org/issue?@action=redirect&bpo=21549]: 向TarFile.list()添加了“members”参数。

bpo-19628 [https://bugs.python.org/issue?@action=redirect&bpo=19628]: 允许通过-r选项指定compileall的递归深度。

bpo-15696 [https://bugs.python.org/issue?@action=redirect&bpo=15696]: 为Windows上的mmap对象添加了__sizeof__实现。

bpo-22068 [https://bugs.python.org/issue?@action=redirect&bpo=22068]: 避免了Tkinter中Variables和Fonts的引用循环。

bpo-22165 [https://bugs.python.org/issue?@action=redirect&bpo=22165]: SimpleHTTPRequestHandler现在支持不可解码的文件名。

bpo-15381 [https://bugs.python.org/issue?@action=redirect&bpo=15381]: 优化了io.BytesIO中的行读取。

bpo-8797 [https://bugs.python.org/issue?@action=redirect&bpo=8797]: 在基本认证失败时立即引发HTTPError。初始由Sam Bull提供补丁。

bpo-20729 [https://bugs.python.org/issue?@action=redirect&bpo=20729]: 恢复了mailbox模块中lazy iterkeys()/itervalues()/iteritems()的使用。

bpo-21448 [https://bugs.python.org/issue?@action=redirect&bpo=21448]: Changed FeedParser feed() to avoid O(N²) behavior when parsing long line. Original patch by Raymond Hettinger.

bpo-22184 [https://bugs.python.org/issue?@action=redirect&bpo=22184]: 当用户忘记必需的参数时，functools LRU Cache装饰器工厂现在会提供更早更清晰的错误信息。

bpo-17923 [https://bugs.python.org/issue?@action=redirect&bpo=17923]: 在AIX上，以斜杠结尾的glob()模式不再匹配非目录。基于Delhallt的补丁。

bpo-21725 [https://bugs.python.org/issue?@action=redirect&bpo=21725]: 在smtpd中添加了对RFC 6531（SMTPUTF8）的支持。

bpo-22176 [https://bugs.python.org/issue?@action=redirect&bpo=22176]: 将ctypes模块的libffi更新到v3.1。此版本增加了对Linux AArch64和POWERPC ELF ABIv2小端架构的支持。

bpo-5411 [https://bugs.python.org/issue?@action=redirect&bpo=5411]: 在shutil模块中添加了对"xztar"格式的支持。

bpo-21121 [https://bugs.python.org/issue?@action=redirect&bpo=21121]: 不再强制第三方C扩展使用-Werror=declaration-after-statement构建。

bpo-21975 [https://bugs.python.org/issue?@action=redirect&bpo=21975]: 修复了使用未初始化的sqlite3.Row（特别是在解pickle pickled sqlite3.Row时）时的崩溃问题。sqlite3.Row现在在__new__()方法中初始化。

bpo-20170 [https://bugs.python.org/issue?@action=redirect&bpo=20170]: 将posixmodule转换为使用Argument Clinic。

bpo-21539 [https://bugs.python.org/issue?@action=redirect&bpo=21539]: Add an exists_ok argument to Pathlib.mkdir() to mimic mkdir -p and os.makedirs() functionality. When true, ignore FileExistsErrors. Patch by Berker Peksag.

bpo-22127 [https://bugs.python.org/issue?@action=redirect&bpo=22127]: 在socket模块中绕过IDNA处理纯ASCII主机名（特别是数字IP）。

bpo-21047 [https://bugs.python.org/issue?@action=redirect&bpo=21047]: 将HTMLParser的 convert_charrefs 参数的默认值设置为True。由Berker Peksag提供补丁。

在 html.entities 包中增加 __all__ 变量。

bpo-15114 [https://bugs.python.org/issue?@action=redirect&bpo=15114]: HTMLParser的严格模式和参数，HTMLParser.error，以及HTMLParserError异常已被移除。

bpo-22085 [https://bugs.python.org/issue?@action=redirect&bpo=22085]: 在Tkinter中放弃了对Tk 8.3的支持。

bpo-21580 [https://bugs.python.org/issue?@action=redirect&bpo=21580]: 现在Tkinter正确处理传递给Tk的字节参数。特别是这允许从二进制数据初始化图像。

bpo-22003 [https://bugs.python.org/issue?@action=redirect&bpo=22003]: 当从字节对象初始化时，io.BytesIO()现在延迟复制直到它被修改，从而在某些用例中提高了性能和内存使用。由David Wilson提供补丁。

bpo-22018 [https://bugs.python.org/issue?@action=redirect&bpo=22018]: 在Windows上，signal.set_wakeup_fd()现在也支持套接字。一个副作用是Python依赖于WinSock库。

bpo-22054 [https://bugs.python.org/issue?@action=redirect&bpo=22054]: 添加 os.get_blocking() 和 os.set_blocking() 函数以获取和设置文件描述符的阻塞模式（如果设置了 O_NONBLOCK 标志则为 False，否则为 True）。这些函数在 Windows 上不可用。

bpo-17172 [https://bugs.python.org/issue?@action=redirect&bpo=17172]: 即使在通过子进程运行时，也使 turtledemo 在 OS X 上作为活动状态启动。补丁由 Lita Cho 提供。

bpo-21704 [https://bugs.python.org/issue?@action=redirect&bpo=21704]: 当信号量不可用时，修复 _multiprocessing 的构建错误。由 Arfrever Frehtes Taifersar Arahesis 提供补丁。

bpo-20173 [https://bugs.python.org/issue?@action=redirect&bpo=20173]: 将 sha1、sha256、sha512 和 md5 转换为 ArgumentClinic。由 Vajrasky Kok 提供补丁。

修复 Windows 64 位上的 repr(_socket.socket)：不要在关闭的套接字上因 OverflowError 而失败。repr(socket.socket) 已经工作良好。

bpo-22033 [https://bugs.python.org/issue?@action=redirect&bpo=22033]: 大多数 Python 实现的类的 repr 现在包含实际的类名而不是硬编码的名称。

bpo-21947 [https://bugs.python.org/issue?@action=redirect&bpo=21947]: dis 模块现在可以根据 generator-iterator 对象的 gi_code 属性对其进行反汇编。由 Clement Rouault 提供补丁。

bpo-16133 [https://bugs.python.org/issue?@action=redirect&bpo=16133]: asynchat.async_chat.handle_read() 方法现在忽略 BlockingIOError 异常。

bpo-22044 [https://bugs.python.org/issue?@action=redirect&bpo=22044]: 修复了 call_tzinfo_method 中的过早 DECREF。由 Tom Flanagan 提供补丁。

bpo-19884 [https://bugs.python.org/issue?@action=redirect&bpo=19884]: readline：如果标准输出不是终端，则禁用元修饰键，以避免将 ANSI 序列 "\033[1034h" 写入标准输出。此序列用于某些终端（例如：TERM=xterm-256color）以启用 8 位字符支持。

bpo-4350 [https://bugs.python.org/issue?@action=redirect&bpo=4350]: 移除了许多长期过时且不工作的 Tkinter 方法。

bpo-6167 [https://bugs.python.org/issue?@action=redirect&bpo=6167]: Scrollbar.activate() 现在在未指定参数时返回活动元素的名称。Scrollbar.set() 现在总是只接受 2 个参数。

bpo-15275 [https://bugs.python.org/issue?@action=redirect&bpo=15275]: 清理并加速 ntpath 模块。

bpo-21888 [https://bugs.python.org/issue?@action=redirect&bpo=21888]: plistlib 的 load() 和 loads() 现在在指定 fmt 参数时可以工作。

bpo-22032 [https://bugs.python.org/issue?@action=redirect&bpo=22032]: 现在总是使用 __qualname__ 而不是 __name__ 来格式化 Python 实现的类的完全限定类名。

bpo-22031 [https://bugs.python.org/issue?@action=redirect&bpo=22031]: 当包含形如" at 0x..."的id时，Reprs现在总是使用带有"0x"前缀的十六进制格式。

bpo-22018 [https://bugs.python.org/issue?@action=redirect&bpo=22018]: signal.set_wakeup_fd()现在在 fstat() 失败时引发OSError而不是ValueError。

bpo-21044 [https://bugs.python.org/issue?@action=redirect&bpo=21044]: tarfile.open()现在可以处理具有整数'name'属性的fileobj。基于Antoine Pietri的补丁。

bpo-21966 [https://bugs.python.org/issue?@action=redirect&bpo=21966]: 当运行代码模块时，尊重-q命令行选项。

bpo-19076 [https://bugs.python.org/issue?@action=redirect&bpo=19076]: 不再向self.error()传递冗余的'file'参数。

bpo-16382 [https://bugs.python.org/issue?@action=redirect&bpo=16382]: 改进了warnings.warn()对于错误类别的异常消息。初始由Phil Elson提供补丁。

bpo-21932 [https://bugs.python.org/issue?@action=redirect&bpo=21932]: os.read()现在使用 Py_ssize_t() 类型而不是 int 来支持一次性读取超过2GB的数据。在Windows上，大小被截断为INT_MAX。如同任何对os.read()的调用，操作系统可能读取的字节数少于请求的字节数。

bpo-21942 [https://bugs.python.org/issue?@action=redirect&bpo=21942]: 修复了Windows上pydoc服务器模式下查看源文件的问题。

bpo-11259 [https://bugs.python.org/issue?@action=redirect&bpo=11259]: asynchat.async_chat().set_terminator()现在如果接收到的字节数为负值时会引发ValueError。

bpo-12523 [https://bugs.python.org/issue?@action=redirect&bpo=12523]: asynchat.async_chat.push()现在如果没有接收到字节字符串时会引发TypeError。

bpo-21707 [https://bugs.python.org/issue?@action=redirect&bpo=21707]: 向ModuleFinder.replace_paths_in_code()添加了缺失的kwonlyargcount参数。

bpo-20639 [https://bugs.python.org/issue?@action=redirect&bpo=20639]: 调用Path.with_suffix('')允许再次移除后缀。由July Tikhonov提供补丁。

bpo-21714 [https://bugs.python.org/issue?@action=redirect&bpo=21714]: 禁止使用Path.with_name()构造无效路径。原始由Antony Lee提供补丁。

bpo-15014 [https://bugs.python.org/issue?@action=redirect&bpo=15014]: 向smtplib添加了'auth'方法以使实现认证机制更简单，并在login方法内部使用它。

bpo-21151 [https://bugs.python.org/issue?@action=redirect&bpo=21151]: 修复了当向SetValueEx传递 None 作为 REG_BINARY 值时winreg模块中的段错误。由John Ehresman提供补丁。

bpo-21090 [https://bugs.python.org/issue?@action=redirect&bpo=21090]: io.FileIO.readall()不再忽略I/O错误。在此之前，如果至少第一次C调用read()成功，它会忽略I/O错误。

bpo-5800 [https://bugs.python.org/issue?@action=redirect&bpo=5800]: wsgiref.headers.Headers 的 headers 参数现在是可选的。初始由 Pablo Torres Navarrete 和 SilentGhost 提供补丁。

bpo-21781 [https://bugs.python.org/issue?@action=redirect&bpo=21781]: ssl.RAND_add() 现在支持超过 2 GB 的字符串。

bpo-21679 [https://bugs.python.org/issue?@action=redirect&bpo=21679]: 防止在 open() 过程中进行多余的 fstat() 调用。由 Bohuslav Kabrda 提供补丁。

bpo-21863 [https://bugs.python.org/issue?@action=redirect&bpo=21863]: cProfile 现在除了显示 C 扩展函数的名称外，还会显示其模块名。

bpo-11453 [https://bugs.python.org/issue?@action=redirect&bpo=11453]: asyncore: 当未关闭的 file_wrapper 对象被销毁时发出 ResourceWarning。现在析构函数会在需要时关闭文件。close() 方法现在可以被调用两次：第二次调用不做任何操作。

bpo-21858 [https://bugs.python.org/issue?@action=redirect&bpo=21858]: 在 sqlite3 模块中更好地处理 Python 异常。

bpo-21476 [https://bugs.python.org/issue?@action=redirect&bpo=21476]: 确保 email.parser.BytesParser TextIOWrapper 在解析后被丢弃，这样输入文件不会意外关闭。

bpo-20295 [https://bugs.python.org/issue?@action=redirect&bpo=20295]: imghdr 现在可以识别 OpenEXR 格式的图像。

bpo-21729 [https://bugs.python.org/issue?@action=redirect&bpo=21729]: 在 dbm.dumb 模块中使用 "with" 语句确保文件关闭。补丁由 Claudiu Popa 提供。

bpo-21491 [https://bugs.python.org/issue?@action=redirect&bpo=21491]: socketserver: 修复子进程回收中的一个竞争条件。

bpo-21719 [https://bugs.python.org/issue?@action=redirect&bpo=21719]: 在 Windows 上为 os.stat_result 添加了 st_file_attributes 字段。

bpo-21832 [https://bugs.python.org/issue?@action=redirect&bpo=21832]: 要求命名元组的输入必须是确切的字符串。

bpo-21722 [https://bugs.python.org/issue?@action=redirect&bpo=21722]: distutils 的 "upload" 命令现在在上传失败时以非零返回码退出。由 Martin Dengler 提供补丁。

bpo-21723 [https://bugs.python.org/issue?@action=redirect&bpo=21723]: asyncio.Queue: 支持任何类型的数字（例如浮点数）作为最大大小。补丁由 Vajrasky Kok 编写。

bpo-21711 [https://bugs.python.org/issue?@action=redirect&bpo=21711]: 现在已从 site 模块中移除了对 "site-python" 目录的支持（已在 3.4 中弃用）。

bpo-17552 [https://bugs.python.org/issue?@action=redirect&bpo=17552]: 新的 socket.sendfile() 方法允许通过 UNIX 上的高性能 os.sendfile() 发送文件。由 Giampaolo Rodola' 提供补丁。

bpo-18039 [https://bugs.python.org/issue?@action=redirect&bpo=18039]: dbm.dump.open() 现在当标志值为 'n' 时总是创建一个新的数据库。由 Claudiu Popa 提供补丁。

bpo-21326 [https://bugs.python.org/issue?@action=redirect&bpo=21326]: 向asyncio.BaseEventLoop添加了一个新的is_closed()方法。如果事件循环已关闭，asyncio.BaseEventLoop的run_forever()和run_until_complete()方法现在会抛出异常。

bpo-21766 [https://bugs.python.org/issue?@action=redirect&bpo=21766]: 通过在检查路径是否为CGI脚本之前对路径进行URL解码，防止了CGIHTTPServer中的安全漏洞。

bpo-21310 [https://bugs.python.org/issue?@action=redirect&bpo=21310]: 修复了在open()失败时可能发生的资源泄漏问题。

bpo-21256 [https://bugs.python.org/issue?@action=redirect&bpo=21256]: 在模拟函数调用中，关键字参数的打印输出现在按确定性顺序进行。这将有助于编写更好的文档测试。

bpo-21677 [https://bugs.python.org/issue?@action=redirect&bpo=21677]: 修复了在io close()方法中链接非规范化异常的问题。

bpo-11709 [https://bugs.python.org/issue?@action=redirect&bpo=11709]: 修复了pydoc.help函数在sys.stdin不是有效文件时不失败的问题。

bpo-21515 [https://bugs.python.org/issue?@action=redirect&bpo=21515]: tempfile.TemporaryFile现在在可用时使用os.O_TMPFILE标志。

bpo-13223 [https://bugs.python.org/issue?@action=redirect&bpo=13223]: 修复了pydoc.writedoc，使得在示例代码中使用'self'的方法的HTML文档能够正确生成。

bpo-21463 [https://bugs.python.org/issue?@action=redirect&bpo=21463]: 在urllib.request中，修复了FTP缓存的修剪问题。

bpo-21618 [https://bugs.python.org/issue?@action=redirect&bpo=21618]: subprocess模块现在能够关闭调用进程继承的打开文件描述符，即使这些描述符已经高于POSIX资源限制所允许的值。在具有正常工作的/proc/self/fd或/dev/fd接口的系统上，现在忽略最大值并关闭所有文件描述符。

bpo-20383 [https://bugs.python.org/issue?@action=redirect&bpo=20383]: 引入了importlib.util.module_from_spec()作为创建新模块的首选方式。

bpo-21552 [https://bugs.python.org/issue?@action=redirect&bpo=21552]: 修复了在64位平台上，tkinter模块中过长的字符串长度可能导致整数溢出的问题。

bpo-14315 [https://bugs.python.org/issue?@action=redirect&bpo=14315]: zipfile模块现在会忽略中央目录中太短而无法解析的额外字段，而不是让struct.unpack错误冒泡，因为这种“坏数据”在现实世界的许多zip文件中出现，并被其他zip工具忽略。

bpo-13742 [https://bugs.python.org/issue?@action=redirect&bpo=13742]: 向heapq.merge()添加了“key”和“reverse”参数。（补丁的第一版由Simon Sapin贡献。）

bpo-21402 [https://bugs.python.org/issue?@action=redirect&bpo=21402]: 当未设置默认根窗口时，tkinter.ttk现在可以正常工作。

bpo-3015 [https://bugs.python.org/issue?@action=redirect&bpo=3015]: _tkinter.create() now creates tkapp object with wantobject=1 by default.

bpo-10203 [https://bugs.python.org/issue?@action=redirect&bpo=10203]: sqlite3.Row 现在真正支持序列协议，特别是它支持 reverse() 和负索引。原始补丁由 Claudiu Popa 提供。

bpo-18807 [https://bugs.python.org/issue?@action=redirect&bpo=18807]: 如果为 venv 指定了复制（无符号链接），则现在通过复制而非符号链接创建 python 解释器别名（python, python3）。

bpo-20197 [https://bugs.python.org/issue?@action=redirect&bpo=20197]: 在 imghdr 模块中添加了对 WebP 图像类型的支持。由 Fabrice Aneche 和 Claudiu Popa 提供补丁。

bpo-21513 [https://bugs.python.org/issue?@action=redirect&bpo=21513]: 加速了 IP 地址（IPv4Address, IPv6Address）的一些属性，如 .is_private 或 .is_multicast。

bpo-21137 [https://bugs.python.org/issue?@action=redirect&bpo=21137]: 通过显示“锁定”或“未锁定”状态改进了 threading.Lock() 及其变体的 repr。补丁由 Berker Peksag 提供。

bpo-21538 [https://bugs.python.org/issue?@action=redirect&bpo=21538]: plistlib 模块现在支持在引用或偏移大小不是二的幂时加载二进制 plist 文件。

bpo-21455 [https://bugs.python.org/issue?@action=redirect&bpo=21455]: 为 socket.listen() 添加了一个默认的 backlog。

bpo-21525 [https://bugs.python.org/issue?@action=redirect&bpo=21525]: 大多数接受元组的 Tkinter 方法现在也接受列表。

bpo-22166 [https://bugs.python.org/issue?@action=redirect&bpo=22166]: 在新内部 _codecs._forget_codec 辅助函数的帮助下，test_codecs 现在清除编码缓存以避免出现引用泄露。

bpo-22236 [https://bugs.python.org/issue?@action=redirect&bpo=22236]: Tkinter 测试现在不再重用默认的根窗口。为每个测试类创建新的根窗口。

bpo-10744 [https://bugs.python.org/issue?@action=redirect&bpo=10744]: 修复具有非平凡形状的 ctypes 对象上的 PEP 3118 [https://www.python.org/dev/peps/pep-3118] 格式字符串。

bpo-20826 [https://bugs.python.org/issue?@action=redirect&bpo=20826]: 优化 ipaddress.collapse_addresses()。

bpo-21487 [https://bugs.python.org/issue?@action=redirect&bpo=21487]: 优化 ipaddress.summarize_address_range() 和 ipaddress.{IPv4Network,IPv6Network}.subnets()。

bpo-21486 [https://bugs.python.org/issue?@action=redirect&bpo=21486]: 优化 ipaddress.IPv4Network 和 ipaddress.IPv6Network 中网络掩码的解析。

bpo-13916 [https://bugs.python.org/issue?@action=redirect&bpo=13916]: 禁止了非 UTF-* 编码的 surrogatepass 错误处理器。

bpo-20998 [https://bugs.python.org/issue?@action=redirect&bpo=20998]: 修复了忽略大小写的重复单字符模式的 re.fullmatch()。原始由 Matthew Barnett 提供补丁。

bpo-21075 [https://bugs.python.org/issue?@action=redirect&bpo=21075]: 如果指定了二进制模式，fileinput.FileInput 现在可以从标准流中读取字节。由 Sam Kimbrel 提供补丁。

bpo-19775 [https://bugs.python.org/issue?@action=redirect&bpo=19775]: 向 pathlib Path 对象添加 samefile() 方法。初始由 Vajrasky Kok 提供补丁。

bpo-21226 [https://bugs.python.org/issue?@action=redirect&bpo=21226]: 在 PyImport_ExecCodeModuleObject（及其相关函数）中正确设置模块。

bpo-21398 [https://bugs.python.org/issue?@action=redirect&bpo=21398]: 修复 pydoc 分页器中的一个 unicode 错误，当文档包含无法编码为标准输出编码的字符时。

bpo-16531 [https://bugs.python.org/issue?@action=redirect&bpo=16531]: ipaddress.IPv4Network 和 ipaddress.IPv6Network 现在接受一个（地址，网络掩码）元组参数，以便从现有地址轻松构建网络对象。

bpo-21156 [https://bugs.python.org/issue?@action=redirect&bpo=21156]: importlib.abc.InspectLoader.source_to_code() 现在是一个静态方法。

bpo-21424 [https://bugs.python.org/issue?@action=redirect&bpo=21424]: 简化和优化了 heapq.nlargest() 和 nsmallest()，以减少元组比较的次数。

bpo-21396 [https://bugs.python.org/issue?@action=redirect&bpo=21396]: 修复 TextIOWrapper(..., write_through=True) 不强制底层二进制流 flush() 的问题。由 akira 提供补丁。

bpo-18314 [https://bugs.python.org/issue?@action=redirect&bpo=18314]: 在 Windows 上，Unlink 现在可以移除 junctions。由 Kim Gräsman 提供补丁。

bpo-21088 [https://bugs.python.org/issue?@action=redirect&bpo=21088]: 修复 curses.window.addch() 在 3.4.0 版本中的回归问题。在迁移到 Argument Clinic 时，前两个参数被反转了。

bpo-21407 [https://bugs.python.org/issue?@action=redirect&bpo=21407]: _decimal: 模块现在支持函数签名。

bpo-10650 [https://bugs.python.org/issue?@action=redirect&bpo=10650]: 从 Python 版本的 Decimal.quantize() 方法中移除了非标准的 'watchexp' 参数。它从未在 C 版本中出现过。

bpo-21469 [https://bugs.python.org/issue?@action=redirect&bpo=21469]: 通过检查确保 robots.txt 已被读取或不存在，在 can_fetch() 返回 True 之前，减少了 robotparser 中误报的风险。

bpo-19414 [https://bugs.python.org/issue?@action=redirect&bpo=19414]: 让 OrderedDict 将被删除的链接标记为不可用。如果在迭代过程中链接被删除，这会提前失败。

bpo-21421 [https://bugs.python.org/issue?@action=redirect&bpo=21421]: 向 MappingViews ABC 添加 __slots__。由 Josh Rosenberg 提供补丁。

bpo-21101 [https://bugs.python.org/issue?@action=redirect&bpo=21101]: 在 collections.Counter() 的 C 加速代码中消除双重哈希。

bpo-21321 [https://bugs.python.org/issue?@action=redirect&bpo=21321]: itertools.islice() 现在在切片耗尽时会释放对源迭代器的引用。由 Anton Afanasyev 提供补丁。

bpo-21057 [https://bugs.python.org/issue?@action=redirect&bpo=21057]: TextIOWrapper 现在允许底层的二进制流的 read() 或 read1() 方法返回任意的 bytes-like 对象（如 memoryview）。由 Nikolaus Rath 提供补丁。

bpo-20951 [https://bugs.python.org/issue?@action=redirect&bpo=20951]: 在非阻塞套接字上，如果操作会阻塞，SSLSocket.send() 现在会引发 SSLWantReadError 或 SSLWantWriteError。之前，它会返回 0。由 Nikolaus Rath 提供补丁。

bpo-13248 [https://bugs.python.org/issue?@action=redirect&bpo=13248]: 移除了之前弃用的 asyncore.dispatcher __getattr__ 廉价继承 hack。

bpo-9815 [https://bugs.python.org/issue?@action=redirect&bpo=9815]: assertRaises 现在尝试清除异常回溯中对局部变量的引用。

bpo-19940 [https://bugs.python.org/issue?@action=redirect&bpo=19940]: ssl.cert_time_to_seconds() 现在将给定的时间字符串解释为 UTC 时区（如 RFC 5280 所指定），而不是本地时区。

bpo-13204 [https://bugs.python.org/issue?@action=redirect&bpo=13204]: 调用 sys.flags.__new__ 会崩溃解释器，现在它会引发 TypeError。

bpo-19385 [https://bugs.python.org/issue?@action=redirect&bpo=19385]: 对已关闭的 dbm.dumb 数据库的操作现在总是引发相同的异常。

bpo-21207 [https://bugs.python.org/issue?@action=redirect&bpo=21207]: 检测 os.urandom 缓存的 fd 是否被关闭或替换，并重新打开它。

bpo-21291 [https://bugs.python.org/issue?@action=redirect&bpo=21291]: subprocess 的 Popen.wait() 现在是线程安全的，因此多个线程可以同时调用 Popen 实例的 wait() 或 poll() 而不会丢失 Popen.returncode 值。

bpo-21127 [https://bugs.python.org/issue?@action=redirect&bpo=21127]: Path 对象现在可以从 str 子类实例（如 numpy.str_）实例化。

bpo-15002 [https://bugs.python.org/issue?@action=redirect&bpo=15002]: urllib.response 对象使用 _TemporaryFileWrapper（和 _TemporaryFileCloser）设施。提供了一种更好的处理文件描述符关闭的方法。由 Christian Theune 提供补丁。

bpo-12220 [https://bugs.python.org/issue?@action=redirect&bpo=12220]: mindom 现在会引发一个自定义的 ValueError，指示它不支持 URI 中的空格，而不是让 'split' ValueError 冒泡。

bpo-21068 [https://bugs.python.org/issue?@action=redirect&bpo=21068]: ssl.PROTOCOL* 常量现在是枚举成员。

bpo-21276 [https://bugs.python.org/issue?@action=redirect&bpo=21276]: posixmodule: 不要在 KFreeBSD 和 Hurd 上定义 USE_XATTRS。

bpo-21262 [https://bugs.python.org/issue?@action=redirect&bpo=21262]: Mock 的新方法 assert_not_called。如果 mock 被调用过，它会引发 AssertionError。

bpo-21238 [https://bugs.python.org/issue?@action=redirect&bpo=21238]: New keyword argument unsafe to Mock. It raises AttributeError incase of an attribute startswith assert or assret.

bpo-20896 [https://bugs.python.org/issue?@action=redirect&bpo=20896]: ssl.get_server_certificate() 现在使用 PROTOCOL_SSLv23，而不是 PROTOCOL_SSLv3，以获得最大的兼容性。

bpo-21239 [https://bugs.python.org/issue?@action=redirect&bpo=21239]: 当同一个名字被多次 patch 时，patch.stopall() 没有确定性地工作。

bpo-21203 [https://bugs.python.org/issue?@action=redirect&bpo=21203]: 更新了 fileConfig 和 dictConfig 以消除不一致。感谢 Jure Koren 的补丁。

bpo-21222 [https://bugs.python.org/issue?@action=redirect&bpo=21222]: 现在，将 name 关键字参数传递给 mock.create_autospec 可以工作了。

bpo-21197 [https://bugs.python.org/issue?@action=redirect&bpo=21197]: 在 64 位非 OS X POSIX 上，venvs 中添加了 lib64 -> lib 的符号链接。

bpo-17498 [https://bugs.python.org/issue?@action=redirect&bpo=17498]: 一些 SMTP 服务器在特定错误后断开连接，违反了严格的 RFC 一致性。smtplib 现在返回错误代码，并在发出下一个命令时延迟引发 SMTPServerDisconnected 错误，而不是在我们发出后续 RSET 时丢失错误代码。

bpo-17826 [https://bugs.python.org/issue?@action=redirect&bpo=17826]: 现在，在由 create_autospec 创建的 mock 函数上设置可迭代的 side_effect 可以工作了。由 Kushal Das 提供的补丁。

bpo-7776 [https://bugs.python.org/issue?@action=redirect&bpo=7776]: 修复了在使用 http.client.HTTPConnection.set_tunnel() 时的 Host: 标头和重新连接。由 Nikolaus Rath 提供的补丁。

bpo-20968 [https://bugs.python.org/issue?@action=redirect&bpo=20968]: unittest.mock.MagicMock 现在支持除法。由 Johannes Baiter 提供的补丁。

bpo-21529 [https://bugs.python.org/issue?@action=redirect&bpo=21529]: Fix arbitrary memory access in JSONDecoder.raw_decode with a negative second parameter. Bug reported by Guido Vranken. (See also: CVE-2014-4616)

bpo-21169 [https://bugs.python.org/issue?@action=redirect&bpo=21169]: getpass 现在通过使用 replace 错误处理程序重新编码，处理输入流编码无法编码的非 ASCII 字符。

bpo-21171 [https://bugs.python.org/issue?@action=redirect&bpo=21171]: 修复了 rot13 编解码器未记录的过滤器 API。由 Berker Peksag 提供的补丁。

bpo-20539 [https://bugs.python.org/issue?@action=redirect&bpo=20539]: 改进了 math.factorial 对于大正数输入的错误消息，并更改了大负数输入的异常类型（OverflowError -> ValueError）。

bpo-21172 [https://bugs.python.org/issue?@action=redirect&bpo=21172]: isinstance 检查从 dict 放宽到 collections.Mapping。

bpo-21155 [https://bugs.python.org/issue?@action=redirect&bpo=21155]: asyncio.EventLoop.create_unix_server() 现在如果同时指定了 path 和 sock 会抛出 ValueError。

bpo-21136 [https://bugs.python.org/issue?@action=redirect&bpo=21136]: 避免了由于幂和其他操作导致的 Fractions 不必要的规范化。由 Raymond Hettinger 提供补丁。

bpo-17621 [https://bugs.python.org/issue?@action=redirect&bpo=17621]: 引入了 importlib.util.LazyLoader。

bpo-21076 [https://bugs.python.org/issue?@action=redirect&bpo=21076]: signal 模块的常量被转换为枚举。由 Giampaolo Rodola' 提供补丁。

bpo-20636 [https://bugs.python.org/issue?@action=redirect&bpo=20636]: 改进了 Tkinter 小部件的 repr。

bpo-19505 [https://bugs.python.org/issue?@action=redirect&bpo=19505]: OrderedDict 的 items、keys 和 values 视图现在支持使用 reversed() 进行反向迭代。

bpo-21149 [https://bugs.python.org/issue?@action=redirect&bpo=21149]: 改进了解释器关闭期间日志清理的线程安全性。感谢 Devin Jeanpierre 提供的补丁。

bpo-21058 [https://bugs.python.org/issue?@action=redirect&bpo=21058]: 修复了 tempfile.NamedTemporaryFile() 中的文件描述符泄漏问题，如果 io.open() 失败则关闭文件描述符。

bpo-21200 [https://bugs.python.org/issue?@action=redirect&bpo=21200]: 当 __spec__ 缺失时，从 pkgutil.get_loader() 返回 None。

bpo-21013 [https://bugs.python.org/issue?@action=redirect&bpo=21013]: 增强 ssl.create_default_context() 用于服务器端套接字时的默认安全性。

bpo-20145 [https://bugs.python.org/issue?@action=redirect&bpo=20145]: assertRaisesRegex and assertWarnsRegex now raise a TypeError if the second argument is not a string or compiled regex.

bpo-20633 [https://bugs.python.org/issue?@action=redirect&bpo=20633]: 用绝对导入替换相对导入。

bpo-20980 [https://bugs.python.org/issue?@action=redirect&bpo=20980]: 使用 ThreadPool 时停止包装异常。

bpo-21082 [https://bugs.python.org/issue?@action=redirect&bpo=21082]: 在 os.makedirs 中，不设置进程级的 umask。注意这改变了 makedirs 当 exist_ok=True 时的行为。

bpo-20990 [https://bugs.python.org/issue?@action=redirect&bpo=20990]: 修复了 pyflakes 为 multiprocessing 发现的问题。

bpo-21015 [https://bugs.python.org/issue?@action=redirect&bpo=21015]: SSL 上下文现在会在 OpenSSL 1.0.2 及更高版本上自动为 ECDH 密钥交换选择椭圆曲线，否则默认为 "prime256v1"。

bpo-21000 [https://bugs.python.org/issue?@action=redirect&bpo=21000]: 改进了 json.tool 的命令行界面。

bpo-20995 [https://bugs.python.org/issue?@action=redirect&bpo=20995]: 增强了 ssl 模块使用的默认密码，以实现更好的安全性并优先考虑完美前向保密。

bpo-20884 [https://bugs.python.org/issue?@action=redirect&bpo=20884]: 不假设 __file__ 在 importlib.__init__ 上有定义。

bpo-21499 [https://bugs.python.org/issue?@action=redirect&bpo=21499]: 在几个 test_importlib.test_api 测试中忽略 __builtins__。

bpo-20627 [https://bugs.python.org/issue?@action=redirect&bpo=20627]: xmlrpc.client.ServerProxy 现在是一个上下文管理器。

bpo-19165 [https://bugs.python.org/issue?@action=redirect&bpo=19165]: formatter 模块现在引发 DeprecationWarning 而不是 PendingDeprecationWarning。

bpo-13936 [https://bugs.python.org/issue?@action=redirect&bpo=13936]: 移除了 datetime.time 实例在布尔上下文中被视为假的能力。

bpo-18931 [https://bugs.python.org/issue?@action=redirect&bpo=18931]: selectors 模块现在支持 Solaris 上的 /dev/poll。补丁由 Giampaolo Rodola' 提供。

bpo-19977 [https://bugs.python.org/issue?@action=redirect&bpo=19977]: 当 LC_TYPE 语言环境是 POSIX 语言环境（C 语言环境）时，sys.stdin 和 sys.stdout 现在使用 surrogateescape 错误处理程序，而不是 strict 错误处理程序。

bpo-20574 [https://bugs.python.org/issue?@action=redirect&bpo=20574]: 为 cp65001 代码（Windows 代码页 65001，Microsoft UTF-8）实现增量解码器。

bpo-20879 [https://bugs.python.org/issue?@action=redirect&bpo=20879]: 延迟初始化 base64 模块中 base32、ascii85 和 base85 编解码器的编码和解码表，并延迟初始化 urllib.parse 模块的 unquote_to_bytes() 表，以避免在这些模块未使用时浪费内存。

bpo-19157 [https://bugs.python.org/issue?@action=redirect&bpo=19157]: 在 ipaddress 中为 IPv6 包括广播地址到可用主机中。

bpo-11599 [https://bugs.python.org/issue?@action=redirect&bpo=11599]: 当外部命令（例如编译器）失败时，如果设置了环境变量 DISTUTILS_DEBUG，distutils 现在会打印出整个命令行（而不仅仅是命令名称）。

bpo-4931 [https://bugs.python.org/issue?@action=redirect&bpo=4931]: distutils 不应再产生无帮助的“error: None”消息。distutils.util.grok_environment_error 被保留但文档标记为弃用。

bpo-20875 [https://bugs.python.org/issue?@action=redirect&bpo=20875]: 防止可能的 gzip "'read' is not defined" NameError。由 Claudiu Popa 提供补丁。

bpo-11558 [https://bugs.python.org/issue?@action=redirect&bpo=11558]: email.message.Message.attach 现在在 is_multipart 为 False 的消息上调用 attach 时返回更有用的错误消息。

bpo-20283 [https://bugs.python.org/issue?@action=redirect&bpo=20283]: RE 模式方法现在接受字符串关键字参数如文档所述。模式和源关键字参数作为弃用的别名保留。

bpo-20778 [https://bugs.python.org/issue?@action=redirect&bpo=20778]: 修复 modulefinder 以与仅字节码的模块一起工作。

bpo-20791 [https://bugs.python.org/issue?@action=redirect&bpo=20791]: copy.copy() 现在当输入是 bytes 对象时不再制作副本。初始由 Peter Otten 提供补丁。

bpo-19748 [https://bugs.python.org/issue?@action=redirect&bpo=19748]: 在 AIX 上，time.mktime() 现在对于超出范围 [1902; 2037] 的年份会引发 OverflowError。

bpo-19573 [https://bugs.python.org/issue?@action=redirect&bpo=19573]: inspect.signature: 使用枚举作为参数种类常量。

bpo-20726 [https://bugs.python.org/issue?@action=redirect&bpo=20726]: inspect.signature: 使 Signature 和 Parameter 可 pickle。

bpo-17373 [https://bugs.python.org/issue?@action=redirect&bpo=17373]: 添加 inspect.Signature.from_callable 方法。

bpo-20378 [https://bugs.python.org/issue?@action=redirect&bpo=20378]: 改进 inspect.Signature 和 inspect.Parameter 的 repr。

bpo-20816 [https://bugs.python.org/issue?@action=redirect&bpo=20816]: 修复 inspect.getcallargs() 以对缺少的关键字参数引发正确的 TypeError。补丁由 Jeremiah Lowin 提供。

bpo-20817 [https://bugs.python.org/issue?@action=redirect&bpo=20817]: 修复 inspect.getcallargs() 以在缺少超过 3 个参数时正确失败。由 Jeremiah Lowin 提供补丁。

bpo-6676 [https://bugs.python.org/issue?@action=redirect&bpo=6676]: 确保在尝试为每个 pyexpat xmlparser 实例解析多个 XML 文档时引发有意义的异常。（原始由 Hirokazu Yamamoto 和 Amaury Forgeot d'Arc 提供补丁，建议措辞由 David Gutteridge 提出）

bpo-21117 [https://bugs.python.org/issue?@action=redirect&bpo=21117]: 修复 inspect.signature 以更好地支持 functools.partial。由于 functools.partial 实现的特殊性，作为关键字参数传递的位置或关键字参数变为仅关键字。

bpo-20334 [https://bugs.python.org/issue?@action=redirect&bpo=20334]: inspect.Signature 和 inspect.Parameter 现在可哈希。感谢 Antony Lee 的错误报告和建议。

bpo-15916 [https://bugs.python.org/issue?@action=redirect&bpo=15916]: 如果 doctest.DocTestSuite 没有找到测试，则返回一个空的 unittest.TestSuite 而不是引发 ValueError。

bpo-21209 [https://bugs.python.org/issue?@action=redirect&bpo=21209]: 修复 asyncio.tasks.CoroWrapper 以解决在 CPython 3.4.1 之前的 yield-from 实现中的一个错误。

asyncio: 向 CoroWrapper 添加 gi_{frame,running,code} 属性（上游 bpo-163 [https://bugs.python.org/issue?@action=redirect&bpo=163]）。

bpo-21311 [https://bugs.python.org/issue?@action=redirect&bpo=21311]: 避免在 _osx_support 中因非标准编译器配置而引发异常。由 John Szakmeister 提供补丁。

bpo-11571 [https://bugs.python.org/issue?@action=redirect&bpo=11571]: 确保在 OS X 上启动时 turtle 窗口成为最顶层窗口。

bpo-21801 [https://bugs.python.org/issue?@action=redirect&bpo=21801]: 验证 __signature__ 是否为 None 或 Signature 的实例。

bpo-21923 [https://bugs.python.org/issue?@action=redirect&bpo=21923]: 防止由于_config_vars可能未初始化而在distutils.sysconfig.customize_compiler中引发AttributeError。

bpo-21323 [https://bugs.python.org/issue?@action=redirect&bpo=21323]: 修复http.server再次处理CGI子目录中的脚本的问题，此功能因修复安全问题 bpo-19435 [https://bugs.python.org/issue?@action=redirect&bpo=19435] 而损坏。由Zach Byrne提供补丁。

bpo-22733 [https://bugs.python.org/issue?@action=redirect&bpo=22733]: 修复ffi_prep_args在64位Windows上未能正确零扩展参数值的问题。

bpo-23302 [https://bugs.python.org/issue?@action=redirect&bpo=23302]: 在建立HTTPConnection时默认设置TCP_NODELAY=1。移除了对硬编码MSS的使用，因为这是一个在Nagle禁用后不再需要的优化。

IDLE

bpo-20577 [https://bugs.python.org/issue?@action=redirect&bpo=20577]: FormatParagraph扩展的最大行长配置已从Idle偏好对话框的General标签页移动到Config Extensions对话框的FormatParagraph标签页。由Tal Einat提供补丁。

bpo-16893 [https://bugs.python.org/issue?@action=redirect&bpo=16893]: 更新Idle文档章节以匹配当前Idle并添加新信息。

bpo-3068 [https://bugs.python.org/issue?@action=redirect&bpo=3068]: 在Options菜单中添加Idle扩展配置对话框。更改将写入HOME/.idlerc/config-extensions.cfg。原始由Tal Einat提供补丁。

bpo-16233 [https://bugs.python.org/issue?@action=redirect&bpo=16233]: 模块浏览器（文件 : 类浏览器，Alt+C）需要一个有文件名的编辑器窗口。当从shell、输出窗口或'Untitled'编辑器请求类浏览器时，Idle不再显示错误框。现在会弹出一个打开模块框（Alt+M）。如果输入了一个有效的名称并打开了一个模块，相应的浏览器也会被打开。

bpo-4832 [https://bugs.python.org/issue?@action=redirect&bpo=4832]: 保存为Python文件时自动为你输入的名称添加.py扩展名（即使你的系统不显示它）。某些系统在类型为文本文件时会自动添加.txt。

bpo-21986 [https://bugs.python.org/issue?@action=redirect&bpo=21986]: 代码对象通常不被pickle模块pickle。为了匹配这一点，当在Idle下运行时，它们不再被pickle。

bpo-17390 [https://bugs.python.org/issue?@action=redirect&bpo=17390]: 调整编辑器窗口标题；移除'Python'，将版本号移至末尾。

bpo-14105 [https://bugs.python.org/issue?@action=redirect&bpo=14105]: 在插入或删除行时，Idle调试器的断点不再消失。

bpo-17172 [https://bugs.python.org/issue?@action=redirect&bpo=17172]: Turtledemo 现在可以从 Idle 运行。目前，该入口位于帮助菜单上，但可能会移至运行菜单。由 Ramchandra Apt 和 Lita Cho 提供的补丁。

bpo-21765 [https://bugs.python.org/issue?@action=redirect&bpo=21765]: 为 HyperParser 添加对非 ASCII 标识符的支持。

bpo-21940 [https://bugs.python.org/issue?@action=redirect&bpo=21940]: 为 WidgetRedirector 添加单元测试。初始由 Saimadhav Heblikar 提供补丁。

bpo-18592 [https://bugs.python.org/issue?@action=redirect&bpo=18592]: 为 SearchDialogBase 添加单元测试。由 Phil Webster 提供的补丁。

bpo-21694 [https://bugs.python.org/issue?@action=redirect&bpo=21694]: 为 ParenMatch 添加单元测试。由 Saimadhav Heblikar 提供的补丁。

bpo-21686 [https://bugs.python.org/issue?@action=redirect&bpo=21686]: 为 HyperParser 添加单元测试。原始由 Saimadhav Heblikar 提供补丁。

bpo-12387 [https://bugs.python.org/issue?@action=redirect&bpo=12387]: 为 Idle 添加默认 Windows 键绑定的大写(小写)版本，以便 Caps Lock 不会禁用它们。由 Roger Serwy 提供的补丁。

bpo-21695 [https://bugs.python.org/issue?@action=redirect&bpo=21695]: 在搜索仍在进行时关闭“在文件中查找”输出窗口不再关闭 Idle。

bpo-18910 [https://bugs.python.org/issue?@action=redirect&bpo=18910]: 为 textView 添加单元测试。由 Phil Webster 提供的补丁。

bpo-18292 [https://bugs.python.org/issue?@action=redirect&bpo=18292]: 为 AutoExpand 添加单元测试。由 Saihadhav Heblikar 提供的补丁。

bpo-18409 [https://bugs.python.org/issue?@action=redirect&bpo=18409]: 为 AutoComplete 添加单元测试。由 Phil Webster 提供的补丁。

bpo-21477 [https://bugs.python.org/issue?@action=redirect&bpo=21477]: htest.py - 改进框架，完成测试集。由 Saimadhav Heblikar 提供的补丁

bpo-18104 [https://bugs.python.org/issue?@action=redirect&bpo=18104]: 添加 idlelib/idle_test/htest.py，包含几个示例测试，开始整合和改进 Idle 的人工验证测试。根据需要更改其他文件以与 htest 协同工作。将模块作为 __main__ 运行会运行所有测试。

bpo-21139 [https://bugs.python.org/issue?@action=redirect&bpo=21139]: 将默认段落宽度更改为 72，这是 PEP 8 [https://www.python.org/dev/peps/pep-0008] 的推荐。

bpo-21284 [https://bugs.python.org/issue?@action=redirect&bpo=21284]: 用户更改重新格式化宽度后，段落重新格式化测试通过。

bpo-17654 [https://bugs.python.org/issue?@action=redirect&bpo=17654]: 确保在 OS X 上为非框架构建和所有 Tk 变体正确自定义 IDLE 菜单。

bpo-23180 [https://bugs.python.org/issue?@action=redirect&bpo=23180]: 将 IDLE 的“Windows”菜单项重命名为“Window”。由 Al Sweigart 提供的补丁。

构建

bpo-15506 [https://bugs.python.org/issue?@action=redirect&bpo=15506]: 在配置脚本中使用标准的 PKG_PROG_PKG_CONFIG autoconf 宏。

bpo-22935 [https://bugs.python.org/issue?@action=redirect&bpo=22935]: 如果 openssl 不支持 SSL 3，也允许编译 ssl 模块。

bpo-22592 [https://bugs.python.org/issue?@action=redirect&bpo=22592]: 放弃对使用 Borland C 编译器构建 Python 的支持。distutils 模块仍支持使用该编译器构建扩展。

bpo-22591 [https://bugs.python.org/issue?@action=redirect&bpo=22591]: 放弃对 MS-DOS 的支持，特别是 DJGPP 编译器（MS-DOS 版的 GCC）。

bpo-16537 [https://bugs.python.org/issue?@action=redirect&bpo=16537]: 在 setup.py 中检查 self.extensions 是否为空。由 Jonathan Hosmer 提供补丁。

bpo-22359 [https://bugs.python.org/issue?@action=redirect&bpo=22359]: 移除递归 make 的错误使用。由 Jonas Wagner 提供补丁。

bpo-21958 [https://bugs.python.org/issue?@action=redirect&bpo=21958]: 当使用 Visual Studio 2013 及以上版本构建时，定义 HAVE_ROUND。由 Zachary Turner 提供补丁。

bpo-18093 [https://bugs.python.org/issue?@action=redirect&bpo=18093]: 嵌入 CPython 运行时的程序现在放在单独的 "Programs" 目录中，而不是保留在 Modules 目录中。

bpo-15759 [https://bugs.python.org/issue?@action=redirect&bpo=15759]: 在 Doc/ 中的 "make suspicious"、"make linkcheck" 和 "make doctest" 现在仅在失败时显示特殊消息。

bpo-21141 [https://bugs.python.org/issue?@action=redirect&bpo=21141]: Windows 构建过程不再尝试查找 Perl，而是依赖已配置并准备好构建的 OpenSSL 源代码。PCbuild\build_ssl.py 脚本已被重写并重命名为 PCbuild\prepare_ssl.py，并负责为 32 位和 64 位平台配置 OpenSSL 源代码。从 svn.python.org 获取的 OpenSSL 源代码将始终预先配置并准备好构建。

bpo-21037 [https://bugs.python.org/issue?@action=redirect&bpo=21037]: 添加构建选项以启用 AddressSanitizer 支持。

bpo-19962 [https://bugs.python.org/issue?@action=redirect&bpo=19962]: Windows 构建过程现在在源代码树的根目录中创建 "python.bat"，它将所有参数传递给最近构建的解释器。

bpo-21285 [https://bugs.python.org/issue?@action=redirect&bpo=21285]: 重构并修复 curses 配置检查，始终在 ncursesw 目录中搜索。

bpo-15234 [https://bugs.python.org/issue?@action=redirect&bpo=15234]: 对于 BerkeleyDB 和 Sqlite，仅当未搜索到库和包含目录时才添加它们。这避免了显式的运行时库依赖。

bpo-17861 [https://bugs.python.org/issue?@action=redirect&bpo=17861]: Tools/scripts/generate_opcode_h.py 如果 Lib/opcode.py 有任何更改，会自动从 Lib/opcode.py 重新生成 Include/opcode.h。

bpo-20644 [https://bugs.python.org/issue?@action=redirect&bpo=20644]: OS X 安装程序构建支持3.4.1中文档构建的更改：假设外部提供的sphinx-build在/usr/bin中可用。

bpo-20022 [https://bugs.python.org/issue?@action=redirect&bpo=20022]: 在OS X构建中消除对已弃用的bundlebuilder的使用。

bpo-15968 [https://bugs.python.org/issue?@action=redirect&bpo=15968]: 将Tcl、Tk和Tix构建集成到Windows构建解决方案中。

bpo-17095 [https://bugs.python.org/issue?@action=redirect&bpo=17095]: 修复Modules/Setup shared 支持。

bpo-21811 [https://bugs.python.org/issue?@action=redirect&bpo=21811]: 预期修复以支持OS X版本 > 10.9。

bpo-21166 [https://bugs.python.org/issue?@action=redirect&bpo=21166]: 防止python --generate-posix-vars在pybuilddir.txt构建目标中可能出现的段错误和其他随机故障。

bpo-18096 [https://bugs.python.org/issue?@action=redirect&bpo=18096]: 修复python-config返回的库顺序。

bpo-17219 [https://bugs.python.org/issue?@action=redirect&bpo=17219]: 为Python扩展跨构建添加库构建目录。

bpo-22919 [https://bugs.python.org/issue?@action=redirect&bpo=22919]: Windows构建更新以支持VC 14.0（Visual Studio 2015），这将用于官方发布。

bpo-21236 [https://bugs.python.org/issue?@action=redirect&bpo=21236]: 使用cabinet.lib而非fci.lib构建_msi.pyd。

bpo-17128 [https://bugs.python.org/issue?@action=redirect&bpo=17128]: 为OS X 10.5+安装程序使用OpenSSL的私有版本。

C API

bpo-14203 [https://bugs.python.org/issue?@action=redirect&bpo=14203]: 移除了对PyBuffer_FillInfo()、bytearray_getbuffer()、bytesiobuf_getbuffer()和array_buffer_getbuf()中view==NULL的过时支持。所有函数在那种情况下现在都会引发BufferError。

bpo-22445 [https://bugs.python.org/issue?@action=redirect&bpo=22445]: PyBuffer_IsContiguous()现在实现了精确的连续性测试，与NumPy的NPY_RELAXED_STRIDES_CHECKING编译标志兼容。之前该函数在角落案例中报告了假阴性。

bpo-22079 [https://bugs.python.org/issue?@action=redirect&bpo=22079]: PyType_Ready()现在检查静态分配的类型没有动态分配的基类。

bpo-22453 [https://bugs.python.org/issue?@action=redirect&bpo=22453]: 移除了未记录的宏PyObject_REPR()。

bpo-18395 [https://bugs.python.org/issue?@action=redirect&bpo=18395]: 将 _Py_char2wchar() 重命名为 Py_DecodeLocale()，将``_Py_wchar2char()`` 重命名为 Py_EncodeLocale()，并记录这些函数。

bpo-21233 [https://bugs.python.org/issue?@action=redirect&bpo=21233]: 添加新的C函数：PyMem_RawCalloc()、PyMem_Calloc()、PyObject_Calloc()、_PyObject_GC_Calloc()。bytes(int)现在对于大对象使用 calloc() 而非 malloc()，这样更快且使用更少的内存。

bpo-20942 [https://bugs.python.org/issue?@action=redirect&bpo=20942]: PyImport_ImportFrozenModuleObject() 不再设置 __file__ 以匹配 importlib 的行为；这影响了 _frozen_importlib 以及任何使用 imp.init_frozen() 加载的模块。

文档

bpo-19548 [https://bugs.python.org/issue?@action=redirect&bpo=19548]: 更新 codecs 模块文档，以更好地涵盖文本编码和其他编解码器之间的区别，以及其他一些澄清。由 Martin Panter 提供补丁。

bpo-22394 [https://bugs.python.org/issue?@action=redirect&bpo=22394]: Doc/Makefile 现在支持 make venv PYTHON=../python 来创建一个用于生成文档的 venv，例如，make html PYTHON=venv/bin/python3。

bpo-21514 [https://bugs.python.org/issue?@action=redirect&bpo=21514]: json 模块的文档现在引用新的 JSON RFC 7159 而不是过时的 RFC 4627。

bpo-21777 [https://bugs.python.org/issue?@action=redirect&bpo=21777]: bytes 和 bytearray 的二进制序列方法现在被明确文档化，而不是假设用户能够从相应的 str 方法的行为中推导出预期行为。

bpo-6916 [https://bugs.python.org/issue?@action=redirect&bpo=6916]: 取消文档中已弃用的 asynchat.fifo 类的记录。

bpo-17386 [https://bugs.python.org/issue?@action=redirect&bpo=17386]: 扩展了 Doc/make.bat 脚本的功能，使其更加接近 Doc/Makefile。

bpo-21312 [https://bugs.python.org/issue?@action=redirect&bpo=21312]: 更新 thread_foobar.h 模板文件，包括更新的线程 API。由 Jack McCracken 提供补丁。

bpo-21043 [https://bugs.python.org/issue?@action=redirect&bpo=21043]: 移除对特定 CA 组织的推荐，并提及加载操作系统证书的能力。

bpo-20765 [https://bugs.python.org/issue?@action=redirect&bpo=20765]: 添加 PurePath.with_name() 和 PurePath.with_suffix() 的缺失文档。

bpo-19407 [https://bugs.python.org/issue?@action=redirect&bpo=19407]: 基于 Python Packaging Authority 工具的新包安装和分发指南。现有的指南作为遗留链接保留在 distutils 文档中，因为它们仍然包含一些工具开发者所需的参考材料，这些材料在其他地方没有记录。

bpo-19697 [https://bugs.python.org/issue?@action=redirect&bpo=19697]: 文档化 __main__.__spec__ 为 None 的情况。

测试

bpo-18982 [https://bugs.python.org/issue?@action=redirect&bpo=18982]: 为 calendar 模块的 CLI 添加测试。

bpo-19548 [https://bugs.python.org/issue?@action=redirect&bpo=19548]: 向 test_codecs 添加了一些额外的检查，以确保更新后的文档中的陈述保持准确。由 Martin Panter 提供补丁。

bpo-22838 [https://bugs.python.org/issue?@action=redirect&bpo=22838]: 所有的test_re测试现在都可以通过unittest测试发现来运行。

bpo-22173 [https://bugs.python.org/issue?@action=redirect&bpo=22173]: 更新lib2to3测试以使用unittest测试发现。

bpo-16000 [https://bugs.python.org/issue?@action=redirect&bpo=16000]: 将test_curses转换为使用unittest。

bpo-21456 [https://bugs.python.org/issue?@action=redirect&bpo=21456]: 如果_ssl模块不存在，则跳过test_urllib2net.py中的两个测试。由Remi Pointel提供补丁。

bpo-20746 [https://bugs.python.org/issue?@action=redirect&bpo=20746]: 修复test_pdb以在refleak模式(-R)下运行。由Xavier de Gaye提供补丁。

bpo-22060 [https://bugs.python.org/issue?@action=redirect&bpo=22060]: test_ctypes已经进行了一定程度的清理和简化；现在它使用unittest测试发现来找到它的测试。

bpo-22104 [https://bugs.python.org/issue?@action=redirect&bpo=22104]: regrtest.py不再持有对从没有定义test_main()的测试模块加载的测试套件的引用。

bpo-22111 [https://bugs.python.org/issue?@action=redirect&bpo=22111]: 在test_imaplib中进行了一些清理。由Milan Oberkirch提供补丁。

bpo-22002 [https://bugs.python.org/issue?@action=redirect&bpo=22002]: 向test.support添加了 load_package_tests 函数，并用它在test_asyncio、test_email、test_importlib、test_json和test_tools中实现/增强测试发现。

bpo-21976 [https://bugs.python.org/issue?@action=redirect&bpo=21976]: 修复test_ssl以接受LibreSSL版本字符串。感谢William Orr。

bpo-21918 [https://bugs.python.org/issue?@action=redirect&bpo=21918]: 将test_tools从一个模块转换为一个包，包含每个测试脚本的单独测试文件。

bpo-9554 [https://bugs.python.org/issue?@action=redirect&bpo=9554]: 在test_argparse中使用现代的unittest特性。由Denver Coneybeare和Radu Voicilas提供初始补丁。

bpo-20155 [https://bugs.python.org/issue?@action=redirect&bpo=20155]: 更改test_httpservers中失败测试的HTTP方法名称，以便数据包过滤软件（特别是Windows基础过滤引擎）不会干扰测试预期的事务语义。

bpo-19493 [https://bugs.python.org/issue?@action=redirect&bpo=19493]: 重构了ctypes测试包，明确跳过测试而不是静默跳过。

bpo-18492 [https://bugs.python.org/issue?@action=redirect&bpo=18492]: 当测试不是由regrtest.py运行时，现在允许所有资源。

bpo-21634 [https://bugs.python.org/issue?@action=redirect&bpo=21634]: Fix pystone micro-benchmark: use floor division instead of true division to benchmark integers instead of floating point numbers. Set pystone version to 1.2. Patch written by Lennart Regebro.

bpo-21605 [https://bugs.python.org/issue?@action=redirect&bpo=21605]: 为Tkinter图像添加了测试。

bpo-21493 [https://bugs.python.org/issue?@action=redirect&bpo=21493]: 为ntpath.expanduser()添加了测试。原始由Claudiu Popa提供补丁。

bpo-19925 [https://bugs.python.org/issue?@action=redirect&bpo=19925]: 为spwd模块添加了测试。原始由Vajrasky Kok提供补丁。

bpo-21522 [https://bugs.python.org/issue?@action=redirect&bpo=21522]: 为Listbox.itemconfigure()、PanedWindow.paneconfigure()和Menu.entryconfigure()添加了Tkinter测试。

bpo-17756 [https://bugs.python.org/issue?@action=redirect&bpo=17756]: 修复从安装位置运行时的test_code测试。

bpo-17752 [https://bugs.python.org/issue?@action=redirect&bpo=17752]: 修复从安装位置运行时的distutils测试。

bpo-18604 [https://bugs.python.org/issue?@action=redirect&bpo=18604]: 合并了对GUI可用性的检查。现在所有平台在请求GUI资源时至少会检查是否可以实例化Tk。

bpo-21275 [https://bugs.python.org/issue?@action=redirect&bpo=21275]: 修复 KFreeBSD 上的一个套接字测试。

bpo-21223 [https://bugs.python.org/issue?@action=redirect&bpo=21223]: 当某些扩展作为内置模块编译时传入 test_site/test_startup_imports。

bpo-20635 [https://bugs.python.org/issue?@action=redirect&bpo=20635]: 添加了针对 Tk geometry 管理器的测试。

增加freeze包的测试用例。

bpo-20743 [https://bugs.python.org/issue?@action=redirect&bpo=20743]: 修复了 test_tcl 中的一个引用泄漏。

bpo-21097 [https://bugs.python.org/issue?@action=redirect&bpo=21097]: 将 test_namespace_pkgs 移至 test_importlib.

bpo-21503 [https://bugs.python.org/issue?@action=redirect&bpo=21503]: 在 test_importlib 中一致地使用 test_both()。

bpo-20939 [https://bugs.python.org/issue?@action=redirect&bpo=20939]: 避免由于新增从 http://www.python.org/ 到 https://www.python.org 的重定向导致的网络测试失败：改用 http://www.example.com。

bpo-20668 [https://bugs.python.org/issue?@action=redirect&bpo=20668]: asyncio 测试不再依赖 tests.txt 文件。 （由 Vajrasky Kok 编写补丁）

bpo-21093 [https://bugs.python.org/issue?@action=redirect&bpo=21093]: 在 OS X 上防止当 libz 的副本存在于 $HOME/lib 或 /usr/local/lib 中时 ctypes test_macholib 的失败。

bpo-22770 [https://bugs.python.org/issue?@action=redirect&bpo=22770]: 在 OS X 上防止当运行图形用户界面测试时的某些 Tk 段错误。

bpo-23211 [https://bugs.python.org/issue?@action=redirect&bpo=23211]: 在某些 OS X 10.6 系统上绕过 test_logging 失败

bpo-23345 [https://bugs.python.org/issue?@action=redirect&bpo=23345]: 防止较大 OpenSSL 补丁级别值 (如 0.9.8zc) 导致的 test_ssl 失败。

工具/示例

bpo-22314 [https://bugs.python.org/issue?@action=redirect&bpo=22314]: 现在当设置了 LINES 环境变量时 pydoc 将会可用。

bpo-22615 [https://bugs.python.org/issue?@action=redirect&bpo=22615]: Argument Clinic 现在支持 int 转换器的 "type" 参数。 这允许将 int 转换器用于枚举和 typedef。

bpo-20076 [https://bugs.python.org/issue?@action=redirect&bpo=20076]: makelocalealias.py 脚本将不再忽略 UTF-8 映射。

bpo-20079 [https://bugs.python.org/issue?@action=redirect&bpo=20079]: makelocalealias.py 脚本现在能够解析 glibc 源代码中的 SUPPORTED 文件并支持针对源代码路径的命令行选项。

bpo-22201 [https://bugs.python.org/issue?@action=redirect&bpo=22201]: zipfile 模块的命令行界面现在能正确地提取带有目录项的 ZIP 文件。 由 Ryan Wilson 编写补丁。

bpo-22120 [https://bugs.python.org/issue?@action=redirect&bpo=22120]: 对于使用无符号整数返回转换器的函数，现在 Argument Clinic 会在所生成的代码中为与 -1 的比较生成到该类型的强制转换。 （这将抑制一个编译警告。）

bpo-18974 [https://bugs.python.org/issue?@action=redirect&bpo=18974]: Tools/scripts/diff.py 现在将使用 argparse 而不是 optparse。

bpo-21906 [https://bugs.python.org/issue?@action=redirect&bpo=21906]: 让 Tools/scripts/md5sum.py 适用于 Python 3。 由 Zachary Ware 编写补丁。

bpo-21629 [https://bugs.python.org/issue?@action=redirect&bpo=21629]: 修复 Argument Clinic 的 "--converters" 特性。

为2to3添加 yield from 的支持。

为 2to3 添加对 PEP 465 矩阵乘法运算符的支持。

bpo-16047 [https://bugs.python.org/issue?@action=redirect&bpo=16047]: 修正冻结中的模块异常列表和 __file__ 处理。 由 Meador Inge 编写补丁。

bpo-11824 [https://bugs.python.org/issue?@action=redirect&bpo=11824]: 考虑冻结 ABI 标签。 由 Meador Inge 编写补丁。

bpo-20535 [https://bugs.python.org/issue?@action=redirect&bpo=20535]: PYTHONWARNING 不再影响 run_tests.py 脚本。 由 Arfrever Frehtes Taifersar Arahesis 编写补丁。

Windows

bpo-23260 [https://bugs.python.org/issue?@action=redirect&bpo=23260]: 更新 Windows 安装器

捆绑的 Tcl/Tk 版本已被更新至 8.6.3。 这项改变最显示的结果是当在 Windows Vista 或更新版本上运行时增加了新的原生文件对话框。 请参阅 Tcl/Tk 的 TIP 432 了解详情。 此外，该 Tcl/Tk 版本还包括了对 Windows 10 的支持。

bpo-17896 [https://bugs.python.org/issue?@action=redirect&bpo=17896]: 现在 Windows 构建脚本将预期外部库源代码位于 PCbuild\..\externals 而不是 PCbuild\..\..。

bpo-17717 [https://bugs.python.org/issue?@action=redirect&bpo=17717]: 现在 Windows 构建脚本将使用来自 svn.python.org的 NASM 副本来构建 OpenSSL。

bpo-21907 [https://bugs.python.org/issue?@action=redirect&bpo=21907]: 改进了供构建 Python 的处理脚本。

bpo-22644 [https://bugs.python.org/issue?@action=redirect&bpo=22644]: 捆绑的 OpenSSL 版本已更新到 1.0.1j。

bpo-10747 [https://bugs.python.org/issue?@action=redirect&bpo=10747]: 在 Windows 开始菜单中使用带版本号的标签。 由 Olive Kilburn 编写补丁。

bpo-22980 [https://bugs.python.org/issue?@action=redirect&bpo=22980]: 带有版本号和平台标记的 .pyd 文件 (例如 ".cp35-win32.pyd") 现在将优先于不带标记的文件被加载。

（有关旧版本的信息，请参阅HISTORY文件。)

Python 教程

Python 是一门易于学习、功能强大的编程语言。它提供了高效的高级数据结构，还能简单有效地面向对象编程。Python 优雅的语法和动态类型以及解释型语言的本质，使它成为多数平台上写脚本和快速开发应用的理想语言。

Python 官网（https://www.python.org/）上免费提供了 Python 解释器和扩展的标准库，包括源码和适用于各操作系统的机器码形式，并可自由地分发。Python 官网还包含许多免费的第三方 Python 模块、程序和工具发布包及文档链接。

Python 解释器易于扩展，使用 C 或 C++（或其他 C 能调用的语言）即可为 Python 扩展新功能和数据类型。Python 也可用作定制软件中的扩展程序语言。

本教程只是简单介绍了 Python 语言概念和功能。读者在阅读本教程时最好使用 Python 解释器以便随时动手练习。本教程中的所有示例都是相互独立的并可离线阅读。

标准库与模块的内容详见 Python 标准库。Python 语言参考手册 是更正规的语言定义。如要编写 C 或 C++ 扩展请参考 扩展和嵌入 Python 解释器 和 Python/C API 参考手册。此外，深入讲解 Python 的书籍也有很多。

本教程对每一个功能的介绍并不完整，甚至没有涉及全部常用功能，只是介绍了 Python 中最值得学习的功能，旨在让读者快速感受一下 Python 的特色。学完本教程的读者可以阅读和编写 Python 模块和程序，也可以继续学习 Python 标准库。

强烈推荐阅读 术语对照表。

1. 课前甜点

2. 使用 Python 的解释器

2.1. 唤出解释器

2.1.1. 传入参数

2.1.2. 交互模式

2.2. 解释器的运行环境

2.2.1. 源文件的字符编码

3. Python 速览

3.1. Python 用作计算器

3.1.1. 数字

3.1.2. 字符串

3.1.3. 列表

3.2. 走向编程的第一步

4. 更多控制流工具

4.1. if 语句

4.2. for 语句

4.3. range() 函数

4.4. 循环中的 break、continue 语句及 else 子句

4.5. pass 语句

4.6. match 语句

4.7. 定义函数

4.8. 函数定义详解

4.8.1. 默认值参数

4.8.2. 关键字参数

4.8.3. 特殊参数

4.8.3.1. 位置或关键字参数

4.8.3.2. 仅位置参数

4.8.3.3. 仅限关键字参数

4.8.3.4. 函数示例

4.8.3.5. 小结

4.8.4. 任意实参列表

4.8.5. 解包实参列表

4.8.6. Lambda 表达式

4.8.7. 文档字符串

4.8.8. 函数注解

4.9. 小插曲：编码风格

5. 数据结构

5.1. 列表详解

5.1.1. 用列表实现堆栈

5.1.2. 用列表实现队列

5.1.3. 列表推导式

5.1.4. 嵌套的列表推导式

5.2. del 语句

5.3. 元组和序列

5.4. 集合

5.5. 字典

5.6. 循环的技巧

5.7. 深入条件控制

5.8. 序列和其他类型的比较

6. 模块

6.1. 模块详解

6.1.1. 以脚本方式执行模块

6.1.2. 模块搜索路径

6.1.3. “已编译的” Python 文件

6.2. 标准模块

6.3. dir() 函数

6.4. 包

6.4.1. 从包中导入 *

6.4.2. 相对导入

6.4.3. 多目录中的包

7. 输入与输出

7.1. 更复杂的输出格式

7.1.1. 格式化字符串字面值

7.1.2. 字符串 format() 方法

7.1.3. 手动格式化字符串

7.1.4. 旧式字符串格式化方法

7.2. 读写文件

7.2.1. 文件对象的方法

7.2.2. 使用 json 保存结构化数据

8. 错误和异常

8.1. 语法错误

8.2. 异常

8.3. 异常的处理

8.4. 触发异常

8.5. 异常链

8.6. 用户自定义异常

8.7. 定义清理操作

8.8. 预定义的清理操作

9. 类

9.1. 名称和对象

9.2. Python 作用域和命名空间

9.2.1. 作用域和命名空间示例

9.3. 初探类

9.3.1. 类定义语法

9.3.2. Class 对象

9.3.3. 实例对象

9.3.4. 方法对象

9.3.5. 类和实例变量

9.4. 补充说明

9.5. 继承

9.5.1. 多重继承

9.6. 私有变量

9.7. 杂项说明

9.8. 迭代器

9.9. 生成器

9.10. 生成器表达式

10. 标准库简介

10.1. 操作系统接口

10.2. 文件通配符

10.3. 命令行参数

10.4. 错误输出重定向和程序终止

10.5. 字符串模式匹配

10.6. 数学

10.7. 互联网访问

10.8. 日期和时间

10.9. 数据压缩

10.10. 性能测量

10.11. 质量控制

10.12. 自带电池

11. 标准库简介 —— 第二部分

11.1. 格式化输出

11.2. 模板

11.3. 使用二进制数据记录格式

11.4. 多线程

11.5. 日志记录

11.6. 弱引用

11.7. 用于操作列表的工具

11.8. 十进制浮点运算

12. 虚拟环境和包

12.1. 概述

12.2. 创建虚拟环境

12.3. 使用pip管理包

13. 接下来？

14. 交互式编辑和编辑历史

14.1. Tab 补全和编辑历史

14.2. 默认交互式解释器的替代品

15. 浮点算术：争议和限制

15.1. 表示性错误

16. 附录

16.1. 交互模式

16.1.1. 错误处理

16.1.2. 可执行的Python脚本

16.1.3. 交互式启动文件

16.1.4. 定制模块

1. 课前甜点

如果您的工作主要是用电脑完成的，总有一天您会想能不能自动执行一些任务。比如，对大量文本文件执行查找、替换操作；利用复杂的规则重命名、重排序一堆照片文件；也可能您想编写一个小型数据库、或开发专用的图形界面应用，甚至是开发一个简单的游戏。

作为一名专业软件开发人员，您可能要处理 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 代码短很多，原因如下：

高级数据类型允许在单一语句中表述复杂操作；

使用缩进，而不是括号实现代码块分组；

无需预声明变量或参数。

Python “可以扩展”：会开发 C 语言程序，就能快速上手为解释器增加新的内置函数或模块，不论是让核心程序以最高速度运行，还是把 Python 程序链接到只提供预编译程序的库（比如，硬件图形库）。只要下点功夫，就能把 Python 解释器和用 C 开发的应用链接在一起，用它来扩展和控制该应用。

顺便提一句，本语言的命名源自 BBC 的 “Monty Python 飞行马戏团”，与爬行动物无关（Python 原义为“蟒蛇”）。欢迎大家在文档中引用 Monty Python 小品短篇集，多多益善！

现在，您已经对 Python 跃跃欲试，想深入了解一些细节了吧。要知道，学习语言的最佳方式是上手实践，建议您边阅读本教程，边在 Python 解释器中练习。

下一章介绍解释器的用法。这部分内容有些单调乏味，但对上手实践后面的例子来说却至关重要。

本教程的其他部分将利用各种示例，介绍 Python 语言、系统的功能，开始只是简单的表达式、语句和数据类型，然后是函数、模块，最后，介绍一些高级概念，如，异常、用户定义的类等功能。

2. 使用 Python 的解释器

2.1. 唤出解释器

Python 解释器在可用的机器上通常安装于 /usr/local/bin/python3.10 路径下；将 /usr/local/bin 加入你的 Unix 终端的搜索路径就可以通过键入以下命令来启动它:

python3.10

这样，就可以在 shell 中运行 Python 了 1 。因为可以选择安装目录，解释器也有可能安装在别的位置；如果还不明白，就去问问身边的 Python 大神或系统管理员。（例如，常见备选路径还有 /usr/local/python。）

在 Windows 机器上当你从 Microsoft Store 安装 Python 之后，python3.10 命令将可使用。 如果你安装了 py.exe 启动器，你将可以使用 py 命令。 请参阅 附录：设置环境变量 了解其他启动 Python 的方式。

在主提示符中，输入文件结束符（Unix 里是 Control-D，Windows 里是 Control-Z），就会退出解释器，退出状态码为 0。如果不能退出，还可以输入这个命令：quit()。

在支持 GNU Readline [https://tiswww.case.edu/php/chet/readline/rltop.html] 库的系统中，解释器的行编辑功能包括交互式编辑、历史替换、代码补全等。检测是否支持命令行编辑最快速的方式是，在首次出现 Python 提示符时，输入 Control-P。听到“哔”提示音，说明支持行编辑；请参阅附录 交互式编辑和编辑历史，了解功能键。如果没有反应，或回显了 ^P，则说明不支持行编辑；只能用退格键删除当前行的字符。

解释器的操作方式类似 Unix Shell：用与 tty 设备关联的标准输入调用时，可以交互式地读取和执行命令；以文件名参数，或标准输入文件调用时，则读取并执行文件中的 脚本。

另一种启动解释器的方式是 python -c command [arg] ...，这将执行 command 中的语句，相当于 shell 的 -c 选项。 由于 Python 语句经常包含空格或其他会被 shell 特殊对待的字符，通常建议用引号将整个 command 括起来。

Python 模块也可以当作脚本使用。输入：python -m module [arg] ...，会执行 module 的源文件，这跟在命令行把路径写全了一样。

在交互模式下运行脚本文件，只要在脚本名称参数前，加上选项 -i 就可以了。

命令行的所有选项详见 命令行与环境。

2.1.1. 传入参数

解释器读取命令行参数，把脚本名与其他参数转化为字符串列表存到 sys 模块的 argv 变量里。执行 import sys，可以导入这个模块，并访问该列表。该列表最少有一个元素；未给定输入参数时，sys.argv[0] 是空字符串。给定脚本名是 '-' （标准输入）时，sys.argv[0] 是 '-'。使用 -c command 时，sys.argv[0] 是 '-c'。如果使用选项 -m module，sys.argv[0] 就是包含目录的模块全名。解释器不处理 -c command 或 -m module 之后的选项，而是直接留在 sys.argv 中由命令或模块来处理。

2.1.2. 交互模式

在终端（tty）输入并执行指令时，解释器在 交互模式（interactive mode） 中运行。在这种模式中，会显示 主提示符，提示输入下一条指令，主提示符通常用三个大于号（>>>）表示；输入连续行时，显示 次要提示符，默认是三个点（...）。进入解释器时，首先显示欢迎信息、版本信息、版权声明，然后才是提示符：

$ python3.10
Python 3.10 (default, June 4 2019, 09:25:04)
[GCC 4.8.2] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

输入多行架构的语句时，要用连续行。以 if 为例：

>>> the_world_is_flat = True
>>> if the_world_is_flat:
...     print("Be careful not to fall off!")
...
Be careful not to fall off!

交互模式的内容详见 交互模式。

2.2. 解释器的运行环境

2.2.1. 源文件的字符编码

默认情况下，Python 源码文件的编码是 UTF-8。这种编码支持世界上大多数语言的字符，可以用于字符串字面值、变量、函数名及注释 —— 尽管标准库只用常规的 ASCII 字符作为变量名或函数名，可移植代码都应遵守此约定。要正确显示这些字符，编辑器必须能识别 UTF-8 编码，而且必须使用支持文件中所有字符的字体。

如果不使用默认编码，则要声明文件的编码，文件的 第一 行要写成特殊注释。句法如下：

# -*- coding: encoding -*-

其中，encoding 可以是 Python 支持的任意一种 codecs。

比如，声明使用 Windows-1252 编码，源码文件要写成：

# -*- coding: cp1252 -*-

第一行 的规则也有一种例外情况，源码以 UNIX "shebang" 行 开头。此时，编码声明要写在文件的第二行。例如：

#!/usr/bin/env python3
# -*- coding: cp1252 -*-

备注

1

Unix 系统中，为了不与同时安装的 Python 2.x 冲突，Python 3.x 解释器默认安装的执行文件名不是 python。

3. Python 速览

下面的例子以是否显示提示符（>>> 与 ...）区分输入与输出：输入例子中的代码时，要键入以提示符开头的行中提示符后的所有内容；未以提示符开头的行是解释器的输出。注意，例子中的某行出现的第二个提示符是用来结束多行命令的，此时，要键入一个空白行。

你可以通过在示例方块右上角的 >>> 上点击来切换显示提示符和输出。 如果你隐藏了一个示例的提示符和输出，那么你可以方便地将输入行复制并粘贴到你的解释器中。

本手册中的许多例子，甚至交互式命令都包含注释。Python 注释以 # 开头，直到该物理行结束。注释可以在行开头，或空白符与代码之后，但不能在字符串里面。字符串中的 # 号就是 # 号。注释用于阐明代码，Python 不解释注释，键入例子时，可以不输入注释。

示例如下：

# this is the first comment
spam = 1  # and this is the second comment
          # ... and now a third!
text = "# This is not a comment because it's inside quotes."

3.1. Python 用作计算器

现在，尝试一些简单的 Python 命令。启动解释器，等待主提示符（>>> ）出现。

3.1.1. 数字

解释器像一个简单的计算器：输入表达式，就会给出答案。表达式的语法很直接：运算符 +、-、*、/ 的用法和其他大部分语言一样（比如，Pascal 或 C）；括号 (()) 用来分组。例如：

>>> 2 + 2
4
>>> 50 - 5*6
20
>>> (50 - 5*6) / 4
5.0
>>> 8 / 5  # division always returns a floating point number
1.6

整数（如，2、4、20 ）的类型是 int，带小数（如，5.0、1.6 ）的类型是 float。本教程后半部分将介绍更多数字类型。

除法运算 (/) 总是返回浮点数。 如果要做 floor division 得到一个整数结果你可以使用 // 运算符；要计算余数你可以使用 %:

>>> 17 / 3  # classic division returns a float
5.666666666666667
>>>
>>> 17 // 3  # floor division discards the fractional part
5
>>> 17 % 3  # the % operator returns the remainder of the division
2
>>> 5 * 3 + 2  # floored quotient * divisor + remainder
17

Python 用 ** 运算符计算乘方 1：

>>> 5 ** 2  # 5 squared
25
>>> 2 ** 7  # 2 to the power of 7
128

等号（=）用于给变量赋值。赋值后，下一个交互提示符的位置不显示任何结果：

>>> width = 20
>>> height = 5 * 9
>>> width * height
900

如果变量未定义（即，未赋值），使用该变量会提示错误：

>>> n  # try to access an undefined variable
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'n' is not defined

Python 全面支持浮点数；混合类型运算数的运算会把整数转换为浮点数：

>>> 4 * 3.75 - 1
14.0

交互模式下，上次输出的表达式会赋给变量 _。把 Python 当作计算器时，用该变量实现下一步计算更简单，例如：

>>> tax = 12.5 / 100
>>> price = 100.50
>>> price * tax
12.5625
>>> price + _
113.0625
>>> round(_, 2)
113.06

最好把该变量当作只读类型。不要为它显式赋值，否则会创建一个同名独立局部变量，该变量会用它的魔法行为屏蔽内置变量。

除了 int 和 float，Python 还支持其他数字类型，例如 Decimal 或 Fraction。Python 还内置支持 复数，后缀 j 或 J 用于表示虚数（例如 3+5j ）。

3.1.2. 字符串

除了数字，Python 还可以操作字符串。字符串有多种表现形式，用单引号（'……'）或双引号（"……"）标注的结果相同 2。反斜杠 \ 用于转义：

>>> 'spam eggs'  # single quotes
'spam eggs'
>>> 'doesn\'t'  # use \' to escape the single quote...
"doesn't"
>>> "doesn't"  # ...or use double quotes instead
"doesn't"
>>> '"Yes," they said.'
'"Yes," they said.'
>>> "\"Yes,\" they said."
'"Yes," they said.'
>>> '"Isn\'t," they said.'
'"Isn\'t," they said.'

交互式解释器会为输出的字符串加注引号，特殊字符使用反斜杠转义。虽然，有时输出的字符串看起来与输入的字符串不一样（外加的引号可能会改变），但两个字符串是相同的。如果字符串中有单引号而没有双引号，该字符串外将加注双引号，反之，则加注单引号。print() 函数输出的内容更简洁易读，它会省略两边的引号，并输出转义后的特殊字符：

>>> '"Isn\'t," they said.'
'"Isn\'t," they said.'
>>> print('"Isn\'t," they said.')
"Isn't," they said.
>>> s = 'First line.\nSecond line.'  # \n means newline
>>> s  # without print(), \n is included in the output
'First line.\nSecond line.'
>>> print(s)  # with print(), \n produces a new line
First line.
Second line.

如果不希望前置 \ 的字符转义成特殊字符，可以使用 原始字符串，在引号前添加 r 即可：

>>> print('C:\some\name')  # here \n means newline!
C:\some
ame
>>> print(r'C:\some\name')  # note the r before the quote
C:\some\name

原始字符串还有一个微妙的限制：一个原始字符串不能以奇数个 \ 字符结束；请参阅 此 FAQ 条目 了解更多信息及绕过的办法。

字符串字面值可以包含多行。 一种实现方式是使用三重引号："""...""" 或 '''...'''。 字符串中将自动包括行结束符，但也可以在换行的地方添加一个 \ 来避免此情况。 参见以下示例：

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

字符串可以用 + 合并（粘到一起），也可以用 * 重复：

>>> # 3 times 'un', followed by 'ium'
>>> 3 * 'un' + 'ium'
'unununium'

相邻的两个或多个 字符串字面值 （引号标注的字符）会自动合并：

>>> 'Py' 'thon'
'Python'

拼接分隔开的长字符串时，这个功能特别实用：

>>> text = ('Put several strings within parentheses '
...         'to have them joined together.')
>>> text
'Put several strings within parentheses to have them joined together.'

这项功能只能用于两个字面值，不能用于变量或表达式：

>>> prefix = 'Py'
>>> prefix 'thon'  # can't concatenate a variable and a string literal
  File "<stdin>", line 1
    prefix 'thon'
           ^^^^^^
SyntaxError: invalid syntax
>>> ('un' * 3) 'ium'
  File "<stdin>", line 1
    ('un' * 3) 'ium'
               ^^^^^
SyntaxError: invalid syntax

合并多个变量，或合并变量与字面值，要用 +：

>>> prefix + 'thon'
'Python'

字符串支持 索引 （下标访问），第一个字符的索引是 0。单字符没有专用的类型，就是长度为一的字符串：

>>> word = 'Python'
>>> word[0]  # character in position 0
'P'
>>> word[5]  # character in position 5
'n'

索引还支持负数，用负数索引时，从右边开始计数：

>>> word[-1]  # last character
'n'
>>> word[-2]  # second-last character
'o'
>>> word[-6]
'P'

注意，-0 和 0 一样，因此，负数索引从 -1 开始。

除了索引，字符串还支持 切片。索引可以提取单个字符，切片 则提取子字符串：

>>> word[0:2]  # characters from position 0 (included) to 2 (excluded)
'Py'
>>> word[2:5]  # characters from position 2 (included) to 5 (excluded)
'tho'

切片索引的默认值很有用；省略开始索引时，默认值为 0，省略结束索引时，默认为到字符串的结尾：

>>> word[:2]   # character from the beginning to position 2 (excluded)
'Py'
>>> word[4:]   # characters from position 4 (included) to the end
'on'
>>> word[-2:]  # characters from the second-last (included) to the end
'on'

注意，输出结果包含切片开始，但不包含切片结束。因此，s[:i] + s[i:] 总是等于 s：

>>> word[:2] + word[2:]
'Python'
>>> word[:4] + word[4:]
'Python'

还可以这样理解切片，索引指向的是字符 之间 ，第一个字符的左侧标为 0，最后一个字符的右侧标为 n ，n 是字符串长度。例如：

 +---+---+---+---+---+---+
 | P | y | t | h | o | n |
 +---+---+---+---+---+---+
 0   1   2   3   4   5   6
-6  -5  -4  -3  -2  -1

第一行数字是字符串中索引 0...6 的位置，第二行数字是对应的负数索引位置。i 到 j 的切片由 i 和 j 之间所有对应的字符组成。

对于使用非负索引的切片，如果两个索引都不越界，切片长度就是起止索引之差。例如， word[1:3] 的长度是 2。

索引越界会报错：

>>> word[42]  # the word only has 6 characters
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
IndexError: string index out of range

但是，切片会自动处理越界索引：

>>> word[4:42]
'on'
>>> word[42:]
''

Python 字符串不能修改，是 immutable 的。因此，为字符串中某个索引位置赋值会报错：

>>> 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

要生成不同的字符串，应新建一个字符串：

>>> 'J' + word[1:]
'Jython'
>>> word[:2] + 'py'
'Pypy'

内置函数 len() 返回字符串的长度：

>>> s = 'supercalifragilisticexpialidocious'
>>> len(s)
34

参见

文本序列类型 --- str

字符串是 序列类型 ，支持序列类型的各种操作。

字符串的方法

字符串支持很多变形与查找方法。

格式字符串字面值

内嵌表达式的字符串字面值。

格式字符串语法

使用 str.format() 格式化字符串。

printf 风格的字符串格式化

这里详述了用 % 运算符格式化字符串的操作。

3.1.3. 列表

Python 支持多种 复合 数据类型，可将不同值组合在一起。最常用的 列表 ，是用方括号标注，逗号分隔的一组值。列表 可以包含不同类型的元素，但一般情况下，各个元素的类型相同：

>>> squares = [1, 4, 9, 16, 25]
>>> squares
[1, 4, 9, 16, 25]

和字符串（及其他内置 sequence 类型）一样，列表也支持索引和切片：

>>> squares[0]  # indexing returns the item
1
>>> squares[-1]
25
>>> squares[-3:]  # slicing returns a new list
[9, 16, 25]

切片操作返回包含请求元素的新列表。以下切片操作会返回列表的 浅拷贝：

>>> squares[:]
[1, 4, 9, 16, 25]

列表还支持合并操作：

>>> squares + [36, 49, 64, 81, 100]
[1, 4, 9, 16, 25, 36, 49, 64, 81, 100]

与 immutable 字符串不同, 列表是 mutable 类型，其内容可以改变：

>>> cubes = [1, 8, 27, 65, 125]  # something's wrong here
>>> 4 ** 3  # the cube of 4 is 64, not 65!
64
>>> cubes[3] = 64  # replace the wrong value
>>> cubes
[1, 8, 27, 64, 125]

append() 方法 可以在列表末尾添加新元素（后面我们会看到更多例子）：

>>> cubes.append(216)  # add the cube of 6
>>> cubes.append(7 ** 3)  # and the cube of 7
>>> cubes
[1, 8, 27, 64, 125, 216, 343]

为切片赋值可以改变列表大小，甚至清空整个列表：

>>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> letters
['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> # replace some values
>>> letters[2:5] = ['C', 'D', 'E']
>>> letters
['a', 'b', 'C', 'D', 'E', 'f', 'g']
>>> # now remove them
>>> letters[2:5] = []
>>> letters
['a', 'b', 'f', 'g']
>>> # clear the list by replacing all the elements with an empty list
>>> letters[:] = []
>>> letters
[]

内置函数 len() 也支持列表：

>>> letters = ['a', 'b', 'c', 'd']
>>> len(letters)
4

还可以嵌套列表（创建包含其他列表的列表），例如：

>>> 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'

3.2. 走向编程的第一步

当然，Python 还可以完成比二加二更复杂的任务。 例如，可以编写 斐波那契数列 [https://en.wikipedia.org/wiki/Fibonacci_number] 的初始子序列，如下所示：

>>> # Fibonacci series:
... # the sum of two elements defines the next
... a, b = 0, 1
>>> while a < 10:
...     print(a)
...     a, b = b, a+b
...
0
1
1
2
3
5
8

本例引入了几个新功能。

第一行中的 多重赋值 ：变量 a 和 b 同时获得新值 0 和 1 。最后一行又用了一次多重赋值，体现了，等号右边的所有表达式的值，都是在这一语句对任何变量赋新值之前求出来的——求值顺序为从左到右。

while 循环只要条件（这里是 a < 10）为真就会一直执行。Python 和 C 一样，任何非零整数都为真，零为假。这个条件也可以是字符串或列表类型的值，事实上，任何序列都可以：长度非零就为真，空序列则为假。示例中的判断只是最简单的比较。比较操作符的写法和 C 语言一样： < （小于）、 > （大于）、 == （等于）、 <= （小于等于)、 >= （大于等于）及 != （不等于）。

循环体 是 缩进的 ：缩进是 Python 组织语句的方式。在交互式命令行里，得为每个缩进的行输入空格（或制表符）。使用文本编辑器可以实现更复杂的输入方式；所有像样的文本编辑器都支持自动缩进。交互式输入复合语句时，要在最后输入空白行表示完成（因为解析器不知道哪一行代码是代码块的最后一行）。注意，同一块语句的每一行的缩进相同。

print() 函数输出给定参数的值。除了可以以单一的表达式作为参数（比如，前面的计算器的例子），它还能处理多个参数，包括浮点数与字符串。它输出的字符串不带引号，且各参数项之间会插入一个空格，这样可以实现更好的格式化操作：

>>> i = 256*256
>>> print('The value of i is', i)
The value of i is 65536

关键字参数 end 可以取消输出后面的换行, 或用另一个字符串结尾：

>>> 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,

备注

1

** 比 - 的优先级更高, 所以 -3**2 会被解释成 -(3**2) ，因此，结果是 -9。要避免这个问题，并且得到 9, 可以用 (-3)**2。

2

与其他语言不同，特殊字符如 \n 在单引号（'...' ）和双引号（"..." ）里的意义一样。这两种引号唯一的区别是，不需要在单引号里转义双引号 " （但此时必须把单引号转义成 \' ），反之亦然。

4. 更多控制流工具

除了上一章介绍的 while 语句，Python 还支持其他语言中常见的流程控制语句，只是稍有不同。

4.1. if 语句

最让人耳熟能详的语句应当是 if 语句：

>>> 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

可有零个或多个 elif 部分，else 部分也是可选的。关键字 'elif' 是 'else if' 的缩写，用于避免过多的缩进。if ... elif ... elif ... 序列可以当作其它语言中 switch 或 case 语句的替代品。

如果是把一个值与多个常量进行比较，或者检查特定类型或属性，match 语句更有用。详见 match 语句。

4.2. for 语句

Python 的 for 语句与 C 或 Pascal 中的不同。Python 的 for 语句不迭代算术递增数值（如 Pascal），或是给予用户定义迭代步骤和结束条件的能力（如 C），而是在列表或字符串等任意序列的元素上迭代，按它们在序列中出现的顺序。 例如（这不是有意要暗指什么）：

>>> # Measure some strings:
... words = ['cat', 'window', 'defenestrate']
>>> for w in words:
...     print(w, len(w))
...
cat 3
window 6
defenestrate 12

很难正确地在迭代多项集的同时修改多项集的内容。更简单的方法是迭代多项集的副本或者创建新的多项集：

# Create a sample collection
users = {'Hans': 'active', 'Éléonore': 'inactive', '景太郎': 'active'}

# Strategy:  Iterate over a copy
for user, status in users.copy().items():
    if status == 'inactive':
        del users[user]

# Strategy:  Create a new collection
active_users = {}
for user, status in users.items():
    if status == 'active':
        active_users[user] = status

4.3. range() 函数

内置函数 range() 用于生成等差数列：

>>> for i in range(5):
...     print(i)
...
0
1
2
3
4

生成的序列绝不会包括给定的终止值；range(10) 生成 10 个值——长度为 10 的序列的所有合法索引。range 可以不从 0 开始，且可以按给定的步长递增（即使是负数步长）：

>>> 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]

要按索引迭代序列，可以组合使用 range() 和 len()：

>>> 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

不过大多数情况下 enumerate() 函数很方便，详见 循环的技巧。

如果直接打印一个 range 会发生意想不到的事情：

>>> range(10)
range(0, 10)

range() 返回的对象在很多方面和列表的行为一样，但其实它和列表不一样。该对象只有在被迭代时才一个一个地返回所期望的列表项，并没有真正生成过一个含有全部项的列表，从而节省了空间。

这种对象称为可迭代对象 iterable，适合作为需要获取一系列值的函数或程序构件的参数。for 语句就是这样的程序构件；以可迭代对象作为参数的函数例如 sum()：

>>> sum(range(4))  # 0 + 1 + 2 + 3
6

之后我们会看到更多返回可迭代对象，或以可迭代对象作为参数的函数。在 数据结构 这一章中，我们将讨论 list() 的更多细节。

4.4. 循环中的 break、continue 语句及 else 子句

break 语句和 C 中的类似，用于跳出最近的 for 或 while 循环。

循环语句支持 else 子句；for 循环中，可迭代对象中的元素全部循环完毕，或 while 循环的条件为假时，执行该子句；break 语句终止循环时，不执行该子句。 请看下面这个查找素数的循环示例：

>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(n, 'equals', x, '*', n//x)
...             break
...     else:
...         # loop fell through without finding a factor
...         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

（没错，这段代码就是这么写。仔细看：else 子句属于 for 循环，不属于 if 语句。）

else 子句用于循环时比起 if 语句的 else 子句，更像 try 语句的。try 语句的 else 子句在未发生异常时执行，循环的 else 子句则在未发生 break 时执行。 try 语句和异常详见 异常的处理。

continue 语句，同样借鉴自 C 语言，以执行循环的下一次迭代来继续：

>>> for num in range(2, 10):
...     if num % 2 == 0:
...         print("Found an even number", num)
...         continue
...     print("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

4.5. pass 语句

pass 语句不执行任何动作。语法上需要一个语句，但程序毋需执行任何动作时，可以使用该语句。例如：

>>> while True:
...     pass  # Busy-wait for keyboard interrupt (Ctrl+C)
...

这常用于创建一个最小的类：

>>> class MyEmptyClass:
...     pass
...

pass 还可用作函数或条件语句体的占位符，让你保持在更抽象的层次进行思考。pass 会被默默地忽略：

>>> def initlog(*args):
...     pass   # Remember to implement this!
...

4.6. match 语句

match 语句接受一个表达式并把它的值与一个或多个 case 块给出的一系列模式进行比较。这表面上像 C、Java 或 JavaScript（以及许多其他程序设计语言）中的 switch 语句，但其实它更像 Rust 或 Haskell 中的模式匹配。只有第一个匹配的模式会被执行，并且它还可以提取值的组成部分（序列的元素或对象的属性）赋给变量。

最简单的形式是将一个主语值与一个或多个字面值进行比较：

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"

注意最后一个代码块：“变量名” _ 被作为 通配符 并必定会匹配成功。如果没有 case 匹配成功，则不会执行任何分支。

你可以使用 | （“ or ”）在一个模式中组合几个字面值:

case 401 | 403 | 404:
    return "Not allowed"

形如解包赋值的模式可被用于绑定变量：

# point is an (x, y) tuple
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")

请仔细学习此代码！第一个模式有两个字面值，可视为前述字面值模式的扩展。接下来的两个模式结合了一个字面值和一个变量，变量 绑定 了来自主语（point）的一个值。第四个模式捕获了两个值，使其在概念上与解包赋值 (x, y) = point 类似。

如果用类组织数据，可以用“类名后接一个参数列表”这种很像构造器的形式，把属性捕获到变量里：

class Point:
    x: int
    y: int

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")

你可以在某些为其属性提供了排序的内置类（例如 dataclass）中使用位置参数。 你也可以通过在你的类中设置 __match_args__ 特殊属性来为模式中的属性定义一个专门的位置。 如果它被设为 ("x", "y")，则以下模式均为等价的（并且都是将 y 属性绑定到 var 变量）:

Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)

建议这样来阅读一个模式——通过将其视为赋值语句等号左边的一种扩展形式，来理解各个变量被设为何值。match 语句只会为单一的名称（如上面的 var）赋值，而不会赋值给带点号的名称（如 foo.bar）、属性名（如上面的 x= 和 y=）和类名（是通过其后的 "(...)" 来识别的，如上面的 Point）。

模式可以任意地嵌套。例如，如果有一个由点组成的短列表，则可使用如下方式进行匹配：

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")

我们可以向一个模式添加 if 子句，称为“约束项”。 如果约束项为假值，则 match 将继续尝试下一个 case 语句块。 请注意值的捕获发生在约束项被求值之前。:

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")

该语句的一些其它关键特性：

与解包赋值类似，元组和列表模式具有完全相同的含义并且实际上都能匹配任意序列，区别是它们不能匹配迭代器或字符串。

序列模式支持扩展解包：[x, y, *rest] 和 (x, y, *rest) 和相应的解包赋值做的事是一样的。接在 * 后的名称也可以为 _，所以 (x, y, *_) 匹配含至少两项的序列，而不必绑定剩余的项。

映射模式：{"bandwidth": b, "latency": l} 从字典中捕获 "bandwidth" 和 "latency" 的值。额外的键会被忽略，这一点与序列模式不同。**rest 这样的解包也支持。（但 **_ 将会是冗余的，故不允许使用。）

子模式可使用 as 关键字来捕获:

case (Point(x1, y1), Point(x2, y2) as p2): ...

将把输入中的第二个元素捕获为 p2 （只要输入是包含两个点的序列）

大多数字面值是按相等性比较的，但是单例对象 True、False 和 None 则是按 id 比较的。

模式可以使用具名常量。它们必须作为带点号的名称出现，以防止它们被解释为用于捕获的变量：

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 :(")

更详细的说明和更多示例，可参阅以教程格式撰写的 PEP 636 [https://www.python.org/dev/peps/pep-0636]。

4.7. 定义函数

下列代码创建一个可以输出限定数值内的斐波那契数列函数：

>>> def fib(n):    # write Fibonacci series up to n
...     """Print a Fibonacci series up to n."""
...     a, b = 0, 1
...     while a < n:
...         print(a, end=' ')
...         a, b = b, a+b
...     print()
...
>>> # Now call the function we just defined:
... fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597

定义 函数使用关键字 def，后跟函数名与括号内的形参列表。函数语句从下一行开始，并且必须缩进。

函数内的第一条语句是字符串时，该字符串就是文档字符串，也称为 docstring，详见 文档字符串。利用文档字符串可以自动生成在线文档或打印版文档，还可以让开发者在浏览代码时直接查阅文档；Python 开发者最好养成在代码中加入文档字符串的好习惯。

函数在 执行 时使用函数局部变量符号表，所有函数变量赋值都存在局部符号表中；引用变量时，首先，在局部符号表里查找变量，然后，是外层函数局部符号表，再是全局符号表，最后是内置名称符号表。因此，尽管可以引用全局变量和外层函数的变量，但最好不要在函数内直接赋值（除非是 global 语句定义的全局变量，或 nonlocal 语句定义的外层函数变量）。

在调用函数时会将实际参数（实参）引入到被调用函数的局部符号表中；因此，实参是使用 按值调用 来传递的（其中的 值 始终是对象的 引用 而不是对象的值）。 1 当一个函数调用另外一个函数时，会为该调用创建一个新的局部符号表。

函数定义在当前符号表中把函数名与函数对象关联在一起。解释器把函数名指向的对象作为用户自定义函数。还可以使用其他名称指向同一个函数对象，并访问访该函数：

>>> fib
<function fib at 10042ed0>
>>> f = fib
>>> f(100)
0 1 1 2 3 5 8 13 21 34 55 89

如果你用过其他语言，你可能会认为 fib 不是函数而是一个过程，因为它没有返回值。 事实上，即使没有 return 语句的函数也有返回值，尽管这个值可能相当无聊。 这个值被称为 None (是一个内置名称)。 通常解释器会屏蔽单独的返回值 None。 如果你确有需要可以使用 print() 查看它:

>>> fib(0)
>>> print(fib(0))
None

编写不直接输出斐波那契数列运算结果，而是返回运算结果列表的函数也非常简单：

>>> def fib2(n):  # return Fibonacci series up to n
...     """Return a list containing the Fibonacci series up to n."""
...     result = []
...     a, b = 0, 1
...     while a < n:
...         result.append(a)    # see below
...         a, b = b, a+b
...     return result
...
>>> f100 = fib2(100)    # call it
>>> f100                # write the result
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

本例也新引入了一些 Python 功能：

return 语句返回函数的值。return 语句不带表达式参数时，返回 None。函数执行完毕退出也返回 None。

result.append(a) 语句调用了列表对象 result 的 方法 。方法是“从属于”对象的函数，命名为 obj.methodname，obj 是对象（也可以是表达式），methodname 是对象类型定义的方法名。不同类型定义不同的方法，不同类型的方法名可以相同，且不会引起歧义。（用 类 可以自定义对象类型和方法，详见 类 ）示例中的方法 append() 是为列表对象定义的，用于在列表末尾添加新元素。本例中，该方法相当于 result = result + [a] ，但更有效。

4.8. 函数定义详解

函数定义支持可变数量的参数。这里列出三种可以组合使用的形式。

4.8.1. 默认值参数

为参数指定默认值是非常有用的方式。调用函数时，可以使用比定义时更少的参数，例如：

def ask_ok(prompt, retries=4, reminder='Please try again!'):
    while True:
        ok = input(prompt)
        if ok in ('y', 'ye', 'yes'):
            return True
        if ok in ('n', 'no', 'nop', 'nope'):
            return False
        retries = retries - 1
        if retries < 0:
            raise ValueError('invalid user response')
        print(reminder)

该函数可以用以下方式调用：

只给出必选实参：ask_ok('Do you really want to quit?')

给出一个可选实参：ask_ok('OK to overwrite the file?', 2)

给出所有实参：ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')

本例还使用了关键字 in ，用于确认序列中是否包含某个值。

默认值在 定义 作用域里的函数定义中求值，所以：

i = 5

def f(arg=i):
    print(arg)

i = 6
f()

上例输出的是 5。

重要警告： 默认值只计算一次。默认值为列表、字典或类实例等可变对象时，会产生与该规则不同的结果。例如，下面的函数会累积后续调用时传递的参数：

def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))

输出结果如下：

[1]
[1, 2]
[1, 2, 3]

不想在后续调用之间共享默认值时，应以如下方式编写函数：

def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L

4.8.2. 关键字参数

kwarg=value 形式的 关键字参数 也可以用于调用函数。函数示例如下：

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, "!")

该函数接受一个必选参数（voltage）和三个可选参数（state, action 和 type）。该函数可用下列方式调用：

parrot(1000)                                          # 1 positional argument
parrot(voltage=1000)                                  # 1 keyword argument
parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword

以下调用函数的方式都无效：

parrot()                     # required argument missing
parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
parrot(110, voltage=220)     # duplicate value for the same argument
parrot(actor='John Cleese')  # unknown keyword argument

函数调用时，关键字参数必须跟在位置参数后面。所有传递的关键字参数都必须匹配一个函数接受的参数（比如，actor 不是函数 parrot 的有效参数），关键字参数的顺序并不重要。这也包括必选参数，（比如，parrot(voltage=1000) 也有效）。不能对同一个参数多次赋值，下面就是一个因此限制而失败的例子：

>>> 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'

最后一个形参为 **name 形式时，接收一个字典（详见 映射类型 --- dict），该字典包含与函数中已定义形参对应之外的所有关键字参数。**name 形参可以与 *name 形参（下一小节介绍）组合使用（*name 必须在 **name 前面）， *name 形参接收一个 元组，该元组包含形参列表之外的位置参数。例如，可以定义下面这样的函数：

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])

该函数可以用如下方式调用：

cheeseshop("Limburger", "It's very runny, sir.",
           "It's really very, VERY runny, sir.",
           shopkeeper="Michael Palin",
           client="John Cleese",
           sketch="Cheese Shop Sketch")

输出结果如下：

-- 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

注意，关键字参数在输出结果中的顺序与调用函数时的顺序一致。

4.8.3. 特殊参数

默认情况下，参数可以按位置或显式关键字传递给 Python 函数。为了让代码易读、高效，最好限制参数的传递方式，这样，开发者只需查看函数定义，即可确定参数项是仅按位置、按位置或关键字，还是仅按关键字传递。

函数定义如下：

def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
      -----------    ----------     ----------
        |             |                  |
        |        Positional or keyword   |
        |                                - Keyword only
         -- Positional only

/ 和 * 是可选的。这些符号表明形参如何把参数值传递给函数：位置、位置或关键字、关键字。关键字形参也叫作命名形参。

4.8.3.1. 位置或关键字参数

函数定义中未使用 / 和 * 时，参数可以按位置或关键字传递给函数。

4.8.3.2. 仅位置参数

此处再介绍一些细节，特定形参可以标记为 仅限位置。仅限位置 时，形参的顺序很重要，且这些形参不能用关键字传递。仅限位置形参应放在 / （正斜杠）前。/ 用于在逻辑上分割仅限位置形参与其它形参。如果函数定义中没有 /，则表示没有仅限位置形参。

/ 后可以是 位置或关键字 或 仅限关键字 形参。

4.8.3.3. 仅限关键字参数

把形参标记为 仅限关键字，表明必须以关键字参数形式传递该形参，应在参数列表中第一个 仅限关键字 形参前添加 *。

4.8.3.4. 函数示例

请看下面的函数定义示例，注意 / 和 * 标记：

>>> 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)

第一个函数定义 standard_arg 是最常见的形式，对调用方式没有任何限制，可以按位置也可以按关键字传递参数：

>>> standard_arg(2)
2

>>> standard_arg(arg=2)
2

第二个函数 pos_only_arg 的函数定义中有 /，仅限使用位置形参：

>>> 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'

第三个函数 kwd_only_args 的函数定义通过 * 表明仅限关键字参数：

>>> 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

最后一个函数在同一个函数定义中，使用了全部三种调用惯例：

>>> 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'

下面的函数定义中，kwds 把 name 当作键，因此，可能与位置参数 name 产生潜在冲突：

def foo(name, **kwds):
    return 'name' in kwds

调用该函数不可能返回 True，因为关键字 'name' 总与第一个形参绑定。例如：

>>> foo(1, **{'name': 2})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got multiple values for argument 'name'
>>>

加上 / （仅限位置参数）后，就可以了。此时，函数定义把 name 当作位置参数，'name' 也可以作为关键字参数的键：

def foo(name, /, **kwds):
    return 'name' in kwds
>>> foo(1, **{'name': 2})
True

换句话说，仅限位置形参的名称可以在 **kwds 中使用，而不产生歧义。

4.8.3.5. 小结

以下用例决定哪些形参可以用于函数定义：

def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

说明：

使用仅限位置形参，可以让用户无法使用形参名。形参名没有实际意义时，强制调用函数的实参顺序时，或同时接收位置形参和关键字时，这种方式很有用。

当形参名有实际意义，且显式名称可以让函数定义更易理解时，阻止用户依赖传递实参的位置时，才使用关键字。

对于 API，使用仅限位置形参，可以防止未来修改形参名时造成破坏性的 API 变动。

4.8.4. 任意实参列表

调用函数时，使用任意数量的实参是最少见的选项。这些实参包含在元组中（详见 元组和序列 ）。在可变数量的实参之前，可能有若干个普通参数：

def write_multiple_items(file, separator, *args):
    file.write(separator.join(args))

variadic 参数用于采集传递给函数的所有剩余参数，因此，它们通常在形参列表的末尾。*args 形参后的任何形式参数只能是仅限关键字参数，即只能用作关键字参数，不能用作位置参数：

>>> def concat(*args, sep="/"):
...     return sep.join(args)
...
>>> concat("earth", "mars", "venus")
'earth/mars/venus'
>>> concat("earth", "mars", "venus", sep=".")
'earth.mars.venus'

4.8.5. 解包实参列表

函数调用要求独立的位置参数，但实参在列表或元组里时，要执行相反的操作。例如，内置的 range() 函数要求独立的 start 和 stop 实参。如果这些参数不是独立的，则要在调用函数时，用 * 操作符把实参从列表或元组解包出来：

>>> list(range(3, 6))            # normal call with separate arguments
[3, 4, 5]
>>> args = [3, 6]
>>> list(range(*args))            # call with arguments unpacked from a list
[3, 4, 5]

同样，字典可以用 ** 操作符传递关键字参数：

>>> 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 !

4.8.6. Lambda 表达式

lambda 关键字用于创建小巧的匿名函数。lambda a, b: a+b 函数返回两个参数的和。Lambda 函数可用于任何需要函数对象的地方。在语法上，匿名函数只能是单个表达式。在语义上，它只是常规函数定义的语法糖。与嵌套函数定义一样，lambda 函数可以引用包含作用域中的变量：

>>> def make_incrementor(n):
...     return lambda x: x + n
...
>>> f = make_incrementor(42)
>>> f(0)
42
>>> f(1)
43

上例用 lambda 表达式返回函数。还可以把匿名函数用作传递的实参：

>>> 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')]

4.8.7. 文档字符串

以下是文档字符串内容和格式的约定。

第一行应为对象用途的简短摘要。为保持简洁，不要在这里显式说明对象名或类型，因为可通过其他方式获取这些信息（除非该名称碰巧是描述函数操作的动词）。这一行应以大写字母开头，以句点结尾。

文档字符串为多行时，第二行应为空白行，在视觉上将摘要与其余描述分开。后面的行可包含若干段落，描述对象的调用约定、副作用等。

Python 解析器不会删除 Python 中多行字符串字面值的缩进，因此，文档处理工具应在必要时删除缩进。这项操作遵循以下约定：文档字符串第一行 之后 的第一个非空行决定了整个文档字符串的缩进量（第一行通常与字符串开头的引号相邻，其缩进在字符串中并不明显，因此，不能用第一行的缩进），然后，删除字符串中所有行开头处与此缩进“等价”的空白符。不能有比此缩进更少的行，但如果出现了缩进更少的行，应删除这些行的所有前导空白符。转化制表符后（通常为 8 个空格），应测试空白符的等效性。

下面是多行文档字符串的一个例子：

>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything.
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

    No, really, it doesn't do anything.

4.8.8. 函数注解

函数注解 是可选的用户自定义函数类型的元数据完整信息（详见 PEP 3107 [https://www.python.org/dev/peps/pep-3107] 和 PEP 484 [https://www.python.org/dev/peps/pep-0484] ）。

标注 以字典的形式存放在函数的 __annotations__ 属性中，并且不会影响函数的任何其他部分。 形参标注的定义方式是在形参名后加冒号，后面跟一个表达式，该表达式会被求值为标注的值。 返回值标注的定义方式是加组合符号 ->，后面跟一个表达式，该标注位于形参列表和表示 def 语句结束的冒号之间。 下面的示例有一个必须的参数，一个可选的关键字参数以及返回值都带有相应的标注:

>>> 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'

4.9. 小插曲：编码风格

现在你将要写更长，更复杂的 Python 代码，是时候讨论一下 代码风格 了。 大多数语言都能以不同的风格被编写（或更准确地说，被格式化）；有些比其他的更具有可读性。 能让其他人轻松阅读你的代码总是一个好主意，采用一种好的编码风格对此有很大帮助。

Python 项目大多都遵循 PEP 8 [https://www.python.org/dev/peps/pep-0008] 的风格指南；它推行的编码风格易于阅读、赏心悦目。Python 开发者均应抽时间悉心研读；以下是该提案中的核心要点：

缩进，用 4 个空格，不要用制表符。

4 个空格是小缩进（更深嵌套）和大缩进（更易阅读）之间的折中方案。制表符会引起混乱，最好别用。

换行，一行不超过 79 个字符。

这样换行的小屏阅读体验更好，还便于在大屏显示器上并排阅读多个代码文件。

用空行分隔函数和类，及函数内较大的代码块。

最好把注释放到单独一行。

使用文档字符串。

运算符前后、逗号后要用空格，但不要直接在括号内使用： a = f(1, 2) + g(3, 4)。

类和函数的命名要一致；按惯例，命名类用 UpperCamelCase，命名函数与方法用 lowercase_with_underscores。命名方法中第一个参数总是用 self (类和方法详见 初探类)。

编写用于国际多语环境的代码时，不要用生僻的编码。Python 默认的 UTF-8 或纯 ASCII 可以胜任各种情况。

同理，就算多语阅读、维护代码的可能再小，也不要在标识符中使用非 ASCII 字符。

备注

1

实际上，对象引用调用 这种说法更好，因为，传递的是可变对象时，调用者能发现被调者做出的任何更改（插入列表的元素）。

5. 数据结构

本章深入讲解之前学过的一些内容，同时，还增加了新的知识点。

5.1. 列表详解

列表数据类型支持很多方法，列表对象的所有方法所示如下：

list.append(x)

在列表末尾添加一个元素，相当于 a[len(a):] = [x] 。

list.extend(iterable)

用可迭代对象的元素扩展列表。相当于 a[len(a):] = iterable 。

list.insert(i, x)

在指定位置插入元素。第一个参数是插入元素的索引，因此，a.insert(0, x) 在列表开头插入元素， a.insert(len(a), x) 等同于 a.append(x) 。

list.remove(x)

从列表中删除第一个值为 x 的元素。未找到指定元素时，触发 ValueError 异常。

list.pop([i])

删除列表中指定位置的元素，并返回被删除的元素。未指定位置时，a.pop() 删除并返回列表的最后一个元素。（方法签名中 i 两边的方括号表示该参数是可选的，不是要求输入方括号。这种表示法常见于 Python 参考库）。

list.clear()

删除列表里的所有元素，相当于 del a[:] 。

list.index(x[, start[, end]])

返回列表中第一个值为 x 的元素的零基索引。未找到指定元素时，触发 ValueError 异常。

可选参数 start 和 end 是切片符号，用于将搜索限制为列表的特定子序列。返回的索引是相对于整个序列的开始计算的，而不是 start 参数。

list.count(x)

返回列表中元素 x 出现的次数。

list.sort(*, key=None, reverse=False)

就地排序列表中的元素（要了解自定义排序参数，详见 sorted()）。

list.reverse()

翻转列表中的元素。

list.copy()

返回列表的浅拷贝。相当于 a[:] 。

多数列表方法示例：

>>> fruits = ['orange', 'apple', 'pear', 'banana', 'kiwi', 'apple', 'banana']
>>> fruits.count('apple')
2
>>> fruits.count('tangerine')
0
>>> fruits.index('banana')
3
>>> fruits.index('banana', 4)  # Find next banana starting a position 4
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'

你可能已经注意到 insert, remove 或 sort 等仅修改列表的方法都不会打印返回值 -- 它们返回默认值 None。 1 这是适用于 Python 中所有可变数据结构的设计原则。

还有，不是所有数据都可以排序或比较。例如，[None, 'hello', 10] 就不可排序，因为整数不能与字符串对比，而 None 不能与其他类型对比。有些类型根本就没有定义顺序关系，例如，3+4j < 5+7j 这种对比操作就是无效的。

5.1.1. 用列表实现堆栈

使用列表方法实现堆栈非常容易，最后插入的最先取出（“后进先出”）。把元素添加到堆栈的顶端，使用 append() 。从堆栈顶部取出元素，使用 pop() ，不用指定索引。例如：

>>> 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]

5.1.2. 用列表实现队列

列表也可以用作队列，最先加入的元素，最先取出（“先进先出”）；然而，列表作为队列的效率很低。因为，在列表末尾添加和删除元素非常快，但在列表开头插入或移除元素却很慢（因为所有其他元素都必须移动一位）。

实现队列最好用 collections.deque，可以快速从两端添加或删除元素。例如：

>>> from collections import deque
>>> queue = deque(["Eric", "John", "Michael"])
>>> queue.append("Terry")           # Terry arrives
>>> queue.append("Graham")          # Graham arrives
>>> queue.popleft()                 # The first to arrive now leaves
'Eric'
>>> queue.popleft()                 # The second to arrive now leaves
'John'
>>> queue                           # Remaining queue in order of arrival
deque(['Michael', 'Terry', 'Graham'])

5.1.3. 列表推导式

列表推导式创建列表的方式更简洁。常见的用法为，对序列或可迭代对象中的每个元素应用某种操作，用生成的结果创建新的列表；或用满足特定条件的元素创建子序列。

例如，创建平方值的列表：

>>> squares = []
>>> for x in range(10):
...     squares.append(x**2)
...
>>> squares
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

注意，这段代码创建（或覆盖）变量 x，该变量在循环结束后仍然存在。下述方法可以无副作用地计算平方列表：

squares = list(map(lambda x: x**2, range(10)))

或等价于：

squares = [x**2 for x in range(10)]

上面这种写法更简洁、易读。

列表推导式的方括号内包含以下内容：一个表达式，后面为一个 for 子句，然后，是零个或多个 for 或 if 子句。结果是由表达式依据 for 和 if 子句求值计算而得出一个新列表。 举例来说，以下列表推导式将两个列表中不相等的元素组合起来：

>>> [(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)]

等价于：

>>> 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)]

注意，上面两段代码中，for 和 if 的顺序相同。

表达式是元组（例如上例的 (x, y)）时，必须加上括号：

>>> vec = [-4, -2, 0, 2, 4]
>>> # create a new list with the values doubled
>>> [x*2 for x in vec]
[-8, -4, 0, 4, 8]
>>> # filter the list to exclude negative numbers
>>> [x for x in vec if x >= 0]
[0, 2, 4]
>>> # apply a function to all the elements
>>> [abs(x) for x in vec]
[4, 2, 0, 2, 4]
>>> # call a method on each element
>>> freshfruit = ['  banana', '  loganberry ', 'passion fruit  ']
>>> [weapon.strip() for weapon in freshfruit]
['banana', 'loganberry', 'passion fruit']
>>> # create a list of 2-tuples like (number, square)
>>> [(x, x**2) for x in range(6)]
[(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)]
>>> # the tuple must be parenthesized, otherwise an error is raised
>>> [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?
>>> # flatten a list using a listcomp with two '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]

列表推导式可以使用复杂的表达式和嵌套函数：

>>> from math import pi
>>> [str(round(pi, i)) for i in range(1, 6)]
['3.1', '3.14', '3.142', '3.1416', '3.14159']

5.1.4. 嵌套的列表推导式

列表推导式中的初始表达式可以是任何表达式，甚至可以是另一个列表推导式。

下面这个 3x4 矩阵，由 3 个长度为 4 的列表组成：

>>> matrix = [
...     [1, 2, 3, 4],
...     [5, 6, 7, 8],
...     [9, 10, 11, 12],
... ]

下面的列表推导式可以转置行列：

>>> [[row[i] for row in matrix] for i in range(4)]
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]

如上节所示，嵌套的列表推导式基于其后的 for 求值，所以这个例子等价于：

>>> 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]]

反过来说，也等价于：

>>> transposed = []
>>> for i in range(4):
...     # the following 3 lines implement the nested listcomp
...     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]]

实际应用中，最好用内置函数替代复杂的流程语句。此时，zip() 函数更好用：

>>> list(zip(*matrix))
[(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)]

关于本行中星号的详细说明，参见 解包实参列表。

5.2. del 语句

del 语句按索引，而不是值从列表中移除元素。与返回值的 pop() 方法不同， del 语句也可以从列表中移除切片，或清空整个列表（之前是将空列表赋值给切片）。 例如：

>>> 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
[]

del 也可以用来删除整个变量：

>>> del a

此后，再引用 a 就会报错（直到为它赋与另一个值）。后文会介绍 del 的其他用法。

5.3. 元组和序列

列表和字符串有很多共性，例如，索引和切片操作。这两种数据类型是 序列 （参见 序列类型 --- list, tuple, range）。随着 Python 语言的发展，其他的序列类型也被加入其中。本节介绍另一种标准序列类型：元组。

元组由多个用逗号隔开的值组成，例如：

>>> t = 12345, 54321, 'hello!'
>>> t[0]
12345
>>> t
(12345, 54321, 'hello!')
>>> # Tuples may be nested:
... u = t, (1, 2, 3, 4, 5)
>>> u
((12345, 54321, 'hello!'), (1, 2, 3, 4, 5))
>>> # Tuples are immutable:
... t[0] = 88888
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'tuple' object does not support item assignment
>>> # but they can contain mutable objects:
... v = ([1, 2, 3], [3, 2, 1])
>>> v
([1, 2, 3], [3, 2, 1])

输出时，元组都要由圆括号标注，这样才能正确地解释嵌套元组。输入时，圆括号可有可无，不过经常是必须的（如果元组是更大的表达式的一部分）。不允许为元组中的单个元素赋值，当然，可以创建含列表等可变对象的元组。

虽然，元组与列表很像，但使用场景不同，用途也不同。元组是 immutable （不可变的），一般可包含异质元素序列，通过解包（见本节下文）或索引访问（如果是 namedtuples，可以属性访问）。列表是 mutable （可变的），列表元素一般为同质类型，可迭代访问。

构造 0 个或 1 个元素的元组比较特殊：为了适应这种情况，对句法有一些额外的改变。用一对空圆括号就可以创建空元组；只有一个元素的元组可以通过在这个元素后添加逗号来构建（圆括号里只有一个值的话不够明确）。丑陋，但是有效。例如：

>>> empty = ()
>>> singleton = 'hello',    # <-- note trailing comma
>>> len(empty)
0
>>> len(singleton)
1
>>> singleton
('hello',)

语句 t = 12345, 54321, 'hello!' 是 元组打包 的例子：值 12345, 54321 和 'hello!' 一起被打包进元组。逆操作也可以：

>>> x, y, z = t

称之为 序列解包 也是妥妥的，适用于右侧的任何序列。序列解包时，左侧变量与右侧序列元素的数量应相等。注意，多重赋值其实只是元组打包和序列解包的组合。

5.4. 集合

Python 还支持 集合 这种数据类型。集合是由不重复元素组成的无序容器。基本用法包括成员检测、消除重复元素。集合对象支持合集、交集、差集、对称差分等数学运算。

创建集合用花括号或 set() 函数。注意，创建空集合只能用 set()，不能用 {}，{} 创建的是空字典，下一小节介绍数据结构：字典。

以下是一些简单的示例

>>> basket = {'apple', 'orange', 'apple', 'pear', 'orange', 'banana'}
>>> print(basket)                      # show that duplicates have been removed
{'orange', 'banana', 'pear', 'apple'}
>>> 'orange' in basket                 # fast membership testing
True
>>> 'crabgrass' in basket
False

>>> # Demonstrate set operations on unique letters from two words
...
>>> a = set('abracadabra')
>>> b = set('alacazam')
>>> a                                  # unique letters in a
{'a', 'r', 'b', 'c', 'd'}
>>> a - b                              # letters in a but not in b
{'r', 'd', 'b'}
>>> a | b                              # letters in a or b or both
{'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'}
>>> a & b                              # letters in both a and b
{'a', 'c'}
>>> a ^ b                              # letters in a or b but not both
{'r', 'd', 'b', 'm', 'z', 'l'}

与 列表推导式 类似，集合也支持推导式：

>>> a = {x for x in 'abracadabra' if x not in 'abc'}
>>> a
{'r', 'd'}

5.5. 字典

字典 （参见 映射类型 --- dict） 也是一种常用的 Python 內置数据类型。其他语言可能把字典称为 联合内存 或 联合数组。与以连续整数为索引的序列不同，字典以 关键字 为索引，关键字通常是字符串或数字，也可以是其他任意不可变类型。只包含字符串、数字、元组的元组，也可以用作关键字。但如果元组直接或间接地包含了可变对象，就不能用作关键字。列表不能当关键字，因为列表可以用索引、切片、append() 、extend() 等方法修改。

可以把字典理解为 键值对 的集合，但字典的键必须是唯一的。花括号 {} 用于创建空字典。另一种初始化字典的方式是，在花括号里输入逗号分隔的键值对，这也是字典的输出方式。

字典的主要用途是通过关键字存储、提取值。用 del 可以删除键值对。用已存在的关键字存储值，与该关键字关联的旧值会被取代。通过不存在的键提取值，则会报错。

对字典执行 list(d) 操作，返回该字典中所有键的列表，按插入次序排列（如需排序，请使用 sorted(d)）。检查字典里是否存在某个键，使用关键字 in。

以下是一些字典的简单示例：

>>> tel = {'jack': 4098, 'sape': 4139}
>>> tel['guido'] = 4127
>>> tel
{'jack': 4098, 'sape': 4139, 'guido': 4127}
>>> tel['jack']
4098
>>> 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

dict() 构造函数可以直接用键值对序列创建字典：

>>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)])
{'sape': 4139, 'guido': 4127, 'jack': 4098}

字典推导式可以用任意键值表达式创建字典：

>>> {x: x**2 for x in (2, 4, 6)}
{2: 4, 4: 16, 6: 36}

关键字是比较简单的字符串时，直接用关键字参数指定键值对更便捷：

>>> dict(sape=4139, guido=4127, jack=4098)
{'sape': 4139, 'guido': 4127, 'jack': 4098}

5.6. 循环的技巧

在字典中循环时，用 items() 方法可同时取出键和对应的值：

>>> knights = {'gallahad': 'the pure', 'robin': 'the brave'}
>>> for k, v in knights.items():
...     print(k, v)
...
gallahad the pure
robin the brave

在序列中循环时，用 enumerate() 函数可以同时取出位置索引和对应的值：

>>> for i, v in enumerate(['tic', 'tac', 'toe']):
...     print(i, v)
...
0 tic
1 tac
2 toe

同时循环两个或多个序列时，用 zip() 函数可以将其内的元素一一匹配：

>>> 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.

为了逆向对序列进行循环，可以求出欲循环的正向序列，然后调用 reversed() 函数：

>>> for i in reversed(range(1, 10, 2)):
...     print(i)
...
9
7
5
3
1

按指定顺序循环序列，可以用 sorted() 函数，在不改动原序列的基础上，返回一个重新的序列：

>>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
>>> for i in sorted(basket):
...     print(i)
...
apple
apple
banana
orange
orange
pear

使用 set() 去除序列中的重复元素。使用 sorted() 加 set() 则按排序后的顺序，循环遍历序列中的唯一元素：

>>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
>>> for f in sorted(set(basket)):
...     print(f)
...
apple
banana
orange
pear

一般来说，在循环中修改列表的内容时，创建新列表比较简单，且安全：

>>> 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]

5.7. 深入条件控制

while 和 if 条件句不只可以进行比较，还可以使用任意运算符。

比较运算符 in 和 not in 用于执行确定一个值是否存在（或不存在）于某个容器中的成员检测。 运算符 is 和 is not 用于比较两个对象是否是同一个对象。 所有比较运算符的优先级都一样，且低于任何数值运算符。

比较操作支持链式操作。例如，a < b == c 校验 a 是否小于 b，且 b 是否等于 c。

比较操作可以用布尔运算符 and 和 or 组合，并且，比较操作（或其他布尔运算）的结果都可以用 not 取反。这些操作符的优先级低于比较操作符；not 的优先级最高， or 的优先级最低，因此，A and not B or C 等价于 (A and (not B)) or C。与其他运算符操作一样，此处也可以用圆括号表示想要的组合。

布尔运算符 and 和 or 是所谓的 短路 运算符：其参数从左至右求值，一旦可以确定结果，求值就会停止。例如，如果 A 和 C 为真，B 为假，那么 A and B and C 不会对 C 求值。用作普通值而不是布尔值时，短路运算符的返回值通常是最后一个求了值的参数。

还可以把比较运算或其它布尔表达式的结果赋值给变量，例如：

>>> string1, string2, string3 = '', 'Trondheim', 'Hammer Dance'
>>> non_null = string1 or string2 or string3
>>> non_null
'Trondheim'

注意，Python 与 C 不同，在表达式内部赋值必须显式使用 海象运算符 :=。 这避免了 C 程序中常见的问题：要在表达式中写 == 时，却写成了 =。

5.8. 序列和其他类型的比较

序列对象可以与相同序列类型的其他对象比较。这种比较使用 字典式 顺序：首先，比较前两个对应元素，如果不相等，则可确定比较结果；如果相等，则比较之后的两个元素，以此类推，直到其中一个序列结束。如果要比较的两个元素本身是相同类型的序列，则递归地执行字典式顺序比较。如果两个序列中所有的对应元素都相等，则两个序列相等。如果一个序列是另一个的初始子序列，则较短的序列可被视为较小（较少）的序列。 对于字符串来说，字典式顺序使用 Unicode 码位序号排序单个字符。下面列出了一些比较相同类型序列的例子：

(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)

注意，当比较不同类型的对象时，只要待比较的对象提供了合适的比较方法，就可以使用 < 和 > 进行比较。例如，混合的数字类型通过数字值进行比较，所以，0 等于 0.0，等等。如果没有提供合适的比较方法，解释器不会随便给出一个比较结果，而是引发 TypeError 异常。

备注

1

别的语言可能会将可变对象返回，允许方法连续执行，例如 d->insert("a")->remove("b")->sort();。

6. 模块

退出 Python 解释器后，再次进入时，之前在 Python 解释器中定义的函数和变量就丢失了。因此，编写较长程序时，最好用文本编辑器代替解释器，执行文件中的输入内容，这就是编写 脚本 。随着程序越来越长，为了方便维护，最好把脚本拆分成多个文件。编写脚本还一个好处，不同程序调用同一个函数时，不用把函数定义复制到各个程序。

为实现这些需求，Python 把各种定义存入一个文件，在脚本或解释器的交互式实例中使用。这个文件就是 模块 ；模块中的定义可以 导入 到其他模块或 主 模块（在顶层和计算器模式下，执行脚本中可访问的变量集）。

模块是包含 Python 定义和语句的文件。其文件名是模块名加后缀名 .py 。在模块内部，通过全局变量 __name__ 可以获取模块名（即字符串）。例如，用文本编辑器在当前目录下创建 fibo.py 文件，输入以下内容：

# Fibonacci numbers module

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

现在，进入 Python 解释器，用以下命令导入该模块：

>>> import fibo

此操作不会直接把 fibo 中定义的函数名称添加到当前 namespace 中（请参阅 Python 作用域和命名空间 了解详情）；它只是将模块名称 fibo 添加到那里。 使用该模块名称你可以访问其中的函数:

>>> 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'

如果经常使用某个函数，可以把它赋值给局部变量：

>>> fib = fibo.fib
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

6.1. 模块详解

模块包含可执行语句及函数定义。这些语句用于初始化模块，且仅在 import 语句 第一次 遇到模块名时执行。1 (文件作为脚本运行时，也会执行这些语句。)

每个模块都有自己的私有命名空间，它会被用作模块中定义的所有函数的全局命名空间。 因此，模块作者可以在模块内使用全局变量而不必担心与用户的全局变量发生意外冲突。 另一方面，如果你知道要怎么做就可以通过与引用模块函数一样的标记法 modname.itemname 来访问一个模块的全局变量。

模块可以导入其他模块。 根据惯例可以将所有 import 语句都放在模块（或者也可以说是脚本）的开头但这并非强制要求。 如果被放置于一个模块的最高层级，则被导入的模块名称会被添加到该模块的全局命名空间。

还有一种 import 语句的变化形式可以将来自某个模块的名称直接导入到导入方模块的命名空间中。 例如:

>>> from fibo import fib, fib2
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

这条语句不会将所导入的模块的名称引入到局部命名空间中（因此在本示例中，fibo 将是未定义的名称）。

还有一种变体可以导入模块内定义的所有名称：

>>> from fibo import *
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

这种方式会导入所有不以下划线（_）开头的名称。大多数情况下，不要用这个功能，这种方式向解释器导入了一批未知的名称，可能会覆盖已经定义的名称。

注意，一般情况下，不建议从模块或包内导入 *，因为，这项操作经常让代码变得难以理解。不过，为了在交互式会话中少打几个字，这么用也没问题。

模块名后使用 as 时，直接把 as 后的名称与导入模块绑定。

>>> import fibo as fib
>>> fib.fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

与 import fibo 一样，这种方式也可以有效地导入模块，唯一的区别是，导入的名称是 fib。

from 中也可以使用这种方式，效果类似：

>>> from fibo import fib as fibonacci
>>> fibonacci(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

注解

为了保证运行效率，每次解释器会话只导入一次模块。如果更改了模块内容，必须重启解释器；仅交互测试一个模块时，也可以使用 importlib.reload()，例如 import importlib; importlib.reload(modulename)。

6.1.1. 以脚本方式执行模块

可以用以下方式运行 Python 模块：

python fibo.py <arguments>

这项操作将执行模块里的代码，和导入模块一样，但会把 __name__ 赋值为 "__main__"。 也就是把下列代码添加到模块末尾：

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

这个文件既能被用作脚本，又能被用作一个可供导入的模块，因为解析命令行参数的那两行代码只有在模块作为“main”文件执行时才会运行：

$ python fibo.py 50
0 1 1 2 3 5 8 13 21 34

当这个模块被导入到其它模块时，那两行代码不运行：

>>> import fibo
>>>

这常用于为模块提供一个便捷的用户接口，或用于测试（把模块作为执行测试套件的脚本运行）。

6.1.2. 模块搜索路径

当一个名为 spam 的模块被导入时，解释器首先搜索具有该名称的内置模块。这些模块的名字被列在 sys.builtin_module_names 中。如果没有找到，它就在变量 sys.path 给出的目录列表中搜索一个名为 spam.py 的文件，sys.path 从这些位置初始化:

被命令行直接运行的脚本所在的目录（或未指定文件时的当前目录）。

PYTHONPATH （目录列表，与 shell 变量 PATH 的语法一样）。

依赖于安装的默认值（按照惯例包括一个 site-packages 目录，由 site 模块处理）。

注解

在支持符号链接的文件系统中，“被命令行直接运行的脚本所在的目录”是符号链接最终指向的目录。换句话说，符号链接所在的目录并 没有 被添加至模块搜索路径。

初始化后，Python 程序可以更改 sys.path。脚本所在的目录先于标准库所在的路径被搜索。这意味着，脚本所在的目录如果有和标准库同名的文件，那么加载的是该目录里的，而不是标准库的。这一般是一个错误，除非这样的替换是你有意为之。详见 标准模块。

6.1.3. “已编译的” Python 文件

为了快速加载模块，Python 把模块的编译版本缓存在 __pycache__ 目录中，文件名为 module.version.pyc，version 对编译文件格式进行编码，一般是 Python 的版本号。例如，CPython 的 3.3 发行版中，spam.py 的编译版本缓存为 __pycache__/spam.cpython-33.pyc。这种命名惯例让不同 Python 版本编译的模块可以共存。

Python 对比编译版与源码的修改日期，查看编译版是否已过期，是否要重新编译。此进程完全是自动的。此外，编译模块与平台无关，因此，可在不同架构的系统之间共享相同的库。

Python 在两种情况下不检查缓存。一，从命令行直接载入的模块，每次都会重新编译，且不储存编译结果；二，没有源模块，就不会检查缓存。为了让一个库能以隐藏源代码的形式分发（通过将所有源代码变为编译后的版本），编译后的模块必须放在源目录而非缓存目录中，并且源目录绝不能包含同名的未编译的源模块。

给专业人士的一些小建议：

在 Python 命令中使用 -O 或 -OO 开关，可以减小编译模块的大小。-O 去除断言语句，-OO 去除断言语句和 __doc__ 字符串。有些程序可能依赖于这些内容，因此，没有十足的把握，不要使用这两个选项。“优化过的”模块带有 opt- 标签，并且文件通常会一小些。将来的发行版或许会改进优化的效果。

从 .pyc 文件读取的程序不比从 .py 读取的执行速度快，.pyc 文件只是加载速度更快。

compileall 模块可以为一个目录下的所有模块创建 .pyc 文件。

本过程的细节及决策流程图，详见 PEP 3147 [https://www.python.org/dev/peps/pep-3147]。

6.2. 标准模块

Python 自带一个标准模块的库，它在 Python 库参考（此处以下称为"库参考" ）里另外描述。 一些模块是内嵌到解释器里面的， 它们给一些虽并非语言核心但却内嵌的操作提供接口，要么是为了效率，要么是给操作系统基础操作例如系统调入提供接口。 这些模块集是一个配置选项， 并且还依赖于底层的操作系统。 例如，winreg 模块只在 Windows 系统上提供。一个特别值得注意的模块 sys，它被内嵌到每一个 Python 解释器中。sys.ps1 和 sys.ps2 变量定义了一些字符，它们可以用作主提示符和辅助提示符:

>>> import sys
>>> sys.ps1
'>>> '
>>> sys.ps2
'... '
>>> sys.ps1 = 'C> '
C> print('Yuck!')
Yuck!
C>

只有解释器用于交互模式时，才定义这两个变量。

变量 sys.path 是字符串列表，用于确定解释器的模块搜索路径。该变量以环境变量 PYTHONPATH 提取的默认路径进行初始化，如未设置 PYTHONPATH，则使用内置的默认路径。可以用标准列表操作修改该变量：

>>> import sys
>>> sys.path.append('/ufs/guido/lib/python')

6.3. dir() 函数

内置函数 dir() 用于查找模块定义的名称。返回结果是经过排序的字符串列表：

>>> 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']

没有参数时，dir() 列出当前已定义的名称：

>>> a = [1, 2, 3, 4, 5]
>>> import fibo
>>> fib = fibo.fib
>>> dir()
['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']

注意它列出所有类型的名称：变量，模块，函数，……。

dir() 不会列出内置函数和变量的名称。这些内容的定义在标准模块 builtins 中：

>>> 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']

6.4. 包

包是一种用“点式模块名”构造 Python 模块命名空间的方法。例如，模块名 A.B 表示包 A 中名为 B 的子模块。正如模块可以区分不同模块之间的全局变量名称一样，点式模块名可以区分 NumPy 或 Pillow 等不同多模块包之间的模块名称。

假设要为统一处理声音文件与声音数据设计一个模块集（“包”）。声音文件的格式很多（通常以扩展名来识别，例如：.wav，.aiff，.au），因此，为了不同文件格式之间的转换，需要创建和维护一个不断增长的模块集合。为了实现对声音数据的不同处理（例如，混声、添加回声、均衡器功能、创造人工立体声效果），还要编写无穷无尽的模块流。下面这个分级文件树展示了这个包的架构：

sound/                          Top-level package
      __init__.py               Initialize the sound package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...

导入包时，Python 搜索 sys.path 里的目录，查找包的子目录。

必须要有 __init__.py 文件才能让 Python 将包含该文件的目录当作包来处理。 这可以防止具有通用名称的目录如 string 在无意中屏蔽后续出现在模块搜索路径中的有效模块。 在最简单的情况下，__init__.py 可以只是一个空文件，但它也可以执行包的初始化代码或设置 __all__ 变量，这将在后面详细描述。

还可以从包中导入单个模块，例如：

import sound.effects.echo

这段代码加载子模块 sound.effects.echo ，但引用时必须使用子模块的全名：

sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

另一种导入子模块的方法是 ：

from sound.effects import echo

这段代码还可以加载子模块 echo ，不加包前缀也可以使用。因此，可以按如下方式使用：

echo.echofilter(input, output, delay=0.7, atten=4)

Import 语句的另一种变体是直接导入所需的函数或变量：

from sound.effects.echo import echofilter

同样，这样也会加载子模块 echo，但可以直接使用函数 echofilter()：

echofilter(input, output, delay=0.7, atten=4)

注意，使用 from package import item 时，item 可以是包的子模块（或子包），也可以是包中定义的函数、类或变量等其他名称。import 语句首先测试包中是否定义了 item；如果未在包中定义，则假定 item 是模块，并尝试加载。如果找不到 item，则触发 ImportError 异常。

相反，使用 import item.subitem.subsubitem 句法时，除最后一项外，每个 item 都必须是包；最后一项可以是模块或包，但不能是上一项中定义的类、函数或变量。

6.4.1. 从包中导入 *

使用 from sound.effects import * 时会发生什么？你可能希望它会查找并导入包的所有子模块，但事实并非如此。因为这将花费很长的时间，并且可能会产生你不想要的副作用，如果这种副作用被你设计为只有在导入某个特定的子模块时才应该发生。

唯一的解决办法是提供包的显式索引。import 语句使用如下惯例：如果包的 __init__.py 代码定义了列表 __all__，运行 from package import * 时，它就是被导入的模块名列表。发布包的新版本时，包的作者应更新此列表。如果包的作者认为没有必要在包中执行导入 * 操作，也可以不提供此列表。例如，sound/effects/__init__.py 文件可以包含以下代码：

__all__ = ["echo", "surround", "reverse"]

这意味着 from sound.effects import * 将导入 sound.effects 包的以上三个子模块。

如果没有定义 __all__，from sound.effects import * 语句 不会 把包 sound.effects 中所有子模块都导入到当前命名空间；该语句只确保导入包 sound.effects （可能还会运行 __init__.py 中的初始化代码），然后，再导入包中定义的名称。这些名称包括 __init__.py 中定义的任何名称（以及显式加载的子模块），还包括之前 import 语句显式加载的包里的子模块。请看以下代码：

import sound.effects.echo
import sound.effects.surround
from sound.effects import *

本例中，执行 from...import 语句时，将把 echo 和 surround 模块导入至当前命名空间，因为，它们是在 sound.effects 包里定义的。（该导入操作在定义了 __all__ 时也有效。）

虽然，可以把模块设计为用 import * 时只导出遵循指定模式的名称，但仍不提倡在生产代码中使用这种做法。

记住，使用 from package import specific_submodule 没有任何问题！ 实际上，除了导入模块使用不同包的同名子模块之外，这种方式是推荐用法。

6.4.2. 相对导入

包中内有多个子包时（与示例中的 sound 包一样），可以使用绝对导入来引用兄弟包中的子模块。例如，要在模块 sound.filters.vocoder 中使用 sound.effects 包的 echo 模块时，可以用 from sound.effects import echo 导入。

还可以用 import 语句的 from module import name 形式执行相对导入。下面的导入语句使用前导句点表示相对导入中的当前包和父包。例如，相对于 surround 模块，可以使用：

from . import echo
from .. import formats
from ..filters import equalizer

注意，相对导入基于当前模块名。因为主模块名永远是 "__main__" ，所以如果计划将一个模块用作 Python 应用程序的主模块，那么该模块内的导入语句必须始终使用绝对导入。

6.4.3. 多目录中的包

包还支持一个特殊属性 __path__ 。在包的 __init__.py 中的代码被执行前，该属性被初始化为一个只含一项的列表，该项是一个字符串，是 __init__.py 所在目录的名称。可以修改此变量；这样做会改变在此包中搜索模块和子包的方式。

这个功能虽然不常用，但可用于扩展包中的模块集。

备注

1

实际上函数定义也是被执行的语句；模块级函数定义的执行会将函数名称添加到模块的全局命名空间。

7. 输入与输出

程序输出有几种显示方式；数据既可以输出供人阅读的形式，也可以写入文件备用。本章探讨一些可用的方式。

7.1. 更复杂的输出格式

至此，我们已学习了两种写入值的方法：表达式语句 和 print() 函数。第三种方法是使用文件对象的 write() 方法；标准输出文件称为 sys.stdout。详见标准库参考。

对输出格式的控制不只是打印空格分隔的值，还需要更多方式。格式化输出包括以下几种方法。

使用 格式化字符串字面值 ，要在字符串开头的引号/三引号前添加 f 或 F 。在这种字符串中，可以在 { 和 } 字符之间输入引用的变量，或字面值的 Python 表达式。

>>> year = 2016
>>> event = 'Referendum'
>>> f'Results of the {year} {event}'
'Results of the 2016 Referendum'

字符串的 str.format() 方法需要更多手动操作。该方法也用 { 和 } 标记替换变量的位置，虽然这种方法支持详细的格式化指令，但需要提供格式化信息。

>>> yes_votes = 42_572_654
>>> no_votes = 43_132_495
>>> percentage = yes_votes / (yes_votes + no_votes)
>>> '{:-9} YES votes  {:2.2%}'.format(yes_votes, percentage)
' 42572654 YES votes  49.67%'

最后，还可以用字符串切片和合并操作完成字符串处理操作，创建任何排版布局。字符串类型还支持将字符串按给定列宽进行填充，这些方法也很有用。

如果不需要花哨的输出，只想快速显示变量进行调试，可以用 repr() 或 str() 函数把值转化为字符串。

str() 函数返回供人阅读的值，repr() 则生成适于解释器读取的值（如果没有等效的语法，则强制执行 SyntaxError）。对于没有支持供人阅读展示结果的对象， str() 返回与 repr() 相同的值。一般情况下，数字、列表或字典等结构的值，使用这两个函数输出的表现形式是一样的。字符串有两种不同的表现形式。

示例如下：

>>> 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...
>>> # The repr() of a string adds string quotes and backslashes:
... hello = 'hello, world\n'
>>> hellos = repr(hello)
>>> print(hellos)
'hello, world\n'
>>> # The argument to repr() may be any Python object:
... repr((x, y, ('spam', 'eggs')))
"(32.5, 40000, ('spam', 'eggs'))"

string 模块包含 Template 类，提供了将值替换为字符串的另一种方法。该类使用 $x 占位符，并用字典的值进行替换，但对格式控制的支持比较有限。

7.1.1. 格式化字符串字面值

格式化字符串字面值 （简称为 f-字符串）在字符串前加前缀 f 或 F，通过 {expression} 表达式，把 Python 表达式的值添加到字符串内。

格式说明符是可选的，写在表达式后面，可以更好地控制格式化值的方式。下例将 pi 舍入到小数点后三位：

>>> import math
>>> print(f'The value of pi is approximately {math.pi:.3f}.')
The value of pi is approximately 3.142.

在 ':' 后传递整数，为该字段设置最小字符宽度，常用于列对齐：

>>> 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

还有一些修饰符可以在格式化前转换值。 '!a' 应用 ascii() ，'!s' 应用 str()，'!r' 应用 repr()：

>>> 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'.

= 说明符可被用于将一个表达式扩展为表达式文本、等号再加表达式求值结果的形式。

>>> bugs = 'roaches'
>>> count = 13
>>> area = 'living room'
>>> print(f'Debugging {bugs=} {count=} {area=}')
Debugging bugs='roaches' count=13 area='living room'

请参阅 自说明型表达式 以了解 = 说明符的更多信息。 有关这些格式说明的详情，请查看针对 格式规格迷你语言 的参考指南。

7.1.2. 字符串 format() 方法

str.format() 方法的基本用法如下所示：

>>> print('We are the {} who say "{}!"'.format('knights', 'Ni'))
We are the knights who say "Ni!"

花括号及之内的字符（称为格式字段）被替换为传递给 str.format() 方法的对象。花括号中的数字表示传递给 str.format() 方法的对象所在的位置。

>>> print('{0} and {1}'.format('spam', 'eggs'))
spam and eggs
>>> print('{1} and {0}'.format('spam', 'eggs'))
eggs and spam

str.format() 方法中使用关键字参数名引用值。

>>> print('This {food} is {adjective}.'.format(
...       food='spam', adjective='absolutely horrible'))
This spam is absolutely horrible.

位置参数和关键字参数可以任意组合：

>>> print('The story of {0}, {1}, and {other}.'.format('Bill', 'Manfred',
...                                                    other='Georg'))
The story of Bill, Manfred, and Georg.

如果不想分拆较长的格式字符串，最好按名称引用变量进行格式化，不要按位置。这项操作可以通过传递字典，并用方括号 '[]' 访问键来完成。

>>> 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

这也可以通过将 table 字典作为采用 ** 标记的关键字参数传入来实现。

>>> 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

与内置函数 vars() 结合使用时，这种方式非常实用，可以返回包含所有局部变量的字典。

举个例子，以下几行代码将产生一组整齐的数据列，包含给定的整数及其平方与立方:

>>> 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

str.format() 进行字符串格式化的完整概述详见 格式字符串语法 。

7.1.3. 手动格式化字符串

下面是使用手动格式化方式实现的同一个平方和立方的表：

>>> for x in range(1, 11):
...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
...     # Note use of 'end' on previous line
...     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

（注意，每列之间的空格是通过使用 print() 添加的：它总在其参数间添加空格。）

字符串对象的 str.rjust() 方法通过在左侧填充空格，对给定宽度字段中的字符串进行右对齐。同类方法还有 str.ljust() 和 str.center() 。这些方法不写入任何内容，只返回一个新字符串，如果输入的字符串太长，它们不会截断字符串，而是原样返回；虽然这种方式会弄乱列布局，但也比另一种方法好，后者在显示值时可能不准确（如果真的想截断字符串，可以使用 x.ljust(n)[:n] 这样的切片操作 。）

另一种方法是 str.zfill() ，该方法在数字字符串左边填充零，且能识别正负号：

>>> '12'.zfill(5)
'00012'
>>> '-3.14'.zfill(7)
'-003.14'
>>> '3.14159265359'.zfill(5)
'3.14159265359'

7.1.4. 旧式字符串格式化方法

% 运算符（求余符）也可用于字符串格式化。给定 'string' % values，则 string 中的 % 实例会以零个或多个 values 元素替换。此操作被称为字符串插值。例如：

>>> import math
>>> print('The value of pi is approximately %5.3f.' % math.pi)
The value of pi is approximately 3.142.

printf 风格的字符串格式化 小节介绍更多相关内容。

7.2. 读写文件

open() 返回一个 file object ，最常使用的是两个位置参数和一个关键字参数：open(filename, mode, encoding=None)

>>> f = open('workfile', 'w', encoding="utf-8")

第一个实参是文件名字符串。第二个实参是包含描述文件使用方式字符的字符串。mode 的值包括 'r' ，表示文件只能读取；'w' 表示只能写入（现有同名文件会被覆盖）；'a' 表示打开文件并追加内容，任何写入的数据会自动添加到文件末尾。'r+' 表示打开文件进行读写。mode 实参是可选的，省略时的默认值为 'r'。

通常情况下，文件是以 text mode 打开的，也就是说，你从文件中读写字符串，这些字符串是以特定的 encoding 编码的。如果没有指定 encoding ，默认的是与平台有关的（见 open() ）。因为 UTF-8 是现代事实上的标准，除非你知道你需要使用一个不同的编码，否则建议使用 encoding="utf-8" 。在模式后面加上一个 'b' ，可以用 binary mode 打开文件。二进制模式的数据是以 bytes 对象的形式读写的。在二进制模式下打开文件时，你不能指定 encoding 。

在文本模式下读取文件时，默认把平台特定的行结束符（Unix 上为 \n, Windows 上为 \r\n）转换为 \n。在文本模式下写入数据时，默认把 \n 转换回平台特定结束符。这种操作方式在后台修改文件数据对文本文件来说没有问题，但会破坏 JPEG 或 EXE 等二进制文件中的数据。注意，在读写此类文件时，一定要使用二进制模式。

在处理文件对象时，最好使用 with 关键字。优点是，子句体结束后，文件会正确关闭，即便触发异常也可以。而且，使用 with 相比等效的 try-finally 代码块要简短得多：

>>> with open('workfile', encoding="utf-8") as f:
...     read_data = f.read()

>>> # We can check that the file has been automatically closed.
>>> f.closed
True

如果没有使用 with 关键字，则应调用 f.close() 关闭文件，即可释放文件占用的系统资源。

警告

调用 f.write() 时，未使用 with 关键字，或未调用 f.close()，即使程序正常退出，也**可能** 导致 f.write() 的参数没有完全写入磁盘。

通过 with 语句，或调用 f.close() 关闭文件对象后，再次使用该文件对象将会失败。

>>> f.close()
>>> f.read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: I/O operation on closed file.

7.2.1. 文件对象的方法

本节下文中的例子假定已创建 f 文件对象。

f.read(size) 可用于读取文件内容，它会读取一些数据，并返回字符串（文本模式），或字节串对象（在二进制模式下）。 size 是可选的数值参数。省略 size 或 size 为负数时，读取并返回整个文件的内容；文件大小是内存的两倍时，会出现问题。size 取其他值时，读取并返回最多 size 个字符（文本模式）或 size 个字节（二进制模式）。如已到达文件末尾，f.read() 返回空字符串（''）。

>>> f.read()
'This is the entire file.\n'
>>> f.read()
''

f.readline() 从文件中读取单行数据；字符串末尾保留换行符（\n），只有在文件不以换行符结尾时，文件的最后一行才会省略换行符。这种方式让返回值清晰明确；只要 f.readline() 返回空字符串，就表示已经到达了文件末尾，空行使用 '\n' 表示，该字符串只包含一个换行符。

>>> f.readline()
'This is the first line of the file.\n'
>>> f.readline()
'Second line of the file\n'
>>> f.readline()
''

从文件中读取多行时，可以用循环遍历整个文件对象。这种操作能高效利用内存，快速，且代码简单：

>>> for line in f:
...     print(line, end='')
...
This is the first line of the file.
Second line of the file

如需以列表形式读取文件中的所有行，可以用 list(f) 或 f.readlines()。

f.write(string) 把 string 的内容写入文件，并返回写入的字符数。

>>> f.write('This is a test\n')
15

写入其他类型的对象前，要先把它们转化为字符串（文本模式）或字节对象（二进制模式）：

>>> value = ('the answer', 42)
>>> s = str(value)  # convert the tuple to string
>>> f.write(s)
18

f.tell() 返回整数，给出文件对象在文件中的当前位置，表示为二进制模式下时从文件开始的字节数，以及文本模式下的意义不明的数字。

f.seek(offset, whence) 可以改变文件对象的位置。通过向参考点添加 offset 计算位置；参考点由 whence 参数指定。 whence 值为 0 时，表示从文件开头计算，1 表示使用当前文件位置，2 表示使用文件末尾作为参考点。省略 whence 时，其默认值为 0，即使用文件开头作为参考点。

>>> f = open('workfile', 'rb+')
>>> f.write(b'0123456789abcdef')
16
>>> f.seek(5)      # Go to the 6th byte in the file
5
>>> f.read(1)
b'5'
>>> f.seek(-3, 2)  # Go to the 3rd byte before the end
13
>>> f.read(1)
b'd'

在文本文件（模式字符串未使用 b 时打开的文件）中，只允许相对于文件开头搜索（使用 seek(0, 2) 搜索到文件末尾是个例外），唯一有效的 offset 值是能从 f.tell() 中返回的，或 0。其他 offset 值都会产生未定义的行为。

文件对象还支持 isatty() 和 truncate() 等方法，但不常用；文件对象的完整指南详见库参考。

7.2.2. 使用 json 保存结构化数据

从文件写入或读取字符串很简单，数字则稍显麻烦，因为 read() 方法只返回字符串，这些字符串必须传递给 int() 这样的函数，接受 '123' 这样的字符串，并返回数字值 123。保存嵌套列表、字典等复杂数据类型时，手动解析和序列化的操作非常复杂。

Python 允许你使用流行的数据交换格式 JSON (JavaScript Object Notation) [https://json.org]，而不是让用户持续编写和调试代码来将复杂的数据类型存入文件中。 标准库模块 json 可以接受带有层级结构的 Python 数据，并将其转换为字符串表示形式；这个过程称为 serializing。 根据字符串表示形式重建数据则称为 deserializing。 在序列化和反序列化之间，用于代表对象的字符串可以存储在文件或数据库中，或者通过网络连接发送到远端主机。

注解

JSON 格式通常用于现代应用程序的数据交换。程序员早已对它耳熟能详，可谓是交互操作的不二之选。

只需一行简单的代码即可查看某个对象的 JSON 字符串表现形式：

>>> import json
>>> x = [1, 'simple', 'list']
>>> json.dumps(x)
'[1, "simple", "list"]'

dumps() 函数还有一个变体， dump() ，它只将对象序列化为 text file 。因此，如果 f 是 text file 对象，可以这样做：

json.dump(x, f)

要再次解码对象，如果 f 是已打开、供读取的 binary file 或 text file 对象：

x = json.load(f)

注解

JSON文件必须以UTF-8编码。当打开JSON文件作为一个 text file 用于读写时，使用 encoding="utf-8" 。

这种简单的序列化技术可以处理列表和字典，但在 JSON 中序列化任意类的实例，则需要付出额外努力。json 模块的参考包含对此的解释。

参见

pickle - 封存模块

与 JSON 不同，pickle 是一种允许对复杂 Python 对象进行序列化的协议。因此，它为 Python 所特有，不能用于与其他语言编写的应用程序通信。默认情况下它也是不安全的：如果解序化的数据是由手段高明的攻击者精心设计的，这种不受信任来源的 pickle 数据可以执行任意代码。

8. 错误和异常

至此，本教程还未深入介绍错误信息，但如果您尝试过本教程前文中的例子，应该已经看到过一些错误信息。错误可（至少）被分为两种：语法错误 和 异常。

8.1. 语法错误

语法错误又称解析错误，是学习 Python 时最常见的错误：

>>> while True print('Hello world')
  File "<stdin>", line 1
    while True print('Hello world')
                   ^
SyntaxError: invalid syntax

解析器会复现出现句法错误的代码行，并用小“箭头”指向行里检测到的第一个错误。错误是由箭头 上方 的 token 触发的（至少是在这里检测出的）：本例中，在 print() 函数中检测到错误，因为，在它前面缺少冒号（':'） 。错误信息还输出文件名与行号，在使用脚本文件时，就可以知道去哪里查错。

8.2. 异常

即使语句或表达式使用了正确的语法，执行时仍可能触发错误。执行时检测到的错误称为 异常，异常不一定导致严重的后果：很快我们就能学会如何处理 Python 的异常。大多数异常不会被程序处理，而是显示下列错误信息：

>>> 10 * (1/0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ZeroDivisionError: division by zero
>>> 4 + spam*3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'spam' is not defined
>>> '2' + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: can only concatenate str (not "int") to str

错误信息的最后一行说明程序遇到了什么类型的错误。异常有不同的类型，而类型名称会作为错误信息的一部分中打印出来：上述示例中的异常类型依次是：ZeroDivisionError， NameError 和 TypeError。作为异常类型打印的字符串是发生的内置异常的名称。对于所有内置异常都是如此，但对于用户定义的异常则不一定如此（虽然这种规范很有用）。标准的异常类型是内置的标识符（不是保留关键字）。

此行其余部分根据异常类型，结合出错原因，说明错误细节。

错误信息开头用堆栈回溯形式展示发生异常的语境。一般会列出源代码行的堆栈回溯；但不会显示从标准输入读取的行。

内置异常 列出了内置异常及其含义。

8.3. 异常的处理

可以编写程序处理选定的异常。下例会要求用户一直输入内容，直到输入有效的整数，但允许用户中断程序（使用 Control-C 或操作系统支持的其他操作）；注意，用户中断程序会触发 KeyboardInterrupt 异常。

>>> while True:
...     try:
...         x = int(input("Please enter a number: "))
...         break
...     except ValueError:
...         print("Oops!  That was no valid number.  Try again...")
...

try 语句的工作原理如下：

首先，执行 try 子句 （try 和 except 关键字之间的（多行）语句）。

如果没有触发异常，则跳过 except 子句，try 语句执行完毕。

如果在执行 try 子句时发生了异常，则跳过该子句中剩下的部分。 如果异常的类型与 except 关键字后指定的异常相匹配，则会执行 except 子句，然后跳到 try/except 代码块之后继续执行。

如果发生的异常与 except 子句 中指定的异常不匹配，则它会被传递到外部的 try 语句中；如果没有找到处理程序，则它是一个 未处理异常 且执行将终止并输出如上所示的消息。

try 语句可以有多个 except 子句 来为不同的异常指定处理程序。 但最多只有一个处理程序会被执行。 处理程序只处理对应的 try 子句 中发生的异常，而不处理同一 try 语句内其他处理程序中的异常。 except 子句 可以用带圆括号的元组来指定多个异常，例如:

... except (RuntimeError, TypeError, NameError):
...     pass

如果发生的异常与 except 子句中的类是同一个类或是它的基类时，则该类与该异常相兼容（反之则不成立 --- 列出派生类的 except 子句 与基类不兼容）。 例如，下面的代码将依次打印 B, C, D:

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")

请注意如果颠倒 except 子句 的顺序（把 except B 放在最前），则会输出 B, B, B --- 即触发了第一个匹配的 except 子句。

所有异常都继承自 BaseException，因此它可被用作通配符。 但这种用法要非常谨慎小心，因为它很容易掩盖真正的编程错误！ 它还可被用于打印错误消息然后重新引发异常（允许调用者再来处理该异常）:

import sys

try:
    f = open('myfile.txt')
    s = f.readline()
    i = int(s.strip())
except OSError as err:
    print("OS error: {0}".format(err))
except ValueError:
    print("Could not convert data to an integer.")
except BaseException as err:
    print(f"Unexpected {err=}, {type(err)=}")
    raise

可以选择让最后一个 except 子句省略异常名称，但在此之后异常值必须从 sys.exc_info()[1] 获取。

try ... except 语句具有可选的 else 子句，该子句如果存在，它必须放在所有 except 子句 之后。 它适用于 try 子句 没有引发异常但又必须要执行的代码。 例如:

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()

使用 else 子句比向 try 子句添加额外的代码要好，可以避免意外捕获非 try ... except 语句保护的代码触发的异常。

发生异常时，它可能具有关联值，即异常 参数 。是否需要参数，以及参数的类型取决于异常的类型。

except 子句 可以在异常名称后面指定一个变量。 这个变量会绑定到一个异常实例并将参数存储在 instance.args 中。 为了方便起见，该异常实例定义了 __str__() 以便能直接打印参数而无需引用 .args。 也可以在引发异常之前先实例化一个异常并根据需要向其添加任何属性。:

>>> try:
...     raise Exception('spam', 'eggs')
... except Exception as inst:
...     print(type(inst))    # the exception instance
...     print(inst.args)     # arguments stored in .args
...     print(inst)          # __str__ allows args to be printed directly,
...                          # but may be overridden in exception subclasses
...     x, y = inst.args     # unpack args
...     print('x =', x)
...     print('y =', y)
...
<class 'Exception'>
('spam', 'eggs')
('spam', 'eggs')
x = spam
y = eggs

如果异常有参数，则它们将作为未处理异常的消息的最后一部分（'详细信息'）打印。

异常处理程序不仅会处理在 try 子句 中发生的异常，还会处理在 try 子句 中调用（包括间接调用）的函数。 例如:

>>> 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

8.4. 触发异常

raise 语句支持强制触发指定的异常。例如：

>>> raise NameError('HiThere')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: HiThere

raise 唯一的参数就是要触发的异常。这个参数必须是异常实例或异常类（派生自 Exception 类）。如果传递的是异常类，将通过调用没有参数的构造函数来隐式实例化：

raise ValueError  # shorthand for 'raise ValueError()'

如果只想判断是否触发了异常，但并不打算处理该异常，则可以使用更简单的 raise 语句重新触发异常：

>>> 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>
NameError: HiThere

8.5. 异常链

如果一个未处理的异常发生在 except 部分内，它将会有被处理的异常附加到它上面，并包括在错误信息中:

>>> try:
...     open("database.sqlite")
... except OSError:
...     raise RuntimeError("unable to handle error")
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
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>
RuntimeError: unable to handle error

为了表明一个异常是另一个异常的直接后果， raise 语句允许一个可选的 from 子句:

# exc must be exception instance or None.
raise RuntimeError from exc

转换异常时，这种方式很有用。例如：

>>> 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>
  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>
RuntimeError: Failed to open database

它还允许使用 from None 表达禁用自动异常链:

>>> try:
...     open('database.sqlite')
... except OSError:
...     raise RuntimeError from None
...
Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
RuntimeError

异常链机制详见 内置异常。

8.6. 用户自定义异常

程序可以通过创建新的异常类命名自己的异常（Python 类的内容详见 类）。不论是以直接还是间接的方式，异常都应从 Exception 类派生。

异常类可以被定义成能做其他类所能做的任何事，但通常应当保持简单，它往往只提供一些属性，允许相应的异常处理程序提取有关错误的信息。

大多数异常命名都以 “Error” 结尾，类似标准异常的命名。

许多标准模块都需要自定义异常，以报告由其定义的函数中出现的错误。有关类的说明，详见 类。

8.7. 定义清理操作

try 语句还有一个可选子句，用于定义在所有情况下都必须要执行的清理操作。例如：

>>> try:
...     raise KeyboardInterrupt
... finally:
...     print('Goodbye, world!')
...
Goodbye, world!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
KeyboardInterrupt

如果存在 finally 子句，则 finally 子句是 try 语句结束前执行的最后一项任务。不论 try 语句是否触发异常，都会执行 finally 子句。以下内容介绍了几种比较复杂的触发异常情景：

如果执行 try 子句期间触发了某个异常，则某个 except 子句应处理该异常。如果该异常没有 except 子句处理，在 finally 子句执行后会被重新触发。

except 或 else 子句执行期间也会触发异常。 同样，该异常会在 finally 子句执行之后被重新触发。

如果 finally 子句中包含 break、continue 或 return 等语句，异常将不会被重新引发。

如果执行 try 语句时遇到 break,、continue 或 return 语句，则 finally 子句在执行 break、continue 或 return 语句之前执行。

如果 finally 子句中包含 return 语句，则返回值来自 finally 子句的某个 return 语句的返回值，而不是来自 try 子句的 return 语句的返回值。

例如：

>>> def bool_return():
...     try:
...         return True
...     finally:
...         return False
...
>>> bool_return()
False

这是一个比较复杂的例子：

>>> 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>
  File "<stdin>", line 3, in divide
TypeError: unsupported operand type(s) for /: 'str' and 'str'

如上所示，任何情况下都会执行 finally 子句。except 子句不处理两个字符串相除触发的 TypeError，因此会在 finally 子句执行后被重新触发。

在实际应用程序中，finally 子句对于释放外部资源（例如文件或者网络连接）非常有用，无论是否成功使用资源。

8.8. 预定义的清理操作

某些对象定义了不需要该对象时要执行的标准清理操作。无论使用该对象的操作是否成功，都会执行清理操作。比如，下例要打开一个文件，并输出文件内容：

for line in open("myfile.txt"):
    print(line, end="")

这个代码的问题在于，执行完代码后，文件在一段不确定的时间内处于打开状态。在简单脚本中这没有问题，但对于较大的应用程序来说可能会出问题。with 语句支持以及时、正确的清理的方式使用文件对象：

with open("myfile.txt") as f:
    for line in f:
        print(line, end="")

语句执行完毕后，即使在处理行时遇到问题，都会关闭文件 f。和文件一样，支持预定义清理操作的对象会在文档中指出这一点。

9. 类

类提供了把数据和功能绑定在一起的方法。创建新类时创建了新的对象 类型，从而能够创建该类型的新 实例。实例具有能维持自身状态的属性，还具有能修改自身状态的方法（由其所属的类来定义）。

和其他编程语言相比，Python 的类只使用了很少的新语法和语义。Python 的类有点类似于 C++ 和 Modula-3 中类的结合体，而且支持面向对象编程（OOP）的所有标准特性：类的继承机制支持多个基类、派生的类能覆盖基类的方法、类的方法能调用基类中的同名方法。对象可包含任意数量和类型的数据。和模块一样，类也支持 Python 动态特性：在运行时创建，创建后还可以修改。

如果用 C++ 术语来描述的话，类成员（包括数据成员）通常为 public （例外的情况见下文 私有变量），所有成员函数都为 virtual 。与 Modula-3 中一样，没有用于从对象的方法中引用本对象成员的简写形式：方法函数在声明时，有一个显式的第一个参数代表本对象，该参数由方法调用隐式提供。与在 Smalltalk 中一样，Python 的类也是对象，这为导入和重命名提供了语义支持。与 C++ 和 Modula-3 不同，Python 的内置类型可以用作基类，供用户扩展。此外，与 C++ 一样，具有特殊语法的内置运算符（算术运算符、下标等）都可以为类实例重新定义。

由于缺乏关于类的公认术语，本章中偶尔会使用 Smalltalk 和 C++ 的术语。本章还会使用 Modula-3 的术语，Modula-3 的面向对象语义比 C++ 更接近 Python，但估计听说过这门语言的读者很少。

9.1. 名称和对象

对象之间相互独立，多个名称（甚至是多个作用域内的多个名称）可以绑定到同一对象。这在其他语言中通常被称为别名。Python 初学者通常不容易理解这个概念，处理数字、字符串、元组等不可变基本类型时，可以不必理会。但是，对于涉及可变对象（如列表、字典，以及大多数其他类型）的 Python 代码的语义，别名可能会产生意料之外的效果。这样做，通常是为了让程序受益，因为别名在某些方面就像指针。例如，传递对象的代价很小，因为实现只传递一个指针；如果函数修改了作为参数传递的对象，调用者就可以看到更改——无需像 Pascal 那样用两个不同的机制来传参。

9.2. Python 作用域和命名空间

在介绍类前，首先要介绍 Python 的作用域规则。类定义对命名空间有一些巧妙的技巧，了解作用域和命名空间的工作机制有利于加强对类的理解。并且，即便对于高级 Python 程序员，这方面的知识也很有用。

接下来，我们先了解一些定义。

namespace （命名空间）是从名称到对象的映射。现在，大多数命名空间都使用 Python 字典实现，但除非涉及到性能优化，我们一般不会关注这方面的事情，而且将来也可能会改变这种方式。命名空间的例子有：内置名称集合（包括 abs() 函数以及内置异常的名称等）；一个模块的全局名称；一个函数调用中的局部名称。对象的属性集合也是命名空间的一种形式。关于命名空间的一个重要知识点是，不同命名空间中的名称之间绝对没有关系；例如，两个不同的模块都可以定义 maximize 函数，且不会造成混淆。用户使用函数时必须要在函数名前面加上模块名。

点号之后的名称是 属性。例如，表达式 z.real 中，real 是对象 z 的属性。严格来说，对模块中名称的引用是属性引用：表达式 modname.funcname 中，modname 是模块对象，funcname 是模块的属性。模块属性和模块中定义的全局名称之间存在直接的映射：它们共享相同的命名空间！ 1

属性可以是只读或者可写的。如果可写，则可对属性赋值。模块属性是可写时，可以使用 modname.the_answer = 42 。del 语句可以删除可写属性。例如， del modname.the_answer 会删除 modname 对象中的 the_answer 属性。

命名空间是在不同时刻创建的，且拥有不同的生命周期。内置名称的命名空间是在 Python 解释器启动时创建的，永远不会被删除。模块的全局命名空间在读取模块定义时创建；通常，模块的命名空间也会持续到解释器退出。从脚本文件读取或交互式读取的，由解释器顶层调用执行的语句是 __main__ 模块调用的一部分，也拥有自己的全局命名空间。内置名称实际上也在模块里，即 builtins 。

函数的局部命名空间在函数被调用时被创建，并在函数返回或抛出未在函数内被处理的异常时，被删除。（实际上，用“遗忘”来描述实际发生的情况会更好一些。）当然，每次递归调用都有自己的局部命名空间。

一个命名空间的 作用域 是 Python 代码中的一段文本区域，从这个区域可直接访问该命名空间。“可直接访问”的意思是，该文本区域内的名称在被非限定引用时，查找名称的范围，是包括该命名空间在内的。

作用域虽然是被静态确定的，但会被动态使用。执行期间的任何时刻，都会有 3 或 4 个“命名空间可直接访问”的嵌套作用域：

最内层作用域，包含局部名称，并首先在其中进行搜索

那些外层闭包函数的作用域，包含“非局部、非全局”的名称，从最靠内层的那个作用域开始，逐层向外搜索。

倒数第二层作用域，包含当前模块的全局名称

最外层（最后搜索）的作用域，是内置名称的命名空间

如果一个名称被声明为全局，则所有引用和赋值都将直接指向“倒数第二层作用域”，即包含模块的全局名称的作用域。 要重新绑定在最内层作用域以外找到的变量，可以使用 nonlocal 语句；如果未使用 nonlocal 声明，这些变量将为只读（尝试写入这样的变量将在最内层作用域中创建一个 新的 局部变量，而使得同名的外部变量保持不变）。

通常，当前局部作用域将（按字面文本）引用当前函数的局部名称。在函数之外，局部作用域引用与全局作用域一致的命名空间：模块的命名空间。 类定义在局部命名空间内再放置另一个命名空间。

划重点，作用域是按字面文本确定的：模块内定义的函数的全局作用域就是该模块的命名空间，无论该函数从什么地方或以什么别名被调用。另一方面，实际的名称搜索是在运行时动态完成的。但是，Python 正在朝着“编译时静态名称解析”的方向发展，因此不要过于依赖动态名称解析！（局部变量已经是被静态确定了。）

Python 有一个特殊规定。如果不存在生效的 global 或 nonlocal 语句，则对名称的赋值总是会进入最内层作用域。赋值不会复制数据，只是将名称绑定到对象。删除也是如此：语句 del x 从局部作用域引用的命名空间中移除对 x 的绑定。所有引入新名称的操作都是使用局部作用域：尤其是 import 语句和函数定义会在局部作用域中绑定模块或函数名称。

global 语句用于表明特定变量在全局作用域里，并应在全局作用域中重新绑定；nonlocal 语句表明特定变量在外层作用域中，并应在外层作用域中重新绑定。

9.2.1. 作用域和命名空间示例

下例演示了如何引用不同作用域和名称空间，以及 global 和 nonlocal 对变量绑定的影响：

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)

示例代码的输出是：

After local assignment: test spam
After nonlocal assignment: nonlocal spam
After global assignment: nonlocal spam
In global scope: global spam

注意，局部 赋值（这是默认状态）不会改变 scope_test 对 spam 的绑定。 nonlocal 赋值会改变 scope_test 对 spam 的绑定，而 global 赋值会改变模块层级的绑定。

而且，global 赋值前没有 spam 的绑定。

9.3. 初探类

类引入了一点新语法，三种新的对象类型和一些新语义。

9.3.1. 类定义语法

最简单的类定义形式如下：

class ClassName:
    <statement-1>
    .
    .
    .
    <statement-N>

与函数定义 (def 语句) 一样，类定义必须先执行才能生效。把类定义放在 if 语句的分支里或函数内部试试。

在实践中，类定义内的语句通常都是函数定义，但也可以是其他语句。这部分内容稍后再讨论。类里的函数定义一般是特殊的参数列表，这是由方法调用的约定规范所指明的 --- 同样，稍后再解释。

当进入类定义时，将创建一个新的命名空间，并将其用作局部作用域 --- 因此，所有对局部变量的赋值都是在这个新命名空间之内。 特别的，函数定义会绑定到这里的新函数名称。

当（从结尾处）正常离开类定义时，将创建一个 类对象。 这基本上是一个包围在类定义所创建命名空间内容周围的包装器；我们将在下一节了解有关类对象的更多信息。 原始的（在进入类定义之前起作用的）局部作用域将重新生效，类对象将在这里被绑定到类定义头所给出的类名称 (在这个示例中为 ClassName)。

9.3.2. Class 对象

类对象支持两种操作：属性引用和实例化。

属性引用 使用 Python 中所有属性引用所使用的标准语法: obj.name。 有效的属性名称是类对象被创建时存在于类命名空间中的所有名称。 因此，如果类定义是这样的:

class MyClass:
    """A simple example class"""
    i = 12345

    def f(self):
        return 'hello world'

那么 MyClass.i 和 MyClass.f 就是有效的属性引用，将分别返回一个整数和一个函数对象。 类属性也可以被赋值，因此可以通过赋值来更改 MyClass.i 的值。 __doc__ 也是一个有效的属性，将返回所属类的文档字符串: "A simple example class"。

类的 实例化 使用函数表示法。 可以把类对象视为是返回该类的一个新实例的不带参数的函数。 举例来说（假设使用上述的类）:

x = MyClass()

创建类的新 实例 并将此对象分配给局部变量 x。

实例化操作（“调用”类对象）会创建一个空对象。 许多类喜欢创建带有特定初始状态的自定义实例。 为此类定义可能包含一个名为 __init__() 的特殊方法，就像这样:

def __init__(self):
    self.data = []

当一个类定义了 __init__() 方法时，类的实例化操作会自动为新创建的类实例发起调用 __init__()。 因此在这个例子中，可以通过以下语句获得一个新的已初始化实例:

x = MyClass()

当然，__init__() 方法还可以有额外参数以实现更高灵活性。 在这种情况下，提供给类实例化运算符的参数将被传递给 __init__()。 例如，:

>>> 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)

9.3.3. 实例对象

现在我们能用实例对象做什么？ 实例对象所能理解的唯一操作是属性引用。 有两种有效的属性名称：数据属性和方法。

Data attributes correspond to "instance variables" in Smalltalk, and to "data members" in C++. Data attributes need not be declared; like local variables, they spring into existence when they are first assigned to. For example, if x is the instance of MyClass created above, the following piece of code will print the value 16, without leaving a trace:

x.counter = 1
while x.counter < 10:
    x.counter = x.counter * 2
print(x.counter)
del x.counter

另一类实例属性引用称为 方法。 方法是“从属于”对象的函数。 （在 Python 中，方法这个术语并不是类实例所特有的：其他对象也可以有方法。 例如，列表对象具有 append, insert, remove, sort 等方法。 然而，在以下讨论中，我们使用方法一词将专指类实例对象的方法，除非另外显式地说明。）

实例对象的有效方法名称依赖于其所属的类。 根据定义，一个类中所有是函数对象的属性都是定义了其实例的相应方法。 因此在我们的示例中，x.f 是有效的方法引用，因为 MyClass.f 是一个函数，而 x.i 不是方法，因为 MyClass.i 不是函数。 但是 x.f 与 MyClass.f 并不是一回事 --- 它是一个 方法对象，不是函数对象。

9.3.4. 方法对象

通常，方法在绑定后立即被调用:

x.f()

在 MyClass 示例中，这将返回字符串 'hello world'。 但是，立即调用一个方法并不是必须的: x.f 是一个方法对象，它可以被保存起来以后再调用。 例如:

xf = x.f
while True:
    print(xf())

将持续打印 hello world，直到结束。

当一个方法被调用时到底发生了什么？ 你可能已经注意到上面调用 x.f() 时并没有带参数，虽然 f() 的函数定义指定了一个参数。 这个参数发生了什么事？ 当不带参数地调用一个需要参数的函数时 Python 肯定会引发异常 --- 即使参数实际未被使用...

实际上，你可能已经猜到了答案：方法的特殊之处就在于实例对象会作为函数的第一个参数被传入。 在我们的示例中，调用 x.f() 其实就相当于 MyClass.f(x)。 总之，调用一个具有 n 个参数的方法就相当于调用再多一个参数的对应函数，这个参数值为方法所属实例对象，位置在其他参数之前。

如果你仍然无法理解方法的运作原理，那么看了实现细节可能会弄清楚问题。当对实例对象进行属性引用时，如果该属性在实例中无法找到，将搜索实例所属的类。如果被引用的属性名称表示一个有效的类属性中的函数对象，会打包两者（实例对象和查找到的函数对象）的指针到一个抽象对象，这个抽象对象就是方法对象。当用参数列表调用方法对象时，将基于实例对象和参数列表构建一个新的参数列表，并用这个新参数列表调用相应的函数对象。

9.3.5. 类和实例变量

一般来说，实例变量用于每个实例的唯一数据，而类变量用于类的所有实例共享的属性和方法:

class Dog:

    kind = 'canine'         # class variable shared by all instances

    def __init__(self, name):
        self.name = name    # instance variable unique to each instance

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.kind                  # shared by all dogs
'canine'
>>> e.kind                  # shared by all dogs
'canine'
>>> d.name                  # unique to d
'Fido'
>>> e.name                  # unique to e
'Buddy'

正如 名称和对象 中已讨论过的，共享数据可能在涉及 mutable 对象例如列表和字典的时候导致令人惊讶的结果。 例如以下代码中的 tricks 列表不应该被用作类变量，因为所有的 Dog 实例将只共享一个单独的列表:

class Dog:

    tricks = []             # mistaken use of a class variable

    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                # unexpectedly shared by all dogs
['roll over', 'play dead']

正确的类设计应该使用实例变量:

class Dog:

    def __init__(self, name):
        self.name = name
        self.tricks = []    # creates a new empty list for each 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']

9.4. 补充说明

如果同样的属性名称同时出现在实例和类中，则属性查找会优先选择实例:

>>> 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

数据属性可以被方法以及一个对象的普通用户（“客户端”）所引用。 换句话说，类不能用于实现纯抽象数据类型。 实际上，在 Python 中没有任何东西能强制隐藏数据 --- 它是完全基于约定的。 （而在另一方面，用 C 语言编写的 Python 实现则可以完全隐藏实现细节，并在必要时控制对象的访问；此特性可以通过用 C 编写 Python 扩展来使用。）

客户端应当谨慎地使用数据属性 --- 客户端可能通过直接操作数据属性的方式破坏由方法所维护的固定变量。 请注意客户端可以向一个实例对象添加他们自己的数据属性而不会影响方法的可用性，只要保证避免名称冲突 --- 再次提醒，在此使用命名约定可以省去许多令人头痛的麻烦。

在方法内部引用数据属性（或其他方法！）并没有简便方式。 我发现这实际上提升了方法的可读性：当浏览一个方法代码时，不会存在混淆局部变量和实例变量的机会。

方法的第一个参数常常被命名为 self。 这也不过就是一个约定: self 这一名称在 Python 中绝对没有特殊含义。 但是要注意，不遵循此约定会使得你的代码对其他 Python 程序员来说缺乏可读性，而且也可以想像一个 类浏览器 程序的编写可能会依赖于这样的约定。

任何一个作为类属性的函数都为该类的实例定义了一个相应方法。 函数定义的文本并非必须包含于类定义之内：将一个函数对象赋值给一个局部变量也是可以的。 例如:

# Function defined outside the class
def f1(self, x, y):
    return min(x, x+y)

class C:
    f = f1

    def g(self):
        return 'hello world'

    h = g

现在 f, g 和 h 都是 C 类的引用函数对象的属性，因而它们就都是 C 的实例的方法 --- 其中 h 完全等同于 g。 但请注意，本示例的做法通常只会令程序的阅读者感到迷惑。

方法可以通过使用 self 参数的方法属性调用其他方法:

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)

方法可以通过与普通函数相同的方式引用全局名称。与方法相关联的全局作用域就是包含该方法的定义语句的模块。（类永远不会被用作全局作用域。）尽管一个人很少会有好的理由在方法中使用全局作用域中的数据，全局作用域依然存在许多合理的使用场景：举个例子，导入到全局作用域的函数和模块可以被方法所使用，定义在全局作用域中的函数和类也一样。通常，包含该方法的类本身就定义在全局作用域中，而在下一节中我们将会发现，为何有些时候方法需要引用其所属类。

每个值都是一个对象，因此具有 类 （也称为 类型），并存储为 object.__class__ 。

9.5. 继承

当然，如果不支持继承，语言特性就不值得称为“类”。派生类定义的语法如下所示:

class DerivedClassName(BaseClassName):
    <statement-1>
    .
    .
    .
    <statement-N>

名称 BaseClassName 必须定义于包含派生类定义的作用域中。 也允许用其他任意表达式代替基类名称所在的位置。 这有时也可能会用得上，例如，当基类定义在另一个模块中的时候:

class DerivedClassName(modname.BaseClassName):

派生类定义的执行过程与基类相同。 当构造类对象时，基类会被记住。 此信息将被用来解析属性引用：如果请求的属性在类中找不到，搜索将转往基类中进行查找。 如果基类本身也派生自其他某个类，则此规则将被递归地应用。

派生类的实例化没有任何特殊之处: DerivedClassName() 会创建该类的一个新实例。 方法引用将按以下方式解析：搜索相应的类属性，如有必要将按基类继承链逐步向下查找，如果产生了一个函数对象则方法引用就生效。

派生类可能会重写其基类的方法。 因为方法在调用同一对象的其他方法时没有特殊权限，所以基类方法在尝试调用调用同一基类中定义的另一方法时，可能实际上调用是该基类的派生类中定义的方法。（对 C++ 程序员的提示：Python 中所有的方法实际上都是 virtual 方法。）

在派生类中的重写方法实际上可能想要扩展而非简单地替换同名的基类方法。 有一种方式可以简单地直接调用基类方法：即调用 BaseClassName.methodname(self, arguments)。 有时这对客户端来说也是有用的。 （请注意仅当此基类可在全局作用域中以 BaseClassName 的名称被访问时方可使用此方式。）

Python有两个内置函数可被用于继承机制：

使用 isinstance() 来检查一个实例的类型: isinstance(obj, int) 仅会在 obj.__class__ 为 int 或某个派生自 int 的类时为 True。

使用 issubclass() 来检查类的继承关系: issubclass(bool, int) 为 True，因为 bool 是 int 的子类。 但是，issubclass(float, int) 为 False，因为 float 不是 int 的子类。

9.5.1. 多重继承

Python 也支持一种多重继承。 带有多个基类的类定义语句如下所示:

class DerivedClassName(Base1, Base2, Base3):
    <statement-1>
    .
    .
    .
    <statement-N>

对于多数应用来说，在最简单的情况下，你可以认为搜索从父类所继承属性的操作是深度优先、从左至右的，当层次结构中存在重叠时不会在同一个类中搜索两次。 因此，如果某一属性在 DerivedClassName 中未找到，则会到 Base1 中搜索它，然后（递归地）到 Base1 的基类中搜索，如果在那里未找到，再到 Base2 中搜索，依此类推。

真实情况比这个更复杂一些；方法解析顺序会动态改变以支持对 super() 的协同调用。 这种方式在某些其他多重继承型语言中被称为后续方法调用，它比单继承型语言中的 super 调用更强大。

动态改变顺序是有必要的，因为所有多重继承的情况都会显示出一个或更多的菱形关联（即至少有一个父类可通过多条路径被最底层类所访问）。 例如，所有类都是继承自 object，因此任何多重继承的情况都提供了一条以上的路径可以通向 object。 为了确保基类不会被访问一次以上，动态算法会用一种特殊方式将搜索顺序线性化， 保留每个类所指定的从左至右的顺序，只调用每个父类一次，并且保持单调（即一个类可以被子类化而不影响其父类的优先顺序）。 总而言之，这些特性使得设计具有多重继承的可靠且可扩展的类成为可能。 要了解更多细节，请参阅 https://www.python.org/download/releases/2.3/mro/。

9.6. 私有变量

那种仅限从一个对象内部访问的“私有”实例变量在 Python 中并不存在。 但是，大多数 Python 代码都遵循这样一个约定：带有一个下划线的名称 (例如 _spam) 应该被当作是 API 的非公有部分 (无论它是函数、方法或是数据成员)。 这应当被视为一个实现细节，可能不经通知即加以改变。

由于存在对于类私有成员的有效使用场景（例如避免名称与子类所定义的名称相冲突），因此存在对此种机制的有限支持，称为 名称改写。 任何形式为 __spam 的标识符（至少带有两个前缀下划线，至多一个后缀下划线）的文本将被替换为 _classname__spam，其中 classname 为去除了前缀下划线的当前类名称。 这种改写不考虑标识符的句法位置，只要它出现在类定义内部就会进行。

名称改写有助于让子类重写方法而不破坏类内方法调用。例如:

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   # private copy of original update() method

class MappingSubclass(Mapping):

    def update(self, keys, values):
        # provides new signature for update()
        # but does not break __init__()
        for item in zip(keys, values):
            self.items_list.append(item)

上面的示例即使在 MappingSubclass 引入了一个 __update 标识符的情况下也不会出错，因为它会在 Mapping 类中被替换为 _Mapping__update 而在 MappingSubclass 类中被替换为 _MappingSubclass__update。

请注意，改写规则的设计主要是为了避免意外冲突；访问或修改被视为私有的变量仍然是可能的。这在特殊情况下甚至会很有用，例如在调试器中。

请注意传递给 exec() 或 eval() 的代码不会将唤起类的类名视作当前类；这类似于 global 语句的效果，因此这种效果仅限于同时经过字节码编译的代码。 同样的限制也适用于 getattr(), setattr() 和 delattr()，以及对于 __dict__ 的直接引用。

9.7. 杂项说明

有时具有类似于 Pascal "record" 或 C "struct" 的数据类型是很有用的，将一些带名称的数据项捆绑在一起。 实现这一目标的理想方式是使用 dataclasses:

from dataclasses import dataclass

@dataclass
class Employee:
    name: str
    dept: str
    salary: int

>>> john = Employee('john', 'computer lab', 1000)
>>> john.dept
'computer lab'
>>> john.salary
1000

一段需要特定抽象数据类型的 Python 代码往往可以被传入一个模拟了该数据类型的方法的类作为替代。 例如，如果你有一个基于文件对象来格式化某些数据的函数，你可以定义一个带有 read() 和 readline() 方法从字符串缓存获取数据的类，并将其作为参数传入。

实例方法对象也具有属性: m.__self__ 就是带有 m() 方法的实例对象，而 m.__func__ 则是该方法所对应的函数对象。

9.8. 迭代器

到目前为止，您可能已经注意到大多数容器对象都可以使用 for 语句:

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='')

这种访问风格清晰、简洁又方便。 迭代器的使用非常普遍并使得 Python 成为一个统一的整体。 在幕后，for 语句会在容器对象上调用 iter()。 该函数返回一个定义了 __next__() 方法的迭代器对象，此方法将逐一访问容器中的元素。 当元素用尽时，__next__() 将引发 StopIteration 异常来通知终止 for 循环。 你可以使用 next() 内置函数来调用 __next__() 方法；这个例子显示了它的运作方式:

>>> 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

看过迭代器协议的幕后机制，给你的类添加迭代器行为就很容易了。 定义一个 __iter__() 方法来返回一个带有 __next__() 方法的对象。 如果类已定义了 __next__()，则 __iter__() 可以简单地返回 self:

class Reverse:
    """Iterator for looping over a sequence backwards."""
    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]

>>> rev = Reverse('spam')
>>> iter(rev)
<__main__.Reverse object at 0x00A1DB50>
>>> for char in rev:
...     print(char)
...
m
a
p
s

9.9. 生成器

生成器 是一个用于创建迭代器的简单而强大的工具。 它们的写法类似于标准的函数，但当它们要返回数据时会使用 yield 语句。 每次在生成器上调用 next() 时，它会从上次离开的位置恢复执行（它会记住上次执行语句时的所有数据值）。 一个显示如何非常容易地创建生成器的示例如下:

def reverse(data):
    for index in range(len(data)-1, -1, -1):
        yield data[index]

>>> for char in reverse('golf'):
...     print(char)
...
f
l
o
g

可以用生成器来完成的操作同样可以用前一节所描述的基于类的迭代器来完成。 但生成器的写法更为紧凑，因为它会自动创建 __iter__() 和 __next__() 方法。

另一个关键特性在于局部变量和执行状态会在每次调用之间自动保存。 这使得该函数相比使用 self.index 和 self.data 这种实例变量的方式更易编写且更为清晰。

除了会自动创建方法和保存程序状态，当生成器终结时，它们还会自动引发 StopIteration。 这些特性结合在一起，使得创建迭代器能与编写常规函数一样容易。

9.10. 生成器表达式

某些简单的生成器可以写成简洁的表达式代码，所用语法类似列表推导式，但外层为圆括号而非方括号。 这种表达式被设计用于生成器将立即被外层函数所使用的情况。 生成器表达式相比完整的生成器更紧凑但较不灵活，相比等效的列表推导式则更为节省内存。

示例:

>>> sum(i*i for i in range(10))                 # sum of squares
285

>>> xvec = [10, 20, 30]
>>> yvec = [7, 5, 3]
>>> sum(x*y for x,y in zip(xvec, yvec))         # dot product
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']

备注

1

存在一个例外。 模块对象有一个秘密的只读属性 __dict__，它返回用于实现模块命名空间的字典；__dict__ 是属性但不是全局名称。 显然，使用这个将违反命名空间实现的抽象，应当仅被用于事后调试器之类的场合。

10. 标准库简介

10.1. 操作系统接口

os 模块提供了许多与操作系统交互的函数:

>>> import os
>>> os.getcwd()      # Return the current working directory
'C:\\Python310'
>>> os.chdir('/server/accesslogs')   # Change current working directory
>>> os.system('mkdir today')   # Run the command mkdir in the system shell
0

一定要使用 import os 而不是 from os import * 。这将避免内建的 open() 函数被 os.open() 隐式替换掉，因为它们的使用方式大不相同。

内置的 dir() 和 help() 函数可用作交互式辅助工具，用于处理大型模块，如 os:

>>> import os
>>> dir(os)
<returns a list of all module functions>
>>> help(os)
<returns an extensive manual page created from the module's docstrings>

对于日常文件和目录管理任务， shutil 模块提供了更易于使用的更高级别的接口:

>>> import shutil
>>> shutil.copyfile('data.db', 'archive.db')
'archive.db'
>>> shutil.move('/build/executables', 'installdir')
'installdir'

10.2. 文件通配符

glob 模块提供了一个在目录中使用通配符搜索创建文件列表的函数:

>>> import glob
>>> glob.glob('*.py')
['primes.py', 'random.py', 'quote.py']

10.3. 命令行参数

通用实用程序脚本通常需要处理命令行参数。这些参数作为列表存储在 sys 模块的 argv 属性中。例如，以下输出来自在命令行运行 python demo.py one two three

>>> import sys
>>> print(sys.argv)
['demo.py', 'one', 'two', 'three']

argparse 模块提供了一种更复杂的机制来处理命令行参数。 以下脚本可提取一个或多个文件名，并可选择要显示的行数:

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)

当在通过 python top.py --lines=5 alpha.txt beta.txt 在命令行运行时，该脚本会将 args.lines 设为 5 并将 args.filenames 设为 ['alpha.txt', 'beta.txt']。

10.4. 错误输出重定向和程序终止

sys 模块还具有 stdin ， stdout 和 stderr 的属性。后者对于发出警告和错误消息非常有用，即使在 stdout 被重定向后也可以看到它们:

>>> sys.stderr.write('Warning, log file not found starting a new one\n')
Warning, log file not found starting a new one

终止脚本的最直接方法是使用 sys.exit() 。

10.5. 字符串模式匹配

re 模块为高级字符串处理提供正则表达式工具。对于复杂的匹配和操作，正则表达式提供简洁，优化的解决方案:

>>> 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'

当只需要简单的功能时，首选字符串方法因为它们更容易阅读和调试:

>>> 'tea for too'.replace('too', 'two')
'tea for two'

10.6. 数学

math 模块提供对浮点数学的底层C库函数的访问:

>>> import math
>>> math.cos(math.pi / 4)
0.70710678118654757
>>> math.log(1024, 2)
10.0

random 模块提供了进行随机选择的工具:

>>> import random
>>> random.choice(['apple', 'pear', 'banana'])
'apple'
>>> random.sample(range(100), 10)   # sampling without replacement
[30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
>>> random.random()    # random float
0.17970987693706186
>>> random.randrange(6)    # random integer chosen from range(6)
4

statistics 模块计算数值数据的基本统计属性（均值，中位数，方差等）:

>>> 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

SciPy项目 <https://scipy.org> 有许多其他模块用于数值计算。

10.7. 互联网访问

有许多模块可用于访问互联网和处理互联网协议。其中两个最简单的 urllib.request 用于从URL检索数据，以及 smtplib 用于发送邮件:

>>> from urllib.request import urlopen
>>> with urlopen('http://worldtimeapi.org/api/timezone/etc/UTC.txt') as response:
...     for line in response:
...         line = line.decode()             # Convert bytes to a str
...         if line.startswith('datetime'):
...             print(line.rstrip())         # Remove trailing newline
...
datetime: 2022-01-01T01:36:47.689215+00:00

>>> 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()

（请注意，第二个示例需要在localhost上运行的邮件服务器。）

10.8. 日期和时间

datetime 模块提供了以简单和复杂的方式操作日期和时间的类。虽然支持日期和时间算法，但实现的重点是有效的成员提取以进行输出格式化和操作。该模块还支持可感知时区的对象。

>>> # dates are easily constructed and formatted
>>> from datetime import date
>>> now = 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.'

>>> # dates support calendar arithmetic
>>> birthday = date(1964, 7, 31)
>>> age = now - birthday
>>> age.days
14368

10.9. 数据压缩

常见的数据存档和压缩格式由模块直接支持，包括：zlib, gzip, bz2, lzma, zipfile 和 tarfile。:

>>> 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

10.10. 性能测量

一些Python用户对了解同一问题的不同方法的相对性能产生了浓厚的兴趣。 Python提供了一种可以立即回答这些问题的测量工具。

例如，元组封包和拆包功能相比传统的交换参数可能更具吸引力。timeit 模块可以快速演示在运行效率方面一定的优势:

>>> 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

与 timeit 的精细粒度级别相反， profile 和 pstats 模块提供了用于在较大的代码块中识别时间关键部分的工具。

10.11. 质量控制

开发高质量软件的一种方法是在开发过程中为每个函数编写测试，并在开发过程中经常运行这些测试。

doctest 模块提供了一个工具，用于扫描模块并验证程序文档字符串中嵌入的测试。测试构造就像将典型调用及其结果剪切并粘贴到文档字符串一样简单。这通过向用户提供示例来改进文档，并且它允许doctest模块确保代码保持对文档的真实:

def average(values):
    """Computes the arithmetic mean of a list of numbers.

    >>> print(average([20, 30, 70]))
    40.0
    """
    return sum(values) / len(values)

import doctest
doctest.testmod()   # automatically validate the embedded tests

unittest 模块不像 doctest 模块那样易于使用，但它允许在一个单独的文件中维护更全面的测试集:

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()  # Calling from the command line invokes all tests

10.12. 自带电池

Python有“自带电池”的理念。通过其包的复杂和强大功能可以最好地看到这一点。例如:

xmlrpc.client 和 xmlrpc.server 模块使得实现远程过程调用变成了小菜一碟。 尽管存在于模块名称中，但用户不需要直接了解或处理 XML。

 email 包是一个用于管理电子邮件的库，包括MIME和其他符合 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 规范的邮件文档。与 smtplib 和 poplib 不同（它们实际上做的是发送和接收消息），电子邮件包提供完整的工具集，用于构建或解码复杂的消息结构（包括附件）以及实现互联网编码和标头协议。

 json 包为解析这种流行的数据交换格式提供了强大的支持。 csv 模块支持以逗号分隔值格式直接读取和写入文件，这种格式通常为数据库和电子表格所支持。 XML 处理由 xml.etree.ElementTree ， xml.dom 和 xml.sax 包支持。这些模块和软件包共同大大简化了 Python 应用程序和其他工具之间的数据交换。

 sqlite3 模块是 SQLite 数据库库的包装器，提供了一个可以使用稍微非标准的 SQL 语法更新和访问的持久数据库。

国际化由许多模块支持，包括 gettext ， locale ，以及 codecs 包。

11. 标准库简介 —— 第二部分

第二部分涵盖了专业编程所需要的更高级的模块。这些模块很少用在小脚本中。

11.1. 格式化输出

reprlib 模块提供了一个定制化版本的 repr() 函数，用于缩略显示大型或深层嵌套的容器对象:

>>> import reprlib
>>> reprlib.repr(set('supercalifragilisticexpialidocious'))
"{'a', 'c', 'd', 'e', 'f', 'g', ...}"

pprint 模块提供了更加复杂的打印控制，其输出的内置对象和用户自定义对象能够被解释器直接读取。当输出结果过长而需要折行时，“美化输出机制”会添加换行符和缩进，以更清楚地展示数据结构:

>>> import pprint
>>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta',
...     'yellow'], 'blue']]]
...
>>> pprint.pprint(t, width=30)
[[[['black', 'cyan'],
   'white',
   ['green', 'red']],
  [['magenta', 'yellow'],
   'blue']]]

textwrap 模块能够格式化文本段落，以适应给定的屏幕宽度:

>>> 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.

locale 模块处理与特定地域文化相关的数据格式。locale 模块的 format 函数包含一个 grouping 属性，可直接将数字格式化为带有组分隔符的样式:

>>> import locale
>>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
'English_United States.1252'
>>> conv = locale.localeconv()          # get a mapping of conventions
>>> x = 1234567.8
>>> locale.format("%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'

11.2. 模板

string 模块包含一个通用的 Template 类，具有适用于最终用户的简化语法。它允许用户在不更改应用逻辑的情况下定制自己的应用。

上述格式化操作是通过占位符实现的，占位符由 $ 加上合法的 Python 标识符（只能包含字母、数字和下划线）构成。一旦使用花括号将占位符括起来，就可以在后面直接跟上更多的字母和数字而无需空格分割。$$ 将被转义成单个字符 $:

>>> 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.'

如果在字典或关键字参数中未提供某个占位符的值，那么 substitute() 方法将抛出 KeyError。对于邮件合并类型的应用，用户提供的数据有可能是不完整的，此时使用 safe_substitute() 方法更加合适 —— 如果数据缺失，它会直接将占位符原样保留。

>>> 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.'

Template 的子类可以自定义分隔符。例如，以下是某个照片浏览器的批量重命名功能，采用了百分号作为日期、照片序号和照片格式的占位符:

>>> 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

模板的另一个应用是将程序逻辑与多样的格式化输出细节分离开来。这使得对 XML 文件、纯文本报表和 HTML 网络报表使用自定义模板成为可能。

11.3. 使用二进制数据记录格式

struct 模块提供了 pack() 和 unpack() 函数，用于处理不定长度的二进制记录格式。下面的例子展示了在不使用 zipfile 模块的情况下，如何循环遍历一个 ZIP 文件的所有头信息。Pack 代码 "H" 和 "I" 分别代表两字节和四字节无符号整数。"<" 代表它们是标准尺寸的小端字节序:

import struct

with open('myfile.zip', 'rb') as f:
    data = f.read()

start = 0
for i in range(3):                      # show the first 3 file headers
    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     # skip to the next header

11.4. 多线程

线程是一种对于非顺序依赖的多个任务进行解耦的技术。多线程可以提高应用的响应效率，当接收用户输入的同时，保持其他任务在后台运行。一个有关的应用场景是，将 I/O 和计算运行在两个并行的线程中。

以下代码展示了高阶的 threading 模块如何在后台运行任务，且不影响主程序的继续运行:

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()    # Wait for the background task to finish
print('Main program waited until background was done.')

多线程应用面临的主要挑战是，相互协调的多个线程之间需要共享数据或其他资源。为此，threading 模块提供了多个同步操作原语，包括线程锁、事件、条件变量和信号量。

尽管这些工具非常强大，但微小的设计错误却可以导致一些难以复现的问题。因此，实现多任务协作的首选方法是将所有对资源的请求集中到一个线程中，然后使用 queue 模块向该线程供应来自其他线程的请求。 应用程序使用 Queue 对象进行线程间通信和协调，更易于设计，更易读，更可靠。

11.5. 日志记录

logging 模块提供功能齐全且灵活的日志记录系统。在最简单的情况下，日志消息被发送到文件或 sys.stderr

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')

这会产生以下输出:

WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down

默认情况下，informational 和 debugging 消息被压制，输出会发送到标准错误流。其他输出选项包括将消息转发到电子邮件，数据报，套接字或 HTTP 服务器。新的过滤器可以根据消息优先级选择不同的路由方式：DEBUG，INFO，WARNING，ERROR，和 CRITICAL。

日志系统可以直接从 Python 配置，也可以从用户配置文件加载，以便自定义日志记录而无需更改应用程序。

11.6. 弱引用

Python 会自动进行内存管理（对大多数对象进行引用计数并使用 garbage collection 来清除循环引用）。 当某个对象的最后一个引用被移除后不久就会释放其所占用的内存。

此方式对大多数应用来说都适用，但偶尔也必须在对象持续被其他对象所使用时跟踪它们。 不幸的是，跟踪它们将创建一个会令其永久化的引用。 weakref 模块提供的工具可以不必创建引用就能跟踪对象。 当对象不再需要时，它将自动从一个弱引用表中被移除，并为弱引用对象触发一个回调。 典型应用包括对创建开销较大的对象进行缓存:

>>> 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:/python310/lib/weakref.py", line 46, in __getitem__
    o = self.data[key]()
KeyError: 'primary'

11.7. 用于操作列表的工具

许多对于数据结构的需求可以通过内置列表类型来满足。 但是，有时也会需要具有不同效费比的替代实现。

array 模块提供了一种 array() 对象，它类似于列表，但只能存储类型一致的数据且存储密度更高。下面演示了一个用双字节无符号整数数组来储存整数的例子（类型码为 "H"），而通常的用 Python 的 int 对象来储存整数的列表，每个表项通常要使用 16 个字节：

>>> from array import array
>>> a = array('H', [4000, 10, 700, 22222])
>>> sum(a)
26932
>>> a[1:3]
array('H', [10, 700])

collections 模块提供了一种 deque() 对象，它类似于列表，但从左端添加和弹出的速度较快，而在中间查找的速度较慢。 此种对象适用于实现队列和广度优先树搜索:

>>> from collections import deque
>>> d = deque(["task1", "task2", "task3"])
>>> d.append("task4")
>>> print("Handling", d.popleft())
Handling task1

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)

在替代的列表实现以外，标准库也提供了其他工具，例如 bisect 模块具有用于操作有序列表的函数:

>>> 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')]

heapq 模块提供了基于常规列表来实现堆的函数。 最小值的条目总是保持在位置零。 这对于需要重复访问最小元素而不希望运行完整列表排序的应用来说非常有用:

>>> from heapq import heapify, heappop, heappush
>>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
>>> heapify(data)                      # rearrange the list into heap order
>>> heappush(data, -5)                 # add a new entry
>>> [heappop(data) for i in range(3)]  # fetch the three smallest entries
[-5, 0, 1]

11.8. 十进制浮点运算

decimal 模块提供了一种 Decimal 数据类型用于十进制浮点运算。 相比内置的 float 二进制浮点实现，该类特别适用于

财务应用和其他需要精确十进制表示的用途，

控制精度，

控制四舍五入以满足法律或监管要求，

跟踪有效小数位，或

用户期望结果与手工完成的计算相匹配的应用程序。

例如，使用十进制浮点和二进制浮点数计算70美分手机和5％税的总费用，会产生的不同结果。如果结果四舍五入到最接近的分数差异会更大:

>>> from decimal import *
>>> round(Decimal('0.70') * Decimal('1.05'), 2)
Decimal('0.74')
>>> round(.70 * 1.05, 2)
0.73

Decimal 表示的结果会保留尾部的零，并根据具有两个有效位的被乘数自动推出四个有效位。 Decimal 可以模拟手工运算来避免当二进制浮点数无法精确表示十进制数时会导致的问题。

精确表示特性使得 Decimal 类能够执行对于二进制浮点数来说不适用的模运算和相等性检测:

>>> Decimal('1.00') % Decimal('.10')
Decimal('0.00')
>>> 1.00 % 0.10
0.09999999999999995

>>> sum([Decimal('0.1')]*10) == Decimal('1.0')
True
>>> sum([0.1]*10) == 1.0
False

decimal 模块提供了运算所需要的足够精度:

>>> getcontext().prec = 36
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857')

12. 虚拟环境和包

12.1. 概述

Python应用程序通常会使用不在标准库内的软件包和模块。应用程序有时需要特定版本的库，因为应用程序可能需要修复特定的错误，或者可以使用库的过时版本的接口编写应用程序。

这意味着一个Python安装可能无法满足每个应用程序的要求。如果应用程序A需要特定模块的1.0版本但应用程序B需要2.0版本，则需求存在冲突，安装版本1.0或2.0将导致某一个应用程序无法运行。

这个问题的解决方案是创建一个 virtual environment，一个目录树，其中安装有特定Python版本，以及许多其他包。

然后，不同的应用将可以使用不同的虚拟环境。 要解决先前需求相冲突的例子，应用程序 A 可以拥有自己的 安装了 1.0 版本的虚拟环境，而应用程序 B 则拥有安装了 2.0 版本的另一个虚拟环境。 如果应用程序 B 要求将某个库升级到 3.0 版本，也不会影响应用程序 A 的环境。

12.2. 创建虚拟环境

用于创建和管理虚拟环境的模块称为 venv。venv 通常会安装你可用的最新版本的 Python。如果您的系统上有多个版本的 Python，您可以通过运行 python3 或您想要的任何版本来选择特定的Python版本。

要创建虚拟环境，请确定要放置它的目录，并将 venv 模块作为脚本运行目录路径:

python -m venv tutorial-env

这将创建 tutorial-env 目录，如果它不存在的话，并在其中创建包含 Python 解释器副本和各种支持文件的目录。

虚拟环境的常用目录位置是 .venv。 这个名称通常会令该目录在你的终端中保持隐藏，从而避免需要对所在目录进行额外解释的一般名称。 它还能防止与某些工具所支持的 .env 环境变量定义文件发生冲突。

创建虚拟环境后，您可以激活它。

在Windows上，运行:

tutorial-env\Scripts\activate.bat

在Unix或MacOS上，运行:

source tutorial-env/bin/activate

（这个脚本是为bash shell编写的。如果你使用 csh 或 fish shell，你应该改用 activate.csh 或 activate.fish 脚本。）

激活虚拟环境将改变你所用终端的提示符，以显示你正在使用的虚拟环境，并修改环境以使 python 命令所运行的将是已安装的特定 Python 版本。 例如：

$ source ~/envs/tutorial-env/bin/activate
(tutorial-env) $ python
Python 3.5.1 (default, May  6 2016, 10:59:36)
  ...
>>> import sys
>>> sys.path
['', '/usr/local/lib/python35.zip', ...,
'~/envs/tutorial-env/lib/python3.5/site-packages']
>>>

12.3. 使用pip管理包

你可以使用一个名为 pip 的程序来安装、升级和移除软件包。 默认情况下 pip 将从 Python Package Index [https://pypi.org] 安装软件包。 你可以在你的 web 浏览器中查看 Python Package Index。

pip 有许多子命令: "install", "uninstall", "freeze" 等等。 （请在 安装 Python 模块 指南页查看完整的 pip 文档。）

您可以通过指定包的名称来安装最新版本的包：

(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

您还可以通过提供包名称后跟 == 和版本号来安装特定版本的包：

(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

如果你重新运行这个命令，pip 会注意到已经安装了所请求的版本并且什么都不做。您可以提供不同的版本号来获取该版本，或者您可以运行 pip install --upgrade 将软件包升级到最新版本：

(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

pip uninstall 后跟一个或多个包名称将从虚拟环境中删除包。

pip show 将显示有关特定包的信息：

(tutorial-env) $ 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:

pip list 将显示虚拟环境中安装的所有软件包：

(tutorial-env) $ pip list
novas (3.1.1.3)
numpy (1.9.2)
pip (7.0.3)
requests (2.7.0)
setuptools (16.0)

pip freeze` 将生成一个类似的已安装包列表，但输出使用 pip install 期望的格式。一个常见的约定是将此列表放在 requirements.txt 文件中：

(tutorial-env) $ pip freeze > requirements.txt
(tutorial-env) $ cat requirements.txt
novas==3.1.1.3
numpy==1.9.2
requests==2.7.0

然后可以将 requirements.txt 提交给版本控制并作为应用程序的一部分提供。然后用户可以使用 install -r 安装所有必需的包：

(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

pip 有更多选择。有关 pip 的完整文档，请参阅 安装 Python 模块 指南。当您编写一个包并希望在 Python 包索引中使它可用时，请参考 分发 Python 模块 指南。

13. 接下来？

阅读本教程可能会增强您对使用Python的兴趣 - 您应该热衷于应用Python来解决您的实际问题。你应该去哪里了解更多？

本教程是Python文档集的一部分。其他文档：

Python 标准库:

您应该浏览本手册，该手册提供了有关标准库中的类型，功能和模块的完整（尽管简洁）参考资料。标准的Python发行版包含 很多 的附加代码。有些模块可以读取Unix邮箱，通过HTTP检索文档，生成随机数，解析命令行选项，编写CGI程序，压缩数据以及许多其他任务。浏览标准库参考可以了解更多可用的内容。

安装 Python 模块 解释了怎么安装由其他Python开发者编写的模块。

Python 语言参考手册: Python的语法和语义的详细解释。尽管阅读完非常繁重，但作为语言本身的完整指南是有用的。

更多Python资源：

https://www.python.org: Python 主网站。 它包含代码、文档和指向全网 Python 相关网页的链接。

https://docs.python.org ：快速访问Python的文档。

https://pypi.org: The Python Package Index，以前也被昵称为 Cheese Shop 1，是可下载用户自制 Python 模块的索引。 当你要开始发布代码时，你可以在此处进行注册以便其他人能找到它。

https://code.activestate.com/recipes/langs/python/ ：Python Cookbook是一个相当大的代码示例集，更多的模块和有用的脚本。特别值得一看的贡献收集在一本名为Python Cookbook（O'Reilly＆Associates，ISBN 0-596-00797-3）的书中。

https://pyvideo.org 收集了来自研讨会和用户组会议的 Python 相关视频的链接。

https://scipy.org ：Scientific Python 项目包含用于快速矩阵计算和操作的模块，以及用于诸如线性代数，傅里叶变换，非线性求解器，随机数分布，统计分析等的一系列包。

对于与Python相关的问题和问题报告，您可以发布到新闻组 comp.lang.python ，或者将它们发送到邮件列表python-list@python.org。新闻组和邮件列表是互通的，因此发布到一个地方将自动转发给另一个。每天有数百个帖子，询问（和回答）问题，建议新功能，以及宣布新模块。邮件列表档案可在 https://mail.python.org/pipermail/ 上找到。

在发问之前，请务必查看以下列表 常见问题 （或简写为 FAQ）。常见问题包含了很多一次又一次被提出的问题及其答案，所以可能已经包含了您的问题解决方案。

备注

1

“Cheese Shop”是 Monty Python 的一个短剧：一位顾客来到一家奶酪商店，但无论他要哪种奶酪，店员都说没有货。

14. 交互式编辑和编辑历史

某些版本的 Python 解释器支持编辑当前输入行和编辑历史记录，类似 Korn shell 和 GNU Bash shell 的功能 。这个功能使用了 GNU Readline [https://tiswww.case.edu/php/chet/readline/rltop.html] 来实现，一个支持多种编辑方式的库。这个库有它自己的文档，在这里我们就不重复说明了。

14.1. Tab 补全和编辑历史

在解释器启动的时候，补全变量和模块名的功能将 自动打开，以便在按下 Tab 键的时候调用补全函数。它会查看 Python 语句名称，当前局部变量和可用的模块名称。处理像 string.a 的表达式，它会求值在最后一个 '.' 之前的表达式，接着根据求值结果对象的属性给出补全建议。如果拥有 __getattr__() 方法的对象是表达式的一部分，注意这可能会执行程序定义的代码。默认配置下会把编辑历史记录保存在用户目录下名为 .python_history 的文件。在下一次 Python 解释器会话期间，编辑历史记录仍旧可用。

14.2. 默认交互式解释器的替代品

Python 解释器与早期版本的相比，向前迈进了一大步；无论怎样，还有些希望的功能：如果能在编辑连续行时建议缩进（解析器知道接下来是否需要缩进符号），那将很棒。补全机制可以使用解释器的符号表。有命令去检查（甚至建议）括号，引号以及其他符号是否匹配。

一个可选的增强型交互式解释器是 IPython [https://ipython.org/]，它已经存在了有一段时间，它具有 tab 补全，探索对象和高级历史记录管理功能。它还可以彻底定制并嵌入到其他应用程序中。另一个相似的增强型交互式环境是 bpython [https://www.bpython-interpreter.org/]。

15. 浮点算术：争议和限制

浮点数在计算机硬件中表示为以 2 为基数（二进制）的小数。举例而言，十进制的小数

0.125

等于 1/10 + 2/100 + 5/1000 ，同理，二进制的小数

0.001

等于0/2 + 0/4 + 1/8。这两个小数具有相同的值，唯一真正的区别是第一个是以 10 为基数的小数表示法，第二个则是 2 为基数。

不幸的是，大多数的十进制小数都不能精确地表示为二进制小数。这导致在大多数情况下，你输入的十进制浮点数都只能近似地以二进制浮点数形式储存在计算机中。

用十进制来理解这个问题显得更加容易一些。考虑分数 1/3 。我们可以得到它在十进制下的一个近似值

0.3

或者，更近似的，:

0.33

或者，更近似的，:

0.333

以此类推。结果是无论你写下多少的数字，它都永远不会等于 1/3 ，只是更加更加地接近 1/3 。

同样的道理，无论你使用多少位以 2 为基数的数码，十进制的 0.1 都无法精确地表示为一个以 2 为基数的小数。 在以 2 为基数的情况下， 1/10 是一个无限循环小数

0.0001100110011001100110011001100110011001100110011...

在任何一个位置停下，你都只能得到一个近似值。因此，在今天的大部分架构上，浮点数都只能近似地使用二进制小数表示，对应分数的分子使用每 8 字节的前 53 位表示，分母则表示为 2 的幂次。在 1/10 这个例子中，相应的二进制分数是 3602879701896397 / 2 ** 55 ，它很接近 1/10 ，但并不是 1/10 。

大部分用户都不会意识到这个差异的存在，因为 Python 只会打印计算机中存储的二进制值的十进制近似值。在大部分计算机中，如果 Python 想把 0.1 的二进制对应的精确十进制打印出来，将会变成这样

>>> 0.1
0.1000000000000000055511151231257827021181583404541015625

这比大多数人认为有用的数字更多，因此Python通过显示舍入值来保持可管理的位数

>>> 1 / 10
0.1

牢记，即使输出的结果看起来好像就是 1/10 的精确值，实际储存的值只是最接近 1/10 的计算机可表示的二进制分数。

有趣的是，有许多不同的十进制数共享相同的最接近的近似二进制小数。例如， 0.1 、 0.10000000000000001 、 0.1000000000000000055511151231257827021181583404541015625 全都近似于 3602879701896397 / 2 ** 55 。由于所有这些十进制值都具有相同的近似值，因此可以显示其中任何一个，同时仍然保留不变的 eval(repr(x)) == x 。

在历史上，Python 提示符和内置的 repr() 函数会选择具有 17 位有效数字的来显示，即 0.10000000000000001。 从 Python 3.1 开始，Python（在大多数系统上）现在能够选择这些表示中最短的并简单地显示 0.1 。

请注意这种情况是二进制浮点数的本质特性：它不是 Python 的错误，也不是你代码中的错误。 你会在所有支持你的硬件中的浮点运算的语言中发现同样的情况（虽然某些语言在默认状态或所有输出模块下都不会 显示 这种差异）。

想要更美观的输出，你可能会希望使用字符串格式化来产生限定长度的有效位数:

>>> format(math.pi, '.12g')  # give 12 significant digits
'3.14159265359'

>>> format(math.pi, '.2f')   # give 2 digits after the point
'3.14'

>>> repr(math.pi)
'3.141592653589793'

必须重点了解的是，这在实际上只是一个假象：你只是将真正的机器码值进行了舍入操作再 显示 而已。

一个假象还可能导致另一个假象。 例如，由于这个 0.1 并非真正的 1/10，将三个 0.1 的值相加也不一定能恰好得到 0.3:

>>> .1 + .1 + .1 == .3
False

而且，由于这个 0.1 无法精确表示 1/10 的值而这个 0.3 也无法精确表示 3/10 的值，使用 round() 函数进行预先舍入也是没用的:

>>> round(.1, 1) + round(.1, 1) + round(.1, 1) == round(.3, 1)
False

虽然这些小数无法精确表示其所要代表的实际值，round() 函数还是可以用来“事后舍入”，使得实际的结果值可以做相互比较:

>>> round(.1 + .1 + .1, 10) == round(.3, 10)
True

二进制浮点运算会造成许多这样的意外。 有关 "0.1" 的问题会在下面的 "表示性错误" 一节中更精确详细地描述。 请参阅 浮点数的危险性 [https://www.lahey.com/float.htm] 了解有关其他常见意外现象的更完整介绍。

正如那篇文章的结尾所言，“对此问题并无简单的答案。” 但是也不必过于担心浮点数的问题！ Python 浮点运算中的错误是从浮点运算硬件继承而来，而在大多数机器上每次浮点运算得到的 2**53 数码位都会被作为 1 个整体来处理。 这对大多数任务来说都已足够，但你确实需要记住它并非十进制算术，且每次浮点运算都可能会导致新的舍入错误。

虽然病态的情况确实存在，但对于大多数正常的浮点运算使用来说，你只需简单地将最终显示的结果舍入为你期望的十进制数值即可得到你期望的结果。 str() 通常已足够，对于更精度的控制可参看 格式字符串语法 中 str.format() 方法的格式描述符。

对于需要精确十进制表示的使用场景，请尝试使用 decimal 模块，该模块实现了适合会计应用和高精度应用的十进制运算。

另一种形式的精确运算由 fractions 模块提供支持，该模块实现了基于有理数的算术运算（因此可以精确表示像 1/3 这样的数值）。

如果你是浮点运算的重度用户则你应当了解一下 NumPy 包以及由 SciPy 项目所提供的许多其他数字和统计运算包。 参见 <https://scipy.org>。

Python 也提供了一些工具，可以在你真的 想要 知道一个浮点数精确值的少数情况下提供帮助。 例如 float.as_integer_ratio() 方法会将浮点数表示为一个分数:

>>> x = 3.14159
>>> x.as_integer_ratio()
(3537115888337719, 1125899906842624)

由于这是一个精确的比值，它可以被用来无损地重建原始值:

>>> x == 3537115888337719 / 1125899906842624
True

float.hex() 方法会以十六进制（以 16 为基数）来表示浮点数，同样能给出保存在你的计算机中的精确值:

>>> x.hex()
'0x1.921f9f01b866ep+1'

这种精确的十六进制表示法可被用来精确地重建浮点值:

>>> x == float.fromhex('0x1.921f9f01b866ep+1')
True

由于这种表示法是精确的，它适用于跨越不同版本（平台无关）的 Python 移植数值，以及与支持相同格式的其他语言（例如 Java 和 C99）交换数据.

另一个有用的工具是 math.fsum() 函数，它有助于减少求和过程中的精度损失。 它会在数值被添加到总计值的时候跟踪“丢失的位”。 这可以很好地保持总计值的精确度， 使得错误不会积累到能影响结果总数的程度:

>>> sum([0.1] * 10) == 1.0
False
>>> math.fsum([0.1] * 10) == 1.0
True

15.1. 表示性错误

本小节将详细解释 "0.1" 的例子，并说明你可以怎样亲自对此类情况进行精确分析。 假定前提是已基本熟悉二进制浮点表示法。

表示性错误 是指某些（其实是大多数）十进制小数无法以二进制（以 2 为基数的计数制）精确表示这一事实造成的错误。 这就是为什么 Python（或者 Perl、C、C++、Java、Fortran 以及许多其他语言）经常不会显示你所期待的精确十进制数值的主要原因。

为什么会这样？ 1/10 是无法用二进制小数精确表示的。 目前（2000年11月）几乎所有使用 IEEE-754 浮点运算标准的机器以及几乎所有系统平台都会将 Python 浮点数映射为 IEEE-754 “双精度类型”。 754 双精度类型包含 53 位精度，因此在输入时，计算会尽量将 0.1 转换为以 J/2**N 形式所能表示的最接近分数，其中 J 为恰好包含 53 个二进制位的整数。 重新将

1 / 10 ~= J / (2**N)

写为

J ~= 2**N / 10

并且由于 J 恰好有 53 位 (即 >= 2**52 但 < 2**53)，N 的最佳值为 56:

>>> 2**52 <=  2**56 // 10  < 2**53
True

也就是说，56 是唯一的 N 值能令 J 恰好有 53 位。 这样 J 的最佳可能值就是经过舍入的商:

>>> q, r = divmod(2**56, 10)
>>> r
6

由于余数超过 10 的一半，最佳近似值可通过四舍五入获得:

>>> q+1
7205759403792794

这样在 754 双精度下 1/10 的最佳近似值为:

7205759403792794 / 2 ** 56

分子和分母都除以二则结果小数为:

3602879701896397 / 2 ** 55

请注意由于我们做了向上舍入，这个结果实际上略大于 1/10；如果我们没有向上舍入，则商将会略小于 1/10。 但无论如何它都不会是 精确的 1/10！

因此计算永远不会“看到”1/10：它实际看到的就是上面所给出的小数，它所能达到的最佳 754 双精度近似值:

>>> 0.1 * 2 ** 55
3602879701896397.0

如果我们将该小数乘以 10**55，我们可以看到该值输出为 55 位的十进制数:

>>> 3602879701896397 * 10 ** 55 // 2 ** 55
1000000000000000055511151231257827021181583404541015625

这意味着存储在计算机中的确切数值等于十进制数值 0.1000000000000000055511151231257827021181583404541015625。 许多语言（包括较旧版本的 Python）都不会显示这个完整的十进制数值，而是将结果舍入为 17 位有效数字:

>>> format(0.1, '.17f')
'0.10000000000000001'

fractions 和 decimal 模块可令进行此类计算更加容易:

>>> 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'

16. 附录

16.1. 交互模式

16.1.1. 错误处理

当发生错误时，解释器会打印错误信息和栈回溯。在交互模式下，将回到主命令提示符，而如果输入内容来自文件，在打印栈回溯之后，程序会以非零的退出状态码退出。（注：这个上下文中所说的错误不包括 try 语句中已经被 except 子句所捕获的异常。）有些错误是无条件致命的，会导致程序以非零状态退出，比如内部逻辑矛盾或某些情况下的内存耗尽。所有错误信息都会被写入标准错误流；而命令的正常输出则被写入标准输出流。

将中断字符（通常为 Control-C 或 Delete ）键入主要或辅助提示符会取消输入并返回主提示符。 1 在执行命令时键入中断引发的 KeyboardInterrupt 异常，可以由 try 语句处理。

16.1.2. 可执行的Python脚本

在 BSD 等类Unix系统上，Python 脚本可以像 shell 脚本一样直接执行，通过在第一行添加：

#!/usr/bin/env python3.5

（假设解释器位于用户的 PATH ）脚本的开头，并将文件设置为可执行。 #! 必须是文件的前两个字符。在某些平台上，第一行必须以Unix样式的行结尾（'\n'）结束，而不是以Windows（'\r\n'）行结尾。注意，“散列字符”，或者说“磅字符”， '#' ，在Python中代表注释开始。

可以使用 chmod 命令为脚本提供可执行模式或权限。

$ chmod +x myscript.py

在Windows系统上，没有“可执行模式”的概念。 Python安装程序自动将 .py 文件与 python.exe 相关联，这样双击Python文件就会将其作为脚本运行。扩展也可以是 .pyw ，在这种情况下，会隐藏通常出现的控制台窗口。

16.1.3. 交互式启动文件

当您以交互模式使用 Python 时，您可能会希望在每次启动解释器时，解释器先执行几条您预先编写的命令，然后您再以交互模式继续使用。您可以通过将名为 PYTHONSTARTUP 的环境变量设置为包含启动命令的文件的文件名来实现。这类似于 Unix shell 的 .profile 功能。

Python 只有在交互模式时，才会读取此文件，而非在从脚本读指令或是将 /dev/tty 显式作为被运行的 Python 脚本的文件名时（后者反而表现得像一个交互式会话）。这个文件与交互式指令共享相同的命名空间，所以它定义或导入的对象可以在交互式会话中直接使用。您也可以在该文件中更改提示符 sys.ps1 和 sys.ps2。

如果您想 从当前目录中 读取一个额外的启动文件，您可以在上文所说的全局启动文件中编写像 if os.path.isfile('.pythonrc.py'): exec(open('.pythonrc.py').read()) 这样的代码。如果要在脚本中使用启动文件，则必须在脚本中显式执行此操作：

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)

16.1.4. 定制模块

Python提供了两个钩子来让你自定义它：sitecustomize 和 usercustomize。要查看其工作原理，首先需要找到用户site-packages目录的位置。启动Python并运行此代码:

>>> import site
>>> site.getusersitepackages()
'/home/user/.local/lib/python3.5/site-packages'

现在，您可以在该目录中创建一个名为 usercustomize.py 的文件，并将所需内容放入其中。它会影响Python的每次启动，除非它以 -s 选项启动，以禁用自动导入。

sitecustomize 以相同的方式工作，但通常由计算机管理员在全局 site-packages 目录中创建，并在 usercustomize 之前被导入。有关详情请参阅 site 模块的文档。

备注

1

GNU Readline 包的问题可能会阻止这种情况。

Python安装和使用

这一部分文档专门介绍关于在不同平台上设置Python环境、调用解释器以及让使用Python更容易的一些事情的有用信息。

1. 命令行与环境

1.1. 命令行

1.1.1. 接口选项

1.1.2. 通用选项

1.1.3. 其他选项

1.1.4. 不应当使用的选项

1.2. 环境变量

1.2.1. 调试模式变量

2. 在类Unix环境下使用Python

2.1. 获得并安装Python的最新版本

2.1.1. 在Linux中

2.1.2. 在FreeBSD和OpenBSD上

2.1.3. 在OpenSolaris系统上

2.2. 构建Python

2.3. 与Python相关的路径和文件

2.4. 杂项

2.5. 自定义 OpenSSL

3. 配置 Python

3.1. 配置选项

3.1.1. 通用选项

3.1.2. 安装时的选项

3.1.3. 性能选项

3.1.4. Python 调试级编译

3.1.5. 调试选项

3.1.6. 链接器选项

3.1.7. 库选项

3.1.8. 安全性选项

3.1.9. macOS 选项

3.2. Python 构建系统

3.2.1. 构建系统的主要文件

3.2.2. 主要构建步骤

3.2.3. 主要 Makefile 目标

3.2.4. C 扩展

3.3. 编译器和链接器的标志

3.3.1. 预处理器的标志

3.3.2. 编译器标志

3.3.3. 链接器标志位

4. 在Windows上使用 Python

4.1. 完整安装程序

4.1.1. 安装步骤

4.1.2. 删除 MAX_PATH 限制

4.1.3. 无UI 安装

4.1.4. 免下载安装

4.1.5. 修改安装

4.2. Microsoft Store包

4.2.1. 已知的问题

4.2.1.1. 本地数据、注册表项和临时路径的重定向

4.3. nuget.org 安装包

4.4. 可嵌入的包

4.4.1. Python 应用程序

4.4.2. 嵌入Python

4.5. 替代捆绑包

4.6. 配置Python

4.6.1. 附录：设置环境变量

4.6.2. 查找Python可执行文件

4.7. UTF-8 模式

4.8. 适用于Windows的Python启动器

4.8.1. 入门

4.8.1.1. 从命令行

4.8.1.2. 从虚拟环境

4.8.1.3. 从脚本

4.8.1.4. 从文件关联

4.8.2. Shebang 行

4.8.3. shebang 行的参数

4.8.4. 自定义

4.8.4.1. 通过INI文件自定义

4.8.4.2. 自定义默认的Python版本

4.8.5. 诊断

4.9. 查找模块

4.10. 附加模块

4.10.1. PyWin32

4.10.2. cx_Freeze

4.11. 在Windows上编译Python

4.12. 其他平台

5. 在 Mac 上使用 Python

5.1. 获取和安装 MacPython

5.1.1. 如何运行 Python 脚本

5.1.2. 运行有图形界面的脚本

5.1.3. 配置

5.2. IDE

5.3. 安装额外的 Python 包

5.4. Mac 上的图形界面编程

5.5. 在 Mac 上分发 Python 应用程序

5.6. 其他资源

6. 编辑器和集成开发环境

1. 命令行与环境

为获取各种设置信息，CPython 解析器会扫描命令行与环境。

CPython 实现细节： 其他实现的命令行方案可能会有所不同。 详见 其他实现。

1.1. 命令行

调用 Python 时，可以指定下列任意选项：

python [-bBdEhiIOqsSuvVWx?] [-c command | -m module-name | script | - ] [args]

最常见的用例是启动时执行脚本：

python myscript.py

1.1.1. 接口选项

解释器接口类似于 UNIX shell，但提供了额外的调用方法:

用连接到 tty 设备的标准输入调用时，会提示输入并执行命令，输入 EOF （文件结束符，UNIX 中按 Ctrl-D，Windows 中按 Ctrl-Z, Enter）时终止。

用文件名参数或以标准输入文件调用时，读取，并执行该脚本文件。

用目录名参数调用时，从该目录读取、执行适当名称的脚本。

用 -c command 调用时，执行 command 表示的 Python 语句。command 可以包含用换行符分隔的多条语句。注意，前导空白字符在 Python 语句中非常重要！

用 -m module-name 调用时，在 Python 模块路径中查找指定的模块，并将其作为脚本执行。

非交互模式下，先解析全部输入，再执行。

接口选项会终结解释器读入的选项列表，所有后续参数都在 sys.argv 里 -- 注意，首个元素，即下标为零的元素（sys.argv[0]）是表示程序来源的字符串。

-c <command>

执行 command 中的 Python 代码。command 可以是一条语句，也可以是用换行符分隔的多条语句，其中，前导空白字符与普通模块代码中的作用一样。

使用此选项时，sys.argv 的首个元素为 "-c"，并会把当前目录加入至 sys.path 开头（让该目录中的模块作为顶层模块导入）。

引发一个 审计事件 cpython.run_command 并附带参数 command。

-m <module-name>

在 sys.path 中搜索指定模块，并以 __main__ 模块执行其内容。

该参数是 模块名，请勿输入文件扩展名（.py）。模块名应为有效的绝对 Python 模块名，但本实现对此不作强制要求（例如，允许使用含连字符 - 的名称）。

包名称（包括命名空间包）也允许使用。使用包名称而不是普通模块名时，解释器把 <pkg>.__main__ 作为主模块执行。此行为特意被设计为与作为脚本参数传递给解释器的目录和 zip 文件的处理方式类似。

注解

此选项不适用于内置模块和以 C 编写的扩展模块，因为它们并没有对应的 Python 模块文件。 但是它仍然适用于预编译的模块，即使没有可用的初始源文件。

如果给出此选项，sys.argv 的首个元素将为模块文件的完整路径 (在定位模块文件期间，首个元素将设为 "-m")。 与 -c 选项一样，当前目录将被加入 sys.path 的开头。

-I 选项可用来在隔离模式下运行脚本，此模式中 sys.path 既不包含当前目录也不包含用户的 site-packages 目录。 所有 PYTHON* 环境变量也会被忽略。

许多标准库模块都包含在执行时，以脚本方式调用的代码。例如 timeit 模块：

python -m timeit -s 'setup here' 'benchmarked code here'
python -m timeit -h # for details

引发一个 审计事件 cpython.run_module 并附带参数 module-name。

参见

runpy.run_module()

Python 代码可以直接使用的等效功能

PEP 338 [https://www.python.org/dev/peps/pep-0338] -- 将模块作为脚本执行

在 3.1 版更改: 提供包名称来运行 __main__ 子模块。

在 3.4 版更改: 同样支持命名空间包

-

从标准输入 (sys.stdin) 读取命令。标准输入为终端时，使用 -i。

使用此选项时，sys.argv 的第一个元素是 "-"， 同时，把当前目录加入 sys.path 开头。

引发一个不带参数的 审计事件 cpython.run_stdin。

<script>

执行 script 中的 Python 代码，该参数应为（绝对或相对）文件系统路径，指向 Python 文件、包含 __main__.py 文件的目录，或包含 __main__.py 文件的 zip 文件。

给出此选项时，sys.argv 的第一个元素就是在命令行中指定的脚本名称。

如果脚本名称直接指向 Python 文件，则把该文件所在目录加入 sys.path 的开头，并且把该文件当作 __main__ 模块来执行。

如果脚本名称指向目录或 zip 文件，则把脚本名加入 sys.path 的开头，并把该位置中的 __main__.py 文件当作 __main__ 模块来执行。

-I 选项以隔离模式运行脚本，此模式中，sys.path 既不包含脚本目录，也不包含用户的 site-packages 目录，还会忽略所有 PYTHON* 环境变量。

引发一个 审计事件 cpython.run_file 并附带参数 filename。

参见

runpy.run_path()

Python 代码可以直接使用的等效功能

未给出接口选项时，使用 -i，sys.argv[0] 为空字符串 ("")，并把当前目录加至 sys.path 的开头。 此外，如果系统支持，还能自动启用 tab 补全和历史编辑（参见 Readline 配置）。

参见

唤出解释器

在 3.4 版更改: 自动启用 tab 补全和历史编辑。

1.1.2. 通用选项

-?

-h

--help

输出所有命令行选项的简介。

-V

--version

输出 Python 版本号并退出。示例如下：

Python 3.8.0b2+

输入两次 V 选项时，输出更多构建信息，例如：

Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)
[GCC 6.2.0 20161005]

3.6 新版功能: -VV 选项。

1.1.3. 其他选项

-b

用 str 与 bytes 或 bytearray 对比， 或对比 bytes 与 int 时，会发出警告。重复给出该选项（-bb）时会报错。

在 3.5 版更改: 影响 bytes 与 int 的比较。

-B

给出此选项时，Python 不在导入源模块时写入 .pyc 文件。另请参阅 PYTHONDONTWRITEBYTECODE。

--check-hash-based-pycs default|always|never

控制基于哈希值的 .pyc 文件的验证行为。 参见 已缓存字节码的失效。 当设为 default 时，已选定和未选定的基于哈希值的字节码缓存文件将根据其默认语义进行验证。 当设为 always 时，所有基于哈希值的 .pyc 文件，不论是已选定还是未选定的都将根据其对应的源文件进行验证。 当设为 never 时，基于哈希值的 .pyc 文件将不会根据其对应的源文件进行验证。

基于时间戳的 .pyc 文件的语义不会受此选项影响。

-d

开启解析器调试输出（限专家使用，依赖于编译选项）。 另请参阅 PYTHONDEBUG。

-E

忽略所有 PYTHON* 环境变量，例如，已设置的 PYTHONPATH 和 PYTHONHOME。

-i

脚本是第一个参数，或使用 -c 时，即便 sys.stdin 不是终端，执行脚本或命令后，也会进入交互模式。不读取 PYTHONSTARTUP 文件。

本选项用于，脚本触发异常时，检查全局变量或堆栈回溯。 详见 PYTHONINSPECT。

-I

在隔离模式下运行 Python。 这将同时应用 -E 和 -s。 在隔离模式下 sys.path 既不包含脚本所在目录也不包含用户的 site-packages 目录。 所有 PYTHON* 环境变量也会被忽略。 还可以施加更进一步的限制以防止用户注入恶意代码。

3.4 新版功能.

-O

移除 assert 语句以及任何以 __debug__ 的值作为条件的代码。 通过在 .pyc 扩展名之前添加 .opt-1 来扩充已编译文件 (bytecode) 的文件名 (参见 PEP 488 [https://www.python.org/dev/peps/pep-0488])。 另请参阅 PYTHONOPTIMIZE。

在 3.5 版更改: 依据 PEP 488 [https://www.python.org/dev/peps/pep-0488] 修改 .pyc 文件名。

-OO

在启用 -O 的同时丢弃文档字符串。 通过在 .pyc 扩展名之前添加 .opt-2 来扩展已编译文件 (bytecode) 的文件名 (参见 PEP 488 [https://www.python.org/dev/peps/pep-0488])。

在 3.5 版更改: 依据 PEP 488 [https://www.python.org/dev/peps/pep-0488] 修改 .pyc 文件名。

-q

即使在交互模式下也不显示版权和版本信息。

3.2 新版功能.

-R

开启哈希随机化。 此选项权 PYTHONHASHSEED 环境变量设置为 0 时起作用，因为哈希随机化是默认启用的。

在Python的早期版本中，此选项启用哈希随机化，将 str 和 bytes 的对象 __hash__() 的值 "加盐" 为不可预测的随机值。虽然它们在单个Python进程中保持不变，但是在重复调用的Python进程之间它们是不可预测的。

Hash randomization is intended to provide protection against a denial-of-service caused by carefully chosen inputs that exploit the worst case performance of a dict construction, O(n²) complexity. See http://www.ocert.org/advisories/ocert-2011-003.html for details.

PYTHONHASHSEED 允许你为哈希种子密码设置一个固定值。

在 3.7 版更改: 此选项不会再被忽略。

3.2.3 新版功能.

-s

不要将 用户 site-packages 目录 添加到 sys.path。

参见

PEP 370 [https://www.python.org/dev/peps/pep-0370] -- 分用户的 site-packages 目录

-S

禁用 site 的导入及其所附带的基于站点对 sys.path 的操作。 如果 site 会在稍后被显式地导入也会禁用这些操作 (如果你希望触发它们则应调用 site.main())。

-u

强制 stdout 和 stderr 流不使用缓冲。 此选项对 stdin 流无影响。

另请参阅 PYTHONUNBUFFERED。

在 3.7 版更改: stdout 和 stderr 流在文本层现在不使用缓冲。

-v

每次在初始化模块时会打印一条信息，显示被加载的地方（文件名或内置模块名）。当给出两个v（ -vv ）时，搜索模块时会为每个文件打印一条信息。退出时模块清理的信息也会给出来。

在 3.10 版更改: 由 site 模块可以得到将要处理的站点路径和 .pth 文件。

参阅 PYTHONVERBOSE 。

-W arg

警告信息的控制。Python 的警告机制默认将警告信息打印到 sys.stderr。

最简单的设置是将某个特定操作无条件地应用于进程所发出所有警告 (即使是在默认情况下会忽略的那些警告):

-Wdefault  # Warn once per call location
-Werror    # Convert to exceptions
-Walways   # Warn every time
-Wmodule   # Warn once per calling module
-Wonce     # Warn once per Python process
-Wignore   # Never warn

action 名可以根据需要进行缩写，解释器将会解析为合适的名称。例如，-Wi 与 -Wignore 相同。

完整的参数如下：

action:message:category:module:lineno

空字段匹配所有值；尾部的空字段可以省略。例如，-W ignore::DeprecationWarning 将忽略所有的 DeprecationWarning 警告。

action 字段如上所述，但只适用于匹配其余字段的警告。

message 字段必须与整个警告信息相匹配；不区分大小写。

category 字段与警告类别相匹配（DeprecationWarning 等）。必须是个类名；检测消息的实际警告类别是否为指定类别的子类。

module 字段匹配的是（完整限定）模块名称；这种匹配是大小写敏感的。

lineno 字段匹配行号，其中 0 匹配所有行号，相当于省略了行号。

可以给出多个 -W 选项；当某条警告信息匹配上多个选项时，将执行最后一个匹配项的操作。非法 -W 选项将被忽略（不过，在触发第一条警告时，会打印出一条无效选项的警告信息）。

警告信息还可以用 PYTHONWARNINGS 环境变量来控制，也可以在 Python 程序中用 warnings 模块进行控制。例如， warnings.filterwarnings() 函数可对警告信息使用正则表达式。

请参阅 警告过滤器 和 警告过滤器的介绍 了解更多细节。

-x

跳过源中第一行，以允许使用非 Unix 形式的 #!cmd。 这适用于 DOS 专属的破解操作。

-X

保留用于各种具体实现专属的选项。 CPython 目前定义了下列可用的值：

-X faulthandler 启用 faulthandler；

-X showrefcount 可在程序结束时或在交互式解释器每条语句后，输出总的引用计数和使用的内存块数。这只适用于 调试版本。

-X tracemalloc 使用 tracemalloc 模块启动对 Python 内存分配的跟踪。 默认情况下，只有最近的帧会保存在跟踪的回溯信息中。 使用 -X tracemalloc=NFRAME 以启动限定回溯 NFRAME 帧的跟踪。 请参阅 tracemalloc.start() 了解详情。

-X int_max_str_digits 将配置 整数字符串转换长度限制。 另请参阅 PYTHONINTMAXSTRDIGITS。

-X importtime 显示每次导入耗费的时间。 它会显示模块名称，累计时间（包括嵌套的导入）和自身时间（排除嵌套的导入）。 请注意它的输出在多线程应用程序中可能会出错。 典型用法如 python3 -X importtime -c 'import asyncio'。 另请参阅 PYTHONPROFILEIMPORTTIME。

-X dev: 启用 Python 开发模式，引入在默认情况下启用会导致开销过大的运行时检查。

-X utf8 启用 Python UTF-8 模式。 -X utf8=0 显式禁用 Python UTF-8 模式 (即便已自动启用)。

-X pycache_prefix=PATH 允许将 .pyc 文件写入以给定目录为根的并行树，而不是代码树。另见 PYTHONPYCACHEPREFIX 。

-X warn_default_encoding issues a EncodingWarning when the locale-specific default encoding is used for opening files. See also PYTHONWARNDEFAULTENCODING.

它还允许传入任意值并通过 sys._xoptions 字典来提取这些值。

在 3.2 版更改: 增加了 -X 选项。

3.3 新版功能: -X faulthandler 选项。

3.4 新版功能: -X showrefcount 与 -X tracemalloc 选项。

3.6 新版功能: -X showalloccount 选项。

3.7 新版功能: -X importtime, -X dev 与 -X utf8 选项。

3.8 新版功能: -X pycache_prefix 选项。 -X dev 选项现在在 io.IOBase 析构函数中记录 close() 异常。

在 3.9 版更改: 使用 -X dev 选项，在字符串编码和解码操作时检查 encoding 和 errors 参数。

The -X showalloccount 选项已被移除。

3.10 新版功能: -X warn_default_encoding 选项。

3.10.7 新版功能: -X int_max_str_digits 选项。

Deprecated since version 3.9, removed in version 3.10: The -X oldparser option.

1.1.4. 不应当使用的选项

-J

保留给 Jython [https://www.jython.org/] 使用。

1.2. 环境变量

这些环境变量会影响 Python 的行为，它们是在命令行开关之前被处理的，但 -E 或 -I 除外。 根据约定，当存在冲突时命令行开关会覆盖环境变量的设置。

PYTHONHOME

更改标准 Python 库的位置。 默认情况下库是在 prefix/lib/pythonversion 和 exec_prefix/lib/pythonversion 中搜索，其中 prefix 和 exec_prefix 是由安装位置确定的目录，默认都位于 /usr/local。

当 PYTHONHOME 被设为单个目录时，它的值会同时替代 prefix 和 exec_prefix。 要为两者指定不同的值，请将 PYTHONHOME 设为 prefix:exec_prefix。

PYTHONPATH

增加模块文件默认搜索路径。 所用格式与终端的 PATH 相同：一个或多个由 os.pathsep 分隔的目录路径名称（例如 Unix 上用冒号而在 Windows 上用分号）。 默认忽略不存在的目录。

除了普通目录之外，单个 PYTHONPATH 条目可以引用包含纯Python模块的zip文件（源代码或编译形式）。无法从zip文件导入扩展模块。

默认索引路径依赖于安装路径，但通常都是以 prefix/lib/pythonversion 开始 (参见上文中的 PYTHONHOME)。 它 总是 会被添加到 PYTHONPATH。

有一个附加目录将被插入到索引路径的 PYTHONPATH 之前，正如上文中 接口选项 所描述的。 搜索路径可以在 Python 程序内作为变量 sys.path 来进行操作。

PYTHONPLATLIBDIR

如果它被设为非空字符串，则会覆盖 sys.platlibdir 值。

3.9 新版功能.

PYTHONSTARTUP

这如果是一个可读文件的名称，该文件中的 Python 命令会在交互模式的首个提示符显示之前被执行。 该文件会在与交互式命令执行所在的同一命名空间中被执行，因此其中所定义或导入的对象可以在交互式会话中无限制地使用。 你还可以在这个文件中修改提示符 sys.ps1 和 sys.ps2 以及钩子 sys.__interactivehook__。

使用 filename 参数会引发 审计事件 cpython.run_startup 。

PYTHONOPTIMIZE

这如果被设为一个非空字符串，它就相当于指定 -O 选项。 如果设为一个整数，则它就相当于多次指定 -O。

PYTHONBREAKPOINT

此变量如果被设定，它会使用加点号的路径标记一个可调用对象。 包含该可调用对象的模块将被导入，随后该可调用对象将由 sys.breakpointhook() 的默认实现来运行，后者自身将由内置的 breakpoint() 来调用。 如果未设定，或设定为空字符串，则它相当于值 "pdb.set_trace"。 将此变量设为字符串 "0" 会导致 sys.breakpointhook() 的默认实现不做任何事而直接返回。

3.7 新版功能.

PYTHONDEBUG

此变量如果被设为一个非空字符串，它就相当于指定 -d 选项。 如果设为一个整数，则它就相当于多次指定 -d。

PYTHONINSPECT

此变量如果被设为一个非空字符串，它就相当于指定 -i 选项。

此变量也可由 Python 代码使用 os.environ 来修改以在程序终结时强制检查模式。

引发一个不带参数的 审计事件 cpython.run_stdin。

在 3.10.15 版更改: (also 3.9.20, and 3.8.20) Emits audit events.

PYTHONUNBUFFERED

此变量如果被设为一个非空字符串，它就相当于指定 -u 选项。

PYTHONVERBOSE

此变量如果被设为一个非空字符串，它就相当于指定 -v 选项。 如果设为一个整数，则它就相当于多次指定 -v。

PYTHONCASEOK

如果设置了此变量，Python 将忽略 import 语句中的大小写。 这仅在 Windows 和 macOS 上有效。

PYTHONDONTWRITEBYTECODE

此变量如果被设为一个非空字符串，Python 将不会尝试在导入源模块时写入 .pyc 文件。 这相当于指定 -B 选项。

PYTHONPYCACHEPREFIX

如果设置了此选项，Python将在镜像目录树中的此路径中写入 .pyc 文件，而不是源树中的 __pycache__ 目录中。这相当于指定 -X pycache_prefix=PATH 选项。

3.8 新版功能.

PYTHONHASHSEED

如果此变量未设置或设为 random，将使用一个随机值作为 str 和 bytes 对象哈希运算的种子。

如果 PYTHONHASHSEED 被设为一个整数值，它将被作为固定的种子数用来生成哈希随机化所涵盖的类型的 hash() 结果。

它的目的是允许可复现的哈希运算，例如用于解释器本身的自我检测，或允许一组 python 进程共享哈希值。

该整数必须为一个 [0,4294967295] 范围内的十进制数。 指定数值 0 将禁用哈希随机化。

3.2.3 新版功能.

PYTHONINTMAXSTRDIGITS

如果将此变量设为一个整数，它会被用来配置解释器的全局 整数字符串转换长度限制。

3.10.7 新版功能.

PYTHONIOENCODING

如果此变量在运行解释器之前被设置，它会覆盖通过 encodingname:errorhandler 语法设置的 stdin/stdout/stderr 所用编码。 encodingname 和 :errorhandler 部分都是可选项，与在 str.encode() 中的含义相同。

对于 stderr，:errorhandler 部分会被忽略；处理程序将总是为 'backslashreplace'。

在 3.4 版更改: “encodingname” 部分现在是可选的。

在 3.6 版更改: 在 Windows 上，对于交互式控制台缓冲区会忽略此变量所指定的编码，除非还指定了 PYTHONLEGACYWINDOWSSTDIO。 通过标准流重定向的文件和管道则不受其影响。

PYTHONNOUSERSITE

如果设置了此变量，Python 将不会把 用户 site-packages 目录 添加到 sys.path。

参见

PEP 370 [https://www.python.org/dev/peps/pep-0370] -- 分用户的 site-packages 目录

PYTHONUSERBASE

定义 用户基准目录，它会在执行 python setup.py install --user 时被用来计算 用户 site-packages 目录 的路径以及 Distutils 安装路径。

参见

PEP 370 [https://www.python.org/dev/peps/pep-0370] -- 分用户的 site-packages 目录

PYTHONEXECUTABLE

如果设置了此环境变量，则 sys.argv[0] 将被设为此变量的值而不是通过 C 运行时所获得的值。 这仅在 macOS 上起作用。

PYTHONWARNINGS

此变量等价于 -W 选项。 如果被设为一个以逗号分隔的字符串，它就相当于多次指定 -W，列表中后出现的过滤器优先级会高于列表中先出现的。

最简单的设置是将某个特定操作无条件地应用于进程所发出所有警告 (即使是在默认情况下会忽略的那些警告):

PYTHONWARNINGS=default  # Warn once per call location
PYTHONWARNINGS=error    # Convert to exceptions
PYTHONWARNINGS=always   # Warn every time
PYTHONWARNINGS=module   # Warn once per calling module
PYTHONWARNINGS=once     # Warn once per Python process
PYTHONWARNINGS=ignore   # Never warn

请参阅 警告过滤器 和 警告过滤器的介绍 了解更多细节。

PYTHONFAULTHANDLER

如果此环境变量被设为一个非空字符串，faulthandler.enable() 会在启动时被调用：为 SIGSEGV, SIGFPE, SIGABRT, SIGBUS 和 SIGILL 等信号安装一个处理器以转储 Python 回溯信息。 此变量等价于 -X faulthandler 选项。

3.3 新版功能.

PYTHONTRACEMALLOC

如果此环境变量被设为一个非空字符串，则会使用 tracemalloc 模块启动对 Python 内存分配的跟踪。 该变量的值是保存于跟踪的回溯信息中的最大帧数。 例如，PYTHONTRACEMALLOC=1 只保存最近的帧。 请参阅 tracemalloc.start() 了解详情。

3.4 新版功能.

PYTHONPROFILEIMPORTTIME

如果此变量被设为一个非空字符串，Python 将显示每次导入花费了多长时间。 此变量完全等价于在命令行为设置 -X importtime。

3.7 新版功能.

PYTHONASYNCIODEBUG

如果此变量被设为一个非空字符串，则会启用 asyncio 模块的 调试模式。

3.4 新版功能.

PYTHONMALLOC

设置 Python 内存分配器和/或安装调试钩子。

设置 Python 所使用的内存分配器族群：

default: 使用 默认内存分配器。

malloc: 对所有域 (PYMEM_DOMAIN_RAW, PYMEM_DOMAIN_MEM, PYMEM_DOMAIN_OBJ) 使用 C 库的 malloc() 函数。

pymalloc: 对 PYMEM_DOMAIN_MEM 和 PYMEM_DOMAIN_OBJ 域使用 pymalloc 分配器 而对 PYMEM_DOMAIN_RAW 域使用 malloc() 函数。

安装 调试钩子 ：

debug: 在 默认内存分配器 之上安装调试钩子。

malloc_debug: 与 malloc 相同但还会安装调试钩子。

pymalloc_debug: 与 pymalloc 相同但还会安装调试钩子。

在 3.7 版更改: 增加了 "default" 分配器。

3.6 新版功能.

PYTHONMALLOCSTATS

如果设为一个非空字符串，Python 将在每次创建新的 pymalloc 对象区域以及在关闭时打印 pymalloc 内存分配器 的统计信息。

如果 PYTHONMALLOC 环境变量被用来强制开启 C 库的 malloc() 分配器，或者如果 Python 的配置不支持 pymalloc，则此变量将被忽略。

在 3.6 版更改: 此变量现在也可以被用于在发布模式下编译的 Python。 如果它被设置为一个空字符串则将没有任何效果。

PYTHONLEGACYWINDOWSFSENCODING

如果设为非空字符串，默认的 filesystem encoding and error handler 模式将恢复到 3.6 版本之前的值 “mbcs”和“replace”。 否则，将采用新的默认值“utf-8”和“surrogatepass”。

这也可以在运行时通过 sys._enablelegacywindowsfsencoding() 来启用。

可用性: Windows。

3.6 新版功能: 更多详情请参阅 PEP 529 [https://www.python.org/dev/peps/pep-0529]。

PYTHONLEGACYWINDOWSSTDIO

如果设为一个非空字符串，则不使用新的控制台读取器和写入器。 这意味着 Unicode 字符将根据活动控制台的代码页进行编码，而不是使用 utf-8。

如果标准流被重定向（到文件或管道）而不是指向控制台缓冲区则该变量会被忽略。

可用性: Windows。

3.6 新版功能.

PYTHONCOERCECLOCALE

如果值设为 0，将导致主 Python 命令行应用跳过将传统的基于 ASCII 的 C 与 POSIX 区域设置强制转换为更强大的基于 UTF-8 的替代方案。

如果此变量 未被 设置（或被设为 0 以外的值），则覆盖环境变量的 LC_ALL 区域选项也不会被设置，并且报告给 LC_CTYPE 类别的当前区域选项或者为默认的 C 区域，或者为显式指明的基于 ASCII 的 POSIX 区域，然后 Python CLI 将在加载解释器运行时之前尝试为 LC_CTYPE 类别按指定的顺序配置下列区域选项：

C.UTF-8

C.utf8

UTF-8

如果成功设置了以上区域类别中的一个，则初始化 Python 运行时之前也将在当前进程环境中相应地设置 LC_CTYPE 环境变量。 这会确保除了解释器本身和运行于同一进程中的其他可感知区域选项的组件 (例如 GNU readline 库) 之外，还能在子进程 (无论这些进程是否在运行 Python 解释器) 以及在查询环境而非当前 C 区域的操作 (例如 Python 自己的 locale.getdefaultlocale()) 中看到更新的设置。

(显式地或通过上述的隐式区域强制转换) 配置其中一个区域选项将自动为 sys.stdin 和 sys.stdout 启用 surrogateescape 错误处理器 (sys.stderr 会继续使用 backslashreplace 如同在任何其他区域选项中一样)。 这种流处理行为可以按通常方式使用 PYTHONIOENCODING 来覆盖。

出于调试目的，如果激活了区域强制转换，或者如果当 Python 运行时被初始化时某个 应该 触发强制转换的区域选项仍处于激活状态则设置 PYTHONCOERCECLOCALE=warn 将导致 Python 在 stderr 上发出警告消息。

还要注意，即使在区域转换转换被禁用，或者在其无法找到合适的目标区域时，默认 PYTHONUTF8 仍将在传统的基于 ASCII 的区域中被激活。 必须同时禁用这两项特性以强制解释器使用 ASCII 而不是 UTF-8 作为系统接口。

可用性: *nix。

3.7 新版功能: 请参阅 PEP 538 [https://www.python.org/dev/peps/pep-0538] 了解详情。

PYTHONDEVMODE

如果将此环境变量设为非空字符串，则启用 Python 开发模式，引入在默认情况下启用会导致开销过大的运行时检查。

3.7 新版功能.

PYTHONUTF8

如果设为 1 ，将会启用 Python UTF-8 模式。

若设为 0 ，则会禁用 Python UTF-8 模式 。

设置任何其他非空字符串会在解释器初始化期间导致错误。

3.7 新版功能.

PYTHONWARNDEFAULTENCODING

如果该环境变量设为一个非空字符串，则在采用某地区默认编码时，将会引发一条 EncodingWarning 。

请参阅 选择性的 EncodingWarning 来了解详情。

3.10 新版功能.

1.2.1. 调试模式变量

PYTHONTHREADDEBUG

若设置此变量，Python 将会把线程调试信息打印到 stdout。

需要 Python 的调试版本。

Deprecated since version 3.10, will be removed in version 3.12.

PYTHONDUMPREFS

如果设置，Python 将在关闭解释器后转储仍存活的对象和引用计数。

需用 --with-trace-refs 编译选项来配置 Python。

2. 在类Unix环境下使用Python

2.1. 获得并安装Python的最新版本

2.1.1. 在Linux中

Python预装在大多数Linux发行版上，并作为一个包提供给所有其他用户。 但是，您可能想要使用的某些功能在发行版提供的软件包中不可用。这时您可以从源代码轻松编译最新版本的Python。

如果Python没有预先安装并且不在发行版提供的库中，您可以轻松地为自己使用的发行版创建包。 参阅以下链接：

参见

https://www.debian.org/doc/manuals/maint-guide/first.en.html

对于Debian用户

https://en.opensuse.org/Portal:Packaging

对于OpenSuse用户

https://docs-old.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch-creating-rpms.html

对于Fedora用户

http://www.slackbook.org/html/package-management-making-packages.html

对于Slackware用户

2.1.2. 在FreeBSD和OpenBSD上

FreeBSD用户，使用以下命令添加包:

pkg install python3

OpenBSD用户，使用以下命令添加包:

pkg_add -r python

pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/<insert your architecture here>/python-<version>.tgz

例如：i386用户获取Python 2.5.1的可用版本:

pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz

2.1.3. 在OpenSolaris系统上

你可以从 OpenCSW [https://www.opencsw.org/] 获取、安装及使用各种版本的Python。比如 pkgutil -i python27 。

2.2. 构建Python

如果你想自己编译 CPython，首先要做的是获取 源代码 [https://www.python.org/downloads/source/]。 你可以下载最新发布版的 source 或是直接抓取最新的 clone [https://devguide.python.org/setup/#get-the-source-code]。 （如果你想要贡献补丁，那么你就必须先 clone。）

构建过程由常用命令组成：

./configure
make
make install

特定 Unix 平台的 配置选项 和注意事项通常会详细地记录在 Python 源代码树的根目录下的 README.rst [https://github.com/python/cpython/tree/3.10/README.rst] 文件中。

警告

make install 可以覆盖或伪装 python3 二进制文件。因此，建议使用 make altinstall 而不是 make install ，因为后者只安装了 exec_prefix/bin/pythonversion 。

2.3. 与Python相关的路径和文件

这些取决于本机安装惯例的不同；prefix 和 exec_prefix 依赖于具体安装并且应当被解读为针对 GNU 软件；它们可能具有相同的含义。

例如，在大多数Linux系统上，两者的默认值是 /usr 。

文件/目录 | 含意
exec_prefix/bin/python3 | 解释器的推荐位置
prefix/lib/pythonversion, exec_prefix/lib/pythonversion | 包含标准模块的目录的推荐位置
prefix/include/pythonversion, exec_prefix/include/pythonversion | 包含开发Python扩展和嵌入解释器所需的include文件的目录的推荐位置

2.4. 杂项

要在Unix上使用Python脚本，需要添加可执行权限，例如：

$ chmod +x script

并在脚本的顶部放置一个合适的Shebang线。一个很好的选择通常是:

#!/usr/bin/env python3

将在整个 PATH 中搜索Python解释器。但是，某些Unix系统可能没有 env 命令，因此可能需要将 /usr/bin/python3 硬编码为解释器路径。

要在Python脚本中使用shell命令，请查看 subprocess 模块。

2.5. 自定义 OpenSSL

要使用发行商的 OpenSSL 配置和系统信任存储库，请找到包含 openssl.cnf 文件或符号链接的目录，它位于 /etc 中。 在大多数发行版上该文件是在 /etc/ssl 或者 /etc/pki/tls 中。 该目录还应当包含一个 cert.pem 文件和/或一个 certs 目录。

$ find /etc/ -name openssl.cnf -printf "%h\n"
/etc/ssl

下载、编译并安装 OpenSSL。 请确保你使用 install_sw 而不是 install。 install_sw 的目标不会覆盖 openssl.cnf。

$ 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

使用自定义的 OpenSSL 编译 Python （参考配置 --with-openssl 和 --with-openssl-rpath 选项）

$ 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

注解

OpenSSL 的补丁发布版具有向下兼容的 ABI。 你不需要重新编译 Python 来更新 OpenSSL。 使用一个新的版本来替代自定义 OpenSSL 安装版就可以了。

3. 配置 Python

3.1. 配置选项

用以下方式列出 ./configure 脚本的所有选项:

./configure --help

参阅 Python 源代码中的 Misc/SpecialBuilds.txt 。

3.1.1. 通用选项

--enable-loadable-sqlite-extensions

支持 _sqlite 扩展模块中的可加载扩展（默认为否）。

参见 sqlite3.Connection.enable_load_extension() 方法的 sqlite3 模块。

3.6 新版功能.

--disable-ipv6

禁用 IPv6 支持（若开启支持则默认启用），见 socket 模块。

--enable-big-digits=[15|30]

定义 Python int 数字的比特大小：15或30比特

默认情况下，比特数取决于 sizeof(void*)。如果 void* 大小为 64 位以上，则比特数为 30 位，否则为 15 位。

定义 PYLONG_BITS_IN_DIGIT 为 15 或 30。

参见 sys.int_info.bits_per_digit 。

--with-cxx-main

--with-cxx-main=COMPILER

编译 Python main() 函数，用 C++ 编译器链接 Python 可执行文件： $CXX` 或 COMPILER。

--with-suffix=SUFFIX

将 Python 的可执行文件后缀设置为 SUFFIX。

在 Windows 和 macOS 上的默认后缀为 .exe``（ ``python.exe 为可执行文件），在其他平台上为空字符串（ python 可执行）。

--with-tzpath=<list of absolute paths separated by pathsep>

为 zoneinfo.TZPATH 选择默认的时区搜索路径。 参见 zoneinfo 模块的 编译时配置。

默认：/usr/share/zoneinfo:/usr/lib/zoneinfo:/usr/share/lib/zoneinfo:/etc/zoneinfo

参阅 os.pathsep 路径分隔符。

3.9 新版功能.

--without-decimal-contextvar

编译 _decimal 扩展模块时使用线程本地上下文，而不是协程本地上下文（默认），参见 decimal 模块。

参见 decimal.HAVE_CONTEXTVAR 和 contextvars 模块。

3.9 新版功能.

--with-dbmliborder=db1:db2:...

覆盖 dbm 模块的 db 后端检查顺序。

合法值是用冒号（:）分隔的字符串，包含后端名称。

ndbm ；

gdbm ；

bdb 。

--without-c-locale-coercion

禁用 C 语言对 UTF-8 的强制要求（默认为启用）。

不定义 PY_COERCE_C_LOCALE 宏。

参阅 PYTHONCOERCECLOCALE 和 PEP 538 [https://www.python.org/dev/peps/pep-0538]。

--with-platlibdir=DIRNAME

Python 库目录名（默认为 lib）。

Fedora 和 SuSE 在64 位平台用 lib64 。

参阅 sys.platlibdir 。

3.9 新版功能.

--with-wheel-pkg-dir=PATH

ensurepip 模块用到的 wheel 包目录（默认为无）。

某些 Linux 发行版的打包策略建议不要捆绑依赖关系。如 Fedora 在 /usr/share/python-wheels/ 目录下安装 wheel 包，而不安装 ensurepip._bundled 包。

3.10 新版功能.

3.1.2. 安装时的选项

--prefix=PREFIX

在 PREFIX 中安装架构无关的文件。 在 Unix 上，它默认为 /usr/local。

该值可使用 sys.prefix 在运行时获取。

作为示例，用户可以使用 --prefix="$HOME/.local/" 在其家目录中安装 Python。

--exec-prefix=EPREFIX

在 EPREFIX 中安装架构无关的文件，默认为 --prefix。

该值可使用 sys.exec_prefix 在运行时获取。

--disable-test-modules

不编译和安装 test 模块，如 test 包或 _testcapi 扩展模块（默认会编译并安装）。

3.10 新版功能.

--with-ensurepip=[upgrade|install|no]

选择 Python 安装时运行的 ensurepip 命令。

upgrade （默认）：运行 python -m ensurepip --altinstall --upgrade 命令。

install ：运行 python -m ensurepip --altinstall 命令。

no ：不运行 ensurepip。

3.6 新版功能.

3.1.3. 性能选项

建议用 --enable-optimizations --with-lto （PGO + LTO）配置 Python，以便实现最佳性能。

--enable-optimizations

用 PROFILE_TASK 启用以配置文件主导的优化（PGO）（默认为禁用）。

C 编译器 Clang 需要用到 llvm-profdata 程序进行 PGO。在 macOS 上，GCC 也需要用到它：在 macOS 上 GCC 只是 Clang 的别名而已。

如果使用 --enable-shared 和 GCC ，还可以禁用 libpython 中的语义插值：在编译器和链接器的标志中加入 -fno-semantic-interposition 。

3.6 新版功能.

在 3.10 版更改: 在 GCC 上使用 -fno-semantic-interposition 。

PROFILE_TASK

Makefile 用到的环境变量：PGO 用到的 Python 命令行参数。

默认为：-m test --pgo --timeout=$(TESTTIMEOUT) 。

3.8 新版功能.

--with-lto

在编译过程中启用链接时间优化（LTO）（默认为禁用）。

LTO 时 C 编译器 Clang 需要用到 llvm-ar 参数（在 macOS 则为 ar），以及支持 LTO 的链接器（ld.gold 或 lld）。

3.6 新版功能.

--with-computed-gotos

在求值环节启用 goto 计数（在支持的编译器上默认启用）。

--without-pymalloc

禁用特定的 Python 内存分配器 pymalloc （默认为启用）。

参见环境变量 PYTHONMALLOC 。

--without-doc-strings

禁用静态文档字符串以减少内存占用（默认启用）。Python 中定义的文档字符串不受影响。

不定义 PY_COERCE_C_LOCALE 宏。

参阅宏 PyDoc_STRVAR() 。

--enable-profiling

用 gprof 启用 C 语言级的代码评估（默认为禁用）。

3.1.4. Python 调试级编译

调试版本 Python 是指带有 --with-pydebug  参数的编译。

调试版本的效果：

默认显示所有警告：在 warnings 模块中，默认警告过滤器的列表是空的。

在 sys.abiflags 中加入 d 标记。

加入 sys.gettotalrefcount() 函数。

命令行参数加入 -X showrefcount 。

环境变量加入 PYTHONTHREADDEBUG 。

加入对 __ltrace__ 变量的支持：如果定义了该变量，在计算字节码环节启用底层跟踪。

安装 内存分配调试钩子 ，以便检测缓冲区溢出和其他内存错误。

定义宏 Py_DEBUG 和 Py_REF_DEBUG 。

加入运行时检查：针对 #ifdef Py_DEBUG 和 #endif 包裹的代码。启用 assert(...) 和 _PyObject_ASSERT(...) 断言：不设置 NDEBUG 宏（参阅 --with-assertions  参数）。主要的运行检查包括：

增加了对函数参数的合理性检查。

创建 Unicode 和 int 对象时，内存按某种模式进行了填充，用于检测是否使用了未初始化的对象。

确保有能力清除或替换当前异常的函数在调用时不会引发异常。

垃圾收集器（gc.collect() 函数）对对象的一致性进行一些基本检查。

从较宽类型转换到较窄类型时，Py_SAFE_DOWNCAST() 宏会检查整数下溢和上溢的情况。

参见 Python 开发模式 和配置参数 --with-trace-refs 。

在 3.8 版更改: 发布版和调试版的编译现在是 ABI 兼容的：定义了 Py_DEBUG 宏不再意味着同时定义了 Py_TRACE_REFS 宏（参见 --with-trace-refs 参数），这引入了唯一一处不是 ABI 兼容的地方。

3.1.5. 调试选项

--with-pydebug

在调试模式下编译 Python: 定义宏 Py_DEBUG (默认为禁用)。

--with-trace-refs

为了调试而启用引用的跟踪（默认为禁用）。

效果如下：

定义 Py_TRACE_REFS 宏。

加入 sys.getobjects() 函数。

环境变量加入 PYTHONDUMPREFS 。

此版本与发布模式（默认编译模式）或调试模式（Py_DEBUG 和 Py_REF_DEBUG 宏）不具备 ABI 兼容性。

3.8 新版功能.

--with-assertions

编译时启用 C 断言：assert(...); 和 _PyObject_ASSERT(...); （默认不启用）。

如果设置此参数，则在 OPT 编译器变量中不定义 NDEBUG 宏。

参阅 --with-pydebug 选项（调试编译模式），它也可以启用断言。

3.6 新版功能.

--with-valgrind

启用 Valgrind （默认禁用）。

--with-dtrace

启用 DTrace（默认禁用）。

参阅 用 DTrace 和 SystemTap 测试 CPython。

3.6 新版功能.

--with-address-sanitizer

启用 AddressSanitizer 内存错误检测 asan，（默认为禁用）。

3.6 新版功能.

--with-memory-sanitizer

启用 MemorySanitizer 内存错误检测 msan，（默认为禁用）。

3.6 新版功能.

--with-undefined-behavior-sanitizer

启用 undefinedBehaviorSanitizer 未定义行为检测 ubsan，（默认为禁用）。

3.6 新版功能.

3.1.6. 链接器选项

--enable-shared

启用共享 Python 库 libpython 的编译（默认为禁用）。

--without-static-libpython

不编译 libpythonMAJOR.MINOR.a，也不安装 python.o (默认会编译并安装)。

3.10 新版功能.

3.1.7. 库选项

--with-libs='lib1 ...'

链接附加库（默认不会）。

--with-system-expat

用已安装的 expat 库编译 pyexpat 模块（默认为否）。

--with-system-ffi

用已安装的 ffi 库编译 _ctypes 扩展模块，参见 ctypes 模块（默认情况视系统而定）。

--with-system-libmpdec

用已安装的 mpdec 库编译 _decimal 扩展模块，参见 decimal 模块（默认为否）。

3.3 新版功能.

--with-readline=editline

用 editline 库作为 readline 模块的后端。

定义 WITH_EDITLINE 宏。

3.10 新版功能.

--without-readline

不编译 readline 模块（默认会）。

不定义 HAVE_LIBREADLINE 宏。

3.10 新版功能.

--with-tcltk-includes='-I...'

覆盖 Tcl 和 Tk 包含文件的搜索路径。

--with-tcltk-libs='-L...'

覆盖 Tcl 和 Tk 库的搜索路径。

--with-libm=STRING

将 libm 数学库覆盖为 STRING (默认情况视系统而定)。

--with-libc=STRING

将 libc C 库覆盖为 STRING (默认情况视系统而定)。

--with-openssl=DIR

OpenSSL 的根目录。

3.7 新版功能.

--with-openssl-rpath=[no|auto|DIR]

设置 OpenSSL 库的运行时库目录（rpath）。

no (默认): 不设置 rpath。

auto：根据 --with-openssl 和 pkg-config 自动检测 rpath。

DIR ：直接设置 rpath。

3.10 新版功能.

3.1.8. 安全性选项

--with-hash-algorithm=[fnv|siphash24]

选择 Python/pyhash.c 采用的哈希算法。

siphash24 (默认)。

fnv。

3.4 新版功能.

--with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2

内置哈希模块：

md5。

sha1。

sha256。

sha512。

sha3 (带 shake)。

blake2。

3.9 新版功能.

--with-ssl-default-suites=[python|openssl|STRING]

覆盖 OpenSSL 默认的密码套件字符串。

python (默认值): 采用 Python 推荐选择。

openssl：保留 OpenSSL 默认值不动。

STRING ：采用自定义字符串。

参见 ssl  模块。

3.7 新版功能.

在 3.10 版更改: 设置 python 和 STRING 也会把 TLS 1.2 设为最低版本的协议。

3.1.9. macOS 选项

参见 Mac/README.rst 。

--enable-universalsdk

--enable-universalsdk=SDKDIR

创建通用的二进制版本。SDKDIR 指定应采用的 macOS SDK （默认为否）。

--enable-framework

--enable-framework=INSTALLDIR

创建 Python.framework ，而不是传统的 Unix 安装版。可选参数 INSTALLDIR 指定了安装路径（(默认为否）。

--with-universal-archs=ARCH

指定应创建何种通用二进制文件。该选项仅当设置了 --enable-universalsdk 时才有效。

可选项：

universal2。

32-bit。

64-bit。

3-way。

intel。

intel-32。

intel-64。

all。

--with-framework-name=FRAMEWORK

为 macOS 中的 python 框架指定名称，仅当设置了 --enable-framework 时有效（默认：Python）。

3.2. Python 构建系统

3.2.1. 构建系统的主要文件

configure.ac => configure;

Makefile.pre.in => Makefile (由 configure 创建);

pyconfig.h (由 configure 创建);

Modules/Setup: 由Makefile 使用 Module/makesetup shell 脚本构建的 C 扩展;

setup.py: 使用 distutils 模块构建的 C 扩展。

3.2.2. 主要构建步骤

C文件（ .c ）是作为对象文件（ .o ）构建的。

一个静态库 libpython （ .a ）是由对象文件创建的。

python.o 和静态库 libpython 被链接到最终程序 python 中。

C 扩展由 Makefile （参见 Modules/Setup ） 和 python setup.py build 构建。

3.2.3. 主要 Makefile 目标

make ：用标准库构建Python。

make platform: ：构建 python 程序，但不构建标准库扩展模块。

make profile-opt ：使用 Profile Guided Optimization (PGO) 构建 Python 。你可以使用 configure 的 --enable-optimizations 选项来使其成为 make 命令的默认目标（ make all 或只是 make ）。

make buildbottest ：构建 Python 并运行 Python 测试套件，与 buildbots 测试 Python 的方式相同。设置变量 TESTTIMEOUT （单位：秒）来改变测试超时时间（默认为 1200 即 20 分钟）。

make install：构建并安装 Python 。

make regen-all ：重新生成（几乎）所有生成的文件； make regen-stdlib-module-names 和 autoconf 必须对其余生成的文件单独运行。

make clean ：移除构建的文件。

make distclean ：与 make clean 相同，但也删除由配置脚本创建的文件。

3.2.4. C 扩展

一些 C 扩展是作为内置模块构建的，比如模块 sys 。它们是在定义了宏 Py_BUILD_CORE_BUILTIN 的情况下构建的。内置模块没有 __file__ 属性:

>>> 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__'

其他的 C 扩展是作为动态库构建的，就像 _asyncio 模块一样。 它们是在定义了 Py_BUILD_CORE_MODULE 宏的情况下构建的。 在 Linux x86-64 上的例子:

>>> 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'

Modules/Setup 用于生成 Makefile 目标，以构建 C 扩展。在文件的开头， C 被构建为内置模块。在标记 *shared* 之后定义的扩展被构建为动态库。

setup.py 脚本只使用 distutils 模块将 C 构建为共享库。

宏 PyAPI_FUNC() ， PyAPI_API() 和 PyMODINIT_FUNC() 在 Include/pyport.h 中的定义不同，取决于是否定义宏 Py_BUILD_CORE_MODULE 。

如果 Py_BUILD_CORE_MODULE 定义了，使用 Py_EXPORTED_SYMBOL 。

否则使用 Py_IMPORTED_SYMBOL 。

如果宏 Py_BUILD_CORE_BUILTIN 被错误地用在作为共享库构建的 C 扩展上，它的函数 PyInit_xxx() 就不会被导出，导致导入时出现 ImportError 。

3.3. 编译器和链接器的标志

脚本 ./configure 和环境变量设置的选项，并被 Makefile 使用。

3.3.1. 预处理器的标志

CONFIGURE_CPPFLAGS

变量 CPPFLAGS 的值被传递给 ./configure 脚本。

3.6 新版功能.

CPPFLAGS

（ Objective ） C/C++ 预处理器标志，例如，使用 -I<include dir> 如果你的头文件在一个非标准的目录 <include dir> 中 、

CPPFLAGS 和 LDFLAGS 都需要包含shell的值，以便 setup.py 能够使用环境变量中指定的目录构建扩展模块。

BASECPPFLAGS

3.4 新版功能.

PY_CPPFLAGS

为构建解释器对象文件增加了额外的预处理器标志。

默认为： $(BASECPPFLAGS) -I. -I$(srcdir)/Include $(CONFIGURE_CPPFLAGS) $(CPPFLAGS) 。

3.2 新版功能.

3.3.2. 编译器标志

CC

C 编译器指令。

例如： gcc -pthread 。

MAINCC

C编译器命令用于构建像 python 这样的程序的 main() 函数。

由配置脚本的 --with-cxx-main 选项设置的变量。

默认为： $(CC) 。

CXX

C++ 编译器指令。

如果使用了 --with-cxx-main 选项，则使用。

例如： g++ -pthread 。

CFLAGS

C 编译器标志。

CFLAGS_NODIST

CFLAGS_NODIST 用于构建解释器和 stdlib C 扩展。当 Python 安装后，编译器标志 不 应该成为 distutils CFLAGS 的一部分时，可以使用它 （ bpo-21121 [https://bugs.python.org/issue?@action=redirect&bpo=21121] ）。

特别地，CFLAGS 不应当包含:

编译器旗标 -I (用于为包括文件设置搜索路径)。 -I 旗标将按从左到右的顺序处理，并且 CFLAGS 中的任何旗标都将优先于 user- 和 package- 层级所提供的 -I 旗标。

加固旗标如 -Werror 因为分发版无法控制由用户安装的包是否符合这样的高标准。

3.5 新版功能.

EXTRA_CFLAGS

而外的 C 编译器指令。

CONFIGURE_CFLAGS

变量 CFLAGS 的值传递给 ./configure 脚本。

3.2 新版功能.

CONFIGURE_CFLAGS_NODIST

变量 CFLAGS_NODIST 的值传递给 ./configure 脚本。

3.5 新版功能.

BASECFLAGS

基础编译器标志。

OPT

优化标志。

CFLAGS_ALIASING

严格或不严格的别名标志，用于编译 Python/dtoa.c 、

3.7 新版功能.

CCSHARED

用于构建共享库的编译器标志。

例如， -fPIC 在 Linux 和 BSD 上使用。

CFLAGSFORSHARED

为构建解释器对象文件增加了额外的 C 标志。

，默认为： $(CCSHARED) ，当 --enable-shared 被使用时，则为空字符串

PY_CFLAGS

默认为： $(BASECFLAGS) $(OPT) $(CONFIGURE_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS) 。

PY_CFLAGS_NODIST

默认为： $(CONFIGURE_CFLAGS_NODIST) $(CFLAGS_NODIST) -I$(srcdir)/Include/internal 。

3.5 新版功能.

PY_STDMODULE_CFLAGS

用于构建解释器对象文件的 C 标志。

默认为： $(PY_CFLAGS) $(PY_CFLAGS_NODIST) $(PY_CPPFLAGS) $(CFLAGSFORSHARED)。

3.7 新版功能.

PY_CORE_CFLAGS

默认为 $(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE 。

3.2 新版功能.

PY_BUILTIN_MODULE_CFLAGS

编译器标志，将标准库的扩展模块作为内置模块来构建，如 posix 模块

默认为： $(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE_BUILTIN 。

3.8 新版功能.

PURIFY

Purify 命令。 Purify 是一个内存调试程序。

默认为：空字符串（不使用）。

3.3.3. 链接器标志位

LINKCC

用于构建如 python 和 _testembed 的程序的链接器命令。

默认为： $(PURIFY) $(MAINCC) 。

CONFIGURE_LDFLAGS

变量 LDFLAGS 的值被传递给 ./configure 脚本。

避免指定 CFLAGS ， LDFLAGS 等，这样用户就可以在命令行上使用它们来追加这些值，而不用触碰到预设的值。

3.2 新版功能.

LDFLAGS_NODIST

LDFLAGS_NODIST 的使用方式与 CFLAGS_NODIST 相同。当 Python 安装后，链接器标志 不 应该成为 distutils LDFLAGS 的一部分时，可以使用它（ bpo-35257 [https://bugs.python.org/issue?@action=redirect&bpo=35257] ）。

特别地，LDFLAGS 不应当包含:

编译器旗标 -L (用于为库设置搜索路径)。 -L 旗标将按从左到右的顺序处理，并且 LDFLAGS 中的任何旗标都将优先于 user- 和 package 层级所提供的 -L 旗标。

CONFIGURE_LDFLAGS_NODIST

变量 LDFLAGS_NODIST 的值传递给 ./configure 脚本。

3.8 新版功能.

LDFLAGS

链接器标志，例如，如果你的库在一个非标准的目录 <lib dir> 中，则使用 -L<lib dir> 。

CPPFLAGS 和 LDFLAGS 都需要包含shell的值，以便 setup.py 能够使用环境变量中指定的目录构建扩展模块。

LIBS

链接器标志，在链接 Python 可执行文件时将库传递给链接器。

例如： -lrt 。

LDSHARED

构建一个共享库的命令。

默认为： @LDSHARED@ $(PY_LDFLAGS) 。

BLDSHARED

构建共享库 libpython 的命令。

默认为： @BLDSHARED@ $(PY_CORE_LDFLAGS) 。

PY_LDFLAGS

默认为： $(CONFIGURE_LDFLAGS) $(LDFLAGS) 。

PY_LDFLAGS_NODIST

默认为： $(CONFIGURE_LDFLAGS_NODIST) $(LDFLAGS_NODIST) 。

3.8 新版功能.

PY_CORE_LDFLAGS

用于构建解释器对象文件的链接器标志。

3.8 新版功能.

4. 在Windows上使用 Python

本文档旨在概述在 Microsoft Windows 上使用 Python 时应了解的特定于 Windows 的行为。

与大多数UNIX系统和服务不同，Windows系统没有预安装Python。多年来CPython 团队已经编译了每一个 发行版 [https://www.python.org/download/releases/] 的Windows安装程序（MSI 包），已便Windows 用户下载和安装。这些安装程序主要用于每个用户单独安装Python时，添加核心解释器和库。安装程序还可以为一台机器的所有用户安装，并且可以为应用程序本地分发提供单独的zip文件。

如 PEP 11 [https://www.python.org/dev/peps/pep-0011] 所述，Python 发布版对某个 Windows 平台的支持仅限于被 Microsoft 视为处于延长支持周期内的版本。 这意味着 Python 3.10 支持 Windows 8.1 及其后的版本。 如果你需要 Windows 7 支持，请安装 Python 3.8。

Windows提供了许多不同的安装程序，每个安装程序都有一定的优点和缺点。

完整安装程序 内含所有组件，对于使用Python 进行任何类型项目的开发人员而言，它是最佳选择。

Microsoft Store包 是一个适用于运行脚本和包，并使用 IDLE 或其他开发环境的简易 Python 安装版。 它需要 Windows 10 或更新的系统，但可以安全地安装而不会破坏其他程序。 它还提供了许多便捷命令用来启动 Python 及其工具。

nuget.org 安装包 是用于持续集成系统的轻量级安装。它可用于构建Python包或运行脚本，但不可更新且没有用户界面工具。

可嵌入的包 是Python的最小安装包，适合嵌入到更大的应用程序中。

4.1. 完整安装程序

4.1.1. 安装步骤

四个 Python 3.10 安装程序可供下载 - 32位和64位版本的各有两个。 web installer （网络安装包）是一个小的初始化工具，它将在安装过程中，根据需要自动下载所需的组件。 offline installer （离线安装包）内含默认安装所需的组件，可选择功能仍需要Internet连接下载。请参阅 免下载安装 以了解在安装过程中避免下载的其他方法。

启动安装程序后，可以选择以下两个选项之一：

如果选择“Install Now（立即安装）”：

您 不 需要成为管理员（除非需要对C运行库进行系统更新，或者为所有用户安装 适用于Windows的Python启动器 ）

Python将安装到您的用户目录中

适用于Windows的Python启动器 将根据第一页底部的选项安装

将安装标准库，测试套件，启动器和pip

如果选择将安装目录将添加到 PATH

快捷方式仅对当前用户可见

选择“自定义安装”将允许您选择：要安装的功能、安装位置、其他选项或安装后的操作。如果要安装调试符号或二进制文件，您需要使用此选项。

如要为全部用户安装，应选择“自定义安装”。在这种情况下:

您可能需要提供管理凭据或批准

Python 将安装到Program Files目录中

适用于Windows的Python启动器 将安装到Windows目录中

安装期间可以选择可选功能

标准库可以预编译为字节码

如果选中，安装目录将添加到系统 PATH

快捷方式所有用户可用

4.1.2. 删除 MAX_PATH 限制

历史上Windows的路径长度限制为260个字符。这意味着长于此的路径将无法解决并导致错误。

在最新版本的 Windows 中，此限制可被扩展到大约 32,000 个字符。 但需要让管理员激活“启用 Win32 长路径”组策略，或在注册表键 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem 中设置 LongPathsEnabled 为 1。

这允许 open() 函数，os 模块和大多数其他路径功能接受并返回长度超过 260 个字符的路径。

更改上述选项后，无需进一步配置。

在 3.6 版更改: Python中启用了对长路径的支持。

4.1.3. 无UI 安装

安装程序UI中的所有选项也可以从命令行指定，允许脚本安装程序在许多机器上复制安装，而无需用户交互。还可以在不禁用UI的情况下设置这些选项，以更改一些默认值。

要完全隐藏安装程序UI并静默安装Python，请使用 /quiet 选项。要跳过用户交互但仍然显示进度和错误，请使用 /passive 选项。可以通过 /uninstall 选项立即开始删除Python - - 不会显示任何确认提示。

所有其他选项都传递为 name=value ，其中值通常是 0 来禁用某个特性， 1 来启用某个特性或路径。可用选项的完整列表如下所示。

名称 | 描述 | 默认值
InstallAllUsers | 为所有用户安装。 | 0
TargetDir | 安装目录 | 基于InstallAllUsers选择
DefaultAllUsersTargetDir | 为所有用户安装时的默认安装路径 | %ProgramFiles%\Python X.Y 或 %ProgramFiles(x86)%\Python X.Y
DefaultJustForMeTargetDir | 仅为当前用户安装时的默认安装路径 | %LocalAppData%\Programs\Python\PythonXY 或 %LocalAppData%\Programs\Python\PythonXY-32 或 %LocalAppData%\Programs\Python\PythonXY-64
DefaultCustomTargetDir | UI中显示的默认自定义安装目录 | （空）
AssociateFiles | 如果还安装了启动器，则创建文件关联。 | 1
CompileAll | 将所有 .py 文件编译为 .pyc 。 | 0
PrependPath | 将install和Scripts目录添加到 PATH 以及将 .PY 添加到 PATHEXT | 0
Shortcuts | 如果已安装，为解释器，文档和IDLE创建快捷方式 | 1
Include_doc | 安装Python手册 | 1
Include_debug | 安装调试二进制文件 | 0
Include_dev | 安装开发者头文件和库文件。 省略这一步可能导致安装不可用。 | 1
Include_exe | 安装 python.exe 以及相关文件。忽略此项可能会导致安装不可用。 | 1
Include_launcher | 安装 适用于Windows的Python启动器 . | 1
InstallLauncherAllUsers | 为所有用户安装启动器。还需要 Include_launcher 被设定为1 | 1
Include_lib | 安装标准库和扩展模块。 省略这一步可能导致安装不可用。 | 1
Include_pip | 安装捆绑的pip和setuptools | 1
Include_symbols | 安装调试符号集 (*.pdb) | 0
Include_tcltk | 安装Tcl/Tk 支持和IDLE | 1
Include_test | 安装标准库测试套件 | 1
Include_tools | 安装实用程序脚本 | 1
LauncherOnly | 仅安装启动器。这将覆盖大多数其他选项。 | 0
SimpleInstall | 禁用大多数安装UI | 0
SimpleInstallDescription | 使用简化安装UI时显示的自定义消息。 | （空）

例如，要以静默方式全局安装默认的Python，您可以（在命令提示符>）使用以下命令:

python-3.9.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0

要允许用户在没有测试套件的情况下轻松安装Python的个人副本，可以使用以下命令提供快捷方式。这将显示一个简化的初始页面，不允许自定义:

python-3.9.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0
    SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."

（请注意，省略启动器也会省略文件关联，并且仅在全局安装包含启动器时才建议用于每用户安装。）

上面列出的选项也可以在一个名为 unattend.xml 的文件中与可执行文件一起提供。此文件指定选项和值的列表。作为属性提供的值，（如果可能）它将转换为数字。作为文本提供的值，始终保留为字符串。此示例文件设置与上一示例采用相同的选项：

<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>

4.1.4. 免下载安装

由于下载的初始安装包中未包含Python的某些可选功能，如果选择安装这些功能可能需要Internet连接。为了避免这种需要，可以按需下载所有可能的组件，以创建一个完整的布局，该布局将不再需要internet连接，而不管所选择的特性是什么。请注意，此下载可能比要求的要大，但是如果要执行大量安装，则拥有本地缓存​​的副本非常有用。

从命令提示符执行以下命令以下载所有可能的必需文件。 请记得要将 python-3.9.0.exe 替换为安装程序的实际名称，并在单独的目录中创建子目录以避免同名文件间的冲突。

python-3.9.0.exe /layout [optional target directory]

您也可以指定 /quiet 选项来隐藏进度显示。

4.1.5. 修改安装

安装Python后，您可以通过Windows中的“程序和功能”工具添加或删除功能。选择Python条目并选择“卸载/更改”以在维护模式下打开安装程序。

“修改” 允许您通过修改复选框来添加或删除功能 - 未更改的复选框将不会安装或删除任何内容。在此模式下无法更改某些选项，例如安装目录；要修改这些，您需要完全删除然后重新安装Python。

“修复” 将使用当前设置验证应安装的所有文件，并替换已删除或修改的任何文件

“卸载” 将完全删除Python，但 适用于Windows的Python启动器 除外，它在“程序和功能”中有自己的条目。

4.2. Microsoft Store包

3.7.2 新版功能.

Microsoft Store 包是一个易于安装的 Python 解释器，主要针对在交互模式下使用，例如用于教学。

要安装此软件包，请确保您拥有最新的Windows 10更新，并在Microsoft Store应用程序中搜索 "Python 3.10" 。确保您选择的应用程序由 Python Software Foundation 发布并安装。

警告

Python将始终在Microsoft Store上免费提供。如果要求您付款，则表示您没有选择正确的包。

安装完成后，可以在开始菜单中找到它来启动 Python。或者可以在命令提示符或 PowerShell 会话中输入 python 来启动。此外可以输入 pip 或 idle 来使用 pip 和 IDLE。IDLE 也在开始菜单中。

所有这三个命令也可以使用版本号后缀，例如， python3.exe 和 python3.x.exe 以及 python.exe （其中 3.x 是您要启动的特定版本，例如 3.10 ）。在 设置-->主页-->应用和功能 页面中，点选 管理可选功能 ，选择与每个命令关联的python版本。建议确保 pip 和 idle 与选择的 python 版本一致。

可以使用 python -m venv 创建虚拟环境并激活并正常使用。

如果你已经安装了另一个版本的Python并将它添加到你的 PATH 变量中，那么它将作为 python.exe 而不是来自Microsoft Store的那个。要访问新安装，请使用 python3.exe 或 python3.x.exe 。

py.exe 启动器将检测此 Python 安装版，但会优先使用来自传统安装器的安装版。

要删除Python，请打开“设置”并使用“应用程序和功能”，或者在“开始”中找到Python，然后右键单击以选择“卸载”。卸载将删除该已安装Python程序中的所有软件包，但不会删除任何虚拟环境

4.2.1. 已知的问题

4.2.1.1. 本地数据、注册表项和临时路径的重定向

由于 Microsoft Store 应用程序的限制，Python 脚本可能无法对共享位置如 TEMP 和注册表进行完全写入访问。 相反同，它将写入到一个私有副本。 如果你的脚本必须修改共享位置，则需要安装完整的安装器。

在运行时，Python 将使用知名 Windows 文件夹和注册表项的一个私有副本。 例如，如果环境变量 %APPDATA% 为 c:\Users\<user>\AppData\，则当写入 C:\Users\<user>\AppData\Local 时将会写入到 C:\Users\<user>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\LocalCache\Local\。

当读取文件时，Windows 将返回来自私有文件夹的文件，或者如果文件不存在，则返回来自知名 Windows 目录的文件。 例如读取 C:\Windows\System32 将返回 C:\Windows\System32 的内容加上 C:\Program Files\WindowsApps\package_name\VFS\SystemX86 的内容。

你可以使用 os.path.realpath() 找到任何现有文件的真实路径:

>>> import os
>>> test_file = 'C:\\Users\\example\\AppData\\Local\\test.txt'
>>> os.path.realpath(test_file)
'C:\\Users\\example\\AppData\\Local\\Packages\\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\\LocalCache\\Local\\test.txt'

当写入到 Windows 注册表时，会存在以下行为:

从 HKLM\\Software 读取是被允许的并且其结果将与包中的 registry.dat 文件合并。

当相应的键/值存在时向 HKLM\\Software 写入，即修改现有键的值是不被允许的。

当包中相应的键/值不存在并且用户具有正确的访问权限时向 HKLM\\Software 写入是被允许的。

有关此限制的技术原理的更多细节，请查询 Microsoft 已打包完全可信应用的文档，当前位于 docs.microsoft.com/en-us/windows/msix/desktop/desktop-to-uwp-behind-the-scenes [https://docs.microsoft.com/en-us/windows/msix/desktop/desktop-to-uwp-behind-the-scenes]

4.3. nuget.org 安装包

3.5.2 新版功能.

nuget.org 是一个精简的 Python 环境，用于在没有全局安装 Python 的系统的持续集成和构建。 虽然 nuget 是“.NET的包管理器”，但是对于包含构建时工具的包来说，它也可以很好地工作。

访问 nuget.org [https://www.nuget.org/] 获取有关使用 nuget 的最新信息。 下面的摘要对 Python 开发人员来说已经足够了。

nuget.exe 命令行工具可以直接从 https://aka.ms/nugetclidl 下载，例如，使用 curl 或 PowerShell。 使用该工具安装 64 位或 32 位最新版本的 Python:

nuget.exe install python -ExcludeVersion -OutputDirectory .
nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .

要选择特定版本，请添加 -Version 3.x.y 。 输出目录可以从 . 更改，包将安装到子目录中。 默认情况下，子目录的名称与包的名称相同，如果没有 -ExcludeVersion 选项，则此名称将包含已安装的特定版本。 子目录里面是一个包含 Python 安装的 tools 目录：

# 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

通常，nuget 包不可升级，应该平行安装较新版本并使用完整路径引用。 或者，手动删除程序包目录并再次安装。 如果在构建之间不保留文件，许多 CI 系统将自动执行此操作。

除了 tools 目录外，还有一个 build\native 目录。 它包含一个 MSBuild 属性文件 python.props，可以在 C++ 项目中使用该文件来引用 Python 安装。 包含这些设置将自动在生成中使用标头和导入库。

nuget.org上的包信息页是 www.nuget.org/packages/python [https://www.nuget.org/packages/python] 对于64位版本和 www.nuget.org/packages/pythonx86 [https://www.nuget.org/packages/pythonx86] 表示32位版本。

4.4. 可嵌入的包

3.5 新版功能.

嵌入式发行版是一个包含最小 Python 环境的 ZIP 文件。 它旨在作为另一个应用程序的一部分，而不是由最终用户直接访问。

解压缩后，嵌入式发行版（几乎）与用户系统完全隔离，包括环境变量、系统注册表设置和已安装的软件包。标准库作为预先编译和优化的 .pyc 文件包含在ZIP中，并提供了 python3.dll ， python37.dll ， python.exe 和 pythonw.exe 文件。不包括Tcl/tk（包括所有依赖项，如Idle），pip和Python文档。

注解

嵌入式发行版不包括 Microsoft C 运行时 [https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#visual-studio-2015-2017-2019-and-2022]，应用程序安装程序负责提供此功能。 运行时可能已经预先安装在用户的系统上或通过 Windows Update 自动安装，并且可以通过在系统目录中找到 ucrtbase.dll 来检测。

第三方软件包应该由应用程序与嵌入式发行版一起安装。这个发行版不支持像常规 Python 安装那样使用 pip 来管理依赖关系，不过可以小心地将 pip 包含进来并使用它进行自动更新。 通常，第三方包应该作为应用程序的一部分(“打包”)处理，以便开发人员在向用户提供更新之前能够确保与新版本兼容。

下面描述了这个发行版的两个推荐用例。

4.4.1. Python 应用程序

用 Python 编写的应用程序并不一定要求用户了解这一事实。 在这种情况下，可以使用嵌入式发行版在安装包中包含 Python 的私有版本。 根据它应该有多透明（或者相反，它应该看起来有多专业），有两个选项。

使用专门的可执行文件作为启动程序需要一些编码，但为用户提供了最透明的体验。使用定制的启动器，没有明显的迹象表明程序是在 Python 上运行的：图标可以定制，公司和版本信息可以指定，文件关联可以正常运行。在大多数情况下，自定义启动程序应该只需使用硬编码的命令行就能调用 Py_Main。

更简单的方法是提供批处理文件或生成的快捷方式，使用所需的命令行参数直接调用 python.exe 或 pythonw.exe。在这种情况下，应用程序将显示为 Python 而不是其实际名称，并且用户可能无法将其与其他正在运行的 Python 进程或文件关联区分开来。

对于后一种方法，包应该与 Python 可执行文件一起作为目录安装，以确保它们在路径上可用。 使用专用的启动器，包可以位于其他位置，因为在启动应用程序之前有机会指定搜索路径。

4.4.2. 嵌入Python

用本地代码编写的应用程序通常需要某种形式的脚本语言，嵌入式Python发行版可以用于此目的。通常，应用程序的大部分都是本机代码，某些部分将调用 python.exe 或直接使用 python3.dll 。无论是哪种情况，将嵌入的发行版解压缩到应用程序安装的子目录中就足以提供可加载的Python解释器。

与应用程序使用一样，包可以安装到任何位置，因为在初始化解释器之前有机会指定搜索路径。否则，使用嵌入式发行版和常规安装之间没有根本区别。

4.5. 替代捆绑包

除了标准的CPython发行版之外，还有一些包含附加功能的修改包。以下是热门版本及其主要功能的列表：

ActivePython [https://www.activestate.com/activepython/]

具有多平台兼容性的安装程序，文档，PyWin32

Anaconda [https://www.anaconda.com/download/]

流行的科学模块（如numpy，scipy和pandas）和 conda 包管理器。

Enthought 部署管理器 [https://www.enthought.com/edm/]

“下一代的 Python 环境和包管理器”

之前 Enthought 提供了 Canopy，但已经 于 2016 年结束生命期 [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]。

WinPython [https://winpython.github.io/]

特定于Windows的发行版，包含用于构建包的预构建科学包和工具。

请注意，这些软件包可能不包含最新版本的Python或其他库，并且不由核心Python团队维护或支持。

4.6. 配置Python

要从命令提示符方便地运行Python，您可以考虑在Windows中更改一些默认环境变量。虽然安装程序提供了为您配置PATH和PATHEXT变量的选项，但这仅适用于单版本、全局安装。如果您经常使用多个版本的Python，请考虑使用 适用于Windows的Python启动器 。

4.6.1. 附录：设置环境变量

Windows允许在用户级别和系统级别永久配置环境变量，或临时在命令提示符中配置环境变量。

要临时设置环境变量，请打开命令提示符并使用 set 命令：

C:\>set PATH=C:\Program Files\Python 3.9;%PATH%
C:\>set PYTHONPATH=%PYTHONPATH%;C:\My_python_lib
C:\>python

这些环境变量的更改将应用​​于在该控制台中执行的任何其他命令，并且，由该控制台启动的任何应用程序都继承设这些设置。

在百分号中包含的变量名将被现有值替换，允许在开始或结束时添加新值。通过将包含 python.exe 的目录添加到开头来修改 PATH 是确保启动正确版本的Python的常用方法。

要永久修改默认环境变量，请单击“开始”并搜索“编辑环境变量”，或打开系统属性的 高级系统设置 ，然后单击 环境变量 按钮。在此对话框中，您可以添加或修改用户和系统变量。要更改系统变量，您需要对计算机进行无限制访问（即管理员权限）。

注解

Windows会将用户变量串联在系统变量 之后 ，这可能会在修改 PATH 时导致意外结果。

PYTHONPATH 变量被 Python 的所有版本使用，因此除非它列出的路径只包含与所有已安装的 Python 版本兼容的代码，否则不要永久配置此变量。

参见

https://docs.microsoft.com/en-us/windows/win32/procthread/environment-variables

Windows 中的环境变量概述

https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1

用于临时修改环境变量的 set 命令

https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/setx

用于永久修改环境变量的 setx 命令

4.6.2. 查找Python可执行文件

在 3.5 版更改.

除了使用自动创建的Python解释器的开始菜单项之外，您可能还想在命令提示符下启动Python。安装程序有一个选项可以为您设置。

在安装程序的第一页上，可以选择标记为“将Python添加到环境变量”的选项，以使安装程序将安装位置添加到 PATH 。还添加了 Scripts\ 文件夹的位置。这允许你输入 python 来运行解释器，并且 pip 用于包安装程序。因此，您还可以使用命令行选项执行脚本，请参阅 命令行 文档。

如果在安装时未启用此选项，则始终可以重新运行安装程序，选择“修改”并启用它。或者，您可以使用 附录：设置环境变量 的方法手动修改 PATH 。您需要将Python安装目录添加到 PATH 环境变量中，该内容与其他条目用分号分隔。示例变量可能如下所示（假设前两个条目已经存在）:

C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.9

4.7. UTF-8 模式

3.7 新版功能.

Windows 仍然使用传统编码格式作为系统的编码格式（ANSI 代码页）。 Python 使用它作为文本文件默认的编码格式 (即 locale.getpreferredencoding())。

这可能会造成问题，因为因特网和大多数 Unix 系统包括 WSL (Windows Subsystem for Linux) 广泛使用 UTF-8。

你可以使用 Python UTF-8 模式 将默认的文本编码格式改为 UTF-8。 要启用 Python UTF-8 模式 可以通过 -X utf8 命令行选项，或者 PYTHONUTF8=1 环境变量。 请参阅 PYTHONUTF8 了解如何启用 UTF-8 模式，并参阅 附录：设置环境变量 了解如何修改环境变量。

当 Python UTF-8 模式 启用时，你仍然可以通过 "mbcs" 编解码器使用系统编码格式（ANSI 代码页）。

请注意添加 PYTHONUTF8=1 到默认环境变量将会影响你的系统中的所有 Python 3.7+ 应用。 如果你有任何 Python 3.7+ 应用仍然依赖于传统的系统编码格式，则推荐设置临时环境变量或使用 -X utf8 命令行选项。

注解

即使在不启用 UTF-8 模式时，Windows 版的 Python 也会在以下情况中默认使用 UTF-8：

控制台 I/O 包括标准 I/O (详情见 PEP 528 [https://www.python.org/dev/peps/pep-0528])。

文件系统编码格式 (参见 PEP 529 [https://www.python.org/dev/peps/pep-0529] 了解详情)。

4.8. 适用于Windows的Python启动器

3.3 新版功能.

用于Windows的Python启动器是一个实用程序，可帮助定位和执行不同的Python版本。它允许脚本（或命令行）指示特定Python版本的首选项，并将定位并执行该版本。

与 PATH 变量不同，启动器将正确选择最合适的Python版本。它更倾向于按用户安装而不是系统安装，并按语言版本排序，而不是使用最新安装的版本。

启动器最初是在 PEP 397 [https://www.python.org/dev/peps/pep-0397] 中指定的。

4.8.1. 入门

4.8.1.1. 从命令行

在 3.6 版更改.

全局安装Python 3.3及更高版本将把启动器放在你的 PATH 上。启动程序与所有可用的Python版本兼容，因此安装哪个版本无关紧要。要检查启动程序是否可用，请在命令提示符中执行以下命令：

py

您应该会发现已安装的最新版本的Python已启动 - 它可以正常退出，并且将指定的任何其他命令行参数直接发送到Python。

如果您安装了多个版本的Python（例如，3.7和 3.10 ），您会注意到Python 3.10 启动 - 如果要启动 Python 3.7，尝试命令：

py -3.7

如果您想使用已安装的 Python 2 的最新版本，请尝试以下命令：

py -2

你会发现 Python 3.x 的最新版本已启动。

如果您看到以下错误，则表明您没有安装启动器：

'py' is not recognized as an internal or external command,
operable program or batch file.

除非在安装时选择了该选项，单个用户安装的Python不会将启动程序添加到 PATH 。

Tix 命令：

py --list

显示当前已安装的Python版本。

4.8.1.2. 从虚拟环境

3.5 新版功能.

如果启动程序运行时没有明确的Python版本，并且虚拟环境（使用标准库创建 venv 模块或外部 virtualenv 工具）处于活动状态，则启动程序将运行虚拟环境的解释器而不是全局的。要运行全局解释器，请停用虚拟环境，或显式指定全局Python版本。

4.8.1.3. 从脚本

让我们创建一个测试Python脚本 - 创建一个名为 hello.py 的文件，其中包含以下内容

#! python
import sys
sys.stdout.write("hello from Python %s\n" % (sys.version,))

从hello.py所在的目录中，执行以下命令：

py hello.py

您应该注意到最新的Python 2.x安装的版本号已打印出来。现在尝试将第一行更改为：

#! python3

现在重新执行该命令将打印最新的 Python 3.x 信息。 如上面的命令行示例一样，你可以更明确地指定版本限定符。 假设你已安装了 Python 3.7，请尝试将第一行改为 #! python3.7 那么你应当看到打印出了 3.7 的版本信息。

请注意，与交互式使用不同，裸“python”将使用您已安装的Python 2.x的最新版本。这是为了向后兼容及兼容Unix，其中命令 python 通常是指Python 2。

4.8.1.4. 从文件关联

安装时应该将启动器与Python文件（即 .py, .pyw, .pyc 文件）相关联。这意味着当您从Windows资源管理器中双击其中一个文件时，将使用启动程序，因此您可以使用上述相同的工具让脚本指定应使用的版本。

这样做的主要好处是，单个启动程序可以同时支持多个Python版本，具体取决于第一行的内容。

4.8.2. Shebang 行

如果脚本文件的第一行以 #! 开头，则称为 "shebang" 行。Linux和其他类Unix操作系统都有对这些行的本机支持，它们通常在此类系统上用来指示应该如何执行脚本。这个启动器允许在Windows上对Python脚本使用相同的工具，上面的示例演示了它们的使用。

为了允许Python脚本中的shebang行在Unix和Windows之间移植，该启动器支持许多“虚拟”命令来指定要使用的解释器。支持的虚拟命令是：

/usr/bin/env python

/usr/bin/python

/usr/local/bin/python

python

例如，如果脚本开始的第一行为

#! /usr/bin/python

将找到并使用默认的Python。因为在Unix上编写的许多Python脚本已经有了这一行，你应该发现这些脚本可以由启动器使用而无需修改。如果您在Windows上编写一个新脚本，希望在Unix上有用，那么您应该使用以 /usr 开头的一个shebang行。

任何上述虚拟命令都可以显式指定版本（可以仅为主要版本，也可以为主要版本加次要版本）作为后缀。 此外，可以通过在次要版本之后添加 “-32” 来请求 32 位版本。 例如 /usr/bin/python3.7-32 将请求使用 32 位 python 3.7。

3.7 新版功能: 从 python 启动器 3.7 开始，可以通过 "-64" 后缀调用 64 位版本。 此外还可以指定一个主版本号加架构而不带次版本号 (即 /usr/bin/python3-64)。

shebang line的 /usr/bin/env 形式还有一个特殊属性。在寻找已安装的Python解释器之前，此表单将搜索可执行文件 PATH 以获取Python可执行文件。这对应于Unix中 env 程序的行为，该程序将在 PATH 执行搜索。

4.8.3. shebang 行的参数

shebang 行还可以指定要传递给Python解释器的其他选项。 举例来说，如果你有这样的 shebang 行：

#! /usr/bin/python -v

那么 Python 将以 -v 选项启动

4.8.4. 自定义

4.8.4.1. 通过INI文件自定义

启动程序将搜索两个.ini文件 - 在当前用户的 "application data" 目录中搜索 py.ini （即通过使用 CSIDL_LOCAL_APPDATA 调用Windows函数 SHGetFolderPath 返回的目录）以及与启动器位于同一目录中的 py.ini 。相同的.ini文件既用于启动器的“控制台”版本（即 py.exe），也用于“windows”版本（即pyw.exe）

“应用程序目录”中指定的自定义优先于可执行文件旁边.ini文件的自定义，因此对启动程序旁边的.ini文件不具有写访问权限的用户可以覆盖该全局.ini文件中的命令。

4.8.4.2. 自定义默认的Python版本

在某些情况下，可以在命令中包含版本限定符，以指定命令将使用哪个Python版本。版本限定符以主版本号开头，可以选择后跟 ('.') 和次版本说明符。此外，可以通过添加 "-32" 或 “-64” 来指定是请求32位还是64位实现。

例如，一个shebang 行的 #!python 行没有版本限定符，而 #!python3 有一个版本限定符，它只指定一个主版本。

如果在命令中找不到版本限定符，则可以设置环境变量 PY_PYTHON 以指定默认版本限定符。 如果未设置，则默认为 "3"。 该变量可以指定能通过命令行传递的任何值，比如 "3", "3.7", "3.7-32" 或 "3.7-64"。 （请注意 "-64" 选项仅适用于 Python 3.7 或更高版本中包含的启动器。）

如果没有找到次版本限定符，则可以设置环境变量 PY_PYTHON{major} （其中 {major} 是上面确定的当前主要版本限定符）以指定完整版本。如果没有找到这样的选项，启动器将枚举已安装的Python版本并使用为主要版本找到的最新次要版本，尽管不能保证，但该版本可能是该系列中最新安装的版本。

在安装了相同（major.minor）Python版本的32位和64位的64位Windows上，64位版本将始终是首选。对于启动程序的32位和64位实现都是如此 -- 这对于启动程序32位和64位都是正确的 -- 如果可用，32位启动程序将倾向于执行指定版本的64位Python安装。这样就可以预测启动器的行为，只知道PC上安装了哪些版本，而不考虑它们的安装顺序（即，不知道32位或64位版本的Python和相应的启动器是否是最后安装）。如上所述，可以在版本说明符上使用可选的“-32”或“-64”后缀来更改此行为。

示例：

如果没有设置相关选项，命令 python 和 python2 将使用安装的最新Python 2.x版本，命令 python3 将使用最新安装的Python 3.x.

命令 python3.7 根本不会查阅任何选项，因为版本已完全指定。

如果 PY_PYTHON=3 ，命令 python 和 python3 都将使用最新安装的Python 3版本。

如果 PY_PYTHON=3.7-32 ，命令 python 将使用3.7的32位实现，而命令 python3 将使用最新安装的Python（PY_PYTHON根本没有被视为指定了主要版本。）

如果 PY_PYTHON=3 且 PY_PYTHON3=3.7 ，命令 python 和 python3 都将特别使用3.7

除环境变量外，还可以在启动程序使用的.INI文件中配置相同的设置。 INI文件中的部分称为 [defaults] ，键名称将与没有前导 PY_ 前缀的环境变量相同（并注意INI文件中的键名不区分大小写） 。）环境变量的内容将覆盖INI文件中指定的内容。

例如:

设置 PY_PYTHON=3.7 等同于包含以下内容的INI文件：

[defaults]
python=3.7

设置 PY_PYTHON=3 和 PY_PYTHON3=3.7 相当于包含以下内容的INI文件：

[defaults]
python=3
python3=3.7

4.8.5. 诊断

如果设置了环境变量 PYLAUNCH_DEBUG （任何值），启动器将诊断信息打印到stderr（即：控制台）。虽然这些信息同时具有冗长 和 简洁性，但它应该允许您查看Python的版本、选择特定版本的原因以及用于执行目标Python的确切命令行。

4.9. 查找模块

Python通常将其库（以及您的site-packages文件夹）存储在安装目录中。因此，如果您已将Python安装到 C:\Python\ ，则默认库将驻留在 C:\Python\Lib\ 中，第三方模块存储在 C:\Python\Lib\site-packages\ 。

若要完全覆盖 sys.path ，请创建与DLL(python37._pth)或可执行文件(“python._pth`”)同名的 ._pth 文件，并为要添加的每个路径指定一行 sys.path 。基于DLL名称的文件覆盖基于可执行文件的文件，如果需要，可以为加载运行时的任何程序限制路径。

当文件存在时，将忽略所有注册表和环境变量，启用隔离模式，并且：除非文件中的一行指定 import site ，否则不会导入 site 。以 ＃ 开头的空白路径和行将被忽略。每个路径可以是绝对的或相对于文件的位置。不允许使用除 site 以外的导入语句，并且不能指定任意代码。

请注意，当指定 import site 时， .pth 文件（没有前导下划线）将由 site 模块正常处理。

当找不到 ._pth 文件时， sys.path 是如何在Windows上填充的：

在开始时，添加一个空条目，该条目对应于当前目录。

如果环境变量 PYTHONPATH 存在，如 环境变量 中所述，则接下来添加其条目。请注意，在Windows上，此变量中的路径必须用分号分隔，以区别于驱动器标识符中使用的冒号（ C:\ 等）。

额外的 "应用程序路径" 可以作为子键被同时添加到注册表 HKEY_CURRENT_USER 和 HKEY_LOCAL_MACHINE 分支下的 \SOFTWARE\Python\PythonCore{version}\PythonPath 中。 以分号分隔的路径字符串作为默认值的子键将导致每个路径都被添加到 sys.path 中。 （请注意所有已知的安装程序都只使用 HKLM，因此 HKCU 通常为空。）

如果设置了环境变量 PYTHONHOME ，则将其假定为 “Python 主目录” 。否则，主Python可执行文件的路径用于定位 “landmark 文件” （ Lib\os.py 或 pythonXY.zip ）以推断 ”Python 主目录“ 。如果找到了Python主目录，则基于该文件夹将相关的子目录添加到 sys.path （Lib , plat-win 等）。否则，核心Python路径是从存储在注册表中的PythonPath构造的。

如果找不到Python Home，也没有指定 PYTHONPATH 环境变量，并且找不到注册表项，则使用具有相对条目的默认路径（例如 .\Lib; .\plat-win 等等）。

如果在主可执行文件旁边或在可执行文件上一级的目录中找到 pyvenv.cfg 文件，则以下变体适用：

如果 home 是一个绝对路径，并且 PYTHONHOME 未设置，则在推断起始位置时使用此路径而不是主可执行文件的路径。

这一切的最终结果是：

运行 python.exe ，或主Python目录中的任何其他.exe（安装版本，或直接来自PCbuild目录）时，推导出核心路径，并忽略注册表中的核心路径。始终读取注册表中的其他“应用程序路径”。

当Python托管在另一个.exe（不同的目录，通过COM嵌入等）时，将不会推断出“Python Home”，因此使用了来自注册表的核心路径。始终读取注册表中的其他“应用程序路径”。

如果Python找不到它的主目录并且没有注册表值（冻结的.exe，一些非常奇怪的安装设置），那么你会得到一条带有一些默认但相对的路径的路径。

对于那些想要将Python捆绑到其应用程序或发行版中的人，以下建议将防止与其他安装冲突：

在您的可执行文件中包含一个 ._pth 文件，其中包含目录。这将忽略注册表和环境变量中列出的路径，并忽略 site ，除非列出 import site 。

如果你在自己的可执行文件中加载 python3.dll 或 python37.dll ，在 Py_Initialize() 之前，要显式调用 Py_SetPath() 或（至少） Py_SetProgramName()

清除 和/或 覆盖 PYTHONPATH 并在启动来自应用程序的 python.exe 之前设置 PYTHONHOME 。

如果您不能使用前面的建议（例如，您是一个允许人们直接运行 python.exe 的分发版），请确保安装目录中存在 landmark 文件 (Lib\os.py)。 （请注意，在 ZIP 文件中不会检测到该文件，但会检测到正确命名的 ZIP 文件。）

这些将确保系统范围安装中的文件不会优先于与应用程序捆绑在一起的标准库的副本。否则，用户可能会在使用您的应用程序时遇到问题请注意，第一个建议是最好的，因为其他建议可能仍然容易受到注册表和用户站点包中的非标准路径的影响。

在 3.6 版更改:

添加 ._pth 文件支持并从 pyvenv.cfg 中删除 applocal 选项

当直接与可执行文件相邻时，添加 pythonXX.zip 作为潜在的 landmark 。

3.6 版后已移除:

在 Modules （不是 PythonPath ）下的注册表中指定的模块可以通过以下方式导入 importlib.machinery.WindowsRegistryFinder 。在Windows上，此查找程序在3.6.0及更早版本的可用，但可能需要在将来显式添加到 sys.meta_path

4.10. 附加模块

尽管Python的目标是在所有平台中都可移植，但是Windows有一些独特的特性。在标准库和外部都有一些模块和代码片段在使用这些特性。

特定于Windows的标准模块记录在 Windows系统相关模块 中。

4.10.1. PyWin32

Mark Hammond 的 PyWin32 [https://pypi.org/project/pywin32] 模块是一组用于高级Windows特定支持的模块。这包括以下实用程序：

组件对象模型 [https://docs.microsoft.com/en-us/windows/win32/com/component-object-model--com--portal] (COM)

Win32 API 调用

注册

事件日志

Microsoft Foundation Classes [https://docs.microsoft.com/en-us/cpp/mfc/mfc-desktop-applications] (MFC) 用户界面

PythonWin [https://web.archive.org/web/20060524042422/https://www.python.org/windows/pythonwin/] 是PyWin32附带的一个示例MFC应用程序。它是一个内置调试器的可嵌入IDE。

参见

Win32 How Do I...? [http://timgolden.me.uk/python/win32_how_do_i.html]

Tim Golden 著

Python and COM [https://www.boddie.org.uk/python/COM.html]

David 和 Paul Boddie 著

4.10.2. cx_Freeze

cx_Freeze [https://cx-freeze.readthedocs.io/en/latest/] 是一个 distutils 的扩展 (参见 扩展 Distutils)，它将 Python 脚本包装成可执行的 Windows 程序 (*.exe 文件)。 完成此操作后，你就可以分发你的应用程序而无需用户安装 Python。

4.11. 在Windows上编译Python

如果你想要自己编译 CPython，首先要做的是获取 源代码 [https://www.python.org/downloads/source/]。 你可以下载最新发行版的源代码或是执行最新的 签出 [https://devguide.python.org/setup/#get-the-source-code]。

源代码树包含Microsoft Visual Studio的构建解决方案和项目文件，它是用于构建官方Python版本的编译器。这些文件位于 PCbuild 目录中。

检查 PCbuild/readme.txt 以获取有关构建过程的一般信息。

有关扩展模块，请参阅 在 Windows 上构建 C 和 C++ 扩展 。

4.12. 其他平台

随着Python的不断发展，不再支持以前曾经支持的一些平台（由于缺少用户或开发人员）。检查 PEP 11 [https://www.python.org/dev/peps/pep-0011] 了解所有不支持的平台的详细信息。

Windows CE [https://pythonce.sourceforge.net/] 自 Python 3 起 不再受支持 [https://github.com/python/cpython/issues/71542] (如果曾经受支持的话)。

Cygwin <https://cygwin.com/>`_安装程序也提供了安装 `Python 解释器 [https://cygwin.com/packages/summary/python3.html] 的功能。

有关具有预编译安装程序平台的详细信息，请参阅 Python for Windows [https://www.python.org/downloads/windows/]

5. 在 Mac 上使用 Python

作者

Bob Savage <bobsavage@mac.com>

在运行 macOS 的 Mac 上的 Python 原则上与在其他 Unix 平台上的 Python 非常相似，但有一些额外的特性，如 IDE 和包管理器，值得指出。

5.1. 获取和安装 MacPython

macOS 曾经在 10.8 至 12.3 [https://developer.apple.com/documentation/macos-release-notes/macos-12_3-release-notes#Python] 版中预装了 Python 2.7。 建议你从 Python 网站 (https://www.python.org) 安装最新版本的 Python 3。 那里也提供了当前 Python 的 "通用二进制" 编译版，它可以在使用新 Intel 和传统 PPC CPU 的 Mac 上原生运行。

你安装后得到的东西有：

会有一个 Python 3.12 文件夹在你的 Applications 文件夹中。 在这里你可以找到 IDLE，它是作为官方 Python 发行版标准组成部分的开发环境；以及 PythonLauncher，它负责处理在 Finder 中双击 Python 脚本的操作。

框架 /Library/Frameworks/Python.framework ，包括 Python 可执行文件和库。安装程序将此位置添加到 shell 路径。 要卸载 MacPython ，你可以简单地移除这三个项目。 Python 可执行文件的符号链接放在 /usr/local/bin/ 中。

Apple 提供的 Python 版本分别安装在 /System/Library/Frameworks/Python.framework 和 /usr/bin/python 中。 你永远不应修改或删除这些内容，因为它们由 Apple 控制并由 Apple 或第三方软件使用。 请记住，如果你选择从 python.org 安装较新的 Python 版本，那么你的计算机上将安装两个不同但都有用的 Python ，因此你的路径和用法与你想要执行的操作一致非常重要。

IDLE 包含一个帮助菜单，允许你访问 Python 文档。 如果您是 Python 的新手，你应该开始阅读该文档中的教程介绍。

如果你熟悉其他 Unix 平台上的 Python ，那么你应该阅读有关从 Unix shell 运行 Python 脚本的部分。

5.1.1. 如何运行 Python 脚本

你在 macOS 上开始使用 Python 的最好方法是通过 IDLE 集成开发环境，参见章节 IDE 以及在IDE运行时使用帮助菜单。

If you want to run Python scripts from the Terminal window command line or from the Finder you first need an editor to create your script. macOS comes with a number of standard Unix command line editors, vim and emacs among them. If you want a more Mac-like editor, BBEdit or TextWrangler from Bare Bones Software (see http://www.barebones.com/products/bbedit/index.html) are good choices, as is TextMate (see https://macromates.com/). Other editors include Gvim (https://macvim-dev.github.io/macvim/) and Aquamacs (http://aquamacs.org/).

要从终端窗口运行脚本，必须确保:file:/usr/local/bin 位于 shell 搜索路径中。

要从 Finder 运行你的脚本，你有两个选择：

把脚本拖拽到 PythonLauncher

选择 PythonLauncher 作为通过 finder Info 窗口打开脚本（或任何 .py 脚本）的默认应用程序，然后双击脚本。 PythonLauncher 有各种首选项来控制脚本的启动方式。 拖拽方式允许你为一次调用更改这些选项，或使用其“首选项”菜单全局更改内容。

5.1.2. 运行有图形界面的脚本

对于旧版本的 Python ，有一个需要注意的 macOS 特殊问题：与 Aqua 窗口管理器通信的程序（换句话说，任何有 GUI 的程序）需要以特殊的方式运行。使用 pythonw 而不是 python 来启动此类脚本。

对于 Python 3.9，你可以使用 python 或者 pythonw。

5.1.3. 配置

macOS 上的 Python 遵循所有标准的 Unix 环境变量，例如 PYTHONPATH ，但是为从 Finder 启动的程序设置这些变量是不标准的，因为 Finder 在启动时不会读取你的 .profile 或 .cshrc 。你需要创建一个文件 ~/.MacOSX/environment.plist 。详情请看苹果的技术文件QA1067。

更多关于在 MacPython 中安装 Python 包的信息，参阅 安装额外的 Python 包 部分。

5.2. IDE

MacPython 附带标准的 IDLE 开发环境。 有关使用 IDLE 的详细介绍，请访问 http://www.hashcollision.org/hkn/python/idle_intro/index.html 。

5.3. 安装额外的 Python 包

有几个方法可以安装额外的 Python 包：

可以通过标准的 Python distutils 模式（ python setup.py install ）安装软件包。

许多包也可以通过 setuptools 扩展或 pip 包装器安装，请参阅 https://pip.pypa.io/ 。

5.4. Mac 上的图形界面编程

使用 Python 在 Mac 上构建 GUI 应用程序有多种选择。

PyObjC 是一个 Python 到 Apple 的 Objective-C/Cocoa 框架的绑定，这是大多数现代 Mac 开发的基础。 有关 PyObjC 的信息，请访问 https://pypi.org/project/pyobjc/。

标准的 Python GUI 工具包是 tkinter ，基于跨平台的 Tk 工具包（ https://www.tcl.tk ）。 Apple 的 OS X 捆绑了 Aqua 原生版本的 Tk ，最新版本可以从 https://www.activestate.com 下载和安装；它也可以从源代码构建。

wxPython 是另一个流行的跨平台 GUI 工具包，可以在 macOS 上原生运行。软件包和文档可从 https://www.wxpython.org 获取。

PyQt 是另一个流行的跨平台 GUI 工具包，可以在 MacOS 上原生运行。更多信息可以在 https://riverbankcomputing.com/software/pyqt/intro 找到。

5.5. 在 Mac 上分发 Python 应用程序

在 Mac 上部署独立 Python 应用程序的标准工具是 py2app 。关于安装和使用 py2app 的更多信息可以在 https://pypi.org/project/py2app/ 找到。

5.6. 其他资源

MacPython 邮件列表是 Mac 上 Python 用户和开发人员的优秀支持资源：

https://www.python.org/community/sigs/current/pythonmac-sig/

另一个有用的资源是 MacPython wiki ：

https://wiki.python.org/moin/MacPython

6. 编辑器和集成开发环境

有很多支持Python编程语言的集成开发环境。大多数编辑器和集成开发环境支持语法高亮，调试工具和 PEP 8 [https://www.python.org/dev/peps/pep-0008] 检查。

请访问 Python Editors [https://wiki.python.org/moin/PythonEditors] 和 Integrated Development Environments [https://wiki.python.org/moin/IntegratedDevelopmentEnvironments] 以获取完整列表。

Python 语言参考手册

本参考手册介绍了 Python 句法与“核心语义”。在力求简明扼要的同时，我们也尽量做到准确、完整。有关内置对象类型、内置函数、模块的语义在 Python 标准库 中介绍。有关本语言的非正式介绍，请参阅 Python 教程 。对于 C 或 C++ 程序员，我们还提供了两个手册：扩展和嵌入 Python 解释器 介绍了如何编写 Python 扩展模块，Python/C API 参考手册 则详细介绍了 C/C++ 的可用接口。

1. 概述

1.1. 其他实现

1.2. 标注

2. 词法分析

2.1. 行结构

2.2. 其他形符

2.3. 标识符和关键字

2.4. 字面值

2.5. 运算符

2.6. 分隔符

3. 数据模型

3.1. 对象、值与类型

3.2. 标准类型层级结构

3.3. 特殊方法名称

3.4. 协程

4. 执行模型

4.1. 程序的结构

4.2. 命名与绑定

4.3. 异常

5. 导入系统

5.1. importlib

5.2. 包

5.3. 搜索

5.4. 加载

5.5. 基于路径的查找器

5.6. 替换标准导入系统

5.7. 包相对导入

5.8. 有关 __main__ 的特殊事项

5.9. 参考文献

6. 表达式

6.1. 算术转换

6.2. 原子

6.3. 原型

6.4. await 表达式

6.5. 幂运算符

6.6. 一元算术和位运算

6.7. 二元算术运算符

6.8. 移位运算

6.9. 二元位运算

6.10. 比较运算

6.11. 布尔运算

6.12. 赋值表达式

6.13. 条件表达式

6.14. lambda 表达式

6.15. 表达式列表

6.16. 求值顺序

6.17. 运算符优先级

7. 简单语句

7.1. 表达式语句

7.2. 赋值语句

7.3. assert 语句

7.4. pass 语句

7.5. del 语句

7.6. return 语句

7.7. yield 语句

7.8. raise 语句

7.9. break 语句

7.10. continue 语句

7.11. import 语句

7.12. global 语句

7.13. nonlocal 语句

8. 复合语句

8.1. if 语句

8.2. while 语句

8.3. for 语句

8.4. try 语句

8.5. with 语句

8.6. match 语句

8.7. 函数定义

8.8. 类定义

8.9. 协程

9. 顶级组件

9.1. 完整的 Python 程序

9.2. 文件输入

9.3. 交互式输入

9.4. 表达式输入

10. 完整的语法规范

1. 概述

本手册仅描述 Python 编程语言，不宜当作教程。

我希望尽可能地保证内容精确无误，但还是选择使用自然词句进行描述，正式的规格定义仅用于句法和词法解析。这样应该能使文档对于普通人来说更易理解，但也可能导致一些歧义。因此，如果你是来自火星并且想凭借这份文档把 Python 重新实现一遍，也许有时需要自行猜测，实际上最终大概会得到一个十分不同的语言。而在另一方面，如果你正在使用 Python 并且想了解有关该语言特定领域的精确规则，你应该能够在这里找到它们。如果你希望查看对该语言更正式的定义，也许你可以花些时间自己写上一份 --- 或者发明一台克隆机器 :-)

在语言参考文档里加入过多的实现细节是很危险的 --- 具体实现可能发生改变，对同一语言的其他实现可能使用不同的方式。而在另一方面，CPython 是得到广泛使用的 Python 实现 (然而其他一些实现的拥护者也在增加)，其中的特殊细节有时也值得一提，特别是当其实现方式导致额外的限制时。因此，你会发现在正文里不时会跳出来一些简短的 "实现注释"。

每种 Python 实现都带有一些内置和标准的模块。相关的文档可参见 Python 标准库 索引。少数内置模块也会在此提及，如果它们同语言描述存在明显的关联。

1.1. 其他实现

虽然官方 Python 实现差不多得到最广泛的欢迎，但也有一些其他实现对特定领域的用户来说更具吸引力。

知名的实现包括:

CPython

这是最早出现并持续维护的 Python 实现，以 C 语言编写。新的语言特性通常在此率先添加。

Jython

以 Java 语言编写的 Python 实现。 此实现可以作为 Java 应用的一个脚本语言，或者可以用来创建需要 Java 类库支持的应用。 想了解更多信息请访问 Jython 网站 [https://www.jython.org/]。

Python for .NET

此实现实际上使用了 CPython 实现，但是属于 .NET 托管应用并且可以引入 .NET 类库。它的创造者是 Brian Lloyd。想了解详情可访问 Python for .NET 主页 [https://pythonnet.github.io/]。

IronPython

另一个 .NET 版 Python 实现，不同于 Python.NET，这是一个生成 IL 的完整 Python 实现，并会将 Python 代码直接编译为 .NET 程序集。 它的创造者就是当初创造 Jython 的 Jim Hugunin。 想了解更多信息，请参看 IronPython 网站 [https://ironpython.net/]。

PyPy

一个完全使用 Python 语言编写的 Python 实现。 它支持多个其他实现所没有的高级特性，例如非栈式支持和实时编译器等。 此项目的目标之一是通过允许方便地修改解释器（因为它是用 Python 编写的）来鼓励对语言本身的试验。 更多信息可在 PyPy 项目主页 [https://pypy.org/] 获取。

以上这些实现都可能在某些方面与此参考文档手册的描述有所差异，或是引入了超出标准 Python 文档范围的特定信息。请参考它们各自的专门文档，以确定你正在使用的这个实现有哪些你需要了解的东西。

1.2. 标注

句法和词法解析的描述采用经过改进的 BNF 语法标注。这包含以下定义样式:

name      ::=  lc_letter (lc_letter | "_")*
lc_letter ::=  "a"..."z"

第一行表示 name 是 lc_letter 之后跟零个或多个 lc_letter 和下划线。而 lc_letter 则是任意单个 'a' 至 'z' 字符。(实际上在本文档中始终采用此规则来定义词法和语法规则的名称。)

每条规则的开头是一个名称 (即该规则所定义的名称) 加上 ::=。 竖线 (|) 被用来分隔可选项，它是此标注中绑定程度最低的操作符。 星号 (*) 表示前一项的零次或多次重复，类似地，加号 (+) 表示一次或多次重复，而由方括号括起的内容 ([ ]) 表示出现零次或一次 (或者说，这部分内容是可选的)。 * 和 + 操作符的绑定是最紧密的，圆括号用于分组。 字符串字面值包含在引号内。 空格的作用仅限于分隔形符。 每条规则通常为一行，有许多个可选项的规则可能会以竖线为界分为多行。

在词法定义中 (如上述示例)，还额外使用了两个约定: 由三个点号分隔的两个字符字面值表示在指定 (闭) 区间范围内的任意单个 ASCII 字符。由尖括号 (<...>) 括起来的内容是对于所定义符号的非正式描述；即可以在必要时用来说明 '控制字符' 的意图。

虽然所用的标注方式几乎相同，但是词法定义和句法定义是存在很大区别的: 词法定义作用于输入源中单独的字符，而句法定义则作用于由词法分析所生成的形符流。在下一章节 ("词法分析") 中使用的 BNF 全部都是词法定义；在之后的章节中使用的则是句法定义。

2. 词法分析

Python 程序由 解析器 读取，输入解析器的是 词法分析器 生成的 形符 流。本章介绍词法分析器怎样把文件拆成形符。

Python 将读取的程序文本转为 Unicode 代码点；编码声明用于指定源文件的编码，默认为 UTF-8，详见 PEP 3120 [https://www.python.org/dev/peps/pep-3120]。源文件不能解码时，触发 SyntaxError。

2.1. 行结构

Python 程序可以拆分为多个 逻辑行。

2.1.1. 逻辑行

NEWLINE 形符表示结束逻辑行。语句不能超出逻辑行的边界，除非句法支持 NEWLINE （例如，复合语句中的多行子语句）。根据显式或隐式 行拼接 规则，一个或多个 物理行 可组成逻辑行。

2.1.2. 物理行

物理行是一序列字符，由行尾序列终止。源文件和字符串可使用任意标准平台行终止序列 - Unix ASCII 字符 LF （换行）、 Windows ASCII 字符序列 CR LF （回车换行）、或老式 Macintosh ASCII 字符 CR （回车）。不管在哪个平台，这些形式均可等价使用。输入结束也可以用作最终物理行的隐式终止符。

嵌入 Python 时，传入 Python API 的源码字符串应使用 C 标准惯例换行符（\n，代表 ASCII 字符 LF， 行终止符）。

2.1.3. 注释

注释以井号 （#） 开头，在物理行末尾截止。注意，井号不是字符串字面值。除非应用隐式行拼接规则，否则，注释代表逻辑行结束。句法不解析注释。

2.1.4. 编码声明

Python 脚本第一或第二行的注释匹配正则表达式 coding[=:]\s*([-\w.]+) 时，该注释会被当作编码声明；这个表达式的第一组指定了源码文件的编码。编码声明必须独占一行，在第二行时，则第一行必须也是注释。编码表达式的形式如下：

# -*- coding: <encoding-name> -*-

这也是 GNU Emacs 认可的形式，此外，还支持如下形式：

# vim:fileencoding=<encoding-name>

这是 Bram Moolenaar 的 VIM 认可的形式。

没有编码声明时，默认编码为 UTF-8。此外，如果文件的首字节为 UTF-8 字节顺序标志（b'\xef\xbb\xbf'），文件编码也声明为 UTF-8（这是 Microsoft 的 notepad 等软件支持的形式）。

如果声明了编码格式，该编码格式的名称必须是 Python 可识别的 (参见 标准编码)。 编码格式会被用于所有的词法分析，包括字符串字面值、注释和标识符等。

2.1.5. 显式拼接行

两个及两个以上的物理行可用反斜杠（\）拼接为一个逻辑行，规则如下：以不在字符串或注释内的反斜杠结尾时，物理行将与下一行拼接成一个逻辑行，并删除反斜杠及其后的换行符。例如：

if 1900 < year < 2100 and 1 <= month <= 12 \
   and 1 <= day <= 31 and 0 <= hour < 24 \
   and 0 <= minute < 60 and 0 <= second < 60:   # Looks like a valid date
        return 1

以反斜杠结尾的行，不能加注释；反斜杠也不能拼接注释。除字符串字面值外，反斜杠不能拼接形符（如，除字符串字面值外，不能用反斜杠把形符切分至两个物理行）。反斜杠只能在代码的字符串字面值里，在其他任何位置都是非法的。

2.1.6. 隐式拼接行

圆括号、方括号、花括号内的表达式可以分成多个物理行，不必使用反斜杠。例如：

month_names = ['Januari', 'Februari', 'Maart',      # These are the
               'April',   'Mei',      'Juni',       # Dutch names
               'Juli',    'Augustus', 'September',  # for the months
               'Oktober', 'November', 'December']   # of the year

隐式行拼接可含注释；后续行的缩进并不重要；还支持空的后续行。隐式拼接行之间没有 NEWLINE 形符。三引号字符串支持隐式拼接行（见下文），但不支持注释。

2.1.7. 空白行

只包含空格符、制表符、换页符、注释的逻辑行会被忽略（即不生成 NEWLINE 形符）。交互模式输入语句时，空白行的处理方式可能因读取 - 求值 - 打印循环（REPL）的具体实现方式而不同。标准交互模式解释器中，完全空白的逻辑行（即连空格或注释都没有）将结束多行复合语句。

2.1.8. 缩进

逻辑行开头的空白符（空格符和制表符）用于计算该行的缩进层级，决定语句组块。

制表符（从左至右）被替换为一至八个空格，缩进空格的总数是八的倍数（与 Unix 的规则保持一致）。首个非空字符前的空格数决定了该行的缩进层次。缩进不能用反斜杠进行多行拼接；首个反斜杠之前的空白符决定了缩进的层次。

源文件混用制表符和空格符缩进时，因空格数量与制表符相关，由此产生的不一致将导致不能正常识别缩进层次，从而触发 TabError。

跨平台兼容性说明： 鉴于非 UNIX 平台文本编辑器本身的特性，请勿在源文件中混用制表符和空格符。另外也请注意，不同平台有可能会显式限制最大缩进层级。

行首含换页符时，缩进计算将忽略该换页符。换页符在行首空白符内其他位置的效果未定义（例如，可能导致空格计数重置为零）。

连续行的缩进层级以堆栈形式生成 INDENT 和 DEDENT 形符，说明如下。

读取文件第一行前，先向栈推入一个零值，该零值不会被移除。推入栈的层级值从底至顶持续增加。每个逻辑行开头的行缩进层级将与栈顶行比较。如果相等，则不做处理。如果新行层级较高，则会被推入栈顶，并生成一个 INDENT 形符。如果新行层级较低，则 应当 是栈中的层级数值之一；栈中高于该层级的所有数值都将被移除，每移除一级数值生成一个 DEDENT 形符。文件末尾，栈中剩余的每个大于零的数值生成一个 DEDENT 形符。

下面的 Python 代码缩进示例虽然正确，但含混不清：

def perm(l):
        # Compute the list of all permutations of 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

下例展示了多种缩进错误：

 def perm(l):                       # error: first line indented
for i in range(len(l)):             # error: not indented
    s = l[:i] + l[i+1:]
        p = perm(l[:i] + l[i+1:])   # error: unexpected indent
        for x in p:
                r.append(l[i:i+1] + x)
            return r                # error: inconsistent dedent

（实际上，解析器可以识别前三个错误；只有最后一个错误由词法分析器识别 --- return r 的缩进无法匹配从栈里移除的缩进层级。）

2.1.9. 形符间的空白字符

除非在逻辑行开头或字符串内，空格符、制表符、换页符等空白符都可以分隔形符。要把两个相连形符解读为不同形符，需要用空白符分隔（例如，ab 是一个形符，a b 则是两个形符）。

2.2. 其他形符

除 NEWLINE、INDENT、DEDENT 外，还有 标识符、关键字、字面值、运算符 、分隔符 等形符。 空白符（前述的行终止符除外）不是形符，可用于分隔形符。存在二义性时，将从左至右，读取尽量长的字符串组成合法形符。

2.3. 标识符和关键字

标识符（也称为 名称）的词法定义说明如下。

Python 标识符的句法基于 Unicode 标准附件 UAX-31，并加入了下文定义的细化与修改；详见 PEP 3131 [https://www.python.org/dev/peps/pep-3131] 。

与 Python 2.x 一样，在 ASCII 范围内（U+0001..U+007F），有效标识符字符为： 大小写字母 A 至 Z、下划线 _ 、数字 0 至 9，但不能以数字开头。

Python 3.0 引入了 ASCII 之外的更多字符（请参阅 PEP 3131 [https://www.python.org/dev/peps/pep-3131]）。这些字符的分类使用 unicodedata 模块中的 Unicode 字符数据库版本。

标识符的长度没有限制，但区分大小写。

identifier   ::=  xid_start xid_continue*
id_start     ::=  <all characters in general categories Lu, Ll, Lt, Lm, Lo, Nl, the underscore, and characters with the Other_ID_Start property>
id_continue  ::=  <all characters in id_start, plus characters in the categories Mn, Mc, Nd, Pc and others with the Other_ID_Continue property>
xid_start    ::=  <all characters in id_start whose NFKC normalization is in "id_start xid_continue*">
xid_continue ::=  <all characters in id_continue whose NFKC normalization is in "id_continue*">

上述 Unicode 类别码的含义:

Lu - 大写字母

Ll - 小写字母

Lt - 词首大写字母

Lm - 修饰符字母

Lo - 其他字母

Nl - 字母数字

Mn - 非空白标识

Mc - 含空白标识

Nd - 十进制数字

Pc - 连接标点

Other_ID_Start - 由 PropList.txt [https://www.unicode.org/Public/13.0.0/ucd/PropList.txt] 定义的显式字符列表，用于支持向后兼容

Other_ID_Continue - 同上

在解析时，所有标识符都会被转换为规范形式 NFKC；标识符的比较都是基于 NFKC。

Unicode 4.1 中所有可用的标识符字符详见此 HTML 文件 https://www.unicode.org/Public/13.0.0/ucd/DerivedCoreProperties.txt

2.3.1. 关键字

以下标识符为保留字，或称 关键字，不可用于普通标识符。关键字的拼写必须与这里列出的完全一致：

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

2.3.2. 软关键字

3.10 新版功能.

某些标识符仅在特定上下文中被保留。 它们被称为 软关键字。 match, case 和 _ 等标识符在模式匹配语句相关的上下文中具有相当于关键字的语义，但这种区分是在解析器层级完成，而不是在形符化的时候。

作为软关键字，它们能够与模式匹配一起使用，同时仍然保持与使用 match, case 和 _ 作为标识符名称的现有代码的兼容性。

2.3.3. 保留的标识符类

某些标识符类（除了关键字）具有特殊含义。这些类的命名模式以下划线字符开头，并以下划线结尾：

_*

不会被 from module import * 所导入。

_

在 match 语句内部的 case 模式中，_ 是一个 软关键字，它表示 通配符。

在此之外，交互式解释器会将最后一次求值的结果放到变量 _ 中。 （它与 print 等内置函数一起被存储于 builtins 模块。）

在其他地方，_ 是一个常规标识符。 它常常被用来命名 "特殊" 条目，但对 Python 本身来说毫无特殊之处。

注解

_ 常用于连接国际化文本；详见 gettext 模块文档。

它还经常被用来命名无需使用的变量。

__*__

系统定义的名称，通常简称为 "dunder" 。这些名称由解释器及其实现（包括标准库）定义。现有系统定义名称相关的论述详见 特殊方法名称 等章节。Python 未来版本中还将定义更多此类名称。任何情况下，任何 不显式遵从 __*__ 名称的文档用法，都可能导致无警告提示的错误。

__*

类的私有名称。类定义时，此类名称以一种混合形式重写，以避免基类及派生类的 "私有" 属性之间产生名称冲突。详见 标识符（名称）。

2.4. 字面值

字面值是内置类型常量值的表示法。

2.4.1. 字符串与字节串字面值

字符串字面值的词法定义如下：

stringliteral   ::=  [stringprefix](shortstring | longstring)
stringprefix    ::=  "r" | "u" | "R" | "U" | "f" | "F"
                     | "fr" | "Fr" | "fR" | "FR" | "rf" | "rF" | "Rf" | "RF"
shortstring     ::=  "'" shortstringitem* "'" | '"' shortstringitem* '"'
longstring      ::=  "'''" longstringitem* "'''" | '"""' longstringitem* '"""'
shortstringitem ::=  shortstringchar | stringescapeseq
longstringitem  ::=  longstringchar | stringescapeseq
shortstringchar ::=  <any source character except "\" or newline or the quote>
longstringchar  ::=  <any source character except "\">
stringescapeseq ::=  "\" <any source character>

bytesliteral   ::=  bytesprefix(shortbytes | longbytes)
bytesprefix    ::=  "b" | "B" | "br" | "Br" | "bR" | "BR" | "rb" | "rB" | "Rb" | "RB"
shortbytes     ::=  "'" shortbytesitem* "'" | '"' shortbytesitem* '"'
longbytes      ::=  "'''" longbytesitem* "'''" | '"""' longbytesitem* '"""'
shortbytesitem ::=  shortbyteschar | bytesescapeseq
longbytesitem  ::=  longbyteschar | bytesescapeseq
shortbyteschar ::=  <any ASCII character except "\" or newline or the quote>
longbyteschar  ::=  <any ASCII character except "\">
bytesescapeseq ::=  "\" <any ASCII character>

这些产生式未指明的一个句法限制是空白符不允许在 stringprefix 或 bytesprefix 与字面值的其余部分之间出现。 源字符集是由编码格式声明来定义的；如果源文件没有给出编码格式声明则默认 UTF-8；参见 编码声明 一节。

直白的说明：两种类型的字面值都可用成对的单引号 (') 或双引号 (") 括起来。 它们还可以用成对的连续三个单引号或双引号括起来 (这通常被称为 三重引号字符串)。 反斜杠 (\) 字符被用来给予普通的字符特殊含义例如 n，当用斜杠转义时 (\n) 表示 '换行'。 它还可以被用来对具有特殊含义的字符进行转义，例如换行符、反斜杠本身或者引号等。 请参阅下面的 转义序列 查看示例。

字节串字面值要加前缀 'b' 或 'B'；生成的是类型 bytes 的实例，不是类型 str 的实例；字节串只能包含 ASCII 字符；字节串数值大于等于 128 时，必须用转义表示。

字符串和字节串都可以加前缀 'r' 或 'R'，称为 原始字符串，原始字符串把反斜杠当作原义字符，不执行转义操作。因此，原始字符串不转义 '\U' 和 '\u'。与 Python 2.x 的原始 unicode 字面值操作不同，Python 3.x 现已不支持 'ur' 句法。

3.3 新版功能: 新增原始字节串 'rb' 前缀，是 'br' 的同义词。

3.3 新版功能: 支持 unicode 字面值（u'value'）遗留代码，简化 Python 2.x 和 3.x 并行代码库的维护工作。详见 PEP 414 [https://www.python.org/dev/peps/pep-0414]。

前缀为 'f' 或 'F' 的字符串称为 格式字符串；详见 格式字符串字面值。'f' 可与 'r' 连用，但不能与 'b' 或 'u' 连用，因此，可以使用原始格式字符串，但不能使用格式字节串字面值。

三引号字面值可以包含未转义的换行和引号（原样保留），除了连在一起的，用于终止字面值的，未经转义的三个引号。（"引号" 是启用字面值的字符，可以是 '，也可以是 "。）

如未标注 'r' 或 'R' 前缀，字符串和字节串字面值中，转义序列以类似 C 标准的规则进行解释。可用的转义序列如下：

转义序列 | 含意 | 备注
\<newline> | 忽略反斜杠与换行符 | (1)
\\ | 反斜杠（\） |
\' | 单引号（'） |
\" | 双引号（"） |
\a | ASCII 响铃（BEL） |
\b | ASCII 退格符（BS） |
\f | ASCII 换页符（FF） |
\n | ASCII 换行符（LF） |
\r | ASCII 回车符（CR） |
\t | ASCII 水平制表符（TAB） |
\v | ASCII 垂直制表符（VT） |
\ooo | 八进制数 ooo 字符 | (2,4)
\xhh | 十六进制数 hh 字符 | (3,4)

字符串字面值专用的转义序列：

转义序列 | 含意 | 备注
\N{name} | Unicode 数据库中名为 name 的字符 | (5)
\uxxxx | 16 位十六进制数 xxxx 码位的字符 | (6)
\Uxxxxxxxx | 32 位 16 进制数 xxxxxxxx 码位的字符 | (7)

注释：

可以在行尾添加一个反斜杠来忽略换行符:

>>> 'This string will not include \
... backslashes or newline characters.'
'This string will not include backslashes or newline characters.'

同样的效果也可以使用 三重引号字符串，或者圆括号和 字符串字面值拼接 来达成。

与 C 标准一致，接受最多三个八进制数字。

与 C 标准不同，必须为两个十六进制数字。

字节串 字面值中，十六进制数和八进制数的转义码以相应数值代表每个字节。字符串 字面值中，这些转义码以相应数值代表每个 Unicode 字符。

在 3.3 版更改: 加入了对别名 1 的支持。

必须为 4 个十六进制数码。

表示任意 Unicode 字符。必须为 8 个十六进制数码。

与 C 标准不同，无法识别的转义序列在字符串里原样保留，即，输出结果保留反斜杠。（调试时，这种方式很有用：输错转义序列时，更容易在输出结果中识别错误。）注意，在字节串字面值内，字符串字面值专用的转义序列属于无法识别的转义序列。

在 3.6 版更改: 无法识别的转义序列触发 DeprecationWarning。未来的 Python 发行版将改为触发 SyntaxWarning，最终会改为触发 SyntaxError。

即使在原始字面值中，引号也可以用反斜杠转义，但反斜杠会保留在输出结果里；例如 r"\"" 是由两个字符组成的有效字符串字面值：反斜杠和双引号；r"\" 则不是有效字符串字面值（原始字符串也不能以奇数个反斜杠结尾）。尤其是，原始字面值不能以单个反斜杠结尾 （反斜杠会转义其后的引号)。还要注意，反斜杠加换行在字面值中被解释为两个字符，而 不是 连续行。

2.4.2. 字符串字面值合并

以空白符分隔的多个相邻字符串或字节串字面值，可用不同引号标注，等同于合并操作。因此，"hello" 'world' 等价于 "helloworld"。此功能不需要反斜杠，即可将长字符串分为多个物理行，还可以为不同部分的字符串添加注释，例如：

re.compile("[A-Za-z_]"       # letter or underscore
           "[A-Za-z0-9_]*"   # letter, digit or underscore
          )

注意，此功能在句法层面定义，在编译时实现。在运行时，合并字符串表达式必须使用 '+' 运算符。还要注意，字面值合并可以为每个部分应用不同的引号风格（甚至混用原始字符串和三引号字符串)，格式字符串字面值也可以与纯字符串字面值合并。

2.4.3. 格式字符串字面值

3.6 新版功能.

格式字符串字面值 或称 f-string 是标注了 'f' 或 'F' 前缀的字符串字面值。这种字符串可包含替换字段，即以 {} 标注的表达式。其他字符串字面值只是常量，格式字符串字面值则是可在运行时求值的表达式。

除非字面值标记为原始字符串，否则，与在普通字符串字面值中一样，转义序列也会被解码。解码后，用于字符串内容的语法如下：

f_string          ::=  (literal_char | "{{" | "}}" | replacement_field)*
replacement_field ::=  "{" f_expression ["="] ["!" conversion] [":" format_spec] "}"
f_expression      ::=  (conditional_expression | "*" or_expr)
                         ("," conditional_expression | "," "*" or_expr)* [","]
                       | yield_expression
conversion        ::=  "s" | "r" | "a"
format_spec       ::=  (literal_char | NULL | replacement_field)*
literal_char      ::=  <any code point except "{", "}" or NULL>

双花括号 '{{' 或 '}}' 被替换为单花括号，花括号外的字符串仍按字面值处理。单左花括号 '{' 标记以 Python 表达式开头的替换字段。在表达式后加等于号 '='，可在求值后，同时显示表达式文本及其结果（用于调试）。 随后是用叹号 '!' 标记的转换字段。还可以在冒号 ':' 后附加格式说明符。替换字段以右花括号 '}' 为结尾。

格式字符串字面值中，表达式的处理与圆括号中的常规 Python 表达式基本一样，但也有一些不同的地方。不允许使用空表达式；lambda 和赋值表达式 := 必须显式用圆括号标注；替换表达式可以包含换行（例如，三引号字符串中），但不能包含注释；在格式字符串字面值语境内，按从左至右的顺序，为每个表达式求值。

在 3.7 版更改: Python 3.7 以前， 因为实现的问题，不允许在格式字符串字面值表达式中使用 await 表达式与包含 async for 子句的推导式。

表达式里含等号 '=' 时，输出内容包括表达式文本、'=' 、求值结果。输出内容可以保留表达式中左花括号 '{' 后，及 '=' 后的空格。没有指定格式时，'=' 默认调用表达式的 repr()。指定了格式时，默认调用表达式的 str()，除非声明了转换字段 '!r'。

3.8 新版功能: 等号 '='。

指定了转换符时，表达式求值的结果会先转换，再格式化。转换符 '!s' 调用 str() 转换求值结果，'!r' 调用 repr()，'!a' 调用 ascii()。

输出结果的格式化使用 format() 协议。格式说明符传入表达式或转换结果的 __format__() 方法。省略格式说明符，则传入空字符串。然后，格式化结果包含在整个字符串的最终值里。

最高层级的格式说明符可以包括嵌套的替换字段。 这些嵌套字段也可以包括它们自己的转换字段和 格式说明符，但是不可再包括更深层嵌套的替换字段。 这里的 格式说明符微语言 与 str.format() 方法所使用的相同。

格式化字符串字面值可以拼接，但是一个替换字段不能拆分到多个字面值。

格式字符串字面值示例如下：

>>> name = "Fred"
>>> f"He said his name is {name!r}."
"He said his name is 'Fred'."
>>> f"He said his name is {repr(name)}."  # repr() is equivalent to !r
"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'
>>> today = datetime(year=2017, month=1, day=27)
>>> f"{today:%B %d, %Y}"  # using date format specifier
'January 27, 2017'
>>> f"{today=:%B %d, %Y}" # using date format specifier and debugging
'today=January 27, 2017'
>>> number = 1024
>>> f"{number:#0x}"  # using integer format specifier
'0x400'
>>> foo = "bar"
>>> f"{ foo = }" # preserves whitespace
" foo = 'bar'"
>>> line = "The mill's closed"
>>> f"{line = }"
'line = "The mill\'s closed"'
>>> f"{line = :20}"
"line = The mill's closed   "
>>> f"{line = !r:20}"
'line = "The mill\'s closed" '

与常规字符串字面值的语法一样，替换字段中的字符不能与外层格式字符串字面值的引号冲突：

f"abc {a["x"]} def"    # error: outer string literal ended prematurely
f"abc {a['x']} def"    # workaround: use different quoting

格式化表达式中不允许使用反斜杠，否则导致错误：

f"newline: {ord('\n')}"  # raises SyntaxError

如果要包含带反斜杠的值，请创建一个临时变量。

>>> newline = ord('\n')
>>> f"newline: {newline}"
'newline: 10'

即便未包含表达式，格式字符串字面值也不能用作文档字符串。

>>> def foo():
...     f"Not a docstring"
...
>>> foo.__doc__ is None
True

参阅 PEP 498 [https://www.python.org/dev/peps/pep-0498]，了解格式字符串字面值的提案，以及与格式字符串机制相关的 str.format()。

2.4.4. 数值字面值

数值字面值有三种类型：整数、浮点数、虚数。没有复数字面值（复数由实数加虚数构成）。

注意，数值字面值不含正负号；实际上，-1 等负数是由一元运算符 '-' 和字面值 1 合成的。

2.4.5. 整数字面值

整数字面值词法定义如下：

integer      ::=  decinteger | bininteger | octinteger | hexinteger
decinteger   ::=  nonzerodigit (["_"] digit)* | "0"+ (["_"] "0")*
bininteger   ::=  "0" ("b" | "B") (["_"] bindigit)+
octinteger   ::=  "0" ("o" | "O") (["_"] octdigit)+
hexinteger   ::=  "0" ("x" | "X") (["_"] hexdigit)+
nonzerodigit ::=  "1"..."9"
digit        ::=  "0"..."9"
bindigit     ::=  "0" | "1"
octdigit     ::=  "0"..."7"
hexdigit     ::=  digit | "a"..."f" | "A"..."F"

整数字面值的长度没有限制，能一直大到占满可用内存。

确定数值时，会忽略字面值中的下划线。下划线只是为了分组数字，让数字更易读。下划线可在数字之间，也可在 0x 等基数说明符后。

注意，除了 0 以外，十进制数字的开头不允许有零。以免与 Python 3.0 版之前使用的 C 样式八进制字面值混淆。

整数字面值示例如下：

7     2147483647                        0o177    0b100110111
3     79228162514264337593543950336     0o377    0xdeadbeef
      100_000_000_000                   0b_1110_0101

在 3.6 版更改: 现已支持在字面值中，用下划线分组数字。

2.4.6. 浮点数字面值

浮点数字面值词法定义如下：

floatnumber   ::=  pointfloat | exponentfloat
pointfloat    ::=  [digitpart] fraction | digitpart "."
exponentfloat ::=  (digitpart | pointfloat) exponent
digitpart     ::=  digit (["_"] digit)*
fraction      ::=  "." digitpart
exponent      ::=  ("e" | "E") ["+" | "-"] digitpart

注意，解析时，整数和指数部分总以 10 为基数。例如，077e010 是合法的，表示的数值与 77e10 相同。浮点数字面值的支持范围取决于具体实现。整数字面值支持用下划线分组数字。

浮点数字面值示例如下：

3.14    10.    .001    1e100    3.14e-10    0e0    3.14_15_93

在 3.6 版更改: 现已支持在字面值中，用下划线分组数字。

2.4.7. 虚数字面值

虚数字面值词法定义如下：

imagnumber ::=  (floatnumber | digitpart) ("j" | "J")

虚数字面值生成实部为 0.0 的复数。复数由一对浮点数表示，它们的取值范围相同。创建实部不为零的复数，则需添加浮点数，例如 (3+4j)。虚数字面值示例如下：

3.14j   10.j    10j     .001j   1e100j   3.14e-10j   3.14_15_93j

2.5. 运算符

运算符如下所示：

+       -       *       **      /       //      %      @
<<      >>      &       |       ^       ~       :=
<       >       <=      >=      ==      !=

2.6. 分隔符

以下形符在语法中为分隔符：

(       )       [       ]       {       }
,       :       .       ;       @       =       ->
+=      -=      *=      /=      //=     %=      @=
&=      |=      ^=      >>=     <<=     **=

句点也可以用于浮点数和虚数字面值。三个连续句点表示省略符。列表后半部分是增强赋值操作符，用作词法分隔符，但也可以执行运算。

以下 ASCII 字符具有特殊含义，对词法分析器有重要意义：

'       "       #       \

以下 ASCII 字符不用于 Python。在字符串字面值或注释外使用时，将直接报错：

$       ?       `

备注

1

https://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt

3. 数据模型

3.1. 对象、值与类型

对象 是 Python 中对数据的抽象。 Python 程序中的所有数据都是由对象或对象间关系来表示的。 （从某种意义上说，按照冯·诺依曼的“存储程序计算机”模型，代码本身也是由对象来表示的。）

每个对象都有各自的标识号、类型和值。一个对象被创建后，它的 标识号 就绝不会改变；你可以将其理解为该对象在内存中的地址。 'is' 运算符可以比较两个对象的标识号是否相同；id() 函数能返回一个代表其标识号的整数。

CPython 实现细节： 在 CPython 中，id(x) 就是存放 x 的内存的地址。

对象的类型决定该对象所支持的操作 (例如 "对象是否有长度属性？") 并且定义了该类型的对象可能的取值。type() 函数能返回一个对象的类型 (类型本身也是对象)。与编号一样，一个对象的 类型 也是不可改变的。1

有些对象的 值 可以改变。值可以改变的对象被称为 可变对象；值不可以改变的对象就被称为 不可变对象。(一个不可变容器对象如果包含对可变对象的引用，当后者的值改变时，前者的值也会改变；但是该容器仍属于不可变对象，因为它所包含的对象集是不会改变的。因此，不可变并不严格等同于值不能改变，实际含义要更微妙。) 一个对象的可变性是由其类型决定的；例如，数字、字符串和元组是不可变的，而字典和列表是可变的。

对象绝不会被显式地销毁；然而，当无法访问时它们可能会被作为垃圾回收。允许具体的实现推迟垃圾回收或完全省略此机制 --- 如何实现垃圾回收是实现的质量问题，只要可访问的对象不会被回收即可。

CPython 实现细节： CPython 目前使用带有 (可选) 延迟检测循环链接垃圾的引用计数方案，会在对象不可访问时立即回收其中的大部分，但不保证回收包含循环引用的垃圾。请查看 gc 模块的文档了解如何控制循环垃圾的收集相关信息。其他实现会有不同的行为方式，CPython 现有方式也可能改变。不要依赖不可访问对象的立即终结机制 (所以你应当总是显式地关闭文件)。

注意：使用实现的跟踪或调试功能可能令正常情况下会被回收的对象继续存活。还要注意通过 'try...except' 语句捕捉异常也可能令对象保持存活。

有些对象包含对 "外部" 资源的引用，例如打开文件或窗口。当对象被作为垃圾回收时这些资源也应该会被释放，但由于垃圾回收并不确保发生，这些对象还提供了明确地释放外部资源的操作，通常为一个 close() 方法。强烈推荐在程序中显式关闭此类对象。'try...finally' 语句和 'with' 语句提供了进行此种操作的更便捷方式。

有些对象包含对其他对象的引用；它们被称为 容器。容器的例子有元组、列表和字典等。这些引用是容器对象值的组成部分。在多数情况下，当谈论一个容器的值时，我们是指所包含对象的值而不是其编号；但是，当我们谈论一个容器的可变性时，则仅指其直接包含的对象的编号。因此，如果一个不可变容器 (例如元组) 包含对一个可变对象的引用，则当该可变对象被改变时容器的值也会改变。

类型会影响对象行为的几乎所有方面。甚至对象标识号的重要性也在某种程度上受到影响：对于不可变类型，会得出新值的运算实际上可能返回类型和值相同的现有对象的引用，而对于可变类型来说这是不允许的。例如在 a = 1; b = 1 之后，a 和 b 可能会指向同一个值为一的对象，也可能不会，这取决于具体实现，但是在 c = []; d = [] 之后，c 和 d 保证会指向两个不同、单独的新建空列表。（请注意 c = d = [] 则是将同一个对象赋值给 c 和 d。）

3.2. 标准类型层级结构

以下是 Python 内置类型的列表。扩展模块 (具体实现会以 C, Java 或其他语言编写) 可以定义更多的类型。未来版本的 Python 可能会加入更多的类型 (例如有理数、高效存储的整型数组等等)，不过新增类型往往都是通过标准库来提供的。

以下部分类型的描述中包含有 '特殊属性列表' 段落。这些属性提供对具体实现的访问而非通常使用。它们的定义在未来可能会改变。

None

此类型只有一种取值。是一个具有此值的单独对象。此对象通过内置名称 None 访问。在许多情况下它被用来表示空值，例如未显式指明返回值的函数将返回 None。它的逻辑值为假。

NotImplemented

此类型只有一种取值。 是一个具有该值的单独对象。 此对象通过内置名称 NotImplemented 访问。 数值方法和丰富比较方法如未实现指定运算符表示的运算则应返回该值。 （解释器会根据具体运算符继续尝试反向运算或其他回退操作。） 它不应被解读为布尔值。

详情参见 实现算术运算。

在 3.9 版更改: 作为布尔值来解读 NotImplemented 已被弃用。 虽然它目前会被解读为真值，但将同时发出 DeprecationWarning。 它将在未来的 Python 版本中引发 TypeError。

Ellipsis

此类型只有一种取值。是一个具有此值的单独对象。此对象通过字面值 ... 或内置名称 Ellipsis 访问。它的逻辑值为真。

numbers.Number

此类对象由数字字面值创建，并会被作为算术运算符和算术内置函数的返回结果。数字对象是不可变的；一旦创建其值就不再改变。Python 中的数字当然非常类似数学中的数字，但也受限于计算机中的数字表示方法。

数字类的字符串表示形式，由 __repr__() 和 __str__() 算出，具有以下特征属性:

它们是有效的数字字面值，当被传给它们的类构造器时，将会产生具有原数字值的对象。

表示形式会在可能的情况下采用 10 进制。

开头的零，除小数点前可能存在的单个零之外，将不会被显示。

末尾的零，除小数点后可能存在的单个零之外，将不会被显示。

正负号仅在当数字为负值时会被显示。

Python 区分整型数、浮点型数和复数:

numbers.Integral

此类对象表示数学中整数集合的成员 (包括正数和负数)。

整型数可细分为两种类型:

整型 (int)

此类对象表示任意大小的数字，仅受限于可用的内存 (包括虚拟内存)。在变换和掩码运算中会以二进制表示，负数会以 2 的补码表示，看起来像是符号位向左延伸补满空位。

布尔型 (bool)

此类对象表示逻辑值 False 和 True。代表 False 和 True 值的两个对象是唯二的布尔对象。布尔类型是整型的子类型，两个布尔值在各种场合的行为分别类似于数值 0 和 1，例外情况只有在转换为字符串时分别返回字符串 "False" 或 "True"。

整型数表示规则的目的是在涉及负整型数的变换和掩码运算时提供最为合理的解释。

numbers.Real (float)

此类对象表示机器级的双精度浮点数。其所接受的取值范围和溢出处理将受制于底层的机器架构 (以及 C 或 Java 实现)。Python 不支持单精度浮点数；支持后者通常的理由是节省处理器和内存消耗，但这点节省相对于在 Python 中使用对象的开销来说太过微不足道，因此没有理由包含两种浮点数而令该语言变得复杂。

numbers.Complex (complex)

此类对象以一对机器级的双精度浮点数来表示复数值。有关浮点数的附带规则对其同样有效。一个复数值 z 的实部和虚部可通过只读属性 z.real 和 z.imag 来获取。

序列

此类对象表示以非负整数作为索引的有限有序集。内置函数 len() 可返回一个序列的条目数量。当一个序列的长度为 n 时，索引集包含数字 0, 1, ..., n-1。序列 a 的条目 i 可通过 a[i] 选择。

序列还支持切片: a[i:j] 选择索引号为 k 的所有条目，i <= k < j。当用作表达式时，序列的切片就是一个与序列类型相同的新序列。新序列的索引还是从 0 开始。

有些序列还支持带有第三个 "step" 形参的 "扩展切片": a[i:j:k] 选择 a 中索引号为 x 的所有条目，x = i + n*k, n >= 0 且 i <= x < j。

序列可根据其可变性来加以区分:

不可变序列

不可变序列类型的对象一旦创建就不能再改变。(如果对象包含对其他对象的引用，其中的可变对象就是可以改变的；但是，一个不可变对象所直接引用的对象集是不能改变的。)

以下类型属于不可变对象:

字符串

字符串是由代表 Unicode 码位的值组成的序列。 取值范围在 U+0000 - U+10FFFF 之内的所有码位都可在字符串中使用。 Python 没有 char 类型；而是将字符串中的每个码位表示为一个长度为 1 的字符串对象。 内置函数 ord() 可将一个码位由字符串形式转换为取值范围在 0 - 10FFFF 之内的整数；chr() 可将一个取值范围在 0 - 10FFFF 之内的整数转换为长度为 1 的对应字符串对象。 str.encode() 可以使用给定的文本编码格式将 str 转换为 bytes，而 bytes.decode() 则可以被用来实现相反的解码操作。

元组

一个元组中的条目可以是任意 Python 对象。包含两个或以上条目的元组由逗号分隔的表达式构成。只有一个条目的元组 ('单项元组') 可通过在表达式后加一个逗号来构成 (一个表达式本身不能创建为元组，因为圆括号要用来设置表达式分组)。一个空元组可通过一对内容为空的圆括号创建。

字节串

字节串对象是不可变的数组。其中每个条目都是一个 8 位字节，以取值范围 0 <= x < 256 的整型数表示。字节串字面值 (例如 b'abc') 和内置的 bytes() 构造器可被用来创建字节串对象。字节串对象还可以通过 decode() 方法解码为字符串。

可变序列

可变序列在被创建后仍可被改变。下标和切片标注可被用作赋值和 del (删除) 语句的目标。

目前有两种内生可变序列类型:

列表

列表中的条目可以是任意 Python 对象。列表由用方括号括起并由逗号分隔的多个表达式构成。(注意创建长度为 0 或 1 的列表无需使用特殊规则。)

字节数组

字节数组对象属于可变数组。可以通过内置的 bytearray() 构造器来创建。除了是可变的 (因而也是不可哈希的)，在其他方面字节数组提供的接口和功能都与不可变的 bytes 对象一致。

扩展模块 array 提供了一个额外的可变序列类型示例，collections 模块也是如此。

集合类型

此类对象表示由不重复且不可变对象组成的无序且有限的集合。因此它们不能通过下标来索引。但是它们可被迭代，也可用内置函数 len() 返回集合中的条目数。集合常见的用处是快速成员检测，去除序列中的重复项，以及进行交、并、差和对称差等数学运算。

对于集合元素所采用的不可变规则与字典的键相同。注意数字类型遵循正常的数字比较规则: 如果两个数字相等 (例如 1 和 1.0)，则同一集合中只能包含其中一个。

目前有两种内生集合类型:

集合

此类对象表示可变集合。它们可通过内置的 set() 构造器创建，并且创建之后可以通过方法进行修改，例如 add()。

冻结集合

此类对象表示不可变集合。它们可通过内置的 frozenset() 构造器创建。由于 frozenset 对象不可变且 hashable，它可以被用作另一个集合的元素或是字典的键。

映射

此类对象表示由任意索引集合所索引的对象的集合。通过下标 a[k] 可在映射 a 中选择索引为 k 的条目；这可以在表达式中使用，也可作为赋值或 del 语句的目标。内置函数 len() 可返回一个映射中的条目数。

目前只有一种内生映射类型:

字典

此类对象表示由几乎任意值作为索引的有限个对象的集合。不可作为键的值类型只有包含列表或字典或其他可变类型，通过值而非对象编号进行比较的值，其原因在于高效的字典实现需要使用键的哈希值以保持一致性。用作键的数字类型遵循正常的数字比较规则: 如果两个数字相等 (例如 1 和 1.0) 则它们均可来用来索引同一个字典条目。

字典会保留插入顺序，这意味着键将以它们被添加的顺序在字典中依次产生。 替换某个现有的键不会改变其顺序，但是移除某个键再重新插入则会将其添加到末尾而不会保留其原有位置。

字典是可变的；它们可通过 {...} 标注来创建 (参见 字典显示 小节)。

扩展模块 dbm.ndbm 和 dbm.gnu 提供了额外的映射类型示例，collections 模块也是如此。

在 3.7 版更改: 在 Python 3.6 版之前字典不会保留插入顺序。 在 CPython 3.6 中插入顺序会被保留，但这在当时被当作是一个实现细节而非确定的语言特性。

可调用类型

此类型可以被应用于函数调用操作 (参见 调用 小节):

用户定义函数

用户定义函数对象可通过函数定义来创建 (参见 函数定义 小节)。它被调用时应附带一个参数列表，其中包含的条目应与函数所定义的形参列表一致。

特殊属性:

属性 | 含意 |
__doc__ | 该函数的文档字符串，没有则为 None；不会被子类继承。 | 可写
__name__ | 该函数的名称。 | 可写
__qualname__ | 该函数的 qualified name。 3.3 新版功能. | 可写
__module__ | 该函数所属模块的名称，没有则为 None。 | 可写
__defaults__ | 由具有默认值的参数的默认参数值组成的元组，如无任何参数具有默认值则为 None。 | 可写
__code__ | 表示编译后的函数体的代码对象。 | 可写
__globals__ | 对存放该函数中全局变量的字典的引用 --- 函数所属模块的全局命名空间。 | 只读
__dict__ | 命名空间支持的函数属性。 | 可写
__closure__ | None 或包含该函数可用变量的绑定的单元的元组。有关 cell_contents 属性的详情见下。 | 只读
__annotations__ | 包含形参标注的字典。 字典的键是形参名，而如果提供了 'return' 则是用于返回值标注。 有关如何使用此属性的更多信息，请参阅 注解最佳实践。 | 可写
__kwdefaults__ | 仅包含关键字参数默认值的字典。 | 可写

大部分标有 "Writable" 的属性均会检查赋值的类型。

函数对象也支持获取和设置任意属性，例如这可以被用来给函数附加元数据。使用正规的属性点号标注获取和设置此类属性。注意当前实现仅支持用户定义函数属性。未来可能会增加支持内置函数属性。

单元对象具有 cell_contents 属性。这可被用来获取以及设置单元的值。

有关函数定义的额外信息可以从其代码对象中提取；参见下文对内部类型的描述。 cell 类型可以在 types 模块中访问。

实例方法

实例方法用于结合类、类实例和任何可调用对象 (通常为用户定义函数)。

特殊的只读属性: __self__ 为类实例对象本身，__func__ 为函数对象；__doc__ 为方法的文档 (与 __func__.__doc__ 作用相同)；__name__ 为方法名称 (与 __func__.__name__ 作用相同)；__module__ 为方法所属模块的名称，没有则为 None。

方法还支持获取 (但不能设置) 下层函数对象的任意函数属性。

用户定义方法对象可在获取一个类的属性时被创建 (也可能通过该类的一个实例)，如果该属性为用户定义函数对象或类方法对象。

当通过从类实例获取一个用户定义函数对象的方式创建一个实例方法对象时，类实例对象的 __self__ 属性即为该实例，并会绑定方法对象。该新建方法的 __func__ 属性就是原来的函数对象。

当通过从类或实例获取一个类方法对象的方式创建一个实例对象时，实例对象的 __self__ 属性为该类本身，其 __func__ 属性为类方法对应的下层函数对象。

当一个实例方法对象被调用时，会调用对应的下层函数 (__func__)，并将类实例 (__self__) 插入参数列表的开头。例如，当 C 是一个包含了 f() 函数定义的类，而 x 是 C 的一个实例，则调用 x.f(1) 就等同于调用 C.f(x, 1)。

当一个实例方法对象是衍生自一个类方法对象时，保存在 __self__ 中的 "类实例" 实际上会是该类本身，因此无论是调用 x.f(1) 还是 C.f(1) 都等同于调用 f(C,1)，其中 f 为对应的下层函数。

请注意从函数对象到实例方法对象的变换会在每一次从实例获取属性时发生。在某些情况下，一种高效的优化方式是将属性赋值给一个本地变量并调用该本地变量。还要注意这样的变换只发生于用户定义函数；其他可调用对象 (以及所有不可调用对象) 在被获取时都不会发生变换。还有一个需要关注的要点是作为一个类实例属性的用户定义函数不会被转换为绑定方法；这样的变换 仅当 函数是类属性时才会发生。

生成器函数

一个使用 yield 语句（见 yield 语句 章节）的函数或方法被称为 生成器函数。 这样的函数在被调用时，总是返回一个可以执行该函数体的 iterator 对象：调用该迭代器的 iterator.__next__() 方法将导致这个函数一直运行到它使用 yield 语句提供一个值。 当这个函数执行 return 语句或到达函数体末尾时，将引发 StopIteration 异常并且该迭代器将到达所返回的值集合的末尾。

协程函数

使用 async def 来定义的函数或方法就被称为 协程函数。这样的函数在被调用时会返回一个 coroutine 对象。它可能包含 await 表达式以及 async with 和 async for 语句。详情可参见 协程对象 一节。

异步生成器函数

使用 async def 来定义并使用了 yield 语句的函数或方法被称为 异步生成器函数。 这样的函数在被调用时，将返回一个 asynchronous iterator 对象，该对象可在 async for 语句中被用来执行函数体。

调用异步迭代器的 aiterator.__anext__ 方法将返回一个 awaitable，此对象会在被等待时执行直到使用 yield 产生一个值。 当函数执行到空的 return 语句或函数末尾时，将会引发 StopAsyncIteration 异常并且异步迭代器也将到达要产生的值集合的末尾。

内置函数

内置函数对象是对于 C 函数的外部封装。内置函数的例子包括 len() 和 math.sin() (math 是一个标准内置模块)。内置函数参数的数量和类型由 C 函数决定。特殊的只读属性: __doc__ 是函数的文档字符串，如果没有则为 None; __name__ 是函数的名称; __self__ 设定为 None (参见下一条目); __module__ 是函数所属模块的名称，如果没有则为 None。

内置方法

此类型实际上是内置函数的另一种形式，只不过还包含了一个传入 C 函数的对象作为隐式的额外参数。内置方法的一个例子是 alist.append()，其中 alist 为一个列表对象。在此示例中，特殊的只读属性 __self__ 会被设为 alist 所标记的对象。

类

类是可调用对象。 这些对象通常是用作创建自身实例的“工厂”，但类也可以有重载 __new__() 的变体类型。 调用的参数会传递给 __new__()，并且在通常情况下，也会传递给 __init__() 来初始化新的实例。to initialize the new instance.

类实例

任意类的实例可以通过在其所属类中定义 __call__() 方法变成可调用对象。

模块

模块是 Python 代码的基本组织单元，由 导入系统 创建，由 import 语句发起调用，或者通过 importlib.import_module() 和内置的 __import__() 等函数发起调用。 模块对象具有由字典对象实现的命名空间（这是被模块中定义的函数的 __globals__ 属性引用的字典）。 属性引用被转换为该字典中的查找，例如 m.x 相当于 m.__dict__["x"]。 模块对象不包含用于初始化模块的代码对象（因为初始化完成后不需要它）。

属性赋值会更新模块的命名空间字典，例如 m.x = 1 等同于 m.__dict__["x"] = 1。

预先定义的（可写）属性:

__name__

模块的名称。

__doc__

模块的文档字符串，如果不可用则为 None。

__file__

被加载模块所对应文件的路径名称，如果它是从文件加载的话。 对于某些类型的模块来说 __file__ 属性可能是缺失的，例如被静态链接到解释器中的 C 模块。 对于从共享库动态加载的扩展模块来说，它将是共享库文件的路径名称。

__annotations__

包含在模块体执行期间收集的 变量标注 的字典。 有关使用 __annotations__ 的最佳实践，请参阅 注解最佳实践。

特殊的只读属性: __dict__ 为以字典对象表示的模块命名空间。

CPython 实现细节： 由于 CPython 清理模块字典的设定，当模块离开作用域时模块字典将会被清理，即使该字典还有活动的引用。想避免此问题，可复制该字典或保持模块状态以直接使用其字典。

自定义类

自定义类这种类型一般通过类定义来创建 (参见 类定义 一节)。每个类都有通过一个字典对象实现的独立命名空间。类属性引用会被转化为在此字典中查找，例如 C.x 会被转化为 C.__dict__["x"] (不过也存在一些钩子对象以允许其他定位属性的方式)。当未在其中发现某个属性名称时，会继续在基类中查找。这种基类查找使用 C3 方法解析顺序，即使存在 '钻石形' 继承结构即有多条继承路径连到一个共同祖先也能保持正确的行为。有关 Python 使用的 C3 MRO 的详情可查看配合 2.3 版发布的文档 https://www.python.org/download/releases/2.3/mro/.

当一个类属性引用 (假设类名为 C) 会产生一个类方法对象时，它将转化为一个 __self__ 属性为 C 的实例方法对象。当其会产生一个静态方法对象时，它将转化为该静态方法对象所封装的对象。从类的 __dict__ 所包含内容以外获取属性的其他方式请参看 实现描述器 一节。

类属性赋值会更新类的字典，但不会更新基类的字典。

类对象可被调用 (见上文) 以产生一个类实例 (见下文)。

特殊属性:

__name__

类的名称。

__module__

类定义所在模块的名称。

__dict__

包含类命名空间的字典。

__bases__

包含基类的元组，按它们在基类列表中的出现先后排序。

__doc__

类的文档字符串，如果未定义则为 None。

__annotations__

包含在类体执行期间收集的 变量标注 的字典。 有关使用 __annotations__ 的最佳实践，请参阅 注解最佳实践。

类实例

类实例可通过调用类对象来创建（见上文）。 每个类实例都有通过一个字典对象实现的独立命名空间，属性引用会首先在此字典中查找。 当未在其中发现某个属性，而实例对应的类中有该属性时，会继续在类属性中查找。 如果找到的类属性为一个用户自定义函数对象，它会被转化为实例方法对象，其 __self__ 属性即该实例。 静态方法和类方法对象也会被转化；参见上文的“类”小节。 要了解其他通过类实例来获取相应类属性的方式请参阅 实现描述器 小节，这样得到的属性可能与实际存放在类的 __dict__ 中的对象不同。 如果未找到类属性，而对象所属的类具有 __getattr__() 方法，则会调用该方法来满足查找要求。

属性赋值和删除会更新实例的字典，但绝不会更新类的字典。 如果类具有 __setattr__() 或 __delattr__() 方法，则将调用该方法而不再直接更新实例的字典。

如果类实例具有某些特殊名称的方法，就可以伪装为数字、序列或映射。参见 特殊方法名称 一节。

特殊属性: __dict__ 为属性字典; __class__ 为实例对应的类。

I/O 对象 (或称文件对象)

file object 表示一个打开的文件。有多种快捷方式可用来创建文件对象: open() 内置函数，以及 os.popen(), os.fdopen() 和 socket 对象的 makefile() 方法 (还可能使用某些扩展模块所提供的其他函数或方法)。

sys.stdin, sys.stdout 和 sys.stderr 会初始化为对应于解释器标准输入、输出和错误流的文件对象；它们都会以文本模式打开，因此都遵循 io.TextIOBase 抽象类所定义的接口。

内部类型

某些由解释器内部使用的类型也被暴露给用户。它们的定义可能随未来解释器版本的更新而变化，为内容完整起见在此处一并介绍。

代码对象

代码对象表示 编译为字节的 可执行 Python 代码，或称 bytecode。代码对象和函数对象的区别在于函数对象包含对函数全局对象 (函数所属的模块) 的显式引用，而代码对象不包含上下文；而且默认参数值会存放于函数对象而不是代码对象内 (因为它们表示在运行时算出的值)。与函数对象不同，代码对象不可变，也不包含对可变对象的引用 (不论是直接还是间接)。

特殊的只读属性: co_name 给出了函数名; co_argcount 为位置参数的总数量 (包括仅限位置参数和带有默认值的参数); co_posonlyargcount 为仅限位置参数的数量 (包括带有默认值的参数); co_kwonlyargcount 为仅限关键字参数的数量 (包括带有默认值的参数); co_nlocals 为函数使用的局部变量的数量 (包括参数); co_varnames 为一个包含局部变量名称的元组 (参数名排在最前面); co_cellvars 为一个包含被嵌套函数所引用的局部变量名称的元组; co_freevars 为一个包含自由变量名称的元组; co_code 为一个表示字节码指令序列的字符口中; co_consts 为一个包含字节码所使用的字面值的元组; co_names 为一个包含字节码所使用的名称的元组; co_filename 为被编码代码所在的文件名; co_firstlineno 为函数首行的行号; co_lnotab 为一个字符串，其中编码了从字节码偏移量到行号的映射 (详情参见解释器的源代码); co_stacksize 为要求的栈大小; co_flags 为一个整数，其中编码了解释器所用的多个旗标。

以下是可用于 co_flags 的标志位定义：如果函数使用 *arguments 语法来接受任意数量的位置参数，则 0x04 位被设置；如果函数使用 **keywords 语法来接受任意数量的关键字参数，则 0x08 位被设置；如果函数是一个生成器，则 0x20 位被设置。

未来特性声明 (from __future__ import division) 也使用 co_flags 中的标志位来指明代码对象的编译是否启用特定的特性: 如果函数编译时启用未来除法特性则设置 0x2000 位; 在更早的 Python 版本中则使用 0x10 和 0x1000 位。

co_flags 中的其他位被保留为内部使用。

如果代码对象表示一个函数，co_consts 中的第一项将是函数的文档字符串，如果未定义则为 None。

帧对象

帧对象表示执行帧。它们可能出现在回溯对象中 (见下文)，还会被传递给注册跟踪函数。

特殊的只读属性: f_back 为前一堆栈帧 (指向调用者)，如是最底层堆栈帧则为 None; f_code 为此帧中所执行的代码对象; f_locals 为用于查找本地变量的字典; f_globals 则用于查找全局变量; f_builtins 用于查找内置 (固有) 名称; f_lasti 给出精确指令 (这是代码对象的字节码字符串的一个索引)。

访问 f_code 会引发一个 审计事件 object.__getattr__，附带参数 obj 和 "f_code"。

特殊的可写属性: f_trace，如果不为 None，则是在代码执行期间调用各类事件的函数 (由调试器使用)。通常每个新源码行会触发一个事件 - 这可以通过将 f_trace_lines 设为 False 来禁用。

具体的实现 可能 会通过将 f_trace_opcodes 设为 True 来允许按操作码请求事件。请注意如果跟踪函数引发的异常逃逸到被跟踪的函数中，这可能会导致未定义的解释器行为。

f_lineno 为帧的当前行号 --- 在这里写入从一个跟踪函数内部跳转的指定行 (仅用于最底层的帧)。调试器可以通过写入 f_lineno 实现一个 Jump 命令 (即设置下一语句)。

帧对象支持一个方法:

frame.clear()

此方法清除该帧持有的全部对本地变量的引用。而且如果该帧属于一个生成器，生成器会被完成。这有助于打破包含帧对象的循环引用 (例如当捕获一个异常并保存其回溯在之后使用)。

如果该帧当前正在执行，则会引发 RuntimeError

3.4 新版功能.

回溯对象

回溯对象表示一个异常的栈跟踪记录。当异常发生时会隐式地创建一个回溯对象，也可能通过调用 types.TracebackType 显式地创建。

对于隐式地创建的回溯对象，当查找异常句柄使得执行栈展开时，会在每个展开层级的当前回溯之前插入一个回溯对象。当进入一个异常句柄时，栈跟踪将对程序启用。(参见 try 语句 一节。) 它可作为 sys.exc_info() 所返回的元组的第三项，以及所捕获异常的 __traceback__ 属性被获取。

当程序不包含可用的句柄时，栈跟踪会 (以良好的格式) 写入标准错误流；如果解释器处于交互模式，它也可作为 sys.last_traceback 对用户启用。

对于显式创建的回溯对象，则由回溯对象的创建者来决定应该如何链接 tb_next 属性来构成完整的栈跟踪。

特殊的只读属性: tb_frame 指向当前层级的执行帧; tb_lineno 给出发生异常所在的行号; tb_lasti 标示具体指令。如果异常发生于没有匹配的 except 子句或有 finally 子句的 try 语句中，回溯对象中的行号和最后指令可能与相应帧对象中行号不同。

访问 tb_frame 会引发一个 审计事件 object.__getattr__，附带参数 obj 和 "tb_frame"。

特殊的可写属性: tb_next 为栈跟踪中的下一层级 (通往发生异常的帧)，如果没有下一层级则为 None。

在 3.7 版更改: 回溯对象现在可以使用 Python 代码显式地实例化，现有实例的 tb_next 属性可以被更新。

切片对象

切片对象被用来表示 __getitem__() 方法所使用的切片。 该对象也可使用内置的 slice() 函数来创建。

特殊的只读属性: start 为下界; stop 为上界; step 为步长值; 各值如省略则为 None。这些属性可具有任意类型。

切片对象支持一个方法:

slice.indices(self, length)

此方法接受一个整型参数 length 并计算在切片对象被应用到 length 指定长度的条目序列时切片的相关信息应如何描述。 其返回值为三个整型数组成的元组；这些数分别为切片的 start 和 stop 索引号以及 step 步长值。索引号缺失或越界则按照与正规切片相一致的方式处理。

静态方法对象

静态方法对象提供了一种胜过上文所述将函数对象转换为方法对象的方式。 静态方法对象是对任意其他对象的包装器，通常用来包装用户自定义的方法对象。 当从类或类实例获取一个静态方法对象时，实际返回的是经过包装的对象，它不会被进一步转换。 静态方法对象也是可调用对象。 静态方法对象可通过内置的 staticmethod() 构造器来创建。

类方法对象

类方法对象和静态方法一样是对其他对象的封装，会改变从类或类实例获取该对象的方式。类方法对象在此类获取操作中的行为已在上文 "用户定义方法" 一节中描述。类方法对象可通过内置的 classmethod() 构造器来创建。

3.3. 特殊方法名称

一个类可以通过定义具有特殊名称的方法来实现由特殊语法来唤起的特定操作（例如算术运算或抽取与切片）。 这是 Python 实现 运算符重载 的方式，允许每个类自行定义基于该语言运算符的特定行为。 举例来说，如果一个类定义了名为 __getitem__() 的方法，并且 x 是该类的一个实例，则 x[i] 基本就等价于 type(x).__getitem__(x, i)。 除非有说明例外情况，在没有定义适当方法的时候尝试执行某种操作将引发一个异常 (通常为 AttributeError 或 TypeError)。

将一个特殊方法设为 None 表示对应的操作不可用。 例如，如果一个类将 __iter__() 设为 None，则该类就是不可迭代的，因此对其实例调用 iter() 将引发一个 TypeError (而不会回退至 __getitem__())。 2

在实现模拟任何内置类型的类时，很重要的一点是模拟的实现程度对于被模拟对象来说应当是有意义的。例如，提取单个元素的操作对于某些序列来说是适宜的，但提取切片可能就没有意义。(这种情况的一个实例是 W3C 的文档对象模型中的 NodeList 接口。)

3.3.1. 基本定制

object.__new__(cls[, ...])

调用以创建一个 cls 类的新实例。 __new__() 是一个静态方法（因为是特例所以你不需要显式地声明），它会将所请求实例所属的类作为第一个参数。 其余的参数则是传递给对象构造表达式（对类的调用）的参数。 __new__() 的返回值应为新对象实例（通常是 cls 的实例）。

典型的实现会附带适当的参数使用 super().__new__(cls[, ...]) 通过唤起超类的 __new__() 方法来创建一个新的类实例然后在返回它之前根据需要修改新创建的实例。

如果 __new__() 在构造对象期间被唤起并且它返回了一个 cls 的实例，则新实例的 __init__() 方法将以 __init__(self[, ...]) 的形式被唤起，其中 self 为新实例而其余的参数与被传给对象构造器的参数相同。

如果 __new__() 未返回一个 cls 的实例，则新实例的 __init__() 方法就不会被执行。

__new__() 的目的主要是允许不可变类型的子类 (例如 int, str 或 tuple) 定制实例创建过程。它也常会在自定义元类中被重载以便定制类创建过程。

object.__init__(self[, ...])

在实例 (通过 __new__()) 被创建之后，返回调用者之前调用。其参数与传递给类构造器表达式的参数相同。一个基类如果有 __init__() 方法，则其所派生的类如果也有 __init__() 方法，就必须显式地调用它以确保实例基类部分的正确初始化；例如: super().__init__([args...]).

因为对象是由 __new__() 和 __init__() 协作构造完成的 (由 __new__() 创建，并由 __init__() 定制)，所以 __init__() 返回的值只能是 None，否则会在运行时引发 TypeError。

object.__del__(self)

在实例将被销毁时调用。 这还被称为终结器或析构器（不适当）。 如果一个基类具有 __del__() 方法，则其所派生的类如果也有 __del__() 方法，就必须显式地调用它以确保实例基类部分的正确清除。

__del__() 方法可以 (但不推荐!) 通过创建一个该实例的新引用来推迟其销毁。这被称为对象 重生。__del__() 是否会在重生的对象将被销毁时再次被调用是由具体实现决定的 ；当前的 CPython 实现只会调用一次。

当解释器退出时不会确保为仍然存在的对象调用 __del__() 方法。

注解

del x 并不直接调用 x.__del__() --- 前者会将 x 的引用计数减一，而后者仅会在 x 的引用计数变为零时被调用。

CPython 实现细节： 一个引用循环可以阻止对象的引用计数归零。 在这种情况下，循环将稍后被检测到并被 循环垃圾回收器 删除。 导致引用循环的一个常见原因是当一个异常在局部变量中被捕获。 帧的局部变量将会引用该异常，这将引用它自己的回溯信息，它会又引用在回溯中捕获的所有帧的局部变量。

参见

gc 模块的文档。

警告

由于调用 __del__() 方法时周边状况已不确定，在其执行期间发生的异常将被忽略，改为打印一个警告到 sys.stderr。特别地：

__del__() 可在任意代码被执行时启用，包括来自任意线程的代码。如果 __del__() 需要接受锁或启用其他阻塞资源，可能会发生死锁，例如该资源已被为执行 __del__() 而中断的代码所获取。

__del__() 可以在解释器关闭阶段被执行。因此，它需要访问的全局变量（包含其他模块）可能已被删除或设为 None。Python 会保证先删除模块中名称以单个下划线打头的全局变量再删除其他全局变量；如果已不存在其他对此类全局变量的引用，这有助于确保导入的模块在 __del__() 方法被调用时仍然可用。

object.__repr__(self)

由 repr() 内置函数调用以输出一个对象的“官方”字符串表示。如果可能，这应类似一个有效的 Python 表达式，能被用来重建具有相同取值的对象（只要有适当的环境）。如果这不可能，则应返回形式如 <...some useful description...> 的字符串。返回值必须是一个字符串对象。如果一个类定义了 __repr__() 但未定义 __str__()，则在需要该类的实例的“非正式”字符串表示时也会使用 __repr__()。

此方法通常被用于调试，因此确保其表示的内容包含丰富信息且无歧义是很重要的。

object.__str__(self)

通过 str(object) 以及内置函数 format() 和 print() 调用以生成一个对象的“非正式”或格式良好的字符串表示。返回值必须为一个 字符串 对象。

此方法与 object.__repr__() 的不同点在于 __str__() 并不预期返回一个有效的 Python 表达式：可以使用更方便或更准确的描述信息。

内置类型 object 所定义的默认实现会调用 object.__repr__()。

object.__bytes__(self)

通过 bytes 调用以生成一个对象的字节串表示。这应该返回一个 bytes 对象。

object.__format__(self, format_spec)

通过 format() 内置函数、扩展、格式化字符串字面值 的求值以及 str.format() 方法调用以生成一个对象的“格式化”字符串表示。 format_spec 参数为包含所需格式选项描述的字符串。 format_spec 参数的解读是由实现 __format__() 的类型决定的，不过大多数类或是将格式化委托给某个内置类型，或是使用相似的格式化选项语法。

请参看 格式规格迷你语言 了解标准格式化语法的描述。

返回值必须为一个字符串对象。

在 3.4 版更改: object 本身的 __format__ 方法如果被传入任何非空字符，将会引发一个 TypeError。

在 3.7 版更改: object.__format__(x, '') 现在等同于 str(x) 而不再是 format(str(x), '')。

object.__lt__(self, other)

object.__le__(self, other)

object.__eq__(self, other)

object.__ne__(self, other)

object.__gt__(self, other)

object.__ge__(self, other)

以上这些被称为“富比较”方法。运算符号与方法名称的对应关系如下：x<y 调用 x.__lt__(y)、x<=y 调用 x.__le__(y)、x==y 调用 x.__eq__(y)、x!=y 调用 x.__ne__(y)、x>y 调用 x.__gt__(y)、x>=y 调用 x.__ge__(y)。

如果指定的参数对没有相应的实现，富比较方法可能会返回单例对象 NotImplemented。按照惯例，成功的比较会返回 False 或 True。不过实际上这些方法可以返回任意值，因此如果比较运算符是要用于布尔值判断（例如作为 if 语句的条件），Python 会对返回值调用 bool() 以确定结果为真还是假。

在默认情况下，object 通过使用 is 来实现 __eq__()，并在比较结果为假值时返回 NotImplemented: True if x is y else NotImplemented。 对于 __ne__()，默认会委托给 __eq__() 并对结果取反，除非结果为 NotImplemented。 比较运算符之间没有其他隐含关系或默认实现；例如，(x<y or x==y) 为真并不意味着 x<=y。 要根据单根运算自动生成排序操作，请参看 functools.total_ordering()。

请查看 __hash__() 的相关段落，了解创建可支持自定义比较运算并可用作字典键的 hashable 对象时要注意的一些事项。

这些方法并没有对调参数版本（在左边参数不支持该操作但右边参数支持时使用）；而是 __lt__() 和 __gt__() 互为对方的反射， __le__() 和 __ge__() 互为对方的反射，而 __eq__() 和 __ne__() 则是它们自己的反射。如果两个操作数的类型不同，且右操作数类型是左操作数类型的直接或间接子类，则优先选择右操作数的反射方法，否则优先选择左操作数的方法。虚拟子类不会被考虑。

object.__hash__(self)

通过内置函数 hash() 调用以对哈希集的成员进行操作，属于哈希集的类型包括 set、frozenset 以及 dict。__hash__() 应该返回一个整数。对象比较结果相同所需的唯一特征属性是其具有相同的哈希值；建议的做法是把参与比较的对象全部组件的哈希值混在一起，即将它们打包为一个元组并对该元组做哈希运算。例如:

def __hash__(self):
    return hash((self.name, self.nick, self.color))

注解

hash() 会从一个对象自定义的 __hash__() 方法返回值中截断为 Py_ssize_t 的大小。通常对 64 位构建为 8 字节，对 32 位构建为 4 字节。如果一个对象的 __hash__() 必须在不同位大小的构建上进行互操作，请确保检查全部所支持构建的宽度。做到这一点的简单方法是使用 python -c "import sys; print(sys.hash_info.width)"。

如果一个类没有定义 __eq__() 方法，那么它也不应该定义 __hash__() 操作；如果它定义了 __eq__() 但没有定义 __hash__()，则其实例将不可被用作可哈希多项集的条目。 如果一个类定义了可变对象并实现了 __eq__() 方法，则它不应该实现 __hash__()，因为 hashable 多项集的实现要求键的哈希值是不可变的（如果对象的哈希值发生改变，它将位于错误的哈希桶中）。

用户定义的类默认带有 __eq__() 和 __hash__() 方法；使用它们与任何对象（自己除外）比较必定不相等，并且 x.__hash__() 会返回一个恰当的值以确保 x == y 同时意味着 x is y 且 hash(x) == hash(y)。

一个类如果重载了 __eq__() 且没有定义 __hash__() 则会将其 __hash__() 隐式地设为 None。当一个类的 __hash__() 方法为 None 时，该类的实例将在一个程序尝试获取其哈希值时正确地引发 TypeError，并会在检测 isinstance(obj, collections.abc.Hashable) 时被正确地识别为不可哈希对象。

如果一个重载了 __eq__() 的类需要保留来自父类的 __hash__() 实现，则必须通过设置 __hash__ = <ParentClass>.__hash__ 来显式地告知解释器。

如果一个没有重载 __eq__() 的类需要去掉哈希支持，则应该在类定义中包含 __hash__ = None。一个自定义了 __hash__() 以显式地引发 TypeError 的类会被 isinstance(obj, collections.abc.Hashable) 调用错误地识别为可哈希对象。

注解

在默认情况下，str 和 bytes 对象的 __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²) complexity. See http://www.ocert.org/advisories/ocert-2011-003.html for details.

改变哈希值会影响集合的迭代次序。Python 也从不保证这个次序不会被改变（通常它在 32 位和 64 位构建上是不一致的）。

另见 PYTHONHASHSEED.

在 3.3 版更改: 默认启用哈希随机化。

object.__bool__(self)

调用此方法以实现真值检测以及内置的 bool() 操作；应该返回 False 或 True。如果未定义此方法，则会查找并调用 __len__() 并在其返回非零值时视对象的逻辑值为真。如果一个类既未定义 __len__() 也未定义 __bool__() 则视其所有实例的逻辑值为真。

3.3.2. 自定义属性访问

可以定义下列方法来自定义对类实例属性访问（x.name 的使用、赋值或删除）的具体含义.

object.__getattr__(self, name)

当默认属性访问因引发 AttributeError 而失败时被调用 (可能是调用 __getattribute__() 时由于 name 不是一个实例属性或 self 的类关系树中的属性而引发了 AttributeError；或者是对 name 特性属性调用 __get__() 时引发了 AttributeError)。此方法应当返回（找到的）属性值或是引发一个 AttributeError 异常。

请注意如果属性是通过正常机制找到的，__getattr__() 就不会被调用。（这是在 __getattr__() 和 __setattr__() 之间故意设置的不对称性。）这既是出于效率理由也是因为不这样设置的话 __getattr__() 将无法访问实例的其他属性。要注意至少对于实例变量来说，你不必在实例属性字典中插入任何值（而是通过插入到其他对象）就可以模拟对它的完全控制。请参阅下面的 __getattribute__() 方法了解真正获取对属性访问的完全控制权的办法。

object.__getattribute__(self, name)

此方法会无条件地被调用以实现对类实例属性的访问。如果类还定义了 __getattr__()，则后者不会被调用，除非 __getattribute__() 显式地调用它或是引发了 AttributeError。此方法应当返回（找到的）属性值或是引发一个 AttributeError 异常。为了避免此方法中的无限递归，其实现应该总是调用具有相同名称的基类方法来访问它所需要的任何属性，例如 object.__getattribute__(self, name)。

注解

此方法在作为通过特定语法或内置函数隐式地调用的结果的情况下查找特殊方法时仍可能会被跳过。参见 特殊方法查找。

引发一个 审计事件 object.__getattr__，附带参数 obj, name。

object.__setattr__(self, name, value)

此方法在一个属性被尝试赋值时被调用。这个调用会取代正常机制（即将值保存到实例字典）。 name 为属性名称， value 为要赋给属性的值。

如果 __setattr__() 想要赋值给一个实例属性，它应该调用同名的基类方法，例如 object.__setattr__(self, name, value)。

引发一个 审计事件 object.__setattr__，附带参数 obj, name, value。

object.__delattr__(self, name)

类似于 __setattr__() 但其作用为删除而非赋值。此方法应该仅在 del obj.name 对于该对象有意义时才被实现。

引发一个 审计事件 object.__delattr__，附带参数 obj, name。

object.__dir__(self)

此方法会在对相应对象调用 dir() 时被调用。返回值必须为一个序列。 dir() 会把返回的序列转换为列表并对其排序。

3.3.2.1. 自定义模块属性访问

特殊名称 __getattr__ 和 __dir__ 还可被用来自定义对模块属性的访问。模块层级的 __getattr__ 函数应当接受一个参数，其名称为一个属性名，并返回计算结果值或引发一个 AttributeError。如果通过正常查找即 object.__getattribute__() 未在模块对象中找到某个属性，则 __getattr__ 会在模块的 __dict__ 中查找，未找到时会引发一个 AttributeError。如果找到，它会以属性名被调用并返回结果值。

__dir__ 函数应当不接受任何参数，并且返回一个表示模块中可访问名称的字符串序列。 此函数如果存在，将会重载一个模块中的标准 dir() 查找。

想要更细致地自定义模块的行为（设置属性和特性属性等待），可以将模块对象的 __class__ 属性设置为一个 types.ModuleType 的子类。例如:

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

注解

定义模块的 __getattr__ 和设置模块的 __class__ 只会影响使用属性访问语法进行的查找 -- 直接访问模块全局变量（不论是通过模块内的代码还是通过对模块全局字典的引用）是不受影响的。

在 3.5 版更改: __class__ 模块属性改为可写。

3.7 新版功能: __getattr__ 和 __dir__ 模块属性。

参见

PEP 562 [https://www.python.org/dev/peps/pep-0562] - 模块 __getattr__ 和 __dir__

描述用于模块的 __getattr__ 和 __dir__ 函数。

3.3.2.2. 实现描述器

以下方法仅当一个包含该方法的类（称为 描述器 类）的实例出现于一个 所有者 类中的时候才会起作用（该描述器必须在所有者类或其某个上级类的字典中）。在以下示例中，“属性”指的是名称为所有者类 __dict__ 中的特征属性的键名的属性。

object.__get__(self, instance, owner=None)

调用此方法以获取所有者类的属性（类属性访问）或该类的实例的属性（实例属性访问）。 可选的 owner 参数是所有者类而 instance 是被用来访问属性的实例，如果通过 owner 来访问属性则返回 None。

此方法应当返回计算得到的属性值或是引发 AttributeError 异常。

PEP 252 [https://www.python.org/dev/peps/pep-0252] 指明 __get__() 为带有一至二个参数的可调用对象。 Python 自身内置的描述器支持此规格定义；但是，某些第三方工具可能要求必须带两个参数。 Python 自身的 __getattribute__() 实现总是会传入两个参数，无论它们是否被要求提供。

object.__set__(self, instance, value)

调用此方法以设置 instance 指定的所有者类的实例的属性为新值 value。

请注意，添加 __set__() 或 __delete__() 会将描述器变成“数据描述器”。 更多细节请参阅 调用描述器。

object.__delete__(self, instance)

调用此方法以删除 instance 指定的所有者类的实例的属性。

属性 __objclass__ 会被 inspect 模块解读为指定此对象定义所在的类（正确设置此属性有助于动态类属性的运行时内省）。对于可调用对象来说，它可以指明预期或要求提供一个特定类型（或子类）的实例作为第一个位置参数（例如，CPython 会为实现于 C 中的未绑定方法设置此属性）。

3.3.2.3. 调用描述器

总的说来，描述器就是具有“绑定行为”的对象属性，其属性访问已被描述器协议中的方法所重载: __get__(), __set__() 和 __delete__()。 如果一个对象定义了以上方法中的任意一个，它就被称为描述器。

属性访问的默认行为是从一个对象的字典中获取、设置或删除属性。例如，a.x 的查找顺序会从 a.__dict__['x'] 开始，然后是 type(a).__dict__['x']，接下来依次查找 type(a) 的上级基类，不包括元类。

但是，如果找到的值是定义了某个描述器方法的对象，则 Python 可能会重载默认行为并转而唤起描述器方法。这具体发生在优先级链的哪个环节则要根据所定义的描述器方法及其被调用的方式来决定。

描述器唤起的开始点是一个绑定 a.x。参数的组合方式依 a 而定:

直接调用

最简单但最不常见的调用方式是用户代码直接唤起一个描述器方法: x.__get__(a)。

实例绑定

如果绑定到一个对象实例，a.x 会被转换为调用: type(a).__dict__['x'].__get__(a, type(a))。

类绑定

如果绑定到一个类，A.x 会被转换为调用: A.__dict__['x'].__get__(None, A)。

超绑定

如果 a 是 super 的一个实例，则绑定 super(B, obj).m() 会在 obj.__class__.__mro__ 中搜索 B 的直接上级基类 A 然后通过以下调用来发起调用描述器: A.__dict__['m'].__get__(obj, obj.__class__)。

对于实例绑定，发起描述器调用的优先级取决于定义了哪些描述器方法。 一个描述器可以定义 __get__(), __set__() 和 __delete__() 的任意组合。 如果它没有定义 __get__()，则访问属性将返回描述器对象自身，除非对象的实例字典中有相应的属性值。 如果描述器定义了 __set__() 和/或 __delete__()，则它是一个数据描述器；如果以上两个都未定义，则它是一个非数据描述器。 通常，数据描述器会同时定义 __get__() 和 __set__()，而非数据描述器则只有 __get__() 方法。 定义了 __get__() 和 __set__() (和/或 __delete__()) 的数据描述器总是会重载实例字典中的定义。 与之相对地，非数据描述器则可被实例所重载。

Python 方法（包括用 @staticmethod 和 @classmethod 装饰的方法）都是作为非数据描述器来实现的。 因而，实例可以重定义和重写方法。 这允许单个实例获得与相同类的其他实例不一样的行为。

property() 函数是作为数据描述器来实现的。因此实例不能重载特性属性的行为。

3.3.2.4. __slots__

__slots__ 允许我们显式地声明数据成员（如特征属性）并禁止创建 __dict__ 和 __weakref__ (除非是在 __slots__ 中显式地声明或是在父类中可用。)

相比使用 __dict__ 可以显著节省空间。 属性查找速度也可得到显著的提升。

object.__slots__

这个类变量可赋值为字符串、可迭代对象或由实例使用的变量名组成的字符串序列。 __slots__ 会为已声明的变量保留空间并阻止自动为每个实例创建 __dict__ 和 __weakref__。

3.3.2.4.1. 使用 __slots__ 的注意事项

当继承自一个没有 __slots__ 的类时，实例的 __dict__ 和 __weakref__ 属性将总是可访问的。

没有 __dict__ 变量，实例就不能给未在 __slots__ 定义中列出的新变量赋值。 尝试给一个未列出的变量名赋值将引发 AttributeError。 如果需要动态地给新变量赋值，则要将 '__dict__' 加入到在 __slots__ 中声明的字符串序列中。

如果未给每个实例设置 __weakref__ 变量，则定义了 __slots__ 的类就不支持对其实例的 弱引用。 如果需要支持弱引用，则要将 '__weakref__' 加入到在 __slots__ 中声明的字符串序列中。

__slots__ 是通过为每个变量名创建 描述器 在类层级上实现的。 因此，类属性不能被用来为通过 __slots__ 定义的实例变量设置默认值；否则，类属性将会覆盖描述器赋值。

__slots__ 声明的作用不只限于定义它的类。 在父类中声明的 __slots__ 在其子类中同样可用。 不过，子类将会获得 __dict__ 和 __weakref__ 除非它们也定义了 __slots__ (其中应当仅包含任何 附加 槽位的名称)。

如果一个类定义的位置在某个基类中也有定义，则由基类位置定义的实例变量将不可访问（除非通过直接从基类获取其描述器的方式）。这会使得程序的含义变成未定义。未来可能会添加一个防止此情况的检查。

如果为派生自 "variable-length" 内置类型 如 int, bytes 和 tuple 的类定义了非空的*__slots__* 则将引发 TypeError。

任何非字符串的 iterable 都可以被赋值给 __slots__。

如果是使用一个 字典 来给 __slots__ 赋值，则该字典的键将被用作槽位名称。 字典的值可被用来为每个属性提供将被 inspect.getdoc() 识别并在and displayed in the output of help() 的输出中显示的文档字符串。

__class__ 赋值仅在两个类具有同样的 __slots__ 时会起作用。

带有多槽位父类的 多重继承 也是可用的，但仅允许一个父类具有由槽位创建的属性（其他基类必须具有空的槽位布局） —— 违反此规则将引发 TypeError。

如果将 iterator 用于 __slots__ 则会为该迭代器的每个值创建一个 descriptor。 但是，__slots__ 属性将为一个空迭代器。

3.3.3. 自定义类创建

当一个类继承另一个类时，会在这个父类上调用 __init_subclass__()。 这样，就使得编写改变子类行为的类成为可能。 这与类装饰器有很密切的关联，但类装饰器只能影响它们所应用的特定类，而 __init_subclass__ 则只作用于定义了该方法的类在未来的子类。

classmethod object.__init_subclass__(cls)

当所在类派生子类时此方法就会被调用。cls 将指向新的子类。如果定义为一个普通实例方法，此方法将被隐式地转换为类方法。

传入一个新类的关键字参数会被传给父类的 __init_subclass__。为了与其他使用 __init_subclass__ 的类兼容，应当根据需要去掉部分关键字参数再将其余的传给基类，例如:

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

object.__init_subclass__ 的默认实现什么都不做，只在带任意参数调用时引发一个错误。

注解

元类提示 metaclass 将被其它类型机制消耗掉，并不会被传给 __init_subclass__ 的实现。实际的元类（而非显式的提示）可通过 type(cls) 访问。

3.6 新版功能.

当一个类被创建时，type.__new__() 会扫描类变量并对其中带有 __set_name__() 钩子的对象执行回调。

object.__set_name__(self, owner, name)

在所有者类 owner 被创建时自动调用。 此对象已被赋值给该类中的 name:

class A:
    x = C()  # Automatically calls: x.__set_name__(A, 'x')

如果类变量赋值是在类被创建之后进行的，__set_name__() 将不会被自动调用。 如有必要，可以直接调用 __set_name__():

class A:
   pass

c = C()
A.x = c                  # The hook is not called
c.__set_name__(A, 'x')   # Manually invoke the hook

详情参见 创建类对象。

3.6 新版功能.

3.3.3.1. 元类

默认情况下，类是使用 type() 来构建的。类体会在一个新的命名空间内执行，类名会被局部绑定到 type(name, bases, namespace) 的结果。

类创建过程可通过在定义行传入 metaclass 关键字参数，或是通过继承一个包含此参数的现有类来进行定制。在以下示例中，MyClass 和 MySubclass 都是 Meta 的实例:

class Meta(type):
    pass

class MyClass(metaclass=Meta):
    pass

class MySubclass(MyClass):
    pass

在类定义内指定的任何其他关键字参数都会在下面所描述的所有元类操作中进行传递。

当一个类定义被执行时，将发生以下步骤:

解析 MRO 条目；

确定适当的元类；

准备类命名空间；

执行类主体；

创建类对象。

3.3.3.2. 解析 MRO 条目

如果在类定义中出现的基类不是 type 的实例，则使用 __mro_entries__ 方法对其进行搜索，当找到结果时，它会以原始基类元组做参数进行调用。此方法必须返回类的元组以替代此基类被使用。元组可以为空，在此情况下原始基类将被忽略。

参见

PEP 560 [https://www.python.org/dev/peps/pep-0560] - 对 typing 模块和泛型类型的核心支持

3.3.3.3. 确定适当的元类

为一个类定义确定适当的元类是根据以下规则:

如果没有基类且没有显式指定元类，则使用 type()；

如果给出一个显式元类而且 不是 type() 的实例，则其会被直接用作元类；

如果给出一个 type() 的实例作为显式元类，或是定义了基类，则使用最近派生的元类。

最近派生的元类会从显式指定的元类（如果有）以及所有指定的基类的元类（即 type(cls)）中选取。最近派生的元类应为 所有 这些候选元类的一个子类型。如果没有一个候选元类符合该条件，则类定义将失败并抛出 TypeError。

3.3.3.4. 准备类命名空间

一旦确定了适当的元类，就开始准备类的命名空间。 如果元类具有 __prepare__ 属性，它将以 namespace = metaclass.__prepare__(name, bases, **kwds) 的形式被调用（其中如果存在任何额外关键字参数，则应来自类定义）。 __prepare__ 方法应当被实现为 类方法。 __prepare__ 所返回的命名空间会被传入 __new__，但是当最终的类对象被创建时该命名空间会被拷贝到一个新的 dict 中。

如果元类没有 __prepare__ 属性，则类命名空间将初始化为一个空的有序映射。

参见

PEP 3115 [https://www.python.org/dev/peps/pep-3115] - Python 3000 中的元类

引入 __prepare__ 命名空间钩子

3.3.3.5. 执行类主体

类主体会以（类似于） exec(body, globals(), namespace) 的形式被执行。普通调用与 exec() 的关键区别在于当类定义发生于函数内部时，词法作用域允许类主体（包括任何方法）引用来自当前和外部作用域的名称。

但是，即使当类定义发生于函数内部时，在类内部定义的方法仍然无法看到在类作用域层次上定义的名称。类变量必须通过实例的第一个形参或类方法来访问，或者是通过下一节中描述的隐式词法作用域的 __class__ 引用。

3.3.3.6. 创建类对象

一旦执行类主体完成填充类命名空间，将通过调用 metaclass(name, bases, namespace, **kwds) 创建类对象（此处的附加关键字参数与传入 __prepare__ 的相同）。

如果类主体中有任何方法引用了 __class__ 或 super，这个类对象会通过零参数形式的 super(). __class__ 所引用，这是由编译器所创建的隐式闭包引用。这使用零参数形式的 super() 能够正确标识正在基于词法作用域来定义的类，而被用于进行当前调用的类或实例则是基于传递给方法的第一个参数来标识的。

CPython 实现细节： 在 CPython 3.6 及之后的版本中，__class__ 单元会作为类命名空间中的 __classcell__ 条目被传给元类。 如果存在，它必须被向上传播给 type.__new__ 调用，以便能正确地初始化该类。 如果不这样做，在 Python 3.8 中将引发 RuntimeError。

当使用默认的元类 type，或者任何最终会调用 type.__new__ 的元类时，以下额外的自定义步骤将在创建类对象之后被唤起：

type.__new__ 方法会收集类命名空间中所有定义了 __set_name__() 方法的属性;

这些 __set_name__ 方法将附带所定义的类和指定的属性所赋的名称进行调用;

在新类基于方法解析顺序所确定的直接父类上调用 __init_subclass__() 钩子。

在类对象创建之后，它会被传给包含在类定义中的类装饰器（如果有的话），得到的对象将作为已定义的类绑定到局部命名空间。

当通过 type.__new__ 创建一个新类时，提供以作为命名空间形参的对象会被复制到一个新的有序映射并丢弃原对象。这个新副本包装于一个只读代理中，后者则成为类对象的 __dict__ 属性。

参见

PEP 3135 [https://www.python.org/dev/peps/pep-3135] - 新的超类型

描述隐式的 __class__ 闭包引用

3.3.3.7. 元类的作用

元类的潜在作用非常广泛。已经过尝试的设想包括枚举、日志、接口检查、自动委托、自动特征属性创建、代理、框架以及自动资源锁定/同步等等。

3.3.4. 自定义实例及子类检查

以下方法被用来重载 isinstance() 和 issubclass() 内置函数的默认行为。

特别地，元类 abc.ABCMeta 实现了这些方法以便允许将抽象基类（ABC）作为“虚拟基类”添加到任何类或类型（包括内置类型），包括其他 ABC 之中。

class.__instancecheck__(self, instance)

如果 instance 应被视为 class 的一个（直接或间接）实例则返回真值。如果定义了此方法，则会被调用以实现 isinstance(instance, class)。

class.__subclasscheck__(self, subclass)

Return true 如果 subclass 应被视为 class 的一个（直接或间接）子类则返回真值。如果定义了此方法，则会被调用以实现 issubclass(subclass, class)。

请注意这些方法的查找是基于类的类型（元类）。它们不能作为类方法在实际的类中被定义。这与基于实例被调用的特殊方法的查找是一致的，只有在此情况下实例本身被当作是类。

参见

PEP 3119 [https://www.python.org/dev/peps/pep-3119] - 引入抽象基类

新增功能描述，通过 __instancecheck__() 和 __subclasscheck__() 来定制 isinstance() 和 issubclass() 行为，加入此功能的动机是出于向该语言添加抽象基类的内容（参见 abc 模块）。

3.3.5. 模拟泛型类型

当使用 类型标注 时，使用 Python 的方括号标记来 形参化 一个 generic type 往往会很有用处。 例如，list[int] 这样的标注可以被用来表示一个 list 中的所有元素均为 int 类型。

参见

PEP 484 [https://www.python.org/dev/peps/pep-0484] —— 类型注解

介绍 Python 中用于类型标注的框架

泛用别名类型

代表形参化泛用类的对象的文档

泛型（Generic）, 用户自定义泛型 和 typing.Generic

有关如何实现可在运行时被形参化并能被静态类型检查器所识别的泛用类的文档。

一个类 通常 只有在定义了特殊的类方法 __class_getitem__() 时才能被形参化。

classmethod object.__class_getitem__(cls, key)

按照 key 参数指定的类型返回一个表示泛型类的专门化对象。

当在类上定义时，__class_getitem__() 会自动成为类方法。 因此，当它被定义时没有必要使用 @classmethod 来装饰。

3.3.5.1. __class_getitem__ 的目的

__class_getitem__() 的目的是允许标准库泛型类的运行时形参化以更方便地对这些类应用 类型提示。

要实现可以在运行时被形参化并可被静态类型检查所理解的自定义泛型类，用户应当从已经实现了 __class_getitem__() 的标准库类继承，或是从 typing.Generic 继承，这个类拥有自己的 __class_getitem__() 实现。

标准库以外的类上的 __class_getitem__() 自定义实现可能无法被第三方类型检查器如 mypy 所理解。 不建议在任何类上出于类型提示以外的目的使用 __class_getitem__()。

3.3.5.2. __class_getitem__ 与 __getitem__

通常，使用方括号语法 抽取 一个对象将会调用在该对象的类上定义的 __getitem__() 实例方法。 不过，如果被拟抽取的对象本身是一个类，则可能会调用 __class_getitem__() 类方法。 __class_getitem__() 如果被正确地定义，则应当返回一个 GenericAlias 对象。

使用 表达式 obj[x] 来呈现，Python 解释器会遵循下面这样的过程来确定应当调用 __getitem__() 还是 __class_getitem__():

from inspect import isclass

def subscribe(obj, x):
    """Return the result of the expression `obj[x]`"""

    class_of_obj = type(obj)

    # If the class of obj defines __getitem__,
    # call class_of_obj.__getitem__(obj, x)
    if hasattr(class_of_obj, '__getitem__'):
        return class_of_obj.__getitem__(obj, x)

    # Else, if obj is a class and defines __class_getitem__,
    # call obj.__class_getitem__(x)
    elif isclass(obj) and hasattr(obj, '__class_getitem__'):
        return obj.__class_getitem__(x)

    # Else, raise an exception
    else:
        raise TypeError(
            f"'{class_of_obj.__name__}' object is not subscriptable"
        )

在 Python 中，所有的类自身也是其他类的实例。 一个类所属的类被称为该类的 metaclass，并且大多数类都将 type 类作为它们的元类。 type 没有定义 __getitem__()，这意味着 list[int], dict[str, float] 和 tuple[str, bytes] 这样的表达式都将导致 __class_getitem__() 被调用:

>>> # list has class "type" as its metaclass, like most classes:
>>> type(list)
<class 'type'>
>>> type(dict) == type(list) == type(tuple) == type(str) == type(bytes)
True
>>> # "list[int]" calls "list.__class_getitem__(int)"
>>> list[int]
list[int]
>>> # list.__class_getitem__ returns a GenericAlias object:
>>> type(list[int])
<class 'types.GenericAlias'>

然而，如果一个类属于定义了 __getitem__() 的自定义元类，则抽取该类可能导致不同的行为。 这方面的一个例子可以在 enum 模块中找到:

>>> from enum import Enum
>>> class Menu(Enum):
...     """A breakfast menu"""
...     SPAM = 'spam'
...     BACON = 'bacon'
...
>>> # Enum classes have a custom metaclass:
>>> type(Menu)
<class 'enum.EnumMeta'>
>>> # EnumMeta defines __getitem__,
>>> # so __class_getitem__ is not called,
>>> # and the result is not a GenericAlias object:
>>> Menu['SPAM']
<Menu.SPAM: 'spam'>
>>> type(Menu['SPAM'])
<enum 'Menu'>

参见

PEP 560 [https://www.python.org/dev/peps/pep-0560] - 对 typing 模块和泛型的核心支持

介绍 __class_getitem__()，并指明 抽取 在何时会导致 __class_getitem__() 而不是 __getitem__() 被调用

3.3.6. 模拟可调用对象

object.__call__(self[, args...])

此方法会在实例作为一个函数被“调用”时被调用；如果定义了此方法，则 x(arg1, arg2, ...) 就大致可以被改写为 type(x).__call__(x, arg1, ...)。

3.3.7. 模拟容器类型

可以定义下列方法来实现容器对象。 窗口通常属于 序列 (如 列表 或 元组) 或者 映射 (如 字典)，但也有表现为其他形式的容器。 前几个方法被用来模拟序列或是模拟映射；两者的不同之处在于序列允许的键应为整数 k 并且 0 <= k < N 其中 N 是序列或 slice 对象的长度，它们定义了条目的范围。 此外还建议让映射提供 keys(), values(), items(), get(), clear(), setdefault(), pop(), popitem(), copy() 以及 update() 等方法，它们的行为应与 Python 的标准 字典 对象类似。 此外 collections.abc 模块提供了一个 MutableMapping abstract base class 以便根据由 __getitem__(), __setitem__(), __delitem__() 和 keys() 组成的基本集来创建所需的方法。 可变序列还应提供 append(), count(), index(), extend(), insert(), pop(), remove(), reverse() 和 sort() 等方法，就像 Python 的标准 list 对象那样。 最后，序列类型还应通过定义下文描述的 __add__(), __radd__(), __iadd__(), __mul__(), __rmul__() 和 __imul__() 等方法来实现加法（指拼接）和乘法（指重复）；它们不应定义其他数值运算符。 此外还建议映射和序列都实现 __contains__() 方法以允许高效地使用 in 运算符；对于映射，in 应当搜索映射的键；对于序列，则应当搜索其中的值。 另外还建议映射和序列都实现 __iter__() 方法以允许高效地迭代容器中的条目；对于映射，__iter__() 应当迭代对象的键；对于序列，则应当迭代其中的值。

object.__len__(self)

调用此方法以实现内置函数 len()。应该返回对象的长度，以一个 >= 0 的整数表示。此外，如果一个对象未定义 __bool__() 方法而其 __len__() 方法返回值为零，则在布尔运算中会被视为假值。

CPython 实现细节： 在 CPython 中，要求长度最大为 sys.maxsize。如果长度大于 sys.maxsize 则某些特性 (例如 len()) 可能会引发 OverflowError。要通过真值检测来防止引发 OverflowError，对象必须定义 __bool__() 方法。

object.__length_hint__(self)

调用此方法以实现 operator.length_hint()。 应该返回对象长度的估计值（可能大于或小于实际长度）。 此长度应为一个 >= 0 的整数。 返回值也可以为 NotImplemented，这会被视作与 __length_hint__ 方法完全不存在时一样处理。 此方法纯粹是为了优化性能，并不要求正确无误。

3.4 新版功能.

注解

切片是通过下述三个专门方法完成的。以下形式的调用

a[1:2] = b

会为转写为

a[slice(1, 2, None)] = b

其他形式以此类推。略去的切片项总是以 None 补全。

object.__getitem__(self, key)

调用此方法以实现 self[key] 的未付。 对于 sequence 类型，接受的键应为整数和切片对象。 请注意负数索引（如果类想要模拟 sequence 类型）的特殊解读是依赖于 __getitem__() 方法。 如果 key 的类型不正确，则会引发 TypeError；如果为序列索引集范围以外的值（在进行任何负数索引的特殊解读之后），则应当引发 IndexError。 对于 mapping 类型，如果 key 找不到（不在容器中），则应当引发 KeyError。

注解

for 循环在有不合法索引时会期待捕获 IndexError 以便正确地检测到序列的结束。

注解

当 抽取 一个 class 时，可能会调用特殊类方法 __class_getitem__() 而不是 __getitem__()。 请参阅 __class_getitem__ 与 __getitem__ 了解详情。

object.__setitem__(self, key, value)

调用此方法以实现向 self[key] 赋值。注意事项与 __getitem__() 相同。为对象实现此方法应该仅限于需要映射允许基于键修改值或添加键，或是序列允许元素被替换时。不正确的 key 值所引发的异常应与 __getitem__() 方法的情况相同。

object.__delitem__(self, key)

调用此方法以实现 self[key] 的删除。注意事项与 __getitem__() 相同。为对象实现此方法应该权限于需要映射允许移除键，或是序列允许移除元素时。不正确的 key 值所引发的异常应与 __getitem__() 方法的情况相同。

object.__missing__(self, key)

此方法由 dict.__getitem__() 在找不到字典中的键时调用以实现 dict 子类的 self[key]。

object.__iter__(self)

此方法会在需要为一个容器创建 iterator 时被调用。 此方法应当返回一个新的迭代器对象，它可以对容器中的所有对象执行迭代。 对于映射，它应当对窗口中的键执行迭代。

object.__reversed__(self)

此方法（如果存在）会被 reversed() 内置函数调用以实现逆向迭代。它应当返回一个新的以逆序逐个迭代容器内所有对象的迭代器对象。

如果未提供 __reversed__() 方法，则 reversed() 内置函数将回退到使用序列协议 (__len__() 和 __getitem__())。支持序列协议的对象应当仅在能够提供比 reversed() 所提供的实现更高效的实现时才提供 __reversed__() 方法。

成员检测运算符 (in 和 not in) 通常以对容器进行逐个迭代的方式来实现。 不过，容器对象可以提供以下特殊方法并采用更有效率的实现，这样也不要求对象必须为可迭代对象。

object.__contains__(self, item)

调用此方法以实现成员检测运算符。如果 item 是 self 的成员则应返回真，否则返回假。对于映射类型，此检测应基于映射的键而不是值或者键值对。

对于未定义 __contains__() 的对象，成员检测将首先尝试通过 __iter__() 进行迭代，然后再使用 __getitem__() 的旧式序列迭代协议，参看 语言参考中的相应部分。

3.3.8. 模拟数字类型

定义以下方法即可模拟数字类型。特定种类的数字不支持的运算（例如非整数不能进行位运算）所对应的方法应当保持未定义状态。

object.__add__(self, other)

object.__sub__(self, other)

object.__mul__(self, other)

object.__matmul__(self, other)

object.__truediv__(self, other)

object.__floordiv__(self, other)

object.__mod__(self, other)

object.__divmod__(self, other)

object.__pow__(self, other[, modulo])

object.__lshift__(self, other)

object.__rshift__(self, other)

object.__and__(self, other)

object.__xor__(self, other)

object.__or__(self, other)

调用这些方法来实现二进制算术运算 (+, -, *, @, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |)。例如，求表达式 x + y 的值，其中 x 是具有 __add__() 方法的类的一个实例，则会调用 x.__add__(y)。__divmod__() 方法应该等价于使用 __floordiv__() 和 __mod__()，它不应该被关联到 __truediv__()。请注意如果要支持三元版本的内置 pow() 函数，则 __pow__() 的定义应该接受可选的第三个参数。

如果这些方法中的某一个不支持与所提供参数进行运算，它应该返回 NotImplemented。

object.__radd__(self, other)

object.__rsub__(self, other)

object.__rmul__(self, other)

object.__rmatmul__(self, other)

object.__rtruediv__(self, other)

object.__rfloordiv__(self, other)

object.__rmod__(self, other)

object.__rdivmod__(self, other)

object.__rpow__(self, other[, modulo])

object.__rlshift__(self, other)

object.__rrshift__(self, other)

object.__rand__(self, other)

object.__rxor__(self, other)

object.__ror__(self, other)

调用这些方法来实现具有反射（交换）操作数的二进制算术运算 (+, -, *, @, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |)。这些成员函数仅会在左操作数不支持相应运算 3 且两个操作数类型不同时被调用。4 例如，求表达式 x - y 的值，其中 y 是具有 __rsub__() 方法的类的一个实例，则当 x.__sub__(y) 返回 NotImplemented 时会调用 y.__rsub__(x)。

请注意三元版的 pow() 并不会尝试调用 __rpow__() (因为强制转换规则会太过复杂)。

注解

如果右操作数类型为左操作数类型的一个子类，且该子类提供了指定运算的反射方法，则此方法将先于左操作数的非反射方法被调用。 此行为可允许子类重载其祖先类的运算符。

object.__iadd__(self, other)

object.__isub__(self, other)

object.__imul__(self, other)

object.__imatmul__(self, other)

object.__itruediv__(self, other)

object.__ifloordiv__(self, other)

object.__imod__(self, other)

object.__ipow__(self, other[, modulo])

object.__ilshift__(self, other)

object.__irshift__(self, other)

object.__iand__(self, other)

object.__ixor__(self, other)

object.__ior__(self, other)

调用这些方法来实现扩展算术赋值 (+=, -=, *=, @=, /=, //=, %=, **=, <<=, >>=, &=, ^=, |=)。这些方法应该尝试进行自身操作 (修改 self) 并返回结果 (结果应该但并非必须为 self)。如果某个方法未被定义，相应的扩展算术赋值将回退到普通方法。例如，如果 x 是具有 __iadd__() 方法的类的一个实例，则 x += y 就等价于 x = x.__iadd__(y)。否则就如 x + y 的求值一样选择 x.__add__(y) 和 y.__radd__(x)。在某些情况下，扩展赋值可导致未预期的错误 (参见 为什么 a_tuple[i] += ['item'] 会引发异常？)，但此行为实际上是数据模型的一个组成部分。

object.__neg__(self)

object.__pos__(self)

object.__abs__(self)

object.__invert__(self)

调用此方法以实现一元算术运算 (-, +, abs() 和 ~)。

object.__complex__(self)

object.__int__(self)

object.__float__(self)

调用这些方法以实现内置函数 complex(), int() 和 float()。应当返回一个相应类型的值。

object.__index__(self)

调用此方法以实现 operator.index() 以及 Python 需要无损地将数字对象转换为整数对象的场合（例如切片或是内置的 bin(), hex() 和 oct() 函数)。 存在此方法表明数字对象属于整数类型。 必须返回一个整数。

如果未定义 __int__(), __float__() 和 __complex__() 则相应的内置函数 int(), float() 和 complex() 将回退为 __index__()。

object.__round__(self[, ndigits])

object.__trunc__(self)

object.__floor__(self)

object.__ceil__(self)

调用这些方法以实现内置函数 round() 以及 math 函数 trunc(), floor() 和 ceil()。 除了将 ndigits 传给 __round__() 的情况之外这些方法的返回值都应当是原对象截断为 Integral (通常为 int)。

如果 __int__() 或 __index__() 均未被定义则内置函数 int() 会回退至 __trunc__()。

3.3.9. with 语句上下文管理器

上下文管理器 是一个对象，它定义了在执行 with 语句时要建立的运行时上下文。 上下文管理器处理进入和退出所需运行时上下文以执行代码块。 通常使用 with 语句（在 with 语句 中描述），但是也可以通过直接调用它们的方法来使用。

上下文管理器的典型用法包括保存和恢复各种全局状态，锁定和解锁资源，关闭打开的文件等等。

要了解上下文管理器的更多信息，请参阅 上下文管理器类型。

object.__enter__(self)

进入与此对象相关的运行时上下文。 with 语句将会绑定这个方法的返回值到 as 子句中指定的目标，如果有的话。

object.__exit__(self, exc_type, exc_value, traceback)

退出关联到此对象的运行时上下文。 各个参数描述了导致上下文退出的异常。 如果上下文是无异常地退出的，三个参数都将为 None。

如果提供了异常，并且希望方法屏蔽此异常（即避免其被传播），则应当返回真值。 否则的话，异常将在退出此方法时按正常流程处理。

请注意 __exit__() 方法不应该重新引发被传入的异常，这是调用者的责任。

参见

PEP 343 [https://www.python.org/dev/peps/pep-0343] - "with" 语句

Python with 语句的规范描述、背景和示例。

3.3.10. 定制类模式匹配中的位置参数

当在模式中使用类名称时，默认不允许模式中出现位置参数，例如在 MyClass 没有特别支持的情况下 case MyClass(x, y) 通常是无效的。 要能使用这样的模式，类必须定义一个 __match_args__ 属性。

object.__match_args__

该类变量可以被赋值为一个字符串元组。 当该类被用于带位置参数的类模式时，每个位置参数都将被转换为关键字参数，并使用 __match_args__ 中的对应值作为关键字。 缺失此属性就等价于将其设为 ()。

举例来说，如果 MyClass.__match_args__ 为 ("left", "center", "right") 则意味着 case MyClass(x, y) 就等价于 case MyClass(left=x, center=y)。 请注意模式中参数的数量必须小于等于 __match_args__ 中元素的数量；如果前者大于后者，则尝试模式匹配时将引发 TypeError。

3.10 新版功能.

参见

PEP 634 [https://www.python.org/dev/peps/pep-0634] - 结构化模式匹配

有关 Python match 语句的规范说明。

3.3.11. 特殊方法查找

对于自定义类来说，特殊方法的隐式唤起仅保证在其定义于对象类型中时能正确地发挥作用，而不能定义在对象实例字典中。 该行为就是以下代码会引发异常的原因。:

>>> 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()

此行为背后的原理在于包括类型对象在内的所有对象都会实现的几个特殊方法如 __hash__() 和 __repr__()。 如果这些方法的隐式查找使用了传统的查找过程，则当它们在针对类型对象自身被唤起时将会失败:

>>> 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

以这种方式不正确地尝试唤起一个类的未绑定方法有时被称为‘元类混淆’，可以通过在查找特殊方法时绕过实例的方式来避免:

>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True

除了出于正确性考虑而会绕过任何实例属性，隐式特殊方法查找通常还会绕过 __getattribute__() 方法，甚至包括对象的元类:

>>> 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__()                 # Explicit lookup via instance
Class getattribute invoked
10
>>> type(c).__len__(c)          # Explicit lookup via type
Metaclass getattribute invoked
10
>>> len(c)                      # Implicit lookup
10

以这种方式绕过 __getattribute__() 机制为解释器内部的速度优化提供了显著的空间，其代价则是牺牲了一些处理特殊方法时的灵活性（特殊方法 must 必须设置在类对象自身上以便始终一致地由解释器唤起）。

3.4. 协程

3.4.1. 可等待对象

awaitable 对象主要实现了 __await__() 方法。 从 async def 函数返回的 协程对象 即为可等待对象。

注解

从带有 types.coroutine() 或 asyncio.coroutine() 装饰器的生成器返回的 generator iterator 对象也属于可等待对象，但它们并未实现 __await__()。

object.__await__(self)

必须返回一个 iterator。 应当被用来实现 awaitable 对象。 例如，asyncio.Future 实现了此方法以与 await 表达式相兼容。

注解

本语言不会对 __await__ 所返回的迭代器产生的对象的类型或值施加任何限制，因为这是负责管理 awaitable 对象的异步执行框架的具体实现 (如 asyncio) 专属特性。

3.5 新版功能.

参见

PEP 492 [https://www.python.org/dev/peps/pep-0492] 了解有关可等待对象的详细信息。

3.4.2. 协程对象

协程对象 属于 awaitable 对象。 协程的执行可以通过调用 __await__() 并迭代其结果来控制。 当协程结束执行并返回时，迭代器会引发 StopIteration，而该异常的 value 属性将存放返回值。 如果协程引发了异常，它会被迭代器传播出去。 协程不应当直接引发未被处理的 StopIteration 异常。

协程也具有下面列出的方法，它们类似于生成器的对应方法 (参见 生成器-迭代器的方法)。 但是，与生成器不同，协程并不直接支持迭代。

在 3.5.2 版更改: 等待一个协程超过一次将引发 RuntimeError。

coroutine.send(value)

开始或恢复协程的执行。 如果 value 为 None，那么这就相当于前往 __await__() 所返回迭代器的下一项。 如果 value 不为 None，此方法将委托给导致协程挂起的迭代器的 send() 方法。 其结果（返回值，StopIteration 或是其他异常）将与上述对 __await__() 返回值进行迭代的结果相同。

coroutine.throw(value)

coroutine.throw(type[, value[, traceback]])

在协程内引发指定的异常。 此方法将委托给导致该协程挂起的迭代器的 throw() 方法，如果存在此方法的话。 否则，该异常将在挂起点被引发。 其结果（返回值，StopIteration 或是其他异常）将与上述对 __await__() 返回值进行迭代的结果相同。 如果该异常未在协程内被捕获，则将回传给调用方。

coroutine.close()

此方法会使得协程清理自身并退出。 如果协程被挂起，此方法会先委托给导致协程挂起的迭代器的 close() 方法，如果存在该方法。 然后它会在挂起点引发 GeneratorExit，使得协程立即清理自身。 最后，协程会被标记为已结束执行，即使它根本未被启动。

当协程对象将要被销毁时，会使用以上处理过程来自动关闭。

3.4.3. 异步迭代器

异步迭代器 可以在其 __anext__ 方法中调用异步代码。

异步迭代器可在 async for 语句中使用。

object.__aiter__(self)

必须返回一个 异步迭代器 对象。

object.__anext__(self)

必须返回一个 可等待对象 输出迭代器的下一结果值。 当迭代结束时应该引发 StopAsyncIteration 错误。

异步可迭代对象的一个示例:

class Reader:
    async def readline(self):
        ...

    def __aiter__(self):
        return self

    async def __anext__(self):
        val = await self.readline()
        if val == b'':
            raise StopAsyncIteration
        return val

3.5 新版功能.

在 3.7 版更改: 在 Python 3.7 之前，__aiter__() 可以返回一个 可等待对象 并将被解析为 异步迭代器。

从 Python 3.7 开始，__aiter__() 必须返回一个异步迭代器对象。 返回任何其他对象都将导致 TypeError 错误。

3.4.4. 异步上下文管理器

异步上下文管理器 是 上下文管理器 的一种，它能够在其 __aenter__ 和 __aexit__ 方法中暂停执行。

异步上下文管理器可在 async with 语句中使用。

object.__aenter__(self)

在语义上类似于 __enter__()，仅有的区别是它必须返回一个 可等待对象。

object.__aexit__(self, exc_type, exc_value, traceback)

在语义上类似于 __exit__()，仅有的区别是它必须返回一个 可等待对象。

异步上下文管理器类的一个示例:

class AsyncContextManager:
    async def __aenter__(self):
        await log('entering context')

    async def __aexit__(self, exc_type, exc, tb):
        await log('exiting context')

3.5 新版功能.

备注

1

在某些情况下 有可能 基于可控的条件改变一个对象的类型。 但这通常不是个好主意，因为如果处理不当会导致一些非常怪异的行为。

2

__hash__(), __iter__(), __reversed__() 以及 __contains__() 方法对此有特殊处理；其他方法仍会引发 TypeError，但可能依赖 None 属于不可调用对象的行为来做到这一点。

3

这里的“不支持”是指该类无此方法，或方法返回 NotImplemented。 如果你想强制回退到右操作数的反射方法，请不要设置方法为 None — 那会造成显式地 阻塞 此种回退的相反效果。

4

对于相同类型的操作数，如果非返回方法 -- 例如 __add__() -- 失败则会认为整个运算都不被支持，这就是反射方法不会被调用的原因。

4. 执行模型

4.1. 程序的结构

Python 程序是由代码块构成的。 代码块 是被作为一个单元来执行的一段 Python 程序文本。 以下几个都属于代码块：模块、函数体和类定义。 交互式输入的每条命令都是代码块。 一个脚本文件（作为标准输入发送给解释器或是作为命令行参数发送给解释器的文件）也是代码块。 一条脚本命令（通过 -c 选项在解释器命令行中指定的命令）也是代码块。 通过在命令行中使用 -m 参数作为最高层级脚本（即 __main__ 模块）运行的模块也是代码块。 传递给内置函数 eval() 和 exec() 的字符串参数也是代码块。

代码块在 执行帧 中被执行。 一个帧会包含某些管理信息（用于调试）并决定代码块执行完成后应前往何处以及如何继续执行。

4.2. 命名与绑定

4.2.1. 名称的绑定

名称 用于指代对象。 名称是通过名称绑定操作来引入的。

下面的结构将名字绑定:

函数的正式参数，

类定义，

函数定义，

赋值表达式,

如果在一个赋值中出现，则为标识符的 目标 :

for 循环头,

在 as 后面的 with 语句， except 子句或结构模式匹配中的 as 模式。

在结构模式匹配中的捕获模式

import 语句。

形式为 from ... import * 的 import 语句绑定所有在导入的模块中定义的名字，除了那些以下划线开头的名字。这种形式只能在模块级别上使用。

del 语句的目标也被视作一种绑定（虽然其实际语义为解除名称绑定）。

每条赋值或导入语句均发生于类或函数内部定义的代码块中，或是发生于模块层级（即最高层级的代码块）。

如果名称绑定在一个代码块中，则为该代码块的局部变量，除非声明为 nonlocal 或 global。 如果名称绑定在模块层级，则为全局变量。 (模块代码块的变量既为局部变量又为全局变量。) 如果变量在一个代码块中被使用但不是在其中定义，则为 自由变量。

每个在程序文本中出现的名称是指由以下名称解析规则所建立的对该名称的 绑定。

4.2.2. 名称的解析

作用域 定义了一个代码块中名称的可见性。 如果代码块中定义了一个局部变量，则其作用域包含该代码块。 如果定义发生于函数代码块中，则其作用域会扩展到该函数所包含的任何代码块，除非有某个被包含代码块引入了对该名称的不同绑定。

当一个名称在代码块中被使用时，会由包含它的最近作用域来解析。 对一个代码块可见的所有这种作用域的集合称为该代码块的 环境。

当一个名称完全找不到时，将会引发 NameError 异常。 如果当前作用域为函数作用域，且该名称指向一个局部变量，而此变量在该名称被使用的时候尚未绑定到特定值，将会引发 UnboundLocalError 异常。 UnboundLocalError 为 NameError 的一个子类。

如果一个代码块内的任何位置发生名称绑定操作，则代码块内所有对该名称的使用都会被视为对当前代码块的引用。 当一个名称在其被绑定前就在代码块内被使用时将会导致错误。 这个规则是很微妙的。 Python 缺少声明语法并且允许名称绑定操作发生于代码块内的任何位置。 一个代码块的局部变量可通过在整个代码块文本中扫描名称绑定操作来确定。 请参阅 UnboundLocalError 的 FAQ 条目 来获取示例。

如果 global 语句出现在一个代码块中，则所有对该语句所指定名称的使用都是在最高层级命名空间内对该名称绑定的引用。 名称在最高层级命名内的解析是通过全局命名空间，也就是包含该代码块的模块的命名空间，以及内置命名空间即 builtins 模块的命名空间。 全局命名空间会先被搜索。 如果未在其中找到指定名称，再搜索内置命名空间。 global 语句必须位于所有对其所列出名称的使用之前。

global 语句与同一代码块中名称绑定具有相同的作用域。 如果一个自由变量的最近包含作用域中有一条 global 语句，则该自由变量也会被当作是全局变量。

nonlocal 语句会使得相应的名称指向之前在最近包含函数作用域中绑定的变量。 如果指定名称不存在于任何包含函数作用域中则将在编译时引发 SyntaxError。

模块的作用域会在模块第一次被导入时自动创建。 一个脚本的主模块总是被命名为 __main__。

类定义代码块以及传给 exec() 和 eval() 的参数是名称解析上下文中的特殊情况。 类定义是可能使用并定义名称的可执行语句。 这些引用遵循正常的名称解析规则，例外之处在于未绑定的局部变量将会在全局命名空间中查找。 类定义的命名空间会成为该类的属性字典。 在类代码块中定义的名称的作用域会被限制在类代码块中；它不会扩展到方法的代码块中 -- 这也包括推导式和生成器表达式，因为它们都是使用函数作用域实现的。 这意味着以下代码将会失败:

class A:
    a = 42
    b = list(a + i for i in range(10))

4.2.3. 内置命名空间和受限的执行

CPython 实现细节： 用户不应该接触 __builtins__，严格说来它属于实现细节。 用户如果要重载内置命名空间中的值则应该 import builtins 并相应地修改该模块中的属性。

与一个代码块的执行相关联的内置命名空间实际上是通过在其全局命名空间中搜索名称 __builtins__ 来找到的；这应该是一个字典或一个模块（在后一种情况下会使用该模块的字典）。 默认情况下，当在 __main__ 模块中时，__builtins__ 就是内置模块 builtins；当在任何其他模块中时，__builtins__ 则是 builtins 模块自身的字典的一个别名。

4.2.4. 与动态特性的交互

自由变量的名称解析发生于运行时而不是编译时。 这意味着以下代码将打印出 42:

i = 10
def f():
    print(i)
i = 42
f()

eval() 和 exec() 函数没有对完整环境的访问权限来解析名称。 名称可以在调用者的局部和全局命名空间中被解析。 自由变量的解析不是在最近包含命名空间中，而是在全局命名空间中。 1 exec() 和 eval() 函数有可选参数用来重载全局和局部命名空间。 如果只指定一个命名空间，则它会同时作用于两者。

4.3. 异常

异常是中断代码块的正常控制流程以便处理错误或其他异常条件的一种方式。 异常会在错误被检测到的位置 引发，它可以被当前包围代码块或是任何直接或间接唤起发生错误的代码块的其他代码块所 处理。

Python 解析器会在检测到运行时错误（例如零作为被除数）的时候引发异常。 Python 程序也可以通过 raise 语句显式地引发异常。 异常处理是通过 try ... except 语句来指定的。 该语句的 finally 子句可被用来指定清理代码，它并不处理异常，而是无论之前的代码是否发生异常都会被执行。

Python 的错误处理采用的是“终止”模型：异常处理器可以找出发生了什么问题，并在外层继续执行，但它不能修复错误的根源并重试失败的操作（除非通过从顶层重新进入出错的代码片段）。

当一个异常完全未被处理时，解释器会终止程序的执行，或者返回交互模式的主循环。 无论是哪种情况，它都会打印栈回溯信息，除非是当异常为 SystemExit 的时候。

异常是通过类实例来标识的。 except 子句会依据实例的类来选择：它必须引用实例的类或是其所属的 非虚基类 。 实例可通过处理器被接收，并可携带有关异常条件的附加信息。

注解

异常消息不是 Python API 的组成部分。 其内容可能在 Python 升级到新版本时不经警告地发生改变，不应该被需要在多版本解释器中运行的代码所依赖。

另请参看 try 语句 小节中对 try 语句的描述以及 raise 语句 小节中对 raise 语句的描述。

备注

1

出现这样的限制是由于通过这些操作执行的代码在模块被编译的时候并不可用。

5. 导入系统

一个 module 内的 Python 代码通过 importing 操作就能够访问另一个模块内的代码。 import 语句是唤起导入机制的最常用方式，但不是唯一的方式。 importlib.import_module() 以及内置的 __import__() 等函数也可以被用来唤起导入机制。

import 语句结合了两个操作；它先搜索指定名称的模块，然后将搜索结果绑定到当前作用域中的名称。 import 语句的搜索操作被定义为对 __import__() 函数的调用并带有适当的参数。 __import__() 的返回值会被用于执行 import 语句的名称绑定操作。 请参阅 import 语句了解名称绑定操作的更多细节。

对 __import__() 的直接调用将仅执行模块搜索以及在找到时的模块创建操作。 不过也可能产生某些副作用，例如导入父包和更新各种缓存 (包括 sys.modules)，只有 import 语句会执行名称绑定操作。

当 import 语句被执行时，标准的内置 __import__() 函数会被调用。 其他唤起导入系统的机制 (例如 importlib.import_module()) 可能会选择绕过 __import__() 并使用它们自己的解决方案来实现导入机制。

当一个模块首次被导入时，Python 会搜索该模块，如果找到就创建一个 module 对象 1 并初始化它。 如果指定名称的模块未找到，则会引发 ModuleNotFoundError。 当唤起导入机制时，Python 会实现多种策略来搜索指定名称的模块。 这些策略可以通过使用使用下文所描述的多种钩子来加以修改和扩展。

在 3.3 版更改: 导入系统已被更新以完全实现 PEP 302 [https://www.python.org/dev/peps/pep-0302] 中的第二阶段要求。 不会再有任何隐式的导入机制 —— 整个导入系统都通过 sys.meta_path 暴露出来。 此外，对原生命名空间包的支持也已被实现 (参见 PEP 420 [https://www.python.org/dev/peps/pep-0420])。

5.1. importlib

importlib 模块提供了一个丰富的 API 用来与导入系统进行交互。 例如 importlib.import_module() 提供了相比内置的 __import__() 更推荐、更简单的 API 用来唤起导入机制。 更多细节请参看 importlib 库文档。

5.2. 包

Python 只有一种模块对象类型，所有模块都属于该类型，无论模块是用 Python、C 还是别的语言实现。 为了帮助组织模块并提供名称层次结构，Python 还引入了 包 的概念。

你可以把包看成是文件系统中的目录，并把模块看成是目录中的文件，但请不要对这个类比做过于字面的理解，因为包和模块不是必须来自于文件系统。 为了方便理解本文档，我们将继续使用这种目录和文件的类比。 与文件系统一样，包通过层次结构进行组织，在包之内除了一般的模块，还可以有子包。

要注意的一个重点概念是所有包都是模块，但并非所有模块都是包。 或者换句话说，包只是一种特殊的模块。 特别地，任何具有 __path__ 属性的模块都会被当作是包。

所有模块都有自己的名字。 子包名与其父包名会以点号分隔，与 Python 的标准属性访问语法一致。 因此你可能会有一个名为 email 的包，这个包中又有一个名为 email.mime 的子包以及该子包中的名为 email.mime.text 的子包。

5.2.1. 常规包

Python 定义了两种类型的包，常规包 和 命名空间包。 常规包是传统的包类型，它们在 Python 3.2 及之前就已存在。 常规包通常以一个包含 __init__.py 文件的目录形式实现。 当一个常规包被导入时，这个 __init__.py 文件会隐式地被执行，它所定义的对象会被绑定到该包命名空间中的名称。__init__.py 文件可以包含与任何其他模块中所包含的 Python 代码相似的代码，Python 将在模块被导入时为其添加额外的属性。

例如，以下文件系统布局定义了一个最高层级的 parent 包和三个子包:

parent/
    __init__.py
    one/
        __init__.py
    two/
        __init__.py
    three/
        __init__.py

导入 parent.one 将隐式地执行 parent/__init__.py 和 parent/one/__init__.py。 后续导入 parent.two 或 parent.three 则将分别执行 parent/two/__init__.py 和 parent/three/__init__.py。

5.2.2. 命名空间包

命名空间包是由多个 部分 构成的，每个部分为父包增加一个子包。 各个部分可能处于文件系统的不同位置。 部分也可能处于 zip 文件中、网络上，或者 Python 在导入期间可以搜索的其他地方。 命名空间包并不一定会直接对应到文件系统中的对象；它们有可能是无实体表示的虚拟模块。

命名空间包的 __path__ 属性不使用普通的列表。 而是使用定制的可迭代类型，如果其父包的路径 (或者最高层级包的 sys.path) 发生改变，这种对象会在该包内的下一次导入尝试时自动执行新的对包部分的搜索。

命名空间包没有 parent/__init__.py 文件。 实际上，在导入搜索期间可能找到多个 parent 目录，每个都由不同的部分所提供。 因此 parent/one 的物理位置不一定与 parent/two 相邻。 在这种情况下，Python 将为顶级的 parent 包创建一个命名空间包，无论是它本身还是它的某个子包被导入。

另请参阅 PEP 420 [https://www.python.org/dev/peps/pep-0420] 了解对命名空间包的规格描述。

5.3. 搜索

为了开始搜索，Python 需要被导入模块（或者包，对于当前讨论来说两者没有差别）的完整 限定名称。 此名称可以来自 import 语句所带的各种参数，或者来自传给 importlib.import_module() 或 __import__() 函数的形参。

此名称会在导入搜索的各个阶段被使用，它也可以是指向一个子模块的带点号路径，例如 foo.bar.baz。 在这种情况下，Python 会先尝试导入 foo，然后是 foo.bar，最后是 foo.bar.baz。 如果这些导入中的任何一个失败，都会引发 ModuleNotFoundError。

5.3.1. 模块缓存

在导入搜索期间首先会被检查的地方是 sys.modules。 这个映射起到缓存之前导入的所有模块的作用（包括其中间路径）。 因此如果之前导入过 foo.bar.baz，则 sys.modules 将包含 foo, foo.bar 和 foo.bar.baz 条目。 每个键的值就是相应的模块对象。

在导入期间，会在 sys.modules 查找模块名称，如存在则其关联的值就是需要导入的模块，导入过程完成。 然而，如果值为 None，则会引发 ModuleNotFoundError。 如果找不到指定模块名称，Python 将继续搜索该模块。

sys.modules 是可写的。删除键可能不会破坏关联的模块（因为其他模块可能会保留对它的引用），但它会使命名模块的缓存条目无效，导致 Python 在下次导入时重新搜索命名模块。键也可以赋值为 None ，强制下一次导入模块导致 ModuleNotFoundError 。

但是要小心，因为如果你还保有对某个模块对象的引用，同时停用其在 sys.modules 中的缓存条目，然后又再次导入该名称的模块，则前后两个模块对象将 不是 同一个。 相反地，importlib.reload() 将重用 同一个 模块对象，并简单地通过重新运行模块的代码来重新初始化模块内容。

5.3.2. 查找器和加载器

如果指定名称的模块在 sys.modules 找不到，则将唤起 Python 的导入协议以查找和加载该模块。 此协议由两个概念性模块构成，即 查找器 和 加载器。 查找器的任务是确定是否能使用其所知的策略找到该名称的模块。 同时实现这两种接口的对象称为 导入器 —— 它们在确定能加载所需的模块时会返回其自身。

Python 包含了多个默认查找器和导入器。 第一个知道如何定位内置模块，第二个知道如何定位冻结模块。 第三个默认查找器会在 import path 中搜索模块。 import path 是一个由文件系统路径或 zip 文件组成的位置列表。 它还可以扩展为搜索任意可定位资源，例如由 URL 指定的资源。

导入机制是可扩展的，因此可以加入新的查找器以扩展模块搜索的范围和作用域。

查找器并不真正加载模块。 如果它们能找到指定名称的模块，会返回一个 模块规格说明，这是对模块导入相关信息的封装，供后续导入机制用于在加载模块时使用。

以下各节描述了有关查找器和加载器协议的更多细节，包括你应该如何创建并注册新的此类对象来扩展导入机制。

在 3.4 版更改: 在之前的 Python 版本中，查找器会直接返回 加载器，现在它们则返回模块规格说明，其中 包含 加载器。 加载器仍然在导入期间被使用，但负担的任务有所减少。

5.3.3. 导入钩子

导入机制被设计为可扩展；其中的基本机制是 导入钩子。 导入钩子有两种类型: 元钩子 和 导入路径钩子。

元钩子在导入过程开始时被调用，此时任何其他导入过程尚未发生，但 sys.modules 缓存查找除外。 这允许元钩子重载 sys.path 过程、冻结模块甚至内置模块。 元钩子的注册是通过向 sys.meta_path 添加新的查找器对象，具体如下所述。

导入路径钩子是作为 sys.path (或 package.__path__) 过程的一部分，在遇到它们所关联的路径项的时候被调用。 导入路径钩子的注册是通过向 sys.path_hooks 添加新的可调用对象，具体如下所述。

5.3.4. 元路径

当指定名称的模块在 sys.modules 中找不到时，Python 会接着搜索 sys.meta_path，其中包含元路径查找器对象列表。 这些查找器按顺序被查询以确定它们是否知道如何处理该名称的模块。 元路径查找器必须实现名为 find_spec() 的方法，该方法接受三个参数：名称、导入路径和目标模块（可选）。 元路径查找器可使用任何策略来确定它是否能处理指定名称的模块。

如果元路径查找器知道如何处理指定名称的模块，它将返回一个说明对象。 如果它不能处理该名称的模块，则会返回 None。 如果 sys.meta_path 处理过程到达列表末尾仍未返回说明对象，则将引发 ModuleNotFoundError。 任何其他被引发异常将直接向上传播，并放弃导入过程。

元路径查找器的 find_spec() 方法调用带有两到三个参数。 第一个是被导入模块的完整限定名称，例如 foo.bar.baz。 第二个参数是供模块搜索使用的路径条目。 对于最高层级模块，第二个参数为 None，但对于子模块或子包，第二个参数为父包 __path__ 属性的值。 如果相应的 __path__ 属性无法访问，将引发 ModuleNotFoundError。 第三个参数是一个将被作为稍后加载目标的现有模块对象。 导入系统仅会在重加载期间传入一个目标模块。

对于单个导入请求可以多次遍历元路径。 例如，假设所涉及的模块都尚未被缓存，则导入 foo.bar.baz 将首先执行顶级的导入，在每个元路径查找器 (mpf) 上调用 mpf.find_spec("foo", None, None)。 在导入 foo 之后，foo.bar 将通过第二次遍历元路径来导入，调用 mpf.find_spec("foo.bar", foo.__path__, None)。 一旦 foo.bar 完成导入，最后一次遍历将调用 mpf.find_spec("foo.bar.baz", foo.bar.__path__, None)。

有些元路径查找器只支持顶级导入。 当把 None 以外的对象作为第三个参数传入时，这些导入器将总是返回 None。

Python 的默认 sys.meta_path 具有三种元路径查找器，一种知道如何导入内置模块，一种知道如何导入冻结模块，还有一种知道如何导入来自 import path 的模块 (即 path based finder)。

在 3.4 版更改: 元路径查找器的 find_spec() 方法替代了 find_module()，后者现已弃用，它将继续可用但不会再做改变，导入机制仅会在查找器未实现 find_spec() 时尝试使用它。

在 3.10 版更改: 导入系统使用 find_module() 现在将会引发 ImportWarning。

5.4. 加载

当一个模块说明被找到时，导入机制将在加载该模块时使用它（及其所包含的加载器）。 下面是导入的加载部分所发生过程的简要说明:

module = None
if spec.loader is not None and hasattr(spec.loader, 'create_module'):
    # It is assumed 'exec_module' will also be defined on the loader.
    module = spec.loader.create_module(spec)
if module is None:
    module = ModuleType(spec.name)
# The import-related module attributes get set here:
_init_module_attrs(spec, module)

if spec.loader is None:
    # unsupported
    raise ImportError
if spec.origin is None and spec.submodule_search_locations is not None:
    # namespace package
    sys.modules[spec.name] = module
elif not hasattr(spec.loader, 'exec_module'):
    module = spec.loader.load_module(spec.name)
    # Set __loader__ and __package__ if missing.
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]

请注意以下细节:

如果在 sys.modules 中存在指定名称的模块对象，导入操作会已经将其返回。

在加载器执行模块代码之前，该模块将存在于 sys.modules 中。 这一点很关键，因为该模块代码可能（直接或间接地）导入其自身；预先将其添加到 sys.modules 可防止在最坏情况下的无限递归和最好情况下的多次加载。

如果加载失败，则该模块 -- 只限加载失败的模块 -- 将从 sys.modules 中移除。 任何已存在于 sys.modules 缓存的模块，以及任何作为附带影响被成功加载的模块仍会保留在缓存中。 这与重新加载不同，后者会把即使加载失败的模块也保留在 sys.modules 中。

在模块创建完成但还未执行之前，导入机制会设置导入相关模块属性（在上面的示例伪代码中为 “_init_module_attrs”），详情参见 后续部分。

模块执行是加载的关键时刻，在此期间将填充模块的命名空间。 执行会完全委托给加载器，由加载器决定要填充的内容和方式。

在加载过程中创建并传递给 exec_module() 的模块并不一定就是在导入结束时返回的模块 2。

在 3.4 版更改: 导入系统已经接管了加载器建立样板的责任。 这些在以前是由 importlib.abc.Loader.load_module() 方法来执行的。

5.4.1. 加载器

模块加载器提供关键的加载功能：模块执行。 导入机制调用 importlib.abc.Loader.exec_module() 方法并传入一个参数来执行模块对象。 从 exec_module() 返回的任何值都将被忽略。

加载器必须满足下列要求:

如果模块是一个 Python 模块（而非内置模块或动态加载的扩展），加载器应该在模块的全局命名空间 (module.__dict__) 中执行模块的代码。

如果加载器无法执行指定模块，它应该引发 ImportError，不过在 exec_module() 期间引发的任何其他异常也会被传播。

在许多情况下，查找器和加载器可以是同一对象；在此情况下 find_spec() 方法将返回一个规格说明，其中加载器会被设为 self。

模块加载器可以选择通过实现 create_module() 方法在加载期间创建模块对象。 它接受一个参数，即模块规格说明，并返回新的模块对象供加载期间使用。 create_module() 不需要在模块对象上设置任何属性。 如果模块返回 None，导入机制将自行创建新模块。

3.4 新版功能: 加载器的 create_module() 方法。

在 3.4 版更改: load_module() 方法被 exec_module() 所替代，导入机制会对加载的所有样板责任作出假定。

为了与现有的加载器兼容，导入机制会使用导入器的 load_module() 方法，如果它存在且导入器也未实现 exec_module()。 但是，load_module() 现已弃用，加载器应该转而实现 exec_module()。

除了执行模块之外，load_module() 方法必须实现上文描述的所有样板加载功能。 所有相同的限制仍然适用，并带有一些附加规定:

如果 sys.modules 中存在指定名称的模块对象，加载器必须使用已存在的模块。 （否则 importlib.reload() 将无法正确工作。） 如果该名称模块不存在于 sys.modules 中，加载器必须创建一个新的模块对象并将其加入 sys.modules。

在加载器执行模块代码之前，模块 必须 存在于 sys.modules 之中，以防止无限递归或多次加载。

如果加载失败，加载器必须移除任何它已加入到 sys.modules 中的模块，但它必须 仅限 移除加载失败的模块，且所移除的模块应为加载器自身显式加载的。

在 3.5 版更改: 当 exec_module() 已定义但 create_module() 未定义时将引发 DeprecationWarning。

在 3.6 版更改: 当 exec_module() 已定义但 create_module() 未定义时将引发 ImportError。

在 3.10 版更改: 使用 load_module() 将引发 ImportWarning。

5.4.2. 子模块

当使用任意机制 (例如 importlib API, import 及 import-from 语句或者内置的 __import__()) 加载一个子模块时，父模块的命名空间中会添加一个对子模块对象的绑定。 例如，如果包 spam 有一个子模块 foo，则在导入 spam.foo 之后，spam 将具有一个 绑定到相应子模块的 foo 属性。 假如现在有如下的目录结构:

spam/
    __init__.py
    foo.py

并且 spam/__init__.py 中有如下几行内容:

from .foo import Foo

那么执行如下代码将把 foo 和 Foo 的名称绑定添加到 spam 模块中:

>>> import spam
>>> spam.foo
<module 'spam.foo' from '/tmp/imports/spam/foo.py'>
>>> spam.Foo
<class 'spam.foo.Foo'>

按照通常的 Python 名称绑定规则，这看起来可能会令人惊讶，但它实际上是导入系统的一个基本特性。 保持不变的一点是如果你有 sys.modules['spam'] 和 sys.modules['spam.foo'] (例如在上述导入之后就是如此)，则后者必须显示为前者的 foo 属性。

5.4.3. 模块规格说明

导入机制在导入期间会使用有关每个模块的多种信息，特别是加载之前。 大多数信息都是所有模块通用的。 模块规格说明的目的是基于每个模块来封装这些导入相关信息。

在导入期间使用规格说明可允许状态在导入系统各组件之间传递，例如在创建模块规格说明的查找器和执行模块的加载器之间。 最重要的一点是，它允许导入机制执行加载的样板操作，在没有模块规格说明的情况下这是加载器的责任。

模块的规格说明会作为模块对象的 __spec__ 属性对外公开。 有关模块规格的详细内容请参阅 ModuleSpec。

3.4 新版功能.

5.4.4. 导入相关的模块属性

导入机制会在加载期间会根据模块的规格说明填充每个模块对象的这些属性，并在加载器执行模块之前完成。

__name__

__name__ 属性必须被设为模块的完整限定名称。 此名称被用来在导入系统中唯一地标识模块。

__loader__

__loader__ 属性必须被设为导入系统在加载模块时使用的加载器对象。 这主要是用于内省，但也可用于额外的加载器专用功能，例如获取关联到加载器的数据。

__package__

模块的 __package__ 属性必须设定。 其取值必须为一个字符串，但可以与 __name__ 取相同的值。 当模块是包时，其 __package__ 值应该设为其 __name__ 值。 当模块不是包时，对于最高层级模块 __package__ 应该设为空字符串，对于子模块则应该设为其父包名。 更多详情可参阅 PEP 366 [https://www.python.org/dev/peps/pep-0366]。

该属性取代 __name__ 被用来为主模块计算显式相对导入，相关定义见 PEP 366 [https://www.python.org/dev/peps/pep-0366]。 预期它与 __spec__.parent 具有相同的值。

在 3.6 版更改: __package__ 预期与 __spec__.parent 具有相同的值。

__spec__

__spec__ 属性必须设为在导入模块时要使用的模块规格说明。 对 __spec__ 的正确设定将同时作用于 解释器启动期间初始化的模块。 唯一的例外是 __main__，其中的 __spec__ 会 在某些情况下设为 None.

当 __package__ 未定义时， __spec__.parent 会被用作回退项。

3.4 新版功能.

在 3.6 版更改: 当 __package__ 未定义时，__spec__.parent 会被用作回退项。

__path__

如果模块为包（不论是正规包还是命名空间包），则必须设置模块对象的 __path__ 属性。 属性值必须为可迭代对象，但如果 __path__ 没有进一步的用处则可以为空。 如果 __path__ 不为空，则在迭代时它应该产生字符串。 有关 __path__ 语义的更多细节将在 下文 中给出。

不是包的模块不应该具有 __path__ 属性。

__file__

__cached__

__file__ 是可选项。 如果设置，此属性的值必须为字符串。 导入系统可以选择在其没有语法意义时不设置 __file__ (例如从数据库加载的模块)。

如果设置了 __file__，则也可以再设置 __cached__ 属性，后者取值为编译版本代码（例如字节码文件）所在的路径。 设置此属性不要求文件已存在；该路径可以简单地指向应该存放编译文件的位置 (参见 PEP 3147 [https://www.python.org/dev/peps/pep-3147])。

当未设置 __file__ 时也可以设置 __cached__。 但是，那样的场景很不典型。 最终，加载器会使用 __file__ 和/或 __cached__。 因此如果一个加载器可以从缓存加载模块但是不能从文件加载，那种非典型场景就是适当的。

5.4.5. module.__path__

根据定义，如果一个模块具有 __path__ 属性，它就是包。

包的 __path__ 属性会在导入其子包期间被使用。 在导入机制内部，它的功能与 sys.path 基本相同，即在导入期间提供一个模块搜索位置列表。 但是，__path__ 通常会比 sys.path 受到更多限制。

__path__ 必须是由字符串组成的可迭代对象，但它也可以为空。 作用于 sys.path 的规则同样适用于包的 __path__，并且 sys.path_hooks (见下文) 会在遍历包的 __path__ 时被查询。

包的 __init__.py 文件可以设置或更改包的 __path__ 属性，而且这是在 PEP 420 [https://www.python.org/dev/peps/pep-0420] 之前实现命名空间包的典型方式。 随着 PEP 420 [https://www.python.org/dev/peps/pep-0420] 的引入，命名空间包不再需要提供仅包含 __path__ 操控代码的 __init__.py 文件；导入机制会自动为命名空间包正确地设置 __path__。

5.4.6. 模块的 repr

默认情况下，全部模块都具有一个可用的 repr，但是你可以依据上述的属性设置，在模块的规格说明中更为显式地控制模块对象的 repr。

如果模块具有 spec (__spec__)，导入机制将尝试用它来生成一个 repr。 如果生成失败或找不到 spec，导入系统将使用模块中的各种可用信息来制作一个默认 repr。 它将尝试使用 module.__name__, module.__file__ 以及 module.__loader__ 作为 repr 的输入，并将任何丢失的信息赋为默认值。

以下是所使用的确切规则:

如果模块具有 __spec__ 属性，其中的规格信息会被用来生成 repr。 被查询的属性有 "name", "loader", "origin" 和 "has_location" 等等。

如果模块具有 __file__ 属性，这会被用作模块 repr 的一部分。

如果模块没有 __file__ 但是有 __loader__ 且取值不为 None，则加载器的 repr 会被用作模块 repr 的一部分。

对于其他情况，仅在 repr 中使用模块的 __name__。

在 3.4 版更改: loader.module_repr() 已弃用，导入机制现在使用模块规格说明来生成模块 repr。

为了向后兼容 Python 3.3，如果加载器定义了 module_repr() 方法，则会在尝试上述两种方式之前先调用该方法来生成模块 repr。 但请注意此方法已弃用。

在 3.10 版更改: 对 module_repr() 的调用现在会在尝试使用模块的 __spec__ 属性之后但在回退至 __file__ 之前发生。 module_repr() 的使用预定会在 Python 3.12 中停止。

5.4.7. 已缓存字节码的失效

在 Python 从 .pyc 文件加载已缓存字节码之前，它会检查缓存是否由最新的 .py 源文件所生成。 默认情况下，Python 通过在所写入缓存文件中保存源文件的最新修改时间戳和大小来实现这一点。 在运行时，导入系统会通过比对缓存文件中保存的元数据和源文件的元数据确定该缓存的有效性。

Python 也支持“基于哈希的”缓存文件，即保存源文件内容的哈希值而不是其元数据。 存在两种基于哈希的 .pyc 文件：检查型和非检查型。 对于检查型基于哈希的 .pyc 文件，Python 会通过求哈希源文件并将结果哈希值与缓存文件中的哈希值比对来确定缓存有效性。 如果检查型基于哈希的缓存文件被确定为失效，Python 会重新生成并写入一个新的检查型基于哈希的缓存文件。 对于非检查型 .pyc 文件，只要其存在 Python 就会直接认定缓存文件有效。 确定基于哈希的 .pyc 文件有效性的行为可通过 --check-hash-based-pycs 旗标来重载。

在 3.7 版更改: 增加了基于哈希的 .pyc 文件。在此之前，Python 只支持基于时间戳来确定字节码缓存的有效性。

5.5. 基于路径的查找器

在之前已经提及，Python 带有几种默认的元路径查找器。 其中之一是 path based finder (PathFinder)，它会搜索包含一个 路径条目 列表的 import path。 每个路径条目指定一个用于搜索模块的位置。

基于路径的查找器自身并不知道如何进行导入。 它只是遍历单独的路径条目，将它们各自关联到某个知道如何处理特定类型路径的路径条目查找器。

默认的路径条目查找器集合实现了在文件系统中查找模块的所有语义，可处理多种特殊文件类型例如 Python 源码 (.py 文件)，Python 字节码 (.pyc 文件) 以及共享库 (例如 .so 文件)。 在标准库中 zipimport 模块的支持下，默认路径条目查找器还能处理所有来自 zip 文件的上述文件类型。

路径条目不必仅限于文件系统位置。 它们可以指向 URL、数据库查询或可以用字符串指定的任何其他位置。

基于路径的查找器还提供了额外的钩子和协议以便能扩展和定制可搜索路径条目的类型。 例如，如果你想要支持网络 URL 形式的路径条目，你可以编写一个实现 HTTP 语义在网络上查找模块的钩子。 这个钩子（可调用对象）应当返回一个支持下述协议的 path entry finder，以被用来获取一个专门针对来自网络的模块的加载器。

预先的警告：本节和上节都使用了 查找器 这一术语，并通过 meta path finder 和 path entry finder 两个术语来明确区分它们。 这两种类型的查找器非常相似，支持相似的协议，且在导入过程中以相似的方式运作，但关键的一点是要记住它们是有微妙差异的。 特别地，元路径查找器作用于导入过程的开始，主要是启动 sys.meta_path 遍历。

相比之下，路径条目查找器在某种意义上说是基于路径的查找器的实现细节，实际上，如果需要从 sys.meta_path 移除基于路径的查找器，并不会有任何路径条目查找器被唤起。

5.5.1. 路径条目查找器

path based finder 会负责查找和加载通过 path entry 字符串来指定位置的 Python 模块和包。 多数路径条目所指定的是文件系统中的位置，但它们并不必受限于此。

作为一种元路径查找器，path based finder 实现了上文描述的 find_spec() 协议，但是它还对外公开了一些附加钩子，可被用来定制模块如何从 import path 查找和加载。

有三个变量由 path based finder, sys.path, sys.path_hooks 和 sys.path_importer_cache 所使用。 包对象的 __path__ 属性也会被使用。 它们提供了可用于定制导入机制的额外方式。

sys.path 包含一个提供模块和包搜索位置的字符串列表。 它初始化自 PYTHONPATH 环境变量以及多种其他特定安装和实现的默认设置。 sys.path 条目可指定的名称有文件系统中的目录、zip 文件和其他可用于搜索模块的潜在“位置”（参见 site 模块），例如 URL 或数据库查询等。 在 sys.path 中只能出现字符串和字节串；所有其他数据类型都会被忽略。 字节串条目使用的编码由单独的 路径条目查找器 来确定。

path based finder 是一种 meta path finder，因此导入机制会通过调用上文描述的基于路径的查找器的 find_spec() 方法来启动 import path 搜索。 当要向 find_spec() 传入 path 参数时，它将是一个可遍历的字符串列表 —— 通常为用来在其内部进行导入的包的 __path__ 属性。 如果 path 参数为 None，这表示最高层级的导入，将会使用 sys.path。

基于路径的查找器会迭代搜索路径中的每个条目，并且每次都查找与路径条目对应的 path entry finder (PathEntryFinder)。 因为这种操作可能很耗费资源 (例如搜索会有 stat() 调用的开销)，基于路径的查找器会维持一个缓存来将路径条目映射到路径条目查找器。 这个缓存存放在 sys.path_importer_cache (尽管如此命名，但这个缓存实际存放的是查找器对象而非仅限于 importer 对象)。 通过这种方式，对特定 path entry 位置的 path entry finder 的高耗费搜索中需要进行一次。 用户代码可以自由地从 sys.path_importer_cache 移除缓存条目，以强制基于路径的查找器再次执行路径条目搜索 3。

如果路径条目不存在于缓存中，基于路径的查找器会迭代 sys.path_hooks 中的每个可调用对象。 对此列表中的每个 路径条目钩子 的调用会带有一个参数，即要搜索的路径条目。 每个可调用对象或是返回可处理路径条目的 path entry finder，或是引发 ImportError。 基于路径的查找器使用 ImportError 来表示钩子无法找到与 path entry 相对应的 path entry finder。 该异常会被忽略并继续进行 import path 的迭代。 每个钩子应该期待接收一个字符串或字节串对象；字节串对象的编码由钩子决定（例如可以是文件系统使用的编码 UTF-8 或其它编码），如果钩子无法解码参数，它应该引发 ImportError。

如果 sys.path_hooks 迭代结束时没有返回 path entry finder，则基于路径的查找器 find_spec() 方法将在 sys.path_importer_cache 中存入 None (表示此路径条目没有对应的查找器) 并返回 None，表示此 meta path finder 无法找到该模块。

如果 sys.path_hooks 中的某个 path entry hook 可调用对象的返回值 是 一个 path entry finder，则以下协议会被用来向查找器请求一个模块的规格说明，并在加载该模块时被使用。

当前工作目录 -- 由一个空字符串表示 -- 的处理方式与 sys.path 中的其他条目略有不同。 首先，如果发现当前工作目录不存在，则 sys.path_importer_cache 中不会存放任何值。 其次，每个模块查找会对当前工作目录的值进行全新查找。 第三，由 sys.path_importer_cache 所使用并由 importlib.machinery.PathFinder.find_spec() 所返回的路径将是实际的当前工作目录而非空字符串。

5.5.2. 路径条目查找器协议

为了支持模块和已初始化包的导入，也为了给命名空间包提供组成部分，路径条目查找器必须实现 find_spec() 方法。

find_spec() 接受两个参数，即要导入模块的完整限定名称，以及（可选的）目标模块。 find_spec() 返回模块的完全填充好的规格说明。 这个规格说明总是包含“加载器”集合（但有一个例外）。

为了向导入机制提示该规格说明代表一个命名空间 portion，路径条目查找器会将 "submodule_search_locations" 设为一个包含该部分的列表。

在 3.4 版更改: find_spec() 替代了 find_loader() 和 find_module()，后两者现在都已弃用，但会在 find_spec() 未定义时被使用。

较旧的路径条目查找器可能会实现这两个已弃用的方法中的一个而没有实现 find_spec()。 为保持向后兼容，这两个方法仍会被接受。 但是，如果在路径条目查找器上实现了 find_spec()，这两个遗留方法就会被忽略。

find_loader() 接受一个参数，即要导入模块的完整限定名称。 find_loader() 返回一个 2 元组，其中第一项是加载器而第二项是命名空间 portion。

为了向后兼容其他导入协议的实现，许多路径条目查找器也同样支持元路径查找器所支持的传统 find_module() 方法。 但是路径条目查找器 find_module() 方法的调用绝不会带有 path 参数（它们被期望记录来自对路径钩子初始调用的恰当路径信息）。

路径条目查找器的 find_module() 方法已弃用，因为它不允许路径条目查找器为命名空间包提供部分。 如果 find_loader() 和 find_module() 同时存在于一个路径条目查找器中，导入系统将总是调用 find_loader() 而不选择 find_module()。

在 3.10 版更改: 导入系统调用 find_module() 和 find_loader() 将引发 ImportWarning。

5.6. 替换标准导入系统

替换整个导入系统的最可靠机制是移除 sys.meta_path 的默认内容，,将其完全替换为自定义的元路径钩子。

一个可行的方式是仅改变导入语句的行为而不影响访问导入系统的其他 API，那么替换内置的 __import__() 函数可能就够了。 这种技巧也可以在模块层级上运用，即只在某个模块内部改变导入语句的行为。

想要选择性地预先防止在元路径上从一个钩子导入某些模块（而不是完全禁用标准导入系统），只需直接从 find_spec() 引发 ModuleNotFoundError 而非返回 None 就足够了。 返回后者表示元路径搜索应当继续，而引发异常则会立即终止搜索。

5.7. 包相对导入

相对导入使用前缀点号。 一个前缀点号表示相对导入从当前包开始。 两个或更多前缀点号表示对当前包的上级包的相对导入，第一个点号之后的每个点号代表一级。 例如，给定以下的包布局结构:

package/
    __init__.py
    subpackage1/
        __init__.py
        moduleX.py
        moduleY.py
    subpackage2/
        __init__.py
        moduleZ.py
    moduleA.py

不论是在 subpackage1/moduleX.py 还是 subpackage1/__init__.py 中，以下导入都是有效的:

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

绝对导入可以使用 import <> 或 from <> import <> 语法，但相对导入只能使用第二种形式；其中的原因在于:

import XXX.YYY.ZZZ

应当提供 XXX.YYY.ZZZ 作为可用表达式，但 .moduleY 不是一个有效的表达式。

5.8. 有关 __main__ 的特殊事项

对于 Python 的导入系统来说 __main__ 模块是一个特殊情况。 正如在 另一节 中所述，__main__ 模块是在解释器启动时直接初始化的，与 sys 和 builtins 很类似。 但是，与那两者不同，它并不被严格归类为内置模块。 这是因为 __main__ 被初始化的方式依赖于唤起解释器所附带的旗标和其他选项。

5.8.1. __main__.__spec__

根据 __main__ 被初始化的方式，__main__.__spec__ 会被设置相应值或是 None。

当 Python 附加 -m 选项启动时，__spec__ 会被设为相应模块或包的模块规格说明。 __spec__ 也会在 __main__ 模块作为执行某个目录，zip 文件或其它 sys.path 条目的一部分加载时被填充。

在 其余的情况 下 __main__.__spec__ 会被设为 None，因为用于填充 __main__ 的代码不直接与可导入的模块相对应:

交互型提示

-c 选项

从 stdin 运行

直接从源码或字节码文件运行

请注意在最后一种情况中 __main__.__spec__ 总是为 None，即使 文件从技术上说可以作为一个模块被导入。 如果想要让 __main__ 中的元数据生效，请使用 -m 开关。

还要注意即使是在 __main__ 对应于一个可导入模块且 __main__.__spec__ 被相应地设定时，它们仍会被视为 不同的 模块。 这是由于以下事实：使用 if __name__ == "__main__": 检测来保护的代码块仅会在模块被用来填充 __main__ 命名空间时而非普通的导入时被执行。

5.9. 参考文献

导入机制自 Python 诞生之初至今已发生了很大的变化。 原始的 包规格说明 [https://www.python.org/doc/essays/packages/] 仍然可以查阅，但在撰写该文档之后许多相关细节已被修改。

原始的 sys.meta_path 规格说明见 PEP 302 [https://www.python.org/dev/peps/pep-0302]，后续的扩展说明见 PEP 420 [https://www.python.org/dev/peps/pep-0420]。

PEP 420 [https://www.python.org/dev/peps/pep-0420] 为 Python 3.3 引入了 命名空间包。 PEP 420 [https://www.python.org/dev/peps/pep-0420] 还引入了 find_loader() 协议作为 find_module() 的替代。

PEP 366 [https://www.python.org/dev/peps/pep-0366] 描述了新增的 __package__ 属性，用于在模块中的显式相对导入。

PEP 328 [https://www.python.org/dev/peps/pep-0328] 引入了绝对和显式相对导入，并初次提出了 __name__ 语义，最终由 PEP 366 [https://www.python.org/dev/peps/pep-0366] 为 __package__ 加入规范描述。

PEP 338 [https://www.python.org/dev/peps/pep-0338] 定义了将模块作为脚本执行。

PEP 451 [https://www.python.org/dev/peps/pep-0451] 在 spec 对象中增加了对每个模块导入状态的封装。 它还将加载器的大部分样板责任移交回导入机制中。 这些改变允许弃用导入系统中的一些 API 并为查找器和加载器增加一些新的方法。

备注

1

参见 types.ModuleType。

2

importlib 实现避免直接使用返回值。 而是通过在 sys.modules 中查找模块名称来获取模块对象。 这种方式的间接影响是被导入的模块可能在 sys.modules 中替换其自身。 这属于具体实现的特定行为，不保证能在其他 Python 实现中起作用。

3

在遗留代码中，有可能在 sys.path_importer_cache 中找到 imp.NullImporter 的实例。 建议将这些代码修改为使用 None 代替。 详情参见 移植 Python 代码。

6. 表达式

本章将解释 Python 中组成表达式的各种元素的的含义。

语法注释: 在本章和后续章节中，会使用扩展 BNF 标注来描述语法而不是词法分析。 当（某种替代的）语法规则具有如下形式

name ::=  othername

并且没有给出语义，则这种形式的 name 在语法上与 othername 相同。

6.1. 算术转换

当对下述某个算术运算符的描述中使用了“数值参数被转换为普通类型”这样的说法，这意味着内置类型的运算符实现采用了如下运作方式:

如果任一参数为复数，另一参数会被转换为复数；

否则，如果任一参数为浮点数，另一参数会被转换为浮点数；

否则，两者应该都为整数，不需要进行转换。

某些附加规则会作用于特定运算符（例如，字符串作为 '%' 运算符的左运算参数）。 扩展必须定义它们自己的转换行为。

6.2. 原子

“原子”指表达式的最基本构成元素。 最简单的原子是标识符和字面值。 以圆括号、方括号或花括号包括的形式在语法上也被归类为原子。 原子的句法为:

atom      ::=  identifier | literal | enclosure
enclosure ::=  parenth_form | list_display | dict_display | set_display
               | generator_expression | yield_atom

6.2.1. 标识符（名称）

作为原子出现的标识符叫做名称。 请参看 标识符和关键字 一节了解其词法定义，以及 命名与绑定 获取有关命名与绑定的文档。

当名称被绑定到一个对象时，对该原子求值将返回相应对象。 当名称未被绑定时，尝试对其求值将引发 NameError 异常。

私有名称转换: 当以文本形式出现在类定义中的一个标识符以两个或更多下划线开头并且不以两个或更多下划线结尾，它会被视为该类的 私有名称。 私有名称会在为其生成代码之前被转换为一种更长的形式。 转换时会插入类名，移除打头的下划线再在名称前增加一个下划线。 例如，出现在一个名为 Ham 的类中的标识符 __spam 会被转换为 _Ham__spam。 这种转换独立于标识符所使用的相关句法。 如果转换后的名称太长（超过 255 个字符），可能发生由具体实现定义的截断。 如果类名仅由下划线组成，则不会进行转换。

6.2.2. 字面值

Python 支持字符串和字节串字面值，以及几种数字字面值:

literal ::=  stringliteral | bytesliteral
             | integer | floatnumber | imagnumber

对字面值求值将返回一个该值所对应类型的对象（字符串、字节串、整数、浮点数、复数）。 对于浮点数和虚数（复数）的情况，该值可能为近似值。 详情参见 字面值。

所有字面值都对应于不可变数据类型，因此对象标识的重要性不如其实际值。 多次对具有相同值的字面值求值（不论是发生在程序文本的相同位置还是不同位置）可能得到相同对象或是具有相同值的不同对象。

6.2.3. 带圆括号的形式

带圆括号的形式是包含在圆括号中的可选表达式列表。

parenth_form ::=  "(" [starred_expression] ")"

带圆括号的表达式列表将返回该表达式列表所产生的任何东西：如果该列表包含至少一个逗号，它会产生一个元组；否则，它会产生该表达式列表所对应的单一表达式。

一对内容为空的圆括号将产生一个空的元组对象。 由于元组是不可变对象，因此适用与字面值相同的规则（即两次出现的空元组产生的对象可能相同也可能不同）。

请注意元组并不是由圆括号构建，实际起作用的是逗号操作符。 例外情况是空元组，这时圆括号 才是 必须的 --- 允许在表达式中使用不带圆括号的 "空" 会导致歧义，并会造成常见输入错误无法被捕获。

6.2.4. 列表、集合与字典的显示

为了构建列表、集合或字典，Python 提供了名为“显示”的特殊句法，每个类型各有两种形式:

第一种是显式地列出容器内容

第二种是通过一组循环和筛选指令计算出来，称为 推导式。

推导式的常用句法元素为:

comprehension ::=  assignment_expression comp_for
comp_for      ::=  ["async"] "for" target_list "in" or_test [comp_iter]
comp_iter     ::=  comp_for | comp_if
comp_if       ::=  "if" or_test [comp_iter]

推导式的结构是一个单独表达式后面加至少一个 for 子句以及零个或更多个 for 或 if 子句。 在这种情况下，新容器的元素产生方式是将每个 for 或 if 子句视为一个代码块，按从左至右的顺序嵌套，然后每次到达最内层代码块时就对表达式进行求值以产生一个元素。

不过，除了最左边 for 子句中的可迭代表达式，推导式是在另一个隐式嵌套的作用域内执行的。 这能确保赋给目标列表的名称不会“泄露”到外层的作用域。

最左边的 for 子句中的可迭代对象表达式会直接在外层作用域中被求值，然后作为一个参数被传给隐式嵌套的作用域。 后续的 for 子句以及最左侧 for 子句中的任何筛选条件不能在外层作用域中被求值，因为它们可能依赖于从最左侧可迭代对象中获得的值。 例如: [x*y for x in range(10) for y in range(x, x+10)]。

为了确保推导式得出的结果总是一个类型正确的容器，在隐式嵌套作用域内禁止使用 yield 和 yield from 表达式。

从 Python 3.6 开始，在 async def 函数中可以使用 async for 子句来迭代 asynchronous iterator。 在 async def 函数中构建推导式可以通过在打头的表达式后加上 for 或 async for 子句，也可能包含额外的 for 或 async for 子句，还可能使用 await 表达式。 如果一个推导式包含 async for 子句或者 await 表达式，则被称为 异步推导式。 异步推导式可以暂停执行它所在的协程函数。 另请参阅 PEP 530 [https://www.python.org/dev/peps/pep-0530]。

3.6 新版功能: 引入了异步推导式。

在 3.8 版更改: yield 和 yield from 在隐式嵌套的作用域中已被禁用。

6.2.5. 列表显示

列表显示是一个用方括号括起来的可能为空的表达式系列:

list_display ::=  "[" [starred_list | comprehension] "]"

列表显示会产生一个新的列表对象，其内容通过一系列表达式或一个推导式来指定。 当提供由逗号分隔的一系列表达式时，其元素会从左至右被求值并按此顺序放入列表对象。 当提供一个推导式时，列表会根据推导式所产生的结果元素进行构建。

6.2.6. 集合显示

集合显示是用花括号标明的，与字典显示的区别在于没有冒号分隔的键和值:

set_display ::=  "{" (starred_list | comprehension) "}"

集合显示会产生一个新的可变集合对象，其内容通过一系列表达式或一个推导式来指定。 当提供由逗号分隔的一系列表达式时，其元素会从左至右被求值并加入到集合对象。 当提供一个推导式时，集合会根据推导式所产生的结果元素进行构建。

空集合不能用 {} 来构建；该字面值所构建的是一个空字典。

6.2.7. 字典显示

字典显示是一个用花括号括起来的可能为空的键/数据对系列:

dict_display       ::=  "{" [key_datum_list | dict_comprehension] "}"
key_datum_list     ::=  key_datum ("," key_datum)* [","]
key_datum          ::=  expression ":" expression | "**" or_expr
dict_comprehension ::=  expression ":" expression comp_for

字典显示会产生一个新的字典对象。

如果给出一个由逗号分隔的键/数据对序列，它们会从左至右被求值以定义字典的条目：每个键对象会被用作在字典中存放相应数据的键。 这意味着你可以在键/数据对序列中多次指定相同的键，最终字典的值将由最后一次给出的键决定。

双星号 ** 表示 字典拆包。 它的操作数必须是一个 mapping。 每个映射项被会加入新的字典。 后续的值会替代先前的键/数据对和先前的字典拆包所设置的值。

3.5 新版功能: 拆包到字典显示，最初由 PEP 448 [https://www.python.org/dev/peps/pep-0448] 提出。

字典推导式与列表和集合推导式有所不同，它需要以冒号分隔的两个表达式，后面带上标准的 "for" 和 "if" 子句。 当推导式被执行时，作为结果的键和值元素会按它们的产生顺序被加入新的字典。

对键取值类型的限制已列在之前的 标准类型层级结构 一节中。 (总的说来，键的类型应该为 hashable，这就把所有可变对象都排除在外。) 重复键之间的冲突不会被检测；指定键所保存的最后一个数据 (即在显示中排最右边的文本) 为最终有效数据。

在 3.8 版更改: 在 Python 3.8 之前的字典推导式中，并没有定义好键和值的求值顺序。 在 CPython 中，值会先于键被求值。 根据 PEP 572 [https://www.python.org/dev/peps/pep-0572] 的提议，从 3.8 开始，键会先于值被求值。

6.2.8. 生成器表达式

生成器表达式是用圆括号括起来的紧凑形式生成器标注。

generator_expression ::=  "(" expression comp_for ")"

生成器表达式会产生一个新的生成器对象。 其句法与推导式相同，区别在于它是用圆括号而不是用方括号或花括号括起来的。

在生成器表达式中使用的变量会在为生成器对象调用 __next__() 方法的时候以惰性方式被求值（即与普通生成器相同的方式）。 但是，最左侧 for 子句内的可迭代对象是会被立即求值的，因此它所造成的错误会在生成器表达式被定义时被检测到，而不是在获取第一个值时才出错。 后续的 for 子句以及最左侧 for 子句内的任何筛选条件无法在外层作用域内被求值，因为它们可能会依赖于从最左侧可迭代对象获取的值。 例如: (x*y for x in range(10) for y in range(x, x+10)).

圆括号在只附带一个参数的调用中可以被省略。 详情参见 调用 一节。

为了避免干扰到生成器表达式本身的预期操作，禁止在隐式定义的生成器中使用 yield 和 yield from 表达式。

如果生成器表达式包含 async for 子句或 await 表达式，则称为 异步生成器表达式。 异步生成器表达式会返回一个新的异步生成器对象，此对象属于异步迭代器 (参见 异步迭代器)。

3.6 新版功能: 引入了异步生成器表达式。

在 3.7 版更改: 在 Python 3.7 之前，异步生成器表达式只能在 async def 协和中出现。 从 3.7 开始，任何函数都可以使用异步生成器表达式。

在 3.8 版更改: yield 和 yield from 在隐式嵌套的作用域中已被禁用。

6.2.9. yield 表达式

yield_atom       ::=  "(" yield_expression ")"
yield_expression ::=  "yield" [expression_list | "from" expression]

yield 表达式在定义 generator 函数或 asynchronous generator 函数时才会用到因此只能在函数定义的内部使用。 在一个函数体内使用 yield 表达式会使这个函数变成一个生成器函数，而在一个 async def 函数的内部使用它则会让这个协程函数变成一个异步生成器函数。 例如:

def gen():  # defines a generator function
    yield 123

async def agen(): # defines an asynchronous generator function
    yield 123

由于它们会对外层作用域造成附带影响，yield 表达式不被允许作为用于实现推导式和生成器表达式的隐式定义作用域的一部分。

在 3.8 版更改: 禁止在实现推导式和生成器表达式的隐式嵌套作用域中使用 yield 表达式。

下面是对生成器函数的描述，异步生成器函数会在 异步生成器函数 一节中单独介绍。

当一个生成器函数被调用时，它返回一个名为生成器的迭代器。 然后这个生成器将控制生成器函数的执行。 执行过程会在这个生成器的某个方法被调用时开始。 这时，函数会执行到第一个 yield 表达式，在这里它将再次被挂起，向生成器的调用方返回 expression_list 的值，或者如果 expression_list 被省略则返回 None。 这里所谓的挂起，就是说所有局部状态都会被保留下来，包括局部变量的当前绑定、指令指针、内部求值栈和任何异常处理等等。 当通过调用生成器的某个方法恢复执行时，这个函数的运行就与 yield 表达式只是一个外部调用的情况完全一样。 恢复之后 yield 表达式的值取决于恢复执行所调用的方法。 如果是用 __next__() (通常是通过 for 或 next() 内置函数) 则结果为 None。 在其他情况下，如果是用 send()，则结果将为传给该方法的值。

所有这些使生成器函数与协程非常相似；它们 yield 多次，它们具有多个入口点，并且它们的执行可以被挂起。唯一的区别是生成器函数不能控制在它在 yield 后交给哪里继续执行；控制权总是转移到生成器的调用者。

在 try 结构中的任何位置都允许yield表达式。如果生成器在(因为引用计数到零或是因为被垃圾回收)销毁之前没有恢复执行，将调用生成器-迭代器的 close() 方法. close 方法允许任何挂起的 finally 子句执行。

当使用 yield from <expr> 时，所提供的表达式必须是一个可迭代对象。 迭代该可迭代对象所产生的值会被直接传递给当前生成器方法的调用者。 任何通过 send() 传入的值以及任何通过 throw() 传入的异常如果有适当的方法则会被传给下层迭代器。 如果不是这种情况，那么 send() 将引发 AttributeError 或 TypeError，而 throw() 将立即引发所转入的异常。

当下层迭代器完成时，被引发的 StopIteration 实例的 value 属性会成为 yield 表达式的值。 它可以在引发 StopIteration 时被显式地设置，也可以在子迭代器是一个生成器时自动地设置（通过从子生成器返回一个值）。

在 3.3 版更改: 添加 yield from <expr> 以委托控制流给一个子迭代器。

当yield表达式是赋值语句右侧的唯一表达式时，括号可以省略。

参见

PEP 255 [https://www.python.org/dev/peps/pep-0255] - 简单生成器

在 Python 中加入生成器和 yield 语句的提议。

PEP 342 [https://www.python.org/dev/peps/pep-0342] - 通过增强型生成器实现协程

增强生成器 API 和语法的提议，使其可以被用作简单的协程。

PEP 380 [https://www.python.org/dev/peps/pep-0380] - 委托给子生成器的语法

引入 yield_from 语法的提议，以方便地委托给子生成器。

PEP 525 [https://www.python.org/dev/peps/pep-0525] - 异步生成器

通过给协程函数加入生成器功能对 PEP 492 [https://www.python.org/dev/peps/pep-0492] 进行扩展的提议。

6.2.9.1. 生成器-迭代器的方法

这个子小节描述了生成器迭代器的方法。 它们可被用于控制生成器函数的执行。

请注意在生成器已经在执行时调用以下任何方法都会引发 ValueError 异常。

generator.__next__()

开始一个生成器函数的执行或是从上次执行 yield 表达式的位置恢复执行。 当一个生成器函数通过 __next__() 方法恢复执行时，当前的 yield 表达式总是取值为 None。 随后会继续执行到下一个 yield 表达式，这时生成器将再次挂起，而 expression_list 的值会被返回给 __next__() 的调用方。 如果生成器没有产生下一个值就退出，则将引发 StopIteration 异常。

此方法通常是隐式地调用，例如通过 for 循环或是内置的 next() 函数。

generator.send(value)

恢复执行并向生成器函数“发送”一个值。 value 参数将成为当前 yield 表达式的结果。 send() 方法会返回生成器所产生的下一个值，或者如果生成器没有产生下一个值就退出则会引发 StopIteration。 当调用 send() 来启动生成器时，它必须以 None 作为调用参数，因为这时没有可以接收值的 yield 表达式。

generator.throw(value)

generator.throw(type[, value[, traceback]])

在生成器暂停的位置引发一个异常，并返回该生成器函数所产生的下一个值。 如果生成器没有产生下一个值就退出，则将引发 StopIteration 异常。 如果生成器函数没有捕获传入的异常，或是引发了另一个异常，则该异常会被传播给调用方。

在典型的使用场景下，其调用将附带单个异常实例，类似于使用 raise 关键字的方式。

但是为了向下兼容，也支持第二种签名方式，遵循来自旧版本 Python 的惯例。 type 参数应为一个异常类，而 value 应为一个异常实例。 如果未提供 value，则将调用 type 构造器来获取一个实例。 如果提供了 traceback，它将被设置到异常上，否则任何存储在 value 中的现有 __traceback__ 属性都会被清空。

generator.close()

在生成器函数暂停的位置引发 GeneratorExit。 如果生成器函数随后正常退出、已经关闭，或者引发了 GeneratorExit (由于未捕获异常)，执行关闭将返回其调用方。 如果生成器产生了一个值，则将引发 RuntimeError。 如果生成器引发了任何其他异常，它将被传播给调用方。 如果生成器已经由于异常或以正常退出方式结束执行则 close() 将不会做任何事。

6.2.9.2. 例子

这里是一个简单的例子，演示了生成器和生成器函数的行为:

>>> 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.

对于 yield from 的例子, 参见“Python 有什么新变化”中的 PEP 380: 委托给子生成器的语法。

6.2.9.3. 异步生成器函数

在一个使用 async def 定义的函数或方法中出现的 yield 表达式会进一步将该函数定义为一个 asynchronous generator 函数。

当一个异步生成器函数被调用时，它会返回一个名为异步生成器对象的异步迭代器。 此对象将在之后控制该生成器函数的执行。 异步生成器对象通常被用在协程函数的 async for 语句中，类似于在 for 语句中使用生成器对象。

调用某个异步生成器的方法将返回 awaitable 对象，执行会在此对象被等待时启动。 到那时，执行过程将前往第一个 yield 表达式，在那里它会再次挂起，将 expression_list 的值返回给等待中的协程。 与生成器一样，挂起意味着所有局部状态会被保留，包括局部变量的当前绑定、指令指针、内部求值栈以及任何异常处理的状态。 当执行在等待异步生成器的方法返回下一个对象后恢复时，该函数可以从原状态继续执行，就仿佛 yield 表达式只是另一个外部调用。 恢复执行之后 yield 表达式的值取决于恢复执行所用的方法。 如果使用 __anext__() 则结果为 None。 否则的话，如果使用 asend()，则结果将是传递给该方法的值。

如果一个异步生成器恰好因 break、调用方任务被取消，或是其他异常而提前退出，生成器的异步清理代码将会运行并可能引发异常或访问意外上下文中的上下文变量 -- 也许是在它所依赖的任务的生命周期之后，或是在异步生成器垃圾回收钩子被调用时的事件循环关闭期间。 为了防止这种情况，调用方必须通过调用 aclose() 方法来显式地关闭异步生成器以终结生成器并最终从事件循环中将其分离。

在异步生成器函数中，yield 表达式允许出现在 try 结构的任何位置。但是，如果一个异步生成器在其被终结（由于引用计数达到零或被作为垃圾回收）之前未被恢复，则 try 结构中的 yield 表达式可能导致挂起的 finally 子句执行失败。在此情况下，应由运行该异步生成器的事件循环或任务调度器来负责调用异步生成器-迭代器的 aclose() 方法并运行所返回的协程对象，从而允许任何挂起的 finally 子句得以执行。

为了能在事件循环终结时执行最终化处理，事件循环应当定义一个 终结器 函数，它接受一个异步生成器迭代器并将调用 aclose() 且执行该协程。 这个 终结器 可以通过调用 sys.set_asyncgen_hooks() 来注册。 当首次迭代时，异步生成器迭代器将保存已注册的 终结器 以便在最终化时调用。 有关 终结器 方法的参考示例请查看在 Lib/asyncio/base_events.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/base_events.py] 的中的 asyncio.Loop.shutdown_asyncgens 实现。

yield from <expr> 表达式如果在异步生成器函数中使用会引发语法错误。

6.2.9.4. 异步生成器-迭代器方法

这个子小节描述了异步生成器迭代器的方法，它们可被用于控制生成器函数的执行。

coroutine agen.__anext__()

返回一个可等待对象，它在运行时会开始执行该异步生成器或是从上次执行的 yield 表达式位置恢复执行。 当一个异步生成器函数通过 __anext__() 方法恢复执行时，当前的 yield 表达式所返回的可等待对象总是取值为 None，它在运行时将继续执行到下一个 yield 表达式。 该 yield 表达式的 expression_list 的值会是完成的协程所引发的 StopIteration 异常的值。 如果异步生成器没有产生下一个值就退出，则该可等待对象将引发 StopAsyncIteration 异常，提示该异步迭代操作已完成。

此方法通常是通过 async for 循环隐式地调用。

coroutine agen.asend(value)

返回一个可等待对象，它在运行时会恢复该异步生成器的执行。 与生成器的 send() 方法一样，此方法会“发送”一个值给异步生成器函数，其 value 参数会成为当前 yield 表达式的结果值。 asend() 方法所返回的可等待对象将返回生成器产生的下一个值，其值为所引发的 StopIteration，或者如果异步生成器没有产生下一个值就退出则引发 StopAsyncIteration。 当调用 asend() 来启动异步生成器时，它必须以 None 作为调用参数，因为这时没有可以接收值的 yield 表达式。

coroutine agen.athrow(value)

coroutine agen.athrow(type[, value[, traceback]])

返回一个可等待对象，它会在异步生成器暂停的位置引发 type 类型的异常，并返回该生成器函数所产生的下一个值，其值为所引发的 StopIteration 异常。 如果异步生成器没有产生下一个值就退出，则将由该可等待对象引发 StopAsyncIteration 异步。 如果生成器函数没有捕获传入的异常，或引发了另一个异常，则当可等待对象运行时该异常会被传播给可等待对象的调用者。

coroutine agen.aclose()

返回一个可等待对象，它会在运行时向异步生成器函数暂停的位置抛入一个 GeneratorExit。 如果该异步生成器函数正常退出、关闭或引发 GeneratorExit (由于未捕获该异常) 则返回的可等待对象将引发 StopIteration 异常。 后续调用异步生成器所返回的任何其他可等待对象将引发 StopAsyncIteration 异常。 如果异步生成器产生了一个值，该可等待对象会引发 RuntimeError。 如果异步生成器引发任何其他异常，它会被传播给可等待对象的调用者。 如果异步生成器已经由于异常或正常退出则后续调用 aclose() 将返回一个不会做任何事的可等待对象。

6.3. 原型

原型代表编程语言中最紧密绑定的操作。 它们的句法如下:

primary ::=  atom | attributeref | subscription | slicing | call

6.3.1. 属性引用

属性引用是后面带有一个句点加一个名称的原型:

attributeref ::=  primary "." identifier

此原型必须求值为一个支持属性引用的类型的对象，多数对象都支持属性引用。 随后该对象会被要求产生以指定标识符为名称的属性。 这个产生过程可通过重载 __getattr__() 方法来自定义。 如果这个属性不可用，则将引发 AttributeError 异常。 否则的话，所产生对象的类型和值会根据该对象来确定。 对同一属性引用的多次求值可能产生不同的对象。

6.3.2. 抽取

对一个 容器类 的实例执行抽取操作通常将会从该容器中选取一个元素。 而对一个 泛型类 执行抽取操作通常将会返回一个 GenericAlias 对象。

subscription ::=  primary "[" expression_list "]"

当一个对象被抽取时，解释器将对原型和表达式列表进行求值。

原型必须可被求值为一个支持抽取操作的对象。 一个对象可通过同时定义 __getitem__() 和 __class_getitem__() 或其中之一来支持抽取操作。 当原型被抽取时，表达式列表的求值结果将被传给以上方法中的一个。 对于在何时会调用 __class_getitem__ 而不是 __getitem__ 的更多细节，请参阅 __class_getitem__ 与 __getitem__。

如果表达式列表包含至少一个逗号，它将被求值为包含该表达式列表中所有条目的 tuple。 在其他情况下，表达式列表将被求值为列表中唯一成员的值。

对于内置对象，有两种类型的对象支持通过 __getitem__() 执行抽取操作:

映射。 如果原型是一个 mapping，则表达式列表必须求值为一个以该映射的某个键为值的对象，而抽取操作会在映射中选取该键所对应的值。 内置映射类的一个例子是 dict 类。

序列。 如果原型是一个 sequence，则表达式列表必须求值为一个 int 或一个 slice (如下面的小节所讨论的)。 内置序列类的例子包括 str, list 和 tuple 等类。

正式语法规则并未在 序列 中设置负索引号的特殊保留条款。 不过，内置序列都提供了通过给索引号加上序列长度来解读负索引号的 __getitem__() 方法，因此举例来说，x[-1] 将选取 x 的最后一项。 结果值必须为一个小于序列中条目数的非负整数，抽取操作会选取索引号为该值的条目（从零开始计数）。 由于对负索引号和切片的支持位于对象的 __getitem__() 方法中，因而重载此方法的子类将需要显式地添加这种支持。

字符串 是一种特殊的序列，其中的项是 字符。 字符并不是一种单独的数据类型而是长度恰好为一个字符的字符串。

6.3.3. 切片

切片就是在序列对象（字符串、元组或列表）中选择某个范围内的项。 切片可被用作表达式以及赋值或 del 语句的目标。 切片的句法如下:

slicing      ::=  primary "[" slice_list "]"
slice_list   ::=  slice_item ("," slice_item)* [","]
slice_item   ::=  expression | proper_slice
proper_slice ::=  [lower_bound] ":" [upper_bound] [ ":" [stride] ]
lower_bound  ::=  expression
upper_bound  ::=  expression
stride       ::=  expression

此处的正式句法中存在一点歧义：任何形似表达式列表的东西同样也会形似切片列表，因此任何抽取操作也可以被解析为切片。 为了不使句法更加复杂，于是通过定义将此情况解析为抽取优先于解析为切片来消除这种歧义（切片列表未包含正确的切片就属于此情况）。

切片的语义如下所述。 元型通过一个根据下面的切片列表来构造的键进行索引（与普通抽取一样使用 __getitem__() 方法）。 如果切片列表包含至少一个逗号，则键将是一个包含切片项转换的元组；否则的话，键将是单个切片项的转换。 切片项如为一个表达式，则其转换就是该表达式。 一个正确切片的转换就是一个切片对象（参见 标准类型层级结构 一节），该对象的 start, stop 和 step 属性将分别为表达式所给出的下界、上界和步长值，省略的表达式将用 None 来替换。

6.3.4. 调用

所谓调用就是附带可能为空的一系列 参数 来执行一个可调用对象 (例如 function):

call                 ::=  primary "(" [argument_list [","] | comprehension] ")"
argument_list        ::=  positional_arguments ["," starred_and_keywords]
                            ["," keywords_arguments]
                          | starred_and_keywords ["," keywords_arguments]
                          | keywords_arguments
positional_arguments ::=  positional_item ("," positional_item)*
positional_item      ::=  assignment_expression | "*" expression
starred_and_keywords ::=  ("*" expression | keyword_item)
                          ("," "*" expression | "," keyword_item)*
keywords_arguments   ::=  (keyword_item | "**" expression)
                          ("," keyword_item | "," "**" expression)*
keyword_item         ::=  identifier "=" expression

一个可选项为在位置和关键字参数后加上逗号而不影响语义。

此原型必须求值为一个可调用对象（用户定义的函数，内置函数，内置对象的方法，类对象，类实例的方法以及任何具有 __call__() 方法的对象都是可调用对象）。 所有参数表达式将在尝试调用前被求值。 请参阅 函数定义 一节了解正式的 parameter 列表句法。

如果存在关键字参数，它们会先通过以下操作被转换为位置参数。 首先，为正式参数创建一个未填充空位的列表. 如果有 N 个位置参数，则将它们放入前 N 个空位。 然后，对于每个关键字参数，使用标识符来确定其对应的空位（如果标识符与第一个正式参数名相同则使用第一个个空位，依此类推）。 如果空位已被填充，则会引发 TypeError 异常。 否则，将参数值放入空位进行填充（即使表达式为 None 也会填充空位）。 当所有参数处理完毕时，尚未填充的空位将用来自函数定义的相应默认值来填充。 （函数一旦定义其参数默认值就会被计算；因此，当列表或字典这类可变对象被用作默认值时，将会被所有未指定相应空位参数值的调用所共享；这种情况通常应当避免。） 如果任何一个未填充空位没有指定默认值，则会引发 TypeError 异常。 否则的话，已填充空位的列表会被作为调用的参数列表。

CPython 实现细节： 某些实现可能提供位置参数没有名称的内置函数，即使它们在文档说明的场合下有“命名”，因此不能以关键字形式提供参数。 在 CPython 中，以 C 编写并使用 PyArg_ParseTuple() 来解析其参数的函数实现就属于这种情况。

如果存在比正式参数空位多的位置参数，将会引发 TypeError 异常，除非有一个正式参数使用了 *identifier 句法；在此情况下，该正式参数将接受一个包含了多余位置参数的元组（如果没有多余位置参数则为一个空元组）。

如果任何关键字参数没有与之对应的正式参数名称，将会引发 TypeError 异常，除非有一个正式参数使用了 **identifier 句法，该正式参数将接受一个包含了多余关键字参数的字典（使用关键字作为键而参数值作为与键对应的值），如果没有多余关键字参数则为一个（新的）空字典。

如果函数调用中出现了 *expression 句法，expression 必须求值为一个 iterable。 来自该可迭代对象的元素会被当作是额外的位置参数。 对于 f(x1, x2, *y, x3, x4) 调用，如果 y 求值为一个序列 y1, ..., yM，则它就等价于一个带有 M+4 个位置参数 x1, x2, y1, ..., yM, x3, x4 的调用。

这样做的一个后果是虽然 *expression 句法可能出现于显式的关键字参数 之后，但它会在关键字参数（以及任何 **expression 参数 -- 见下文） 之前 被处理。 因此:

>>> 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

在同一个调用中同时使用关键字参数和 *expression 句法并不常见，因此实际上这样的混淆不会发生。

如果函数调用中出现了 **expression，则 expression 必须求值为一个 mapping，其内容会被当作是额外的关键字参数。 如果一个形参与一个已给定值关键字相匹配（通过显式的关键字参数，或通过另一个解包），则会引发 TypeError 异常。

当使用 **expression 时，该映射中的每个键都必须为字符串。 该映射中的每个值将被赋值给名称与键相同的适用于关键字赋值的第一个正式形参。 键名不需要是 Python 标识符（例如 "max-temp °F" 也是可接受的，但它将不能与可被声明的任何正式形参相匹配）。 如果键值对未与某个正式形参相匹配则将被 ** 形参所收集，或者如果没有此形参，则会引发 TypeError 异常。

使用 *identifier 或 **identifier 句法的正式参数不能被用作位置参数空位或关键字参数名称。

在 3.5 版更改: 函数调用接受任意数量的 * 和 ** 拆包，位置参数可能跟在可迭代对象拆包 (*) 之后，而关键字参数可能跟在字典拆包 (**) 之后。 由 PEP 448 [https://www.python.org/dev/peps/pep-0448] 发起最初提议。

除非引发了异常，调用总是会有返回值，返回值也可能为 None。 返回值的计算方式取决于可调用对象的类型。

如果类型为---

用户自定义函数:

函数的代码块会被执行，并向其传入参数列表。 代码块所做的第一件事是将正式形参绑定到对应参数；相关描述参见 函数定义 一节。 当代码块执行 return 语句时，由其指定函数调用的返回值。

内置函数或方法:

具体结果依赖于解释器；有关内置函数和方法的描述参见 内置函数。

类对象:

返回该类的一个新实例。

类实例方法:

调用相应的用户自定义函数，向其传入的参数列表会比调用的参数列表多一项：该实例将成为第一个参数。

类实例:

该类必须定义有 __call__() 方法；作用效果将等价于调用该方法。

6.4. await 表达式

挂起 coroutine 的执行以等待一个 awaitable 对象。 只能在 coroutine function 内部使用。

await_expr ::=  "await" primary

3.5 新版功能.

6.5. 幂运算符

幂运算符的绑定比在其左侧的一元运算符更紧密；但绑定紧密程度不及在其右侧的一元运算符。 句法如下:

power ::=  (await_expr | primary) ["**" u_expr]

因此，在一个未加圆括号的幂运算符和单目运算符序列中，运算符将从右向左求值（这不会限制操作数的求值顺序）: -1**2 结果将为 -1。

幂运算符与附带两个参数调用内置 pow() 函数具有相同的语义：结果为对其左参数进行其右参数所指定幂次的乘方运算。 数值参数会先转换为相同类型，结果也为转换后的类型。

对于 int 类型的操作数，结果将具有与操作数相同的类型，除非第二个参数为负数；在那种情况下，所有参数会被转换为 float 类型并输出 float 类型的结果。 例如，10**2 返回 100，而 10**-2 返回 0.01。

对 0.0 进行负数幂次运算将导致 ZeroDivisionError。 对负数进行分数幂次运算将返回 complex 数值。 （在早期版本中这将引发 ValueError。）

此运算符可使用特殊的 __pow__() 方法来自定义。

6.6. 一元算术和位运算

所有算术和位运算具有相同的优先级:

u_expr ::=  power | "-" u_expr | "+" u_expr | "~" u_expr

一元的 - (负值) 运算符会产生其数字参数的负值；该运算可通过 __neg__() 特殊方法来重载。

一元的 + (正值) 运算符会原样输出其数字参数；该运算可通过 __pos__() 特殊方法来重载。

一元的 ~ (取反) 运算符会对其整数参数按位取反。 x 的按位取反被定义为 -(x+1)。 它只作用于整数或是重载了 __invert__() 特殊方法的自定义对象。

在所有三种情况下，如果参数的类型不正确，将引发 TypeError 异常。

6.7. 二元算术运算符

二元算术运算符遵循传统的优先级。 请注意某些此类运算符也作用于特定的非数字类型。 除幂运算符以外只有两个优先级别，一个作用于乘法型运算符，另一个作用于加法型运算符:

m_expr ::=  u_expr | m_expr "*" u_expr | m_expr "@" m_expr |
            m_expr "//" u_expr | m_expr "/" u_expr |
            m_expr "%" u_expr
a_expr ::=  m_expr | a_expr "+" m_expr | a_expr "-" m_expr

运算符 * (乘) 将输出其参数的乘积。 两个参数或者必须都为数字，或者一个参数必须为整数而另一个参数必须为序列。 在前一种情况下，两个数字将被转换为相同类型然后相乘。 在后一种情况下，将执行序列的重复；重复因子为负数将输出空序列。

此运算可使用特殊的 __mul__() 和 __rmul__() 方法来自定义。

运算符 @ (at) 的目标是用于矩阵乘法。 没有内置 Python 类型实现此运算符。

3.5 新版功能.

运算符 / (除) 和 // (整除) 将输出其参数的商。 两个数字参数将先被转换为相同类型。 整数相除会输出一个 float 值，整数相整除的结果仍是整数；整除的结果就是使用 'floor' 函数进行算术除法的结果。 除以零的运算将引发 ZeroDivisionError 异常。

此运行可使用特殊的 __truediv__() 和 __floordiv__() 方法来自定义。

运算符 % (模) 将输出第一个参数除以第二个参数的余数。 两个数字参数将先被转换为相同类型。 右参数为零将引发 ZeroDivisionError 异常。 参数可以为浮点数，例如 3.14%0.7 等于 0.34 (因为 3.14 等于 4*0.7 + 0.34)。 模运算符的结果的正负总是与第二个操作数一致（或是为零）；结果的绝对值一定小于第二个操作数的绝对值 1。

整除与模运算符的联系可通过以下等式说明: x == (x//y)*y + (x%y)。 此外整除与模也可通过内置函数 divmod() 来同时进行: divmod(x, y) == (x//y, x%y)。 2。

除了对数字执行模运算，运算符 % 还被字符串对象重载用于执行旧式的字符串格式化（又称插值）。 字符串格式化句法的描述参见 Python 库参考的 printf 风格的字符串格式化 一节。

取余 运算可使用特殊的 __mod__() 方法来自定义。

整除运算符，模运算符和 divmod() 函数未被定义用于复数。 如果有必要可以使用 abs() 函数将其转换为浮点数。

运算符 + (addition) 将输出其参数的和。 两个参数或者必须都为数字，或者都为相同类型的序列。 在前一种情况下，两个数字将被转换为相同类型然后相加。 在后一种情况下，将执行序列拼接操作。

此运算可使用特殊的 __add__() 和 __radd__() 方法来自定义。

运算符 - (减) 将输出其参数的差。 两个数字参数将先被转换为相同类型。

此运算可使用特殊的 __sub__() 方法来自定义。

6.8. 移位运算

移位运算的优先级低于算术运算:

shift_expr ::=  a_expr | shift_expr ("<<" | ">>") a_expr

这些运算符接受整数参数。 它们会将第一个参数左移或右移第二个参数所指定的比特位数。

此运算可使用特殊的 __lshift__() 和 __rshift__() 方法来自定义。

右移 n 位被定义为被 pow(2,n) 整除。 左移 n 位被定义为乘以 pow(2,n)。

6.9. 二元位运算

三种位运算具有各不相同的优先级:

and_expr ::=  shift_expr | and_expr "&" shift_expr
xor_expr ::=  and_expr | xor_expr "^" and_expr
or_expr  ::=  xor_expr | or_expr "|" xor_expr

& 运算符会对其参数执行按位 AND，参数必须都为整数或者其中之一必须为重载了 __and__() 或 __rand__() 特殊方法的自定义对象。

^ 运算符会对其参数执行按位 XOR (异 OR)，参数必须都为整数或者其中之一必须为重载了 __xor__() 或 __rxor__() 特殊方法的自定义对象。

| 运算符会对其参数执行按位 (合并) OR，参数必须都为整数或者其中之一必须为重载了 __or__() 或 __ror__() 特殊方法的自定义对象。

6.10. 比较运算

与 C 不同，Python 中所有比较运算的优先级相同，低于任何算术、移位或位运算。 另一个与 C 不同之处在于 a < b < c 这样的表达式会按传统算术法则来解读:

comparison    ::=  or_expr (comp_operator or_expr)*
comp_operator ::=  "<" | ">" | "==" | ">=" | "<=" | "!="
                   | "is" ["not"] | ["not"] "in"

比较运算会产生布尔值: True 或 False。 自定义的 富比较方法 可能返回非布尔值。 在此情况下 Python 将在布尔运算上下文中对该值调用 bool()。

比较运算可以任意串连，例如 x < y <= z 等价于 x < y and y <= z，除了 y 只被求值一次（但在两种写法下当 x < y 值为假时 z 都不会被求值）。

正式的说法是这样：如果 a, b, c, ..., y, z 为表达式而 op1, op2, ..., opN 为比较运算符，则 a op1 b op2 c ... y opN z 就等价于 a op1 b and b op2 c and ... y opN z，不同点在于每个表达式最多只被求值一次。

请注意 a op1 b op2 c 不意味着在 a 和 c 之间进行任何比较，因此，如 x < y > z 这样的写法是完全合法的（虽然也许不太好看）。

6.10.1. 值比较

运算符 <, >, ==, >=, <= 和 != 将比较两个对象的值。 两个对象不要求为相同类型。

对象、值与类型 一章已说明对象都有相应的值（还有类型和标识号）。 对象值在 Python 中是一个相当抽象的概念：例如，对象值并没有一个规范的访问方法。 而且，对象值并不要求具有特定的构建方式，例如由其全部数据属性组成等。 比较运算符实现了一个特定的对象值概念。 人们可以认为这是通过实现对象比较间接地定义了对象值。

由于所有类型都是 object 的（直接或间接）子类型，它们都从 object 继承了默认的比较行为。 类型可以通过实现 丰富比较方法 例如 __lt__() 来定义自己的比较行为，详情参见 基本定制。

默认的一致性比较 (== 和 !=) 是基于对象的标识号。 因此，具有相同标识号的实例一致性比较结果为相等，具有不同标识号的实例一致性比较结果为不等。 规定这种默认行为的动机是希望所有对象都应该是自反射的 (即 x is y 就意味着 x == y)。

次序比较 (<, >, <= 和 >=) 默认没有提供；如果尝试比较会引发 TypeError。 规定这种默认行为的原因是缺少与一致性比较类似的固定值。

按照默认的一致性比较行为，具有不同标识号的实例总是不相等，这可能不适合某些对象值需要有合理定义并有基于值的一致性的类型。 这样的类型需要定制自己的比较行为，实际上，许多内置类型都是这样做的。

以下列表描述了最主要内置类型的比较行为。

内置数值类型 (数字类型 --- int, float, complex) 以及标准库类型 fractions.Fraction 和 decimal.Decimal 可进行类型内部和跨类型的比较，例外限制是复数不支持次序比较。 在类型相关的限制以内，它们会按数学（算法）规则正确进行比较且不会有精度损失。

非数字值 float('NaN') 和 decimal.Decimal('NaN') 属于特例。 任何数字与非数字值的排序比较均返回假值。 还有一个反直觉的结果是非数字值不等于其自身。 举例来说，如果 x = float('NaN') 则 3 < x, x < 3 和 x == x 均为假值，而 x != x 则为真值。 此行为是遵循 IEEE 754 标准的。

None 和 NotImplemented 都是单例对象。 PEP 8 [https://www.python.org/dev/peps/pep-0008] 建议单例对象的比较应当总是通过 is 或 is not 而不是等于运算符来进行。

二进制码序列 (bytes 或 bytearray 的实例) 可进行类型内部和跨类型的比较。 它们使用其元素的数字值按字典顺序进行比较。

字符串 (str 的实例) 使用其字符的 Unicode 码位数字值 (内置函数 ord() 的结果) 按字典顺序进行比较。 3

字符串和二进制码序列不能直接比较。

序列 (tuple, list 或 range 的实例) 只可进行类型内部的比较，range 还有一个限制是不支持次序比较。 以上对象的跨类型一致性比较结果将是不相等，跨类型次序比较将引发 TypeError。

序列比较是按字典序对相应元素进行逐个比较。 内置容器通常设定同一对象与其自身是相等的。 这使得它们能跳过同一对象的相等性检测以提升运行效率并保持它们的内部不变性。

内置多项集间的字典序比较规则如下:

两个多项集若要相等，它们必须为相同类型、相同长度，并且每对相应的元素都必须相等（例如，[1,2] == (1,2) 为假值，因为类型不同）。

对于支持次序比较的多项集，排序与其第一个不相等元素的排序相同（例如 [1,2,x] <= [1,2,y] 的值与 x <= y 相同）。 如果对应元素不存在，较短的多项集排序在前（例如 [1,2] < [1,2,3] 为真值）。

两个映射 (dict 的实例) 若要相等则必须当且仅当它们具有相等的 (key, value) 对。 键和值的相相等性比较强制要求自反射性。

次序比较 (<, >, <= 和 >=) 将引发 TypeError。

集合 (set 或 frozenset 的实例) 可进行类型内部和跨类型的比较。

它们将比较运算符定义为子集和超集检测。 这类关系没有定义完全排序（例如 {1,2} 和 {2,3} 两个集合不相等，即不为彼此的子集，也不为彼此的超集。 相应地，集合不适宜作为依赖于完全排序的函数的参数（例如如果给出一个集合列表作为 min(), max() 和 sorted() 的输入将产生未定义的结果）。

集合的比较强制规定其元素的自反射性。

大多数其他内置类型没有实现比较方法，因此它们会继承默认的比较行为。

在可能的情况下，用户定义类在定制其比较行为时应当遵循一些一致性规则:

相等比较应该是自反射的。 换句话说，相同的对象比较时应该相等:

x is y 意味着 x == y

比较应该是对称的。 换句话说，下列表达式应该有相同的结果:

x == y 和 y == x

x != y 和 y != x

x < y 和 y > x

x <= y 和 y >= x

比较应该是可传递的。 下列（简要的）例子显示了这一点:

x > y and y > z 意味着 x > z

x < y and y <= z 意味着 x < z

反向比较应该导致布尔值取反。 换句话说，下列表达式应该有相同的结果:

x == y 和 not x != y

x < y 和 not x >= y (对于完全排序)

x > y 和 not x <= y (对于完全排序)

最后两个表达式适用于完全排序的多项集（即序列而非集合或映射）。 另请参阅 total_ordering() 装饰器。

hash() 的结果应该与是否相等一致。 相等的对象应该或者具有相同的哈希值，或者标记为不可哈希。

Python 并不强制要求这些一致性规则。 实际上，非数字值就是一个不遵循这些规则的例子。

6.10.2. 成员检测运算

运算符 in 和 not in 用于成员检测。 如果 x 是 s 的成员则 x in s 求值为 True，否则为 False。 x not in s 返回 x in s 取反后的值。 所有内置序列和集合类型以及字典都支持此运算，对于字典来说 in 检测其是否有给定的键。 对于 list, tuple, set, frozenset, dict 或 collections.deque 这样的容器类型，表达式 x in y 等价于 any(x is e or x == e for e in y)。

对于字符串和字节串类型来说，当且仅当 x 是 y 的子串时 x in y 为 True。 一个等价的检测是 y.find(x) != -1。 空字符串总是被视为任何其他字符串的子串，因此 "" in "abc" 将返回 True。

对于定义了 __contains__() 方法的用户自定义类来说，如果 y.__contains__(x) 返回真值则 x in y 返回 True，否则返回 False。

对于未定义 __contains__() 但定义了 __iter__() 的用户自定义类来说，如果在对 y 进行迭代时产生了值 z 使得表达式 x is z or x == z 为真，则 x in y 为 True。 如果在迭代期间引发了异常，则等同于 in 引发了该异常。

最后将会尝试旧式的迭代协议：如果一个类定义了 __getitem__()，则当且仅当存在非负整数索引号 i 使得 x is y[i] or x == y[i] 并且没有更小的索引号引发 IndexError 异常时 x in y 为 True。 （如果引发了任何其他异常，则等同于 in 引发了该异常）。

运算符 not in 被定义为具有与 in 相反的逻辑值。

6.10.3. 标识号比较

运算符 is 和 is not 用于检测对象的标识号：当且仅当 x 和 y 是同一对象时 x is y 为真。 一个对象的标识号可使用 id() 函数来确定。 x is not y 会产生相反的逻辑值。 4

6.11. 布尔运算

or_test  ::=  and_test | or_test "or" and_test
and_test ::=  not_test | and_test "and" not_test
not_test ::=  comparison | "not" not_test

在执行布尔运算的情况下，或是当表达式被用于流程控制语句时，以下值会被解析为假值: False, None, 所有类型的数字零，以及空字符串和空容器（包括字符串、元组、列表、字典、集合与冻结集合）。 所有其他值都会被解析为真值。 用户自定义对象可通过提供 __bool__() 方法来定制其逻辑值。

运算符 not 将在其参数为假值时产生 True，否则产生 False。

表达式 x and y 首先对 x 求值；如果 x 为假则返回该值；否则对 y 求值并返回其结果值。

表达式 x or y 首先对 x 求值；如果 x 为真则返回该值；否则对 y 求值并返回其结果值。

请注意 and 和 or 都不限制其返回的值和类型必须为 False 和 True，而是返回最后被求值的操作数。 此行为是有必要的，例如假设 s 为一个当其为空时应被替换为某个默认值的字符串，表达式 s or 'foo' 将产生希望的值。 由于 not 必须创建一个新值，不论其参数为何种类型它都会返回一个布尔值（例如，not 'foo' 结果为 False 而非 ''。）

6.12. 赋值表达式

assignment_expression ::=  [identifier ":="] expression

赋值表达式（有时又被称为“命名表达式”或“海象表达式”）将一个 expression 赋值给一个 identifier，同时还会返回 expression 的值。

一个常见用例是在处理匹配的正则表达式的时候:

if matching := pattern.search(data):
    do_something(matching)

或者是在处理分块的文件流的时候:

while chunk := file.read(9000):
    process(chunk)

赋值表达式在被用作切片、条件表达式、lambda 表达式、关键字参数和推导式中的 if 表达式以及在 assert 和 with 语句中的子表达式时必须用圆括号括起来。 在其可使用的其他场合，圆括号则不是必须的，包括在 if 和 while 语句中。

3.8 新版功能: 请参阅 PEP 572 [https://www.python.org/dev/peps/pep-0572] 了解有关赋值表达式的详情。

6.13. 条件表达式

conditional_expression ::=  or_test ["if" or_test "else" expression]
expression             ::=  conditional_expression | lambda_expr

条件表达式（有时称为“三目运算符”）在所有 Python 运算中具有最低的优先级。

表达式 x if C else y 首先是对条件 C 而非 x 求值。 如果 C 为真，x 将被求值并返回其值；否则将对 y 求值并返回其值。

请参阅 PEP 308 [https://www.python.org/dev/peps/pep-0308] 了解有关条件表达式的详情。

6.14. lambda 表达式

lambda_expr ::=  "lambda" [parameter_list] ":" expression

lambda 表达式（有时称为 lambda 构型）被用于创建匿名函数。 表达式 lambda parameters: expression 会产生一个函数对象 。 该未命名对象的行为类似于用以下方式定义的函数:

def <lambda>(parameters):
    return expression

请参阅 函数定义 了解有关参数列表的句法。 请注意通过 lambda 表达式创建的函数不能包含语句或标注。

6.15. 表达式列表

expression_list    ::=  expression ("," expression)* [","]
starred_list       ::=  starred_item ("," starred_item)* [","]
starred_expression ::=  expression | (starred_item ",")* [starred_item]
starred_item       ::=  assignment_expression | "*" or_expr

除了作为列表或集合显示的一部分，包含至少一个逗号的表达式列表将生成一个元组。 元组的长度就是列表中表达式的数量。 表达式将从左至右被求值。

一个星号 * 表示 可迭代拆包。 其操作数必须为一个 iterable。 该可迭代对象将被拆解为迭代项的序列，并被包含于在拆包位置上新建的元组、列表或集合之中。

3.5 新版功能: 表达式列表中的可迭代对象拆包，最初由 PEP 448 [https://www.python.org/dev/peps/pep-0448] 提出。

末尾的逗号仅在创建单独元组 (或称 单例) 时需要；在所有其他情况下都是可选项。 没有末尾逗号的单独表达式不会创建一个元组，而是产生该表达式的值。 （要创建一个空元组，应使用一对内容为空的圆括号: ()。）

6.16. 求值顺序

Python 按从左至右的顺序对表达式求值。 但注意在对赋值操作求值时，右侧会先于左侧被求值。

在以下几行中，表达式将按其后缀的算术优先顺序被求值。:

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

6.17. 运算符优先级

下表对 Python 中运算符的优先顺序进行了总结，从最高优先级（最先绑定）到最低优先级（最后绑定）。 相同单元格内的运算符具有相同优先级。 除非句法显式地给出，否则运算符均指二元运算。 相同单元格内的运算符从左至右分组（除了幂运算是从右至左分组）。

请注意比较、成员检测和标识号检测均为相同优先级，并具有如 比较运算 一节所描述的从左至右串连特性。

运算符 | 描述
(expressions...), [expressions...], {key: value...}, {expressions...} | 绑定或加圆括号的表达式，列表显示，字典显示，集合显示
x[index], x[index:index], x(arguments...), x.attribute | 抽取，切片，调用，属性引用
await x | await 表达式
** | 乘方 5
+x, -x, ~x | 正，负，按位非 NOT
*, @, /, //, % | 乘，矩阵乘，除，整除，取余 6
+, - | 加和减
<<, >> | 移位
& | 按位与 AND
^ | 按位异或 XOR
| | 按位或 OR
in, not in, is, is not, <, <=, >, >=, !=, == | 比较运算，包括成员检测和标识号检测
not x | 布尔逻辑非 NOT
and | 布尔逻辑与 AND
or | 布尔逻辑或 OR
if -- else | 条件表达式
lambda | lambda 表达式
:= | 赋值表达式

备注

1

虽然 abs(x%y) < abs(y) 在数学中必为真，但对于浮点数而言，由于舍入的存在，其在数值上未必为真。 例如，假设在某个平台上的 Python 浮点数为一个 IEEE 754 双精度数值，为了使 -1e-100 % 1e100 具有与 1e100 相同的正负性，计算结果将是 -1e-100 + 1e100，这在数值上正好等于 1e100。 函数 math.fmod() 返回的结果则会具有与第一个参数相同的正负性，因此在这种情况下将返回 -1e-100。 何种方式更适宜取决于具体的应用。

2

如果 x 恰好非常接近于 y 的整数倍，则由于舍入的存在 x//y 可能会比 (x-x%y)//y 大。 在这种情况下，Python 会返回后一个结果，以便保持令 divmod(x,y)[0] * y + x % y 尽量接近 x.

3

Unicode 标准明确区分 码位 (例如 U+0041) 和 抽象字符 (例如 "大写拉丁字母 A")。 虽然 Unicode 中的大多数抽象字符都只用一个码位来代表，但也存在一些抽象字符可使用由多个码位组成的序列来表示。 例如，抽象字符 "带有下加符的大写拉丁字母 C" 可以用 U+00C7 码位上的单个 预设字符 来表示，也可以用一个 U+0043 码位上的 基础字符 (大写拉丁字母 C) 加上一个 U+0327 码位上的 组合字符 (组合下加符) 组成的序列来表示。

对于字符串，比较运算符会按 Unicode 码位级别进行比较。 这可能会违反人类的直觉。 例如，"\u00C7" == "\u0043\u0327" 为 False，虽然两个字符串都代表同一个抽象字符 "带有下加符的大写拉丁字母 C"。

要按抽象字符级别（即对人类来说更直观的方式）对字符串进行比较，应使用 unicodedata.normalize()。

4

由于存在自动垃圾收集、空闲列表以及描述器的动态特性，你可能会注意到在特定情况下使用 is 运算符会出现看似不正常的行为，例如涉及到实例方法或常量之间的比较时就是如此。 更多信息请查看有关它们的文档。

5

幂运算符 ** 绑定的紧密程度低于在其右侧的算术或按位一元运算符，也就是说 2**-1 为 0.5。

6

% 运算符也被用于字符串格式化；在此场合下会使用同样的优先级。

7. 简单语句

简单语句由一个单独的逻辑行构成。 多条简单语句可以存在于同一行内并以分号分隔。 简单语句的句法为:

simple_stmt ::=  expression_stmt
                 | assert_stmt
                 | assignment_stmt
                 | augmented_assignment_stmt
                 | annotated_assignment_stmt
                 | pass_stmt
                 | del_stmt
                 | return_stmt
                 | yield_stmt
                 | raise_stmt
                 | break_stmt
                 | continue_stmt
                 | import_stmt
                 | future_stmt
                 | global_stmt
                 | nonlocal_stmt

7.1. 表达式语句

表达式语句用于计算和写入值（大多是在交互模式下），或者（通常情况）调用一个过程 (过程就是不返回有意义结果的函数；在 Python 中，过程的返回值为 None)。 表达式语句的其他使用方式也是允许且有特定用处的。 表达式语句的句法为:

expression_stmt ::=  starred_expression

表达式语句会对指定的表达式列表（也可能为单一表达式）进行求值。

在交互模式下，如果结果值不为 None，它会通过内置的 repr() 函数转换为一个字符串，该结果字符串将以单独一行的形式写入标准输出（例外情况是如果结果为 None，则该过程调用不产生任何输出。）

7.2. 赋值语句

赋值语句用于将名称（重）绑定到特定值，以及修改属性或可变对象的成员项:

assignment_stmt ::=  (target_list "=")+ (starred_expression | yield_expression)
target_list     ::=  target ("," target)* [","]
target          ::=  identifier
                     | "(" [target_list] ")"
                     | "[" [target_list] "]"
                     | attributeref
                     | subscription
                     | slicing
                     | "*" target

(请参阅 原型 一节了解 属性引用, 抽取 和 切片 的句法定义。)

赋值语句会对指定的表达式列表进行求值（注意这可能为单一表达式或是由逗号分隔的列表，后者将产生一个元组）并将单一结果对象从左至右逐个赋值给目标列表。

赋值是根据目标（列表）的格式递归地定义的。 当目标为一个可变对象（属性引用、抽取或切片）的组成部分时，该可变对象必须最终执行赋值并决定其有效性，如果赋值操作不可接受也可能引发异常。 各种类型可用的规则和引发的异常通过对象类型的定义给出（参见 标准类型层级结构 一节）。

对象赋值的目标对象可以包含于圆括号或方括号内，具体操作按以下方式递归地定义。

如果目标列表为后面不带逗号、可以包含于圆括号内的单一目标，则将对象赋值给该目标。

否则:

如果目标列表包含一个带有星号前缀的目标，这称为“加星”目标：则该对象至少必须为与目标列表项数减一相同项数的可迭代对象。 该可迭代对象前面的项将按从左至右的顺序被赋值给加星目标之前的目标。 该可迭代对象末尾的项将被赋值给加星目标之后的目标。 然后该可迭代对象中剩余项的列表将被赋值给加星目标（该列表可以为空）。

否则：该对象必须为具有与目标列表相同项数的可迭代对象，这些项将按从左至右的顺序被赋值给对应的目标。

对象赋值给单个目标的操作按以下方式递归地定义。

如果目标为标识符（名称）:

如果该名称未出现于当前代码块的 global 或 nonlocal 语句中：该名称将被绑定到当前局部命名空间的对象。

否则：该名称将被分别绑定到全局命名空间或由 nonlocal 所确定的外层命名空间的对象。

如果该名称已经被绑定则将被重新绑定。 这可能导致之前被绑定到该名称的对象的引用计数变为零，造成该对象进入释放过程并调用其析构器（如果存在）。

如果该对象为属性引用：引用中的原型表达式会被求值。 它应该产生一个具有可赋值属性的对象；否则将引发 TypeError。 该对象会被要求将可赋值对象赋值给指定的属性；如果它无法执行赋值，则会引发异常 (通常应为 AttributeError 但并不强制要求)。

注意：如果该对象为类实例并且属性引用在赋值运算符的两侧都出现，则右侧表达式 a.x 可以访问实例属性或（如果实例属性不存在）类属性。 左侧目标 a.x 将总是设定为实例属性，并在必要时创建该实例属性。 因此 a.x 的两次出现不一定指向相同的属性：如果右侧表达式指向一个类属性，则左侧会创建一个新的实例属性作为赋值的目标:

class Cls:
    x = 3             # class variable
inst = Cls()
inst.x = inst.x + 1   # writes inst.x as 4 leaving Cls.x as 3

此描述不一定作用于描述器属性，例如通过 property() 创建的特征属性。

如果目标为一个抽取项：引用中的原型表达式会被求值。 它应当产生一个可变序列对象（例如列表）或一个映射对象（例如字典）。 接下来，该抽取表达式会被求值。

如果原型为一个可变序列对象（例如列表），抽取应产生一个整数。 如其为负值，则再加上序列长度。 结果值必须为一个小于序列长度的非负整数，序列将把被赋值对象赋值给该整数指定索引号的项。 如果索引超出范围，将会引发 IndexError (给被抽取序列赋值不能向列表添加新项)。

如果原型为一个映射对象（例如字典），抽取必须具有与该映射的键类型相兼容的类型，然后映射中会创建一个将抽取映射到被赋值对象的键/值对。 这可以是替换一个现有键/值对并保持相同键值，也可以是插入一个新键/值对（如果具有相同值的键不存在）。

对于用户定义对象，会调用 __setitem__() 方法并附带适当的参数。

如果目标为一个切片：引用中的原型表达式会被求值。 它应当产生一个可变序列对象（例如列表）。 被赋值对象应当是一个相同类型的序列对象。 接下来，下界与上界表达式如果存在的话将被求值；默认值分别为零和序列长度。 上下边界值应当为整数。 如果某一边界为负值，则会加上序列长度。 求出的边界会被裁剪至介于零和序列长度的开区间中。 最后，将要求序列对象以被赋值序列的项替换该切片。 切片的长度可能与被赋值序列的长度不同，这会在目标序列允许的情况下改变目标序列的长度。

CPython 实现细节： 在当前实现中，目标的句法被当作与表达式的句法相同，无效的句法会在代码生成阶段被拒绝，导致不太详细的错误信息。

虽然赋值的定义意味着左手边与右手边的重叠是“同时”进行的（例如 a, b = b, a 会交换两个变量的值），但在赋值给变量的多项集 之内 的重叠是从左至右进行的，这有时会令人混淆。 例如，以下程序将会打印出 [0, 2]:

x = [0, 1]
i = 0
i, x[i] = 1, 2         # i is updated, then x[i] is updated
print(x)

参见

PEP 3132 [https://www.python.org/dev/peps/pep-3132] - 扩展的可迭代对象拆包

对 *target 特性的规范说明。

7.2.1. 增强赋值语句

增强赋值语句就是在单个语句中将二元运算和赋值语句合为一体:

augmented_assignment_stmt ::=  augtarget augop (expression_list | yield_expression)
augtarget                 ::=  identifier | attributeref | subscription | slicing
augop                     ::=  "+=" | "-=" | "*=" | "@=" | "/=" | "//=" | "%=" | "**="
                               | ">>=" | "<<=" | "&=" | "^=" | "|="

（请参阅 原型 一节了解最后三种符号的句法定义。）

增强赋值语句将对目标和表达式列表求值（与普通赋值语句不同的是，前者不能为可迭代对象拆包），对两个操作数相应类型的赋值执行指定的二元运算，并将结果赋值给原始目标。 目标仅会被求值一次。

增强赋值语句例如 x += 1 可以改写为 x = x + 1 获得类似但并非完全等价的效果。 在增强赋值的版本中，x 仅会被求值一次。 而且，在可能的情况下，实际的运算是 原地 执行的，也就是说并不是创建一个新对象并将其赋值给目标，而是直接修改原对象。

不同于普通赋值，增强赋值会在对右手边求值 之前 对左手边求值。 例如，a[i] += f(x) 首先查找 a[i]，然后对 f(x) 求值并执行加法操作，最后将结果写回到 a[i]。

除了在单个语句中赋值给元组和多个目标的例外情况，增强赋值语句的赋值操作处理方式与普通赋值相同。 类似地，除了可能存在 原地 操作行为的例外情况，增强赋值语句执行的二元运算也与普通二元运算相同。

对于属性引用类目标，针对常规赋值的 关于类和实例属性的警告 也同样适用。

7.2.2. 带标注的赋值语句

标注 赋值就是在单个语句中将变量或属性标注和可选的赋值语句合为一体:

annotated_assignment_stmt ::=  augtarget ":" expression
                               ["=" (starred_expression | yield_expression)]

与普通 赋值语句 的差别在于仅允许单个目标。

对于将简单名称作为赋值目标的情况，如果是在类或模块作用域中，标注会被求值并存入一个特殊的类或模块属性 __annotations__ 中，这是一个将变量名称（如为私有会被移除）映射到被求值标注的字典。 此属性为可写并且在类或模块体开始执行时如果静态地发现标注就会自动创建。

对于将表达式作为赋值目标的情况，如果是在类或模块作用域中，标注会被求值，但不会保存。

如果一个名称在函数作用域内被标注，则该名称为该作用域的局部变量。 标注绝不会在函数作用域内被求值和保存。

如果存在右手边，带标注的赋值会在对标注求值之前（如果适用）执行实际的赋值。 如果用作表达式目标的右手边不存在，则解释器会对目标求值，但最后的 __setitem__() 或 __setattr__() 调用除外。

参见

PEP 526 [https://www.python.org/dev/peps/pep-0526] - 变量标注的语法

该提议增加了标注变量（也包括类变量和实例变量）类型的语法，而不再是通过注释来进行表达。

PEP 484 [https://www.python.org/dev/peps/pep-0484] - 类型提示

该提议增加了 typing 模块以便为类型标注提供标准句法，可被静态分析工具和 IDE 所使用。

在 3.8 版更改: 现在带有标注的赋值允许在右边以同样的表达式作为常规赋值。 之前某些表达式（例如未加圆括号的元组表达式）会导致语法错误。

7.3. assert 语句

assert 语句是在程序中插入调试性断言的简便方式:

assert_stmt ::=  "assert" expression ["," expression]

简单形式 assert expression 等价于

if __debug__:
    if not expression: raise AssertionError

扩展形式 assert expression1, expression2 等价于

if __debug__:
    if not expression1: raise AssertionError(expression2)

以上等价形式假定 __debug__ 和 AssertionError 指向具有指定名称的内置变量。 在当前实现中，内置变量 __debug__ 在正常情况下为 True，在请求优化时为 False (对应命令行选项为 -O)。 如果在编译时请求优化，当前代码生成器不会为 assert 语句发出任何代码。 请注意不必在错误信息中包含失败表达式的源代码；它会被作为栈追踪的一部分被显示。

赋值给 __debug__ 是非法的。 该内置变量的值会在解释器启动时确定。

7.4. pass 语句

pass_stmt ::=  "pass"

pass 是一个空操作 --- 当它被执行时，什么都不发生。 它适合当语法上需要一条语句但并不需要执行任何代码时用来临时占位，例如:

def f(arg): pass    # a function that does nothing (yet)

class C: pass       # a class with no methods (yet)

7.5. del 语句

del_stmt ::=  "del" target_list

删除是递归定义的，与赋值的定义方式非常类似。 此处不再详细说明，只给出一些提示。

目标列表的删除将从左至右递归地删除每一个目标。

名称的删除将从局部或全局命名空间中移除该名称的绑定，具体作用域的确定是看该名称是否有在同一代码块的 global 语句中出现。 如果该名称未被绑定，将会引发 NameError。

属性引用、抽取和切片的删除会被传递给相应的原型对象；删除一个切片基本等价于赋值为一个右侧类型的空切片（但即便这一点也是由切片对象决定的）。

在 3.2 版更改: 在之前版本中，如果一个名称作为被嵌套代码块中的自由变量出现，则将其从局部命名空间中删除是非法的。

7.6. return 语句

return_stmt ::=  "return" [expression_list]

return 在语法上只会出现于函数定义所嵌套的代码，不会出现于类定义所嵌套的代码。

如果提供了表达式列表，它将被求值，否则以 None 替代。

return 会离开当前函数调用，并以表达式列表 (或 None) 作为返回值。

当 return 将控制流传出一个带有 finally 子句的 try 语句时，该 finally 子句会先被执行然后再真正离开该函数。

在一个生成器函数中，return 语句表示生成器已完成并将导致 StopIteration 被引发。 返回值（如果有的话）会被当作一个参数用来构建 StopIteration 并成为 StopIteration.value 属性。

在一个异步生成器函数中，一个空的 return 语句表示异步生成器已完成并将导致 StopAsyncIteration 被引发。 一个非空的 return 语句在异步生成器函数中会导致语法错误。

7.7. yield 语句

yield_stmt ::=  yield_expression

yield 语句在语义上等同于 yield 表达式。 yield 语句可用来省略在使用等效的 yield 表达式语句时所必须的圆括号。 例如，以下 yield 语句

yield <expr>
yield from <expr>

等同于以下 yield 表达式语句

(yield <expr>)
(yield from <expr>)

yield 表达式和语句仅在定义 generator 函数时使用，并且仅被用于生成器函数的函数体内部。 在函数定义中使用 yield 就足以使得该定义创建的是生成器函数而非普通函数。

有关 yield 语义的完整细节请参看 yield 表达式 一节。

7.8. raise 语句

raise_stmt ::=  "raise" [expression ["from" expression]]

如果没有提供表达式，则 raise 会重新引发当前正在处理的异常，它也被称为 活动的异常。 如果当前没有活动的异常，则会引发 RuntimeError 来提示发生了错误。

否则的话，raise 会将第一个表达式求值为异常对象。 它必须为 BaseException 的子类或实例。 如果它是一个类，当需要时会通过不带参数地实例化该类来获得异常的实例。

异常的 类型 为异常实例的类，值 为实例本身。

当有异常被引发时通常会自动创建一个回溯对象并将其关联到它的 __traceback__ 属性，该属性是可写的。 你可以创建一个异常并使用 with_traceback() 异常方法（该方法将返回同一异常实例，并将回溯对象设为其参数）直接设置自己的回溯对象，就像这样like so:

raise Exception("foo occurred").with_traceback(tracebackobj)

from 子句用于异常串连：如果有该子句，则第二个 表达式 必须为另一个异常类或实例。 如果第二个表达式是一个异常实例，它将作为可写的 __cause__ 属性被关联到所引发的异常。 如果该表达式是一个异常类，这个类将被实例化且所生成的异常实例将作为 __cause__ 属性被关联到所引发的异常。 如果所引发的异常未被处理，则两个异常都将被打印出来:

>>> 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>
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>
RuntimeError: Something bad happened

当已经有一个异常在处理时如果有新的异常被引发则类似的机制会隐式地起作用。 异常可以通过使用 except 或 finally 子句或是 with 语句来处理。 之前的异常将被关联至新异常的 __context__ 属性:

>>> try:
...     print(1 / 0)
... except:
...     raise RuntimeError("Something bad happened")
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
ZeroDivisionError: division by zero

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
RuntimeError: Something bad happened

异常串连可通过在 from 子句中指定 None 来显式地加以抑制:

>>> 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

有关异常的更多信息可在 异常 一节查看，有关处理异常的信息可在 try 语句 一节查看。

在 3.3 版更改: None 现在允许被用作 raise X from Y 中的 Y。

3.3 新版功能: 使用 __suppress_context__ 属性来抑制异常上下文的自动显示。

7.9. break 语句

break_stmt ::=  "break"

break 在语法上只会出现于 for 或 while 循环所嵌套的代码，但不会出现于该循环内部的函数或类定义所嵌套的代码。

它会终结最近的外层循环，如果循环有可选的 else 子句，也会跳过该子句。

如果一个 for 循环被 break 所终结，该循环的控制目标会保持其当前值。

当 break 将控制流传出一个带有 finally 子句的 try 语句时，该 finally 子句会先被执行然后再真正离开该循环。

7.10. continue 语句

continue_stmt ::=  "continue"

continue 在语法上只会出现于 for 或 while 循环所嵌套的代码中，但不会出现于该循环内部的函数或类定义中。 它会继续执行最近的外层循环的下一个轮次。

当 continue 将控制流传出一个带有 finally 子句的 try 语句时，该 finally 子句会先被执行然后再真正开始循环的下一个轮次。

7.11. import 语句

import_stmt     ::=  "import" module ["as" identifier] ("," module ["as" identifier])*
                     | "from" relative_module "import" identifier ["as" identifier]
                     ("," identifier ["as" identifier])*
                     | "from" relative_module "import" "(" identifier ["as" identifier]
                     ("," identifier ["as" identifier])* [","] ")"
                     | "from" relative_module "import" "*"
module          ::=  (identifier ".")* identifier
relative_module ::=  "."* module | "."+

基本的 import 语句（不带 from 子句）会分两步执行:

查找一个模块，如果有必要还会加载并初始化模块。

在局部命名空间中为 import 语句发生位置所处的作用域定义一个或多个名称。

当语句包含多个子句（由逗号分隔）时这两个步骤将对每个子句分别执行，如同这些子句被分成独立的 import 语句一样。

第一个步骤，即查找和加载模块的细节在 导入系统 一节中有更详细的描述，其中也描述了可被导入的多种类型的包和模块，以及可用于定制导入系统的所有钩子对象。 请注意如果这一步失败，则可能说明模块无法找到，或者 是在初始化模块，包括执行模块代码期间发生了错误。

如果成功获取到请求的模块，则可以通过以下三种方式一之在局部命名空间中使用它:

模块名后使用 as 时，直接把 as 后的名称与导入模块绑定。

如果没有指定其他名称，且被导入的模块为最高层级模块，则模块的名称将被绑定到局部命名空间作为对所导入模块的引用。

如果被导入的模块 不是 最高层级模块，则包含该模块的最高层级包的名称将被绑定到局部命名空间作为对该最高层级包的引用。 所导入的模块必须使用其完整限定名称来访问而不能直接访问。

from 形式使用的过程略微繁复一些:

查找 from 子句中指定的模块，如有必要还会加载并初始化模块；

对于 import 子句中指定的每个标识符：

检查被导入模块是否有该名称的属性

如果没有，尝试导入具有该名称的子模块，然后再次检查被导入模块是否有该属性

如果未找到该属性，则引发 ImportError。

否则的话，将对该值的引用存入局部命名空间，如果有 as 子句则使用其指定的名称，否则使用该属性的名称

示例:

import foo                 # foo imported and bound locally
import foo.bar.baz         # foo, foo.bar, and foo.bar.baz imported, foo bound locally
import foo.bar.baz as fbb  # foo, foo.bar, and foo.bar.baz imported, foo.bar.baz bound as fbb
from foo.bar import baz    # foo, foo.bar, and foo.bar.baz imported, foo.bar.baz bound as baz
from foo import attr       # foo imported and foo.attr bound as attr

如果标识符列表改为一个星号 ('*')，则在模块中定义的全部公有名称都将按 import 语句所在的作用域被绑定到局部命名空间。

一个模块所定义的 公有名称 是由在模块的命名空间中检测一个名为 __all__ 的变量来确定的；如果有定义，它必须是一个字符串列表，其中的项为该模块所定义或导入的名称。 在 __all__ 中所给出的名称都会被视为公有并且应当存在。 如果 __all__ 没有被定义，则公有名称的集合将包含在模块的命名空间中找到的所有不以下划线字符 ('_') 打头的名称。 __all__ 应当包括整个公有 API。 它的目标是避免意外地导出不属于 API 的一部分的项（例如在模块内部被导入和使用的库模块）。

通配符形式的导入 --- from module import * --- 仅在模块层级上被允许。 尝试在类或函数定义中使用它将引发 SyntaxError。

当指定要导入哪个模块时，你不必指定模块的绝对名称。 当一个模块或包被包含在另一个包之中时，可以在同一个最高层级包中进行相对导入，而不必提及包名称。 通过在 from 之后指定的模块或包中使用前缀点号，你可以在不指定确切名称的情况下指明在当前包层级结构中要上溯多少级。 一个前缀点号表示是执行导入的模块所在的当前包，两个点号表示上溯一个包层级。 三个点号表示上溯两级，依此类推。 因此如果你执行 from . import mod 时所处位置为 pkg 包内的一个模块，则最终你将导入 pkg.mod。 如果你执行 from ..subpkg2 import mod 时所处位置为 pkg.subpkg1 则你将导入 pkg.subpkg2.mod。 有关相对导入的规范说明包含在 包相对导入 一节中。

importlib.import_module() 被提供用来为动态地确定要导入模块的应用提供支持。

引发一个 审计事件 import 并附带参数 module, filename, sys.path, sys.meta_path, sys.path_hooks。

7.11.1. future 语句

future 语句 是一种针对编译器的指令，指明某个特定模块应当使用在特定的未来某个 Python 发行版中成为标准特性的语法或语义。

future 语句的目的是使得向在语言中引入了不兼容改变的 Python 未来版本的迁移更为容易。 它允许基于每个模块在某种新特性成为标准之前的发行版中使用该特性。

future_stmt ::=  "from" "__future__" "import" feature ["as" identifier]
                 ("," feature ["as" identifier])*
                 | "from" "__future__" "import" "(" feature ["as" identifier]
                 ("," feature ["as" identifier])* [","] ")"
feature     ::=  identifier

future 语句必须在靠近模块开头的位置出现。 可以出现在 future 语句之前行只有:

模块的文档字符串（如果存在），

注释，

空行，以及

其他 future 语句。

唯一需要使用 future 语句的特性是 标注 (参见 PEP 563 [https://www.python.org/dev/peps/pep-0563])。

future 语句所启用的所有历史特性仍然为 Python 3 所认可。 其中包括 absolute_import, division, generators, generator_stop, unicode_literals, print_function, nested_scopes 和 with_statement。 它们都已成为冗余项，因为它们总是为已启用状态，保留它们只是为了向后兼容。

future 语句在编译时会被识别并做特殊对待：对核心构造语义的改变常常是通过生成不同的代码来实现。 新的特性甚至可能会引入新的不兼容语法（例如新的保留字），在这种情况下编译器可能需要以不同的方式来解析模块。 这样的决定不能推迟到运行时方才作出。

对于任何给定的发布版本，编译器要知道哪些特性名称已被定义，如果某个 future 语句包含未知的特性则会引发编译时错误。

直接运行时的语义与任何 import 语句相同：存在一个后文将详细说明的标准模块 __future__，它会在执行 future 语句时以通常的方式被导入。

相应的运行时语义取决于 future 语句所启用的指定特性。

请注意以下语句没有任何特别之处:

import __future__ [as name]

这并非 future 语句；它只是一条没有特殊语义或语法限制的普通 import 语句。

在默认情况下，通过对Code compiled by calls to the 内置函数 exec() 和 compile() 的调用所编译的代码如果出现于一个包含有 future 语句的模块 M 之中，就会使用 future 语句所关联的语法和语义。 此行为可以通过 compile() 的可选参数加以控制 --- 请参阅该函数的文档以了解详情。

在交互式解释器提示符中键入的 future 语句将在解释器会话此后的交互中有效。 如果一个解释器的启动使用了 -i 选项启动，并传入了一个脚本名称来执行，且该脚本包含 future 语句，它将在交互式会话开始执行脚本之后保持有效。

参见

PEP 236 [https://www.python.org/dev/peps/pep-0236] - 回到 __future__

有关 __future__ 机制的最初提议。

7.12. global 语句

global_stmt ::=  "global" identifier ("," identifier)*

global 语句是作用于整个当前代码块的声明。 它意味着所列出的标识符将被解读为全局变量。 要给全局变量赋值不可能不用到 global 关键字，不过自由变量也可以指向全局变量而不必声明为全局变量。

在 global 语句中列出的名称不得在同一代码块内该 global 语句之前的位置中使用。

在 global 语句中列出的名称不能被定义为形式参数，也不能被作为 with 语句或 except 子句的目标，以及 for 循环的目标列表、class 定义、函数定义、import 语句或变量标注等等。

CPython 实现细节： 当前的实现并未强制要求所有的上述限制，但程序不应当滥用这样的自由，因为未来的实现可能会改为强制要求，并静默地改变程序的含义。

程序员注意事项: global 是对解析器的指令。 它仅对与 global 语句同时被解析的代码起作用。 特别地，包含在提供给内置 exec() 函数字符串或代码对象中的 global 语句并不会影响 包含 该函数调用的代码块，而包含在这种字符串中的代码也不会受到包含该函数调用的代码中的 global 语句影响。 这同样适用于 eval() 和 compile() 函数。

7.13. nonlocal 语句

nonlocal_stmt ::=  "nonlocal" identifier ("," identifier)*

nonlocal 语句会使得所列出的名称指向之前在最近的包含作用域中绑定的除全局变量以外的变量。 这种功能很重要，因为绑定的默认行为是先搜索局部命名空间。 这个语句允许被封装的代码重新绑定局部作用域以外且非全局（模块）作用域当中的变量。

与 global 语句中列出的名称不同，nonlocal 语句中列出的名称必须指向之前存在于包含作用域之中的绑定（在这个应当用来创建新绑定的作用域不能被无歧义地确定）。

nonlocal 语句中列出的名称不得与之前存在于局部作用域中的绑定相冲突。

参见

PEP 3104 [https://www.python.org/dev/peps/pep-3104] - 访问外层作用域中的名称

有关 nonlocal 语句的规范说明。

8. 复合语句

复合语句是包含其它语句（语句组）的语句；它们会以某种方式影响或控制所包含其它语句的执行。 通常，复合语句会跨越多行，虽然在某些简单形式下整个复合语句也可能包含于一行之内。

if, while 和 for 语句用来实现传统的控制流程构造。 try 语句为一组语句指定异常处理和/和清理代码，而 with 语句允许在一个代码块周围执行初始化和终结化代码。 函数和类定义在语法上也属于复合语句。

一条复合语句由一个或多个‘子句’组成。 一个子句则包含一个句头和一个‘句体’。 特定复合语句的子句头都处于相同的缩进层级。 每个子句头以一个作为唯一标识的关键字开始并以一个冒号结束。 子句体是由一个子句控制的一组语句。 子句体可以是在子句头的冒号之后与其同处一行的一条或由分号分隔的多条简单语句，或者也可以是在其之后缩进的一行或多行语句。 只有后一种形式的子句体才能包含嵌套的复合语句；以下形式是不合法的，这主要是因为无法分清某个后续的 else 子句应该属于哪个 if 子句:

if test1: if test2: print(x)

还要注意的是在这种情形下分号的绑定比冒号更紧密，因此在以下示例中，所有 print() 调用或者都不执行，或者都执行:

if x < y < z: print(x); print(y); print(z)

总结:

compound_stmt ::=  if_stmt
                   | while_stmt
                   | for_stmt
                   | try_stmt
                   | with_stmt
                   | match_stmt
                   | funcdef
                   | classdef
                   | async_with_stmt
                   | async_for_stmt
                   | async_funcdef
suite         ::=  stmt_list NEWLINE | NEWLINE INDENT statement+ DEDENT
statement     ::=  stmt_list NEWLINE | compound_stmt
stmt_list     ::=  simple_stmt (";" simple_stmt)* [";"]

请注意语句总是以 NEWLINE 结束，之后可能跟随一个 DEDENT。 还要注意可选的后续子句总是以一个不能作为语句开头的关键字作为开头，因此不会产生歧义（‘悬空的 else’问题在 Python 中是通过要求嵌套的 if 语句必须缩进来解决的)。

为了保证清晰，以下各节中语法规则采用将每个子句都放在单独行中的格式。

8.1. if 语句

if 语句用于有条件的执行:

if_stmt ::=  "if" assignment_expression ":" suite
             ("elif" assignment_expression ":" suite)*
             ["else" ":" suite]

它通过对表达式逐个求值直至找到一个真值（请参阅 布尔运算 了解真值与假值的定义）在子句体中选择唯一匹配的一个；然后执行该子句体（而且 if 语句的其他部分不会被执行或求值）。 如果所有表达式均为假值，则如果 else 子句体如果存在就会被执行。

8.2. while 语句

while 语句用于在表达式保持为真的情况下重复地执行:

while_stmt ::=  "while" assignment_expression ":" suite
                ["else" ":" suite]

这将重复地检验表达式，并且如果其值为真就执行第一个子句体；如果表达式值为假（这可能在第一次检验时就发生）则如果 else 子句体存在就会被执行并终止循环。

第一个子句体中的 break 语句在执行时将终止循环且不执行 else 子句体。 第一个子句体中的 continue 语句在执行时将跳过子句体中的剩余部分并返回检验表达式。

8.3. for 语句

for 语句用于对序列（例如字符串、元组或列表）或其他可迭代对象中的元素进行迭代:

for_stmt ::=  "for" target_list "in" expression_list ":" suite
              ["else" ":" suite]

表达式列表会被求值一次；它应该产生一个可迭代对象。 系统将为 expression_list 的结果创建一个迭代器，然后将为迭代器所提供的每一项执行一次子句体，具体次序与迭代器的返回顺序一致。 每一项会按标准赋值规则 (参见 赋值语句) 被依次赋值给目标列表，然后子句体将被执行。 当所有项被耗尽时 (这会在序列为空或迭代器引发 StopIteration 异常时立刻发生)，else 子句的子句体如果存在将会被执行，并终止循环。

第一个子句体中的 break 语句在执行时将终止循环且不执行 else 子句体。 第一个子句体中的 continue 语句在执行时将跳过子句体中的剩余部分并转往下一项继续执行，或者在没有下一项时转往 else 子句执行。

for 循环会对目标列表中的变量进行赋值。 这将覆盖之前对这些变量的所有赋值，包括在 for 循环体中的赋值:

for i in range(10):
    print(i)
    i = 5             # this will not affect the for-loop
                      # because i will be overwritten with the next
                      # index in the range

目标列表中的名称在循环结束时不会被删除，但是如果序列为空，则它们将根本不会被循环所赋值。 提示：内置类型 range() 代表由整数组成的不可变算数序列。 例如，迭代 range(3) 将依次产生 0, 1 和 2。

8.4. try 语句

try 语句可为一组语句指定异常处理器和/或清理代码:

try_stmt  ::=  try1_stmt | try2_stmt
try1_stmt ::=  "try" ":" suite
               ("except" [expression ["as" identifier]] ":" suite)+
               ["else" ":" suite]
               ["finally" ":" suite]
try2_stmt ::=  "try" ":" suite
               "finally" ":" suite

except 子句指定一个或多个异常处理程序。 当 try 子句中无异常发生时，也不会有任何异常处理程序被执行。 当 try 子句中发生异常时，将启动对异常处理程序的搜索。 此搜索会逐一检查 except 子句直至找到与该异常相匹配的子句。 如果存在无表达式的 except 子句，它必须是最后一个；它将匹配任何异常。 对于带有表达式的 except 子句，该表达式会被未付，如果结果对象与发生的异常“兼容”，则该子句将匹配当前异常。 如果一个对象是异常对象所属的类或是其 非虚基类，或者是包含异常对象的类的非虚基类的元组，则此对象与异常是兼容的。

如果没有 except 子句与异常相匹配，则会在周边代码和发起调用栈上继续搜索异常处理器。 1

如果在对 except 子句头中的表达式求值时引发了异常，则原来对处理器的搜索会被取消，并在周边代码和调用栈上启动对新异常的搜索（它会被视作是整个 try 语句所引发的异常）。

当找到一个匹配的 except 子句时，该异常将被赋值给该 except 子句在 as 关键字之后指定的目标，如果存在此关键字的话，并且该 except 子句体将被执行。 所有 except 子句都必须有可执行的子句体。 当到达子句体的末尾时，通常会转向整个 try 语句之后继续执行。 （这意味着如果对于同一异常存在有嵌套的两个处理器，而异常发生于内层处理器的 try 子句中，则外层处理器将不会处理该异常。）

当使用 as 将目标赋值为一个异常时，它将在 except 子句结束时被清除。 这就相当于

except E as N:
    foo

被转写为

except E as N:
    try:
        foo
    finally:
        del N

这意味着异常必须赋值给一个不同的名称才能在 except 子句之后引用它。 异常会被清除是因为在附加了回溯信息的情况下，它们会形成堆栈帧的循环引用，使得所有局部变量保持存活直到发生下一次垃圾回收。

在一个 except 子句体被执行之前，有关异常的详细信息存放在 sys 模块中，可通过 sys.exc_info() 来访问。 sys.exc_info() 返回一个 3 元组，由异常类、异常实例和回溯对象组成（参见 标准类型层级结构 一节），用于在程序中标识异常发生点。 当从处理异常的代码返回时，通过 sys.exc_info() 访问的异常详细信息会恢复到之前的值:

>>> print(sys.exc_info())
(None, None, None)
>>> try:
...     raise TypeError
... except:
...     print(sys.exc_info())
...     try:
...          raise ValueError
...     except:
...         print(sys.exc_info())
...     print(sys.exc_info())
...
(<class 'TypeError'>, TypeError(), <traceback object at 0x10efad080>)
(<class 'ValueError'>, ValueError(), <traceback object at 0x10efad040>)
(<class 'TypeError'>, TypeError(), <traceback object at 0x10efad080>)
>>> print(sys.exc_info())
(None, None, None)

如果控制流离开 try 子句体时没有引发异常，并且没有执行 return, continue 或 break 语句，可选的 else 子句将被执行。 else 语句中的异常不会由之前的 except 子句处理。

如果存在 finally，它将指定一个‘清理’处理程序。 try 子句会被执行，包括任何 except 和 else 子句。 如果在这些子句中发生任何未处理的异常，该异常会被临时保存。 finally 子句将被执行。 如果存在被保存的异常，它会在 finally 子句的末尾被重新引发。 如果 finally 子句引发了另一个异常，被保存的异常会被设为新异常的上下文。 如果 finally 子句执行了 return, break 或 continue 语句，则被保存的异常会被丢弃:

>>> def f():
...     try:
...         1/0
...     finally:
...         return 42
...
>>> f()
42

在 finally 子句执行期间，程序不能获取异常信息。

当 return, break 或 continue 语句在一个 try...finally 语句的 try 子语句体中被执行时，finally 子语句也会‘在离开时’被执行。

函数的返回值是由最后被执行的 return 语句所决定的。 由于 finally 子句总是被执行，因此在 finally 子句中被执行的 return 语句总是最后被执行的:

>>> def foo():
...     try:
...         return 'try'
...     finally:
...         return 'finally'
...
>>> foo()
'finally'

有关异常的更多信息可以在 异常 一节找到，有关使用 raise 语句生成异常的信息可以在 raise 语句 一节找到。

在 3.8 版更改: 在 Python 3.8 之前，continue 语句不允许在 finally 子句中使用，这是因为具体实现存在一个问题。

8.5. with 语句

with 语句用于包装带有使用上下文管理器 (参见 with 语句上下文管理器 一节) 定义的方法的代码块的执行。 这允许对普通的 try...except...finally 使用模式进行封装以方便地重用。

with_stmt          ::=  "with" ( "(" with_stmt_contents ","? ")" | with_stmt_contents ) ":" suite
with_stmt_contents ::=  with_item ("," with_item)*
with_item          ::=  expression ["as" target]

带有一个“项目”的 with 语句的执行过程如下:

对上下文表达式（在 with_item 中给出的表达式）进行求值来获得上下文管理器。

载入上下文管理器的 __enter__() 以便后续使用。

载入上下文管理器的 __exit__() 以便后续使用。

发起调用上下文管理器的 __enter__() 方法。

如果 with 语句中包含一个目标，来自 __enter__() 的返回值将被赋值给它。

注解

with 语句会保证只要 __enter__() 方法未发生错误即返回，则 __exit__() 将总是被调用。 因此，如果在对目标列表赋值期间发生错误，它将被当作在语句体内部发生的错误来处理。 参见下面的第 7 步。

执行语句体。

发起调用上下文管理器的 __exit__() 方法。 如果语句体的退出是由异常导致的，则其类型、值和回溯信息将被作为参数传递给 __exit__()。 否则的话，将提供三个 None 参数。

如果语句体的退出是由异常导致的，并且来自 __exit__() 方法的返回值为假，则该异常会被重新引发。 如果返回值为真，则该异常会被抑制，并会继续执行 with 语句之后的语句。

如果语句体由于异常以外的任何原因退出，则来自 __exit__() 的返回值会被忽略，并会在该类退出正常的发生位置继续执行。

以下代码:

with EXPRESSION as TARGET:
    SUITE

在语义上等价于:

manager = (EXPRESSION)
enter = type(manager).__enter__
exit = type(manager).__exit__
value = enter(manager)
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not exit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        exit(manager, None, None, None)

如果有多个项目，则会视作存在多个 with 语句嵌套来处理多个上下文管理器:

with A() as a, B() as b:
    SUITE

在语义上等价于:

with A() as a:
    with B() as b:
        SUITE

也可以用圆括号包围的多行形式的多项目上下文管理器。例如:

with (
    A() as a,
    B() as b,
):
    SUITE

在 3.1 版更改: 支持多个上下文表达式。

在 3.10 版更改: Support for using grouping parentheses to break the statement in multiple lines.

参见

PEP 343 [https://www.python.org/dev/peps/pep-0343] - "with" 语句

Python with 语句的规范描述、背景和示例。

8.6. match 语句

3.10 新版功能.

匹配语句用于进行模式匹配。语法如下：

match_stmt   ::=  'match' subject_expr ":" NEWLINE INDENT case_block+ DEDENT
subject_expr ::=  star_named_expression "," star_named_expressions?
                  | named_expression
case_block   ::=  'case' patterns [guard] ":" block

注解

本节使用单引号来表示 软关键字。

模式匹配接受一个模式作为输入（跟在 case 后），一个目标值（跟在 match 后）。该模式（可能包含子模式）将与目标值进行匹配。输出是：

匹配成功或失败（也被称为模式成功或失败）。

可能将匹配的值绑定到一个名字上。 这方面的先决条件将在下面进一步讨论。

关键字 match 和 case 是 soft keywords 。

参见

PEP 634 [https://www.python.org/dev/peps/pep-0634] —— 结构化模式匹配：规范

PEP 636 [https://www.python.org/dev/peps/pep-0636] —— 结构化模式匹配：教程

8.6.1. 概述

匹配语句逻辑流程的概述如下：

对目标表达式 subject_expr 求值后将结果作为匹配用的目标值。 如果目标表达式包含逗号，则使用 the standard rules 构建一个元组。

目标值将依次与 case_block 中的每个模式进行匹配。匹配成功或失败的具体规则在下面描述。匹配尝试也可以与模式中的一些或所有的独立名称绑定。准确的模式绑定规则因模式类型而异，具体规定见下文。成功的模式匹配过程中产生的名称绑定将超越所执行的块的范围，可以在匹配语句之后使用。

注解

在模式匹配失败时，一些子模式可能会成功。 不要依赖于失败匹配进行的绑定。 反过来说，不要认为变量在匹配失败后保持不变。 确切的行为取决于实现，可能会有所不同。 这是一个有意的决定，允许不同的实现添加优化。

如果该模式匹配成功，并且完成了对相应的约束项（如果存在）的求值。在这种情况下，保证完成所有的名称绑定。

如果约束项求值为真或缺失，执行 case_block 中的 block 。

否则，将按照上述方法尝试下一个 case_block 。

如果没有进一步的 case 块，匹配语句终止。

注解

用户一般不应依赖正在求值的模式。 根据不同的实现方式，解释器可能会缓存数值或使用其他优化方法来避免重复求值。

匹配语句示例:

>>> flag = False
>>> match (100, 200):
...    case (100, 300):  # Mismatch: 200 != 300
...        print('Case 1')
...    case (100, 200) if flag:  # Successful match, but guard fails
...        print('Case 2')
...    case (100, y):  # Matches and binds y to 200
...        print(f'Case 3, y: {y}')
...    case _:  # Pattern not attempted
...        print('Case 4, I match anything!')
...
Case 3, y: 200

在这个示例中，if flag 是约束项。请阅读下一节以了解更多相关内容。

8.6.2. 约束项

guard ::=  "if" named_expression

guard (它是 case 的一部分) 必须成立才能让 case 语句块中的代码被执行。 它所采用的形式为: if 之后跟一个表达式。

拥有 guard 的 case 块的逻辑流程如下：

检查 case 块中的模式是否匹配成功。如果该模式匹配失败，则不对 guard 进行求值，检查下一个 case 块。

如果该模式匹配成功，对 guard 求值。

如果 guard 求值为真，则选用该 case 块。

如果 guard 求值为假，则不选用该 case 块。

如果在对 guard 求值过程中引发了异常，则异常将被抛出。

允许约束项产生副作用，因为他们是表达式。约束项求值必须从第一个 case 块到最后一个 case 块依次逐个进行，模式匹配失败的 case 块将被跳过。（也就是说，约束项求值必须按顺序进行。）一旦选用了一个 case 块，约束项求值必须由此终止。

8.6.3. 必定匹配的 case 块

必定匹配的 case 块是能匹配所有情况的 case 块。一个匹配语句最多可以有一个必定匹配的 case 块，而且必须是最后一个。

如果一个 case 块没有约束项，并且其模式是必定匹配的，那么它就被认为是必定匹配的。 如果我们可以仅从语法上证明一个模式总是能匹配成功，那么这个模式就被认为是必定匹配的。 只有以下模式是必定匹配的：

左侧模式是必定匹配的 AS 模式

包含至少一个必定匹配模式的 或模式

捕获模式

通配符模式

括号内的必定匹配模式

8.6.4. 模式

注解

本节使用了超出标准 EBNF 的语法符号。

符号 SEP.RULE+ 是 RULE (SEP RULE)* 的简写

符号 !RULE 是前向否定断言的简写

patterns 的顶层语法是：

patterns       ::=  open_sequence_pattern | pattern
pattern        ::=  as_pattern | or_pattern
closed_pattern ::=  | literal_pattern
                    | capture_pattern
                    | wildcard_pattern
                    | value_pattern
                    | group_pattern
                    | sequence_pattern
                    | mapping_pattern
                    | class_pattern

下面的描述将包括一个“简而言之”以描述模式的作用，便于说明问题（感谢 Raymond Hettinger 提供的一份文件，大部分的描述受其启发）。请注意，这些描述纯粹是为了说明问题，可能不 反映底层的实现。此外，它们并没有涵盖所有有效的形式。

8.6.4.1. 或模式

或模式是由竖杠 | 分隔的两个或更多的模式。语法：

or_pattern ::=  "|".closed_pattern+

只有最后的子模式可以是 必定匹配的，且每个子模式必须绑定相同的名字集以避免歧义。

或模式将目标值依次与其每个子模式尝试匹配，直到有一个匹配成功，然后该或模式被视作匹配成功。 否则，如果没有任何子模式匹配成功，则或模式匹配失败。

简而言之，P1 | P2 | ... 会首先尝试匹配 P1 ，如果失败将接着尝试匹配 P2 ，如果出现成功的匹配则立即结束且模式匹配成功，否则模式匹配失败。

8.6.4.2. AS 模式

AS 模式将关键字 as 左侧的或模式与目标值进行匹配。语法：

as_pattern ::=  or_pattern "as" capture_pattern

如果 OR 模式匹配失败，则 AS 模式也会失败。 在其他情况下，AS 模块会将目标与 as 关键字右边的名称绑定并匹配成功。 capture_pattern 不可为 _。

简而言之， P as NAME 将与 P 匹配，成功后将设置 NAME = <subject> 。

8.6.4.3. 字面值模式

字面值模式对应 Python 中的大多数 字面值。 语法为:

literal_pattern ::=  signed_number
                     | signed_number "+" NUMBER
                     | signed_number "-" NUMBER
                     | strings
                     | "None"
                     | "True"
                     | "False"
                     | signed_number: NUMBER | "-" NUMBER

规则 strings 和标记 NUMBER 是在 standard Python grammar 中定义的。支持三引号的字符串。不支持原始字符串和字节字符串。也不支持 格式字符串字面值 。

signed_number '+' NUMBER 和 signed_number '-' NUMBER 形式是用于表示 复数；它们要求左边是一个实数而右边是一个虚数。 例如 3 + 4j。

简而言之， LITERAL 只会在 <subject> == LITERAL 时匹配成功。对于单例 None 、 True 和 False ，会使用 is 运算符。

8.6.4.4. 捕获模式

捕获模式将目标值与一个名称绑定。语法：

capture_pattern ::=  !'_' NAME

单独的一个下划线 _ 不是捕获模式（ !'_' 表达的就是这个含义）。 它会被当作 wildcard_pattern 。

在给定的模式中，一个名字只能被绑定一次。例如 case x, x: ... 时无效的，但 case [x] | x: ... 是被允许的。

捕获模式总是能匹配成功。绑定遵循 PEP 572 [https://www.python.org/dev/peps/pep-0572] 中赋值表达式运算符设立的作用域规则；名字在最接近的包含函数作用域内成为一个局部变量，除非有适用的 global 或 nonlocal 语句。

简而言之， NAME 总是会匹配成功且将设置 NAME = <subject> 。

8.6.4.5. 通配符模式

通配符模式总是会匹配成功（匹配任何内容）并且不绑定任何名称。语法：

wildcard_pattern ::=  '_'

在且仅在任何模式中 _ 是一个 软关键字。 通常情况下它是一个标识符，即使是在 match 的目标表达式、guard 和 case 代码块中也是如此。

简而言之，_ 总是会匹配成功。

8.6.4.6. 值模式

值模式代表 Python 中具有名称的值。语法：

value_pattern ::=  attr
attr          ::=  name_or_attr "." NAME
name_or_attr  ::=  attr | NAME

模式中带点的名称会使用标准的 Python 名称解析规则 来查找。 如果找到的值与目标值比较结果相等则模式匹配成功（使用 == 相等运算符）。

简而言之， NAME1.NAME2 仅在 <subject> == NAME1.NAME2 时匹配成功。

注解

如果相同的值在同一个匹配语句中出现多次，解释器可能会缓存找到的第一个值并重新使用它，而不是重复查找。 这种缓存与特定匹配语句的执行严格挂钩。

8.6.4.7. 组模式

组模式允许用户在模式周围添加括号，以强调预期的分组。 除此之外，它没有额外的语法。语法：

group_pattern ::=  "(" pattern ")"

简单来说 (P) 具有与 P 相同的效果。

8.6.4.8. 序列模式

一个序列模式包含数个将与序列元素进行匹配的子模式。其语法类似于列表或元组的解包。

sequence_pattern       ::=  "[" [maybe_sequence_pattern] "]"
                            | "(" [open_sequence_pattern] ")"
open_sequence_pattern  ::=  maybe_star_pattern "," [maybe_sequence_pattern]
maybe_sequence_pattern ::=  ",".maybe_star_pattern+ ","?
maybe_star_pattern     ::=  star_pattern | pattern
star_pattern           ::=  "*" (capture_pattern | wildcard_pattern)

序列模式中使用圆括号或方括号没有区别（例如 (...) 和 [...] ）。

注解

用圆括号括起来且没有跟随逗号的单个模式 (例如 (3 | 4)) 是一个 分组模式。 而用方括号括起来的单个模式 (例如 [3 | 4]) 则仍是一个序列模式。

一个序列模式中最多可以有一个星号子模式。星号子模式可以出现在任何位置。如果没有星号子模式，该序列模式是固定长度的序列模式；否则，其是一个可变长度的序列模式。

下面是将一个序列模式与一个目标值相匹配的逻辑流程：

如果目标值不是一个序列 2 ，该序列模式匹配失败。

如果目标值是 str 、 bytes 或 bytearray 的实例，则该序列模式匹配失败。

随后的步骤取决于序列模式是固定长度还是可变长度的。

如果序列模式是固定长度的：

如果目标序列的长度与子模式的数量不相等，则该序列模式匹配失败

序列模式中的子模式与目标序列中的相应项目从左到右进行匹配。 一旦一个子模式匹配失败，就停止匹配。 如果所有的子模式都成功地与它们的对应项相匹配，那么该序列模式就匹配成功了。

否则，如果序列模式是变长的：

如果目标序列的长度小于非星号子模式的数量，则该序列模式匹配失败。

与固定长度的序列一样，靠前的非星形子模式与其相应的项目进行匹配。

如果上一步成功，星号子模式与剩余的目标项形成的列表相匹配，不包括星号子模式之后的非星号子模式所对应的剩余项。

剩余的非星号子模式将与相应的目标项匹配，就像固定长度的序列一样。

注解

目标序列的长度可通过 len() (即通过 __len__() 协议) 获得。 解释器可能会以类似于 值模式 的方式缓存这个长度信息。

简而言之， [P1, P2, P3, ... , P<N>] 仅在满足以下情况时匹配成功：

检查 <subject> 是一个序列

len(subject) == <N>

将 P1 与 <subject>[0] 进行匹配（请注意此匹配可以绑定名称）

将 P2 与 <subject>[1] 进行匹配（请注意此匹配可以绑定名称）

…… 剩余对应的模式/元素也以此类推。

8.6.4.9. 映射模式

映射模式包含一个或多个键值模式。其语法类似于字典的构造。语法：

mapping_pattern     ::=  "{" [items_pattern] "}"
items_pattern       ::=  ",".key_value_pattern+ ","?
key_value_pattern   ::=  (literal_pattern | value_pattern) ":" pattern
                         | double_star_pattern
double_star_pattern ::=  "**" capture_pattern

一个映射模式中最多可以有一个双星号模式。双星号模式必须是映射模式中的最后一个子模式。

映射模式中不允许出现重复的键。重复的字面值键会引发 SyntaxError 。若是两个键有相同的值将会在运行时引发 ValueError 。

以下是映射模式与目标值匹配的逻辑流程：

如果目标值不是一个映射 3，则映射模式匹配失败。

若映射模式中给出的每个键都存在于目标映射中，且每个键的模式都与目标映射的相应项匹配成功，则该映射模式匹配成功。

如果在映射模式中检测到重复的键，该模式将被视作无效。对于重复的字面值，会引发 SyntaxError ；对于相同值的命名键，会引发 ValueError 。

注解

键值对使用映射目标的 get() 方法的双参数形式进行匹配。匹配的键值对必须已经存在于映射中，而不是通过 __missing__() 或 __getitem__() 即时创建。

简而言之， {KEY1: P1, KEY2: P2, ... } 仅在满足以下情况时匹配成功：

检查 <subject> 是映射

KEY1 in <subject>

P1 与 <subject>[KEY1] 相匹配

…… 剩余对应的键/模式对也以此类推。

8.6.4.10. 类模式

类模式表示一个类以及它的位置参数和关键字参数（如果有的话）。语法：

class_pattern       ::=  name_or_attr "(" [pattern_arguments ","?] ")"
pattern_arguments   ::=  positional_patterns ["," keyword_patterns]
                         | keyword_patterns
positional_patterns ::=  ",".pattern+
keyword_patterns    ::=  ",".keyword_pattern+
keyword_pattern     ::=  NAME "=" pattern

同一个关键词不应该在类模式中重复出现。

以下是类模式与目标值匹配的逻辑流程：

如果 name_or_attr 不是内置 type 的实例，引发 TypeError 。

如果目标值不是 name_or_attr 的实例（通过 isinstance() 测试），该类模式匹配失败。

如果没有模式参数存在，则该模式匹配成功。 否则，后面的步骤取决于是否有关键字或位置参数模式存在。

对于一些内置的类型（将在后文详述），接受一个位置子模式，它将与整个目标值相匹配；对于这些类型，关键字模式也像其他类型一样工作。

如果只存在关键词模式，它们将被逐一处理，如下所示：

一. 该关键词被视作主体的一个属性进行查找。

如果这引发了除 AttributeError 以外的异常，该异常会被抛出。

如果这引发了 AttributeError ，该类模式匹配失败。

否则，与关键词模式相关的子模式将与目标的属性值进行匹配。 如果失败，则类模式匹配失败；如果成功，则继续对下一个关键词进行匹配。

二. 如果所有的关键词模式匹配成功，该类模式匹配成功。

如果存在位置模式，在匹配前会用类 name_or_attr 的 __match_args__ 属性将其转换为关键词模式。

一. 进行与 getattr(cls, "__match_args__", ()) 等价的调用。

如果这引发一个异常，该异常将被抛出。

如果返回值不是一个元组，则转换失败且引发 TypeError 。

若位置模式的数量超出 len(cls.__match_args__) ，将引发 TypeError 。

否则，位置模式 i 会使用 __match_args__[i] 转换为关键词。 __match_args__[i] 必须是一个字符串；如果不是则引发 TypeError 。

如果有重复的关键词，引发 TypeError 。

参见

定制类模式匹配中的位置参数

二. 若所有的位置模式都被转换为关键词模式，

匹配的过程就像只有关键词模式一样。

对于以下内置类型，位置子模式的处理是不同的：

bool

bytearray

bytes

dict

float

frozenset

int

list

set

str

tuple

这些类接受一个位置参数，其模式是针对整个对象而不是某个属性进行匹配。 例如，int(0|1) 匹配值 0，但不匹配值 0.0。

简而言之， CLS(P1, attr=P2) 仅在满足以下情况时匹配成功：

isinstance(<subject>, CLS)

用 CLS.__match_args__ 将 P1 转换为关键词模式

对于每个关键词参数 attr=P2 ：

hasattr(<subject>, "attr")

将 P2 与 <subject>.attr 进行匹配

…… 剩余对应的关键字参数/模式对也以此类推。

参见

PEP 634 [https://www.python.org/dev/peps/pep-0634] —— 结构化模式匹配：规范

PEP 636 [https://www.python.org/dev/peps/pep-0636] —— 结构化模式匹配：教程

8.7. 函数定义

函数定义就是对用户自定义函数的定义（参见 标准类型层级结构 一节）:

funcdef                   ::=  [decorators] "def" funcname "(" [parameter_list] ")"
                               ["->" expression] ":" suite
decorators                ::=  decorator+
decorator                 ::=  "@" assignment_expression NEWLINE
parameter_list            ::=  defparameter ("," defparameter)* "," "/" ["," [parameter_list_no_posonly]]
                                 | parameter_list_no_posonly
parameter_list_no_posonly ::=  defparameter ("," defparameter)* ["," [parameter_list_starargs]]
                               | parameter_list_starargs
parameter_list_starargs   ::=  "*" [parameter] ("," defparameter)* ["," ["**" parameter [","]]]
                               | "**" parameter [","]
parameter                 ::=  identifier [":" expression]
defparameter              ::=  parameter ["=" expression]
funcname                  ::=  identifier

函数定义是一条可执行语句。 它执行时会在当前局部命名空间中将函数名称绑定到一个函数对象（函数可执行代码的包装器）。 这个函数对象包含对当前全局命名空间的引用，作为函数被调用时所使用的全局命名空间。

函数定义并不会执行函数体；只有当函数被调用时才会执行此操作。 4

一个函数定义可以被一个或多个 decorator 表达式所包装。 当函数被定义时将在包含该函数定义的作用域中对装饰器表达式求值。 求值结果必须是一个可调用对象，它会以该函数对象作为唯一参数被唤起。 其返回值将被绑定到函数名称而非函数对象。 多个装饰器会以嵌套方式被应用。 例如以下代码

@f1(arg)
@f2
def func(): pass

大致等价于

def func(): pass
func = f1(arg)(f2(func))

不同之处在于原始函数并不会被临时绑定到名称 func。

在 3.9 版更改: 函数可使用任何有效的 assignment_expression 来装饰。 在之前版本中，此语法则更为受限，详情参见 PEP 614 [https://www.python.org/dev/peps/pep-0614]。

当一个或多个 形参 具有 形参 = 表达式 这样的形式时，该函数就被称为具有“默认形参值”。 对于一个具有默认值的形参，其对应的 argument 可以在调用中被省略，在此情况下会用形参的默认值来替代。 如果一个形参具有默认值，后续所有在 "*" 之前的形参也必须具有默认值 --- 这个句法限制并未在语法中明确表达。

默认形参值会在执行函数定义时按从左至右的顺序被求值。 这意味着当函数被定义时将对表达式求值一次，相同的“预计算”值将在每次调用时被使用。 这一点在默认形参为可变对象，例如列表或字典的时候尤其需要重点理解：如果函数修改了该对象（例如向列表添加了一项），则实际上默认值也会被修改。 这通常不是人们所想要的。 绕过此问题的一个方法是使用 None 作为默认值，并在函数体中显式地对其进测试，例如:

def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin

函数调用的语义在 调用 一节中有更详细的描述。 函数调用总是会给形参列表中列出的所有形参赋值，或是用位置参数，或是用关键字参数，或是用默认值。 如果存在 "*identifier" 这样的形式，它会被初始化为一个元组来接收任何额外的位置参数，默认为一个空元组。 如果存在 "**identifier" 这样的形式，它会被初始化为一个新的有序映射来接收任何额外的关键字参数，默认为一个相同类型的空映射。 在 "*" 或 "*identifier" 之后的形参都是仅限关键字形参因而只能通过关键字参数传入。 在 "/" 之前的形参都是仅限位置形参因而只能通过位置参数传入。

在 3.8 版更改: 可以使用 / 函数形参语法来标示仅限位置形参。 请参阅 PEP 570 [https://www.python.org/dev/peps/pep-0570] 了解详情。

形参可以带有 标注，其形式为在形参名称后加上 ": expression"。 任何形参都可以带有标注，甚至 *identifier 或 **identifier 这样的形参也可以。 函数可以带有“返回”标注，其形式为在形参列表后加上 "-> expression"。 这些标注可以是任何有效的 Python 表达式。 标注的存在不会改变函数的语义。 标注值可以作为函数对象的 __annotations__ 属性中以对应形参名称为键的字典值被访问。 如果使用了 annotations import from __future__ 的方式，则标注会在运行时保存为字符串以启用延迟求值特性。 否则，它们会在执行函数定义时被求值。 在这种情况下，标注的求值顺序可能与它们在源代码中出现的顺序不同。

创建匿名函数（未绑定到一个名称的函数）以便立即在表达式中使用也是可能的。 这需要使用 lambda 表达式，具体描述见 lambda 表达式 一节。 请注意 lambda 只是简单函数定义的一种简化写法；在 "def" 语句中定义的函数也可以像用 lambda 表达式定义的函数一样被传递或赋值给其他名称。 "def" 形式实际上更为强大，因为它允许执行多条语句和使用标注。

程序员注意事项: 函数属于一类对象。 在一个函数内部执行的 "def" 语句会定义一个局部函数并可被返回或传递。 在嵌套函数中使用的自由变量可以访问包含该 def 语句的函数的局部变量。 详情参见 命名与绑定 一节。

参见

PEP 3107 [https://www.python.org/dev/peps/pep-3107] - 函数标注

最初的函数标注规范说明。

PEP 484 [https://www.python.org/dev/peps/pep-0484] —— 类型注解

标注的标准含意定义：类型提示。

PEP 526 [https://www.python.org/dev/peps/pep-0526] - 变量标注的语法

变量声明的类型提示功能，包括类变量和实例变量

PEP 563 [https://www.python.org/dev/peps/pep-0563] - 延迟的标注求值

支持在运行时通过以字符串形式保存标注而非不是即求值来实现标注内部的向前引用。

8.8. 类定义

类定义就是对类对象的定义 (参见 标准类型层级结构 一节):

classdef    ::=  [decorators] "class" classname [inheritance] ":" suite
inheritance ::=  "(" [argument_list] ")"
classname   ::=  identifier

类定义是一条可执行语句。 其中继承列表通常给出基类的列表 (进阶用法请参见 元类)，列表中的每一项都应当被求值为一个允许子类的类对象。 没有继承列表的类默认继承自基类 object；因此，:

class Foo:
    pass

等价于

class Foo(object):
    pass

随后类体将在一个新的执行帧 (参见 命名与绑定) 中被执行，使用新创建的局部命名空间和原有的全局命名空间。 （通常，类体主要包含函数定义。） 当类体结束执行时，其执行帧将被丢弃而其局部命名空间会被保存。 5 一个类对象随后会被创建，其基类使用给定的继承列表，属性字典使用保存的局部命名空间。 类名称将在原有的全局命名空间中绑定到该类对象。

在类体内定义的属性的顺序保存在新类的 __dict__ 中。 请注意此顺序的可靠性只限于类刚被创建时，并且只适用于使用定义语法所定义的类。

类的创建可使用 元类 进行重度定制。

类也可以被装饰：就像装饰函数一样，:

@f1(arg)
@f2
class Foo: pass

大致等价于

class Foo: pass
Foo = f1(arg)(f2(Foo))

装饰器表达式的求值规则与函数装饰器相同。 结果随后会被绑定到类名称。

在 3.9 版更改: 类可使用任何有效的 assignment_expression 来装饰。 在之前版本中，此语法则更为受限，详情参见 PEP 614 [https://www.python.org/dev/peps/pep-0614]。

程序员注意事项: 在类定义内定义的变量是类属性；它们将被类实例所共享。 实例属性可通过 self.name = value 在方法中设定。 类和实例属性均可通过 "self.name" 表示法来访问，当通过此方式访问时实例属性会隐藏同名的类属性。 类属性可被用作实例属性的默认值，但在此场景下使用可变值可能导致未预期的结果。 可以使用 描述器 来创建具有不同实现细节的实例变量。

参见

PEP 3115 [https://www.python.org/dev/peps/pep-3115] - Python 3000 中的元类

将元类声明修改为当前语法的提议，以及关于如何构建带有元类的类的语义描述。

PEP 3129 [https://www.python.org/dev/peps/pep-3129] - 类装饰器

增加类装饰器的提议。 函数和方法装饰器是在 PEP 318 [https://www.python.org/dev/peps/pep-0318] 中被引入的。

8.9. 协程

3.5 新版功能.

8.9.1. 协程函数定义

async_funcdef ::=  [decorators] "async" "def" funcname "(" [parameter_list] ")"
                   ["->" expression] ":" suite

Python 协程的执行可以在多个位置上被挂起和恢复 (参见 coroutine)。 await 表达式，async for 以及 async with 只能在协程函数体中使用。

使用 async def 语法定义的函数总是为协程函数，即使它们不包含 await 或 async 关键字。

在协程函数体中使用 yield from 表达式将引发 SyntaxError。

协程函数的例子:

async def func(param1, param2):
    do_stuff()
    await some_coroutine()

在 3.7 版更改: await 和 async 现在是保留关键字；在之前版本中它们仅在协程函数内被当作保留关键字。

8.9.2. async for 语句

async_for_stmt ::=  "async" for_stmt

asynchronous iterable 提供了 __aiter__ 方法，该方法会直接返回 asynchronous iterator，它可以在其 __anext__ 方法中调用异步代码。

async for 语句允许方便地对异步可迭代对象进行迭代。

以下代码:

async for TARGET in ITER:
    SUITE
else:
    SUITE2

在语义上等价于:

iter = (ITER)
iter = type(iter).__aiter__(iter)
running = True

while running:
    try:
        TARGET = await type(iter).__anext__(iter)
    except StopAsyncIteration:
        running = False
    else:
        SUITE
else:
    SUITE2

另请参阅 __aiter__() 和 __anext__() 了解详情。

在协程函数体之外使用 async for 语句将引发 SyntaxError。

8.9.3. async with 语句

async_with_stmt ::=  "async" with_stmt

asynchronous context manager 是一种 context manager，能够在其 enter 和 exit 方法中暂停执行。

以下代码:

async with EXPRESSION as TARGET:
    SUITE

在语义上等价于:

manager = (EXPRESSION)
aenter = type(manager).__aenter__
aexit = type(manager).__aexit__
value = await aenter(manager)
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not await aexit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        await aexit(manager, None, None, None)

另请参阅 __aenter__() 和 __aexit__() 了解详情。

在协程函数体之外使用 async with 语句将引发 SyntaxError。

参见

PEP 492 [https://www.python.org/dev/peps/pep-0492] - 使用 async 和 await 语法实现协程

将协程作为 Python 中的一个正式的单独概念，并增加相应的支持语法。

备注

1

异常会被传播给唤起栈，除非存在一个 finally 子句正好引发了另一个异常。 新引发的异常将导致旧异常的丢失。

2

在模式匹配中，序列被定义为以下几种之一:

继承自 collections.abc.Sequence 的类

注册为 collections.abc.Sequence 的 Python 类

设置了 (CPython) Py_TPFLAGS_SEQUENCE 位的内置类

继承自上述任何一个类的类

下列标准库中的类都是序列:

array.array

collections.deque

list

memoryview

range

tuple

注解

类型为 str, bytes 和 bytearray 的目标值不能匹配序列模式。

3

在模式匹配中，映射被定义为以下几种之一:

继承自 collections.abc.Mapping 的类

注册为 collections.abc.Mapping 的 Python 类

设置了 (CPython) Py_TPFLAGS_MAPPING 位的内置类

继承自上述任何一个类的类

标准库中的 dict 和 types.MappingProxyType 类都属于映射。

4

作为函数体的第一条语句出现的字符串字面值会被转换为函数的 __doc__ 属性，也就是该函数的 docstring。

5

作为类体的第一条语句出现的字符串字面值会被转换为命名空间的 __doc__ 条目，也就是该类的 docstring。

9. 顶级组件

Python 解释器可以从多种源获得输入：作为标准输入或程序参数传入的脚本，以交互方式键入的语句，导入的模块源文件等等。 这一章将给出在这些情况下所用的语法。

9.1. 完整的 Python 程序

虽然语言规范描述不必规定如何唤起语言解释器，但对完整的 Python 程序加以说明还是很有用的。 一个完整的 Python 程序会在最小初始化环境中被执行：所有内置和标准模块均为可用，但均处于未初始化状态，只有 sys (各种系统服务), builtins (内置函数、异常以及 None) 和 __main__ 除外。 最后一个模块用于为完整程序的执行提供局部和全局命名空间。

适用于一个完整 Python 程序的语法即下节所描述的文件输入。

解释器也可以通过交互模式被唤起；在此情况下，它并不读取和执行一个完整程序，而是每次读取和执行一条语句（可能为复合语句）。 此时的初始环境与一个完整程序的相同；每条语句会在 __main__ 的命名空间中被执行。

一个完整程序可通过三种形式被传递给解释器：使用 -c 字符串 命令行选项，使用一个文件作为第一个命令行参数，或者使用标准输入。 如果文件或标准输入是一个 tty 设置，解释器会进入交互模式；否则的话，它会将文件当作一个完整程序来执行。

9.2. 文件输入

所有从非交互式文件读取的输入都具有相同的形式:

file_input ::=  (NEWLINE | statement)*

此语法用于下列几种情况:

解析一个完整 Python 程序时（从文件或字符串）；

解析一个模块时；

解析一个传递给 exec() 函数的字符串时；

9.3. 交互式输入

交互模式下的输入使用以下语法进行解析:

interactive_input ::=  [stmt_list] NEWLINE | compound_stmt NEWLINE

请注意在交互模式下一条（最高层级）复合语句必须带有一个空行；这对于帮助解析器确定输入的结束是必须的。

9.4. 表达式输入

eval() 被用于表达式输入。 它会忽略开头的空白。 传递给 eval() 的字符串参数必须具有以下形式:

eval_input ::=  expression_list NEWLINE*

10. 完整的语法规范

这是完整的 Python 语法规范，直接提取自用于生成 CPython 解析器的语法 (参见 Grammar/python.gram [https://github.com/python/cpython/tree/3.10/Grammar/python.gram])。 这里显示的版本省略了有关代码生成和错误恢复的细节。

该标记法是 EBNF [https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form] 和 PEG [https://en.wikipedia.org/wiki/Parsing_expression_grammar] 的混合体。 特别地，& 后跟一个符号、形符或带括号的分组来表示肯定型前视（即要求匹配但不消耗字符）。而 ! 表示否定型前视（即要求 不 匹配）。 我们使用 | 分隔符来表示 PEG 的“有序选择”（在传统 PEG 语法中为 / 写法）。 请参阅 PEP 617 [https://www.python.org/dev/peps/pep-0617] 了解有关该语法规则的更多细节。

# PEG grammar for Python

file: [statements] ENDMARKER
interactive: statement_newline
eval: expressions NEWLINE* ENDMARKER
func_type: '(' [type_expressions] ')' '->' expression NEWLINE* ENDMARKER
fstring: star_expressions

# type_expressions allow */** but ignore them
type_expressions:
    | ','.expression+ ',' '*' expression ',' '**' expression
    | ','.expression+ ',' '*' expression
    | ','.expression+ ',' '**' expression
    | '*' expression ',' '**' expression
    | '*' expression
    | '**' expression
    | ','.expression+

statements: statement+
statement: compound_stmt  | simple_stmts
statement_newline:
    | compound_stmt NEWLINE
    | simple_stmts
    | NEWLINE
    | ENDMARKER
simple_stmts:
    | simple_stmt !';' NEWLINE  # Not needed, there for speedup
    | ';'.simple_stmt+ [';'] NEWLINE
# NOTE: assignment MUST precede expression, else parsing a simple assignment
# will throw a SyntaxError.
simple_stmt:
    | assignment
    | star_expressions
    | return_stmt
    | import_stmt
    | raise_stmt
    | 'pass'
    | del_stmt
    | yield_stmt
    | assert_stmt
    | 'break'
    | 'continue'
    | global_stmt
    | nonlocal_stmt
compound_stmt:
    | function_def
    | if_stmt
    | class_def
    | with_stmt
    | for_stmt
    | try_stmt
    | while_stmt
    | match_stmt

# NOTE: annotated_rhs may start with 'yield'; yield_expr must start with 'yield'
assignment:
    | NAME ':' expression ['=' annotated_rhs ]
    | ('(' single_target ')'
         | single_subscript_attribute_target) ':' expression ['=' annotated_rhs ]
    | (star_targets '=' )+ (yield_expr | star_expressions) !'=' [TYPE_COMMENT]
    | single_target augassign ~ (yield_expr | star_expressions)

augassign:
    | '+='
    | '-='
    | '*='
    | '@='
    | '/='
    | '%='
    | '&='
    | '|='
    | '^='
    | '<<='
    | '>>='
    | '**='
    | '//='

global_stmt: 'global' ','.NAME+
nonlocal_stmt: 'nonlocal' ','.NAME+

yield_stmt: yield_expr

assert_stmt: 'assert' expression [',' expression ]

del_stmt:
    | 'del' del_targets &(';' | NEWLINE)

import_stmt: import_name | import_from
import_name: 'import' dotted_as_names
# note below: the ('.' | '...') is necessary because '...' is tokenized as ELLIPSIS
import_from:
    | 'from' ('.' | '...')* dotted_name 'import' import_from_targets
    | 'from' ('.' | '...')+ 'import' import_from_targets
import_from_targets:
    | '(' import_from_as_names [','] ')'
    | import_from_as_names !','
    | '*'
import_from_as_names:
    | ','.import_from_as_name+
import_from_as_name:
    | NAME ['as' NAME ]
dotted_as_names:
    | ','.dotted_as_name+
dotted_as_name:
    | dotted_name ['as' NAME ]
dotted_name:
    | dotted_name '.' NAME
    | NAME

if_stmt:
    | 'if' named_expression ':' block elif_stmt
    | 'if' named_expression ':' block [else_block]
elif_stmt:
    | 'elif' named_expression ':' block elif_stmt
    | 'elif' named_expression ':' block [else_block]
else_block:
    | 'else' ':' block

while_stmt:
    | 'while' named_expression ':' block [else_block]

for_stmt:
    | 'for' star_targets 'in' ~ star_expressions ':' [TYPE_COMMENT] block [else_block]
    | ASYNC 'for' star_targets 'in' ~ star_expressions ':' [TYPE_COMMENT] block [else_block]

with_stmt:
    | 'with' '(' ','.with_item+ ','? ')' ':' block
    | 'with' ','.with_item+ ':' [TYPE_COMMENT] block
    | ASYNC 'with' '(' ','.with_item+ ','? ')' ':' block
    | ASYNC 'with' ','.with_item+ ':' [TYPE_COMMENT] block

with_item:
    | expression 'as' star_target &(',' | ')' | ':')
    | expression

try_stmt:
    | 'try' ':' block finally_block
    | 'try' ':' block except_block+ [else_block] [finally_block]
except_block:
    | 'except' expression ['as' NAME ] ':' block
    | 'except' ':' block
finally_block:
    | 'finally' ':' block

match_stmt:
    | "match" subject_expr ':' NEWLINE INDENT case_block+ DEDENT
subject_expr:
    | star_named_expression ',' star_named_expressions?
    | named_expression
case_block:
    | "case" patterns guard? ':' block
guard: 'if' named_expression

patterns:
    | open_sequence_pattern
    | pattern
pattern:
    | as_pattern
    | or_pattern
as_pattern:
    | or_pattern 'as' pattern_capture_target
or_pattern:
    | '|'.closed_pattern+

closed_pattern:
    | 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:
    | signed_number !('+' | '-')
    | complex_number
    | strings
    | 'None'
    | 'True'
    | 'False'

# Literal expressions are used to restrict permitted mapping pattern keys
literal_expr:
    | signed_number !('+' | '-')
    | complex_number
    | strings
    | 'None'
    | 'True'
    | 'False'

complex_number:
    | signed_real_number '+' imaginary_number
    | signed_real_number '-' imaginary_number

signed_number:
    | NUMBER
    | '-' NUMBER

signed_real_number:
    | real_number
    | '-' real_number

real_number:
    | NUMBER

imaginary_number:
    | NUMBER

capture_pattern:
    | pattern_capture_target

pattern_capture_target:
    | !"_" NAME !('.' | '(' | '=')

wildcard_pattern:
    | "_"

value_pattern:
    | attr !('.' | '(' | '=')
attr:
    | name_or_attr '.' NAME
name_or_attr:
    | attr
    | NAME

group_pattern:
    | '(' pattern ')'

sequence_pattern:
    | '[' maybe_sequence_pattern? ']'
    | '(' open_sequence_pattern? ')'
open_sequence_pattern:
    | maybe_star_pattern ',' maybe_sequence_pattern?
maybe_sequence_pattern:
    | ','.maybe_star_pattern+ ','?
maybe_star_pattern:
    | star_pattern
    | pattern

star_pattern:
    | '*' pattern_capture_target
    | '*' wildcard_pattern

mapping_pattern:
    | '{' '}'
    | '{' double_star_pattern ','? '}'
    | '{' items_pattern ',' double_star_pattern ','? '}'
    | '{' items_pattern ','? '}'
items_pattern:
    | ','.key_value_pattern+
key_value_pattern:
    | (literal_expr | attr) ':' pattern
double_star_pattern:
    | '**' pattern_capture_target

class_pattern:
    | name_or_attr '(' ')'
    | name_or_attr '(' positional_patterns ','? ')'
    | name_or_attr '(' keyword_patterns ','? ')'
    | name_or_attr '(' positional_patterns ',' keyword_patterns ','? ')'
positional_patterns:
    | ','.pattern+
keyword_patterns:
    | ','.keyword_pattern+
keyword_pattern:
    | NAME '=' pattern

return_stmt:
    | 'return' [star_expressions]

raise_stmt:
    | 'raise' expression ['from' expression ]
    | 'raise'

function_def:
    | decorators function_def_raw
    | function_def_raw

function_def_raw:
    | 'def' NAME '(' [params] ')' ['->' expression ] ':' [func_type_comment] block
    | ASYNC 'def' NAME '(' [params] ')' ['->' expression ] ':' [func_type_comment] block
func_type_comment:
    | NEWLINE TYPE_COMMENT &(NEWLINE INDENT)   # Must be followed by indented block
    | TYPE_COMMENT

params:
    | parameters

parameters:
    | slash_no_default param_no_default* param_with_default* [star_etc]
    | slash_with_default param_with_default* [star_etc]
    | param_no_default+ param_with_default* [star_etc]
    | param_with_default+ [star_etc]
    | star_etc

# Some duplication here because we can't write (',' | &')'),
# which is because we don't support empty alternatives (yet).
#
slash_no_default:
    | param_no_default+ '/' ','
    | param_no_default+ '/' &')'
slash_with_default:
    | param_no_default* param_with_default+ '/' ','
    | param_no_default* param_with_default+ '/' &')'

star_etc:
    | '*' param_no_default param_maybe_default* [kwds]
    | '*' ',' param_maybe_default+ [kwds]
    | kwds

kwds: '**' param_no_default

# 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:
    | param ',' TYPE_COMMENT?
    | param TYPE_COMMENT? &')'
param_with_default:
    | param default ',' TYPE_COMMENT?
    | param default TYPE_COMMENT? &')'
param_maybe_default:
    | param default? ',' TYPE_COMMENT?
    | param default? TYPE_COMMENT? &')'
param: NAME annotation?

annotation: ':' expression
default: '=' expression

decorators: ('@' named_expression NEWLINE )+

class_def:
    | decorators class_def_raw
    | class_def_raw
class_def_raw:
    | 'class' NAME ['(' [arguments] ')' ] ':' block

block:
    | NEWLINE INDENT statements DEDENT
    | simple_stmts

star_expressions:
    | star_expression (',' star_expression )+ [',']
    | star_expression ','
    | star_expression
star_expression:
    | '*' bitwise_or
    | expression

star_named_expressions: ','.star_named_expression+ [',']
star_named_expression:
    | '*' bitwise_or
    | named_expression

assignment_expression:
    | NAME ':=' ~ expression

named_expression:
    | assignment_expression
    | expression !':='

annotated_rhs: yield_expr | star_expressions

expressions:
    | expression (',' expression )+ [',']
    | expression ','
    | expression
expression:
    | disjunction 'if' disjunction 'else' expression
    | disjunction
    | lambdef

lambdef:
    | 'lambda' [lambda_params] ':' expression

lambda_params:
    | 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:
    | lambda_slash_no_default lambda_param_no_default* lambda_param_with_default* [lambda_star_etc]
    | lambda_slash_with_default lambda_param_with_default* [lambda_star_etc]
    | lambda_param_no_default+ lambda_param_with_default* [lambda_star_etc]
    | lambda_param_with_default+ [lambda_star_etc]
    | lambda_star_etc

lambda_slash_no_default:
    | lambda_param_no_default+ '/' ','
    | lambda_param_no_default+ '/' &':'
lambda_slash_with_default:
    | lambda_param_no_default* lambda_param_with_default+ '/' ','
    | lambda_param_no_default* lambda_param_with_default+ '/' &':'

lambda_star_etc:
    | '*' lambda_param_no_default lambda_param_maybe_default* [lambda_kwds]
    | '*' ',' lambda_param_maybe_default+ [lambda_kwds]
    | lambda_kwds

lambda_kwds: '**' lambda_param_no_default

lambda_param_no_default:
    | lambda_param ','
    | lambda_param &':'
lambda_param_with_default:
    | lambda_param default ','
    | lambda_param default &':'
lambda_param_maybe_default:
    | lambda_param default? ','
    | lambda_param default? &':'
lambda_param: NAME

disjunction:
    | conjunction ('or' conjunction )+
    | conjunction
conjunction:
    | inversion ('and' inversion )+
    | inversion
inversion:
    | 'not' inversion
    | comparison
comparison:
    | bitwise_or compare_op_bitwise_or_pair+
    | bitwise_or
compare_op_bitwise_or_pair:
    | 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: '==' bitwise_or
noteq_bitwise_or:
    | ('!=' ) bitwise_or
lte_bitwise_or: '<=' bitwise_or
lt_bitwise_or: '<' bitwise_or
gte_bitwise_or: '>=' bitwise_or
gt_bitwise_or: '>' bitwise_or
notin_bitwise_or: 'not' 'in' bitwise_or
in_bitwise_or: 'in' bitwise_or
isnot_bitwise_or: 'is' 'not' bitwise_or
is_bitwise_or: 'is' bitwise_or

bitwise_or:
    | bitwise_or '|' bitwise_xor
    | bitwise_xor
bitwise_xor:
    | bitwise_xor '^' bitwise_and
    | bitwise_and
bitwise_and:
    | bitwise_and '&' shift_expr
    | shift_expr
shift_expr:
    | shift_expr '<<' sum
    | shift_expr '>>' sum
    | sum

sum:
    | sum '+' term
    | sum '-' term
    | term
term:
    | term '*' factor
    | term '/' factor
    | term '//' factor
    | term '%' factor
    | term '@' factor
    | factor
factor:
    | '+' factor
    | '-' factor
    | '~' factor
    | power
power:
    | await_primary '**' factor
    | await_primary
await_primary:
    | AWAIT primary
    | primary
primary:
    | primary '.' NAME
    | primary genexp
    | primary '(' [arguments] ')'
    | primary '[' slices ']'
    | atom

slices:
    | slice !','
    | ','.slice+ [',']
slice:
    | [expression] ':' [expression] [':' [expression] ]
    | named_expression
atom:
    | NAME
    | 'True'
    | 'False'
    | 'None'
    | strings
    | NUMBER
    | (tuple | group | genexp)
    | (list | listcomp)
    | (dict | set | dictcomp | setcomp)
    | '...'

strings: STRING+
list:
    | '[' [star_named_expressions] ']'
listcomp:
    | '[' named_expression for_if_clauses ']'
tuple:
    | '(' [star_named_expression ',' [star_named_expressions]  ] ')'
group:
    | '(' (yield_expr | named_expression) ')'
genexp:
    | '(' ( assignment_expression | expression !':=') for_if_clauses ')'
set: '{' star_named_expressions '}'
setcomp:
    | '{' named_expression for_if_clauses '}'
dict:
    | '{' [double_starred_kvpairs] '}'

dictcomp:
    | '{' kvpair for_if_clauses '}'
double_starred_kvpairs: ','.double_starred_kvpair+ [',']
double_starred_kvpair:
    | '**' bitwise_or
    | kvpair
kvpair: expression ':' expression
for_if_clauses:
    | for_if_clause+
for_if_clause:
    | ASYNC 'for' star_targets 'in' ~ disjunction ('if' disjunction )*
    | 'for' star_targets 'in' ~ disjunction ('if' disjunction )*

yield_expr:
    | 'yield' 'from' expression
    | 'yield' [star_expressions]

arguments:
    | args [','] &')'
args:
    | ','.(starred_expression | ( assignment_expression | expression !':=') !'=')+ [',' kwargs ]
    | kwargs

kwargs:
    | ','.kwarg_or_starred+ ',' ','.kwarg_or_double_starred+
    | ','.kwarg_or_starred+
    | ','.kwarg_or_double_starred+
starred_expression:
    | '*' expression
kwarg_or_starred:
    | NAME '=' expression
    | starred_expression
kwarg_or_double_starred:
    | NAME '=' expression
    | '**' expression

# NOTE: star_targets may contain *bitwise_or, targets may not.
star_targets:
    | star_target !','
    | star_target (',' star_target )* [',']
star_targets_list_seq: ','.star_target+ [',']
star_targets_tuple_seq:
    | star_target (',' star_target )+ [',']
    | star_target ','
star_target:
    | '*' (!'*' star_target)
    | target_with_star_atom
target_with_star_atom:
    | t_primary '.' NAME !t_lookahead
    | t_primary '[' slices ']' !t_lookahead
    | star_atom
star_atom:
    | NAME
    | '(' target_with_star_atom ')'
    | '(' [star_targets_tuple_seq] ')'
    | '[' [star_targets_list_seq] ']'

single_target:
    | single_subscript_attribute_target
    | NAME
    | '(' single_target ')'
single_subscript_attribute_target:
    | t_primary '.' NAME !t_lookahead
    | t_primary '[' slices ']' !t_lookahead

del_targets: ','.del_target+ [',']
del_target:
    | t_primary '.' NAME !t_lookahead
    | t_primary '[' slices ']' !t_lookahead
    | del_t_atom
del_t_atom:
    | NAME
    | '(' del_target ')'
    | '(' [del_targets] ')'
    | '[' [del_targets] ']'

t_primary:
    | t_primary '.' NAME &t_lookahead
    | t_primary '[' slices ']' &t_lookahead
    | t_primary genexp &t_lookahead
    | t_primary '(' [arguments] ')' &t_lookahead
    | atom &t_lookahead
t_lookahead: '(' | '[' | '.'

Python 标准库

Python 语言参考手册 描述了 Python 语言的具体语法和语义，这份库参考则介绍了与 Python 一同发行的标准库。它还描述了通常包含在 Python 发行版中的一些可选组件。

Python 标准库非常庞大，所提供的组件涉及范围十分广泛，正如以下内容目录所显示的。这个库包含了多个内置模块 (以 C 编写)，Python 程序员必须依靠它们来实现系统级功能，例如文件 I/O，此外还有大量以 Python 编写的模块，提供了日常编程中许多问题的标准解决方案。其中有些模块经过专门设计，通过将特定平台功能抽象化为平台中立的 API 来鼓励和加强 Python 程序的可移植性。

Windows 版本的 Python 安装程序通常包含整个标准库，往往还包含许多额外组件。对于类 Unix 操作系统，Python 通常会分成一系列的软件包，因此可能需要使用操作系统所提供的包管理工具来获取部分或全部可选组件。

在这个标准库以外还存在成千上万并且不断增加的其他组件 (从单独的程序、模块、软件包直到完整的应用开发框架)，访问 Python 包索引 [https://pypi.org] 即可获取这些第三方包。

概述

可用性注释

内置函数

内置常量

由 site 模块添加的常量

内置类型

逻辑值检测

布尔运算 --- and, or, not

比较运算

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

迭代器类型

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

文本序列类型 --- str

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

集合类型 --- set, frozenset

映射类型 --- dict

上下文管理器类型

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

其他内置类型

特殊属性

整数字符串转换长度限制

内置异常

异常上下文

从内置异常继承

基类

具体异常

警告

异常层次结构

文本处理服务

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

re --- 正则表达式操作

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

textwrap --- 文本自动换行与填充

unicodedata --- Unicode 数据库

stringprep --- 因特网字符串预备

readline --- GNU readline 接口

rlcompleter --- GNU readline 的补全函数

二进制数据服务

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

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

数据类型

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

zoneinfo --- IANA 时区支持

calendar --- 日历相关函数

collections --- 容器数据类型

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

heapq --- 堆队列算法

bisect --- 数组二分查找算法

array --- 高效的数字数组

weakref --- 弱引用

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

copy --- 浅层 (shallow) 和深层 (deep) 复制操作

pprint --- 数据美化输出

reprlib --- 另一种 repr() 实现

enum --- 对枚举的支持

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

数字和数学模块

numbers --- 数字的抽象基类

math --- 数学函数

cmath --- 关于复数的数学函数

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

fractions --- 分数

random --- 生成伪随机数

statistics --- 数学统计函数

函数式编程模块

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

functools --- 高阶函数和可调用对象上的操作

operator --- 标准运算符替代函数

文件和目录访问

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

os.path --- 常用路径操作

fileinput --- 迭代来自多个输入流的行

stat --- 解析 stat() 结果

filecmp --- 文件及目录的比较

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

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

fnmatch --- Unix 文件名模式匹配

linecache --- 随机读写文本行

shutil --- 高阶文件操作

数据持久化

pickle --- Python 对象序列化

copyreg --- 注册配合 pickle 模块使用的函数

shelve --- Python 对象持久化

marshal --- 内部 Python 对象序列化

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

sqlite3 --- SQLite 数据库 DB-API 2.0 接口模块

数据压缩和存档

zlib --- 与 gzip 兼容的压缩

gzip --- 对 gzip 格式的支持

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

lzma --- 用 LZMA 算法压缩

zipfile --- 使用ZIP存档

tarfile --- 读写tar归档文件

文件格式

csv --- CSV 文件读写

configparser --- 配置文件解析器

netrc --- netrc 文件处理

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

加密服务

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

hmac --- 基于密钥的消息验证

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

通用操作系统服务

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

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

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

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

getopt --- C 风格的命令行选项解析器

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

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

logging.handlers --- 日志处理程序

getpass --- 便携式密码输入工具

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

curses.textpad --- 用于 curses 程序的文本输入控件

curses.ascii --- 用于 ASCII 字符的工具

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

platform --- 获取底层平台的标识数据

errno --- 标准 errno 系统符号

ctypes --- Python 的外部函数库

并发执行

threading --- 基于线程的并行

multiprocessing --- 基于进程的并行

multiprocessing.shared_memory --- 可跨进程直接访问的共享内存

concurrent 包

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

subprocess --- 子进程管理

sched --- 事件调度器

queue --- 一个同步的队列类

contextvars --- 上下文变量

_thread --- 底层多线程 API

网络和进程间通信

asyncio --- 异步 I/O

socket --- 底层网络接口

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

select --- 等待 I/O 完成

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

signal --- 设置异步事件处理程序

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

互联网数据处理

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

json --- JSON 编码和解码器

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

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

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

binhex --- 对binhex4文件进行编码和解码

binascii --- 二进制和 ASCII 码互转

quopri --- 编码与解码经过 MIME 转码的可打印数据

结构化标记处理工具

html --- 超文本标记语言支持

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

html.entities --- HTML 一般实体的定义

XML处理模块

xml.etree.ElementTree --- ElementTree XML API

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

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

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

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

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

xml.sax.saxutils --- SAX 工具集

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

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

互联网协议和支持

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

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

urllib --- URL 处理模块

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

urllib.response --- urllib 使用的 Response 类

urllib.parse 用于解析 URL

urllib.error --- urllib.request 引发的异常类

urllib.robotparser --- robots.txt 语法分析程序

http --- HTTP 模块

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

ftplib --- FTP 协议客户端

poplib --- POP3 协议客户端

imaplib --- IMAP4 协议客户端

smtplib --- SMTP 协议客户端

uuid --- RFC 4122 定义的UUID对象

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

http.server --- HTTP 服务器

http.cookies --- HTTP状态管理

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

xmlrpc --- XMLRPC 服务端与客户端模块

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

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

ipaddress --- IPv4/IPv6 操作库

多媒体服务

wave --- 读写WAV格式文件

colorsys --- 颜色系统间的转换

国际化

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

locale --- 国际化服务

程序框架

turtle --- 海龟绘图

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

shlex —— 简单的词法分析

Tk图形用户界面(GUI)

tkinter —— Tcl/Tk 的 Python 接口

tkinter.colorchooser --- 颜色选择对话框

tkinter.font --- Tkinter 字体封装

Tkinter 对话框

tkinter.messagebox --- Tkinter 消息提示

tkinter.scrolledtext --- 滚动文字控件

tkinter.dnd --- 拖放操作支持

tkinter.ttk --- Tk 风格的控件

tkinter.tix --- TK扩展包

IDLE

开发工具

typing —— 对类型提示的支持

pydoc --- 文档生成器和在线帮助系统

Python 开发模式

Python 开发模式的效果

ResourceWarning 示例

文件描述符错误示例

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

unittest --- 单元测试框架

unittest.mock --- 模拟对象库

unittest.mock --- 上手指南

2to3 --- 自动化的 Python 2 到 3 代码转写

test --- Python 回归测试包

test.support --- 针对 Python 测试套件的工具

test.support.socket_helper --- 用于套接字测试的工具

test.support.script_helper --- 用于 Python 执行测试工具

test.support.bytecode_helper --- 用于测试正确字节码生成的支持工具

test.support.threading_helper --- 用于线程测试的工具

test.support.os_helper --- 用于操作系统测试的工具

test.support.import_helper --- 用于导入测试的工具

test.support.warnings_helper --- 用于警告测试的工具

调试和分析

审计事件表

bdb --- 调试器框架

faulthandler —— 转储 Python 的跟踪信息

pdb --- Python 的调试器

Python 性能分析器

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

trace —— 跟踪 Python 语句的执行

tracemalloc --- 跟踪内存分配

软件打包和分发

distutils 构建和安装 Python 模块

ensurepip --- 引导 pip 安装器

venv --- 创建虚拟环境

zipapp —— 管理可执行的 Python zip 打包文件

Python 运行时服务

sys --- 系统相关的形参和函数

sysconfig —— 提供对 Python 配置信息的访问支持

builtins --- 内建对象

__main__ ——顶层代码环境

warnings ——控制警告信息

dataclasses --- 数据类

contextlib --- 为 with语句上下文提供的工具

abc --- 抽象基类

atexit --- 退出处理器

traceback —— 打印或读取栈回溯信息

__future__ --- Future 语句定义

gc --- 垃圾回收器接口

inspect --- 检查对象

site —— 指定域的配置钩子

自定义 Python 解释器

code --- 解释器基类

codeop --- 编译Python代码

导入模块

zipimport --- 从 Zip 存档中导入模块

pkgutil --- 包扩展工具

modulefinder --- 查找脚本使用的模块

runpy ——查找并执行 Python 模块

importlib --- import 的实现

使用 importlib.metadata

Python 语言服务

ast --- 抽象语法树

symtable ——访问编译器的符号表

token --- 与Python解析树一起使用的常量

keyword --- 检验Python关键字

tokenize --- 对 Python 代码使用的标记解析器

tabnanny --- 模糊缩进检测

pyclbr --- Python 模块浏览器支持

py_compile --- 编译 Python 源文件

compileall --- 字节编译 Python 库

dis --- Python 字节码反汇编器

pickletools --- pickle 开发者工具集

Windows系统相关模块

msvcrt --- 来自 MS VC++ 运行时的有用例程

winreg --- 访问 Windows 注册表

winsound —— Windows 系统的音频播放接口

Unix 专有服务

posix --- 最常见的 POSIX 系统调用

pwd --- 用户密码数据库

grp --- 组数据库

termios --- POSIX 风格的 tty 控制

tty --- 终端控制功能

pty --- 伪终端工具

fcntl —— 系统调用 fcntl 和 ioctl

resource --- 资源使用信息

Unix syslog 库例程

被取代的模块

aifc --- 读写 AIFF 和 AIFC 文件

asynchat --- 异步套接字指令/响应处理程序

asyncore --- 异步套接字处理器

audioop --- 处理原始音频数据

cgi --- 通用网关接口支持

cgitb --- 用于 CGI 脚本的回溯管理器

chunk --- 读取 IFF 分块数据

crypt —— 验证 Unix 口令的函数

imghdr --- 推测图像类型

imp --- 访问 import 内部对象

mailcap --- Mailcap 文件处理

msilib --- 读写 Microsoft Installer 文件

nis --- Sun 的 NIS (黄页) 接口

nntplib --- NNTP 协议客户端

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

ossaudiodev --- 访问兼容OSS的音频设备

pipes --- 终端管道接口

smtpd --- SMTP 服务器

sndhdr --- 推测声音文件的类型

spwd —— shadow 密码库

sunau --- 读写 Sun AU 文件

telnetlib -- Telnet 客户端

uu --- 对 uuencode 文件进行编码与解码

xdrlib --- 编码与解码 XDR 数据

安全考量

概述

"Python 库"中包含了几种不同的组件。

它包含通常被视为语言“核心”中的一部分的数据类型，例如数字和列表。对于这些类型，Python语言核心定义了文字的形式，并对它们的语义设置了一些约束，但没有完全定义语义。（另一方面，语言核心确实定义了语法属性，如操作符的拼写和优先级。）

这个库也包含了内置函数和异常 --- 不需要 import 语句就可以在所有Python代码中使用的对象。有一些是由语言核心定义的，但是许多对于核心语义不是必需的，并且仅在这里描述。

不过这个库主要是由一系列的模块组成。这些模块集可以不同方式分类。有些模块是用 C 编写并内置于 Python 解释器中；另一些模块则是用 Python 编写并以源码形式导入。有些模块提供专用于 Python 的接口，例如打印栈追踪信息；有些模块提供专用于特定操作系统的接口，例如操作特定的硬件；另一些模块则提供针对特定应用领域的接口，例如万维网。有些模块在所有更新和移植版本的 Python 中可用；另一些模块仅在底层系统支持或要求时可用；还有些模块则仅当编译和安装 Python 时选择了特定配置选项时才可用。

本手册以 "从内到外" 的顺序组织：首先描述内置函数、数据类型和异常，最后是根据相关性进行分组的各种模块。

这意味着如果你从头开始阅读本手册，并在感到厌烦时跳到下一章，你仍能对 Python 库的可用模块和所支持的应用领域有个大致了解。当然，你并非 必须 如同读小说一样从头读到尾 --- 你也可以先浏览内容目录 (在手册开头)，或在索引 (在手册末尾) 中查找某个特定函数、模块或条目。最后，如果你喜欢随意学习某个主题，你可以选择一个随机页码 (参见 random 模块) 并读上一两小节。无论你想以怎样的顺序阅读本手册，还是建议先从 内置函数 这一章开始，因为本手册的其余内容都需要你熟悉其中的基本概念。

让我们开始吧！

可用性注释

如果出现“适用：Unix”注释，意味着相应函数通常存在于 Unix 系统中。 但这并不保证其存在于某个特定的操作系统中。

如果没有单独说明，所有注明 "可用性: Unix" 的函数都在 macOS 上受到支持，因为此系统是基于 Unix 内核的。

内置函数

Python 解释器内置了很多函数和类型，任何时候都能使用。以下按字母顺序给出列表。

内置函数

A

abs()

aiter()

all()

any()

anext()

ascii()

B

bin()

bool()

breakpoint()

bytearray()

bytes()

C

callable()

chr()

classmethod()

compile()

complex()

D

delattr()

dict()

dir()

divmod()

E

enumerate()

eval()

exec()

F

filter()

float()

format()

frozenset()

G

getattr()

globals()

H

hasattr()

hash()

help()

hex()

I

id()

input()

int()

isinstance()

issubclass()

iter()

L

len()

list()

locals()

M

map()

max()

memoryview()

min()

N

next()

O

object()

oct()

open()

ord()

P

pow()

print()

property()

R

range()

repr()

reversed()

round()

S

set()

setattr()

slice()

sorted()

staticmethod()

str()

sum()

super()

T

tuple()

type()

V

vars()

Z

zip()

_

__import__()

abs(x)

返回一个数的绝对值。 参数可以是整数、浮点数或任何实现了 __abs__() 的对象。 如果参数是一个复数，则返回它的模。

aiter(async_iterable)

返回 asynchronous iterable 的 asynchronous iterator 。相当于调用 x.__aiter__()。

注意：与 iter() 不同，aiter() 没有两个参数的版本。

3.10 新版功能.

all(iterable)

如果 iterable 的所有元素均为真值（或可迭代对象为空）则返回 True 。 等价于：

def all(iterable):
    for element in iterable:
        if not element:
            return False
    return True

awaitable anext(async_iterator[, default])

当进入 await 状态时，从给定 asynchronous iterator 返回下一数据项，迭代完毕则返回 default。

这是内置函数 next() 的异步版本，类似于：

调用 async_iterator 的 __anext__() 方法，返回一个 awaitable。等待返回迭代器的下一个值。若有给出 default，则在迭代完毕后会返回给出的值，否则会触发 StopAsyncIteration。

3.10 新版功能.

any(iterable)

如果 iterable 的任一元素为真值则返回 True。 如果可迭代对象为空，返回 False。 等价于:

def any(iterable):
    for element in iterable:
        if element:
            return True
    return False

ascii(object)

与 repr() 类似，返回一个包含对象的可打印表示形式的字符串，但是使用 \x、\u 和 \U 对 repr() 返回的字符串中非 ASCII 编码的字符进行转义。生成的字符串和 Python 2 的 repr() 返回的结果相似。

bin(x)

将整数转变为以“0b”前缀的二进制字符串。结果是一个合法的 Python 表达式。如果 x 不是 Python 的 int 对象，它必须定义 __index__() 方法，以便返回整数值。下面是一些例子：

>>> bin(3)
'0b11'
>>> bin(-10)
'-0b1010'

若要控制是否显示前缀“0b”，可以采用以下两种方案：

>>> format(14, '#b'), format(14, 'b')
('0b1110', '1110')
>>> f'{14:#b}', f'{14:b}'
('0b1110', '1110')

另见 format() 获取更多信息。

class bool([x])

返回布尔值，True 或 False。x 用标准的 真值测试过程 进行转换。如果 x 为 False 或省略，则返回 False；否则返回 True。 bool 类是 int 的子类（见 数字类型 --- int, float, complex ）。它不能再被继承。它唯一的实例就是 False 和 True （参阅 布尔值 ）。

在 3.7 版更改: x 现在只能作为位置参数。

breakpoint(*args, **kws)

此函数会在调用点进入调试器。具体来说，它调用 sys.breakpointhook() ，直接传递 args 和 kws 。默认情况下， sys.breakpointhook() 调用 pdb.set_trace() 且没有参数。在这种情况下，它纯粹是一个便利函数，因此您不必显式导入 pdb 且键入尽可能少的代码即可进入调试器。但是， sys.breakpointhook() 可以设置为其他一些函数并被 breakpoint() 自动调用，以允许进入你想用的调试器。如果 sys.breakpointhook() 不可访问，这个函数将会引发 RuntimeError。

引发一个 审计事件 builtins.breakpoint 并附带参数 breakpointhook。

3.7 新版功能.

class bytearray([source[, encoding[, errors]]])

返回一个新的 bytes 数组。 bytearray 类是一个可变序列，包含范围为 0 <= x < 256 的整数。它有可变序列大部分常见的方法，见 可变序列类型 的描述；同时有 bytes 类型的大部分方法，参见 bytes 和 bytearray 操作。

可选形参 source 可以用不同的方式来初始化数组：

如果是一个 string，您必须提供 encoding 参数（errors 参数仍是可选的）；bytearray() 会使用 str.encode() 方法来将 string 转变成 bytes。

如果是一个 integer，会初始化大小为该数字的数组，并使用 null 字节填充。

如果是一个遵循 缓冲区接口 的对象，该对象的只读缓冲区将被用来初始化字节数组。

如果是一个 iterable 可迭代对象，它的元素的范围必须是 0 <= x < 256 的整数，它会被用作数组的初始内容。

如果没有实参，则创建大小为 0 的数组。

另见 二进制序列类型 --- bytes, bytearray, memoryview 和 bytearray 对象。

class bytes([source[, encoding[, errors]]])

返回一个新的“bytes”对象，这是一个不可变序列，包含范围为 0 <= x < 256 的整数。bytes 是 bytearray 的不可变版本——带有同样不改变序列的方法，支持同样的索引、切片操作。

因此，构造函数的实参和 bytearray() 相同。

字节对象还可以用字面值创建，参见 字符串与字节串字面值。

另见 二进制序列类型 --- bytes, bytearray, memoryview，bytes 对象 和 bytes 和 bytearray 操作。

callable(object)

如果参数 object 是可调用的就返回 True，否则返回 False。 如果返回 True，调用仍可能失败，但如果返回 False，则调用 object 将肯定不会成功。 请注意类是可调用的（调用类将返回一个新的实例）；如果实例所属的类有 __call__() 则它就是可调用的。

3.2 新版功能: 这个函数一开始在 Python 3.0 被移除了，但在 Python 3.2 被重新加入。

chr(i)

返回 Unicode 码位为整数 i 的字符的字符串格式。例如，chr(97) 返回字符串 'a'，chr(8364) 返回字符串 '€'。这是 ord() 的逆函数。

实参的合法范围是 0 到 1,114,111（16 进制表示是 0x10FFFF）。如果 i 超过这个范围，会触发 ValueError 异常。

@classmethod

把一个方法封装成类方法。

类方法隐含的第一个参数就是类，就像实例方法接收实例作为参数一样。要声明一个类方法，按惯例请使用以下方案：

class C:
    @classmethod
    def f(cls, arg1, arg2): ...

@classmethod 这样的形式称为函数的 decorator -- 详情参阅 函数定义。

类方法的调用可以在类上进行 (例如 C.f()) 也可以在实例上进行 (例如 C().f())。 其所属类以外的类实例会被忽略。 如果类方法在其所属类的派生类上调用，则该派生类对象会被作为隐含的第一个参数被传入。

类方法与 C++ 或 Java 中的静态方法不同。 如果你需要后者，请参阅本节中的 staticmethod()。 有关类方法的更多信息，请参阅 标准类型层级结构。

在 3.9 版更改: 类方法现在可以包装其他 描述器 例如 property()。

在 3.10 版更改: 类方法现在继承了方法的属性（ __module__、 __name__、 __qualname__、 __doc__ 和 __annotations__），并拥有一个新的 __wrapped__ 属性。

compile(source, filename, mode, flags=0, dont_inherit=False, optimize=- 1)

将 source 编译成代码或 AST 对象。代码对象可以被 exec() 或 eval() 执行。source 可以是常规的字符串、字节字符串，或者 AST 对象。参见 ast 模块的文档了解如何使用 AST 对象。

filename 实参需要是代码读取的文件名；如果代码不需要从文件中读取，可以传入一些可辨识的值（经常会使用 '<string>'）。

mode 实参指定了编译代码必须用的模式。如果 source 是语句序列，可以是 'exec'；如果是单一表达式，可以是 'eval'；如果是单个交互式语句，可以是 'single'。（在最后一种情况下，如果表达式执行结果不是 None 将会被打印出来。）

可选参数 flags 和 dont_inherit 控制应当激活哪个 编译器选项 以及应当允许哪个 future 特性。 如果两者都未提供 (或都为零) 则代码会应用与调用 compile() 的代码相同的旗标来编译。 如果给出了 flags 参数而未给出 dont_inherit (或者为零) 则会在无论如何都将被使用的旗标之外还会额外使用 flags 参数所指定的编译器选项和 future 语句。 如果 dont_inherit 为非零整数，则只使用 flags 参数 -- 外围代码中的旗标 (future 特性和编译器选项) 会被忽略。

编译器选项和 future 语句是由比特位来指明的。 比特位可以通过一起按位 OR 来指明多个选项。 指明特定 future 特性所需的比特位可以在 __future__ 模块的 _Feature 实例的 compiler_flag 属性中找到。 编译器旗标 可以在 ast 模块中查找带有 PyCF_ 前缀的名称。

optimize 实参指定编译器的优化级别；默认值 -1 选择与解释器的 -O 选项相同的优化级别。显式级别为 0 （没有优化；__debug__ 为真）、1 （断言被删除， __debug__ 为假）或 2 （文档字符串也被删除）。

如果编译的源码不合法，此函数会触发 SyntaxError 异常；如果源码包含 null 字节，则会触发 ValueError 异常。

如果您想分析 Python 代码的 AST 表示，请参阅 ast.parse()。

引发一个 审计事件 compile 附带参数 source, filename。

注解

在 'single' 或 'eval' 模式编译多行代码字符串时，输入必须以至少一个换行符结尾。 这使 code 模块更容易检测语句的完整性。

警告

在将足够大或者足够复杂的字符串编译成 AST 对象时，Python 解释器有可能因为 Python AST 编译器的栈深度限制而崩溃。

在 3.2 版更改: Windows 和 Mac 的换行符均可使用。而且在 'exec' 模式下的输入不必再以换行符结尾了。另增加了 optimize 参数。

在 3.5 版更改: 之前 source 中包含 null 字节的话会触发 TypeError 异常。

3.8 新版功能: ast.PyCF_ALLOW_TOP_LEVEL_AWAIT 现在可在旗标中传入以启用对最高层级 await, async for 和 async with 的支持。

class complex([real[, imag]])

返回值为 real + imag*1j 的复数，或将字符串或数字转换为复数。如果第一个形参是字符串，则它被解释为一个复数，并且函数调用时必须没有第二个形参。第二个形参不能是字符串。每个实参都可以是任意的数值类型（包括复数）。如果省略了 imag，则默认值为零，构造函数会像 int 和 float 一样进行数值转换。如果两个实参都省略，则返回 0j。

对于一个普通 Python 对象 x，complex(x) 会委托给 x.__complex__()。 如果 __complex__() 未定义则将回退至 __float__()。 如果 __float__() 未定义则将回退至 __index__()。

注解

当从字符串转换时，字符串在 + 或 - 的周围必须不能有空格。例如 complex('1+2j') 是合法的，但 complex('1 + 2j') 会触发 ValueError 异常。

数字类型 --- int, float, complex 描述了复数类型。

在 3.6 版更改: 您可以使用下划线将代码文字中的数字进行分组。

在 3.8 版更改: 如果 __complex__() 和 __float__() 未定义则回退至 __index__()。

delattr(object, name)

这是 setattr() 的相关函数。 其参数是一个对象和一个字符串。 其中字符串必须是对象的某个属性的名称。 该函数会删除指定的属性，如果对象允许这样做的话。 例如，delattr(x, 'foobar') 等价于 del x.foobar。 name 不要求必须是 Python 标识符 (参见 setattr())。

class dict(**kwarg)

class dict(mapping, **kwarg)

class dict(iterable, **kwarg)

创建一个新的字典。dict 对象是一个字典类。参见 dict 和 映射类型 --- dict 了解这个类。

其他容器类型，请参见内置的 list、set 和 tuple 类，以及 collections 模块。

dir([object])

如果没有实参，则返回当前本地作用域中的名称列表。如果有实参，它会尝试返回该对象的有效属性列表。

如果对象有一个名为 __dir__() 的方法，那么该方法将被调用，并且必须返回一个属性列表。这允许实现自定义 __getattr__() 或 __getattribute__() 函数的对象能够自定义 dir() 来报告它们的属性。

如果对象未提供 __dir__() 方法，该函数会尽量从对象的 __dict__ 属性和其类型对象中收集信息。得到的列表不一定是完整，如果对象带有自定义 __getattr__() 方法时，结果可能不准确。

默认的 dir() 机制对不同类型的对象行为不同，它会试图返回最相关而不是最全的信息：

如果对象是模块对象，则列表包含模块的属性名称。

如果对象是类型或类对象，则列表包含它们的属性名称，并且递归查找所有基类的属性。

否则，列表包含对象的属性名称，它的类属性名称，并且递归查找它的类的所有基类的属性。

返回的列表按字母表排序。例如：

>>> 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']

注解

因为 dir() 主要是为了便于在交互式时使用，所以它会试图返回人们感兴趣的名字集合，而不是试图保证结果的严格性或一致性，它具体的行为也可能在不同版本之间改变。例如，当实参是一个类时，metaclass 的属性不包含在结果列表中。

divmod(a, b)

以两个（非复数）数字为参数，在作整数除法时，返回商和余数。若操作数为混合类型，则适用二进制算术运算符的规则。对于整数而言，结果与 (a // b, a % b) 相同。对于浮点数则结果为 (q, a % b)，其中 q 通常为 math.floor(a / b)，但可能比它小 1。在任何情况下， q * b + a % b 都非常接近 a，如果 a % b 非零，则结果符号与 b 相同，并且 0 <= abs(a % b) < abs(b)。

enumerate(iterable, start=0)

返回一个枚举对象。iterable 必须是一个序列，或 iterator，或其他支持迭代的对象。 enumerate() 返回的迭代器的 __next__() 方法返回一个元组，里面包含一个计数值（从 start 开始，默认为 0）和通过迭代 iterable 获得的值。

>>> 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')]

等价于:

def enumerate(sequence, start=0):
    n = start
    for elem in sequence:
        yield n, elem
        n += 1

eval(expression[, globals[, locals]])

实参是一个字符串，以及可选的 globals 和 locals。globals 实参必须是一个字典。locals 可以是任何映射对象。

表达式解析参数 expression 并作为 Python 表达式进行求值（从技术上说是一个条件列表），采用 globals 和 locals 字典作为全局和局部命名空间。 如果存在 globals 字典，并且不包含 __builtins__ 键的值，则在解析 expression 之前会插入以该字符串为键以对内置模块 builtins 的字典的引用为值的项。 这样就可以在将 globals 传给 eval() 之前通过向其传入你自己的 __builtins__ 字典来控制可供被执行代码可以使用哪些内置模块。 如果 locals 字典被省略则它默认为 globals 字典。 如果两个字典都被省略，则将使用调用 eval() 的环境中的 globals 和 locals 来执行该表达式。 注意，eval() 无法访问闭包环境中的 嵌套作用域 (非局部变量)。

返回值就是表达式的求值结果。 语法错误将作为异常被报告。 例如：

>>> x = 1
>>> eval('x+1')
2

该函数还可用于执行任意代码对象（比如由 compile() 创建的对象）。 这时传入的是代码对象，而非一个字符串了。如果代码对象已用参数为 mode 的 'exec' 进行了编译，那么 eval() 的返回值将为 None。

提示： exec() 函数支持语句的动态执行。 globals() 和 locals() 函数分别返回当前的全局和本地字典，可供传给 eval() 或 exec() 使用。

如果给出的源数据是个字符串，那么其前后的空格和制表符将被剔除。

另外可以参阅 ast.literal_eval()，该函数可以安全执行仅包含文字的表达式字符串。

引发一个 审计事件 exec 附带参数 code_object。

exec(object[, globals[, locals]])

这个函数支持动态执行 Python 代码。 object 必须是字符串或者代码对象。 如果是字符串，那么该字符串将被解析为一系列 Python 语句并执行（除非发生语法错误）。 1 如果是代码对象，它将被直接执行。 在任何情况下，被执行的代码都应当是有效的文件输入（见参考手册中的 文件输入 一节）。 请注意即使在传递给 exec() 函数的代码的上下文中，nonlocal, yield 和 return 语句也不能在函数定义以外使用。 该函数的返回值是 None。

无论在什么情况下，如果省略了可选部分，代码将运行于当前作用域中。如果只提供了 globals，则必须为字典对象（而不能是字典的子类），同时用于存放全局变量和局部变量。如果提供了 globals 和 locals，则将分别用于全局变量和局部变量。locals 可以是任意字典映射对象。请记住，在模块级别，globals 和 locals 是同一个字典。如果 exec 获得两个独立的对象作为 globals 和 locals，代码执行起来就像嵌入到某个类定义中一样。

如果 globals 字典不包含 __builtins__ 键值，则将为该键插入对内建 builtins 模块字典的引用。因此，在将执行的代码传递给 exec() 之前，可以通过将自己的 __builtins__ 字典插入到 globals 中来控制可以使用哪些内置代码。

引发一个 审计事件 exec 附带参数 code_object。

注解

内置 globals() 和 locals() 函数各自返回当前的全局和本地字典，因此可以将它们传递给 exec() 的第二个和第三个实参。

注解

默认情况下，locals 的行为如下面 locals() 函数描述的一样：不要试图改变默认的 locals 字典。 如果您需要在 exec() 函数返回时查看代码对 locals 的影响，请明确地传递 locals 字典。

filter(function, iterable)

用 iterable 中函数 function 返回真的那些元素，构建一个新的迭代器。iterable 可以是一个序列，一个支持迭代的容器，或一个迭代器。如果 function 是 None ，则会假设它是一个身份函数，即 iterable 中所有返回假的元素会被移除。

请注意， filter(function, iterable) 相当于一个生成器表达式，当 function 不是 None 的时候为 (item for item in iterable if function(item))；function 是 None 的时候为 (item for item in iterable if item) 。

请参阅 itertools.filterfalse() 了解，只有 function 返回 false 时才选取 iterable 中元素的补充函数。

class float([x])

返回从数字或字符串 x 生成的浮点数。

如果该参数是一个字符串，则它应当包含一个十进制数字，前面可以选择带一个符号，也可以选择嵌入空格。 可选的符号可以为 '+' 或 '-'；'+' 符号对所产生的值没有影响。 该参数还可以是一个代表 NaN (not-a-number) 或正负无穷大的字符串。 更确切地说，在去除前导和尾随的空格之后，输入必须为符合以下语法的 floatvalue 产生规则:

sign        ::=  "+" | "-"
infinity    ::=  "Infinity" | "inf"
nan         ::=  "nan"
digitpart   ::=  digit (["_"] digit)*
number      ::=  [digitpart] "." digitpart | digitpart ["."]
exponent    ::=  ("e" | "E") ["+" | "-"] digitpart
floatnumber ::=  number [exponent]
floatvalue  ::=  [sign] (floatnumber | infinity | nan)

在这里 digit 是一个 Unicode 十进制数码 (Unicode 主分类为 Nd 的字符)。 对大小写不敏感，因此，举例来说，"inf", "Inf", "INFINITY" 和 "iNfINity" 都是正无穷大的可接受拼写。

另一方面，如果实参是整数或浮点数，则返回具有相同值（在 Python 浮点精度范围内）的浮点数。如果实参在 Python 浮点精度范围外，则会触发 OverflowError。

对于一个普通 Python 对象 x，float(x) 会委托给 x.__float__()。 如果 __float__() 未定义则将回退至 __index__()。

如果没有实参，则返回 0.0 。

示例:

>>> float('+1.23')
1.23
>>> float('   -12345\n')
-12345.0
>>> float('1e-003')
0.001
>>> float('+1E6')
1000000.0
>>> float('-Infinity')
-inf

数字类型 --- int, float, complex 描述了浮点类型。

在 3.6 版更改: 您可以使用下划线将代码文字中的数字进行分组。

在 3.7 版更改: x 现在只能作为位置参数。

在 3.8 版更改: 如果 __float__() 未定义则回退至 __index__()。

format(value[, format_spec])

将 value 转换为“格式化后”的形式，格式由 format_spec 进行控制。format_spec 的解释方式取决于 value 参数的类型；但大多数内置类型使用一种标准的格式化语法： 格式规格迷你语言。

默认的 format_spec 是一个空字符串，它通常给出与调用 str(value) 相同的结果。

调用 format(value, format_spec) 会转换成 type(value).__format__(value, format_spec) ，所以实例字典中的 __format__() 方法将不会调用。如果方法搜索回退到 object 类但 format_spec 不为空，或者如果 format_spec 或返回值不是字符串，则会触发 TypeError 异常。

在 3.4 版更改: 当 format_spec 不是空字符串时， object().__format__(format_spec) 会触发 TypeError。

class frozenset([iterable])

返回一个新的 frozenset 对象，它包含可选参数 iterable 中的元素。 frozenset 是一个内置的类。有关此类的文档，请参阅 frozenset 和 集合类型 --- set, frozenset。

请参阅内建的 set、list、tuple 和 dict 类，以及 collections 模块来了解其它的容器。

getattr(object, name[, default])

object 中指定名称的属性的值。 name 必须是字符串。 如果该字符串是对象的某一属性的名称，则结果将为该属性的值。 例如，getattr(x, 'foobar') 等同于 x.foobar。 如果指定名称的属性不存在，则如果提供了 default 则返回该值，否则将引发 AttributeError。 name 不必是一个 Python 标识符 (参见 setattr())。

注解

由于 私有名称混合 发生在编译时，因此必须手动混合私有属性（以两个下划线打头的属性）名称以使用 getattr() 来提取它。

globals()

返回实现当前模块命名空间的字典。对于函数内的代码，这是在定义函数时设置的，无论函数在哪里被调用都保持不变。

hasattr(object, name)

该实参是一个对象和一个字符串。如果字符串是对象的属性之一的名称，则返回 True，否则返回 False。（此功能是通过调用 getattr(object, name) 看是否有 AttributeError 异常来实现的。）

hash(object)

返回该对象的哈希值（如果它有的话）。哈希值是整数。它们在字典查找元素时用来快速比较字典的键。相同大小的数字变量有相同的哈希值（即使它们类型不同，如 1 和 1.0）。

注解

如果对象实现了自己的 __hash__() 方法，请注意，hash() 根据机器的字长来截断返回值。另请参阅 __hash__()。

help([object])

启动内置的帮助系统（此函数主要在交互式中使用）。如果没有实参，解释器控制台里会启动交互式帮助系统。如果实参是一个字符串，则在模块、函数、类、方法、关键字或文档主题中搜索该字符串，并在控制台上打印帮助信息。如果实参是其他任意对象，则会生成该对象的帮助页。

请注意，如果在调用 help() 时，目标函数的形参列表中存在斜杠（/），则意味着斜杠之前的参数只能是位置参数。详情请参阅 有关仅限位置形参的 FAQ 条目。

该函数通过 site 模块加入到内置命名空间。

在 3.4 版更改: pydoc 和 inspect 的变更使得可调用对象的签名信息更加全面和一致。

hex(x)

将整数转换为以“0x”为前缀的小写十六进制字符串。如果 x 不是 Python int 对象，则必须定义返回整数的 __index__() 方法。一些例子：

>>> hex(255)
'0xff'
>>> hex(-42)
'-0x2a'

如果要将整数转换为大写或小写的十六进制字符串，并可选择有无“0x”前缀，则可以使用如下方法：

>>> '%#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')

另见 format() 获取更多信息。

另请参阅 int() 将十六进制字符串转换为以 16 为基数的整数。

注解

如果要获取浮点数的十六进制字符串形式，请使用 float.hex() 方法。

id(object)

返回对象的“标识值”。该值是一个整数，在此对象的生命周期中保证是唯一且恒定的。两个生命期不重叠的对象可能具有相同的 id() 值。

CPython 实现细节： 这是对象在内存中的地址。

引发一个 审计事件 builtins.id 并附带参数 id。

input([prompt])

如果存在 prompt 实参，则将其写入标准输出，末尾不带换行符。接下来，该函数从输入中读取一行，将其转换为字符串（除了末尾的换行符）并返回。当读取到 EOF 时，则触发 EOFError。例如:

>>> s = input('--> ')
--> Monty Python's Flying Circus
>>> s
"Monty Python's Flying Circus"

如果加载了 readline 模块，input() 将使用它来提供复杂的行编辑和历史记录功能。

引发一个 审计事件 builtins.input 附带参数 prompt。

在成功读取输入之后引发一个 审计事件 builtins.input/result 附带结果。

class int([x])

class int(x, base=10)

返回一个基于数字或字符串 x 构造的整数对象，或者在未给出参数时返回 0。 如果 x 定义了 __int__()，int(x) 将返回 x.__int__()。 如果 x 定义了 __index__()，它将返回 x.__index__()。 如果 x 定义了 __trunc__()，它将返回 x.__trunc__()。 对于浮点数，它将向零舍入。

如果 x 不是一个数字或者如果给定了 base，则 x 必须是一个表示以 base 为基数的整数的字符串、bytes 或 bytearray 实例。 字符串前面还能加上可选的 + 或 - (中间没有空格)，带有前导的零，带有两侧的空格，并可带有数位之间的单个下划线。

一个以 n 为基数的整数字符串包含多个数位，每个数位代表从 0 到 n-1 范围内的值。 0--9 的值可以用任何 Unicode 十进制数码来表示。 10--35 的值可以用 a 到 z (或 A 到 Z) 来表示。 默认的 base 为 10。 允许的基数为 0 和 2--36。 对于基数 2, -8 和 -16 来说字符串前面还能加上可选的 0b/0B, 0o/0O 或 0x/0X 前缀，就像代码中的整数字面值那样。 对于基数 0 来说，字符串会以与 代码中的整数字面值 类似的方式来解读，即实际的基数将由前缀确定为 2, 8, 10 或 16。 基数为 0 还会禁用前导的零: int('010', 0) 将是无效的，而 int('010') 和 int('010', 8) 则是有效的。

整数类型定义请参阅 数字类型 --- int, float, complex 。

在 3.4 版更改: 如果 base 不是 int 的实例，但 base 对象有 base.__index__ 方法，则会调用该方法来获取进制数。以前的版本使用 base.__int__ 而不是 base.__index__。

在 3.6 版更改: 您可以使用下划线将代码文字中的数字进行分组。

在 3.7 版更改: x 现在只能作为位置参数。

在 3.8 版更改: 如果 __int__() 未定义则回退至 __index__()。

在 3.10.7 版更改: int 字符串输入和字符串表示形式可受到限制以帮助避免拒绝服务攻击。 当将一个字符串 x 转换为 int 或者当将一个 int 转换为字符串的操作超出限制则会引发 ValueError。 请参阅 整数字符串转换长度限制 文档。

isinstance(object, classinfo)

如果 object 参数是 classinfo 参数的实例，或其（直接、间接或 virtual ）子类的实例，则返回 True。 如果 object 不是给定类型的对象，则总是返回 False。如果 classinfo 是类型对象的元组（或由该类元组递归生成）或多个类型的 union 类型，那么当 object 是其中任一类型的实例时就会返回 True。如果 classinfo 不是某个类型或类型元组，将会触发 TypeError 异常。

在 3.10 版更改: classinfo 可以是一个 union 类型。

issubclass(class, classinfo)

如果 class 是 classinfo 的子类（直接、间接或 虚的 ），则返回 True。类将视为自己的子类。classinfo 可为类对象的元组（或递归地，其他这样的元组）或 union 类型，这时如果 class 是 classinfo 中任何条目的子类，则返回 True 。任何其他情况都会触发 TypeError 异常。

在 3.10 版更改: classinfo 可以是一个 union 类型。

iter(object[, sentinel])

返回一个 iterator 对象。根据是否存在第二个实参，第一个实参的解释是非常不同的。如果没有第二个实参，object 必须是支持 iterable 协议（有 __iter__() 方法）的集合对象，或必须支持序列协议（有 __getitem__() 方法，且数字参数从 0 开始）。如果它不支持这些协议，会触发 TypeError。如果有第二个实参 sentinel，那么 object 必须是可调用的对象。这种情况下生成的迭代器，每次迭代调用它的 __next__() 方法时都会不带实参地调用 object；如果返回的结果是 sentinel 则触发 StopIteration，否则返回调用结果。

另请参阅 迭代器类型。

适合 iter() 的第二种形式的应用之一是构建块读取器。 例如，从二进制数据库文件中读取固定宽度的块，直至到达文件的末尾:

from functools import partial
with open('mydata.db', 'rb') as f:
    for block in iter(partial(f.read, 64), b''):
        process_block(block)

len(s)

返回对象的长度（元素个数）。实参可以是序列（如 string、bytes、tuple、list 或 range 等）或集合（如 dictionary、set 或 frozen set 等）。

CPython 实现细节： len 对于大于 sys.maxsize 的长度如 range(2 ** 100) 会引发 OverflowError。

class list([iterable])

虽然被称为函数，list 实际上是一种可变序列类型，详情请参阅 列表 和 序列类型 --- list, tuple, range。

locals()

更新并返回表示当前本地符号表的字典。 在函数代码块但不是类代码块中调用 locals() 时将返回自由变量。 请注意在模块层级上，locals() 和 globals() 是同一个字典。

注解

不要更改此字典的内容；更改不会影响解释器使用的局部变量或自由变量的值。

map(function, iterable, ...)

返回一个将 function 应用于 iterable 中每一项并输出其结果的迭代器。 如果传入了额外的 iterable 参数，function 必须接受相同个数的实参并被应用于从所有可迭代对象中并行获取的项。 当有多个可迭代对象时，最短的可迭代对象耗尽则整个迭代就将结束。 对于函数的输入已经是参数元组的情况，请参阅 itertools.starmap()。

max(iterable, *[, key, default])

max(arg1, arg2, *args[, key])

返回可迭代对象中最大的元素，或者返回两个及以上实参中最大的。

如果只提供了一个位置参数，它必须是非空 iterable，返回可迭代对象中最大的元素；如果提供了两个及以上的位置参数，则返回最大的位置参数。

有两个可选只能用关键字的实参。key 实参指定排序函数用的参数，如传给 list.sort() 的。default 实参是当可迭代对象为空时返回的值。如果可迭代对象为空，并且没有给 default ，则会触发 ValueError。

如果有多个最大元素，则此函数将返回第一个找到的。这和其他稳定排序工具如 sorted(iterable, key=keyfunc, reverse=True)[0] 和 heapq.nlargest(1, iterable, key=keyfunc) 保持一致。

3.4 新版功能: keyword-only 实参 default 。

在 3.8 版更改: key 可以为 None。

class memoryview(object)

返回由给定实参创建的“内存视图”对象。有关详细信息，请参阅 内存视图。

min(iterable, *[, key, default])

min(arg1, arg2, *args[, key])

返回可迭代对象中最小的元素，或者返回两个及以上实参中最小的。

如果只提供了一个位置参数，它必须是 iterable，返回可迭代对象中最小的元素；如果提供了两个及以上的位置参数，则返回最小的位置参数。

有两个可选只能用关键字的实参。key 实参指定排序函数用的参数，如传给 list.sort() 的。default 实参是当可迭代对象为空时返回的值。如果可迭代对象为空，并且没有给 default ，则会触发 ValueError。

如果有多个最小元素，则此函数将返回第一个找到的。这和其他稳定排序工具如 sorted(iterable, key=keyfunc)[0] 和 heapq.nsmallest(1, iterable, key=keyfunc) 保持一致。

3.4 新版功能: keyword-only 实参 default 。

在 3.8 版更改: key 可以为 None。

next(iterator[, default])

通过调用 iterator 的 __next__() 方法获取下一个元素。如果迭代器耗尽，则返回给定的 default，如果没有默认值则触发 StopIteration。

class object

返回一个不带特征的新对象。object 是所有类的基类。它带有所有 Python 类实例均通用的方法。本函数不接受任何参数。

注解

由于 object 没有 __dict__，因此无法将任意属性赋给 object 的实例。

oct(x)

将一个整数转变为一个前缀为“0o”的八进制字符串。结果是一个合法的 Python 表达式。如果 x 不是 Python 的 int 对象，那它需要定义 __index__() 方法返回一个整数。一些例子：

>>> oct(8)
'0o10'
>>> oct(-56)
'-0o70'

若要将整数转换为八进制字符串，并可选择是否带有“0o”前缀，可采用如下方法：

>>> '%#o' % 10, '%o' % 10
('0o12', '12')
>>> format(10, '#o'), format(10, 'o')
('0o12', '12')
>>> f'{10:#o}', f'{10:o}'
('0o12', '12')

另见 format() 获取更多信息。

open(file, mode='r', buffering=- 1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

打开 file 并返回对应的 file object。 如果该文件不能被打开，则引发 OSError。 请参阅 读写文件 获取此函数的更多用法示例。

file 是一个 path-like object，表示将要打开的文件的路径（绝对路径或者相对当前工作目录的路径），也可以是要封装文件对应的整数类型文件描述符。（如果给出的是文件描述符，则当返回的 I/O 对象关闭时它也会关闭，除非将 closefd 设为 False 。）

mode 是可选的字符串，用于指定打开文件的模式。默认值是 'r' ，表示以文本模式打开并读取文件。其他常见模式有：写入模式 'w' （已存在文件会被清空）、独占创建模式 'x' 、追加写入模式 'a' （在 某些 Unix 系统中，无论当前文件指针在什么位置，所有 的写入操作都会追加到文件末尾）。在文本模式，如果未指定 encoding ，则会根据当前平台决定编码格式：调用 locale.getpreferredencoding(False) 获取当前地区的编码。若要读写原生字节格式，请使用二进制模式且不要指定 encoding。可用的模式有：

字符 | 含意
'r' | 读取（默认）
'w' | 写入，并先截断文件
'x' | 排它性创建，如果文件已存在则失败
'a' | 打开文件用于写入，如果文件存在则在末尾追加
'b' | 二进制模式
't' | 文本模式（默认）
'+' | 打开用于更新（读取与写入）

默认模式为 'r' （打开文件用于读取文本，与 'rt' 同义）。'w+' 和 'w+b' 模式将打开文件并清空内容。而 'r+' 和 'r+b' 模式将打开文件但不清空内容。

正如在 概述 中提到的，Python区分二进制和文本I/O。以二进制模式打开的文件（包括 mode 参数中的 'b' ）返回的内容为 bytes 对象，不进行任何解码。在文本模式下（默认情况下，或者在 mode 参数中包含 't' ）时，文件内容返回为 str ，首先使用指定的 encoding （如果给定）或者使用平台默认的的字节编码解码。

另外还有一种模式字符 'U' 可用，不过它已失效，并视作弃用。以前它会在文本模式中启用 universal newlines，这在 Python 3.0 已成为默认行为。详情请参阅 newline 形参的文档。

注解

Python不依赖于底层操作系统的文本文件概念;所有处理都由Python本身完成，因此与平台无关。

buffering 是一个可选的整数，用于设置缓冲策略。 传入 0 来关闭缓冲（只允许在二进制模式下），传入 1 来选择行缓冲（只在文本模式下可用），传入一个整数 > 1 来表示固定大小的块缓冲区的字节大小。注意，这样指定缓冲区的大小适用于二进制缓冲的 I/O ，但 TextIOWrapper （即用 mode='r+' 打开的文件）会有另一种缓冲。要禁用在 TextIOWrapper 缓冲，考虑使用 io.TextIOWrapper.reconfigure() 的 write_through 标志来。当没有给出 buffering 参数时，默认的缓冲策略工作如下。

二进制文件以固定大小的块进行缓冲；使用启发式方法选择缓冲区的大小，尝试确定底层设备的“块大小”或使用 io.DEFAULT_BUFFER_SIZE。在许多系统上，缓冲区的长度通常为4096或8192字节。

“交互式”文本文件（ isatty() 返回 True 的文件）使用行缓冲。其他文本文件使用上述策略用于二进制文件。

encoding 是用于解码或编码文件的编码的名称。这应该只在文本模式下使用。默认编码是依赖于平台的（不 管 locale.getpreferredencoding() 返回何值），但可以使用任何Python支持的 text encoding 。有关支持的编码列表，请参阅 codecs 模块。

errors 是一个可选的字符串参数，用于指定如何处理编码和解码错误 - 这不能在二进制模式下使用。可以使用各种标准错误处理程序（列在 错误处理方案 ），但是使用 codecs.register_error() 注册的任何错误处理名称也是有效的。标准名称包括:

如果存在编码错误，'strict' 会引发 ValueError 异常。 默认值 None 具有相同的效果。

'ignore' 忽略错误。请注意，忽略编码错误可能会导致数据丢失。

'replace' 会将替换标记（例如 '?' ）插入有错误数据的地方。

'surrogateescape' 将把任何不正确的字节表示为 U+DC80 至 U+DCFF 范围内的下方替代码位。 当在写入数据时使用 surrogateescape 错误处理器时这些替代码位会被转回到相同的字节。 这适用于处理具有未知编码格式的文件。

只有在写入文件时才支持 'xmlcharrefreplace'。编码不支持的字符将替换为相应的XML字符引用 &#nnn;。

'backslashreplace' 用Python的反向转义序列替换格式错误的数据。

'namereplace' （也只在编写时支持）用 \N{...} 转义序列替换不支持的字符。

newline 决定如何解析来自流的换行符。 它可以为 None, '', '\n', '\r' 和 '\r\n'。 它的工作原理如下:

从流中读取输入时，如果 newline 为 None，则启用通用换行模式。输入中的行可以以 '\n'，'\r' 或 '\r\n' 结尾，这些行被翻译成 '\n' 在返回呼叫者之前。如果它是 ''，则启用通用换行模式，但行结尾将返回给调用者未翻译。如果它具有任何其他合法值，则输入行仅由给定字符串终止，并且返回给调用者时行结尾不会被转换。

将输出写入流时，如果 newline 为 None，则写入的任何 '\n' 字符都将转换为系统默认行分隔符 os.linesep。如果 newline 是 '' 或 '\n'，则不进行翻译。如果 newline 是任何其他合法值，则写入的任何 '\n' 字符将被转换为给定的字符串。

如果 closefd 为 False 且给出的不是文件名而是文件描述符，那么当文件关闭时，底层文件描述符将保持打开状态。如果给出的是文件名，则 closefd 必须为 True （默认值），否则将触发错误。

可以通过传递可调用的 opener 来使用自定义开启器。然后通过使用参数（ file，flags ）调用 opener 获得文件对象的基础文件描述符。 opener 必须返回一个打开的文件描述符（使用 os.open as opener 时与传递 None 的效果相同）。

新创建的文件是 不可继承的。

下面的示例使用 os.open() 函数的 dir_fd 的形参，从给定的目录中用相对路径打开文件:

>>> 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)  # don't leak a file descriptor

open() 函数所返回的 file object 类型取决于所用模式。 当使用 open() 以文本模式 ('w', 'r', 'wt', 'rt' 等) 打开文件时，它将返回 io.TextIOBase (具体为 io.TextIOWrapper) 的一个子类。 当使用缓冲以二进制模式打开文件时，返回的类是 io.BufferedIOBase 的一个子类。 具体的类会有多种：在只读的二进制模式下，它将返回 io.BufferedReader；在写入二进制和追加二进制模式下，它将返回 io.BufferedWriter，而在读/写模式下，它将返回 io.BufferedRandom。 当禁用缓冲时，则会返回原始流，即 io.RawIOBase 的一个子类 io.FileIO。

另请参阅文件操作模块，如 fileinput、io （声明了 open()）、os、os.path、tempfile 和 shutil。

引发一个 审计事件 open 附带参数 file, mode, flags。

mode 与 flags 参数可以在原始调用的基础上被修改或传递。

在 3.3 版更改:

增加了 opener 形参。

增加了 'x' 模式。

过去触发的 IOError，现在是 OSError 的别名。

如果文件已存在但使用了排它性创建模式（ 'x' ），现在会触发 FileExistsError。

在 3.4 版更改:

文件现在禁止继承。

Deprecated since version 3.4, removed in version 3.10: 'U' 模式。

在 3.5 版更改:

如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

增加了 'namereplace' 错误处理接口。

在 3.6 版更改:

增加对实现了 os.PathLike 对象的支持。

在 Windows 上，打开一个控制台缓冲区将返回 io.RawIOBase 的子类，而不是 io.FileIO。

ord(c)

对表示单个 Unicode 字符的字符串，返回代表它 Unicode 码点的整数。例如 ord('a') 返回整数 97， ord('€') （欧元符号）返回 8364 。这是 chr() 的逆函数。

pow(base, exp[, mod])

返回 base 的 exp 次幂；如果 mod 存在，则返回 base 的 exp 次幂对 mod 取余（比 pow(base, exp) % mod 更高效）。 两参数形式 pow(base, exp) 等价于乘方运算符: base**exp。

参数必须为数值类型。 对于混用的操作数类型，则适用二元算术运算符的类型强制转换规则。 对于 int 操作数，结果具有与操作数相同的类型（转换后），除非第二个参数为负值；在这种情况下，所有参数将被转换为浮点数并输出浮点数结果。 例如，pow(10, 2) 返回 100，但 pow(10, -2) 返回 0.01。 对于 int 或 float 类型的负基和一个非整数的指数，会产生一个复数作为结果。 例如， pow(-9, 0.5) 返回一个接近于 3j 的值。

对于 int 操作数 base 和 exp，如果给出 mod，则 mod 必须为整数类型并且 mod 必须不为零。 如果给出 mod 并且 exp 为负值，则 base 必须相对于 mod 不可整除。 在这种情况下，将会返回 pow(inv_base, -exp, mod)，其中 inv_base 为 base 的倒数对 mod 取余。

下面的例子是 38 的倒数对 97 取余:

>>> pow(38, -1, mod=97)
23
>>> 23 * 38 % 97 == 1
True

在 3.8 版更改: 对于 int 操作数，三参数形式的 pow 现在允许第二个参数为负值，即可以计算倒数的余数。

在 3.8 版更改: 允许关键字参数。 之前只支持位置参数。

print(*objects, sep=' ', end='\n', file=None, flush=False)

将 objects 打印输出至 file 指定的文本流，以 sep 分隔并在末尾加上 end。 sep 、 end 、 file 和 flush 必须以关键字参数的形式给出。

所有非关键字参数都会被转换为字符串，就像是执行了 str() 一样，并会被写入到流，以 sep 分隔并在末尾加上 end。 sep 和 end 都必须为字符串；它们也可以为 None，这意味着使用默认值。 如果没有给出 objects，则 print() 将只写入 end。

file 参数必须是一个具有 write(string) 方法的对象；如果参数不存在或为 None，则将使用 sys.stdout。 由于要打印的参数会被转换为文本字符串，因此 print() 不能用于二进制模式的文件对象。 对于这些对象，应改用 file.write(...)。

输出缓冲通常由 file 确定。 但是，如果 flush 为真值，流将被强制刷新。

在 3.3 版更改: 增加了 flush 关键字参数。

class property(fget=None, fset=None, fdel=None, doc=None)

返回 property 属性。

fget 是获取属性值的函数。 fset 是用于设置属性值的函数。 fdel 是用于删除属性值的函数。并且 doc 为属性对象创建文档字符串。

一个典型的用法是定义一个托管属性 x:

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.")

如果 c 为 C 的实例，c.x 将调用 getter，c.x = value 将调用 setter， del c.x 将调用 deleter。

如果给出，doc 将成为该 property 属性的文档字符串。 否则该 property 将拷贝 fget 的文档字符串（如果存在）。 这令使用 property() 作为 decorator 来创建只读的特征属性可以很容易地实现:

class Parrot:
    def __init__(self):
        self._voltage = 100000

    @property
    def voltage(self):
        """Get the current voltage."""
        return self._voltage

以上 @property 装饰器会将 voltage() 方法转化为一个具有相同名称的只读属性的 "getter"，并将 voltage 的文档字符串设置为 "Get the current voltage."

特征属性对象具有 getter, setter 以及 deleter 方法，它们可用作装饰器来创建该特征属性的副本，并将相应的访问函数设为所装饰的函数。 这最好是用一个例子来解释:

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

上述代码与第一个例子完全等价。 注意一定要给附加函数与原始的特征属性相同的名称 (在本例中为 x。)

返回的特征属性对象同样具有与构造器参数相对应的属性 fget, fset 和 fdel。

在 3.5 版更改: 特征属性对象的文档字符串现在是可写的。

class range(stop)

class range(start, stop[, step])

虽然被称为函数，但 range 实际上是一个不可变的序列类型，参见在 range 对象 与 序列类型 --- list, tuple, range 中的文档说明。

repr(object)

返回包含一个对象的可打印表示形式的字符串。 对于许多类型而言，此函数将会尝试返回一个具有与传给 eval() 时相同的值的字符串；在其他情况下，其表示形式将为一个包含对象类型名称和通常包括对象名称和地址的额外信息的用尖括号括起来的字符串。 一个类可以通过定义 __repr__() 方法来控制此函数为其实例所返回的内容。 如果 sys.displayhook() 不可访问，则此函数将会引发 RuntimeError。

reversed(seq)

返回一个反向的 iterator。 seq 必须是一个具有 __reversed__() 方法的对象或者是支持该序列协议（具有从 0 开始的整数类型参数的 __len__() 方法和 __getitem__() 方法）。

round(number[, ndigits])

返回 number 舍入到小数点后 ndigits 位精度的值。 如果 ndigits 被省略或为 None，则返回最接近输入值的整数。

对于支持 round() 方法的内置类型，结果值会舍入至最接近的 10 的负 ndigits 次幂的倍数；如果与两个倍数同样接近，则选用偶数。因此，round(0.5) 和 round(-0.5) 均得出 0 而 round(1.5) 则为 2。ndigits 可为任意整数值（正数、零或负数）。如果省略了 ndigits 或为 None ，则返回值将为整数。否则返回值与 number 的类型相同。

对于一般的 Python 对象 number, round 将委托给 number.__round__。

注解

对浮点数执行 round() 的行为可能会令人惊讶：例如，round(2.675, 2) 将给出 2.67 而不是期望的 2.68。 这不算是程序错误：这一结果是由于大多数十进制小数实际上都不能以浮点数精确地表示。 请参阅 浮点算术：争议和限制 了解更多信息。

class set([iterable])

返回一个新的 set 对象，可以选择带有从 iterable 获取的元素。 set 是一个内置类型。 请查看 set 和 集合类型 --- set, frozenset 获取关于这个类的文档。

有关其他容器请参看内置的 frozenset, list, tuple 和 dict 类，以及 collections 模块。

setattr(object, name, value)

本函数与 getattr() 相对应。其参数为一个对象、一个字符串和一个任意值。字符串可以为某现有属性的名称，或为新属性。只要对象允许，函数会将值赋给属性。如 setattr(x, 'foobar', 123) 等价于 x.foobar = 123。

name 无需为在 标识符和关键字 中定义的 Python 标识符除非对象选择强制这样做，例如在一个自定义的 __getattribute__() 中或是通过 __slots__。 一个名称不为标识符的属性将不可使用点号标记来访问，但是可以通过 getattr() 等来访问。

注解

由于 私有名称混合 发生在编译时，因此必须手动混合私有属性（以两个下划线打头的属性）名称以便使用 setattr() 来设置它。

class slice(stop)

class slice(start, stop[, step])

返回一个 slice 对象，代表由 range(start, stop, step) 指定索引集的切片。 其中参数 start 和 step 的默认值为 None。切片对象具有只读数据属性 start 、stop 和 step，只是返回对应的参数值（或默认值）。这几个属性没有其他明确的功能；不过 NumPy 和其他第三方扩展会用到。在使用扩展索引语法时，也会生成切片对象。例如： a[start:stop:step] 或 a[start:stop, i]。 另一种方案是返回迭代器对象，可参阅 itertools.islice() 。

sorted(iterable, /, *, key=None, reverse=False)

根据 iterable 中的项返回一个新的已排序列表。

具有两个可选参数，它们都必须指定为关键字参数。

key 指定带有单个参数的函数，用于从 iterable 的每个元素中提取用于比较的键 (例如 key=str.lower)。 默认值为 None (直接比较元素)。

reverse 为一个布尔值。 如果设为 True，则每个列表元素将按反向顺序比较进行排序。

使用 functools.cmp_to_key() 可将老式的 cmp 函数转换为 key 函数。

内置的 sorted() 确保是稳定的。 如果一个排序确保不会改变比较结果相等的元素的相对顺序就称其为稳定的 --- 这有利于进行多重排序（例如先按部门、再按薪级排序）。

排序算法只使用 < 在项目之间比较。 虽然定义一个 __lt__() 方法就足以进行排序，但 PEP 8 [https://www.python.org/dev/peps/pep-0008] 建议实现所有六个 富比较 。 这将有助于避免在与其他排序工具（如 max() ）使用相同的数据时出现错误，这些工具依赖于不同的底层方法。实现所有六个比较也有助于避免混合类型比较的混乱，因为混合类型比较可以调用反射到 __gt__() 的方法。

有关排序示例和简要排序教程，请参阅 排序指南 。

@staticmethod

将方法转换为静态方法。

静态方法不会接收隐式的第一个参数。要声明一个静态方法，请使用此语法

class C:
    @staticmethod
    def f(arg1, arg2, ...): ...

@staticmethod 这样的形式称为函数的 decorator -- 详情参阅 函数定义。

静态方法既可以由类中调用（如 C.f()），也可以由实例中调用（如 `C().f()）。此外，还可以作为普通的函数进行调用（如 f()）。

Python 的静态方法与 Java 或 C++ 类似。另请参阅 classmethod() ，可用于创建另一种类构造函数。

像所有装饰器一样，也可以像常规函数一样调用 staticmethod ，并对其结果执行某些操作。比如某些情况下需要从类主体引用函数并且您希望避免自动转换为实例方法。对于这些情况，请使用此语法:

def regular_function():
    ...

class C:
    method = staticmethod(regular_function)

想了解更多有关静态方法的信息，请参阅 标准类型层级结构 。

在 3.10 版更改: 静态方法继承了方法的多个属性（ __module__、 __name__、 __qualname__、 __doc__ 和 __annotations__），还拥有一个新的 __wrapped__ 属性，并且现在还可以作为普通函数进行调用。

class str(object='')

class str(object=b'', encoding='utf-8', errors='strict')

返回一个 str 版本的 object 。有关详细信息，请参阅 str() 。

str 是内置字符串 class 。更多关于字符串的信息查看 文本序列类型 --- str。

sum(iterable, /, start=0)

从 start 开始自左向右对 iterable 的项求和并返回总计值。 iterable 的项通常为数字，而 start 值则不允许为字符串。

对某些用例来说，存在 sum() 的更好替代。 拼接字符串序列的更好更快方式是调用 ''.join(sequence)。 要以扩展精度对浮点值求和，请参阅 math.fsum()。 要拼接一系列可迭代对象，请考虑使用 itertools.chain()。

在 3.8 版更改: start 形参可用关键字参数形式来指定。

class super([type[, object-or-type]])

返回一个代理对象，它会将方法调用委托给 type 的父类或兄弟类。 这对于访问已在类中被重写的继承方法很有用。

object-or-type 确定用于搜索的 method resolution order。 搜索会从 type 之后的类开始。

举例来说，如果 object-or-type 的 __mro__ 为 D -> B -> C -> A -> object 并且 type 的值为 B，则 super() 将会搜索 C -> A -> object。

object-or-type 的 __mro__ 属性列出了 getattr() 和 super() 所共同使用的方法解析搜索顺序。 该属性是动态的，可以在任何继承层级结构发生更新的时候被改变。

如果省略第二个参数，则返回的超类对象是未绑定的。 如果第二个参数为一个对象，则 isinstance(obj, type) 必须为真值。 如果第二个参数为一个类型，则 issubclass(type2, type) 必须为真值（这适用于类方法）。

super 有两个典型用例。 在具有单继承的类层级结构中，super 可用来引用父类而不必显式地指定它们的名称，从而令代码更易维护。 这种用法与其他编程语言中 super 的用法非常相似。

第二个用例是在动态执行环境中支持协作多重继承。 此用例为 Python 所独有而不存在于静态编码语言或仅支持单继承的语言当中。 这使用实现“菱形图”成为可能，即有多个基类实现相同的方法。 好的设计强制要求这样的方法在每个情况下都具有相同的调用签名（因为调用顺序是在运行时确定的，也因为这个顺序要适应类层级结构的更改，还因为这个顺序可能包括在运行时之前未知的兄弟类）。

对于以上两个用例，典型的超类调用看起来是这样的:

class C(B):
    def method(self, arg):
        super().method(arg)    # This does the same thing as:
                               # super(C, self).method(arg)

除了方法查找之外，super() 也可用于属性查找。 一个可能的应用场合是在上级或同级类中调用 描述器。

请注意 super() 是作为显式加点属性查找的绑定过程的一部分来实现的，例如 super().__getitem__(name)。 它做到这一点是通过实现自己的 __getattribute__() 方法，这样就能以可预测的顺序搜索类，并且支持协作多重继承。 对应地，super() 在像 super()[name] 这样使用语句或操作符进行隐式查找时则未被定义。

还要注意的是，除了零个参数的形式以外，super() 并不限于在方法内部使用。 两个参数的形式明确指定参数并进行相应的引用。 零个参数的形式仅适用于类定义内部，因为编译器需要填入必要的细节以正确地检索到被定义的类，还需要让普通方法访问当前实例。

对于有关如何使用 super() 来如何设计协作类的实用建议，请参阅 使用 super() 的指南 [https://rhettinger.wordpress.com/2011/05/26/super-considered-super/]。

class tuple([iterable])

虽然被称为函数，但 tuple 实际上是一个不可变的序列类型，参见在 元组 与 序列类型 --- list, tuple, range 中的文档说明。

class type(object)

class type(name, bases, dict, **kwds)

传入一个参数时，返回 object 的类型。 返回值是一个 type 对象，通常与 object.__class__ 所返回的对象相同。

推荐使用 isinstance() 内置函数来检测对象的类型，因为它会考虑子类的情况。

传入三个参数时，返回一个新的 type 对象。 这在本质上是 class 语句的一种动态形式，name 字符串即类名并会成为 __name__ 属性；bases 元组包含基类并会成为 __bases__ 属性；如果为空则会添加所有类的终极基类 object。 dict 字典包含类主体的属性和方法定义；它在成为 __dict__ 属性之前可能会被拷贝或包装。 下面两条语句会创建相同的 type 对象:

>>> class X:
...     a = 1
...
>>> X = type('X', (), dict(a=1))

另请参阅 类型对象。

提供给三参数形式的关键字参数会被传递给适当的元类机制 (通常为 __init_subclass__())，相当于类定义中关键字 (除了 metaclass) 的行为方式。

另请参阅 自定义类创建。

在 3.6 版更改: type 的子类如果未重载 type.__new__，将不再能使用一个参数的形式来获取对象的类型。

vars([object])

返回模块、类、实例或任何其它具有 __dict__ 属性的对象的 __dict__ 属性。

模块和实例这样的对象具有可更新的 __dict__ 属性；但是，其它对象的 __dict__ 属性可能会设为限制写入（例如，类会使用 types.MappingProxyType 来防止直接更新字典）。

不带参数时，vars() 的行为类似 locals()。 请注意，locals 字典仅对于读取起作用，因为对 locals 字典的更新会被忽略。

如果指定了一个对象但它没有 __dict__ 属性（例如，当它所属的类定义了 __slots__ 属性时）则会引发 TypeError 异常。

zip(*iterables, strict=False)

在多个迭代器上并行迭代，从每个迭代器返回一个数据项组成元组。

示例:

>>> for item in zip([1, 2, 3], ['sugar', 'spice', 'everything nice']):
...     print(item)
...
(1, 'sugar')
(2, 'spice')
(3, 'everything nice')

更正式的说法： zip() 返回元组的迭代器，其中第 i 个元组包含的是每个参数迭代器的第 i 个元素。

不妨换一种方式认识 zip() ：它会把行变成列，把列变成行。这类似于 矩阵转置 [https://en.wikipedia.org/wiki/Transpose] 。

zip() 是延迟执行的：直至迭代时才会对元素进行处理，比如 for 循环或放入 list 中。

值得考虑的是，传给 zip() 的可迭代对象可能长度不同；有时是有意为之，有时是因为准备这些对象的代码存在错误。Python 提供了三种不同的处理方案：

默认情况下，zip() 在最短的迭代完成后停止。较长可迭代对象中的剩余项将被忽略，结果会裁切至最短可迭代对象的长度：

>>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum']))
[(0, 'fee'), (1, 'fi'), (2, 'fo')]

通常 zip() 用于可迭代对象等长的情况下。这时建议用 strict=True 的选项。输出与普通的 zip() 相同：。

>>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True))
[('a', 1), ('b', 2), ('c', 3)]

与默认行为不同，如果一个可迭代对象在其他几个之前被耗尽则会引发 ValueError:

>>> 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

如果未指定 strict=True 参数，所有导致可迭代对象长度不同的错误都会被抑制，这可能会在程序的其他地方表现为难以发现的错误。

为了让所有的可迭代对象具有相同的长度，长度较短的可用常量进行填充。这可由 itertools.zip_longest() 来完成。

极端例子是只有一个可迭代对象参数，zip() 会返回一个一元组的迭代器。如果未给出参数，则返回一个空的迭代器。

小技巧：

可确保迭代器的求值顺序是从左到右的。这样就能用 zip(*[iter(s)]*n, strict=True) 将数据列表按长度 n 进行分组。这将重复 相同 的迭代器 n 次，输出的每个元组都包含 n 次调用迭代器的结果。这样做的效果是把输入拆分为长度为 n 的块。

zip() 与 * 运算符相结合可以用来拆解一个列表:

>>> 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

在 3.10 版更改: 增加了 strict 参数。

__import__(name, globals=None, locals=None, fromlist=(), level=0)

注解

与 importlib.import_module() 不同，这是一个日常 Python 编程中不需要用到的高级函数。

此函数会由 import 语句唤起。 它可以被替换 (通过导入 builtins 模块并赋值给 builtins.__import__) 以便修改 import 语句的语义，但是 强烈 不建议这样做，因为使用导入钩子 (参见 PEP 302 [https://www.python.org/dev/peps/pep-0302]) 通常更容易实现同样的目标，并且不会导致代码问题，因为许多代码都会假定所用的是默认实现。 同样也不建议直接使用 __import__() 而应该用 importlib.import_module()。

本函数会导入模块 name，利用 globals 和 locals 来决定如何在包的上下文中解释该名称。fromlist 给出了应从 name 模块中导入的对象或子模块的名称。标准的实现代码完全不会用到 locals 参数，只用到了 globals 用于确定 import 语句所在的包上下文。

level 指定是使用绝对还是相对导入。 0 (默认值) 意味着仅执行绝对导入。 level 为正数值表示相对于模块调用 __import__() 的目录，将要搜索的父目录层数 (详情参见 PEP 328 [https://www.python.org/dev/peps/pep-0328])。

当 name 变量的形式为 package.module 时，通常将会返回最高层级的包（第一个点号之前的名称），而 不是 以 name 命名的模块。 但是，当给出了非空的 fromlist 参数时，则将返回以 name 命名的模块。

例如，语句 import spam 的结果将为与以下代码作用相同的字节码:

spam = __import__('spam', globals(), locals(), [], 0)

语句 import spam.ham 的结果将为以下调用:

spam = __import__('spam.ham', globals(), locals(), [], 0)

请注意在这里 __import__() 是如何返回顶层模块的，因为这是通过 import 语句被绑定到特定名称的对象。

另一方面，语句 from spam.ham import eggs, sausage as saus 的结果将为

_temp = __import__('spam.ham', globals(), locals(), ['eggs', 'sausage'], 0)
eggs = _temp.eggs
saus = _temp.sausage

在这里， spam.ham 模块会由 __import__() 返回。 要导入的对象将从此对象中提取并赋值给它们对应的名称。

如果您只想按名称导入模块（可能在包中），请使用 importlib.import_module()

在 3.3 版更改: level 的值不再支持负数（默认值也修改为0）。

在 3.9 版更改: 当使用了命令行参数 -E 或 -I 时，环境变量 PYTHONCASEOK 现在将被忽略。

备注

1

解析器只接受 Unix 风格的行结束符。如果您从文件中读取代码，请确保用换行符转换模式转换 Windows 或 Mac 风格的换行符。

内置常量

有少数的常量存在于内置命名空间中。 它们是：

False

bool 类型的假值。 给 False 赋值是非法的并会引发 SyntaxError。

True

bool 类型的真值。 给 True 赋值是非法的并会引发 SyntaxError。

None

通常被用来代表空值的对象，例如在未向某个函数传入默认参数时。 给 None 赋值是非法的并会引发 SyntaxError。 None 是 NoneType 类型的唯一实例。

NotImplemented

应当由双目运算特殊方法（如 __eq__(), __lt__(), __add__(), __rsub__() 等）返回的特殊值，用于表明运算没有针对其他类型的实现；也可由原地双目运算特殊方法（如 __imul__(), __iand__() 等）出于同样的目的而返回。 它不应在布尔运算中被求值。 NotImplemented 是 types.NotImplementedType 类型的唯一实例。

注解

当二进制（或就地）方法返回 NotImplemented 时，解释器将尝试对另一种类型（或其他一些回滚操作，取决于运算符）的反射操作。 如果所有尝试都返回 NotImplemented ，则解释器将引发适当的异常。 错误返回的 NotImplemented 将导致误导性错误消息或返回到Python代码中的 NotImplemented 值。

参见 实现算术运算 为例。

注解

NotImplementedError 和 NotImplemented 不可互换，即使它们有相似的名称和用途。 有关何时使用它的详细信息，请参阅 NotImplementedError。

在 3.9 版更改: 作为布尔值来解读 NotImplemented 已被弃用。 虽然它目前会被解读为真值，但将同时发出 DeprecationWarning。 它将在未来的 Python 版本中引发 TypeError。

Ellipsis

与省略号字面值 "..." 相同。 该特殊值主要是与用户定义的容器数据类型的扩展切片语法结合使用。 Ellipsis 是 types.EllipsisType 类型的唯一实例。

__debug__

如果 Python 没有以 -O 选项启动，则此常量为真值。 另请参见 assert 语句。

注解

变量名 None，False，True 和 __ debug__ 无法重新赋值（赋值给它们，即使是属性名，将引发 SyntaxError ），所以它们可以被认为是“真正的”常数。

由 site 模块添加的常量

site 模块（在启动期间自动导入，除非给出 -S 命令行选项）将几个常量添加到内置命名空间。 它们对交互式解释器 shell 很有用，并且不应在程序中使用。

quit(code=None)

exit(code=None)

当打印此对象时，会打印出一条消息，例如“Use quit() or Ctrl-D (i.e. EOF) to exit”，当调用此对象时，将使用指定的退出代码来引发 SystemExit。

copyright

credits

打印或调用的对象分别打印版权或作者的文本。

license

当打印此对象时，会打印出一条消息“Type license() to see the full license text”，当调用此对象时，将以分页形式显示完整的许可证文本（每次显示一屏）。

内置类型

以下部分描述了解释器中内置的标准类型。

主要内置类型有数字、序列、映射、类、实例和异常。

有些多项集类是可变的。 它们用于添加、移除或重排其成员的方法将原地执行，并不返回特定的项，绝对不会返回多项集实例自身而是返回 None。

有些操作受多种对象类型的支持；特别地，实际上所有对象都可以比较是否相等、检测逻辑值，以及转换为字符串（使用 repr() 函数或略有差异的 str() 函数）。 后一个函数是在对象由 print() 函数输出时被隐式地调用的。

逻辑值检测

任何对象都可以进行逻辑值的检测，以便在 if 或 while 作为条件或是作为下文所述布尔运算的操作数来使用。

一个对象在默认情况下均被视为真值，除非当该对象被调用时其所属类定义了 __bool__() 方法且返回 False 或是定义了 __len__() 方法且返回零。 1 下面基本完整地列出了会被视为假值的内置对象:

被定义为假值的常量: None 和 False。

任何数值类型的零: 0, 0.0, 0j, Decimal(0), Fraction(0, 1)

空的序列和多项集: '', (), [], {}, set(), range(0)

产生布尔值结果的运算和内置函数总是返回 0 或 False 作为假值，1 或 True 作为真值，除非另行说明。 （重要例外：布尔运算 or 和 and 总是返回其中一个操作数。）

布尔运算 --- and, or, not

这些属于布尔运算，按优先级升序排列:

运算 | 结果： | 备注
x or y | 如果 x 为真值，则 x，否则 y | (1)
x and y | if x is false, then x, else y | (2)
not x | if x is false, then True, else False | (3)

注释：

这是个短路运算符，因此只有在第一个参数为假值时才会对第二个参数求值。

这是个短路运算符，因此只有在第一个参数为真值时才会对第二个参数求值。

not 的优先级比非布尔运算符低，因此 not a == b 会被解读为 not (a == b) 而 a == not b 会引发语法错误。

比较运算

在 Python 中有八种比较运算符。 它们的优先级相同（比布尔运算的优先级高）。 比较运算可以任意串连；例如，x < y <= z 等价于 x < y and y <= z，前者的不同之处在于 y 只被求值一次（但在两种情况下当 x < y 结果为假值时 z 都不会被求值）。

此表格汇总了比较运算:

运算 | 含意
< | 严格小于
<= | 小于或等于
> | 严格大于
>= | 大于或等于
== | 等于
!= | 不等于
is | 对象标识
is not | 否定的对象标识

除不同的数字类型外，不同类型的对象不能进行相等比较。== 运算符总有定义，但对于某些对象类型（例如，类对象），它等于 is 。其他 <、<=、> 和 >= 运算符仅在有意义的地方定义。例如，当参与比较的参数之一为复数时，它们会抛出 TypeError 异常。

具有不同标识的类的实例比较结果通常为不相等，除非类定义了 __eq__() 方法。

一个类的实例不能与相同类的其他实例或其他类型的对象进行排序，除非定义该类定义了足够多的方法，包括 __lt__(), __le__(), __gt__() 以及 __ge__() (而如果你想实现常规意义上的比较操作，通常只要有 __lt__() 和 __eq__() 就可以了)。

is 和 is not 运算符无法自定义；并且它们可以被应用于任意两个对象而不会引发异常。

还有两种具有相同语法优先级的运算 in 和 not in，它们被 iterable 或实现了 __contains__() 方法的类型所支持。

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

存在三种不同的数字类型: 整数, 浮点数 和 复数。 此外，布尔值属于整数的子类型。 整数具有无限的精度。 浮点数通常使用 C 中的 double 来实现；有关你的程序运行所在机器上浮点数的精度和内部表示法可在 sys.float_info 中查看。 复数包含实部和虚部，分别以一个浮点数表示。 要从一个复数 z 中提取这两个部分，可使用 z.real 和 z.imag。 （标准库包含附加的数字类型，如表示有理数的 fractions.Fraction 以及以用户定制精度表示浮点数的 decimal.Decimal。）

数字是由数字字面值或内置函数与运算符的结果来创建的。 不带修饰的整数字面值（包括十六进制、八进制和二进制数）会生成整数。 包含小数点或幂运算符的数字字面值会生成浮点数。 在数字字面值末尾加上 'j' 或 'J' 会生成虚数（实部为零的复数），你可以将其与整数或浮点数相加来得到具有实部和虚部的复数。

Python 完全支持混合运算：当一个二元算术运算符的操作数有不同数值类型时，"较窄"类型的操作数会拓宽到另一个操作数的类型，其中整数比浮点数窄，浮点数比复数窄。不同类型的数字之间的比较，同比较这些数字的精确值一样。2

构造函数 int()、 float() 和 complex() 可以用来构造特定类型的数字。

所有数字类型（复数除外）都支持下列运算（有关运算优先级，请参阅：运算符优先级）:

运算 | 结果： | 备注 | 完整文档
x + y | x 和 y 的和 |  |
x - y | x 和 y 的差 |  |
x * y | x 和 y 的乘积 |  |
x / y | x 和 y 的商 |  |
x // y | x 和 y 的商数 | (1) |
x % y | x / y 的余数 | (2) |
-x | x 取反 |  |
+x | x 不变 |  |
abs(x) | x 的绝对值或大小 |  | abs()
int(x) | 将 x 转换为整数 | (3)(6) | int()
float(x) | 将 x 转换为浮点数 | (4)(6) | float()
complex(re, im) | 一个带有实部 re 和虚部 im 的复数。im 默认为0。 | (6) | complex()
c.conjugate() | 复数 c 的共轭 |  |
divmod(x, y) | (x // y, x % y) | (2) | divmod()
pow(x, y) | x 的 y 次幂 | (5) | pow()
x ** y | x 的 y 次幂 | (5) |

注释：

也称为整数除法。 结果值是一个整数，但结果的类型不一定是 int。 运算结果总是向负无穷的方向舍入: 1//2 为 0, (-1)//2 为 -1, 1//(-2) 为 -1 而 (-1)//(-2) 为 0。

不可用于复数。 而应在适当条件下使用 abs() 转换为浮点数。

从 float 转换为 int 将会执行截断，丢弃掉小数部分。 请参阅 math.floor() 和 math.ceil() 函数了解替代的转换方式。

float 也接受字符串 "nan" 和附带可选前缀 "+" 或 "-" 的 "inf" 分别表示非数字 (NaN) 以及正或负无穷。

Python 将 pow(0, 0) 和 0 ** 0 定义为 1，这是编程语言的普遍做法。

接受的数字字面值包括数码 0 到 9 或任何等效的 Unicode 字符（具有 Nd 特征属性的代码点）。

请参阅 https://www.unicode.org/Public/13.0.0/ucd/extracted/DerivedNumericType.txt 查看具有 Nd 特征属性的代码点的完整列表。

所有 numbers.Real 类型 (int 和 float) 还包括下列运算:

运算 | 结果：
math.trunc(x) | x 截断为 Integral
round(x[, n]) | x 舍入到 n 位小数，半数值会舍入到偶数。 如果省略 n，则默认为 0。
math.floor(x) | <= x 的最大 Integral
math.ceil(x) | >= x 的最小 Integral

有关更多的数字运算请参阅 math 和 cmath 模块。

整数类型的按位运算

按位运算只对整数有意义。 计算按位运算的结果，就相当于使用无穷多个二进制符号位对二的补码执行操作。

二进制按位运算的优先级全都低于数字运算，但又高于比较运算；一元运算 ~ 具有与其他一元算术运算 (+ and -) 相同的优先级。

此表格是以优先级升序排序的按位运算列表:

运算 | 结果： | 备注
x | y | x 和 y 按位 或 | (4)
x ^ y | x 和 y 按位 异或 | (4)
x & y | x 和 y 按位 与 | (4)
x << n | x 左移 n 位 | (1)(2)
x >> n | x 右移 n 位 | (1)(3)
~x | x 逐位取反 |

注释：

负的移位数是非法的，会导致引发 ValueError。

左移 n 位等价于乘以 pow(2, n) 。

右移 n 位等价于除以 pow(2, n) ，作向下取整除法。

使用带有至少一个额外符号扩展位的有限个二进制补码表示（有效位宽度为 1 + max(x.bit_length(), y.bit_length()) 或以上）执行这些计算就足以获得相当于有无数个符号位时的同样结果。

整数类型的附加方法

int 类型实现了 numbers.Integral abstract base class。 此外，它还提供了其他几个方法:

int.bit_length()

返回以二进制表示一个整数所需要的位数，不包括符号位和前面的零:

>>> n = -37
>>> bin(n)
'-0b100101'
>>> n.bit_length()
6

更准确地说，如果 x 非零，则 x.bit_length() 是使得 2**(k-1) <= abs(x) < 2**k 的唯一正整数 k。 同样地，当 abs(x) 小到足以具有正确的舍入对数时，则 k = 1 + int(log(abs(x), 2))。 如果 x 为零，则 x.bit_length() 返回 0。

等价于:

def bit_length(self):
    s = bin(self)       # binary representation:  bin(-37) --> '-0b100101'
    s = s.lstrip('-0b') # remove leading zeros and minus sign
    return len(s)       # len('100101') --> 6

3.1 新版功能.

int.bit_count()

返回整数的绝对值的二进制表示中 1 的个数。也被称为 population count。示例:

>>> n = 19
>>> bin(n)
'0b10011'
>>> n.bit_count()
3
>>> (-n).bit_count()
3

等价于:

def bit_count(self):
    return bin(self).count("1")

3.10 新版功能.

int.to_bytes(length, byteorder, *, signed=False)

返回表示一个整数的字节数组。

>>> (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'

整数会使用 length 个字节来表示。 如果整数不能用给定的字节数来表示则会引发 OverflowError。

byteorder 参数确定用于表示整数的字节顺序。 如果 byteorder 为 "big"，则最高位字节放在字节数组的开头。 如果 byteorder 为 "little"，则最高位字节放在字节数组的末尾。 要请求主机系统上的原生字节顺序，请使用 sys.byteorder 作为字节顺序值。

signed 参数确定是否使用二的补码来表示整数。 如果 signed 为 False 并且给出的是负整数，则会引发 OverflowError。 signed 的默认值为 False。

3.2 新版功能.

classmethod int.from_bytes(bytes, byteorder, *, signed=False)

返回由给定字节数组所表示的整数。

>>> 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

bytes 参数必须为一个 bytes-like object 或是生成字节的可迭代对象。

byteorder 参数确定用于表示整数的字节顺序。 如果 byteorder 为 "big"，则最高位字节放在字节数组的开头。 如果 byteorder 为 "little"，则最高位字节放在字节数组的末尾。 要请求主机系统上的原生字节顺序，请使用 sys.byteorder 作为字节顺序值。

signed 参数指明是否使用二的补码来表示整数。

3.2 新版功能.

int.as_integer_ratio()

返回一对整数，其比率正好等于原整数并且分母为正数。 整数的比率总是用这个整数本身作为分子，1 作为分母。

3.8 新版功能.

浮点类型的附加方法

float 类型实现了 numbers.Real abstract base class。 float 还具有以下附加方法。

float.as_integer_ratio()

返回一对整数，其比率正好等于原浮点数并且分母为正数。 无穷大会引发 OverflowError 而 NaN 则会引发 ValueError。

float.is_integer()

如果 float 实例可用有限位整数表示则返回 True，否则返回 False:

>>> (-2.0).is_integer()
True
>>> (3.2).is_integer()
False

两个方法均支持与十六进制数字符串之间的转换。 由于 Python 浮点数在内部存储为二进制数，因此浮点数与 十进制数 字符串之间的转换往往会导致微小的舍入错误。 而十六进制数字符串却允许精确地表示和描述浮点数。 这在进行调试和数值工作时非常有用。

float.hex()

以十六进制字符串的形式返回一个浮点数表示。 对于有限浮点数，这种表示法将总是包含前导的 0x 和尾随的 p 加指数。

classmethod float.fromhex(s)

返回以十六进制字符串 s 表示的浮点数的类方法。 字符串 s 可以带有前导和尾随的空格。

请注意 float.hex() 是实例方法，而 float.fromhex() 是类方法。

十六进制字符串采用的形式为:

[sign] ['0x'] integer ['.' fraction] ['p' exponent]

可选的 sign 可以是 + 或 -，integer 和 fraction 是十六进制数码组成的字符串，exponent 是带有可选前导符的十进制整数。 大小写没有影响，在 integer 或 fraction 中必须至少有一个十六进制数码。 此语法类似于 C99 标准的 6.4.4.2 小节中所描述的语法，也是 Java 1.5 以上所使用的语法。 特别地，float.hex() 的输出可以用作 C 或 Java 代码中的十六进制浮点数字面值，而由 C 的 %a 格式字符或 Java 的 Double.toHexString 所生成的十六进制数字符串由为 float.fromhex() 所接受。

请注意 exponent 是十进制数而非十六进制数，它给出要与系数相乘的 2 的幂次。 例如，十六进制数字符串 0x3.a7p10 表示浮点数 (3 + 10./16 + 7./16**2) * 2.0**10 即 3740.0:

>>> float.fromhex('0x3.a7p10')
3740.0

对 3740.0 应用反向转换会得到另一个代表相同数值的十六进制数字符串:

>>> float.hex(3740.0)
'0x1.d380000000000p+11'

数字类型的哈希运算

对于可能为不同类型的数字 x 和 y，要求 x == y 时必定 hash(x) == hash(y) (详情参见 __hash__() 方法的文档)。 为了便于在各种数字类型 (包括 int, float, decimal.Decimal 和 fractions.Fraction) 上实现并保证效率，Python 对数字类型的哈希运算是基于为任意有理数定义统一的数学函数，因此该运算对 int 和 fractions.Fraction 的全部实例，以及 float 和 decimal.Decimal 的全部有限实例均可用。 从本质上说，此函数是通过以一个固定质数 P 进行 P 降模给出的。 P 的值在 Python 中可以 sys.hash_info 的 modulus 属性的形式被访问。

CPython 实现细节： 目前所用的质数设定，在 C long 为 32 位的机器上 P = 2**31 - 1 而在 C long 为 64 位的机器上 P = 2**61 - 1。

详细规则如下所述:

如果 x = m / n 是一个非负的有理数且 n 不可被 P 整除，则定义 hash(x) 为 m * invmod(n, P) % P，其中 invmod(n, P) 是对 n 模 P 取反。

如果 x = m / n 是一个非负的有理数且 n 可被 P 整除（但 m 不能）则 n 不能对 P 降模，以上规则不适用；在此情况下则定义 hash(x) 为常数值 sys.hash_info.inf。

如果 x = m / n 是一个负的有理数则定义 hash(x) 为 -hash(-x)。 如果结果哈希值为 -1 则将其替换为 -2。

特殊值 sys.hash_info.inf 和 -sys.hash_info.inf 分别用于正无穷或负无穷的哈希值。

对于一个 complex 值 z，会通过计算 hash(z.real) + sys.hash_info.imag * hash(z.imag) 将实部和虚部的哈希值结合起来，并进行降模 2**sys.hash_info.width 以使其处于 range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width - 1)) 范围之内。 同样地，如果结果为 -1 则将其替换为 -2。

为了阐明上述规则，这里有一些等价于内置哈希算法的 Python 代码示例，可用于计算有理数、float 或 complex 的哈希值:

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
    # Remove common factors of P.  (Unnecessary if m and n already coprime.)
    while m % P == n % P == 0:
        m, n = m // P, n // P

    if n % P == 0:
        hash_value = sys.hash_info.inf
    else:
        # Fermat's Little Theorem: pow(n, P-1, P) is 1, so
        # pow(n, P-2, P) gives the inverse of n modulo 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)
    # do a signed reduction modulo 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

迭代器类型

Python 支持在容器中进行迭代的概念。 这是通过使用两个单独方法来实现的；它们被用于允许用户自定义类对迭代的支持。 将在下文中详细描述的序列总是支持迭代方法。

容器对象要提供 iterable 支持，必须定义一个方法:

container.__iter__()

返回一个 iterator 对象。 该对象需要支持下文所述的迭代器协议。 如果容器支持不同的迭代类型，则可以提供额外的方法来专门地请求不同迭代类型的迭代器。 （支持多种迭代形式的对象的例子有同时支持广度优先和深度优先遍历的树结果。） 此方法对应于 Python/C API 中 Python 对象类型结构体的 tp_iter 槽位。

迭代器对象自身需要支持以下两个方法，它们共同组成了 迭代器协议:

iterator.__iter__()

返回 iterator 对象本身。 这是同时允许容器和迭代器配合 for 和 in 语句使用所必须的。 此方法对应于 Python/C API 中 Python 对象类型结构体的 tp_iter 槽位。

iterator.__next__()

iterator 中返回下一项。 如果已经没有可返回的项，则会引发 StopIteration 异常。 此方法对应于 Python/C API 中 Python 对象类型结构体的 tp_iternext 槽位。

Python 定义了几种迭代器对象以支持对一般和特定序列类型、字典和其他更特别的形式进行迭代。 除了迭代器协议的实现，特定类型的其他性质对迭代操作来说都不重要。

一旦迭代器的 __next__() 方法引发了 StopIteration，它必须一直对后续调用引发同样的异常。 不遵循此行为特性的实现将无法正常使用。

生成器类型

Python 的 generator 提供了一种实现迭代器协议的便捷方式。 如果容器对象 __iter__() 方法被实现为一个生成器，它将自动返回一个迭代器对象（从技术上说是一个生成器对象），该对象提供 __iter__() 和 __next__() 方法。 有关生成器的更多信息可以参阅 yield 表达式的文档。

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

有三种基本序列类型：list, tuple 和 range 对象。 为处理 二进制数据 和 文本字符串 而特别定制的附加序列类型会在专门的小节中描述。

通用序列操作

大多数序列类型，包括可变类型和不可变类型都支持下表中的操作。 collections.abc.Sequence ABC 被提供用来更容易地在自定义序列类型上正确地实现这些操作。

此表按优先级升序列出了序列操作。 在表格中，s 和 t 是具有相同类型的序列，n, i, j 和 k 是整数而 x 是任何满足 s 所规定的类型和值限制的任意对象。

in 和 not in 操作具有与比较操作相同的优先级。 + (拼接) 和 * (重复) 操作具有与对应数值运算相同的优先级。 3

运算 | 结果： | 备注
x in s | 如果 s 中的某项等于 x 则结果为 True，否则为 False | (1)
x not in s | 如果 s 中的某项等于 x 则结果为 False，否则为 True | (1)
s + t | s 与 t 相拼接 | (6)(7)
s * n 或 n * s | 相当于 s 与自身进行 n 次拼接 | (2)(7)
s[i] | s 的第 i 项，起始为 0 | (3)
s[i:j] | s 从 i 到 j 的切片 | (3)(4)
s[i:j:k] | s 从 i 到 j 步长为 k 的切片 | (3)(5)
len(s) | s 的长度 |
min(s) | s 的最小项 |
max(s) | s 的最大项 |
s.index(x[, i[, j]]) | x 在 s 中首次出现项的索引号（索引号在 i 或其后且在 j 之前） | (8)
s.count(x) | x 在 s 中出现的总次数 |

相同类型的序列也支持比较。 特别地，tuple 和 list 的比较是通过比较对应元素的字典顺序。 这意味着想要比较结果相等，则每个元素比较结果都必须相等，并且两个序列长度必须相同。 （完整细节请参阅语言参考的 比较运算 部分。）

可变序列的正向和逆向迭代器使用一个索引来访问值。 即使底层序列被改变该索引也将持续向前（或向后）步进。 迭代器只有在遇到 IndexError 或 a StopIteration 时才会终结（或是当索引降至零以下）。

注释：

虽然 in 和 not in 操作在通常情况下仅被用于简单的成员检测，某些专门化序列 (例如 str, bytes 和 bytearray) 也使用它们进行子序列检测:

>>> "gg" in "eggs"
True

小于 0 的 n 值会被当作 0 来处理 (生成一个与 s 同类型的空序列)。 请注意序列 s 中的项并不会被拷贝；它们会被多次引用。 这一点经常会令 Python 编程新手感到困扰；例如:

>>> lists = [[]] * 3
>>> lists
[[], [], []]
>>> lists[0].append(3)
>>> lists
[[3], [3], [3]]

具体的原因在于 [[]] 是一个包含了一个空列表的单元素列表，所以 [[]] * 3 结果中的三个元素都是对这一个空列表的引用。 修改 lists 中的任何一个元素实际上都是对这一个空列表的修改。 你可以用以下方式创建以不同列表为元素的列表:

>>> lists = [[] for i in range(3)]
>>> lists[0].append(3)
>>> lists[1].append(5)
>>> lists[2].append(7)
>>> lists
[[3], [5], [7]]

进一步的解释可以在 FAQ 条目 如何创建多维列表？ 中查看。

如果 i 或 j 为负值，则索引顺序是相对于序列 s 的末尾: 索引号会被替换为 len(s) + i 或 len(s) + j。 但要注意 -0 仍然为 0。

s 从 i 到 j 的切片被定义为所有满足 i <= k < j 的索引号 k 的项组成的序列。 如果 i 或 j 大于 len(s)，则使用 len(s)。 如果 i 被省略或为 None，则使用 0。 如果 j 被省略或为 None，则使用 len(s)。 如果 i 大于等于 j，则切片为空。

s 从 i 到 j 步长为 k 的切片被定义为所有满足 0 <= n < (j-i)/k 的索引号 x = i + n*k 的项组成的序列。 换句话说，索引号为 i, i+k, i+2*k, i+3*k，以此类推，当达到 j 时停止 (但一定不包括 j)。 当 k 为正值时，i 和 j 会被减至不大于 len(s)。 当 k 为负值时，i 和 j 会被减至不大于 len(s) - 1。 如果 i 或 j 被省略或为 None，它们会成为“终止”值 (是哪一端的终止值则取决于 k 的符号)。 请注意，k 不可为零。 如果 k 为 None，则当作 1 处理。

拼接不可变序列总是会生成新的对象。 这意味着通过重复拼接来构建序列的运行时开销将会基于序列总长度的乘方。 想要获得线性的运行时开销，你必须改用下列替代方案之一：

如果拼接 str 对象，你可以构建一个列表并在最后使用 str.join() 或是写入一个 io.StringIO 实例并在结束时获取它的值

如果拼接 bytes 对象，你可以类似地使用 bytes.join() 或 io.BytesIO，或者你也可以使用 bytearray 对象进行原地拼接。 bytearray 对象是可变的，并且具有高效的重分配机制

如果拼接 tuple 对象，请改为扩展 list 类

对于其它类型，请查看相应的文档

某些序列类型 (例如 range) 仅支持遵循特定模式的项序列，因此并不支持序列拼接或重复。

当 x 在 s 中找不到时 index 会引发 ValueError。 不是所有实现都支持传入额外参数 i 和 j。 这两个参数允许高效地搜索序列的子序列。 传入这两个额外参数大致相当于使用 s[i:j].index(x)，但是不会复制任何数据，并且返回的索引是相对于序列的开头而非切片的开头。

不可变序列类型

不可变序列类型普遍实现而可变序列类型未实现的唯一操作就是对 hash() 内置函数的支持。

这种支持允许不可变类型，例如 tuple 实例被用作 dict 键，以及存储在 set 和 frozenset 实例中。

尝试对包含有不可哈希值的不可变序列进行哈希运算将会导致 TypeError。

可变序列类型

以下表格中的操作是在可变序列类型上定义的。 collections.abc.MutableSequence ABC 被提供用来更容易地在自定义序列类型上正确实现这些操作。

表格中的 s 是可变序列类型的实例，t 是任意可迭代对象，而 x 是符合对 s 所规定类型与值限制的任何对象 (例如，bytearray 仅接受满足 0 <= x <= 255 值限制的整数)。

运算 | 结果： | 备注
s[i] = x | 将 s 的第 i 项替换为 x |
s[i:j] = t | 将 s 从 i 到 j 的切片替换为可迭代对象 t 的内容 |
del s[i:j] | 等同于 s[i:j] = [] |
s[i:j:k] = t | 将 s[i:j:k] 的元素替换为 t 的元素 | (1)
del s[i:j:k] | 从列表中移除 s[i:j:k] 的元素 |
s.append(x) | 将 x 添加到序列的末尾 (等同于 s[len(s):len(s)] = [x]) |
s.clear() | 从 s 中移除所有项 (等同于 del s[:]) | (5)
s.copy() | 创建 s 的浅拷贝 (等同于 s[:]) | (5)
s.extend(t) 或 s += t | 用 t 的内容扩展 s (基本上等同于 s[len(s):len(s)] = t) |
s *= n | 使用 s 的内容重复 n 次来对其进行更新 | (6)
s.insert(i, x) | 在由 i 给出的索引位置将 x 插入 s (等同于 s[i:i] = [x]) |
s.pop() 或 s.pop(i) | 提取在 i 位置上的项，并将其从 s 中移除 | (2)
s.remove(x) | 删除 s 中第一个 s[i] 等于 x 的项目。 | (3)
s.reverse() | 就地将列表中的元素逆序。 | (4)

注释：

t 必须与它所替换的切片具有相同的长度。

可选参数 i 默认为 -1，因此在默认情况下会移除并返回最后一项。

当在 s 中找不到 x 时 remove() 操作会引发 ValueError。

当反转大尺寸序列时 reverse() 方法会原地修改该序列以保证空间经济性。 为提醒用户此操作是通过间接影响进行的，它并不会返回反转后的序列。

包括 clear() 和 copy() 是为了与不支持切片操作的可变容器 (例如 dict 和 set) 的接口保持一致。 copy() 不是 collections.abc.MutableSequence ABC 的一部分，但大多数具体的可变序列类都提供了它。

3.3 新版功能: clear() 和 copy() 方法。

n 值为一个整数，或是一个实现了 __index__() 的对象。 n 值为零或负数将清空序列。 序列中的项不会被拷贝；它们会被多次引用，正如 通用序列操作 中有关 s * n 的说明。

列表

列表是可变序列，通常用于存放同类项目的集合（其中精确的相似程度将根据应用而变化）。

class list([iterable])

可以用多种方式构建列表：

使用一对方括号来表示空列表: []

使用方括号，其中的项以逗号分隔: [a], [a, b, c]

使用列表推导式: [x for x in iterable]

使用类型的构造器: list() 或 list(iterable)

构造器将构造一个列表，其中的项与 iterable 中的项具有相同的的值与顺序。 iterable 可以是序列、支持迭代的容器或其它可迭代对象。 如果 iterable 已经是一个列表，将创建并返回其副本，类似于 iterable[:]。 例如，list('abc') 返回 ['a', 'b', 'c'] 而 list( (1, 2, 3) ) 返回 [1, 2, 3]。 如果没有给出参数，构造器将创建一个空列表 []。

其它许多操作也会产生列表，包括 sorted() 内置函数。

列表实现了所有 一般 和 可变 序列的操作。 列表还额外提供了以下方法：

sort(*, key=None, reverse=False)

此方法会对列表进行原地排序，只使用 < 来进行各项间比较。 异常不会被屏蔽 —— 如果有任何比较操作失败，整个排序操作将失败（而列表可能会处于被部分修改的状态）。

sort() 接受两个仅限以关键字形式传入的参数 (仅限关键字参数):

key 指定带有一个参数的函数，用于从每个列表元素中提取比较键 (例如 key=str.lower)。 对应于列表中每一项的键会被计算一次，然后在整个排序过程中使用。 默认值 None 表示直接对列表项排序而不计算一个单独的键值。

可以使用 functools.cmp_to_key() 将 2.x 风格的 cmp 函数转换为 key 函数。

reverse 为一个布尔值。 如果设为 True，则每个列表元素将按反向顺序比较进行排序。

当顺序大尺寸序列时此方法会原地修改该序列以保证空间经济性。 为提醒用户此操作是通过间接影响进行的，它并不会返回排序后的序列（请使用 sorted() 显示地请求一个新的已排序列表实例）。

sort() 方法确保是稳定的。 如果一个排序确保不会改变比较结果相等的元素的相对顺序就称其为稳定的 --- 这有利于进行多重排序（例如先按部门、再接薪级排序）。

有关排序示例和简要排序教程，请参阅 排序指南 。

CPython 实现细节： 在一个列表被排序期间，尝试改变甚至进行检测也会造成未定义的影响。 Python 的 C 实现会在排序期间将列表显示为空，如果发现列表在排序期间被改变将会引发 ValueError。

元组

元组是不可变序列，通常用于储存异构数据的多项集（例如由 enumerate() 内置函数所产生的二元组）。 元组也被用于需要同构数据的不可变序列的情况（例如允许存储到 set 或 dict 的实例）。

class tuple([iterable])

可以用多种方式构建元组：

使用一对圆括号来表示空元组: ()

使用一个后缀的逗号来表示单元组: a, 或 (a,)

使用以逗号分隔的多个项: a, b, c or (a, b, c)

使用内置的 tuple(): tuple() 或 tuple(iterable)

构造器将构造一个元组，其中的项与 iterable 中的项具有相同的值与顺序。 iterable 可以是序列、支持迭代的容器或其他可迭代对象。 如果 iterable 已经是一个元组，会不加改变地将其返回。 例如，tuple('abc') 返回 ('a', 'b', 'c') 而 tuple( [1, 2, 3] ) 返回 (1, 2, 3)。 如果没有给出参数，构造器将创建一个空元组 ()。

请注意决定生成元组的其实是逗号而不是圆括号。 圆括号只是可选的，生成空元组或需要避免语法歧义的情况除外。 例如，f(a, b, c) 是在调用函数时附带三个参数，而 f((a, b, c)) 则是在调用函数时附带一个三元组。

元组实现了所有 一般 序列的操作。

对于通过名称访问相比通过索引访问更清晰的异构数据多项集，collections.namedtuple() 可能是比简单元组对象更为合适的选择。

range 对象

range 类型表示不可变的数字序列，通常用于在 for 循环中循环指定的次数。

class range(stop)

class range(start, stop[, step])

range 构造器的参数必须为整数（可以是内置的 int 或任何实现了 __index__() 特殊方法的对象）。 如果省略 step 参数，则默认为 1。 如果省略 start 参数，则默认为 0。 如果 step 为零，则会引发 ValueError。

如果 step 为正值，确定 range r 内容的公式为 r[i] = start + step*i 其中 i >= 0 且 r[i] < stop。

如果 step 为负值，确定 range 内容的公式仍然为 r[i] = start + step*i，但限制条件改为 i >= 0 且 r[i] > stop.

如果 r[0] 不符合值的限制条件，则该 range 对象为空。 range 对象确实支持负索引，但是会将其解读为从正索引所确定的序列的末尾开始索引。

元素绝对值大于 sys.maxsize 的 range 对象是被允许的，但某些特性 (例如 len()) 可能引发 OverflowError。

一些 range 对象的例子:

>>> 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))
[]

range 对象实现了 一般 序列的所有操作，但拼接和重复除外（这是由于 range 对象只能表示符合严格模式的序列，而重复和拼接通常都会违反这样的模式）。

start

start 形参的值 (如果该形参未提供则为 0)

stop

stop 形参的值

step

step 形参的值 (如果该形参未提供则为 1)

range 类型相比常规 list 或 tuple 的优势在于一个 range 对象总是占用固定数量的（较小）内存，不论其所表示的范围有多大（因为它只保存了 start, stop 和 step 值，并会根据需要计算具体单项或子范围的值）。

range 对象实现了 collections.abc.Sequence ABC，提供如包含检测、元素索引查找、切片等特性，并支持负索引 (参见 序列类型 --- list, tuple, range):

>>> 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

使用 == 和 != 检测 range 对象是否相等是将其作为序列来比较。 也就是说，如果两个 range 对象表示相同的值序列就认为它们是相等的。 （请注意比较结果相等的两个 range 对象可能会具有不同的 start, stop 和 step 属性，例如 range(0) == range(2, 1, 3) 而 range(0, 3, 2) == range(0, 4, 2)。）

在 3.2 版更改: 实现 Sequence ABC。 支持切片和负数索引。 使用 int 对象在固定时间内进行成员检测，而不是逐一迭代所有项。

在 3.3 版更改: 定义 '==' 和 '!=' 以根据 range 对象所定义的值序列来进行比较（而不是根据对象的标识）。

3.3 新版功能: start, stop 和 step 属性。

参见

linspace recipe [https://code.activestate.com/recipes/579000/] 演示了如何实现一个延迟求值版本的适合浮点数应用的 range 对象。

文本序列类型 --- str

在 Python 中处理文本数据是使用 str 对象，也称为 字符串。 字符串是由 Unicode 码位构成的不可变 序列。 字符串字面值有多种不同的写法：

单引号: '允许包含有 "双" 引号'

双引号: "允许嵌入 '单' 引号"

三重引号: '''三重单引号''', """三重双引号"""

使用三重引号的字符串可以跨越多行 —— 其中所有的空白字符都将包含在该字符串字面值中。

作为单一表达式组成部分，之间只由空格分隔的多个字符串字面值会被隐式地转换为单个字符串字面值。 也就是说，("spam " "eggs") == "spam eggs"。

请参阅 字符串与字节串字面值 了解有关不同字符串字面值的更多信息，包括所支持的转义序列，以及使用 r ("raw") 前缀来禁用大多数转义序列的处理。

字符串也可以通过使用 str 构造器从其他对象创建。

由于不存在单独的“字符”类型，对字符串做索引操作将产生一个长度为 1 的字符串。 也就是说，对于一个非空字符串 s, s[0] == s[0:1]。

不存在可变的字符串类型，但是 str.join() 或 io.StringIO 可以被被用来根据多个片段高效率地构建字符串。

在 3.3 版更改: 为了与 Python 2 系列的向下兼容，再次允许字符串字面值使用 u 前缀。 它对字符串字面值的含义没有影响，并且不能与 r 前缀同时出现。

class str(object='')

class str(object=b'', encoding='utf-8', errors='strict')

返回 object 的 字符串 版本。 如果未提供 object 则返回空字符串。 在其他情况下 str() 的行为取决于 encoding 或 errors 是否有给出，具体见下。

如果 encoding 或 errors 均未给出，则 str(object) 返回 type(object).__str__(object)，这是 object 的 "非正式" 或格式良好的字符串表示形式。 对于字符串对象，这是该字符串本身。 如果 object 没有 __str__() 方法，则 str() 将回退为返回 repr(object)。

如果 encoding 或 errors 至少给出其中之一，则 object 应该是一个 bytes-like object (例如 bytes 或 bytearray)。 在此情况下，如果 object 是一个 bytes (或 bytearray) 对象，则 str(bytes, encoding, errors) 等价于 bytes.decode(encoding, errors)。 否则的话，会在调用 bytes.decode() 之前获取缓冲区对象下层的 bytes 对象。 请参阅 二进制序列类型 --- bytes, bytearray, memoryview 与 缓冲协议 了解有关缓冲区对象的信息。

将一个 bytes 对象传入 str() 而不给出 encoding 或 errors 参数的操作属于第一种情况， 将返回非正式的字符串表示（另请参阅 Python 的 -b 命令行选项）。 例如:

>>> str(b'Zoot!')
"b'Zoot!'"

有关 str 类及其方法的更多信息，请参阅下面的 文本序列类型 --- str 和 字符串的方法 小节。 要输出格式化字符串，请参阅 格式字符串字面值 和 格式字符串语法 小节。 此外还可以参阅 文本处理服务 小节。

字符串的方法

字符串实现了所有 一般 序列的操作，还额外提供了以下列出的一些附加方法。

字符串还支持两种字符串格式化样式，一种提供了很大程度的灵活性和可定制性 (参阅 str.format(), 格式字符串语法 和 自定义字符串格式化) 而另一种是基于 C printf 样式的格式化，它可处理的类型范围较窄，并且更难以正确使用，但对于它可处理的情况往往会更为快速 (printf 风格的字符串格式化)。

标准库的 文本处理服务 部分涵盖了许多其他模块，提供各种文本相关工具（例如包含于 re 模块中的正则表达式支持）。

str.capitalize()

返回原字符串的副本，其首个字符大写，其余为小写。

在 3.8 版更改: 第一个字符现在被放入了 titlecase 而不是 uppercase。 这意味着复合字母类字符将只有首个字母改为大写，而再不是全部字符大写。

str.casefold()

返回原字符串消除大小写的副本。 消除大小写的字符串可用于忽略大小写的匹配。

消除大小写类似于转为小写，但是更加彻底一些，因为它会移除字符串中的所有大小写变化形式。 例如，德语小写字母 'ß' 相当于 "ss"。 由于它已经是小写了，lower() 不会对 'ß' 做任何改变；而 casefold() 则会将其转换为 "ss"。

消除大小写算法的描述请参见 Unicode 标准的 3.13 节。

3.3 新版功能.

str.center(width[, fillchar])

返回长度为 width 的字符串，原字符串在其正中。 使用指定的 fillchar 填充两边的空位（默认使用 ASCII 空格符）。 如果 width 小于等于 len(s) 则返回原字符串的副本。

str.count(sub[, start[, end]])

返回子字符串 sub 在 [start, end] 范围内非重叠出现的次数。 可选参数 start 与 end 会被解读为切片表示法。

如果 sub 为空，则返回字符之间的空字符串数，即字符串的长度加一。

str.encode(encoding='utf-8', errors='strict')

返回编码为 bytes 的字符串。

encoding 默认为 'utf-8' ；请参阅 标准编码 了解其他可能的值。

errors 控制如何处理编码错误。 如为 'strict' (默认值)，则会引发 UnicodeError。 其他可能的值有 'ignore', 'replace', 'xmlcharrefreplace', 'backslashreplace' 以及通过 codecs.register_error() 注册的任何其他名称。 请参阅 错误处理方案 了解详情。

出于性能原因，除非真正发生了编码错误，启用了 Python 开发模式 或使用了 调试编译版 否则不会检查 errors 值的有效性。

在 3.1 版更改: 加入了对关键字参数的支持。

在 3.9 版更改: 现在会在 Python 开发模式 和 调试模式 下检查 errors 参数的值。

str.endswith(suffix[, start[, end]])

如果字符串以指定的 suffix 结束返回 True，否则返回 False。 suffix 也可以为由多个供查找的后缀构成的元组。 如果有可选项 start，将从所指定位置开始检查。 如果有可选项 end，将在所指定位置停止比较。

str.expandtabs(tabsize=8)

返回字符串的副本，其中所有的制表符会由一个或多个空格替换，具体取决于当前列位置和给定的制表符宽度。 每 tabsize 个字符设为一个制表位（默认值 8 时设定的制表位在列 0, 8, 16 依次类推）。 要展开字符串，当前列将被设为零并逐一检查字符串中的每个字符。 如果字符为制表符 (\t)，则会在结果中插入一个或多个空格符，直到当前列等于下一个制表位。 （制表符本身不会被复制。） 如果字符为换行符 (\n) 或回车符 (\r)，它会被复制并将当前列重设为零。 任何其他字符会被不加修改地复制并将当前列加一，不论该字符在被打印时会如何显示。

>>> '01\t012\t0123\t01234'.expandtabs()
'01      012     0123    01234'
>>> '01\t012\t0123\t01234'.expandtabs(4)
'01  012 0123    01234'

str.find(sub[, start[, end]])

返回子字符串 sub 在 s[start:end] 切片内被找到的最小索引。 可选参数 start 与 end 会被解读为切片表示法。 如果 sub 未被找到则返回 -1。

注解

find() 方法应该只在你需要知道 sub 所在位置时使用。 要检查 sub 是否为子字符串，请使用 in 操作符:

>>> 'Py' in 'Python'
True

str.format(*args, **kwargs)

执行字符串格式化操作。 调用此方法的字符串可以包含字符串字面值或者以花括号 {} 括起来的替换域。 每个替换域可以包含一个位置参数的数字索引，或者一个关键字参数的名称。 返回的字符串副本中每个替换域都会被替换为对应参数的字符串值。

>>> "The sum of 1 + 2 is {0}".format(1+2)
'The sum of 1 + 2 is 3'

请参阅 格式字符串语法 了解有关可以在格式字符串中指定的各种格式选项的说明。

注解

当使用 n 类型 (例如: '{:n}'.format(1234)) 来格式化数字 (int, float, complex, decimal.Decimal 及其子类) 的时候，该函数会临时性地将 LC_CTYPE 区域设置为 LC_NUMERIC 区域以解码 localeconv() 的 decimal_point 和 thousands_sep 字段，如果它们是非 ASCII 字符或长度超过 1 字节的话，并且 LC_NUMERIC 区域会与 LC_CTYPE 区域不一致。 这个临时更改会影响其他线程。

在 3.7 版更改: 当使用 n 类型格式化数字时，该函数在某些情况下会临时性地将 LC_CTYPE 区域设置为 LC_NUMERIC 区域。

str.format_map(mapping)

类似于 str.format(**mapping)，不同之处在于 mapping 会被直接使用而不是复制到一个 dict。 适宜使用此方法的一个例子是当 mapping 为 dict 的子类的情况：

>>> class Default(dict):
...     def __missing__(self, key):
...         return key
...
>>> '{name} was born in {country}'.format_map(Default(name='Guido'))
'Guido was born in country'

3.2 新版功能.

str.index(sub[, start[, end]])

类似于 find()，但在找不到子字符串时会引发 ValueError。

str.isalnum()

如果字符串中的所有字符都是字母或数字且至少有一个字符，则返回 True ， 否则返回 False 。 如果 c.isalpha() ， c.isdecimal() ， c.isdigit() ，或 c.isnumeric() 之中有一个返回 True ，则字符 c 是字母或数字。

str.isalpha()

如果字符串中的所有字符都是字母，并且至少有一个字符，返回 True ，否则返回 False 。字母字符是指那些在 Unicode 字符数据库中定义为 "Letter" 的字符，即那些具有 "Lm"、"Lt"、"Lu"、"Ll" 或 "Lo" 之一的通用类别属性的字符。 注意，这与 Unicode 标准中定义的"字母"属性不同。

str.isascii()

如果字符串为空或字符串中的所有字符都是 ASCII ，返回 True ，否则返回 False 。ASCII 字符的码点范围是 U+0000-U+007F 。

3.7 新版功能.

str.isdecimal()

如果字符串中的所有字符都是十进制字符且该字符串至少有一个字符，则返回 True ， 否则返回 False 。十进制字符指那些可以用来组成10进制数字的字符，例如 U+0660 ，即阿拉伯字母数字0 。 严格地讲，十进制字符是 Unicode 通用类别 "Nd" 中的一个字符。

str.isdigit()

如果字符串中的所有字符都是数字，并且至少有一个字符，返回 True ，否则返回 False 。 数字包括十进制字符和需要特殊处理的数字，如兼容性上标数字。这包括了不能用来组成 10 进制数的数字，如 Kharosthi 数。 严格地讲，数字是指属性值为 Numeric_Type=Digit 或 Numeric_Type=Decimal 的字符。

str.isidentifier()

如果字符串是有效的标识符，返回 True ，依据语言定义， 标识符和关键字 节。

调用 keyword.iskeyword() 来检测字符串 s 是否为保留标识符，例如 def 和 class。

示例：

>>> from keyword import iskeyword

>>> 'hello'.isidentifier(), iskeyword('hello')
(True, False)
>>> 'def'.isidentifier(), iskeyword('def')
(True, True)

str.islower()

如果字符串中至少有一个区分大小写的字符 4 且此类字符均为小写则返回 True ，否则返回 False 。

str.isnumeric()

如果字符串中至少有一个字符且所有字符均为数值字符则返回 True ，否则返回 False 。 数值字符包括数字字符，以及所有在 Unicode 中设置了数值特性属性的字符，例如 U+2155, VULGAR FRACTION ONE FIFTH。 正式的定义为：数值字符就是具有特征属性值 Numeric_Type=Digit, Numeric_Type=Decimal 或 Numeric_Type=Numeric 的字符。

str.isprintable()

如果字符串中所有字符均为可打印字符或字符串为空则返回 True ，否则返回 False 。 不可打印字符是在 Unicode 字符数据库中被定义为 "Other" 或 "Separator" 的字符，例外情况是 ASCII 空格字符 (0x20) 被视作可打印字符。 （请注意在此语境下可打印字符是指当对一个字符串唤起 repr() 时不必被转义的字符。 它们与字符串写入 sys.stdout 或 sys.stderr 时所需的处理无关。）

str.isspace()

如果字符串中只有空白字符且至少有一个字符则返回 True ，否则返回 False 。

空白 字符是指在 Unicode 字符数据库 (参见 unicodedata) 中主要类别为 Zs ("Separator, space") 或所属双向类为 WS, B 或 S 的字符。

str.istitle()

如果字符串中至少有一个字符且为标题字符串则返回 True ，例如大写字符之后只能带非大写字符而小写字符必须有大写字符打头。 否则返回 False 。

str.isupper()

如果字符串中至少有一个区分大小写的字符 4 且此类字符均为大写则返回 True ，否则返回 False 。

>>> 'BANANA'.isupper()
True
>>> 'banana'.isupper()
False
>>> 'baNana'.isupper()
False
>>> ' '.isupper()
False

str.join(iterable)

返回一个由 iterable 中的字符串拼接而成的字符串。 如果 iterable 中存在任何非字符串值包括 bytes 对象则会引发 TypeError。 调用该方法的字符串将作为元素之间的分隔。

str.ljust(width[, fillchar])

返回长度为 width 的字符串，原字符串在其中靠左对齐。 使用指定的 fillchar 填充空位 (默认使用 ASCII 空格符)。 如果 width 小于等于 len(s) 则返回原字符串的副本。

str.lower()

返回原字符串的副本，其所有区分大小写的字符 4 均转换为小写。

所用转换小写算法的描述请参见 Unicode 标准的 3.13 节。

str.lstrip([chars])

返回原字符串的副本，移除其中的前导字符。 chars 参数为指定要移除字符的字符串。 如果省略或为 None，则 chars 参数默认移除空白符。 实际上 chars 参数并非指定单个前缀；而是会移除参数值的所有组合:

>>> '   spacious   '.lstrip()
'spacious   '
>>> 'www.example.com'.lstrip('cmowz.')
'example.com'

参见 str.removeprefix() ，该方法将删除单个前缀字符串，而不是全部给定集合中的字符。 例如:

>>> 'Arthur: three!'.lstrip('Arthur: ')
'ee!'
>>> 'Arthur: three!'.removeprefix('Arthur: ')
'three!'

static str.maketrans(x[, y[, z]])

此静态方法返回一个可供 str.translate() 使用的转换对照表。

如果只有一个参数，则它必须是一个将 Unicode 码位序号（整数）或字符（长度为 1 的字符串）映射到 Unicode 码位序号、（任意长度的）字符串或 None 的字典。 字符键将会被转换为码位序号。

如果有两个参数，则它们必须是两个长度相等的字符串，并且在结果字典中，x 中每个字符将被映射到 y 中相同位置的字符。 如果有第三个参数，它必须是一个字符串，其中的字符将在结果中被映射到 None。

str.partition(sep)

在 sep 首次出现的位置拆分字符串，返回一个 3 元组，其中包含分隔符之前的部分、分隔符本身，以及分隔符之后的部分。 如果分隔符未找到，则返回的 3 元组中包含字符本身以及两个空字符串。

str.removeprefix(prefix, /)

如果字符串以 prefix 字符串开头，返回 string[len(prefix):]。 否则，返回原始字符串的副本：

>>> 'TestHook'.removeprefix('Test')
'Hook'
>>> 'BaseTestCase'.removeprefix('Test')
'BaseTestCase'

3.9 新版功能.

str.removesuffix(suffix, /)

如果字符串以 suffix 字符串结尾，并且 suffix 非空，返回 string[:-len(suffix)]。 否则，返回原始字符串的副本:

>>> 'MiscTests'.removesuffix('Tests')
'Misc'
>>> 'TmpDirMixin'.removesuffix('Tests')
'TmpDirMixin'

3.9 新版功能.

str.replace(old, new[, count])

用 new 替换子字符串 old 的所有出现次数，并返回该字符串的副本。如果给定了可选参数 count，则只替换前 count 次出现的字符串。

str.rfind(sub[, start[, end]])

返回子字符串 sub 在字符串内被找到的最大（最右）索引，这样 sub 将包含在 s[start:end] 当中。 可选参数 start 与 end 会被解读为切片表示法。 如果未找到则返回 -1。

str.rindex(sub[, start[, end]])

类似于 rfind()，但在子字符串 sub 未找到时会引发 ValueError。

str.rjust(width[, fillchar])

返回长度为 width 的字符串，原字符串在其中靠右对齐。 使用指定的 fillchar 填充空位 (默认使用 ASCII 空格符)。 如果 width 小于等于 len(s) 则返回原字符串的副本。

str.rpartition(sep)

在 sep 最后一次出现的位置拆分字符串，返回一个 3 元组，其中包含分隔符之前的部分、分隔符本身，以及分隔符之后的部分。 如果分隔符未找到，则返回的 3 元组中包含两个空字符串以及字符串本身。

str.rsplit(sep=None, maxsplit=- 1)

返回一个由字符串内单词组成的列表，使用 sep 作为分隔字符串。 如果给出了 maxsplit，则最多进行 maxsplit 次拆分，从 最右边 开始。 如果 sep 未指定或为 None，任何空白字符串都会被作为分隔符。 除了从右边开始拆分，rsplit() 的其他行为都类似于下文所述的 split()。

str.rstrip([chars])

返回原字符串的副本，移除其中的末尾字符。 chars 参数为指定要移除字符的字符串。 如果省略或为 None，则 chars 参数默认移除空白符。 实际上 chars 参数并非指定单个后缀；而是会移除参数值的所有组合:

>>> '   spacious   '.rstrip()
'   spacious'
>>> 'mississippi'.rstrip('ipz')
'mississ'

要删除单个后缀字符串，而不是全部给定集合中的字符，请参见 str.removesuffix() 方法。 例如:

>>> 'Monty Python'.rstrip(' Python')
'M'
>>> 'Monty Python'.removesuffix(' Python')
'Monty'

str.split(sep=None, maxsplit=- 1)

返回一个由字符串内单词组成的列表，使用 sep 作为分隔字符串。 如果给出了 maxsplit，则最多进行 maxsplit 次拆分（因此，列表最多会有 maxsplit+1 个元素）。 如果 maxsplit 未指定或为 -1，则不限制拆分次数（进行所有可能的拆分）。

如果给出了 sep，则连续的分隔符不会被组合在一起而是被视为分隔空字符串 (例如 '1,,2'.split(',') 将返回 ['1', '', '2'])。 sep 参数可能由多个字符组成 (例如 '1<>2<>3'.split('<>') 将返回 ['1', '2', '3'])。 使用指定的分隔符拆分空字符串将返回 ['']。

例如：

>>> '1,2,3'.split(',')
['1', '2', '3']
>>> '1,2,3'.split(',', maxsplit=1)
['1', '2,3']
>>> '1,2,,3,'.split(',')
['1', '2', '', '3', '']

如果 sep 未指定或为 None，则会应用另一种拆分算法：连续的空格会被视为单个分隔符，其结果将不包含开头或末尾的空字符串，如果字符串包含前缀或后缀空格的话。 因此，使用 None 拆分空字符串或仅包含空格的字符串将返回 []。

例如：

>>> '1 2 3'.split()
['1', '2', '3']
>>> '1 2 3'.split(maxsplit=1)
['1', '2 3']
>>> '   1   2   3   '.split()
['1', '2', '3']

str.splitlines(keepends=False)

返回由原字符串中各行组成的列表，在行边界的位置拆分。 结果列表中不包含行边界，除非给出了 keepends 且为真值。

此方法会以下列行边界进行拆分。 特别地，行边界是 universal newlines 的一个超集。

表示符 | 描述
\n | 换行
\r | 回车
\r\n | 回车 + 换行
\v 或 \x0b | 行制表符
\f 或 \x0c | 换表单
\x1c | 文件分隔符
\x1d | 组分隔符
\x1e | 记录分隔符
\x85 | 下一行 (C1 控制码)
\u2028 | 行分隔符
\u2029 | 段分隔符

在 3.2 版更改: \v 和 \f 被添加到行边界列表

例如：

>>> 'ab c\n\nde fg\rkl\r\n'.splitlines()
['ab c', '', 'de fg', 'kl']
>>> 'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
['ab c\n', '\n', 'de fg\r', 'kl\r\n']

不同于 split()，当给出了分隔字符串 sep 时，对于空字符串此方法将返回一个空列表，而末尾的换行不会令结果中增加额外的行:

>>> "".splitlines()
[]
>>> "One line\n".splitlines()
['One line']

作为比较，split('\n') 的结果为:

>>> ''.split('\n')
['']
>>> 'Two lines\n'.split('\n')
['Two lines', '']

str.startswith(prefix[, start[, end]])

如果字符串以指定的 prefix 开始则返回 True，否则返回 False。 prefix 也可以为由多个供查找的前缀构成的元组。 如果有可选项 start，将从所指定位置开始检查。 如果有可选项 end，将在所指定位置停止比较。

str.strip([chars])

返回原字符串的副本，移除其中的前导和末尾字符。 chars 参数为指定要移除字符的字符串。 如果省略或为 None，则 chars 参数默认移除空白符。 实际上 chars 参数并非指定单个前缀或后缀；而是会移除参数值的所有组合:

>>> '   spacious   '.strip()
'spacious'
>>> 'www.example.com'.strip('cmowz.')
'example'

最外侧的前导和末尾 chars 参数值将从字符串中移除。 开头端的字符的移除将在遇到一个未包含于 chars 所指定字符集的字符时停止。 类似的操作也将在结尾端发生。 例如:

>>> comment_string = '#....... Section 3.2.1 Issue #32 .......'
>>> comment_string.strip('.#! ')
'Section 3.2.1 Issue #32'

str.swapcase()

返回原字符串的副本，其中大写字符转换为小写，反之亦然。 请注意 s.swapcase().swapcase() == s 并不一定为真值。

str.title()

返回原字符串的标题版本，其中每个单词第一个字母为大写，其余字母为小写。

例如：

>>> 'Hello world'.title()
'Hello World'

该算法使用一种简单的与语言无关的定义，将连续的字母组合视为单词。 该定义在多数情况下都很有效，但它也意味着代表缩写形式与所有格的撇号也会成为单词边界，这可能导致不希望的结果:

>>> "they're bill's friends from the UK".title()
"They'Re Bill'S Friends From The Uk"

string.capwords() 函数没有此问题，因为它只用空格来拆分单词。

作为替代，可以使用正则表达式来构造针对撇号的变通处理:

>>> 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."

str.translate(table)

返回原字符串的副本，其中每个字符按给定的转换表进行映射。 转换表必须是一个使用 __getitem__() 来实现索引操作的对象，通常为 mapping 或 sequence。 当以 Unicode 码位序号（整数）为索引时，转换表对象可以做以下任何一种操作：返回 Unicode 序号或字符串，将字符映射为一个或多个字符；返回 None，将字符从结果字符串中删除；或引发 LookupError 异常，将字符映射为其自身。

你可以使用 str.maketrans() 基于不同格式的字符到字符映射来创建一个转换映射表。

另请参阅 codecs 模块以了解定制字符映射的更灵活方式。

str.upper()

返回原字符串的副本，其中所有区分大小写的字符 4 均转换为大写。 请注意如果 s 包含不区分大小写的字符或者如果结果字符的 Unicode 类别不是 "Lu" (Letter, uppercase) 而是 "Lt" (Letter, titlecase) 则 s.upper().isupper() 有可能为 False。

所用转换大写算法的描述请参见 Unicode 标准的 3.13 节。

str.zfill(width)

返回原字符串的副本，在左边填充 ASCII '0' 数码使其长度变为 width。 正负值前缀 ('+'/'-') 的处理方式是在正负符号 之后 填充而非在之前。 如果 width 小于等于 len(s) 则返回原字符串的副本。

例如：

>>> "42".zfill(5)
'00042'
>>> "-42".zfill(5)
'-0042'

printf 风格的字符串格式化

注解

此处介绍的格式化操作具有多种怪异特性，可能导致许多常见错误（例如无法正确显示元组和字典）。 使用较新的 格式化字符串字面值，str.format() 接口或 模板字符串 有助于避免这样的错误。 这些替代方案中的每一种都更好地权衡并提供了简单、灵活以及可扩展性优势。

字符串对象有一个独特的内置运算: % 运算符 (取模)。 这也被称为字符串 formatting 或 interpolation 运算符。 如果给定 format % values (其中 format 是字符串)，format 中 % 的转换规范将被 values 中的零个或多个元素替换。 其效果类似于在 C 语言中使用 sprintf()。

如果 format 要求一个单独参数，则 values 可以为一个非元组对象。 5 否则的话，values 必须或者是一个包含项数与格式字符串中指定的转换符项数相同的元组，或者是一个单独映射对象（例如字典）。

转换标记符包含两个或更多字符并具有以下组成，且必须遵循此处规定的顺序：

'%' 字符，用于标记转换符的起始。

映射键（可选），由加圆括号的字符序列组成 (例如 (somename))。

转换旗标（可选），用于影响某些转换类型的结果。

最小字段宽度（可选）。 如果指定为 '*' (星号)，则实际宽度会从 values 元组的下一元素中读取，要转换的对象则为最小字段宽度和可选的精度之后的元素。

精度（可选），以在 '.' (点号) 之后加精度值的形式给出。 如果指定为 '*' (星号)，则实际精度会从 values 元组的下一元素中读取，要转换的对象则为精度之后的元素。

长度修饰符（可选）。

转换类型。

当右边的参数为一个字典（或其他映射类型）时，字符串中的格式 必须 包含加圆括号的映射键，对应 '%' 字符之后字典中的每一项。 映射键将从映射中选取要格式化的值。 例如：

>>> print('%(language)s has %(number)03d quote types.' %
...       {'language': "Python", "number": 2})
Python has 002 quote types.

在此情况下格式中不能出现 * 标记符（因其需要一个序列类的参数列表）。

转换旗标为：

标志位 | 含意
'#' | 值的转换将使用“替代形式”（具体定义见下文）。
'0' | 转换将为数字值填充零字符。
'-' | 转换值将靠左对齐（如果同时给出 '0' 转换，则会覆盖后者）。
' ' | (空格) 符号位转换产生的正数（或空字符串）前将留出一个空格。
'+' | 符号字符 ('+' 或 '-') 将显示于转换结果的开头（会覆盖 "空格" 旗标）。

可以给出长度修饰符 (h, l 或 L)，但会被忽略，因为对 Python 来说没有必要 -- 所以 %ld 等价于 %d。

转换类型为：

转换符 | 含意 | 备注
'd' | 有符号十进制整数。 |
'i' | 有符号十进制整数。 |
'o' | 有符号八进制数。 | (1)
'u' | 过时类型 -- 等价于 'd'。 | (6)
'x' | 有符号十六进制数（小写）。 | (2)
'X' | 有符号十六进制数（大写）。 | (2)
'e' | 浮点指数格式（小写）。 | (3)
'E' | 浮点指数格式（大写）。 | (3)
'f' | 浮点十进制格式。 | (3)
'F' | 浮点十进制格式。 | (3)
'g' | 浮点格式。 如果指数小于 -4 或不小于精度则使用小写指数格式，否则使用十进制格式。 | (4)
'G' | 浮点格式。 如果指数小于 -4 或不小于精度则使用大写指数格式，否则使用十进制格式。 | (4)
'c' | 单个字符（接受整数或单个字符的字符串）。 |
'r' | 字符串（使用 repr() 转换任何 Python 对象）。 | (5)
's' | 字符串（使用 str() 转换任何 Python 对象）。 | (5)
'a' | 字符串（使用 ascii() 转换任何 Python 对象）。 | (5)
'%' | 不转换参数，在结果中输出一个 '%' 字符。 |

注释：

此替代形式会在第一个数码之前插入标示八进制数的前缀 ('0o')。

此替代形式会在第一个数码之前插入 '0x' 或 '0X' 前缀（取决于是使用 'x' 还是 'X' 格式）。

此替代形式总是会在结果中包含一个小数点，即使其后并没有数码。

小数点后的数码位数由精度决定，默认为 6。

此替代形式总是会在结果中包含一个小数点，末尾各位的零不会如其他情况下那样被移除。

小数点前后的有效数码位数由精度决定，默认为 6。

如果精度为 N，输出将截短为 N 个字符。

参见 PEP 237 [https://www.python.org/dev/peps/pep-0237]。

由于 Python 字符串显式指明长度，%s 转换不会将 '\0' 视为字符串的结束。

在 3.1 版更改: 绝对值超过 1e50 的 %f 转换不会再被替换为 %g 转换。

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

操作二进制数据的核心内置类型是 bytes 和 bytearray。 它们由 memoryview 提供支持，该对象使用 缓冲区协议 来访问其他二进制对象所在内存，不需要创建对象的副本。

array 模块支持高效地存储基本数据类型，例如 32 位整数和 IEEE754 双精度浮点值。

bytes 对象

bytes 对象是由单个字节构成的不可变序列。 由于许多主要二进制协议都基于 ASCII 文本编码，因此 bytes 对象提供了一些仅在处理 ASCII 兼容数据时可用，并且在许多特性上与字符串对象紧密相关的方法。

class bytes([source[, encoding[, errors]]])

首先，表示 bytes 字面值的语法与字符串字面值的大致相同，只是添加了一个 b 前缀：

单引号: b'同样允许嵌入 "双" 引号'。

双引号: b"仍然允许嵌入 '单' 引号"

三重引号: b'''三重单引号''', b"""三重双引号"""

bytes 字面值中只允许 ASCII 字符（无论源代码声明的编码格式为何）。 任何超出 127 的二进制值必须使用相应的转义序列形式加入 bytes 字面值。

像字符串字面值一样，bytes 字面值也可以使用 r 前缀来禁用转义序列处理。 请参阅 字符串与字节串字面值 了解有关各种 bytes 字面值形式的详情，包括所支持的转义序列。

虽然 bytes 字面值和表示法是基于 ASCII 文本的，但 bytes 对象的行为实际上更像是不可变的整数序列，序列中的每个值的大小被限制为 0 <= x < 256 (如果违反此限制将引发 ValueError)。 这种限制是有意设计用以强调以下事实，虽然许多二进制格式都包含基于 ASCII 的元素，可以通过某些面向文本的算法进行有用的操作，但情况对于任意二进制数据来说通常却并非如此（盲目地将文本处理算法应用于不兼容 ASCII 的二进制数据格式往往将导致数据损坏）。

除了字面值形式，bytes 对象还可以通过其他几种方式来创建：

指定长度的以零值填充的 bytes 对象: bytes(10)

通过由整数组成的可迭代对象: bytes(range(20))

通过缓冲区协议复制现有的二进制数据: bytes(obj)

另请参阅 bytes 内置类型。

由于两个十六进制数码精确对应一个字节，因此十六进制数是描述二进制数据的常用格式。 相应地，bytes 类型具有从此种格式读取数据的附加类方法：

classmethod fromhex(string)

此 bytes 类方法返回一个解码给定字符串的 bytes 对象。 字符串必须由表示每个字节的两个十六进制数码构成，其中的 ASCII 空白符会被忽略。

>>> bytes.fromhex('2Ef0 F1f2  ')
b'.\xf0\xf1\xf2'

在 3.7 版更改: bytes.fromhex() 现在会忽略所有 ASCII 空白符而不只是空格符。

存在一个反向转换函数，可以将 bytes 对象转换为对应的十六进制表示。

hex([sep[, bytes_per_sep]])

返回一个字符串对象，该对象包含实例中每个字节的两个十六进制数字。

>>> b'\xf0\xf1\xf2'.hex()
'f0f1f2'

如果你希望令十六进制数字符串更易读，你可以指定单个字符分隔符作为 sep 形参包含于输出中。 默认情况下，该分隔符会放在每个字节之间。 第二个可选的 bytes_per_sep 形参控制间距。 正值会从右开始计算分隔符的位置，负值则是从左开始。

>>> value = b'\xf0\xf1\xf2'
>>> value.hex('-')
'f0-f1-f2'
>>> value.hex('_', 2)
'f0_f1f2'
>>> b'UUDDLRLRAB'.hex(' ', -4)
'55554444 4c524c52 4142'

3.5 新版功能.

在 3.8 版更改: bytes.hex() 现在支持可选的 sep 和 bytes_per_sep 形参以在十六进制输出的字节之间插入分隔符。

由于 bytes 对象是由整数构成的序列（类似于元组），因此对于一个 bytes 对象 b，b[0] 将为一个整数，而 b[0:1] 将为一个长度为 1 的 bytes 对象。 （这与文本字符串不同，索引和切片所产生的将都是一个长度为 1 的字符串）。

bytes 对象的表示使用字面值格式 (b'...')，因为它通常都要比像 bytes([46, 46, 46]) 这样的格式更好用。 你总是可以使用 list(b) 将 bytes 对象转换为一个由整数构成的列表。

bytearray 对象

bytearray 对象是 bytes 对象的可变对应物。

class bytearray([source[, encoding[, errors]]])

bytearray 对象没有专属的字面值语法，它们总是通过调用构造器来创建：

创建一个空实例: bytearray()

创建一个指定长度的以零值填充的实例: bytearray(10)

通过由整数组成的可迭代对象: bytearray(range(20))

通过缓冲区协议复制现有的二进制数据: bytearray(b'Hi!')

由于 bytearray 对象是可变的，该对象除了 bytes 和 bytearray 操作 中所描述的 bytes 和 bytearray 共有操作之外，还支持 可变 序列操作。

另请参见 bytearray 内置类型。

由于两个十六进制数码精确对应一个字节，因此十六进制数是描述二进制数据的常用格式。 相应地，bytearray 类型具有从此种格式读取数据的附加类方法：

classmethod fromhex(string)

bytearray 类方法返回一个解码给定字符串的 bytearray 对象。 字符串必须由表示每个字节的两个十六进制数码构成，其中的 ASCII 空白符会被忽略。

>>> bytearray.fromhex('2Ef0 F1f2  ')
bytearray(b'.\xf0\xf1\xf2')

在 3.7 版更改: bytearray.fromhex() 现在会忽略所有 ASCII 空白符而不只是空格符。

存在一个反向转换函数，可以将 bytearray 对象转换为对应的十六进制表示。

hex([sep[, bytes_per_sep]])

返回一个字符串对象，该对象包含实例中每个字节的两个十六进制数字。

>>> bytearray(b'\xf0\xf1\xf2').hex()
'f0f1f2'

3.5 新版功能.

在 3.8 版更改: 与 bytes.hex() 相似， bytearray.hex() 现在支持可选的 sep 和 bytes_per_sep 参数以在十六进制输出的字节之间插入分隔符。

由于 bytearray 对象是由整数构成的序列（类似于列表），因此对于一个 bytearray 对象 b，b[0] 将为一个整数，而 b[0:1] 将为一个长度为 1 的 bytearray 对象。 （这与文本字符串不同，索引和切片所产生的将都是一个长度为 1 的字符串）。

bytearray 对象的表示使用 bytes 对象字面值格式 (bytearray(b'...'))，因为它通常都要比 bytearray([46, 46, 46]) 这样的格式更好用。 你总是可以使用 list(b) 将 bytearray 对象转换为一个由整数构成的列表。

bytes 和 bytearray 操作

bytes 和 bytearray 对象都支持 通用 序列操作。 它们不仅能与相同类型的操作数，也能与任何 bytes-like object 进行互操作。 由于这样的灵活性，它们可以在操作中自由地混合而不会导致错误。 但是，操作结果的返回值类型可能取决于操作数的顺序。

注解

bytes 和 bytearray 对象的方法不接受字符串作为其参数，就像字符串的方法不接受 bytes 对象作为其参数一样。 例如，你必须使用以下写法:

a = "abc"
b = a.replace("a", "f")

和:

a = b"abc"
b = a.replace(b"a", b"f")

某些 bytes 和 bytearray 操作假定使用兼容 ASCII 的二进制格式，因此在处理任意二进数数据时应当避免使用。 这些限制会在下文中说明。

注解

使用这些基于 ASCII 的操作来处理未以基于 ASCII 的格式存储的二进制数据可能会导致数据损坏。

bytes 和 bytearray 对象的下列方法可以用于任意二进制数据。

bytes.count(sub[, start[, end]])

bytearray.count(sub[, start[, end]])

返回子序列 sub 在 [start, end] 范围内非重叠出现的次数。 可选参数 start 与 end 会被解读为切片表示法。

要搜索的子序列可以是任意 bytes-like object 或是 0 至 255 范围内的整数。

如果 sub 为空，则返回字符之间的空切片的数量即字节串对象的长度加一。

在 3.3 版更改: 也接受 0 至 255 范围内的整数作为子序列。

bytes.removeprefix(prefix, /)

bytearray.removeprefix(prefix, /)

如果二进制数据以 prefix 字符串开头，返回 bytes[len(prefix):]。 否则，返回原始二进制数据的副本：

>>> b'TestHook'.removeprefix(b'Test')
b'Hook'
>>> b'BaseTestCase'.removeprefix(b'Test')
b'BaseTestCase'

prefix 可以是任意 bytes-like object。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

3.9 新版功能.

bytes.removesuffix(suffix, /)

bytearray.removesuffix(suffix, /)

如果二进制数据以 suffix 字符串结尾，并且 suffix 非空，返回 bytes[:-len(suffix)]。 否则，返回原始二进制数据的副本:

>>> b'MiscTests'.removesuffix(b'Tests')
b'Misc'
>>> b'TmpDirMixin'.removesuffix(b'Tests')
b'TmpDirMixin'

suffix 可以是任意 bytes-like object。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

3.9 新版功能.

bytes.decode(encoding='utf-8', errors='strict')

bytearray.decode(encoding='utf-8', errors='strict')

返回解码为 str 的字节串。

encoding 默认为 'utf-8' ；请参阅 标准编码 了解其他可能的值。

errors 控制如何处理编码错误。 如为 'strict' (默认值)，则会引发 UnicodeError。 其他可能的值有 'ignore', 'replace' 以及通过 codecs.register_error() 注册的任何其他名称。 请参阅 错误处理方案 了解详情。

出于性能原因，除非真正发生了编码错误，启用了 Python 开发模式 或使用了 调试编译版 否则不会检查 errors 值的有效性。

注解

将 encoding 参数传给 str 允许直接解码任何 bytes-like object，无须创建临时的 bytes 或 bytearray 对象。

在 3.1 版更改: 加入了对关键字参数的支持。

在 3.9 版更改: 现在会在 Python 开发模式 和 调试模式 下检查 errors 参数的值。

bytes.endswith(suffix[, start[, end]])

bytearray.endswith(suffix[, start[, end]])

如果二进制数据以指定的 suffix 结束则返回 True，否则返回 False。 suffix 也可以为由多个供查找的后缀构成的元组。 如果有可选项 start，将从所指定位置开始检查。 如果有可选项 end，将在所指定位置停止比较。

要搜索的后缀可以是任意 bytes-like object。

bytes.find(sub[, start[, end]])

bytearray.find(sub[, start[, end]])

返回子序列 sub 在数据中被找到的最小索引，sub 包含于切片 s[start:end] 之内。 可选参数 start 与 end 会被解读为切片表示法。 如果 sub 未被找到则返回 -1。

要搜索的子序列可以是任意 bytes-like object 或是 0 至 255 范围内的整数。

注解

find() 方法应该只在你需要知道 sub 所在位置时使用。 要检查 sub 是否为子串，请使用 in 操作符:

>>> b'Py' in b'Python'
True

在 3.3 版更改: 也接受 0 至 255 范围内的整数作为子序列。

bytes.index(sub[, start[, end]])

bytearray.index(sub[, start[, end]])

类似于 find()，但在找不到子序列时会引发 ValueError。

要搜索的子序列可以是任意 bytes-like object 或是 0 至 255 范围内的整数。

在 3.3 版更改: 也接受 0 至 255 范围内的整数作为子序列。

bytes.join(iterable)

bytearray.join(iterable)

返回一个由 iterable 中的二进制数据序列拼接而成的 bytes 或 bytearray 对象。 如果 iterable 中存在任何非 字节类对象 包括存在 str 对象值则会引发 TypeError。 提供该方法的 bytes 或 bytearray 对象的内容将作为元素之间的分隔。

static bytes.maketrans(from, to)

static bytearray.maketrans(from, to)

此静态方法返回一个可用于 bytes.translate() 的转换对照表，它将把 from 中的每个字符映射为 to 中相同位置上的字符；from 与 to 必须都是 字节类对象 并且具有相同的长度。

3.1 新版功能.

bytes.partition(sep)

bytearray.partition(sep)

在 sep 首次出现的位置拆分序列，返回一个 3 元组，其中包含分隔符之前的部分、分隔符本身或其 bytearray 副本，以及分隔符之后的部分。 如果分隔符未找到，则返回的 3 元组中包含原序列以及两个空的 bytes 或 bytearray 对象。

要搜索的分隔符可以是任意 bytes-like object。

bytes.replace(old, new[, count])

bytearray.replace(old, new[, count])

返回序列的副本，其中出现的所有子序列 old 都将被替换为 new。 如果给出了可选参数 count，则只替换前 count 次出现。

要搜索的子序列及其替换序列可以是任意 bytes-like object。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.rfind(sub[, start[, end]])

bytearray.rfind(sub[, start[, end]])

返回子序列 sub 在序列内被找到的最大（最右）索引，这样 sub 将包含在 s[start:end] 当中。 可选参数 start 与 end 会被解读为切片表示法。 如果未找到则返回 -1。

要搜索的子序列可以是任意 bytes-like object 或是 0 至 255 范围内的整数。

在 3.3 版更改: 也接受 0 至 255 范围内的整数作为子序列。

bytes.rindex(sub[, start[, end]])

bytearray.rindex(sub[, start[, end]])

类似于 rfind()，但在子序列 sub 未找到时会引发 ValueError。

要搜索的子序列可以是任意 bytes-like object 或是 0 至 255 范围内的整数。

在 3.3 版更改: 也接受 0 至 255 范围内的整数作为子序列。

bytes.rpartition(sep)

bytearray.rpartition(sep)

在 sep 最后一次出现的位置拆分序列，返回一个 3 元组，其中包含分隔符之前的部分，分隔符本身或其 bytearray 副本，以及分隔符之后的部分。 如果分隔符未找到，则返回的 3 元组中包含两个空的 bytes 或 bytearray 对象以及原序列的副本。

要搜索的分隔符可以是任意 bytes-like object。

bytes.startswith(prefix[, start[, end]])

bytearray.startswith(prefix[, start[, end]])

如果二进制数据以指定的 prefix 开头则返回 True，否则返回 False。 prefix 也可以为由多个供查找的前缀构成的元组。 如果有可选项 start，将从所指定位置开始检查。 如果有可选项 end，将在所指定位置停止比较。

要搜索的前缀可以是任意 bytes-like object。

bytes.translate(table, /, delete=b'')

bytearray.translate(table, /, delete=b'')

返回原 bytes 或 bytearray 对象的副本，移除其中所有在可选参数 delete 中出现的 bytes，其余 bytes 将通过给定的转换表进行映射，该转换表必须是长度为 256 的 bytes 对象。

你可以使用 bytes.maketrans() 方法来创建转换表。

对于仅需移除字符的转换，请将 table 参数设为 None:

>>> b'read this short text'.translate(None, b'aeiou')
b'rd ths shrt txt'

在 3.6 版更改: 现在支持将 delete 作为关键字参数。

以下 bytes 和 bytearray 对象的方法的默认行为会假定使用兼容 ASCII 的二进制格式，但通过传入适当的参数仍然可用于任意二进制数据。 请注意本小节中所有的 bytearray 方法都 不是 原地执行操作，而是会产生新的对象。

bytes.center(width[, fillbyte])

bytearray.center(width[, fillbyte])

返回原对象的副本，在长度为 width 的序列内居中，使用指定的 fillbyte 填充两边的空位（默认使用 ASCII 空格符）。 对于 bytes 对象，如果 width 小于等于 len(s) 则返回原序列的副本。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.ljust(width[, fillbyte])

bytearray.ljust(width[, fillbyte])

返回原对象的副本，在长度为 width 的序列中靠左对齐。 使用指定的 fillbyte 填充空位（默认使用 ASCII 空格符）。 对于 bytes 对象，如果 width 小于等于 len(s) 则返回原序列的副本。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.lstrip([chars])

bytearray.lstrip([chars])

返回原序列的副本，移除指定的前导字节。 chars 参数为指定要移除字节值集合的二进制序列 —— 这个名称表明此方法通常是用于 ASCII 字符。 如果省略或为 None，则 chars 参数默认移除 ASCII 空白符。 chars 参数并非指定单个前缀；而是会移除参数值的所有组合:

>>> b'   spacious   '.lstrip()
b'spacious   '
>>> b'www.example.com'.lstrip(b'cmowz.')
b'example.com'

要移除的二进制序列可以是任意 bytes-like object 。 要删除单个前缀字符串，而不是全部给定集合中的字符，请参见 str.removeprefix() 方法。 例如:

>>> b'Arthur: three!'.lstrip(b'Arthur: ')
b'ee!'
>>> b'Arthur: three!'.removeprefix(b'Arthur: ')
b'three!'

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.rjust(width[, fillbyte])

bytearray.rjust(width[, fillbyte])

返回原对象的副本，在长度为 width 的序列中靠右对齐。 使用指定的 fillbyte 填充空位（默认使用 ASCII 空格符）。 对于 bytes 对象，如果 width 小于等于 len(s) 则返回原序列的副本。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.rsplit(sep=None, maxsplit=- 1)

bytearray.rsplit(sep=None, maxsplit=- 1)

将二进制序列拆分为相同类型的子序列，使用 sep 作为分隔符。 如果给出了 maxsplit，则最多进行 maxsplit 次拆分，从 最右边 开始。 如果 sep 未指定或为 None，任何只包含 ASCII 空白符的子序列都会被作为分隔符。 除了从右边开始拆分，rsplit() 的其他行为都类似于下文所述的 split()。

bytes.rstrip([chars])

bytearray.rstrip([chars])

返回原序列的副本，移除指定的末尾字节。 chars 参数为指定要移除字节值集合的二进制序列 —— 这个名称表明此方法通常是用于 ASCII 字符。 如果省略或为 None，则 chars 参数默认移除 ASCII 空白符。 chars 参数并非指定单个后缀；而是会移除参数值的所有组合:

>>> b'   spacious   '.rstrip()
b'   spacious'
>>> b'mississippi'.rstrip(b'ipz')
b'mississ'

要移除的二进制序列可以是任意 bytes-like object 。 要删除单个后缀字符串，而不是全部给定集合中的字符，请参见 str.removesuffix() 方法。 例如:

>>> b'Monty Python'.rstrip(b' Python')
b'M'
>>> b'Monty Python'.removesuffix(b' Python')
b'Monty'

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.split(sep=None, maxsplit=- 1)

bytearray.split(sep=None, maxsplit=- 1)

将二进制序列拆分为相同类型的子序列，使用 sep 作为分隔符。 如果给出了 maxsplit 且非负值，则最多进行 maxsplit 次拆分（因此，列表最多会有 maxsplit+1 个元素）。 如果 maxsplit 未指定或为 -1，则不限制拆分次数（进行所有可能的拆分）。

如果给出了 sep，则连续的分隔符不会被组合在一起而是被视为分隔空子序列 (例如 b'1,,2'.split(b',') 将返回 [b'1', b'', b'2'])。 sep 参数可能为一个多字节序列 (例如 b'1<>2<>3'.split(b'<>') 将返回 [b'1', b'2', b'3'])。 使用指定的分隔符拆分空序列将返回 [b''] 或 [bytearray(b'')]，具体取决于被拆分对象的类型。 sep 参数可以是任意 bytes-like object。

例如：

>>> 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'', b'3', b'']

如果 sep 未指定或为 None，则会应用另一种拆分算法：连续的 ASCII 空白符会被视为单个分隔符，其结果将不包含序列开头或末尾的空白符。 因此，在不指定分隔符的情况下对空序列或仅包含 ASCII 空白符的序列进行拆分将返回 []。

例如：

>>> 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']

bytes.strip([chars])

bytearray.strip([chars])

返回原序列的副本，移除指定的开头和末尾字节。 chars 参数为指定要移除字节值集合的二进制序列 —— 这个名称表明此方法通常是用于 ASCII 字符。 如果省略或为 None，则 chars 参数默认移除 ASCII 空白符。 chars 参数并非指定单个前缀或后缀；而是会移除参数值的所有组合:

>>> b'   spacious   '.strip()
b'spacious'
>>> b'www.example.com'.strip(b'cmowz.')
b'example'

要移除的字节值二进制序列可以是任意 bytes-like object。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

以下 bytes 和 bytearray 对象的方法会假定使用兼容 ASCII 的二进制格式，不应当被应用于任意二进制数据。 请注意本小节中所有的 bytearray 方法都 不是 原地执行操作，而是会产生新的对象。

bytes.capitalize()

bytearray.capitalize()

返回原序列的副本，其中每个字节将都将被解读为一个 ASCII 字符，并且第一个字节的字符大写而其余的小写。 非 ASCII 字节值将保持原样不变。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.expandtabs(tabsize=8)

bytearray.expandtabs(tabsize=8)

返回序列的副本，其中所有的 ASCII 制表符会由一个或多个 ASCII 空格替换，具体取决于当前列位置和给定的制表符宽度。 每 tabsize 个字节设为一个制表位（默认值 8 时设定的制表位在列 0, 8, 16 依次类推）。 要展开序列，当前列位置将被设为零并逐一检查序列中的每个字节。 如果字节为 ASCII 制表符 (b'\t')，则并在结果中插入一个或多个空格符，直到当前列等于下一个制表位。 （制表符本身不会被复制。） 如果当前字节为 ASCII 换行符 (b'\n') 或回车符 (b'\r')，它会被复制并将当前列重设为零。 任何其他字节会被不加修改地复制并将当前列加一，不论该字节值在被打印时会如何显示:

>>> b'01\t012\t0123\t01234'.expandtabs()
b'01      012     0123    01234'
>>> b'01\t012\t0123\t01234'.expandtabs(4)
b'01  012 0123    01234'

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.isalnum()

bytearray.isalnum()

如果序列中所有字节都是字母类 ASCII 字符或 ASCII 十进制数码并且序列非空则返回 True ，否则返回 False 。 字母类 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。 ASCII 十进制数码就是字节值包含在序列 b'0123456789' 中的字符。

例如：

>>> b'ABCabc1'.isalnum()
True
>>> b'ABC abc1'.isalnum()
False

bytes.isalpha()

bytearray.isalpha()

如果序列中所有字节都是字母类 ASCII 字符并且序列不非空则返回 True ，否则返回 False 。 字母类 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。

例如：

>>> b'ABCabc'.isalpha()
True
>>> b'ABCabc1'.isalpha()
False

bytes.isascii()

bytearray.isascii()

如果序列为空或序列中所有字节都是 ASCII 字节则返回 True ，否则返回 False 。 ASCII 字节的取值范围是 0-0x7F。

3.7 新版功能.

bytes.isdigit()

bytearray.isdigit()

如果序列中所有字节都是 ASCII 十进制数码并且序列非空则返回 True ，否则返回 False 。 ASCII 十进制数码就是字节值包含在序列 b'0123456789' 中的字符。

例如：

>>> b'1234'.isdigit()
True
>>> b'1.23'.isdigit()
False

bytes.islower()

bytearray.islower()

如果序列中至少有一个小写的 ASCII 字符并且没有大写的 ASCII 字符则返回 True ，否则返回 False 。

例如：

>>> b'hello world'.islower()
True
>>> b'Hello world'.islower()
False

小写 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyz' 中的字符。 大写 ASCII 字符就是字节值包含在序列 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。

bytes.isspace()

bytearray.isspace()

如果序列中所有字节都是 ASCII 空白符并且序列非空则返回 True ，否则返回 False 。 ASCII 空白符就是字节值包含在序列 b' \t\n\r\x0b\f' (空格, 制表, 换行, 回车, 垂直制表, 进纸) 中的字符。

bytes.istitle()

bytearray.istitle()

如果序列为 ASCII 标题大小写形式并且序列非空则返回 True ，否则返回 False 。 请参阅 bytes.title() 了解有关“标题大小写”的详细定义。

例如：

>>> b'Hello World'.istitle()
True
>>> b'Hello world'.istitle()
False

bytes.isupper()

bytearray.isupper()

如果序列中至少有一个大写字母 ASCII 字符并且没有小写 ASCII 字符则返回 True ，否则返回 False 。

例如：

>>> b'HELLO WORLD'.isupper()
True
>>> b'Hello world'.isupper()
False

小写 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyz' 中的字符。 大写 ASCII 字符就是字节值包含在序列 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。

bytes.lower()

bytearray.lower()

返回原序列的副本，其所有大写 ASCII 字符均转换为对应的小写形式。

例如：

>>> b'Hello World'.lower()
b'hello world'

小写 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyz' 中的字符。 大写 ASCII 字符就是字节值包含在序列 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.splitlines(keepends=False)

bytearray.splitlines(keepends=False)

返回由原二进制序列中各行组成的列表，在 ASCII 行边界符的位置拆分。 此方法使用 universal newlines 方式来分行。 结果列表中不包含换行符，除非给出了 keepends 且为真值。

例如：

>>> b'ab c\n\nde fg\rkl\r\n'.splitlines()
[b'ab c', b'', 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']

不同于 split()，当给出了分隔符 sep 时，对于空字符串此方法将返回一个空列表，而末尾的换行不会令结果中增加额外的行:

>>> b"".split(b'\n'), b"Two lines\n".split(b'\n')
([b''], [b'Two lines', b''])
>>> b"".splitlines(), b"One line\n".splitlines()
([], [b'One line'])

bytes.swapcase()

bytearray.swapcase()

返回原序列的副本，其所有小写 ASCII 字符均转换为对应的大写形式，反之亦反。

例如：

>>> b'Hello World'.swapcase()
b'hELLO wORLD'

小写 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyz' 中的字符。 大写 ASCII 字符就是字节值包含在序列 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。

不同于 str.swapcase()，在些二进制版本下 bin.swapcase().swapcase() == bin 总是成立。 大小写转换在 ASCII 中是对称的，即使其对于任意 Unicode 码位来说并不总是成立。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.title()

bytearray.title()

返回原二进制序列的标题版本，其中每个单词以一个大写 ASCII 字符为开头，其余字母为小写。 不区别大小写的字节值将保持原样不变。

例如：

>>> b'Hello world'.title()
b'Hello World'

小写 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyz' 中的字符。 大写 ASCII 字符就是字节值包含在序列 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。 所有其他字节值都不区分大小写。

该算法使用一种简单的与语言无关的定义，将连续的字母组合视为单词。 该定义在多数情况下都很有效，但它也意味着代表缩写形式与所有格的撇号也会成为单词边界，这可能导致不希望的结果:

>>> b"they're bill's friends from the UK".title()
b"They'Re Bill'S Friends From The Uk"

可以使用正则表达式来构建针对撇号的特别处理:

>>> 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."

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.upper()

bytearray.upper()

返回原序列的副本，其所有小写 ASCII 字符均转换为对应的大写形式。

例如：

>>> b'Hello World'.upper()
b'HELLO WORLD'

小写 ASCII 字符就是字节值包含在序列 b'abcdefghijklmnopqrstuvwxyz' 中的字符。 大写 ASCII 字符就是字节值包含在序列 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 中的字符。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

bytes.zfill(width)

bytearray.zfill(width)

返回原序列的副本，在左边填充 b'0' 数码使序列长度为 width。 正负值前缀 (b'+'/ b'-') 的处理方式是在正负符号 之后 填充而非在之前。 对于 bytes 对象，如果 width 小于等于 len(seq) 则返回原序列。

例如：

>>> b"42".zfill(5)
b'00042'
>>> b"-42".zfill(5)
b'-0042'

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

printf 风格的字节串格式化

注解

此处介绍的格式化操作具有多种怪异特性，可能导致许多常见错误（例如无法正确显示元组和字典）。 如果要打印的值可能为元组或字典，请将其放入一个元组中。

字节串对象 (bytes/bytearray) 具有一种特殊的内置操作：使用 % (取模) 运算符。 这也被称为字节串的 格式化 或 插值 运算符。 对于 format % values (其中 format 为一个字节串对象)，在 format 中的 % 转换标记符将被替换为零个或多个 values 条目。 其效果类似于在 C 语言中使用 sprintf()。

如果 format 要求一个单独参数，则 values 可以为一个非元组对象。 5 否则的话，values 必须或是是一个包含项数与格式字节串对象中指定的转换符项数相同的元组，或者是一个单独的映射对象（例如元组）。

转换标记符包含两个或更多字符并具有以下组成，且必须遵循此处规定的顺序：

'%' 字符，用于标记转换符的起始。

映射键（可选），由加圆括号的字符序列组成 (例如 (somename))。

转换旗标（可选），用于影响某些转换类型的结果。

最小字段宽度（可选）。 如果指定为 '*' (星号)，则实际宽度会从 values 元组的下一元素中读取，要转换的对象则为最小字段宽度和可选的精度之后的元素。

精度（可选），以在 '.' (点号) 之后加精度值的形式给出。 如果指定为 '*' (星号)，则实际精度会从 values 元组的下一元素中读取，要转换的对象则为精度之后的元素。

长度修饰符（可选）。

转换类型。

当右边的参数为一个字典（或其他映射类型）时，字节串对象中的格式 必须 包含加圆括号的映射键，对应 '%' 字符之后字典中的每一项。 映射键将从映射中选取要格式化的值。 例如：

>>> print(b'%(language)s has %(number)03d quote types.' %
...       {b'language': b"Python", b"number": 2})
b'Python has 002 quote types.'

在此情况下格式中不能出现 * 标记符（因其需要一个序列类的参数列表）。

转换旗标为：

标志位 | 含意
'#' | 值的转换将使用“替代形式”（具体定义见下文）。
'0' | 转换将为数字值填充零字符。
'-' | 转换值将靠左对齐（如果同时给出 '0' 转换，则会覆盖后者）。
' ' | (空格) 符号位转换产生的正数（或空字符串）前将留出一个空格。
'+' | 符号字符 ('+' 或 '-') 将显示于转换结果的开头（会覆盖 "空格" 旗标）。

可以给出长度修饰符 (h, l 或 L)，但会被忽略，因为对 Python 来说没有必要 -- 所以 %ld 等价于 %d。

转换类型为：

转换符 | 含意 | 备注
'd' | 有符号十进制整数。 |
'i' | 有符号十进制整数。 |
'o' | 有符号八进制数。 | (1)
'u' | 过时类型 -- 等价于 'd'。 | (8)
'x' | 有符号十六进制数（小写）。 | (2)
'X' | 有符号十六进制数（大写）。 | (2)
'e' | 浮点指数格式（小写）。 | (3)
'E' | 浮点指数格式（大写）。 | (3)
'f' | 浮点十进制格式。 | (3)
'F' | 浮点十进制格式。 | (3)
'g' | 浮点格式。 如果指数小于 -4 或不小于精度则使用小写指数格式，否则使用十进制格式。 | (4)
'G' | 浮点格式。 如果指数小于 -4 或不小于精度则使用大写指数格式，否则使用十进制格式。 | (4)
'c' | 单个字节（接受整数或单个字节对象）。 |
'b' | 字节串（任何遵循 缓冲区协议 或是具有 __bytes__() 的对象）。 | (5)
's' | 's' 是 'b' 的一个别名，只应当在基于 Python2/3 的代码中使用。 | (6)
'a' | 字节串（使用 repr(obj).encode('ascii', 'backslashreplace') 来转换任意 Python 对象）。 | (5)
'r' | 'r' 是 'a' 的一个别名，只应当在基于 Python2/3 的代码中使用。 | (7)
'%' | 不转换参数，在结果中输出一个 '%' 字符。 |

注释：

此替代形式会在第一个数码之前插入标示八进制数的前缀 ('0o')。

此替代形式会在第一个数码之前插入 '0x' 或 '0X' 前缀（取决于是使用 'x' 还是 'X' 格式）。

此替代形式总是会在结果中包含一个小数点，即使其后并没有数码。

小数点后的数码位数由精度决定，默认为 6。

此替代形式总是会在结果中包含一个小数点，末尾各位的零不会如其他情况下那样被移除。

小数点前后的有效数码位数由精度决定，默认为 6。

如果精度为 N，输出将截短为 N 个字符。

b'%s' 已弃用，但在 3.x 系列中将不会被移除。

b'%r' 已弃用，但在 3.x 系列中将不会被移除。

参见 PEP 237 [https://www.python.org/dev/peps/pep-0237]。

注解

此方法的 bytearray 版本 并非 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。

参见

PEP 461 [https://www.python.org/dev/peps/pep-0461] - 为 bytes 和 bytearray 添加 % 格式化

3.5 新版功能.

内存视图

memoryview 对象允许 Python 代码访问一个对象的内部数据，只要该对象支持 缓冲区协议 而无需进行拷贝。

class memoryview(object)

创建一个引用 object 的 memoryview 。 object 必须支持缓冲区协议。支持缓冲区协议的内置对象有 bytes 和 bytearray 。

memoryview 有 元素 的概念， 元素 指由原始 object 处理的原子内存单元。对于许多简单的类型，如 bytes 和 bytearray ，一个元素是一个字节，但其他类型，如 array.array 可能有更大的元素。

len(view) 与 tolist 的长度相等。 如果 view.ndim = 0，则其长度为 1。 如果 view.ndim = 1，则其长度等于 view 中元素的数量。 对于更高的维度，其长度等于表示 view 的嵌套列表的长度。 itemsize 属性可向你给出单个元素所占的字节数。

memoryview 支持通过切片和索引访问其元素。 一维切片的结果将是一个子视图:

>>> v = memoryview(b'abcefg')
>>> v[1]
98
>>> v[-1]
103
>>> v[1:4]
<memory at 0x7f3ddc9f4350>
>>> bytes(v[1:4])
b'bce'

如果 format 是一个来自于 struct 模块的原生格式说明符，则也支持使用整数或由整数构成的元组进行索引，并返回具有正确类型的单个 元素。 一维内存视图可以使用一个整数或由一个整数构成的元组进行索引。 多维内存视图可以使用由恰好 ndim 个整数构成的元素进行索引，ndim 即其维度。 零维内存视图可以使用空元组进行索引。

这里是一个使用非字节格式的例子:

>>> import array
>>> a = array.array('l', [-11111111, 22222222, -33333333, 44444444])
>>> m = memoryview(a)
>>> m[0]
-11111111
>>> m[-1]
44444444
>>> m[::2].tolist()
[-11111111, -33333333]

如果下层对象是可写的，则内存视图支持一维切片赋值。 改变大小则不被允许:

>>> 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')

格式符为 'B', 'b' 或 'c' 的 hashable (只读) 类型的一维内存视图也是可哈希对象。 哈希被定义为 hash(m) == hash(m.tobytes()):

>>> 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

在 3.3 版更改: 一维内存视图现在可以被切片。 格式符为 'B', 'b' 或 'c' 的一维内存视图现在是 hashable。

在 3.4 版更改: 内存视图现在会自动注册为 collections.abc.Sequence

在 3.5 版更改: 内存视图现在可使用整数元组进行索引。

memoryview 具有以下一些方法：

__eq__(exporter)

memoryview 与 PEP 3118 [https://www.python.org/dev/peps/pep-3118] 中的导出器这两者如果形状相同，并且如果当使用 struct 语法解读操作数的相应格式代码时所有对应值都相同，则它们就是等价的。

对于 tolist() 当前所支持的 struct 格式字符串子集，如果 v.tolist() == w.tolist() 则 v 和 w 相等:

>>> 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

如果两边的格式字符串都不被 struct 模块所支持，则两对象比较结果总是不相等（即使格式字符串和缓冲区内容相同）:

>>> 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

请注意，与浮点数的情况一样，对于内存视图对象来说，v is w 也 并不 意味着 v == w。

在 3.3 版更改: 之前的版本比较原始内存时会忽略条目的格式与逻辑数组结构。

tobytes(order=None)

将缓冲区中的数据作为字节串返回。 这相当于在内存视图上调用 bytes 构造器。

>>> m = memoryview(b"abc")
>>> m.tobytes()
b'abc'
>>> bytes(m)
b'abc'

对于非连续数组，结果等于平面化表示的列表，其中所有元素都转换为字节串。 tobytes() 支持所有格式字符串，不符合 struct 模块语法的那些也包括在内。

3.8 新版功能: order 可以为 {'C', 'F', 'A'}。 当 order 为 'C' 或 'F' 时，原始数组的数据会被转换至 C 或 Fortran 顺序。 对于连续视图，'A' 会返回物理内存的精确副本。 特别地，内存中的 Fortran 顺序会被保留。对于非连续视图，数据会先被转换为 C 形式。 order=None 与 order='C' 是相同的。

hex([sep[, bytes_per_sep]])

返回一个字符串对象，其中分别以两个十六进制数码表示缓冲区里的每个字节。

>>> m = memoryview(b"abc")
>>> m.hex()
'616263'

3.5 新版功能.

在 3.8 版更改: 与 bytes.hex() 相似， memoryview.hex() 现在支持可选的 sep 和 bytes_per_sep 参数以在十六进制输出的字节之间插入分隔符。

tolist()

将缓冲区内的数据以一个元素列表的形式返回。

>>> 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]

在 3.3 版更改: tolist() 现在支持 struct 模块语法中的所有单字符原生格式以及多维表示形式。

toreadonly()

返回 memoryview 对象的只读版本。 原始的 memoryview 对象不会被改变。

>>> m = memoryview(bytearray(b'abc'))
>>> mm = m.toreadonly()
>>> mm.tolist()
[89, 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]

3.8 新版功能.

release()

释放由内存视图对象所公开的底层缓冲区。 许多对象在被视图所获取时都会采取特殊动作（例如，bytearray 将会暂时禁止调整大小）；因此，调用 release() 可以方便地尽早去除这些限制（并释放任何多余的资源）。

在此方法被调用后，任何对视图的进一步操作将引发 ValueError (release() 本身除外，它可以被多次调用):

>>> 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

使用 with 语句，可以通过上下文管理协议达到类似的效果:

>>> 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

3.2 新版功能.

cast(format[, shape])

将内存视图转化为新的格式或形状。 shape 默认为 [byte_length//new_itemsize]，这意味着结果视图将是一维的。 返回值是一个新的内存视图，但缓冲区本身不会被复制。 支持的转化有 1D -> C-contiguous 和 C-contiguous -> 1D。

目标格式仅限于 struct 语法中的单一元素原生格式。 其中一种格式必须为字节格式 ('B', 'b' 或 'c')。 结果的字节长度必须与原始长度相同。

将 1D/long 转换为 1D/unsigned bytes:

>>> 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

将 1D/unsigned bytes 转换为 1D/char:

>>> b = bytearray(b'zyz')
>>> x = memoryview(b)
>>> x[0] = b'a'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: memoryview: invalid value for format "B"
>>> y = x.cast('c')
>>> y[0] = b'a'
>>> b
bytearray(b'ayz')

将 1D/bytes 转换为 3D/ints 再转换为 1D/signed char:

>>> 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

将 1D/unsigned long 转换为 2D/unsigned long:

>>> 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]]

3.3 新版功能.

在 3.5 版更改: 当转换为字节视图时，源格式将不再受限。

还存在一些可用的只读属性：

obj

内存视图的下层对象:

>>> b  = bytearray(b'xyz')
>>> m = memoryview(b)
>>> m.obj is b
True

3.3 新版功能.

nbytes

nbytes == product(shape) * itemsize == len(m.tobytes())。 这是数组在连续表示时将会占用的空间总字节数。 它不一定等于 len(m):

>>> 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

多维数组:

>>> 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

3.3 新版功能.

readonly

一个表明内存是否只读的布尔值。

format

一个字符串，包含视图中每个元素的格式（表示为 struct 模块样式）。 内存视图可以从具有任意格式字符串的导出器创建，但某些方法 (例如 tolist()) 仅限于原生的单元素格式。

在 3.3 版更改: 格式 'B' 现在会按照 struct 模块语法来处理。 这意味着 memoryview(b'abc')[0] == b'abc'[0] == 97。

itemsize

memoryview 中每个元素以字节表示的大小:

>>> import array, struct
>>> m = memoryview(array.array('H', [32000, 32001, 32002]))
>>> m.itemsize
2
>>> m[0]
32000
>>> struct.calcsize('H') == m.itemsize
True

ndim

一个整数，表示内存所代表的多维数组具有多少个维度。

shape

一个整数元组，通过 ndim 的长度值给出内存所代表的 N 维数组的形状。

在 3.3 版更改: 当 ndim = 0 时值为空元组而不再为 None。

strides

一个整数元组，通过 ndim 的长度给出以字节表示的大小，以便访问数组中每个维度上的每个元素。

在 3.3 版更改: 当 ndim = 0 时值为空元组而不再为 None。

suboffsets

供 PIL 风格的数组内部使用。 该值仅作为参考信息。

c_contiguous

一个表明内存是否为 C-contiguous 的布尔值。

3.3 新版功能.

f_contiguous

一个表明内存是否为 Fortran contiguous 的布尔值。

3.3 新版功能.

contiguous

一个表明内存是否为 contiguous 的布尔值。

3.3 新版功能.

集合类型 --- set, frozenset

set 对象是由具有唯一性的 hashable 对象所组成的无序多项集。 常见的用途包括成员检测、从序列中去除重复项以及数学中的集合类计算，例如交集、并集、差集与对称差集等等。 （关于其他容器对象请参看 dict, list 与 tuple 等内置类，以及 collections 模块。）

与其他多项集一样，集合也支持 x in set, len(set) 和 for x in set。 作为一种无序的多项集，集合并不记录元素位置或插入顺序。 相应地，集合不支持索引、切片或其他序列类的操作。

目前有两种内置集合类型，set 和 frozenset。 set 类型是可变的 --- 其内容可以使用 add() 和 remove() 这样的方法来改变。 由于是可变类型，它没有哈希值，且不能被用作字典的键或其他集合的元素。 frozenset 类型是不可变并且为 hashable --- 其内容在被创建后不能再改变；因此它可以被用作字典的键或其他集合的元素。

除了可以使用 set 构造器，非空的 set (不是 frozenset) 还可以通过将以逗号分隔的元素列表包含于花括号之内来创建，例如: {'jack', 'sjoerd'}。

两个类的构造器具有相同的作用方式：

class set([iterable])

class frozenset([iterable])

返回一个新的 set 或 frozenset 对象，其元素来自于 iterable。 集合的元素必须为 hashable。 要表示由集合对象构成的集合，所有的内层集合必须为 frozenset 对象。 如果未指定 iterable，则将返回一个新的空集合。

集合可用多种方式来创建:

使用花括号内以逗号分隔元素的方式: {'jack', 'sjoerd'}

使用集合推导式: {c for c in 'abracadabra' if c not in 'abc'}

使用类型构造器: set(), set('foobar'), set(['a', 'b', 'foo'])

set 和 frozenset 的实例提供以下操作：

len(s)

返回集合 s 中的元素数量（即 s 的基数）。

x in s

检测 x 是否为 s 中的成员。

x not in s

检测 x 是否非 s 中的成员。

isdisjoint(other)

如果集合中没有与 other 共有的元素则返回 True。 当且仅当两个集合的交集为空集合时，两者为不相交集合。

issubset(other)

set <= other

检测是否集合中的每个元素都在 other 之中。

set < other

检测集合是否为 other 的真子集，即 set <= other and set != other。

issuperset(other)

set >= other

检测是否 other 中的每个元素都在集合之中。

set > other

检测集合是否为 other 的真超集，即 set >= other and set != other。

union(*others)

set | other | ...

返回一个新集合，其中包含来自原集合以及 others 指定的所有集合中的元素。

intersection(*others)

set & other & ...

返回一个新集合，其中包含原集合以及 others 指定的所有集合中共有的元素。

difference(*others)

set - other - ...

返回一个新集合，其中包含原集合中在 others 指定的其他集合中不存在的元素。

symmetric_difference(other)

set ^ other

返回一个新集合，其中的元素或属于原集合或属于 other 指定的其他集合，但不能同时属于两者。

copy()

返回原集合的浅拷贝。

注意， union() 、 intersection() 、 difference() 、 symmetric_difference() 、 issubset() 和 issuperset() 方法的非运算符版本可以接受任何可迭代对象作为一个参数。相比之下，基于运算符的对应方法则要求参数为集合对象。这就避开了像 set('abc') & 'cbs' 这样容易出错的结构，而换成了可读性更好的 set('abc').intersection('cbs')。

set 和 frozenset 均支持集合与集合的比较。 两个集合当且仅当每个集合中的每个元素均包含于另一个集合之内（即各为对方的子集）时则相等。 一个集合当且仅当其为另一个集合的真子集（即为后者的子集但两者不相等）时则小于另一个集合。 一个集合当且仅当其为另一个集合的真超集（即为后者的超集但两者不相等）时则大于另一个集合。

set 的实例与 frozenset 的实例之间基于它们的成员进行比较。 例如 set('abc') == frozenset('abc') 返回 True，set('abc') in set([frozenset('abc')]) 也一样。

子集与相等比较并不能推广为完全排序函数。 例如，任意两个非空且不相交的集合不相等且互不为对方的子集，因此以下 所有 比较均返回 False: a<b, a==b, or a>b。

由于集合仅定义了部分排序（子集关系），因此由集合构成的列表 list.sort() 方法的输出并无定义。

集合的元素，与字典的键类似，必须为 hashable。

混合了 set 实例与 frozenset 的二进制位运算将返回与第一个操作数相同的类型。例如: frozenset('ab') | set('bc') 将返回 frozenset 的实例。

下表列出了可用于 set 而不能用于不可变的 frozenset 实例的操作：

update(*others)

set |= other | ...

更新集合，添加来自 others 中的所有元素。

intersection_update(*others)

set &= other & ...

更新集合，只保留其中在所有 others 中也存在的元素。

difference_update(*others)

set -= other | ...

更新集合，移除其中也存在于 others 中的元素。

symmetric_difference_update(other)

set ^= other

更新集合，只保留存在于集合的一方而非共同存在的元素。

add(elem)

将元素 elem 添加到集合中。

remove(elem)

从集合中移除元素 elem。 如果 elem 不存在于集合中则会引发 KeyError。

discard(elem)

如果元素 elem 存在于集合中则将其移除。

pop()

从集合中移除并返回任意一个元素。 如果集合为空则会引发 KeyError。

clear()

从集合中移除所有元素。

请注意，非运算符版本的 update(), intersection_update(), difference_update() 和 symmetric_difference_update() 方法将接受任意可迭代对象作为参数。

请注意，__contains__(), remove() 和 discard() 方法的 elem 参数可能是一个 set。 为支持对一个等价的 frozenset 进行搜索，会根据 elem 临时创建一个该类型对象。

映射类型 --- dict

mapping 对象会将 hashable 值映射到任意对象。 映射属于可变对象。 目前仅有一种标准映射类型 字典。 （关于其他容器对象请参看 list, set 与 tuple 等内置类，以及 collections 模块。）

字典的键 几乎 可以为任何值。 不是 hashable 的值，即包含列表、字典或其他可变类型（按值比较而非按对象标识比较）的值不可被用作键。 比较结果相等的值（如 1, 1.0 和 True 等）可被互换使用以索引同一个字典条目。

class dict(**kwargs)

class dict(mapping, **kwargs)

class dict(iterable, **kwargs)

返回一个新的字典，基于可选的位置参数和可能为空的关键字参数集来初始化。

字典可用多种方式来创建:

使用花括号内以逗号分隔 键: 值 对的方式: {'jack': 4098, 'sjoerd': 4127} or {4098: 'jack', 4127: 'sjoerd'}

使用字典推导式: {}, {x: x ** 2 for x in range(10)}

使用类型构造器: dict(), dict([('foo', 100), ('bar', 200)]), dict(foo=100, bar=200)

如果没有给出位置参数，将创建一个空字典。 如果给出一个位置参数并且其属于映射对象，将创建一个具有与映射对象相同键值对的字典。 否则的话，位置参数必须为一个 iterable 对象。 该可迭代对象中的每一项本身必须为一个刚好包含两个元素的可迭代对象。 每一项中的第一个对象将成为新字典的一个键，第二个对象将成为其对应的值。 如果一个键出现一次以上，该键的最后一个值将成为其在新字典中对应的值。

如果给出了关键字参数，则关键字参数及其值会被加入到基于位置参数创建的字典。 如果要加入的键已存在，来自关键字参数的值将替代来自位置参数的值。

作为演示，以下示例返回的字典均等于 {"one": 1, "two": 2, "three": 3}:

>>> 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

像第一个例子那样提供关键字参数的方式只能使用有效的 Python 标识符作为键。 其他方式则可使用任何有效的键。

这些是字典所支持的操作（因而自定义的映射类型也应当支持）：

list(d)

返回字典 d 中使用的所有键的列表。

len(d)

返回字典 d 中的项数。

d[key]

返回 d 中以 key 为键的项。 如果映射中不存在 key 则会引发 KeyError。

如果字典的子类定义了方法 __missing__() 并且 key 不存在，则 d[key] 操作将调用该方法并附带键 key 作为参数。 d[key] 随后将返回或引发 __missing__(key) 调用所返回或引发的任何对象或异常。 没有其他操作或方法会唤起 __missing__()。 如果未定义 __missing__()，则会引发 KeyError。 __missing__() 必须是一个方法；它不能是一个实例变量:

>>> class Counter(dict):
...     def __missing__(self, key):
...         return 0
>>> c = Counter()
>>> c['red']
0
>>> c['red'] += 1
>>> c['red']
1

上面的例子显示了 collections.Counter 实现的部分代码。 还有另一个不同的 __missing__ 方法是由 collections.defaultdict 所使用的。

d[key] = value

将 d[key] 设为 value。

del d[key]

将 d[key] 从 d 中移除。 如果映射中不存在 key 则会引发 KeyError。

key in d

如果 d 中存在键 key 则返回 True，否则返回 False。

key not in d

等价于 not key in d。

iter(d)

返回以字典的键为元素的迭代器。 这是 iter(d.keys()) 的快捷方式。

clear()

移除字典中的所有元素。

copy()

返回原字典的浅拷贝。

classmethod fromkeys(iterable[, value])

使用来自 iterable 的键创建一个新字典，并将键值设为 value。

fromkeys() 是一个返回新字典的类方法。 value 默认为 None。 所有值都只引用一个单独的实例，因此让 value 成为一个可变对象例如空列表通常是没有意义的。 要获取不同的值，请改用 字典推导式。

get(key[, default])

如果 key 存在于字典中则返回 key 的值，否则返回 default。 如果 default 未给出则默认为 None，因而此方法绝不会引发 KeyError。

items()

返回由字典项 ((键, 值) 对) 组成的一个新视图。 参见 视图对象文档。

keys()

返回由字典键组成的一个新视图。 参见 视图对象文档。

pop(key[, default])

如果 key 存在于字典中则将其移除并返回其值，否则返回 default。 如果 default 未给出且 key 不存在于字典中，则会引发 KeyError。

popitem()

从字典中移除并返回一个 (键, 值) 对。 键值对会按 LIFO 的顺序被返回。

popitem() 适用于对字典进行消耗性的迭代，这在集合算法中经常被使用。 如果字典为空，调用 popitem() 将引发 KeyError。

在 3.7 版更改: 现在会确保采用 LIFO 顺序。 在之前的版本中，popitem() 会返回一个任意的键/值对。

reversed(d)

返回一个逆序获取字典键的迭代器。 这是 reversed(d.keys()) 的快捷方式。

3.8 新版功能.

setdefault(key[, default])

如果字典存在键 key ，返回它的值。如果不存在，插入值为 default 的键 key ，并返回 default 。 default 默认为 None。

update([other])

使用来自 other 的键/值对更新字典，覆盖原有的键。 返回 None。

update() 接受另一个字典对象，或者一个包含键/值对（以长度为二的元组或其他可迭代对象表示）的可迭代对象。 如果给出了关键字参数，则会以其所指定的键/值对更新字典: d.update(red=1, blue=2)。

values()

返回由字典值组成的一个新视图。 参见 视图对象文档。

两个 dict.values() 视图之间的相等性比较将总是返回 False。 这在 dict.values() 与其自身比较时也同样适用:

>>> d = {'a': 1}
>>> d.values() == d.values()
False

d | other

合并 d 和 other 中的键和值来创建一个新的字典，两者必须都是字典。当 d 和 other 有相同键时， other 的值优先。

3.9 新版功能.

d |= other

用 other 的键和值更新字典 d ，other 可以是 mapping 或 iterable 的键值对。当 d 和 other 有相同键时， other 的值优先。

3.9 新版功能.

两个字典的比较当且仅当它们具有相同的 (键, 值) 对时才会相等（不考虑顺序）。 排序比较 ('<', '<=', '>=', '>') 会引发 TypeError。

字典会保留插入时的顺序。 请注意对键的更新不会影响顺序。 删除并再次添加的键将被插入到末尾。

>>> 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}

在 3.7 版更改: 字典顺序会确保为插入顺序。 此行为是自 3.6 版开始的 CPython 实现细节。

字典和字典视图都是可逆的。

>>> 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)]

在 3.8 版更改: 字典现在是可逆的。

参见

types.MappingProxyType 可被用来创建一个 dict 的只读视图。

字典视图对象

由 dict.keys(), dict.values() 和 dict.items() 所返回的对象是 视图对象。 该对象提供字典条目的一个动态视图，这意味着当字典改变时，视图也会相应改变。

字典视图可以被迭代以产生与其对应的数据，并支持成员检测：

len(dictview)

返回字典中的条目数。

iter(dictview)

返回字典中的键、值或项（以 (键, 值) 为元素的元组表示）的迭代器。

键和值是按插入时的顺序进行迭代的。 这样就允许使用 zip() 来创建 (值, 键) 对: pairs = zip(d.values(), d.keys())。 另一个创建相同列表的方式是 pairs = [(v, k) for (k, v) in d.items()].

在添加或删除字典中的条目期间对视图进行迭代可能引发 RuntimeError 或者无法完全迭代所有条目。

在 3.7 版更改: 字典顺序会确保为插入顺序。

x in dictview

如果 x 是对应字典中存在的键、值或项（在最后一种情况下 x 应为一个 (键, 值) 元组） 则返回 True。

reversed(dictview)

返回一个逆序获取字典键、值或项的迭代器。 视图将按与插入时相反的顺序进行迭代。

在 3.8 版更改: 字典视图现在是可逆的。

dictview.mapping

返回 types.MappingProxyType 对象，封装了字典视图指向的原始字典。

3.10 新版功能.

Keys views are set-like since their entries are unique and hashable. If all values are hashable, so that (key, value) pairs are unique and hashable, then the items view is also set-like. (Values views are not treated as set-like since the entries are generally not unique.) For set-like views, all of the operations defined for the abstract base class collections.abc.Set are available (for example, ==, <, or ^).

一个使用字典视图的示例:

>>> dishes = {'eggs': 2, 'sausage': 1, 'bacon': 1, 'spam': 500}
>>> keys = dishes.keys()
>>> values = dishes.values()

>>> # iteration
>>> n = 0
>>> for val in values:
...     n += val
>>> print(n)
504

>>> # keys and values are iterated over in the same order (insertion order)
>>> list(keys)
['eggs', 'sausage', 'bacon', 'spam']
>>> list(values)
[2, 1, 1, 500]

>>> # view objects are dynamic and reflect dict changes
>>> del dishes['eggs']
>>> del dishes['sausage']
>>> list(keys)
['bacon', 'spam']

>>> # set operations
>>> keys & {'eggs', 'bacon', 'salad'}
{'bacon'}
>>> keys ^ {'sausage', 'juice'}
{'juice', 'sausage', 'bacon', 'spam'}

>>> # get back a read-only proxy for the original dictionary
>>> values.mapping
mappingproxy({'bacon': 1, 'spam': 500})
>>> values.mapping['spam']
500

上下文管理器类型

Python 的 with 语句支持通过上下文管理器所定义的运行时上下文这一概念。 此对象的实现使用了一对专门方法，允许用户自定义类来定义运行时上下文，在语句体被执行前进入该上下文，并在语句执行完毕时退出该上下文：

contextmanager.__enter__()

进入运行时上下文并返回此对象或关联到该运行时上下文的其他对象。 此方法的返回值会绑定到使用此上下文管理器的 with 语句的 as 子句中的标识符。

一个返回其自身的上下文管理器的例子是 file object。 文件对象会从 __enter__() 返回其自身，以允许 open() 被用作 with 语句中的上下文表达式。

一个返回关联对象的上下文管理器的例子是 decimal.localcontext() 所返回的对象。 此种管理器会将活动的 decimal 上下文设为原始 decimal 上下文的一个副本并返回该副本。 这允许对 with 语句的语句体中的当前 decimal 上下文进行更改，而不会影响 with 语句以外的代码。

contextmanager.__exit__(exc_type, exc_val, exc_tb)

退出运行时上下文并返回一个布尔值旗标来表明所发生的任何异常是否应当被屏蔽。 如果在执行 with 语句的语句体期间发生了异常，则参数会包含异常的类型、值以及回溯信息。 在其他情况下三个参数均为 None。

自此方法返回一个真值将导致 with 语句屏蔽异常并继续执行紧随在 with 语句之后的语句。 否则异常将在此方法结束执行后继续传播。 在此方法执行期间发生的异常将会取代 with 语句的语句体中发生的任何异常。

传入的异常绝对不应当被显式地重新引发 —— 相反地，此方法应当返回一个假值以表明方法已成功完成并且不希望屏蔽被引发的异常。 这允许上下文管理代码方便地检测 __exit__() 方法是否确实已失败。

Python 定义了一些上下文管理器来支持简易的线程同步、文件或其他对象的快速关闭，以及更方便地操作活动的十进制算术上下文。 除了实现上下文管理协议以外，不同类型不会被特殊处理。 请参阅 contextlib 模块查看相关的示例。

Python 的 generator 和 contextlib.contextmanager 装饰器提供了实现这些协议的便捷方式。 如果使用 contextlib.contextmanager 装饰器来装饰一个生成器函数，它将返回一个实现了必要的 __enter__() 和 __exit__() 方法的上下文管理器，而不再是由未经装饰的生成器所产生的迭代器。

请注意，Python/C API 中 Python 对象的类型结构中并没有针对这些方法的专门槽位。 想要定义这些方法的扩展类型必须将它们作为普通的 Python 可访问方法来提供。 与设置运行时上下文的开销相比，单个类字典查找的开销可以忽略不计。

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

type annotations 的内置类型为 Generic Alias 和 Union。

GenericAlias 类型

GenericAlias 对象通常是通过 抽取 一个类来创建的。 它们最常被用于 容器类，如 list 或 dict。 举例来说，list[int] 这个 GenericAlias 对象是通过附带 int 参数抽取 list 类来创建的。 GenericAlias 对象的主要目的是用于 类型标注。

注解

通常一个类只有在实现了特殊方法 __class_getitem__() 时才支持抽取操作。

GenericAlias 对象可作为 generic type 的代理，实现了 形参化泛型。

对于一个容器类，提供给类的 抽取 操作的参数可以指明对象所包含的元素类型。 例如，set[bytes] 可在类型标注中用来表示一个 set 中的所有元素均为 bytes 类型。

对于一个定义了 __class_getitem__() 但不属于容器的类，提供给类的抽取操作的参数往往会指明在对象上定义的一个或多个方法的返回值类型。 例如，正则表达式 可以被用在 str 数据类型和 bytes 数据类型上:

如果 x = re.search('foo', 'foo')，则 x 将为一个 re.Match 对象而 x.group(0) 和 x[0] 的返回值将均为 str 类型。 我们可以在类型标注中使用 GenericAlias re.Match[str] 来代表这种对象。

如果 y = re.search(b'bar', b'bar')，(注意 b 表示 bytes)，则 y 也将为一个 re.Match 的实例，但 y.group(0) 和 y[0] 的返回值将均为 bytes 类型。 在类型标注中，我们将使用 re.Match[bytes] 来代表这种形式的 re.Match 对象。

GenericAlias 对象是 types.GenericAlias 类的实例，该类也可被用来直接创建 GenericAlias 对象。

T[X, Y, ...]

创建一个代表由类型 X, Y 来参数化的类型 T 的 GenericAlias，此类型会更依赖于所使用的 T。 例如，一个接受包含 float 元素的 list 的函数:

def average(values: list[float]) -> float:
    return sum(values) / len(values)

另一个例子是关于 mapping 对象的，用到了 dict，泛型的两个类型参数分别代表了键类型和值类型。本例中的函数需要一个 dict，其键的类型为 str，值的类型为 int:。

def send_post_request(url: str, body: dict[str, int]) -> None:
    ...

内置函数 isinstance() 和 issubclass() 不接受第二个参数为 GenericAlias 类型：

>>> 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

Python 运行时不会强制执行 类型标注。 这种行为扩展到了泛型及其类型形参。 当由 GenericAlias 创建容器对象时，并不会检查容器中为元素指定的类型。 例如，以下代码虽然不被鼓励，但运行时并不会报错:

>>> t = list[str]
>>> t([1, 2, 3])
[1, 2, 3]

不仅如此，在创建对象的过程中，应用了参数后的泛型还会抹除类型参数：

>>> t = list[str]
>>> type(t)
<class 'types.GenericAlias'>

>>> l = t()
>>> type(l)
<class 'list'>

在泛型上调用 repr() 或 str() 会显示应用参数之后的类型：

>>> repr(list[int])
'list[int]'

>>> str(list[int])
'list[int]'

调用泛型容器的 __getitem__() 方法将引发异常以防出现 dict[str][str] 之类的错误:

>>> dict[str][str]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: There are no type variables left in dict[str]

不过，当使用了 类型变量 时这种表达式是无效的。 索引必须有与 GenericAlias 对象的 __args__ 中的类型变量条目数量相当的元素。

>>> from typing import TypeVar
>>> Y = TypeVar('Y')
>>> dict[str, Y][int]
dict[str, int]

标准泛型类

下列标准库类支持形参化的泛型。 此列表并不是详尽无遗的。

tuple

list

dict

set

frozenset

type

collections.deque

collections.defaultdict

collections.OrderedDict

collections.Counter

collections.ChainMap

collections.abc.Awaitable

collections.abc.Coroutine

collections.abc.AsyncIterable

collections.abc.AsyncIterable

collections.abc.AsyncGenerator

collections.abc.Iterable

collections.abc.Iterator

collections.abc.Generator

collections.abc.Reversible

collections.abc.Container

collections.abc.Collection

collections.abc.Callable

collections.abc.Set

collections.abc.MutableSet

collections.abc.Mapping

collections.abc.MutableMapping

collections.abc.Sequence

collections.abc.MutableSequence

collections.abc.ByteString

collections.abc.MappingView

collections.abc.KeysView

collections.abc.ItemsView

collections.abc.ValuesView

contextlib.AbstractContextManager

contextlib.AbstractAsyncContextManager

dataclasses.Field

functools.cached_property

functools.partialmethod

os.PathLike

queue.LifoQueue

queue.Queue

queue.PriorityQueue

queue.SimpleQueue

re.Pattern

re.Match

shelve.BsdDbShelf

shelve.DbfilenameShelf

shelve.Shelf

types.MappingProxyType

weakref.WeakKeyDictionary

weakref.WeakMethod

weakref.WeakSet

weakref.WeakValueDictionary

GenericAlias 对象的特殊属性

应用参数后的泛型都实现了一些特殊的只读属性：

genericalias.__origin__

本属性指向未应用参数之前的泛型类：

>>> list[int].__origin__
<class 'list'>

genericalias.__args__

该属性是传给泛型类的原始 __class_getitem__() 的泛型所组成的 tuple (长度可能为 1):

>>> dict[str, list[int]].__args__
(<class 'str'>, list[int])

genericalias.__parameters__

该属性是延迟计算出来的一个元组（可能为空），包含了 __args__ 中的类型变量。

>>> from typing import TypeVar

>>> T = TypeVar('T')
>>> list[T].__parameters__
(~T,)

注解

带有参数 typing.ParamSpec 的 GenericAlias 对象，在类型替换后其 __parameters__ 可能会不准确，因为 typing.ParamSpec 主要用于静态类型检查。

参见

PEP 484 [https://www.python.org/dev/peps/pep-0484] —— 类型注解

介绍 Python 中用于类型标注的框架。

PEP 585 [https://www.python.org/dev/peps/pep-0585] - 标准多项集中的类型提示泛型

介绍了对标准库类进行原生形参化的能力，只要它们实现了特殊的类方法 __class_getitem__()。

泛型（Generic）, 用户自定义泛型 和 typing.Generic

有关如何实现可在运行时被形参化并能被静态类型检查器所识别的泛用类的文档。

3.9 新版功能.

union 类型

联合对象包含了在多个 类型对象 上执行 | (按位或) 运算后的值。 这些类型主要用于 类型标注。与 typing.Union 相比，联合类型表达式可以实现更简洁的类型提示语法。

X | Y | ...

定义包含了 X、Y 等类型的 union 对象。 X | Y 表示 X 或 Y。相当于 typing.Union[X, Y] 。比如以下函数的参数应为类型 int 或 float ：

def square(number: int | float) -> int | float:
    return number ** 2

union_object == other

union 对象可与其他 union 对象进行比较。详细结果如下：

多次组合的结果会平推：

(int | str) | float == int | str | float

冗余的类型会被删除：

int | str | int == int | str

在相互比较时，会忽略顺序：

int | str == str | int

与 typing.union 兼容：

int | str == typing.Union[int, str]

Optional 类型可表示为与 None 的组合。

str | None == typing.Optional[str]

isinstance(obj, union_object)

issubclass(obj, union_object)

isinstance() 和 issubclass() 也支持 union 对象：

>>> isinstance("", int | str)
True

但不能使用包含 parameterized generics 的 union 对象：

>>> isinstance(1, int | list[int])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: isinstance() argument 2 cannot contain a parameterized generic

union 对象构成的用户类型可以经由 types.UnionType 访问，并可用于 isinstance() 检查。 而不能由类型直接实例化为对象：

>>> import types
>>> isinstance(int | str, types.UnionType)
True
>>> types.UnionType()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot create 'types.UnionType' instances

注解

为了支持 X | Y 语法，类型对象加入了 __or__() 方法。若是元类已实现了 __or__()，union 也可以覆盖掉：

>>> class M(type):
...     def __or__(self, other):
...         return "Hello"
...
>>> class C(metaclass=M):
...     pass
...
>>> C | int
'Hello'
>>> int | C
int | __main__.C

参见

PEP 604 [https://www.python.org/dev/peps/pep-0604] —— 提出了 X | Y 语法和 union 类型。

3.10 新版功能.

其他内置类型

解释器支持一些其他种类的对象。 这些对象大都仅支持一两种操作。

模块

模块唯一的特殊操作是属性访问: m.name，这里 m 为一个模块而 name 访问定义在 m 的符号表中的一个名称。 模块属性可以被赋值。 （请注意 import 语句严格来说也是对模块对象的一种操作；import foo 不要求存在一个名为 foo 的模块对象，而是要求存在一个对于名为 foo 的模块的 (永久性) 定义。）

每个模块都有一个特殊属性 __dict__。 这是包含模块的符号表的字典。 修改此字典将实际改变模块的符号表，但是无法直接对 __dict__ 赋值 (你可以写 m.__dict__['a'] = 1，这会将 m.a 定义为 1，但是你不能写 m.__dict__ = {})。 不建议直接修改 __dict__。

内置于解释器中的模块会写成这样: <module 'sys' (built-in)>。 如果是从一个文件加载，则会写成 <module 'os' from '/usr/local/lib/pythonX.Y/os.pyc'>。

类与类实例

关于这些类型请参阅 对象、值与类型 和 类定义。

函数

函数对象是通过函数定义创建的。 对函数对象的唯一操作是调用它: func(argument-list)。

实际上存在两种不同的函数对象：内置函数和用户自定义函数。 两者支持同样的操作（调用函数），但实现方式不同，因此对象类型也不同。

更多信息请参阅 函数定义。

方法

方法是使用属性表示法来调用的函数。 存在两种形式：内置方法（例如列表的 append() 方法）和类实例方法。 内置方法由支持它们的类型来描述。

如果你通过一个实例来访问方法（即定义在类命名空间内的函数），你会得到一个特殊对象: 绑定方法 (或称 实例方法) 对象。 当被调用时，它会将 self 参数添加到参数列表。 绑定方法具有两个特殊的只读属性: m.__self__ 操作该方法的对象，而 m.__func__ 是实现该方法的函数。 调用 m(arg-1, arg-2, ..., arg-n) 完全等价于调用 m.__func__(m.__self__, arg-1, arg-2, ..., arg-n)。

与函数对象类似，绑定方法对象也支持获取任意属性。 但是，由于方法属性实际上保存于下层的函数对象中 (meth.__func__)，因此不允许设置绑定方法的方法属性。 尝试设置方法的属性将会导致引发 AttributeError。 想要设置方法属性，你必须在下层的函数对象中显式地对其进行设置:

>>> 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'

更多信息请参阅 标准类型层级结构。

代码对象

代码对象被具体实现用来表示“伪编译”的可执行 Python 代码，例如一个函数体。 它们不同于函数对象，因为它们不包含对其全局执行环境的引用。 代码对象由内置的 compile() 函数返回，并可通过从函数对象的 __code__ 属性从中提取。 另请参阅 code 模块。

访问 __code__ 会触发 审计事件 object.__getattr__，参数为 obj 和 "__code__"。

可以通过将代码对象（而非源码字符串）传给 exec() 或 eval() 内置函数来执行或求值。

更多信息请参阅 标准类型层级结构。

类型对象

类型对象表示各种对象类型。 对象的类型可通过内置函数 type() 来获取。 类型没有特殊的操作。 标准库模块 types 定义了所有标准内置类型的名称。

类型以这样的写法来表示: <class 'int'>。

空对象

此对象会由不显式地返回值的函数所返回。 它不支持任何特殊的操作。 空对象只有一种值 None (这是个内置名称)。 type(None)() 会生成同一个单例。

该对象的写法为 None。

省略符对象

此对象常被用于切片 (参见 切片)。 它不支持任何特殊的操作。 省略符对象只有一种值 Ellipsis (这是个内置名称)。 type(Ellipsis)() 会生成 Ellipsis 单例。

该对象的写法为 Ellipsis 或 ...。

未实现对象

此对象会被作为比较和二元运算被应用于它们所不支持的类型时的返回值。 请参阅 比较运算 了解更多信息。 未实现对象只有一种值 NotImplemented。 type(NotImplemented)() 会生成这个单例。

该对象的写法为 NotImplemented。

布尔值

布尔值是两个常量对象 False 和 True。 它们被用来表示逻辑上的真假（不过其他值也可被当作真值或假值）。 在数字类的上下文中（例如被用作算术运算符的参数时），它们的行为分别类似于整数 0 和 1。 内置函数 bool() 可被用来将任意值转换为布尔值，只要该值可被解析为一个逻辑值（参见之前的 逻辑值检测 部分）。

该对象的写法分别为 False 和 True。

内部对象

有关此对象的信息请参阅 标准类型层级结构。 其中描述了栈帧对象、回溯对象以及切片对象等等。

特殊属性

语言实现为部分对象类型添加了一些特殊的只读属性，它们具有各自的作用。 其中一些并不会被 dir() 内置函数所列出。

object.__dict__

一个字典或其他类型的映射对象，用于存储对象的（可写）属性。

instance.__class__

类实例所属的类。

class.__bases__

由类对象的基类所组成的元组。

definition.__name__

类、函数、方法、描述器或生成器实例的名称。

definition.__qualname__

类、函数、方法、描述器或生成器实例的 qualified name。

3.3 新版功能.

class.__mro__

此属性是由类组成的元组，在方法解析期间会基于它来查找基类。

class.mro()

此方法可被一个元类来重载，以为其实例定制方法解析顺序。 它会在类实例化时被调用，其结果存储于 __mro__ 之中。

class.__subclasses__()

每个类都存有对直接子类的弱引用列表。本方法返回所有存活引用的列表。列表的顺序按照子类定义的排列。例如：

>>> int.__subclasses__()
[<class 'bool'>]

整数字符串转换长度限制

CPython 对于 int 和 str 之间的转换有一个全局限制以缓解拒绝服务攻击。 此限制 仅会 作用于十进制或其他以非二的乘方为基数的数字。 十六进制、八进制和二进制转换不受限制。 该限制可以被配置。

int 类型在 CPython 中是存储为二进制形式的任意长度的数字（通常称为“大数字”）。 不存在可在线性时间内将一个字符串转换为二进制整数或将一个二进制整数转换为字符串的算法，除非 基数为 2 的乘方。 对于基数为 10 来说已知最好的算法也有亚二次方复杂度。 转换一个大数值如 int('1' * 500_000) 在快速的 CPU 上也会花费一秒以上的时间。

限制转换大小提供了一个避免 CVE-2020-10735 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735] 的可行方法。

此限制会在可能涉及非线性转换算法时作用于输入或输出字符串中的数字型字符数量。 下划线和正负号不计入限制数量。

当一个操作会超出限制时，将引发 ValueError:

>>> import sys
>>> sys.set_int_max_str_digits(4300)  # Illustrative, this is the default.
>>> _ = int('2' * 5432)
Traceback (most recent call last):
...
ValueError: Exceeds the limit (4300) 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) for integer string conversion: value has 8599 digits; 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  # Hexadecimal is unlimited.

默认限制为 4300 位即 sys.int_info.default_max_str_digits 的值。 最低限制可被配置为 640 位即 sys.int_info.str_digits_check_threshold。

验证:

>>> 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')
...

3.10.7 新版功能.

受影响的 API

此限制仅会作用于 int 和 str 和 bytes 之间存在速度变慢可能的转换:

int(string) 默认以 10 为基数。

int(string, base) 用于所有不为 2 的乘方的基数。

str(integer)。

repr(integer)。

任何其他目标是以 10 为基数的字符串转换，例如 f"{integer}", "{}".format(integer) 或 b"%d" % integer。

此限制不会作用于使用线性算法的函数:

int(string, base) 中 base 可以为 2, 4, 8, 16 或 32。

int.from_bytes() 和 int.to_bytes()。

hex(), oct(), bin()。

格式规格迷你语言 用于十六进制、八进制和二进制数。

str 至 float。

str 至 decimal.Decimal。

配置限制值

在 Python 启动之前你可以使用环境变量或解释器命令行旗标来配置限制值:

PYTHONINTMAXSTRDIGITS，例如 PYTHONINTMAXSTRDIGITS=640 python3 是将限制设为 640 而 PYTHONINTMAXSTRDIGITS=0 python3 是禁用此限制。

-X int_max_str_digits，例如 python3 -X int_max_str_digits=640

sys.flags.int_max_str_digits 包含 PYTHONINTMAXSTRDIGITS 或 -X int_max_str_digits 的值。 如果环境变量和 -X 选项均有设置，则 -X 选项优先。 值为 -1 表示两者均未设置，因此会在初始化时使用 sys.int_info.default_max_str_digits 的值。

从代码中，你可以检查当前的限制并使用这些 sys API 来设置新值:

sys.get_int_max_str_digits() 和 sys.set_int_max_str_digits() 是解释器级限制的读取器和设置器。 子解释器具有它们自己的限制。

Information about the default and minimum can be found in sys.int_info:

sys.int_info.default_max_str_digits 是已编译的默认限制。

sys.int_info.str_digits_check_threshold 是该限制可接受的最低值（禁用该限制的 0 除外）。

3.10.7 新版功能.

警告

设置较低的限制值 可能 导致问题。 虽然不常见，但还是会有在其源代码中包含超出最小阈值的十进制整数常量的代码存在。 设置此限制的一个后果将是包含比此限制长的十进制整数字面值的 Python 源代码将在解析期间遇到错误，通常是在启动时或导入时甚至是在安装时 —— 只要对于某个代码还不存在已更新的 .pyc 就会发生。 一种在包含此类大数值常量的源代码中绕过该问题的办法是将它们转换为不受限制的 0x 十六进制形式。

如果你使用了较低的限制则请要彻底地测试你的应用程序。 确保你的测试通过环境变量或旗标尽早设置该限制来运行以便在启动期间甚至是在可能唤起 Python 来将 .py 源文件预编译为 .pyc 文件的任何安装步骤其间应用该限制。

推荐配置

The default sys.int_info.default_max_str_digits is expected to be reasonable for most applications. If your application requires a different limit, set it from your main entry point using Python version agnostic code as these APIs were added in security patch releases in versions before 3.11.

示例:

>>> 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)

如果你需要完全禁用它，请将其设为 0。

备注

1

有关这些特殊方法的额外信息可参看 Python 参考指南 (基本定制)。

2

作为结果，列表 [1, 2] 与 [1.0, 2.0] 是相等的，元组的情况也类似。

3

必须如此，因为解析器无法判断操作数的类型。

4(1,2,3,4)

区分大小写的字符是指所属一般类别属性为 "Lu" (Letter, uppercase), "Ll" (Letter, lowercase) 或 "Lt" (Letter, titlecase) 之一的字符。

5(1,2)

若只是要格式化一个元组，则应提供一个单例元组，其中只包含一个元素，就是需要格式化的那个元组。

内置异常

在 Python 中，所有异常必须为一个派生自 BaseException 的类的实例。 在带有提及一个特定类的 except 子句的 try 语句中，该子句也会处理任何派生自该类的异常类（但不处理 它 所派生出的异常类）。 通过子类化创建的两个不相关异常类永远是不等效的，既使它们具有相同的名称。

下面列出的内置异常可通过解释器或内置函数来生成。除非另有说明，它们都会具有一个提示导致错误详细原因的“关联值”。 这可以是一个字符串或由多个信息项（例如一个错误码和一个解释错误的字符串）组成的元组。 关联值通常会作为参数被传递给异常类的构造器。

用户代码可以引发内置异常。 这可被用于测试异常处理程序或报告错误条件，“就像” 在解释器引发了相同异常的情况时一样；但是请注意，没有任何机制能防止用户代码引发不适当的错误。

内置异常类可以被子类化以定义新的异常；鼓励程序员从 Exception 类或它的某个子类而不是从 BaseException 来派生新的异常。 关于定义异常的更多信息可以在 Python 教程的 用户自定义异常 部分查看。

异常上下文

当有其他异常已经被处理的情况下又引发一个新异常的时候，新异常的 __context__ 属性会被自动设为已经被处理的异常。 异常可以在使用了 except 或 finally 子句，或者 with 语句的时候被处理。

这个隐式异常上下文可以通过使用 from 配合 raise 来补充一个显式的原因:

raise new_exc from original_exc

跟在 from 之后一表达式必须为一个异常或 None。 它将在所引发的异常上被设置为 __cause__。 设置 __cause__ 还会隐式地将 __suppress_context__ 属性设为 True，这样使用 raise new_exc from None 可以有效地将旧异常替换为新异常来显示其目的 (例如将 KeyError 转换为 AttributeError)，同时让旧异常在 __context__ 中保持可用状态以便在调试时进行内省。

除了异常本身的回溯以外，默认的回溯还会显示这些串连的异常。 __cause__ 中的显式串连异常如果存在将总是显示。 __context__ 中的隐式串连异常仅在 __cause__ 为 None 并且 __suppress_context__ 为假值时显示。

不论在哪种情况下，异常本身总会在任何串连异常之后显示，以便回溯的最后一行总是显示所引发的最后一个异常。

从内置异常继承

用户代码可以创建继承自某个异常类型的子类。 建议每次仅子类化一个异常类型以避免多个基类处理 args 属性的不同方式，以及内存布局不兼容可能导致的冲突。

CPython 实现细节： 大多数内置异常都用 C 实现以保证运行效率，参见: Objects/exceptions.c [https://github.com/python/cpython/tree/3.10/Objects/exceptions.c]。 其中一些具有自定义内存布局，这使得创建继承自多个异常类型的子类成为不可能。 一个类型的内存布局属于实现细节并可能随着 Python 版本升级而改变，导致在未来可能产生新的冲突。 因此，建议完全避免子类化多个异常类型。

基类

下列异常主要被用作其他异常的基类。

exception BaseException

所有内置异常的基类。 它不应该被用户自定义类直接继承 (这种情况请使用 Exception)。 如果在此类的实例上调用 str()，则会返回实例的参数表示，或者当没有参数时返回空字符串。

args

传给异常构造器的参数元组。 某些内置异常 (例如 OSError) 接受特定数量的参数并赋予此元组中的元素特殊的含义，而其他异常通常只接受一个给出错误信息的单独字符串。

with_traceback(tb)

此方法会将 tb 设为新的异常回溯信息并返回异常对象。 它在 PEP 3134 [https://www.python.org/dev/peps/pep-3134] 的异常链特性可用之前更为常用。 下面的例子演示了我们如何将一个 SomeException 实例转换为 OtherException 实例而保留回溯信息。 异常一旦被引发，当前帧会被推至 OtherException 的回溯栈顶端，就像当我们允许原始 SomeException 被传播给调用方时它的回溯栈将会发生的情形一样。:

try:
    ...
except SomeException:
    tb = sys.exc_info()[2]
    raise OtherException(...).with_traceback(tb)

exception Exception

所有内置的非系统退出类异常都派生自此类。 所有用户自定义异常也应当派生自此类。

exception ArithmeticError

此基类用于派生针对各种算术类错误而引发的内置异常: OverflowError, ZeroDivisionError, FloatingPointError。

exception BufferError

当与 缓冲区 相关的操作无法执行时将被引发。

exception LookupError

此基类用于派生当映射或序列所使用的键或索引无效时引发的异常: IndexError, KeyError。 这可以通过 codecs.lookup() 来直接引发。

具体异常

以下异常属于经常被引发的异常。

exception AssertionError

当 assert 语句失败时将被引发。

exception AttributeError

当属性引用 (参见 属性引用) 或赋值失败时将被引发。 （当一个对象根本不支持属性引用或属性赋值时则将引发 TypeError。）

name 和 obj 属性可以使用构造器的仅限关键字参数来设置。 它们如果被设置则分别代表要尝试访问的属性名称以及所访问的该属性的对象。

在 3.10 版更改: 增加了 name 和 obj 属性。

exception EOFError

当 input() 函数未读取任何数据即达到文件结束条件 (EOF) 时将被引发。 （另外，io.IOBase.read() 和 io.IOBase.readline() 方法在遇到 EOF 则将返回一个空字符串。）

exception FloatingPointError

目前未被使用。

exception GeneratorExit

当一个 generator 或 coroutine 被关闭时将被引发；参见 generator.close() 和 coroutine.close()。 它直接继承自 BaseException 而不是 Exception，因为从技术上来说它并不是一个错误。

exception ImportError

当 import 语句尝试加载模块遇到麻烦时将被引发。 并且当 from ... import 中的 "from list" 存在无法找到的名称时也会被引发。

name 与 path 属性可通过对构造器使用仅关键字参数来设定。 设定后它们将分别表示被尝试导入的模块名称与触发异常的任意文件所在路径。

在 3.3 版更改: 添加了 name 与 path 属性。

exception ModuleNotFoundError

ImportError 的子类，当一个模块无法被定位时将由 import 引发。 当在 sys.modules 中找到 None 时也会被引发。

3.6 新版功能.

exception IndexError

当序列抽取超出范围时将被引发。 （切片索引会被静默截短到允许的范围；如果指定索引不是整数则 TypeError 会被引发。）

exception KeyError

当在现有键集合中找不到指定的映射（字典）键时将被引发。

exception KeyboardInterrupt

当用户按下中断键 (通常为 Control-C 或 Delete) 时将被引发。 在执行期间，会定期检测中断信号。 该异常继承自 BaseException 以确保不会被处理 Exception 的代码意外捕获，这样可以避免退出解释器。

注解

捕获 KeyboardInterrupt 需要特别考虑。 因为它可能会在不可预知的点位被引发，在某些情况下，它可能使运行中的程序陷入不一致的状态。 通常最好是让 KeyboardInterrupt 尽快结束程序或者完全避免引发它。 (参见 有关信号处理器和异常的注释。)

exception MemoryError

当一个操作耗尽内存但情况仍可（通过删除一些对象）进行挽救时将被引发。 关联的值是一个字符串，指明是哪种（内部）操作耗尽了内存。 请注意由于底层的内存管理架构（C 的 malloc() 函数），解释器也许并不总是能够从这种情况下完全恢复；但它毕竟可以引发一个异常，这样就能打印出栈回溯信息，以便找出导致问题的失控程序。

exception NameError

当某个局部或全局名称未找到时将被引发。 此异常仅用于非限定名称。 关联的值是一条错误信息，其中包含未找到的名称。

name 属性可以使用构造器的仅限关键字参数来设置。 它如果被设置则代表要尝试访问的变量名称。

在 3.10 版更改: 增加了 name 属性。

exception NotImplementedError

此异常派生自 RuntimeError。 在用户自定义的基类中，抽象方法应当在其要求所派生类重写该方法，或是在其要求所开发的类提示具体实现尚待添加时引发此异常。

注解

它不应当用来表示一个运算符或方法根本不能被支持 -- 在此情况下应当让特定运算符 / 方法保持未定义，或者在子类中将其设为 None。

注解

NotImplementedError 和 NotImplemented 不可互换，即使它们有相似的名称和用途。 请参阅 NotImplemented 了解有关何时使用它们的详细说明。

exception OSError([arg])

exception OSError(errno, strerror[, filename[, winerror[, filename2]]])

此异常在一个系统函数返回系统相关的错误时将被引发，此类错误包括 I/O 操作失败例如 "文件未找到" 或 "磁盘已满" 等（不包括非法参数类型或其他偶然性错误）。

构造器的第二种形式可设置如下所述的相应属性。 如果未指定这些属性则默认为 None。 为了能向下兼容，如果传入了三个参数，则 args 属性将仅包含由前两个构造器参数组成的 2 元组。

构造器实际返回的往往是 OSError 的某个子类，如下文 OS exceptions 中所描述的。 具体的子类取决于最终的 errno 值。 此行为仅在直接或通过别名来构造 OSError 时发生，并且在子类化时不会被继承。

errno

来自于 C 变量 errno 的数字错误码。

winerror

在 Windows 下，此参数将给出原生的 Windows 错误码。 而 errno 属性将是该原生错误码在 POSIX 平台下的近似转换形式。

在 Windows 下，如果 winerror 构造器参数是一个整数，则 errno 属性会根据 Windows 错误码来确定，而 errno 参数会被忽略。 在其他平台上，winerror 参数会被忽略，并且 winerror 属性将不存在。

strerror

操作系统所提供的相应错误信息。 它在 POSIX 平台中由 C 函数 perror() 来格式化，在 Windows 中则是由 FormatMessage()。

filename

filename2

对于与文件系统路径有关 (例如 open() 或 os.unlink()) 的异常，filename 是传给函数的文件名。 对于涉及两个文件系统路径的函数 (例如 os.rename())，filename2 将是传给函数的第二个文件名。

在 3.3 版更改: EnvironmentError, IOError, WindowsError, socket.error, select.error 与 mmap.error 已被合并到 OSError，构造器可能返回其中一个子类。

在 3.4 版更改: filename 属性现在是传给函数的原始文件名，而不是基于 filesystem encoding and error handler 进行编码或解码之后的名称。 此外，还添加了 filename2 构造器参数和属性。

exception OverflowError

当算术运算的结果大到无法表示时将被引发。 这对整数来说不可能发生（宁可引发 MemoryError 也不会放弃尝试）。 但是出于历史原因，有时也会在整数超出要求范围的情况下引发 OverflowError。 因为在 C 中缺少对浮点异常处理的标准化，大多数浮点运算都不会做检查。

exception RecursionError

此异常派生自 RuntimeError。 它会在解释器检测发现超过最大递归深度 (参见 sys.getrecursionlimit()) 时被引发。

3.5 新版功能: 在此之前将只引发 RuntimeError。

exception ReferenceError

此异常将在使用 weakref.proxy() 函数所创建的弱引用来访问该引用的某个已被作为垃圾回收的属性时被引发。 有关弱引用的更多信息请参阅 weakref 模块。

exception RuntimeError

当检测到一个不归属于任何其他类别的错误时将被引发。 关联的值是一个指明究竟发生了什么问题的字符串。

exception StopIteration

由内置函数 next() 和 iterator 的 __next__() 方法所引发，用来表示该迭代器不能产生下一项。

该异常对象只有一个属性 value，它在构造该异常时作为参数给出，默认值为 None。

当一个 generator 或 coroutine 函数返回时，将引发一个新的 StopIteration 实例，函数返回的值将被用作异常构造器的 value 形参。

如果某个生成器代码直接或间接地引发了 StopIteration，它会被转换为 RuntimeError (并将 StopIteration 保留为导致新异常的原因)。

在 3.3 版更改: 添加了 value 属性及其被生成器函数用作返回值的功能。

在 3.5 版更改: 引入了通过 from __future__ import generator_stop 来实现 RuntimeError 转换，参见 PEP 479 [https://www.python.org/dev/peps/pep-0479]。

在 3.7 版更改: 默认对所有代码启用 PEP 479 [https://www.python.org/dev/peps/pep-0479]: 在生成器中引发的 StopIteration 错误将被转换为 RuntimeError。

exception StopAsyncIteration

必须由一个 asynchronous iterator 对象的 __anext__() 方法来引发以停止迭代操作。

3.5 新版功能.

exception SyntaxError(message, details)

当解析器遇到语法错误时引发。 这可以发生在 import 语句，对内置函数 compile(), exec() 或 eval() 的调用，或是读取原始脚本或标准输入（也包括交互模式）的时候。

异常实例的 str() 只返回错误消息。 错误详情为一个元组，其成员也可在单独的属性中分别获取。

filename

发生语法错误所在文件的名称。

lineno

发生错误所在文件中的行号。 行号索引从 1 开始：文件中首行的 lineno 为 1。

offset

发生错误所在文件中的列号。 列号索引从 1 开始：行中首个字符的 offset 为 1。

text

错误所涉及的源代码文本。

end_lineno

发生的错误在文件中的末尾行号。 这个索引是从 1 开始的：文件中首行的 lineno 为 1。

end_offset

发生的错误在文件中的末尾列号。 这个索引是从 1 开始：行中首个字符的 offset 为 1。

对于 f-字符串字段中的错误，消息会带有 "f-string: " 前缀并且其位置是基于替换表达式构建的文本中的位置。 例如，编译 f'Bad {a b} field' 将产生这样的 args 属性: ('f-string: ...', ('', 1, 2, '(a b)n', 1, 5))。

在 3.10 版更改: 增加了 end_lineno 和 end_offset 属性。

exception IndentationError

与不正确的缩进相关的语法错误的基类。 这是 SyntaxError 的一个子类。

exception TabError

当缩进包含对制表符和空格符不一致的使用时将被引发。 这是 IndentationError 的一个子类。

exception SystemError

当解释器发现内部错误，但情况看起来尚未严重到要放弃所有希望时将被引发。 关联的值是一个指明发生了什么问题的字符串（表示为低层级的符号）。

你应当将此问题报告给你所用 Python 解释器的作者或维护人员。 请确认报告 Python 解释器的版本号 (sys.version; 它也会在交互式 Python 会话开始时被打印出来)，具体的错误消息（异常所关联的值）以及可能触发该错误的程序源码。

exception SystemExit

此异常由 sys.exit() 函数引发。 它继承自 BaseException 而不是 Exception 以确保不会被处理 Exception 的代码意外捕获。 这允许此异常正确地向上传播并导致解释器退出。 如果它未被处理，则 Python 解释器就将退出；不会打印任何栈回溯信息。 构造器接受的可选参数与传递给 sys.exit() 的相同。 如果该值为一个整数，则它指明系统退出状态码（会传递给 C 的 exit() 函数）；如果该值为 None，则退出状态码为零；如果该值为其他类型（例如字符串），则会打印对象的值并将退出状态码设为一。

对 sys.exit() 的调用会被转换为一个异常以便能执行清理处理程序 (try 语句的 finally 子句)，并且使得调试器可以执行一段脚本而不必冒失去控制的风险。 如果绝对确实地需要立即退出（例如在调用 os.fork() 之后的子进程中）则可使用 os._exit().

code

传给构造器的退出状态码或错误信息（默认为 None。）

exception TypeError

当一个操作或函数被应用于类型不适当的对象时将被引发。 关联的值是一个字符串，给出有关类型不匹配的详情。

此异常可以由用户代码引发，以表明尝试对某个对象进行的操作不受支持也不应当受支持。 如果某个对象应当支持给定的操作但尚未提供相应的实现，所要引发的适当异常应为 NotImplementedError。

传入参数的类型错误 (例如在要求 int 时却传入了 list) 应当导致 TypeError，但传入参数的值错误 (例如传入要求范围之外的数值) 则应当导致 ValueError。

exception UnboundLocalError

当在函数或方法中对某个局部变量进行引用，但该变量并未绑定任何值时将被引发。 此异常是 NameError 的一个子类。

exception UnicodeError

当发生与 Unicode 相关的编码或解码错误时将被引发。 此异常是 ValueError 的一个子类。

UnicodeError 具有一些描述编码或解码错误的属性。 例如 err.object[err.start:err.end] 会给出导致编解码器失败的特定无效输入。

encoding

引发错误的编码名称。

reason

描述特定编解码器错误的字符串。

object

编解码器试图要编码或解码的对象。

start

object 中无效数据的开始位置索引。

end

object 中无效数据的末尾位置索引（不含）。

exception UnicodeEncodeError

当在编码过程中发生与 Unicode 相关的错误时将被引发。 此异常是 UnicodeError 的一个子类。

exception UnicodeDecodeError

当在解码过程中发生与 Unicode 相关的错误时将被引发。 此异常是 UnicodeError 的一个子类。

exception UnicodeTranslateError

在转写过程中发生与 Unicode 相关的错误时将被引发。 此异常是 UnicodeError 的一个子类。

exception ValueError

当操作或函数接收到具有正确类型但值不适合的参数，并且情况不能用更精确的异常例如 IndexError 来描述时将被引发。

exception ZeroDivisionError

当除法或取余运算的第二个参数为零时将被引发。 关联的值是一个字符串，指明操作数和运算的类型。

下列异常被保留以与之前的版本相兼容；从 Python 3.3 开始，它们都是 OSError 的别名。

exception EnvironmentError

exception IOError

exception WindowsError

限在 Windows 中可用。

OS 异常

下列异常均为 OSError 的子类，它们将根据系统错误代码被引发。

exception BlockingIOError

当一个操作将会在设置为非阻塞操作的对象（例如套接字）上发生阻塞时将被引发。 对应于 errno EAGAIN, EALREADY, EWOULDBLOCK 和 EINPROGRESS。

除了 OSError 已有的属性，BlockingIOError 还有一个额外属性：

characters_written

一个整数，表示在被阻塞前已写入到流的字符数。 当使用来自 io 模块的带缓冲 I/O 类时此属性可用。

exception ChildProcessError

当一个子进程上的操作失败时将被引发。 对应于 errno ECHILD。

exception ConnectionError

与连接相关问题的基类。

其子类有 BrokenPipeError, ConnectionAbortedError, ConnectionRefusedError 和 ConnectionResetError。

exception BrokenPipeError

ConnectionError 的子类，当试图写入一个管道而该管道的另一端已关闭，或者试图写入一个套接字而该套接字已关闭写入时将被引发。 对应于 errno EPIPE 和 ESHUTDOWN。

exception ConnectionAbortedError

ConnectionError 的子类，当一个连接尝试被对端中止时将被引发。 对应于 errno ECONNABORTED。

exception ConnectionRefusedError

ConnectionError 的子类，当一个连接尝试被对端拒绝时将被引发。 对应于 errno ECONNREFUSED。

exception ConnectionResetError

ConnectionError 的子类，当一个连接尝试被对端重置时将被引发。 对应于 errno ECONNRESET。

exception FileExistsError

当试图创建一个已存在的文件或目录时将被引发。 对应于 errno EEXIST。

exception FileNotFoundError

将所请求的文件或目录不存在时将被引发。 对应于 errno ENOENT。

exception InterruptedError

当系统调用被输入信号中断时将被引发。 对应于 errno EINTR。

在 3.5 版更改: 当系统调用被某个信号中断时，Python 现在会重试系统调用，除非该信号的处理程序引发了其它异常 (原理参见 PEP 475 [https://www.python.org/dev/peps/pep-0475]) 而不是引发 InterruptedError。

exception IsADirectoryError

当请求对一个目录执行文件操作 (例如 os.remove()) 时将被引发。 对应于 errno EISDIR。

exception NotADirectoryError

当请求对一个非目录执行目录操作 (例如 os.listdir()) 时将被引发。 在大多数 POSIX 平台上，它还可能在某个操作试图将一个非目录作为目录打开或遍历时被引发。 对应于 errno ENOTDIR。

exception PermissionError

当在没有足够访问权限的情况下试图执行某个操作时将被引发 —— 例如文件系统权限。 对应于 errno EACCES 和 EPERM。

exception ProcessLookupError

当给定的进程不存在时将被引发。 对应于 errno ESRCH。

exception TimeoutError

当一个系统函数在系统层级发生超时的情况下将被引发。 对应于 errno ETIMEDOUT。

3.3 新版功能: 添加了以上所有 OSError 的子类。

参见

PEP 3151 [https://www.python.org/dev/peps/pep-3151] - 重写 OS 和 IO 异常的层次结构

警告

下列异常被用作警告类别；请参阅 警告类别 文档了解详情。

exception Warning

警告类别的基类。

exception UserWarning

用户代码所产生警告的基类。

exception DeprecationWarning

如果所发出的警告是针对其他 Python 开发者的，则以此作为与已弃用特性相关警告的基类。

会被默认警告过滤器忽略，在 __main__ 模块中的情况除外 (PEP 565 [https://www.python.org/dev/peps/pep-0565])。 启用 Python 开发模式 时会显示此警告。

这个弃用政策是在 PEP 387 [https://www.python.org/dev/peps/pep-0387] 中描述的。

exception PendingDeprecationWarning

对于已过时并预计在未来弃用，但目前尚未弃用的特性相关警告的基类。

这个类很少被使用，因为针对未来可能的弃用发出警告的做法并不常见，而针对当前已有的弃用则推荐使用 DeprecationWarning。

会被默认警告过滤器忽略。 启用 Python 开发模式 时会显示此警告。

这个弃用政策是在 PEP 387 [https://www.python.org/dev/peps/pep-0387] 中描述的。

exception SyntaxWarning

与模糊的语法相关的警告的基类。

exception RuntimeWarning

与模糊的运行时行为相关的警告的基类。

exception FutureWarning

如果所发出的警告是针对以 Python 所编写应用的最终用户的，则以此作为与已弃用特性相关警告的基类。

exception ImportWarning

与在模块导入中可能的错误相关的警告的基类。

会被默认警告过滤器忽略。 启用 Python 开发模式 时会显示此警告。

exception UnicodeWarning

与 Unicode 相关的警告的基类。

exception EncodingWarning

与编码格式相关的警告的基类。

请参阅 选择性的 EncodingWarning 来了解详情。

3.10 新版功能.

exception BytesWarning

与 bytes 和 bytearray 相关的警告的基类。

exception ResourceWarning

资源使用相关警告的基类。

会被默认警告过滤器忽略。 启用 Python 开发模式 时会显示此警告。

3.2 新版功能.

异常层次结构

内置异常的类层级结构如下：

BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration
      +-- StopAsyncIteration
      +-- ArithmeticError
      |    +-- FloatingPointError
      |    +-- OverflowError
      |    +-- ZeroDivisionError
      +-- AssertionError
      +-- AttributeError
      +-- BufferError
      +-- EOFError
      +-- 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
      |    +-- RecursionError
      +-- SyntaxError
      |    +-- IndentationError
      |         +-- TabError
      +-- SystemError
      +-- TypeError
      +-- ValueError
      |    +-- UnicodeError
      |         +-- UnicodeDecodeError
      |         +-- UnicodeEncodeError
      |         +-- UnicodeTranslateError
      +-- Warning
           +-- DeprecationWarning
           +-- PendingDeprecationWarning
           +-- RuntimeWarning
           +-- SyntaxWarning
           +-- UserWarning
           +-- FutureWarning
           +-- ImportWarning
           +-- UnicodeWarning
           +-- BytesWarning
           +-- EncodingWarning
           +-- ResourceWarning

文本处理服务

本章介绍的模块提供了广泛的字符串操作和其他文本处理服务。

在 二进制数据服务 之下描述的 codecs 模块也与文本处理高度相关。 此外也请参阅 Python 内置字符串类型的文档 文本序列类型 --- str。

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

字符串常量

自定义字符串格式化

格式字符串语法

格式规格迷你语言

格式示例

模板字符串

辅助函数

re --- 正则表达式操作

正则表达式语法

模块内容

标志

函数

异常

正则表达式对象 （正则对象）

匹配对象

正则表达式例子

检查对子

模拟 scanf()

search() vs. match()

制作一个电话本

文字整理

查找所有副词

查找所有的副词及其位置

原始字符串标记

写一个词法分析器

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

SequenceMatcher 对象

SequenceMatcher 的示例

Differ 对象

Differ 示例

difflib 的命令行接口

textwrap --- 文本自动换行与填充

unicodedata --- Unicode 数据库

stringprep --- 因特网字符串预备

readline --- GNU readline 接口

初始化文件

行缓冲区

历史文件

历史列表

启动钩子

Completion

示例

rlcompleter --- GNU readline 的补全函数

Completer 对象

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

源代码： Lib/string.py [https://github.com/python/cpython/tree/3.10/Lib/string.py]

参见

文本序列类型 --- str

字符串的方法

字符串常量

此模块中定义的常量为：

string.ascii_letters

下文所述 ascii_lowercase 和 ascii_uppercase 常量的拼连。 该值不依赖于语言区域。

string.ascii_lowercase

小写字母 'abcdefghijklmnopqrstuvwxyz'。 该值不依赖于语言区域，不会发生改变。

string.ascii_uppercase

大写字母 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'。 该值不依赖于语言区域，不会发生改变。

string.digits

字符串 '0123456789'。

string.hexdigits

字符串 '0123456789abcdefABCDEF'。

string.octdigits

字符串 '01234567'。

string.punctuation

由在 C 区域设置中被视为标点符号的 ASCII 字符所组成的字符串: !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~.

string.printable

由被视为可打印符号的 ASCII 字符组成的字符串。 这是 digits, ascii_letters, punctuation 和 whitespace 的总和。

string.whitespace

由被视为空白符号的 ASCII 字符组成的字符串。 其中包括空格、制表、换行、回车、进纸和纵向制表符。

自定义字符串格式化

内置的字符串类提供了通过使用 PEP 3101 [https://www.python.org/dev/peps/pep-3101] 所描述的 format() 方法进行复杂变量替换和值格式化的能力。 string 模块中的 Formatter 类允许你使用与内置 format() 方法相同的实现来创建并定制你自己的字符串格式化行为。

class string.Formatter

Formatter 类包含下列公有方法：

format(format_string, /, *args, **kwargs)

首要的 API 方法。 它接受一个格式字符串和任意一组位置和关键字参数。 它只是一个调用 vformat() 的包装器。

在 3.7 版更改: 格式字符串参数现在是 仅限位置参数。

vformat(format_string, args, kwargs)

此函数执行实际的格式化操作。 它被公开为一个单独的函数，用于需要传入一个预定义字母作为参数，而不是使用 *args 和 **kwargs 语法将字典解包为多个单独参数并重打包的情况。 vformat() 完成将格式字符串分解为字符数据和替换字段的工作。 它会调用下文所述的几种不同方法。

此外，Formatter 还定义了一些旨在被子类替换的方法：

parse(format_string)

循环遍历 format_string 并返回一个由可迭代对象组成的元组 (literal_text, field_name, format_spec, conversion)。 它会被 vformat() 用来将字符串分解为文本字面值或替换字段。

元组中的值在概念上表示一段字面文本加上一个替换字段。 如果没有字面文本（如果连续出现两个替换字段就会发生这种情况），则 literal_text 将是一个长度为零的字符串。 如果没有替换字段，则 field_name, format_spec 和 conversion 的值将为 None。

get_field(field_name, args, kwargs)

给定 field_name 作为 parse() (见上文) 的返回值，将其转换为要格式化的对象。 返回一个元组 (obj, used_key)。 默认版本接受在 PEP 3101 [https://www.python.org/dev/peps/pep-3101] 所定义形式的字符串，例如 "0[name]" 或 "label.title"。 args 和 kwargs 与传给 vformat() 的一样。 返回值 used_key 与 get_value() 的 key 形参具有相同的含义。

get_value(key, args, kwargs)

提取给定的字段值。 key 参数将为整数或字符串。 如果是整数，它表示 args 中位置参数的索引；如果是字符串，它表示 kwargs 中的关键字参数名。

args 形参会被设为 vformat() 的位置参数列表，而 kwargs 形参会被设为由关键字参数组成的字典。

对于复合字段名称，仅会为字段名称的第一个组件调用这些函数；后续组件会通过普通属性和索引操作来进行处理。

因此举例来说，字段表达式 '0.name' 将导致调用 get_value() 时附带 key 参数值 0。 在 get_value() 通过调用内置的 getattr() 函数返回后将会查找 name 属性。

如果索引或关键字引用了一个不存在的项，则将引发 IndexError 或 KeyError。

check_unused_args(used_args, args, kwargs)

在必要时实现对未使用参数进行检测。 此函数的参数是是格式字符串中实际引用的所有参数键的集合（整数表示位置参数，字符串表示名称参数），以及被传给 vformat 的 args 和 kwargs 的引用。 未使用参数的集合可以根据这些形参计算出来。 如果检测失败则 check_unused_args() 应会引发一个异常。

format_field(value, format_spec)

format_field() 会简单地调用内置全局函数 format()。 提供该方法是为了让子类能够重载它。

convert_field(value, conversion)

使用给定的转换类型（来自 parse() 方法所返回的元组）来转换（由 get_field() 所返回的）值。 默认版本支持 's' (str), 'r' (repr) 和 'a' (ascii) 等转换类型。

格式字符串语法

str.format() 方法和 Formatter 类共享相同的格式字符串语法（虽然对于 Formatter 来说，其子类可以定义它们自己的格式字符串语法）。 具体语法与 格式化字符串字面值 相似，但较为简单一些，并且关键的一点是不支持任意表达式。

格式字符串包含有以花括号 {} 括起来的“替换字段”。 不在花括号之内的内容被视为字面文本，会不加修改地复制到输出中。 如果你需要在字面文本中包含花括号字符，可以通过重复来转义: {{ and }}。

替换字段的语法如下：

replacement_field ::=  "{" [field_name] ["!" conversion] [":" format_spec] "}"
field_name        ::=  arg_name ("." attribute_name | "[" element_index "]")*
arg_name          ::=  [identifier | digit+]
attribute_name    ::=  identifier
element_index     ::=  digit+ | index_string
index_string      ::=  <any source character except "]"> +
conversion        ::=  "r" | "s" | "a"
format_spec       ::=  <described in the next section>

用不太正式的术语来描述，替换字段开头可以用一个 field_name 指定要对值进行格式化并取代替换字符被插入到输出结果的对象。 field_name 之后有可选的 conversion 字段，它是一个感叹号 '!' 加一个 format_spec，并以一个冒号 ':' 打头。 这些指明了替换值的非默认格式。

另请参阅 格式规格迷你语言 一节。

field_name 本身以一个数字或关键字 arg_name 打头。 如果为数字，则它指向一个位置参数，而如果为关键字，则它指向一个命名关键字参数。 如果格式字符串中的数字 arg_names 为 0, 1, 2, ... 的序列，它们可以全部省略（而非部分省略），数字 0, 1, 2, ... 将会按顺序自动插入。 由于 arg_name 不使用引号分隔，因此无法在格式字符串中指定任意的字典键 (例如字符串 '10' 或 ':-]')。 arg_name 之后可以带上任意数量的索引或属性表达式。 '.name' 形式的表达式会使用 getattr() 选择命名属性，而 '[index]' 形式的表达式会使用 __getitem__() 执行索引查找。

在 3.1 版更改: 位置参数说明符对于 str.format() 可以省略，因此 '{} {}'.format(a, b) 等价于 '{0} {1}'.format(a, b)。

在 3.4 版更改: 位置参数说明符对于 Formatter 可以省略。

一些简单的格式字符串示例

"First, thou shalt count to {0}"  # References first positional argument
"Bring me a {}"                   # Implicitly references the first positional argument
"From {} to {}"                   # Same as "From {0} to {1}"
"My quest is {name}"              # References keyword argument 'name'
"Weight in tons {0.weight}"       # 'weight' attribute of first positional arg
"Units destroyed: {players[0]}"   # First element of keyword argument 'players'.

使用 conversion 字段在格式化之前进行类型强制转换。 通常，格式化值的工作由值本身的 __format__() 方法来完成。 但是，在某些情况下最好强制将类型格式化为一个字符串，覆盖其本身的格式化定义。 通过在调用 __format__() 之前将值转换为字符串，可以绕过正常的格式化逻辑。

目前支持的转换旗标有三种: '!s' 会对值调用 str()，'!r' 调用 repr() 而 '!a' 则调用 ascii()。

示例如下：

"Harold's a clever {0!s}"        # Calls str() on the argument first
"Bring out the holy {name!r}"    # Calls repr() on the argument first
"More {!a}"                      # Calls ascii() on the argument first

format_spec 字段包含值应如何呈现的规格描述，例如字段宽度、对齐、填充、小数精度等细节信息。 每种值类型可以定义自己的“格式化迷你语言”或对 format_spec 的解读方式。

大多数内置类型都支持同样的格式化迷你语言，具体描述见下一节。

format_spec 字段还可以在其内部包含嵌套的替换字段。 这些嵌套的替换字段可能包括字段名称、转换旗标和格式规格描述，但是不再允许更深层的嵌套。 format_spec 内部的替换字段会在解读 format_spec 字符串之前先被解读。 这将允许动态地指定特定值的格式。

请参阅 格式示例 一节查看相关示例。

格式规格迷你语言

“格式规格”在格式字符串所包含的替换字段内部使用，用于定义单个值应如何呈现 (参见 格式字符串语法 和 格式字符串字面值)。 它们也可以被直接传给内置的 format() 函数。 每种可格式化的类型都可以自行定义如何对格式规格进行解读。

大多数内置类型都为格式规格实现了下列选项，不过某些格式化选项只被数值类型所支持。

一般约定空的格式描述将产生与在值上调用 str() 相同的结果。 非空格式描述通常会修改此结果。

标准格式说明符 的一般形式如下：

format_spec     ::=  [[fill]align][sign][#][0][width][grouping_option][.precision][type]
fill            ::=  <any character>
align           ::=  "<" | ">" | "=" | "^"
sign            ::=  "+" | "-" | " "
width           ::=  digit+
grouping_option ::=  "_" | ","
precision       ::=  digit+
type            ::=  "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%"

如果指定了一个有效的 align 值，则可以在该值前面加一个 fill 字符，它可以为任意字符，如果省略则默认为空格符。 在 格式化字符串字面值 或在使用 str.format() 方法时是无法使用花括号字面值 ("{" or "}") 作为 fill 字符的。 但是，通过嵌套替换字段插入花括号则是可以的。 这个限制不会影响 format() 函数。

各种对齐选项的含义如下：

属性 | 含意
'<' | 强制字段在可用空间内左对齐（这是大多数对象的默认值）。
'>' | 强制字段在可用空间内右对齐（这是数字的默认值）。
'=' | 强制在符号（如果有）之后数码之前放置填充。 这被用于以 '+000000120' 形式打印字段。 这个对齐选项仅对数字类型有效。 这是当 '0' 紧接在字段宽度之前时的默认选项。
'^' | 强制字段在可用空间内居中。

请注意，除非定义了最小字段宽度，否则字段宽度将始终与填充它的数据大小相同，因此在这种情况下，对齐选项没有意义。

sign 选项仅对数字类型有效，可以是以下之一：

属性 | 含意
'+' | 表示正负号将同时用于正数与负数，例如 +3 , -1 。
'-' | 表示正负号仅用于负数（这是默认行为），例如 3 , -1。
space | 表示应在正数上使用前导空格，在负数上使用负号。

'#' 选项可让“替代形式”被用于执行转换。 替代形式会针对不同的类型分别定义。 此选项仅适用于整数、浮点数和复数类型。 对于整数类型，当使用二进制、八进制或十六进制输出时，此选项会为输出值分别添加相应的 '0b', '0o', '0x' 或 '0X' 前缀。 对于浮点数和复数类型，替代形式会使得转换结果总是包含小数点符号，即使其不带小数部分。 通常只有在带有小数部分的情况下，此类转换的结果中才会出现小数点符号。 此外，对于 'g' 和 'G' 转换，末尾的零不会从结果中被移除。

',' 选项表示使用逗号作为千位分隔符。 对于感应区域设置的分隔符，请改用 'n' 整数表示类型。

在 3.1 版更改: 添加了 ',' 选项 (另请参阅 PEP 378 [https://www.python.org/dev/peps/pep-0378])。

'_' 选项表示对浮点表示类型和整数表示类型 'd' 使用下划线作为千位分隔符。 对于整数表示类型 'b', 'o', 'x' 和 'X'，将为每 4 个数位插入一个下划线。 对于其他表示类型指定此选项则将导致错误。

在 3.6 版更改: 添加了 '_' 选项 (另请参阅 PEP 515 [https://www.python.org/dev/peps/pep-0515])。

width 是一个定义最小总字段宽度的十进制整数，包括任何前缀、分隔符和其他格式化字符。 如果未指定，则字段宽度将由内容确定。

当未显式给出对齐方式时，在 width 字段前加一个零 ('0') 字段将为数字类型启用感知正负号的零填充。 这相当于设置 fill 字符为 '0' 且 alignment 类型为 '='。

在 3.10 版更改: 在 width 字段之前添加 '0' 不会再影响字符串的默认对齐。

precision 是一个十进制整数，它表示对于以表示类型 'f' 和 'F' 格式化的数值应当在小数点后显示多少个数位，或者对于以表示类型 'g' 或 'G' 格式化的数值应当在小数点前后显示多少个数位。 对于字符串表示类型，该字段表示最大的字段大小 ——换句话说，就是要使用多少个来自字段内容的字符。不允许对整数表示类型指定 precision 字段。

最后，type 确定了数据应如何呈现。

可用的字符串表示类型是：

类型 | 含意
's' | 字符串格式。这是字符串的默认类型，可以省略。
None | 和 's' 一样。

可用的整数表示类型是：

类型 | 含意
'b' | 二进制格式。 输出以 2 为基数的数字。
'c' | 字符。在打印之前将整数转换为相应的unicode字符。
'd' | 十进制整数。 输出以 10 为基数的数字。
'o' | 八进制格式。 输出以 8 为基数的数字。
'x' | 十六进制格式。 输出以 16 为基数的数字，使用小写字母表示 9 以上的数码。
'X' | 十六进制格式。 输出以 16 为基数的数字，使用大写字母表示 9 以上的数码。 在指定 '#' 的情况下，前缀 '0x' 也将被转为大写形式 '0X'。
'n' | 数字。 这与 'd' 相似，不同之处在于它会使用当前区域设置来插入适当的数字分隔字符。
None | 和 'd' 相同。

在上述的表示类型之外，整数还可以通过下列的浮点表示类型来格式化 (除了 'n' 和 None)。 当这样做时，会在格式化之前使用 float() 将整数转换为浮点数。

float 和 Decimal 值的可用表示类型有:

类型 | 含意
'e' | 科学计数法。 对于一个给定的精度 p，将数字格式化为以字母 'e' 分隔系数和指数的科学计数法形式。 系数在小数点之前有一位，之后有 p 位，总计 p + 1 个有效数位。 如未指定精度，则会对 float 采用小数点之后 6 位精度，而对 Decimal 则显示所有系数位。 如果小数点之后没有数位，则小数点也会被略去，除非使用了 # 选项。
'E' | 科学计数法。 与 'e' 相似，不同之处在于它使用大写字母 'E' 作为分隔字符。
'f' | 定点表示法。 对于一个给定的精度 p，将数字格式化为在小数点之后恰好有 p 位的小数形式。 如未指定精度，则会对 float 采用小数点之后 6 位精度，而对 Decimal 则使用大到足够显示所有系数位的精度。 如果小数点之后没有数位，则小数点也会被略去，除非使用了 # 选项。
'F' | 定点表示。 与 'f' 相似，但会将 nan 转为 NAN 并将 inf 转为 INF。

'g'

常规格式。 对于给定精度 p >= 1，这会将数值舍入到 p 个有效数位，再将结果以定点表示法或科学计数法进行格式化，具体取决于其值的大小。 精度 0 会被视为等价于精度 1。

准确的规则如下：假设使用表示类型 'e' 和精度 p-1 进行格式化的结果具有指数值 exp。 那么如果 m <= exp < p，其中 m 以 -4 表示浮点值而以 -6 表示 Decimal 值，该数字将使用类型 'f' 和精度 p-1-exp 进行格式化。 否则的话，该数字将使用表示类型 'e' 和精度 p-1 进行格式化。 在两种情况下，都会从有效数字中移除无意义的末尾零，如果小数点之后没有余下数字则小数点也会被移除，除非使用了 '#' 选项。

如未指定精度，会对 float 采用 6 个有效数位的精度。 对于 Decimal，结果的系数会沿用原值的系数数位；对于绝对值小于 1e-6 的值以及最小有效数位的位值大于 1 的数值将会使用科学计数法，在其他情况下则会使用定点表示法。

正负无穷，正负零和 nan 会分别被格式化为 inf, -inf, 0, -0 和 nan，无论精度如何设定。

'G' | 常规格式。 类似于 'g'，不同之处在于当数值非常大时会切换为 'E'。 无穷与 NaN 也会表示为大写形式。
'n' | 数字。 这与 'g' 相似，不同之处在于它会使用当前区域设置来插入适当的数字分隔字符。
'%' | 百分比。 将数字乘以 100 并显示为定点 ('f') 格式，后面带一个百分号。
None | 对于 float 来说这类似于 'g'，不同之处在于当使用定点表示法时，小数点之后将至少显示一位。 所用的精度会大到足以精确表示给定的值。 对于 Decimal 来说这相当于 'g' 或 'G'，具体取决于当前 decimal 上下文的 context.capitals 值。 总体效果是将 str() 的输出匹配为其他格式化因子所调整出的样子。

格式示例

本节包含 str.format() 语法的示例以及与旧式 % 格式化的比较。

该语法在大多数情况下与旧式的 % 格式化类似，只是增加了 {} 和 : 来取代 %。 例如，，'%03.2f' 可以被改写为 '{:03.2f}'。

新的格式语法还支持新增的不同选项，将在以下示例中说明。

按位置访问参数:

>>> '{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')      # unpacking argument sequence
'c, b, a'
>>> '{0}{1}{0}'.format('abra', 'cad')   # arguments' indices can be repeated
'abracadabra'

按名称访问参数:

>>> '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'

访问参数的属性:

>>> 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)'

访问参数的项:

>>> coord = (3, 5)
>>> 'X: {0[0]};  Y: {0[1]}'.format(coord)
'X: 3;  Y: 5'

替代 %s 和 %r:

>>> "repr() shows quotes: {!r}; str() doesn't: {!s}".format('test1', 'test2')
"repr() shows quotes: 'test1'; str() doesn't: test2"

对齐文本以及指定宽度:

>>> '{:<30}'.format('left aligned')
'left aligned                  '
>>> '{:>30}'.format('right aligned')
'                 right aligned'
>>> '{:^30}'.format('centered')
'           centered           '
>>> '{:*^30}'.format('centered')  # use '*' as a fill char
'***********centered***********'

替代 %+f, %-f 和 % f 以及指定正负号:

>>> '{:+f}; {:+f}'.format(3.14, -3.14)  # show it always
'+3.140000; -3.140000'
>>> '{: f}; {: f}'.format(3.14, -3.14)  # show a space for positive numbers
' 3.140000; -3.140000'
>>> '{:-f}; {:-f}'.format(3.14, -3.14)  # show only the minus -- same as '{:f}; {:f}'
'3.140000; -3.140000'

替代 %x 和 %o 以及转换基于不同进位制的值:

>>> # format also supports binary numbers
>>> "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'

使用逗号作为千位分隔符:

>>> '{:,}'.format(1234567890)
'1,234,567,890'

表示为百分数:

>>> points = 19
>>> total = 22
>>> 'Correct answers: {:.2%}'.format(points/total)
'Correct answers: 86.36%'

使用特定类型的专属格式化:

>>> import datetime
>>> d = datetime.datetime(2010, 7, 4, 12, 15, 58)
>>> '{:%Y-%m-%d %H:%M:%S}'.format(d)
'2010-07-04 12:15:58'

嵌套参数以及更复杂的示例:

>>> 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

模板字符串

模板字符串提供了由 PEP 292 [https://www.python.org/dev/peps/pep-0292] 所描述的更简便的字符串替换方式。 模板字符串的一个主要用例是文本国际化 (i18n)，因为在此情境下，更简单的语法和功能使得文本翻译过程比使用 Python 的其他内置字符串格式化工具更方便。 作为基于模板字符串构建以实现 i18n 的库的一个例子，请参看 flufl.i18n [https://flufli18n.readthedocs.io/en/latest/] 包。

模板字符串支持基于 $ 的替换，使用以下规则：

$$ 为转义符号；它会被替换为单个的 $。

$identifier 为替换占位符，它会匹配一个名为 "identifier" 的映射键。 在默认情况下，"identifier" 限制为任意 ASCII 字母数字（包括下划线）组成的字符串，不区分大小写，以下划线或 ASCII 字母开头。 在 $ 字符之后的第一个非标识符字符将表明占位符的终结。

${identifier} 等价于 $identifier。 当占位符之后紧跟着有效的但又不是占位符一部分的标识符字符时需要使用，例如 "${noun}ification"。

在字符串的其他位置出现 $ 将导致引发 ValueError。

string 模块提供了实现这些规则的 Template 类。 Template 有下列方法：

class string.Template(template)

该构造器接受一个参数作为模板字符串。

substitute(mapping={}, /, **kwds)

执行模板替换，返回一个新字符串。 mapping 为任意字典类对象，其中的键将匹配模板中的占位符。 或者你也可以提供一组关键字参数，其中的关键字即对应占位符。 当同时给出 mapping 和 kwds 并且存在重复时，则以 kwds 中的占位符为优先。

safe_substitute(mapping={}, /, **kwds)

类似于 substitute()，不同之处是如果有占位符未在 mapping 和 kwds 中找到，不是引发 KeyError 异常，而是将原始占位符不加修改地显示在结果字符串中。 另一个与 substitute() 的差异是任何在其他情况下出现的 $ 将简单地返回 $ 而不是引发 ValueError。

此方法被认为“安全”，因为虽然仍有可能发生其他异常，但它总是尝试返回可用的字符串而不是引发一个异常。 从另一方面来说，safe_substitute() 也可能根本算不上安全，因为它将静默地忽略错误格式的模板，例如包含多余的分隔符、不成对的花括号或不是合法 Python 标识符的占位符等等。

Template 的实例还提供一个公有数据属性：

template

这是作为构造器的 template 参数被传入的对象。 一般来说，你不应该修改它，但并不强制要求只读访问。

以下是一个如何使用模版的示例：

>>> 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'

进阶用法：你可以派生 Template 的子类来自定义占位符语法、分隔符，或用于解析模板字符串的整个正则表达式。 为此目的，你可以重载这些类属性：

delimiter -- 这是用来表示占位符的起始的分隔符的字符串字面值。 默认值为 $。 请注意此参数 不能 为正则表达式，因为其实现将在必要时对此字符串调用 re.escape()。 还要注意你不能在创建类之后改变此分隔符（例如在子类的类命名空间中必须设置不同的分隔符）。

idpattern -- 这是用来描述不带花括号的占位符的模式的正则表达式。 默认值为正则表达式 (?a:[_a-z][_a-z0-9]*)。 如果给出了此属性并且 braceidpattern 为 None 则此模式也将作用于带花括号的占位符。

注解

由于默认的 flags 为 re.IGNORECASE，模式 [a-z] 可以匹配某些非 ASCII 字符。 因此我们在这里使用了局部旗标 a。

在 3.7 版更改: braceidpattern 可被用来定义对花括号内部和外部进行区分的模式。

braceidpattern -- 此属性类似于 idpattern 但是用来描述带花括号的占位符的模式。 默认值 None 意味着回退到 idpattern (即在花括号内部和外部使用相同的模式)。 如果给出此属性，这将允许你为带花括号和不带花括号的占位符定义不同的模式。

3.7 新版功能.

flags -- 将在编译用于识别替换内容的正则表达式被应用的正则表达式旗标。 默认值为 re.IGNORECASE。 请注意 re.VERBOSE 总是会被加为旗标，因此自定义的 idpattern 必须遵循详细正则表达式的约定。

3.2 新版功能.

作为另一种选项，你可以通过重载类属性 pattern 来提供整个正则表达式模式。 如果你这样做，该值必须为一个具有四个命名捕获组的正则表达式对象。 这些捕获组对应于上面已经给出的规则，以及无效占位符的规则：

escaped -- 这个组匹配转义序列，在默认模式中即 $$。

named -- 这个组匹配不带花括号的占位符名称；它不应当包含捕获组中的分隔符。

braced -- 这个组匹配带有花括号的占位符名称；它不应当包含捕获组中的分隔符或者花括号。

invalid -- 这个组匹配任何其他分隔符模式（通常为单个分隔符），并且它应当出现在正则表达式的末尾。

辅助函数

string.capwords(s, sep=None)

使用 str.split() 将参数拆分为单词，使用 str.capitalize() 将单词转为大写形式，使用 str.join() 将大写的单词进行拼接。 如果可选的第二个参数 sep 被省略或为 None，则连续的空白字符会被替换为单个空格符并且开头和末尾的空白字符会被移除，否则 sep 会被用来拆分和拼接单词。

re --- 正则表达式操作

源代码: Lib/re.py [https://github.com/python/cpython/tree/3.10/Lib/re.py]

本模块提供了与 Perl 语言类似的正则表达式匹配操作。

模式和被搜索的字符串既可以是 Unicode 字符串 (str) ，也可以是8位字节串 (bytes)。 但是，Unicode 字符串与 8 位字节串不能混用：也就是说，不能用字节串模式匹配 Unicode 字符串，反之亦然；同理，替换操作时，替换字符串的类型也必须与所用的模式和搜索字符串的类型一致。

正则表达式使用反斜杠字符 ('\') 来表示特殊形式或允许使用特殊字符而不表达其特殊含义。 这与 Python 为相同目的在字符串字面量中使用相同字符的做法相冲突；例如，要匹配一个反斜杠字面量，我们可能不得不写``'\\'`` 作为模式字符串，因为正则表达式必须是 \\，而每个反斜杠必须在正则 Python 字符串字面量中表示为 \\。 另外，请注意 Python 在字符串字面中使用反斜杠时，任何无效的转义序列现在都会生成 DeprecationWarning ，将来会变成 SyntaxError。 即使它是正则表达式的有效转义序列，这种行为也会发生。

解决办法是对于正则表达式模式（patterns）使用 Python 的原始字符串表示法；在带有 'r' 前缀的字符串字面值中，反斜杠不必做任何特殊处理。 因此 r"\n" 表示包含 '\' 和 'n' 两个字符的字符串，而 "\n" 则表示只包含一个换行符的字符串。 模式在 Python 代码中通常都使用原始字符串表示法。

绝大多数正则表达式操作都提供为模块函数和方法，在 编译正则表达式. 这些函数是一个捷径，不需要先编译正则对象，但是损失了一些优化参数。

参见

第三方模块 regex [https://pypi.org/project/regex/] , 提供了与标准库 re 模块兼容的 API 接口，同时，还提供了更多功能和更全面的 Unicode 支持。

正则表达式语法

正则表达式（或 RE）指定了一组与之匹配的字符串；模块内的函数可以检查某个字符串是否与给定的正则表达式匹配（或者正则表达式是否匹配到字符串，这两种说法含义相同）。

正则表达式可以拼接；如果 A 和 B 都是正则表达式，则 AB 也是正则表达式。通常，如果字符串 p 匹配 A，并且另一个字符串 q 匹配 B，那么 pq 可以匹配 AB。除非 A 或者 B 包含低优先级操作，A 和 B 存在边界条件；或者命名组引用。所以，复杂表达式可以很容易的从这里描述的简单源语表达式构建。更多正则表达式理论和实现，详见 the Friedl book [Frie09] ，或者其他构建编译器的书籍。

以下是正则表达式格式的简要说明。更详细的信息和演示，参考 正则表达式指南。

正则表达式可以包含普通或者特殊字符。绝大部分普通字符，比如 'A', 'a', 或者 '0'，都是最简单的正则表达式。它们就匹配自身。你可以拼接普通字符，所以 last 匹配字符串 'last'. （在这一节的其他部分，我们将用 this special style 这种方式表示正则表达式，通常不带引号，要匹配的字符串用 'in single quotes' ，单引号形式。）

有些字符，比如 '|' 或者 '('，属于特殊字符。 特殊字符既可以表示它的普通含义， 也可以影响它旁边的正则表达式的解释。

重复修饰符 (*, +, ?, {m,n}, 等) 不能直接嵌套。这样避免了非贪婪后缀 ? 修饰符，和其他实现中的修饰符产生的多义性。要应用一个内层重复嵌套，可以使用括号。 比如，表达式 (?:a{6})* 匹配6个 'a' 字符重复任意次数。

特殊字符有：

.

(点号) 在默认模式下，匹配除换行符以外的任意字符。 如果指定了旗标 DOTALL ，它将匹配包括换行符在内的任意字符。

^

(插入符) 匹配字符串的开头， 并且在 MULTILINE 模式下也匹配换行后的首个符号。

$

匹配字符串尾或者在字符串尾的换行符的前一个字符，在 MULTILINE 模式下也会匹配换行符之前的文本。 foo 匹配 'foo' 和 'foobar'，但正则表达式 foo$ 只匹配 'foo'。 更有趣的是，在 'foo1\nfoo2\n' 中搜索 foo.$，通常匹配 'foo2'，但在 MULTILINE 模式下可以匹配到 'foo1'；在 'foo\n' 中搜索 $ 会找到两个（空的）匹配：一个在换行符之前，一个在字符串的末尾。

*

对它前面的正则式匹配0到任意次重复， 尽量多的匹配字符串。 ab* 会匹配 'a'，'ab'，或者 'a' 后面跟随任意个 'b'。

+

对它前面的正则式匹配1到任意次重复。 ab+ 会匹配 'a' 后面跟随1个以上到任意个 'b'，它不会匹配 'a'。

?

对它前面的正则式匹配0到1次重复。 ab? 会匹配 'a' 或者 'ab'。

*?, +?, ??

'*', '+'，和 '?' 修饰符都是 贪婪的；它们在字符串进行尽可能多的匹配。有时候并不需要这种行为。如果正则式 <.*> 希望找到 '<a> b <c>'，它将会匹配整个字符串，而不仅是 '<a>'。在修饰符之后添加 ? 将使样式以 非贪婪`方式或者 :dfn:`最小 方式进行匹配； 尽量 少 的字符将会被匹配。 使用正则式 <.*?> 将会仅仅匹配 '<a>'。

{m}

对其之前的正则式指定匹配 m 个重复；少于 m 的话就会导致匹配失败。比如， a{6} 将匹配6个 'a' , 但是不能是5个。

{m,n}

对正则式进行 m 到 n 次匹配，在 m 和 n 之间取尽量多。 比如，a{3,5} 将匹配 3 到 5个 'a'。忽略 m 意为指定下界为0，忽略 n 指定上界为无限次。 比如 a{4,}b 将匹配 'aaaab' 或者1000个 'a' 尾随一个 'b'，但不能匹配 'aaab'。逗号不能省略，否则无法辨别修饰符应该忽略哪个边界。

{m,n}?

前一个修饰符的非贪婪模式，只匹配尽量少的字符次数。比如，对于 'aaaaaa'， a{3,5} 匹配 5个 'a' ，而 a{3,5}? 只匹配3个 'a'。

\

转义特殊字符（允许你匹配 '*', '?', 或者此类其他），或者表示一个特殊序列；特殊序列之后进行讨论。

如果你没有使用原始字符串（ r'raw' ）来表达样式，要牢记Python也使用反斜杠作为转义序列；如果转义序列不被Python的分析器识别，反斜杠和字符才能出现在字符串中。如果Python可以识别这个序列，那么反斜杠就应该重复两次。这将导致理解障碍，所以高度推荐，就算是最简单的表达式，也要使用原始字符串。

[]

用于表示一个字符集合。在一个集合中：

字符可以单独列出，比如 [amk] 匹配 'a'， 'm'， 或者 'k'。

可以表示字符范围，通过用 '-' 将两个字符连起来。比如 [a-z] 将匹配任何小写ASCII字符， [0-5][0-9] 将匹配从 00 到 59 的两位数字， [0-9A-Fa-f] 将匹配任何十六进制数位。 如果 - 进行了转义 （比如 [a\-z]）或者它的位置在首位或者末尾（如 [-a] 或 [a-]），它就只表示普通字符 '-'。

特殊字符在集合中会失去其特殊意义。比如 [(+*)] 只会匹配这几个字面字符之一 '(', '+', '*', or ')'。

字符类如 \w 或者 \S (如下定义) 在集合内可以接受，它们可以匹配的字符由 ASCII 或者 LOCALE 模式决定。

不在集合范围内的字符可以通过 取反 来进行匹配。如果集合首字符是 '^' ，所有 不 在集合内的字符将会被匹配，比如 [^5] 将匹配所有字符，除了 '5'， [^^] 将匹配所有字符，除了 '^'. ^ 如果不在集合首位，就没有特殊含义。

要在集合内匹配一个 ']' 字面值，可以在它前面加上反斜杠，或是将它放到集合的开头。 例如，[()[\]{}] 和 []()[{}] 都可以匹配右方括号，以及左方括号，花括号和圆括号。

Unicode Technical Standard #18 [https://unicode.org/reports/tr18/] 里的嵌套集合和集合操作支持可能在未来添加。这将会改变语法，所以为了帮助这个改变，一个 FutureWarning 将会在有多义的情况里被 raise，包含以下几种情况，集合由 '[' 开始，或者包含下列字符序列 '--', '&&', '~~', 和 '||'。为了避免警告，需要将它们用反斜杠转义。

在 3.7 版更改: 如果一个字符串构建的语义在未来会改变的话，一个 FutureWarning 会 raise 。

|

A|B， A 和 B 可以是任意正则表达式，创建一个正则表达式，匹配 A 或者 B. 任意个正则表达式可以用 '|' 连接。它也可以在组合（见下列）内使用。扫描目标字符串时， '|' 分隔开的正则样式从左到右进行匹配。当一个样式完全匹配时，这个分支就被接受。意思就是，一旦 A 匹配成功， B 就不再进行匹配，即便它能产生一个更好的匹配。或者说，'|' 操作符绝不贪婪。 如果要匹配 '|' 字符，使用 \|， 或者把它包含在字符集里，比如 [|].

(...)

（组合），匹配括号内的任意正则表达式，并标识出组合的开始和结尾。匹配完成后，组合的内容可以被获取，并可以在之后用 \number 转义序列进行再次匹配，之后进行详细说明。要匹配字符 '(' 或者 ')', 用 \( 或 \), 或者把它们包含在字符集合里: [(], [)].

(?…)

这是个扩展标记法 （一个 '?' 跟随 '(' 并无含义）。 '?' 后面的第一个字符决定了这个构建采用什么样的语法。这种扩展通常并不创建新的组合； (?P<name>...) 是唯一的例外。 以下是目前支持的扩展。

(?aiLmsux)

( 'a', 'i', 'L', 'm', 's', 'u', 'x' 中的一个或多个) 这个组合匹配一个空字符串；这些字符对正则表达式设置以下标记 re.A (只匹配ASCII字符), re.I (忽略大小写), re.L (语言依赖), re.M (多行模式), re.S (点dot匹配全部字符), re.U (Unicode匹配), and re.X (冗长模式)。 (这些标记在 模块内容 中描述) 如果你想将这些标记包含在正则表达式中，这个方法就很有用，免去了在 re.compile() 中传递 flag 参数。标记应该在表达式字符串首位表示。

(?:…)

正则括号的非捕获版本。 匹配在括号内的任何正则表达式，但该分组所匹配的子字符串 不能 在执行匹配后被获取或是之后在模式中被引用。

(?aiLmsux-imsx:…)

('a', 'i', 'L', 'm', 's', 'u', 'x' 中的0或者多个， 之后可选跟随 '-' 在后面跟随 'i' , 'm' , 's' , 'x' 中的一到多个 .) 这些字符为表达式的其中一部分 设置 或者 去除 相应标记 re.A (只匹配ASCII), re.I (忽略大小写), re.L (语言依赖), re.M (多行), re.S (点匹配所有字符), re.U (Unicode匹配), and re.X (冗长模式)。(标记描述在 模块内容 .)

'a', 'L' and 'u' 作为内联标记是相互排斥的， 所以它们不能结合在一起，或者跟随 '-' 。 当他们中的某个出现在内联组中，它就覆盖了括号组内的匹配模式。在Unicode样式中， (?a:...) 切换为 只匹配ASCII， (?u:...) 切换为Unicode匹配 (默认). 在byte样式中 (?L:...) 切换为语言依赖模式， (?a:...) 切换为 只匹配ASCII (默认)。这种方式只覆盖组合内匹配，括号外的匹配模式不受影响。

3.6 新版功能.

在 3.7 版更改: 符号 'a', 'L' 和 'u' 同样可以用在一个组合内。

(?P<name>…)

（命名组合）类似正则组合，但是匹配到的子串组在外部是通过定义的 name 来获取的。组合名必须是有效的Python标识符，并且每个组合名只能用一个正则表达式定义，只能定义一次。一个符号组合同样是一个数字组合，就像这个组合没有被命名一样。

命名组合可以在三种上下文中引用。如果样式是 (?P<quote>['"]).*?(?P=quote) （也就是说，匹配单引号或者双引号括起来的字符串)：

引用组合 "quote" 的上下文 | 引用方法
在正则式自身内 | (?P=quote) (如示) \1
处理匹配对象 m | m.group('quote') m.end('quote') (等)
传递到 re.sub() 里的 repl 参数中 | \g<quote> \g<1> \1

(?P=name)

反向引用一个命名组合；它匹配前面那个叫 name 的命名组中匹配到的串同样的字串。

(?#…)

注释；里面的内容会被忽略。

(?=…)

当 … 匹配时，匹配成功，但不消耗字符串中的任何字符。这个叫做 前视断言 （lookahead assertion）。比如， Isaac (?=Asimov) 将会匹配 'Isaac ' ，仅当其后紧跟 'Asimov' 。

(?!…)

当 … 不匹配时，匹配成功。这个叫 否定型前视断言 （negative lookahead assertion）。例如， Isaac (?!Asimov) 将会匹配 'Isaac ' ，仅当它后面 不是 'Asimov' 。

(?<=…)

如果 ... 的匹配内容出现在当前位置的左侧，则匹配。这叫做 肯定型后视断言 （positive lookbehind assertion）。 (?<=abc)def 将会在 'abcdef' 中找到一个匹配，因为后视会回退3个字符并检查内部表达式是否匹配。内部表达式（匹配的内容）必须是固定长度的，意思就是 abc 或 a|b 是允许的，但是 a* 和 a{3,4} 不可以。注意，以肯定型后视断言开头的正则表达式，匹配项一般不会位于搜索字符串的开头。很可能你应该使用 search() 函数，而不是 match() 函数：

>>> import re
>>> m = re.search('(?<=abc)def', 'abcdef')
>>> m.group(0)
'def'

这个例子搜索一个跟随在连字符后的单词：

>>> m = re.search(r'(?<=-)\w+', 'spam-egg')
>>> m.group(0)
'egg'

在 3.5 版更改: 添加定长组合引用的支持。

(?<!…)

如果 ... 的匹配内容没有出现在当前位置的左侧，则匹配。这个叫做 否定型后视断言 （negative lookbehind assertion）。类似于肯定型后视断言，内部表达式（匹配的内容）必须是固定长度的。以否定型后视断言开头的正则表达式，匹配项可能位于搜索字符串的开头。

(?(id/name)yes-pattern|no-pattern)

如果给定的 id 或 name 存在，将会尝试匹配 yes-pattern ，否则就尝试匹配 no-pattern，no-pattern 可选，也可以被忽略。比如， (<)?(\w+@\w+(?:\.\w+)+)(?(1)>|$) 是一个email样式匹配，将匹配 '<user@host.com>' 或 'user@host.com' ，但不会匹配 '<user@host.com' ，也不会匹配 'user@host.com>'。

由 '\' 和一个字符组成的特殊序列在以下列出。 如果普通字符不是ASCII数位或者ASCII字母，那么正则样式将匹配第二个字符。比如，\$ 匹配字符 '$'.

\number

匹配数字代表的组合。每个括号是一个组合，组合从1开始编号。比如 (.+) \1 匹配 'the the' 或者 '55 55', 但不会匹配 'thethe' (注意组合后面的空格)。这个特殊序列只能用于匹配前面99个组合。如果 number 的第一个数位是0， 或者 number 是三个八进制数，它将不会被看作是一个组合，而是八进制的数字值。在 '[' 和 ']' 字符集合内，任何数字转义都被看作是字符。

\A

只匹配字符串开始。

\b

匹配空字符串，但只在单词开始或结尾的位置。一个单词被定义为一个单词字符的序列。注意，通常 \b 定义为 \w 和 \W 字符之间，或者 \w 和字符串开始/结尾的边界， 意思就是 r'\bfoo\b' 匹配 'foo', 'foo.', '(foo)', 'bar foo baz' 但不匹配 'foobar' 或者 'foo3'。

默认情况下，Unicode字母和数字是在Unicode样式中使用的，但是可以用 ASCII 标记来更改。如果 LOCALE 标记被设置的话，词的边界是由当前语言区域设置决定的，\b 表示退格字符，以便与Python字符串文本兼容。

\B

匹配空字符串，但 不 能在词的开头或者结尾。意思就是 r'py\B' 匹配 'python', 'py3', 'py2', 但不匹配 'py', 'py.', 或者 'py!'. \B 是 \b 的取非，所以Unicode样式的词语是由Unicode字母，数字或下划线构成的，虽然可以用 ASCII 标志来改变。如果使用了 LOCALE 标志，则词的边界由当前语言区域设置。

\d

对于 Unicode (str) 样式：

匹配任何Unicode十进制数（就是在Unicode字符目录[Nd]里的字符）。这包括了 [0-9] ，和很多其他的数字字符。如果设置了 ASCII 标志，就只匹配 [0-9] 。

对于8位(bytes)样式：

匹配任何十进制数，就是 [0-9]。

\D

匹配任何非十进制数字的字符。就是 \d 取非。 如果设置了 ASCII 标志，就相当于 [^0-9] 。

\s

对于 Unicode (str) 样式：

匹配任何Unicode空白字符（包括 [ \t\n\r\f\v] ，还有很多其他字符，比如不同语言排版规则约定的不换行空格）。如果 ASCII 被设置，就只匹配 [ \t\n\r\f\v] 。

对于8位(bytes)样式：

匹配ASCII中的空白字符，就是 [ \t\n\r\f\v] 。

\S

匹配任何非空白字符。就是 \s 取非。如果设置了 ASCII 标志，就相当于 [^ \t\n\r\f\v] 。

\w

对于 Unicode (str) 样式：

匹配 Unicode 单词类字符；这包括字母数字字符 (如 str.isalnum() 所定义的) 以及下划线 (_)。 如果使用了 ASCII 旗标，则将只匹配 [a-zA-Z0-9_]。

对于8位(bytes)样式：

匹配ASCII字符中的数字和字母和下划线，就是 [a-zA-Z0-9_] 。如果设置了 LOCALE 标记，就匹配当前语言区域的数字和字母和下划线。

\W

匹配非单词字符的字符。这与 \w 正相反。如果使用了 ASCII 旗标，这就等价于 [^a-zA-Z0-9_]。如果使用了 LOCALE 旗标，则会匹配当前区域中既非字母数字也非下划线的字符。

\Z

只匹配字符串尾。

绝大部分Python的标准转义字符也被正则表达式分析器支持。:

\a      \b      \f      \n
\N      \r      \t      \u
\U      \v      \x      \\

（注意 \b 被用于表示词语的边界，它只在字符集合内表示退格，比如 [\b] 。）

'\u', '\U' 和 '\N' 转义序列只在 Unicode 模式中可被识别。 在 bytes 模式中它们会导致错误。 未知的 ASCII 字母转义序列保留在未来使用，会被当作错误来处理。

八进制转义包含为一个有限形式。如果首位数字是 0， 或者有三个八进制数位，那么就认为它是八进制转义。其他的情况，就看作是组引用。对于字符串文本，八进制转义最多有三个数位长。

在 3.3 版更改: 增加了 '\u' 和 '\U' 转义序列。

在 3.6 版更改: 由 '\' 和一个ASCII字符组成的未知转义会被看成错误。

在 3.8 版更改: 添加了 '\N{name}' 转义序列。 与在字符串字面值中一样，它扩展了命名 Unicode 字符 (例如 '\N{EM DASH}')。

模块内容

模块定义了几个函数、常量，和一个异常。有些函数是编译后的正则表达式方法的简化版本（少了一些特性）。重要的应用程序大多会在使用前先编译正则表达式。

标志

在 3.6 版更改: 标志常量现在是 RegexFlag 类的实例，这个类是 enum.IntFlag 的子类。

re.A

re.ASCII

让 \w, \W, \b, \B, \d, \D, \s 和 \S 只匹配ASCII，而不是Unicode。这只对Unicode样式有效，会被byte样式忽略。相当于前面语法中的内联标志 (?a) 。

注意，为了保持向后兼容， re.U 标记依然存在（还有他的同义 re.UNICODE 和嵌入形式 (?u) ) ， 但是这些在 Python 3 是冗余的，因为默认字符串已经是Unicode了（并且Unicode匹配不允许byte出现)。

re.DEBUG

显示编译时的debug信息，没有内联标记。

re.I

re.IGNORECASE

进行忽略大小写匹配；表达式如 [A-Z] 也会匹配小写字符。Unicode匹配（比如 Ü 匹配 ü）同样有用，除非设置了 re.ASCII 标记来禁用非ASCII匹配。当前语言区域不会改变这个标记，除非设置了 re.LOCALE 标记。这个相当于内联标记 (?i) 。

注意，当设置了 IGNORECASE 标记，搜索Unicode样式 [a-z] 或 [A-Z] 的结合时，它将会匹配52个ASCII字符和4个额外的非ASCII字符： 'İ' (U+0130, 拉丁大写的 I 带个点在上面), 'ı' (U+0131, 拉丁小写没有点的 I ), 'ſ' (U+017F, 拉丁小写长 s) and 'K' (U+212A, 开尔文符号).如果使用 ASCII 标记，就只匹配 'a' 到 'z' 和 'A' 到 'Z' 。

re.L

re.LOCALE

由当前语言区域决定 \w, \W, \b, \B 和大小写敏感匹配。这个标记只能对byte样式有效。这个标记不推荐使用，因为语言区域机制很不可靠，它一次只能处理一个 "习惯”，而且只对8位字节有效。Unicode匹配在Python 3 里默认启用，并可以处理不同语言。 这个对应内联标记 (?L) 。

在 3.6 版更改: re.LOCALE 只能用于byte样式，而且不能和 re.ASCII 一起用。

在 3.7 版更改: 设置了 re.LOCALE 标记的编译正则对象不再在编译时依赖语言区域设置。语言区域设置只在匹配的时候影响其结果。

re.M

re.MULTILINE

设置以后，样式字符 '^' 匹配字符串的开始，和每一行的开始（换行符后面紧跟的符号）；样式字符 '$' 匹配字符串尾，和每一行的结尾（换行符前面那个符号）。默认情况下，’^’ 匹配字符串头，'$' 匹配字符串尾。对应内联标记 (?m) 。

re.S

re.DOTALL

让 '.' 特殊字符匹配任何字符，包括换行符；如果没有这个标记，'.' 就匹配 除了 换行符的其他任意字符。对应内联标记 (?s) 。

re.X

re.VERBOSE

这个旗标允许你通过在视觉上分隔表达式的逻辑段落和添加注释来编写更为友好并更具可读性的正则表达式。 表达式中的空白符会被忽略，除非是在字符类中，或前面有一个未转义的反斜杠，或者是在 *?, (?: 或 (?P<...> 等形符之内。 例如，(? : 和 * ? 是不被允许的。 当一个行内包含不在字符类中并且前面没有未转义反斜杠的 # 时，则从最左边的此 # 直至行尾的所有字符都会被忽略。

意思就是下面两个正则表达式等价地匹配一个十进制数字：

a = re.compile(r"""\d +  # the integral part
                   \.    # the decimal point
                   \d *  # some fractional digits""", re.X)
b = re.compile(r"\d+\.\d*")

对应内联标记 (?x) 。

函数

re.compile(pattern, flags=0)

将正则表达式的样式编译为一个 正则表达式对象 （正则对象），可以用于匹配，通过这个对象的方法 match(), search() 以及其他如下描述。

这个表达式的行为可以通过指定 标记 的值来改变。值可以是以下任意变量，可以通过位的OR操作来结合（ | 操作符）。

序列

prog = re.compile(pattern)
result = prog.match(string)

等价于

result = re.match(pattern, string)

如果需要多次使用这个正则表达式的话，使用 re.compile() 和保存这个正则对象以便复用，可以让程序更加高效。

注解

通过 re.compile() 编译后的样式，和模块级的函数会被缓存， 所以少数的正则表达式使用无需考虑编译的问题。

re.search(pattern, string, flags=0)

扫描整个 字符串 找到匹配样式的第一个位置，并返回一个相应的 匹配对象。如果没有匹配，就返回一个 None ； 注意这和找到一个零长度匹配是不同的。

re.match(pattern, string, flags=0)

如果 string 开始的0或者多个字符匹配到了正则表达式样式，就返回一个相应的 匹配对象 。 如果没有匹配，就返回 None ；注意它跟零长度匹配是不同的。

注意即便是 MULTILINE 多行模式， re.match() 也只匹配字符串的开始位置，而不匹配每行开始。

如果你想定位 string 的任何位置，使用 search() 来替代（也可参考 search() vs. match() ）

re.fullmatch(pattern, string, flags=0)

如果整个 string 匹配到正则表达式样式，就返回一个相应的 匹配对象 。 否则就返回一个 None ；注意这跟零长度匹配是不同的。

3.4 新版功能.

re.split(pattern, string, maxsplit=0, flags=0)

用 pattern 分开 string 。 如果在 pattern 中捕获到括号，那么所有的组里的文字也会包含在列表里。如果 maxsplit 非零， 最多进行 maxsplit 次分隔， 剩下的字符全部返回到列表的最后一个元素。

>>> re.split(r'\W+', 'Words, words, words.')
['Words', 'words', 'words', '']
>>> re.split(r'(\W+)', 'Words, words, words.')
['Words', ', ', 'words', ', ', 'words', '.', '']
>>> re.split(r'\W+', 'Words, words, words.', 1)
['Words', 'words, words.']
>>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE)
['0', '3', '9']

如果分隔符里有捕获组合，并且匹配到字符串的开始，那么结果将会以一个空字符串开始。对于结尾也是一样

>>> re.split(r'(\W+)', '...words, words...')
['', '...', 'words', ', ', 'words', '...', '']

这样的话，分隔组将会出现在结果列表中同样的位置。

样式的空匹配仅在与前一个空匹配不相邻时才会拆分字符串。

>>> re.split(r'\b', 'Words, words, words.')
['', 'Words', ', ', 'words', ', ', 'words', '.']
>>> re.split(r'\W*', '...words...')
['', '', 'w', 'o', 'r', 'd', 's', '', '']
>>> re.split(r'(\W*)', '...words...')
['', '...', '', '', 'w', '', 'o', '', 'r', '', 'd', '', 's', '...', '', '', '']

在 3.1 版更改: 增加了可选标记参数。

在 3.7 版更改: 增加了空字符串的样式分隔。

re.findall(pattern, string, flags=0)

返回 pattern 在 string 中的所有非重叠匹配，以字符串列表或字符串元组列表的形式。对 string 的扫描从左至右，匹配结果按照找到的顺序返回。 空匹配也包括在结果中。

返回结果取决于模式中捕获组的数量。如果没有组，返回与整个模式匹配的字符串列表。如果有且仅有一个组，返回与该组匹配的字符串列表。如果有多个组，返回与这些组匹配的字符串元组列表。非捕获组不影响结果。

>>> 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')]

在 3.7 版更改: 非空匹配现在可以在前一个空匹配之后出现了。

re.finditer(pattern, string, flags=0)

pattern 在 string 里所有的非重复匹配，返回为一个迭代器 iterator 保存了 匹配对象 。 string 从左到右扫描，匹配按顺序排列。空匹配也包含在结果里。

在 3.7 版更改: 非空匹配现在可以在前一个空匹配之后出现了。

re.sub(pattern, repl, string, count=0, flags=0)

返回通过使用 repl 替换在 string 最左边非重叠出现的 pattern 而获得的字符串。 如果样式没有找到，则不加改变地返回 string。 repl 可以是字符串或函数；如为字符串，则其中任何反斜杠转义序列都会被处理。 也就是说，\n 会被转换为一个换行符，\r 会被转换为一个回车符，依此类推。 未知的 ASCII 字符转义序列保留在未来使用，会被当作错误来处理。 其他未知转义序列例如 \& 会保持原样。 向后引用像是 \6 会用样式中第 6 组所匹配到的子字符串来替换。 例如:

>>> 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{'

如果 repl 是一个函数，那它会对每个非重复的 pattern 的情况调用。这个函数只能有一个 匹配对象 参数，并返回一个替换后的字符串。比如

>>> 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'

样式可以是一个字符串或者一个 样式对象 。

可选参数 count 是要替换的最大次数；count 必须是非负整数。如果省略这个参数或设为 0，所有的匹配都会被替换。 样式的空匹配仅在与前一个空匹配不相邻时才会被替换，所以 sub('x*', '-', 'abxd') 返回 '-a-b--d-' 。

在字符串类型的 repl 参数里，如上所述的转义和向后引用中，\g<name> 会使用命名组合 name，（在 (?P<name>…) 语法中定义） \g<number> 会使用数字组；\g<2> 就是 \2，但它避免了二义性，如 \g<2>0。 \20 就会被解释为组20，而不是组2后面跟随一个字符 '0'。向后引用 \g<0> 把 pattern 作为一整个组进行引用。

在 3.1 版更改: 增加了可选标记参数。

在 3.5 版更改: 不匹配的组合替换为空字符串。

在 3.6 版更改: pattern 中的未知转义（由 '\' 和一个 ASCII 字符组成）被视为错误。

在 3.7 版更改: repl 中的未知转义（由 '\' 和一个 ASCII 字符组成）被视为错误。

在 3.7 版更改: 样式中的空匹配相邻接时会被替换。

re.subn(pattern, repl, string, count=0, flags=0)

行为与 sub() 相同，但是返回一个元组 (字符串, 替换次数).

在 3.1 版更改: 增加了可选标记参数。

在 3.5 版更改: 不匹配的组合替换为空字符串。

re.escape(pattern)

转义 pattern 中的特殊字符。如果你想对任意可能包含正则表达式元字符的文本字符串进行匹配，它就是有用的。比如

>>> 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))))
/|\-|\+|\*\*|\*

这个函数不能被用于 sub() 和 subn() 的替换字符串，只有反斜杠应该被转义。 例如:

>>> 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

在 3.3 版更改: '_' 不再被转义。

在 3.7 版更改: 只有在正则表达式中具有特殊含义的字符才会被转义。 因此， '!', '"', '%', "'", ',', '/', ':', ';', '<', '=', '>', '@' 和 "`" 将不再会被转义。

re.purge()

清除正则表达式的缓存。

异常

exception re.error(msg, pattern=None, pos=None)

当传递给函数的正则表达式不合法（比如括号不匹配），或者在编译或匹配过程中出现其他错误时，会引发异常。所给字符串不匹配所给模式不会引发异常。异常实例有以下附加属性：

msg

未格式化的错误消息。

pattern

正则表达式的模式串。

pos

编译失败的 pattern 的位置索引（可以是 None ）。

lineno

对应 pos (可以是 None) 的行号。

colno

对应 pos (可以是 None) 的列号。

在 3.5 版更改: 增加了额外的属性。

正则表达式对象 （正则对象）

编译后的正则表达式对象支持以下方法和属性：

Pattern.search(string[, pos[, endpos]])

扫描整个 string 寻找第一个匹配的位置， 并返回一个相应的 匹配对象。如果没有匹配，就返回 None ；注意它和零长度匹配是不同的。

可选的第二个参数 pos 给出了字符串中开始搜索的位置索引；默认为 0，它不完全等价于字符串切片； '^' 样式字符匹配字符串真正的开头，和换行符后面的第一个字符，但不会匹配索引规定开始的位置。

可选参数 endpos 限定了字符串搜索的结束；它假定字符串长度到 endpos ， 所以只有从 pos 到 endpos - 1 的字符会被匹配。如果 endpos 小于 pos，就不会有匹配产生；另外，如果 rx 是一个编译后的正则对象， rx.search(string, 0, 50) 等价于 rx.search(string[:50], 0)。

>>> pattern = re.compile("d")
>>> pattern.search("dog")     # Match at index 0
<re.Match object; span=(0, 1), match='d'>
>>> pattern.search("dog", 1)  # No match; search doesn't include the "d"

Pattern.match(string[, pos[, endpos]])

如果 string 的 开始位置 能够找到这个正则样式的任意个匹配，就返回一个相应的 匹配对象。如果不匹配，就返回 None ；注意它与零长度匹配是不同的。

可选参数 pos 和 endpos 与 search() 含义相同。

>>> pattern = re.compile("o")
>>> pattern.match("dog")      # No match as "o" is not at the start of "dog".
>>> pattern.match("dog", 1)   # Match as "o" is the 2nd character of "dog".
<re.Match object; span=(1, 2), match='o'>

如果你想定位匹配在 string 中的位置，使用 search() 来替代（另参考 search() vs. match()）。

Pattern.fullmatch(string[, pos[, endpos]])

如果整个 string 匹配这个正则表达式，就返回一个相应的 匹配对象 。 否则就返回 None ； 注意跟零长度匹配是不同的。

可选参数 pos 和 endpos 与 search() 含义相同。

>>> pattern = re.compile("o[gh]")
>>> pattern.fullmatch("dog")      # No match as "o" is not at the start of "dog".
>>> pattern.fullmatch("ogre")     # No match as not the full string matches.
>>> pattern.fullmatch("doggie", 1, 3)   # Matches within given limits.
<re.Match object; span=(1, 3), match='og'>

3.4 新版功能.

Pattern.split(string, maxsplit=0)

等价于 split() 函数，使用了编译后的样式。

Pattern.findall(string[, pos[, endpos]])

类似函数 findall() ， 使用了编译后样式，但也可以接收可选参数 pos 和 endpos ，限制搜索范围，就像 search()。

Pattern.finditer(string[, pos[, endpos]])

类似函数 finditer() ， 使用了编译后样式，但也可以接收可选参数 pos 和 endpos ，限制搜索范围，就像 search()。

Pattern.sub(repl, string, count=0)

等价于 sub() 函数，使用了编译后的样式。

Pattern.subn(repl, string, count=0)

等价于 subn() 函数，使用了编译后的样式。

Pattern.flags

正则匹配标记。这是可以传递给 compile() 的参数，任何 (?…) 内联标记，隐性标记比如 UNICODE 的结合。

Pattern.groups

捕获到的模式串中组的数量。

Pattern.groupindex

映射由 (?P<id>) 定义的命名符号组合和数字组合的字典。如果没有符号组，那字典就是空的。

Pattern.pattern

编译对象的原始样式字符串。

在 3.7 版更改: 添加 copy.copy() 和 copy.deepcopy() 函数的支持。编译后的正则表达式对象被认为是原子性的。

匹配对象

匹配对象总是有一个布尔值 True。如果没有匹配的话 match() 和 search() 返回 None 所以你可以简单的用 if 语句来判断是否匹配

match = re.search(pattern, string)
if match:
    process(match)

匹配对象支持以下方法和属性：

Match.expand(template)

对 template 进行反斜杠转义替换并且返回，就像 sub() 方法中一样。转义如同 \n 被转换成合适的字符，数字引用(\1, \2)和命名组合(\g<1>, \g<name>) 替换为相应组合的内容。

在 3.5 版更改: 不匹配的组合替换为空字符串。

Match.group([group1, ...])

返回一个或者多个匹配的子组。如果只有一个参数，结果就是一个字符串，如果有多个参数，结果就是一个元组（每个参数对应一个项），如果没有参数，组1默认到0（整个匹配都被返回）。 如果一个组N 参数值为 0，相应的返回值就是整个匹配字符串；如果它是一个范围 [1..99]，结果就是相应的括号组字符串。如果一个组号是负数，或者大于样式中定义的组数，就引发一个 IndexError 异常。如果一个组包含在样式的一部分，并被匹配多次，就返回最后一个匹配。:

>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
>>> m.group(0)       # The entire match
'Isaac Newton'
>>> m.group(1)       # The first parenthesized subgroup.
'Isaac'
>>> m.group(2)       # The second parenthesized subgroup.
'Newton'
>>> m.group(1, 2)    # Multiple arguments give us a tuple.
('Isaac', 'Newton')

如果正则表达式使用了 (?P<name>...) 语法， groupN 参数就也可能是命名组合的名字。如果一个字符串参数在样式中未定义为组合名，就引发一个 IndexError 异常。

一个相对复杂的例子

>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
>>> m.group('first_name')
'Malcolm'
>>> m.group('last_name')
'Reynolds'

命名组合同样可以通过索引值引用

>>> m.group(1)
'Malcolm'
>>> m.group(2)
'Reynolds'

如果一个组匹配成功多次，就只返回最后一个匹配

>>> m = re.match(r"(..)+", "a1b2c3")  # Matches 3 times.
>>> m.group(1)                        # Returns only the last match.
'c3'

Match.__getitem__(g)

这个等价于 m.group(g)。这允许更方便的引用一个匹配

>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
>>> m[0]       # The entire match
'Isaac Newton'
>>> m[1]       # The first parenthesized subgroup.
'Isaac'
>>> m[2]       # The second parenthesized subgroup.
'Newton'

3.6 新版功能.

Match.groups(default=None)

返回一个元组，包含所有匹配的子组，在样式中出现的从1到任意多的组合。 default 参数用于不参与匹配的情况，默认为 None。

例如：

>>> m = re.match(r"(\d+)\.(\d+)", "24.1632")
>>> m.groups()
('24', '1632')

如果我们使小数点可选，那么不是所有的组都会参与到匹配当中。这些组合默认会返回一个 None ，除非指定了 default 参数。

>>> m = re.match(r"(\d+)\.?(\d+)?", "24")
>>> m.groups()      # Second group defaults to None.
('24', None)
>>> m.groups('0')   # Now, the second group defaults to '0'.
('24', '0')

Match.groupdict(default=None)

返回一个字典，包含了所有的 命名 子组。key就是组名。 default 参数用于不参与匹配的组合；默认为 None。 例如

>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
>>> m.groupdict()
{'first_name': 'Malcolm', 'last_name': 'Reynolds'}

Match.start([group])

Match.end([group])

返回 group 匹配到的字串的开始和结束标号。group 默认为0（意思是整个匹配的子串）。如果 group 存在，但未产生匹配，就返回 -1 。对于一个匹配对象 m， 和一个未参与匹配的组 g ，组 g (等价于 m.group(g))产生的匹配是

m.string[m.start(g):m.end(g)]

注意 m.start(group) 将会等于 m.end(group) ，如果 group 匹配一个空字符串的话。比如，在 m = re.search('b(c?)', 'cba') 之后，m.start(0) 为 1, m.end(0) 为 2, m.start(1) 和 m.end(1) 都是 2, m.start(2) 引发一个 IndexError 异常。

这个例子会从email地址中移除掉 remove_this

>>> email = "tony@tiremove_thisger.net"
>>> m = re.search("remove_this", email)
>>> email[:m.start()] + email[m.end():]
'tony@tiger.net'

Match.span([group])

对于一个匹配 m ， 返回一个二元组 (m.start(group), m.end(group)) 。 注意如果 group 没有在这个匹配中，就返回 (-1, -1) 。group 默认为0，就是整个匹配。

Match.pos

pos 的值，会传递给 search() 或 match() 的方法 a 正则对象 。这个是正则引擎开始在字符串搜索一个匹配的索引位置。

Match.endpos

endpos 的值，会传递给 search() 或 match() 的方法 a 正则对象 。这个是正则引擎停止在字符串搜索一个匹配的索引位置。

Match.lastindex

捕获组的最后一个匹配的整数索引值，或者 None 如果没有匹配产生的话。比如，对于字符串 'ab'，表达式 (a)b, ((a)(b)), 和 ((ab)) 将得到 lastindex == 1 ， 而 (a)(b) 会得到 lastindex == 2 。

Match.lastgroup

最后一个匹配的命名组名字，或者 None 如果没有产生匹配的话。

Match.re

返回产生这个实例的 正则对象 ， 这个实例是由 正则对象的 match() 或 search() 方法产生的。

Match.string

传递到 match() 或 search() 的字符串。

在 3.7 版更改: 添加了对 copy.copy() 和 copy.deepcopy() 的支持。匹配对象被看作是原子性的。

正则表达式例子

检查对子

在这个例子里，我们使用以下辅助函数来更好地显示匹配对象:

def displaymatch(match):
    if match is None:
        return None
    return '<Match: %r, groups=%r>' % (match.group(), match.groups())

假设你在写一个扑克程序，一个玩家的一手牌为五个字符的串，每个字符表示一张牌，"a" 就是 A, "k" K， "q" Q, "j" J, "t" 为 10, "2" 到 "9" 表示2 到 9。

要看给定的字符串是否有效，我们可以按照以下步骤

>>> valid = re.compile(r"^[a2-9tjqk]{5}$")
>>> displaymatch(valid.match("akt5q"))  # Valid.
"<Match: 'akt5q', groups=()>"
>>> displaymatch(valid.match("akt5e"))  # Invalid.
>>> displaymatch(valid.match("akt"))    # Invalid.
>>> displaymatch(valid.match("727ak"))  # Valid.
"<Match: '727ak', groups=()>"

最后一手牌，"727ak" ，包含了一个对子，或者两张同样数值的牌。要用正则表达式匹配它，应该使用向后引用如下

>>> pair = re.compile(r".*(.).*\1")
>>> displaymatch(pair.match("717ak"))     # Pair of 7s.
"<Match: '717', groups=('7',)>"
>>> displaymatch(pair.match("718ak"))     # No pairs.
>>> displaymatch(pair.match("354aa"))     # Pair of aces.
"<Match: '354aa', groups=('a',)>"

要找出对子由什么牌组成，开发者可以按照下面的方式来使用匹配对象的 group() 方法:

>>> pair = re.compile(r".*(.).*\1")
>>> pair.match("717ak").group(1)
'7'

# Error because re.match() returns None, which doesn't have a group() method:
>>> 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'

模拟 scanf()

Python 目前没有一个类似c函数 scanf() 的替代品。正则表达式通常比 scanf() 格式字符串要更强大一些，但也带来更多复杂性。下面的表格提供了 scanf() 格式符和正则表达式大致相同的映射。

scanf() 格式符 | 正则表达式
%c | .
%5c | .{5}
%d | [-+]?\d+
%e, %E, %f, %g | [-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?
%i | [-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)
%o | [-+]?[0-7]+
%s | \S+
%u | \d+
%x, %X | [-+]?(0[xX])?[\dA-Fa-f]+

从文件名和数字提取字符串

/usr/sbin/sendmail - 0 errors, 4 warnings

你可以使用 scanf() 格式化

%s - %d errors, %d warnings

等价的正则表达式是：

(\S+) - (\d+) errors, (\d+) warnings

search() vs. match()

Python 基于正则表达式提供了不同的原始操作:

re.match() 只在字符串的开头位置检测匹配。

re.search() 在字符串中的任何位置检测匹配（这也是 Perl 在默认情况下所做的）

re.fullmatch() 检测整个字符串是否匹配

例如：

>>> re.match("c", "abcdef")    # No match
>>> re.search("c", "abcdef")   # Match
<re.Match object; span=(2, 3), match='c'>
>>> re.fullmatch("p.*n", "python") # Match
<re.Match object; span=(0, 6), match='python'>
>>> re.fullmatch("r.*n", "python") # No match

在 search() 中，可以用 '^' 作为开始来限制匹配到字符串的首位

>>> re.match("c", "abcdef")    # No match
>>> re.search("^c", "abcdef")  # No match
>>> re.search("^a", "abcdef")  # Match
<re.Match object; span=(0, 1), match='a'>

注意 MULTILINE 多行模式中函数 match() 只匹配字符串的开始，但使用 search() 和以 '^' 开始的正则表达式会匹配每行的开始

>>> re.match("X", "A\nB\nX", re.MULTILINE)  # No match
>>> re.search("^X", "A\nB\nX", re.MULTILINE)  # Match
<re.Match object; span=(4, 5), match='X'>

制作一个电话本

split() 将字符串用参数传递的样式分隔开。这个方法对于转换文本数据到易读而且容易修改的数据结构，是很有用的，如下面的例子证明。

首先，这里是输入。 它通常来自一个文件，这里我们使用三重引号字符串语法

>>> 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"""

条目用一个或者多个换行符分开。现在我们将字符串转换为一个列表，每个非空行都有一个条目:

>>> 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']

最终，将每个条目分割为一个由名字、姓氏、电话号码和地址组成的列表。我们为 split() 使用了 maxsplit 形参，因为地址中包含有被我们作为分割模式的空格符:

>>> [re.split(":? ", entry, 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']]

:? 样式匹配姓后面的冒号，因此它不出现在结果列表中。如果 maxsplit 设置为 4 ，我们还可以从地址中获取到房间号:

>>> [re.split(":? ", entry, 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']]

文字整理

sub() 替换字符串中出现的样式的每一个实例。这个例子证明了使用 sub() 来整理文字，或者随机化每个字符的位置，除了首位和末尾字符

>>> 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.'

查找所有副词

findall() 匹配样式 所有 的出现，不仅是像 search() 中的第一个匹配。比如，如果一个作者希望找到文字中的所有副词，他可能会按照以下方法用 findall()

>>> text = "He was carefully disguised but captured quickly by police."
>>> re.findall(r"\w+ly\b", text)
['carefully', 'quickly']

查找所有的副词及其位置

如果需要匹配样式的更多信息， finditer() 可以起到作用，它提供了 匹配对象 作为返回值，而不是字符串。继续上面的例子，如果一个作者希望找到所有副词和它的位置，可以按照下面方法使用 finditer()

>>> 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

原始字符串标记

原始字符串记法 (r"text") 保持正则表达式正常。否则，每个正则式里的反斜杠('\') 都必须前缀一个反斜杠来转义。比如，下面两行代码功能就是完全一致的

>>> 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 '>

当需要匹配一个字符反斜杠，它必须在正则表达式中转义。在原始字符串记法，就是 r"\\"。否则就必须用 "\\\\"，来表示同样的意思

>>> re.match(r"\\", r"\\")
<re.Match object; span=(0, 1), match='\\'>
>>> re.match("\\\\", r"\\")
<re.Match object; span=(0, 1), match='\\'>

写一个词法分析器

一个 词法器或词法分析器 [https://en.wikipedia.org/wiki/Lexical_analysis] 分析字符串，并分类成目录组。 这是写一个编译器或解释器的第一步。

文字目录是由正则表达式指定的。这个技术是通过将这些样式合并为一个主正则式，并且循环匹配来实现的

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*)?'),  # Integer or decimal number
        ('ASSIGN',   r':='),           # Assignment operator
        ('END',      r';'),            # Statement terminator
        ('ID',       r'[A-Za-z]+'),    # Identifiers
        ('OP',       r'[+\-*/]'),      # Arithmetic operators
        ('NEWLINE',  r'\n'),           # Line endings
        ('SKIP',     r'[ \t]+'),       # Skip over spaces and tabs
        ('MISMATCH', r'.'),            # Any other character
    ]
    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 = '''
    IF quantity THEN
        total := total + price * quantity;
        tax := price * 0.05;
    ENDIF;
'''

for token in tokenize(statements):
    print(token)

该词法器产生以下的输出

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)

Frie09

Friedl, Jeffrey. Mastering Regular Expressions. 3rd ed., O'Reilly Media, 2009. 该书的第三版不再包含 Python，但第一版极详细地覆盖了正则表达式模式串的编写。

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

源代码: Lib/difflib.py [https://github.com/python/cpython/tree/3.10/Lib/difflib.py]

此模块提供用于比较序列的类和函数。 例如，它可被用于比较文件，并可产生多种格式的不同文件差异信息，包括 HTML 和上下文以及统一的 diff 数据。 有关比较目录和文件，另请参阅 filecmp 模块。

class difflib.SequenceMatcher

这是一个灵活的类，可用于比较任何类型的序列对，只要序列元素为 hashable 对象。 其基本算法要早于由 Ratcliff 和 Obershelp 于 1980 年代末期发表并以“格式塔模式匹配”的夸张名称命名的算法，并且更加有趣一些。 其思路是找到不包含“垃圾”元素的最长连续匹配子序列；所谓“垃圾”元素是指其在某种意义上没有价值，例如空白行或空白符。 （处理垃圾元素是对 Ratcliff 和 Obershelp 算法的一个扩展。） 然后同样的思路将递归地应用于匹配序列的左右序列片段。 这并不能产生最小编辑序列，但确实能产生在人们看来“正确”的匹配。

耗时: 基本 Ratcliff-Obershelp 算法在最坏情况下为立方时间而在一般情况下为平方时间。 SequenceMatcher 在最坏情况下为平方时间而在一般情况下的行为受到序列中有多少相同元素这一因素的微妙影响；在最佳情况下则为线性时间。

自动垃圾启发式计算: SequenceMatcher 支持使用启发式计算来自动将特定序列项视为垃圾。 这种启发式计算会统计每个单独项在序列中出现的次数。 如果某一项（在第一项之后）的重复次数超过序列长度的 1% 并且序列长度至少有 200 项，该项会被标记为“热门”并被视为序列匹配中的垃圾。 这种启发式计算可以通过在创建 SequenceMatcher 时将 autojunk 参数设为 False 来关闭。

3.2 新版功能: autojunk 形参。

class difflib.Differ

这个类的作用是比较由文本行组成的序列，并产生可供人阅读的差异或增量信息。 Differ 统一使用 SequenceMatcher 来完成行序列的比较以及相似（接近匹配）行内部字符序列的比较。

Differ 增量的每一行均以双字母代码打头：

双字母代码 | 含意
'- ' | 行为序列 1 所独有
'+ ' | 行为序列 2 所独有
'  ' | 行在两序列中相同
'? ' | 行不存在于任一输入序列

以 '?' 打头的行尝试将视线引至行以外而不存在于任一输入序列的差异。 如果序列包含制表符则这些行可能会令人感到迷惑。

class difflib.HtmlDiff

这个类可用于创建 HTML 表格（或包含表格的完整 HTML 文件）以并排地逐行显示文本比较，行间与行外的更改将突出显示。 此表格可以基于完全或上下文差异模式来生成。

这个类的构造函数：

__init__(tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK)

初始化 HtmlDiff 的实例。

tabsize 是一个可选关键字参数，指定制表位的间隔，默认值为 8。

wrapcolumn 是一个可选关键字参数，指定行文本自动打断并换行的列位置，默认值为 None 表示不自动换行。

linejunk 和 charjunk 均是可选关键字参数，会传入 ndiff() (被 HtmlDiff 用来生成并排显示的 HTML 差异)。 请参阅 ndiff() 文档了解参数默认值及其说明。

下列是公开的方法

make_file(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5, *, charset='utf-8')

比较 fromlines 和 tolines (字符串列表) 并返回一个字符串，表示一个完整 HTML 文件，其中包含各行差异的表格，行间与行外的更改将突出显示。

fromdesc 和 todesc 均是可选关键字参数，指定来源/目标文件的列标题字符串（默认均为空白字符串）。

context 和 numlines 均是可选关键字参数。 当只要显示上下文差异时就将 context 设为 True，否则默认值 False 为显示完整文件。 numlines 默认为 5。 当 context 为 True 时 numlines 将控制围绕突出显示差异部分的上下文行数。 当 context 为 False 时 numlines 将控制在使用 "next" 超链接时突出显示差异部分之前所显示的行数（设为零则会导致 "next" 超链接将下一个突出显示差异部分放在浏览器顶端，不添加任何前导上下文）。

注解

fromdesc 和 todesc 会被当作未转义的 HTML 来解读，当接收不可信来源的输入时应该适当地进行转义。

在 3.5 版更改: 增加了 charset 关键字参数。 HTML 文档的默认字符集从 'ISO-8859-1' 更改为 'utf-8'。

make_table(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5)

比较 fromlines 和 tolines (字符串列表) 并返回一个字符串，表示一个包含各行差异的完整 HTML 表格，行间与行外的更改将突出显示。

此方法的参数与 make_file() 方法的相同。

Tools/scripts/diff.py 是这个类的命令行前端，其中包含一个很好的使用示例。

difflib.context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')

比较 a 和 b (字符串列表)；返回上下文差异格式的增量信息 (一个产生增量行的 generator)。

所谓上下文差异是一种只显示有更改的行再加几个上下文行的紧凑形式。 更改被显示为之前/之后的样式。 上下文行数由 n 设定，默认为三行。

默认情况下，差异控制行（以 *** or --- 表示）是通过末尾换行符来创建的。 这样做的好处是从 io.IOBase.readlines() 创建的输入将得到适用于 io.IOBase.writelines() 的差异信息，因为输入和输出都带有末尾换行符。

对于没有末尾换行符的输入，应将 lineterm 参数设为 ""，这样输出内容将统一不带换行符。

上下文差异格式通常带有一个记录文件名和修改时间的标头。 这些信息的部分或全部可以使用字符串 fromfile, tofile, fromfiledate 和 tofiledate 来指定。 修改时间通常以 ISO 8601 格式表示。 如果未指定，这些字符串默认为空。

>>> 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

请参阅 difflib 的命令行接口 获取更详细的示例。

difflib.get_close_matches(word, possibilities, n=3, cutoff=0.6)

返回由最佳“近似”匹配构成的列表。 word 为一个指定目标近似匹配的序列（通常为字符串），possibilities 为一个由用于匹配 word 的序列构成的列表（通常为字符串列表）。

可选参数 n (默认为 3) 指定最多返回多少个近似匹配； n 必须大于 0.

可选参数 cutoff (默认为 0.6) 是一个 [0, 1] 范围内的浮点数。 与 word 相似度得分未达到该值的候选匹配将被忽略。

候选匹配中（不超过 n 个）的最佳匹配将以列表形式返回，按相似度得分排序，最相似的排在最前面。

>>> 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']

difflib.ndiff(a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)

比较 a 和 b (字符串列表)；返回 Differ 形式的增量信息 (一个产生增量行的 generator)。

可选关键字形参 linejunk 和 charjunk 均为过滤函数 (或为 None)：

linejunk: 此函数接受单个字符串参数，如果其为垃圾字符串则返回真值，否则返回假值。 默认为 None。 此外还有一个模块层级的函数 IS_LINE_JUNK()，它会过滤掉没有可见字符的行，除非该行添加了至多一个井号符 ('#') -- 但是下层的 SequenceMatcher 类会动态分析哪些行的重复频繁到足以形成噪音，这通常会比使用此函数的效果更好。

charjunk: 此函数接受一个字符（长度为 1 的字符串)，如果其为垃圾字符则返回真值，否则返回假值。 默认为模块层级的函数 IS_CHARACTER_JUNK()，它会过滤掉空白字符（空格符或制表符；但包含换行符可不是个好主意！）。

Tools/scripts/ndiff.py 是这个函数的命令行前端。

>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
...              'ore\ntree\nemu\n'.splitlines(keepends=True))
>>> print(''.join(diff), end="")
- one
?  ^
+ ore
?  ^
- two
- three
?  -
+ tree
+ emu

difflib.restore(sequence, which)

返回两个序列中产生增量的那一个。

给出一个由 Differ.compare() 或 ndiff() 产生的 序列，提取出来自文件 1 或 2 (which 形参) 的行，去除行前缀。

示例:

>>> 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(''.join(restore(diff, 1)), end="")
one
two
three
>>> print(''.join(restore(diff, 2)), end="")
ore
tree
emu

difflib.unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')

比较 a 和 b (字符串列表)；返回统一差异格式的增量信息 (一个产生增量行的 generator)。

所以统一差异是一种只显示有更改的行再加几个上下文行的紧凑形式。 更改被显示为内联的样式（而不是分开的之前/之后文本块）。 上下文行数由 n 设定，默认为三行。

默认情况下，差异控制行 (以 ---, +++ 或 @@ 表示) 是通过末尾换行符来创建的。 这样做的好处是从 io.IOBase.readlines() 创建的输入将得到适用于 io.IOBase.writelines() 的差异信息，因为输入和输出都带有末尾换行符。

对于没有末尾换行符的输入，应将 lineterm 参数设为 ""，这样输出内容将统一不带换行符。

上下文差异格式通常带有一个记录文件名和修改时间的标头。 这些信息的部分或全部可以使用字符串 fromfile, tofile, fromfiledate 和 tofiledate 来指定。 修改时间通常以 ISO 8601 格式表示。 如果未指定，这些字符串默认为空。

>>> 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

请参阅 difflib 的命令行接口 获取更详细的示例。

difflib.diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')

使用 dfunc 比较 a 和 b (字节串对象列表)；产生以 dfunc 所返回格式表示的差异行列表（也是字节串）。 dfunc 必须是可调用对象，通常为 unified_diff() 或 context_diff()。

允许你比较编码未知或不一致的数据。 除 n 之外的所有输入都必须为字节串对象而非字符串。 作用方式为无损地将所有输入 (除 n 之外) 转换为字符串，并调用 dfunc(a, b, fromfile, tofile, fromfiledate, tofiledate, n, lineterm)。 dfunc 的输出会被随即转换回字节串，这样你所得到的增量行将具有与 a 和 b 相同的未知/不一致编码。

3.5 新版功能.

difflib.IS_LINE_JUNK(line)

对于可忽略的行返回 True。 如果 line 为空行或只包含单个 '#' 则 line 行就是可忽略的，否则就是不可忽略的。 此函数被用作较旧版本 ndiff() 中 linejunk 形参的默认值。

difflib.IS_CHARACTER_JUNK(ch)

对于可忽略的字符返回 True。 字符 ch 如果为空格符或制表符则 ch 就是可忽略的，否则就是不可忽略的。 此函数被用作 ndiff() 中 charjunk 形参的默认值。

参见

Pattern Matching: The Gestalt Approach [https://www.drdobbs.com/database/pattern-matching-the-gestalt-approach/184407970]

John W. Ratcliff 和 D. E. Metzener 对于一种类似算法的讨论。 此文于 1988 年 7 月发表于 Dr. Dobb's Journal [https://www.drdobbs.com/]。

SequenceMatcher 对象

SequenceMatcher 类具有这样的构造器：

class difflib.SequenceMatcher(isjunk=None, a='', b='', autojunk=True)

可选参数 isjunk 必须为 None (默认值) 或为接受一个序列元素并当且仅当其为应忽略的“垃圾”元素时返回真值的单参数函数。 传入 None 作为 isjunk 的值就相当于传入 lambda x: False；也就是说不忽略任何值。 例如，传入:

lambda x: x in " \t"

如果你以字符序列的形式对行进行比较，并且不希望区分空格符或硬制表符。

可选参数 a 和 b 为要比较的序列；两者默认为空字符串。 两个序列的元素都必须为 hashable。

可选参数 autojunk 可用于启用自动垃圾启发式计算。

3.2 新版功能: autojunk 形参。

SequenceMatcher 对象接受三个数据属性: bjunk 是 b 当中 isjunk 为 True 的元素集合；bpopular 是被启发式计算（如果其未被禁用）视为热门候选的非垃圾元素集合；b2j 是将 b 当中剩余元素映射到一个它们出现位置列表的字典。 所有三个数据属性将在 b 通过 set_seqs() 或 set_seq2() 重置时被重置。

3.2 新版功能: bjunk 和 bpopular 属性。

SequenceMatcher 对象具有以下方法：

set_seqs(a, b)

设置要比较的两个序列。

SequenceMatcher 计算并缓存有关第二个序列的详细信息，这样如果你想要将一个序列与多个序列进行比较，可使用 set_seq2() 一次性地设置该常用序列并重复地对每个其他序列各调用一次 set_seq1()。

set_seq1(a)

设置要比较的第一个序列。 要比较的第二个序列不会改变。

set_seq2(b)

设置要比较的第二个序列。 要比较的第一个序列不会改变。

find_longest_match(alo=0, ahi=None, blo=0, bhi=None)

找出 a[alo:ahi] 和 b[blo:bhi] 中的最长匹配块。

如果 isjunk 被省略或为 None，find_longest_match() 将返回 (i, j, k) 使得 a[i:i+k] 等于 b[j:j+k]，其中 alo <= i <= i+k <= ahi 并且 blo <= j <= j+k <= bhi。 对于所有满足这些条件的 (i', j', k')，如果 i == i', j <= j' 也被满足，则附加条件 k >= k', i <= i'。 换句话说，对于所有最长匹配块，返回在 a 当中最先出现的一个，而对于在 a 当中最先出现的所有最长匹配块，则返回在 b 当中最先出现的一个。

>>> s = SequenceMatcher(None, " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
Match(a=0, b=4, size=5)

如果提供了 isjunk，将按上述规则确定第一个最长匹配块，但额外附加不允许块内出现垃圾元素的限制。 然后将通过（仅）匹配两边的垃圾元素来尽可能地扩展该块。 这样结果块绝对不会匹配垃圾元素，除非同样的垃圾元素正好与有意义的匹配相邻。

这是与之前相同的例子，但是将空格符视为垃圾。 这将防止 ' abcd' 直接与第二个序列末尾的 ' abcd' 相匹配。 而只可以匹配 'abcd'，并且是匹配第二个序列最左边的 'abcd'：

>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
Match(a=1, b=0, size=4)

如果未找到匹配块，此方法将返回 (alo, blo, 0)。

此方法将返回一个 named tuple Match(a, b, size)。

在 3.9 版更改: 加入默认参数。

get_matching_blocks()

返回描述非重叠匹配子序列的三元组列表。 每个三元组的形式为 (i, j, n)，其含义为 a[i:i+n] == b[j:j+n]。 这些三元组按 i 和 j 单调递增排列。

最后一个三元组用于占位，其值为 (len(a), len(b), 0)。 它是唯一 n == 0 的三元组。 如果 (i, j, n) 和 (i', j', n') 是在列表中相邻的三元组，且后者不是列表中的最后一个三元组，则 i+n < i' 或 j+n < j'；换句话说，相邻的三元组总是描述非相邻的相等块。

>>> 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)]

get_opcodes()

返回描述如何将 a 变为 b 的 5 元组列表，每个元组的形式为 (tag, i1, i2, j1, j2)。 在第一个元组中 i1 == j1 == 0，而在其余的元组中 i1 等于前一个元组的 i2，并且 j1 也等于前一个元组的 j2。

tag 值为字符串，其含义如下：

值 | 含意
'replace' | a[i1:i2] 应由 b[j1:j2] 替换。
'delete' | a[i1:i2] 应被删除。 请注意在此情况下 j1 == j2。
'insert' | b[j1:j2] 应插入到 a[i1:i1]。 请注意在此情况下 i1 == i2。
'equal' | a[i1:i2] == b[j1:j2] (两个子序列相同)。

例如：

>>> 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' --> ''
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]       '' --> 'f'

get_grouped_opcodes(n=3)

返回一个带有最多 n 行上下文的分组的 generator。

从 get_opcodes() 所返回的组开始，此方法会拆分出较小的更改簇并消除没有更改的间隔区域。

这些分组以与 get_opcodes() 相同的格式返回。

ratio()

返回一个取值范围 [0, 1] 的浮点数作为序列相似性度量。

其中 T 是两个序列中元素的总数量，M 是匹配的数量，即 2.0*M / T。 请注意如果两个序列完全相同则该值为 1.0，如果两者完全不同则为 0.0。

如果 get_matching_blocks() 或 get_opcodes() 尚未被调用则此方法运算消耗较大，在此情况下你可能需要先调用 quick_ratio() 或 real_quick_ratio() 来获取一个上界。

注解

注意: ratio() 调用的结果可能会取决于参数的顺序。 例如:

>>> SequenceMatcher(None, 'tide', 'diet').ratio()
0.25
>>> SequenceMatcher(None, 'diet', 'tide').ratio()
0.5

quick_ratio()

相对快速地返回一个 ratio() 的上界。

real_quick_ratio()

非常快速地返回一个 ratio() 的上界。

这三个返回匹配部分占字符总数的比率的方法可能由于不同的近似级别而给出不一样的结果，但是 quick_ratio() 和 real_quick_ratio() 总是会至少与 ratio() 一样大：

>>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio()
0.75
>>> s.quick_ratio()
0.75
>>> s.real_quick_ratio()
1.0

SequenceMatcher 的示例

以下示例比较两个字符串，并将空格视为“垃圾”：

>>> s = SequenceMatcher(lambda x: x == " ",
...                     "private Thread currentThread;",
...                     "private volatile Thread currentThread;")

ratio() 返回一个 [0, 1] 范围内的整数作为两个序列相似性的度量。 根据经验，ratio() 值超过 0.6 就意味着两个序列是近似匹配的：

>>> print(round(s.ratio(), 3))
0.866

如果你只对两个序列相匹配的位置感兴趣，则 get_matching_blocks() 就很方便：

>>> 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

请注意 get_matching_blocks() 返回的最后一个元组总是只用于占位的 (len(a), len(b), 0)，这也是元组末尾元素（匹配的元素数量）为 0 的唯一情况。

如果你想要知道如何将第一个序列转成第二个序列，可以使用 get_opcodes():

>>> 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]

参见

此模块中的 get_close_matches() 函数显示了如何基于 SequenceMatcher 构建简单的代码来执行有用的功能。

使用 SequenceMatcher 构建小型应用的 简易版本控制方案 [https://code.activestate.com/recipes/576729/]。

Differ 对象

请注意 Differ 所生成的增量并不保证是 最小 差异。 相反，最小差异往往是违反直觉的，因为它们会同步任何可能的地方，有时甚至意外产生相距 100 页的匹配。 将同步点限制为连续匹配保留了一些局部性概念，这偶尔会带来产生更长差异的代价。

Differ 类具有这样的构造器：

class difflib.Differ(linejunk=None, charjunk=None)

可选关键字形参 linejunk 和 charjunk 均为过滤函数 (或为 None)：

linejunk: 接受单个字符串作为参数的函数，如果其为垃圾字符串则返回真值。 默认值为 None，意味着没有任何行会被视为垃圾行。

charjunk: 接受单个字符（长度为 1 的字符串）作为参数的函数，如果其为垃圾字符则返回真值。 默认值为 None，意味着没有任何字符会被视为垃圾字符。

这些垃圾过滤函数可加快查找差异的匹配速度，并且不会导致任何差异行或字符被忽略。 请阅读 find_longest_match() 方法的 isjunk 形参的描述了解详情。

Differ 对象是通过一个单独方法来使用（生成增量）的：

compare(a, b)

比较两个由行组成的序列，并生成增量（一个由行组成的序列）。

每个序列必须包含一个以换行符结尾的单行字符串。 这样的序列可以通过文件型对象的 readlines() 方法来获取。 所生成的增量同样由以换行符结尾的字符串构成，可以通过文件型对象的 writelines() 方法原样打印出来。

Differ 示例

此示例比较两段文本。 首先我们设置文本为以换行符结尾的单行字符串构成的序列（这样的序列也可以通过文件类对象的 readlines() 方法来获取）：

>>> text1 = '''  1. Beautiful is better than ugly.
...   2. Explicit is better than implicit.
...   3. Simple is better than complex.
...   4. Complex is better than complicated.
... '''.splitlines(keepends=True)
>>> len(text1)
4
>>> text1[0][-1]
'\n'
>>> text2 = '''  1. Beautiful is better than ugly.
...   3.   Simple is better than complex.
...   4. Complicated is better than complex.
...   5. Flat is better than nested.
... '''.splitlines(keepends=True)

接下来我们实例化一个 Differ 对象：

>>> d = Differ()

请注意在实例化 Differ 对象时我们可以传入函数来过滤掉“垃圾”行和字符。 详情参见 Differ() 构造器说明。

最后，我们比较两个序列：

>>> result = list(d.compare(text1, text2))

result 是一个字符串列表，让我们将其美化打印出来：

>>> 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']

作为单独的多行字符串显示出来则是这样：

>>> 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.

difflib 的命令行接口

这个实例演示了如何使用 difflib 来创建一个类似于 diff 的工具。 它同样包含在 Python 源码发布包中，文件名为 Tools/scripts/diff.py。

#!/usr/bin/env python3
""" 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
from datetime import datetime, timezone

def file_mtime(path):
    t = datetime.fromtimestamp(os.stat(path).st_mtime,
                               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()

textwrap --- 文本自动换行与填充

源代码: Lib/textwrap.py [https://github.com/python/cpython/tree/3.10/Lib/textwrap.py]

textwrap 模块提供了一些快捷函数，以及可以完成所有工作的类 TextWrapper。 如果你只是要对一两个文本字符串进行自动换行或填充，快捷函数应该就够用了；否则的话，你应该使用 TextWrapper 的实例来提高效率。

textwrap.wrap(text, width=70, *, initial_indent='', subsequent_indent='', 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 个字符。 返回由输出行组成的列表，行尾不带换行符。

与 TextWrapper 的实例属性对应的可选的关键字参数，具体文档见下。

请参阅 TextWrapper.wrap() 方法了解有关 wrap() 行为的详细信息。

textwrap.fill(text, width=70, *, initial_indent='', subsequent_indent='', 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 中的单独段落自动换行，并返回一个包含被自动换行段落的单独字符串。 fill() 是以下语句的快捷方式

"\n".join(wrap(text, ...))

特别要说明的是，fill() 接受与 wrap() 完全相同的关键字参数。

textwrap.shorten(text, width, *, fix_sentence_endings=False, break_long_words=True, break_on_hyphens=True, placeholder=' [...]')

折叠并截短给定的 text 以符合给定的 width。

首先，将折叠 text 中的空格（所有连续空格替换为单个空格）。 如果结果能适合 width 则将其返回。 否则将丢弃足够数量的末尾单词以使得剩余单词加 placeholder 能适合 width：

>>> textwrap.shorten("Hello  world!", width=12)
'Hello world!'
>>> textwrap.shorten("Hello  world!", width=11)
'Hello [...]'
>>> textwrap.shorten("Hello world", width=10, placeholder="...")
'Hello...'

可选的关键字参数对应于 TextWrapper 的实际属性，具体见下文。 请注意文本在被传入 TextWrapper 的 fill() 函数之前会被折叠，因此改变 tabsize, expand_tabs, drop_whitespace 和 replace_whitespace 的值将没有任何效果。

3.4 新版功能.

textwrap.dedent(text)

移除 text 中每一行的任何相同前缀空白符。

这可以用来清除三重引号字符串行左侧空格，而仍然在源码中显示为缩进格式。

请注意制表符和空格符都被视为是空白符，但它们并不相等：以下两行 "  hello" 和 "\thello" 不会被视为具有相同的前缀空白符。

只包含空白符的行会在输入时被忽略并在输出时被标准化为单个换行符。

例如：

def test():
    # end first line with \ to avoid the empty line!
    s = '''\
    hello
      world
    '''
    print(repr(s))          # prints '    hello\n      world\n    '
    print(repr(dedent(s)))  # prints 'hello\n  world\n'

textwrap.indent(text, prefix, predicate=None)

将 prefix 添加到 text 中选定行的开头。

通过调用 text.splitlines(True) 来对行进行拆分。

默认情况下，prefix 会被添加到所有不是只由空白符（包括任何行结束符）组成的行。

例如：

>>> s = 'hello\n\n \nworld'
>>> indent(s, '  ')
'  hello\n\n \n  world'

可选的 predicate 参数可用来控制哪些行要缩进。 例如，可以很容易地为空行或只有空白符的行添加 prefix:

>>> print(indent(s, '+ ', lambda line: True))
+ hello
+
+
+ world

3.3 新版功能.

wrap(), fill() 和 shorten() 的作用方式为创建一个 TextWrapper 实例并在其上调用单个方法。 该实例不会被重用，因此对于要使用 wrap() 和/或 fill() 来处理许多文本字符串的应用来说，创建你自己的 TextWrapper 对象可能会更有效率。

文本最好在空白符位置自动换行，包括带连字符单词的连字符之后；长单词仅在必要时会被拆分，除非 TextWrapper.break_long_words 被设为假值。

class textwrap.TextWrapper(**kwargs)

TextWrapper 构造器接受多个可选的关键字参数。 每个关键字参数对应一个实例属性，比如说

wrapper = TextWrapper(initial_indent="* ")

相当于：

wrapper = TextWrapper()
wrapper.initial_indent = "* "

你可以多次重用相同的 TextWrapper 对象，并且你也可以在使用期间通过直接向实例属性赋值来修改它的任何选项。

TextWrapper 的实例属性（以及构造器的关键字参数）如下所示：

width

(默认: 70) 自动换行的最大行长度。 只要输入文本中没有长于 width 的单个单词，TextWrapper 就能保证没有长于 width 个字符的输出行。

expand_tabs

(默认: True) 如果为真值，则 text 中所有的制表符将使用 text 的 expandtabs() 方法扩展为空格符。

tabsize

(默认: 8) 如果 expand_tabs 为真值，则 text 中所有的制表符将扩展为零个或多个空格，具体取决于当前列位置和给定的制表宽度。

3.3 新版功能.

replace_whitespace

(default: True) 如果为真值，在制表符扩展之后、自动换行之前，wrap() 方法将把每个空白字符都替换为单个空格。 会被替换的空白字符如下：制表，换行，垂直制表，进纸和回车 ('\t\n\v\f\r')。

注解

如果 expand_tabs 为假值且 replace_whitespace 为真值，每个制表符将被替换为单个空格，这与制表符扩展是 不 一样的。

注解

如果 replace_whitespace 为假值，在一行的中间有可能出现换行符并导致怪异的输出。 因此，文本应当（使用 str.splitlines() 或类似方法）拆分为段落并分别进行自动换行。

drop_whitespace

(默认: True) 如果为真值，每一行开头和末尾的空白字符（在包装之后、缩进之前）会被丢弃。 但是段落开头的空白字符如果后面不带任何非空白字符则不会被丢弃。 如果被丢弃的空白字符占据了一个整行，则该整行将被丢弃。

initial_indent

(默认: '') 将被添加到被自动换行输出内容的第一行的字符串。 其长度会被计入第一行的长度。 空字符串不会被缩进。

subsequent_indent

(default: '') 将被添加到被自动换行输出内容除第一行外的所有行的字符串。 其长度会被计入除行一行外的所有行的长度。

fix_sentence_endings

(默认: False) 如果为真值，TextWrapper 将尝试检测句子结尾并确保句子间总是以恰好两个空格符分隔。 对于使用等宽字体的文本来说通常都需要这样。 但是，句子检测算法并不完美：它假定句子结尾是一个小写字母加字符 '.', '!' 或 '?' 中的一个，并可能带有字符 '"' 或 "'"，最后以一个空格结束。 此算法的问题之一是它无法区分以下文本中的 "Dr."

[...] Dr. Frankenstein's monster [...]

和以下文本中的 "Spot."

[...] See Spot. See Spot run [...]

fix_sentence_endings 默认为假值。

由于句子检测算法依赖于 string.lowercase 来确定“小写字母”，以及约定在句点后使用两个空格来分隔处于同一行的句子，因此只适用于英语文本。

break_long_words

(默认: True) 如果为真值，则长度超过 width 的单词将被分开以保证行的长度不会超过 width。 如果为假值，超长单词不会被分开，因而某些行的长度可能会超过 width。 （超长单词将被单独作为一行，以尽量减少超出 width 的情况。）

break_on_hyphens

(默认: True) 如果为真值，将根据英语的惯例首选在空白符和复合词的连字符之后自动换行。 如果为假值，则只有空白符会被视为合适的潜在断行位置，但如果你确实不希望出现分开的单词则你必须将 break_long_words 设为假值。 之前版本的默认行为总是允许分开带有连字符的单词。

max_lines

(默认: None) 如果不为 None，则输出内容将最多包含 max_lines 行，并使 placeholder 出现在输出内容的末尾。

3.4 新版功能.

placeholder

(默认: ' [...]') 该文本将在输出文本被截短时出现在文本末尾。

3.4 新版功能.

TextWrapper 还提供了一些公有方法，类似于模块层级的便捷函数：

wrap(text)

对 text (字符串) 中的单独段落自动换行以使每行长度最多为 width 个字符。 所有自动换行选项均获取自 TextWrapper 实例的实例属性。 返回由输出行组成的列表，行尾不带换行符。 如果自动换行输出结果没有任何内容，则返回空列表。

fill(text)

对 text 中的单独段落自动换行并返回包含被自动换行段落的单独字符串。

unicodedata --- Unicode 数据库

此模块提供了对 Unicode Character Database (UCD) 的访问，其中定义了所有 Unicode 字符的字符属性。 此数据库中包含的数据编译自 UCD 版本 13.0.0 [https://www.unicode.org/Public/13.0.0/ucd]。

该模块使用与 Unicode 标准附件 #44 “Unicode 字符数据库” [https://www.unicode.org/reports/tr44/] 中所定义的相同名称和符号。 它定义了以下函数：

unicodedata.lookup(name)

按名称查找字符。如果找到具有给定名称的字符，则返回相应的字符。 如果没有找到，则 KeyError 被引发。

在 3.3 版更改: 已添加对名称别名 1 和命名序列 2 的支持。

unicodedata.name(chr[, default])

返回分配给字符 chr 的名称作为字符串。如果没有定义名称，则返回 default ，如果没有给出，则 ValueError 被引发。

unicodedata.decimal(chr[, default])

返回分配给字符 chr 的十进制值作为整数。 如果没有定义这样的值，则返回 default ，如果没有给出，则 ValueError 被引发。

unicodedata.digit(chr[, default])

返回分配给字符 chr 的数字值作为整数。 如果没有定义这样的值，则返回 default ，如果没有给出，则 ValueError 被引发。

unicodedata.numeric(chr[, default])

返回分配给字符 chr 的数值作为浮点数。 如果没有定义这样的值，则返回 default ，如果没有给出，则 ValueError 被引发。

unicodedata.category(chr)

返回分配给字符 chr 的常规类别为字符串。

unicodedata.bidirectional(chr)

返回分配给字符 chr 的双向类作为字符串。如果未定义此类值，则返回空字符串。

unicodedata.combining(chr)

返回分配给字符 chr 的规范组合类作为整数。如果没有定义组合类，则返回 0 。

unicodedata.east_asian_width(chr)

返回分配给字符 chr 的东亚宽度作为字符串。

unicodedata.mirrored(chr)

返回分配给字符 chr 的镜像属性为整数。如果字符在双向文本中被识别为“镜像”字符，则返回 1 ，否则返回 0 。

unicodedata.decomposition(chr)

返回分配给字符 chr 的字符分解映射作为字符串。如果未定义此类映射，则返回空字符串。

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）完全相同。 但是， Unicode 支持它与现有字符集（例如 gb2312 ）的兼容性。

正规形式KD（NFKD）将应用兼容性分解，即用其等价项替换所有兼容性字符。 正规形式KC（NFKC）首先应用兼容性分解，然后是规范组合。

即使两个 unicode 字符串被规范化并且人类读者看起来相同，如果一个具有组合字符而另一个没有，则它们可能无法相等。

unicodedata.is_normalized(form, unistr)

判断 Unicode 字符串 unistr 是否为正规形式 form。 form 的有效值为 'NFC', 'NFKC', 'NFD' 和 'NFKD'。

3.8 新版功能.

此外，该模块暴露了以下常量：

unicodedata.unidata_version

此模块中使用的 Unicode 数据库的版本。

unicodedata.ucd_3_2_0

这是一个与整个模块具有相同方法的对象，但对于需要此特定版本的 Unicode 数据库（如 IDNA ）的应用程序，则使用 Unicode 数据库版本 3.2 。

示例：

>>> import unicodedata
>>> unicodedata.lookup('LEFT CURLY BRACKET')
'{'
>>> unicodedata.name('/')
'SOLIDUS'
>>> unicodedata.decimal('9')
9
>>> unicodedata.decimal('a')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: not a decimal
>>> unicodedata.category('A')  # 'L'etter, 'u'ppercase
'Lu'
>>> unicodedata.bidirectional('\u0660') # 'A'rabic, 'N'umber
'AN'

备注

1

https://www.unicode.org/Public/13.0.0/ucd/NameAliases.txt

2

https://www.unicode.org/Public/13.0.0/ucd/NamedSequences.txt

stringprep --- 因特网字符串预备

源代码: Lib/stringprep.py [https://github.com/python/cpython/tree/3.10/Lib/stringprep.py]

在标识因特网上的事物（例如主机名），经常需要比较这些标识是否（相等）。 这种比较的具体执行可能会取决于应用域的不同，例如是否要区分大小写等等。 有时也可能需要限制允许的标识为仅由“可打印”字符组成。

RFC 3454 [https://datatracker.ietf.org/doc/html/rfc3454.html] 定义了在因特网协议中 Unicode 字符串的“预备”过程。 在将字符串连线传输之前，它们会先使用预备过程进行处理，之后它们将具有特定的标准形式。 该 RFC 定义了一系列表格，它们可以被组合为选项配置。 每个配置必须定义所使用的表格，stringprep 过程的其他可选项也是配置的组成部分。 stringprep 配置的一个例子是 nameprep，它被用于国际化域名。

模块 stringprep 仅公开了来自 RFC 3454 [https://datatracker.ietf.org/doc/html/rfc3454.html] 的表格。 由于这些如果表格如果表示为字典或列表将会非常庞大，该模块在内部使用 Unicode 字符数据库。 该模块本身的源代码是使用 mkstringprep.py 工具生成的。

因此，这些表格以函数而非数据结构的形式公开。 在 RFC 中有两种表格：集合与映射。 对于集合，stringprep 提供了“特征函数”，即如果形参是集合的一部分则返回值为 True 的函数。 对于映射，它提供了映射函数：它会根据给定的键返回所关联的值。 以下是模块中所有可用函数的列表。

stringprep.in_table_a1(code)

确定 code 是否属于 tableA.1 (Unicode 3.2 中的未分配码位)。

stringprep.in_table_b1(code)

确定 code 是否属于 tableB.1 (通常映射为空值)。

stringprep.map_table_b2(code)

返回 code 依据 tableB.2 (配合 NFKC 使用的大小写转换映射) 所映射的值。

stringprep.map_table_b3(code)

返回 code 依据 tableB.3 (不附带正规化的大小写折叠映射) 所映射的值。

stringprep.in_table_c11(code)

确定 code 是否属于 tableC.1.1 (ASCII 空白字符)。

stringprep.in_table_c12(code)

确定 code 是否属于 tableC.1.2 (非 ASCII 空白字符)。

stringprep.in_table_c11_c12(code)

确定 code 是否属于 tableC.1 (空白字符，C.1.1 和 C.1.2 的并集)。

stringprep.in_table_c21(code)

确定 code 是否属于 tableC.2.1 (ASCII 控制字符)。

stringprep.in_table_c22(code)

确定 code 是否属于 tableC.2.2 (非 ASCII 控制字符)。

stringprep.in_table_c21_c22(code)

确定 code 是否属于 tableC.2 (控制字符，C.2.1 和 C.2.2 的并集)。

stringprep.in_table_c3(code)

确定 code 是否属于 tableC.3 (私有使用)。

stringprep.in_table_c4(code)

确定 code 是否属于 tableC.4 (非字符码位)。

stringprep.in_table_c5(code)

确定 code 是否属于 tableC.5 (替代码)。

stringprep.in_table_c6(code)

确定 code 是否属于 tableC.6 (不适用于纯文本)。

stringprep.in_table_c7(code)

确定 code 是否属于 tableC.7 (不适用于规范表示)。

stringprep.in_table_c8(code)

确定 code 是否属于 tableC.8 (改变显示属性或已弃用)。

stringprep.in_table_c9(code)

确定 code 是否属于 tableC.9 (标记字符)。

stringprep.in_table_d1(code)

确定 code 是否属于 tableD.1 (带有双向属性 "R" 或 "AL" 的字符)。

stringprep.in_table_d2(code)

确定 code 是否属于 tableD.2 (带有双向属性 "L" 的字符)。

readline --- GNU readline 接口

readline 模块定义了许多方便从 Python 解释器完成和读取/写入历史文件的函数。 此模块可以直接使用，或通过支持在交互提示符下完成 Python 标识符的 rlcompleter 模块使用。 使用此模块进行的设置会同时影响解释器的交互提示符以及内置 input() 函数提供的提示符。

Readline keybindings may be configured via an initialization file, typically .inputrc in your home directory. See Readline Init File [https://tiswww.cwru.edu/php/chet/readline/rluserman.html#SEC9] in the GNU Readline manual for information about the format and allowable constructs of that file, and the capabilities of the Readline library in general.

注解

底层的 Readline 库 API 可能使用 libedit 库来实现而不是 GNU readline。 在 macOS 上 readline 模块会在运行时检测所使用的是哪个库。

libedit 所用的配置文件与 GNU readline 的不同。 如果你要在程序中载入配置字符串你可以在 readline.__doc__ 中检测文本 "libedit" 来区分 GNU readline 和 libedit。

如果你是在 macOS 上使用 editline/libedit readline 模拟，则位于你的主目录中的初始化文件名称为 .editrc。 例如，~/.editrc 中的以下内容将开启 vi 按键绑定以及 TAB 补全:

python:bind -v
python:bind ^I rl_complete

初始化文件

下列函数与初始化文件和用户配置有关：

readline.parse_and_bind(string)

执行在 string 参数中提供的初始化行。 此函数会调用底层库中的 rl_parse_and_bind()。

readline.read_init_file([filename])

执行一个 readline 初始化文件。 默认文件名为最近所使用的文件名。 此函数会调用底层库中的 rl_read_init_file()。

行缓冲区

下列函数会在行缓冲区上操作。

readline.get_line_buffer()

返回行缓冲区的当前内容 (底层库中的 rl_line_buffer)。

readline.insert_text(string)

将文本插入行缓冲区的当前游标位置。 该函数会调用底层库中的 rl_insert_text()，但会忽略其返回值。

readline.redisplay()

改变屏幕的显示以反映行缓冲区的当前内容。 该函数会调用底层库中的 rl_redisplay()。

历史文件

下列函数会在历史文件上操作：

readline.read_history_file([filename])

载入一个 readline 历史文件，并将其添加到历史列表。 默认文件名为 ~/.history。 此函数会调用底层库中的 read_history()。

readline.write_history_file([filename])

将历史列表保存为 readline 历史文件，覆盖任何现有文件。 默认文件名为 ~/.history。 此函数会调用底层库中的 write_history()。

readline.append_history_file(nelements[, filename])

将历史列表的最后 nelements 项添加到历史文件。 默认文件名为 ~/.history。 文件必须已存在。 此函数会调用底层库中的 append_history()。 此函数仅当 Python 编译包带有支持此功能的库版本时才会存在。

3.5 新版功能.

readline.get_history_length()

readline.set_history_length(length)

设置或返回需要保存到历史文件的行数。 write_history_file() 函数会通过调用底层库中的 history_truncate_file() 以使用该值来截取历史文件。 负值意味着不限制历史文件的大小。

历史列表

以下函数会在全局历史列表上操作：

readline.clear_history()

清除当前历史。 此函数会调用底层库的 clear_history()。 此 Python 函数仅当 Python 编译包带有支持此功能的库版本时才会存在。

readline.get_current_history_length()

返回历史列表的当前项数。 （此函数不同于 get_history_length()，后者是返回将被写入历史文件的最大行数。）

readline.get_history_item(index)

返回序号为 index 的历史条目的当前内容。 条目序号从一开始。 此函数会调用底层库中的 history_get()。

readline.remove_history_item(pos)

从历史列表中移除指定位置上的历史条目。 条目位置从零开始。 此函数会调用底层库中的 remove_history()。

readline.replace_history_item(pos, line)

将指定位置上的历史条目替换为 line。 条目位置从零开始。 此函数会调用底层库中的 replace_history_entry()。

readline.add_history(line)

将 line 添加到历史缓冲区，相当于是最近输入的一行。 此函数会调用底层库中的 add_history()。

readline.set_auto_history(enabled)

启用或禁用当通过 readline 读取输入时自动调用 add_history()。 enabled 参数应为一个布尔值，当其为真值时启用自动历史，当其为假值时禁用自动历史。

3.6 新版功能.

CPython 实现细节： 自动历史将默认启用，对此设置的改变不会在多个会话中保持。

启动钩子

readline.set_startup_hook([function])

设置或移除底层库的 rl_startup_hook 回调所唤起的函数。 如果指定了 function，它将被用作新的钩子函数；如果省略或为 None，任何已安装的函数将被移除。 钩子函数将在 readline 打印第一个提示信息之前不带参数地被调用。

readline.set_pre_input_hook([function])

设置或移除底层库的 rl_pre_input_hook 回调所唤起的函数。 如果指定了 function，它将被用作新的钩子函数；如果省略或为 None，任何已安装的函数将被移除。 钩子函数将在打印第一个提示信息之后、readline 开始读取输入字符之前不带参数地被调用。 此函数仅当 Python 编译包带有支持此功能的库版本时才会存在。

Completion

以下函数与自定义单词补全函数的实现有关。 这通常使用 Tab 键进行操作，能够提示并自动补全正在输入的单词。 默认情况下，Readline 设置为由 rlcompleter 来补全交互模式解释器的 Python 标识符。 如果 readline 模块要配合自定义的补全函数来使用，则需要设置不同的单词分隔符。

readline.set_completer([function])

设置或移除补全函数。 如果指定了 function，它将被用作新的补全函数；如果省略或为 None，任何已安装的补全函数将被移除。 补全函数的调用形式为 function(text, state)，其中 state 为 0, 1, 2, ..., 直至其返回一个非字符串值。 它应当返回下一个以 text 开头的候选补全内容。

已安装的补全函数将由传递给底层库中 rl_completion_matches() 的 entry_func 回调函数来唤起。 text 字符串来自于底层库中 rl_attempted_completion_function 回调函数的第一个形参。

readline.get_completer()

获取补全函数，如果没有设置补全函数则返回 None。

readline.get_completion_type()

获取正在尝试的补全类型。 此函数会将底层库中的 rl_completion_type 变量作为一个整数返回。

readline.get_begidx()

readline.get_endidx()

获取完全范围的开始和结束索引号。 这些索引号就是传递给下层库的 rl_attempted_completion_function 回调的 start 和 end 参数。 具体值在同一个输入编辑场景中可能不同，具体取决于下层的 C readline 实现。 例如：已知 libedit 的行为就不同于 libreadline。

readline.set_completer_delims(string)

readline.get_completer_delims()

设置或获取补全的单词分隔符。 此分隔符确定了要考虑补全的单词的开始和结束位置（补全域）。 这些函数会访问底层库的 rl_completer_word_break_characters 变量。

readline.set_completion_display_matches_hook([function])

设置或移除补全显示函数。 如果指定了 function，它将被用作新的补全显示函数；如果省略或为 None，任何已安装的补全显示函数将被移除。 此函数会设置或清除底层库的 rl_completion_display_matches_hook 回调函数。 补全显示函数会在每次需要显示匹配项时以 function(substitution, [matches], longest_match_length) 的形式被调用。

示例

以下示例演示了如何使用 readline 模块的历史读取或写入函数来自动加载和保存用户主目录下名为 .python_history 的历史文件。 以下代码通常应当在交互会话期间从用户的 PYTHONSTARTUP 文件自动执行。

import atexit
import os
import readline

histfile = os.path.join(os.path.expanduser("~"), ".python_history")
try:
    readline.read_history_file(histfile)
    # default history len is -1 (infinite), which may grow unruly
    readline.set_history_length(1000)
except FileNotFoundError:
    pass

atexit.register(readline.write_history_file, histfile)

此代码实际上会在 Python 运行于 交互模式 时自动运行 (参见 Readline 配置)。

以下示例实现了同样的目标，但是通过只添加新历史的方式来支持并发的交互会话。

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)

以下示例扩展了 code.InteractiveConsole 类以支持历史保存/恢复。

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)

rlcompleter --- GNU readline 的补全函数

源代码: Lib/rlcompleter.py [https://github.com/python/cpython/tree/3.10/Lib/rlcompleter.py]

rlcompeleter 通过补全有效的 Python 标识符和关键字定义了一个适用于 readline 模块的补全函数。

当此模块在具有可用的 readline 模块的 Unix 平台被导入, 一个 Completer 实例将被自动创建并且它的 complete() 方法将设置为 readline 的补全器.

示例:

>>> 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.

rlcompleter 模块是为了使用 Python 的 交互模式 而设计的。 除非 Python 是通过 -S 选项运行, 这个模块总是自动地被导入且配置 (参见 Readline 配置)。

在没有 readline 的平台, 此模块定义的 Completer 类仍然可以用于自定义行为.

Completer 对象

Completer 对象具有以下方法：

Completer.complete(text, state)

为 text 返回第 state 项补全。

如果指定的 text 不包含句点字符 ('.')，它将根据当前 __main__, builtins 和保留关键字（定义于 keyword 模块）所定义的名称进行补全。

如果为带有句点的名称执行调用，它将尝试尽量求值直到最后一部分为止而不产生附带影响（函数不会被求值，但它可以生成对 __getattr__() 的调用），并通过 dir() 函数来匹配剩余部分。 在对表达式求值期间引发的任何异常都会被捕获、静默处理并返回 None。

二进制数据服务

本章介绍的模块提供了一些操作二进制数据的基本服务操作。 有关二进制数据的其他操作，特别是与文件格式和网络协议有关的操作，将在相关章节中介绍。

下面描述的一些库 文本处理服务 也可以使用 ASCII 兼容的二进制格式（例如 re ）或所有二进制数据（例如 difflib ）。

另外，请参阅 Python 的内置二进制数据类型的文档 二进制序列类型 --- bytes, bytearray, memoryview 。

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

函数和异常

格式字符串

字节顺序，大小和对齐方式

格式字符

例子

应用

原生格式

标准格式

类

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

编解码器基类

错误处理方案

无状态的编码和解码

增量式的编码和解码

IncrementalEncoder 对象

IncrementalDecoder 对象

流式的编码和解码

StreamWriter 对象

StreamReader 对象

StreamReaderWriter 对象

StreamRecoder 对象

编码格式与 Unicode

标准编码

Python 专属的编码格式

文字编码

二进制转换

文字转换

encodings.idna --- 应用程序中的国际化域名

encodings.mbcs --- Windows ANSI代码页

encodings.utf_8_sig --- 带BOM签名的UTF-8编解码器

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

源代码： Lib/struct.py [https://github.com/python/cpython/tree/3.10/Lib/struct.py]

此模块可在 Python 值和以 Python bytes 对象表示的 C 结构体之间进行转换。 通过紧凑 格式字符串 描述预期的 Python 值转换目标/来源。 此模块的函数和对象可被用于两种相当不同的应用程序，与外部源（文件或网络连接）进行数据交换，或者在 Python 应用和 C 层级之间进行数据传输。

注解

当未给出前缀字符时，将默认为原生模式。 它会基于构建 Python 解释器的平台和编译器来打包和解包数据。 打包一个给定 C 结构体的结果包括为所涉及的 C 类型保持正确对齐的填充字节；类似地，当解包时也会将对齐纳入考虑。 相反地，当在外部源之间进行数据通信时，将由程序员负责定义字节顺序和元素之间的填充。 请参阅 字节顺序，大小和对齐方式 了解详情。

某些 struct 的函数（以及 Struct 的方法）接受一个 buffer 参数。 这将指向实现了 缓冲协议 并提供只读或是可读写缓冲的对象。 用于此目的的最常见类型为 bytes 和 bytearray，但许多其他可被视为字节数组的类型也实现了缓冲协议，因此它们无需额外从 bytes 对象复制即可被读取或填充。

函数和异常

此模块定义了下列异常和函数：

exception struct.error

会在多种场合下被引发的异常；其参数为一个描述错误信息的字符串。

struct.pack(format, v1, v2, ...)

返回一个 bytes 对象，其中包含根据格式字符串 format 打包的值 v1, v2, ... 参数个数必须与格式字符串所要求的值完全匹配。

struct.pack_into(format, buffer, offset, v1, v2, ...)

根据格式字符串 format 打包 v1, v2, ... 等值并将打包的字节串写入可写缓冲区 buffer 从 offset 开始的位置。 请注意 offset 是必需的参数。

struct.unpack(format, buffer)

根据格式字符串 format 从缓冲区 buffer 解包（假定是由 pack(format, ...) 打包）。 结果为一个元组，即使其只包含一个条目。 缓冲区的字节大小必须匹配格式所要求的大小，如 calcsize() 所示。

struct.unpack_from(format, /, buffer, offset=0)

对 buffer 从位置 offset 开始根据格式字符串 format 进行解包。 结果为一个元组，即使其中只包含一个条目。 缓冲区的字节大小从位置 offset 开始必须至少为 calcsize() 显示的格式所要求的大小。

struct.iter_unpack(format, buffer)

根据格式字符串 format 以迭代方式从缓冲区 buffer 中解包。 此函数返回一个迭代器，它将从缓冲区读取大小相等的块直到其所有内容耗尽为止。 缓冲区的字节大小必须是格式所要求的大小的整数倍，如 calcsize() 所显示的。

每次迭代将产生一个如格式字符串所指定的元组。

3.4 新版功能.

struct.calcsize(format)

返回与格式字符串 format 相对应的结构的大小（亦即 pack(format, ...) 所产生的字节串对象的大小）。

格式字符串

格式字符串描述了打包和解包数据时的数据布局。 它们是使用 格式字符 来构建的，格式字符指明被打包/解包的数据的类型。 此外，还有用来控制 字节顺序、大小和对齐 的特殊字符。 每个格式字符串都是由一个可选的描述数据总体属性的前缀字符和一个或多个描述实际数据值和填充的格式字符组成的。

字节顺序，大小和对齐方式

在默认情况下，C 类型将以所在机器的原生格式和字节顺序来表示，并在必要时通过跳过填充字节来正确地对齐（根据 C 编译器所使用的规则）。 选择此行为是为了使已打包结构体的字节与对应的 C 结构体的内存布局完全对应。 使用原生字节顺序和填充还是标准格式取决于应用程序本身。

或者，根据下表，格式字符串的第一个字符可用于指示打包数据的字节顺序，大小和对齐方式：

字符 | 字节顺序 | 大小 | 对齐方式
@ | 按原字节 | 按原字节 | 按原字节
= | 按原字节 | 标准 | 无
< | 小端 | 标准 | 无
> | 大端 | 标准 | 无
! | 网络（=大端） | 标准 | 无

如果第一个字符不是其中之一，则假定为 '@' 。

原生字节顺序可能为大端序或小端序，具体取决于主机系统。 例如，Intel x86, AMD64 (x86-64) 和 Apple M1 是小端序的；IBM z 和许多旧式架构则是大端序的。 请使用 sys.byteorder 来检查你的系统字节顺序。

本机大小和对齐方式是使用 C 编译器的 sizeof 表达式来确定的。 这总是会与本机字节顺序相绑定。

标准大小仅取决于格式字符；请参阅 格式字符 部分中的表格。

请注意 '@' 和 '=' 之间的区别：两个都使用本机字节顺序，但后者的大小和对齐方式是标准化的。

形式 '!' 代表网络字节顺序总是使用在 IETF RFC 1700 [https://tools.ietf.org/html/rfc1700] 中所定义的大端序。

没有什么方式能指定非本机字节顺序（强制字节对调）；请正确选择使用 '<' 或 '>'。

注释：

填充只会在连续结构成员之间自动添加。 填充不会添加到已编码结构的开头和末尾。

当使用非本机大小和对齐方式即 '<', '>', '=', and '!' 时不会添加任何填充。

要将结构的末尾对齐到符合特定类型的对齐要求，请以该类型代码加重复计数的零作为格式结束。 参见 例子。

格式字符

格式字符具有以下含义；C 和 Python 值之间的按其指定类型的转换应当是相当明显的。 ‘标准大小’列是指当使用标准大小时以字节表示的已打包值大小；也就是当格式字符串以 '<', '>', '!' 或 '=' 之一开头的情况。 当使用本机大小时，已打包值的大小取决于具体的平台。

格式 | C 类型 | Python 类型 | 标准大小 | 备注
x | 填充字节 | 无 |  | (7)
c | char | 长度为 1 的字节串 | 1 |
b | signed char | integer | 1 | (1), (2)
B | unsigned char | integer | 1 | (2)
? | _Bool | bool | 1 | (1)
h | short | integer | 2 | (2)
H | unsigned short | integer | 2 | (2)
i | int | integer | 4 | (2)
I | unsigned int | integer | 4 | (2)
l | long | integer | 4 | (2)
L | unsigned long | integer | 4 | (2)
q | long long | integer | 8 | (2)
Q | unsigned long long | integer | 8 | (2)
n | ssize_t | integer |  | (3)
N | size_t | integer |  | (3)
e | (6) | float | 2 | (4)
f | float | float | 4 | (4)
d | double | float | 8 | (4)
s | char[] | 字节串 |  | (9)
p | char[] | 字节串 |  | (8)
P | void* | integer |  | (5)

在 3.3 版更改: 增加了对 'n' 和 'N' 格式的支持

在 3.6 版更改: 添加了对 'e' 格式的支持。

注释：

'?' 转换码对应于 C99 对应的 _Bool 类型。 如此此类型不可用，则使用 char 来模块。 在标准模式下，它总是以一个字节表示。

当尝试使用任何整数转换码打包一个非整数时，如果该非整数具有 __index__() 方法，则会在打包之前调用该方法将参数转换为一个整数。

在 3.2 版更改: 增加了针对非整数使用 __index__() 方法的特性。

'n' 和 'N' 转换码仅对本机大小可用（选择为默认或使用 '@' 字节顺序字符）。 对于标准大小，你可以使用适合你的应用的任何其他整数格式。

对于 'f', 'd' 和 'e' 转换码，打包表示形式将使用 IEEE 754 binary32, binary64 或 binary16 格式 (分别对应于 'f', 'd' 或 'e')，无论平台使用何种浮点格式。

'P' 格式字符仅对本机字节顺序可用（选择为默认或使用 '@' 字节顺序字符）。 字节顺序字符 '=' 选择使用基于主机系统的小端或大端排序。 struct 模块不会将其解读为本机排序，因此 'P' 格式将不可用。

IEEE 754 binary16 "半精度" 类型是在 IEEE 754 标准 [https://en.wikipedia.org/wiki/IEEE_754-2008_revision] 的 2008 修订版中引入的。 它包含一个符号位，5 个指数位和 11 个精度位（明确存储 10 位），可以完全精确地表示大致范围在 6.1e-05 和 6.5e+04 之间的数字。 此类型并不被 C 编译器广泛支持：在一台典型的机器上，可以使用 unsigned short 进行存储，但不会被用于数学运算。 请参阅维基百科页面 half-precision floating-point format [https://en.wikipedia.org/wiki/Half-precision_floating-point_format] 了解详情。

在打包时，'x' 会插入一个 NUL 字节。

'p' 格式字符用于编码“Pascal 字符串”，即存储在由计数指定的 固定长度字节 中的可变长度短字符串。 所存储的第一个字节为字符串长度或 255 中的较小值。 之后是字符串对应的字节。 如果传入 pack() 的字符串过长（超过计数值减 1），则只有字符串前 count-1 个字节会被存储。 如果字符串短于 count-1，则会填充空字节以使得恰好使用了 count 个字节。 请注意对于 unpack()，'p' 格式字符会消耗 count 个字节，但返回的字符串永远不会包含超过 255 个字节。

对于 's' 格式字符，计数会被解读为字节的长度，而不是像其他格式字符那样的重复计数；例如，'10s' 表示一个与特定的 Python 字节串互相映射的长度为 10 的字节数据，而 '10c' 则表示个 10 个与十个不同的 Python 字节对象互相映射的独立的一字节字符元素 (如 cccccccccc)。 (其中的差别的具体演示请参见 例子。) 如果未给出计数，则默认值为 1。 对于打包操作，字节串会被适当地截断或填充空字节以符合尺寸要求。 对于解包操作，结果字节对象总是会恰好具有指定数量的字节。 作为特例，'0s' 表示单个空字节串 (而 '0c' 表示 0 个字符)。

格式字符之前可以带有整数重复计数。 例如，格式字符串 '4h' 的含义与 'hhhh' 完全相同。

格式之间的空白字符会被忽略；但是计数及其格式字符中不可有空白字符。

当使用某一种整数格式 ('b', 'B', 'h', 'H', 'i', 'I', 'l', 'L', 'q', 'Q') 打包值 x 时，如果 x 在该格式的有效范围之外则将引发 struct.error。

在 3.1 版更改: 在之前版本中，某些整数格式包装了超范围的值并会引发 DeprecationWarning 而不是 struct.error。

对于 '?' 格式字符，返回值为 True 或 False。 在打包时将会使用参数对象的逻辑值。 以本机或标准 bool 类型表示的 0 或 1 将被打包，任何非零值在解包时将为 True。

例子

注解

原生字节顺序的示例 (由 '@' 格式前缀或不带任何前缀字符的形式指定) 可能与读者机器所产生的内容不匹配，因为这取决于具体的平台和编译器。

打包和解包三种不同大小的整数，使用大端序:

>>> 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

尝试打包一个对于所定义字段来说过大的整数:

>>> pack(">h", 99999)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
struct.error: 'h' format requires -32768 <= number <= 32767

显示 's' and 'c' 格式字符之间的差异:

>>> pack("@ccc", b'1', b'2', b'3')
b'123'
>>> pack("@3s", b'123')
b'123'

解包的字段可通过将它们赋值给变量或将结果包装为一个具名元组来命名:

>>> 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)

格式字符的顺序可能会因为填充是隐式的而对在原生模式中的大小产生影响。 在标准模式下，用户要负责插入任何必要的填充。 请注意下面的第一个 pack 调用中在已打包的 '#' 之后添加了三个 NUL 字节以便在四字节边界上对齐到下面的整数。 在这个例子中，输出是在一台小端序的机器上产生的:

>>> 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

以下格式 'llh0l' 将会在末尾添加两个填充字节，假定平台的 long 类型按 4 个字节的边界对齐的话:

>>> pack('@llh0l', 1, 2, 3)
b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'

参见

模块 array

被打包为二进制存储的同质数据。

模块 json

JSON 编码器和解码器。

模块 pickle

Python 对象序列化。

应用

struct 模块存在两个主要应用，即在一个应用程序或使用相同编译器编译的另一个应用程序中 Python 和 C 代码之间的数据交换 (原生格式)，以及使用商定的数据布局的应用程序之间的数据交换 (标准格式)。 一般来说，针对这两个领域构造的格式字符串是不一样的。

原生格式

When constructing format strings which mimic native layouts, the compiler and machine architecture determine byte ordering and padding. In such cases, the @ format character should be used to specify native byte ordering and data sizes. Internal pad bytes are normally inserted automatically. It is possible that a zero-repeat format code will be needed at the end of a format string to round up to the correct byte boundary for proper alignment of consective chunks of data.

请看这两个简单的示例（在 64 位的小端序机器上）:

>>> calcsize('@lhl')
24
>>> calcsize('@llh')
18

在不使用额外填充的情况下不会将数据填充到第二个格式字符串末尾的 8 字节边界上。 零重复的格式代码解决了这个问题:

>>> calcsize('@llh0l')
24

'x' 格式代码可被用来指定重复，但对于原生格式来说最好是使用 '0l' 这样的零重复格式。

在默认情况下，将使用原生字节顺序和对齐，但最好是显式指定并使用 '@' 前缀字符。

标准格式

当与你的进程之外如网络或存储交换数据时，请务必保持精确。 准确地指定字节顺序、大小和对齐。 不要假定它们与特定机器的原生顺序相匹配。 例如，网络字节顺序是大端序的，而许多流行的 CPU 则是小端序的。 通过显式定义，用户将无需关心他们的代码运行所在平台的具体规格。 第一个字符通常应为 < 或 > (或者 !)。 程序员要负责填充操作。 零重复格式字符是无效的。 相反，用户必须在需要时显式地添加 'x' 填充字节。 回顾上一节中的示例，我们得到:

>>> 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

上述结果（在 64 位机器上执行）不保证在不同的机器上执行时仍能匹配。 例如，以下示例是在 32 位机器上执行的:

>>> calcsize('<qqh6x')
24
>>> calcsize('@llh0l')
12
>>> pack('@llh0l', 1, 2, 3) == pack('<qqh6x', 1, 2, 3)
False

类

struct 模块还定义了以下类型：

class struct.Struct(format)

返回一个新的 Struct 对象，它会根据格式字符串 format 来写入和读取二进制数据。 一次性地创建 Struct 对象并调用其方法相比调用相同格式的模块层级函数效率更高因为格式字符串只会被编译一次。

注解

传递给 Struct 和模块层级函数的已编译版最新格式字符串会被缓存，因此只使用少量格式字符串的程序无需担心重用单独的 Struct 实例。

已编译的 Struct 对象支持以下方法和属性：

pack(v1, v2, ...)

等价于 pack() 函数，使用了已编译的格式。 (len(result) 将等于 size。)

pack_into(buffer, offset, v1, v2, ...)

等价于 pack_into() 函数，使用了已编译的格式。

unpack(buffer)

等价于 unpack() 函数，使用了已编译的格式。 缓冲区的字节大小必须等于 size。

unpack_from(buffer, offset=0)

等价于 unpack_from() 函数，使用了已编译的格式。 缓冲区的字节大小从位置 offset 开始必须至少为 size。

iter_unpack(buffer)

等价于 iter_unpack() 函数，使用了已编译的格式。 缓冲区的大小必须为 size 的整数倍。

3.4 新版功能.

format

用于构造此 Struct 对象的格式字符串。

在 3.7 版更改: 格式字符串类型现在是 str 而不再是 bytes。

size

计算出对应于 format 的结构大小（亦即 pack() 方法所产生的字节串对象的大小）。

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

源代码： Lib/codecs.py [https://github.com/python/cpython/tree/3.10/Lib/codecs.py]

这个模块定义了标准 Python 编解码器（编码器和解码器）的基类并提供对内部 Python 编解码器注册表的访问，该注册表负责管理编解码器和错误处理的查找过程。 大多数标准编解码器都属于 文本编码格式，它们可将文本编码为字节串（以及将字节串解码为文本），但也提供了一些将文本编码为文本，以及将字节串编码为字节串的编解码器。 自定义编解码器可以在任意类型间进行编码和解码，但某些模块特性被限制为仅适用于 文本编码格式 或将数据编码为 bytes 的编解码器。

该模块定义了以下用于使用任何编解码器进行编码和解码的函数:

codecs.encode(obj, encoding='utf-8', errors='strict')

使用为 encoding 注册的编解码器对 obj 进行编码。

可以给定 Errors 以设置所需要的错误处理方案。 默认的错误处理方案 'strict' 表示编码错误将引发 ValueError (或更特定编解码器相关的子类，例如 UnicodeEncodeError)。 请参阅 编解码器基类 了解有关编解码器错误处理的更多信息。

codecs.decode(obj, encoding='utf-8', errors='strict')

使用为 encoding 注册的编解码器对 obj 进行解码。

可以给定 Errors 以设置所需要的错误处理方案。 默认的错误处理方案 'strict' 表示编码错误将引发 ValueError (或更特定编解码器相关的子类，例如 UnicodeDecodeError)。 请参阅 编解码器基类 了解有关编解码器错误处理的更多信息。

每种编解码器的完整细节也可以直接查找获取：

codecs.lookup(encoding)

在 Python 编解码器注册表中查找编解码器信息，并返回一个 CodecInfo 对象，其定义见下文。

首先将会在注册表缓存中查找编码，如果未找到，则会扫描注册的搜索函数列表。 如果没有找到 CodecInfo 对象，则将引发 LookupError。 否则，CodecInfo 对象将被存入缓存并返回给调用者。

class codecs.CodecInfo(encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None)

查找编解码器注册表所得到的编解码器细节信息。 构造器参数将保存为同名的属性：

name

编码名称

encode

decode

无状态的编码和解码函数。 它们必须是具有与 Codec 的 encode() 和 decode() 方法相同接口的函数或方法 (参见 Codec 接口)。 这些函数或方法应当工作于无状态的模式。

incrementalencoder

incrementaldecoder

增量式的编码器和解码器类或工厂函数。 这些函数必须分别提供由基类 IncrementalEncoder 和 IncrementalDecoder 所定义的接口。 增量式编解码器可以保持状态。

streamwriter

streamreader

流式写入器和读取器类或工厂函数。 这些函数必须分别提供由基类 StreamWriter 和 StreamReader 所定义的接口。 流式编解码器可以保持状态。

为了简化对各种编解码器组件的访问，本模块提供了以下附加函数，它们使用 lookup() 来执行编解码器查找：

codecs.getencoder(encoding)

查找给定编码的编解码器并返回其编码器函数。

在编码无法找到时将引发 LookupError。

codecs.getdecoder(encoding)

查找给定编码的编解码器并返回其解码器函数。

在编码无法找到时将引发 LookupError。

codecs.getincrementalencoder(encoding)

查找给定编码的编解码器并返回其增量式编码器类或工厂函数。

在编码无法找到或编解码器不支持增量式编码器时将引发 LookupError。

codecs.getincrementaldecoder(encoding)

查找给定编码的编解码器并返回其增量式解码器类或工厂函数。

在编码无法找到或编解码器不支持增量式解码器时将引发 LookupError。

codecs.getreader(encoding)

查找给定编码的编解码器并返回其 StreamReader 类或工厂函数。

在编码无法找到时将引发 LookupError。

codecs.getwriter(encoding)

查找给定编码的编解码器并返回其 StreamWriter 类或工厂函数。

在编码无法找到时将引发 LookupError。

自定义编解码器的启用是通过注册适当的编解码器搜索函数：

codecs.register(search_function)

注册一个编解码器搜索函数。 搜索函数预期接收一个参数，即全部以小写字母表示的编码格式名称，其中中连字符和空格会被转换为下划线，并返回一个 CodecInfo 对象。 在搜索函数无法找到给定编码格式的情况下，它应当返回 None。

在 3.9 版更改: 连字符和空格会被转换为下划线。

codecs.unregister(search_function)

注销一个编解码器搜索函数并清空注册表缓存。 如果指定搜索函数未被注册，则不做任何操作。

3.10 新版功能.

虽然内置的 open() 和相关联的 io 模块是操作已编码文本文件的推荐方式，但本模块也提供了额外的工具函数和类，允许在操作二进制文件时使用更多种类的编解码器：

codecs.open(filename, mode='r', encoding=None, errors='strict', buffering=- 1)

使用给定的 mode 打开已编码的文件并返回一个 StreamReaderWriter 的实例，提供透明的编码/解码。 默认的文件模式为 'r'，表示以读取模式打开文件。

注解

如果 encoding 不为 None，则下层的已编码文件总是以二进制模式打开。 在读取和写入时不会自动执行 '\n' 的转换。 mode 参数可以是内置 open() 函数所接受的任意二进制模式；'b' 会被自动添加。

encoding 指定文件所要使用的编码格式。 允许任何编码为字节串或从字节串解码的编码格式，而文件方法所支持的数据类型则取决于所使用的编解码器。

可以指定 errors 来定义错误处理方案。 默认值 'strict' 表示在出现编码错误时引发 ValueError。

buffering 的含义与内置 open() 函数中的相同。 默认值 -1 表示将使用默认的缓冲区大小。

codecs.EncodedFile(file, data_encoding, file_encoding=None, errors='strict')

返回一个 StreamRecoder 实例，它提供了 file 的透明转码包装版本。 当包装版本被关闭时原始文件也会被关闭。

写入已包装文件的数据会根据给定的 data_encoding 解码，然后以使用 file_encoding 的字节形式写入原始文件。 从原始文件读取的字节串将根据 file_encoding 解码，其结果将使用 data_encoding 进行编码。

如果 file_encoding 未给定，则默认为 data_encoding。

可以指定 errors 来定义错误处理方案。 默认值 'strict' 表示在出现编码错误时引发 ValueError。

codecs.iterencode(iterator, encoding, errors='strict', **kwargs)

使用增量式编码器通过迭代来编码由 iterator 所提供的输入。 此函数属于 generator。 errors 参数（以及任何其他关键字参数）会被传递给增量式编码器。

此函数要求编解码器接受 str 对象形式的文本进行编码。 因此它不支持字节到字节的编码器，例如 base64_codec。

codecs.iterdecode(iterator, encoding, errors='strict', **kwargs)

使用增量式解码器通过迭代来解码由 iterator 所提供的输入。 此函数属于 generator。 errors 参数（以及任何其他关键字参数）会被传递给增量式解码器。

此函数要求编解码器接受 bytes 对象进行解码。 因此它不支持文本到文本的编码器，例如 rot_13，但是 rot_13 可以通过同样效果的 iterencode() 来使用。

本模块还提供了以下常量，适用于读取和写入依赖于平台的文件：

codecs.BOM

codecs.BOM_BE

codecs.BOM_LE

codecs.BOM_UTF8

codecs.BOM_UTF16

codecs.BOM_UTF16_BE

codecs.BOM_UTF16_LE

codecs.BOM_UTF32

codecs.BOM_UTF32_BE

codecs.BOM_UTF32_LE

这些常量定义了多种字节序列，即一些编码格式的 Unicode 字节顺序标记（BOM）。 它们在 UTF-16 和 UTF-32 数据流中被用以指明所使用的字节顺序，并在 UTF-8 中被用作 Unicode 签名。 BOM_UTF16 是 BOM_UTF16_BE 或 BOM_UTF16_LE，具体取决于平台的本机字节顺序，BOM 是 BOM_UTF16 的别名, BOM_LE 是 BOM_UTF16_LE 的别名，BOM_BE 是 BOM_UTF16_BE 的别名。 其他序列则表示 UTF-8 和 UTF-32 编码格式中的 BOM。

编解码器基类

codecs 模块定义了一系列基类用来定义配合编解码器对象进行工作的接口，并且也可用作定制编解码器实现的基础。

每种编解码器必须定义四个接口以便用作 Python 中的编解码器：无状态编码器、无状态解码器、流读取器和流写入器。 流读取器和写入器通常会重用无状态编码器/解码器来实现文件协议。 编解码器作者还需要定义编解码器将如何处理编码和解码错误。

错误处理方案

为了简化和标准化错误处理，编解码器可以通过接受 errors 字符串参数来实现不同的错误处理方案:

>>> 'German ß, ♬'.encode(encoding='ascii', errors='backslashreplace')
b'German \\xdf, \\u266c'
>>> 'German ß, ♬'.encode(encoding='ascii', errors='xmlcharrefreplace')
b'German &#223;, &#9836;'

以下错误处理器可以用于所有的 Python 标准编码 编解码器:

值 | 含意
'strict' | 引发 UnicodeError (或其子类)，这是默认的方案。 在 strict_errors() 中实现。
'ignore' | 忽略错误格式的数据并且不加进一步通知就继续执行。 在 ignore_errors() 中实现。
'replace' | 用一个替代标记来替换。 在编码时，使用 ? (ASCII 字符)。 在解码时，使用 � (U+FFFD，官方的 REPLACEMENT CHARACTER)。 在 replace_errors() 中实现。
'backslashreplace' | 用反斜杠转义序列来替换。 在编码时，使用格式为 \xhh \uxxxx \Uxxxxxxxx 的 Unicode 码位十六进制表示形式。 在解码时，使用格式为 \xhh 的字节值十六进制表示形式。 在 backslashreplace_errors() 中实现。
'surrogateescape' | 在解码时，将字节替换为 U+DC80 至 U+DCFF 范围内的单个代理代码。 当在编码数据时使用 'surrogateescape' 错误处理方案时，此代理将被转换回相同的字节。 （请参阅 PEP 383 [https://www.python.org/dev/peps/pep-0383] 了解详情。）

下列错误处理器仅在编码时适用（在 文本编码格式 类别以内）:

值 | 含意
'xmlcharrefreplace' | 用 XML/HTML 数字字符引用来替换，即格式为 &#num; 的 Unicode 码位十进制表达形式。 在 xmlcharrefreplace_errors() 中实现。
'namereplace' | 用 \N{...} 转义序列来替换，出现在花括号中的是来自 Unicode 字符数据库的 Name 属性。 在 namereplace_errors() 中实现。

此外，以下错误处理方案被专门用于指定的编解码器：

值 | 编解码器 | 含意
'surrogatepass' | utf-8, utf-16, utf-32, utf-16-be, utf-16-le, utf-32-be, utf-32-le | 允许将代理码位 (U+D800 - U+DFFF) 作为正常码位来编码和解码。 否则这些编解码器会将 str 中出现的代理码位视为错误。

3.1 新版功能: 'surrogateescape' 和 'surrogatepass' 错误处理方案。

在 3.4 版更改: 'surrogatepass' 错误处理器现在可适用于 utf-16* 和 utf-32* 编解码器。

3.5 新版功能: 'namereplace' 错误处理方案。

在 3.5 版更改: 'backslashreplace' 错误处理器现在可适用于解码和转码。

允许的值集合可以通过注册新命名的错误处理方案来扩展：

codecs.register_error(name, error_handler)

在名称 name 之下注册错误处理函数 error_handler。 当 name 被指定为错误形参时，error_handler 参数所指定的对象将在编码和解码期间发生错误的情况下被调用，

对于编码操作，将会调用 error_handler 并传入一个 UnicodeEncodeError 实例，其中包含有关错误位置的信息。 错误处理程序必须引发此异常或别的异常，或者也可以返回一个元组，其中包含输入的不可编码部分的替换对象，以及应当继续进行编码的位置。 替换对象可以为 str 或 bytes 类型。 如果替换对象为字节串，编码器将简单地将其复制到输出缓冲区。 如果替换对象为字符串，编码器将对替换对象进行编码。 对原始输入的编码操作会在指定位置继续进行。 负的位置值将被视为相对于输入字符串的末尾。 如果结果位置超出范围则将引发 IndexError。

解码和转换的做法很相似，不同之处在于将把 UnicodeDecodeError 或 UnicodeTranslateError 传给处理程序，并且来自错误处理程序的替换对象将被直接放入输出。

之前注册的错误处理方案（包括标准错误处理方案）可通过名称进行查找：

codecs.lookup_error(name)

返回之前在名称 name 之下注册的错误处理方案。

在处理方案无法找到时将引发 LookupError。

以下标准错误处理方案也可通过模块层级函数的方式来使用：

codecs.strict_errors(exception)

实现了 'strict' 错误处理。

每个编码或解码错误都将引发 UnicodeError。

codecs.ignore_errors(exception)

实现了 'ignore' 错误处理。

错误格式的数据会被忽略；编码或解码将继续执行而不再通知。

codecs.replace_errors(exception)

实现了 'replace' 错误处理。

替换 ? (ASCII 字符) 表示编码错误或者 � (U+FFFD，官方的 REPLACEMENT CHARACTER) 表示解码错误。

codecs.backslashreplace_errors(exception)

实现了 'backslashreplace' 错误处理。

错误格式的数据会用反斜杠转义序列来替换。 在编码时，使用格式为 \xhh \uxxxx \Uxxxxxxxx 的 Unicode 码位十六进制表示形式。 在解码时，使用格式为 \xhh 的字节值十六进制表示形式。

在 3.5 版更改: 适用于解码和转码。

codecs.xmlcharrefreplace_errors(exception)

实现 'xmlcharrefreplace' 错误处理（仅限 text encoding 范围内的编码操作）。

不可编码的字符会被替换为适当的 XML/HTML 数值字符引用，即格式为 &#num; 的十进制形式 Unicode 码位。

codecs.namereplace_errors(exception)

实现 'namereplace' 错误处理（仅限 text encoding 范围内的编码操作）。

不可编码的字符会被替换为 \N{...} 转义序列。 出现在花括号内的字符集合是来自于 Unicode 字符数据库的 Name 属性。 例如，德语小写字母 'ß' 将被转换为字符序列 \N{LATIN SMALL LETTER SHARP S}。

3.5 新版功能.

无状态的编码和解码

基本 Codec 类定义了这些方法，同时还定义了无状态编码器和解码器的函数接口：

Codec.encode(input, errors='strict')

编码 input 对象并返回一个元组 (输出对象, 消耗长度)。 例如，text encoding 会使用特定的字符集编码格式 (例如 cp1252 或 iso-8859-1) 将字符串转换为字节串对象。

errors 参数定义了要应用的错误处理方案。 默认为 'strict' 处理方案。

此方法不一定会在 Codec 实例中保存状态。 可使用必须保存状态的 StreamWriter 作为编解码器以便高效地进行编码。

编码器必须能够处理零长度的输入并在此情况下返回输出对象类型的空对象。

Codec.decode(input, errors='strict')

解码 input 对象并返回一个元组 (输出对象, 消耗长度)。 例如，text encoding 的解码操作会使用特定的字符集编码格式将字节串对象转换为字符串对象。

对于文本编码格式和字节到字节编解码器，input 必须为一个字节串对象或提供了只读缓冲区接口的对象 -- 例如，缓冲区对象和映射到内存的文件。

errors 参数定义了要应用的错误处理方案。 默认为 'strict' 处理方案。

此方法不一定会在 Codec 实例中保存状态。 可使用必须保存状态的 StreamReader 作为编解码器以便高效地进行解码。

解码器必须能够处理零长度的输入并在此情况下返回输出对象类型的空对象。

增量式的编码和解码

IncrementalEncoder 和 IncrementalDecoder 类提供了增量式编码和解码的基本接口。 对输入的编码/解码不是通过对无状态编码器/解码器的一次调用，而是通过对增量式编码器/解码器的 encode()/decode() 方法的多次调用。 增量式编码器/解码器会在方法调用期间跟踪编码/解码过程。

调用 encode()/decode() 方法后的全部输出相当于将所有通过无状态编码器/解码器进行编码/解码的单个输入连接在一起所得到的输出。

IncrementalEncoder 对象

IncrementalEncoder 类用来对一个输入进行分步编码。 它定义了以下方法，每个增量式编码器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

class codecs.IncrementalEncoder(errors='strict')

IncrementalEncoder 实例的构造器。

所有增量式编码器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

IncrementalEncoder 可以通过提供 errors 关键字参数来实现不同的错误处理方案。 可用的值请参阅 错误处理方案。

errors 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 IncrementalEncoder 对象的生命期内在不同的错误处理策略之间进行切换。

encode(object, final=False)

编码 object (会将编码器的当前状态纳入考虑) 并返回已编码的结果对象。 如果这是对 encode() 的最终调用则 final 必须为真值（默认为假值）。

reset()

将编码器重置为初始状态。 输出将被丢弃：调用 .encode(object, final=True)，在必要时传入一个空字节串或字符串，重置编码器并得到输出。

getstate()

返回编码器的当前状态，该值必须为一个整数。 实现应当确保 0 是最常见的状态。 （比整数更复杂的状态表示可以通过编组/选择状态并将结果字符串的字节数据编码为整数来转换为一个整数值）。

setstate(state)

将编码器的状态设为 state。 state 必须为 getstate() 所返回的一个编码器状态。

IncrementalDecoder 对象

IncrementalDecoder 类用来对一个输入进行分步解码。 它定义了以下方法，每个增量式解码器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

class codecs.IncrementalDecoder(errors='strict')

IncrementalDecoder 实例的构造器。

所有增量式解码器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

IncrementalDecoder 可以通过提供 errors 关键字参数来实现不同的错误处理方案。 可用的值请参阅 错误处理方案。

errors 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 IncrementalDecoder 对象的生命期内在不同的错误处理策略之间进行切换。

decode(object, final=False)

解码 object (会将解码器的当前状态纳入考虑) 并返回已解码的结果对象。 如果这是对 decode() 的最终调用则 final 必须为真值（默认为假值）。 如果 final 为真值则解码器必须对输入进行完全解码并且必须 刷新所有缓冲区。 如果这无法做到（例如由于在输入结束时字节串序列不完整）则它必须像在无状态的情况下那样初始化错误处理（这可能引发一个异常）。

reset()

将解码器重置为初始状态。

getstate()

返回解码器的当前状态。 这必须为一个二元组，第一项必须是包含尚未解码的输入的缓冲区。 第二项必须为一个整数，可以表示附加状态信息。 （实现应当确保 0 是最常见的附加状态信息。） 如果此附加状态信息为 0 则必须可以将解码器设为没有已缓冲输入并且以 0 作为附加状态信息，以便将先前已缓冲的输入馈送到解码器使其返回到先前的状态而不产生任何输出。 （比整数更复杂的附加状态信息可以通过编组/选择状态信息并将结果字符串的字节数据编码为整数来转换为一个整数值。）

setstate(state)

将解码器的状态设为 state。 state 必须为 getstate() 所返回的一个解码器状态。

流式的编码和解码

StreamWriter 和 StreamReader 类提供了一些泛用工作接口，可被用来非常方便地实现新的编码格式子模块。 请参阅 encodings.utf_8 中的示例了解如何做到这一点。

StreamWriter 对象

StreamWriter 类是 Codec 的子类，它定义了以下方法，每个流式写入器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

class codecs.StreamWriter(stream, errors='strict')

StreamWriter 实例的构造器。

所有流式写入器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

stream 参数必须为一个基于特定编解码器打开用于写入文本或二进制数据的文件型对象。

StreamWriter 可以通过提供 errors 关键字参数来实现不同的错误处理方案。 请参阅 错误处理方案 了解下层的流式编解码器可支持的标准错误处理方案。

errors 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 StreamWriter 对象的生命期内在不同的错误处理策略之间进行切换。

write(object)

将编码后的对象内容写入到流。

writelines(list)

将拼接后的字符串可迭代对象写入到流（可能通过重用 write() 方法）。 无限长或非常大的可迭代对象不受支持。 标准的字节到字节编解码器不支持此方法。

reset()

重置用于保持内部状态的编解码器缓冲区。

调用此方法应当确保在干净的状态下放入输出数据，以允许直接添加新的干净数据而无须重新扫描整个流来恢复状态。

除了上述的方法，StreamWriter 还必须继承来自下层流的所有其他方法和属性。

StreamReader 对象

StreamReader 类是 Codec 的子类，它定义了以下方法，每个流式读取器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

class codecs.StreamReader(stream, errors='strict')

StreamReader 实例的构造器。

所有流式读取器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

stream 参数必须为一个基于特定编解码器打开用于读取文本或二进制数据的文件型对象。

StreamReader 可以通过提供 errors 关键字参数来实现不同的错误处理方案。 请参阅 错误处理方案 了解下层的流式编解码器可支持的标准错误处理方案。

errors 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 StreamReader 对象的生命期内在不同的错误处理策略之间进行切换。

errors 参数所允许的值集合可以使用 register_error() 来扩展。

read(size=- 1, chars=- 1, firstline=False)

解码来自流的数据并返回结果对象。

chars 参数指明要返回的解码后码位或字节数量。 read() 方法绝不会返回超出请求数量的数据，但如果可用数量不足，它可能返回少于请求数量的数据。

size 参数指明要读取并解码的已编码字节或码位的最大数量近似值。 解码器可以适当地修改此设置。 默认值 -1 表示尽可能多地读取并解码。 此形参的目的是防止一次性解码过于巨大的文件。

firstline 旗标指明如果在后续行发生解码错误，则仅返回第一行就足够了。

此方法应当使用“贪婪”读取策略，这意味着它应当在编码格式定义和给定大小所允许的情况下尽可能多地读取数据，例如，如果在流上存在可选的编码结束或状态标记，这些内容也应当被读取。

readline(size=None, keepends=True)

从输入流读取一行并返回解码后的数据。

如果给定了 size，则将其作为 size 参数传递给流的 read() 方法。

如果 keepends 为假值，则行结束符将从返回的行中去除。

readlines(sizehint=None, keepends=True)

从输入流读取所有行并将其作为一个行列表返回。

行结束符会使用编解码器的 decode() 方法来实现，并且如果 keepends 为真值则会将其包含在列表条目中。

如果给定了 sizehint，则将其作为 size 参数传递给流的 read() 方法。

reset()

重置用于保持内部状态的编解码器缓冲区。

请注意不应当对流进行重定位。 使用此方法的主要目的是为了能够从解码错误中恢复。

除了上述的方法，StreamReader 还必须继承来自下层流的所有其他方法和属性。

StreamReaderWriter 对象

StreamReaderWriter 是一个方便的类，允许对同时工作于读取和写入模式的流进行包装。

其设计使得开发者可以使用 lookup() 函数所返回的工厂函数来构造实例。

class codecs.StreamReaderWriter(stream, Reader, Writer, errors='strict')

创建一个 StreamReaderWriter 实例。 stream 必须为一个文件型对象。 Reader 和 Writer 必须为分别提供了 StreamReader 和 StreamWriter 接口的工厂函数或类。 错误处理通过与流式读取器和写入器所定义的相同方式来完成。

StreamReaderWriter 实例定义了 StreamReader 和 StreamWriter 类的组合接口。 它们还继承了来自下层流的所有其他方法和属性。

StreamRecoder 对象

StreamRecoder 将数据从一种编码格式转换为另一种，这对于处理不同编码环境的情况有时会很有用。

其设计使得开发者可以使用 lookup() 函数所返回的工厂函数来构造实例。

class codecs.StreamRecoder(stream, encode, decode, Reader, Writer, errors='strict')

创建一个实现了双向转换的 StreamRecoder 实例: encode 和 decode 工作于前端 — 对代码可见的数据调用 read() 和 write()，而 Reader 和 Writer 工作于后端 — stream 中的数据。

你可以使用这些对象来进行透明转码，例如从 Latin-1 转为 UTF-8 以及反向转换。

stream 参数必须为一个文件型对象。

encode 和 decode 参数必须遵循 Codec 接口。 Reader 和 Writer 必须为分别提供了 StreamReader 和 StreamWriter 接口对象的工厂函数或类。

错误处理通过与流式读取器和写入器所定义的相同方式来完成。

StreamRecoder 实例定义了 StreamReader 和 StreamWriter 类的组合接口。 它们还继承了来自下层流的所有其他方法和属性。

编码格式与 Unicode

字符串在系统内部存储为 U+0000--U+10FFFF 范围内的码位序列。 （请参阅 PEP 393 [https://www.python.org/dev/peps/pep-0393] 了解有关实现的详情。） 一旦字符串对象要在 CPU 和内存以外使用，字节的大小端顺序和字节数组的存储方式就成为一个影响因素。 如同使用其他编解码器一样，将字符串序列化为字节序列被称为 编码，而从字节序列重建字符串被称为 解码。 存在许多不同的文本序列化编解码器，它们被统称为 文本编码格式。

最简单的文本编码格式 (称为 'latin-1' 或 'iso-8859-1') 将码位 0--255 映射为字节值 0x0--0xff，这意味着包含 U+00FF 以上码位的字符串对象无法使用此编解码器进行编码。 这样做将引发 UnicodeEncodeError，其形式类似下面这样（不过详细的错误信息可能会有所不同）: UnicodeEncodeError: 'latin-1' codec can't encode character '\u1234' in position 3: ordinal not in range(256)。

还有另外一组编码格式（所谓的字符映射编码）会选择全部 Unicode 码位的不同子集并设定如何将这些码位映射为字节值 0x0--0xff。 要查看这是如何实现的，只需简单地打开相应源码例如 encodings/cp1252.py (这是一个主要在 Windows 上使用的编码格式)。 其中会有一个包含 256 个字符的字符串常量，指明每个字符所映射的字节值。

所有这些编码格式只能对 Unicode 所定义的 1114112 个码位中的 256 个进行编码。 一种能够存储每个 Unicode 码位的简单而直接的办法就是将每个友们存储为四个连续的字节。 存在两种不同的可能性：以大端序存储或以小端序存储。 这两种编码格式分别被称为 UTF-32-BE 和 UTF-32-LE。 他们共有的缺点可以举例说明：如果你在一台小端序的机器上使用 UTF-32-BE 则你必须在编码和解码时翻转字节。 UTF-32 避免了这个问题：字节的排列将总是使用自然端序。 当这些字节被具有不同端序的 CPU 读取时，则必须进行字节翻转。 为了能够检测 UTF-16 或 UTF-32 字节序列的大小端序，可以使用所谓的 BOM ("字节顺序标记")。 这对应于 Unicode 字符 U+FEFF。 此字符可被添加到每个 UTF-16 或 UTF-32 字节序列的开头。 此字符的字节翻转版本 (0xFFFE) 是一个不可出现于 Unicode 文本中的非法字符。 因此当发现一个 UTF-16 或 UTF-32 字节序列的首个字符是 U+FFFE 时，就必须在解码时进行字节翻转。 不幸的是字符 U+FEFF 还有第二个含义 ZERO WIDTH NO-BREAK SPACE: 即宽度为零并且不允许用来拆分单词的字符。 它可以被用来为语言分析算法提供提示。 在 Unicode 4.0 中使用 U+FEFF 表示 ZERO WIDTH NO-BREAK SPACE 已被弃用 (改用 U+2060 (WORD JOINER) 负责此任务)。 然而 Unicode 软件仍然必须能够处理 U+FEFF 的两个含义：作为 BOM 它被用来确定已编码字节的存储布局，并在字节序列被解码为字符串后将其去除；作为 ZERO WIDTH NO-BREAK SPACE 它是一个普通字符，将像其他字符一样被解码。

还有另一种编码格式能够对所有 Unicode 字符进行编码：UTF-8。 UTF-8 是一种 8 位编码，这意味着在 UTF-8 中没有字节顺序问题。 UTF-8 字节序列中的每个字节由两部分组成：标志位（最重要的位）和内容位。 标志位是由零至四个值为 1 的二进制位加一个值为 0 的二进制位构成的序列。 Unicode 字符会按以下形式进行编码（其中 x 为内容位，当拼接为一体时将给出对应的 Unicode 字符）:

范围 | 编码
U-00000000 ... U-0000007F | 0xxxxxxx
U-00000080 ... U-000007FF | 110xxxxx 10xxxxxx
U-00000800 ... U-0000FFFF | 1110xxxx 10xxxxxx 10xxxxxx
U-00010000 ... U-0010FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

Unicode 字符最不重要的一个位就是最右侧的二进制位 x。

由于 UTF-8 是一种 8 位编码格式，因此 BOM 是不必要的，并且已编码字符串中的任何 U+FEFF 字符（即使是作为第一个字符）都会被视为是 ZERO WIDTH NO-BREAK SPACE。

在没有外部信息的情况下将不可能毫无疑义地确定一个字符串使用了何种编码格式。 每种字符映射编码格式都可以解码任意的随机字节序列。 然而对 UTF-8 来说这却是不可能的，因为 UTF-8 字节序列具有不允许任意字节序列的特别结构。 为了提升 UTF-8 编码格式检测的可靠性，Microsoft 发明了一种 UTF-8 的变体形式 (Python 称之为 "utf-8-sig") 专门用于其 Notepad 程序：在任何 Unicode 字节被写入文件之前，会先写入一个 UTF-8 编码的 BOM (它看起来是这样一个字节序列: 0xef, 0xbb, 0xbf)。 由于任何字符映射编码后的文件都不大可能以这些字节值开头 (例如它们会映射为

LATIN SMALL LETTER I WITH DIAERESIS

RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK

INVERTED QUESTION MARK

对于 iso-8859-1 编码格式来说），这提升了根据字节序列来正确猜测 utf-8-sig 编码格式的成功率。 所以在这里 BOM 的作用并不是帮助确定生成字节序列所使用的字节顺序，而是作为帮助猜测编码格式的记号。 在进行编码时 utf-8-sig 编解码器将把 0xef, 0xbb, 0xbf 作为头三个字节写入文件。 在进行解码时 utf-8-sig 将跳过这三个字节，如果它们作为文件的头三个字节出现的话。 在 UTF-8 中并不推荐使用 BOM，通常应当避免它们的出现。

标准编码

Python 自带了许多内置的编解码器，它们的实现或者是通过 C 函数，或者是通过映射表。 以下表格是按名称排序的编解码器列表，并提供了一些常见别名以及编码格式通常针对的语言。 别名和语言列表都不是详尽无遗的。 请注意仅有大小写区别或使用连字符替代下划线的拼写形式也都是有效的别名；因此，'utf-8' 是 'utf_8' 编解码器的有效别名。

CPython 实现细节： 有些常见编码格式可以绕过编解码器查找机制来提升性能。 这些优化机会对于 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 等）以及给字符所分配的码位方面存在差异。 特别是对于欧洲语言来说，通常存在以下几种变体：

某个 ISO 8859 编码集

某个 Microsoft Windows 编码页，通常是派生自某个 8859 编码集，但会用附加的图形字符来替换控制字符。

某个 IBM EBCDIC 编码页

某个 IBM PC 编码页，通常会兼容 ASCII

编码 | 别名 | 语言
ascii | 646, us-ascii | 英语
big5 | big5-tw, csbig5 | 繁体中文
big5hkscs | big5-hkscs, hkscs | 繁体中文
cp037 | IBM037, IBM039 | 英语
cp273 | 273, IBM273, csIBM273 | 德语 3.4 新版功能.
cp424 | EBCDIC-CP-HE, IBM424 | 希伯来语
cp437 | 437, IBM437 | 英语
cp500 | EBCDIC-CP-BE, EBCDIC-CP-CH, IBM500 | 西欧
cp720 |  | 阿拉伯语
cp737 |  | 希腊语
cp775 | IBM775 | 波罗的海语言
cp850 | 850, IBM850 | 西欧
cp852 | 852, IBM852 | 中欧和东欧
cp855 | 855, IBM855 | 保加利亚语，白俄罗斯语，马其顿语，俄语，塞尔维亚语
cp856 |  | 希伯来语
cp857 | 857, IBM857 | 土耳其语
cp858 | 858, IBM858 | 西欧
cp860 | 860, IBM860 | 葡萄牙语
cp861 | 861, CP-IS, IBM861 | 冰岛语
cp862 | 862, IBM862 | 希伯来语
cp863 | 863, IBM863 | 加拿大语
cp864 | IBM864 | 阿拉伯语
cp865 | 865, IBM865 | 丹麦语/挪威语
cp866 | 866, IBM866 | 俄语
cp869 | 869, CP-GR, IBM869 | 希腊语
cp874 |  | 泰语
cp875 |  | 希腊语
cp932 | 932, ms932, mskanji, ms-kanji | 日语
cp949 | 949, ms949, uhc | 韩语
cp950 | 950, ms950 | 繁体中文
cp1006 |  | 乌尔都语
cp1026 | ibm1026 | 土耳其语
cp1125 | 1125, ibm1125, cp866u, ruscii | 乌克兰语 3.4 新版功能.
cp1140 | ibm1140 | 西欧
cp1250 | windows-1250 | 中欧和东欧
cp1251 | windows-1251 | 保加利亚语，白俄罗斯语，马其顿语，俄语，塞尔维亚语
cp1252 | windows-1252 | 西欧
cp1253 | windows-1253 | 希腊语
cp1254 | windows-1254 | 土耳其语
cp1255 | windows-1255 | 希伯来语
cp1256 | windows-1256 | 阿拉伯语
cp1257 | windows-1257 | 波罗的海语言
cp1258 | windows-1258 | 越南语
euc_jp | eucjp, ujis, u-jis | 日语
euc_jis_2004 | jisx0213, eucjis2004 | 日语
euc_jisx0213 | eucjisx0213 | 日语
euc_kr | euckr, korean, ksc5601, ks_c-5601, ks_c-5601-1987, ksx1001, ks_x-1001 | 韩语
gb2312 | chinese, csiso58gb231280, euc-cn, euccn, eucgb2312-cn, gb2312-1980, gb2312-80, iso-ir-58 | 简体中文
gbk | 936, cp936, ms936 | 统一汉语
gb18030 | gb18030-2000 | 统一汉语
hz | hzgb, hz-gb, hz-gb-2312 | 简体中文
iso2022_jp | csiso2022jp, iso2022jp, iso-2022-jp | 日语
iso2022_jp_1 | iso2022jp-1, iso-2022-jp-1 | 日语
iso2022_jp_2 | iso2022jp-2, iso-2022-jp-2 | 日语，韩语，简体中文，西欧，希腊语
iso2022_jp_2004 | iso2022jp-2004, iso-2022-jp-2004 | 日语
iso2022_jp_3 | iso2022jp-3, iso-2022-jp-3 | 日语
iso2022_jp_ext | iso2022jp-ext, iso-2022-jp-ext | 日语
iso2022_kr | csiso2022kr, iso2022kr, iso-2022-kr | 韩语
latin_1 | iso-8859-1, iso8859-1, 8859, cp819, latin, latin1, L1 | 西欧
iso8859_2 | iso-8859-2, latin2, L2 | 中欧和东欧
iso8859_3 | iso-8859-3, latin3, L3 | 世界语，马耳他语
iso8859_4 | iso-8859-4, latin4, L4 | 波罗的海语言
iso8859_5 | iso-8859-5, cyrillic | 保加利亚语，白俄罗斯语，马其顿语，俄语，塞尔维亚语
iso8859_6 | iso-8859-6, arabic | 阿拉伯语
iso8859_7 | iso-8859-7, greek, greek8 | 希腊语
iso8859_8 | iso-8859-8, hebrew | 希伯来语
iso8859_9 | iso-8859-9, latin5, L5 | 土耳其语
iso8859_10 | iso-8859-10, latin6, L6 | 北欧语言
iso8859_11 | iso-8859-11, thai | 泰语
iso8859_13 | iso-8859-13, latin7, L7 | 波罗的海语言
iso8859_14 | iso-8859-14, latin8, L8 | 凯尔特语
iso8859_15 | iso-8859-15, latin9, L9 | 西欧
iso8859_16 | iso-8859-16, latin10, L10 | 东南欧
johab | cp1361, ms1361 | 韩语
koi8_r |  | 俄语
koi8_t |  | 塔吉克 3.5 新版功能.
koi8_u |  | 乌克兰语
kz1048 | kz_1048, strk1048_2002, rk1048 | 哈萨克语 3.5 新版功能.
mac_cyrillic | maccyrillic | 保加利亚语，白俄罗斯语，马其顿语，俄语，塞尔维亚语
mac_greek | macgreek | 希腊语
mac_iceland | maciceland | 冰岛语
mac_latin2 | maclatin2, maccentraleurope, mac_centeuro | 中欧和东欧
mac_roman | macroman, macintosh | 西欧
mac_turkish | macturkish | 土耳其语
ptcp154 | csptcp154, pt154, cp154, cyrillic-asian | 哈萨克语
shift_jis | csshiftjis, shiftjis, sjis, s_jis | 日语
shift_jis_2004 | shiftjis2004, sjis_2004, sjis2004 | 日语
shift_jisx0213 | shiftjisx0213, sjisx0213, s_jisx0213 | 日语
utf_32 | U32, utf32 | 所有语言
utf_32_be | UTF-32BE | 所有语言
utf_32_le | UTF-32LE | 所有语言
utf_16 | U16, utf16 | 所有语言
utf_16_be | UTF-16BE | 所有语言
utf_16_le | UTF-16LE | 所有语言
utf_7 | U7, unicode-1-1-utf-7 | 所有语言
utf_8 | U8, UTF, utf8, cp65001 | 所有语言
utf_8_sig |  | 所有语言

在 3.4 版更改: utf-16* 和 utf-32* 编码器将不再允许编码代理码位 (U+D800--U+DFFF)。 utf-32* 解码器将不再解码与代理码位相对应的字节序列。

在 3.8 版更改: cp65001 现在是 utf_8 的一个别名。

Python 专属的编码格式

有一些预定义编解码器是 Python 专属的，因此它们在 Python 之外没有意义。 这些编解码器按其所预期的输入和输出类型在下表中列出（请注意虽然文本编码是编解码器最常见的使用场景，但下层的编解码器架构支持任意数据转换而不仅是文本编码）。 对于非对称编解码器，该列描述的含义是编码方向。

文字编码

以下编解码器提供了 str 到 bytes 的编码和 bytes-like object 到 str 的解码，类似于 Unicode 文本编码。

编码 | 别名 | 含意
idna |  | 实现 RFC 3490 [https://datatracker.ietf.org/doc/html/rfc3490.html]，另请参阅 encodings.idna 。仅支持 errors='strict' 。
mbcs | ansi, dbcs | Windows 专属：根据 ANSI 代码页（CP_ACP）对操作数进行编码。
oem |  | Windows 专属：根据 OEM 代码页（CP_OEMCP）对操作数进行编码。 3.6 新版功能.
palmos |  | PalmOS 3.5 的编码格式
punycode |  | 实现 RFC 3492 [https://datatracker.ietf.org/doc/html/rfc3492.html]。 不支持有状态编解码器。
raw_unicode_escape |  | Latin-1 编码格式附带对其他码位以 \uXXXX 和 \UXXXXXXXX 进行编码。 现有反斜杠不会以任何方式转义。 它被用于 Python 的 pickle 协议。
undefined |  | 所有转换都将引发异常，甚至对空字符串也不例外。 错误处理方案会被忽略。
unicode_escape |  | 适合用于以 ASCII 编码的 Python 源代码中的 Unicode 字面值内容的编码格式，但引号不会被转义。 对 Latin-1 源代码进行解码。 请注意 Python 源代码实际上默认使用 UTF-8。

在 3.8 版更改: "unicode_internal" 编解码器已被移除。

二进制转换

以下编解码器提供了二进制转换: bytes-like object 到 bytes 的映射。 它们不被 bytes.decode() 所支持（该方法只生成 str 类型的输出）。

编码 | 别名 | 含意 | 编码器/解码器
base64_codec 1 | base64, base_64 | 将操作数转换为多行 MIME base64 (结果总是包含一个末尾的 '\n') 在 3.4 版更改: 接受任意 bytes-like object 作为输入用于编码和解码 | base64.encodebytes() / base64.decodebytes()
bz2_codec | bz2 | 使用bz2压缩操作数 | bz2.compress() / bz2.decompress()
hex_codec | hex | 将操作数转换为十六进制表示，每个字节有两位数 | binascii.b2a_hex() / binascii.a2b_hex()
quopri_codec | quopri, quotedprintable, quoted_printable | 将操作数转换为 MIME 带引号的可打印数据 | quopri.encode() 且 quotetabs=True / quopri.decode()
uu_codec | uu | 使用uuencode转换操作数 | uu.encode() / uu.decode()
zlib_codec | zip, zlib | 使用gzip压缩操作数 | zlib.compress() / zlib.decompress()

1

除了 字节类对象，'base64_codec' 也接受仅包含 ASCII 的 str 实例用于解码

3.2 新版功能: 恢复二进制转换。

在 3.4 版更改: 恢复二进制转换的别名。

文字转换

以下编解码器提供了文本转换: str 到 str 的映射。 它不被 str.encode() 所支持（该方法只生成 bytes 类型的输出）。

编码 | 别名 | 含意
rot_13 | rot13 | 返回操作数的凯撒密码加密结果

3.2 新版功能: 恢复 rot_13 文本转换。

在 3.4 版更改: 恢复 rot13 别名。

encodings.idna --- 应用程序中的国际化域名

此模块实现了 RFC 3490 [https://datatracker.ietf.org/doc/html/rfc3490.html] (应用程序中的国际化域名) 和 RFC 3492 [https://datatracker.ietf.org/doc/html/rfc3492.html] (Nameprep: 用于国际化域名 (IDN) 的 Stringprep 配置文件)。 它是在 punycode 编码格式和 stringprep 的基础上构建的。

如果你需要来自 RFC 5891 [https://datatracker.ietf.org/doc/html/rfc5891.html] 和 RFC 5895 [https://datatracker.ietf.org/doc/html/rfc5895.html] 的 IDNA 2008 标准，请使用第三方 idna 模块 [https://pypi.org/project/idna/]。

这些 RFC 共同定义了一个在域名中支持非 ASCII 字符的协议。 一个包含非 ASCII 字符的域名 (例如 www.Alliancefrançaise.nu) 会被转换为兼容 ASCII 的编码格式 (简称 ACE，例如 www.xn--alliancefranaise-npb.nu)。 随后此域名的 ACE 形式可以用于所有由于特定协议而不允许使用任意字符的场合，例如 DNS 查询，HTTP Host 字段等等。 此转换是在应用中进行的；如有可能将对用户可见：应用应当透明地将 Unicode 域名标签转换为线上的 IDNA，并在 ACE 标签被呈现给用户之前将其转换回 Unicode。

Python 以多种方式支持这种转换: idna 编解码器执行 Unicode 和 ACE 之间的转换，基于在 section 3.1 of RFC 3490 [https://datatracker.ietf.org/doc/html/rfc3490.html#section-3.1] 中定义的分隔字符将输入字符串拆分为标签，再根据需要将每个标签转换为 ACE，相反地又会基于 . 分隔符将输入字节串拆分为标签，再将找到的任何 ACE 标签转换为 Unicode。 此外，socket 模块可透明地将 Unicode 主机名转换为 ACE，以便应用在将它们传给 socket 模块时无须自行转换主机名。 除此之外，许多包含以主机名作为函数参数的模块例如 http.client 和 ftplib 都接受 Unicode 主机名（并且 http.client 也会在 Host 字段中透明地发送 IDNA 主机名，如果它需要发送该字段的话）。

当从线路接收主机名时（例如反向名称查找），到 Unicode 的转换不会自动被执行：希望向用户提供此种主机名的应用应当将它们解码为 Unicode。

encodings.idna 模块还实现了 nameprep 过程，该过程会对主机名执行特定的规范化操作，以实现国际域名的大小写不敏感特性与合并相似的字符。 如果有需要可以直接使用 nameprep 函数。

encodings.idna.nameprep(label)

返回 label 经过名称处理操作的版本。 该实现目前基于查询字符串，因此 AllowUnassigned 为真值。

encodings.idna.ToASCII(label)

将标签转换为 ASCII，规则定义见 RFC 3490 [https://datatracker.ietf.org/doc/html/rfc3490.html]。 UseSTD3ASCIIRules 预设为假值。

encodings.idna.ToUnicode(label)

将标签转换为 Unicode，规则定义见 RFC 3490 [https://datatracker.ietf.org/doc/html/rfc3490.html]。

encodings.mbcs --- Windows ANSI代码页

此模块实现ANSI代码页（CP_ACP）。

Availability: 仅Windows可用

在 3.3 版更改: 支持任何错误处理

在 3.2 版更改: 在 3.2 版之前， errors 参数会被忽略；总是会使用 'replace' 进行编码，并使用 'ignore' 进行解码。

encodings.utf_8_sig --- 带BOM签名的UTF-8编解码器

此模块实现了 UTF-8 编解码器的一个变种：在编码时将把 UTF-8 已编码 BOM 添加到 UTF-8 编码字节数据的开头。 对于有状态编码器此操作只执行一次（当首次写入字节流时）。 在解码时将跳过数据开头作为可选项的 UTF-8 已编码 BOM。

数据类型

本章所描述的模块提供了许多专门的数据类型，如日期和时间、固定类型的数组、堆队列、双端队列、以及枚举。

Python也提供一些内置数据类型，特别是，dict、 list、set、frozenset、以及 tuple。str 这个类是用来存储Unicode字符串的，而 bytes 和 bytearray 这两个类是用来存储二进制数据的。

本章包含以下模块的文档：

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

感知型对象和简单型对象

常量

有效的类型

通用的特征属性

确定一个对象是感知型还是简单型

timedelta 类对象

timedelta 用法示例

date 对象

date 用法示例

datetime 对象

用法示例: datetime

time 对象

用法示例: time

tzinfo 对象

timezone 对象

strftime() 和 strptime() 的行为

strftime() 和 strptime() Format Codes

技术细节

zoneinfo --- IANA 时区支持

使用 ZoneInfo

数据源

配置数据源

编译时配置

环境配置

运行时配置

ZoneInfo 类

字符串表示

封存序列化

函数

全局变量

异常与警告

calendar --- 日历相关函数

collections --- 容器数据类型

ChainMap 对象

ChainMap 例子和方法

Counter 对象

deque 对象

deque 用法

defaultdict 对象

defaultdict 例子

namedtuple() 命名元组的工厂函数

OrderedDict 对象

OrderedDict 例子和用法

UserDict 对象

UserList 对象

UserString 对象

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

容器抽象基类

多项集抽象基类 -- 详细描述

例子和配方

heapq --- 堆队列算法

基本示例

优先队列实现说明

理论

bisect --- 数组二分查找算法

性能说明

搜索有序列表

例子

array --- 高效的数字数组

weakref --- 弱引用

弱引用对象

示例

终结器对象

比较终结器与 __del__() 方法

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

动态类型创建

标准解释器类型

附加工具类和函数

协程工具函数

copy --- 浅层 (shallow) 和深层 (deep) 复制操作

pprint --- 数据美化输出

PrettyPrinter 对象

示例

reprlib --- 另一种 repr() 实现

Repr 对象

子类化 Repr 对象

enum --- 对枚举的支持

模块内容

创建 Enum

枚举成员及其属性的编程访问

重复的枚举成员和值

确保枚举值唯一

使用自动设定的值

迭代

比较运算

合法的枚举成员和属性

受限的 Enum 子类化

打包（pickle）

函数式 API

派生的枚举

IntEnum

IntFlag

标志位

其他事项

何时使用 __new__() 与 __init__()

有趣的示例

省略值

使用 auto

使用 object

使用描述性字符串

使用自定义的 __new__()

OrderedEnum

DuplicateFreeEnum

Planet

TimePeriod

各种枚举有何区别？

枚举类

枚举成员（即实例）

细节要点

支持的 __dunder__ 名称

支持的 _sunder_ 名称

_Private__names

Enum 成员类型

Enum 类和成员的布尔值

带有方法的 Enum 类

组合 Flag 的成员

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

异常

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

源代码： Lib/datetime.py [https://github.com/python/cpython/tree/3.10/Lib/datetime.py]

datetime 模块提供用于处理日期和时间的类。

在支持日期时间数学运算的同时，实现的关注点更着重于如何能够更有效地解析其属性用于格式化输出和数据操作。

参见

模块 calendar

通用日历相关函数

模块 time

时间的访问和转换

zoneinfo 模块

代表 IANA 时区数据库的具体时区。

dateutil [https://dateutil.readthedocs.io/en/stable/] 包

具有扩展时区和解析支持的第三方库。

感知型对象和简单型对象

日期和时间对象可以根据它们是否包含时区信息而分为“感知型”和“简单型”两类。

充分掌握应用性算法和政治性时间调整信息例如时区和夏令时的情况下，一个 感知型 对象就能相对于其他感知型对象来精确定位自身时间点。 感知型对象是用来表示一个没有解释空间的固定时间点。 1

简单型 对象没有包含足够多的信息来无歧义地相对于其他 date/time 对象来定位自身时间点。 不论一个简单型对象所代表的是世界标准时间（UTC）、当地时间还是某个其他时区的时间完全取决于具体程序，就像一个特定数字所代表的是米、英里还是质量完全取决于具体程序一样。 简单型对象更易于理解和使用，代价则是忽略了某些现实性考量。

对于要求感知型对象的应用，datetime 和 time 对象具有一个可选的时区信息属性 tzinfo，它可被设为抽象类 tzinfo 的子类的一个实例。 这些 tzinfo 对象会捕获与 UTC 时间的差值、时区名称以及夏令时是否生效等信息。

datetime 模块只提供了一个具体的 tzinfo 类，即 timezone 类。 timezone 类可以表示具有相对于 UTC 的固定时差的简单时区，例如 UTC 本身或北美的 EST 和 EDT 时区等。 支持时间的详细程度取决于具体的应用。 世界各地的时间调整规则往往是政治性多于合理性，经常会发生变化，除了 UTC 之外并没有一个能适合所有应用的标准。

常量

The datetime module exports the following constants:

datetime.MINYEAR

date 或者 datetime 对象允许的最小年份。 常量 MINYEAR 是 1 。

datetime.MAXYEAR

date 或 datetime 对象允许最大的年份。常量 MAXYEAR 是 9999 。

有效的类型

class datetime.date

一个理想化的简单型日期，它假设当今的公历在过去和未来永远有效。 属性: year, month, and day。

class datetime.time

一个独立于任何特定日期的理想化时间，它假设每一天都恰好等于 24*60*60 秒。 （这里没有“闰秒”的概念。） 包含属性: hour, minute, second, microsecond 和 tzinfo。

class datetime.datetime

日期和时间的结合。属性：year, month, day, hour, minute, second, microsecond, and tzinfo.

class datetime.timedelta

表示两个 date 对象或 time 对象，或者 datetime 对象之间的时间间隔，精确到微秒。

class datetime.tzinfo

一个描述时区信息对象的抽象基类。 用来给 datetime 和 time 类提供自定义的时间调整概念（例如处理时区和/或夏令时）。

class datetime.timezone

一个实现了 tzinfo 抽象基类的子类，用于表示相对于 世界标准时间（UTC）的偏移量。

3.2 新版功能.

这些类型的对象都是不可变的。

子类关系

object
    timedelta
    tzinfo
        timezone
    time
    date
        datetime

通用的特征属性

date, datetime, time 和 timezone 类型共享这些通用特性:

这些类型的对象都是不可变的。

这些类型的对象是 hashable，意味着它们可以被用作字典的键。

这些类型的对象支持通过 pickle 模块进行高效的封存。

确定一个对象是感知型还是简单型

date 类型的对象都是简单型的。

time 或 datetime 类型的对象可以是感知型或者简单型。

一个 datetime 对象 d 在以下条件同时成立时将是感知型的：

d.tzinfo 不为 None

d.tzinfo.utcoffset(d) 不返回 None

在其他情况下，d 将是简单型的。

一个 time 对象 t 在以下条件同时成立时将是感知型的：

t.tzinfo 不为 None

t.tzinfo.utcoffset(None) 不返回 None。

在其他情况下，t 将是简单型的。

感知型和简单型之间的区别不适用于 timedelta 对象。

timedelta 类对象

timedelta 对象表示两个 date 或者 time 的时间间隔。

class datetime.timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)

所有参数都是可选的并且默认为 0。 这些参数可以是整数或者浮点数，也可以是正数或者负数。

只有 days, seconds 和 microseconds 会存储在内部。 参数单位的换算规则如下：

1毫秒会转换成1000微秒。

1分钟会转换成60秒。

1小时会转换成3600秒。

1星期会转换成7天。

日期、秒、微秒都是标准化的，所以它们的表达方式也是唯一的，例：

0 <= microseconds < 1000000

0 <= seconds < 3600*24 (一天的秒数)

-999999999 <= days <= 999999999

下面的例子演示了如何对 days, seconds 和 microseconds 以外的任意参数执行“合并”操作并标准化为以上三个结果属性:

>>> from datetime import timedelta
>>> delta = 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)

在有任何参数为浮点型并且 microseconds 值为小数的情况下，从所有参数中余下的微秒数将被合并，并使用四舍五入偶不入奇的规则将总计值舍入到最接近的整数微秒值。 如果没有任何参数为浮点型的情况下，则转换和标准化过程将是完全精确的（不会丢失信息）。

如果标准化后的 days 数值超过了指定范围，将会抛出 OverflowError 异常。

请注意对负数值进行标准化的结果可能会令人感到惊讶。 例如:

>>> from datetime import timedelta
>>> d = timedelta(microseconds=-1)
>>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999)

类属性：

timedelta.min

The most negative timedelta object, timedelta(-999999999).

timedelta.max

The most positive timedelta object, timedelta(days=999999999, hours=23, minutes=59, seconds=59, microseconds=999999).

timedelta.resolution

两个不相等的 timedelta 类对象最小的间隔为 timedelta(microseconds=1)。

需要注意的是，因为标准化的缘故，timedelta.max > -timedelta.min，-timedelta.max 不可以表示一个 timedelta 类对象。

实例属性（只读）：

属性 | 值
days | -999999999 至 999999999 ，含999999999
seconds | 0 至 86399，包含86399
microseconds | 0 至 999999，包含999999

支持的运算：

运算 | 结果：
t1 = t2 + t3 | t2 和 t3 的和。 运算后 t1-t2 == t3 and t1-t3 == t2 必为真值。(1)
t1 = t2 - t3 | t2 减 t3 的差。 运算后 t1 == t2 - t3 and t2 == t1 + t3 必为真值。 (1)(6)
t1 = t2 * i or t1 = i * t2 | 乘以一个整数。运算后假如 i != 0 则 t1 // i == t2 必为真值。
| In general, t1 * i == t1 * (i-1) + t1 is true. (1)
t1 = t2 * f or t1 = f * t2 | 乘以一个浮点数，结果会被舍入到 timedelta 最接近的整数倍。 精度使用四舍五偶入奇不入规则。
f = t2 / t3 | 总时间 t2 除以间隔单位 t3 (3)。 返回一个 float 对象。
t1 = t2 / f or t1 = t2 / i | 除以一个浮点数或整数。 结果会被舍入到 timedelta 最接近的整数倍。 精度使用四舍五偶入奇不入规则。
t1 = t2 // i or t1 = t2 // t3 | 计算底数，其余部分（如果有）将被丢弃。在第二种情况下，将返回整数。 （3）
t1 = t2 % t3 | 余数为一个 timedelta 对象。(3)
q, r = divmod(t1, t2) | 通过 : q = t1 // t2 (3) and r = t1 % t2 计算出商和余数。q是一个整数，r是一个 timedelta 对象。
+t1 | 返回一个相同数值的 timedelta 对象。
-t1 | 等价于 timedelta(-t1.days, -t1.seconds, -t1.microseconds), 和 t1* -1. (1)(4)
abs(t) | 当 t.days >= 0 时等于 +t, 当 t.days < 0 时 -t 。 (2)
str(t) | 返回一个形如 [D day[s], ][H]H:MM:SS[.UUUUUU] 的字符串，当 t 为负数的时候， D 也为负数。 (5)
repr(t) | 返回一个 timedelta 对象的字符串表示形式，作为附带正规属性值的构造器调用。

注释：

结果正确，但可能会溢出。

结果正确，不会溢出。

除以0将会抛出异常 ZeroDivisionError 。

-timedelta.max 不是一个 timedelta 类对象。

timedelta 对象的字符串表示形式类似于其内部表示形式被规范化。对于负时间增量，这会导致一些不寻常的结果。例如:

>>> timedelta(hours=-5)
datetime.timedelta(days=-1, seconds=68400)
>>> print(_)
-1 day, 19:00:00

表达式 t2 - t3 通常与 t2 + (-t3) 是等价的，除非 t3 等于 timedelta.max; 在这种情况下前者会返回结果，而后者则会溢出。

除了上面列举的操作以外，timedelta 对象还支持与 date 和 datetime 对象进行特定的相加和相减运算（见下文）。

在 3.2 版更改: 现在已支持 timedelta 对象与另一个 timedelta 对象相整除或相除，包括求余运算和 divmod() 函数。 现在也支持 timedelta 对象加上或乘以一个 float 对象。

支持 timedelta 对象之间进行比较，但其中有一些注意事项。

== 或 != 比较 总是 返回一个 bool 对象，无论被比较的对象是什么类型:

>>> from datetime import timedelta
>>> delta1 = timedelta(seconds=57)
>>> delta2 = timedelta(hours=25, seconds=2)
>>> delta2 != delta1
True
>>> delta2 == 5
False

对于所有其他比较 (例如 < 和 >)，当一个 timedelta 对象与其他类型的对象比较时，将引发 TypeError:

>>> delta2 > delta1
True
>>> delta2 > 5
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '>' not supported between instances of 'datetime.timedelta' and 'int'

在布尔运算中，timedelta 对象当且仅当其不等于 timedelta(0) 时则会被视为真值。

实例方法：

timedelta.total_seconds()

返回期间占用了多少秒。等价于 td / timedelta(seconds=1)。对于秒以外的间隔单位，直接使用除法形式 (例如 td / timedelta(microseconds=1))。

需要注意的是，时间间隔较大时，这个方法的结果中的微秒将会失真（大多数平台上大于270年视为一个较大的时间间隔）。

3.2 新版功能.

timedelta 用法示例

一个标准化的附加示例:

>>> # Components of another_year add up to exactly 365 days
>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> another_year = timedelta(weeks=40, days=84, hours=23,
...                          minutes=50, seconds=600)
>>> year == another_year
True
>>> year.total_seconds()
31536000.0

timedelta 算术运算的示例:

>>> from datetime import timedelta
>>> year = 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)

date 对象

date 对象代表一个理想化历法中的日期（年、月和日），即当今的格列高利历向前后两个方向无限延伸。

公元 1 年 1 月 1日是第 1 日，公元 1 年 1 月 2 日是第 2 日，依此类推。 2

class datetime.date(year, month, day)

所有参数都是必要的。 参数必须是在下面范围内的整数：

MINYEAR <= year <= MAXYEAR

1 <= month <= 12

1 <= 日期 <= 给定年月对应的天数

如果参数不在这些范围内，则抛出 ValueError 异常。

其它构造器，所有的类方法：

classmethod date.today()

返回当前的本地日期。

这等价于 date.fromtimestamp(time.time())。

classmethod date.fromtimestamp(timestamp)

返回对应于 POSIX 时间戳的当地时间，例如 time.time() 返回的就是时间戳。

这可能引发 OverflowError，如果时间戳数值超出所在平台 C localtime() 函数的支持范围的话，并且会在 localtime() 出错时引发 OSError。 通常该数值会被限制在 1970 年至 2038 年之间。 请注意在时间戳概念包含闰秒的非 POSIX 系统上，闰秒会被 fromtimestamp() 所忽略。

在 3.3 版更改: 引发 OverflowError 而不是 ValueError，如果时间戳数值超出所在平台 C localtime() 函数的支持范围的话，并会在 localtime() 出错时引发 OSError 而不是 ValueError。

classmethod date.fromordinal(ordinal)

返回对应于预期格列高利历序号的日期，其中公元 1 年 1 月 1 日的序号为 1。

除非 1 <= ordinal <= date.max.toordinal() 否则会引发 ValueError。对于任意日期 d，date.fromordinal(d.toordinal()) == d。

classmethod date.fromisoformat(date_string)

返回一个对应于以 YYYY-MM-DD 格式给出的 date_string 的 date 对象:

>>> from datetime import date
>>> date.fromisoformat('2019-12-04')
datetime.date(2019, 12, 4)

这是 date.isoformat() 的逆操作。 它只支持 YYYY-MM-DD 格式。

3.7 新版功能.

classmethod date.fromisocalendar(year, week, day)

返回指定 year, week 和 day 所对应 ISO 历法日期的 date。 这是函数 date.isocalendar() 的逆操作。

3.8 新版功能.

类属性：

date.min

最小的日期 date(MINYEAR, 1, 1) 。

date.max

最大的日期 ，date(MAXYEAR, 12, 31)。

date.resolution

两个日期对象的最小间隔，timedelta(days=1)。

实例属性（只读）：

date.year

在 MINYEAR 和 MAXYEAR 之间，包含边界。

date.month

1 至 12（含）

date.day

返回1到指定年月的天数间的数字。

支持的运算：

运算 | 结果：
date2 = date1 + timedelta | date2 将为 date1 之后的 timedelta.days 日。 (1)
date2 = date1 - timedelta | 计算 date2 的值使得 date2 + timedelta == date1。 (2)
timedelta = date1 - date2 | (3)
date1 < date2 | 如果 date1 的时间在 date2 之前则认为 date1 小于 date2 。 (4)

注释：

如果 timedelta.days > 0 则 date2 将在时间线上前进，如果 timedelta.days < 0 则将后退。 操作完成后 date2 - date1 == timedelta.days。 timedelta.seconds 和 timedelta.microseconds 会被忽略。 如果 date2.year 将小于 MINYEAR 或大于 MAXYEAR 则会引发 OverflowError。

timedelta.seconds 和 timedelta.microseconds 会被忽略。

此值完全精确且不会溢出。 操作完成后 timedelta.seconds 和 timedelta.microseconds 均为 0，并且 date2 + timedelta == date1。

换句话说，当且仅当 date1.toordinal() < date2.toordinal() 时 date1 < date2。 日期比较会引发 TypeError，如果比较目标不为 date 对象的话。 不过也可能会返回 NotImplemented，如果比较目标具有 timetuple() 属性的话。 这个钩子给予其他日期对象类型实现混合类型比较的机会。 否则，当 date 对象与不同类型的对象比较时将会引发 TypeError，除非是 == 或 != 比较。 后两种情况将分别返回 False 或 True。

在布尔运算中，所有 date 对象都会被视为真值。

实例方法：

date.replace(year=self.year, month=self.month, day=self.day)

返回一个具有同样值的日期，除非通过任何关键字参数给出了某些形参的新值。

示例:

>>> from datetime import date
>>> d = date(2002, 12, 31)
>>> d.replace(day=26)
datetime.date(2002, 12, 26)

date.timetuple()

返回一个 time.struct_time，即 time.localtime() 所返回的类型。

hours, minutes 和 seconds 值均为 0，且 DST 旗标值为 -1。

d.timetuple() 等价于:

time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1))

其中 yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1 是当前年份中的日期序号，1 月 1 日的序号为 1。

date.toordinal()

返回日期的预期格列高利历序号，其中公元 1 年 1 月 1 日的序号为 1。 对于任意 date 对象 d，date.fromordinal(d.toordinal()) == d。

date.weekday()

返回一个整数代表星期几，星期一为0，星期天为6。例如， date(2002, 12, 4).weekday() == 2，表示的是星期三。参阅 isoweekday()。

date.isoweekday()

返回一个整数代表星期几，星期一为1，星期天为7。例如：date(2002, 12, 4).isoweekday() == 3,表示星期三。参见 weekday(), isocalendar()。

date.isocalendar()

返回一个由三部分组成的 named tuple 对象: year, week 和 weekday。

ISO 历法是一种被广泛使用的格列高利历。 3

ISO 年由 52 或 53 个完整星期构成，每个星期开始于星期一结束于星期日。 一个 ISO 年的第一个星期就是（格列高利）历法的一年中第一个包含星期四的星期。 这被称为 1 号星期，这个星期四所在的 ISO 年与其所在的格列高利年相同。

例如，2004 年的第一天是星期四，因此 ISO 2004 年的第一个星期开始于 2003 年 12 月 29 日星期一，结束于 2004 年 1 月 4 日星期日:

>>> from datetime import date
>>> date(2003, 12, 29).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=1)
>>> date(2004, 1, 4).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=7)

在 3.9 版更改: 结果由元组改为 named tuple。

date.isoformat()

返回一个以 ISO 8601 格式 YYYY-MM-DD 来表示日期的字符串:

>>> from datetime import date
>>> date(2002, 12, 4).isoformat()
'2002-12-04'

这是 date.fromisoformat() 的逆操作。

date.__str__()

对于日期对象 d, str(d) 等价于 d.isoformat() 。

date.ctime()

返回一个表示日期的字符串:

>>> from datetime import date
>>> date(2002, 12, 4).ctime()
'Wed Dec  4 00:00:00 2002'

d.ctime() 等效于:

time.ctime(time.mktime(d.timetuple()))

在原生 C ctime() 函数遵循 C 标准的平台上 (time.ctime() 会发起对该函数的调用，但 date.ctime() 并不会) 。

date.strftime(format)

返回一个由显式格式字符串所指明的代表日期的字符串。 表示时、分或秒的格式代码值将为 0。 要获取格式指令的完整列表请参阅 strftime() 和 strptime() 的行为。

date.__format__(format)

与 date.strftime() 相同。 此方法使得为 date 对象指定以 格式化字符串字面值 表示的格式化字符串以及使用 str.format() 进行格式化成为可能。 要获取格式指令的完整列表，请参阅 strftime() 和 strptime() 的行为。

date 用法示例

计算距离特定事件天数的例子:

>>> import time
>>> from datetime import date
>>> today = date.today()
>>> today
datetime.date(2007, 12, 5)
>>> today == date.fromtimestamp(time.time())
True
>>> my_birthday = 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

使用 date 的更多例子：

>>> from datetime import date
>>> d = 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 to 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)

datetime 对象

datetime 对象是包含来自 date 对象和 time 对象的所有信息的单一对象。

与 date 对象一样，datetime 假定当前的格列高利历向前后两个方向无限延伸；与 time 对象一样，datetime 假定每一天恰好有 3600*24 秒。

构造器 ：

class datetime.datetime(year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

year, month 和 day 参数是必须的。 tzinfo 可以是 None 或者是一个 tzinfo 子类的实例。 其余的参数必须是在下面范围内的整数：

MINYEAR <= year <= MAXYEAR,

1 <= month <= 12,

1 <= day <= 指定年月的天数,

0 <= hour < 24,

0 <= minute < 60,

0 <= second < 60,

0 <= microsecond < 1000000,

fold in [0, 1].

如果参数不在这些范围内，则抛出 ValueError 异常。

3.6 新版功能: 增加了 fold 参数。

其它构造器，所有的类方法：

classmethod datetime.today()

返回表示当前地方时的 datetime 对象，其中 tzinfo 为 None。

等价于:

datetime.fromtimestamp(time.time())

另请参阅 now(), fromtimestamp()。

此方法的功能等价于 now()，但是不带 tz 形参。

classmethod datetime.now(tz=None)

返回表示当前地方时的 date 和 time 对象。

如果可选参数 tz 为 None 或未指定，这就类似于 today()，但该方法会在可能的情况下提供比通过 time.time() 时间戳所获时间值更高的精度（例如，在提供了 C gettimeofday() 函数的平台上就可以做到这一点）。

如果 tz 不为 None，它必须是 tzinfo 子类的一个实例，并且当前日期和时间将被转换到 tz 时区。

此函数可以替代 today() 和 utcnow()。

classmethod datetime.utcnow()

返回表示当前 UTC 时间的 date 和 time，其中 tzinfo 为 None。

这类似于 now()，但返回的是当前 UTC 日期和时间，类型为简单型 datetime 对象。 感知型的当前 UTC 日期时间可通过调用 datetime.now(timezone.utc) 来获得。 另请参阅 now()。

警告

由于简单型 datetime 对象会被许多 datetime 方法当作本地时间来处理，最好是使用感知型日期时间对象来表示 UTC 时间。 因此，创建表示当前 UTC 时间的对象的推荐方式是通过调用 datetime.now(timezone.utc)。

classmethod datetime.fromtimestamp(timestamp, tz=None)

返回 POSIX 时间戳对应的本地日期和时间，如 time.time() 返回的。 如果可选参数 tz 指定为 None 或未指定，时间戳将转换为平台的本地日期和时间，并且返回的 datetime 对象将为简单型。

如果 tz 不为 None，它必须是 tzinfo 子类的一个实例，并且时间戳将被转换到 tz 指定的时区。

fromtimestamp() 可能会引发 OverflowError，如果时间戳数值超出所在平台 C localtime() 或 gmtime() 函数的支持范围的话，并会在 localtime() 或 gmtime() 报错时引发 OSError。 通常该数值会被限制在 1970 年至 2038 年之间。 请注意在时间戳概念包含闰秒的非 POSIX 系统上，闰秒会被 fromtimestamp() 所忽略，结果可能导致两个相差一秒的时间戳产生相同的 datetime 对象。 相比 utcfromtimestamp() 更推荐使用此方法。

在 3.3 版更改: 引发 OverflowError 而不是 ValueError，如果时间戳数值超出所在平台 C localtime() 或 gmtime() 函数的支持范围的话。 并会在 localtime() 或 gmtime() 出错时引发 OSError 而不是 ValueError。

在 3.6 版更改: fromtimestamp() 可能返回 fold 值设为 1 的实例。

classmethod datetime.utcfromtimestamp(timestamp)

返回对应于 POSIX 时间戳的 UTC datetime，其中 tzinfo 值为 None。 （结果为简单型对象。）

这可能引发 OverflowError，如果时间戳数值超出所在平台 C gmtime() 函数的支持范围的话，并会在 gmtime() 报错时引发 OSError。 通常该数值会被限制在 1970 至 2038 年之间。

要得到一个感知型 datetime 对象，应调用 fromtimestamp():

datetime.fromtimestamp(timestamp, timezone.utc)

在 POSIX 兼容的平台上，它等价于以下表达式:

datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)

不同之处在于后一种形式总是支持完整年份范围：从 MINYEAR 到 MAXYEAR 的开区间。

警告

由于简单型 datetime 对象会被许多 datetime 方法当作本地时间来处理，最好是使用感知型日期时间对象来表示 UTC 时间。 因此，创建表示特定 UTC 时间戳的日期时间对象的推荐方式是通过调用 datetime.fromtimestamp(timestamp, tz=timezone.utc)。

在 3.3 版更改: 引发 OverflowError 而不是 ValueError，如果时间戳数值超出所在平台 C gmtime() 函数的支持范围的话。 并会在 gmtime() 出错时引发 OSError 而不是 ValueError。

classmethod datetime.fromordinal(ordinal)

返回对应于预期格列高利历序号的 datetime，其中公元 1 年 1 月 1 日的序号为 1。 除非 1 <= ordinal <= datetime.max.toordinal() 否则会引发 ValueError。 结果的 hour, minute, second 和 microsecond 值均为 0，并且 tzinfo 值为 None。

classmethod datetime.combine(date, time, tzinfo=self.tzinfo)

返回一个新的 datetime 对象，对象的日期部分等于给定的 date 对象的值，而其时间部分等于给定的 time 对象的值。 如果提供了 tzinfo 参数，其值会被用来设置结果的 tzinfo 属性，否则将使用 time 参数的 tzinfo 属性。

对于任意 datetime 对象 d，d == datetime.combine(d.date(), d.time(), d.tzinfo)。 如果 date 是一个 datetime 对象，它的时间部分和 tzinfo 属性会被忽略。

在 3.6 版更改: 增加了 tzinfo 参数。

classmethod datetime.fromisoformat(date_string)

返回一个对应于 date.isoformat() 和 datetime.isoformat() 所提供的某一种 date_string 的 datetime 对象。

特别地，此函数支持以下格式的字符串：

YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]]

其中 * 可以匹配任意的单个字符。

警告

此函数 并不 支持解析任意 ISO 8601 字符串 —— 它的目的只是作为 datetime.isoformat() 的逆操作。 在第三方包 dateutil [https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.isoparse] 中提供了一个更完善的 ISO 8601 解析器 dateutil.parser.isoparse。

示例:

>>> from datetime import datetime
>>> datetime.fromisoformat('2011-11-04')
datetime.datetime(2011, 11, 4, 0, 0)
>>> datetime.fromisoformat('2011-11-04T00:05:23')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> datetime.fromisoformat('2011-11-04 00:05:23.283')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000)
>>> datetime.fromisoformat('2011-11-04 00:05:23.283+00:00')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000, tzinfo=datetime.timezone.utc)
>>> datetime.fromisoformat('2011-11-04T00:05:23+04:00')
datetime.datetime(2011, 11, 4, 0, 5, 23,
    tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))

3.7 新版功能.

classmethod datetime.fromisocalendar(year, week, day)

返回以 year, week 和 day 值指明的 ISO 历法日期所对应的 datetime。 该datetime 对象的非日期部分将使用其标准默认值来填充。 这是函数 datetime.isocalendar() 的逆操作。

3.8 新版功能.

classmethod datetime.strptime(date_string, format)

返回一个对应于 date_string，根据 format 进行解析得到的 datetime 对象。

这相当于：

datetime(*(time.strptime(date_string, format)[0:6]))

如果 date_string 和 format 无法被 time.strptime() 解析或它返回一个不是时间元组的值，则将引发 ValueError。 要获取格式化指令的完整列表，请参阅 strftime() 和 strptime() 的行为。

类属性：

datetime.min

最早的可表示 datetime，datetime(MINYEAR, 1, 1, tzinfo=None)。

datetime.max

最晚的可表示 datetime，datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, tzinfo=None)。

datetime.resolution

两个不相等的 datetime 对象之间可能的最小间隔，timedelta(microseconds=1)。

实例属性（只读）：

datetime.year

在 MINYEAR 和 MAXYEAR 之间，包含边界。

datetime.month

1 至 12（含）

datetime.day

返回1到指定年月的天数间的数字。

datetime.hour

取值范围是 range(24)。

datetime.minute

取值范围是 range(60)。

datetime.second

取值范围是 range(60)。

datetime.microsecond

取值范围是 range(1000000)。

datetime.tzinfo

作为 tzinfo 参数被传给 datetime 构造器的对象，如果没有传入值则为 None。

datetime.fold

取值范围是 [0, 1]。 用于在重复的时间段中消除边界时间歧义。 （当夏令时结束时回拨时钟或由于政治原因导致当明时区的 UTC 时差减少就会出现重复的时间段。） 取值 0 (1) 表示两个时刻早于（晚于）所代表的同一边界时间。

3.6 新版功能.

支持的运算：

运算 | 结果：
datetime2 = datetime1 + timedelta | (1)
datetime2 = datetime1 - timedelta | (2)
timedelta = datetime1 - datetime2 | (3)
datetime1 < datetime2 | 比较 datetime 与 datetime。 (4)

datetime2 是从 datetime1 去掉了一段 timedelta 的结果，如果 timedelta.days > 0 则是在时间线上前进，如果 timedelta.days < 0 则是在时间线上后退。 该结果具有与输入的 datetime 相同的 tzinfo 属性，并且操作完成后 datetime2 - datetime1 == timedelta。 如果 datetime2.year 将要小于 MINYEAR 或大于 MAXYEAR 则会引发 OverflowError。 请注意即使输入的是一个感知型对象，该方法也不会进行时区调整。

计算 datetime2 使得 datetime2 + timedelta == datetime1。 与相加操作一样，结果具有与输入的 datetime 相同的 tzinfo 属性，即使输入的是一个感知型对象，该方法也不会进行时区调整。

从一个 datetime 减去一个 datetime 仅对两个操作数均为简单型或均为感知型时有定义。 如果一个是感知型而另一个是简单型，则会引发 TypeError。

如果两个操作数都是简单型，或都是感知型并且具有相同的 tzinfo 属性，则 tzinfo 属性会被忽略，并且结果会是一个使得 datetime2 + t == datetime1 的 timedelta 对象 t。 在此情况下不会进行时区调整。

如果两个操作数都是感知型且具有不同的 tzinfo 属性，a-b 操作的效果就如同 a 和 b 首先被转换为简单型 UTC 日期时间。 结果将是 (a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) - b.utcoffset())，除非具体实现绝对不溢出。

当 datetime1 的时间在 datetime2 之前则认为 datetime1 小于 datetime2。

如果比较的一方是简单型而另一方是感知型，则如果尝试进行顺序比较将引发 TypeError。 对于相等比较，简单型实例将永远不等于感知型实例。

如果两个比较方都是感知型，且具有相同的 tzinfo 属性，则相同的 tzinfo 属性会被忽略并对基本日期时间值进行比较。 如果两个比较方都是感知型且具有不同的 tzinfo 属性，则两个比较方将首先通过减去它们的 UTC 差值（使用 self.utcoffset() 获取）来进行调整。

在 3.3 版更改: 感知型和简单型 datetime 实例之间的相等比较不会引发 TypeError。

注解

为了防止比较操作回退为默认的对象地址比较方式，datetime 比较通常会引发 TypeError，如果比较目标不同样为 datetime 对象的话。 不过也可能会返回 NotImplemented，如果比较目标具有 timetuple() 属性的话。 这个钩子给予其他种类的日期对象实现混合类型比较的机会。 如果未实现，则当 datetime 对象与不同类型比较时将会引发 TypeError，除非是 == 或 != 比较。 后两种情况将分别返回 False 或 True。

实例方法：

datetime.date()

返回具有同样 year, month 和 day 值的 date 对象。

datetime.time()

返回具有同样 hour, minute, second, microsecond 和 fold 值的 time 对象。 tzinfo 值为 None。 另请参见 timetz() 方法。

在 3.6 版更改: fold 值会被复制给返回的 time 对象。

datetime.timetz()

返回具有同样 hour, minute, second, microsecond, fold 和 tzinfo 属性性的 time 对象。 另请参见 time() 方法。

在 3.6 版更改: fold 值会被复制给返回的 time 对象。

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)

返回一个具有同样属性值的 datetime，除非通过任何关键字参数为某些属性指定了新值。 请注意可以通过指定 tzinfo=None 来从一个感知型 datetime 创建一个简单型 datetime 而不必转换日期和时间数据。

3.6 新版功能: 增加了 fold 参数。

datetime.astimezone(tz=None)

返回一个具有新的 tzinfo 属性 tz 的 datetime 对象，并会调整日期和时间数据使得结果对应的 UTC 时间与 self 相同，但为 tz 时区的本地时间。

如果给出了 tz，则它必须是一个 tzinfo 子类的实例，并且其 utcoffset() 和 dst() 方法不可返回 None。 如果 self 为简单型，它会被假定为基于系统时区表示的时间。

如果调用时不传入参数 (或传入 tz=None) 则将假定目标时区为系统的本地时区。 转换后 datetime 实例的 .tzinfo 属性将被设为一个 timezone 实例，时区名称和时差值将从 OS 获取。

如果 self.tzinfo 为 tz，self.astimezone(tz) 等于 self: 不会对日期或时间数据进行调整。 否则结果为 tz 时区的本地时间，代表的 UTC 时间与 self 相同：在 astz = dt.astimezone(tz) 之后，astz - astz.utcoffset() 将具有与 dt - dt.utcoffset() 相同的日期和时间数据。

如果你只是想要附加一个时区对象 tz 到一个 datetime 对象 dt 而不调整日期和时间数据，请使用 dt.replace(tzinfo=tz)。 如果你只想从一个感知型 datetime 对象 dt 移除时区对象，请使用 dt.replace(tzinfo=None)。

请注意默认的 tzinfo.fromutc() 方法在 tzinfo 的子类中可以被重写，从而影响 astimezone() 的返回结果。 如果忽略出错的情况，astimezone() 的行为就类似于:

def astimezone(self, tz):
    if self.tzinfo is tz:
        return self
    # Convert self to UTC, and attach the new time zone object.
    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    # Convert from UTC to tz's local time.
    return tz.fromutc(utc)

在 3.3 版更改: tz 现在可以被省略。

在 3.6 版更改: astimezone() 方法可以由简单型实例调用，这将假定其表示本地时间。

datetime.utcoffset()

如果 tzinfo 为 None，则返回 None，否则返回 self.tzinfo.utcoffset(self)，并且在后者不返回 None 或者一个幅度小于一天的 timedelta 对象时将引发异常。

在 3.7 版更改: UTC 时差不再限制为一个整数分钟值。

datetime.dst()

如果 tzinfo 为 None，则返回 None，否则返回 self.tzinfo.dst(self)，并且在后者不返回 None 或者一个幅度小于一天的 timedelta 对象时将引发异常。

在 3.7 版更改: DST 差值不再限制为一个整数分钟值。

datetime.tzname()

如果 tzinfo 为 None，则返回 None，否则返回 self.tzinfo.tzname(self)，如果后者不返回 None 或者一个字符串对象则将引发异常。

datetime.timetuple()

返回一个 time.struct_time，即 time.localtime() 所返回的类型。

d.timetuple() 等价于:

time.struct_time((d.year, d.month, d.day,
                  d.hour, d.minute, d.second,
                  d.weekday(), yday, dst))

其中 yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1 是日期在当前年份中的序号，起始序号 1 表示 1 月 1 日。 结果的 tm_isdst 旗标的设定会依据 dst() 方法：如果 tzinfo 为 None 或 dst() 返回 None，则 tm_isdst 将设为 -1；否则如果 dst() 返回一个非零值，则 tm_isdst 将设为 1；在其他情况下 tm_isdst 将设为 0。

datetime.utctimetuple()

如果 datetime 实例 d 为简单型，这类似于 d.timetuple()，不同之处在于 tm_isdst 会强制设为 0，无论 d.dst() 返回什么结果。 DST 对于 UTC 时间永远无效。

如果 d 为感知型， d 会通过减去 d.utcoffset() 来标准化为 UTC 时间，并返回该标准化时间所对应的 time.struct_time。 tm_isdst 会强制设为 0。 请注意如果 d.year 为 MINYEAR 或 MAXYEAR 并且 UTC 调整超出一年的边界则可能引发 OverflowError。

警告

由于简单型 datetime 对象会被许多 datetime 方法当作本地时间来处理，最好是使用感知型日期时间来表示 UTC 时间；因此，使用 datetime.utctimetuple() 可能会给出误导性的结果。 如果你有一个表示 UTC 的简单型 datetime，请使用 datetime.replace(tzinfo=timezone.utc) 将其改为感知型，这样你才能使用 datetime.timetuple()。

datetime.toordinal()

返回日期的预期格列高利历序号。 与 self.date().toordinal() 相同。

datetime.timestamp()

返回对应于 datetime 实例的 POSIX 时间戳。 此返回值是与 time.time() 返回值类似的 float 对象。

简单型 datetime 实例会假定为代表本地时间，并且此方法依赖于平台的 C mktime() 函数来执行转换。 由于在许多平台上 datetime 支持的范围比 mktime() 更广，对于极其遥远的过去或未来此方法可能引发 OverflowError。

对于感知型 datetime 实例，返回值的计算方式为:

(dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()

3.3 新版功能.

在 3.6 版更改: timestamp() 方法使用 fold 属性来消除重复间隔中的时间歧义。

注解

没有一个方法能直接从表示 UTC 时间的简单型 datetime 实例获取 POSIX 时间戳。 如果你的应用程序使用此惯例并且你的系统时区不是设为 UTC，你可以通过提供 tzinfo=timezone.utc 来获取 POSIX 时间戳:

timestamp = dt.replace(tzinfo=timezone.utc).timestamp()

或者通过直接计算时间戳:

timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)

datetime.weekday()

返回一个整数代表星期几，星期一为 0，星期天为 6。 相当于 self.date().weekday()。 另请参阅 isoweekday()。

datetime.isoweekday()

返回一个整数代表星期几，星期一为 1，星期天为 7。 相当于 self.date().isoweekday()。 另请参阅 weekday(), isocalendar()。

datetime.isocalendar()

返回一个由三部分组成的 named tuple: year, week 和 weekday。 等同于 self.date().isocalendar()。

datetime.isoformat(sep='T', timespec='auto')

返回一个以 ISO 8601 格式表示的日期和时间字符串：

YYYY-MM-DDTHH:MM:SS.ffffff，如果 microsecond 不为 0

YYYY-MM-DDTHH:MM:SS，如果 microsecond 为 0

如果 utcoffset() 返回值不为 None，则添加一个字符串来给出 UTC 时差：

YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]，如果 microsecond 不为 0

YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]，如果 microsecond 为 0

示例:

>>> from datetime import datetime, timezone
>>> datetime(2019, 5, 18, 15, 17, 8, 132263).isoformat()
'2019-05-18T15:17:08.132263'
>>> datetime(2019, 5, 18, 15, 17, tzinfo=timezone.utc).isoformat()
'2019-05-18T15:17:00+00:00'

可选参数 sep (默认为 'T') 为单个分隔字符，会被放在结果的日期和时间两部分之间。 例如:

>>> from datetime import tzinfo, timedelta, datetime
>>> class TZ(tzinfo):
...     """A time zone with an arbitrary, constant -06:39 offset."""
...     def utcoffset(self, dt):
...         return timedelta(hours=-6, minutes=-39)
...
>>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
'2002-12-25 00:00:00-06:39'
>>> datetime(2009, 11, 27, microsecond=100, tzinfo=TZ()).isoformat()
'2009-11-27T00:00:00.000100-06:39'

可选参数 timespec 要包含的额外时间组件值 (默认为 'auto')。它可以是以下值之一：

'auto': 如果 microsecond 为 0 则与 'seconds' 相同，否则与 'microseconds' 相同。

'hours': 以两个数码的 HH 格式 包含 hour。

'minutes': 以 HH:MM 格式包含 hour 和 minute。

'seconds': 以 HH:MM:SS 格式包含 hour, minute 和 second。

'milliseconds': 包含完整时间，但将秒值的小数部分截断至毫秒。 格式为 HH:MM:SS.sss。

'microseconds': 以 HH:MM:SS.ffffff 格式包含完整时间。

注解

排除掉的时间部分将被截断，而不是被舍入。

对于无效的 timespec 参数将引发 ValueError:

>>> from datetime import datetime
>>> datetime.now().isoformat(timespec='minutes')
'2002-12-25T00:00'
>>> dt = datetime(2015, 1, 1, 12, 30, 59, 0)
>>> dt.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'

3.6 新版功能: 增加了 timespec 参数。

datetime.__str__()

对于 datetime 实例 d，str(d) 等价于 d.isoformat(' ')。

datetime.ctime()

返回一个表示日期和时间的字符串:

>>> from datetime import datetime
>>> datetime(2002, 12, 4, 20, 30, 40).ctime()
'Wed Dec  4 20:30:40 2002'

输出字符串将 并不 包括时区信息，无论输入的是感知型还是简单型。

d.ctime() 等效于:

time.ctime(time.mktime(d.timetuple()))

在原生 C ctime() 函数遵循 C 标准的平台上 (time.ctime() 会发起对该函数的调用，但 datetime.ctime() 并不会) 。

datetime.strftime(format)

返回一个由显式格式字符串所指明的代表日期和时间的字符串，要获取格式指令的完整列表，请参阅 strftime() 和 strptime() 的行为。

datetime.__format__(format)

与 datetime.strftime() 相同。 此方法使得为 datetime 对象指定以 格式化字符串字面值 表示的格式化字符串以及使用 str.format() 进行格式化成为可能。 要获取格式指令的完整列表，请参阅 strftime() 和 strptime() 的行为。

用法示例: datetime

使用 datetime 对象的例子：

>>> from datetime import datetime, date, time, timezone

>>> # Using datetime.combine()
>>> d = date(2005, 7, 14)
>>> t = time(12, 30)
>>> datetime.combine(d, t)
datetime.datetime(2005, 7, 14, 12, 30)

>>> # Using datetime.now()
>>> datetime.now()
datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
>>> datetime.now(timezone.utc)
datetime.datetime(2007, 12, 6, 15, 29, 43, 79060, tzinfo=datetime.timezone.utc)

>>> # Using datetime.strptime()
>>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
>>> dt
datetime.datetime(2006, 11, 21, 16, 30)

>>> # Using datetime.timetuple() to get tuple of all attributes
>>> tt = dt.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 = dt.isocalendar()
>>> for it in ic:
...     print(it)
...
2006    # ISO year
47      # ISO week
2       # ISO weekday

>>> # Formatting a datetime
>>> dt.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(dt, "day", "month", "time")
'The day is 21, the month is November, the time is 04:30PM.'

以下示例定义了一个 tzinfo 子类，它捕获 Kabul, Afghanistan 时区的信息，该时区使用 +4 UTC 直到 1945 年，之后则使用 +4:30 UTC:

from datetime import timedelta, datetime, tzinfo, timezone

class KabulTz(tzinfo):
    # Kabul used +4 until 1945, when they moved to +4:30
    UTC_MOVE_DATE = datetime(1944, 12, 31, 20, tzinfo=timezone.utc)

    def utcoffset(self, dt):
        if dt.year < 1945:
            return timedelta(hours=4)
        elif (1945, 1, 1, 0, 0) <= dt.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 dt falls in the imaginary range, use fold to decide how
            # to resolve. See PEP495.
            return timedelta(hours=4, minutes=(30 if dt.fold else 0))
        else:
            return timedelta(hours=4, minutes=30)

    def fromutc(self, dt):
        # Follow same validations as in datetime.tzinfo
        if not isinstance(dt, datetime):
            raise TypeError("fromutc() requires a datetime argument")
        if dt.tzinfo is not self:
            raise ValueError("dt.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 dt.replace(tzinfo=timezone.utc) >= self.UTC_MOVE_DATE:
            return dt + timedelta(hours=4, minutes=30)
        else:
            return dt + timedelta(hours=4)

    def dst(self, dt):
        # Kabul does not observe daylight saving time.
        return timedelta(0)

    def tzname(self, dt):
        if dt >= self.UTC_MOVE_DATE:
            return "+04:30"
        return "+04"

上述 KabulTz 的用法:

>>> tz1 = KabulTz()

>>> # Datetime before the change
>>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
>>> print(dt1.utcoffset())
4:00:00

>>> # Datetime after the change
>>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
>>> print(dt2.utcoffset())
4:30:00

>>> # Convert datetime to another time zone
>>> dt3 = dt2.astimezone(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

time 对象

一个 time 对象代表某日的（本地）时间，它独立于任何特定日期，并可通过 tzinfo 对象来调整。

class datetime.time(hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

所有参数都是可选的。 tzinfo 可以是 None，或者是一个 tzinfo 子类的实例。 其余的参数必须是在下面范围内的整数：

0 <= hour < 24,

0 <= minute < 60,

0 <= second < 60,

0 <= microsecond < 1000000,

fold in [0, 1].

如果给出一个此范围以外的参数，则会引发 ValueError。 所有参数值默认为 0，只有 tzinfo 默认为 None。

类属性：

time.min

早最的可表示 time, time(0, 0, 0, 0)。

time.max

最晚的可表示 time, time(23, 59, 59, 999999)。

time.resolution

两个不相等的 time 对象之间可能的最小间隔，timedelta(microseconds=1)，但是请注意 time 对象并不支持算术运算。

实例属性（只读）：

time.hour

取值范围是 range(24)。

time.minute

取值范围是 range(60)。

time.second

取值范围是 range(60)。

time.microsecond

取值范围是 range(1000000)。

time.tzinfo

作为 tzinfo 参数被传给 time 构造器的对象，如果没有传入值则为 None。

time.fold

取值范围是 [0, 1]。 用于在重复的时间段中消除边界时间歧义。 （当夏令时结束时回拨时钟或由于政治原因导致当明时区的 UTC 时差减少就会出现重复的时间段。） 取值 0 (1) 表示两个时刻早于（晚于）所代表的同一边界时间。

3.6 新版功能.

time 对象支持 time 与 time 的比较，当 a 时间在 b 之前时，则认为 a 小于 b。 如果比较的一方是简单型而另一方是感知型，则如果尝试进行顺序比较将引发 TypeError。 对于相等比较，简单型实例将永远不等于感知型实例。

如果两个比较方都是感知型，且具有相同的 tzinfo 属性，相同的 tzinfo 属性会被忽略并对基本时间值进行比较。 如果两个比较方都是感知型且具有不同的 tzinfo 属性，两个比较方将首先通过减去它们的 UTC 时差（从 self.utcoffset() 获取）来进行调整。 为了防止将混合类型比较回退为基于对象地址的默认比较，当 time 对象与不同类型的对象比较时，将会引发 TypeError，除非比较运算符是 == 或 !=。 在后两种情况下将分别返回 False 或 True。

在 3.3 版更改: 感知型和简单型 time 实例之间的相等比较不会引发 TypeError。

在布尔运算时，time 对象总是被视为真值。

在 3.5 版更改: 在 Python 3.5 之前，如果一个 time 对象代表 UTC 午夜零时则会被视为假值。 此行为被认为容易引发困惑和错误，因此从 Python 3.5 起已被去除。 详情参见 bpo-13936 [https://bugs.python.org/issue?@action=redirect&bpo=13936]。

其他构造方法：

classmethod time.fromisoformat(time_string)

返回对应于 time.isoformat() 所提供的某种 time_string 格式的 time。 特别地，此函数支持以下格式的字符串：

HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]

警告

此方法 并不 支持解析任意 ISO 8601 字符串。 它的目的只是作为 time.isoformat() 的逆操作。

示例:

>>> from datetime import time
>>> time.fromisoformat('04:23:01')
datetime.time(4, 23, 1)
>>> time.fromisoformat('04:23:01.000384')
datetime.time(4, 23, 1, 384)
>>> time.fromisoformat('04:23:01+04:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))

3.7 新版功能.

实例方法：

time.replace(hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

返回一个具有同样属性值的 time，除非通过任何关键字参数指定了某些属性值。 请注意可以通过指定 tzinfo=None 从一个感知型 time 创建一个简单型 time，而不必转换时间数据。

3.6 新版功能: 增加了 fold 参数。

time.isoformat(timespec='auto')

返回表示为下列 ISO 8601 格式之一的时间字符串：

HH:MM:SS.ffffff，如果 microsecond 不为 0

HH:MM:SS，如果 microsecond 为 0

HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]，如果 utcoffset() 不返回 None

HH:MM:SS+HH:MM[:SS[.ffffff]]，如果 microsecond 为 0 并且 utcoffset() 不返回 None

可选参数 timespec 要包含的额外时间组件值 (默认为 'auto')。它可以是以下值之一：

'auto': 如果 microsecond 为 0 则与 'seconds' 相同，否则与 'microseconds' 相同。

'hours': 以两个数码的 HH 格式 包含 hour。

'minutes': 以 HH:MM 格式包含 hour 和 minute。

'seconds': 以 HH:MM:SS 格式包含 hour, minute 和 second。

'milliseconds': 包含完整时间，但将秒值的小数部分截断至毫秒。 格式为 HH:MM:SS.sss。

'microseconds': 以 HH:MM:SS.ffffff 格式包含完整时间。

注解

排除掉的时间部分将被截断，而不是被舍入。

对于无效的 timespec 参数将引发 ValueError。

示例:

>>> from datetime import time
>>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
'12:34'
>>> dt = time(hour=12, minute=34, second=56, microsecond=0)
>>> dt.isoformat(timespec='microseconds')
'12:34:56.000000'
>>> dt.isoformat(timespec='auto')
'12:34:56'

3.6 新版功能: 增加了 timespec 参数。

time.__str__()

对于时间对象 t, str(t) 等价于 t.isoformat()。

time.strftime(format)

返回一个由显式格式字符串所指明的代表时间的字符串。 要获取格式指令的完整列表，请参阅 strftime() 和 strptime() 的行为。

time.__format__(format)

与 time.strftime() 相同。 此方法使得为 time 对象指定以 格式化字符串字面值 表示的格式化字符串以及使用 str.format() 进行格式化成为可能。 要获取格式指令的完整列表，请参阅 strftime() 和 strptime() 的行为。

time.utcoffset()

如果 tzinfo 为 None，则返回 None，否则返回 self.tzinfo.utcoffset(None)，并且在后者不返回 None 或一个幅度小于一天的 a timedelta 对象时将引发异常。

在 3.7 版更改: UTC 时差不再限制为一个整数分钟值。

time.dst()

如果 tzinfo 为 None，则返回 None，否则返回 self.tzinfo.dst(None)，并且在后者不返回 None 或者一个幅度小于一天的 timedelta 对象时将引发异常。

在 3.7 版更改: DST 差值不再限制为一个整数分钟值。

time.tzname()

如果 tzinfo 为 None，则返回 None，否则返回 self.tzinfo.tzname(None)，如果后者不返回 None 或者一个字符串对象则将引发异常。

用法示例: time

使用 time 对象的例子:

>>> from datetime import time, tzinfo, timedelta
>>> class TZ1(tzinfo):
...     def utcoffset(self, dt):
...         return timedelta(hours=1)
...     def dst(self, dt):
...         return timedelta(0)
...     def tzname(self,dt):
...         return "+01:00"
...     def  __repr__(self):
...         return f"{self.__class__.__name__}()"
...
>>> t = 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.'

tzinfo 对象

class datetime.tzinfo

这是一个抽象基类，也就是说该类不应被直接实例化。 请定义 tzinfo 的子类来捕获有关特定时区的信息。

tzinfo 的（某个实体子类）的实例可以被传给 datetime 和 time 对象的构造器。 这些对象会将它们的属性视为对应于本地时间，并且 tzinfo 对象支持展示本地时间与 UTC 的差值、时区名称以及 DST 差值的方法，都是与传给它们的日期或时间对象的相对值。

你需要派生一个实体子类，并且（至少）提供你使用 datetime 方法所需要的标准 tzinfo 方法的实现。 datetime 模块提供了 timezone，这是 tzinfo 的一个简单实体子类，它能以与 UTC 的固定差值来表示不同的时区，例如 UTC 本身或北美的 EST 和 EDT。

对于封存操作的特殊要求：一个 tzinfo 子类必须具有可不带参数调用的 __init__() 方法，否则它虽然可以被封存，但可能无法再次解封。 这是个技术性要求，在未来可能会被取消。

一个 tzinfo 的实体子类可能需要实现以下方法。 具体需要实现的方法取决于感知型 datetime 对象如何使用它。 如果有疑问，可以简单地全都实现。

tzinfo.utcoffset(dt)

将本地时间与 UTC 时差返回为一个 timedelta 对象，如果本地时区在 UTC 以东则为正值。 如果本地时区在 UTC 以西则为负值。

这表示与 UTC 的 总计 时差；举例来说，如果一个 tzinfo 对象同时代表时区和 DST 调整，则 utcoffset() 应当返回两者的和。 如果 UTC 时差不确定则返回 None。 在其他情况下返回值必须为一个 timedelta 对象，其取值严格限制于 -timedelta(hours=24) 和 timedelta(hours=24) 之间（差值的幅度必须小于一天）。 大多数 utcoffset() 的实现看起来可能像是以下两者之一:

return CONSTANT                 # fixed-offset class
return CONSTANT + self.dst(dt)  # daylight-aware class

如果 utcoffset() 返回值不为 None，则 dst() 也不应返回 None。

默认的 utcoffset() 实现会引发 NotImplementedError。

在 3.7 版更改: UTC 时差不再限制为一个整数分钟值。

tzinfo.dst(dt)

将夏令时（DST）调整返回为一个 timedelta 对象，如果 DST 信息未知则返回 None。

如果 DST 未启用则返回 timedelta(0)。 如果 DST 已启用则将差值作为一个 timedelta 对象返回（参见 utcoffset() 了解详情）。 请注意 DST 差值如果可用，就会直接被加入 utcoffset() 所返回的 UTC 时差，因此无需额外查询 dst() 除非你希望单独获取 DST 信息。 例如，datetime.timetuple() 会调用其 tzinfo 属性的 dst() 方法来确定应该如何设置 tm_isdst 旗标，而 tzinfo.fromutc() 会调用 dst() 来在跨越时区时处理 DST 的改变。

一个可以同时处理标准时和夏令时的 tzinfo 子类的实例 tz 必须在此情形中保持一致：

tz.utcoffset(dt) - tz.dst(dt)

必须为具有同样的 tzinfo 子类实例且 dt.tzinfo == tz 的每个 datetime 对象 dt 返回同样的结果，此表达式会产生时区的“标准时差”，它不应取决于具体日期或时间，只取决于地理位置。 datetime.astimezone() 的实现依赖此方法，但无法检测违反规则的情况；确保符合规则是程序员的责任。 如果一个 tzinfo 子类不能保证这一点，也许可以重写 tzinfo.fromutc() 的默认实现以便在任何情况下与 astimezone() 正确配合。

大多数 dst() 的实现可能会如以下两者之一:

def dst(self, dt):
    # a fixed-offset class:  doesn't account for DST
    return timedelta(0)

或者：

def dst(self, dt):
    # Code to set dston and dstoff to the time zone's DST
    # transition times based on the input dt.year, and expressed
    # in standard local time.

    if dston <= dt.replace(tzinfo=None) < dstoff:
        return timedelta(hours=1)
    else:
        return timedelta(0)

默认的 dst() 实现会引发 NotImplementedError。

在 3.7 版更改: DST 差值不再限制为一个整数分钟值。

tzinfo.tzname(dt)

将对应于 datetime 对象 dt 的时区名称作为字符串返回。 datetime 模块没有定义任何字符串名称相关内容，也不要求名称有任何特定含义。 例如 "GMT", "UTC", "-500", "-5:00", "EDT", "US/Eastern", "America/New York" 都是有效的返回值。 如果字符串名称未知则返回 None。 请注意这是一个方法而不是一个固定的字符串，这主要是因为某些 tzinfo 子类可能需要根据所传入的特定 dt 值返回不同的名称，特别是当 tzinfo 类要负责处理夏令时的时候。

默认的 tzname() 实现会引发 NotImplementedError。

这些方法会被 datetime 或 time 对象调用，用来与它们的同名方法相对应。 datetime 对象会将自身作为传入参数，而 time 对象会将 None 作为传入参数。 这样 tzinfo 子类的方法应当准备好接受 dt 参数值为 None 或是 datetime 类的实例。

当传入 None 时，应当由类的设计者来决定最佳回应方式。 例如，返回 None 适用于希望该类提示时间对象不参与 tzinfo 协议处理。 让 utcoffset(None) 返回标准 UTC 时差也许会更有用处，因为并没有其他可用于发现标准时差的约定惯例。

当传入一个 datetime 对象来回应 datetime 方法时，dt.tzinfo 与 self 是同一对象。 tzinfo 方法可以依赖这一点，除非用户代码直接调用了 tzinfo 方法。 此行为的目的是使得 tzinfo 方法将 dt 解读为本地时间，而不需要担心其他时区的相关对象。

还有一个额外的 tzinfo 方法，某个子类可能会希望重写它：

tzinfo.fromutc(dt)

此方法会由默认的 datetime.astimezone() 实现来调用。 当被其调用时，dt.tzinfo 为 self，并且 dt 的日期和时间数据会被视为表示 UTC 时间，fromutc() 的目标是调整日期和时间数据，返回一个等价的 datetime 来表示 self 的本地时间。

大多数 tzinfo 子类应该能够毫无问题地继承默认的 fromutc() 实现。 它的健壮性足以处理固定差值的时区以及同时负责标准时和夏令时的时区，对于后者甚至还能处理 DST 转换时间在各个年份有变化的情况。 一个默认 fromutc() 实现可能无法在所有情况下正确处理的例子是（与 UTC 的）标准时差取决于所经过的特定日期和时间，这种情况可能由于政治原因而出现。 默认的 astimezone() 和 fromutc() 实现可能无法生成你希望的结果，如果这个结果恰好是跨越了标准时差发生改变的时刻当中的某个小时值的话。

忽略针对错误情况的代码，默认 fromutc() 实现的行为方式如下:

def fromutc(self, dt):
    # raise ValueError error if dt.tzinfo is not self
    dtoff = dt.utcoffset()
    dtdst = dt.dst()
    # raise ValueError if dtoff is None or dtdst is None
    delta = dtoff - dtdst  # this is self's standard offset
    if delta:
        dt += delta   # convert to standard local time
        dtdst = dt.dst()
        # raise ValueError if dtdst is None
    if dtdst:
        return dt + dtdst
    else:
        return dt

在以下 tzinfo_examples.py 文件中有一些 tzinfo 类的例子：

from datetime import tzinfo, timedelta, datetime

ZERO = timedelta(0)
HOUR = timedelta(hours=1)
SECOND = timedelta(seconds=1)

# 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 as _time

STDOFFSET = timedelta(seconds = -_time.timezone)
if _time.daylight:
    DSTOFFSET = timedelta(seconds = -_time.altzone)
else:
    DSTOFFSET = STDOFFSET

DSTDIFF = DSTOFFSET - STDOFFSET

class LocalTimezone(tzinfo):

    def fromutc(self, dt):
        assert dt.tzinfo is self
        stamp = (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 datetime(*args, microsecond=dt.microsecond,
                        tzinfo=self, fold=fold)

    def utcoffset(self, dt):
        if self._isdst(dt):
            return DSTOFFSET
        else:
            return STDOFFSET

    def dst(self, dt):
        if self._isdst(dt):
            return DSTDIFF
        else:
            return ZERO

    def tzname(self, dt):
        return _time.tzname[self._isdst(dt)]

    def _isdst(self, dt):
        tt = (dt.year, dt.month, dt.day,
              dt.hour, dt.minute, dt.second,
              dt.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(dt):
    days_to_go = 6 - dt.weekday()
    if days_to_go:
        dt += timedelta(days_to_go)
    return dt

# 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 = datetime(1, 3, 8, 2)
# and ends at 2am (DST time) on the first Sunday of Nov.
DSTEND_2007 = 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 = datetime(1, 4, 1, 2)
DSTEND_1987_2006 = 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 = 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 (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(tzinfo):

    def __init__(self, hours, reprname, stdname, dstname):
        self.stdoffset = timedelta(hours=hours)
        self.reprname = reprname
        self.stdname = stdname
        self.dstname = dstname

    def __repr__(self):
        return self.reprname

    def tzname(self, dt):
        if self.dst(dt):
            return self.dstname
        else:
            return self.stdname

    def utcoffset(self, dt):
        return self.stdoffset + self.dst(dt)

    def dst(self, dt):
        if dt is None or dt.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 dt.tzinfo is self.
            return ZERO
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        # Can't compare naive to aware objects, so strip the timezone from
        # dt first.
        dt = dt.replace(tzinfo=None)
        if start + HOUR <= dt < end - HOUR:
            # DST is in effect.
            return HOUR
        if end - HOUR <= dt < end:
            # Fold (an ambiguous hour): use dt.fold to disambiguate.
            return ZERO if dt.fold else HOUR
        if start <= dt < start + HOUR:
            # Gap (a non-existent hour): reverse the fold rule.
            return HOUR if dt.fold else ZERO
        # DST is off.
        return ZERO

    def fromutc(self, dt):
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        start = start.replace(tzinfo=self)
        end = end.replace(tzinfo=self)
        std_time = dt + 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")

请注意同时负责标准时和夏令时的 tzinfo 子类在每年两次的 DST 转换点上会出现不可避免的微妙问题。具体而言，考虑美国东部时区 (UTC -0500)，它的 EDT 从三月的第二个星期天 1:59 (EST) 之后一分钟开始，并在十一月的第一天星期天 1:59 (EDT) 之后一分钟结束:

  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

当 DST 开始时（即 "start" 行），本地时钟从 1:59 跳到 3:00。 形式为 2:MM 的时间值在那一天是没有意义的，因此在 DST 开始那一天 astimezone(Eastern) 不会输出包含 hour == 2 的结果。 例如，在 2016 年春季时钟向前调整时，我们得到:

>>> from datetime import datetime, timezone
>>> from tzinfo_examples import HOUR, Eastern
>>> u0 = datetime(2016, 3, 13, 5, tzinfo=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

当 DST 结束时（见 "end" 行），会有更糟糕的潜在问题：本地时间值中有一个小时是不可能没有歧义的：夏令时的最后一小时。 即以北美东部时间表示当天夏令时结束时的形式为 5:MM UTC 的时间。 本地时钟从 1:59 (夏令时) 再次跳回到 1:00 (标准时)。 形式为 1:MM 的本地时间就是有歧义的。 此时 astimezone() 是通过将两个相邻的 UTC 小时映射到两个相同的本地小时来模仿本地时钟的行为。 在这个北美东部时间的示例中，形式为 5:MM 和 6:MM 的 UTC 时间在转换为北美东部时间时都将被映射到 1:MM，但前一个时间会将 fold 属性设为 0 而后一个时间会将其设为 1。 例如，在 2016 年秋季时钟往回调整时，我们得到:

>>> 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

请注意不同的 datetime 实例仅通过 fold 属性值来加以区分，它们在比较时会被视为相等。

不允许时间显示存在歧义的应用需要显式地检查 fold 属性的值，或者避免使用混合式的 tzinfo 子类；当使用 timezone 或者任何其他固定差值的 tzinfo 子类例如仅表示 EST（固定差值 -5 小时）或仅表示 EDT（固定差值 -4 小时）的类时是不会有歧义的。

参见

zoneinfo

datetime 模块有一个基本 timezone 类（用来处理任意与 UTC 的固定时差）及其 timezone.utc 属性（一个 UTC 时区实例）。

zoneinfo 为 Python 带来了 IANA时区数据库 （也被称为 Olson 数据库），推荐使用它。

IANA 时区数据库 [https://www.iana.org/time-zones]

该时区数据库 (通常称为 tz, tzdata 或 zoneinfo) 包含大量代码和数据用来表示全球许多有代表性的地点的本地时间的历史信息。 它会定期进行更新以反映各政治实体对时区边界、UTC 差值和夏令时规则的更改。

timezone 对象

timezone 类是 tzinfo 的子类，它的每个实例都代表一个以与 UTC 的固定时差来定义的时区。

此类的对象不可被用于代表某些特殊地点的时区信息，这些地点在一年的不同日期会使用不同的时差，或是在历史上对民用时间进行过调整。

class datetime.timezone(offset, name=None)

offset 参数必须指定为一个 timedelta 对象，表示本地时间与 UTC 的时差。 它必须严格限制于 -timedelta(hours=24) 和 timedelta(hours=24) 之间，否则会引发 ValueError。

name 参数是可选的。 如果指定则必须为一个字符串，它将被用作 datetime.tzname() 方法的返回值。

3.2 新版功能.

在 3.7 版更改: UTC 时差不再限制为一个整数分钟值。

timezone.utcoffset(dt)

返回当 timezone 实例被构造时指定的固定值。

dt 参数会被忽略。 返回值是一个 timedelta 实例，其值等于本地时间与 UTC 之间的时差。

在 3.7 版更改: UTC 时差不再限制为一个整数分钟值。

timezone.tzname(dt)

返回当 timezone 实例被构造时指定的固定值。

如果没有在构造器中提供 name，则 tzname(dt) 所返回的名称将根据 offset 值按以下规则生成。 如果 offset 为 timedelta(0)，则名称为“UTC”，否则为字符串 UTC±HH:MM，其中 ± 为 offset 的正负符号，HH 和 MM 分别为表示 offset.hours 和 offset.minutes 的两个数码。

在 3.6 版更改: 由 offset=timedelta(0) 生成的名称现在是简单的 'UTC'，而不是 'UTC+00:00'。

timezone.dst(dt)

总是返回 None。

timezone.fromutc(dt)

返回 dt + offset。 dt 参数必须为一个感知型 datetime 实例，其中 tzinfo 值设为 self。

类属性：

timezone.utc

UTC 时区，timezone(timedelta(0))。

strftime() 和 strptime() 的行为

date, datetime 和 time 对象都支持 strftime(format) 方法，可用来创建由一个显式格式字符串所控制的表示时间的字符串。

相反地，datetime.strptime() 类会根据表示日期和时间的字符串和相应的格式字符串来创建一个 datetime 对象。

下表提供了 strftime() 与 strptime() 的高层级比较：

| strftime | strptime
用法 | 根据给定的格式将对象转换为字符串 | 将字符串解析为给定相应格式的 datetime 对象
方法类型 | 实例方法 | 类方法
方法 | date; datetime; time | datetime
签名 | strftime(format) | strptime(date_string, format)

strftime() 和 strptime() Format Codes

以下列表显示了 1989 版 C 标准所要求的全部格式代码，它们在带有标准 C 实现的所有平台上均可用。

指令 | 含意 | 示例 | 备注
%a | 当地工作日的缩写。 | Sun, Mon, ..., Sat (en_US); So, Mo, ..., Sa (de_DE) | (1)
%A | 本地化的星期中每日的完整名称。 | Sunday, Monday, ..., Saturday (en_US); Sonntag, Montag, ..., Samstag (de_DE) | (1)
%w | 以十进制数显示的工作日，其中0表示星期日，6表示星期六。 | 0, 1, ..., 6 |
%d | 补零后，以十进制数显示的月份中的一天。 | 01, 02, ..., 31 | (9)
%b | 当地月份的缩写。 | Jan, Feb, ..., Dec (en_US); Jan, Feb, ..., Dez (de_DE) | (1)
%B | 本地化的月份全名。 | January, February, ..., December (en_US); Januar, Februar, ..., Dezember (de_DE) | (1)
%m | 补零后，以十进制数显示的月份。 | 01, 02, ..., 12 | (9)
%y | 补零后，以十进制数表示的，不带世纪的年份。 | 00, 01, ..., 99 | (9)
%Y | 十进制数表示的带世纪的年份。 | 0001, 0002, ..., 2013, 2014, ..., 9998, 9999 | (2)
%H | 以补零后的十进制数表示的小时（24 小时制）。 | 00, 01, ..., 23 | (9)
%I | 以补零后的十进制数表示的小时（12 小时制）。 | 01, 02, ..., 12 | (9)
%p | 本地化的 AM 或 PM 。 | AM, PM (en_US); am, pm (de_DE) | (1), (3)
%M | 补零后，以十进制数显示的分钟。 | 00, 01, ..., 59 | (9)
%S | 补零后，以十进制数显示的秒。 | 00, 01, ..., 59 | (4), (9)
%f | 微秒作为一个十进制数，零填充到 6 位。 | 000000, 000001, ..., 999999 | (5)
%z | UTC 偏移量，格式为 ±HHMM[SS[.ffffff]] （如果是简单型对象则为空字符串）。 | (空), +0000, -0400, +1030, +063415, -030712.345216 | (6)
%Z | 时区名称（如果对象为简单型则为空字符串）。 | (空), UTC, GMT | (6)
%j | 以补零后的十进制数表示的一年中的日序号。 | 001, 002, ..., 366 | (9)
%U | 以补零后的十进制数表示的一年中的周序号（星期日作为每周的第一天）。 在新的一年中第一个星期日之前的所有日子都被视为是在第 0 周。 | 00, 01, ..., 53 | (7), (9)
%W | 以补零后的十进制数表示的一年中的周序号（星期一作为每周的第一天）。 在新的一年中第一个星期一之前的所有日子都被视为是在第 0 周。 | 00, 01, ..., 53 | (7), (9)
%c | 本地化的适当日期和时间表示。 | Tue Aug 16 21:30:00 1988 (en_US); Di 16 Aug 21:30:00 1988 (de_DE) | (1)
%x | 本地化的适当日期表示。 | 08/16/88 (None); 08/16/1988 (en_US); 16.08.1988 (de_DE) | (1)
%X | 本地化的适当时间表示。 | 21:30:00 (en_US); 21:30:00 (de_DE) | (1)
%% | 字面的 '%' 字符。 | % |

为了方便起见，还包括了C89标准不需要的其他一些指示符。 这些参数都对应于 ISO 8601 日期值。

指令 | 含意 | 示例 | 备注
%G | 带有世纪的 ISO 8601 年份，表示包含大部分 ISO 星期 (%V) 的年份。 | 0001, 0002, ..., 2013, 2014, ..., 9998, 9999 | (8)
%u | 以十进制数显示的 ISO 8601 星期中的日序号，其中 1 表示星期一。 | 1, 2, ..., 7 |
%V | 以十进制数显示的 ISO 8601 星期，以星期一作为每周的第一天。 第 01 周为包含 1 月 4 日的星期。 | 01, 02, ..., 53 | (8), (9)

这些代码可能不是在所有平台上都可与 strftime() 方法配合使用。 ISO 8601 年份和 ISO 8601 星期指令并不能与上面的年份和星期序号指令相互替代。 调用 strptime() 时传入不完整或有歧义的 ISO 8601 指令将引发 ValueError。

对完整格式代码集的支持在不同平台上有所差异，因为 Python 要调用所在平台的 C 库的 strftime() 函数，而不同平台的差异是很常见的。 要查看你所用平台所支持的完整格式代码集，请参阅 strftime(3) 文档。不同的平台在处理不支持的格式指定符方面也有差异。

3.6 新版功能: 增加了 %G, %u 和 %V。

技术细节

总体而言，d.strftime(fmt) 类似于 time 模块的 time.strftime(fmt, d.timetuple())，但是并非所有对象都支持 timetuple() 方法。

对于 datetime.strptime() 类方法，默认值为 1900-01-01T00:00:00.000: 任何未在格式字符串中指定的部分都将从默认值中提取。 4

使用 datetime.strptime(date_string, format) 等价于:

datetime(*(time.strptime(date_string, format)[0:6]))

除非格式中包含秒以下的部分或时区差值信息，它们在 datetime.strptime 中受支持但会被 time.strptime 所丢弃。

对于 time 对象，年、月、日的格式代码不应被使用，因为 time 对象没有这些值。 如果它们被使用，则年份将被替换为 1900，而月和日将被替换为 1。

对于 date 对象，时、分、秒和微秒的格式代码不应被使用，因为 date 对象没有这些值。 如果它们被使用，则它们都将被替换为 0。

出于相同的原因，对于包含当前区域设置字符集所无法表示的 Unicode 码位的格式字符串的处理方式也取决于具体平台。 在某些平台上这样的码位会不加修改地原样输出，而在其他平台上 strftime 则可能引发 UnicodeError 或只返回一个空字符串。

注释：

由于此格式依赖于当前区域设置，因此对具体输出值应当保持谨慎预期。 字段顺序会发生改变（例如 "month/day/year" 与 "day/month/year"），并且输出可能包含使用区域设置所指定的默认编码格式的 Unicode 字符（例如如果当前区域为 ja_JP，则默认编码格式可能为 eucJP, SJIS 或 utf-8 中的一个；使用 locale.getlocale() 可确定当前区域设置的编码格式）。

strptime() 方法能够解析整个 [1, 9999] 范围内的年份，但 < 1000 的年份必须加零填充为 4 位数字宽度。

在 3.2 版更改: 在之前的版本中，strftime() 方法只限于 >= 1900 的年份。

在 3.3 版更改: 在版本3.2中，strftime() 方法只限于 years >= 1000。

当与 strptime() 方法一起使用时，如果使用 %I 指令来解析小时，%p 指令只影响输出小时字段。

与 time 模块不同的是， datetime 模块不支持闰秒。

当与 strptime() 方法一起使用时，%f 指令可接受一至六个数码及左边的零填充。 %f 是对 C 标准中格式字符集的扩展（但单独在 datetime 对象中实现，因此它总是可用）。

对于简单型对象，%z and %Z 格式代码会被替换为空字符串。

对于一个感知型对象而言：

%z

utcoffset() 会被转换为 ±HHMM[SS[.ffffff]] 形式的字符串，其中 HH 为给出 UTC 时差的小时部分的 2 位数码字符串，MM 为给出 UTC 时差的分钟部分的 2 位数码字符串，SS 为给出 UTC 时差的秒部分的 2 位数码字符串，而 ffffff 为给出 UTC 时差的微秒部分的 6 位数码字符串。 当时差为整数秒时 ffffff 部分将被省略，而当时差为整数分钟时 ffffff 和 SS 部分都将被省略。 例如，如果 utcoffset() 返回 timedelta(hours=-3, minutes=-30)，则 %z 会被替换为字符串 '-0330'。

在 3.7 版更改: UTC 时差不再限制为一个整数分钟值。

在 3.7 版更改: 当提供 %z 指令给 strptime() 方法时，UTC 差值可以在时、分和秒之间使用冒号分隔符。 例如，'+01:00:00' 将被解读为一小时的差值。 此外，提供 'Z' 就相当于 '+00:00'。

%Z

在 strftime() 中，如果 tzname() 返回 None 则 %Z 会被替换为一个空字符串；在其他情况下 %Z 会被替换为返回值，该值必须为一个字符串。

strptime() 仅接受特定的 %Z 值:

你的机器的区域设置可以是 time.tzname 中的任何值

硬编码的值 UTC 和 GMT

这样生活在日本的人可用的值为 JST, UTC 和 GMT，但可能没有 EST。 它将引发 ValueError 表示无效的值。

在 3.2 版更改: 当提供 %z 指令给 strptime() 方法时，将产生一个感知型 datetime 对象。 结果的 tzinfo 将被设为一个 timezone 实例。

当与 strptime() 方法一起使用时，%U 和 %W 仅用于指定星期几和日历年份 (%Y) 的计算。

类似于 %U 和 %W，%V 仅用于在 strptime() 格式字符串中指定星期几和 ISO 年份 (%G) 的计算。 还要注意 %G 和 %Y 是不可交换的。

当与 strptime() 方法一起使用的，前导的零在格式 %d, %m, %H, %I, %M, %S, %j, %U, %W 和 %V 中是可选的。 格式 %y 则要求有前导的零。

备注

1

就是说如果我们忽略相对论效应的话。

2

这与 Dershowitz 和 Reingold 所著 Calendrical Calculations 中“预期格列高利”历法的定义一致，它是适用于该书中所有运算的基础历法。 请参阅该书了解在预期格利高利历序列与许多其他历法系统之间进行转换的算法。

3

请参阅 R. H. van Gent 所著 ISO 8601 历法的数学指南 [https://web.archive.org/web/20220531051136/https://webspace.science.uu.nl/~gent0113/calendar/isocalendar.htm] 以获取更完整的说明。

4

传入 datetime.strptime('Feb 29', '%b %d') 将导致错误，因为 1900 不是闰年。

zoneinfo --- IANA 时区支持

3.9 新版功能.

源代码: Lib/zoneinfo [https://github.com/python/cpython/tree/3.10/Lib/zoneinfo]

zoneinfo 模块根据 PEP 615 [https://www.python.org/dev/peps/pep-0615] 的最初说明提供了具体的时区实现来支持 IANA 时区数据库。 按照默认设置，zoneinfo 会在可能的情况下使用系统的时区数据；如果系统时区数据不可用，该库将回退为使用 PyPI 上提供的 tzdata [https://pypi.org/project/tzdata/] 第一方包。

参见

模块: datetime

提供 time 和 datetime 类型，ZoneInfo 类被设计为可配合这两个类型使用。

包 tzdata [https://pypi.org/project/tzdata/]

由 CPython 核心开发者维护以通过 PyPI 提供时区数据的第一方包。

使用 ZoneInfo

ZoneInfo 是 datetime.tzinfo 抽象基类的具体实现，其目标是通过构造器、 datetime.replace 方法或 datetime.astimezone 来与 tzinfo 建立关联:

>>> from zoneinfo import ZoneInfo
>>> from datetime import datetime, timedelta

>>> dt = datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-10-31 12:00:00-07:00

>>> dt.tzname()
'PDT'

以此方式构造的日期时间对象可兼容日期时间运算并可在无需进一步干预的情况下处理夏令时转换:

>>> dt_add = dt + timedelta(days=1)

>>> print(dt_add)
2020-11-01 12:00:00-08:00

>>> dt_add.tzname()
'PST'

这些时区还支持在 PEP 495 [https://www.python.org/dev/peps/pep-0495] 中引入的 fold。 在可能导致时间歧义的时差转换中（例如夏令时到标准时的转换），当 fold=0 时会使用转换 之前 的时差，而当 fold=1 时则使用转换 之后 的时差，例如:

>>> dt = datetime(2020, 11, 1, 1, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-11-01 01:00:00-07:00

>>> print(dt.replace(fold=1))
2020-11-01 01:00:00-08:00

当执行来自另一时区的转换时，fold 将被设置为正确的值:

>>> from datetime import timezone
>>> LOS_ANGELES = ZoneInfo("America/Los_Angeles")
>>> dt_utc = datetime(2020, 11, 1, 8, tzinfo=timezone.utc)

>>> # Before the PDT -> PST transition
>>> print(dt_utc.astimezone(LOS_ANGELES))
2020-11-01 01:00:00-07:00

>>> # After the PDT -> PST transition
>>> print((dt_utc + timedelta(hours=1)).astimezone(LOS_ANGELES))
2020-11-01 01:00:00-08:00

数据源

zoneinfo 模块不直接提供时区数据，而是在可能的情况下从系统时区数据库或 PyPI 上的第一方包 tzdata [https://pypi.org/project/tzdata/] 获取时区信息。 某些系统，重要的一点是 Windows 系统也包括在内，并没有可用的 IANA 数据库，因此对于要保证获取时区信息的跨平台兼容性的项目，推荐对 tzdata 声明依赖。 如果系统数据和 tzdata 均不可用，则所有对 ZoneInfo 的调用都将引发 ZoneInfoNotFoundError。

配置数据源

当 ZoneInfo(key) 被调用时，此构造器首先会在 TZPATH 所指定的目录下搜索匹配 key 的文件，失败时则会在 tzdata 包中查找匹配。 此行为可通过三种方式来配置:

默认的 TZPATH 未通过其他方式指定时可在 编译时 进行配置。

TZPATH 可使用 环境变量 进行配置。

在 运行时，搜索路径可使用 reset_tzpath() 函数来修改。

编译时配置

默认的 TZPATH 包括一些时区数据库的通用部署位置（Windows 除外，该系统没有时区数据的“通用”位置）。 在 POSIX 系统中，下游分发者和从源码编译 Python 的开发者知道系统时区数据部署位置，它们可以通过指定编译时选项 TZPATH (或者更常见的是通过 配置旗标 --with-tzpath) 来改变默认的时区路径，该选项应当是一个由 os.pathsep 分隔的字符串。

在所有平台上，配置值会在 sysconfig.get_config_var() 中以 TZPATH 键的形式提供。

环境配置

当初始化 TZPATH 时（在导入时或不带参数调用 reset_tzpath() 时），zoneinfo 模块将使用环境变量 PYTHONTZPATH，如果变量存在则会设置搜索路径。

PYTHONTZPATH

这是一个以 os.pathsep 分隔的字符串，其中包含要使用的时区搜索路径。 它必须仅由绝对路径而非相对路径组成。 在 PYTHONTZPATH 中指定的相对路径部分将不会被使用，但在其他情况下当指定相对路径时的行为该实现是有定义的；CPython 将引发 InvalidTZPathWarning，而其他实现可自由地忽略错误部分或是引发异常。

要设置让系统忽略系统数据并改用 tzdata 包，请设置 PYTHONTZPATH=""。

运行时配置

TZ 搜索路径也可在运行时使用 reset_tzpath() 函数来配置。 通常并不建议如此操作，不过在需要使用指定时区路径（或者需要禁止访问系统时区）的测试函数中使用它则是合理的。

ZoneInfo 类

class zoneinfo.ZoneInfo(key)

一个具体的 datetime.tzinfo 子类，它代表一个由字符串 key 所指定的 IANA 时区。 对主构造器的调用将总是返回可进行标识比较的对象；但是另一种方式，对所有的 key 值通过 ZoneInfo.clear_cache() 禁止缓存失效，对以下断言将总是为真值:

a = ZoneInfo(key)
b = ZoneInfo(key)
assert a is b

key 必须采用相对的标准化 POSIX 路径的形式，其中没有对上一层级的引用。 如果传入了不合要求的键则构造器将引发 ValueError。

如果没有找到匹配 key 的文件，构造器将引发 ZoneInfoNotFoundError。

ZoneInfo 类具有两个替代构造器:

classmethod ZoneInfo.from_file(fobj, /, key=None)

基于一个返回字节串的文件型对象（例如一个以二进制模式打开的文件或是一个 io.BytesIO 对象）构造 ZoneInfo 对象。 不同于主构造器，此构造器总是会构造一个新对象。

key 形参设置时区名称以供 __str__() 和 __repr__() 使用。

由此构造器创建的对象不可被封存 (参见 pickling)。

classmethod ZoneInfo.no_cache(key)

一个绕过构造器缓存的替代构造器。 它与主构造器很相似，但每次调用都会返回一个新对象。 此构造器在进行测试或演示时最为适用，但它也可以被用来创建具有不同缓存失效策略的系统。

由此构造器创建的对象在被解封时也会绕过反序列化进程的缓存。

警告

使用此构造器可以会以令人惊讶的方式改变日期时间对象的语义，只有在你确定你的需求时才使用它。

也可以使用以下的类方法:

classmethod ZoneInfo.clear_cache(*, only_keys=None)

一个可在 ZoneInfo 类上禁用缓存的方法。 如果不传入参数，则会禁用所有缓存并且下次对每个键调用主构造器将返回一个新实例。

如果将一个键名称的可迭代对象传给 only_keys 形参，则将只有指定的键会被从缓存中移除。 传给 only_keys 但在缓存中找不到的键会被忽略。

警告

发起调用此函数可能会以令人惊讶的方式改变使用 ZoneInfo 的日期时间对象的语义；这会修改进程范围内的全局状态并因此可能产生大范围的影响。 只有在你确定你的需求时才使用它。

该类具有一个属性:

ZoneInfo.key

这是一个只读的 attribute，它返回传给构造器的 key 的值，该值应为一个 IANA 时区数据库的查找键 (例如 America/New_York, Europe/Paris 或 Asia/Tokyo)。

对于不指定 key 形参而是基于文件构造时区，该属性将设为 None。

注解

尽管将这些信息暴露给最终用户是一种比较普通的做法，但是这些值被设计作为代表相关时区的主键而不一定是面向用户的元素。 CLDR (Unicode 通用区域数据存储库) 之类的项目可被用来根据这些键获取更为用户友好的字符串。

字符串表示

当在 ZoneInfo 对象上调用 str 时返回的字符串表示默认会使用 ZoneInfo.key 属性（参见该属性文档中的用法注释）:

>>> zone = ZoneInfo("Pacific/Kwajalein")
>>> str(zone)
'Pacific/Kwajalein'

>>> dt = datetime(2020, 4, 1, 3, 15, tzinfo=zone)
>>> f"{dt.isoformat()} [{dt.tzinfo}]"
'2020-04-01T03:15:00+12:00 [Pacific/Kwajalein]'

对于基于文件而非指定 key 形参所构建的对象，str 会回退为调用 repr()。 ZoneInfo 的 repr 是由具体实现定义的并且不一定会在不同版本间保持稳定，但它保证不会是一个有效的 ZoneInfo 键。

封存序列化

ZoneInfo 对象的序列化是基于键的，而不是序列化所有过渡数据，并且基于文件构造的 ZoneInfo 对象（即使是指定了 key 值的对象）不能被封存。

ZoneInfo 文件的行为取决于它的构造方式:

ZoneInfo(key): 当使用主构造器构造时，会基于键序列化一个 ZoneInfo 对象，而当反序列化时，反序列化过程会使用主构造器，因此预期它们与其他对同一时区的引用会是同一对象。 例如，如果 europe_berlin_pkl 是一个包含基于 ZoneInfo("Europe/Berlin") 构建的封存数据的字符串，你可以预期出现以下的行为:

>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl)
>>> a is b
True

ZoneInfo.no_cache(key): 当通过绕过缓存的构造器构造时，ZoneInfo 对象也会基于键序列化，但当反序列化时，反序列化过程会使用绕过缓存的构造器。 如果 europe_berlin_pkl_nc 是一个包含基于 ZoneInfo.no_cache("Europe/Berlin") 构造的封存数据的字符串，你可以预期出现以下的行为:

>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl_nc)
>>> a is b
False

ZoneInfo.from_file(fobj, /, key=None): 当通过文件构造时，ZoneInfo 对象会在封存时引发异常。 如果最终用户想要封存通过文件构造的 ZoneInfo，则推荐他们使用包装类型或自定义序列化函数：或者基于键序列化，或者存储文件对象的内容并将其序列化。

该序列化方法要求所需键的时区数据在序列化和反序列化中均可用，类似于在序列化和反序列化环境中都预期存在对类和函数的引用的方式。 这还意味着在具有不同时区数据版本的环境中当解封被封存的 ZoneInfo 时并不会保证结果的一致性。

函数

zoneinfo.available_timezones()

获取一个包含可用 IANA 时区的在时区路径的任何位置均可用的全部有效键的集合。 每次调用该函数时都会重新计算。

此函数仅包括规范时区名称而不包括“特殊”时区如位于 posix/ 和 right/ 目录下的时区或 posixrules 时区。

警告

此函数可能会打开大量的文件，因为确定时区路径上某个文件是否为有效时区的最佳方式是读取开头位置的“魔术字符串”。

注解

这些值并不被设计用来对外公开给最终用户；对于面向用户的元素，应用程序应当使用 CLDR (Unicode 通用区域数据存储库) 之类来获取更为用户友好的字符串。 另请参阅 ZoneInfo.key 中的提示性说明。

zoneinfo.reset_tzpath(to=None)

设置或重置模块的时区搜索路径 (TZPATH)。 当不带参数调用时，TZPATH 会被设为默认值。

调用 reset_tzpath 将不会使 ZoneInfo 缓存失效，因而在缓存未命中的情况下对主 ZoneInfo 构造器的调用将只使用新的 TZPATH。

to 形参必须是由字符串或 os.PathLike 组成的 sequence 或而不是字符串，它们必须都是绝对路径。 如果所传入的不是绝对路径则将引发 ValueError。

全局变量

zoneinfo.TZPATH

一个表示时区搜索路径的只读序列 -- 当通过键构造 ZoneInfo 时，键会与 TZPATH 中的每个条目进行合并，并使用所找到的第一个文件。

TZPATH 可以只包含绝对路径，绝不包含相对路径，无论它是如何配置的。

zoneinfo.TZPATH 所指向的对象可能随着对 reset_tzpath() 的调用而改变，因此推荐使用 zoneinfo.TZPATH 而不是从 zoneinfo 导入 TZPATH 或是将 zoneinfo.TZPATH 赋值给一个长期变量。

有关配置时区搜索路径的更多信息，请参阅 配置数据源。

异常与警告

exception zoneinfo.ZoneInfoNotFoundError

当一个 ZoneInfo 对象的构造由于在系统中找不到指定的键而失败时引发。 这是 KeyError 的一个子类。

exception zoneinfo.InvalidTZPathWarning

当 PYTHONTZPATH 包含将被过滤掉的无效组件，例如一个相对路径时引发。

calendar --- 日历相关函数

源代码： Lib/calendar.py [https://github.com/python/cpython/tree/3.10/Lib/calendar.py]

这个模块让你可以输出像 Unix cal 那样的日历，它还提供了其它与日历相关的实用函数。 默认情况下，这些日历把星期一作为一周的第一天，星期天作为一周的最后一天（这是欧洲惯例）。可以使用 setfirstweekday() 方法设置一周的第一天为星期天 (6) 或者其它任意一天。函数全部接收整数类型的参数用来指定日期。其它相关功能参见 datetime 和 time 模块。

在这个模块中定义的函数和类都基于一个理想化的日历——向过去和未来两个方向无限扩展的现行公历。这与 Dershowitz 和 Reingold 的书“历法计算”中所有计算的基本日历 "proleptic Gregorian" 历的定义相符。0 和负数年份按照 ISO 8601 标准解释：0 年指公元前 1 年，-1 年指公元前 2 年，依此类推。

class calendar.Calendar(firstweekday=0)

创建一个 Calendar 对象。firstweekday 是一个用来指定每星期第一天的整数。MONDAY 是 0 （默认值），SUNDAY 是 6。

Calendar 对象提供了一些可用于对日历数据进行格式化的准备的方法。这个类本身不执行任何格式化操作。 这部分任务应由子类来完成。

Calendar 实例有下列方法：

iterweekdays()

返回一个迭代器，迭代器的内容为一周里每天的星期值。迭代器的第一个值与 firstweekday 属性的值一致。

itermonthdates(year, month)

为 year 年 month 月 (1-12) 返回一个迭代器。这个迭代器返回当月的所有日期（使用 datetime.date 对象），日期包含了本月头尾用于组成完整一周的日期。

itermonthdays(year, month)

为 year 年 month 月返回一个与 itermonthdates() 类似的迭代器，但不会受 datetime.date 范围的限制。返回的为每一天的日期相对于当月 1 日过去的天数。对于不在当月的日期，返回数字 0。

itermonthdays2(year, month)

为 year 年 month 月返回一个与 itermonthdates() 类似的迭代器，但不会受 datetime.date 范围的限制。迭代器中的每一个元素为由日数和代表星期几的数字组成的元组。

itermonthdays3(year, month)

为 year 年 month 月返回一个与 itermonthdates() 类似的迭代器，但不会受 datetime.date 范围的限制。迭代器的元素为一个由年、月、日组成的元组。

3.7 新版功能.

itermonthdays4(year, month)

为 year 年 month 月返回一个与 itermonthdates() 类似的迭代器，但不会受 datetime.date 范围的限制。迭代器的元素为一个由年、月、日和代表星期几的数字组成的元组。

3.7 新版功能.

monthdatescalendar(year, month)

返回 year 年 month 月的周组成的列表。列表中的每一个周是由七个 datetime.date 对象组成的列表。

monthdays2calendar(year, month)

返回 year 年 month 月的周组成的列表。列表中的每一个周是七个由日数和代表星期几的数字组成的元组的列表。

monthdayscalendar(year, month)

返回 year 年 month 月的周组成的列表。列表中的每一个周是由七个日数组成的列表。

yeardatescalendar(year, width=3)

返回可以用来格式化的指定年月的数据。返回的值是一个列表，列表是月份组成的行。每一行包含了最多 width 个月(默认为3)。每个月包含了4到6周，每周包含1--7天。每一天使用 datetime.date 对象。

yeardays2calendar(year, width=3)

返回可以用来模式化的指定年月的数据(与 yeardatescalendar() 类似)。周列表的元素是由表示日期的数字和表示星期几的数字组成的元组。不在这个月的日子为0。

yeardayscalendar(year, width=3)

返回可以用来模式化的指定年月的数据(与 yeardatescalendar() 类似)。周列表的元素是表示日期的数字。不在这个月的日子为0。

class calendar.TextCalendar(firstweekday=0)

可以使用这个类生成纯文本日历。

TextCalendar 实例有以下方法：

formatmonth(theyear, themonth, w=0, l=0)

返回指定月的用多行字符串表示的月历。w 为日期列的宽度，日期列居中打印。l 指定了周与周之间的行距。返回的日历还依赖于构造器或者 setfirstweekday() 方法指定的每周的第一天是哪一天。

prmonth(theyear, themonth, w=0, l=0)

调用 formatmonth() 方法并打印返回的月历。

formatyear(theyear, w=2, l=1, c=6, m=3)

返回指定年的用多行字符串表示的 m 列年历。可选参数 w、l 和 c 分别表示日期列宽，周的行距，和月与月之间的纵向间隔。同样依赖于构造器或者 setfirstweekday() 方法指定的每周的第一天是哪一天。可以生成年历的最早的年是哪一年依赖于使用的平台。

pryear(theyear, w=2, l=1, c=6, m=3)

调用 formatyear() 方法并打印返回的年历。

class calendar.HTMLCalendar(firstweekday=0)

可以使用这个类生成 HTML 日历。

HTMLCalendar 实例有以下方法：

formatmonth(theyear, themonth, withyear=True)

返回一个 HTML 表格作为指定年月的日历。 withyear 为真，则年份将会包含在表头，否则只显示月份。

formatyear(theyear, width=3)

返回一个 HTML 表格作为指定年份的日历。 width (默认为3) 用于规定每一行显示月份的数量。

formatyearpage(theyear, width=3, css='calendar.css', encoding=None)

返回一个完整的 HTML 页面作为指定年份的日历。 width*(默认为3) 用于规定每一行显示的月份数量。 *css 为层叠样式表的名字。如果不使用任何层叠样式表，可以使用 None 。 encoding 为输出页面的编码 (默认为系统的默认编码)。

HTMLCalendar 有以下属性，你可以重写它们来自定义应用日历的样式。

cssclasses

一个对应星期一到星期天的 CSS class 列表。默认列表为

cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]

可以向每天加入其它样式

cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]

需要注意的是，列表的长度必须为7。

cssclass_noday

工作日的 CSS 类在上个月或下个月发生。

3.7 新版功能.

cssclasses_weekday_head

用于标题行中的工作日名称的 CSS 类 列表。默认值与 cssclasses 相同。

3.7 新版功能.

cssclass_month_head

月份的头 CSS 类（由 formatmonthname() 使用）。默认值为 "month" 。

3.7 新版功能.

cssclass_month

某个月的月历的 CSS 类（由 formatmonth() 使用）。默认值为 "month" 。

3.7 新版功能.

cssclass_year

某年的年历的 CSS 类（由 formatyear() 使用）。默认值为 "year" 。

3.7 新版功能.

cssclass_year_head

年历的·表头 CSS 类（由 formatyear() 使用）。默认值为 "year" 。

3.7 新版功能.

需要注意的是，尽管上面命名的样式类都是单独出现的(如： cssclass_month cssclass_noday), 但我们可以使用空格将样式类列表中的多个元素分隔开，例如：

"text-bold text-red"

下面是一个如何自定义 HTMLCalendar 的示例

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"

class calendar.LocaleTextCalendar(firstweekday=0, locale=None)

这个子类 TextCalendar 可以在构造函数中传递一个语言环境名称，并且返回月份和星期几的名称在特定语言环境中。如果此语言环境包含编码，则包含月份和工作日名称的所有字符串将作为 unicode 返回。

class calendar.LocaleHTMLCalendar(firstweekday=0, locale=None)

This subclass of HTMLCalendar can be passed a locale name in the constructor and will return month and weekday names in the specified locale. If this locale includes an encoding all strings containing month and weekday names will be returned as unicode.

注解

这两个类的 formatweekday() 和 formatmonthname() 方法临时更改dang当前区域至给定 locale 。由于当前的区域设置是进程范围的设置，因此它们不是线程安全的。

这个模块为简单的文本日历提供了下列函数。

calendar.setfirstweekday(weekday)

设置每一周的开始（0 表示星期一，6 表示星期天）。提供了 MONDAY、TUESDAY、WEDNESDAY、THURSDAY、FRIDAY、SATURDAY 和 SUNDAY 几个常量值作为方便。例如，设置每周的第一天为星期天：

import calendar
calendar.setfirstweekday(calendar.SUNDAY)

calendar.firstweekday()

返回当前设置的每星期的第一天的数值。

calendar.isleap(year)

如果 year 是闰年则返回 True ,否则返回 False。

calendar.leapdays(y1, y2)

返回在范围 y1 至 y2 （不包括 y2）之间的闰年的年数，其中 y1 和 y2 是年份。

此函数对于跨越世纪初的范围也适用。

calendar.weekday(year, month, day)

返回某年（ 1970 -- ...），某月（ 1 -- 12 ），某日（ 1 -- 31 ）是星期几（ 0 是星期一）。

calendar.weekheader(n)

返回一个包含星期几的缩写名的头。 n 指定星期几缩写的字符宽度。

calendar.monthrange(year, month)

返回指定 年份 的指定 月份 的第一天是星期几和这个月的天数。

calendar.monthcalendar(year, month)

返回表示一个月的日历的矩阵。 每一行代表一周；此月份外的日子由零表示。 每周从周一开始，除非使用 setfirstweekday() 改变设置。

calendar.prmonth(theyear, themonth, w=0, l=0)

打印由 month() 返回的一个月的日历。

calendar.month(theyear, themonth, w=0, l=0)

使用 TextCalendar 类的 formatmonth() 以多行字符串形式返回月份日历。

calendar.prcal(year, w=0, l=0, c=6, m=3)

打印由 calendar() 返回的整年的日历。

calendar.calendar(year, w=2, l=1, c=6, m=3)

使用 TextCalendar 类的 formatyear() 返回整年的3列的日历以多行字符串的形式。

calendar.timegm(tuple)

一个不相关但很好用的函数，它接受一个时间元组例如 time 模块中的 gmtime() 函数的返回并返回相应的 Unix 时间戳值，假定 1970 年开始计数， POSIX 编码。实际上， time.gmtime() 和 timegm() 是彼此相反的。

calendar 模块导出以下数据属性：

calendar.day_name

在当前语言环境下表示星期几的数组。

calendar.day_abbr

在当前语言环境下表示星期几缩写的数组。

calendar.month_name

在当前语言环境下表示一年中月份的数组。这遵循一月的月号为 1 的通常惯例，所以它的长度为 13 且 month_name[0] 是空字符串。

calendar.month_abbr

在当前语言环境下表示月份简写的数组。这遵循一月的月号为 1 的通常惯例，所以它的长度为 13 且 month_abbr[0] 是空字符串。

calendar.MONDAY

calendar.TUESDAY

calendar.WEDNESDAY

calendar.THURSDAY

calendar.FRIDAY

calendar.SATURDAY

calendar.SUNDAY

星期内序号的别名，其中 MONDAY 是 0 而 SUNDAY 是 6。

参见

模块 datetime

为日期和时间提供与 time 模块相似功能的面向对象接口。

模块 time

底层时间相关函数。

collections --- 容器数据类型

源代码： Lib/collections/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/collections/__init__.py]

这个模块实现了一些专门化的容器，提供了对 Python 的通用内建容器 dict、list、set 和 tuple 的补充。

namedtuple() | 一个工厂函数，用来创建元组的子类，子类的字段是有名称的。
deque | 类似列表的容器，但 append 和 pop 在其两端的速度都很快。
ChainMap | 类似字典的类，用于创建包含多个映射的单个视图。
Counter | 用于计数 hashable 对象的字典子类
OrderedDict | 字典的子类，能记住条目被添加进去的顺序。
defaultdict | 字典的子类，通过调用用户指定的工厂函数，为键提供默认值。
UserDict | 封装了字典对象，简化了字典子类化
UserList | 封装了列表对象，简化了列表子类化
UserString | 封装了字符串对象，简化了字符串子类化

ChainMap 对象

3.3 新版功能.

ChainMap 类将多个映射迅速地链到一起，这样它们就可以作为一个单元处理。这通常比创建一个新字典再重复地使用 update() 要快得多。

这个类可以用于模拟嵌套作用域，并且对模版化有用。

class collections.ChainMap(*maps)

一个 ChainMap 将多个字典或者其他映射组合在一起，创建一个单独的可更新的视图。 如果没有指定任何 maps，一个空字典会被作为 maps。这样，每个新链至少包含一个映射。

底层映射被存储在一个列表中。这个列表是公开的，可以通过 maps 属性存取和更新。没有其他的状态。

搜索查询底层映射，直到一个键被找到。不同的是，写，更新和删除只操作第一个映射。

一个 ChainMap 通过引用合并底层映射。 所以，如果一个底层映射更新了，这些更改会反映到 ChainMap 。

支持所有常用字典方法。另外还有一个 maps 属性(attribute)，一个创建子上下文的方法(method)， 一个存取它们首个映射的属性(property):

maps

一个可以更新的映射列表。这个列表是按照第一次搜索到最后一次搜索的顺序组织的。它是仅有的存储状态，可以被修改。列表最少包含一个映射。

new_child(m=None, **kwargs)

返回一个新的 ChainMap，其中包含一个新的映射，后面跟随当前实例中的所有映射。 如果指定了 m，它会成为新的映射加在映射列表的前面；如果未指定，则会使用一个空字典，因此调用 d.new_child() 就等价于 ChainMap({}, *d.maps)。 如果指定了任何关键字参数，它们会更新所传入的映射或新的空字典。 此方法被用于创建子上下文，它可在不改变任何上级映射的情况下被更新。

在 3.4 版更改: 添加了可选的 m 形参。

在 3.10 版更改: 增加了对关键字参数的支持。

parents

属性返回一个新的 ChainMap 包含所有的当前实例的映射，除了第一个。这样可以在搜索的时候跳过第一个映射。 使用的场景类似在 nested scopes 嵌套作用域中使用 nonlocal 关键词。用例也可以类比内建函数 super() 。一个 d.parents 的引用等价于 ChainMap(*d.maps[1:]) 。

注意，一个 ChainMap() 的迭代顺序是通过从后往前扫描所有映射来确定的:

>>> baseline = {'music': 'bach', 'art': 'rembrandt'}
>>> adjustments = {'art': 'van gogh', 'opera': 'carmen'}
>>> list(ChainMap(adjustments, baseline))
['music', 'art', 'opera']

使得顺序与从最后一个映射开始调用一系列 dict.update() 得到的字典的迭代顺序相同：

>>> combined = baseline.copy()
>>> combined.update(adjustments)
>>> list(combined)
['music', 'art', 'opera']

在 3.9 版更改: 增加了对 | 和 |= 运算符的支持，相关说明见 PEP 584 [https://www.python.org/dev/peps/pep-0584]。

参见

MultiContext class [https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py] 在 Enthought CodeTools package [https://github.com/enthought/codetools] 有支持写映射的选项。

Django 中用于模板的 Context class [https://github.com/django/django/blob/main/django/template/context.py] 是只读的映射链。 它还具有上下文推送和弹出特性，类似于 new_child() 方法和 parents 特征属性。

Nested Contexts recipe [https://code.activestate.com/recipes/577434/] 提供了是否对第一个映射或其他映射进行写和其他修改的选项。

一个 极简的只读版 Chainmap [https://code.activestate.com/recipes/305268/].

ChainMap 例子和方法

这一节提供了多个使用链映射的案例。

模拟Python内部lookup链的例子

import builtins
pylookup = ChainMap(locals(), globals(), vars(builtins))

让用户指定的命令行参数优先于环境变量，优先于默认值的例子

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'])

用 ChainMap 类模拟嵌套上下文的例子

c = ChainMap()        # Create root context
d = c.new_child()     # Create nested child context
e = c.new_child()     # Child of c, independent from d
e.maps[0]             # Current context dictionary -- like Python's locals()
e.maps[-1]            # Root context -- like Python's globals()
e.parents             # Enclosing context chain -- like Python's nonlocals

d['x'] = 1            # Set value in current context
d['x']                # Get first key in the chain of contexts
del d['x']            # Delete from current context
list(d)               # All nested values
k in d                # Check all nested values
len(d)                # Number of nested values
d.items()             # All nested items
dict(d)               # Flatten into a regular dictionary

ChainMap 类只更新链中的第一个映射，但lookup会搜索整个链。 然而，如果需要深度写和删除，也可以很容易的通过定义一个子类来实现它

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'         # update an existing key two levels down
>>> d['snake'] = 'red'           # new keys get added to the topmost dict
>>> del d['elephant']            # remove an existing key one level down
>>> d                            # display result
DeepChainMap({'zebra': 'black', 'snake': 'red'}, {}, {'lion': 'orange'})

Counter 对象

一个计数器工具，为的是可以方便快速地计账。例如：

>>> # Tally occurrences of words in a list
>>> cnt = Counter()
>>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
...     cnt[word] += 1
>>> cnt
Counter({'blue': 3, 'red': 2, 'green': 1})

>>> # Find the ten most common words in Hamlet
>>> 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)]

class collections.Counter([iterable-or-mapping])

Counter 是 dict 的子类，用于计数 hashable 对象。它是一个多项集，元素存储为字典的键而它们的计数存储为字典的值。计数可以是任何整数，包括零或负的计数值。Counter 类与其他语言中的 bag 或 multiset 很相似。

它可以通过计数一个 iterable 中的元素来初始化，或用其它 mapping (包括 counter) 初始化：

>>> 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

Counter 对象的接口类似于字典，不同的是，如果查询的键不在 Counter 中，它会返回一个 0 而不是引发一个 KeyError：

>>> c = Counter(['eggs', 'ham'])
>>> c['bacon']                              # count of a missing element is zero
0

设置一个计数为0不会从计数器中移去一个元素。使用 del 来删除它:

>>> c['sausage'] = 0                        # counter entry with a zero count
>>> del c['sausage']                        # del actually removes the entry

3.1 新版功能.

在 3.7 版更改: 作为 dict 的子类，Counter 继承了记住插入顺序的功能。Counter 对象间的数学运算也是保序的。结果首先把左操作数中存在的元素按照它们在左操作数中的顺序排序，后面跟着其它元素，按它们在右操作数中的顺序排序。

Counter 对象在对所有字典可用的方法以外还支持一些附加方法:

elements()

返回一个迭代器，其中每个元素将重复出现计数值所指定次。 元素会按首次出现的顺序返回。 如果一个元素的计数值小于一，elements() 将会忽略它。

>>> c = Counter(a=4, b=2, c=0, d=-2)
>>> sorted(c.elements())
['a', 'a', 'a', 'a', 'b', 'b']

most_common([n])

返回一个列表，其中包含 n 个最常见的元素及出现次数，按常见程度由高到低排序。 如果 n 被省略或为 None，most_common() 将返回计数器中的 所有 元素。 计数值相等的元素按首次出现的顺序排序：

>>> Counter('abracadabra').most_common(3)
[('a', 5), ('b', 2), ('r', 2)]

subtract([iterable-or-mapping])

减去一个 可迭代对象 或 映射对象 (或 counter) 中的元素。类似于 dict.update() 但是是减去而非替换。输入和输出都可以是 0 或负数。

>>> 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})

3.2 新版功能.

total()

计算总计数值。

>>> c = Counter(a=10, b=5, c=0)
>>> c.total()
15

3.10 新版功能.

通常字典方法都可用于 Counter 对象，除了有两个方法工作方式与字典并不相同。

fromkeys(iterable)

这个类方法没有在 Counter 中实现。

update([iterable-or-mapping])

加上一个 可迭代对象 或 映射对象 (或 counter) 中的元素。类似于 dict.update() 但是是加上而非替换。另外，可迭代对象 应当是一个元素序列，而不是一个 (key, value) 对的序列。

计数对象支持相等性、子集和超集关系等富比较运算符: ==, !=, <, <=, >, >=。 所有这些检测会将不存在的元素当作计数值为零，因此 Counter(a=1) == Counter(a=1, b=0) 将返回真值。

3.10 新版功能: 增加了富比较运算。

在 3.10 版更改: 在相等性检测中，不存在的元素会被当作计数值为零。 在此之前，Counter(a=3) 和 Counter(a=3, b=0) 会被视为不同。

Counter 对象的常用案例

c.total()                       # total of all counts
c.clear()                       # reset all counts
list(c)                         # list unique elements
set(c)                          # convert to a set
dict(c)                         # convert to a regular dictionary
c.items()                       # convert to a list of (elem, cnt) pairs
Counter(dict(list_of_pairs))    # convert from a list of (elem, cnt) pairs
c.most_common()[:-n-1:-1]       # n least common elements
+c                              # remove zero and negative counts

提供了几种数学运算用来合并 Counter 对象，产生多集（所有计数值均大于零的 counter）。加减运算通过增加或减少两者间对应元素的计数来合并 counter。交并运算返回对应计数的最小值和最大值。相等和包含运算比较对应的计数。每个运算的参数都可以含有有符号的计数，但输出将排除计数小于等于零的元素。

>>> c = Counter(a=3, b=1)
>>> d = Counter(a=1, b=2)
>>> c + d                       # add two counters together:  c[x] + d[x]
Counter({'a': 4, 'b': 3})
>>> c - d                       # subtract (keeping only positive counts)
Counter({'a': 2})
>>> c & d                       # intersection:  min(c[x], d[x])
Counter({'a': 1, 'b': 1})
>>> c | d                       # union:  max(c[x], d[x])
Counter({'a': 3, 'b': 2})
>>> c == d                      # equality:  c[x] == d[x]
False
>>> c <= d                      # inclusion:  c[x] <= d[x]
False

单目加和减（一元操作符）意思是从空计数器加或者减去。

>>> c = Counter(a=2, b=-4)
>>> +c
Counter({'a': 2})
>>> -c
Counter({'b': 4})

3.3 新版功能: 添加了对一元加，一元减和位置集合操作的支持。

注解

计数器主要是为了表达运行的正的计数而设计；但是，小心不要预先排除负数或者其他类型。为了帮助这些用例，这一节记录了最小范围和类型限制。

Counter 类是一个字典的子类，不限制键和值。值用于表示计数，但你实际上 可以 存储任何其他值。

most_common() 方法在值需要排序的时候用。

参与原地操作如 c[key] += 1 的值的类型只需要支持加和减，所以分数、小数和 decimals 都可以用，也支持负数。update() 和 subtract() 当然也一样，输入和输出都支持 0 和 负数。

多集方法是专为只会遇到正值的使用情况设计的。输入可以是 0 或负数，但只输出计数为正的值。没有类型限制，但值的类型需支持加、减和比较操作。

elements() 方法要求正整数计数。忽略0和负数计数。

参见

Bag class [https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html] 在 Smalltalk。

Wikipedia 链接 Multisets [https://en.wikipedia.org/wiki/Multiset].

C++ multisets [http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm] 教程和例子。

数学操作和多集合用例，参考 Knuth, Donald. The Art of Computer Programming Volume II, Section 4.6.3, Exercise 19 。

在给定数量和集合元素枚举所有不同的多集合，参考 itertools.combinations_with_replacement()

map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC

deque 对象

class collections.deque([iterable[, maxlen]])

返回一个新的双向队列对象，从左到右初始化(用方法 append()) ，从 iterable （迭代对象) 数据创建。如果 iterable 没有指定，新队列为空。

Deque队列是由栈或者queue队列生成的（发音是 “deck”，”double-ended queue”的简称）。Deque 支持线程安全，内存高效添加(append)和弹出(pop)，从两端都可以，两个方向的大概开销都是 O(1) 复杂度。

虽然 list 对象也支持类似的操作，但它们优化的是定长操作，而 pop(0) 和 insert(0, v) 将改变底层数据的大小和位置，引起 O(n) 的内存移动开销。

如果 maxlen 没有指定或者是 None ，deques 可以增长到任意长度。否则，deque就限定到指定最大长度。一旦限定长度的deque满了，当新项加入时，同样数量的项就从另一端弹出。限定长度deque提供类似Unix filter tail 的功能。它们同样可以用与追踪最近的交换和其他数据池活动。

双向队列(deque)对象支持以下方法：

append(x)

添加 x 到右端。

appendleft(x)

添加 x 到左端。

clear()

移除所有元素，使其长度为0.

copy()

创建一份浅拷贝。

3.5 新版功能.

count(x)

计算 deque 中元素等于 x 的个数。

3.2 新版功能.

extend(iterable)

扩展deque的右侧，通过添加iterable参数中的元素。

extendleft(iterable)

扩展deque的左侧，通过添加iterable参数中的元素。注意，左添加时，在结果中iterable参数中的顺序将被反过来添加。

index(x[, start[, stop]])

返回 x 在 deque 中的位置（在索引 start 之后，索引 stop 之前）。 返回第一个匹配项，如果未找到则引发 ValueError。

3.5 新版功能.

insert(i, x)

在位置 i 插入 x 。

如果插入会导致一个限长 deque 超出长度 maxlen 的话，就引发一个 IndexError。

3.5 新版功能.

pop()

移去并且返回一个元素，deque 最右侧的那一个。 如果没有元素的话，就引发一个 IndexError。

popleft()

移去并且返回一个元素，deque 最左侧的那一个。 如果没有元素的话，就引发 IndexError。

remove(value)

移除找到的第一个 value。 如果没有的话就引发 ValueError。

reverse()

将deque逆序排列。返回 None 。

3.2 新版功能.

rotate(n=1)

向右循环移动 n 步。 如果 n 是负数，就向左循环。

如果deque不是空的，向右循环移动一步就等价于 d.appendleft(d.pop()) ， 向左循环一步就等价于 d.append(d.popleft()) 。

Deque对象同样提供了一个只读属性:

maxlen

Deque的最大尺寸，如果没有限定的话就是 None 。

3.1 新版功能.

除了以上操作，deque 还支持迭代、封存、len(d)、reversed(d)、copy.copy(d)、copy.deepcopy(d)、成员检测运算符 in 以及下标引用例如通过 d[0] 访问首个元素等。 索引访问在两端的复杂度均为 O(1) 但在中间则会低至 O(n)。 如需快速随机访问，请改用列表。

Deque从版本3.5开始支持 __add__(), __mul__(), 和 __imul__() 。

示例:

>>> from collections import deque
>>> d = deque('ghi')                 # make a new deque with three items
>>> for elem in d:                   # iterate over the deque's elements
...     print(elem.upper())
G
H
I

>>> d.append('j')                    # add a new entry to the right side
>>> d.appendleft('f')                # add a new entry to the left side
>>> d                                # show the representation of the deque
deque(['f', 'g', 'h', 'i', 'j'])

>>> d.pop()                          # return and remove the rightmost item
'j'
>>> d.popleft()                      # return and remove the leftmost item
'f'
>>> list(d)                          # list the contents of the deque
['g', 'h', 'i']
>>> d[0]                             # peek at leftmost item
'g'
>>> d[-1]                            # peek at rightmost item
'i'

>>> list(reversed(d))                # list the contents of a deque in reverse
['i', 'h', 'g']
>>> 'h' in d                         # search the deque
True
>>> d.extend('jkl')                  # add multiple elements at once
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])
>>> d.rotate(1)                      # right rotation
>>> d
deque(['l', 'g', 'h', 'i', 'j', 'k'])
>>> d.rotate(-1)                     # left rotation
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])

>>> deque(reversed(d))               # make a new deque in reverse order
deque(['l', 'k', 'j', 'i', 'h', 'g'])
>>> d.clear()                        # empty the deque
>>> d.pop()                          # cannot pop from an empty deque
Traceback (most recent call last):
    File "<pyshell#6>", line 1, in -toplevel-
        d.pop()
IndexError: pop from an empty deque

>>> d.extendleft('abc')              # extendleft() reverses the input order
>>> d
deque(['c', 'b', 'a'])

deque 用法

这一节展示了deque的多种用法。

限长deque提供了类似Unix tail 过滤功能

def tail(filename, n=10):
    'Return the last n lines of a file'
    with open(filename) as f:
        return deque(f, n)

另一个用法是维护一个近期添加元素的序列，通过从右边添加和从左边弹出

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

一个 轮询调度器 [https://en.wikipedia.org/wiki/Round-robin_scheduling] 可以通过在 deque 中放入迭代器来实现。值从当前迭代器的位置0被取出并暂存(yield)。 如果这个迭代器消耗完毕，就用 popleft() 将其从对列中移去；否则，就通过 rotate() 将它移到队列的末尾

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:
            # Remove an exhausted iterator.
            iterators.popleft()

rotate() 方法提供了一种方式来实现 deque 切片和删除。 例如， 一个纯的Python del d[n] 实现依赖于 rotate() 来定位要弹出的元素

def delete_nth(d, n):
    d.rotate(-n)
    d.popleft()
    d.rotate(n)

要实现 deque 切片， 使用一个类似的方法，应用 rotate() 将目标元素放到左边。通过 popleft() 移去老的条目（entries），通过 extend() 添加新的条目， 然后反向 rotate。这个方法可以最小代价实现命令式的栈操作，诸如 dup, drop, swap, over, pick, rot, 和 roll 。

defaultdict 对象

class collections.defaultdict(default_factory=None, /[, ...])

返回一个新的类似字典的对象。 defaultdict 是内置 dict 类的子类。 它重写了一个方法并添加了一个可写的实例变量。 其余的功能与 dict 类相同因而不在此文档中写明。

本对象包含一个名为 default_factory 的属性，构造时，第一个参数用于为该属性提供初始值，默认为 None。所有其他参数（包括关键字参数）都相当于传递给 dict 的构造函数。

defaultdict 对象除了支持标准 dict 的操作，还支持以下方法作为扩展：

__missing__(key)

如果 default_factory 属性为 None，则调用本方法会抛出 KeyError 异常，附带参数 key。

如果 default_factory 不为 None，则它会被（不带参数地）调用来为 key 提供一个默认值，这个值和 key 作为一对键值对被插入到字典中，并作为本方法的返回值返回。

如果调用 default_factory 时抛出了异常，这个异常会原封不动地向外层传递。

在无法找到所需键值时，本方法会被 dict 中的 __getitem__() 方法调用。无论本方法返回了值还是抛出了异常，都会被 __getitem__() 传递。

注意，__missing__() 不会 被 __getitem__() 以外的其他方法调用。意味着 get() 会像正常的 dict 那样返回 None，而不是使用 default_factory。

defaultdict 对象支持以下实例变量：

default_factory

本属性由 __missing__() 方法来调用。如果构造对象时提供了第一个参数，则本属性会被初始化成那个参数，如果未提供第一个参数，则本属性为 None。

在 3.9 版更改: 增加了合并 (|) 与更新 (|=) 运算符，相关说明见 PEP 584 [https://www.python.org/dev/peps/pep-0584]。

defaultdict 例子

使用 list 作为 default_factory，很轻松地将（键-值对组成的）序列转换为（键-列表组成的）字典：

>>> 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])]

当每个键第一次遇见时，它还没有在字典里面，所以自动创建该条目，即调用 default_factory 方法，返回一个空的 list。 list.append() 操作添加值到这个新的列表里。当再次存取该键时，就正常操作，list.append() 添加另一个值到列表中。这个计数比它的等价方法 dict.setdefault() 要快速和简单：

>>> d = {}
>>> for k, v in s:
...     d.setdefault(k, []).append(v)
...
>>> sorted(d.items())
[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]

设置 default_factory 为 int，使 defaultdict 用于计数（类似其他语言中的 bag 或 multiset）：

>>> s = 'mississippi'
>>> d = defaultdict(int)
>>> for k in s:
...     d[k] += 1
...
>>> sorted(d.items())
[('i', 4), ('m', 1), ('p', 2), ('s', 4)]

当一个字母首次遇到时，它会查询失败，则 default_factory 会调用 int() 来提供一个整数 0 作为默认值。后续的自增操作建立起对每个字母的计数。

函数 int() 总是返回 0，这是常数函数的特殊情况。一个更快和灵活的方法是使用 lambda 函数，可以提供任何常量值（不只是0）：

>>> 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>'

设置 default_factory 为 set 使 defaultdict 用于构建 set 集合：

>>> 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})]

namedtuple() 命名元组的工厂函数

命名元组赋予每个位置一个含义，提供可读性和自文档性。它们可以用于任何普通元组，并添加了通过名字获取值的能力，通过索引值也是可以的。

collections.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)

返回一个新的元组子类，名为 typename 。这个新的子类用于创建类元组的对象，可以通过字段名来获取属性值，同样也可以通过索引和迭代获取值。子类实例同样有文档字符串（类名和字段名）另外一个有用的 __repr__() 方法，以 name=value 格式列明了元组内容。

field_names 是一个像 [‘x’, ‘y’] 一样的字符串序列。另外 field_names 可以是一个纯字符串，用空白或逗号分隔开元素名，比如 'x y' 或者 'x, y' 。

任何有效的Python 标识符都可以作为字段名，除了下划线开头的那些。有效标识符由字母，数字，下划线组成，但首字母不能是数字或下划线，另外不能是关键词 keyword 比如 class, for, return, global, pass, 或 raise 。

如果 rename 为真， 无效字段名会自动转换成位置名。比如 ['abc', 'def', 'ghi', 'abc'] 转换成 ['abc', '_1', 'ghi', '_3'] ， 消除关键词 def 和重复字段名 abc 。

defaults 可以为 None 或者是一个默认值的 iterable 。如果一个默认值域必须跟其他没有默认值的域在一起出现，defaults 就应用到最右边的参数。比如如果域名 ['x', 'y', 'z'] 和默认值 (1, 2) ，那么 x 就必须指定一个参数值 ，y 默认值 1 ， z 默认值 2 。

如果 module 值有定义，命名元组的 __module__ 属性值就被设置。

具名元组实例毋需字典来保存每个实例的不同属性，所以它们轻量，占用的内存和普通元组一样。

要支持封存操作，应当将命名元组类赋值给一个匹配 typename 的变量。

在 3.1 版更改: 添加了对 rename 的支持。

在 3.6 版更改: verbose 和 rename 参数成为 仅限关键字参数.

在 3.6 版更改: 添加了 module 参数。

在 3.7 版更改: 移除了 verbose 形参和 _source 属性。

在 3.7 版更改: 添加了 defaults 参数和 _field_defaults 属性。

>>> # Basic example
>>> Point = namedtuple('Point', ['x', 'y'])
>>> p = Point(11, y=22)     # instantiate with positional or keyword arguments
>>> p[0] + p[1]             # indexable like the plain tuple (11, 22)
33
>>> x, y = p                # unpack like a regular tuple
>>> x, y
(11, 22)
>>> p.x + p.y               # fields also accessible by name
33
>>> p                       # readable __repr__ with a name=value style
Point(x=11, y=22)

命名元组尤其有用于赋值 csv sqlite3 模块返回的元组

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)

除了继承元组的方法，命名元组还支持三个额外的方法和两个属性。为了防止字段名冲突，方法和属性以下划线开始。

classmethod somenamedtuple._make(iterable)

类方法从存在的序列或迭代实例创建一个新实例。

>>> t = [11, 22]
>>> Point._make(t)
Point(x=11, y=22)

somenamedtuple._asdict()

返回一个新的 dict ，它将字段名称映射到它们对应的值：

>>> p = Point(x=11, y=22)
>>> p._asdict()
{'x': 11, 'y': 22}

在 3.1 版更改: 返回一个 OrderedDict 而不是 dict 。

在 3.8 版更改: 返回一个常规 dict 而不是 OrderedDict。 因为自 Python 3.7 起，常规字典已经保证有序。 如果需要 OrderedDict 的额外特性，推荐的解决方案是将结果转换为需要的类型: OrderedDict(nt._asdict())。

somenamedtuple._replace(**kwargs)

返回一个新的命名元组实例，并将指定域替换为新的值

>>> 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())

somenamedtuple._fields

字符串元组列出了字段名。用于提醒和从现有元组创建一个新的命名元组类型。

>>> p._fields            # view the field names
('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)

somenamedtuple._field_defaults

字典将字段名称映射到默认值。

>>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
>>> Account._field_defaults
{'balance': 0}
>>> Account('premium')
Account(type='premium', balance=0)

要获取这个名字域的值，使用 getattr() 函数 :

>>> getattr(p, 'x')
11

转换一个字典到命名元组，使用 ** 两星操作符 (所述如 解包实参列表):

>>> d = {'x': 11, 'y': 22}
>>> Point(**d)
Point(x=11, y=22)

因为一个命名元组是一个正常的Python类，它可以很容易的通过子类更改功能。这里是如何添加一个计算域和定宽输出打印格式:

>>> 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

上面的子类设置 __slots__ 为一个空元组。通过阻止创建实例字典保持了较低的内存开销。

子类化对于添加和存储新的名字域是无效的。应当通过 _fields 创建一个新的命名元组来实现它:

>>> Point3D = namedtuple('Point3D', Point._fields + ('z',))

文档字符串可以自定义，通过直接赋值给 __doc__ 属性:

>>> 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'

在 3.5 版更改: 文档字符串属性变成可写。

参见

请参阅 typing.NamedTuple ，以获取为命名元组添加类型提示的方法。 它还使用 class 关键字提供了一种优雅的符号:

class Component(NamedTuple):
    part_number: int
    weight: float
    description: Optional[str] = None

对于以字典为底层的可变域名， 参考 types.SimpleNamespace() 。

dataclasses 模块提供了一个装饰器和一些函数，用于自动将生成的特殊方法添加到用户定义的类中。

OrderedDict 对象

有序词典就像常规词典一样，但有一些与排序操作相关的额外功能。由于内置的 dict 类获得了记住插入顺序的能力（在 Python 3.7 中保证了这种新行为），它们变得不那么重要了。

一些与 dict 的不同仍然存在：

常规的 dict 被设计为非常擅长映射操作。 跟踪插入顺序是次要的。

OrderedDict 旨在擅长重新排序操作。 空间效率、迭代速度和更新操作的性能是次要的。

OrderedDict 算法能比 dict 更好地处理频繁的重排序操作。 如下面的例程所示，这使得它更适用于实现各种 LRU 缓存。

对于 OrderedDict ，相等操作检查匹配顺序。

常规的 dict 可以使用 p == q and all(k1 == k2 for k1, k2 in zip(p, q)) 进行模拟顺序相等性测试。

OrderedDict 类的 popitem() 方法有不同的签名。它接受一个可选参数来指定弹出哪个元素。

常规的 dict 可以使用 d.popitem() 模拟 OrderedDict 的 od.popitem(last=True)，其保证会返回最右边（最后）的项。

常规的 dict 可以通过 (k := next(iter(d)), d.pop(k)) 来模拟 OrderedDict 的 od.popitem(last=False)，它将返回并移除最左边（开头）的条目，如果条目存在的话。

OrderedDict 类有一个 move_to_end() 方法，可以有效地将元素移动到任一端。

常规的 dict 可以通过 d[k] = d.pop(k) 来模拟 OrderedDict 的 od.move_to_end(k, last=True)，它将把键及其所关联的值移到最右边（末尾）的位置。

常规的 dict 没有 OrderedDict 的 od.move_to_end(k, last=False) 的高效等价物，它会把键及其所关联的值移到最左边（开头）的位置。

Python 3.8之前， dict 缺少 __reversed__() 方法。

class collections.OrderedDict([items])

返回一个 dict 子类的实例，它具有专门用于重新排列字典顺序的方法。

3.1 新版功能.

popitem(last=True)

有序字典的 popitem() 方法移除并返回一个 (key, value) 键值对。 如果 last 值为真，则按 LIFO 后进先出的顺序返回键值对，否则就按 FIFO 先进先出的顺序返回键值对。

move_to_end(key, last=True)

将一个现有的 key 移到序字典的任一端。 如果 last 为真值（默认）则将条目移到右端，或者如果 last 为假值则将条目移到开头。 如果 key 不存在则会引发 KeyError:

>>> d = OrderedDict.fromkeys('abcde')
>>> d.move_to_end('b')
>>> ''.join(d)
'acdeb'
>>> d.move_to_end('b', last=False)
>>> ''.join(d)
'bacde'

3.2 新版功能.

相对于通常的映射方法，有序字典还另外提供了逆序迭代的支持，通过 reversed() 。

OrderedDict 之间的相等测试是顺序敏感的，实现为 list(od1.items())==list(od2.items()) 。 OrderedDict 对象和其他的 Mapping 的相等测试，是顺序敏感的字典测试。这允许 OrderedDict 替换为任何字典可以使用的场所。

在 3.5 版更改: OrderedDict 的项(item)，键(key)和值(value) 视图 现在支持逆序迭代，通过 reversed() 。

在 3.6 版更改: PEP 468 [https://www.python.org/dev/peps/pep-0468] 赞成将关键词参数的顺序保留， 通过传递给 OrderedDict 构造器和它的 update() 方法。

在 3.9 版更改: 增加了合并 (|) 与更新 (|=) 运算符，相关说明见 PEP 584 [https://www.python.org/dev/peps/pep-0584]。

OrderedDict 例子和用法

创建记住键值 最后 插入顺序的有序字典变体很简单。 如果新条目覆盖现有条目，则原始插入位置将更改并移至末尾:

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)

一个 OrderedDict 对于实现 functools.lru_cache() 的变体也很有用:

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(0)
        return result

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  # max number of uncached requests
        self.maxsize = maxsize          # max number of stored return values
        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(0)
        else:
            self.requests.pop(args, None)
            self.cache[args] = result
            if len(self.cache) > self.maxsize:
                self.cache.popitem(0)
        return result

UserDict 对象

UserDict 类是用作字典对象的外包装。对这个类的需求已部分由直接创建 dict 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的字典可以作为属性来访问。

class collections.UserDict([initialdata])

模拟字典的类。 这个实例的内容保存在一个常规字典中，它可以通过 UserDict 实例的 data 属性来访问。 如果提供了 initialdata，则 data 会用其内容来初始化；请注意对 initialdata 的引用将不会被保留，以允许它被用于其他目的。

UserDict 实例提供了以下属性作为扩展方法和操作的支持:

data

一个真实的字典，用于保存 UserDict 类的内容。

UserList 对象

这个类封装了列表对象。它是一个有用的基础类，对于你想自定义的类似列表的类，可以继承和覆盖现有的方法，也可以添加新的方法。这样我们可以对列表添加新的行为。

对这个类的需求已部分由直接创建 list 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的列表可以作为属性来访问。

class collections.UserList([list])

模拟一个列表。这个实例的内容被保存为一个正常列表，通过 UserList 的 data 属性存取。实例内容被初始化为一个 list 的copy，默认为 [] 空列表。 list 可以是迭代对象，比如一个Python列表，或者一个 UserList 对象。

UserList 提供了以下属性作为可变序列的方法和操作的扩展:

data

一个 list 对象用于存储 UserList 的内容。

子类化的要求: UserList 的子类需要提供一个构造器，可以无参数调用，或者一个参数调用。返回一个新序列的列表操作需要创建一个实现类的实例。它假定了构造器可以以一个参数进行调用，这个参数是一个序列对象，作为数据源。

如果一个分离的类不希望依照这个需求，所有的特殊方法就必须重写；请参照源代码进行修改。

UserString 对象

UserString 类是用作字符串对象的外包装。对这个类的需求已部分由直接创建 str 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的字符串可以作为属性来访问。

class collections.UserString(seq)

模拟一个字符串对象。这个实例对象的内容保存为一个正常字符串，通过 UserString 的 data 属性存取。实例内容初始化设置为 seq 的copy。seq 参数可以是任何可通过内建 str() 函数转换为字符串的对象。

UserString 提供了以下属性作为字符串方法和操作的额外支持：

data

一个真正的 str 对象用来存放 UserString 类的内容。

在 3.5 版更改: 新方法 __getnewargs__, __rmod__, casefold, format_map, isprintable, 和 maketrans。

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

3.3 新版功能: 该模块曾是 collections 模块的组成部分。

源代码： Lib/_collections_abc.py [https://github.com/python/cpython/tree/3.10/Lib/_collections_abc.py]

本模块提供了一些 抽象基类，它们可用于测试一个类是否提供某个特定的接口；例如，它是否为 hashable 或是否为映射等。

一个接口的 issubclass() 或 isinstance() 测试采用以下三种方式之一。

1) A newly written class can inherit directly from one of the abstract base classes. The class must supply the required abstract methods. The remaining mixin methods come from inheritance and can be overridden if desired. Other methods may be added as needed:

class C(Sequence):                      # Direct inheritance
    def __init__(self): ...             # Extra method not required by the ABC
    def __getitem__(self, index):  ...  # Required abstract method
    def __len__(self):  ...             # Required abstract method
    def count(self, value): ...         # Optionally override a mixin method

>>> issubclass(C, Sequence)
True
>>> isinstance(C(), Sequence)
True

2) Existing classes and built-in classes can be registered as "virtual subclasses" of the ABCs. Those classes should define the full API including all of the abstract methods and all of the mixin methods. This lets users rely on issubclass() or isinstance() tests to determine whether the full interface is supported. The exception to this rule is for methods that are automatically inferred from the rest of the API:

class D:                                 # No inheritance
    def __init__(self): ...              # Extra method not required by the ABC
    def __getitem__(self, index):  ...   # Abstract method
    def __len__(self):  ...              # Abstract method
    def count(self, value): ...          # Mixin method
    def index(self, value): ...          # Mixin method

Sequence.register(D)                     # Register instead of inherit

>>> issubclass(D, Sequence)
True
>>> isinstance(D(), Sequence)
True

在这个例子中，D 类不需要定义 __contains__, __iter__ 和 __reversed__ 因为 in 运算符, the 迭代 逻辑和 reversed() 函数会自动回退为使用 __getitem__ 和 __len__。

3) Some simple interfaces are directly recognizable by the presence of the required methods (unless those methods have been set to None):

class E:
    def __iter__(self): ...
    def __next__(next): ...

>>> issubclass(E, Iterable)
True
>>> isinstance(E(), Iterable)
True

复杂的接口不支持最后这种技术手段因为接口并不只是作为方法名称存在。 接口指明了方法之间的语义和关系，这些是无法根据特定方法名称的存在推断出来的。 例如，知道一个类提供了 __getitem__, __len__ 和 __iter__ 并不足以区分 Sequence 和 Mapping。

3.9 新版功能: 这些抽象类现在都支持 []。 参见 GenericAlias 类型 和 PEP 585 [https://www.python.org/dev/peps/pep-0585]。

容器抽象基类

这个容器模块提供了以下 ABCs:

抽象基类 | 继承自 | 抽象方法 | Mixin 方法
Container 1 |  | __contains__ |
Hashable 1 |  | __hash__ |
Iterable 1 2 |  | __iter__ |
Iterator 1 | Iterable | __next__ | __iter__
Reversible 1 | Iterable | __reversed__ |
Generator 1 | Iterator | send, throw | close, __iter__, __next__
Sized 1 |  | __len__ |
Callable 1 |  | __call__ |
Collection 1 | Sized, Iterable, Container | __contains__, __iter__, __len__ |
Sequence | Reversible, Collection | __getitem__, __len__ | __contains__, __iter__, __reversed__, index, and count
MutableSequence | Sequence | __getitem__, __setitem__, __delitem__, __len__, insert | 继承自 Sequence 的方法，以及 append, reverse, extend, pop, remove，和 __iadd__
ByteString | Sequence | __getitem__, __len__ | 继承自 Sequence 的方法
Set | Collection | __contains__, __iter__, __len__ | __le__, __lt__, __eq__, __ne__, __gt__, __ge__, __and__, __or__, __sub__, __xor__, and isdisjoint
MutableSet | Set | __contains__, __iter__, __len__, add, discard | 继承自 Set 的方法以及 clear, pop, remove, __ior__, __iand__, __ixor__，和 __isub__
Mapping | Collection | __getitem__, __iter__, __len__ | __contains__, keys, items, values, get, __eq__, and __ne__
MutableMapping | Mapping | __getitem__, __setitem__, __delitem__, __iter__, __len__ | 继承自 Mapping 的方法以及 pop, popitem, clear, update，和 setdefault
MappingView | Sized |  | __len__
ItemsView | MappingView, Set |  | __contains__, __iter__
KeysView | MappingView, Set |  | __contains__, __iter__
ValuesView | MappingView, Collection |  | __contains__, __iter__
Awaitable 1 |  | __await__ |
Coroutine 1 | Awaitable | send, throw | close
AsyncIterable 1 |  | __aiter__ |
AsyncIterator 1 | AsyncIterable | __anext__ | __aiter__
AsyncGenerator 1 | AsyncIterator | asend, athrow | aclose, __aiter__, __anext__

备注

1(1,2,3,4,5,6,7,8,9,10,11,12,13,14)

这些 ABC 重载了 object.__subclasshook__() 以便支持通过验证所需的方法是否存在并且没有被设为 None 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或直接子类化。

2

检查 isinstance(obj, Iterable) 是否侦测到被注册为 Iterable 或者具有 __iter__() 方法的类，但它不能侦测到使用 __getitem__() 方法进行迭代的类。 确定一个对象是否为 iterable 的唯一可靠方式是调用 iter(obj)。

多项集抽象基类 -- 详细描述

class collections.abc.Container

提供了 __contains__() 方法的抽象基类。

class collections.abc.Hashable

提供了 __hash__() 方法的抽象基类。

class collections.abc.Sized

提供了 __len__() 方法的抽象基类。

class collections.abc.Callable

提供了 __call__() 方法的抽象基类。

class collections.abc.Iterable

提供了 __iter__() 方法的抽象基类。

使用 isinstance(obj, Iterable) 可以检测一个类是否已经注册到了 Iterable 或者实现了 __iter__() 函数，但是无法检测这个类是否能够使用 __getitem__() 方法进行迭代。检测一个对象是否是 iterable 的唯一可信赖的方法是调用 iter(obj)。

class collections.abc.Collection

集合了 Sized 和 Iterable 类的抽象基类。

3.6 新版功能.

class collections.abc.Iterator

提供了 __iter__() 和 __next__() 方法的抽象基类。参见 iterator 的定义。

class collections.abc.Reversible

为可迭代类提供了 __reversed__() 方法的抽象基类。

3.6 新版功能.

class collections.abc.Generator

生成器类，实现了 PEP 342 [https://www.python.org/dev/peps/pep-0342] 中定义的协议，继承并扩展了迭代器，提供了 send(), throw() 和 close() 方法。参见 generator 的定义。

3.5 新版功能.

class collections.abc.Sequence

class collections.abc.MutableSequence

class collections.abc.ByteString

只读的与可变的 序列 的抽象基类。

实现笔记：一些混入（Maxin）方法比如 __iter__(), __reversed__() 和 index() 会重复调用底层的 __getitem__() 方法。因此，如果实现的 __getitem__() 是常数级访问速度，那么相应的混入方法会有一个线性的表现；然而，如果底层方法是线性实现（例如链表），那么混入方法将会是平方级的表现，这也许就需要被重构了。

在 3.5 版更改: index() 方法支持 stop 和 start 参数。

class collections.abc.Set

class collections.abc.MutableSet

只读的与可变的集合的抽象基类。

class collections.abc.Mapping

class collections.abc.MutableMapping

只读的与可变的 映射 的抽象基类。

class collections.abc.MappingView

class collections.abc.ItemsView

class collections.abc.KeysView

class collections.abc.ValuesView

映射及其键和值的 视图 的抽象基类。

class collections.abc.Awaitable

为可等待对象 awaitable 提供的类，可以被用于 await 表达式中。习惯上必须实现 __await__() 方法。

协程 对象和 Coroutine ABC 的实例都是这个 ABC 的实例。

注解

在 CPython 里，基于生成器的协程（使用 types.coroutine() 或 asyncio.coroutine() 包装的生成器）都是 可等待对象，即使他们不含有 __await__() 方法。使用 isinstance(gencoro, Awaitable) 来检测他们会返回 False。要使用 inspect.isawaitable() 来检测他们。

3.5 新版功能.

class collections.abc.Coroutine

用于协程兼容类的抽象基类。实现了如下定义在 协程对象: 里的方法： send()，throw() 和 close()。通常的实现里还需要实现 __await__() 方法。所有的 Coroutine 实例都必须是 Awaitable 实例。参见 coroutine 的定义。

注解

在 CPython 里，基于生成器的协程（使用 types.coroutine() 或 asyncio.coroutine() 包装的生成器）都是 可等待对象，即使他们不含有 __await__() 方法。使用 isinstance(gencoro, Coroutine) 来检测他们会返回 False。要使用 inspect.isawaitable() 来检测他们。

3.5 新版功能.

class collections.abc.AsyncIterable

提供了 __aiter__ 方法的抽象基类。参见 asynchronous iterable 的定义。

3.5 新版功能.

class collections.abc.AsyncIterator

提供了 __aiter__ 和 __anext__ 方法的抽象基类。参见 asynchronous iterator 的定义。

3.5 新版功能.

class collections.abc.AsyncGenerator

为异步生成器类提供的抽象基类，这些类实现了定义在 PEP 525 [https://www.python.org/dev/peps/pep-0525] 和 PEP 492 [https://www.python.org/dev/peps/pep-0492] 里的协议。

3.6 新版功能.

例子和配方

ABC 允许我们询问类或实例是否提供特定的功能，例如:

size = None
if isinstance(myvar, collections.abc.Sized):
    size = len(myvar)

有些抽象基类也可以用作混入类（mixin），这可以更容易地开发支持容器 API 的类。例如，要写一个支持完整 Set API 的类，只需要提供下面这三个方法： __contains__(), __iter__() 和 __len__()。抽象基类会补充上其余的方法，比如 __and__() 和 isdisjoint():

class ListBasedSet(collections.abc.Set):
    ''' Alternate set implementation favoring space over speed
        and not requiring the set elements to be hashable. '''
    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            # The __and__() method is supported automatically

当把 Set 和 MutableSet 用作混入类时需注意：

由于某些集合操作会创建新集合，默认的混入方法需要一种从可迭代对象里创建新实例的方式。 假定类构造器具有 ClassName(iterable) 形式的签名。 这样它将执行一个名为 _from_iterable() 的内部类方法，该方法会调用 cls(iterable) 来产生一个新集合。 如果 Set 混入类在具有不同构造器签名的类中被使用，你将需要通过类方法或常规方法来重载 _from_iterable()，以便基于可迭代对象参数来构造新的实例。

重载比较符时时（想必是为了速度，因为其语义都是固定的），只需要重定义 __le__() 和 __ge__() 函数，然后其他的操作会自动跟进。

Set 混入类提供了一个 _hash() 方法为集合计算哈希值；但是，没有定义 __hash__() 因为并非所有集合都是 hashable 或不可变对象。 要使用混入类为集合添加哈希能力，可以同时继承 Set() 和 Hashable()，然后定义 __hash__ = Set._hash。

参见

OrderedSet recipe [https://code.activestate.com/recipes/576694/] 是基于 MutableSet 构建的一个示例。

对于抽象基类，参见 abc 模块和 PEP 3119 [https://www.python.org/dev/peps/pep-3119]。

heapq --- 堆队列算法

源码：Lib/heapq.py [https://github.com/python/cpython/tree/3.10/Lib/heapq.py]

这个模块实现了堆队列算法，即优先队列算法。

堆是一棵完全二叉树，其中每个节点的值都小于等于其各个子节点的值。这个使用数组的实现，索引从 0 开始，且对所有的 k 都有 heap[k] <= heap[2*k+1] 和 heap[k] <= heap[2*k+2]。比较时不存在的元素被认为是无限大。堆最有趣的特性在于最小的元素总是在根结点：heap[0]。

这个API与教材的堆算法实现有所不同，具体区别有两方面：（a）我们使用了从零开始的索引。这使得节点和其孩子节点索引之间的关系不太直观但更加适合，因为 Python 使用从零开始的索引。 （b）我们的 pop 方法返回最小的项而不是最大的项（这在教材中称为“最小堆”；而“最大堆”在教材中更为常见，因为它更适用于原地排序）。

基于这两方面，把堆看作原生的Python list也没什么奇怪的： heap[0] 表示最小的元素，同时 heap.sort() 维护了堆的不变性！

要创建一个堆，可以新建一个空列表 []，或者用函数 heapify() 把一个非空列表变为堆。

定义了以下函数：

heapq.heappush(heap, item)

将 item 的值加入 heap 中，保持堆的不变性。

heapq.heappop(heap)

弹出并返回 heap 的最小的元素，保持堆的不变性。如果堆为空，抛出 IndexError 。使用 heap[0] ，可以只访问最小的元素而不弹出它。

heapq.heappushpop(heap, item)

将 item 放入堆中，然后弹出并返回 heap 的最小元素。该组合操作比先调用 heappush() 再调用 heappop() 运行起来更有效率。

heapq.heapify(x)

将list x 转换成堆，原地，线性时间内。

heapq.heapreplace(heap, item)

弹出并返回 heap 中最小的一项，同时推入新的 item。 堆的大小不变。 如果堆为空则引发 IndexError。

这个单步骤操作比 heappop() 加 heappush() 更高效，并且在使用固定大小的堆时更为适宜。 pop/push 组合总是会从堆中返回一个元素并将其替换为 item。

返回的值可能会比新加入的值大。如果不希望如此，可改用 heappushpop()。它的 push/pop 组合返回两个值中较小的一个，将较大的留在堆中。

该模块还提供了三个基于堆的通用目的函数。

heapq.merge(*iterables, key=None, reverse=False)

将多个已排序的输入合并为一个已排序的输出（例如，合并来自多个日志文件的带时间戳的条目）。 返回已排序值的 iterator。

类似于 sorted(itertools.chain(*iterables)) 但返回一个可迭代对象，不会一次性地将数据全部放入内存，并假定每个输入流都是已排序的（从小到大）。

具有两个可选参数，它们都必须指定为关键字参数。

key 指定带有单个参数的 key function，用于从每个输入元素中提取比较键。 默认值为 None (直接比较元素)。

reverse 为一个布尔值。 如果设为 True，则输入元素将按比较结果逆序进行合并。 要达成与 sorted(itertools.chain(*iterables), reverse=True) 类似的行为，所有可迭代对象必须是已从大到小排序的。

在 3.5 版更改: 添加了可选的 key 和 reverse 形参。

heapq.nlargest(n, iterable, key=None)

从 iterable 所定义的数据集中返回前 n 个最大元素组成的列表。 如果提供了 key 则其应指定一个单参数的函数，用于从 iterable 的每个元素中提取比较键 (例如 key=str.lower)。 等价于: sorted(iterable, key=key, reverse=True)[:n]。

heapq.nsmallest(n, iterable, key=None)

从 iterable 所定义的数据集中返回前 n 个最小元素组成的列表。 如果提供了 key 则其应指定一个单参数的函数，用于从 iterable 的每个元素中提取比较键 (例如 key=str.lower)。 等价于: sorted(iterable, key=key)[:n]。

后两个函数在 n 值较小时性能最好。 对于更大的值，使用 sorted() 函数会更有效率。 此外，当 n==1 时，使用内置的 min() 和 max() 函数会更有效率。 如果需要重复使用这些函数，请考虑将可迭代对象转为真正的堆。

基本示例

堆排序 [https://en.wikipedia.org/wiki/Heapsort] 可以通过将所有值推入堆中然后每次弹出一个最小值项来实现。

>>> 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]

这类似于 sorted(iterable)，但与 sorted() 不同的是这个实现是不稳定的。

堆元素可以为元组。这有利于以下做法——在被跟踪的主记录旁边添一个额外的值（例如任务的优先级）用于互相比较：

>>> 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')

优先队列实现说明

优先队列 [https://en.wikipedia.org/wiki/Priority_queue] 是堆的常用场合，并且它的实现包含了多个挑战：

排序稳定性：如何让两个相同优先级的任务按它们最初被加入队列的顺序返回？

如果 priority 相同且 task 之间未定义默认比较顺序，则两个 (priority, task) 元组之间的比较会报错。

如果任务优先级发生改变，你该如何将其移至堆中的新位置？

或者如果一个挂起的任务需要被删除，你该如何找到它并将其移出队列？

针对前两项挑战的一种解决方案是将条目保存为包含优先级、条目计数和任务对象 3 个元素的列表。 条目计数可用来打破平局，这样具有相同优先级的任务将按它们的添加顺序返回。 并且由于没有哪两个条目计数是相同的，元组比较将永远不会直接比较两个任务。

两个 task 之间不可比的问题的另一种解决方案是——创建一个忽略 task，只比较 priority 字段的包装器类：

from dataclasses import dataclass, field
from typing import Any

@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)

其余的挑战主要包括找到挂起的任务并修改其优先级或将其完全移除。 找到一个任务可使用一个指向队列中条目的字典来实现。

移除条目或改变其优先级的操作实现起来更为困难，因为它会破坏堆结构不变量。 因此，一种可能的解决方案是将条目标记为已移除，再添加一个改变了优先级的新条目:

pq = []                         # list of entries arranged in a heap
entry_finder = {}               # mapping of tasks to entries
REMOVED = '<removed-task>'      # placeholder for a removed task
counter = itertools.count()     # unique sequence count

def add_task(task, priority=0):
    'Add a new task or update the priority of an existing task'
    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):
    'Mark an existing task as REMOVED.  Raise KeyError if not found.'
    entry = entry_finder.pop(task)
    entry[-1] = REMOVED

def pop_task():
    'Remove and return the lowest priority task. Raise KeyError if empty.'
    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')

理论

堆是通过数组来实现的，其中的元素从 0 开始计数，对于所有的 k 都有 a[k] <= a[2*k+1] 且 a[k] <= a[2*k+2]。 为了便于比较，不存在的元素被视为无穷大。 堆最有趣的特性在于 a[0] 总是其中最小的元素。

上面的特殊不变量是用来作为一场锦标赛的高效内存表示。 下面的数字是 k 而不是 a[k]:

                               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

在上面的树中，每个 k 单元都位于 2*k+1 和 2*k+2 之上。 体育运动中我们经常见到二元锦标赛模式，每个胜者单元都位于另两个单元之上，并且我们可以沿着树形图向下追溯胜者所遇到的所有对手。 但是，在许多采用这种锦标赛模式的计算机应用程序中，我们并不需要追溯胜者的历史。 为了获得更高的内存利用效率，当一个胜者晋级时，我们会用较低层级的另一条目来替代它，因此规则变为一个单元和它之下的两个单元包含三个不同条目，上方单元“胜过”了两个下方单元。

如果此堆的不变性质始终受到保护，则序号 0 显然是总的赢家。 删除它并找出“下一个”赢家的最简单算法方式是将某个输家（让我们假定是上图中的 30 号单元）移至 0 号位置，然后将这个新的 0 号沿树下行，不断进行值的交换，直到不变性质得到重建。 这显然会是树中条目总数的对数。 通过迭代所有条目，你将得到一个 O(n log n) 复杂度的排序。

此排序有一个很好的特性就是你可以在排序进行期间高效地插入新条目，前提是插入的条目不比你最近取出的 0 号元素“更好”。 这在模拟上下文时特别有用，在这种情况下树保存的是所有传入事件，“胜出”条件是最小调度时间。 当一个事件将其他事件排入执行计划时，它们的调试时间向未来方向延长，这样它们可方便地入堆。 因此，堆结构很适宜用来实现调度器，我的 MIDI 音序器就是用的这个 :-)。

用于实现调度器的各种结构都得到了充分的研究，堆是非常适宜的一种，因为它们的速度相当快，并且几乎是恒定的，最坏的情况与平均情况没有太大差别。 虽然还存在其他总体而言更高效的实现方式，但其最坏的情况却可能非常糟糕。

堆在大磁盘排序中也非常有用。 你应该已经了解大规模排序会有多个“运行轮次”（即预排序的序列，其大小通常与 CPU 内存容量相关），随后这些轮次会进入合并通道，轮次合并的组织往往非常巧妙 1。 非常重要的一点是初始排序应产生尽可能长的运行轮次。 锦标赛模式是达成此目标的好办法。 如果你使用全部有用内存来进行锦标赛，替换和安排恰好适合当前运行轮次的条目，你将可以对于随机输入生成两倍于内存大小的运行轮次，对于模糊排序的输入还会有更好的效果。

另外，如果你输出磁盘上的第 0 个条目并获得一个可能不适合当前锦标赛的输入（因为其值要“胜过”上一个输出值），它无法被放入堆中，因此堆的尺寸将缩小。 被释放的内存可以被巧妙地立即重用以逐步构建第二个堆，其增长速度与第一个堆的缩减速度正好相同。 当第一个堆完全消失时，你可以切换新堆并启动新的运行轮次。 这样做既聪明又高效！

总之，堆是值得了解的有用内存结构。 我在一些应用中用到了它们，并且认为保留一个 'heap' 模块是很有意义的。 :-)

备注

1

当前时代的磁盘平衡算法与其说是巧妙，不如说是麻烦，这是由磁盘的寻址能力导致的结果。 在无法寻址的设备例如大型磁带机上，情况则相当不同，开发者必须非常聪明地（极为提前地）确保每次磁带转动都尽可能地高效（就是说能够最好地加入到合并“进程”中）。 有些磁带甚至能够反向读取，这也被用来避免倒带的耗时。 请相信我，真正优秀的磁带机排序看起来是极其壮观的，排序从来都是一门伟大的艺术！ :-)

bisect --- 数组二分查找算法

源代码： Lib/bisect.py [https://github.com/python/cpython/tree/3.10/Lib/bisect.py]

这个模块对有序列表提供了支持，使得他们可以在插入新数据仍然保持有序。对于长列表，如果其包含元素的比较操作十分昂贵的话，这可以是对更常见方法的改进。这个模块叫做 bisect 因为其使用了基本的二分（bisection）算法。源代码也可以作为很棒的算法示例（边界判断也做好啦！）

定义了以下函数：

bisect.bisect_left(a, x, lo=0, hi=len(a), *, key=None)

在 a 中找到 x 合适的插入点以维持有序。参数 lo 和 hi 可以被用于确定需要考虑的子集；默认情况下整个列表都会被使用。如果 x 已经在 a 里存在，那么插入点会在已存在元素之前（也就是左边）。如果 a 是列表（list）的话，返回值是可以被放在 list.insert() 的第一个参数的。

返回的插入点 i 将数组 a 分成两半，使得 all(val < x for val in a[lo : i]) 在左半边而 all(val >= x for val in a[i : hi]) 在右半边。

key 指定带有单个参数的 key function 用来从数组的每个元素中提取比较键。 为了支持搜索复杂记录，键函数不会被应用到 x 值。

如果 key 为 None，则将直接进行元素比较而不需要中间的函数调用。

在 3.10 版更改: 增加了 key 形参。

bisect.bisect_right(a, x, lo=0, hi=len(a), *, key=None)

bisect.bisect(a, x, lo=0, hi=len(a), *, key=None)

类似于 bisect_left()，但是返回的插入点是 a 中已存在元素 x 的右侧。

返回的插入点 i 将数组 a 分成两半，使得左半边为 all(val <= x for val in a[lo : i]) 而右半边为 all(val > x for val in a[i : hi])。

key 指定带有单个参数的 key function 用来从数组的每个元素中提取比较键。 为了支持搜索复杂记录，键函数不会被应用到 x 值。

如果 key 为 None，则将直接进行元素比较而不需要中间的函数调用。

在 3.10 版更改: 增加了 key 形参。

bisect.insort_left(a, x, lo=0, hi=len(a), *, key=None)

按照已排序顺序将 x 插入到 a 中。

此函数首先会运行 bisect_left() 来定位一个插入点。 然后，它会在 a 上运行 insert() 方法在正确的位置插入 x 以保持排序顺序。

为了支持将记录插入到表中，key 函数（如果存在）将被应用到 x 用于搜索步骤但不会用于插入步骤。

请记住 O(log n) 搜索是由缓慢的 O(n) 抛入步骤主导的。

在 3.10 版更改: 增加了 key 形参。

bisect.insort_right(a, x, lo=0, hi=len(a), *, key=None)

bisect.insort(a, x, lo=0, hi=len(a), *, key=None)

类似于 insort_left()，但是把 x 插入到 a 中已存在元素 x 的右侧。

此函数首先会运行 bisect_right() 来定位一个插入点。 然后，它会在 a 上运行 insert() 方法在正确的位置插入 x 以保持排序顺序。

为了支持将记录插入到表中，key 函数（如果存在）将被应用到 x 用于搜索步骤但不会用于插入步骤。

请记住 O(log n) 搜索是由缓慢的 O(n) 抛入步骤主导的。

在 3.10 版更改: 增加了 key 形参。

性能说明

当使用 bisect() 和 insort() 编写时间敏感的代码时，请记住以下概念。

二分法对于搜索一定范围的值是很高效的。 对于定位特定的值，则字典的性能更好。

insort() 函数的时间复杂度为 O(n) 因为对数时间的搜索步骤被线性时间的插入步骤所主导。

这些搜索函数都是无状态的并且会在它们被使用后丢弃键函数的结果。 因此，如果在一个循环中使用搜索函数，则键函数可能会在同一个数据元素上被反复调用。 如果键函数速度不快，请考虑用 functools.cache() 来包装它以避免重复计算。 另外，也可以考虑搜索一个预先计算好的键数组来定位插入点（如下面的示例节所演示的）。

参见

Sorted Collections [https://grantjenks.com/docs/sortedcollections/] 是一个使用 bisect 来管理数据的已排序多项集的高性能模块。

SortedCollection recipe [https://code.activestate.com/recipes/577197-sortedcollection/] 使用 bisect 构建了一个功能完整的多项集类，拥有直观的搜索方法和对键函数的支持。 所有键函数都 是预先计算好的以避免在搜索期间对键函数的不必要的调用。

搜索有序列表

上面的 bisect() 函数对于找到插入点是有用的，但在一般的搜索任务中可能会有点尴尬。下面 5 个函数展示了如何将其转变成有序列表中的标准查找函数

def index(a, x):
    'Locate the leftmost value exactly equal to x'
    i = bisect_left(a, x)
    if i != len(a) and a[i] == x:
        return i
    raise ValueError

def find_lt(a, x):
    'Find rightmost value less than x'
    i = bisect_left(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_le(a, x):
    'Find rightmost value less than or equal to x'
    i = bisect_right(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_gt(a, x):
    'Find leftmost value greater than x'
    i = bisect_right(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

def find_ge(a, x):
    'Find leftmost item greater than or equal to x'
    i = bisect_left(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

例子

函数 bisect() 还可以用于数字表查询。这个例子是使用 bisect() 从一个给定的考试成绩集合里，通过一个有序数字表，查出其对应的字母等级：90 分及以上是 'A'，80 到 89 是 'B'，以此类推

>>> def grade(score, breakpoints=[60, 70, 80, 90], grades='FDCBA'):
...     i = bisect(breakpoints, score)
...     return grades[i]
...
>>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]]
['F', 'A', 'C', 'C', 'B', 'A', 'A']

bisect() 和 insort() 函数也适用于列表和元组。 key 参数可被用来提取在表中为记录排序所使用的字段:

>>> 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, 'Speilberg'),
...     Movie('Titanic', 1997, 'Cameron'),
...     Movie('The Birds', 1963, 'Hitchcock'),
...     Movie('Aliens', 1986, 'Scott')
... ]

>>> # Find the first movie released after 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')

>>> # Insert a movie while maintaining sort order
>>> 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='Speilberg'),
 Movie(name='Aliens', released=1986, director='Scott'),
 Movie(name='Titanic', released=1997, director='Cameron')]

如果键函数较为消耗资源，可以通过搜索一个预先计算的键列表来查找记录的索引以避免重复的函数调用:

>>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
>>> data.sort(key=lambda r: r[1])       # Or use operator.itemgetter(1).
>>> keys = [r[1] for r in data]         # Precompute a list of keys.
>>> 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)

array --- 高效的数字数组

此模块定义了一种对象类型，可以紧凑地表示由基本值（字符、整数、浮点数）组成的数组。数组是序列类型，其行为与列表非常相似，不同之处在于其中存储的对象类型是受限的，在数组对象创建时用单个字符的 类型码 来指定。已定义的类型码如下：

类型码 | C 类型 | Python 类型 | 最小字节数 | 备注
'b' | signed char | int | 1 |
'B' | unsigned char | int | 1 |
'u' | wchar_t | Unicode 字符 | 2 | (1)
'h' | signed short | int | 2 |
'H' | unsigned short | int | 2 |
'i' | signed int | int | 2 |
'I' | unsigned int | int | 2 |
'l' | signed long | int | 4 |
'L' | unsigned long | int | 4 |
'q' | signed long long | int | 8 |
'Q' | unsigned long long | int | 8 |
'f' | float | float | 4 |
'd' | double | float | 8 |

注释：

可能为 16 位或 32 位，取决于具体的平台。

在 3.9 版更改: array('u') 现在使用 作为C类型，而不是被废弃的 Py_UNICODE 。这一变化并不影响它的行为，因为从Python 3.3开始， Py_UNICODE 就是 wchar_t 的别名。

Deprecated since version 3.3, will be removed in version 4.0.

值的实际表示是由机器架构（严格说是由 C 实现）决定的。实际大小可以通过 array.itemsize 属性来访问。

此模块定义了以下项目：

array.typecodes

一个由所有可用的类型码组成的字符串。

此模块定义了以下类型：

class array.array(typecode[, initializer])

一个由 typecode 限定类型的新数组，可由可选的 initializer 初始化。initializer 必须为一个列表、bytes-like object 或在合适类型元素上迭代的可迭代对象。

如果是一个列表或字符串，该 initializer 会被传给新数组的 fromlist()，frombytes() 或 fromunicode() 方法（见下）以将初始项添加到数组中。其它将可迭代对象将被传给 extend() 方法。

数组对象支持普通的序列操作如索引、切片、拼接和重复等。当使用切片赋值时，所赋的值必须为具有相同类型码的数组对象；所有其他情况都将引发 TypeError。数组对象也实现了缓冲区接口，可以用于所有支持 类字节对象 的场合。

引发一个 审计事件 array.__new__ 并附带参数 typecode, initializer。

typecode

在创建数组时使用的类型码字符。

itemsize

内部表示中，单个数组项的长度。单位为字节。

append(x)

添加一个值为 x 的新项到数组末尾。

buffer_info()

返回一个元组 (address, length) 给出存放数组内容的内存缓冲区的当前地址和长度（以元素个数为单位）。以字节为单位的的内存缓冲区大小可通过 array.buffer_info()[1] * array.itemsize 来计算。工作在需要内存地址的底层（因此天然地不够安全）的 I/O 接口上时，这有时会有用，例如某些 ioctl() 操作。只要数组还存在，并且没有对其应用过改变长度的操作，则返回的数值就是有效的。

注解

只有在使用以 C 或 C++ 编写的代码中的数组对象时，才能有效利用该信息，但此时，更合理的是，使用数组对象支持的缓冲区接口。因此，该方法的存在仅仅是为了向后兼容性，应避免在新代码中使用。缓冲区接口的文档参见 缓冲协议。

byteswap()

“字节对调”所有数组项。此方法只支持大小为 1, 2, 4 或 8 字节的值；对于其它类型的值将引发 RuntimeError。当要从另一种字节顺序的机器生成的文件中读取数据时，它很有用。

count(x)

返回 x 在数组中的出现次数。

extend(iterable)

将来自 iterable 的项添加到数组末尾。如果 iterable 是另一个数组，它必须具有 完全 相同的类型码；否则将引发 TypeError。如果 iterable 不是一个数组，则它必须为可迭代对象且其元素的类型须为可添加到数组的适当类型。

frombytes(s)

将来自字节串的项添加到数组末尾，字节串被视为由机器值组成的数组（就像用 fromfile() 方法从文件中读取数据一样）。

3.2 新版功能: fromstring() 被重命名为含义更准确的 frombytes()。

fromfile(f, n)

从 file object f 中读取 n 项（视为机器值）并将它们添加到数组末尾。如果可用的项少于 n 项，则会引发 EOFError，但可用的项仍然会被加进数组。

fromlist(list)

将来自列表的项添加到数组末尾。等价于 for x in list: a.append(x)，而不同之处在于，若发生类型错误，数组则不会被改变。

fromunicode(s)

将来自 Unicode 字符串的项添加到数组末尾。数组必须是类型为 'u' 的数组；否则将引发 ValueError。请用 array.frombytes(unicodestring.encode(enc)) 来将 Unicode 数据添加到其它类型的数组。

index(x[, start[, stop]])

返回以这样的方式找到的最小的 i：i 为数组中第一个 x 的下标。可选参数 start 和 stop 用于在数组的一个指定的子段中搜索 x。如果未找到 x 则会引发 ValueError。

在 3.10 版更改: 添加了可选的 start 和 stop 形参。

insert(i, x)

在数组的位置 i 之前插入一个值为 x 的新项。负值被视为相对于数组末尾的位置。

pop([i])

从数组中移除下标为 i 的项并将其返回。参数默认值为 -1，因此默认移除并返回末项。

remove(x)

从数组中移除第一个出现的 x。

reverse()

反转数组中各项的顺序。

tobytes()

将数组转换为一个由机器值组成的数组并返回其字节表示（和用 tofile() 方法写入文件的字节序列相同）。

3.2 新版功能: tostring() 被重命名为含义更准确的 tobytes()。

tofile(f)

将所有项（作为机器值）写入 file object f。

tolist()

将数组转换为由相同的项组成的普通列表。

tounicode()

将数组转换为一个 Unicode 字符串。数组必须是类型为 'u' 的数组；否则将引发 ValueError。请用 array.tobytes().decode(enc) 来将其它类型的数组转换为 Unicode 字符串。

数组对象被打印或转换为字符串时，会被表示为 array(typecode, initializer)。initializer 在数组为空时会被省略，在数组的 typecode 为 'u' 时是一个字符串，其它时候是一个数字列表。只要 array 类已用 from array import array 引入，该字符串保证能被 eval() 转换回具有相同类型和值的数组。例：

array('l')
array('u', 'hello \u2641')
array('l', [1, 2, 3, 4, 5])
array('d', [1.0, 2.0, 3.14])

参见

struct 模块

打包和解包异构二进制数据。

xdrlib 模块

对某些远程过程调用系统中使用的外部数据表示（XDR）数据进行打包和解包 。

NumPy [https://numpy.org/]

NumPy 包定义了另一数组类型。

weakref --- 弱引用

源代码： Lib/weakref.py [https://github.com/python/cpython/tree/3.10/Lib/weakref.py]

weakref 模块允许 Python 程序员创建对象的 弱引用 。

在下文中，术语 所指对象 表示弱引用所指向的对象。

对象的弱引用不能保证对象存活：当所指对像的引用只剩弱引用时， 垃圾回收 可以销毁所指对象，并将其内存重新用于其它用途。但是，在实际销毁对象之前，即使没有强引用，弱引用也能返回该对象。

弱引用的一个主要用途是实现一个存储大型对象的缓存或映射，但又不希望该大型对象仅因为它只出现在这个缓存或映射中而保持存活。

例如，如果你有许多大型二进制图像对象，你可能希望为每个对象关联一个名称。如果你使用 Python 字典来将名称映射到图像，或将图像映射到名称，那么图像对象将因为它们在字典中作为值或键而保持存活。 weakref 模块提供的 WeakKeyDictionary 和 WeakValueDictionary 类可以替代 Python 字典，它们使用弱引用来构造映射，这种映射不会仅因为对象出现在映射中而使对象保持存活。例如，如果一个图像对象是 WeakValueDictionary 中的值，那么当对该图像对象的剩余引用是弱映射对象所持有的弱引用时，垃圾回收器将回收该对象，并删除弱映射对象中相应的条目。

WeakKeyDictionary 和 WeakValueDictionary 在它们的实现中使用了弱引用，并在弱引用上设置当键或值被垃圾回收器回收时通知弱字典的回调函数。 WeakSet 实现了 set 接口，但像 WeakKeyDictionary 一样，只持有其元素的弱引用。

finalize 提供了一种直接的方法来注册当对象被垃圾收集时要调用的清理函数。这比在普通的弱引用上设置回调函数的方式更简单，因为模块会自动确保对象被回收前终结器一直保持存活。

这些弱容器类型之一或者 finalize 就是大多数程序所需要的——通常不需要直接创建自己的弱引用。weakref 模块暴露了底层机制，以便用于高级用途。

并非所有对象都可以被弱引用；可以被弱引用的对象包括类实例，用 Python（而不是用 C）编写的函数，实例方法、集合、冻结集合，某些 文件对象，生成器，类型对象，套接字，数组，双端队列，正则表达式模式对象以及代码对象等。

在 3.2 版更改: 添加了对 thread.lock，threading.Lock 和代码对象的支持。

一些内置类型，如 list 和 dict，不直接支持弱引用，但可以通过子类化添加支持:

class Dict(dict):
    pass

obj = Dict(red=1, green=2, blue=3)   # this object is weak referenceable

CPython 实现细节： 其他内置类型，如 tuple 和 int，不支持弱引用，即使通过子类化也不支持。

可以轻松地使扩展类型支持弱引用；参见 弱引用支持。

当为某个给定类型定义了 __slots__ 时，弱引用支持会被禁用，除非将 '__weakref__' 字符串也加入到 __slots__ 声明的字符串序列中。 请参阅 __slots__ 文档 了解详情。

class weakref.ref(object[, callback])

返回 object 的弱引用。如果所指对象存活，则可以通过调用引用对象来获取原始对象；如果所指对象不存在，则调用引用对象将得到 None 。如果提供了值不是 None 的 callback，并且返回的弱引用对象仍然存活，则在对象即将终结时将调用回调函数；弱引用对象将作为回调函数的唯一参数传递；然后所指对象将不再可用。

允许为同一个对象的构造多个弱引用。每个弱引用注册的回调函数将按从最近注册的回调函数，到最早注册的回调函数的顺序调用。

回调所引发的异常将记录于标准错误输出，但无法被传播；它们会按与对象的 __del__() 方法所引发的异常相同的方式被处理。

如果 object 可哈希，则弱引用也 可哈希。即使在 object 被删除之后，弱引用仍将保持其哈希值。如果在 object 被删除之后才首次调用 hash()，则该调用将引发 TypeError。

弱引用支持相等性测试，但不支持排序。如果所指对象仍然存活，两个引用具有与它们的所指对象具有一致的相等关系（无论 callback 是否相同）。如果删除了任一所指对象，则仅在两个引用指向同一对象时，二者才相等。

这是一个可子类化的类型，而非一个工厂函数。

__callback__

这个只读属性会返回当前关联到弱引用的回调函数。 如果回调函数不存在，或弱引用的所指对象已不存在，则此属性的值为 None。

在 3.4 版更改: 添加了 __callback__ 属性。

weakref.proxy(object[, callback])

返回 object 的一个使用弱引用的代理。 此函数支持在大多数上下文中使用代理，而不要求显式地对所使用的弱引用对象解除引用。 返回的对象类型将为 ProxyType 或 CallableProxyType，具体取决于 object 是否可调用。 Proxy 对象不是 hashable 对象，无论被引用对象是否可哈希；这可避免与它们的基本可变性质相关的多种问题，并可防止它们被用作字典键。 callback 与 ref() 函数的同名形参含义相同。

在所指对象被作为垃圾回收后访问代理对象的属性将引发 ReferenceError。

在 3.8 版更改: 扩展代理对象所支持的运算符，包括矩阵乘法运算符 @ 和 @=。

weakref.getweakrefcount(object)

返回指向 object 的弱引用和代理的数量。

weakref.getweakrefs(object)

返回由指向 object 的所有弱引用和代理构成的列表。

class weakref.WeakKeyDictionary([dict])

弱引用键的映射类。当不再存在对键的强引用时，字典中的相关条目将被丢弃。这可用于将额外数据与应用程序中其它部分拥有的对象相关联，而无需向这些对象添加属性。这对于重写了属性访问的对象来说特别有用。

请注意，当把一个与现有键具有相同值（但是标识号不相等）的键插入字典时，它会替换该值，但不会替换现有的键。由于这一点，当删除对原来的键的引用时，也将同时删除字典中的对应条目:

>>> 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 = {}

一种变通做法是在重新赋值之前先移除键:

>>> 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}

在 3.9 版更改: 增加了对 | 和 |= 运算符的支持，相关说明见 PEP 584 [https://www.python.org/dev/peps/pep-0584]。

WeakKeyDictionary 对象具有一个额外方法，可以直接公开内部引用。这些引用不保证在它们被使用时仍然保持“存活”，因此这些引用的调用结果需要在使用前进行检测。 此方法可用于避免创建会导致垃圾回收器将保留键超出实际需要时长的引用。

WeakKeyDictionary.keyrefs()

返回包含对键的弱引用的可迭代对象。

class weakref.WeakValueDictionary([dict])

弱引用值的映射类。当不再存在对该值的强引用时，字典中的条目将被丢弃。

在 3.9 版更改: 增加了对 | 和 |= 运算符的支持，相关说明见 PEP 584 [https://www.python.org/dev/peps/pep-0584]。

WeakValueDictionary 对象具有一个额外方法，此方法存在与 WeakKeyDictionary 对象的 keyrefs() 方法相同的问题。

WeakValueDictionary.valuerefs()

返回包含对值的弱引用的可迭代对象。

class weakref.WeakSet([elements])

保持对其元素弱引用的集合类。当某个元素没有强引用时，该元素将被丢弃。

class weakref.WeakMethod(method)

一个模拟对绑定方法（即在类中定义并在实例中查找的方法）进行弱引用的自定义 ref 子类。 由于绑定方法是临时性的，标准弱引用无法保持它。 WeakMethod 包含特别代码用来重新创建绑定方法，直到对象或初始函数被销毁:

>>> 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()
>>>

3.4 新版功能.

class weakref.finalize(obj, func, /, *args, **kwargs)

返回一个可调用的终结器对象，该对象将在 obj 作为垃圾回收时被调用。与普通的弱引用不同，终结器将总是存活，直到引用对象被回收，这极大地简化了生命周期管理。

终结器总是被视为 存活 直到它被调用（显式调用或在垃圾回收时隐式调用），调用之后它将 死亡。 调用存活的终结器将返回 func(*arg, **kwargs) 的求值结果，而调用死亡的终结器将返回 None。

在垃圾收集期间由终结器回调所引发异常将显示于标准错误输出，但无法被传播。 它们会按与对象的 __del__() 方法或弱引用的回调所引发异常相同的方式被处理。

当程序退出时，剩余的存活终结器会被调用，除非它们的 atexit 属性已被设为假值。 它们会按与创建时相反的顺序被调用。

终结器在 interpreter shutdown 的后期绝不会唤起其回调函数，此时模块全局变量很可能已被替换为 None。

__call__()

如果 self 为存活状态则将其标记为已死亡，并返回调用 func(*args, **kwargs) 的结果。 如果 self 已死亡则返回 None。

detach()

如果 self 为存活状态则将其标记为已死亡，并返回元组 (obj, func, args, kwargs)。 如果 self 已死亡则返 None。

peek()

如果 self 为存活状态则返回元组 (obj, func, args, kwargs)。 如果 self 已死亡则返回 None。

alive

如果终结器为存活状态则该特征属性为真值，否则为假值。

atexit

一个可写的布尔型特征属性，默认为真值。 当程序退出时，它会调用所有 atexit 为真值的剩余存活终结器。 它们会按与创建时相反的顺序被调用。

注解

很重要的一点是确保 func, args 和 kwargs 不拥有任何对 obj 的引用，无论是直接的或是间接的，否则的话 obj 将永远不会被作为垃圾回收。 特别地，func 不应当是 obj 的一个绑定方法。

3.4 新版功能.

weakref.ReferenceType

弱引用对象的类型对象。

weakref.ProxyType

不可调用对象的代理的类型对象。

weakref.CallableProxyType

可调用对象的代理的类型对象。

weakref.ProxyTypes

包含所有代理的类型对象的序列。 这可以用于更方便地检测一个对象是否是代理，而不必依赖于两种代理对象的名称。

参见

PEP 205 [https://www.python.org/dev/peps/pep-0205] - 弱引用

此特性的提议和理由，包括早期实现的链接和其他语言中类似特性的相关信息。

弱引用对象

弱引用对象没有 ref.__callback__ 以外的方法和属性。 一个弱引用对象如果存在，就允许通过调用它来获取引用:

>>> import weakref
>>> class Object:
...     pass
...
>>> o = Object()
>>> r = weakref.ref(o)
>>> o2 = r()
>>> o is o2
True

如果引用已不存在，则调用引用对象将返回 None:

>>> del o, o2
>>> print(r())
None

检测一个弱引用对象是否仍然存在应该使用表达式 ref() is not None。 通常，需要使用引用对象的应用代码应当遵循这样的模式:

# r is a weak reference object
o = r()
if o is None:
    # referent has been garbage collected
    print("Object has been deallocated; can't frobnicate.")
else:
    print("Object is still live!")
    o.do_something_useful()

使用单独的“存活”测试会在多线程应用中制造竞争条件；其他线程可能导致某个弱引用在该弱引用被调用前就失效；上述的写法在多线程应用和单线程应用中都是安全的。

特别版本的 ref 对象可以通过子类化来创建。 在 WeakValueDictionary 的实现中就使用了这种方式来减少映射中每个条目的内存开销。 这对于将附加信息关联到引用的情况最为适用，但也可以被用于在调用中插入额外处理来提取引用。

这个例子演示了如何将 ref 的一个子类用于存储有关对象的附加信息并在引用被访问时影响其所返回的值:

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):
        """Return a pair containing the referent and the number of
        times the reference has been called.
        """
        ob = super().__call__()
        if ob is not None:
            self.__counter += 1
            ob = (ob, self.__counter)
        return ob

示例

这个简单的例子演示了一个应用如何使用对象 ID 来提取之前出现过的对象。 然后对象的 ID 可以在其它数据结构中使用，而无须强制对象保持存活，但处于存活状态的对象也仍然可以通过 ID 来提取。

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]

终结器对象

使用 finalize 的主要好处在于它能更简便地注册回调函数，而无须保留所返回的终结器对象。 例如

>>> 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!

终结器也可以被直接调用。 但是终结器最多只能对回调函数发起一次调用。

>>> 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

你可以使用 detach() 方法来注销一个终结器。 该方法将销毁终结器并返回其被创建时传给构造器的参数。

>>> 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

除非你将 atexit 属性设为 False，否则终结器在程序退出时如果仍然存活就将被调用。 例如

>>> obj = Object()
>>> weakref.finalize(obj, print, "obj dead or exiting")
<finalize object at ...; for 'Object' at ...>
>>> exit()
obj dead or exiting

比较终结器与 __del__() 方法

假设我们想创建一个类，用它的实例来代表临时目录。 当以下事件中的某一个发生时，这个目录应当与其内容一起被删除：

对象被作为垃圾回收，

对象的 remove() 方法被调用，或

程序退出。

我们可以尝试使用 __del__() 方法来实现这个类，如下所示:

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()

从 Python 3.4 开始，__del__() 方法不会再阻止循环引用被作为垃圾回收，并且模块全局变量在 interpreter shutdown 期间不会被强制设为 None。 因此这段代码在 CPython 上应该会正常运行而不会出现任何问题。

然而，__del__() 方法的处理会严重地受到具体实现的影响，因为它依赖于解释器垃圾回收实现方式的内部细节。

更健壮的替代方式可以是定义一个终结器，只引用它所需要的特定函数和对象，而不是获取对整个对象状态的访问权:

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

像这样定义后，我们的终结器将只接受一个对其完成正确清理目录任务所需细节的引用。 如果对象一直未被作为垃圾回收，终结器仍会在退出时被调用。

基于弱引用的终结器还具有另一项优势，就是它们可被用来为定义由第三方控制的类注册终结器，例如当一个模块被卸载时运行特定代码:

import weakref, sys
def unloading_module():
    # implicit reference to the module globals from the function body
weakref.finalize(sys.modules[__name__], unloading_module)

注解

如果当程序退出时你恰好在守护线程中创建终结器对象，则有可能该终结器不会在退出时被调用。 但是，在一个守护线程中 atexit.register(), try: ... finally: ... 和 with: ... 同样不能保证执行清理。

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

源代码: Lib/types.py [https://github.com/python/cpython/tree/3.10/Lib/types.py]

此模块定义了一些工具函数，用于协助动态创建新的类型。

它还为某些对象类型定义了名称，这些名称由标准 Python 解释器所使用，但并不像内置的 int 或 str 那样对外公开。

最后，它还额外提供了一些类型相关但重要程度不足以作为内置对象的工具类和函数。

动态类型创建

types.new_class(name, bases=(), kwds=None, exec_body=None)

使用适当的元类动态地创建一个类对象。

前三个参数是组成类定义头的部件：类名称，基类 (有序排列)，关键字参数 (例如 metaclass)。

exec_body 参数是一个回调函数，用于填充新创建类的命名空间。 它应当接受类命名空间作为其唯一的参数并使用类内容直接更新命名空间。 如果未提供回调函数，则它就等效于传入 lambda ns: None。

3.3 新版功能.

types.prepare_class(name, bases=(), kwds=None)

计算适当的元类并创建类命名空间。

参数是组成类定义头的部件：类名称，基类 (有序排列) 以及关键字参数 (例如 metaclass)。

返回值是一个 3 元组: metaclass, namespace, kwds

metaclass 是适当的元类，namespace 是预备好的类命名空间而 kwds 是所传入 kwds 参数移除每个 'metaclass' 条目后的已更新副本。 如果未传入 kwds 参数，这将为一个空字典。

3.3 新版功能.

在 3.6 版更改: 所返回元组中 namespace 元素的默认值已被改变。 现在当元类没有 __prepare__ 方法时将会使用一个保留插入顺序的映射。

参见

元类

这些函数所支持的类创建过程的完整细节

PEP 3115 [https://www.python.org/dev/peps/pep-3115] - Python 3000 中的元类

引入 __prepare__ 命名空间钩子

types.resolve_bases(bases)

动态地解析 MRO 条目，具体描述见 PEP 560 [https://www.python.org/dev/peps/pep-0560]。

此函数会在 bases 中查找不是 type 的实例的项，并返回一个元组，其中每个具有 __mro_entries__ 方法的此种对象对象将被替换为调用该方法解包后的结果。 如果一个 bases 项是 type 的实例，或它不具有 __mro_entries__ 方法，则它将不加改变地被包含在返回的元组中。

3.7 新版功能.

参见

PEP 560 [https://www.python.org/dev/peps/pep-0560] - 对 typing 模块和泛型类型的核心支持

标准解释器类型

此模块为许多类型提供了实现 Python 解释器所要求的名称。 它刻意地避免了包含某些仅在处理过程中偶然出现的类型，例如 listiterator 类型。

此种名称的典型应用如 isinstance() 或 issubclass() 检测。

如果你要实例化这些类型中的任何一种，请注意其签名在不同 Python 版本之间可能出现变化。

以下类型有相应的标准名称定义：

types.NoneType

None 的类型。

3.10 新版功能.

types.FunctionType

types.LambdaType

用户自定义函数以及由 lambda 表达式所创建函数的类型。

引发一个 审计事件 function.__new__ 并附带参数 code。

此审计事件只会被函数对象的直接实例化引发，而不会被普通编译所引发。

types.GeneratorType

generator 迭代器对象的类型，由生成器函数创建。

types.CoroutineType

coroutine 对象的类型，由 async def 函数创建。

3.5 新版功能.

types.AsyncGeneratorType

asynchronous generator 迭代器对象的类型，由异步生成器函数创建。

3.6 新版功能.

class types.CodeType(**kwargs)

代码对象的类型，例如 compile() 的返回值。

引发一个 审计事件 code.__new__ 并附带参数 code, filename, name, argcount, posonlyargcount, kwonlyargcount, nlocals, stacksize, flags。

请注意被审计的参数可能与初始化代码所要求的名称或位置不相匹配。 审计事件只会被代码对象的直接实例化引发，而不会被普通编译所引发。

replace(**kwargs)

返回代码对象的一个副本，使用指定的新字段值。

3.8 新版功能.

types.CellType

单元对象的类型：这种对象被用作函数中自由变量的容器。

3.8 新版功能.

types.MethodType

用户自定义类实例方法的类型。

types.BuiltinFunctionType

types.BuiltinMethodType

内置函数例如 len() 或 sys.exit() 以及内置类方法的类型。 （这里所说的“内置”是指“以 C 语言编写”。）

types.WrapperDescriptorType

某些内置数据类型和基类的方法的类型，例如 object.__init__() 或 object.__lt__()。

3.7 新版功能.

types.MethodWrapperType

某些内置数据类型和基类的 绑定 方法的类型。 例如 object().__str__ 所属的类型。

3.7 新版功能.

types.NotImplementedType

NotImplemented 的类型。

3.10 新版功能.

types.MethodDescriptorType

某些内置数据类型方法例如 str.join() 的类型。

3.7 新版功能.

types.ClassMethodDescriptorType

某些内置数据类型 非绑定 类方法例如 dict.__dict__['fromkeys'] 的类型。

3.7 新版功能.

class types.ModuleType(name, doc=None)

模块 的类型。 构造器接受待创建模块的名称并以其 docstring 作为可选参数。

注解

如果你希望设置各种由导入控制的属性，请使用 importlib.util.module_from_spec() 来创建一个新模块。

__doc__

模块的 docstring。 默认为 None。

__loader__

用于加载模块的 loader。 默认为 None。

此属性会匹配保存在 __spec__ object 对象中的 importlib.machinery.ModuleSpec.loader。

注解

未来的 Python 版本可能会停止默认设置此属性。 为了避免这个潜在变化的影响，如果你明确地需要使用此属性则推荐改从 __spec__ 属性读取或是使用 getattr(module, "__loader__", None)。

在 3.4 版更改: 默认为 None。 之前该属性为可选项。

__name__

模块的名称。 应当能匹配 importlib.machinery.ModuleSpec.name。

__package__

一个模块所属的 package。 如果模块为最高层级的（即不是任何特定包的组成部分）则该属性应设为 ''，否则它应设为特定包的名称 (如果模块本身也是一个包则名称可以为 __name__)。 默认为 None。

此属性会匹配保存在 __spec__ 对象中的 importlib.machinery.ModuleSpec.parent。

注解

未来的 Python 版本可能停止默认设置此属性。 为了避免这个潜在变化的影响，如果你明确地需要使用此属性则推荐改从 __spec__ 属性读取或是使用 getattr(module, "__package__", None)。

在 3.4 版更改: 默认为 None。 之前该属性为可选项。

__spec__

模块的导入系统相关状态的记录。 应当是一个 importlib.machinery.ModuleSpec 的实例。

3.4 新版功能.

types.EllipsisType

Ellipsis 的类型。

3.10 新版功能.

class types.GenericAlias(t_origin, t_args)

形参化泛型 的类型，例如 list[int]。

t_origin 应当是一个非形参化的泛型类，例如 list, tuple 或 dict。 t_args 应当是一个形参化 t_origin 的 tuple (长度可以为 1):

>>> from types import GenericAlias

>>> list[int] == GenericAlias(list, (int,))
True
>>> dict[str, int] == GenericAlias(dict, (str, int))
True

3.9 新版功能.

在 3.9.2 版更改: 此类型现在可以被子类化。

class types.UnionType

合并类型表达式 的类型。

3.10 新版功能.

class types.TracebackType(tb_next, tb_frame, tb_lasti, tb_lineno)

回溯对象的类型，例如 sys.exc_info()[2] 中的对象。

请查看 语言参考 了解可用属性和操作的细节，以及动态地创建回溯对象的指南。

types.FrameType

帧对象的类型，例如 tb.tb_frame 中的对象，其中 tb 是一个回溯对象。

请查看 语言参考 了解可用属性和操作的细节。

types.GetSetDescriptorType

使用 PyGetSetDef 在扩展模块中定义的对象的类型，例如 FrameType.f_locals 或 array.array.typecode。 此类型被用作对象属性的描述器；它的目的与 property 类型相同，但专门针对在扩展模块中定义的类。

types.MemberDescriptorType

使用 PyMemberDef 在扩展模块中定义的对象的类型，例如 datetime.timedelta.days。 此类型被用作使用标准转换函数的简单 C 数据成员的描述器；它的目的与 property 类型相同，但专门针对在扩展模块中定义的类。

CPython 实现细节： 在 Python 的其它实现中，此类型可能与 GetSetDescriptorType 完全相同。

class types.MappingProxyType(mapping)

一个映射的只读代理。 它提供了对映射条目的动态视图，这意味着当映射发生改变时，视图会反映这些改变。

3.3 新版功能.

在 3.9 版更改: 更新为支持 PEP 584 [https://www.python.org/dev/peps/pep-0584] 所新增的合并 (|) 运算符，它会简单地委托给下层的映射。

key in proxy

如果下层的映射中存在键 key 则返回 True，否则返回 False。

proxy[key]

返回下层的映射中以 key 为键的项。 如果下层的映射中不存在键 key 则引发 KeyError。

iter(proxy)

返回由下层映射的键为元素的迭代器。 这是 iter(proxy.keys()) 的快捷方式。

len(proxy)

返回下层映射中的项数。

copy()

返回下层映射的浅拷贝。

get(key[, default])

如果 key 存在于下层映射中则返回 key 的值，否则返回 default。 如果 default 未给出则默认为 None，因而此方法绝不会引发 KeyError。

items()

返回由下层映射的项 ((键, 值) 对) 组成的一个新视图。

keys()

返回由下层映射的键组成的一个新视图。

values()

返回由下层映射的值组成的一个新视图。

reversed(proxy)

返回一个包含下层映射的键的反向迭代器。

3.9 新版功能.

附加工具类和函数

class types.SimpleNamespace

一个简单的 object 子类，提供了访问其命名空间的属性，以及一个有意义的 repr。

不同于 object，对于 SimpleNamespace 你可以添加和移除属性。 如果一个 SimpleNamespace 对象使用关键字参数进行初始化，这些参数会被直接加入下层命名空间。

此类型大致等价于以下代码:

class SimpleNamespace:
    def __init__(self, /, **kwargs):
        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

SimpleNamespace 可被用于替代 class NS: pass。 但是，对于结构化记录类型则应改用 namedtuple()。

3.3 新版功能.

在 3.9 版更改: repr 中的属性顺序由字母顺序改为插入顺序 (类似 dict)。

types.DynamicClassAttribute(fget=None, fset=None, fdel=None, doc=None)

在类上访问 __getattr__ 的路由属性。

这是一个描述器，用于定义通过实例与通过类访问时具有不同行为的属性。 当实例访问时保持正常行为，但当类访问属性时将被路由至类的 __getattr__ 方法；这是通过引发 AttributeError 来完成的。

这允许有在实例上激活的特性属性，同时又有在类上的同名虚拟属性 (一个例子请参见 enum.Enum)。

3.4 新版功能.

协程工具函数

types.coroutine(gen_func)

此函数可将 generator 函数转换为一个返回基于生成器的协程的 coroutine function。 基于生成器的协程仍然属于 generator iterator，但同时又可被视为 coroutine 对象兼 awaitable。 不过，它没有必要实现 __await__() 方法。

如果 gen_func 是一个生成器函数，它将被原地修改。

如果 gen_func 不是一个生成器函数，则它会被包装。 如果它返回一个 collections.abc.Generator 的实例，该实例将被包装在一个 awaitable 代理对象中。 所有其他对象类型将被原样返回。

3.5 新版功能.

copy --- 浅层 (shallow) 和深层 (deep) 复制操作

源代码: Lib/copy.py [https://github.com/python/cpython/tree/3.10/Lib/copy.py]

Python 的赋值语句不复制对象，而是创建目标和对象的绑定关系。对于自身可变，或包含可变项的集合，有时要生成副本用于改变操作，而不必改变原始对象。本模块提供了通用的浅层复制和深层复制操作，（如下所述）。

接口摘要：

copy.copy(x)

返回 x 的浅复制。

copy.deepcopy(x[, memo])

返回 x 的深复制。

exception copy.Error

针对模块特定错误引发。

浅层与深层复制的区别仅与复合对象（即包含列表或类的实例等其他对象的对象）相关：

浅层复制 构造一个新的复合对象，然后（在尽可能的范围内）将原始对象中找到的对象的 引用 插入其中。

深层复制 构造一个新的复合对象，然后，递归地将在原始对象里找到的对象的 副本 插入其中。

深度复制操作通常存在两个问题, 而浅层复制操作并不存在这些问题：

递归对象 (直接或间接包含对自身引用的复合对象) 可能会导致递归循环。

由于深层复制会复制所有内容，因此可能会过多复制（例如本应该在副本之间共享的数据）。

deepcopy() 函数用以下方式避免了这些问题：

保留在当前复制过程中已复制的对象的 "备忘录" （memo） 字典；以及

允许用户定义的类重写复制操作或复制的组件集合。

此模块不会复制模块、方法、栈追踪、栈帧、文件、套接字、窗口以及任何相似的类型。 它会通过不加修改地返回原始对象来（浅层或深层地）“复制”函数和类；这与 pickle 模块处理这类问题的方式是兼容的。

制作字典的浅层复制可以使用 dict.copy() 方法，而制作列表的浅层复制可以通过赋值整个列表的切片完成，例如，copied_list = original_list[:]。

类可以使用与控制序列化（pickling）操作相同的接口来控制复制操作，关于这些方法的描述信息请参考 pickle 模块。实际上，copy 模块使用的正是从 copyreg 模块中注册的 pickle 函数。

为了让一个类定义其自己的复制实现，它可以定义特殊方法 __copy__() 和 __deepcopy__()。 前者用于实现浅复制操作，后者用于实现深复制操作，它接受一个参数，即 memo 字典。 如果 __deepcopy__() 实现需要对某个组件进行深复制，它应该调用 deepcopy() 函数，组件作为第一个参数，memo 字典作为第二个参数。 memo 字典应被视为不透明对象。

参见

模块 pickle

讨论了支持对象状态检索和恢复的特殊方法。

pprint --- 数据美化输出

源代码： Lib/pprint.py [https://github.com/python/cpython/tree/3.10/Lib/pprint.py]

pprint 模块提供了“美化打印”任意 Python 数据结构的功能，这种美化形式可用作对解释器的输入。 如果经格式化的结构包含非基本 Python 类型的对象，则其美化形式可能无法被加载。 包含文件、套接字或类对象，以及许多其他不能用 Python 字面值来表示的对象都有可能导致这样的结果。

格式化后的形式会在可能的情况下以单行来表示对象，并在无法在允许宽度内容纳对象的情况下将其分为多行。 如果你需要调整宽度限制则应显式地构造 PrettyPrinter 对象。

字典在计算其显示形式前会先根据键来排序。

在 3.9 版更改: 添加了对美化打印 types.SimpleNamespace 的支持。

在 3.10 版更改: 添加了对美化打印 dataclasses.dataclass 的支持。

pprint 模块定义了一个类：

class pprint.PrettyPrinter(indent=1, width=80, depth=None, stream=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

构造一个 PrettyPrinter 实例。 这个构造器支持一些关键字形参。

stream (默认为 sys.stdout) 是一个 file-like object，通过调用该对象的 write() 方法可以将输出写入其中。

其他值可用来配置复杂数据结构嵌套要以何种形式被展示。

indent (默认为 1) 指定要为每个缩进层级添加的缩进量。

depth 控制可被打印的缩进层级数量；如果要打印的数据结构层级过深，则其所包含的下一层级将用 ... 替换。 默认情况下，对于被格式化对象的层级深度没有任何限制。

width (默认为 80) 指定输出中每行所允许的最大字符数。 如果一个数据结构无法在宽度限制之内被格式化，将显示尽可能多的内容。

compact 影响长序列（列表、元组、集合等等）的格式化方式。 如果 compact 为假值（默认）则序列的每一项将格式化为单独的行。 如果 compact 为真值，则每个输出行格式化时将在 width 的限制之内尽可能地容纳多个条目。

如果 sort_dicts 为真值（默认），字典在格式化时将基于键进行排序，否则它们将按插入顺序显示。

如果 underscore_numbers 为真值，整数在格式化时将使用 _ 字符作为千位分隔符，否则不显示下划线（默认）。

在 3.4 版更改: 增加了 compact 形参。

在 3.8 版更改: 增加了 sort_dicts 形参。

在 3.10 版更改: 添加了 underscore_numbers 形参。

>>> 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', (...)))))))

pprint 模块还提供了一些快捷函数：

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 将作为格式化形参传递给 PrettyPrinter 构造器。

在 3.4 版更改: 增加了 compact 形参。

在 3.8 版更改: 增加了 sort_dicts 形参。

在 3.10 版更改: 添加了 underscore_numbers 形参。

pprint.pp(object, *args, sort_dicts=False, **kwargs)

打印 object 的格式化表示并附带一个换行符。 如果 sort_dicts 为假值（默认），字典将按键的插入顺序显示，否则将按字典键排序。 args 和 kwargs 将作为格式化形参被传给 pprint()。

3.8 新版功能.

pprint.pprint(object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

将 object 的格式化表示打印至 stream，末尾带一个换行符。 如果 stream 为 None，则使用 sys.stdout。 这可在交互式解释器而非 print() 函数中使用以便对值进行检查（你甚至可以在特定作用域内重赋值 print = pprint.pprint 以方便使用）。 indent, width, depth, compact, sort_dicts 和 underscore_numbers 将作为格式化形参传递给 PrettyPrinter 构造器。

在 3.4 版更改: 增加了 compact 形参。

在 3.8 版更改: 增加了 sort_dicts 形参。

在 3.10 版更改: 添加了 underscore_numbers 形参。

>>> import pprint
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
>>> stuff.insert(0, stuff)
>>> pprint.pprint(stuff)
[<Recursion on list with id=...>,
 'spam',
 'eggs',
 'lumberjack',
 'knights',
 'ni']

pprint.isreadable(object)

确定 object 的格式化表示是否“可读”，或是否可被用来通过 eval() 重新构建对象的值。 此函数对于递归对象总是返回 False。

>>> pprint.isreadable(stuff)
False

pprint.isrecursive(object)

确定 object 是否需要递归表示。

此外还定义了一个支持函数：

pprint.saferepr(object)

返回 object 的字符串表示，并为递归数据结构提供保护。 如果 object 的表示形式公开了一个递归条目，该递归引用会被表示为 <Recursion on typename with id=number>。 该表示因而不会进行其它格式化。

>>> pprint.saferepr(stuff)
"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"

PrettyPrinter 对象

PrettyPrinter 的实例具有下列方法：

PrettyPrinter.pformat(object)

返回 object 格式化表示。 这会将传给 PrettyPrinter 构造器的选项纳入考虑。

PrettyPrinter.pprint(object)

在所配置的流上打印 object 的格式化表示，并附加一个换行符。

下列方法提供了与同名函数相对应的实现。 在实例上使用这些方法效率会更高一些，因为不需要创建新的 PrettyPrinter 对象。

PrettyPrinter.isreadable(object)

确定对象的格式化表示是否“可读”，或者是否可使用 eval() 重建对象值。 请注意此方法对于递归对象将返回 False。 如果设置了 PrettyPrinter 的 depth 形参并且对象深度超出允许范围，此方法将返回 False。

PrettyPrinter.isrecursive(object)

确定对象是否需要递归表示。

此方法作为一个钩子提供，允许子类修改将对象转换为字符串的方式。 默认实现使用 saferepr() 实现的内部方式。

PrettyPrinter.format(object, context, maxlevels, level)

返回三个值：字符串形式的 object 已格式化版本，指明结果是否可读的旗标，以及指明是否检测到递归的旗标。 第一个参数是要表示的对象。 第二个是以对象 id() 为键的字典，这些对象是当前表示上下文的一部分（影响 object 表示的直接和间接容器）；如果需要呈现一个已经在 context 中表示的对象，则第三个返回值应当为 True。 对 format() 方法的递归调用应当将容器的附加条目添加到此字典中。 第三个参数 maxlevels 给出了对递归的请求限制；如果没有请求限制则其值将为 0。 此参数应当不加修改地传给递归调用。 第四个参数 level 给出于当前层级；传给递归调用的参数值应当小于当前调用的值。

示例

为了演示 pprint() 函数及其形参的几种用法，让我们从 PyPI [https://pypi.org] 获取关于某个项目的信息:

>>> import json
>>> import pprint
>>> from urllib.request import urlopen
>>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
...     project_info = json.load(resp)['info']

pprint() 以其基本形式显示了整个对象:

>>> pprint.pprint(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'}

结果可以被限制到特定的 depth (更深层的内容将使用省略号):

>>> pprint.pprint(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'}

此外，还可以设置建议的最大字符 width。 如果一个对象无法被拆分，则将超出指定宽度:

>>> pprint.pprint(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'}

reprlib --- 另一种 repr() 实现

源代码: Lib/reprlib.py [https://github.com/python/cpython/tree/3.10/Lib/reprlib.py]

reprlib 模块提供了一种对象表示的产生方式，它会对结果字符串的大小进行限制。 该方式被用于 Python 调试器，也适用于某些其他场景。

此模块提供了一个类、一个实例和一个函数：

class reprlib.Repr

该类提供了格式化服务 适用于实现与内置 repr() 相似的方法；其中附加了针对不同对象类型的大小限制，以避免生成超长的表示。

reprlib.aRepr

这是 Repr 的一个实例，用于提供如下所述的 repr() 函数。 改变此对象的属性将会影响 repr() 和 Python 调试器所使用的大小限制。

reprlib.repr(obj)

这是 aRepr 的 repr() 方法。 它会返回与同名内置函数所返回字符串相似的字符串，区别在于附带了对多数类型的大小限制。

在大小限制工具以外，此模块还提供了一个装饰器，用于检测对 __repr__() 的递归调用并改用一个占位符来替换。

@reprlib.recursive_repr(fillvalue='...')

用于为 __repr__() 方法检测同一线程内部递归调用的装饰器。 如果执行了递归调用，则会返回 fillvalue，否则执行正常的 __repr__() 调用。 例如：

>>> 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'>

3.2 新版功能.

Repr 对象

Repr 实例对象包含一些属性可以用于为不同对象类型的表示提供大小限制，还包含一些方法可以格式化特定的对象类型。

Repr.maxlevel

创建递归表示形式的深度限制。 默认为 6。

Repr.maxdict

Repr.maxlist

Repr.maxtuple

Repr.maxset

Repr.maxfrozenset

Repr.maxdeque

Repr.maxarray

表示命名对象类型的条目数量限制。 对于 maxdict 的默认值为 4，对于 maxarray 为 5，对于其他则为 6。

Repr.maxlong

表示整数的最大字符数量。 数码会从中间被丢弃。 默认值为 40。

Repr.maxstring

表示字符串的字符数量限制。 请注意字符源会使用字符串的“正常”表示形式：如果表示中需要用到转义序列，在缩短表示时它们可能会被破坏。 默认值为 30。

Repr.maxother

此限制用于控制在 Repr 对象上没有特定的格式化方法可用的对象类型的大小。 它会以类似 maxstring 的方式被应用。 默认值为 20。

Repr.repr(obj)

内置 repr() 的等价形式，它使用实例专属的格式化。

Repr.repr1(obj, level)

供 repr() 使用的递归实现。 此方法使用 obj 的类型来确定要调用哪个格式化方法，并传入 obj 和 level。 类型专属的方法应当调用 repr1() 来执行递归格式化，在递归调用中使用 level - 1 作为 level 的值。

Repr.repr_TYPE(obj, level)

特定类型的格式化方法会被实现为基于类型名称来命名的方法。 在方法名称中，TYPE 会被替换为 '_'.join(type(obj).__name__.split())。 对这些方法的分派会由 repr1() 来处理。 需要对值进行递归格式化的类型专属方法应当调用 self.repr1(subobj, level - 1)。

子类化 Repr 对象

通过 Repr.repr1() 使用动态分派允许 Repr 的子类添加对额外内置对象类型的支持，或是修改对已支持类型的处理。 这个例子演示了如何添加对文件对象的特殊支持:

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))         # prints '<stdin>'

enum --- 对枚举的支持

3.4 新版功能.

源代码： Lib/enum.py [https://github.com/python/cpython/tree/3.10/Lib/enum.py]

枚举是与多个唯一常量值绑定的一组符号名（即成员）。枚举中的成员可以进行身份比较，并且枚举自身也可迭代。

注解

枚举成员名的大小写

枚举表示的是常量，因此，建议枚举成员名称使用大写字母，本篇的示例将用此种风格。

模块内容

本模块定义了四个枚举类，用来定义名称与值的唯一组合: Enum、IntEnum、Flag 和 IntFlag。此外，还定义了一个装饰器，unique()， 和一个辅助类，auto。

class enum.Enum

创建枚举常量的基类。 如需了解另一种构建语法，请参阅 Functional API 小节。

class enum.IntEnum

创建 int 子类枚举常量的基类。

class enum.IntFlag

创建可与位运算符搭配使用，又不失去 IntFlag 成员资格的枚举常量的基类。IntFlag 成员也是 int 的子类。

class enum.Flag

创建可与位运算符搭配使用，又不会失去 Flag 成员资格的枚举常量的基类。

enum.unique()

确保一个名称只绑定一个值的 Enum 类装饰器。

class enum.auto

以合适的值代替 Enum 成员的实例。 初始值默认从 1 开始。

3.6 新版功能: Flag, IntFlag, auto

创建 Enum

枚举是由 class 句法创建的，这种方式易读、易写。 另一种创建方法请参阅 Functional API。Enum 以如下定义枚举：

>>> from enum import Enum
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
...

注解

Enum 成员值

成员值可以是 int、str 等。若无需设定确切值，auto 实例可以自动为成员分配合适 的值。将 auto 与其他值混用时必须要慎重。

注解

命名法

类 Color 是 枚举 （或称为 enum ）。

Color.RED、Color.GREEN 等属性是 枚举成员 （或 enum 成员），也是常量。

枚举成员具有 名称 和 值 (例如 Color.RED 的名称为 RED，Color.BLUE 的值为 3 等等)

注解

虽然 Enum 由 class 语法创建，但 Enum 并不是常规的 Python 类。详见 How are Enums different?。

枚举成员的字符串表现形式更容易理解：

>>> print(Color.RED)
Color.RED

同时，它的 repr 包含更多信息：

>>> print(repr(Color.RED))
<Color.RED: 1>

枚举成员的 类型 就是它所属的枚举：

>>> type(Color.RED)
<enum 'Color'>
>>> isinstance(Color.GREEN, Color)
True
>>>

Enum 成员还包含 name 属性：

>>> print(Color.RED.name)
RED

枚举按定义的顺序进行迭代：

>>> class Shake(Enum):
...     VANILLA = 7
...     CHOCOLATE = 4
...     COOKIES = 9
...     MINT = 3
...
>>> for shake in Shake:
...     print(shake)
...
Shake.VANILLA
Shake.CHOCOLATE
Shake.COOKIES
Shake.MINT

枚举成员可哈希，可用于字典和集合：

>>> apples = {}
>>> apples[Color.RED] = 'red delicious'
>>> apples[Color.GREEN] = 'granny smith'
>>> apples == {Color.RED: 'red delicious', Color.GREEN: 'granny smith'}
True

枚举成员及其属性的编程访问

有时，要在程序中访问枚举成员（如，开发时不知道颜色的确切值，Color.RED 不适用的情况）。Enum 支持如下访问方式:

>>> Color(1)
<Color.RED: 1>
>>> Color(3)
<Color.BLUE: 3>

若要用 名称 访问枚举成员时，可使用枚举项:

>>> Color['RED']
<Color.RED: 1>
>>> Color['GREEN']
<Color.GREEN: 2>

若有了枚举成员，需要获取 name 或 value:

>>> member = Color.RED
>>> member.name
'RED'
>>> member.value
1

重复的枚举成员和值

两个枚举成员的名称不能相同:

>>> class Shape(Enum):
...     SQUARE = 2
...     SQUARE = 3
...
Traceback (most recent call last):
...
TypeError: Attempted to reuse key: 'SQUARE'

但是，两个枚举成员可以有相同的值。假设，成员 A 和 B 的值相同（先定义的是 A），则 B 是 A 的别名。按值查找 A 和 B 的值返回的是 A。按名称查找 B，返回的也是 A：

>>> 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>

注解

不允许创建与已定义属性（其他成员、方法等）同名的成员，也不支持创建与现有成员同名的属性。

确保枚举值唯一

默认情况下，枚举允许多个名称作为一个值的别名。如需禁用此行为，下述装饰器可以确保枚举中的值仅能只用一次：

@enum.unique

专用于枚举的 class 装饰器。 它会搜索一个枚举的 __members__ 并收集所找到的任何别名；只要找到任何别名就会引发 ValueError 并附带相关细节信息:

>>> 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

使用自动设定的值

如果具体的枚举值无所谓是什么，可以使用 auto:

>>> 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>]

枚举值将交由 _generate_next_value_() 选取，该函数可以被重写:

>>> class AutoName(Enum):
...     def _generate_next_value_(name, start, count, last_values):
...         return name
...
>>> class Ordinal(AutoName):
...     NORTH = auto()
...     SOUTH = auto()
...     EAST = auto()
...     WEST = auto()
...
>>> list(Ordinal)
[<Ordinal.NORTH: 'NORTH'>, <Ordinal.SOUTH: 'SOUTH'>, <Ordinal.EAST: 'EAST'>, <Ordinal.WEST: 'WEST'>]

注解

默认 _generate_next_value_() 方法的目标是提供所给出的最后一个 int 所在序列的下一个 int，但这种行为方式属于实现细节并且可能发生改变。

注解

_generate_next_value_() 方法的定义必须在任何其他成员之前。

迭代

对枚举成员的迭代遍历不会列出别名:

>>> list(Shape)
[<Shape.SQUARE: 2>, <Shape.DIAMOND: 1>, <Shape.CIRCLE: 3>]

特殊属性 __members__ 是一个名称与成员间的只读有序映射。包含了枚举中定义的所有名称，包括别名:

>>> 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>)

__members__ 属性可用于获取枚举成员的详细信息。比如查找所有别名:

>>> [name for name, member in Shape.__members__.items() if member.name != name]
['ALIAS_FOR_SQUARE']

比较运算

枚举成员是按 ID 进行比较的:

>>> Color.RED is Color.RED
True
>>> Color.RED is Color.BLUE
False
>>> Color.RED is not Color.BLUE
True

枚举值之间无法进行有序的比较。枚举的成员不是整数（另请参阅下文 IntEnum）:

>>> Color.RED < Color.BLUE
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'Color' and 'Color'

相等性比较的定义如下:

>>> Color.BLUE == Color.RED
False
>>> Color.BLUE != Color.RED
True
>>> Color.BLUE == Color.BLUE
True

与非枚举值的比较将总是不等的（同样 IntEnum 有意设计为其他的做法，参见下文）:

>>> Color.BLUE == 2
False

合法的枚举成员和属性

以上示例使用整数作为枚举值。 使用整数相当简洁方便（并由 Functional API 默认提供），但并不强制要求使用。 在大部分用例中，开发者都关心枚举的实际值是什么。 但如果值 确实 重要，则枚举可以使用任意的值。

枚举是 Python 的类，可带有普通方法和特殊方法。假设有如下枚举:

>>> class Mood(Enum):
...     FUNKY = 1
...     HAPPY = 3
...
...     def describe(self):
...         # self is the member here
...         return self.name, self.value
...
...     def __str__(self):
...         return 'my custom str! {0}'.format(self.value)
...
...     @classmethod
...     def favorite_mood(cls):
...         # cls here is the enumeration
...         return cls.HAPPY
...

那么:

>>> Mood.favorite_mood()
<Mood.HAPPY: 3>
>>> Mood.HAPPY.describe()
('HAPPY', 3)
>>> str(Mood.FUNKY)
'my custom str! 1'

合法的规则如下：以单下划线开头和结尾的名称是保留值，不能使用；在枚举中定义的其他所有属性都将成为该枚举的成员，但特殊方法（__str__() 、__add__() 等）、描述符（方法也是描述符）和在 _ignore_ 中列出的变量名除外。

注意：如果枚举定义了 __new__() 或 __init__() ，那么赋给枚举成员的任何值都会被传入这些方法。请参阅示例 Planet 。

受限的 Enum 子类化

一个新的 Enum 类必须基于一个 Enum 类，至多一个实体数据类型以及出于实际需要的任意多个基于 object 的 mixin 类。 这些基类的顺序为:

class EnumName([mix-in, ...,] [data-type,] base-enum):
    pass

仅当未定义任何成员时，枚举类才允许被子类化。因此不得有以下写法:

>>> class MoreColor(Color):
...     PINK = 17
...
Traceback (most recent call last):
...
TypeError: MoreColor: cannot extend enumeration 'Color'

但以下代码是可以的:

>>> class Foo(Enum):
...     def some_behavior(self):
...         pass
...
>>> class Bar(Foo):
...     HAPPY = 1
...     SAD = 2
...

如果定义了成员的枚举也能被子类化，则类型与实例的某些重要不可变规则将会被破坏。另一方面，一组枚举类共享某些操作也是合理的。（请参阅例程 OrderedEnum ）

打包（pickle）

枚举类型可以被打包和解包:

>>> from test.test_enum import Fruit
>>> from pickle import dumps, loads
>>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
True

打包的常规限制同样适用于枚举类型：必须在模块的最高层级定义，因为解包操作要求可从该模块导入。

注解

用 pickle 协议版本 4 可以轻松地将嵌入其他类中的枚举进行打包。

通过在枚举类中定义 __reduce_ex__() 可以对 Enum 成员的封存/解封方式进行修改。

函数式 API

Enum 类可调用并提供了以下函数式 API：

>>> Animal = Enum('Animal', 'ANT BEE CAT DOG')
>>> Animal
<enum 'Animal'>
>>> Animal.ANT
<Animal.ANT: 1>
>>> Animal.ANT.value
1
>>> list(Animal)
[<Animal.ANT: 1>, <Animal.BEE: 2>, <Animal.CAT: 3>, <Animal.DOG: 4>]

该 API 的语义类似于 namedtuple。调用 Enum 的第一个参数是枚举的名称。

第二个参数是枚举成员名称的 来源。可以是个用空格分隔的名称字符串、名称序列、表示键/值对的二元组的序列，或者名称到值的映射（如字典）。 最后两种可以为枚举赋任意值；其他类型则会自动赋成由 1 开始递增的整数值（利用 start 形参可指定为其他起始值）。返回值是一个派生自 Enum 的新类。换句话说，上述对 Animal 的赋值等价于:

>>> class Animal(Enum):
...     ANT = 1
...     BEE = 2
...     CAT = 3
...     DOG = 4
...

默认以 1 而以 0 作为起始数值的原因在于 0 的布尔值为 False，但所有枚举成员都应被求值为 True。

对使用功能性 API 创建的枚举执行封存可能会很麻烦，因为要使用帧堆栈的实现细节来尝试并找出枚举是在哪个模块中创建的（例如当你使用了另一个模块中的工具函数就可能失败，在 IronPython 或 Jython 上也可能无效）。 解决办法是显式地指定模块名称，如下所示:

>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)

警告

如果未提供 module，且 Enum 无法确定是哪个模块，新的 Enum 成员将不可被解封；为了让错误尽量靠近源头，封存将被禁用。

新的 pickle 协议版本 4 在某些情况下同样依赖于 __qualname__ 被设为特定位置以便 pickle 能够找到相应的类。 例如，类是否存在于全局作用域的 SomeData 类中:

>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal')

完整的签名为:

Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>, start=1)

value

将被新 Enum 类将记录为其名称的数据。

names

Enum 的成员。 这可以是一个空格或逗号分隔的字符串 (起始值将为 1，除非另行指定):

'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE'

或是一个名称的迭代器对象:

['RED', 'GREEN', 'BLUE']

或是一个 (名称, 值) 对的迭代器对象:

[('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]

或是一个映射对象:

{'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42}

module

新 Enum 类所在模块的名称。

qualname

新 Enum 类在模块中的具体位置。

type

要加入新 Enum 类的类型。

start

当只传入名称时要使用的起始数值。

在 3.5 版更改: 增加了 start 形参。

派生的枚举

IntEnum

所提供的第一个变种 Enum 同时也是 int 的一个子类。 IntEnum 的成员可与整数进行比较；通过扩展，不同类型的整数枚举也可以相互进行比较:

>>> 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

不过，它们仍然不可与标准 Enum 枚举进行比较:

>>> class Shape(IntEnum):
...     CIRCLE = 1
...     SQUARE = 2
...
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...
>>> Shape.CIRCLE == Color.RED
False

IntEnum 值在其他方面的行为都如你预期的一样类似于整数:

>>> int(Shape.CIRCLE)
1
>>> ['a', 'b', 'c'][Shape.CIRCLE]
'b'
>>> [i for i in range(Shape.SQUARE)]
[0, 1]

IntFlag

所提供的下一个 Enum 的变种 IntFlag 同样是基于 int 的，不同之处在于 IntFlag 成员可使用按位运算符 (&, |, ^, ~) 进行组合且结果仍然为 IntFlag 成员。 如果，正如名称所表明的，IntFlag 成员同时也是 int 的子类，并能在任何使用 int 的场合被使用。 IntFlag 成员进行除按位运算以外的其他运算都将导致失去 IntFlag 成员资格。

3.6 新版功能.

示例 IntFlag 类:

>>> 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

对于组合同样可以进行命名:

>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...     RWX = 7
>>> Perm.RWX
<Perm.RWX: 7>
>>> ~Perm.RWX
<Perm.-8: -8>

IntFlag 和 Enum 的另一个重要区别在于如果没有设置任何旗标（值为 0），则其布尔值为 False:

>>> Perm.R & Perm.X
<Perm.0: 0>
>>> bool(Perm.R & Perm.X)
False

由于 IntFlag 成员同时也是 int 的子类，因此它们可以相互组合:

>>> Perm.X | 8
<Perm.8|X: 9>

标志位

最后一个变体是 Flag。与 IntFlag 类似，Flag 成员可用按位运算符 (&, |, ^, ~) 组合。与 IntFlag 不同的是，它们不可与其它 Flag 枚举或 int 进行组合或比较。 虽然可以直接指定值，但推荐使用 auto 作为值来让 Flag 选择适当的值。

3.6 新版功能.

与 IntFlag 类似，如果 Flag 成员的某种组合导致没有设置任何旗标，则其布尔值为 False:

>>> from enum import Flag, auto
>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.RED & Color.GREEN
<Color.0: 0>
>>> bool(Color.RED & Color.GREEN)
False

单个标志的值应当为二的乘方 (1, 2, 4, 8, ...)，标志的组合则无此限制:

>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...     WHITE = RED | BLUE | GREEN
...
>>> Color.WHITE
<Color.WHITE: 7>

对 "no flags set" 条件指定一个名称并不会改变其布尔值:

>>> class Color(Flag):
...     BLACK = 0
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.BLACK
<Color.BLACK: 0>
>>> bool(Color.BLACK)
False

注解

对于大多数新代码，强烈推荐使用 Enum 和 Flag，因为 IntEnum 和 IntFlag 打破了枚举的某些语义约定（例如可以同整数进行比较，并因而导致此行为被传递给其他无关的枚举）。 IntEnum 和 IntFlag 的使用应当仅限于 Enum 和 Flag 无法使用的场合；例如，当使用枚举替代整数常量时，或是与其他系统进行交互操作时。

其他事项

虽然 IntEnum 是 enum 模块的一部分，但要独立实现也应该相当容易:

class IntEnum(int, Enum):
    pass

这里演示了如何定义类似的派生枚举；例如一个混合了 str 而不是 int 的 StrEnum。

几条规则：

当子类化 Enum 时，在基类序列中的混合类型必须出现于 Enum 本身之前，如以上 IntEnum 的例子所示。

虽然 Enum 可以拥有任意类型的成员，不过一旦你混合了附加类型，则所有成员必须为相应类型的值，如在上面的例子中即为 int。 此限制不适用于仅添加方法而未指定另一数据类型的混合类。

当混合了另一数据类型时，value 属性会 不同于 枚举成员自身，但它们仍保持等价且比较结果也相等。

%-style formatting: %s 和 %r 会分别调用 Enum 类的 __str__() 和 __repr__()；其他代码 (例如表示 IntEnum 的 %i 或 %h) 会将枚举成员视为对应的混合类型。

格式化字符串字面值, str.format() 和 format() 将使用混合类型的 __format__() 除非在子类中重载了 __str__() 或 __format__()，在这种情况下将使用被重载的方法或 Enum 的方法。 请使用 !s 和 !r 格式代码来强制使用 Enum 类的 __str__() 和 __repr__() 方法。

何时使用 __new__() 与 __init__()

当你想要定制 Enum 成员的实际值时必须使用 __new__()。 任何其他修改可以用 __new__() 也可以用 __init__()，应优先使用 __init__()。

举例来说，如果你要向构造器传入多个条目，但只希望将其中一个作为值:

>>> 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

有趣的示例

虽然 Enum, IntEnum, IntFlag 和 Flag 预期可覆盖大多数应用场景，但它们无法覆盖全部。 这里有一些不同类型枚举的方案，它们可以被直接使用，或是作为自行创建的参考示例。

省略值

在许多应用场景中人们都不关心枚举的实际值是什么。 有几个方式可以定义此种类型的简单枚举：

使用 auto 的实例作为值

使用 object 的实例作为值

使用描述性的字符串作为值

使用元组作为值并用自定义的 __new__() 以一个 int 值来替代该元组

使用以上任何一种方法均可向用户指明值并不重要，并且使人能够添加、移除或重排序成员而不必改变其余成员的数值。

无论你选择何种方法，你都应当提供一个 repr() 并且它也需要隐藏（不重要的）值:

>>> class NoValue(Enum):
...     def __repr__(self):
...         return '<%s.%s>' % (self.__class__.__name__, self.name)
...

使用 auto

使用 auto 的形式如下:

>>> class Color(NoValue):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.GREEN
<Color.GREEN>

使用 object

使用 object 的形式如下:

>>> class Color(NoValue):
...     RED = object()
...     GREEN = object()
...     BLUE = object()
...
>>> Color.GREEN
<Color.GREEN>

使用描述性字符串

使用字符串作为值的形式如下:

>>> class Color(NoValue):
...     RED = 'stop'
...     GREEN = 'go'
...     BLUE = 'too fast!'
...
>>> Color.GREEN
<Color.GREEN>
>>> Color.GREEN.value
'go'

使用自定义的 __new__()

使用自动编号 __new__() 的形式如下:

>>> class AutoNumber(NoValue):
...     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>
>>> Color.GREEN.value
2

要实现更通用的 AutoNumber，请添加 *args 到签名中:

>>> class AutoNumber(NoValue):
...     def __new__(cls, *args):      # this is the only change from above
...         value = len(cls.__members__) + 1
...         obj = object.__new__(cls)
...         obj._value_ = value
...         return obj
...

这样当你从 AutoNumber 继承时你将可以编写你自己的 __init__ 来处理任何附加参数:

>>> class Swatch(AutoNumber):
...     def __init__(self, pantone='unknown'):
...         self.pantone = pantone
...     AUBURN = '3497'
...     SEA_GREEN = '1246'
...     BLEACHED_CORAL = () # New color, no Pantone code yet!
...
>>> Swatch.SEA_GREEN
<Swatch.SEA_GREEN>
>>> Swatch.SEA_GREEN.pantone
'1246'
>>> Swatch.BLEACHED_CORAL.pantone
'unknown'

注解

如果定义了 __new__() 则它会在创建 Enum 成员期间被使用；随后它将被 Enum 的 __new__() 所替换，该方法会在类创建后被用来查找现有成员。

OrderedEnum

一个有序枚举，它不是基于 IntEnum，因此保持了正常的 Enum 不变特性（例如不可与其他枚举进行比较）:

>>> 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

DuplicateFreeEnum

如果发现重复的成员名称则将引发错误而不是创建别名:

>>> 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'

注解

这个例子适用于子类化 Enum 来添加或改变禁用别名以及其他行为。 如果需要的改变只是禁用别名，也可以选择使用 unique() 装饰器。

Planet

如果定义了 __new__() 或 __init__() 则枚举成员的值将被传给这些方法:

>>> 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

TimePeriod

一个演示如何使用 _ignore_ 属性的例子:

>>> from datetime import timedelta
>>> class Period(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)>]

各种枚举有何区别？

枚举具有自定义的元类，它会影响所派生枚举类及其实例（成员）的各个方面。

枚举类

EnumMeta 元类负责提供 __contains__(), __dir__(), __iter__() 及其他方法以允许用户通过 Enum 类来完成一般类做不到的事情，例如 list(Color) 或 some_enum_var in Color。 EnumMeta 会负责确保最终 Enum 类中的各种其他方法是正确的 (例如 __new__(), __getnewargs__(), __str__() 和 __repr__())。

枚举成员（即实例）

有关枚举成员最有趣的特点是它们都是单例对象。 EnumMeta 会在创建 Enum 类本身时将它们全部创建完成，然后准备好一个自定义的 __new__()，通过只返回现有的成员实例来确保不会再实例化新的对象。

细节要点

支持的 __dunder__ 名称

__members__ 是一个 member_name:member 条目的只读有序映射。 它只在类上可用。

如果指定了 __new__()，它必须创建并返回枚举成员；相应地设定成员的 _value_ 也是一个很好的主意。 一旦所有成员都创建完成它就不会再被使用。

支持的 _sunder_ 名称

_name_ -- 成员的名称

_value_ -- 成员的值；可以在 __new__ 中设置 / 修改

_missing_ -- 当未发现某个值时所使用的查找函数；可被重写

_ignore_ -- 一个名称列表，可以为 list 或 str，它不会被转化为成员，并将从最终类中被移除

_order_ -- 用于 Python 2/3 代码以确保成员顺序一致（类属性，在类创建期间会被移除）

_generate_next_value_ -- Functional API 和 auto 用它为枚举成员获取适当的值；可被重写

3.6 新版功能: _missing_, _order_, _generate_next_value_

3.7 新版功能: _ignore_

用来帮助 Python 2 / Python 3 代码保持同步提供 _order_ 属性。 它将与枚举的实际顺序进行对照检查，如果两者不匹配则会引发错误:

>>> 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_

注解

在 Python 2 代码中 _order_ 属性是必须的，因为定义顺序在被记录之前就会丢失。

_Private__names

私有名称 在 Python 3.11 中将成为普通属性而不再是错误或成员（具体取决于该名称是否以一个下划线结束）。 在 3.10 中使用这种名称将引发 DeprecationWarning。

Enum 成员类型

Enum 成员是其 Enum 类的实例，一般通过 EnumClass.member 的形式来访问。 在特定情况下它们也可通过 EnumClass.member.member 的形式来访问，但你绝对不应这样做，因为查找可能失败，或者更糟糕地返回你所查找的 Enum 成员以外的对象（这也是成员应使用全大写名称的另一个好理由）:

>>> class FieldTypes(Enum):
...     name = 0
...     value = 1
...     size = 2
...
>>> FieldTypes.value.size
<FieldTypes.size: 2>
>>> FieldTypes.size.value
2

注解

这一行为已被废弃，并将在 3.11 中被删除。

在 3.5 版更改.

Enum 类和成员的布尔值

混合了非 Enum 类型（例如 int, str 等）的 Enum 成员会按所混合类型的规则被求值；在其他情况下，所有成员都将被求值为 True。 要使你的自定义 Enum 的布尔值取决于成员的值，请在你的类中添加以下代码:

def __bool__(self):
    return bool(self.value)

Enum 类总是会被求值为 True。

带有方法的 Enum 类

如果你为你的 Enum 子类添加了额外的方法，如同上述的 Planet 类一样，这些方法将在对成员执行 dir() 时显示出来，但对类执行时则不会显示:

>>> 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']

组合 Flag 的成员

如果 Flag 成员的某种组合未被命名，则 repr() 将包含所有已命名的标志和值中所有已命名的标志组合：

>>> 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.CYAN|MAGENTA|BLUE|YELLOW|GREEN|RED: 7>

注解

在 3.11 中，未命名的标志组合将只产生典型的标志成员（又称单值标志）。 所以 Color(7) 会产生类似 <Color.BLUE|GREEN|RED: 7> 的结果。

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

源代码: Lib/graphlib.py [https://github.com/python/cpython/tree/3.10/Lib/graphlib.py]

class graphlib.TopologicalSorter(graph=None)

提供以拓扑方式对由 hashable 节点组成的图进行排序的功能。

拓扑排序是指图中顶点的线性排序，使得对于每条从顶点 u 到顶点 v 的有向边 u -> v，顶点 u 都排在顶点 v 之前。 例如，图的顶点可以代表要执行的任务，而边代表某一个任务必须在另一个任务之前执行的约束条件；在这个例子中，拓扑排序只是任务的有效序列。 完全拓扑排序 当且仅当图不包含有向环，也就是说为有向无环图时，完全拓扑排序才是可能的。

如果提供了可选的 graph 参数则它必须为一个表示有向无环图的字典，其中的键为节点而值为包含图中该节点的所有上级节点（即具有指向键中的值的边的节点）的可迭代对象。 额外的节点可以使用 add() 方法添加到图中。

在通常情况下，对给定的图执行排序所需的步骤如下:

通过可选的初始图创建一个 TopologicalSorter 的实例。

添加额外的节点到图中。

在图上调用 prepare()。

当 is_active() 为 True 时，迭代 get_ready() 所返回的节点并加以处理。 完成处理后在每个节点上调用 done()。

在只需要对图中的节点进行立即排序并且不涉及并行性的情况下，可以直接使用便捷方法 TopologicalSorter.static_order():

>>> graph = {"D": {"B", "C"}, "C": {"A"}, "B": {"A"}}
>>> ts = TopologicalSorter(graph)
>>> tuple(ts.static_order())
('A', 'C', 'B', 'D')

这个类被设计用来在节点就绪时方便地支持对其并行处理。 例如:

topological_sorter = TopologicalSorter()

# Add nodes to 'topological_sorter'...

topological_sorter.prepare()
while topological_sorter.is_active():
    for node in topological_sorter.get_ready():
        # Worker threads or processes take nodes to work on off the
        # 'task_queue' queue.
        task_queue.put(node)

    # When the work for a node is done, workers put the node in
    # 'finalized_tasks_queue' so we can get more nodes to work on.
    # The definition of 'is_active()' guarantees that, at this point, at
    # least one node has been placed on 'task_queue' that hasn't yet
    # been passed to 'done()', so this blocking 'get()' must (eventually)
    # succeed.  After calling 'done()', we loop back to call 'get_ready()'
    # again, so put newly freed nodes on 'task_queue' as soon as
    # logically possible.
    node = finalized_tasks_queue.get()
    topological_sorter.done(node)

add(node, *predecessors)

将一个新节点及其上级节点添加到图中。 node 和 predecessors 中的所有元素都必须是 hashable。

如果附带相同的节点参数多次调用，则依赖项的集合将为所有被传入依赖项的并集。

可以添加不带依赖项的节点 (即不提供 predecessors) 或者重复提供依赖项。 如果有先前未提供的节点包含在 predecessors 中则它将被自动添加到图中并且不带自己的上级节点。

如果在 prepare() 之后被调用则会引发 ValueError。

prepare()

将图标记为已完成并检查图中是否存在环。 如何检测到任何环，则将引发 CycleError，但 get_ready() 仍可被用来获取尽可能多的节点直到环阻塞了操作过程。 在调用此函数后，图将无法再修改，因此不能再使用 add() 添加更多的节点。

is_active()

如果可以取得更多进展则返回 True，否则返回 False。 如果环没有阻塞操作，并且还存在尚未被 TopologicalSorter.get_ready() 返回的已就绪节点或者已标记为 TopologicalSorter.done() 的节点数量少于已被 TopologicalSorter.get_ready() 所返回的节点数量则还可以取得进展。

该类的 __bool__() 方法要使用此函数，因此除了:

if ts.is_active():
    ...

可能会简单地执行:

if ts:
    ...

如果之前未调用 prepare() 就调用此函数则会引发 ValueError。

done(*nodes)

将 TopologicalSorter.get_ready() 所返回的节点集合标记为已处理，解除对 nodes 中每个节点的后续节点的阻塞以便在将来通过对 TopologicalSorter.get_ready() 的调用来返回它们。

如果 nodes 中的任何节点已经被之前对该方法的调用标记为已处理或者如果未通过使用 TopologicalSorter.add() 将一个节点添加到图中，如果未调用 prepare() 即调用此方法或者如果节点尚未被 get_ready() 所返回则将引发 ValueError。

get_ready()

返回由所有已就绪节点组成的 tuple。 初始状态下它将返回所有不带上级节点的节点，并且一旦通过调用 TopologicalSorter.done() 将它们标记为已处理，之后的调用将返回所有上级节点已被处理的新节点。 一旦无法再取得进展，则会返回空元组。

如果之前未调用 prepare() 就调用此函数则会引发 ValueError。

static_order()

返回一个迭代器，它将按照拓扑顺序来迭代所有节点。 当使用此方法时，prepare() 和 done() 不应被调用。 此方法等价于:

def static_order(self):
    self.prepare()
    while self.is_active():
        node_group = self.get_ready()
        yield from node_group
        self.done(*node_group)

所返回的特定顺序可能取决于条目被插入图中的顺序。 例如:

>>> 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]

这是由于实际上 "0" 和 "2" 在图中的级别相同（它们将在对 get_ready() 的同一次调用中被返回） 并且它们之间的顺序是由插入顺序决定的。

如果检测到任何环，则将引发 CycleError。

3.9 新版功能.

异常

graphlib 模块定义了以下异常类:

exception graphlib.CycleError

ValueError 的子类，当特定的图中存在环时将由 TopologicalSorter.prepare() 引发。 如果存在多个环，则将只报告其中一个未定义的选项并将其包括在异常中。

检测到的环可以通过异常实例的 args 属性的第二个元素来访问，它由一个节点列表组成，其中的每个节点在图中都是列表中下一个节点的直接上级节点。 在报告的列表中，开头和末尾的节点将是同一对象，以表明它是一个环。

数字和数学模块

本章介绍的模块提供与数字和数学相关的函数和数据类型。 numbers 模块定义了数字类型的抽象层次结构。 math 和 cmath 模块包含浮点数和复数的各种数学函数。 decimal 模块支持使用任意精度算术的十进制数的精确表示。

本章包含以下模块的文档：

numbers --- 数字的抽象基类

数字的层次

类型接口注释。

加入更多数字的ABC

实现算术运算

math --- 数学函数

数论与表示函数

幂函数与对数函数

三角函数

角度转换

双曲函数

特殊函数

常量

cmath --- 关于复数的数学函数

到极坐标和从极坐标的转换

幂函数与对数函数

三角函数

双曲函数

分类函数

常量

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

快速入门教程

Decimal 对象

逻辑操作数

上下文对象

常量

舍入模式

信号

浮点数说明

通过提升精度来解决舍入错误

特殊的值

使用线程

例程

Decimal 常见问题

fractions --- 分数

random --- 生成伪随机数

簿记功能

用于字节数据的函数

整数用函数

序列用函数

实值分布

替代生成器

关于再现性的说明

例子

例程

statistics --- 数学统计函数

平均值以及对中心位置的评估

对分散程度的评估

对两个输入之间关系的统计

函数细节

异常

NormalDist 对象

NormalDist 示例和用法

numbers --- 数字的抽象基类

源代码： Lib/numbers.py [https://github.com/python/cpython/tree/3.10/Lib/numbers.py]

numbers 模块 (PEP 3141 [https://www.python.org/dev/peps/pep-3141]) 定义了数字 抽象基类 的层级结构，其中逐级定义了更多操作。 此模块中定义的类型都不可被实例化。

class numbers.Number

数字的层次结构的基础。 如果你只想确认参数 x 是不是数字而不关心其类型，则使用 isinstance(x, Number)。

数字的层次

class numbers.Complex

这个类型的子类描述了复数并包括了适用于内置 complex 类型的操作。 这些操作有: 转换为 complex 和 bool, real, imag, +, -, *, /, **, abs(), conjugate(), == 以及 !=。 除 - 和 != 之外所有操作都是抽象的。

real

抽象的。得到该数字的实数部分。

imag

抽象的。得到该数字的虚数部分。

abstractmethod conjugate()

抽象的。返回共轭复数。例如 (1+3j).conjugate() == (1-3j)。

class numbers.Real

相对于 Complex，Real 加入了只有实数才能进行的操作。

简单的说，它们是：转化至 float，math.trunc()、 round()、 math.floor()、 math.ceil()、 divmod()、 //、 %、 <、 <=、 >、 和 >=。

实数同样默认支持 complex()、 real、 imag 和 conjugate()。

class numbers.Rational

子类型 Real 并加入 numerator 和 denominator 两种特征属性。 它还为 float() 提供了默认值。

numerator 和 denominator 值应为 Integral 的实例并且应当是具有 denominator 正值的最低项。

numerator

抽象的。

denominator

抽象的。

class numbers.Integral

子类型 Rational 还增加了到 int 的转换操作。 为 float(), numerator 和 denominator 提供了默认支持。 为 pow() 方法增加了求余和按位字符串运算的抽象方法: <<, >>, &, ^, |, ~。

类型接口注释。

实现者需要注意使相等的数字相等并拥有同样的值。当这两个数使用不同的扩展模块时，这其中的差异是很微妙的。例如，用 fractions.Fraction 实现 hash() 如下:

def __hash__(self):
    if self.denominator == 1:
        # Get integers right.
        return hash(self.numerator)
    # Expensive check, but definitely correct.
    if self == float(self):
        return hash(float(self))
    else:
        # Use tuple's hash to avoid a high collision rate on
        # simple fractions.
        return hash((self.numerator, self.denominator))

加入更多数字的ABC

当然，这里有更多支持数字的ABC，如果不加入这些，就将缺少层次感。你可以用如下方法在 Complex 和 Real 中加入 MyFoo:

class MyFoo(Complex): ...
MyFoo.register(Real)

实现算术运算

我们希望实现计算，因此，混合模式操作要么调用一个作者知道参数类型的实现，要么转变成为最接近的内置类型并对这个执行操作。对于子类 Integral，这意味着 __add__() 和 __radd__() 必须用如下方式定义：

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

Complex 有 5 种不同的混合类型的操作。 我将上面提到的所有代码作为“模板”称作 MyIntegral 和 OtherTypeIKnowAbout。 a 是 Complex 的子类型 A 的实例 (a : A <: Complex)，同时 b : B <: Complex。 我将要计算 a + b:

如果 A 被定义成一个承认 b 的 __add__()，一切都没有问题。

如果 A 转回成“模板”失败，它将返回一个属于 __add__() 的值，我们需要避免 B 定义了一个更加智能的 __radd__()，因此模板需要返回一个属于 __add__() 的 NotImplemented 。（或者 A 可能完全不实现 __add__() 。）

接着看 B 的 __radd__() 。如果它承认 a ，一切都没有问题。

如果没有成功回退到模板，就没有更多的方法可以去尝试，因此这里将使用默认的实现。

如果 B <: A ， Python 在 A.__add__ 之前尝试 B.__radd__ 。 这是可行的，是通过对 A 的认识实现的，因此这可以在交给 Complex 处理之前处理这些实例。

如果 A <: Complex 和 B <: Real 没有共享任何资源，那么适当的共享操作涉及内置的 complex ，并且分别获得 __radd__() ，因此 a+b == b+a。

由于对任何一直类型的大部分操作是十分相似的，可以定义一个帮助函数，即一个生成后续或相反的实例的生成器。例如，使用 fractions.Fraction 如下：

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, numbers.Real):
            return fallback_operator(float(a), float(b))
        elif isinstance(a, numbers.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)

# ...

math --- 数学函数

该模块提供了对C标准定义的数学函数的访问。

这些函数不适用于复数；如果你需要计算复数，请使用 cmath 模块中的同名函数。将支持计算复数的函数区分开的目的，在于大多数用户并不愿意为了理解复数而去学习太多数学知识。得到一个异常而不是一个复数结果能让复数当作参数的情况更早被监测到，进而程序员可以第一时间调查其产生的原因。

该模块提供了以下函数。除非另有明确说明，否则所有返回值均为浮点数。

数论与表示函数

math.ceil(x)

返回 x 的向上取整，即大于或等于 x 的最小的整数。如果 x 不是浮点数，委托给 x.__ceil__ ，它应该返回一个 Integral 的值。

math.comb(n, k)

返回不重复且无顺序地从 n 项中选择 k 项的方式总数。

当 k <= n 时取值为 n! / (k! * (n - k)!)；当 k > n 时取值为零。

也称为二项式系数，因为它等价于表达式 (1 + x) ** n 的多项式展开中第 k 项的系数。

如果任一参数不为整数则会引发 TypeError。 如果任一参数为负数则会引发 ValueError。

3.8 新版功能.

math.copysign(x, y)

返回一个基于 x 的绝对值和 y 的符号的浮点数。在支持带符号零的平台上，copysign(1.0, -0.0) 返回 -1.0.

math.fabs(x)

返回 x 的绝对值。

math.factorial(x)

以一个整数返回 x 的阶乘。 如果 x 不是整数或为负数时则将引发 ValueError。

3.9 版后已移除: 接受具有整数值的浮点数 (例如 5.0) 的行为已被弃用。

math.floor(x)

返回 x 的向下取整，小于或等于 x 的最大整数。如果 x 不是浮点数，则委托给 x.__floor__ ，它应返回一个 Integral 值。

math.fmod(x, y)

返回 fmod(x, y) ，由平台C库定义。请注意，Python表达式 x % y 可能不会返回相同的结果。C标准的目的是 fmod(x, y) 完全（数学上；到无限精度）等于 x - n*y 对于某个整数 n ，使得结果具有 与 x 相同的符号和小于 abs(y) 的幅度。Python的 x % y 返回带有 y 符号的结果，并且可能不能完全计算浮点参数。 例如， fmod(-1e-100, 1e100) 是 -1e-100 ，但Python的 -1e-100 % 1e100 的结果是 1e100-1e-100 ，它不能完全表示为浮点数，并且取整为令人惊讶的 1e100 。 出于这个原因，函数 fmod() 在使用浮点数时通常是首选，而Python的 x % y 在使用整数时是首选。

math.frexp(x)

以 (m, e) 对的形式返回 x 的尾数和指数。 m 是一个浮点数， e 是一个整数，正好是 x == m * 2**e 。 如果 x 为零，则返回 (0.0, 0) ，否则返回 0.5 <= abs(m) < 1 。这用于以可移植方式“分离”浮点数的内部表示。

math.fsum(iterable)

返回迭代中的精确浮点值。通过跟踪多个中间部分和来避免精度损失:

>>> sum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1])
0.9999999999999999
>>> fsum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1])
1.0

该算法的准确性取决于IEEE-754算术保证和舍入模式为半偶的典型情况。在某些非Windows版本中，底层C库使用扩展精度添加，并且有时可能会使中间和加倍，导致它在最低有效位中关闭。

有关待进一步讨论和两种替代方法，参见 ASPN cookbook recipes for accurate floating point summation [https://code.activestate.com/recipes/393090/]。

math.gcd(*integers)

返回给定的整数参数的最大公约数。 如果有一个参数非零，则返回值将是能同时整除所有参数的最大正整数。 如果所有参数为零，则返回值为 0。 不带参数的 gcd() 返回 0。

3.5 新版功能.

在 3.9 版更改: 添加了对任意数量的参数的支持。 之前的版本只支持两个参数。

math.isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0)

若 a 和 b 的值比较接近则返回 True，否则返回 False。

根据给定的绝对和相对容差确定两个值是否被认为是接近的。

rel_tol 是相对容差 —— 它是 a 和 b 之间允许的最大差值，相对于 a 或 b 的较大绝对值。例如，要设置5％的容差，请传递 rel_tol=0.05 。默认容差为 1e-09，确保两个值在大约9位十进制数字内相同。 rel_tol 必须大于零。

abs_tol 是最小绝对容差 —— 对于接近零的比较很有用。 abs_tol 必须至少为零。

如果没有错误发生，结果将是： abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol) 。

IEEE 754特殊值 NaN ， inf 和 -inf 将根据IEEE规则处理。具体来说， NaN 不被认为接近任何其他值，包括 NaN 。 inf 和 -inf 只被认为接近自己。

3.5 新版功能.

参见

PEP 485 [https://www.python.org/dev/peps/pep-0485] —— 用于测试近似相等的函数

math.isfinite(x)

如果 x 既不是无穷大也不是NaN，则返回 True ，否则返回 False 。 （注意 0.0 被认为 是 有限的。）

3.2 新版功能.

math.isinf(x)

如果 x 是正或负无穷大，则返回 True ，否则返回 False 。

math.isnan(x)

如果 x 是 NaN（不是数字），则返回 True ，否则返回 False 。

math.isqrt(n)

返回非负整数 n 的整数平方根。 这就是对 n 的实际平方根向下取整，或者相当于使得 a² ≤ n 的最大整数 a。

对于某些应用来说，可以更适合取值为使得 n ≤ a² 的最小整数 a ，或者换句话说就是 n 的实际平方根向上取整。 对于正数 n，这可以使用 a = 1 + isqrt(n - 1) 来计算。

3.8 新版功能.

math.lcm(*integers)

返回给定的整数参数的最小公倍数。 如果所有参数均非零，则返回值将是为所有参数的整数倍的最小正整数。 如果参数之一为零，则返回值为 0。 不带参数的 lcm() 返回 1。

3.9 新版功能.

math.ldexp(x, i)

返回 x * (2**i) 。 这基本上是函数 frexp() 的反函数。

math.modf(x)

返回 x 的小数和整数部分。两个结果都带有 x 的符号并且是浮点数。

math.nextafter(x, y)

返回 x 趋向于 y 的最接近的浮点数值。

如果 x 等于 y 则返回 y。

示例：

math.nextafter(x, math.inf) 的方向朝上：趋向于正无穷。

math.nextafter(x, -math.inf) 的方向朝下：趋向于负无穷。

math.nextafter(x, 0.0) 趋向于零。

math.nextafter(x, math.copysign(math.inf, x)) 趋向于零的反方向。

另请参阅 math.ulp()。

3.9 新版功能.

math.perm(n, k=None)

返回不重复且有顺序地从 n 项中选择 k 项的方式总数。

当 k <= n 时取值为 n! / (n - k)!；当 k > n 时取值为零。

如果 k 未指定或为 None，则 k 默认值为 n 并且函数将返回 n!。

如果任一参数不为整数则会引发 TypeError。 如果任一参数为负数则会引发 ValueError。

3.8 新版功能.

math.prod(iterable, *, start=1)

计算输入的 iterable 中所有元素的积。 积的默认 start 值为 1。

当可迭代对象为空时，返回起始值。 此函数特别针对数字值使用，并会拒绝非数字类型。

3.8 新版功能.

math.remainder(x, y)

返回 IEEE 754 风格的 x 相对于 y 的余数。对于有限 x 和有限非零 y ，这是差异 x - n*y ，其中 n 是与商 x / y 的精确值最接近的整数。如果 x / y 恰好位于两个连续整数之间，则将最接近的 偶数 用作 n 。 余数 r = remainder(x, y) 因此总是满足 abs(r) <= 0.5 * abs(y)。

特殊情况遵循IEEE 754：特别是 remainder(x, math.inf) 对于任何有限 x 都是 x ，而 remainder(x, 0) 和 remainder(math.inf, x) 引发 ValueError 适用于任何非NaN的 x 。如果余数运算的结果为零，则该零将具有与 x 相同的符号。

在使用IEEE 754二进制浮点的平台上，此操作的结果始终可以完全表示：不会引入舍入错误。

3.7 新版功能.

math.trunc(x)

返回去除小数部分的 x ，只留下整数部分。 这样就可以四舍五入到0了： trunc() 对于正的 x 相当于 floor() ，对于负的 x 相当于 ceil() 。如果 x 不是浮点数，委托给 x.__trunc__ ，它应该返回一个 Integral 值。

math.ulp(x)

返回浮点数 x 的最小有效比特位的值:

如果 x 是 NaN (非数字)，则返回 x。

如果 x 为负数，则返回 ulp(-x)。

如果 x 为正无穷，则返回 x。

如果 x 等于零，则返回 去正规化的 可表示最小正浮点数 (小于 正规化的 最小正浮点数 sys.float_info.min)。

如果 x 等于可表示最大正浮点数，则返回 x 的最低有效比特位的值，使得小于 x 的第一个浮点数为 x - ulp(x)。

在其他情况下 (x 是一个有限的正数)，则返回 x 的最低有效比特位的值，使得大于 x 的第一个浮点数为 x + ulp(x)。

ULP 即 "Unit in the Last Place" 的缩写。

另请参阅 math.nextafter() 和 sys.float_info.epsilon。

3.9 新版功能.

注意 frexp() 和 modf() 具有与它们的C等价函数不同的调用/返回模式：它们采用单个参数并返回一对值，而不是通过 '输出形参' 返回它们的第二个返回参数（Python中没有这样的东西）。

对于 ceil() ， floor() 和 modf() 函数，请注意 所有 足够大的浮点数都是精确整数。Python浮点数通常不超过53位的精度（与平台C double类型相同），在这种情况下，任何浮点 x 与 abs(x) >= 2**52 必然没有小数位。

幂函数与对数函数

math.exp(x)

返回 e 的 x 次幂，其中 e = 2.718281... 是自然对数的基数。这通常比 math.e ** x 或 pow(math.e, x) 更精确。

math.expm1(x)

返回 e 的 x 次幂，减1。这里 e 是自然对数的基数。对于小浮点数 x ， exp(x) - 1 中的减法可能导致 significant loss of precision [https://en.wikipedia.org/wiki/Loss_of_significance]； expm1() 函数提供了一种将此数量计算为全精度的方法:

>>> 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

3.2 新版功能.

math.log(x[, base])

使用一个参数，返回 x 的自然对数（底为 e ）。

使用两个参数，返回给定的 base 的对数 x ，计算为 log(x)/log(base) 。

math.log1p(x)

返回 1+x 的自然对数（以 e 为底）。 以对于接近零的 x 精确的方式计算结果。

math.log2(x)

返回 x 以2为底的对数。这通常比 log(x, 2) 更准确。

3.3 新版功能.

参见

int.bit_length() 返回表示二进制整数所需的位数，不包括符号和前导零。

math.log10(x)

返回 x 底为10的对数。这通常比 log(x, 10) 更准确。

math.pow(x, y)

将返回 x 的 y 次幂。特殊情况尽可能遵循C99标准的附录'F'。特别是， pow(1.0, x) 和 pow(x, 0.0) 总是返回 1.0 ，即使 x 是零或NaN。 如果 x 和 y 都是有限的， x 是负数， y 不是整数那么 pow(x, y) 是未定义的，并且引发 ValueError 。

与内置的 ** 运算符不同， math.pow() 将其参数转换为 float 类型。使用 ** 或内置的 pow() 函数来计算精确的整数幂。

math.sqrt(x)

返回 x 的平方根。

三角函数

math.acos(x)

返回以弧度为单位的 x 的反余弦值。 结果范围在 0 到 pi 之间。

math.asin(x)

返回以弧度为单位的 x 的反正弦值。 结果范围在 -pi/2 到 pi/2 之间。

math.atan(x)

返回以弧度为单位的 x 的反正切值。 结果范围在 -pi/2 到 pi/2 之间。.

math.atan2(y, x)

以弧度为单位返回 atan(y / x) 。结果是在 -pi 和 pi 之间。从原点到点 (x, y) 的平面矢量使该角度与正X轴成正比。 atan2() 的点的两个输入的符号都是已知的，因此它可以计算角度的正确象限。 例如， atan(1) 和 atan2(1, 1) 都是 pi/4 ，但 atan2(-1, -1) 是 -3*pi/4 。

math.cos(x)

返回 x 弧度的余弦值。

math.dist(p, q)

返回 p 与 q 两点之间的欧几里得距离，以一个坐标序列（或可迭代对象）的形式给出。 两个点必须具有相同的维度。

大致相当于：

sqrt(sum((px - qx) ** 2.0 for px, qx in zip(p, q)))

3.8 新版功能.

math.hypot(*coordinates)

返回欧几里得范数，sqrt(sum(x**2 for x in coordinates))。 这是从原点到坐标给定点的向量长度。

对于一个二维点 (x, y)，这等价于使用毕达哥拉斯定义 sqrt(x*x + y*y) 计算一个直角三角形的斜边。

在 3.8 版更改: 添加了对 n 维点的支持。 之前的版本只支持二维点。

在 3.10 版更改: 改进了算法的精确性，使得最大误差在 1 ulp (最后一位的单位数值) 以下。 更为常见的情况是，结果几乎总是能正确地舍入到 1/2 ulp 范围之内。

math.sin(x)

返回 x 弧度的正弦值。

math.tan(x)

返回 x 弧度的正切值。

角度转换

math.degrees(x)

将角度 x 从弧度转换为度数。

math.radians(x)

将角度 x 从度数转换为弧度。

双曲函数

双曲函数 [https://en.wikipedia.org/wiki/Hyperbolic_function] 是基于双曲线而非圆来对三角函数进行模拟。

math.acosh(x)

返回 x 的反双曲余弦值。

math.asinh(x)

返回 x 的反双曲正弦值。

math.atanh(x)

返回 x 的反双曲正切值。

math.cosh(x)

返回 x 的双曲余弦值。

math.sinh(x)

返回 x 的双曲正弦值。

math.tanh(x)

返回 x 的双曲正切值。

特殊函数

math.erf(x)

返回 x 处的 误差函数 [https://en.wikipedia.org/wiki/Error_function] 。

erf() 函数可用来计算传统的统计函数如 累计标准正态分布 [https://en.wikipedia.org/wiki/Normal_distribution#Cumulative_distribution_functions]:

def phi(x):
    'Cumulative distribution function for the standard normal distribution'
    return (1.0 + erf(x / sqrt(2.0))) / 2.0

3.2 新版功能.

math.erfc(x)

返回 x 处的互补误差函数。 互补误差函数 [https://en.wikipedia.org/wiki/Error_function] 定义为 1.0 - erf(x)。 它用于大的 x 取值，以避免直接用 1 减其误差函数值导致的 有效位数损失 [https://en.wikipedia.org/wiki/Loss_of_significance]。

3.2 新版功能.

math.gamma(x)

返回 x 处的 伽马函数 [https://en.wikipedia.org/wiki/Gamma_function] 值。

3.2 新版功能.

math.lgamma(x)

返回Gamma函数在 x 绝对值的自然对数。

3.2 新版功能.

常量

math.pi

数学常数 π = 3.141592...，精确到可用精度。

math.e

数学常数 e = 2.718281...，精确到可用精度。

math.tau

数学常数 τ = 6.283185...，精确到可用精度。Tau 是一个圆周常数，等于 2π，圆的周长与半径之比。更多关于 Tau 的信息可参考 Vi Hart 的视频 Pi is (still) Wrong [https://www.youtube.com/watch?v=jG7vhMMXagQ]。吃两倍多的派来庆祝 Tau 日 [https://tauday.com/] 吧！

3.6 新版功能.

math.inf

浮点正无穷大。 （对于负无穷大，使用 -math.inf 。）相当于 float('inf') 的输出。

3.5 新版功能.

math.nan

一个浮点的 "非数字"（NaN）值。相当于 float('nan') 的输出。 由于 IEEE-754标准 [https://en.wikipedia.org/wiki/IEEE_754] 的要求， math.nan 和 float('nan') 不被认为等于任何其他数值，包括其本身。要检查一个数字是否为NaN，请使用 isnan() 函数来测试 NaN ，而不是 is 或 == 。 例子:

>>> import math
>>> math.nan == math.nan
False
>>> float('nan') == float('nan')
False
>>> math.isnan(math.nan)
True
>>> math.isnan(float('nan'))
True

3.5 新版功能.

CPython 实现细节： math 模块主要包含围绕平台C数学库函数的简单包装器。特殊情况下的行为在适当情况下遵循C99标准的附录F。当前的实现将引发 ValueError 用于无效操作，如 sqrt(-1.0) 或 log(0.0) （其中C99附件F建议发出无效操作信号或被零除）， 和 OverflowError 用于溢出的结果（例如， exp(1000.0) ）。除非一个或多个输入参数是NaN，否则不会从上述任何函数返回NaN；在这种情况下，大多数函数将返回一个NaN，但是（再次遵循C99附件F）这个规则有一些例外，例如 pow(float('nan'), 0.0) 或 hypot(float('nan'), float('inf')) 。

请注意，Python不会将显式NaN与静默NaN区分开来，并且显式NaN的行为仍未明确。典型的行为是将所有NaN视为静默的。

参见

cmath 模块

这里很多函数的复数版本。

cmath --- 关于复数的数学函数

这一模块提供了一些关于复数的数学函数。 该模块的函数的参数为整数、浮点数或复数。 这些函数的参数也可为一个拥有 __complex__() 或 __float__() 方法的 Python 对象，这些方法分别用于将对象转换为复数和浮点数，这些函数作用于转换后的结果。

注解

对于涉及分支切割的函数，我们会有确定如何在切割本身上定义这些函数的问题。 根据 Kahan 的论文 "Branch cuts for complex elementary functions"，以及 C99 的附录 G 和之后的 C 标准，我们使用零符号来区别分支切割的一侧和另一侧：对于沿实轴（一部分）的分支切割我们要看虚部的符号，而对于沿虚轴的分支切割我们则要看实部的符号。

例如，cmath.sqrt() 函数有一个沿着负实轴的分支切割。 参数 complex(-2.0, -0.0) 会被当作位于切支切割的 下方 来处理，因而将给出一个负虚轴上的结果。

>>> cmath.sqrt(complex(-2.0, -0.0))
-1.4142135623730951j

但是参数 complex(-2.0, 0.0) 则会被当作是位于支割线的上方来处理:

>>> cmath.sqrt(complex(-2.0, 0.0))
1.4142135623730951j

到极坐标和从极坐标的转换

使用 矩形坐标 或 笛卡尔坐标 在内部存储 Python 复数 z。 这完全取决于它的 实部 z.real 和 虚部 z.imag。 换句话说:

z == z.real + z.imag*1j

极坐标 提供了另一种复数的表示方法。在极坐标中，一个复数 z 由模量 r 和相位角 phi 来定义。模量 r 是从 z 到坐标原点的距离，而相位角 phi 是以弧度为单位的，逆时针的，从正X轴到连接原点和 z 的线段间夹角的角度。

下面的函数可用于原生直角坐标与极坐标的相互转换。

cmath.phase(x)

将 x 的相位 (或称 x 的 参数) 作为一个浮点数返回。 phase(x) 等价于 math.atan2(x.imag, x.real)。 结果将位于 [-π, π] 范围内，且此操作的支割线将位于负实轴上。 结果的符号将与 x.imag 的符号相同，即使 x.imag 的值为零:

>>> phase(complex(-1.0, 0.0))
3.141592653589793
>>> phase(complex(-1.0, -0.0))
-3.141592653589793

注解

一个复数 x 的模数（绝对值）可以通过内置函数 abs() 计算。没有单独的 cmath 模块函数用于这个操作。

cmath.polar(x)

在极坐标中返回 x 的表达方式。返回一个数对 (r, phi)，r 是 x 的模数，phi 是 x 的相位角。 polar(x) 相当于 (abs(x), phase(x))。

cmath.rect(r, phi)

通过极坐标的 r 和 phi 返回复数 x。相当于 r * (math.cos(phi) + math.sin(phi)*1j)。

幂函数与对数函数

cmath.exp(x)

返回 e 的 x 次方，e 是自然对数的底数。

cmath.log(x[, base])

返回 x 的以 base 为底的对数。 如果没有指定 base，则返回 x 的自然对数。 存在一条支割线，即沿着负实轴从 0 到 -∞。

cmath.log10(x)

返回底数为 10 的 x 的对数。它具有与 log() 相同的支割线。

cmath.sqrt(x)

返回 x 的平方根。 它具有与 log() 相同的支割线。

三角函数

cmath.acos(x)

返回 x 的反余弦。 存在两条支割线：一条沿着实轴从 1 到 ∞。 另一条沿着实轴从 -1 向左延伸到 -∞。

cmath.asin(x)

返回 x 的反正弦。它与 acos() 有相同的支割线。

cmath.atan(x)

返回 x 的反正切。 存在两条支割线：一条沿着虚轴从 1j 延伸到 ∞j。 另一条沿着虚轴从 -1j 延伸到 -∞j。

cmath.cos(x)

返回 x 的余弦。

cmath.sin(x)

返回 x 的正弦。

cmath.tan(x)

返回 x 的正切。

双曲函数

cmath.acosh(x)

返回 x 的反双曲余弦。 存在一条支割线，沿着实轴从 1 向左延伸到 -∞。

cmath.asinh(x)

返回 x 的反双曲正弦。 存在两条支割线：一条沿着虚轴从 1j 延伸到 ∞j。 另一条沿着虚轴从 -1j 延伸到 -∞j。

cmath.atanh(x)

返回 x 反双曲正切。 存在两条支割线：一条沿着实轴从 1 延伸到 ∞。 另一条沿着实轴从 -1 延伸到 -∞。

cmath.cosh(x)

返回 x 的双曲余弦值。

cmath.sinh(x)

返回 x 的双曲正弦值。

cmath.tanh(x)

返回 x 的双曲正切值。

分类函数

cmath.isfinite(x)

如果 x 的实部和虚部都是有限的，则返回 True，否则返回 False。

3.2 新版功能.

cmath.isinf(x)

如果 x 的实部或者虚部是无穷大的，则返回 True，否则返回 False。

cmath.isnan(x)

如果 x 的实部或者虚部是 NaN，则返回 True ，否则返回 False。

cmath.isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0)

若 a 和 b 的值比较接近则返回 True，否则返回 False。

根据给定的绝对和相对容差确定两个值是否被认为是接近的。

rel_tol 是相对容差 —— 它是 a 和 b 之间允许的最大差值，相对于 a 或 b 的较大绝对值。例如，要设置5％的容差，请传递 rel_tol=0.05 。默认容差为 1e-09，确保两个值在大约9位十进制数字内相同。 rel_tol 必须大于零。

abs_tol 是最小绝对容差 —— 对于接近零的比较很有用。 abs_tol 必须至少为零。

如果没有错误发生，结果将是： abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol) 。

IEEE 754特殊值 NaN ， inf 和 -inf 将根据IEEE规则处理。具体来说， NaN 不被认为接近任何其他值，包括 NaN 。 inf 和 -inf 只被认为接近自己。

3.5 新版功能.

参见

PEP 485 [https://www.python.org/dev/peps/pep-0485] —— 用于测试近似相等的函数

常量

cmath.pi

数学常数 π ，作为一个浮点数。

cmath.e

数学常数 e ，作为一个浮点数。

cmath.tau

数学常数 τ ，作为一个浮点数。

3.6 新版功能.

cmath.inf

浮点正无穷大。相当于 float('inf')。

3.6 新版功能.

cmath.infj

具有零实部和正无穷虚部的复数。相当于 complex(0.0, float('inf'))。

3.6 新版功能.

cmath.nan

浮点“非数字”（NaN）值。相当于 float('nan')。

3.6 新版功能.

cmath.nanj

具有零实部和 NaN 虚部的复数。相当于 complex(0.0, float('nan'))。

3.6 新版功能.

请注意，函数的选择与模块 math 中的函数选择相似，但不完全相同。 拥有两个模块的原因是因为有些用户对复数不感兴趣，甚至根本不知道它们是什么。它们宁愿 math.sqrt(-1) 引发异常，也不想返回一个复数。 另请注意，被 cmath 定义的函数始终会返回一个复数，尽管答案可以表示为一个实数（在这种情况下，复数的虚数部分为零）。

关于支割线的注释：它们是沿着给定函数无法连续的曲线。它们是许多复变函数的必要特征。 假设您需要使用复变函数进行计算，您将会了解支割线的概念。 请参阅几乎所有关于复变函数的（不太基本）的书来获得启发。 对于如何正确地基于数值目的来选择支割线的相关信息，一个良好的参考如下：

参见

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.

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

源码： Lib/decimal.py [https://github.com/python/cpython/tree/3.10/Lib/decimal.py]

decimal 模块提供了对快速且正确舍入的十进制浮点运算的支持。 与 float 数据类型相比它具有以下优势:

Decimal 类型的“设计是基于考虑人类习惯的浮点数模型，并且因此具有以下最高指导原则 —— 计算机必须提供与人们在学校所学习的算术相一致的算术。” —— 摘自 decimal 算术规范描述。

Decimal 数字可以完全精确地表示。 相比之下，1.1 和 2.2 这样的数字在二进制浮点形式下没有精确的表示。 最终用户通常不希望 1.1 + 2.2 像在二进制浮点形式下那样被显示为 3.3000000000000003。

这样的精确性会延续到算术运算中。 对于 decimal 浮点数，0.1 + 0.1 + 0.1 - 0.3 会精确地等于零。 而对于二进制浮点数，结果则为 5.5511151231257827e-017。 虽然接近于零，但其中的误差将妨碍到可靠的相等性检测并且这样的误差还会不断累积。 因此，decimal 更适合具有严格相等不变性要求的会计类应用。

decimal 模块包含有效位的概念因而使得 1.30 + 1.20 等于 2.50。 末尾的零会被保留以表明有效位。 这是货币相关应用的惯例表示方式。 对于乘法，则按“教科书”方式来使用被乘数中的所有数位。 例如，1.3 * 1.2 结果为 1.56 而 1.30 * 1.20 结果为 1.5600。

与基于硬件的二进制浮点不同，十进制模块具有用户可更改的精度（默认为28位），可以与给定问题所需的一样大：

>>> from decimal import *
>>> getcontext().prec = 6
>>> Decimal(1) / Decimal(7)
Decimal('0.142857')
>>> getcontext().prec = 28
>>> Decimal(1) / Decimal(7)
Decimal('0.1428571428571428571428571429')

二进制和 decimal 浮点数都是根据已发布的标准实现的。 虽然内置浮点类型只公开其功能的一小部分，但 decimal 模块公开了标准的所有必需部分。 在需要时，程序员可以完全控制舍入和信号处理。 这包括通过使用异常来阻止任何不精确操作来强制执行精确算术的选项。

decimal 模块旨在支持“无偏差，精确无舍入的十进制算术（有时称为定点数算术）和有舍入的浮点数算术”。 —— 摘自 decimal 算术规范说明。

该模块的设计以三个概念为中心：decimal 数值，算术上下文和信号。

decimal 数值属于不可变对象。 它由一个符号、一个系数值及一个指数值组成。 为了保留有效位，系数值不会截去末尾的零。 decimal 数值还包括特殊值如 Infinity, -Infinity 和 NaN。 该标准还会区分 -0 和 +0。

算术的上下文是指定精度、舍入规则、指数限制、指示操作结果的标志以及确定符号是否被视为异常的陷阱启用器的环境。 舍入选项包括 ROUND_CEILING 、 ROUND_DOWN 、 ROUND_FLOOR 、 ROUND_HALF_DOWN, ROUND_HALF_EVEN 、 ROUND_HALF_UP 、 ROUND_UP 以及 ROUND_05UP.

信号是在计算过程中出现的异常条件组。 根据应用程序的需要，信号可能会被忽略，被视为信息，或被视为异常。 十进制模块中的信号有：Clamped 、 InvalidOperation 、 DivisionByZero 、 Inexact 、 Rounded 、 Subnormal 、 Overflow 、 Underflow 以及 FloatOperation 。

对于每个信号，都有一个标志和一个陷阱启动器。 遇到信号时，其标志设置为 1 ，然后，如果陷阱启用器设置为 1 ，则引发异常。 标志是粘性的，因此用户需要在监控计算之前重置它们。

参见

IBM 的通用十进制算术规范描述，The General Decimal Arithmetic Specification [https://speleotrove.com/decimal/decarith.html]。

快速入门教程

通常使用 decimal 的方式是先导入该模块，通过 getcontext() 查看当前上下文，并在必要时为精度、舍入或启用的陷阱设置新值:

>>> 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       # Set a new precision

Decimal 实例可以基于整数、字符串、浮点数或元组来构建。 基于整数或浮点数进行构建将执行该整数或浮点数值的精确转换。 Decimal 数字包括特殊值如代表“非数字”的 NaN，正的和负的 Infinity 以及 -0:

>>> 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')

如果 FloatOperation 信号被捕获，构造函数中的小数和浮点数的意外混合或排序比较会引发异常

>>> 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

3.3 新版功能.

新 Decimal 的重要性仅由输入的位数决定。 上下文精度和舍入仅在算术运算期间发挥作用。

>>> 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')

如果超出了 C 版本的内部限制，则构造一个 decimal 将引发 InvalidOperation

>>> Decimal("1e9999999999999999999")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]

在 3.3 版更改.

Decimal 数字能很好地与 Python 的其余部分交互。 以下是一个小小的 decimal 浮点数飞行马戏团：

>>> 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')

Decimal 也可以使用一些数学函数：

>>> 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')

quantize() 方法将舍入为固定的指数。 此方法对于将结果舍入到固定位置的货币应用程序来说很有用处:

>>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
Decimal('7.32')
>>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
Decimal('8')

如上所示，getcontext() 函数访问当前上下文并允许更改设置。 这种方法满足大多数应用程序的需求。

对于更高级的工作，使用 Context() 构造函数创建备用上下文可能很有用。 要使用备用活动，请使用 setcontext() 函数。

根据标准，decimal 模块提供了两个现成的标准上下文 BasicContext 和 ExtendedContext 。 前者对调试特别有用，因为许多陷阱都已启用：

>>> 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

上下文还具有用于监视计算期间遇到的异常情况的信号旗标。 这些旗标将保持设置直到被显式地清除，因此最好是通过使用 clear_flags() 方法来清除每组受监控的计算之前的旗标。

>>> 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=[])

flags 条目显示对 pi 的有理逼近被舍入（超出上下文精度的数字会被丢弃）并且结果是不精确的（某些被丢弃的数字为非零值）。

单个陷阱是使用上下文的 traps 属性中的字典来设置的:

>>> 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

大多数程序仅在程序开始时调整当前上下文一次。 并且，在许多应用程序中，数据在循环内单个强制转换为 Decimal 。 通过创建上下文集和小数，程序的大部分操作数据与其他 Python 数字类型没有区别。

Decimal 对象

class decimal.Decimal(value='0', context=None)

根据 value 构造一个新的 Decimal 对象。

value 可以是整数，字符串，元组，float ，或另一个 Decimal 对象。 如果没有给出 value，则返回 Decimal('0')。 如果 value 是一个字符串，它应该在前导和尾随空格字符以及下划线被删除之后符合十进制数字字符串语法:

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

当上面出现 digit 时也允许其他十进制数码。 其中包括来自各种其他语言系统的十进制数码（例如阿拉伯-印地语和天城文的数码）以及全宽数码 '\uff10' 到 '\uff19'。

如果 value 是一个 tuple，它应当有三个组成部分，一个符号 (0 表示正数 1 表示负数)，一个由数字组成的 tuple，以及一个整数指数值。 例如，Decimal((0, (1, 4, 1, 4), -3)) 将返回 Decimal('1.414')。

如果 value 是 float ，则二进制浮点值无损地转换为其精确的十进制等效值。 此转换通常需要53位或更多位数的精度。 例如， Decimal(float('1.1')) 转换为 Decimal('1.100000000000000088817841970012523233890533447265625')。

context 精度不会影响存储的位数。 这完全由 value 中的位数决定。 例如，Decimal('3.00000') 记录所有五个零，即使上下文精度只有三。

context 参数的目的是确定当 value 为错误格式的字符串时要怎么做。 如果上下文捕获了 InvalidOperation，将会引发异常；在其他情况下，构造器将返回一个值为 NaN 的新 Decimal。

构造完成后， Decimal 对象是不可变的。

在 3.2 版更改: 现在允许构造函数的参数为 float 实例。

在 3.3 版更改: float 参数在设置 FloatOperation 陷阱时引发异常。 默认情况下，陷阱已关闭。

在 3.6 版更改: 允许下划线进行分组，就像代码中的整数和浮点文字一样。

十进制浮点对象与其他内置数值类型共享许多属性，例如 float 和 int 。 所有常用的数学运算和特殊方法都适用。 同样，十进制对象可以复制、pickle、打印、用作字典键、用作集合元素、比较、排序和强制转换为另一种类型（例如 float 或 int ）。

算术对十进制对象和算术对整数和浮点数有一些小的差别。 当余数运算符 % 应用于Decimal对象时，结果的符号是 被除数 的符号，而不是除数的符号:

>>> (-7) % 4
1
>>> Decimal(-7) % Decimal(4)
Decimal('-3')

整数除法运算符 // 的行为类似，返回真商的整数部分（截断为零）而不是它的向下取整，以便保留通常的标识 x == (x // y) * y + x % y:

>>> -7 // 4
-2
>>> Decimal(-7) // Decimal(4)
Decimal('-1')

% 和 // 运算符实现了 remainder 和 divide-integer 操作（分别），如规范中所述。

十进制对象通常不能与浮点数或 fractions.Fraction 实例在算术运算中结合使用：例如,尝试将 Decimal 加到 float ，将引发 TypeError。 但是，可以使用 Python 的比较运算符来比较 Decimal 实例 x 和另一个数字 y 。 这样可以避免在对不同类型的数字进行相等比较时混淆结果。

在 3.2 版更改: 现在完全支持 Decimal 实例和其他数字类型之间的混合类型比较。

除了标准的数字属性，十进制浮点对象还有许多专门的方法：

adjusted()

在移出系数最右边的数字之后返回调整后的指数，直到只剩下前导数字：Decimal('321e+5').adjusted() 返回 7 。 用于确定最高有效位相对于小数点的位置。

as_integer_ratio()

返回一对 (n, d) 整数，表示给定的 Decimal 实例作为分数、最简形式项并带有正分母:

>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)

转换是精确的。 在 Infinity 上引发 OverflowError ，在 NaN 上引起 ValueError 。

3.6 新版功能.

as_tuple()

返回一个 named tuple 表示的数字： DecimalTuple(sign, digits, exponent)。

canonical()

返回参数的规范编码。 目前，一个 Decimal 实例的编码始终是规范的，因此该操作返回其参数不变。

compare(other, context=None)

比较两个 Decimal 实例的值。 compare() 返回一个 Decimal 实例，如果任一操作数是 NaN ，那么结果是 NaN

a or b is a NaN  ==> Decimal('NaN')
a < b            ==> Decimal('-1')
a == b           ==> Decimal('0')
a > b            ==> Decimal('1')

compare_signal(other, context=None)

除了所有 NaN 信号之外，此操作与 compare() 方法相同。 也就是说，如果两个操作数都不是信令NaN，那么任何静默的 NaN 操作数都被视为信令NaN。

compare_total(other, context=None)

使用它们的抽象表示而不是它们的数值来比较两个操作数。 类似于 compare() 方法，但结果给出了一个总排序 Decimal 实例。 两个 Decimal 实例具有相同的数值但不同的表示形式在此排序中比较不相等：

>>> Decimal('12.0').compare_total(Decimal('12'))
Decimal('-1')

静默和发出信号的 NaN 也包括在总排序中。 这个函数的结果是 Decimal('0') 如果两个操作数具有相同的表示，或是 Decimal('-1') 如果第一个操作数的总顺序低于第二个操作数，或是 Decimal('1') 如果第一个操作数在总顺序中高于第二个操作数。 有关总排序的详细信息，请参阅规范。

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。 作为例外，如果无法准确转换第二个操作数，则C版本可能会引发InvalidOperation。

compare_total_mag(other, context=None)

比较两个操作数使用它们的抽象表示而不是它们的值，如 compare_total()，但忽略每个操作数的符号。 x.compare_total_mag(y) 相当于 x.copy_abs().compare_total(y.copy_abs())。

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。 作为例外，如果无法准确转换第二个操作数，则C版本可能会引发InvalidOperation。

conjugate()

只返回self，这种方法只符合 Decimal 规范。

copy_abs()

返回参数的绝对值。 此操作不受上下文影响并且是静默的：没有更改标志且不执行舍入。

copy_negate()

回到参数的否定。 此操作不受上下文影响并且是静默的：没有标志更改且不执行舍入。

copy_sign(other, context=None)

返回第一个操作数的副本，其符号设置为与第二个操作数的符号相同。 例如：

>>> Decimal('2.3').copy_sign(Decimal('-1.5'))
Decimal('-2.3')

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。 作为例外，如果无法准确转换第二个操作数，则C版本可能会引发InvalidOperation。

exp(context=None)

返回给定数字的（自然）指数函数 e**x 的值。结果使用 ROUND_HALF_EVEN 舍入模式正确舍入。

>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal(321).exp()
Decimal('2.561702493119680037517373933E+139')

classmethod from_float(f)

另一个构造函数，只接受 float 或 int 的实例。

请注意 Decimal.from_float(0.1) 与 Decimal('0.1') 是不同的。 由于 0.1 不能以二进制浮点数精确表示，该值将被存储为最接受的可表示值 0x1.999999999999ap-4。 与其等价的十进制值为 0.1000000000000000055511151231257827021181583404541015625。

注解

从 Python 3.2 开始，Decimal 实例也可以直接从 float 构造。

>>> 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')

3.1 新版功能.

fma(other, third, context=None)

混合乘法加法。 返回 self*other+third ，中间乘积 self*other 没有舍入。

>>> Decimal(2).fma(3, 5)
Decimal('11')

is_canonical()

如果参数是规范的，则为返回 True，否则为 False 。 目前，Decimal 实例总是规范的，所以这个操作总是返回 True 。

is_finite()

如果参数是一个有限的数，则返回为 True ；如果参数为无穷大或 NaN ，则返回为 False。

is_infinite()

如果参数为正负无穷大，则返回为 True ，否则为 False 。

is_nan()

如果参数为 NaN （无论是否静默），则返回为 True ，否则为 False 。

is_normal(context=None)

如果参数是一个 标准的 有限数则返回 True。 如果参数为零、次标准数、无穷大或 NaN 则返回 False。

is_qnan()

如果参数为静默 NaN，返回 True，否则返回 False。

is_signed()

如果参数带有负号，则返回为 True，否则返回 False。注意，0 和 NaN 都可带有符号。

is_snan()

如果参数为显式 NaN，则返回 True，否则返回 False。

is_subnormal(context=None)

如果参数为次标准数，则返回 True，否则返回 False。

is_zero()

如果参数是0（正负皆可），则返回 True，否则返回 False。

ln(context=None)

返回操作数的自然对数（以 e 为底）。结果是使用 ROUND_HALF_EVEN 舍入模式正确舍入的。

log10(context=None)

返回操作数的以十为底的对数。结果是使用 ROUND_HALF_EVEN 舍入模式正确舍入的。

logb(context=None)

对于一个非零数，返回其运算数的调整后指数作为一个 Decimal 实例。 如果运算数为零将返回 Decimal('-Infinity') 并且产生 the DivisionByZero 标志。如果运算数是无限大则返回 Decimal('Infinity') 。

logical_and(other, context=None)

logical_and() 是需要两个 逻辑运算数 的逻辑运算（参考 逻辑操作数 ）。按位输出两运算数的 and 运算的结果。

logical_invert(context=None)

logical_invert() 是一个逻辑运算。结果是操作数的按位求反。

logical_or(other, context=None)

logical_or() 是需要两个 logical operands 的逻辑运算（请参阅 逻辑操作数 ）。结果是两个运算数的按位的 or 运算。

logical_xor(other, context=None)

logical_xor() 是需要两个 逻辑运算数 的逻辑运算（参考 逻辑操作数 ）。结果是按位输出的两运算数的异或运算。

max(other, context=None)

类似于 max(self, other) 只是上下文舍入规则是在返回之前被应用并且对于 NaN 值会发出信号或忽略（依赖于上下文以及它们是否要发送信号或保持静默）。

max_mag(other, context=None)

与 max() 方法相似，但是操作数使用绝对值完成比较。

min(other, context=None)

类似于 min(self, other) 只是上下文舍入规则是在返回之前被应用并且对于 NaN 值会发出信号或忽略（依赖于上下文以及它们是发出了信号还是保持静默）。

min_mag(other, context=None)

与 min() 方法相似，但是操作数使用绝对值完成比较。

next_minus(context=None)

返回小于给定操作数的上下文中可表示的最大数字（或者当前线程的上下文中的可表示的最大数字如果没有给定上下文）。

next_plus(context=None)

返回大于给定操作数的上下文中可表示的最小数字（或者当前线程的上下文中的可表示的最小数字如果没有给定上下文）。

next_toward(other, context=None)

如果两运算数不相等，返回在第二个操作数的方向上最接近第一个操作数的数。如果两操作数数值上相等，返回将符号设置为与第二个运算数相同的第一个运算数的拷贝。

normalize(context=None)

Normalize the number by stripping the rightmost trailing zeros and converting any result equal to Decimal('0') to Decimal('0e0'). Used for producing canonical values for attributes of an equivalence class. For example, Decimal('32.100') and Decimal('0.321000e+2') both normalize to the equivalent value Decimal('32.1').

number_class(context=None)

返回一个字符串描述运算数的 class 。返回值是以下十个字符串中的一个。

"-Infinity" ，指示运算数为负无穷大。

"-Normal" ，指示该运算数是负正常数字。

"-Subnormal" ，指示该运算数是负的次标准数。

"-Zero" ，指示该运算数是负零。

"-Zero" ，指示该运算数是正零。

"+Subnormal" ，指示该运算数是正的次标准数。

"+Normal" ，指示该运算数是正的标准数。

"+Infinity" ，指示该运算数是正无穷。

"NaN" ，指示该运算数是肃静 NaN （非数字）。

"sNaN" ，指示该运算数是信号 NaN 。

quantize(exp, rounding=None, context=None)

返回的值等于舍入后的第一个运算数并且具有第二个操作数的指数。

>>> Decimal('1.41421356').quantize(Decimal('1.000'))
Decimal('1.414')

与其他运算不同，如果量化运算后的系数长度大于精度，那么会发出一个 InvalidOperation 信号。这保证了除非有一个错误情况，量化指数恒等于右手运算数的指数。

与其他运算不同，量化永不信号下溢，即使结果不正常且不精确。

如果第二个运算数的指数大于第一个运算数的指数那或许需要舍入。在这种情况下，舍入模式由给定 rounding 参数决定，其余的由给定 context 参数决定；如果参数都未给定，使用当前线程上下文的舍入模式。

每当结果的指数大于 Emax 或小于 Etiny() 就将返回一个错误。

radix()

返回 Decimal(10)，即 Decimal 类进行所有算术运算所用的数制（基数）。 这是为保持与规范描述的兼容性而加入的。

remainder_near(other, context=None)

返回 self 除以 other 的余数。 这与 self % other 的区别在于所选择的余数要使其绝对值最小化。 更准确地说，返回值为 self - n * other 其中 n 是最接近 self / other 的实际值的整数，并且如果两个整数与实际值的差相等则会选择其中的偶数。

如果结果为零则其符号将为 self 的符号。

>>> Decimal(18).remainder_near(Decimal(10))
Decimal('-2')
>>> Decimal(25).remainder_near(Decimal(10))
Decimal('5')
>>> Decimal(35).remainder_near(Decimal(10))
Decimal('-5')

rotate(other, context=None)

返回对第一个操作数的数码按第二个操作数所指定的数量进行轮转的结果。 第二个操作数必须为 -precision 至 precision 精度范围内的整数。 第二个操作数的绝对值给出要轮转的位数。 如果第二个操作数为正值则向左轮转；否则向右轮转。 如有必要第一个操作数的系数会在左侧填充零以达到 precision 所指定的长度。 第一个操作数的符号和指数保持不变。

same_quantum(other, context=None)

检测自身与 other 是否具有相同的指数或是否均为 NaN。

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。 作为例外，如果无法准确转换第二个操作数，则C版本可能会引发InvalidOperation。

scaleb(other, context=None)

返回第一个操作数使用第二个操作数对指数进行调整的结果。 等价于返回第一个操作数乘以 10**other 的结果。 第二个操作数必须为整数。

shift(other, context=None)

返回第一个操作数的数码按第二个操作数所指定的数量进行移位的结果。 第二个操作数必须为 -precision 至 precision 范围内的整数。 第二个操作数的绝对值给出要移动的位数。 如果第二个操作数为正值则向左移位；否则向右移位。 移入系数的数码为零。 第一个操作数的符号和指数保持不变。

sqrt(context=None)

返回参数的平方根精确到完整精度。

to_eng_string(context=None)

转换为字符串，如果需要指数则会使用工程标注法。

工程标注法的指数是 3 的倍数。 这会在十进制位的左边保留至多 3 个数码，并可能要求添加一至两个末尾零。

例如，此方法会将 Decimal('123E+1') 转换为 Decimal('1.23E+3')。

to_integral(rounding=None, context=None)

与 to_integral_value() 方法相同。 保留 to_integral 名称是为了与旧版本兼容。

to_integral_exact(rounding=None, context=None)

舍入到最接近的整数，发出信号 Inexact 或者如果发生舍入则相应地发出信号 Rounded。 如果给出 rounding 形参则由其确定舍入模式，否则由给定的 context 来确定。 如果没有给定任何形参则会使用当前上下文的舍入模式。

to_integral_value(rounding=None, context=None)

舍入到最接近的整数而不发出 Inexact 或 Rounded 信号。 如果给出 rounding 则会应用其所指定的舍入模式；否则使用所提供的 context 或当前上下文的舍入方法。

逻辑操作数

logical_and(), logical_invert(), logical_or() 和 logical_xor() 方法均期望其参数为 逻辑操作数。 逻辑操作数 即指数位和符号位均为零，且其数字位均为 0 或 1 的 Decimal 实例。

上下文对象

上下文是算术运算所在的环境。 它们管理精度、设置舍入规则、确定将哪些信号视为异常，并限制指数的范围。

每个线程都有自己的当前上下文，可使用 getcontext() 和 setcontext() 函数来读取或修改：

decimal.getcontext()

返回活动线程的当前上下文。

decimal.setcontext(c)

将活动线程的当前上下文设为 c。

你也可以使用 with 语句和 localcontext() 函数来临时改变活动上下文。

decimal.localcontext(ctx=None)

返回一个上下文管理器，它将在进入 with 语句时将活动线程的当前上下文设为 ctx 的一个副本并在退出 with 语句时恢复之前的上下文。 如果未指定上下文，则会使用当前上下文的一个副本。

例如，以下代码会将当前 decimal 精度设为 42 位，执行一个运算，然后自动恢复之前的上下文:

from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # Perform a high precision calculation
    s = calculate_something()
s = +s  # Round the final result back to the default precision

新的上下文也可使用下述的 Context 构造器来创建。 此外，模块还提供了三种预设的上下文:

class decimal.BasicContext

这是由通用十进制算术规范描述所定义的标准上下文。 精度设为九。 舍入设为 ROUND_HALF_UP。 清除所有旗标。 启用所有陷阱（视为异常），但 Inexact, Rounded 和 Subnormal 除外。

由于启用了许多陷阱，此上下文适用于进行调试。

class decimal.ExtendedContext

这是由通用十进制算术规范描述所定义的标准上下文。 精度设为九。 舍入设为 ROUND_HALF_EVEN。 清除所有旗标。 不启用任何陷阱（因此在计算期间不会引发异常）。

由于禁用了陷阱，此上下文适用于希望结果值为 NaN 或 Infinity 而不是引发异常的应用程序。 这允许应用程序在出现当其他情况下会中止程序的条件时仍能完成运行。

class decimal.DefaultContext

此上下文被 Context 构造器用作新上下文的原型。 改变一个字段（例如精度）的效果将是改变 Context 构造器所创建的新上下文的默认值。

此上下文最适用于多线程环境。 在线程开始前改变一个字段具有设置全系统默认值的效果。 不推荐在线程开始后改变字段，因为这会要求线程同步避免竞争条件。

在单线程环境中，最好完全不使用此上下文。 而是简单地电显式创建上下文，具体如下所述。

默认值为 Context.prec=28, Context.rounding=ROUND_HALF_EVEN，并为 Overflow, InvalidOperation 和 DivisionByZero 启用陷阱。

在已提供的三种上下文之外，还可以使用 Context 构造器创建新的上下文。

class decimal.Context(prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)

创建一个新上下文。 如果某个字段未指定或为 None，则从 DefaultContext 拷贝默认值。 如果 flags 字段未指定或为 None，则清空所有旗标。

prec 是一个用于设置该上下文中算术运算的精度的 [1, MAX_PREC] 范围内的整数。

rounding 选项应为 Rounding Modes 小节中列出的常量之一。

traps 和 flags 字段列出要设置的任何信号。 通常，新上下文应当只设置 traps 而让 flags 为空。

Emin 和 Emax 字段是指定指数所允许的外部上限的整数。 Emin 必须在 [MIN_EMIN, 0] 范围内，Emax 必须在 [0, MAX_EMAX] 范围内。

capitals 字段为 0 或 1 (默认值)。 如果设为 1，指数将附带大写的 E 打印出来；在其他情况下将使用小写的 e: Decimal('6.02e+23')。

clamp 字段为 0 (默认值) 或 1。 如果设为 1，则 Decimal 实例的指数 e 的表示范围在此上下文中将严格限制在 Emin - prec + 1 <= e <= Emax - prec + 1 范围内。 如果 clamp 为 0 则将适用较弱的条件：调整后的 Decimal 实例指数最大值为 Emax。 当 clamp 为 1 时，一个较大的普通数值将在可能的情况下减小其指数并为其系数添加相应数量的零，以便符合指数值限制；这可以保留数字值但会丢失有效末尾零的信息。 例如:

>>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
Decimal('1.23000E+999')

将 clamp 值设为 1 即允许与 IEEE 754 所描述的固定宽度十进制交换格式保持兼容性。

Context 类定义了几种通用方法以及大量直接在给定上下文中进行算术运算的方法。 此外，对于上述的每种 Decimal 方法（除了 adjusted() 和 as_tuple() 方法）都有一个对应的 Context 方法。 例如，对于一个 Context 的实例 C 和 Decimal 的实例 x，C.exp(x) 就等价于 x.exp(context=C)。 每个 Context 方法都接受一个 Python 整数（即 int 的实例）在任何接受 Decimal 实例的地方使用。

clear_flags()

将所有旗标重置为 0。

clear_traps()

将所有陷阱重置为 0。

3.3 新版功能.

copy()

返回上下文的一个副本。

copy_decimal(num)

返回 Decimal 实例 num 的一个副本。

create_decimal(num)

基于 num 创建一个新 Decimal 实例但使用 self 作为上下文。 与 Decimal 构造器不同，该上下文的精度、舍入方法、旗标和陷阱会被应用于转换过程。

此方法很有用处，因为常量往往被给予高于应用所需的精度。 另一个好处在于立即执行舍入可以消除超出当前精度的数位所导致的意外效果。 在下面的示例中，使用未舍入的输入意味着在总和中添加零会改变结果：

>>> getcontext().prec = 3
>>> Decimal('3.4445') + Decimal('1.0023')
Decimal('4.45')
>>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
Decimal('4.44')

此方法实现了 IBM 规格描述中的转换为数字操作。 如果参数为字符串，则不允许有开头或末尾的空格或下划线。

create_decimal_from_float(f)

基于浮点数 f 创建一个新的 Decimal 实例，但会使用 self 作为上下文来执行舍入。 与 Decimal.from_float() 类方法不同，上下文的精度、舍入方法、旗标和陷阱会应用到转换中。

>>> 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

3.1 新版功能.

Etiny()

返回一个等于 Emin - prec + 1 的值即次标准化结果中的最小指数值。 当发生向下溢出时，指数会设为 Etiny。

Etop()

返回一个等于 Emax - prec + 1 的值。

使用 decimal 的通常方式是创建 Decimal 实例然后对其应用算术运算,这些运算发生在活动线程的当前上下文中。 一种替代方式则是使用上下文的方法在特定上下文中进行计算。 这些方法类似于 Decimal 类的方法，在此仅简单地重新列出。

abs(x)

返回 x 的绝对值。

add(x, y)

返回 x 与 y 的和。

canonical(x)

返回相同的 Decimal 对象 x。

compare(x, y)

对 x 与 y 进行数值比较。

compare_signal(x, y)

对两个操作数进行数值比较。

compare_total(x, y)

对两个操作数使用其抽象表示进行比较。

compare_total_mag(x, y)

对两个操作数使用其抽象表示进行比较，忽略符号。

copy_abs(x)

返回 x 的副本，符号设为 0。

copy_negate(x)

返回 x 的副本，符号取反。

copy_sign(x, y)

从 y 拷贝符号至 x。

divide(x, y)

返回 x 除以 y 的结果。

divide_int(x, y)

返回 x 除以 y 的结果，截短为整数。

divmod(x, y)

两个数字相除并返回结果的整数部分。

exp(x)

返回 e ** x。

fma(x, y, z)

返回 x 乘以 y 再加 z 的结果。

is_canonical(x)

如果 x 是规范的则返回 True；否则返回 False。

is_finite(x)

如果 x 为有限的则返回 True；否则返回 False。

is_infinite(x)

如果 x 是无限的则返回 True；否则返回 False。

is_nan(x)

如果 x 是 qNaN 或 sNaN 则返回 True；否则返回 False。

is_normal(x)

如果 x 是标准数则返回 True；否则返回 False。

is_qnan(x)

如果 x 是静默 NaN 则返回 True；否则返回 False。

is_signed(x)

x 是负数则返回 True；否则返回 False。

is_snan(x)

如果 x 是显式 NaN 则返回 True；否则返回 False。

is_subnormal(x)

如果 x 是次标准数则返回 True；否则返回 False。

is_zero(x)

如果 x 为零则返回 True；否则返回 False。

ln(x)

返回 x 的自然对数（以 e 为底）。

log10(x)

返回 x 的以 10 为底的对数。

logb(x)

返回操作数的 MSD 等级的指数。

logical_and(x, y)

在操作数的每个数位间应用逻辑运算 and。

logical_invert(x)

反转 x 中的所有数位。

logical_or(x, y)

在操作数的每个数位间应用逻辑运算 or。

logical_xor(x, y)

在操作数的每个数位间应用逻辑运算 xor。

max(x, y)

对两个值执行数字比较并返回其中的最大值。

max_mag(x, y)

对两个值执行忽略正负号的数字比较。

min(x, y)

对两个值执行数字比较并返回其中的最小值。

min_mag(x, y)

对两个值执行忽略正负号的数字比较。

minus(x)

对应于 Python 中的单目前缀取负运算符执行取负操作。

multiply(x, y)

返回 x 和 y 的积。

next_minus(x)

返回小于 x 的最大数字表示形式。

next_plus(x)

返回大于 x 的最小数字表示形式。

next_toward(x, y)

返回 x 趋向于 y 的最接近的数字。

normalize(x)

将 x 改写为最简形式。

number_class(x)

返回 x 的类的表示。

plus(x)

对应于 Python 中的单目前缀取正运算符执行取正操作。 此操作将应用上下文精度和舍入，因此它 不是 标识运算。

power(x, y, modulo=None)

返回 x 的 y 次方，如果给出了模数 modulo 则取其余数。

传入两个参数时，计算 x**y。 如果 x 为负值则 y 必须为整数。 除非 y 为整数且结果为有限值并可在 'precision' 位内精确表示否则结果将是不精确的。 所在上下文的舍入模式将被使用。 结果在 Python 版中总是会被正确地舍入。

Decimal(0) ** Decimal(0) 结果为 InvalidOperation，而如果 InvalidOperation 未被捕获，则结果为 Decimal('NaN')。

在 3.3 版更改: C 模块计算 power() 时会使用已正确舍入的 exp() 和 ln() 函数。 结果是有良好定义的但仅限于“几乎总是正确舍入”。

带有三个参数时，计算 (x**y) % modulo。 对于三个参数的形式，参数将会应用以下限制：

三个参数必须都是整数

y 必须是非负数

x 或 y 至少有一个不为零

modulo 必须不为零且至多有 'precision' 位

来自 Context.power(x, y, modulo) 的结果值等于使用无限精度计算 (x**y) % modulo 所得到的值，但其计算过程更高效。 结果的指数为零，无论 x, y 和 modulo 的指数是多少。 结果值总是完全精确的。

quantize(x, y)

返回的值等于 x (舍入后)，并且指数为 y。

radix()

恰好返回 10，因为这是 Decimal 对象 :)

remainder(x, y)

返回整除所得到的余数。

结果的符号，如果不为零，则与原始除数的符号相同。

remainder_near(x, y)

返回 x - y * n，其中 n 为最接近 x / y 实际值的整数（如结果为 0 则其符号将与 x 的符号相同）。

rotate(x, y)

返回 x 翻转 y 次的副本。

same_quantum(x, y)

如果两个操作数具有相同的指数则返回 True。

scaleb(x, y)

返回第一个操作数添加第二个值的指数后的结果。

shift(x, y)

返回 x 变换 y 次的副本。

sqrt(x)

非负数基于上下文精度的平方根。

subtract(x, y)

返回 x 和 y 的差。

to_eng_string(x)

转换为字符串，如果需要指数则会使用工程标注法。

工程标注法的指数是 3 的倍数。 这会在十进制位的左边保留至多 3 个数码，并可能要求添加一至两个末尾零。

to_integral_exact(x)

舍入到一个整数。

to_sci_string(x)

使用科学计数法将一个数字转换为字符串。

常量

本节中的常量仅与 C 模块相关。 它们也被包含在纯 Python 版本以保持兼容性。

| 32位 | 64位
decimal.MAX_PREC | 425000000 | 999999999999999999
decimal.MAX_EMAX | 425000000 | 999999999999999999
decimal.MIN_EMIN | -425000000 | -999999999999999999
decimal.MIN_ETINY | -849999999 | -1999999999999999997

decimal.HAVE_THREADS

该值为 True。 已弃用，因为 Python 现在总是启用线程。

3.9 版后已移除.

decimal.HAVE_CONTEXTVAR

默认值为 True。 如果 Python 编译版本 使用了 --without-decimal-contextvar 选项来配置，则 C 版本会使用线程局部而非协程局部上下文并且该值为 False。 这在某些嵌套上下文场景中将会稍快一些。

3.9 新版功能: 向下移植到 3.7 和 3.8。

舍入模式

decimal.ROUND_CEILING

舍入方向为 Infinity。

decimal.ROUND_DOWN

舍入方向为零。

decimal.ROUND_FLOOR

舍入方向为 -Infinity。

decimal.ROUND_HALF_DOWN

舍入到最接近的数，同样接近则舍入方向为零。

decimal.ROUND_HALF_EVEN

舍入到最接近的数，同样接近则舍入到最接近的偶数。

decimal.ROUND_HALF_UP

舍入到最接近的数，同样接近则舍入到零的反方向。

decimal.ROUND_UP

舍入到零的反方向。

decimal.ROUND_05UP

如果最后一位朝零的方向舍入后为 0 或 5 则舍入到零的反方向；否则舍入方向为零。

信号

信号代表在计算期间引发的条件。 每个信号对应于一个上下文旗标和一个上下文陷阱启用器。

上下文旗标将在遇到特定条件时被设定。 在完成计算之后，将为了获得信息而检测旗标（例如确定计算是否精确）。 在检测旗标后，请确保在开始下一次计算之前清除所有旗标。

如果为信号设定了上下文的陷阱启用器，则条件会导致特定的 Python 异常被引发。 举例来说，如果设定了 DivisionByZero 陷阱，则当遇到此条件时就将引发 DivisionByZero 异常。

class decimal.Clamped

修改一个指数以符合表示限制。

通常，限位将在一个指数值超出上下文的 Emin 和 Emax 限制时发生。 在可能的情况下，会通过向系数添加零来将指数缩减至符合限制。

class decimal.DecimalException

其他信号的基类，并且也是 ArithmeticError 的一个子类。

class decimal.DivisionByZero

非无限数被零除的信号。

可在除法、取余除法或对一个数执行负数次幂运算时发生。 如果此信号未被陷阱捕获，则返回 Infinity 或 -Infinity 并由对计算的输入来确定正负符号。

class decimal.Inexact

表明发生了舍入且结果是不精确的。

有非零数位在舍入期间被丢弃的信号。 舍入结果将被返回。 此信号旗标或陷阱被用于检测结果不精确的情况。

class decimal.InvalidOperation

执行了一个无效的操作。

表明请求了一个无意义的运算。 如果未被捕获，则返回 NaN。 可能的原因包括:

Infinity - Infinity
0 * Infinity
Infinity / Infinity
x % 0
Infinity % x
sqrt(-x) and x > 0
0 ** 0
x ** (non-integer)
x ** Infinity

class decimal.Overflow

数值的溢出。

表明在发生舍入之后指数值大于 Context.Emax。 如果未被捕获，则结果将取决于舍入模式，或是向下舍入为最大的可表示有限数值，或是向上舍入为 Infinity。 无论是哪种情况，都将发出 Inexact 和 Rounded 信号。

class decimal.Rounded

发生了舍入，但或许并没有信息丢失。

一旦舍入操作丢弃了数位就会发出此信号；即使被丢弃的数位是零（如将 5.00 舍入到 5.0 的情况）。 如果未被捕获，则不加修改地返回结果。 此信号用于检测有效位数的丢弃。

class decimal.Subnormal

在舍入之前指数值低于 Emin。

当操作结果是次标准数（即指数过小）时就会发出此信号。 如果未被陷阱捕获，则不经修改过返回结果。

class decimal.Underflow

数字向下溢出导致结果舍入到零。

当一个次标准数结果通过舍入转为零时就会发出此信号。 同时还将引发 Inexact 和 Subnormal 信号。

class decimal.FloatOperation

为 float 和 Decimal 的混合启用更严格的语义。

如果信号未被捕获（默认），则在 Decimal 构造器、create_decimal() 和所有比较运算中允许 float 和 Decimal 的混合。 转换和比较都是完全精确的。 发生的任何混合运算都将通过在上下文旗标中设置 FloatOperation 来静默地记录。 通过 from_float() 或 create_decimal_from_float() 进行显式转换则不会设置旗标。

在其他情况下（即信号被捕获），则只静默执行相等性比较和显式转换。 所有其他混合运算都将引发 FloatOperation。

以下表格总结了信号的层级结构:

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)

浮点数说明

通过提升精度来解决舍入错误

使用 decimal 浮点数可以消除十进制表示错误（即能够精确地表示 0.1 这样的数）；然而，某些运算在非零数位超出了给定的精度时仍然可能导至舍入错误。

舍入错误的影响可能因接近相互抵销的加减运算被放大从而导致丢失有效位。 Knuth 提供了两个指导性示例，其中出现了精度不足的浮点算术舍入，导致加法的交换律和分配律被打破：

# Examples from 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')

decimal 模块则可以通过充分地扩展精度来避免有效位的丢失：

>>> 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')

特殊的值

decimal 模块的数字系统提供了一些特殊的值包括 NaN, sNaN, -Infinity, Infinity, 和两种零值，+0 和 -0。

无穷大可以使用 Decimal('Infinity') 来构建。 它们也可以在不捕获 DivisionByZero 信号捕获时通过除以零来产生。 类似地，当不捕获 Overflow 信号时，也可以通过舍入到超出最大可表示数字限制的方式产生无穷大的结果。

无穷大是有符号的（仿射）并可用于算术运算，它们会被当作极其巨大的不确定数字来处理。 例如，无穷大加一个常量结果也将为无穷大。

某些运算没有确定的结果并将返回 NaN，或者如果捕获了 InvalidOperation 信号，则会引发一个异常。 例如，0/0 将返回 NaN 表示 "not a number"。 这样的 NaN 将静默产生，并且一旦产生就将在参与其他运算时始终得到 NaN 的结果。 这种行为对于偶尔缺少输入的各类计算都很有用处 --- 它允许在将特定结果标记为无效的同时让计算继续进行。

一种变体形式是 sNaN，它在每次运算后会发出信号而不是保持静默。 当对于无效结果需要中断计算进行特别处理时这是一个很有用的返回值。

Python 中比较运算符的行为在涉及 NaN 时可能会令人有点惊讶。 相等性检测在操作数中有静默型或信号型 NaN 时总是会返回 False (即使是执行 Decimal('NaN')==Decimal('NaN'))，而不等性检测总是会返回 True。 当尝试使用 <, <=, > 或 >= 运算符中的任何一个来比较两个 Decimal 值时，如果运算数中有 NaN 则将引发 InvalidOperation 信号，如果此信号未被捕获则将返回 False。 请注意通用十进制算术规范并未规定直接比较行为；这些涉及 NaN 的比较规则来自于 IEEE 854 标准 (见第 5.7 节表 3)。 要确保严格符合标准，请改用 compare() 和 compare_signal() 方法。

有符号零值可以由向下溢出的运算产生。 它们保留符号是为了让运算结果能以更高的精度传递。 由于它们的大小为零，正零和负零会被视为相等，且它们的符号具有信息。

在这两个不相同但却相等的有符号零之外，还存在几种零的不同表示形式，它们的精度不同但值也都相等。 这需要一些时间来逐渐适应。 对于习惯了标准浮点表示形式的眼睛来说，以下运算返回等于零的值并不是显而易见的：

>>> 1 / Decimal('Infinity')
Decimal('0E-1000026')

使用线程

getcontext() 函数会为每个线程访问不同的 Context 对象。 具有单独线程上下文意味着线程可以修改上下文 (例如 getcontext().prec=10) 而不影响其他线程。

类似的 setcontext() 会为当前上下文的目标自动赋值。

如果在调用 setcontext() 之前调用了 getcontext()，则 getcontext() 将自动创建一个新的上下文在当前线程中使用。

新的上下文拷贝自一个名为 DefaultContext 的原型上下文。 要控制默认值以便每个线程在应用运行期间都使用相同的值，可以直接修改 DefaultContext 对象。 这应当在任何线程启动 之前 完成以使得调用 getcontext() 的线程之间不会产生竞争条件。 例如:

# Set applicationwide defaults for all threads about to be launched
DefaultContext.prec = 12
DefaultContext.rounding = ROUND_DOWN
DefaultContext.traps = ExtendedContext.traps.copy()
DefaultContext.traps[InvalidOperation] = 1
setcontext(DefaultContext)

# Afterwards, the threads can be started
t1.start()
t2.start()
t3.start()
 . . .

例程

以下是一些用作工具函数的例程，它们演示了使用 Decimal 类的各种方式:

def moneyfmt(value, places=2, curr='', sep=',', dp='.',
             pos='', neg='-', trailneg=''):
    """Convert Decimal to a money formatted string.

    places:  required number of places after the decimal point
    curr:    optional currency symbol before the sign (may be blank)
    sep:     optional grouping separator (comma, period, space, or blank)
    dp:      decimal point indicator (comma or period)
             only specify as blank when places is zero
    pos:     optional sign for positive numbers: '+', space or blank
    neg:     optional sign for negative numbers: '-', '(', space or blank
    trailneg:optional trailing minus indicator:  '-', ')', space or blank

    >>> d = Decimal('-1234567.8901')
    >>> moneyfmt(d, curr='$')
    '-$1,234,567.89'
    >>> moneyfmt(d, places=0, sep='.', dp='', neg='', 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 places --> '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 ''.join(reversed(result))

def pi():
    """Compute Pi to the current precision.

    >>> print(pi())
    3.141592653589793238462643383

    """
    getcontext().prec += 2  # extra digits for intermediate steps
    three = Decimal(3)      # substitute "three=3.0" for regular floats
    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               # unary plus applies the new precision

def exp(x):
    """Return e raised to the power of x.  Result type matches input type.

    >>> 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):
    """Return the cosine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute 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):
    """Return the sine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute 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

Decimal 常见问题

Q. 总是输入 decimal.Decimal('1234.5') 是否过于笨拙。 在使用交互解释器时有没有最小化输入量的方式？

A. 有些用户会将构造器简写为一个字母：

>>> D = decimal.Decimal
>>> D('1.23') + D('3.45')
Decimal('4.68')

Q. 在带有两个十进制位的定点数应用中，有些输入值具有许多位，需要被舍入。 另一些数则不应具有多余位，需要验证有效性。 这种情况应该用什么方法？

A. 用 quantize() 方法舍入到固定数目的十进制位。 如果设置了 Inexact 陷阱，它也适用于验证有效性:

>>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')

>>> # Round to two places
>>> Decimal('3.214').quantize(TWOPLACES)
Decimal('3.21')

>>> # Validate that a number does not exceed two places
>>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Decimal('3.21')

>>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Traceback (most recent call last):
   ...
Inexact: None

Q. 当我使用两个有效位的输入时，我要如何在一个应用中保持有效位不变？

A. 某些运算如与整数相加、相减和相乘将会自动保留固定的小数位数。 其他运算，如相除和非整数相乘则会改变小数位数，需要再加上 quantize() 处理步骤:

>>> 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')

在开发定点数应用时，更方便的做法是定义处理 quantize() 步骤的函数:

>>> def mul(x, y, fp=TWOPLACES):
...     return (x * y).quantize(fp)
>>> def div(x, y, fp=TWOPLACES):
...     return (x / y).quantize(fp)

>>> mul(a, b)                       # Automatically preserve fixed-point
Decimal('325.62')
>>> div(b, a)
Decimal('0.03')

Q. 表示同一个值有许多方式。 数字 200, 200.000, 2E2 和 .02E+4 都具有相同的值但其精度不同。 是否有办法将它们转换为一个可识别的规范值？

A. normalize() 方法可将所有相等的值映射为单一表示形式:

>>> 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')]

Q. 有些十进制值总是被打印为指数表示形式。 是否有办法得到一个非指数表示形式？

A. 对于某些值来说，指数表示法是表示系数中有效位的唯一方式。 例如，将 5.0E+3 表示为 5000 可以让值保持恒定但是无法显示原本的两位有效位。

如果一个应用不必关心追踪有效位，则可以很容易地移除指数和末尾的零，丢弃有效位但让值保持不变：

>>> def remove_exponent(d):
...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()

>>> remove_exponent(Decimal('5E+3'))
Decimal('5000')

Q. 是否有办法将一个普通浮点数转换为 Decimal？

A. 是的，任何二进制浮点数都可以精确地表示为 Decimal 值，但完全精确的转换可能需要比平常感觉更高的精度：

>>> Decimal(math.pi)
Decimal('3.141592653589793115997963468544185161590576171875')

Q. 在一个复杂的计算中，我怎样才能保证不会得到由精度不足和舍入异常所导致的虚假结果。

A. 使用 decimal 模块可以很容易地检测结果。 最好的做法是使用更高的精度和不同的舍入模式重新进行计算。 明显不同的结果表明存在精度不足、舍入模式问题、不符合条件的输入或是结果不稳定的算法。

Q. 我发现上下文精度的应用只针对运算结果而不针对输入。在混合使用不同精度的值时有什么需要注意的吗？

A. 是的。 原则上所有值都会被视为精确值，在这些值上进行的算术运算也是如此。 只有结果会被舍入。 对于输入来说其好处是“所输入即所得”。 而其缺点则是如果你忘记了输入没有被舍入，结果看起来可能会很奇怪：

>>> getcontext().prec = 3
>>> Decimal('3.104') + Decimal('2.104')
Decimal('5.21')
>>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
Decimal('5.20')

解决办法是提高精度或使用单目加法运算对输入执行强制舍入：

>>> getcontext().prec = 3
>>> +Decimal('1.23456789')      # unary plus triggers rounding
Decimal('1.23')

此外，还可以使用 Context.create_decimal() 方法在创建输入时执行舍入：

>>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
Decimal('1.2345')

Q. CPython 实现对于巨大数字是否足够快速？

A. 是的。 在 CPython 和 PyPy3 实现中，decimal 模块的 C/CFFI 版本集成了高速 libmpdec [https://www.bytereef.org/mpdecimal/doc/libmpdec/index.html] 库用于实现任意精度正确舍入的十进制浮点算术 1。 libmpdec 会对中等大小的数字使用 Karatsuba 乘法 [https://en.wikipedia.org/wiki/Karatsuba_algorithm] 而对非常巨大的数字使用 数字原理变换 [https://en.wikipedia.org/wiki/Discrete_Fourier_transform_(general)#Number-theoretic_transform]。

上下文必须针对任意精度算术进行适配。 Emin 和 Emax 应当总是被设为最大值，clamp 应当总是为 0 (默认值)。 设置 prec 需要十分谨慎。requires some care.

进行大数字算术的最便捷方式同样是使用 prec 的最大值 2:

>>> setcontext(Context(prec=MAX_PREC, Emax=MAX_EMAX, Emin=MIN_EMIN))
>>> x = Decimal(2) ** 256
>>> x / 128
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')

对于不精确的结果，在 64 位平台上 MAX_PREC 的值太大了，可用的内存将会不足:

>>> Decimal(1) / 3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
MemoryError

在具有超量分配的系统上 (如 Linux)，一种更复杂的方式是根据可用的 RAM 大小来调整 prec。 假设你有 8GB 的 RAM 并期望同时有 10 个操作数，每个最多使用 500MB:

>>> import sys
>>>
>>> # Maximum number of digits for a single operand using 500MB in 8-byte words
>>> # with 19 digits per word (4-byte and 9 digits for the 32-bit build):
>>> maxdigits = 19 * ((500 * 1024**2) // 8)
>>>
>>> # Check that this works:
>>> c = Context(prec=maxdigits, Emax=MAX_EMAX, Emin=MIN_EMIN)
>>> c.traps[Inexact] = True
>>> setcontext(c)
>>>
>>> # Fill the available precision with nines:
>>> 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'>]

总体而言（特别是在没有超量分配的系统上），如果期望所有计算都是精确的则推荐预估更严格的边界并设置 Inexact 陷阱。

1

3.3 新版功能.

2

在 3.9 版更改: 此方式现在适用于除了非整数乘方以外的所有精确结果。

fractions --- 分数

源代码 Lib/fractions.py [https://github.com/python/cpython/tree/3.10/Lib/fractions.py]

fractions 模块支持分数运算。

分数实例可以由一对整数，一个分数，或者一个字符串构建而成。

class fractions.Fraction(numerator=0, denominator=1)

class fractions.Fraction(other_fraction)

class fractions.Fraction(float)

class fractions.Fraction(decimal)

class fractions.Fraction(string)

第一个版本要求 numerator 和 denominator 是 numbers.Rational 的实例，并返回一个新的 Fraction 实例，其值为 numerator/denominator。 如果 denominator 为 0 将会引发 ZeroDivisionError。 第二个版本要求 other_fraction 是 numbers.Rational 的实例，并返回一个 Fraction 实例且与传入值相等。 下两个版本接受 float 或 decimal.Decimal 的实例，并返回一个 Fraction 实例且与传入值完全相等。 请注意由于二进制浮点数通常存在的问题 (参见 浮点算术：争议和限制)，Fraction(1.1) 的参数并不会精确等于 11/10，因此 Fraction(1.1) 也 不会 返回用户所期望的 Fraction(11, 10)。 （请参阅下文中 limit_denominator() 方法的文档。） 构造器的最后一个版本接受一个字符串或 unicode 实例。 此实例的通常形式为:

[sign] numerator ['/' denominator]

其中的可选项 sign 可以为 '+' 或 '-' 并且 numerator 和 denominator (如果存在) 是十进制数码的字符串。 此外，float 构造器所接受的任何表示一个有限值的字符串也都为 Fraction 构造器所接受。 不论哪种形式的输入字符串也都可以带有前缀和/或后缀的空格符。 这里是一些示例:

>>> 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)

Fraction 类继承自抽象基类 numbers.Rational，并实现了该类的所有方法和操作。 Fraction 实例是 hashable 对象，并应当被视为不可变对象。 此外，Fraction 还具有以下特征属性和方法:

在 3.2 版更改: Fraction 构造器现在接受 float 和 decimal.Decimal 实例。

在 3.9 版更改: 现在会使用 math.gcd() 函数来正规化 numerator 和 denominator。 math.gcd() 总是返回 int 类型。 在之前版本中，GCD 的类型取决于 numerator 和 denominator 的类型。

numerator

最简分数形式的分子。

denominator

最简分数形式的分母。

as_integer_ratio()

返回由两个整数组成的元组，两数之比等于该分数的值且其分母为正数。

3.8 新版功能.

classmethod from_float(flt)

只接受 float 或 numbers.Integral 实例的替代性构造器。 请注意 Fraction.from_float(0.3) 与 Fraction(3, 10) 的值是不同的。

注解

从 Python 3.2 开始，在构造 Fraction 实例时可以直接使用 float。

classmethod from_decimal(dec)

只接受 decimal.Decimal 或 numbers.Integral 实例的替代性构造器。

注解

从 Python 3.2 开始，在构造 Fraction 实例时可以直接使用 decimal.Decimal 实例。

limit_denominator(max_denominator=1000000)

找到并返回一个 Fraction 使得其值最接近 self 并且分母不大于 max_denominator。 此方法适用于找出给定浮点数的有理数近似值：

>>> from fractions import Fraction
>>> Fraction('3.1415926535897932').limit_denominator(1000)
Fraction(355, 113)

或是用来恢复被表示为一个浮点数的有理数：

>>> 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)

__floor__()

返回最大的 int <= self。 此方法也可通过 math.floor() 函数来使用：

>>> from math import floor
>>> floor(Fraction(355, 113))
3

__ceil__()

返回最小的 int >= self。 此方法也可通过 math.ceil() 函数来使用。

__round__()

__round__(ndigits)

第一个版本返回一个 int 使得其值最接近 self，位值为二分之一时只对偶数舍入。第二个版本会将 self 舍入到最接近 Fraction(1, 10**ndigits) 的倍数（如果 ndigits 为负值则为逻辑运算），位值为二分之一时同样只对偶数舍入。 此方法也可通过 round() 函数来使用。

参见

numbers 模块

构成数字塔的所有抽象基类。

random --- 生成伪随机数

源码： Lib/random.py [https://github.com/python/cpython/tree/3.10/Lib/random.py]

该模块实现了各种分布的伪随机数生成器。

对于整数，从范围中有统一的选择。 对于序列，存在随机元素的统一选择、用于生成列表的随机排列的函数、以及用于随机抽样而无需替换的函数。

在实数轴上，有计算均匀、正态（高斯）、对数正态、负指数、伽马和贝塔分布的函数。 为了生成角度分布，可以使用 von Mises 分布。

几乎所有模块函数都依赖于基本函数 random() ，它在半开放区间 [0.0,1.0) 内均匀生成随机浮点数。 Python 使用 Mersenne Twister 作为核心生成器。 它产生 53 位精度浮点数，周期为 2**19937-1 ，其在 C 中的底层实现既快又线程安全。 Mersenne Twister 是现存最广泛测试的随机数发生器之一。 但是，因为完全确定性，它不适用于所有目的，并且完全不适合加密目的。

这个模块提供的函数实际上是 random.Random 类的隐藏实例的绑定方法。 你可以实例化自己的 Random 类实例以获取不共享状态的生成器。

如果你想使用自己设计的不同基础生成器，类 Random 也可以作为子类：在这种情况下，重载 random() 、 seed() 、 getstate() 以及 setstate() 方法。可选地，新生成器可以提供 getrandbits() 方法——这允许 randrange() 在任意大的范围内产生选择。

random 模块还提供 SystemRandom 类，它使用系统函数 os.urandom() 从操作系统提供的源生成随机数。

警告

不应将此模块的伪随机生成器用于安全目的。 有关安全性或加密用途，请参阅 secrets 模块。

参见

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 [https://code.activestate.com/recipes/576707/] 用于兼容的替代随机数发生器，具有长周期和相对简单的更新操作。

簿记功能

random.seed(a=None, version=2)

初始化随机数生成器。

如果 a 被省略或为 None ，则使用当前系统时间。 如果操作系统提供随机源，则使用它们而不是系统时间（有关可用性的详细信息，请参阅 os.urandom() 函数）。

如果 a 是 int 类型，则直接使用。

对于版本2（默认的），str 、 bytes 或 bytearray 对象转换为 int 并使用它的所有位。

对于版本1（用于从旧版本的Python再现随机序列），用于 str 和 bytes 的算法生成更窄的种子范围。

在 3.2 版更改: 已移至版本2方案，该方案使用字符串种子中的所有位。

3.9 版后已移除: 在将来，seed 必须是下列类型之一: NoneType, int, float, str, bytes 或 bytearray。

random.getstate()

返回捕获生成器当前内部状态的对象。 这个对象可以传递给 setstate() 来恢复状态。

random.setstate(state)

state 应该是从之前调用 getstate() 获得的，并且 setstate() 将生成器的内部状态恢复到 getstate() 被调用时的状态。

用于字节数据的函数

random.randbytes(n)

生成 n 个随机字节。

此方法不可用于生成安全凭据。 那应当使用 secrets.token_bytes()。

3.9 新版功能.

整数用函数

random.randrange(stop)

random.randrange(start, stop[, step])

从 range(start, stop, step) 返回一个随机选择的元素。 这相当于 choice(range(start, stop, step)) ，但实际上并没有构建一个 range 对象。

位置参数模式匹配 range() 。不应使用关键字参数，因为该函数可能以意外的方式使用它们。

在 3.2 版更改: randrange() 在生成均匀分布的值方面更为复杂。 以前它使用了像 int(random()*n) 这样的形式，它可以产生稍微不均匀的分布。

3.10 版后已移除: 非整数类型到相等整数的自动转换已被弃用。 目前 randrange(10.0) 会无损地转换为 randrange(10)。 在未来，这将引发 TypeError。

3.10 版后已移除: 针对非整数值例如 randrange(10.5) 或 randrange('10') 引发的异常将从 ValueError 修改为 TypeError。

random.randint(a, b)

返回随机整数 N 满足 a <= N <= b。相当于 randrange(a, b+1)。

random.getrandbits(k)

返回具有 k 个随机比特位的非负 Python 整数。 此方法随 MersenneTwister 生成器一起提供，其他一些生成器也可能将其作为 API 的可选部分提供。 在可能的情况下，getrandbits() 会启用 randrange() 来处理任意大的区间。

在 3.9 版更改: 此方法现在接受零作为 k 的值。

序列用函数

random.choice(seq)

从非空序列 seq 返回一个随机元素。 如果 seq 为空，则引发 IndexError。

random.choices(population, weights=None, *, cum_weights=None, k=1)

从 population 中有重复地随机选取元素，返回大小为 k 的元素列表。 如果 population 为空，则引发 IndexError。

如果指定了 weight 序列，则根据相对权重进行选择。 或者，如果给出 cum_weights 序列，则根据累积权重（可能使用 itertools.accumulate() 计算）进行选择。 例如，相对权重 [10, 5, 30, 5]``相当于累积权重``[10, 15, 45, 50]。 在内部，相对权重在进行选择之前会转换为累积权重，因此提供累积权重可以节省工作量。

如果既未指定 weight 也未指定 cum_weights ，则以相等的概率进行选择。 如果提供了权重序列，则它必须与 population 序列的长度相同。 一个 TypeError 指定了 weights 和 cum_weights 。

weights 或 cum_weights 可使用 random() 所返回的能与 float 值进行相互运算的任何数字类型（包括整数、浮点数、分数但不包括 decimal）。 权重值应当非负且为有限的数值。 如果所有的权重值均为零则会引发 ValueError。

对于给定的种子，具有相等加权的 choices() 函数通常产生与重复调用 choice() 不同的序列。 choices() 使用的算法使用浮点运算来实现内部一致性和速度。 choice() 使用的算法默认为重复选择的整数运算，以避免因舍入误差引起的小偏差。

3.6 新版功能.

在 3.9 版更改: 如果所有权重均为负值则将引发 ValueError。

random.shuffle(x[, random])

就地将序列 x 随机打乱位置。

可选参数 random 是一个0参数函数，在 [0.0, 1.0) 中返回随机浮点数；默认情况下，这是函数 random() 。

要改变一个不可变的序列并返回一个新的打乱列表，请使用 sample(x, k=len(x))。

请注意，即使对于小的 len(x)，x 的排列总数也可以快速增长，大于大多数随机数生成器的周期。 这意味着长序列的大多数排列永远不会产生。 例如，长度为2080的序列是可以在 Mersenne Twister 随机数生成器的周期内拟合的最大序列。

Deprecated since version 3.9, will be removed in version 3.11: 可选形参 random。

random.sample(population, k, *, counts=None)

返回从总体序列或集合中选择的唯一元素的 k 长度列表。 用于无重复的随机抽样。

返回包含来自总体的元素的新列表，同时保持原始总体不变。 结果列表按选择顺序排列，因此所有子切片也将是有效的随机样本。 这允许抽奖获奖者（样本）被划分为大奖和第二名获胜者（子切片）。

总体成员不必是 hashable 或 unique 。 如果总体包含重复，则每次出现都是样本中可能的选择。

重复的元素可以一个个地直接列出，或使用可选的仅限关键字形参 counts 来指定。 例如，sample(['red', 'blue'], counts=[4, 2], k=5) 等价于 sample(['red', 'red', 'red', 'red', 'blue', 'blue'], k=5)。

要从一系列整数中选择样本，请使用 range() 对象作为参数。 对于从大量人群中采样，这种方法特别快速且节省空间：sample(range(10000000), k=60) 。

如果样本大小大于总体大小，则引发 ValueError 。

在 3.9 版更改: 增加了 counts 形参。

3.9 版后已移除: 在将来，population 必须是一个序列。 set 的实例将不再被支持。 集合必须先转换为 list 或 tuple，最好是固定顺序以使抽样是可重现的。

实值分布

以下函数生成特定的实值分布。如常用数学实践中所使用的那样，函数形参以分布方程中的相应变量命名，大多数这些方程都可以在任何统计学教材中找到。

random.random()

返回 [0.0, 1.0) 范围内的下一个随机浮点数。

random.uniform(a, b)

返回一个随机浮点数 N ，当 a <= b 时 a <= N <= b ，当 b < a 时 b <= N <= a 。

取决于等式 a + (b-a) * random() 中的浮点舍入，终点 b 可以包括或不包括在该范围内。

random.triangular(low, high, mode)

返回一个随机浮点数 N ，使得 low <= N <= high 并在这些边界之间使用指定的 mode 。 low 和 high 边界默认为零和一。 mode 参数默认为边界之间的中点，给出对称分布。

random.betavariate(alpha, beta)

Beta 分布。 参数的条件是 alpha > 0 和 beta > 0。 返回值的范围介于 0 和 1 之间。

random.expovariate(lambd)

指数分布。 lambd 是 1.0 除以所需的平均值，它应该是非零的。 （该参数本应命名为 “lambda” ，但这是 Python 中的保留字。）如果 lambd 为正，则返回值的范围为 0 到正无穷大；如果 lambd 为负，则返回值从负无穷大到 0。

random.gammavariate(alpha, beta)

Gamma 分布。 （ 不是 gamma 函数！ ） 参数的条件是 alpha > 0 和 beta > 0。

概率分布函数是:

          x ** (alpha - 1) * math.exp(-x / beta)
pdf(x) =  --------------------------------------
            math.gamma(alpha) * beta ** alpha

random.gauss(mu, sigma)

正态分布，也称高斯分布。 mu 为平均值，而 sigma 为标准差。 此函数要稍快于下面所定义的 normalvariate() 函数。

多线程注意事项：当两个线程同时调用此方法时，它们有可能将获得相同的返回值。 这可以通过三种办法来避免。 1) 让每个线程使用不同的随机数生成器实例。 2) 在所有调用外面加锁。 3) 改用速度较慢但是线程安全的 normalvariate() 函数。

random.lognormvariate(mu, sigma)

对数正态分布。 如果你采用这个分布的自然对数，你将得到一个正态分布，平均值为 mu 和标准差为 sigma 。 mu 可以是任何值，sigma 必须大于零。

random.normalvariate(mu, sigma)

正态分布。 mu 是平均值，sigma 是标准差。

random.vonmisesvariate(mu, kappa)

冯·米塞斯分布。 mu 是平均角度，以弧度表示，介于0和 2*pi 之间，kappa 是浓度参数，必须大于或等于零。 如果 kappa 等于零，则该分布在 0 到 2*pi 的范围内减小到均匀的随机角度。

random.paretovariate(alpha)

帕累托分布。 alpha 是形状参数。

random.weibullvariate(alpha, beta)

威布尔分布。 alpha 是比例参数，beta 是形状参数。

替代生成器

class random.Random([seed])

该类实现了 random 模块所用的默认伪随机数生成器。

3.9 版后已移除: 在将来，seed 必须是下列类型之一: NoneType, int, float, str, bytes 或 bytearray。

class random.SystemRandom([seed])

使用 os.urandom() 函数的类，用从操作系统提供的源生成随机数。 这并非适用于所有系统。 也不依赖于软件状态，序列不可重现。 因此，seed() 方法没有效果而被忽略。 getstate() 和 setstate() 方法如果被调用则引发 NotImplementedError。

关于再现性的说明

有时能够重现伪随机数生成器给出的序列是很有用处的。 通过重用一个种子值，只要没有运行多线程，相同的序列就应当可在多次运行中重现。

大多数随机模块的算法和种子函数都会在 Python 版本中发生变化，但保证两个方面不会改变：

如果添加了新的播种方法，则将提供向后兼容的播种机。

当兼容的播种机被赋予相同的种子时，生成器的 random() 方法将继续产生相同的序列。

例子

基本示例:

>>> random()                             # Random float:  0.0 <= x < 1.0
0.37444887175646646

>>> uniform(2.5, 10.0)                   # Random float:  2.5 <= x <= 10.0
3.1800146073117523

>>> expovariate(1 / 5)                   # Interval between arrivals averaging 5 seconds
5.148957571865031

>>> randrange(10)                        # Integer from 0 to 9 inclusive
7

>>> randrange(0, 101, 2)                 # Even integer from 0 to 100 inclusive
26

>>> choice(['win', 'lose', 'draw'])      # Single random element from a sequence
'draw'

>>> deck = 'ace two three four'.split()
>>> shuffle(deck)                        # Shuffle a list
>>> deck
['four', 'two', 'ace', 'three']

>>> sample([10, 20, 30, 40, 50], k=4)    # Four samples without replacement
[40, 10, 50, 30]

模拟:

>>> # Six roulette wheel spins (weighted sampling with replacement)
>>> choices(['red', 'black', 'green'], [18, 18, 2], k=6)
['red', 'green', 'black', 'black', 'red', 'black']

>>> # Deal 20 cards without replacement from a deck
>>> # of 52 playing cards, and determine the proportion of cards
>>> # with a ten-value:  ten, jack, queen, or king.
>>> dealt = sample(['tens', 'low cards'], counts=[16, 36], k=20)
>>> dealt.count('tens') / 20
0.15

>>> # Estimate the probability of getting 5 or more heads from 7 spins
>>> # of a biased coin that settles on heads 60% of the time.
>>> def trial():
...     return choices('HT', cum_weights=(0.60, 1.00), k=7).count('H') >= 5
...
>>> sum(trial() for i in range(10_000)) / 10_000
0.4169

>>> # Probability of the median of 5 samples being in middle two quartiles
>>> 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

statistical bootstrapping [https://en.wikipedia.org/wiki/Bootstrapping_(statistics)] 的示例，使用重新采样和替换来估计一个样本的均值的置信区间:

# 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}')

使用 重新采样排列测试 [https://en.wikipedia.org/wiki/Resampling_(statistics)#Permutation_tests] 来确定统计学显著性或者使用 p-值 [https://en.wikipedia.org/wiki/P-value] 来观察药物与安慰剂的作用之间差异的示例:

# Example from "Statistics is Easy" by Dennis Shasha and Manda Wilson
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.')

多服务器队列的到达时间和服务交付模拟:

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  # time when each server becomes available
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)])

参见

Statistics for Hackers [https://www.youtube.com/watch?v=Iq9DzN6mvYA] Jake Vanderplas [https://us.pycon.org/2016/speaker/profile/295/] 撰写的视频教程，使用一些基本概念进行统计分析，包括模拟、抽样、洗牌和交叉验证。

Peter Norvig [https://norvig.com/bio.html] 编写的市场模拟 Economics Simulation [https://nbviewer.jupyter.org/url/norvig.com/ipython/Economics.ipynb] 显示了此模块所提供的许多工具和分布（gauss, uniform, sample, betavariate, choice, triangular 和 randrange）的高效使用。

由 Peter Norvig [https://norvig.com/bio.html] 撰写的教程 A Concrete Introduction to Probability (using Python) [https://nbviewer.jupyter.org/url/norvig.com/ipython/Probability.ipynb] 涵盖了概率论基础知识，如何编写模拟，以及如何使用 Python 进行数据分析。

例程

默认的 random() 返回在 0.0 ≤ x < 1.0 范围内 2⁻⁵³ 的倍数。 所有这些数值间隔相等并能精确表示为 Python 浮点数。 但是在此间隔上有许多其他可表示浮点数是不可能的选择。 例如，0.05954861408025609 就不是 2⁻⁵³ 的整数倍。

以下规范程序采取了一种不同的方式。 在间隔上的所有浮点数都是可能的选择。 它们的尾数取值来自 2⁵² ≤ 尾数 < 2⁵³ 范围内整数的均匀分布。 指数取值则来自几何分布，其中小于 -53 的指数的出现频率为下一个较大指数的一半。

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)

该类中所有的 实值分布 都将使用新的方法:

>>> fr = FullRandom()
>>> fr.random()
0.05954861408025609
>>> fr.expovariate(0.25)
8.87925541791544

该规范程序在概念上等效于在 0.0 ≤ x < 1.0 范围内对所有 2⁻¹⁰⁷⁴ 的倍数进行选择的算法。 所有这样的数字间隔都相等，但大多必须向下舍入为最接近的 Python 浮点数表示形式。 （2⁻¹⁰⁷⁴ 这个数值是等于 math.ulp(0.0) 的未经正规化的最小正浮点数。）

参见

生成伪随机浮点数值 [https://allendowney.com/research/rand/downey07randfloat.pdf] 为 Allen B. Downey 所撰写的描述如何生成相比通过 random() 正常生成的数值更细粒度浮点数的论文。

statistics --- 数学统计函数

3.4 新版功能.

源代码: Lib/statistics.py [https://github.com/python/cpython/tree/3.10/Lib/statistics.py]

该模块提供了用于计算数字 (Real-valued) 数据的数理统计量的函数。

此模块并不是诸如 NumPy [https://numpy.org] ， SciPy [https://www.scipy.org/] 等第三方库或者诸如 Minitab ， SAS ， Matlab 等针对专业统计学家的专有全功能统计软件包的竞品。此模块针对图形和科学计算器的水平。

除非明确注释，这些函数支持 int ， float ， Decimal 和 Fraction 。当前不支持同其他类型（是否在数字塔中）的行为。混合类型的集合也是未定义的，并且依赖于实现。如果你输入的数据由混合类型组成，你应该能够使用 map() 来确保一个一致的结果，比如： map(float, input_data) 。

某些数据集合类型使用 NaN (not a number) 值来代表缺失的数据。 由于 NaN 具有特殊的比较语义，它们会在数据排序或计数等统计函数中产生怪异或未定义的行为。 受影响的函数有 median(), median_low(), median_high(), median_grouped(), mode(), multimode() 和 quantiles()。 NaN 值应当在调用这些函数之前被去除:

>>> 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)  # This has surprising behavior
[20.7, nan, 14.4, 18.3, 19.2, nan]
>>> median(data)  # This result is unexpected
16.35

>>> sum(map(isnan, data))    # Number of missing values
2
>>> clean = list(filterfalse(isnan, data))  # Strip NaN values
>>> clean
[20.7, 19.2, 18.3, 14.4]
>>> sorted(clean)  # Sorting now works as expected
[14.4, 18.3, 19.2, 20.7]
>>> median(clean)       # This result is now well defined
18.75

平均值以及对中心位置的评估

这些函数用于计算一个总体或样本的平均值或者典型值。

mean() | 数据的算术平均数（“平均数”）。
fmean() | 快速的，浮点算数平均数。
geometric_mean() | 数据的几何平均数
harmonic_mean() | 数据的调和均值
median() | 数据的中位数（中间值）
median_low() | 数据的低中位数
median_high() | 数据的高中位数
median_grouped() | 分组数据的中位数，即第50个百分点。
mode() | 离散的或标称的数据的单个众数（出现最多的值）。
multimode() | 离散的或标称的数据的众数（出现最多的值）列表。
quantiles() | 将数据以相等的概率分为多个间隔。

对分散程度的评估

这些函数用于计算总体或样本与典型值或平均值的偏离程度。

pstdev() | 数据的总体标准差
pvariance() | 数据的总体方差
stdev() | 数据的样本标准差
variance() | 数据的样本方差

对两个输入之间关系的统计

这些函数计算两个输入之间关系的统计值。

covariance() | 两个变量的样本协方差。
correlation() | 两个变量的皮尔逊相关系数。
linear_regression() | 简单线性回归的斜率和截距。

函数细节

注释：这些函数不需要对提供给它们的数据进行排序。但是，为了方便阅读，大多数例子展示的是已排序的序列。

statistics.mean(data)

返回 data 的样本算术平均数，形式为序列或迭代器。

算术平均数是数据之和与数据点个数的商。通常称作“平均数”，尽管它指示诸多数学平均数之一。它是数据的中心位置的度量。

若 data 为空，将会引发 StatisticsError。

一些用法示例：

>>> 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')

注解

平均数会受到 异常值 [https://en.wikipedia.org/wiki/Outlier] 的强烈影响因而不一定能作为数据点的典型样本。 想获得对于 集中趋势 [https://en.wikipedia.org/wiki/Central_tendency] 的更可靠的度量，可以参看 median()，但其效率要低一些。

样本均值给出了一个无偏向的真实总体均值的估计，因此当平均抽取所有可能的样本， mean(sample) 收敛于整个总体的真实均值。如果 data 代表整个总体而不是样本，那么 mean(data) 等同于计算真实整体均值 μ 。

statistics.fmean(data)

将 data 转换成浮点数并且计算算术平均数。

此函数的运行速度比 mean() 函数快并且它总是返回一个 float。 data 可以为序列或可迭代对象。 如果输入数据集为空，则会引发 StatisticsError。

>>> fmean([3.5, 4.0, 5.25])
4.25

3.8 新版功能.

statistics.geometric_mean(data)

将 data 转换成浮点数并且计算几何平均数。

几何平均值使用值的乘积表示 数据 的中心趋势或典型值（与使用它们的总和的算术平均值相反）。

如果输入数据集为空、包含零或包含负值则将引发 StatisticsError。 data 可以是序列或可迭代对象。

无需做出特殊努力即可获得准确的结果。（但是，将来或许会修改。）

>>> round(geometric_mean([54, 24, 36]), 1)
36.0

3.8 新版功能.

statistics.harmonic_mean(data, weights=None)

返回包含实数值的序列或可迭代对象 data 的调和平均数。 如果 weights 被省略或为 None，则会假定权重相等。

调和平均数是数据的倒数的算术平均值 mean() 的倒数。 例如，三个数值 a, b 和 c 的调和平均数将等于 3/(1/a + 1/b + 1/c)。 如果其中一个值为零，则结果也将为零。

调和平均数是均值的一种，是对数据的中心位置的度量。 它通常适用于求比率和比例（如速度）的均值。

假设一辆车在 40 km/hr 的速度下行驶了 10 km ，然后又以 60 km/hr 的速度行驶了 10 km 。车辆的平均速率是多少？

>>> harmonic_mean([40, 60])
48.0

假设一辆汽车以速度 40 公里/小时行驶了 5 公里，当道路变得畅通后，提速到 60 公里/小时行驶了行程中剩余的 30 km。 请问其平均速度是多少？

>>> harmonic_mean([40, 60], weights=[5, 30])
56.0

如果 data 为空、任意元素小于零，或者加权汇总值不为正数则会引发 StatisticsError。

当前算法在输入中遇到零时会提前退出。这意味着不会测试后续输入的有效性。（此行为将来可能会更改。）

3.6 新版功能.

在 3.10 版更改: 添加了对 weights 的支持。

statistics.median(data)

使用普通的“取中间两数平均值”方法返回数值数据的中位数（中间值）。 如果 data 为空，则将引发 StatisticsError。 data 可以是序列或可迭代对象。

中位数是衡量中间位置的可靠方式，并且较少受到极端值的影响。 当数据点的总数为奇数时，将返回中间数据点：

>>> median([1, 3, 5])
3

当数据点的总数为偶数时，中位数将通过对两个中间值求平均进行插值得出：

>>> median([1, 3, 5, 7])
4.0

这适用于当你的数据是离散的，并且你不介意中位数不是实际数据点的情况。

如果数据是有序的（支持排序操作）但不是数字（不支持加法），请考虑改用 median_low() 或 median_high()。

statistics.median_low(data)

返回数值数据的低中位数。 如果 data 为空则将引发 StatisticsError。 data 可以是序列或可迭代对象。

低中位数一定是数据集的成员。 当数据点总数为奇数时，将返回中间值。 当其为偶数时，将返回两个中间值中较小的那个。

>>> median_low([1, 3, 5])
3
>>> median_low([1, 3, 5, 7])
3

当你的数据是离散的，并且你希望中位数是一个实际数据点而非插值结果时可以使用低中位数。

statistics.median_high(data)

返回数据的高中位数。 如果 data 为空则将引发 StatisticsError。 data 可以是序列或可迭代对象。

高中位数一定是数据集的成员。 当数据点总数为奇数时，将返回中间值。 当其为偶数时，将返回两个中间值中较大的那个。

>>> median_high([1, 3, 5])
3
>>> median_high([1, 3, 5, 7])
5

当你的数据是离散的，并且你希望中位数是一个实际数据点而非插值结果时可以使用高中位数。

statistics.median_grouped(data, interval=1)

返回分组的连续数据的中位数，根据第 50 个百分点的位置使用插值来计算。 如果 data 为空则将引发 StatisticsError。 data 可以是序列或可迭代对象。

>>> median_grouped([52, 52, 53, 54])
52.5

在下面的示例中，数据已经过舍入，这样每个值都代表数据分类的中间点，例如 1 是 0.5--1.5 分类的中间点，2 是 1.5--2.5 分类的中间点，3 是 2.5--3.5 的中间点等待。 根据给定的数据，中间值应落在 3.5--4.5 分类之内，并可使用插值法来进行估算：

>>> median_grouped([1, 2, 2, 3, 4, 4, 4, 4, 4, 5])
3.7

可选参数 interval 表示分类间隔，默认值为 1。 改变分类间隔自然会改变插件结果：

>>> median_grouped([1, 3, 3, 5, 7], interval=1)
3.25
>>> median_grouped([1, 3, 3, 5, 7], interval=2)
3.5

此函数不会检查数据点之间是否至少相隔 interval 的距离。

CPython 实现细节： 在某些情况下，median_grouped() 可以会将数据点强制转换为浮点数。 此行为在未来有可能会发生改变。

参见

"Statistics for the Behavioral Sciences", Frederick J Gravetter and Larry B Wallnau (8th Edition).

Gnome Gnumeric 电子表格中的 SSMEDIAN [https://help.gnome.org/users/gnumeric/stable/gnumeric.html#gnumeric-function-SSMEDIAN] 函数，包括 这篇讨论 [https://mail.gnome.org/archives/gnumeric-list/2011-April/msg00018.html]。

statistics.mode(data)

从离散或标称的 data 返回单个出现最多的数据点。 此众数（如果存在）是最典型的值，并可用来度量中心的位置。

如果存在具有相同频率的多个众数，则返回在 data 中遇到的第一个。 如果想要其中最小或最大的一个，请使用 min(multimode(data)) 或 max(multimode(data))。 如果输入的 data 为空，则会引发 StatisticsError。

mode 将假定是离散数据并返回一个单一的值。 这是通常的学校教学中标准的处理方式：

>>> mode([1, 1, 2, 3, 3, 3, 3, 4])
3

此众数的独特之处在于它是这个包中唯一还可应用于标称（非数字）数据的统计信息：

>>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
'red'

在 3.8 版更改: 现在会通过返回所遇到的第一个众数来处理多模数据集。 之前它会在遇到超过一个的众数时引发 StatisticsError。

statistics.multimode(data)

返回最频繁出现的值的列表，并按它们在 data 中首次出现的位置排序。 如果存在多个众数则将返回一个以上的众数，或者如果 data 为空则将返回空列表：

>>> multimode('aabbbbccddddeeffffgg')
['b', 'd', 'f']
>>> multimode('')
[]

3.8 新版功能.

statistics.pstdev(data, mu=None)

返回总体标准差（总体方差的平方根）。 请参阅 pvariance() 了解参数和其他细节。

>>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
0.986893273527251

statistics.pvariance(data, mu=None)

返回非空序列或包含实数值的可迭代对象 data 的总体方差。 方差或称相对于均值的二阶距，是对数据变化幅度（延展度或分散度）的度量。 方差值较大表明数据的散布范围较大；方差值较小表明它紧密聚集于均值附近。

如果给出了可选的第二个参数 mu，它通常是 data 的均值。 它也可以被用来计算相对于一个非均值点的二阶距。 如果该参数省略或为 None (默认值)，则会自动进行算术均值的计算。

使用此函数可根据所有数值来计算方差。 要根据一个样本来估算方差，通常 variance() 函数是更好的选择。

如果 data 为空则会引发 StatisticsError。

示例：

>>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
>>> pvariance(data)
1.25

如果你已经计算过数据的平均值，你可以将其作为可选的第二个参数 mu 传入以避免重复计算：

>>> mu = mean(data)
>>> pvariance(data, mu)
1.25

同样也支持使用 Decimal 和 Fraction 值：

>>> 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)

注解

当调用时附带完整的总体数据时，这将给出总体方差 σ²。 而当调用时只附带一个样本时，这将给出偏置样本方差 s²，也被称为带有 N 个自由度的方差。

如果你通过某种方式知道了真实的总体平均值 μ，则可以使用此函数来计算一个样本的方差，并将已知的总体平均值作为第二个参数。 假设数据点是总体的一个随机样本，则结果将为总体方差的无偏估计值。

statistics.stdev(data, xbar=None)

返回样本标准差（样本方差的平方根）。 请参阅 variance() 了解参数和其他细节。

>>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
1.0810874155219827

statistics.variance(data, xbar=None)

返回包含至少两个实数值的可迭代对象 data 的样本方差。 方差或称相对于均值的二阶矩，是对数据变化幅度（延展度或分散度）的度量。 方差值较大表明数据的散布范围较大；方差值较小表明它紧密聚集于均值附近。

如果给出了可选的第二个参数 xbar，它应当是 data 的均值。 如果该参数省略或为 None (默认值)，则会自动进行均值的计算。

当你的数据是总体数据的样本时请使用此函数。 要根据整个总体数据来计算方差，请参见 pvariance()。

如果 data 包含的值少于两个则会引发 StatisticsError。

示例：

>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> variance(data)
1.3720238095238095

如果你已经计算过数据的平均值，你可以将其作为可选的第二个参数 xbar 传入以避免重复计算：

>>> m = mean(data)
>>> variance(data, m)
1.3720238095238095

此函数不会试图检查你所传入的 xbar 是否为真实的平均值。 使用任意值作为 xbar 可能导致无效或不可能的结果。

同样也支持使用 Decimal 和 Fraction 值：

>>> 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)

注解

这是附带贝塞尔校正的样本方差 s²，也称为具有 N-1 自由度的方差。 假设数据点具有代表性（即为独立且均匀的分布），则结果应当是对总体方差的无偏估计。

如果你通过某种方式知道了真实的总体平均值 μ 则应当调用 pvariance() 函数并将该值作为 mu 形参传入以得到一个样本的方差。

statistics.quantiles(data, *, n=4, method='exclusive')

将 data 分隔为具有相等概率的 n 个连续区间。 返回分隔这些区间的 n - 1 个分隔点的列表。

将 n 设为 4 以使用四分位（默认值）。 将 n 设为 10 以使用十分位。 将 n 设为 100 以使用百分位，即给出 99 个分隔点来将 data 分隔为 100 个大小相等的组。 如果 n 小于 1 则将引发 StatisticsError。

data 可以是包含样本数据的任意可迭代对象。 为了获得有意义的结果，data 中数据点的数量应当大于 n。 如果数据点的数量小于两个则将引发 StatisticsError。

分隔点是通过对两个最接近的数据点进行线性插值得到的。 例如，如果一个分隔点落在两个样本值 100 和 112 之间距离三分之一的位置，则分隔点的取值将为 104。

method 用于计算分位值，它会由于 data 是包含还是排除总体的最低和最高可能值而有所不同。

默认 method 是 “唯一的” 并且被用于在总体中数据采样这样可以有比样本中找到的更多的极端值。落在 m 个排序数据点的第 i-th 个以下的总体部分被计算为 i / (m + 1) 。给定九个样本值，方法排序它们并且分配一下的百分位： 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90% 。

将 method 设为 "inclusive" 可用于描述总体数据或已明确知道包含有总体数据中最极端值的样本。 data 中的最小值会被作为第 0 个百分位而最大值会被作为第 100 个百分位。 总体数据里处于 m 个已排序数据点中 第 i 个 以下的部分会以 (i - 1) / (m - 1) 来计算。 给定 11 个样本值，该方法会对它们进行排序并赋予以下百分位: 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%, 100%。

# 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]

3.8 新版功能.

statistics.covariance(x, y, /)

返回两个输入 x 和 y 的样本协方差。 样本协方差是对两个输入的同步变化性的度量。

两个输入必须具有相同的长度（不少于两个元素），否则会引发 StatisticsError。

示例：

>>> 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

3.10 新版功能.

statistics.correlation(x, y, /)

返回两个输入的 皮尔逊相关系数 [https://en.wikipedia.org/wiki/Pearson_correlation_coefficient]。 皮尔逊相关系数 r 的取值在 -1 到 +1 之间。 它衡量线性相关的强度和方向，其中 +1 表示非常强的正线性相关，-1 表示非常强的负线性相关，0 表示无线性相关。

两个输入必须具有相同的长度（不少于两个元素），并且不必为常量，否则会引发 StatisticsError。

示例：

>>> x = [1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> y = [9, 8, 7, 6, 5, 4, 3, 2, 1]
>>> correlation(x, x)
1.0
>>> correlation(x, y)
-1.0

3.10 新版功能.

statistics.linear_regression(x, y, /)

返回使用普通最小二乘法估计得到的 简单线性回归 [https://en.wikipedia.org/wiki/Simple_linear_regression] 参数的斜率和截距。 简单纯属回归通过此线性函数来描述自变量 x 和因变量 y 之间的关系。

y = slope * x + intercept + noise

其中 slope 和 intercept 是估计得到的回归参数，而 noise 代表不可由线性回归解释的数据变异性（它等于因变量的预测值和实际值之间的差异）。

两个输入必须具有相同的长度（不少于两个元素），并且自变量 x 不可为常量；否则会引发 StatisticsError。

例如，我们可以使用 Monty Python 系列电影的发布日期 [https://en.wikipedia.org/wiki/Monty_Python#Films] 在假定出品方保持现有步调的情况下预测到 2019 年时产出的 Monty Python 电影的累计数量。

>>> 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

3.10 新版功能.

异常

只定义了一个异常：

exception statistics.StatisticsError

ValueError 的子类，表示统计相关的异常。

NormalDist 对象

NormalDist 工具可用于创建和操纵 随机变量 [http://www.stat.yale.edu/Courses/1997-98/101/ranvar.htm] 的正态分布。 这个类将数据度量值的平均值和标准差作为单一实体来处理。

正态分布的概念来自于 中央极限定理 [https://en.wikipedia.org/wiki/Central_limit_theorem] 并且在统计学中有广泛的应用。

class statistics.NormalDist(mu=0.0, sigma=1.0)

返回一个新的 NormalDist 对象，其中 mu 代表 算术平均值 [https://en.wikipedia.org/wiki/Arithmetic_mean] 而 sigma 代表 标准差 [https://en.wikipedia.org/wiki/Standard_deviation]。

若 sigma 为负数，将会引发 StatisticsError。

mean

一个只读特征属性，表示特定正态分布的 算术平均值 [https://en.wikipedia.org/wiki/Arithmetic_mean]。

median

一个只读特征属性，表示特定正态分布的 中位数 [https://en.wikipedia.org/wiki/Median]。

mode

一个只读特征属性，表示特定正态分布的 众数 [https://en.wikipedia.org/wiki/Mode_(statistics)]。

stdev

一个只读特征属性，表示特定正态分布的 标准差 [https://en.wikipedia.org/wiki/Standard_deviation]。

variance

一个只读特征属性，表示特定正态分布的 方差 [https://en.wikipedia.org/wiki/Variance]。 等于标准差的平方。

classmethod from_samples(data)

传入使用 fmean() 和 stdev() 基于 data 估算出的 mu 和 sigma 形参创建一个正态分布实例。

data 可以是任何 iterable 并且应当包含能被转换为 float 类型的值。 如果 data 不包含至少两个元素，则会引发 StatisticsError，因为估算中心值至少需要一个点而估算分散度至少需要两个点。

samples(n, *, seed=None)

对于给定的平均值和标准差生成 n 个随机样本。 返回一个由 float 值组成的 list。

当给定 seed 时，创建一个新的底层随机数生成器实例。 这适用于创建可重现的结果，即使对于多线程上下文也有效。

pdf(x)

使用 概率密度函数 (pdf) [https://en.wikipedia.org/wiki/Probability_density_function]，计算一个随机变量 X 趋向于给定值 x 的相对可能性。 在数学意义上，它是当 dx 趋向于零时比率 P(x <= X < x+dx) / dx 的极限。

相对可能性的计算方法是用一个狭窄区间内某个样本出现的概率除以区间的宽度（因此使用 "density" 一词）。 由于可能性是相对于其他点的，因此它的值可以大于 1.0。

cdf(x)

使用 累积分布函数 (cdf) [https://en.wikipedia.org/wiki/Cumulative_distribution_function]，计算一个随机变量 X 小于等于 x 的概率。 在数学上，它表示为 P(X <= x)。

inv_cdf(p)

计算反射累积分布函数，也称为 分位数函数 [https://en.wikipedia.org/wiki/Quantile_function] 或 百分点 [https://web.archive.org/web/20190203145224/https://www.statisticshowto.datasciencecentral.com/inverse-distribution-function/] 函数。 在数学上，它表示为 x : P(X <= x) = p。

找出随机变量 X 的值 x 使得该变量小于等于该值的概率等于给定的概率 p。

overlap(other)

测量两个正态概率分布之间的一致性。 返回介于 0.0 和 1.0 之间的值，给出 两个概率密度函数的重叠区域 [https://www.rasch.org/rmt/rmt101r.htm]。

quantiles(n=4)

将指定正态分布划分为 n 个相等概率的连续分隔区。 返回这些分隔区对应的 (n - 1) 个分隔点的列表。

将 n 设为 4 以使用四分位（默认值）。 将 n 设为 10 以使用十分位。将 n 设为 100 以使用百分位，即给出 99 个分隔点来将正态分布分隔为 100 个大小相等的组。

zscore(x)

计算 标准分 [https://www.statisticshowto.com/probability-and-statistics/z-score/] 即以高于或低于正态分布的平均值的标准差数值的形式来描述 x: (x - mean) / stdev.

3.9 新版功能.

NormalDist 的实例支持加上、减去、乘以或除以一个常量。 这些运算被用于转换和缩放。 例如：

>>> temperature_february = NormalDist(5, 2.5)             # Celsius
>>> temperature_february * (9/5) + 32                     # Fahrenheit
NormalDist(mu=41.0, sigma=4.5)

不允许一个常量除以 NormalDist 的实例，因为结果将不是正态分布。

由于正态分布是由独立变量的累加效应产生的，因此允许表示为 NormalDist 实例的 两组独立正态分布的随机变量相加和相减 [https://en.wikipedia.org/wiki/Sum_of_normally_distributed_random_variables]。 例如：

>>> 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

3.8 新版功能.

NormalDist 示例和用法

NormalDist 适合用来解决经典概率问题。

举例来说，如果 SAT 考试的历史数据 [https://nces.ed.gov/programs/digest/d17/tables/dt17_226.40.asp] 显示分数呈平均值为 1060 且标准差为 195 的正态分布，则可以确定考试分数处于 1100 和 1200 之间的学生的百分比舍入到最接近的整数应为：

>>> sat = NormalDist(1060, 195)
>>> fraction = sat.cdf(1200 + 0.5) - sat.cdf(1100 - 0.5)
>>> round(fraction * 100.0, 1)
18.4

求 SAT 分数的 四分位 [https://en.wikipedia.org/wiki/Quartile] 和 十分位 [https://en.wikipedia.org/wiki/Decile]：

>>> list(map(round, sat.quantiles()))
[928, 1060, 1192]
>>> list(map(round, sat.quantiles(n=10)))
[810, 896, 958, 1011, 1060, 1109, 1162, 1224, 1310]

为了估算一个不易解析的模型分布，NormalDist 可以生成用于 蒙特卡洛模拟 [https://en.wikipedia.org/wiki/Monte_Carlo_method] 的输入样本：

>>> 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]

当样本量较大且成功试验的可能性接近 50% 时，正态分布可以被用来模拟 二项式分布 [https://mathworld.wolfram.com/BinomialDistribution.html] 。

例如，一次开源会议有 750 名与会者和两个可分别容纳 500 人的会议厅。 会上有一场关于 Python 的演讲和一场关于 Ruby 的演讲。 在往届会议中，65% 的与会者更愿意去听关于 Python 的演讲。 假定人群的偏好没有发生改变，那么 Python 演讲的会议厅不超出其容量上限的可能性是多少？

>>> n = 750             # Sample size
>>> p = 0.65            # Preference for Python
>>> q = 1.0 - p         # Preference for Ruby
>>> k = 500             # Room capacity

>>> # Approximation using the cumulative normal distribution
>>> from math import sqrt
>>> round(NormalDist(mu=n*p, sigma=sqrt(n*p*q)).cdf(k + 0.5), 4)
0.8402

>>> # Solution using the cumulative binomial distribution
>>> from math import comb, fsum
>>> round(fsum(comb(n, r) * p**r * q**(n-r) for r in range(k+1)), 4)
0.8402

>>> # Approximation using a simulation
>>> from random import seed, choices
>>> seed(8675309)
>>> def trial():
...     return choices(('Python', 'Ruby'), (p, q), k=n).count('Python')
>>> mean(trial() <= k for i in range(10_000))
0.8398

在机器学习问题中也经常会出现正态分布。

维基百科上有一个 朴素贝叶斯分类器的良好样例 [https://en.wikipedia.org/wiki/Naive_Bayes_classifier#Person_classification]。 要处理的问题是根据对多个分布的特征测量值包括身高、体重和足部尺码来预测一个人的性别。

我们得到了由八个人的测量值组成的训练数据集。 假定这些测量值是正态分布的，因此我们用 NormalDist 来总结数据：

>>> 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])

接下来，我们遇到一个特征测量值已知但性别未知的新人：

>>> ht = 6.0        # height
>>> wt = 130        # weight
>>> fs = 8          # foot size

从是男是女各 50% 的 先验概率 [https://en.wikipedia.org/wiki/Prior_probability] 出发，我们通过将该先验概率乘以给定性别的特征度量值的可能性累积值来计算后验概率：

>>> 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))

最终预测值应为最大后验概率值。 这种算法被称为 maximum a posteriori [https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation] 或 MAP：

>>> 'male' if posterior_male > posterior_female else 'female'
'female'

函数式编程模块

本章里描述的模块提供了函数和类，以支持函数式编程风格和在可调用对象上的通用操作。

本章包含以下模块的文档：

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

Itertool函数

itertools 配方

functools --- 高阶函数和可调用对象上的操作

partial 对象

operator --- 标准运算符替代函数

将运算符映射到函数

原地运算符

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

本模块实现一系列 iterator ，这些迭代器受到APL，Haskell和SML的启发。为了适用于Python，它们都被重新写过。

本模块标准化了一个快速、高效利用内存的核心工具集，这些工具本身或组合都很有用。它们一起形成了“迭代器代数”，这使得在纯Python中有可能创建简洁又高效的专用工具。

例如，SML有一个制表工具： tabulate(f)，它可产生一个序列 f(0), f(1), ...。在Python中可以组合 map() 和 count() 实现： map(f, count())。

这些内置工具同时也能很好地与 operator 模块中的高效函数配合使用。例如，我们可以将两个向量的点积映射到乘法运算符： sum(map(operator.mul, vector1, vector2)) 。

无穷迭代器：

迭代器 | 实参 | 结果 | 示例
count() | start, [step] | start, start+step, start+2*step, ... | count(10) --> 10 11 12 13 14 ...
cycle() | p | p0, p1, ... plast, p0, p1, ... | cycle('ABCD') --> A B C D A B C D ...
repeat() | elem [,n] | elem, elem, elem, ... 重复无限次或n次 | repeat(10, 3) --> 10 10 10

根据最短输入序列长度停止的迭代器：

迭代器 | 实参 | 结果 | 示例
accumulate() | p [,func] | p0, p0+p1, p0+p1+p2, ... | accumulate([1,2,3,4,5]) --> 1 3 6 10 15
chain() | p, q, ... | p0, p1, ... plast, q0, q1, ... | chain('ABC', 'DEF') --> A B C D E F
chain.from_iterable() | iterable -- 可迭代对象 | p0, p1, ... plast, q0, q1, ... | chain.from_iterable(['ABC', 'DEF']) --> A B C D E F
compress() | data, selectors | (d[0] if s[0]), (d[1] if s[1]), ... | compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F
dropwhile() | pred, seq | seq[n], seq[n+1], ... 从pred首次真值测试失败开始 | dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1
filterfalse() | pred, seq | seq中pred(x)为假值的元素，x是seq中的元素。 | filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8
groupby() | iterable[, key] | 根据key(v)值分组的迭代器 |
islice() | seq, [start,] stop [, step] | seq[start:stop:step]中的元素 | islice('ABCDEFG', 2, None) --> C D E F G
pairwise() | iterable -- 可迭代对象 | (p[0], p[1]), (p[1], p[2]) | pairwise('ABCDEFG') --> AB BC CD DE EF FG
starmap() | func, seq | func(*seq[0]), func(*seq[1]), ... | starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000
takewhile() | pred, seq | seq[0], seq[1], ..., 直到pred真值测试失败 | takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4
tee() | it, n | it1, it2, ... itn 将一个迭代器拆分为n个迭代器 |
zip_longest() | p, q, ... | (p[0], q[0]), (p[1], q[1]), ... | zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-

排列组合迭代器：

迭代器 | 实参 | 结果
product() | p, q, ... [repeat=1] | 笛卡尔积，相当于嵌套的for循环
permutations() | p[, r] | 长度r元组，所有可能的排列，无重复元素
combinations() | p, r | 长度r元组，有序，无重复元素
combinations_with_replacement() | p, r | 长度r元组，有序，元素可重复

例子 | 结果
product('ABCD', repeat=2) | AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD
permutations('ABCD', 2) | AB AC AD BA BC BD CA CB CD DA DB DC
combinations('ABCD', 2) | AB AC AD BC BD CD
combinations_with_replacement('ABCD', 2) | AA AB AC AD BB BC BD CC CD DD

Itertool函数

下列模块函数均创建并返回迭代器。有些迭代器不限制输出流长度，所以它们只应在能截断输出流的函数或循环中使用。

itertools.accumulate(iterable[, func, *, initial=None])

创建一个迭代器，返回累积汇总值或其他双目运算函数的累积结果值（通过可选的 func 参数指定）。

如果提供了 func，它应当为带有两个参数的函数。 输入 iterable 的元素可以是能被 func 接受为参数的任意类型。 （例如，对于默认的加法运算，元素可以是任何可相加的类型包括 Decimal 或 Fraction。）

通常，输出的元素数量与输入的可迭代对象是一致的。 但是，如果提供了关键字参数 initial，则累加会以 initial 值开始，这样输出就比输入的可迭代对象多一个元素。

大致相当于：

def accumulate(iterable, func=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
    it = iter(iterable)
    total = initial
    if initial is None:
        try:
            total = next(it)
        except StopIteration:
            return
    yield total
    for element in it:
        total = func(total, element)
        yield total

func 参数有几种用法。它可以被设为 min() 最终得到一个最小值，或者设为 max() 最终得到一个最大值，或设为 operator.mul() 最终得到一个乘积。摊销表可通过累加利息和支付款项得到。给iterable设置初始值并只将参数 func 设为累加总数可以对一阶 递归关系 [https://en.wikipedia.org/wiki/Recurrence_relation] 建模。

>>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8]
>>> list(accumulate(data, operator.mul))     # running product
[3, 12, 72, 144, 144, 1296, 0, 0, 0, 0]
>>> list(accumulate(data, max))              # running maximum
[3, 4, 6, 6, 6, 9, 9, 9, 9, 9]

# Amortize a 5% loan of 1000 with 4 annual payments of 90
>>> cashflows = [1000, -90, -90, -90, -90]
>>> list(accumulate(cashflows, lambda bal, pmt: bal*1.05 + pmt))
[1000, 960.0, 918.0, 873.9000000000001, 827.5950000000001]

# Chaotic recurrence relation https://en.wikipedia.org/wiki/Logistic_map
>>> logistic_map = lambda x, _:  r * x * (1 - x)
>>> r = 3.8
>>> x0 = 0.4
>>> inputs = repeat(x0, 36)     # only the initial value is used
>>> [format(x, '.2f') for x in accumulate(inputs, logistic_map)]
['0.40', '0.91', '0.30', '0.81', '0.60', '0.92', '0.29', '0.79', '0.63',
 '0.88', '0.39', '0.90', '0.33', '0.84', '0.52', '0.95', '0.18', '0.57',
 '0.93', '0.25', '0.71', '0.79', '0.63', '0.88', '0.39', '0.91', '0.32',
 '0.83', '0.54', '0.95', '0.20', '0.60', '0.91', '0.30', '0.80', '0.60']

参考一个类似函数 functools.reduce() ，它只返回一个最终累积值。

3.2 新版功能.

在 3.3 版更改: 增加可选参数 func 。

在 3.8 版更改: 添加了可选的 initial 形参。

itertools.chain(*iterables)

创建一个迭代器，它首先返回第一个可迭代对象中所有元素，接着返回下一个可迭代对象中所有元素，直到耗尽所有可迭代对象中的元素。可将多个序列处理为单个序列。大致相当于：

def chain(*iterables):
    # chain('ABC', 'DEF') --> A B C D E F
    for it in iterables:
        for element in it:
            yield element

classmethod chain.from_iterable(iterable)

构建类似 chain() 迭代器的另一个选择。从一个单独的可迭代参数中得到链式输入，该参数是延迟计算的。大致相当于：

def from_iterable(iterables):
    # chain.from_iterable(['ABC', 'DEF']) --> A B C D E F
    for it in iterables:
        for element in it:
            yield element

itertools.combinations(iterable, r)

返回由输入 iterable 中元素组成长度为 r 的子序列。

组合元组会以字典顺序根据所输入 iterable 的顺序发出。 因此，如果所输入 iterable 是已排序的，组合元组也将按已排序的顺序生成。

即使元素的值相同，不同位置的元素也被认为是不同的。如果元素各自不同，那么每个组合中没有重复元素。

大致相当于：

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)

combinations() 的代码可被改写为 permutations() 过滤后的子序列，（相对于元素在输入中的位置）元素不是有序的。

def combinations(iterable, r):
    pool = tuple(iterable)
    n = len(pool)
    for indices in permutations(range(n), r):
        if sorted(indices) == list(indices):
            yield tuple(pool[i] for i in indices)

当 0 <= r <= n 时，返回项的个数是 n! / r! / (n-r)!；当 r > n 时，返回项个数为0。

itertools.combinations_with_replacement(iterable, r)

返回由输入 iterable 中元素组成的长度为 r 的子序列，允许每个元素可重复出现。

组合元组会以字典顺序根据所输入 iterable 的顺序发出。 因此，如果所输入 iterable 是已排序的，组合元组也将按已排序的顺序生成。

不同位置的元素是不同的，即使它们的值相同。因此如果输入中的元素都是不同的话，返回的组合中元素也都会不同。

大致相当于：

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)

combinations_with_replacement() 的代码可被改写为 production() 过滤后的子序列，（相对于元素在输入中的位置）元素不是有序的。

def combinations_with_replacement(iterable, r):
    pool = tuple(iterable)
    n = len(pool)
    for indices in product(range(n), repeat=r):
        if sorted(indices) == list(indices):
            yield tuple(pool[i] for i in indices)

当 n > 0 时，返回项个数为 (n+r-1)! / r! / (n-1)!.

3.1 新版功能.

itertools.compress(data, selectors)

创建一个迭代器，它返回 data 中经 selectors 真值测试为 True 的元素。迭代器在两者较短的长度处停止。大致相当于：

def compress(data, selectors):
    # compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F
    return (d for d, s in zip(data, selectors) if s)

3.1 新版功能.

itertools.count(start=0, step=1)

创建一个迭代器，它从 start 值开始，返回均匀间隔的值。常用于 map() 中的实参来生成连续的数据点。此外，还用于 zip() 来添加序列号。大致相当于：

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

当对浮点数计数时，替换为乘法代码有时精度会更好，例如： (start + step * i for i in count()) 。

在 3.1 版更改: 增加参数 step ，允许非整型。

itertools.cycle(iterable)

创建一个迭代器，返回 iterable 中所有元素并保存一个副本。当取完 iterable 中所有元素，返回副本中的所有元素。无限重复。大致相当于：

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

注意，该函数可能需要相当大的辅助空间（取决于 iterable 的长度）。

itertools.dropwhile(predicate, iterable)

创建一个迭代器，如果 predicate 为true，迭代器丢弃这些元素，然后返回其他元素。注意，迭代器在 predicate 首次为false之前不会产生任何输出，所以可能需要一定长度的启动时间。大致相当于：

def dropwhile(predicate, iterable):
    # dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1
    iterable = iter(iterable)
    for x in iterable:
        if not predicate(x):
            yield x
            break
    for x in iterable:
        yield x

itertools.filterfalse(predicate, iterable)

创建一个迭代器，只返回 iterable 中 predicate 为 False 的元素。如果 predicate 是 None，返回真值测试为false的元素。大致相当于：

def filterfalse(predicate, iterable):
    # filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8
    if predicate is None:
        predicate = bool
    for x in iterable:
        if not predicate(x):
            yield x

itertools.groupby(iterable, key=None)

创建一个迭代器，返回 iterable 中连续的键和组。key 是一个计算元素键值函数。如果未指定或为 None，key 缺省为恒等函数（identity function），返回元素不变。一般来说，iterable 需用同一个键值函数预先排序。

groupby() 操作类似于Unix中的 uniq。当每次 key 函数产生的键值改变时，迭代器会分组或生成一个新组（这就是为什么通常需要使用同一个键值函数先对数据进行排序）。这种行为与SQL的GROUP BY操作不同，SQL的操作会忽略输入的顺序将相同键值的元素分在同组中。

返回的组本身也是一个迭代器，它与 groupby() 共享底层的可迭代对象。因为源是共享的，当 groupby() 对象向后迭代时，前一个组将消失。因此如果稍后还需要返回结果，可保存为列表：

groups = []
uniquekeys = []
data = sorted(data, key=keyfunc)
for k, g in groupby(data, keyfunc):
    groups.append(list(g))      # Store group iterator as a list
    uniquekeys.append(k)

groupby() 大致相当于：

class groupby:
    # [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
    def __init__(self, iterable, key=None):
        if key is None:
            key = lambda x: x
        self.keyfunc = key
        self.it = iter(iterable)
        self.tgtkey = self.currkey = self.currvalue = object()
    def __iter__(self):
        return self
    def __next__(self):
        self.id = object()
        while self.currkey == self.tgtkey:
            self.currvalue = next(self.it)    # Exit on StopIteration
            self.currkey = self.keyfunc(self.currvalue)
        self.tgtkey = self.currkey
        return (self.currkey, self._grouper(self.tgtkey, self.id))
    def _grouper(self, tgtkey, id):
        while self.id is id and self.currkey == tgtkey:
            yield self.currvalue
            try:
                self.currvalue = next(self.it)
            except StopIteration:
                return
            self.currkey = self.keyfunc(self.currvalue)

itertools.islice(iterable, stop)

itertools.islice(iterable, start, stop[, step])

创建一个迭代器，返回从 iterable 里选中的元素。如果 start 不是0，跳过 iterable 中的元素，直到到达 start 这个位置。之后迭代器连续返回元素，除非 step 设置的值很高导致被跳过。如果 stop 为 None，迭代器耗光为止；否则，在指定的位置停止。与普通的切片不同，islice() 不支持将 start ， stop ，或 step 设为负值。可用来从内部数据结构被压平的数据中提取相关字段（例如一个多行报告，它的名称字段出现在每三行上）。大致相当于：

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, stop, step = s.start or 0, s.stop or sys.maxsize, s.step or 1
    it = iter(range(start, stop, step))
    try:
        nexti = next(it)
    except StopIteration:
        # Consume *iterable* up to the *start* position.
        for i, element in zip(range(start), iterable):
            pass
        return
    try:
        for i, element in enumerate(iterable):
            if i == nexti:
                yield element
                nexti = next(it)
    except StopIteration:
        # Consume to *stop*.
        for i, element in zip(range(i + 1, stop), iterable):
            pass

如果 start 为 None，迭代从0开始。如果 step 为 None ，步长缺省为1。

itertools.pairwise(iterable)

返回从输入 iterable 中获取的连续重叠对。

输出迭代器中 2 元组的数量将比输入的数量少一个。 如果输入可迭代对象中少于两个值则它将为空。

大致相当于：

def pairwise(iterable):
    # pairwise('ABCDEFG') --> AB BC CD DE EF FG
    a, b = tee(iterable)
    next(b, None)
    return zip(a, b)

3.10 新版功能.

itertools.permutations(iterable, r=None)

连续返回由 iterable 元素生成长度为 r 的排列。

如果 r 未指定或为 None ，r 默认设置为 iterable 的长度，这种情况下，生成所有全长排列。

排列元组会以字典顺序根据所输入 iterable 的顺序发出。 因此，如果所输入 iterable 是已排序的，组合元组也将按已排序的顺序生成。

即使元素的值相同，不同位置的元素也被认为是不同的。如果元素值都不同，每个排列中的元素值不会重复。

大致相当于：

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

permutations() 的代码也可被改写为 product() 的子序列，只要将含有重复元素（来自输入中同一位置的）的项排除。

def permutations(iterable, r=None):
    pool = tuple(iterable)
    n = len(pool)
    r = n if r is None else r
    for indices in product(range(n), repeat=r):
        if len(set(indices)) == r:
            yield tuple(pool[i] for i in indices)

当 0 <= r <= n ，返回项个数为 n! / (n-r)! ；当 r > n ，返回项个数为0。

itertools.product(*iterables, repeat=1)

可迭代对象输入的笛卡儿积。

大致相当于生成器表达式中的嵌套循环。例如， product(A, B) 和 ((x,y) for x in A for y in B) 返回结果一样。

嵌套循环像里程表那样循环变动，每次迭代时将最右侧的元素向后迭代。这种模式形成了一种字典序，因此如果输入的可迭代对象是已排序的，笛卡尔积元组依次序发出。

要计算可迭代对象自身的笛卡尔积，将可选参数 repeat 设定为要重复的次数。例如，product(A, repeat=4) 和 product(A, A, A, A) 是一样的。

该函数大致相当于下面的代码，只不过实际实现方案不会在内存中创建中间结果。

def product(*args, 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
    pools = [tuple(pool) for pool in args] * repeat
    result = [[]]
    for pool in pools:
        result = [x+[y] for x in result for y in pool]
    for prod in result:
        yield tuple(prod)

在 product() 运行之前，它会完全耗尽输入的可迭代对象，在内存中保留值的临时池以生成结果积。 相应地，它只适用于有限的输入。

itertools.repeat(object[, times])

创建一个迭代器，不断重复 object 。除非设定参数 times ，否则将无限重复。可用于 map() 函数中的参数，被调用函数可得到一个不变参数。也可用于 zip() 的参数以在元组记录中创建一个不变的部分。

大致相当于：

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

repeat 最常见的用途就是在 map 或 zip 提供一个常量流：

>>> list(map(pow, range(10), repeat(2)))
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

itertools.starmap(function, iterable)

创建一个迭代器，使用从可迭代对象中获取的参数来计算该函数。当参数对应的形参已从一个单独可迭代对象组合为元组时（数据已被“预组对”）可用此函数代替 map()。map() 与 starmap() 之间的区别可以类比 function(a,b) 与 function(*c) 的区别。大致相当于:

def starmap(function, iterable):
    # starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000
    for args in iterable:
        yield function(*args)

itertools.takewhile(predicate, iterable)

创建一个迭代器，只要 predicate 为真就从可迭代对象中返回元素。大致相当于:

def takewhile(predicate, iterable):
    # takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4
    for x in iterable:
        if predicate(x):
            yield x
        else:
            break

itertools.tee(iterable, n=2)

从一个可迭代对象中返回 n 个独立的迭代器。

下面的Python代码能帮助解释 tee 做了什么（尽管实际的实现更复杂，而且仅使用了一个底层的 FIFO 队列）。

大致相当于：

def tee(iterable, n=2):
    it = iter(iterable)
    deques = [collections.deque() for i in range(n)]
    def gen(mydeque):
        while True:
            if not mydeque:             # when the local deque is empty
                try:
                    newval = next(it)   # fetch a new value and
                except StopIteration:
                    return
                for d in deques:        # load it to all the deques
                    d.append(newval)
            yield mydeque.popleft()
    return tuple(gen(d) for d in deques)

一旦 tee() 实施了一次分裂，原有的 iterable 不应再被使用；否则tee对象无法得知 iterable 可能已向后迭代。

tee 迭代器不是线程安全的。当同时使用由同一个 tee() 调用所返回的迭代器时可能引发 RuntimeError，即使原本的 iterable 是线程安全的。

该迭代工具可能需要相当大的辅助存储空间（这取决于要保存多少临时数据）。通常，如果一个迭代器在另一个迭代器开始之前就要使用大部份或全部数据，使用 list() 会比 tee() 更快。

itertools.zip_longest(*iterables, fillvalue=None)

创建一个迭代器，从每个可迭代对象中收集元素。如果可迭代对象的长度未对齐，将根据 fillvalue 填充缺失值。迭代持续到耗光最长的可迭代对象。大致相当于：

def zip_longest(*args, fillvalue=None):
    # zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-
    iterators = [iter(it) for it in args]
    num_active = len(iterators)
    if not num_active:
        return
    while True:
        values = []
        for i, it in enumerate(iterators):
            try:
                value = next(it)
            except StopIteration:
                num_active -= 1
                if not num_active:
                    return
                iterators[i] = repeat(fillvalue)
                value = fillvalue
            values.append(value)
        yield tuple(values)

如果其中一个可迭代对象有无限长度，zip_longest() 函数应封装在限制调用次数的场景中（例如 islice() 或 takewhile()）。除非指定， fillvalue 默认为 None 。

itertools 配方

本节将展示如何使用现有的 itertools 作为基础构件来创建扩展的工具集。

基本上所有这些西方和许许多多其他的配方都可以通过 Python Package Index 上的 more-itertools 项目 [https://pypi.org/project/more-itertools/] 来安装:

pip install more-itertools

扩展的工具提供了与底层工具集相同的高性能。保持了超棒的内存利用率，因为一次只处理一个元素，而不是将整个可迭代对象加载到内存。代码量保持得很小，以函数式风格将这些工具连接在一起，有助于消除临时变量。速度依然很快，因为倾向于使用“矢量化”构件来取代解释器开销大的 for 循环和 generator 。

def take(n, iterable):
    "Return first n items of the iterable as a list"
    return list(islice(iterable, n))

def prepend(value, iterator):
    "Prepend a single value in front of an iterator"
    # prepend(1, [2, 3, 4]) -> 1 2 3 4
    return chain([value], iterator)

def tabulate(function, start=0):
    "Return function(0), function(1), ..."
    return map(function, count(start))

def tail(n, iterable):
    "Return an iterator over the last n items"
    # tail(3, 'ABCDEFG') --> E F G
    return iter(collections.deque(iterable, maxlen=n))

def consume(iterator, n=None):
    "Advance the iterator n-steps ahead. If n is None, consume entirely."
    # Use functions that consume iterators at C speed.
    if n is None:
        # feed the entire iterator into a zero-length deque
        collections.deque(iterator, maxlen=0)
    else:
        # advance to the empty slice starting at position n
        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 all_equal(iterable):
    "Returns True if all the elements are equal to each other"
    g = groupby(iterable)
    return next(g, True) and not next(g, False)

def quantify(iterable, pred=bool):
    "Count how many times the predicate is true"
    return sum(map(pred, iterable))

def pad_none(iterable):
    """Returns the sequence elements and then returns None indefinitely.

    Useful for emulating the behavior of the built-in map() function.
    """
    return chain(iterable, repeat(None))

def ncycles(iterable, n):
    "Returns the sequence elements n times"
    return chain.from_iterable(repeat(tuple(iterable), n))

def dotproduct(vec1, vec2):
    return sum(map(operator.mul, vec1, vec2))

def convolve(signal, kernel):
    # See:  https://betterexplained.com/articles/intuitive-convolution/
    # convolve(data, [0.25, 0.25, 0.25, 0.25]) --> Moving average (blur)
    # convolve(data, [1, -1]) --> 1st finite difference (1st derivative)
    # convolve(data, [1, -2, 1]) --> 2nd finite difference (2nd derivative)
    kernel = tuple(kernel)[::-1]
    n = len(kernel)
    window = collections.deque([0], maxlen=n) * n
    for x in chain(signal, repeat(0, n-1)):
        window.append(x)
        yield sum(map(operator.mul, kernel, window))

def flatten(list_of_lists):
    "Flatten one level of nesting"
    return chain.from_iterable(list_of_lists)

def repeatfunc(func, times=None, *args):
    """Repeat calls to func with specified arguments.

    Example:  repeatfunc(random.random)
    """
    if times is None:
        return starmap(func, repeat(args))
    return starmap(func, repeat(args, times))

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
    args = [iter(iterable)] * n
    if incomplete == 'fill':
        return zip_longest(*args, fillvalue=fillvalue)
    if incomplete == 'strict':
        return zip(*args, strict=True)
    if incomplete == 'ignore':
        return zip(*args)
    else:
        raise ValueError('Expected fill, strict, or ignore')

def triplewise(iterable):
    "Return overlapping triplets from an iterable"
    # triplewise('ABCDEFG') -> ABC BCD CDE DEF EFG
    for (a, _), (b, c) in pairwise(pairwise(iterable)):
        yield a, b, c

def sliding_window(iterable, n):
    # sliding_window('ABCDEFG', 4) -> ABCD BCDE CDEF DEFG
    it = iter(iterable)
    window = collections.deque(islice(it, n), maxlen=n)
    if len(window) == n:
        yield tuple(window)
    for x in it:
        window.append(x)
        yield tuple(window)

def roundrobin(*iterables):
    "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
    # Recipe credited to George Sakkis
    num_active = len(iterables)
    nexts = cycle(iter(it).__next__ for it in iterables)
    while num_active:
        try:
            for next in nexts:
                yield next()
        except StopIteration:
            # Remove the iterator we just exhausted from the cycle.
            num_active -= 1
            nexts = cycle(islice(nexts, num_active))

def partition(pred, iterable):
    "Use a predicate to partition entries into false entries and true entries"
    # partition(is_odd, range(10)) --> 0 2 4 6 8   and  1 3 5 7 9
    t1, t2 = tee(iterable)
    return filterfalse(pred, t1), filter(pred, t2)

def before_and_after(predicate, it):
    """ Variant of takewhile() that allows complete
        access to the remainder of the iterator.

        >>> it = iter('ABCdEfGhI')
        >>> all_upper, remainder = before_and_after(str.isupper, it)
        >>> ''.join(all_upper)
        'ABC'
        >>> ''.join(remainder)     # takewhile() would lose the 'd'
        'dEfGhI'

        Note that the first iterator must be fully
        consumed before the second iterator can
        generate valid results.
    """
    it = iter(it)
    transition = []
    def true_iterator():
        for elem in it:
            if predicate(elem):
                yield elem
            else:
                transition.append(elem)
                return
    def remainder_iterator():
        yield from transition
        yield from it
    return true_iterator(), remainder_iterator()

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(operator.getitem, repeat(seq), slices)

def powerset(iterable):
    "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 unique_everseen(iterable, key=None):
    "List unique elements, preserving order. Remember all elements ever seen."
    # unique_everseen('AAAABBBCCDAABBB') --> A B C D
    # unique_everseen('ABBCcAD', str.lower) --> A B C D
    seen = set()
    seen_add = seen.add
    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_justseen(iterable, key=None):
    "List unique elements, preserving order. Remember only the element just seen."
    # unique_justseen('AAAABBBCCDAABBB') --> A B C D A B
    # unique_justseen('ABBCcAD', str.lower) --> A B C A D
    return map(next, map(operator.itemgetter(1), groupby(iterable, key)))

def iter_except(func, exception, first=None):
    """ Call a function repeatedly until an exception is raised.

    Converts a call-until-exception interface to an iterator interface.
    Like builtins.iter(func, sentinel) but uses an exception instead
    of a sentinel to end the loop.

    Examples:
        iter_except(functools.partial(heappop, h), IndexError)   # priority queue iterator
        iter_except(d.popitem, KeyError)                         # non-blocking dict iterator
        iter_except(d.popleft, IndexError)                       # non-blocking deque iterator
        iter_except(q.get_nowait, Queue.Empty)                   # loop over a producer Queue
        iter_except(s.pop, KeyError)                             # non-blocking set iterator

    """
    try:
        if first is not None:
            yield first()            # For database APIs needing an initial cast to db.first()
        while True:
            yield func()
    except exception:
        pass

def first_true(iterable, default=False, pred=None):
    """Returns the first true value in the iterable.

    If no true value is found, returns *default*

    If *pred* is not None, returns the first item
    for which pred(item) is true.

    """
    # 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(pred, iterable), default)

def random_product(*args, repeat=1):
    "Random selection from itertools.product(*args, **kwds)"
    pools = [tuple(pool) for pool in args] * 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):
    "Random selection from 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 nth_combination(iterable, r, index):
    "Equivalent to list(combinations(iterable, r))[index]"
    pool = tuple(iterable)
    n = len(pool)
    if r < 0 or r > n:
        raise ValueError
    c = 1
    k = min(r, n-r)
    for i in range(1, k+1):
        c = c * (n - k + i) // i
    if index < 0:
        index += c
    if index < 0 or index >= c:
        raise IndexError
    result = []
    while r:
        c, n, r = c*r//n, n-1, r-1
        while index >= c:
            index -= c
            c, n = c*(n-r)//n, n-1
        result.append(pool[-1-n])
    return tuple(result)

functools --- 高阶函数和可调用对象上的操作

源代码: Lib/functools.py [https://github.com/python/cpython/tree/3.10/Lib/functools.py]

functools 模块应用于高阶函数，即参数或（和）返回值为其他函数的函数。 通常来说，此模块的功能适用于所有可调用对象。

functools 模块定义了以下函数:

@functools.cache(user_function)

简单轻量级未绑定函数缓存。 有时称为 "memoize" [https://en.wikipedia.org/wiki/Memoization]。

返回值与 lru_cache(maxsize=None) 相同，创建一个查找函数参数的字典的简单包装器。 因为它不需要移出旧值，所以比带有大小限制的 lru_cache() 更小更快。

例如：

@cache
def factorial(n):
    return n * factorial(n-1) if n else 1

>>> factorial(10)      # no previously cached result, makes 11 recursive calls
3628800
>>> factorial(5)       # just looks up cached value result
120
>>> factorial(12)      # makes two new recursive calls, the other 10 are cached
479001600

3.9 新版功能.

@functools.cached_property(func)

将一个类方法转换为特征属性，一次性计算该特征属性的值，然后将其缓存为实例生命周期内的普通属性。 类似于 property() 但增加了缓存功能。 对于在其他情况下实际不可变的高计算资源消耗的实例特征属性来说该函数非常有用。

示例:

class DataSet:

    def __init__(self, sequence_of_numbers):
        self._data = tuple(sequence_of_numbers)

    @cached_property
    def stdev(self):
        return statistics.stdev(self._data)

cached_property() 的设定与 property() 有所不同。 常规的 property 会阻止属性写入，除非定义了 setter。 与之相反，cached_property 则允许写入。

cached_property 装饰器仅在执行查找且不存在同名属性时才会运行。 当运行时，cached_property 会写入同名的属性。 后续的属性读取和写入操作会优先于 cached_property 方法，其行为就像普通的属性一样。

缓存的值可通过删除该属性来清空。 这允许 cached_property 方法再次运行。

注意，这个装饰器会影响 PEP 412 [https://www.python.org/dev/peps/pep-0412] 键共享字典的操作。 这意味着相应的字典实例可能占用比通常时更多的空间。

而且，这个装饰器要求每个实例上的 __dict__ 是可变的映射。 这意味着它将不适用于某些类型，例如元类（因为类型实例上的 __dict__ 属性是类命名空间的只读代理），以及那些指定了 __slots__ 但未包括 __dict__ 作为所定义的空位之一的类（因为这样的类根本没有提供 __dict__ 属性）。

如果可变的映射不可用或者如果想要节省空间的键共享，可以通过在 cache() 之上堆叠一个 property() 来实现类似 cached_property() 的效果:

class DataSet:
    def __init__(self, sequence_of_numbers):
        self._data = sequence_of_numbers

    @property
    @cache
    def stdev(self):
        return statistics.stdev(self._data)

3.8 新版功能.

functools.cmp_to_key(func)

将(旧式的)比较函数转换为新式的 key function . 在类似于 sorted() ， min() ， max() ， heapq.nlargest() ， heapq.nsmallest() ， itertools.groupby() 等函数的 key 参数中使用。此函数主要用作将 Python 2 程序转换至新版的转换工具，以保持对比较函数的兼容。

比较函数是任何接受两个参数，比较它们，并在结果为小于时返回负数，等于时返回零，大于时返回正数的可调用对象。键函数是接受一个参数并返回另一值的可调用对象，返回值在排序时被用作键。

示例:

sorted(iterable, key=cmp_to_key(locale.strcoll))  # locale-aware sort order

有关排序示例和简要排序教程，请参阅 排序指南 。

3.2 新版功能.

@functools.lru_cache(user_function)

@functools.lru_cache(maxsize=128, typed=False)

一个为函数提供缓存功能的装饰器，缓存 maxsize 组传入参数，在下次以相同参数调用时直接返回上一次的结果。用以节约高开销或I/O函数的调用时间。

由于使用字典来缓存结果，因此传给该函数的位置和关键字参数必须为 hashable。

不同模式的参数可能被视为不同从而产生多个缓存项，例如, f(a=1, b=2) 和 f(b=2, a=1) 因其参数顺序不同，可能会被缓存两次。

如果指定了 user_function，它必须是一个可调用对象。 这允许 lru_cache 装饰器被直接应用于一个用户自定义函数，让 maxsize 保持其默认值 128:

@lru_cache
def count_vowels(sentence):
    return sum(sentence.count(vowel) for vowel in 'AEIOUaeiou')

如果 maxsize 设为 None，LRU 特性将被禁用且缓存可无限增长。

如果 typed 被设置为 true ，不同类型的函数参数将被分别缓存。 如果 typed 为 false ，实现通常会将它们视为等价的调用，只缓存一个结果。(有些类型，如 str 和 int ，即使 typed 为 false ，也可能被分开缓存）。

注意，类型的特殊性只适用于函数的直接参数而不是它们的内容。 标量参数 Decimal(42) 和 Fraction(42) 被视为具有不同结果的不同调用。相比之下，元组参数 ('answer', Decimal(42)) 和 ('answer', Fraction(42)) 被视为等同的。

被包装的函数配有一个 cache_parameters() 函数，该函数返回一个新的 dict 用来显示 maxsize 和 typed 的值。 这只是出于显示信息的目的。 改变值没有任何效果。

为了帮助衡量缓存的有效性以及调整 maxsize 形参，被包装的函数会带有一个 cache_info() 函数，它返回一个 named tuple 以显示 hits, misses, maxsize 和 currsize。

该装饰器也提供了一个用于清理/使缓存失效的函数 cache_clear() 。

原始的未经装饰的函数可以通过 __wrapped__ 属性访问。它可以用于检查、绕过缓存，或使用不同的缓存再次装饰原始函数。

缓存会保持对参数的引用并返回值，直到它们结束生命期退出缓存或者直到缓存被清空。

LRU（最久未使用算法）缓存 [https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_recently_used_(LRU)] 在最近的调用是即将到来的调用的最佳预测值时性能最好（例如，新闻服务器上最热门文章倾向于每天更改）。 缓存的大小限制可确保缓存不会在长期运行进程如网站服务器上无限制地增长。

一般来说，LRU缓存只在当你想要重用之前计算的结果时使用。因此，用它缓存具有副作用的函数、需要在每次调用时创建不同、易变的对象的函数或者诸如time（）或random（）之类的不纯函数是没有意义的。

静态 Web 内容的 LRU 缓存示例:

@lru_cache(maxsize=32)
def get_pep(num):
    'Retrieve text of a Python Enhancement Proposal'
    resource = 'https://www.python.org/dev/peps/pep-%04d/' % num
    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)

以下是使用缓存通过 动态规划 [https://zh.wikipedia.org/wiki/动态规划] 计算 斐波那契数列 [https://zh.wikipedia.org/wiki/斐波那契数列] 的例子。

@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)

3.2 新版功能.

在 3.3 版更改: 添加 typed 选项。

在 3.8 版更改: 添加了 user_function 选项。

3.9 新版功能: 新增函数 cache_parameters()

@functools.total_ordering

给定一个声明一个或多个全比较排序方法的类，这个类装饰器实现剩余的方法。这减轻了指定所有可能的全比较操作的工作。

此类必须包含以下方法之一：__lt__() 、__le__()、__gt__() 或 __ge__()。另外，此类必须支持 __eq__() 方法。

例如：

@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()))

注解

虽然此装饰器使得创建具有良好行为的完全有序类型变得非常容易，但它 确实 是以执行速度更缓慢和派生比较方法的堆栈回溯更复杂为代价的。 如果性能基准测试表明这是特定应用的瓶颈所在，则改为实现全部六个富比较方法应该会轻松提升速度。

注解

这个装饰器不会尝试重写类 或其上级类 中已经被声明的方法。 这意味着如果某个上级类定义了比较运算符，则 total_ordering 将不会再次实现它，即使原方法是抽象方法。

3.2 新版功能.

在 3.4 版更改: 现在已支持从未识别类型的下层比较函数返回 NotImplemented 异常。

functools.partial(func, /, *args, **keywords)

返回一个新的 部分对象，当被调用时其行为类似于 func 附带位置参数 args 和关键字参数 keywords 被调用。 如果为调用提供了更多的参数，它们会被附加到 args。 如果提供了额外的关键字参数，它们会扩展并重写 keywords。 大致等价于:

def partial(func, /, *args, **keywords):
    def newfunc(*fargs, **fkeywords):
        newkeywords = {**keywords, **fkeywords}
        return func(*args, *fargs, **newkeywords)
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc

partial() 会被“冻结了”一部分函数参数和/或关键字的部分函数应用所使用，从而得到一个具有简化签名的新对象。 例如，partial() 可用来创建一个行为类似于 int() 函数的可调用对象，其中 base 参数默认为二：

>>> from functools import partial
>>> basetwo = partial(int, base=2)
>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
>>> basetwo('10010')
18

class functools.partialmethod(func, /, *args, **keywords)

返回一个新的 partialmethod 描述器，其行为类似 partial 但它被设计用作方法定义而非直接用作可调用对象。

func 必须是一个 descriptor 或可调用对象（同属两者的对象例如普通函数会被当作描述器来处理）。

当 func 是一个描述器（例如普通 Python 函数, classmethod(), staticmethod(), abstractmethod() 或其他 partialmethod 的实例）时, 对 __get__ 的调用会被委托给底层的描述器，并会返回一个适当的 部分对象 作为结果。

当 func 是一个非描述器类可调用对象时，则会动态创建一个适当的绑定方法。 当用作方法时其行为类似普通 Python 函数：将会插入 self 参数作为第一个位置参数，其位置甚至会处于提供给 partialmethod 构造器的 args 和 keywords 之前。

示例:

>>> 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

3.4 新版功能.

functools.reduce(function, iterable[, initializer])

将两个参数的 function 从左至右积累地应用到 iterable 的条目，以便将该可迭代对象缩减为单一的值。 例如，reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) 是计算 ((((1+2)+3)+4)+5) 的值。 左边的参数 x 是积累值而右边的参数 y 则是来自 iterable 的更新值。 如果存在可选项 initializer，它会被放在参与计算的可迭代对象的条目之前，并在可迭代对象为空时作为默认值。 如果没有给出 initializer 并且 iterable 仅包含一个条目，则将返回第一项。

大致相当于：

def reduce(function, iterable, initializer=None):
    it = iter(iterable)
    if initializer is None:
        value = next(it)
    else:
        value = initializer
    for element in it:
        value = function(value, element)
    return value

请参阅 itertools.accumulate() 了解有关可产生所有中间值的迭代器。

@functools.singledispatch

将一个函数转换为 单分派 generic function。

要定义一个泛型函数，用装饰器 @singledispatch 来装饰它。当使用 @singledispatch 定义一个函数时，请注意调度发生在第一个参数的类型上:

>>> from functools import singledispatch
>>> @singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)

要将重载的实现添加到函数中，请使用泛型函数的 register() 属性，它可以被用作装饰器。 对于带有类型标注的函数，该装饰器将自动推断第一个参数的类型:

>>> @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)

对于不使用类型标注的代码，可以将适当的类型参数显式地传给装饰器本身:

>>> @fun.register(complex)
... def _(arg, verbose=False):
...     if verbose:
...         print("Better than complicated.", end=" ")
...     print(arg.real, arg.imag)
...

要启用注册 lambda 和现有的函数，也可以使用 register() 属性的函数形式:

>>> def nothing(arg, verbose=False):
...     print("Nothing.")
...
>>> fun.register(type(None), nothing)

register() 属性会返回未被装饰的函数。 这将启用装饰器栈、封存，并为每个变量单独创建单元测试:

>>> @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

在调用时，泛型函数会根据第一个参数的类型进行分派:

>>> 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

在没有针对特定类型的已注册实现的情况下，会使用其方法解析顺序来查找更通用的实现。 使用 @singledispatch 装饰的原始函数将为基本的 object 类型进行注册，这意味着它将在找不到更好的实现时被使用。

如果一个实现被注册到 abstract base class，则基类的虚拟子类将被发送到该实现:

>>> 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

要检查泛型函数将为给定的类型选择哪个实现，请使用 dispatch() 属性:

>>> fun.dispatch(float)
<function fun_num at 0x1035a2840>
>>> fun.dispatch(dict)    # note: default implementation
<function fun at 0x103fe0000>

要访问所有已注册实现，请使用只读的 registry 属性:

>>> 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>

3.4 新版功能.

在 3.7 版更改: register() 属性现在支持使用类型标注。

class functools.singledispatchmethod(func)

将一个方法转换为 单分派 generic function。

要定义一个泛型方法，请用 @singledispatchmethod 装饰器来装饰它。 当使用 @singledispatchmethod 定义一个函数时，请注意发送操作将针对第一个非 self 或非 cls 参数的类型上:

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

@singledispatchmethod 支持与其他装饰器如 @classmethod 相嵌套。 请注意为了允许 dispatcher.register，singledispatchmethod 必须是 最外层的 装饰器。 下面是一个 Negator 类包含绑定到类的 neg 方法，而不是一个类实例:

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

同样的模式也可被用于其他类似的装饰器: @staticmethod, @abstractmethod 等等。

3.8 新版功能.

functools.update_wrapper(wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

更新一个 wrapper 函数以使其类似于 wrapped 函数。 可选参数为指明原函数的哪些属性要直接被赋值给 wrapper 函数的匹配属性的元组，并且这些 wrapper 函数的属性将使用原函数的对应属性来更新。 这些参数的默认值是模块级常量 WRAPPER_ASSIGNMENTS (它将被赋值给 wrapper 函数的 __module__, __name__, __qualname__, __annotations__ 和 __doc__ 即文档字符串) 以及 WRAPPER_UPDATES (它将更新 wrapper 函数的 __dict__ 即实例字典)。

为了允许出于内省和其他目的访问原始函数（例如绕过 lru_cache() 之类的缓存装饰器），此函数会自动为 wrapper 添加一个指向被包装函数的 __wrapped__ 属性。

此函数的主要目的是在 decorator 函数中用来包装被装饰的函数并返回包装器。 如果包装器函数未被更新，则被返回函数的元数据将反映包装器定义而不是原始函数定义，这通常没有什么用处。

update_wrapper() 可以与函数之外的可调用对象一同使用。 在 assigned 或 updated 中命名的任何属性如果不存在于被包装对象则会被忽略（即该函数将不会尝试在包装器函数上设置它们）。 如果包装器函数自身缺少在 updated 中命名的任何属性则仍将引发 AttributeError。

3.2 新版功能: 自动添加 __wrapped__ 属性。

3.2 新版功能: 默认拷贝 __annotations__ 属性。

在 3.2 版更改: 不存在的属性将不再触发 AttributeError。

在 3.4 版更改: __wrapped__ 属性现在总是指向被包装的函数，即使该函数定义了 __wrapped__ 属性。 (参见 bpo-17482 [https://bugs.python.org/issue?@action=redirect&bpo=17482])

@functools.wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

这是一个便捷函数，用于在定义包装器函数时唤起 update_wrapper() 作为函数装饰器。 它等价于 partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)。 例如:

>>> 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'

如果不使用这个装饰器工厂函数，则 example 函数的名称将变为 'wrapper'，并且 example() 原本的文档字符串将会丢失。

partial 对象

partial 对象是由 partial() 创建的可调用对象。 它们具有三个只读属性：

partial.func

一个可调用对象或函数。 对 partial 对象的调用将被转发给 func 并附带新的参数和关键字。

partial.args

最左边的位置参数将放置在提供给 partial 对象调用的位置参数之前。

partial.keywords

当调用 partial 对象时将要提供的关键字参数。

partial 对象与 function 对象的类似之处在于它们都是可调用、可弱引用的对象并可拥有属性。 但两者也存在一些重要的区别。 例如前者不会自动创建 __name__ 和 __doc__ 属性。 而且，在类中定义的 partial 对象的行为类似于静态方法，并且不会在实例属性查找期间转换为绑定方法。

operator --- 标准运算符替代函数

源代码: Lib/operator.py [https://github.com/python/cpython/tree/3.10/Lib/operator.py]

operator 模块提供了一套与Python的内置运算符对应的高效率函数。例如，operator.add(x, y) 与表达式 x+y 相同。 许多函数名与特殊方法名相同，只是没有双下划线。为了向后兼容性，也保留了许多包含双下划线的函数。为了表述清楚，建议使用没有双下划线的函数。

函数包含的种类有：对象的比较运算、逻辑运算、数学运算以及序列运算。

对象比较函数适用于所有的对象，函数名根据它们对应的比较运算符命名。

operator.lt(a, b)

operator.le(a, b)

operator.eq(a, b)

operator.ne(a, b)

operator.ge(a, b)

operator.gt(a, b)

operator.__lt__(a, b)

operator.__le__(a, b)

operator.__eq__(a, b)

operator.__ne__(a, b)

operator.__ge__(a, b)

operator.__gt__(a, b)

在 a 和 b 之间进行全比较。具体的，lt(a, b) 与 a < b 相同， le(a, b) 与 a <= b 相同，eq(a, b) 与 a == b 相同，ne(a, b) 与 a != b 相同，gt(a, b) 与 a > b 相同，ge(a, b) 与 a >= b 相同。注意这些函数可以返回任何值，无论它是否可当作布尔值。关于全比较的更多信息请参考 比较运算 。

逻辑运算通常也适用于所有对象，并且支持真值检测、标识检测和布尔运算：

operator.not_(obj)

operator.__not__(obj)

返回 not obj 的结果。 （请注意对象实例并没有 __not__() 方法；只有解释器核心可定义此操作。 结果会受 __bool__() 和 __len__() 方法影响。）

operator.truth(obj)

如果 obj 为真值则返回 True，否则返回 False。 这等价于使用 bool 构造器。

operator.is_(a, b)

返回 a is b。 检测对象标识。

operator.is_not(a, b)

返回 a is not b。 检测对象标识。

数学和按位运算的种类是最多的：

operator.abs(obj)

operator.__abs__(obj)

返回 obj 的绝对值。

operator.add(a, b)

operator.__add__(a, b)

对于数字 a 和 b，返回 a + b。

operator.and_(a, b)

operator.__and__(a, b)

返回 x 和 y 按位与的结果。

operator.floordiv(a, b)

operator.__floordiv__(a, b)

返回 a // b。

operator.index(a)

operator.__index__(a)

返回 a 转换为整数的结果。 等价于 a.__index__()。

在 3.10 版更改: 结果总是为 int 类型。 在之前版本中，结果可能为 int 的子类的实例。

operator.inv(obj)

operator.invert(obj)

operator.__inv__(obj)

operator.__invert__(obj)

返回数字 obj 按位取反的结果。 这等价于 ~obj。

operator.lshift(a, b)

operator.__lshift__(a, b)

返回 a 左移 b 位的结果。

operator.mod(a, b)

operator.__mod__(a, b)

返回 a % b。

operator.mul(a, b)

operator.__mul__(a, b)

对于数字 a 和 b，返回 a * b。

operator.matmul(a, b)

operator.__matmul__(a, b)

返回 a @ b。

3.5 新版功能.

operator.neg(obj)

operator.__neg__(obj)

返回 obj 取负的结果 (-obj)。

operator.or_(a, b)

operator.__or__(a, b)

返回 a 和 b 按位或的结果。

operator.pos(obj)

operator.__pos__(obj)

返回 obj 取正的结果 (+obj)。

operator.pow(a, b)

operator.__pow__(a, b)

对于数字 a 和 b，返回 a ** b。

operator.rshift(a, b)

operator.__rshift__(a, b)

返回 a 右移 b 位的结果。

operator.sub(a, b)

operator.__sub__(a, b)

返回 a - b。

operator.truediv(a, b)

operator.__truediv__(a, b)

返回 a / b 例如 2/3 将等于 .66 而不是 0。 这也被称为“真”除法。

operator.xor(a, b)

operator.__xor__(a, b)

返回 a 和 b 按位异或的结果。

适用于序列的操作（其中一些也适用于映射）包括：

operator.concat(a, b)

operator.__concat__(a, b)

对于序列 a 和 b，返回 a + b。

operator.contains(a, b)

operator.__contains__(a, b)

返回 b in a 检测的结果。 请注意操作数是反序的。

operator.countOf(a, b)

返回 b 在 a 中的出现次数。

operator.delitem(a, b)

operator.__delitem__(a, b)

移除 a 中索引号为 b 的值。

operator.getitem(a, b)

operator.__getitem__(a, b)

返回 a 中索引为 b 的值。

operator.indexOf(a, b)

返回 b 在 a 中首次出现所在的索引号。

operator.setitem(a, b, c)

operator.__setitem__(a, b, c)

将 a 中索引号为 b 的值设为 c。

operator.length_hint(obj, default=0)

返回对象 o 的估计长度。 首先尝试返回其实际长度，再使用 object.__length_hint__() 得出估计值，最后返回默认值。

3.4 新版功能.

operator 模块还定义了一些用于常规属性和条目查找的工具。 这些工具适合用来编写快速字段提取器作为 map(), sorted(), itertools.groupby() 或其他需要相应函数参数的函数的参数。

operator.attrgetter(attr)

operator.attrgetter(*attrs)

返回一个可从操作数中获取 attr 的可调用对象。 如果请求了一个以上的属性，则返回一个属性元组。 属性名称还可包含点号。 例如：

在 f = attrgetter('name') 之后，调用 f(b) 将返回 b.name。

在 f = attrgetter('name', 'date') 之后，调用 f(b) 将返回 (b.name, b.date)。

在 f = attrgetter('name.first', 'name.last') 之后，调用 f(b) 将返回 (b.name.first, b.name.last)。

等价于:

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

operator.itemgetter(item)

operator.itemgetter(*items)

返回一个使用操作数的 __getitem__() 方法从操作数中获取 item 的可调用对象。 如果指定了多个条目，则返回一个查找值的元组。 例如：

在 f = itemgetter(2) 之后，调用 f(r) 将返回 r[2]。

在 g = itemgetter(2, 5, 3) 之后，调用 g(r) 将返回 (r[2], r[5], r[3])。

等价于:

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

条目可以是操作数的 __getitem__() 方法 所接受的任何类型。 字典接受任意 hashable 值。 列表、元组和字符串接受索引或切片对象:

>>> 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'

使用 itemgetter() 从元组的记录中提取特定字段的例子：

>>> 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)]

operator.methodcaller(name, /, *args, **kwargs)

返回一个在操作数上调用 name 方法的可调用对象。 如果给出额外的参数和/或关键字参数，它们也将被传给该方法。 例如：

在 f = methodcaller('name') 之后，调用 f(b) 将返回 b.name()。

在 f = methodcaller('name', 'foo', bar=1) 之后，调用 f(b) 将返回 b.name('foo', bar=1)。

等价于:

def methodcaller(name, /, *args, **kwargs):
    def caller(obj):
        return getattr(obj, name)(*args, **kwargs)
    return caller

将运算符映射到函数

以下表格显示了抽象运算是如何对应于 Python 语法中的运算符和 operator 模块中的函数的。

运算 | 语法 | 函数
加法 | a + b | add(a, b)
字符串拼接 | seq1 + seq2 | concat(seq1, seq2)
包含测试 | obj in seq | contains(seq, obj)
除法 | a / b | truediv(a, b)
除法 | a // b | floordiv(a, b)
按位与 | a & b | and_(a, b)
按位异或 | a ^ b | xor(a, b)
按位取反 | ~ a | invert(a)
按位或 | a | b | or_(a, b)
取幂 | a ** b | pow(a, b)
标识 | a is b | is_(a, b)
标识 | a is not b | is_not(a, b)
索引赋值 | obj[k] = v | setitem(obj, k, v)
索引删除 | del obj[k] | delitem(obj, k)
索引取值 | obj[k] | getitem(obj, k)
左移 | a << b | lshift(a, b)
取模 | a % b | mod(a, b)
乘法 | a * b | mul(a, b)
矩阵乘法 | a @ b | matmul(a, b)
取反（算术） | - a | neg(a)
取反（逻辑） | not a | not_(a)
正数 | + a | pos(a)
右移 | a >> b | rshift(a, b)
切片赋值 | seq[i:j] = values | setitem(seq, slice(i, j), values)
切片删除 | del seq[i:j] | delitem(seq, slice(i, j))
切片取值 | seq[i:j] | getitem(seq, slice(i, j))
字符串格式化 | s % obj | mod(s, obj)
减法 | a - b | sub(a, b)
真值测试 | obj | truth(obj)
比较 | a < b | lt(a, b)
比较 | a <= b | le(a, b)
相等 | a == b | eq(a, b)
不等 | a != b | ne(a, b)
比较 | a >= b | ge(a, b)
比较 | a > b | gt(a, b)

原地运算符

许多运算都有“原地”版本。 以下列出的是提供对原地运算符相比通常语法更底层访问的函数，例如 statement x += y 相当于 x = operator.iadd(x, y)。 换一种方式来讲就是 z = operator.iadd(x, y) 等价于语句块 z = x; z += y。

在这些例子中，请注意当调用一个原地方法时，运算和赋值是分成两个步骤来执行的。 下面列出的原地函数只执行第一步即调用原地方法。 第二步赋值则不加处理。

对于不可变的目标例如字符串、数字和元组，更新的值会被计算，但不会被再被赋值给输入变量：

>>> a = 'hello'
>>> iadd(a, ' world')
'hello world'
>>> a
'hello'

对于可变的目标例如列表和字典，原地方法将执行更新，因此不需要后续赋值操作：

>>> 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']

operator.iadd(a, b)

operator.__iadd__(a, b)

a = iadd(a, b) 等价于 a += b。

operator.iand(a, b)

operator.__iand__(a, b)

a = iand(a, b) 等价于 a &= b。

operator.iconcat(a, b)

operator.__iconcat__(a, b)

a = iconcat(a, b) 等价于 a += b 其中 a 和 b 为序列。

operator.ifloordiv(a, b)

operator.__ifloordiv__(a, b)

a = ifloordiv(a, b) 等价于 a //= b。

operator.ilshift(a, b)

operator.__ilshift__(a, b)

a = ilshift(a, b) 等价于 a <<= b。

operator.imod(a, b)

operator.__imod__(a, b)

a = imod(a, b) 等价于 a %= b。

operator.imul(a, b)

operator.__imul__(a, b)

a = imul(a, b) 等价于 a *= b。

operator.imatmul(a, b)

operator.__imatmul__(a, b)

a = imatmul(a, b) 等价于 a @= b。

3.5 新版功能.

operator.ior(a, b)

operator.__ior__(a, b)

a = ior(a, b) 等价于 a |= b。

operator.ipow(a, b)

operator.__ipow__(a, b)

a = ipow(a, b) 等价于 a **= b。

operator.irshift(a, b)

operator.__irshift__(a, b)

a = irshift(a, b) 等价于 a >>= b。

operator.isub(a, b)

operator.__isub__(a, b)

a = isub(a, b) 等价于 a -= b。

operator.itruediv(a, b)

operator.__itruediv__(a, b)

a = itruediv(a, b) 等价于 a /= b。

operator.ixor(a, b)

operator.__ixor__(a, b)

a = ixor(a, b) 等价于 a ^= b。

文件和目录访问

本章中描述的模块处理磁盘文件和目录。 例如，有一些模块用于读取文件的属性，以可移植的方式操作路径以及创建临时文件。 本章的完整模块列表如下：

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

基础使用

纯路径

通用性质

运算符

访问个别部分

方法和特征属性

具体路径

方法

对应的 os 模块的工具

os.path --- 常用路径操作

fileinput --- 迭代来自多个输入流的行

stat --- 解析 stat() 结果

filecmp --- 文件及目录的比较

dircmp 类

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

例子

已弃用的函数和变量

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

fnmatch --- Unix 文件名模式匹配

linecache --- 随机读写文本行

shutil --- 高阶文件操作

目录和文件操作

依赖于具体平台的高效拷贝操作

copytree 示例

rmtree 示例

归档操作

归档程序示例

使用 base_dir 的归档程序示例

查询输出终端的尺寸

参见

模块 os

操作系统接口，包括处理比 Python 文件对象 更低级别文件的功能。

模块 io

Python的内置 I/O 库，包括抽象类和一些具体的类，如文件 I/O 。

内置函数 open()

使用 Python 打开文件进行读写的标准方法。

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

3.4 新版功能.

源代码：Lib/pathlib.py [https://github.com/python/cpython/tree/3.10/Lib/pathlib.py]

该模块提供表示文件系统路径的类，其语义适用于不同的操作系统。路径类被分为提供纯计算操作而没有 I/O 的 纯路径，以及从纯路径继承而来但提供 I/O 操作的 具体路径。

如果以前从未用过此模块，或不确定哪个类适合完成任务，那要用的可能就是 Path。它在运行代码的平台上实例化为 具体路径。

在一些用例中纯路径很有用，例如：

如果你想要在 Unix 设备上操作 Windows 路径（或者相反）。你不应在 Unix 上实例化一个 WindowsPath，但是你可以实例化 PureWindowsPath。

你只想操作路径但不想实际访问操作系统。在这种情况下，实例化一个纯路径是有用的，因为它们没有任何访问操作系统的操作。

参见

PEP 428 [https://www.python.org/dev/peps/pep-0428]：pathlib 模块 -- 面向对象的文件系统路径。

参见

对于底层的路径字符串操作，你也可以使用 os.path 模块。

基础使用

导入主类:

>>> from pathlib import Path

列出子目录:

>>> p = Path('.')
>>> [x for x in p.iterdir() if x.is_dir()]
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
 PosixPath('__pycache__'), PosixPath('build')]

列出当前目录树下的所有 Python 源代码文件:

>>> list(p.glob('**/*.py'))
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
 PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
 PosixPath('build/lib/pathlib.py')]

在目录树中移动:

>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
PosixPath('/etc/rc.d/init.d/halt')

查询路径的属性:

>>> q.exists()
True
>>> q.is_dir()
False

打开一个文件:

>>> with q.open() as f: f.readline()
...
'#!/bin/bash\n'

纯路径

纯路径对象提供了不实际访问文件系统的路径处理操作。有三种方式来访问这些类，也是不同的风格：

class pathlib.PurePath(*pathsegments)

一个通用的类，代表当前系统的路径风格（实例化为 PurePosixPath 或者 PureWindowsPath）:

>>> PurePath('setup.py')      # Running on a Unix machine
PurePosixPath('setup.py')

每一个 pathsegments 的元素可能是一个代表路径片段的字符串，一个返回字符串的实现了 os.PathLike 接口的对象，或者另一个路径对象:

>>> PurePath('foo', 'some/path', 'bar')
PurePosixPath('foo/some/path/bar')
>>> PurePath(Path('foo'), Path('bar'))
PurePosixPath('foo/bar')

当 pathsegments 为空的时候，假定为当前目录:

>>> PurePath()
PurePosixPath('.')

如果某个段为绝对路径，则其前面的所有段都会被忽略 (类似 os.path.join()):

>>> PurePath('/etc', '/usr', 'lib64')
PurePosixPath('/usr/lib64')
>>> PureWindowsPath('c:/Windows', 'd:bar')
PureWindowsPath('d:bar')

在 Windows 上，当遇到带根符号的路径段 (如 r'\foo') 时驱动器将不会被重置:

>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')

假斜杠和单个点号会被消除，但双点号 ('..') 和打头的双斜杠 ('//') 不会，因为这会出于各种原因改变路径的实际含义 (例如符号链接、UNC 路径等):

>>> PurePath('foo//bar')
PurePosixPath('foo/bar')
>>> PurePath('//foo/bar')
PurePosixPath('//foo/bar')
>>> PurePath('foo/./bar')
PurePosixPath('foo/bar')
>>> PurePath('foo/../bar')
PurePosixPath('foo/../bar')

（一个很 naïve 的做法是让 PurePosixPath('foo/../bar') 等同于 PurePosixPath('bar')，如果 foo 是一个指向其他目录的符号链接那么这个做法就将出错）

纯路径对象实现了 os.PathLike 接口，允许它们在任何接受此接口的地方使用。

在 3.6 版更改: 添加了 os.PathLike 接口支持。

class pathlib.PurePosixPath(*pathsegments)

一个 PurePath 的子类，路径风格不同于 Windows 文件系统:

>>> PurePosixPath('/etc')
PurePosixPath('/etc')

pathsegments 参数的指定和 PurePath 相同。

class pathlib.PureWindowsPath(*pathsegments)

PurePath 的一个子类，此路径风格代表 Windows 文件系统路径，包括 UNC paths [https://en.wikipedia.org/wiki/Path_(computing)#UNC]:

>>> PureWindowsPath('c:/Program Files/')
PureWindowsPath('c:/Program Files')
>>> PureWindowsPath('//server/share/file')
PureWindowsPath('//server/share/file')

pathsegments 参数的指定和 PurePath 相同。

无论你正运行什么系统，你都可以实例化这些类，因为它们提供的操作不做任何系统调用。

通用性质

路径是不可变并且 hashable。 相同风格的路径可以排序和比较。 这此特性会尊重对应风格的大小写转换语义。:

>>> PurePosixPath('foo') == PurePosixPath('FOO')
False
>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
True
>>> PureWindowsPath('FOO') in { PureWindowsPath('foo') }
True
>>> PureWindowsPath('C:') < PureWindowsPath('d:')
True

不同风格的路径比较得到不等的结果并且无法被排序:

>>> 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'

运算符

斜杠操作符可以帮助创建子路径，如 os.path.join()。 如果参数为一个绝对路径，则之前的路径会被忽略。 在 Windows 上，当参数为一个带根符号的相对路径 (如 r'\foo') 时驱动器将不会被重置:

>>> 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')

文件对象可用于任何接受 os.PathLike 接口实现的地方。

>>> import os
>>> p = PurePath('/etc')
>>> os.fspath(p)
'/etc'

路径的字符串表示法为它自己原始的文件系统路径（以原生形式，例如在 Windows 下使用反斜杠）。你可以传递给任何需要字符串形式路径的函数。

>>> p = PurePath('/etc')
>>> str(p)
'/etc'
>>> p = PureWindowsPath('c:/Program Files')
>>> str(p)
'c:\\Program Files'

类似地，在路径上调用 bytes 将原始文件系统路径作为字节对象给出，就像被 os.fsencode() 编码一样:

>>> bytes(p)
b'/etc'

注解

只推荐在 Unix 下调用 bytes。在 Windows， unicode 形式是文件系统路径的规范表示法。

访问个别部分

为了访问路径独立的部分 （组件），使用以下特征属性：

PurePath.parts

一个元组，可以访问路径的多个组件:

>>> p = PurePath('/usr/bin/python3')
>>> p.parts
('/', 'usr', 'bin', 'python3')

>>> p = PureWindowsPath('c:/Program Files/PSF')
>>> p.parts
('c:\\', 'Program Files', 'PSF')

（注意盘符和本地根目录是如何重组的）

方法和特征属性

纯路径提供以下方法和特征属性：

PurePath.drive

一个表示驱动器盘符或命名的字符串，如果存在:

>>> PureWindowsPath('c:/Program Files/').drive
'c:'
>>> PureWindowsPath('/Program Files/').drive
''
>>> PurePosixPath('/etc').drive
''

UNC 分享也被认作驱动器:

>>> PureWindowsPath('//host/share/foo.txt').drive
'\\\\host\\share'

PurePath.root

一个表示（本地或全局）根的字符串，如果存在:

>>> PureWindowsPath('c:/Program Files/').root
'\\'
>>> PureWindowsPath('c:Program Files/').root
''
>>> PurePosixPath('/etc').root
'/'

UNC 分享一样拥有根:

>>> PureWindowsPath('//host/share').root
'\\'

如果路径以超过两个连续斜框打头，PurePosixPath 会合并它们:

>>> PurePosixPath('//etc').root
'//'
>>> PurePosixPath('///etc').root
'/'
>>> PurePosixPath('////etc').root
'/'

注解

此行为符合 The Open Group Base Specifications Issue 6, paragraph 4.11 Pathname Resolution [https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11]:

"以连续两个斜杠打头的路径名可能会以具体实现所定义的方式被解读，但是两个以上的前缀斜杠则应当被当作一个斜杠来处理。"

PurePath.anchor

驱动器和根的联合:

>>> PureWindowsPath('c:/Program Files/').anchor
'c:\\'
>>> PureWindowsPath('c:Program Files/').anchor
'c:'
>>> PurePosixPath('/etc').anchor
'/'
>>> PureWindowsPath('//host/share').anchor
'\\\\host\\share\\'

PurePath.parents

提供访问此路径的逻辑祖先的不可变序列:

>>> 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:/')

在 3.10 版更改: parents 序列现在支持 切片 和负的索引值。

PurePath.parent

此路径的逻辑父路径:

>>> p = PurePosixPath('/a/b/c/d')
>>> p.parent
PurePosixPath('/a/b/c')

你不能超过一个 anchor 或空路径:

>>> p = PurePosixPath('/')
>>> p.parent
PurePosixPath('/')
>>> p = PurePosixPath('.')
>>> p.parent
PurePosixPath('.')

注解

这是一个单纯的词法操作，因此有以下行为:

>>> p = PurePosixPath('foo/..')
>>> p.parent
PurePosixPath('foo')

如果要向上遍历任意文件系统路径，建议首先调用 Path.resolve() 以解析符号链接并消除 ".." 部分。

PurePath.name

一个表示最后路径组件的字符串，排除了驱动器与根目录，如果存在的话:

>>> PurePosixPath('my/library/setup.py').name
'setup.py'

UNC 驱动器名不被考虑:

>>> PureWindowsPath('//some/share/setup.py').name
'setup.py'
>>> PureWindowsPath('//some/share').name
''

PurePath.suffix

最终组件的文件扩展名（如果有）：

>>> PurePosixPath('my/library/setup.py').suffix
'.py'
>>> PurePosixPath('my/library.tar.gz').suffix
'.gz'
>>> PurePosixPath('my/library').suffix
''

PurePath.suffixes

一个路径文件扩展名的列表：

>>> PurePosixPath('my/library.tar.gar').suffixes
['.tar', '.gar']
>>> PurePosixPath('my/library.tar.gz').suffixes
['.tar', '.gz']
>>> PurePosixPath('my/library').suffixes
[]

PurePath.stem

最后一个路径组件，除去后缀:

>>> PurePosixPath('my/library.tar.gz').stem
'library.tar'
>>> PurePosixPath('my/library.tar').stem
'library'
>>> PurePosixPath('my/library').stem
'library'

PurePath.as_posix()

返回使用正斜杠（/）的路径字符串:

>>> p = PureWindowsPath('c:\\windows')
>>> str(p)
'c:\\windows'
>>> p.as_posix()
'c:/windows'

PurePath.as_uri()

将路径表示为 file URI。 如果路径不是绝对路径，将引发 ValueError。

>>> p = PurePosixPath('/etc/passwd')
>>> p.as_uri()
'file:///etc/passwd'
>>> p = PureWindowsPath('c:/Windows')
>>> p.as_uri()
'file:///c:/Windows'

PurePath.is_absolute()

返回此路径是否为绝对路径。如果路径同时拥有驱动器符与根路径（如果风格允许）则将被认作绝对路径。

>>> 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

PurePath.is_relative_to(*other)

返回此路径是否相对于 other 的路径。

>>> p = PurePath('/etc/passwd')
>>> p.is_relative_to('/etc')
True
>>> p.is_relative_to('/usr')
False

3.9 新版功能.

PurePath.is_reserved()

在 PureWindowsPath，如果路径是被 Windows 保留的则返回 True，否则 False。在 PurePosixPath，总是返回 False。

>>> PureWindowsPath('nul').is_reserved()
True
>>> PurePosixPath('nul').is_reserved()
False

对保留路径的文件系统调用可能会莫名其妙地失败或产生意想不到的效果。

PurePath.joinpath(*other)

调用此方法等同于将每个 other 参数中的项目连接在一起:

>>> 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')

PurePath.match(pattern)

将此路径与所提供的 glob 样式匹配。如果匹配成功，则返回``True``，否则返回``False``。

如果 pattern 是相对路径，则路径既可以是相对路径，也可以是绝对路径，匹配从右边的开始：

>>> 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

如果 pattern 是绝对的，则路径必须是绝对的，并且路径必须完全匹配:

>>> PurePath('/a.py').match('/*.py')
True
>>> PurePath('a/b.py').match('/*.py')
False

与其他方法一样，是否大小写敏感遵循平台的默认规则:

>>> PurePosixPath('b.py').match('*.PY')
False
>>> PureWindowsPath('b.py').match('*.PY')
True

PurePath.relative_to(*other)

计算此路径相对 other 表示路径的版本。如果不可计算，则抛出 ValueError:

>>> 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 694, in relative_to
    .format(str(self), str(formatted)))
ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other absolute.

注意：此函数是 PurePath 的一部分并且适用于字符串。 它不会检查或访问下层的文件结构。

PurePath.with_name(name)

返回一个新的路径并修改 name。如果原本路径没有 name，ValueError 被抛出:

>>> 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

PurePath.with_stem(stem)

返回一个带有修改后 stem 的新路径。 如果原路径没有名称，则会引发 ValueError:

>>> 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('')
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

3.9 新版功能.

PurePath.with_suffix(suffix)

返回一个新的路径并修改 suffix。如果原本的路径没有后缀，新的 suffix 则被追加以代替。如果 suffix 是空字符串，则原本的后缀被移除:

>>> 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('')
PureWindowsPath('README')

具体路径

具体路径是纯路径的子类。除了后者提供的操作之外，它们还提供了对路径对象进行系统调用的方法。有三种方法可以实例化具体路径:

class pathlib.Path(*pathsegments)

一个 PurePath 的子类，此类以当前系统的路径风格表示路径（实例化为 PosixPath 或 WindowsPath）:

>>> Path('setup.py')
PosixPath('setup.py')

pathsegments 参数的指定和 PurePath 相同。

class pathlib.PosixPath(*pathsegments)

一个 Path 和 PurePosixPath 的子类，此类表示一个非 Windows 文件系统的具体路径:

>>> PosixPath('/etc')
PosixPath('/etc')

pathsegments 参数的指定和 PurePath 相同。

class pathlib.WindowsPath(*pathsegments)

Path 和 PureWindowsPath 的子类，从类表示一个 Windows 文件系统的具体路径:

>>> WindowsPath('c:/Program Files/')
WindowsPath('c:/Program Files')

pathsegments 参数的指定和 PurePath 相同。

你只能实例化与当前系统风格相同的类（允许系统调用作用于不兼容的路径风格可能在应用程序中导致缺陷或失败）:

>>> 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__,))
NotImplementedError: cannot instantiate 'WindowsPath' on your system

方法

除纯路径方法外，实体路径还提供以下方法。 如果系统调用失败（例如因为路径不存在）这些方法中许多都会引发 OSError。

在 3.8 版更改: 对于包含 OS 层级无法表示字符的路径，exists(), is_dir(), is_file(), is_mount(), is_symlink(), is_block_device(), is_char_device(), is_fifo(), is_socket() 现在将返回 False 而不是引发异常。

classmethod Path.cwd()

返回一个新的表示当前目录的路径对象（和 os.getcwd() 返回的相同）:

>>> Path.cwd()
PosixPath('/home/antoine/pathlib')

classmethod Path.home()

返回一个表示用户家目录的新路径对象（与带 ~ 构造的 os.path.expanduser() 所返回的相同）。 如果无法解析家目录，则会引发 RuntimeError。

>>> Path.home()
PosixPath('/home/antoine')

3.5 新版功能.

Path.stat(*, follow_symlinks=True)

返回一个 os.stat_result 对象，其中包含有关此路径的信息，例如 os.stat()。 结果会在每次调用此方法时重新搜索。

此方法通常会跟随符号链接；要对 symlink 使用 stat 请添加参数 follow_symlinks=False，或者使用 lstat()。

>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554

在 3.10 版更改: 增加了 follow_symlinks 形参。

Path.chmod(mode, *, follow_symlinks=True)

改变文件模式和权限，和 os.chmod() 一样。

此方法通常会跟随符号链接。 某些 Unix 变种支持改变 symlink 本身的权限；在这些平台上你可以添加参数 follow_symlinks=False，或者使用 lchmod()。

>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060

在 3.10 版更改: 增加了 follow_symlinks 形参。

Path.exists()

此路径是否指向一个已存在的文件或目录:

>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('nonexistentfile').exists()
False

注解

如果路径指向一个符号链接， exists() 返回此符号链接是否指向存在的文件或目录。

Path.expanduser()

返回带有扩展 ~ 和 ~user 构造的新路径，与 os.path.expanduser() 所返回的相同。 如果无法解析家目录，则会引发 RuntimeError。

>>> p = PosixPath('~/films/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/films/Monty Python')

3.5 新版功能.

Path.glob(pattern)

解析相对于此路径的通配符 pattern，产生所有匹配的文件:

>>> sorted(Path('.').glob('*.py'))
[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
>>> sorted(Path('.').glob('*/*.py'))
[PosixPath('docs/conf.py')]

pattern 的形式与 fnmatch 的相同，还增加了 "**" 表示 "此目录以及所有子目录，递归"。 换句话说，它启用递归通配:

>>> sorted(Path('.').glob('**/*.py'))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]

注解

在一个较大的目录树中使用 "**" 模式可能会消耗非常多的时间。

引发一个 审计事件 pathlib.Path.glob 并附带参数 self, pattern。

Path.group()

返回拥有此文件的用户组。如果文件的 GID 无法在系统数据库中找到，将抛出 KeyError 。

Path.is_dir()

如果文件指向一个目录（或指向目录的符号链接）则返回 True，指向其他类型的文件则返回 False。

当路径不存在或者是一个破损的符号链接时也会返回 False；其他错误（例如权限错误）被传播。

Path.is_file()

如果文件指向一个常规文件（或指向常规文件的符号链接）则返回 True，指向其他类型的文件则返回 False。

当路径不存在或者是一个破损的符号链接时也会返回 False；其他错误（例如权限错误）被传播。

Path.is_mount()

如果路径是一个 挂载点 <mount point>: 在文件系统中被其他不同的文件系统挂载的地点则返回 True。在 POSIX 系统上，此函数检查 path 的父级 —— path/.. 是否处于一个和 path 不同的设备中，或者 path/.. 和 path 是否指向相同设备的相同 i-node —— 这能检测所有 Unix 以及 POSIX 变种上的挂载点。 Windows 上未实现。

3.7 新版功能.

Path.is_symlink()

如果路径指向符号链接则返回 True， 否则 False。

如果路径不存在也返回 False；其他错误（例如权限错误）被传播。

Path.is_socket()

如果路径指向一个 Unix socket 文件（或者指向 Unix socket 文件的符号链接）则返回 True，如果指向其他类型的文件则返回 False。

当路径不存在或者是一个破损的符号链接时也会返回 False；其他错误（例如权限错误）被传播。

Path.is_fifo()

如果路径指向一个先进先出存储（或者指向先进先出存储的符号链接）则返回 True ，指向其他类型的文件则返回 False。

当路径不存在或者是一个破损的符号链接时也会返回 False；其他错误（例如权限错误）被传播。

Path.is_block_device()

如果文件指向一个块设备（或者指向块设备的符号链接）则返回 True，指向其他类型的文件则返回 False。

当路径不存在或者是一个破损的符号链接时也会返回 False；其他错误（例如权限错误）被传播。

Path.is_char_device()

如果路径指向一个字符设备（或指向字符设备的符号链接）则返回 True，指向其他类型的文件则返回 False。

当路径不存在或者是一个破损的符号链接时也会返回 False；其他错误（例如权限错误）被传播。

Path.iterdir()

当路径指向一个目录时，产生该路径下的对象的路径:

>>> 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')

子条目会以任意顺序生成，并且不包括特殊条目 '.' 和 '..'。 如果迭代器创建之后有文件在目录中被移除或添加，是否要包括该文件所对应的路径对象并没有明确规定。

Path.lchmod(mode)

就像 Path.chmod() 但是如果路径指向符号链接则是修改符号链接的模式，而不是修改符号链接的目标。

Path.lstat()

就和 Path.stat() 一样，但是如果路径指向符号链接，则是返回符号链接而不是目标的信息。

Path.mkdir(mode=0o777, parents=False, exist_ok=False)

新建给定路径的目录。如果给出了 mode ，它将与当前进程的 umask 值合并来决定文件模式和访问标志。如果路径已经存在，则抛出 FileExistsError。

如果 parents 为真值，任何找不到的父目录都会伴随着此路径被创建；它们会以默认权限被创建，而不考虑 mode 设置（模仿 POSIX 的 mkdir -p 命令）。

如果 parents 为假值（默认），则找不到的父级目录会引发 FileNotFoundError。

如果 exist_ok 为 false（默认），则在目标已存在的情况下抛出 FileExistsError。

如果 exist_ok 为 true， 则 FileExistsError 异常将被忽略（和 POSIX mkdir -p 命令行为相同），但是只有在最后一个路径组件不是现存的非目录文件时才生效。

在 3.5 版更改: exist_ok 形参被加入。

Path.open(mode='r', buffering=- 1, encoding=None, errors=None, newline=None)

打开路径指向的文件，就像内置的 open() 函数所做的一样:

>>> p = Path('setup.py')
>>> with p.open() as f:
...     f.readline()
...
'#!/usr/bin/env python3\n'

Path.owner()

返回拥有此文件的用户名。如果文件的 UID 无法在系统数据库中找到，则抛出 KeyError。

Path.read_bytes()

以字节对象的形式返回路径指向的文件的二进制内容:

>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'

3.5 新版功能.

Path.read_text(encoding=None, errors=None)

以字符串形式返回路径指向的文件的解码后文本内容。

>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'

文件先被打开然后关闭。有和 open() 一样的可选形参。

3.5 新版功能.

Path.readlink()

返回符号链接所指向的路径（即 os.readlink() 的返回值）:

>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.readlink()
PosixPath('setup.py')

3.9 新版功能.

Path.rename(target)

将文件名目录重命名为给定的 target，并返回一个新的指向 target 的 Path 实例。 在 Unix 上，如果 target 存在且为一个文件，如果用户有足够权限则它将被静默地替换。 在 Windows 上，如果 target 存在，则将会引发 FileExistsError。 target 可以是一个字符串或者另一个路径对象:

>>> p = Path('foo')
>>> p.open('w').write('some text')
9
>>> target = Path('bar')
>>> p.rename(target)
PosixPath('bar')
>>> target.open().read()
'some text'

目标路径可能为绝对或相对路径。 相对路径将被解释为相对于当前工作目录，而 不是 相对于 Path 对象的目录。

它根据 os.rename() 实现并给出了同样的保证。

在 3.8 版更改: 添加了返回值，返回新的 Path 实例。

Path.replace(target)

将文件或目录重命名为给定的 target，并返回一个新的指向 target 的 Path 实例。 如果 target 指向一个现有文件或空目录，则它将被无条件地替换。

目标路径可能为绝对或相对路径。 相对路径将被解释为相对于当前工作目录，而 不是 相对于 Path 对象的目录。

在 3.8 版更改: 添加了返回值，返回新的 Path 实例。

Path.resolve(strict=False)

将路径绝对化，解析任何符号链接。返回新的路径对象:

>>> p = Path()
>>> p
PosixPath('.')
>>> p.resolve()
PosixPath('/home/antoine/pathlib')

".." 组件也将被消除（只有这一种方法这么做）:

>>> p = Path('docs/../setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')

如果路径不存在并且 strict 设为 True，则抛出 FileNotFoundError。如果 strict 为 False，则路径将被尽可能地解析并且任何剩余部分都会被不检查是否存在地追加。如果在解析路径上发生无限循环，则抛出 RuntimeError。

3.6 新版功能: 加入*strict* 参数（3.6之前的版本相当于strict值为True）

Path.rglob(pattern)

这就像调用 Path.glob() 并在给定的相对 pattern 前面添加了 "**/":

>>> sorted(Path().rglob("*.py"))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]

引发一个 审计事件 pathlib.Path.rglob 并附带参数 self, pattern。

Path.rmdir()

移除此目录。此目录必须为空的。

Path.samefile(other_path)

返回此目录是否指向与可能是字符串或者另一个路径对象的 other_path 相同的文件。语义类似于 os.path.samefile() 与 os.path.samestat()。

如果两者都以同一原因无法访问，则抛出 OSError。

>>> p = Path('spam')
>>> q = Path('eggs')
>>> p.samefile(q)
False
>>> p.samefile('spam')
True

3.5 新版功能.

Path.symlink_to(target, target_is_directory=False)

将此路径创建为指向 target 的符号链接。在 Windows 下，如果链接的目标是一个目录则 target_is_directory 必须为 true （默认为 False）。在 POSIX 下， target_is_directory 的值将被忽略。

>>> 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

注解

参数的顺序（link, target) 和 os.symlink() 是相反的。

Path.hardlink_to(target)

将此路径设为一个指向与 target 相同文件的硬链接。

注解

参数顺序 (link, target) 和 os.link() 是相反的。

3.10 新版功能.

Path.link_to(target)

创建硬链接 target 指向此路径。

警告

此函数不会将此路径设为指向 target 的硬链接，尽管此函数名和参数名有此含义。 参数顺序 (target, link) 与 Path.symlink_to() 和 Path.hardlink_to() 相反，而与 os.link() 的一致。

3.8 新版功能.

3.10 版后已移除: 此方法已被弃用而建议改用 Path.hardlink_to()，因为 Path.link_to() 的参数顺序与 Path.symlink_to() 的不相匹配。

Path.touch(mode=0o666, exist_ok=True)

将给定的路径创建为文件。如果给出了 mode 它将与当前进程的 umask 值合并以确定文件的模式和访问标志。如果文件已经存在，则当 exist_ok 为 true 则函数仍会成功（并且将它的修改事件更新为当前事件），否则抛出 FileExistsError。

Path.unlink(missing_ok=False)

移除此文件或符号链接。如果路径指向目录，则用 Path.rmdir() 代替。

如果 missing_ok 为假值（默认），则如果路径不存在将会引发 FileNotFoundError。

如果 missing_ok 为真值，则 FileNotFoundError 异常将被忽略（和 POSIX rm -f 命令的行为相同）。

在 3.8 版更改: 增加了 missing_ok 形参。

Path.write_bytes(data)

将文件以二进制模式打开，写入 data 并关闭:

>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'

一个同名的现存文件将被覆盖。

3.5 新版功能.

Path.write_text(data, encoding=None, errors=None, newline=None)

将文件以文本模式打开，写入 data 并关闭:

>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'

同名的现有文件会被覆盖。 可选形参的含义与 open() 的相同。

3.5 新版功能.

在 3.10 版更改: 增加了 newline 形参。

对应的 os 模块的工具

以下是一个映射了 os 与 PurePath/Path 对应相同的函数的表。

注解

以下函数/方法对并不完全等价。 它们有些虽然具有相互重叠的使用场景，但语义并不相同。 这包括了 os.path.abspath() 和 Path.resolve()，以及 os.path.relpath() 和 PurePath.relative_to()。

os 和 os.path | pathlib
os.path.abspath() | Path.resolve() 1
os.chmod() | Path.chmod()
os.mkdir() | Path.mkdir()
os.makedirs() | Path.mkdir()
os.rename() | Path.rename()
os.replace() | Path.replace()
os.rmdir() | Path.rmdir()
os.remove(), os.unlink() | Path.unlink()
os.getcwd() | Path.cwd()
os.path.exists() | Path.exists()
os.path.expanduser() | Path.expanduser() 和 Path.home()
os.listdir() | Path.iterdir()
os.path.isdir() | Path.is_dir()
os.path.isfile() | Path.is_file()
os.path.islink() | Path.is_symlink()
os.link() | Path.hardlink_to()
os.symlink() | Path.symlink_to()
os.readlink() | Path.readlink()
os.path.relpath() | PurePath.relative_to() 2
os.stat() | Path.stat(), Path.owner(), Path.group()
os.path.isabs() | PurePath.is_absolute()
os.path.join() | PurePath.joinpath()
os.path.basename() | PurePath.name
os.path.dirname() | PurePath.parent
os.path.samefile() | Path.samefile()
os.path.splitext() | PurePath.stem 和 PurePath.suffix

备注

1

os.path.abspath() 不会解析符号链接而 Path.resolve() 则会解析。

2

PurePath.relative_to() 要求 self 为参数的子路径，但 os.path.relpath() 则不要求。

os.path --- 常用路径操作

源代码: Lib/posixpath.py [https://github.com/python/cpython/tree/3.10/Lib/posixpath.py] (用于 POSIX) 和 Lib/ntpath.py [https://github.com/python/cpython/tree/3.10/Lib/ntpath.py] (用于 Windows)。

此模块实现了一些有用的路径名称相关函数。 要读取或写入文件请参见 open()，对于访问文件系统请参阅 os 模块。 传给 path 形参的可以是字符串、字节串或者任何实现了 os.PathLike 协议的对象。

与 Unix 不同，Python 不会执行任何 自动 路径扩展。 当应用程序需要类似 shell 的路径扩展时，可以显式地唤起 expanduser() 和 expandvars() 这样的函数。 （另请参阅 glob 模块。）

参见

pathlib 模块提供高级路径对象。

注解

所有这些函数都仅接受字节或字符串对象作为其参数。如果返回路径或文件名，则结果是相同类型的对象。

注解

由于不同的操作系统具有不同的路径名称约定，因此标准库中有此模块的几个版本。os.path 模块始终是适合 Python 运行的操作系统的路径模块，因此可用于本地路径。但是，如果操作的路径 总是 以一种不同的格式显示，那么也可以分别导入和使用各个模块。它们都具有相同的接口：

posixpath 用于Unix 样式的路径

ntpath 用于 Windows 路径

在 3.8 版更改: exists()、lexists()、isdir()、isfile()、islink() 和 ismount() 现在遇到系统层面上不可表示的字符或字节的路径时，会返回 False，而不是抛出异常。

os.path.abspath(path)

返回路径 path 的绝对路径（标准化的）。在大多数平台上，这等同于用 normpath(join(os.getcwd(), path)) 的方式调用 normpath() 函数。

在 3.6 版更改: 接受一个 path-like object。

os.path.basename(path)

返回路径 path 的基本名称。这是将 path 传入函数 split() 之后，返回的一对值中的第二个元素。请注意，此函数的结果与Unix basename 程序不同。basename 在 '/foo/bar/' 上返回 'bar'，而 basename() 函数返回一个空字符串 ('')。

在 3.6 版更改: 接受一个 path-like object。

os.path.commonpath(paths)

接受包含多个路径的序列 paths，返回 paths 的最长公共子路径。如果 paths 同时包含绝对路径和相对路径，或 paths 在不同的驱动器上，或 paths 为空，则抛出 ValueError 异常。与 commonprefix() 不同，本方法返回有效路径。

可用性: Unix, Windows。

3.5 新版功能.

在 3.6 版更改: 接受一个 类路径对象 序列。

os.path.commonprefix(list)

返回作为 list 中所有路径前缀的最长字符串前缀（逐字符比较）。 如果 list 为空，则返回空字符串 ('')。

警告

此函数可能返回无效的路径因为它是按每个字符来处理的。 如果你需要的是 共同路径前缀，则此函数中的实现算法是不安全的 。请使用 commonpath() 来获取共同路径前缀。

>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'

在 3.6 版更改: 接受一个 path-like object。

os.path.dirname(path)

返回路径 path 的目录名称。这是将 path 传入函数 split() 之后，返回的一对值中的第一个元素。

在 3.6 版更改: 接受一个 path-like object。

os.path.exists(path)

如果 path 指向一个已存在的路径或已打开的文件描述符，返回 True。对于失效的符号链接，返回 False。在某些平台上，如果使用 os.stat() 查询到目标文件没有执行权限，即使 path 确实存在，本函数也可能返回 False。

在 3.3 版更改: path 现在可以是一个整数：如果该整数是一个已打开的文件描述符，返回 True，否则返回 False。

在 3.6 版更改: 接受一个 path-like object。

os.path.lexists(path)

如果 path 指向一个已存在的路径，返回 True。对于失效的符号链接，也返回 True。在缺失 os.lstat() 的平台上等同于 exists()。

在 3.6 版更改: 接受一个 path-like object。

os.path.expanduser(path)

在 Unix 和 Windows 上，将参数中开头部分的 ~ 或 ~user 替换为当前 用户 的家目录并返回。

在 Unix 上，开头的 ~ 会被环境变量 HOME 代替，如果变量未设置，则通过内置模块 pwd 在 password 目录中查找当前用户的主目录。以 ~user 开头则直接在 password 目录中查找。

在 Windows 上，如果 USERPROFILE 已设置将会被使用，否则 HOMEPATH 和 HOMEDRIVE 将被组合起来使用。 初始的 ~user 会通过检查当前用户的家目录中匹配 USERNAME 的最后一部分目录名并执行替换来处理。

如果展开路径失败，或者路径不是以波浪号开头，则路径将保持不变。

在 3.6 版更改: 接受一个 path-like object。

在 3.8 版更改: Windows 不再使用 HOME。

os.path.expandvars(path)

输入带有环境变量的路径作为参数，返回展开变量以后的路径。$name 或 ${name} 形式的子字符串被环境变量 name 的值替换。格式错误的变量名称和对不存在变量的引用保持不变。

在 Windows 上，除了 $name 和 ${name} 外，还可以展开 %name%。

在 3.6 版更改: 接受一个 path-like object。

os.path.getatime(path)

返回 path 的最后访问时间。返回值是一个浮点数，为纪元秒数（参见 time 模块）。如果该文件不存在或不可访问，则抛出 OSError 异常。

os.path.getmtime(path)

返回 path 的最后修改时间。返回值是一个浮点数，为纪元秒数（参见 time 模块）。如果该文件不存在或不可访问，则抛出 OSError 异常。

在 3.6 版更改: 接受一个 path-like object。

os.path.getctime(path)

返回 path 在系统中的 ctime，在有些系统（比如 Unix）上，它是元数据的最后修改时间，其他系统（比如 Windows）上，它是 path 的创建时间。返回值是一个数，为纪元秒数（参见 time 模块）。如果该文件不存在或不可访问，则抛出 OSError 异常。

在 3.6 版更改: 接受一个 path-like object。

os.path.getsize(path)

返回 path 的大小，以字节为单位。如果该文件不存在或不可访问，则抛出 OSError 异常。

在 3.6 版更改: 接受一个 path-like object。

os.path.isabs(path)

如果 path 是一个绝对路径，则返回 True。在 Unix 上，它就是以斜杠开头，而在 Windows 上，它可以是去掉驱动器号后以斜杠（或反斜杠）开头。

在 3.6 版更改: 接受一个 path-like object。

os.path.isfile(path)

如果 path 是 现有的 常规文件，则返回 True。本方法会跟踪符号链接，因此，对于同一路径，islink() 和 isfile() 都可能为 True。

在 3.6 版更改: 接受一个 path-like object。

os.path.isdir(path)

如果 path 是 现有的 目录，则返回 True。本方法会跟踪符号链接，因此，对于同一路径，islink() 和 isdir() 都可能为 True。

在 3.6 版更改: 接受一个 path-like object。

os.path.islink(path)

如果 path 指向的 现有 目录条目是一个符号链接，则返回 True。如果 Python 运行时不支持符号链接，则总是返回 False。

在 3.6 版更改: 接受一个 path-like object。

os.path.ismount(path)

如果路径 path 是 挂载点 （文件系统中挂载其他文件系统的点），则返回 True。在 POSIX 上，该函数检查 path 的父目录 path/.. 是否在与 path 不同的设备上，或者 path/.. 和 path 是否指向同一设备上的同一 inode（这一检测挂载点的方法适用于所有 Unix 和 POSIX 变体）。本方法不能可靠地检测同一文件系统上的绑定挂载 (bind mount)。在 Windows 上，盘符和共享 UNC 始终是挂载点，对于任何其他路径，将调用 GetVolumePathName 来查看它是否与输入的路径不同。

3.4 新版功能: 支持在 Windows 上检测非根挂载点。

在 3.6 版更改: 接受一个 path-like object。

os.path.join(path, *paths)

智能地合并一个或多个路径部分。 返回值将是 path 和所有 *paths 成员的拼接，其中每个非空部分后面都紧跟一个目录分隔符，最后一个除外。 也就是说，如果最后一个部分为空或是以一个分隔符结束则结果将仅以一个分隔符结束。 如果某个部分为绝对路径（在 Windows 上需要同时有驱动器号和根路径符号），则之前的所有部分会被忽略并从该绝对路径部分开始拼接。

在 Windows，当遇到绝对路径部分 (如 r'\foo') 时驱动器号将不会被重置。 如果某个部分位于不同驱动器或为绝对路径，则之前的所有部分会被忽略并且该驱动器号会被重置。 请注意由于每个驱动器都有一个当前目录，因此 os.path.join("c:", "foo") 是代表驱动器 C: 上当前路径的相对路径 (c:foo)，而不是 c:\foo。

在 3.6 版更改: 接受一个 类路径对象 用于 path 和 paths 。

os.path.normcase(path)

规范路径的大小写。在 Windows 上，将路径中的所有字符都转换为小写，并将正斜杠转换为反斜杠。在其他操作系统上返回原路径。

在 3.6 版更改: 接受一个 path-like object。

os.path.normpath(path)

通过折叠多余的分隔符和对上级目录的引用来标准化路径名，所以 A//B、A/B/、A/./B 和 A/foo/../B 都会转换成 A/B。这个字符串操作可能会改变带有符号链接的路径的含义。在 Windows 上，本方法将正斜杠转换为反斜杠。要规范大小写，请使用 normcase()。

注解

在 POSIX 系统上，根据 IEEE Std 1003.1 2013 Edition; 4.13 Pathname Resolution [https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13]，如果一个路径名称以两个斜杠开始，则开始字符之后的第一个部分将以具体实现所定义的方式来解读，但是超过两个开始字符则将被视为单个字符。

在 3.6 版更改: 接受一个 path-like object。

os.path.realpath(path, *, strict=False)

返回指定文件的规范路径，消除路径中存在的任何符号链接（如果操作系统支持）。

在默认情况下，对路径的求值将执行至第一个不存在的、导致符号链接循环的，或者求值引发 OSError 的路径组件。 所有这样的组件将不经修改地添加到现有的路径组件。

会以这种方式来处理的错误包括 "access denied", "not a directory" 或 "bad argument to internal function"。 因此，结果路径可能不存在或不可访问，可能仍然包含链接或循环，并可能遍历至非目录。

此行为可通过关键字参数来修改：

如果 strict 为 True，则在对路径求值时遇到的第一个错误将被重新引发。 具体来说，如果 path 不存在则会引发 FileNotFoundError，或者如果因其他原因而不可访问则会引发 OSError。

如果 strict 为 os.path.ALLOW_MISSING，则 FileNotFoundError 以外的错误将被重新引发（就像设置 strict=True 一样）。 因此，返回的路径将不包含任何符号链接，但指定名称的文件及其某些上级目录可能会不存在。

注解

这个函数会模拟操作系统生成规范路径的过程，Windows 与 UNIX 的这个过程在处理链接和后续路径组成部分的交互方式上有所差异。

操作系统 API 会根据需要来规范化路径，因此通常不需要调用此函数。

在 3.6 版更改: 接受一个 path-like object。

在 3.8 版更改: 在 Windows 上现在可以正确解析符号链接和交接点 (junction point)。

在 3.10 版更改: 增加了 strict 形参。

在 3.10.18 版更改: 增加了用于 strict 形参的 ALLOW_MISSING 值。

os.path.ALLOW_MISSING

用于 realpath() 中 strict 参数的特殊值。

3.10.18 新版功能.

os.path.relpath(path, start=os.curdir)

返回从当前目录或可选的 start 目录至 path 的相对文件路径。 这只是一个路径计算：不会访问文件系统来确认 path 或 start 是否存在或其性质。 在 Windows 上，当 path 和 start 位于不同驱动器时将引发 ValueError。

start 默认为 os.curdir。

可用性: Unix, Windows。

在 3.6 版更改: 接受一个 path-like object。

os.path.samefile(path1, path2)

如果两个路径都指向相同的文件或目录，则返回 True。这由设备号和 inode 号确定，在任一路径上调用 os.stat() 失败则抛出异常。

可用性: Unix, Windows。

在 3.2 版更改: 添加了对 Windows 的支持。

在 3.4 版更改: Windows现在使用与其他所有平台相同的实现。

在 3.6 版更改: 接受一个 path-like object。

os.path.sameopenfile(fp1, fp2)

如果文件描述符 fp1 和 fp2 指向相同文件，则返回 True。

可用性: Unix, Windows。

在 3.2 版更改: 添加了对 Windows 的支持。

在 3.6 版更改: 接受一个 path-like object。

os.path.samestat(stat1, stat2)

如果 stat 元组 stat1 和 stat2 指向相同文件，则返回 True。这些 stat 元组可能是由 os.fstat()、os.lstat() 或 os.stat() 返回的。本函数实现了 samefile() 和 sameopenfile() 底层所使用的比较过程。

可用性: Unix, Windows。

在 3.4 版更改: 添加了对 Windows 的支持。

在 3.6 版更改: 接受一个 path-like object。

os.path.split(path)

将路径 path 拆分为一对，即 (head, tail)，其中，tail 是路径的最后一部分，而 head 里是除最后部分外的所有内容。tail 部分不会包含斜杠，如果 path 以斜杠结尾，则 tail 将为空。如果 path 中没有斜杠，head 将为空。如果 path 为空，则 head 和 tail 均为空。head 末尾的斜杠会被去掉，除非它是根目录（即它仅包含一个或多个斜杠）。在所有情况下，join(head, tail) 指向的位置都与 path 相同（但字符串可能不同）。另请参见函数 dirname() 和 basename()。

在 3.6 版更改: 接受一个 path-like object。

os.path.splitdrive(path)

将路径 path 拆分为一对，即 (drive, tail)，其中 drive 是挂载点或空字符串。在没有驱动器概念的系统上，drive 将始终为空字符串。在所有情况下，drive + tail 都与 path 相同。

在 Windows 上，本方法将路径拆分为驱动器/UNC 根节点和相对路径。

如果路径 path 包含盘符，则 drive 将包含冒号之前的所有内容包括冒号本身:

>>> splitdrive("c:/dir")
("c:", "/dir")

如果路径 path 包含 UNC 路径，则 drive 将包含主机名和 share，直至第四个分隔符但不包括该分隔符:

>>> splitdrive("//host/computer/dir")
("//host/computer", "/dir")

在 3.6 版更改: 接受一个 path-like object。

os.path.splitext(path)

将路径名称 path 拆分为 (root, ext) 对使得 root + ext == path，并且扩展名 ext 为空或以句点打头并最多只包含一个句点。

如果路径 path 不包含扩展名，则 ext 将为 '':

>>> splitext('bar')
('bar', '')

如果路径 path 包含扩展名，则 ext 将被设为该扩展名，包括打头的句点。 请注意在其之前的句点将被忽略:

>>> splitext('foo.bar.exe')
('foo.bar', '.exe')
>>> splitext('/foo/bar.exe')
('/foo/bar', '.exe')

path 中最后一部分如果以点号开头则会被视为 root 的一部分:

>>> splitext('.cshrc')
('.cshrc', '')
>>> splitext('/foo/....jpg')
('/foo/....jpg', '')

在 3.6 版更改: 接受一个 path-like object。

os.path.supports_unicode_filenames

如果（在文件系统限制下）允许将任意 Unicode 字符串用作文件名，则为 True。

fileinput --- 迭代来自多个输入流的行

源代码: Lib/fileinput.py [https://github.com/python/cpython/tree/3.10/Lib/fileinput.py]

此模块实现了一个辅助类和一些函数用来快速编写访问标准输入或文件列表的循环。 如果你只想要读写一个文件请参阅 open()。

典型用法为:

import fileinput
for line in fileinput.input(encoding="utf-8"):
    process(line)

此程序会迭代 sys.argv[1:] 中列出的所有文件内的行，如果列表为空则会使用 sys.stdin。 如果有一个文件名为 '-'，它也会被替换为 sys.stdin 并且可选参数 mode 和 openhook 会被忽略。 要指定替代文件列表，请将其作为第一个参数传给 input()。 也允许使用单个文件。

所有文件都默认以文本模式打开，但你可以通过在调用 input() 或 FileInput 时指定 mode 形参来覆盖此行为。 如果在打开或读取文件时发生了 I/O 错误，将会引发 OSError。

在 3.3 版更改: 原来会引发 IOError；现在它是 OSError 的别名。

如果 sys.stdin 被使用超过一次，则第二次之后的使用将不返回任何行，除非是被交互式的使用，或都是被显式地重置 (例如使用 sys.stdin.seek(0))。

空文件打开后将立即被关闭；它们在文件列表中会被注意到的唯一情况只有当最后打开的文件为空的时候。

反回的行不会对换行符做任何处理，这意味着文件中的最后一行可能不带换行符。

你可以通过将 openhook 形参传给 fileinput.input() 或 FileInput() 来提供一个打开钩子以便控制文件的打开方式。 此钩子必须为一个函数，它接受两个参数 filename 和 mode，并返回一个以相应模式打开的文件型对象。 如果指定了 encoding 和/或 errors，它们将作为额外的关键字参数被传给这个钩子。 此模块提供了一个 hook_compressed() 来支持压缩文件。

以下函数是此模块的初始接口：

fileinput.input(files=None, inplace=False, backup='', *, mode='r', openhook=None, encoding=None, errors=None)

创建一个 FileInput 类的实例。 该实例将被用作此模块中函数的全局状态，并且还将在迭代期间被返回使用。 此函数的形参将被继续传递给 FileInput 类的构造器。

FileInput 实例可以在 with 语句中被用作上下文管理器。 在这个例子中，input 在 with 语句结束后将会被关闭，即使发生了异常也是如此:

with fileinput.input(files=('spam.txt', 'eggs.txt'), encoding="utf-8") as f:
    for line in f:
        process(line)

在 3.2 版更改: 可以被用作上下文管理器。

在 3.8 版更改: 关键字形参 mode 和 openhook 现在是仅限关键字形参。

在 3.10 版更改: 增加了仅限关键字形参 encoding 和 errors。

下列函数会使用 fileinput.input() 所创建的全局状态；如果没有活动的状态，则会引发 RuntimeError。

fileinput.filename()

返回当前被读取的文件名。 在第一行被读取之前，返回 None。

fileinput.fileno()

返回以整数表示的当前文件“文件描述符”。 当未打开文件时（处在第一行和文件之间），返回 -1。

fileinput.lineno()

返回已被读取的累计行号。 在第一行被读取之前，返回 0。 在最后一个文件的最后一行被读取之后，返回该行的行号。

fileinput.filelineno()

返回当前文件中的行号。 在第一行被读取之前，返回 0。 在最后一个文件的最后一行被读取之后，返回此文件中该行的行号。

fileinput.isfirstline()

如果刚读取的行是其所在文件的第一行则返回 True，否则返回 False。

fileinput.isstdin()

如果最后读取的行来自 sys.stdin 则返回 True，否则返回 False。

fileinput.nextfile()

关闭当前文件以使下次迭代将从下一个文件（如果存在）读取第一行；不是从该文件读取的行将不会被计入累计行数。 直到下一个文件的第一行被读取之后文件名才会改变。 在第一行被读取之前，此函数将不会生效；它不能被用来跳过第一个文件。 在最后一个文件的最后一行被读取之后，此函数将不再生效。

fileinput.close()

关闭序列。

此模块所提供的实现了序列行为的类同样也可用于子类化：

class fileinput.FileInput(files=None, inplace=False, backup='', *, mode='r', openhook=None, encoding=None, errors=None)

类 FileInput 是一个实现；它的方法 filename(), fileno(), lineno(), filelineno(), isfirstline(), isstdin(), nextfile() 和 close() 对应于此模块中具有相同名称的函数。 此外它还有一个 readline() 方法可返回下一个输入行，以及一个 __getitem__() 方法，该方法实现了序列行为。 这种序列必须以严格的序列顺序来读写；随机读写和 readline() 不可以被混用。

通过 mode 你可以指定要传给 open() 的文件模式。 它必须为 'r', 'rU', 'U' 和 'rb' 中的一个。

openhook 如果给出则必须为一个函数，它接受两个参数 filename 和 mode，并相应地返回一个打开的文件型对象。 你不能同时使用 inplace 和 openhook。

你可以指定 encoding 和 errors 来将其传给 open() 或 openhook。

FileInput 实例可以在 with 语句中被用作上下文管理器。 在这个例子中，input 在 with 语句结束后将会被关闭，即使发生了异常也是如此:

with FileInput(files=('spam.txt', 'eggs.txt')) as input:
    process(input)

在 3.2 版更改: 可以被用作上下文管理器。

3.4 版后已移除: 'rU' 和 'U' 模式。

3.8 版后已移除: 对 __getitem__() 方法的支持已弃用。

在 3.8 版更改: 关键字形参 mode 和 openhook 现在是仅限关键字形参。

在 3.10 版更改: 增加了仅限关键字形参 encoding 和 errors。

可选的原地过滤: 如果传递了关键字参数 inplace=True 给 fileinput.input() 或 FileInput 构造器，则文件会被移至备份文件并将标准输出定向到输入文件（如果已存在与备份文件同名的文件，它将被静默地替换）。 这使得编写一个能够原地重写其输入文件的过滤器成为可能。 如果给出了 backup 形参 (通常形式为 backup='.<some extension>')，它将指定备份文件的扩展名，并且备份文件会被保留；默认情况下扩展名为 '.bak' 并且它会在输出文件关闭时被删除。 在读取标准输入时原地过滤会被禁用。

此模块提供了以下两种打开文件钩子：

fileinput.hook_compressed(filename, mode, *, encoding=None, errors=None)

使用 gzip 和 bz2 模块透明地打开 gzip 和 bzip2 压缩的文件（通过扩展名 '.gz' 和 '.bz2' 来识别）。 如果文件扩展名不是 '.gz' 或 '.bz2'，文件会以正常方式打开（即使用 open() 并且不带任何解压操作）。

encoding 和 errors 值会被传给 io.TextIOWrapper 用于压缩文件以及打开普通文件。

用法示例: fi = fileinput.FileInput(openhook=fileinput.hook_compressed, encoding="utf-8")

在 3.10 版更改: 增加了仅限关键字形参 encoding 和 errors。

fileinput.hook_encoded(encoding, errors=None)

返回一个通过 open() 打开每个文件的钩子，使用给定的 encoding 和 errors 来读取文件。

使用示例: fi = fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", "surrogateescape"))

在 3.6 版更改: 添加了可选的 errors 形参。

3.10 版后已移除: 此函数已被弃用，因为 fileinput.input() 和 FileInput 现在有了 encoding 和 errors 形参。

stat --- 解析 stat() 结果

源代码： Lib/stat.py [https://github.com/python/cpython/tree/3.10/Lib/stat.py]

stat 模块定义了一些用于解析 os.stat(), os.fstat() 和 os.lstat() (如果它们存在) 输出结果的常量和函数。 有关 stat(), fstat() 和 lstat() 调用的完整细节，请参阅你的系统文档。

在 3.4 版更改: stat 模块是通过 C 实现来支持的。

stat 模块定义了以下函数来检测特定文件类型：

stat.S_ISDIR(mode)

如果 mode 来自一个目录则返回非零值。

stat.S_ISCHR(mode)

如果 mode 来自一个字符特殊设备文件则返回非零值。

stat.S_ISBLK(mode)

如果 mode 来自一个块特殊设备文件则返回非零值。

stat.S_ISREG(mode)

如果 mode 来自一个常规文件则返回非零值。

stat.S_ISFIFO(mode)

如果 mode 来自一个 FIFO (命名管道) 则返回非零值。

stat.S_ISLNK(mode)

如果 mode 来自一个符号链接则返回非零值。

stat.S_ISSOCK(mode)

如果 mode 来自一个套接字则返回非零值。

stat.S_ISDOOR(mode)

如果 mode 来自一个门则返回非零值。

3.4 新版功能.

stat.S_ISPORT(mode)

如果 mode 来自一个事件端口则返回非零值。

3.4 新版功能.

stat.S_ISWHT(mode)

如果 mode 来自一个白输出则返回非零值。

3.4 新版功能.

定义了两个附加函数用于对文件模式进行更一般化的操作：

stat.S_IMODE(mode)

返回文件模式中可由 os.chmod() 进行设置的部分 --- 即文件的 permission 位，加上 sticky 位、set-group-id 以及 set-user-id 位（在支持这些部分的系统上）。

stat.S_IFMT(mode)

返回文件模式中描述文件类型的部分（供上面的 S_IS*() 函数使用）。

通常，你应当使用 os.path.is*() 函数来检测文件的类型；这里提供的函数则适用于当你要对同一文件执行多项检测并且希望避免每项检测的 stat() 系统调用开销的情况。 这些函数也适用于检测有关未被 os.path 处理的信息，例如检测块和字符设备等。

示例:

import os, sys
from stat import *

def walktree(top, callback):
    '''recursively descend the directory tree rooted at top,
       calling the callback function for each regular file'''

    for f in os.listdir(top):
        pathname = os.path.join(top, f)
        mode = os.lstat(pathname).st_mode
        if S_ISDIR(mode):
            # It's a directory, recurse into it
            walktree(pathname, callback)
        elif S_ISREG(mode):
            # It's a file, call the callback function
            callback(pathname)
        else:
            # Unknown file type, print a message
            print('Skipping %s' % pathname)

def visitfile(file):
    print('visiting', file)

if __name__ == '__main__':
    walktree(sys.argv[1], visitfile)

另外还提供了一个附加的辅助函数用来将文件模式转换为人类易读的字符串：

stat.filemode(mode)

将文件模式转换为 '-rwxrwxrwx' 形式的字符串。

3.3 新版功能.

在 3.4 版更改: 此函数支持 S_IFDOOR, S_IFPORT and S_IFWHT。

以下所有变量是一些简单的符号索引，用于访问 os.stat(), os.fstat() 或 os.lstat() 所返回的 10 条目元组。

stat.ST_MODE

inode 保护模式。

stat.ST_INO

Inode 号

stat.ST_DEV

Inode 所在的设备。

stat.ST_NLINK

Inode 拥有的链接数量。

stat.ST_UID

所有者的用户 ID。

stat.ST_GID

所有者的用户组ID。

stat.ST_SIZE

以字节为单位的普通文件大小；对于某些特殊文件则是所等待的数据量。

stat.ST_ATIME

上次访问的时间。

stat.ST_MTIME

上次修改的时间。

stat.ST_CTIME

操作系统所报告的 "ctime"。 在某些系统上（例如 Unix）是元数据的最后修改时间，而在其他系统上（例如 Windows）则是创建时间（请参阅系统平台的文档了解相关细节）。

对于“文件大小”的解析可因文件类型的不同而变化。 对于普通文件就是文件的字节数。 对于大部分种类的 Unix（特别包括 Linux）的 FIFO 和套接字来说，“大小”则是指在调用 os.stat(), os.fstat() 或 os.lstat() 时等待读取的字节数；这在某些时候很有用处，特别是在一个非阻塞的打开后轮询这些特殊文件中的一个时。 其他字符和块设备的文件大小字段的含义还会有更多变化，具体取决于底层系统调用的实现方式。

以下变量定义了在 ST_MODE 字段中使用的旗标。

使用上面的函数会比使用第一组旗标更容易移植：

stat.S_IFSOCK

套接字。

stat.S_IFLNK

符号链接。

stat.S_IFREG

普通文件。

stat.S_IFBLK

块设备。

stat.S_IFDIR

目录。

stat.S_IFCHR

字符设备。

stat.S_IFIFO

先进先出。

stat.S_IFDOOR

门。

3.4 新版功能.

stat.S_IFPORT

事件端口。

3.4 新版功能.

stat.S_IFWHT

白输出。

3.4 新版功能.

注解

S_IFDOOR, S_IFPORT or S_IFWHT 等文件类型在不受系统平台支持时会被定义为 0。

以下旗标还可以 os.chmod() 的在 mode 参数中使用：

stat.S_ISUID

设置 UID 位。

stat.S_ISGID

设置分组 ID 位。 这个位有几种特殊用途。 对于目录它表示该目录将使用 BSD 语义：在其中创建的文件将从目录继承其分组 ID，而不是从创建进程的有效分组 ID 继承，并且在其中创建的目录也将设置 S_ISGID 位。 对于没有设置分组执行位 (S_IXGRP) 的文件，设置分组 ID 位表示强制性文件/记录锁定 (另请参见 S_ENFMT)。

stat.S_ISVTX

固定位。 当对目录设置该位时则意味着此目录中的文件只能由文件所有者、目录所有者或特权进程来重命名或删除。

stat.S_IRWXU

文件所有者权限的掩码。

stat.S_IRUSR

所有者具有读取权限。

stat.S_IWUSR

所有者具有写入权限。

stat.S_IXUSR

所有者具有执行权限。

stat.S_IRWXG

组权限的掩码。

stat.S_IRGRP

组具有读取权限。

stat.S_IWGRP

组具有写入权限。

stat.S_IXGRP

组具有执行权限。

stat.S_IRWXO

其他人（不在组中）的权限掩码。

stat.S_IROTH

其他人具有读取权限。

stat.S_IWOTH

其他人具有写入权限。

stat.S_IXOTH

其他人具有执行权限。

stat.S_ENFMT

System V 执行文件锁定。 此旗标是与 S_ISGID 共享的：文件/记录锁定会针对未设置分组执行位 (S_IXGRP) 的文件强制执行。

stat.S_IREAD

Unix V7 中 S_IRUSR 的同义词。

stat.S_IWRITE

Unix V7 中 S_IWUSR 的同义词。

stat.S_IEXEC

Unix V7 中 S_IXUSR 的同义词。

以下旗标可以在 os.chflags() 的 flags 参数中使用：

stat.UF_NODUMP

不要转储文件。

stat.UF_IMMUTABLE

文件不能被更改。

stat.UF_APPEND

文件只能被附加。

stat.UF_OPAQUE

当通过联合堆栈查看时，目录是不透明的。

stat.UF_NOUNLINK

文件不能重命名或删除。

stat.UF_COMPRESSED

文件是压缩存储的（macOS 10.6+）。

stat.UF_HIDDEN

文件不可被显示在 GUI 中（macOS 10.5+）。

stat.SF_ARCHIVED

文件可能已存档。

stat.SF_IMMUTABLE

文件不能被更改。

stat.SF_APPEND

文件只能被附加。

stat.SF_NOUNLINK

文件不能重命名或删除。

stat.SF_SNAPSHOT

文件有一个快照文件

请参阅 *BSD 或 macOS 系统的指南页 chflags(2) 来了解详情。

在 Windows 上，以下文件属性常量可被用来检测 os.stat() 所返回的 st_file_attributes 成员中的位。 请参阅 Windows API 文档 [https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx] 了解有关这些常量含义的详情。

stat.FILE_ATTRIBUTE_ARCHIVE

stat.FILE_ATTRIBUTE_COMPRESSED

stat.FILE_ATTRIBUTE_DEVICE

stat.FILE_ATTRIBUTE_DIRECTORY

stat.FILE_ATTRIBUTE_ENCRYPTED

stat.FILE_ATTRIBUTE_HIDDEN

stat.FILE_ATTRIBUTE_INTEGRITY_STREAM

stat.FILE_ATTRIBUTE_NORMAL

stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED

stat.FILE_ATTRIBUTE_NO_SCRUB_DATA

stat.FILE_ATTRIBUTE_OFFLINE

stat.FILE_ATTRIBUTE_READONLY

stat.FILE_ATTRIBUTE_REPARSE_POINT

stat.FILE_ATTRIBUTE_SPARSE_FILE

stat.FILE_ATTRIBUTE_SYSTEM

stat.FILE_ATTRIBUTE_TEMPORARY

stat.FILE_ATTRIBUTE_VIRTUAL

3.5 新版功能.

在 Windows 上，以下常量可被用来与 os.lstat() 所返回的 st_reparse_tag 成员进行比较。 这些是最主要的常量，而不是详尽的清单。

stat.IO_REPARSE_TAG_SYMLINK

stat.IO_REPARSE_TAG_MOUNT_POINT

stat.IO_REPARSE_TAG_APPEXECLINK

3.8 新版功能.

filecmp --- 文件及目录的比较

源代码: Lib/filecmp.py [https://github.com/python/cpython/tree/3.10/Lib/filecmp.py]

filecmp 模块定义了用于比较文件及目录的函数，并且可以选取多种关于时间和准确性的折衷方案。对于文件的比较，另见 difflib 模块。

filecmp 模块定义了如下函数：

filecmp.cmp(f1, f2, shallow=True)

比较名为 f1 和 f2 的文件，如果它们似乎相等则返回 True ，否则返回 False 。

如果 shallow 为真值且两个文件的 os.stat() 签名信息（文件类型、大小和修改时间）一致，则文件会被视为相同。

在其他情况下，如果文件大小或内容不同则它们会被视为不同。

需要注意，没有外部程序被该函数调用，这赋予了该函数可移植性与效率。

该函数会缓存过去的比较及其结果，且在文件的 os.stat() 信息变化后缓存条目失效。所有的缓存可以通过使用 clear_cache() 来清除。

filecmp.cmpfiles(dir1, dir2, common, shallow=True)

比较在两个目录 dir1 和 dir2 中，由 common 所确定名称的文件。

返回三组文件名列表： match, mismatch, errors 。 match 含有相匹配的文件， mismatch 含有那些不匹配的，然后 errors 列出那些未被比较文件的名称。如果文件不存在于两目录中的任一个，或者用户缺少读取它们的权限，又或者因为其他的一些原因而无法比较，那么这些文件将会被列在 errors 中。

参数 shallow 具有同 filecmp.cmp() 一致的含义与默认值。

例如， cmpfiles('a', 'b', ['c', 'd/e']) 将会比较 a/c 与 b/c 以及 a/d/e 与 b/d/e 。 'c' 和 'd/e' 将会各自出现在返回的三个列表里的某一个列表中。

filecmp.clear_cache()

清除 filecmp 缓存。如果一个文件过快地修改，以至于超过底层文件系统记录修改时间的精度，那么该函数可能有助于比较该类文件。

3.4 新版功能.

dircmp 类

class filecmp.dircmp(a, b, ignore=None, hide=None)

创建一个用于比较目录 a 和 b 的新的目录比较对象。 ignore 是需要忽略的文件名列表，且默认为 filecmp.DEFAULT_IGNORES 。 hide 是需要隐藏的文件名列表，且默认为 [os.curdir, os.pardir] 。

dircmp 类如 filecmp.cmp() 中所描述的那样对文件进行 shallow 比较。

dircmp 类提供以下方法：

report()

将 a 与 b 之间的比较结果打印（到 sys.stdout ）。

report_partial_closure()

打印 a 与 b 及共同直接子目录的比较结果。

report_full_closure()

打印 a 与 b 及共同子目录比较结果（递归地）。

dircmp 类提供了一些有趣的属性，用以得到关于参与比较的目录树的各种信息。

需要注意，通过 __getattr__() 钩子，所有的属性将会惰性求值，因此如果只使用那些计算简便的属性，将不会有速度损失。

left

目录 a 。

right

目录 b 。

left_list

经 hide 和 ignore 过滤，目录 a 中的文件与子目录。

right_list

经 hide 和 ignore 过滤，目录 b 中的文件与子目录。

common

同时存在于目录 a 和 b 中的文件和子目录。

left_only

仅在目录 a 中的文件和子目录。

right_only

仅在目录 b 中的文件和子目录。

common_dirs

同时存在于目录 a 和 b 中的子目录。

common_files

同时存在于目录 a 和 b 中的文件。

common_funny

在目录 a 和 b 中类型不同的名字，或者那些 os.stat() 报告错误的名字。

same_files

在目录 a 和 b 中，使用类的文件比较操作符判定相等的文件。

diff_files

在目录 a 和 b 中，根据类的文件比较操作符判定内容不等的文件。

funny_files

在目录 a 和 b 中无法比较的文件。

subdirs

一个将 common_dirs 中的名称映射到 dircmp 实例（或者 MyDirCmp 实例，如果该实例类型为 dircmp 的子类 MyDirCmp 的话）的字典。

在 3.10 版更改: 在之前版本中字典条目总是为 dircmp 实例。 现在条目将与 self 的类型相同，如果 self 为 dircmp 的子类的话。

filecmp.DEFAULT_IGNORES

3.4 新版功能.

默认被 dircmp 忽略的目录列表。

下面是一个简单的例子，使用 subdirs 属性递归搜索两个目录以显示公共差异文件：

>>> 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)

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

源代码： Lib/tempfile.py [https://github.com/python/cpython/tree/3.10/Lib/tempfile.py]

该模块用于创建临时文件和目录，它可以跨平台使用。TemporaryFile、NamedTemporaryFile、TemporaryDirectory 和 SpooledTemporaryFile 是带有自动清理功能的高级接口，可用作上下文管理器。mkstemp() 和 mkdtemp() 是低级函数，使用完毕需手动清理。

所有由用户调用的函数和构造函数都带有参数，这些参数可以设置临时文件和临时目录的路径和名称。该模块生成的文件名包括一串随机字符，在公共的临时目录中，这些字符可以让创建文件更加安全。为了保持向后兼容性，参数的顺序有些奇怪。所以为了代码清晰，建议使用关键字参数。

这个模块定义了以下内容供用户调用：

tempfile.TemporaryFile(mode='w+b', buffering=- 1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

返回一个 file-like object 作为临时存储区域。创建该文件使用了与 mkstemp() 相同的安全规则。它将在关闭后立即销毁（包括垃圾回收机制关闭该对象时）。在 Unix 下，该文件在目录中的条目根本不创建，或者创建文件后立即就被删除了，其他平台不支持此功能。您的代码不应依赖使用此功能创建的临时文件名称，因为它在文件系统中的名称可能是可见的，也可能是不可见的。

生成的对象可以用作上下文管理器（参见 例子）。完成上下文或销毁临时文件对象后，临时文件将从文件系统中删除。

mode 参数默认值为 'w+b'，所以创建的文件不用关闭，就可以读取或写入。因为用的是二进制模式，所以无论存的是什么数据，它在所有平台上都表现一致。buffering、encoding、errors 和 newline 的含义与 open() 中的相同。

参数 dir、prefix 和 suffix 的含义和默认值都与它们在 mkstemp() 中的相同。

在 POSIX 平台上，它返回的对象是真实的文件对象。在其他平台上，它是一个文件型对象，它的 file 属性是底层的真实文件对象。

如果可用，则使用 os.O_TMPFILE 标志（仅限于 Linux，需要 3.11 及更高版本的内核）。

在 Posix 或 Cygwin 以外的平台上，TemporaryFile 是 NamedTemporaryFile 的别名。

引发一个 审计事件 tempfile.mkstemp 并附带参数 fullpath。

在 3.5 版更改: 如果可用，现在用的是 os.O_TMPFILE 标志。

在 3.8 版更改: 添加了 errors 参数。

tempfile.NamedTemporaryFile(mode='w+b', buffering=- 1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, delete=True, *, errors=None)

此函数执行的操作与 TemporaryFile() 完全相同，但是会确保该文件在文件系统中具有可见的名称（在 Unix 上表现为目录项不取消链接）。 该名称可从返回的文件类对象的 name 属性获取。 在指定的临时文件仍然被打开时该名称是否可被用来再次打开文件对于不同平台则有所不同（在 Unix 上可以这样做；在 Windows 上不可以） 如果 delete 为（默认的）真值，则文件会在关闭之后立即被删除。 此函数返回的对象始终会是文件类对象，它的 file 属性是底层的真实文件对象。 这个文件类对象可以在 with 语句中使用，就像普通的文件一样。

引发一个 审计事件 tempfile.mkstemp 并附带参数 fullpath。

在 3.8 版更改: 添加了 errors 参数。

class tempfile.SpooledTemporaryFile(max_size=0, mode='w+b', buffering=- 1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

这个类执行的操作与 TemporaryFile() 完全相同，但会将数据缓存在内存中直到文件大小超过 max_size，或者直到文件的 fileno() 方法被调用，这时文件内容会被写入磁盘并如使用 TemporaryFile() 时一样继续操作。

此函数生成的文件对象有一个额外的方法——rollover()，可以忽略文件大小，让文件立即写入磁盘。

返回的对象是文件类对象 (file-like object)，它的 _file 属性是 io.BytesIO 或 io.TextIOWrapper 对象（取决于指定的是二进制模式还是文本模式）或真实的文件对象（取决于是否已调用 rollover()）。文件类对象可以像普通文件一样在 with 语句中使用。

在 3.3 版更改: 现在，文件的 truncate 方法可接受一个 size 参数。

在 3.8 版更改: 添加了 errors 参数。

class tempfile.TemporaryDirectory(suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False)

这个类会使用与 mkdtemp() 相同的规则安全地创建一个临时目录。 结果对象可以被用作上下文管理器 (参见 例子)。 在完成上下文或销毁临时目录对象时，新创建的临时目录及其所有内容会从文件系统中被移除。

可以从返回对象的 name 属性中找到临时目录的名称。当返回的对象用作上下文管理器时，这个 name 会作为 with 语句中 as 子句的目标（如果有 as 的话）。

此目录可通过调用 cleanup() 方法来显式地清理。 如果 ignore_cleanup_errors 为真值，则在显式或隐式清理（例如在 Windows 上 PermissionError 移除打开的文件）期间出现的未处理异常将被忽略，并且剩余的可移除条目会被“尽可能”地删除。 在其他情况下，错误将在任何上下文清理发生时被引发 (cleanup() 调用、退出上下文管理器、对象被作为垃圾回收或解释器关闭等)。

引发一个 审计事件 tempfile.mkdtemp 并附带参数 fullpath。

3.2 新版功能.

在 3.10 版更改: 添加了 ignore_cleanup_errors 形参。

tempfile.mkstemp(suffix=None, prefix=None, dir=None, text=False)

以最安全的方式创建一个临时文件。假设所在平台正确实现了 os.open() 的 os.O_EXCL 标志，则创建文件时不会有竞争的情况。该文件只能由创建者读写，如果所在平台用权限位来标记文件是否可执行，那么没有人有执行权。文件描述符不会过继给子进程。

与 TemporaryFile() 不同，mkstemp() 用户用完临时文件后需要自行将其删除。

如果 suffix 不是 None 则文件名将以该后缀结尾，是 None 则没有后缀。mkstemp() 不会在文件名和后缀之间加点，如果需要加一个点号，请将其放在 suffix 的开头。

如果 prefix 不是 None，则文件名将以该前缀开头，是 None 则使用默认前缀。默认前缀是 gettempprefix() 或 gettempprefixb() 函数的返回值（自动调用合适的函数）。

如果 dir 不为 None，则在指定的目录创建文件，是 None 则使用默认目录。默认目录是从一个列表中选择出来的，这个列表不同平台不一样，但是用户可以设置 TMPDIR、TEMP 或 TMP 环境变量来设置目录的位置。因此，不能保证生成的临时文件路径很规范，比如，通过 os.popen() 将路径传递给外部命令时仍需要加引号。

如果 suffix、prefix 和 dir 中的任何一个不是 None，就要保证它们是同一数据类型。如果它们是 bytes，则返回的名称的类型就是 bytes 而不是 str。如果确实要用默认参数，但又想要返回值是 bytes 类型，请传入 suffix=b''。

如果指定了 text 且为真值，文件会以文本模式打开。 否则，文件（默认）会以二进制模式打开。

mkstemp() 返回一个元组，元组中第一个元素是句柄，它是一个系统级句柄，指向一个打开的文件（等同于 os.open() 的返回值），第二元素是该文件的绝对路径。

引发一个 审计事件 tempfile.mkstemp 并附带参数 fullpath。

在 3.5 版更改: 现在，suffix、prefix 和 dir 可以以 bytes 类型按顺序提供，以获得 bytes 类型的返回值。之前只允许使用 str。suffix 和 prefix 现在可以接受 None，并且默认为 None 以使用合适的默认值。

在 3.6 版更改: dir 参数现在可接受一个路径类对象 (path-like object)。

tempfile.mkdtemp(suffix=None, prefix=None, dir=None)

以最安全的方式创建一个临时目录，创建该目录时不会有竞争的情况。该目录只能由创建者读取、写入和搜索。

mkdtemp() 用户用完临时目录后需要自行将其删除。

prefix、suffix 和 dir 的含义与它们在 mkstemp() 中的相同。

mkdtemp() 返回新目录的绝对路径。

引发一个 审计事件 tempfile.mkdtemp 并附带参数 fullpath。

在 3.5 版更改: 现在，suffix、prefix 和 dir 可以以 bytes 类型按顺序提供，以获得 bytes 类型的返回值。之前只允许使用 str。suffix 和 prefix 现在可以接受 None，并且默认为 None 以使用合适的默认值。

在 3.6 版更改: dir 参数现在可接受一个路径类对象 (path-like object)。

tempfile.gettempdir()

返回放置临时文件的目录的名称。这个方法的返回值就是本模块所有函数的 dir 参数的默认值。

Python 搜索标准目录列表，以找到调用者可以在其中创建文件的目录。这个列表是：

TMPDIR 环境变量指向的目录。

TEMP 环境变量指向的目录。

TMP 环境变量指向的目录。

与平台相关的位置：

在 Windows 上，依次为 C:\TEMP、C:\TMP、\TEMP 和 \TMP。

在所有其他平台上，依次为 /tmp、/var/tmp 和 /usr/tmp。

不得已时，使用当前工作目录。

搜索的结果会缓存起来，参见下面 tempdir 的描述。

在 3.10 版更改: 总是返回一个字符串。 在之前的版本中它会返回任意 tempdir 值而不考虑它的类型，只要它不为 None。

tempfile.gettempdirb()

与 gettempdir() 相同，但返回值为字节类型。

3.5 新版功能.

tempfile.gettempprefix()

返回用于创建临时文件的文件名前缀，它不包含目录部分。

tempfile.gettempprefixb()

与 gettempprefix() 相同，但返回值为字节类型。

3.5 新版功能.

本模块使用一个全局变量来存储由 gettempdir() 返回的临时文件使用的目录路径。 它可被直接设置以覆盖选择过程，但不建议这样做。 本模块中的所有函数都接受一个 dir 参数，它可被用于指定目录。 这是不会通过改变全局 API 行为对其他无准备代码造成影响的推荐做法。

tempfile.tempdir

当设为 None 以外的值时，此变量会为本模块中定义的函数的 dir 参数定义默认值，包括确定其类型为字节串还是字符串。 它不可以为 path-like object。

如果在调用除 gettempprefix() 外的上述任何函数时 tempdir 为 None (默认值) 则它会按照 gettempdir() 中所描述的算法来初始化。

注解

请注意如果你将 tempdir 设为字节串值，会有一个麻烦的副作用: mkstemp() 和 mkdtemp() 的全局默认返回类型会在没有显式提供字符串类型的when no explicit prefix, suffix 或 dir 的时候被改为字节串。 请不要编写预期或依赖于此入围的代码。 这个笨拙行为是为了保持与历史实现的兼容性。

例子

以下是 tempfile 模块典型用法的一些示例:

>>> import tempfile

# create a temporary file and write some data to it
>>> fp = tempfile.TemporaryFile()
>>> fp.write(b'Hello world!')
# read data from file
>>> fp.seek(0)
>>> fp.read()
b'Hello world!'
# close the file, it will be removed
>>> fp.close()

# create a temporary file using a context manager
>>> with tempfile.TemporaryFile() as fp:
...     fp.write(b'Hello world!')
...     fp.seek(0)
...     fp.read()
b'Hello world!'
>>>
# file is now closed and removed

# create a temporary directory using the context manager
>>> with tempfile.TemporaryDirectory() as tmpdirname:
...     print('created temporary directory', tmpdirname)
>>>
# directory and contents have been removed

已弃用的函数和变量

创建临时文件有一种历史方法，首先使用 mktemp() 函数生成一个文件名，然后使用该文件名创建文件。不幸的是，这是不安全的，因为在调用 mktemp() 与随后尝试创建文件的进程之间的时间里，其他进程可能会使用该名称创建文件。解决方案是将两个步骤结合起来，立即创建文件。这个方案目前被 mkstemp() 和上述其他函数所采用。

tempfile.mktemp(suffix='', prefix='tmp', dir=None)

2.3 版后已移除: 使用 mkstemp() 来代替。

返回一个绝对路径，这个路径指向的文件在调用本方法时不存在。prefix、suffix 和 dir 参数与 mkstemp() 中的同名参数类似，不同之处在于不支持字节类型的文件名，不支持 suffix=None 和 prefix=None。

警告

使用此功能可能会在程序中引入安全漏洞。当你开始使用本方法返回的文件执行任何操作时，可能有人已经捷足先登了。mktemp() 的功能可以很轻松地用 NamedTemporaryFile() 代替，当然需要传递 delete=False 参数:

>>> 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

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

源代码: Lib/glob.py [https://github.com/python/cpython/tree/3.10/Lib/glob.py]

glob 模块会按照 Unix shell 所使用的规则找出所有匹配特定模式的路径名称，但返回结果的顺序是不确定的。 波浪号扩展不会生效，但 *, ? 以及用 [] 表示的字符范围将被正确地匹配。 这是通过配合使用 os.scandir() 和 fnmatch.fnmatch() 函数来实现的，而不是通过实际唤起子 shell。

请注意以点号 (.) 打头的文件只能用同样以点号打头的模式来匹配，这不同于 fnmatch.fnmatch() 或 pathlib.Path.glob()。 （对于波浪号和 shell 变量扩展，请使用 os.path.expanduser() 和 os.path.expandvars()。）

对于字面值匹配，请将原字符用方括号括起来。 例如，'[?]' 将匹配字符 '?'。

参见

pathlib 模块提供高级路径对象。

glob.glob(pathname, *, root_dir=None, dir_fd=None, recursive=False)

Return a possibly empty list of path names that match pathname, which must be a string containing a path specification. pathname can be either absolute (like /usr/src/Python-1.5/Makefile) or relative (like ../../Tools/*/*.gif), and can contain shell-style wildcards. Broken symlinks are included in the results (as in the shell). Whether or not the results are sorted depends on the file system. If a file that satisfies conditions is removed or added during the call of this function, whether a path name for that file be included is unspecified.

如果 root_dir 不为 None，则它应当是指明要搜索的根目录的 path-like object。 它用在 glob() 上与在调用它之前改变当前目录有相同的效果。 如果 pathname 为相对路径，结果将包含相对于 root_dir 的路径。

本函数带有 dir_fd 参数，支持 基于目录描述符的相对路径。

如果 recursive 为真值，则模式 "**" 将匹配目录中的任何文件以及零个或多个目录、子目录和符号链接。 如果模式加了一个 os.sep 或 os.altsep 则将不匹配文件。

引发一个 审计事件 glob.glob 并附带参数 pathname, recursive。

引发一个 审计事件 glob.glob/2 并附带参数 pathname, recursive, root_dir, dir_fd。

注解

在一个较大的目录树中使用 "**" 模式可能会消耗非常多的时间。

在 3.5 版更改: 支持使用 "**" 的递归 glob。

在 3.10 版更改: 添加了 root_dir 和 dir_fd 形参。

glob.iglob(pathname, *, root_dir=None, dir_fd=None, recursive=False)

返回一个 iterator，它会产生与 glob() 相同的结果，但不会实际地同时保存它们。

引发一个 审计事件 glob.glob 并附带参数 pathname, recursive。

引发一个 审计事件 glob.glob/2 并附带参数 pathname, recursive, root_dir, dir_fd。

在 3.5 版更改: 支持使用 "**" 的递归 glob。

在 3.10 版更改: 添加了 root_dir 和 dir_fd 形参。

glob.escape(pathname)

转义所有特殊字符 ('?', '*' 和 '[')。 这适用于当你想要匹配可能带有特殊字符的任意字符串字面值的情况。 在 drive/UNC 共享点中的特殊字符不会被转义，例如在 Windows 上 escape('//?/c:/Quo vadis?.txt') 将返回 '//?/c:/Quo vadis[?].txt'。

3.4 新版功能.

例如，考虑一个包含以下内容的目录：文件 1.gif, 2.txt, card.gif 以及一个子目录 sub 其中只包含一个文件 3.txt. glob() 将产生如下结果。 请注意路径的任何开头部分都将被保留。:

>>> 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/']

如果目录包含以 . 打头的文件，它们默认将不会被匹配。 例如，考虑一个包含 card.gif 和 .card.gif 的目录:

>>> import glob
>>> glob.glob('*.gif')
['card.gif']
>>> glob.glob('.c*')
['.card.gif']

参见

模块 fnmatch

Shell 风格文件名（而非路径）扩展

fnmatch --- Unix 文件名模式匹配

源代码: Lib/fnmatch.py [https://github.com/python/cpython/tree/3.10/Lib/fnmatch.py]

此模块提供了 Unix shell 风格的通配符，它们 并不 等同于正则表达式（关于后者的文档参见 re 模块）。 shell 风格通配符所使用的特殊字符如下：

模式 | 含意
* | 匹配所有
? | 匹配任何单个字符
[seq] | 匹配 seq 中的任何字符
[!seq] | 匹配任何不在 seq 中的字符

对于字面值匹配，请将原字符用方括号括起来。 例如，'[?]' 将匹配字符 '?'。

注意文件名分隔符 (Unix 上为 '/') 不会 被此模块特别对待。 请参见 glob 模块了解文件名扩展 (glob 使用 filter() 来匹配文件名的各个部分)。 类似地，以一个句点打头的文件名也不会被此模块特别对待，可以通过 * 和 ? 模式来匹配。

fnmatch.fnmatch(filename, pattern)

检测 filename 字符串是否匹配 pattern 字符串，返回 True 或 False。 两个形参都会使用 os.path.normcase() 进行大小写正规化。 fnmatchcase() 可被用于执行大小写敏感的比较，无论这是否为所在操作系统的标准。

这个例子将打印当前目录下带有扩展名 .txt 的所有文件名:

import fnmatch
import os

for file in os.listdir('.'):
    if fnmatch.fnmatch(file, '*.txt'):
        print(file)

fnmatch.fnmatchcase(filename, pattern)

检测 filename 是否匹配 pattern，返回 True 或 False；此比较是大小写敏感的，并且不会应用 os.path.normcase()。

fnmatch.filter(names, pattern)

基于可迭代对象 names 中匹配 pattern 的元素构造一个列表。 它等价于 [n for n in names if fnmatch(n, pattern)]，但实现得更有效率。

fnmatch.translate(pattern)

返回 shell 风格 pattern 转换成的正则表达式以便用于 re.match()。

示例:

>>> 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'>

参见

模块 glob

Unix shell 风格路径扩展。

linecache --- 随机读写文本行

源代码: Lib/linecache.py [https://github.com/python/cpython/tree/3.10/Lib/linecache.py]

linecache 模块允许从一个 Python 源文件中获取任意的行，并会尝试使用缓存进行内部优化，常应用于从单个文件读取多行的场合。 此模块被 traceback 模块用来提取源码行以便包含在格式化的回溯中。

tokenize.open() 函数被用于打开文件。 此函数使用 tokenize.detect_encoding() 来获取文件的编码格式；如果未指明编码格式，则默认编码为 UTF-8。

linecache 模块定义了下列函数：

linecache.getline(filename, lineno, module_globals=None)

从名为 filename 的文件中获取 lineno 行，此函数绝不会引发异常 --- 出现错误时它将返回 '' (所有找到的行都将包含换行符作为结束)。

如果找不到名为 filename 的文件，此函数会先在 module_globals 中检查 PEP 302 [https://www.python.org/dev/peps/pep-0302] __loader__。 如果存在这样的加载器并且它定义了 get_source 方法，则由该方法来确定源行 (如果 get_source() 返回 None，则该函数返回 '')。 最后，如果 filename 是一个相对路径文件名，则它会在模块搜索路径 sys.path 中按条目的相对位置进行查找。

linecache.clearcache()

清空缓存。 如果你不再需要之前使用 getline() 从文件读取的行即可使用此函数。

linecache.checkcache(filename=None)

检查缓存有效性。 如果缓存中的文件在磁盘上发生了改变，而你需要更新后的版本即可使用此函数。 如果省略了 filename，它会检查缓存中的所有条目。

linecache.lazycache(filename, module_globals)

捕获有关某个非基于文件的模块的足够细节信息，以允许稍后再通过 getline() 来获取其中的行，即使当稍后调用时 module_globals 为 None。 这可以避免在实际需要读取行之前执行 I/O，也不必始终保持模块全局变量。

3.5 新版功能.

示例:

>>> import linecache
>>> linecache.getline(linecache.__file__, 8)
'import sys\n'

shutil --- 高阶文件操作

源代码： Lib/shutil.py [https://github.com/python/cpython/tree/3.10/Lib/shutil.py]

shutil 模块提供了一系列对文件和文件集合的高阶操作。 特别是提供了一些支持文件拷贝和删除的函数。 对于单个文件的操作，请参阅 os 模块。

警告

即便是高阶文件拷贝函数 (shutil.copy(), shutil.copy2()) 也无法拷贝所有的文件元数据。

在 POSIX 平台上，这意味着将丢失文件所有者和组以及 ACL 数据。 在 Mac OS 上，资源钩子和其他元数据不被使用。 这意味着将丢失这些资源并且文件类型和创建者代码将不正确。 在 Windows 上，将不会拷贝文件所有者、ACL 和替代数据流。

目录和文件操作

shutil.copyfileobj(fsrc, fdst[, length])

将文件型对象 fsrc 的内容拷贝到文件型对象 fdst。 整数值 length 如果给出则为缓冲区大小。 特别地， length 为负值表示拷贝数据时不对源数据进行分块循环处理；默认情况下会分块读取数据以避免不受控制的内存消耗。 请注意如果 fsrc 对象的当前文件位置不为 0，则只有从当前文件位置到文件末尾的内容会被拷贝。

shutil.copyfile(src, dst, *, follow_symlinks=True)

将名为 src 的文件的内容（不包括元数据）拷贝到名为 dst 的文件并以尽可能高效的方式返回 dst。 src 和 dst 均为路径类对象或以字符串形式给出的路径名。

dst 必须是完整的目标文件名；对于接受目标目录路径的拷贝请参见 copy()。 如果 src 和 dst 指定了同一个文件，则将引发 SameFileError。

目标位置必须是可写的；否则将引发 OSError 异常。 如果 dst 已经存在，它将被替换。 特殊文件如字符或块设备以及管道无法用此函数来拷贝。

如果 follow_symlinks 为假值且 src 为符号链接，则将创建一个新的符号链接而不是拷贝 src 所指向的文件。

引发一个 审计事件 shutil.copyfile 并附带参数 src, dst。

在 3.3 版更改: 曾经是引发 IOError 而不是 OSError。 增加了 follow_symlinks 参数。 现在是返回 dst。

在 3.4 版更改: 引发 SameFileError 而不是 Error。 由于前者是后者的子类，此改变是向后兼容的。

在 3.8 版更改: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。 参见 依赖于具体平台的高效拷贝操作 一节。

exception shutil.SameFileError

此异常会在 copyfile() 中的源和目标为同一文件时被引发。

3.4 新版功能.

shutil.copymode(src, dst, *, follow_symlinks=True)

从 src 拷贝权限位到 dst。 文件的内容、所有者和分组将不受影响。 src 和 dst 均为路径类对象或字符串形式的路径名。 如果 follow_symlinks 为假值，并且 src 和 dst 均为符号链接，copymode() 将尝试修改 dst 本身的模式（而非它所指向的文件）。 此功能并不是在所有平台上均可用；请参阅 copystat() 了解详情。 如果 copymode() 无法修改本机平台上的符号链接，而它被要求这样做，它将不做任何操作即返回。

引发一个 审计事件 shutil.copymode 并附带参数 src, dst。

在 3.3 版更改: 加入 follow_symlinks 参数。

shutil.copystat(src, dst, *, follow_symlinks=True)

从 src 拷贝权限位、最近访问时间、最近修改时间以及旗标到 dst。 在 Linux上，copystat() 还会在可能的情况下拷贝“扩展属性”。 文件的内容、所有者和分组将不受影响。 src 和 dst 均为路径类对象或字符串形式的路径名。

如果 follow_symlinks 为假值，并且 src 和 dst 均指向符号链接，copystat() 将作用于符号链接本身而非该符号链接所指向的文件 — 从 src 符号链接读取信息，并将信息写入 dst 符号链接。

注解

并非所有平台者提供检查和修改符号链接的功能。 Python 本身可以告诉你哪些功能是在本机上可用的。

如果 os.chmod in os.supports_follow_symlinks 为 True，则 copystat() 可以修改符号链接的权限位。

如果 os.utime in os.supports_follow_symlinks 为 True，则 copystat() 可以修改符号链接的最近访问和修改时间。

如果 os.chflags in os.supports_follow_symlinks 为 True，则 copystat() 可以修改符号链接的旗标。 (os.chflags 不是在所有平台上均可用。)

在此功能部分或全部不可用的平台上，当被要求修改一个符号链接时，copystat() 将尽量拷贝所有内容。 copystat() 一定不会返回失败信息。

更多信息请参阅 os.supports_follow_symlinks。

引发一个 审计事件 shutil.copystat 并附带参数 src, dst。

在 3.3 版更改: 添加了 follow_symlinks 参数并且支持 Linux 扩展属性。

shutil.copy(src, dst, *, follow_symlinks=True)

将文件 src 拷贝到文件或目录 dst。 src 和 dst 应为 路径类对象 或字符串。 如果 dst 指定了一个目录，文件将使用 src 中的基准文件名拷贝到 dst 中。 如果 dst 指定了一个已存在的文件，它将被替换。 返回新创建文件所对应的路径。

如果 follow_symlinks 为假值且 src 为符号链接，则 dst 也将被创建为符号链接。 如果 follow_symlinks 为真值且 src 为符号链接，dst 将成为 src 所指向的文件的一个副本。

copy() 会拷贝文件数据和文件的权限模式 (参见 os.chmod())。 其他元数据，例如文件的创建和修改时间不会被保留。 要保留所有原有的元数据，请改用 copy2() 。

引发一个 审计事件 shutil.copyfile 并附带参数 src, dst。

引发一个 审计事件 shutil.copymode 并附带参数 src, dst。

在 3.3 版更改: 添加了 follow_symlinks 参数。 现在会返回新创建文件的路径。

在 3.8 版更改: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。 参见 依赖于具体平台的高效拷贝操作 一节。

shutil.copy2(src, dst, *, follow_symlinks=True)

类似于 copy()，区别在于 copy2() 还会尝试保留文件的元数据。

当 follow_symlinks 为假值，并且 src 为符号链接时，copy2() 会尝试将来自 src 符号链接的所有元数据拷贝到新创建的 dst 符号链接。 但是，此功能不是在所有平台上均可用。 在此功能部分或全部不可用的平台上，copy2() 将尽量保留所有元数据，copy2() 一定不会由于无法保留文件元数据而引发异常。

copy2() 会使用 copystat() 来拷贝文件元数据。 请参阅 copystat() 了解有关修改符号链接元数据的平台支持的更多信息。

引发一个 审计事件 shutil.copyfile 并附带参数 src, dst。

引发一个 审计事件 shutil.copystat 并附带参数 src, dst。

在 3.3 版更改: 添加了 follow_symlinks 参数，还会尝试拷贝扩展文件系统属性（目前仅限 Linux）。 现在会返回新创建文件的路径。

在 3.8 版更改: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。 参见 依赖于具体平台的高效拷贝操作 一节。

shutil.ignore_patterns(*patterns)

这个工厂函数会创建一个函数，它可被用作 copytree() 的 ignore 可调用对象参数，以忽略那些匹配所提供的 glob 风格的 patterns 之一的文件和目录。 参见以下示例。

shutil.copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)

递归地将以 src 为根起点的整个目录树拷贝到名为 dst 的目录并返回目标目录。 所需的包含 dst 的中间目录在默认情况下也将被创建。

目录的权限和时间会通过 copystat() 来拷贝，单个文件则会使用 copy2() 来拷贝。

如果 symlinks 为真值，源目录树中的符号链接会在新目录树中表示为符号链接，并且原链接的元数据在平台允许的情况下也会被拷贝；如果为假值或省略，则会将被链接文件的内容和元数据拷贝到新目录树。

当 symlinks 为假值时，如果符号链接所指向的文件不存在，则会在拷贝进程的末尾将一个异常添加到 Error 异常中的错误列表。 如果你希望屏蔽此异常那就将可选的 ignore_dangling_symlinks 旗标设为真值。 请注意此选项在不支持 os.symlink() 的平台上将不起作用。

如果给出了 ignore，它必须是一个可调用对象，该对象将接受 copytree() 所访问的目录以及 os.listdir() 所返回的目录内容列表作为其参数。 由于 copytree() 是递归地被调用的，ignore 可调用对象对于每个被拷贝目录都将被调用一次。 该可调用对象必须返回一个相对于当前目录的目录和文件名序列（即其第二个参数的子集）；随后这些名称将在拷贝进程中被忽略。 ignore_patterns() 可被用于创建这种基于 glob 风格模式来忽略特定名称的可调用对象。

如果发生了（一个或多个）异常，将引发一个附带原因列表的 Error。

如果给出了 copy_function，它必须是一个将被用来拷贝每个文件的可调用对象。 它在被调用时会将源路径和目标路径作为参数传入。 默认情况下，copy2() 将被使用，但任何支持同样签名（与 copy() 一致）都可以使用。

如果 dirs_exist_ok 为（默认的）假值且 dst 已存在，则会引发 FileExistsError。 如果 dirs_exist_ok 为真值，则如果拷贝操作遇到已存在的目录时将继续执行，并且在 dst 目录树中的文件将被 src 目录树中对应的文件所覆盖。

引发一个 审计事件 shutil.copytree 并附带参数 src, dst。

在 3.3 版更改: 当 symlinks 为假值时拷贝元数据。 现在会返回 dst。

在 3.2 版更改: 添加了 copy_function 参数以允许提供定制的拷贝函数。 添加了 ignore_dangling_symlinks 参数以便在 symlinks 为假值时屏蔽目标不存在的符号链接。

在 3.8 版更改: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。 参见 依赖于具体平台的高效拷贝操作 一节。

3.8 新版功能: dirs_exist_ok 形参。

shutil.rmtree(path, ignore_errors=False, onerror=None)

删除一个完整的目录树；path 必须指向一个目录（但不能是一个目录的符号链接）。 如果 ignore_errors 为真值，删除失败导致的错误将被忽略；如果为假值或是省略，此类错误将通过调用由 onerror 所指定的处理程序来处理，或者如果此参数被省略则将引发一个异常。

注解

在支持必要的基于 fd 的函数的平台上，默认会使用 rmtree() 的可防御符号链接攻击的版本。 在其他平台上，rmtree() 较易遭受符号链接攻击：给定适当的时间和环境，攻击者可以操纵文件系统中的符号链接来删除他们在其他情况下无法访问的文件。 应用程序可以使用 rmtree.avoids_symlink_attacks 函数属性来确定此类情况具体是哪一些。

如果提供了 onerror，它必须为接受三个形参的可调用对象: function, path 和 excinfo。

第一个形参 function 是引发异常的函数；它依赖于具体的平台和实现。 第二个形参 path 将是传递给 function 的路径名。 第三个形参 excinfo 将是由 sys.exc_info() 所返回的异常信息。 由 onerror 所引发的异常将不会被捕获。

引发一个 审计事件 shutil.rmtree 附带参数 path。

在 3.3 版更改: 添加了一个防御符号链接攻击的版本，如果平台支持基于 fd 的函数就会被使用。

在 3.8 版更改: 在 Windows 上将不会再在移除连接之前删除目录连接中的内容。

rmtree.avoids_symlink_attacks

指明当前平台和实现是否提供防御符号链接攻击的 rmtree() 版本。 目前它仅在平台支持基于 fd 的目录访问函数时才返回真值。

3.3 新版功能.

shutil.move(src, dst, copy_function=copy2)

递归地将一个文件或目录 (src) 移至另一位置 (dst) 并返回目标位置。

如果目标是已存在的目录，则 src 会被移至该目录下。 如果目标已存在但不是目录，它可能会被覆盖，具体取决于 os.rename() 的语义。

如果目标是在当前文件系统中，则会使用 os.rename()。 在其他情况下，src 将被拷贝至 dst，使用的函数为 copy_function，然后目标会被移除。 对于符号链接，则将在 dst 之下或以其本身为名称创建一个指向 src 目标的新符号链接，并且 src 将被移除。

如果给出了 copy_function，则它必须为接受两个参数 src 和 dst 的可调用对象，并将在 os.rename() 无法使用时被用来将 src 拷贝到 dst。 如果源是一个目录，则会调用 copytree()，并向它传入 copy_function()。 默认的 copy_function 是 copy2()。 使用 copy() 作为 copy_function 允许在无法附带拷贝元数据时让移动操作成功执行，但其代价是不拷贝任何元数据。

引发一个 审计事件 shutil.move 并附带参数 src, dst。

在 3.3 版更改: 为异类文件系统添加了显式的符号链接处理，以便使它适应 GNU 的 mv 的行为。 现在会返回 dst。

在 3.5 版更改: 增加了 copy_function 关键字参数。

在 3.8 版更改: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。 参见 依赖于具体平台的高效拷贝操作 一节。

在 3.9 版更改: 接受一个 path-like object 作为 src 和 dst。

shutil.disk_usage(path)

返回给定路径的磁盘使用统计数据，形式为一个 named tuple，其中包含 total, used 和 free 属性，分别表示总计、已使用和未使用空间的字节数。 path 可以是一个文件或是一个目录。

3.3 新版功能.

在 3.8 版更改: 在 Windows 上，path 现在可以是一个文件或目录。

可用性: Unix, Windows。

shutil.chown(path, user=None, group=None)

修改给定 path 的所有者 user 和/或 group。

user 可以是一个系统用户名或 uid；group 同样如此。 要求至少有一个参数。

另请参阅下层的函数 os.chown()。

引发一个 审计事件 shutil.chown 并附带参数 path, user, group。

可用性: Unix。

3.3 新版功能.

shutil.which(cmd, mode=os.F_OK | os.X_OK, path=None)

返回当给定的 cmd 被调用时将要运行的可执行文件的路径。 如果没有 cmd 会被调用则返回 None。

mode 是一个传递给 os.access() 的权限掩码，在默认情况下将确定文件是否存在并且为可执行文件。

当未指定 path 时，将会使用 os.environ() 的结果，返回 "PATH" 的值或回退为 os.defpath。

在 Windows 上当前目录总是会被添加为 path 的第一项，无论你是否使用默认值或提供你自己的路径，这是命令行终端在查找可执行文件时所采用的行为方式。 此外，当在 path 中查找 cmd 时，还会检查 PATHEXT 环境变量。 例如，如果你调用 shutil.which("python")，which() 将搜索 PATHEXT 来确定它要在 path 目录中查找 python.exe。 例如，在 Windows 上:

>>> shutil.which("python")
'C:\\Python33\\python.EXE'

3.3 新版功能.

在 3.8 版更改: 现在可以接受 bytes 类型。 如果 cmd 的类型为 bytes，结果的类型也将为 bytes。

exception shutil.Error

此异常会收集在多文件操作期间所引发的异常。 对于 copytree()，此异常参数将是一个由三元组 (srcname, dstname, exception) 构成的列表。

依赖于具体平台的高效拷贝操作

从 Python 3.8 开始，所有涉及文件拷贝的函数 (copyfile(), copy(), copy2(), copytree() 以及 move()) 将会使用平台专属的 "fast-copy" 系统调用以便更高效地拷贝文件 (参见 bpo-33671 [https://bugs.python.org/issue?@action=redirect&bpo=33671])。 "fast-copy" 意味着拷贝操作将发生于内核之中，避免像在 "outfd.write(infd.read())" 中那样使用 Python 用户空间的缓冲区。

在 macOS 上将会使用 fcopyfile [http://www.manpagez.com/man/3/copyfile/] 来拷贝文件内容（不含元数据）。

在 Linux 上将会使用 os.sendfile()。

在 Windows 上 shutil.copyfile() 将会使用更大的默认缓冲区（1 MiB 而非 64 KiB）并且会使用基于 memoryview() 的 shutil.copyfileobj() 变种形式。

如果快速拷贝操作失败并且没有数据被写入目标文件，则 shutil 将在内部静默地回退到使用效率较低的 copyfileobj() 函数。

在 3.8 版更改.

copytree 示例

一个使用 ignore_patterns() 辅助函数的例子:

from shutil import copytree, ignore_patterns

copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))

这将会拷贝除 .pyc 文件和以 tmp 打头的文件或目录以外的所有条目.

另一个使用 ignore 参数来添加记录调用的例子:

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)

rmtree 示例

这个例子演示了如何在 Windows 上删除一个目录树，其中部分文件设置了只读属性位。 它会使用 onerror 回调函数来清除只读属性位并再次尝试删除。 任何后续的失败都将被传播。

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, onerror=remove_readonly)

归档操作

3.2 新版功能.

在 3.5 版更改: 添加了对 xztar 格式的支持。

本模块也提供了用于创建和读取压缩和归档文件的高层级工具。 它们依赖于 zipfile 和 tarfile 模块。

shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])

创建一个归档文件（例如 zip 或 tar）并返回其名称。

base_name 是要创建的文件名称，包括路径，去除任何特定格式的扩展名。 format 是归档格式：为 "zip" (如果 zlib 模块可用), "tar", "gztar" (如果 zlib 模块可用), "bztar" (如果 bz2 模块可用) 或 "xztar" (如果 lzma 模块可用) 中的一个。

root_dir 是一个目录，它将作为归档文件的根目录，归档中的所有路径都将是它的相对路径；例如，我们通常会在创建归档之前用 chdir 命令切换到 root_dir。

base_dir 是我们要执行归档的起始目录；也就是说 base_dir 将成为归档中所有文件和目录共有的路径前缀。 base_dir 必须相对于 root_dir 给出。 请参阅 使用 base_dir 的归档程序示例 了解如何同时使用 base_dir 和 root_dir。

root_dir 和 base_dir 默认均为当前目录。

如果 dry_run 为真值，则不会创建归档文件，但将要被执行的操作会被记录到 logger。

owner 和 group 将在创建 tar 归档文件时被使用。 默认会使用当前的所有者和分组。

logger 必须是一个兼容 PEP 282 [https://www.python.org/dev/peps/pep-0282] 的对象，通常为 logging.Logger 的实例。

verbose 参数已不再使用并进入弃用状态。

引发一个 审计事件 shutil.make_archive 并附带参数 base_name, format, root_dir, base_dir。

注解

This function is not thread-safe when custom archivers registered with register_archive_format() are used. In this case it temporarily changes the current working directory of the process to perform archiving.

在 3.8 版更改: 现在对于通过 format="tar" 创建的归档文件将使用新式的 pax (POSIX.1-2001) 格式而非旧式的 GNU 格式。

在 3.10.6 版更改: 目前此函数在创建标准 .zip 和 tar 归档文件期间会确保是线程安全的。

shutil.get_archive_formats()

返回支持的归档格式列表。 所返回序列中的每个元素为一个元组 (name, description)。

默认情况下 shutil 提供以下格式:

zip: ZIP 文件（如果 zlib 模块可用）。

tar: 未压缩的 tar 文件。 对于新归档文件将使用 POSIX.1-2001 pax 格式。

gztar: gzip 压缩的 tar 文件（如果 zlib 模块可用）。

bztar: bzip2 压缩的 tar 文件（如果 bz2 模块可用）。

xztar: xz 压缩的 tar 文件（如果 lzma 模块可用）。

你可以通过使用 register_archive_format() 注册新的格式或为任何现有格式提供你自己的归档器。

shutil.register_archive_format(name, function[, extra_args[, description]])

为 name 格式注册一个归档器。

function 是将被用来解包归档文件的可调用对象。 该可调用对象将接收要创建文件的 base_name，再加上要归档内容的 base_dir (其默认值为 os.curdir)。 更多参数会被作为关键字参数传入: owner, group, dry_run 和 logger (与向 make_archive() 传入的参数一致)。

如果给出了 extra_args，则其应为一个 (name, value) 对的序列，将在归档器可调用对象被使用时作为附加的关键字参数。

description 由 get_archive_formats() 使用，它将返回归档器的列表。 默认值为一个空字符串。

shutil.unregister_archive_format(name)

从支持的格式中移除归档格式 name。

shutil.unpack_archive(filename[, extract_dir[, format[, filter]]])

解包一个归档文件。 filename 是归档文件的完整路径。

extract_dir 是归档文件解包的目标目录名称。 如果未提供，则将使用当前工作目录。

format 是归档格式：应为 "zip", "tar", "gztar", "bztar" 或 "xztar" 之一。 或者任何通过 register_unpack_format() 注册的其他格式。 如果未提供，unpack_archive() 将使用归档文件的扩展名来检查是否注册了对应于该扩展名的解包器。 在未找到任何解包器的情况下，将引发 ValueError。

The keyword-only filter argument, which was added in Python 3.10.12, is passed to the underlying unpacking function. For zip files, filter is not accepted. For tar files, it is recommended to set it to 'data', unless using features specific to tar and UNIX-like filesystems. (See 解压缩过滤器 for details.) The 'data' filter will become the default for tar files in Python 3.14.

引发一个 审计事件 shutil.unpack_archive 并附带参数 filename, extract_dir, format。

警告

绝不要未经预先检验就从不可靠的源中提取归档文件。 这样有可能会在 extract_dir 参数所指定的路径之外创建文件，例如某些成员具有以 "/" 打头的绝对路径文件名或是以两个点号 ".." 打头的文件名。

在 3.7 版更改: 接受一个 path-like object 作为 filename 和 extract_dir。

在 3.10.12 版更改: 增加了 filter 参数。

shutil.register_unpack_format(name, extensions, function[, extra_args[, description]])

注册一个解包格式。 name 为格式名称而 extensions 为对应于该格式的扩展名列表，例如 Zip 文件的扩展名为 .zip。

function 是将被用于解包归档的可调用对象。 该可调用对象将接受:

归档的路径，为位置参数;

归档要提取到的目录，为位置参数;

可选的 filter 关键字参数，如果有提供给 unpack_archive() 的话;

额外的关键字参数，由 (name, value) 元组组成的序列 extra_args 指明。

可以提供 description 来描述该格式，它将被 get_unpack_formats() 返回。

shutil.unregister_unpack_format(name)

撤销注册一个解包格式。 name 为格式的名称。

shutil.get_unpack_formats()

返回所有已注册的解包格式列表。 所返回序列中的每个元素为一个元组 (name, extensions, description)。

默认情况下 shutil 提供以下格式:

zip: ZIP 文件（只有在相应模块可用时才能解包压缩文件）。

tar: 未压缩的 tar 文件。

gztar: gzip 压缩的 tar 文件（如果 zlib 模块可用）。

bztar: bzip2 压缩的 tar 文件（如果 bz2 模块可用）。

xztar: xz 压缩的 tar 文件（如果 lzma 模块可用）。

你可以通过使用 register_unpack_format() 注册新的格式或为任何现有格式提供你自己的解包器。

归档程序示例

在这个示例中，我们创建了一个 gzip 压缩的 tar 归档文件，其中包含用户的 .ssh 目录下的所有文件:

>>> 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'

结果归档文件中包含有:

$ 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

使用 base_dir 的归档程序示例

在这个例子中，与 上面的例子 类似，我们演示了如何使用 make_archive()，但这次是使用 base_dir。 我们现在具有如下的目录结构:

$ tree tmp
tmp
└── root
    └── structure
        ├── content
            └── please_add.txt
        └── do_not_add.txt

在最终的归档中，应当会包括 please_add.txt，但不应当包括 do_not_add.txt。 因此我们使用以下代码:

>>> 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/my_archive.tar'

列出结果归档中的文件我们将会得到:

$ python -m tarfile -l /Users/tarek/myarchive.tar
structure/content/
structure/content/please_add.txt

查询输出终端的尺寸

shutil.get_terminal_size(fallback=(columns, lines))

获取终端窗口的尺寸。

对于两个维度中的每一个，会分别检查环境变量 COLUMNS 和 LINES。 如果定义了这些变量并且其值为正整数，则将使用这些值。

如果未定义 COLUMNS 或 LINES，这是通常的情况，则连接到 sys.__stdout__ 的终端将通过唤起 os.get_terminal_size() 被查询。

如果由于系统不支持查询，或是由于我们未连接到某个终端而导致查询终端尺寸不成功，则会使用在 fallback 形参中给出的值。 fallback 默认为 (80, 24)，这是许多终端模拟器所使用的默认尺寸。

返回的值是一个 os.terminal_size 类型的具名元组。

另请参阅: The Single UNIX Specification, Version 2, Other Environment Variables [https://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003].

3.3 新版功能.

数据持久化

本章中描述的模块支持在磁盘上以持久形式存储 Python 数据。 pickle 和 marshal 模块可以将许多 Python 数据类型转换为字节流，然后从字节中重新创建对象。 各种与 DBM 相关的模块支持一系列基于散列的文件格式，这些格式存储字符串到其他字符串的映射。

本章中描述的模块列表是：

pickle --- Python 对象序列化

与其他 Python 模块间的关系

与 marshal 间的关系

与 json 模块的比较

数据流格式

模块接口

可以被封存/解封的对象

封存类实例

持久化外部对象

Dispatch 表

处理有状态的对象

类型，函数和其他对象的自定义归约

外部缓冲区

提供方 API

使用方 API

示例

限制全局变量

性能

例子

copyreg --- 注册配合 pickle 模块使用的函数

示例

shelve --- Python 对象持久化

限制

示例

marshal --- 内部 Python 对象序列化

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

dbm.gnu --- GNU 对 dbm 的重解析

dbm.ndbm --- 基于 ndbm 的接口

dbm.dumb --- 便携式 DBM 实现

sqlite3 --- SQLite 数据库 DB-API 2.0 接口模块

教程

参考

模块函数

模块常量

连接对象

游标对象

Row 对象

PrepareProtocol 对象

异常

SQLite 与 Python 类型

默认适配器和转换器

常用方案指引

如何在 SQL 查询中使用占位符来绑定值

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

如何编写可适配对象

如何注册适配器可调用对象

如何将 SQLite 值转换为自定义 Python 类型

适配器和转换器范例程序

如何使用连接快捷方法

如何使用连接上下文管理器

如何使用 SQLite URI

如何创建并使用行工厂对象

说明

事务控制

pickle --- Python 对象序列化

源代码： Lib/pickle.py [https://github.com/python/cpython/tree/3.10/Lib/pickle.py]

模块 pickle 实现了对一个 Python 对象结构的二进制序列化和反序列化。 "pickling" 是将 Python 对象及其所拥有的层次结构转化为一个字节流的过程，而 "unpickling" 是相反的操作，会将（来自一个 binary file 或者 bytes-like object 的）字节流转化回一个对象层次结构。 pickling（和 unpickling）也被称为“序列化”, “编组” 1 或者 “平面化”。而为了避免混乱，此处采用术语 “封存 (pickling)” 和 “解封 (unpickling)”。

警告

pickle 模块 并不安全。 你只应该对你信任的数据进行 unpickle 操作。

构建恶意的 pickle 数据来 在解封时执行任意代码 是可能的。 绝对不要对不信任来源的数据和可能被篡改过的数据进行解封。

请考虑使用 hmac 来对数据进行签名，确保数据没有被篡改。

在你处理不信任数据时，更安全的序列化格式如 json 可能更为适合。参见 与 json 模块的比较 。

与其他 Python 模块间的关系

与 marshal 间的关系

Python 有一个更原始的序列化模块称为 marshal，但一般地 pickle 应该是序列化 Python 对象时的首选。marshal 存在主要是为了支持 Python 的 .pyc 文件.

pickle 模块与 marshal 在如下几方面显著地不同：

pickle 模块会跟踪已被序列化的对象，所以该对象之后再次被引用时不会再次被序列化。marshal 不会这么做。

这隐含了递归对象和共享对象。递归对象指包含对自己的引用的对象。这种对象并不会被 marshal 接受，并且实际上尝试 marshal 递归对象会让你的 Python 解释器崩溃。对象共享发生在对象层级中存在多处引用同一对象时。pickle 只会存储这些对象一次，并确保其他的引用指向同一个主副本。共享对象将保持共享，这可能对可变对象非常重要。

marshal 不能被用于序列化用户定义类及其实例。pickle 能够透明地存储并保存类实例，然而此时类定义必须能够从与被存储时相同的模块被引入。

同样用于序列化的 marshal 格式不保证数据能移植到不同的 Python 版本中。因为它的主要任务是支持 .pyc 文件，必要时会以破坏向后兼容的方式更改这种序列化格式，为此 Python 的实现者保留了更改格式的权利。pickle 序列化格式可以在不同版本的 Python 中实现向后兼容，前提是选择了合适的 pickle 协议。如果你的数据要在 Python 2 与 Python 3 之间跨越传递，封存和解封的代码在 2 和 3 之间也是不同的。

与 json 模块的比较

在 pickle 协议和 JSON (JavaScript Object Notation) [https://json.org] 之间有着本质上的差异:

JSON 是一个文本序列化格式（它输出 unicode 文本，尽管在大多数时候它会接着以 utf-8 编码），而 pickle 是一个二进制序列化格式；

JSON 是我们可以直观阅读的，而 pickle 不是；

JSON是可互操作的，在Python系统之外广泛使用，而pickle则是Python专用的；

默认情况下，JSON 只能表示 Python 内置类型的子集，不能表示自定义的类；但 pickle 可以表示大量的 Python 数据类型（可以合理使用 Python 的对象内省功能自动地表示大多数类型，复杂情况可以通过实现 specific object APIs 来解决）。

不像pickle，对一个不信任的JSON进行反序列化的操作本身不会造成任意代码执行漏洞。

参见

json 模块:一个允许JSON序列化和反序列化的标准库模块

数据流格式

pickle 所使用的数据格式仅可用于 Python。这样做的好处是没有外部标准给该格式强加限制，比如 JSON 或 XDR（不能表示共享指针）标准；但这也意味着非 Python 程序可能无法重新读取 pickle 封存的 Python 对象。

默认情况下，pickle 格式使用相对紧凑的二进制来存储。如果需要让文件更小，可以高效地 压缩 由 pickle 封存的数据。

pickletools 模块包含了相应的工具用于分析 pickle 生成的数据流。pickletools 源码中包含了对 pickle 协议使用的操作码的大量注释。

当前共有 6 种不同的协议可用于封存操作。 使用的协议版本越高，读取所生成 pickle 对象所需的 Python 版本就要越新。

v0 版协议是原始的“人类可读”协议，并且向后兼容早期版本的 Python。

v1 版协议是较早的二进制格式，它也与早期版本的 Python 兼容。

第 2 版协议是在 Python 2.3 中引入的。 它为 新式类 提供了更高效的封存机制。 请参考 PEP 307 [https://www.python.org/dev/peps/pep-0307] 了解第 2 版协议带来的改进的相关信息。

v3 版协议是在 Python 3.0 中引入的。 它显式地支持 bytes 字节对象，不能使用 Python 2.x 解封。这是 Python 3.0-3.7 的默认协议。

v4 版协议添加于 Python 3.4。它支持存储非常大的对象，能存储更多种类的对象，还包括一些针对数据格式的优化。它是Python 3.8使用的默认协议。有关第 4 版协议带来改进的信息，请参阅 PEP 3154 [https://www.python.org/dev/peps/pep-3154]。

第 5 版协议是在 Python 3.8 中加入的。 它增加了对带外数据的支持，并可加速带内数据处理。 请参阅 PEP 574 [https://www.python.org/dev/peps/pep-0574] 了解第 5 版协议所带来的改进的详情。

注解

序列化是一种比持久化更底层的概念，虽然 pickle 读取和写入的是文件对象，但它不处理持久对象的命名问题，也不处理对持久对象的并发访问（甚至更复杂）的问题。pickle 模块可以将复杂对象转换为字节流，也可以将字节流转换为具有相同内部结构的对象。处理这些字节流最常见的做法是将它们写入文件，但它们也可以通过网络发送或存储在数据库中。shelve 模块提供了一个简单的接口，用于在 DBM 类型的数据库文件上封存和解封对象。

模块接口

要序列化某个包含层次结构的对象，只需调用 dumps() 函数即可。同样，要反序列化数据流，可以调用 loads() 函数。但是，如果要对序列化和反序列化加以更多的控制，可以分别创建 Pickler 或 Unpickler 对象。

pickle 模块包含了以下常量：

pickle.HIGHEST_PROTOCOL

整数，可用的最高 协议版本。此值可以作为 协议 值传递给 dump() 和 dumps() 函数，以及 Pickler 的构造函数。

pickle.DEFAULT_PROTOCOL

整数，用于 pickle 数据的默认 协议版本。它可能小于 HIGHEST_PROTOCOL。当前默认协议是 v4，它在 Python 3.4 中首次引入，与之前的版本不兼容。

在 3.0 版更改: 默认协议版本是 3。

在 3.8 版更改: 默认协议版本是 4。

pickle 模块提供了以下方法，让封存过程更加方便：

pickle.dump(obj, file, protocol=None, *, fix_imports=True, buffer_callback=None)

将对象 obj 封存以后的对象写入已打开的 file object file。它等同于 Pickler(file, protocol).dump(obj)。

参数 file、protocol、fix_imports 和 buffer_callback 的含义与它们在 Pickler 的构造函数中的含义相同。

在 3.8 版更改: 加入了 buffer_callback 参数。

pickle.dumps(obj, protocol=None, *, fix_imports=True, buffer_callback=None)

将 obj 封存以后的对象作为 bytes 类型直接返回，而不是将其写入到文件。

参数 protocol、fix_imports 和 buffer_callback 的含义与它们在 Pickler 的构造函数中的含义相同。

在 3.8 版更改: 加入了 buffer_callback 参数。

pickle.load(file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

从已打开的 file object 文件 中读取封存后的对象，重建其中特定对象的层次结构并返回。它相当于 Unpickler(file).load()。

Pickle 协议版本是自动检测出来的，所以不需要参数来指定协议。封存对象以外的其他字节将被忽略。

参数 file、fix_imports、encoding、errors、strict 和 buffers 的含义与它们在 Unpickler 的构造函数中的含义相同。

在 3.8 版更改: 加入了 buffers 参数。

pickle.loads(data, /, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

重建并返回一个对象的封存表示形式 data 的对象层级结构。 data 必须为 bytes-like object。

Pickle 协议版本是自动检测出来的，所以不需要参数来指定协议。封存对象以外的其他字节将被忽略。

参数 fix_imports, encoding, errors, strict 和 buffers 的含义与在 Unpickler 构造器中的含义相同。

在 3.8 版更改: 加入了 buffers 参数。

pickle 模块定义了以下 3 个异常：

exception pickle.PickleError

其他 pickle 异常的基类。它是 Exception 的一个子类。

exception pickle.PicklingError

当 Pickler 遇到无法解封的对象时抛出此错误。它是 PickleError 的子类。

参考 可以被封存/解封的对象 来了解哪些对象可以被封存。

exception pickle.UnpicklingError

当解封出错时抛出此异常，例如数据损坏或对象不安全。它是 PickleError 的子类。

注意，解封时可能还会抛出其他异常，包括（但不限于） AttributeError、EOFError、ImportError 和 IndexError。

pickle 模块包含了 3 个类，Pickler、Unpickler 和 PickleBuffer：

class pickle.Pickler(file, protocol=None, *, fix_imports=True, buffer_callback=None)

它接受一个二进制文件用于写入 pickle 数据流。

可选参数 protocol 是一个整数，告知 pickler 使用指定的协议，可选择的协议范围从 0 到 HIGHEST_PROTOCOL。如果没有指定，这一参数默认值为 DEFAULT_PROTOCOL。指定一个负数就相当于指定 HIGHEST_PROTOCOL。

参数 file 必须有一个 write() 方法，该 write() 方法要能接收字节作为其唯一参数。因此，它可以是一个打开的磁盘文件（用于写入二进制内容），也可以是一个 io.BytesIO 实例，也可以是满足这一接口的其他任何自定义对象。

如果 fix_imports 为 True 且 protocol 小于 3，pickle 将尝试将 Python 3 中的新名称映射到 Python 2 中的旧模块名称，因此 Python 2 也可以读取封存的数据流。

如果 buffer_callback 为 None（默认情况），缓冲区视图（buffer view）将会作为 pickle 流的一部分被序列化到 file 中。

如果 buffer_callback 不为 None，那它可以用缓冲区视图调用任意次。如果某次调用返回了 False 值（例如 None），则给定的缓冲区是 带外的，否则缓冲区是带内的（例如保存在了 pickle 流里面）。

如果 buffer_callback 不是 None 且 protocol 是 None 或小于 5，就会出错。

在 3.8 版更改: 加入了 buffer_callback 参数。

dump(obj)

将 obj 封存后的内容写入已打开的文件对象，该文件对象已经在构造函数中指定。

persistent_id(obj)

默认无动作，该方法可被子类重写。

如果 persistent_id() 返回 None，obj 会被照常 pickle。如果返回其他值，Pickler 会将这个函数的返回值作为 obj 的持久化 ID（Pickler 本应得到序列化数据流并将其写入文件，若此函数有返回值，则得到此函数的返回值并写入文件）。这个持久化 ID 的解释应当定义在 Unpickler.persistent_load() 中（该方法定义还原对象的过程，并返回得到的对象）。注意，persistent_id() 的返回值本身不能拥有持久化 ID。

参阅 持久化外部对象 获取详情和使用示例。

dispatch_table

Pickler 对象的 dispatch 表是 copyreg.pickle() 中用到的 reduction 函数 的注册。dispatch 表本身是一个 class 到其 reduction 函数的映射键值对。一个 reduction 函数只接受一个参数，就是其关联的 class，函数行为应当遵守 __reduce__() 接口规范。

Pickler 对象默认并没有 dispatch_table 属性，该对象默认使用 copyreg 模块中定义的全局 dispatch 表。如果要为特定 Pickler 对象自定义序列化过程，可以将 dispatch_table 属性设置为类字典对象（dict-like object）。另外，如果 Pickler 的子类设置了 dispatch_table 属性，则该子类的实例会使用这个表作为默认的 dispatch 表。

参阅 Dispatch 表 获取使用示例。

3.3 新版功能.

reducer_override(obj)

可以在 Pickler 的子类中定义的特殊 reducer。此方法的优先级高于 dispatch_table 中的任何 reducer。它应该与 __reduce__() 方法遵循相同的接口，它也可以返回 NotImplemented，这将使用 dispatch_table 里注册的 reducer 来封存 obj。

参阅 类型，函数和其他对象的自定义归约 获取详细的示例。

3.8 新版功能.

fast

已弃用。设为 True 则启用快速模式。快速模式禁用了“备忘录” (memo) 的使用，即不生成多余的 PUT 操作码来加快封存过程。不应将其与自指 (self-referential) 对象一起使用，否则将导致 Pickler 无限递归。

如果需要进一步提高 pickle 的压缩率，请使用 pickletools.optimize()。

class pickle.Unpickler(file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

它接受一个二进制文件用于读取 pickle 数据流。

Pickle 协议版本是自动检测出来的，所以不需要参数来指定协议。

参数 file 必须有三个方法，read() 方法接受一个整数参数，readinto() 方法接受一个缓冲区作为参数，readline() 方法不需要参数，这与 io.BufferedIOBase 里定义的接口是相同的。因此 file 可以是一个磁盘上用于二进制读取的文件，也可以是一个 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 存储的 datetime、date 和 time 实例时，请使用 encoding='latin1'。

如果 buffers 为 None（默认值），则反序列化所需的所有数据都必须包含在 pickle 流中。这意味着在实例化 Pickler 时（或调用 dump() 或 dumps() 时），参数 buffer_callback 为 None。

如果 buffers 不为 None，则每次 pickle 流引用 带外 缓冲区视图时，消耗的对象都应该是可迭代的启用缓冲区的对象。这样的缓冲区应该按顺序地提供给 Pickler 对象的 buffer_callback 方法。

在 3.8 版更改: 加入了 buffers 参数。

load()

从构造函数中指定的文件对象里读取封存好的对象，重建其中特定对象的层次结构并返回。封存对象以外的其他字节将被忽略。

persistent_load(pid)

默认抛出 UnpicklingError 异常。

如果定义了此方法，persistent_load() 应当返回持久化 ID pid 所指定的对象。 如果遇到无效的持久化 ID，则应当引发 UnpicklingError。

参阅 持久化外部对象 获取详情和使用示例。

find_class(module, name)

如有必要，导入 module 模块并返回其中名叫 name 的对象，其中 module 和 name 参数都是 str 对象。注意，不要被这个函数的名字迷惑， find_class() 同样可以用来导入函数。

子类可以重写此方法，来控制加载对象的类型和加载对象的方式，从而尽可能降低安全风险。参阅 限制全局变量 获取更详细的信息。

引发一个 审计事件 pickle.find_class 并附带参数 module, name。

class pickle.PickleBuffer(buffer)

缓冲区的包装器 (wrapper)，缓冲区中包含着可封存的数据。buffer 必须是一个 buffer-providing 对象，比如 bytes-like object 或多维数组。

PickleBuffer 本身就可以生成缓冲区对象，因此可以将其传递给需要缓冲区生成器的其他 API，比如 memoryview。

PickleBuffer 对象只能用 pickle 版本 5 及以上协议进行序列化。它们符合 带外序列化 的条件。

3.8 新版功能.

raw()

返回该缓冲区底层内存区域的 memoryview。 返回的对象是一维的、C 连续布局的 memoryview，格式为 B (无符号字节)。 如果缓冲区既不是 C 连续布局也不是 Fortran 连续布局的，则抛出 BufferError 异常。

release()

释放由 PickleBuffer 占用的底层缓冲区。

可以被封存/解封的对象

下列类型可以被封存：

None, True 和 False;

整数、浮点数、复数;

字符串、字节串、字节数组;

只包含可封存对象的元组、列表、集合和字典;

可在模块最高层级上访问的（内置与用户自定义的）函数（使用 def，而不是使用 lambda 定义）;

可在模块最高层级上访问的类;

某些类实例，这些类的 __dict__ 属性值或 __getstate__() 函数的返回值可以被封存（详情参阅 封存类实例 这一段）。

尝试封存不能被封存的对象会抛出 PicklingError 异常，异常发生时，可能有部分字节已经被写入指定文件中。尝试封存递归层级很深的对象时，可能会超出最大递归层级限制，此时会抛出 RecursionError 异常，可以通过 sys.setrecursionlimit() 调整递归层级，不过请谨慎使用这个函数，因为可能会导致解释器崩溃。

请注意（内置与用户自定义的）函数是按完整 qualified name，而不是按值来封存的。 2 这意味着只会封存函数名称，以及包含它的模块和类名称。 函数的代码，以及函数的属性都不会被封存。 因而定义它的模块在解封环境中必须可以被导入，并且模块必须包含所命名的对象，否则将会引发异常。 3

类似地，类也是按完整限定名称来封存的，因此在解封环境中也会应用相同的限制。 请注意类的代码或数据都不会被封存，因此在下面的示例中类属性 attr 不会在解封环境中被恢复:

class Foo:
    attr = 'A class attribute'

picklestring = pickle.dumps(Foo)

这些限制决定了为什么可封存的函数和类必须在一个模块的最高层级上定义。

类似的，在封存类的实例时，其类体和类数据不会跟着实例一起被封存，只有实例数据会被封存。这样设计是有目的的，在将来修复类中的错误、给类增加方法之后，仍然可以载入原来版本类实例的封存数据来还原该实例。如果你准备长期使用一个对象，可能会同时存在较多版本的类体，可以为对象添加版本号，这样就可以通过类的 __setstate__() 方法将老版本转换成新版本。

封存类实例

在本节中，我们描述了可用于定义、自定义和控制如何封存和解封类实例的通用流程。

通常，使一个实例可被封存不需要附加任何代码。Pickle 默认会通过 Python 的内省机制获得实例的类及属性。而当实例解封时，它的 __init__() 方法通常 不会 被调用。其默认动作是：先创建一个未初始化的实例，然后还原其属性，下面的代码展示了这种行为的实现机制：

def save(obj):
    return (obj.__class__, obj.__dict__)

def restore(cls, attributes):
    obj = cls.__new__(cls)
    obj.__dict__.update(attributes)
    return obj

类可以改变默认行为，只需定义以下一种或几种特殊方法：

object.__getnewargs_ex__()

对于使用第 2 版或更高版协议的 pickle，实现了 __getnewargs_ex__() 方法的类可以控制在解封时传给 __new__() 方法的参数。本方法必须返回一对 (args, kwargs) 用于构建对象，其中 args 是表示位置参数的 tuple，而 kwargs 是表示命名参数的 dict。它们会在解封时传递给 __new__() 方法。

如果类的 __new__() 方法只接受关键字参数，则应当实现这个方法。否则，为了兼容性，更推荐实现 __getnewargs__() 方法。

在 3.6 版更改: __getnewargs_ex__() 现在可用于第 2 和第 3 版协议。

object.__getnewargs__()

这个方法与上一个 __getnewargs_ex__() 方法类似，但仅支持位置参数。它要求返回一个 tuple 类型的 args，用于解封时传递给 __new__() 方法。

如果定义了 __getnewargs_ex__()，那么 __getnewargs__() 就不会被调用。

在 3.6 版更改: 在 Python 3.6 前，第 2、3 版协议会调用 __getnewargs__()，更高版本协议会调用 __getnewargs_ex__()。

object.__getstate__()

类还可以进一步控制其实例的封存过程。如果类定义了 __getstate__()，它就会被调用，其返回的对象是被当做实例内容来封存的，否则封存的是实例的 __dict__。如果 __getstate__() 未定义，实例的 __dict__ 会被照常封存。

object.__setstate__(state)

当解封时，如果类定义了 __setstate__()，就会在已解封状态下调用它。此时不要求实例的 state 对象必须是 dict。没有定义此方法的话，先前封存的 state 对象必须是 dict，且该 dict 内容会在解封时赋给新实例的 __dict__。

注解

如果 __getstate__() 返回 False，那么在解封时就不会调用 __setstate__() 方法。

参考 处理有状态的对象 一段获取如何使用 __getstate__() 和 __setstate__() 方法的更多信息。

注解

在解封时，实例的某些方法例如 __getattr__(), __getattribute__() 或 __setattr__() 可能会被调用。 由于这些方法可能要求某些内部不变量为真值，因此该类型应当实现 __new__() 以建立这样的不变量，因为当解封一个实例时 __init__() 并不会被调用。

可以看出，其实 pickle 并不直接调用上面的几个函数。事实上，这几个函数是复制协议的一部分，它们实现了 __reduce__() 这一特殊接口。复制协议提供了统一的接口，用于在封存或复制对象的过程中取得所需数据。4

尽管这个协议功能很强，但是直接在类中实现 __reduce__() 接口容易产生错误。因此，设计类时应当尽可能的使用高级接口（比如 __getnewargs_ex__()、__getstate__() 和 __setstate__()）。后面仍然可以看到直接实现 __reduce__() 接口的状况，可能别无他法，可能为了获得更好的性能，或者两者皆有之。

object.__reduce__()

该接口当前定义如下。__reduce__() 方法不带任何参数，并且应返回字符串或最好返回一个元组（返回的对象通常称为“reduce 值”）。

如果返回字符串，该字符串会被当做一个全局变量的名称。它应该是对象相对于其模块的本地名称，pickle 模块会搜索模块命名空间来确定对象所属的模块。这种行为常在单例模式使用。

如果返回的是元组，则应当包含 2 到 6 个元素，可选元素可以省略或设置为 None。每个元素代表的意义如下：

一个可调用对象，该对象会在创建对象的最初版本时调用。

可调用对象的参数，是一个元组。如果可调用对象不接受参数，必须提供一个空元组。

可选元素，用于表示对象的状态，将被传给前述的 __setstate__() 方法。 如果对象没有此方法，则这个元素必须是字典类型，并会被添加至 __dict__ 属性中。

可选元素，一个返回连续项的迭代器（而不是序列）。这些项会被 obj.append(item) 逐个加入对象，或被 obj.extend(list_of_items) 批量加入对象。这个元素主要用于 list 的子类，也可以用于那些正确实现了 append() 和 extend() 方法的类。（具体是使用 append() 还是 extend() 取决于 pickle 协议版本以及待插入元素的项数，所以这两个方法必须同时被类支持。）

可选元素，一个返回连续键值对的迭代器（而不是序列）。这些键值对将会以 obj[key] = value 的方式存储于对象中。该元素主要用于 dict 子类，也可以用于那些实现了 __setitem__() 的类。

可选元素，一个带有 (obj, state) 签名的可调用对象。该可调用对象允许用户以编程方式控制特定对象的状态更新行为，而不是使用 obj 的静态 __setstate__() 方法。如果此处不是 None，则此可调用对象的优先级高于 obj 的 __setstate__()。

3.8 新版功能: 新增了元组的第 6 项，可选元素 (obj, state)。

object.__reduce_ex__(protocol)

作为替代选项，也可以实现 __reduce_ex__() 方法。 此方法的唯一不同之处在于它应接受一个整型参数用于指定协议版本。 如果定义了这个函数，则会覆盖 __reduce__() 的行为。 此外，__reduce__() 方法会自动成为扩展版方法的同义词。 这个函数主要用于为以前的 Python 版本提供向后兼容的 reduce 值。

持久化外部对象

为了获取对象持久化的利益， pickle 模块支持引用已封存数据流之外的对象。 这样的对象是通过一个持久化 ID 来引用的，它应当是一个由字母数字类字符组成的字符串 (对于第 0 版协议) 5 或是一个任意对象 (用于任意新版协议)。

pickle 模块不提供对持久化 ID 的解析工作，它将解析工作分配给用户定义的方法，分别是 pickler 中的 persistent_id() 方法和 unpickler 中的 persistent_load() 方法。

要通过持久化 ID 将外部对象封存，必须在 pickler 中实现 persistent_id() 方法，该方法接受需要被封存的对象作为参数，返回一个 None 或返回该对象的持久化 ID。如果返回 None，该对象会被按照默认方式封存为数据流。如果返回字符串形式的持久化 ID，则会封存这个字符串并加上一个标记，这样 unpickler 才能将其识别为持久化 ID。

要解封外部对象，Unpickler 必须实现 persistent_load() 方法，接受一个持久化 ID 对象作为参数并返回一个引用的对象。

下面是一个全面的例子，展示了如何使用持久化 ID 来封存外部对象。

# Simple example presenting how persistent ID can be used to pickle
# external objects by reference.

import pickle
import sqlite3
from collections import namedtuple

# Simple class representing a record in our database.
MemoRecord = namedtuple("MemoRecord", "key, task")

class DBPickler(pickle.Pickler):

    def persistent_id(self, obj):
        # Instead of pickling MemoRecord as a regular class instance, we emit a
        # persistent ID.
        if isinstance(obj, MemoRecord):
            # Here, our persistent ID is simply a tuple, containing a tag and a
            # key, which refers to a specific record in the database.
            return ("MemoRecord", obj.key)
        else:
            # If obj does not have a persistent ID, return None. This means obj
            # needs to be pickled as usual.
            return None

class DBUnpickler(pickle.Unpickler):

    def __init__(self, file, connection):
        super().__init__(file)
        self.connection = connection

    def persistent_load(self, pid):
        # This method is invoked whenever a persistent ID is encountered.
        # Here, pid is the tuple returned by DBPickler.
        cursor = self.connection.cursor()
        type_tag, key_id = pid
        if type_tag == "MemoRecord":
            # Fetch the referenced record from the database and return it.
            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
            key, task = cursor.fetchone()
            return MemoRecord(key, task)
        else:
            # Always raises an error if you cannot return the correct object.
            # Otherwise, the unpickler will think None is the object referenced
            # by the persistent ID.
            raise pickle.UnpicklingError("unsupported persistent object")

def main():
    import io
    import pprint

    # Initialize and populate our database.
    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,))

    # Fetch the records to be pickled.
    cursor.execute("SELECT * FROM memos")
    memos = [MemoRecord(key, task) for key, task in cursor]
    # Save the records using our custom DBPickler.
    file = io.BytesIO()
    DBPickler(file).dump(memos)

    print("Pickled records:")
    pprint.pprint(memos)

    # Update a record, just for good measure.
    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")

    # Load the records from the pickle data stream.
    file.seek(0)
    memos = DBUnpickler(file, conn).load()

    print("Unpickled records:")
    pprint.pprint(memos)

if __name__ == '__main__':
    main()

Dispatch 表

如果想对某些类进行自定义封存，而又不想在类中增加用于封存的代码，就可以创建带有特殊 dispatch 表的 pickler。

在 copyreg 模块的 copyreg.dispatch_table 中定义了全局 dispatch 表。因此，可以使用 copyreg.dispatch_table 修改后的副本作为自有 dispatch 表。

例如

f = io.BytesIO()
p = pickle.Pickler(f)
p.dispatch_table = copyreg.dispatch_table.copy()
p.dispatch_table[SomeClass] = reduce_SomeClass

创建了一个带有自有 dispatch 表的 pickle.Pickler 实例，它可以对 SomeClass 类进行特殊处理。另外，下列代码

class MyPickler(pickle.Pickler):
    dispatch_table = copyreg.dispatch_table.copy()
    dispatch_table[SomeClass] = reduce_SomeClass
f = io.BytesIO()
p = MyPickler(f)

完成同样的操作，但所有 MyPickler 的实例都会共享一个私有分发表。 另一方面，代码

copyreg.pickle(SomeClass, reduce_SomeClass)
f = io.BytesIO()
p = pickle.Pickler(f)

会修改由 copyreg 模块的所有用户共享的全局分发表。

处理有状态的对象

下面的示例展示了如何修改类在封存时的行为。其中 TextReader 类打开了一个文本文件，每次调用其 readline() 方法则返回行号和该行的字符。 在封存这个 TextReader 的实例时，除了 文件对象，其他属性都会被保存。 当解封实例时，需要重新打开文件，然后从上次的位置开始继续读取。实现这些功能需要实现 __setstate__() 和 __getstate__() 方法。

class TextReader:
    """Print and number lines in a text file."""

    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):
        # Copy the object's state from self.__dict__ which contains
        # all our instance attributes. Always use the dict.copy()
        # method to avoid modifying the original state.
        state = self.__dict__.copy()
        # Remove the unpicklable entries.
        del state['file']
        return state

    def __setstate__(self, state):
        # Restore instance attributes (i.e., filename and lineno).
        self.__dict__.update(state)
        # Restore the previously opened file's state. To do so, we need to
        # reopen it and read from it until the line count is restored.
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # Finally, save the file.
        self.file = file

使用方法如下所示：

>>> 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!'

类型，函数和其他对象的自定义归约

3.8 新版功能.

有时，dispatch_table 可能不够灵活。 特别是当我们想要基于对象类型以外的其他规则来对封存进行定制，或是当我们想要对函数和类的封存进行定制的时候。

对于那些情况，可能要基于 Pickler 类进行子类化并实现 reducer_override() 方法。 此方法可返回任意的归约元组 (参见 __reduce__())。 它也可以选择返回 NotImplemented 来回退到传统行为。

如果同时定义了 dispatch_table 和 reducer_override()，则 reducer_override() 方法具有优先权。

注解

出于性能理由，可能不会为以下对象调用 reducer_override(): None, True, False, 以及 int, float, bytes, str, dict, set, frozenset, list 和 tuple 的具体实例。

以下是一个简单的例子，其中我们允许封存并重新构建一个给定的类:

import io
import pickle

class MyClass:
    my_attribute = 1

class MyPickler(pickle.Pickler):
    def reducer_override(self, obj):
        """Custom reducer for MyClass."""
        if getattr(obj, "__name__", None) == "MyClass":
            return type, (obj.__name__, obj.__bases__,
                          {'my_attribute': obj.my_attribute})
        else:
            # For any other object, fallback to usual reduction
            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

外部缓冲区

3.8 新版功能.

在某些场景中，pickle 模块会被用来传输海量的数据。 因此，最小化内存复制次数以保证性能和节省资源是很重要的。 但是 pickle 模块的正常运作会将图类对象结构转换为字节序列流，因此在本质上就要从封存流中来回复制数据。

如果 provider (待传输对象类型的实现) 和 consumer (通信系统的实现) 都支持 pickle 第 5 版或更高版本所提供的外部传输功能，则此约束可以被撤销。

提供方 API

大的待封存数据对象必须实现协议 5 及以上版本专属的 __reduce_ex__() 方法，该方法将为任意大的数据返回一个 PickleBuffer 实例（而不是 bytes 对象等）。

PickleBuffer 对象会 表明 底层缓冲区可被用于外部数据传输。 那些对象仍将保持与 pickle 模块的正常用法兼容。 但是，使用方也可以选择告知 pickle 它们将自行处理那些缓冲区。

使用方 API

当序列化一个对象图时，通信系统可以启用对所生成 PickleBuffer 对象的定制处理。

发送端需要传递 buffer_callback 参数到 Pickler (或是到 dump() 或 dumps() 函数)，该回调函数将在封存对象图时附带每个所生成的 PickleBuffer 被调用。 由 buffer_callback 所累积的缓冲区的数据将不会被拷贝到 pickle 流，而是仅插入一个简单的标记。

接收端需要传递 buffers 参数到 Unpickler (或是到 load() 或 loads() 函数)，其值是一个由缓冲区组成的可迭代对象，它会被传递给 buffer_callback。 该可迭代对象应当按其被传递给 buffer_callback 时的顺序产生缓冲区。 这些缓冲区将提供对象重构造器所期望的数据，对这些数据的封存产生了原本的 PickleBuffer 对象。

在发送端和接受端之间，通信系统可以自由地实现它自己用于外部缓冲区的传输机制。 潜在的优化包括使用共享内存或基于特定数据类型的压缩等。

示例

下面是一个小例子，在其中我们实现了一个 bytearray 的子类，能够用于外部缓冲区封存:

class ZeroCopyByteArray(bytearray):

    def __reduce_ex__(self, protocol):
        if protocol >= 5:
            return type(self)._reconstruct, (PickleBuffer(self),), None
        else:
            # PickleBuffer is forbidden with pickle protocols <= 4.
            return type(self)._reconstruct, (bytearray(self),)

    @classmethod
    def _reconstruct(cls, obj):
        with memoryview(obj) as m:
            # Get a handle over the original buffer object
            obj = m.obj
            if type(obj) is cls:
                # Original buffer object is a ZeroCopyByteArray, return it
                # as-is.
                return obj
            else:
                return cls(obj)

重构造器 (_reconstruct 类方法) 会在缓冲区的提供对象具有正确类型时返回该对象。 在此小示例中这是模拟零拷贝行为的便捷方式。

在使用方，我们可以按通常方式封存那些对象，它们在反序列化时将提供原始对象的一个副本:

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: a copy was made

但是如果我们传入 buffer_callback 然后在反序列化时给回累积的缓冲区，我们就能够取回原始对象:

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: no copy was made

这个例子受限于 bytearray 会自行分配内存这一事实：你无法基于另一个对象的内存创建 bytearray 的实例。 但是，第三方数据类型例如 NumPy 数组则没有这种限制，允许在单独进程或系统间传输时使用零拷贝的封存（或是尽可能少地拷贝） 。

参见

PEP 574 [https://www.python.org/dev/peps/pep-0574] -- 带有外部数据缓冲区的 pickle 协议 5

限制全局变量

默认情况下，解封将会导入在 pickle 数据中找到的任何类或函数。 对于许多应用来说，此行为是不可接受的，因为它会允许解封器导入并唤起任意代码。 只须考虑当这个手工构建的 pickle 数据流被加载时会做什么:

>>> import pickle
>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
hello world
0

在这个例子里，解封器导入 os.system() 函数然后应用字符串参数 "echo hello world"。 虽然这个例子不具攻击性，但是不难想象别人能够通过此方式对你的系统造成损害。

出于这样的理由，你可能会希望通过定制 Unpickler.find_class() 来控制要解封的对象。 与其名称所提示的不同，Unpickler.find_class() 会在执行对任何全局对象（例如一个类或一个函数）的请求时被调用。 因此可以完全禁止全局对象或是将它们限制在一个安全的子集中。

下面的例子是一个解封器，它只允许某一些安全的来自 builtins 模块的类被加载:

import builtins
import io
import pickle

safe_builtins = {
    'range',
    'complex',
    'set',
    'frozenset',
    'slice',
}

class RestrictedUnpickler(pickle.Unpickler):

    def find_class(self, module, name):
        # Only allow safe classes from builtins.
        if module == "builtins" and name in safe_builtins:
            return getattr(builtins, name)
        # Forbid everything else.
        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                     (module, name))

def restricted_loads(s):
    """Helper function analogous to pickle.loads()."""
    return RestrictedUnpickler(io.BytesIO(s)).load()

我们这个解封器完成其功能的一个示例用法:

>>> 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

正如我们这个例子所显示的，对于允许解封的对象你必须要保持谨慎。 因此如果要保证安全，你可以考虑其他选择例如 xmlrpc.client 中的编组 API 或是第三方解决方案。

性能

较新版本的 pickle 协议（第 2 版或更高）具有针对某些常见特性和内置类型的高效二进制编码格式。 此外，pickle 模块还拥有一个以 C 编写的透明优化器。

例子

对于最简单的代码，请使用 dump() 和 load() 函数。

import pickle

# An arbitrary collection of objects supported by 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:
    # Pickle the 'data' dictionary using the highest protocol available.
    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)

以下示例读取之前封存的数据。

import pickle

with open('data.pickle', 'rb') as f:
    # The protocol version used is detected automatically, so we do not
    # have to specify it.
    data = pickle.load(f)

参见

模块 copyreg

为扩展类型提供 pickle 接口所需的构造函数。

模块 pickletools

用于处理和分析已封存数据的工具。

模块 shelve

带索引的数据库，用于存放对象，使用了 pickle 模块。

模块 copy

浅层 (shallow) 和深层 (deep) 复制对象操作

模块 marshal

高效地序列化内置类型的数据。

备注

1

不要把它与 marshal 模块混淆。

2

这就是为什么 lambda 函数不可以被封存：所有的匿名函数都有同一个名字：<lambda>。

3

抛出的异常有可能是 ImportError 或 AttributeError，也可能是其他异常。

4

copy 模块使用这一协议实现浅层 (shallow) 和深层 (deep) 复制操作。

5

对于字符数字类字符的限制是由于持久化 ID 在协议版本 0 中是由分行符来分隔的。 因此如果持久化 ID 中出现了任何形式的分行符，封存结果就将变得无法读取。

copyreg --- 注册配合 pickle 模块使用的函数

源代码: Lib/copyreg.py [https://github.com/python/cpython/tree/3.10/Lib/copyreg.py]

copyreg 模块提供了可在封存特定对象时使用的一种定义函数方式。 pickle 和 copy 模块会在封存/拷贝特定对象时使用这些函数。 此模块提供了非类对象构造器的相关配置信息。 这样的构造器可以是工厂函数或类实例。

copyreg.constructor(object)

将 object 声明为一个有效的构造器。 如果 object 是不可调用的（因而不是一个有效的构造器）则会引发 TypeError。

copyreg.pickle(type, function, constructor_ob=None)

Declares that function should be used as a "reduction" function for objects of type type. function should return either a string or a tuple containing two or three elements. See the dispatch_table for more details on the interface of function.

constructor_ob 形参是一个旧式特性并且现在会被忽略，但如果传入则它必须为一个可调用对象。

请注意一个 pickler 或 pickle.Pickler 的子类的 dispatch_table 属性也可以被用来声明约归函数。

示例

以下示例将会显示如何注册一个封存函数，以及如何来使用它：

>>> 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...

shelve --- Python 对象持久化

源代码: Lib/shelve.py [https://github.com/python/cpython/tree/3.10/Lib/shelve.py]

"Shelf" 是一种持久化的类似字典的对象。 与 "dbm" 数据库的区别在于 Shelf 中的值（不是键！）实际上可以为任意 Python 对象 --- 即 pickle 模块能够处理的任何东西。 这包括大部分类实例、递归数据类型，以及包含大量共享子对象的对象。 键则为普通的字符串。

shelve.open(filename, flag='c', protocol=None, writeback=False)

打开一个持久化字典。 filename 指定下层数据库的基准文件名。 作为附带效果，会为 filename 添加一个扩展名并且可能创建更多的文件。 默认情况下，下层数据库会以读写模式打开。 可选的 flag 形参具有与 dbm.open() flag 形参相同的含义。

在默认情况下，会使用以 pickle.DEFAULT_PROTOCOL 创建的 pickle 来序列化值。 pickle 协议的版本可通过 protocol 形参来指定。

由于 Python 语义的限制，Shelf 对象无法确定一个可变的持久化字典条目在何时被修改。 默认情况下 只有 在被修改对象再赋值给 shelf 时才会写入该对象 (参见 示例)。 如果可选的 writeback 形参设为 True，则所有被访问的条目都将在内存中被缓存，并会在 sync() 和 close() 时被写入；这可以使得对持久化字典中可变条目的修改更方便，但是如果访问的条目很多，这会消耗大量内存作为缓存，并会使得关闭操作变得非常缓慢，因为所有被访问的条目都需要写回到字典（无法确定被访问的条目中哪个是可变的，也无法确定哪个被实际修改了）。

在 3.10 版更改: pickle.DEFAULT_PROTOCOL 现在会被用作默认的 pickle 协议。

注解

请不要依赖于 Shelf 的自动关闭功能；当你不再需要时应当总是显式地调用 close()，或者使用 shelve.open() 作为上下文管理器:

with shelve.open('spam') as db:
    db['eggs'] = 'eggs'

警告

由于 shelve 模块需要 pickle 的支持，因此从不可靠的来源载入 shelf 是不安全的。 与 pickle 一样，载入 Shelf 时可以执行任意代码。

Shelf 对象支持字典所支持的大多数方法和运算（除了拷贝、构造器以及 | 和 |= 运算符）。 这样就能方便地将基于字典的脚本转换为要求持久化存储的脚本。

额外支持的两个方法：

Shelf.sync()

如果 Shelf 打开时将 writeback 设为 True 则写回缓存中的所有条目。 如果可行还会清空缓存并将持久化字典同步到磁盘。 此方法会在使用 close() 关闭 Shelf 时自动被调用。

Shelf.close()

同步并关闭持久化 dict 对象。 对已关闭 Shelf 的操作将失败并引发 ValueError。

参见

持久化字典方案 [https://code.activestate.com/recipes/576642/]，使用了广泛支持的存储格式并具有原生字典的速度。

限制

可选择使用哪种数据库包 (例如 dbm.ndbm 或 dbm.gnu) 取决于支持哪种接口。 因此使用 dbm 直接打开数据库是不安全的。 如果使用了 dbm，数据库同样会（不幸地）受限于它 --- 这意味着存储在数据库中的（封存形式的）对象尺寸应当较小，并且在少数情况下键冲突有可能导致数据库拒绝更新。

shelve 模块不支持对 Shelf 对象的 并发 读/写访问。 （多个同时读取访问则是安全的。） 当一个程序打开一个 shelve 对象来写入时，不应再有其他程序同时打开它来读取或写入。 Unix 文件锁定可被用来解决此问题，但这在不同 Unix 版本上会存在差异，并且需要有关所用数据库实现的细节知识。

class shelve.Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')

collections.abc.MutableMapping 的一个子类，它会将封存的值保存在 dict 对象中。

在默认情况下，会使用以 pickle.DEFAULT_PROTOCOL 创建的 pickle 来序列化值。 pickle 协议的版本可通过 protocol 形参来指定。 请参阅 pickle 文档来查看 pickle 协议的相关讨论。

如果 writeback 形参为 True，对象将为所有访问过的条目保留缓存并在同步和关闭时将它们写回到 dict。 这允许对可变的条目执行自然操作，但是会消耗更多内存并让同步和关闭花费更长时间。

keyencoding 形参是在下层字典被使用之前用于编码键的编码格式。

Shelf 对象还可以被用作上下文管理器，在这种情况下它将在 with 语句块结束时自动被关闭。

在 3.2 版更改: 添加了 keyencoding 形参；之前，键总是使用 UTF-8 编码。

在 3.4 版更改: 添加了上下文管理器支持。

在 3.10 版更改: pickle.DEFAULT_PROTOCOL 现在会被用作默认的 pickle 协议。

class shelve.BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8')

Shelf 的一个子类，将 first(), next(), previous(), last() 和 set_location() 对外公开，在来自 pybsddb [https://www.jcea.es/programacion/pybsddb.htm] 的第三方 bsddb 模块中可用，但在其他数据库模块中不可用。 传给构造器的 dict 对象必须支持这些方法。 这通常是通过调用 bsddb.hashopen(), bsddb.btopen() 或 bsddb.rnopen() 之一来完成的。 可选的 protocol, writeback 和 keyencoding 形参具有与 Shelf 类相同的含义。

class shelve.DbfilenameShelf(filename, flag='c', protocol=None, writeback=False)

Shelf 的一个子类，它接受一个 filename 而非字典类对象。 下层文件将使用 dbm.open() 来打开。 默认情况下，文件将以读写模式打开。 可选的 flag 形参具有与 open() 函数相同的含义。 可选的 protocol 和 writeback 形参具有与 Shelf 类相同的含义。

示例

对接口的总结如下 (key 为字符串，data 为任意对象):

import shelve

d = shelve.open(filename)  # open -- file may get suffix added by low-level
                           # library

d[key] = data              # store data at key (overwrites old data if
                           # using an existing key)
data = d[key]              # retrieve a COPY of data at key (raise KeyError
                           # if no such key)
del d[key]                 # delete data stored at key (raises KeyError
                           # if no such key)

flag = key in d            # true if the key exists
klist = list(d.keys())     # a list of all existing keys (slow!)

# as d was opened WITHOUT writeback=True, beware:
d['xx'] = [0, 1, 2]        # this works as expected, but...
d['xx'].append(3)          # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]!

# having opened d without writeback=True, you need to code carefully:
temp = d['xx']             # extracts the copy
temp.append(5)             # mutates the copy
d['xx'] = temp             # stores the copy right back, to persist it

# or, d=shelve.open(filename,writeback=True) would let you just code
# d['xx'].append(5) and have it work as expected, BUT it would also
# consume more memory and make the d.close() operation slower.

d.close()                  # close it

参见

模块 dbm

dbm 风格数据库的泛型接口。

模块 pickle

shelve 所使用的对象序列化。

marshal --- 内部 Python 对象序列化

此模块包含一此能以二进制格式来读写 Python 值的函数。 这种格式是 Python 专属的，但是独立于特定的机器架构（即你可以在一台 PC 上写入某个 Python 值，将文件传到一台 Sun 上并在那里读取它）。 这种格式的细节有意不带文档说明；它可能在不同 Python 版本中发生改变（但这种情况极少发生）。 1

这不是一个通用的“持久化”模块。 对于通用的持久化以及通过 RPC 调用传递 Python 对象，请参阅 pickle 和 shelve 等模块。 marshal 模块主要是为了支持读写 .pyc 文件形式“伪编译”代码的 Python 模块。 因此，Python 维护者保留在必要时以不向下兼容的方式修改 marshal 格式的权利。 如果你要序列化和反序列化 Python 对象，请改用 pickle 模块 -- 其执行效率相当，版本独立性有保证，并且 pickle 还支持比 marshal 更多样的对象类型。

警告

marshal 模块对于错误或恶意构建的数据来说是不安全的。 永远不要 unmarshal 来自不受信任的或未经验证的来源的数据。

不是所有 Python 对象类型都受支持；一般来说，此模块只能写入和读取不依赖于特定 Python 调用的对象。 下列类型是受支持的：布尔值、整数、浮点数、复数、字符串、字节串、字节数组、元组、列表、集合、冻结集合、字典和代码对象，需要了解的一点是元组、列表、集合、冻结集合和字典只在其所包含的值也是这些值时才受支持。 单例对象 None, Ellipsis and StopIteration 也可以被 marshal 和 unmarshal。 对于 version 低于 3 的格式，递归列表、集合和字典无法被写入（见下文）。

有些函数可以读/写文件，还有些函数可以操作字节类对象。

这个模块定义了以下函数：

marshal.dump(value, file[, version])

向打开的文件写入值。 值必须为受支持的类型。 文件必须为可写的 binary file。

如果值具有（或所包含的对象具有）不受支持的类型，则会引发 ValueError --- 但是将向文件写入垃圾数据。 对象也将不能正确地通过 load() 重新读取。

version 参数指明 dump 应当使用的数据格式（见下文）。

引发一个 审计事件 marshal.dumps 并附带参数 value, version。

marshal.load(file)

从打开的文件读取一个值并返回。 如果读不到有效的值（例如由于数据为不同 Python 版本的不兼容 marshal 格式），则会引发 EOFError, ValueError 或 TypeError。 文件必须为可读的 binary file。

引发一个不带参数的 审计事件 marshal.load。

注解

如果通过 dump() marshal 了一个包含不受支持类型的对象，load() 将为不可 marshal 的类型替换 None。

在 3.10 版更改: 使用此调用为每个代码对象引发一个 code.__new__ 审计事件。 现在它会为整个载入操作引发单个 marshal.load 事件。

marshal.dumps(value[, version])

返回将通过 dump(value, file) 被写入一个文件的字节串对象。 值必须属于受支持的类型。 如果值属于（或包含的对象属于）不受支持的类型则会引发 ValueError。

version 参数指明 dumps 应当使用的数据类型（见下文）。

引发一个 审计事件 marshal.dumps 并附带参数 value, version。

marshal.loads(bytes)

将 bytes-like object 转换为一个值。 如果找不到有效的值，则会引发 EOFError, ValueError 或 TypeError。 输入的额外字节串会被忽略。

引发一个 审计事件 marshal.loads 并附带参数 bytes。

在 3.10 版更改: 使用此调用为每个代码对象引发一个 code.__new__ 审计事件。 现在它会为整个载入操作引发单个 marshal.loads 事件。

此外，还定义了以下常量：

marshal.version

指明模块所使用的格式。 第 0 版为历史格式，第 1 版为共享固化的字符串，第 2 版对浮点数使用二进制格式。 第 3 版添加了对于对象实例化和递归的支持。 目前使用的为第 4 版。

备注

1

此模块的名称来源于 Modula-3 (及其他语言) 的设计者所使用的术语，他们使用术语 "marshal" 来表示以自包含的形式传输数据。 严格地说，将数据从内部形式转换为外部形式 (例如用于 RPC 缓冲区) 称为 "marshal" 而其逆过程则称为 "unmarshal"。

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

源代码: Lib/dbm/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/dbm/__init__.py]

dbm 是一种泛用接口，针对各种 DBM 数据库 --- 包括 dbm.gnu 或 dbm.ndbm。 如果未安装这些模块中的任何一种，则将使用 dbm.dumb 模块中慢速但简单的实现。 还有一个适用于 Oracle Berkeley DB 的 第三方接口 [https://www.jcea.es/programacion/pybsddb.htm]。

exception dbm.error

一个元组，其中包含每个受支持的模块可引发的异常，另外还有一个名为 dbm.error 的特殊异常作为第一项 --- 后者最在引发 dbm.error 时被使用。

dbm.whichdb(filename)

此函数会猜测各种简单数据库模块中的哪一个是可用的 --- dbm.gnu, dbm.ndbm 还是 dbm.dumb --- 应该被用来打开给定的文件。

返回下列值中的一个：如果文件由于不可读或不存在而无法打开则返回 None；如果文件的格式无法猜测则返回空字符串 ('')；或是包含所需模块名称的字符串，例如 'dbm.ndbm' 或 'dbm.gnu'。

dbm.open(file, flag='r', mode=0o666)

打开数据库文件 file 并返回一个相应的对象。

如果数据库文件已存在，则使用 whichdb() 函数来确定其类型和要使用的适当模块；如果文件不存在，则会使用上述可导入模块中的第一个。

可选的 flag 参数可以是：

值 | 含意
'r' | 以只读方式打开现有数据库（默认）
'w' | 以读写方式打开现有数据库
'c' | 以读写方式打开数据库，如果不存在则创建它
'n' | 始终创建一个新的空数据库，以读写方式打开

可选的 mode 参数是文件的 Unix 模式，仅在要创建数据库时才会被使用。 其默认值为八进制数 0o666 (并将被当前的 umask 所修改)。

open() 所返回的对象支持与字典相同的基本功能；可以存储、获取和删除键及其对应的值，并可使用 in 运算符和 keys() 方法，以及 get() 和 setdefault()。

在 3.2 版更改: 现在 get() 和 setdefault() 在所有数据库模块中均可用。

在 3.8 版更改: 从只读数据库中删除键将引发数据库模块专属的错误而不是 KeyError。

键和值总是被存储为字节串。 这意味着当使用字符串时它们会在被存储之前隐式地转换至默认编码格式。

这些对象也支持在 with 语句中使用，当语句结束时将自动关闭它们。

在 3.4 版更改: 向 open() 所返回的对象添加了上下文管理协议的原生支持。

以下示例记录了一些主机名和对应的标题，随后将数据库的内容打印出来。:

import dbm

# Open database, creating it if necessary.
with dbm.open('cache', 'c') as db:

    # Record some values
    db[b'hello'] = b'there'
    db['www.python.org'] = 'Python Website'
    db['www.cnn.com'] = 'Cable News Network'

    # Note that the keys are considered bytes now.
    assert db[b'www.python.org'] == b'Python Website'
    # Notice how the value is now in bytes.
    assert db['www.cnn.com'] == b'Cable News Network'

    # Often-used methods of the dict interface work too.
    print(db.get('python.org', b'not present'))

    # Storing a non-string key or value will raise an exception (most
    # likely a TypeError).
    db['www.yahoo.com'] = 4

# db is automatically closed when leaving the with statement.

参见

模块 shelve

存储非字符串数据的持久化模块。

以下部分描述了各个单独的子模块。

dbm.gnu --- GNU 对 dbm 的重解析

源代码: Lib/dbm/gnu.py [https://github.com/python/cpython/tree/3.10/Lib/dbm/gnu.py]

此模块与 dbm 模块很相似，但是改用 GNU 库 gdbm 来提供某些附加功能。 请注意由 dbm.gnu 与 dbm.ndbm 所创建的文件格式是不兼容的。

dbm.gnu 模块提供了对 GNU DBM 库的接口。 dbm.gnu.gdbm 对象的行为类似于映射（字典），区别在于其键和值总是会在存储之前被转换为字节串。 打印 gdbm 对象不会打印出键和值，并且 items() 和 values() 等方法也不受支持。

exception dbm.gnu.error

针对 dbm.gnu 专属错误例如 I/O 错误引发。 KeyError 的引发则针对一般映射错误例如指定了不正确的键。

dbm.gnu.open(filename[, flag[, mode]])

打开一个 gdbm 数据库并返回 gdbm 对象。 filename 参数为数据库文件名称。

可选的 flag 参数可以是：

值 | 含意
'r' | 以只读方式打开现有数据库（默认）
'w' | 以读写方式打开现有数据库
'c' | 以读写方式打开数据库，如果不存在则创建它
'n' | 始终创建一个新的空数据库，以读写方式打开

下列附加字符可被添加至旗标以控制数据库的打开方式：

值 | 含意
'f' | 以快速模式打开数据库。写入数据库将不会同步。
's' | 同步模式。这将导致数据库的更改立即写入文件。
'u' | 不要锁定数据库。

不是所有旗标都可用于所有版本的 gdbm。 模块常量 open_flags 为包含受支持旗标字符的字符串。 如果指定了无效的旗标则会引发 error。

可选的 mode 参数是文件的 Unix 模式，仅在要创建数据库时才会被使用。 其默认值为八进制数 0o666。

除了与字典类似的方法，gdbm 对象还有以下方法：

gdbm.firstkey()

使用此方法和 nextkey() 方法可以循环遍历数据库中的每个键。 遍历的顺序是按照 gdbm 的内部哈希值，而不会根据键的值排序。 此方法将返回起始键。

gdbm.nextkey(key)

在遍历中返回 key 之后的的下一个键。 以下代码将打印数据库 db 中的每个键，而不会在内存中创建一个包含所有键的列表:

k = db.firstkey()
while k is not None:
    print(k)
    k = db.nextkey(k)

gdbm.reorganize()

如果你进行了大量删除操作并且想要缩减 gdbm 文件所使用的空间，此例程将可重新组织数据库。 除非使用此重组功能否则 gdbm 对象不会缩减数据库文件大小；在其他情况下，被删除的文件空间将会保留并在添加新的 (键, 值) 对时被重用。

gdbm.sync()

当以快速模式打开数据库时，此方法会将任何未写入数据强制写入磁盘。

gdbm.close()

关闭 gdbm 数据库。

dbm.ndbm --- 基于 ndbm 的接口

源代码: Lib/dbm/ndbm.py [https://github.com/python/cpython/tree/3.10/Lib/dbm/ndbm.py]

dbm.ndbm 模块提供了对 Unix "(n)dbm" 库的接口。 Dbm 对象的行为类似于映射（字典），区别在于其键和值总是被存储为字节串。 打印 dbm 对象不会打印出键和值，并且 items() 和 values() 等方法也不受支持。

此模块可与 "经典classic" ndbm 接口或 GNU GDBM 兼容接口一同使用。 在 Unix 上，configure 脚本将尝试定位适当的头文件来简化此模块的构建。

exception dbm.ndbm.error

针对 dbm.ndbm 专属错误例如 I/O 错误引发。 KeyError 的引发则针对一般映射错误例如指定了不正确的键。

dbm.ndbm.library

所使用的 ndbm 实现库的名称。

dbm.ndbm.open(filename[, flag[, mode]])

打开一个 dbm 数据库并返回 ndbm 对象。 filename 参数为数据库文件名称（不带 .dir 或 .pag 扩展名）。

可选的 flag 参数必须是下列值之一：

值 | 含意
'r' | 以只读方式打开现有数据库（默认）
'w' | 以读写方式打开现有数据库
'c' | 以读写方式打开数据库，如果不存在则创建它
'n' | 始终创建一个新的空数据库，以读写方式打开

可选的 mode 参数是文件的 Unix 模式，仅在要创建数据库时才会被使用。 其默认值为八进制数 0o666 (并将被当前的 umask 所修改)。

除了与字典类似的方法，ndbm 对象还有以下方法：

ndbm.close()

关闭 ndbm 数据库。

dbm.dumb --- 便携式 DBM 实现

源代码: Lib/dbm/dumb.py [https://github.com/python/cpython/tree/3.10/Lib/dbm/dumb.py]

注解

dbm.dumb 模块的目的是在更健壮的模块不可用时作为 dbm 模块的最终回退项。 dbm.dumb 不是为高速运行而编写的，也不像其他数据库模块一样被经常使用。

dbm.dumb 模块提供了一个完全以 Python 编写的持久化字典类接口。 不同于 dbm.gnu 等其他模块，它不需要外部库。 与其他持久化映射一样，它的键和值也总是被存储为字节串。

该模块定义以下内容：

exception dbm.dumb.error

针对 dbm.dumb 专属错误例如 I/O 错误引发。 KeyError 的引发则针对一般映射例如指定了不正确的键。

dbm.dumb.open(filename[, flag[, mode]])

打开一个 dumbdbm 数据库并返回 dumbdbm 对象。 filename 参数为数据库文件的主名称（不带任何特定扩展名）。 创建一个 dumbdbm 数据库时将创建多个带有 .dat 和 .dir 扩展名的文件。

可选的 flag 参数可以是：

值 | 含意
'r' | 以只读方式打开现有数据库（默认）
'w' | 以读写方式打开现有数据库
'c' | 以读写方式打开数据库，如果不存在则创建它
'n' | 始终创建一个新的空数据库，以读写方式打开

可选的 mode 参数是文件的 Unix 模式，仅在要创建数据库时才会被使用。 其默认值为八进制数 0o666 (并将被当前的 umask 所修改)。

警告

当载入包含足够巨大/复杂条目的数据库时有可能导致 Python 解释器的崩溃，这是由于 Python AST 编译器有栈深度限制。

在 3.5 版更改: open() 在 flag 值为 'n' 时将总是创建一个新的数据库。

在 3.8 版更改: 附带 'r' 旗标打开的数据库现在将是只读的。 附带 'r' 和 'w' 旗标的打开操作不会再创建数据库。

除了 collections.abc.MutableMapping 类所提供的方法，dumbdbm 对象还提供了以下方法：

dumbdbm.sync()

同步磁盘上的目录和数据文件。 此方法会由 Shelve.sync() 方法来调用。

dumbdbm.close()

关闭 dumbdbm 数据库。

sqlite3 --- SQLite 数据库 DB-API 2.0 接口模块

源代码： Lib/sqlite3/ [https://github.com/python/cpython/tree/3.10/Lib/sqlite3/]

SQLite 是一个C语言库，它可以提供一种轻量级的基于磁盘的数据库，这种数据库不需要独立的服务器进程，也允许需要使用一种非标准的 SQL 查询语言来访问它。一些应用程序可以使用 SQLite 作为内部数据存储。可以用它来创建一个应用程序原型，然后再迁移到更大的数据库，比如 PostgreSQL 或 Oracle。

sqlite3 模块由Gerhard Häring编写。它提供了 PEP 249 [https://www.python.org/dev/peps/pep-0249] 所描述的符合 DB-API 2.0 规范的 SQL 接口，并要求使用 SQLite 3.7.15 或更新的版本。

本文档包括了四个主要部分：

教程 将教你如何使用 sqlite3 模块。

参考 描述了该模块定义的类与函数。

常用方案指引 详细介绍了如何处理一些特定的任务。

说明 提供了关于事务控制（transaction control）的更深一步的背景。

参见

https://www.sqlite.org

SQLite的主页；它的文档详细描述了它所支持的 SQL 方言的语法和可用的数据类型。

https://www.w3schools.com/sql/

学习 SQL 语法的教程、参考和例子。

PEP 249 [https://www.python.org/dev/peps/pep-0249] - DB-API 2.0 规范

PEP 由 Marc-André Lemburg 撰写。

教程

在本篇教程中，你将会使用 sqlite3 模块的基本功能创建一个存储 Monty Python 的电影作品信息的数据库。本篇教程假定您在阅读前对于数据库的基本概念有所了解，例如 cursors [https://en.wikipedia.org/wiki/Cursor_(databases)] 与 transactions [https://en.wikipedia.org/wiki/Database_transaction] 。

首先，我们需要创建一个新的数据库并打开一个数据库连接以允许 sqlite3 通过它来动作。 调用 sqlite3.connect() 来创建与当前工作目录下 tutorial.db 数据库的连接，如果它不存在则会隐式地创建它:

import sqlite3
con = sqlite3.connect("tutorial.db")

上面的代码中，返回的 Connection 对象 con 代表一个与在磁盘上的数据库（on-disk databse）的连接。

为了执行 SQL 语句并且从 SQL 查询中取得结果，我们需要使用游标 (cursor) 。在下面的代码中，我们调用函数 con.cursor() 创建了一个游标 (Cursor) ：

cur = con.cursor()

通过上面的操作，我们已经得到了与数据库的连接 (connection) 与游标 (cursor) ，现在我们便可以在数据库中创建一张名为 movie 的表了，它包括电影名 （title，在下方代码中对应“title”）、上映年份（release year，在下方代码中对应“year”）以及电影评分（review score，在下方代码中对应“score”）这三列。在本篇教程中，出于简洁的考虑，我们在创建表的 SQL 语句声明中只列出表头名 (column names) ，而没有像一般的 SQL 语句那样同时声明数据列的对应数据类型 —— 这一点得益于 SQLite 的 flexible typing [https://www.sqlite.org/flextypegood.html] 特性，它使得我们在使用 SQLite 时，指明数据类型这一项工作时可选的。如下面的代码所示，我们通过调用函数 cur.excute(...) 执行创建表格的 CREATE TABLE 语句：

cur.execute("CREATE TABLE movie(title, year, score)")

我们可以通过查询 SQLite 内置的 sqlite_matser 表以验证新表是否已经创建，本例中，此时该表应该已经包括了一条 movie 的表定义（更多内容请参考 The Schema Table [https://www.sqlite.org/schematab.html] ）。下面的代码将通过调用函数 cur.excute(...) 执行查询，把结果赋给 res ，而后调用 res.fetchone() 获取结果行：

>>> res = cur.execute("SELECT name FROM sqlite_master")
>>> res.fetchone()
('movie',)

在上面的代码中，我们可以看到表格已经被创建，因为查询结果返回了一个包含表格名的元组 (tuple) 。倘若我们在 sqlite_master 表中查询一个并不存在的表 spam ，那么 res.fetchone() 将会返回 None ：

>>> res = cur.execute("SELECT name FROM sqlite_master WHERE name='spam'")
>>> res.fetchone() is None
True

现在，让我们再次调用 cur.execute(...) 去添加由 SQL 字面量 (literals) 提供的两行数据：

cur.execute("""
    INSERT INTO movie VALUES
        ('Monty Python and the Holy Grail', 1975, 8.2),
        ('And Now for Something Completely Different', 1971, 7.5)
""")

INSERT 语句将隐式地创建一个事务 (transaction) ，事务需要在将更改保存到数据库前提交（更多细节请参考 事务控制 ）。我们通过在一个连接对象（本例中为 con）上调用 con.commit() 提交事务：

con.commit()

我们可以通过执行一个 SELECT 查询以验证数据是否被正确地插入表中。下面的代码中，我们使用我们已经很熟悉的函数 cur.execute(...) 将查询结果赋给 res ，而后调用 res.fetchall() 返回所有的结果行：

>>> res = cur.execute("SELECT score FROM movie")
>>> res.fetchall()
[(8.2,), (7.5,)]

上面的代码中，结果是一个包含了两个元组 (tuple) 的列表 (list) ，其中每一个元组代表一个数据行，每个数据行都包括该行的 score 值。

现在，让我们调用 cur.executemany(...) 再插入三行数据：

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()  # Remember to commit the transaction after executing INSERT.

请注意，占位符 (placeholders) ? 是用来在查询中绑定数据 data 的。在绑定 Python 的值到 SQL 语句中时，请使用占位符取代格式化字符串 (string formatting ) 以避免 SQL 注入攻击 [https://en.wikipedia.org/wiki/SQL_injection] （更多细节请参见 如何在 SQL 查询中使用占位符来绑定值 ）。

同样的，我们可以通过执行 SELECT 查询验证新的数据行是否已经插入表中，这一次我们将迭代查询的结果：

>>> 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")

如上可见，每一行都是包括 (year,title) 这两个元素的元组 (tuple ) ，它与我们查询中选中的数据列相匹配。

最后，让我们先通过调用 con.close() 关闭现存的与数据库的连接，而后打开一个新的连接、创建一个新的游标、执行一个新的查询以验证我们是否将数据库写入到了本地磁盘上：

>>> 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

现在您已经成功地使用模块 sqlite3 创建了一个 SQLite 数据库，并且学会了以多种方式往其中插入数据与检索值。

参见

阅读 常用方案指引 以获取更多信息：

如何在 SQL 查询中使用占位符来绑定值

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

如何将 SQLite 值转换为自定义 Python 类型

如何使用连接上下文管理器

如何创建并使用行工厂对象

参阅 说明 以获取关于事务控制的更深一步的背景。

参考

模块函数

sqlite3.connect(database, timeout=5.0, detect_types=0, isolation_level='DEFERRED', check_same_thread=True, factory=sqlite3.Connection, cached_statements=100, uri=False)

打开一个与 SQLite 数据库的连接。

参数

database (path-like object) -- 数据库文件所在的路径。传入 ":memory:" 将会打开一个与在计算机内存 (RAM) 中的数据库连接，而不是打开与在本地磁盘 (disk) 上储存的数据库的连接。

timeout (float) -- 当一个表被锁定时连接在最终引发 OperationalError 之前应该等待多少秒。 如果另一个链接开启了一个事务来修改一个表，该表将被锁定直到该事务完成提交。 默认值为五秒。

detect_types (int) -- 控制是否以及如何使用由 register_converter() 注册的转换器将并非由 SQLite 原生支持的 数据类型转换为 Python 类型。 将它设置为 PARSE_DECLTYPES 和 PARSE_COLNAMES 的任意组合 (使用 |，即按位或) 来启动它。 如果两个旗标都被设置则列名将优先于声明的类型。 即使设置了 detect_types，依然无法对生成的字段 (例如 max(data)) 进行类型检测；此时它将改为返回 str。 当使用默认值 (0) 时，类型检测将被禁用。

isolation_level (str | None) -- 该参数代表数据库连接的事务控制级别 (isolation_level)，它将控制数据库事务是否以及如何隐式创建 。 它的可取值为 "DEFERRED" (默认值)，"EXCLUSIVE"，"IMMEDIATE" 或 None (取用该值将禁止事务的隐式创建)。 请参阅 事务控制 以获取更多信息。

check_same_thread (bool) -- 如果为 True (默认)，则 ProgrammingError 将在数据库连接被它的创建者以外的线程使用时被引发。 如果为 False，则连接可以在多个线程中被访问；写入操作需要由用户者进行序列化以避免数据损坏。 请参阅 threadsafety 了解详情。

factory (Connection) -- 如果您不想使用默认的 Connection 类创建连接，那么您可以通过传入一个自定义的 Connection 类的子类给该参数以创建连接。

cached_statements (int) -- sqlite3 应当为该连接进行内部缓存以避免解析开销的语句数量。 在默认情况下为 100 条语句。

uri (bool) -- 如果将该参数的值设置为 True，参数 database 将会被解释为一个由文件路径与可选的查询字符串组成的 URI 链接。链接的前缀协议部分 (schema part) 必需 是 "file:" ，后面的文件路径可以是相对路径或绝对路径。查询字符串允许向 SQLite 传递参数，以实现不同的 如何使用 SQLite URI。

返回类型

Connection

引发一个 审计事件 sqlite3.connect 并附带参数 database。

引发一个 审计事件 sqlite3.connect/handle 并附带参数 connection_handle。

3.4 新版功能: 参数 uri 。

在 3.7 版更改: database 现在可以是一个 path-like object 对象了，而不仅仅是字符串。

3.10 新版功能: 审计事件 sqlite3.connect/handle 。

sqlite3.complete_statement(statement)

如果传入的字符串语句 (statement) 看起来像是包括一条或多条完整的 SQL 语句，那么该函数将返回 True 。请注意，除了检查未封闭的字符串字面 (unclosed string literals) 以及语句是否以分号结束外，它不会执行任何的语法检查 (syntactic verification) 与语法解析 (synatatic parsing) 。

例如:

>>> sqlite3.complete_statement("SELECT foo FROM bar;")
True
>>> sqlite3.complete_statement("SELECT foo")
False

该函数可能在这样的情形下非常有用：在通过命令行 (command-line) 输入数据时，可使用该函数判断输入文本是否可以构成一个完成的 SQL 语句，或者判断在调用函数 execute() 前是否还需要额外的输入。

sqlite3.enable_callback_tracebacks(flag, /)

是否启用回调回溯 (callback tracebacks) 。默认情况下，在 SQLite 中，您不会在用户定义的函数、聚合函数 (aggregates) 、转换函数 (converters) 、验证回调函数 (authorizer callbacks) 等中得到任何回溯信息。如果您想调试它们，您可以在将形式参数 flag 设置为 True 的情况下调用该函数。之后您便可以从 sys.stderr 的回调中得到回溯信息。使用 False 将再次禁用该功能。

sqlite3.register_adapter(type, adapter, /)

注册一个可调用的适配器 (adapter) 以将一个 Python 类型适配为一个 SQLite 类型。适配器应该以一个类型为 type 的 Python 对象作为它的唯一参数传入调用，并且必需返回能被 SQLite 原生支持的类型的一个值 。

sqlite3.register_converter(typename, converter, /)

注册一个可调用的转换器 (converter) ，它能够将 SQLite 对象转换为一个特定类型的 Python 对象。转换器将会对所有类型为 typename 的 SQLite 值进行调用；它会被传递给一个 bytes 对象并且应该返回一个所需的 Python 类型的对象。您可以参考函数 connect() 的形式参数 detect_types 的文档，以了解关于类型检测 (detection works) 是如何工作的详细信息。

注：typename 以及您在查询中使用的类型名是不大小写敏感的。

模块常量

sqlite3.PARSE_COLNAMES

将这个旗标值传递给 connect() 的 detect_types 形参，以使用从查询列名解析的类型名作为转换器字典键来查找转换器函数。类型名称必须用方括号（[]）括起来。

SELECT p as "p [point]" FROM test;  ! will look up converter "point"

此旗标可以使用 | （位或）运算符与 PARSE_DECLTYPES 组合。

sqlite3.PARSE_DECLTYPES

将这个旗标值传递给 connect() 的 detect_types 形参，以使用创建数据库表时为每列声明的类型的查找转换器函数。sqlite3 将使用声明类型的第一个单词作为转换字典键来查找转换函数。例如：

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"
 )

此旗标可以使用 | （位或）运算符与 PARSE_COLNAMES 组合。

sqlite3.SQLITE_OK

sqlite3.SQLITE_DENY

sqlite3.SQLITE_IGNORE

作为传递给函数 Connection.set_authorizer() 的形式参数 authorizer_callback 的回调函数应该返回的标志 (flags) ，以表明是否：

访问被允许（SQLITE_OK）。

SQL语句伴异常的执行失败（SQLITE_DENY）。

该列应被视为NULL（SQLITE_IGNORE）。

sqlite3.apilevel

指明所支持的 DB-API 级别的字符串常量。 根据 DB-API 的需要设置。 硬编码为 "2.0"。

sqlite3.paramstyle

指明 sqlite3 模块所预期的形参标记格式化类型。 根据 DB-API 的需要设置。 硬编码为 "qmark"。

注解

named DB-API 形参风格也受到支持。

sqlite3.sqlite_version

以 字符串 表示的运行时 SQLite 库版本号。

sqlite3.sqlite_version_info

以 整数 tuple 表示的运行时. SQLite 库版本号。

sqlite3.threadsafety

由 DB-API 所需要的整数常量，指明 sqlite3 模块支持的线程安全 (thread safety) 等级。目前硬编码为 1，表示 线程可能会分享模块 (module) ，但不会分享连接 (connections) 。然而，这可能不会总是正确的，即它无法完全确保它所指明的情况总是为真。您可以通过使用以下查询以检查底层的 SQLite 库在编译时的线程模式 (threaded mode) ：

import sqlite3
con = sqlite3.connect(":memory:")
con.execute("""
    select * from pragma_compile_options
    where compile_options like 'THREADSAFE=%'
""").fetchall()

注意 SQLITE_THREADSAFE 级别 [https://sqlite.org/compile.html#threadsafe] 与 DB-API 2.0 threadsafety 级别不一致。

sqlite3.version

此模块 字符串 形式的版本号。 这不是 SQLite 库的版本号。

sqlite3.version_info

此模块 整数 tuple 形式的版本号。 这不是 SQLite 库的版本号。library.

连接对象

class sqlite3.Connection

每个打开的 SQLite 数据库均以 Connection 对象来表示，这种对象是使用 sqlite3.connect() 创建的。 它们的主要目的是创建 Cursor 对象，以及 事务控制。

参见

如何使用连接快捷方法

如何使用连接上下文管理器

SQLite 数据库连接对象有如下的属性和方法：

cursor(factory=Cursor)

创建并返回一个 Cursor 对象。该方法接受一个可选的形式参数 factory 。如果要提供该参数，请确保该参数是一个能够返回从属于 Cursor 类或其子类的实例的可调用参数。

commit()

向数据库提交任何待处理的事务。 如果没有已开启的事务，则此方法不执行任何操作。

rollback()

回滚到任何未决事务 (pending transaction) 的起点处。如果不存在打开的事务，那么该方法便没有作用。

close()

关闭数据库连接。任何未决事务 (pending transaction) 都不会被隐式提交，即所有未提交的事务都会丢失。请确保您在关闭数据库连接前调用方法 commit() ，以避免丢失任何挂起 (pending) 的更改。

execute(sql, parameters=(), /)

创建一个新的 Cursor 对象，并在其上使用给出的 sql 和 parameters 调用 execute()。 返回新的游标对象。

executemany(sql, parameters, /)

创建一个新的 Cursor 对象，并在其上使用给出的 sql 和 parameters 调用 executemany()。 返回新的游标对象。

executescript(sql_script, /)

创建一个新的 Cursor 对象，并在其上使用给出的 sql_script 调用 executescript()。 返回新的游标对象。

create_function(name, narg, func, *, deterministic=False)

创建或移除用户定义的 SQL 函数。

参数

name (str) -- SQL 函数的名称。

narg (int) -- SQL 函数可接受的参数数量，如果是 -1，则该函数可以接受任意数量的参数。

func (callback | None) -- 当 SQL 函数被调用时，所唤起的一个可调用对象 (callable) 。该可调用对象应该返回 一个 SQLite 原生支持的类型 。如果将它设置为 None ，那么将会移除一个现存的 SQL 函数。

deterministic (bool) -- 如为 True，创建的 SQL 函数将被标记为 deterministic [https://sqlite.org/deterministic.html]，这允许 SQLite 执行额外的优化。

引发

NotSupportedError -- 如果 deterministic 在早于 SQLite 3.8.3 的版本上使用。

3.8 新版功能: deterministic 形参。

示例:

>>> 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',)

create_aggregate(name, /, n_arg, aggregate_class)

创建或移除用户自定义的 SQL 聚合函数。

参数

name (str) -- SQL 聚合函数的名称。

n_arg (int) -- SQL 聚合函数可接受的参数数量。 如为 -1，则可以接受任意数量的参数。

aggregate_class (class | None) -- 一个类必须实现下列方法: * step(): 向聚合添加一行。 * finalize(): 将聚合的最终结果作为 一个 SQLite 原生支持的类型 返回。 step() 方法需要接受的参数数量是由 n_arg 控制的。 设为 None 将移除现有的 SQL 聚合函数。

示例:

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()

create_collation(name, callable)

使用排序函数 callable 创建一个名为 name 的排序规则。 callable 被传递给两个 字符串 参数，并且它应该返回一个 整数。

如果前者的排序高于后者则为 1

如果前者的排序低于于后者则为 -1

如果它们的顺序相同则为 0

下面的例子显示了一个反向排序的排序方法:

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()

通过将 callable 设为 None 来移除一个排序规则函数。

interrupt()

从其他的线程调用此方法以中止可能正在连接上执行的任何查询。 被中止的查询将引发 OperationalError。

set_authorizer(authorizer_callback)

注册可调用的 authorizer_callback 回调函数，它将在每次试图访问数据库中的表的某一列被调用。回调函数应该返回常量 SQLITE_OK、SQLITE_DENY、SQLITE_IGNORE 中的任意一个，以表明对该列的访问应该由底层 SQLite 库进行怎样的处理。

该回调的第一个参数指明哪种操作将被授权。 第二个和第三个参数根据第一个参数的具体值将为传给操作的参数或为 None。 第四个参数如果适用则为数据库名称（"main", "temp" 等）。 第五个参数是负责尝试访问的最内层触发器或视图的名称或者如果该尝试访问是直接来自输入的 SQL 代码的话则为 None。

请参阅 SQLite 文档了解第一个参数可能的值以及依赖于第一个参数的第二个和第三个参数的含义。 所有必需的常量均在 sqlite3 模块中可用。

set_progress_handler(progress_handler, n)

注册可调用的 progress_handler 函数，它将在 SQLite 虚拟机 (SQLite virtual machine) 的每 n 条指令中被调用。如果您向在长期运行的操作中得到 SQLite 的调用，例如更新GUI，那么这个函数将非常有用。

如果你想清除任何先前安装的进度处理器，可在调用该方法时传入 None 作为 progress_handler。

从处理函数返回非零值将终止当前正在执行的查询并导致它引发 OperationalError 异常。

set_trace_callback(trace_callback)

注册可调用的 trace_callback 追踪回调函数，它将在 SQLite后端 (SQLite backend) 执行每一条 SQL 语句时被调用。

传给该回调的唯一参数是被执行的语句 (作为 str)。 回调的返回值将被忽略。 请注意后端不仅会运行传给 Cursor.execute() 方法的语句。 其他来源还包括 sqlite3 模块的 事务管理 以及在当前数据库中定义的触发器的执行。

传入 None 作为 trace_callback 将禁用追踪回调。

注解

在跟踪回调中产生的异常不会被传播。作为开发和调试的辅助手段，使用 enable_callback_tracebacks() 来启用打印跟踪回调中产生的异常的回调。

3.3 新版功能.

enable_load_extension(enabled, /)

如果 enabled 为 True 则允许 SQLite 从共享库加载 SQLite 扩展；否则，不允许加载 SQLite 扩展。 SQLite 扩展可以定义新的函数、聚合或全新的虚拟表实现。 一个知名的扩展是与随同 SQLite 一起分发的全文搜索扩展。

注解

在默认情况下 sqlite3 模块的构建没有附带可加载扩展支持，因为某些平台（主要是 macOS）上的 SQLite 库在编译时未启用此特性。 要获得可加载扩展支持，你必须将 --enable-loadable-sqlite-extensions 选项传给 configure。

引发一个 审计事件 sqlite3.enable_load_extension 并附带参数 connection, enabled。

3.2 新版功能.

在 3.10 版更改: 增加了 sqlite3.enable_load_extension 审计事件。

con.enable_load_extension(True)

# Load the fulltext search extension
con.execute("select load_extension('./fts3.so')")

# alternatively you can load the extension using an API call:
# con.load_extension("./fts3.so")

# disable extension loading again
con.enable_load_extension(False)

# example from 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)

con.close()

load_extension(path, /)

从指定路径 path 的共享库中加载一个 SQLite 扩展。请您在调用该方法前，确保您已经使用 enable_load_extension() 方法启用了拓展的加载。

引发一个 审计事件 sqlite3.load_extension 并附带参数 connection, path。

3.2 新版功能.

在 3.10 版更改: 增加了 sqlite3.load_extension 审计事件。

iterdump()

返回一个 iterator 用来将数据库转储为 SQL 源代码。 在保存内存数据库以便将来恢复时很有用处。 类似于 sqlite3 shell 中的 .dump 命令。

示例:

# Convert file example.db to SQL dump file 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()

backup(target, *, pages=- 1, progress=None, name='main', sleep=0.250)

创建 SQLite 数据库的备份。

即使数据库是通过其他客户端访问或通过同一连接并发访问也是有效的。

参数

target (Connection) -- 用于保存备份的数据库连接。

pages (int) -- 每次要拷贝的页数。 如果小于等于 0，则一次性拷贝整个数据库。 默认为 -1。

progress (callback | None) -- 如果将它设置为一个可调用的回调函数 (callable) ，那么它会在每次备份迭代 (backup iteration) 时被调用，并且带有以下三个整数参数：最近一次迭代的的状态（形式参数 status），需要复制的剩余页数（形式参数 remaining）以及总页数（形式参数 total）。默认值为 None。

name (str) -- 要备份的数据库名称。 可能为代表主数据库的 "main" (默认值)，代表临时数据库的 "temp"，或者使用 ATTACH DATABASE SQL 语句所附加的自定义数据库名称。

sleep (float) -- 连续尝试备份剩余页所要间隔的休眠秒数。

示例 1，将现有数据库拷贝至另一个数据库:

def progress(status, remaining, total):
    print(f'Copied {total-remaining} of {total} pages...')

src = sqlite3.connect('example.db')
dst = sqlite3.connect('backup.db')
with dst:
    src.backup(dst, pages=1, progress=progress)
dst.close()
src.close()

示例 2，将现有数据库拷贝至一个临时副本:

src = sqlite3.connect('example.db')
dst = sqlite3.connect(':memory:')
src.backup(dst)

3.7 新版功能.

in_transaction

这个只读属性对应于低层级的 SQLite autocommit mode [https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions]。

如果一个事务处于活动状态（有未提交的更改）则为 True，否则为 False。

3.2 新版功能.

isolation_level

该属性控制由 sqlite3 模块执行的 事务处理 。如果将该属性设置为 None ，那么事务将永远不会被隐式地打开。如果将它设置为 "DEFERRED" 、 "IMMEDIATE" 、 "EXCLUSIVE" 中的任意一个，那么 事务管理 (transaction management) 将会隐式地根据其对应的 SQLite transaction behaviour [https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions] 执行。

如果未被 connect() 的 isolation_level 形参覆盖，则默认为 ""，这是 "DEFERRED" 的一个别名。

row_factory

针对从该连接创建的 Cursor 对象的初始 row_factory。 为该属性赋值不会影响属于该连接的现有游标的 row_factory，只影响新的游标。 默认为 None，表示将每一行作为 tuple 返回。

详情参见 如何创建并使用行工厂对象。

text_factory

一个可调用对象 (callable) ，它接受一个 bytes 作为形式参数并且返回该参数的文本表示。该调用对象将为数据类型为 TEXT 的 SQLite 值调用。默认情况下，该属性将被设置为 str ，这意味着它总是返回一个字符串。如果您想返回 bytes ，请将*text_factory*设置为`bytes`。

示例:

con = sqlite3.connect(":memory:")
cur = con.cursor()

AUSTRIA = "Österreich"

# by default, rows are returned as str
cur.execute("SELECT ?", (AUSTRIA,))
row = cur.fetchone()
assert row[0] == AUSTRIA

# but we can make sqlite3 always return bytestrings ...
con.text_factory = bytes
cur.execute("SELECT ?", (AUSTRIA,))
row = cur.fetchone()
assert type(row[0]) is bytes
# the bytestrings will be encoded in UTF-8, unless you stored garbage in the
# database ...
assert row[0] == AUSTRIA.encode("utf-8")

# we can also implement a custom text_factory ...
# here we implement one that appends "foo" to all strings
con.text_factory = lambda x: x.decode("utf-8") + "foo"
cur.execute("SELECT ?", ("bar",))
row = cur.fetchone()
assert row[0] == "barfoo"

con.close()

total_changes

返回自打开数据库连接以来已修改、插入或删除的数据库行的总数。

游标对象

一个代表被用于执行 SQL 语句，并管理获取操作的上下文的 database cursor [https://en.wikipedia.org/wiki/Cursor_(databases)] 的 Cursor 对象。 游标对象是使用 Connection.cursor()，或是通过使用任何 连接快捷方法 来创建的。

Cursor 对象属于 迭代器，这意味着如果你通过 execute() 来执行 SELECT 查询，你可以简单地迭代游标来获取结果行:

for row in cur.execute("SELECT t FROM data"):
    print(row)

class sqlite3.Cursor

Cursor 游标实例具有以下属性和方法。

execute(sql, parameters=(), /)

执行一条 SQL 语句，可以选择使用 占位符 来绑定 Python 值。

参数

sql (str) -- 一条 SQL 语句。

parameters (dict | sequence) -- 要绑定到 sql 中占位符的 Python 值。 如果使用命名占位符则会使用 dict。 如果使用非命名占位符则会使用 sequence。 参见 如何在 SQL 查询中使用占位符来绑定值。

引发

Warning -- 如果 sql 包含多条 SQL 语句。

如果属性 isolation_level 的值不是 None，并且*sql* 是一个 INSERT、UPDATE、 DELETE、 或 REPLACE 语句，并且现在没有打开的事务 (transaction) ，那么在执行 sql 语句前将会隐式打开一个事务。

使用 executescript() 来执行多条 SQL 语句。statements.

executemany(sql, parameters, /)

对于在 parameters 中的每一项，重复执行已经 参数化 了的 SQL 语句 sql。

使用与 execute() 相同的隐式事务处理。

参数

sql (str) -- 一条 SQL DML 语句。

parameters (iterable) -- 一个用来绑定到 sql 中的占位符的形参的 iterable。 参见 如何在 SQL 查询中使用占位符来绑定值。

引发

ProgrammingError -- 如果 sql 不是一条 DML 语句。

Warning -- 如果 sql 包含多条 SQL 语句。

示例:

rows = [
    ("row1",),
    ("row2",),
]
# cur is an sqlite3.Cursor object
cur.executemany("INSERT INTO data VALUES(?)", rows)

executescript(sql_script, /)

执行形式参数 sql_script 中的 SQL 语句。如果在执行时仍有一个未决事务 (pending transaction) ，那么首先会隐式地执行一个 COMMIT 语句。请注意，除此之外，它不会执行任何隐式的事务控制；因此，任何关于事务控制的内容都应添加到 sql_script 中。

sql_script 必须为 字符串。

示例:

# cur is an sqlite3.Cursor object
cur.executescript("""
    BEGIN;
    CREATE TABLE person(firstname, lastname, age);
    CREATE TABLE book(title, author, published);
    CREATE TABLE publisher(name, address);
    COMMIT;
""")

fetchone()

如果 row_factory 为 None，则将下一行查询结果集作为 tuple 返回。 否则，将其传给指定的行工厂函数并返回函数结果。 如果没有更多可用数据则返回 None。

fetchmany(size=cursor.arraysize)

将下一个多行查询结果集作为 list 返回。 如果没有更多可用行时则返回一个空列表。

每次调用要获取的行数是由 size 形参指定的。 如果未指定 size，则由 arraysize 确定要获取的行数。 如果可用的行少于 size，则返回可用的行数。

请注意 size 形参会涉及到性能方面的考虑。为了获得优化的性能，通常最好是使用 arraysize 属性。 如果使用 size 形参，则最好在从一个 fetchmany() 调用到下一个调用之间保持相同的值。

fetchall()

将全部（剩余的）查询结果行作为 list 返回。 如果没有可用的行则返回空列表。 请注意 arraysize 属性可能会影响此操作的性能。

close()

立即关闭 cursor（而不是在当 __del__ 被调用的时候）。

从这一时刻起该 cursor 将不再可用，如果再尝试用该 cursor 执行任何操作将引发 ProgrammingError 异常。

setinputsizes(sizes, /)

DB-API 要求的方法。 在 sqlite3 不做任何事情。

setoutputsize(size, column=None, /)

DB-API 要求的方法。 在 sqlite3 不做任何事情。

arraysize

用于控制 fetchmany() 返回行数的可读取/写入属性。 该属性的默认值为 1，表示每次调用将获取单独一行。

connection

提供属于该游标的 SQLite Connection 的只读属性。 通过调用 con.cursor() 创建的 Cursor 对象将具有一个指向 con 的 connection 属性:

>>> con = sqlite3.connect(":memory:")
>>> cur = con.cursor()
>>> cur.connection == con
True

description

提供上一次查询的列名称的只读属性。 为了与 Python DB API 保持兼容，它会为每个列返回一个 7 元组，每个元组的最后六个条目均为 None。

对于没有任何匹配行的 SELECT 语句同样会设置该属性。

lastrowid

提供上一次插入的行的行 ID 的只读属性。 它只会在使用 execute() 方法的 INSERT 或 REPLACE 语句成功后被更新。 对于其他语句，则在 executemany() 或 executescript()，或者如果插入失败，lastrowid 的值将保持不变。 lastrowid 的初始值为 None。

注解

对 WITHOUT ROWID 表的插入不被记录。

在 3.6 版更改: 增加了 REPLACE 语句的支持。

rowcount

这是一个只读属性。对于语句 INSERT、DELETE、REPLACE ，它将提供这些语句所修改的行数；对于其他语句，包括 CTE 查询，它的值将会是 -1。它的值只会在执行方法 execute() 与方法 executemany() 时发生更新。

row_factory

控制从该 Cursor 获取的行的表示形式。 如为 None，一行将表示为一个 tuple。可设置形式包括 sqlite3.Row；或者接受两个参数的 callable，一个 Cursor 对象和由行内所有值组成的 tuple，以及返回代表一个 SQLite 行的自定义对象。

默认为当 Cursor 被创建时设置的 Connection.row_factory。 对该属性赋值不会影响父连接的 Connection.row_factory。

详情参见 如何创建并使用行工厂对象。

Row 对象

class sqlite3.Row

一个被用作 Connection 对象的高度优化的 row_factory 的 Row 实例。 它支持迭代、相等性检测、len() 以及基于列名称的 mapping 访问和数字序列。

两个 Row 对象如果具有相同的列名称和值则比较结果相等。

详情参见 如何创建并使用行工厂对象。

keys()

在一次查询之后，立即将由列名称组成的 list 作为 字符串 返回，它是 Cursor.description 中每个元组的第一个成员。

在 3.5 版更改: 添加了对切片操作的支持。

PrepareProtocol 对象

class sqlite3.PrepareProtocol

PrepareProtocol 类型的唯一目的是作为 PEP 246 [https://www.python.org/dev/peps/pep-0246] 风格的适配协议让对象能够 将自身适配 为 原生 SQLite 类型。

异常

异常层次是由 DB-API 2.0 (PEP 249 [https://www.python.org/dev/peps/pep-0249]) 定义的。

exception sqlite3.Warning

当 SQL 查询不是一个 字符串 或多个语句被传递给了方法 execute() 或方法 executemany() 时由模块 sqlite3 引发的异常。Warning 是 Exception 的子类。

exception sqlite3.Error

本模块中其他异常的基类。使用它来捕捉所有的错误，只需一条 except 语句。 Error 是 Exception 的子类。

exception sqlite3.InterfaceError

当跨越回滚 (rollback) 获取数据或模块 sqlite3 无法绑定参数时引发的异常。InterfaceError 是 Error 的子类。

exception sqlite3.DatabaseError

对与数据库有关的错误引发的异常。它作为几种数据库错误的基础异常。它只通过专门的子类隐式引发。 DatabaseError 是 Error 的一个子类。

exception sqlite3.DataError

由于处理的数据有问题而产生的异常，比如数字值超出范围，字符串太长。 DataError 是 DatabaseError 的子类。

exception sqlite3.OperationalError

与数据库操作有关的错误而引发的异常，不一定在程序员的控制之下。例如，数据库路径没有找到，或者一个事务无法被处理。 OperationalError 是 DatabaseError 的子类。

exception sqlite3.IntegrityError

当数据库的关系一致性受到影响时引发的异常。 例如外键检查失败等。 它是 DatabaseError 的子类。

exception sqlite3.InternalError

当 SQLite 遇到一个内部错误时引发的异常。如果它被引发，可能表明运行中的 SQLite 库有问题。 InternalError 是 DatabaseError 的子类。

exception sqlite3.ProgrammingError

由 sqlite3 API 编程错误引发的异常。例如，您尝试对一个已经关闭的 Connection 对象进行操作，或试图通过方法 executemany() 执行非DML语句 (non-DML statements) ，这些行为都会引发该异常。ProgrammingError 是 DatabaseError 的子类。

exception sqlite3.NotSupportedError

在下层的 SQLite 库不支持某个方法或数据库 API 的情况下引发的异常。 例如，在 create_function() 中把 deterministic 设为 True，而下层的 SQLite 库不支持确定性函数的时候。 NotSupportedError 是 DatabaseError 的一个子类。

SQLite 与 Python 类型

SQLite 原生支持如下的类型： NULL，INTEGER，REAL，TEXT，BLOB。

因此可以将以下Python类型发送到SQLite而不会出现任何问题：

Python 类型 | SQLite 类型
None | NULL
int | INTEGER
float | REAL
str | TEXT
bytes | BLOB

这是SQLite类型默认转换为Python类型的方式：

SQLite 类型 | Python 类型
NULL | None
INTEGER | int
REAL | float
TEXT | 取决于 text_factory , 默认为 str
BLOB | bytes

sqlite3 模块的类型系统可通过两种方式来扩展：你可以通过 对象适配器 将额外的 Python 类型保存在 SQLite 数据库中，你也可以让 sqlite3 模块通过 转换器 将 SQLite 类型转换为不同的 Python 类型。types via.

默认适配器和转换器

对于 datetime 模块中的 date 和 datetime 类型已提供了默认的适配器。 它们将会以 ISO 日期/ISO 时间戳的形式发给 SQLite。

默认转换器使用的注册名称是针对 datetime.date 的 "date" 和针对 datetime.datetime 的 "timestamp"。

通过这种方式，你可以在大多数情况下使用 Python 的 date/timestamp 对象而无须任何额外处理。 适配器的格式还与实验性的 SQLite date/time 函数兼容。

下面的示例演示了这一点。

import sqlite3
import datetime

con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES|sqlite3.PARSE_COLNAMES)
cur = con.cursor()
cur.execute("create table test(d date, ts timestamp)")

today = datetime.date.today()
now = datetime.datetime.now()

cur.execute("insert into test(d, ts) values (?, ?)", (today, now))
cur.execute("select d, ts from test")
row = cur.fetchone()
print(today, "=>", row[0], type(row[0]))
print(now, "=>", row[1], type(row[1]))

cur.execute('select current_date as "d [date]", current_timestamp as "ts [timestamp]"')
row = cur.fetchone()
print("current_date", row[0], type(row[0]))
print("current_timestamp", row[1], type(row[1]))

con.close()

如果存储在 SQLite 中的时间戳的小数位多于 6 个数字，则时间戳转换器会将该值截断至微秒精度。

注解

默认的 "时间戳" 转换器忽略了数据库中的 UTC 偏移，总是返回一个原生的 datetime.datetime 对象。要在时间戳中保留 UTC 偏移，可以不使用转换器，或者用 register_converter() 注册一个偏移感知的转换器。

常用方案指引

如何在 SQL 查询中使用占位符来绑定值

SQL 操作通常会需要使用来自 Python 变量的值。 不过，请谨慎使用 Python 的字符串操作来拼装查询，因为这样易受 SQL injection attacks [https://en.wikipedia.org/wiki/SQL_injection]。 例如，攻击者可以简单地添加结束单引号并注入 OR TRUE 来选择所有的行:

>>> # Never do this -- insecure!
>>> symbol = input()
' OR TRUE; --
>>> sql = "SELECT * FROM stocks WHERE symbol = '%s'" % symbol
>>> print(sql)
SELECT * FROM stocks WHERE symbol = '' OR TRUE; --'
>>> cur.execute(sql)

请改用 DB-API 的形参替换。 要将变量插入到查询字符串中，可在字符串中使用占位符，并通过将实际值作为游标的 execute() 方法的第二个参数以由多个值组成的 tuple 形式提供给查询来替换它们。

一条SQL语句可能使用这两种占位符中的一种：? 标记（或称问号标记风格 qmark style）或具名占位符（或称具名风格 named style）。对于问号标记风格，parameters 必须是一个长度与 ? 标记 的数量匹配的序列 (sequence)，否则将会抛出 ProgrammingError 错误。 对于具名风格，parameters 必须是一个 dict 或是其子类的实例，同时该实例必须包括所有具名占位符所对应的键。 其中，该实例中不为具名占位符所对应的键将会被忽略。这里是上述两种风格的示例：

con = sqlite3.connect(":memory:")
cur = con.execute("CREATE TABLE lang(name, first_appeared)")

# This is the named style used with 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)

# This is the qmark style used in a SELECT query:
params = (1972,)
cur.execute("SELECT * FROM lang WHERE first_appeared = ?", params)
print(cur.fetchall())

注解

PEP 249 [https://www.python.org/dev/peps/pep-0249] 数字占位符已经 不再 被支持。 如果使用，它们将被解读为命名占位符。

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

SQLite 仅支持一个原生数据类型的有限集。 要在 SQLite 数据库中存储自定义 Python 类型，请将它们 适配 到 SQLite 原生可识别的 Python 类型 之一。

有两种方式可将 Python 对象适配到 SQLite 类型：让你的对象自行适配，或是使用 适配器可调用对象。 后者将优先于前者发挥作用。 对于导出自定义类型的库，启用该类型的自行适配可能更为合理。 而作为一名应用程序开发者，通过注册自定义适配器函数进行直接控制可能更为合理。

如何编写可适配对象

假设我们有一个代表笛卡尔坐标系中的坐标值对 Point，x 和 y 的类，该坐标值在数据库中将存储为一个文本字符串。 这可以通过添加一个返回已适配值的 __conform__(self, protocol) 方法来实现。 传给 protocol 的对象将为 PrepareProtocol 类型。

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])

如何注册适配器可调用对象

另一种可能的方式是创建一个将 Python 对象转换为 SQLite 兼容类型的函数。 随后可使用 register_adapter() 来注册该函数。

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])

如何将 SQLite 值转换为自定义 Python 类型

编写适配器使你可以将 from 自定义 Python 类型转换为 to SQLite 值。 为了能将 from SQLite 值转换为 to 自定义 Python 类型，我们可使用 converters。

让我们回到 Point 类。 我们以以分号分隔的字符串形式在 SQLite 中存储了 x 和 y 坐标值。

首先，我们将定义一个转换器函数，它接受这样的字符串作为形参并根据该参数构造一个 Point 对象。

注解

转换器函数 总是 接受传入一个 bytes 对象，无论下层的 SQLite 数据类型是什么。

def convert_point(s):
    x, y = map(float, s.split(b";"))
    return Point(x, y)

我们现在需要告诉 sqlite3 何时应当转换一个给定的 SQLite 值。 这是在连接到一个数据库时完成的，使用 connect() 的 detect_types 形参。 有三个选项:

隐式: 将 detect_types 设为 PARSE_DECLTYPES

显式: 将 detect_types 设为 PARSE_COLNAMES

同时: 将 detect_types 设为 sqlite3.PARSE_DECLTYPES | sqlite3.PARSE_COLNAMES。 列名的优先级高于声明的类型。

下面的示例演示了隐式和显式的方法:

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)

# Register the adapter and converter
sqlite3.register_adapter(Point, adapt_point)
sqlite3.register_converter("point", convert_point)

# 1) Parse using declared types
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) Parse using column names
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])

适配器和转换器范例程序

本小节显示了通用适配器和转换器的范例程序。

import datetime
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.isoformat()

def adapt_datetime_epoch(val):
    """Adapt datetime.datetime to Unix timestamp."""
    return int(val.timestamp())

sqlite3.register_adapter(datetime.date, adapt_date_iso)
sqlite3.register_adapter(datetime.datetime, adapt_datetime_iso)
sqlite3.register_adapter(datetime.datetime, adapt_datetime_epoch)

def convert_date(val):
    """Convert ISO 8601 date to datetime.date object."""
    return datetime.date.fromisoformat(val.decode())

def convert_datetime(val):
    """Convert ISO 8601 datetime to datetime.datetime object."""
    return datetime.datetime.fromisoformat(val.decode())

def convert_timestamp(val):
    """Convert Unix epoch timestamp to datetime.datetime object."""
    return datetime.datetime.fromtimestamp(int(val))

sqlite3.register_converter("date", convert_date)
sqlite3.register_converter("datetime", convert_datetime)
sqlite3.register_converter("timestamp", convert_timestamp)

如何使用连接快捷方法

通过使用 Connection 类的 execute(), executemany() 与 executescript() 方法，您可以简化您的代码，因为无需再显式创建 （通常是多余的） Cursor 对象。此时 Cursor 对象会被隐式创建并且由这些快捷方法返回。这样一来，您仅需在 Connection 对象上调用一次方法就可以执行 SELECT 语句，并对其进行迭代。

# Create and fill the table.
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)

# Print the table contents
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() is not a shortcut method and it's not called automatically;
# the connection object should be closed manually
con.close()

如何使用连接上下文管理器

一个 Connection 对象可以像一个上下文管理器 (context manager) 那般被使用，在这种情况下当离开上下文管理器的主体时，将会自动提交或回滚打开的事务。如果 with 语句的主体在没有异常的情况下完成，那么事务便会被提交；如果提交失败，或者 with 语句的主体引发了一个未被捕获异常，那么事务将会回滚。

如果在离开 with 语句的主体时没有打开的事务，那么上下文管理器是无用的。

注解

此上下文管理器不会隐式地开启新事务也不会关闭连接。

con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE lang(id INTEGER PRIMARY KEY, name VARCHAR UNIQUE)")

# Successful, con.commit() is called automatically afterwards
with con:
    con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))

# con.rollback() is called after the with block finishes with an exception,
# the exception is still raised and must be caught
try:
    with con:
        con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))
except sqlite3.IntegrityError:
    print("couldn't add Python twice")

# Connection object used as context manager only commits or rollbacks transactions,
# so the connection object should be closed manually
con.close()

如何使用 SQLite URI

一些有用的 URI 技巧包括:

以只读模式打开一个数据库:

>>> 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

如果一个数据库尚不存在则不会隐式地新建数据库；如果无法新建数据库则将引发 OperationalError:

>>> con = sqlite3.connect("file:nosuchdb.db?mode=rw", uri=True)
Traceback (most recent call last):
OperationalError: unable to open database file

创建一个名为 shared 的内存数据库:

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,)

关于此特性的更多信息，包括可用的形参列表，可以在 SQLite URI documentation [https://www.sqlite.org/uri.html] 中找到。

如何创建并使用行工厂对象

在默认情况下，sqlite3 会以 tuple 来表示每一行。 如果 tuple 不适合你的需求，你可以使用 sqlite3.Row 类或自定义的 row_factory。

虽然 row_factory 同时作为 Cursor 和 Connection 的属性存在，但推荐设置 Connection.row_factory，这样在该连接上创建的所有游标都将使用同一个行工厂对象。

Row 提供了针对列的序列方式和大小写不敏感的名称方式访问，具有优于 tuple 的最小化内存开销和性能影响。 要使用 Row 作为行工厂对象，请将其赋值给 row_factory 属性:

>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = sqlite3.Row

现在查询将返回 Row 对象:

>>> res = con.execute("SELECT 'Earth' AS name, 6378 AS radius")
>>> row = res.fetchone()
>>> row.keys()
['name', 'radius']
>>> row[0]         # Access by index.
'Earth'
>>> row["name"]    # Access by name.
'Earth'
>>> row["RADIUS"]  # Column names are case-insensitive.
6378

你可以创建自定义 row_factory 用来返回 dict 形式的行，将列名映射到相应的值。

def dict_factory(cursor, row):
    fields = [column[0] for column in cursor.description]
    return {key: value for key, value in zip(fields, row)}

使用它，现在查询将返回 dict 而不是 tuple:

>>> 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}

以下行工厂函数将返回一个 named tuple:

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)

namedtuple_factory() 可以像下面这样使用:

>>> 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]  # Indexed access.
1
>>> row.b   # Attribute access.
2

经过一些调整，上面的范例程序可以被适配为使用 dataclass，或任何其他自定义类，而不是 namedtuple。

说明

事务控制

sqlite3 模块并不遵守 PEP 249 [https://www.python.org/dev/peps/pep-0249] 所推荐的事务控制规范。

如果连接的属性 isolation_level 不为 None，新的事务会在 execute() 和 executemany() 执行 INSERT, UPDATE, DELETE 或 REPLACE 语句之前隐式地开启；对于其他语句，则不会执行隐式的事务处理。 可分别使用 commit() 和 rollback() 方法提交和回滚未应用的事务。 你可以通过 isolation_level 属性来选择下层的 SQLite transaction behaviour [https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions] — 也就是说，sqlite3 是否要隐式地执行以及执行何种类型的 BEGIN 语句

如果 isolation_level 被设为 None，则完全不会隐式地开启任何事务。 这将使下层 SQLite 库处于 自动提交模式 [https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions]，但也允许用户使用显式 SQL 语句执行他们自己的事务处理。 下层 SQLite 库的自动提交模式可使用 in_transaction 属性来查询。

executescript() 方法会在执行给定的 SQL 脚本之前隐式地提交任何挂起的事务，无论 isolation_level 的值是什么。

在 3.6 版更改: 在以前 sqlite3 会在 DDL 语句之前隐式地提交已开启的事务。 现存则不会再这样做。

数据压缩和存档

本章中描述的模块支持 zlib、gzip、bzip2 和 lzma 数据压缩算法，以及创建 ZIP 和 tar 格式的归档文件。参见由 shutil 模块提供的 归档操作 。

zlib --- 与 gzip 兼容的压缩

gzip --- 对 gzip 格式的支持

用法示例

命令行界面

命令行选项

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

文件压缩和解压

增量压缩和解压

一次性压缩或解压缩

用法示例

lzma --- 用 LZMA 算法压缩

读写压缩文件

在内存中压缩和解压缩数据

杂项

指定自定义的过滤器链

例子

zipfile --- 使用ZIP存档

ZipFile 对象

Path 对象

PyZipFile 对象

ZipInfo 对象

命令行接口

命令行选项

解压缩的障碍

由于文件本身

文件系统限制

资源限制

中断

提取的默认行为

tarfile --- 读写tar归档文件

TarFile 对象

TarInfo 对象

解压缩过滤器

默认的命名过滤器

过滤器错误

进一步核验的提示

支持较早的 Python 版本

有状态的提取过滤器示例

命令行接口

命令行选项

例子

受支持的 tar 格式

Unicode 问题

zlib --- 与 gzip 兼容的压缩

对于需要数据压缩的应用，此模块中的函数允许使用 zlib 库进行压缩和解压缩。 zlib 库的项目主页是 https://www.zlib.net。 已知此 Python 模块与 1.1.3 之前版本的 zlib 库存在不兼容；1.1.3 版则存在一个 安全缺陷 [https://zlib.net/zlib_faq.html#faq33]，因此我们推荐使用 1.1.4 或更新的版本。

zlib 的函数有很多选项，一般需要按特定顺序使用。本文档没有覆盖全部的用法。更多详细信息请于 http://www.zlib.net/manual.html 参阅官方手册。

要读写 .gz 格式的文件，请参考 gzip 模块。

此模块中可用的异常和函数如下：

exception zlib.error

在压缩或解压缩过程中发生错误时的异常。

zlib.adler32(data[, value])

计算 data 的 Adler-32 校验值。(Adler-32 校验的可靠性与 CRC32 基本相当，但比计算 CRC32 更高效。) 计算的结果是一个 32 位的整数。参数 value 是校验时的起始值，其默认值为 1。借助参数 value 可为分段的输入计算校验值。此算法没有加密强度，不应用于身份验证和数字签名。此算法的目的仅为验证数据的正确性，不适合作为通用散列算法。

在 3.0 版更改: 结果值将始终为无符号类型。 要在使用 Python 2 或更早版本时生成同样的数值，请使用 adler32(data) & 0xffffffff。

zlib.compress(data, /, level=- 1)

压缩 data 中的字节，返回含有已压缩内容的 bytes 对象。参数 level 为整数，可取值为 0 到 9 或 -1，用于指定压缩等级。1 (Z_BEST_SPEED) 表示最快速度和最低压缩率，9 (Z_BEST_COMPRESSION) 表示最慢速度和最高压缩率。0 (Z_NO_COMPRESSION) 表示不压缩。参数默认值为 -1 (Z_DEFAULT_COMPRESSION)。Z_DEFAULT_COMPRESSION 是速度和压缩率之间的平衡 (一般相当于设压缩等级为 6)。函数发生错误时抛出 error 异常。

在 3.6 版更改: 现在，level 可作为关键字参数。

zlib.compressobj(level=-1, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])

返回一个 压缩对象，用来压缩内存中难以容下的数据流。

参数 level 为压缩等级，是整数，可取值为 0 到 9 或 -1。1 (Z_BEST_SPEED) 表示最快速度和最低压缩率，9 (Z_BEST_COMPRESSION) 表示最慢速度和最高压缩率。0 (Z_NO_COMPRESSION) 表示不压缩。参数默认值为 -1 (Z_DEFAULT_COMPRESSION)。Z_DEFAULT_COMPRESSION 是速度和压缩率之间的平衡 (一般相当于设压缩等级为 6)。

method 表示压缩算法。现在只支持 DEFLATED 这个算法。

参数 wbits 指定压缩数据时所使用的历史缓冲区的大小 (窗口大小)，并指定压缩输出是否包含头部或尾部。参数的默认值是 15 (MAX_WBITS)。参数的值分为几个范围：

+9 至 +15：窗口大小以二为底的对数。 即这些值对应着 512 至 32768 的窗口大小。 更大的值会提供更好的压缩，同时内存开销也会更大。 压缩输出会包含 zlib 特定格式的头部和尾部。

−9 至 −15：绝对值为窗口大小以二为底的对数。 压缩输出仅包含压缩数据，没有头部和尾部。

+25 至 +31 = 16 + (9 至 15)：后 4 个比特位为窗口大小以二为底的对数。 压缩输出包含一个基本的 gzip 头部，并以校验和为尾部。

参数 memLevel 指定内部压缩操作时所占用内存大小。参数取 1 到 9。更大的值占用更多的内存，同时速度也更快输出也更小。

参数 strategy 用于调节压缩算法。可取值为 Z_DEFAULT_STRATEGY、Z_FILTERED、Z_HUFFMAN_ONLY、Z_RLE (zlib 1.2.0.1) 或 Z_FIXED (zlib 1.2.2.2)。

参数 zdict 指定预定义的压缩字典。它是一个字节序列 (如 bytes 对象)，其中包含用户认为要压缩的数据中可能频繁出现的子序列。频率高的子序列应当放在字典的尾部。

在 3.3 版更改: 添加关键字参数 zdict。

zlib.crc32(data[, value])

计算 data 的 CRC (循环冗余校验) 值。计算的结果是一个 32 位的整数。参数 value 是校验时的起始值，其默认值为 0。借助参数 value 可为分段的输入计算校验值。此算法没有加密强度，不应用于身份验证和数字签名。此算法的目的仅为验证数据的正确性，不适合作为通用散列算法。

在 3.0 版更改: 结果值将始终为无符号类型。 要在使用 Python 2 或更早版本时生成同样的数值，请使用 crc32(data) & 0xffffffff。

zlib.decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)

解压 data 中的字节，返回含有已解压内容的 bytes 对象。参数 wbits 取决于 data 的格式，具体参见下边的说明。bufsize 为输出缓冲区的起始大小。函数发生错误时抛出 error 异常。

wbits 形参控制历史缓冲区的大小（或称“窗口大小”）以及所期望的头部和尾部格式。 它类似于 compressobj() 的形参，但可接受更大范围的值：

+8 至 +15：窗口尺寸以二为底的对数。 输入必须包含 zlib 头部和尾部。

0：根据 zlib 头部自动确定窗口大小。 只从 zlib 1.2.3.5 版起受支持。

−8 至 −15：使用 wbits 的绝对值作为窗口大小以二为底的对数。 输入必须为原始数据流，没有头部和尾部。

+24 至 +31 = 16 + (8 至 15)：使用后 4 个比特位作为窗口大小以二为底的对数。 输入必须包括 gzip 头部和尾部。

+40 至 +47 = 32 + (8 至 15)：使用后 4 个比特位作为窗口大小以二为底的对数，并且自动接受 zlib 或 gzip 格式。

当解压缩一个数据流时，窗口大小必须不小于用于压缩数据流的原始窗口大小；使用太小的值可能导致 error 异常。 默认 wbits 值对应于最大的窗口大小并且要求包括 zlib 头部和尾部。

bufsize 是用于存放解压数据的缓冲区初始大小。 如果需要更大空间，缓冲区大小将按需增加，因此你不需要让这个值完全精确；对其进行调整仅会节省一点对 malloc() 的调用次数。

在 3.6 版更改: wbits 和 bufsize 可用作关键字参数。

zlib.decompressobj(wbits=MAX_WBITS[, zdict])

返回一个解压对象，用来解压无法被一次性放入内存的数据流。

wbits 形参控制历史缓冲区的大小（或称“窗口大小”）以及所期望的头部和尾部格式。 它的含义与 对 decompress() 的描述 相同。

zdict 形参指定指定一个预定义的压缩字典。 如果提供了此形参，它必须与产生将解压数据的压缩器所使用的字典相同。

注解

如果 zdict 是一个可变对象 (例如 bytearray)，则你不可在对 decompressobj() 的调用和对解压器的 decompress() 方法的调用之间修改其内容。

在 3.3 版更改: 增加了 zdict 形参。

压缩对象支持以下方法：

Compress.compress(data)

压缩 data 并返回 bytes 对象，这个对象含有 data 的部分或全部内容的已压缩数据。所得的对象必须拼接在上一次调用 compress() 方法所得数据的后面。缓冲区中可能留存部分输入以供下一次调用。

Compress.flush([mode])

压缩所有缓冲区的数据并返回已压缩的数据。参数 mode 可以传入的常量为：Z_NO_FLUSH、Z_PARTIAL_FLUSH、Z_SYNC_FLUSH、Z_FULL_FLUSH、Z_BLOCK (zlib 1.2.3.4) 或 Z_FINISH。默认值为 Z_FINISH。Z_FINISH 关闭已压缩数据流并不允许再压缩其他数据，Z_FINISH 以外的值皆允许这个对象继续压缩数据。调用 flush() 方法并将 mode 设为 Z_FINISH 后会无法再次调用 compress()，此时只能删除这个对象。

Compress.copy()

返回此压缩对象的一个拷贝。它可以用来高效压缩一系列拥有相同前缀的数据。

在 3.8 版更改: 添加了对压缩对象执行 copy.copy() 和 copy.deepcopy() 的支持。

解压缩对象支持以下方法：

Decompress.unused_data

一个 bytes 对象，其中包含压缩数据结束之后的任何字节数据。 也就是说，它将为 b"" 直到包含压缩数据的末尾字节可用。 如果整个结果字节串都包含压缩数据，它将为一个空的 bytes 对象 b""。

Decompress.unconsumed_tail

一个 bytes 对象，其中包含未被上一次 decompress() 调用所消耗的任何数据。 此数据不能被 zlib 机制看到，因此你必须将其送回（可能要附带额外的数据拼接）到后续的 decompress() 方法调用以获得正确的输出。

Decompress.eof

一个布尔值，指明是否已到达压缩数据流的末尾。

这使得区分正确构造的压缩数据流和不完整或被截断的流成为可能。

3.3 新版功能.

Decompress.decompress(data, max_length=0)

解压缩 data 并返回 bytes 对象，其中包含对应于 string 中至少一部分数据的解压缩数据。 此数据应当被拼接到之前任何对 decompress() 方法的调用所产生的输出。 部分输入数据可能会被保留在内部缓冲区以供后续处理。

如果可选的形参 max_length 非零则返回值将不会长于 max_length。 这可能意味着不是所有已压缩输入都能被处理；并且未被消耗的数据将被保存在 unconsumed_tail 属性中。 如果要继续解压缩则这个字节串必须被传给对 decompress() 的后续调用。 如果 max_length 为零则整个输入都会被解压缩，并且 unconsumed_tail 将为空。

在 3.6 版更改: max_length 可用作关键字参数。

Decompress.flush([length])

所有挂起的输入会被处理，并且返回包含剩余未压缩输出的 bytes 对象。 在调用 flush() 之后，decompress() 方法将无法被再次调用；唯一可行的操作是删除该对象。

可选的形参 length 设置输出缓冲区的初始大小。

Decompress.copy()

返回解压缩对象的一个拷贝。 它可以用来在数据流的中途保存解压缩器的状态以便加快随机查找数据流后续位置的速度。

在 3.8 版更改: 添加了对解压缩对象执行 copy.copy() 和 copy.deepcopy() 的支持。

通过下列常量可获取模块所使用的 zlib 库的版本信息：

zlib.ZLIB_VERSION

构建此模块时所用的 zlib 库的版本字符串。它的值可能与运行时所加载的 zlib 不同。运行时加载的 zlib 库的版本字符串为 ZLIB_RUNTIME_VERSION。

zlib.ZLIB_RUNTIME_VERSION

解释器所加载的 zlib 库的版本字符串。

3.3 新版功能.

参见

模块 gzip

读写 gzip 格式的文件。

http://www.zlib.net

zlib 库项目主页。

http://www.zlib.net/manual.html

zlib 库用户手册。提供了库的许多功能的解释和用法。

gzip --- 对 gzip 格式的支持

源代码： Lib/gzip.py [https://github.com/python/cpython/tree/3.10/Lib/gzip.py]

此模块提供的简单接口帮助用户压缩和解压缩文件，功能类似于 GNU 应用程序 gzip 和 gunzip。

数据压缩由 zlib 模块提供。

gzip 模块提供 GzipFile 类和 open()、compress()、decompress() 几个便利的函数。GzipFile 类可以读写 gzip 格式的文件，还能自动压缩和解压缩数据，这让操作压缩文件如同操作普通的 file object 一样方便。

注意，此模块不支持部分可以被 gzip 和 gunzip 解压的格式，如利用 compress 或 pack 压缩所得的文件。

这个模块定义了以下内容：

gzip.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

以二进制方式或者文本方式打开一个 gzip 格式的压缩文件，返回一个 file object。

filename 参数可以是一个实际的文件名（一个 str 对象或者 bytes 对象），或者是一个用来读写的已存在的文件对象。

mode 参数可以是二进制模式： 'r', 'rb', 'a', 'ab', 'w', 'wb', 'x' or 'xb' , 或者是文本模式 'rt', 'at', 'wt', or 'xt'。默认值是 'rb'。

The compresslevel argument is an integer from 0 to 9, as for the GzipFile constructor.

对于二进制模式，这个函数等价于 GzipFile 构造器：GzipFile(filename, mode, compresslevel)。在这个例子中，encoding, errors 和 newline 三个参数一定不要设置。

对于文本模式，将会创建一个 GzipFile 对象，并将它封装到一个 io.TextIOWrapper 实例中， 这个实例默认了指定编码，错误抓获行为和行。

在 3.3 版更改: 支持 filename 为一个文件对象，支持文本模式和 encoding, errors 和 newline 参数。

在 3.4 版更改: 支持 'x', 'xb' 和 'xt' 三种模式。

在 3.6 版更改: 接受一个 path-like object。

exception gzip.BadGzipFile

针对无效 gzip 文件引发的异常。 它继承自 OSError。 针对无效 gzip 文件也可能引发 EOFError 和 zlib.error。

3.8 新版功能.

class gzip.GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)

GzipFile 类的构造器支持 truncate() 的异常，与 file object 的大多数方法非常相似。fileobj 和 filename 至少有一个不为空。

新的实例基于 fileobj，它可以是一个普通文件，一个 io.BytesIO 对象，或者任何一个与文件相似的对象。当 filename 是一个文件对象时，它的默认值是 None。

当 fileobj 为 None 时， filename 参数只用于 gzip 文件头中，这个文件有可能包含未压缩文件的源文件名。如果文件可以被识别，默认 fileobj 的文件名；否则默认为空字符串，在这种情况下文件头将不包含源文件名。

mode 参数可以是 'r', 'rb', 'a', 'ab', 'w', 'wb', 'x' 或 'xb' 中的一个，具体取决于文件将被读取还是被写入。 如果可识别则默认为 fileobj 的模式；否则默认为 'rb'。 在未来的 Python 发布版中将不再使用 fileobj 的模式。 最好总是指定 mode 为写入模式。

需要注意的是，文件默认使用二进制模式打开。 如果要以文本模式打开一个压缩文件，请使用 open() 方法 (或者使用 io.TextIOWrapper 包装 GzipFile)。

compresslevel 参数是一个从 0 到 9 的整数，用于控制压缩等级；1 最快但压缩比例最小，9 最慢但压缩比例最大。 0 不压缩。默认为 9。

mtime 参数是一个可选的数字时间戳用于写入流的最后修改字段，。mtime 只在压缩模式中使用。如果省略或者值为 None，则使用当前时间。更多细节，详见 mtime 属性。

调用 GzipFile 的 close() 方法不会关闭 fileobj，因为你可以希望增加其它内容到已经压缩的数中。你可以将一个 io.BytesIO 对象作为 fileobj，也可以使用 io.BytesIO 的 getvalue() 方法从内存缓存中恢复数据。

GzipFile 支持 io.BufferedIOBase 类的接口, 包括迭代和 with 语句。只有 truncate() 方法没有实现。

GzipFile 还提供了以下的方法和属性:

peek(n)

在不移动文件指针的情况下读取 n 个未压缩字节。最多只有一个单独的读取流来服务这个方法调用。返回的字节数不一定刚好等于要求的数量。

注解

调用 peek() 并没有改变 GzipFile 的文件指针，它可能改变潜在文件对象(例如： GzipFile 使用 fileobj 参数进行初始化)。

3.2 新版功能.

mtime

在解压的过程中，最后修改时间字段的值可能来自于这个属性，以整数的形式出现。在读取任何文件头信息前，初始值为 None。

所有 gzip 东方压缩流中必须包含时间戳这个字段。以便于像 gunzip这样的程序可以使用时间戳。格式与 time.time() 的返回值和 os.stat() 对象的 st_mtime 属性值一样。

name

指向磁盘上 gzip 文件的路径，为 str 或 bytes 对象。 等价于原始输入路径上 os.fspath() 的输出，不带其他标准化、解析或扩展。

在 3.1 版更改: 支持 with 语句，构造器参数 mtime 和 mtime 属性。

在 3.2 版更改: 添加了对零填充和不可搜索文件的支持。

在 3.3 版更改: 实现 io.BufferedIOBase.read1() 方法。

在 3.4 版更改: 支持 'x' and 'xb' 两种模式。

在 3.5 版更改: 支持写入任意 bytes-like objects。read() 方法可以接受 None 为参数。

在 3.6 版更改: 接受一个 path-like object。

3.9 版后已移除: 打开 GzipFile 用于写入而不指定 mode 参数的做法已被弃用。

gzip.compress(data, compresslevel=9, *, mtime=None)

压缩 data，返回一个包含压缩数据的 bytes 对象。 compresslevel 和 mtime 的含义与上文中 GzipFile 构造器的相同。

3.2 新版功能.

在 3.8 版更改: 添加了 mtime 形参用于可重复的输出。

gzip.decompress(data)

解压缩 data，返回一个包含未压缩数据的 bytes 对象。

3.2 新版功能.

用法示例

读取压缩文件示例：

import gzip
with gzip.open('/home/joe/file.txt.gz', 'rb') as f:
    file_content = f.read()

创建GZIP 文件示例：

import gzip
content = b"Lots of content here"
with gzip.open('/home/joe/file.txt.gz', 'wb') as f:
    f.write(content)

使用 GZIP 压缩已有的文件示例：

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)

使用 GZIP 压缩二进制字符串示例：

import gzip
s_in = b"Lots of content here"
s_out = gzip.compress(s_in)

参见

模块 zlib

支持 gzip 格式所需要的基本压缩模块。

命令行界面

gzip 模块提供了简单的命令行界面用于压缩和解压缩文件。

在执行后 gzip 模块会保留输入文件。

在 3.8 版更改: 添加一个带有用法说明的新命令行界面命令。 默认情况下，当你要执行 CLI 时，默认压缩等级为 6。

命令行选项

file

如果 file 未指定，则从 sys.stdin 读取。

--fast

指明最快速的压缩方法（较低压缩率）。

--best

指明最慢速的压缩方法（最高压缩率）。

-d, --decompress

解压缩给定的文件。

-h, --help

显示帮助消息。

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

源代码： Lib/bz2.py [https://github.com/python/cpython/tree/3.10/Lib/bz2.py]

此模块提供了使用 bzip2 压缩算法压缩和解压数据的一套完整的接口。

bz2 模块包含：

用于读写压缩文件的 open() 函数和 BZ2File 类。

用于增量压缩和解压的 BZ2Compressor 和 BZ2Decompressor 类。

用于一次性压缩和解压的 compress() 和 decompress() 函数。

文件压缩和解压

bz2.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

以二进制或文本模式打开 bzip2 压缩文件，返回一个 file object。

和 BZ2File 的构造函数类似，filename 参数可以是一个实际的文件名（str 或 bytes 对象），或是已有的可供读取或写入的文件对象。

mode 参数可设为二进制模式的 'r'、'rb'、'w'、'wb'、'x'、'xb'、'a' 或 'ab'，或者文本模式的 'rt'、'wt'、'xt' 或 'at'。默认是 'rb'。

compresslevel 参数是 1 到 9 的整数，和 BZ2File 的构造函数一样。

对于二进制模式，这个函数等价于 BZ2File 构造器: BZ2File(filename, mode, compresslevel=compresslevel)。 在这种情况下，不可提供 encoding, errors 和 newline 参数。

对于文本模式，将会创建一个 BZ2File 对象，并将它包装到一个 io.TextIOWrapper 实例中，此实例带有指定的编码格式、错误处理行为和行结束符。

3.3 新版功能.

在 3.4 版更改: 添加了 'x' (单独创建) 模式。

在 3.6 版更改: 接受一个 path-like object。

class bz2.BZ2File(filename, mode='r', *, compresslevel=9)

用二进制模式打开 bzip2 压缩文件。

如果 filename 是一个 str 或 bytes 对象，则打开名称对应的文件目录。 否则的话，filename 应当是一个 file object，它将被用来读取或写入压缩数据。

mode 参数可以是表示读取的 'r' (默认值)，表示覆写的 'w'，表示单独创建的 'x'，或表示添加的 'a'。 这些模式还可分别以 'rb', 'wb', 'xb' 和 'ab' 的等价形式给出。

如果 filename 是一个文件对象（而不是实际的文件名），则 'w' 模式并不会截断文件，而是会等价于 'a'。

如果 mode 为 'w' 或 'a'，则 compresslevel 可以是 1 到 9 之间的整数，用于指定压缩等级: 1 产生最低压缩率，而 9 (默认值) 产生最高压缩率。

如果 mode 为 'r'，则输入文件可以为多个压缩流的拼接。

BZ2File 提供了 io.BufferedIOBase 所指定的所有成员，但 detach() 和 truncate() 除外。 并支持迭代和 with 语句。

BZ2File 还提供了以下方法：

peek([n])

返回缓冲的数据而不前移文件位置。 至少将返回一个字节的数据（除非为 EOF）。 实际返回的字节数不确定。

注解

虽然调用 peek() 不会改变 BZ2File 的文件位置，但它可能改变下层文件对象的位置（举例来说如果 BZ2File 是通过传入一个文件对象作为 filename 的话）。

3.3 新版功能.

在 3.1 版更改: 添加了对 with 语句的支持。

在 3.3 版更改: 添加了 fileno(), readable(), seekable(), writable(), read1() 和 readinto() 方法。

在 3.3 版更改: 添加了对 filename 使用 file object 而非实际文件名的支持。

在 3.3 版更改: 添加了 'a' (append) 模式，以及对读取多数据流文件的支持。

在 3.4 版更改: 添加了 'x' (单独创建) 模式。

在 3.5 版更改: read() 方法现在接受 None 作为参数。

在 3.6 版更改: 接受一个 path-like object。

在 3.9 版更改: buffering 形参已被移除。 它自 Python 3.0 起即被忽略并弃用。 请传入一个打开文件对象来控制文件的打开方式。

compresslevel 形参成为仅限关键字参数。

在 3.10 版更改: 这个类在面对多个同时读取器和写入器时是线程安全的，就如它在 gzip 和 lzma 中的等价类所具有的特性一样。

增量压缩和解压

class bz2.BZ2Compressor(compresslevel=9)

创建一个新的压缩器对象。 此对象可被用来执行增量数据压缩。 对于一次性压缩，请改用 compress() 函数。

如果给定 compresslevel，它必须为 1 至 9 之间的整数。 默认值为 9。

compress(data)

向压缩器对象提供数据。 在可能的情况下返回一段已压缩数据，否则返回空字节串。

当你已结束向压缩器提供数据时，请调用 flush() 方法来完成压缩进程。

flush()

结束压缩进程，返回内部缓冲中剩余的压缩完成的数据。

调用此方法之后压缩器对象将不可再被使用。

class bz2.BZ2Decompressor

创建一个新的解压缩器对象。 此对象可被用来执行增量数据解压缩。 对于一次性解压缩，请改用 decompress() 函数。

注解

这个类不会透明地处理包含多个已压缩数据流的输入，这不同于 decompress() 和 BZ2File。 如果你需要通过 BZ2Decompressor 来解压缩多个数据流输入，你必须为每个数据流都使用新的解压缩器。

decompress(data, max_length=- 1)

解压缩 data (一个 bytes-like object)，返回字节串形式的解压缩数据。 某些 data 可以在内部被缓冲，以便用于后续的 decompress() 调用。 返回的数据应当与之前任何 decompress() 调用的输出进行拼接。

如果 max_length 为非负数，将返回至多 max_length 个字节的解压缩数据。 如果达到此限制并且可以产生后续输出，则 needs_input 属性将被设为 False。 在这种情况下，下一次 decompress() 调用提供的 data 可以为 b'' 以获取更多的输出。

如果所有输入数据都已被解压缩并返回（或是因为它少于 max_length 个字节，或是因为 max_length 为负数），则 needs_input 属性将被设为 True。

在到达数据流末尾之后再尝试解压缩数据会引发 EOFError。 在数据流末尾之后获取的任何数据都会被忽略并存储至 unused_data 属性。

在 3.5 版更改: 添加了 max_length 形参。

eof

若达到了数据流的末尾标记则为 True。

3.3 新版功能.

unused_data

在压缩数据流的末尾之后获取的数据。

如果在达到数据流末尾之前访问此属性，其值将为 b''。

needs_input

如果在要求新的未解压缩输入之前 decompress() 方法可以提供更多的解压缩数据则为 False。

3.5 新版功能.

一次性压缩或解压缩

bz2.compress(data, compresslevel=9)

压缩 data，此参数为一个 字节类对象。

如果给定 compresslevel，它必须为 1 至 9 之间的整数。 默认值为 9。

对于增量压缩，请改用 BZ2Compressor。

bz2.decompress(data)

解压缩 data，此参数为一个 字节类对象。

如果 data 是多个压缩数据流的拼接，则解压缩所有数据流。

对于增量解压缩，请改用 BZ2Decompressor。

在 3.3 版更改: 支持了多数据流的输入。

用法示例

以下是 bz2 模块典型用法的一些示例。

使用 compress() 和 decompress() 来显示往复式的压缩：

>>> 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

使用 BZ2Compressor 进行增量压缩：

>>> 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()

上面的示例使用了一个相当 "非随机" 的数据流（即 b"z" 块的数据流）。 随机数据的压缩率通常很差，而有序、重复的数据通常会产生很高的压缩率。

用二进制模式写入和读取 bzip2 压缩文件：

>>> 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

lzma --- 用 LZMA 算法压缩

3.3 新版功能.

源代码： Lib/lzma.py [https://github.com/python/cpython/tree/3.10/Lib/lzma.py]

此模块提供了可以压缩和解压缩使用 LZMA 压缩算法的数据的类和便携函数。 其中还包含支持 xz 工具所使用的 .xz 和旧式 .lzma 文件格式的文件接口，以及相应的原始压缩数据流。

此模块所提供了接口与 bz2 模块的非常类似。 请注意 LZMAFile 和 bz2.BZ2File 都 不是 线程安全的。，因此如果你需要在多个线程中使用单个 LZMAFile 实例，则需要通过锁来保护它。

exception lzma.LZMAError

当在压缩或解压缩期间或是在初始化压缩器/解压缩器的状态期间发生错误时此异常会被引发。

读写压缩文件

lzma.open(filename, mode='rb', *, format=None, check=- 1, preset=None, filters=None, encoding=None, errors=None, newline=None)

以二进制或文本模式打开 LZMA 压缩文件，返回一个 file object。

filename 参数可以是一个实际的文件名（以 str, bytes 或 路径类 对象的形式给出），在此情况下会打开指定名称的文件，或者可以是一个用于读写的现有文件对象。

mode 参数可以是二进制模式的 "r", "rb", "w", "wb", "x", "xb", "a" 或 "ab"，或者文本模式的 "rt", "wt", "xt" 或 "at"。 默认值为 "rb"。

当打开一个文件用于读取时，format 和 filters 参数具有与 LZMADecompressor 的参数相同的含义。 在此情况下，check 和 preset 参数不应被使用。

当打开一个文件用于写入的，format, check, preset 和 filters 参数具有与 LZMACompressor 的参数相同的含义。

对于二进制模式，这个函数等价于 LZMAFile 构造器: LZMAFile(filename, mode, ...)。 在这种情况下，不可提供 encoding, errors 和 newline 参数。

对于文本模式，将会创建一个 LZMAFile 对象，并将它包装到一个 io.TextIOWrapper 实例中，此实例带有指定的编码格式、错误处理行为和行结束符。

在 3.4 版更改: 增加了对 "x", "xb" 和 "xt" 模式的支持。

在 3.6 版更改: 接受一个 path-like object。

class lzma.LZMAFile(filename=None, mode='r', *, format=None, check=- 1, preset=None, filters=None)

以二进制模式打开一个 LZMA 压缩文件。

LZMAFile 可以包装在一个已打开的 file object 中，或者是在给定名称的文件上直接操作。 filename 参数指定所包装的文件对象，或是要打开的文件名称（类型为 str, bytes 或 路径类 对象）。 如果是包装现有的文件对象，被包装的文件在 LZMAFile 被关闭时将不会被关闭。

mode 参数可以是表示读取的 "r" (默认值)，表示覆写的 "w"，表示单独创建的 "x"，或表示添加的 "a"。 这些模式还可以分别以 "rb", "wb", "xb" 和 "ab" 的等价形式给出。

如果 filename 是一个文件对象（而不是实际的文件名），则 "w" 模式并不会截断文件，而会等价于 "a"。

当打开一个文件用于读取时，输入文件可以为多个独立压缩流的拼接。 它们会被作为单个逻辑流被透明地解码。

当打开一个文件用于读取时，format 和 filters 参数具有与 LZMADecompressor 的参数相同的含义。 在此情况下，check 和 preset 参数不应被使用。

当打开一个文件用于写入的，format, check, preset 和 filters 参数具有与 LZMACompressor 的参数相同的含义。

LZMAFile 支持 io.BufferedIOBase 所指定的所有成员，但 detach() 和 truncate() 除外。 并支持迭代和 with 语句。

还提供了以下方法：

peek(size=- 1)

返回缓冲的数据而不前移文件位置。 至少将返回一个字节的数据，除非已经到达 EOF。 实际返回的字节数不确定（会忽略 size 参数）。

注解

虽然调用 peek() 不会改变 LZMAFile 的文件位置，但它可能改变下层文件对象的位置（举例来说如果 LZMAFile 是通过传入一个文件对象作为 filename 的话）。

在 3.4 版更改: 增加了对 "x" 和 "xb" 模式的支持。

在 3.5 版更改: read() 方法现在接受 None 作为参数。

在 3.6 版更改: 接受一个 path-like object。

在内存中压缩和解压缩数据

class lzma.LZMACompressor(format=FORMAT_XZ, check=- 1, preset=None, filters=None)

创建一个压缩器对象，此对象可被用来执行增量压缩。

压缩单个数据块的更便捷方式请参阅 compress()。

format 参数指定应当使用哪种容器格式。 可能的值有：

FORMAT_XZ: .xz 容器格式。

这是默认格式。

FORMAT_ALONE: 传统的 .lzma 容器格式。

这种格式相比 .xz 更为受限 -- 它不支持一致性检查或多重过滤器。

FORMAT_RAW: 原始数据流，不使用任何容器格式。

这个格式描述器不支持一致性检查，并且要求你必须指定一个自定义的过滤器链（用于压缩和解压缩）。 此外，以这种方式压缩的数据不可使用 FORMAT_AUTO 来解压缩 (参见 LZMADecompressor)。

check 参数指定要包含在压缩数据中的一致性检查类型。 这种检查在解压缩时使用，以确保数据没有被破坏。 可能的值是：

CHECK_NONE: 没有一致性检查。 这是 FORMAT_ALONE 和 FORMAT_RAW 的默认值（也是唯一可接受的值）。

CHECK_CRC32: 32 位循环冗余检查。

CHECK_CRC64: 64 位循环冗余检查。 这是 FORMAT_XZ 的默认值。

CHECK_SHA256: 256 位安全哈希算法。

如果指定的检查不受支持，则会引发 LZMAError。

压缩设置可被指定为一个预设的压缩等级（通过 preset 参数）或以自定义过滤器链来详细设置（通过 filters 参数）。

preset 参数（如果提供）应当为一个 0 到 9 (包括边界) 之间的整数，可以选择与常数 PRESET_EXTREME 进行 OR 运算。 如果 preset 和 filters 均未给出，则默认行为是使用 PRESET_DEFAULT (预设等级 6)。 更高的预设等级会产生更小的输出，但会使得压缩过程更缓慢。

注解

除了更加 CPU 密集，使用更高的预设等级来压缩还需要更多的内存（并产生需要更多内存来解压缩的输出）。 例如使用预设等级 9 时，一个 LZMACompressor 对象的开销可以高达 800 MiB。 出于这样的原因，通常最好是保持使用默认预设等级。

filters 参数（如果提供）应当指定一个过滤器链。 详情参见 指定自定义的过滤器链。

compress(data)

压缩 data (一个 bytes object)，返回包含针对输入的至少一部分已压缩数据的 bytes 对象。 一部 data 可能会被放入内部缓冲区，以便用于后续的 compress() 和 flush() 调用。 返回的数据应当与之前任何 compress() 调用的输出进行拼接。

flush()

结束压缩进程，返回包含保存在压缩器的内部缓冲区中的任意数据的 bytes 对象。

调用此方法之后压缩器将不可再被使用。

class lzma.LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None)

创建一个压缩器对象，此对象可被用来执行增量解压缩。

一次性解压缩整个压缩数据流的更便捷方式请参阅 decompress()。

format 参数指定应当被使用的容器格式。 默认值为 FORMAT_AUTO，它可以解压缩 .xz 和 .lzma 文件。 其他可能的值为 FORMAT_XZ, FORMAT_ALONE 和 FORMAT_RAW。

memlimit 参数指定解压缩器可以使用的内存上限（字节数）。 当使用此参数时，如果不可能在给定内存上限之内解压缩输入数据则解压缩将失败并引发 LZMAError。

filters 参数指定用于创建被解压缩数据流的过滤器链。 此参数在 format 为 FORMAT_RAW 时要求提供，但对于其他格式不应使用。 有关过滤器链的更多信息请参阅 指定自定义的过滤器链。

注解

这个类不会透明地处理包含多个已压缩数据流的输入，这不同于 decompress() 和 LZMAFile。 要通过 LZMADecompressor 来解压缩多个数据流输入，你必须为每个数据流都创建一个新的解压缩器。

decompress(data, max_length=- 1)

解压缩 data (一个 bytes-like object)，返回字节串形式的解压缩数据。 某些 data 可以在内部被缓冲，以便用于后续的 decompress() 调用。 返回的数据应当与之前任何 decompress() 调用的输出进行拼接。

如果 max_length 为非负数，将返回至多 max_length 个字节的解压缩数据。 如果达到此限制并且可以产生后续输出，则 needs_input 属性将被设为 False。 在这种情况下，下一次 decompress() 调用提供的 data 可以为 b'' 以获取更多的输出。

如果所有输入数据都已被解压缩并返回（或是因为它少于 max_length 个字节，或是因为 max_length 为负数），则 needs_input 属性将被设为 True。

在到达数据流末尾之后再尝试解压缩数据会引发 EOFError。 在数据流末尾之后获取的任何数据都会被忽略并存储至 unused_data 属性。

在 3.5 版更改: 添加了 max_length 形参。

check

输入流使用的一致性检查的 ID。 这可能为 CHECK_UNKNOWN 直到已解压了足够的输入数据来确定它所使用的一致性检查。

eof

若达到了数据流的末尾标记则为 True。

unused_data

在压缩数据流的末尾之后获取的数据。

在达到数据流末尾之前，这个值将为 b""。

needs_input

如果在要求新的未解压缩输入之前 decompress() 方法可以提供更多的解压缩数据则为 False。

3.5 新版功能.

lzma.compress(data, format=FORMAT_XZ, check=- 1, preset=None, filters=None)

压缩 data (一个 bytes 对象)，返回包含压缩数据的 bytes 对象。

参见上文的 LZMACompressor 了解有关 format, check, preset 和 filters 参数的说明。

lzma.decompress(data, format=FORMAT_AUTO, memlimit=None, filters=None)

解压缩 data (一个 bytes 对象)，返回包含解压缩数据的 bytes 对象。

如果 data 是多个单独压缩数据流的拼接，则解压缩所有相应数据流，并返回结果的拼接。

参见上文的 LZMADecompressor 了解有关 format, memlimit 和 filters 参数的说明。

杂项

lzma.is_check_supported(check)

如果本系统支持给定的一致性检查则返回 True。

CHECK_NONE 和 CHECK_CRC32 总是受支持。 CHECK_CRC64 和 CHECK_SHA256 或许不可用，如果你正在使用基于受限制特性集编译的 liblzma 版本的话。

指定自定义的过滤器链

过滤器链描述符是由字典组成的序列，其中每个字典包含单个过滤器的 ID 和选项。 每个字典必须包含键 "id"，并可能包含额外的键用来指定基于过滤器的选项。 有效的过滤器 ID 如下：

压缩过滤器：

FILTER_LZMA1 (配合 FORMAT_ALONE 使用)

FILTER_LZMA2 (配合 FORMAT_XZ 和 FORMAT_RAW 使用)

Delta 过滤器：

FILTER_DELTA

Branch-Call-Jump (BCJ) 过滤器：

FILTER_X86

FILTER_IA64

FILTER_ARM

FILTER_ARMTHUMB

FILTER_POWERPC

FILTER_SPARC

一个过滤器链最多可由 4 个过滤器组成，并且不能为空。 过滤器链中的最后一个过滤器必须为压缩过滤器，其他过滤器必须为 Delta 或 BCJ 过滤器。

压缩过滤器支持下列选项（指定为表示过滤器的字典中的附加条目）：

preset: 压缩预设选项，用于作为未显式指定的选项的默认值的来源。

dict_size: 以字节表示的字典大小。 这应当在 4 KiB 和 1.5 GiB 之间（包含边界）。

lc: 字面值上下文的比特数。

lp: 字面值位置的比特数。 总计值 lc + lp 必须不大于 4。

pb: 位置的比特数；必须不大于 4。

mode: MODE_FAST 或 MODE_NORMAL。

nice_len: 对于一个匹配应当被视为“适宜长度”的值。 这应当小于或等于 273。

mf: 要使用的匹配查找器 -- MF_HC3, MF_HC4, MF_BT2, MF_BT3 或 MF_BT4。

depth: 匹配查找器使用的最大查找深度。 0 (默认值) 表示基于其他过滤器选项自动选择。

Delta 过滤器保存字节数据之间的差值，在特定环境下可产生更具重复性的输入。 它支持一个 dist 选项，指明要减去的字节之间的差值大小。 默认值为 1，即相邻字节之间的差值。

BCJ 过滤器主要作用于机器码。 它们会转换机器码内的相对分支、调用和跳转以使用绝对寻址，其目标是提升冗余度以供压缩器利用。 这些过滤器支持一个 start_offset 选项，指明应当被映射到输入数据开头的地址。 默认值为 0。

例子

在已压缩的数据中读取:

import lzma
with lzma.open("file.xz") as f:
    file_content = f.read()

创建一个压缩文件:

import lzma
data = b"Insert Data Here"
with lzma.open("file.xz", "w") as f:
    f.write(data)

在内存中压缩文件:

import lzma
data_in = b"Insert Data Here"
data_out = lzma.compress(data_in)

增量压缩:

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()
# Concatenate all the partial results:
result = b"".join([out1, out2, out3, out4])

写入已压缩数据到已打开的文件:

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")

使用自定义过滤器链创建一个已压缩文件:

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")

zipfile --- 使用ZIP存档

源代码： Lib/zipfile.py [https://github.com/python/cpython/tree/3.10/Lib/zipfile.py]

ZIP 文件格式是一个常用的归档与压缩标准。 这个模块提供了创建、读取、写入、添加及列出 ZIP 文件的工具。 任何对此模块的进阶使用都将需要理解此格式，其定义参见 PKZIP 应用程序笔记 [https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT]。

此模块目前不能处理分卷 ZIP 文件。它可以处理使用 ZIP64 扩展（超过 4 GB 的 ZIP 文件）的 ZIP 文件。它支持解密 ZIP 归档中的加密文件，但是目前不能创建一个加密的文件。解密非常慢，因为它是使用原生 Python 而不是 C 实现的。

这个模块定义了以下内容：

exception zipfile.BadZipFile

为损坏的 ZIP 文件抛出的错误。

3.2 新版功能.

exception zipfile.BadZipfile

BadZipFile 的别名，与旧版本 Python 保持兼容性。

3.2 版后已移除.

exception zipfile.LargeZipFile

当 ZIP 文件需要 ZIP64 功能但是未启用时会抛出此错误。

class zipfile.ZipFile

用于读写 ZIP 文件的类。 欲了解构造函数的描述，参阅段落 ZipFile 对象。

class zipfile.Path

实现了 pathlib.Path 所提供接口的一个子集的类，包括完整的 importlib.resources.abc.Traversable 接口。

3.8 新版功能.

class zipfile.PyZipFile

用于创建包含 Python 库的 ZIP 归档的类。

class zipfile.ZipInfo(filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))

用于表示档案内一个成员信息的类。 此类的实例会由 ZipFile 对象的 getinfo() 和 infolist() 方法返回。 大多数 zipfile 模块的用户都不必创建它们，只需使用此模块所创建的实例。 filename 应当是档案成员的全名，date_time 应当是包含六个字段的描述最近修改时间的元组；这些字段的描述请参阅 ZipInfo 对象。

zipfile.is_zipfile(filename)

根据文件的 Magic Number，如果 filename 是一个有效的 ZIP 文件则返回 True，否则返回 False。 filename 也可能是一个文件或类文件对象。

在 3.1 版更改: 支持文件或类文件对象。

zipfile.ZIP_STORED

未被压缩的归档成员的数字常数。

zipfile.ZIP_DEFLATED

常用的 ZIP 压缩方法的数字常数。需要 zlib 模块。

zipfile.ZIP_BZIP2

BZIP2 压缩方法的数字常数。需要 bz2 模块。

3.3 新版功能.

zipfile.ZIP_LZMA

LZMA 压缩方法的数字常数。需要 lzma 模块。

3.3 新版功能.

注解

ZIP 文件格式规范包括自 2001 年以来对 bzip2 压缩的支持，以及自 2006 年以来对 LZMA 压缩的支持。但是，一些工具（包括较旧的 Python 版本）不支持这些压缩方法，并且可能拒绝完全处理 ZIP 文件，或者无法提取单个文件。

参见

PKZIP 应用程序笔记 [https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT]

Phil Katz 编写的 ZIP 文件格式文档，此格式和使用的算法的创建者。

Info-ZIP 主页 [http://www.info-zip.org/]

有关 Info-ZIP 项目的 ZIP 存档程序和开发库的信息。

ZipFile 对象

class zipfile.ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True)

打开一个 ZIP 文件，file 为一个指向文件的路径（字符串），一个类文件对象或者一个 path-like object。

形参 mode 应当为 'r' 来读取一个存在的文件，'w' 来截断并写入新的文件， 'a' 来添加到一个存在的文件，或者 'x' 来仅新建并写入新的文件。如果 mode 为 'x' 并且 file 指向已经存在的文件，则抛出 FileExistsError。如果 mode 为 'a' 且 file 为已存在的文件，则格外的文件将被加入。如果 file 不指向 ZIP 文件，之后一个新的 ZIP 归档将被追加为此文件。这是为了将 ZIP 归档添加到另一个文件（例如 python.exe）。如果 mode 为 'a' 并且文件不存在， 则会新建。如果 mode 为 'r' 或 'a'， 则文件应当可定位。

compression 是在写入归档时要使用的 ZIP 压缩方法，应为 ZIP_STORED, ZIP_DEFLATED, ZIP_BZIP2 或 ZIP_LZMA；不可识别的值将导致引发 NotImplementedError。 如果指定了 ZIP_DEFLATED, ZIP_BZIP2 或 ZIP_LZMA 但相应的模块 (zlib, bz2 或 lzma) 不可用，则会引发 RuntimeError。 默认值为 ZIP_STORED。

如果 allowZip64 为 True (默认值) 则当 zipfile 大于 4 GiB 时 zipfile 将创建使用 ZIP64 扩展的 ZIP 文件。 如果该参数为 false 则当 ZIP 文件需要 ZIP64 扩展时 zipfile 将引发异常。

compresslevel 形参控制在将文件写入归档时要使用的压缩等级。 当使用 ZIP_STORED 或 ZIP_LZMA 时无压缩效果。 当使用 ZIP_DEFLATED 时接受整数 0 至 9 (更多信息参见 zlib)。 当使用 ZIP_BZIP2 时接受整数 1 至 9 (更多信息参见 bz2)。

strict_timestamps 参数在设为 False 时允许压缩早于 1980-01-01 的文件，代价时会将时间戳设为 1980-01-01。 类似的行为也会对晚于 2107-12-31 的文件发生，时间戳也会被设为该上限值。

如果创建文件时使用 'w', 'x' 或 'a' 模式并且未向归档添加任何文件就执行了 closed，则会将适当的空归档 ZIP 结构写入文件。

ZipFile 也是一个上下文管理器，因此支持 with 语句。 在这个示例中，myzip 将在 with 语句块执行完成之后被关闭 --- 即使是发生了异常:

with ZipFile('spam.zip', 'w') as myzip:
    myzip.write('eggs.txt')

3.2 新版功能: 添加了将 ZipFile 用作上下文管理器的功能。

在 3.3 版更改: 添加了对 bzip2 和 lzma 压缩的支持。

在 3.4 版更改: 默认启用 ZIP64 扩展。

在 3.5 版更改: 添加了对不可查找数据流的支持。 并添加了对 'x' 模式的支持。

在 3.6 版更改: 在此之前，对于不可识别的压缩值将引发普通的 RuntimeError。

在 3.6.2 版更改: file 形参接受一个 path-like object。

在 3.7 版更改: 添加了 compresslevel 形参。

3.8 新版功能: strict_timestamps 仅限关键字参数

ZipFile.close()

关闭归档文件。 你必须在退出程序之前调用 close() 否则将不会写入关键记录数据。

ZipFile.getinfo(name)

返回一个 ZipInfo 对象，其中包含有关归档成员 name 的信息。 针对一个目前并不包含于归档中的名称调用 getinfo() 将会引发 KeyError。

ZipFile.infolist()

返回一个列表，其中包含每个归档成员的 ZipInfo 对象。 如果是打开一个现有归档则这些对象的排列顺序与它们对应条目在磁盘上的实际 ZIP 文件中的顺序一致。

ZipFile.namelist()

返回按名称排序的归档成员列表。

ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False)

以二进制文件型对象的形式访问一个归档成员。 name 可以是归档内某个文件的名称或是某个 ZipInfo 对象。 如果包括了 mode 形参，则它必须为 'r' (默认值) 或 'w'。 pwd 是用于解密 bytes 对象形式的已加密 ZIP 文件的密码。

open() 也是一个上下文管理器，因此支持 with 语句:

with ZipFile('spam.zip') as myzip:
    with myzip.open('eggs.txt') as myfile:
        print(myfile.read())

如果 mode 为 'r' 则文件型对象 (ZipExtFile) 将为只读并且提供下列方法: read(), readline(), readlines(), seek(), tell(), __iter__(), __next__()。 这些对象可独立于 ZipFile 进行操作。

如果 mode='w' 则返回一个可写入的文件句柄，它将支持 write() 方法。 当一个可写入的文件句柄被打开时，尝试读写 ZIP 文件中的其他文件将会引发 ValueError。

当写入一个文件时，如果文件大小不能预先确定但是可能超过 2 GiB，可传入 force_zip64=True 以确保标头格式能够支持超大文件。 如果文件大小可以预先确定，则在构造 ZipInfo 对象时应设置 file_size，并将其用作 name 形参。

注解

open(), read() 和 extract() 方法可接受文件名或 ZipInfo 对象。 当尝试读取一个包含重复名称成员的 ZIP 文件时你将发现此功能很有好处。

在 3.6 版更改: 移除了对 mode='U' 的支持。 请使用 io.TextIOWrapper 以在 universal newlines 模式中读取已压缩的文本文件。

在 3.6 版更改: 现在 ZipFile.open() 可以被用来配合 mode='w' 选项将文件写入归档。

在 3.6 版更改: 在已关闭的 ZipFile 上调用 open() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。

ZipFile.extract(member, path=None, pwd=None)

从归档中提取一个成员放入当前工作目录；member 必须是一个成员的完整名称或 ZipInfo 对象。 成员的文件信息会尽可能精确地被提取。 path 指定一个要放入的不同目录。 member 可以是一个文件名或 ZipInfo 对象。 pwd 是 bytes 对象形式的用于解密已加密文件的密码。

返回所创建的经正规化的路径（对应于目录或新文件）。

注解

如果一个成员文件名为绝对路径，则将去掉驱动器/UNC共享点和前导的（反）斜杠，例如: ///foo/bar 在 Unix 上将变为 foo/bar，而 C:\foo\bar 在 Windows 上将变为 foo\bar。 并且一个成员文件名中的所有 ".." 都将被移除，例如: ../../foo../../ba..r 将变为 foo../ba..r。 在 Windows 上非法字符 (:, <, >, |, ", ?, and *) 会被替换为下划线 (_)。

在 3.6 版更改: 在已关闭的 ZipFile 上调用 extract() 将引发 ValueError。 在之前的版本中则将引发 RuntimeError。

在 3.6.2 版更改: path 形参接受一个 path-like object。

ZipFile.extractall(path=None, members=None, pwd=None)

从归档中提取出所有成员放入当前工作目录。 path 指定一个要放入的不同目录。 members 为可选项且必须为 namelist() 所返回列表的一个子集。 pwd 是 bytes 对象形式的用于解密已加密文件的密码。

警告

绝不要未经预先检验就从不可靠的源中提取归档文件。 这样有可能在 path 之外创建文件，例如某些成员具有以 "/" 开始的文件名或带有两个点号 ".." 的文件名。 此模块会尝试防止这种情况。 参见 extract() 的注释。

在 3.6 版更改: 在已关闭的 ZipFile 上调用 extractall() 将引发 ValueError。 在之前的版本中则将引发 RuntimeError。

在 3.6.2 版更改: path 形参接受一个 path-like object。

ZipFile.printdir()

将归档的目录表打印到 sys.stdout。

ZipFile.setpassword(pwd)

将 pwd (一个 bytes 对象) 设为用于提取已加密文件的默认密码。

ZipFile.read(name, pwd=None)

返回归档中文件 name 的字节数据。 name 是归档中文件的名称，或是一个 ZipInfo 对象。 归档必须以读取或追加模式打开。 pwd 为 bytes 对象形式的用于解密已加密文件的密码，并且如果指定了该参数则它将覆盖通过 setpassword() 设置的默认密码。 在使用 ZIP_STORED, ZIP_DEFLATED, ZIP_BZIP2 or ZIP_LZMA 以外的压缩方法的 ZipFile 上调用 read() 将引发 NotImplementedError。 如果相应的压缩模块不可用也会引发错误。

在 3.6 版更改: 在已关闭的 ZipFile 上调用 read() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。

ZipFile.testzip()

读取归档中的所有文件并检查它们的 CRC 和文件头。 返回第一个已损坏文件的名称，在其他情况下则返回 None。

在 3.6 版更改: 在已关闭的 ZipFile 上调用 testzip() 将引发 ValueError。 在之前的版本中则将引发 RuntimeError。

ZipFile.write(filename, arcname=None, compress_type=None, compresslevel=None)

将名为 filename 的文件写入归档，给予的归档名为 arcname (默认情况下将与 filename 一致，但是不带驱动器盘符并会移除开头的路径分隔符)。 compress_type 如果给出，它将覆盖作为构造器 compression 形参对于新条目所给出的值。 类似地，compresslevel 如果给出也将覆盖构造器。 归档必须使用 'w', 'x' 或 'a' 模式打开。

注解

归档名称应当是基于归档根目录的相对路径，也就是说，它们不应以路径分隔符开头。

注解

如果 arcname (或 filename，如果 arcname 未给出) 包含一个空字节，则归档中该文件的名称将在空字节位置被截断。

注解

文件名开头有一个斜杠可能导致存档文件无法在 Windows 系统上的某些 zip 程序中打开。

在 3.6 版更改: 在使用 'r' 模式创建的 ZipFile 或已关闭的 ZipFile 上调用 write() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。

ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)

将一个文件写入归档。 内容为 data，它可以是一个 str 或 bytes 的实例；如果是 str，则会先使用 UTF-8 进行编码。 zinfo_or_arcname 可以是它在归档中将被给予的名称，或者是 ZipInfo 的实例。 如果它是一个实例，则至少必须给定文件名、日期和时间。 如果它是一个名称，则日期和时间会被设为当前日期和时间。 归档必须以 'w', 'x' 或 'a' 模式打开。

如果给定了 compress_type，它将会覆盖作为新条目构造器的 compression 形参或在 zinfo_or_arcname (如果是一个 ZipInfo 实例) 中所给出的值。 类似地，如果给定了 compresslevel，它将会覆盖构造器。

注解

当传入一个 ZipInfo 实例作为 zinfo_or_arcname 形参时，所使用的压缩方法将为在给定的 ZipInfo 实例的 compress_type 成员中指定的方法。 默认情况下，ZipInfo 构造器将将此成员设为 ZIP_STORED。

在 3.2 版更改: compress_type 参数。

在 3.6 版更改: 在使用 'r' 模式创建的 ZipFile 或已关闭的 ZipFile 上调用 writestr() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。

以下数据属性也是可用的:

ZipFile.filename

ZIP 文件的名称。

ZipFile.debug

要使用的调试输出等级。 这可以设为从 0 (默认无输出) 到 3 (最多输出) 的值。 调试信息会被写入 sys.stdout。

ZipFile.comment

关联到 ZIP 文件的 bytes 对象形式的说明。 如果将说明赋给以 'w', 'x' 或 'a' 模式创建的 ZipFile 实例，它的长度不应超过 65535 字节。 超过此长度的说明将被截断。

Path 对象

class zipfile.Path(root, at='')

根据 root zipfile (它可以是一个 ZipFile 实例或适合传给 ZipFile 构造器的 file) 构造一个 Path 对象。

at 指定此 Path 在 zipfile 中的位置，例如 'dir/file.txt', 'dir/' 或 ''。 默认为空字符串，即指定跟目录。

Path 对象会公开 pathlib.Path 对象的下列特性:

Path 对象可以使用 / 运算符或 joinpath 来进行遍历。

Path.name

最终的路径组成部分。

Path.open(mode='r', *, pwd, **)

在当前路径上唤起 ZipFile.open()。 允许通过支持的模式打开用于读取或写入文本或二进制数据: 'r', 'w', 'rb', 'wb'。 当以文本模式打开时位置和关键字参数会被传给 io.TextIOWrapper，在其他情况下则会被忽略。 pwd 是要传给 ZipFile.open() 的 pwd 形参。

在 3.9 版更改: 增加了对以文本和二进制模式打开的支持。 现在默认为文本模式。

在 3.10.10 版更改: encoding 形参可以作为位置参数来提供而不会引起 TypeError。 这种情况在 3.9 中是会发生的。 需要与未打补丁的 3.10 和 3.11 版保持兼容的代码必须将所有 io.TextIOWrapper 参数，包括 encoding 作为关键字参数传入。

Path.iterdir()

枚举当前目录的子目录。

Path.is_dir()

如果当前上下文引用了一个目录则返回 True。

Path.is_file()

如果当前上下文引用了一个文件则返回 True。

Path.exists()

如果当前上下文引用了 zip 文件内的一个文件或目录则返回 True。

Path.read_text(*, **)

读取当前文件为 unicode 文本。 位置和关键字参数会被传递给 io.TextIOWrapper (buffer 除外，它将由上下文确定)。

在 3.10.10 版更改: encoding 形参可以作为位置参数来提供而不会引起 TypeError。 这种情况在 3.9 中是会发生的。 需要与未打补丁的 3.10 和 3.11 版保持兼容的代码必须将所有 io.TextIOWrapper 参数，包括 encoding 作为关键字参数传入。

Path.read_bytes()

读取当前文件为字节串。

Path.joinpath(*other)

返回一个新的 Path 对象，其中合并了每个 other 参数。 以下代码是等价的:

>>> Path(...).joinpath('child').joinpath('grandchild')
>>> Path(...).joinpath('child', 'grandchild')
>>> Path(...) / 'child' / 'grandchild'

在 3.10 版更改: 在 3.10 之前，joinpath 未被写入文档并且只接受一个形参。

PyZipFile 对象

PyZipFile 构造器接受与 ZipFile 构造器相同的形参，以及一个额外的形参 optimize。

class zipfile.PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=- 1)

3.2 新版功能: optimize 形参。

在 3.4 版更改: 默认启用 ZIP64 扩展。

实例在 ZipFile 对象所具有的方法以外还附加了一个方法:

writepy(pathname, basename='', filterfunc=None)

查找 *.py 文件并将相应的文件添加到归档。

如果 PyZipFile 的 optimize 形参未给定或为 -1，则相应的文件为 *.pyc 文件，并在必要时进行编译。

如果 PyZipFile 的 optimize 形参为 0, 1 或 2，则限具有相应优化级别 (参见 compile()) 的文件会被添加到归档，并在必要时进行编译。

如果 pathname 是文件，则文件名必须以 .py 为后缀，并且只有 (相应的 *.pyc) 文件会被添加到最高层级（不带路径信息）。 如果 pathname 不是以 .py 为后缀的文件，则将引发 RuntimeError。 如果它是目录，并且该目录不是一个包目录，则所有的 *.pyc 文件会被添加到最高层级。 如果目录是一个包目录，则所有的 *.pyc 会被添加到包名所表示的文件路径下，并且如果有任何子目录为包目录，则会以排好的顺序递归地添加这些目录。

basename 仅限在内部使用。

如果给定 filterfunc，则它必须是一个接受单个字符串参数的函数。 在将其添加到归档之前它将被传入每个路径（包括每个单独的完整路径）。 如果 filterfunc 返回假值，则路径将不会被添加，而如果它是一个目录则其内容将被忽略。 例如，如果我们的测试文件全都位于 test 目录或以字符串 test_ 打头，则我们可以使用一个 filterfunc 来排除它们:

>>> 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)

writepy() 方法会产生带有这样一些文件名的归档:

string.pyc                   # Top level name
test/__init__.pyc            # Package directory
test/testall.pyc             # Module test.testall
test/bogus/__init__.pyc      # Subpackage directory
test/bogus/myfile.pyc        # Submodule test.bogus.myfile

3.4 新版功能: filterfunc 形参。

在 3.6.2 版更改: pathname 形参接受一个 path-like object。

在 3.7 版更改: 递归排序目录条目。

ZipInfo 对象

ZipInfo 类的实例会通过 getinfo() 和 ZipFile 对象的 infolist() 方法返回。 每个对象将存储关于 ZIP 归档的一个成员的信息。

有一个类方法可以为文件系统文件创建 ZipInfo 实例:

classmethod ZipInfo.from_file(filename, arcname=None, *, strict_timestamps=True)

为文件系统中的文件构造一个 ZipInfo 实例，并准备将其添加到一个 zip 文件。

filename 应为文件系统中某个文件或目录的路径。

如果指定了 arcname，它会被用作归档中的名称。 如果未指定 arcname，则所用名称与 filename 相同，但将去除任何驱动器盘符和打头的路径分隔符。

strict_timestamps 参数在设为 False 时允许压缩早于 1980-01-01 的文件，代价时会将时间戳设为 1980-01-01。 类似的行为也会对晚于 2107-12-31 的文件发生，时间戳也会被设为该上限值。

3.6 新版功能.

在 3.6.2 版更改: filename 形参接受一个 path-like object。

3.8 新版功能: strict_timestamps 仅限关键字参数

实例具有下列方法和属性:

ZipInfo.is_dir()

如果此归档成员是一个目录则返回 True。

这会使用条目的名称：目录应当总是以 / 结尾。

3.6 新版功能.

ZipInfo.filename

归档中的文件名称。

ZipInfo.date_time

上次修改存档成员的时间和日期。这是六个值的元组：

索引 | 值
0 | Year (>= 1980)
1 | 月（1为基数）
2 | 月份中的日期（1为基数）
3 | 小时（0为基数）
4 | 分钟（0为基数）
5 | 秒（0为基数）

注解

ZIP文件格式不支持1980年以前的时间戳。

ZipInfo.compress_type

归档成员的压缩类型。

ZipInfo.comment

bytes 对象形式的单个归档成员的注释。

ZipInfo.extra

扩展字段数据。 PKZIP Application Note [https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT] 包含一些保存于该 bytes 对象中的内部结构的注释。

ZipInfo.create_system

创建 ZIP 归档所用的系统。

ZipInfo.create_version

创建 ZIP 归档所用的 PKZIP 版本。

ZipInfo.extract_version

需要用来提取归档的 PKZIP 版本。

ZipInfo.reserved

必须为零。

ZipInfo.flag_bits

ZIP 标志位。

ZipInfo.volume

文件头的分卷号。

ZipInfo.internal_attr

内部属性。

ZipInfo.external_attr

外部文件属性。

ZipInfo.header_offset

文件头的字节偏移量。

ZipInfo.CRC

未压缩文件的 CRC-32。

ZipInfo.compress_size

已压缩数据的大小。

ZipInfo.file_size

未压缩文件的大小。

命令行接口

zipfile 模块提供了简单的命令行接口用于与 ZIP 归档的交互。

如果你想要创建一个新的 ZIP 归档，请在 -c 选项后指定其名称然后列出应当被包含的文件名:

$ python -m zipfile -c monty.zip spam.txt eggs.txt

传入一个目录也是可接受的:

$ python -m zipfile -c monty.zip life-of-brian_1979/

如果你想要将一个 ZIP 归档提取到指定的目录，请使用 -e 选项:

$ python -m zipfile -e monty.zip target-dir/

要获取一个 ZIP 归档中的文件列表，请使用 -l 选项:

$ python -m zipfile -l monty.zip

命令行选项

-l <zipfile>

--list <zipfile>

列出一个 zipfile 中的文件名。

-c <zipfile> <source1> ... <sourceN>

--create <zipfile> <source1> ... <sourceN>

基于源文件创建 zipfile。

-e <zipfile> <output_dir>

--extract <zipfile> <output_dir>

将 zipfile 提取到目标目录中。

-t <zipfile>

--test <zipfile>

检测 zipfile 是否有效。

解压缩的障碍

zipfile 模块的提取操作可能会由于下面列出的障碍而失败。

由于文件本身

解压缩可能由于不正确的密码 / CRC 校验和 / ZIP 格式或不受支持的压缩 / 解密方法而失败。

文件系统限制

超出特定文件系统上的限制可能会导致解压缩失败。 例如目录条目所允许的字符、文件名的长度、路径名的长度、单个文件的大小以及文件的数量等等。

资源限制

缺乏内存或磁盘空间将会导致解压缩失败。 例如，作用于 zipfile 库的解压缩炸弹 (即 ZIP bomb [https://en.wikipedia.org/wiki/Zip_bomb]) 就可能造成磁盘空间耗尽。

中断

在解压缩期间中断执行，例如按下 ctrl-C 或杀死解压缩进程可能会导致归档文件的解压缩不完整。

提取的默认行为

不了解提取的默认行为可能导致不符合期望的解压缩结果。 例如，当提取相同归档两次时，它会不经询问地覆盖文件。

tarfile --- 读写tar归档文件

源代码: Lib/tarfile.py [https://github.com/python/cpython/tree/3.10/Lib/tarfile.py]

tarfile 模块可以用来读写 tar 归档，包括使用 gzip, bz2 和 lzma 压缩的归档。 请使用 zipfile 模块来读写 .zip 文件，或者使用 shutil 的高层级函数。

一些事实和数字:

读写 gzip, bz2 和 lzma 解压的归档要求相应的模块可用。

支持读取 / 写入 POSIX.1-1988 (ustar) 格式。

对 GNU tar 格式的读/写支持，包括 longname 和 longlink 扩展，对所有种类 sparse 扩展的只读支持，包括 sparse 文件的恢复。

对 POSIX.1-2001 (pax) 格式的读/写支持。

处理目录、正常文件、硬链接、符号链接、fifo 管道、字符设备和块设备，并且能够获取和恢复文件信息例如时间戳、访问权限和所有者等。

在 3.3 版更改: 添加了对 lzma 压缩的支持。

tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)

针对路径名 name 返回 TarFile 对象。 有关 TarFile 对象以及所允许的关键字参数的详细信息请参阅 TarFile 对象。

mode 必须是 'filemode[:compression]' 形式的字符串，其默认值为 'r'。 以下是模式组合的完整列表:

mode | action
'r' or 'r:*' | 打开和读取使用透明压缩（推荐）。
'r:' | 打开和读取不使用压缩。
'r:gz' | 打开和读取使用gzip 压缩。
'r:bz2' | 打开和读取使用bzip2 压缩。
'r:xz' | 打开和读取使用lzma 压缩。
'x' 或 'x:' | 创建tarfile不进行压缩。如果文件已经存在，则抛出 FileExistsError 异常。
'x:gz' | 使用gzip压缩创建tarfile。如果文件已经存在，则抛出 FileExistsError 异常。
'x:bz2' | 使用bzip2 压缩创建tarfile。如果文件已经存在，则抛出 FileExistsError 异常。
'x:xz' | 使用lzma 压缩创建tarfile。如果文件已经存在，则抛出 FileExistsError 异常。
'a' or 'a:' | 打开以便在没有压缩的情况下追加。如果文件不存在，则创建该文件。
'w' or 'w:' | 打开用于未压缩的写入。
'w:gz' | 打开用于 gzip 压缩的写入。
'w:bz2' | 打开用于 bzip2 压缩的写入。
'w:xz' | 打开用于 lzma 压缩的写入。

请注意 'a:gz', 'a:bz2' 或 'a:xz' 是不可能的组合。 如果 mode 不适用于打开特定（压缩的）文件用于读取，则会引发 ReadError。 请使用 mode 'r' 来避免这种情况。 如果某种压缩方法不受支持，则会引发 CompressionError。

如果指定了 fileobj，它会被用作对应于 name 的以二进制模式打开的 file object 的替代。 它会被设定为处在位置 0。

对于 'w:gz', 'r:gz', 'w:bz2', 'r:bz2', 'x:gz', 'x:bz2' 等模式，tarfile.open() 接受关键字参数 compresslevel (默认值为 9) 来指定文件的压缩等级。

对于 'w:xz' 和 'x:xz' 模式，tarfile.open() 接受关键字参数 preset 来指定文件的压缩等级。

针对特殊的目的，还存在第二种 mode 格式: 'filemode|[compression]'。 tarfile.open() 将返回一个将其数据作为数据块流来处理的 TarFile 对象。 对此文件将不能执行随机查找。 如果给定了 fileobj，它可以是任何具有 read() 或 write() 方法 (由 mode 确定) 的对象。 bufsize 指定块大小，默认值为 20 * 512 字节。 可与此格式组合使用的有 sys.stdin, 套接字 file object 或磁带设备等。 但是，对于这样的 TarFile 对象存在不允许随机访问的限制，参见 例子。 目前可用的模式如下:

模式 | 动作
'r|*' | 打开 tar 块的 流 以进行透明压缩读取。
'r|' | 打开一个未压缩的 tar 块的 stream 用于读取。
'r|gz' | 打开一个 gzip 压缩的 stream 用于读取。
'r|bz2' | 打开一个 bzip2 压缩的 stream 用于读取。
'r|xz' | 打开一个 lzma 压缩 stream 用于读取。
'w|' | 打开一个未压缩的 stream 用于写入。
'w|gz' | 打开一个 gzip 压缩的 stream 用于写入。
'w|bz2' | 打开一个 bzip2 压缩的 stream 用于写入。
'w|xz' | 打开一个 lzma 压缩的 stream 用于写入。

在 3.5 版更改: 添加了 'x' (单独创建) 模式。

在 3.6 版更改: name 形参接受一个 path-like object。

class tarfile.TarFile

用于读取和写入 tar 归档的类。 请不要直接使用这个类：而要使用 tarfile.open()。 参见 TarFile 对象。

tarfile.is_tarfile(name)

如果 name 是一个 tarfile 能读取的 tar 归档文件则返回 True。 name 可以为 str，文件或文件型对象。

在 3.9 版更改: 支持文件或类文件对象。

tarfile 模块定义了以下异常:

exception tarfile.TarError

所有 tarfile 异常的基类。

exception tarfile.ReadError

当一个不能被 tarfile 模块处理或者因某种原因而无效的 tar 归档被打开时将被引发。

exception tarfile.CompressionError

当一个压缩方法不受支持或者当数据无法被正确解码时将被引发。

exception tarfile.StreamError

当达到流式 TarFile 对象的典型限制时将被引发。

exception tarfile.ExtractError

当使用 TarFile.extract() 时针对 non-fatal 所引发的异常，但是仅限 TarFile.errorlevel== 2。

exception tarfile.HeaderError

如果获取的缓冲区无效则会由 TarInfo.frombuf() 引发的异常。

exception tarfile.FilterError

被过滤器 拒绝 的成员的基类。

tarinfo

关于过滤器拒绝提取的成员的信息，为 TarInfo 类型。

exception tarfile.AbsolutePathError

在拒绝提取具有绝对路径的成员时引发。

exception tarfile.OutsideDestinationError

在拒绝提取目标目录以外的成员时引发。

exception tarfile.SpecialFileError

在拒绝提取特殊文件（例如设备或管道）时引发。

exception tarfile.AbsoluteLinkError

在拒绝提取具有绝对路径的符号链接时引发。

exception tarfile.LinkOutsideDestinationError

在拒绝提取指向目标目录以外的符号链接时引发。

exception tarfile.LinkFallbackError

在要拒绝通过提取其他归档成员来模拟一个链接（硬链接或符号链接），而该成员会被过滤位置丢弃时被引发。 被引发以丢弃替换成员的异常可作为 BaseException.__context__ 被访问。

3.10.18 新版功能.

以下常量在模块层级上可用:

tarfile.ENCODING

默认的字符编码格式：在 Windows 上为 'utf-8'，其他系统上则为 sys.getfilesystemencoding() 所返回的值。

以下常量各自定义了一个 tarfile 模块能够创建的 tar 归档格式。 相关细节请参阅 受支持的 tar 格式 小节。

tarfile.USTAR_FORMAT

POSIX.1-1988 (ustar) 格式。

tarfile.GNU_FORMAT

GNU tar 格式。

tarfile.PAX_FORMAT

POSIX.1-2001 (pax) 格式。

tarfile.DEFAULT_FORMAT

用于创建归档的默认格式。 目前为 PAX_FORMAT。

在 3.8 版更改: 新归档的默认格式已更改为 PAX_FORMAT 而不再是 GNU_FORMAT。

参见

模块 zipfile

zipfile 标准模块的文档。

归档操作

标准 shutil 模块所提供的高层级归档工具的文档。

GNU tar manual, Basic Tar Format [https://www.gnu.org/software/tar/manual/html_node/Standard.html]

针对 tar 归档文件的文档，包含 GNU tar 扩展。

TarFile 对象

TarFile 对象提供了一个 tar 归档的接口。 一个 tar 归档就是数据块的序列。 一个归档成员（被保存文件）是由一个标头块加多个数据块组成的。 一个文件可以在一个 tar 归档中多次被保存。 每个归档成员都由一个 TarInfo 对象来代表，详情参见 TarInfo 对象。

TarFile 对象可在 with 语句中作为上下文管理器使用。 当语句块结束时它将自动被关闭。 请注意在发生异常事件时被打开用于写入的归档将不会被终结；只有内部使用的文件对象将被关闭。 相关用例请参见 例子。

3.2 新版功能: 添加了对上下文管理器协议的支持。

class 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)

下列所有参数都是可选项并且也可作为实例属性来访问。

name 是归档的路径名称。 name 可以是一个 path-like object。 如果给定了 fileobj 则它可以被省略。 在此情况下，如果对象的 name 属性存在则它会被使用。

mode 可以为 'r' 表示从现有归档读取，'a' 表示将数据追加到现有文件，'w' 表示创建新文件覆盖现有文件，或者 'x' 表示仅在文件不存在时创建新文件。

如果给定了 fileobj，它会被用于读取或写入数据。 如果可以被确定，则 mode 会被 fileobj 的模式所覆盖。 fileobj 的使用将从位置 0 开始。

注解

当 TarFile 被关闭时，fileobj 不会被关闭。

format 控制用于写入的归档格式。 它必须为在模块层级定义的常量 USTAR_FORMAT, GNU_FORMAT 或 PAX_FORMAT 中的一个。 当读取时，格式将被自动检测，即使单个归档中存在不同的格式。

tarinfo 参数可以被用来将默认的 TarInfo 类替换为另一个。

如果 dereference 为 False，则会将符号链接和硬链接添加到归档中。 如果为 True，则会将目标文件的内容添加到归档中。 在不支持符号链接的系统上参数将不起作用。

如果 ignore_zeros 为 False，则会将空的数据块当作归档的末尾来处理。 如果为 True，则会跳过空的（和无效的）数据块并尝试获取尽可能多的成员。 此参数仅适用于读取拼接的或损坏的归档。

debug 可设为从 0 (无调试消息) 到 3 (全部调试消息)。 消息会被写入到 sys.stderr。

errorlevel 控制如何处理提取错误，参见 相应的属性。

encoding 和 errors 参数定义了读取或写入归档所使用的字符编码格式以及要如何处理转换错误。 默认设置将适用于大多数用户。 要深入了解详情可参阅 Unicode 问题 小节。

可选的 pax_headers 参数是字符串的字典，如果 format 为 PAX_FORMAT 它将被作为 pax 全局标头被添加。

在 3.2 版更改: 使用 'surrogateescape' 作为 errors 参数的默认值。

在 3.5 版更改: 添加了 'x' (单独创建) 模式。

在 3.6 版更改: name 形参接受一个 path-like object。

classmethod TarFile.open(...)

作为替代的构造器。 tarfile.open() 函数实际上是这个类方法的快捷方式。

TarFile.getmember(name)

返回成员 name 的 TarInfo 对象。 如果 name 在归档中找不到，则会引发 KeyError。

注解

如果一个成员在归档中出现超过一次，它的最后一次出现会被视为是最新的版本。

TarFile.getmembers()

以 TarInfo 对象列表的形式返回归档的成员。 列表的顺序与归档中成员的顺序一致。

TarFile.getnames()

以名称列表的形式返回成员。 它的顺序与 getmembers() 所返回列表的顺序一致。

TarFile.list(verbose=True, *, members=None)

将内容清单打印到 sys.stdout。 如果 verbose 为 False，则将只打印成员名称。 如果为 True，则输出将类似于 ls -l 的输出效果。 如果给定了可选的 members，它必须为 getmembers() 所返回的列表的一个子集。

在 3.5 版更改: 添加了 members 形参。

TarFile.next()

当 TarFile 被打开用于读取时，以 TarInfo 对象的形式返回归档的下一个成员。 如果不再有可用对象则返回 None。

TarFile.extractall(path='.', members=None, *, numeric_owner=False, filter=None)

将归档中的所有成员提取到当前工作目录或 path 目录。 如果给定了可选的 members，则它必须为 getmembers() 所返回的列表的一个子集。 字典信息例如所有者、修改时间和权限会在所有成员提取完毕后被设置。 这样做是为了避免两个问题：目录的修改时间会在每当在其中创建文件时被重置。 并且如果目录的权限不允许写入，提取文件到目录的操作将失败。

如果 numeric_owner 为 True，则将使用来自 tarfile 的 uid 和 gid 数值来设置被提取文件的所有者/用户组。 在其他情况下，则会使用来自 tarfile 的名称值。

The filter argument, which was added in Python 3.10.12, specifies how members are modified or rejected before extraction. See 解压缩过滤器 for details. It is recommended to set this explicitly depending on which tar features you need to support.

警告

绝不要未经预先检验就从不可靠的源中提取归档文件。 这样有可能在 path 之外创建文件，例如某些成员具有以 "/" 开始的绝对路径文件名或带有两个点号 ".." 的文件名。

设置 filter='data' 来防止最危险的安全问题，并请参阅 解压缩过滤器 一节了解详情。section for details.

在 3.5 版更改: 添加了 numeric_owner 形参。

在 3.6 版更改: path 形参接受一个 path-like object。

在 3.10.12 版更改: 添加了 filter 形参。

TarFile.extract(member, path='', set_attrs=True, *, numeric_owner=False, filter=None)

从归档中提取出一个成员放入当前工作目录，将使用其完整名称。 成员的文件信息会尽可能精确地被提取。 member 可以是一个文件名或 TarInfo 对象。 你可以使用 path 指定一个不同的目录。 path 可以是一个 path-like object。 将会设置文件属性 (owner, mtime, mode) 除非 set_attrs 为假值。

numeric_owner 和 filter 参数与 extractall() 中的相同。

注解

extract() 方法不会处理某些提取问题。 在大多数情况下你应当考虑使用 extractall() 方法。

警告

查看 extractall() 的警告信息。

设置 filter='data' 来防止最危险的安全问题，并请参阅 解压缩过滤器 一节了解详情。section for details.

在 3.2 版更改: 添加了 set_attrs 形参。

在 3.5 版更改: 添加了 numeric_owner 形参。

在 3.6 版更改: path 形参接受一个 path-like object。

在 3.10.12 版更改: 添加了 filter 形参。

TarFile.extractfile(member)

将归档中的一个成员提取为文件对象。 member 可以是一个文件名或 TarInfo 对象。 如果 member 是一个常规文件或链接，则会返回一个 io.BufferedReader 对象。 对于所有其他现有成员，则都将返回 None。 如果 member 未在归档中出现，则会引发 KeyError。

在 3.3 版更改: 返回一个 io.BufferedReader 对象。

TarFile.errorlevel: int

如果 errorlevel 为 0，则在使用 TarFile.extract() 和 TarFile.extractall() 时错误会被忽略。 不过，当 debug 大于 0 时它们将会作为错误消息在调试输出中出现。 如果 errorlevel*为 ``1`` (默认值)，则所有 *fatal 错误都会作为 OSError 或 FilterError 异常被引发。 如果为 2，则所有 non-fatal 错误也会作为 TarError 异常被引发。

某些异常，如参数类型错误或数据损坏导致的异常，总是会被触发。

自定义 提取过滤器 应针对 fatal 错误引发 FilterError，针对 non-fatal 错误引发 ExtractError。

请注意，当出现异常时，存档可能会被部分提取。用需要户负责进行清理。

TarFile.extraction_filter

3.10.12 新版功能.

被用作 extract() 和 extractall() 的 filter 参数的默认值的 提取过滤器。

该属性可以为 None 或是一个可调用对象。 与 extract() 的 filter 参数不同，该属性不允许使用字符串名称。

If extraction_filter is None (the default), calling an extraction method without a filter argument will use the fully_trusted filter for compatibility with previous Python versions.

在 Python 3.12+ 中，保留 extraction_filter=None 会发出一个 DeprecationWarning 。

在 Python 3.14+ 中，保持 extraction_filter=None 将导致提取方法默认使用 data 过滤器。

该属性可在实例上设置或在子类中重载。 也可以在 TarFile 类本身上设置它以设置一个全局默认值，不过，由于它会影响 tarfile 的所有使用，因此最好只在最高层级应用程序或 站点配置 中这样做。 要以这种方式设置全局默认值，需要用 staticmethod() 包装过滤器函数以防止 self 参数的注入。

TarFile.add(name, arcname=None, recursive=True, *, filter=None)

将文件 name 添加到归档。 name 可以为任意类型的文件（目录、fifo、符号链接等等）。 如果给出 arcname 则它将为归档中的文件指定一个替代名称。 默认情况下会递归地添加目录。 这可以通过将 recursive 设为 False 来避免。 递归操作会按排序顺序添加条目。 如果给定了 filter，它应当为一个接受 TarInfo 对象并返回已修改 TarInfo 对象的函数。 如果它返回 None 则 TarInfo 对象将从归档中被排除。 具体示例参见 例子。

在 3.2 版更改: 添加了 filter 形参。

在 3.7 版更改: 递归操作按排序顺序添加条目。

TarFile.addfile(tarinfo, fileobj=None)

将 TarInfo 对象 tarinfo 添加到归档。 如果给定了 fileobj，它应当是一个 binary file，并会从中读取 tarinfo.size 个字节添加到归档。 你可以直接创建 TarInfo 对象，或是使用 gettarinfo() 来创建。

TarFile.gettarinfo(name=None, arcname=None, fileobj=None)

基于 os.stat() 的结果或者现有文件的相同数据创建一个 TarInfo。 文件或者是命名为 name，或者是使用文件描述符指定为一个 file object fileobj。 name 可以是一个 path-like object。 如果给定了 arcname，则它将为归档中的文件指定一个替代名称，在其他情况下，名称将从 fileobj 的 name 属性或 name 参数获取。 名称应当是一个文本字符串。

你可以在使用 addfile() 添加 TarInfo 的某些属性之前修改它们。 如果文件对象不是从文件开头进行定位的普通文件对象，size 之类的属性就可能需要修改。 例如 GzipFile 之类的文件就属于这种情况。 name 也可以被修改，在这种情况下 arcname 可以是一个占位字符串。

在 3.6 版更改: name 形参接受一个 path-like object。

TarFile.close()

关闭 TarFile。 在写入模式下，会向归档添加两个表示结束的零数据块。

TarFile.pax_headers

一个包含 pax 全局标头的键值对的字典。

TarInfo 对象

TarInfo 对象代表 TarFile 中的一个文件。 除了会存储所有必要的文件属性（例如文件类型、大小、时间、权限、所有者等），它还提供了一些确定文件类型的有用方法。 此对象 并不 包含文件数据本身。

TarInfo 对象可通过 TarFile 的方法 getmember(), getmembers() 和 gettarinfo() 返回。

修改 getmember() 或 getmembers() 返回的对象将会影响在归档上的所有后续操作。 对于不希望如此的情况，你可以使用 copy.copy() 或调用 replace() 方法通过一个步骤创建经修改的副本。

部分属性可以设为 None 以表示一些元数据未被使用或未知。 不同的 TarInfo 方法会以不同的方式处理 None:

extract() 或 extractall() 方法会忽略相应的元数据，让其保持默认设置。

addfile() 将会失败。

list() 将打印一个占位字符串。

在 3.10.12 版更改: Added replace() and handling of None.

class tarfile.TarInfo(name='')

创建一个 TarInfo 对象。

classmethod TarInfo.frombuf(buf, encoding, errors)

基于字符串缓冲区 buf 创建并返回一个 TarInfo 对象。

如果缓冲区无效则会引发 HeaderError。

classmethod TarInfo.fromtarfile(tarfile)

从 TarFile 对象 tarfile 读取下一个成员并将其作为 TarInfo 对象返回。

TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')

基于 TarInfo 对象创建一个字符串缓冲区。 有关参数的信息请参见 TarFile 类的构造器。

在 3.2 版更改: 使用 'surrogateescape' 作为 errors 参数的默认值。

TarInfo 对象具有以下公有数据属性:

TarInfo.name: str

归档成员的名称。

TarInfo.size: int

以字节表示的大小。

TarInfo.mtime: int | float

以 Unix 纪元 秒数表示的最近修改时间，与 os.stat_result.st_mtime 相同。

在 3.10.12 版更改: 对于 extract() 和 extractall() 可设为 None，以使解压缩操作跳过应用此属性。

TarInfo.mode: int

权限比特位，与 os.chmod() 相同。

在 3.10.12 版更改: 对于 extract() 和 extractall() 可设为 None，以使解压缩操作跳过应用此属性。

TarInfo.type

文件类型。 type 通常为以下常量之一: REGTYPE, AREGTYPE, LNKTYPE, SYMTYPE, DIRTYPE, FIFOTYPE, CONTTYPE, CHRTYPE, BLKTYPE, GNUTYPE_SPARSE。 要更方便地确定一个 TarInfo 对象的类型，请使用下述的 is*() 方法。

TarInfo.linkname: str

目标文件名的名称，该属性仅在类型为 LNKTYPE 和 SYMTYPE 的 TarInfo 对象中存在。

对于符号链接 (SYMTYPE)，linkname 是相对于包含链接的目录的。 对于硬链接 (LNKTYPE)，linkname 则是相对于存档根目录的。

TarInfo.uid: int

最初保存该成员的用户的用户 ID。

在 3.10.12 版更改: 对于 extract() 和 extractall() 可设为 None，以使解压缩操作跳过应用此属性。

TarInfo.gid: int

最初保存该成员的用户的分组 ID。

在 3.10.12 版更改: 对于 extract() 和 extractall() 可设为 None，以使解压缩操作跳过应用此属性。

TarInfo.uname: str

用户名。

在 3.10.12 版更改: 对于 extract() 和 extractall() 可设为 None，以使解压缩操作跳过应用此属性。

TarInfo.gname: str

分组名。

在 3.10.12 版更改: 对于 extract() 和 extractall() 可设为 None，以使解压缩操作跳过应用此属性。

TarInfo.pax_headers: dict

一个包含所关联的 pax 扩展标头的键值对的字典。

TarInfo.replace(name=..., mtime=..., mode=..., linkname=...,

uid=..., gid=..., uname=..., gname=...,

deep=True)

3.10.12 新版功能.

返回修改了给定属性的 TarInfo 对象的 新 副本。 例如，要返回组名设为 'staff' 的 TarInfo，请使用:

new_tarinfo = old_tarinfo.replace(gname='staff')

在默认情况下，将执行深拷贝。 如果 deep 为假值，则执行浅拷贝，即 pax_headers 及任何自定义属性都与原始 TarInfo 对象共享。

TarInfo 对象还提供了一些便捷查询方法:

TarInfo.isfile()

如果 Tarinfo 对象为普通文件则返回 True。

TarInfo.isreg()

与 isfile() 相同。

TarInfo.isdir()

如果为目录则返回 True。

TarInfo.issym()

如果为符号链接则返回 True。

TarInfo.islnk()

如果为硬链接则返回 True。

TarInfo.ischr()

如果为字符设备则返回 True。

TarInfo.isblk()

如果为块设备则返回 True。

TarInfo.isfifo()

如果为 FIFO 则返回 True。.

TarInfo.isdev()

如果为字符设备、块设备或 FIFO 之一则返回 True。

解压缩过滤器

3.10.12 新版功能.

tar 格式的设计旨在捕捉类 UNIX 文件系统的所有细节，这使其功能非常强大。 不幸的是，这些特性也使得很容易创建在解压缩时产生意想不到的 -- 甚至可能是恶意的 -- 影响的 tar 文件。 举例来说，解压缩 tar 文件时可以通过各种方式覆盖任意文件（例如通过使用绝对路径、.. 路径组件或影响后续成员的符号链接等）。

在大多数情况下，并不需要全部的功能。 因此，tarfile 支持提取过滤器：一种限制功能的机制，从而避免一些安全问题。

参见

PEP 706 [https://www.python.org/dev/peps/pep-0706]

包含设计背后进一步的动机和理由。

TarFile.extract() 或 extractall() 的 filter 参数可以是：

字符串 'fully_trusted'：尊重归档文件中指定的所有元数据。 如果用户完全信任该归档，或实现了自己的复杂验证则应使用此过滤器。

字符串 'tar': 尊重大多数 tar 专属的特性（即类 UNIX 文件系统的功能），但阻止极有可能令人惊讶的或恶意的功能。 详情参见 tar_filter()。

字符串 'data'：忽略或阻止大多数类 UNIX 文件系统专属的特性。 用于提取跨平台数据归档文件。 详情参见 data_filter()。

None (默认): 使用 TarFile.extraction_filter。

如果也是 None （默认值），则将使用 'fully_trusted' 过滤器（为了与 Python 早期版本兼容）。

在 Python 3.12 中，默认情况下会发出 DeprecationWarning 。

在 Python 3.14 中，'data' 过滤器将变成默认选项。 也可以提前切换，参见 TarFile.extraction_filter。

该可调用对象将针每个被提取的成员执行调用并附带一个 TarInfo 来描述该成员以及被提取归档文件的目标路径（即供所有成员使用的相同路径）:

filter(/, member: TarInfo, path: str) -> TarInfo | None

该可调用对象会在提取每个成员之前被调用，因此它能够将磁盘的当前状态考虑在内。 它可以：

返回一个 TarInfo 对象，该对象将被用来代替归档文件中的元数据，或者

返回 None，在这种情况下该成员将被跳过，或者

根据 errorlevel 的值引发一个异常以中止操作或跳过成员。 请注意当提取操作中止时，extractall() 可能会保留部分已提取的归档文件。 它不会尝试执行清理。

默认的命名过滤器

预定义的命名过滤器可作为函数使用，因此它们可在自定义过滤器中被重用：

tarfile.fully_trusted_filter(/, member, path)

不加修改地返回 member。

实现 'fully_trusted' 过滤器。

tarfile.tar_filter(/, member, path)

实现 'tar' 过滤器。

Strip leading slashes (/ and os.sep) from filenames.

拒绝 提取具有绝对路径的文件（针对名称在去除斜杠后仍为绝对路径的情况，例如 Windows 上 C:/foo 这样的路径）。 这会引发 AbsolutePathError。

拒绝 提取具有位于目标以外的绝对路径（跟随符号链接之后）的文件。这会引发 OutsideDestinationError。

Clear high mode bits (setuid, setgid, sticky) and group/other write bits (S_IWOTH).

返回修改后的 TarInfo 成员。

tarfile.data_filter(/, member, path)

实现 'data' 过滤器。 在 tar_filter 的所具有的功能之外：

使用 os.path.normpath() 来正规化链接目标 (TarInfo.linkname)。 请注意这将移除内部的 .. 组件，这可能在 TarInfo.linkname 中的路径会遍历符号链接时改变链接的含义。

拒绝 提取链接到绝对路径的链接（不论是硬链接还是软链接），或链接到目标之外的链接。

这会引发 AbsoluteLinkError 或 LinkOutsideDestinationError。

请注意即使在不支持符号链接的平台上此类文件也会被拒绝。

拒绝 提取设备文件（包括管道）。 这会引发 SpecialFileError。

用于常规文件，包括硬链接：

Set the owner read and write permissions (S_IWUSR).

Remove the group & other executable permission (S_IXOTH) if the owner doesn’t have it (S_IXUSR).

对于其他文件（目录），将 mode 设为 None，以便提取方法跳过应用权限位。

将用户和组信息 (uid, gid, uname, gname) 设为 None，以使得提取方法跳过对它的设置。

返回修改后的 TarInfo 成员。

在 3.10.18 版更改: 链接目标现在会被正规化。

过滤器错误

当过滤器拒绝提取文件时，它将引发一个适当的异常，即 FilterError 的子类。 如果 TarFile.errorlevel 为 1 或更大的值则提取将中止。 如果 errorlevel=0 则会记录错误并跳过该成员，但提取仍会继续。

进一步核验的提示

即使 filter='data'，tarfile 也不适合在没有事先检查的情况下提取不受信任的文件。 除其他问题外，预定义的过滤器不能防止拒绝服务攻击。 用户应当进行额外的检查。

以下是一份不完整的考虑事项列表：

提取到 新的临时目录 以避免滥用已存在的链接等问题，并使得提取失败后更容易清理。

如果你不需要此功能则请禁用符号链接。

在处理不受信任的数据时，使用外部（例如操作系统层级）的磁盘、内存和 CPU 使用限制。

根据允许字符列表检查文件名（来过滤控制字符、易混淆字符、外来路径分隔符等）。

检查文件名是否有预期的扩展名（不鼓励使用在“点击”时会被执行的文件，或像 Windows 特殊设备名称这样没有扩展名的文件）。

限制提取文件的数量、提取数据的总大小、文件名长度（包括符号链接长度）以及单个文件的大小。

检查在不区分大小写的文件系统上会被屏蔽的文件。

还需要注意：

Tar 文件可能包含同一文件的多个版本。 较晚的版本会覆盖任何较早的版本。 这一功能对于更新磁带归档来说至关重要，但也可能被恶意滥用。

tarfile 无法为“实时”数据的问题提供保护，例如在提取（或归档）过程中攻击者对目标（或源）目录进行了改动。

支持较早的 Python 版本

Extraction filters were added to Python 3.12, and are backported to older versions as security updates. To check whether the feature is available, use e.g. hasattr(tarfile, 'data_filter') rather than checking the Python version.

下面的例子演示了如何支持带有和没有有该功能的 Python 版本。 请注意设置 extraction_filter 会影响任何后续的操作。

完全受信任的归档:

my_tarfile.extraction_filter = (lambda member, path: member)
my_tarfile.extractall()

如果可用则使用 'data' 过滤器；如果此特性不可用，则恢复为 Python 3.11 的行为 ('fully_trusted'):

my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',
                                       (lambda member, path: member))
my_tarfile.extractall()

使用 'data' 过滤器；如果不可用则 fail:

my_tarfile.extractall(filter=tarfile.data_filter)

或者：

my_tarfile.extraction_filter = tarfile.data_filter
my_tarfile.extractall()

使用 'data' 过滤器；如果不可用则 warn:

if hasattr(tarfile, 'data_filter'):
    my_tarfile.extractall(filter='data')
else:
    # remove this when no longer needed
    warn_the_user('Extracting may be unsafe; consider updating Python')
    my_tarfile.extractall()

有状态的提取过滤器示例

tarfile 的提取方法接受一个简单的 filter 可调用对象，而自定义过滤器则可以是具有内部状态的更复杂对象。 将其写成为下文管理器可能会很有用处，即以这样的方式使用:

with StatefulFilter() as filter_func:
    tar.extractall(path, filter=filter_func)

例如，这种过滤器可以写成:

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')

命令行接口

3.4 新版功能.

tarfile 模块提供了简单的命令行接口以便与 tar 归档进行交互。

如果你想要创建一个新的 tar 归档，请在 -c 选项后指定其名称然后列出应当被包含的文件名:

$ python -m tarfile -c monty.tar  spam.txt eggs.txt

传入一个目录也是可接受的:

$ python -m tarfile -c monty.tar life-of-brian_1979/

如果你想要将一个 tar 归档提取到指定的目录，请使用 -e 选项:

$ python -m tarfile -e monty.tar

你也可以通过传入目录名称将一个 tar 归档提取到不同的目录:

$ python -m tarfile -e monty.tar  other-dir/

要获取一个 tar 归档中文件的列表，请使用 -l 选项:

$ python -m tarfile -l monty.tar

命令行选项

-l <tarfile>

--list <tarfile>

列出一个 tarfile 中的文件名。

-c <tarfile> <source1> ... <sourceN>

--create <tarfile> <source1> ... <sourceN>

基于源文件创建 tarfile。

-e <tarfile> [<output_dir>]

--extract <tarfile> [<output_dir>]

如果未指定 output_dir 则会将 tarfile 提取到当前目录。

-t <tarfile>

--test <tarfile>

检测 tarfile 是否有效。

-v, --verbose

更详细地输出结果。

--filter <filtername>

为 --extract 指定 filter。 详情参见 解压缩过滤器。 只接受字符串名称 (包括 fully_trusted, tar 和 data)。

3.10.12 新版功能.

例子

如何将整个 tar 归档提取到当前工作目录:

import tarfile
tar = tarfile.open("sample.tar.gz")
tar.extractall()
tar.close()

如何通过 TarFile.extractall() 使用生成器函数而非列表来提取一个 tar 归档的子集:

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()

如何基于一个文件名列表创建未压缩的 tar 归档:

import tarfile
tar = tarfile.open("sample.tar", "w")
for name in ["foo", "bar", "quux"]:
    tar.add(name)
tar.close()

使用 with 语句的同一个示例:

import tarfile
with tarfile.open("sample.tar", "w") as tar:
    for name in ["foo", "bar", "quux"]:
        tar.add(name)

如何读取一个 gzip 压缩的 tar 归档并显示一些成员信息:

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()

如何创建一个归档并使用 TarFile.add() 中的 filter 形参来重置用户信息:

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()

受支持的 tar 格式

通过 tarfile 模块可以创建三种 tar 格式:

The POSIX.1-1988 ustar 格式 (USTAR_FORMAT)。 它支持最多 256 个字符的文件名长度和最多 100 个字符的链接名长度。 文件大小上限为 8 GiB。 这是一种老旧但广受支持的格式。

GNU tar 格式 (GNU_FORMAT)。 它支持长文件名和链接名、大于 8 GiB 的文件以及稀疏文件。 它是 GNU/Linux 系统上的事实标准。 tarfile 完全支持针对长名称的 GNU tar 扩展，稀疏文件支持则限制为只读。

POSIX.1-2001 pax 格式 (PAX_FORMAT)。 它是几乎无限制的最灵活格式。 它支持长文件名和链接名，大文件以及使用可移植方式存储路径名。 现代的 tar 实现，包括 GNU tar, bsdtar/libarchive 和 star，都完全支持扩展的 pax 特性；某些老旧或不再维护的库可能不支持，但应当会将 pax 归档视为广受支持的 ustar 格式。 它是当前新建归档的默认格式。

它扩展了现有的 ustar 格式，包括用于无法以其他方式存储的附加标头。 存在两种形式的 pax 标头：扩展标头只影响后续的文件标头，全局标头则适用于完整归档并会影响所有后续的文件。 为了便于移植，在 pax 标头中的所有数据均以 UTF-8 编码。

还有一些 tar 格式的其他变种，它们可以被读取但不能被创建:

古老的 V7 格式。 这是来自 Unix 第七版的第一个 tar 格式，它只存储常规文件和目录。 名称长度不能超过 100 个字符，并且没有用户/分组名信息。 某些归档在带有非 ASCII 字符字段的情况下会产生计算错误的标头校验和。

SunOS tar 扩展格式。 此格式是 POSIX.1-2001 pax 格式的一个变种，但并不保持兼容。

Unicode 问题

最初 tar 格式被设计用来在磁带机上生成备份，主要关注于保存文件系统信息。 现在 tar 归档通常用于文件分发和在网络上交换归档。 最初格式（它是所有其他格式的基础）的一个问题是它没有支持不同字符编码格式的概念。 例如，一个在 UTF-8 系统上创建的普通 tar 归档如果包含非 ASCII 字符则将无法在 Latin-1 系统上被正确读取。 文本元数据（例如文件名，链接名，用户/分组名）将变为损坏状态。 不幸的是，没有什么办法能够自动检测一个归档的编码格式。 pax 格式被设计用来解决这个问题。 它使用通用字符编码格式 UTF-8 来存储非 ASCII 元数据。

在 tarfile 中字符转换的细节由 TarFile 类的 encoding 和 errors 关键字参数控制。

encoding 定义了用于归档中元数据的字符编码格式。 默认值为 sys.getfilesystemencoding() 或是回退选项 'ascii'。 根据归档是被读取还是被写入，元数据必须被解码或编码。 如果没有正确设置 encoding，转换可能会失败。

errors 参数定义了不能被转换的字符将如何处理。 可能的取值在 错误处理方案 小节列出。 默认方案为 'surrogateescape'，它也被 Python 用于文件系统调用，参见 文件名，命令行参数，以及环境变量。。

对于 PAX_FORMAT 归档（默认格式），encoding 通常是不必要的，因为所有元数据都使用 UTF-8 来存储。 encoding 仅在解码二进制 pax 标头或存储带有替代字符的字符串等少数场景下会被使用。

文件格式

本章中描述的模块解析各种不是标记语言且与电子邮件无关的杂项文件格式。

csv --- CSV 文件读写

模块内容

变种与格式参数

Reader 对象

Writer 对象

例子

configparser --- 配置文件解析器

快速起步

支持的数据类型

回退值

受支持的 INI 文件结构

值的插值

映射协议访问

定制解析器行为

旧式 API 示例

ConfigParser 对象

RawConfigParser 对象

异常

netrc --- netrc 文件处理

netrc 对象

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

例子

csv --- CSV 文件读写

源代码： Lib/csv.py [https://github.com/python/cpython/tree/3.10/Lib/csv.py]

CSV (Comma Separated Values) 格式是电子表格和数据库中最常见的输入、输出文件格式。在 RFC 4180 [https://datatracker.ietf.org/doc/html/rfc4180.html] 规范推出的很多年前，CSV 格式就已经被开始使用了，由于当时并没有合理的标准，不同应用程序读写的数据会存在细微的差别。这种差别让处理多个来源的 CSV 文件变得困难。但尽管分隔符会变化，此类文件的大致格式是相似的，所以编写一个单独的模块以高效处理此类数据，将程序员从读写数据的繁琐细节中解放出来是有可能的。

csv 模块实现了 CSV 格式表单数据的读写。其提供了诸如“以兼容 Excel 的方式输出数据文件”或“读取 Excel 程序输出的数据文件”的功能，程序员无需知道 Excel 所采用 CSV 格式的细节。此模块同样可以用于定义其他应用程序可用的 CSV 格式或定义特定需求的 CSV 格式。

csv 模块中的 reader 类和 writer 类可用于读写序列化的数据。也可使用 DictReader 类和 DictWriter 类以字典的形式读写数据。

参见

该实现在“Python 增强提议” - PEP 305 (CSV 文件 API) 中被提出

《Python 增强提议》提出了对 Python 的这一补充。

模块内容

csv 模块定义了以下函数：

csv.reader(csvfile, dialect='excel', **fmtparams)

返回一个 reader 对象，该对象将逐行遍历 csvfile。csvfile 可以是任何对象，只要这个对象支持 iterator 协议并在每次调用 __next__() 方法时都返回字符串，文件对象 和列表对象均适用。如果 csvfile 是文件对象，则打开它时应使用 newline=''。 1 可选参数 dialect 是用于不同的 CSV 变种的特定参数组。它可以是 Dialect 类的子类的实例，也可以是 list_dialects() 函数返回的字符串之一。另一个可选关键字参数 fmtparams 可以覆写当前变种格式中的单个格式设置。有关变种和格式设置参数的完整详细信息，请参见 变种与格式参数 部分。

csv 文件的每一行都读取为一个由字符串组成的列表。除非指定了 QUOTE_NONNUMERIC 格式选项（在这种情况下，未加引号的字段会转换为浮点数），否则不会执行自动数据类型转换。

一个简短的用法示例:

>>> import csv
>>> with open('eggs.csv', newline='') 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

csv.writer(csvfile, dialect='excel', **fmtparams)

返回一个 writer 对象，该对象负责将用户的数据在给定的文件类对象上转换为带分隔符的字符串。 csvfile 可以是任何具有 write() 方法的对象。 如果 csvfile 是一个文件对象，则打开它时应使用 newline='' 1。 可以给出可选的 dialect 形参用来定义一组特定 CSV 变种专属的形参。 它可以是 Dialect 类的某个子类的实例或是 list_dialects() 函数所返回的字符串之一。 还可以给出另一个可选的 fmtparams 关键字参数来覆盖当前变种中的单个格式化形参。 有关各个变种和格式化形参的完整细节，请参阅 变种与格式参数 部分。 为了尽量简化与实现 DB API 的模块之间的接口，None 值会被当作空字符串写入。 虽然这个转换是不可逆的，但它可以简化 SQL NULL 数据值到 CSV 文件的转储而无需预处理从 cursor.fetch* 调用返回的数据。 在被写入之前所有其他非字符串数据都会先用 str() 来转转为字符串。

一个简短的用法示例:

import csv
with open('eggs.csv', 'w', newline='') 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'])

csv.register_dialect(name[, dialect[, **fmtparams]])

将 dialect 与 name 关联起来。 name 必须是字符串。 变种的指定可以通过传入一个 Dialect 的子类，或通过 fmtparams 关键字参数，或是两者同时传入，此时关键字参数会覆盖 dialect 形参。 有关变种和格式化形参的完整细节，请参阅 变种与格式参数 部分。

csv.unregister_dialect(name)

从变种注册表中删除 name 对应的变种。如果 name 不是已注册的变种名称，则抛出 Error 异常。

csv.get_dialect(name)

返回 name 对应的变种。如果 name 不是已注册的变种名称，则抛出 Error 异常。该函数返回的是不可变的 Dialect 对象。

csv.list_dialects()

返回所有已注册变种的名称。

csv.field_size_limit([new_limit])

返回解析器当前允许的最大字段大小。如果指定了 new_limit，则它将成为新的最大字段大小。

csv 模块定义了以下类：

class csv.DictReader(f, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)

创建一个对象，该对象在操作上类似于常规 reader，但是将每行中的信息映射到一个 dict，该 dict 的键由 fieldnames 可选参数给出。

fieldnames 参数是一个 sequence。如果省略 fieldnames，则文件 f 第一行中的值将用作字段名。无论字段名是如何确定的，字典都将保留其原始顺序。

如果某一行中的字段多于字段名，则剩余数据会被放入一个列表，并与 restkey 所指定的字段名 (默认为 None) 一起保存。 如果某个非空白行的字段少于字段名，则缺失的值会使用 restval 的值来填充 (默认为 None)。

所有其他可选或关键字参数都传递给底层的 reader 实例。

在 3.6 版更改: 返回的行现在的类型是 OrderedDict。

在 3.8 版更改: 现在，返回的行是 dict 类型。

一个简短的用法示例:

>>> import csv
>>> with open('names.csv', newline='') 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'}

class csv.DictWriter(f, fieldnames, restval='', extrasaction='raise', dialect='excel', *args, **kwds)

创建一个对象，该对象在操作上类似常规 writer，但会将字典映射到输出行。 fieldnames 参数是由键组成的 序列，它指定字典中值的顺序，这些值会按指定顺序传递给 writerow() 方法并写入文件 f。 如果字典缺少 fieldnames 中的键，则可选参数 restval 用于指定要写入的值。 如果传递给 writerow() 方法的字典的某些键在 fieldnames 中找不到，则可选参数 extrasaction 用于指定要执行的操作。 如果将其设置为默认值 'raise'，则会引发 ValueError。 如果将其设置为 'ignore'，则字典中的其他键值将被忽略。 所有其他可选或关键字参数都传递给底层的 writer 实例。

注意，与 DictReader 类不同，DictWriter 类的 fieldnames 参数不是可选参数。

一个简短的用法示例:

import csv

with open('names.csv', 'w', newline='') 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'})

class csv.Dialect

Dialect 类是一个容器类，其属性包含有如何处理双引号、空白符、分隔符等的信息。 由于缺少严格的 CSV 规格描述，不同的应用程序会产生略有差别的 CSV 数据。 Dialect 实例定义了 reader 和 writer 实例将具有怎样的行为。

所有可用的 Dialect 名称会由 list_dialects() 返回，并且它们可由特定的 reader 和 writer 类通过它们的初始化函数 (__init__) 来注册，例如:

import csv

with open('students.csv', 'w', newline='') as csvfile:
    writer = csv.writer(csvfile, dialect='unix')
                                 ^^^^^^^^^^^^^^

class csv.excel

excel 类定义了 Excel 生成的 CSV 文件的常规属性。它在变种注册表中的名称是 'excel'。

class csv.excel_tab

excel_tab 类定义了 Excel 生成的、制表符分隔的 CSV 文件的常规属性。它在变种注册表中的名称是 'excel-tab'。

class csv.unix_dialect

unix_dialect 类定义了在 UNIX 系统上生成的 CSV 文件的常规属性，即使用 '\n' 作为换行符，且所有字段都有引号包围。它在变种注册表中的名称是 'unix'。

3.2 新版功能.

class csv.Sniffer

Sniffer 类用于推断 CSV 文件的格式。

Sniffer 类提供了两个方法：

sniff(sample, delimiters=None)

分析给定的 sample 并返回一个 Dialect 子类，该子类中包含了分析出的格式参数。如果给出可选的 delimiters 参数，则该参数会被解释为字符串，该字符串包含了可能的有效定界符。

has_header(sample)

分析 sample 文本（假定为 CSV 格式），如果发现其首行为一组列标题则返回 True。 在检查每一列时，将考虑是否满足两个关键标准之一来估计 sample 是否包含标题:

第二至第 n 行包含数字值

第二至第 n 行包含字符串值，其中至少有一个值的长度与该列预期标题的长度不同。

会对第一行之后的二十行进行采样；如果有超过一半的列 + 行符合标准，则返回 True。

注解

此方法是一个粗略的启发式方式，有可能产生错误的真值和假值。

使用 Sniffer 的示例：

with open('example.csv', newline='') as csvfile:
    dialect = csv.Sniffer().sniff(csvfile.read(1024))
    csvfile.seek(0)
    reader = csv.reader(csvfile, dialect)
    # ... process CSV file contents here ...

csv 模块定义了以下常量：

csv.QUOTE_ALL

指示 writer 对象给所有字段加上引号。

csv.QUOTE_MINIMAL

指示 writer 对象仅为包含特殊字符（例如 定界符、引号字符 或 行结束符 中的任何字符）的字段加上引号。

csv.QUOTE_NONNUMERIC

指示 writer 对象为所有非数字字段加上引号。

指示 reader 将所有未用引号引出的字段转换为 float 类型。

csv.QUOTE_NONE

指示 writer 对象不使用引号引出字段。当 定界符 出现在输出数据中时，其前面应该有 转义符。如果未设置 转义符，则遇到任何需要转义的字符时，writer 都会抛出 Error 异常。

指示 reader 不对引号字符进行特殊处理。

csv 模块定义了以下异常：

exception csv.Error

该异常可能由任何发生错误的函数抛出。

变种与格式参数

为了更容易指定输入和输出记录的格式，特定的一组格式参数组合为一个 dialect（变种）。一个 dialect 是一个 Dialect 类的子类，它具有一组特定的方法和一个 validate() 方法。创建 reader 或 writer 对象时，程序员可以将某个字符串或 Dialect 类的子类指定为 dialect 参数。要想补充或覆盖 dialect 参数，程序员还可以单独指定某些格式参数，这些参数的名称与下面 Dialect 类定义的属性相同。

Dialect 类支持以下属性：

Dialect.delimiter

一个用于分隔字段的单字符，默认为 ','。

Dialect.doublequote

控制出现在字段中的 引号字符 本身应如何被引出。当该属性为 True 时，双写引号字符。如果该属性为 False，则在 引号字符 的前面放置 转义符。默认值为 True。

在输出时，如果 doublequote 是 False，且 转义符 未指定，且在字段中发现 引号字符 时，会抛出 Error 异常。

Dialect.escapechar

一个用于 writer 的单字符，用来在 quoting 设置为 QUOTE_NONE 的情况下转义 定界符，在 doublequote 设置为 False 的情况下转义 引号字符。在读取时，escapechar 去除了其后所跟字符的任何特殊含义。该属性默认为 None，表示禁用转义。

Dialect.lineterminator

放在 writer 产生的行的结尾，默认为 '\r\n'。

注解

reader 经过硬编码，会识别 '\r' 或 '\n' 作为行尾，并忽略 lineterminator。未来可能会更改这一行为。

Dialect.quotechar

一个单字符，用于包住含有特殊字符的字段，特殊字符如 定界符 或 引号字符 或换行符。默认为 '"'。

Dialect.quoting

控制 writer 何时生成引号，以及 reader 何时识别引号。该属性可以等于任何 QUOTE_* 常量（参见 模块内容 段落），默认为 QUOTE_MINIMAL。

Dialect.skipinitialspace

当为 True 时，紧接在 delimiter 之后空格会被忽略。 默认值为 False。

Dialect.strict

如果为 True，则在输入错误的 CSV 时抛出 Error 异常。默认值为 False。

Reader 对象

Reader 对象（DictReader 实例和 reader() 函数返回的对象）具有以下公开方法：

csvreader.__next__()

返回 reader 的可迭代对象的下一行，它可以是一个列表（如果对象是由 reader() 返回）或字典（如果是一个 DictReader 实例），根据当前 Dialect 来解析。 通常你应当以 next(reader) 的形式来调用它。

Reader 对象具有以下公开属性：

csvreader.dialect

变种描述，只读，供解析器使用。

csvreader.line_num

源迭代器已经读取了的行数。它与返回的记录数不同，因为记录可能跨越多行。

DictReader 对象具有以下公开属性：

DictReader.fieldnames

字段名称。如果在创建对象时未传入字段名称，则首次访问时或从文件中读取第一条记录时会初始化此属性。

Writer 对象

Writer 对象（DictWriter 实例和 writer() 函数返回的对象）具有下面的公开方法。对于 Writer 对象，行 必须是（一组可迭代的）字符串或数字。对于 DictWriter 对象，行 必须是一个字典，这个字典将字段名映射为字符串或数字（数字要先经过 str() 转换类型）。请注意，输出的复数会有括号包围。这样其他程序读取 CSV 文件时可能会有一些问题（假设它们完全支持复数）。

csvwriter.writerow(row)

将 row 形参写入到 writer 的文件对象，根据当前 Dialect 进行格式化。 返回对下层文件对象的 write 方法的调用的返回值。

在 3.5 版更改: 开始支持任意类型的迭代器。

csvwriter.writerows(rows)

将 rows*（即能迭代出多个上述 *row 对象的迭代器）中的所有元素写入 writer 的文件对象，并根据当前设置的变种进行格式化。

Writer 对象具有以下公开属性：

csvwriter.dialect

变种描述，只读，供 writer 使用。

DictWriter 对象具有以下公开方法：

DictWriter.writeheader()

在 writer 的文件对象中，写入一行字段名称（字段名称在构造函数中指定），并根据当前设置的变种进行格式化。本方法的返回值就是内部使用的 csvwriter.writerow() 方法的返回值。

3.2 新版功能.

在 3.8 版更改: 现在 writeheader() 也返回其内部使用的 csvwriter.writerow() 方法的返回值。

例子

读取 CSV 文件最简单的一个例子:

import csv
with open('some.csv', newline='') as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)

读取其他格式的文件:

import csv
with open('passwd', newline='') as f:
    reader = csv.reader(f, delimiter=':', quoting=csv.QUOTE_NONE)
    for row in reader:
        print(row)

相应最简单的写入示例是:

import csv
with open('some.csv', 'w', newline='') as f:
    writer = csv.writer(f)
    writer.writerows(someiterable)

由于使用 open() 来读取 CSV 文件，因此默认情况下，将使用系统默认编码来解码文件并转换为 unicode（请参阅 locale.getpreferredencoding()）。要使用其他编码来解码文件，请使用 open 的 encoding 参数:

import csv
with open('some.csv', newline='', encoding='utf-8') as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)

这同样适用于写入非系统默认编码的内容：打开输出文件时，指定 encoding 参数。

注册一个新的变种:

import csv
csv.register_dialect('unixpwd', delimiter=':', quoting=csv.QUOTE_NONE)
with open('passwd', newline='') as f:
    reader = csv.reader(f, 'unixpwd')

Reader 的更高级用法——捕获并报告错误:

import csv, sys
filename = 'some.csv'
with open(filename, newline='') as f:
    reader = csv.reader(f)
    try:
        for row in reader:
            print(row)
    except csv.Error as e:
        sys.exit('file {}, line {}: {}'.format(filename, reader.line_num, e))

尽管该模块不直接支持解析字符串，但仍可如下轻松完成:

import csv
for row in csv.reader(['one,two,three']):
    print(row)

备注

1(1,2)

如果没有指定 newline=''，则嵌入引号中的换行符将无法正确解析，并且在写入时，使用 \r\n 换行的平台会有多余的 \r 写入。由于 csv 模块会执行自己的（通用）换行符处理，因此指定 newline='' 应该总是安全的。

configparser --- 配置文件解析器

源代码: Lib/configparser.py [https://github.com/python/cpython/tree/3.10/Lib/configparser.py]

此模块提供了它实现一种基本配置语言 ConfigParser 类，这种语言所提供的结构与 Microsoft Windows INI 文件的类似。 你可以使用这种语言来编写能够由最终用户来自定义的 Python 程序。

注解

这个库 并不 能够解析或写入在 Windows Registry 扩展版本 INI 语法中所使用的值-类型前缀。

参见

模块 shlex

支持创建可被用作应用配置文件的替代的 Unix 终端式微语言。

模块 json

json 模块实现了一个 JavaScript 语法的子集，它也可被用于这种目的。

快速起步

让我们准备一个非常基本的配置文件，它看起来是这样的:

[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes

[forge.example]
User = hg

[topsecret.server.example]
Port = 50022
ForwardX11 = no

INI 文件的结构描述见 以下章节。 总的来说，这种文件由多个节组成，每个节包含多个带有值的键。 configparser 类可以读取和写入这种文件。 让我们先通过程序方式来创建上述的配置文件。

>>> 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'     # mutates the parser
>>> topsecret['ForwardX11'] = 'no'  # same here
>>> config['DEFAULT']['ForwardX11'] = 'yes'
>>> with open('example.ini', 'w') as configfile:
...   config.write(configfile)
...

如你所见，我们可以把配置解析器当作一个字典来处理。 两者确实存在差异，将在后文说明，但是其行为非常接近于字典所具有一般行为。

现在我们已经创建并保存了一个配置文件，让我们再将它读取出来并探究其中包含的数据。

>>> 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'

正如我们在上面所看到的，相关的 API 相当直观。 唯一有些神奇的地方是 DEFAULT 小节，它为所有其他小节提供了默认值 1。 还要注意小节中的键大小写不敏感并且会存储为小写形式 1。

将多个配置读入单个 ConfigParser 是可能的，其中最近添加的配置具有最高优先级。 任何冲突的键都会从更近的配置获取并且先前存在的键会被保留。

>>> another_config = configparser.ConfigParser()
>>> another_config.read('example.ini')
['example.ini']
>>> another_config['topsecret.server.example']['Port']
'50022'
>>> another_config.read_string("[topsecret.server.example]\nPort=48484")
>>> another_config['topsecret.server.example']['Port']
'48484'
>>> another_config.read_dict({"topsecret.server.example": {"Port": 21212}})
>>> another_config['topsecret.server.example']['Port']
'21212'
>>> another_config['topsecret.server.example']['ForwardX11']
'no'

此行为等价于一次 ConfigParser.read() 调用并向 filenames 形参传入多个文件。

支持的数据类型

配置解析器并不会猜测配置文件中值的类型，而总是将它们在内部存储为字符串。 这意味着如果你需要其他数据类型，你应当自己来转换:

>>> int(topsecret['Port'])
50022
>>> float(topsecret['CompressionLevel'])
9.0

由于这种任务十分常用，配置解析器提供了一系列便捷的获取方法来处理整数、浮点数和布尔值。 最后一个类型的处理最为有趣，因为简单地将值传给 bool() 是没有用的，bool('False') 仍然会是 True。 为解决这个问题配置解析器还提供了 getboolean()。 这个方法对大小写不敏感并可识别 'yes'/'no', 'on'/'off', 'true'/'false' 和 '1'/'0' 1 等布尔值。 例如:

>>> topsecret.getboolean('ForwardX11')
False
>>> config['forge.example'].getboolean('ForwardX11')
True
>>> config.getboolean('forge.example', 'Compression')
True

除了 getboolean()，配置解析器还提供了同类的 getint() 和 getfloat() 方法。 你可以注册你自己的转换器并或是定制已提供的转换器。 1

回退值

与字典类似，你可以使用某个小节的 get() 方法来提供回退值:

>>> topsecret.get('Port')
'50022'
>>> topsecret.get('CompressionLevel')
'9'
>>> topsecret.get('Cipher')
>>> topsecret.get('Cipher', '3des-cbc')
'3des-cbc'

请注意默认值会优先于回退值。 例如，在我们的示例中 'CompressionLevel' 键仅在 'DEFAULT' 小节中被指定。 如果我们尝试从 'topsecret.server.example' 小节获取它，我们将总是会得到默认值，即使我们指定了一个回退值:

>>> topsecret.get('CompressionLevel', '3')
'9'

还需要注意的一点是解析器层级的 get() 方法提供了自定义的更复杂接口，它被维护用于向下兼容。 当使用此方法时，回退值可以通过 fallback 仅限关键字参数来提供:

>>> config.get('forge.example', 'monster',
...            fallback='No such things as monsters')
'No such things as monsters'

同样的 fallback 参数也可在 getint(), getfloat() 和 getboolean() 方法中使用，例如:

>>> 'BatchMode' in topsecret
False
>>> topsecret.getboolean('BatchMode', fallback=True)
True
>>> config['DEFAULT']['BatchMode'] = 'no'
>>> topsecret.getboolean('BatchMode', fallback=True)
False

受支持的 INI 文件结构

配置文件是由小节组成的，每个小节都有一个 [section] 标头，加上多个由特定字符串 (默认为 = 或 : 1) 分隔的键/值条目。 在默认情况下，小节名对大小写敏感而键对大小写不敏感 1。 键和值开头和末尾的空格会被移除。 在解释器配置允许时值可以被省略 1，在此情况下键/值分隔符也可以被省略。 值还可以跨越多行，只要值的其他行带有比第一行更深的缩进。 依据解析器的具体模式，空白行可能会被视为多行值的组成部分或是被忽略。

在默认情况下，有效的节名称可以是不包含 '\n' 或 ']' 的任意字符串。 要改变此设定，请参阅 ConfigParser.SECTCRE。

配置文件可以包含注释，要带有指定字符前缀 (默认为 # 和 ; 1)。 注释可以单独出现于原本的空白行，并可使用缩进。 1

例如:

[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?

值的插值

在核心功能之上，ConfigParser 还支持插值。 这意味着值可以在被 get() 调用返回之前进行预处理。

class configparser.BasicInterpolation

默认实现由 ConfigParser 来使用。 它允许值包含引用了相同小节中其他值或者特殊的默认小节中的值的格式字符串 1。 额外的默认值可以在初始化时提供。

例如:

[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%%

在上面的例子里，ConfigParser 的 interpolation 设为 BasicInterpolation()，这会将 %(home_dir)s 求解为 home_dir 的值 (在这里是 /Users)。 %(my_dir)s 的将被实际求解为 /Users/lumberjack。 所有插值都是按需进行的，这样引用链中使用的键不必以任何特定顺序在配置文件中指明。

当 interpolation 设为 None 时，解析器会简单地返回 %(my_dir)s/Pictures 作为 my_pictures 的值，并返回 %(home_dir)s/lumberjack 作为 my_dir 的值。

class configparser.ExtendedInterpolation

一个用于插值的替代处理程序实现了更高级的语法，它被用于 zc.buildout 中的实例。 扩展插值使用 ${section:option} 来表示来自外部小节的值。 插值可以跨越多个层级。 为了方便使用，section: 部分可被省略，插值会默认作用于当前小节（可能会从特殊小节获取默认值）。

例如，上面使用基本插值描述的配置，使用扩展插值将是这个样子:

[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

来自其他小节的值也可以被获取:

[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}

映射协议访问

3.2 新版功能.

映射协议访问这个通用名称是指允许以字典的方式来使用自定义对象的功能。 在 configparser 中，映射接口的实现使用了 parser['section']['option'] 标记法。

parser['section'] 专门为解析器中的小节数据返回一个代理。 这意味着其中的值不会被拷贝，而是在需要时从原始解析器中获取。 更为重要的是，当值在小节代理上被修改时，它们其实是在原始解析器中发生了改变。

configparser 对象的行为会尽可能地接近真正的字典。 映射接口是完整而且遵循 MutableMapping ABC 规范的。 但是，还是有一些差异应当被纳入考虑:

默认情况下，小节中的所有键是以大小写不敏感的方式来访问的 1。 例如 for option in parser["section"] 只会产生 optionxform 形式的选项键名称。 也就是说默认使用小写字母键名。 与此同时，对于一个包含键 'a' 的小节，以下两个表达式均将返回 True:

"a" in parser["section"]
"A" in parser["section"]

所有小节也包括 DEFAULTSECT，这意味着对一个小节执行 .clear() 可能无法使得该小节显示为空。 这是因为默认值是无法从小节中被删除的（因为从技术上说它们并不在那里）。 如果它们在小节中被覆盖，删除将导致默认值重新变为可见。 尝试删除默认值将会引发 KeyError。

DEFAULTSECT 无法从解析器中被移除:

尝试删除将引发 ValueError，

parser.clear() 会保留其原状，

parser.popitem() 绝不会将其返回。

parser.get(section, option, **kwargs) - 第二个参数 并非 回退值。 但是请注意小节层级的 get() 方法可同时兼容映射协议和经典配置解析器 API。

parser.items() 兼容映射协议（返回 section_name, section_proxy 对的列表，包括 DEFAULTSECT）。 但是，此方法也可以附带参数被唤起: parser.items(section, raw, vars)。 这种调用形式返回指定 section 的 option, value 对的列表，将展开所有插值（除非提供了 raw=True 选项）。

映射协议是在现有的传统 API 之上实现的，以便重写原始接口的子类仍然具有符合预期的有效映射。

定制解析器行为

INI 格式的变种数量几乎和使用此格式的应用一样多。 configparser 花费了很大力气来为尽量大范围的可用 INI 样式提供支持。 默认的可用功能主要由历史状况来确定，你很可能会想要定制某些特性。

改变特定配置解析器行为的最常见方式是使用 __init__() 选项:

defaults，默认值: None

此选项接受一个键值对的字典，它将被首先放入 DEFAULT 小节。 这实现了一种优雅的方式来支持简洁的配置文件，它不必指定与已记录的默认值相同的值。

提示：如果你想要为特定的小节指定默认的值，请在读取实际文件之前使用 read_dict()。

dict_type，默认值: dict

此选项主要影响映射协议的行为和写入配置文件的外观。 使用标准字典时，每个小节是按照它们被加入解析器的顺序保存的。 在小节内的选项也是如此。

还有其他替换的字典类型可以使用，例如在写回数据时对小节和选项进行排序。

请注意：存在其他方式只用一次操作来添加键值对的集合。 当你在这些操作中使用一个常规字典时，键将按顺序进行排列。 例如:

>>> 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']

allow_no_value，默认值: False

已知某些配置文件会包括不带值的设置，但其在其他方面均符合 configparser 所支持的语法。 构造器的 allow_no_value 形参可用于指明应当接受这样的值:

>>> 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)

>>> # Settings with values are treated as before:
>>> config["mysqld"]["user"]
'mysql'

>>> # Settings without values provide None:
>>> config["mysqld"]["skip-bdb"]

>>> # Settings which aren't specified still raise an error:
>>> config["mysqld"]["does-not-exist"]
Traceback (most recent call last):
  ...
KeyError: 'does-not-exist'

delimiters，默认值: ('=', ':')

分隔符是用于在小节内分隔键和值的子字符串。 在一行中首次出现的分隔子字符串会被视为一个分隔符。 这意味着值可以包含分隔符（但键不可以）。

另请参见 ConfigParser.write() 的 space_around_delimiters 参数。

comment_prefixes，默认值: ('#', ';')

inline_comment_prefixes，默认值: None

注释前缀是配置文件中用于标示一条有效注释的开头的字符串。 comment_prefixes 仅用在被视为空白的行（可以缩进）之前而 inline_comment_prefixes 可用在每个有效值之后（例如小节名称、选项以及空白的行）。 默认情况下禁用行内注释，并且 '#' 和 ';' 都被用作完整行注释的前缀。

在 3.2 版更改: 在之前的 configparser 版本中行为匹配 comment_prefixes=('#',';') 和 inline_comment_prefixes=(';',)。

请注意配置解析器不支持对注释前缀的转义，因此使用 inline_comment_prefixes 可能妨碍用户将被用作注释前缀的字符指定为可选值。 当有疑问时，请避免设置 inline_comment_prefixes。 在许多情况下，在多行值的一行开头存储注释前缀字符的唯一方式是进行前缀插值，例如:

>>> 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

strict，默认值: True

当设为 True 时，解析器在从单一源读取 (使用 read_file(), read_string() 或 read_dict()) 期间将不允许任何小节或选项出现重复。 推荐在新的应用中使用严格解析器。

在 3.2 版更改: 在之前的 configparser 版本中行为匹配 strict=False。

empty_lines_in_values，默认值: True

在配置解析器中，值可以包含多行，只要它们的缩进级别低于它们所对应的键。 默认情况下解析器还会将空行视为值的一部分。 于此同时，键本身也可以任意缩进以提升可读性。 因此，当配置文件变得非常庞大而复杂时，用户很容易失去对文件结构的掌控。 例如:

[Section]
key = multiline
  value with a gotcha

 this = is still a part of the multiline value of 'key'

在用户查看时这可能会特别有问题，如果她是使用比例字体来编辑文件的话。 这就是为什么当你的应用不需要带有空行的值时，你应该考虑禁用它们。 这将使得空行每次都会作为键之间的分隔。 在上面的示例中，空行产生了两个键，key 和 this。

default_section，默认值: configparser.DEFAULTSECT (即: "DEFAULT")

允许设置一个保存默认值的特殊节在其他节或插值等目的中使用的惯例是这个库所拥有的一个强大概念，使得用户能够创建复杂的声明性配置。 这种特殊节通常称为 "DEFAULT" 但也可以被定制为指向任何其他有效的节名称。 一些典型的值包括: "general" 或 "common"。 所提供的名称在从任意节读取的时候被用于识别默认的节，而且也会在将配置写回文件时被使用。 它的当前值可以使用 parser_instance.default_section 属性来获取，并且可以在运行时被修改（即将文件从一种格式转换为另一种格式）。

interpolation，默认值: configparser.BasicInterpolation

插值行为可以用通过提供 interpolation 参数提供自定义处理程序的方式来定制。 None 可用来完全禁用插值，ExtendedInterpolation() 提供了一种更高级的变体形式，它的设计受到了 zc.buildout 的启发。 有关该主题的更多信息请参见 专门的文档章节。 RawConfigParser 具有默认的值 None。

converters，默认值: 不设置

配置解析器提供了可选的值获取方法用来执行类型转换。 默认实现包括 getint(), getfloat() 以及 getboolean()。 如果还需要其他获取方法，用户可以在子类中定义它们，或者传入一个字典，其中每个键都是一个转换器的名称而每个值都是一个实现了特定转换的可调用对象。 例如，传入 {'decimal': decimal.Decimal} 将对解释器对象和所有节代理添加 getdecimal()。 换句话说，可以同时编写 parser_instance.getdecimal('section', 'key', fallback=0) 和 parser_instance['section'].getdecimal('key', 0)。

如果转换器需要访问解析器的状态，可以在配置解析器子类上作为一个方法来实现。 如果该方法的名称是以 get 打头的，它将在所有节代理上以兼容字典的形式提供（参见上面的 getdecimal() 示例）。

更多高级定制选项可通过重写这些解析器属性的默认值来达成。 默认值是在类中定义的，因此它们可以通过子类或属性赋值来重写。

ConfigParser.BOOLEAN_STATES

默认情况下当使用 getboolean() 时，配置解析器会将下列值视为 True: '1', 'yes', 'true', 'on' 而将下列值视为 False: '0', 'no', 'false', 'off'。 你可以通过指定一个自定义的字符串键及其对应的布尔值字典来覆盖此行为。 例如:

>>> 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

其他典型的布尔值对包括 accept/reject 或 enabled/disabled。

ConfigParser.optionxform(option)

这个方法会转换每次 read, get, 或 set 操作的选项名称。 默认会将名称转换为小写形式。 这也意味着当一个配置文件被写入时，所有键都将为小写形式。 如果此行为不合适则要重写此方法。 例如:

>>> 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']

注解

optionxform 函数会将选项名称转换为规范形式。 这应该是一个幂等函数：如果名称已经为规范形式，则应不加修改地将其返回。

ConfigParser.SECTCRE

一个已编译正则表达式会被用来解析节标头。 默认将 [section] 匹配到名称 "section"。 空格会被视为节名称的一部分，因此 [  larch  ] 将被读取为一个名称为 "  larch  " 的节。 如果此行为不合适则要覆盖此属性。 例如:

>>> 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']

注解

虽然 ConfigParser 对象也使用 OPTCRE 属性来识别选项行，但并不推荐重写它，因为这会与构造器选项 allow_no_value 和 delimiters 产生冲突。

旧式 API 示例

主要出于向下兼容性的考虑，configparser 还提供了一种采用显式 get/set 方法的旧式 API。 虽然以下介绍的方法存在有效的用例，但对于新项目仍建议采用映射协议访问。 旧式 API 在多数时候都更复杂、更底层并且完全违反直觉。

一个写入配置文件的示例:

import configparser

config = configparser.RawConfigParser()

# Please note that using RawConfigParser's set functions, you can assign
# non-string values to keys internally, but will receive an error when
# attempting to write to a file or when you get it in non-raw mode. Setting
# values using the mapping protocol or ConfigParser's set() does not allow
# such assignments to take place.
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!')

# Writing our configuration file to 'example.cfg'
with open('example.cfg', 'w') as configfile:
    config.write(configfile)

一个再次读取配置文件的示例:

import configparser

config = configparser.RawConfigParser()
config.read('example.cfg')

# getfloat() raises an exception if the value is not a float
# getint() and getboolean() also do this for their respective types
a_float = config.getfloat('Section1', 'a_float')
an_int = config.getint('Section1', 'an_int')
print(a_float + an_int)

# Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'.
# This is because we are using a RawConfigParser().
if config.getboolean('Section1', 'a_bool'):
    print(config.get('Section1', 'foo'))

要获取插值，请使用 ConfigParser:

import configparser

cfg = configparser.ConfigParser()
cfg.read('example.cfg')

# Set the optional *raw* argument of get() to True if you wish to disable
# interpolation in a single get operation.
print(cfg.get('Section1', 'foo', raw=False))  # -> "Python is fun!"
print(cfg.get('Section1', 'foo', raw=True))   # -> "%(bar)s is %(baz)s!"

# The optional *vars* argument is a dict with members that will take
# precedence in interpolation.
print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation',
                                       'baz': 'evil'}))

# The optional *fallback* argument can be used to provide a fallback value
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."

# A bare print(cfg.get('Section1', 'monster')) would raise NoOptionError
# but we can also use:

print(cfg.get('Section1', 'monster', fallback=None))
      # -> None

默认值在两种类型的 ConfigParser 中均可用。 它们将在当某个选项未在别处定义时被用于插值。

import configparser

# New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each
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!"

ConfigParser 对象

class 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={})

主配置解析器。 当给定 defaults 时，它会被初始化为包含固有默认值的字典。 当给定 dict_type 时，它将被用来创建包含节、节中的选项以及默认值的字典。

当给定 delimiters 时，它会被用作分隔键与值的子字符串的集合。 当给定 comment_prefixes 时，它将被用作在否则为空行的注释的前缀子字符串的集合。 注释可以被缩进。 当给定 inline_comment_prefixes 时，它将被用作非空行的注释的前缀子字符串的集合。

当 strict 为 True (默认值) 时，解析器在从单个源（文件、字符串或字典）读取时将不允许任何节或选项出现重复，否则会引发 DuplicateSectionError 或 DuplicateOptionError。 当 empty_lines_in_values 为 False (默认值: True) 时，每个空行均表示一个选项的结束。 在其他情况下，一个多行选项内部的空行会被保留为值的一部分。 当 allow_no_value 为 True (默认值: False) 时，将接受没有值的选项；此种选项的值将为 None 并且它们会以不带末尾分隔符的形式被序列化。

当给定 default_section 时，它将指定存放其他节的默认值和用于插值的特殊节的名称 (通常命名为 "DEFAULT")。 该值可通过使用 default_section 实例属性在运行时被读取或修改。

插值行为可通过给出 interpolation 参数提供自定义处理程序的方式来定制。 None 可用来完全禁用插值，ExtendedInterpolation() 提供了一种更高级的变体形式，它的设计受到了 zc.buildout 的启发。 有关该主题的更多信息请参见 专门的文档章节。

插值中使用的所有选项名称将像任何其他选项名称引用一样通过 optionxform() 方法来传递。 例如，使用 optionxform() 的默认实现（它会将选项名称转换为小写形式）时，值 foo %(bar)s 和 foo %(BAR)s 是等价的。

当给定 converters 时，它应当为一个字典，其中每个键代表一个类型转换器的名称而每个值则为实现从字符串到目标数据类型的转换的可调用对象。 每个转换器会获得其在解析器对象和节代理上对应的 get*() 方法。

在 3.1 版更改: 默认的 dict_type 为 collections.OrderedDict。

在 3.2 版更改: 添加了 allow_no_value, delimiters, comment_prefixes, strict, empty_lines_in_values, default_section 以及 interpolation。

在 3.5 版更改: 添加了 converters 参数。

在 3.7 版更改: defaults 参数会通过 read_dict() 来读取，提供全解析器范围内一致的行为：非字符串类型的键和值会被隐式地转换为字符串。

在 3.8 版更改: 默认的 dict_type 为 dict，因为它现在会保留插入顺序。

defaults()

返回包含实例范围内默认值的字典。

sections()

返回可用节的列表；default section 不包括在该列表中。

add_section(section)

向实例添加一个名为 section 的节。 如果给定名称的节已存在，将会引发 DuplicateSectionError。 如果传入了 default section 名称，则会引发 ValueError。 节名称必须为字符串；如果不是则会引发 TypeError。

在 3.2 版更改: 非字符串的节名称将引发 TypeError。

has_section(section)

指明相应名称的 section 是否存在于配置中。 default section 不包含在内。

options(section)

返回指定 section 中可用选项的列表。

has_option(section, option)

如果给定的 section 存在并且包含给定的 option 则返回 True；否则返回 False。 如果指定的 section 为 None 或空字符串，则会使用 DEFAULT。

read(filenames, encoding=None)

尝试读取并解析一个包含文件名的可迭代对象，返回一个被成功解析的文件名列表。

如果 filenames 为字符串、bytes 对象或 path-like object，它会被当作单个文件来处理。 如果 filenames 中名称对应的某个文件无法被打开，该文件将被忽略。 这样的设计使得你可以指定包含多个潜在配置文件位置的可迭代对象（例如当前目录、用户家目录以及某个系统级目录），存在于该可迭代对象中的所有配置文件都将被读取。

如果名称对应的文件全都不存在，则 ConfigParser 实例将包含一个空数据集。 一个要求从文件加载初始值的应用应当在调用 read() 来获取任何可选文件之前使用 read_file() 来加载所要求的一个或多个文件:

import configparser, os

config = configparser.ConfigParser()
config.read_file(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
            encoding='cp1250')

3.2 新版功能: encoding 形参。 在之前的版本中，所有文件都将使用 open() 的默认编码格式来读取。

3.6.1 新版功能: filenames 形参接受一个 path-like object。

3.7 新版功能: filenames 形参接受一个 bytes 对象。

read_file(f, source=None)

从 f 读取并解析配置数据，它必须是一个产生 Unicode 字符串的可迭代对象（例如以文本模式打开的文件）。

可选参数 source 指定要读取的文件名称。 如果未给出并且 f 具有 name 属性，则该属性会被用作 source；默认值为 '<???>'。

3.2 新版功能: 替代 readfp()。

read_string(string, source='<string>')

从字符串中解析配置数据。

可选参数 source 指定一个所传入字符串的上下文专属名称。 如果未给出，则会使用 '<string>'。 这通常应为一个文件系统路径或 URL。

3.2 新版功能.

read_dict(dictionary, source='<dict>')

从任意一个提供了类似于字典的 items() 方法的对象加载配置。 键为节名称，值为包含节中所出现的键和值的字典。 如果所用的字典类型会保留顺序，则节和其中的键将按顺序加入。 值会被自动转换为字符串。

可选参数 source 指定一个所传入字典的上下文专属名称。 如果未给出，则会使用 <dict>。

此方法可被用于在解析器之间拷贝状态。

3.2 新版功能.

get(section, option, *, raw=False, vars=None[, fallback])

获取指定名称的 section 的一个 option 的值。 如果提供了 vars，则它必须为一个字典。 option 的查找顺序为 vars*（如果有提供）、*section 以及 DEFAULTSECT。 如果未找到该键并且提供了 fallback，则它会被用作回退值。 可以提供 None 作为 fallback 值。

所有 '%' 插值会在返回值中被展开，除非 raw 参数为真值。 插值键所使用的值会按与选项相同的方式来查找。

在 3.2 版更改: raw, vars 和 fallback 都是仅限关键字参数，以防止用户试图使用第三个参数作业为 fallback 回退值（特别是在使用映射 协议的时候）。

getint(section, option, *, raw=False, vars=None[, fallback])

将在指定 section 中的 option 强制转换为整数的便捷方法。 参见 get() 获取对于 raw, vars 和 fallback 的解释。

getfloat(section, option, *, raw=False, vars=None[, fallback])

将在指定 section 中的 option 强制转换为浮点数的便捷方法。 参见 get() 获取对于 raw, vars 和 fallback 的解释。

getboolean(section, option, *, raw=False, vars=None[, fallback])

将在指定 section 中的 option 强制转换为布尔值的便捷方法。 请注意选项所接受的值为 '1', 'yes', 'true' 和 'on'，它们会使得此方法返回 True，以及 '0', 'no', 'false' 和 'off'，它们会使得此方法返回 False。 这些字符串值会以对大小写不敏感的方式被检测。 任何其他值都将导致引发 ValueError。 参见 get() 获取对于 raw, vars 和 fallback 的解释。

items(raw=False, vars=None)

items(section, raw=False, vars=None)

当未给出 section 时，将返回由 section_name, section_proxy 对组成的列表，包括 DEFAULTSECT。

在其他情况下，将返回给定的 section 中的 option 的 name, value 对组成的列表。 可选参数具有与 get() 方法的参数相同的含义。

在 3.8 版更改: vars 中的条目将不在结果中出现。 之前的行为混淆了实际的解析器选项和为插值提供的变量。

set(section, option, value)

如果给定的节存在，则将所给出的选项设为指定的值；在其他情况下将引发 NoSectionError。 option 和 value 必须为字符串；如果不是则将引发 TypeError。

write(fileobject, space_around_delimiters=True)

将配置的表示形式写入指定的 file object，该对象必须以文本模式打开（接受字符串）。 此表示形式可由将来的 read() 调用进行解析。 如果 space_around_delimiters 为真值，键和值之前的分隔符两边将加上空格。

注解

原始配置文件中的注释在写回配置时不会被保留。 具体哪些会被当作注释，取决于为 comment_prefix 和 inline_comment_prefix 所指定的值。

remove_option(section, option)

将指定的 option 从指定的 section 中移除。 如果指定的节不存在则会引发 NoSectionError。 如果要移除的选项存在则返回 True；在其他情况下将返回 False。

remove_section(section)

从配置中移除指定的 section。 如果指定的节确实存在则返回 True。 在其他情况下将返回 False。

optionxform(option)

将选项名 option 转换为输入文件中的形式或客户端代码所传入的应当在内部结构中使用的形式。 默认实现将返回 option 的小写形式版本；子类可以重写此行为，或者客户端代码也可以在实例上设置一个具有此名称的属性来影响此行为。

你不需要子类化解析器来使用此方法，你也可以在一个实例上设置它，或使用一个接受字符串参数并返回字符串的函数。 例如将它设为 str 将使得选项名称变得大小写敏感:

cfgparser = ConfigParser()
cfgparser.optionxform = str

请注意当读取配置文件时，选项名称两边的空格将在调用 optionxform() 之前被去除。

readfp(fp, filename=None)

3.2 版后已移除: 使用 read_file() 来代替。

在 3.2 版更改: readfp() 现在将在 fp 上执行迭代而不是调用 fp.readline()。

对于调用 readfp() 时传入不支持迭代的参数的现有代码，可以在文件类对象外使用以下生成器作为包装器:

def readline_generator(fp):
    line = fp.readline()
    while line:
        yield line
        line = fp.readline()

不再使用 parser.readfp(fp) 而是改用 parser.read_file(readline_generator(fp))。

configparser.MAX_INTERPOLATION_DEPTH

当 raw 形参为假值时 get() 所采用的递归插值的最大深度。 这只在使用默认的 interpolation 时会起作用。

RawConfigParser 对象

class 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])

旧式 ConfigParser。 它默认禁用插值并且允许通过不安全的 add_section 和 set 方法以及旧式 defaults= 关键字参数处理来设置非字符串的节名、选项名和值。

在 3.8 版更改: 默认的 dict_type 为 dict，因为它现在会保留插入顺序。

注解

考虑改用 ConfigParser，它会检查内部保存的值的类型。 如果你不想要插值，你可以使用 ConfigParser(interpolation=None)。

add_section(section)

向实例添加一个名为 section 的节。 如果给定名称的节已存在，将会引发 DuplicateSectionError。 如果传入了 default section 名称，则会引发 ValueError。

不检查 section 以允许用户创建以非字符串命名的节。 此行为已不受支持并可能导致内部错误。

set(section, option, value)

如果给定的节存在，则将给定的选项设为指定的值；在其他情况下将引发 NoSectionError。 虽然可能使用 RawConfigParser (或使用 ConfigParser 并将 raw 形参设为真值) 以便实现非字符串值的 internal 存储，但是完整功能（包括插值和输出到文件）只能使用字符串值来实现。

此方法允许用户在内部将非字符串值赋给键。 此行为已不受支持并会在尝试写入到文件或在非原始模式下获取数据时导致错误。 请使用映射协议 API，它不允许出现这样的赋值。

异常

exception configparser.Error

所有其他 configparser 异常的基类。

exception configparser.NoSectionError

当找不到指定节时引发的异常。

exception configparser.DuplicateSectionError

当调用 add_section() 时传入已存在的节名称，或者在严格解析器中当单个输入文件、字符串或字典内出现重复的节时引发的异常。

3.2 新版功能: 将可选的 source 和 lineno 属性和参数添加到 __init__()。

exception configparser.DuplicateOptionError

当单个选项在从单个文件、字符串或字典读取时出现两次时引发的异常。 这会捕获拼写错误和大小写敏感相关的错误，例如一个字典可能包含两个键分别代表同一个大小写不敏感的配置键。

exception configparser.NoOptionError

当指定的选项未在指定的节中被找到时引发的异常。

exception configparser.InterpolationError

当执行字符串插值发生问题时所引发的异常的基类。

exception configparser.InterpolationDepthError

当字符串插值由于迭代次数超出 MAX_INTERPOLATION_DEPTH 而无法完成所引发的异常。 为 InterpolationError 的子类。

exception configparser.InterpolationMissingOptionError

当从某个值引用的选项并不存在时引发的异常。 为 InterpolationError 的子类。

exception configparser.InterpolationSyntaxError

当将要执行替换的源文本不符合要求的语法时引发的异常。 为 InterpolationError 的子类。

exception configparser.MissingSectionHeaderError

当尝试解析一个不带节标头的文件时引发的异常。

exception configparser.ParsingError

当尝试解析一个文件而发生错误时引发的异常。

在 3.2 版更改: filename 属性和 __init__() 参数被重命名为 source 以保持一致性。

备注

1(1,2,3,4,5,6,7,8,9,10,11)

配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 Customizing Parser Behaviour 一节。

netrc --- netrc 文件处理

源代码: Lib/netrc.py [https://github.com/python/cpython/tree/3.10/Lib/netrc.py]

netrc 类解析并封装了 Unix 的 ftp 程序和其他 FTP 客户端所使用的 netrc 文件格式。

class netrc.netrc([file])

netrc 的实例或其子类的实例会被用来封装来自 netrc 文件的数据。 如果有初始化参数，它将指明要解析的文件。 如果未给出参数，则位于用户家目录的 .netrc 文件 -- 即 os.path.expanduser() 所确定的文件 -- 将会被读取。 在其他情况下，则将引发 FileNotFoundError 异常。 解析错误将引发 NetrcParseError 并附带诊断信息，包括文件名、行号以及终止令牌。 如果在 POSIX 系统上未指明参数，则当 .netrc 文件中有密码时，如果文件归属或权限不安全（归属的用户不是运行进程的用户，或者可供任何其他用户读取或写入）将引发 NetrcParseError。 这实现了与 ftp 和其他使用 .netrc 的程序同等的安全行为。

在 3.4 版更改: 添加了 POSIX 权限检查。

在 3.7 版更改: 当未将 file 作为参数传入时会使用 os.path.expanduser() 来查找 .netrc 文件的位置。

在 3.10 版更改: netrc 会在使用语言区域指定的编码格式之前先尝试 UTF-8 编码格式。

exception netrc.NetrcParseError

当在源文本中遇到语法错误时由 netrc 类引发的异常。 此异常的实例提供了三个有用属性: msg 为错误的文本说明，filename 为源文件的名称，而 lineno 给出了错误所在的行号。

netrc 对象

netrc 实例具有下列方法:

netrc.authenticators(host)

针对 host 的身份验证者返回一个 3 元组 (login, account, password)。 如果 netrc 文件不包含针对给定主机的条目，则返回关联到 'default' 条目的元组。 如果匹配的主机或默认条目均不可用，则返回 None。

netrc.__repr__()

将类数据以 netrc 文件的格式转储为一个字符串。 （这会丢弃注释并可能重排条目顺序。）

netrc 的实例具有一些公共实例变量:

netrc.hosts

将主机名映射到 (login, account, password) 元组的字典。 如果存在 'default' 条目，则会表示为使用该名称的伪主机。

netrc.macros

将宏名称映射到字符串列表的字典。

注解

密码会被限制为 ASCII 字符集的一个子集。 所有 ASCII 标点符号均可用作密码，但是要注意空白符和非打印字符不允许用作密码。 这是 .netrc 文件解析方式带来的限制，在未来可能会被解除。

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

源代码: Lib/plistlib.py [https://github.com/python/cpython/tree/3.10/Lib/plistlib.py]

此模块提供了可读写 Apple "property list" 文件的接口，它主要用于 macOS 和 iOS 系统。 此模块同时支持二进制和 XML plist 文件。

property list (.plist) 文件格式是一种简单的序列化格式，它支持一些基本对象类型，例如字典、列表、数字和字符串等。 通常使用一个字典作为最高层级对象。

要写入和解析 plist 文件，请使用 dump() 和 load() 函数。

要以字节串对象形式操作 plist 数据，请使用 dumps() 和 loads()。

值可以为字符串、整数、浮点数、布尔值、元组、列表、字典（但只允许用字符串作为键）、bytes、bytearray 或 datetime.datetime 对象。

在 3.4 版更改: 新版 API，旧版 API 已被弃用。 添加了对二进制 plist 格式的支持。

在 3.8 版更改: 添加了在二进制 plist 中读写 UID 令牌的支持，例如用于 NSKeyedArchiver 和 NSKeyedUnarchiver。

在 3.9 版更改: 旧 API 已被移除。

参见

PList 指南页面 [https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/]

针对该文件格式的 Apple 文档。

这个模块定义了以下函数：

plistlib.load(fp, *, fmt=None, dict_type=dict)

读取 plist 文件。 fp 应当可读并且为二进制文件对象。 返回已解包的根对象（通常是一个字典）。

fmt 为文件的格式，有效的值如下:

None: 自动检测文件格式

FMT_XML: XML 文件格式

FMT_BINARY: 二进制 plist 格式

dict_type 为字典用来从 plist 文件读取的类型。

FMT_XML 格式的 XML 数据 会使用来自 xml.parsers.expat 的 Expat 解析器 -- 请参阅其文档了解错误格式 XML 可能引发的异常。 未知元素将被 plist 解析器直接略过。

当文件无法被解析时二进制格式的解析器将引发 InvalidFileException。

3.4 新版功能.

plistlib.loads(data, *, fmt=None, dict_type=dict)

从一个 bytes 对象加载 plist。 参阅 load() 获取相应关键字参数的说明。

3.4 新版功能.

plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)

将 value 写入 plist 文件。 Fp 应当可写并且为二进制文件对象。

fmt 参数指定 plist 文件的格式，可以是以下值之一:

FMT_XML: XML 格式的 plist 文件

FMT_BINARY: 二进制格式的 plist 文件

当 sort_keys 为真值（默认）时字典的键将经过排序再写入 plist，否则将按字典的迭代顺序写入。

当 skipkeys 为假值（默认）时该函数将在字典的键不为字符串时引发 TypeError，否则将跳过这样的键。

如果对象是不受支持的类型或者是包含不受支持类型的对象的容器则将引发 TypeError。

对于无法在（二进制）plist 文件中表示的整数值，将会引发 OverflowError。

3.4 新版功能.

plistlib.dumps(value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)

将 value 以 plist 格式字节串对象的形式返回。 参阅 dump() 的文档获取此函数的关键字参数的说明。

3.4 新版功能.

可以使用以下的类:

class plistlib.UID(data)

包装一个 int。 该类将在读取或写入 NSKeyedArchiver 编码的数据时被使用，其中包含 UID（参见 PList 指南）。

它具有一个属性 data，可以被用来提取 UID 的 int 值。 data 的取值范围必须为 0 <= data < 2**64。

3.8 新版功能.

可以使用以下的常量:

plistlib.FMT_XML

用于 plist 文件的 XML 格式。

3.4 新版功能.

plistlib.FMT_BINARY

用于 plist 文件的二进制格式。

3.4 新版功能.

例子

生成一个 plist:

import datetime
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 = datetime.datetime.now()
)
print(plistlib.dumps(pl).decode())

解析一个 plist:

import plistlib

plist = b"""<plist version="1.0">
<dict>
    <key>foo</key>
    <string>bar</string>
</dict>
</plist>"""
pl = plistlib.loads(plist)
print(pl["foo"])

加密服务

本章中描述的模块实现了加密性质的各种算法。 它们可以在安装时自行选择。 在 Unix 系统上，crypt 模块也可以使用。 以下是为内容概要：

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

哈希算法

SHAKE 可变长度摘要

密钥派生

BLAKE2

创建哈希对象

常量

例子

简单哈希

使用不同的摘要大小

密钥哈希

随机哈希

个性化

树形模式

开发人员

hmac --- 基于密钥的消息验证

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

随机数

生成 Token

Token 应当使用多少个字节？

其他功能

应用技巧与最佳实践

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

源码： Lib/hashlib.py [https://github.com/python/cpython/tree/3.10/Lib/hashlib.py]

这个模块针对许多不同的安全哈希和消息摘要算法实现了一个通用接口。 包括 FIPS 安全哈希算法 SHA1, SHA224, SHA256, SHA384 和 SHA512 (定义于 FIPS 180-2) 以及 RSA 的 MD5 算法 (定义于互联网 RFC 1321 [https://datatracker.ietf.org/doc/html/rfc1321.html])。 术语 "安全哈希" 和 "消息摘要" 是同义的。 较旧的算法被称为消息摘要。 现代的术语是安全哈希。

注解

如果你想找到 adler32 或 crc32 哈希函数，它们在 zlib 模块中。

警告

有些算法已知存在哈希碰撞弱点，请参考最后的“另请参阅”段。

哈希算法

每种类型的 hash 都有一个构造器方法。 它们都返回一个具有相同的简单接口的 hash 对象。 例如，使用 use sha256() 创建一个 SHA-256 hash 对象。 你可以使用 update() 方法向这个对象输入 字节类对象 (通常是 bytes)。 在任何时候你都可以使用 digest() 或 hexdigest() 方法获得到目前为止输入这个对象的拼接数据的 digest。

注解

为了更好的多线程性能，在对象创建或者更新时，若数据大于2047字节则 Python 的 GIL 会被释放。

注解

向 update() 输入字符串对象是不被支持的，因为哈希基于字节而非字符。

此模块中总是可用的哈希算法构造器有 sha1(), sha224(), sha256(), sha384(), sha512(), blake2b() 和 blake2s()。 md5() 通常也是可用的，但如果你在使用少见的 "FIPS 兼容" 的 Python 编译版本则可能会找不到它。 此外还可能有一些附加的算法，具体取决于你的平台上的 Python 所使用的 OpenSSL 库。 在大部分平台上可用的还有 sha3_224(), sha3_256(), sha3_384(), sha3_512(), shake_128(), shake_256() 等等。·

3.6 新版功能: SHA3 (Keccak) 和 SHAKE 构造器 sha3_224(), sha3_256(), sha3_384(), sha3_512(), shake_128(), shake_256().

3.6 新版功能: 添加了 blake2b() 和 blake2s() 。

在 3.9 版更改: 所有 hashlib 的构造器都接受仅限关键字参数 usedforsecurity 且其默认值为 True。 设为假值即允许在受限的环境中使用不安全且阻塞的哈希算法。 False 表示此哈希算法不可用于安全场景，例如用作非加密的单向压缩函数。

现在 hashlib 会使用 OpenSSL 1.1.1 或更新版本的 SHA3 和 SHAKE。

例如，如果想获取字节串 b'Nobody inspects the spammish repetition' 的摘要:

>>> 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.digest_size
32
>>> m.block_size
64

更简要的写法：

>>> hashlib.sha224(b"Nobody inspects the spammish repetition").hexdigest()
'a4337bc45a8fc544c03f52dc550cd6e1e87021bc896588bd79e901e2'

hashlib.new(name, [data, ]*, usedforsecurity=True)

一个接受所希望的算法对应的字符串 name 作为第一个形参的通用构造器。 它还允许访问上面列出的哈希算法以及你的 OpenSSL 库可能提供的任何其他算法。 同名的构造器要比 new() 更快所以应当优先使用。

使用 new() 并附带由 OpenSSL 所提供了算法:

>>> h = hashlib.new('sha256')
>>> h.update(b"Nobody inspects the spammish repetition")
>>> h.hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'

Hashlib 提供下列常量属性：

hashlib.algorithms_guaranteed

一个集合，其中包含此模块在所有平台上都保证支持的哈希算法的名称。 请注意 'md5' 也在此清单中，虽然某些上游厂商提供了一个怪异的排除了此算法的 "FIPS 兼容" Python 编译版本。

3.2 新版功能.

hashlib.algorithms_available

一个集合，其中包含在所运行的 Python 解释器上可用的哈希算法的名称。 将这些名称传给 new() 时将可被识别。 algorithms_guaranteed 将总是它的一个子集。 同样的算法在此集合中可能以不同的名称出现多次（这是 OpenSSL 的原因）。

3.2 新版功能.

下列值会以构造器所返回的哈希对象的常量属性的形式被提供:

hash.digest_size

以字节表示的结果哈希对象的大小。

hash.block_size

以字节表示的哈希算法的内部块大小。

hash 对象具有以下属性：

hash.name

此哈希对象的规范名称，总是为小写形式并且总是可以作为 new() 的形参用来创建另一个此类型的哈希对象。

在 3.4 版更改: 该属性名称自被引入起即存在于 CPython 中，但在 Python 3.4 之前并未正式指明，因此可能不存在于某些平台上。

哈希对象具有下列方法:

hash.update(data)

用 bytes-like object 来更新哈希对象。 重复调用相当于单次调用并传入所有参数的拼接结果: m.update(a); m.update(b) 等价于 m.update(a+b)。

在 3.1 版更改: 当使用 OpenSSL 提供的哈希算法在大于 2047 字节的数据上执行哈希更新时 Python GIL 会被释放以允许其他线程运行。

hash.digest()

返回当前已传给 update() 方法的数据摘要。 这是一个大小为 digest_size 的字节串对象，字节串中可包含 0 至 255 的完整取值范围。

hash.hexdigest()

类似于 digest() 但摘要会以两倍长度字符串对象的形式返回，其中仅包含十六进制数码。 这可以被用于在电子邮件或其他非二进制环境中安全地交换数据值。

hash.copy()

返回哈希对象的副本（“克隆”）。 这可被用来高效地计算共享相同初始子串的数据的摘要。

SHAKE 可变长度摘要

shake_128() 和 shake_256() 算法提供安全的 length_in_bits//2 至 128 或 256 位可变长度摘要。 为此，它们的摘要需指定一个长度。 SHAKE 算法不限制最大长度。

shake.digest(length)

返回当前已传给 update() 方法的数据摘要。 这是一个大小为 length 的字节串对象，字节串中可包含 0 to 255 的完整取值范围。

shake.hexdigest(length)

类似于 digest() 但摘要会以两倍长度字符串对象的形式返回，其中仅包含十六进制数码。 这可以被用于在电子邮件或其他非二进制环境中安全地交换数据值。

密钥派生

密钥派生和密钥延展算法被设计用于安全密码哈希。 sha1(password) 这样的简单算法无法防御暴力攻击。 好的密码哈希函数必须可以微调、放慢步调，并且包含 加盐 [https://en.wikipedia.org/wiki/Salt_%28cryptography%29]。

hashlib.pbkdf2_hmac(hash_name, password, salt, iterations, dklen=None)

此函数提供 PKCS#5 基于密码的密钥派生函数 2。 它使用 HMAC 作为伪随机函数。

字符串 hash_name 是要求用于 HMAC 的哈希摘要算法的名称，例如 'sha1' 或 'sha256'。 password 和 salt 会以字节串缓冲区的形式被解析。 应用和库应当将 password 限制在合理长度 (例如 1024)。 salt 应当为适当来源例如 os.urandom() 的大约 16 个或更多的字节串数据。

iterations 的数值应当基于哈希算法和机器算力来选择。 在 2022 年，建议选择进行数万次的 SHA-256 迭代。 对于为何以及如何选择最适合你的应用程序的迭代次数的理由，请参阅 NIST-SP-800-132 [https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf] 的 Appendix A.2.2。 其中 stackexchange pbkdf2 迭代问题 [https://security.stackexchange.com/questions/3959/recommended-of-iterations-when-using-pbkdf2-sha256/] 的解答提供的详细的说明。

dklen 为派生密钥的长度。 如果 dklen 为 None 则会使用哈希算法 hash_name 的摘要大小，例如 SHA-512 为 64。

>>> 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'

3.4 新版功能.

注解

随同 OpenSSL 提供了一个快速的 pbkdf2_hmac 实现。 Python 实现是使用 hmac 的内联版本。 它的速度大约要慢上三倍并且不会释放 GIL。

3.10 版后已移除: 较慢的 pbkdf2_hmac Python 实现已被弃用。 未来该函数将仅在 Python 附带 OpenSSL 编译时可用。

hashlib.scrypt(password, *, salt, n, r, p, maxmem=0, dklen=64)

此函数提供基于密码加密的密钥派生函数，其定义参见 RFC 7914 [https://datatracker.ietf.org/doc/html/rfc7914.html]。

password 和 salt 必须为 字节类对象。 应用和库应当将 password 限制在合理长度 (例如 1024)。 salt 应当为适当来源例如 os.urandom() 的大约 16 个或更多的字节串数据。

n 为 CPU/内存开销因子，r 为块大小，p 为并行化因子，maxmem 为内存限制 (OpenSSL 1.1.0 默认为 32 MiB)。 dklen 为派生密钥的长度。

3.6 新版功能.

BLAKE2

BLAKE2 [https://blake2.net] 是在 RFC 7693 [https://datatracker.ietf.org/doc/html/rfc7693.html] 中定义的加密哈希函数，它有两种形式:

BLAKE2b，针对 64 位平台进行优化，并会生成长度介于 1 和 64 字节之间任意大小的摘要。

BLAKE2s，针对 8 至 32 位平台进行优化，并会生成长度介于 1 和 32 字节之间任意大小的摘要。

BLAKE2 支持 keyed mode (HMAC [https://en.wikipedia.org/wiki/Hash-based_message_authentication_code] 的更快速更简单的替代), salted hashing, personalization 和 tree hashing.

此模块的哈希对象遵循标准库 hashlib 对象的 API。

创建哈希对象

新哈希对象可通过调用构造器函数来创建:

hashlib.blake2b(data=b'', *, digest_size=64, key=b'', salt=b'', person=b'', fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False, usedforsecurity=True)

hashlib.blake2s(data=b'', *, digest_size=32, key=b'', salt=b'', person=b'', fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False, usedforsecurity=True)

这些函数返回用于计算 BLAKE2b 或 BLAKE2s 的相应的哈希对象。 它们接受下列可选通用形参:

data: 要哈希的初始数据块，它必须为 bytes-like object。 它只能作为位置参数传入。

digest_size: 以字节数表示的输出摘要大小。

key: 用于密钥哈希的密钥（对于 BLAKE2b 最长 64 字节，对于 BLAKE2s 最长 32 字节）。

salt: 用于随机哈希的盐值（对于 BLAKE2b 最长 16 字节，对于 BLAKE2s 最长 8 字节）。

person: 个性化字符串（对于 BLAKE2b 最长 16 字节，对于 BLAKE2s 最长 8 字节）。

下表显示了常规参数的限制（以字节为单位）：

Hash | 目标长度 | 长度（键） | 长度（盐） | 长度（个人）
BLAKE2b | 64 | 64 | 16 | 16
BLAKE2s | 32 | 32 | 8 | 8

注解

BLAKE2 规格描述为盐值和个性化形参定义了固定的长度，但是为了方便起见，此实现接受指定在长度以内的任意大小的字节串。 如果形参长度小于指定值，它将以零值进行填充，因此举例来说，b'salt' 和 b'salt\x00' 为相同的值 (key 的情况则并非如此。)

如下面的模块 constants 所描述，这些是可用的大小取值。

构造器函数还接受下列树形哈希形参:

fanout: 扇出值 (0 至 255，如无限制即为 0，连续模式下为 1)。

depth: 树的最大深度 (1 至 255，如无限制则为 255，连续模式下为 1)。

leaf_size: 叶子的最大字节长度 (0 至 2**32-1，如无限制或在连续模式下则为 0)。

node_offset: 节点的偏移量 (对于 BLAKE2b 为 0 至 2**64-1，对于 BLAKE2s 为 0 至 2**48-1，对于最多边的第一个叶子或在连续模式下则为 0)。

node_depth: 节点深度 (0 至 255，对于叶子或在连续模式下则为 0)。

inner_size: 内部摘要大小 (对于 BLAKE2b 为 0 至 64，对于 BLAKE2s 为 0 至 32，连续模式下则为 0)。

last_node: 一个指明所处理的节点是否为最后一个 (在连续模式下为 False) 的布尔值。

请参阅 BLAKE2 规格描述 [https://blake2.net/blake2_20130129.pdf] 第 2.10 节获取有关树形哈希的完整说明。

常量

blake2b.SALT_SIZE

blake2s.SALT_SIZE

盐值长度（构造器所接受的最大长度）。

blake2b.PERSON_SIZE

blake2s.PERSON_SIZE

个性化字符串长度（构造器所接受的最大长度）。

blake2b.MAX_KEY_SIZE

blake2s.MAX_KEY_SIZE

最大密钥长度。

blake2b.MAX_DIGEST_SIZE

blake2s.MAX_DIGEST_SIZE

哈希函数可输出的最大摘要长度。

例子

简单哈希

要计算某个数据的哈希值，你应该首先通过调用适当的构造器函数 (blake2b() 或 blake2s()) 来构造一个哈希对象，然后通过在该对象上调用 update() 来更新目标数据，最后通过调用 digest() (或针对十六进制编码字符串的 hexdigest()) 来获取该对象的摘要。

>>> from hashlib import blake2b
>>> h = blake2b()
>>> h.update(b'Hello world')
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'

作为快捷方式，你可以直接以位置参数的形式向构造器传入第一个数据块来直接更新:

>>> from hashlib import blake2b
>>> blake2b(b'Hello world').hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'

你可以多次调用 hash.update() 至你所想要的任意次数以迭代地更新哈希值:

>>> from hashlib import blake2b
>>> items = [b'Hello', b' ', b'world']
>>> h = blake2b()
>>> for item in items:
...     h.update(item)
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'

使用不同的摘要大小

BLAKE2 具有可配置的摘要大小，对于 BLAKE2b 最多 64 字节，对于 BLAKE2s 最多 32 字节。 例如，要使用 BLAKE2b 来替代 SHA-1 而不改变输出大小，我们可以让 BLAKE2b 产生 20 个字节的摘要:

>>> 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

不同摘要大小的哈希对象具有完全不同的输出（较短哈希值 并非 较长哈希值的前缀）；即使输出长度相同，BLAKE2b 和 BLAKE2s 也会产生不同的输出:

>>> 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'

密钥哈希

带密钥的哈希运算可被用于身份验证，作为 基于哈希的消息验证代码 [https://en.wikipedia.org/wiki/HMAC] (HMAC) 的一种更快速更简单的替代。 BLAKE2 可被安全地用于前缀 MAC 模式，这是由于它从 BLAKE 继承而来的不可区分特性。

这个例子演示了如何使用密钥 b'pseudorandom key' 来为 b'message data' 获取一个（十六进制编码的）128 位验证代码:

>>> from hashlib import blake2b
>>> h = blake2b(key=b'pseudorandom key', digest_size=16)
>>> h.update(b'message data')
>>> h.hexdigest()
'3d363ff7401e02026f4a4687d4863ced'

作为实际的例子，一个 Web 应用可为发送给用户的 cookies 进行对称签名，并在之后对其进行验证以确保它们没有被篡改:

>>> 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

即使存在原生的密钥哈希模式，BLAKE2 也同样可在 hmac 模块的 HMAC 构造过程中使用:

>>> import hmac, hashlib
>>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s)
>>> m.update(b'message')
>>> m.hexdigest()
'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142'

随机哈希

用户可通过设置 salt 形参来为哈希函数引入随机化。 随机哈希适用于防止对数字签名中使用的哈希函数进行碰撞攻击。

随机哈希被设计用来处理当一方（消息准备者）要生成由另一方（消息签名者）进行签名的全部或部分消息的情况。 如果消息准备者能够找到加密哈希函数的碰撞现象（即两条消息产生相同的哈希值），则他们就可以准备将产生相同哈希值和数字签名但却具有不同结果的有意义的消息版本（例如向某个账户转入 $1,000,000 而不是 $10）。 加密哈希函数的设计都是以防碰撞性能为其主要目标之一的，但是当前针对加密哈希函数的集中攻击可能导致特定加密哈希函数所提供的防碰撞性能低于预期。 随机哈希为签名者提供了额外的保护，可以降低准备者在数字签名生成过程中使得两条或更多条消息最终产生相同哈希值的可能性 --- 即使为特定哈希函数找到碰撞现象是可行的。 但是，当消息的所有部分均由签名者准备时，使用随机哈希可能降低数字签名所提供的安全性。

(NIST SP-800-106 "数字签名的随机哈希" [https://csrc.nist.gov/publications/detail/sp/800-106/final])

在 BLAKE2 中，盐值会在初始化期间作为对哈希函数的一次性输入而不是对每个压缩函数的输入来处理。

警告

使用 BLAKE2 或任何其他通用加密哈希函数例如 SHA-256 进行 加盐哈希 (或纯哈希) 并不适用于哈希密码。 请参阅 BLAKE2 FAQ [https://blake2.net/#qa] 了解更多信息。

>>> 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

个性化

出于不同的目的强制让哈希函数为相同的输入生成不同的摘要有时也是有用的。 正如 Skein 哈希函数的作者所言:

我们建议所有应用设计者慎重考虑这种做法；我们已看到有许多协议在协议的某一部分中计算出来的哈希值在另一个完全不同的部分中也可以被使用，因为两次哈希计算是针对类似或相关的数据进行的，这样攻击者可以强制应用为相同的输入生成哈希值。 个性化协议中所使用的每个哈希函数将有效地阻止这种类型的攻击。

(Skein 哈希函数族 [https://www.schneier.com/wp-content/uploads/2016/02/skein.pdf], p. 21)

BLAKE2 可通过向 person 参数传入字节串来进行个性化:

>>> 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'

个性化配合密钥模式也可被用来从单个密钥派生出多个不同密钥。

>>> 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=

树形模式

以下是对包含两个叶子节点的最小树进行哈希的例子:

  10
 /  \
00  01

这个例子使用 64 字节内部摘要，返回 32 字节最终摘要:

>>> 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'

开发人员

BLAKE2 [https://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 [https://en.wikipedia.org/wiki/NIST_hash_function_competition] 入围方案 BLAKE [https://131002.net/blake/] 进行设计的。

它使用的核心算法来自由 Daniel J. Bernstein 所设计的 ChaCha [https://cr.yp.to/chacha.html] 加密。

stdlib 实现是基于 pyblake2 [https://pythonhosted.org/pyblake2/] 模块的。 它由 Dmitry Chestnykh 在 Samuel Neves 所编写的 C 实现的基础上编写。 此文档拷贝自 pyblake2 [https://pythonhosted.org/pyblake2/] 并由 Dmitry Chestnykh 撰写。

C 代码由 Christian Heimes 针对 Python 进行了部分的重写。

以下公共领域贡献同时适用于 C 哈希函数实现、扩展代码和本文档:

在法律许可的范围内，作者已将此软件的全部版权以及关联和邻接权利贡献到全球公共领域。 此软件的发布不附带任何担保。

你应该已收到此软件附带的 CC0 公共领域专属证书的副本。 如果没有，请参阅 https://creativecommons.org/publicdomain/zero/1.0/。

根据创意分享公共领域贡献 1.0 通用规范，下列人士为此项目的开发提供了帮助或对公共领域的修改作出了贡献:

Alexandr Sokolovskiy

参见

模块 hmac

使用哈希运算来生成消息验证代码的模块。

模块 base64

针对非二进制环境对二进制哈希值进行编辑的另一种方式。

https://blake2.net

BLAKE2 官方网站

https://csrc.nist.gov/csrc/media/publications/fips/180/2/archive/2002-08-01/documents/fips180-2.pdf

有关安全哈希算法的 FIPS 180-2 出版物。

https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms

包含关于哪些算法存在已知问题以及对其使用所造成的影响的信息的 Wikipedia 文章。

https://www.ietf.org/rfc/rfc8018.txt

PKCS #5: 基于密码的加密规范描述 2.1 版

https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf

NIST 对基于密码的密钥派生的建议。

hmac --- 基于密钥的消息验证

源代码: Lib/hmac.py [https://github.com/python/cpython/tree/3.10/Lib/hmac.py]

此模块实现了 HMAC 算法，算法的描述参见 RFC 2104 [https://datatracker.ietf.org/doc/html/rfc2104.html]。

hmac.new(key, msg=None, digestmod='')

返回一个新的 hmac 对象。 key 是一个指定密钥的 bytes 或 bytearray 对象。 如果提供了 msg，将会调用 update(msg) 方法。 digestmod 为 HMAC 对象所用的摘要名称、摘要构造器或模块。 它可以是适用于 hashlib.new() 的任何名称。 虽然该参数位置靠后，但它却是必须的。

在 3.4 版更改: 形参 key 可以为 bytes 或 bytearray 对象。 形参 msg 可以为 hashlib 所支持的任意类型。 形参 digestmod 可以为某种哈希算法的名称。

Deprecated since version 3.4, removed in version 3.8: MD5 作为 digestmod 的隐式默认摘要已被弃用。 digestmod 形参现在是必须的。 请将其作为关键字参数传入以避免当你没有初始 msg 时将导致的麻烦。

hmac.digest(key, msg, digest)

基于给定密钥 key 和 digest 返回 msg 的摘要。 此函数等价于 HMAC(key, msg, digest).digest()，但使用了优化的 C 或内联实现，对放入内存的消息能处理得更快。 形参 key, msg 和 digest 具有与 new() 中相同的含义。

作为 CPython 的实现细节，优化的 C 实现仅当 digest 为字符串并且是一个 OpenSSL 所支持的摘要算法的名称时才会被使用。

3.7 新版功能.

HMAC 对象具有下列方法:

HMAC.update(msg)

用 msg 来更新 hmac 对象。 重复调用相当于单次调用并传入所有参数的拼接结果: m.update(a); m.update(b) 等价于 m.update(a + b)。

在 3.4 版更改: 形参 msg 可以为 hashlib 所支持的任何类型。

HMAC.digest()

返回当前已传给 update() 方法的字节串数据的摘要。 这个字节串数据的长度将与传给构造器的摘要的长度 digest_size 相同。 它可以包含非 ASCII 的字节，包括 NUL 字节。

警告

在验证例程运行期间将 digest() 的输出与外部提供的摘要进行比较时，建议使用 compare_digest() 函数而不是 == 运算符以减少面对定时攻击的弱点。

HMAC.hexdigest()

类似于 digest() 但摘要会以两倍长度字符串的形式返回，其中仅包含十六进制数码。 这可以被用于在电子邮件或其他非二进制环境中安全地交换数据值。

警告

在验证例程运行期间将 hexdigest() 的输出与外部提供的摘要进行比较时，建议使用 compare_digest() 函数而不是 == 运算符以减少面对定时攻击的弱点。

HMAC.copy()

返回 hmac 对象的副本（“克隆）。 这可被用来高效地计算共享相同初始子串的数据的摘要。

hash 对象具有以下属性：

HMAC.digest_size

以字节表示的结果 HMAC 摘要的大小。

HMAC.block_size

以字节表示的哈希算法的内部块大小。

3.4 新版功能.

HMAC.name

HMAC 的规范名称，总是为小写形式，例如 hmac-md5。

3.4 新版功能.

3.9 版后已移除: 未写入文档的属性 HMAC.digest_cons, HMAC.inner 和 HMAC.outer 属于内部实现细节，将在 Python 3.10 中被移除。

这个模块还提供了下列辅助函数:

hmac.compare_digest(a, b)

返回 a == b。 此函数使用一种经专门设计的方式通过避免基于内容的短路行为来防止定时分析，使得它适合处理密码。 a 和 b 必须为相同的类型：或者是 str (仅限 ASCII 字符，如 HMAC.hexdigest() 的返回值)，或者是 bytes-like object。

注解

如果 a 和 b 具有不同的长度，或者如果发生了错误，定时攻击在理论上可以获取有关 a 和 b 的类型和长度信息 — 但不能获取它们的值。

3.3 新版功能.

在 3.10 版更改: 此函数在可能的情况下会在内部使用 OpenSSL 的 CRYPTO_memcmp()。

参见

模块 hashlib

提供安全哈希函数的 Python 模块。

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

3.6 新版功能.

源代码: Lib/secrets.py [https://github.com/python/cpython/tree/3.10/Lib/secrets.py]

secrets 模块用于生成高度加密的随机数，适于管理密码、账户验证、安全凭据及机密数据。

最好用 secrets 替代 random 模块的默认伪随机数生成器，该生成器适用于建模和模拟，不宜用于安全与加密。

参见

PEP 506 [https://www.python.org/dev/peps/pep-0506]

随机数

secrets 模块是操作系统提供的最安全地随机性来源。

class secrets.SystemRandom

用操作系统提供的最高质量源生成随机数的类。详见 random.SystemRandom。

secrets.choice(sequence)

返回一个从非空序列中随机选取的元素。

secrets.randbelow(n)

返回 [0, n) 范围内的随机整数。

secrets.randbits(k)

返回 k 个随机比特位的整数。

生成 Token

secrets 模块提供了生成安全 Token 的函数，适用于密码重置、密保 URL 等应用场景。

secrets.token_bytes([nbytes=None])

返回含 nbytes 个字节的随机字节字符串。如果未提供 nbytes，或*nbytes* 为 None，则使用合理的默认值。

>>> token_bytes(16)
b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b'

secrets.token_hex([nbytes=None])

返回十六进制随机文本字符串。字符串有 nbytes 个随机字节，每个字节转换为两个十六进制数码。未提供 nbytes 或为 None 时，则使用合理的默认值。

>>> token_hex(16)
'f9bf78b9a18ce6d46a0cd2b0b86df9da'

secrets.token_urlsafe([nbytes=None])

返回安全的 URL 随机文本字符串，包含 nbytes 个随机字节。文本用 Base64 编码，平均来说，每个字节对应 1.3 个结果字符。未提供 nbytes 或为 None 时，则使用合理的默认值。

>>> token_urlsafe(16)
'Drmhze6EPcv0fN_81Bj-nA'

Token 应当使用多少个字节？

为了在面对 暴力攻击 [https://en.wikipedia.org/wiki/Brute-force_attack] 时保证安全，Token 的随机性必须足够高。随着计算机推衍能力的不断提升，随机性的安全标准也要不断提高。比如 2015 年，32 字节（256 位）的随机性对于 secrets 模块的典型用例就已经足够了。

要自行管理 Token 长度的用户，可以通过为 token_* 函数指定 int 参数显式指定 Token 要使用多大的随机性。该参数以字节数表示随机性大小。

反之，如果未提供参数，或参数为 None，则 token_* 函数将使用合理的默认值。

注解

该默认值随时可能会改变，比如，版本更新的时候。

其他功能

secrets.compare_digest(a, b)

如果字符串或 字节型对象 a 与 b 相等则返回 True，否则返回 False，使用了“常数时间比较”来降低 定时攻击 [https://codahale.com/a-lesson-in-timing-attacks/] 的风险。请参阅 hmac.compare_digest() 了解更多细节。

应用技巧与最佳实践

本节展示了一些使用 secrets 管理基本安全级别的应用技巧和最佳实践。

生成长度为八个字符的字母数字密码：

import string
import secrets
alphabet = string.ascii_letters + string.digits
password = ''.join(secrets.choice(alphabet) for i in range(8))

注解

应用程序不可 以可恢复的格式存储密码 [https://cwe.mitre.org/data/definitions/257.html]，无论是纯文本还是加密形式。 它们应当使用高加密强度的单向（不可逆）哈希函数来加盐和生成哈希值。

生成长度为十个字符的字母数字密码，包含至少一个小写字母，至少一个大写字母以及至少三个数字：

import string
import secrets
alphabet = string.ascii_letters + string.digits
while True:
    password = ''.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

生成 XKCD 风格的密码串 [https://xkcd.com/936/]：

import secrets
# On standard Linux systems, use a convenient dictionary file.
# Other platforms may need to provide their own word-list.
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))

生成临时密保 URL，包含密码恢复应用的安全 Token：

import secrets
url = 'https://example.com/reset=' + secrets.token_urlsafe()

通用操作系统服务

本章中描述的各模块提供了在（几乎）所有的操作系统上可用的操作系统特性的接口，例如文件和时钟。这些接口通常以 Unix 或 C 接口为参考对象，不过在大多数其他系统上也可用。这里有一个概述：

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

文件名，命令行参数，以及环境变量。

Python UTF-8 模式

进程参数

创建文件对象

文件描述符操作

查询终端的尺寸

文件描述符的继承

文件和目录

Linux 扩展属性

进程管理

调度器接口

其他系统信息

随机数

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

概述

文本 I/O

二进制 I/O

原始 I/O

文本编码格式

选择性的 EncodingWarning

高阶模块接口

类的层次结构

I/O 基类

原始文件 I/O

缓冲流

文本 I/O

性能

二进制 I/O

文本 I/O

多线程

可重入性

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

函数

Clock ID 常量

时区常量

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

示例

创建一个解析器

添加参数

解析参数

ArgumentParser 对象

prog

usage（用法）

description

epilog

parents

formatter_class

prefix_chars

fromfile_prefix_chars

argument_default

allow_abbrev

conflict_handler

add_help

exit_on_error

add_argument() 方法

name or flags

action

nargs

const

默认值

type

choices

required

help

metavar

dest

Action 类

parse_args() 方法

选项值语法

无效的参数

包含 - 的参数

参数缩写（前缀匹配）

在 sys.argv 以外

命名空间对象

其它实用工具

子命令

FileType 对象

参数组

互斥

解析器默认值

打印帮助

部分解析

自定义文件解析

退出方法

混合解析

升级 optparse 代码

getopt --- C 风格的命令行选项解析器

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

记录器对象

日志级别

处理器对象

格式器对象

过滤器对象

LogRecord 属性

LogRecord 属性

LoggerAdapter 对象

线程安全

模块级函数

模块级属性

与警告模块集成

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

配置函数

安全考量

配置字典架构

字典架构细节

增量配置

对象连接

用户定义对象

处理器配置顺序

访问外部对象

访问内部对象

导入解析与定制导入器

配置文件格式

logging.handlers --- 日志处理程序

StreamHandler

FileHandler

NullHandler

WatchedFileHandler

BaseRotatingHandler

RotatingFileHandler

TimedRotatingFileHandler

SocketHandler

DatagramHandler

SysLogHandler

NTEventLogHandler

SMTPHandler

MemoryHandler

HTTPHandler

QueueHandler

QueueListener

getpass --- 便携式密码输入工具

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

函数

Window 对象

常量

curses.textpad --- 用于 curses 程序的文本输入控件

文本框对象

curses.ascii --- 用于 ASCII 字符的工具

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

函数

Panel 对象

platform --- 获取底层平台的标识数据

跨平台

Java平台

Windows平台

macOS 平台

Unix 平台

Linux 平台

errno --- 标准 errno 系统符号

ctypes --- Python 的外部函数库

ctypes 教程

载入动态连接库

操作导入的动态链接库中的函数

调用函数

基础数据类型

调用函数，继续

调用可变函数

使用自定义的数据类型调用函数

指定必选参数的类型(函数原型)

返回类型

传递指针（或以引用方式传递形参）

结构体和联合

结构体/联合字段对齐及字节顺序

结构体和联合中的位域

数组

指针

类型转换

不完整类型

回调函数

访问 dll 的导出变量

意外

变长数据类型

ctypes 参考手册

寻找动态链接库

加载动态链接库

外部函数

函数原型

工具函数

数据类型

基础数据类型

结构化数据类型

数组与指针

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

源代码： Lib/os.py [https://github.com/python/cpython/tree/3.10/Lib/os.py]

本模块提供了一种使用与操作系统相关的功能的便捷式途径。 如果你只是想读写一个文件，请参阅 open()，如果你想操作文件路径，请参阅 os.path 模块，如果你想读取通过命令行给出的所有文件中的所有行，请参阅 fileinput 模块。 为了创建临时文件和目录，请参阅 tempfile 模块，对于高级文件和目录处理，请参阅 shutil 模块。

关于这些函数的适用性的说明：

Python中所有依赖于操作系统的内置模块的设计都是这样，只要不同的操作系统某一相同的功能可用，它就使用相同的接口。例如，函数 os.stat(path) 以相同的格式返回关于 path 的状态信息（该格式源于 POSIX 接口）。

特定于某一操作系统的扩展通过操作 os 模块也是可用的，但是使用它们当然是对可移植性的一种威胁。

所有接受路径或文件名的函数都同时支持字节串和字符串对象，并在返回路径或文件名时使用相应类型的对象作为结果。

在 VxWorks 系统上，os.popen, os.fork, os.execv 和 os.spawn*p* 都未支持。

注解

如果使用无效或无法访问的文件名与路径，或者其他类型正确但操作系统不接受的参数，此模块的所有函数都抛出 OSError （或者它的子类）。

exception os.error

内建的 OSError 异常的一个别名。

os.name

导入的依赖特定操作系统的模块的名称。以下名称目前已注册: 'posix', 'nt', 'java'.

参见

sys.platform 有更详细的描述. os.uname() 只给出系统提供的版本信息。

platform 模块对系统的标识有更详细的检查。

文件名，命令行参数，以及环境变量。

在 Python 中，使用字符串类型表示文件名、命令行参数和环境变量。 在某些系统上，在将这些字符串传递给操作系统之前，必须将这些字符串解码为字节。 Python 使用 filesystem encoding and error handler 来执行此转换（请参阅 sys.getfilesystemencoding() ）。

filesystem encoding and error handler 是在 Python 启动时通过 PyConfig_Read() 函数来配置的：请参阅 PyConfig 的 filesystem_encoding 和 filesystem_errors 等成员。

在 3.1 版更改: 在某些系统上，使用文件系统编码进行转换可能会失败。 在这种情况下，Python 会使用 代理转义编码错误处理器，这意味着在解码时，不可解码的字节被 Unicode 字符 U+DCxx 替换，并且这些字节在编码时再次转换为原始字节。

文件系统编码器 必须保证能成功解码所有 128 以内的字节。如果不能保证，API 函数可能触发 UnicodeError 。

另请参见 locale encoding。

Python UTF-8 模式

3.7 新版功能: 有关更多详细信息，请参阅 PEP 540 [https://www.python.org/dev/peps/pep-0540] 。

Python UTF-8 模式会忽略 locale encoding 并强制使用 UTF-8 编码。

用 UTF-8 作为 文件系统编码。

sys.getfilesystemencoding() 返回 'UTF-8' 。

locale.getpreferredencoding() 返回 'UTF-8' (do_setlocale 参数不起作用)。

sys.stdin, sys.stdout 和 sys.stderr 都将 UTF-8 用作它们的文本编码，并且为 sys.stdin 和 sys.stdout 启用 surrogateescape 错误处理器 (sys.stderr 会继续使用 backslashreplace 如同在默认的局部感知模式下一样)

在 Unix 中，os.device_encoding() 返回 'UTF-8'。而不是设备的编码。

请注意 UTF-8 模式下的标准流设置可以被 PYTHONIOENCODING 所覆盖（在默认的区域感知模式下也同样如此）。

作为低层级 API 发生改变的结果，其他高层级 API 也会表现出不同的默认行为：

命令行参数，环境变量和文件名会使用 UTF-8 编码来解码为文本。

os.fsdecode() 和 os.fsencode() 会使用 UTF-8 编码。

open(), io.open() 和 codecs.open() 默认会使用 UTF-8 编码。 但是，它们默认仍将使用 strict 错误处理器，因此试图在文本模式下打开二进制文件将可能引发异常，而不是生成无意义的数据。

如果在 Python 启动时 LC_CTYPE 区域设为 C 或 POSIX ，则启用 Python UTF-8 模式 (参见 PyConfig_Read() 函数)。

它可以通过命令行选项 -X utf8 和环境变量 PYTHONUTF8，来启用或禁用。

如果没有设置 PYTHONUTF8 环境变量，那么解释器默认使用当前的地区设置，除非 当前地区识别为基于 ASCII 的传统地区（如 PYTHONCOERCECLOCALE 所述），并且 locale coercion 被禁用或失败。在这种传统地区，除非显式指明不要如此，解释器将默认启用 UTF-8 模式。

Python UTF-8 模式只能在 Python 启动时启用。其值可以从 sys.flags.utf8_mode 读取。

另请参阅 在 Windows 中的 UTF-8 模式 和 filesystem encoding and error handler。

进程参数

这些函数和数据项提供了操作当前进程和用户的信息。

os.ctermid()

返回与进程控制终端对应的文件名。

可用性: Unix。

os.environ

一个 mapping 对象，其中键值是代表进程环境的字符串。 例如，environ['HOME'] 是你的主目录（在某些平台上）的路径名，相当于 C 中的 getenv("HOME")。

这个映射是在第一次导入 os 模块时捕获的，通常作为 Python 启动时处理 site.py 的一部分。除了通过直接修改 os.environ 之外，在此之后对环境所做的更改不会反映在 os.environ 中。

该映射除了可以用于查询环境外，还能用于修改环境。当该映射被修改时，将自动调用 putenv()。

在Unix系统上，键和值会使用 sys.getfilesystemencoding() 和 'surrogateescape' 的错误处理。如果你想使用其他的编码，使用 environb。

在 Windows 上，这些键会被转换为大写形式。 这也会在获取、设备或删除条目时被应用。 例如，environ['monty'] = 'python' 会将键 'MONTY' 映射到值 'python'。

注解

直接调用 putenv() 并不会影响 os.environ ，所以推荐直接修改 os.environ 。

注解

在某些平台上，包括 FreeBSD 和 macOS，设置 environ 可能导致内存泄漏。 请参阅 putenv() 的系统文档。

可以删除映射中的元素来删除对应的环境变量。当从 os.environ 删除元素时，以及调用 pop() 或 clear() 之一时，将自动调用 unsetenv()。

在 3.9 版更改: 已更新并支持了 PEP 584 [https://www.python.org/dev/peps/pep-0584] 的合并 (|) 和更新 (|=) 运算符。

os.environb

environ 的字节版本：一个 mapping 对象，其中键值都是 bytes 对象，代表进程环境。 environ 和 environb 是同步的（修改 environb 会更新 environ，反之亦然）。

只有在 supports_bytes_environ 为 True 的时候 environb 才是可用的。

3.2 新版功能.

在 3.9 版更改: 已更新并支持了 PEP 584 [https://www.python.org/dev/peps/pep-0584] 的合并 (|) 和更新 (|=) 运算符。

os.chdir(path)

os.fchdir(fd)

os.getcwd()

以上函数请参阅 文件和目录 。

os.fsencode(filename)

将 类似路径形式的 filename 编码为 filesystem encoding and error handler；原样返回 bytes。

fsdecode() 是此函数的逆向函数。

3.2 新版功能.

在 3.6 版更改: 增加对实现了 os.PathLike 接口的对象的支持。

os.fsdecode(filename)

根据 filesystem encoding and error handler 来解码 类似路径形式的 filename；原样返回 str。

fsencode() 是此函数的逆向函数。

3.2 新版功能.

在 3.6 版更改: 增加对实现了 os.PathLike 接口的对象的支持。

os.fspath(path)

返回路径的文件系统表示。

如果传入的是 str 或 bytes 类型的字符串，将原样返回。否则 __fspath__() 将被调用，如果得到的是一个 str 或 bytes 类型的对象，那就返回这个值。其他所有情况则会抛出 TypeError  异常。

3.6 新版功能.

class os.PathLike

某些对象用于表示文件系统中的路径（如 pathlib.PurePath 对象），本类是这些对象的 抽象基类。

3.6 新版功能.

abstractmethod __fspath__()

返回当前对象的文件系统表示。

这个方法只应该返回一个 str 字符串或 bytes 字节串，请优先选择 str 字符串。

os.getenv(key, default=None)

如果环境变量 key 存在则将其值作为字符串返回，如果不存在则返回 default。 key 是一个字符串。 请注意由于 getenv() 使用了 os.environ，因此 getenv() 的映射同样也会在导入时被捕获，并且该函数可能无法反映未来的环境变化。

在Unix系统上，键和值会使用 sys.getfilesystemencoding() 和 'surrogateescape' 错误处理进行解码。如果你想使用其他的编码，使用 os.getenvb()。

可用性: 大部分的Unix系统，Windows。

os.getenvb(key, default=None)

如果环境变量 key 存在则将其值作为字节串返回，如果不存在则返回 default。 key 必须为字节串。 请注意由于 getenvb() 使用了 os.environb，因此 getenvb() 的映射同样也会在导入时被捕获，并且该函数可能无法反映未来的环境变化。

getenvb() 仅在 supports_bytes_environ 为 True 时可用。

可用性: 大部分的Unix系统。

3.2 新版功能.

os.get_exec_path(env=None)

返回将用于搜索可执行文件的目录列表，与在外壳程序中启动一个进程时相似。指定的 env 应为用于搜索 PATH 的环境变量字典。默认情况下，当 env 为 None 时，将会使用 environ 。

3.2 新版功能.

os.getegid()

返回当前进程的有效组ID。对应当前进程执行文件的 "set id" 位。

可用性: Unix。

os.geteuid()

返回当前进程的有效用户ID。

可用性: Unix。

os.getgid()

返回当前进程的实际组ID。

可用性: Unix。

os.getgrouplist(user, group)

返回该用户所在的组 ID 列表。可能 group 参数没有在返回的列表中，实际上用户应该也是属于该 group。group 参数一般可以从储存账户信息的密码记录文件中找到。

可用性: Unix。

3.3 新版功能.

os.getgroups()

返回当前进程关联的附加组ID列表

可用性: Unix。

注解

在 macOS 中，getgroups() 会和其他 Unix 平台有所不同。 如果 Python 解释器是在 10.5 或更早版本中部署的，则 getgroups() 会返回与当前用户进程相关联的有效组 ID 列表；该列表受限于系统预定义的条目数量，通常为 16，并且在适当的权限下还可通过调用 setgroups() 来修改。 如果是在高于 10.5 的版本中部署的，则 getgroups() 会返回与进程的有效用户 ID 相关联的当前组访问列表；组访问列表可能会在进程的生命周期之内发生改变，它不会受对 setgroups() 的调用影响，且其长度也不被限制为 16。 部署目标值 MACOSX_DEPLOYMENT_TARGET 可以通过 sysconfig.get_config_var() 来获取。

os.getlogin()

返回通过控制终端进程进行登录的用户名。在多数情况下，使用 getpass.getuser() 会更有效，因为后者会通过检查环境变量 LOGNAME 或 USERNAME 来查找用户，再由 pwd.getpwuid(os.getuid())[0] 来获取当前用户 ID 的登录名。

可用性: Unix, Windows。

os.getpgid(pid)

根据进程id pid 返回进程的组 ID 列表。如果 pid 为 0，则返回当前进程的进程组 ID 列表

可用性: Unix。

os.getpgrp()

返回当时进程组的ID

可用性: Unix。

os.getpid()

返回当前进程ID

os.getppid()

返回父进程ID。当父进程已经结束，在Unix中返回的ID是初始进程(1)中的一个，在Windows中仍然是同一个进程ID，该进程ID有可能已经被进行进程所占用。

可用性: Unix, Windows。

在 3.2 版更改: 添加 Windows 的支持。

os.getpriority(which, who)

获取程序调度优先级。which 参数值可以是 PRIO_PROCESS，PRIO_PGRP，或 PRIO_USER 中的一个，who 是相对于 which (PRIO_PROCESS 的进程标识符，PRIO_PGRP 的进程组标识符和 PRIO_USER 的用户ID)。当 who 为 0 时（分别）表示调用的进程，调用进程的进程组或调用进程所属的真实用户 ID。

可用性: Unix。

3.3 新版功能.

os.PRIO_PROCESS

os.PRIO_PGRP

os.PRIO_USER

函数 getpriority() 和 setpriority() 的参数。

可用性: Unix。

3.3 新版功能.

os.getresuid()

返回一个由 (ruid, euid, suid) 所组成的元组，分别表示当前进程的真实用户ID，有效用户ID和暂存用户ID。

可用性: Unix。

3.2 新版功能.

os.getresgid()

返回一个由 (rgid, egid, sgid) 所组成的元组，分别表示当前进程的真实组ID，有效组ID和暂存组ID。

可用性: Unix。

3.2 新版功能.

os.getuid()

返回当前进程的真实用户ID。

可用性: Unix。

os.initgroups(username, gid)

调用系统 initgroups()，使用指定用户所在的所有值来初始化组访问列表，包括指定的组ID。

可用性: Unix。

3.2 新版功能.

os.putenv(key, value)

将名为 key 的环境变量值设置为 value。该变量名修改会影响由 os.system()， popen() ，fork() 和 execv() 发起的子进程。

对 os.environ 中的项目的赋值会自动转化为对 putenv() 的相应调用；然而，对 putenv() 的调用并不更新 os.environ ，所以实际上最好是赋值到 os.environ 的项目。这也适用于 getenv() 和 getenvb() ，它们分别使用 os.environ 和 os.environb 在它们的实现中。

注解

在某些平台上，包括 FreeBSD 和 macOS，设置 environ 可能导致内存泄漏。 请参阅 putenv() 的系统文档。

引发一个 审计事件 os.putenv 并附带参数 key, value。

在 3.9 版更改: 该函数现在总是可用。

os.setegid(egid)

设置当前进程的有效组ID。

可用性: Unix。

os.seteuid(euid)

设置当前进程的有效用户ID。

可用性: Unix。

os.setgid(gid)

设置当前进程的组ID。

可用性: Unix。

os.setgroups(groups)

将 group 参数值设置为与当进程相关联的附加组ID列表。group 参数必须为一个序列，每个元素应为每个组的数字ID。该操作通常只适用于超级用户。

可用性: Unix。

注解

在 macOS 中，groups 的长度不能超过系统定义的最大有效组 ID 数量，通常为 16。 对于未返回与调用 setgroups() 产生的相同组列表的情况，请参阅 getgroups() 的文档。

os.setpgrp()

根据已实现的版本（如果有）来调用系统 setpgrp() 或 setpgrp(0, 0) 。相关说明，请参考 Unix 手册。

可用性: Unix。

os.setpgid(pid, pgrp)

使用系统调用 setpgid()，将 pid 对应进程的组ID设置为 pgrp。相关说明，请参考 Unix 手册。

可用性: Unix。

os.setpriority(which, who, priority)

设置程序调度优先级。 which 的值为 PRIO_PROCESS, PRIO_PGRP 或 PRIO_USER 之一，而 who 会相对于 which (PRIO_PROCESS 的进程标识符, PRIO_PGRP 的进程组标识符和 PRIO_USER 的用户 ID) 被解析。 who 值为零 (分别) 表示调用进程，调用进程的进程组或调用进程的真实用户 ID。 priority 是范围在 -20 至 19 的值。 默认优先级为 0；较小的优先级数值会更优先被调度。

可用性: Unix。

3.3 新版功能.

os.setregid(rgid, egid)

设置当前进程的真实和有效组ID。

可用性: Unix。

os.setresgid(rgid, egid, sgid)

设置当前进程的真实，有效和暂存组ID。

可用性: Unix。

3.2 新版功能.

os.setresuid(ruid, euid, suid)

设置当前进程的真实，有效和暂存用户ID。

可用性: Unix。

3.2 新版功能.

os.setreuid(ruid, euid)

设置当前进程的真实和有效用户ID。

可用性: Unix。

os.getsid(pid)

调用系统调用 getsid()。相关说明，请参考 Unix 手册。

可用性: Unix。

os.setsid()

使用系统调用 getsid()。相关说明，请参考 Unix 手册。

可用性: Unix。

os.setuid(uid)

设置当前进程的用户ID。

可用性: Unix。

os.strerror(code)

根据 code 中的错误码返回错误消息。 在某些平台上当给出未知错误码时 strerror() 将返回 NULL 并会引发 ValueError。

os.supports_bytes_environ

如果操作系统上原生环境类型是字节型则为 True (例如在 Windows 上为 False)。

3.2 新版功能.

os.umask(mask)

设定当前数值掩码并返回之前的掩码。

os.uname()

返回当前操作系统的识别信息。返回值是一个有5个属性的对象：

sysname - 操作系统名

nodename - 机器在网络上的名称（需要先设定）

release - 操作系统发行信息

version - 操作系统版本信息

machine - 硬件标识符

为了向后兼容，该对象也是可迭代的，像是一个按照 sysname，nodename，release，version，和 machine 顺序组成的元组。

有些系统会将 nodename 截短为 8 个字符或截短至前缀部分；获取主机名的一个更好方式是 socket.gethostname() 或甚至可以用 socket.gethostbyaddr(socket.gethostname())。

可用性: 较新的 Unix 版本。

在 3.3 版更改: 返回结果的类型由元组变成一个类似元组的对象，同时具有命名的属性。

os.unsetenv(key)

取消设置（删除）名为 key 的环境变量。变量名的改变会影响由 os.system()，popen()，fork() 和 execv() 触发的子进程。

删除 os.environ 中的项目会自动转化为对 unsetenv() 的相应调用；然而，对 unsetenv() 的调用并不更新 os.environ ，所以实际上最好是删除 os.environ 的项目。

引发一个 审计事件 os.unsetenv 并附带参数 key。

在 3.9 版更改: 该函数现在总是可用，并且在 Windows 上也可用。

创建文件对象

这些函数创建新的 file objects 。（参见 open() 以获取打开文件描述符的相关信息。）

os.fdopen(fd, *args, **kwargs)

返回打开文件描述符 fd 对应文件的对象。类似内建 open() 函数，二者接受同样的参数。不同之处在于 fdopen() 第一个参数应该为整数。

文件描述符操作

这些函数对文件描述符所引用的 I/O 流进行操作。

文件描述符是一些小的整数，对应于当前进程所打开的文件。例如，标准输入的文件描述符通常是0，标准输出是1，标准错误是2。之后被进程打开的文件的文件描述符会被依次指定为3，4，5等。“文件描述符”这个词有点误导性，在 Unix 平台中套接字和管道也被文件描述符所引用。

当需要时，可以用 fileno() 可以获得 file object 所对应的文件描述符。需要注意的是，直接使用文件描述符会绕过文件对象的方法，会忽略如数据内部缓冲等情况。

os.close(fd)

关闭文件描述符 fd。

注解

该功能适用于低级 I/O 操作，必须用于 os.open() 或 pipe() 返回的文件描述符。若要关闭由内建函数 open()、popen() 或 fdopen() 返回的 "文件对象"，则应使用其相应的 close() 方法。

os.closerange(fd_low, fd_high)

关闭从 fd_low （包括）到 fd_high （排除）间的文件描述符，并忽略错误。类似（但快于）:

for fd in range(fd_low, fd_high):
    try:
        os.close(fd)
    except OSError:
        pass

os.copy_file_range(src, dst, count, offset_src=None, offset_dst=None)

从文件描述符 src 复制 count 字节，从偏移量 offset_src 开始读取，到文件描述符 dst，从偏移量 offset_dst 开始写入。如果 offset_src 为 None，则 src 将从当前位置开始读取；offset_dst 同理。src 和 dst 指向的文件必须处于相同的文件系统，否则将会抛出一个 errno 被设为 errno.EXDEV 的 OSError 。

此复制的完成没有额外的从内核到用户空间再回到内核的数据转移花费。另外，一些文件系统可能实现额外的优化。完成复制就如同打开两个二进制文件一样。

返回值是复制的字节的数目。这可能低于需求的数目。

Availability: Linux kernel >= 4.5 或 glibc >= 2.27。

3.8 新版功能.

os.device_encoding(fd)

如果连接到终端，则返回一个与 fd 关联的设备描述字符，否则返回 None。

在 Unix 上，如果启用了 Python UTF-8 模式，则返回 'UTF-8' 而不是设备的编码格式。

在 3.10 版更改: 在 Unix 上，该函数现在实现了 Python UTF-8 模式。

os.dup(fd)

返回一个文件描述符 fd 的副本。该文件描述符的副本是 不可继承的。

在 Windows 中，当复制一个标准流（0: stdin, 1: stdout, 2: stderr）时，新的文件描述符是 可继承的。

在 3.4 版更改: 新的文件描述符现在是不可继承的。

os.dup2(fd, fd2, inheritable=True)

把文件描述符 fd 复制为 fd2，必要时先关闭后者。返回 fd2。新的文件描述符默认是 可继承的，除非在 inheritable 为 False 时，是不可继承的。

在 3.4 版更改: 添加可选参数 inheritable。

在 3.7 版更改: 成功时返回 fd2，以过去的版本中，总是返回 None。

os.fchmod(fd, mode)

将 fd 指定文件的权限状态修改为 mode。可以参考 chmod() 中列出 mode 的可用值。从Python 3.3开始，这相当于 os.chmod(fd, mode)。

引发一个 审计事件 os.chmod 并附带参数 path, mode, dir_fd。

可用性: Unix。

os.fchown(fd, uid, gid)

分别将 fd 指定文件的所有者和组 ID 修改为 uid 和 gid 的值。若不想变更其中的某个 ID，可将相应值设为 -1。参考 chown()。从 Python 3.3 开始，这相当于 os.chown(fd, uid, gid)。

引发一个 审计事件 os.chown 并附带参数 path, uid, gid, dir_fd。

可用性: Unix。

os.fdatasync(fd)

强制将文件描述符 fd 指定文件写入磁盘。不强制更新元数据。

可用性: Unix。

注解

该功能在 MacOS 中不可用。

os.fpathconf(fd, name)

返回与打开的文件有关的系统配置信息。name 指定要查找的配置名称，它可以是字符串，是一个系统已定义的名称，这些名称定义在不同标准（POSIX.1，Unix 95，Unix 98 等）中。一些平台还定义了额外的其他名称。当前操作系统已定义的名称在 pathconf_names 字典中给出。对于未包含在该映射中的配置名称，也可以传递一个整数作为 name。

如果 name 是一个字符串且不是已定义的名称，将抛出 ValueError 异常。如果当前系统不支持 name 指定的配置名称，即使该名称存在于 pathconf_names，也会抛出 OSError 异常，错误码为 errno.EINVAL。

从 Python 3.3 起，此功能等价于 os.pathconf(fd, name)。

可用性: Unix。

os.fstat(fd)

获取文件描述符 fd 的状态. 返回一个 stat_result 对象。

从 Python 3.3 起，此功能等价于 os.stat(fd)。

参见

stat() 函数。

os.fstatvfs(fd)

返回文件系统的信息，该文件系统是文件描述符 fd 指向的文件所在的文件系统，与 statvfs() 一样。从 Python 3.3 开始，它等效于 os.statvfs(fd)。

可用性: Unix。

os.fsync(fd)

强制将文件描述符 fd 指向的文件写入磁盘。在 Unix，这将调用原生 fsync() 函数；在 Windows，则是 MS _commit() 函数。

如果要写入的是缓冲区内的 Python 文件对象 f，请先执行 f.flush()，然后执行 os.fsync(f.fileno())，以确保与 f 关联的所有内部缓冲区都写入磁盘。

可用性: Unix, Windows。

os.ftruncate(fd, length)

截断文件描述符 fd 指向的文件，以使其最大为 length 字节。从 Python 3.3 开始，它等效于 os.truncate(fd, length)。

引发一个 审计事件 os.truncate 并附带参数 fd, length。

可用性: Unix, Windows。

在 3.5 版更改: 添加了 Windows 支持

os.get_blocking(fd)

获取文件描述符的阻塞模式：如果设置了 O_NONBLOCK 标志位，返回 False，如果该标志位被清除，返回 True。

参见 set_blocking() 和 socket.socket.setblocking()。

可用性: Unix。

3.5 新版功能.

os.isatty(fd)

如果文件描述符 fd 打开且已连接至 tty 设备（或类 tty 设备），返回 True，否则返回 False。

os.lockf(fd, cmd, len)

在打开的文件描述符上，使用、测试或删除 POSIX 锁。fd 是一个打开的文件描述符。cmd 指定要进行的操作，它们是 F_LOCK、F_TLOCK、F_ULOCK 或 F_TEST 中的一个。len 指定哪部分文件需要锁定。

引发一个 审计事件 os.lockf 并附带参数 fd, cmd, len。

可用性: Unix。

3.3 新版功能.

os.F_LOCK

os.F_TLOCK

os.F_ULOCK

os.F_TEST

标志位，用于指定 lockf() 进行哪一种操作。

可用性: Unix。

3.3 新版功能.

os.lseek(fd, pos, how)

将文件描述符 fd 的当前位置设置为 pos，位置的计算方式 how 如下：设置为 SEEK_SET 或 0 表示从文件开头计算，设置为 SEEK_CUR 或 1 表示从文件当前位置计算，设置为 SEEK_END 或 2 表示文件末尾计算。返回新指针位置，这个位置是从文件开头计算的，单位是字节。

os.SEEK_SET

os.SEEK_CUR

os.SEEK_END

lseek() 函数的参数，它们的值分别为 0、1 和 2。

3.3 新版功能: 某些操作系统可能支持其他值，例如 os.SEEK_HOLE 或 os.SEEK_DATA。

os.open(path, flags, mode=0o777, *, dir_fd=None)

打开文件 path，根据 flags 设置各种标志位，并根据 mode 设置其权限状态。当计算 mode 时，会首先根据当前 umask 值将部分权限去除。本方法返回新文件的描述符。新的文件描述符是 不可继承 的。

有关 flag 和 mode 取值的说明，请参见 C 运行时文档。标志位常量（如 O_RDONLY 和 O_WRONLY）在 os 模块中定义。特别地，在 Windows 上需要添加 O_BINARY 才能以二进制模式打开文件。

本函数带有 dir_fd 参数，支持 基于目录描述符的相对路径。

引发一个 审计事件 open 并附带参数 path, mode, flags。

在 3.4 版更改: 新的文件描述符现在是不可继承的。

注解

本函数适用于底层的 I/O。常规用途请使用内置函数 open()，该函数的 read() 和 write() 方法（及其他方法）会返回 文件对象。要将文件描述符包装在文件对象中，请使用 fdopen()。

3.3 新版功能: dir_fd 参数。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

在 3.6 版更改: 接受一个 path-like object。

以下常量是 open() 函数 flags 参数的选项。可以用按位或运算符 | 将它们组合使用。部分常量并非在所有平台上都可用。有关其可用性和用法的说明，请参阅 open(2) 手册（Unix 上）或 MSDN [https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx] （Windows 上）。

os.O_RDONLY

os.O_WRONLY

os.O_RDWR

os.O_APPEND

os.O_CREAT

os.O_EXCL

os.O_TRUNC

上述常量在 Unix 和 Windows 上均可用。

os.O_DSYNC

os.O_RSYNC

os.O_SYNC

os.O_NDELAY

os.O_NONBLOCK

os.O_NOCTTY

os.O_CLOEXEC

这个常数仅在 Unix 系统中可用。

在 3.3 版更改: 增加 O_CLOEXEC 常量。

os.O_BINARY

os.O_NOINHERIT

os.O_SHORT_LIVED

os.O_TEMPORARY

os.O_RANDOM

os.O_SEQUENTIAL

os.O_TEXT

这个常数仅在 Windows 系统中可用。

os.O_EVTONLY

os.O_FSYNC

os.O_SYMLINK

os.O_NOFOLLOW_ANY

以上常量仅适用于 macOS。

在 3.10 版更改: 加入 O_EVTONLY 、 O_FSYNC 、 O_SYMLINK 和 O_NOFOLLOW_ANY 常量。

os.O_ASYNC

os.O_DIRECT

os.O_DIRECTORY

os.O_NOFOLLOW

os.O_NOATIME

os.O_PATH

os.O_TMPFILE

os.O_SHLOCK

os.O_EXLOCK

上述常量是扩展常量，如果 C 库未定义它们，则不存在。

在 3.4 版更改: 在支持的系统上增加 O_PATH。增加 O_TMPFILE，仅在 Linux Kernel 3.11 或更高版本可用。

os.openpty()

打开一对新的伪终端，返回一对文件描述符 （主，从），分别为 pty 和 tty。新的文件描述符是 不可继承 的。对于（稍微）轻量一些的方法，请使用 pty 模块。

可用性: 某些 Unix。

在 3.4 版更改: 新的文件描述符不再可继承。

os.pipe()

创建一个管道，返回一对分别用于读取和写入的文件描述符 (r, w)。新的文件描述符是 不可继承 的。

可用性: Unix, Windows。

在 3.4 版更改: 新的文件描述符不再可继承。

os.pipe2(flags)

创建带有 flags 标志位的管道。可通过对以下一个或多个值进行“或”运算来构造这些 flags：O_NONBLOCK、O_CLOEXEC。返回一对分别用于读取和写入的文件描述符 (r, w)。

可用性: 某些 Unix。

3.3 新版功能.

os.posix_fallocate(fd, offset, len)

确保为 fd 指向的文件分配了足够的磁盘空间，该空间从偏移量 offset 开始，到 len 字节为止。

可用性: Unix。

3.3 新版功能.

os.posix_fadvise(fd, offset, len, advice)

声明即将以特定模式访问数据，使内核可以提前进行优化。数据范围是从 fd 所指向文件的 offset 开始，持续 len 个字节。advice 的取值是如下之一：POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL, POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED 或 POSIX_FADV_DONTNEED。

可用性: Unix。

3.3 新版功能.

os.POSIX_FADV_NORMAL

os.POSIX_FADV_SEQUENTIAL

os.POSIX_FADV_RANDOM

os.POSIX_FADV_NOREUSE

os.POSIX_FADV_WILLNEED

os.POSIX_FADV_DONTNEED

用于 posix_fadvise() 的 advice 参数的标志位，指定可能使用的访问模式。

可用性: Unix。

3.3 新版功能.

os.pread(fd, n, offset)

从文件描述符 fd 所指向文件的偏移位置 offset 开始，读取至多 n 个字节，而保持文件偏移量不变。

返回所读取字节的字节串 (bytestring)。如果到达了 fd 指向的文件末尾，则返回空字节对象。

可用性: Unix。

3.3 新版功能.

os.preadv(fd, buffers, offset, flags=0)

从文件描述符 fd 所指向文件的偏移位置 offset 开始，将数据读取至可变 字节类对象 缓冲区 buffers 中，保持文件偏移量不变。将数据依次存放到每个缓冲区中，填满一个后继续存放到序列中的下一个缓冲区，来保存其余数据。

flags 参数可以由零个或多个标志位进行按位或运算来得到：

RWF_HIPRI

RWF_NOWAIT

返回实际读取的字节总数，该总数可以小于所有对象的总容量。

操作系统可能对允许使用的缓冲区数量有限制（使用 sysconf() 获取 'SC_IOV_MAX' 值）。

本方法结合了 os.readv() 和 os.pread() 的功能。

可用性：Linux 2.6.30 或更高版本，FreeBSD 6.0 或更高版本，OpenBSD 2.7 或更高版本，AIX 7.1 或更高版本。使用标志位需要 Linux 4.6 或更高版本。

3.7 新版功能.

os.RWF_NOWAIT

不要等待无法立即获得的数据。如果指定了此标志，那么当需要从后备存储器中读取数据，或等待文件锁时，系统调用将立即返回。

如果成功读取数据，则返回读取的字节数。如果未读取到数据，则返回 -1，并将错误码 errno 置为 errno.EAGAIN。

可用性：Linux 4.14 或更高版本。

3.7 新版功能.

os.RWF_HIPRI

高优先级读/写。允许基于块的文件系统对设备进行轮询，这样可以降低延迟，但可能会占用更多资源。

目前在 Linux 上，此功能仅在使用 O_DIRECT 标志打开的文件描述符上可用。

可用性：Linux 4.6 或更高版本。

3.7 新版功能.

os.pwrite(fd, str, offset)

将 str 中的字节串 (bytestring) 写入文件描述符 fd 的偏移位置 offset 处，保持文件偏移量不变。

返回实际写入的字节数。

可用性: Unix。

3.3 新版功能.

os.pwritev(fd, buffers, offset, flags=0)

将缓冲区 buffers 的内容写入文件描述符 fd 的偏移位置 offset 处，保持文件偏移量不变。缓冲区 buffers 必须是由 字节类对象 组成的序列。缓冲区以数组顺序处理。先写入第一个缓冲区的全部内容，再写入第二个缓冲区，照此继续。

flags 参数可以由零个或多个标志位进行按位或运算来得到：

RWF_DSYNC

RWF_SYNC

RWF_APPEND

返回实际写入的字节总数。

操作系统可能对允许使用的缓冲区数量有限制（使用 sysconf() 获取 'SC_IOV_MAX' 值）。

本方法结合了 os.writev() 和 os.pwrite() 的功能。

可用性：Linux 2.6.30 或更高版本，FreeBSD 6.0 或更高版本，OpenBSD 2.7 或更高版本，AIX 7.1 或更高版本。使用标志位需要 Linux 4.7 或更高版本。

3.7 新版功能.

os.RWF_DSYNC

提供预写功能，等效于带 O_DSYNC 标志的 os.open() 。本标志只作用于通过系统调用写入的数据。

可用性：Linux 4.7 或更高版本。

3.7 新版功能.

os.RWF_SYNC

提供预写功能，等效于带 O_SYNC 标志的 os.open() 。本标志只作用于通过系统调用写入的数据。

可用性：Linux 4.7 或更高版本。

3.7 新版功能.

os.RWF_APPEND

提供预写功能，等效于带 O_APPEND 标志的 os.open() 。本标志只对 os.pwritev() 有意义，只作用于通过系统调用写入的数据。参数 offset 对写入操作无效；数据总是会添加到文件的末尾。但如果 offset 参数为 -1，则会刷新当前文件的 offset 。

可用性：Linux 4.16 以上版本。

3.10 新版功能.

os.read(fd, n)

从文件描述符 fd 中读取至多 n 个字节。

返回所读取字节的字节串 (bytestring)。如果到达了 fd 指向的文件末尾，则返回空字节对象。

注解

该功能适用于低级 I/O 操作，必须用于 os.open() 或 pipe() 返回的文件描述符。若要读取由内建函数 open()、popen()、fdopen() 或 sys.stdin 返回的 "文件对象"，则应使用其相应的 read() 或 readline() 方法。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

os.sendfile(out_fd, in_fd, offset, count)

os.sendfile(out_fd, in_fd, offset, count, headers=(), trailers=(), flags=0)

将文件描述符 in_fd 中的 count 字节复制到文件描述符 out_fd 的偏移位置 offset 处。返回复制的字节数，如果到达 EOF，返回 0。

定义了 sendfile() 的所有平台均支持第一种函数用法。

在 Linux 上，将 offset 设置为 None，则从 in_fd 的当前位置开始读取，并更新 in_fd 的位置。

第二种情况可以被用于 macOS 和 FreeBSD，其中 headers 和 trailers 是任意的缓冲区序列，它们会在写入来自 in_fd 的数据之前被写入。 它的返回内容与第一种情况相同。

在 macOS 和 FreeBSD 上，传入 0 值作为 count 将指定持续发送直至到达 in_fd 的末尾。

所有平台都支持将套接字作为 out_fd 文件描述符，有些平台也支持其他类型（如常规文件或管道）。

跨平台应用程序不应使用 headers、trailers 和 flags 参数。

可用性: Unix。

注解

有关 sendfile() 的高级封装，参见 socket.socket.sendfile()。

3.3 新版功能.

在 3.9 版更改: out 和 in 参数被重命名为 out_fd 和 in_fd。

os.set_blocking(fd, blocking)

设置指定文件描述符的阻塞模式：如果 blocking 为 False，则为该描述符设置 O_NONBLOCK 标志位，反之则清除该标志位。

参见 get_blocking() 和 socket.socket.setblocking()。

可用性: Unix。

3.5 新版功能.

os.SF_NODISKIO

os.SF_MNOWAIT

os.SF_SYNC

sendfile() 函数的参数（假设当前实现支持这些参数）。

可用性: Unix。

3.3 新版功能.

os.splice(src, dst, count, offset_src=None, offset_dst=None)

由文件描述符 src 传输 count 字节，从偏移量 offset_src 开始读取，到文件描述符 dst，从偏移量 offset_dst 开始写入。至少得有一个文件描述符必须指向管道。如果 offset_src 为 None，则 src 将从当前位置开始读取；offset_dst 同理。指向管道的文件描述符，其偏移量必须为 None。 src 和 dst 指向的文件必须处于同一文件系统中，否则将会触发 OSError ，其 errno 将被设为 errno.EXDEV 。

此复制的完成没有额外的从内核到用户空间再回到内核的数据转移花费。另外，一些文件系统可能实现额外的优化。完成复制就如同打开两个二进制文件一样。

调用成功后，返回拼接到管道的字节数或从管道拼接出来的字节数。返回值为 0 意味着输入结束。如果 src 指向一个管道，则意味着没有数据需要传输，而且由于没有写入程序连到管道的写入端，所以将不会阻塞。

可用性： Linux >= 2.6.27 且 glibc >= 2.5。

3.10 新版功能.

os.SPLICE_F_MOVE

os.SPLICE_F_NONBLOCK

os.SPLICE_F_MORE

3.10 新版功能.

os.readv(fd, buffers)

从文件描述符 fd 将数据读取至多个可变的 字节类对象 缓冲区 buffers 中。将数据依次存放到每个缓冲区中，填满一个后继续存放到序列中的下一个缓冲区，来保存其余数据。

返回实际读取的字节总数，该总数可以小于所有对象的总容量。

操作系统可能对允许使用的缓冲区数量有限制（使用 sysconf() 获取 'SC_IOV_MAX' 值）。

可用性: Unix。

3.3 新版功能.

os.tcgetpgrp(fd)

返回与 fd 指定的终端相关联的进程组（fd 是由 os.open() 返回的已打开的文件描述符）。

可用性: Unix。

os.tcsetpgrp(fd, pg)

设置与 fd 指定的终端相关联的进程组为 pg*（*fd 是由 os.open() 返回的已打开的文件描述符）。

可用性: Unix。

os.ttyname(fd)

返回一个字符串，该字符串表示与文件描述符 fd 关联的终端。如果 fd 没有与终端关联，则抛出异常。

可用性: Unix。

os.write(fd, str)

将 str 中的字节串 (bytestring) 写入文件描述符 fd。

返回实际写入的字节数。

注解

该功能适用于低级 I/O 操作，必须用于 os.open() 或 pipe() 返回的文件描述符。若要写入由内建函数 open()、popen()、fdopen()、sys.stdout 或 sys.stderr 返回的 "文件对象"，则应使用其相应的 write() 方法。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

os.writev(fd, buffers)

将缓冲区 buffers 的内容写入文件描述符 fd。缓冲区 buffers 必须是由 字节类对象 组成的序列。缓冲区以数组顺序处理。先写入第一个缓冲区的全部内容，再写入第二个缓冲区，照此继续。

返回实际写入的字节总数。

操作系统可能对允许使用的缓冲区数量有限制（使用 sysconf() 获取 'SC_IOV_MAX' 值）。

可用性: Unix。

3.3 新版功能.

查询终端的尺寸

3.3 新版功能.

os.get_terminal_size(fd=STDOUT_FILENO)

返回终端窗口的尺寸，格式为 (columns, lines)，它是类型为 terminal_size 的元组。

可选参数 fd （默认为 STDOUT_FILENO 或标准输出）指定应查询的文件描述符。

如果文件描述符未连接到终端，则抛出 OSError 异常。

shutil.get_terminal_size() 是供常规使用的高阶函数，os.get_terminal_size 是其底层的实现。

可用性: Unix, Windows。

class os.terminal_size

元组的子类，存储终端窗口尺寸 (columns, lines)。

columns

终端窗口的宽度，单位为字符。

lines

终端窗口的高度，单位为字符。

文件描述符的继承

3.4 新版功能.

每个文件描述符都有一个 "inheritable"（可继承）标志位，该标志位控制了文件描述符是否可以由子进程继承。从 Python 3.4 开始，由 Python 创建的文件描述符默认是不可继承的。

在 UNIX 上，执行新程序时，不可继承的文件描述符在子进程中是关闭的，其他文件描述符将被继承。

在 Windows 上，不可继承的句柄和文件描述符在子进程中是关闭的，但标准流（文件描述符 0、1 和 2 即标准输入、标准输出和标准错误）是始终继承的。如果使用 spawn* 函数，所有可继承的句柄和文件描述符都将被继承。如果使用 subprocess 模块，将关闭除标准流以外的所有文件描述符，并且仅当 close_fds 参数为 False 时才继承可继承的句柄。

os.get_inheritable(fd)

获取指定文件描述符的“可继承”标志位（为布尔值）。

os.set_inheritable(fd, inheritable)

设置指定文件描述符的“可继承”标志位。

os.get_handle_inheritable(handle)

获取指定句柄的“可继承”标志位（为布尔值）。

可用性: Windows。

os.set_handle_inheritable(handle, inheritable)

设置指定句柄的“可继承”标志位。

可用性: Windows。

文件和目录

在某些 Unix 平台上，许多函数支持以下一项或多项功能：

指定文件描述符为参数： 通常在 os 模块中提供给函数的 path 参数必须是表示文件路径的字符串，但是，某些函数现在可以接受其 path 参数为打开文件描述符，该函数将对描述符指向的文件进行操作。（对于 POSIX 系统，Python 将调用以 f 开头的函数变体（如调用 fchdir 而不是 chdir）。）

可以用 os.supports_fd 检查某个函数在你的平台上是否支持将 path 参数指定为文件描述符。如果不支持，使用该功能将抛出 NotImplementedError 异常。

如果该函数还支持 dir_fd 或 follow_symlinks 参数，那么用文件描述符作为 path 后就不能再指定上述参数了。

基于目录描述符的相对路径： 如果 dir_fd 不是 None，它就应该是一个指向目录的文件描述符，这时待操作的 path 应该是相对路径，相对路径是相对于前述目录的。如果 path 是绝对路径，则 dir_fd 将被忽略。（对于 POSIX 系统，Python 将调用该函数的变体，变体以 at 结尾，可能以 f 开头（如调用 faccessat 而不是 access）。

可以用 os.supports_dir_fd 检查某个函数在你的平台上是否支持 dir_fd。如果不支持，使用该功能将抛出 NotImplementedError 异常。

不跟踪符号链接： 如果 follow_symlinks 为 False，并且待操作路径的最后一个元素是符号链接，则该函数将在符号链接本身而不是链接所指向的文件上操作。（对于 POSIX 系统，Python 将调用该函数的 l... 变体。）

可以用 os.supports_follow_symlinks 检查某个函数在你的平台上是否支持 follow_symlinks。如果不支持，使用该功能将抛出 NotImplementedError 异常。

os.access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)

使用 实际用户ID/用户组ID 测试对 path 的访问。请注意，大多数测试操作将使用 有效用户ID/用户组ID，因此可以在 suid/sgid 环境中运用此例程，来测试调用用户是否具有对 path 的指定访问权限。mode 为 F_OK 时用于测试 path 是否存在，也可以对 R_OK、W_OK 和 X_OK 中的一个或多个进行“或”运算来测试指定权限。允许访问则返回 True，否则返回 False。更多信息请参见 Unix 手册页 access(2)。

本函数支持指定 基于目录描述符的相对路径 和 不跟踪符号链接。

如果 effective_ids 为 True，access() 将使用 有效用户ID/用户组ID 而非 实际用户ID/用户组ID 进行访问检查。您的平台可能不支持 effective_ids，您可以使用 os.supports_effective_ids 检查它是否可用。如果不可用，使用它时会抛出 NotImplementedError 异常。

注解

使用 access() 来检查用户是否具有某项权限（如打开文件的权限），然后再使用 open() 打开文件，这样做存在一个安全漏洞，因为用户可能会在检查和打开文件之间的时间里做其他操作。推荐使用 EAFP 技术。如:

if os.access("myfile", os.R_OK):
    with open("myfile") as fp:
        return fp.read()
return "some default data"

最好写成:

try:
    fp = open("myfile")
except PermissionError:
    return "some default data"
else:
    with fp:
        return fp.read()

注解

即使 access() 指示 I/O 操作会成功，但实际操作仍可能失败，尤其是对网络文件系统的操作，其权限语义可能超出常规的 POSIX 权限位模型。

在 3.3 版更改: 添加 dir_fd、effective_ids 和 follow_symlinks 参数。

在 3.6 版更改: 接受一个 path-like object。

os.F_OK

os.R_OK

os.W_OK

os.X_OK

作为 access() 的 mode 参数的可选值，分别测试 path 的存在性、可读性、可写性和可执行性。

os.chdir(path)

将当前工作目录更改为 path。

本函数支持 指定文件描述符为参数。其中，描述符必须指向打开的目录，不能是打开的文件。

本函数可以抛出 OSError 及其子类的异常，如 FileNotFoundError、PermissionError 和 NotADirectoryError 异常。

引发一个 审计事件 os.chdir 并附带参数 path。

3.3 新版功能: 在某些平台上新增支持将 path 参数指定为文件描述符。

在 3.6 版更改: 接受一个 path-like object。

os.chflags(path, flags, *, follow_symlinks=True)

将 path 的 flags 设置为其他由数字表示的 flags。flags 可以用以下值按位或组合起来（以下值在 stat 模块中定义）：

stat.UF_NODUMP

stat.UF_IMMUTABLE

stat.UF_APPEND

stat.UF_OPAQUE

stat.UF_NOUNLINK

stat.UF_COMPRESSED

stat.UF_HIDDEN

stat.SF_ARCHIVED

stat.SF_IMMUTABLE

stat.SF_APPEND

stat.SF_NOUNLINK

stat.SF_SNAPSHOT

本函数支持 不跟踪符号链接。

引发一个 审计事件 os.chflags 并附带参数 path, flags。

可用性: Unix。

3.3 新版功能: follow_symlinks 参数。

在 3.6 版更改: 接受一个 path-like object。

os.chmod(path, mode, *, dir_fd=None, follow_symlinks=True)

将 path 的 mode 更改为其他由数字表示的 mode。mode 可以用以下值之一，也可以将它们按位或组合起来（以下值在 stat 模块中定义）：

stat.S_ISUID

stat.S_ISGID

stat.S_ENFMT

stat.S_ISVTX

stat.S_IREAD

stat.S_IWRITE

stat.S_IEXEC

stat.S_IRWXU

stat.S_IRUSR

stat.S_IWUSR

stat.S_IXUSR

stat.S_IRWXG

stat.S_IRGRP

stat.S_IWGRP

stat.S_IXGRP

stat.S_IRWXO

stat.S_IROTH

stat.S_IWOTH

stat.S_IXOTH

本函数支持 指定文件描述符、指定基于目录描述符的相对路径 和 不跟踪符号链接。

注解

尽管 Windows 支持 chmod()，但只能用它设置文件的只读标志（stat.S_IWRITE 和 stat.S_IREAD 常量或对应的整数值）。所有其他标志位都会被忽略。

引发一个 审计事件 os.chmod 并附带参数 path, mode, dir_fd。

3.3 新版功能: 添加了指定 path 为文件描述符的支持，以及 dir_fd 和 follow_symlinks 参数。

在 3.6 版更改: 接受一个 path-like object。

os.chown(path, uid, gid, *, dir_fd=None, follow_symlinks=True)

将 path 的用户和组 ID 分别修改为数字形式的 uid 和 gid。若要使其中某个 ID 保持不变，请将其置为 -1。

本函数支持 指定文件描述符、指定基于目录描述符的相对路径 和 不跟踪符号链接。

参见更高阶的函数 shutil.chown()，除了数字 ID 之外，它也接受名称。

引发一个 审计事件 os.chown 并附带参数 path, uid, gid, dir_fd。

可用性: Unix。

3.3 新版功能: 添加了指定 path 为文件描述符的支持，以及 dir_fd 和 follow_symlinks 参数。

在 3.6 版更改: 支持 类路径对象。

os.chroot(path)

将当前进程的根目录更改为 path。

可用性: Unix。

在 3.6 版更改: 接受一个 path-like object。

os.fchdir(fd)

将当前工作目录更改为文件描述符 fd 指向的目录。fd 必须指向打开的目录而非文件。从 Python 3.3 开始，它等效于 os.chdir(fd)。

引发一个 审计事件 os.chdir 并附带参数 path。

可用性: Unix。

os.getcwd()

返回表示当前工作目录的字符串。

os.getcwdb()

返回表示当前工作目录的字节串 (bytestring)。

在 3.8 版更改: 在 Windows 上，本函数现在会使用 UTF-8 编码格式而不是 ANSI 代码页：请参看 PEP 529 [https://www.python.org/dev/peps/pep-0529] 了解具体原因。 该函数在 Windows 上不再被弃用。

os.lchflags(path, flags)

将 path 的 flags 设置为其他由数字表示的 flags，与 chflags() 类似，但不跟踪符号链接。从 Python 3.3 开始，它等效于 os.chflags(path, flags, follow_symlinks=False)。

引发一个 审计事件 os.chflags 并附带参数 path, flags。

可用性: Unix。

在 3.6 版更改: 接受一个 path-like object。

os.lchmod(path, mode)

将 path 的权限状态修改为 mode。如果 path 是符号链接，则影响符号链接本身而非链接目标。可以参考 chmod() 中列出 mode 的可用值。从 Python 3.3 开始，它等效于 os.chmod(path, mode, follow_symlinks=False)。

引发一个 审计事件 os.chmod 并附带参数 path, mode, dir_fd。

可用性: Unix。

在 3.6 版更改: 接受一个 path-like object。

os.lchown(path, uid, gid)

将 path 的用户和组 ID 分别修改为数字形式的 uid 和 gid，本函数不跟踪符号链接。从 Python 3.3 开始，它等效于 os.chown(path, uid, gid, follow_symlinks=False)。

引发一个 审计事件 os.chown 并附带参数 path, uid, gid, dir_fd。

可用性: Unix。

在 3.6 版更改: 接受一个 path-like object。

os.link(src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True)

创建一个指向 src 的硬链接，名为 dst。

本函数支持将 src_dir_fd 和 dst_dir_fd 中的一个或两个指定为 基于目录描述符的相对路径，支持 不跟踪符号链接。

引发一个 审计事件 os.link 并附带参数 src、dst、src_dir_fd、dst_dir_fd。

可用性: Unix, Windows。

在 3.2 版更改: 添加了对 Windows 的支持。

3.3 新版功能: 添加 src_dir_fd、dst_dir_fd 和 follow_symlinks 参数。

在 3.6 版更改: 接受一个 类路径对象 作为 src 和 dst。

os.listdir(path='.')

返回一个包含由 path 指定目录中条目名称组成的列表。 该列表按任意顺序排列，并且不包括特殊条目 '.' 和 '..'，即使它们存在于目录中。 如果有文件在调用此函数期间在被移除或添加到目录中，是否要包括该文件的名称并没有规定。

path 可以是 类路径对象。如果 path 是（直接传入或通过 PathLike 接口间接传入） bytes 类型，则返回的文件名也将是 bytes 类型，其他情况下是 str 类型。

本函数也支持 指定文件描述符为参数，其中描述符必须指向目录。

引发一个 审计事件 os.listdir 并附带参数 path。

注解

要将 str 类型的文件名编码为 bytes，请使用 fsencode()。

参见

scandir() 函数返回目录内文件名的同时，也返回文件属性信息，它在某些具体情况下能提供更好的性能。

在 3.2 版更改: path 变为可选参数。

3.3 新版功能: 新增支持将 path 参数指定为打开的文件描述符。

在 3.6 版更改: 接受一个 path-like object。

os.lstat(path, *, dir_fd=None)

在给定路径上执行本函数，其操作相当于 lstat() 系统调用，类似于 stat() 但不跟踪符号链接。返回值是 stat_result 对象。

在不支持符号链接的平台上，本函数是 stat() 的别名。

从 Python 3.3 起，此功能等价于 os.stat(path, dir_fd=dir_fd, follow_symlinks=False)。

本函数支持 基于目录描述符的相对路径。

参见

stat() 函数。

在 3.2 版更改: 添加对 Windows 6.0 (Vista) 符号链接的支持。

在 3.3 版更改: 添加了 dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

在 3.8 版更改: 目前在 Windows 上，遇到表示另一个路径的重解析点（即名称代理，包括符号链接和目录结点），本函数将打开它。其他种类的重解析点由 stat() 交由操作系统解析。

os.mkdir(path, mode=0o777, *, dir_fd=None)

创建一个名为 path 的目录，应用以数字表示的权限模式 mode。

如果目录已经存在， FileExistsError 会被提出。如果路径中的父目录不存在，则会引发 FileNotFoundError 。

某些系统会忽略 mode。如果没有忽略它，那么将首先从它中减去当前的 umask 值。如果除最后 9 位（即 mode 八进制的最后 3 位）之外，还设置了其他位，则其他位的含义取决于各个平台。在某些平台上，它们会被忽略，应显式调用 chmod() 进行设置。

在 Windows 系统中，mode 值 0o700 被专门用于对新目录实施访问控制，使其只有当前用户和管理员才能访问。 其他值的 mode 将被忽略。

本函数支持 基于目录描述符的相对路径。

如果需要创建临时目录，请参阅 tempfile 模块中的 tempfile.mkdtemp() 函数。

引发一个 审计事件 os.mkdir 并附带参数 path, mode, dir_fd。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

在 3.10.15 版更改: Windows系统现在使用*mode*值``0o700``

os.makedirs(name, mode=0o777, exist_ok=False)

递归目录创建函数。与 mkdir() 类似，但会自动创建到达最后一级目录所需要的中间目录。

mode 形参会被传递给 mkdir() 用来创建最后一级目录；请参阅 mkdir() 的说明 了解其解读方式。 要设置任何新建父目录的权限你可以在唤起 makedirs() 之前设置掩码。 现有父目录的文件权限不会被更改。

如果 exist_ok 为 False (默认值)，则如果目标目录已存在将引发 FileExistsError。

注解

如果要创建的路径元素包含 pardir (如 UNIX 系统中的 "..") makedirs() 将无法明确目标。

本函数能正确处理 UNC 路径。

引发一个 审计事件 os.mkdir 并附带参数 path, mode, dir_fd。

3.2 新版功能: exist_ok 参数。

在 3.4.1 版更改: 在 Python 3.4.1 以前，如果 exist_ok 为 True，且目录已存在，且 mode 与现有目录的权限不匹配，makedirs() 仍会抛出错误。由于无法安全地实现此行为，因此在 Python 3.4.1 中将该行为删除。请参阅 bpo-21082 [https://bugs.python.org/issue?@action=redirect&bpo=21082]。

在 3.6 版更改: 接受一个 path-like object。

在 3.7 版更改: mode 参数不会再影响新创建的中间目录的文件权限位。

os.mkfifo(path, mode=0o666, *, dir_fd=None)

创建一个名为 path 的 FIFO（命名管道，一种先进先出队列），具有以数字表示的权限状态 mode。将从 mode 中首先减去当前的 umask 值。

本函数支持 基于目录描述符的相对路径。

FIFO 是可以像常规文件一样访问的管道。FIFO 如果没有被删除（如使用 os.unlink()），会一直存在。通常，FIFO 用作“客户端”和“服务器”进程之间的汇合点：服务器打开 FIFO 进行读取，而客户端打开 FIFO 进行写入。请注意，mkfifo() 不会打开 FIFO --- 它只是创建汇合点。

可用性: Unix。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

os.mknod(path, mode=0o600, device=0, *, dir_fd=None)

创建一个名为 path 的文件系统节点（文件，设备专用文件或命名管道）。mode 指定权限和节点类型，方法是将权限与下列节点类型 stat.S_IFREG、stat.S_IFCHR、stat.S_IFBLK 和 stat.S_IFIFO 之一（按位或）组合（这些常量可以在 stat 模块中找到）。对于 stat.S_IFCHR 和 stat.S_IFBLK，device 参数指定了新创建的设备专用文件（可能会用到 os.makedev()），否则该参数将被忽略。

本函数支持 基于目录描述符的相对路径。

可用性: Unix。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

os.major(device)

提取主设备号，提取自原始设备号（通常是 stat 中的 st_dev 或 st_rdev 字段）。

os.minor(device)

提取次设备号，提取自原始设备号（通常是 stat 中的 st_dev 或 st_rdev 字段）。

os.makedev(major, minor)

将主设备号和次设备号组合成原始设备号。

os.pathconf(path, name)

返回所给名称的文件有关的系统配置信息。name 指定要查找的配置名称，它可以是字符串，是一个系统已定义的名称，这些名称定义在不同标准（POSIX.1，Unix 95，Unix 98 等）中。一些平台还定义了额外的其他名称。当前操作系统已定义的名称在 pathconf_names 字典中给出。对于未包含在该映射中的配置名称，也可以传递一个整数作为 name。

如果 name 是一个字符串且不是已定义的名称，将抛出 ValueError 异常。如果当前系统不支持 name 指定的配置名称，即使该名称存在于 pathconf_names，也会抛出 OSError 异常，错误码为 errno.EINVAL。

本函数支持 指定文件描述符为参数。

可用性: Unix。

在 3.6 版更改: 接受一个 path-like object。

os.pathconf_names

字典，表示映射关系，为 pathconf() 和 fpathconf() 可接受名称与操作系统为这些名称定义的整数值之间的映射。这可用于判断系统已定义了哪些名称。

可用性: Unix。

os.readlink(path, *, dir_fd=None)

返回一个字符串，为符号链接指向的实际路径。其结果可以是绝对或相对路径。如果是相对路径，则可用 os.path.join(os.path.dirname(path), result) 转换为绝对路径。

如果 path 是字符串对象（直接传入或通过 PathLike 接口间接传入），则结果也将是字符串对象，且此类调用可能会引发 UnicodeDecodeError。如果 path 是字节对象（直接传入或间接传入），则结果将会是字节对象。

本函数支持 基于目录描述符的相对路径。

当尝试解析的路径可能含有链接时，请改用 realpath() 以正确处理递归和平台差异。

可用性: Unix, Windows。

在 3.2 版更改: 添加对 Windows 6.0 (Vista) 符号链接的支持。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 在 Unix 上可以接受一个 类路径对象。

在 3.8 版更改: 在 Windows 上接受 类路径对象 和字节对象。

在 3.8 版更改: 增加了对目录链接的支持，且返回值改为了“替换路径”的形式（通常带有 \\?\ 前缀），而不是先前那样返回可选的 "print name" 字段。

os.remove(path, *, dir_fd=None)

移除（删除）文件 path。 如果 path 是目录，则会引发 OSError。 请使用 rmdir() 来移除目录。 如果文件不存在，则会引发 FileNotFoundError。

本函数支持 基于目录描述符的相对路径。

在 Windows 上，尝试删除正在使用的文件会抛出异常。而在 Unix 上，虽然该文件的条目会被删除，但分配给文件的存储空间仍然不可用，直到原始文件不再使用为止。

本函数在语义上与 unlink() 相同。

引发一个 审计事件 os.remove 并附带参数 path, dir_fd。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

os.removedirs(name)

递归删除目录。工作方式类似于 rmdir()，不同之处在于，如果成功删除了末尾一级目录，removedirs() 会尝试依次删除 path 中提到的每个父目录，直到抛出错误为止（但该错误会被忽略，因为这通常表示父目录不是空目录）。例如，os.removedirs('foo/bar/baz') 将首先删除目录 'foo/bar/baz'，然后如果 'foo/bar' 和 'foo' 为空，则继续删除它们。如果无法成功删除末尾一级目录，则抛出 OSError 异常。

引发一个 审计事件 os.remove 并附带参数 path, dir_fd。

在 3.6 版更改: 接受一个 path-like object。

os.rename(src, dst, *, src_dir_fd=None, dst_dir_fd=None)

将文件或目录 src 重命名为 dst。如果 dst 已存在，则下列情况下将会操作失败，并抛出 OSError 的子类：

在 Windows 上，如果 dst 存在则总是会引发 FileExistsError。 如果 src 和 dst 是在不同的文件系统上则此操作可能会失败。 请使用 shutil.move() 以支持移动到不同的文件系统。

在 Unix 上，如果 src 是文件而 dst 是目录，将抛出 IsADirectoryError 异常，反之则抛出 NotADirectoryError 异常。如果两者都是目录且 dst 为空，则 dst 将被静默替换。如果 dst 是非空目录，则抛出 OSError 异常。如果两者都是文件，则在用户具有权限的情况下，将对 dst 进行静默替换。如果 src 和 dst 在不同的文件系统上，则本操作在某些 Unix 分支上可能会失败。如果成功，重命名操作将是一个原子操作（这是 POSIX 的要求）。

本函数支持将 src_dir_fd 和 dst_dir_fd 中的一个或两个指定为 基于目录描述符的相对路径。

如果需要在不同平台上都能替换目标，请使用 replace()。

引发一个 审计事件 os.rename 并附带参数 src, dst, src_dir_fd, dst_dir_fd。

3.3 新版功能: src_dir_fd 和 dst_dir_fd 参数。

在 3.6 版更改: 接受一个 类路径对象 作为 src 和 dst。

os.renames(old, new)

递归重命名目录或文件。工作方式类似 rename()，除了会首先创建新路径所需的中间目录。重命名后，将调用 removedirs() 删除旧路径中不需要的目录。

注解

如果用户没有权限删除末级的目录或文件，则本函数可能会无法建立新的目录结构。

引发一个 审计事件 os.rename 并附带参数 src, dst, src_dir_fd, dst_dir_fd。

在 3.6 版更改: 接受一个 类路径对象 作为 old 和 new。

os.replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None)

将文件或目录 src 重命名为 dst。如果 dst 是非空目录，将抛出 OSError 异常。如果 dst 已存在且为文件，则在用户具有权限的情况下，将对其进行静默替换。如果 src 和 dst 在不同的文件系统上，本操作可能会失败。如果成功，重命名操作将是一个原子操作（这是 POSIX 的要求）。

本函数支持将 src_dir_fd 和 dst_dir_fd 中的一个或两个指定为 基于目录描述符的相对路径。

引发一个 审计事件 os.rename 并附带参数 src, dst, src_dir_fd, dst_dir_fd。

3.3 新版功能.

在 3.6 版更改: 接受一个 类路径对象 作为 src 和 dst。

os.rmdir(path, *, dir_fd=None)

移除（删除）目录 path。如果目录不存在或不为空，则会分别抛出 FileNotFoundError 或 OSError 异常。要删除整个目录树，可以使用 shutil.rmtree()。

本函数支持 基于目录描述符的相对路径。

引发一个 审计事件 os.rmdir 并附带参数 path, dir_fd。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

os.scandir(path='.')

返回一个 os.DirEntry 对象的迭代器，它们对应于由 path 指定目录中的条目。 这些条目会以任意顺序生成，并且不包括特殊条目 '.' 和 '..'。 如果有文件在迭代器创建之后在目录中被移除或添加，是否要包括该文件对应的条目并没有规定。

如果需要文件类型或文件属性信息，使用 scandir() 代替 listdir() 可以大大提高这部分代码的性能，因为如果操作系统在扫描目录时返回的是 os.DirEntry 对象，则该对象包含了这些信息。所有 os.DirEntry 的方法都可能执行一次系统调用，但是 is_dir() 和 is_file() 通常只在有符号链接时才执行一次系统调用。os.DirEntry.stat() 在 Unix 上始终需要一次系统调用，而在 Windows 上只在有符号链接时才需要。

path 可以是 类路径对象。如果 path 是（直接传入或通过 PathLike 接口间接传入的） bytes 类型，那么每个 os.DirEntry 的 name 和 path 属性将是 bytes 类型，其他情况下是 str 类型。

本函数也支持 指定文件描述符为参数，其中描述符必须指向目录。

引发一个 审计事件 os.scandir 并附带参数 path。

scandir() 迭代器支持 上下文管理 协议，并具有以下方法：

scandir.close()

关闭迭代器并释放占用的资源。

当迭代器迭代完毕，或垃圾回收，或迭代过程出错时，将自动调用本方法。但仍建议显式调用它或使用 with 语句。

3.6 新版功能.

下面的例子演示了 scandir() 的简单用法，用来显示给定 path 中所有不以 '.' 开头的文件（不包括目录）。entry.is_file() 通常不会增加一次额外的系统调用:

with os.scandir(path) as it:
    for entry in it:
        if not entry.name.startswith('.') and entry.is_file():
            print(entry.name)

注解

在基于 Unix 的系统上，scandir() 使用系统的 opendir() [https://pubs.opengroup.org/onlinepubs/009695399/functions/opendir.html] 和 readdir() [https://pubs.opengroup.org/onlinepubs/009695399/functions/readdir_r.html] 函数。 在 Windows 上，它使用 Win32 FindFirstFileW [https://msdn.microsoft.com/en-us/library/windows/desktop/aa364418(v=vs.85).aspx] 和 FindNextFileW [https://msdn.microsoft.com/en-us/library/windows/desktop/aa364428(v=vs.85).aspx] 函数。

3.5 新版功能.

3.6 新版功能: 添加了对 上下文管理 协议和 close() 方法的支持。如果 scandir() 迭代器没有迭代完毕且没有显式关闭，其析构函数将发出 ResourceWarning 警告。

本函数接受一个 类路径对象。

在 3.7 版更改: 在 Unix 上新增支持 指定文件描述符为参数。

class os.DirEntry

由 scandir() 生成的对象，用于显示目录内某个条目的文件路径和其他文件属性。

scandir() 将在不进行额外系统调用的情况下，提供尽可能多的此类信息。每次进行 stat() 或 lstat() 系统调用时，os.DirEntry 对象会将结果缓存下来。

os.DirEntry 实例不适合存储在长期存在的数据结构中，如果你知道文件元数据已更改，或者自调用 scandir() 以来已经经过了很长时间，请调用 os.stat(entry.path) 来获取最新信息。

因为 os.DirEntry 方法可以进行系统调用，所以它也可能抛出 OSError 异常。如需精确定位错误，可以逐个调用 os.DirEntry 中的方法来捕获 OSError，并适当处理。

为了能直接用作 类路径对象，os.DirEntry 实现了 PathLike 接口。

os.DirEntry 实例所包含的属性和方法如下：

name

本条目的基本文件名，是根据 scandir() 的 path 参数得出的相对路径。

如果 scandir() 的 path 参数是 bytes 类型，则 name 属性也是 bytes 类型，否则为 str。使用 fsdecode() 解码 byte 类型的文件名。

path

本条目的完整路径：等效于 os.path.join(scandir_path, entry.name)，其中 scandir_path 就是 scandir() 的 path 参数。仅当 scandir() 的 path 参数为绝对路径时，本路径才是绝对路径。如果 scandir() 的 path 参数是 文件描述符，则 path 属性与上述 name 属性相同。

如果 scandir() 的 path 参数是 bytes 类型，则 path 属性也是 bytes 类型，否则为 str。使用 fsdecode() 解码 byte 类型的文件名。

inode()

返回本条目的索引节点号 (inode number)。

这一结果是缓存在 os.DirEntry 对象中的，请调用 os.stat(entry.path, follow_symlinks=False).st_ino 来获取最新信息。

一开始没有缓存时，在 Windows 上需要一次系统调用，但在 Unix 上不需要。

is_dir(*, follow_symlinks=True)

如果本条目是目录，或是指向目录的符号链接，则返回 True。如果本条目是文件，或指向任何其他类型的文件，或该目录不再存在，则返回 False。

如果 follow_symlinks 是 False，那么仅当本条目为目录时返回 True （不跟踪符号链接），如果本条目是任何类型的文件，或该文件不再存在，则返回 False。

这一结果是缓存在 os.DirEntry 对象中的，且 follow_symlinks 为 True 和 False 时的缓存是分开的。请调用 os.stat() 和 stat.S_ISDIR() 来获取最新信息。

一开始没有缓存时，大多数情况下不需要系统调用。特别是对于非符号链接，Windows 和 Unix 都不需要系统调用，除非某些 Unix 文件系统（如网络文件系统）返回了 dirent.d_type == DT_UNKNOWN。如果本条目是符号链接，则需要一次系统调用来跟踪它（除非 follow_symlinks 为 False）。

本方法可能抛出 OSError 异常，如 PermissionError 异常，但 FileNotFoundError 异常会被内部捕获且不会抛出。

is_file(*, follow_symlinks=True)

如果本条目是文件，或是指向文件的符号链接，则返回 True。如果本条目是目录，或指向目录，或指向其他非文件条目，或该文件不再存在，则返回 False。

如果 follow_symlinks 是 False，那么仅当本条目为文件时返回 True （不跟踪符号链接），如果本条目是目录或其他非文件条目，或该文件不再存在，则返回 False。

这一结果是缓存在 os.DirEntry 对象中的。缓存、系统调用、异常抛出都与 is_dir() 一致。

is_symlink()

如果本条目是符号链接（即使是断开的链接），返回 True。如果是目录或任何类型的文件，或本条目不再存在，返回 False。

这一结果是缓存在 os.DirEntry 对象中的，请调用 os.path.islink() 来获取最新信息。

一开始没有缓存时，大多数情况下不需要系统调用。其实 Windows 和 Unix 都不需要系统调用，除非某些 Unix 文件系统（如网络文件系统）返回了 dirent.d_type == DT_UNKNOWN。

本方法可能抛出 OSError 异常，如 PermissionError 异常，但 FileNotFoundError 异常会被内部捕获且不会抛出。

stat(*, follow_symlinks=True)

返回本条目对应的 stat_result 对象。本方法默认会跟踪符号链接，要获取符号链接本身的 stat，请添加 follow_symlinks=False 参数。

在 Unix 上，本方法需要一次系统调用。在 Windows 上，仅在 follow_symlinks 为 True 且该条目是一个重解析点（如符号链接或目录结点）时，才需要一次系统调用。

在 Windows 上，stat_result 的 st_ino、st_dev 和 st_nlink 属性总是为零。请调用 os.stat() 以获得这些属性。

这一结果是缓存在 os.DirEntry 对象中的，且 follow_symlinks 为 True 和 False 时的缓存是分开的。请调用 os.stat() 来获取最新信息。

注意，os.DirEntry 和 pathlib.Path 的几个属性和方法之间存在很好的对应关系。具体来说是 name 属性，以及 is_dir()、is_file()、is_symlink() 和 stat() 方法，在两个类中具有相同的含义。

3.5 新版功能.

在 3.6 版更改: 添加了对 PathLike 接口的支持。在 Windows 上添加了对 bytes 类型路径的支持。

os.stat(path, *, dir_fd=None, follow_symlinks=True)

获取文件或文件描述符的状态。在所给路径上执行等效于 stat() 系统调用的操作。path 可以是字符串类型，或（直接传入或通过 PathLike 接口间接传入的） bytes 类型，或打开的文件描述符。返回一个 stat_result 对象。

本函数默认会跟踪符号链接，要获取符号链接本身的 stat，请添加 follow_symlinks=False 参数，或使用 lstat()。

本函数支持 指定文件描述符为参数 和 不跟踪符号链接。

在 Windows 上，传入 follow_symlinks=False 将禁用所有名称代理重解析点，其中包括符号链接和目录结点。其他类型的重解析点将直接打开，比如不像链接的或系统无法跟踪的重解析点。当多个链接形成一个链时，本方法可能会返回原始链接的 stat，无法完整遍历到非链接的对象。在这种情况下，要获取最终路径的 stat，请使用 os.path.realpath() 函数尽可能地解析路径，并在解析结果上调用 lstat()。这不适用于空链接或交接点，否则会抛出异常。

示例:

>>> 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

参见

fstat() 和 lstat() 函数。

3.3 新版功能: 增加 dir_fd 和 follow_symlinks 参数，可指定文件描述符代替路径。

在 3.6 版更改: 接受一个 path-like object。

在 3.8 版更改: 在 Windows 上，本方法将跟踪系统能解析的所有重解析点，并且传入 follow_symlinks=False 会停止跟踪所有名称代理重解析点。现在，如果操作系统遇到无法跟踪的重解析点，stat 将返回原始路径的信息，就像已指定 follow_symlinks=False 一样，而不会抛出异常。

class os.stat_result

本对象的属性大致对应于 stat 结构体成员，主要作为 os.stat()、os.fstat() 和 os.lstat() 的返回值。

属性：

st_mode

文件模式：包括文件类型和文件模式位（即权限位）。

st_ino

与平台有关，但如果不为零，则根据 st_dev 值唯一地标识文件。通常：

在 Unix 上该值表示索引节点号 (inode number)。

在 Windows 上该值表示 文件索引号 [https://msdn.microsoft.com/en-us/library/aa363788] 。

st_dev

该文件所在设备的标识符。

st_nlink

硬链接的数量。

st_uid

文件所有者的用户 ID。

st_gid

文件所有者的用户组 ID。

st_size

文件大小（以字节为单位），文件可以是常规文件或符号链接。符号链接的大小是它包含的路径的长度，不包括末尾的空字节。

时间戳：

st_atime

最近的访问时间，以秒为单位。

st_mtime

最近的修改时间，以秒为单位。

st_ctime

取决于平台：

在 Unix 上表示最近的元数据更改时间，

在 Windows 上表示创建时间，以秒为单位。

st_atime_ns

最近的访问时间，以纳秒表示，为整数。

st_mtime_ns

最近的修改时间，以纳秒表示，为整数。

st_ctime_ns

取决于平台：

在 Unix 上表示最近的元数据更改时间，

在 Windows 上表示创建时间，以纳秒表示，为整数。

注解

st_atime、st_mtime 和 st_ctime 属性的确切含义和分辨率取决于操作系统和文件系统。例如，在使用 FAT 或 FAT32 文件系统的 Windows 上，st_mtime 有 2 秒的分辨率，而 st_atime 仅有 1 天的分辨率。详细信息请参阅操作系统文档。

类似地，尽管 st_atime_ns、st_mtime_ns 和 st_ctime_ns 始终以纳秒表示，但许多系统并不提供纳秒精度。在确实提供纳秒精度的系统上，用于存储 st_atime、st_mtime 和 st_ctime 的浮点对象无法保留所有精度，因此不够精确。如果需要确切的时间戳，则应始终使用 st_atime_ns、st_mtime_ns 和 st_ctime_ns。

在某些 Unix 系统上（如 Linux 上），以下属性可能也可用：

st_blocks

为文件分配的字节块数，每块 512 字节。文件是稀疏文件时，它可能小于 st_size/512。

st_blksize

“首选的” 块大小，用于提高文件系统 I/O 效率。写入文件时块大小太小可能会导致读取-修改-重写效率低下。

st_rdev

设备类型（如果是 inode 设备）。

st_flags

用户定义的文件标志位。

在其他 Unix 系统上（如 FreeBSD 上），以下属性可能可用（但仅当 root 使用它们时才被填充）：

st_gen

文件生成号。

st_birthtime

文件创建时的时间。

在 Solaris 及其衍生版本上，以下属性可能也可用：

st_fstype

文件所在文件系统的类型的唯一标识，为字符串。

在 macOS 系统上，以下属性可能也可用：

st_rsize

文件的实际大小。

st_creator

文件的创建者。

st_type

文件类型。

在 Windows 系统上，以下属性也可用：

st_file_attributes

Windows 文件属性：dwFileAttributes，由 GetFileInformationByHandle() 返回的 BY_HANDLE_FILE_INFORMATION 结构体的成员之一。请参阅 stat 模块中的 FILE_ATTRIBUTE_* 常量。

st_reparse_tag

当 st_file_attributes 存在 FILE_ATTRIBUTE_REPARSE_POINT 集合时，本字段包含重解析点类型标记。请参阅 stat 模块中的 IO_REPARSE_TAG_* 常量。

标准模块 stat 中定义了函数和常量，这些函数和常量可用于从 stat 结构体中提取信息。（在 Windows 上，某些项填充的是虚值。）

为了向后兼容，一个 stat_result 实例还可以作为至少包含 10 个整数的元组访问，以提供 stat 结构中最重要（和可移植）的成员，整数顺序为 st_mode, st_ino, st_dev, st_nlink, st_uid, st_gid, st_size, st_atime, st_mtime, st_ctime。某些实现可能在末尾还有更多项。为了与旧版 Python 兼容，以元组形式访问 stat_result 始终返回整数。

3.3 新版功能: 添加了 st_atime_ns、st_mtime_ns 和 st_ctime_ns 成员。

3.5 新版功能: 在 Windows 上添加了 st_file_attributes 成员。

在 3.5 版更改: 在 Windows 上，如果可用，会返回文件索引作为 st_ino 的值。

3.7 新版功能: 在 Solaris 及其衍生版本上添加了 st_fstype 成员。

3.8 新版功能: 在 Windows 上添加了 st_reparse_tag 成员。

在 3.8 版更改: 在 Windows 上，st_mode 成员现在可以根据需要将特殊文件标识为 S_IFCHR、S_IFIFO 或 S_IFBLK。

os.statvfs(path)

在所给的路径上执行 statvfs() 系统调用。返回值是一个对象，其属性描述了所给路径上的文件系统，并且与 statvfs 结构体的成员相对应，即：f_bsize, f_frsize, f_blocks, f_bfree, f_bavail, f_files, f_ffree, f_favail, f_flag, f_namemax, f_fsid。

为 f_flag 属性位定义了两个模块级常量：如果存在 ST_RDONLY 位，则文件系统以只读挂载；如果存在 ST_NOSUID 位，则文件系统禁用或不支持 setuid/setgid 位。

为基于 GNU/glibc 的系统还定义了额外的模块级常量。它们是 ST_NODEV （禁止访问设备专用文件），ST_NOEXEC （禁止执行程序），ST_SYNCHRONOUS （写入后立即同步），ST_MANDLOCK （允许文件系统上的强制锁定），ST_WRITE （写入文件/目录/符号链接），ST_APPEND （仅追加文件），ST_IMMUTABLE （不可变文件），ST_NOATIME （不更新访问时间），ST_NODIRATIME （不更新目录访问时间），ST_RELATIME （相对于 mtime/ctime 更新访问时间）。

本函数支持 指定文件描述符为参数。

可用性: Unix。

在 3.2 版更改: 添加了 ST_RDONLY 和 ST_NOSUID 常量。

3.3 新版功能: 新增支持将 path 参数指定为打开的文件描述符。

在 3.4 版更改: 添加了 ST_NODEV、ST_NOEXEC、ST_SYNCHRONOUS、ST_MANDLOCK、ST_WRITE、ST_APPEND、ST_IMMUTABLE、ST_NOATIME、ST_NODIRATIME 和 ST_RELATIME 常量。

在 3.6 版更改: 接受一个 path-like object。

3.7 新版功能: 添加了 f_fsid。

os.supports_dir_fd

一个 set 对象，指示 os 模块中的哪些函数接受一个打开的文件描述符作为 dir_fd 参数。不同平台提供的功能不同，且 Python 用于实现 dir_fd 参数的底层函数并非在 Python 支持的所有平台上都可用。考虑到一致性，支持 dir_fd 的函数始终允许指定描述符，但如果在底层不支持时调用了该函数，则会抛出异常。（在所有平台上始终支持将 dir_fd 指定为 None。）

要检查某个函数是否接受打开的文件描述符作为 dir_fd 参数，请在 supports_dir_fd 前使用 in 运算符。例如，如果 os.stat() 在当前平台上接受打开的文件描述符作为 dir_fd 参数，则此表达式的计算结果为 True:

os.stat in os.supports_dir_fd

目前 dir_fd 参数仅在 Unix 平台上有效，在 Windows 上均无效。

3.3 新版功能.

os.supports_effective_ids

一个 set 对象，指示 os.access() 是否允许在当前平台上将其 effective_ids 参数指定为 True。（所有平台都支持将 effective_ids 指定为 False。）如果当前平台支持，则集合将包含 os.access()，否则集合为空。

如果当前平台上的 os.access() 支持 effective_ids=True，则此表达式的计算结果为 True:

os.access in os.supports_effective_ids

目前仅 Unix 平台支持 effective_ids，Windows 不支持。

3.3 新版功能.

os.supports_fd

一个 set 对象，指示在当前平台上 os 模块中的哪些函数接受一个打开的文件描述符作为 path 参数。不同平台提供的功能不同，且 Python 所使用到的底层函数（用于实现接受描述符作为 path）并非在 Python 支持的所有平台上都可用。

要判断某个函数是否接受打开的文件描述符作为 path 参数，请在 supports_fd 前使用 in 运算符。例如，如果 os.chdir() 在当前平台上接受打开的文件描述符作为 path 参数，则此表达式的计算结果为 True:

os.chdir in os.supports_fd

3.3 新版功能.

os.supports_follow_symlinks

一个 set 对象，指示在当前平台上 os 模块中的哪些函数的 follow_symlinks 参数可指定为 False。不同平台提供的功能不同，且 Python 用于实现 follow_symlinks 的底层函数并非在 Python 支持的所有平台上都可用。考虑到一致性，支持 follow_symlinks 的函数始终允许将其指定为 False，但如果在底层不支持时调用了该函数，则会抛出异常。（在所有平台上始终支持将 follow_symlinks 指定为 True。）

要检查某个函数的 follow_symlinks 参数是否可以指定为 False，请在 supports_follow_symlinks 前使用 in 运算符。例如，如果在当前平台上调用 os.stat() 时可以指定 follow_symlinks=False，则此表达式的计算结果为 True:

os.stat in os.supports_follow_symlinks

3.3 新版功能.

os.symlink(src, dst, target_is_directory=False, *, dir_fd=None)

创建一个指向 src 的符号链接，名为 dst。

在 Windows 上，符号链接可以表示文件或目录两种类型，并且不会动态改变类型。如果目标存在，则新建链接的类型将与目标一致。否则，如果 target_is_directory 为 True，则符号链接将创建为目录链接，为 False （默认）将创建为文件链接。在非 Windows 平台上，target_is_directory 被忽略。

本函数支持 基于目录描述符的相对路径。

注解

在 Windows 10 或更高版本上，如果启用了开发人员模式，非特权帐户可以创建符号链接。如果开发人员模式不可用/未启用，则需要 SeCreateSymbolicLinkPrivilege 权限，或者该进程必须以管理员身份运行。

当本函数由非特权账户调用时，抛出 OSError 异常。

引发一个 审计事件 os.symlink 并附带参数 src, dst, dir_fd。

可用性: Unix, Windows。

在 3.2 版更改: 添加对 Windows 6.0 (Vista) 符号链接的支持。

3.3 新版功能: 添加了 dir_fd 参数，现在在非 Windows 平台上允许 target_is_directory 参数。

在 3.6 版更改: 接受一个 类路径对象 作为 src 和 dst。

在 3.8 版更改: 针对启用了开发人员模式的 Windows，添加了非特权账户创建符号链接的支持。

os.sync()

强制将所有内容写入磁盘。

可用性: Unix。

3.3 新版功能.

os.truncate(path, length)

截断 path 对应的文件，以使其最大为 length 字节。

本函数支持 指定文件描述符为参数。

引发一个 审计事件 os.truncate 并附带参数 path, length。

可用性: Unix, Windows。

3.3 新版功能.

在 3.5 版更改: 添加了 Windows 支持

在 3.6 版更改: 接受一个 path-like object。

os.unlink(path, *, dir_fd=None)

移除（删除）文件 path。该函数在语义上与 remove() 相同，unlink 是其传统的 Unix 名称。请参阅 remove() 的文档以获取更多信息。

引发一个 审计事件 os.remove 并附带参数 path, dir_fd。

3.3 新版功能: dir_fd 参数。

在 3.6 版更改: 接受一个 path-like object。

os.utime(path, times=None, *, [ns, ]dir_fd=None, follow_symlinks=True)

设置文件 path 的访问时间和修改时间。

utime() 有 times 和 ns 两个可选参数，它们指定了设置给 path 的时间，用法如下：

如果指定 ns，它必须是一个 (atime_ns, mtime_ns) 形式的二元组，其中每个成员都是一个表示纳秒的整数。

如果 times 不为 None，则它必须是 (atime, mtime) 形式的二元组，其中每个成员都是一个表示秒的 int 或 float。

如果 times 为 None 且未指定 ns，则相当于指定 ns=(atime_ns, mtime_ns)，其中两个时间均为当前时间。

同时为 times 和 ns 指定元组会出错。

请注意你在此处设置的确切时间可能不会被后续的 stat() 调用所返回，具体取决于你的操作系统记录访问和修改时间的分辨率；请参阅 stat()。 保留准确时间的最佳方式是使用来自于将 ns 形参设为 utime() 的 os.stat() 结果对象的 st_atime_ns 和 st_mtime_ns 字段。

本函数支持 指定文件描述符、指定基于目录描述符的相对路径 和 不跟踪符号链接。

引发一个 审计事件 os.utime 并附带参数 path, times, ns, dir_fd。

3.3 新版功能: 新增支持将 path 参数指定为打开的文件描述符，以及支持 dir_fd、follow_symlinks 和 ns 参数。

在 3.6 版更改: 接受一个 path-like object。

os.walk(top, topdown=True, onerror=None, followlinks=False)

生成目录树中的文件名，方式是按上->下或下->上顺序浏览目录树。对于以 top 为根的目录树中的每个目录（包括 top 本身），它都会生成一个三元组 (dirpath, dirnames, filenames)。

dirpath 是一个字符串，表示目录的路径。 dirnames 是由 dirpath 中的子目录名称组成的列表 (包括指向目录的符号链接，不包括 '.' 和 '..')。 filenames 是由 dirpath 中非目录文件名称组成的列表。 请注意列表中的名称不包含路径部分。 要获取 dirpath 中文件或目录的完整路径 (以 top 打头，请执行 os.path.join(dirpath, name)。 列表是否排序取决于具体文件系统。 如果有文件在列表生成期间被移除或添加到 dirpath，是否要包括该文件的名称并没有规定。

如果可选参数 topdown 为 True 或未指定，则在所有子目录的三元组之前生成父目录的三元组（目录是自上而下生成的）。如果 topdown 为 False，则在所有子目录的三元组生成之后再生成父目录的三元组（目录是自下而上生成的）。无论 topdown 为何值，在生成目录及其子目录的元组之前，都将检索全部子目录列表。

当 topdown 为 True 时，调用者可以就地修改 dirnames 列表（也许用到了 del 或切片），而 walk() 将仅仅递归到仍保留在 dirnames 中的子目录内。这可用于减少搜索、加入特定的访问顺序，甚至可在继续 walk() 之前告知 walk() 由调用者新建或重命名的目录的信息。当 topdown 为 False 时，修改 dirnames 对 walk 的行为没有影响，因为在自下而上模式中，dirnames 中的目录是在 dirpath 本身之前生成的。

默认将忽略 scandir() 调用中的错误。如果指定了可选参数 onerror，它应该是一个函数。出错时它会被调用，参数是一个 OSError 实例。它可以报告错误然后继续遍历，或者抛出异常然后中止遍历。注意，可以从异常对象的 filename 属性中获取出错的文件名。

walk() 默认不会递归进指向目录的符号链接。可以在支持符号链接的系统上将 followlinks 设置为 True，以访问符号链接指向的目录。

注解

注意，如果链接指向自身的父目录，则将 followlinks 设置为 True 可能导致无限递归。walk() 不会记录它已经访问过的目录。

注解

如果传入的是相对路径，请不要在恢复 walk() 之间更改当前工作目录。walk() 不会更改当前目录，并假定其调用者也不会更改当前目录。

下面的示例遍历起始目录内所有子目录，打印每个目录内的文件占用的字节数，CVS 子目录不会被遍历:

import os
from os.path import join, getsize
for root, dirs, files in os.walk('python/Lib/email'):
    print(root, "consumes", end=" ")
    print(sum(getsize(join(root, name)) for name in files), end=" ")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories

在下一个示例（shutil.rmtree() 的简单实现）中，必须使树自下而上遍历，因为 rmdir() 只允许在目录为空时删除目录:

# Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION:  This is dangerous!  For example, if top == '/', it
# could delete all your disk files.
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.walk 并附带参数 top, topdown, onerror, followlinks。

在 3.5 版更改: 现在，本函数调用的是 os.scandir() 而不是 os.listdir()，从而减少了调用 os.stat() 的次数而变得更快。

在 3.6 版更改: 接受一个 path-like object。

os.fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)

本方法的行为与 walk() 完全一样，除了它产生的是 4 元组 (dirpath, dirnames, filenames, dirfd)，并且它支持 dir_fd。

dirpath、dirnames 和 filenames 与 walk() 输出的相同，dirfd 是指向目录 dirpath 的文件描述符。

本函数始终支持 基于目录描述符的相对路径 和 不跟踪符号链接。但是请注意，与其他函数不同，fwalk() 的 follow_symlinks 的默认值为 False。

注解

由于 fwalk() 会生成文件描述符，而它们仅在下一个迭代步骤前有效，因此如果要将描述符保留更久，则应复制它们（比如使用 dup()）。

下面的示例遍历起始目录内所有子目录，打印每个目录内的文件占用的字节数，CVS 子目录不会被遍历:

import os
for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
    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 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories

在下一个示例中，必须使树自下而上遍历，因为 rmdir() 只允许在目录为空时删除目录:

# Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION:  This is dangerous!  For example, if top == '/', it
# could delete all your disk files.
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)

引发一个 审计事件 os.fwalk 并附带参数 top, topdown, onerror, follow_symlinks, dir_fd。

可用性: Unix。

3.3 新版功能.

在 3.6 版更改: 接受一个 path-like object。

在 3.7 版更改: 添加了对 bytes 类型路径的支持。

os.memfd_create(name[, flags=os.MFD_CLOEXEC])

创建一个匿名文件，返回指向该文件的文件描述符。flags 必须是系统上可用的 os.MFD_* 常量之一（或将它们按位“或”组合起来）。新文件描述符默认是 不可继承的。

name 提供的名称会被用作文件名，并且 /proc/self/fd/ 目录中相应符号链接的目标将显示为该名称。显示的名称始终以 memfd: 为前缀，并且仅用于调试目的。名称不会影响文件描述符的行为，因此多个文件可以有相同的名称，不会有副作用。

可用性：Linux 3.17 或更高版本，且装有 glibc 2.27 或更高版本。

3.8 新版功能.

os.MFD_CLOEXEC

os.MFD_ALLOW_SEALING

os.MFD_HUGETLB

os.MFD_HUGE_SHIFT

os.MFD_HUGE_MASK

os.MFD_HUGE_64KB

os.MFD_HUGE_512KB

os.MFD_HUGE_1MB

os.MFD_HUGE_2MB

os.MFD_HUGE_8MB

os.MFD_HUGE_16MB

os.MFD_HUGE_32MB

os.MFD_HUGE_256MB

os.MFD_HUGE_512MB

os.MFD_HUGE_1GB

os.MFD_HUGE_2GB

os.MFD_HUGE_16GB

以上标志位可以传递给 memfd_create()。

可用性：Linux 3.17 或更高版本，且装有 glibc 2.27 或更高版本。MFD_HUGE* 标志仅在 Linux 4.14 及以上可用。

3.8 新版功能.

os.eventfd(initval[, flags=os.EFD_CLOEXEC])

创建并返回一个事件文件描述符。此文件描述符支持缓冲区大小为 8 的原生 read() 和 write() 操作、select() 、poll() 等类似操作。更多信息请参阅 man 文档 eventfd(2)。默认情况下，新的文件描述符是 non-inheritable。

initval 是事件计数器的初始值。初始值必须是一个 32 位无符号整数。请注意，虽然事件计数器是一个无符号的 64 位整数，其最大值为 2 ⁶⁴-2，但初始值仍被限制为 32 位无符号整数。

flags 可由 EFD_CLOEXEC 、 EFD_NONBLOCK 和 EFD_SEMAPHORE 组合而成。

如果设置了 EFD_SEMAPHORE，并且事件计数器非零，那么 eventfd_read() 将返回 1 并将计数器递减 1。

如果未设置 EFD_SEMAPHORE，并且事件计数器非零，那么 eventfd_read() 返回当前的事件计数器值，并将计数器重置为零。

如果事件计数器为 0，并且未设置 EFD_NONBLOCK，那么 eventfd_read() 会阻塞。

eventfd_write() 会递增事件计数器。如果写操作会让计数器的增量大于2⁶⁴-2，则写入会被阻止。

示例:

import os

# semaphore with start value '1'
fd = os.eventfd(1, os.EFD_SEMAPHORE | os.EFC_CLOEXEC)
try:
    # acquire semaphore
    v = os.eventfd_read(fd)
    try:
        do_work()
    finally:
        # release semaphore
        os.eventfd_write(fd, v)
finally:
    os.close(fd)

可用性 ：Linux 2.6.27 以上版本，带有 glibc 2.8 以上版本。

3.10 新版功能.

os.eventfd_read(fd)

从一个 eventfd() 文件描述符中读取数据，并返回一个 64 位无符号整数。该函数不会校验 fd 是否为 eventfd()。

可用性 ：参见 eventfd() 。

3.10 新版功能.

os.eventfd_write(fd, value)

向一个 eventfd() 文件描述符加入数据。value 必须是一个 64 位无符号整数。本函数不会校验 fd 是否为 eventfd()。

可用性 ：参见 eventfd() 。

3.10 新版功能.

os.EFD_CLOEXEC

为新的 eventfd() 文件描述符设置 close-on-exec 标志。

可用性 ：参见 eventfd() 。

3.10 新版功能.

os.EFD_NONBLOCK

为新的 eventfd() 文件描述符设置 O_NONBLOCK 状态标志。

可用性 ：参见 eventfd() 。

3.10 新版功能.

os.EFD_SEMAPHORE

为读取 eventfd() 文件描述符的操作提供类似信号量的控制。在读取时，内部计数器递减 1。

可用性: Linux 2.6.30 以上版本，带有 glibc 2.8 以上版本。

3.10 新版功能.

Linux 扩展属性

3.3 新版功能.

这些函数仅在 Linux 上可用。

os.getxattr(path, attribute, *, follow_symlinks=True)

返回 path 的扩展文件系统属性 attribute 的值。attribute 可以是 bytes 或 str （直接传入或通过 PathLike 接口间接传入）。如果是 str，则使用文件系统编码来编码字符串。

本函数支持 指定文件描述符为参数 和 不跟踪符号链接。

引发一个 审计事件 os.getxattr 并附带参数 path, attribute。

在 3.6 版更改: 接受一个 类路径对象 作为 path 和 attribute。

os.listxattr(path=None, *, follow_symlinks=True)

返回一个列表，包含 path 的所有扩展文件系统属性。列表中的属性都表示为字符串，它们是根据文件系统编码解码出来的。如果 path 为 None，则 listxattr() 将检查当前目录。

本函数支持 指定文件描述符为参数 和 不跟踪符号链接。

引发一个 审计事件 os.listxattr 并附带参数 path。

在 3.6 版更改: 接受一个 path-like object。

os.removexattr(path, attribute, *, follow_symlinks=True)

移除 path 中的扩展文件系统属性 attribute。 attribute 应为字节串或字符串类型（通过 PathLike 接口直接或间接得到）。 若为字符串类型，则用 filesystem encoding and error handler 进行编码。

本函数支持 指定文件描述符为参数 和 不跟踪符号链接。

引发一个 审计事件 os.removexattr 并附带参数 path, attribute。

在 3.6 版更改: 接受一个 类路径对象 作为 path 和 attribute。

os.setxattr(path, attribute, value, flags=0, *, follow_symlinks=True)

将 path 的文件系统扩展属性 attribute 设为 value。 attribute 必须是一个字节串或字符串，不含 NUL（通过 PathLike 接口直接或间接得到）。 若为字符串，将用 filesystem encoding and error handler 进行编码。 flags 可以是 XATTR_REPLACE 或 XATTR_CREATE。 如果给出 XATTR_REPLACE 而属性不存在，则会触发 ENODATA。 如果给出了 XATTR_CREATE 而属性已存在，则不会创建属性并将触发 EEXISTS。

本函数支持 指定文件描述符为参数 和 不跟踪符号链接。

注解

Linux kernel 2.6.39 以下版本的一个 bug 导致在某些文件系统上，flags 参数会被忽略。

引发一个 审计事件 os.setxattr 并附带参数 path, attribute, value, flags。

在 3.6 版更改: 接受一个 类路径对象 作为 path 和 attribute。

os.XATTR_SIZE_MAX

一条扩展属性的值的最大大小。在当前的 Linux 上是 64 KiB。

os.XATTR_CREATE

这是 setxattr() 的 flags 参数的可取值，它表示该操作必须创建一个属性。

os.XATTR_REPLACE

这是 setxattr() 的 flags 参数的可取值，它表示该操作必须替换现有属性。

进程管理

下列函数可用于创建和管理进程。

所有 exec* 函数都接受一个参数列表，用来给新程序加载到它的进程中。在所有情况下，传递给新程序的第一个参数是程序本身的名称，而不是用户在命令行上输入的参数。对于 C 程序员来说，这就是传递给 main() 函数的 argv[0]。例如，os.execv('/bin/echo', ['foo', 'bar']) 只会在标准输出上打印 bar，而 foo 会被忽略。

os.abort()

发送 SIGABRT 信号到当前进程。在 Unix 上，默认行为是生成一个核心转储。在 Windows 上，该进程立即返回退出代码 3。请注意，使用 signal.signal() 可以为 SIGABRT 注册 Python 信号处理程序，而调用本函数将不会调用按前述方法注册的程序。

os.add_dll_directory(path)

将路径添加到 DLL 搜索路径。

当需要解析扩展模块的依赖时（扩展模块本身通过 sys.path 解析），会使用该搜索路径，ctypes 也会使用该搜索路径。

要移除目录，可以在返回的对象上调用 close()，也可以在 with 语句内使用本方法。

参阅 Microsoft 文档 [https://msdn.microsoft.com/44228cf2-6306-466c-8f16-f513cd3ba8b5] 获取如何加载 DLL 的信息。

引发一个 审计事件 os.add_dll_directory 并附带参数 path。

可用性: Windows。

3.8 新版功能: 早期版本的 CPython 解析 DLL 时用的是当前进程的默认行为。这会导致不一致，比如不是每次都会去搜索 PATH 和当前工作目录，且系统函数（如 AddDllDirectory ）失效。

在 3.8 中，DLL 的两种主要加载方式现在可以显式覆盖进程的行为，以确保一致性。请参阅 移植说明 了解如何更新你的库。

os.execl(path, arg0, arg1, ...)

os.execle(path, arg0, arg1, ..., env)

os.execlp(file, arg0, arg1, ...)

os.execlpe(file, arg0, arg1, ..., env)

os.execv(path, args)

os.execve(path, args, env)

os.execvp(file, args)

os.execvpe(file, args, env)

这些函数都将执行一个新程序，以替换当前进程。它们没有返回值。在 Unix 上，新程序会加载到当前进程中，且进程号与调用者相同。过程中的错误会被报告为 OSError 异常。

当前进程会被立即替换。打开的文件对象和描述符都不会刷新，因此如果这些文件上可能缓冲了数据，则应在调用 exec* 函数之前使用 sys.stdout.flush() 或 os.fsync() 刷新它们。

exec* 函数的 "l" 和 "v" 变体不同在于命令行参数的传递方式。如果在编码时固定了参数数量，则 "l" 变体可能是最方便的，各参数作为 execl*() 函数的附加参数传入即可。当参数数量可变时，"v" 变体更方便，参数以列表或元组的形式作为 args 参数传递。在这两种情况下，子进程的第一个参数都应该是即将运行的命令名称，但这不是强制性的。

结尾包含 "p" 的变体（execlp()、execlpe()、execvp() 和 execvpe() ）将使用 PATH 环境变量来查找程序 file。当环境被替换时（使用下一段讨论的 exec*e 变体之一），PATH 变量将来自于新环境。其他变体 execl()、execle()、execv() 和 execve() 不使用 PATH 变量来查找程序，因此 path 必须包含正确的绝对或相对路径。

对于 execle()、execlpe()、execve() 和 execvpe() （都以 "e" 结尾），env 参数是一个映射，用于定义新进程的环境变量（代替当前进程的环境变量）。而函数 execl()、execlp()、execv() 和 execvp() 会将当前进程的环境变量过继给新进程。

某些平台上的 execve() 可以将 path 指定为打开的文件描述符。当前平台可能不支持此功能，可以使用 os.supports_fd 检查它是否支持。如果不可用，则使用它会抛出 NotImplementedError 异常。

引发一个 审计事件 os.exec 并附带参数 path, args, env。

可用性: Unix, Windows。

3.3 新版功能: 新增支持将 execve() 的 path 参数指定为打开的文件描述符。

在 3.6 版更改: 接受一个 path-like object。

os._exit(n)

以状态码 n 退出进程，不会调用清理处理程序，不会刷新 stdio，等等。

注解

退出的标准方式是使用 sys.exit(n)。 _exit() 通常只应在 fork() 所生成的子进程中使用。

以下是已定义的退出代码，可以用于 _exit()，尽管它们不是必需的。这些退出代码通常用于 Python 编写的系统程序，例如邮件服务器的外部命令传递程序。

注解

其中部分退出代码在部分 Unix 平台上可能不可用，因为平台间存在差异。如果底层平台定义了这些常量，那上层也会定义。

os.EX_OK

退出代码，表示未发生任何错误。

可用性: Unix。

os.EX_USAGE

退出代码，表示命令使用不正确，如给出的参数数量有误。

可用性: Unix。

os.EX_DATAERR

退出代码，表示输入数据不正确。

可用性: Unix。

os.EX_NOINPUT

退出代码，表示某个输入文件不存在或不可读。

可用性: Unix。

os.EX_NOUSER

退出代码，表示指定的用户不存在。

可用性: Unix。

os.EX_NOHOST

退出代码，表示指定的主机不存在。

可用性: Unix。

os.EX_UNAVAILABLE

退出代码，表示所需的服务不可用。

可用性: Unix。

os.EX_SOFTWARE

退出代码，表示检测到内部软件错误。

可用性: Unix。

os.EX_OSERR

退出代码，表示检测到操作系统错误，例如无法 fork 或创建管道。

可用性: Unix。

os.EX_OSFILE

退出代码，表示某些系统文件不存在、无法打开或发生其他错误。

可用性: Unix。

os.EX_CANTCREAT

退出代码，表示无法创建用户指定的输出文件。

可用性: Unix。

os.EX_IOERR

退出代码，表示对某些文件进行读写时发生错误。

可用性: Unix。

os.EX_TEMPFAIL

退出代码，表示发生了暂时性故障。它可能并非意味着真正的错误，例如在可重试的情况下无法建立网络连接。

可用性: Unix。

os.EX_PROTOCOL

退出代码，表示协议交换是非法的、无效的或无法解读的。

可用性: Unix。

os.EX_NOPERM

退出代码，表示没有足够的权限执行该操作（但不适用于文件系统问题）。

可用性: Unix。

os.EX_CONFIG

退出代码，表示发生某种配置错误。

可用性: Unix。

os.EX_NOTFOUND

退出代码，表示的内容类似于“找不到条目”。

可用性: Unix。

os.fork()

Fork 出一个子进程。在子进程中返回 0，在父进程中返回子进程的进程号。如果发生错误，则抛出 OSError 异常。

注意，当从线程中使用 fork() 时，某些平台（包括 FreeBSD <= 6.3 和 Cygwin）存在已知问题。

引发一个不带参数的 审计事件 os.fork。

在 3.8 版更改: 不再支持在子解释器中调用 fork() （将抛出 RuntimeError 异常）。

警告

有关 SSL 模块与 fork() 结合的应用，请参阅 ssl。

可用性: Unix。

os.forkpty()

Fork 出一个子进程，使用新的伪终端作为子进程的控制终端。返回一对 (pid, fd)，其中 pid 在子进程中为 0，这是父进程中新子进程的进程号，而 fd 是伪终端主设备的文件描述符。对于更便于移植的方法，请使用 pty 模块。如果发生错误，则抛出 OSError 异常。

引发一个不带参数的 审计事件 os.forkpty。

在 3.8 版更改: 不再支持在子解释器中调用 forkpty() （将抛出 RuntimeError 异常）。

可用性: 某些 Unix。

os.kill(pid, sig)

将信号 sig 发送至进程 pid。特定平台上可用的信号常量定义在 signal 模块中。

Windows： signal.CTRL_C_EVENT 和 signal.CTRL_BREAK_EVENT 信号是特殊信号，只能发送给共享同一个控制台窗口的控制台进程，如某些子进程。sig 取任何其他值将导致该进程被 TerminateProcess API 无条件终止，且退出代码为 sig。Windows 版本的 kill() 还需要传入待结束进程的句柄。

另请参阅 signal.pthread_kill()。

引发一个 审计事件 os.kill 并附带参数 pid, sig。

3.2 新版功能: Windows 支持。

os.killpg(pgid, sig)

将信号 sig 发送给进程组 pgid。

引发一个 审计事件 os.killpg 并附带参数 pgid, sig。

可用性: Unix。

os.nice(increment)

将进程的优先级（nice 值）增加 increment，返回新的 nice 值。

可用性: Unix。

os.pidfd_open(pid, flags=0)

返回一个文件描述符，它指向进程 pid。该描述符可用于管理进程，避免出现竞争和信号。flags 参数提供给将来扩展使用，当前没有定义标志值。

更多详细信息请参阅 pidfd_open(2) 手册页。

可用性: Linux 5.3+。

3.9 新版功能.

os.plock(op)

将程序段锁定到内存中。op 的值（定义在 <sys/lock.h> 中）决定了哪些段被锁定。

可用性: Unix。

os.popen(cmd, mode='r', buffering=- 1)

打开一个管道，它通往 / 接受自命令 cmd。返回值是连接到管道的文件对象，根据 mode 是 'r' （默认）还是 'w' 决定该对象可以读取还是写入。buffering 参数与内置函数 open() 相应的参数含义相同。返回的文件对象只能读写文本字符串，不能是字节类型。

如果子进程成功退出，则 close 方法返回 None。如果发生错误，则返回子进程的返回码。在 POSIX 系统上，如果返回码为正，则它就是进程返回值左移一个字节后的值。如果返回码为负，则进程是被信号终止的，返回码取反后就是该信号。（例如，如果子进程被终止，则返回值可能是 - signal.SIGKILL。）在 Windows 系统上，返回值包含子进程的返回码（有符号整数）。

在 Unix 上，waitstatus_to_exitcode() 可以将 close 方法的返回值（即退出状态，不能是 None）转换为退出码。在 Windows 上，close 方法的结果直接就是退出码（或 None ）。

本方法是使用 subprocess.Popen 实现的，如需更强大的方法来管理和沟通子进程，请参阅该类的文档。

os.posix_spawn(path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

包装 posix_spawn() C 库 API，使其可以从 Python 调用。

大多数用户应使用 subprocess.run() 代替 posix_spawn()。

仅位置参数 (Positional-only arguments) path、args 和 env 与 execve() 中的类似。

path 形参是可执行文件的路径，path 中应当包含目录。 使用 posix_spawnp() 可传入不带目录的可执行文件。

file_actions 参数可以是由元组组成的序列，序列描述了对子进程中指定文件描述符采取的操作，这些操作会在 C 库实现的 fork() 和 exec() 步骤间完成。每个元组的第一个元素必须是下面列出的三个类型指示符之一，用于描述元组剩余的元素：

os.POSIX_SPAWN_OPEN

(os.POSIX_SPAWN_OPEN, fd, path, flags, mode)

执行 os.dup2(os.open(path, flags, mode), fd)。

os.POSIX_SPAWN_CLOSE

(os.POSIX_SPAWN_CLOSE, fd)

执行 os.close(fd)。

os.POSIX_SPAWN_DUP2

(os.POSIX_SPAWN_DUP2, fd, new_fd)

执行 os.dup2(fd, new_fd)。

这些元组对应于 C 库 posix_spawn_file_actions_addopen()， posix_spawn_file_actions_addclose() 和 posix_spawn_file_actions_adddup2() API 调用，它们为调用 posix_spawn() 自身做准备。

setpgroup 参数将子进程的进程组设置为指定值。如果指定值为 0，则子进程的进程组 ID 将与其进程 ID 相同。如果未设置 setpgroup 值，则子进程将继承父进程的进程组 ID。本参数对应于 C 库 POSIX_SPAWN_SETPGROUP 标志。

如果 resetids 参数为 True，则会将子进程的有效用户 ID 和有效组 ID 重置为父进程的实际用户 ID 和实际组 ID。如果该参数为 False，则子进程保留父进程的有效用户 ID 和有效组 ID。无论哪种情况，若在可执行文件上启用了 “设置用户 ID” 和 “设置组 ID” 权限位，它们将覆盖有效用户 ID 和有效组 ID 的设置。本参数对应于 C 库 POSIX_SPAWN_RESETIDS 标志。

If the setsid argument is True, it will create a new session ID for posix_spawn. setsid requires POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP flag. Otherwise, NotImplementedError is raised.

setsigmask 参数将信号掩码设置为指定的信号集合。如果未使用该参数，则子进程将继承父进程的信号掩码。本参数对应于 C 库 POSIX_SPAWN_SETSIGMASK 标志。

sigdef 参数将集合中所有信号的操作全部重置为默认。本参数对应于 C 库 POSIX_SPAWN_SETSIGDEF 标志。

scheduler 参数必须是一个元组，其中包含调度器策略（可选）以及携带了调度器参数的 sched_param 实例。在调度器策略所在位置为 None 表示未提供该值。本参数是 C 库 POSIX_SPAWN_SETSCHEDPARAM 和 POSIX_SPAWN_SETSCHEDULER 标志的组合。

引发一个 审计事件 os.posix_spawn 并附带参数 path, argv, env。

3.8 新版功能.

可用性: Unix。

os.posix_spawnp(path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

包装 posix_spawnp() C 库 API，使其可以从 Python 调用。

与 posix_spawn() 相似，但是系统会在 PATH 环境变量指定的目录列表中搜索可执行文件 executable （与 execvp(3) 相同）。

引发一个 审计事件 os.posix_spawn 并附带参数 path, argv, env。

3.8 新版功能.

可用性: 请参阅 posix_spawn() 文档。

os.register_at_fork(*, before=None, after_in_parent=None, after_in_child=None)

注册可调用对象，在使用 os.fork() 或类似的进程克隆 API 派生新的子进程时，这些对象会运行。参数是可选的，且为仅关键字 (Keyword-only) 参数。每个参数指定一个不同的调用点。

before 是一个函数，在 fork 子进程前调用。

after_in_parent 是一个函数，在 fork 子进程后从父进程调用。

after_in_child 是一个函数，从子进程中调用。

只有希望控制权回到 Python 解释器时，才进行这些调用。典型的 子进程 启动时不会触发它们，因为子进程不会重新进入解释器。

在注册的函数中，用于 fork 前运行的函数将按与注册相反的顺序调用。用于 fork 后（从父进程或子进程）运行的函数按注册顺序调用。

注意，第三方 C 代码的 fork() 调用可能不会调用这些函数，除非它显式调用了 PyOS_BeforeFork()、PyOS_AfterFork_Parent() 和 PyOS_AfterFork_Child()。

函数注册后无法注销。

可用性: Unix。

3.7 新版功能.

os.spawnl(mode, path, ...)

os.spawnle(mode, path, ..., env)

os.spawnlp(mode, file, ...)

os.spawnlpe(mode, file, ..., env)

os.spawnv(mode, path, args)

os.spawnve(mode, path, args, env)

os.spawnvp(mode, file, args)

os.spawnvpe(mode, file, args, env)

在新进程中执行程序 path。

（注意，subprocess 模块提供了更强大的工具来生成新进程并跟踪执行结果，使用该模块比使用这些函数更好。尤其应当检查 使用 subprocess 模块替换旧函数 部分。）

mode 为 P_NOWAIT 时，本函数返回新进程的进程号。mode 为 P_WAIT 时，如果进程正常退出，返回退出代码，如果被终止，返回 -signal，其中 signal 是终止进程的信号。在 Windows 上，进程号实际上是进程句柄，因此可以与 waitpid() 函数一起使用。

注意在 VxWorks 上，新进程被终止时，本函数不会返回 -signal，而是会抛出 OSError 异常。

spawn* 函数的 "l" 和 "v" 变体不同在于命令行参数的传递方式。如果在编码时固定了参数数量，则 "l" 变体可能是最方便的，各参数作为 spawnl*() 函数的附加参数传入即可。当参数数量可变时，"v" 变体更方便，参数以列表或元组的形式作为 args 参数传递。在这两种情况下，子进程的第一个参数都必须是即将运行的命令名称。

结尾包含第二个 "p" 的变体（spawnlp()、spawnlpe()、spawnvp() 和 spawnvpe()）将使用 PATH 环境变量来查找程序 file。当环境被替换时（使用下一段讨论的 spawn*e 变体之一），PATH 变量将来自于新环境。其他变体 spawnl()、spawnle()、spawnv() 和 spawnve() 不使用 PATH 变量来查找程序，因此 path 必须包含正确的绝对或相对路径。

对于 spawnle()、spawnlpe()、spawnve() 和 spawnvpe() （都以 "e" 结尾），env 参数是一个映射，用于定义新进程的环境变量（代替当前进程的环境变量）。而函数 spawnl()、spawnlp()、spawnv() 和 spawnvp() 会将当前进程的环境变量过继给新进程。注意，env 字典中的键和值必须是字符串。无效的键或值将导致函数出错，返回值为 127。

例如，以下对 spawnlp() 和 spawnvpe() 的调用是等效的:

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)

引发一个 审计事件 os.spawn 并附带参数 mode, path, args, env。

可用性: Unix, Windows。spawnlp()、spawnlpe()、spawnvp() 和 spawnvpe() 在 Windows 上不可用。spawnle() 和 spawnve() 在 Windows 上不是线程安全的，建议使用 subprocess 模块替代。

在 3.6 版更改: 接受一个 path-like object。

os.P_NOWAIT

os.P_NOWAITO

spawn* 系列函数的 mode 参数的可取值。如果给出这些值中的任何一个，则 spawn*() 函数将在创建新进程后立即返回，且返回值为进程号。

可用性: Unix, Windows。

os.P_WAIT

spawn* 系列函数的 mode 参数的可取值。如果将 mode 指定为该值，则 spawn*() 函数将在新进程运行完毕后返回，运行成功则返回进程的退出代码，被信号终止则返回 -signal。

可用性: Unix, Windows。

os.P_DETACH

os.P_OVERLAY

spawn* 系列函数的 mode 参数的可取值。它们比上面列出的值可移植性差。P_DETACH 与 P_NOWAIT 相似，但是新进程会与父进程的控制台脱离。使用 P_OVERLAY 则会替换当前进程，spawn* 函数将不会返回。

可用性: Windows。

os.startfile(path[, operation][, arguments][, cwd][, show_cmd])

使用已关联的应用程序打开文件。

当 operation 未指定或指定为 'open' 时，这类似于在 Windows 资源管理器中双击文件，或在交互式命令行中将文件名作为 start 命令的参数：通过扩展名相关联的应用程序（如果有）打开文件。

当指定另一个 operation 时，它必须是一个“命令动词” ("command verb")，该词指定对文件执行的操作。Microsoft 文档中的常用动词有 'print' 和 'edit' （用于文件），以及 'explore' 和 'find' （用于目录）。

在启动某个应用程序时，arguments 将作为一个字符串传入。若是打开某个文档，此参数可能没什么效果。

默认工作目录是继承而来的，但可以通过 cwd 参数进行覆盖。且应为绝对路径。相对路径 path 将据此参数进行解析。

show_cmd 可用于覆盖默认的窗口样式。是否生效则取决于被启动的应用程序。应为 Win32 函数 ShellExecute() 所支持的整数值。

在关联的应用程序启动后，startfile() 就会立即返回。 没有提供等待应用程序关闭的选项，也没有办法获得应用程序的退出状态。 path 形参是基于当前目录或 cwd 的相对路径。 如果要使用绝对路径，请确保第一个字符不为斜杠 ('/') 。 请用 pathlib 或 os.path.normpath() 函数来保证路径已按照 Win32 的要求进行了正确的编码。

为了减少解释器的启动开销，直到第一次调用本函数后，才解析 Win32 ShellExecute() 函数。如果无法解析该函数​​，则抛出 NotImplementedError 异常。

引发一个 审计事件 os.startfile 并附带参数 path, operation。

引发一个 审计事件 os.startfile/2 并附带参数 path, operation, arguments, cwd, show_cmd。

可用性: Windows。

在 3.10 版更改: 加入了 arguments、cwd 和 show_cmd 参数，以及 os.startfile/2 审计事件。

os.system(command)

在子外壳程序中执行此命令（一个字符串）。 这是通过调用标准 C 函数 system() 来实现的，并受到同样的限制。 对 sys.stdin 的更改等不会反映在所执行命令的环境中。 如果 command 生成了任何输出，它将被发送到解释器的标准输出流。 C 标准没有指明这个 C 函数返回值的含义，因此这个 Python 函数的返回值取决于具体系统。

在 Unix 上，返回值为进程的退出状态，以针对 wait() 而指定的格式进行编码。

在 Windows 上，返回值是运行 command 后系统 Shell 返回的值。该 Shell 由 Windows 环境变量 COMSPEC: 给出：通常是 cmd.exe，它会返回命令的退出状态。在使用非原生 Shell 的系统上，请查阅 Shell 的文档。

subprocess 模块提供了更强大的工具来生成新进程并跟踪执行结果，使用该模块比使用本函数更好。参阅 subprocess 文档中的 使用 subprocess 模块替换旧函数 部分以获取有用的帮助。

在 Unix 上，waitstatus_to_exitcode() 可以将返回值（即退出状态）转换为退出码。在 Windows 上，返回值就是退出码。

引发一个 审计事件 os.system 并附带参数 command。

可用性: Unix, Windows。

os.times()

返回当前的全局进程时间。返回值是一个有 5 个属性的对象：

user - 用户时间

system - 系统时间

children_user - 所有子进程的用户时间

children_system - 所有子进程的系统时间

elapsed - 从过去的固定时间点起，经过的真实时间

为了向后兼容，该对象的行为也类似于五元组，按照 user，system，children_user，children_system 和 elapsed 顺序组成。

See the Unix manual page times(2) and times(3) [https://www.freebsd.org/cgi/man.cgi?time(3)] manual page on Unix or the GetProcessTimes MSDN [https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes] on Windows. On Windows, only user and system are known; the other attributes are zero.

可用性: Unix, Windows。

在 3.3 版更改: 返回结果的类型由元组变成一个类似元组的对象，同时具有命名的属性。

os.wait()

等待子进程执行完毕，返回一个元组，包含其 pid 和退出状态指示：一个 16 位数字，其低字节是终止该进程的信号编号，高字节是退出状态码（信号编号为零的情况下），如果生成了核心文件，则低字节的高位会置位。

可以使用 waitstatus_to_exitcode() 来将退出状态转换为退出码。

可用性: Unix。

参见

waitpid() 可以等待特定的子进程执行完毕，且支持更多选项。

os.waitid(idtype, id, options)

等待一个或多个子进程执行完毕。idtype 可以是 P_PID, P_PGID, P_ALL, 或 P_PIDFD （Linux 可用）。id 指定要等待的 pid。options 是由 WEXITED、WSTOPPED 或 WCONTINUED 中的一个或多个进行或运算构造的，且额外可以与 WNOHANG 或 WNOWAIT 进行或运算。返回值是一个对象，对应着 siginfo_t 结构体中的数据，即： si_pid, si_uid, si_signo, si_status, si_code 或 None （如果指定了 WNOHANG 且没有子进程处于等待状态）。

可用性: Unix。

3.3 新版功能.

os.P_PID

os.P_PGID

os.P_ALL

waitid() 的 idtype 参数的可取值。它们影响 id 的解释方式。

可用性: Unix。

3.3 新版功能.

os.P_PIDFD

这是仅 Linux 上存在的一种 idtype，它表示 id 是指向一个进程的文件描述符。

可用性: Linux 5.4+

3.9 新版功能.

os.WEXITED

os.WSTOPPED

os.WNOWAIT

用于 waitid() 的 options 参数的标志位，指定要等待的子进程信号。

可用性: Unix。

3.3 新版功能.

os.CLD_EXITED

os.CLD_KILLED

os.CLD_DUMPED

os.CLD_TRAPPED

os.CLD_STOPPED

os.CLD_CONTINUED

waitid() 返回的结果中，si_code 的可取值。

可用性: Unix。

3.3 新版功能.

在 3.9 版更改: 添加了 CLD_KILLED 和 CLD_STOPPED 值。

os.waitpid(pid, options)

本函数的细节在 Unix 和 Windows 上有不同之处。

在 Unix 上：等待进程号为 pid 的子进程执行完毕，返回一个元组，内含其进程 ID 和退出状态指示（编码与 wait() 相同）。调用的语义受整数 options 的影响，常规操作下该值应为 0。

如果 pid 大于 0，则 waitpid() 会获取该指定进程的状态信息。如果 pid 为 0，则获取当前进程所在进程组中的所有子进程的状态。如果 pid 为 -1，则获取当前进程的子进程状态。如果 pid 小于 -1，则获取进程组 -pid （ pid 的绝对值）中所有进程的状态。

当系统调用返回 -1 时，将抛出带有错误码的 OSError 异常。

在 Windows 上：等待句柄为 pid 的进程执行完毕，返回一个元组，内含 pid 以及左移 8 位后的退出状态码（移位简化了跨平台使用本函数）。小于或等于 0 的 pid 在 Windows 上没有特殊含义，且会抛出异常。整数值 options 无效。pid 可以指向任何 ID 已知的进程，不一定是子进程。调用 spawn* 函数时传入 P_NOWAIT 将返回合适的进程句柄。

可以使用 waitstatus_to_exitcode() 来将退出状态转换为退出码。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

os.wait3(options)

与 waitpid() 相似，差别在于没有进程 ID 参数，且返回一个 3 元组，其中包括子进程 ID，退出状态指示和资源使用信息。关于资源使用信息的详情，请参考 resource.getrusage()。option 参数与传入 waitpid() 和 wait4() 的相同。

可以使用 waitstatus_to_exitcode() 来将退出状态转换为退出码。

可用性: Unix。

os.wait4(pid, options)

与 waitpid() 相似，差别在本方法返回一个 3 元组，其中包括子进程 ID，退出状态指示和资源使用信息。关于资源使用信息的详情，请参考 resource.getrusage()。wait4() 的参数与 waitpid() 的参数相同。

可以使用 waitstatus_to_exitcode() 来将退出状态转换为退出码。

可用性: Unix。

os.waitstatus_to_exitcode(status)

将等待状态转换为退出码。

在 Unix 上：

如果进程正常退出（当 WIFEXITED(status) 为真值），则返回进程退出状态 (返回 WEXITSTATUS(status)): 结果值大于等于 0。

如果进程被信号终止（当 WIFSIGNALED(status) 为真值），则返回 -signum 其中 signum 为导致进程终止的信号数值 (返回 -WTERMSIG(status)): 结果值小于 0。

否则将抛出 ValueError 异常。

在 Windows 上，返回 status 右移 8 位的结果。

在 Unix 上，如果进程正被追踪或 waitpid() 附带 WUNTRACED 选项被调用，则调用者必须先检查 WIFSTOPPED(status) 是否为真值。 如果 WIFSTOPPED(status) 为真值则此函数不可被调用。

参见

WIFEXITED(), WEXITSTATUS(), WIFSIGNALED(), WTERMSIG(), WIFSTOPPED(), WSTOPSIG() 函数。

3.9 新版功能.

os.WNOHANG

用于 waitpid() 的选项，如果没有立即可用的子进程状态，则立即返回。在这种情况下，函数返回 (0, 0)。

可用性: Unix。

os.WCONTINUED

被任务控制 (job control) 停止的子进程，如果上次报告状态后已恢复运行，则此选项将报告这些子进程。

可用性: 部分 Unix 系统。

os.WUNTRACED

已停止的子进程，如果自停止以来尚未报告其当前状态，则此选项将报告这些子进程。

可用性: Unix。

下列函数采用进程状态码作为参数，状态码由 system()、wait() 或 waitpid() 返回。它们可用于确定进程上发生的操作。

os.WCOREDUMP(status)

如果为该进程生成了核心转储，返回 True，否则返回 False。

此函数应当仅在 WIFSIGNALED() 为真值时使用。

可用性: Unix。

os.WIFCONTINUED(status)

如果一个已停止的子进程通过传送 SIGCONT 获得恢复（如果该进程是从任务控制停止后再继续的）则返回 True，否则返回 False。

参见 WCONTINUED 选项。

可用性: Unix。

os.WIFSTOPPED(status)

如果进程是通过传送一个信号来停止的则返回 True，否则返回 False。

WIFSTOPPED() 只有在当 waitpid() 调用是通过使用 WUNTRACED 选项来完成或者当该进程正被追踪时 (参见 ptrace(2)) 才返回 True。

可用性: Unix。

os.WIFSIGNALED(status)

如果进程是通过一个信号来终止的则返回 True ，否则返回 False。

可用性: Unix。

os.WIFEXITED(status)

如果进程正常终止退出则返回 True，也就是说通过调用 exit() 或 _exit()，或者通过从 main() 返回；在其他情况下则返回 False。

可用性: Unix。

os.WEXITSTATUS(status)

返回进程退出状态。

此函数应当仅在 WIFEXITED() 为真值时使用。

可用性: Unix。

os.WSTOPSIG(status)

返回导致进程停止的信号。

此函数应当仅在 WIFSTOPPED() 为真值时使用。

可用性: Unix。

os.WTERMSIG(status)

返回导致进程终止的信号的编号。

此函数应当仅在 WIFSIGNALED() 为真值时使用。

可用性: Unix。

调度器接口

这些函数控制操作系统如何为进程分配 CPU 时间。 它们仅在某些 Unix 平台上可用。 更多细节信息请查阅你所用 Unix 的指南页面。

3.3 新版功能.

以下调度策略如果被操作系统支持就会对外公开。

os.SCHED_OTHER

默认调度策略。

os.SCHED_BATCH

用于 CPU 密集型进程的调度策略，它会尽量为计算机中的其余任务保留交互性。

os.SCHED_IDLE

用于极低优先级的后台任务的调度策略。

os.SCHED_SPORADIC

用于偶发型服务程序的调度策略。

os.SCHED_FIFO

先进先出的调度策略。

os.SCHED_RR

循环式的调度策略。

os.SCHED_RESET_ON_FORK

此旗标可与任何其他调度策略进行 OR 运算。 当带有此旗标的进程设置分叉时，其子进程的调度策略和优先级会被重置为默认值。

class os.sched_param(sched_priority)

这个类表示在 sched_setparam(), sched_setscheduler() 和 sched_getparam() 中使用的可修改调度形参。 它属于不可变对象。

目前它只有一个可能的形参：

sched_priority

一个调度策略的调度优先级。

os.sched_get_priority_min(policy)

获取 policy 的最低优先级数值。 policy 是以上调度策略常量之一。

os.sched_get_priority_max(policy)

获取 policy 的最高优先级数值。 policy 是以上调度策略常量之一。

os.sched_setscheduler(pid, policy, param)

设置 PID 为 pid 的进程的调度策略。pid 为 0 指的是调用本方法的进程。policy 是以上调度策略常量之一。param 是一个 sched_param 实例。

os.sched_getscheduler(pid)

返回 PID 为 pid 的进程的调度策略。pid 为 0 指的是调用本方法的进程。返回的结果是以上调度策略常量之一。

os.sched_setparam(pid, param)

设置 PID 为 pid 的进程的调度参数。 pid 为 0 表示调用方过程。 param 是一个 sched_param 实例。

os.sched_getparam(pid)

返回 PID 为 pid 的进程的调度参数为一个 sched_param 实例。pid 为 0 指的是调用本方法的进程。

os.sched_rr_get_interval(pid)

返回 PID 为 pid 的进程在时间片轮转调度下的时间片长度（单位为秒）。pid 为 0 指的是调用本方法的进程。

os.sched_yield()

自愿放弃 CPU。

os.sched_setaffinity(pid, mask)

将 PID 为 pid 的进程（为零则为当前进程）限制到一组 CPU 上。mask 是整数的可迭代对象，表示应将进程限制在其中的一组 CPU。

os.sched_getaffinity(pid)

返回 PID 为 pid 的进程（为零则为当前进程）被限制到的那一组 CPU。

其他系统信息

os.confstr(name)

返回字符串格式的系统配置信息。name 指定要查找的配置名称，它可以是字符串，是一个系统已定义的名称，这些名称定义在不同标准（POSIX，Unix 95，Unix 98 等）中。一些平台还定义了额外的其他名称。当前操作系统已定义的名称在 confstr_names 字典的键中给出。对于未包含在该映射中的配置名称，也可以传递一个整数作为 name。

如果 name 指定的配置值未定义，返回 None。

如果 name 是一个字符串且不是已定义的名称，将抛出 ValueError 异常。如果当前系统不支持 name 指定的配置名称，即使该名称存在于 confstr_names，也会抛出 OSError 异常，错误码为 errno.EINVAL。

可用性: Unix。

os.confstr_names

字典，表示映射关系，为 confstr() 可接受名称与操作系统为这些名称定义的整数值之间的映射。这可用于判断系统已定义了哪些名称。

可用性: Unix。

os.cpu_count()

返回系统的 CPU 数量。不确定则返回 None。

该数量不同于当前进程可以使用的CPU数量。可用的CPU数量可以由 len(os.sched_getaffinity(0)) 方法获得。

3.4 新版功能.

os.getloadavg()

返回系统运行队列中最近 1、5 和 15 分钟内的平均进程数。无法获得平均负载则抛出 OSError 异常。

可用性: Unix。

os.sysconf(name)

返回整数格式的系统配置信息。如果 name 指定的配置值未定义，返回 -1。对 confstr() 的 name 参数的注释在此处也适用。当前已知的配置名称在 sysconf_names 字典中提供。

可用性: Unix。

os.sysconf_names

字典，表示映射关系，为 sysconf() 可接受名称与操作系统为这些名称定义的整数值之间的映射。这可用于判断系统已定义了哪些名称。

可用性: Unix。

以下数据值用于支持对路径本身的操作。所有平台都有定义。

对路径的高级操作在 os.path 模块中定义。

os.curdir

操作系统用来表示当前目录的常量字符串。在 Windows 和 POSIX 上是 '.'。在 os.path 中也可用。

os.pardir

操作系统用来表示父目录的常量字符串。在 Windows 和 POSIX 上是 '..'。在 os.path 中也可用。

os.sep

操作系统用来分隔路径不同部分的字符。在 POSIX 上是 '/'，在 Windows 上是是 '\\'。注意，仅了解它不足以能解析或连接路径，请使用 os.path.split() 和 os.path.join()，但它有时是有用的。在 os.path 中也可用。

os.altsep

操作系统用来分隔路径不同部分的替代字符。如果仅存在一个分隔符，则为 None。在 sep 是反斜杠的 Windows 系统上，该值被设为 '/'。在 os.path 中也可用。

os.extsep

分隔基本文件名与扩展名的字符，如 os.py 中的 '.'。在 os.path 中也可用。

os.pathsep

操作系统通常用于分隔搜索路径（如 PATH）中不同部分的字符，如 POSIX 上是 ':'，Windows 上是 ';'。在 os.path 中也可用。

os.defpath

在环境变量没有 'PATH' 键的情况下，exec*p* and spawn*p* 使用的默认搜索路径。在 os.path 中也可用。

os.linesep

当前平台用于分隔（或终止）行的字符串。它可以是单个字符，如 POSIX 上是 '\n'，也可以是多个字符，如 Windows 上是 '\r\n'。在写入以文本模式（默认模式）打开的文件时，请不要使用 os.linesep 作为行终止符，请在所有平台上都使用一个 '\n' 代替。

os.devnull

空设备的文件路径。如 POSIX 上为 '/dev/null'，Windows 上为 'nul'。在 os.path 中也可用。

os.RTLD_LAZY

os.RTLD_NOW

os.RTLD_GLOBAL

os.RTLD_LOCAL

os.RTLD_NODELETE

os.RTLD_NOLOAD

os.RTLD_DEEPBIND

setdlopenflags() 和 getdlopenflags() 函数所使用的标志。请参阅 Unix 手册页 dlopen(3) 获取不同标志的含义。

3.3 新版功能.

随机数

os.getrandom(size, flags=0)

获得最多为 size 的随机字节。本函数返回的字节数可能少于请求的字节数。

这些字节可用于为用户空间的随机数生成器提供种子，或用于加密目的。

getrandom() 依赖于从设备驱动程序和其他环境噪声源收集的熵。不必要地读取大量数据将对使用 /dev/random 和 /dev/urandom 设备的其他用户产生负面影响。

flags 参数是一个位掩码，可以是零个或多个下列值以或运算组合： os.GRND_RANDOM 和 GRND_NONBLOCK。

另请参阅 Linux getrandom() 手册页 [https://man7.org/linux/man-pages/man2/getrandom.2.html]。

可用性：Linux 3.17 或更高版本。

3.6 新版功能.

os.urandom(size)

返回大小为 size 的字节串，它是适合加密使用的随机字节。

本函数从系统指定的随机源获取随机字节。对于加密应用程序，返回的数据应有足够的不可预测性，尽管其确切的品质取决于操作系统的实现。

在 Linux 上，如果 getrandom() 系统调用可用，它将以阻塞模式使用：阻塞直到系统的 urandom 熵池初始化完毕（内核收集了 128 位熵）。原理请参阅 PEP 524 [https://www.python.org/dev/peps/pep-0524]。在 Linux 上，getrandom() 可以以非阻塞模式（使用 GRND_NONBLOCK 标志）获取随机字节，或者轮询直到系统的 urandom 熵池初始化完毕。

在类 Unix 系统上，随机字节是从 /dev/urandom 设备读取的。如果 /dev/urandom 设备不可用或不可读，则抛出 NotImplementedError 异常。

在 Windows 上将使用 CryptGenRandom()。

参见

secrets 模块提供了更高级的功能。所在平台会提供随机数生成器，有关其易于使用的接口，请参阅 random.SystemRandom。

在 3.6.0 版更改: 在 Linux 上，getrandom() 现在以阻塞模式使用，以提高安全性。

在 3.5.2 版更改: 在 Linux 上，如果 getrandom() 系统调用阻塞（urandom 熵池尚未初始化完毕），则退回一步读取 /dev/urandom。

在 3.5 版更改: 在 Linux 3.17 和更高版本上，现在使用 getrandom() 系统调用（如果可用）。在 OpenBSD 5.6 和更高版本上，现在使用 getentropy() C 函数。这些函数避免了使用内部文件描述符。

os.GRND_NONBLOCK

默认情况下，从 /dev/random 读取时，如果没有可用的随机字节，则 getrandom() 会阻塞；从 /dev/urandom 读取时，如果熵池尚未初始化，则会阻塞。

如果设置了 GRND_NONBLOCK 标志，则这些情况下 getrandom() 不会阻塞，而是立即抛出 BlockingIOError 异常。

3.6 新版功能.

os.GRND_RANDOM

如果设置了此标志位，那么将从 /dev/random 池而不是 /dev/urandom 池中提取随机字节。

3.6 新版功能.

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

源代码: Lib/io.py [https://github.com/python/cpython/tree/3.10/Lib/io.py]

概述

io 模块提供了 Python 用于处理各种 I/O 类型的主要工具。三种主要的 I/O类型分别为: 文本 I/O, 二进制 I/O 和 原始 I/O。这些是泛型类型，有很多种后端存储可以用在他们上面。一个隶属于任何这些类型的具体对象被称作 file object。 其他同类的术语还有 流 和 类文件对象。

独立于其类别，每个具体流对象也将具有各种功能：它可以是只读，只写或读写。它还可以允许任意随机访问（向前或向后寻找任何位置），或仅允许顺序访问（例如在套接字或管道的情况下）。

所有流对提供给它们的数据类型都很敏感。例如将 str 对象给二进制流的 write() 方法会引发 TypeError。将 bytes 对象提供给文本流的 write() 方法也是如此。

在 3.3 版更改: 由于 IOError 现在是 OSError 的别名，因此用于引发 IOError 的操作现在会引发 OSError 。

文本 I/O

文本I/O预期并生成 str 对象。这意味着，无论何时后台存储是由字节组成的（例如在文件的情况下），数据的编码和解码都是透明的，并且可以选择转换特定于平台的换行符。

创建文本流的最简单方法是使用 open()，可以选择指定编码：

f = open("myfile.txt", "r", encoding="utf-8")

内存中文本流也可以作为 StringIO 对象使用：

f = io.StringIO("some initial text data")

TextIOBase 的文档中详细描述了文本流的API

二进制 I/O

二进制I/O（也称为缓冲I/O）预期 bytes-like objects 并生成 bytes 对象。不执行编码、解码或换行转换。这种类型的流可以用于所有类型的非文本数据，并且还可以在需要手动控制文本数据的处理时使用。

创建二进制流的最简单方法是使用 open()，并在模式字符串中指定 'b' ：

f = open("myfile.jpg", "rb")

内存中二进制流也可以作为 BytesIO 对象使用：

f = io.BytesIO(b"some initial binary data: \x00\x01")

BufferedIOBase 的文档中详细描述了二进制流 API。

其他库模块可以提供额外的方式来创建文本或二进制流。参见 socket.socket.makefile() 的示例。

原始 I/O

原始 I/O（也称为 非缓冲 I/O）通常用作二进制和文本流的低级构建块。用户代码直接操作原始流的用法非常罕见。不过，可以通过在禁用缓冲的情况下以二进制模式打开文件来创建原始流：

f = open("myfile.jpg", "rb", buffering=0)

RawIOBase 的文档中详细描述了原始流的API

文本编码格式

TextIOWrapper 和 open() 的默认编码格式取决于语言区域设置 (locale.getpreferredencoding(False)).

但是，很多开发者在打开以 UTF-8 编码的文本文件 (例如 JSON, TOML, Markdown 等等...) 时会忘记指定编码格式，因为大多数 Unix 平台默认使用 UTF-8 语言区域。 这会导致各种错误因为大多数 Windows 用户的语言区域编码格式并不是 UTF-8。 例如:

# May not work on Windows when non-ASCII characters in the file.
with open("README.md") as f:
    long_description = f.read()

此外，虽然暂时还没有确定的计划，但 Python 可能会在未来将默认的文本文件编码格式改为 UTF-8。

为此，强烈建议你在打开文本文件时显式地指定编码格式。 如果你想要使用 UTF-8，请传入 encoding="utf-8"。 要使用当前语言区域的编码格式，encoding="locale" 已在 Python 3.10 中被支持。

当你需要在 Windows 上运行尝试使用默认语言区域的编码格式打开使用 UTF-8 的文件的现有代码时，你可以启动 UTF-8 模式。 参见 Windows 上的 UTF-8 模式。

选择性的 EncodingWarning

3.10 新版功能: 请参阅 PEP 597 [https://www.python.org/dev/peps/pep-0597] 了解详情。

要找出哪里使用了默认语言区域的编码格式，你可以启用 -X warn_default_encoding 命令行选项或设置 PYTHONWARNDEFAULTENCODING 环境变量，这将在使用默认编码格式时发出 EncodingWarning。

如果你提供了使用 open() 或 TextIOWrapper 的 API 并将 encoding=None 作为形参传入，你可以使用 text_encoding() 以便 API 的调用方在没有传入 encoding 的时候将发出 EncodingWarning。 但是，对于新的 API 请考虑默认就使用 UTF-8 (即 encoding="utf-8")。

高阶模块接口

io.DEFAULT_BUFFER_SIZE

包含模块缓冲 I/O 类使用的默认缓冲区大小的 int。 在可能的情况下 open() 将使用文件的 blksize（由 os.stat() 获得）。

io.open(file, mode='r', buffering=- 1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

这是内置的 open() 函数的别名。

引发一个 审计事件 open 并附带参数 path, mode, flags。

io.open_code(path)

以 'rb' 模式打开提供的文件。如果目的是将文件内容做为可执行代码，则应使用此函数。

path 应当为 str 类型并且是一个绝对路径。

此函数的行为可以由对 PyFile_SetOpenCodeHook() 的先期调用所重载。 但是，如果 path 为 str 类型并且是一个绝对路径，open_code(path) 的行为应当总是与 open(path, 'rb') 一致。 重载此行为的目的是为了给文件附加额外的验证或预处理。

3.8 新版功能.

io.text_encoding(encoding, stacklevel=2, /)

这是一个针对使用 open() 或 TextIOWrapper 的可调用对象的辅助函数并且具有 encoding=None 形参。

此函数会返回 encoding，如果它不为 None 的话，或是 "locale" ，如果 encoding 为 None 的话。

如果 sys.flags.warn_default_encoding 为真值并且 encoding 为 None 则此函数会发出 EncodingWarning。 stacklevel 指定在哪里发出警告。 例如:

def read_text(path, encoding=None):
    encoding = io.text_encoding(encoding)  # stacklevel=2
    with open(path, encoding) as f:
        return f.read()

在这个例子中，将为 read_text() 的调用方发出 EncodingWarning。

请参阅 文本编码格式 了解更多信息。

3.10 新版功能.

exception io.BlockingIOError

这是内置的 BlockingIOError 异常的兼容性别名。

exception io.UnsupportedOperation

在流上调用不支持的操作时引发的继承 OSError 和 ValueError 的异常。

参见

sys

包含标准IO流: sys.stdin, sys.stdout 和 sys.stderr 。

类的层次结构

I/O 流被安排为按类的层次结构实现。 首先是 抽象基类 (ABC)，用于指定流的各种类别，然后是提供标准流实现的具体类。

注解

抽象基类还提供某些方法的默认实现，以帮助实现具体的流类。例如 BufferedIOBase 提供了 readinto() 和 readline() 的未优化实现。

I/O层次结构的顶部是抽象基类 IOBase 。它定义了流的基本接口。但是请注意，对流的读取和写入之间没有分离。如果实现不支持指定的操作，则会引发 UnsupportedOperation 。

抽象基类 RawIOBase 是 IOBase 的子类。它负责将字节读取和写入流中。 RawIOBase 的子类 FileIO 提供计算机文件系统中文件的接口。

抽象基类 BufferedIOBase 扩展了 IOBase。 它能处理原始二进制流 (RawIOBase) 上的缓冲。 它的子类 BufferedWriter, BufferedReader 和 BufferedRWPair 分别缓冲可写、可读以及同时可读写的原始二进制流。 BufferedRandom 提供了带缓冲的可随机访问接口。 BufferedIOBase 的另一子类 BytesIO 是内存中字节流。

抽象基类 TextIOBase 继承了 IOBase 。它处理可表示文本的流，并处理字符串的编码和解码。类 TextIOWrapper 继承了 TextIOBase ，是原始缓冲流（ BufferedIOBase ）的缓冲文本接口。最后， StringIO 是文本的内存流。

参数名不是规范的一部分，只有 open() 的参数才用作关键字参数。

下表总结了抽象基类提供的 io 模块：

抽象基类 | 继承 | 抽象方法 | Mixin方法和属性
IOBase |  | fileno, seek, 和 truncate | close, closed, __enter__, __exit__, flush, isatty, __iter__, __next__, readable, readline, readlines, seekable, tell, writable 和 writelines
RawIOBase | IOBase | readinto 和 write | 继承 IOBase 方法, read, 和 readall
BufferedIOBase | IOBase | detach, read, read1, 和 write | 继承 IOBase 方法, readinto, 和 readinto1
TextIOBase | IOBase | detach, read, readline, 和 write | 继承 IOBase 方法, encoding, errors, 和 newlines

I/O 基类

class io.IOBase

所有 I/O 类的抽象基类。

此类为许多方法提供了空的抽象实现，派生类可以有选择地重写。默认实现代表一个无法读取、写入或查找的文件。

尽管 IOBase 没有声明 read() 或 write() ，因为它们的签名会有所不同，但是实现和客户端应该将这些方法视为接口的一部分。此外，当调用不支持的操作时可能会引发 ValueError （或 UnsupportedOperation ）。

从文件读取或写入文件的二进制数据的基本类型为 bytes 。其他 bytes-like objects 也可以作为方法参数。文本I/O类使用 str 数据。

请注意，在关闭的流上调用任何方法（甚至查询）都是未定义的（undefined）。在这种情况下，实现可能会引发 ValueError 。

IOBase （及其子类）支持迭代器协议，这意味着可以迭代 IOBase 对象以产生流中的行。根据流是二进制流（产生字节）还是文本流（产生字符串），行的定义略有不同。请参见下面的 readline() 。

IOBase 也是一个上下文管理器，因此支持 with 语句。 在这个示例中，file 将在 with 语句块执行完成之后被关闭 --- 即使是发生了异常:

with open('spam.txt', 'w') as file:
    file.write('Spam and eggs!')

IOBase 提供以下数据属性和方法：

close()

刷新并关闭此流。如果文件已经关闭，则此方法无效。文件关闭后，对文件的任何操作（例如读取或写入）都会引发 ValueError 。

为方便起见，允许多次调用此方法。但是，只有第一个调用才会生效。

closed

如果流已关闭，则返回 True。

fileno()

返回流的底层文件描述符（整数）---如果存在。如果 IO 对象不使用文件描述符，则会引发 OSError 。

flush()

刷新流的写入缓冲区（如果适用）。这对只读和非阻塞流不起作用。

isatty()

如果流是交互式的（即连接到终端/tty设备），则返回 True 。

readable()

如果可以读取流，则返回 True 。否则为 False ，且 read() 将引发 OSError 错误。

readline(size=- 1, /)

从流中读取并返回一行。如果指定了 size，将至多读取 size 个字节。

对于二进制文件行结束符总是 b'\n'；对于文本文件，可以用将 newline 参数传给 open() 的方式来选择要识别的行结束符。

readlines(hint=- 1, /)

从流中读取并返回包含多行的列表。可以指定 hint 来控制要读取的行数：如果（以字节/字符数表示的）所有行的总大小超出了 hint 则将不会读取更多的行。

0 或更小的 hint 值以及 None，会被视为没有 hint。

请注意使用 for line in file: ... 就足够对文件对象进行迭代了，可以不必调用 file.readlines()。

seek(offset, whence=SEEK_SET, /)

将流位置修改到给定的字节 offset。 offset 将相对于由 whence 指定的位置进行解析。 whence 的默认值为 SEEK_SET。 whence 的可用值有：

SEEK_SET 或 0 -- 流的开头（默认值）；offset 应为零或正值

SEEK_CUR or 1 -- 当前流位置；offset 可以为负值

SEEK_END or 2 -- 流的末尾；offset 通常为负值

返回新的绝对位置。

3.1 新版功能: SEEK_* 常量.

3.3 新版功能: 某些操作系统还可支持其他的值，例如 os.SEEK_HOLE 或 os.SEEK_DATA。特定文件的可用值还会取决于它是以文本还是二进制模式打开。

seekable()

如果流支持随机访问则返回 True。 如为 False，则 seek(), tell() 和 truncate() 将引发 OSError。

tell()

返回当前流的位置。

truncate(size=None, /)

将流的大小调整为给定的 size 个字节（如果未指定 size 则调整至当前位置）。 当前的流位置不变。 这个调整操作可扩展或减小当前文件大小。 在扩展的情况下，新文件区域的内容取决于具体平台（在大多数系统上，额外的字节会填充为零）。 返回新的文件大小。

在 3.5 版更改: 现在Windows在扩展时将文件填充为零。

writable()

如果流支持写入则返回 True。 如为 False，则 write() 和 truncate() 将引发 OSError。

writelines(lines, /)

将行列表写入到流。 不会添加行分隔符，因此通常所提供的每一行都带有末尾行分隔符。

__del__()

为对象销毁进行准备。 IOBase 提供了此方法的默认实现，该实现会调用实例的 close() 方法。

class io.RawIOBase

原始二进制流的基类。 它继承自 IOBase 。

原始二进制流通常会提供对下层 OS 设备或 API 的低层级访问，而不是尝试将其封装到高层级的基元中（此功能是在更高层级的缓冲二进制流和文本流中实现的，将在下文中描述）。

RawIOBase 在 IOBase 的现有成员以外还提供了下列方法:

read(size=- 1, /)

从对象中读取 size 个字节并将其返回。 作为一个便捷选项，如果 size 未指定或为 -1，则返回所有字节直到 EOF。 在其他情况下，仅会执行一次系统调用。 如果操作系统调用返回字节数少于 size 则此方法也可能返回少于 size 个字节。

如果返回 0 个字节而 size 不为零 0，这表明到达文件末尾。 如果处于非阻塞模式并且没有更多字节可用，则返回 None。

默认实现会转至 readall() 和 readinto()。

readall()

从流中读取并返回所有字节直到 EOF，如有必要将对流执行多次调用。

readinto(b, /)

将字节数据读入预先分配的可写 bytes-like object b，并返回所读取的字节数。 例如，b 可以是一个 bytearray。 如果对象处理非阻塞模式并且没有更多字节可用，则返回 None。

write(b, /)

将给定的 bytes-like object b 写入到下层的原始流，并返回所写入的字节数。 这可以少于 b 的总字节数，具体取决于下层原始流的设定，特别是如果它处于非阻塞模式的话。 如果原始流设为非阻塞并且不能真正向其写入单个字节时则返回 None。 调用者可以在此方法返回后释放或改变 b，因此该实现应该仅在方法调用期间访问 b。

class io.BufferedIOBase

支持某种缓冲的二进制流的基类。 它继承自 IOBase。

与 RawIOBase 的主要差别在于 read(), readinto() 和 write() 等方法将（分别）尝试按照要求读取尽可能多的输入或是耗尽所有给定的输出，其代价是可能会执行一次以上的系统调用。

除此之外，那些方法还可能引发 BlockingIOError，如果下层的原始数据流处于非阻塞模式并且无法接受或给出足够数据的话；不同于对应的 RawIOBase 方法，它们将永远不会返回 None。

并且，read() 方法也没有转向 readinto() 的默认实现。

典型的 BufferedIOBase 实现不应当继承自 RawIOBase 实现，而要包装一个该实现，正如 BufferedWriter 和 BufferedReader 所做的那样。

BufferedIOBase 在 IOBase 的现有成员以外还提供或重写了下列数据属性和方法:

raw

由 BufferedIOBase 处理的下层原始流 (RawIOBase 的实例)。 它不是 BufferedIOBase API 的组成部分并且不存在于某些实现中。

detach()

从缓冲区分离出下层原始流并将其返回。

在原始流被分离之后，缓冲区将处于不可用的状态。

某些缓冲区例如 BytesIO 并无可从此方法返回的单独原始流的概念。 它们将会引发 UnsupportedOperation。

3.1 新版功能.

read(size=- 1, /)

读取并返回最多 size 个字节。 如果此参数被省略、为 None 或为负值，则读取并返回所有数据直到 EOF。 如果流已经到达 EOF 则返回一个空的 bytes 对象。

如果此参数为正值，并且下层原始流不可交互，则可能发起多个原始读取以满足字节计数（直至先遇到 EOF）。 但对于可交互原始流，则将至多发起一个原始读取，并且简短的结果并不意味着已到达 EOF。

BlockingIOError 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。

read1(size=- 1, /)

通过至多一次对下层流的 read() (或 readinto()) 方法的调用读取并返回至多 size 个字节。 这适用于在 BufferedIOBase 对象之上实现你自己的缓冲区的情况。

如果 size 为 -1 (默认值)，则返回任意数量的字节（多于零字节，除非已到达 EOF）。

readinto(b, /)

将字节数据读入预先分配的可写 bytes-like object b 并返回所读取的字节数。 例如，b 可以是一个 bytearray。

类似于 read()，可能对下层原始流发起多次读取，除非后者为交互式。

BlockingIOError 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。

readinto1(b, /)

将字节数据读入预先分配的可写 bytes-like object b，其中至多使用一次对下层原始流 read() (或 readinto()) 方法的调用。 返回所读取的字节数。

BlockingIOError 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。

3.5 新版功能.

write(b, /)

写入给定的 bytes-like object b，并返回写入的字节数 (总是等于 b 的字节长度，因为如果写入失败则会引发 OSError)。 根据具体实现的不同，这些字节可能被实际写入下层流，或是出于运行效率和冗余等考虑而暂存于缓冲区。

当处于非阻塞模式时，如果需要将数据写入原始流但它无法在不阻塞的情况下接受所有数据则将引发 BlockingIOError。

调用者可能会在此方法返回后释放或改变 b，因此该实现应当仅在方法调用期间访问 b。

原始文件 I/O

class io.FileIO(name, mode='r', closefd=True, opener=None)

代表一个包含字节数据的 OS 层级文件的原始二进制流。 它继承自 RawIOBase。

name 可以是以下两项之一：

代表将被打开的文件路径的字符串或 bytes 对象。 在此情况下 closefd 必须为 True (默认值) 否则将会引发异常。

代表一个现有 OS 层级文件描述符的号码的整数，作为结果的 FileIO 对象将可访问该文件。 当 FileIO 对象被关闭时此 fd 也将被关闭，除非 closefd 设为 False。

mode 可以为 'r', 'w', 'x' 或 'a' 分别表示读取（默认模式）、写入、独占新建或添加。 如果以写入或添加模式打开的文件不存在将自动新建；当以写入模式打开时文件将先清空。 以新建模式打开时如果文件已存在则将引发 FileExistsError。 以新建模式打开文件也意味着要写入，因此该模式的行为与 'w' 类似。 在模式中附带 '+' 将允许同时读取和写入。

该类的 read() (当附带正值参数调用时), readinto() 和 write() 方法将只执行一次系统调用。

可以通过传入一个可调用对象作为 opener 来使用自定义文件打开器。 然后通过调用 opener 并传入 (name, flags) 来获取文件对象所对应的下层文件描述符。 opener 必须返回一个打开文件描述符（传入 os.open 作为 opener 的结果在功能上将与传入 None 类似）。

新创建的文件是 不可继承的。

有关 opener 参数的示例，请参见内置函数 open() 。

在 3.3 版更改: 增加了 opener 参数。增加了 'x' 模式。

在 3.4 版更改: 文件现在禁止继承。

FileIO 在继承自 RawIOBase 和 IOBase 的现有成员以外还提供了以下数据属性和方法:

mode

构造函数中给定的模式。

name

文件名。当构造函数中没有给定名称时，这是文件的文件描述符。

缓冲流

相比原始 I/O，缓冲 I/O 流提供了针对 I/O 设备的更高层级接口。

class io.BytesIO(initial_bytes=b'')

一个使用内在字节缓冲区的二进制流。 它继承自 BufferedIOBase。 在 close() 方法被调用时将会丢弃缓冲区。

可选参数 initial_bytes 是一个包含初始数据的 bytes-like object。

BytesIO 在继承自 BufferedIOBase 和 IOBase 的成员以外还提供或重写了下列方法:

getbuffer()

返回一个对应于缓冲区内容的可读写视图而不必拷贝其数据。 此外，改变视图将透明地更新缓冲区内容:

>>> b = io.BytesIO(b"abcdef")
>>> view = b.getbuffer()
>>> view[2:4] = b"56"
>>> b.getvalue()
b'ab56ef'

注解

只要视图保持存在，BytesIO 对象就无法被改变大小或关闭。

3.2 新版功能.

getvalue()

返回包含整个缓冲区内容的 bytes。

read1(size=- 1, /)

在 BytesIO 中，这与 read() 相同。

在 3.7 版更改: size 参数现在是可选的。

readinto1(b, /)

在 BytesIO 中，这与 readinto() 相同。

3.5 新版功能.

class io.BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)

一个提供对可读、不可查找的 RawIOBase 原始二进制流的高层级访问的缓冲二进制流。 它继承自 BufferedIOBase。

当从此对象读取数据时，可能会从下层原始流请求更大量的数据，并存放到内部缓冲区中。 接下来可以在后续读取时直接返回缓冲数据。

根据给定的可读 raw 流和 buffer_size 创建 BufferedReader 的构造器。 如果省略 buffer_size，则会使用 DEFAULT_BUFFER_SIZE。

BufferedReader 在继承自 BufferedIOBase 和 IOBase 的成员以外还提供或重写了下列方法:

peek(size=0, /)

从流返回字节数据而不前移位置。 完成此调用将至多读取一次原始流。 返回的字节数量可能少于或多于请求的数量。

read(size=- 1, /)

读取并返回 size 个字节，如果 size 未给定或为负值，则读取至 EOF 或是在非阻塞模式下读取调用将会阻塞。

read1(size=- 1, /)

在原始流上通过单次调用读取并返回至多 size 个字节。 如果至少缓冲了一个字节，则只返回缓冲的字节。 在其他情况下，将执行一次原始流读取。

在 3.7 版更改: size 参数现在是可选的。

class io.BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)

一个提供对可写、不可查找的 RawIOBase 原始二进制流的高层级访问的缓冲二进制流。 它继承自 BufferedIOBase。

当写入到此对象时，数据通常会被放入到内部缓冲区中。 缓冲区将在满足某些条件的情况下被写到下层的 RawIOBase 对象，包括:

当缓冲区对于所有挂起数据而言太小时；

当 flush() 被调用时

当（为 BufferedRandom 对象）请求 seek() 时；

当 BufferedWriter 对象被关闭或销毁时。

该构造器会为给定的可写 raw 流创建一个 BufferedWriter。 如果未给定 buffer_size，则使用默认的 DEFAULT_BUFFER_SIZE。

BufferedWriter 在继承自 BufferedIOBase 和 IOBase 的成员以外还提供或重写了下列方法:

flush()

将缓冲区中保存的字节数据强制放入原始流。 如果原始流发生阻塞则应当引发 BlockingIOError。

write(b, /)

写入 bytes-like object b 并返回写入的字节数。 当处于非阻塞模式时，如果缓冲区需要被写入但原始流发生阻塞则将引发 BlockingIOError。

class io.BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)

一个提供对不可查找的 RawIOBase 原始二进制流的高层级访问的缓冲二进制流。 它继承自 BufferedReader 和 BufferedWriter。

该构造器会为在第一个参数中给定的可查找原始流创建一个读取器和写入器。 如果省略 buffer_size 则使用默认的 DEFAULT_BUFFER_SIZE。

BufferedRandom 能做到 BufferedReader 或 BufferedWriter 所能做的任何事。 此外，还会确保实现 seek() 和 tell()。

class io.BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE, /)

一个提供对两个不可查找的 RawIOBase 原始二进制流的高层级访问的缓冲二进制流 --- 一个可读，另一个可写。 它继承自 BufferedIOBase。

reader 和 writer 分别是可读和可写的 RawIOBase 对象。 如果省略 buffer_size 则使用默认的 DEFAULT_BUFFER_SIZE。

BufferedRWPair 实现了 BufferedIOBase 的所有方法，但 detach() 除外，调用该方法将引发 UnsupportedOperation。

警告

BufferedRWPair 不会尝试同步访问其下层的原始流。 你不应当将传给它与读取器和写入器相同的对象；而要改用 BufferedRandom。

文本 I/O

class io.TextIOBase

文本流的基类。 该类提供了基于字符和行的流 I/O 接口。 它继承自 IOBase。

TextIOBase 在来自 IOBase 的成员以外还提供或重写了以下数据属性和方法:

encoding

用于将流的字节串解码为字符串以及将字符串编码为字节串的编码格式名称。

errors

解码器或编码器的错误设置。

newlines

一个字符串、字符串元组或者 None，表示目前已经转写的新行。 根据具体实现和初始构造器旗标的不同，此属性或许会不可用。

buffer

由 TextIOBase 处理的下层二进制缓冲区（为一个 BufferedIOBase 的实例）。 它不是 TextIOBase API 的组成部分并且不存在于某些实现中。

detach()

从 TextIOBase 分离出下层二进制缓冲区并将其返回。

在下层缓冲区被分离后，TextIOBase 将处于不可用的状态。

某些 TextIOBase 的实现，例如 StringIO 可能并无下层缓冲区的概念，因此调用此方法将引发 UnsupportedOperation。

3.1 新版功能.

read(size=- 1, /)

从流中读取至多 size 个字符并以单个 str 的形式返回。 如果 size 为负值或 None，则读取至 EOF。

readline(size=- 1, /)

读取至换行符或 EOF 并返回单个 str。 如果流已经到达 EOF，则将返回一个空字符串。

如果指定了 size ，最多将读取 size 个字符。

seek(offset, whence=SEEK_SET, /)

将流位置改为给定的偏移位置 offset。 具体行为取决于 whence 形参。 whence 的默认值为 SEEK_SET。

SEEK_SET 或 0: 从流的开始位置起查找（默认值）；offset 必须为 TextIOBase.tell() 所返回的数值或为零。 任何其他 offset 值都将导致未定义的行为。

SEEK_CUR 或 1: "查找" 到当前位置；offset 必须为零，表示无操作（所有其他值均不受支持）。

SEEK_END 或 2: 查找到流的末尾；offset 必须为零（所有其他值均不受支持）。

以不透明数字形式返回新的绝对位置。

3.1 新版功能: SEEK_* 常量.

tell()

以不透明数字形式返回当前流的位置。 该数字通常并不代表下层二进制存储中对应的字节数。

write(s, /)

将字符串 s 写入到流并返回写入的字符数。

class io.TextIOWrapper(buffer, encoding=None, errors=None, newline=None, line_buffering=False, write_through=False)

一个提供对 BufferedIOBase 缓冲二进制流的高层级访问的缓冲文本流。 它继承自 TextIOBase。

encoding 给出流的解码和编码将会使用的编码格式的名称。 它默认为 locale.getpreferredencoding(False)。 encoding="locale" 可被用来指定当前语言区域的编码格式。 请参阅 文本编码格式 了解更多信息。

errors 是一个可选的字符串，它指明编码格式和编码格式错误的处理方式。 传入 'strict' 将在出现编码格式错误时引发 ValueError (默认值 None 具有相同的效果)，传入 'ignore' 将忽略错误。 (请注意忽略编码格式错误会导致数据丢失。) 'replace' 会在出现错误数据时插入一个替换标记 (例如 '?')。 'backslashreplace' 将把错误数据替换为一个反斜杠转义序列。 在写入时，还可以使用 'xmlcharrefreplace' (替换为适当的 XML 字符引用) 或 'namereplace' (替换为 \N{...} 转义序列)。 任何其他通过 codecs.register_error() 注册的错误处理方式名称也可以被接受。

newline 控制行结束符处理方式。 它可以为 None, '', '\n', '\r' 和 '\r\n'。 其工作原理如下:

当从流读取输入时，如果 newline 为 None，则将启用 universal newlines 模式。 输入中的行结束符可以为 '\n', '\r' 或 '\r\n'，在返回给调用者之前它们会被统一转写为 '\n'。 如果 newline 为 ''，也会启用通用换行模式，但行结束符会不加转写即返回给调用者。 如果 newline 具有任何其他合法的值，则输入行将仅由给定的字符串结束，并且行结束符会不加转写即返回给调用者。

将输出写入流时，如果 newline 为 None，则写入的任何 '\n' 字符都将转换为系统默认行分隔符 os.linesep。如果 newline 是 '' 或 '\n'，则不进行翻译。如果 newline 是任何其他合法值，则写入的任何 '\n' 字符将被转换为给定的字符串。

如果 line_buffering 为 True，则当一个写入调用包含换行符或回车时将会应用 flush()。

如果 write_through 为 True，对 write() 的调用会确保不被缓冲：在 TextIOWrapper 对象上写入的任何数据会立即交给其下层的 buffer 来处理。

在 3.3 版更改: 已添加 write_through 参数

在 3.3 版更改: 默认的 encoding 现在将为 locale.getpreferredencoding(False) 而非 locale.getpreferredencoding()。 不要使用 locale.setlocale() 来临时改变区域编码格式，要使用当前区域编码格式而不是用户的首选编码格式。

在 3.10 版更改: encoding 参数现在支持 "locale" 作为编码格式名称。

TextIOWrapper 在继承自 TextIOBase 和 IOBase 的现有成员以外还提供了以下数据属性和方法:

line_buffering

是否启用行缓冲。

write_through

写入是否要立即传给下层的二进制缓冲。

3.7 新版功能.

reconfigure(*, encoding=None, errors=None, newline=None, line_buffering=None, write_through=None)

使用 encoding, errors, newline, line_buffering 和 write_through 的新设置来重新配置此文本流。

未指定的形参将保留当前设定，例外情况是当指定了 encoding 但未指定 errors 时将会使用 errors='strict'。

如果已经有数据从流中被读取则将无法再改变编码格式或行结束符。 另一方面，在写入数据之后再改变编码格式则是可以的。

此方法会在设置新的形参之前执行隐式的流刷新。

3.7 新版功能.

class io.StringIO(initial_value='', newline='\n')

一个使用内存文本缓冲的文本流。 它继承自 TextIOBase。

当 close() 方法被调用时将会丢弃文本缓冲区。

缓冲区的初始值可通过提供 initial_value 来设置。 如果启用了行结束符转写，换行将以 write() 所用的方式被编码。 数据流位置将被设为缓冲区的开头。

newline 参数的规则与 TextIOWrapper 所用的一致，不同之处在于当将输出写入到流时，如果 newline 为 None，则在所有平台上换行符都会被写入为 \n。

StringIO 在继承自 TextIOBase 和 IOBase 的现有成员以外还提供了以下方法:

getvalue()

返回一个包含缓冲区全部内容的 str。 换行符会以与 read() 相同的方式被编码，但是流的位置不会被改变。

用法示例:

import io

output = io.StringIO()
output.write('First line.\n')
print('Second line.', file=output)

# Retrieve file contents -- this will be
# 'First line.\nSecond line.\n'
contents = output.getvalue()

# Close object and discard memory buffer --
# .getvalue() will now raise an exception.
output.close()

class io.IncrementalNewlineDecoder

用于在 universal newlines 模式下解码换行符的辅助编解码器。 它继承自 codecs.IncrementalDecoder。

性能

本节讨论所提供的具体 I/O 实现的性能。

二进制 I/O

即使在用户请求单个字节时，也只读取和写入大块数据。通过该方法，缓冲 I/O 隐藏了操作系统调用和执行无缓冲 I/O 例程时的任何低效性。增益取决于操作系统和执行的 I/O 类型。例如，在某些现代操作系统上（例如 Linux），无缓冲磁盘 I/O 可以与缓冲 I/O 一样快。但最重要的是，无论平台和支持设备如何，缓冲 I/O 都能提供可预测的性能。因此，对于二进制数据，应首选使用缓冲的 I/O 而不是未缓冲的 I/O 。

文本 I/O

二进制存储（如文件）上的文本 I/O 比同一存储上的二进制 I/O 慢得多，因为它需要使用字符编解码器在Unicode和二进制数据之间进行转换。这在处理大量文本数据（如大型日志文件）时会变得非常明显。此外，由于使用的重构算法 TextIOWrapper.tell() 和 TextIOWrapper.seek() 都相当慢。

StringIO 是原生的内存 Unicode 容器，速度与 BytesIO 相似。

多线程

FileIO 对象是线程安全的，只要它们封装的操作系统调用（比如Unix下的 read(2) ）也是线程安全的。

二进制缓冲对象（例如 BufferedReader, BufferedWriter, BufferedRandom 和 BufferedRWPair）使用锁来保护其内部结构；因此，可以安全地一次从多个线程中调用它们。

TextIOWrapper 对象不再是线程安全的。

可重入性

二进制缓冲对象（ BufferedReader ， BufferedWriter ， BufferedRandom 和 BufferedRWPair 的实例）不是可重入的。虽然在正常情况下不会发生可重入调用，但仍可能会在 signal 处理程序执行 I/O 时产生。如果线程尝试重入已经访问的缓冲对象，则会引发 RuntimeError 。注意，这并不禁止其他线程进入缓冲对象。

上面的内容隐式地扩展到文本文件中，因为 open() 函数将把缓冲对象封装在 TextIOWrapper 中。 这包括标准流，因而也会影响内置的 print() 函数。

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

该模块提供了各种与时间相关的函数。相关功能还可以参阅 datetime 和 calendar 模块。

尽管所有平台皆可使用此模块，但模块内的函数并非所有平台都可用。此模块中定义的大多数函数的实现都是调用其所在平台的C语言库的同名函数。因为这些函数的语义可能因平台而异，所以使用时最好查阅对应平台的相关文档。

下面是一些术语和惯例的解释.

epoch 是时间开始的点，其值取决于平台。对于Unix， epoch 是1970年1月1日00:00:00（UTC）。要找出给定平台上的 epoch ，请查看 time.gmtime(0) 。

术语 纪元秒数 是指自 epoch （纪元）时间点以来经过的总秒数，通常不包括 闰秒 [https://en.wikipedia.org/wiki/Leap_second]。 在所有符合 POSIX 标准的平台上，闰秒都不会记录在总秒数中。

此模块中的函数可能无法处理纪元之前或遥远未来的日期和时间。“遥远未来”的定义由对应的C语言库决定；对于32位系统，它通常是指2038年及以后。

函数 strptime() 在接收到 %y 格式代码时可以解析使用 2 位数表示的年份。当解析 2 位数年份时，函数会按照 POSIX 和 ISO C 标准进行年份转换：数值 69--99 被映射为 1969--1999；数值 0--68 被映射为 2000--2068。

UTC是协调世界时（Coordinated Universal Time）的缩写。它以前也被称为格林威治标准时间（GMT）。使用UTC而不是CUT作为缩写是英语与法语（Temps Universel Coordonné）之间妥协的结果，不是什么低级错误。

DST是夏令时（Daylight Saving Time）的缩写，在一年的某一段时间中将当地时间调整（通常）一小时。 DST的规则非常神奇（由当地法律确定），并且每年的起止时间都不同。C语言库中有一个表格，记录了各地的夏令时规则（实际上，为了灵活性，C语言库通常是从某个系统文件中读取这张表）。从这个角度而言，这张表是夏令时规则的唯一权威真理。

由于平台限制，各种实时函数的精度可能低于其值或参数所要求（或给定）的精度。例如，在大多数Unix系统上，时钟频率仅为每秒50或100次。

另一方面， time() 和 sleep() 的精度优于它们的Unix等价物：时间表示为浮点数，time() 返回最准确的时间 （使用Unix gettimeofday() 如果可用），并且 sleep() 将接受非零分数的时间（Unix select() 用于实现此功能，如果可用）。

时间值由 gmtime()，localtime() 和 strptime() 返回，并被 asctime()， mktime() 和 strftime() 接受，是一个 9 个整数的序列。 gmtime()， localtime() 和 strptime() 的返回值还提供各个字段的属性名称。

请参阅 struct_time 以获取这些对象的描述。

在 3.3 版更改: 在平台支持相应的 struct tm 成员时，struct_time 类型被扩展提供 tm_gmtoff 和 tm_zone 属性。

在 3.6 版更改: struct_time 的属性 tm_gmtoff 和 tm_zone 现在可在所有平台上使用。

使用以下函数在时间表示之间进行转换：

从 | 到 | 使用
自纪元以来的秒数 | UTC 的 struct_time | gmtime()
自纪元以来的秒数 | 本地时间的 struct_time | localtime()
UTC 的 struct_time | 自纪元以来的秒数 | calendar.timegm()
本地时间的 struct_time | 自纪元以来的秒数 | mktime()

函数

time.asctime([t])

转换由 gmtime() 或 localtime() 所返回的 struct_time 或相应的表示时间的元组为以下形式的字符串: 'Sun Jun 20 23:21:05 1993'。 日期字段的长度为两个字符，如果日期只有一个数字则会以空格填充，例如: 'Wed Jun  9 04:26:40 1993'。

如果未提供 t，则会使用 localtime() 所返回的当前时间。 asctime() 不会使用区域设置信息。

注解

与同名的C函数不同， asctime() 不添加尾随换行符。

time.pthread_getcpuclockid(thread_id)

返回指定的 thread_id 的特定于线程的CPU时间时钟的 clk_id 。

使用 threading.Thread 对象的 threading.get_ident() 或 ident 属性为 thread_id 获取合适的值。

警告

传递无效的或过期的 thread_id 可能会导致未定义的行为，例如段错误。

可用性 ： Unix（有关详细信息，请参见 pthread_getcpuclockid(3) 的手册页）。

3.7 新版功能.

time.clock_getres(clk_id)

返回指定时钟 clk_id 的分辨率（精度）。有关 clk_id 的可接受值列表，请参阅 Clock ID 常量 。

可用性: Unix。

3.3 新版功能.

time.clock_gettime(clk_id) → float

返回指定 clk_id 时钟的时间。有关 clk_id 的可接受值列表，请参阅 Clock ID 常量 。

使用 clock_gettime_ns() 以避免 float 类型导致的精度损失。

可用性: Unix。

3.3 新版功能.

time.clock_gettime_ns(clk_id) → int

与 clock_gettime() 相似，但返回时间为纳秒。

可用性: Unix。

3.7 新版功能.

time.clock_settime(clk_id, time: float)

设置指定 clk_id 时钟的时间。 目前， CLOCK_REALTIME 是 clk_id 唯一可接受的值。

使用 clock_settime_ns() 以避免 float 类型导致的精度损失。

可用性: Unix。

3.3 新版功能.

time.clock_settime_ns(clk_id, time: int)

与 clock_settime() 相似，但设置时间为纳秒。

可用性: Unix。

3.7 新版功能.

time.ctime([secs])

转换以距离初始纪元的秒数表示的时间为以下形式的字符串: 'Sun Jun 20 23:21:05 1993' 代表本地时间。 日期字段的长度为两个字符，如果日期只有一个数字则会以零填充，例如: 'Wed Jun  9 04:26:40 1993'。

如果 secs 未提供或为 None，则使用 time() 所返回的当前时间。 ctime(secs) 等价于 asctime(localtime(secs))。 ctime() 不会使用区域设置信息。

time.get_clock_info(name)

获取有关指定时钟的信息作为命名空间对象。 支持的时钟名称和读取其值的相应函数是：

'monotonic': time.monotonic()

'perf_counter': time.perf_counter()

'process_time': time.process_time()

'thread_time': time.thread_time()

'time': time.time()

结果具有以下属性：

adjustable ： 如果时钟可以自动更改（例如通过NTP守护程序）或由系统管理员手动更改，则为 True ，否则为 False 。

implementation ： 用于获取时钟值的基础C函数的名称。有关可能的值，请参阅 Clock ID 常量 。

monotonic ：如果时钟不能倒退，则为 True ，否则为 False 。

resolution ： 以秒为单位的时钟分辨率（ float ）

3.3 新版功能.

time.gmtime([secs])

将以自 epoch 开始的秒数表示的时间转换为 UTC 的 struct_time ，其中 dst 标志始终为零。 如果未提供 secs 或为 None ，则使用 time() 所返回的当前时间。 一秒以内的小数将被忽略。 有关 struct_time 对象的说明请参见上文。 有关此函数的逆操作请参阅 calendar.timegm()。

time.localtime([secs])

与 gmtime() 相似但转换为当地时间。如果未提供 secs 或为 None ，则使用由 time() 返回的当前时间。当 DST 适用于给定时间时，dst标志设置为 1 。

localtime() 可能会引发 OverflowError ，如果时间戳超出平台 C localtime() 或 gmtime() 函数支持的范围，并会在 localtime() 或 gmtime() 失败时引发 OSError 。这通常被限制在1970至2038年之间。

time.mktime(t)

这是 localtime() 的反函数。它的参数是 struct_time 或者完整的 9 元组（因为需要 dst 标志；如果它是未知的则使用 -1 作为dst标志），它表示 local 的时间，而不是 UTC 。它返回一个浮点数，以便与 time() 兼容。如果输入值不能表示为有效时间，则 OverflowError 或 ValueError 将被引发（这取决于Python或底层C库是否捕获到无效值）。它可以生成时间的最早日期取决于平台。

time.monotonic() → float

（以小数表示的秒为单位）返回一个单调时钟的值，即不能倒退的时钟。 该时钟不受系统时钟更新的影响。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

使用 monotonic_ns() 以避免 float 类型导致的精度损失。

3.3 新版功能.

在 3.5 版更改: 该功能现在始终可用且始终在系统范围内。

在 3.10 版更改: 在 macOS 上，现在这个函数作用于全系统。

time.monotonic_ns() → int

与 monotonic() 相似，但是返回时间为纳秒数。

3.7 新版功能.

time.perf_counter() → float

（以小数表示的秒为单位）返回一个性能计数器的值，即用于测量较短持续时间的具有最高有效精度的时钟。 它会包括睡眠状态所消耗的时间并且作用于全系统范围。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

使用 perf_counter_ns() 以避免 float 类型导致的精度损失。

3.3 新版功能.

在 3.10 版更改: 在 Windows 上，现在这个函数作用于全系统。

time.perf_counter_ns() → int

与 perf_counter() 相似，但是返回时间为纳秒。

3.7 新版功能.

time.process_time() → float

（以小数表示的秒为单位）返回当前进程的系统和用户 CPU 时间的总计值。 它不包括睡眠状态所消耗的时间。 根据定义它只作用于进程范围。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

使用 process_time_ns() 以避免 float 类型导致的精度损失。

3.3 新版功能.

time.process_time_ns() → int

与 process_time() 相似，但是返回时间为纳秒。

3.7 新版功能.

time.sleep(secs)

调用该方法的线程将被暂停执行 secs 秒。参数可以是浮点数，以表示更为精确的睡眠时长。由于任何捕获到的信号都会终止 sleep() 引发的该睡眠过程并开始执行信号的处理例程，因此实际的暂停时长可能小于请求的时长；此外，由于系统需要调度其他活动，实际暂停时长也可能比请求的时间长。

在 3.5 版更改: 现在，即使该睡眠过程被信号中断，该函数也会保证调用它的线程至少会睡眠 secs 秒。信号处理例程抛出异常的情况除外。（欲了解我们做出这次改变的原因，请参见 PEP 475 [https://www.python.org/dev/peps/pep-0475] ）

time.strftime(format[, t])

转换一个元组或 struct_time 表示的由 gmtime() 或 localtime() 返回的时间到由 format 参数指定的字符串。如果未提供 t ，则使用由 localtime() 返回的当前时间。 format 必须是一个字符串。如果 t 中的任何字段超出允许范围，则引发 ValueError 。

0是时间元组中任何位置的合法参数；如果它通常是非法的，则该值被强制改为正确的值。

以下指令可以嵌入 format 字符串中。它们显示时没有可选的字段宽度和精度规范，并被 strftime() 结果中的指示字符替换：

指令 | 含意 | 备注
%a | 本地化的缩写星期中每日的名称。 |
%A | 本地化的星期中每日的完整名称。 |
%b | 本地化的月缩写名称。 |
%B | 本地化的月完整名称。 |
%c | 本地化的适当日期和时间表示。 |
%d | 十进制数 [01,31] 表示的月中日。 |
%H | 十进制数 [00,23] 表示的小时（24小时制）。 |
%I | 十进制数 [01,12] 表示的小时（12小时制）。 |
%j | 十进制数 [001,366] 表示的年中日。 |
%m | 十进制数 [01,12] 表示的月。 |
%M | 十进制数 [00,59] 表示的分钟。 |
%p | 本地化的 AM 或 PM 。 | (1)
%S | 十进制数 [00,61] 表示的秒。 | (2)
%U | 十进制数 [00,53] 表示的一年中的周数（星期日作为一周的第一天）。 在第一个星期日之前的新年中的所有日子都被认为是在第 0 周。 | (3)
%w | 十进制数 [0(星期日),6] 表示的周中日。 |
%W | 十进制数 [00,53] 表示的一年中的周数（星期一作为一周的第一天）。 在第一个星期一之前的新年中的所有日子被认为是在第 0 周。 | (3)
%x | 本地化的适当日期表示。 |
%X | 本地化的适当时间表示。 |
%y | 十进制数 [00,99] 表示的没有世纪的年份。 |
%Y | 十进制数表示的带世纪的年份。 |
%z | 时区偏移以格式 +HHMM 或 -HHMM 形式的 UTC/GMT 的正或负时差指示，其中H表示十进制小时数字，M表示小数分钟数字 [-23:59, +23:59] 。1 |
%Z | 时区名称（如果不存在时区，则不包含字符）。已弃用。 1 |
%% | 字面的 '%' 字符。 |

注释：

当与 strptime() 函数一起使用时，如果使用 %I 指令来解析小时， %p 指令只影响输出小时字段。

范围真的是 0 到 61 ；值 60 在表示 leap seconds [https://en.wikipedia.org/wiki/Leap_second] 的时间戳中有效，并且由于历史原因支持值 61 。

当与 strptime() 函数一起使用时， %U 和 %W 仅用于指定星期几和年份的计算。

下面是一个示例，一个与 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] Internet电子邮件标准以兼容的日期格式。 1

>>> from time import gmtime, strftime
>>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
'Thu, 28 Jun 2001 14:17:15 +0000'

某些平台可能支持其他指令，但只有此处列出的指令具有 ANSI C 标准化的含义。要查看平台支持的完整格式代码集，请参阅 strftime(3) 文档。

在某些平台上，可选的字段宽度和精度规范可以按照以下顺序紧跟在指令的初始 '%' 之后；这也不可移植。字段宽度通常为2，除了 %j ，它是3。

time.strptime(string[, format])

根据格式解析表示时间的字符串。 返回值为一个被 gmtime() 或 localtime() 返回的 struct_time 。

format 参数使用与 strftime() 相同的指令。 它默认为匹配 ctime() 所返回的格式 "%a %b %d %H:%M:%S %Y"` 。 如果 string 不能根据 format 来解析，或者解析后它有多余的数据，则会引发 ValueError。 当无法推断出更准确的值时，用于填充任何缺失数据的默认值是 (1900, 1, 1, 0, 0, 0, 0, 1, -1) 。 string 和 format 都必须为字符串。

例如:

>>> 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)

支持 %Z 指令是基于 tzname 中包含的值以及 daylight 是否为真。因此，它是特定于平台的，除了识别始终已知的 UTC 和 GMT （并且被认为是非夏令时时区）。

仅支持文档中指定的指令。因为每个平台都实现了 strftime() ，它有时会提供比列出的指令更多的指令。但是 strptime() 独立于任何平台，因此不一定支持所有未记录为支持的可用指令。

class time.struct_time

返回的时间值序列的类型为 gmtime() 、 localtime() 和 strptime() 。它是一个带有 named tuple 接口的对象：可以通过索引和属性名访问值。 存在以下值：

索引 | 属性 | 值
0 | tm_year | （例如，1993）
1 | tm_mon | range [1, 12]
2 | tm_mday | range [1, 31]
3 | tm_hour | range [0, 23]
4 | tm_min | range [0, 59]
5 | tm_sec | range [0, 61]； 见 strftime() 介绍中的 (2)
6 | tm_wday | range [0, 6] ，周一为 0
7 | tm_yday | range [1, 366]
8 | tm_isdst | 0, 1 或 -1；如下所示
N/A | tm_zone | 时区名称的缩写
N/A | tm_gmtoff | 以秒为单位的UTC以东偏离

请注意，与C结构不同，月份值是 [1,12] 的范围，而不是 [0,11] 。

在调用 mktime() 时， tm_isdst 可以在夏令时生效时设置为1，而在夏令时不生效时设置为0。 值-1表示这是未知的，并且通常会导致填写正确的状态。

当一个长度不正确的元组被传递给期望 struct_time 的函数，或者具有错误类型的元素时，会引发 TypeError 。

time.time() → float

返回以浮点数表示的从 epoch 开始的秒数的时间值。 epoch 的具体日期和 leap seconds [https://en.wikipedia.org/wiki/Leap_second] 的处理取决于平台。 在 Windows 和大多数 Unix 系统中， epoch 是 1970 年 1 月 1 日 00:00:00 (UTC)，并且闰秒将不计入从 epoch 开始的秒数。 这通常被称为 Unix 时间 [https://en.wikipedia.org/wiki/Unix_time]。 要了解给定平台上 epoch 的具体定义，请查看 gmtime(0)。

请注意，即使时间总是作为浮点数返回，但并非所有系统都提供高于1秒的精度。虽然此函数通常返回非递减值，但如果在两次调用之间设置了系统时钟，则它可以返回比先前调用更低的值。

返回的数字 time() 可以通过将其传递给 gmtime() 函数或转换为UTC中更常见的时间格式（即年、月、日、小时等）或通过将它传递给 localtime() 函数获得本地时间。在这两种情况下都返回一个 struct_time 对象，日历日期组件可以从中作为属性访问。

使用 time_ns() 以避免 float 类型导致的精度损失。

time.time_ns() → int

与 time() 相似，但返回时间为用整数表示的自 epoch 以来所经过的纳秒数。

3.7 新版功能.

time.thread_time() → float

（以小数表示的秒为单位）返回当前线程的系统和用户 CPU 时间的总计值。 它不包括睡眠状态所消耗的时间。 根据定义它只作用于线程范围。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

使用 thread_time_ns() 以避免 float 类型导致的精度损失。

可用性 ： Windows、 Linux、 Unix 系统支持 CLOCK_THREAD_CPUTIME_ID 。

3.7 新版功能.

time.thread_time_ns() → int

与 thread_time() 相似，但返回纳秒时间。

3.7 新版功能.

time.tzset()

重置库例程使用的时间转换规则。环境变量 TZ 指定如何完成。它还将设置变量 tzname （来自 TZ 环境变量）， timezone （UTC的西部非DST秒）， altzone （UTC以西的DST秒）和 daylight （如果此时区没有任何夏令时规则则为0，如果有夏令时适用的时间，无论过去、现在或未来，则为非零）。

可用性: Unix。

注解

虽然在很多情况下，更改 TZ 环境变量而不调用 tzset() 可能会影响函数的输出，例如 localtime() ，不应该依赖此行为。

TZ 不应该包含空格。

TZ 环境变量的标准格式是（为了清晰起见，添加了空格）:

std offset [dst [offset [,start[/time], end[/time]]]]

组件的位置是：

std 和 dst

三个或更多字母数字，给出时区缩写。这些将传到 time.tzname

offset

偏移量的形式为： ± hh[:mm[:ss]] 。这表示添加到达UTC的本地时间的值。如果前面有 '-' ，则时区位于本初子午线的东边；否则，在它是西边。如果dst之后没有偏移，则假设夏令时比标准时间提前一小时。

start[/time], end[/time]

指示何时更改为DST和从DST返回。开始日期和结束日期的格式为以下之一：

Jn

Julian日 n （1 <= n <= 365）。闰日不计算在内，因此在所有年份中，2月28日是第59天，3月1日是第60天。

n

从零开始的Julian日（0 <= n <= 365）。 闰日计入，可以引用2月29日。

Mm.n.d

一年中 m 月的第 n 周（1 <= n <= 5 ，1 <= m <= 12 ，第 5 周表示 “可能在 m 月第 4 周或第 5 周出现的最后第 d 日”）的第 d 天（0 <= d <= 6）。 第 1 周是第 d 天发生的第一周。 第 0 天是星期天。

time 的格式与 offset 的格式相同，但不允许使用前导符号（ '-' 或 '+' ）。如果没有给出时间，则默认值为02:00:00。

>>> 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'

在许多Unix系统（包括 *BSD ， Linux ， Solaris 和 Darwin 上），使用系统的区域信息（ tzfile(5) ）数据库来指定时区规则会更方便。为此，将 TZ 环境变量设置为所需时区数据文件的路径，相对于系统 'zoneinfo' 时区数据库的根目录，通常位于 /usr/share/zoneinfo 。 例如，'US/Eastern' 、 'Australia/Melbourne' 、 'Egypt' 或 'Europe/Amsterdam'。

>>> os.environ['TZ'] = 'US/Eastern'
>>> time.tzset()
>>> time.tzname
('EST', 'EDT')
>>> os.environ['TZ'] = 'Egypt'
>>> time.tzset()
>>> time.tzname
('EET', 'EEST')

Clock ID 常量

这些常量用作 clock_getres() 和 clock_gettime() 的参数。

time.CLOCK_BOOTTIME

与 CLOCK_MONOTONIC 相同，除了它还包括系统暂停的任何时间。

这允许应用程序获得一个暂停感知的单调时钟，而不必处理 CLOCK_REALTIME 的复杂性，如果使用 settimeofday() 或类似的时间更改时间可能会有不连续性。

可用性: Linux 2.6.39 或更新

3.7 新版功能.

time.CLOCK_HIGHRES

Solaris OS 有一个 CLOCK_HIGHRES 计时器，试图使用最佳硬件源，并可能提供接近纳秒的分辨率。 CLOCK_HIGHRES 是不可调节的高分辨率时钟。

可用性: Solaris.

3.3 新版功能.

time.CLOCK_MONOTONIC

无法设置的时钟，表示自某些未指定的起点以来的单调时间。

可用性: Unix。

3.3 新版功能.

time.CLOCK_MONOTONIC_RAW

类似于 CLOCK_MONOTONIC ，但可以访问不受NTP调整影响的原始硬件时间。

可用性: Linux 2.6.28 和更新版本， macOS 10.12 和更新版本。

3.3 新版功能.

time.CLOCK_PROCESS_CPUTIME_ID

来自CPU的高分辨率每进程计时器。

可用性: Unix。

3.3 新版功能.

time.CLOCK_PROF

来自CPU的高分辨率每进程计时器。

可用性: FreeBSD， NetBSD 7 或更新， OpenBSD.

3.7 新版功能.

time.CLOCK_TAI

国际原子时间 [https://www.nist.gov/pml/time-and-frequency-division/nist-time-frequently-asked-questions-faq#tai]

该系统必须有一个当前闰秒表以便能给出正确的回答。 PTP 或 NTP 软件可以用来维护闰秒表。

可用性: Linux。

3.9 新版功能.

time.CLOCK_THREAD_CPUTIME_ID

特定于线程的CPU时钟。

可用性: Unix。

3.3 新版功能.

time.CLOCK_UPTIME

该时间的绝对值是系统运行且未暂停的时间，提供准确的正常运行时间测量，包括绝对值和间隔值。

可用性: FreeBSD， OpenBSD 5.5 或更新。

3.7 新版功能.

time.CLOCK_UPTIME_RAW

单调递增的时钟，记录从一个任意起点开始的时间，不受频率或时间调整的影响，并且当系统休眠时将不会递增。

可用性: macOS 10.12 和更新版本。

3.8 新版功能.

以下常量是唯一可以发送到 clock_settime() 的参数。

time.CLOCK_REALTIME

系统范围的实时时钟。 设置此时钟需要适当的权限。

可用性: Unix。

3.3 新版功能.

时区常量

time.altzone

本地DST时区的偏移量，以UTC为单位的秒数，如果已定义。如果当地DST时区在UTC以东（如在西欧，包括英国），则是负数。 只有当 daylight 非零时才使用它。 见下面的注释。

time.daylight

如果定义了DST时区，则为非零。 见下面的注释。

time.timezone

本地（非DST）时区的偏移量，UTC以西的秒数（西欧大部分地区为负，美国为正，英国为零）。 见下面的注释。

time.tzname

两个字符串的元组：第一个是本地非DST时区的名称，第二个是本地DST时区的名称。 如果未定义DST时区，则不应使用第二个字符串。 见下面的注释。

注解

对于上述时区常量（ altzone 、 daylight 、 timezone 和 tzname ），该值由模块加载时有效的时区规则确定，或者最后一次 tzset() 被调用时，并且在过去的时间可能不正确。建议使用来自 localtime() 结果的 tm_gmtoff 和 tm_zone 来获取时区信息。

参见

模块 datetime

更多面向对象的日期和时间接口。

模块 locale

国际化服务。 区域设置会影响 strftime() 和 strptime() 中许多格式说明符的解析。

模块 calendar

一般日历相关功能。这个模块的 timegm() 是函数 gmtime() 的反函数。

备注

1(1,2,3)

现在不推荐使用 %Z ，但是所有 ANSI C 库都不支持扩展为首选小时/分钟偏移量的 %z 转义符。 此外，严格的 1982 年原始 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 标准要求两位数的年份（ %y 而不是 %Y ），但是实际在2000年之前很久就转移到了4位数年。之后， RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 已经废弃了，4位数的年份首先被推荐 RFC 1123 [https://datatracker.ietf.org/doc/html/rfc1123.html] ，然后被 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 强制执行。

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

3.2 新版功能.

源代码： Lib/argparse.py [https://github.com/python/cpython/tree/3.10/Lib/argparse.py]

教程

此页面包含该 API 的参考信息。有关 Python 命令行解析更细致的介绍，请参阅 argparse 教程。

argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

示例

以下代码是一个 Python 程序，它获取一个整数列表并计算总和或者最大值：

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

假设上面的 Python 代码保存在名为 prog.py 的文件中，它可以在命令行运行并提供有用的帮助信息：

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

当使用适当的参数运行时，它会输出命令行传入整数的总和或者最大值：

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

如果传入无效参数，则会报出错误：

$ python prog.py a b c
usage: prog.py [-h] [--sum] N [N ...]
prog.py: error: argument N: invalid int value: 'a'

以下部分将引导你完成这个示例。

创建一个解析器

使用 argparse 的第一步是创建一个 ArgumentParser 对象：

>>> parser = argparse.ArgumentParser(description='Process some integers.')

ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。

添加参数

给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。通常，这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。这些信息在 parse_args() 调用时被存储和使用。例如：

>>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
...                     help='an integer for the accumulator')
>>> parser.add_argument('--sum', dest='accumulate', action='store_const',
...                     const=sum, default=max,
...                     help='sum the integers (default: find the max)')

然后，调用 parse_args() 将返回一个具有 integers 和 accumulate 两个属性的对象。integers 属性将是一个包含一个或多个整数的列表，而 accumulate 属性当命令行中指定了 --sum 参数时将是 sum() 函数，否则则是 max() 函数。

解析参数

ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。在大多数情况下，这意味着一个简单的 Namespace 对象将从命令行解析出的属性构建：

>>> parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

在脚本中，通常 parse_args() 会被不带参数调用，而 ArgumentParser 将自动从 sys.argv 中确定命令行参数。

ArgumentParser 对象

class 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)

创建一个新的 ArgumentParser 对象。所有的参数都应当作为关键字参数传入。每个参数在下面都有它更详细的描述，但简而言之，它们是：

prog - 程序的名称 (默认值: os.path.basename(sys.argv[0]))

usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）

description - 要在参数帮助信息之前显示的文本（默认：无文本）

epilog - 要在参数帮助信息之后显示的文本（默认：无文本）

parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内

formatter_class - 用于自定义帮助文档输出格式的类

prefix_chars - 可选参数的前缀字符集合（默认值： '-'）

fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值： None）

argument_default - 参数的全局默认值（默认值： None）

conflict_handler - 解决冲突选项的策略（通常是不必要的）

add_help - 为解析器添加一个 -h/--help 选项（默认值： True）

allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：True）

exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)

在 3.5 版更改: 增加了 allow_abbrev 参数。

在 3.8 版更改: 在之前的版本中，allow_abbrev 还会禁用短旗标分组，例如 -vv 表示为 -v -v。

在 3.9 版更改: 添加了 exit_on_error 形参。

以下部分描述这些参数如何使用。

prog

默认情况下，ArgumentParser 对象使用 sys.argv[0] 来确定如何在帮助消息中显示程序名称。这一默认值几乎总是可取的，因为它将使帮助消息与从命令行调用此程序的方式相匹配。例如，对于有如下代码的名为 myprogram.py 的文件：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--foo', help='foo help')
args = parser.parse_args()

该程序的帮助信息将显示 myprogram.py 作为程序名称（无论程序从何处被调用）：

$ python myprogram.py --help
usage: myprogram.py [-h] [--foo FOO]

options:
 -h, --help  show this help message and exit
 --foo FOO   foo help
$ cd ..
$ python subdir/myprogram.py --help
usage: myprogram.py [-h] [--foo FOO]

options:
 -h, --help  show this help message and exit
 --foo FOO   foo help

要更改这样的默认行为，可以使用 prog= 参数为 ArgumentParser 指定另一个值：

>>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.print_help()
usage: myprogram [-h]

options:
 -h, --help  show this help message and exit

需要注意的是，无论是从 sys.argv[0] 或是从 prog= 参数确定的程序名称，都可以在帮助消息里通过 %(prog)s 格式说明符来引用。

>>> 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

usage（用法）

默认情况下，ArgumentParser 根据它包含的参数来构建用法消息：

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', nargs='?', help='foo help')
>>> parser.add_argument('bar', nargs='+', help='bar help')
>>> parser.print_help()
usage: PROG [-h] [--foo [FOO]] bar [bar ...]

positional arguments:
 bar          bar help

options:
 -h, --help   show this help message and exit
 --foo [FOO]  foo help

可以通过 usage= 关键字参数覆盖这一默认消息：

>>> 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

在用法消息中可以使用 %(prog)s 格式说明符来填入程序名称。

description

大多数对 ArgumentParser 构造方法的调用都会使用 description= 关键字参数。 这个参数简要描述这个程序做什么以及怎么做。 在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间:

>>> parser = argparse.ArgumentParser(description='A foo that bars')
>>> parser.print_help()
usage: argparse.py [-h]

A foo that bars

options:
 -h, --help  show this help message and exit

在默认情况下，description 将被换行以便适应给定的空间。如果想改变这种行为，见 formatter_class 参数。

epilog

一些程序喜欢在 description 参数后显示额外的对程序的描述。这种文字能够通过给 ArgumentParser:: 提供 epilog= 参数而被指定。

>>> 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

和 description 参数一样，epilog= text 在默认情况下会换行，但是这种行为能够被调整通过提供 formatter_class 参数给 ArgumentParse.

parents

有些时候，少数解析器会使用同一系列参数。 单个解析器能够通过提供 parents= 参数给 ArgumentParser 而使用相同的参数而不是重复这些参数的定义。parents= 参数使用 ArgumentParser 对象的列表，从它们那里收集所有的位置和可选的行为，然后将这写行为加到正在构建的 ArgumentParser 对象。

>>> 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)

请注意大多数父解析器会指定 add_help=False . 否则， ArgumentParse 将会看到两个 -h/--help 选项（一个在父参数中一个在子参数中）并且产生一个错误。

注解

你在通过 parents= 传递解析器之前必须完全初始化它们。 如果你在子解析器之后改变父解析器，这些改变将不会反映在子解析器上。

formatter_class

ArgumentParser 对象允许通过指定备用格式化类来自定义帮助格式。目前，有四种这样的类。

class argparse.RawDescriptionHelpFormatter

class argparse.RawTextHelpFormatter

class argparse.ArgumentDefaultsHelpFormatter

class argparse.MetavarTypeHelpFormatter

RawDescriptionHelpFormatter 和 RawTextHelpFormatter 在正文的描述和展示上给与了更多的控制。ArgumentParser 对象会将 description 和 epilog 的文字在命令行中自动换行。

>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     description='''this description
...         was indented weird
...             but that is okay''',
...     epilog='''
...             likewise for this epilog whose whitespace will
...         be cleaned up and whose words will be wrapped
...         across a couple lines''')
>>> 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

传 RawDescriptionHelpFormatter 给 formatter_class= 表示 description 和 epilog 已经被正确的格式化了，不能在命令行中被自动换行:

>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.RawDescriptionHelpFormatter,
...     description=textwrap.dedent('''\
...         Please do not mess up this text!
...         --------------------------------
...             I have indented it
...             exactly the way
...             I want it
...         '''))
>>> 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

RawTextHelpFormatter 保留所有种类文字的空格，包括参数的描述。然而，多重的新行会被替换成一行。如果你想保留多重的空白行，可以在新行之间加空格。

ArgumentDefaultsHelpFormatter 自动添加默认的值的信息到每一个帮助信息的参数中:

>>> 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)

MetavarTypeHelpFormatter 为它的值在每一个参数中使用 type 的参数名当作它的显示名（而不是使用通常的格式 dest ):

>>> 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

prefix_chars

许多命令行会使用 - 当作前缀，比如 -f/--foo。如果解析器需要支持不同的或者额外的字符，比如像 +f 或者 /foo 的选项，可以在参数解析构建器中使用 prefix_chars= 参数。

>>> 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')

prefix_chars= 参数默认使用 '-'。 提供一组不包括 - 的字符将导致 -f/--foo 选项不被允许。

fromfile_prefix_chars

在某些时候，例如在处理一个特别长的参数列表的时候，把参数列表存入一个文件中而不是在命令行中打印出来会更有意义。 如果提供 fromfile_prefix_chars= 参数给 ArgumentParser 构造器，则任何以指定字符打头的参数都将被当作文件来处理，并将被它们包含的参数所替代。 举例来说:

>>> with open('args.txt', 'w') 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')

从文件读取的参数在默认情况下必须一个一行（但是可参见 convert_arg_line_to_args()）并且它们被视为与命令行上的原始文件引用参数位于同一位置。所以在以上例子中，['-f', 'foo', '@args.txt'] 的表示和 ['-f', 'foo', '-f', 'bar'] 的表示相同。

fromfile_prefix_chars= 参数默认为 None，意味着参数不会被当作文件对待。

argument_default

一般情况下，参数默认会通过设置一个默认到 add_argument() 或者调用带一组指定键值对的 ArgumentParser.set_defaults() 方法。但是有些时候，为参数指定一个普遍适用的解析器会更有用。这能够通过传输 argument_default= 关键词参数给 ArgumentParser 来完成。举个栗子，要全局禁止在 parse_args() 中创建属性，我们提供 argument_default=SUPPRESS:

>>> 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()

allow_abbrev

正常情况下，当你向 ArgumentParser 的 parse_args() 方法传入一个参数列表时，它会 recognizes abbreviations。

这个特性可以设置 allow_abbrev 为 False 来关闭:

>>> 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

3.5 新版功能.

conflict_handler

ArgumentParser 对象不允许在相同选项字符串下有两种行为。默认情况下， ArgumentParser 对象会产生一个异常如果去创建一个正在使用的选项字符串参数。

>>> 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

有些时候（例如：使用 parents），重写旧的有相同选项字符串的参数会更有用。为了产生这种行为， 'resolve' 值可以提供给 ArgumentParser 的 conflict_handler= 参数:

>>> 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

注意 ArgumentParser 对象只能移除一个行为如果它所有的选项字符串都被重写。所以，在上面的例子中，旧的 -f/--foo 行为 回合 -f 行为保持一样, 因为只有 --foo 选项字符串被重写。

add_help

默认情况下，ArgumentParser 对象添加一个简单的显示解析器帮助信息的选项。举个栗子，考虑一个名为 myprogram.py 的文件包含如下代码:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--foo', help='foo help')
args = parser.parse_args()

如果 -h or --help 在命令行中被提供, 参数解析器帮助信息会打印:

$ python myprogram.py --help
usage: myprogram.py [-h] [--foo FOO]

options:
 -h, --help  show this help message and exit
 --foo FOO   foo help

有时候可能会需要关闭额外的帮助信息。这可以通过在 ArgumentParser 中设置 add_help= 参数为 False 来实现。

>>> 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

帮助选项一般为 -h/--help。如果 prefix_chars= 被指定并且没有包含 - 字符，在这种情况下， -h --help 不是有效的选项。此时， prefix_chars 的第一个字符将用作帮助选项的前缀。

>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')
>>> parser.print_help()
usage: PROG [+h]

options:
  +h, ++help  show this help message and exit

exit_on_error

正常情况下，当你向 ArgumentParser 的 parse_args() 方法传入一个无效的参数列表时，它将会退出并发出错误信息。

如果用户想要手动捕获错误，可通过将 exit_on_error 设为 False 来启用该特性:

>>> 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

3.9 新版功能.

add_argument() 方法

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述，长话短说有：

name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。

action - 当参数在命令行中出现时使用的动作基本类型。

nargs - 命令行参数应当消耗的数目。

const - 被一些 action 和 nargs 选择所需求的常数。

default - 当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值。

type - 命令行参数应当被转换成的类型。

choices - 由允许作为参数的值组成的序列。

required - 此命令行选项是否可省略 （仅选项可用）。

help - 一个此选项作用的简单描述。

metavar - 在使用方法消息中使用的参数值示例。

dest - 被添加到 parse_args() 所返回对象上的属性名。

以下部分描述这些参数如何使用。

name or flags

add_argument() 方法必须知道它是否是一个选项，例如 -f 或 --foo，或是一个位置参数，例如一组文件名。 第一个传递给 add_argument() 的参数必须是一系列旗标或者是一个简单的参数名。例如，可选参数可以被这样创建:

>>> parser.add_argument('-f', '--foo')

而位置参数可以这么创建:

>>> parser.add_argument('bar')

当 parse_args() 被调用，选项会以 - 前缀识别，剩下的参数则会被假定为位置参数:

>>> 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

action

ArgumentParser 对象将命令行参数与动作相关联。这些动作可以做与它们相关联的命令行参数的任何事，尽管大多数动作只是简单的向 parse_args() 返回的对象上添加属性。action 命名参数指定了这个命令行参数应当如何处理。供应的动作有：

'store' - 存储参数的值。这是默认的动作。例如:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.parse_args('--foo 1'.split())
Namespace(foo='1')

'store_const' - 存储被 const 命名参数指定的值。 'store_const' 动作通常用在选项中来指定一些标志。例如:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_const', const=42)
>>> parser.parse_args(['--foo'])
Namespace(foo=42)

'store_true' and 'store_false' - 这些是 'store_const' 分别用作存储 True 和 False 值的特殊用例。另外，它们的默认值分别为 False 和 True。例如:

>>> 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)

'append' - 存储一个列表，并且将每个参数值追加到列表中。在允许多次使用选项时很有用。例如:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='append')
>>> parser.parse_args('--foo 1 --foo 2'.split())
Namespace(foo=['1', '2'])

'append_const' - 这存储一个列表，并将 const 命名参数指定的值追加到列表中。（注意 const 命名参数默认为 None。）``'append_const'`` 动作一般在多个参数需要在同一列表中存储常数时会有用。例如:

>>> 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'>])

'count' - 计算一个关键字参数出现的数目或次数。例如，对于一个增长的详情等级来说有用:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--verbose', '-v', action='count', default=0)
>>> parser.parse_args(['-vvv'])
Namespace(verbose=3)

请注意，default 将为 None，除非显式地设为 0。

'help' - 打印所有当前解析器中的选项和参数的完整帮助信息，然后退出。默认情况下，一个 help 动作会被自动加入解析器。关于输出是如何创建的，参与 ArgumentParser。

'version' - 期望有一个 version= 命名参数在 add_argument() 调用中，并打印版本信息并在调用后退出:

>>> 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

'extend' - 这会存储一个列表，并将每个参数值加入到列表中。 示例用法:

>>> 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'])

3.8 新版功能.

你还可以通过传递一个 Action 子类或实现相同接口的其他对象来指定任意操作。 BooleanOptionalAction 在 argparse 中可用并会添加对布尔型操作例如 --foo 和 --no-foo 的支持:

>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction)
>>> parser.parse_args(['--no-foo'])
Namespace(foo=False)

3.9 新版功能.

创建自定义动作的推荐方式是扩展 Action，重写 __call__ 方法以及可选的 __init__ 和 format_usage 方法。

一个自定义动作的例子:

>>> 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')

更多描述，见 Action。

nargs

ArgumentParser 对象通常关联一个单独的命令行参数到一个单独的被执行的动作。 nargs 命名参数关联不同数目的命令行参数到单一动作。支持的值有：

N （一个整数）。命令行中的 N 个参数会被聚集到一个列表中。 例如:

>>> 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'])

注意 nargs=1 会产生一个单元素列表。这和默认的元素本身是不同的。

'?'。 如果可能的话，会从命令行中消耗一个参数，并产生一个单独项。 如果当前没有命令行参数，将会产生 default 值。 注意对于可选参数来说，还有一个额外情况 —— 出现了选项字符串但没有跟随命令行参数，在此情况下将会产生 const 值。 一些说明这种情况的例子如下:

>>> 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')

nargs='?' 的一个更普遍用法是允许可选的输入或输出文件:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
...                     default=sys.stdin)
>>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
...                     default=sys.stdout)
>>> parser.parse_args(['input.txt', 'output.txt'])
Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,
          outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>)
>>> parser.parse_args([])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,
          outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)

'*'。所有当前命令行参数被聚集到一个列表中。注意通过 nargs='*' 来实现多个位置参数通常没有意义，但是多个选项是可能的。例如:

>>> 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'])

'+'。和 '*' 类似，所有当前命令行参数被聚集到一个列表中。另外，当前没有至少一个命令行参数时会产生一个错误信息。例如:

>>> 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

如果不提供 nargs 命名参数，则消耗参数的数目将被 action 决定。通常这意味着单一项目（非列表）消耗单一命令行参数。

const

add_argument() 的 const 参数用于保存不从命令行中读取但被各种 ArgumentParser 动作需求的常数值。最常用的两例为：

当 add_argument() 通过 action='store_const' 或 action='append_const 调用时。这些动作将 const 值添加到 parse_args() 返回的对象的属性中。在 action 的描述中查看案例。

当 add_argument() 通过选项（例如 -f 或 --foo）调用并且 nargs='?' 时。这会创建一个可以跟随零个或一个命令行参数的选项。当解析命令行时，如果选项后没有参数，则将用 const 代替。在 nargs 描述中查看案例。

对 'store_const' 和 'append_const' 动作， const 命名参数必须给出。对其他动作，默认为 None。

默认值

所有选项和一些位置参数可能在命令行中被忽略。add_argument() 的命名参数 default，默认值为 None，指定了在命令行参数未出现时应当使用的值。对于选项， default 值在选项未在命令行中出现时使用:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args(['--foo', '2'])
Namespace(foo='2')
>>> parser.parse_args([])
Namespace(foo=42)

如果目标命名空间已经有一个属性集，则 default 动作不会覆盖它:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args([], namespace=argparse.Namespace(foo=101))
Namespace(foo=101)

如果 default 值是一个字符串，解析器解析此值就像一个命令行参数。特别是，在将属性设置在 Namespace 的返回值之前，解析器应用任何提供的 type 转换参数。否则解析器使用原值:

>>> 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)

对于 nargs 等于 ? 或 * 的位置参数， default 值在没有命令行参数出现时使用。

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('foo', nargs='?', default=42)
>>> parser.parse_args(['a'])
Namespace(foo='a')
>>> parser.parse_args([])
Namespace(foo=42)

提供 default=argparse.SUPPRESS 导致命令行参数未出现时没有属性被添加:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=argparse.SUPPRESS)
>>> parser.parse_args([])
Namespace()
>>> parser.parse_args(['--foo', '1'])
Namespace(foo='1')

type

默认情况下，解析器会将命令行参数当作简单字符串读入。 然而，命令行字符串经常应当被解读为其他类型，例如 float 或 int。 add_argument() 的 type 关键字允许执行任何必要的类型检查和类型转换。

如果 type 关键字使用了 default 关键字，则类型转换器仅会在默认值为字符串时被应用。

传给 type 的参数可以是任何接受单个字符串的可调用对象。 如果函数引发了 ArgumentTypeError, TypeError 或 ValueError，异常会被捕获并显示经过良好格式化的错误消息。 其他异常类型则不会被处理。

普通内置类型和函数可被用作类型转换器:

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('source_file', type=open)
parser.add_argument('dest_file', type=argparse.FileType('w', encoding='latin-1'))
parser.add_argument('datapath', type=pathlib.Path)

用户自定义的函数也可以被使用:

>>> 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')

不建议将 bool() 函数用作类型转换器。 它所做的只是将空字符串转为 False 而将非空字符串转为 True。 这通常不是用户所想要的。

通常，type 关键字是仅应被用于只会引发上述三种被支持的异常的简单转换的便捷选项。 任何具有更复杂错误处理或资源管理的转换都应当在参数被解析后由下游代码来完成。

例如，JSON 或 YAML 转换具有复杂的错误情况，要求给出比 type 关键字所能给出的更好的报告。 JSONDecodeError 将不会被良好地格式化而 FileNotFound 异常则完全不会被处理。

即使 FileType 在用于 type 关键字时也存在限制。 如果一个参数使用了 FileType 并且有一个后续参数出错，则将报告一个错误但文件并不会被自动关闭。 在此情况下，更好的做法是等待直到解析器运行完毕再使用 with 语句来管理文件。

对于简单地检查一组固定值的类型检查器，请考虑改用 choices 关键字。

choices

某些命令行参数应当从一组受限的值中选择。 这可以通过将一个序列对象作为 choices 关键字参数传给 add_argument() 来处理。 当执行命令行解析时，参数值将被检查，如果参数不是可接受的值之一就将显示错误消息:

>>> 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')

请注意 choices 序列包含的内容会在执行任意 type 转换之后被检查，因此 choices 序列中对象的类型应当与指定的 type 相匹配:

>>> parser = argparse.ArgumentParser(prog='doors.py')
>>> parser.add_argument('door', type=int, choices=range(1, 4))
>>> print(parser.parse_args(['3']))
Namespace(door=3)
>>> parser.parse_args(['4'])
usage: doors.py [-h] {1,2,3}
doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)

任何序列都可作为 choices 值传入，因此 list 对象、tuple 对象以及自定义序列都是受支持的。

不建议使用 enum.Enum，因为要控制其在用法、帮助和错误消息中的外观是很困难的。

已格式化的选项会覆盖默认的 metavar，该值一般是派生自 dest。 这通常就是你所需要的，因为用户永远不会看到 dest 形参。 如果不想要这样的显示（或许因为有很多选择），只需指定一个显式的 metavar。

required

通常，argparse 模块会认为 -f 和 --bar 等旗标是指明 可选的 参数，它们总是可以在命令行中被忽略。 要让一个选项成为 必需的，则可以将 True 作为 required= 关键字参数传给 add_argument():

>>> 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

如这个例子所示，如果一个选项被标记为 required，则当该选项未在命令行中出现时，parse_args() 将会报告一个错误。

注解

必需的选项通常被认为是不适宜的，因为用户会预期 options 都是 可选的，因此在可能的情况下应当避免使用它们。

help

help 值是一个包含参数简短描述的字符串。 当用户请求帮助时（一般是通过在命令行中使用 -h 或 --help 的方式），这些 help 描述将随每个参数一同显示:

>>> parser = argparse.ArgumentParser(prog='frobble')
>>> parser.add_argument('--foo', action='store_true',
...                     help='foo the bars before frobbling')
>>> parser.add_argument('bar', nargs='+',
...                     help='one of the bars to be frobbled')
>>> parser.parse_args(['-h'])
usage: frobble [-h] [--foo] bar [bar ...]

positional arguments:
 bar     one of the bars to be frobbled

options:
 -h, --help  show this help message and exit
 --foo   foo the bars before frobbling

help 字符串可包括各种格式描述符以避免重复使用程序名称或参数 default 等文本。 有效的描述符包括程序名称 %(prog)s 和传给 add_argument() 的大部分关键字参数，例如 %(default)s, %(type)s 等等:

>>> 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

由于帮助字符串支持 %-formatting，如果你希望在帮助字符串中显示 % 字面值，你必须将其转义为 %%。

argparse 支持静默特定选项的帮助，具体做法是将 help 的值设为 argparse.SUPPRESS:

>>> 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

metavar

当 ArgumentParser 生成帮助消息时，它需要用某种方式来引用每个预期的参数。 默认情况下，ArgumentParser 对象使用 dest 值作为每个对象的 "name"。 默认情况下，对于位置参数动作，dest 值将被直接使用，而对于可选参数动作，dest 值将被转为大写形式。 因此，一个位置参数 dest='bar' 的引用形式将为 bar。 一个带有单独命令行参数的可选参数 --foo 的引用形式将为 FOO。 示例如下:

>>> 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

可以使用 metavar 来指定一个替代名称:

>>> 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

请注意 metavar 仅改变 显示的 名称 - parse_args() 对象的属性名称仍然会由 dest 值确定。

不同的 nargs 值可能导致 metavar 被多次使用。 提供一个元组给 metavar 即为每个参数指定不同的显示信息:

>>> 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

dest

大多数 ArgumentParser 动作会添加一些值作为 parse_args() 所返回对象的一个属性。 该属性的名称由 add_argument() 的 dest 关键字参数确定。 对于位置参数动作，dest 通常会作为 add_argument() 的第一个参数提供:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('bar')
>>> parser.parse_args(['XXX'])
Namespace(bar='XXX')

对于可选参数动作，dest 的值通常取自选项字符串。 ArgumentParser 会通过接受第一个长选项字符串并去掉开头的 -- 字符串来生成 dest 的值。 如果没有提供长选项字符串，则 dest 将通过接受第一个短选项字符串并去掉开头的 - 字符来获得。 任何内部的 - 字符都将被转换为 _ 字符以确保字符串是有效的属性名称。 下面的例子显示了这种行为:

>>> 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')

dest 允许提供自定义属性名称:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', dest='bar')
>>> parser.parse_args('--foo XXX'.split())
Namespace(bar='XXX')

Action 类

Action 类实现了 Action API，它是一个返回可调用对象的可调用对象，返回的可调用对象可处理来自命令行的参数。 任何遵循此 API 的对象均可作为 action 形参传给 add_argument()。

class argparse.Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Action 对象会被 ArgumentParser 用来表示解析从命令行中的一个或多个字符串中解析出单个参数所必须的信息。 Action 类必须接受两个位置参数以及传给 ArgumentParser.add_argument() 的任何关键字参数，除了 action 本身。

Action 的实例（或作为or return value of any callable to the action 形参的任何可调用对象的返回值）应当定义 "dest", "option_strings", "default", "type", "required", "help" 等属性。 确保这些属性被定义的最容易方式是调用 Action.__init__。

Action 的实例应当为可调用对象，因此所有子类都必须重写 __call__ 方法，该方法应当接受四个形参:

parser - 包含此动作的 ArgumentParser 对象。

namespace - 将由 parse_args() 返回的 Namespace 对象。 大多数动作会使用 setattr() 为此对象添加属性。

values - 已关联的命令行参数，并提供相应的类型转换。 类型转换由 add_argument() 的 type 关键字参数来指定。

option_string - 被用来发起调用此动作的选项字符串。 option_string 参数是可选的，且此参数在动作关联到位置参数时将被略去。

__call__ 方法可以执行任意动作，但通常将基于 dest 和 values 来设置 namespace 的属性。

动作子类可定义 format_usage 方法，该方法不带参数，所返回的字符串将被用于打印程序的用法说明。 如果未提供此方法，则将使用适当的默认值。

parse_args() 方法

ArgumentParser.parse_args(args=None, namespace=None)

将参数字符串转换为对象并将其设为命名空间的属性。 返回带有成员的命名空间。

之前对 add_argument() 的调用决定了哪些对象被创建以及它们如何被赋值。 请参阅 add_argument() 的文档了解详情。

args - 要解析的字符串列表。 默认值是从 sys.argv 获取。

namespace - 用于获取属性的对象。 默认值是一个新的空 Namespace 对象。

选项值语法

parse_args() 方法支持多种指定选项值的方式（如果它接受选项的话）。 在最简单的情况下，选项和它的值是作为两个单独参数传入的:

>>> 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)

对于长选项（名称长度超过一个字符的选项），选项和值也可以作为单个命令行参数传入，使用 = 分隔它们即可:

>>> parser.parse_args(['--foo=FOO'])
Namespace(foo='FOO', x=None)

对于短选项（长度只有一个字符的选项），选项和它的值可以拼接在一起:

>>> parser.parse_args(['-xX'])
Namespace(foo=None, x='X')

有些短选项可以使用单个 - 前缀来进行合并，如果仅有最后一个选项（或没有任何选项）需要值的话:

>>> 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')

无效的参数

在解析命令行时，parse_args() 会检测多种错误，包括有歧义的选项、无效的类型、无效的选项、错误的位置参数个数等等。 当遇到这种错误时，它将退出并打印出错误文本同时附带用法消息:

>>> 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

包含 - 的参数

parse_args() 方法会在用户明显出错时尝试给出错误信息，但某些情况本身就存在歧义。 例如，命令行参数 -1 可能是尝试指定一个选项也可能是尝试提供一个位置参数。 parse_args() 方法在此会谨慎行事：位置参数只有在它们看起来像负数并且解析器中没有任何选项看起来像负数时才能以 - 打头。:

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('foo', nargs='?')

>>> # no negative number options, so -1 is a positional argument
>>> parser.parse_args(['-x', '-1'])
Namespace(foo=None, x='-1')

>>> # no negative number options, so -1 and -5 are positional arguments
>>> 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='?')

>>> # negative number options present, so -1 is an option
>>> parser.parse_args(['-1', 'X'])
Namespace(foo=None, one='X')

>>> # negative number options present, so -2 is an option
>>> parser.parse_args(['-2'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: no such option: -2

>>> # negative number options present, so both -1s are options
>>> parser.parse_args(['-1', '-1'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: argument -1: expected one argument

如果你有必须以 - 打头的位置参数并且看起来不像负数，你可以插入伪参数 '--' 以告诉 parse_args() 在那之后的内容是一个位置参数:

>>> parser.parse_args(['--', '-f'])
Namespace(foo='-f', one=None)

参数缩写（前缀匹配）

parse_args() 方法 在默认情况下 允许将长选项缩写为前缀，如果缩写无歧义（即前缀与一个特定选项相匹配）的话:

>>> 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

可产生一个以上选项的参数会引发错误。 此特定可通过将 allow_abbrev 设为 False 来禁用。

在 sys.argv 以外

有时在 sys.argv 以外用 ArgumentParser 解析参数也是有用的。 这可以通过将一个字符串列表传给 parse_args() 来实现。 它适用于在交互提示符下进行检测:

>>> 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])

命名空间对象

class argparse.Namespace

由 parse_args() 默认使用的简单类，可创建一个存放属性的对象并将其返回。

这个类被有意做得很简单，只是一个具有可读字符串表示形式的 object。 如果你更喜欢类似字典的属性视图，你可以使用标准 Python 中惯常的 vars():

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> args = parser.parse_args(['--foo', 'BAR'])
>>> vars(args)
{'foo': 'BAR'}

另一个用处是让 ArgumentParser 为一个已存在对象而不是为一个新的 Namespace 对象的属性赋值。 这可以通过指定 namespace= 关键字参数来实现:

>>> class C:
...     pass
...
>>> c = C()
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.parse_args(args=['--foo', 'BAR'], namespace=c)
>>> c.foo
'BAR'

其它实用工具

子命令

ArgumentParser.add_subparsers([title][, description][, prog][, parser_class][, action][, option_strings][, dest][, required][, help][, metavar])

许多程序都会将其功能拆分为一系列子命令，例如，svn 程序包含的子命令有 svn checkout, svn update 和 svn commit。 当一个程序能执行需要多组不同种类命令行参数时这种拆分功能的方式是一个非常好的主意。 ArgumentParser 通过 add_subparsers() 方法支持创建这样的子命令。 add_subparsers() 方法通常不带参数地调用并返回一个特殊的动作对象。 这种对象只有一个方法 add_parser()，它接受一个命令名称和任意多个 ArgumentParser 构造器参数，并返回一个可以通常方式进行修改的 ArgumentParser 对象。

形参的描述

title - 输出帮助的子解析器分组的标题；如果提供了描述则默认为 "subcommands"，否则使用位置参数的标题

description - 输出帮助中对子解析器的描述，默认为 None

prog - 将与子命令帮助一同显示的用法信息，默认为程序名称和子解析器参数之前的任何位置参数。

parser_class - 将被用于创建子解析器实例的类，默认为当前解析器类（例如 ArgumentParser）

action - 当此参数在命令行中出现时要执行动作的基本类型

dest - 将被用于保存子命令名称的属性名；默认为 None 即不保存任何值

required - 是否必须要提供子命令，默认为 False (在 3.7 中新增)

help - 在输出帮助中的子解析器分组帮助信息，默认为 None

metavar - 帮助信息中表示可用子命令的字符串；默认为 None 并以 {cmd1, cmd2, ..} 的形式表示子命令

一些使用示例:

>>> # create the top-level parser
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', action='store_true', help='foo help')
>>> subparsers = parser.add_subparsers(help='sub-command help')
>>>
>>> # create the parser for the "a" command
>>> parser_a = subparsers.add_parser('a', help='a help')
>>> parser_a.add_argument('bar', type=int, help='bar help')
>>>
>>> # create the parser for the "b" command
>>> parser_b = subparsers.add_parser('b', help='b help')
>>> parser_b.add_argument('--baz', choices='XYZ', help='baz help')
>>>
>>> # parse some argument lists
>>> parser.parse_args(['a', '12'])
Namespace(bar=12, foo=False)
>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])
Namespace(baz='Z', foo=True)

请注意 parse_args() 返回的对象将只包含主解析器和由命令行所选择的子解析器的属性（而没有任何其他子解析器）。 因此在上面的例子中，当指定了 a 命令时，将只存在 foo 和 bar 属性，而当指定了 b 命令时，则只存在 foo 和 baz 属性。

类似地，当从一个子解析器请求帮助消息时，只有该特定解析器的帮助消息会被打印出来。 帮助消息将不包括父解析器或同级解析器的消息。 （每个子解析器命令一条帮助消息，但是，也可以像上面那样通过提供 help= 参数给 add_parser() 来给出。）

>>> parser.parse_args(['--help'])
usage: PROG [-h] [--foo] {a,b} ...

positional arguments:
  {a,b}   sub-command 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

add_subparsers() 方法也支持 title 和 description 关键字参数。 当两者都存在时，子解析器的命令将出现在输出帮助消息中它们自己的分组内。 例如:

>>> 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

此外，add_parser 还支持额外的``aliases`` 参数，允许多个字符串引用同一个子解析器。以下例子，与``svn`` 一样，将``co`` 作为``checkout`` 的别名:

>>> 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')

一个特别有效的处理子命令的方式是将 add_subparsers() 方法与对 set_defaults() 的调用结合起来使用，这样每个子解析器就能知道应当执行哪个 Python 函数。 例如:

>>> # sub-command functions
>>> def foo(args):
...     print(args.x * args.y)
...
>>> def bar(args):
...     print('((%s))' % args.z)
...
>>> # create the top-level parser
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(required=True)
>>>
>>> # create the parser for the "foo" command
>>> 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)
>>>
>>> # create the parser for the "bar" command
>>> parser_bar = subparsers.add_parser('bar')
>>> parser_bar.add_argument('z')
>>> parser_bar.set_defaults(func=bar)
>>>
>>> # parse the args and call whatever function was selected
>>> args = parser.parse_args('foo 1 -x 2'.split())
>>> args.func(args)
2.0
>>>
>>> # parse the args and call whatever function was selected
>>> args = parser.parse_args('bar XYZYX'.split())
>>> args.func(args)
((XYZYX))

通过这种方式，你可以在参数解析结束后让 parse_args() 执行调用适当函数的任务。 像这样将函数关联到动作通常是你处理每个子解析器的不同动作的最简便方式。 但是，如果有必要检查被唤起的子解析器的名称，则 add_subparsers() 调用的 dest 关键字参数将可实现:

>>> 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')

在 3.7 版更改: 新增 required 关键字参数。

FileType 对象

class argparse.FileType(mode='r', bufsize=- 1, encoding=None, errors=None)

FileType 工厂类用于创建可作为 ArgumentParser.add_argument() 的 type 参数传入的对象。 以 FileType 对象作为其类型的参数将使用命令行参数以所请求模式、缓冲区大小、编码格式和错误处理方式打开文件（请参阅 open() 函数了解详情）:

>>> 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'>)

FileType 对象能理解伪参数 '-' 并会自动将其转换为 sys.stdin 用于可读的 FileType 对象以及 sys.stdout 用于可写的 FileType 对象:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', type=argparse.FileType('r'))
>>> parser.parse_args(['-'])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)

3.4 新版功能: encodings 和 errors 关键字参数。

参数组

ArgumentParser.add_argument_group(title=None, description=None)

在默认情况下，ArgumentParser 会在显示帮助消息时将命令行参数分为“位置参数”和“可选参数”两组。 当存在比默认更好的参数分组概念时，可以使用 add_argument_group() 方法来创建适当的分组:

>>> 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

add_argument_group() 方法返回一个具有 add_argument() 方法的参数分组对象，这与常规的 ArgumentParser 一样。 当一个参数被加入分组时，解析器会将它视为一个正常的参数，但是会在不同的帮助消息分组中显示该参数。 add_argument_group() 方法接受 title 和 description 参数，它们可被用来定制显示内容:

>>> 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

请注意任意不在你的自定义分组中的参数最终都将回到通常的“位置参数”和“可选参数”分组中。

互斥

ArgumentParser.add_mutually_exclusive_group(required=False)

创建一个互斥组。 argparse 将会确保互斥组中只有一个参数在命令行中可用:

>>> 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

add_mutually_exclusive_group() 方法也接受一个 required 参数，表示在互斥组中至少有一个参数是需要的:

>>> 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

注意，目前互斥参数组不支持 add_argument_group() 的 title 和 description 参数。

解析器默认值

ArgumentParser.set_defaults(**kwargs)

在大多数时候，parse_args() 所返回对象的属性将完全通过检查命令行参数和参数动作来确定。 set_defaults() 则允许加入一些无须任何命令行检查的额外属性:

>>> 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)

请注意解析器层级的默认值总是会覆盖参数层级的默认值:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='bar')
>>> parser.set_defaults(foo='spam')
>>> parser.parse_args([])
Namespace(foo='spam')

解析器层级默认值在需要多解析器时会特别有用。 请参阅 add_subparsers() 方法了解此类型的一个示例。

ArgumentParser.get_default(dest)

获取一个命名空间属性的默认值，该值是由 add_argument() 或 set_defaults() 设置的:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='badger')
>>> parser.get_default('foo')
'badger'

打印帮助

在大多数典型应用中，parse_args() 将负责任何用法和错误消息的格式化和打印。 但是，也可使用某些其他格式化方法:

ArgumentParser.print_usage(file=None)

打印一段简短描述，说明应当如何在命令行中唤起 ArgumentParser。 如果 file 为 None，则默认使用 sys.stdout。

ArgumentParser.print_help(file=None)

打印一条帮助消息，包括程序用法和通过 ArgumentParser 注册的相关参数信息。 如果 file 为 None，则默认使用 sys.stdout。

还存在这些方法的几个变化形式，它们只返回字符串而不打印消息:

ArgumentParser.format_usage()

返回一个包含简短描述的字符串，说明应当如何在命令行中唤起 ArgumentParser。

ArgumentParser.format_help()

反回一个包含帮助消息的字符串，包括程序用法和通过 ArgumentParser 注册的相关参数信息。

部分解析

ArgumentParser.parse_known_args(args=None, namespace=None)

有时一个脚本可能只解析部分命令行参数，而将其余的参数继续传递给另一个脚本或程序。 在这种情况下，parse_known_args() 方法会很有用处。 它的作用方式很类似 parse_args() 但区别在于当存在额外参数时它不会产生错误。 而是会返回一个由两个条目构成的元组，其中包含带成员的命名空间和剩余参数字符串的列表。

>>> 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'])

警告

前缀匹配 规则应用于 parse_known_args()。 一个选项即使只是已知选项的前缀部分解析器也能识别该选项，不会将其放入剩余参数列表。

自定义文件解析

ArgumentParser.convert_arg_line_to_args(arg_line)

从文件读取的参数（见 ArgumentParser 的 fromfile_prefix_chars 关键字参数）将是一行读取一个参数。 convert_arg_line_to_args() 可被重写以使用更复杂的读取方式。

此方法接受从参数文件读取的字符串形式的单个参数 arg_line。 它返回从该字符串解析出的参数列表。 此方法将在每次按顺序从参数文件读取一行时被调用一次。

此方法的一个有用的重写是将每个以空格分隔的单词视为一个参数。 下面的例子演示了如何实现这一点:

class MyArgumentParser(argparse.ArgumentParser):
    def convert_arg_line_to_args(self, arg_line):
        return arg_line.split()

退出方法

ArgumentParser.exit(status=0, message=None)

此方法将终结程序，退出时附带指定的 status，并且如果给出了 message 则会在退出前将其打印输出。 用户可重写此方法以不同方式来处理这些步骤:

class ErrorCatchingArgumentParser(argparse.ArgumentParser):
    def exit(self, status=0, message=None):
        if status:
            raise Exception(f'Exiting because of an error: {message}')
        exit(status)

ArgumentParser.error(message)

此方法将向标准错误打印包括 message 的用法消息并附带状态码 2 终结程序。

混合解析

ArgumentParser.parse_intermixed_args(args=None, namespace=None)

ArgumentParser.parse_known_intermixed_args(args=None, namespace=None)

许多 Unix 命令允许用户混用可选参数与位置参数。 parse_intermixed_args() 和 parse_known_intermixed_args() 方法均支持这种解析风格。

这些解析器并不支持所有的 argparse 特性，并且当未支持的特性被使用时将会引发异常。 特别地，子解析器，argparse.REMAINDER 以及同时包括可选与位置参数的互斥分组是不受支持的。

下面的例子显示了 parse_known_args() 与 parse_intermixed_args() 之间的差异：前者会将 ['2', '3'] 返回为未解析的参数，而后者会将所有位置参数收集至 rest 中。

>>> 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])

parse_known_intermixed_args() 返回由两个条目组成的元组，其中包含带成员的命名空间以及剩余参数字符串列表。 当存在任何剩余的未解析参数字符串时 parse_intermixed_args() 将引发一个错误。

3.7 新版功能.

升级 optparse 代码

起初，argparse 曾经尝试通过 optparse 来维持兼容性。 但是，optparse 很难透明地扩展，特别是那些为支持新的 nargs= 描述方式和更好的用法消息所需的修改。当When most everything in optparse 中几乎所有内容都已被复制粘贴或打上补丁时，维持向下兼容看来已是不切实际的。

argparse 模块在许多方面对标准库的 optparse 模块进行了增强，包括:

处理位置参数。

支持子命令。

允许替代选项前缀例如 + 和 /。

处理零个或多个以及一个或多个风格的参数。

生成更具信息量的用法消息。

提供用于定制 type 和 action 的更为简单的接口。

从 optparse 到 argparse 的部分升级路径:

将所有 optparse.OptionParser.add_option() 调用替换为 ArgumentParser.add_argument() 调用。

将 (options, args) = parser.parse_args() 替换为 args = parser.parse_args() 并为位置参数添加额外的 ArgumentParser.add_argument() 调用。 请注意之前所谓的 options 在 argparse 上下文中被称为 args。

通过使用 parse_intermixed_args() 而非 parse_args() 来替换 optparse.OptionParser.disable_interspersed_args()。

将回调动作和 callback_* 关键字参数替换为 type 或 action 参数。

将 type 关键字参数字符串名称替换为相应的类型对象（例如 int, float, complex 等）。

将 optparse.Values 替换为 Namespace 并将 optparse.OptionError 和 optparse.OptionValueError 替换为 ArgumentError。

将隐式参数字符串例如使用标准 Python 字典语法的 %default 或 %prog 替换为格式字符串，即 %(default)s 和 %(prog)s。

将 OptionParser 构造器 version 参数替换为对 parser.add_argument('--version', action='version', version='<the version>') 的调用。

getopt --- C 风格的命令行选项解析器

源代码: Lib/getopt.py [https://github.com/python/cpython/tree/3.10/Lib/getopt.py]

注解

getopt 模块是一个命令行选项解析器，其 API 设计会让 C getopt() 函数的用户感到熟悉。 不熟悉 C getopt() 函数或者希望写更少代码并获得更完善帮助和错误消息的用户应当考虑改用 argparse 模块。

此模块可协助脚本解析 sys.argv 中的命令行参数。 它支持与 Unix getopt() 函数相同的惯例（包括形式如 '-' 与 '--' 的参数的特殊含义）。 也能通过可选的第三个参数来使用与 GNU 软件所支持形式相类似的长选项。

此模块提供了两个函数和一个异常:

getopt.getopt(args, shortopts, longopts=[])

解析命令行选项与形参列表。 args 为要解析的参数列表，不包含最开头的对正在运行的程序的引用。 通常这意味着 sys.argv[1:]。 shortopts 为脚本所要识别的字母选项，包含要求后缀一个冒号 (':'；即与 Unix getopt() 所用的格式相同) 的选项。

注解

与 GNU getopt() 不同，在非选项参数之后，所有后续参数都会被视为非选项。 这类似于非 GNU Unix 系统的运作方式。

如果指定了 longopts，则必须为一个由应当被支持的长选项名称组成的列表。 开头的 '--' 字符不应被包括在选项名称中。 要求参数的长选项后应当带一个等号 ('=')。 可选参数不被支持。 如果想仅接受长选项，则 shortopts 应为一个空字符串。 命令行中的长选项只要提供了恰好能匹配可接受选项之一的选项名称前缀即可被识别。 举例来说，如果 longopts 为 ['foo', 'frob']，则选项 --fo 将匹配为 --foo，但 --f 将不能得到唯一匹配，因此将引发 GetoptError。

返回值由两个元素组成：第一个是 (option, value) 对的列表；第二个是在去除该选项列表后余下的程序参数列表（这也就是 args 的尾部切片）。每个被返回的选项与值对的第一个元素是选项，短选项前缀一个连字符 (例如 '-x')，长选项则前缀两个连字符 (例如 '--long-option')，第二个元素是选项参数，如果选项不带参数则为空字符串。 列表中选项的排列顺序与它们被解析的顺序相同，因此允许多次出现。 长选项与短选项可以混用。

getopt.gnu_getopt(args, shortopts, longopts=[])

此函数与 getopt() 类似，区别在于它默认使用 GNU 风格的扫描模式。 这意味着选项和非选项参数可能会混在一起。 getopt() 函数将在遇到非选项参数时立即停止处理选项。

如果选项字符串的第一个字符为 '+'，或者如果设置了环境变量 POSIXLY_CORRECT，则选项处理会在遇到非选项参数时立即停止。

exception getopt.GetoptError

This is raised当参数列表中出现不可识别的选项或者当一个需要参数的选项未带参数时将引发此异常。 此异常的参数是一个指明错误原因的字符串。 对于长选项，将一个参数传给不需要参数的选项也将导致引发此异常。 msg 和 opt 属性会给出错误消息和关联的选项；如果没有关联到异常的特定选项，则 opt 将为空字符串。

exception getopt.error

GetoptError 的别名；用于向后兼容。

一个仅使用 Unix 风格选项的例子:

>>> 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', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')]
>>> args
['a1', 'a2']

使用长选项名也同样容易:

>>> 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', ''), ('--output-file', 'abc.def'), ('-x', '')]
>>> args
['a1', 'a2']

在脚本中，典型的用法类似这样:

import getopt, sys

def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])
    except getopt.GetoptError as err:
        # print help information and exit:
        print(err)  # will print something like "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"
    # ...

if __name__ == "__main__":
    main()

请注意通过 argparse 模块可以使用更少的代码并附带更详细的帮助与错误消息生成等价的命令行接口:

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    args = parser.parse_args()
    # ... do something with args.output ...
    # ... do something with args.verbose ..

参见

模块 argparse

替代的命令行选项和参数解析库。

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

源代码： Lib/logging/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/logging/__init__.py]

Important

此页面仅包含 API 参考信息。教程信息和更多高级用法的讨论，请参阅

基础教程

进阶教程

日志记录操作手册

这个模块为应用与库实现了灵活的事件日志系统的函数与类。

使用标准库提供的 logging API 最主要的好处是，所有的 Python 模块都可能参与日志输出，包括你自己的日志消息和第三方模块的日志消息。

最简单的例子：

>>> import logging
>>> logging.warning('Watch out!')
WARNING:root:Watch out!

这个模块提供许多强大而灵活的功能。如果对 logging 不太熟悉， 掌握它最好的方式就是查看它对应的教程（详见右侧的链接）。

该模块定义的基础类和函数都列在下面。

记录器暴露了应用程序代码直接使用的接口。

处理器将日志记录（由记录器创建）发送到适当的目标。

过滤器提供了更细粒度的功能，用于确定要输出的日志记录。

格式器指定最终输出中日志记录的样式。

记录器对象

记录器有以下的属性和方法。注意 永远 不要直接实例化记录器，应当通过模块级别的函数 logging.getLogger(name) 。多次使用相同的名字调用 getLogger() 会一直返回相同的 Logger 对象的引用。

name 一般是句点分割的层级值, 像 foo.bar.baz (尽管也可以只是普通的 foo)。层次结构列表中位于下方的记录器是列表中较高位置的记录器的子级。例如，有个名叫 foo 的记录器，而名字是 foo.bar， foo.bar.baz，和 foo.bam 的记录器都是 foo 的子级。记录器的名字分级类似 Python 包的层级，如果您使用建议的结构 logging.getLogger(__name__) 在每个模块的基础上组织记录器，则与之完全相同。这是因为在模块里， __name__ 是该模块在 Python 包命名空间中的名字。

class logging.Logger

propagate

如果这个属性为真，记录到这个记录器的事件除了会发送到此记录器的所有处理程序外，还会传递给更高级别（祖先）记录器的处理器，此外任何关联到这个记录器的处理器。消息会直接传递给祖先记录器的处理器 —— 不考虑祖先记录器的级别和过滤器。

如果为假，记录消息将不会传递给当前记录器的祖先记录器的处理器。

举例说明：如果名为 A.B.C 的记录器的传播属性求值为真，则任何通过调用诸如 logging.getLogger('A.B.C').error(...) 之类的方法记录到 A.B.C 的事件，在第一次被传递到 A.B.C 上附加的处理器后，将[取决于传递该记录器的级别和过滤器设置]依次传递给附加到名为 A.B，A 的记录器和根记录器的所有处理器。如果 A.B.C、A.B、A 组成的链中，任一记录器的 propagate 属性设置为假，那么这将是最后一个其处理器会收到事件的记录器，此后传播在该点停止。

构造器将这个属性初始化为 True。

注解

如果你将一个处理器附加到一个记录器 和 其一个或多个祖先记录器，它可能发出多次相同的记录。通常，您不需要将一个处理器附加到一个以上的记录器上 —— 如果您将它附加到记录器层次结构中最高的适当记录器上，则它将看到所有后代记录器记录的所有事件，前提是它们的传播设置保留为 True。一种常见的方案是仅将处理器附加到根记录器，通过传播来处理其余部分。

setLevel(level)

给记录器设置阈值为 level 。日志等级小于 level 会被忽略。严重性为 level 或更高的日志消息将由该记录器的任何一个或多个处理器发出，除非将处理器的级别设置为比 level 更高的级别。

创建记录器时，级别默认设置为 NOTSET （当记录器是根记录器时，将处理所有消息；如果记录器不是根记录器，则将委托给父级）。请注意，根记录器的默认级别为 WARNING 。

委派给父级的意思是如果一个记录器的级别设置为 NOTSET，将遍历其祖先记录器，直到找到级别不是 NOTSET 的记录器，或者到根记录器为止。

如果发现某个父级的级别不是 NOTSET ，那么该父级的级别将被视为发起搜索的记录器的有效级别，并用于确定如何处理日志事件。

如果搜索到达根记录器，并且其级别为 NOTSET，则将处理所有消息。否则，将使用根记录器的级别作为有效级别。

参见 日志级别 级别列表。

在 3.2 版更改: 现在 level 参数可以接受形如 'INFO' 的级别字符串表示形式，以代替形如 INFO 的整数常量。 但是请注意，级别在内部存储为整数，并且 getEffectiveLevel() 和 isEnabledFor() 等方法的传入/返回值也为整数。

isEnabledFor(level)

指示此记录器是否将处理级别为 level 的消息。此方法首先检查由 logging.disable(level) 设置的模块级的级别，然后检查由 getEffectiveLevel() 确定的记录器的有效级别。

getEffectiveLevel()

指示此记录器的有效级别。如果通过 setLevel() 设置了除 NOTSET 以外的值，则返回该值。否则，将层次结构遍历到根，直到找到除 NOTSET 以外的其他值，然后返回该值。返回的值是一个整数，通常为 logging.DEBUG、 logging.INFO 等等。

getChild(suffix)

返回由后缀确定的该记录器的后代记录器。 因此，logging.getLogger('abc').getChild('def.ghi') 与 logging.getLogger('abc.def.ghi') 将返回相同的记录器。 这是一个便捷方法，当使用如 __name__ 而不是字符串字面值命名父记录器时很有用。

3.2 新版功能.

debug(msg, *args, **kwargs)

在此记录器上记录 DEBUG 级别的消息。 msg 是消息格式字符串，而 args 是用于字符串格式化操作合并到 msg 的参数。（请注意，这意味着您可以在格式字符串中使用关键字以及单个字典参数。）当未提供 args 时，不会对 msg 执行 ％ 格式化操作。

在 kwargs 中会检查四个关键字参数： exc_info ，stack_info ，stacklevel 和 extra 。

如果 exc_info 的求值结果不为 false ，则它将异常信息添加到日志消息中。如果提供了一个异常元组（按照 sys.exc_info() 返回的格式）或一个异常实例，则它将被使用；否则，调用 sys.exc_info() 以获取异常信息。

第二个可选关键字参数是 stack_info，默认为 False。如果为 True，则将堆栈信息添加到日志消息中，包括实际的日志调用。请注意，这与通过指定 exc_info 显示的堆栈信息不同：前者是从堆栈底部到当前线程中的日志记录调用的堆栈帧，而后者是在搜索异常处理程序时，跟踪异常而打开的堆栈帧的信息。

您可以独立于 exc_info 来指定 stack_info，例如，即使在未引发任何异常的情况下，也可以显示如何到达代码中的特定点。堆栈帧在标题行之后打印：

Stack (most recent call last):

这模仿了显示异常帧时所使用的 Traceback (most recent call last): 。

第三个可选关键字参数是 stacklevel ，默认为 1 。如果大于 1 ，则在为日志记录事件创建的 LogRecord 中计算行号和函数名时，将跳过相应数量的堆栈帧。可以在记录帮助器时使用它，以便记录的函数名称，文件名和行号不是帮助器的函数/方法的信息，而是其调用方的信息。此参数是 warnings 模块中的同名等效参数。

第四个关键字参数是 extra ，传递一个字典，该字典用于填充为日志记录事件创建的、带有用户自定义属性的 LogRecord 中的 __dict__ 。然后可以按照需求使用这些自定义属性。例如，可以将它们合并到已记录的消息中：

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)

输出类似于

2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

在The keys in the dictionary passed in extra 传入的字典的键不应与日志系统所使用的键相冲突。 （请参阅 LogRecord 属性 一节了解有关日志系统所使用的键的更多信息。）

如果在已记录的消息中使用这些属性，则需要格外小心。例如，在上面的示例中，Formatter 已设置了格式字符串，其在 LogRecord 的属性字典中键值为 “clientip” 和 “user”。如果缺少这些内容，则将不会记录该消息，因为会引发字符串格式化异常。因此，在这种情况下，您始终需要使用 extra 字典传递这些键。

尽管这可能很烦人，但此功能旨在用于特殊情况，例如在多个上下文中执行相同代码的多线程服务器，并且出现的有趣条件取决于此上下文（例如在上面的示例中就是远程客户端IP地址和已验证用户名）。在这种情况下，很可能将专门的 Formatter 与特定的 Handler 一起使用。

如果没有处理器附加到这个记录器（或者它的任何父辈记录器，考虑到相关的 Logger.propagate 属性），消息将被发送到设置在 lastResort 的处理器。

在 3.2 版更改: 增加了 stack_info 参数。

在 3.5 版更改: exc_info 参数现在可以接受异常实例。

在 3.8 版更改: 增加了 stacklevel 参数。

info(msg, *args, **kwargs)

在此记录器上记录 INFO 级别的消息。参数解释同 debug()。

warning(msg, *args, **kwargs)

在此记录器上记录 WARNING 级别的消息。参数解释同 debug()。

注解

有一个功能上与 warning 一致的方法 warn。由于 warn 已被弃用，请不要使用它 —— 改为使用 warning。

error(msg, *args, **kwargs)

在此记录器上记录 ERROR 级别的消息。参数解释同 debug()。

critical(msg, *args, **kwargs)

在此记录器上记录 CRITICAL 级别的消息。参数解释同 debug()。

log(level, msg, *args, **kwargs)

在此记录器上记录 level 整数代表的级别的消息。参数解释同 debug()。

exception(msg, *args, **kwargs)

在此记录器上记录 ERROR 级别的消息。参数解释同 debug()。异常信息将添加到日志消息中。仅应从异常处理程序中调用此方法。

addFilter(filter)

将指定的过滤器 filter 添加到此记录器。

removeFilter(filter)

从此记录器中删除指定的过滤器 filter。

filter(record)

将此记录器的过滤器应用于记录，如果记录能被处理则返回 True。过滤器会被依次使用，直到其中一个返回假值为止。如果它们都不返回假值，则记录将被处理（传递给处理器）。如果返回任一为假值，则不会对该记录做进一步处理。

addHandler(hdlr)

将指定的处理器 hdlr 添加到此记录器。

removeHandler(hdlr)

从此记录器中删除指定的处理器 hdlr。

findCaller(stack_info=False, stacklevel=1)

查找调用源的文件名和行号，以 文件名，行号，函数名称和堆栈信息 4元素元组的形式返回。堆栈信息将返回 None，除非 stack_info 为 True。

stacklevel 参数用于调用 debug() 和其他 API。如果大于 1，则多余部分将用于跳过堆栈帧，然后再确定要返回的值。当从帮助器/包装器代码调用日志记录 API 时，这通常很有用，以便事件日志中的信息不是来自帮助器/包装器代码，而是来自调用它的代码。

handle(record)

通过将记录传递给与此记录器及其祖先关联的所有处理器来处理（直到某个 propagate 值为 false）。此方法用于从套接字接收的未序列化的以及在本地创建的记录。使用 filter() 进行记录器级别过滤。

makeRecord(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)

这是一种工厂方法，可以在子类中对其进行重写以创建专门的 LogRecord 实例。

hasHandlers()

检查此记录器是否配置了任何处理器。通过在此记录器及其记录器层次结构中的父级中查找处理器完成此操作。如果找到处理器则返回 True，否则返回 False。只要找到 “propagate” 属性设置为假值的记录器，该方法就会停止搜索层次结构 —— 其将是最后一个检查处理器是否存在的记录器。

3.2 新版功能.

在 3.7 版更改: 现在可以对处理器进行序列化和反序列化。

日志级别

日志记录级别的数值在下表中给出。如果你想要定义自己的级别，并且需要它们具有相对于预定义级别的特定值，那么这你可能对以下内容感兴趣。如果你定义具有相同数值的级别，它将覆盖预定义的值；预定义的名称将失效。

级别 | 数值
CRITICAL | 50
ERROR | 40
WARNING | 30
INFO | 20
DEBUG | 10
NOTSET | 0

处理器对象

Handler 有以下属性和方法。注意不要直接实例化 Handler ；这个类用来派生其他更有用的子类。但是，子类的 __init__() 方法需要调用 Handler.__init__() 。

class logging.Handler

__init__(level=NOTSET)

初始化 Handler 实例时，需要设置它的级别，将过滤列表置为空，并且创建锁（通过 createLock() ）来序列化对 I/O 的访问。

createLock()

初始化一个线程锁，用来序列化对底层的 I/O 功能的访问，底层的 I/O 功能可能不是线程安全的。

acquire()

获取由 createLock() 创建的线程锁。

release()

释放由 acquire() 获取的线程锁。

setLevel(level)

给处理器设置阈值为 level 。日志级别小于 level 将被忽略。创建处理器时，日志级别被设置为 NOTSET （所有的消息都会被处理）。

参见 日志级别 级别列表。

在 3.2 版更改: level 形参现在接受像 'INFO' 这样的字符串形式的级别表达方式，也可以使用像 INFO 这样的整数常量。

setFormatter(fmt)

将此处理器的 Formatter 设置为 fmt。

addFilter(filter)

将指定的过滤器 filter 添加到此处理器。

removeFilter(filter)

从此处理器中删除指定的过滤器 filter 。

filter(record)

将此处理器的过滤器应用于记录，在要处理记录时返回 True 。依次查询过滤器，直到其中一个返回假值为止。如果它们都不返回假值，则将发出记录。如果返回一个假值，则处理器将不会发出记录。

flush()

确保所有日志记录从缓存输出。此版本不执行任何操作，并且应由子类实现。

close()

回收处理器使用的所有资源。此版本不输出，但从内部处理器列表中删除处理器，内部处理器在 shutdown() 被调用时关闭 。子类应确保从重写的 close() 方法中调用此方法。

handle(record)

经已添加到处理器的过滤器过滤后，有条件地发出指定的日志记录。用获取/释放 I/O 线程锁包装了记录的实际发出行为。

handleError(record)

调用 emit() 期间遇到异常时，应从处理器中调用此方法。如果模块级属性 raiseExceptions 是 False，则异常将被静默忽略。这是大多数情况下日志系统需要的 —— 大多数用户不会关心日志系统中的错误，他们对应用程序错误更感兴趣。但是，你可以根据需要将其替换为自定义处理器。指定的记录是发生异常时正在处理的记录。（raiseExceptions 的默认值是 True，因为这在开发过程中是比较有用的）。

format(record)

如果设置了格式器则用其对记录进行格式化。否则，使用模块的默认格式器。

emit(record)

执行实际记录给定日志记录所需的操作。这个版本应由子类实现，因此这里直接引发 NotImplementedError 异常。

警告

此方法会在获得一个处理器层级的锁之后被调用，在此方法返回之后锁将被释放。 当你重写此方法时，请注意在调用任何可能执行锁定操作的日志记录 API 的其他部分的方法时务必小心谨慎，因为这可能会导致死锁。 具体来说:

日志记录配置 API 会获取模块层级锁，然后还会在配置处理器时获取处理器层级锁。

许多日志记录 API 都会锁定模块级锁。 如果这样的 API 在此方法中被调用，则它可能会在另一个线程执行配置调用时导致死锁，因为那个线程将试图在处理器级锁 之前 获取模块级锁，而这个线程将试图在处理器级锁 之后 获取模块级锁（因为在此方法中，处理器级锁已经被获取了）。

有关作为标准随附的处理器列表，请参见 logging.handlers。

格式器对象

Formatter 对象拥有以下的属性和方法。一般情况下，它们负责将 LogRecord 转换为可由人或外部系统解释的字符串。基础的 Formatter 允许指定格式字符串。如果未提供任何值，则使用默认值 '%(message)s' ，它仅将消息包括在日志记录调用中。要在格式化输出中包含其他信息（如时间戳），请阅读下文。

格式器可以使用格式化字符串来初始化，该字符串利用 LogRecord 的属性 —— 例如上述默认值，用户的消息和参数预先格式化为 LogRecord 的 message 属性后被使用。此格式字符串包含标准的 Python %-s 样式映射键。有关字符串格式的更多信息，请参见 printf 风格的字符串格式化。

LogRecord 属性 一节中给出了 LogRecord 中有用的映射键。

class logging.Formatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

返回 Formatter 类的新实例。实例将使用整个消息的格式字符串以及消息的日期/时间部分的格式字符串进行初始化。如果未指定 fmt ，则使用 '%(message)s'。如果未指定 datefmt，则使用 formatTime() 文档中描述的格式。

style 形参可以是 '%', '{' 或 '$' 之一，它决定格式字符串将如何与数据进行合并：使用 %-formatting, str.format() 或是 string.Template。 这仅适用于格式字符串 fmt (例如 '%(message)s' 或 {message})，不适用于传递给 Logger.debug 的实际日志消息等；请参阅 生效于整个应用程序的格式化样式 了解有关在日志消息中使用 {- 和 $-formatting 的更多详情。

defaults 形参可以是一个包含在自定义字段中使用的默认值的字典。 例如: logging.Formatter('%(ip)s %(message)s', defaults={"ip": None})

在 3.2 版更改: 加入了 style 形参。

在 3.8 版更改: 加入*validate* 参数。不正确或不匹配的样式和格式将引发 ValueError 错误。例如: logging.Formatter('%(asctime)s - %(message)s', style='{')。

在 3.10 版更改: 增加了 defaults 形参。

format(record)

记录的属性字典被用作字符串格式化操作的操作数。 返回结果字符串。 在格式化该字典之前，会执行几个预备步骤。 记录的 message 属性是用 msg % args 来计算的。 如果格式化字符串包含 '(asctime)'，则会调用 formatTime() 来格式化事件时间。 如果有异常信息，则使用 formatException() 将其格式化并添加到消息中。 请注意已格式化的异常信息会缓存在 exc_text 属性中。 这很有用因为异常信息可以被 pickle 并通过网络发送，但是如果你有不止一个对异常信息进行定制的 Formatter 子类则应当小心。 在这种情况下，你必须在一个格式化器完成格式化后清空缓存的值 (通过将 exc_text 属性设为 None)，以便下一个处理事件的格式化器不会使用缓存的值，而是重新计算它。

如果栈信息可用，它将被添加在异常信息之后，如有必要请使用 formatStack() 来转换它。

formatTime(record, datefmt=None)

此方法应由想要使用格式化时间的格式器中的 format() 调用。可以在格式器中重写此方法以提供任何特定要求，但是基本行为如下：如果指定了 datefmt （字符串），则将其用于 time.strftime() 来格式化记录的创建时间。否则，使用格式 '%Y-%m-%d %H:%M:%S,uuu'，其中 uuu 部分是毫秒值，其他字母根据 time.strftime() 文档。这种时间格式的示例为 2003-01-23 00:29:50,411。返回结果字符串。

此函数使用一个用户可配置函数将创建时间转换为元组。 默认情况下，使用 time.localtime()；要为特定格式化程序实例更改此项，请将实例的 converter 属性设为具有与 time.localtime() 或 time.gmtime() 相同签名的函数。 要为所有格式化程序更改此项，例如当你希望所有日志时间都显示为 GMT，请在 Formatter 类中设置 converter 属性。

在 3.3 版更改: 在之前版本中，默认格式是被硬编码的，例如这个例子: 2010-09-06 22:38:15,292 其中逗号之前的部分由 strptime 格式字符串 ('%Y-%m-%d %H:%M:%S') 处理，而逗号之后的部分为毫秒值。 因为 strptime 没有表示毫秒的占位符，毫秒值使用了另外的格式字符串来添加 '%s,%03d' --- 这两个格式字符串代码都是硬编码在该方法中的。 经过修改，这些字符串被定义为类层级的属性，当需要时可以在实例层级上被重写。 属性的名称为 default_time_format (用于 strptime 格式字符串) 和 default_msec_format (用于添加毫秒值)。

在 3.9 版更改: default_msec_format 可以为 None。

formatException(exc_info)

将指定的异常信息（由 sys.exc_info() 返回的标准异常元组）格式化为字符串。默认实现只是使用了 traceback.print_exception()。 结果字符串将被返回。

formatStack(stack_info)

将指定的堆栈信息（由 traceback.print_stack() 返回的字符串，但移除末尾的换行符）格式化为字符串。 默认实现只是返回输入值。

class logging.BufferingFormatter(linefmt=None)

适合用来在你想要格式化多条记录时进行子类化的格式化器。 你可以传入一个 Formatter 实例用来格式化每一行（每一行对应一条记录）。 如果未被指定，则会使用默认的格式化器（仅输出事件消息）作为行格式化器。

formatHeader(records)

为 records 列表返回一个标头。 基本实现只是返回空字符串。 如果你想要指明特定行为则需要重写此方法，例如显示记录条数、标题或分隔行等。

formatFooter(records)

为 records 列表返回一个结束标记。 基本实现只是返回空字符串。 如果你想要指明特定行为则需要重写此方法，例如显示记录条数或分隔行等。

format(records)

为 records 列表返回已格式化文本。 基本实现在没有记录时只是返回空字符串；在其他情况下，它将返回标头、使用行格式化器执行格式化的每行记录以及结束标记。

过滤器对象

Filters 可被 Handlers 和 Loggers 用来实现比按层级提供更复杂的过滤操作。 基本过滤器类只允许低于日志记录器层级结构中低于特定层级的事件。 例如，一个用 'A.B' 初始化的过滤器将允许 'A.B', 'A.B.C', 'A.B.C.D', 'A.B.D' 等日志记录器所记录的事件。 但 'A.BB', 'B.A.B' 等则不允许。 如果用空字符串初始化，则所有事件都会通过。

class logging.Filter(name='')

返回一个 Filter 类的实例。 如果指定了 name，则它将被用来为日志记录器命名，该类及其子类将通过该过滤器允许指定事件通过。 如果 name 为空字符串，则允许所有事件通过。

filter(record)

是否要记录指定的记录？返回零表示否，非零表示是。如果认为合适，则可以通过此方法就地修改记录。

请注意关联到处理器的过滤器会在事件由处理器发出之前被查询，而关联到日志记录器的过滤器则会在有事件被记录的的任何时候（使用 debug(), info() 等等）在将事件发送给处理器之前被查询。 这意味着由后代日志记录器生成的事件将不会被父代日志记录器的过滤器设置所过滤，除非该过滤器也已被应用于后代日志记录器。

你实际上不需要子类化 Filter ：你可以传入任何一个包含有相同语义的 filter 方法的实例。

在 3.2 版更改: 你不需要创建专门的 Filter 类，或使用具有 filter 方法的其他类：你可以使用一个函数（或其他可调用对象）作为过滤器。 过滤逻辑将检查过滤器对象是否具有 filter 属性：如果有，就会将它当作是 Filter 并调用它的 filter() 方法。 在其他情况下，则会将它当作是可调用对象并将记录作为唯一的形参进行调用。 返回值应当与 filter() 的返回值相一致。

尽管过滤器主要被用来构造比层级更复杂的规则以过滤记录，但它们可以查看由它们关联的处理器或记录器所处理的每条记录：当你想要执行统计特定记录器或处理器共处理了多少条记录，或是在所处理的 LogRecord 中添加、修改或移除属性这样的任务时该特性将很有用处。 显然改变 LogRecord 时需要相当小心，但将上下文信息注入日志确实是被允许的 (参见 使用过滤器传递上下文信息)。

LogRecord 属性

LogRecord 实例是每当有日志被记录时由 Logger 自动创建的，并且可通过 makeLogRecord() 手动创建（例如根据从网络接收的已封存事件创建）。

class logging.LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)

包含与被记录的事件相关的所有信息。

主要信息是在 msg 中 args 传递的，它们使用 msg % args 组合到一起以创建记录的 message 属性。

参数

name (str) -- 用于记录此 LogRecord 所表示事件的记录器名称。 请注意 LogRecord 中的记录器名称将始终为该值，即使它可能是由附加到不同（上级）日志记录器的处理器所发出的。

level (int) -- 日志记录事件的 数字层级 (如 10 表示 DEBUG, 20 表示 INFO 等等)。 请注意这会转换为 LogRecord 的 两个 属性: levelno 表示数字值而 levelname 表示对应的层级名。

pathname (str) -- 日志记录调用所在源文件的完整路径字符串。

lineno (int) -- 记录调用所在源文件中的行号。

msg (typing.Any) -- 事件描述消息，这可以是一个带有 % 形式可变数据占位符的格式字符串，或是任意对象 (参见 使用任意对象作为消息)。

args (tuple | dict[str, typing.Any]) -- 要合并到 msg 参数以获得事件描述的可变数据。

exc_info (tuple[type[BaseException], BaseException, types.TracebackType] | None) -- 包含当前异常信息的异常元组，就如 sys.exc_info() 所返回的，或者如果没有可用异常信息则为 None。

func (str | None) -- 唤起日志记录调用的函数或方法名称。

sinfo (str | None) -- 一个文本字符串，表示当前线程中从堆栈底部直到日志记录调用的堆栈信息。

getMessage()

在将 LogRecord 实例与任何用户提供的参数合并之后，返回此实例的消息。 如果用户提供给日志记录调用的消息参数不是字符串，则会在其上调用 str() 以将它转换为字符串。 此方法允许将用户定义的类用作消息，类的 __str__ 方法可以返回要使用的实际格式字符串。

在 3.2 版更改: 通过提供用于创建记录的工厂方法已使得 LogRecord 的创建更易于配置。 该工厂方法可使用 getLogRecordFactory() 和 setLogRecordFactory() （在此可查看工厂方法的签名）来设置。

在创建时可使用此功能将你自己的值注入 LogRecord。 你可以使用以下模式:

old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)

通过此模式，多个工厂方法可以被链接起来，并且只要它们不重写彼此的属性或是在无意中覆盖了上面列出的标准属性，就不会发生意外。

LogRecord 属性

LogRecord 具有许多属性，它们大多数来自于传递给构造器的形参。 （请注意 LogRecord 构造器形参与 LogRecord 属性的名称并不总是完全彼此对应的。） 这些属性可被用于将来自记录的数据合并到格式字符串中。 下面的表格（按字母顺序）列出了属性名称、它们的含义以及相应的 %-style 格式字符串内占位符。

如果是使用 {}-格式化（str.format()），你可以将 {attrname} 用作格式字符串内的占位符。 如果是使用 $-格式化（string.Template），则会使用 ${attrname} 的形式。 当然在这两种情况下，都应当将 attrname 替换为你想要使用的实际属性名称。

在 {}-格式化的情况下，你可以在属性名称之后放置指定的格式化旗标，并用冒号来分隔两者。 例如，占位符 {msecs:03d} 会将毫秒值 4 格式化为 004。 请参看 str.format() 文档了解你所能使用的选项的完整细节。

属性名称 | 格式 | 描述
args | 此属性不需要用户进行格式化。 | 合并到 msg 以产生 message 的包含参数的元组，或是其中的值将被用于合并的字典（当只有一个参数且其类型为字典时）。
asctime | %(asctime)s | 表示人类易读的 LogRecord 生成时间。 默认形式为 '2003-07-08 16:49:45,896' （逗号之后的数字为时间的毫秒部分）。
created | %(created)f | LogRecord 被创建的时间（即 time.time() 的返回值）。
exc_info | 此属性不需要用户进行格式化。 | 异常元组（例如 sys.exc_info）或者如未发生异常则为 None。
文件名 | %(filename)s | pathname 的文件名部分。
funcName | %(funcName)s | 函数名包括调用日志记录.
levelname | %(levelname)s | 消息文本记录级别（'DEBUG'，'INFO'，'WARNING'，'ERROR'，'CRITICAL'）。
levelno | %(levelno)s | 消息数字的记录级别 (DEBUG, INFO, WARNING, ERROR, CRITICAL).
lineno | %(lineno)d | 发出日志记录调用所在的源行号（如果可用）。
message | %(message)s | 记入日志的消息，即 msg % args 的结果。 这是在唤起 Formatter.format() 时设置的。
module | %(module)s | 模块 (filename 的名称部分)。
msecs | %(msecs)d | LogRecord 被创建的时间的毫秒部分。
msg | 此属性不需要用户进行格式化。 | 在原始日志记录调用中传入的格式字符串。 与 args 合并以产生 message，或是一个任意对象 (参见 使用任意对象作为消息)。
name | %(name)s | 用于记录调用的日志记录器名称。
pathname | %(pathname)s | 发出日志记录调用的源文件的完整路径名（如果可用）。
process | %(process)d | 进程ID（如果可用）
processName | %(processName)s | 进程名（如果可用）
relativeCreated | %(relativeCreated)d | 以毫秒数表示的 LogRecord 被创建的时间，即相对于 logging 模块被加载时间的差值。
stack_info | 此属性不需要用户进行格式化。 | 当前线程中从堆栈底部起向上直到包括日志记录调用并引发创建当前记录堆栈帧创建的堆栈帧信息（如果可用）。
thread | %(thread)d | 线程ID（如果可用）
threadName | %(threadName)s | 线程名（如果可用）

在 3.1 版更改: 添加了 processName

LoggerAdapter 对象

LoggerAdapter 实例会被用来方便地将上下文信息传入日志记录调用。 要获取用法示例，请参阅 添加上下文信息到你的日志记录输出 部分。

class logging.LoggerAdapter(logger, extra)

返回一个 LoggerAdapter 的实例，该实例的初始化使用了下层的 Logger 实例和一个字典类对象。

process(msg, kwargs)

修改传递给日志记录调用的消息和/或关键字参数以便插入上下文信息。 此实现接受以 extra 形式传给构造器的对象并使用 'extra' 键名将其加入 kwargs。 返回值为一个 (msg, kwargs) 元组，其包含（可能经过修改的）传入参数。

在上述方法之外，LoggerAdapter 还支持 Logger 的下列方法: debug(), info()，warning()，error(), exception(), critical()，log()，isEnabledFor()，getEffectiveLevel()，setLevel() 以及 hasHandlers()。 这些方法具有与它们在 Logger 中的对应方法相同的签名，因此你可以互换使用这两种类型的实例。

在 3.2 版更改: isEnabledFor(), getEffectiveLevel(), setLevel() 和 hasHandlers() 方法已被添加到 LoggerAdapter。 这些方法会委托给下层的日志记录器。

在 3.6 版更改: 增加了 manager 属性和 _log() 方法，它们会委托给下层的日志记录器并允许适配器嵌套。

线程安全

logging 模块的目标是使客户端不必执行任何特殊操作即可确保线程安全。 它通过使用线程锁来达成这个目标；用一个锁来序列化对模块共享数据的访问，并且每个处理程序也会创建一个锁来序列化对其下层 I/O 的访问。

如果你要使用 signal 模块来实现异步信号处理程序，则可能无法在这些处理程序中使用 logging。 这是因为 threading 模块中的锁实现并非总是可重入的，所以无法从此类信号处理程序唤起。

模块级函数

在上述的类之外，还有一些模块级的函数。

logging.getLogger(name=None)

返回具有指定 name 的日志记录器，或者当 name 为 None 时返回层级结构中的根日志记录器。 如果指定了 name，它通常是以点号分隔的带层级结构的名称，如 'a'、'a.b' 或 'a.b.c.d'。 这些名称的选择完全取决于使用 logging 的开发者。

所有用给定的 name 对该函数的调用都将返回相同的日志记录器实例。 这意味着日志记录器实例不需要在应用的各部分间传递。

logging.getLoggerClass()

返回标准的 Logger 类，或是最近传给 setLoggerClass() 的类。 此函数可以从一个新的类定义中调用，以确保安装自定义的 Logger 类不会撤销其他代码已经应用的自定义操作。 例如:

class MyLogger(logging.getLoggerClass()):
    # ... override behaviour here

logging.getLogRecordFactory()

返回一个被用来创建 LogRecord 的可调用对象。

3.2 新版功能: 此函数与 setLogRecordFactory() 一起提供，以允许开发者对表示日志记录事件的 LogRecord 的构造有更好的控制。

请参阅 setLogRecordFactory() 了解有关如何调用该工厂方法的更多信息。

logging.debug(msg, *args, **kwargs)

在根日志记录器上记录一条 DEBUG 级别的消息。 msg 是消息格式字符串，而 args 是要使用字符串格式化运算符合并到 msg 的参数。 （请注意这意味着你可以在格式字符串中使用关键字以及单个字典参数。）

在 kwargs 中有三个关键字参数会被检查: exc_info 参数如果不为假值则会将异常信息添加到日志记录消息。 如果提供了异常元组（为 sys.exc_info() 的返回值格式）或异常实例则它会被使用；在其他情况下，会调用 sys.exc_info() 以获取异常信息。

第二个可选关键字参数是 stack_info，默认为 False。如果为 True，则将堆栈信息添加到日志消息中，包括实际的日志调用。请注意，这与通过指定 exc_info 显示的堆栈信息不同：前者是从堆栈底部到当前线程中的日志记录调用的堆栈帧，而后者是在搜索异常处理程序时，跟踪异常而打开的堆栈帧的信息。

您可以独立于 exc_info 来指定 stack_info，例如，即使在未引发任何异常的情况下，也可以显示如何到达代码中的特定点。堆栈帧在标题行之后打印：

Stack (most recent call last):

这模仿了显示异常帧时所使用的 Traceback (most recent call last): 。

第三个可选关键字参数是 extra，它可被用来传递一个字典，该字典会被用来填充为日志记录事件创建并附带用户自定义属性的 LogRecord 的 __dict__。 之后将可按你的需要使用这些自定义属性。 例如，可以将它们合并到已记录的消息中。 举例来说:

FORMAT = '%(asctime)s %(clientip)-15s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
logging.warning('Protocol problem: %s', 'connection reset', extra=d)

应当会打印出这样的内容:

2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

extra 中传入的字典的键不应与日志系统使用的键冲突。（有关日志系统使用哪些键的更多信息，请参见 Formatter 的文档。）

如果你选择在已记录的消息中使用这些属性，则需要格外小心。 例如在上面的示例中，Formatter 已设置了格式字符串，其在 LogRecord 的属性字典中应有 'clientip' 和 'user'。 如果缺少这些属性，消息将不被记录，因为会引发字符串格式化异常，你始终需要传入带有这些键的 extra 字典。

尽管这可能很烦人，但此功能旨在用于特殊情况，例如在多个上下文中执行相同代码的多线程服务器，并且出现的有趣条件取决于此上下文（例如在上面的示例中就是远程客户端IP地址和已验证用户名）。在这种情况下，很可能将专门的 Formatter 与特定的 Handler 一起使用。

如果根记录器没有任何附加的处理器，此函数（以及 info()、warning()、error() 和 critical()）将调用 basicConfig()。

在 3.2 版更改: 增加了 stack_info 参数。

logging.info(msg, *args, **kwargs)

在根日志记录器上记录一条 INFO 级别的消息。 参数解释同 debug()。

logging.warning(msg, *args, **kwargs)

在根日志记录器上记录一条 WARNING 级别的消息。 参数解释同 debug()。

注解

有一个已过时方法 warn 其功能与 warning 一致。 由于 warn 已被弃用，请不要使用它 —— 而是改用 warning。

logging.error(msg, *args, **kwargs)

在根日志记录器上记录一条 ERROR 级别的消息。 参数解释同 debug()。

logging.critical(msg, *args, **kwargs)

在根日志记录器上记录一条 CRITICAL 级别的消息。 参数解释同 debug()。

logging.exception(msg, *args, **kwargs)

在根日志记录器上记录一条 ERROR 级别的消息。 参数解释同 debug()。 异常信息将被添加到日志消息中。 此函数应当仅从异常处理程序中调用。

logging.log(level, msg, *args, **kwargs)

在根日志记录器上记录一条 level 级别的消息。 其他参数解释同 debug()。

logging.disable(level=CRITICAL)

为所有日志记录器提供重写的级别 level，其优先级高于日志记录器自己的级别。 当需要临时限制整个应用程序中的日志记录输出时，此功能会很有用。 它的效果是禁用所有重要程度为 level 及以下的日志记录调用，因此如果你附带 INFO 值调用它，则所有 INFO 和 DEBUG 事件就会被丢弃，而重要程度为 WARNING 以及上的事件将根据日志记录器的当前有效级别来处理。 如果 logging.disable(logging.NOTSET) 被调用，它将移除这个重写的级别，因此日志记录输出会再次取决于单个日志记录器的有效级别。

请注意如果你定义了任何高于 CRITICAL 的自定义日志级别（并不建议这样做），你就将无法沿用 level 形参的默认值，而必须显式地提供适当的值。

在 3.7 版更改: level 形参默认级别为 CRITICAL。 请参阅 bpo-28524 [https://bugs.python.org/issue?@action=redirect&bpo=28524] 了解此项改变的更多细节。

logging.addLevelName(level, levelName)

在一个内部字典中关联级别 level 与文本 levelName，该字典会被用来将数字级别映射为文本表示形式，例如在 Formatter 格式化消息的时候。 此函数也可被用来定义你自己的级别。 唯一的限制是自定义的所有级别必须使用此函数来注册，级别值必须为正整数并且其应随严重程度而递增。

注解

如果你考虑要定义你自己的级别，请参阅 自定义级别 部分。

logging.getLevelName(level)

返回日志记录级别 level 的字符串表示。

如果 level 为预定义的级别 CRITICAL, ERROR, WARNING, INFO 或 DEBUG 之一则你会得到相应的字符串。 如果你使用 addLevelName() 将级别关联到名称则返回你为 level 所关联的名称。 如果传入了与已定义级别相对应的数字值，则返回对应的字符串表示。

level 形参也接受级别的字符串表示例如 'INFO'。 在这种情况下，此函数将返回级别所对应的数字值。

如果未传入可匹配的数字或字符串值，则返回字符串 'Level %s' % level。

注解

级别在内部以整数表示（因为它们在日志记录逻辑中需要进行比较）。 此函数被用于在整数级别与通过 %(levelname)s 格式描述符方式在格式化日志输出中显示的级别名称之间进行相互的转换 (参见 LogRecord 属性)。

在 3.4 版更改: 在早于 3.4 的 Python 版本中，此函数也可传入一个字符串形式的级别名称，并将返回对应的级别数字值。 此未记入文档的行为被视为是一个错误，并在 Python 3.4 中被移除，但又在 3.4.2 中被恢复以保持向下兼容性。

logging.makeLogRecord(attrdict)

创建并返回一个新的 LogRecord 实例，实例属性由 attrdict 定义。 此函数适用于接受一个通过套接字传输的封存好的 LogRecord 属性字典，并在接收端将其重建为一个 LogRecord 实例。

logging.basicConfig(**kwargs)

通过使用默认的 Formatter 创建一个 StreamHandler 并将其加入根日志记录器来为日志记录系统执行基本配置。 如果没有为根日志记录器定义处理器则 debug(), info(), warning(), error() 和 critical() 等函数将自动调用 basicConfig()。

如果根日志记录器已配置了处理器则此函数将不执行任何操作，除非关键字参数 force 被设为 True。

注解

此函数应当在其他线程启动之前从主线程被调用。 在 2.7.1 和 3.2 之前的 Python 版本中，如果此函数从多个线程被调用，一个处理器（在极少的情况下）有可能被多次加入根日志记录器，导致非预期的结果例如日志中的消息出现重复。

支持以下关键字参数。

格式 | 描述
filename | 使用指定的文件名创建一个 FileHandler，而不是 StreamHandler。
filemode | 如果指定了 filename，则用此 模式 打开该文件。 默认模式为 'a'。
format | 使用指定的格式字符串作为处理器。 默认为属性以冒号分隔的 levelname, name 和 message。
datefmt | 使用指定的日期/时间格式，与 time.strftime() 所接受的格式相同。
style | 如果指定了 format，将为格式字符串使用此风格。 '%', '{' 或 '$' 分别对应于 printf 风格, str.format() 或 string.Template。 默认为 '%'。
level | 设置根记录器级别为指定的 level.
stream | 使用指定的流初始化 StreamHandler。 请注意此参数与 filename 不兼容 —— 如果两者同时存在，则会引发 ValueError。
handlers | 如果指定，这应为一个包含要加入根日志记录器的已创建处理器的可迭代对象。 任何尚未设置格式描述符的处理器将被设置为在此函数中创建的默认格式描述符。 请注意此参数与 filename 或 stream 不兼容 —— 如果两者同时存在，则会引发 ValueError。
force | 如果将此关键字参数指定为 true，则在执行其他参数指定的配置之前，将移除并关闭附加到根记录器的所有现有处理器。
encoding | 如果此关键字参数与 filename 一同被指定，则其值会在创建 FileHandler 时被使用，因而也会在打开输出文件时被使用。
errors | 如果此关键字参数与 filename 一同被指定，则其值会在创建 FileHandler 时被使用，因而也会在打开输出文件时被使用。 如果未指定，则会使用值 'backslashreplace'。 请注意如果指定为 None，它将被原样传给 open()，这意味着它将会当作传入 'errors' 一样处理。

在 3.2 版更改: 增加了 style 参数。

在 3.3 版更改: 增加了 handlers 参数。 增加了额外的检查来捕获指定不兼容参数的情况 (例如同时指定 handlers 与 stream 或 filename，或者同时指定 stream 与 filename)。

在 3.8 版更改: 增加了 force 参数。

在 3.9 版更改: 增加了 encoding 和 errors 参数。

logging.shutdown()

通过刷新和关闭所有处理程序来通知日志记录系统执行有序停止。 此函数应当在应用退出时被调用并且在此调用之后不应再使用日志记录系统。

当 logging 模块被导入时，它会将此函数注册为退出处理程序 (参见 atexit)，因此通常不需要手动执行该操作。

logging.setLoggerClass(klass)

通知日志记录系统在实例化日志记录器时使用 klass 类。 该类应当定义 __init__() 使其只要求一个 name 参数，并且 __init__() 应当调用 Logger.__init__()。 此函数通常会在需要使用自定义日志记录器行为的应用程序实例化任何日志记录器之前被调用。 在此调用之后，在任何其他时刻都不要使用该子类来直接实例化日志记录器：请继续使用 logging.getLogger() API 来获取你的日志记录器。

logging.setLogRecordFactory(factory)

设置一个用来创建 LogRecord 的可调用对象。

参数

factory -- 用来实例化日志记录的工厂可调用对象。

3.2 新版功能: 此函数与 getLogRecordFactory() 一起提供，以便允许开发者对如何构造表示日志记录事件的 LogRecord 有更好的控制。

可调用对象 factory 具有如下签名:

factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)

name

日志记录器名称

level

日志记录级别（数字）。

fn

进行日志记录调用的文件的完整路径名。

lno

记录调用所在文件中的行号。

msg

日志消息。

args

日志记录消息的参数。

exc_info

异常元组，或 None 。

func

调用日志记录调用的函数或方法的名称。

sinfo

与 traceback.print_stack() 所提供的类似的栈回溯信息，显示调用的层级结构。

kwargs

其他关键字参数。

模块级属性

logging.lastResort

通过此属性提供的“最后处理者”。 这是一个以 WARNING 级别写入到 sys.stderr 的 StreamHandler，用于在没有任何日志记录配置的情况下处理日志记录事件。 最终结果就是将消息打印到 sys.stderr，这会替代先前形式为 "no handlers could be found for logger XYZ" 的错误消息。 如果出于某种原因你需要先前的行为，可将 lastResort 设为 None。

3.2 新版功能.

与警告模块集成

captureWarnings() 函数可用来将 logging 和 warnings 模块集成。

logging.captureWarnings(capture)

此函数用于打开和关闭日志系统对警告的捕获。

如果 capture 是 True，则 warnings 模块发出的警告将重定向到日志记录系统。具体来说，将使用 warnings.formatwarning() 格式化警告信息，并将结果字符串使用 WARNING 等级记录到名为 'py.warnings' 的记录器中。

如果 capture 是 False，则将停止将警告重定向到日志记录系统，并且将警告重定向到其原始目标（即在 captureWarnings(True) 调用之前的有效目标）。

参见

logging.config 模块

日志记录模块的配置 API 。

logging.handlers 模块

日志记录模块附带的有用处理器。

PEP 282 [https://www.python.org/dev/peps/pep-0282] - Logging 系统

该提案描述了Python标准库中包含的这个特性。

Original Python logging package [https://old.red-dove.com/python_logging.html]

这是该 logging 包的原始来源。该站点提供的软件包版本适用于 Python 1.5.2、2.1.x 和 2.2.x，它们不被 logging 包含在标准库中。

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

源代码： Lib/logging/config.py [https://github.com/python/cpython/tree/3.10/Lib/logging/config.py]

Important

此页面仅包含参考信息。有关教程，请参阅

基础教程

进阶教程

日志记录操作手册

这一节描述了用于配置 logging 模块的 API。

配置函数

下列函数可配置 logging 模块。 它们位于 logging.config 模块中。 它们的使用是可选的 --- 要配置 logging 模块你可以使用这些函数，也可以通过调用主 API (在 logging 本身定义) 并定义在 logging 或 logging.handlers 中声明的处理器。

logging.config.dictConfig(config)

从一个字典获取日志记录配置。 字典的内容描述见下文的 配置字典架构。

如果在配置期间遇到错误，此函数将引发 ValueError, TypeError, AttributeError 或 ImportError 并附带适当的描述性消息。 下面是将会引发错误的（可能不完整的）条件列表:

level 不是字符串或者不是对应于实际日志记录级别的字符串。

propagate 值不是布尔类型。

id 没有对应的目标。

在增量调用期间发现不存在的处理器 id。

无效的日志记录器名称。

无法解析为内部或外部对象。

解析由 DictConfigurator 类执行，该类的构造器可传入用于配置的字典，并且具有 configure() 方法。 logging.config 模块具有可调用属性 dictConfigClass，其初始值设为 DictConfigurator。 你可以使用你自己的适当实现来替换 dictConfigClass 的值。

dictConfig() 会调用 dictConfigClass 并传入指定的字典，然后在所返回的对象上调用 configure() 方法以使配置生效:

def dictConfig(config):
    dictConfigClass(config).configure()

例如，DictConfigurator 的子类可以在它自己的 __init__() 中调用 DictConfigurator.__init__()，然后设置可以在后续 configure() 调用中使用的自定义前缀。 dictConfigClass 将被绑定到这个新的子类，然后就可以与在默认的未定制状态下完全相同的方式调用 dictConfig()。

3.2 新版功能.

logging.config.fileConfig(fname, defaults=None, disable_existing_loggers=True, encoding=None)

从一个 configparser 格式文件中读取日志记录配置。 文件格式应当与 配置文件格式 中的描述一致。 此函数可在应用程序中被多次调用，以允许最终用户在多个预设配置中进行选择（如果开发者提供了展示选项并加载选定配置的机制）。

参数

fname -- 一个文件名，或一个文件类对象，或是一个派生自 RawConfigParser 的实例。 如果传入了一个派生自 RawConfigParser 的实例，它会被原样使用。 否则，将会实例化一个 Configparser，并且它会从作为 fname 传入的对象中读取配置。 如果存在 readline() 方法，则它会被当作一个文件类对象并使用 read_file() 来读取；在其它情况下，它会被当作一个文件名并传递给 read()。

defaults -- 要传递给 ConfigParser 的默认值可在此参数中指定。

disable_existing_loggers -- 如果指定为 False，则当执行此调用时已存在的日志记录器会被保持启用。 默认值为 True 因为这将以向下兼容的方式启用旧有行为。 此行为是禁用任何已存在的非根日志记录器除非它们或它们的上级在日志配置中被显式地指定。 :param encoding: 当 fname 为文件名时用于打开文件的编码格式。

在 3.4 版更改: 现在接受 RawConfigParser 子类的实例作为 fname 的值。 这有助于:

使用一个配置文件，其中日志记录配置只是全部应用程序配置的一部分。

使用从一个文件读取的配置，它随后会在被传给 fileConfig 之前由使用配置的应用程序来修改（例如基于命令行参数或运行时环境的其他部分）。

3.10 新版功能: 增加了 encoding 形参。

logging.config.listen(port=DEFAULT_LOGGING_CONFIG_PORT, verify=None)

在指定的端口上启动套接字服务器，并监听新的配置。 如果未指定端口，则会使用模块默认的 DEFAULT_LOGGING_CONFIG_PORT。 日志记录配置将作为适合由 dictConfig() 或 fileConfig() 进行处理的文件来发送。 返回一个 Thread 实例，你可以在该实例上调用 start() 来启动服务器，对该服务器你可以在适当的时候执行 join()。 要停止该服务器，请调用 stopListening()。

如果指定 verify 参数，则它应当是一个可调用对象，该对象应当验证通过套接字接收的字节数据是否有效且应被处理。 这可以通过对通过套接字发送的内容进行加密和/或签名来完成，这样 verify 可调用对象就能执行签名验证和/或解密。 verify 可调用对象的调用会附带一个参数 —— 通过套接字接收的字节数据 —— 并应当返回要处理的字节数据，或者返回 None 来指明这些字节数据应当被丢弃。 返回的字节数据可以与传入的字节数据相同（例如在只执行验证的时候），或者也可以完全不同（例如在可能执行了解密的时候）。

要将配置发送到套接字，请读取配置文件并将其作为字节序列发送到套接字，字节序列要以使用 struct.pack('>L', n) 打包为二进制格式的四字节长度的字符串打头。

注解

因为配置的各部分是通过 eval() 传递的，使用此函数可能让用户面临安全风险。虽然此函数仅绑定到 localhost 上的套接字，因此并不接受来自远端机器的连接，但在某些场景中不受信任的代码可以在调用 listen() 的进程的账户下运行。具体来说，如果如果调用 listen() 的进程在用户无法彼此信任的多用户机器上运行，则恶意用户就能简单地通过连接到受害者的 listen() 套接字并发送运行攻击者想在受害者的进程上执行的任何代码的配置的方式，安排运行几乎任意的代码。如果是使用默认端口这会特别容易做到，即便使用了不同端口也不难做到。要避免发生这种情况的风险，请在 listen() 中使用 verify 参数来防止未经认可的配置被应用。

在 3.4 版更改: 添加了 verify 参数。

注解

如果你希望将配置发送给未禁用现有日志记录器的监听器，你将需要使用 JSON 格式的配置，该格式将使用 dictConfig() 进行配置。 此方法允许你在你发送的配置中将 disable_existing_loggers 指定为 False。

logging.config.stopListening()

停止通过对 listen() 的调用所创建的监听服务器。 此函数的调用通常会先于在 listen() 的返回值上调用 join()。

安全考量

日志配置功能试图提供便利，从某种角度来说，这是通过将配置文件中的文本转换为日志配置中使用的 Python 对象来完成的 —— 如 用户定义对象 中所述。但是，这些相同的机制（从用户定义的模块中导入可调用对象并使用配置中的参数调用它们）可用于调用您指定的任何代码，因此您应该*非常谨慎*地处理来自非信任源的配置文件。并且在实际加载前，您应该确信加载不会导致坏事情。

配置字典架构

描述日志记录配置需要列出要创建的不同对象及它们之间的连接；例如，你可以创建一个名为 'console' 的处理器，然后名为 'startup' 的日志记录器将可以把它的消息发送给 'console' 处理器。 这些对象并不仅限于 logging 模块所提供的对象，因为你还可以编写你自己的格式化或处理器类。 这些类的形参可能还需要包括 sys.stderr 这样的外部对象。 描述这些对象和连接的语法会在下面的 对象连接 中定义。

字典架构细节

传给 dictConfig() 的字典必须包含以下的键:

version - 应设为代表架构版本的整数值。 目前唯一有效的值是 1，使用此键可允许架构在继续演化的同时保持向下兼容性。

所有其他键都是可选项，但如存在它们将根据下面的描述来解读。 在下面提到 'configuring dict' 的所有情况下，都将检查它的特殊键 '()' 以确定是否需要自定义实例化。 如果需要，则会使用下面 用户定义对象 所描述的机制来创建一个实例；否则，会使用上下文来确定要实例化的对象。

formatters - 对应的值将是一个字典，其中每个键是一个格式器 ID 而每个值则是一个描述如何配置相应 Formatter 实例的字典。

在配置字典中搜索以下可选键，这些键对应于创建 Formatter 对象时传入的参数。:

format

datefmt

style

validate (从版本 >=3.8 起)

可选的 class 键指定格式化器类的名称（形式为带点号的模块名和类名）。 实例化的参数与 Formatter 的相同，因此这个键对于实例化自定义的 Formatter 子类最为有用。 如果，替代类可能 会以扩展和精简格式呈现异常回溯信息。 如果你的格式化器需要不同的或额外的配置键，你应当使用 用户定义对象。

filters - 对应的值将是一个字典，其中每个键是一个过滤器 ID 而每个值则是一个描述如何配置相应 Filter 实例的字典。

将在配置字典中搜索键 name (默认值为空字符串) 并且该键会被用于构造 logging.Filter 实例。

handlers - 对应的值将是一个字典，其中每个键是一个处理器 ID 而每个值则是一个描述如何配置相应 Handler 实例的字典。

将在配置字典中搜索下列键:

class (强制)。 这是处理器类的完整限定名称。

level (可选)。 处理器的级别。

formatter (可选)。 处理器所对应格式化器的 ID。

filters (可选)。 由处理器所对应过滤器的 ID 组成的列表。

所有 其他 键会被作为关键字参数传递给处理器类的构造器。 例如，给定如下配置:

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

ID 为 console 的处理器会被实例化为 logging.StreamHandler，并使用 sys.stdout 作为下层流。 ID 为 file 的处理器会被实例化为 logging.handlers.RotatingFileHandler，并附带关键字参数 filename='logconfig.log', maxBytes=1024, backupCount=3。

loggers - 对应的值将是一个字典，其中每个键是一个日志记录器名称而每个值则是一个描述如何配置相应 Logger 实例的字典。

将在配置字典中搜索下列键:

level (可选)。 日志记录器的级别。

propagate (可选)。 日志记录器的传播设置。

filters (可选)。 由日志记录器对应过滤器的 ID 组成的列表。

handlers (可选)。 由日志记录器对应处理器的 ID 组成的列表。

指定的记录器将根据指定的级别、传播、过滤器和处理器来配置。

root - 这将成为根日志记录器对应的配置。 配置的处理方式将与所有日志记录器一致，除了 propagate 设置将不可用之外。

incremental - 配置是否要被解读为在现有配置上新增。 该值默认为 False，这意味着指定的配置将以与当前 fileConfig() API 所使用的相同语义来替代现有的配置。

如果指定的值为 True，配置会按照 增量配置 部分所描述的方式来处理。

disable_existing_loggers - 是否要禁用任何现有的非根日志记录器。 该设置对应于 fileConfig() 中的同名形参。 如果省略，则此形参默认为 True。 如果 incremental 为 True 则该省会被忽略。

增量配置

为增量配置提供完全的灵活性是很困难的。 例如，由于过滤器和格式化器这样的对象是匿名的，一旦完成配置，在增加配置时就不可能引用这些匿名对象。

此外，一旦完成了配置，在运行时任意改变日志记录器、处理器、过滤器、格式化器的对象图就不是很有必要；日志记录器和处理器的详细程度只需通过设置级别即可实现控制（对于日志记录器则可设置传播旗标）。 在多线程环境中以安全的方式任意改变对象图也许会导致问题；虽然并非不可能，但这样做的好处不足以抵销其所增加的实现复杂度。

这样，当配置字典的 incremental 键存在且为 True 时，系统将完全忽略任何 formatters 和 filters 条目，并仅会处理 handlers 条目中的 level 设置，以及 loggers 和 root 条目中的 level 和 propagate 设置。

使用配置字典中的值可让配置以封存字典对象的形式通过线路传送给套接字监听器。 这样，长时间运行的应用程序的日志记录的详细程度可随时间改变而无须停止并重新启动应用程序。

对象连接

该架构描述了一组日志记录对象 —— 日志记录器、处理器、格式化器、过滤器 —— 它们在对象图中彼此连接。 因此，该架构需要能表示对象之间的连接。 例如，在配置完成后，一个特定的日志记录器关联到了一个特定的处理器。 出于讨论的目的，我们可以说该日志记录器代表两者间连接的源头，而处理器则代表对应的目标。 当然在已配置对象中这是由包含对处理器的引用的日志记录器来代表的。 在配置字典中，这是通过给每个目标对象一个 ID 来无歧义地标识它，然后在源头对象中使用该 ID 来实现的。

因此，举例来说，考虑以下 YAML 代码段:

formatters:
  brief:
    # configuration for formatter with id 'brief' goes here
  precise:
    # configuration for formatter with id 'precise' goes here
handlers:
  h1: #This is an id
   # configuration of handler with id 'h1' goes here
   formatter: brief
  h2: #This is another id
   # configuration of handler with id 'h2' goes here
   formatter: precise
loggers:
  foo.bar.baz:
    # other configuration for logger 'foo.bar.baz'
    handlers: [h1, h2]

（注：这里使用 YAML 是因为它的可读性比表示字典的等价 Python 源码形式更好。）

日志记录器 ID 就是日志记录器的名称，它会在程序中被用来获取对日志记录器的引用，例如 foo.bar.baz。 格式化器和过滤器的 ID 可以是任意字符串值 (例如上面的 brief, precise) 并且它们是瞬态的，因为它们仅对处理配置字典有意义并会被用来确定对象之间的连接，而当配置调用完成时不会在任何地方保留。

上面的代码片段指明名为 foo.bar.baz 的日志记录器应当关联到两个处理器，它们的 ID 是 h1 和 h2。 h1 的格式化器的 ID 是 brief，而 h2 的格式化器的 ID 是 precise。

用户定义对象

此架构支持用户定义对象作为处理器、过滤器和格式化器。 （日志记录器的不同实例不需要具有不同类型，因此这个配置架构并不支持用户定义日志记录器类。）

要配置的对象是由字典描述的，其中包含它们的配置详情。 在某些地方，日志记录系统将能够从上下文中推断出如何实例化一个对象，但是当要实例化一个用户自定义对象时，系统将不知道要如何做。 为了提供用户自定义对象实例化的完全灵活性，用户需要提供一个‘工厂’函数 —— 即在调用时传入配置字典并返回实例化对象的可调用对象。 这是用一个通过特殊键 '()' 来访问的工厂函数的绝对导入路径来标示的。 下面是一个实际的例子:

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

上面的 YAML 代码片段定义了三个格式化器。 第一个的 ID 为 brief，是带有特殊格式字符串的标准 logging.Formatter 实例。 第二个的 ID 为 default，具有更长的格式同时还显式地定义了时间格式，并将最终实例化一个带有这两个格式字符串的 logging.Formatter。 以 Python 源代码形式显示的 brief 和 default 格式化器分别具有下列配置子字典:

{
  'format' : '%(message)s'
}

和:

{
  'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s',
  'datefmt' : '%Y-%m-%d %H:%M:%S'
}

并且由于这些字典不包含特殊键 '()'，实例化方式是从上下文中推断出来的：结果会创建标准的 logging.Formatter 实例。 第三个格式器的 ID 为 custom，对应配置子字典为:

{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42
}

并且它包含特殊键 '()'，这意味着需要用户自定义实例化方式。 在此情况下，将使用指定的工厂可调用对象。 如果它本身就是一个可调用对象则将被直接使用 —— 否则如果你指定了一个字符串（如这个例子所示）则将使用正常的导入机制来定位实例的可调用对象。 调用该可调用对象将传入配置子字典中 剩余的 条目作为关键字参数。 在上面的例子中，调用将预期返回 ID 为 custom 的格式化器:

my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)

警告

上面示例中 bar, spam 和 answer 等键的值不应是配置目录或引用如 cfg://foo 或 ext://bar，因为它们将不会被配置机制所处理，而是被原样传给可调用对象。

将 '()' 用作特殊键是因为它不是一个有效的关键字形参名称，这样就不会与调用中使用的关键字参数发生冲突。 '()' 还被用作表明对应值为可调用对象的助记符。

你还可以指定一个特殊键 '.' 其值应为一个将属性名称映射到对应值的字典。 如果找到，则指定的属性在被返回之前将在用户定义的对象上设置。 因此，使用以下配置:

{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42,
  '.' {
    'foo': 'bar',
    'baz': 'bozz'
  }
}

被返回的格式化器的 foo 属性将设为 'bar' 而 baz 属性将设为 'bozz'。

警告

上面示例中 foo 和 baz 等属性的值不应是配置目录或引用如 cfg://foo 或 ext://bar，因为它们将不会被配置机制所处理，而是被原样设置为属性。

处理器配置顺序

处理器按其键的字母顺序进行配置，而已配置的处理器将替换配置方案内部 handlers 字典（的一个工作副本）中的配置字典。 如果你使用 cfg://handlers.foo 这样的构造，那么在初始状态下 handlers['foo'] 会指向名为 foo 的处理器的配置字典，随后（一旦配置了该处理器）它将指向已配置的处理器实例。 因此，cfg://handlers.foo 可以解析为一个字典或处理器实例。 通常来说，对于带依赖的处理器采用在它们所依赖的任何处理器完成配置 _之后_ 再进行配置的方式来命名处理器是一种明智的做法；这将允许使用 cfg://handlers.foo 这样的构造来配置依赖于处理器 foo 的处理器。 如果这个带依赖的处理器被命名为 bar，则会导致问题，因为 bar 的配置将在 foo 的配置之前被尝试使用，而 foo 将尚未配置完成。 但是，如果带依赖的处理器被命名为 foobar，则它将在 foo 之后被配置，结果就是 cfg://handlers.foo 将被解析为已配置的处理器 foo，而不是其配置字典。

访问外部对象

有时一个配置需要引用配置以外的对象，例如 sys.stderr。 如果配置字典是使用 Python 代码构造的，这会很直观，但是当配置是通过文本文件（例如 JSON, YAML）提供的时候就会引发问题。 在一个文本文件中，没有将 sys.stderr 与字符串字面值 'sys.stderr' 区分开来的标准方式。 为了实现这种区分，配置系统会在字符串值中查找规定的特殊前缀并对其做特殊处理。 例如，如果在配置中将字符串字面值 'ext://sys.stderr' 作为一个值来提供，则 ext:// 将被去除而该值的剩余部分将使用正常导入机制来处理。

此类前缀的处理方式类似于协议处理：存在一种通用机制来查找与正则表达式 ^(?P<prefix>[a-z]+)://(?P<suffix>.*)$ 相匹配的前缀，如果识别出了 prefix，则 suffix 会以与前缀相对应的方式来处理并且处理的结果将替代原字符串值。 如果未识别出前缀，则原字符串将保持不变。

访问内部对象

除了外部对象，有时还需要引用配置中的对象。 这将由配置系统针对它所了解的内容隐式地完成。 例如，在日志记录器或处理器中表示 level 的字符串值 'DEBUG' 将被自动转换为值 logging.DEBUG，而 handlers, filters 和 formatter 条目将接受一个对象 ID 并解析为适当的目标对象。

但是，对于 logging 模块所不了解的用户自定义对象则需要一种更通用的机制。 例如，考虑 logging.handlers.MemoryHandler，它接受一个 target 参数即其所委托的另一个处理器。 由于系统已经知道存在该类，因而在配置中，给定的 target 只需为相应目标处理器的的对象 ID 即可，而系统将根据该 ID 解析出处理器。 但是，如果用户定义了一个具有 alternate 处理器的 my.package.MyHandler，则配置程序将不知道 alternate 指向的是一个处理器。 为了应对这种情况，通用解析系统允许用户指定:

handlers:
  file:
    # configuration of file handler goes here

  custom:
    (): my.package.MyHandler
    alternate: cfg://handlers.file

字符串字面值 'cfg://handlers.file' 将按照与 ext:// 前缀类似的方式被解析为结果字符串，但查找操作是在配置自身而不是在导入命名空间中进行。 该机制允许按点号或按索引来访问，与 str.format 所提供的方式类似。 这样，给定以下代码段:

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.

在该配置中，字符串 'cfg://handlers' 将解析为带有 handlers 键的字典，字符串 'cfg://handlers.email 将解析为具有 email 键的 handlers 字典中的字典，依此类推。 字符串 'cfg://handlers.email.toaddrs[1] 将解析为 'dev_team@domain.tld' 而字符串 'cfg://handlers.email.toaddrs[0]' 将解析为值 'support_team@domain.tld'。 subject 值 可以使用 'cfg://handlers.email.subject' 或者等价的 'cfg://handlers.email[subject]' 来访问。 后一种形式仅在键包含空格或非字母类数字类字符的情况下才需要使用。 如果一个索引仅由十进制数码构成，则将尝试使用相应的整数值来访问，如果有必要则将回退为字符串值。

给定字符串 cfg://handlers.myhandler.mykey.123，这将解析为 config_dict['handlers']['myhandler']['mykey']['123']。 如果字符串被指定为 cfg://handlers.myhandler.mykey[123]，系统将尝试从 config_dict['handlers']['myhandler']['mykey'][123] 中提取值，并在尝试失败时回退为 config_dict['handlers']['myhandler']['mykey']['123']。

导入解析与定制导入器

导入解析默认使用内置的 __import__() 函数来执行导入。 你可能想要将其替换为你自己的导入机制：如果是这样的话，你可以替换 DictConfigurator 或其超类 BaseConfigurator 类的 importer 属性。 但是你必须小心谨慎，因为函数是从类中通过描述器方式来访问的。 如果你使用 Python 可调用对象来执行导入，并且你希望在类层级而不是在实例层级上定义它，则你需要用 staticmethod() 来装饰它。 例如:

from importlib import import_module
from logging.config import BaseConfigurator

BaseConfigurator.importer = staticmethod(import_module)

如果你是在一个配置器的 实例 上设置导入可调用对象则你不需要用 staticmethod() 来装饰。

配置文件格式

fileConfig() 所能理解的配置文件格式是基于 configparser 功能的。 该文件必须包含 [loggers], [handlers] 和 [formatters] 等小节，它们通过名称来标识文件中定义的每种类型的实体。 对于每个这样的实体，都有单独的小节来标识实体的配置方式。 因此，对于 [loggers] 小节中名为 log01 的日志记录器，相应的配置详情保存在 [logger_log01] 小节中。 类似地，对于 [handlers] 小节中名为 hand01 的处理器，其配置将保存在名为 [handler_hand01] 的小节中，而对于 [formatters] 小节中名为 form01 的格式化器，其配置将在名为 [formatter_form01] 的小节中指定。 根日志记录器的配置必须在名为 [logger_root] 的小节中指定。

注解

fileConfig() API 比 dictConfig() API 更旧因而没有提供涵盖日志记录特定方面的功能。 例如，你无法配置 Filter 对象，该对象使用 fileConfig() 提供超出简单整数级别的消息过滤功能。 如果你想要在你的日志记录配置中包含 Filter 的实例，你将必须使用 dictConfig()。 请注意未来还将向 dictConfig() 添加对配置功能的强化，因此值得考虑在方便的时候转换到这个新 API。

在文件中这些小节的例子如下所示。

[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

根日志记录器必须指定一个级别和一个处理器列表。 根日志小节的例子如下所示。

[logger_root]
level=NOTSET
handlers=hand01

level 条目可以为 DEBUG, INFO, WARNING, ERROR, CRITICAL 或 NOTSET 之一。 其中 NOTSET 仅适用于根日志记录器，表示将会记录所有消息。 级别值会在 logging 包命名空间的上下文中通过 eval() 来得出。

handlers 条目是以逗号分隔的处理器名称列表，它必须出现于 [handlers] 小节并且在配置文件中有相应的小节。

对于根日志记录器以外的日志记录器，还需要某些附加信息。 下面的例子演示了这些信息。

[logger_parser]
level=DEBUG
handlers=hand01
propagate=1
qualname=compiler.parser

level 和 handlers 条目的解释方式与根日志记录器的一致，不同之处在于如果一个非根日志记录器的级别被指定为 NOTSET，则系统会咨询更高层级的日志记录器来确定该日志记录器的有效级别。 propagate 条目设为 1 表示消息必须从此日志记录器传播到更高层级的处理器，设为 0 表示消息 不会 传播到更高层级的处理器。 qualname 条目是日志记录器的层级通道名称，也就是应用程序获取日志记录器所用的名称。

指定处理器配置的小节说明如下。

[handler_hand01]
class=StreamHandler
level=NOTSET
formatter=form01
args=(sys.stdout,)

class 条目指明处理器的类（由 logging 包命名空间中的 eval() 来确定）。 level 会以与日志记录器相同的方式来解读，NOTSET 会被视为表示‘记录一切消息’。

formatter 条目指明此处理器的格式化器的键名称。 如为空白，则会使用默认的格式化器 (logging._defaultFormatter)。 如果指定了名称，则它必须出现于 [formatters] 小节并且在配置文件中有相应的小节。

args 条目，当在 logging 包命名空间的上下文中执行 eval() 时将是传给处理器类构造器的参数列表。 请参阅相应处理器的构造器说明或者下面的示例，以了解典型的条目是如何构造的。 如果未提供，则默认为 ()。

可选的 kwargs 条目，当在 logging 包命名空间的上下文中执行 eval() 时将是传给处理器的构造器的关键字参数字典。 如果未提供，则默认为 {}。

[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', '', '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}

指定格式化器配置的小节说明如下。

[formatter_form01]
format=F1 %(asctime)s %(levelname)s %(message)s
datefmt=
style=%
validate=True
class=logging.Formatter

用于格式化器配置的参数与字典规范 格式化器部分 中的键相同。

注解

由于如上所述使用了 eval()，因此使用 listen() 通过套接字来发送和接收配置会导致潜在的安全风险。 此风险仅限于相互间没有信任的多个用户在同一台机器上运行代码的情况；请参阅 listen() 了解更多信息。

参见

模块 logging

日志记录模块的 API 参考。

logging.handlers 模块

日志记录模块附带的有用处理器。

logging.handlers --- 日志处理程序

源代码: Lib/logging/handlers.py [https://github.com/python/cpython/tree/3.10/Lib/logging/handlers.py]

Important

此页面仅包含参考信息。有关教程，请参阅

基础教程

进阶教程

日志记录操作手册

这个包提供了以下有用的处理程序。 请注意有三个处理程序类 (StreamHandler, FileHandler 和 NullHandler) 实际上是在 logging 模块本身定义的，但其文档与其他处理程序一同记录在此。

StreamHandler

StreamHandler 类位于核心 logging 包，它可将日志记录输出发送到数据流例如 sys.stdout, sys.stderr 或任何文件型对象（或者更精确地说，任何支持 write() 和 flush() 方法的对象）。

class logging.StreamHandler(stream=None)

返回一个新的 StreamHandler 类。 如果指定了 stream，则实例将用它作为日志记录输出；在其他情况下将使用 sys.stderr。

emit(record)

如果指定了一个格式化器，它会被用来格式化记录。 随后记录会被写入到 terminator 之后的流中。 如果存在异常信息，则会使用 traceback.print_exception() 来格式化并添加到流中。

flush()

通过调用流的 flush() 方法来刷新它。 请注意 close() 方法是继承自 Handler 的所以没有输出，因此有时可能需要显式地调用 flush()。

setStream(stream)

将实例的流设为指定值，如果两者不一致的话。 旧的流会在设置新的流之前被刷新。

参数

stream -- 处理程序应当使用的流。

返回

旧的流，如果流已被改变的话，如果未被改变则为 None。

3.7 新版功能.

terminator

当将已格式化的记录写入到流时被用作终止符的字符串。 默认值为 '\n'。

如果你不希望以换行符终止，你可以将处理程序类实例的 terminator 属性设为空字符串。

在较早的版本中，终止符被硬编码为 '\n'。

3.2 新版功能.

FileHandler

FileHandler 类位于核心 logging 包，它可将日志记录输出到磁盘文件中。 它从 StreamHandler 继承了输出功能。

class logging.FileHandler(filename, mode='a', encoding=None, delay=False, errors=None)

返回一个 FileHandler 类的新实例。 将打开指定的文件并将其用作日志记录流。 如果未指定 mode，则会使用 'a'。 如果 encoding 不为 None，则会将其用作打开文件的编码格式。 如果 delay 为真值，则文件打开会被推迟至第一次调用 emit() 时。 默认情况下，文件会无限增长。 如果指定了 errors，它会被用于确定编码格式错误的处理方式。

在 3.6 版更改: 除了字符串值，也接受 Path 对象作为 filename 参数。

在 3.9 版更改: 增加了 errors 形参。

close()

关闭文件。

emit(record)

将记录输出到文件。

请注意如果文件因日志记录在退出后终止而被关闭并且文件打开模式为 'w'，则记录将不会被发送 (参见 bpo-42378 [https://bugs.python.org/issue?@action=redirect&bpo=42378])。

NullHandler

3.1 新版功能.

NullHandler 类位于核心 logging 包，它不执行任何格式化或输出。 它实际上是一个供库开发者使用的‘无操作’处理程序。

class logging.NullHandler

返回一个 NullHandler 类的新实例。

emit(record)

此方法不执行任何操作。

handle(record)

此方法不执行任何操作。

createLock()

此方法会对锁返回 None，因为没有下层 I/O 的访问需要被序列化。

请参阅 为库配置日志 了解有关如何使用 NullHandler 的更多信息。

WatchedFileHandler

WatchedFileHandler 类位于 logging.handlers 模块，这个 FileHandler 用于监视它所写入日志记录的文件。 如果文件发生变化，它会被关闭并使用文件名重新打开。

发生文件更改可能是由于使用了执行文件轮换的程序例如 newsyslog 和 logrotate。 这个处理程序在 Unix/Linux 下使用，它会监视文件来查看自上次发出数据后是否有更改。 （如果文件的设备或 inode 发生变化就认为已被更改。） 如果文件被更改，则会关闭旧文件流，并再打开文件以获得新文件流。

这个处理程序不适合在 Windows 下使用，因为在 Windows 下打开的日志文件无法被移动或改名 —— 日志记录会使用排他的锁来打开文件 —— 因此这样的处理程序是没有必要的。 此外，ST_INO 在 Windows 下不受支持；stat() 将总是为该值返回零。

class logging.handlers.WatchedFileHandler(filename, mode='a', encoding=None, delay=False, errors=None)

返回一个 WatchedFileHandler 类的新实例。 将打开指定的文件并将其用作日志记录流。 如果未指定 mode，则会使用 'a'。 如果 encoding 不为 None，则会将其用作打开文件的编码格式。 如果 delay 为真值，则文件打开会被推迟至第一次调用 emit() 时。 默认情况下，文件会无限增长。 如果提供了 errors，它会被用于确定编码格式错误的处理方式。

在 3.6 版更改: 除了字符串值，也接受 Path 对象作为 filename 参数。

在 3.9 版更改: 增加了 errors 形参。

reopenIfNeeded()

检查文件是否已更改。 如果已更改，则会刷新并关闭现有流然后重新打开文件，这通常是将记录输出到文件的先导操作。

3.6 新版功能.

emit(record)

将记录输出到文件，但如果文件已更改则会先调用 reopenIfNeeded() 来重新打开它。

BaseRotatingHandler

BaseRotatingHandler 类位于 logging.handlers 模块中，它是轮换文件处理程序类 RotatingFileHandler 和 TimedRotatingFileHandler 的基类。 你不需要实例化此类，但它具有你可能需要重写的属性和方法。

class logging.handlers.BaseRotatingHandler(filename, mode, encoding=None, delay=False, errors=None)

类的形参与 FileHandler 的相同。 其属性有:

namer

如果此属性被设为一个可调用对象，则 rotation_filename() 方法会委托给该可调用对象。 传给该可调用对象的形参与传给 rotation_filename() 的相同。

注解

namer 函数会在轮换期间被多次调用，因此它应当尽可能的简单快速。 它还应当对给定的输入每次都返回相同的输出，否则轮换行为可能无法按预期工作。

还有一点值得注意的是当使用命名器来保存文件名中要在轮换中使用的特定属性时必须小心处理。 例如，RotatingFileHandler 会要求有一组名称中包含连续整数的日志文件，以便轮换的效果能满足预期，而 TimedRotatingFileHandler 会通过确定要删除的最旧文件（根据传递纵使中处理器的初始化器的 backupCount 形参）来删除旧的日志文件。 为了达成这样的效果，文件名应当是可以使用文件名的日期/时间部分来排序的，而且命名器需要遵循此排序。 （如果想使用不遵循此规则的命名器，则需要在一个重写了 getFilesToDelete() 方法的 TimedRotatingFileHandler 的子类中使用它以便与自定义的命名规则进行配合。）

3.3 新版功能.

rotator

如果此属性被设为一个可调用对象，则 rotate() 方法会委托给该可调用对象。 传给该可调用对象的形参与传给 rotate() 的相同。

3.3 新版功能.

rotation_filename(default_name)

当轮换时修改日志文件的文件名。

提供该属性以便可以提供自定义文件名。

默认实现会调用处理程序的 'namer' 属性，如果它是可调用对象的话，并传给它默认的名称。 如果该属性不是可调用对象 (默认值为 None)，则将名称原样返回。

参数

default_name -- 日志文件的默认名称。

3.3 新版功能.

rotate(source, dest)

当执行轮换时，轮换当前日志。

默认实现会调用处理程序的 'rotator' 属性，如果它是可调用对象的话，并传给它 source 和 dest 参数。 如果该属性不是可调用对象 (默认值为 None)，则将源简单地重命名为目标。

参数

source -- 源文件名。 这通常为基本文件名，例如 'test.log'。

dest -- 目标文件名。 这通常是源被轮换后的名称，例如 'test.log.1'。

3.3 新版功能.

该属性存在的理由是让你不必进行子类化 —— 你可以使用与 RotatingFileHandler 和 TimedRotatingFileHandler 的实例相同的可调用对象。 如果 namer 或 rotator 可调用对象引发了异常，将会按照与 emit() 调用期间的任何其他异常相同的方式来处理，例如通过处理程序的 handleError() 方法。

如果你需要对轮换进程执行更多的修改，你可以重写这些方法。

请参阅 利用 rotator 和 namer 自定义日志轮换操作 获取具体示例。

RotatingFileHandler

RotatingFileHandler 类位于 logging.handlers 模块，它支持磁盘日志文件的轮换。

class logging.handlers.RotatingFileHandler(filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False, errors=None)

返回一个 RotatingFileHandler 类的新实例。 将打开指定的文件并将其用作日志记录流。 如果未指定 mode，则会使用 'a'。 如果 encoding 不为 None，则会将其用作打开文件的编码格式。 如果 delay 为真值，则文件打开会被推迟至第一次调用 emit()。 默认情况下，文件会无限增长。 如果提供了 errors，它会被用于确定编码格式错误的处理方式。

你可以使用 maxBytes 和 backupCount 值来允许文件以预定的大小执行 rollover。 当即将超出预定大小时，将关闭旧文件并打开一个新文件用于输出。 只要当前日志文件长度接近 maxBytes 就会发生轮换；但是如果 maxBytes 或 backupCount 两者之一的值为零，就不会发生轮换，因此你通常要设置 backupCount 至少为 1，而 maxBytes 不能为零。 当 backupCount 为非零值时，系统将通过为原文件名添加扩展名 '.1', '.2' 等来保存旧日志文件。 例如，当 backupCount 为 5 而基本文件名为 app.log 时，你将得到 app.log, app.log.1, app.log.2 直至 app.log.5。 当前被写入的文件总是 app.log。 当此文件写满时，它会被关闭并重户名为 app.log.1，而如果文件 app.log.1, app.log.2 等存在，则它们会被分别重命名为 app.log.2, app.log.3 等等。

在 3.6 版更改: 除了字符串值，也接受 Path 对象作为 filename 参数。

在 3.9 版更改: 增加了 errors 形参。

doRollover()

执行上文所描述的轮换。

emit(record)

将记录输出到文件，以适应上文所描述的轮换。

TimedRotatingFileHandler

TimedRotatingFileHandler 类位于 logging.handlers 模块，它支持基于特定时间间隔的磁盘日志文件轮换。

class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None, errors=None)

返回一个新的 TimedRotatingFileHandler 类实例。 指定的文件会被打开并用作日志记录的流。 对于轮换操作它还会设置文件名前缀。 轮换的发生是基于 when 和 interval 的积。

你可以使用 when 来指定 interval 的类型。 可能的值列表如下。 请注意它们不是大小写敏感的。

值 | 间隔类型 | 如果/如何使用 atTime
'S' | 秒 | 忽略
'M' | 分钟 | 忽略
'H' | 小时 | 忽略
'D' | 天 | 忽略
'W0'-'W6' | 工作日(0=星期一) | 用于计算初始轮换时间
'midnight' | 如果未指定 atTime 则在午夜执行轮换，否则将使用 atTime。 | 用于计算初始轮换时间

当使用基于星期的轮换时，星期一为 'W0'，星期二为 'W1'，以此类推直至星期日为 'W6'。 在这种情况下，传入的 interval 值不会被使用。

系统将通过为文件名添加扩展名来保存旧日志文件。 扩展名是基于日期和时间的，根据轮换间隔的长短使用 strftime 格式 %Y-%m-%d_%H-%M-%S 或是其中有变动的部分。

当首次计算下次轮换的时间时（即当处理程序被创建时），现有日志文件的上次被修改时间或者当前时间会被用来计算下次轮换的发生时间。

如果 utc 参数为真值，将使用 UTC 时间；否则会使用本地时间。

如果 backupCount 不为零，则最多将保留 backupCount 个文件，而如果当轮换发生时创建了更多的文件，则最旧的文件会被删除。 删除逻辑使用间隔时间来确定要删除的文件，因此改变间隔时间可能导致旧文件被继续保留。

如果 delay 为真值，则会将文件打开延迟到首次调用 emit() 的时候。

如果 atTime 不为 None，则它必须是一个 datetime.time 的实例，该实例指定轮换在一天内的发生时间，用于轮换被设为“在午夜”或“在每星期的某一天”之类的情况。 请注意在这些情况下，atTime 值实际上会被用于计算 初始 轮换，而后续轮换将会通过正常的间隔时间计算来得出。

如果指定了 errors，它会被用来确定编码错误的处理方式。

注解

初始轮换时间的计算是在处理程序被初始化时执行的。 后续轮换时间的计算则仅在轮换发生时执行，而只有当提交输出时轮换才会发生。 如果不记住这一点，你就可能会感到困惑。 例如，如果设置时间间隔为“每分钟”，那并不意味着你总会看到（文件名中）带有间隔一分钟时间的日志文件；如果在应用程序执行期间，日志记录输出的生成频率高于每分钟一次，那么 你可以预期看到间隔一分钟时间的日志文件。 另一方面，如果（假设）日志记录消息每五分钟才输出一次，那么文件时间将会存在对应于没有输出（因而没有轮换）的缺失。

在 3.4 版更改: 添加了 atTime 形参。

在 3.6 版更改: 除了字符串值，也接受 Path 对象作为 filename 参数。

在 3.9 版更改: 增加了 errors 形参。

doRollover()

执行上文所描述的轮换。

emit(record)

将记录输出到文件，以适应上文所描述的轮换。

getFilesToDelete()

返回由应当作为轮转的一部分被删除的文件名组成的列表。 它们是由处理程序写入的最旧的备份日志文件的绝对路径。

SocketHandler

SocketHandler 类位于 logging.handlers 模块，它会将日志记录输出发送到网络套接字。 基类所使用的是 TCP 套接字。

class logging.handlers.SocketHandler(host, port)

返回一个 SocketHandler 类的新实例，该实例旨在与使用 host 与 port 给定地址的远程主机进行通信。

在 3.4 版更改: 如果 port 指定为 None，会使用 host 中的值来创建一个 Unix 域套接字 —— 在其他情况下，则会创建一个 TCP 套接字。

close()

关闭套接字。

emit()

对记录的属性字典执行封存并以二进制格式将其写入套接字。 如果套接字存在错误，则静默地丢弃数据包。 如果连接在此之前丢失，则重新建立连接。 要在接收端将记录解封并输出到 LogRecord，请使用 makeLogRecord() 函数。

handleError()

处理在 emit() 期间发生的错误。 最可能的原因是连接丢失。 关闭套接字以便我们能在下次事件时重新尝试。

makeSocket()

这是一个工厂方法，它允许子类定义它们想要的套接字的准确类型。 默认实现会创建一个 TCP 套接字 (socket.SOCK_STREAM)。

makePickle(record)

将记录的属性字典封存为带有长度前缀的二进制格式，并将其返回以准备通过套接字进行传输。 此操作在细节上相当于:

data = pickle.dumps(record_attr_dict, 1)
datalen = struct.pack('>L', len(data))
return datalen + data

请注意封存操作不是绝对安全的。 如果你关心安全问题，你可能会想要重写此方法以实现更安全的机制。 例如，你可以使用 HMAC 对封存对象进行签名然后在接收端验证它们，或者你也可以在接收端禁用全局对象的解封操作。

send(packet)

将封存后的字节串 packet 发送到套接字。 所发送字节串的格式与 makePickle() 文档中的描述一致。

此函数允许部分发送，这可能会在网络繁忙时发生。

createSocket()

尝试创建一个套接字；失败时将使用指数化回退算法处理。 在失败初次发生时，处理程序将丢弃它正尝试发送的消息。 当后续消息交由同一实例处理时，它将不会尝试连接直到经过一段时间以后。 默认形参设置为初始延迟一秒，如果在延迟之后连接仍然无法建立，处理程序将每次把延迟翻倍直至达到 30 秒的最大值。

此行为由下列处理程序属性控制:

retryStart (初始延迟，默认为 1.0 秒)。

retryFactor (倍数，默认为 2.0)。

retryMax (最大延迟，默认为 30.0 秒)。

这意味着如果远程监听器在处理程序被使用 之后 启动，你可能会丢失消息（因为处理程序在延迟结束之前甚至不会尝试连接，而在延迟期间静默地丢弃消息）。

DatagramHandler

DatagramHandler 类位于 logging.handlers 模块，它继承自 SocketHandler，支持通过 UDP 套接字发送日志记录消息。

class logging.handlers.DatagramHandler(host, port)

返回一个 DatagramHandler 类的新实例，该实例旨在与使用 host 与 port 给定地址的远程主机进行通信。

注解

由于 UDP 不是流式协议，在该处理器与 host 之前不存在持久连接。 因为这个原因，当使用网络套接字时，每当有事件被写入日志时都可能要进行 DNS 查询，这会给系统带来一些延迟。 如果这对你有影响，你可以自己执行查询并使用已查询到的 IP 地址而不是主机名来初始化这个处理器。

在 3.4 版更改: 如果 port 指定为 None，会使用 host 中的值来创建一个 Unix 域套接字 —— 在其他情况下，则会创建一个 UDP 套接字。

emit()

对记录的属性字典执行封存并以二进制格式将其写入套接字。 如果套接字存在错误，则静默地丢弃数据包。 要在接收端将记录解封并输出到 LogRecord，请使用 makeLogRecord() 函数。

makeSocket()

SocketHandler 的工厂方法会在此被重写以创建一个 UDP 套接字 (socket.SOCK_DGRAM)。

send(s)

将封存后的字节串发送到套接字。 所发送字节串的格式与 SocketHandler.makePickle() 文档中的描述一致。

SysLogHandler

SysLogHandler 类位于 logging.handlers 模块，它支持将日志记录消息发送到远程或本地 Unix syslog。

class logging.handlers.SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM)

返回一个 SysLogHandler 类的新实例用来与通过 address 以 (host, port) 元组形式给出地址的远程 Unix 机器进行通讯。 如果未指定 address，则使用 ('localhost', 514)。 该地址会被用于打开套接字。 提供 (host, port) 元组的一种替代方式是提供字符串形式的地址，例如 '/dev/log'。 在这种情况下，会使用 Unix 域套接字将消息发送到 syslog。 如果未指定 facility，则使用 LOG_USER。 打开的套接字类型取决于 socktype 参数，该参数的默认值为 socket.SOCK_DGRAM 即打开一个 UDP 套接字。 要打开一个 TCP 套接字（用来配合较新的 syslog 守护程序例如 rsyslog 使用），请指定值为 socket.SOCK_STREAM。

请注意如果你的服务器不是在 UDP 端口 514 上进行侦听，则 SysLogHandler 可能无法正常工作。 在这种情况下，请检查你应当为域套接字所使用的地址 —— 它依赖于具体的系统。 例如，在 Linux 上通常为 '/dev/log' 而在 OS/X 上则为 '/var/run/syslog'。 你需要检查你的系统平台并使用适当的地址（如果你的应用程序需要在多个平台上运行则可能需要在运行时进行这样的检查）。 在 Windows 上，你大概必须要使用 UDP 选项。

注解

在 macOS 12.x (Monterey) 上，Apple 修改了其 syslog 守护进程的行为 —— 它不再监听某个域套接字。 因此，你不能再预期 SysLogHandler 在此系统上有效。

请参阅 gh-91070 [https://github.com/python/cpython/issues/91070] 了解更多信息。

在 3.2 版更改: 添加了 socktype。

close()

关闭连接远程主机的套接字。

emit(record)

记录会被格式化，然后发送到 syslog 服务器。 如果存在异常信息，则它 不会 被发送到服务器。

在 3.2.1 版更改: (参见: bpo-12168 [https://bugs.python.org/issue?@action=redirect&bpo=12168]。) 在较早的版本中，发送至 syslog 守护程序的消息总是以一个 NUL 字节结束，因为守护程序的早期版本期望接收一个以 NUL 结束的消息 —— 即使它不包含于对应的规范说明 (RFC 5424 [https://datatracker.ietf.org/doc/html/rfc5424.html])。 这些守护程序的较新版本不再期望接收 NUL 字节，如果其存在则会将其去除，而最新的守护程序（更紧密地遵循 RFC 5424）会将 NUL 字节作为消息的一部分传递出去。

为了在面对所有这些不同守护程序行为时能够更方便地处理 syslog 消息，通过使用类层级属性 append_nul，添加 NUL 字节的操作已被作为可配置项。 该属性默认为 True (保留现有行为) 但可在 SysLogHandler 实例上设为 False 以便让实例 不会 添加 NUL 结束符。

在 3.3 版更改: (参见: bpo-12419 [https://bugs.python.org/issue?@action=redirect&bpo=12419]。) 在较早的版本中，没有 "ident" 或 "tag" 前缀工具可以用来标识消息的来源。 现在则可以使用一个类层级属性来设置它，该属性默认为 "" 表示保留现有行为，但可在 SysLogHandler 实例上重写以便让实例不会为所处理的每条消息添加标识。 请注意所提供的标识必须为文本而非字节串，并且它会被原封不动地添加到消息中。

encodePriority(facility, priority)

将功能和优先级编码为一个整数。 你可以传入字符串或者整数 —— 如果传入的是字符串，则会使用内部的映射字典将其转换为整数。

符号 LOG_ 的值在 SysLogHandler 中定义并且是 sys/syslog.h 头文件中所定义值的镜像。

优先级

名称（字符串） | 符号值
alert | LOG_ALERT
crit 或 critical | LOG_CRIT
debug | LOG_DEBUG
emerg 或 panic | LOG_EMERG
err 或 error | LOG_ERR
info | LOG_INFO
notice | LOG_NOTICE
warn 或 warning | LOG_WARNING

设备

名称（字符串） | 符号值
auth | LOG_AUTH
authpriv | LOG_AUTHPRIV
cron | LOG_CRON
daemon | LOG_DAEMON
ftp | LOG_FTP
kern | LOG_KERN
lpr | LOG_LPR
mail | LOG_MAIL
news | LOG_NEWS
syslog | LOG_SYSLOG
user | LOG_USER
uucp | LOG_UUCP
local0 | LOG_LOCAL0
local1 | LOG_LOCAL1
local2 | LOG_LOCAL2
local3 | LOG_LOCAL3
local4 | LOG_LOCAL4
local5 | LOG_LOCAL5
local6 | LOG_LOCAL6
local7 | LOG_LOCAL7

mapPriority(levelname)

将日志记录级别名称映射到 syslog 优先级名称。 如果你使用自定义级别，或者如果默认算法不适合你的需要，你可能需要重写此方法。 默认算法将 DEBUG, INFO, WARNING, ERROR 和 CRITICAL 映射到等价的 syslog 名称，并将所有其他级别名称映射到 'warning'。

NTEventLogHandler

NTEventLogHandler 类位于 logging.handlers 模块，它支持将日志记录消息发送到本地 Windows NT, Windows 2000 或 Windows XP 事件日志。 在你使用它之前，你需要安装 Mark Hammond 的 Python Win32 扩展。

class logging.handlers.NTEventLogHandler(appname, dllname=None, logtype='Application')

返回一个 NTEventLogHandler 类的新实例。 appname 用来定义出现在事件日志中的应用名称。 将使用此名称创建适当的注册表条目。 dllname 应当给出要包含在日志中的消息定义的 .dll 或 .exe 的完整限定路径名称（如未指定则会使用 'win32service.pyd' —— 此文件随 Win32 扩展安装且包含一些基本的消息定义占位符。 请注意使用这些占位符将使你的事件日志变得很大，因为整个消息源都会被放入日志。 如果你希望有较小的日志，你必须自行传入包含你想要在事件日志中使用的消息定义的 .dll 或 .exe 名称）。 logtype 为 'Application', 'System' 或 'Security' 之一，且默认值为 'Application'。

close()

这时，你就可以从注册表中移除作为事件日志条目来源的应用名称。 但是，如果你这样做，你将无法如你所预期的那样在事件日志查看器中看到这些事件 —— 它必须能访问注册表来获取 .dll 名称。 当前版本并不会这样做。

emit(record)

确定消息 ID，事件类别和事件类型，然后将消息记录到 NT 事件日志中。

getEventCategory(record)

返回记录的事件类别。 如果你希望指定你自己的类别就要重写此方法。 此版本将返回 0。

getEventType(record)

返回记录的事件类型。 如果你希望指定你自己的类型就要重写此方法。 此版本将使用处理程序的 typemap 属性来执行映射，该属性在 __init__() 被设置为一个字典，其中包含 DEBUG, INFO, WARNING, ERROR 和 CRITICAL 的映射。 如果你使用你自己的级别，你将需要重写此方法或者在处理程序的 typemap 属性中放置一个合适的字典。

getMessageID(record)

返回记录的消息 ID。 如果你使用你自己的消息，你可以通过将 msg 传给日志记录器作为 ID 而非格式字符串实现此功能。 然后，你可以在这里使用字典查找来获取消息 ID。 此版本将返回 1，是 win32service.pyd 中的基本消息 ID。

SMTPHandler

SMTPHandler 类位于 logging.handlers 模块，它支持将日志记录消息通过 SMTP 发送到一个电子邮件地址。

class logging.handlers.SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0)

返回一个 SMTPHandler 类的新实例。 该实例使用电子邮件的发件人、收件人地址和主题行进行初始化。 toaddrs 应当为字符串列表。 要指定一个非标准 SMTP 端口，请使用 (host, port) 元组格式作为 mailhost 参数。 如果你使用一个字符串，则会使用标准 SMTP 端口。 如果你的 SMTP 服务器要求验证，你可以指定一个 (username, password) 元组作为 credentials 参数。

要指定使用安全协议 (TLS)，请传入一个元组作为 secure 参数。 这将仅在提供了验证凭据时才能被使用。 元组应当或是一个空元组，或是一个包含密钥文件名的单值元组，或是一个包含密钥文件和证书文件的 2 值元组。 （此元组会被传给 smtplib.SMTP.starttls() 方法。）

可以使用 timeout 参数为与 SMTP 服务器的通信指定超时限制。

3.3 新版功能: 增加了 timeout 参数。

emit(record)

对记录执行格式化并将其发送到指定的地址。

getSubject(record)

如果你想要指定一个基于记录的主题行，请重写此方法。

MemoryHandler

MemoryHandler 类位于 logging.handlers 模块，它支持在内存中缓冲日志记录，并定期将其刷新到 target 处理程序中。 刷新会在缓冲区满的时候，或是在遇到特定或更高严重程度事件的时候发生。

MemoryHandler 是更通用的 BufferingHandler 的子类，后者属于抽象类。 它会在内存中缓冲日志记录。 当每条记录被添加到缓冲区时，会通过调用 shouldFlush() 来检查缓冲区是否应当刷新。 如果应当刷新，则要使用 flush() 来执行刷新。

class logging.handlers.BufferingHandler(capacity)

使用指定容量的缓冲区初始化处理程序。 这里，capacity 是指缓冲的日志记录数量。

emit(record)

将记录添加到缓冲区。 如果 shouldFlush() 返回真值，则会调用 flush() 来处理缓冲区。

flush()

你可以重载此方法来实现自定义的刷新行为。 此版本只是将缓冲区清空。

shouldFlush(record)

如果缓冲区容量已满则返回 True。 可以重写此方法以实现自定义的刷新策略。

class logging.handlers.MemoryHandler(capacity, flushLevel=ERROR, target=None, flushOnClose=True)

返回一个 MemoryHandler 类的新实例。 该实例使用 capacity 指定的缓冲区大小（要缓冲的记录数量）来初始化。 如果 flushLevel 未指定，则使用 ERROR。 如果未指定 target，则需要在此处理程序执行任何实际操作之前使用 setTarget() 来设置目标。 如果 flushOnClose 指定为 False，则当处理程序被关闭时 不会 刷新缓冲区。 如果未指定或指定为 True，则当处理程序被关闭时将会发生之前的缓冲区刷新行为。

在 3.6 版更改: 增加了 flushOnClose 形参。

close()

调用 flush()，设置目标为 None 并清空缓冲区。

flush()

对于 MemoryHandler，刷新是指将缓冲的记录发送到目标，如果存在目标的话。 当此行为发生时缓冲区也将被清空。 如果你想要不同的行为请重载此方法。

setTarget(target)

设置此处理程序的目标处理程序。

shouldFlush(record)

检测缓冲区是否已满或是有记录为 flushLevel 或更高级别。

HTTPHandler

HTTPHandler 类位于 logging.handlers 模块，它支持使用 GET 或 POST 语义将日志记录消息发送到 Web 服务器。

class logging.handlers.HTTPHandler(host, url, method='GET', secure=False, credentials=None, context=None)

返回一个 HTTPHandler 类的新实例。 host 可以为 host:port 的形式，如果你需要使用指定端口号的话。 如果没有指定 method，则会使用 GET。 如果 secure 为真值，则将使用 HTTPS 连接。 context 形参可以设为一个 ssl.SSLContext 实例以配置用于 HTTPS 连接的 SSL 设置。 如果指定了 credentials，它应当为包含 userid 和 password 的二元组，该元组将被放入使用 Basic 验证的 HTTP 'Authorization' 标头中。 如果你指定了 credentials，你还应当指定 secure=True 这样你的 userid 和 password 就不会以明文在线路上传输。

在 3.5 版更改: 增加了 context 形参。

mapLogRecord(record)

基于 record 提供一个字典，它将被执行 URL 编码并发送至 Web 服务器。 默认实现仅返回 record.__dict__。 在只需将 LogRecord 的某个子集发送至 Web 服务器，或者需要对发送至服务器的内容进行更多定制时可以重写此方法。

emit(record)

将记录以 URL 编码字典的形式发送至 Web 服务器。 mapLogRecord() 方法会被用来将要发送的记录转换为字典。

注解

由于记录发送至 Web 服务器所需的预处理与通用的格式化操作不同，使用 setFormatter() 来指定一个 Formatter 用于 HTTPHandler 是没有效果的。 此处理程序不会调用 format()，而是调用 mapLogRecord() 然后再调用 urllib.parse.urlencode() 来以适合发送至 Web 服务器的形式对字典进行编码。

QueueHandler

3.2 新版功能.

QueueHandler 类位于 logging.handlers 模块，它支持将日志记录消息发送到一个队列，例如在 queue 或 multiprocessing 模块中实现的队列。

配合 QueueListener 类使用，QueueHandler 可被用来使处理程序在与执行日志记录的线程不同的线程上完成工作。 这对 Web 应用程序以及其他服务于客户端的线程需要尽可能快地响应的服务应用程序来说很重要，任何潜在的慢速操作（例如通过 SMTPHandler 发送邮件）都要在单独的线程上完成。

class logging.handlers.QueueHandler(queue)

返回一个 QueueHandler 类的新实例。 该实例使用队列来初始化以向其发送消息。 queue 可以为任何队列类对象；它由 enqueue() 方法来使用，该方法需要知道如何向其发送消息。 队列 不要求 具有任务跟踪 API，这意味着你可以为 queue 使用 SimpleQueue 实例。

注解

如果你在使用 multiprocessing，则你应当避免使用 SimpleQueue 而要改用 multiprocessing.Queue。

emit(record)

将准备 LogRecord 的结果排入队列。 如果发生了异常（例如由于有界队列已满），则会调用 handleError() 方法来处理错误。 这可能导致记录被静默地丢弃 (如果 logging.raiseExceptions 为 False) 或者消息被打印到 sys.stderr (如果 logging.raiseExceptions 为 True)。

prepare(record)

准备用于队列的记录。 此方法返回的对象会被排入队列。

该基本实现会对记录进行格式化以合并消息、参数、异常和栈信息，如果它们存在的话。 它还会从记录中原地移除不可 pickle 的条目。 具体来说，它会用合并后的消息（通过调用处理器的 format() 方法获得）覆盖记录的 msg 和 message 属性，并将 args, exc_info 和 exc_text 属性设置为 None。

如果你想要将记录转换为 dict 或 JSON 字符串，或者发送记录被修改后的副本而让初始记录保持原样，则你可能会想要重写此方法。

注解

该基本实现会使用这些参数对消息进行格式化，将 message 和 msg 属性设置为已格式化的消息并将 args 和 exc_text 属性设置为 None 以允许 pickle 操作并防止更多的格式化尝试。 这意味着 QueueListener 一方的处理器将没有自定义格式化所需的信息，例如异常信息等。 你可能会想要子类化 QueueHandler 并重写此方法以便避免将 exc_text 设置为 None。 请注意对 message / msg / args 的改变与确保记录可以 pickle 是相关联的，根据你的 args 是否可以 pickle 你将可能或不可能避免这样做。 （请注意你可能必须不仅要考虑你自己的代码还要考虑你所使用的任何库中的代码。）

enqueue(record)

使用 put_nowait() 将记录排入队列；如果你想要使用阻塞行为，或超时设置，或自定义的队列实现，则你可能会想要重写此方法。

listener

当通过使用 dictConfig() 的配置创建时，该属性将包含一个 QueueListener 实例供此处理器使用。 在其他情况下，它将为 None。

3.12 新版功能.

QueueListener

3.2 新版功能.

QueueListener 类位于 logging.handlers 模块，它支持从一个队列接收日志记录消息，例如在 queue 或 multiprocessing 模块中实现的队列。 消息是在内部线程中从队列接收并在同一线程上传递到一个或多个处理程序进行处理的。 尽管 QueueListener 本身并不是一个处理程序，但由于它要与 QueueHandler 配合工作，因此也在此处介绍。

配合 QueueHandler 类使用，QueueListener 可被用来使处理程序在与执行日志记录的线程不同的线程上完成工作。 这对 Web 应用程序以及其他服务于客户端的线程需要尽可能快地响应的服务应用程序来说很重要，任何潜在的慢速动作（例如通过 SMTPHandler 发送邮件）都要在单独的线程上完成。

class logging.handlers.QueueListener(queue, *handlers, respect_handler_level=False)

返回一个 QueueListener 类的新实例。 该实例初始化时要传入一个队列以向其发送消息，还要传入一个处理程序列表用来处理放置在队列中的条目。 队列可以是任何队列类对象；它会被原样传给 dequeue() 方法，该方法需要知道如何从其获取消息。 队列 不要求 具有任务跟踪 API（但如提供则会使用它），这意味着你可以为 queue 使用 SimpleQueue 实例。

注解

如果你在使用 multiprocessing，则你应当避免使用 SimpleQueue 而要改用 multiprocessing.Queue。

如果 respect_handler_level 为 True，则在决定是否将消息传递给处理程序之前会遵循处理程序的级别（与消息的级别进行比较）；在其他情况下，其行为与之前的 Python 版本一致 —— 总是将每条消息传递给每个处理程序。

在 3.5 版更改: 增加了 respect_handler_level 参数。

dequeue(block)

从队列移出一条记录并将其返回，可以选择阻塞。

基本实现使用 get()。 如果你想要使用超时设置或自定义的队列实现，则你可能会想要重写此方法。

prepare(record)

准备一条要处理的记录。

该实现只是返回传入的记录。 如果你想要对记录执行任何自定义的 marshal 操作或在将其传给处理程序之前进行调整，则你可能会想要重写此方法。

handle(record)

处理一条记录。

此方法简单地循环遍历处理程序，向它们提供要处理的记录。 实际传给处理程序的对象就是从 prepare() 返回的对象。

start()

启动监听器。

此方法启动一个后台线程来监视 LogRecords 队列以进行处理。

stop()

停止监听器。

此方法要求线程终止，然后等待它完成终止操作。 请注意在你的应用程序退出之前如果你没有调用此方法，则可能会有一些记录在留在队列中，它们将不会被处理。

enqueue_sentinel()

将一个标记写入队列以通知监听器退出。 此实现会使用 put_nowait()。 如果你想要使得超时设置或自定义的队列实现，则你可能会想要重写此方法。

3.3 新版功能.

参见

模块 logging

日志记录模块的 API 参考。

logging.config 模块

日志记录模块的配置 API 。

getpass --- 便携式密码输入工具

源代码: Lib/getpass.py [https://github.com/python/cpython/tree/3.10/Lib/getpass.py]

getpass 模块提供了两个函数：

getpass.getpass(prompt='Password: ', stream=None)

提示用户输入一个密码且不会回显。 用户会看到字符串 prompt 作为提示，其默认值为 'Password: '。 在 Unix 上，如有必要提示会使用替换错误句柄写入到文件型对象 stream。 stream 默认指向控制终端 (/dev/tty)，如果不可用则指向 sys.stderr (此参数在 Windows 上会被忽略)。

如果回显自由输入不可用则 getpass() 将回退为打印一条警告消息到 stream 并且从 sys.stdin 读取同时发出 GetPassWarning。

注解

如果你从 IDLE 内部调用 getpass，输入可能是在你启动 IDLE 的终端中而非在 IDLE 窗口本身中完成。

exception getpass.GetPassWarning

一个当密码输入可能被回显时发出的 UserWarning 子类。

getpass.getuser()

返回用户的“登录名称”。

此函数会按顺序检查环境变量 LOGNAME, USER, LNAME 和 USERNAME，并返回其中第一个被设置为非空字符串的值。 如果均未设置，则在支持 pwd 模块的系统上将返回来自密码数据库的登录名，否则将引发一个异常。

通常情况下，此函数应优先于 os.getlogin() 使用。

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

源代码: Lib/curses [https://github.com/python/cpython/tree/3.10/Lib/curses]

curses 模块提供了 curses 库的接口，这是可移植高级终端处理的事实标准。

虽然 curses 在 Unix 环境中使用最为广泛，但也有适用于 Windows，DOS 以及其他可能的系统的版本。此扩展模块旨在匹配 ncurses 的 API，这是一个部署在 Linux 和 Unix 的 BSD 变体上的开源 curses 库。

注解

每当文档提到 字符 时，它可以被指定为一个整数，一个单字符 Unicode 字符串或者一个单字节的字节字符串。

每当此文档提到 字符串 时，它可以被指定为一个 Unicode 字符串或者一个字节字符串。

注解

从 5.4 版本开始，ncurses 库使用 nl_langinfo 函数来决定如何解释非 ASCII 数据。这意味着你需要在程序中调用 locale.setlocale() 函数，并使用一种系统中可用的编码方法来编码 Unicode 字符串。这个例子使用了系统默认的编码:

import locale
locale.setlocale(locale.LC_ALL, '')
code = locale.getpreferredencoding()

然后使用 code 作为 str.encode() 调用的编码。

参见

模块 curses.ascii

在 ASCII 字符上工作的工具，无论你的区域设置是什么。

模块 curses.panel

为 curses 窗口添加深度的面板栈扩展。

模块 curses.textpad

用于使 curses 支持 Emacs 式绑定的可编辑文本部件。

用 Python 进行 Curses 编程

关于配合 Python 使用 curses 的教学材料，由 Andrew Kuchling 和 Eric Raymond 撰写。

Python 源码发布包的 Tools/demo/ [https://github.com/python/cpython/tree/3.10/Tools/demo/] 目录包含了一些使用此模块所提供的 curses 绑定的示例程序。

函数

curses 模块定义了以下异常：

exception curses.error

当 curses 库中函数返回一个错误时引发的异常。

注解

只要一个函数或方法的 x 或 y 参数是可选项，它们会默认为当前光标位置。 而当 attr 是可选项时，它会默认为 A_NORMAL。

curses 模块定义了以下函数：

curses.baudrate()

以每秒比特数为单位返回终端输出速度。 在软件终端模拟器上它将具有一个固定的最高值。 此函数出于历史原因被包括；在以前，它被用于写输出循环以提供时间延迟，并偶尔根据线路速度来改变接口。

curses.beep()

发出短促的提醒声音。

curses.can_change_color()

根据程序员能否改变终端显示的颜色返回 True 或 False。

curses.cbreak()

进入 cbreak 模式。 在 cbreak 模式（有时也称为“稀有”模式）通常的 tty 行缓冲会被关闭并且字符可以被一个一个地读取。 但是，与原始模式不同，特殊字符（中断、退出、挂起和流程控制）会在 tty 驱动和调用程序上保留其效果。 首先调用 raw() 然后调用 cbreak() 会将终端置于 cbreak 模式。

curses.color_content(color_number)

返回颜色值 color_number 中红、绿和蓝（RGB）分量的强度，此强度值必须介于 0 和 COLORS - 1 之间。 返回一个 3 元组，其中包含给定颜色的 R,G,B 值，它们必须介于 0 (无分量) 和 1000 (最大分量) 之间。

curses.color_pair(pair_number)

返回用于以指定颜色对显示文本的属性值。 仅支持前 256 个颜色对。 该属性值可与 A_STANDOUT, A_REVERSE 以及其他 A_* 属性组合使用。 pair_number() 是此函数的对应操作。

curses.curs_set(visibility)

设置光标状态。 visibility 可设为 0, 1 或 2 表示不可见、正常与高度可见。 如果终端支持所请求的可见性，则返回之前的光标状态；否则会引发异常。 在许多终端上，“正常可见”模式为下划线光标而“高度可见”模式为方块形光标。

curses.def_prog_mode()

将当前终端模式保存为 "program" 模式，即正在运行的程序使用 curses 的模式。 （与其相对的是 "shell" 模式，即程序不使用 curses。） 对 reset_prog_mode() 的后续调用将恢复此模式。

curses.def_shell_mode()

将当前终端模式保存为 "shell" 模式，即正在运行的程序不使用 curses 的模式。 （与其相对的是 "program" 模式，即程序使用 功能。） 对 reset_shell_mode() 的后续调用将恢复此模式。

curses.delay_output(ms)

在输出中插入 ms 毫秒的暂停。

curses.doupdate()

更新物理屏幕。 curses 库会保留两个数据结构，一个代表当前物理屏幕的内容以及一个虚拟屏幕代表需要的后续状态。 doupdate() 整体更新物理屏幕以匹配虚拟屏幕。

虚拟屏幕可以通过在写入操作例如在一个窗口上执行 addstr() 之后调用 noutrefresh() 来刷新。 普通的 refresh() 调用只是简单的 noutrefresh() 加 doupdate()；如果你需要更新多个窗口，你可以通过在所有窗口上发出 noutrefresh() 调用再加单次 doupdate() 来提升性能并可减少屏幕闪烁。

curses.echo()

进入 echo 模式。 在 echo 模式下，输入的每个字符都会在输入后回显到屏幕上。

curses.endwin()

撤销库的初始化，使终端返回正常状态。

curses.erasechar()

将用户的当前擦除字符以单字节字节串对象的形式返回。 在 Unix 操作系统下这是 curses 程序用来控制 tty 的属性，而不是由 curses 库本身来设置的。

curses.filter()

如果要使用 filter() 例程，它必须在调用 initscr() 之前被调用。 其效果是在这些调用期间，LINES 会被设为 1；clear, cup, cud, cud1, cuu1, cuu, vpa 等功能会被禁用；而 home 字符串会被设为 cr 的值。 其影响是光标会被限制在当前行内，屏幕刷新也是如此。 这可被用于启用单字符模式的行编辑而不触及屏幕的其余部分。

curses.flash()

闪烁屏幕。 也就是将其改为反显并在很短的时间内将其改回原状。 有些人更喜欢这样的‘视觉响铃’而非 beep() 所产生的听觉提醒信号。

curses.flushinp()

刷新所有输入缓冲区。 这会丢弃任何已被用户输入但尚未被程序处理的预输入内容。

curses.getmouse()

在 getch() 返回 KEY_MOUSE 以发出鼠标事件信号之后，应当调用此方法来获取加入队列的鼠标事件，事件以一个 5 元组 (id, x, y, z, bstate) 来表示。 其中 id 为用于区分多个设备的 ID 值，而 x, y, z 为事件的坐标。 (z 目前未被使用。) bstate 为一个整数值，其各个比特位将被设置用来表示事件的类型，并将为下列常量中的一个或多个按位 OR 的结果，其中 n 是以 1 到 5 表示的键号: BUTTONn_PRESSED, BUTTONn_RELEASED, BUTTONn_CLICKED, BUTTONn_DOUBLE_CLICKED, BUTTONn_TRIPLE_CLICKED, BUTTON_SHIFT, BUTTON_CTRL, BUTTON_ALT。

在 3.10 版更改: 现在 BUTTON5_* 常量如果是由下层 curses 库提供的则会对外公开。

curses.getsyx()

将当前虚拟屏幕光标的坐标作为元组 (y, x) 返回。 如果 leaveok 当前为 True，则返回 (-1, -1)。

curses.getwin(file)

读取由之前的 putwin() 调用存放在文件中的窗口相关数据。 该例程随后将使用该数据创建并初始化一个新窗口，并返回该新窗口对象。

curses.has_colors()

如果终端能显示彩色则返回 True；否则返回 False。

curses.has_extended_color_support()

如果此模块支持扩展颜色则返回 True；否则返回 False。 扩展颜色支持允许支持超过 16 种颜色的终端（例如 xterm-256color）支持超过 256 种颜色对。

扩展颜色支持要求 ncurses 版本为 6.1 或更新。

3.10 新版功能.

curses.has_ic()

如果终端具有插入和删除字符的功能则返回 True。 此函数仅是出于历史原因而被包括的，因为所有现代软件终端模拟器都具有这些功能。

curses.has_il()

如果终端具有插入和删除字符功能，或者能够使用滚动区域来模拟这些功能则返回 True。 此函数仅是出于历史原因而被包括的，因为所有现代软件终端模拟器都具有这些功能。

curses.has_key(ch)

接受一个键值 ch，并在当前终端类型能识别出具有该值的键时返回 True。

curses.halfdelay(tenths)

用于半延迟模式，与 cbreak 模式的类似之处是用户所键入的字符会立即对程序可用。 但是，在阻塞 tenths 个十分之一秒之后，如果还未输入任何内容则将引发异常。 tenths 值必须为 1 和 255 之间的数字。 使用 nocbreak() 可退出半延迟模式。

curses.init_color(color_number, r, g, b)

更改某个颜色的定义，接受要更改的颜色编号以及三个 RGB 值（表示红绿蓝三个分量的强度）。 color_number 的值必须为 0 和 COLORS - 1 之间的数字。 每个 r, g, b 值必须为 0 和 1000 之间的数字。 当使用 init_color() 时，出现在屏幕上的对应颜色会立即按照定定义来更改。 此函数在大多数终端上都是无操作的；它仅会在 can_change_color() 返回 True 时生效。

curses.init_pair(pair_number, fg, bg)

更改某个颜色对的定义。 它接受三个参数：要更改的颜色对编号，前景色编号和背景色编号。 pair_number 值必须为 1 和 COLOR_PAIRS - 1 之间的数字（并且 0 号颜色对固定为黑底白字而无法更改）。 fg 和 bg 参数必须为 0 和 COLORS - 1 之间的数字，或者在调用 use_default_colors() 之后则为 -1。 如果颜色对之前已被初始化，则屏幕会被刷新使得出现在屏幕上的该颜色会立即按照新定义来更改。

curses.initscr()

初始化库。 返回代表整个屏幕的 窗口 对象。

注解

如果打开终端时发生错误，则下层的 curses 库可能会导致解释器退出。

curses.is_term_resized(nlines, ncols)

如果 resize_term() 会修改窗口结构则返回 True，否则返回 False。

curses.isendwin()

如果 endwin() 已经被调用（即 curses 库已经被撤销初始化则返回 True。

curses.keyname(k)

将编号为 k 的键名称作为字节串对象返回。 生成可打印 ASCII 字符的键名称就是键所对应的字符。 Ctrl-键组合的键名称则是一个两字节的字节串对象，它由插入符 (b'^') 加对应的可打印 ASCII 字符组成。 Alt-键组合 (128--255) 的键名称则是由前缀 b'M-' 加对应的可打印 ASCII 字符组成的字节串对象。

curses.killchar()

将用户的当前行删除字符以单字节字节串对象的形式返回。 在 Unix 操作系统下这是 curses 程序用来控制 tty 的属性，而不是由 curses 库本身来设置的。

curses.longname()

返回一个字节串对象，其中包含描述当前终端的 terminfo 长名称字段。 详细描述的最大长度为 128 个字符。 它仅在调用 initscr() 之后才会被定义。

curses.meta(flag)

如果 flag 为 True，则允许输入 8 比特位的字符。 如果 flag 为 False，则只允许 7 比特位的字符。

curses.mouseinterval(interval)

以毫秒为单位设置能够被识别为点击的按下和释放事件之间可以间隔的最长时间，并返回之前的间隔值。 默认值为 200 毫秒，即五分之一秒。

curses.mousemask(mousemask)

设置要报告的鼠标事件，并返回一个元组 (availmask, oldmask)。 availmask 表明指定的鼠标事件中哪些可以被报告；当完全失败时将返回 0。 oldmask 是给定窗口的鼠标事件之前的掩码值。 如果从未调用此函数，则不会报告任何鼠标事件。

curses.napms(ms)

休眠 ms 毫秒。

curses.newpad(nlines, ncols)

创建并返回一个指向具有给定行数和列数新的面板数据结构的指针。 将面板作为窗口对象返回。

面板类似于窗口，区别在于它不受屏幕大小的限制，并且不必与屏幕的特定部分相关联。 面板可以在需要使用大窗口时使用，并且每次只需将窗口的一部分放在屏幕上。 面板不会发生自动刷新（例如由于滚动或输入回显）。 面板的 refresh() 和 noutrefresh() 方法需要 6 个参数来指定面板要显示的部分以及要用于显示的屏幕位置。 这些参数是 pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol；p 参数表示要显示的面板区域的左上角而 s 参数定义了要显示的面板区域在屏幕上的剪切框。

curses.newwin(nlines, ncols)

curses.newwin(nlines, ncols, begin_y, begin_x)

返回一个新的 窗口，其左上角位于 (begin_y, begin_x)，并且其高度/宽度为 nlines/ncols。

默认情况下，窗口将从指定位置扩展到屏幕的右下角。

curses.nl()

进入 newline 模式。 此模式会在输入时将回车转换为换行符，并在输出时将换行符转换为回车加换行。 newline 模式会在初始时启用。

curses.nocbreak()

退出 cbreak 模式。 返回具有行缓冲的正常 "cooked" 模式。

curses.noecho()

退出 echo 模式。 关闭输入字符的回显。

curses.nonl()

退出 newline 模式。 停止在输入时将回车转换为换行，并停止在输出时从换行到换行/回车的底层转换（但这不会改变 addch('\n') 的行为，此行为总是在虚拟屏幕上执行相当于回车加换行的操作）。 当停止转换时，curses 有时能使纵向移动加快一些；并且，它将能够在输入时检测回车键。

curses.noqiflush()

当使用 noqiflush() 例程时，与 INTR, QUIT 和 SUSP 字符相关联的输入和输出队列的正常刷新将不会被执行。 如果你希望在处理程序退出后还能继续输出，就像没有发生过中断一样，你可能会想要在信号处理程序中调用 noqiflush()。

curses.noraw()

退出 raw 模式。 返回具有行缓冲的正常 "cooked" 模式。

curses.pair_content(pair_number)

返回包含对应于所请求颜色对的元组 (fg, bg)。 pair_number 的值必须在 0 和 COLOR_PAIRS - 1 之间。

curses.pair_number(attr)

返回通过属性值 attr 所设置的颜色对的编号。 color_pair() 是此函数的对应操作。

curses.putp(str)

等价于 tputs(str, 1, putchar)；为当前终端发出指定 terminfo 功能的值。 请注意 putp() 的输出总是前往标准输出。

curses.qiflush([flag])

如果 flag 为 False，则效果与调用 noqiflush() 相同。 如果 flag 为 True 或未提供参数，则在读取这些控制字符时队列将被刷新。

curses.raw()

进入 raw 模式。 在 raw 模式下，正常的行缓冲和对中断、退出、挂起和流程控制键的处理会被关闭；字符会被逐个地提交给 curses 输入函数。

curses.reset_prog_mode()

将终端恢复到 "program" 模式，如之前由 def_prog_mode() 所保存的一样。

curses.reset_shell_mode()

将终端恢复到 "shell" 模式，如之前由 def_shell_mode() 所保存的一样。

curses.resetty()

将终端模式恢复到最后一次调用 savetty() 时的状态。

curses.resize_term(nlines, ncols)

由 resizeterm() 用来执行大部分工作的后端函数；当调整窗口大小时，resize_term() 会以空白填充扩展区域。 调用方应用程序应当以适当的数据填充这些区域。 resize_term() 函数会尝试调整所有窗口的大小。 但是，由于面板的调用约定，在不与应用程序进行额外交互的情况下是无法调整其大小的。

curses.resizeterm(nlines, ncols)

将标准窗口和当前窗口的大小调整为指定的尺寸，并调整由 curses 库所使用的记录窗口尺寸的其他记录数据（特别是 SIGWINCH 处理程序）。

curses.savetty()

将终端模式的当前状态保存在缓冲区中，可供 resetty() 使用。

curses.get_escdelay()

提取通过 set_escdelay() 设置的值。

3.9 新版功能.

curses.set_escdelay(ms)

设置读取一个转义字符后要等待的毫秒数，以区分在键盘上输入的单个转义字符与通过光标和功能键发送的转义序列。

3.9 新版功能.

curses.get_tabsize()

提取通过 set_tabsize() 设置的值。

3.9 新版功能.

curses.set_tabsize(size)

设置 curses 库在将制表符添加到窗口时将制表符转换为空格所使用的列数。

3.9 新版功能.

curses.setsyx(y, x)

将虚拟屏幕光标设置到 y, x。 如果 y 和 x 均为 -1，则 leaveok 将设为 True。

curses.setupterm(term=None, fd=- 1)

初始化终端。 term 为给出终端名称的字符串或为 None；如果省略或为 None，则将使用 TERM 环境变量的值。 fd 是任何初始化序列将被发送到的文件描述符；如未指定或为 -1，则将使用 sys.stdout 的文件描述符。

curses.start_color()

如果程序员想要使用颜色，则必须在任何其他颜色操作例程被调用之前调用它。 在 initscr() 之后立即调用此例程是一个很好的做法。

start_color() 会初始化八种基本颜色（黑、红、绿、黄、蓝、品、青和白）以及 curses 模块中的两个全局变量 COLORS 和 COLOR_PAIRS，其中包含终端可支持的颜色和颜色对的最大数量。 它还会将终端中的颜色恢复为终端刚启动时的值。

curses.termattrs()

返回终端所支持的所有视频属性逻辑 OR 的值。 此信息适用于当 curses 程序需要对屏幕外观进行完全控制的情况。

curses.termname()

将环境变量 TERM 的值截短至 14 个字节，作为字节串对象返回。

curses.tigetflag(capname)

将与 terminfo 功能名称 capname 相对应的布尔功能值以整数形式返回。 如果 capname 不是一个布尔功能则返回 -1，如果其被取消或不存在于终端描述中则返回 0。

curses.tigetnum(capname)

将与 terminfo 功能名称 capname 相对应的数字功能值以整数形式返回。 如果 capname 不是一个数字功能则返回 -2，如果其被取消或不存在于终端描述中则返回 -1。

curses.tigetstr(capname)

将与 terminfo 功能名称 capname 相对应的字符串功能值以字节串对象形式返回。 如果 capname 不是一个 terminfo "字符串功能" 或者如果其被取消或不存在于终端描述中则返回 None。

curses.tparm(str[, ...])

使用提供的形参初始化字节串对象 str，其中 str 应当是从 terminfo 数据库获取的参数化字符串。 例如 tparm(tigetstr("cup"), 5, 3) 的结果可能为 b'\033[6;4H'，实际结果将取决于终端类型。

curses.typeahead(fd)

指定将被用于预输入检查的文件描述符 fd。 如果 fd 为 -1，则不执行预输入检查。

curses 库会在更新屏幕时通过定期查找预输入来执行 "断行优化"。 如果找到了输入，并且输入是来自于 tty，则会将当前更新推迟至 refresh 或 doupdate 再次被调用的时候，以便允许更快地响应预先输入的命令。 此函数允许为预输入检查指定其他的文件描述符。

curses.unctrl(ch)

返回一个字节串对象作为字符 ch 的可打印表示形式。 控制字符会表示为一个变换符加相应的字符，例如 b'^C'。 可打印字符则会保持原样。

curses.ungetch(ch)

推送 ch 以便让下一个 getch() 返回该字符。

注解

在 getch() 被调用之前只能推送一个 ch。

curses.update_lines_cols()

更新 LINES 和 COLS。 适用于检测屏幕大小的手动调整。

3.5 新版功能.

curses.unget_wch(ch)

推送 ch 以便让下一个 get_wch() 返回该字符。

注解

在 get_wch() 被调用之前只能推送一个 ch。

3.3 新版功能.

curses.ungetmouse(id, x, y, z, bstate)

将 KEY_MOUSE 事件推送到输入队列，将其与给定的状态数据进行关联。

curses.use_env(flag)

如果使用此函数，则应当在调用 initscr() 或 newterm 之前调用它。 当 flag 为 False 时，将会使用在 terminfo 数据库中指定的行和列的值，即使设置了环境变量 LINES 和 COLUMNS (默认使用)，或者如果 curses 是在窗口中运行（在此情况下如果未设置 LINES 和 COLUMNS 则默认行为将是使用窗口大小）。

curses.use_default_colors()

允许在支持此特性的终端上使用默认的颜色值。 使用此函数可在你的应用程序中支持透明效果。 默认颜色会被赋给颜色编号 -1。 举例来说，在调用此函数后，init_pair(x, curses.COLOR_RED, -1) 会将颜色对 x 初始化为红色前景和默认颜色背景。

curses.wrapper(func, /, *args, **kwargs)

初始化 curses 并调用另一个可调用对象 func，该对象应当为你的使用 curses 的应用程序的其余部分。 如果应用程序引发了异常，此函数将在重新引发异常并生成回溯信息之前将终端恢复到正常状态。 随后可调用对象 func 会被传入主窗口 'stdscr' 作为其第一个参数，再带上其他所有传给 wrapper() 的参数。 在调用 func 之前，wrapper() 会启用 cbreak 模式，关闭回显，启用终端键盘，并在终端具有颜色支持的情况下初始化颜色。 在退出时（无论是正常退出还是异常退出）它会恢复 cooked 模式，打开回显，并禁用终端键盘。

Window 对象

Window 对象会由上面的 initscr() 和 newwin() 返回，它具有以下方法和属性:

window.addch(ch[, attr])

window.addch(y, x, ch[, attr])

将带有属性 attr 的字符 ch 绘制到 (y, x)，覆盖之前在该位置上绘制的任何字符。 默认情况下，字符的位置和属性均为窗口对象的当前设置。

注解

在窗口、子窗口或面板之外写入会引发 curses.error。 尝试在窗口、子窗口或面板的右下角写入将在字符被打印之后导致异常被引发。

window.addnstr(str, n[, attr])

window.addnstr(y, x, str, n[, attr])

将带有属性 attr 的字符串 str 中的至多 n 个字符绘制到 (y, x)，覆盖之前在屏幕上的任何内容。

window.addstr(str[, attr])

window.addstr(y, x, str[, attr])

将带有属性 attr 的字符串 str 绘制到 (y, x)，覆盖之前在屏幕上的任何内容。

注解

在窗口、子窗口或面板之外写入会引发 curses.error。 尝试在窗口、子窗口或面板的右下角写入将在字符串被打印之后导致异常被引发。

此 Python 模块的后端 ncurses 中的一个缺陷 [https://bugs.python.org/issue35924] 会在调整窗口大小时导致段错误。 此缺陷已在 ncurses-6.1-20190511 中被修复。 如果你必须使用较早版本的 ncurses，则你只要在调用 addstr() 时不传入嵌入了换行符的 str 即可避免触发此错误。 请为每一行分别调用 addstr()。

window.attroff(attr)

从应用于写入到当前窗口的 "background" 集中移除属性 attr。

window.attron(attr)

向应用于写入到当前窗口的 "background" 集中添加属性 attr。

window.attrset(attr)

将 "background" 属性集设为 attr。 该集合初始时为 0 (无属性)。

window.bkgd(ch[, attr])

将窗口 background 特征属性设为带有属性 attr 的字符 ch。 随后此修改将应用于放置到该窗口中的每个字符。

窗口中每个字符的属性会被修改为新的 background 属性。

不论之前的 background 字符出现在哪里，它都会被修改为新的 background 字符。

window.bkgdset(ch[, attr])

设置窗口的背景。 窗口的背景由字符和属性的任意组合构成。 背景的属性部分会与写入窗口的所有非空白字符合并（即 OR 运算）。 背景和字符和属性部分均会与空白字符合并。 背景将成为字符的特征属性并在任何滚动与插入/删除行/字符操作中与字符一起移动。

window.border([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])

在窗口边缘绘制边框。每个参数指定用于边界特定部分的字符;请参阅下表了解更多详情。

注解

任何形参的值为 0 都将导致该形参使用默认字符。 关键字形参 不可 被使用。 默认字符在下表中列出:

参数 | 描述 | 默认值
ls | 左侧 | ACS_VLINE
rs | 右侧 | ACS_VLINE
ts | 顶部 | ACS_HLINE
bs | 底部 | ACS_HLINE
tl | 左上角 | ACS_ULCORNER
tr | 右上角 | ACS_URCORNER
bl | 左下角 | ACS_LLCORNER
br | 右下角 | ACS_LRCORNER

window.box([vertch, horch])

类似于 border()，但 ls 和 rs 均为 vertch 而 ts 和 bs 均为 horch。 此函数总是会使用默认的转角字符。

window.chgat(attr)

window.chgat(num, attr)

window.chgat(y, x, attr)

window.chgat(y, x, num, attr)

在当前光标位置或是在所提供的位置 (y, x) 设置 num 个字符的属性。 如果 num 未给出或为 -1，则将属性设置到所有字符上直至行尾。 如果提供了位置 (y, x) 则此函数会将光标移至该位置。 修改过的行将使用 touchline() 方法处理以便下次窗口刷新时内容会重新显示。

window.clear()

类似于 erase()，但还会导致在下次调用 refresh() 时整个窗口被重新绘制。

window.clearok(flag)

如果 flag 为 True，则在下次调用 refresh() 时将完全清除窗口。

window.clrtobot()

从光标位置开始擦除直至窗口末端：光标以下的所有行都会被删除，然后会执行 clrtoeol() 的等效操作。

window.clrtoeol()

从光标位置开始擦除直至行尾。

window.cursyncup()

更新窗口所有上级窗口的当前光标位置以反映窗口的当前光标位置。

window.delch([y, x])

删除位于 (y, x) 的任何字符。

window.deleteln()

删除在光标之下的行。 所有后续的行都会上移一行。

window.derwin(begin_y, begin_x)

window.derwin(nlines, ncols, begin_y, begin_x)

"derive window" 的缩写，derwin() 与调用 subwin() 等效，不同之处在于 begin_y 和 begin_x 是想对于窗口的初始位置，而不是相对于整个屏幕。 返回代表所派生窗口的窗口对象。

window.echochar(ch[, attr])

使用属性 attr 添加字符 ch，并立即在窗口上调用 refresh()。

window.enclose(y, x)

检测给定的相对屏幕的字符-单元格坐标是否被给定的窗口所包围，返回 True 或 False。 它适用于确定是哪个屏幕窗口子集包围着某个鼠标事件的位置。

在 3.10 版更改: 在之前版本中它会返回 1 或 0 而不是 True 或 False。

window.encoding

用于编码方法参数（Unicode 字符串和字符）的编码格式。 encoding 属性是在创建子窗口时从父窗口继承的，例如通过 window.subwin()。 默认情况下，会使用当前区域的编码格式 (参见 locale.getpreferredencoding())。

3.3 新版功能.

window.erase()

清空窗口。

window.getbegyx()

返回左上角坐标的元组 (y, x)。

window.getbkgd()

返回给定窗口的当前背景字符/属性对。

window.getch([y, x])

获取一个字符。 请注意所返回的整数 不一定 要在 ASCII 范围以内：功能键、小键盘键等等是由大于 255 的数字表示的。 在无延迟模式下，如果没有输入则返回 -1，在其他情况下都会等待直至有键被按下。

window.get_wch([y, x])

获取一个宽字符。 对于大多数键都是返回一个字符，对于功能键、小键盘键和其他特殊键则是返回一个整数。 在无延迟模式下，如果没有输入则引发一个异常。

3.3 新版功能.

window.getkey([y, x])

获取一个字符，返回一个字符串而不是像 getch() 那样返回一个整数。 功能键、小键盘键和其他特殊键则是返回一个包含键名的多字节字符串。 在无延迟模式下，如果没有输入则引发一个异常。

window.getmaxyx()

返回窗口高度和宽度的元组 (y, x)。

window.getparyx()

将此窗口相对于父窗口的起始坐标作为元组 (y, x) 返回。 如果此窗口没有父窗口则返回 (-1, -1)。

window.getstr()

window.getstr(n)

window.getstr(y, x)

window.getstr(y, x, n)

从用户读取一个字节串对象，附带基本的行编辑功能。

window.getyx()

返回当前光标相对于窗口左上角的位置的元组 (y, x)。

window.hline(ch, n)

window.hline(y, x, ch, n)

显示一条起始于 (y, x) 长度为 n 个字符 ch 的水平线。

window.idcok(flag)

如果 flag 为 False，curses 将不再考虑使用终端的硬件插入/删除字符功能；如果 flag 为 True，则会启用字符插入和删除。 当 curses 首次初始化时，默认会启用字符插入/删除。

window.idlok(flag)

如果 flag 为 True，curses 将尝试使用硬件行编辑功能。 否则，行插入/删除会被禁用。

window.immedok(flag)

如果 flag 为 True，窗口图像中的任何改变都会自动导致窗口被刷新；你不必再自己调用 refresh()。 但是，这可能会由于重复调用 wrefresh 而显著降低性能。 此选项默认被禁用。

window.inch([y, x])

返回窗口中给定位置上的字符。 下面的 8 个比特位是字符本身，上面的比特位则为属性。

window.insch(ch[, attr])

window.insch(y, x, ch[, attr])

将带有属性 attr 的字符 ch 绘制到 (y, x)，将该行从位置 x 开始右移一个字符。

window.insdelln(nlines)

在指定窗口的当前行上方插入 nlines 行。 下面的 nlines 行将丢失。 对于 nlines 为负值的情况，则从光标下方的行开始删除 nlines 行，并将其余的行向上移动。 下面的 nlines 行会被清空。 当前光标位置将保持不变。

window.insertln()

在光标下方插入一个空行。 所有后续的行都会下移一行。

window.insnstr(str, n[, attr])

window.insnstr(y, x, str, n[, attr])

在光标下方的字符之前插入一个至多为 n 个字符的字符串（字符数量将与该行相匹配）。 如果 n 为零或负数，则插入整个字符串。 光标右边的所有字符将被右移，该行右端的字符将丢失。 光标位置将保持不变（在移到可能指定的 y, x 之后）。

window.insstr(str[, attr])

window.insstr(y, x, str[, attr])

在光标下方的字符之前插入一个字符串（字符数量将与该行相匹配）。 光标右边的所有字符将被右移，该行右端的字符将丢失。 光标位置将保持不变（在移到可能指定的 y, x 之后）。

window.instr([n])

window.instr(y, x[, n])

返回从窗口的当前光标位置，或者指定的 y, x 开始提取的字符所对应的字节串对象。 属性会从字符中去除。 如果指定了 n，instr() 将返回长度至多为 n 个字符的字符串（不包括末尾的 NUL）。

window.is_linetouched(line)

如果指定的行自上次调用 refresh() 后发生了改变则返回 True；否则返回 False。 如果 line 对于给定的窗口不可用则会引发 curses.error 异常。

window.is_wintouched()

如果指定的窗口自上次调用 refresh() 后发生了改变则返回 True；否则返回 False。

window.keypad(flag)

如果 flag 为 True，则某些键（小键盘键、功能键等）生成的转义序列将由 curses 来解析。 如果 flag 为 False，转义序列将保持在输入流中的原样。

window.leaveok(flag)

如果 flag 为 True，则在更新时光标将停留在原地，而不是在“光标位置”。 这将可以减少光标的移动。 在可能的情况下光标将变为不可见。

如果 flag 为 False，光标在更新后将总是位于“光标位置”。

window.move(new_y, new_x)

将光标移至 (new_y, new_x)。

window.mvderwin(y, x)

让窗口在其父窗口内移动。 窗口相对于屏幕的参数不会被更改。 此例程用于在屏幕的相同物理位置显示父窗口的不同部分。

window.mvwin(new_y, new_x)

移动窗口以使其左上角位于 (new_y, new_x)。

window.nodelay(flag)

如果 flag 为 True，则 getch() 将为非阻塞的。

window.notimeout(flag)

如果 flag 为 True，则转义序列将不会发生超时。

如果 flag 为 False，则在几毫秒之后，转义序列将不会被解析，并将保持在输入流中的原样。

window.noutrefresh()

标记为刷新但保持等待。 此函数会更新代表预期窗口状态的数据结构，但并不强制更新物理屏幕。 要完成后者，请调用 doupdate()。

window.overlay(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

将窗口覆盖在 destwin 上方。 窗口的大小不必相同，只有重叠的区域会被复制。 此复制是非破坏性的，这意味着当前背景字符不会覆盖掉 destwin 的旧内容。

为了获得对被复制区域的细粒度控制，可以使用 overlay() 的第二种形式。 sminrow 和 smincol 是源窗口的左上角坐标，而其他变量则在目标窗口中标记出一个矩形。

window.overwrite(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

将窗口覆盖在 destwin 上方。 窗口的大小不必相同，此时只有重叠的区域会被复制。 此复制是破坏性的，这意味着当前背景字符会覆盖掉 destwin 的旧内容。

为了获得对被复制区域的细粒度控制，可以使用 overwrite() 的第二种形式。 sminrow 和 smincol 是源窗口的左上角坐标，而其他变量则在目标窗口中标记出一个矩形。

window.putwin(file)

将关联到窗口的所有数据写入到所提供的文件对象。 此信息可在以后使用 getwin() 函数来提取。

window.redrawln(beg, num)

指明从 beg 行开始的 num 个屏幕行已被破坏并且应当在下次 refresh() 调用时完全重绘。

window.redrawwin()

触碰整个窗口，以使其在下次 refresh() 调用时完全重绘。

window.refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])

立即更新显示（将实际屏幕与之前的绘制/删除方法进行同步）。

6 个可选参数仅在窗口为使用 newpad() 创建的面板时可被指定。 需要额外的形参来指定所涉及到的是面板和屏幕的哪一部分。 pminrow 和 pmincol 指定要在面板中显示的矩形的左上角。 sminrow, smincol, smaxrow 和 smaxcol 指定要在屏幕中显示的矩形的边。 要在面板中显示的矩形的右下角是根据屏幕坐标计算出来的，由于矩形的大小必须相同。 两个矩形都必须完全包含在其各自的结构之内。 负的 pminrow, pmincol, sminrow 或 smincol 值会被视为将它们设为零值。

window.resize(nlines, ncols)

为 curses 窗口重新分配存储空间以将其尺寸调整为指定的值。 如果任一维度的尺寸大于当前值，则窗口的数据将以具有合并了当前背景渲染（由 bkgdset() 设置）的空白来填充。

window.scroll([lines=1])

将屏幕或滚动区域向上滚动 lines 行。

window.scrollok(flag)

控制当一个窗口的光标移出窗口或滚动区域边缘时会发生什么，这可能是在底端行执行换行操作，或者在最后一行输入最后一个字符导致的结果。 如果 flag 为 False，光标会留在底端行。 如果 flag 为 True，窗口会向上滚动一行。 请注意为了在终端上获得实际的滚动效果，还需要调用 idlok()。

window.setscrreg(top, bottom)

设置从 top 行至 bottom 行的滚动区域。 所有滚动操作将在此区域中进行。

window.standend()

关闭 standout 属性。 在某些终端上此操作会有关闭所有属性的副作用。

window.standout()

启用属性 A_STANDOUT。

window.subpad(begin_y, begin_x)

window.subpad(nlines, ncols, begin_y, begin_x)

返回一个子窗口，其左上角位于 (begin_y, begin_x)，并且其宽度/高度为 ncols/nlines。

window.subwin(begin_y, begin_x)

window.subwin(nlines, ncols, begin_y, begin_x)

返回一个子窗口，其左上角位于 (begin_y, begin_x)，并且其宽度/高度为 ncols/nlines。

默认情况下，子窗口将从指定位置扩展到窗口的右下角。

window.syncdown()

触碰已在上级窗口上被触碰的每个位置。 此例程由 refresh() 调用，因此几乎从不需要手动调用。

window.syncok(flag)

如果 flag 为 True，则 syncup() 会在窗口发生改变的任何时候自动被调用。

window.syncup()

触碰已在窗口中被改变的此窗口的各个上级窗口中的所有位置。

window.timeout(delay)

为窗口设置阻塞或非阻塞读取行为。 如果 delay 为负值，则会使用阻塞读取（这将无限期地等待输入）。 如果 delay 为零，则会使用非阻塞读取，并且当没有输入在等待时 getch() 将返回 -1。 如果 delay 为正值，则 getch() 将阻塞 delay 毫秒，并且当此延时结束时仍无输入将返回 -1。

window.touchline(start, count[, changed])

假定从行 start 开始的 count 行已被更改。 如果提供了 changed，它将指明是将受影响的行标记为已更改 (changed=True) 还是未更改 (changed=False)。

window.touchwin()

假定整个窗口已被更改，其目的是用于绘制优化。

window.untouchwin()

将自上次调用 refresh() 以来窗口中的所有行标记为未改变。

window.vline(ch, n[, attr])

window.vline(y, x, ch, n[, attr])

显示一行起始于 (y, x) 长度为 n 的由具有属性 attr 的字符 ch 组成的垂直线。

常量

curses 模块定义了以下数据成员:

curses.ERR

一些返回整数的 curses 例程，例如 getch()，在失败时将返回 ERR。

curses.OK

一些返回整数的 curses 例程，例如 napms()，在成功时将返回 OK。

curses.version

一个代表当前模块版本的字节串对象。 也作 __version__。

curses.ncurses_version

一个具名元组，它包含构成 ncurses 库版本号的三个数字: major, minor 和 patch。 三个值均为整数。 三个值也可通过名称来访问，因此 curses.ncurses_version[0] 等价于 curses.ncurses_version.major，依此类推。

可用性：如果使用了 ncurses 库。

3.8 新版功能.

有些常量可用于指定字符单元属性。 实际可用的常量取决于具体的系统。

属性 | 含意
A_ALTCHARSET | 备用字符集模式
A_BLINK | 闪烁模式
A_BOLD | 粗体模式
A_DIM | 暗淡模式
A_INVIS | 不可见或空白模式
A_ITALIC | 斜体模式
A_NORMAL | 正常属性
A_PROTECT | 保护模式
A_REVERSE | 反转背景色和前景色
A_STANDOUT | 突出模式
A_UNDERLINE | 下划线模式
A_HORIZONTAL | 水平突出显示
A_LEFT | 左高亮
A_LOW | 底部高亮
A_RIGHT | 右高亮
A_TOP | 顶部高亮
A_VERTICAL | 垂直突出显示
A_CHARTEXT | 用于提取字符的位掩码

3.7 新版功能: A_ITALIC was added.

有几个常量可用于提取某些方法返回的相应属性。

位掩码 | 含意
A_ATTRIBUTES | 用于提取属性的位掩码
A_CHARTEXT | 用于提取字符的位掩码
A_COLOR | 用于提取颜色对字段信息的位掩码

键由名称以 KEY_ 开头的整数常量引用。确切的可用键取决于系统。

关键常数 | 键
KEY_MIN | 最小键值
KEY_BREAK | 中断键（不可靠）
KEY_DOWN | 向下箭头
KEY_UP | 向上箭头
KEY_LEFT | 向左箭头
KEY_RIGHT | 向右箭头
KEY_HOME | Home 键 (上+左箭头)
KEY_BACKSPACE | 退格（不可靠）
KEY_F0 | 功能键。 支持至多 64 个功能键。
KEY_Fn | 功能键 n 的值
KEY_DL | 删除行
KEY_IL | 插入行
KEY_DC | 删除字符
KEY_IC | 插入字符或进入插入模式
KEY_EIC | 退出插入字符模式
KEY_CLEAR | 清空屏幕
KEY_EOS | 清空至屏幕底部
KEY_EOL | 清空至行尾
KEY_SF | 向前滚动 1 行
KEY_SR | 向后滚动 1 行 (反转)
KEY_NPAGE | 下一页
KEY_PPAGE | 上一页
KEY_STAB | 设置制表符
KEY_CTAB | 清除制表符
KEY_CATAB | 清除所有制表符
KEY_ENTER | 回车或发送 (不可靠)
KEY_SRESET | 软 (部分) 重置 (不可靠)
KEY_RESET | 重置或硬重置 (不可靠)
KEY_PRINT | 打印
KEY_LL | Home 向下或到底 (左下)
KEY_A1 | 键盘的左上角
KEY_A3 | 键盘的右上角
KEY_B2 | 键盘的中心
KEY_C1 | 键盘左下方
KEY_C3 | 键盘右下方
KEY_BTAB | 回退制表符
KEY_BEG | Beg (开始)
KEY_CANCEL | 取消
KEY_CLOSE | 关闭
KEY_COMMAND | Cmd (命令行)
KEY_COPY | 复制
KEY_CREATE | 创建
KEY_END | End
KEY_EXIT | 退出
KEY_FIND | 查找
KEY_HELP | 帮助
KEY_MARK | 标记
KEY_MESSAGE | 消息
KEY_MOVE | 移动
KEY_NEXT | 下一个
KEY_OPEN | 打开
KEY_OPTIONS | 属性
KEY_PREVIOUS | Prev (上一个)
KEY_REDO | 重做
KEY_REFERENCE | Ref (引用)
KEY_REFRESH | 刷新
KEY_REPLACE | 替换
KEY_RESTART | 重启
KEY_RESUME | 恢复
KEY_SAVE | 保存
KEY_SBEG | Shift + Beg (开始)
KEY_SCANCEL | Shift + Cancel
KEY_SCOMMAND | Shift + Command
KEY_SCOPY | Shift + Copy
KEY_SCREATE | Shift + Create
KEY_SDC | Shift + 删除字符
KEY_SDL | Shift + 删除行
KEY_SELECT | 选择
KEY_SEND | Shift + End
KEY_SEOL | Shift + 清空行
KEY_SEXIT | Shift + 退出
KEY_SFIND | Shift + 查找
KEY_SHELP | Shift + 帮助
KEY_SHOME | Shift + Home
KEY_SIC | Shift + 输入
KEY_SLEFT | Shift + 向左箭头
KEY_SMESSAGE | Shift + 消息
KEY_SMOVE | Shift + 移动
KEY_SNEXT | Shift + 下一个
KEY_SOPTIONS | Shift + 选项
KEY_SPREVIOUS | Shift + 上一个
KEY_SPRINT | Shift + 打印
KEY_SREDO | Shift + 重做
KEY_SREPLACE | Shift + 替换
KEY_SRIGHT | Shift + 向右箭头
KEY_SRSUME | Shift + 恢复
KEY_SSAVE | Shift + 保存
KEY_SSUSPEND | Shift + 挂起
KEY_SUNDO | Shift + 撤销
KEY_SUSPEND | 挂起
KEY_UNDO | 撤销操作
KEY_MOUSE | 鼠标事件已发生
KEY_RESIZE | 终端大小改变事件
KEY_MAX | 最大键值

在VT100及其软件仿真（例如X终端仿真器）上，通常至少有四个功能键（ KEY_F1, KEY_F2, KEY_F3, KEY_F4 ）可用，并且箭头键以明显的方式映射到 KEY_UP, KEY_DOWN, KEY_LEFT 和 KEY_RIGHT 。如果您的机器有一个PC键盘，可以安全地使用箭头键和十二个功能键（旧的PC键盘可能只有十个功能键）;此外，以下键盘映射是标准的：

键帽 | 常量
Insert | KEY_IC
Delete | KEY_DC
Home | KEY_HOME
End | KEY_END
Page Up | KEY_PPAGE
Page Down | KEY_NPAGE

下表列出了替代字符集中的字符。 这些字符继承自 VT100 终端，在 X 终端等软件模拟器上通常均为可用。 当没有可用的图形时，curses 会回退为粗糙的可打印 ASCII 近似符号。

注解

只有在调用 initscr() 之后才能使用它们

ACS代码 | 含意
ACS_BBSS | 右上角的别名
ACS_BLOCK | 实心方块
ACS_BOARD | 正方形
ACS_BSBS | 水平线的别名
ACS_BSSB | 左上角的别名
ACS_BSSS | 顶部 T 型的别名
ACS_BTEE | 底部 T 型
ACS_BULLET | 正方形
ACS_CKBOARD | 棋盘（点刻）
ACS_DARROW | 向下箭头
ACS_DEGREE | 等级符
ACS_DIAMOND | 菱形
ACS_GEQUAL | 大于或等于
ACS_HLINE | 水平线
ACS_LANTERN | 灯形符号
ACS_LARROW | 向左箭头
ACS_LEQUAL | 小于或等于
ACS_LLCORNER | 左下角
ACS_LRCORNER | 右下角
ACS_LTEE | 左侧 T 型
ACS_NEQUAL | 不等号
ACS_PI | 字母π
ACS_PLMINUS | 正负号
ACS_PLUS | 加号
ACS_RARROW | 向右箭头
ACS_RTEE | 右侧 T 型
ACS_S1 | 扫描线 1
ACS_S3 | 扫描线3
ACS_S7 | 扫描线7
ACS_S9 | 扫描线 9
ACS_SBBS | 右下角的别名
ACS_SBSB | 垂直线的别名
ACS_SBSS | 右侧 T 型的别名
ACS_SSBB | 左下角的别名
ACS_SSBS | 底部 T 型的别名
ACS_SSSB | 左侧 T 型的别名
ACS_SSSS | 交叉或大加号的替代名称
ACS_STERLING | 英镑
ACS_TTEE | 顶部 T 型
ACS_UARROW | 向上箭头
ACS_ULCORNER | 左上角
ACS_URCORNER | 右上角
ACS_VLINE | 垂线

下表列出了预定义的颜色：

常量 | 颜色
COLOR_BLACK | 黑色
COLOR_BLUE | 蓝色
COLOR_CYAN | 青色（浅绿蓝色）
COLOR_GREEN | 绿色
COLOR_MAGENTA | 洋红色（紫红色）
COLOR_RED | 红色
COLOR_WHITE | 白色
COLOR_YELLOW | 黄色

curses.textpad --- 用于 curses 程序的文本输入控件

curses.textpad 模块提供了一个 Textbox 类，该类在 curses 窗口中处理基本的文本编辑，支持一组与 Emacs 类似的键绑定（因此这也适用于 Netscape Navigator, BBedit 6.x, FrameMaker 和许多其他程序）。 该模块还提供了一个绘制矩形的函数，适用于容纳文本框或其他目的。

curses.textpad 模块定义了以下函数:

curses.textpad.rectangle(win, uly, ulx, lry, lrx)

绘制一个矩形。 第一个参数必须为窗口对象；其余参数均为相对于该窗口的坐标值。 第二和第三个参数为要绘制的矩形的左上角的 y 和 x 坐标值；第四和第五个参数为其右下角的 y 和 x 坐标值。 将会使用 VT100/IBM PC 形式的字符在可用的终端上（包括 xterm 和大多数其他软件终端模拟器）绘制矩形。 在其他情况下则将使用 ASCII 横杠、竖线和加号绘制。

文本框对象

你可以通过如下方式实例化一个 Textbox:

class curses.textpad.Textbox(win)

返回一个文本框控件对象。 win 参数必须是一个 curses 窗口 对象，文本框将被包含在其中。 文本框的编辑光标在初始时位于包含窗口的左上角，坐标值为 (0, 0)。 实例的 stripspaces 旗标初始时为启用。

Textbox 对象具有以下方法:

edit([validator])

这是你通常将使用的入口点。 它接受编辑按键直到键入了一个终止按键。 如果提供了 validator，它必须是一个函数。 它将在每次按键时被调用并传入相应的按键作作为形参；命令发送将在结果上执行。 此方法会以字符串形式返回窗口内容；是否包括窗口中的空白将受到 stripspaces 属性的影响。

do_command(ch)

处理单个按键命令。以下是支持的特殊按键：

按键 | 动作
Control-A | 转到窗口的左边缘。
Control-B | 光标向左，如果可能，包含前一行。
Control-D | 删除光标下的字符。
Control-E | 前往右边缘（stripspaces 关闭时）或者行尾（stripspaces 启用时）。
Control-F | 向右移动光标，适当时换行到下一行。
Control-G | 终止，返回窗口内容。
Control-H | 向后删除字符。
Control-J | 如果窗口是1行则终止，否则插入换行符。
Control-K | 如果行为空，则删除它，否则清除到行尾。
Control-L | 刷新屏幕。
Control-N | 光标向下;向下移动一行。
Control-O | 在光标位置插入一个空行。
Control-P | 光标向上;向上移动一行。

如果光标位于无法移动的边缘，则移动操作不执行任何操作。在可能的情况下，支持以下同义词：

常量 | 按键
KEY_LEFT | Control-B
KEY_RIGHT | Control-F
KEY_UP | Control-P
KEY_DOWN | Control-N
KEY_BACKSPACE | Control-h

所有其他按键将被视为插入给定字符并右移的命令（带有自动折行）。

gather()

以字符串形式返回窗口内容；是否包括窗口中的空白将受到 stripspaces 成员的影响。

stripspaces

此属性是控制窗口中空白解读方式的旗标。 当启用时，每一行的末尾空白会被忽略；任何将光标定位至末尾空白的光标动作都将改为前往该行末尾，并且在收集窗口内容时将去除末尾空白。

curses.ascii --- 用于 ASCII 字符的工具

源代码: Lib/curses/ascii.py [https://github.com/python/cpython/tree/3.10/Lib/curses/ascii.py]

curses.ascii 模块提供了一些 ASCII 字符的名称常量以及在各种 ASCII 字符类中执行成员检测的函数。 所提供的控制字符常量如下:

名称 | 含意
NUL |
SOH | 标题开始，控制台中断
STX | 文本开始
ETX | 文本结束
EOT | 传输结束
ENQ | 查询，附带 ACK 流量控制
ACK | 确认
BEL | 蜂鸣器
BS | 退格
TAB | 制表符
HT | TAB 的别名： "水平制表符”
LF | 换行
NL | LF 的别名： "新行"
VT | 垂直制表符
FF | 换页
CR | 回车
SO | Shift-out，开始替换字符集
SI | Shift-in，恢复默认字符集
DLE | Data-link escape，数据链接转义
DC1 | XON，用于流程控制
DC2 | Device control 2，块模式流程控制
DC3 | XOFF，用于流程控制
DC4 | 设备控制4
NAK | 否定确认
SYN | 同步空闲
ETB | 末端传输块
CAN | 取消
EM | 媒体结束
SUB | 替换
ESC | 退出
FS | 文件分隔符
GS | 组分隔符
RS | Record separator，块模式终止符
US | 单位分隔符
SP | 空格
DEL | 删除

请注意其中有许多在现今已经没有实际作用。 这些助记符是来源于数字计算机之前的电传打印机规范。

此模块提供了下列函数，对应于标准 C 库中的函数:

curses.ascii.isalnum(c)

检测 ASCII 字母数字类字符；它等价于 isalpha(c) 或 isdigit(c)。

curses.ascii.isalpha(c)

检测 ASCII 字母类字符；它等价于 isupper(c) or islower(c)。

curses.ascii.isascii(c)

检测字符值是否在 7 位 ASCII 集范围内。

curses.ascii.isblank(c)

检测 ASCII 空白字符；包括空格或水平制表符。

curses.ascii.iscntrl(c)

检测 ASCII 控制字符（在 0x00 到 0x1f 或 0x7f 范围内）。

curses.ascii.isdigit(c)

检测 ASCII 十进制数码，即 '0' 至 '9'。 它等价于 c in string.digits。

curses.ascii.isgraph(c)

检测任意 ASCII 可打印字符，不包括空白符。

curses.ascii.islower(c)

检测 ASCII 小写字母字符。

curses.ascii.isprint(c)

检测任意 ASCII 可打印字符，包括空白符。

curses.ascii.ispunct(c)

检测任意 ASCII 可打印字符，不包括空白符或字母数字类字符。

curses.ascii.isspace(c)

检测 ASCII 空白字符；包括空格，换行，回车，进纸，水平制表和垂直制表。

curses.ascii.isupper(c)

检测 ASCII 大写字母字符。

curses.ascii.isxdigit(c)

检测 ASCII 十六进制数码。 这等价于 c in string.hexdigits。

curses.ascii.isctrl(c)

检测 ASCII 控制字符（码位值 0 至 31）。

curses.ascii.ismeta(c)

检测非 ASCII 字符（码位值 0x80 及以上）。

这些函数接受整数或单字符字符串；当参数为字符串时，会先使用内置函数 ord() 进行转换。

请注意所有这些函数都是检测根据你传入的字符串的字符所生成的码位值；它们实际上完全不会知晓本机的字符编码格式。

以下两个函数接受单字符字符串或整数形式的字节值；它们会返回相同类型的值。

curses.ascii.ascii(c)

返回对应于 c 的下个 7 比特位的 ASCII 值。

curses.ascii.ctrl(c)

返回对应于给定字符的控制字符（字符比特值会与 0x1f 进行按位与运算）。

curses.ascii.alt(c)

返回对应于给定 ASCII 字符的 8 比特位字符（字符比特值会与 0x80 进行按位或运算）。

以下函数接受单字符字符串或整数值；它会返回一个字符串。

curses.ascii.unctrl(c)

返回 ASCII 字符 c 的字符串表示形式。 如果 c 是可打印字符，则字符串为字符本身。 如果该字符是控制字符 (0x00--0x1f) 则字符串由一个插入符 ('^') 加相应的大写字母组成。 如果该字符是 ASCII 删除符 (0x7f) 则字符串为 '^?'。 如果该字符设置了元比特位 (0x80)，元比特位会被去除，应用以上规则后将在结果之前添加 '!'。

curses.ascii.controlnames

一个 33 元素的字符串数据，其中按从 0 (NUL) 到 0x1f (US) 的顺序包含了三十二个 ASCII 控制字符的 ASCII 助记符，另加空格符的助记符 SP。

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

面板是具有添加深度功能的窗口，因此它们可以从上至下堆叠为栈，只有显示每个窗口的可见部分会显示出来。 面板可以在栈中被添加、上移或下移，也可以被移除。

函数

curses.panel 模块定义了以下函数:

curses.panel.bottom_panel()

返回面板栈中的底部面板。

curses.panel.new_panel(win)

返回一个面板对象，将其与给定的窗口 win 相关联。 请注意你必须显式地保持所返回的面板对象。 如果你不这样做，面板对象会被垃圾回收并从面板栈中被移除。

curses.panel.top_panel()

返回面板栈中的顶部面板。

curses.panel.update_panels()

在面板栈发生改变后更新虚拟屏幕。 这不会调用 curses.doupdate()，因此你不必自己执行此操作。

Panel 对象

Panel 对象，如上面 new_panel() 所返回的对象，是带有栈顺序的多个窗口。 总是会有一个窗口与确定内容的面板相关联，面板方法会负责窗口在面板栈中的深度。

Panel 对象具有以下方法:

Panel.above()

返回当前面板之上的面板。

Panel.below()

返回当前面板之下的面板。

Panel.bottom()

将面板推至栈底部。

Panel.hidden()

如果面板被隐藏（不可见）则返回 True，否则返回 False。

Panel.hide()

隐藏面板。 这不会删除对象，它只是让窗口在屏幕上不可见。

Panel.move(y, x)

将面板移至屏幕坐标 (y, x)。

Panel.replace(win)

将与面板相关联的窗口改为窗口 win。

Panel.set_userptr(obj)

将面板的用户指向设为 obj。 这被用来将任意数据与面板相关联，数据可以是任何 Python 对象。

Panel.show()

显示面板（面板可能已被隐藏）。

Panel.top()

将面板推至栈顶部。

Panel.userptr()

返回面板的用户指针。 这可以是任何 Python 对象。

Panel.window()

返回与面板相关联的窗口对象。

platform --- 获取底层平台的标识数据

源代码： Lib/platform.py [https://github.com/python/cpython/tree/3.10/Lib/platform.py]

注解

特定平台按字母顺序排列，Linux 包括在 Unix 小节之中。

跨平台

platform.architecture(executable=sys.executable, bits='', linkage='')

查询给定的可执行文件（默认为 Python 解释器二进制码文件）来获取各种架构信息。

返回一个元素 (bits, linkage)，其中包含可执行文件所使用的位架构和链接格式信息。 这两个值均以字符串形式返回。

无法确定的值将返回为形参预设所给出的值。 如果给出的位数为 ''，则会使用 sizeof(pointer) (或者当 Python 版本 < 1.5.2 时为 sizeof(long)) 作为所支持的指针大小的提示。

此函数依赖于系统的 file 命令来执行实际的操作。 这在几乎所有 Unix 平台和某些非 Unix 平台上只有当可执行文件指向 Python 解释器时才可用。 当以上要求不满足时将会使用合理的默认值。

注解

在 macOS (也许还有其他平台) 上，可执行文件可能是包含多种架构的通用文件。

要获取当前解释器的“64 位性”，更可靠的做法是查询 sys.maxsize 属性:

is_64bits = sys.maxsize > 2**32

platform.machine()

返回机器类型，例如 'AMD64' 。 如果该值无法确定则会返回一个空字符串。

platform.node()

返回计算机的网络名称（可能不是完整限定名称！）。 如果该值无法确定则会返回一个空字符串。

platform.platform(aliased=0, terse=0)

返回一个标识底层平台的字符串，其中带有尽可能多的有用信息。

输出信息的目标是“人类易读”而非机器易解析。 它在不同平台上可能看起来不一致，这是有意为之的。

如果 aliased 为真值，此函数将使用各种平台不同与其通常名称的别名来报告系统名称，例如 SunOS 将被报告为 Solaris。 system_alias() 函数将被用于实现此功能。

将 terse 设为真值将导致此函数只返回标识平台所必须的最小量信息。

在 3.8 版更改: 在 macOS 上，此函数现在会在 mac_ver() 返回的发布版字符串非空时使用它，以便获取 macOS 版本而非 darwin 版本。

platform.processor()

返回（真实的）处理器名称，例如 'amdk6'。

如果该值无法确定则将返回空字符串。 请注意许多平台都不提供此信息或是简单地返回与 machine() 相同的值。 NetBSD 则会提供此信息。

platform.python_build()

返回一个元组 (buildno, builddate)，以字符串表示的 Python 编译代码和日期。

platform.python_compiler()

返回一个标识用于编译 Python 的编译器的的字符串。

platform.python_branch()

返回一个标识 Python 实现的 SCM 分支的字符串。

platform.python_implementation()

返回一个标识 Python 实现的字符串。 可能的返回值有: 'CPython', 'IronPython', 'Jython', 'PyPy'。

platform.python_revision()

返回一个标识 Python 实现的 SCM 修订版的字符串。

platform.python_version()

将 Python 版本以字符串 'major.minor.patchlevel' 形式返回。

请注意此返回值不同于 Python sys.version，它将总是包括 patchlevel (默认为 0)。

platform.python_version_tuple()

将 Python 版本以字符串元组 (major, minor, patchlevel) 形式返回。

请注意此返回值不同于 Python sys.version，它将总是包括 patchlevel (默认为 '0')。

platform.release()

返回系统的发布版本，例如 '2.2.0' 或 'NT'，如果该值无法确定则将返回一个空字符串。

platform.system()

返回系统平台/OS的名称，例如 'Linux', 'Darwin', 'Java', 'Windows'。 如果该值无法确定则将返回一个空字符串。

platform.system_alias(system, release, version)

返回别名为某些系统所使用的常见营销名称的 (system, release, version)。 它还会在可能导致混淆的情况下对信息进行一些重排序操作。

platform.version()

返回系统的发布版本信息，例如 '#3 on degas'。 如果该值无法确定则将返回一个空字符串。

platform.uname()

具有高可移植性的 uname 接口。 返回包含六个属性的 namedtuple(): system, node, release, version, machine 和 processor。

请注意此函数添加的第六个属性 (processor) 并不存在于 os.uname() 的结果中。 并且前两个属性的属性名称也不一致；os.uname() 是将它们称为 sysname 和 nodename。

无法确定的条目会被设为 ''。

在 3.3 版更改: 结果由元组改为 namedtuple() 。

Java平台

platform.java_ver(release='', vendor='', vminfo=('', '', ''), osinfo=('', '', ''))

Jython 的版本接口

返回一个元组 (release, vendor, vminfo, osinfo)，其中 vminfo 为元组 (vm_name, vm_release, vm_vendor) 而 osinfo 为元组 (os_name, os_version, os_arch)。 无法确定的值将设为由形参所给出的默认值 (默认均为 '')。

Windows平台

platform.win32_ver(release='', version='', csd='', ptype='')

从 Windows 注册表获取额外的版本信息并返回一个元组 (release, version, csd, ptype) 表示 OS 发行版, 版本号, CSD 级别 (Service Pack) 和 OS 类型 (多个/单个处理器)。无法确定的值被设置为作为参数给出的默认值（这些参数都默认为一个空字符串）。

一点提示: ptype 在单个处理器的 NT 机器上为 'Uniprocessor Free' 而在多个处理器的机器上为 'Multiprocessor Free'。 'Free' 是指该 OS 版本没有调试代码。 它还可能显示 'Checked' 表示该 OS 版本使用了调试代码，即检测参数、范围等的代码。

platform.win32_edition()

返回一个代表当前 Windows 版本的字符串，或者在该值无法确定时返回 None 。 可能的值包括但不限于 'Enterprise', 'IoTUAP', 'ServerStandard' 和 'nanoserver'。

3.8 新版功能.

platform.win32_is_iot()

如果 win32_edition() 返回的 Windows 版本被识别为 IoT 版则返回 True。

3.8 新版功能.

macOS 平台

platform.mac_ver(release='', versioninfo=('', '', ''), machine='')

获取 macOS 版本信息并将其返回为元组 (release, versioninfo, machine)，其中 versioninfo 是一个元组 (version, dev_stage, non_release_version)。

无法确定的条目会被设为 ''。 所有元组条目均为字符串。

Unix 平台

platform.libc_ver(executable=sys.executable, lib='', version='', chunksize=16384)

尝试确定可执行文件（默认为 Python 解释器）所链接到的 libc 版本。 返回一个字符串元组 (lib, version)，当查找失败时其默认值将设为给定的形参值。

请注意此函数对于不同 libc 版本向可执行文件添加符号的方式有深层的关联，可能仅适用于使用 gcc 编译出来的可执行文件。

文件将按 chunksize 个字节的分块来读取和扫描。

Linux 平台

platform.freedesktop_os_release()

从 os-release 文件获取操作系统标识并将其作为一个字典返回。 os-release 文件是 freedesktop.org 标准 [https://www.freedesktop.org/software/systemd/man/os-release.html] 并在大多数 Linux 发行版上可用。 一个重要的例外是 Android 和基于 Android 的发行版。

当 /etc/os-release 或 /usr/lib/os-release 均无法读取时将引发 OSError 或其子类。

成功时，该函数将返回一个字典，其中键和值均为字符串。 值当中的特殊字符例如 " 和 {TX-PL-LABEL}#x60; 会被复原。 字段 NAME, ID 和 PRETTY_NAME 总是会按照标准来定义。 所有其他字段都是可选的。 厂商可能会包括额外的字段。

请注意 NAME, VERSION 和 VARIANT 等字段是适用于向用户展示的字符串。 程序应当使用 ID, ID_LIKE, VERSION_ID 或 VARIANT_ID 等字段来标识 Linux 发行版。

示例:

def get_like_distro():
    info = platform.freedesktop_os_release()
    ids = [info["ID"]]
    if "ID_LIKE" in info:
        # ids are space separated and ordered by precedence
        ids.extend(info["ID_LIKE"].split())
    return ids

3.10 新版功能.

errno --- 标准 errno 系统符号

该模块提供了标准的 errno 系统符号。每个符号的值都是相应的整数值。名称和描述借用自 linux/include/errno.h ，它应该是全包含的。

errno.errorcode

提供从 errno 值到底层系统中字符串名称的映射的字典。例如， errno.errorcode[errno.EPERM] 映射为 'EPERM' 。

如果要将数字的错误代码转换为错误信息，请使用 os.strerror()。

在下面的列表中，当前平台上没有使用的符号没有被本模块定义。 已定义的符号的具体列表可参见 errno.errorcode.keys()。 可用的符号包括：

errno.EPERM

操作不允许。这个错误被映射到异常 PermissionError 。

errno.ENOENT

没有这样的文件或目录。这个错误被映射到异常 FileNotFoundError 。

errno.ESRCH

没有这样的进程。这个错误被映射到异常 ProcessLookupError 。

errno.EINTR

系统调用中断。这个错误被映射到异常 InterruptedError 。

errno.EIO

I/O 错误

errno.ENXIO

无此设备或地址

errno.E2BIG

参数列表过长

errno.ENOEXEC

执行格式错误

errno.EBADF

错误的文件号

errno.ECHILD

没有子进程。这个错误被映射到异常 ChildProcessError 。

errno.EAGAIN

再试一次。这个错误被映射到异常 BlockingIOError 。

errno.ENOMEM

内存不足

errno.EACCES

权限被拒绝。 这个错误被映射到异常 PermissionError 。

errno.EFAULT

错误的地址

errno.ENOTBLK

需要块设备

errno.EBUSY

设备或资源忙

errno.EEXIST

文件存在。这个错误被映射到异常 FileExistsError 。

errno.EXDEV

跨设备链接

errno.ENODEV

无此设备

errno.ENOTDIR

不是一个目录。这个错误被映射到异常 NotADirectoryError 。

errno.EISDIR

是一个目录。这个错误被映射到异常 IsADirectoryError 。

errno.EINVAL

无效的参数

errno.ENFILE

文件表溢出

errno.EMFILE

打开的文件过多

errno.ENOTTY

不是打字机

errno.ETXTBSY

文本文件忙

errno.EFBIG

文件过大

errno.ENOSPC

设备已无可用空间

errno.ESPIPE

非法查找

errno.EROFS

只读文件系统

errno.EMLINK

链接过多

errno.EPIPE

管道中断。这个错误被映射到异常 BrokenPipeError 。

errno.EDOM

数学参数超出函数范围

errno.ERANGE

数学运算结果无法表示

errno.EDEADLK

将发生资源死锁

errno.ENAMETOOLONG

文件名过长

errno.ENOLCK

没有可用的记录锁

errno.ENOSYS

功能未实现

errno.ENOTEMPTY

目录非空

errno.ELOOP

遇到过多的符号链接

errno.EWOULDBLOCK

操作会阻塞。这个错误被映射到异常 BlockingIOError 。

errno.ENOMSG

没有所需类型的消息

errno.EIDRM

标识符被移除

errno.ECHRNG

信道编号超出范围

errno.EL2NSYNC

级别 2 未同步

errno.EL3HLT

级别 3 已停止

errno.EL3RST

级别 3 重置

errno.ELNRNG

链接编号超出范围

errno.EUNATCH

未附加协议驱动

errno.ENOCSI

没有可用的 CSI 结构

errno.EL2HLT

级别 2 已停止

errno.EBADE

无效的交换

errno.EBADR

无效的请求描述符

errno.EXFULL

交换已满

errno.ENOANO

没有阳极

errno.EBADRQC

无效的请求码·

errno.EBADSLT

无效的槽位

errno.EDEADLOCK

文件锁定死锁错误

errno.EBFONT

错误的字体文件格式

errno.ENOSTR

设备不是流

errno.ENODATA

没有可用的数据

errno.ETIME

计时器已到期

errno.ENOSR

流资源不足

errno.ENONET

机器不在网络上

errno.ENOPKG

包未安装

errno.EREMOTE

对象是远程的

errno.ENOLINK

链接已被切断

errno.EADV

广告错误

errno.ESRMNT

挂载错误

errno.ECOMM

发送时通讯错误

errno.EPROTO

协议错误

errno.EMULTIHOP

已尝试多跳

errno.EDOTDOT

RFS 专属错误

errno.EBADMSG

非数据消息

errno.EOVERFLOW

值相对于已定义数据类型过大

errno.ENOTUNIQ

名称在网络上不唯一

errno.EBADFD

文件描述符处于错误状态

errno.EREMCHG

远端地址已改变

errno.ELIBACC

无法访问所需的共享库

errno.ELIBBAD

访问已损坏的共享库

errno.ELIBSCN

a.out 中的 .lib 部分已损坏

errno.ELIBMAX

尝试链接过多的共享库

errno.ELIBEXEC

无法直接执行共享库

errno.EILSEQ

非法字节序列

errno.ERESTART

已中断系统调用需要重启

errno.ESTRPIPE

流管道错误

errno.EUSERS

用户过多

errno.ENOTSOCK

在非套接字上执行套接字操作

errno.EDESTADDRREQ

需要目标地址

errno.EMSGSIZE

消息过长

errno.EPROTOTYPE

套接字的协议类型错误

errno.ENOPROTOOPT

协议不可用

errno.EPROTONOSUPPORT

协议不受支持

errno.ESOCKTNOSUPPORT

套接字类型不受支持

errno.EOPNOTSUPP

操作在传输端点上不受支持

errno.EPFNOSUPPORT

协议族不受支持

errno.EAFNOSUPPORT

地址族不受协议支持

errno.EADDRINUSE

地址已被使用

errno.EADDRNOTAVAIL

无法分配要求的地址

errno.ENETDOWN

网络已断开

errno.ENETUNREACH

网络不可达

errno.ENETRESET

网络因重置而断开连接

errno.ECONNABORTED

软件导致连接中止。这个错误被映射到异常 ConnectionAbortedError 。

errno.ECONNRESET

连接被对方重置。这个错误被映射到异常 ConnectionResetError 。

errno.ENOBUFS

没有可用的缓冲区空间

errno.EISCONN

传输端点已连接

errno.ENOTCONN

传输端点未连接

errno.ESHUTDOWN

在传输端点关闭后无法发送。这个错误被映射到异常 BrokenPipeError 。

errno.ETOOMANYREFS

引用过多：无法拼接

errno.ETIMEDOUT

连接超时。这个错误被映射到异常 TimeoutError 。

errno.ECONNREFUSED

连接被拒绝。这个错误被映射到异常 ConnectionRefusedError 。

errno.EHOSTDOWN

主机已关闭

errno.EHOSTUNREACH

没有到主机的路由

errno.EALREADY

操作已经在进行中。这个错误被映射到异常 BlockingIOError 。

errno.EINPROGRESS

操作现在正在进行中。这个错误被映射到异常 BlockingIOError 。

errno.ESTALE

过期的 NFS 文件句柄

errno.EUCLEAN

结构需要清理

errno.ENOTNAM

不是 XENIX 命名类型文件

errno.ENAVAIL

没有可用的 XENIX 信标

errno.EISNAM

是命名类型文件

errno.EREMOTEIO

远程 I/O 错误

errno.EDQUOT

超出配额

ctypes --- Python 的外部函数库

源代码: Lib/ctypes [https://github.com/python/cpython/tree/3.10/Lib/ctypes]

ctypes 是 Python 的外部函数库。它提供了与 C 兼容的数据类型，并允许调用 DLL 或共享库中的函数。可使用该模块以纯 Python 形式对这些库进行封装。

ctypes 教程

注：本教程中的示例代码使用 doctest 来保证它们能正确运行。 由于有些代码示例在 Linux, Windows 或 macOS 上的行为有所不同，它们在注释中包含了一些 doctest 指令。

注意：部分示例代码引用了 ctypes c_int 类型。在 sizeof(long) == sizeof(int) 的平台上此类型是 c_long 的一个别名。所以，在程序输出 c_long 而不是你期望的 c_int 时不必感到迷惑 --- 它们实际上是同一种类型。

载入动态连接库

ctypes 导出了 cdll 对象，在 Windows 系统中还导出了 windll 和 oledll 对象用于载入动态连接库。

通过操作这些对象的属性，你可以载入外部的动态链接库。cdll 载入按标准的 cdecl 调用协议导出的函数，而 windll 导入的库按 stdcall 调用协议调用其中的函数。 oledll 也按 stdcall 调用协议调用其中的函数，并假定该函数返回的是 Windows HRESULT 错误代码，并当函数调用失败时，自动根据该代码甩出一个 OSError 异常。

在 3.3 版更改: 原来在 Windows 下抛出的异常类型 WindowsError 现在是 OSError 的一个别名。

这是一些 Windows 下的例子。注意：msvcrt 是微软 C 标准库，包含了大部分 C 标准函数，这些函数都是以 cdecl 调用协议进行调用的。

>>> from ctypes import *
>>> print(windll.kernel32)
<WinDLL 'kernel32', handle ... at ...>
>>> print(cdll.msvcrt)
<CDLL 'msvcrt', handle ... at ...>
>>> libc = cdll.msvcrt
>>>

Windows 会自动添加通常的 .dll 文件扩展名。

注解

通过 cdll.msvcrt 调用的标准 C 函数，可能会导致调用一个过时的，与当前 Python 所不兼容的函数。因此，请尽量使用标准的 Python 函数，而不要使用 msvcrt 模块。

在 Linux 下，必须使用 包含 文件扩展名的文件名来导入共享库。因此不能简单使用对象属性的方式来导入库。因此，你可以使用方法 LoadLibrary()，或构造 CDLL 对象来导入库。

>>> cdll.LoadLibrary("libc.so.6")
<CDLL 'libc.so.6', handle ... at ...>
>>> libc = CDLL("libc.so.6")
>>> libc
<CDLL 'libc.so.6', handle ... at ...>
>>>

操作导入的动态链接库中的函数

通过操作dll对象的属性来操作这些函数。

>>> from ctypes import *
>>> 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
>>>

注意：Win32 系统的动态库，比如 kernel32 和 user32，通常会同时导出同一个函数的 ANSI 版本和 UNICODE 版本。UNICODE 版本通常会在名字最后以 W 结尾，而 ANSI 版本的则以 A 结尾。 win32的 GetModuleHandle 函数会根据一个模块名返回一个 模块句柄，该函数暨同时包含这样的两个版本的原型函数，并通过宏 UNICODE 是否定义，来决定宏 GetModuleHandle 导出的是哪个具体函数。

/* ANSI version */
HMODULE GetModuleHandleA(LPCSTR lpModuleName);
/* UNICODE version */
HMODULE GetModuleHandleW(LPCWSTR lpModuleName);

windll 不会通过这样的魔法手段来帮你决定选择哪一种函数，你必须显式的调用 GetModuleHandleA 或 GetModuleHandleW，并分别使用字节对象或字符串对象作参数。

有时候，dlls的导出的函数名不符合 Python 的标识符规范，比如 "??2@YAPAXI@Z"。此时，你必须使用 getattr() 方法来获得该函数。

>>> getattr(cdll.msvcrt, "??2@YAPAXI@Z")
<_FuncPtr object at 0x...>
>>>

Windows 下，有些 dll 导出的函数没有函数名，而是通过其顺序号调用。对此类函数，你也可以通过 dll 对象的数值索引来操作这些函数。

>>> 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
>>>

调用函数

你可以貌似是调用其它 Python 函数那样直接调用这些函数。在这个例子中，我们调用了 time() 函数，该函数返回一个系统时间戳（从 Unix 时间起点到现在的秒数），而``GetModuleHandleA()`` 函数返回一个 win32 模块句柄。

此函数中调用的两个函数都使用了空指针（用 None 作为空指针）:

>>> print(libc.time(None))
1150640792
>>> print(hex(windll.kernel32.GetModuleHandleA(None)))
0x1d000000
>>>

如果你用 cdecl 调用方式调用 stdcall 约定的函数，则会甩出一个异常 ValueError。反之亦然。

>>> 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)
>>>

你必须阅读这些库的头文件或说明文档来确定它们的正确的调用协议。

在 Windows 中，ctypes 使用 win32 结构化异常处理来防止由于在调用函数时使用非法参数导致的程序崩溃。

>>> windll.kernel32.GetModuleHandleA(32)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
OSError: exception: access violation reading 0x00000020
>>>

然而，总有许多办法，通过调用 ctypes 使得 Python 程序崩溃。因此，你必须小心使用。 faulthandler 模块可以用于帮助诊断程序崩溃的原因。（比如由于错误的C库函数调用导致的段错误）。

在原生 Python 对象中，None、整数、字节串以及（Unicode）字符串可以直接在这些函数调用中作为参数传递。 None 作为 C 的 NULL 指针传递，字节串和字符串作为指向包含其数据的内存块的指针传递 (char* 或 wchar_t*)。 Python 整数以平台默认的 C 类型 int 传递，它们的值会被掩码化以适应 C 中的类型。

在我们开始调用函数前，我们必须先了解作为函数参数的 ctypes 数据类型。

基础数据类型

ctypes 定义了一些和C兼容的基本数据类型：

ctypes 类型 | C 类型 | Python 类型
c_bool | _Bool | bool (1)
c_char | char | 单字符字节串对象
c_wchar | wchar_t | 单字符字符串
c_byte | char | int
c_ubyte | unsigned char | int
c_short | short | int
c_ushort | unsigned short | int
c_int | int | int
c_uint | unsigned int | int
c_long | long | int
c_ulong | unsigned long | int
c_longlong | __int64 或 long long | int
c_ulonglong | unsigned __int64 或 unsigned long long | int
c_size_t | size_t | int
c_ssize_t | ssize_t or Py_ssize_t | int
c_float | float | float
c_double | double | float
c_longdouble | long double | float
c_char_p | char* (以 NUL 结尾) | 字节串对象或 None
c_wchar_p | wchar_t* (以 NUL 结尾) | 字符串或 None
c_void_p | void* | int 或 None

构造函数接受任何具有真值的对象。

所有这些类型都可以通过使用正确类型和值的可选初始值调用它们来创建:

>>> c_int()
c_long(0)
>>> c_wchar_p("Hello, World")
c_wchar_p(140018365411392)
>>> c_ushort(-3)
c_ushort(65533)
>>>

由于这些类型是可变的，它们的值也可以在以后更改:

>>> i = c_int(42)
>>> print(i)
c_long(42)
>>> print(i.value)
42
>>> i.value = -99
>>> print(i.value)
-99
>>>

当给指针类型的对象 c_char_p, c_wchar_p 和 c_void_p 等赋值时，将改变它们所指向的 内存地址，而 不是 它们所指向的内存区域的 内容 (这是理所当然的，因为 Python 的 bytes 对象是不可变的):

>>> 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)              # the memory location has changed
c_wchar_p(139966783348904)
>>> print(c_s.value)
Hi, there
>>> print(s)                # first object is unchanged
Hello, World
>>>

但你要注意不能将它们传递给会改变指针所指内存的函数。如果你需要可改变的内存块，ctypes 提供了 create_string_buffer() 函数，它提供多种方式创建这种内存块。当前的内存块内容可以通过 raw 属性存取，如果你希望将它作为NUL结束的字符串，请使用 value 属性:

>>> from ctypes import *
>>> p = create_string_buffer(3)            # create a 3 byte buffer, initialized to NUL bytes
>>> print(sizeof(p), repr(p.raw))
3 b'\x00\x00\x00'
>>> p = create_string_buffer(b"Hello")     # create a buffer containing a NUL terminated string
>>> print(sizeof(p), repr(p.raw))
6 b'Hello\x00'
>>> print(repr(p.value))
b'Hello'
>>> p = create_string_buffer(b"Hello", 10) # create a 10 byte buffer
>>> 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'
>>>

The create_string_buffer() function replaces the c_buffer() function (which is still available as an alias), as well as the c_string() function from earlier ctypes releases. To create a mutable memory block containing unicode characters of the C type wchar_t use the create_unicode_buffer() function.

调用函数，继续

注意 printf 将打印到真正标准输出设备，而*不是* sys.stdout，因此这些实例只能在控制台提示符下工作，而不能在 IDLE 或 PythonWin 中运行。

>>> 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>
ArgumentError: argument 2: TypeError: Don't know how to convert parameter 2
>>>

正如前面所提到过的，除了整数、字符串以及字节串之外，所有的 Python 类型都必须使用它们对应的 ctypes 类型包装，才能够被正确地转换为所需的C语言类型。

>>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))
An int 1234, a double 3.140000
31
>>>

调用可变函数

在许多平台上通过 ctypes 调用可变函数与调用带有固定数量形参的函数是完全一样的。 在某些平台，特别是针对 Apple 平台的 ARM64 上，可变函数的调用约定与常规函数则是不同的。

在那些平台上要求为常规、非可变函数参数指定 argtypes 属性:

libc.printf.argtypes = [ctypes.c_char_p]

Because specifying the attribute does inhibit portability it is advised to always specify argtypes for all variadic functions.

使用自定义的数据类型调用函数

你也可以通过自定义 ctypes 参数转换方式来允许自定义类型作为参数。 ctypes 会寻找 _as_parameter_ 属性并使用它作为函数参数。当然，它必须是数字、字符串或者二进制字符串:

>>> 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
>>>

如果你不想把实例的数据存储到 _as_parameter_ 属性。可以通过定义 property 函数计算出这个属性。

指定必选参数的类型(函数原型)

可以通过设置 argtypes 属性的方法指定从 DLL 中导出函数的必选参数类型。

argtypes 必须是一个 C 数据类型的序列 (这里的 printf 可能不是个好例子，因为它是变长参数，而且每个参数的类型依赖于格式化字符串，不过尝试这个功能也很方便):

>>> 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
>>>

指定数据类型可以防止不合理的参数传递（就像 C 函数的原型），并且会自动尝试将参数转换为需要的类型:

>>> printf(b"%d %d %d", 1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ArgumentError: argument 2: TypeError: wrong type
>>> printf(b"%s %d %f\n", b"X", 2, 3)
X 2 3.000000
13
>>>

如果你想通过自定义类型传递参数给函数，必须实现 from_param() 类方法，才能够将此自定义类型用于 argtypes 序列。from_param() 类方法接受一个 Python 对象作为函数输入，它应该进行类型检查或者其他必要的操作以保证接收到的对象是合法的，然后返回这个对象，或者它的 _as_parameter_ 属性，或者其他你想要传递给 C 函数的参数。这里也一样，返回的结果必须是整型、字符串、二进制字符串、 ctypes 类型，或者一个具有 _as_parameter_ 属性的对象。

返回类型

默认情况下都会假定函数返回 C int 类型。 其他返回类型可以通过设置函数对象的 restype 属性来指定。

这是个更高级的例子，它调用了 strchr 函数，这个函数接收一个字符串指针以及一个字符作为参数，返回另一个字符串指针。

>>> 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
>>>

如果希望避免上述的 ord("x") 调用，可以设置 argtypes 属性，第二个参数就会将单字符的 Python 二进制字符对象转换为 C 字符:

>>> strchr.restype = c_char_p
>>> strchr.argtypes = [c_char_p, c_char]
>>> strchr(b"abcdef", b"d")
'def'
>>> strchr(b"abcdef", b"def")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ArgumentError: argument 2: TypeError: one character string expected
>>> print(strchr(b"abcdef", b"x"))
None
>>> strchr(b"abcdef", b"d")
'def'
>>>

如果外部函数返回了一个整数，你也可以使用要给可调用的 Python 对象（比如函数或者类）作为 restype 属性的值。将会以 C 函数返回的 整数 对象作为参数调用这个可调用对象，执行后的结果作为最终函数返回值。这在错误返回值校验和自动抛出异常等方面比较有用。

>>> 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.
>>>

WinError 函数可以调用 Windows 的 FormatMessage() API 获取错误码的字符串说明，然后 返回 一个异常。 WinError 接收一个可选的错误码作为参数，如果没有的话，它将调用 GetLastError() 获取错误码。

请注意，使用 errcheck 属性可以实现更强大的错误检查手段；详情请见参考手册。

传递指针（或以引用方式传递形参）

有时候 C 函数接口可能由于要往某个地址写入值，或者数据太大不适合作为值传递，从而希望接收一个 指针 作为数据参数类型。这和 传递参数引用 类似。

ctypes 暴露了 byref() 函数用于通过引用传递参数，使用 pointer() 函数也能达到同样的效果，只不过 pointer() 需要更多步骤，因为它要先构造一个真实指针对象。所以在 Python 代码本身不需要使用这个指针对象的情况下，使用 byref() 效率更高。

>>> 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''
>>> 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'
>>>

结构体和联合

结构体和联合必须继承自 ctypes 模块中的 Structure 和 Union 。子类必须定义 _fields_ 属性。 _fields_ 是一个二元组列表，二元组中包含 field name 和 field type 。

type 字段必须是一个 ctypes 类型，比如 c_int，或者其他 ctypes 类型: 结构体、联合、数组、指针。

这是一个简单的 POINT 结构体，它包含名称为 x 和 y 的两个变量，还展示了如何通过构造函数初始化结构体。

>>> 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
>>>

当然，你可以构造更复杂的结构体。一个结构体可以通过设置 type 字段包含其他结构体或者自身。

这是以一个 RECT 结构体，他包含了两个 POINT ，分别叫 upperleft 和 lowerright:

>>> 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
>>>

嵌套结构体可以通过几种方式构造初始化:

>>> r = RECT(POINT(1, 2), POINT(3, 4))
>>> r = RECT((1, 2), (3, 4))

可以通过 类 获取字段 descriptor ，它能提供很多有用的调试信息。

>>> print(POINT.x)
<Field type=c_long, ofs=0, size=4>
>>> print(POINT.y)
<Field type=c_long, ofs=4, size=4>
>>>

警告

ctypes 不支持带位域的结构体、联合以值的方式传给函数。这可能在 32 位 x86 平台上可以正常工作，但是对于一般情况，这种行为是未定义的。带位域的结构体、联合应该总是通过指针传递给函数。

结构体/联合字段对齐及字节顺序

默认情况下，结构体和联合的字段与 C 的字节对齐是一样的。也可以在定义子类的时候指定类的 _pack_ 属性来覆盖这种行为。 它必须设置为一个正整数，表示字段的最大对齐字节。这和 MSVC 中的 #pragma pack(n) 功能一样。

ctypes 中的结构体和联合使用的是本地字节序。要使用非本地字节序，可以使用 BigEndianStructure, LittleEndianStructure, BigEndianUnion, and LittleEndianUnion 作为基类。这些类不能包含指针字段。

结构体和联合中的位域

结构体和联合中是可以包含位域字段的。位域只能用于整型字段，位长度通过 _fields_ 中的第三个参数指定:

>>> class Int(Structure):
...     _fields_ = [("first_16", c_int, 16),
...                 ("second_16", c_int, 16)]
...
>>> print(Int.first_16)
<Field type=c_long, ofs=0:0, bits=16>
>>> print(Int.second_16)
<Field type=c_long, ofs=0:16, bits=16>
>>>

数组

数组是一个序列，包含指定个数元素，且必须类型相同。

创建数组类型的推荐方式是使用一个类型乘以一个正数:

TenPointsArrayType = POINT * 10

下面是一个构造的数据案例，结构体中包含了4个 POINT 和一些其他东西。

>>> 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
>>>

和平常一样，通过调用它创建实例:

arr = TenPointsArrayType()
for pt in arr:
    print(pt.x, pt.y)

以上代码会打印几行 0 0 ，因为数组内容被初始化为 0.

也能通过指定正确类型的数据来初始化:

>>> 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
>>>

指针

可以将 ctypes 类型数据传入 pointer() 函数创建指针:

>>> from ctypes import *
>>> i = c_int(42)
>>> pi = pointer(i)
>>>

指针实例拥有 contents 属性，它返回指针指向的真实对象，如上面的 i 对象:

>>> pi.contents
c_long(42)
>>>

注意 ctypes 并没有 OOR （返回原始对象）, 每次访问这个属性时都会构造返回一个新的相同对象:

>>> pi.contents is i
False
>>> pi.contents is pi.contents
False
>>>

将这个指针的 contents 属性赋值为另一个 c_int 实例将会导致该指针指向该实例的内存地址:

>>> i = c_int(99)
>>> pi.contents = i
>>> pi.contents
c_long(99)
>>>

指针对象也可以通过整数下标进行访问:

>>> pi[0]
99
>>>

通过整数下标赋值可以改变指针所指向的真实内容:

>>> print(i)
c_long(99)
>>> pi[0] = 22
>>> print(i)
c_long(22)
>>>

使用 0 以外的索引也是合法的，但是你必须确保知道自己为什么这么做，就像 C 语言中: 你可以访问或者修改任意内存内容。 通常只会在函数接收指针是才会使用这种特性，而且你 知道 这个指针指向的是一个数组而不是单个值。

内部细节, pointer() 函数不只是创建了一个指针实例，它首先创建了一个指针 类型 。这是通过调用 POINTER() 函数实现的，它接收 ctypes 类型为参数，返回一个新的类型:

>>> 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...>
>>>

无参调用指针类型可以创建一个 NULL 指针。 NULL 指针的布尔值是 False

>>> null_ptr = POINTER(c_int)()
>>> print(bool(null_ptr))
False
>>>

解引用指针的时候， ctypes 会帮你检测是否指针为 NULL (但是解引用无效的 非 NULL 指针仍会导致 Python 崩溃):

>>> 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
>>>

类型转换

通常情况下, ctypes 具有严格的类型检查。这代表着, 如果在函数 argtypes 中或者结构体定义成员中有 POINTER(c_int) 类型，只有相同类型的实例才会被接受。 也有一些例外。比如，你可以传递兼容的数组实例给指针类型。所以，对于 POINTER(c_int) ，ctypes 也可以接受 c_int 类型的数组:

>>> 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
>>>

另外，如果一个函数 argtypes 列表中的参数显式的定义为指针类型(如 POINTER(c_int) )，指针所指向的 类型 (这个例子中是 c_int )也可以传递给函数。ctypes 会自动调用对应的 byref() 转换。

可以给指针内容赋值为 None 将其设置为 Null

>>> bar.values = None
>>>

有时候你拥有一个不兼容的类型。 在 C 中，你可以将一个类型强制转换为另一个。 ctypes 中的 a cast() 函数提供了相同的功能。 上面的结构体 Bar 的 value 字段接收 POINTER(c_int) 指针或者 c_int 数组，但是不能接受其他类型的实例:

>>> 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
>>>

这种情况下, 需要手动使用 cast() 函数。

cast() 函数可以将一个指针实例强制转换为另一种 ctypes 类型。 cast() 接收两个参数，一个 ctypes 指针对象或者可以被转换为指针的其他类型对象，和一个 ctypes 指针类型。 返回第二个类型的一个实例，该返回实例和第一个参数指向同一片内存空间:

>>> a = (c_byte * 4)()
>>> cast(a, POINTER(c_int))
<ctypes.LP_c_long object at ...>
>>>

所以 cast() 可以用来给结构体 Bar 的 values 字段赋值:

>>> bar = Bar()
>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))
>>> print(bar.values[0])
0
>>>

不完整类型

不完整类型 即还没有定义成员的结构体、联合或者数组。在 C 中，它们通常用于前置声明，然后在后面定义:

struct cell; /* forward declaration */

struct cell {
    char *name;
    struct cell *next;
};

直接翻译成 ctypes 的代码如下，但是这行不通:

>>> 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
>>>

因为新的 cell 类 在 class 语句结束之前还没有完成定义。在 ctypes 中，我们可以先定义 cell 类，在 class 语句结束之后再设置 _fields_ 属性:

>>> from ctypes import *
>>> class cell(Structure):
...     pass
...
>>> cell._fields_ = [("name", c_char_p),
...                  ("next", POINTER(cell))]
>>>

让我们试试。我们定义两个 cell 实例，让它们互相指向对方，然后通过指针链式访问几次:

>>> 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
>>>

回调函数

ctypes 允许创建一个指向 Python 可调用对象的 C 函数。它们有时候被称为 回调函数 。

首先，你必须为回调函数创建一个类，这个类知道调用约定，包括返回值类型以及函数接收的参数类型及个数。

CFUNCTYPE() 工厂函数使用 cdecl 调用约定创建回调函数类型。在 Windows 上， WINFUNCTYPE() 工厂函数使用 stdcall 调用约定为回调函数创建类型。

这些工厂函数的第一个参数是返回值类型，回调函数的参数类型作为剩余参数。

这里展示一个使用 C 标准库函数 qsort() 的例子，它使用一个回调函数对数据进行排序。 qsort() 将用来给整数数组排序:

>>> IntArray5 = c_int * 5
>>> ia = IntArray5(5, 1, 7, 33, 99)
>>> qsort = libc.qsort
>>> qsort.restype = None
>>>

qsort() 必须接收的参数，一个指向待排序数据的指针，元素个数，每个元素的大小，以及一个指向排序函数的指针，即回调函数。然后回调函数接收两个元素的指针，如果第一个元素小于第二个，则返回一个负整数，如果相等则返回0，否则返回一个正整数。

所以，我们的回调函数要接收两个整数指针，返回一个整数。首先我们创建回调函数的 类型

>>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
>>>

首先，这是一个简单的回调，它会显示传入的值:

>>> def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return 0
...
>>> cmp_func = CMPFUNC(py_cmp_func)
>>>

结果:

>>> 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
>>>

现在我们可以比较两个元素并返回有用的结果了:

>>> 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
>>>

我们可以轻易地验证，现在数组是有序的了:

>>> for i in ia: print(i, end=" ")
...
1 5 7 33 99
>>>

这些工厂函数可以当作装饰器工厂，所以可以这样写:

>>> @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
>>>

注解

请确保你维持的 CFUNCTYPE() 对象的引用周期与它们在 C 代码中的使用期一样长。 ctypes 不会确保这一点，如果不这样做，它们可能会被垃圾回收，导致程序在执行回调函数时发生崩溃。

注意，如果回调函数在Python之外的另外一个线程使用(比如，外部代码调用这个回调函数)， ctypes 会在每一次调用上创建一个虚拟 Python 线程。这个行为在大多数情况下是合理的，但也意味着如果有数据使用 threading.local 方式存储，将无法访问，就算它们是在同一个 C 线程中调用的 。

访问 dll 的导出变量

一些动态链接库不仅仅导出函数，也会导出变量。一个例子就是 Python 库本身的 Py_OptimizeFlag ，根据启动选项 -O 、 -OO 的不同，它是值可能为 0、1、2 的整型。

ctypes 可以通过 in_dll() 类方法访问这类变量 。 pythonapi 是用于访问 Python C 接口的预定义符号:

>>> opt_flag = c_int.in_dll(pythonapi, "Py_OptimizeFlag")
>>> print(opt_flag)
c_long(0)
>>>

如果解释器使用 -O 选项启动，这个例子会打印 c_long(1) ， 如果使用 -OO 启动，则会打印 c_long(2) 。

一个扩展例子, 同时也展示了使用指针访问 Python 导出的 PyImport_FrozenModules 指针对象。

对文档中这个值的解释说明

该指针被初始化为指向一个 _frozen 记录的数组，以一个所有成员均为 NULL 或零的记录表示结束。 当一个冻结模块被导入时，它将在此表中被搜索。 第三方代码可以利用此方式来提供动态创建的冻结模块集。

这足以证明修改这个指针是很有用的。为了让实例大小不至于太长，这里只展示如何使用 ctypes 读取这个表:

>>> from ctypes import *
>>>
>>> class struct_frozen(Structure):
...     _fields_ = [("name", c_char_p),
...                 ("code", POINTER(c_ubyte)),
...                 ("size", c_int)]
...
>>>

我们定义了 _frozen 数据类型，所以我们可以获取表的指针:

>>> FrozenTable = POINTER(struct_frozen)
>>> table = FrozenTable.in_dll(pythonapi, "PyImport_FrozenModules")
>>>

由于 table 是指向 struct_frozen 数组的 指针 ，我们可以遍历它，只不过需要自己判断循环是否结束，因为指针本身并不包含长度。它早晚会因为访问到野指针或者什么的把自己搞崩溃，所以我们最好在遇到 NULL 后就让它退出循环:

>>> for item in table:
...     if item.name is None:
...         break
...     print(item.name.decode("ascii"), item.size)
...
_frozen_importlib 31764
_frozen_importlib_external 41499
__hello__ 161
__phello__ -161
__phello__.spam 161
>>>

Python 的冻结模块和冻结包(由负 size 成员表示)并不是广为人知的事情，它们仅仅用于实验。例如，可以使用 import __hello__ 尝试一下这个功能。

意外

ctypes 也有自己的边界，有时候会发生一些意想不到的事情。

比如下面的例子:

>>> 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
>>> # now swap the two points
>>> 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
>>>

嗯。我们预想应该打印 3 4 1 2 。但是为什么呢? 这是 rc.a, rc.b = rc.b, rc.a 这行代码展开后的步骤:

>>> temp0, temp1 = rc.b, rc.a
>>> rc.a = temp0
>>> rc.b = temp1
>>>

注意 temp0 和 temp1 对象始终引用了对象 rc 的内容。然后执行 rc.a = temp0 会把 temp0 的内容拷贝到 rc 的空间。这也改变了 temp1 的内容。最终导致赋值语句 rc.b = temp1 没有产生预想的效果。

记住，访问被包含在结构体、联合、数组中的对象并不会将其 复制 出来，而是得到了一个代理对象，它是对根对象的内部内容的一层包装。

下面是另一个可能和预期有偏差的例子:

>>> s = c_char_p()
>>> s.value = b"abc def ghi"
>>> s.value
b'abc def ghi'
>>> s.value is s.value
False
>>>

注解

使用 c_char_p  实例化的对象只能将其值设置为 bytes 或者整数。

为什么这里打印了 False ？ ctypes 实例是一些内存块加上一些用于访问这些内存块的 descriptor 组成。将 Python 对象存储在内存块并不会存储对象本身，而是存储了对象的 内容 。每次访问对象的内容都会构造一个新的 Python 对象。

变长数据类型

ctypes 对变长数组和结构体提供了一些支持 。

The 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 ValueError is raised if this is tried:

>>> 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
>>>

这非常好，但是要怎么访问数组中额外的元素呢？因为数组类型已经定义包含4个元素，导致我们访问新增元素时会产生以下错误:

>>> short_array[:]
[0, 0, 0, 0]
>>> short_array[7]
Traceback (most recent call last):
    ...
IndexError: invalid index
>>>

使用 ctypes 访问变长数据类型的一个可行方法是利用 Python 的动态特性，根据具体情况，在知道这个数据的大小后，(重新)指定这个数据的类型。

ctypes 参考手册

寻找动态链接库

在编译型语言中，动态链接库会在编译、链接或者程序运行时访问。

The purpose of the find_library() function is to locate a library in a way similar to what the compiler or runtime loader does (on platforms with several versions of a shared library the most recent should be loaded), while the ctypes library loaders act like when a program is run, and call the runtime loader directly.

ctypes.util 模块提供了一个函数，可以帮助确定需要加载的库。

ctypes.util.find_library(name)

尝试寻找一个库然后返回其路径名， name 是库名称, 且去除了 lib 等前缀和 .so 、 .dylib 、版本号等后缀(这是 posix 连接器 -l 选项使用的格式)。如果没有找到对应的库，则返回 None 。

确切的功能取决于系统。

在 Linux 上， find_library() 会尝试运行外部程序(/sbin/ldconfig, gcc, objdump 以及 ld) 来寻找库文件。返回库文件的文件名。

在 3.6 版更改: 在Linux 上，如果其他方式找不到的话，会使用环境变量 LD_LIBRARY_PATH 搜索动态链接库。

这是一些例子:

>>> 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'
>>>

在 macOS 上，find_library() 会尝试几种预定义的命名方案和路径来定位库，如果成功则将返回完整的路径名称:

>>> 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'
>>>

在 Windows 上， find_library() 在系统路径中搜索，然后返回全路径，但是如果没有预定义的命名方案， find_library("c") 调用会返回 None

使用 ctypes 包装动态链接库，更好的方式 可能 是在开发的时候就确定名称，然后硬编码到包装模块中去，而不是在运行时使用 find_library() 寻找库。

加载动态链接库

有很多方式可以将动态链接库加载到 Python 进程。其中之一是实例化以下类的其中一个:

class ctypes.CDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

该类的实例代表已加载的共享库。 这些库中的函数使用标准的 C 调用约定，并被预期会返回 int。

在 Windows 上创建 CDLL 实例可能会失败，即使 DLL 名称确实存在。 当某个被加载 DLL 所依赖的 DLL 未找到时，将引发 OSError 错误并附带消息 "[WinError 126] The specified module could not be found". 此错误消息不包含缺失 DLL 的名称，因为 Windows API 并不会返回此类信息，这使得此错误难以诊断。 要解决此错误并确定是哪一个 DLL 未找到，你需要找出所依赖的 DLL 列表并使用 Windows 调试与跟踪工具确定是哪一个未找到。

参见

Microsoft DUMPBIN 工具 [https://docs.microsoft.com/cpp/build/reference/dependents] -- 一个用于查找 DLL 依赖的工具。

class ctypes.OleDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

仅 Windows : 此类的实例即加载好的动态链接库，其中的函数使用 stdcall 调用约定，并且假定返回 windows 指定的 HRESULT 返回码。 HRESULT 的值包含的信息说明函数调用成功还是失败，以及额外错误码。 如果返回值表示失败，会自动抛出 OSError 异常。

在 3.3 版更改: 以前是引发 WindowsError。

class ctypes.WinDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

仅限 Windows：该类的实例代表已加载的共享库，这些库中的函数使用 stdcall 调用约定，并被预期默认会返回 int。

调用动态库导出的函数之前，Python会释放 global interpreter lock ，并在调用后重新获取。

class ctypes.PyDLL(name, mode=DEFAULT_MODE, handle=None)

这个类实例的行为与 CDLL 类似，只不过 不会 在调用函数的时候释放 GIL 锁，且调用结束后会检查 Python 错误码。 如果错误码被设置，会抛出一个 Python 异常。

所以，它只在直接调用 Python C 接口函数的时候有用。

通过使用至少一个参数（共享库的路径名）调用它们，可以实例化所有这些类。也可以传入一个已加载的动态链接库作为 handler 参数，其他情况会调用系统底层的 dlopen 或 LoadLibrary 函数将库加载到进程，并获取其句柄。

mode 可以指定库加载方式。详情请参见 dlopen(3) 手册页。 在 Windows 上， 会忽略 mode ，在 posix 系统上， 总是会加上 RTLD_NOW ，且无法配置。

对于 use_errno 参数，如果设为真，则 ctypes 会启用一种安全访问系统 errno 的机制。 ctypes 维护有系统 errno 的一个线程局部副本；如果调用传入了 use_errno=True 的外部函数，函数调用前 errno 的值将与 ctypes 的私有副本交换，函数调用后也进行同样的交换。

The function ctypes.get_errno() returns the value of the ctypes private copy, and the function ctypes.set_errno() changes the ctypes private copy to a new value and returns the former value.

use_last_error 参数如果设置为 true，可以在 Windows 上启用相同的策略，它是通过 Windows API 函数 GetLastError()  和 SetLastError() 管理的。 ctypes.get_last_error() 和 ctypes.set_last_error() 可用于获取和设置 ctypes 自己维护的 windows 错误码拷贝。

winmode 参数用于在 Windows 平台上指定库的加载方式( 因为 mode 会被忽略)。他接受任何与 Win32 API 的 LoadLibraryEx 的标志兼容的值作为参数。省略时，默认设置使用最安全的DLL加载的标志，以避免DLL劫持等问题。传入 DLL 的全路径是保证正确加载库及其依赖最安全的方法。

在 3.8 版更改: 增加了 winmode 参数。

ctypes.RTLD_GLOBAL

用于 mode 参数的标识值。在此标识不可用的系统上，它被定义为整数0。

ctypes.RTLD_LOCAL

Flag to use as mode parameter. On platforms where this is not available, it is the same as RTLD_GLOBAL.

ctypes.DEFAULT_MODE

加载动态链接库的默认模式。在 OSX 10.3 上，它是 RTLD_GLOBAL ，其余系统上是 RTLD_LOCAL 。

这些类的实例没有共用方法。动态链接库的导出函数可以通过属性或者索引的方式访问。注意，通过属性的方式访问会缓存这个函数，因而每次访问它时返回的都是同一个对象。另一方面，通过索引访问，每次都会返回一个新的对象:

>>> from ctypes import CDLL
>>> libc = CDLL("libc.so.6")  # On Linux
>>> libc.time == libc.time
True
>>> libc['time'] == libc['time']
False

还有下面这些属性可用，他们的名称以下划线开头，以避免和导出函数重名:

PyDLL._handle

用于访问库的系统句柄。

PyDLL._name

传入构造函数的库名称。

共享库也可以通用使用一个预制对象来加载，这种对象是 LibraryLoader 类的实例，具体做法或是通过调用 LoadLibrary() 方法，或是通过将库作为加载器实例的属性来提取。

class ctypes.LibraryLoader(dlltype)

加载共享库的类。 dlltype 应当为 CDLL, PyDLL, WinDLL 或 OleDLL 类型之一。

__getattr__() 具有特殊的行为：它允许通过将一个共享库作为库加载器实例的属性进行访问来加载它。 加载结果将被缓存，因此重复的属性访问每次都会返回相同的库。

LoadLibrary(name)

加载一个共享库到进程中并将其返回。 此方法总是返回一个新的库实例。

可用的预制库加载器有如下这些:

ctypes.cdll

创建 CDLL 实例。

ctypes.windll

仅限 Windows：创建 WinDLL 实例.

ctypes.oledll

仅限 Windows：创建 OleDLL 实例。

ctypes.pydll

创建 PyDLL 实例。

要直接访问 C Python api，可以使用一个现成的 Python 共享库对象:

ctypes.pythonapi

一个将 Python C API 作为属性公开出来的 PyDLL 实例。 请注意所有这些函数都应返回 C int，当然也不总是如此，所以你必须分配正确的 restype 属性以使用这些函数。

引发一个 审计事件 ctypes.dlopen，附带参数 name。

引发一个审计事件 ctypes.dlsym，附带参数 library, name。

引发一个审计事件 ctypes.dlsym/handle，附带参数 handle, name。

外部函数

正如之前小节的说明，外部函数可作为被加载共享库的属性来访问。 用此方式创建的函数对象默认接受任意数量的参数，接受任意 ctypes 数据实例作为参数，并且返回库加载器所指定的默认结果类型。 它们是一个私有类的实例:

class ctypes._FuncPtr

C 可调用外部函数的基类。

外部函数的实例也是兼容 C 的数据类型；它们代表 C 函数指针。

此行为可通过对外部函数对象的特殊属性赋值来自定义。

restype

分配一个 ctypes 类型来指定外部函数的结果类型。 使用 None 来表示 void，即不返回任何结果的函数。

赋值为一个不为 ctypes 类型的可调用 Python 对象也是可以的，在此情况下函数应返回 C int，并且该可调用对象将附带此整数被调用，以允许进一步的处理或错误检测。 这种用法已被弃用，为了更灵活的后续处理或错误检测请使用一个 ctypes 数据类型作为 restype 并将 errcheck 属性赋值为一个可调用对象。

argtypes

赋值为一个 ctypes 类型的元组来指定函数所接受的参数类型。 使用 stdcall 调用规范的函数只能附带与此元组长度相同数量的参数进行调用；使用 C 调用规范的函数还可接受额外的未指明参数。

当外部函数被调用时，每个实际参数都会被传给 argtypes 元组中条目的 from_param() 类方法，此方法允许将实际参数适配为此外部函数所接受的对象。 例如，argtypes 元组中的 c_char_p 条目将使用 ctypes 约定规则把作为参数传入的字符串转换为字节串对象。

新增：现在可以将不是 ctypes 类型的条目放入 argtypes，但每个条目都必须具有 from_param() 方法用于返回可作为参数的值（整数、字符串、ctypes 实例）。 这样就允许定义可将自定义对象适配为函数形参的适配器。

errcheck

将一个 Python 函数或其他可调用对象赋值给此属性。 该可调用对象将附带三个及以上的参数被调用。

callable(result, func, arguments)

result 是外部函数返回的结果，由 restype 属性指明。

func 是外部函数对象本身，这样就允许重新使用相同的可调用对象来对多个函数进行检查或后续处理。

arguments 是一个包含最初传递给函数调用的形参的元组，这样就允许对所用参数的行为进行特别处理。

此函数所返回的对象将会由外部函数调用返回，但它还可以在外部函数调用失败时检查结果并引发异常。

exception ctypes.ArgumentError

此异常会在外部函数无法对某个传入参数执行转换时被引发。

引发一个审计事件 ctypes.seh_exception 并附带参数 code。

引发一个审计事件 ctypes.call_function，附带参数 func_pointer, arguments。

函数原型

外部函数也可通过实例化函数原型来创建。 函数原型类似于 C 中的函数原型；它们在不定义具体实现的情况下描述了一个函数（返回类型、参数类型、调用约定）。 工厂函数必须使用函数所需要的结果类型和参数类型来调用，并可被用作装饰器工厂函数，在此情况下可以通过 @wrapper 语法应用于函数。 请参阅 回调函数 了解有关示例。

ctypes.CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)

返回的函数原型会创建使用标准 C 调用约定的函数。 该函数在调用过程中将释放 GIL。 如果 use_errno 设为真值，则在调用之前和之后系统 errno 变量的 ctypes 私有副本会与真正的 errno 值进行交换；use_last_error 会为 Windows 错误码执行同样的操作。

ctypes.WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)

仅限 Windows：返回的函数原型会创建使用 stdcall 调用约定的函数。 该函数在调用过程中将会释放 GIL。 use_errno 和 use_last_error 具有与上文中相同的含义。

ctypes.PYFUNCTYPE(restype, *argtypes)

返回的函数原型会创建使用 Python 调用约定的函数。 该函数在调用过程中将 不会 释放 GIL。

这些工厂函数所创建的函数原型可通过不同的方式来实例化，具体取决于调用中的类型与数量:

prototype(address)

在指定地址上返回一个外部函数，地址值必须为整数。

prototype(callable)

基于 Python callable 创建一个 C 可调用函数（回调函数）。

prototype(func_spec[, paramflags])

返回由一个共享库导出的外部函数。 func_spec 必须为一个 2 元组 (name_or_ordinal, library)。 第一项是字符串形式的所导出函数名称，或小整数形式的所导出函数序号。 第二项是该共享库实例。

prototype(vtbl_index, name[, paramflags[, iid]])

返回将调用一个 COM 方法的外部函数。 vtbl_index 虚拟函数表中的索引。 name 是 COM 方法的名称。 iid 是可选的指向接口标识符的指针，它被用于扩展的错误报告。

COM 方法使用特殊的调用约定：除了在 argtypes 元组中指定的形参，它们还要求一个指向 COM 接口的指针作为第一个参数。

可选的 paramflags 形参会创建相比上述特性具有更多功能的外部函数包装器。

paramflags 必须为一个与 argtypes 长度相同的元组。

此元组中的每一项都包含有关形参的更多信息，它必须为包含一个、两个或更多条目的元组。

第一项是包含形参指令旗标组合的整数。

1

指定函数的一个输入形参。

2

输出形参。 外部函数会填入一个值。

4

默认为整数零值的输入形参。

可选的第二项是字符串形式的形参名称。 如果指定此项，则可以使用该形参名称来调用外部函数。

可选的第三项是该形参的默认值。

这个例子演示了如何包装 Windows 的 MessageBoxW 函数以使其支持默认形参和已命名参数。 相应 windows 头文件的 C 声明是这样的:

WINUSERAPI int WINAPI
MessageBoxW(
    HWND hWnd,
    LPCWSTR lpText,
    LPCWSTR lpCaption,
    UINT uType);

这是使用 ctypes 的包装:

>>> 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)

现在 MessageBox 外部函数可以通过以下方式来调用:

>>> MessageBox()
>>> MessageBox(text="Spam, spam, spam")
>>> MessageBox(flags=2, text="foo bar")

第二个例子演示了输出形参。 这个 win32 GetWindowRect 函数通过将指定窗口的维度拷贝至调用者必须提供的 RECT 结构体来提取这些值。 这是相应的 C 声明:

WINUSERAPI BOOL WINAPI
GetWindowRect(
     HWND hWnd,
     LPRECT lpRect);

这是使用 ctypes 的包装:

>>> 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)
>>>

带有输出形参的函数如果输出形参存在单一值则会自动返回该值，或是当输出形参存在多个值时返回包含这些值的元组，因此当 GetWindowRect 被调用时现在将返回一个 RECT 实例。

输出形参可以与 errcheck 协议相结合以执行进一步的输出处理与错误检查。 Win32 GetWindowRect API 函数返回一个 BOOL 来表示成功或失败，因此此函数可执行错误检查，并在 API 调用失败时引发异常:

>>> def errcheck(result, func, args):
...     if not result:
...         raise WinError()
...     return args
...
>>> GetWindowRect.errcheck = errcheck
>>>

如果 errcheck 不加更改地返回它所接收的参数元组，则 ctypes 会继续对输出形参执行常规处理。 如果你希望返回一个窗口坐标的元组而非 RECT 实例，你可以从函数中提取这些字段并返回它们，常规处理将不会再执行:

>>> 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
>>>

工具函数

ctypes.addressof(obj)

以整数形式返回内存缓冲区地址。 obj 必须为一个 ctypes 类型的实例。

引发一个 审计事件 ctypes.addressof 并附带参数 obj。

ctypes.alignment(obj_or_type)

返回一个 ctypes 类型的对齐要求。 obj_or_type 必须为一个 ctypes 类型或实例。

ctypes.byref(obj[, offset])

返回指向 obj 的轻量指针，该对象必须为一个 ctypes 类型的实例。 offset 默认值为零，且必须为一个将被添加到内部指针值的整数。

byref(obj, offset) 对应于这段 C 代码:

(((char *)&obj) + offset)

返回的对象只能被用作外部函数调用形参。 它的行为类似于 pointer(obj)，但构造起来要快很多。

ctypes.cast(obj, type)

此函数类似于 C 的强制转换运算符。 它返回一个 type 的新实例，该实例指向与 obj 相同的内存块。 type 必须为指针类型，而 obj 必须为可以被作为指针来解读的对象。

ctypes.create_string_buffer(init_or_size, size=None)

此函数会创建一个可变的字符缓冲区。 返回的对象是一个 c_char 的 ctypes 数组。

init_or_size 必须是一个指明数组大小的整数，或者是一个将被用来初始化数组条目的字节串对象。

如果将一个字节串对象指定为第一个参数，则将使缓冲区大小比其长度多一项以便数组的最后一项为一个 NUL 终结符。 可以传入一个整数作为第二个参数以允许在不使用字节串长度的情况下指定数组大小。

引发一个 审计事件 ctypes.create_string_buffer 并附带参数 init, size。

ctypes.create_unicode_buffer(init_or_size, size=None)

此函数会创建一个可变的 unicode 字符缓冲区。 返回的对象是一个 c_wchar 的 ctypes 数组。

init_or_size 必须是一个指明数组大小的整数，或者是一个将被用来初始化数组条目的字符串。

如果将一个字符串指定为第一个参数，则将使缓冲区大小比其长度多一项以便数组的最后一项为一个 NUL 终结符。 可以传入一个整数作为第二个参数以允许在不使用字符串长度的情况下指定数组大小。

引发一个 审计事件 ctypes.create_unicode_buffer 并附带参数 init, size。

ctypes.DllCanUnloadNow()

仅限 Windows：此函数是一个允许使用 ctypes 实现进程内 COM 服务的钩子。 它将由 _ctypes 扩展 dll 所导出的 DllCanUnloadNow 函数来调用。

ctypes.DllGetClassObject()

仅限 Windows：此函数是一个允许使用 ctypes 实现进程内 COM 服务的钩子。 它将由 _ctypes 扩展 dll 所导出的 DllGetClassObject 函数来调用。

ctypes.util.find_library(name)

尝试寻找一个库并返回路径名称。 name 是库名称并且不带任何前缀如 lib 以及后缀如 .so，.dylib 或版本号（形式与 posix 链接器选项 -l 所用的一致）。 如果找不到库，则返回 None。

确切的功能取决于系统。

ctypes.util.find_msvcrt()

仅限 Windows：返回 Python 以及扩展模块所使用的 VC 运行时库的文件名。 如果无法确定库名称，则返回 None。

如果你需要通过调用 free(void *) 来释放内存，例如某个扩展模块所分配的内存，重要的一点是你应当使用分配内存的库中的函数。

ctypes.FormatError([code])

仅限 Windows：返回错误码 code 的文本描述。 如果未指定错误码，则会通过调用 Windows api 函数 GetLastError 来获得最新的错误码。

ctypes.GetLastError()

仅限 Windows：返回 Windows 在调用线程中设置的最新错误码。 此函数会直接调用 Windows GetLastError() 函数，它并不返回错误码的 ctypes 私有副本。

ctypes.get_errno()

返回调用线程中系统 errno 变量的 ctypes 私有副本的当前值。

引发一个不带参数的 审计事件 ctypes.get_errno。

ctypes.get_last_error()

仅限 Windows：返回调用线程中系统 LastError 变量的 ctypes 私有副本的当前值。

引发一个不带参数的 审计事件 ctypes.get_last_error。

ctypes.memmove(dst, src, count)

与标准 C memmove 库函数相同：将 count 个字节从 src 拷贝到 dst。 dst 和 src 必须为整数或可被转换为指针的 ctypes 实例。

ctypes.memset(dst, c, count)

与标准 C memset 库函数相同：将位于地址 dst 的内存块用 count 个字节的 c 值填充。 dst 必须为指定地址的整数或 ctypes 实例。

ctypes.POINTER(type)

这个工厂函数创建并返回一个新的 ctypes 指针类型。 指针类型会被缓存并在内部重用，因此重复调用此函数耗费不大。 type 必须为 ctypes 类型。

ctypes.pointer(obj)

此函数会创建一个新的指向 obj 的指针实例。 返回的对象类型为 POINTER(type(obj))。

注意：如果你只是想向外部函数调用传递一个对象指针，你应当使用更为快速的 byref(obj)。

ctypes.resize(obj, size)

此函数可改变 obj 的内部内存缓冲区大小，其参数必须为 ctypes 类型的实例。 没有可能将缓冲区设为小于对象类型的本机大小值，该值由 sizeof(type(obj)) 给出，但将缓冲区加大则是可能的。

ctypes.set_errno(value)

设置调用线程中系统 errno 变量的 ctypes 私有副本的当前值为 value 并返回原来的值。

引发一个 审计事件 ctypes.set_errno 并附带参数 errno。

ctypes.set_last_error(value)

仅限 Windows：设置调用线程中系统 LastError 变量的 ctypes 私有副本的当前值为 value 并返回原来的值。

引发一个 审计事件 ctypes.set_last_error 并附带参数 error。

ctypes.sizeof(obj_or_type)

返回 ctypes 类型或实例的内存缓冲区以字节表示的大小。 其功能与 C sizeof 运算符相同。

ctypes.string_at(address, size=- 1)

此函数返回从内存地址 address 开始的以字节串表示的 C 字符串。 如果指定了 size，则将其用作长度，否则将假定字符串以零值结尾。

引发一个 审计事件 ctypes.string_at，附带参数 address, size。

ctypes.WinError(code=None, descr=None)

仅限 Windows：此函数可能是 ctypes 中名字起得最差的函数。 它会创建一个 OSError 的实例。 如果未指定 code，则会调用 GetLastError 来确定错误码。 如果未指定 descr，则会调用 FormatError() 来获取错误的文本描述。

在 3.3 版更改: 以前是会创建一个 WindowsError 的实例。

ctypes.wstring_at(address, size=- 1)

此函数返回从内存地址 address 开始的以字符串表示的宽字节字符串。 如果指定了 size，则将其用作字符串中的字符数量，否则将假定字符串以零值结尾。

引发一个 审计事件 ctypes.wstring_at，附带参数 address, size。

数据类型

class ctypes._CData

这个非公有类是所有 ctypes 数据类型的共同基类。 另外，所有 ctypes 类型的实例都包含一个存放 C 兼容数据的内存块；该内存块的地址可由 addressof() 辅助函数返回。 还有一个实例变量被公开为 _objects；此变量包含其他在内存块包含指针的情况下需要保持存活的 Python 对象。

ctypes 数据类型的通用方法，它们都是类方法（严谨地说，它们是 metaclass 的方法）:

from_buffer(source[, offset])

此方法返回一个共享 source 对象缓冲区的 ctypes 实例。 source 对象必须支持可写缓冲区接口。 可选的 offset 形参指定以字节表示的源缓冲区内偏移量；默认值为零。 如果源缓冲区不够大则会引发 ValueError。

引发一个 审计事件 ctypes.cdata/buffer 并附带参数 pointer, size, offset。

from_buffer_copy(source[, offset])

此方法创建一个 ctypes 实例，从 source 对象缓冲区拷贝缓冲区，该对象必须是可读的。 可选的 offset 形参指定以字节表示的源缓冲区内偏移量；默认值为零。 如果源缓冲区不够大则会引发 ValueError。

引发一个 审计事件 ctypes.cdata/buffer 并附带参数 pointer, size, offset。

from_address(address)

此方法会使用 address 所指定的内存返回一个 ctypes 类型的实例，该参数必须为一个整数。

引发一个 审计事件 ctypes.cdata，附带参数 address。

from_param(obj)

此方法会将 obj 适配为一个 ctypes 类型。 它调用时会在当该类型存在于外部函数的 argtypes 元组时传入外部函数调用所使用的实际对象；它必须返回一个可被用作函数调用参数的对象。

所有 ctypes 数据类型都带有这个类方法的默认实现，它通常会返回 obj，如果该对象是此类型的实例的话。 某些类型也能接受其他对象。

in_dll(library, name)

此方法返回一个由共享库导出的 ctypes 类型。 name 为导出数据的符号名称，library 为所加载的共享库。

ctypes 数据类型的通用实例变量:

_b_base_

有时 ctypes 数据实例并不拥有它们所包含的内存块，它们只是共享了某个基对象的部分内存块。 _b_base_ 只读成员是拥有内存块的根 ctypes 对象。

_b_needsfree_

这个只读变量在 ctypes 数据实例自身已分配了内存块时为真值，否则为假值。

_objects

这个成员或者为 None，或者为一个包含需要保持存活以使内存块的内存保持有效的 Python 对象的字典。 这个对象只是出于调试目的而对外公开；绝对不要修改此字典的内容。

基础数据类型

class ctypes._SimpleCData

这个非公有类是所有基本 ctypes 数据类型的基类。 它在这里被提及是因为它包含基本 ctypes 数据类型共有的属性。 _SimpleCData 是 _CData 的子类，因此继承了其方法和属性。 非指针及不包含指针的 ctypes 数据类型现在将可以被封存。

实例拥有一个属性:

value

这个属性包含实例的实际值。 对于整数和指针类型，它是一个整数，对于字符类型，它是一个单字符字符串对象或字符串，对于字符指针类型，它是一个 Python 字节串对象或字符串。

当从 ctypes 实例提取 value 属性时，通常每次会返回一个新的对象。 ctypes 并 没有 实现原始对象返回，它总是会构造一个新的对象。 所有其他 ctypes 对象实例也同样如此。

基本数据类型当作为外部函数调用结果被返回或者作为结构字段成员或数组项被提取时，会透明地转换为原生 Python 类型。 换句话说，如果某个外部函数具有 c_char_p 的 restype，你将总是得到一个 Python 字节串对象，而 不是 一个 c_char_p 实例。

基本数据类型的子类并 没有 继续此行为。 因此，如果一个外部函数的 restype 是 c_void_p 的一个子类，你将从函数调用得到一个该子类的实例。 当然，你可以通过访问 value 属性来获取指针的值。

这些是基本 ctypes 数据类型:

class ctypes.c_byte

代表 C signed char 数据类型，并将值解读为一个小整数。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_char

代表 C char 数据类型，并将值解读为单个字符。 该构造器接受一个可选的字符串初始值，字符串的长度必须恰好为一个字符。

class ctypes.c_char_p

当指向一个以零为结束符的字符串时代表 C char* 数据类型。 对于通用字符指针来说也可能指向二进制数据，必须要使用 POINTER(c_char)。 该构造器接受一个整数地址，或者一个字节串对象。

class ctypes.c_double

代表 C double 数据类型。 该构造器接受一个可选的浮点数初始值。

class ctypes.c_longdouble

代表 C long double 数据类型。 该构造器接受一个可选的浮点数初始值。 在 sizeof(long double) == sizeof(double) 的平台上它是 c_double 的一个别名。

class ctypes.c_float

代表 C float 数据类型。 该构造器接受一个可选的浮点数初始值。datatype. The constructor accepts an optional float initializer.

class ctypes.c_int

代表 C signed int 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。 在 sizeof(int) == sizeof(long) 的平台上它是 c_long 的一个别名。

class ctypes.c_int8

代表 C 8 位 signed int 数据类型。 通常是 c_byte 的一个别名。

class ctypes.c_int16

代表 C 16 位 signed int 数据类型。 通常是 c_short 的一个别名。

class ctypes.c_int32

代表 C 32 位 signed int 数据类型。 通常是 c_int 的一个别名。

class ctypes.c_int64

代表 C 64 位 signed int 数据类型。 通常是 c_longlong 的一个别名。

class ctypes.c_long

代表 C signed long 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_longlong

代表 C signed long long 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_short

代表 C signed short 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_size_t

代表 C size_t 数据类型。

class ctypes.c_ssize_t

代表 C ssize_t 数据类型。

3.2 新版功能.

class ctypes.c_ubyte

代表 C unsigned char 数据类型，它将值解读为一个小整数。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_uint

代表 C unsigned int 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。 在 sizeof(int) == sizeof(long) 的平台上它是 c_ulong 的一个别名。

class ctypes.c_uint8

代表 C 8 位 unsigned int 类型。 通常是 c_ubyte 的一个别名。.

class ctypes.c_uint16

代表 C 16 位 unsigned int 数据类型。 通常是 c_ushort 的一个别名。.

class ctypes.c_uint32

代表 C 32 位 unsigned int 数据类型。 通常是 c_uint 的一个别名。

class ctypes.c_uint64

代表 C 64 位 unsigned int 数据类型。 通常是 c_ulonglong 的一个别名。

class ctypes.c_ulong

代表 C unsigned long 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_ulonglong

代表 C unsigned long long 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_ushort

代表 C unsigned short 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。

class ctypes.c_void_p

代表 C void* 类型。 该值被表示为整数形式。 该构造器接受一个可选的整数初始值。

class ctypes.c_wchar

Represents the C wchar_t datatype, and interprets the value as a single character unicode string. The constructor accepts an optional string initializer, the length of the string must be exactly one character.

class ctypes.c_wchar_p

代表 C wchar_t* 数据类型，它必须为指向以零为续签符的宽字符串的指针。 该构造器接受一个整数地址，或一个字符串。

class ctypes.c_bool

代表 C bool 数据类型 (更准确地说，是 C99 _Bool)。 它的值可以为 True 或 False，并且该构造器接受任何具有逻辑值的对象。

class ctypes.HRESULT

Windows 专属：代表一个 HRESULT 值，它包含某个函数或方法调用的成功或错误信息。

class ctypes.py_object

代表 C PyObject* 数据类型。 不带参数地调用此构造器将创建一个 NULL PyObject* 指针。

ctypes.wintypes 模块提供了其他许多 Windows 专属的数据类型，例如 HWND, WPARAM 或 DWORD。 还定义了一些有用的结构体例如 MSG 或 RECT。

结构化数据类型

class ctypes.Union(*args, **kw)

本机字节序的联合所对应的抽象基类。

class ctypes.BigEndianStructure(*args, **kw)

大端 字节序的结构体所对应的抽象基类。

class ctypes.LittleEndianStructure(*args, **kw)

小端 字节序的结构体所对应的抽象基类。

非本机字节序的结构体不能包含指针类型字段，或任何其他包含指针类型字段的数据类型。

class ctypes.Structure(*args, **kw)

本机 字节序的结构体所对应的抽象基类。

实际的结构体和联合类型必须通过子类化这些类型之一来创建，并且至少要定义一个 _fields_ 类变量。 ctypes 将创建 descriptor，它允许通过直接属性访问来读取和写入字段。 这些是

_fields_

一个定义结构体字段的序列。 其中的条目必须为 2 元组或 3 元组。 元组的第一项是字段名称，第二项指明字段类型；它可以是任何 ctypes 数据类型。

对于整数类型字段例如 c_int，可以给定第三个可选项。 它必须是一个定义字段比特位宽度的小正整数。

字段名称在一个结构体或联合中必须唯一。 不会检查这个唯一性，但当名称出现重复时将只有一个字段可被访问。

可以在定义 Structure 子类的类语句 之后 再定义 _fields_ 类变量，这将允许创建直接或间接引用其自身的数据类型:

class List(Structure):
    pass
List._fields_ = [("pnext", POINTER(List)),
                 ...
                ]

但是，_fields_ 类变量必须在类型第一次被使用（创建实例，调用 sizeof() 等等）之前进行定义。 在此之后对 _fields_ 类变量赋值将会引发 AttributeError。

可以定义结构体类型的子类，它们会继承基类的字段再加上在子类中定义的任何 _fields_。

_pack_

一个可选的小整数，它允许覆盖实体中结构体字段的对齐方式。 当 _fields_ 被赋值时必须已经定义了 _pack_，否则它将没有效果。

_anonymous_

一个可选的序列，它会列出未命名（匿名）字段的名称。 当 _fields_ 被赋值时必须已经定义了 _anonymous_，否则它将没有效果。

在此变量中列出的字段必须为结构体或联合类型字段。 ctypes 将在结构体类型中创建描述器以允许直接访问嵌套字段，而无需创建对应的结构体或联合字段。

以下是一个示例类型（Windows）:

class _U(Union):
    _fields_ = [("lptdesc", POINTER(TYPEDESC)),
                ("lpadesc", POINTER(ARRAYDESC)),
                ("hreftype", HREFTYPE)]

class TYPEDESC(Structure):
    _anonymous_ = ("u",)
    _fields_ = [("u", _U),
                ("vt", VARTYPE)]

TYPEDESC 结构体描述了一个 COM 数据类型，vt 字段指明哪个联合字段是有效的。 由于 u 字段被定义为匿名字段，现在可以直接从 TYPEDESC 实例访问成员。 td.lptdesc 和 td.u.lptdesc 是等价的，但前者速度更快，因为它不需要创建临时的联合实例:

td = TYPEDESC()
td.vt = VT_PTR
td.lptdesc = POINTER(some_type)
td.u.lptdesc = POINTER(some_type)

可以定义结构体的子类，它们会继承基类的字段。 如果子类定义具有单独的 _fields_ 变量，在其中指定的字段会被添加到基类的字段中。

结构体和联合的构造器均可接受位置和关键字参数。 位置参数用于按照 _fields_ 中的出现顺序来初始化成员字段。 构造器中的关键字参数会被解读为属性赋值，因此它们将以相应的名称来初始化 _fields_，或为不存在于 _fields_ 中的名称创建新的属性。

数组与指针

class ctypes.Array(*args)

数组的抽象基类。

创建实体数组类型的推荐方式是通过将任意 ctypes 数据类型与一个非负整数相乘。 作为替代方式，你也可以子类化这个类型并定义 _length_ 和 _type_ 类变量。 数组元素可使用标准的抽取和切片操作来进行读写；对于切片读取，结果对象本身 不是 一个 Array。

_length_

一个指明数组中元素数量的正整数。 超出范围的抽取会导致 IndexError。 该值将由 len() 返回。

_type_

指明数组中每个元素的类型。

Array 子类构造器可接受位置参数，用来按顺序初始化元素。

class ctypes._Pointer

私有对象，指针的抽象基类。

实际的指针类型是通过调用 POINTER() 并附带其将指向的类型来创建的；这会由 pointer() 自动完成。

如果一个指针指向的是数组，则其元素可使用标准的抽取和切片方式来读写。 指针对象没有长度，因此 len() 将引发 TypeError。 抽取负值将会从指针 之前 的内存中读取（与 C 一样），并且超出范围的抽取将可能因非法访问而导致崩溃（视你的运气而定）。

_type_

指明所指向的类型。

contents

返回指针所指向的对象。 对此属性赋值会使指针改为指向所赋值的对象。

并发执行

本章中描述的模块支持并发执行代码。 适当的工具选择取决于要执行的任务（CPU密集型或IO密集型）和偏好的开发风格（事件驱动的协作式多任务或抢占式多任务处理）。 这是一个概述：

threading --- 基于线程的并行

线程本地数据

线程对象

锁对象

递归锁对象

条件对象

信号量对象

Semaphore 例子

事件对象

定时器对象

栅栏对象

在 with 语句中使用锁、条件和信号量

multiprocessing --- 基于进程的并行

概述

Process 类

上下文和启动方法

在进程之间交换对象

进程间同步

进程间共享状态

使用工作进程

参考

Process 和异常

管道和队列

杂项

连接对象（Connection）

同步原语

共享 ctypes 对象

multiprocessing.sharedctypes 模块

管理器

自定义管理器

使用远程管理器

代理对象

清理

进程池

监听器及客户端

地址格式

认证密码

日志记录

multiprocessing.dummy 模块

编程指导

所有start方法

spawn 和 forkserver 启动方式

例子

multiprocessing.shared_memory --- 可跨进程直接访问的共享内存

concurrent 包

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

Executor 对象

ThreadPoolExecutor

ThreadPoolExecutor 例子

ProcessPoolExecutor

ProcessPoolExecutor 例子

Future 对象

模块函数

Exception 类

subprocess --- 子进程管理

使用 subprocess 模块

常用参数

Popen 构造函数

异常

安全考量

Popen 对象

Windows Popen 助手

Windows 常数

较旧的高阶 API

使用 subprocess 模块替换旧函数

替代 /bin/sh shell 命令替换

替代 shell 管道

替代 os.system()

替代 os.spawn 函数族

替代 os.popen(), os.popen2(), os.popen3()

来自 popen2 模块的替代函数

旧式的 Shell 发起函数

备注

在 Windows 上将参数列表转换为一个字符串

sched --- 事件调度器

调度器对象

queue --- 一个同步的队列类

Queue对象

SimpleQueue 对象

contextvars --- 上下文变量

上下文变量

手动上下文管理

asyncio 支持

以下是上述某些服务的支持模块：

_thread --- 底层多线程 API

threading --- 基于线程的并行

源代码: Lib/threading.py [https://github.com/python/cpython/tree/3.10/Lib/threading.py]

这个模块在低层级的 _thread 模块之上构造了高层级的线程接口。

在 3.7 版更改: 这个模块曾经为可选项，但现在总是可用。

参见

concurrent.futures.ThreadPoolExecutor 提供了一个高层级接口用来向后台线程推送任务而不会阻塞调用方线程的执行，同时仍然能够在需要时获取任务的结果。

queue 提供了一个线程安全的接口用来在运行中的线程之间交换数据。

asyncio 提供了一个替代方式用来实现任务层级的并发而不要求使用多个操作系统线程。

注解

在 Python 2.x 系列中，此模块包含有某些方法和函数 camelCase 形式的名称。 它们在 Python 3.10 中已弃用，但为了与 Python 2.5 及更旧版本的兼容性而仍受到支持。

CPython 实现细节： 在 CPython 中，由于存在 全局解释器锁，同一时刻只有一个线程可以执行 Python 代码（虽然某些性能导向的库可能会去除此限制）。 如果你想让你的应用更好地利用多核心计算机的计算资源，推荐你使用 multiprocessing 或 concurrent.futures.ProcessPoolExecutor。 但是，如果你想要同时运行多个 I/O 密集型任务，则多线程仍然是一个合适的模型。

这个模块定义了以下函数：

threading.active_count()

返回当前存活的 Thread 对象的数量。 返回值与 enumerate() 所返回的列表长度一致。

函数 activeCount 是此函数的已弃用别名。

threading.current_thread()

返回当前对应调用者的控制线程的 Thread 对象。如果调用者的控制线程不是利用 threading 创建，会返回一个功能受限的虚拟线程对象。

函数 currentThread 是此函数的已弃用别名。

threading.excepthook(args, /)

处理由 Thread.run() 引发的未捕获异常。

args 参数具有以下属性:

exc_type: 异常类型

exc_value: 异常值，可以是 None.

exc_traceback: 异常回溯，可以是 None.

thread: 引发异常的线程，可以为 None。

如果 exc_type 为 SystemExit，则异常会被静默地忽略。 在其他情况下，异常将被打印到 sys.stderr。

如果此函数引发了异常，则会调用 sys.excepthook() 来处理它。

threading.excepthook() 可以被重载以控制由 Thread.run() 引发的未捕获异常的处理方式。

使用定制钩子存放 exc_value 可能会创建引用循环。 它应当在不再需要异常时被显式地清空以打破引用循环。

如果一个对象正在被销毁，那么使用自定义的钩子储存 thread 可能会将其复活。请在自定义钩子生效后避免储存 thread，以避免对象的复活。

参见

sys.excepthook() 处理未捕获的异常。

3.8 新版功能.

threading.__excepthook__

保存 threading.excepthook() 的原始值。 它被保存以便在原始值碰巧被已损坏或替代对象所替换的情况下可被恢复。

3.10 新版功能.

threading.get_ident()

返回当前线程的 “线程标识符”。它是一个非零的整数。它的值没有直接含义，主要是用作 magic cookie，比如作为含有线程相关数据的字典的索引。线程标识符可能会在线程退出，新线程创建时被复用。

3.3 新版功能.

threading.get_native_id()

返回内核分配给当前线程的原生集成线程 ID。 这是一个非负整数。 它的值可被用来在整个系统中唯一地标识这个特定线程（直到线程终结，在那之后该值可能会被 OS 回收再利用）。

可用性: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX。

3.8 新版功能.

threading.enumerate()

返回当前所有存活的 Thread 对象的列表。 该列表包括守护线程以及 current_thread() 创建的空线程。 它不包括已终结的和尚未开始的线程。 但是，主线程将总是结果的一部分，即使是在已终结的时候。

threading.main_thread()

返回主 Thread 对象。一般情况下，主线程是Python解释器开始时创建的线程。

3.4 新版功能.

threading.settrace(func)

为所有 threading 模块开始的线程设置追踪函数。在每个线程的 run() 方法被调用前，func 会被传递给 sys.settrace() 。

threading.gettrace()

返回由 settrace() 设置的跟踪函数。

3.10 新版功能.

threading.setprofile(func)

为所有 threading 模块开始的线程设置性能测试函数。在每个线程的 run() 方法被调用前，func 会被传递给 sys.setprofile() 。

threading.getprofile()

返回由 setprofile() 设置的性能分析函数。

3.10 新版功能.

threading.stack_size([size])

返回创建线程时使用的堆栈大小。可选参数 size 指定之后新建的线程的堆栈大小，而且一定要是0（根据平台或者默认配置）或者最小是32,768(32KiB)的一个正整数。如果 size 没有指定，默认是0。如果不支持改变线程堆栈大小，会抛出 RuntimeError 错误。如果指定的堆栈大小不合法，会抛出 ValueError 错误并且不会修改堆栈大小。32KiB是当前最小的能保证解释器有足够堆栈空间的堆栈大小。需要注意的是部分平台对于堆栈大小会有特定的限制，例如要求大于32KiB的堆栈大小或者需要根据系统内存页面的整数倍进行分配 - 应当查阅平台文档有关详细信息（4KiB页面比较普遍，在没有更具体信息的情况下，建议的方法是使用4096的倍数作为堆栈大小）。

适用于: Windows，具有 POSIX 线程的系统。

这个模块同时定义了以下常量：

threading.TIMEOUT_MAX

阻塞函数（ Lock.acquire(), RLock.acquire(), Condition.wait(), ...）中形参 timeout 允许的最大值。传入超过这个值的 timeout 会抛出 OverflowError 异常。

3.2 新版功能.

这个模块定义了许多类，详见以下部分。

该模块的设计基于 Java的线程模型。 但是，在Java里面，锁和条件变量是每个对象的基础特性，而在Python里面，这些被独立成了单独的对象。 Python 的 Thread 类只是 Java 的 Thread 类的一个子集；目前还没有优先级，没有线程组，线程还不能被销毁、停止、暂停、恢复或中断。 Java 的 Thread 类的静态方法在实现时会映射为模块级函数。

下述方法的执行都是原子性的。

线程本地数据

线程本地数据是特定线程的数据。管理线程本地数据，只需要创建一个 local （或者一个子类型）的实例并在实例中储存属性：

mydata = threading.local()
mydata.x = 1

在不同的线程中，实例的值会不同。

class threading.local

一个代表线程本地数据的类。

更多相关细节和大量示例，参见 _threading_local 模块的文档。

线程对象

Thread 类代表在独立控制线程运行的活动。有两种方式指定活动：传递一个可调用对象给构造函数或者在子类重载 run() 方法。其它方法不应该在子类被（除了构造函数）重载。换句话说，只能 重载这个类的 __init__() 和 run() 方法。

当线程对象一旦被创建，其活动必须通过调用线程的 start() 方法开始。 这会在独立的控制线程中唤起 run() 方法。

一旦线程活动开始，该线程会被认为是 '存活的' 。当它的 run() 方法终结了（不管是正常的还是抛出未被处理的异常），就不是'存活的'。 is_alive() 方法用于检查线程是否存活。

其他线程可以调用一个线程的 join() 方法。这会阻塞调用该方法的线程，直到被调用 join() 方法的线程终结。

线程有名字。名字可以传递给构造函数，也可以通过 name 属性读取或者修改。

如果 run() 方法引发了异常，则会调用 threading.excepthook() 来处理它。 在默认情况下，threading.excepthook() 会静默地忽略 SystemExit。

一个线程可以被标记成一个“守护线程”。 这个标识的意义是，当剩下的线程都是守护线程时，整个 Python 程序将会退出。 初始值继承于创建线程。 这个标识可以通过 daemon 特征属性或者 daemon 构造器参数来设置。

注解

守护线程在程序关闭时会突然关闭。他们的资源（例如已经打开的文档，数据库事务等等）可能没有被正确释放。如果你想你的线程正常停止，设置他们成为非守护模式并且使用合适的信号机制，例如： Event。

有个 "主线程" 对象；这对应Python程序里面初始的控制线程。它不是一个守护线程。

"虚拟线程对象" 是可以被创建的。这些是对应于“外部线程”的线程对象，它们是在线程模块外部启动的控制线程，例如直接来自C代码。虚拟线程对象功能受限；他们总是被认为是存活的和守护模式，不能被 join() 。因为无法检测外来线程的终结，它们永远不会被删除。

class threading.Thread(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)

应当始终使用关键字参数调用此构造函数。 参数如下：

group 应该为 None；为了日后扩展 ThreadGroup 类实现而保留。

target 是用于 run() 方法调用的可调用对象。默认是 None，表示不需要调用任何方法。

name 是线程名称。 在默认情况下，会以 "Thread-N" 的形式构造唯一名称，其中 N 为一个较小的十进制数值，或是 "Thread-N (target)" 的形式，其中 "target" 为 target.__name__，如果指定了 target 参数的话。

args 是用于调用目标函数的参数元组。默认是 ()。

kwargs 是用于调用目标函数的关键字参数字典。默认是 {}。

如果不是 None，daemon 参数将显式地设置该线程是否为守护模式。 如果是 None (默认值)，线程将继承当前线程的守护模式属性。

如果子类型重载了构造函数，它一定要确保在做任何事前，先唤起基类构造器(Thread.__init__())。

在 3.10 版更改: 使用 target 名称，如果 name 参数被省略的话。

在 3.3 版更改: 加入 daemon 参数。

start()

开始线程活动。

它在一个线程里最多只能被调用一次。 它安排对象的 run() 方法在一个独立的控制线程中被调用。

如果同一个线程对象中调用这个方法的次数大于一次，会抛出 RuntimeError 。

run()

代表线程活动的方法。

你可以在子类型里重载这个方法。 标准的 run() 方法会对作为 target 参数传递给该对象构造器的可调用对象（如果存在）被唤起，并附带从 args 和 kwargs 参数分别获取的位置和关键字参数。

join(timeout=None)

等待，直到线程终结。这会阻塞调用这个方法的线程，直到被调用 join() 的线程终结 -- 不管是正常终结还是抛出未处理异常 -- 或者直到发生超时，超时选项是可选的。

当 timeout 参数存在而且不是 None 时，它应该是一个用于指定操作超时的以秒为单位的浮点数或者分数。因为 join() 总是返回 None ，所以你一定要在 join() 后调用 is_alive() 才能判断是否发生超时 -- 如果线程仍然存活，则 join() 超时。

当 timeout 参数不存在或者是 None ，这个操作会阻塞直到线程终结。

一个线程可以被 join() 很多次。

如果尝试加入当前线程会导致死锁， join() 会引起 RuntimeError 异常。如果尝试 join() 一个尚未开始的线程，也会抛出相同的异常。

name

只用于识别的字符串。它没有语义。多个线程可以赋予相同的名称。 初始名称由构造函数设置。

getName()

setName()

已被弃用的 name 的取值/设值 API；请改为直接以特征属性方式使用它。

3.10 版后已移除.

ident

这个线程的 '线程标识符'，如果线程尚未开始则为 None 。这是个非零整数。参见 get_ident() 函数。当一个线程退出而另外一个线程被创建，线程标识符会被复用。即使线程退出后，仍可得到标识符。

native_id

此线程的线程 ID (TID)，由 OS (内核) 分配。 这是一个非负整数，或者如果线程还未启动则为 None。 请参阅 get_native_id() 函数。 这个值可被用来在全系统范围内唯一地标识这个特定线程 (直到线程终结，在那之后该值可能会被 OS 回收再利用)。

注解

类似于进程 ID，线程 ID 的有效期（全系统范围内保证唯一）将从线程被创建开始直到线程被终结。

可用性: 需要 get_native_id() 函数。

3.8 新版功能.

is_alive()

返回线程是否存活。

当 run() 方法刚开始直到 run() 方法刚结束，这个方法返回 True 。模块函数 enumerate() 返回包含所有存活线程的列表。

daemon

一个布尔值，表示这个线程是否是一个守护线程（True）或不是（False）。 这个值必须在调用 start() 之前设置，否则会引发 RuntimeError 。它的初始值继承自创建线程；主线程不是一个守护线程，因此所有在主线程中创建的线程默认为 daemon = False。

当没有存活的非守护线程时，整个Python程序才会退出。

isDaemon()

setDaemon()

已被弃用的 daemon 的取值/设值 API；请改为直接以特征属性方式使用它。

3.10 版后已移除.

锁对象

原始锁是一个在锁定时不属于特定线程的同步基元组件。在Python中，它是能用的最低级的同步基元组件，由 _thread 扩展模块直接实现。

原始锁处于 "锁定" 或者 "非锁定" 两种状态之一。它被创建时为非锁定状态。它有两个基本方法， acquire() 和 release() 。当状态为非锁定时， acquire() 将状态改为 锁定 并立即返回。当状态是锁定时， acquire() 将阻塞至其他线程调用 release() 将其改为非锁定状态，然后 acquire() 调用重置其为锁定状态并返回。 release() 只在锁定状态下调用； 它将状态改为非锁定并立即返回。如果尝试释放一个非锁定的锁，则会引发 RuntimeError  异常。

锁同样支持 上下文管理协议。

当多个线程在 acquire() 等待状态转变为未锁定被阻塞，然后 release() 重置状态为未锁定时，只有一个线程能继续执行；至于哪个等待线程继续执行没有定义，并且会根据实现而不同。

所有方法的执行都是原子性的。

class threading.Lock

实现原始锁对象的类。一旦一个线程获得一个锁，会阻塞随后尝试获得锁的线程，直到它被释放；任何线程都可以释放它。

需要注意的是 Lock 其实是一个工厂函数，返回平台支持的具体锁类中最有效的版本的实例。

acquire(blocking=True, timeout=- 1)

可以阻塞或非阻塞地获得锁。

当调用时参数 blocking 设置为 True （缺省值），阻塞直到锁被释放，然后将锁锁定并返回 True 。

在参数 blocking 被设置为 False 的情况下调用，将不会发生阻塞。如果调用时 blocking 设为 True 会阻塞，并立即返回 False ；否则，将锁锁定并返回 True。

当参数 timeout 使用设置为正值的浮点数调用时，最多阻塞 timeout 指定的秒数，在此期间锁不能被获取。设置 timeout 参数为 -1 specifies an unbounded wait. It is forbidden to specify a timeout when blocking is False 。

如果成功获得锁，则返回 True，否则返回 False (例如发生 超时 的时候)。

在 3.2 版更改: 新的 timeout 形参。

在 3.2 版更改: 现在如果底层线程实现支持，则可以通过POSIX上的信号中断锁的获取。

release()

释放一个锁。这个方法可以在任何线程中调用，不单指获得锁的线程。

当锁被锁定，将它重置为未锁定，并返回。如果其他线程正在等待这个锁解锁而被阻塞，只允许其中一个允许。

当在未锁定的锁上唤起时，会引发 RuntimeError。

没有返回值。

locked()

当锁被获取时，返回 True。

递归锁对象

重入锁是一个可以被同一个线程多次获取的同步基元组件。在内部，它在基元锁的锁定/非锁定状态上附加了 "所属线程" 和 "递归等级" 的概念。在锁定状态下，某些线程拥有锁 ； 在非锁定状态下， 没有线程拥有它。

若要锁定锁，线程调用其 acquire() 方法；一旦线程拥有了锁，方法将返回。若要解锁，线程调用 release() 方法。 acquire()/release() 对可以嵌套；只有最终 release() (最外面一对的 release() ) 将锁解开，才能让其他线程继续处理 acquire() 阻塞。

递归锁也支持 上下文管理协议。

class threading.RLock

此类实现了重入锁对象。重入锁必须由获取它的线程释放。一旦线程获得了重入锁，同一个线程再次获取它将不阻塞；线程必须在每次获取它时释放一次。

需要注意的是 RLock 其实是一个工厂函数，返回平台支持的具体递归锁类中最有效的版本的实例。

acquire(blocking=True, timeout=- 1)

可以阻塞或非阻塞地获得锁。

当无参数调用时： 如果这个线程已经拥有锁，递归级别增加一，并立即返回。否则，如果其他线程拥有该锁，则阻塞至该锁解锁。一旦锁被解锁(不属于任何线程)，则抢夺所有权，设置递归等级为一，并返回。如果多个线程被阻塞，等待锁被解锁，一次只有一个线程能抢到锁的所有权。在这种情况下，没有返回值。

当调用时，将 blocking 参数设置为 True，所做的事情与调用时没有参数时相同，并返回 True。

当 blocking 参数设置为 False``时调用，不会阻塞。如果调用时没有参数而且会阻塞，立即返回``False；否则，做与没有参数的调用相同的事情，并返回 True。

当浮点数参数 timeout 设置为正值时调用，最多阻断 timeout 指定的秒数，如果期间锁不能被获取。 如果锁已被获取返回 True，如果超时已过，则返回 False。

在 3.2 版更改: 新的 timeout 形参。

release()

释放锁，自减递归等级。如果减到零，则将锁重置为非锁定状态(不被任何线程拥有)，并且，如果其他线程正被阻塞着等待锁被解锁，则仅允许其中一个线程继续。如果自减后，递归等级仍然不是零，则锁保持锁定，仍由调用线程拥有。

只有当前线程拥有锁才能调用这个方法。如果锁被释放后调用这个方法，会引起 RuntimeError 异常。

没有返回值。

条件对象

条件变量总是与某种类型的锁对象相关联，锁对象可以通过传入获得，或者在缺省的情况下自动创建。当多个条件变量需要共享同一个锁时，传入一个锁很有用。锁是条件对象的一部分，你不必单独地跟踪它。

条件变量遵循 上下文管理协议 ：使用 with 语句会在它包围的代码块内获取关联的锁。 acquire() 和 release() 方法也能调用关联锁的相关方法。

其它方法必须在持有关联的锁的情况下调用。 wait() 方法释放锁，然后阻塞直到其它线程调用 notify() 方法或 notify_all() 方法唤醒它。一旦被唤醒， wait() 方法重新获取锁并返回。它也可以指定超时时间。

The notify() method wakes up one of the threads waiting for the condition variable, if any are waiting. The notify_all() method wakes up all threads waiting for the condition variable.

注意： notify() 方法和 notify_all() 方法并不会释放锁，这意味着被唤醒的线程不会立即从它们的 wait() 方法调用中返回，而是会在调用了 notify() 方法或 notify_all() 方法的线程最终放弃了锁的所有权后返回。

使用条件变量的典型编程风格是将锁用于同步某些共享状态的权限，那些对状态的某些特定改变感兴趣的线程，它们重复调用 wait() 方法，直到看到所期望的改变发生；而对于修改状态的线程，它们将当前状态改变为可能是等待者所期待的新状态后，调用 notify() 方法或者 notify_all() 方法。例如，下面的代码是一个通用的无限缓冲区容量的生产者-消费者情形：

# Consume one item
with cv:
    while not an_item_is_available():
        cv.wait()
    get_an_available_item()

# Produce one item
with cv:
    make_an_item_available()
    cv.notify()

使用 while 循环检查所要求的条件成立与否是有必要的，因为 wait() 方法可能要经过不确定长度的时间后才会返回，而此时导致 notify() 方法调用的那个条件可能已经不再成立。这是多线程编程所固有的问题。 wait_for() 方法可自动化条件检查，并简化超时计算。

# Consume an item
with cv:
    cv.wait_for(an_item_is_available)
    get_an_available_item()

选择 notify() 还是 notify_all() ，取决于一次状态改变是只能被一个还是能被多个等待线程所用。例如在一个典型的生产者-消费者情形中，添加一个项目到缓冲区只需唤醒一个消费者线程。

class threading.Condition(lock=None)

实现条件变量对象的类。一个条件变量对象允许一个或多个线程在被其它线程所通知之前进行等待。

如果给出了非 None 的 lock 参数，则它必须为 Lock 或者 RLock 对象，并且它将被用作底层锁。否则，将会创建新的 RLock 对象，并将其用作底层锁。

在 3.3 版更改: 从工厂函数变为类。

acquire(*args)

请求底层锁。此方法调用底层锁的相应方法，返回值是底层锁相应方法的返回值。

release()

释放底层锁。此方法调用底层锁的相应方法。没有返回值。

wait(timeout=None)

等待直到被通知或发生超时。如果线程在调用此方法时没有获得锁，将会引发 RuntimeError 异常。

这个方法释放底层锁，然后阻塞，直到在另外一个线程中调用同一个条件变量的 notify() 或 notify_all() 唤醒它，或者直到可选的超时发生。一旦被唤醒或者超时，它重新获得锁并返回。

当提供了 timeout 参数且不是 None 时，它应该是一个浮点数，代表操作的超时时间，以秒为单位（可以为小数）。

当底层锁是个 RLock ，不会使用它的 release() 方法释放锁，因为当它被递归多次获取时，实际上可能无法解锁。相反，使用了 RLock 类的内部接口，即使多次递归获取它也能解锁它。 然后，在重新获取锁时，使用另一个内部接口来恢复递归级别。

返回 True ，除非提供的 timeout 过期，这种情况下返回 False。

在 3.2 版更改: 在此之前，方法总是返回 None。

wait_for(predicate, timeout=None)

等待，直到条件计算为真。 predicate 应该是一个可调用对象而且它的返回值可被解释为一个布尔值。可以提供 timeout 参数给出最大等待时间。

这个实用方法会重复地调用 wait() 直到满足判断式或者发生超时。返回值是判断式最后一个返回值，而且如果方法发生超时会返回 False 。

忽略超时功能，调用此方法大致相当于编写:

while not predicate():
    cv.wait()

因此，规则同样适用于 wait() ：锁必须在被调用时保持获取，并在返回时重新获取。 随着锁定执行判断式。

3.2 新版功能.

notify(n=1)

默认唤醒一个等待这个条件的线程。如果调用线程在没有获得锁的情况下调用这个方法，会引发 RuntimeError 异常。

这个方法唤醒最多 n 个正在等待这个条件变量的线程；如果没有线程在等待，这是一个空操作。

当前实现中，如果至少有 n 个线程正在等待，准确唤醒 n 个线程。但是依赖这个行为并不安全。未来，优化的实现有时会唤醒超过 n 个线程。

注意：被唤醒的线程并没有真正恢复到它调用的 wait() ，直到它可以重新获得锁。 因为 notify() 不释放锁，其调用者才应该这样做。

notify_all()

唤醒所有正在等待这个条件的线程。这个方法行为与 notify() 相似，但并不只唤醒单一线程，而是唤醒所有等待线程。如果调用线程在调用这个方法时没有获得锁，会引发 RuntimeError 异常。

notifyAll 方法是此方法的已弃用别名。

信号量对象

这是计算机科学史上最古老的同步原语之一，早期的荷兰科学家 Edsger W. Dijkstra 发明了它。（他使用名称 P() 和 V() 而不是 acquire() 和 release() ）。

一个信号量管理一个内部计数器，该计数器因 acquire() 方法的调用而递减，因 release() 方法的调用而递增。 计数器的值永远不会小于零；当 acquire() 方法发现计数器为零时，将会阻塞，直到其它线程调用 release() 方法。

信号量对象也支持 上下文管理协议 。

class threading.Semaphore(value=1)

该类实现信号量对象。信号量对象管理一个原子性的计数器，代表 release() 方法的调用次数减去 acquire() 的调用次数再加上一个初始值。如果需要， acquire() 方法将会阻塞直到可以返回而不会使得计数器变成负数。在没有显式给出 value 的值时，默认为1。

可选参数 value 赋予内部计数器初始值，默认值为 1 。如果 value 被赋予小于0的值，将会引发 ValueError 异常。

在 3.3 版更改: 从工厂函数变为类。

acquire(blocking=True, timeout=None)

获取一个信号量。

在不带参数的情况下调用时：

如果在进入时内部计数器的值大于零，则将其减一并立即返回 True。

如果在进入时内部计数器的值为零，则将会阻塞直到被对 release() 的调用唤醒。 一旦被唤醒（并且计数器的值大于 0），则将计数器减 1 并返回 True。 每次对 release() 的调用将只唤醒一个线程。 线程被唤醒的次序是不可确定的。

当 blocking 设置为 False 时调用，不会阻塞。 如果没有参数的调用会阻塞，立即返回 False；否则，做与无参数调用相同的事情时返回 True。

当被唤起时如果 timeout 不为 None，则它将阻塞最多 timeout 秒。 请求在此时段时未能成功完成获取则将返回 False。 在其他情况下返回 True。

在 3.2 版更改: 新的 timeout 形参。

release(n=1)

释放一个信号量，将内部计数器的值增加 n。 当进入时值为零且有其他线程正在等待它再次变为大于零时，则唤醒那 n 个线程。

在 3.9 版更改: 增加了 n 形参以一次性释放多个等待线程。

class threading.BoundedSemaphore(value=1)

该类实现有界信号量。有界信号量通过检查以确保它当前的值不会超过初始值。如果超过了初始值，将会引发 ValueError 异常。在大多情况下，信号量用于保护数量有限的资源。如果信号量被释放的次数过多，则表明出现了错误。没有指定时， value 的值默认为1。

在 3.3 版更改: 从工厂函数变为类。

Semaphore 例子

信号量通常用于保护数量有限的资源，例如数据库服务器。在资源数量固定的任何情况下，都应该使用有界信号量。在生成任何工作线程前，应该在主线程中初始化信号量。

maxconnections = 5
# ...
pool_sema = BoundedSemaphore(value=maxconnections)

工作线程生成后，当需要连接服务器时，这些线程将调用信号量的 acquire 和 release 方法：

with pool_sema:
    conn = connectdb()
    try:
        # ... use connection ...
    finally:
        conn.close()

使用有界信号量能减少这种编程错误：信号量的释放次数多于其请求次数。

事件对象

这是线程之间通信的最简单机制之一：一个线程发出事件信号，而其他线程等待该信号。

一个事件对象管理一个内部标识，调用 set() 方法可将其设置为 true ，调用 clear() 方法可将其设置为 false ，调用 wait() 方法将进入阻塞直到标识为 true 。

class threading.Event

实现事件对象的类。事件对象管理一个内部标识，调用 set() 方法可将其设置为true。调用 clear() 方法可将其设置为 false 。调用 wait() 方法将进入阻塞直到标识为true。这个标识初始时为 false 。

在 3.3 版更改: 从工厂函数变为类。

is_set()

当且仅当内部标识为 true 时返回 True 。

isSet 方法是此方法的已弃用别名。

set()

将内部标识设置为 true 。所有正在等待这个事件的线程将被唤醒。当标识为 true 时，调用 wait() 方法的线程不会被被阻塞。

clear()

将内部标识设置为 false 。之后调用 wait() 方法的线程将会被阻塞，直到调用 set() 方法将内部标识再次设置为 true 。

wait(timeout=None)

阻塞线程直到内部变量为 true 。如果调用时内部标识为 true，将立即返回。否则将阻塞线程，直到调用 set() 方法将标识设置为 true 或者发生可选的超时。

当提供了timeout参数且不是 None 时，它应该是一个浮点数，代表操作的超时时间，以秒为单位（可以为小数）。

当且仅当内部旗标在等待调用之前或者等待开始之后被设为真值时此方法将返回 True，也就是说，它将总是返回 True 除非设定了超时且操作发生了超时。

在 3.1 版更改: 在此之前，方法总是返回 None。

定时器对象

此类表示一个操作应该在等待一定的时间之后运行 --- 相当于一个定时器。 Timer 类是 Thread 类的子类，因此可以像一个自定义线程一样工作。

与线程一样，通过调用 start() 方法启动定时器。而 cancel() 方法可以停止计时器（在计时结束前）， 定时器在执行其操作之前等待的时间间隔可能与用户指定的时间间隔不完全相同。

例如：

def hello():
    print("hello, world")

t = Timer(30.0, hello)
t.start()  # after 30 seconds, "hello, world" will be printed

class threading.Timer(interval, function, args=None, kwargs=None)

创建一个定时器，在经过 interval 秒的间隔事件后，将会用参数 args 和关键字参数 kwargs 调用 function。如果 args 为 None （默认值），则会使用一个空列表。如果 kwargs 为 None （默认值），则会使用一个空字典。

在 3.3 版更改: 从工厂函数变为类。

cancel()

停止定时器并取消执行计时器将要执行的操作。仅当计时器仍处于等待状态时有效。

栅栏对象

3.2 新版功能.

栅栏类提供一个简单的同步原语，用于应对固定数量的线程需要彼此相互等待的情况。线程调用 wait() 方法后将阻塞，直到所有线程都调用了 wait() 方法。此时所有线程将被同时释放。

栅栏对象可以被多次使用，但进程的数量不能改变。

这是一个使用简便的方法实现客户端进程与服务端进程同步的例子：

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)

class threading.Barrier(parties, action=None, timeout=None)

创建一个需要 parties 个线程的栅栏对象。如果提供了可调用的 action 参数，它会在所有线程被释放时在其中一个线程中自动调用。 timeout 是默认的超时时间，如果没有在 wait() 方法中指定超时时间的话。

wait(timeout=None)

冲出栅栏。当栅栏中所有线程都已经调用了这个函数，它们将同时被释放。如果提供了 timeout 参数，这里的 timeout 参数优先于创建栅栏对象时提供的 timeout 参数。

函数返回值是一个整数，取值范围在0到 parties -- 1，在每个线程中的返回值不相同。可用于从所有线程中选择唯一的一个线程执行一些特别的工作。例如：

i = barrier.wait()
if i == 0:
    # Only one thread needs to print this
    print("passed the barrier")

如果创建栅栏对象时在构造函数中提供了 action 参数，它将在其中一个线程释放前被调用。如果此调用引发了异常，栅栏对象将进入损坏态。

如果发生了超时，栅栏对象将进入破损态。

如果栅栏对象进入破损态，或重置栅栏时仍有线程等待释放，将会引发 BrokenBarrierError 异常。

reset()

重置栅栏为默认的初始态。如果栅栏中仍有线程等待释放，这些线程将会收到 BrokenBarrierError 异常。

请注意使用此函数时，如果存在状态未知的其他线程，则可能需要执行外部同步。 如果栅栏已损坏则最好将其废弃并新建一个。

abort()

使栅栏处于损坏状态。 这将导致任何现有和未来对 wait() 的调用失败并引发 BrokenBarrierError。 例如可以在需要中止某个线程时使用此方法，以避免应用程序的死锁。

更好的方式是：创建栅栏时提供一个合理的超时时间，来自动避免某个线程出错。

parties

冲出栅栏所需要的线程数量。

n_waiting

当前时刻正在栅栏中阻塞的线程数量。

broken

一个布尔值，值为 True 表明栅栏为破损态。

exception threading.BrokenBarrierError

异常类，是 RuntimeError 异常的子类，在 Barrier 对象重置时仍有线程阻塞时和对象进入破损态时被引发。

在 with 语句中使用锁、条件和信号量

这个模块提供的带有 acquire() 和 release() 方法的对象，可以被用作 with 语句的上下文管理器。当进入语句块时 acquire() 方法会被调用，退出语句块时 release() 会被调用。因此，以下片段:

with some_lock:
    # do something...

相当于:

some_lock.acquire()
try:
    # do something...
finally:
    some_lock.release()

现在 Lock 、 RLock 、 Condition 、 Semaphore 和 BoundedSemaphore 对象可以用作 with 语句的上下文管理器。

multiprocessing --- 基于进程的并行

源代码 Lib/multiprocessing/ [https://github.com/python/cpython/tree/3.10/Lib/multiprocessing/]

概述

multiprocessing 是一个支持使用与 threading 模块类似的 API 来产生进程的包。 multiprocessing 包同时提供了本地和远程并发操作，通过使用子进程而非线程有效地绕过了 全局解释器锁。 因此，multiprocessing 模块允许程序员充分利用给定机器上的多个处理器。 它在 Unix 和 Windows 上均可运行。

multiprocessing 模块还引入了在 threading 模块中没有的API。一个主要的例子就是 Pool 对象，它提供了一种快捷的方法，赋予函数并行化处理一系列输入值的能力，可以将输入数据分配给不同进程处理（数据并行）。下面的例子演示了在模块中定义此类函数的常见做法，以便子进程可以成功导入该模块。这个数据并行的基本例子使用了 Pool ，

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]))

将在标准输出中打印

[1, 4, 9]

参见

concurrent.futures.ProcessPoolExecutor 提供了一个更高层级的接口用来将任务推送到后台进程而不会阻塞调用方进程的执行。 与直接使用 Pool 接口相比，concurrent.futures API 能更好地允许将工作单元发往无需等待结果的下层进程池。

Process 类

在 multiprocessing 中，通过创建一个 Process 对象然后调用它的 start() 方法来生成进程。 Process 和 threading.Thread API 相同。 一个简单的多进程程序示例是:

from multiprocessing import Process

def f(name):
    print('hello', name)

if __name__ == '__main__':
    p = Process(target=f, args=('bob',))
    p.start()
    p.join()

要显示所涉及的各个进程ID，这是一个扩展示例:

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()

关于为什么 if __name__ == '__main__' 部分是必需的解释，请参见 编程指导。

上下文和启动方法

根据不同的平台， multiprocessing 支持三种启动进程的方法。这些 启动方法 有

spawn

父进程会启动一个新的 Python 解释器进程。 子进程将只继承那些运行进程对象的 run() 方法所必须的资源。 特别地，来自父进程的非必需文件描述符和句柄将不会被继承。 使用此方法启动进程相比使用 fork 或 forkserver 要慢上许多。

可在 Unix 和 Windows 上使用。 Windows 和 macOS 上的默认设置。

fork

父进程使用 os.fork() 来产生 Python 解释器分叉。子进程在开始时实际上与父进程相同。父进程的所有资源都由子进程继承。请注意，安全分叉多线程进程是棘手的。

只存在于 Unix。 Unix 中的默认值。

forkserver

程序启动并选择 forkserver 启动方法时，将启动服务器进程。 从那时起，每当需要一个新进程时，父进程就会连接到服务器并请求它分叉一个新进程。 分叉服务器进程是单线程的，因此使用 os.fork() 是安全的。 没有不必要的资源被继承。

可在Unix平台上使用，支持通过Unix管道传递文件描述符。

在 3.8 版更改: 对于 macOS，spawn 启动方式是默认方式。 因为 fork 可能导致subprocess崩溃，被认为是不安全的，查看 bpo-33725 [https://bugs.python.org/issue?@action=redirect&bpo=33725] 。

在 3.4 版更改: spawn added on all Unix platforms, and forkserver added for some Unix platforms. Child processes no longer inherit all of the parents inheritable handles on Windows.

在 Unix 上通过 spawn 和 forkserver 方式启动多进程会同时启动一个 资源追踪 进程，负责追踪当前程序的进程产生的、并且不再被使用的命名系统资源(如命名信号量以及 SharedMemory 对象)。当所有进程退出后，资源追踪会负责释放这些仍被追踪的的对象。通常情况下是不会有这种对象的，但是假如一个子进程被某个信号杀死，就可能存在这一类资源的“泄露”情况。（泄露的信号量以及共享内存不会被释放，直到下一次系统重启，对于这两类资源来说，这是一个比较大的问题，因为操作系统允许的命名信号量的数量是有限的，而共享内存也会占据主内存的一片空间）

要选择一个启动方法，你应该在主模块的 if __name__ == '__main__' 子句中调用 set_start_method() 。例如：

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()

在程序中 set_start_method() 不应该被多次调用。

或者，你可以使用 get_context() 来获取上下文对象。上下文对象与 multiprocessing 模块具有相同的API，并允许在同一程序中使用多种启动方法。:

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()

请注意，对象在不同上下文创建的进程间可能并不兼容。 特别是，使用 fork 上下文创建的锁不能传递给使用 spawn 或 forkserver 启动方法启动的进程。

想要使用特定启动方法的库应该使用 get_context() 以避免干扰库用户的选择。

警告

'spawn' 和 'forkserver' 启动方法当前不能在Unix上和“冻结的”可执行内容一同使用（例如，有类似 PyInstaller 和 cx_Freeze 的包产生的二进制文件）。 'fork' 启动方法可以使用。

在进程之间交换对象

multiprocessing 支持进程之间的两种通信通道：

队列

Queue 类是一个近似 queue.Queue 的克隆。 例如:

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())    # prints "[42, None, 'hello']"
    p.join()

队列是线程和进程安全的。

管道

Pipe() 函数返回一个由管道连接的连接对象，默认情况下是双工（双向）。例如:

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())   # prints "[42, None, 'hello']"
    p.join()

返回的两个连接对象 Pipe() 表示管道的两端。每个连接对象都有 send() 和 recv() 方法（相互之间的）。请注意，如果两个进程（或线程）同时尝试读取或写入管道的 同一 端，则管道中的数据可能会损坏。当然，在不同进程中同时使用管道的不同端的情况下不存在损坏的风险。

进程间同步

multiprocessing 包含来自 threading 的所有同步原语的等价物。例如，可以使用锁来确保一次只有一个进程打印到标准输出:

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()

不使用锁的情况下，来自于多进程的输出很容易产生混淆。

进程间共享状态

如上所述，在进行并发编程时，通常最好尽量避免使用共享状态。使用多个进程时尤其如此。

但是，如果你真的需要使用一些共享数据，那么 multiprocessing 提供了两种方法。

共享内存

可以使用 Value 或 Array 将数据存储在共享内存映射中。例如，以下代码:

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[:])

将打印

3.1415927
[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]

创建 num 和 arr 时使用的 'd' 和 'i' 参数是 array 模块使用的类型的 typecode ： 'd' 表示双精度浮点数， 'i' 表示有符号整数。这些共享对象将是进程和线程安全的。

为了更灵活地使用共享内存，可以使用 multiprocessing.sharedctypes 模块，该模块支持创建从共享内存分配的任意ctypes对象。

服务进程

由 Manager() 返回的管理器对象控制一个服务进程，该进程保存Python对象并允许其他进程使用代理操作它们。

Manager() 返回的管理器支持类型： list 、 dict 、 Namespace 、 Lock 、 RLock 、 Semaphore 、 BoundedSemaphore 、 Condition 、 Event 、 Barrier 、 Queue 、 Value 和 Array 。例如

from multiprocessing import Process, Manager

def f(d, l):
    d[1] = '1'
    d['2'] = 2
    d[0.25] = None
    l.reverse()

if __name__ == '__main__':
    with Manager() as manager:
        d = manager.dict()
        l = manager.list(range(10))

        p = Process(target=f, args=(d, l))
        p.start()
        p.join()

        print(d)
        print(l)

将打印

{0.25: None, 1: '1', '2': 2}
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]

使用服务进程的管理器比使用共享内存对象更灵活，因为它们可以支持任意对象类型。此外，单个管理器可以通过网络由不同计算机上的进程共享。但是，它们比使用共享内存慢。

使用工作进程

Pool 类表示一个工作进程池。它具有允许以几种不同方式将任务分配到工作进程的方法。

例如：

from multiprocessing import Pool, TimeoutError
import time
import os

def f(x):
    return x*x

if __name__ == '__main__':
    # start 4 worker processes
    with Pool(processes=4) as pool:

        # print "[0, 1, 4,..., 81]"
        print(pool.map(f, range(10)))

        # print same numbers in arbitrary order
        for i in pool.imap_unordered(f, range(10)):
            print(i)

        # evaluate "f(20)" asynchronously
        res = pool.apply_async(f, (20,))      # runs in *only* one process
        print(res.get(timeout=1))             # prints "400"

        # evaluate "os.getpid()" asynchronously
        res = pool.apply_async(os.getpid, ()) # runs in *only* one process
        print(res.get(timeout=1))             # prints the PID of that process

        # launching multiple evaluations asynchronously *may* use more processes
        multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
        print([res.get(timeout=1) for res in multiple_results])

        # make a single worker sleep for 10 secs
        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")

    # exiting the 'with'-block has stopped the pool
    print("Now the pool is closed and no longer available")

请注意，进程池的方法只能由创建它的进程使用。

注解

这个包中的功能要求子进程可以导入 __main__ 模块。虽然这在 编程指导 中有描述，但还是需要提前说明一下。这意味着一些示例在交互式解释器中不起作用，比如 multiprocessing.pool.Pool 示例。例如:

>>> 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: 'module' object has no attribute 'f'
AttributeError: 'module' object has no attribute 'f'
AttributeError: 'module' object has no attribute 'f'

（如果尝试执行上面的代码，它会以一种半随机的方式将三个完整的堆栈内容交替输出，然后你只能以某种方式停止父进程。)

参考

multiprocessing 包主要复制了 threading 模块的API。

Process 和异常

class multiprocessing.Process(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)

进程对象表示在单独进程中运行的活动。 Process 类拥有和 threading.Thread 等价的大部分方法。

应始终使用关键字参数调用构造函数。 group 应该始终是 None ；它仅用于兼容 threading.Thread 。 target 是由 run() 方法调用的可调用对象。它默认为 None ，意味着什么都没有被调用。 name 是进程名称（有关详细信息，请参阅 name ）。 args 是目标调用的参数元组。 kwargs 是目标调用的关键字参数字典。如果提供，则键参数 daemon 将进程 daemon 标志设置为 True 或 False 。如果是 None （默认值），则该标志将从创建的进程继承。

默认情况下，不会将任何参数传递给 target 。

如果子类重写构造函数，它必须确保它在对进程执行任何其他操作之前调用基类构造函数（ Process.__init__() ）。

在 3.3 版更改: 加入 daemon 参数。

run()

表示进程活动的方法。

你可以在子类中重写此方法。标准 run() 方法调用传递给对象构造函数的可调用对象作为目标参数（如果有），分别从 args 和 kwargs 参数中获取顺序和关键字参数。

start()

启动进程活动。

这个方法每个进程对象最多只能调用一次。它会将对象的 run() 方法安排在一个单独的进程中调用。

join([timeout])

如果可选参数 timeout 是 None （默认值），则该方法将阻塞，直到调用 join() 方法的进程终止。如果 timeout 是一个正数，它最多会阻塞 timeout 秒。请注意，如果进程终止或方法超时，则该方法返回 None 。检查进程的 exitcode 以确定它是否终止。

一个进程可以被 join 多次。

进程无法join自身，因为这会导致死锁。尝试在启动进程之前join进程是错误的。

name

进程的名称。该名称是一个字符串，仅用于识别目的。它没有语义。可以为多个进程指定相同的名称。

初始名称由构造器设定。 如果没有为构造器提供显式名称，则会构造一个形式为 'Process-N₁:N₂:...:Nk' 的名称，其中每个 Nk 是其父亲的第 N 个孩子。

is_alive()

返回进程是否还活着。

粗略地说，从 start() 方法返回到子进程终止之前，进程对象仍处于活动状态。

daemon

进程的守护标志，一个布尔值。这必须在 start() 被调用之前设置。

初始值继承自创建进程。

当进程退出时，它会尝试终止其所有守护进程子进程。

请注意，不允许在守护进程中创建子进程。这是因为当守护进程由于父进程退出而中断时，其子进程会变成孤儿进程。 另外，这些 不是 Unix 守护进程或服务，它们是正常进程，如果非守护进程已经退出，它们将被终止（并且不被合并）。

除了 threading.Thread API ，Process 对象还支持以下属性和方法：

pid

返回进程ID。在生成该进程之前，这将是 None 。

exitcode

子进程的退出代码。如果该进程尚未终止则为 None 。

如果子进程的 run() 方法正常返回，退出代码将是 0 。 如果它通过 sys.exit() 终止，并有一个整数参数 N ，退出代码将是 N 。

如果子进程由于在 run() 内的未捕获异常而终止，退出代码将是 1 。 如果它是由信号 N 终止的，退出代码将是负值 -N 。

authkey

进程的身份验证密钥（字节字符串）。

当 multiprocessing 初始化时，主进程使用 os.urandom() 分配一个随机字符串。

当创建 Process 对象时，它将继承其父进程的身份验证密钥，尽管可以通过将 authkey 设置为另一个字节字符串来更改。

参见 认证密码 。

sentinel

系统对象的数字句柄，当进程结束时将变为 "ready" 。

如果要使用 multiprocessing.connection.wait() 一次等待多个事件，可以使用此值。否则调用 join() 更简单。

在Windows上，这是一个操作系统句柄，可以与 WaitForSingleObject 和 WaitForMultipleObjects 系列API调用一起使用。在Unix上，这是一个文件描述符，可以使用来自 select 模块的原语。

3.3 新版功能.

terminate()

终止进程。 在Unix上，这是使用 SIGTERM 信号完成的；在Windows上使用 TerminateProcess() 。 请注意，不会执行退出处理程序和finally子句等。

请注意，进程的后代进程将不会被终止 —— 它们将简单地变成孤立的。

警告

如果在关联进程使用管道或队列时使用此方法，则管道或队列可能会损坏，并可能无法被其他进程使用。类似地，如果进程已获得锁或信号量等，则终止它可能导致其他进程死锁。

kill()

与 terminate() 相同，但在Unix上使用 SIGKILL 信号。

3.7 新版功能.

close()

关闭 Process 对象，释放与之关联的所有资源。如果底层进程仍在运行，则会引发 ValueError 。一旦 close() 成功返回， Process 对象的大多数其他方法和属性将引发 ValueError 。

3.7 新版功能.

注意 start() 、 join() 、 is_alive() 、 terminate() 和 exitcode 方法只能由创建进程对象的进程调用。

Process 一些方法的示例用法：

>>> import multiprocessing, time, signal
>>> p = multiprocessing.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

exception multiprocessing.ProcessError

所有 multiprocessing 异常的基类。

exception multiprocessing.BufferTooShort

当提供的缓冲区对象太小而无法读取消息时， Connection.recv_bytes_into() 引发的异常。

如果 e 是一个 BufferTooShort 实例，那么 e.args[0] 将把消息作为字节字符串给出。

exception multiprocessing.AuthenticationError

出现身份验证错误时引发。

exception multiprocessing.TimeoutError

有超时的方法超时时引发。

管道和队列

使用多进程时，一般使用消息机制实现进程间通信，尽可能避免使用同步原语，例如锁。

消息机制包含： Pipe() (可以用于在两个进程间传递消息)，以及队列(能够在多个生产者和消费者之间通信)。

Queue, SimpleQueue 以及 JoinableQueue 都是多生产者，多消费者，并且实现了 FIFO 的队列类型，其表现与标准库中的 queue.Queue 类相似。 不同之处在于 Queue 缺少标准库的 queue.Queue 从 Python 2.5 开始引入的 task_done() 和 join() 方法。

如果你使用了 JoinableQueue ，那么你 必须 对每个已经移出队列的任务调用 JoinableQueue.task_done()。 不然的话用于统计未完成任务的信号量最终会溢出并抛出异常。

另外还可以通过使用一个管理器对象创建一个共享队列，详见 管理器 。

注解

multiprocessing 使用了普通的 queue.Empty 和 queue.Full 异常去表示超时。 你需要从 queue 中导入它们，因为它们并不在 multiprocessing 的命名空间中。

注解

当一个对象被放入一个队列中时，这个对象首先会被一个后台线程用 pickle 序列化，并将序列化后的数据通过一个底层管道的管道传递到队列中。 这种做法会有点让人惊讶，但一般不会出现什么问题。 如果它们确实妨碍了你，你可以使用一个由管理器 manager 创建的队列替换它。

将一个对象放入一个空队列后，可能需要极小的延迟，队列的方法 empty()  才会返回 False 。而 get_nowait() 可以不抛出 queue.Empty 直接返回。

如果有多个进程同时将对象放入队列，那么在队列的另一端接受到的对象可能是无序的。但是由同一个进程放入的多个对象的顺序在另一端输出时总是一样的。

警告

如果一个进程在尝试使用 Queue 期间被 Process.terminate() 或 os.kill() 调用终止了，那么队列中的数据很可能被破坏。 这可能导致其他进程在尝试使用该队列时发生异常。

警告

正如刚才提到的，如果一个子进程将一些对象放进队列中 (并且它没有用 JoinableQueue.cancel_join_thread 方法)，那么这个进程在所有缓冲区的对象被刷新进管道之前，是不会终止的。

这意味着，除非你确定所有放入队列中的对象都已经被消费了，否则如果你试图等待这个进程，你可能会陷入死锁中。相似地，如果该子进程不是后台进程，那么父进程可能在试图等待所有非后台进程退出时挂起。

注意用管理器创建的队列不存在这个问题，详见 编程指导 。

该 例子 展示了如何使用队列实现进程间通信。

multiprocessing.Pipe([duplex])

返回一对 Connection 对象 (conn1, conn2) ， 分别表示管道的两端。

如果 duplex 被置为 True (默认值)，那么该管道是双向的。如果 duplex 被置为 False ，那么该管道是单向的，即 conn1 只能用于接收消息，而 conn2 仅能用于发送消息。

class multiprocessing.Queue([maxsize])

返回一个使用一个管道和少量锁和信号量实现的共享队列实例。当一个进程将一个对象放进队列中时，一个写入线程会启动并将对象从缓冲区写入管道中。

一旦超时，将抛出标准库 queue 模块中常见的异常 queue.Empty 和 queue.Full。

除了 task_done() 和 join() 之外，Queue  实现了标准库类 queue.Queue 中所有的方法。

qsize()

返回队列的大致长度。由于多线程或者多进程的上下文，这个数字是不可靠的。

请注意，这可能会在Unix平台上引起 NotImplementedError ，如 macOS ，因为其上没有实现 sem_getvalue() 。

empty()

如果队列是空的，返回 True ，反之返回 False 。 由于多线程或多进程的环境，该状态是不可靠的。

full()

如果队列是满的，返回 True ，反之返回 False 。 由于多线程或多进程的环境，该状态是不可靠的。

put(obj[, block[, timeout]])

将 obj 放入队列。如果可选参数 block 是 True (默认值) 而且 timeout 是 None (默认值), 将会阻塞当前进程，直到有空的缓冲槽。如果 timeout 是正数，将会在阻塞了最多 timeout 秒之后还是没有可用的缓冲槽时抛出 queue.Full  异常。反之 (block 是 False 时)，仅当有可用缓冲槽时才放入对象，否则抛出 queue.Full 异常 (在这种情形下 timeout 参数会被忽略)。

在 3.8 版更改: 如果队列已经关闭，会抛出 ValueError 而不是 AssertionError 。

put_nowait(obj)

相当于 put(obj, False)。

get([block[, timeout]])

从队列中取出并返回对象。如果可选参数 block 是 True (默认值) 而且 timeout 是 None (默认值), 将会阻塞当前进程，直到队列中出现可用的对象。如果 timeout 是正数，将会在阻塞了最多 timeout 秒之后还是没有可用的对象时抛出 queue.Empty 异常。反之 (block 是 False 时)，仅当有可用对象能够取出时返回，否则抛出 queue.Empty 异常 (在这种情形下 timeout 参数会被忽略)。

在 3.8 版更改: 如果队列已经关闭，会抛出 ValueError 而不是 OSError 。

get_nowait()

相当于 get(False) 。

multiprocessing.Queue 类有一些在 queue.Queue 类中没有出现的方法。这些方法在大多数情形下并不是必须的。

close()

指示当前进程将不会再往队列中放入对象。一旦所有缓冲区中的数据被写入管道之后，后台的线程会退出。这个方法在队列被gc回收时会自动调用。

join_thread()

等待后台线程。这个方法仅在调用了 close() 方法之后可用。这会阻塞当前进程，直到后台线程退出，确保所有缓冲区中的数据都被写入管道中。

默认情况下，如果一个不是队列创建者的进程试图退出，它会尝试等待这个队列的后台线程。这个进程可以使用 cancel_join_thread() 让 join_thread() 方法什么都不做直接跳过。

cancel_join_thread()

防止 join_thread() 方法阻塞当前进程。具体而言，这防止进程退出时自动等待后台线程退出。详见 join_thread()。

这个方法更好的名字可能是 allow_exit_without_flush()。 这可能会导致已排入队列的数据丢失，几乎可以肯定你将不需要用到这个方法。 实际上它仅适用于当你需要当前进程立即退出而不必等待将已排入的队列更新到下层管道，并且你不担心丢失数据的时候。

注解

该类的功能依赖于宿主操作系统具有可用的共享信号量实现。否则该类将被禁用，任何试图实例化一个 Queue 对象的操作都会抛出 ImportError 异常，更多信息详见 bpo-3770 [https://bugs.python.org/issue?@action=redirect&bpo=3770] 。后续说明的任何专用队列对象亦如此。

class multiprocessing.SimpleQueue

这是一个简化的 Queue 类的实现，很像带锁的 Pipe 。

close()

关闭队列：释放内部资源。

队列在被关闭后就不可再被使用。 例如不可再调用 get(), put() 和 empty() 等方法。

3.9 新版功能.

empty()

如果队列为空返回 True ，否则返回 False 。

get()

从队列中移出并返回一个对象。

put(item)

将 item 放入队列。

class multiprocessing.JoinableQueue([maxsize])

JoinableQueue 类是 Queue 的子类，额外添加了 task_done() 和 join() 方法。

task_done()

指出之前进入队列的任务已经完成。由队列的消费者进程使用。对于每次调用 get() 获取的任务，执行完成后调用 task_done() 告诉队列该任务已经处理完成。

如果 join() 方法正在阻塞之中，该方法会在所有对象都被处理完的时候返回 (即对之前使用 put() 放进队列中的所有对象都已经返回了对应的 task_done() ) 。

如果被调用的次数多于放入队列中的项目数量，将引发 ValueError 异常 。

join()

阻塞至队列中所有的元素都被接收和处理完毕。

当条目添加到队列的时候，未完成任务的计数就会增加。每当消费者进程调用 task_done() 表示这个条目已经被回收，该条目所有工作已经完成，未完成计数就会减少。当未完成计数降到零的时候， join() 阻塞被解除。

杂项

multiprocessing.active_children()

返回当前进程存活的子进程的列表。

调用该方法有“等待”已经结束的进程的副作用。

multiprocessing.cpu_count()

返回系统的CPU数量。

该数量不同于当前进程可以使用的CPU数量。可用的CPU数量可以由 len(os.sched_getaffinity(0)) 方法获得。

当 CPU 的数量无法确定时，会引发 NotImplementedError 。

参见

os.cpu_count()

multiprocessing.current_process()

返回与当前进程相对应的 Process 对象。

和 threading.current_thread() 相同。

multiprocessing.parent_process()

返回父进程 Process  对象，和父进程调用 current_process() 返回的对象一样。如果一个进程已经是主进程， parent_process 会返回 None.

3.8 新版功能.

multiprocessing.freeze_support()

为使用了 multiprocessing  的程序，提供冻结以产生 Windows 可执行文件的支持。(在 py2exe, PyInstaller 和 cx_Freeze 上测试通过)

需要在 main 模块的 if __name__ == '__main__' 该行之后马上调用该函数。例如：

from multiprocessing import Process, freeze_support

def f():
    print('hello world!')

if __name__ == '__main__':
    freeze_support()
    Process(target=f).start()

如果没有调用 freeze_support() 在尝试运行被冻结的可执行文件时会抛出 RuntimeError 异常。

对 freeze_support() 的调用在非 Windows 平台上是无效的。如果该模块在 Windows 平台的 Python 解释器中正常运行 (该程序没有被冻结)， 调用 freeze_support() 也是无效的。

multiprocessing.get_all_start_methods()

返回支持的启动方法的列表，该列表的首项即为默认选项。可能的启动方法有 'fork' ， 'spawn' 和``'forkserver'`` 。在 Windows 中，只有 'spawn' 是可用的。 Unix 平台总是支持 'fork' 和 'spawn' ，且 'fork' 是默认值。

3.4 新版功能.

multiprocessing.get_context(method=None)

返回一个 Context 对象。该对象具有和 multiprocessing 模块相同的API。

如果 method 设置成 None 那么将返回默认上下文对象。否则 method  应该是 'fork', 'spawn', 'forkserver' 。 如果指定的启动方法不存在，将抛出 ValueError  异常。

3.4 新版功能.

multiprocessing.get_start_method(allow_none=False)

返回启动进程时使用的启动方法名。

如果启动方法已经固定，并且 allow_none 被设置成 False ，那么启动方法将被固定为默认的启动方法，并且返回其方法名。如果启动方法没有设定，并且 allow_none 被设置成 True ，那么将返回 None  。

返回值将为 'fork' , 'spawn' , 'forkserver' 或者 None 。 'fork' 是 Unix 的默认值， 'spawn' 是 Windows 和 macOS 的默认值。

在 3.8 版更改: 对于 macOS，spawn 启动方式是默认方式。 因为 fork 可能导致subprocess崩溃，被认为是不安全的，查看 bpo-33725 [https://bugs.python.org/issue?@action=redirect&bpo=33725] 。

3.4 新版功能.

multiprocessing.set_executable(executable)

设置在启动子进程时使用的 Python 解释器路径。 ( 默认使用 sys.executable ) 嵌入式编程人员可能需要这样做：

set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))

以使他们可以创建子进程。

在 3.4 版更改: 现在在 Unix 平台上使用 'spawn' 启动方法时支持调用该方法。

multiprocessing.set_start_method(method)

设置启动子进程的方法。 method 可以是 'fork' , 'spawn' 或者 'forkserver' 。

注意这最多只能调用一次，并且需要藏在 main 模块中，由 if __name__ == '__main__' 保护着。

3.4 新版功能.

注解

multiprocessing 并没有包含类似 threading.active_count() , threading.enumerate() , threading.settrace() , threading.setprofile(), threading.Timer , 或者 threading.local 的方法和类。

连接对象（Connection）

Connection 对象允许收发可以序列化的对象或字符串。它们可以看作面向消息的连接套接字。

通常使用 Pipe 创建 Connection 对象。详见 ： 监听器及客户端.

class multiprocessing.connection.Connection

send(obj)

将一个对象发送到连接的另一端，可以用 recv() 读取。

发送的对象必须是可以序列化的，过大的对象 ( 接近 32MiB+ ，这个值取决于操作系统 ) 有可能引发 ValueError  异常。

recv()

返回一个由另一端使用 send() 发送的对象。该方法会一直阻塞直到接收到对象。 如果对端关闭了连接或者没有东西可接收，将抛出 EOFError 异常。

fileno()

返回由连接对象使用的描述符或者句柄。

close()

关闭连接对象。

当连接对象被垃圾回收时会自动调用。

poll([timeout])

返回连接对象中是否有可以读取的数据。

如果未指定 timeout ，此方法会马上返回。如果 timeout 是一个数字，则指定了最大阻塞的秒数。如果 timeout 是 None，那么将一直等待，不会超时。

注意通过使用 multiprocessing.connection.wait() 可以一次轮询多个连接对象。

send_bytes(buffer[, offset[, size]])

从一个 bytes-like object 对象中取出字节数组并作为一条完整消息发送。

如果由 offset  给定了在 buffer 中读取数据的位置。 如果给定了 size ，那么将会从缓冲区中读取多个字节。 过大的缓冲区 ( 接近 32MiB+ ，此值依赖于操作系统 ) 有可能引发 ValueError  异常。

recv_bytes([maxlength])

以字符串形式返回一条从连接对象另一端发送过来的字节数据。此方法在接收到数据前将一直阻塞。 如果连接对象被对端关闭或者没有数据可读取，将抛出 EOFError 异常。

如果给定了 maxlength 并且消息长于 maxlength 那么将抛出 OSError 并且该连接对象将不再可读。

在 3.3 版更改: 曾经该函数抛出 IOError ，现在这是 OSError 的别名。

recv_bytes_into(buffer[, offset])

将一条完整的字节数据消息读入 buffer 中并返回消息的字节数。 此方法在接收到数据前将一直阻塞。 如果连接对象被对端关闭或者没有数据可读取，将抛出 EOFError  异常。

buffer must be a writable 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).

如果缓冲区太小，则将引发 BufferTooShort  异常，并且完整的消息将会存放在异常实例 e 的 e.args[0] 中。

在 3.3 版更改: 现在连接对象自身可以通过 Connection.send() 和 Connection.recv() 在进程之间传递。

3.3 新版功能: 连接对象现已支持上下文管理协议 -- 参见 see 上下文管理器类型 。 __enter__() 返回连接对象， __exit__() 会调用 close() 。

例如:

>>> 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])

警告

Connection.recv() 方法会自动解封它收到的数据，除非你能够信任发送消息的进程，否则此处可能有安全风险。

因此， 除非连接对象是由 Pipe() 产生的，否则你应该仅在使用了某种认证手段之后才使用 recv() 和 send() 方法。 参考 认证密码。

警告

如果一个进程在试图读写管道时被终止了，那么管道中的数据很可能是不完整的，因为此时可能无法确定消息的边界。

同步原语

通常来说同步原语在多进程环境中并不像它们在多线程环境中那么必要。参考 threading 模块的文档。

注意可以使用管理器对象创建同步原语，参考 管理器 。

class multiprocessing.Barrier(parties[, action[, timeout]])

类似 threading.Barrier 的栅栏对象。

3.3 新版功能.

class multiprocessing.BoundedSemaphore([value])

非常类似 threading.BoundedSemaphore 的有界信号量对象。

一个小小的不同在于，它的 acquire  方法的第一个参数名是和 Lock.acquire() 一样的 block 。

注解

在 macOS 平台上， 该对象于 Semaphore  不同在于 sem_getvalue() 方法并没有在该平台上实现。

class multiprocessing.Condition([lock])

条件变量： threading.Condition 的别名。

指定的 lock 参数应该是 multiprocessing 模块中的 Lock 或者 RLock 对象。

在 3.3 版更改: 新增了 wait_for()  方法。

class multiprocessing.Event

A clone of threading.Event.

class multiprocessing.Lock

原始锁（非递归锁）对象，类似于 threading.Lock 。一旦一个进程或者线程拿到了锁，后续的任何其他进程或线程的其他请求都会被阻塞直到锁被释放。任何进程或线程都可以释放锁。除非另有说明，否则 multiprocessing.Lock  用于进程或者线程的概念和行为都和 threading.Lock  一致。

注意 Lock 实际上是一个工厂函数。它返回由默认上下文初始化的 multiprocessing.synchronize.Lock  对象。

Lock supports the context manager protocol and thus may be used in with statements.

acquire(block=True, timeout=None)

可以阻塞或非阻塞地获得锁。

如果 block 参数被设为 True ( 默认值 ) ， 对该方法的调用在锁处于释放状态之前都会阻塞，然后将锁设置为锁住状态并返回 True 。需要注意的是第一个参数名与 threading.Lock.acquire() 的不同。

如果 block 参数被设置成 False ，方法的调用将不会阻塞。 如果锁当前处于锁住状态，将返回 False ； 否则将锁设置成锁住状态，并返回 True 。

当 timeout 是一个正浮点数时，会在等待锁的过程中最多阻塞等待 timeout 秒，当 timeout 是负数时，效果和 timeout 为0时一样，当 timeout 是 None （默认值）时，等待时间是无限长。需要注意的是，对于 timeout 参数是负数和 None 的情况, 其行为与 threading.Lock.acquire() 是不一样的。当 block 参数 为 False 时， timeout 并没有实际用处，会直接忽略。否则，函数会在拿到锁后返回 True 或者 超时没拿到锁后返回 False 。

release()

释放锁，可以在任何进程、线程使用，并不限于锁的拥有者。

当尝试释放一个没有被持有的锁时，会抛出 ValueError 异常，除此之外其行为与 threading.Lock.release() 一样。

class multiprocessing.RLock

递归锁对象: 类似于 threading.RLock 。递归锁必须由持有线程、进程亲自释放。如果某个进程或者线程拿到了递归锁，这个进程或者线程可以再次拿到这个锁而不需要等待。但是这个进程或者线程的拿锁操作和释放锁操作的次数必须相同。

注意 RLock 是一个工厂函数，调用后返回一个使用默认 context 初始化的 multiprocessing.synchronize.RLock 实例。

RLock 支持 context manager 协议，因此可在 with 语句内使用。

acquire(block=True, timeout=None)

可以阻塞或非阻塞地获得锁。

当 block 参数设置为 True 时，会一直阻塞直到锁处于空闲状态（没有被任何进程、线程拥有），除非当前进程或线程已经拥有了这把锁。然后当前进程/线程会持有这把锁（在锁没有其他持有者的情况下），锁内的递归等级加一，并返回 True . 注意， 这个函数第一个参数的行为和 threading.RLock.acquire() 的实现有几个不同点，包括参数名本身。

当 block 参数是 False , 将不会阻塞，如果此时锁被其他进程或者线程持有，当前进程、线程获取锁操作失败，锁的递归等级也不会改变，函数返回 False , 如果当前锁已经处于释放状态，则当前进程、线程则会拿到锁，并且锁内的递归等级加一，函数返回 True 。

timeout 参数的使用方法及行为与 Lock.acquire() 一样。但是要注意 timeout 的其中一些行为和 threading.RLock.acquire() 中实现的行为是不同的。

release()

释放锁，使锁内的递归等级减一。如果释放后锁内的递归等级降低为0，则会重置锁的状态为释放状态（即没有被任何进程、线程持有），重置后如果有有其他进程和线程在等待这把锁，他们中的一个会获得这个锁而继续运行。如果释放后锁内的递归等级还没到达0，则这个锁仍将保持未释放状态且当前进程和线程仍然是持有者。

只有当前进程或线程是锁的持有者时，才允许调用这个方法。如果当前进程或线程不是这个锁的拥有者，或者这个锁处于已释放的状态(即没有任何拥有者)，调用这个方法会抛出 AssertionError 异常。注意这里抛出的异常类型和 threading.RLock.release() 中实现的行为不一样。

class multiprocessing.Semaphore([value])

一种信号量对象: 类似于 threading.Semaphore.

一个小小的不同在于，它的 acquire  方法的第一个参数名是和 Lock.acquire() 一样的 block 。

注解

在 macOS 上，不支持 sem_timedwait ，所以，调用 acquire() 时如果使用 timeout 参数，会通过循环sleep来模拟这个函数的行为。

注解

假如信号 SIGINT 是来自于 Ctrl-C ，并且主线程被 BoundedSemaphore.acquire(), Lock.acquire(), RLock.acquire(), Semaphore.acquire(), Condition.acquire() 或 Condition.wait() 阻塞，则调用会立即中断同时抛出 KeyboardInterrupt 异常。

这和 threading 的行为不同，此模块中当执行对应的阻塞式调用时，SIGINT 会被忽略。

注解

这个包的某些功能依赖于宿主机系统的共享信号量的实现，如果系统没有这个特性， multiprocessing.synchronize 会被禁用，尝试导入这个模块会引发 ImportError 异常，详细信息请查看 bpo-3770 [https://bugs.python.org/issue?@action=redirect&bpo=3770] 。

共享 ctypes 对象

在共享内存上创建可被子进程继承的共享对象时是可行的。

multiprocessing.Value(typecode_or_type, *args, lock=True)

返回一个从共享内存上创建的 ctypes 对象。默认情况下返回的对象实际上是经过了同步器包装过的。可以通过 Value 的 value 属性访问这个对象本身。

typecode_or_type 指明了返回的对象类型: 它可能是一个 ctypes 类型或者 array  模块中每个类型对应的单字符长度的字符串。 *args 会透传给这个类的构造函数。

如果 lock 参数是 True （默认值）, 将会新建一个递归锁用于同步对于此值的访问操作。 如果 lock 是 Lock 或者 RLock 对象，那么这个传入的锁将会用于同步对这个值的访问操作，如果 lock 是 False , 那么对这个对象的访问将没有锁保护，也就是说这个变量不是进程安全的。

诸如 += 这类的操作会引发独立的读操作和写操作，也就是说这类操作符并不具有原子性。所以，如果你想让递增共享变量的操作具有原子性，仅仅以这样的方式并不能达到要求:

counter.value += 1

共享对象内部关联的锁是递归锁(默认情况下就是)的情况下， 你可以采用这种方式

with counter.get_lock():
    counter.value += 1

注意 lock 只能是命名参数。

multiprocessing.Array(typecode_or_type, size_or_initializer, *, lock=True)

从共享内存中申请并返回一个具有ctypes类型的数组对象。默认情况下返回值实际上是被同步器包装过的数组对象。

typecode_or_type 指明了返回的数组中的元素类型: 它可能是一个 ctypes 类型或者 array 模块中每个类型对应的单字符长度的字符串。 如果 size_or_initializer 是一个整数，那就会当做数组的长度，并且整个数组的内存会初始化为0。否则，如果 size_or_initializer 会被当成一个序列用于初始化数组中的每一个元素，并且会根据元素个数自动判断数组的长度。

如果 lock 为 True (默认值) 则将创建一个新的锁对象用于同步对值的访问。 如果 lock 为一个 Lock 或 RLock 对象则该对象将被用于同步对值的访问。 如果 lock 为 False 则对返回对象的访问将不会自动得到锁的保护，也就是说它不是“进程安全的”。

请注意 lock 是一个仅限关键字参数。

请注意 ctypes.c_char 的数组具有 value 和 raw 属性，允许被用来保存和提取字符串。

multiprocessing.sharedctypes 模块

multiprocessing.sharedctypes 模块提供了一些函数，用于分配来自共享内存的、可被子进程继承的 ctypes 对象。

注解

虽然可以将指针存储在共享内存中，但请记住它所引用的是特定进程地址空间中的位置。 而且，指针很可能在第二个进程的上下文中无效，尝试从第二个进程对指针进行解引用可能会导致崩溃。

multiprocessing.sharedctypes.RawArray(typecode_or_type, size_or_initializer)

从共享内存中申请并返回一个 ctypes 数组。

typecode_or_type 指明了返回的数组中的元素类型: 它可能是一个 ctypes 类型或者 array 模块中使用的类型字符。 如果 size_or_initializer 是一个整数，那就会当做数组的长度，并且整个数组的内存会初始化为0。否则，如果 size_or_initializer 会被当成一个序列用于初始化数组中的每一个元素，并且会根据元素个数自动判断数组的长度。

注意对元素的访问、赋值操作可能是非原子操作 - 使用 Array() , 从而借助其中的锁保证操作的原子性。

multiprocessing.sharedctypes.RawValue(typecode_or_type, *args)

从共享内存中申请并返回一个 ctypes 对象。

typecode_or_type 指明了返回的对象类型: 它可能是一个 ctypes 类型或者 array  模块中每个类型对应的单字符长度的字符串。 *args 会透传给这个类的构造函数。

注意对 value 的访问、赋值操作可能是非原子操作 - 使用 Value() ，从而借助其中的锁保证操作的原子性。

请注意 ctypes.c_char 的数组具有 value 和 raw 属性，允许被用来保存和提取字符串 - 请查看 ctypes 文档。

multiprocessing.sharedctypes.Array(typecode_or_type, size_or_initializer, *, lock=True)

返回一个纯 ctypes 数组, 或者在此之上经过同步器包装过的进程安全的对象，这取决于 lock 参数的值，除此之外，和 RawArray() 一样。

如果 lock 为 True (默认值) 则将创建一个新的锁对象用于同步对值的访问。 如果 lock 为一个 Lock 或 RLock 对象则该对象将被用于同步对值的访问。 如果 lock 为 False 则对所返回对象的访问将不会自动得到锁的保护，也就是说它将不是“进程安全的”。

注意 lock 只能是命名参数。

multiprocessing.sharedctypes.Value(typecode_or_type, *args, lock=True)

返回一个纯 ctypes 数组, 或者在此之上经过同步器包装过的进程安全的对象，这取决于 lock 参数的值，除此之外，和 RawArray() 一样。

如果 lock 为 True (默认值) 则将创建一个新的锁对象用于同步对值的访问。 如果 lock 为一个 Lock 或 RLock 对象则该对象将被用于同步对值的访问。 如果 lock 为 False 则对所返回对象的访问将不会自动得到锁的保护，也就是说它将不是“进程安全的”。

注意 lock 只能是命名参数。

multiprocessing.sharedctypes.copy(obj)

从共享内存中申请一片空间将 ctypes 对象 obj 过来，然后返回一个新的 ctypes 对象。

multiprocessing.sharedctypes.synchronized(obj[, lock])

将一个 ctypes 对象包装为进程安全的对象并返回，使用 lock 同步对于它的操作。如果 lock 是 None (默认值) ，则会自动创建一个 multiprocessing.RLock 对象。

同步器包装后的对象会在原有对象基础上额外增加两个方法: get_obj() 返回被包装的对象， get_lock() 返回内部用于同步的锁。

需要注意的是，访问包装后的ctypes对象会比直接访问原来的纯 ctypes 对象慢得多。

在 3.5 版更改: 同步器包装后的对象支持 context manager 协议。

下面的表格对比了创建普通ctypes对象和基于共享内存上创建共享ctypes对象的语法。（表格中的 MyStruct 是 ctypes.Structure 的子类）

ctypes | 使用类型的共享ctypes | 使用 typecode 的共享 ctypes
c_double(2.4) | RawValue(c_double, 2.4) | RawValue('d', 2.4)
MyStruct(4, 6) | RawValue(MyStruct, 4, 6) |
(c_short * 7)() | RawArray(c_short, 7) | RawArray('h', 7)
(c_int * 3)(9, 2, 8) | RawArray(c_int, (9, 2, 8)) | RawArray('i', (9, 2, 8))

下面是一个在子进程中修改多个ctypes对象的例子。

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])

输出如下

49
0.1111111111111111
HELLO WORLD
[(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)]

管理器

管理器提供了一种创建共享数据的方法，从而可以在不同进程中共享，甚至可以通过网络跨机器共享数据。管理器维护一个用于管理 共享对象 的服务。其他进程可以通过代理访问这些共享对象。

multiprocessing.Manager()

返回一个已启动的 SyncManager 管理器对象，这个对象可以用于在不同进程中共享数据。返回的管理器对象对应了一个已经启动的子进程，并且拥有一系列方法可以用于创建共享对象、返回对应的代理。

当管理器被垃圾回收或者父进程退出时，管理器进程会立即退出。管理器类定义在 multiprocessing.managers 模块:

class multiprocessing.managers.BaseManager([address[, authkey]])

创建一个 BaseManager 对象。

一旦创建，应该及时调用 start() 或者 get_server().serve_forever() 以确保管理器对象对应的管理进程已经启动。

address 是管理器服务进程监听的地址。如果 address 是 None ,则允许和任意主机的请求建立连接。

authkey 是认证标识，用于检查连接服务进程的请求合法性。如果 authkey 是 None, 则会使用 current_process().authkey , 否则，就使用 authkey , 需要保证它必须是 byte 类型的字符串。

start([initializer[, initargs]])

为管理器开启一个子进程，如果 initializer 不是 None , 子进程在启动时将会调用 initializer(*initargs) 。

get_server()

返回一个 Server  对象，它是管理器在后台控制的真实的服务。 Server  对象拥有 serve_forever() 方法。

>>> from multiprocessing.managers import BaseManager
>>> manager = BaseManager(address=('', 50000), authkey=b'abc')
>>> server = manager.get_server()
>>> server.serve_forever()

Server 额外拥有一个 address 属性。

connect()

将本地管理器对象连接到一个远程管理器进程:

>>> from multiprocessing.managers import BaseManager
>>> m = BaseManager(address=('127.0.0.1', 50000), authkey=b'abc')
>>> m.connect()

shutdown()

停止管理器的进程。这个方法只能用于已经使用 start() 启动的服务进程。

它可以被多次调用。

register(typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]])

一个 classmethod，可以将一个类型或者可调用对象注册到管理器类。

typeid 是一种 "类型标识符"，用于唯一表示某种共享对象类型，必须是一个字符串。

callable 是一个用来为此类型标识符创建对象的可调用对象。如果一个管理器实例将使用 connect() 方法连接到服务器，或者 create_method 参数为 False，那么这里可留下 None。

proxytype 是 BaseProxy  的子类，可以根据 typeid 为共享对象创建一个代理，如果是 None , 则会自动创建一个代理类。

exposed 是一个函数名组成的序列，用来指明只有这些方法可以使用 BaseProxy._callmethod() 代理。(如果 exposed 是 None, 则会在 proxytype._exposed_ 存在的情况下转而使用它) 当暴露的方法列表没有指定的时候，共享对象的所有 “公共方法” 都会被代理。（这里的“公共方法”是指所有拥有 __call__() 方法并且不是以 '_' 开头的属性）

method_to_typeid 是一个映射，用来指定那些应该返回代理对象的暴露方法所返回的类型。（如果 method_to_typeid 是 None, 则 proxytype._method_to_typeid_ 会在存在的情况下被使用）如果方法名称不在这个映射中或者映射是 None ,则方法返回的对象会是一个值拷贝。

create_method 指明，是否要创建一个以 typeid 命名并返回一个代理对象的方法，这个函数会被服务进程用于创建共享对象，默认为 True 。

BaseManager 实例也有一个只读属性。

address

管理器所用的地址。

在 3.3 版更改: 管理器对象支持上下文管理协议 - 查看 上下文管理器类型 。__enter__() 启动服务进程（如果它还没有启动）并且返回管理器对象， __exit__() 会调用 shutdown() 。

在之前的版本中，如果管理器服务进程没有启动， __enter__() 不会负责启动它。

class multiprocessing.managers.SyncManager

BaseManager 的子类，可用于进程的同步。这个类型的对象使用 multiprocessing.Manager() 创建。

它拥有一系列方法，可以为大部分常用数据类型创建并返回 代理对象 代理，用于进程间同步。甚至包括共享列表和字典。

Barrier(parties[, action[, timeout]])

创建一个共享的 threading.Barrier 对象并返回它的代理。

3.3 新版功能.

BoundedSemaphore([value])

创建一个共享的 threading.BoundedSemaphore 对象并返回它的代理。

Condition([lock])

创建一个共享的 threading.Condition 对象并返回它的代理。

如果提供了 lock 参数，那它必须是 threading.Lock 或 threading.RLock 的代理对象。

在 3.3 版更改: 新增了 wait_for()  方法。

Event()

创建一个共享的 threading.Event 对象并返回它的代理。

Lock()

创建一个共享的 threading.Lock 对象并返回它的代理。

Namespace()

创建一个共享的 Namespace 对象并返回它的代理。

Queue([maxsize])

创建一个共享的 queue.Queue 对象并返回它的代理。

RLock()

创建一个共享的 threading.RLock 对象并返回它的代理。

Semaphore([value])

创建一个共享的 threading.Semaphore 对象并返回它的代理。

Array(typecode, sequence)

创建一个数组并返回它的代理。

Value(typecode, value)

创建一个具有可写 value 属性的对象并返回它的代理。

dict()

dict(mapping)

dict(sequence)

创建一个共享的 dict 对象并返回它的代理。

list()

list(sequence)

创建一个共享的 list 对象并返回它的代理。

在 3.6 版更改: 共享对象能够嵌套。例如, 共享的容器对象如共享列表，可以包含另一个共享对象，他们全都会在 SyncManager 中进行管理和同步。

class multiprocessing.managers.Namespace

一个可以注册到 SyncManager 的类型。

命名空间对象没有公共方法，但是拥有可写的属性。直接print会显示所有属性的值。

值得一提的是，当对命名空间对象使用代理的时候，访问所有名称以 '_' 开头的属性都只是代理器上的属性，而不是命名空间对象的属性。

>>> manager = multiprocessing.Manager()
>>> Global = manager.Namespace()
>>> Global.x = 10
>>> Global.y = 'hello'
>>> Global._z = 12.3    # this is an attribute of the proxy
>>> print(Global)
Namespace(x=10, y='hello')

自定义管理器

要创建一个自定义的管理器，需要新建一个 BaseManager 的子类，然后使用这个管理器类上的 register() 类方法将新类型或者可调用方法注册上去。例如:

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))         # prints 7
        print(maths.mul(7, 8))         # prints 56

使用远程管理器

可以将管理器服务运行在一台机器上，然后使用客户端从其他机器上访问。(假设它们的防火墙允许)

运行下面的代码可以启动一个服务，此付包含了一个共享队列，允许远程客户端访问:

>>> 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=('', 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()

远程客户端可以通过下面的方式访问服务:

>>> 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')

也可以通过下面的方式:

>>> 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'

本地进程也可以访问这个队列，利用上面的客户端代码通过远程方式访问:

>>> 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=('', 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()

代理对象

代理是一个 指向 其他共享对象的对象，这个对象(很可能)在另外一个进程中。共享对象也可以说是代理 指涉 的对象。多个代理对象可能指向同一个指涉对象。

代理对象代理了指涉对象的一系列方法调用(虽然并不是指涉对象的每个方法都有必要被代理)。通过这种方式，代理的使用方法可以和它的指涉对象一样:

>>> from multiprocessing import Manager
>>> manager = 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]

注意，对代理使用 str() 函数会返回指涉对象的字符串表示，但是 repr() 却会返回代理本身的内部字符串表示。

被代理的对象很重要的一点是必须可以被序列化，这样才能允许他们在进程间传递。因此，指涉对象可以包含 代理对象 。这允许管理器中列表、字典或者其他 代理对象 对象之间的嵌套。

>>> a = manager.list()
>>> b = manager.list()
>>> a.append(b)         # referent of a now contains referent of b
>>> print(a, b)
[<ListProxy object, typeid 'list' at ...>] []
>>> b.append('hello')
>>> print(a[0], b)
['hello'] ['hello']

类似地，字典和列表代理也可以相互嵌套:

>>> 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}

如果指涉对象包含了普通 list 或 dict 对象，对这些内部可变对象的修改不会通过管理器传播，因为代理无法得知被包含的值什么时候被修改了。但是把存放在容器代理中的值本身是会通过管理器传播的（会触发代理对象中的 __setitem__ ）从而有效修改这些对象，所以可以把修改过的值重新赋值给容器代理:

# create a list proxy and append a mutable object (a dictionary)
lproxy = manager.list()
lproxy.append({})
# now mutate the dictionary
d = lproxy[0]
d['a'] = 1
d['b'] = 2
# at this point, the changes to d are not yet synced, but by
# updating the dictionary, the proxy is notified of the change
lproxy[0] = d

在大多是使用情形下，这种实现方式并不比嵌套 代理对象 方便，但是依然演示了对于同步的一种控制级别。

注解

multiprocessing 中的代理类并没有提供任何对于代理值比较的支持。所以，我们会得到如下结果:

>>> manager.list([1,2,3]) == [1,2,3]
False

当需要比较值的时候，应该替换为使用指涉对象的拷贝。

class multiprocessing.managers.BaseProxy

代理对象是 BaseProxy 派生类的实例。

_callmethod(methodname[, args[, kwds]])

调用指涉对象的方法并返回结果。

如果 proxy 是一个代理且其指涉的是 obj , 那么下面的表达式:

proxy._callmethod(methodname, args, kwds)

相当于求取以下表达式的值:

getattr(obj, methodname)(*args, **kwds)

于管理器进程。

返回结果会是一个值拷贝或者一个新的共享对象的代理 - 见函数 BaseManager.register() 中关于参数 method_to_typeid 的文档。

如果这个调用熬出了异常，则这个异常会被 _callmethod() 透传出来。如果是管理器进程本身抛出的一些其他异常，则会被 _callmethod() 转换为 RemoteError 异常重新抛出。

特别注意，如果 methodname 没有 暴露 出来，将会引发一个异常。

_callmethod() 的一个使用示例:

>>> l = manager.list(range(10))
>>> l._callmethod('__len__')
10
>>> l._callmethod('__getitem__', (slice(2, 7),)) # equivalent to l[2:7]
[2, 3, 4, 5, 6]
>>> l._callmethod('__getitem__', (20,))          # equivalent to l[20]
Traceback (most recent call last):
...
IndexError: list index out of range

_getvalue()

返回指涉对象的一份拷贝。

如果指涉对象无法序列化，则会抛出一个异常。

__repr__()

返回代理对象的内部字符串表示。

__str__()

返回指涉对象的内部字符串表示。

清理

代理对象使用了一个弱引用回调函数，当它被垃圾回收时，会将自己从拥有此指涉对象的管理器上反注册，

当共享对象没有被任何代理器引用时，会被管理器进程删除。

进程池

可以创建一个进程池，它将使用 Pool 类执行提交给它的任务。

class multiprocessing.pool.Pool([processes[, initializer[, initargs[, maxtasksperchild[, context]]]]])

一个进程池对象，它控制可以提交作业的工作进程池。它支持带有超时和回调的异步结果，以及一个并行的 map 实现。

processes 是要使用的工作进程数目。如果 processes 为 None，则使用 os.cpu_count() 返回的值。

如果 initializer 不为 None，则每个工作进程将会在启动时调用 initializer(*initargs)。

maxtasksperchild 是一个工作进程在它退出或被一个新的工作进程代替之前能完成的任务数量，为了释放未使用的资源。默认的 maxtasksperchild 是 None，意味着工作进程寿与池齐。

context 可被用于指定启动的工作进程的上下文。通常一个进程池是使用函数 multiprocessing.Pool() 或者一个上下文对象的 Pool() 方法创建的。在这两种情况下， context 都是适当设置的。

注意，进程池对象的方法只有创建它的进程能够调用。

警告

multiprocessing.pool 对象具有需要正确管理的内部资源 （像任何其他资源一样），具体方式是将进程池用作上下文管理器，或者手动调用 close() 和 terminate()。 未做此类操作将导致进程在终结阶段挂起。

请注意依赖垃圾回收器来销毁进程池是 不正确的 做法，因为 CPython 并不保证进程池终结器会被调用（请参阅 object.__del__() 来了解详情）。

3.2 新版功能: maxtasksperchild

3.4 新版功能: context

注解

通常来说，Pool 中的 Worker 进程的生命周期和进程池的工作队列一样长。一些其他系统中（如 Apache, mod_wsgi 等）也可以发现另一种模式，他们会让工作进程在完成一些任务后退出，清理、释放资源，然后启动一个新的进程代替旧的工作进程。 Pool 的 maxtasksperchild 参数给用户提供了这种能力。

apply(func[, args[, kwds]])

使用 args 参数以及 kwds 命名参数调用 func , 它会返回结果前阻塞。这种情况下，apply_async() 更适合并行化工作。另外 func 只会在一个进程池中的一个工作进程中执行。

apply_async(func[, args[, kwds[, callback[, error_callback]]]])

apply() 方法的一个变种，返回一个 AsyncResult 对象。

如果指定了 callback , 它必须是一个接受单个参数的可调用对象。当执行成功时， callback 会被用于处理执行后的返回结果，否则，调用 error_callback 。

如果指定了 error_callback , 它必须是一个接受单个参数的可调用对象。当目标函数执行失败时， 会将抛出的异常对象作为参数传递给 error_callback 执行。

回调函数应该立即执行完成，否则会阻塞负责处理结果的线程。

map(func, iterable[, chunksize])

内置 map() 函数的并行版本 (但它只支持一个 iterable 参数，对于多个可迭代对象请参阅 starmap())。 它会保持阻塞直到获得结果。

这个方法会将可迭代对象分割为许多块，然后提交给进程池。 可以将 chunksize 设置为一个正整数来指定每个块的（近似）大小。

注意对于很长的迭代对象，可能消耗很多内存。可以考虑使用 imap() 或 imap_unordered() 并且显式指定 chunksize 以提升效率。

map_async(func, iterable[, chunksize[, callback[, error_callback]]])

map() 方法的一个变种，返回一个 AsyncResult 对象。

如果指定了 callback , 它必须是一个接受单个参数的可调用对象。当执行成功时， callback 会被用于处理执行后的返回结果，否则，调用 error_callback 。

如果指定了 error_callback , 它必须是一个接受单个参数的可调用对象。当目标函数执行失败时， 会将抛出的异常对象作为参数传递给 error_callback 执行。

回调函数应该立即执行完成，否则会阻塞负责处理结果的线程。

imap(func, iterable[, chunksize])

map() 的延迟执行版本。

chunksize 参数的作用和 map() 方法的一样。对于很长的迭代器，给 chunksize 设置一个很大的值会比默认值 1 极大 地加快执行速度。

同样，如果 chunksize 是 1 , 那么 imap() 方法所返回的迭代器的 next() 方法拥有一个可选的 timeout 参数： 如果无法在 timeout 秒内执行得到结果，则 next(timeout) 会抛出 multiprocessing.TimeoutError 异常。

imap_unordered(func, iterable[, chunksize])

和 imap() 相同，只不过通过迭代器返回的结果是任意的。（当进程池中只有一个工作进程的时候，返回结果的顺序才能认为是"有序"的）

starmap(func, iterable[, chunksize])

和 map() 类似，不过 iterable 中的每一项会被解包再作为函数参数。

比如可迭代对象 [(1,2), (3, 4)] 会转化为等价于 [func(1,2), func(3,4)] 的调用。

3.3 新版功能.

starmap_async(func, iterable[, chunksize[, callback[, error_callback]]])

相当于 starmap() 与 map_async() 的结合，迭代 iterable 的每一项，解包作为 func 的参数并执行，返回用于获取结果的对象。

3.3 新版功能.

close()

阻止后续任务提交到进程池，当所有任务执行完成后，工作进程会退出。

terminate()

不必等待未完成的任务，立即停止工作进程。当进程池对象被垃圾回收时，会立即调用 terminate()。

join()

等待工作进程结束。调用 join() 前必须先调用 close() 或者 terminate() 。

3.3 新版功能: 进程池对象现在支持上下文管理器协议 - 参见 上下文管理器类型 。__enter__() 返回进程池对象, __exit__() 会调用 terminate() 。

class multiprocessing.pool.AsyncResult

Pool.apply_async() 和 Pool.map_async() 返回对象所属的类。

get([timeout])

用于获取执行结果。如果 timeout 不是 None 并且在 timeout 秒内仍然没有执行完得到结果，则抛出 multiprocessing.TimeoutError 异常。如果远程调用发生异常，这个异常会通过 get() 重新抛出。

wait([timeout])

阻塞，直到返回结果，或者 timeout 秒后超时。

ready()

返回执行状态，是否已经完成。

successful()

判断调用是否已经完成并且未引发异常。 如果还未获得结果则将引发 ValueError。

在 3.7 版更改: 如果没有执行完，会抛出 ValueError  异常而不是 AssertionError 。

下面的例子演示了进程池的用法:

from multiprocessing import Pool
import time

def f(x):
    return x*x

if __name__ == '__main__':
    with Pool(processes=4) as pool:         # start 4 worker processes
        result = pool.apply_async(f, (10,)) # evaluate "f(10)" asynchronously in a single process
        print(result.get(timeout=1))        # prints "100" unless your computer is *very* slow

        print(pool.map(f, range(10)))       # prints "[0, 1, 4,..., 81]"

        it = pool.imap(f, range(10))
        print(next(it))                     # prints "0"
        print(next(it))                     # prints "1"
        print(it.next(timeout=1))           # prints "4" unless your computer is *very* slow

        result = pool.apply_async(time.sleep, (10,))
        print(result.get(timeout=1))        # raises multiprocessing.TimeoutError

监听器及客户端

通常情况下，进程间通过队列或者 Pipe() 返回的 Connection 传递消息。

不过，multiprocessing.connection 模块其实提供了一些更灵活的特性。最基础的用法是通过它抽象出来的高级API来操作socket或者Windows命名管道。也提供一些高级用法，如通过 hmac 模块来支持 摘要认证，以及同时监听多个管道连接。

multiprocessing.connection.deliver_challenge(connection, authkey)

发送一个随机生成的消息到另一端，并等待回复。

如果收到的回复与使用 authkey 作为键生成的信息摘要匹配成功，就会发送一个欢迎信息给管道另一端。否则抛出 AuthenticationError 异常。

multiprocessing.connection.answer_challenge(connection, authkey)

接收一条信息，使用 authkey 作为键计算信息摘要，然后将摘要发送回去。

如果没有收到欢迎消息，就抛出 AuthenticationError 异常。

multiprocessing.connection.Client(address[, family[, authkey]])

尝试使用 address 地址上的监听器建立一个连接，返回 Connection 。

连接的类型取决于 family 参数，但是通常可以省略，因为可以通过 address 的格式推导出来。(查看 地址格式 )

如果提供了 authkey 参数并且不是 None，那它必须是一个字符串并且会被当做基于 HMAC 认证的密钥。如果 authkey 是None 则不会有认证行为。认证失败抛出 AuthenticationError 异常，请查看 See 认证密码 。

class multiprocessing.connection.Listener([address[, family[, backlog[, authkey]]]])

可以监听连接请求，是对于绑定套接字或者 Windows 命名管道的封装。

address 是监听器对象中的绑定套接字或命名管道使用的地址。

注解

如果使用 '0.0.0.0' 作为监听地址，那么在Windows上这个地址无法建立连接。想要建立一个可连接的端点，应该使用 '127.0.0.1' 。

family 是套接字(或者命名管道)使用的类型。它可以是以下一种: 'AF_INET' ( TCP 套接字类型), 'AF_UNIX' ( Unix 域套接字) 或者 'AF_PIPE' ( Windows 命名管道)。其中只有第一个保证各平台可用。如果 family 是 None ,那么 family 会根据 address 的格式自动推导出来。如果 address 也是 None , 则取默认值。默认值为可用类型中速度最快的。见 地址格式 。注意，如果 family 是 'AF_UNIX' 而address是 None ,套接字会在一个 tempfile.mkstemp() 创建的私有临时目录中创建。

如果监听器对象使用了套接字，backlog (默认值为1) 会在套接字绑定后传递给它的 listen() 方法。

如果提供了 authkey 参数并且不是 None，那它必须是一个字符串并且会被当做基于 HMAC 认证的密钥。如果 authkey 是None 则不会有认证行为。认证失败抛出 AuthenticationError 异常，请查看 See 认证密码 。

accept()

接受一个连接并返回一个 Connection 对象，其连接到的监听器对象已绑定套接字或者命名管道。如果已经尝试过认证并且失败了，则会抛出 AuthenticationError 异常。

close()

关闭监听器对象上的绑定套接字或者命名管道。此函数会在监听器被垃圾回收后自动调用。不过仍然建议显式调用函数关闭。

监听器对象拥有下列只读属性:

address

监听器对象使用的地址。

last_accepted

最后一个连接所使用的地址。如果没有的话就是 None 。

3.3 新版功能: 监听器对象现在支持了上下文管理协议 - 见 上下文管理器类型 。 __enter__() 返回一个监听器对象, __exit__() 会调用 close() 。

multiprocessing.connection.wait(object_list, timeout=None)

一直等待直到 object_list 中某个对象处于就绪状态。返回 object_list 中处于就绪状态的对象。如果 timeout 是一个浮点型，该方法会最多阻塞这么多秒。如果 timeout 是 None ，则会允许阻塞的事件没有限制。timeout为负数的情况下和为0的情况相同。

对于 Unix 和 Windows ，满足下列条件的对象可以出现在 object_list 中

可读的 Connection 对象；

一个已连接并且可读的 socket.socket 对象；或者

Process 对象中的 sentinel 属性。

当一个连接或者套接字对象拥有有效的数据可被读取的时候，或者另一端关闭后，这个对象就处于就绪状态。

Unix: wait(object_list, timeout) 和 select.select(object_list, [], [], timeout) 几乎相同。差别在于，如果 select.select() 被信号中断，它会抛出一个附带错误号为 EINTR 的 OSError 异常，而 wait() 不会。

Windows: object_list 中的元素必须是一个表示为整数的可等待的句柄(按照 Win32 函数 WaitForMultipleObjects() 的文档中所定义) 或者一个拥有 fileno() 方法的对象，这个对象返回一个套接字句柄或者管道句柄。（注意管道和套接字两种句柄 不是 可等待的句柄）

3.3 新版功能.

示例

下面的服务代码创建了一个使用 'secret password' 作为认证密码的监听器。它会等待连接然后发送一些数据给客户端:

from multiprocessing.connection import Listener
from array import array

address = ('localhost', 6000)     # family is deduced to be '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]))

下面的代码连接到服务然后从服务器上j接收一些数据:

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])

下面的代码使用了 wait() ，以便在同时等待多个进程发来消息。

import time, random
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()
        # We close the writable end of the pipe now to be sure that
        # p is the only process which owns a handle for it.  This
        # ensures that when p closes its handle for the writable end,
        # wait() will promptly report the readable end as being ready.
        w.close()

    while readers:
        for r in wait(readers):
            try:
                msg = r.recv()
            except EOFError:
                readers.remove(r)
            else:
                print(msg)

地址格式

'AF_INET' 地址是 (hostname, port) 形式的元组类型，其中 hostname 是一个字符串，port 是整数。

'AF_UNIX' 地址是文件系统上文件名的字符串。

'AF_PIPE' 地址是一个 r'\\.\pipe\PipeName' 形式的字符串。 要使用 Client() 来连接到远程计算机上一个名为 ServerName 的命名管道则应当改用 r'\\ServerName\pipe\PipeName' 形式的地址。

注意，使用两个反斜线开头的字符串默认被当做 'AF_PIPE' 地址而不是 'AF_UNIX' 地址。

认证密码

当使用 Connection.recv 接收数据时，数据会自动被反序列化。不幸的是，对于一个不可信的数据源发来的数据，反序列化是存在安全风险的。所以 Listener 和 Client() 之间使用 hmac 模块进行摘要认证。

认证密钥是一个 byte 类型的字符串，可以认为是和密码一样的东西，连接建立好后，双方都会要求另一方证明知道认证密钥。（这个证明过程不会通过连接发送密钥）

如果要求认证但是没有指定认证密钥，则会使用 current_process().authkey 的返回值 (参见 Process)。 这个值将被当前进程所创建的任何 Process 对象自动继承。 这意味着 (在默认情况下) 一个包含多进程的程序中的所有进程会在相互间建立连接的时候共享单个认证密钥。

os.urandom() 也可以用来生成合适的认证密钥。

日志记录

当前模块也提供了一些对 logging 的支持。注意， logging 模块本身并没有使用进程间共享的锁，所以来自于多个进程的日志可能（具体取决于使用的日志 handler 类型）相互覆盖或者混杂。

multiprocessing.get_logger()

返回 multiprocessing 使用的 logger，必要的话会创建一个新的。

如果创建的首个 logger 日志级别为 logging.NOTSET 并且没有默认 handler。通过这个 logger 打印的消息不会传递到根 logger。

注意在 Windows 上，子进程只会继承父进程 logger 的日志级别 - 对于logger的其他自定义项不会继承。

multiprocessing.log_to_stderr(level=None)

此函数会调用 get_logger() 但是会在返回的 logger 上增加一个 handler，将所有输出都使用 '[%(levelname)s/%(processName)s] %(message)s' 的格式发送到 sys.stderr 。你可以通过传递一个 level 参数来修改记录器的 levelname 。

下面是一个在交互式解释器中打开日志功能的例子:

>>> 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

要查看日志等级的完整列表，见 logging 模块。

multiprocessing.dummy 模块

multiprocessing.dummy 复制了 multiprocessing 的 API，不过是在 threading 模块之上包装了一层。

特别地，multiprocessing.dummy 所提供的 Pool 函数会返回一个 ThreadPool 的实例，该类是 Pool 的子类，它支持所有相同的方法调用但会使用一个工作线程池而非工作进程池。

class multiprocessing.pool.ThreadPool([processes[, initializer[, initargs]]])

一个线程池对象，用来控制可向其提交任务的工作线程池。 ThreadPool 实例与 Pool 实例是完全接口兼容的，并且它们的资源也必须被正确地管理，或者是将线程池作为上下文管理器来使用，或者是通过手动调用 close() 和 terminate()。

processes 是要使用的工作线程数目。 如果 processes 为 None，则使用 os.cpu_count() 返回的值。

如果 initializer 不为 None，则每个工作进程将会在启动时调用 initializer(*initargs)。

不同于 Pool，maxtasksperchild 和 context 不可被提供。

注解

ThreadPool 具有与 Pool 相同的接口，它围绕一个进程池进行设计并且先于 concurrent.futures 模块的引入。 因此，它继承了一些对于基于线程的池来说没有意义的操作，并且它具有自己的用于表示异步任务状态的类型 AsyncResult，该类型不为任何其他库所知。

用户通常应该倾向于使用 concurrent.futures.ThreadPoolExecutor，它拥有从一开始就围绕线程进行设计的更简单接口，并且返回与许多其他库相兼容的 concurrent.futures.Future 实例，包括 asyncio 库。

编程指导

使用 multiprocessing 时，应遵循一些指导原则和习惯用法。

所有start方法

下面这些适用于所有start方法。

避免共享状态

应该尽可能避免在进程间传递大量数据，越少越好。

最好坚持使用队列或者管道进行进程间通信，而不是底层的同步原语。

可序列化

保证所代理的方法的参数是可以序列化的。

代理的线程安全性

不要在多线程中同时使用一个代理对象，除非你用锁保护它。

（而在不同进程中使用 相同 的代理对象却没有问题。）

使用 Join 避免僵尸进程

在 Unix 上，如果一个进程执行完成但是没有被 join，就会变成僵尸进程。一般来说，僵尸进程不会很多，因为每次新启动进程（或者 active_children() 被调用）时，所有已执行完成且没有被 join 的进程都会自动被 join，而且对一个执行完的进程调用 Process.is_alive 也会 join 这个进程。尽管如此，对自己启动的进程显式调用 join 依然是最佳实践。

继承优于序列化、反序列化

当使用 spawn 或者 forkserver 的启动方式时，multiprocessing 中的许多类型都必须是可序列化的，这样子进程才能使用它们。但是通常我们都应该避免使用管道和队列发送共享对象到另外一个进程，而是重新组织代码，对于其他进程创建出来的共享对象，让那些需要访问这些对象的子进程可以直接将这些对象从父进程继承过来。

避免杀死进程

通过 Process.terminate 停止一个进程很容易导致这个进程正在使用的共享资源（如锁、信号量、管道和队列）损坏或者变得不可用，无法在其他进程中继续使用。

所以，最好只对那些从来不使用共享资源的进程调用 Process.terminate 。

Join 使用队列的进程

记住，往队列放入数据的进程会一直等待直到队列中所有项被"feeder" 线程传给底层管道。（子进程可以调用队列的 Queue.cancel_join_thread 方法禁止这种行为）

这意味着，任何使用队列的时候，你都要确保在进程join之前，所有存放到队列中的项将会被其他进程、线程完全消费。否则不能保证这个写过队列的进程可以正常终止。记住非精灵进程会自动 join 。

下面是一个会导致死锁的例子:

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()                    # this deadlocks
    obj = queue.get()

交换最后两行可以修复这个问题（或者直接删掉 p.join()）。

显式传递资源给子进程

在Unix上，使用 fork 方式启动的子进程可以使用父进程中全局创建的共享资源。不过，最好是显式将资源对象通过参数的形式传递给子进程。

除了（部分原因）让代码兼容 Windows 以及其他的进程启动方式外，这种形式还保证了在子进程生命期这个对象是不会被父进程垃圾回收的。如果父进程中的某些对象被垃圾回收会导致资源释放，这就变得很重要。

所以对于实例：

from multiprocessing import Process, Lock

def f():
    ... do something using "lock" ...

if __name__ == '__main__':
    lock = Lock()
    for i in range(10):
        Process(target=f).start()

应当重写成这样：

from multiprocessing import Process, Lock

def f(l):
    ... do something using "l" ...

if __name__ == '__main__':
    lock = Lock()
    for i in range(10):
        Process(target=f, args=(lock,)).start()

谨防将 sys.stdin 数据替换为 “类似文件的对象”

multiprocessing 原本会无条件地这样调用:

os.close(sys.stdin.fileno())

在 multiprocessing.Process._bootstrap()  方法中 —— 这会导致与"进程中的进程"相关的一些问题。这已经被修改成了:

sys.stdin.close()
sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False)

它解决了进程相互冲突导致文件描述符错误的根本问题，但是对使用带缓冲的“文件型对象”替换 sys.stdin() 作为输出的应用程序造成了潜在的危险。如果多个进程调用了此文件型对象的 close() 方法，会导致相同的数据多次刷写到此对象，损坏数据。

如果你写入文件型对象并实现了自己的缓存，可以在每次追加缓存数据时记录当前进程id，从而将其变成 fork 安全的，当发现进程id变化后舍弃之前的缓存，例如:

@property
def cache(self):
    pid = os.getpid()
    if pid != self._pid:
        self._pid = pid
        self._cache = []
    return self._cache

需要更多信息，请查看 bpo-5155 [https://bugs.python.org/issue?@action=redirect&bpo=5155], bpo-5313 [https://bugs.python.org/issue?@action=redirect&bpo=5313] 以及 bpo-5331 [https://bugs.python.org/issue?@action=redirect&bpo=5331]

spawn 和 forkserver 启动方式

相对于 fork 启动方式，有一些额外的限制。

更依赖序列化

Process.__init__() 的所有参数都必须可序列化。同样的，当你继承 Process 时，需要保证当调用 Process.start 方法时，实例可以被序列化。

全局变量

记住，如果子进程中的代码尝试访问一个全局变量，它所看到的值（如果有）可能和父进程中执行 Process.start 那一刻的值不一样。

当全局变量只是模块级别的常量时，是不会有问题的。

安全导入主模块

确保主模块可以被新启动的Python解释器安全导入而不会引发什么副作用（比如又启动了一个子进程）

例如，使用 spawn 或 forkserver 启动方式执行下面的模块，会引发 RuntimeError 异常而失败。

from multiprocessing import Process

def foo():
    print('hello')

p = Process(target=foo)
p.start()

应该通过下面的方法使用 if __name__ == '__main__': ，从而保护程序"入口点":

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()

（如果程序将正常运行而不是冻结，则可以省略 freeze_support() 行）

这允许新启动的 Python 解释器安全导入模块然后运行模块中的 foo() 函数。

如果主模块中创建了进程池或者管理器，这个规则也适用。

例子

创建和使用自定义管理器、代理的示例:

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()')

# A simple generator function
def baz():
    for i in range(10):
        yield i*i

# Proxy type for generator objects
class GeneratorProxy(BaseProxy):
    _exposed_ = ['__next__']
    def __iter__(self):
        return self
    def __next__(self):
        return self._callmethod('__next__')

# Function to return the operator module
def get_operator_module():
    return operator

##

class MyManager(BaseManager):
    pass

# register the Foo class; make `f()` and `g()` accessible via proxy
MyManager.register('Foo1', Foo)

# register the Foo class; make `g()` and `_h()` accessible via proxy
MyManager.register('Foo2', Foo, exposed=('g', '_h'))

# register the generator function baz; use `GeneratorProxy` to make proxies
MyManager.register('baz', baz, proxytype=GeneratorProxy)

# register get_operator_module(); make public functions accessible via proxy
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()

使用 Pool:

import multiprocessing
import time
import random
import sys

#
# Functions used by test code
#

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

#
# Test code
#

def test():
    PROCESSES = 4
    print('Creating pool with %d processes\n' % PROCESSES)

    with multiprocessing.Pool(PROCESSES) as pool:
        #
        # Tests
        #

        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()

        #
        # Testing timeouts
        #

        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()

一个演示如何使用队列来向一组工作进程提供任务并收集结果的例子：

import time
import random

from multiprocessing import Process, Queue, current_process, freeze_support

#
# Function run by worker processes
#

def worker(input, output):
    for func, args in iter(input.get, 'STOP'):
        result = calculate(func, args)
        output.put(result)

#
# Function used to calculate result
#

def calculate(func, args):
    result = func(*args)
    return '%s says that %s%s = %s' % \
        (current_process().name, func.__name__, args, result)

#
# Functions referenced by tasks
#

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)]

    # Create queues
    task_queue = Queue()
    done_queue = Queue()

    # Submit tasks
    for task in TASKS1:
        task_queue.put(task)

    # Start worker processes
    for i in range(NUMBER_OF_PROCESSES):
        Process(target=worker, args=(task_queue, done_queue)).start()

    # Get and print results
    print('Unordered results:')
    for i in range(len(TASKS1)):
        print('\t', done_queue.get())

    # Add more tasks using `put()`
    for task in TASKS2:
        task_queue.put(task)

    # Get and print some more results
    for i in range(len(TASKS2)):
        print('\t', done_queue.get())

    # Tell child processes to stop
    for i in range(NUMBER_OF_PROCESSES):
        task_queue.put('STOP')

if __name__ == '__main__':
    freeze_support()
    test()

multiprocessing.shared_memory --- 可跨进程直接访问的共享内存

源代码: Lib/multiprocessing/shared_memory.py [https://github.com/python/cpython/tree/3.10/Lib/multiprocessing/shared_memory.py]

3.8 新版功能.

该模块提供了一个 SharedMemory 类，用于分配和管理多核或对称多处理器（SMP）机器上进程间的共享内存。为了协助管理不同进程间的共享内存生命周期，multiprocessing.managers 模块也提供了一个 BaseManager 的子类： SharedMemoryManager。

本模块中，共享内存是指 "System V 类型" 的共享内存块（虽然可能和它实现方式不完全一致）而不是 “分布式共享内存”。这种类型的的共享内存允许不同进程读写一片公共（或者共享）的易失性存储区域。一般来说，进程被限制只能访问属于自己进程空间的内存，但是共享内存允许跨进程共享数据，从而避免通过进程间发送消息的形式传递数据。相比通过磁盘、套接字或者其他要求序列化、反序列化和复制数据的共享形式，直接通过内存共享数据拥有更出色性能。

class multiprocessing.shared_memory.SharedMemory(name=None, create=False, size=0)

创建一个新的共享内存块或者连接到一片已经存在的共享内存块。每个共享内存块都被指定了一个全局唯一的名称。通过这种方式，进程可以使用一个特定的名字创建共享内存区块，然后其他进程使用同样的名字连接到这个共享内存块。

作为一种跨进程共享数据的方式，共享内存块的寿命可能超过创建它的原始进程。一个共享内存块可能同时被多个进程使用，当一个进程不再需要访问这个共享内存块的时候，应该调用 close() 方法。当一个共享内存块不被任何进程使用的时候，应该调用 unlink() 方法以执行必要的清理。

name 是共享内存的唯一名称，字符串类型。如果创建一个新共享内存块的时候，名称指定为 None (默认值)，将会随机产生一个新名称。

create 指定创建一个新的共享内存块 (True) 还是连接到已存在的共享内存块 (False) 。

如果是新创建共享内存块则 size 用于指定块的大小为多少字节。由于某些平台是以内存页大小为最小单位来分配内存的，最终得到的内存块大小可能大于或等于要求的大小。如果是连接到已经存在的共享内存块， size 参数会被忽略。

close()

关闭实例对于共享内存的访问连接。所有实例确认自己不再需要使用共享内存的时候都应该调用 close() ，以保证必要的资源清理。调用 close() 并不会销毁共享内存区域。

unlink()

请求销毁底层的共享内存块。 为了执行必要的资源清理，在所有使用这个共享内存块的进程中，unlink() 应该调用一次（且只能调用一次）。 发出此销毁请求后，共享内存块可能会、也可能不会立即销毁，且此行为在不同操作系统之间可能不同。 调用 unlink() 后再尝试访问其中的数据可能导致内存错误。 注意：最后一个关闭共享内存访问权限的进程可以以任意顺序调用 unlink() 和 close()。

buf

共享内存块内容的 memoryview 。

name

共享内存块的唯一标识，只读属性。

size

共享内存块的字节大小，只读属性。

以下示例展示了 SharedMemory 底层的用法:

>>> 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])  # Modify multiple at once
>>> buffer[4] = 100                           # Modify single byte at a time
>>> # Attach to an existing shared memory block
>>> shm_b = shared_memory.SharedMemory(shm_a.name)
>>> import array
>>> array.array('b', shm_b.buf[:5])  # Copy the data into a new array.array
array('b', [22, 33, 44, 55, 100])
>>> shm_b.buf[:5] = b'howdy'  # Modify via shm_b using bytes
>>> bytes(shm_a.buf[:5])      # Access via shm_a
b'howdy'
>>> shm_b.close()   # Close each SharedMemory instance
>>> shm_a.close()
>>> shm_a.unlink()  # Call unlink only once to release the shared memory

下面的例子展示了 SharedMemory 类结合 NumPy 数组 [https://numpy.org/] 的实际应用，从两个独立的 Python shell 访问同一个 numpy.ndarray:

>>> # In the first Python interactive shell
>>> import numpy as np
>>> a = np.array([1, 1, 2, 3, 5, 8])  # Start with an existing NumPy array
>>> from multiprocessing import shared_memory
>>> shm = shared_memory.SharedMemory(create=True, size=a.nbytes)
>>> # Now create a NumPy array backed by shared memory
>>> b = np.ndarray(a.shape, dtype=a.dtype, buffer=shm.buf)
>>> b[:] = a[:]  # Copy the original data into shared memory
>>> b
array([1, 1, 2, 3, 5, 8])
>>> type(b)
<class 'numpy.ndarray'>
>>> type(a)
<class 'numpy.ndarray'>
>>> shm.name  # We did not specify a name so one was chosen for us
'psm_21467_46075'

>>> # In either the same shell or a new Python shell on the same machine
>>> import numpy as np
>>> from multiprocessing import shared_memory
>>> # Attach to the existing shared memory block
>>> existing_shm = shared_memory.SharedMemory(name='psm_21467_46075')
>>> # Note that a.shape is (6,) and a.dtype is np.int64 in this example
>>> 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])

>>> # Back in the first Python interactive shell, b reflects this change
>>> b
array([  1,   1,   2,   3,   5, 888])

>>> # Clean up from within the second Python shell
>>> del c  # Unnecessary; merely emphasizing the array is no longer used
>>> existing_shm.close()

>>> # Clean up from within the first Python shell
>>> del b  # Unnecessary; merely emphasizing the array is no longer used
>>> shm.close()
>>> shm.unlink()  # Free and release the shared memory block at the very end

class multiprocessing.managers.SharedMemoryManager([address[, authkey]])

BaseManager 的子类，可用于管理跨进程的共享内存块。

调用 SharedMemoryManager 实例上的 start() 方法会启动一个新进程。这个新进程的唯一目的就是管理所有由它创建的共享内存块的生命周期。想要释放此进程管理的所有共享内存块，可以调用实例的 shutdown() 方法。这会触发执行它管理的所有 SharedMemory 对象的 SharedMemory.unlink() 方法，然后停止这个进程。通过 SharedMemoryManager 创建 SharedMemory 实例，我们可以避免手动跟踪和释放共享内存资源。

这个类提供了创建和返回 SharedMemory 实例的方法，以及以共享内存为基础创建一个列表类对象 (ShareableList) 的方法。

有关继承的可选输入参数 address 和 authkey 以及他们如何用于从进程连接已经存在的 SharedMemoryManager 服务，参见 multiprocessing.managers.BaseManager 。

SharedMemory(size)

使用 size 参数，创建一个新的指定字节大小的 SharedMemory 对象并返回。

ShareableList(sequence)

创建并返回一个新的 ShareableList 对象，通过输入参数 sequence 初始化。

下面的案例展示了 SharedMemoryManager 的基本机制:

>>> from multiprocessing.managers import SharedMemoryManager
>>> smm = SharedMemoryManager()
>>> smm.start()  # Start the process that manages the shared memory blocks
>>> 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()  # Calls unlink() on sl, raw_shm, and another_sl

以下案例展示了 SharedMemoryManager 对象的一种可能更方便的使用方式，通过 with 语句来保证所有共享内存块在使用完后被释放。

>>> with SharedMemoryManager() as smm:
...     sl = smm.ShareableList(range(2000))
...     # Divide the work among two processes, storing partial results in sl
...     p1 = Process(target=do_work, args=(sl, 0, 1000))
...     p2 = Process(target=do_work, args=(sl, 1000, 2000))
...     p1.start()
...     p2.start()  # A multiprocessing.Pool might be more efficient
...     p1.join()
...     p2.join()   # Wait for all work to complete in both processes
...     total_result = sum(sl)  # Consolidate the partial results now in sl

在 with 语句中使用 SharedMemoryManager  对象的时候，使用这个管理器创建的共享内存块会在 with 语句代码块结束后被释放。

class multiprocessing.shared_memory.ShareableList(sequence=None, *, name=None)

提供一个可修改的类 list 对象，其中所有值都存放在共享内存块中。这限制了可被存储在其中的值只能是 int, float, bool, str （每条数据小于10M）, bytes （每条数据小于10M）以及 None 这些内置类型。它另一个显著区别于内置 list 类型的地方在于它的长度无法修改（比如，没有 append, insert 等操作）且不支持通过切片操作动态创建新的 ShareableList  实例。

sequence 会被用来为一个新的 ShareableList 填充值。 设为 None 则会基于唯一的共享内存名称关联到已经存在的 ShareableList。

name 是所请求的共享内存的唯一名称，与 SharedMemory 的定义中所描述的一致。 当关联到现有的 ShareableList 时，则指明其共享内存块的唯一名称并将 sequence 设为 None。

count(value)

返回 value 出现的次数。

index(value)

返回 value 首次出现的位置，如果 value 不存在, 则抛出 ValueError 异常。

format

包含由所有当前存储值所使用的 struct 打包格式的只读属性。

shm

存储了值的 SharedMemory 实例。

下面的例子演示了 ShareableList 实例的基本用法:

>>> 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

下面的例子演示了一个、两个或多个进程如何通过提供下层的共享内存块名称来访问同一个 ShareableList:

>>> 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()

下面的例子显示 ShareableList (以及下层的 SharedMemory) 对象可以在必要时被封存和解封。 请注意，它将仍然为同一个共享对象。 出现这种情况是因为被反序列化的对象具有相同的唯一名称并使用这个相同的名称附加到现有的对象上（如果对象仍然保持存活）:

>>> 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]

>>> deserialized_sl = pickle.loads(pickle.dumps(sl))
>>> list(deserialized_sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

>>> 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]

>>> sl.shm.close()
>>> sl.shm.unlink()

concurrent 包

目前，此包中只有一个模块：

concurrent.futures —— 启动并行任务

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

3.2 新版功能.

源码: Lib/concurrent/futures/thread.py [https://github.com/python/cpython/tree/3.10/Lib/concurrent/futures/thread.py] 和 Lib/concurrent/futures/process.py [https://github.com/python/cpython/tree/3.10/Lib/concurrent/futures/process.py]

concurrent.futures 模块提供异步执行可调用对象高层接口。

异步执行可以由 ThreadPoolExecutor 使用线程或由 ProcessPoolExecutor 使用单独的进程来实现。 两者都是实现抽象类 Executor 定义的接口。

Executor 对象

class concurrent.futures.Executor

抽象类提供异步执行调用方法。要通过它的子类调用，而不是直接调用。

submit(fn, /, *args, **kwargs)

调度可调用对象 fn，以 fn(*args, **kwargs) 方式执行并返回一个代表该可调用对象的执行的 Future 对象。

with ThreadPoolExecutor(max_workers=1) as executor:
    future = executor.submit(pow, 323, 1235)
    print(future.result())

map(func, *iterables, timeout=None, chunksize=1)

类似于 map(func, *iterables) 函数，除了以下两点：

iterables 是立即执行而不是延迟执行的；

func 是异步执行的，对 func 的多个调用可以并发执行。

如果从原始调用到 Executor.map() 经过 timeout 秒后， __next__() 已被调用且返回的结果还不可用，那么已返回的迭代器将触发 concurrent.futures.TimeoutError 。 timeout 可以是整数或浮点数。如果 timeout 没有指定或为 None ，则没有超时限制。

如果 func 调用引发一个异常，当从迭代器中取回它的值时这个异常将被引发。

使用 ProcessPoolExecutor 时，这个方法会将 iterables 分割任务块并作为独立的任务并提交到执行池中。这些块的大概数量可以由 chunksize 指定正整数设置。 对很长的迭代器来说，使用大的 chunksize 值比默认值 1 能显著地提高性能。 chunksize 对 ThreadPoolExecutor 没有效果。

在 3.5 版更改: 加入 chunksize 参数。

shutdown(wait=True, *, cancel_futures=False)

当待执行的 future 对象完成执行后向执行者发送信号，它就会释放正在使用的任何资源。 在关闭后调用 Executor.submit() 和 Executor.map() 将会引发 RuntimeError。

如果 wait 为 True 则此方法只有在所有待执行的 future 对象完成执行且释放已分配的资源后才会返回。 如果 wait 为 False，方法立即返回，所有待执行的 future 对象完成执行后会释放已分配的资源。 不管 wait 的值是什么，整个 Python 程序将等到所有待执行的 future 对象完成执行后才退出。

如果 cancel_futures 为 True，此方法将取消所有执行器还未开始运行的挂起的 Future。无论 cancel_futures 的值是什么，任何已完成或正在运行的 Future 都不会被取消。

如果 cancel_futures 和 wait 均为 True，则执行器已开始运行的所有 Future 将在此方法返回之前完成。 其余的 Future 会被取消。

如果使用 with 语句，你就可以避免显式调用这个方法，它将会停止 Executor (就好像 Executor.shutdown() 调用时 wait 设为 True 一样等待):

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')

在 3.9 版更改: 增加了 cancel_futures。

ThreadPoolExecutor

ThreadPoolExecutor 是 Executor 的子类，它使用线程池来异步执行调用。

当可调用对象已关联了一个 Future 然后在等待另一个 Future 的结果时就会导致死锁情况。例如:

import time
def wait_on_b():
    time.sleep(5)
    print(b.result())  # b will never complete because it is waiting on a.
    return 5

def wait_on_a():
    time.sleep(5)
    print(a.result())  # a will never complete because it is waiting on b.
    return 6

executor = ThreadPoolExecutor(max_workers=2)
a = executor.submit(wait_on_b)
b = executor.submit(wait_on_a)

与:

def wait_on_future():
    f = executor.submit(pow, 5, 2)
    # This will never complete because there is only one worker thread and
    # it is executing this function.
    print(f.result())

executor = ThreadPoolExecutor(max_workers=1)
executor.submit(wait_on_future)

class concurrent.futures.ThreadPoolExecutor(max_workers=None, thread_name_prefix='', initializer=None, initargs=())

Executor 子类使用最多 max_workers 个线程的线程池来异步执行调用。

所有排入 ThreadPoolExecutor 的队列的线程将在解释器退出之前被合并。 请注意执行此操作的 exit 处理器会在任何使用 atexit 添加的 exit处理器 之前 被执行。 这意味着主线程中的异常必须被捕获和处理以便向线程发出信号使其能够优雅地退出。 由于这个原理，建议不要将 ThreadPoolExecutor 用于长期运行的任务。

initializer 是在每个工作者线程开始处调用的一个可选可调用对象。 initargs 是传递给初始化器的元组参数。任何向池提交更多工作的尝试， initializer 都将引发一个异常，当前所有等待的工作都会引发一个 BrokenThreadPool。

在 3.5 版更改: 如果 max_workers 为 None 或没有指定，将默认为机器处理器的个数，假如 ThreadPoolExecutor 侧重于I/O操作而不是CPU运算，那么可以乘以 5 ，同时工作线程的数量可以比 ProcessPoolExecutor 的数量高。

3.6 新版功能: 添加 thread_name_prefix 参数允许用户控制由线程池创建的 threading.Thread 工作线程名称以方便调试。

在 3.7 版更改: 加入 initializer 和*initargs* 参数。

在 3.8 版更改: max_workers 的默认值已改为 min(32, os.cpu_count() + 4)。 这个默认值会保留至少 5 个工作线程用于 I/O 密集型任务。 对于那些释放了 GIL 的 CPU 密集型任务，它最多会使用 32 个 CPU 核心。这样能够避免在多核机器上不知不觉地使用大量资源。

现在 ThreadPoolExecutor 在启动 max_workers 个工作线程之前也会重用空闲的工作线程。

ThreadPoolExecutor 例子

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://nonexistant-subdomain.python.org/']

# Retrieve a single page and report the URL and contents
def load_url(url, timeout):
    with urllib.request.urlopen(url, timeout=timeout) as conn:
        return conn.read()

# We can use a with statement to ensure threads are cleaned up promptly
with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor:
    # Start the load operations and mark each future with its 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)))

ProcessPoolExecutor

ProcessPoolExecutor 类是 Executor 的子类，它使用进程池来异步地执行调用。 ProcessPoolExecutor 会使用 multiprocessing 模块，这允许它绕过 全局解释器锁 但也意味着只可以处理和返回可封存的对象。

__main__ 模块必须可以被工作者子进程导入。这意味着 ProcessPoolExecutor 不可以工作在交互式解释器中。

从可调用对象中调用 Executor 或 Future 的方法提交给 ProcessPoolExecutor 会导致死锁。

class concurrent.futures.ProcessPoolExecutor(max_workers=None, mp_context=None, initializer=None, initargs=())

一个 Executor 子类使用最多由 max_workers 个进程组成的进程池异步执行调用。 如果 max_workers 是 None 或未给出，则默认为机器上的处理器数量。如果 max_workers 小于或等于 0 ，则会引发 ValueError 。在 Windows 系统中，max_workers 必须小于或等于 61 ，否则会引发 ValueError 。如果 max_workers 为 None ，则默认情况下最大为 61 ，即使有更多的处理器可用。mp_context 可以是多进程上下文，也可以是 None。它将用于启动工作者。如果 mp_context 为``None`` 或未给出，则使用默认的多进程上下文。

initializer 是一个可选的可调用对象，它会在每个工作进程启动时被调用；initargs 是传给 initializer 的参数元组。 如果 initializer 引发了异常，则所有当前在等待的任务以及任何向进程池提交更多任务的尝试都将引发 BrokenProcessPool。

在 3.3 版更改: 如果其中一个工作进程被突然终止，BrokenProcessPool 就会马上触发。 可预计的行为没有定义，但执行器上的操作或它的 future 对象会被冻结或死锁。

在 3.7 版更改: 添加 mp_context 参数允许用户控制由进程池创建给工作者进程的开始方法 。

加入 initializer 和*initargs* 参数。

ProcessPoolExecutor 例子

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()

Future 对象

Future 类将可调用对象封装为异步执行。Future 实例由 Executor.submit() 创建。

class concurrent.futures.Future

将可调用对象封装为异步执行。Future 实例由 Executor.submit() 创建，除非测试，不应直接创建。

cancel()

尝试取消调用。 如果调用正在执行或已结束运行不能被取消则该方法将返回 False，否则调用会被取消并且该方法将返回 True。

cancelled()

如果调用成功取消返回 True。

running()

如果调用正在执行而且不能被取消那么返回 True 。

done()

如果调用已被取消或正常结束那么返回 True。

result(timeout=None)

返回调用返回的值。如果调用还没完成那么这个方法将等待 timeout 秒。如果在 timeout 秒内没有执行完成，concurrent.futures.TimeoutError 将会被触发。timeout 可以是整数或浮点数。如果 timeout 没有指定或为 None，那么等待时间就没有限制。

如果 future 在完成前被取消则 CancelledError 将被触发。

如果调用引发了一个异常，这个方法也会引发同样的异常。

exception(timeout=None)

返回由调用引发的异常。如果调用还没完成那么这个方法将等待 timeout 秒。如果在 timeout 秒内没有执行完成，concurrent.futures.TimeoutError 将会被触发。timeout 可以是整数或浮点数。如果 timeout 没有指定或为 None，那么等待时间就没有限制。

如果 future 在完成前被取消则 CancelledError 将被触发。

如果调用正常完成那么返回 None。

add_done_callback(fn)

附加可调用 fn 到 future 对象。当 future 对象被取消或完成运行时，将会调用 fn，而这个 future 对象将作为它唯一的参数。

加入的可调用对象总被属于添加它们的进程中的线程按加入的顺序调用。如果可调用对象引发一个 Exception 子类，它会被记录下来并被忽略掉。如果可调用对象引发一个 BaseException 子类，这个行为没有定义。

如果 future 对象已经完成或已取消，fn 会被立即调用。

下面这些 Future 方法用于单元测试和 Executor 实现。

set_running_or_notify_cancel()

这个方法只可以在执行关联 Future 工作之前由 Executor 实现调用或由单测试调用。

如果此方法返回 False 则 Future 已被取消，即 Future.cancel() 已被调用并返回 True。 任何等待 Future 完成 (即通过 as_completed() 或 wait()) 的线程将被唤醒。

如果此方法返回 True 则 Future 没有被取消并已被置为正在运行的状态，即对 Future.running() 的调用将返回 True。

这个方法只可以被调用一次并且不能在调用 Future.set_result() 或 Future.set_exception() 之后再调用。

set_result(result)

设置将 Future 关联工作的结果给 result 。

这个方法只可以由 Executor 实现和单元测试使用。

在 3.8 版更改: 如果 Future 已经完成则此方法会引发 concurrent.futures.InvalidStateError。

set_exception(exception)

设置 Future 关联工作的结果给 Exception exception 。

这个方法只可以由 Executor 实现和单元测试使用。

在 3.8 版更改: 如果 Future 已经完成则此方法会引发 concurrent.futures.InvalidStateError。

模块函数

concurrent.futures.wait(fs, timeout=None, return_when=ALL_COMPLETED)

等待由 fs 指定的 Future 实例（可能由不同的 Executor 实例创建）完成。 重复传给 fs 的 future 会被移除并将只返回一次。 返回一个由集合组成的具名 2 元组。 第一个集合的名称为 done，包含在等待完成之前已完成的 future（包括正常结束或被取消的 future）。 第二个集合的名称为 not_done，包含未完成的 future（包括挂起的或正在运行的 future）。

timeout 可以用来控制返回前最大的等待秒数。 timeout 可以为 int 或 float 类型。 如果 timeout 未指定或为 None ，则不限制等待时间。

return_when 指定此函数应在何时返回。它必须为以下常数之一:

常量 | 描述
FIRST_COMPLETED | 函数将在任意可等待对象结束或取消时返回。
FIRST_EXCEPTION | 函数将在任意可等待对象因引发异常而结束时返回。当没有引发任何异常时它就相当于 ALL_COMPLETED。
ALL_COMPLETED | 函数将在所有可等待对象结束或取消时返回。

concurrent.futures.as_completed(fs, timeout=None)

返回一个包含 fs 所指定的 Future 实例（可能由不同的 Executor 实例创建）的迭代器，这些实例会在完成时生成 future 对象（包括正常结束或被取消的 future 对象）。 任何由 fs 所指定的重复 future 对象将只被返回一次。 任何在 as_completed() 被调用之前完成的 future 对象将优先被生成。 如果 __next__() 被调用并且在对 as_completed() 的原始调用 timeout 秒之后结果仍不可用，则返回的迭代器将引发 concurrent.futures.TimeoutError。 timeout 可以为整数或浮点数。 如果 timeout 未指定或为 None，则不限制等待时间。

参见

PEP 3148 [https://www.python.org/dev/peps/pep-3148] -- future 对象 - 异步执行指令。

该提案描述了Python标准库中包含的这个特性。

Exception 类

exception concurrent.futures.CancelledError

future 对象被取消时会触发。

exception concurrent.futures.TimeoutError

future 对象执行超出给定的超时数值时引发。

exception concurrent.futures.BrokenExecutor

当执行器被某些原因中断而且不能用来提交或执行新任务时就会被引发派生于 RuntimeError 的异常类。

3.7 新版功能.

exception concurrent.futures.InvalidStateError

当某个操作在一个当前状态所不允许的 future 上执行时将被引发。

3.8 新版功能.

exception concurrent.futures.thread.BrokenThreadPool

当 ThreadPoolExecutor 中的其中一个工作者初始化失败时会引发派生于 BrokenExecutor 的异常类。

3.7 新版功能.

exception concurrent.futures.process.BrokenProcessPool

当 ThreadPoolExecutor 中的其中一个工作者不完整终止时(比如，被外部杀死)会引发派生于 BrokenExecutor ( 原名 RuntimeError ) 的异常类。

3.3 新版功能.

subprocess --- 子进程管理

源代码: Lib/subprocess.py [https://github.com/python/cpython/tree/3.10/Lib/subprocess.py]

subprocess 模块允许你生成新的进程，连接它们的输入、输出、错误管道，并且获取它们的返回码。此模块打算代替一些老旧的模块与功能：

os.system
os.spawn*

在下面的段落中，你可以找到关于 subprocess 模块如何代替这些模块和功能的相关信息。

参见

PEP 324 [https://www.python.org/dev/peps/pep-0324] -- 提出 subprocess 模块的 PEP

使用 subprocess 模块

推荐的调用子进程的方式是在任何它支持的用例中使用 run() 函数。对于更进阶的用例，也可以使用底层的 Popen 接口。

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)

运行被 arg 描述的指令. 等待指令完成, 然后返回一个 CompletedProcess 实例.

以上显示的参数仅仅是最简单的一些，下面 常用参数 描述（因此在缩写签名中使用仅关键字标示）。完整的函数头和 Popen 的构造函数一样，此函数接受的大多数参数都被传递给该接口。（timeout, input, check 和 capture_output 除外）。

如果 capture_output 设为 true，stdout 和 stderr 将会被捕获。在使用时，内置的 Popen 对象将自动用 stdout=PIPE 和 stderr=PIPE 创建。stdout 和 stderr 参数不应当与 capture_output 同时提供。如果你希望捕获并将两个流合并在一起，使用 stdout=PIPE 和 stderr=STDOUT 来代替 capture_output。

timeout 参数将被传递给 Popen.communicate()。如果发生超时，子进程将被杀死并等待。 TimeoutExpired 异常将在子进程中断后被抛出。

input 参数将被传递给 Popen.communicate() 以及子进程的 stdin。 如果使用此参数，它必须是一个字节序列。 如果指定了 encoding 或 errors 或者将 text 设置为 True，那么也可以是一个字符串。 当使用此参数时，在创建内部 Popen 对象时将自动带上 stdin=PIPE，并且不能再手动指定 stdin 参数。

如果 check 设为 True, 并且进程以非零状态码退出, 一个 CalledProcessError 异常将被抛出. 这个异常的属性将设置为参数, 退出码, 以及标准输出和标准错误, 如果被捕获到.

如果指定了 encoding 或 error，或者 text 被设为真值，标准输入、标准输出和标准错误的文件对象将使用指定的 encoding 和 errors 或者 io.TextIOWrapper 默认值以文本模式打开。 universal_newlines 参数等同于 text 并且提供了向后兼容性。 默认情况下, 文件对象是以二进制模式打开的。

如果 env 不为 None，则它必须是一个为新进程定义环境变量的映射；它们将顶替继承当前进程环境的默认行为被使用。 它会被直接传递给 Popen。 这个映射在任何平台上均可以是字符串到字符串的映射或者在 POSIX 平台上也可以是字节串到字节串的映射，就像是 os.environ 或者 os.environb。

示例:

>>> subprocess.run(["ls", "-l"])  # doesn't capture output
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'')

3.5 新版功能.

在 3.6 版更改: 添加了 encoding 和 errors 形参.

在 3.7 版更改: 添加了 text 形参，作为 universal_newlines 的一个更好理解的别名。 添加了 capture_output 形参。

在 3.10.11 版更改: 针对 shell=True 改变的 Windows shell 搜索顺序。 当前目录和 %PATH% 会被替换为 %COMSPEC% 和 %SystemRoot%\System32\cmd.exe。 因此，在当前目录中投放一个命名为 cmd.exe 的恶意程序不会再起作用。

class subprocess.CompletedProcess

run() 的返回值, 代表一个进程已经结束.

args

被用作启动进程的参数. 可能是一个列表或字符串.

returncode

子进程的退出状态码. 通常来说, 一个为 0 的退出码表示进程运行正常.

一个负值 -N 表示子进程被信号 N 中断 (仅 POSIX).

stdout

从子进程捕获到的标准输出. 一个字节序列, 或一个字符串, 如果 run() 是设置了 encoding, errors 或者 text=True 来运行的. 如果未有捕获, 则为 None.

如果你通过 stderr=subprocess.STDOUT 运行进程，标准输入和标准错误将被组合在这个属性中，并且 stderr 将为 None。

stderr

捕获到的子进程的标准错误. 一个字节序列, 或者一个字符串, 如果 run() 是设置了参数 encoding, errors 或者 text=True 运行的. 如果未有捕获, 则为 None.

check_returncode()

如果 returncode 非零, 抛出 CalledProcessError.

3.5 新版功能.

subprocess.DEVNULL

可被 Popen 的 stdin, stdout 或者 stderr 参数使用的特殊值, 表示使用特殊文件 os.devnull.

3.3 新版功能.

subprocess.PIPE

可被 Popen 的 stdin, stdout 或者 stderr 参数使用的特殊值, 表示打开标准流的管道. 常用于 Popen.communicate().

subprocess.STDOUT

可被 Popen 的 stderr 参数使用的特殊值， 表示标准错误与标准输出使用同一句柄。

exception subprocess.SubprocessError

此模块的其他异常的基类。

3.3 新版功能.

exception subprocess.TimeoutExpired

SubprocessError 的子类，等待子进程的过程中发生超时时被抛出。

cmd

用于创建子进程的指令。

timeout

超时秒数。

output

当被 run() 或 check_output() 捕获时的子进程的输出。 在其它情况下将为 None。当有任何输出被捕获时这将始终为 bytes 而不考虑是否设置了 text=True。 当未检测到输出时它可能会保持为 None 而不是 b''。

stdout

对 output 的别名，对应的有 stderr。

stderr

当被 run() 捕获时的标准错误输出。 在其它情况下将为 None。 当有标准错误输出被捕获时这将始终为 bytes 而不考虑是否设置了 text=True。 当未检测到标准错误输出时它可能会保持为 None 而不是 b''。

3.3 新版功能.

在 3.5 版更改: 添加了 stdout 和 stderr 属性。

exception subprocess.CalledProcessError

SubprocessError 的子类，当一个由 check_call(), check_output() 或 run() (附带 check=True) 运行的进程返回了非零退出状态码时将被引发。

returncode

子进程的退出状态。如果程序由一个信号终止，这将会被设为一个负的信号码。

cmd

用于创建子进程的指令。

output

子进程的输出， 如果被 run() 或 check_output() 捕获。否则为 None。

stdout

对 output 的别名，对应的有 stderr。

stderr

子进程的标准错误输出，如果被 run() 捕获。 否则为 None。

在 3.5 版更改: 添加了 stdout 和 stderr 属性。

常用参数

为了支持丰富的使用案例， Popen 的构造函数（以及方便的函数）接受大量可选的参数。对于大多数典型的用例，许多参数可以被安全地留以它们的默认值。通常需要的参数有：

args 被所有调用需要，应当为一个字符串，或者一个程序参数序列。提供一个参数序列通常更好，它可以更小心地使用参数中的转义字符以及引用（例如允许文件名中的空格）。如果传递一个简单的字符串，则 shell 参数必须为 True （见下文）或者该字符串中将被运行的程序名必须用简单的命名而不指定任何参数。

stdin, stdout 和 stderr 分别指定了被执行程序的标准输入、标准输出和标准错误文件句柄。 合法的值包括 PIPE、DEVNULL、现存的文件描述符（一个正整数）、现存的带有合法文件描述符的文件对象以及 None。 PIPE 表示应该新建一个连接子进程的管道。 DEVNULL 表示将使用特殊的文件 os.devnull。 当使用默认设置 None 时，将不会进行任何重定向；子进程的文件流将继承自父进程。 另外，stderr 可以为 STDOUT，这表示来自子进程的 stderr 数据应当被捕获到与 stdout 相同的文件句柄中。

如果指定了 encoding 或 errors，或者 text (也称 universal_newlines) 为真，则文件对象 stdin、 stdout 与 stderr 将会使用在此次调用中指定的 encoding 和 errors 或者 io.TextIOWrapper 的默认值以文本模式打开。

当构造函数的 newline 参数为 None 时。对于 stdin， 输入的换行符 '\n' 将被转换为默认的换行符 os.linesep。对于 stdout 和 stderr， 所有输出的换行符都被转换为 '\n'。更多信息，查看 io.TextIOWrapper 类的文档。

如果文本模式未被使用， stdin， stdout 和 stderr 将会以二进制流模式打开。没有编码与换行符转换发生。

3.6 新版功能: 添加了 encoding 和 errors 形参。

3.7 新版功能: 添加了 text 形参作为 universal_newlines 的别名。

注解

文件对象 Popen.stdin 、 Popen.stdout 和 Popen.stderr 的换行符属性不会被 Popen.communicate() 方法更新。

如果 shell 设为 True,，则使用 shell 执行指定的指令。如果您主要使用 Python 增强的控制流（它比大多数系统 shell 提供的强大），并且仍然希望方便地使用其他 shell 功能，如 shell 管道、文件通配符、环境变量展开以及 ~ 展开到用户家目录，这将非常有用。但是，注意 Python 自己也实现了许多类似 shell 的特性（例如 glob, fnmatch, os.walk(), os.path.expandvars(), os.path.expanduser() 和 shutil）。

在 3.3 版更改: 当 universal_newlines 被设为 True，则类将使用 locale.getpreferredencoding(False) 编码格式来代替 locale.getpreferredencoding()。 关于它们的区别的更多信息，见 io.TextIOWrapper。

注解

在使用 shell=True 之前， 请阅读 Security Considerations 段落。

这些选项以及所有其他选项在 Popen 构造函数文档中有更详细的描述。

Popen 构造函数

此模块的底层的进程创建与管理由 Popen 类处理。它提供了很大的灵活性，因此开发者能够处理未被便利函数覆盖的不常见用例。

class 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)

在一个新的进程中执行子程序。 在 POSIX 上，该类会使用类似于 os.execvpe() 的行为来执行子程序。 在 Windows 上，该类会使用 Windows CreateProcess() 函数。 Popen 的参数如下。

args 应当是一个程序参数的序列或者是一个单独的字符串或 path-like object。 默认情况下，如果 args 是序列则要运行的程序为 args 中的第一项。 如果 args 是字符串，则其解读依赖于具体平台，如下所述。 请查看 shell 和 executable 参数了解其与默认行为的其他差异。 除非另有说明，否则推荐以序列形式传入 args。

警告

为了最大化可靠性，请使用可执行文件的完整限定路径。 要在 PATH 中搜索一个非限定名称，请使用 shutil.which()。 在所有平台上，传入 sys.executable 是再次启动当前 Python 解释器的推荐方式，并请使用 -m 命令行格式来启动已安装的模块。

对 executable (或 args 的第一项) 路径的解析方式依赖于具体平台。 对于 POSIX，请参阅 os.execvpe()，并要注意当解析或搜索可执行文件路径时，cwd 会覆盖当前工作目录而 env 可以覆盖 PATH 环境变量。 对于 Windows，请参阅 lpApplicationName 的文档以及 lpCommandLine 形参 (传给 WinAPI CreateProcess)，并要注意当解析或搜索可执行文件路径时如果传入 shell=False，则 cwd 不会覆盖当前工作目录而 env 无法覆盖 PATH 环境变量。 使用完整路径可避免所有这些变化情况。

向外部函数传入序列形式参数的一个例子如下:

Popen(["/usr/bin/git", "commit", "-m", "Fixes a bug."])

在 POSIX，如果 args 是一个字符串，此字符串被作为将被执行的程序的命名或路径解释。但是，只有在不传递任何参数给程序的情况下才能这么做。

注解

将 shell 命令拆分为参数序列的方式可能并不很直观，特别是在复杂的情况下。 shlex.split() 可以演示如何确定 args 适当的拆分形式:

>>> 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!

特别注意，由 shell 中的空格分隔的选项（例如 -input）和参数（例如 eggs.txt ）位于分开的列表元素中，而在需要时使用引号或反斜杠转义的参数在 shell （例如包含空格的文件名或上面显示的 echo 命令）是单独的列表元素。

在 Windows，如果 args 是一个序列，他将通过一个在 在 Windows 上将参数列表转换为一个字符串 描述的方式被转换为一个字符串。这是因为底层的 CreateProcess() 只处理字符串。

在 3.6 版更改: 在 POSIX 上如果 shell 为 False 并且序列包含路径类对象则 args 形参可以接受一个 path-like object。

在 3.8 版更改: 如果在Windows 上 shell 为 False 并且序列包含字节串和路径类对象则 args 形参可以接受一个 path-like object。

参数 shell （默认为 False）指定是否使用 shell 执行程序。如果 shell 为 True，更推荐将 args 作为字符串传递而非序列。

在 POSIX，当 shell=True， shell 默认为 /bin/sh。如果 args 是一个字符串，此字符串指定将通过 shell 执行的命令。这意味着字符串的格式必须和在命令提示符中所输入的完全相同。这包括，例如，引号和反斜杠转义包含空格的文件名。如果 args 是一个序列，第一项指定了命令，另外的项目将作为传递给 shell （而非命令） 的参数对待。也就是说， Popen 等同于:

Popen(['/bin/sh', '-c', args[0], args[1], ...])

在 Windows，使用 shell=True，环境变量 COMSPEC 指定了默认 shell。在 Windows 你唯一需要指定 shell=True 的情况是你想要执行内置在 shell 中的命令（例如 dir 或者 copy）。在运行一个批处理文件或者基于控制台的可执行文件时，不需要 shell=True。

注解

在使用 shell=True 之前， 请阅读 Security Considerations 段落。

bufsize 将在 open() 函数创建了 stdin/stdout/stderr 管道文件对象时作为对应的参数供应:

0 表示不使用缓冲区 （读取与写入是一个系统调用并且可以返回短内容）

1 表示行缓冲（仅当 text=True 或 universal_newlines=True 时有用）

任何其他正值表示使用一个约为对应大小的缓冲区

负的 bufsize （默认）表示使用系统默认的 io.DEFAULT_BUFFER_SIZE。

在 3.3.1 版更改: bufsize 现在默认为 -1 来启用缓冲，以符合大多数代码所期望的行为。在 Python 3.2.4 和 3.3.1 之前的版本中，它错误地将默认值设为了为 0，这是无缓冲的并且允许短读取。这是无意的，并且与大多数代码所期望的 Python 2 的行为不一致。

executable 参数指定一个要执行的替换程序。这很少需要。当 shell=True， executable 替换 args 指定运行的程序。但是，原始的 args 仍然被传递给程序。大多数程序将被 args 指定的程序作为命令名对待，这可以与实际运行的程序不同。在 POSIX， args 名作为实际调用程序中可执行文件的显示名称，例如 ps。如果 shell=True，在 POSIX， executable 参数指定用于替换默认 shell /bin/sh 的 shell。

在 3.6 版更改: 在POSIX 上 executable 形参可以接受一个 path-like object。

在 3.8 版更改: 在Windows 上 executable 形参可以接受一个字节串和 path-like object。

在 3.10.11 版更改: 针对 shell=True 改变的 Windows shell 搜索顺序。 当前目录和 %PATH% 会被替换为 %COMSPEC% 和 %SystemRoot%\System32\cmd.exe。 因此，在当前目录中投放一个命名为 cmd.exe 的恶意程序不会再起作用。

stdin, stdout 和 stderr 分别指定了被执行程序的标准输入、标准输出和标准错误文件句柄。 合法的值包括 PIPE、DEVNULL、现存的文件描述符（一个正整数）、现存的带有合法文件描述符的 file object 以及 None。 PIPE 表示应该新建一个连接子进程的管道。 DEVNULL 表示将使用特殊的文件 os.devnull。 当使用默认设置 None 时，将不会进行任何重定向；子进程的文件流将继承自父进程。 另外，stderr 可以为 STDOUT，这表示来自子进程的 stderr 数据应当被捕获到与 stdout 相同的文件句柄中。

如果 preexec_fn 被设为一个可调用对象，此对象将在子进程刚创建时被调用。（仅 POSIX）

警告

preexec_fn 形参在应用程序中存在多线程时是不安全的。子进程在调用前可能死锁。如果你必须使用它，保持警惕！最小化你调用的库的数量。

注解

如果你需要修改子进程环境，使用 env 形参而非在 preexec_fn 中进行。 start_new_session 形参可以代替之前常用的 preexec_fn 来在子进程中调用 os.setsid()。

在 3.8 版更改: preexec_fn 形参在子解释器中已不再受支持。 在子解释器中使用此形参将引发 RuntimeError。 这个新限制可能会影响部署在 mod_wsgi, uWSGI 和其他嵌入式环境中的应用。

如果 close_fds 为真，所有文件描述符除了 0, 1, 2 之外都会在子进程执行前关闭。而当 close_fds 为假时，文件描述符遵守它们继承的标志，如 文件描述符的继承 所述。

在 Windows，如果 close_fds 为真， 则子进程不会继承任何句柄，除非在 STARTUPINFO.IpAttributeList 的 handle_list 的键中显式传递，或者通过标准句柄重定向传递。

在 3.2 版更改: close_fds 的默认值已经从 False 修改为上述值。

在 3.7 版更改: 在 Windows，当重定向标准句柄时 close_fds 的默认值从 False 变为 True。现在重定向标准句柄时有可能设置 close_fds 为 True。（标准句柄指三个 stdio 的句柄）

pass_fds 是一个可选的在父子进程间保持打开的文件描述符序列。提供任何 pass_fds 将强制 close_fds 为 True。（仅 POSIX）

在 3.2 版更改: 加入了 pass_fds 形参。

如果 cwd 不为 None，此函数在执行子进程前会将当前工作目录改为 cwd。 cwd 可以是一个字符串、字节串或 路径类对象。 在 POSIX 上，如果可执行文件路径为相对路径则此函数会相对于 cwd 来查找 executable (或 args 的第一项)。

在 3.6 版更改: 在 POSIX 上 cwd 形参接受一个 path-like object。

在 3.7 版更改: 在 Windows 上 cwd 形参接受一个 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 为 true，则 setsid() 系统调用将在子进程执行之前被执行。（仅 POSIX）

在 3.2 版更改: start_new_session 被添加。

如果 group 不为 None，则 setregid() 系统调用将于子进程执行之前在下级进程中进行。 如果所提供的值为一个字符串，将通过 grp.getgrnam() 来查找它，并将使用 gr_gid 中的值。 如果该值为一个整数，它将被原样传递。 （POSIX 专属）

可用性: POSIX

3.9 新版功能.

如果 extra_groups 不为 None，则 setgroups() 系统调用将于子进程之前在下级进程中进行。 在 extra_groups 中提供的字符串将通过 grp.getgrnam() 来查找，并将使用 gr_gid 中的值。 整数值将被原样传递。 （POSIX 专属）

可用性: POSIX

3.9 新版功能.

如果 user 不为 None，则 setreuid() 系统调用将于子进程执行之前在下级进程中进行。 如果所提供的值为一个字符串，将通过 pwd.getpwnam() 来查找它，并将使用 pw_uid 中的值。 如果该值为一个整数，它将被原样传递。 （POSIX 专属）

可用性: POSIX

3.9 新版功能.

如果 umask 不为负值，则 umask() 系统调用将在子进程执行之前在下级进程中进行。

可用性: POSIX

3.9 新版功能.

如果 env 不为 None，则它必须是一个为新进程定义环境变量的映射；它们将顶替继承当前环境的默认行为被使用。 这个映射在任何平台上均可以是字符串到字符串的映射或者在 POSIX 平台上也可以是字节串到字节串的映射，就像是 os.environ 或者 os.environb。

注解

如果指定， env 必须提供所有被子进程需求的变量。在 Windows，为了运行一个 side-by-side assembly [https://en.wikipedia.org/wiki/Side-by-Side_Assembly] ，指定的 env 必须 包含一个有效的 SystemRoot。

如果 encoding 或 errors 被指定，或者 text 为 true，则文件对象 stdin, stdout 和 stderr 将会以指定的编码和 errors 以文本模式打开，如同 常用参数 所述。 universal_newlines 参数等同于 text 并且提供向后兼容性。默认情况下，文件对象都以二进制模式打开。

3.6 新版功能: encoding 和 errors 被添加。

3.7 新版功能: text 作为 universal_newlines 的一个更具可读性的别名被添加。

如果给出， startupinfo 将是一个将被传递给底层的 CreateProcess 函数的 STARTUPINFO 对象。 creationflags，如果给出，可以是一个或多个以下标志之一：

CREATE_NEW_CONSOLE

CREATE_NEW_PROCESS_GROUP

ABOVE_NORMAL_PRIORITY_CLASS

BELOW_NORMAL_PRIORITY_CLASS

HIGH_PRIORITY_CLASS

IDLE_PRIORITY_CLASS

NORMAL_PRIORITY_CLASS

REALTIME_PRIORITY_CLASS

CREATE_NO_WINDOW

DETACHED_PROCESS

CREATE_DEFAULT_ERROR_MODE

CREATE_BREAKAWAY_FROM_JOB

当 PIPE 被用作 stdin, stdout 或 stderr 时 pipesize 可被用于改变管道的大小。 管道的大小仅会在受支持的平台上被改变（当撰写本文档时只有 Linux 支持）。 其他平台将忽略此形参。

3.10 新版功能: 增加了 pipesize 形参。

Popen 对象支持通过 with 语句作为上下文管理器，在退出时关闭文件描述符并等待进程:

with Popen(["ifconfig"], stdout=PIPE) as proc:
    log.write(proc.stdout.read())

引发一个 审计事件 subprocess.Popen，附带参数 executable, args, cwd, env。

在 3.2 版更改: 添加了上下文管理器支持。

在 3.6 版更改: 现在，如果 Popen 析构时子进程仍然在运行，则析构器会发送一个 ResourceWarning 警告。

在 3.8 版更改: 在某些情况下 Popen 可以使用 os.posix_spawn() 以获得更好的性能。在适用于 Linux 的 Windows 子系统和 QEMU 用户模拟器上，使用 os.posix_spawn() 的 Popen 构造器不再会因找不到程序等错误而引发异常，而是上下级进程失败并返回一个非零的 returncode。

异常

在子进程中抛出的异常，在新的进程开始执行前，将会被再次在父进程中抛出。

被引发的最一般异常是 OSError。 例如这会在尝试执行一个不存在的文件时发生。 应用程序应当为 OSError 异常做好准备。 请注意，如果 shell=True，则 OSError 仅会在未找到选定的 shell 本身时被引发。 要确定 shell 是否未找到所请求的应用程序，必须检查来自子进程的返回码或输出。

如果 Popen 调用时有无效的参数，则一个 ValueError 将被抛出。

check_call() 与 check_output() 在调用的进程返回非零退出码时将抛出 CalledProcessError。

所有接受 timeout 形参的函数与方法，例如 call() 和 Popen.communicate() 将会在进程退出前超时到期时抛出 TimeoutExpired。

此模块中定义的异常都继承自 SubprocessError。

3.3 新版功能: 基类 SubprocessError 被添加。

安全考量

不同于某些其他的 popen 函数，这个库将不会隐式地选择调用系统 shell。 这意味着所有字符，包括 shell 元字符都可以被安全地传递给子进程。 如果 shell 是通过 shell=True 被显式地唤起的，则应用程序要负责确保所有空白符和元字符被适当地转义以避免 shell 注入 [https://en.wikipedia.org/wiki/Shell_injection#Shell_injection] 安全漏洞。 在 某些平台 上，可以使用 shlex.quote() 来执行这种转义。

在 Windows 上，批处理文件 (*.bat 或 *.cmd) 可以在系统 shell 中通过操作系统调用来启动而忽略传给该库的参数。 这可能导致根据 shell 规则来解析参数，而没有任何 Python 添加的转义。 如果你想要附带来自不受信任源的参数启动批处理文件，请考虑传入 shell=True 以允许 Python 转义特殊字符。 请参阅 gh-114539 [https://github.com/python/cpython/issues/114539] 了解相关讨论。

Popen 对象

Popen 类的实例拥有以下方法：

Popen.poll()

检查子进程是否已被终止。设置并返回 returncode 属性。否则返回 None。

Popen.wait(timeout=None)

等待子进程被终止。设置并返回 returncode 属性。

如果进程在 timeout 秒后未中断，抛出一个 TimeoutExpired 异常，可以安全地捕获此异常并重新等待。

注解

当 stdout=PIPE 或者 stderr=PIPE 并且子进程产生了足以阻塞 OS 管道缓冲区接收更多数据的输出到管道时，将会发生死锁。当使用管道时用 Popen.communicate() 来规避它。

注解

此函数使用了一个 busy loop （非阻塞调用以及短睡眠） 实现。使用 asyncio 模块进行异步等待： 参阅 asyncio.create_subprocess_exec。

在 3.3 版更改: timeout 被添加

Popen.communicate(input=None, timeout=None)

与进程交互：将数据发送到 stdin。 从 stdout 和 stderr 读取数据，直到抵达文件结尾。 等待进程终止并设置 returncode 属性。 可选的 input 参数应为要发送到下级进程的数据，或者如果没有要发送到下级进程的数据则为 None。 如果流是以文本模式打开的，则 input 必须为字符串。 在其他情况下，它必须为字节串。

communicate() 返回一个 (stdout_data, stderr_data) 元组。如果文件以文本模式打开则为字符串；否则字节。

注意如果你想要向进程的 stdin 传输数据，你需要通过 stdin=PIPE 创建此 Popen 对象。类似的，要从结果元组获取任何非 None 值，你同样需要设置 stdout=PIPE 或者 stderr=PIPE。

如果进程在 timeout 秒后未终止，一个 TimeoutExpired 异常将被抛出。捕获此异常并重新等待将不会丢失任何输出。

如果超时到期，子进程不会被杀死，所以为了正确清理一个行为良好的应用程序应该杀死子进程并完成通讯。

proc = subprocess.Popen(...)
try:
    outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
    proc.kill()
    outs, errs = proc.communicate()

注解

内存里数据读取是缓冲的，所以如果数据尺寸过大或无限，不要使用此方法。

在 3.3 版更改: timeout 被添加

Popen.send_signal(signal)

将信号 signal 发送给子进程。

如果进程已完成则不做任何操作。

注解

在 Windows， SIGTERM 是一个 terminate() 的别名。 CTRL_C_EVENT 和 CTRL_BREAK_EVENT 可以被发送给以包含 CREATE_NEW_PROCESS 的 creationflags 形参启动的进程。

Popen.terminate()

停止子进程。 在 POSIX 操作系统上，此方法会发送 SIGTERM 给子进程。 在 Windows 上则会调用 Win32 API 函数 TerminateProcess() 来停止子进程。

Popen.kill()

杀死子进程。 在 POSIX 操作系统上，此函数会发送 SIGKILL 给子进程。 在 Windows 上 kill() 则是 terminate() 的别名。

下列属性也会通过类来设置以供你访问。 将它们重赋新值是不受支持的:

Popen.args

args 参数传递给 Popen -- 一个程序参数的序列或者一个简单字符串。

3.3 新版功能.

Popen.stdin

如果 stdin 参数为 PIPE，此属性是一个类似 open() 所返回对象的可写流对象。 如果指定了 encoding 或 errors 参数或者 text 或 universal_newlines 参数为 True，则这个流将是一个文本流，否则将是一个字节流。 如果 stdin 参数不为 PIPE，则此属性将为 None。

Popen.stdout

如果 stdout 参数为 PIPE，此属性是一个类似 open() 所返回对象的可读流对象。 从流中读取将会提供来自子进程的输出。 如果 encoding 或 errors 参数被指定或者 text 或 universal_newlines 参数为 True，则这个流将是一个文本流，否则将是一个字节流。 如果 stdout 参数不为 PIPE，则此属性将为 None。

Popen.stderr

如果 stderr 参数为 PIPE，此属性是一个类似 open() 所返回对象的可读流对象。 从流中读取将会提供来自子进程的错误输出。 如果 encoding 或 errors 参数被指定或者 text 或 universal_newlines 参数为 True，则这个流将是一个文本流，否则将是一个字节流。 如果 stderr 参数不为 PIPE，则此属性将为 None。

警告

使用 communicate() 而非 .stdin.write， .stdout.read 或者 .stderr.read 来避免由于任意其他 OS 管道缓冲区被子进程填满阻塞而导致的死锁。

Popen.pid

子进程的进程号。

注意如果你设置了 shell 参数为 True，则这是生成的子 shell 的进程号。

Popen.returncode

此进程的退出码，由 poll() 和 wait() 设置（以及直接由 communicate() 设置）。一个 None 值 表示此进程仍未结束。

一个负值 -N 表示子进程被信号 N 中断 (仅 POSIX).

Windows Popen 助手

STARTUPINFO 类和以下常数仅在 Windows 有效。

class subprocess.STARTUPINFO(*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None)

在 Popen 创建时部分支持 Windows 的 STARTUPINFO [https://msdn.microsoft.com/en-us/library/ms686331(v=vs.85).aspx] 结构。接下来的属性仅能通过关键词参数设置。

在 3.7 版更改: 仅关键词参数支持被加入。

dwFlags

一个位字段，用于确定进程在创建窗口时是否使用某些 STARTUPINFO 属性。

si = subprocess.STARTUPINFO()
si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW

hStdInput

如果 dwFlags 被指定为 STARTF_USESTDHANDLES，则此属性是进程的标准输入句柄，如果 STARTF_USESTDHANDLES 未指定，则默认的标准输入是键盘缓冲区。

hStdOutput

如果 dwFlags 被指定为 STARTF_USESTDHANDLES，则此属性是进程的标准输出句柄。除此之外，此此属性将被忽略并且默认标准输出是控制台窗口缓冲区。

hStdError

如果 dwFlags 被指定为 STARTF_USESTDHANDLES，则此属性是进程的标准错误句柄。除此之外，此属性将被忽略并且默认标准错误为控制台窗口的缓冲区。

wShowWindow

如果 dwFlags 指定了 STARTF_USESHOWWINDOW，此属性可为能被指定为 函数 ShowWindow [https://msdn.microsoft.com/en-us/library/ms633548(v=vs.85).aspx] 的nCmdShow 的形参的任意值，除了 SW_SHOWDEFAULT。如此之外，此属性被忽略。

SW_HIDE 被提供给此属性。它在 Popen 由 shell=True 调用时使用。

lpAttributeList

STARTUPINFOEX 给出的用于进程创建的额外属性字典，参阅 UpdateProcThreadAttribute [https://msdn.microsoft.com/en-us/library/windows/desktop/ms686880(v=vs.85).aspx]。

支持的属性：

handle_list

将被继承的句柄的序列。如果非空， close_fds 必须为 true。

当传递给 Popen 构造函数时，这些句柄必须暂时地能被 os.set_handle_inheritable() 继承，否则 OSError 将以 Windows error ERROR_INVALID_PARAMETER (87) 抛出。

警告

在多线程进程中，请谨慎使用，以便在将此功能与对继承所有句柄的其他进程创建函数——例如 os.system() 的并发调用——相结合时，避免泄漏标记为可继承的句柄。这也应用于临时性创建可继承句柄的标准句柄重定向。

3.7 新版功能.

Windows 常数

subprocess 模块曝出以下常数。

subprocess.STD_INPUT_HANDLE

标准输入设备，这是控制台输入缓冲区 CONIN$。

subprocess.STD_OUTPUT_HANDLE

标准输出设备。最初，这是活动控制台屏幕缓冲区 CONOUT$。

subprocess.STD_ERROR_HANDLE

标准错误设备。最初，这是活动控制台屏幕缓冲区 CONOUT$。

subprocess.SW_HIDE

隐藏窗口。另一个窗口将被激活。

subprocess.STARTF_USESTDHANDLES

指明 STARTUPINFO.hStdInput, STARTUPINFO.hStdOutput 和 STARTUPINFO.hStdError 属性包含额外的信息。

subprocess.STARTF_USESHOWWINDOW

指明 STARTUPINFO.wShowWindow 属性包含额外的信息。

subprocess.CREATE_NEW_CONSOLE

新的进程将有新的控制台，而不是继承父进程的（默认）控制台。

subprocess.CREATE_NEW_PROCESS_GROUP

用于指明将创建一个新的进程组的 Popen creationflags 形参。 这个旗标对于在子进程上使用 os.kill() 来说是必须的。

如果指定了 CREATE_NEW_CONSOLE 则这个旗标会被忽略。

subprocess.ABOVE_NORMAL_PRIORITY_CLASS

用于指明一个新进程将具有高于平均的优先级的 Popen creationflags 形参。

3.7 新版功能.

subprocess.BELOW_NORMAL_PRIORITY_CLASS

用于指明一个新进程将具有低于平均的优先级的 Popen creationflags 形参。

3.7 新版功能.

subprocess.HIGH_PRIORITY_CLASS

用于指明一个新进程将具有高优先级的 Popen creationflags 形参。

3.7 新版功能.

subprocess.IDLE_PRIORITY_CLASS

用于指明一个新进程将具有空闲（最低）优先级的 Popen creationflags 形参。

3.7 新版功能.

subprocess.NORMAL_PRIORITY_CLASS

用于指明一个新进程将具有正常（默认）优先级的 Popen creationflags 形参。

3.7 新版功能.

subprocess.REALTIME_PRIORITY_CLASS

用于指明一个新进程将具有实时优先级的 Popen creationflags 形参。 你应当几乎永远不使用 REALTIME_PRIORITY_CLASS，因为这会中断管理鼠标输入、键盘输入以及后台磁盘刷新的系统线程。 这个类只适用于直接与硬件“对话”，或者执行短暂任务具有受限中断的应用。

3.7 新版功能.

subprocess.CREATE_NO_WINDOW

指明一个新进程将不会创建窗口的 Popen creationflags 形参。

3.7 新版功能.

subprocess.DETACHED_PROCESS

指明一个新进程将不会继承其父控制台的 Popen creationflags 形参。 这个值不能与 CREATE_NEW_CONSOLE 一同使用。

3.7 新版功能.

subprocess.CREATE_DEFAULT_ERROR_MODE

指明一个新进程不会继承调用方进程的错误模式的 Popen creationflags 形参。 新进程会转为采用默认的错误模式。 这个特性特别适用于运行时禁用硬错误的多线程 shell 应用。

3.7 新版功能.

subprocess.CREATE_BREAKAWAY_FROM_JOB

指明一个新进程不会关联到任务的 Popen creationflags 形参。

3.7 新版功能.

较旧的高阶 API

在 Python 3.5 之前，这三个函数组成了 subprocess 的高阶 API。 现在你可以在许多情况下使用 run()，但有大量现在代码仍会调用这些函数。

subprocess.call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

运行由 args 所描述的命令。 等待命令完成，然后返回 returncode 属性。

需要捕获 stdout 或 stderr 的代码应当改用 run():

run(...).returncode

要屏蔽 stdout 或 stderr，可提供 DEVNULL 这个值。

上面显示的参数只是常见的一些。 完整的函数签名与 Popen 构造器的相同 —— 此函数会将所提供的 timeout 之外的全部参数直接传递给目标接口。

注解

请不要在此函数中使用 stdout=PIPE 或 stderr=PIPE。 如果子进程向管道生成了足以填满 OS 管理缓冲区的输出而管道还未被读取时它将会阻塞。

在 3.3 版更改: timeout 被添加

在 3.10.11 版更改: 针对 shell=True 改变的 Windows shell 搜索顺序。 当前目录和 %PATH% 会被替换为 %COMSPEC% 和 %SystemRoot%\System32\cmd.exe。 因此，在当前目录中投放一个命名为 cmd.exe 的恶意程序不会再起作用。

subprocess.check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

附带参数运行命令。 等待命令完成。 如果返回码为零则正常返回，否则引发 CalledProcessError。 CalledProcessError 对象将在 returncode 属性中保存返回码。 如果 check_call() 无法开始进程则它将传播已被引发的异常。

需要捕获 stdout 或 stderr 的代码应当改用 run():

run(..., check=True)

要屏蔽 stdout 或 stderr，可提供 DEVNULL 这个值。

上面显示的参数只是常见的一些。 完整的函数签名与 Popen 构造器的相同 —— 此函数会将所提供的 timeout 之外的全部参数直接传递给目标接口。

注解

请不要在此函数中使用 stdout=PIPE 或 stderr=PIPE。 如果子进程向管道生成了足以填满 OS 管理缓冲区的输出而管道还未被读取时它将会阻塞。

在 3.3 版更改: timeout 被添加

在 3.10.11 版更改: 针对 shell=True 改变的 Windows shell 搜索顺序。 当前目录和 %PATH% 会被替换为 %COMSPEC% 和 %SystemRoot%\System32\cmd.exe。 因此，在当前目录中投放一个命名为 cmd.exe 的恶意程序不会再起作用。

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)

附带参数运行命令并返回其输出。

如果返回码非零则会引发 CalledProcessError。 CalledProcessError 对象将在 returncode 属性中保存返回码并在 output 属性中保存所有输出。

这相当于：

run(..., check=True, stdout=PIPE).stdout

上面显示的参数只是常见的一些。 完整的函数签名与 run() 的大致相同 —— 大部分参数会通过该接口直接传递。 存在一个与 run() 行为不同的 API 差异：传递 input=None 的行为将与 input=b'' (或 input=''，具体取决于其他参数) 一样而不是使用父对象的标准输入文件处理。

默认情况下，此函数将把数据返回为已编码的字节串。 输出数据的实际编码格式将取决于唤起的命令，因此解码为文本的操作往往需要在应用程序层级上进行处理。

此行为可以通过设置 text, encoding, errors 或将 universal_newlines 设为 True 来重载，具体描述见 常用参数 和 run()。

要在结果中同时捕获标准错误，请使用 stderr=subprocess.STDOUT:

>>> subprocess.check_output(
...     "ls non_existent_file; exit 0",
...     stderr=subprocess.STDOUT,
...     shell=True)
'ls: non_existent_file: No such file or directory\n'

3.1 新版功能.

在 3.3 版更改: timeout 被添加

在 3.4 版更改: 增加了对 input 关键字参数的支持。

在 3.6 版更改: 增加了 encoding 和 errors。 详情参见 run()。

3.7 新版功能: text 作为 universal_newlines 的一个更具可读性的别名被添加。

在 3.10.11 版更改: 针对 shell=True 改变的 Windows shell 搜索顺序。 当前目录和 %PATH% 会被替换为 %COMSPEC% 和 %SystemRoot%\System32\cmd.exe。 因此，在当前目录中投放一个命名为 cmd.exe 的恶意程序不会再起作用。

使用 subprocess 模块替换旧函数

在这一节中，"a 改为 b" 意味着 b 可以被用作 a 的替代。

注解

在这一节中的所有 "a" 函数会在找不到被执行的程序时（差不多）静默地失败；"b" 替代函数则会改为引发 OSError。

此外，在使用 check_output() 时如果替代函数所请求的操作产生了非零返回值则将失败并引发 CalledProcessError。 操作的输出仍能以所引发异常的 output 属性的方式被访问。

在下列例子中，我们假定相关的函数都已从 subprocess 模块中导入了。

替代 /bin/sh shell 命令替换

output=$(mycmd myarg)

改为:

output = check_output(["mycmd", "myarg"])

替代 shell 管道

output=$(dmesg | grep hda)

改为:

p1 = Popen(["dmesg"], stdout=PIPE)
p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
p1.stdout.close()  # Allow p1 to receive a SIGPIPE if p2 exits.
output = p2.communicate()[0]

启动 p2 之后再执行 p1.stdout.close() 调用很重要，这是为了让 p1 能在 p2 先于 p1 退出时接收到 SIGPIPE。

另外，对于受信任的输入，shell 本身的管道支持仍然可被直接使用:

output=$(dmesg | grep hda)

改为:

output = check_output("dmesg | grep hda", shell=True)

替代 os.system()

sts = os.system("mycmd" + " myarg")
# becomes
retcode = call("mycmd" + " myarg", shell=True)

注释：

通过 shell 来调用程序通常是不必要的。

call() 返回值的编码方式与 os.system() 的不同。

os.system() 函数在命令运行期间会忽略 SIGINT 和 SIGQUIT 信号，但调用方必须在使用 subprocess 模块时分别执行此操作。

一个更现实的例子如下所示:

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)

替代 os.spawn 函数族

P_NOWAIT 示例:

pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
==>
pid = Popen(["/bin/mycmd", "myarg"]).pid

P_WAIT 示例:

retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
==>
retcode = call(["/bin/mycmd", "myarg"])

Vector 示例:

os.spawnvp(os.P_NOWAIT, path, args)
==>
Popen([path] + args[1:])

Environment 示例:

os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
==>
Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})

替代 os.popen(), os.popen2(), os.popen3()

(child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize)
==>
p = Popen(cmd, shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, close_fds=True)
(child_stdin, child_stdout) = (p.stdin, p.stdout)

(child_stdin,
 child_stdout,
 child_stderr) = os.popen3(cmd, mode, bufsize)
==>
p = Popen(cmd, shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
(child_stdin,
 child_stdout,
 child_stderr) = (p.stdin, p.stdout, p.stderr)

(child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize)
==>
p = Popen(cmd, shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
(child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout)

返回码以如下方式处理转写:

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")

来自 popen2 模块的替代函数

注解

如果 popen2 函数的 cmd 参数是一个字符串，命令会通过 /bin/sh 来执行。 如果是一个列表，命令会被直接执行。

(child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)
==>
p = Popen("somestring", shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, close_fds=True)
(child_stdout, child_stdin) = (p.stdout, p.stdin)

(child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode)
==>
p = Popen(["mycmd", "myarg"], bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, close_fds=True)
(child_stdout, child_stdin) = (p.stdout, p.stdin)

popen2.Popen3 和 popen2.Popen4 基本上类似于 subprocess.Popen，不同之处在于:

Popen 如果执行失败会引发一个异常。

capturestderr 参数被替换为 stderr 参数。

必须指定 stdin=PIPE 和 stdout=PIPE。

popen2 默认会关闭所有文件描述符，但对于 Popen 你必须指明 close_fds=True 以才能在所有平台或较旧的 Python 版本中确保此行为。

旧式的 Shell 发起函数

此模块还提供了以下来自 2.x commands 模块的旧版函数。 这些操作会隐式地唤起系统 shell 并且上文所描述的有关安全与异常处理一致性保证都不适用于这些函数。

subprocess.getstatusoutput(cmd)

返回在 shell 中执行 cmd 产生的 (exitcode, output)。

在 shell 中以 Popen.check_output() 执行字符串 cmd 并返回一个 2 元组 (exitcode, output)。 会使用当前区域设置的编码格式；请参阅 常用参数 中的说明来了解详情。

末尾的一个换行符会从输出中被去除。 命令的退出码可被解读为子进程的返回码。 例如:

>>> 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, '')

可用性: POSIX 和 Windows。

在 3.3.4 版更改: 添加了 Windows 支持。

此函数现在返回 (exitcode, output) 而不是像 Python 3.3.3 及更早的版本那样返回 (status, output)。 exitcode 的值与 returncode 相同。

subprocess.getoutput(cmd)

返回在 shell 中执行 cmd 产生的输出（stdout 和 stderr）。

类似于 getstatusoutput()，但退出码会被忽略并且返回值为包含命令输出的字符串。 例如:

>>> subprocess.getoutput('ls /bin/ls')
'/bin/ls'

可用性: POSIX 和 Windows。

在 3.3.4 版更改: 添加了 Windows 支持

备注

在 Windows 上将参数列表转换为一个字符串

在 Windows 上，args 序列会被转换为可使用以下规则来解析的字符串（对应于 MS C 运行时所使用的规则）:

参数以空白符分隔，即空格符或制表符。

用双引号标示的字符串会被解读为单个参数，而不再考虑其中的空白符。 一个参数可以嵌套用引号标示的字符串。

带有一个反斜杠前缀的双引号会被解读为双引号字面值。

反斜杠会按字面值解读，除非它是作为双引号的前缀。

如果反斜杠被作为双引号的前缀，则每个反斜杠对会被解读为一个反斜杠字面值。 如果反斜杠数量为奇数，则最后一个反斜杠会如规则 3 所描述的那样转义下一个双引号。

参见

shlex

此模块提供了用于解析和转义命令行的函数。

sched --- 事件调度器

源码： Lib/sched.py [https://github.com/python/cpython/tree/3.10/Lib/sched.py]

sched 模块定义了一个实现通用事件调度程序的类：

class sched.scheduler(timefunc=time.monotonic, delayfunc=time.sleep)

scheduler 类定义了一个调度事件的通用接口。 它需要两个函数来实际处理“外部世界” —— timefunc 应当不带参数地调用，并返回一个数字（“时间”，可以为任意单位）。 delayfunc 函数应当带一个参数调用，与 timefunc 的输出相兼容，并且应当延迟其所指定的时间单位。 每个事件运行后还将调用 delayfunc 并传入参数 0 以允许其他线程有机会在多线程应用中运行。

在 3.3 版更改: timefunc 和 delayfunc 参数是可选的。

在 3.3 版更改: scheduler 类可以安全的在多线程环境中使用。

示例:

>>> 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',))
...     # despite having higher priority, 'keyword' runs after 'positional' as enter() is relative
...     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

调度器对象

scheduler 实例拥有以下方法和属性：

scheduler.enterabs(time, priority, action, argument=(), kwargs={})

安排一个新事件。 time 参数应该有一个数字类型兼容的返回值，与传递给构造函数的 timefunc 函数的返回值兼容。 计划在相同 time 的事件将按其 priority 的顺序执行。 数字越小表示优先级越高。

执行事件意为执行 action(*argument, **kwargs)。 argument 是包含有 action 的位置参数的序列。 kwargs 是包含 action 的关键字参数的字典。

返回值是一个事件，可用于以后取消事件（ 参见 cancel() ）。

在 3.3 版更改: argument 参数是可选的。

在 3.3 版更改: 添加了 kwargs 形参。

scheduler.enter(delay, priority, action, argument=(), kwargs={})

安排延后 delay 时间单位的事件。 除了时间是相对的，其他参数、效果和返回值与 enterabs() 相同。

在 3.3 版更改: argument 参数是可选的。

在 3.3 版更改: 添加了 kwargs 形参。

scheduler.cancel(event)

从队列中删除事件。 如果 event 不是当前队列中的事件，则此方法将引发 ValueError。

scheduler.empty()

如果事件队列为空则返回 True。

scheduler.run(blocking=True)

运行所有预定事件。 此方法将等待（使用传递给构造函数的 delayfunc() 函数）进行下一个事件，然后执行它，依此类推，直到没有更多的计划事件。

如果 blocking 为false，则执行最快到期（如果有）的预定事件，然后在调度程序中返回下一个预定调用的截止时间（如果有）。

action 或 delayfunc 都可以引发异常。 在任何一种情况下，调度程序都将保持一致状态并传播异常。 如果 action 引发异常，则在将来调用 run() 时不会尝试该事件。

如果一系列事件的运行时间大于下一个事件发生前的可用时间，那么调度程序只会保持落后。 没有事件会被丢弃；调用代码负责取消不再相关的事件。

在 3.3 版更改: 添加了 blocking 形参。

scheduler.queue

只读属性，按照计划运行的顺序返回即将发生的事件列表。 每个事件都显示为 named tuple ，包含以下字段：time、priority、action、argument、kwargs。

queue --- 一个同步的队列类

源代码: Lib/queue.py [https://github.com/python/cpython/tree/3.10/Lib/queue.py]

queue 模块实现了多生产者、多消费者队列。这特别适用于消息必须安全地在多线程间交换的线程编程。模块中的 Queue 类实现了所有所需的锁定语义。

本模块实现了三种类型的队列，它们的区别仅仅是条目的提取顺序。 在 FIFO 队列中，先添加的任务会先被提取。 在 LIFO 队列中，最近添加的条目会先被提取 (类似于一个栈)。 在优先级队列中，条目将保持已排序状态 (使用 heapq 模块) 并且值最小的条目会先被提取。

在内部，这三个类型的队列使用锁来临时阻塞竞争线程；然而，它们并未被设计用于线程的重入性处理。

此外，模块实现了一个 "简单的" FIFO 队列类型， SimpleQueue ，这个特殊实现为小功能在交换中提供额外的保障。

queue 模块定义了下列类和异常：

class queue.Queue(maxsize=0)

Constructor for a 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.

class queue.LifoQueue(maxsize=0)

LIFO 队列构造函数。 maxsize 是个整数，用于设置可以放入队列中的项目数的上限。当达到这个大小的时候，插入操作将阻塞至队列中的项目被消费掉。如果 maxsize 小于等于零，队列尺寸为无限大。

class queue.PriorityQueue(maxsize=0)

优先级队列构造函数。 maxsize 是个整数，用于设置可以放入队列中的项目数的上限。当达到这个大小的时候，插入操作将阻塞至队列中的项目被消费掉。如果 maxsize 小于等于零，队列尺寸为无限大。

值最小的条目会先被提取 (值最小的条目是由the lowest valued entry is the one that would be returned by min(entries) 返回的)。 条目的典型模式是如下形式的元组: (priority_number, data)。

如果 data 元素没有可比性，数据将被包装在一个类中，忽略数据值，仅仅比较优先级数字 ：

from dataclasses import dataclass, field
from typing import Any

@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)

class queue.SimpleQueue

无界的 FIFO 队列构造函数。简单的队列，缺少任务跟踪等高级功能。

3.7 新版功能.

exception queue.Empty

对空的 Queue 对象，调用非阻塞的 get() (or get_nowait()) 时，引发的异常。

exception queue.Full

对满的 Queue 对象，调用非阻塞的 put() (or put_nowait()) 时，引发的异常。

Queue对象

队列对象 (Queue, LifoQueue, 或者 PriorityQueue) 提供下列描述的公共方法。

Queue.qsize()

返回队列的大致大小。注意，qsize() > 0 不保证后续的 get() 不被阻塞，qsize() < maxsize 也不保证 put() 不被阻塞。

Queue.empty()

如果队列为空，返回 True ，否则返回 False 。如果 empty() 返回 True ，不保证后续调用的 put() 不被阻塞。类似的，如果 empty() 返回 False ，也不保证后续调用的 get() 不被阻塞。

Queue.full()

如果队列是满的返回 True ，否则返回 False 。如果 full() 返回 True 不保证后续调用的 get() 不被阻塞。类似的，如果 full() 返回 False 也不保证后续调用的 put() 不被阻塞。

Queue.put(item, block=True, timeout=None)

将 item 加入队列。 如果可选参数 block 为真值并且 timeout 为 None (默认值)，则会在必要时阻塞直到有空闲槽位可用。 如为 timeout 为正数，则将阻塞最多 timeout 秒并会在没有可用的空闲槽位时引发 Full 异常。 在其他情况下 (block 为假值)，则如果空闲槽位立即可用则将条目加入队列，否则将引发 Full 异常 (timeout 在此情况下将被忽略)。

Queue.put_nowait(item)

相当于 put(item, block=False)。

Queue.get(block=True, timeout=None)

从队列中移除并返回一个项目。如果可选参数 block 是 true 并且 timeout 是 None (默认值)，则在必要时阻塞至项目可得到。如果 timeout 是个正数，将最多阻塞 timeout 秒，如果在这段时间内项目不能得到，将引发 Empty 异常。反之 (block 是 false) , 如果一个项目立即可得到，则返回一个项目，否则引发 Empty 异常 (这种情况下，timeout 将被忽略)。

POSIX 系统上在 3.0 之前，以及在 Windows 上的所有版本中，如果 block 为真值并且 timeout 为 None，此操作将进入在底层锁上的不可中断的等待。 这意味着不会发生任何异常，特别是 SIGINT 将不会触发 KeyboardInterrupt。

Queue.get_nowait()

相当于 get(False) 。

提供了两个方法，用于支持跟踪 排队的任务 是否 被守护的消费者线程 完整的处理。

Queue.task_done()

表示前面排队的任务已经被完成。被队列的消费者线程使用。每个 get() 被用于获取一个任务， 后续调用 task_done() 告诉队列，该任务的处理已经完成。

如果 join() 当前正在阻塞，在所有条目都被处理后，将解除阻塞(意味着每个 put() 进队列的条目的 task_done() 都被收到)。

如果被调用的次数多于放入队列中的项目数量，将引发 ValueError 异常 。

Queue.join()

阻塞至队列中所有的元素都被接收和处理完毕。

当一个条目被添加到队列的时候未完成任务的计数将会增加。 每当一个消费者线程调用 task_done() 来表明该条目已被提取且其上的所有工作已完成时未完成计数将会减少。 当未完成计数降为零时，join() 将解除阻塞。

如何等待排队的任务被完成的示例：

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()

# Turn-on the worker thread.
threading.Thread(target=worker, daemon=True).start()

# Send thirty task requests to the worker.
for item in range(30):
    q.put(item)

# Block until all tasks are done.
q.join()
print('All work completed')

SimpleQueue 对象

SimpleQueue 对象提供下列描述的公共方法。

SimpleQueue.qsize()

返回队列的大致大小。注意，qsize() > 0 不保证后续的 get() 不被阻塞。

SimpleQueue.empty()

如果队列为空则返回 True，否则返回 False。 如果 empty() 返回 False 则不保证后续对 get() 的调用将不会阻塞。

SimpleQueue.put(item, block=True, timeout=None)

将 item 放入队列。此方法永不阻塞，始终成功（除了潜在的低级错误，例如内存分配失败）。可选参数 block 和 timeout 仅仅是为了保持 Queue.put() 的兼容性而提供，其值被忽略。

CPython 实现细节： 此方法具有一个可重入的 C 实现。 也就是说，一个 put() 或 get() 调用可以被同一线程中的另一个 put() 调用打断而不会发生死锁或破坏队列内部的状态。 这使得它适用于析构器如 __del__ 方法或 weakref 回调。

SimpleQueue.put_nowait(item)

相当于 put(item, block=False)，为保持与 Queue.put_nowait() 的兼容性而提供。

SimpleQueue.get(block=True, timeout=None)

从队列中移除并返回一个项目。如果可选参数 block 是 true 并且 timeout 是 None (默认值)，则在必要时阻塞至项目可得到。如果 timeout 是个正数，将最多阻塞 timeout 秒，如果在这段时间内项目不能得到，将引发 Empty 异常。反之 (block 是 false) , 如果一个项目立即可得到，则返回一个项目，否则引发 Empty 异常 (这种情况下，timeout 将被忽略)。

SimpleQueue.get_nowait()

相当于 get(False) 。

参见

类 multiprocessing.Queue

一个用于多进程上下文的队列类（而不是多线程）。

collections.deque 是无界队列的一个替代实现，具有快速的不需要锁并且支持索引的原子化 append() 和 popleft() 操作。

contextvars --- 上下文变量

本模块提供了相关API用于管理、存储和访问上下文相关的状态。 ContextVar 类用于声明 上下文变量 并与其一起使用。函数 copy_context()  和类 Context 用于管理当前上下文和异步框架中。

在多并发环境中，有状态上下文管理器应该使用上下文变量，而不是 threading.local() 来防止他们的状态意外泄露到其他代码。

更多信息参见 PEP 567 [https://www.python.org/dev/peps/pep-0567] 。

3.7 新版功能.

上下文变量

class contextvars.ContextVar(name[, *, default])

此类用于声明一个新的上下文变量，如:

var: ContextVar[int] = ContextVar('var', default=42)

name 参数用于内省和调试，必需。

调用 ContextVar.get() 时，如果上下文中没有找到此变量的值，则返回可选的仅命名参数 default 。

重要： 上下文变量应该在顶级模块中创建，且永远不要在闭包中创建。 Context 对象拥有对上下文变量的强引用，这可以让上下文变量被垃圾收集器正确回收。

name

上下文变量的名称，只读属性。

3.7.1 新版功能.

get([default])

返回当前上下文中此上下文变量的值。

如果当前上下文中此变量没有值，则此方法会:

如果提供了 default，返回其值；或者

返回上下文变量本身的默认值， 如果创建此上下文变量时提供了默认值；或者

抛出 LookupError 异常。

set(value)

调用此方法设置上下文变量在当前上下文中的值。

必选参数 value 是上下文变量的新值。

返回一个 Token  对象，可通过 ContextVar.reset() 方法将上下文变量还原为之前某个状态。

reset(token)

将上下文变量重置为调用 ContextVar.set() 之前、创建 token 时候的状态。

例如：

var = ContextVar('var')

token = var.set('new value')
# code that uses 'var'; var.get() returns 'new value'.
var.reset(token)

# After the reset call the var has no value again, so
# var.get() would raise a LookupError.

class contextvars.Token

ContextVar.set() 方法返回 Token 对象。此对象可以传递给 ContextVar.reset() 方法用于将上下文变量还原为调用 set 前的状态。

var

只读属性。指向创建此 token 的 ContextVar 对象。

old_value

一个只读属性。 会被设为在创建此令牌的 ContextVar.set() 方法调用之前该变量所具有的值。 如果调用之前变量没有设置值则它会指令 Token.MISSING。

MISSING

Token.old_value 会用到的一个标记对象。

手动上下文管理

contextvars.copy_context()

返回当前上下文中 Context 对象的拷贝。

以下代码片段会获取当前上下文的拷贝并打印设置到其中的所有变量及其值:

ctx: Context = copy_context()
print(list(ctx.items()))

此函数复杂度为 O(1) ，也就是说对于只包含几个上下文变量和很多上下文变量的情况，他们是一样快的。

class contextvars.Context

ContextVars 与其值的映射。

Context() 创建一个不包含任何值的空上下文。如果要获取当前上下文的拷贝，使用 copy_context() 函数。

每个线程将有一个不同的最高层级 Context 对象。 这意味着当在不同的线程中赋值时 ContextVar 对象的行为方式与 threading.local() 类似。

Context 实现了 collections.abc.Mapping 接口。

run(callable, *args, **kwargs)

按照 run 方法中的参数在上下文对象中执行 callable(*args, **kwargs) 代码。返回执行结果，如果发生异常，则将异常透传出来。

callable 对上下文变量所做的任何修改都会保留在上下文对象中:

var = ContextVar('var')
var.set('spam')

def main():
    # 'var' was set to 'spam' before
    # calling 'copy_context()' and 'ctx.run(main)', so:
    # var.get() == ctx[var] == 'spam'

    var.set('ham')

    # Now, after setting 'var' to 'ham':
    # var.get() == ctx[var] == 'ham'

ctx = copy_context()

# Any changes that the 'main' function makes to 'var'
# will be contained in 'ctx'.
ctx.run(main)

# The 'main()' function was run in the 'ctx' context,
# so changes to 'var' are contained in it:
# ctx[var] == 'ham'

# However, outside of 'ctx', 'var' is still set to 'spam':
# var.get() == 'spam'

当在多个系统线程或者递归调用同一个上下文对象的此方法，抛出 RuntimeError 异常。

copy()

返回此上下文对象的浅拷贝。

var in context

如果 context 中含有名称为 var 的变量，返回 True， 否则返回 False。

context[var]

返回名称为 var 的 ContextVar 变量。如果上下文对象中不包含这个变量，则抛出 KeyError 异常。

get(var[, default])

如果 var 在上下文对象中具有值则返回 var 的值。 在其他情况下返回 default。 如果未给出 default 则返回 None。

iter(context)

返回一个存储在上下文对象中的变量的迭代器。

len(proxy)

返回上下文对象中所设的变量的数量。

keys()

返回上下文对象中的所有变量的列表。

values()

返回上下文对象中所有变量值的列表。

items()

返回包含上下文对象中所有变量及其值的 2 元组的列表。

asyncio 支持

上下文变量在 asyncio 中有原生的支持并且无需任何额外配置即可被使用。 例如，以下是一个简单的回显服务器，它使用上下文变量来让远程客户端的地址在处理该客户端的 Task 中可用:

import asyncio
import contextvars

client_addr_var = contextvars.ContextVar('client_addr')

def render_goodbye():
    # The address of the currently handled client can be accessed
    # without passing it explicitly to this function.

    client_addr = client_addr_var.get()
    return f'Good bye, client @ {client_addr}\n'.encode()

async def handle_request(reader, writer):
    addr = writer.transport.get_extra_info('socket').getpeername()
    client_addr_var.set(addr)

    # In any code that we call is now possible to get
    # client's address by calling 'client_addr_var.get()'.

    while True:
        line = await reader.readline()
        print(line)
        if not line.strip():
            break
        writer.write(line)

    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())

# To test it you can use telnet:
#     telnet 127.0.0.1 8081

_thread --- 底层多线程 API

该模块提供了操作多个线程（也被称为 轻量级进程 或 任务）的底层原语 —— 多个控制线程共享全局数据空间。为了处理同步问题，也提供了简单的锁机制（也称为 互斥锁 或 二进制信号）。threading 模块基于该模块提供了更易用的高级多线程 API。

在 3.7 版更改: 这个模块曾经为可选项，但现在总是可用。

这个模块定义了以下常量和函数：

exception _thread.error

发生线程相关错误时抛出。

在 3.3 版更改: 现在是内建异常 RuntimeError 的别名。

_thread.LockType

锁对象的类型。

_thread.start_new_thread(function, args[, kwargs])

开启一个新线程并返回其标识。 线程执行函数 function 并附带参数列表 args (必须是元组)。 可选的 kwargs 参数指定一个关键字参数字典。

当函数返回时，线程会静默地退出。

当函数因某个未处理异常而终结时，sys.unraisablehook() 会被调用以处理异常。 钩子参数的 object 属性为 function。 在默认情况下，会打印堆栈回溯然后该线程将退出（但其他线程会继续运行）。

当函数引发 SystemExit 异常时，它会被静默地忽略。

在 3.8 版更改: 现在会使用 sys.unraisablehook() 来处理未处理的异常。

_thread.interrupt_main(signum=signal.SIGINT, /)

模拟一个信号到达主线程的效果。 线程可使用此函数来打断主线程，虽然并不保证打断将立即发生。

如果给出 signum，则表示要模拟的信号的编号。 如果未给出 signum，则将模拟 signal.SIGINT。

如果 Python 没有处理给定的信号 (它被设为 signal.SIG_DFL 或 signal.SIG_IGN)，此函数将不做任何操作。

在 3.10 版更改: 添加了 signum 参数来定制信号的编号。

注解

这并不会发出对应的信号而是将一个调用排入关联处理器的计划任务（如果句柄存在的话）。 如果你想要真的发出信号，请使用 signal.raise_signal()。

_thread.exit()

抛出 SystemExit 异常。如果没有捕获的话，这个异常会使线程退出。

_thread.allocate_lock()

返回一个新的锁对象。锁中的方法在后面描述。初始情况下锁处于解锁状态。

_thread.get_ident()

返回当前线程的 “线程标识符”。它是一个非零的整数。它的值没有直接含义，主要是用作 magic cookie，比如作为含有线程相关数据的字典的索引。线程标识符可能会在线程退出，新线程创建时被复用。

_thread.get_native_id()

返回内核分配给当前线程的原生集成线程 ID。 这是一个非负整数。 它的值可被用来在整个系统中唯一地标识这个特定线程（直到线程终结，在那之后该值可能会被 OS 回收再利用）。

可用性: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX。

3.8 新版功能.

_thread.stack_size([size])

返回创建线程时使用的堆栈大小。可选参数 size 指定之后新建的线程的堆栈大小，而且一定要是0（根据平台或者默认配置）或者最小是32,768(32KiB)的一个正整数。如果 size 没有指定，默认是0。如果不支持改变线程堆栈大小，会抛出 RuntimeError 错误。如果指定的堆栈大小不合法，会抛出 ValueError 错误并且不会修改堆栈大小。32KiB是当前最小的能保证解释器有足够堆栈空间的堆栈大小。需要注意的是部分平台对于堆栈大小会有特定的限制，例如要求大于32KiB的堆栈大小或者需要根据系统内存页面的整数倍进行分配 - 应当查阅平台文档有关详细信息（4KiB页面比较普遍，在没有更具体信息的情况下，建议的方法是使用4096的倍数作为堆栈大小）。

适用于: Windows，具有 POSIX 线程的系统。

_thread.TIMEOUT_MAX

Lock.acquire() 方法中 timeout 参数允许的最大值。传入超过这个值的 timeout 会抛出 OverflowError 异常。

3.2 新版功能.

锁对象有以下方法：

lock.acquire(blocking=True, timeout=- 1)

没有任何可选参数时，该方法无条件申请获得锁，有必要的话会等待其他线程释放锁（同时只有一个线程能获得锁 —— 这正是锁存在的原因）。

如果提供了 blocking 参数，具体的行为将取决于它的值：如果它为 False，则只在能够立即获取到锁而无需等待时才会获取，而如果它为 True，则会与上面一样无条件地获取锁。

如果提供了浮点数形式的 timeout 参数且为正值，它将指明在返回之前的最大等待秒数。 负的 timeout 参数值表示无限期的等待。 如果 blocking 为 False 则你不能指定 timeout。

如果成功获取到所会返回 True，否则返回 False。

在 3.2 版更改: 新的 timeout 形参。

在 3.2 版更改: 现在获取锁的操作可以被 POSIX 信号中断。

lock.release()

释放锁。锁必须已经被获取过，但不一定是同一个线程获取的。

lock.locked()

返回锁的状态：如果已被某个线程获取，返回 True，否则返回 False。

除了这些方法之外，锁对象也可以通过 with 语句使用，例如：

import _thread

a_lock = _thread.allocate_lock()

with a_lock:
    print("a_lock is locked while this executes")

注意事项：

线程与中断奇怪地交互：KeyboardInterrupt 异常可能会被任意一个线程捕获。（如果 signal 模块可用的话，中断总是会进入主线程。）

调用 sys.exit() 或是抛出 SystemExit 异常等效于调用 _thread.exit()。

不可能中断锁的 acquire() 方法 —— KeyboardInterrupt 一场会在锁获取到之后发生。

当主线程退出时，由系统决定其他线程是否存活。在大多数系统中，这些线程会直接被杀掉，不会执行 try ... finally 语句，也不会执行对象析构函数。

当主线程退出时，不会进行正常的清理工作（除非使用了 try ... finally 语句），标准 I/O 文件也不会刷新。

网络和进程间通信

本章介绍的模块提供了网络和进程间通信的机制。

某些模块仅适用于同一台机器上的两个进程，例如 signal 和 mmap 。 其他模块支持两个或多个进程可用于跨机器通信的网络协议。

本章中描述的模块列表是：

asyncio --- 异步 I/O

socket --- 底层网络接口

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

select --- 等待 I/O 完成

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

signal --- 设置异步事件处理程序

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

asyncio --- 异步 I/O

Hello World!

import asyncio

async def main():
    print('Hello ...')
    await asyncio.sleep(1)
    print('... World!')

asyncio.run(main())

asyncio 是用来编写 并发 代码的库，使用 async/await 语法。

asyncio 被用作多个提供高性能 Python 异步框架的基础，包括网络和网站服务，数据库连接库，分布式任务队列等等。

asyncio 往往是构建 IO 密集型和高层级 结构化 网络代码的最佳选择。

asyncio 提供一组 高层级 API 用于:

并发地 运行 Python 协程 并对其执行过程实现完全控制;

执行 网络 IO 和 IPC;

控制 子进程;

通过 队列 实现分布式任务;

同步 并发代码;

此外，还有一些 低层级 API 以支持 库和框架的开发者 实现:

创建和管理 事件循环，以提供异步 API 用于 网络化, 运行 子进程，处理 OS 信号 等等;

使用 transports 实现高效率协议;

通过 async/await 语法 桥接 基于回调的库和代码。

asyncio REPL

你可以在 REPL 中尝试使用 asyncio 并发上下文:

$ 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'

引发一个不带参数的 审计事件 cpython.run_stdin。

在 3.10.15 版更改: (also 3.9.20, and 3.8.20) Emits audit events.

参考

高层级 API

协程与任务

流

同步原语

子进程集

队列集

异常

低层级 API

事件循环

Futures

传输和协议

策略

平台支持

指南与教程

高层级 API 索引

低层级 API 索引

用 asyncio 开发

注解

asyncio 的源代码可以在 Lib/asyncio/ [https://github.com/python/cpython/tree/3.10/Lib/asyncio/] 中找到。

协程与任务

本节将简述用于协程与任务的高层级 API。

协程

可等待对象

运行 asyncio 程序

创建任务

休眠

并发运行任务

屏蔽取消操作

超时

简单等待

在线程中运行

跨线程调度

内省

Task 对象

基于生成器的协程

协程

源码： Lib/asyncio/coroutines.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/coroutines.py]

通过 async/await 语法来声明 协程 是编写 asyncio 应用的推荐方式。 例如，以下代码段会打印 "hello"，等待 1 秒，再打印 "world":

>>> import asyncio

>>> async def main():
...     print('hello')
...     await asyncio.sleep(1)
...     print('world')

>>> asyncio.run(main())
hello
world

注意：简单地调用一个协程并不会使其被调度执行

>>> main()
<coroutine object main at 0x1053bb7c8>

要实际运行协程，asyncio 提供了三种主要机制:

asyncio.run() 函数用来运行最高层级的入口点 "main()" 函数 (参见上面的示例。)

对协程执行 await。以下代码段会在等待 1 秒后打印 "hello"，然后 再次 等待 2 秒后打印 "world":

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())

预期的输出:

started at 17:13:52
hello
world
finished at 17:13:55

asyncio.create_task() 函数用来并发运行作为 asyncio 任务 的多个协程。

让我们修改以上示例，并发 运行两个 say_after 协程:

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')}")

    # Wait until both tasks are completed (should take
    # around 2 seconds.)
    await task1
    await task2

    print(f"finished at {time.strftime('%X')}")

注意，预期的输出显示代码段的运行时间比之前快了 1 秒:

started at 17:14:32
hello
world
finished at 17:14:34

可等待对象

如果一个对象可以在 await 语句中使用，那么它就是 可等待 对象。许多 asyncio API 都被设计为接受可等待对象。

可等待 对象有三种主要类型: 协程, 任务 和 Future.

协程

Python 协程属于 可等待 对象，因此可以在其他协程中被等待:

import asyncio

async def nested():
    return 42

async def main():
    # Nothing happens if we just call "nested()".
    # A coroutine object is created but not awaited,
    # so it *won't run at all*.
    nested()

    # Let's do it differently now and await it:
    print(await nested())  # will print "42".

asyncio.run(main())

重要

在本文档中 "协程" 可用来表示两个紧密关联的概念:

协程函数: 定义形式为 async def 的函数;

协程对象: 调用 协程函数 所返回的对象。

asyncio 也支持旧式的 基于生成器的 协程。

任务

任务 被用来“并行的”调度协程

当一个协程通过 asyncio.create_task() 等函数被封装为一个 任务，该协程会被自动调度执行:

import asyncio

async def nested():
    return 42

async def main():
    # Schedule nested() to run soon concurrently
    # with "main()".
    task = asyncio.create_task(nested())

    # "task" can now be used to cancel "nested()", or
    # can simply be awaited to wait until it is complete:
    await task

asyncio.run(main())

Futures

Future 是一种特殊的 低层级 可等待对象，表示一个异步操作的 最终结果。

当一个 Future 对象 被等待，这意味着协程将保持等待直到该 Future 对象在其他地方操作完毕。

在 asyncio 中需要 Future 对象以便允许通过 async/await 使用基于回调的代码。

通常情况下 没有必要 在应用层级的代码中创建 Future 对象。

Future 对象有时会由库和某些 asyncio API 暴露给用户，用作可等待对象:

async def main():
    await function_that_returns_a_future_object()

    # this is also valid:
    await asyncio.gather(
        function_that_returns_a_future_object(),
        some_python_coroutine()
    )

一个很好的返回对象的低层级函数的示例是 loop.run_in_executor()。

运行 asyncio 程序

asyncio.run(coro, *, debug=False)

执行 coroutine coro 并返回结果。

此函数会运行传入的协程，负责管理 asyncio 事件循环，终结异步生成器，并关闭线程池。

当有其他 asyncio 事件循环在同一线程中运行时，此函数不能被调用。

如果 debug 为 True，事件循环将以调试模式运行。

此函数总是会创建一个新的事件循环并在结束时关闭之。它应当被用作 asyncio 程序的主入口点，理想情况下应当只被调用一次。

示例:

async def main():
    await asyncio.sleep(1)
    print('hello')

asyncio.run(main())

3.7 新版功能.

在 3.9 版更改: 更新为使用 loop.shutdown_default_executor()。

注解

asyncio.run() 的源代码可以在 Lib/asyncio/runners.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/runners.py] 中找到。

创建任务

源码： Lib/asyncio/tasks.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/tasks.py]

asyncio.create_task(coro, *, name=None)

将 coro 协程 封装为一个 Task 并调度其执行。返回 Task 对象。

name 不为 None，它将使用 Task.set_name() 来设为任务的名称。

该任务会在 get_running_loop() 返回的循环中执行，如果当前线程没有在运行的循环则会引发 RuntimeError。

重要

保存一个指向此函数的结果的引用，以避免任务在执行过程中消失。 事件循环将只保留对任务的弱引用。 未在其他地方被引用的任务可能在任何时候被作为垃圾回收，即使是在它被完成之前。 如果需要可靠的“发射后不用管”后台任务，请将它们放到一个多项集中:

background_tasks = set()

for i in range(10):
    task = asyncio.create_task(some_coro(param=i))

    # Add task to the set. This creates a strong reference.
    background_tasks.add(task)

    # To prevent keeping references to finished tasks forever,
    # make each task remove its own reference from the set after
    # completion:
    task.add_done_callback(background_tasks.discard)

3.7 新版功能.

在 3.8 版更改: 增加了 name 形参。

休眠

coroutine asyncio.sleep(delay, result=None)

阻塞 delay 指定的秒数。

如果指定了 result，则当协程完成时将其返回给调用者。

sleep() 总是会挂起当前任务，以允许其他任务运行。

将 delay 设为 0 将提供一个经优化的路径以允许其他任务运行。 这可供长期间运行的函数使用以避免在函数调用的全过程中阻塞事件循环。

Deprecated since version 3.8, removed in version 3.10: loop 形参。 这个函数从 3.7 开始就会隐式地获取当前正在运行的事件循环。 更多信息请参阅 3.10 有什么新变化的“已移除内容”章节。

以下协程示例运行 5 秒，每秒显示一次当前日期:

import asyncio
import datetime

async def display_date():
    loop = asyncio.get_running_loop()
    end_time = loop.time() + 5.0
    while True:
        print(datetime.datetime.now())
        if (loop.time() + 1.0) >= end_time:
            break
        await asyncio.sleep(1)

asyncio.run(display_date())

在 3.10 版更改: 移除了 loop 形参。

并发运行任务

awaitable asyncio.gather(*aws, return_exceptions=False)

并发 运行 aws 序列中的 可等待对象。

如果 aws 中的某个可等待对象为协程，它将自动被作为一个任务调度。

如果所有可等待对象都成功完成，结果将是一个由所有返回值聚合而成的列表。结果值的顺序与 aws 中可等待对象的顺序一致。

如果 return_exceptions 为 False (默认)，所引发的首个异常会立即传播给等待 gather() 的任务。aws 序列中的其他可等待对象 不会被取消 并将继续运行。

如果 return_exceptions 为 True，异常会和成功的结果一样处理，并聚合至结果列表。

如果 gather() 被取消，所有被提交 (尚未完成) 的可等待对象也会 被取消。

如果 aws 序列中的任一 Task 或 Future 对象 被取消，它将被当作引发了 CancelledError 一样处理 -- 在此情况下 gather() 调用 不会 被取消。这是为了防止一个已提交的 Task/Future 被取消导致其他 Tasks/Future 也被取消。

在 3.10 版更改: 移除了 loop 形参。

示例:

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():
    # Schedule three calls *concurrently*:
    L = await asyncio.gather(
        factorial("A", 2),
        factorial("B", 3),
        factorial("C", 4),
    )
    print(L)

asyncio.run(main())

# Expected output:
#
#     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]

注解

如果 return_exceptions 为 False，则在 gather() 被标记为已完成后取消它将不会取消任何已提交的可等待对象。 例如，在将一个异常传播给调用者之后，gather 可被标记为已完成，因此，在从 gather 捕获一个（由可等待对象所引发的）异常之后调用 gather.cancel() 将不会取消任何其他可等待对象。

在 3.7 版更改: 如果 gather 本身被取消，则无论 return_exceptions 取值为何，消息都会被传播。

在 3.10 版更改: 移除了 loop 形参。

3.10 版后已移除: 如果未提供位置参数或者并非所有位置参数均为 Future 类对象并且没有正在运行的事件循环则会发出弃用警告。

屏蔽取消操作

awaitable asyncio.shield(aw)

保护一个 可等待对象 防止其被 取消。

如果 aw 是一个协程，它将自动被作为任务调度。

以下语句:

task = asyncio.create_task(something())
res = await shield(task)

相当于:

res = await something()

不同之处 在于如果包含它的协程被取消，在 something() 中运行的任务不会被取消。从 something() 的角度看来，取消操作并没有发生。然而其调用者已被取消，因此 "await" 表达式仍然会引发 CancelledError。

如果通过其他方式取消 something() (例如在其内部操作) 则 shield() 也会取消。

如果希望完全忽略取消操作 (不推荐) 则 shield() 函数需要配合一个 try/except 代码段，如下所示:

task = asyncio.create_task(something())
try:
    res = await shield(task)
except CancelledError:
    res = None

重要

保存一个传给此函数的任务的引用，以避免任务在执行过程中消失。 事件循环将只保留对任务的弱引用。 未在其他地方被引用的任务可能在任何时候被作为垃圾回收，即使是在它被完成之前。

在 3.10 版更改: 移除了 loop 形参。

3.10 版后已移除: 如果 aw 不是 Future 类对象并且没有正在运行的事件循环则会发出弃用警告。

超时

coroutine asyncio.wait_for(aw, timeout)

等待 aw 可等待对象 完成，指定 timeout 秒数后超时。

如果 aw 是一个协程，它将自动被作为任务调度。

timeout 可以为 None，也可以为 float 或 int 型数值表示的等待秒数。如果 timeout 为 None，则等待直到完成。

如果发生超时，任务将取消并引发 asyncio.TimeoutError.

要避免任务 取消，可以加上 shield()。

此函数将等待直到 Future 确实被取消，所以总等待时间可能超过 timeout。 如果在取消期间发生了异常，异常将会被传播。

如果等待被取消，则 aw 指定的对象也会被取消。

在 3.10 版更改: 移除了 loop 形参。

示例:

async def eternity():
    # Sleep for one hour
    await asyncio.sleep(3600)
    print('yay!')

async def main():
    # Wait for at most 1 second
    try:
        await asyncio.wait_for(eternity(), timeout=1.0)
    except asyncio.TimeoutError:
        print('timeout!')

asyncio.run(main())

# Expected output:
#
#     timeout!

在 3.7 版更改: 当 aw 因超时被取消，wait_for 会等待 aw 被取消。之前版本则将立即引发 asyncio.TimeoutError。

在 3.10 版更改: 移除了 loop 形参。

简单等待

coroutine asyncio.wait(aws, *, timeout=None, return_when=ALL_COMPLETED)

并发地运行 aws 可迭代对象中的 可等待对象 并进入阻塞状态直到满足 return_when 所指定的条件。

aws 可迭代对象必须不为空。

返回两个 Task/Future 集合: (done, pending)。

用法：

done, pending = await asyncio.wait(aws)

如指定 timeout (float 或 int 类型) 则它将被用于控制返回之前等待的最长秒数。

请注意此函数不会引发 asyncio.TimeoutError。当超时发生时，未完成的 Future 或 Task 将在指定秒数后被返回。

return_when 指定此函数应在何时返回。它必须为以下常数之一:

常量 | 描述
FIRST_COMPLETED | 函数将在任意可等待对象结束或取消时返回。
FIRST_EXCEPTION | 函数将在任意可等待对象因引发异常而结束时返回。当没有引发任何异常时它就相当于 ALL_COMPLETED。
ALL_COMPLETED | 函数将在所有可等待对象结束或取消时返回。

与 wait_for() 不同，wait() 在超时发生时不会取消可等待对象。

3.8 版后已移除: 如果 aws 中的某个可等待对象为协程，它将自动被作为任务调度。直接向 wait() 传入协程对象已弃用，因为这会导致 令人迷惑的行为。

在 3.10 版更改: 移除了 loop 形参。

注解

wait() 会自动以任务的形式调度协程，之后将以 (done, pending) 集合形式返回显式创建的任务对象。因此以下代码并不会有预期的行为:

async def foo():
    return 42

coro = foo()
done, pending = await asyncio.wait({coro})

if coro in done:
    # This branch will never be run!

以上代码段的修正方法如下:

async def foo():
    return 42

task = asyncio.create_task(foo())
done, pending = await asyncio.wait({task})

if task in done:
    # Everything will work as expected now.

Deprecated since version 3.8, will be removed in version 3.11: 直接向 wait() 传入协程对象的方式已弃用。

在 3.10 版更改: 移除了 loop 形参。

asyncio.as_completed(aws, *, timeout=None)

并发地运行 aws 可迭代对象中的 可等待对象。 返回一个协程的迭代器。 所返回的每个协程可被等待以从剩余的可等待对象的可迭代对象中获得最早的下一个结果。

如果在所有 Future 对象完成前发生超时则将引发 asyncio.TimeoutError。

示例:

for coro in as_completed(aws):
    earliest_result = await coro
    # ...

在 3.10 版更改: 移除了 loop 形参。

3.10 版后已移除: 如果 aws 可迭代对象中的可等待对象不全为 Future 类对象并且没有正在运行的事件循环则会发出弃用警告。

在线程中运行

coroutine asyncio.to_thread(func, /, *args, **kwargs)

在不同的线程中异步地运行函数 func。

向此函数提供的任何 *args 和 **kwargs 会被直接传给 func。 并且，当前 contextvars.Context 会被传播，允许在不同的线程中访问来自事件循环的上下文变量。

返回一个可被等待以获取 func 的最终结果的协程。

这个协程函数主要是用于执行在其他情况下会阻塞事件循环的 IO 密集型函数/方法。 例如:

def blocking_io():
    print(f"start blocking_io at {time.strftime('%X')}")
    # Note that time.sleep() can be replaced with any blocking
    # IO-bound operation, such as file operations.
    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())

# Expected output:
#
# 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

在任何协程中直接调用 blocking_io() 将会在调用期间阻塞事件循环，导致额外的 1 秒运行时间。 但是，通过改用 asyncio.to_thread()，我们可以在单独的线程中运行它从而不会阻塞事件循环。

注解

由于 GIL 的存在，asyncio.to_thread() 通常只能被用来将 IO 密集型函数变为非阻塞的。 但是，对于会释放 GIL 的扩展模块或无此限制的替代性 Python 实现来说，asyncio.to_thread() 也可被用于 CPU 密集型函数。

3.9 新版功能.

跨线程调度

asyncio.run_coroutine_threadsafe(coro, loop)

向指定事件循环提交一个协程。（线程安全）

返回一个 concurrent.futures.Future 以等待来自其他 OS 线程的结果。

此函数应该从另一个 OS 线程中调用，而非事件循环运行所在线程。示例:

# Create a coroutine
coro = asyncio.sleep(1, result=3)

# Submit the coroutine to a given loop
future = asyncio.run_coroutine_threadsafe(coro, loop)

# Wait for the result with an optional timeout argument
assert future.result(timeout) == 3

如果在协程内产生了异常，将会通知返回的 Future 对象。它也可被用来取消事件循环中的任务:

try:
    result = future.result(timeout)
except concurrent.futures.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}')

参见 concurrency and multithreading 部分的文档。

不同于其他 asyncio 函数，此函数要求显式地传入 loop 参数。

3.5.1 新版功能.

内省

asyncio.current_task(loop=None)

返回当前运行的 Task 实例，如果没有正在运行的任务则返回 None。

如果 loop 为 None 则会使用 get_running_loop() 获取当前事件循环。

3.7 新版功能.

asyncio.all_tasks(loop=None)

返回事件循环所运行的未完成的 Task 对象的集合。

如果 loop 为 None，则会使用 get_running_loop() 获取当前事件循环。

3.7 新版功能.

Task 对象

class asyncio.Task(coro, *, loop=None, name=None)

一个与 Future 类似 的对象，可运行 Python 协程。非线程安全。

Task 对象被用来在事件循环中运行协程。如果一个协程在等待一个 Future 对象，Task 对象会挂起该协程的执行并等待该 Future 对象完成。当该 Future 对象 完成，被打包的协程将恢复执行。

事件循环使用协同日程调度: 一个事件循环每次运行一个 Task 对象。而一个 Task 对象会等待一个 Future 对象完成，该事件循环会运行其他 Task、回调或执行 IO 操作。

使用高层级的 asyncio.create_task() 函数来创建 Task 对象，也可用低层级的 loop.create_task() 或 ensure_future() 函数。不建议手动实例化 Task 对象。

要取消一个正在运行的 Task 对象可使用 cancel() 方法。调用此方法将使该 Task 对象抛出一个 CancelledError 异常给打包的协程。如果取消期间一个协程正在对 Future 对象执行 await，该 Future 对象也将被取消。

cancelled() 可被用来检测 Task 对象是否被取消。如果打包的协程没有抑制 CancelledError 异常并且确实被取消，该方法将返回 True。

asyncio.Task 从 Future 继承了其除 Future.set_result() 和 Future.set_exception() 以外的所有 API。

Task 对象支持 contextvars 模块。当一个 Task 对象被创建，它将复制当前上下文，然后在复制的上下文中运行其协程。

在 3.7 版更改: 加入对 contextvars 模块的支持。

在 3.8 版更改: 增加了 name 形参。

3.10 版后已移除: 如果未指定 loop 并且没有正在运行的事件循环则会发出弃用警告。

cancel(msg=None)

请求取消 Task 对象。

这将安排在下一轮事件循环中抛出一个 CancelledError 异常给被封包的协程。

协程在之后有机会进行清理甚至使用 try ... ... except CancelledError ... finally 代码块抑制异常来拒绝请求。不同于 Future.cancel()，Task.cancel() 不保证 Task 会被取消，虽然抑制完全取消并不常见，也很不鼓励这样做。

在 3.9 版更改: 增加了 msg 形参。

以下示例演示了协程是如何侦听取消请求的:

async def cancel_me():
    print('cancel_me(): before sleep')

    try:
        # Wait for 1 hour
        await asyncio.sleep(3600)
    except asyncio.CancelledError:
        print('cancel_me(): cancel sleep')
        raise
    finally:
        print('cancel_me(): after sleep')

async def main():
    # Create a "cancel_me" Task
    task = asyncio.create_task(cancel_me())

    # Wait for 1 second
    await asyncio.sleep(1)

    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("main(): cancel_me is cancelled now")

asyncio.run(main())

# Expected output:
#
#     cancel_me(): before sleep
#     cancel_me(): cancel sleep
#     cancel_me(): after sleep
#     main(): cancel_me is cancelled now

cancelled()

如果 Task 对象 被取消 则返回 True。

当使用 cancel() 发出取消请求时 Task 会被 取消，其封包的协程将传播被抛入的 CancelledError 异常。

done()

如果 Task 对象 已完成 则返回 True。

当 Task 所封包的协程返回一个值、引发一个异常或 Task 本身被取消时，则会被认为 已完成。

result()

返回 Task 的结果。

如果 Task 对象 已完成，其封包的协程的结果会被返回 (或者当协程引发异常时，该异常会被重新引发。)

如果 Task 对象 被取消，此方法会引发一个 CancelledError 异常。

如果 Task 对象的结果还不可用，此方法会引发一个 InvalidStateError 异常。

exception()

返回 Task 对象的异常。

如果所封包的协程引发了一个异常，该异常将被返回。如果所封包的协程正常返回则该方法将返回 None。

如果 Task 对象 被取消，此方法会引发一个 CancelledError 异常。

如果 Task 对象尚未 完成，此方法将引发一个 InvalidStateError 异常。

add_done_callback(callback, *, context=None)

添加一个回调，将在 Task 对象 完成 时被运行。

此方法应该仅在低层级的基于回调的代码中使用。

要了解更多细节请查看 Future.add_done_callback() 的文档。

remove_done_callback(callback)

从回调列表中移除 callback 。

此方法应该仅在低层级的基于回调的代码中使用。

要了解更多细节请查看 Future.remove_done_callback() 的文档。

get_stack(*, limit=None)

返回此 Task 对象的栈框架列表。

如果所封包的协程未完成，这将返回其挂起所在的栈。如果协程已成功完成或被取消，这将返回一个空列表。如果协程被一个异常终止，这将返回回溯框架列表。

框架总是从按从旧到新排序。

每个被挂起的协程只返回一个栈框架。

可选的 limit 参数指定返回框架的数量上限；默认返回所有框架。返回列表的顺序要看是返回一个栈还是一个回溯：栈返回最新的框架，回溯返回最旧的框架。(这与 traceback 模块的行为保持一致。)

print_stack(*, limit=None, file=None)

打印此 Task 对象的栈或回溯。

此方法产生的输出类似于 traceback 模块通过 get_stack() 所获取的框架。

limit 参数会直接传递给 get_stack()。

file 参数是输出所写入的 I/O 流；在默认情况下输出会写入到 sys.stdout。

get_coro()

返回由 Task 包装的协程对象。

3.8 新版功能.

get_name()

返回 Task 的名称。

如果没有一个 Task 名称被显式地赋值，默认的 asyncio Task 实现会在实例化期间生成一个默认名称。

3.8 新版功能.

set_name(value)

设置 Task 的名称。

value 参数可以为任意对象，它随后会被转换为字符串。

在默认的 Task 实现中，名称将在任务对象的 repr() 输出中可见。

3.8 新版功能.

基于生成器的协程

注解

对基于生成器的协程的支持已被 弃用 并将在 Python 3.11 中被移除。

基于生成器的协程是 async/await 语法的前身。它们是使用 yield from 语句创建的 Python 生成器，可以等待 Future 和其他协程。

基于生成器的协程应该使用 @asyncio.coroutine 装饰，虽然这并非强制。

@asyncio.coroutine

用来标记基于生成器的协程的装饰器。

此装饰器使得旧式的基于生成器的协程能与 async/await 代码相兼容:

@asyncio.coroutine
def old_style_coroutine():
    yield from asyncio.sleep(1)

async def main():
    await old_style_coroutine()

此装饰器不应该被用于 async def 协程。

Deprecated since version 3.8, will be removed in version 3.11: 请改用 async def。

asyncio.iscoroutine(obj)

如果 obj 是一个 协程对象 则返回 True。

此方法不同于 inspect.iscoroutine() 因为它对基于生成器的协程返回 True。

asyncio.iscoroutinefunction(func)

如果 func 是一个 协程函数 则返回 True。

此方法不同于 inspect.iscoroutinefunction() 因为它对以 @coroutine 装饰的基于生成器的协程函数返回 True。

流

源码: Lib/asyncio/streams.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/streams.py]

流是用于处理网络连接的支持 async/await 的高层级原语。 流允许发送和接收数据，而不需要使用回调或低级协议和传输。

下面是一个使用 asyncio streams 编写的 TCP echo 客户端示例:

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!'))

参见下面的 Examples 部分。

Stream 函数

下面的高级 asyncio 函数可以用来创建和处理流:

coroutine 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, happy_eyeballs_delay=None, interleave=None)

建立网络连接并返回一对 (reader, writer) 对象。

返回的 reader 和 writer 对象是 StreamReader 和 StreamWriter 类的实例。

limit 确定返回的 StreamReader 实例使用的缓冲区大小限制。默认情况下，limit 设置为 64 KiB 。

其余的参数直接传递到 loop.create_connection() 。

注解

sock 参数可将套接字的所有权转给所创建的 StreamWriter。 要关闭该套接字，请调用其 close() 方法。

在 3.7 版更改: 添加了 ssl_handshake_timeout 形参。

3.8 新版功能: 增加了 happy_eyeballs_delay 和 interleave 形参。

在 3.10 版更改: 移除了 loop 形参。

coroutine 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, ssl_handshake_timeout=None, start_serving=True)

启动套接字服务。

当一个新的客户端连接被建立时，回调函数 client_connected_cb 会被调用。该函数会接收到一对参数 (reader, writer) ，reader是类 StreamReader 的实例，而writer是类 StreamWriter 的实例。

client_connected_cb 即可以是普通的可调用对象也可以是一个 协程函数; 如果它是一个协程函数，它将自动作为 Task 被调度。

limit 确定返回的 StreamReader 实例使用的缓冲区大小限制。默认情况下，limit 设置为 64 KiB 。

余下的参数将会直接传递给 loop.create_server().

注解

sock 参数可将套接字的所有权转给所创建的服务器。 要关闭该套接字，请调用服务器的 close() 方法。

在 3.7 版更改: 增加了 ssl_handshake_timeout 和 start_serving 形参。

在 3.10 版更改: 移除了 loop 形参。

Unix 套接字

coroutine asyncio.open_unix_connection(path=None, *, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None)

建立一个 Unix 套接字连接并返回 (reader, writer) 这对返回值。

与 open_connection() 相似，但是是在 Unix 套接字上的操作。

请看文档 loop.create_unix_connection().

注解

sock 参数可将套接字的所有权转给所创建的 StreamWriter。 要关闭该套接字，请调用其 close() 方法。

可用性: Unix。

在 3.7 版更改: 增加了 ssl_handshake_timeout 形参。 现在 path 形参可以是一个 path-like object

在 3.10 版更改: 移除了 loop 形参。

coroutine asyncio.start_unix_server(client_connected_cb, path=None, *, limit=None, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, start_serving=True)

启动一个 Unix 套接字服务。

与 start_server() 相似，但是是在 Unix 套接字上的操作。

请看文档 loop.create_unix_server().

注解

sock 参数可将套接字的所有权转给所创建的服务器。 要关闭该套接字，请调用服务器的 close() 方法。

可用性: Unix。

在 3.7 版更改: 增加了 ssl_handshake_timeout 和 start_serving 形参。 现在 path 形参可以是一个 path-like object。

在 3.10 版更改: 移除了 loop 形参。

StreamReader

class asyncio.StreamReader

代表一个提供从 IO 流读取数据的 API 的读取器。 作为一个 asynchronous iterable，该对象支持 async for 语句。

不推荐直接实例化 StreamReader 对象，建议使用 open_connection() 和 start_server() 来获取 StreamReader 实例。

coroutine read(n=- 1)

从流读取至多 n 个字节。

如果未提供 n 或是设为 -1，则一直读取到 EOF，然后返回所读取的全部 bytes。 如果收到 EOF 并且内部缓冲区为空，则返回一个空 bytes 对象。object.

如果 n 为 0，则立即返回一个空 bytes 对象。

如果 n 为正值，则一旦内部缓冲区有至少 1 个字节可用就返回至多 n 个可用的 bytes。 如果在读取任何字节之前收到 EOF，则返回一个空 bytes 对象。

coroutine readline()

读取一行，其中“行”指的是以 \n 结尾的字节序列。

如果读到EOF而没有找到 \n ，该方法返回部分读取的数据。

如果读到EOF，且内部缓冲区为空，则返回一个空的 bytes 对象。

coroutine readexactly(n)

精确读取 n 个 bytes，不会超过也不能少于。

如果在读取完 n 个byte之前读取到EOF，则会引发 IncompleteReadError 异常。使用 IncompleteReadError.partial 属性来获取到达流结束之前读取的 bytes 字符串。

coroutine readuntil(separator=b'\n')

从流中读取数据直至遇到 separator

成功后，数据和指定的separator将从内部缓冲区中删除(或者说被消费掉)。返回的数据将包括在末尾的指定separator。

如果读取的数据量超过了配置的流限制，将引发 LimitOverrunError 异常，数据将留在内部缓冲区中并可以再次读取。

如果在找到完整的separator之前到达EOF，则会引发 IncompleteReadError 异常，并重置内部缓冲区。 IncompleteReadError.partial 属性可能包含指定separator的一部分。

3.5.2 新版功能.

at_eof()

如果缓冲区为空并且 feed_eof() 被调用，则返回 True 。

StreamWriter

class asyncio.StreamWriter

这个类表示一个写入器对象，该对象提供api以便于写数据至IO流中。

不建议直接实例化 StreamWriter；而应改用 open_connection() 和 start_server()。

write(data)

此方法会尝试立即将 data 写入到下层的套接字。 如果写入失败，数据会被排入内部写缓冲队列直到可以被发送。

此方法应当与 drain() 方法一起使用:

stream.write(data)
await stream.drain()

writelines(data)

此方法会立即尝试将一个字节串列表（或任何可迭代对象）写入到下层的套接字。 如果写入失败，数据会被排入内部写缓冲队列直到可以被发送。

此方法应当与 drain() 方法一起使用:

stream.writelines(lines)
await stream.drain()

close()

此方法会关闭流以及下层的套接字。

此方法应当于 wait_closed() 方法一起使用，但这并非强制要求:

stream.close()
await stream.wait_closed()

can_write_eof()

如果下层的传输支持 write_eof() 方法则返回 True，否则返回 False。

write_eof()

在已缓冲的写入数据被刷新后关闭流的写入端。

transport

返回下层的 asyncio 传输。

get_extra_info(name, default=None)

访问可选的传输信息；详情参见 BaseTransport.get_extra_info()。

coroutine drain()

等待直到可以适当地恢复写入到流。 示例:

writer.write(data)
await writer.drain()

这是一个与下层的 IO 写缓冲区进行交互的流程控制方法。 当缓冲区大小达到最高水位（最大上限）时，drain() 会阻塞直到缓冲区大小减少至最低水位以便恢复写入。 当没有要等待的数据时，drain() 会立即返回。

is_closing()

如果流已被关闭或正在被关闭则返回 True。

3.7 新版功能.

coroutine wait_closed()

等待直到流被关闭。

应当在 close() 之后调用以等待直到下层连接被关闭，确保所有数据在退出程序之前已刷新。

3.7 新版功能.

例子

使用流的 TCP 回显客户端

使用 asyncio.open_connection() 函数的 TCP 回显客户端:

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())

    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!'))

参见

使用低层级 loop.create_connection() 方法的 TCP 回显客户端协议 示例。

使用流的 TCP 回显服务器

TCP 回显服务器使用 asyncio.start_server() 函数:

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())

参见

使用 loop.create_server() 方法的 TCP 回显服务器协议 示例。

获取 HTTP 标头

查询命令行传入 URL 的 HTTP 标头的简单示例:

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))

用法：

python example.py http://example.com/path/page.html

或使用 HTTPS:

python example.py https://example.com/path/page.html

注册一个打开的套接字以等待使用流的数据

使用 open_connection() 函数实现等待直到套接字接收到数据的协程:

import asyncio
import socket

async def wait_for_data():
    # Get a reference to the current event loop because
    # we want to access low-level APIs.
    loop = asyncio.get_running_loop()

    # Create a pair of connected sockets.
    rsock, wsock = socket.socketpair()

    # Register the open socket to wait for data.
    reader, writer = await asyncio.open_connection(sock=rsock)

    # Simulate the reception of data from the network
    loop.call_soon(wsock.send, 'abc'.encode())

    # Wait for data
    data = await reader.read(100)

    # Got data, we are done: close the socket
    print("Received:", data.decode())
    writer.close()
    await writer.wait_closed()

    # Close the second socket
    wsock.close()

asyncio.run(wait_for_data())

参见

使用低层级协议以及 loop.create_connection() 方法的 注册一个打开的套接字以等待使用协议的数据 示例。

使用低层级的 loop.add_reader() 方法来监视文件描述符的 监视文件描述符以读取事件 示例。

同步原语

源代码: Lib/asyncio/locks.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/locks.py]

asyncio 同步原语被设计为与 threading 模块的类似，但有两个关键注意事项:

asyncio 原语不是线程安全的，因此它们不应被用于 OS 线程同步 (而应当使用 threading)；

这些同步原语的方法不接受 timeout 参数；请使用 asyncio.wait_for() 函数来执行带有超时的操作。

asyncio 具有下列基本同步原语:

Lock

Event

Condition

Semaphore

BoundedSemaphore

Lock

class asyncio.Lock

实现一个用于 asyncio 任务的互斥锁。 非线程安全。

asyncio 锁可被用来保证对共享资源的独占访问。

使用 Lock 的推荐方式是通过 async with 语句:

lock = asyncio.Lock()

# ... later
async with lock:
    # access shared state

这等价于:

lock = asyncio.Lock()

# ... later
await lock.acquire()
try:
    # access shared state
finally:
    lock.release()

在 3.10 版更改: 移除了 loop 形参。

coroutine acquire()

获取锁。

此方法会等待直至锁为 unlocked，将其设为 locked 并返回 True。

当有一个以上的协程在 acquire() 中被阻塞则会等待解锁，最终只有一个协程会被执行。

锁的获取是 公平的: 被执行的协程将是第一个开始等待锁的协程。

release()

释放锁。

当锁为 locked 时，将其设为 unlocked 并返回。

如果锁为 unlocked，则会引发 RuntimeError。

locked()

如果锁为 locked 则返回 True。

事件

class asyncio.Event

事件对象。 该对象不是线程安全的。

asyncio 事件可被用来通知多个 asyncio 任务已经有事件发生。

Event 对象会管理一个内部旗标，可通过 set() 方法将其设为 true 并通过 clear() 方法将其重设为 false。 wait() 方法会阻塞直至该旗标被设为 true。 该旗标初始时会被设为 false。

在 3.10 版更改: 移除了 loop 形参。

示例:

async def waiter(event):
    print('waiting for it ...')
    await event.wait()
    print('... got it!')

async def main():
    # Create an Event object.
    event = asyncio.Event()

    # Spawn a Task to wait until 'event' is set.
    waiter_task = asyncio.create_task(waiter(event))

    # Sleep for 1 second and set the event.
    await asyncio.sleep(1)
    event.set()

    # Wait until the waiter task is finished.
    await waiter_task

asyncio.run(main())

coroutine wait()

等待直至事件被设置。

如果事件已被设置，则立即返回 True。 否则将阻塞直至另一个任务调用 set()。

set()

设置事件。

所有等待事件被设置的任务将被立即唤醒。

clear()

清空（取消设置）事件。

通过 wait() 进行等待的任务现在将会阻塞直至 set() 方法被再次调用。

is_set()

如果事件已被设置则返回 True。

Condition

class asyncio.Condition(lock=None)

条件对象。 该对象不是线程安全的。

asyncio 条件原语可被任务用于等待某个事件发生，然后获取对共享资源的独占访问。

在本质上，Condition 对象合并了 Event 和 Lock 的功能。 多个 Condition 对象有可能共享一个 Lock，这允许关注于共享资源的特定状态的不同任务实现对共享资源的协同独占访问。

可选的 lock 参数必须为 Lock 对象或 None。 在后一种情况下会自动创建一个新的 Lock 对象。

在 3.10 版更改: 移除了 loop 形参。

使用 Condition 的推荐方式是通过 async with 语句:

cond = asyncio.Condition()

# ... later
async with cond:
    await cond.wait()

这等价于:

cond = asyncio.Condition()

# ... later
await cond.acquire()
try:
    await cond.wait()
finally:
    cond.release()

coroutine acquire()

获取下层的锁。

此方法会等待直至下层的锁为 unlocked，将其设为 locked 并返回 returns True。

notify(n=1)

唤醒最多 n 个正在等待此条件的任务（默认为 1 个）。 如果没有任务正在等待则此方法为空操作。

锁必须在此方法被调用前被获取并在随后被快速释放。 如果通过一个 unlocked 锁调用则会引发 RuntimeError。

locked()

如果下层的锁已被获取则返回 True。

notify_all()

唤醒所有正在等待此条件的任务。

此方法的行为类似于 notify()，但会唤醒所有正在等待的任务。

锁必须在此方法被调用前被获取并在随后被快速释放。 如果通过一个 unlocked 锁调用则会引发 RuntimeError。

release()

释放下层的锁。

当在未锁定的锁上唤起时，会引发 RuntimeError。

coroutine wait()

等待直至收到通知。

当此方法被调用时如果调用方任务未获得锁，则会引发 RuntimeError。

这个方法会释放下层的锁，然后保持阻塞直到被 notify() 或 notify_all() 调用所唤醒。 一旦被唤醒，Condition 会重新获取它的锁并且此方法将返回 True。

coroutine wait_for(predicate)

等待直到目标值变为 true。

目标必须为一个可调用对象，其结果将被解读为一个布尔值。 最终的值将为返回值。

Semaphore

class asyncio.Semaphore(value=1)

信号量对象。 该对象不是线程安全的。

信号量会管理一个内部计数器，该计数器会随每次 acquire() 调用递减并随每次 release() 调用递增。 计数器的值永远不会降到零以下；当 acquire() 发现其值为零时，它将保持阻塞直到有某个任务调用了 release()。

可选的 value 参数用来为内部计数器赋初始值 (默认值为 1)。 如果给定的值小于 0 则会引发 ValueError。

在 3.10 版更改: 移除了 loop 形参。

使用 Semaphore 的推荐方式是通过 async with 语句。:

sem = asyncio.Semaphore(10)

# ... later
async with sem:
    # work with shared resource

这等价于:

sem = asyncio.Semaphore(10)

# ... later
await sem.acquire()
try:
    # work with shared resource
finally:
    sem.release()

coroutine acquire()

获取一个信号量。

如果内部计数器的值大于零，则将其减一并立即返回 True。 如果其值为零，则会等待直到 release() 并调用并返回 True。

locked()

如果信号量对象无法被立即获取则返回 True。

release()

释放一个信号量对象，将内部计数器的值加一。 可以唤醒一个正在等待获取信号量对象的任务。

不同于 BoundedSemaphore，Semaphore 允许执行的 release() 调用多于 acquire() 调用。

BoundedSemaphore

class asyncio.BoundedSemaphore(value=1)

绑定的信号量对象。 该对象不是线程安全的。

BoundedSemaphore 是特殊版本的 Semaphore，如果在 release() 中内部计数器值增加到初始 value 以上它将引发一个 ValueError。

在 3.10 版更改: 移除了 loop 形参。

在 3.9 版更改: 使用 await lock 或 yield from lock 以及/或者 with 语句 (with await lock, with (yield from lock)) 来获取锁的操作已被移除。 请改用 async with lock。

子进程集

源代码: Lib/asyncio/subprocess.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/subprocess.py], Lib/asyncio/base_subprocess.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/base_subprocess.py]

本节介绍了用于创建和管理子进程的高层级 async/await asyncio API。

下面的例子演示了如何用 asyncio 运行一个 shell 命令并获取其结果:

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'))

将打印:

['ls /zzz' exited with 1]
[stderr]
ls: /zzz: No such file or directory

由于所有 asyncio 子进程函数都是异步的并且 asyncio 提供了许多工具用来配合这些函数使用，因此并行地执行和监视多个子进程十分容易。 要修改上面的例子来同时运行多个命令确实是非常简单的:

async def main():
    await asyncio.gather(
        run('ls /zzz'),
        run('sleep 1; echo "hello"'))

asyncio.run(main())

另请参阅 Examples 小节。

创建子进程

coroutine asyncio.create_subprocess_exec(program, *args, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

创建一个子进程。

limit 参数为 Process.stdout 和 Process.stderr 设置 StreamReader 包装器的缓冲区上限（如果将 subprocess.PIPE 传给了 stdout 和 stderr 参数）。

返回一个 Process 实例。

有关其他形参的说明请查阅 loop.subprocess_exec() 的文档。

在 3.10 版更改: 移除了 loop 形参。

coroutine asyncio.create_subprocess_shell(cmd, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

运行 cmd shell 命令。

limit 参数为 Process.stdout 和 Process.stderr 设置 StreamReader 包装器的缓冲区上限（如果将 subprocess.PIPE 传给了 stdout 和 stderr 参数）。

返回一个 Process 实例。

有关其他形参的说明请查阅 loop.subprocess_shell() 的文档。

重要

应用程序要负责确保正确地转义所有空白字符和特殊字符以防止 shell 注入 [https://en.wikipedia.org/wiki/Shell_injection#Shell_injection] 漏洞。 shlex.quote() 函数可以被用来正确地转义字符串中可以被用来构造 shell 命令的空白字符和特殊 shell 字符。

在 3.10 版更改: 移除了 loop 形参。

注解

如果使用了 ProactorEventLoop 则子进程将在 Windows 中可用。 详情参见 Windows 上的子进程支持。

参见

asyncio 还有下列 低层级 API 可配合子进程使用: loop.subprocess_exec(), loop.subprocess_shell(), loop.connect_read_pipe(), loop.connect_write_pipe() 以及 子进程传输 和 子进程协议。

常量

asyncio.subprocess.PIPE

可以被传递给 stdin, stdout 或 stderr 形参。

如果 PIPE 被传递给 stdin 参数，则 Process.stdin 属性将会指向一个 StreamWriter 实例。

如果 PIPE 被传递给 stdout 或 stderr 参数，则 Process.stdout 和 Process.stderr 属性将会指向 StreamReader 实例。

asyncio.subprocess.STDOUT

可以用作 stderr 参数的特殊值，表示标准错误应当被重定向到标准输出。

asyncio.subprocess.DEVNULL

可以用作 stdin, stdout 或 stderr 参数来处理创建函数的特殊值。 它表示将为相应的子进程流使用特殊文件 os.devnull。

与子进程交互

create_subprocess_exec() 和 create_subprocess_shell() 函数都返回 Process 类的实例。 Process 是一个高层级包装器，它允许与子进程通信并监视其完成情况。

class asyncio.subprocess.Process

一个用于包装 create_subprocess_exec() and create_subprocess_shell() 函数创建的 OS 进程的对象。

这个类被设计为具有与 subprocess.Popen 类相似的 API，但两者有一些重要的差异:

不同于 Popen，Process 实例没有与 poll() 方法等价的方法；

communicate() 和 wait() 方法没有 timeout 形参：请使用 wait_for() 函数；

Process.wait() 方法是异步的，而 subprocess.Popen.wait() 方法则被实现为阻塞型忙循环；

universal_newlines 形参不被支持。

这个类不是线程安全的（not thread safe）。

请参阅 子进程和线程 部分。

coroutine wait()

等待子进程终结。

设置并返回 returncode 属性。

注解

当使用 stdout=PIPE 或 stderr=PIPE 并且子进程产生了足以阻塞 OS 管道缓冲区等待接收更多的数据的输出时，此方法会发生死锁。 当使用管道时请使用 communicate() 方法来避免这种情况。

coroutine communicate(input=None)

与进程交互:

发送数据到 stdin (如果 input 不为 None)；

从 stdout 和 stderr 读取数据，直至到达 EOF；

等待进程终结。

可选的 input 参数为将被发送到子进程的数据 (bytes 对象)。

返回一个元组 (stdout_data, stderr_data)。

如果在将 input 写入到 stdin 时引发了 BrokenPipeError 或 ConnectionResetError 异常，异常会被忽略。 此条件会在进程先于所有数据被写入到 stdin 之前退出时发生。

如果想要将数据发送到进程的 stdin，则创建进程时必须使用 stdin=PIPE。 类似地，要在结果元组中获得任何不为 None 的值，则创建进程时必须使用 stdout=PIPE 和/或 stderr=PIPE 参数。

注意，数据读取在内存中是带缓冲的，因此如果数据量过大或不受则不要使用此方法。

send_signal(signal)

将信号 signal 发送给子进程。

注解

在 Windows 上，SIGTERM 是 terminate() 的别名。 CTRL_C_EVENT 和 CTRL_BREAK_EVENT 可被发送给创建时设置了 creationflags 形参且其中包括 CREATE_NEW_PROCESS_GROUP 的进程。

terminate()

停止子进程。

在 POSIX 系统中此方法会发送 signal.SIGTERM 给子进程。

在 Windows 上会调用 Win32 API 函数 TerminateProcess() 以停止子进程。

kill()

杀掉子进程。

在 POSIX 系统中此方法会发送 SIGKILL 给子进程。

在 Windows 上此方法是 terminate() 的别名。

stdin

标准输入流 (StreamWriter) 或者如果进程创建时设置了 stdin=None 则为 None。

stdout

标准输出流 (StreamReader) 或者如果进程创建时设置了 stdout=None 则为 None。

stderr

标准错误流 (StreamReader) 或者如果进程创建时设置了 stderr=None 则为 None。

警告

使用 communicate() 方法而非 process.stdin.write(), await process.stdout.read() 或 await process.stderr.read()。 这可以避免由于流暂停读取或写入并阻塞子进程而导致的死锁。

pid

进程标识号（PID）。

注意对于由Note that for processes created by the create_subprocess_shell() 函数所创建的进程，这个属性将是所生成的 shell 的 PID。

returncode

当进程退出时返回其代号。

None 值表示进程尚未终止。

一个负值 -N 表示子进程被信号 N 中断 (仅 POSIX).

子进程和线程

标准 asyncio 事件循环默认支持从不同线程中运行子进程。

在 Windows 上子进程（默认）只由 ProactorEventLoop 提供，SelectorEventLoop 没有子进程支持。

在 UNIX 上会使用 child watchers 来让子进程结束等待，详情请参阅 进程监视器。

在 3.8 版更改: UNIX 对于从不同线程中无限制地生成子进程会切换为使用 ThreadedChildWatcher。

使用 不活动的 当前子监视器生成子进程将引发 RuntimeError。

请注意其他的事件循环实现可能有其本身的限制；请查看它们各自的文档。

参见

asyncio 中的并发和多线程 章节。

例子

一个使用 Process 类来控制子进程并用 StreamReader 类来从其标准输出读取信息的示例。

这个子进程是由 create_subprocess_exec() 函数创建的:

import asyncio
import sys

async def get_date():
    code = 'import datetime; print(datetime.datetime.now())'

    # Create the subprocess; redirect the standard output
    # into a pipe.
    proc = await asyncio.create_subprocess_exec(
        sys.executable, '-c', code,
        stdout=asyncio.subprocess.PIPE)

    # Read one line of output.
    data = await proc.stdout.readline()
    line = data.decode('ascii').rstrip()

    # Wait for the subprocess exit.
    await proc.wait()
    return line

date = asyncio.run(get_date())
print(f"Current date: {date}")

另请参阅使用低层级 API 编写的 相同示例。

队列集

源代码: Lib/asyncio/queues.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/queues.py]

asyncio 队列被设计成与 queue 模块类似。尽管 asyncio队列不是线程安全的，但是他们是被设计专用于 async/await 代码。

注意asyncio 的队列没有 timeout 形参；请使用 asyncio.wait_for() 函数为队列添加超时操作。

参见下面的 Examples 部分。

Queue

class asyncio.Queue(maxsize=0)

先进，先出（FIFO）队列

如果 maxsize 小于等于零，则队列尺寸是无限的。如果是大于 0 的整数，则当队列达到 maxsize 时， await put() 将阻塞至某个元素被 get() 取出。

不像标准库中的并发型 queue ，队列的尺寸一直是已知的，可以通过调用 qsize() 方法返回。

在 3.10 版更改: 移除了 loop 形参。

这个类不是线程安全的（not thread safe）。

maxsize

队列中可存放的元素数量。

empty()

如果队列为空返回 True ，否则返回 False 。

full()

如果有 maxsize 个条目在队列中，则返回 True 。

如果队列用 maxsize=0 （默认）初始化，则 full() 永远不会返回 True 。

coroutine get()

从队列中删除并返回一个元素。如果队列为空，则等待，直到队列中有元素。

get_nowait()

立即返回一个队列中的元素，如果队列内有值，否则引发异常 QueueEmpty 。

coroutine join()

阻塞至队列中所有的元素都被接收和处理完毕。

当条目添加到队列的时候，未完成任务的计数就会增加。每当消费协程调用 task_done() 表示这个条目已经被回收，该条目所有工作已经完成，未完成计数就会减少。当未完成计数降到零的时候， join() 阻塞被解除。

coroutine put(item)

添加一个元素进队列。如果队列满了，在添加元素之前，会一直等待空闲插槽可用。

put_nowait(item)

不阻塞的放一个元素入队列。

如果没有立即可用的空闲槽，引发 QueueFull 异常。

qsize()

返回队列用的元素数量。

task_done()

表明前面排队的任务已经完成，即get出来的元素相关操作已经完成。

由队列使用者控制。每个 get() 用于获取一个任务，任务最后调用 task_done() 告诉队列，这个任务已经完成。

如果 join() 当前正在阻塞，在所有条目都被处理后，将解除阻塞(意味着每个 put() 进队列的条目的 task_done() 都被收到)。

如果被调用的次数多于放入队列中的项目数量，将引发 ValueError 。

优先级队列

class asyncio.PriorityQueue

Queue 的变体；按优先级顺序取出条目 (最小的先取出)。

条目通常是 (priority_number, data) 形式的元组。

后进先出队列

class asyncio.LifoQueue

Queue 的变体，先取出最近添加的条目（后进，先出）。

异常

exception asyncio.QueueEmpty

当队列为空的时候，调用 get_nowait() 方法而引发这个异常。

exception asyncio.QueueFull

当队列中条目数量已经达到它的 maxsize 的时候，调用 put_nowait() 方法而引发的异常。

例子

队列能被用于多个的并发任务的工作量分配：

import asyncio
import random
import time

async def worker(name, queue):
    while True:
        # Get a "work item" out of the queue.
        sleep_for = await queue.get()

        # Sleep for the "sleep_for" seconds.
        await asyncio.sleep(sleep_for)

        # Notify the queue that the "work item" has been processed.
        queue.task_done()

        print(f'{name} has slept for {sleep_for:.2f} seconds')

async def main():
    # Create a queue that we will use to store our "workload".
    queue = asyncio.Queue()

    # Generate random timings and put them into the 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)

    # Create three worker tasks to process the queue concurrently.
    tasks = []
    for i in range(3):
        task = asyncio.create_task(worker(f'worker-{i}', queue))
        tasks.append(task)

    # Wait until the queue is fully processed.
    started_at = time.monotonic()
    await queue.join()
    total_slept_for = time.monotonic() - started_at

    # Cancel our worker tasks.
    for task in tasks:
        task.cancel()
    # Wait until all worker tasks are cancelled.
    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())

异常

源代码: Lib/asyncio/exceptions.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/exceptions.py]

exception asyncio.TimeoutError

该操作已超过规定的截止日期。

重要

这个异常与内置 TimeoutError 异常不同。

exception asyncio.CancelledError

该操作已被取消。

取消asyncio任务时，可以捕获此异常以执行自定义操作。在几乎所有情况下，都必须重新引发异常。

在 3.8 版更改: CancelledError 现在是 BaseException 的子类。

exception asyncio.InvalidStateError

Task 或 Future 的内部状态无效。

在为已设置结果值的未来对象设置结果值等情况下，可以引发此问题。

exception asyncio.SendfileNotAvailableError

"sendfile" 系统调用不适用于给定的套接字或文件类型。

子类 RuntimeError 。

exception asyncio.IncompleteReadError

请求的读取操作未完全完成。

由 asyncio stream APIs 提出

此异常是 EOFError 的子类。

expected

预期字节的总数（ int ）。

partial

到达流结束之前读取的 bytes 字符串。

exception asyncio.LimitOverrunError

在查找分隔符时达到缓冲区大小限制。

由 asyncio stream APIs 提出

consumed

要消耗的字节总数。

事件循环

源代码: Lib/asyncio/events.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/events.py], Lib/asyncio/base_events.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/base_events.py]

前言

事件循环是每个 asyncio 应用的核心。 事件循环会运行异步任务和回调，执行网络 IO 操作，以及运行子进程。

应用开发者通常应当使用高层级的 asyncio 函数，例如 asyncio.run()，应当很少有必要引用循环对象或调用其方法。 本节所针对的主要是低层级代码、库和框架的编写者，他们需要更细致地控制事件循环行为。

获取事件循环

以下低层级函数可被用于获取、设置或创建事件循环:

asyncio.get_running_loop()

返回当前 OS 线程中正在运行的事件循环。

如果没有正在运行的事件循环则会引发 RuntimeError。

此函数只能由协程或回调来调用。

3.7 新版功能.

asyncio.get_event_loop()

获取当前事件循环。

当在协程或回调中被调用时（例如通过 call_soon 或类似 API 加入计划任务），此函数将始终返回正在运行的事件循环。

如果没有设置正在运行的事件循环，此函数将返回 get_event_loop_policy().get_event_loop() 调用的结果。

由于此函数具有相当复杂的行为（特别是在使用了自定义事件循环策略的时候），更推荐在协程和回调中使用 get_running_loop() 函数而非 get_event_loop()。

如上文所说，请考虑使用高层级的 asyncio.run() 函数，而不是使用这些低层级的函数来手动创建和关闭事件循环。

注解

在 Python 3.10.0--3.10.8 和 3.11.0 等版本中此函数（及隐式地使用了它的其他函数）会在没有正在运行的事件循环时发出 DeprecationWarning，即使在策略中设置了当前循环也是如此。 在 Python 3.10.9, 3.11.1 和 3.12 等版本中在没有正在运行的事件循环且未设置当前循环时它们将发出 DeprecationWarning。 在未来的某个 Python 发布版中这将被改为错误。

asyncio.set_event_loop(loop)

将 loop 设为当前 OS 线程的当前事件循环。

asyncio.new_event_loop()

创建并返回一个新的事件循环对象。

请注意 get_event_loop(), set_event_loop() 以及 new_event_loop() 函数的行为可以通过 设置自定义事件循环策略 来改变。

目录

本文档包含下列小节:

事件循环方法集 章节是事件循环APIs的参考文档；

回调处理 章节是从调度方法 例如 loop.call_soon() 和 loop.call_later() 中返回 Handle 和 TimerHandle 实例的文档。

Server Objects 章节记录了从事件循环方法返回的类型，比如 loop.create_server() ；

Event Loop Implementations 章节记录了 SelectorEventLoop 和 ProactorEventLoop 类；

Examples 章节展示了如何使用某些事件循环API。

事件循环方法集

事件循环有下列 低级 APIs：

运行和停止循环

安排回调

调度延迟回调

创建 Future 和 Task

打开网络连接

创建网络服务

传输文件

TLS 升级

监控文件描述符

直接使用 socket 对象

DNS

使用管道

Unix 信号

在线程或者进程池中执行代码。

错误处理API

开启调试模式

运行子进程

运行和停止循环

loop.run_until_complete(future)

运行直到 future ( Future 的实例 ) 被完成。

如果参数是 coroutine object ，将被隐式调度为 asyncio.Task 来运行。

返回 Future 的结果 或者引发相关异常。

loop.run_forever()

运行事件循环直到 stop() 被调用。

如果 stop() 在调用 run_forever() 之前被调用，循环将轮询一次 I/O 选择器并设置超时为零，再运行所有已加入计划任务的回调来响应 I/O 事件（以及已加入计划任务的事件），然后退出。

如果 stop() 在 run_forever() 运行期间被调用，循环将运行当前批次的回调然后退出。 请注意在此情况下由回调加入计划任务的新回调将不会运行；它们将会在下次 run_forever() 或 run_until_complete() 被调用时运行。

loop.stop()

停止事件循环。

loop.is_running()

返回 True 如果事件循环当前正在运行。

loop.is_closed()

如果事件循环已经被关闭，返回 True 。

loop.close()

关闭事件循环。

当这个函数被调用的时候，循环必须处于非运行状态。pending状态的回调将被丢弃。

此方法清除所有的队列并立即关闭执行器，不会等待执行器完成。

这个方法是幂等的和不可逆的。事件循环关闭后，不应调用其他方法。

coroutine loop.shutdown_asyncgens()

安排所有当前打开的 asynchronous generator 对象通过 aclose() 调用来关闭。 在调用此方法后，如果有新的异步生成器被迭代事件循环将会发出警告。 这应当被用来可靠地完成所有已加入计划任务的异步生成器。

请注意当使用 asyncio.run() 时不必调用此函数。

示例:

try:
    loop.run_forever()
finally:
    loop.run_until_complete(loop.shutdown_asyncgens())
    loop.close()

3.6 新版功能.

coroutine loop.shutdown_default_executor()

安排默认执行器的关闭并等待它合并 ThreadPoolExecutor 中的所有线程。 一旦此方法被调用，将默认执行器与 loop.run_in_executor() 一起使用将引发 RuntimeError。

注解

当使用 asyncio.run() 不要调用此方法，因为它会自动处理默认执行器的关闭。

3.9 新版功能.

安排回调

loop.call_soon(callback, *args, context=None)

安排 callback callback 在事件循环的下一次迭代时附带 args 参数被调用。

返回一个 asyncio.Handle 的实例，可在此后被用来取消回调。

回调按其注册顺序被调用。每个回调仅被调用一次。

可选的仅限关键字参数 context 指定一个自定义的 contextvars.Context 供 callback 在其中运行。 当未提供 context 时回调将使用当前上下文。

与 call_soon_threadsafe() 不同，此方法不是线程安全的。

loop.call_soon_threadsafe(callback, *args, context=None)

call_soon() 的线程安全版。 当从另一个线程安排回调时，必须 使用此函数，因为 call_soon() 不是线程安全的。

如果在已被关闭的循环上调用则会引发 RuntimeError。 这可能会在主应用程序被关闭时在二级线程上发生。

参见 concurrency and multithreading 部分的文档。

在 3.7 版更改: 加入键值类形参 context。请参阅 PEP 567 [https://www.python.org/dev/peps/pep-0567] 查看更多细节。

注解

大多数 asyncio 的调度函数不让传递关键字参数。为此，请使用 functools.partial() ：

# will schedule "print("Hello", flush=True)"
loop.call_soon(
    functools.partial(print, "Hello", flush=True))

使用 partial 对象通常比使用lambda更方便，asyncio 在调试和错误消息中能更好的呈现 partial 对象。

调度延迟回调

事件循环提供安排调度函数在将来某个时刻调用的机制。事件循环使用单调时钟来跟踪时间。

loop.call_later(delay, callback, *args, context=None)

安排 callback 在给定的 delay 秒（可以是 int 或者 float）后被调用。

返回一个 asyncio.TimerHandle 实例，该实例能用于取消回调。

callback 只被调用一次。如果两个回调被安排在同样的时间点，执行顺序未限定。

可选的位置参数 args 在被调用的时候传递给 callback  。 如果你想把关键字参数传递给 callback ，请使用 functools.partial() 。

可选键值类的参数 context 允许 callback 运行在一个指定的自定义 contextvars.Context 对象中。如果没有提供 context ，则使用当前上下文。

在 3.7 版更改: 加入键值类形参 context。请参阅 PEP 567 [https://www.python.org/dev/peps/pep-0567] 查看更多细节。

在 3.8 版更改: 在 Python 3.7 和更早版本的默认事件循环实现中， delay 不能超过一天。 这在 Python 3.8 中已被修复。

loop.call_at(when, callback, *args, context=None)

安排 callback 在给定的绝对时间戳 when (int 或 float) 被调用，使用与 loop.time() 同样的时间参考。

本方法的行为和 call_later() 方法相同。

返回一个 asyncio.TimerHandle 实例，该实例能用于取消回调。

在 3.7 版更改: 加入键值类形参 context。请参阅 PEP 567 [https://www.python.org/dev/peps/pep-0567] 查看更多细节。

在 3.8 版更改: 在 Python 3.7 和更早版本的默认事件循环实现中，when 和当前时间相差不能超过一天。 在这 Python 3.8 中已被修复。

loop.time()

根据时间循环内部的单调时钟，返回当前时间为一个 float 值。

注解

在 3.8 版更改: 在 Python 3.7 和更早版本中超时 (相对的 delay 或绝对的 when) 不能超过一天。 这在 Python 3.8 中已被修复。

参见

asyncio.sleep() 函数。

创建 Future 和 Task

loop.create_future()

创建一个附加到事件循环中的 asyncio.Future 对象。

这是在asyncio中创建Futures的首选方式。这让第三方事件循环可以提供Future 对象的替代实现(更好的性能或者功能)。

3.5.2 新版功能.

loop.create_task(coro, *, name=None)

将 协程 coro 的执行加入计划任务。 返回一个 Task 对象。

第三方的事件循环可以使用它们自己的 Task 子类来满足互操作性。这种情况下结果类型是一个 Task 的子类。

如果提供了 name 参数且不为 None，它会使用 Task.set_name() 来设为任务的名称。

在 3.8 版更改: 增加了 name 形参。

loop.set_task_factory(factory)

设置一个任务工厂，它将由 loop.create_task() 来使用。

如果 factory 为 None 则将设置默认的任务工厂。 在其他情况下，factory 必须为一个 可调用对象 且签名匹配 (loop, coro)，其中 loop 是对活动事件循环的引用，而 coro 是一个协程对象。 该可调用对象必须返回一个兼容 asyncio.Future 的对象。

loop.get_task_factory()

返回一个任务工厂，或者如果是使用默认值则返回 None。

打开网络连接

coroutine 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, happy_eyeballs_delay=None, interleave=None)

打开一个流式传输连接，连接到由 host 和 port 指定的地址。

套接字族可以是 AF_INET 或 AF_INET6，具体取决于 host (或 family 参数，如果有提供的话)。

套接字类型将为 SOCK_STREAM。

protocol_factory 必须为一个返回 asyncio 协议 实现的可调用对象。

这个方法会尝试在后台创建连接。当创建成功，返回 (transport, protocol) 组合。

底层操作的大致的执行顺序是这样的：

创建连接并为其创建一个 传输。

不带参数地调用 protocol_factory 并预期返回一个 协议 实例。

协议实例通过调用其 connection_made() 方法与传输进行配对。

成功时返回一个 (transport, protocol) 元组。

创建的传输是一个具体实现相关的双向流。

其他参数：

ssl: 如果给定该参数且不为假值，则会创建一个 SSL/TLS 传输（默认创建一个纯 TCP 传输）。 如果 ssl 是一个 ssl.SSLContext 对象，则会使用此上下文来创建传输对象；如果 ssl 为 True，则会使用从 ssl.create_default_context() 返回的默认上下文。

参见

SSL/TLS security considerations

server_hostname 设置或覆盖目标服务器的证书将要匹配的主机名。 应当只在 ssl 不为 None 时传入。 默认情况下会使用 host 参数的值。 如果 host 为空那就没有默认值，你必须为 server_hostname 传入一个值。 如果 server_hostname 为空字符串，则主机名匹配会被禁用（这是一个严重的安全风险，使得潜在的中间人攻击成为可能）。

family, proto, flags 是可选的地址族、协议和标志，它们会被传递给 getaddrinfo() 来对 host 进行解析。如果要指定的话，这些都应该是来自于 socket 模块的对应常量。

如果给出 happy_eyeballs_delay，它将为此链接启用 Happy Eyeballs。 该函数应当为一个表示在开始下一个并行尝试之前要等待连接尝试完成的秒数的浮点数。 这也就是在 RFC 8305 [https://datatracker.ietf.org/doc/html/rfc8305.html] 中定义的 "连接尝试延迟"。 该 RFC 所推荐的合理默认值为 0.25 (250 毫秒)。

interleave 控制当主机名解析为多个 IP 地址时的地址重排序。 如果该参数为 0 或未指定，则不会进行重排序，这些地址会按 getaddrinfo() 所返回的顺序进行尝试。 如果指定了一个正整数，这些地址会按地址族交错排列，而指定的整数会被解读为 RFC 8305 [https://datatracker.ietf.org/doc/html/rfc8305.html] 所定义的 "首个地址族计数"。 如果 happy_eyeballs_delay 未指定则默认值为 0，否则为 1。

如果给出 sock，它应当是一个已存在、已连接并将被传输所使用的 socket.socket 对象。 如果给出了 sock，则 host, port, family, proto, flags, happy_eyeballs_delay, interleave 和 local_addr 都不应当被指定。

注解

sock 参数可将套接字的所有权转给所创建的传输。 要关闭该套接字，请调用传输的 close() 方法。

如果给出 local_addr，它应当是一个用来在本地绑定套接字的 (local_host, local_port) 元组。 local_host 和 local_port 会使用 getaddrinfo() 来查找，这与 host 和 port 类似。

ssl_handshake_timeout 是（用于 TLS 连接的）在放弃连接之前要等待 TLS 握手完成的秒数。 如果参数为 None 则使用 (默认的) 60.0。

在 3.5 版更改: ProactorEventLoop 类中添加 SSL/TLS 支持。

在 3.6 版更改: 套接字选项 TCP_NODELAY 默认已为所有 TCP 连接进行了设置。

在 3.7 版更改: 添加了 ssl_handshake_timeout 形参。

在 3.8 版更改: 增加了 happy_eyeballs_delay 和 interleave 形参。

Happy Eyeballs 算法：成功使用双栈主机。 当服务器的 IPv4 路径和协议工作正常，但服务器的 IPv6 路径和协议工作不正常时，双线客户端应用程序相比仅有 IPv4 的客户端会感受到明显的连接延迟。 这是不可接受的因为它会导致双栈客户端糟糕的用户体验。 这篇文档指明了减少这种用户可见延迟的算法要求并提供了具体的算法。

详情参见: https://tools.ietf.org/html/rfc6555

参见

open_connection() 函数是一个高层级的替代 API。 它返回一对 (StreamReader, StreamWriter)，可在 async/await 代码中直接使用。

coroutine loop.create_datagram_endpoint(protocol_factory, local_addr=None, remote_addr=None, *, family=0, proto=0, flags=0, reuse_address=None, reuse_port=None, allow_broadcast=None, sock=None)

注解

形参 reuse_address 已不再受支持，因为使用 SO_REUSEADDR 会对 UDP 造成显著的安全问题。 显式地传入 reuse_address=True 将会引发异常。

当具有不同 UID 的多个进程将套接字赋给具有 SO_REUSEADDR 的相同 UDP 套接字地址时，传入的数据包可能会在套接字间随机分配。

对于受支持的平台，reuse_port 可以被用作类似功能的替代。 通过 reuse_port 将改用 SO_REUSEPORT，它能够防止具有不同 UID 的进程将套接字赋给相同的套接字地址。

创建一个数据报连接。

套接字族可以是 AF_INET, AF_INET6 或 AF_UNIX，具体取决于 host (或 family 参数，如果有提供的话)。

socket类型将是 SOCK_DGRAM 。

protocol_factory 必须为一个返回 协议 实现的可调用对象。

成功时返回一个 (transport, protocol) 元组。

其他参数：

如果给出 local_addr，它应当是一个用来在本地绑定套接字的 (local_host, local_port) 元组。 local_host 和 local_port 是使用 getaddrinfo() 来查找的。

remote_addr，如果指定的话，就是一个 (remote_host, remote_port) 元组，用于同一个远程地址连接。remote_host 和 remote_port 是使用 getaddrinfo() 来查找的。

family, proto, flags 是可选的地址族，协议和标志，其会被传递给 getaddrinfo() 来完成 host 的解析。如果要指定的话，这些都应该是来自于 socket 模块的对应常量。

reuse_port 告知内核，只要在创建时都设置了这个旗标，就允许此端点绑定到其他现有端点所绑定的相同端口上。 这个选项在 Windows 和某些 Unix 上不受支持。 如果 SO_REUSEPORT 常量未定义则此功能就是不受支持的。

allow_broadcast 告知内核允许此端点向广播地址发送消息。

sock 可选择通过指定此值用于使用一个预先存在的，已经处于连接状态的 socket.socket 对象，并将其提供给此传输对象使用。如果指定了这个值， local_addr 和 remote_addr 就应该被忽略 (必须为 None)。

注解

sock 参数可将套接字的所有权转给所创建的传输。 要关闭该套接字，请调用传输的 close() 方法。

参见 UDP echo 客户端协议 和 UDP echo 服务端协议 的例子。

在 3.4.4 版更改: 添加了 family, proto, flags, reuse_address, reuse_port, allow_broadcast 和 sock 等参数。

在 3.8.1 版更改: 出于安全考虑，reuse_address 形参已不再受支持。

在 3.8 版更改: 添加WIndows的支持。

coroutine loop.create_unix_connection(protocol_factory, path=None, *, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None)

创建Unix 连接

套接字族将为 AF_UNIX；套接字类型将为 SOCK_STREAM。

成功时返回一个 (transport, protocol) 元组。

path 是所要求的 Unix 域套接字的名字，除非指定了 sock 形参。 抽象的 Unix 套接字, str, bytes 和 Path 路径都是受支持的。

请查看 loop.create_connection() 方法的文档了解有关此方法的参数的信息。

可用性: Unix。

在 3.7 版更改: 增加了 ssl_handshake_timeout 参数。现在 path 参数可以是一个 path-like object 。

创建网络服务

coroutine 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, ssl_handshake_timeout=None, start_serving=True)

创建TCP服务 (socket 类型 SOCK_STREAM ) 监听 host 地址的 port 端口。

返回一个 Server 对象。

参数：

protocol_factory 必须为一个返回 协议 实现的可调用对象。

host 形参可被设为几种类型，它确定了服务器所应监听的位置:

如果 host 是一个字符串，则 TCP 服务器会被绑定到 host 所指明的单一网络接口。

如果 host 是一个字符串序列，则 TCP 服务器会被绑定到序列所指明的所有网络接口。

如果 host 是一个空字符串或 None，则会应用所有接口并将返回包含多个套接字的列表（通常是一个 IPv4 的加一个 IPv6 的）。

可以设置 port 参数来指定服务器应该监听哪个端口。如果为 0 或者 None （默认），将选择一个随机的未使用的端口（注意，如果 host 解析到多个网络接口，将为每个接口选择一个不同的随机端口）。

family 可被设为 socket.AF_INET 或 AF_INET6 以强制此套接字使用 IPv4 或 IPv6。 如果未设定，则 family 将通过主机名称来确定 (默认为 AF_UNSPEC)。

flags 是用于 getaddrinfo() 的位掩码。

可以选择指定 sock 以便使用预先存在的套接字对象。 如果指定了此参数，则不可再指定 host 和 port。

注解

sock 参数可将套接字的所有权转给所创建的服务器。 要关闭该套接字，请调用服务器的 close() 方法。

backlog 是传递给 listen() 的最大排队连接的数量（默认为100）。

ssl 可被设置为一个 SSLContext 实例以在所接受的连接上启用 TLS。

reuse_address 告知内核要重用一个处于 TIME_WAIT 状态的本地套接字，而不是等待其自然超时失效。 如果未指定此参数则在 Unix 上将自动设置为 True。

reuse_port 告知内核，只要在创建的时候都设置了这个标志，就允许此端点绑定到其它端点列表所绑定的同样的端口上。这个选项在 Windows 上是不支持的。

ssl_handshake_timeout 是（用于 TLS 服务器的）在放弃连接之前要等待 TLS 握手完成的秒数。 如果参数为 (默认值) None 则为 60.0 秒。

start_serving 设置成 True (默认值) 会导致创建server并立即开始接受连接。设置成 False ，用户需要等待 Server.start_serving() 或者 Server.serve_forever() 以使server开始接受连接。

在 3.5 版更改: ProactorEventLoop 类中添加 SSL/TLS 支持。

在 3.5.1 版更改: host 形参可以是一个字符串的序列。

在 3.6 版更改: 增加了 ssl_handshake_timeout 和 start_serving 参数。socket 选项 TCP_NODELAY 对所有TCP连接都是默认设置的。

参见

start_server() 函数是一个高层级的替代 API，它返回一对 StreamReader 和 StreamWriter，可在 async/await 代码中使用。

coroutine loop.create_unix_server(protocol_factory, path=None, *, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, start_serving=True)

与 loop.create_server() 类似但是专用于 AF_UNIX 套接字族。

path 是必要的 Unix 域套接字名称，除非提供了 sock 参数。 抽象的 Unix 套接字, str, bytes 和 Path 路径都是受支持的。

请查看 loop.create_server() 方法的文档了解有关此方法的参数的信息。

可用性: Unix。

在 3.7 版更改: 增加了 ssl_handshake_timeout 和 start_serving 参数。现在 path 参数可以是一个 Path 对象。

coroutine loop.connect_accepted_socket(protocol_factory, sock, *, ssl=None, ssl_handshake_timeout=None)

将已被接受的连接包装成一个传输/协议对。

此方法可被服务器用来接受 asyncio 以外的连接，但是使用 asyncio 来处理它们。

参数：

protocol_factory 必须为一个返回 协议 实现的可调用对象。

sock 是一个预先存在的套接字对象，它是由 socket.accept 返回的。

注解

sock 参数可将套接字的所有权转给所创建的传输。 要关闭该套接字，请调用传输的 close() 方法。

ssl 可被设置为一个 SSLContext 以在接受的连接上启用 SSL。

ssl_handshake_timeout 是(为一个SSL连接)在中止连接前，等待SSL握手完成的时间【单位秒】。如果为 None (缺省) 则是 60.0 秒。

返回一个 (transport, protocol) 对。

3.5.3 新版功能.

在 3.7 版更改: 添加了 ssl_handshake_timeout 形参。

传输文件

coroutine loop.sendfile(transport, file, offset=0, count=None, *, fallback=True)

将 file 通过 transport 发送。 返回所发送的字节总数。

如果可用的话，该方法将使用高性能的 os.sendfile()。

file 必须是个二进制模式打开的常规文件对象。

offset 指明从何处开始读取文件。 如果指定了 count，它是要传输的字节总数而不再一直发送文件直至抵达 EOF。 文件位置总是会被更新，即使此方法引发了错误，并可以使用 file.tell() 来获取实际发送的字节总数。

fallback 设为 True 会使得 asyncio 在平台不支持 sendfile 系统调用时手动读取并发送文件（例如 Windows 或 Unix 上的 SSL 套接字）。

如果系统不支持 sendfile 系统调用且 fallback 为 False 则会引发 SendfileNotAvailableError。

3.7 新版功能.

TLS 升级

coroutine loop.start_tls(transport, protocol, sslcontext, *, server_side=False, server_hostname=None, ssl_handshake_timeout=None)

将现有基于传输的连接升级到 TLS。

创建一个 TLS 编码器/解码器实例并将其插入到 transport 和 protocol 之间。 该编码器/解码器同时实现了面向 transport 的协议和面向 protocol 的传输。

返回已创建的双接口实例。 在 await 之后，protocol 必须使用原始 transport 来停止并仅与所返回的对象通信因为编码器会缓存 protocol 方的数据并会不定期地与 transport 交换额外的 TLS 会话数据包。

在某些情况下（例如当传入的 transport 已经关闭）这可能返回 None。

参数：

transport 和 protocol 实例的方法与 create_server() 和 create_connection() 所返回的类似。

sslcontext ：一个已经配置好的 SSLContext 实例。

当服务端连接已升级时 (如 create_server() 所创建的对象) server_side 会传入 True。

server_hostname ：设置或者覆盖目标服务器证书中相对应的主机名。

ssl_handshake_timeout 是（用于 TLS 连接的）在放弃连接之前要等待 TLS 握手完成的秒数。 如果参数为 None 则使用 (默认的) 60.0。

3.7 新版功能.

监控文件描述符

loop.add_reader(fd, callback, *args)

开始监视 fd 文件描述符以获取读取的可用性，一旦 fd 可用于读取，使用指定的参数调用 callback 。

loop.remove_reader(fd)

停止监视 fd 文件描述符的读取可用性。 如果之前正在监视 fd 的读取则返回 True。

loop.add_writer(fd, callback, *args)

开始监视 fd 文件描述符的写入可用性，一旦 fd 可用于写入，使用指定的参数调用 callback 。

使用 functools.partial() 传递关键字参数 给 callback.

loop.remove_writer(fd)

停止监视 fd 文件描述符的写入可用性。 如果之前正在监视 fd 的写入则返回 True。

另请查看 平台支持 一节了解以上方法的某些限制。

直接使用 socket 对象

通常，使用基于传输的 API 的协议实现，例如 loop.create_connection() 和 loop.create_server() 比直接使用套接字的实现更快。 但是，在某些应用场景下性能并不非常重要，直接使用 socket 对象会更方便。

coroutine loop.sock_recv(sock, nbytes)

从 sock 接收至多 nbytes。 socket.recv() 的异步版本。

返回接收到的数据【bytes对象类型】。

sock 必须是个非阻塞socket。

在 3.7 版更改: 虽然这个方法总是被记录为协程方法，但它在 Python 3.7 之前的发行版中会返回一个 Future。 从 Python 3.7 开始它则是一个 async def 方法。

coroutine loop.sock_recv_into(sock, buf)

从 sock 接收数据放入 buf 缓冲区。 模仿了阻塞型的 socket.recv_into() 方法。

返回写入缓冲区的字节数。

sock 必须是个非阻塞socket。

3.7 新版功能.

coroutine loop.sock_sendall(sock, data)

将 data 发送到 sock 套接字。 socket.sendall() 的异步版本。

此方法会持续发送数据到套接字直至 data 中的所有数据发送完毕或是有错误发生。 当成功时会返回 None。 当发生错误时，会引发一个异常。 此外，没有办法能确定有多少数据或是否有数据被连接的接收方成功处理。

sock 必须是个非阻塞socket。

在 3.7 版更改: 虽然这个方法一直被标记为协程方法。但是，Python 3.7 之前，该方法返回 Future ，从Python 3.7 开始，这个方法是 async def 方法。

coroutine loop.sock_connect(sock, address)

将 sock 连接到位于 address 的远程套接字。

socket.connect() 的异步版本。

sock 必须是个非阻塞socket。

在 3.5.2 版更改: address 不再需要被解析。 sock_connect 将尝试检查 address 是否已通过调用 socket.inet_pton() 被解析。 如果没有，则将使用 loop.getaddrinfo() 来解析 address。

参见

loop.create_connection() 和 asyncio.open_connection() 。

coroutine loop.sock_accept(sock)

接受一个连接。 模仿了阻塞型的 socket.accept() 方法。

此 scoket 必须绑定到一个地址上并且监听连接。返回值是一个 (conn, address) 对，其中 conn 是一个 新*的套接字对象，用于在此连接上收发数据，*address 是连接的另一端的套接字所绑定的地址。

sock 必须是个非阻塞socket。

在 3.7 版更改: 虽然这个方法一直被标记为协程方法。但是，Python 3.7 之前，该方法返回 Future ，从Python 3.7 开始，这个方法是 async def 方法。

参见

loop.create_server() 和 start_server()。

coroutine loop.sock_sendfile(sock, file, offset=0, count=None, *, fallback=True)

在可能的情况下使用高性能的 os.sendfile 发送文件。 返回所发送的字节总数。

socket.sendfile() 的异步版本。

sock 必须为非阻塞型的 socket.SOCK_STREAM socket。

file 必须是个用二进制方式打开的常规文件对象。

offset 指明从何处开始读取文件。 如果指定了 count，它是要传输的字节总数而不再一直发送文件直至抵达 EOF。 文件位置总是会被更新，即使此方法引发了错误，并可以使用 file.tell() 来获取实际发送的字节总数。

当 fallback 被设为 True 时，会使用 asyncio 在平台不支持 sendfile 系统调用时手动读取并发送文件（例如 Windows 或 Unix 上的 SSL 套接字）。

如果系统不支持 sendfile 并且 fallback 为 False ，引发 SendfileNotAvailableError 异常。

sock 必须是个非阻塞socket。

3.7 新版功能.

DNS

coroutine loop.getaddrinfo(host, port, *, family=0, type=0, proto=0, flags=0)

异步版的 socket.getaddrinfo() 。

coroutine loop.getnameinfo(sockaddr, flags=0)

异步版的 socket.getnameinfo() 。

在 3.7 版更改: getaddrinfo 和 getnameinfo 方法一直被标记返回一个协程，但是Python 3.7之前，实际返回的是 asyncio.Future 对象。从Python 3.7 开始，这两个方法是协程。

使用管道

coroutine loop.connect_read_pipe(protocol_factory, pipe)

在事件循环中注册 pipe 的读取端。

protocol_factory 必须为一个返回 asyncio 协议 实现的可调用对象。

pipe 是个 类似文件型对象.

返回一对 (transport, protocol)，其中 transport 支持 ReadTransport 接口而 protocol 是由 protocol_factory 所实例化的对象。

使用 SelectorEventLoop 事件循环， pipe 被设置为非阻塞模式。

coroutine loop.connect_write_pipe(protocol_factory, pipe)

在事件循环中注册 pipe 的写入端。

protocol_factory 必须为一个返回 asyncio 协议 实现的可调用对象。

pipe 是个 类似文件型对象.

返回一对 (transport, protocol)，其中 transport 支持 WriteTransport 接口而 protocol 是由 protocol_factory 所实例化的对象。

使用 SelectorEventLoop 事件循环， pipe 被设置为非阻塞模式。

注解

在 Windows 中 SelectorEventLoop 不支持上述方法。 对于 Windows 请改用 ProactorEventLoop。

参见

loop.subprocess_exec() 和 loop.subprocess_shell() 方法。

Unix 信号

loop.add_signal_handler(signum, callback, *args)

设置 callback 作为 signum 信号的处理程序。

此回调将与该事件循环中其他加入队列的回调和可运行协程一起由 loop 唤起。 不同与使用 signal.signal() 注册的信号处理程序，使用此函数注册的回调可以与事件循环进行交互。

如果信号数字非法或者不可捕获，就抛出一个 ValueError 。如果建立处理器的过程中出现问题，会抛出一个 RuntimeError 。

使用 functools.partial() 传递关键字参数 给 callback.

和 signal.signal() 一样，这个函数只能在主线程中调用。

loop.remove_signal_handler(sig)

移除 sig 信号的处理程序。

如果信号处理程序被移除则返回 True，否则如果给定信号未设置处理程序则返回 False。

可用性: Unix。

参见

signal 模块。

在线程或者进程池中执行代码。

awaitable loop.run_in_executor(executor, func, *args)

安排在指定的执行器中调用 func 。

The executor argument should be an concurrent.futures.Executor instance. The default executor is used if executor is None.

示例:

import asyncio
import concurrent.futures

def blocking_io():
    # File operations (such as logging) can block the
    # event loop: run them in a thread pool.
    with open('/dev/urandom', 'rb') as f:
        return f.read(100)

def cpu_bound():
    # CPU-bound operations will block the event loop:
    # in general it is preferable to run them in a
    # process pool.
    return sum(i * i for i in range(10 ** 7))

async def main():
    loop = asyncio.get_running_loop()

    ## Options:

    # 1. Run in the default loop's executor:
    result = await loop.run_in_executor(
        None, blocking_io)
    print('default thread pool', result)

    # 2. Run in a custom thread pool:
    with concurrent.futures.ThreadPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, blocking_io)
        print('custom thread pool', result)

    # 3. Run in a custom process pool:
    with concurrent.futures.ProcessPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, cpu_bound)
        print('custom process pool', result)

if __name__ == '__main__':
    asyncio.run(main())

请注意需要为选项 3 设置入口点保护 (if __name__ == '__main__')，这是由于 multiprocessing 的特殊性，它将由 ProcessPoolExecutor 来使用。 参见 主模块的安全导入。

这个方法返回一个 asyncio.Future 对象。

使用 functools.partial() 传递关键字参数 给 func 。

在 3.5.3 版更改: loop.run_in_executor() 不会再配置它所创建的线程池执行器的 max_workers，而是将其留给线程池执行器 (ThreadPoolExecutor) 来设置默认值。

loop.set_default_executor(executor)

将 executor 设为 run_in_executor() 所使用的默认执行器。 executor 应当是 ThreadPoolExecutor 的实例。

3.8 版后已移除: 使用不是Using an executor that is not an instance of ThreadPoolExecutor 实例的执行器的做法已被弃用并将在 Python 3.9 中引起错误。

executor 必须是个 concurrent.futures.ThreadPoolExecutor 的实例。

错误处理API

允许自定义事件循环中如何去处理异常。

loop.set_exception_handler(handler)

将 handler 设置为新的事件循环异常处理器。

如果 handler 为 None，将设置默认的异常处理程序。 在其他情况下，handler 必须是一个可调用对象且签名匹配 (loop, context)，其中 loop 是对活动事件循环的引用，而 context 是一个包含异常详情的 dict (请查看 call_exception_handler() 文档来获取关于上下文的更多信息)。

loop.get_exception_handler()

返回当前的异常处理器，如果没有设置异常处理器，则返回 None 。

3.5.2 新版功能.

loop.default_exception_handler(context)

默认的异常处理器。

此方法会在发生异常且未设置异常处理程序时被调用。 此方法也可以由想要具有不同于默认处理程序的行为的自定义异常处理程序来调用。

context 参数和 call_exception_handler() 中的同名参数完全相同。

loop.call_exception_handler(context)

调用当前事件循环的异常处理器。

context 是个包含下列键的 dict 对象(未来版本的Python可能会引入新键)：

'message': 错误消息；

'exception' （可选）: 异常对象；

'future' （可选）: asyncio.Future 实例；

'task' (可选): asyncio.Task 实例；

'handle' （可选）: asyncio.Handle 实例；

'protocol' （可选）: Protocol 实例；

'transport' （可选）: Transport 实例；

'socket' (可选): socket.socket 实例；

'asyncgen' (可选): 异步生成器，它导致了

这个异常

注解

此方法不应在子类化的事件循环中被重载。 对于自定义的异常处理，请使用 set_exception_handler() 方法。

开启调试模式

loop.get_debug()

获取事件循环调试模式设置（bool）。

如果环境变量 PYTHONASYNCIODEBUG 是一个非空字符串，就返回 True ，否则就返回 False 。

loop.set_debug(enabled: bool)

设置事件循环的调试模式。

在 3.7 版更改: 现在也可以通过新的 Python 开发模式 来启用调试模式。

参见

debug mode of asyncio.

运行子进程

本小节所描述的方法都是低层级的。 在常规 async/await 代码中请考虑改用高层级的 asyncio.create_subprocess_shell() 和 asyncio.create_subprocess_exec() 便捷函数。

注解

在 Windows 中，默认的事件循环 ProactorEventLoop 支持子进程，而 SelectorEventLoop 不支持。参见 Windows 中的子进程支持 。

coroutine loop.subprocess_exec(protocol_factory, *args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

用 args 指定的一个或者多个字符串型参数创建一个子进程。

args 必须是个由下列形式的字符串组成的列表：

str;

或者由 文件系统编码格式 编码的 bytes。

第一个字符串指定可执行程序，其余的字符串指定其参数。 所有字符串参数共同组成了程序的 argv。

此方法类似于调用标准库 subprocess.Popen 类，设置 shell=False 并将字符串列表作为第一个参数传入；但是，Popen 只接受一个单独的字符串列表参数，而 subprocess_exec 接受多个字符串参数。

protocol_factory 必须为一个返回 asyncio.SubprocessProtocol 类的子类的可调用对象。

其他参数：

stdin 可以是以下对象之一:

一个文件型对象，表示要使用 connect_write_pipe() 连接到子进程的标准输入流的管道

subprocess.PIPE 常量（默认），将创建并连接一个新的管道。

None 值，这将使得子进程继承来自此进程的文件描述符

subprocess.DEVNULL 常量，这表示将使用特殊的 os.devnull 文件

stdout 可以是以下对象之一:

一个文件型对象，表示要使用 connect_write_pipe() 连接到子进程的标准输出流的管道

subprocess.PIPE 常量（默认），将创建并连接一个新的管道。

None 值，这将使得子进程继承来自此进程的文件描述符

subprocess.DEVNULL 常量，这表示将使用特殊的 os.devnull 文件

stderr 可以是以下对象之一:

一个文件型对象，表示要使用 connect_write_pipe() 连接到子进程的标准错误流的管道

subprocess.PIPE 常量（默认），将创建并连接一个新的管道。

None 值，这将使得子进程继承来自此进程的文件描述符

subprocess.DEVNULL 常量，这表示将使用特殊的 os.devnull 文件

subprocess.STDOUT 常量，将把标准错误流连接到进程的标准输出流

所有其他关键字参数会被不加解释地传给 subprocess.Popen，除了 bufsize, universal_newlines, shell, text, encoding 和 errors，它们都不应当被指定。

asyncio 子进程 API 不支持将流解码为文本。 可以使用 bytes.decode() 来将从流返回的字节串转换为文本。

其他参数的文档，请参阅 subprocess.Popen 类的构造函数。

返回一对 (transport, protocol)，其中 transport 来自 asyncio.SubprocessTransport 基类而 protocol 是由 protocol_factory 所实例化的对象。

coroutine loop.subprocess_shell(protocol_factory, cmd, *, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

基于 cmd 创建一个子进程，该参数可以是一个 str 或者按 文件系统编码格式 编码得到的 bytes ，使用平台的 "shell" 语法。

这类似与用 shell=True 调用标准库的 subprocess.Popen 类。

protocol_factory 必须为一个返回 SubprocessProtocol 类的子类的可调用对象。

请参阅 subprocess_exec() 了解有关其余参数的详情。

返回一对 (transport, protocol)，其中 transport 来自 SubprocessTransport 基类而 protocol 是由 protocol_factory 所实例化的对象。

注解

应用程序要负责确保正确地转义所有空白字符和特殊字符以防止 shell 注入 [https://en.wikipedia.org/wiki/Shell_injection#Shell_injection] 漏洞。 shlex.quote() 函数可以被用来正确地转义字符串中可能被用来构造 shell 命令的空白字符和特殊字符。

回调处理

class asyncio.Handle

由 loop.call_soon(), loop.call_soon_threadsafe() 所返回的回调包装器对象。

cancel()

取消回调。 如果此回调已被取消或已被执行，此方法将没有任何效果。

cancelled()

如果此回调已被取消则返回 True。

3.7 新版功能.

class asyncio.TimerHandle

由 loop.call_later() 和 loop.call_at() 所返回的回调包装器对象。

这个类是 Handle 的子类。

when()

返回加入计划任务的回调时间，以 float 值表示的秒数。

时间值是一个绝对时间戳，使用与 loop.time() 相同的时间引用。

3.7 新版功能.

Server 对象

Server 对象可使用 loop.create_server(), loop.create_unix_server(), start_server() 和 start_unix_server() 等函数来创建。

请不要直接实例化该类。

class asyncio.Server

Server 对象是异步上下文管理器。当用于 async with 语句时，异步上下文管理器可以确保 Server 对象被关闭，并且在 async with 语句完成后，不接受新的连接。

srv = await loop.create_server(...)

async with srv:
    # some code

# At this point, srv is closed and no longer accepts new connections.

在 3.7 版更改: Python3.7 开始，Server 对象是一个异步上下文管理器。

close()

停止服务：关闭监听的套接字并且设置 sockets 属性为 None 。

用于表示已经连进来的客户端连接会保持打开的状态。

服务器是被异步关闭的，使用 wait_closed() 协程来等待服务器关闭。

get_loop()

返回与服务器对象相关联的事件循环。

3.7 新版功能.

coroutine start_serving()

开始接受连接。

这个方法是幂等的【相同参数重复执行，能获得相同的结果】，所以此方法能在服务已经运行的时候调用。

传给 loop.create_server() 和 asyncio.start_server() 的 start_serving 仅限关键字形参允许创建不接受初始连接的 Server 对象。 在此情况下可以使用 Server.start_serving() 或 Server.serve_forever() 让 Server 对象开始接受连接。

3.7 新版功能.

coroutine serve_forever()

开始接受连接，直到协程被取消。 serve_forever 任务的取消将导致服务器被关闭。

如果服务器已经在接受连接了，这个方法可以被调用。每个 Server 对象，仅能有一个 serve_forever 任务。

示例:

async def client_connected(reader, writer):
    # Communicate with the client with
    # reader/writer streams.  For example:
    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))

3.7 新版功能.

is_serving()

如果服务器正在接受新连接的状态，返回 True 。

3.7 新版功能.

coroutine wait_closed()

等待 close() 方法执行完毕。

sockets

服务器监听的 socket.socket 对象列表。

在 3.7 版更改: 在 Python 3.7 之前 Server.sockets 会直接返回内部的服务器套接字列表。 在 3.7 版则会返回该列表的副本。

事件循环实现

asyncio 带有两种不同的事件循环实现: SelectorEventLoop 和 ProactorEventLoop。

默认情况下 asyncio 被配置为在 Unix 上使用 SelectorEventLoop 而在 Windows 上使用 ProactorEventLoop。

class asyncio.SelectorEventLoop

基于 selectors 模块的事件循环。

使用给定平台中最高效的可用 selector。 也可以手动配置要使用的特定 selector:

import asyncio
import selectors

class MyPolicy(asyncio.DefaultEventLoopPolicy):
   def new_event_loop(self):
      selector = selectors.SelectSelector()
      return asyncio.SelectorEventLoop(selector)

asyncio.set_event_loop_policy(MyPolicy())

可用性: Unix, Windows。

class asyncio.ProactorEventLoop

用 "I/O Completion Ports" (IOCP) 构建的专为Windows 的事件循环。

可用性: Windows。

参见

有关 I/O 完成端口的 MSDN 文档 [https://docs.microsoft.com/en-ca/windows/desktop/FileIO/i-o-completion-ports]。

class asyncio.AbstractEventLoop

asyncio 兼容事件循环的抽象基类。

事件循环方法集 一节列出了 AbstractEventLoop 的替代实现应当要定义的所有方法。

例子

请注意本节中的所有示例都 有意地 演示了如何使用低层级的事件循环 API，例如 loop.run_forever() 和 loop.call_soon()。 现代的 asyncio 应用很少需要以这样的方式编写；请考虑使用高层级的函数例如 asyncio.run()。

call_soon() 的 Hello World 示例。

一个使用 loop.call_soon() 方法来安排回调的示例。 回调会显示 "Hello World" 然后停止事件循环:

import asyncio

def hello_world(loop):
    """A callback to print 'Hello World' and stop the event loop"""
    print('Hello World')
    loop.stop()

loop = asyncio.get_event_loop()

# Schedule a call to hello_world()
loop.call_soon(hello_world, loop)

# Blocking call interrupted by loop.stop()
try:
    loop.run_forever()
finally:
    loop.close()

参见

一个类似的 Hello World 示例，使用协程和 run() 函数创建。

使用 call_later() 来展示当前的日期

一个每秒刷新显示当前日期的示例。 回调使用 loop.call_later() 方法在 5 秒后将自身重新加入计划日程，然后停止事件循环:

import asyncio
import datetime

def display_date(end_time, loop):
    print(datetime.datetime.now())
    if (loop.time() + 1.0) < end_time:
        loop.call_later(1, display_date, end_time, loop)
    else:
        loop.stop()

loop = asyncio.get_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()

参见

一个类似的 current date 示例，使用协程和 run() 函数创建。

监控一个文件描述符的读事件

使用 loop.add_reader() 方法，等到文件描述符收到一些数据，然后关闭事件循环：

import asyncio
from socket import socketpair

# Create a pair of connected file descriptors
rsock, wsock = socketpair()

loop = asyncio.get_event_loop()

def reader():
    data = rsock.recv(100)
    print("Received:", data.decode())

    # We are done: unregister the file descriptor
    loop.remove_reader(rsock)

    # Stop the event loop
    loop.stop()

# Register the file descriptor for read event
loop.add_reader(rsock, reader)

# Simulate the reception of data from the network
loop.call_soon(wsock.send, 'abc'.encode())

try:
    # Run the event loop
    loop.run_forever()
finally:
    # We are done. Close sockets and the event loop.
    rsock.close()
    wsock.close()
    loop.close()

参见

一个类似的 示例，使用传输、协议和 loop.create_connection() 方法创建。

另一个类似的 示例，使用了高层级的 asyncio.open_connection() 函数和流。

为SIGINT和SIGTERM设置信号处理器

（这个 signals 示例只适用于 Unix。）

使用 loop.add_signal_handler() 方法为信号 SIGINT 和 SIGTERM 注册处理程序:

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())

Futures

源代码: Lib/asyncio/futures.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/futures.py], Lib/asyncio/base_futures.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/base_futures.py]

Future 对象用来链接 底层回调式代码 和高层异步/等待式代码。

Future 函数

asyncio.isfuture(obj)

如果 obj 为下面任意对象，返回 True：

一个 asyncio.Future 类的实例，

一个 asyncio.Task 类的实例，

带有 _asyncio_future_blocking 属性的类似 Future 的对象。

3.5 新版功能.

asyncio.ensure_future(obj, *, loop=None)

返回：

obj 参数会是保持原样，如果 obj 是 Future、 Task 或 类似 Future 的对象( isfuture() 用于测试。)

封装了 obj 的 Task 对象，如果 obj 是一个协程 (使用 iscoroutine() 进行检测)；在此情况下该协程将通过 ensure_future() 加入执行计划。

等待 obj 的 Task 对象，如果 obj 是一个可等待对象( inspect.isawaitable() 用于测试)

如果 obj 不是上述对象会引发一个 TypeError 异常。

重要

查看 create_task() 函数，它是创建新任务的首选途径。

保存一个指向此函数的结果的引用，以避免任务在执行期间消失。

在 3.5.1 版更改: 这个函数接受任意 awaitable 对象。

3.10 版后已移除: 如果 obj 不是 Future 类对象同时未指定 loop 并且没有正在运行的事件循环则会发出弃用警告。

asyncio.wrap_future(future, *, loop=None)

将一个 concurrent.futures.Future 对象封装到 asyncio.Future 对象中。

3.10 版后已移除: 如果 future 不是 Future 类对象同时未指定 loop 并且没有正在运行的事件循环则会发出弃用警告。

Future 对象

class asyncio.Future(*, loop=None)

一个 Future 代表一个异步运算的最终结果。线程不安全。

Future 是一个 awaitable 对象。 协程可以等待 Future 对象直到它们有结果或设置了异常，或者直到它们被取消。 一个 Future 可被等待多次并且结果相同。

通常 Future 用于支持底层回调式代码(例如在协议实现中使用asyncio transports) 与高层异步/等待式代码交互。

经验告诉我们永远不要面向用户的接口暴露 Future 对象，同时建议使用 loop.create_future() 来创建 Future 对象。这种方法可以让 Future 对象使用其它的事件循环实现，它可以注入自己的优化实现。

在 3.7 版更改: 加入对 contextvars 模块的支持。

3.10 版后已移除: 如果未指定 loop 并且没有正在运行的事件循环则会发出弃用警告。

result()

返回 Future 的结果。

如果 Future 状态为 完成 ，并由 set_result() 方法设置一个结果，则返回这个结果。

如果 Future 状态为 完成 ，并由 set_exception() 方法设置一个异常，那么这个方法会引发异常。

如果 Future 已 取消，方法会引发一个 CancelledError 异常。

如果 Future 的结果还不可用，此方法会引发一个 InvalidStateError 异常。

set_result(result)

将 Future 标记为 完成 并设置结果。

如果 Future 已经 完成 则抛出一个 InvalidStateError 错误。

set_exception(exception)

将 Future 标记为 完成 并设置一个异常。

如果 Future 已经 完成 则抛出一个 InvalidStateError 错误。

done()

如果 Future 为已 完成 则返回 True 。

如果 Future 为 取消 或调用 set_result() 设置了结果或调用 set_exception() 设置了异常，那么它就是 完成 。

cancelled()

如果 Future 已 取消 则返回 True

这个方法通常在设置结果或异常前用来检查 Future 是否已 取消 。

if not fut.cancelled():
    fut.set_result(42)

add_done_callback(callback, *, context=None)

添加一个在 Future 完成 时运行的回调函数。

调用 callback 时，Future 对象是它的唯一参数。

如果调用这个方法时 Future 已经 完成，回调函数会被 loop.call_soon() 调度。

可选键值类的参数 context 允许 callback 运行在一个指定的自定义 contextvars.Context 对象中。如果没有提供 context ，则使用当前上下文。

可以用 functools.partial() 给回调函数传递参数，例如:

# Call 'print("Future:", fut)' when "fut" is done.
fut.add_done_callback(
    functools.partial(print, "Future:"))

在 3.7 版更改: 加入键值类形参 context。请参阅 PEP 567 [https://www.python.org/dev/peps/pep-0567] 查看更多细节。

remove_done_callback(callback)

从回调列表中移除 callback 。

返回被移除的回调函数的数量，通常为1，除非一个回调函数被添加多次。

cancel(msg=None)

取消 Future 并调度回调函数。

如果 Future 已经 完成 或 取消 ，返回 False 。否则将 Future 状态改为 取消 并在调度回调函数后返回 True 。

在 3.9 版更改: 增加了 msg 形参。

exception()

返回 Future 已设置的异常。

只有 Future 在 完成 时才返回异常（或者 None ，如果没有设置异常）。

如果 Future 已 取消，方法会引发一个 CancelledError 异常。

如果 Future 还没 完成 ，这个方法会引发一个 InvalidStateError 异常。

get_loop()

返回 Future 对象已绑定的事件循环。

3.7 新版功能.

这个例子创建一个 Future 对象，创建和调度一个异步任务去设置 Future 结果，然后等待其结果:

async def set_after(fut, delay, value):
    # Sleep for *delay* seconds.
    await asyncio.sleep(delay)

    # Set *value* as a result of *fut* Future.
    fut.set_result(value)

async def main():
    # Get the current event loop.
    loop = asyncio.get_running_loop()

    # Create a new Future object.
    fut = loop.create_future()

    # Run "set_after()" coroutine in a parallel Task.
    # We are using the low-level "loop.create_task()" API here because
    # we already have a reference to the event loop at hand.
    # Otherwise we could have just used "asyncio.create_task()".
    loop.create_task(
        set_after(fut, 1, '... world'))

    print('hello ...')

    # Wait until *fut* has a result (1 second) and print it.
    print(await fut)

asyncio.run(main())

重要

该 Future 对象是为了模仿 concurrent.futures.Future 类。主要差异包含：

与 asyncio 的 Future 不同，concurrent.futures.Future 实例不是可等待对象。

asyncio.Future.result() 和 asyncio.Future.exception() 不接受 timeout 参数。

Future 没有 完成 时 asyncio.Future.result() 和 asyncio.Future.exception() 抛出一个 InvalidStateError 异常。

使用 asyncio.Future.add_done_callback() 注册的回调函数不会立即调用，而是被 loop.call_soon() 调度。

asyncio Future 不能兼容 concurrent.futures.wait() 和 concurrent.futures.as_completed() 函数。

asyncio.Future.cancel() 接受一个可选的 msg 参数，但 concurrent.futures.cancel() 无此参数。

传输和协议

前言

传输和协议会被像 loop.create_connection() 这类 底层 事件循环接口使用。它们使用基于回调的编程风格支持网络或IPC协议（如HTTP）的高性能实现。

基本上，传输和协议应只在库和框架上使用，而不应该在高层的异步应用中使用它们。

本文档包含 Transports 和 Protocols 。

概述

在最顶层，传输只关心 怎样 传送字节内容，而协议决定传送 哪些 字节内容(还要在一定程度上考虑何时)。

也可以这样说：从传输的角度来看，传输是套接字(或类似的I/O终端)的抽象，而协议是应用程序的抽象。

换另一种说法，传输和协议一起定义网络I/0和进程间I/O的抽象接口。

传输对象和协议对象总是一对一关系：协议调用传输方法来发送数据，而传输在接收到数据时调用协议方法传递数据。

大部分面向连接的事件循环方法(如 loop.create_connection() ) 通常接受 protocol_factory 参数为接收到的链接创建 协议 对象，并用 传输 对象来表示。这些方法一般会返回 (transport, protocol) 元组。

目录

本文档包含下列小节:

传输 部分记载异步IO BaseTransport 、 ReadTransport 、 WriteTransport 、 Transport 、 DatagramTransport 和 SubprocessTransport 等类。

The Protocols section documents asyncio BaseProtocol, Protocol, BufferedProtocol, DatagramProtocol, and SubprocessProtocol classes.

例子 部分展示怎样使用传输、协议和底层事件循环接口。

传输

源码: Lib/asyncio/transports.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/transports.py]

传输属于 asyncio 模块中的类，用来抽象各种通信通道。

传输对象总是由 异步IO事件循环 实例化。

异步IO实现TCP、UDP、SSL和子进程管道的传输。传输上可用的方法由传输的类型决定。

传输类属于 线程不安全 。

传输层级

class asyncio.BaseTransport

所有传输的基类。包含所有异步IO传输共用的方法。

class asyncio.WriteTransport(BaseTransport)

只写链接的基础传输。

WriteTransport 类的实例由 loop.connect_write_pipe() 事件循环方法返回，也被子进程相关的方法如 loop.subprocess_exec() 使用。

class asyncio.ReadTransport(BaseTransport)

只读链接的基础传输。

ReadTransport 类的实例由 loop.connect_read_pipe() 事件循环方法返回，也被子进程相关的方法如 loop.subprocess_exec() 使用。

class asyncio.Transport(WriteTransport, ReadTransport)

接口代表一个双向传输，如TCP链接。

用户不用直接实例化传输；调用一个功能函数，给它传递协议工厂和其它需要的信息就可以创建传输和协议。

传输 类实例由如 loop.create_connection() 、 loop.create_unix_connection() 、 loop.create_server() 、 loop.sendfile() 等这类事件循环方法使用或返回。

class asyncio.DatagramTransport(BaseTransport)

数据报(UDP)传输链接。

DatagramTransport 类实例由事件循环方法 loop.create_datagram_endpoint() 返回。

class asyncio.SubprocessTransport(BaseTransport)

表示父进程和子进程之间连接的抽象。

SubprocessTransport 类的实例由事件循环方法 loop.subprocess_shell() 和 loop.subprocess_exec() 返回。

基础传输

BaseTransport.close()

关闭传输。

如果传输具有外发数据缓冲区，已缓存的数据将被异步地发送。 之后将不会再接收更多数据。 在所有已缓存的数据被发送之后，协议的 protocol.connection_lost() 方法将被调用并以 None 作为其参数。 在传输关闭后它就不应再被使用。

BaseTransport.is_closing()

返回 True ，如果传输正在关闭或已经关闭。

BaseTransport.get_extra_info(name, default=None)

返回 传输或它使用的相关资源信息。

name 是表示要获取传输特定信息的字符串。

default 是在信息不可用或传输不支持第三方事件循环实现或当前平台查询时返回的值。

例如下面代码尝试获取传输相关套接字对象:

sock = transport.get_extra_info('socket')
if sock is not None:
    print(sock.getsockopt(...))

传输可查询信息类别:

套接字:

'peername': 套接字链接时的远端地址，socket.socket.getpeername() 方法的结果 (出错时为 None )

'socket': socket.socket 实例

'sockname': 套接字本地地址， socket.socket.getsockname() 方法的结果

SSL套接字

'compression': 用字符串指定压缩算法，或者链接没有压缩时为 None ；ssl.SSLSocket.compression() 的结果。

'cipher': 一个三值的元组，包含使用密码的名称，定义使用的SSL协议的版本，使用的加密位数。 ssl.SSLSocket.cipher() 的结果。

'peercert': 远端凭证； ssl.SSLSocket.getpeercert() 结果。

'sslcontext': ssl.SSLContext 实例

'ssl_object': ssl.SSLObject 或 ssl.SSLSocket 实例

管道：

'pipe': 管道对象

子进程：

'subprocess': subprocess.Popen 实例

BaseTransport.set_protocol(protocol)

设置一个新协议。

只有两种协议都写明支持切换才能完成切换协议。

BaseTransport.get_protocol()

返回当前协议。

只读传输

ReadTransport.is_reading()

如果传输接收到新数据时返回 True 。

3.7 新版功能.

ReadTransport.pause_reading()

暂停传输的接收端。protocol.data_received() 方法将不会收到数据，除非 resume_reading()  被调用。

在 3.7 版更改: 这个方法幂等的， 它可以在传输已经暂停或关闭时调用。

ReadTransport.resume_reading()

恢复接收端。如果有数据可读取时，协议方法 protocol.data_received() 将再次被调用。

在 3.7 版更改: 这个方法幂等的， 它可以在传输已经准备好读取数据时调用。

只写传输

WriteTransport.abort()

立即关闭传输，不会等待已提交的操作处理完毕。已缓存的数据将会丢失。不会接收更多数据。 最终 None 将作为协议的 protocol.connection_lost() 方法的参数被调用。

WriteTransport.can_write_eof()

如果传输支持 write_eof() 返回 True 否则返回 False 。

WriteTransport.get_write_buffer_size()

返回传输使用输出缓冲区的当前大小。

WriteTransport.get_write_buffer_limits()

获取写入流控制 high 和 low 高低标记位。返回元组 (low, high) ， low 和 high 为正字节数。

使用 set_write_buffer_limits() 设置限制。

3.4.2 新版功能.

WriteTransport.set_write_buffer_limits(high=None, low=None)

设置写入流控制 high 和 low 高低标记位。

这两个值（以字节数表示）控制何时调用协议的 protocol.pause_writing() 和 protocol.resume_writing() 方法。 如果指明，则低水位必须小于或等于高水位。 high 和 low 都不能为负值。

pause_writing() 会在缓冲区尺寸大于或等于 high 值时被调用。 如果写入已经被暂停，resume_writing() 会在缓冲区尺寸小于或等于 low 值时被调用。

默认值是实现专属的。 如果只给出了高水位值，则低水位值默认为一个小于或等于高水位值的实现传属值。 将 high 设为零会强制将 low 也设为零，并使得 pause_writing() 在缓冲区变为非空的任何时刻被调用。 将 low 设为零会使得 resume_writing() 在缓冲区为空时只被调用一次。 对于上下限都使用零值通常是不够优化的，因为它减少了并发执行 I/O 和计算的机会。

可使用 get_write_buffer_limits() 来获取上下限值。

WriteTransport.write(data)

将一些 data 字节串写入传输。

此方法不会阻塞；它会缓冲数据并安排其被异步地发出。

WriteTransport.writelines(list_of_data)

将数据字节串的列表（或任意可迭代对象）写入传输。 这在功能上等价于在可迭代对象产生的每个元素上调用 write()，但其实现可能更为高效。

WriteTransport.write_eof()

在刷新所有已缓冲数据之后关闭传输的写入端。 数据仍可以被接收。

如果传输（例如 SSL）不支持半关闭的连接，此方法会引发 NotImplementedError。

数据报传输

DatagramTransport.sendto(data, addr=None)

将 data 字节串发送到 addr (基于传输的目标地址) 所给定的远端对等方。 如果 addr 为 None，则将数据发送到传输创建时给定的目标地址。

此方法不会阻塞；它会缓冲数据并安排其被异步地发出。

DatagramTransport.abort()

立即关闭传输，不会等待已提交的操作执行完毕。 已缓存的数据将会丢失。 不会接收更多的数据。 协议的 protocol.connection_lost() 方法最终将附带 None 作为参数被调用。

子进程传输

SubprocessTransport.get_pid()

将子进程的进程 ID 以整数形式返回。

SubprocessTransport.get_pipe_transport(fd)

返回对应于整数文件描述符 fd 的通信管道的传输:

0: 标准输入 (stdin) 的可读流式传输，如果子进程创建时未设置 stdin=PIPE 则为 None

1: 标准输出 (stdout) 的可写流式传输，如果子进程创建时未设置 stdout=PIPE 则为 None

2: 标准错误 (stderr) 的可写流式传输，如果子进程创建时未设置 stderr=PIPE 则为 None

其他 fd: None

SubprocessTransport.get_returncode()

返回整数形式的进程返回码，或者如果还未返回则为 None，这类似于 subprocess.Popen.returncode 属性。

SubprocessTransport.kill()

杀死子进程。

在 POSIX 系统中，函数会发送 SIGKILL 到子进程。 在 Windows 中，此方法是 terminate() 的别名。

另请参见 subprocess.Popen.kill()。

SubprocessTransport.send_signal(signal)

发送 signal 编号到子进程，与 subprocess.Popen.send_signal() 一样。

SubprocessTransport.terminate()

停止子进程。

在 POSIX 系统中，此方法会发送 SIGTERM 到子进程。 在 Windows 中，则会调用 Windows API 函数 TerminateProcess() 来停止子进程。

另请参见 subprocess.Popen.terminate()。

SubprocessTransport.close()

通过调用 kill() 方法来杀死子进程。

如果子进程尚未返回，并关闭 stdin, stdout 和 stderr 管道的传输。

协议

源码: Lib/asyncio/protocols.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/protocols.py]

asyncio 提供了一组抽象基类，它们应当被用于实现网络协议。 这些类被设计为与 传输 配合使用。

抽象基础协议类的子类可以实现其中的部分或全部方法。 所有这些方法都是回调：它们由传输或特定事件调用，例如当数据被接收的时候。 基础协议方法应当由相应的传输来调用。

基础协议

class asyncio.BaseProtocol

带有所有协议的共享方法的基础协议。

class asyncio.Protocol(BaseProtocol)

用于实现流式协议（TCP, Unix 套接字等等）的基类。

class asyncio.BufferedProtocol(BaseProtocol)

用于实现可对接收缓冲区进行手动控制的流式协议的基类。

class asyncio.DatagramProtocol(BaseProtocol)

用于实现数据报（UDP）协议的基类。

class asyncio.SubprocessProtocol(BaseProtocol)

用于实现与子进程通信（单向管道）的协议的基类。

基础协议

所有 asyncio 协议均可实现基础协议回调。

连接回调

连接回调会在所有协议上被调用，每个成功的连接将恰好调用一次。 所有其他协议回调只能在以下两个方法之间被调用。

BaseProtocol.connection_made(transport)

连接建立时被调用。

transport 参数是代表连接的传输。 此协议负责将引用保存至对应的传输。

BaseProtocol.connection_lost(exc)

连接丢失或关闭时将被调用。

方法的参数是一个异常对象或为 None。 后者意味着收到了常规的 EOF，或者连接被连接的一端取消或关闭。

流程控制回调

流程控制回调可由传输来调用以暂停或恢复协议所执行的写入操作。

请查看 set_write_buffer_limits() 方法的文档了解详情。

BaseProtocol.pause_writing()

当传输的缓冲区升至高水位以上时将被调用。

BaseProtocol.resume_writing()

当传输的缓冲区降到低水位以下时将被调用。

如果缓冲区大小等于高水位值，则 pause_writing() 不会被调用：缓冲区大小必须要高于该值。

相反地，resume_writing() 会在缓冲区大小等于或小于低水位值时被调用。 这些结束条件对于当两个水位取零值时也能确保符合预期的行为是很重要的。

流式协议

事件方法，例如 loop.create_server(), loop.create_unix_server(), loop.create_connection(), loop.create_unix_connection(), loop.connect_accepted_socket(), loop.connect_read_pipe() 和 loop.connect_write_pipe() 都接受返回流式协议的工厂。

Protocol.data_received(data)

当收到数据时被调用。 data 为包含入站数据的非空字节串对象。

数据是否会被缓冲、分块或重组取决于具体传输。 通常，你不应依赖于特定的语义而应使你的解析具有通用性和灵活性。 但是，数据总是要以正确的顺序被接收。

此方法在连接打开期间可以被调用任意次数。

但是，protocol.eof_received() 最多只会被调用一次。 一旦 eof_received() 被调用，data_received() 就不会再被调用。

Protocol.eof_received()

当发出信号的另一端不再继续发送数据时（例如通过调用 transport.write_eof()，如果另一端也使用 asyncio 的话）被调用。

此方法可能返回假值 (包括 None)，在此情况下传输将会自行关闭。 相反地，如果此方法返回真值，将以所用的协议来确定是否要关闭传输。 由于默认实现是返回 None，因此它会隐式地关闭连接。

某些传输，包括 SSL 在内，并不支持半关闭的连接，在此情况下从该方法返回真值将导致连接被关闭。

状态机：

start -> connection_made
    [-> data_received]*
    [-> eof_received]?
-> connection_lost -> end

缓冲流协议

3.7 新版功能.

带缓冲的协议可与任何支持 流式协议 的事件循环方法配合使用。

BufferedProtocol 实现允许显式手动分配和控制接收缓冲区。 随后事件循环可以使用协议提供的缓冲区来避免不必要的数据复制。 这对于接收大量数据的协议来说会有明显的性能提升。 复杂的协议实现能显著地减少缓冲区分配的数量。

以下回调是在 BufferedProtocol 实例上被调用的:

BufferedProtocol.get_buffer(sizehint)

调用后会分配新的接收缓冲区。

sizehint 是推荐的返回缓冲区最小尺寸。 返回小于或大于 sizehint 推荐尺寸的缓冲区也是可接受的。 当设为 -1 时，缓冲区尺寸可以是任意的。 返回尺寸为零的缓冲区则是错误的。

get_buffer() 必须返回一个实现了 缓冲区协议 的对象。

BufferedProtocol.buffer_updated(nbytes)

用接收的数据更新缓冲区时被调用。

nbytes 是被写入到缓冲区的字节总数。

BufferedProtocol.eof_received()

请查看 protocol.eof_received() 方法的文档。

在连接期间 get_buffer() 可以被调用任意次数。 但是，protocol.eof_received() 最多只能被调用一次，如果被调用，则在此之后 get_buffer() 和 buffer_updated() 不能再被调用。

状态机：

start -> connection_made
    [-> get_buffer
        [-> buffer_updated]?
    ]*
    [-> eof_received]?
-> connection_lost -> end

数据报协议

数据报协议实例应当由传递给 loop.create_datagram_endpoint() 方法的协议工厂来构造。

DatagramProtocol.datagram_received(data, addr)

当接收到数据报时被调用。 data 是包含传入数据的字节串对象。 addr 是发送数据的对等端地址；实际的格式取决于具体传输。

DatagramProtocol.error_received(exc)

当前一个发送或接收操作引发 OSError 时被调用。 exc 是 OSError 的实例。

此方法会在当传输（例如UDP）检测到无法将数据报传给接收方等极少数情况下被调用。 而在大多数情况下，无法送达的数据报将被静默地丢弃。

注解

在 BSD 系统（macOS, FreeBSD 等等）上，数据报协议不支持流控制，因为没有可靠的方式来检测因写入多过包所导致的发送失败。

套接字总是显示为 'ready' 且多余的包会被丢弃。 有一定的可能性会引发 OSError 并设置 errno 为 errno.ENOBUFS；如果此异常被引发，它将被报告给 DatagramProtocol.error_received()，在其他情况下则会被忽略。

子进程协议

子进程协议实例应当由传递给 loop.subprocess_exec() 和 loop.subprocess_shell() 方法的协议工厂函数来构造。

SubprocessProtocol.pipe_data_received(fd, data)

当子进程向其 stdout 或 stderr 管道写入数据时被调用。

fd 是以整数表示的管道文件描述符。

data 是包含已接收数据的非空字节串对象。

SubprocessProtocol.pipe_connection_lost(fd, exc)

与子进程通信的其中一个管道关闭时被调用。

fd 以整数表示的已关闭文件描述符。

SubprocessProtocol.process_exited()

子进程退出时被调用。

例子

TCP 回显服务器

使用 loop.create_server() 方法创建 TCP 回显服务器，发回已接收的数据，并关闭连接:

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():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    server = await loop.create_server(
        lambda: EchoServerProtocol(),
        '127.0.0.1', 8888)

    async with server:
        await server.serve_forever()

asyncio.run(main())

参见

使用流的 TCP 回显服务器 示例，使用了高层级的 asyncio.start_server() 函数。

TCP 回显客户端

使用 loop.create_connection() 方法的 TCP 回显客户端，发送数据并等待，直到连接被关闭:

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():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    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)

    # Wait until the protocol signals that the connection
    # is lost and close the transport.
    try:
        await on_con_lost
    finally:
        transport.close()

asyncio.run(main())

参见

使用流的 TCP 回显客户端 示例，使用了高层级的 asyncio.open_connection() 函数。

UDP 回显服务器

使用 loop.create_datagram_endpoint() 方法的 UDP 回显服务器，发回已接收的数据:

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")

    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    # One protocol instance will be created to serve all
    # client requests.
    transport, protocol = await loop.create_datagram_endpoint(
        lambda: EchoServerProtocol(),
        local_addr=('127.0.0.1', 9999))

    try:
        await asyncio.sleep(3600)  # Serve for 1 hour.
    finally:
        transport.close()

asyncio.run(main())

UDP 回显客户端

使用 loop.create_datagram_endpoint() 方法的 UDP 回显客户端，发送数据并在收到回应时关闭传输:

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():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    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())

链接已存在的套接字

附带一个协议使用 loop.create_connection() 方法，等待直到套接字接收数据:

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())

        # We are done: close the transport;
        # connection_lost() will be called automatically.
        self.transport.close()

    def connection_lost(self, exc):
        # The socket has been closed
        self.on_con_lost.set_result(True)

async def main():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()
    on_con_lost = loop.create_future()

    # Create a pair of connected sockets
    rsock, wsock = socket.socketpair()

    # Register the socket to wait for data.
    transport, protocol = await loop.create_connection(
        lambda: MyProtocol(on_con_lost), sock=rsock)

    # Simulate the reception of data from the network.
    loop.call_soon(wsock.send, 'abc'.encode())

    try:
        await protocol.on_con_lost
    finally:
        transport.close()
        wsock.close()

asyncio.run(main())

参见

使用低层级的 loop.add_reader() 方法来注册一个 FD 的 监视文件描述符以读取事件 示例。

使用在协程中通过 open_connection() 函数创建的高层级流的 注册一个打开的套接字以等待使用流的数据 示例。

loop.subprocess_exec() 与 SubprocessProtocol

一个使用子进程协议来获取子进程的输出并等待子进程退出的示例。

这个子进程是由 loop.subprocess_exec() 方法创建的:

import asyncio
import sys

class DateProtocol(asyncio.SubprocessProtocol):
    def __init__(self, exit_future):
        self.exit_future = exit_future
        self.output = bytearray()

    def pipe_data_received(self, fd, data):
        self.output.extend(data)

    def process_exited(self):
        self.exit_future.set_result(True)

async def get_date():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    code = 'import datetime; print(datetime.datetime.now())'
    exit_future = asyncio.Future(loop=loop)

    # Create the subprocess controlled by DateProtocol;
    # redirect the standard output into a pipe.
    transport, protocol = await loop.subprocess_exec(
        lambda: DateProtocol(exit_future),
        sys.executable, '-c', code,
        stdin=None, stderr=None)

    # Wait for the subprocess exit using the process_exited()
    # method of the protocol.
    await exit_future

    # Close the stdout pipe.
    transport.close()

    # Read the output which was collected by the
    # pipe_data_received() method of the protocol.
    data = bytes(protocol.output)
    return data.decode('ascii').rstrip()

date = asyncio.run(get_date())
print(f"Current date: {date}")

另请参阅使用高层级 API 编写的 相同示例。

策略

事件循环策略是一个用于获取和设置当前 事件循环 的全局对象，还可以创建新的事件循环。 默认策略可以可以被 替换 为 内置替代策略 以使用不同的事件循环实现，或者替换为可以覆盖这些行为的 自定义策略。

策略对象 可为每个 context 获取和设置单独的事件循环。 在默认情况下是分线程，不过自定义策略可以按不同的方式定义 context。

自定义事件循环策略可以控制 get_event_loop(), set_event_loop() 和 new_event_loop() 的行为。

策略对象应该实现 AbstractEventLoopPolicy 抽象基类中定义的API。

获取和设置策略

可以使用下面函数获取和设置当前进程的策略:

asyncio.get_event_loop_policy()

返回当前进程域的策略。

asyncio.set_event_loop_policy(policy)

将 policy 设置为当前进程域策略。

如果 policy 设为 None 将恢复默认策略。

策略对象

抽象事件循环策略基类定义如下:

class asyncio.AbstractEventLoopPolicy

异步策略的抽象基类。

get_event_loop()

为当前上下文获取事件循环。

返回一个实现 AbstractEventLoop 接口的事件循环对象。

该方法永远不应返回 None。

在 3.6 版更改.

set_event_loop(loop)

将当前上下文的事件循环设置为 loop 。

new_event_loop()

创建并返回一个新的事件循环对象。

该方法永远不应返回 None。

get_child_watcher()

获取子进程监视器对象。

返回一个实现 AbstractChildWatcher 接口的监视器对象。

该函数仅支持Unix。

set_child_watcher(watcher)

将当前子进程监视器设置为 watcher 。

该函数仅支持Unix。

asyncio附带下列内置策略:

class asyncio.DefaultEventLoopPolicy

默认的 asyncio 策略。 在 Unix 上使用 SelectorEventLoop 而在 Windows 上使用 ProactorEventLoop。

不需要手动安装默认策略。asyncio已配置成自动使用默认策略。

在 3.8 版更改: 在 Windows 上，现在默认会使用 ProactorEventLoop。

注解

在 Python 3.10.9, 3.11.1 和 3.12 等版本中默认 asyncio 策略的 get_event_loop() 方法将在没有正在运行的事件循环且未设置当前循环时发出 DeprecationWarning。 在未来的某个 Python 发布版中这将改为发出错误。

class asyncio.WindowsSelectorEventLoopPolicy

一个使用 SelectorEventLoop 事件循环实现的替代事件循环策略。

可用性: Windows。

class asyncio.WindowsProactorEventLoopPolicy

使用 ProactorEventLoop 事件循环实现的另一种事件循环策略。

可用性: Windows。

进程监视器

进程监视器允许定制事件循环如何监视Unix子进程。具体来说，事件循环需要知道子进程何时退出。

在asyncio中子进程由 create_subprocess_exec() 和 loop.subprocess_exec() 函数创建。

asyncio 定义了 AbstractChildWatcher 抽象基类，子监视器必须要实现它，并具有四种不同实现: ThreadedChildWatcher (已配置为默认使用), MultiLoopChildWatcher, SafeChildWatcher 和 FastChildWatcher。

请参阅 子进程和线程 部分。

以下两个函数可用于自定义子进程监视器实现，它将被asyncio事件循环使用:

asyncio.get_child_watcher()

返回当前策略的当前子监视器。

asyncio.set_child_watcher(watcher)

将当前策略的子监视器设置为 watcher 。watcher 必须实现 AbstractChildWatcher 基类定义的方法。

注解

第三方事件循环实现可能不支持自定义子监视器。对于这样的事件循环，禁止使用 set_child_watcher() 或不起作用。

class asyncio.AbstractChildWatcher

add_child_handler(pid, callback, *args)

注册一个新的子处理回调函数。

安排 callback(pid, returncode, *args) 在进程的PID与 pid 相等时调用。指定另一个同进程的回调函数替换之前的回调处理函数。

回调函数 callback 必须是线程安全。

remove_child_handler(pid)

删除进程PID与 pid 相等的进程的处理函数。

处理函数成功删除时返回 True ，没有删除时返回 False 。

attach_loop(loop)

给一个事件循环绑定监视器。

如果监视器之前已绑定另一个事件循环，那么在绑定新循环前会先解绑原来的事件循环。

注意：循环有可能是 None 。

is_active()

如果监视器已准备好使用则返回 True。

使用 不活动的 当前子监视器生成子进程将引发 RuntimeError。

3.8 新版功能.

close()

关闭监视器。

必须调用这个方法以确保相关资源会被清理。

class asyncio.ThreadedChildWatcher

此实现会为每个生成的子进程启动一具新的等待线程。

即使是当 asyncio 事件循环运行在非主 OS 线程上时它也能可靠地工作。

当处理大量子进程时不存在显著的开销 (每次子进程结束时为 O(1))，但当每个进程启动一个线程时则需要额外的内存。

此监视器会默认被使用。

3.8 新版功能.

class asyncio.MultiLoopChildWatcher

此实现会在实例化时注册一个 SIGCHLD 信号处理程序。 这可能会破坏为 SIGCHLD 信号安装自定义处理程序的第三方代码。

此监视器会在收到 SIGCHLD 信号时通过显式地轮询每个进程来避免干扰其他代码生成的进程。

该监视器一旦被安装就不会限制从不同线程运行子进程。

该解决方案是安全的，但在处理大量进程时会有显著的开销 (每收到一个 SIGCHLD 时为 O(n))。

3.8 新版功能.

class asyncio.SafeChildWatcher

该实现会使用主线程中的活动事件循环来处理 SIGCHLD 信号。 如果主线程没有正在运行的事件循环，则其他线程无法生成子进程 (会引发 RuntimeError)。

此监视器会在收到 SIGCHLD 信号时通过显式地轮询每个进程来避免干扰其他代码生成的进程。

该解决方案与 MultiLoopChildWatcher 同样安全并同样具有 O(N) 复杂度，但需要主线程有正在运行的事件循环才能工作。

class asyncio.FastChildWatcher

这种实现直接调用 os.waitpid(-1) 来获取所有已结束的进程，可能会中断其它代码洐生进程并等待它们结束。

在处理大量子监视器时没有明显的开销( O(1) 每次子监视器结束)。

该解决方案需要主线程有正在运行的事件循环才能工作，这与 SafeChildWatcher 一样。

class asyncio.PidfdChildWatcher

这个实现会轮询处理文件描述符 (pidfds) 以等待子进程终结。 在某些方面，PidfdChildWatcher 是一个“理想的”子进程监视器实现。 它不需要使用信号或线程，不会介入任何在事件循环以外发起的进程，并能随事件循环发起的子进程数量进行线性伸缩。 其主要缺点在于 pidfds 是 Linux 专属的，并且仅在较近版本的核心（5.3+）上可用。

3.9 新版功能.

自定义策略

要实现一个新的事件循环策略，建议子类化 DefaultEventLoopPolicy 并重写需要定制行为的方法，例如:

class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy):

    def get_event_loop(self):
        """Get the event loop.

        This may be None or an instance of EventLoop.
        """
        loop = super().get_event_loop()
        # Do something with loop ...
        return loop

asyncio.set_event_loop_policy(MyEventLoopPolicy())

平台支持

asyncio 模块被设计为可移植的,但由于平台的底层架构和功能，一些平台存在细微的差异和限制。

所有平台

loop.add_reader() 和 loop.add_writer() 不能用来监视文件I/O。

Windows

源代码: Lib/asyncio/proactor_events.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/proactor_events.py], Lib/asyncio/windows_events.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/windows_events.py], Lib/asyncio/windows_utils.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/windows_utils.py]

在 3.8 版更改: 在 Windows 上，ProactorEventLoop 现在是默认的事件循环。

Windows上的所有事件循环都不支持以下方法:

不支持 loop.create_unix_connection() 和 loop.create_unix_server() 。 socket.AF_UNIX 套接字相关参数仅限于Unix。

不支持 loop.add_signal_handler() 和 loop.remove_signal_handler() 。

SelectorEventLoop 有下列限制:

SelectSelector 只被用于等待套接字事件：它支持套接字且最多支持512个套接字。

loop.add_reader() 和 loop.add_writer() 只接受套接字处理回调函数(如管道、文件描述符等都不支持)。

因为不支持管道，所以 loop.connect_read_pipe() 和 loop.connect_write_pipe() 方法没有实现。

不支持 Subprocesses ，也就是 loop.subprocess_exec() 和 loop.subprocess_shell() 方法没有实现。

ProactorEventLoop 有下列限制:

不支持 loop.add_reader() 和 loop.add_writer() 方法。

Windows上单调时钟的分辨率大约为 15.6 毫秒。最佳的分辨率是 0.5 毫秒。分辨率依赖于具体的硬件（HPET [https://zh.wikipedia.org/wiki/高精度事件计时器]）和Windows的设置。

Windows的子进程支持

在 Windows 上，默认的事件循环 ProactorEventLoop 支持子进程，而 SelectorEventLoop 则不支持。

也不支持 policy.set_child_watcher() 函数，ProactorEventLoop 有不同的机制来监视子进程。

macOS

完整支持流行的macOS版本。

macOS <= 10.8

在 macOS 10.6, 10.7 和 10.8 上，默认的事件循环使用 selectors.KqueueSelector，在这些版本上它并不支持字符设备。 可以手工配置 SelectorEventLoop 来使用 SelectSelector 或 PollSelector 以在这些较老版本的 macOS 上支持字符设备。 例如:

import asyncio
import selectors

selector = selectors.SelectSelector()
loop = asyncio.SelectorEventLoop(selector)
asyncio.set_event_loop(loop)

高层级 API 索引

这个页面列举了所有能用于 async/wait 的高层级asyncio API 集。

任务

运行异步程序，创建Task对象，等待多件事运行超时的公共集。

run() | 创建事件循环，运行一个协程，关闭事件循环。
create_task() | 启动一个asyncio的Task对象。
await sleep() | 休眠几秒。
await gather() | 并发执行所有事件的调度和等待。
await wait_for() | 有超时控制的运行。
await shield() | 屏蔽取消操作
await wait() | 完成情况的监控器
current_task() | 返回当前Task对象
all_tasks() | 返回事件循环中所有的task对象。
Task | Task对象
to_thread() | 在不同的 OS 线程中异步地运行一个函数。
run_coroutine_threadsafe() | 从其他OS线程中调度一个协程。
for in as_completed() | 用 for 循环监控完成情况。

例子

使用 asyncio.gather() 并行运行.

使用 asyncio.wait_for() 强制超时.

撤销协程.

asyncio.sleep() 的用法.

请主要参阅 协程与任务文档.

队列集

队列集被用于多个异步Task对象的运行调度，实现连接池以及发布/订阅模式。

Queue | 先进先出队列
PriorityQueue | 优先级队列。
LifoQueue | 后进先出队列。

例子

使用 asyncio.Queue 在多个并发任务间分配工作量.

请参阅 队列集文档.

子进程集

用于生成子进程和运行shell命令的工具包。

await create_subprocess_exec() | 创建一个子进程。
await create_subprocess_shell() | 运行一个shell命令。

例子

执行一个shell命令.

请参阅 子进程 APIs 相关文档.

流

用于网络IO处理的高级API集。

await open_connection() | 建立一个TCP连接。
await open_unix_connection() | 建立一个Unix socket连接。
await start_server() | 启动TCP服务。
await start_unix_server() | 启动一个 Unix 套接字服务。
StreamReader | 接收网络数据的高级async/await对象。
StreamWriter | 发送网络数据的高级async/await对象。

例子

TCP 客户端样例.

请参阅 streams APIs 文档。

同步

能被用于Task对象集的，类似线程的同步基元组件。

Lock | 互斥锁。
Event | 事件对象。
Condition | 条件对象
Semaphore | 信号量
BoundedSemaphore | 有界的信号量。

例子

asyncio.Event 的用法.

请参阅asyncio文档 synchronization primitives.

异常

asyncio.TimeoutError | 类似 wait_for() 等函数在超时时候被引发。请注意 asyncio.TimeoutError 与内建异常 TimeoutError 无关。
asyncio.CancelledError | 当一个Task对象被取消的时候被引发。请参阅 Task.cancel()。

例子

在取消请求发生的运行代码中如何处理CancelledError异常.

请参阅完整的 asyncio 专用异常 列表.

低层级 API 索引

本页列出所有低层级的 asyncio API。

获取事件循环

asyncio.get_running_loop() | 获取当前运行的事件循环 首选 函数。
asyncio.get_event_loop() | 获取一个事件循环实例（正在运行的事件循环或通过当前策略确定的当前事件循环）。
asyncio.set_event_loop() | 通过当前策略将事件循环设置当前事件循环。
asyncio.new_event_loop() | 创建一个新的事件循环。

例子

使用asyncio.get_running_loop()。

事件循环方法集

另请参阅有关 事件循环方法集 的主文档章节。

生命周期

loop.run_until_complete() | 运行一个期程/任务/可等待对象直到完成。
loop.run_forever() | 一直运行事件循环。
loop.stop() | 停止事件循环。
loop.close() | 关闭事件循环。
loop.is_running() | 返回 True ， 如果事件循环正在运行。
loop.is_closed() | 返回 True ，如果事件循环已经被关闭 。
await loop.shutdown_asyncgens() | 关闭异步生成器。

调试

loop.set_debug() | 开启或禁用调试模式。
loop.get_debug() | 获取当前测试模式。

调度回调函数

loop.call_soon() | 尽快调用回调。
loop.call_soon_threadsafe() | loop.call_soon() 方法线程安全的变体。
loop.call_later() | 在给定时间 之后 调用回调函数。
loop.call_at() | 在 指定 时间调用回调函数。

线程/进程池

await loop.run_in_executor() | 在 concurrent.futures 执行器中运行一个独占CPU或其它阻塞函数。
loop.set_default_executor() | 设置 loop.run_in_executor() 默认执行器。

任务与期程

loop.create_future() | 创建一个 Future 对象。
loop.create_task() | 将协程当作 Task 一样调度。
loop.set_task_factory() | 设置 loop.create_task() 使用的工厂，它将用来创建 Tasks 。
loop.get_task_factory() | 获取 loop.create_task() 使用的工厂，它用来创建 Tasks 。

DNS

await loop.getaddrinfo() | 异步版的 socket.getaddrinfo() 。
await loop.getnameinfo() | 异步版的 socket.getnameinfo() 。

网络和IPC

await loop.create_connection() | 打开一个TCP链接。
await loop.create_server() | 创建一个TCP服务。
await loop.create_unix_connection() | 打开一个Unix socket连接。
await loop.create_unix_server() | 创建一个Unix socket服务。
await loop.connect_accepted_socket() | 将 socket 包装成 (transport, protocol) 对。
await loop.create_datagram_endpoint() | 打开一个数据报(UDP)连接。
await loop.sendfile() | 通过传输通道发送一个文件。
await loop.start_tls() | 将一个已建立的链接升级到TLS。
await loop.connect_read_pipe() | 将管道读取端包装成 (transport, protocol) 对。
await loop.connect_write_pipe() | 将管道写入端包装成 (transport, protocol) 对。

套接字

await loop.sock_recv() | 从 socket 接收数据。
await loop.sock_recv_into() | 从 socket 接收数据到一个缓冲区中。
await loop.sock_sendall() | 发送数据到 socket 。
await loop.sock_connect() | 链接 await loop.sock_connect() 。
await loop.sock_accept() | 接受一个 socket 链接。
await loop.sock_sendfile() | 利用 socket 发送一个文件。
loop.add_reader() | 开始对一个文件描述符的可读性的监视。
loop.remove_reader() | 停止对一个文件描述符的可读性的监视。
loop.add_writer() | 开始对一个文件描述符的可写性的监视。
loop.remove_writer() | 停止对一个文件描述符的可写性的监视。

Unix信号

loop.add_signal_handler() | 给 signal 添加一个处理回调函数。
loop.remove_signal_handler() | 删除 signal 的处理回调函数。

子进程集

loop.subprocess_exec() | 衍生一个子进程
loop.subprocess_shell() | 从终端命令衍生一个子进程。

错误处理

loop.call_exception_handler() | 调用异常处理器。
loop.set_exception_handler() | 设置一个新的异常处理器。
loop.get_exception_handler() | 获取当前异常处理器。
loop.default_exception_handler() | 默认异常处理器实现。

例子

使用 asyncio.get_event_loop() 和 loop.run_forever().

使用 loop.call_later().

使用 loop.create_connection() 实现 echo客户端.

使用 loop.create_connection() 去 链接socket.

使用add_reader()监听FD(文件描述符)的读取事件.

使用loop.add_signal_handler().

使用loop.add_signal_handler()。

传输

所有传输都实现以下方法:

transport.close() | 关闭传输。
transport.is_closing() | 返回 True ，如果传输正在关闭或已经关闭。
transport.get_extra_info() | 请求传输的相关信息。
transport.set_protocol() | 设置一个新协议。
transport.get_protocol() | 返回当前协议。

传输可以接收数据(TCP和Unix链接，管道等)。它通过 loop.create_connection(), loop.create_unix_connection(), loop.connect_read_pipe() 等方法返回。

读取传输

transport.is_reading() | 返回 True ，如果传输正在接收。
transport.pause_reading() | 暂停接收。
transport.resume_reading() | 继续接收。

传输可以发送数据(TCP和Unix链接，管道等)。它通过 loop.create_connection(), loop.create_unix_connection(), loop.connect_write_pipe() 等方法返回。

写入传输

transport.write() | 向传输写入数据。
transport.write() | 向传输写入缓冲。
transport.can_write_eof() | 返回 True ，如果传输支持发送 EOF。
transport.write_eof() | 在冲洗已缓冲的数据后关闭传输和发送EOF。
transport.abort() | 立即关闭传输。
transport.get_write_buffer_size() | 返回当前输出缓冲区的大小。
transport.get_write_buffer_limits() | 返回写入流控制的高位标记位和低位标记位。
transport.set_write_buffer_limits() | 设置新的写入流控制的高位标记位和低位标记位。

由 loop.create_datagram_endpoint() 返回的传输:

数据报传输

transport.sendto() | 发送数据到远程链接端。
transport.abort() | 立即关闭传输。

基于子进程的底层抽象传输，它由 loop.subprocess_exec() 和 loop.subprocess_shell() 返回:

子进程传输

transport.get_pid() | 返回子进程的进程ID。
transport.get_pipe_transport() | 返回请求通信管道 (stdin, stdout, 或 stderr)的传输。
transport.get_returncode() | 返回子进程的返回代号。
transport.kill() | 杀死子进程。
transport.send_signal() | 发送一个信号到子进程。
transport.terminate() | 停止子进程。
transport.close() | 杀死子进程并关闭所有管道。

协议

协议类可以由下面 回调方法 实现：

callback connection_made() | 连接建立时被调用。
callback connection_lost() | 连接丢失或关闭时将被调用。
callback pause_writing() | 传输的缓冲区超过高位标记位时被调用。
callback resume_writing() | 传输的缓冲区传送到低位标记位时被调用。

流协议 (TCP, Unix 套接字, 管道)

callback data_received() | 接收到数据时被调用。
callback eof_received() | 接收到EOF时被调用。

缓冲流协议

callback get_buffer() | 调用后会分配新的接收缓冲区。
callback buffer_updated() | 用接收的数据更新缓冲区时被调用。
callback eof_received() | 接收到EOF时被调用。

数据报协议

callback datagram_received() | 接收到数据报时被调用。
callback error_received() | 前一个发送或接收操作引发 OSError 时被调用。

子进程协议

callback pipe_data_received() | 子进程向 stdout 或 stderr 管道写入数据时被调用。
callback pipe_connection_lost() | 与子进程通信的其中一个管道关闭时被调用。
callback process_exited() | 子进程退出时被调用。

事件循环策略

策略是改变 asyncio.get_event_loop() 这类函数行为的一个底层机制。更多细节可以查阅 策略部分。

访问策略

asyncio.get_event_loop_policy() | 返回当前进程域的策略。
asyncio.set_event_loop_policy() | 设置一个新的进程域策略。
AbstractEventLoopPolicy | 策略对象的基类。

用 asyncio 开发

异步编程与传统的“顺序”编程不同。

本页列出常见的错误和陷阱，并解释如何避免它们。

Debug 模式

默认情况下，asyncio以生产模式运行。为了简化开发，asyncio还有一种*debug 模式* 。

有几种方法可以启用异步调试模式:

将 PYTHONASYNCIODEBUG 环境变量设置为 1 。

使用 Python 开发模式。

将 debug=True 传递给 asyncio.run() 。

调用 loop.set_debug() 。

除了启用调试模式外，还要考虑:

将 asyncio logger 的日志级别设置为 logging.DEBUG，例如，下面的代码片段可以在应用程序启动时运行:

logging.basicConfig(level=logging.DEBUG)

配置 warnings 模块以显示 ResourceWarning 警告。一种方法是使用 -W default 命令行选项。

启用调试模式时:

asyncio 检查 未被等待的协程 并记录他们；这将消除“被遗忘的等待”问题。

许多非线程安全的异步 APIs (例如 loop.call_soon() 和 loop.call_at() 方法)，如果从错误的线程调用，则会引发异常。

如果执行I/O操作花费的时间太长，则记录I/O选择器的执行时间。

执行时间超过100毫秒的回调将会载入日志。 属性 loop.slow_callback_duration 可用于设置以秒为单位的最小执行持续时间，这被视为“缓慢”。

并发性和多线程

事件循环在线程中运行(通常是主线程)，并在其线程中执行所有回调和任务。当一个任务在事件循环中运行时，没有其他任务可以在同一个线程中运行。当一个任务执行一个 await 表达式时，正在运行的任务被挂起，事件循环执行下一个任务。

要调度来自另一 OS 线程的 callback，应该使用 loop.call_soon_threadsafe() 方法。 例如:

loop.call_soon_threadsafe(callback, *args)

几乎所有异步对象都不是线程安全的，这通常不是问题，除非在任务或回调函数之外有代码可以使用它们。如果需要这样的代码来调用低级异步API，应该使用 loop.call_soon_threadsafe() 方法，例如:

loop.call_soon_threadsafe(fut.cancel)

要从不同的OS线程调度一个协程对象，应该使用 run_coroutine_threadsafe() 函数。它返回一个 concurrent.futures.Future 。查询结果:

async def coro_func():
     return await asyncio.sleep(1, 42)

# Later in another OS thread:

future = asyncio.run_coroutine_threadsafe(coro_func(), loop)
# Wait for the result:
result = future.result()

为了能够处理信号和执行子进程，事件循环必须运行于主线程中。

方法 loop.run_in_executor() 可以和 concurrent.futures.ThreadPoolExecutor 一起使用，用于在一个不同的操作系统线程中执行阻塞代码，并避免阻塞运行事件循环的那个操作系统线程。

目前没有办法直接从另一个进程（如使用 multiprocessing 启动的进程）安排协程或回调。 事件循环方法集 小节列出了一些可以从管道读取并监视文件描述符而不会阻塞事件循环的 API。 此外，asyncio 的 子进程 API 提供了一种启动进程并在事件循环中与其通信的办法。 最后，之前提到的 loop.run_in_executor() 方法也可以配合 concurrent.futures.ProcessPoolExecutor 使用以在另一个进程中执行代码。

运行阻塞的代码

不应该直接调用阻塞( CPU 绑定)代码。例如，如果一个函数执行1秒的 CPU 密集型计算，那么所有并发异步任务和 IO 操作都将延迟1秒。

可以用执行器在不同的线程甚至不同的进程中运行任务，以避免使用事件循环阻塞 OS 线程。 请参阅 loop.run_in_executor() 方法了解详情。

日志记录

asyncio使用 logging 模块，所有日志记录都是通过 "asyncio" logger执行的。

默认日志级别是 logging.INFO 。可以很容易地调整:

logging.getLogger("asyncio").setLevel(logging.WARNING)

网络日志会阻塞事件循环。 建议使用一个单独进程来处理日志或者使用非阻塞式 IO。 例如，可以参阅 处理日志 handler 的阻塞。

检测 never-awaited 协同程序

当协程函数被调用而不是被等待时 (即执行 coro() 而不是 await coro()) 或者协程没有通过 asyncio.create_task() 被排入计划日程，asyncio 将会发出一条 RuntimeWarning:

import asyncio

async def test():
    print("never scheduled")

async def main():
    test()

asyncio.run(main())

输出:

test.py:7: RuntimeWarning: coroutine 'test' was never awaited
  test()

调试模式的输出:

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()

通常的修复方法是等待协程或者调用 asyncio.create_task() 函数:

async def main():
    await test()

检测就再也没异常

如果调用 Future.set_exception() ，但不等待 Future 对象，将异常传播到用户代码。在这种情况下，当 Future 对象被垃圾收集时，asyncio将发出一条日志消息。

未处理异常的例子:

import asyncio

async def bug():
    raise Exception("not consumed")

async def main():
    asyncio.create_task(bug())

asyncio.run(main())

输出:

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

激活调试模式 以获取任务创建处的跟踪信息:

asyncio.run(main(), debug=True)

调试模式的输出:

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

socket --- 底层网络接口

源代码: Lib/socket.py [https://github.com/python/cpython/tree/3.10/Lib/socket.py]

这个模块提供了访问 BSD 套接字 的接口。在所有现代 Unix 系统、Windows、macOS 和其他一些平台上可用。

注解

一些行为可能因平台不同而异，因为调用的是操作系统的套接字API。

这个Python接口是用Python的面向对象风格对Unix系统调用和套接字库接口的直译：函数 socket() 返回一个 套接字对象 ，其方法是对各种套接字系统调用的实现。形参类型一般与C接口相比更高级：例如在Python文件 read() 和 write() 操作中，接收操作的缓冲区分配是自动的，发送操作的缓冲区长度是隐式的。

参见

模块 socketserver

用于简化网络服务端编写的类。

模块 ssl

套接字对象的TLS/SSL封装。

套接字协议族

根据系统以及构建选项，此模块提供了各种套接字协议簇。

特定的套接字对象需要的地址格式将根据此套接字对象被创建时指定的地址族被自动选择。套接字地址表示如下：

一个绑定在文件系统节点上的 AF_UNIX 套接字的地址表示为一个字符串，使用文件系统字符编码和 'surrogateescape' 错误回调方法（see PEP 383 [https://www.python.org/dev/peps/pep-0383]）。一个地址在 Linux 的抽象命名空间被返回为带有初始的 null 字节的 字节类对象 ；注意在这个命名空间种的套接字可能与普通文件系统套接字通信，所以打算运行在 Linux 上的程序可能需要解决两种地址类型。当传递为参数时，一个字符串或字节类对象可以用于任一类型的地址。

在 3.3 版更改: 之前，AF_UNIX 套接字路径被假设使用 UTF-8 编码。

在 3.5 版更改: 现在接受可写的 字节类对象。

一对 (host, port) 被用作 AF_INET 地址族，其中 host 是一个表示互联网域名标记形式的主机名例如 'daring.cwi.nl' 或者 IPv4 地址例如 '100.50.200.5' 的字符串，而 port 是一个整数值。

对于 IPv4 地址，有两种可接受的特殊形式被用来代替一个主机地址： '' 代表 INADDR_ANY，用来绑定到所有接口；字符串 '<broadcast>' 代表 INADDR_BROADCAST。此行为不兼容 IPv6，因此，如果你的 Python 程序打算支持 IPv6，则可能需要避开这些。

对于 AF_INET6 地址族，使用一个四元组 (host, port, flowinfo, scope_id)，其中 flowinfo 和 scope_id 代表了 C 库 struct sockaddr_in6 中的 sin6_flowinfo 和 sin6_scope_id 成员。对于 socket 模块中的方法， flowinfo 和 scope_id 可以被省略，只为了向后兼容。注意，省略 scope_id 可能会导致操作带有领域 (Scope) 的 IPv6 地址时出错。

在 3.7 版更改: 对于多播地址（其 scope_id 起作用），地址 中可以不包含 %scope_id （或 zone id ）部分，这部分是多余的，可以放心省略（推荐）。

AF_NETLINK 套接字由一对 (pid, groups) 表示。

指定 AF_TIPC 地址族可以使用仅 Linux 支持的 TIPC 协议。TIPC 是一种开放的、非基于 IP 的网络协议，旨在用于集群计算环境。其地址用元组表示，其中的字段取决于地址类型。一般元组形式为 (addr_type, v1, v2, v3 [, scope])，其中：

addr_type 取 TIPC_ADDR_NAMESEQ、TIPC_ADDR_NAME 或 TIPC_ADDR_ID 中的一个。

scope 取 TIPC_ZONE_SCOPE、TIPC_CLUSTER_SCOPE 和 TIPC_NODE_SCOPE 中的一个。

如果 addr_type 为 TIPC_ADDR_NAME，那么 v1 是服务器类型，v2 是端口标识符，v3 应为 0。

如果 addr_type 为 TIPC_ADDR_NAMESEQ，那么 v1 是服务器类型，v2 是端口号下限，而 v3 是端口号上限。

如果 addr_type 为 TIPC_ADDR_ID，那么 v1 是节点 (node)，v2 是 ref，v3 应为 0。

AF_CAN 地址族使用元组 (interface, )，其中 interface 是表示网络接口名称的字符串，如 'can0'。网络接口名 '' 可以用于接收本族所有网络接口的数据包。

CAN_ISOTP 协议接受一个元组 (interface, rx_addr, tx_addr)，其中两个额外参数都是无符号长整数，都表示 CAN 标识符（标准或扩展标识符）。

CAN_J1939 协议接受一个元组 (interface, name, pgn, addr)，其中额外参数有：表示 ECU 名称的 64 位无符号整数，表示参数组号 (Parameter Group Number, PGN) 的 32 位无符号整数，以及表示地址的 8 位整数。

PF_SYSTEM 协议族的 SYSPROTO_CONTROL 协议使用一个字符串或元组 (id, unit)。 这个字符串是使用动态分配 ID 的内核控件名称。 如果 ID 和内核控件的单元编号都已知或者使用了已注册的 ID 则可以使用元组。

3.3 新版功能.

AF_BLUETOOTH 支持以下协议和地址格式：

BTPROTO_L2CAP 接受 (bdaddr, psm)，其中 bdaddr 为字符串格式的蓝牙地址，psm 是一个整数。

BTPROTO_RFCOMM 接受 (bdaddr, channel)，其中 bdaddr 为字符串格式的蓝牙地址，channel 是一个整数。

BTPROTO_HCI 接受 (device_id,)，其中 device_id 为整数或字符串，它表示接口对应的蓝牙地址（具体取决于你的系统，NetBSD 和 DragonFlyBSD 需要蓝牙地址字符串，其他系统需要整数）。

在 3.2 版更改: 添加了对 NetBSD 和 DragonFlyBSD 的支持。

BTPROTO_SCO 接受 bdaddr，其中 bdaddr 是 bytes 对象，其中含有字符串格式的蓝牙地址（如 b'12:23:34:45:56:67' ），FreeBSD 不支持此协议。

AF_ALG 是一个仅 Linux 可用的、基于套接字的接口，用于连接内核加密算法。算法套接字可用包括 2 至 4 个元素的元组来配置 (type, name [, feat [, mask]])，其中：

type 是表示算法类型的字符串，如 aead、hash、skcipher 或 rng。

name 是表示算法类型和操作模式的字符串，如 sha256、hmac(sha256)、cbc(aes) 或 drbg_nopr_ctr_aes256。

feat 和 mask 是无符号 32 位整数。

Availability: Linux 2.6.38, some algorithm types require more recent Kernels.

3.6 新版功能.

AF_VSOCK 用于支持虚拟机与宿主机之间的通讯。该套接字用 (CID, port) 元组表示，其中 Context ID (CID) 和 port 都是整数。

Availability: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX Workstation >= 6.5.

3.7 新版功能.

AF_PACKET 是一个底层接口，直接连接至网卡。数据包使用元组 (ifname, proto[, pkttype[, hatype[, addr]]]) 表示，其中：

ifname - 指定设备名称的字符串。

proto - 一个用网络字节序表示的整数，指定以太网协议版本号。

pkttype - 指定数据包类型的整数（可选）：

PACKET_HOST （默认） - 寻址到本地主机的数据包。

PACKET_BROADCAST - 物理层广播的数据包。

PACKET_MULTIHOST - 发送到物理层多播地址的数据包。

PACKET_OTHERHOST - 被（处于混杂模式的）网卡驱动捕获的、发送到其他主机的数据包。

PACKET_OUTGOING - 来自本地主机的、回环到一个套接字的数据包。

hatype - 可选整数，指定 ARP 硬件地址类型。

addr - 可选的类字节串对象，用于指定硬件物理地址，其解释取决于各设备。

Availability: Linux >= 2.2.

AF_QIPCRTR 是一个仅 Linux 可用的、基于套接字的接口，用于与高通平台中协处理器上运行的服务进行通信。该地址簇用一个 (node, port) 元组表示，其中 node 和 port 为非负整数。

Availability: Linux >= 4.7.

3.8 新版功能.

IPPROTO_UDPLITE 是一种 UDP 的变体，允许指定数据包的哪一部分计算入校验码内。它添加了两个可以修改的套接字选项。self.setsockopt(IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, length) 修改传出数据包的哪一部分计算入校验码内，而 self.setsockopt(IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, length) 将过滤掉计算入校验码的数据太少的数据包。在这两种情况下，length 都应在 range(8, 2**16, 8) 范围内。

对于 IPv4，应使用 socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE) 来构造这样的套接字；对于 IPv6，应使用 socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE) 来构造这样的套接字。

Availability: Linux >= 2.6.20, FreeBSD >= 10.1-RELEASE

3.9 新版功能.

如果你在 IPv4/v6 套接字地址的 host 部分中使用了一个主机名，此程序可能会表现不确定行为，因为 Python 使用 DNS 解析返回的第一个地址。套接字地址在实际的 IPv4/v6 中以不同方式解析，根据 DNS 解析和/或 host 配置。为了确定行为，在 host 部分中使用数字的地址。

所有错误都会引发异常。 普通异常将针对无效的参数类型和内存不足等情况被引发。 与套接字或地址语义有关的错误则会引发 OSError 或它的某个子类。

可以用 setblocking() 设置非阻塞模式。一个基于超时的 generalization 通过 settimeout() 支持。

模块内容

socket 模块包含下列元素。

异常

exception socket.error

一个被弃用的 OSError 的别名。

在 3.3 版更改: 根据 PEP 3151 [https://www.python.org/dev/peps/pep-3151]，这个类是 OSError 的别名。

exception socket.herror

OSError 的子类，本异常通常表示与地址相关的错误，比如那些在 POSIX C API 中使用了 h_errno 的函数，包括 gethostbyname_ex() 和 gethostbyaddr()。附带的值是一对 (h_errno, string)，代表库调用返回的错误。h_errno 是一个数字，而 string 表示 h_errno 的描述，它们由 C 函数 hstrerror() 返回。

在 3.3 版更改: 此类是 OSError 的子类。

exception socket.gaierror

OSError 的子类，本异常来自 getaddrinfo() 和 getnameinfo()，表示与地址相关的错误。附带的值是一对 (error, string)，代表库调用返回的错误。string 表示 error 的描述，它由 C 函数 gai_strerror() 返回。数字值 error 与本模块中定义的 EAI_* 常量之一匹配。

在 3.3 版更改: 此类是 OSError 的子类。

exception socket.timeout

TimeoutError 的已被弃用的别名。

OSError 的子类，当套接字发生超时，且事先已调用过 settimeout() （或隐式地通过 setdefaulttimeout() ）启用了超时，则会抛出此异常。附带的值是一个字符串，其值总是 "timed out"。

在 3.3 版更改: 此类是 OSError 的子类。

在 3.10 版更改: 这个类是 TimeoutError 的别名。

常量

AF_* 和 SOCK_* 常量现在都在 AddressFamily 和 SocketKind 这两个 IntEnum 集合内。

3.4 新版功能.

socket.AF_UNIX

socket.AF_INET

socket.AF_INET6

这些常量表示地址（和协议）簇，用于 socket() 的第一个参数。如果 AF_UNIX 常量未定义，即表示不支持该协议。不同系统可能会有更多其他常量可用。

socket.SOCK_STREAM

socket.SOCK_DGRAM

socket.SOCK_RAW

socket.SOCK_RDM

socket.SOCK_SEQPACKET

这些常量表示套接字类型，用于 socket() 的第二个参数。不同系统可能会有更多其他常量可用。（一般只有 SOCK_STREAM 和 SOCK_DGRAM 可用）

socket.SOCK_CLOEXEC

socket.SOCK_NONBLOCK

这两个常量（如果已定义）可以与上述套接字类型结合使用，允许你设置这些原子性相关的 flags （从而避免可能的竞争条件和单独调用的需要）。

参见

安全文件描述符处理 [https://udrepper.livejournal.com/20407.html] 提供了更详尽的解释。

可用性： Linux >= 2.6.27。

3.2 新版功能.

SO_*

socket.SOMAXCONN

MSG_*

SOL_*

SCM_*

IPPROTO_*

IPPORT_*

INADDR_*

IP_*

IPV6_*

EAI_*

AI_*

NI_*

TCP_*

此列表内的许多常量，记载在 Unix 文档中的套接字和/或 IP 协议部分，同时也定义在本 socket 模块中。它们通常用于套接字对象的 setsockopt() 和 getsockopt() 方法的参数中。在大多数情况下，仅那些在 Unix 头文件中有定义的符号会在本模块中定义，部分符号提供了默认值。

在 3.6 版更改: 添加了 SO_DOMAIN, SO_PROTOCOL, SO_PEERSEC, SO_PASSSEC, TCP_USER_TIMEOUT, TCP_CONGESTION。

在 3.6.5 版更改: 在 Windows 上，如果 Windows 运行时支持，则 TCP_FASTOPEN、TCP_KEEPCNT 可用。

在 3.7 版更改: 添加了 TCP_NOTSENT_LOWAT。

在 Windows 上，如果 Windows 运行时支持，则 TCP_KEEPIDLE、TCP_KEEPINTVL 可用。

在 3.10 版更改: 添加了 IP_RECVTOS。 还添加了 TCP_KEEPALIVE。 这个常量在 MacOS 上可以与在 Linux 上使用 TCP_KEEPIDLE 的相同方式被使用。

socket.AF_CAN

socket.PF_CAN

SOL_CAN_*

CAN_*

此列表内的许多常量，记载在 Linux 文档中，同时也定义在本 socket 模块中。

可用性： Linux >= 2.6.25。

3.3 新版功能.

socket.CAN_BCM

CAN_BCM_*

CAN 协议簇内的 CAN_BCM 是广播管理器（Bbroadcast Manager -- BCM）协议，广播管理器常量在 Linux 文档中有所记载，在本 socket 模块中也有定义。

可用性： Linux >= 2.6.25。

注解

CAN_BCM_CAN_FD_FRAME 旗标仅在 Linux >= 4.8 时可用。

3.4 新版功能.

socket.CAN_RAW_FD_FRAMES

在 CAN_RAW 套接字中启用 CAN FD 支持，默认是禁用的。它使应用程序可以发送 CAN 和 CAN FD 帧。但是，从套接字读取时，也必须同时接受 CAN 和 CAN FD 帧。

此常量在 Linux 文档中有所记载。

可用性： Linux >= 3.6。

3.5 新版功能.

socket.CAN_RAW_JOIN_FILTERS

加入已应用的 CAN 过滤器，这样只有与所有 CAN 过滤器匹配的 CAN 帧才能传递到用户空间。

此常量在 Linux 文档中有所记载。

可用性： Linux >= 4.1。

3.9 新版功能.

socket.CAN_ISOTP

CAN 协议簇中的 CAN_ISOTP 就是 ISO-TP (ISO 15765-2) 协议。ISO-TP 常量在 Linux 文档中有所记载。

可用性： Linux >= 2.6.25。

3.7 新版功能.

socket.CAN_J1939

CAN 协议族中的 CAN_J1939 即 SAE J1939 协议。 J1939 常量记录在 Linux 文档中。

可用性： Linux >= 5.4。

3.9 新版功能.

socket.AF_PACKET

socket.PF_PACKET

PACKET_*

此列表内的许多常量，记载在 Linux 文档中，同时也定义在本 socket 模块中。

可用性： Linux >= 2.2。

socket.AF_RDS

socket.PF_RDS

socket.SOL_RDS

RDS_*

此列表内的许多常量，记载在 Linux 文档中，同时也定义在本 socket 模块中。

可用性： Linux >= 2.6.30。

3.3 新版功能.

socket.SIO_RCVALL

socket.SIO_KEEPALIVE_VALS

socket.SIO_LOOPBACK_FAST_PATH

RCVALL_*

Windows 的 WSAIoctl() 的常量。这些常量用于套接字对象的 ioctl() 方法的参数。

在 3.6 版更改: 添加了 SIO_LOOPBACK_FAST_PATH。

TIPC_*

TIPC 相关常量，与 C socket API 导出的常量一致。更多信息请参阅 TIPC 文档。

socket.AF_ALG

socket.SOL_ALG

ALG_*

用于 Linux 内核加密算法的常量。

可用性： Linux >= 2.6.38。

3.6 新版功能.

socket.AF_VSOCK

socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID

VMADDR*

SO_VM*

用于 Linux 宿主机/虚拟机通讯的常量。

可用性： Linux >= 4.8。

3.7 新版功能.

socket.AF_LINK

可用性: BSD、macOS。

3.4 新版功能.

socket.has_ipv6

本常量为一个布尔值，该值指示当前平台是否支持 IPv6。

socket.BDADDR_ANY

socket.BDADDR_LOCAL

这些是字符串常量，包含蓝牙地址，这些地址具有特殊含义。例如，当用 BTPROTO_RFCOMM 指定绑定套接字时， BDADDR_ANY 表示“任何地址”。

socket.HCI_FILTER

socket.HCI_TIME_STAMP

socket.HCI_DATA_DIR

与 BTPROTO_HCI 一起使用。 HCI_FILTER 在 NetBSD 或 DragonFlyBSD 上不可用。 HCI_TIME_STAMP 和 HCI_DATA_DIR 在 FreeBSD、NetBSD 或 DragonFlyBSD 上不可用。

socket.AF_QIPCRTR

高通 IPC 路由协议的常数，用于与提供远程处理器的服务进行通信。

可用性： Linux >= 4.7。

函数

创建套接字

下列函数都能创建 套接字对象.

class socket.socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)

使用给定的地址族、套接字类型和协议号创建一个新的套接字。 地址族应为 AF_INET (默认值), AF_INET6, AF_UNIX, AF_CAN, AF_PACKET 或 AF_RDS 之一。 套接字类型应为 SOCK_STREAM (默认值), SOCK_DGRAM, SOCK_RAW 或其他可能的 SOCK_ 常量之一。 协议号通常为零并且可以省略，或在协议族为 AF_CAN 的情况下，协议应为 CAN_RAW, CAN_BCM, CAN_ISOTP 或 CAN_J1939 之一。

如果指定了 fileno，那么将从这一指定的文件描述符中自动检测 family、type 和 proto 的值。如果调用本函数时显式指定了 family、type 或 proto 参数，可以覆盖自动检测的值。这只会影响 Python 表示诸如 socket.getpeername() 一类函数的返回值的方式，而不影响实际的操作系统资源。与 socket.fromfd() 不同，fileno 将返回原先的套接字，而不是复制出新的套接字。这有助于在分离的套接字上调用 socket.close() 来关闭它。

新创建的套接字是 不可继承的。

引发一个 审计事件 socket.__new__ 并附带参数 self, family, type, protocol。

在 3.3 版更改: 添加了 AF_CAN 簇。添加了 AF_RDS 簇。

在 3.4 版更改: 添加了 CAN_BCM 协议。

在 3.4 版更改: 返回的套接字现在是不可继承的。

在 3.7 版更改: 添加了 CAN_ISOTP 协议。

在 3.7 版更改: 当将 SOCK_NONBLOCK 或 SOCK_CLOEXEC 旗标位应用于 type 时它们将被清除，且 socket.type 将不会反映它们。 它们仍然会被传递给底层的系统 socket() 调用。 因而，

sock = socket.socket(
    socket.AF_INET,
    socket.SOCK_STREAM | socket.SOCK_NONBLOCK)

仍将在支持 SOCK_NONBLOCK 的系统上创建一个非阻塞的套接字，但是 sock.type 会被置为 socket.SOCK_STREAM。

在 3.9 版更改: 添加了 CAN_J1939 协议。

在 3.10 版更改: 添加了 IPPROTO_MPTCP 协议。

socket.socketpair([family[, type[, proto]]])

构建一对已连接的套接字对象，使用给定的地址簇、套接字类型和协议号。地址簇、套接字类型和协议号与上述 socket() 函数相同。默认地址簇为 AF_UNIX （需要当前平台支持，不支持则默认为 AF_INET ）。

新创建的套接字都是 不可继承的。

在 3.2 版更改: 现在，返回的套接字对象支持全部套接字 API，而不是全部 API 的一个子集。

在 3.4 版更改: 返回的套接字现在都是不可继承的。

在 3.5 版更改: 添加了 Windows 支持。

socket.create_connection(address[, timeout[, source_address]])

连接到一个在互联网 address (以 (host, port) 2 元组表示) 上侦听的 TCP 服务，并返回套接字对象。 这是一个相比 socket.connect() 层级更高的函数：如果 host 是非数字的主机名，它将尝试将其解析为 AF_INET 和 AF_INET6，然后依次尝试连接到所有可能的地址直到连接成功。 这使编写兼容 IPv4 和 IPv6 的客户端变得很容易。

传入可选参数 timeout 可以在套接字实例上设置超时（在尝试连接前）。如果未提供 timeout，则使用由 getdefaulttimeout() 返回的全局默认超时设置。

如果提供了 source_address，它必须为二元组 (host, port)，以便套接字在连接之前绑定为其源地址。如果 host 或 port 分别为 '' 或 0，则使用操作系统默认行为。

在 3.2 版更改: 添加了*source_address* 参数

socket.create_server(address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False)

便捷函数，创建绑定到 address （二元组 (host, port) ）的 TCP 套接字，返回套接字对象。

family 应当为 AF_INET 或 AF_INET6。 backlog 是传递给 socket.listen() 的队列大小；当未指定时，将选择一个合理的默认值。 reuse_port 指定是否要设置 SO_REUSEPORT 套接字选项。

如果 dualstack_ipv6 为 true 且平台支持，则套接字能接受 IPv4 和 IPv6 连接，否则将抛出 ValueError 异常。大多数 POSIX 平台和 Windows 应该支持此功能。启用此功能后，socket.getpeername() 在进行 IPv4 连接时返回的地址将是一个（映射到 IPv4 的）IPv6 地址。在默认启用该功能的平台上（如 Linux），如果 dualstack_ipv6 为 false，即显式禁用此功能。该参数可以与 has_dualstack_ipv6() 结合使用：

import socket

addr = ("", 8080)  # all interfaces, port 8080
if socket.has_dualstack_ipv6():
    s = socket.create_server(addr, family=socket.AF_INET6, dualstack_ipv6=True)
else:
    s = socket.create_server(addr)

注解

在 POSIX 平台上，设置 SO_REUSEADDR 套接字选项是为了立即重用以前绑定在同一 address 上并保持 TIME_WAIT 状态的套接字。

3.8 新版功能.

socket.has_dualstack_ipv6()

如果平台支持创建 IPv4 和 IPv6 连接都可以处理的 TCP 套接字，则返回 True。

3.8 新版功能.

socket.fromfd(fd, family, type, proto=0)

复制文件描述符 fd （一个由文件对象的 fileno() 方法返回的整数），然后从结果中构建一个套接字对象。地址簇、套接字类型和协议号与上述 socket() 函数相同。文件描述符应指向一个套接字，但不会专门去检查——如果文件描述符是无效的，则对该对象的后续操作可能会失败。本函数很少用到，但是在将套接字作为标准输入或输出传递给程序（如 Unix inet 守护程序启动的服务器）时，可以使用本函数获取或设置套接字选项。套接字将处于阻塞模式。

新创建的套接字是 不可继承的。

在 3.4 版更改: 返回的套接字现在是不可继承的。

socket.fromshare(data)

根据 socket.share() 方法获得的数据实例化套接字。套接字将处于阻塞模式。

可用性: Windows。

3.3 新版功能.

socket.SocketType

这是一个 Python 类型对象，表示套接字对象的类型。它等同于 type(socket(...))。

其他功能

socket 模块还提供多种网络相关服务：

socket.close(fd)

关闭一个套接字文件描述符。它类似于 os.close()，但专用于套接字。在某些平台上（特别是在 Windows 上），os.close() 对套接字文件描述符无效。

3.7 新版功能.

socket.getaddrinfo(host, port, family=0, type=0, proto=0, flags=0)

将 host/port 参数转换为 5 元组的序列，其中包含创建（连接到某服务的）套接字所需的所有参数。host 是域名，是字符串格式的 IPv4/v6 地址或 None。port 是字符串格式的服务名称，如 'http' 、端口号（数字）或 None。传入 None 作为 host 和 port 的值，相当于将 NULL 传递给底层 C API。

可以指定 family、type 和 proto 参数，以缩小返回的地址列表。向这些参数分别传入 0 表示保留全部结果范围。flags 参数可以是 AI_* 常量中的一个或多个，它会影响结果的计算和返回。例如，AI_NUMERICHOST 会禁用域名解析，此时如果 host 是域名，则会抛出错误。

本函数返回一个列表，其中的 5 元组具有以下结构：

(family, type, proto, canonname, sockaddr)

在这些元组中，family, type, proto 都是整数且其作用是被传入 socket() 函数。 如果 AI_CANONNAME 是 flags 参数的一部分则 canonname 将是表示 host 规范名称的字符串；否则 canonname 将为空。 sockaddr 是一个描述套接字地址的元组，其具体格式取决于返回的 family (对于 AF_INET 为 (address, port) 2 元组，对于 AF_INET6 则为 (address, port, flowinfo, scope_id) 4 元组)，其作用是被传入 socket.connect() 方法。

引发一个 审计事件 socket.getaddrinfo 并附带参数 host, port, family, type, protocol。

下面的示例获取了 TCP 连接地址信息，假设该连接通过 80 端口连接至 example.org （如果系统未启用 IPv6，则结果可能会不同）:

>>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP)
[(<AddressFamily.AF_INET6: 10>, <AddressFamily.SOCK_STREAM: 1>,
 6, '', ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)),
 (<AddressFamily.AF_INET: 2>, <AddressFamily.SOCK_STREAM: 1>,
 6, '', ('93.184.216.34', 80))]

在 3.2 版更改: 现在可以使用关键字参数的形式来传递参数。

在 3.7 版更改: 对于 IPv6 多播地址，表示地址的字符串将不包含 %scope_id 部分。

socket.getfqdn([name])

返回 name 的完整限定域名。 如果 name 被省略或为空，则将其解读为本地主机。 要查找完整限定名称，将先检查 gethostbyaddr() 所返回的主机名，然后是主机的别名（如果存在）。 包括句点的第一个名称将会被选择。 对于没有完整限定域名而提供了 name 的情况，则会将其原样返回。 如果 name 为空或等于 '0.0.0.0'，则返回来自 gethostname() 的主机名。

socket.gethostbyname(hostname)

将主机名转换为 IPv4 地址格式。IPv4 地址以字符串格式返回，如 '100.50.200.5'。如果主机名本身是 IPv4 地址，则原样返回。更完整的接口请参考 gethostbyname_ex()。 gethostbyname() 不支持 IPv6 名称解析，应使用 getaddrinfo() 来支持 IPv4/v6 双协议栈。

引发一个 审计事件 socket.gethostbyname 并附带参数 hostname。

socket.gethostbyname_ex(hostname)

将一个主机名转换为 IPv4 地址格式的扩展接口。 返回一个三元组 (hostname, aliaslist, ipaddrlist) 其中 hostname 是主机的首选主机名，aliaslist 是同一地址的其他主机名的列表（可能为空），而 ipaddrlist 是同一主机上同一接口的 IPv4 地址列表（通常为单个地址但并不总是如此）。 gethostbyname_ex() 不支持 IPv6 名称解析，应当改用 getaddrinfo() 来提供 IPv4/v6 双栈支持。

引发一个 审计事件 socket.gethostbyname 并附带参数 hostname。

socket.gethostname()

返回一个字符串，包含当前正在运行 Python 解释器的机器的主机名。

引发一个不带参数的 审计事件 socket.gethostname。

注意： gethostname() 并不总是返回全限定域名，必要的话请使用 getfqdn()。

socket.gethostbyaddr(ip_address)

返回三元组 (hostname, aliaslist, ipaddrlist)，其中 hostname 是响应给定 ip_address 的主要主机名，aliaslist 是相同地址的其他可用主机名的列表（可能为空），而 ipaddrlist 是 IPv4/v6 地址列表，包含相同主机名、相同接口的不同地址（很可能仅包含一个地址）。要查询全限定域名，请使用函数 getfqdn()。gethostbyaddr() 支持 IPv4 和 IPv6。

引发一个 审计事件 socket.gethostbyaddr 并附带参数 ip_address。

socket.getnameinfo(sockaddr, flags)

将套接字地址 sockaddr 转换为一个 2 元组 (host, port)。 根据 flags 的设置，结果可能包含 host 中的完整限定域名或数字形式的地址。 类似地，port 可以包含字符串形式的端口名或数字形式的端口号。

对于 IPv6 地址，如果 sockaddr 包含有意义的 scope_id，则 %scope_id 会被附加到主机部分。 这种情况通常发生在多播地址上。

关于 flags 的更多信息可参阅 getnameinfo(3)。

引发一个 审计事件 socket.getnameinfo 并附带参数 sockaddr。

socket.getprotobyname(protocolname)

将一个互联网协议名称 (如 'icmp') 转换为能被作为 (可选的) 第三个参数传给 socket() 函数的常量。 这通常仅对以 "raw" 模式 (SOCK_RAW) 打开的套接字来说是必要的；对于正常的套接字模式，当该协议名称被省略或为零时会自动选择正确的协议。

socket.getservbyname(servicename[, protocolname])

将一个互联网服务名称和协议名称转换为该服务的端口号。 如果给出了可选的协议名称，它应为 'tcp' 或 'udp'，否则将匹配任意的协议。

引发一个 审计事件 socket.getservbyname 并附带参数 servicename, protocolname。

socket.getservbyport(port[, protocolname])

将一个互联网端口号和协议名称转换为该服务的服务名称。 如果给出了可选的协议名称，它应为 'tcp' 或 'udp'，否则将匹配任意的协议。

引发一个 审计事件 socket.getservbyport 并附带参数 port, protocolname。

socket.ntohl(x)

将 32 位正整数从网络字节序转换为主机字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 4 字节交换操作。

socket.ntohs(x)

将 16 位正整数从网络字节序转换为主机字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 2 字节交换操作。

在 3.10 版更改: 如果 x 不能转为 16 位无符号整数则会引发 OverflowError。

socket.htonl(x)

将 32 位正整数从主机字节序转换为网络字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 4 字节交换操作。

socket.htons(x)

将 16 位正整数从主机字节序转换为网络字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 2 字节交换操作。

在 3.10 版更改: 如果 x 不能转为 16 位无符号整数则会引发 OverflowError。

socket.inet_aton(ip_string)

将一个 IPv4 地址从以点号分为四段的字符串格式（例如 '123.45.67.89'）转换为 32 位的紧凑二进制格式，长度为四个字符的字节串对象。 这在与使用标准 C 库并且需要 in_addr 类型对象的程序通信时很有用处，该类型就是此函数所返回的 32 位的紧凑二进制格式 C 类型。

inet_aton() 也接受句点数少于三的字符串，详情请参阅 Unix 手册 inet(3)。

如果传入本函数的 IPv4 地址字符串无效，则抛出 OSError。注意，具体什么样的地址有效取决于 inet_aton() 的底层 C 实现。

inet_aton() 不支持 IPv6，在 IPv4/v6 双协议栈下应使用 inet_pton() 来代替。

socket.inet_ntoa(packed_ip)

将一个 32 位紧凑 IPv4 地址 (长度为四个字节的 bytes-like object) 转换为标准的以点号四分段字符串表示形式 (例如 '123.45.67.89')。 这在与使用标准 C 库并且需要 in_addr 类型对象的程序通信时很有用处，该类型就是此函数接受作为参数的 32 位的紧凑二进制格式 C 类型。

如果传入本函数的字节序列长度不是 4 个字节，则抛出 OSError。inet_ntoa() 不支持 IPv6，在 IPv4/v6 双协议栈下应使用 inet_ntop() 来代替。

在 3.5 版更改: 现在接受可写的 字节类对象。

socket.inet_pton(address_family, ip_string)

将基于特定地址族字符串格式的 IP 地址转换为紧凑的二进制格式。 inet_pton() 在一个库或网络协议需要 in_addr (类似于 inet_aton()) 或 in6_addr 类型的对象时很有用处。

目前 address_family 支持 AF_INET 和 AF_INET6。如果 IP 地址字符串 ip_string 无效，则抛出 OSError。注意，具体什么地址有效取决于 address_family 的值和 inet_pton() 的底层实现。

可用性： Unix（可能非所有平台都可用）、Windows。

在 3.4 版更改: 添加了 Windows 支持

socket.inet_ntop(address_family, packed_ip)

将一个紧凑的 IP 地址 (长度为多个字节的 bytes-like object) 转换为标准的基于特定地址族的字符串表示形式 (例如 '7.10.0.5' 或 '5aef:2b::8')。 inet_ntop() 在一个库或网络协议返回 in_addr (类似于 inet_ntoa()) 或 in6_addr 类型的对象时很有用处。

目前 address_family 支持 AF_INET 和 AF_INET6。如果字节对象 packed_ip 与指定的地址簇长度不符，则抛出 ValueError。针对 inet_ntop() 调用的错误则抛出 OSError。

可用性： Unix（可能非所有平台都可用）、Windows。

在 3.4 版更改: 添加了 Windows 支持

在 3.5 版更改: 现在接受可写的 字节类对象。

socket.CMSG_LEN(length)

返回给定 length 所关联数据的辅助数据项的总长度（不带尾部填充）。此值通常用作 recvmsg() 接收一个辅助数据项的缓冲区大小，但是 RFC 3542 [https://datatracker.ietf.org/doc/html/rfc3542.html] 要求可移植应用程序使用 CMSG_SPACE()，以此将尾部填充的空间计入，即使该项在缓冲区的最后。如果 length 超出允许范围，则抛出 OverflowError。

可用性： 大多数 Unix 平台，其他平台也可能可用。

3.3 新版功能.

socket.CMSG_SPACE(length)

返回 recvmsg() 所需的缓冲区大小，以接收给定 length 所关联数据的辅助数据项，带有尾部填充。接收多个项目所需的缓冲区空间是关联数据长度的 CMSG_SPACE() 值的总和。如果 length 超出允许范围，则抛出 OverflowError。

请注意，某些系统可能支持辅助数据，但不提供本函数。还需注意，如果使用本函数的结果来设置缓冲区大小，可能无法精确限制可接收的辅助数据量，因为可能会有其他数据写入尾部填充区域。

可用性： 大多数 Unix 平台，其他平台也可能可用。

3.3 新版功能.

socket.getdefaulttimeout()

返回用于新套接字对象的默认超时（以秒为单位的浮点数）。值 None 表示新套接字对象没有超时。首次导入 socket 模块时，默认值为 None。

socket.setdefaulttimeout(timeout)

设置用于新套接字对象的默认超时（以秒为单位的浮点数）。首次导入 socket 模块时，默认值为 None。可能的取值及其各自的含义请参阅 settimeout()。

socket.sethostname(name)

将计算机的主机名设置为 name。如果权限不足将抛出 OSError。

引发一个 审计事件 socket.sethostname 并附带参数 name。

可用性: Unix。

3.3 新版功能.

socket.if_nameindex()

返回一个列表，包含网络接口（网卡）信息二元组（整数索引，名称字符串）。系统调用失败则抛出 OSError。

可用性: Unix, Windows。

3.3 新版功能.

在 3.8 版更改: 添加了 Windows 支持。

注解

在 Windows 中网络接口在不同上下文中具有不同的名称（所有名称见对应示例）:

UUID: {FB605B73-AAC2-49A6-9A2F-25416AEA0573}

名称: ethernet_32770

友好名称: vEthernet (nat)

描述: Hyper-V Virtual Ethernet Adapter

此函数返回列表中第二种形式的名称，在此示例中为 ethernet_32770。

socket.if_nametoindex(if_name)

返回网络接口名称相对应的索引号。如果没有所给名称的接口，则抛出 OSError。

可用性: Unix, Windows。

3.3 新版功能.

在 3.8 版更改: 添加了 Windows 支持。

参见

"Interface name" 为 if_nameindex() 中所描述的名称。

socket.if_indextoname(if_index)

返回网络接口索引号相对应的接口名称。如果没有所给索引号的接口，则抛出 OSError。

可用性: Unix, Windows。

3.3 新版功能.

在 3.8 版更改: 添加了 Windows 支持。

参见

"Interface name" 为 if_nameindex() 中所描述的名称。

socket.send_fds(sock, buffers, fds[, flags[, address]])

将文件描述符列表 fds 通过一个 AF_UNIX 套接字 sock 进行发送。 fds 形参是由文件描述符构成的序列。 请查看 sendmsg() 获取这些形参的文档。

可用性: 支持 sendmsg() 和 SCM_RIGHTS 机制的 Unix 系统。

3.9 新版功能.

socket.recv_fds(sock, bufsize, maxfds[, flags])

接收至多 maxfds 个来自 AF_UNIX 套接字 sock 的文件描述符。 返回 (msg, list(fds), flags, addr)。 请查看 recvmsg() 获取有些形参的文档。

可用性: 支持 recvmsg() 和 SCM_RIGHTS 机制的 Unix 系统。

3.9 新版功能.

注解

位于文件描述符列表末尾的任何被截断整数。

套接字对象

套接字对象具有以下方法。除了 makefile()，其他都与套接字专用的 Unix 系统调用相对应。

在 3.2 版更改: 添加了对 上下文管理器 协议的支持。退出上下文管理器与调用 close() 等效。

socket.accept()

接受一个连接。此 socket 必须绑定到一个地址上并且监听连接。返回值是一个 (conn, address) 对，其中 conn 是一个 新 的套接字对象，用于在此连接上收发数据，address 是连接另一端的套接字所绑定的地址。

新创建的套接字是 不可继承的。

在 3.4 版更改: 该套接字现在是不可继承的。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.bind(address)

将套接字绑定到 address。套接字必须尚未绑定。（ address 的格式取决于地址簇 —— 参见上文）

引发一个 审计事件 socket.bind 并附带参数 self、address。

socket.close()

将套接字标记为关闭。当 makefile() 创建的所有文件对象都关闭时，底层系统资源（如文件描述符）也将关闭。一旦上述情况发生，将来对套接字对象的所有操作都会失败。对端将接收不到任何数据（清空队列数据后）。

垃圾回收时，套接字会自动关闭，但建议显式 close() 它们，或在它们周围使用 with 语句。

在 3.6 版更改: 现在，如果底层的 close() 调用出错，会抛出 OSError。

注解

close() 释放与连接相关联的资源，但不一定立即关闭连接。如果需要及时关闭连接，请在调用 close() 之前调用 shutdown()。

socket.connect(address)

连接到 address 处的远程套接字。（ address 的格式取决于地址簇 —— 参见上文）

如果连接被信号中断，则本方法将等待直至连接完成，或者如果信号处理器未引发异常并且套接字被阻塞或已超时则会在超时后引发 TimeoutError。 对于非阻塞型套接字，如果连接被信号中断则本方法将引发 InterruptedError 异常（或信号处理器所引发的异常）。

引发一个 审计事件 socket.connect 并附带参数 self、address。

在 3.5 版更改: 本方法现在将等待，直到连接完成，而不是在以下情况抛出 InterruptedError 异常。该情况为，连接被信号中断，信号处理程序未抛出异常，且套接字阻塞中或已超时（具体解释请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475] ）。

socket.connect_ex(address)

类似于 connect(address)，但是对于 C 级别的 connect() 调用返回的错误，本函数将返回错误指示器，而不是抛出异常（对于其他问题，如“找不到主机”，仍然可以抛出异常）。如果操作成功，则错误指示器为 0，否则为 errno 变量的值。这对支持如异步连接很有用。

引发一个 审计事件 socket.connect 并附带参数 self、address。

socket.detach()

将套接字对象置于关闭状态，而底层的文件描述符实际并不关闭。返回该文件描述符，使其可以重新用于其他目的。

3.2 新版功能.

socket.dup()

创建套接字的副本。

新创建的套接字是 不可继承的。

在 3.4 版更改: 该套接字现在是不可继承的。

socket.fileno()

返回套接字的文件描述符（一个小整数），失败返回 -1。配合 select.select() 使用很有用。

在 Windows 下，此方法返回的小整数在允许使用文件描述符的地方无法使用（如 os.fdopen() ）。Unix 无此限制。

socket.get_inheritable()

获取套接字文件描述符或套接字句柄的 可继承标志 ：如果子进程可以继承套接字则为 True，否则为 False。

3.4 新版功能.

socket.getpeername()

返回套接字连接到的远程地址。举例而言，这可以用于查找远程 IPv4/v6 套接字的端口号。（返回的地址格式取决于地址簇 —— 参见上文。）部分系统不支持此函数。

socket.getsockname()

返回套接字本身的地址。举例而言，这可以用于查找 IPv4/v6 套接字的端口号。（返回的地址格式取决于地址簇 —— 参见上文。）

socket.getsockopt(level, optname[, buflen])

返回指定套接字选项的值（参阅 Unix 手册页 getsockopt(2) ）。所需的符号常量（ SO_* 等）已定义在本模块中。如果未指定 buflen，则认为该选项值为整数，由本函数返回该整数值。如果指定 buflen，则它定义了用于存放选项值的缓冲区的最大长度，且该缓冲区将作为字节对象返回。对缓冲区的解码工作由调用者自行完成（针对编码为字节串的 C 结构，其解码方法请参阅可选的内置模块 struct ）。

socket.getblocking()

如果套接字处于阻塞模式，返回 True，非阻塞模式返回 False。

这相当于检测 socket.gettimeout() == 0。

3.7 新版功能.

socket.gettimeout()

返回套接字操作相关的超时秒数（浮点数），未设置超时则返回 None。它反映最后一次调用 setblocking() 或 settimeout() 后的设置。

socket.ioctl(control, option)

平台

Windows

ioctl() 方法是 WSAIoctl 系统接口的有限接口。请参考 Win32 文档 [https://msdn.microsoft.com/en-us/library/ms741621%28VS.85%29.aspx] 以获取更多信息。

在其他平台上，可以使用通用的 fcntl.fcntl() 和 fcntl.ioctl() 函数，它们接受套接字对象作为第一个参数。

当前仅支持以下控制码： SIO_RCVALL、SIO_KEEPALIVE_VALS 和 SIO_LOOPBACK_FAST_PATH。

在 3.6 版更改: 添加了 SIO_LOOPBACK_FAST_PATH。

socket.listen([backlog])

启动一个服务器用于接受连接。如果指定 backlog，则它最低为 0（小于 0 会被置为 0），它指定系统允许暂未 accept 的连接数，超过后将拒绝新连接。未指定则自动设为合理的默认值。

在 3.5 版更改: backlog 参数现在是可选的。

socket.makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)

返回与套接字关联的 文件对象。返回的对象的具体类型取决于 makefile() 的参数。这些参数的解释方式与内置的 open() 函数相同，其中 mode 的值仅支持 'r' （默认），'w' 和 'b'。

套接字必须处于阻塞模式，它可以有超时，但是如果发生超时，文件对象的内部缓冲区可能会以不一致的状态结尾。

关闭 makefile() 返回的文件对象不会关闭原始套接字，除非所有其他文件对象都已关闭且在套接字对象上调用了 socket.close()。

注解

在 Windows 上，由 makefile() 创建的文件型对象无法作为带文件描述符的文件对象使用，如无法作为 subprocess.Popen() 的流参数。

socket.recv(bufsize[, flags])

从套接字接收数据。返回值是一个字节对象，表示接收到的数据。bufsize 指定一次接收的最大数据量。可选参数 flags 的含义请参阅 Unix 手册页 recv(2)，它默认为零。

注解

为了最佳匹配硬件和网络的实际情况，bufsize 的值应为 2 的相对较小的幂，如 4096。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.recvfrom(bufsize[, flags])

从套接字接收数据。返回值是一对 (bytes, address)，其中 bytes 是字节对象，表示接收到的数据，address 是发送端套接字的地址。可选参数 flags 的含义请参阅 Unix 手册页 recv(2)，它默认为零。（ address 的格式取决于地址簇 —— 参见上文）

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

在 3.7 版更改: 对于多播 IPv6 地址，address 的第一项不会再包含 %scope_id 部分。 要获得完整的 IPv6 地址请使用 getnameinfo()。

socket.recvmsg(bufsize[, ancbufsize[, flags]])

从套接字接收普通数据（至多 bufsize 字节）和辅助数据。ancbufsize 参数设置用于接收辅助数据的内部缓冲区的大小（以字节为单位），默认为 0，表示不接收辅助数据。可以使用 CMSG_SPACE() 或 CMSG_LEN() 计算辅助数据缓冲区的合适大小，无法放入缓冲区的项目可能会被截断或丢弃。flags 参数默认为 0，其含义与 recv() 中的相同。

返回值是一个四元组： (data, ancdata, msg_flags, address)。data 项是一个 bytes 对象，用于保存接收到的非辅助数据。ancdata 项是零个或多个元组 (cmsg_level, cmsg_type, cmsg_data) 组成的列表，表示接收到的辅助数据（控制消息）：cmsg_level 和 cmsg_type 是分别表示协议级别和协议类型的整数，而 cmsg_data 是保存相关数据的 bytes 对象。msg_flags 项由各种标志按位或组成，表示接收消息的情况，详细信息请参阅系统文档。如果接收端套接字断开连接，则 address 是发送端套接字的地址（如果有），否则该值无指定。

在某些系统上，可以使用 sendmsg() 和 recvmsg() 通过 AF_UNIX 套接字在进程之间传递文件描述符。 当使用此功能时 (通常仅限于 SOCK_STREAM 套接字), recvmsg() 将在其附带数据中返回 (socket.SOL_SOCKET, socket.SCM_RIGHTS, fds) 形式的项，其中 fds 是一个代表新文件描述符的原生as a binary array of the native C int 类型的二进制数组形式的 bytes 对象。 如果 recvmsg() 在系统调用返回后引发了异常，它将首先尝试关闭通过此机制接收到的任何文件描述符。

对于仅接收到一部分的辅助数据项，一些系统没有指示其截断长度。如果某个项目可能超出了缓冲区的末尾，recvmsg() 将发出 RuntimeWarning，并返回其在缓冲区内的部分，前提是该对象被截断于关联数据开始后。

在支持 SCM_RIGHTS 机制的系统上，下方的函数将最多接收 maxfds 个文件描述符，返回消息数据和包含描述符的列表（同时忽略意外情况，如接收到无关的控制消息）。另请参阅 sendmsg()。

import socket, array

def recv_fds(sock, msglen, maxfds):
    fds = array.array("i")   # Array of ints
    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:
            # Append data, ignoring any truncated integers at the end.
            fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
    return msg, list(fds)

可用性： 大多数 Unix 平台，其他平台也可能可用。

3.3 新版功能.

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.recvmsg_into(buffers[, ancbufsize[, flags]])

从套接字接收普通数据和辅助数据，其行为与 recvmsg() 相同，但将非辅助数据分散到一系列缓冲区中，而不是返回新的字节对象。buffers 参数必须是可迭代对象，它迭代出可供写入的缓冲区（如 bytearray 对象），这些缓冲区将被连续的非辅助数据块填充，直到数据全部写完或缓冲区用完为止。在允许使用的缓冲区数量上，操作系统可能会有限制（ sysconf() 的 SC_IOV_MAX 值）。ancbufsize 和 flags 参数的含义与 recvmsg() 中的相同。

返回值为四元组： (nbytes, ancdata, msg_flags, address)，其中 nbytes 是写入缓冲区的非辅助数据的字节总数，而 ancdata、msg_flags 和 address 与 recvmsg() 中的相同。

示例:

>>> 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---')]

可用性： 大多数 Unix 平台，其他平台也可能可用。

3.3 新版功能.

socket.recvfrom_into(buffer[, nbytes[, flags]])

从套接字接收数据，将其写入 buffer 而不是创建新的字节串。返回值是一对 (nbytes, address)，其中 nbytes 是收到的字节数，address 是发送端套接字的地址。可选参数 flags 的含义请参阅 Unix 手册页 recv(2)，它默认为零。（ address 的格式取决于地址簇 —— 参见上文）

socket.recv_into(buffer[, nbytes[, flags]])

从套接字接收至多 nbytes 个字节，将其写入缓冲区而不是创建新的字节串。如果 nbytes 未指定（或指定为 0），则接收至所给缓冲区的最大可用大小。返回接收到的字节数。可选参数 flags 的含义请参阅 Unix 手册页 recv(2)，它默认为零。

socket.send(bytes[, flags])

发送数据给套接字。本套接字必须已连接到远程套接字。可选参数 flags 的含义与上述 recv() 中的相同。本方法返回已发送的字节数。应用程序要负责检查所有数据是否已发送，如果仅传输了部分数据，程序需要自行尝试传输其余数据。有关该主题的更多信息，请参考 套接字编程指南。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.sendall(bytes[, flags])

发送数据给套接字。本套接字必须已连接到远程套接字。可选参数 flags 的含义与上述 recv() 中的相同。与 send() 不同，本方法持续从 bytes 发送数据，直到所有数据都已发送或发生错误为止。成功后会返回 None。出错后会抛出一个异常，此时并没有办法确定成功发送了多少数据。

在 3.5 版更改: 每次成员发送数据后，套接字超时将不再重置。 目前的套接字超时是发送所有数据的最大总持续时间。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.sendto(bytes, address)

socket.sendto(bytes, flags, address)

发送数据给套接字。本套接字不应连接到远程套接字，而应由 address 指定目标套接字。可选参数 flags 的含义与上述 recv() 中的相同。本方法返回已发送的字节数。（ address 的格式取决于地址簇 —— 参见上文。）

引发一个 审计事件 socket.sendto 并附带参数 self, address。

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.sendmsg(buffers[, ancdata[, flags[, address]]])

将普通数据和辅助数据发送给套接字，将从一系列缓冲区中收集非辅助数据，并将其拼接为一条消息。buffers 参数指定的非辅助数据应为可迭代的 字节类对象 （如 bytes 对象），在允许使用的缓冲区数量上，操作系统可能会有限制（ sysconf() 的 SC_IOV_MAX 值）。ancdata 参数指定的辅助数据（控制消息）应为可迭代对象，迭代出零个或多个 (cmsg_level, cmsg_type, cmsg_data) 元组，其中 cmsg_level 和 cmsg_type 是分别指定协议级别和协议类型的整数，而 cmsg_data 是保存相关数据的字节类对象。请注意，某些系统（特别是没有 CMSG_SPACE() 的系统）可能每次调用仅支持发送一条控制消息。flags 参数默认为 0，与 send() 中的含义相同。如果 address 指定为除 None 以外的值，它将作为消息的目标地址。返回值是已发送的非辅助数据的字节数。

在支持 SCM_RIGHTS 机制的系统上，下方的函数通过一个 AF_UNIX 套接字来发送文件描述符列表 fds。另请参阅 recvmsg()。

import socket, array

def send_fds(sock, msg, fds):
    return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])

可用性： 大多数 Unix 平台，其他平台也可能可用。

引发一个 审计事件 socket.sendmsg 并附带参数 self, address。

3.3 新版功能.

在 3.5 版更改: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 InterruptedError 异常 (原因详见 PEP 475 [https://www.python.org/dev/peps/pep-0475])。

socket.sendmsg_afalg([msg, ]*, op[, iv[, assoclen[, flags]]])

为 AF_ALG 套接字定制的 sendmsg() 版本。可为 AF_ALG 套接字设置模式、IV、AEAD 关联数据的长度和标志位。

可用性： Linux >= 2.6.38。

3.6 新版功能.

socket.sendfile(file, offset=0, count=None)

使用高性能的 os.sendfile 发送文件，直到达到文件的 EOF 为止，返回已发送的字节总数。file 必须是一个以二进制模式打开的常规文件对象。如果 os.sendfile 不可用（如 Windows）或 file 不是常规文件，将使用 send() 代替。offset 指示从哪里开始读取文件。如果指定了 count，它确定了要发送的字节总数，而不会持续发送直到达到文件的 EOF。返回时或发生错误时，文件位置将更新，在这种情况下，file.tell() 可用于确定已发送的字节数。套接字必须为 SOCK_STREAM 类型。不支持非阻塞的套接字。

3.5 新版功能.

socket.set_inheritable(inheritable)

设置套接字文件描述符或套接字句柄的 可继承标志。

3.4 新版功能.

socket.setblocking(flag)

设置套接字为阻塞或非阻塞模式：如果 flag 为 false，则将套接字设置为非阻塞，否则设置为阻塞。

本方法是某些 settimeout() 调用的简写：

sock.setblocking(True) 相当于 sock.settimeout(None)

sock.setblocking(False) 相当于 sock.settimeout(0.0)

在 3.7 版更改: 本方法不再对 socket.type 属性设置 SOCK_NONBLOCK 标志。

socket.settimeout(value)

为阻塞套接字的操作设置超时。value 参数可以是非负浮点数，表示秒，也可以是 None。如果赋为一个非零值，那么如果在操作完成前超过了超时时间 value，后续的套接字操作将抛出 timeout 异常。如果赋为 0，则套接字将处于非阻塞模式。如果指定为 None，则套接字将处于阻塞模式。

更多信息请查阅 关于套接字超时的说明。

在 3.7 版更改: 本方法不再修改 socket.type 属性的 SOCK_NONBLOCK 标志。

socket.setsockopt(level, optname, value: int)

socket.setsockopt(level, optname, value: buffer)

socket.setsockopt(level, optname, None, optlen: int)

设置给定套接字选项的值（参阅 Unix 手册页 setsockopt(2) ）。所需的符号常量（ SO_* 等）已定义在本 socket 模块中。该值可以是整数、None 或表示缓冲区的 字节类对象。在后一种情况下，由调用者确保字节串中包含正确的数据位（关于将 C 结构体编码为字节串的方法，请参阅可选的内置模块 struct ）。当 value 设置为 None 时，必须设置 optlen 参数。这相当于调用 setsockopt() C 函数时使用了 optval=NULL 和 optlen=optlen 参数。

在 3.5 版更改: 现在接受可写的 字节类对象。

在 3.6 版更改: 添加了 setsockopt(level, optname, None, optlen: int) 调用形式。

socket.shutdown(how)

关闭一半或全部的连接。如果 how 为 SHUT_RD，则后续不再允许接收。如果 how 为 SHUT_WR，则后续不再允许发送。如果 how 为 SHUT_RDWR，则后续的发送和接收都不允许。

socket.share(process_id)

复制套接字，并准备将其与目标进程共享。目标进程必须以 process_id 形式提供。然后可以利用某种形式的进程间通信，将返回的字节对象传递给目标进程，还可以使用 fromshare() 在新进程中重新创建套接字。一旦本方法调用完毕，就可以安全地将套接字关闭，因为操作系统已经为目标进程复制了该套接字。

可用性: Windows。

3.3 新版功能.

注意此处没有 read() 或 write() 方法，请使用不带 flags 参数的 recv() 和 send() 来替代。

套接字对象还具有以下（只读）属性，这些属性与传入 socket 构造函数的值相对应。

socket.family

套接字的协议簇。

socket.type

套接字的类型。

socket.proto

套接字的协议。

关于套接字超时的说明

一个套接字对象可以处于以下三种模式之一：阻塞、非阻塞或超时。套接字默认以阻塞模式创建，但是可以调用 setdefaulttimeout() 来更改。

在 blocking mode （阻塞模式）中，操作将阻塞，直到操作完成或系统返回错误（如连接超时）。

在 非阻塞模式 中，如果操作无法立即完成则该操作将失败（不幸的是它所附带的错误将依赖于具体系统）: 来自 select 模块的函数可被用来获知一个套接字是否可以读取或写入。

在 timeout mode （超时模式）下，如果无法在指定的超时内完成操作（抛出 timeout 异常），或如果系统返回错误，则操作将失败。

注解

在操作系统层面上，超时模式 下的套接字在内部都设置为非阻塞模式。同时，阻塞和超时模式在文件描述符和套接字对象之间共享，这些描述符和对象均应指向同一个网络端点。如果，比如你决定使用套接字的 fileno()，这一实现细节可能导致明显的结果。

超时与 connect 方法

connect() 操作也受超时设置的约束，通常建议在调用 connect() 之前调用 settimeout()，或将超时参数直接传递给 create_connection()。但是，无论 Python 套接字超时设置如何，系统网络栈都有可能返回自带的连接超时错误。

超时与 accept 方法

如果 getdefaulttimeout() 的值不是 None，则 accept() 方法返回的套接字将继承该超时值。若是 None，返回的套接字行为取决于侦听套接字的设置：

如果侦听套接字处于 阻塞模式 或 超时模式，则 accept() 返回的套接字处于 阻塞模式；

如果侦听套接字处于 非阻塞模式，那么 accept() 返回的套接字是阻塞还是非阻塞取决于操作系统。如果要确保跨平台时的正确行为，建议手动覆盖此设置。

示例

以下是 4 个使用 TCP/IP 协议的最小示例程序：一台服务器，它将收到的所有数据原样返回（仅服务于一个客户端），还有一个使用该服务器的客户端。注意，服务器必须按序执行 socket(), bind(), listen(), accept() （可能需要重复执行 accept() 以服务多个客户端），而客户端仅需要按序执行 socket(), connect()。还须注意，服务器不在侦听套接字上发送 sendall()/recv()，而是在 accept() 返回的新套接字上发送。

前两个示例仅支持 IPv4。

# Echo server program
import socket

HOST = ''                 # Symbolic name meaning all available interfaces
PORT = 50007              # Arbitrary non-privileged port
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)

# Echo client program
import socket

HOST = 'daring.cwi.nl'    # The remote host
PORT = 50007              # The same port as used by the server
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))

下两个例子与上两个很像，但是同时支持 IPv4 和 IPv6。 服务端将监听第一个可用的地址族（它本应同时监听两个）。 在大多数支持 IPv6 的系统上，IPv6 将有优先权并且服务端可能不会接受 IPv4 流量。 客户端将尝试连接到作为名称解析结果被返回的所有地址，并将流量发送给连接成功的第一个地址。

# Echo server program
import socket
import sys

HOST = None               # Symbolic name meaning all available interfaces
PORT = 50007              # Arbitrary non-privileged port
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)

# Echo client program
import socket
import sys

HOST = 'daring.cwi.nl'    # The remote host
PORT = 50007              # The same port as used by the server
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))

下面的例子演示了如何在 Windows 上使用原始套接字编写一个非常简单的网络嗅探器。 这个例子需要管理员权限来修改接口:

import socket

# the public network interface
HOST = socket.gethostbyname(socket.gethostname())

# create a raw socket and bind it to the public interface
s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
s.bind((HOST, 0))

# Include IP headers
s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)

# receive all packets
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)

# receive a packet
print(s.recvfrom(65565))

# disabled promiscuous mode
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)

下面的例子演示了如何使用 socket 接口与采用原始套接字协议的 CAN 网络进行通信。 要改为通过广播管理器协议来使用 CAN，则要用以下方式打开一个 socket:

socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)

在绑定 (CAN_RAW) 或连接 (CAN_BCM) 套接字之后，你将可以在套接字对象上正常地使用 socket.send() 和 socket.recv() 操作（及其同类操作）。

最后一个例子可能需要特别的权限:

import socket
import struct

# CAN frame packing/unpacking (see 'struct can_frame' in <linux/can.h>)

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])

# create a raw socket and bind it to the 'vcan0' interface
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')

多次运行一个示例，且每次执行之间等待时间过短，可能导致这个错误:

OSError: [Errno 98] Address already in use

这是因为前一次运行使套接字处于 TIME_WAIT 状态，无法立即重用。

要防止这种情况，需要设置一个 socket 标志 socket.SO_REUSEADDR:

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((HOST, PORT))

SO_REUSEADDR 标志告诉内核将处于 TIME_WAIT 状态的本地套接字重新使用，而不必等到固有的超时到期。

参见

关于套接字编程（C 语言）的介绍，请参阅以下文章：

An Introductory 4.3BSD Interprocess Communication Tutorial，作者 Stuart Sechrest

An Advanced 4.3BSD Interprocess Communication Tutorial，作者 Samuel J. Leffler et al,

两篇文章都在 UNIX 开发者手册，补充文档 1（第 PS1:7 和 PS1:8 节）中。那些特定于平台的参考资料，它们包含与套接字有关的各种系统调用，也是套接字语义细节的宝贵信息来源。对于 Unix，请参考手册页。对于 Windows，请参阅 WinSock（或 Winsock 2）规范。如果需要支持 IPv6 的 API，读者可能希望参考 RFC 3493 [https://datatracker.ietf.org/doc/html/rfc3493.html]，标题为 Basic Socket Interface Extensions for IPv6。

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

源代码: Lib/ssl.py [https://github.com/python/cpython/tree/3.10/Lib/ssl.py]

该模块提供了对传输层安全（通常称为 "安全套接字层"）加密和网络套接字的对等认证设施的访问，包括客户端和服务器端。 该模块使用 OpenSSL 库。它可以在所有现代 Unix 系统、 Windows 、 macOS 和可能的其他平台上使用，只要 OpenSSL 安装在该平台上。

注解

某些行为可能与平台相关，因为调用了操作系统的套接字 API。已安装的OpenSSL 版本也可能会导致不同的行为。比如 TLSv 1.3 与 Open SSL 1.1.1 就不一样。

警告

在阅读 安全考量 前不要使用此模块。 这样做可能会导致虚假的安全感，因为ssl模块的默认设置不一定适合你的应用程序。

文档本文档记录 ssl 模块的对象和函数；更多关于TLS,SSL,和证书的信息，请参阅下方的“详情”选项

本模块提供了一个类 ssl.SSLSocket，它派生自 socket.socket 类型，并提供类似套接字的包装器，也能够对通过带 SSL 套接字的数据进行加密和解密。 它支持一些额外方法例如 getpeercert()，该方法可从连接的另一端获取证书，还有 cipher()，该方法可获取安全连接所使用的密码。

对于更复杂的应用程序，ssl.SSLContext 类有助于管理设置项和证书，进而可以被使用 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 版更改: PEP 644 [https://www.python.org/dev/peps/pep-0644] 已经实现。ssl 模块需要 OpenSSL 1.1.1 以上版本的支持。

使用废弃的常量和函数会导致废弃警告。

方法、常量和异常处理

套接字创建

从 Python 3.2 和 2.7.9 开始，建议使用 SSLContext 实例的 SSLContext.wrap_socket() 来将套接字包装为 SSLSocket 对象。 辅助函数 create_default_context() 会返回一个新的带有安全默认设置的上下文。 旧的 wrap_socket() 函数已被弃用，因为它效率较差并且不支持服务器名称提示（SNI）和主机匹配。

客户端套接字实例，采用默认上下文和IPv4/IPv6双栈:

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())

客户端套接字示例，带有自定义上下文和IPv4:

hostname = 'www.python.org'
# PROTOCOL_TLS_CLIENT requires valid cert chain and hostname
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())

服务器套接字实例，在localhost上监听IPv4:

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()
        ...

上下文创建

便捷函数，可以帮助创建 SSLContext 对象，用于常见的目的。

ssl.create_default_context(purpose=Purpose.SERVER_AUTH, cafile=None, capath=None, cadata=None)

返回一个新的 SSLContext 对象，使用给定 purpose 的默认设置。 该设置由 ssl 模块选择，并且通常是代表一个比直接调用 SSLContext 构造器时更高的安全等级。

cafile, capath, cadata 代表用于进行证书核验的可选受信任 CA 证书，与 SSLContext.load_verify_locations() 的一致。 如果三个参数均为 None，此函数可以转而选择信任系统的默认 CA 证书。

设置为： PROTOCOL_TLS_CLIENT 或 PROTOCOL_TLS_SERVER、 OP_NO_SSLv2 和 OP_NO_SSLv3，带有不含 RC4 及未认证的高强度加密密码套件。 传入 SERVER_AUTH 作为 purpose，会将 verify_mode 设为 CERT_REQUIRED，并加载 CA 证书（若给出 cafile、capath 或 cadata 之一）或用 SSLContext.load_default_certs() 加载默认CA证书。

当 keylog_filename 受支持并且设置了环境变量 SSLKEYLOGFILE 时，create_default_context() 会启用密钥日志记录。

注解

协议、选项、密码和其他设置可随时更改为更具约束性的值而无须事先弃用。 这些值代表了兼容性和安全性之间的合理平衡。

如果你的应用需要特定的设置，你应当创建一个 SSLContext 并自行应用设置。

注解

如果你发现当某些较旧的客户端或服务器尝试与用此函数创建的 SSLContext 进行连接时收到了报错提示 "Protocol or cipher suite mismatch"，这可能是因为它们只支持 SSL3.0 而它被此函数用 OP_NO_SSLv3 排除掉了。 SSL3.0 被广泛认为 完全不可用 [https://en.wikipedia.org/wiki/POODLE]。 如果你仍希望继续使用此函数但仍允许 SSL 3.0 连接，你可以使用以下代码重新启用它们:

ctx = ssl.create_default_context(Purpose.CLIENT_AUTH)
ctx.options &= ~ssl.OP_NO_SSLv3

3.4 新版功能.

在 3.4.4 版更改: RC4 被从默认密码字符串中丢弃。

在 3.6 版更改: ChaCha20/Poly1305 被添加到默认密码字符串中。

3DES 被从默认密码字符串中丢弃。

在 3.8 版更改: 增加了对密钥日志记录至 SSLKEYLOGFILE 的支持。

在 3.10 版更改: 当前上下文使用 PROTOCOL_TLS_CLIENT 或 PROTOCOL_TLS_SERVER 协议而非通用的 PROTOCOL_TLS。

异常

exception ssl.SSLError

引发此异常以提示来自下层 SSL 实现（目前由 OpenSSL 库提供）的错误。 它表示在下层网络连接之上叠加的高层级加密和验证层存在某种问题。 此错误是 OSError 的一个子类型。 SSLError 实例的错误和消息是由 OpenSSL 库提供的。

在 3.3 版更改: SSLError 曾经是 socket.error 的一个子类型。

library

一个字符串形式的助记符，用来指明发生错误的 OpenSSL 子模块，例如 SSL, PEM 或 X509。 可能的取值范围依赖于 OpenSSL 的版本。

3.3 新版功能.

reason

一个字符串形式的助记符，用来指明发生错误的原因，例如 CERTIFICATE_VERIFY_FAILED。 可能的取值范围依赖于 OpenSSL 的版本。

3.3 新版功能.

exception ssl.SSLZeroReturnError

SSLError 的子类，当尝试读取或写入且 SSL 连接已被完全关闭时会被引发。 请注意这并不意味着下层的传输（读取 TCP）已被关闭。

3.3 新版功能.

exception ssl.SSLWantReadError

SSLError 的子类，当尝试读取或写入数据，但在请求被满足之前还需要在下层的 TCP 传输上接收更多数据时会被 非阻塞型 SSL 套接字 引发。

3.3 新版功能.

exception ssl.SSLWantWriteError

SSLError 的子类，当尝试读取或写入数据，但在请求被满足之前还需要在下层的 TCP 传输上发送更多数据时会被 非阻塞型 SSL 套接字 引发。

3.3 新版功能.

exception ssl.SSLSyscallError

SSLError 的子类，当尝试在 SSL 套接字上执行操作时遇到系统错误时会被引发。 不幸的是，没有简单的方式能检查原始 errno 编号。

3.3 新版功能.

exception ssl.SSLEOFError

SSLError 的子类，当 SSL 连接被突然终止时会被引发。 通常，当遇到此错误时你不应再尝试重用下层的传输。

3.3 新版功能.

exception ssl.SSLCertVerificationError

SSLError 的子类，当证书验证失败时会被引发。

3.7 新版功能.

verify_code

一个数字形式的错误编号，用于表示验证错误。

verify_message

用于表示验证错误的人类可读的字符串。

exception ssl.CertificateError

SSLCertVerificationError 的别名。

在 3.7 版更改: 此异常现在是 SSLCertVerificationError 的别名。

随机生成

ssl.RAND_bytes(num)

返回 num 个高加密强度伪随机字节数据。 如果 PRNG 未使用足够的数据作为随机种子或者如果当前 RAND 方法不支持该操作则会引发 SSLError。 RAND_status() 可被用来检查 PRNG 的状态而 RAND_add() 可被用来为 PRNG 设置随机种子。

对于几乎所有应用程序都更推荐使用 os.urandom()。

请阅读维基百科文章 Cryptographically secure pseudorandom number generator (CSPRNG) [https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator] 以了解对于高加密强度生成器的具体要求。

3.3 新版功能.

ssl.RAND_pseudo_bytes(num)

返回 (bytes, is_cryptographic): bytes 是 num 个伪随机字节数据，如果所生成的字节数据为高加密强度则 is_cryptographic 为 True。 如果当前 RAND 方法不支持此操作则会引发 SSLError。

所生成的伪随机字节序列如果具有足够的长度则将会具有唯一性，并是并非不可预测。 它们可被用于非加密目的以及加密协议中的特定目的，但通常不可被用于密钥生成等目的。

对于几乎所有应用程序都更推荐使用 os.urandom()。

3.3 新版功能.

3.6 版后已移除: OpenSSL 已弃用了 ssl.RAND_pseudo_bytes()，请改用 ssl.RAND_bytes()。

ssl.RAND_status()

如果 SSL 伪随机数生成器已使用‘足够的’随机性作为种子则返回 True，否则返回 False。 你可以使用 ssl.RAND_egd() 和 ssl.RAND_add() 来增加伪随机数生成器的随机性。

ssl.RAND_add(bytes, entropy)

将给定的 bytes 混合到 SSL 伪随机数生成器中。 形参 entropy (float 类型) 是数据所包含的熵的下界 (因此你可以总是使用 0.0)。 请查看 RFC 1750 [https://datatracker.ietf.org/doc/html/rfc1750.html] 了解有关熵源的更多信息。

在 3.5 版更改: 现在接受可写的 字节类对象。

证书处理

ssl.match_hostname(cert, hostname)

验证 cert (使用 SSLSocket.getpeercert() 所返回的已解码格式) 是否匹配给定的 hostname。 所应用的规则是在 RFC 2818 [https://datatracker.ietf.org/doc/html/rfc2818.html], RFC 5280 [https://datatracker.ietf.org/doc/html/rfc5280.html] 和 RFC 6125 [https://datatracker.ietf.org/doc/html/rfc6125.html] 中描述的检查 HTTPS 服务器身份的规则。 除了 HTTPS，此函数还应当适用于各种基于 SSL 协议的服务器身份检查操作，例如 FTPS, IMAPS, POPS 等等。

失败时引发 CertificateError。 成功时此函数无返回值:

>>> cert = {'subject': ((('commonName', 'example.com'),),)}
>>> ssl.match_hostname(cert, "example.com")
>>> ssl.match_hostname(cert, "example.org")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/py3k/Lib/ssl.py", line 130, in match_hostname
ssl.CertificateError: hostname 'example.org' doesn't match 'example.com'

3.2 新版功能.

在 3.3.3 版更改: 此函数现在遵循 RFC 6125 [https://datatracker.ietf.org/doc/html/rfc6125.html], 6.4.3 小节，它不会匹配多个通配符 (例如 *.*.com 或 *a*.example.org) 也不匹配国际化域名 (IDN) 片段内部的通配符。 IDN A 标签例如 www*.xn--pthon-kva.org 仍然受支持，但 x*.python.org 不再能匹配 xn--tda.python.org。

在 3.5 版更改: 现在支持匹配存在于证书的 subjectAltName 字段中的 IP 地址。

在 3.7 版更改: 此函数不再被用于 TLS 连接。 主机匹配现在是由 OpenSSL 执行的。

允许位于段的最左端且为唯一字符的通配符。 部分通配符例如 www*.example.com 已不再受支持。

3.7 版后已移除.

ssl.cert_time_to_seconds(cert_time)

返回距离 Unix 纪元零时的秒数，给定的 cert_time 字符串代表来自证书的 "notBefore" 或 "notAfter" 日期值，采用 "%b %d %H:%M:%S %Y %Z" strptime 格式（C 区域）。

以下为示例代码:

>>> import ssl
>>> timestamp = ssl.cert_time_to_seconds("Jan  5 09:34:43 2018 GMT")
>>> timestamp
1515144883
>>> from datetime import datetime
>>> print(datetime.utcfromtimestamp(timestamp))
2018-01-05 09:34:43

"notBefore" 或 "notAfter" 日期值必须使用 GMT (RFC 5280 [https://datatracker.ietf.org/doc/html/rfc5280.html])。

在 3.5 版更改: 将输入时间解读为 UTC 时间，基于输入字符串中指明的 'GMT' 时区。 在之前使用的是本地时区。 返回一个整数（不带输入格式中秒的分数部分）

ssl.get_server_certificate(addr, ssl_version=PROTOCOL_TLS_CLIENT, ca_certs=None[, timeout])

给出一个受 SSL 保护的服务器的地址 addr，形式为 (hostname, port-number) ，获取该服务器的证书，并以 PEM 编码的字符串返回。如果指定了 ssl_version，则使用该版本的 SSL 协议尝试连接服务器。如果指定了 ca_certs，它应该是一个包含根证书列表的文件，与 SSLContext.wrap_socket() 中同名参数的格式相同。该调用将尝试根据该根证书集来验证服务器的证书，如果验证失败则调用失败。参数 timeout 可用于指定超时时间。

在 3.3 版更改: 此函数现在是 IPv6 兼容的。-compatible.

在 3.5 版更改: 默认的 ssl_version 从 PROTOCOL_SSLv3 改为 PROTOCOL_TLS 以保证与现代服务器的最大兼容性。

在 3.10 版更改: 加入 timeout 参数。

ssl.DER_cert_to_PEM_cert(DER_cert_bytes)

根据给定的 DER 编码字节块形式的证书，返回同一证书的 PEM 编码字符串版本。

ssl.PEM_cert_to_DER_cert(PEM_cert_string)

根据给定的 ASCII PEM 字符串形式的证书，返回同一证书的 DER 编码字节序列。

ssl.get_default_verify_paths()

返回包含 OpenSSL 的默认 cafile 和 capath 的路径的命名元组。 此路径与 SSLContext.set_default_verify_paths() 所使用的相同。 返回值是一个 named tuple DefaultVerifyPaths:

cafile - 解析出的 cafile 路径或者如果文件不存在则为 None,

capath - 解析出的 capath 路径或者如果目录不存在则为 None,

openssl_cafile_env - 指向一个 cafile 的 OpenSSL 环境键,

openssl_cafile - 一个 cafile 的硬编码路径,

openssl_capath_env - 指向一个 capath 的 OpenSSL 环境键,

openssl_capath - 一个 capath 目录的硬编码路径

可用性: LibreSSL 会忽略环境变量 openssl_cafile_env 和 openssl_capath_env。

3.4 新版功能.

ssl.enum_certificates(store_name)

从 Windows 的系统证书库中检索证书。 store_name 可以是 CA, ROOT 或 MY 中的一个。 Windows 也可能会提供额外的证书库。

此函数返回一个包含 (cert_bytes, encoding_type, trust) 元组的列表。 encoding_type 指明 cert_bytes 的编码格式。 它可以为 x509_asn 以表示 X.509 ASN.1 数据或是 pkcs_7_asn 以表示 PKCS#7 ASN.1 数据。 trust 以 OIDS 集合的形式指明证书的目的，或者如果证书对于所有目的都可以信任则为 True。

示例:

>>> 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)]

可用性: Windows。

3.4 新版功能.

ssl.enum_crls(store_name)

Windows 的系统证书库中检索 CRL。 store_name 可以是 CA, ROOT 或 MY 中的一个。 Windows 也可能会提供额外的证书库。

此函数返回一个包含 (cert_bytes, encoding_type, trust) 元组的列表。 encoding_type 指明 cert_bytes 的编码格式。 它可以为 x509_asn 以表示 X.509 ASN.1 数据或是 pkcs_7_asn 以表示 PKCS#7 ASN.1 数据。

可用性: Windows。

3.4 新版功能.

ssl.wrap_socket(sock, keyfile=None, certfile=None, server_side=False, cert_reqs=CERT_NONE, ssl_version=PROTOCOL_TLS, ca_certs=None, do_handshake_on_connect=True, suppress_ragged_eofs=True, ciphers=None)

接受一个 socket.socket 的实例 sock，并返回一个 ssl.SSLSocket 的实例，该类型是 socket.socket 的子类型，它将下层的套接字包装在一个 SSL 上下文中。 sock 必须是一个 SOCK_STREAM 套接字；其他套接字类型不被支持。

在内部，该函数会创建一个 SSLContext，其协议版本为 ssl_version 且 SSLContext.options 设为 cert_reqs。 如果设置了 keyfile, certfile, ca_certs 或 ciphers 等形参，则参数值会被传给 SSLContext.load_cert_chain(), SSLContext.load_verify_locations() 以及 SSLContext.set_ciphers()。

参数 server_side, do_handshake_on_connect 和 suppress_ragged_eofs 具有与 SSLContext.wrap_socket() 相同的含义。

3.7 版后已移除: 从 Python 3.2 和 2.7.9 开始，建议使用 SSLContext.wrap_socket() 来代替 wrap_socket()。 模块级函数的功能受限并且将创建不安全的客户端套接字，不带服务器名称提示或主机名匹配。

常量

所有常量现在都是 enum.IntEnum 或 enum.IntFlag 多项集的成员。

3.6 新版功能.

ssl.CERT_NONE

SSLContext.verify_mode 或 wrap_socket() 的 cert_reqs 形参可能的取值。 PROTOCOL_TLS_CLIENT 除外，这是默认的模式。 对于客户端套接字，几乎任何证书都是可接受的。 验证错误例如不受信任或过期的证书错误会被忽略并且不会中止 TLS/SSL 握手。

在服务器模式下，不会从客户端请求任何证书，因此客户端不会发送任何用于客户端证书身份验证的证书。

参见下文对于 安全考量 的讨论。

ssl.CERT_OPTIONAL

SSLContext.verify_mode 或 wrap_socket() 的 cert_reqs 形参可能的取值。 CERT_OPTIONAL 具有与 CERT_REQUIRED 相同的含义。 对于客户端套接字推荐改用 CERT_REQUIRED。

在服务器模式下，客户端证书请求会被发送给客户端。 客户端可以忽略请求也可以发送一个证书以执行 TLS 客户端证书身份验证。 如果客户端选择发送证书，则将对其执行验证。 任何验证错误都将立即中止 TLS 握手。

使用此设置要求将一组有效的 CA 证书传递给 SSLContext.load_verify_locations() 或是作为 wrap_socket() 的 ca_certs 形参值。

ssl.CERT_REQUIRED

SSLContext.verify_mode 或 wrap_socket() 的 cert_reqs 形参可能的取值。 在此模式下，需要从套接字连接的另一端获取证书；如果未提供证书或验证失败则将引发 SSLError。 此模式 不能 在客户端模式下对证书进行验证，因为它不会匹配主机名。 check_hostname 也必须被启用以验证证书的真实性。 PROTOCOL_TLS_CLIENT 会使用 CERT_REQUIRED 并默认启用 check_hostname。

对于服务器套接字，此模式会提供强制性的 TLS 客户端证书验证。 客户端证书请求会被发送给客户端并且客户端必须提供有效且受信任的证书。

使用此设置要求将一组有效的 CA 证书传递给 SSLContext.load_verify_locations() 或是作为 wrap_socket() 的 ca_certs 形参值。

class ssl.VerifyMode

CERT_* 常量的 enum.IntEnum 多项集。

3.6 新版功能.

ssl.VERIFY_DEFAULT

SSLContext.verify_flags 可能的取值。 在此模式下，证书吊销列表（CRL）并不会被检查。 OpenSSL 默认不要求也不验证 CRL。

3.4 新版功能.

ssl.VERIFY_CRL_CHECK_LEAF

SSLContext.verify_flags 可能的取值。 在此模式下， 只会检查对等证书而不检查任何中间 CA 证书。 此模式要求提供由对等证书颁发者（其直接上级 CA）签名的有效 CRL。 如果未使用 SSLContext.load_verify_locations 加载正确的 CRL，则验证将失败。

3.4 新版功能.

ssl.VERIFY_CRL_CHECK_CHAIN

SSLContext.verify_flags 可能的取值。 在此模式下，会检查对等证书链中所有证书的 CRL。

3.4 新版功能.

ssl.VERIFY_X509_STRICT

SSLContext.verify_flags 可能的取值，用于禁用已损坏 X.509 证书的绕过操作。

3.4 新版功能.

ssl.VERIFY_ALLOW_PROXY_CERTS

SSLContext.verify_flags 的可能取值，启用代理证书验证。

3.10 新版功能.

ssl.VERIFY_X509_TRUSTED_FIRST

SSLContext.verify_flags 可能的取值。 它指示 OpenSSL 在构建用于验证某个证书的信任链时首选受信任的证书。 此旗标将默认被启用。

3.4.4 新版功能.

ssl.VERIFY_X509_PARTIAL_CHAIN

SSLContext.verify_flags 的可能取值。它指示 OpenSSL 接受信任存储中的中间 CA 作为信任锚，与自我签名的根 CA 证书的方式相同。这样就能信任中间 CA 颁发的证书，而不一定非要去信任其祖先的根 CA。

3.10 新版功能.

class ssl.VerifyFlags

VERIFY_* 常量的 enum.IntFlag 多项集。

3.6 新版功能.

ssl.PROTOCOL_TLS

选择客户端和服务器均支持的最高协议版本。 此选项名称并不准确，实际上 "SSL" 和 "TLS" 协议均可被选择。

3.6 新版功能.

3.10 版后已移除: TLS 客户端和服务器需要不同的默认设置来实现安全通信。通用的 TLS 协议常量已废弃，而采用 PROTOCOL_TLS_CLIENT 和 PROTOCOL_TLS_SERVER。

ssl.PROTOCOL_TLS_CLIENT

自动协商为客户端和服务器都支持的最高版本协议，并配置当前上下文客户端的连接。该协议默认启用 CERT_REQUIRED 和 check_hostname。

3.6 新版功能.

ssl.PROTOCOL_TLS_SERVER

自动协商为客户端和服务器都支持的最高版本协议，并配置上下文服务器端的连接。

3.6 新版功能.

ssl.PROTOCOL_SSLv23

PROTOCOL_TLS 的别名。

3.6 版后已移除: 请改用 PROTOCOL_TLS。

ssl.PROTOCOL_SSLv2

选择 SSL 版本 2 作为通道加密协议。

如果OpenSSL是用``no-ssl2``选项编译的，则该协议不可用。

警告

SSL 版本 2 并不安全。 极不建议使用它。

3.6 版后已移除: OpenSSL 已经移除了对 SSLv2 的支持。

ssl.PROTOCOL_SSLv3

选择 SSL 版本 3 作为通道加密协议。

如果OpenSSL是用 no-ssl3 选项编译的，则该协议不可用。

警告

SSL 版本 3 并不安全。 极不建议使用它。

3.6 版后已移除: OpenSSL 已经废弃了所有特定于版本的协议。请换用带有 SSLContext.minimum_version 和 SSLContext.maximum_version 的默认协议 PROTOCOL_TLS_SERVER 或 PROTOCOL_TLS_CLIENT 。

ssl.PROTOCOL_TLSv1

选择 TLS 版本 1.0 作为通道加密协议。

3.6 版后已移除: OpenSSL 已经废弃了所有特定于版本的协议。

ssl.PROTOCOL_TLSv1_1

选择 TLS 版本 1.1 作为通道加密协议。 仅适用于 openssl 版本 1.0.1+。

3.4 新版功能.

3.6 版后已移除: OpenSSL 已经废弃了所有特定于版本的协议。

ssl.PROTOCOL_TLSv1_2

选用 TLS 1.2 版本作为隧道加密协议。只适用于 openssl 1.0.1 以上版本。

3.4 新版功能.

3.6 版后已移除: OpenSSL 已经废弃了所有特定于版本的协议。

ssl.OP_ALL

对存在于其他 SSL 实现中的各种缺陷启用绕过操作。 默认会设置此选项。 没有必要设置与 OpenSSL 的 SSL_OP_ALL 常量同名的旗标。

3.2 新版功能.

ssl.OP_NO_SSLv2

阻止 SSLv2 连接。 此选项仅可与 PROTOCOL_TLS 结合使用。 它会阻止对等方选择 SSLv2 作为协议版本。

3.2 新版功能.

3.6 版后已移除: SSLv2 已被弃用

ssl.OP_NO_SSLv3

阻止 SSLv3 连接。 此选项仅可与 PROTOCOL_TLS 结合使用。 它会阻止对等方选择 SSLv3 作为协议版本。

3.2 新版功能.

3.6 版后已移除: SSLv3 已被弃用

ssl.OP_NO_TLSv1

阻止 TLSv1 连接。 此选项仅可与 PROTOCOL_TLS 结合使用。 它会阻止对等方选择 TLSv1 作为协议版本。

3.2 新版功能.

3.7 版后已移除: 此选项自 OpenSSL 1.1.0 起已被弃用，请改用新的 SSLContext.minimum_version 和 SSLContext.maximum_version。

ssl.OP_NO_TLSv1_1

阻止 TLSv1.1 连接。 此选项仅可与 PROTOCOL_TLS 结合使用。 它会阻止对等方选择 TLSv1.1 作为协议版本。 仅适用于 openssl 版本 1.0.1+。

3.4 新版功能.

3.7 版后已移除: 此选项自 OpenSSL 1.1.0 起已被弃用。

ssl.OP_NO_TLSv1_2

阻止 TLSv1.2 连接。 此选项仅可与 PROTOCOL_TLS 结合使用。 它会阻止对等方选择 TLSv1.2 作为协议版本。 仅适用于 openssl 版本 1.0.1+。

3.4 新版功能.

3.7 版后已移除: 此选项自 OpenSSL 1.1.0 起已被弃用。

ssl.OP_NO_TLSv1_3

阻止 TLSv1.3 连接。 此选项仅可与 PROTOCOL_TLS 结合使用。 它会阻止对等方选择 TLSv1.3 作为协议版本。 TLS 1.3 适用于 OpenSSL 1.1.1 或更新的版本。 当 Python 编译是基于较旧版本的 OpenSSL 时，该旗标默认为 0。

3.7 新版功能.

3.7 版后已移除: 此选项自 OpenSSL 1.1.0 起已被弃用。 它被添加到 2.7.15, 3.6.3 和 3.7.0 是为了向下兼容 OpenSSL 1.0.2。

ssl.OP_NO_RENEGOTIATION

禁用所有 TLSv1.2 和更早版本的重协商操作。 不发送 HelloRequest 消息，并忽略通过 ClientHello 发起的重协商请求。

此选项仅适用于 OpenSSL 1.1.0h 及更新的版本。

3.7 新版功能.

ssl.OP_CIPHER_SERVER_PREFERENCE

使用服务器的密码顺序首选项，而不是客户端的首选项。 此选项在客户端套接字和 SSLv2 服务器套接字上无效。

3.3 新版功能.

ssl.OP_SINGLE_DH_USE

阻止对于单独的 SSL 会话重用相同的 DH 密钥。 这会提升前向保密性但需要更多的计算资源。 此选项仅适用于服务器套接字。

3.3 新版功能.

ssl.OP_SINGLE_ECDH_USE

阻止对于单独的 SSL 会话重用相同的 ECDH 密钥。 这会提升前向保密性但需要更多的计算资源。 此选项仅适用于服务器套接字。

3.3 新版功能.

ssl.OP_ENABLE_MIDDLEBOX_COMPAT

在 TLS 1.3 握手中发送虚拟更改密码规格（CCS）消息以使得 TLS 1.3 连接看起来更像是 TLS 1.2 连接。

此选项仅适用于 OpenSSL 1.1.1 及更新的版本。

3.8 新版功能.

ssl.OP_NO_COMPRESSION

在 SSL 通道上禁用压缩。 这适用于应用协议支持自己的压缩方案的情况。

3.3 新版功能.

class ssl.Options

OP_* 常量的 enum.IntFlag 多项集。

ssl.OP_NO_TICKET

阻止客户端请求会话凭据。

3.6 新版功能.

ssl.OP_IGNORE_UNEXPECTED_EOF

忽略 TLS 连接的意外关闭。

此选项仅适用于 OpenSSL 3.0.0 及更新的版本。

3.10 新版功能.

ssl.HAS_ALPN

OpenSSL 库是否具有对 RFC 7301 [https://datatracker.ietf.org/doc/html/rfc7301.html] 中描述的 应用层协议协商 TLS 扩展的内置支持。

3.5 新版功能.

ssl.HAS_NEVER_CHECK_COMMON_NAME

OpenSSL 库是否具有对不检测目标通用名称的内置支持且 SSLContext.hostname_checks_common_name 为可写状态。

3.7 新版功能.

ssl.HAS_ECDH

OpenSSL 库是否具有对基于椭圆曲线的 Diffie-Hellman 密钥交换的内置支持。 此常量应当为真值，除非发布者明确地禁用了此功能。

3.3 新版功能.

ssl.HAS_SNI

OpenSSL 库是否具有对 服务器名称提示 扩展（在 RFC 6066 [https://datatracker.ietf.org/doc/html/rfc6066.html] 中定义）的内置支持。

3.2 新版功能.

ssl.HAS_NPN

OpenSSL 库是否具有对 应用层协议协商 [https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation] 中描述的 下一协议协商 的内置支持。 当此常量为真值时，你可以使用 SSLContext.set_npn_protocols() 方法来公告你想要支持的协议。

3.3 新版功能.

ssl.HAS_SSLv2

OpenSSL 库是否具有对 SSL 2.0 协议的内置支持。

3.7 新版功能.

ssl.HAS_SSLv3

OpenSSL 库是否具有对 SSL 3.0 协议的内置支持。

3.7 新版功能.

ssl.HAS_TLSv1

OpenSSL 库是否具有对 TLS 1.0 协议的内置支持。

3.7 新版功能.

ssl.HAS_TLSv1_1

OpenSSL 库是否具有对 TLS 1.1 协议的内置支持。

3.7 新版功能.

ssl.HAS_TLSv1_2

OpenSSL 库是否具有对 TLS 1.2 协议的内置支持。

3.7 新版功能.

ssl.HAS_TLSv1_3

OpenSSL 库是否具有对 TLS 1.3 协议的内置支持。

3.7 新版功能.

ssl.CHANNEL_BINDING_TYPES

受支持的 TLS 通道绑定类型组成的列表。 此列表中的字符串可被用作传给 SSLSocket.get_channel_binding() 的参数。

3.3 新版功能.

ssl.OPENSSL_VERSION

解释器所加载的 OpenSSL 库的版本字符串:

>>> ssl.OPENSSL_VERSION
'OpenSSL 1.0.2k  26 Jan 2017'

3.2 新版功能.

ssl.OPENSSL_VERSION_INFO

代表 OpenSSL 库的版本信息的五个整数所组成的元组:

>>> ssl.OPENSSL_VERSION_INFO
(1, 0, 2, 11, 15)

3.2 新版功能.

ssl.OPENSSL_VERSION_NUMBER

OpenSSL 库的原始版本号，以单个整数表示:

>>> ssl.OPENSSL_VERSION_NUMBER
268443839
>>> hex(ssl.OPENSSL_VERSION_NUMBER)
'0x100020bf'

3.2 新版功能.

ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE

ssl.ALERT_DESCRIPTION_INTERNAL_ERROR

ALERT_DESCRIPTION_*

来自 RFC 5246 [https://datatracker.ietf.org/doc/html/rfc5246.html] 等文档的警报描述。 IANA TLS Alert Registry [https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6] 中包含了这个列表及对定义其含义的 RFC 引用。

被用作 SSLContext.set_servername_callback() 中的回调函数的返回值。

3.4 新版功能.

class ssl.AlertDescription

ALERT_DESCRIPTION_* 常量的 enum.IntEnum 多项集。

3.6 新版功能.

Purpose.SERVER_AUTH

用于 create_default_context() 和 SSLContext.load_default_certs() 的参数。表示上下文可用于验证网络服务器（因此，它将被用于创建客户端套接字）。

3.4 新版功能.

Purpose.CLIENT_AUTH

用于 create_default_context() 和 SSLContext.load_default_certs() 的参数。 表示上下文可用于验证网络客户（因此，它将被用于创建服务器端套接字）。

3.4 新版功能.

class ssl.SSLErrorNumber

SSL_ERROR_* 常量的 enum.IntEnum 多项集。

3.6 新版功能.

class ssl.TLSVersion

SSLContext.maximum_version 和 SSLContext.minimum_version 中的 SSL 和 TLS 版本的 enum.IntEnum 多项集。

3.7 新版功能.

TLSVersion.MINIMUM_SUPPORTED

TLSVersion.MAXIMUM_SUPPORTED

受支持的最低和最高 SSL 或 TLS 版本。 这些常量被称为魔术常量。 它们的值并不反映可用的最低和最高 TLS/SSL 版本。

TLSVersion.SSLv3

TLSVersion.TLSv1

TLSVersion.TLSv1_1

TLSVersion.TLSv1_2

TLSVersion.TLSv1_3

SSL 3.0 至 TLS 1.3。

3.10 版后已移除: 所有 TLSVersion 成员，除 TLSVersion.TLSv1_2 和 TLSVersion.TLSv1_3 之外均已废弃。

SSL 套接字

class ssl.SSLSocket(socket.socket)

SSL 套接字提供了 套接字对象 的下列方法:

accept()

bind()

close()

connect()

detach()

fileno()

getpeername(), getsockname()

getsockopt(), setsockopt()

gettimeout(), settimeout(), setblocking()

listen()

makefile()

recv(), recv_into() (but passing a non-zero flags argument is not allowed)

send(), sendall() (with the same limitation)

sendfile() (but os.sendfile will be used for plain-text sockets only, else send() will be used)

shutdown()

但是，由于 SSL（和 TLS）协议在 TCP 之上具有自己的框架，因此 SSL 套接字抽象在某些方面可能与常规的 OS 层级套接字存在差异。 特别是要查看 非阻塞型套接字说明。

SSLSocket 的实例必须使用 SSLContext.wrap_socket() 方法来创建。

在 3.5 版更改: 新增了 sendfile() 方法。

在 3.5 版更改: shutdown() 不会在每次接收或发送字节数据后重置套接字超时。 现在套接字超时为关闭的最大总持续时间。

3.6 版后已移除: 直接创建 SSLSocket 实例的做法已被弃用，请使用 SSLContext.wrap_socket() 来包装套接字。

在 3.7 版更改: SSLSocket 的实例必须使用 wrap_socket() 来创建。 在较早的版本中，直接创建实例是可能的。 但这从未被记入文档或是被正式支持。

在 3.10 版更改: Python 内部现在使用 SSL_read_ex 和 SSL_write_ex。这些函数支持读取和写入大于 2GB 的数据。写入零长数据不再出现违反协议的错误。

SSL 套接字还具有下列方法和属性:

SSLSocket.read(len=1024, buffer=None)

从 SSL 套接字读取至多 len 个字节的数据并将结果作为 bytes 实例返回。 如果指定了 buffer，则改为读取到缓冲区，并返回所读取的字节数。

如果套接字为 非阻塞型 则会引发 SSLWantReadError 或 SSLWantWriteError 且读取将阻塞。

由于在任何时候重新协商都是可能的，因此调用 read() 也可能导致写入操作。

在 3.5 版更改: 套接字超时在每次接收或发送字节数据后不会再被重置。 现在套接字超时为读取至多 len 个字节数据的最大总持续时间。

3.6 版后已移除: 请使用 recv() 来代替 read()。

SSLSocket.write(buf)

将 buf 写入到 SSL 套接字并返回所写入的字节数。 buf 参数必须为支持缓冲区接口的对象。

如果套接字为 非阻塞型 则会引发 SSLWantReadError 或 SSLWantWriteError 且读取将阻塞。

由于在任何时候重新协商都是可能的，因此调用 write() 也可能导致读取操作。

在 3.5 版更改: 套接字超时在每次接收或发送字节数据后不会再被重置。 现在套接字超时为写入 buf 的最大总持续时间。

3.6 版后已移除: 请使用 send() 来代替 write()。

注解

read() 和 write() 方法是读写未加密的应用级数据，并将其解密/加密为带加密的线路级数据的低层级方法。 这些方法需要有激活的 SSL 连接，即握手已完成而 SSLSocket.unwrap() 尚未被调用。

通常你应当使用套接字 API 方法例如 recv() 和 send() 来代替这些方法。

SSLSocket.do_handshake()

执行 SSL 设置握手。

在 3.4 版更改: 当套接字的 context 的 check_hostname 属性为真值时此握手方法还会执行 match_hostname()。

在 3.5 版更改: 套接字超时在每次接收或发送字节数据时不会再被重置。 现在套接字超时为握手的最大总持续时间。

在 3.7 版更改: 主机名或 IP 地址会在握手期间由 OpenSSL 进行匹配。 函数 match_hostname() 不再被使用。 在 OpenSSL 拒绝主机名或 IP 地址的情况下，握手将提前被中止并向对等方发送 TLS 警告消息。

SSLSocket.getpeercert(binary_form=False)

如果连接另一端的对等方没有证书，则返回 None。 如果 SSL 握手还未完成，则会引发 ValueError。

如果 binary_form 形参为 False，并且从对等方接收到了证书，此方法将返回一个 dict 实例。 如果证书未通过验证，则字典将为空。 如果证书通过验证，它将返回由多个密钥组成的字典，其中包括 subject (证书颁发给的主体) 和 issuer (颁发证书的主体)。 如果证书包含一个 Subject Alternative Name 扩展的实例 (see RFC 3280 [https://datatracker.ietf.org/doc/html/rfc3280.html])，则字典中还将有一个 subjectAltName 键。

subject 和 issuer 字段都是包含在证书中相应字段的数据结构中给出的相对专有名称（RDN）序列的元组，每个 RDN 均为 name-value 对的序列。 这里是一个实际的示例:

{'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}

注解

要验证特定服务的证书，你可以使用 match_hostname() 函数。

如果 binary_form 形参为 True，并且提供了证书，此方法会将整个证书的 DER 编码形式作为字节序列返回，或者如果对等方未提供证书则返回 None。 对等方是否提供证书取决于 SSL 套接字的角色:

对于客户端 SSL 套接字，服务器将总是提供证书，无论是否需要进行验证;

对于服务器 SSL 套接字，客户端将仅在服务器要求时才提供证书；因此如果你使用了 CERT_NONE (而不是 CERT_OPTIONAL 或 CERT_REQUIRED) 则 getpeercert() 将返回 None。

在 3.2 版更改: 返回的字典包括额外的条目例如 issuer 和 notBefore。

在 3.4 版更改: 如果握手未完成则会引发 ValueError。 返回的字典包括额外的 X509v3 扩展条目例如 crlDistributionPoints, caIssuers 和 OCSP URI。

在 3.9 版更改: IPv6 地址字符串不再附带末尾换行符。

SSLSocket.cipher()

返回由三个值组成的元组，其中包含所使用的密码名称，定义其使用方式的 SSL 协议版本，以及所使用的加密比特位数。 如果尚未建立连接，则返回 None。

SSLSocket.shared_ciphers()

返回在客户端和服务器均可用的密码列表。 所返回列表的每个条目都是由三个值组成的元组其中包含密码名称、定义其使用方式的 SSL 协议版本，以及密码所使用的加密比特位数量。 如果连接尚未建立或套接字为客户端套接字则 shared_ciphers() 将返回 None。

3.5 新版功能.

SSLSocket.compression()

以字符串形式返回所使用的压缩算法，或者如果连接没有使用压缩则返回 None。

如果高层级的协议支持自己的压缩机制，你可以使用 OP_NO_COMPRESSION 来禁用 SSL 层级的压缩。

3.3 新版功能.

SSLSocket.get_channel_binding(cb_type='tls-unique')

为当前连接获取字节串形式的通道绑定数据。 如果尚未连接或握手尚未完成则返回 None。

cb_type 形参允许选择需要的通道绑定类型。 有效的通道绑定类型在 CHANNEL_BINDING_TYPES 列表中列出。 目前只支持由 RFC 5929 [https://datatracker.ietf.org/doc/html/rfc5929.html] 所定义的 'tls-unique' 通道绑定。 如果请求了一个不受支持的通道绑定类型则将引发 ValueError。

3.3 新版功能.

SSLSocket.selected_alpn_protocol()

返回在 TLS 握手期间所选择的协议。 如果 SSLContext.set_alpn_protocols() 未被调用，如果另一方不支持 ALPN，如果此套接字不支持任何客户端所用的协议，或者如果握手尚未发生，则将返回 None。

3.5 新版功能.

SSLSocket.selected_npn_protocol()

返回在Return the higher-level protocol that was selected during the TLS/SSL 握手期间所选择的高层级协议。 如果 SSLContext.set_npn_protocols() 未被调用，或者如果另一方不支持 NPN，或者如果握手尚未发生，则将返回 None。

3.3 新版功能.

3.10 版后已移除: NPN 已被 ALPN 取代。

SSLSocket.unwrap()

执行 SSL 关闭握手，这会从下层的套接字中移除 TLS 层，并返回下层的套接字对象。 这可被用来通过一个连接将加密操作转为非加密。 返回的套接字应当总是被用于同连接另一方的进一步通信，而不是原始的套接字。

SSLSocket.verify_client_post_handshake()

向一个 TLS 1.3 客户端请求握手后身份验证（PHA）。 只有在初始 TLS 握手之后且双方都启用了 PHA 的情况下才能为服务器端套接字的 TLS 1.3 连接启用 PHA，参见 SSLContext.post_handshake_auth。

此方法不会立即执行证书交换。 服务器端会在下一次写入事件期间发送 CertificateRequest 并期待客户端在下一次读取事件期间附带证书进行响应。

如果有任何前置条件未被满足（例如非 TLS 1.3，PHA 未启用），则会引发 SSLError。

注解

仅在 OpenSSL 1.1.1 且 TLS 1.3 被启用时可用。 没有 TLS 1.3 支持，此方法将引发 NotImplementedError。

3.8 新版功能.

SSLSocket.version()

以字符串形式返回由连接协商确定的实际 SSL 协议版本，或者如果未建立安全连接则返回 None。 在撰写本文档时，可能的返回值包括 "SSLv2", "SSLv3", "TLSv1", "TLSv1.1" 和 "TLSv1.2"。 最新的 OpenSSL 版本可能会定义更多的返回值。

3.5 新版功能.

SSLSocket.pending()

返回在连接上等待被读取的已解密字节数。

SSLSocket.context

此 SSL 套接字所联结的 SSLContext 对象。 如果 SSL 套接字是使用已弃用的 wrap_socket() 函数 (而非 SSLContext.wrap_socket()) 创建的，则这将是为此 SSL 套接字创建的自定义上下文对象。

3.2 新版功能.

SSLSocket.server_side

一个布尔值，对于服务器端套接字为 True 而对于客户端套接字则为 False。

3.2 新版功能.

SSLSocket.server_hostname

服务器的主机名: str 类型，对于服务器端套接字或者如果构造器中未指定主机名则为 None。

3.2 新版功能.

在 3.7 版更改: 现在该属性将始终为 ASCII 文本。 当 server_hostname 为一个国际化域名（IDN）时，该属性现在会保存为 A 标签形式 ("xn--pythn-mua.org") 而非 U 标签形式 ("pythön.org")。

SSLSocket.session

用于 SSL 连接的 SSLSession。 该会话将在执行 TLS 握手后对客户端和服务器端套接字可用。 对于客户端套接字该会话可以在调用 do_handshake() 之前被设置以重用一个会话。

3.6 新版功能.

SSLSocket.session_reused

3.6 新版功能.

SSL 上下文

3.2 新版功能.

SSL 上下文可保存各种比单独 SSL 连接寿命更长的数据，例如 SSL 配置选项，证书和私钥等。 它还可为服务器端套接字管理缓存，以加快来自相同客户端的重复连接。

class ssl.SSLContext(protocol=None)

创建一个新的 SSL 上下文。 你可以传入 protocol，它必须为此模块中定义的 PROTOCOL_* 常量之一。 该形参指定要使用哪个 SSL 协议版本。 通常，服务器会选择一个特定的协议版本，而客户端必须适应服务器的选择。 大多数版本都不能与其他版本互操作。 如果未指定，则默认值为 PROTOCOL_TLS；它提供了与其他版本的最大兼容性。

这个表显示了客户端（横向）的哪个版本能够连接服务器（纵向）的哪个版本。

客户端 / 服务器 | SSLv2 | SSLv3 | TLS 3 | TLSv1 | TLSv1.1 | TLSv1.2
SSLv2 | 是 | 否 | 否 1 | 否 | 否 | 否
SSLv3 | 否 | 是 | 否 2 | 否 | 否 | 否
TLS (SSLv23) 3 | 否 1 | 否 2 | 是 | 是 | 是 | 是
TLSv1 | 否 | 否 | 是 | 是 | 否 | 否
TLSv1.1 | 否 | 否 | 是 | 否 | 是 | 否
TLSv1.2 | 否 | 否 | 是 | 否 | 否 | 是

备注

1(1,2)

SSLContext 默认设置 OP_NO_SSLv2 以禁用 SSLv2。

2(1,2)

SSLContext 默认设置 OP_NO_SSLv3 以禁用 SSLv3。

3(1,2)

TLS 1.3 协议在 OpenSSL >= 1.1.1 中设置 PROTOCOL_TLS 时可用。 没有专门针对 TLS 1.3 的 PROTOCOL 常量。

参见

create_default_context() 让 ssl 为特定目标选择安全设置。

在 3.6 版更改: 上下文会使用安全默认值来创建。 默认设置的选项有 OP_NO_COMPRESSION, OP_CIPHER_SERVER_PREFERENCE, OP_SINGLE_DH_USE, OP_SINGLE_ECDH_USE, OP_NO_SSLv2 (except for PROTOCOL_SSLv2) 和 OP_NO_SSLv3 (except for PROTOCOL_SSLv3)。 初始密码集列表只包含 HIGH 密码，不包含 NULL 密码和 MD5 密码 (PROTOCOL_SSLv2 除外)。

3.10 版后已移除: 不带协议参数的 SSLContext 已废弃。将来，上下文类会要求使用 PROTOCOL_TLS_CLIENT 或 PROTOCOL_TLS_SERVER 协议。

在 3.10 版更改: 现在默认的密码套件只包含安全的 AES 和 ChaCha20 密码，具有前向保密性和安全级别2。禁止使用少于 2048 位的 RSA 和 DH 密钥以及少于 224 位的ECC密钥。 PROTOCOL_TLS 、 PROTOCOL_TLS_CLIENT 和 PROTOCOL_TLS_SERVER 至少使用 TLS 1.2 版本。

SSLContext 对象具有以下方法和属性:

SSLContext.cert_store_stats()

获取以字典表示的有关已加载的 X.509 证书数量，被标记为 CA 证书的 X.509 证书数量以及证书吊销列表的统计信息。

具有一个 CA 证书和一个其他证书的上下文示例:

>>> context.cert_store_stats()
{'crl': 0, 'x509_ca': 1, 'x509': 2}

3.4 新版功能.

SSLContext.load_cert_chain(certfile, keyfile=None, password=None)

加载一个私钥及对应的证书。 certfile 字符串必须为以 PEM 格式表示的单个文件路径，该文件中包含证书以及确立证书真实性所需的任意数量的 CA 证书。 如果存在 keyfile 字符串，它必须指向一个包含私钥的文件。 否则私钥也将从 certfile 中提取。 请参阅 证书 中的讨论来了解有关如何将证书存储至 certfile 的更多信息。

password 参数可以是一个函数，调用时将得到用于解密私钥的密码。 它在私钥被加密且需要密码时才会被调用。 它调用时将不带任何参数，并且应当返回一个字符串、字节串或字节数组。 如果返回值是一个字符串，在用它解密私钥之前它将以 UTF-8 进行编码。 或者也可以直接将字符串、字节串或字节数组值作为 password 参数提供。 如果私钥未被加密且不需要密码则它将被忽略。

如果未指定 password 参数且需要一个密码，将会使用 OpenSSL 内置的密码提示机制来交互式地提示用户输入密码。

如果私钥不能匹配证书则会引发 SSLError。

在 3.3 版更改: 新增可选参数 password。

SSLContext.load_default_certs(purpose=Purpose.SERVER_AUTH)

从默认位置加载一组默认的 "证书颁发机构" (CA) 证书。 在 Windows 上它将从 CA 和 ROOT 系统存储中加载 CA 证书。 在所有系统上它会调用 SSLContext.set_default_verify_paths() 。 将来该方法也可能会从其他位置加载 CA 证书。

purpose 旗标指明要加载哪一类 CA 证书。 默认设置 Purpose.SERVER_AUTH 加载被标记且被信任用于 TLS Web 服务器验证（客户端套接字）的证书。 Purpose.CLIENT_AUTH 则加载用于在服务器端进行客户端证书验证的 CA 证书。

3.4 新版功能.

SSLContext.load_verify_locations(cafile=None, capath=None, cadata=None)

当 verify_mode 不为 CERT_NONE 时加载一组用于验证其他对等方证书的 "证书颁发机构" (CA) 证书。 必须至少指定 cafile 或 capath 中的一个。

此方法还可加载 PEM 或 DER 格式的证书吊销列表 (CRL)，为此必须正确配置 SSLContext.verify_flags。

如果存在 cafile 字符串，它应为 PEM 格式的级联 CA 证书文件的路径。 请参阅 证书 中的讨论来了解有关如何处理此文件中的证书的更多信息。

如果存在 capath 字符串，它应为包含多个 PEM 格式的 CA 证书的目录的路径，并遵循 OpenSSL 专属布局 [https://www.openssl.org/docs/manmaster/man3/SSL_CTX_load_verify_locations.html]。

如果存在 cadata 对象，它应为一个或多个 PEM 编码的证书的 ASCII 字符串或者 DER 编码的证书的 bytes-like object。 与 capath 一样 PEM 编码的证书之外的多余行会被忽略，但至少要有一个证书。

在 3.4 版更改: 新增可选参数 cadata

SSLContext.get_ca_certs(binary_form=False)

获取已离开法人 "证书颁发机构" (CA) 证书列表。 如果 binary_form 形参为 False 则每个列表条目都是一个类似于 SSLSocket.getpeercert() 输出的字典。 在其他情况下此方法将返回一个 DER 编码的证书的列表。 返回的列表不包含来自 capath 的证书，除非 SSL 连接请求并加载了一个证书。

注解

capath 目录中的证书不会被加载，除非它们已至少被使用过一次。

3.4 新版功能.

SSLContext.get_ciphers()

获取已启用密码的列表。 该列表将按密码的优先级排序。 参见 SSLContext.set_ciphers()。

示例:

>>> 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'}]

3.6 新版功能.

SSLContext.set_default_verify_paths()

从构建 OpenSSL 库时定义的文件系统路径中加载一组默认的 "证书颁发机构" (CA) 证书。 不幸的是，没有一种简单的方式能知道此方法是否执行成功：如果未找到任何证书也不会返回错误。 不过，当 OpenSSL 库是作为操作系统的一部分被提供时，它的配置应当是正确的。

SSLContext.set_ciphers(ciphers)

为使用此上下文创建的套接字设置可用密码。 它应当为 OpenSSL 密码列表格式 [https://www.openssl.org/docs/manmaster/man1/ciphers.html] 的字符串。 如果没有可被选择的密码（由于编译时选项或其他配置禁止使用所指定的任何密码），则将引发 SSLError。

注解

在连接后，SSL 套接字的 SSLSocket.cipher() 方法将给出当前所选择的密码。

TLS 1.3 密码套件不能通过 set_ciphers() 禁用。

SSLContext.set_alpn_protocols(protocols)

指定在 SSL/TLS 握手期间套接字应当通告的协议。 它应为由 ASCII 字符串组成的列表，例如 ['http/1.1', 'spdy/2']，按首选顺序排列。 协议的选择将在握手期间发生，并依据 RFC 7301 [https://datatracker.ietf.org/doc/html/rfc7301.html] 来执行。 在握手成功后，SSLSocket.selected_alpn_protocol() 方法将返回已达成一致的协议。

如果 HAS_ALPN 为 False 则此方法将引发 NotImplementedError。

3.5 新版功能.

SSLContext.set_npn_protocols(protocols)

指定在Specify which protocols the socket should advertise during the SSL/TLS 握手期间套接字应当通告的协议。 它应为由字符串组成的列表，例如 ['http/1.1', 'spdy/2']，按首选顺序排列。 协议的选择将在握手期间发生，并将依据 应用层协议协商 [https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation] 来执行。 在握手成功后，SSLSocket.selected_npn_protocol() 方法将返回已达成一致的协议。

如果 HAS_NPN 为 False 则此方法将引发 NotImplementedError。

3.3 新版功能.

3.10 版后已移除: NPN 已被 ALPN 取代。

SSLContext.sni_callback

注册一个回调函数，当 TLS 客户端指定了一个服务器名称提示时，该回调函数将在 SSL/TLS 服务器接收到 TLS Client Hello 握手消息后被调用。 服务器名称提示机制的定义见 RFC 6066 [https://datatracker.ietf.org/doc/html/rfc6066.html] section 3 - Server Name Indication。

每个 SSLContext 只能设置一个回调。 如果 sni_callback 被设置为 None 则会禁用回调。 对该函数的后续调用将禁用之前注册的回调。

此回调函数将附带三个参数来调用；第一个参数是 ssl.SSLSocket，第二个参数是代表客户端准备与之通信的服务器的字符串 (或者如果 TLS Client Hello 不包含服务器名称则为 None) 而第三个参数是原来的 SSLContext。 服务器名称参数为文本形式。 对于国际化域名，服务器名称是一个 IDN A 标签 ("xn--pythn-mua.org")。

此回调的一个典型用法是将 ssl.SSLSocket 的 SSLSocket.context 属性修改为一个 SSLContext 类型的新对象，该对象代表与服务器相匹配的证书链。

由于 TLS 连接处于早期协商阶段，因此仅能使用有限的方法和属性例如 SSLSocket.selected_alpn_protocol() 和 SSLSocket.context。 SSLSocket.getpeercert(), SSLSocket.cipher() 和 SSLSocket.compression() 方法要求 TLS 连接已经过 TLS Client Hello 因而将既不返回有意义的值，也不能安全地调用它们。

sni_callback 函数必须返回 None 以允许 TLS 协商继续进行。 如果想要 TLS 失败，则可以返回常量 ALERT_DESCRIPTION_*。 其他返回值将导致 TLS 的致命错误 ALERT_DESCRIPTION_INTERNAL_ERROR。

如果从 sni_callback 函数引发了异常，则 TLS 连接将终止并发出 TLS 致命警告消息 ALERT_DESCRIPTION_HANDSHAKE_FAILURE。

如果 OpenSSL library 库在构建时定义了 OPENSSL_NO_TLSEXT 则此方法将返回 NotImplementedError。

3.7 新版功能.

SSLContext.set_servername_callback(server_name_callback)

这是被保留用于向下兼容的旧式 API。 在可能的情况下，你应当改用 sni_callback。 给出的 server_name_callback 类似于 sni_callback，不同之处在于当服务器主机名是 IDN 编码的国际化域名时，server_name_callback 会接收到一个已编码的 U 标签 ("pythön.org")。

如果发生了服务器名称解码错误。 TLS 连接将终止并向客户端发出 ALERT_DESCRIPTION_INTERNAL_ERROR 最严重 TLS 警告消息。

3.4 新版功能.

SSLContext.load_dh_params(dhfile)

加载密钥生成参数用于 Diffie-Hellman (DH) 密钥交换。 使用 DH 密钥交换能以消耗（服务器和客户端的）计算资源为代价提升前向保密性。 dhfile 参数应当为指向一个包含 PEM 格式的 DH 形参的文件的路径。

此设置不会应用于客户端套接字。 你还可以使用 OP_SINGLE_DH_USE 选项来进一步提升安全性。

3.3 新版功能.

SSLContext.set_ecdh_curve(curve_name)

为基于椭圆曲线的 Elliptic Curve-based Diffie-Hellman (ECDH) 密钥交换设置曲线名称。 ECDH 显著快于常规 DH 同时据信同样安全。 curve_name 形参应为描述某个知名椭圆曲线的字符串，例如受到广泛支持的曲线 prime256v1。

此设置不会应用于客户端套接字。 你还可以使用 OP_SINGLE_ECDH_USE 选项来进一步提升安全性。

如果 HAS_ECDH 为 False 则此方法将不可用。

3.3 新版功能.

参见

SSL/TLS 与完美的前向保密性 [https://vincent.bernat.im/en/blog/2011-ssl-perfect-forward-secrecy]

Vincent Bernat。

SSLContext.wrap_socket(sock, server_side=False, do_handshake_on_connect=True, suppress_ragged_eofs=True, server_hostname=None, session=None)

包装一个现有的 Python 套接字 sock 并返回一个 SSLContext.sslsocket_class 的实例 (默认为 SSLSocket)。 返回的 SSL 套接字会绑定上下文、设置以及证书。 sock 必须是一个 SOCK_STREAM 套接字；其他套接字类型不被支持。

形参 server_side 是一个布尔值，它标明希望从该套接字获得服务器端行为还是客户端行为。

对于客户端套接字，上下文的构造会延迟执行；如果下层的套接字尚未连接，上下文的构造将在对套接字调用 connect() 之后执行。 对于服务器端套接字，如果套接字没有远端对等方，它会被视为一个监听套接字，并且服务器端 SSL 包装操作会在通过 accept() 方法所接受的客户端连接上自动执行。 此方法可能会引发 SSLError。

在客户端连接上，可选形参 server_hostname 指定所要连接的服务的主机名。 这允许单个服务器托管具有单独证书的多个基于 SSL 的服务，很类似于 HTTP 虚拟主机。 如果 server_side 为真值则指定 server_hostname 将引发 ValueError。

形参 do_handshake_on_connect 指明是否要在调用 socket.connect() 之后自动执行 SSL 握手，还是要通过唤起 SSLSocket.do_handshake() 方法让应用程序显式地调用它。 显式地调用 SSLSocket.do_handshake() 可给予程序对握手中所涉及的套接字 I/O 阻塞行为的控制。

形参 suppress_ragged_eofs 指明 SSLSocket.recv() 方法应当如何从连接的另一端发送非预期的 EOF 信号。 如果指定为 True (默认值)，它将返回正常的 EOF (空字节串对象) 来响应从下层套接字引发的非预期的 EOF 错误；如果指定为 False，它将向调用方引发异常。

session，参见 session。

在 3.5 版更改: 总是允许传送 server_hostname，即使 OpenSSL 没有 SNI。

在 3.6 版更改: 增加了 session 参数。

在 3.7 版更改: 此方法返回 SSLContext.sslsocket_class 的实例而非硬编码的 SSLSocket。

SSLContext.sslsocket_class

SSLContext.wrap_socket() 的返回类型，默认为 SSLSocket。 该属性可以在类实例上被重载以便返回自定义的 SSLSocket 的子类。

3.7 新版功能.

SSLContext.wrap_bio(incoming, outgoing, server_side=False, server_hostname=None, session=None)

包装 BIO 对象 incoming 和 outgoing 并返回一个 SSLContext.sslobject_class (默认为 SSLObject) 的实例。 SSL 例程将从 BIO 中读取输入数据并将数据写入到 outgoing BIO。

server_side, server_hostname 和 session 形参具有与 SSLContext.wrap_socket() 中相同的含义。

在 3.6 版更改: 增加了 session 参数。

在 3.7 版更改: 此方法返回 SSLContext.sslobject_class 的实例则非硬编码的 SSLObject。

SSLContext.sslobject_class

SSLContext.wrap_bio() 的返回类型，默认为 SSLObject。 该属性可以在类实例上被重载以便返回自定义的 SSLObject 的子类。

3.7 新版功能.

SSLContext.session_stats()

获取由该上下文创建或管理的 SSL 会话的统计数据。 返回一个将每个 信息块 [https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_sess_number.html] 映射到其数字值的字典。 例如，下面是自该上下文创建以来会话缓存中的总点击数和失误数。:

>>> stats = context.session_stats()
>>> stats['hits'], stats['misses']
(0, 0)

SSLContext.check_hostname

是否要将匹配 SSLSocket.do_handshake() 中对等方证书的主机名。 该上下文的 verify_mode 必须被设为 CERT_OPTIONAL 或 CERT_REQUIRED，并且你必须将 server_hostname 传给 wrap_socket() 以便匹配主机名。 启用主机名检查会自动将 verify_mode 从 CERT_NONE 设为 CERT_REQUIRED。 只要启用了主机名检查就无法将其设回 CERT_NONE。 PROTOCOL_TLS_CLIENT 协议默认启用主机名检查。 对于其他协议，则必须显式地启用主机名检查。

示例:

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))

3.4 新版功能.

在 3.7 版更改: 现在当主机名检查被启用且 verify_mode 为 CERT_NONE 时 verify_mode 会自动更改为 CERT_REQUIRED。 在之前版本中同样的操作将失败并引发 ValueError。

SSLContext.keylog_filename

每当生成或接收到密钥时，将 TLS 密钥写入到一个密钥日志文件。 密钥日志文件的设计仅适用于调试目的。 文件的格式由 NSS 指明并为许多流量分析工具例如 Wireshark 所使用。 日志文件会以追加模式打开。 写入操作会在线程之间同步，但不会在进程之间同步。

3.8 新版功能.

SSLContext.maximum_version

一个代表所支持的最高 TLS 版本的 TLSVersion 枚举成员。 该值默认为 TLSVersion.MAXIMUM_SUPPORTED。 这个属性对于 PROTOCOL_TLS, PROTOCOL_TLS_CLIENT 和 PROTOCOL_TLS_SERVER 以外的其他协议来说都是只读的。

maximum_version, minimum_version 和 SSLContext.options 等属性都会影响上下文所支持的 SSL 和 TLS 版本。 这个实现不会阻止无效的组合。 例如一个 options 为 OP_NO_TLSv1_2 而 maximum_version 设为 TLSVersion.TLSv1_2 的上下文将无法建立 TLS 1.2 连接。

3.7 新版功能.

SSLContext.minimum_version

与 SSLContext.maximum_version 类似，区别在于它是所支持的最低版本或为 TLSVersion.MINIMUM_SUPPORTED。

3.7 新版功能.

SSLContext.num_tickets

控制 TLS_PROTOCOL_SERVER 上下文的 TLS 1.3 会话凭据数量。这个设置不会影响 TLS 1.0 - 1.2 的连接。

3.8 新版功能.

SSLContext.options

一个代表此上下文中所启用的 SSL 选项集的整数。 默认值为 OP_ALL，但你也可以通过在选项间进行 OR 运算来指定其他选项例如 OP_NO_SSLv2。

在 3.6 版更改: SSLContext.options 返回 Options 旗标:

>>> ssl.create_default_context().options
<Options.OP_ALL|OP_NO_SSLv3|OP_NO_SSLv2|OP_NO_COMPRESSION: 2197947391>

3.7 版后已移除: 自 OpenSSL 1.1.0 起，所有 OP_NO_SSL* 和 OP_NO_TLS* 选项已被弃用，请改用新的 SSLContext.minimum_version 和 SSLContext.maximum_version。

SSLContext.post_handshake_auth

启用 TLS 1.3 握手后客户端身份验证。 握手后验证默认是被禁用的，服务器只能在初始握手期间请求 TLS 客户端证书。 当启用时，服务器可以在握手之后的任何时候请求 TLS 客户端证书。

当在客户端套接字上启用时，客户端会向服务器发信号说明它支持握手后身份验证。

当在服务器端套接字上启用时，SSLContext.verify_mode 也必须被设为 CERT_OPTIONAL 或 CERT_REQUIRED。 实际的客户端证书交换会被延迟直至 SSLSocket.verify_client_post_handshake() 被调用并执行了一些 I/O 操作后再进行。

3.8 新版功能.

SSLContext.protocol

构造上下文时所选择的协议版本。 这个属性是只读的。

SSLContext.hostname_checks_common_name

在没有目标替代名称扩展的情况下 check_hostname 是否要回退为验证证书的通用名称（默认为真值）。

3.7 新版功能.

在 3.10 版更改: 此旗标在 OpenSSL 1.1.1k 之前的版本上不起作用。 Python 3.8.9, 3.9.3, 和 3.10 包含了针对之前版本的变通处理。

SSLContext.security_level

整数值，代表上下文的 安全级别 [https://www.openssl.org/docs/manmaster/man3/SSL_CTX_get_security_level.html]。 本属性只读。

3.10 新版功能.

SSLContext.verify_flags

证书验证操作的标志位。可以用“或”的方式组合在一起设置 VERIFY_CRL_CHECK_LEAF 这类标志。默认情况下，OpenSSL 既不需要也不验证证书吊销列表（CRL）。

3.4 新版功能.

在 3.6 版更改: SSLContext.verify_flags 返回 VerifyFlags 旗标:

>>> ssl.create_default_context().verify_flags
<VerifyFlags.VERIFY_X509_TRUSTED_FIRST: 32768>

SSLContext.verify_mode

是否要尝试验证其他对等方的证书以及如果验证失败应采取何种行为。 该属性值必须为 CERT_NONE, CERT_OPTIONAL 或 CERT_REQUIRED 之一。

在 3.6 版更改: SSLContext.verify_mode 返回 VerifyMode 枚举:

>>> ssl.create_default_context().verify_mode
<VerifyMode.CERT_REQUIRED: 2>

证书

总的来说证书是公钥/私钥系统的一个组成部分。 在这个系统中，每 个 主体 (可能是一台机器、一个人或者一个组织) 都会分配到唯一的包含两部分的加密密钥。 一部分密钥是公开的，称为 公钥；另一部分密钥是保密的，称为 私钥。 这两个部分是互相关联的，就是说如果你用其中一个部分来加密一条消息，你将能用并且 只能 用另一个部分来解密它。

在一个证书中包含有两个主体的相关信息。 它包含 目标方 的名称和目标方的公钥。 它还包含由第二个主体 颁发方 所发布的声明：目标方的身份与他们所宣称的一致，包含的公钥也确实是目标方的公钥。 颁发方的声明使用颁发方的私钥进行签名，该私钥的内容只有颁发方自己才知道。 但是，任何人都可以找到颁发方的公钥，用它来解密这个声明，并将其与证书中的其他信息进行比较来验证颁发方声明的真实性。 证书还包含有关其有效期限的信息。 这被表示为两个字段，即 "notBefore" 和 "notAfter"。

在 Python 中应用证书时，客户端或服务器可以用证书来证明自己的身份。 还可以要求网络连接的另一方提供证书，提供的证书可以用于验证以满足客户端或服务器的验证要求。 如果验证失败，连接尝试可被设置为引发一个异常。 验证是由下层的 OpenSSL 框架来自动执行的；应用程序本身不必关注其内部的机制。 但是应用程序通常需要提供一组证书以允许此过程的发生。

Python 使用文件来包含证书。 它们应当采用 "PEM" 格式 (参见 RFC 1422 [https://datatracker.ietf.org/doc/html/rfc1422.html])，这是一种带有头部行和尾部行的 base-64 编码包装形式:

-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----

证书链

包含证书的 Python 文件可以包含一系列的证书，有时被称为 证书链。 这个证书链应当以 "作为" 客户端或服务器的主体的专属证书打头，然后是证书颁发方的证书，然后是 上述 证书的颁发方的证书，证书链就这样不断上溯直到你得到一个 自签名 的证书，即具有相同目标方和颁发方的证书，有时也称为 根证书。 在证书文件中这些证书应当被拼接为一体。 例如，假设我们有一个包含三个证书的证书链，以我们的服务器证书打头，然后是为我们的服务器证书签名的证书颁发机构的证书，最后是为证书颁发机构的证书颁发证书的机构的根证书:

-----BEGIN CERTIFICATE-----
... (certificate for your server)...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (the certificate for the CA)...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (the root certificate for the CA's issuer)...
-----END CERTIFICATE-----

CA 证书

如果你想要求对连接的另一方的证书进行验证，你必须提供一个 "CA 证书" 文件，其中包含了你愿意信任的每个颁发方的证书链。 同样地，这个文件的内容就是这些证书链拼接在一起的结果。 为了进行验证，Python 将使用它在文件中找到的第一个匹配的证书链。 可以通过调用 SSLContext.load_default_certs() 来使用系统平台的证书文件，这可以由 create_default_context() 自动完成。

合并的密钥和证书

私钥往往与证书存储在相同的文件中；在此情况下，只需要将 certfile 形参传给 SSLContext.load_cert_chain() 和 wrap_socket()。 如果私钥是与证书一起存储的，则它应当放在证书链的第一个证书之前:

-----BEGIN RSA PRIVATE KEY-----
... (private key in base64 encoding) ...
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----

自签名证书

如果你准备创建一个提供 SSL 加密连接服务的服务器，你需要为该服务获取一份证书。 有许多方式可以获取合适的证书，例如从证书颁发机构购买。 另一种常见做法是生成自签名证书。 生成自签名证书的最简单方式是使用 OpenSSL 软件包，代码如下所示:

% 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
%

自签名证书的缺点在于它是它自身的根证书，因此不会存在于别人的已知（且信任的）根证书缓存当中。

例子

检测 SSL 支持

要检测一个 Python 安装版中是否带有 SSL 支持，用户代码应当使用以下例程:

try:
    import ssl
except ImportError:
    pass
else:
    ...  # do something that requires SSL support

客户端操作

这个例子创建了一个 SSL 上下文并使用客户端套接字的推荐安全设置，包括自动证书验证:

>>> context = ssl.create_default_context()

如果你喜欢自行调整安全设置，你可能需要从头创建一个上下文（但是请请注意避免不正确的设置）:

>>> context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt")

(这段代码假定你的操作系统将所有 CA 证书打包存放于 /etc/ssl/certs/ca-bundle.crt；如果不是这样，你将收到报错信息，必须修改此位置)

PROTOCOL_TLS_CLIENT 协议配置用于证书验证和主机名验证的上下文。 verify_mode 设为 CERT_REQUIRED 而 check_hostname 设为 True。 所有其他协议都会使用不安全的默认值创建 SSL 上下文。

当你使用此上下文去连接服务器时，CERT_REQUIRED 和 check_hostname 会验证服务器证书；它将确认服务器证书使用了某个 CA 证书进行签名，检查签名是否正确，并验证其他属性例如主机名的有效性和身份真实性:

>>> conn = context.wrap_socket(socket.socket(socket.AF_INET),
...                            server_hostname="www.python.org")
>>> conn.connect(("www.python.org", 443))

你可以随后获取该证书:

>>> cert = conn.getpeercert()

可视化检查显示证书能够证明目标服务 (即 HTTPS 主机 www.python.org) 的身份:

>>> 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}

现在 SSL 通道已建立并已验证了证书，你可以继续与服务器对话了:

>>> 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'',
 b'']

参见下文对于 安全考量 的讨论。

服务器端操作

对于服务器操作，通常你需要在文件中存放服务器证书和私钥各一份。 你将首先创建一个包含密钥和证书的上下文，这样客户端就能检查你的身份真实性。 然后你将打开一个套接字，将其绑定到一个端口，在其上调用 listen()，并开始等待客户端连接:

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)

当有客户端连接时，你将在套接字上调用 accept() 以从另一端获取新的套接字，并使用上下文的 SSLContext.wrap_socket() 方法来为连接创建一个服务器端 SSL 套接字:

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()

随后你将从 connstream 读取数据并对其进行处理，直至你结束与客户端的会话（或客户端结束与你的会话）:

def deal_with_client(connstream):
    data = connstream.recv(1024)
    # empty data means the client is finished with us
    while data:
        if not do_something(connstream, data):
            # we'll assume do_something returns False
            # when we're finished with client
            break
        data = connstream.recv(1024)
    # finished with client

并返回至监听新的客户端连接（当然，真正的服务器应当会在单独的线程中处理每个客户端连接，或者将套接字设为 非阻塞模式 并使用事件循环）。

关于非阻塞套接字的说明

在非阻塞模式下 SSL 套接字的行为与常规套接字略有不同。 当使用非阻塞模式时，你需要注意下面这些事情:

如果一个 I/O 操作会阻塞，大多数 SSLSocket 方法都将引发 SSLWantWriteError 或 SSLWantReadError 而非 BlockingIOError。 如果有必要在下层套接字上执行读取操作将引发 SSLWantReadError，在下层套接字上执行写入操作则将引发 SSLWantWriteError。 请注意尝试 写入 到 SSL 套接字可能需要先从下层套接字 读取，而尝试从 SSL 套接字 读取 则可能需要先向下层套接字 写入。

在 3.5 版更改: 在较早的 Python 版本中，SSLSocket.send() 方法会返回零值而非引发 SSLWantWriteError 或 SSLWantReadError。

调用 select() 将告诉你可以从 OS 层级的套接字读取（或向其写入），但这并不意味着在上面的 SSL 层有足够的数据。 例如，可能只有部分 SSL 帧已经到达。 因此，你必须准备好处理 SSLSocket.recv() 和 SSLSocket.send() 失败的情况，并在再次调用 select() 之后重新尝试。

相反地，由于 SSL 层具有自己的帧机制，一个 SSL 套接字可能仍有可读取的数据而 select() 并不知道这一点。 因此，你应当先调用 SSLSocket.recv() 取走所有潜在的可用数据，然后只在必要时对 select() 调用执行阻塞。

(当然，类似的保留规则在使用其他原语例如 poll()，或 selectors 模块中的原语时也适用)

SSL 握手本身将是非阻塞的: SSLSocket.do_handshake() 方法必须不断重试直至其成功返回。 下面是一个使用 select() 来等待套接字就绪的简短例子:

while True:
    try:
        sock.do_handshake()
        break
    except ssl.SSLWantReadError:
        select.select([sock], [], [])
    except ssl.SSLWantWriteError:
        select.select([], [sock], [])

参见

asyncio 模块支持 非阻塞 SSL 套接字 并提供了更高层级的 API。 它会使用 selectors 模块来轮询事件并处理 SSLWantWriteError, SSLWantReadError 和 BlockingIOError 等异常。 它还会异步地执行 SSL 握手。

内存 BIO 支持

3.5 新版功能.

自从 SSL 模块在 Python 2.6 起被引入之后，SSLSocket 类提供了两个互相关联但彼此独立的功能分块:

SSL 协议处理

网络 IO

网络 IO API 与 socket.socket 所提供的功能一致，SSLSocket 也是从那里继承而来的。 这允许 SSL 套接字被用作常规套接字的替代，使得向现有应用程序添加 SSL 支持变得非常容易。

将 SSL 协议处理与网络 IO 结合使用通常都能运行良好，但在某些情况下则不能。 此情况的一个例子是 async IO 框架，该框架要使用不同的 IO 多路复用模型而非 (基于就绪状态的) "在文件描述器上执行选择/轮询" 模型，该模型是 socket.socket 和内部 OpenSSL 套接字 IO 例程正常运行的假设前提。 这种情况在该模型效率不高的 Windows 平台上最为常见。 为此还提供了一个 SSLSocket 的简化形式，称为 SSLObject。

class ssl.SSLObject

SSLSocket 的简化形式，表示一个不包含任何网络 IO 方法的 SSL 协议实例。 这个类通常由想要通过内存缓冲区为 SSL 实现异步 IO 的框架作者来使用。

这个类在低层级 SSL 对象上实现了一个接口，与 OpenSSL 所实现的类似。 此对象会捕获 SSL 连接的状态但其本身不提供任何网络 IO。 IO 需要通过单独的 "BIO" 对象来执行，该对象是 OpenSSL 的 IO 抽象层。

这个类没有公有构造器。 SSLObject 实例必须使用 wrap_bio() 方法来创建。 此方法将创建 SSLObject 实例并将其绑定到一个 BIO 对。 其中 incoming BIO 用来将数据从 Python 传递到 SSL 协议实例，而 outgoing BIO 用来进行数据反向传递。

可以使用以下方法：

context

server_side

server_hostname

session

session_reused

read()

write()

getpeercert()

selected_alpn_protocol()

selected_npn_protocol()

cipher()

shared_ciphers()

compression()

pending()

do_handshake()

verify_client_post_handshake()

unwrap()

get_channel_binding()

version()

与 SSLSocket 相比，此对象缺少下列特性:

任何形式的网络 IO; recv() 和 send() 仅对下层的 MemoryBIO 缓冲区执行读取和写入。

不存在 do_handshake_on_connect 机制。 你必须总是手动调用 do_handshake() 来开始握手操作。

不存在对 suppress_ragged_eofs 的处理。 所有违反协议的文件结束条件将通过 SSLEOFError 异常来报告。

方法 unwrap() 的调用不返回任何东西，不会如 SSL 套接字那样返回下层的套接字。

server_name_callback 回调被传给 SSLContext.set_servername_callback() 时将获得一个 SSLObject 实例而非 SSLSocket 实例作为其第一个形参。

有关 SSLObject 用法的一些说明:

在 SSLObject 上的所有 IO 都是 非阻塞的。 这意味着例如 read() 在其需要比 incoming BIO 可用的更多数据时将会引发 SSLWantReadError。

不存在模块层级的 wrap_bio() 调用，就像 wrap_socket() 那样。 SSLObject 总是通过 SSLContext 来创建。

在 3.7 版更改: SSLObject 的实例必须使用 wrap_bio() 来创建。 在较早的版本中，直接创建实例是可能的。 但这从未被记入文档或是被正式支持。

SSLObject 会使用内存缓冲区与外部世界通信。 MemoryBIO 类提供了可被用于此目的的内存缓冲区。 它包装了一个 OpenSSL 内存 BIO (Basic IO) 对象:

class ssl.MemoryBIO

一个可被用来在 Python 和 SSL 协议实例之间传递数据的内存缓冲区。

pending

返回当前存在于内存缓冲区的字节数。

eof

一个表明内存 BIO 目前是否位于文件末尾的布尔值。

read(n=- 1)

从内存缓冲区读取至多 n 个字节。 如果 n 未指定或为负值，则返回全部字节数据。

write(buf)

将字节数据从 buf 写入到内存 BIO。 buf 参数必须为支持缓冲区协议的对象。

返回值为写入的字节数，它总是与 buf 的长度相等。

write_eof()

将一个 EOF 标记写入到内存 BIO。 在此方法被调用以后，再调用 write() 将是非法的。 属性 eof will 在缓冲区当前的所有数据都被读取之后将变为真值。

SSL 会话

3.6 新版功能.

class ssl.SSLSession

session 所使用的会话对象。

id

time

timeout

ticket_lifetime_hint

has_ticket

安全考量

最佳默认值

针对 客户端使用，如果你对于安全策略没有任何特殊要求，则强烈推荐你使用 create_default_context() 函数来创建你的 SSL 上下文。 它将加载系统的受信任 CA 证书，启用证书验证和主机名检查，并尝试合理地选择安全的协议和密码设置。

例如，以下演示了你应当如何使用 smtplib.SMTP 类来创建指向一个 SMTP 服务器的受信任且安全的连接:

>>> 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')

如果连接需要客户端证书，可使用 SSLContext.load_cert_chain() 来添加。

作为对比，如果你通过自行调用 SSLContext 构造器来创建 SSL 上下文，它默认将不会启用证书验证和主机名检查。 如果你这样做，请阅读下面的段落以达到良好的安全级别。

手动设置

验证证书

当直接调用 SSLContext 构造器时，默认会使用 CERT_NONE。 由于它不会验证对等方的身份真实性，因此是不安全的，特别是在客户端模式下，大多数时候你都希望能保证你所连接的服务器的身份真实性。 因此，当处于客户端模式时，强烈推荐使用 CERT_REQUIRED。 但是，光这样还不够；你还必须检查服务器证书，这可以通过调用 SSLSocket.getpeercert() 来获取并匹配目标服务。 对于许多协议和应用来说，服务可通过主机名来标识；在此情况下，可以使用 match_hostname() 函数。 这种通用检测会在 SSLContext.check_hostname 被启用时自动执行。

在 3.7 版更改: 主机名匹配现在是由 OpenSSL 来执行的。 Python 不会再使用 match_hostname()。

在服务器模式下，如果你想要使用 SSL 层来验证客户端（而不是使用更高层级的验证机制），你也必须要指定 CERT_REQUIRED 并以类似方式检查客户端证书。

协议版本

SSL 版本 2 和 3 被认为是不安全的因而使用它们会有风险。 如果你想要客户端和服务器之间有最大的兼容性，推荐使用 PROTOCOL_TLS_CLIENT 或 PROTOCOL_TLS_SERVER 作为协议版本。 SSLv2 和 SSLv3 默认会被禁用。

>>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> client_context.minimum_version = ssl.TLSVersion.TLSv1_3
>>> client_context.maximum_version = ssl.TLSVersion.TLSv1_3

上面创建的 SSL 上下文将只允许与服务器进行 TLSv1.3 及更高版本（如果你的系统支持）的连接。 在默认情况下 PROTOCOL_TLS_CLIENT 将使用证书验证和主机名检查。 你必须将证书加载到上下文中。

密码选择

如果你有更高级的安全要求，也可以通过 SSLContext.set_ciphers() 方法在协商 SSL 会话时对所启用的加密进行微调。 从 Python 3.2.3 开始，ssl 模块默认禁用了某些较弱的加密，但你还可能希望进一步限制加密选项。 请确保仔细阅读 OpenSSL 文档中有关 加密列表格式 [https://www.openssl.org/docs/man1.1.1/man1/ciphers.html#CIPHER-LIST-FORMAT] 的部分。 如果你想要检查给定的加密列表启用了哪些加密，可以使用 SSLContext.get_ciphers() 或所在系统的 openssl ciphers 命令。

多进程

如果使用此模块作为多进程应用的一部分（例如使用 multiprocessing 或 concurrent.futures 模块），请注意 OpenSSL 的内部随机数字生成器并不能正确处理分支进程。 应用程序必须修改父进程的 PRNG 状态，如果它们要使用任何包含 os.fork() 的 SSL 特性的话。 任何对 RAND_add(), RAND_bytes() 或 RAND_pseudo_bytes() 都可以 做到这一点。

TLS 1.3

3.7 新版功能.

TLS 1.3 协议的行为与低版本的 TLS/SSL 略有不同。某些 TLS 1.3 新特性还不可用。

TLS 1.3 使用一组不同的加密套件集。 默认情况下所有 AES-GCM 和 ChaCha20 加密套件都会被启用。 SSLContext.set_ciphers() 方法还不能启用或禁用任何 TLS 1.3 加密，但 SSLContext.get_ciphers() 会返回它们。

会话凭据不再会作为初始握手的组成部分被发送而是以不同的方式来处理。 SSLSocket.session 和 SSLSession 与 TLS 1.3 不兼容。

客户端证书在初始握手期间也不会再被验证。 服务器可以在任何时候请求证书。 客户端会在它们从服务器发送或接收应用数据时处理证书请求。

早期数据、延迟的 TLS 客户端证书请求、签名算法配置和密钥重生成等 TLS 1.3 特性尚未被支持。

参见

Class socket.socket

下层 socket 类的文档

SSL/TLS 高强度加密：概述 [https://httpd.apache.org/docs/trunk/en/ssl/ssl_intro.html]

Apache HTTP Server文档介绍

RFC 1422: 因特网电子邮件的隐私加强：第二部分：基于证书的密钥管理 [https://datatracker.ietf.org/doc/html/rfc1422.html]

Steve Kent

RFC 4086: 确保安全的随机性要求 [https://datatracker.ietf.org/doc/html/rfc4086.html]

Donald E., Jeffrey I. Schiller

RFC 5280: 互联网 X.509 公钥基础架构证书和证书吊销列表 (CRL) 配置文件 [https://datatracker.ietf.org/doc/html/rfc5280.html]

D. Cooper

RFC 5246: 传输层安全性 (TLS) 协议版本 1.2 [https://datatracker.ietf.org/doc/html/rfc5246.html]

T. Dierks et. al.

RFC 6066: 传输层安全性 (TLS) 的扩展 [https://datatracker.ietf.org/doc/html/rfc6066.html]

D. Eastlake

IANA TLS: 传输层安全性 (TLS) 的参数 [https://www.iana.org/assignments/tls-parameters/tls-parameters.xml]

IANA

RFC 7525: 传输层安全性 (TLS) 和数据报传输层安全性 (DTLS) 的安全使用建议 [https://datatracker.ietf.org/doc/html/rfc7525.html]

IETF

Mozilla 的服务器端 TLS 建议 [https://wiki.mozilla.org/Security/Server_Side_TLS]

Mozilla

select --- 等待 I/O 完成

该模块提供了对 select() 和 poll() 函数的访问，这些函数在大多数操作系统中是可用的。在 Solaris 及其衍生版本上可用 devpoll()，在 Linux 2.5+ 上可用 epoll()，在大多数 BSD 上可用 kqueue()。注意，在 Windows 上，本模块仅适用于套接字；在其他操作系统上，本模块也适用于其他文件类型（特别地，在 Unix 上也适用于管道）。本模块不能用于常规文件，不能检测出（自上次读取文件后）文件是否有新数据写入。

注解

selectors 模块是在 select 模块原型的基础上进行高级且高效的 I/O 复用。推荐用户改用 selectors 模块，除非用户希望对 OS 级的函数原型进行精确控制。

该模块定义以下内容：

exception select.error

一个被弃用的 OSError 的别名。

在 3.3 版更改: 根据 PEP 3151 [https://www.python.org/dev/peps/pep-3151]，这个类是 OSError 的别名。

select.devpoll()

（仅支持 Solaris 及其衍生版本）返回一个 /dev/poll 轮询对象，请参阅下方 /dev/poll 轮询对象 获取 devpoll 对象所支持的方法。

devpoll() 对象与实例化时允许的文件描述符数量有关，如果在程序中降低了此数值，devpoll() 调用将失败。如果程序提高了此数值，devpoll() 可能会返回一个不完整的活动文件描述符列表。

新的文件描述符是 不可继承的。

3.3 新版功能.

在 3.4 版更改: 新的文件描述符现在是不可继承的。

select.epoll(sizehint=- 1, flags=0)

（仅支持 Linux 2.5.44 或更高版本）返回一个 edge poll 对象，该对象可作为 I/O 事件的边缘触发或水平触发接口。

sizehint informs epoll about the expected number of events to be registered. It must be positive, or -1 to use the default. It is only used on older systems where epoll_create1() is not available; otherwise it has no effect (though its value is still checked).

flags 已经弃用且完全被忽略。但是，如果提供该值，则它必须是 0 或 select.EPOLL_CLOEXEC，否则会抛出 OSError 异常。

请参阅下方 边缘触发和水平触发的轮询 (epoll) 对象 获取 epoll 对象所支持的方法。

epoll 对象支持上下文管理器：当在 with 语句中使用时，新建的文件描述符会在运行至语句块结束时自动关闭。

新的文件描述符是 不可继承的。

在 3.3 版更改: 增加了 flags 参数。

在 3.4 版更改: 增加了对 with 语句的支持。新的文件描述符现在是不可继承的。

3.4 版后已移除: flags 参数。现在默认采用 select.EPOLL_CLOEXEC 标志。使用 os.set_inheritable() 来让文件描述符可继承。

select.poll()

（部分操作系统不支持）返回一个 poll 对象，该对象支持注册和注销文件描述符，支持对描述符进行轮询以获取 I/O 事件。请参阅下方 Poll 对象 获取 poll 对象所支持的方法。

select.kqueue()

（仅支持 BSD）返回一个内核队列对象，请参阅下方 Kqueue 对象 获取 kqueue 对象所支持的方法。

新的文件描述符是 不可继承的。

在 3.4 版更改: 新的文件描述符现在是不可继承的。

select.kevent(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

（仅支持 BSD）返回一个内核事件对象，请参阅下方 Kevent 对象 获取 kevent 对象所支持的方法。

select.select(rlist, wlist, xlist[, timeout])

这是一个明白直观的 Unix select() 系统调用接口。 前三个参数是由‘可等待对象’组成的序列：可以是代表文件描述符的整数，或是带有名为 fileno() 的返回这样的整数的无形参方法的对象:

rlist：等待，直到可以开始读取

wlist：等待，直到可以开始写入

xlist：等待“异常情况”（请参阅当前系统的手册，以获取哪些情况称为异常情况）

允许空的可迭代对象，但是否接受三个空的可迭代对象则取决于具体平台。 （已知在 Unix 上可行但在 Windows 上不可行。） 可选的 timeout 参数以一个浮点数表示超时秒数。 当省略 timeout 参数时该函数将阻塞直到至少有一个文件描述符准备就绪。 超时值为零表示执行轮询且永不阻塞。

返回值是三个列表，包含已就绪对象，返回的三个列表是前三个参数的子集。当超时时间已到且没有文件描述符就绪时，返回三个空列表。

可迭代对象中可接受的对象类型有 Python 文件对象 (例如 sys.stdin 以及 open() 或 os.popen() 所返回的对象)，由 socket.socket() 返回的套接字对象等。 你也可以自定义一个 wrapper 类，只要它具有适当的 fileno() 方法（该方法要确实返回一个文件描述符，而不能只是一个随机整数）。

注解

Windows 上不接受文件对象，但接受套接字。在 Windows 上，底层的 select() 函数由 WinSock 库提供，且不处理不是源自 WinSock 的文件描述符。

在 3.5 版更改: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 InterruptedError 异常。除非信号处理程序抛出异常（相关原理请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475]）。

select.PIPE_BUF

当一个管道已经被 select()、poll() 或本模块中的某个接口报告为可写入时，可以在不阻塞该管道的情况下写入的最小字节数。它不适用于套接字等其他类型的文件类对象。

POSIX 上须保证该值不小于 512。

可用性: Unix

3.2 新版功能.

/dev/poll 轮询对象

Solaris 及其衍生版本具备 /dev/poll。select() 复杂度为 O（最高文件描述符），poll() 为 O（文件描述符数量），而 /dev/poll 为 O（活动的文件描述符）。

/dev/poll 的行为与标准 poll() 对象十分类似。

devpoll.close()

关闭轮询对象的文件描述符。

3.4 新版功能.

devpoll.closed

如果轮询对象已关闭，则返回 True。

3.4 新版功能.

devpoll.fileno()

返回轮询对象的文件描述符对应的数字。

3.4 新版功能.

devpoll.register(fd[, eventmask])

在轮询对象中注册文件描述符。这样，将来调用 poll() 方法时将检查文件描述符是否有未处理的 I/O 事件。fd 可以是整数，也可以是带有 fileno() 方法的对象（该方法返回一个整数）。文件对象已经实现了 fileno()，因此它们也可以用作参数。

eventmask 是可选的位掩码，用于指定要检查的事件类型。这些常量与 poll() 对象所用的相同。本参数的默认值是常量 POLLIN、POLLPRI 和 POLLOUT 的组合。

警告

注册已注册过的文件描述符不会报错，但是结果是不确定的。正确的操作是先注销或直接修改它。与 poll() 相比，这是一个重要的区别。

devpoll.modify(fd[, eventmask])

此方法先执行 unregister() 后执行 register()。直接执行此操作效率（稍微）高一些。

devpoll.unregister(fd)

删除轮询对象正在跟踪的某个文件描述符。与 register() 方法类似，fd 可以是整数，也可以是带有 fileno() 方法的对象（该方法返回一个整数）。

尝试删除从未注册过的文件描述符将被安全地忽略。

devpoll.poll([timeout])

轮询已注册的文件描述符的集合，并返回一个列表，列表可能为空，也可能有多个 (fd, event) 2元组，其中包含了要报告事件或错误的描述符。 fd 是文件描述符，event 是一个位掩码，表示该描述符所报告的事件 --- POLLIN 表示等待输入，POLLOUT 表示该描述符可以写入，依此类推。 空列表表示调用超时，没有任何文件描述符报告事件。 如果指定了 timeout，它将指定系统等待事件时，等待多长时间后返回（以毫秒为单位）。如果 timeout 被省略、为 -1 或为 None，则本调用将阻塞，直到轮询对象发生事件为止。

在 3.5 版更改: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 InterruptedError 异常。除非信号处理程序抛出异常（相关原理请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475]）。

边缘触发和水平触发的轮询 (epoll) 对象

https://linux.die.net/man/4/epoll

eventmask

常量 | 含意
EPOLLIN | 可读
EPOLLOUT | 可写
EPOLLPRI | 紧急数据读取
EPOLLERR | 在关联的文件描述符上有错误情况发生
EPOLLHUP | 关联的文件描述符已挂起
EPOLLET | 设置触发方式为边缘触发，默认为水平触发
EPOLLONESHOT | 设置 one-shot 模式。触发一次事件后，该描述符会在轮询对象内部被禁用。
EPOLLEXCLUSIVE | 当已关联的描述符发生事件时，仅唤醒一个 epoll 对象。默认（如果未设置此标志）是唤醒所有轮询该描述符的 epoll 对象。
EPOLLRDHUP | 流套接字的对侧关闭了连接或关闭了写入到一半的连接。
EPOLLRDNORM | 等同于 EPOLLIN
EPOLLRDBAND | 可以读取优先数据带。
EPOLLWRNORM | 等同于 EPOLLOUT
EPOLLWRBAND | 可以写入优先级数据。
EPOLLMSG | 忽略

3.6 新版功能: 增加了 EPOLLEXCLUSIVE。仅支持 Linux Kernel 4.5 或更高版本。

epoll.close()

关闭用于控制 epoll 对象的文件描述符。

epoll.closed

如果 epoll 对象已关闭，则返回 True。

epoll.fileno()

返回文件描述符对应的数字，该描述符用于控制 epoll 对象。

epoll.fromfd(fd)

根据给定的文件描述符创建 epoll 对象。

epoll.register(fd[, eventmask])

在 epoll 对象中注册一个文件描述符。

epoll.modify(fd, eventmask)

修改一个已注册的文件描述符。

epoll.unregister(fd)

从 epoll 对象中删除一个已注册的文件描述符。

在 3.9 版更改: 此方法不会再忽略 EBADF 错误。

epoll.poll(timeout=None, maxevents=- 1)

等待事件发生，timeout 是浮点数，单位为秒。

在 3.5 版更改: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 InterruptedError 异常。除非信号处理程序抛出异常（相关原理请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475]）。

Poll 对象

大多数 Unix 系统支持 poll() 系统调用，为服务器提供了更好的可伸缩性，使服务器可以同时服务于大量客户端。poll() 的伸缩性更好，因为该调用内部仅列出所关注的文件描述符，而 select() 会构造一个 bitmap，在其中将所关注的描述符所对应的 bit 打开，然后重新遍历整个 bitmap。因此 select() 复杂度是 O（最高文件描述符），而 poll() 是 O（文件描述符数量）。

poll.register(fd[, eventmask])

在轮询对象中注册文件描述符。这样，将来调用 poll() 方法时将检查文件描述符是否有未处理的 I/O 事件。fd 可以是整数，也可以是带有 fileno() 方法的对象（该方法返回一个整数）。文件对象已经实现了 fileno()，因此它们也可以用作参数。

eventmask 是可选的位掩码，用于指定要检查的事件类型，它可以是常量 POLLIN、POLLPRI 和 POLLOUT 的组合，如下表所述。如果未指定本参数，默认将会检查所有 3 种类型的事件。

常量 | 含意
POLLIN | 有要读取的数据
POLLPRI | 有紧急数据需要读取
POLLOUT | 准备输出：写不会阻塞
POLLERR | 某种错误条件
POLLHUP | 挂起
POLLRDHUP | 流套接字的对侧关闭了连接，或关闭了写入到一半的连接
POLLNVAL | 无效的请求：描述符未打开

注册已注册过的文件描述符不会报错，且等同于只注册一次该描述符。

poll.modify(fd, eventmask)

修改一个已注册的文件描述符，等同于 register(fd, eventmask)。尝试修改未注册的文件描述符会抛出 OSError 异常，错误码为 ENOENT。

poll.unregister(fd)

删除轮询对象正在跟踪的某个文件描述符。与 register() 方法类似，fd 可以是整数，也可以是带有 fileno() 方法的对象（该方法返回一个整数）。

尝试删除从未注册过的文件描述符会抛出 KeyError 异常。

poll.poll([timeout])

轮询已注册的文件描述符的集合，并返回一个列表，列表可能为空，也可能有多个 (fd, event) 2元组，其中包含了要报告事件或错误的描述符。 fd 是文件描述符，event 是一个位掩码，表示该描述符所报告的事件 --- POLLIN 表示等待输入，POLLOUT 表示该描述符可以写入，依此类推。 空列表表示调用超时，没有任何文件描述符报告事件。 如果指定了 timeout，它将指定系统等待事件时，等待多长时间后返回（以毫秒为单位）。如果 timeout 被省略、为 -1 或为 None，则本调用将阻塞，直到轮询对象发生事件为止。

在 3.5 版更改: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 InterruptedError 异常。除非信号处理程序抛出异常（相关原理请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475]）。

Kqueue 对象

kqueue.close()

关闭用于控制 kqueue 对象的文件描述符。

kqueue.closed

如果 kqueue 对象已关闭，则返回 True。

kqueue.fileno()

返回文件描述符对应的数字，该描述符用于控制 epoll 对象。

kqueue.fromfd(fd)

根据给定的文件描述符创建 kqueue 对象。

kqueue.control(changelist, max_events[, timeout]) → eventlist

Kevent 的低级接口

changelist 必须是一个可迭代对象，迭代出 kevent 对象，否则置为 None。

max_events 必须是 0 或一个正整数。

timeout 单位为秒（一般为浮点数），默认为 None，即永不超时。

在 3.5 版更改: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 InterruptedError 异常。除非信号处理程序抛出异常（相关原理请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475]）。

Kevent 对象

https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2

kevent.ident

用于区分事件的标识值。其解释取决于筛选器，但该值通常是文件描述符。在构造函数中，该标识值可以是整数或带有 fileno() 方法的对象。kevent 在内部存储整数。

kevent.filter

内核筛选器的名称。

常量 | 含意
KQ_FILTER_READ | 获取描述符，并在有数据可读时返回
KQ_FILTER_WRITE | 获取描述符，并在有数据可写时返回
KQ_FILTER_AIO | AIO 请求
KQ_FILTER_VNODE | 当在 fflag 中监视的一个或多个请求事件发生时返回
KQ_FILTER_PROC | 监视进程ID上的事件
KQ_FILTER_NETDEV | 观察网络设备上的事件 [在 macOS 上不可用]
KQ_FILTER_SIGNAL | 每当监视的信号传递到进程时返回
KQ_FILTER_TIMER | 建立一个任意的计时器

kevent.flags

筛选器操作。

常量 | 含意
KQ_EV_ADD | 添加或修改事件
KQ_EV_DELETE | 从队列中删除事件
KQ_EV_ENABLE | Permitscontrol() 返回事件
KQ_EV_DISABLE | 禁用事件
KQ_EV_ONESHOT | 在第一次发生后删除事件
KQ_EV_CLEAR | 检索事件后重置状态
KQ_EV_SYSFLAGS | 内部事件
KQ_EV_FLAG1 | 内部事件
KQ_EV_EOF | 筛选特定EOF条件
KQ_EV_ERROR | 请参阅返回值

kevent.fflags

筛选特定标志。

KQ_FILTER_READ 和 KQ_FILTER_WRITE 筛选标志：

常量 | 含意
KQ_NOTE_LOWAT | 套接字缓冲区的低水线

KQ_FILTER_VNODE 筛选标志：

常量 | 含意
KQ_NOTE_DELETE | 已调用 unlink()
KQ_NOTE_WRITE | 发生写入
KQ_NOTE_EXTEND | 文件已扩展
KQ_NOTE_ATTRIB | 属性已更改
KQ_NOTE_LINK | 链接计数已更改
KQ_NOTE_RENAME | 文件已重命名
KQ_NOTE_REVOKE | 对文件的访问权限已被撤销

KQ_FILTER_PROC filter flags:

常量 | 含意
KQ_NOTE_EXIT | 进程已退出
KQ_NOTE_FORK | 该进程调用了 fork()
KQ_NOTE_EXEC | 进程已执行新进程
KQ_NOTE_PCTRLMASK | 内部筛选器标志
KQ_NOTE_PDATAMASK | 内部筛选器标志
KQ_NOTE_TRACK | 跨 fork() 执行进程
KQ_NOTE_CHILD | 在 NOTE_TRACK 的子进程上返回
KQ_NOTE_TRACKERR | 无法附加到子对象

KQ_FILTER_NETDEV 过滤器旗标 (在 macOS 上不可用):

常量 | 含意
KQ_NOTE_LINKUP | 链接已建立
KQ_NOTE_LINKDOWN | 链接已断开
KQ_NOTE_LINKINV | 链接状态无效

kevent.data

筛选特定数据。

kevent.udata

用户自定义值。

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

3.4 新版功能.

源码: Lib/selectors.py [https://github.com/python/cpython/tree/3.10/Lib/selectors.py]

概述

此模块允许高层级且高效率的 I/O 复用，它建立在 select 模块原型的基础之上。 推荐用户改用此模块，除非他们希望对所使用的 OS 层级原型进行精确控制。

它定义了一个 BaseSelector 抽象基类，以及多个实际的实现 (KqueueSelector, EpollSelector...)，它们可被用于在多个文件对象上等待 I/O 就绪通知。 在下文中，"文件对象" 是指任何具有 fileno() 方法的对象，或是一个原始文件描述符。 参见 file object。

DefaultSelector 是一个指向当前平台上可用的最高效实现的别名：这应为大多数用户的默认选择。

注解

受支持的文件对象类型取决于具体平台：在 Windows 上，支持套接字但不支持管道，而在 Unix 上两者均受支持（某些其他类型也可能受支持，例如 fifo 或特殊文件设备等）。

参见

select

低层级的 I/O 多路复用模块。

类

类的层次结构:

BaseSelector
+-- SelectSelector
+-- PollSelector
+-- EpollSelector
+-- DevpollSelector
+-- KqueueSelector

下文中，events 一个位掩码，指明哪些 I/O 事件要在给定的文件对象上执行等待。 它可以是以下模块级常量的组合:

常量 | 含意
EVENT_READ | 可读
EVENT_WRITE | 可写

class selectors.SelectorKey

SelectorKey 是一个 namedtuple，用来将文件对象关联到其下层的文件描述符、选定事件掩码和附加数据等。 它会被某些 BaseSelector 方法返回。

fileobj

已注册的文件对象。

fd

下层的文件描述符。

events

必须在此文件对象上被等待的事件。

data

可选的关联到此文件对象的不透明数据：例如，这可被用来存储各个客户端的会话 ID。

class selectors.BaseSelector

一个 BaseSelector，用来在多个文件对象上等待 I/O 事件就绪。 它支持文件流注册、注销，以及在这些流上等待 I/O 事件的方法。 它是一个抽象基类，因此不能被实例化。 请改用 DefaultSelector，或者 SelectSelector, KqueueSelector 等。 如果你想要指明使用某个实现，并且你的平台支持它的话。 BaseSelector 及其具体实现支持 context manager 协议。

abstractmethod register(fileobj, events, data=None)

注册一个用于选择的文件对象，在其上监视 I/O 事件。

fileobj 是要监视的文件对象。 它可以是整数形式的文件描述符或者具有 fileno() 方法的对象。 events 是要监视的事件的位掩码。 data 是一个不透明对象。

这将返回一个新的 SelectorKey 实例，或在出现无效事件掩码或文件描述符时引发 ValueError，或在文件对象已被注册时引发 KeyError。

abstractmethod unregister(fileobj)

注销对一个文件对象的选择，移除对它的监视。 在文件对象被关闭之前应当先将其注销。

fileobj 必须是之前已注册的文件对象。

这将返回已关联的 SelectorKey 实例，或者如果 fileobj 未注册则会引发 KeyError。 It will raise ValueError 如果 fileobj 无效（例如它没有 fileno() 方法或其 fileno() 方法返回无效值）。

modify(fileobj, events, data=None)

更改已注册文件对象所监视的事件或所附带的数据。

这等价于 BaseSelector.unregister(fileobj)() 加 BaseSelector.register(fileobj, events, data)()，区别在于它可以被更高效地实现。

这将返回一个新的 SelectorKey 实例，或在出现无效事件掩码或文件描述符时引发 ValueError，或在文件对象未被注册时引发 KeyError。

abstractmethod select(timeout=None)

等待直到有已注册的文件对象就绪，或是超过时限。

如果 timeout > 0，这指定以秒数表示的最大等待时间。 如果 timeout <= 0，调用将不会阻塞，并将报告当前就绪的文件对象。 如果 timeout 为 None，调用将阻塞直到某个被监视的文件对象就绪。

这将返回由 (key, events) 元组构成的列表，每项各表示一个就绪的文件对象。

key 是对应于就绪文件对象的 SelectorKey 实例。 events 是在此文件对象上等待的事件位掩码。

注解

如果当前进程收到一个信号，此方法可在任何文件对象就绪之前或超出时限时返回：在此情况下，将返回一个空列表。

在 3.5 版更改: 现在当被某个信号中断时，如果信号处理程序没有引发异常，选择器会用重新计算的超时值进行重试（请查看 PEP 475 [https://www.python.org/dev/peps/pep-0475] 其理由），而不是在超时之前返回空的事件列表。

close()

关闭选择器。

必须调用这个方法以确保下层资源会被释放。 选择器被关闭后将不可再使用。

get_key(fileobj)

返回关联到某个已注册文件对象的键。

此方法将返回关联到文件对象的 SelectorKey 实例，或在文件对象未注册时引发 KeyError。

abstractmethod get_map()

返回从文件对象到选择器键的映射。

这将返回一个将已注册文件对象映射到与其相关联的 SelectorKey 实例的 Mapping 实例。

class selectors.DefaultSelector

默认的选择器类，使用当前平台上可用的最高效实现。 这应为大多数用户的默认选择。

class selectors.SelectSelector

基于 select.select() 的选择器。

class selectors.PollSelector

基于 select.poll() 的选择器。

class selectors.EpollSelector

基于 select.epoll() 的选择器。

fileno()

此方法将返回由下层 select.epoll() 对象所使用的文件描述符。

class selectors.DevpollSelector

基于 select.devpoll() 的选择器。

fileno()

此方法将返回由下层 select.devpoll() 对象所使用的文件描述符。

3.5 新版功能.

class selectors.KqueueSelector

基于 select.kqueue() 的选择器。

fileno()

此方法将返回由下层 select.kqueue() 对象所使用的文件描述符。

例子

下面是一个简单的回显服务器实现:

import selectors
import socket

sel = selectors.DefaultSelector()

def accept(sock, mask):
    conn, addr = sock.accept()  # Should be ready
    print('accepted', conn, 'from', addr)
    conn.setblocking(False)
    sel.register(conn, selectors.EVENT_READ, read)

def read(conn, mask):
    data = conn.recv(1000)  # Should be ready
    if data:
        print('echoing', repr(data), 'to', conn)
        conn.send(data)  # Hope it won't block
    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)

signal --- 设置异步事件处理程序

源代码: Lib/signal.py [https://github.com/python/cpython/tree/3.10/Lib/signal.py]

该模块提供了在 Python 中使用信号处理程序的机制。

一般规则

signal.signal() 函数允许定义在接收到信号时执行的自定义处理程序。少量的默认处理程序已经设置： SIGPIPE 被忽略（因此管道和套接字上的写入错误可以报告为普通的 Python 异常）以及如果父进程没有更改 SIGINT ，则其会被翻译成 KeyboardInterrupt 异常。

一旦设置，特定信号的处理程序将保持安装，直到它被显式重置（ Python 模拟 BSD 样式接口而不管底层实现），但 SIGCHLD 的处理程序除外，它遵循底层实现。

执行 Python 信号处理程序

Python 信号处理程序不会在低级（ C ）信号处理程序中执行。相反，低级信号处理程序设置一个标志，告诉 virtual machine 稍后执行相应的 Python 信号处理程序（例如在下一个 bytecode 指令）。这会导致：

捕获同步错误是没有意义的，例如 SIGFPE 或 SIGSEGV ，它们是由 C 代码中的无效操作引起的。Python 将从信号处理程序返回到 C 代码，这可能会再次引发相同的信号，导致 Python 显然的挂起。 从Python 3.3开始，你可以使用 faulthandler 模块来报告同步错误。

纯 C 中实现的长时间运行的计算（例如在大量文本上的正则表达式匹配）可以在任意时间内不间断地运行，而不管接收到任何信号。计算完成后将调用 Python 信号处理程序。

如果处理器引发了异常，它将在主线程中“凭空”被引发。 请参阅 下面的注释 讨论相关细节。

信号与线程

Python 信号处理程序总是会在主 Python 主解释器的主线程中执行，即使信号是在另一个线程中接收的。 这意味着信号不能被用作线程间通信的手段。 你可以改用 threading 模块中的同步原语。

此外，只有主解释器的主线程才被允许设置新的信号处理程序。

模块内容

在 3.5 版更改: 信号（ SIG* ），处理程序（ SIG_DFL ， SIG_IGN）和 sigmask（ SIG_BLOCK ， SIG_UNBLOCK ， SIG_SETMASK ）下面列出的相关常量变成了 enums 。 getsignal() ， pthread_sigmask() ， sigpending() 和 sigwait() 函数返回人类可读的 enums 。

在 signal 模块中定义的变量是：

signal.SIG_DFL

这是两种标准信号处理选项之一；它只会执行信号的默认函数。 例如，在大多数系统上，对于 SIGQUIT 的默认操作是转储核心并退出，而对于 SIGCHLD 的默认操作是简单地忽略它。

signal.SIG_IGN

这是另一个标准信号处理程序，它将简单地忽略给定的信号。

signal.SIGABRT

来自 abort(3) 的中止信号。

signal.SIGALRM

来自 alarm(2) 的计时器信号。

可用性: Unix。

signal.SIGBREAK

来自键盘的中断 (CTRL + BREAK)。

可用性: Windows。

signal.SIGBUS

总线错误 (非法的内存访问)。

可用性: Unix。

signal.SIGCHLD

子进程被停止或终结。

可用性: Unix。

signal.SIGCLD

SIGCHLD 的别名。

signal.SIGCONT

如果进程当前已停止则继续执行它

可用性: Unix。

signal.SIGFPE

浮点异常。 例如除以零。

参见

当除法或求余运算的第二个参数为零时会引发 ZeroDivisionError 。

signal.SIGHUP

在控制终端上检测到挂起或控制进程的终止。

可用性: Unix。

signal.SIGILL

非法指令。

signal.SIGINT

来自键盘的中断 (CTRL + C)。

默认的动作是引发 KeyboardInterrupt。

signal.SIGKILL

终止信号。

它不能被捕获、阻塞或忽略。

可用性: Unix。

signal.SIGPIPE

损坏的管道：写入到没有读取器的管道。

默认的动作是忽略此信号。

可用性: Unix。

signal.SIGSEGV

段错误：无效的内存引用。

signal.SIGTERM

终结信号。

signal.SIGUSR1

用户自定义信号 1。

可用性: Unix。

signal.SIGUSR2

用户自定义信号 2。

可用性: Unix。

signal.SIGWINCH

窗口调整大小信号。

可用性: Unix。

SIG*

所有信号编号都是符号化定义的。 例如，挂起信号被定义为 signal.SIGHUP；变量的名称与 C 程序中使用的名称相同，具体见 <signal.h>。 'signal()' 的 Unix 手册页面列出了现有的信号 (在某些系统上这是 signal(2)，在其他系统中此列表则是在 signal(7) 中)。 请注意并非所有系统都会定义相同的信号名称集；只有系统所定义的名称才会由此模块来定义。

signal.CTRL_C_EVENT

对应于 Ctrl+C 击键事件的信号。此信号只能用于 os.kill() 。

可用性: Windows。

3.2 新版功能.

signal.CTRL_BREAK_EVENT

对应于 Ctrl+Break 击键事件的信号。此信号只能用于 os.kill() 。

可用性: Windows。

3.2 新版功能.

signal.NSIG

比最高信号数多一。

signal.ITIMER_REAL

实时递减间隔计时器，并在到期时发送 SIGALRM 。

signal.ITIMER_VIRTUAL

仅在进程执行时递减间隔计时器，并在到期时发送 SIGVTALRM 。

signal.ITIMER_PROF

当进程执行时以及当系统替进程执行时都会减小间隔计时器。 这个计时器与 ITIMER_VIRTUAL 相配结，通常被用于分析应用程序在用户和内核空间中花费的时间。 SIGPROF 会在超期时被发送。

signal.SIG_BLOCK

pthread_sigmask() 的 how 形参的一个可能的值，表明信号将会被阻塞。

3.3 新版功能.

signal.SIG_UNBLOCK

pthread_sigmask() 的 how 形参的是个可能的值，表明信号将被解除阻塞。

3.3 新版功能.

signal.SIG_SETMASK

pthread_sigmask() 的 how 形参的一个可能的值，表明信号掩码将要被替换。

3.3 新版功能.

signal 模块定义了一个异常:

exception signal.ItimerError

作为来自下层 setitimer() 或 getitimer() 实现错误的信号被引发。 如果将无效的定时器或负的时间值传给 setitimer() 就导致这个错误。 此错误是 OSError 的子类型。

3.3 新版功能: 此错误是 IOError 的子类型，现在则是 OSError 的别名。

signal 模块定义了以下函数:

signal.alarm(time)

如果 time 值非零，则此函数将要求将一个 SIGALRM 信号在 time 秒内发往进程。 任何在之前排入计划的警报都会被取消（在任何时刻都只能有一个警报被排入计划）。 后续的返回值将是任何之前设置的警报被传入之前的秒数。 如果 time 值为零，则不会将任何警报排入计划，并且任何已排入计划的警报都会被取消。 如果返回值为零，则目前没有任何警报被排入计划。

可用性: Unix。 更多信息请参见手册页面 alarm(2)。

signal.getsignal(signalnum)

返回当前用于信号 signalnum 的信号处理程序。 返回值可以是一个 Python 可调用对象，或是特殊值 signal.SIG_IGN, signal.SIG_DFL 或 None 之一。 在这里，signal.SIG_IGN 表示信号在之前被忽略，signal.SIG_DFL 表示之前在使用默认的信号处理方式，而 None 表示之前的信号处理程序未由 Python 安装。

signal.strsignal(signalnum)

返回信号 signalnum 的系统描述，例如 "Interrupt", "Segmentation fault" 等等。 如果信号无法被识别则返回 None。

3.8 新版功能.

signal.valid_signals()

返回本平台上的有效信号编号集。 这可能会少于 range(1, NSIG)，如果某些信号被系统保留作为内部使用的话。

3.8 新版功能.

signal.pause()

使进程休眠直至接收到一个信号；然后将会调用适当的处理程序。 返回空值。

可用性: Unix。 更多信息请参见手册页面 signal(2)。

另请参阅 sigwait(), sigwaitinfo(), sigtimedwait() 和 sigpending()。

signal.raise_signal(signum)

向调用方进程发送一个信号。 返回空值。

3.8 新版功能.

signal.pidfd_send_signal(pidfd, sig, siginfo=None, flags=0)

发送信号 sig 到文件描述符 pidfd 所指向的进程。 Python 目前不支持 siginfo 形参；它必须为 None。 提供 flags 参数是为了将来扩展；当前未定义旗标值。

更多信息请参阅 pidfd_send_signal(2) 手册页面。

可用性: Linux 5.1+

3.9 新版功能.

signal.pthread_kill(thread_id, signalnum)

将信号 signalnum 发送至与调用者在同一进程中另一线程 thread_id。 目标线程可被用于执行任何代码（Python或其它）。 但是，如果目标线程是在执行 Python 解释器，则 Python 信号处理程序将 由主解释器的主线程来执行。 因此，将信号发送给特定 Python 线程的唯一作用在于强制让一个正在运行的系统调用失败并抛出 InterruptedError。

使用 threading.get_ident() 或 threading.Thread 对象的 ident 属性为 thread_id 获取合适的值。

如果 signalnum 为 0，则不会发送信号，但仍然会执行错误检测；这可被用来检测目标线程是否仍在运行。

引发一个 审计事件 signal.pthread_kill 并附带参数 thread_id, signalnum。

可用性: Unix。 更多信息请参见手册页面 pthread_kill(3)。

另请参阅 os.kill()。

3.3 新版功能.

signal.pthread_sigmask(how, mask)

获取和/或修改调用方线程的信号掩码。 信号掩码是一组传送过程目前为调用者而阻塞的信号集。 返回旧的信号掩码作为一组信号。

该调用的行为取决于 how 的值，具体见下。

SIG_BLOCK: 被阻塞信号集是当前集与 mask 参数的并集。

SIG_UNBLOCK: mask 中的信号会从当前已阻塞信号集中被移除。 允许尝试取消对一个非阻塞信号的阻塞。

SIG_SETMASK: 已阻塞信号集会被设为 mask 参数的值。

mask 是一个信号编号集合 (例如 {signal.SIGINT, signal.SIGTERM})。 请使用 valid_signals() 表示包含所有信号的完全掩码。

例如，signal.pthread_sigmask(signal.SIG_BLOCK, []) 会读取调用方线程的信号掩码。

SIGKILL 和 SIGSTOP 不能被阻塞。

可用性: Unix。 更多信息请参见手册页面 sigprocmask(2) 和 pthread_sigmask(3)。

另请参阅 pause(), sigpending() 和 sigwait()。

3.3 新版功能.

signal.setitimer(which, seconds, interval=0.0)

设置由 which 指明的给定间隔计时器 (signal.ITIMER_REAL, signal.ITIMER_VIRTUAL 或 signal.ITIMER_PROF 之一) 在 seconds 秒 (接受浮点数值，为与 alarm() 之差) 之后开始并在每 interval 秒间隔时 (如果 interval 不为零) 启动。 由 which 指明的间隔计时器可通过将 seconds 设为零来清空。

当一个间隔计时器启动时，会有信号发送至进程。 所发送的具体信号取决于所使用的计时器；signal.ITIMER_REAL 将发送 SIGALRM, signal.ITIMER_VIRTUAL 将发送 SIGVTALRM, 而 signal.ITIMER_PROF 将发送 SIGPROF.

原有的值会以元组: (delay, interval) 的形式被返回。

尝试传入无效的计时器将导致 ItimerError。

可用性: Unix。

signal.getitimer(which)

返回由 which 指明的给定间隔计时器当前的值。

可用性: Unix。

signal.set_wakeup_fd(fd, *, warn_on_full_buffer=True)

将唤醒文件描述符设为 fd。 当接收到信号时，会将信号编号以单个字节的形式写入 fd。 这可被其它库用来唤醒一次 poll 或 select 调用，以允许该信号被完全地处理。

原有的唤醒 fd 会被返回（或者如果未启用文件描述符唤醒则返回 -1）。 如果 fd 为 -1，文件描述符唤醒会被禁用。 如果不为 -1，则 fd 必须为非阻塞型。 需要由库来负责在重新调用 poll 或 select 之前从 fd 移除任何字节数据。

当启用线程用时，此函数只能从 主解释器的主线程 被调用；尝试从另一线程调用它将导致 ValueError 异常被引发。

使用此函数有两种通常的方式。 在两种方式下，当有信号到达时你都是用 fd 来唤醒，但之后它们在确定达到的一个或多个信号 which 时存在差异。

在第一种方式下，我们从 fd 的缓冲区读取数据，这些字节值会给你信号编号。 这种方式很简单，但在少数情况下会发生问题：通常 fd 将有缓冲区空间大小限制，如果信号到达得太多且太快，缓冲区可能会爆满，有些信号可能丢失。 如果你使用此方式，则你应当设置 warn_on_full_buffer=True，当信号丢失时这至少能将警告消息打印到 stderr。

在第二种方式下，我们 只会 将唤醒 fd 用于唤醒，而忽略实际的字节值。 在此情况下，我们所关心的只有 fd 的缓冲区为空还是不为空；爆满的缓冲区完全不会导致问题。 如果你使用此方式，则你应当设置 warn_on_full_buffer=False，这样你的用户就不会被虚假的警告消息所迷惑。

在 3.5 版更改: 在 Windows 上，此函数现在也支持套接字处理。

在 3.7 版更改: 添加了 warn_on_full_buffer 形参。

signal.siginterrupt(signalnum, flag)

更改系统调用重启行为：如果 flag 为 False，系统调用将在被信号 signalnum 中断时重启，否则系统调用将被中断。 返回空值。

可用性: Unix。 更多信息请参见手册页面 siginterrupt(3)。

请注意用 signal() 安装信号处理程序将重启行为重置为可通过显式调用 siginterrupt() 并为给定信号的 flag 设置真值来实现中断。

signal.signal(signalnum, handler)

将信号 signalnum 的处理程序设为函数 handler。 handler 可以为接受两个参数（见下）的 Python 可调用对象，或者为特殊值 signal.SIG_IGN 或 signal.SIG_DFL 之一。 之前的信号处理程序将被返回（参见上文 getsignal() 的描述）。 （更多信息请参阅 Unix 手册页面 signal(2)。）

当启用线程用时，此函数只能从 主解释器的主线程 被调用；尝试从另一线程调用它将导致 ValueError 异常被引发。

handler 将附带两个参数调用：信号编号和当前堆栈帧 (None 或一个帧对象；有关帧对象的描述请参阅 类型层级结构描述 或者参阅 inspect 模块中的属性描述)。

在 Windows 上，signal() 调用只能附带 SIGABRT, SIGFPE, SIGILL, SIGINT, SIGSEGV, SIGTERM 或 SIGBREAK。 任何其他值都将引发 ValueError。 请注意不是所有系统都定义了同样的信号名称集合；如果一个信号名称未被定义为 SIG* 模块层级常量则将引发 AttributeError。

signal.sigpending()

检查正在等待传送给调用方线程的信号集合（即在阻塞期间被引发的信号）。 返回正在等待的信号集合。

可用性: Unix。 更多信息请参见手册页面 sigpending(2)。

另请参阅 pause(), pthread_sigmask() 和 sigwait()。

3.3 新版功能.

signal.sigwait(sigset)

挂起调用方线程的执行直到信号集合 sigset 中指定的信号之一被传送。 此函数会接受该信号（将其从等待信号列表中移除），并返回信号编号。

可用性: Unix。 更多信息请参见手册页面 sigwait(3)。

另请参阅 pause(), pthread_sigmask(), sigpending(), sigwaitinfo() 和 sigtimedwait()。

3.3 新版功能.

signal.sigwaitinfo(sigset)

挂起调用方线程的执行直到信号集合 sigset 中指定的信号之一被传送。 此函数会接受该信号并将其从等待信号列表中移除。 如果 sigset 中的信号之一已经在等待调用方线程，此函数将立即返回并附带有关该信号的信息。 被传送信号的信号处理程序不会被调用。 如果该函数被某个不在 sigset 中的信号中断则会引发 InterruptedError。

返回值是一个代表 siginfo_t 结构体所包含数据的对象，具体为: si_signo, si_code, si_errno, si_pid, si_uid, si_status, si_band。

可用性: Unix。 更多信息请参见手册页面 sigwaitinfo(2)。

另请参阅 pause(), sigwait() 和 sigtimedwait()。

3.3 新版功能.

在 3.5 版更改: 当被某个 不在 sigset 中的信号中断时本函数将进行重试并且信号处理程序不会引发异常（请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475] 了解其理由）。

signal.sigtimedwait(sigset, timeout)

类似于 sigwaitinfo()，但会接受一个额外的 timeout 参数来指定超时限制。 如果将 timeout 指定为 0，则会执行轮询。 如果发生超时则返回 None。

可用性: Unix。 更多信息请参见手册页面 sigtimedwait(2)。

另请参阅 pause(), sigwait() 和 sigwaitinfo()。

3.3 新版功能.

在 3.5 版更改: 现在当此函数被某个不在 sigset 中的信号中断时将以计算出的 timeout 进行重试并且信号处理程序不会引发异常（请参阅 PEP 475 [https://www.python.org/dev/peps/pep-0475] 了解其理由）。

示例

这是一个最小示例程序。 它使用 alarm() 函数来限制等待打开一个文件所花费的时间；这在文件为无法开启的串行设备时会很有用处，此情况通常会导致 os.open() 无限期地挂起。 解决办法是在打开文件之前设置 5 秒钟的 alarm；如果操作耗时过长，将会发送 alarm 信号，并且处理程序会引发一个异常。

import signal, os

def handler(signum, frame):
    print('Signal handler called with signal', signum)
    raise OSError("Couldn't open device!")

# Set the signal handler and a 5-second alarm
signal.signal(signal.SIGALRM, handler)
signal.alarm(5)

# This open() may hang indefinitely
fd = os.open('/dev/ttyS0', os.O_RDWR)

signal.alarm(0)          # Disable the alarm

对于 SIGPIPE 的说明

将你的程序用管道输出到工具例如 head(1) 将会导致 SIGPIPE 信号在其标准输出的接收方提前关闭时被发送到你的进程。 这将引发一个异常例如 BrokenPipeError: [Errno 32] Broken pipe。 要处理这种情况，请对你的入口点进行包装以捕获此异常，如下所示:

import os
import sys

def main():
    try:
        # simulate large output (your code replaces this loop)
        for x in range(10000):
            print("y")
        # flush output here to force SIGPIPE to be triggered
        # while inside this try block.
        sys.stdout.flush()
    except BrokenPipeError:
        # Python flushes standard streams on exit; redirect remaining output
        # to devnull to avoid another BrokenPipeError at shutdown
        devnull = os.open(os.devnull, os.O_WRONLY)
        os.dup2(devnull, sys.stdout.fileno())
        sys.exit(1)  # Python exits with error code 1 on EPIPE

if __name__ == '__main__':
    main()

请不要将 SIGPIPE 的处置方式设为 SIG_DFL 以避免 BrokenPipeError。 这样做还会在你的程序所写入的任何套接字连接中断时导致你的程序异常退出。

有关信号处理器和异常的注释

如果一个信号处理器引发了异常，该异常将被传播到主线程并可能在任何 bytecode 指令之后被引发，在执行期间的任何时候都可能出现 KeyboardInterrupt。 大多数 Python 代码，包括标准库的代码都不能对此进行健壮性处理，因此 KeyboardInterrupt (或由信号处理器所导致的任何其他异常) 可能会在极少数情况下使程序处于非预期的状态。

为了展示这个问题，请考虑以下代码:

class SpamContext:
    def __init__(self):
        self.lock = threading.Lock()

    def __enter__(self):
        # If KeyboardInterrupt occurs here, everything is fine
        self.lock.acquire()
        # If KeyboardInterrupt occurs here, __exit__ will not be called
        ...
        # KeyboardInterrupt could occur just before the function returns

    def __exit__(self, exc_type, exc_val, exc_tb):
        ...
        self.lock.release()

对于许多程序，特别是那些在遇到 KeyboardInterrupt 只需直接退出的程序来说，这不是个问题，但是高复杂度或要求高可靠性的应用程序则应当避免由于信号处理器引发异常。 他们还应当避免将捕获 KeyboardInterrupt 作为程序关闭的优雅方式。 相反地，他们应当安装自己的 SIGINT 处理器。 下面是一个避免了 KeyboardInterrupt 的 HTTP 服务器示例:

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(('', 8000), SimpleHTTPRequestHandler)
serve_forever(httpd)
print("Shutdown...")

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

内存映射文件对象的行为既像 bytearray 又像 文件对象。 你可以在大部分接受 bytearray 的地方使用 mmap 对象；例如，你可以使用 re 模块来搜索一个内存映射文件。 你也可以通过执行 obj[index] = 97 来修改单个字节，或者通过对切片赋值来修改一个子序列: obj[i1:i2] = b'...'。 你还可以在文件的当前位置开始读取和写入数据，并使用 seek() 前往另一个位置。

内存映射文件是由 mmap 构造函数创建的，其在 Unix 和 Windows 上是不同的。 无论哪种情况，你都必须为一个打开的文件提供文件描述符以进行更新。 如果你希望映射一个已有的 Python 文件对象，请使用该对象的 fileno() 方法来获取 fileno 参数的正确值。 否则，你可以使用 os.open() 函数来打开这个文件，这会直接返回一个文件描述符（结束时仍然需要关闭该文件）。

注解

如果要为可写的缓冲文件创建内存映射，则应当首先 flush() 该文件。 这确保了对缓冲区的本地修改在内存映射中可用。

对于 Unix 和 Windows 版本的构造函数，可以将 access 指定为可选的关键字参数。 access 接受以下四个值之一： ACCESS_READ ， ACCESS_WRITE 或 ACCESS_COPY 分别指定只读，直写或写时复制内存，或 ACCESS_DEFAULT 推迟到 prot 。 access 可以在 Unix 和 Windows 上使用。如果未指定 access ，则 Windows mmap 返回直写映射。这三种访问类型的初始内存值均取自指定的文件。向 ACCESS_READ 内存映射赋值会引发 TypeError 异常。 向 ACCESS_WRITE 内存映射赋值会影响内存和底层的文件。 向 ACCESS_COPY 内存映射赋值会影响内存，但不会更新底层的文件。

在 3.7 版更改: 添加了 ACCESS_DEFAULT 常量。

要映射匿名内存，应将 -1 作为 fileno 和 length 一起传递。

class mmap.mmap(fileno, length, tagname=None, access=ACCESS_DEFAULT[, offset])

（ Windows 版本） 映射被文件句柄 fileno 指定的文件的 length 个字节，并创建一个 mmap 对象。如果 length 大于当前文件大小，则文件将扩展为包含 length 个字节。如果 length 为 0，则映射的最大长度为当前文件大小。如果文件为空， Windows 会引发异常（你无法在Windows上创建空映射）。

如果 tagname 被指定且不是 None ，则是为映射提供标签名称的字符串。 Windows 允许你对同一文件拥有许多不同的映射。如果指定现有标签的名称，则会打开该标签，否则将创建该名称的新标签。如果省略此参数或设置为 None ，则创建的映射不带名称。避免使用 tag 参数将有助于使代码在Unix和Windows之间可移植。

offset 可以被指定为非负整数偏移量。 mmap 引用将相对于从文件开头的偏移。 offset 默认为0。 offeset 必须是 ALLOCATIONGRANULARITY 的倍数。

引发一个 审计事件 mmap.__new__ 并附带参数 fileno, length, access, offset。

class mmap.mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])

(Unix 版本) 映射文件描述符 fileno 指定的文件的 length 个字节，并返回一个 mmap 对象。如果 length 为 0 ，则当调用 mmap 时，映射的最大长度将为文件的当前大小。

flags 指明映射的性质。 MAP_PRIVATE 会创建私有的写入时拷贝映射，因此对 mmap 对象内容的修改将为该进程所私有。 而 MAP_SHARED 会创建与其他映射同一文件区域的进程所共享的映射。 默认值为 MAP_SHARED。 某些系统还具有额外的可用旗标，完整列表会在 MAP_* 常量 中指明。

如果指明了 prot，它将给出所需的内存保护方式；最有用的两个值是 PROT_READ 和 PROT_WRITE，分别指明页面为可读或可写。 prot 默认为 PROT_READ | PROT_WRITE。

可以指定 access 作为替代 flags 和 prot 的可选关键字形参。 同时指定 flags, prot 和 access 将导致错误。 请参阅上文中 access 的描述了解有关如何使用此形参的信息。

offset 可以被指定为非负整数偏移量。 mmap 引用将相对于从文件开头的偏移。 offset 默认为 0。 offset 必须是 ALLOCATIONGRANULARITY 的倍数，它在 Unix 系统上等价于 PAGESIZE。

为了确保已创建内存映射的有效性，描述符 fileno 所指定的文件在 macOS 上会与物理后备存储进行内部自动同步。

这个例子演示了使用 mmap 的简单方式:

import mmap

# write a simple example file
with open("hello.txt", "wb") as f:
    f.write(b"Hello Python!\n")

with open("hello.txt", "r+b") as f:
    # memory-map the file, size 0 means whole file
    mm = mmap.mmap(f.fileno(), 0)
    # read content via standard file methods
    print(mm.readline())  # prints b"Hello Python!\n"
    # read content via slice notation
    print(mm[:5])  # prints b"Hello"
    # update content using slice notation;
    # note that new content must have same size
    mm[6:] = b" world!\n"
    # ... and read again using standard file methods
    mm.seek(0)
    print(mm.readline())  # prints b"Hello  world!\n"
    # close the map
    mm.close()

mmap 也可以在 with 语句中被用作上下文管理器:

import mmap

with mmap.mmap(-1, 13) as mm:
    mm.write(b"Hello world!")

3.2 新版功能: 上下文管理器支持。

下面的例子演示了如何创建一个匿名映射并在父进程和子进程之间交换数据。:

import mmap
import os

mm = mmap.mmap(-1, 13)
mm.write(b"Hello world!")

pid = os.fork()

if pid == 0:  # In a child process
    mm.seek(0)
    print(mm.readline())

    mm.close()

引发一个 审计事件 mmap.__new__ 并附带参数 fileno, length, access, offset。

映射内存的文件对象支持以下方法:

close()

关闭 mmap。 后续调用该对象的其他方法将导致引发 ValueError 异常。 此方法将不会关闭打开的文件。

closed

如果文件已关闭则返回 True。

3.2 新版功能.

find(sub[, start[, end]])

返回子序列 sub 在对象内被找到的最小索引号，使得 sub 被包含在 [start, end] 范围中。 可选参数 start 和 end 会被解读为切片表示法。 如果未找到则返回 -1。

在 3.5 版更改: 现在接受可写的 字节类对象。

flush([offset[, size]])

将对文件的内存副本的修改刷新至磁盘。 如果不使用此调用则无法保证在对象被销毁前将修改写回存储。 如果指定了 offset 和 size，则只将对指定范围内字节的修改刷新至磁盘；在其他情况下，映射的全部范围都会被刷新。 offset 必须为 PAGESIZE 或 ALLOCATIONGRANULARITY 的倍数。

返回 None 以表示成功。 当调用失败时将引发异常。

在 3.8 版更改: 在之前版本中，成功时将返回非零值；在 Windows 下当发生错误时将返回零。 在 Unix 下 成功时将返回零值；当发生错误时将引发异常。

madvise(option[, start[, length]])

将有关内存区域的建议 option 发送至内核，从 start 开始扩展 length 个字节。 option 必须为系统中可用的 MADV_* 常量 之一。 如果省略 start 和 length，则会包含整个映射。 在某些系统中（包括 Linux），start 必须为 PAGESIZE 的倍数。

可用性: 具有 madvise() 系统调用的系统。

3.8 新版功能.

move(dest, src, count)

将从偏移量 src 开始的 count 个字节拷贝到目标索引号 dest。 如果 mmap 创建时设置了 ACCESS_READ，则调用 move 将引发 TypeError 异常。

read([n])

返回一个 bytes，其中包含从当前文件位置开始的至多 n 个字节。 如果参数省略，为 None 或负数，则返回从当前文件位置开始直至映射结尾的所有字节。 文件位置会被更新为返回字节数据之后的位置。

在 3.3 版更改: 参数可被省略或为 None。

read_byte()

将当前文件位置上的一个字节以整数形式返回，并让文件位置前进 1。

readline()

返回一个单独的行，从当前文件位置开始直到下一个换行符。 文件位置会被更新为返回字节数据之后的位置。

resize(newsize)

改变映射以及下层文件的大小，如果存在的话。 如果 mmap 创建时设置了 ACCESS_READ 或 ACCESS_COPY，则改变映射大小将引发 TypeError 异常。

rfind(sub[, start[, end]])

返回子序列 sub 在对象内被找到的最大索引号，使得 sub 被包含在 [start, end] 范围中。 可选参数 start 和 end 会被解读为切片表示法。 如果未找到则返回 -1。

在 3.5 版更改: 现在接受可写的 字节类对象。

seek(pos[, whence])

设置文件的当前位置。 whence 参数为可选项并且默认为 os.SEEK_SET 或 0 (绝对文件定位)；其他值还有 os.SEEK_CUR 或 1 (相对当前位置查找) 和 os.SEEK_END 或 2 (相对文件末尾查找)。

size()

返回文件的长度，该数值可以大于内存映射区域的大小。

tell()

返回文件指针的当前位置。

write(bytes)

将 bytes 中的字节数据写入文件指针当前位置的内存并返回写入的字节总数 (一定不小于 len(bytes)，因为如果写入失败，将会引发 ValueError)。 在字节数据被写入后文件位置将会更新。 如果 mmap 创建时设置了 ACCESS_READ，则向其写入将引发 TypeError 异常。

在 3.5 版更改: 现在接受可写的 字节类对象。

在 3.6 版更改: 现在会返回写入的字节总数。

write_byte(byte)

将整数值 byte 写入文件指针当前位置的内存；文件位置前进 1。 如果 mmap 创建时设置了 ACCESS_READ，则向其写入将引发 TypeError 异常。

MADV_* 常量

mmap.MADV_NORMAL

mmap.MADV_RANDOM

mmap.MADV_SEQUENTIAL

mmap.MADV_WILLNEED

mmap.MADV_DONTNEED

mmap.MADV_REMOVE

mmap.MADV_DONTFORK

mmap.MADV_DOFORK

mmap.MADV_HWPOISON

mmap.MADV_MERGEABLE

mmap.MADV_UNMERGEABLE

mmap.MADV_SOFT_OFFLINE

mmap.MADV_HUGEPAGE

mmap.MADV_NOHUGEPAGE

mmap.MADV_DONTDUMP

mmap.MADV_DODUMP

mmap.MADV_FREE

mmap.MADV_NOSYNC

mmap.MADV_AUTOSYNC

mmap.MADV_NOCORE

mmap.MADV_CORE

mmap.MADV_PROTECT

mmap.MADV_FREE_REUSABLE

mmap.MADV_FREE_REUSE

这些选项可被传给 mmap.madvise()。 不是每个选项都存在于每个系统中。

可用性: 具有 madvise() 系统调用的系统。

3.8 新版功能.

MAP_* 常量

mmap.MAP_SHARED

mmap.MAP_PRIVATE

mmap.MAP_DENYWRITE

mmap.MAP_EXECUTABLE

mmap.MAP_ANON

mmap.MAP_ANONYMOUS

mmap.MAP_POPULATE

这些是可被传给 mmap.mmap() 的各种旗标。 请注意某些选项在某些系统上可能不存在。

在 3.10 版更改: 增加了 MAP_POPULATE 常量。

互联网数据处理

本章介绍了一些支持处理因特网上常用数据格式的模块。

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

email.message: 表示一封电子邮件信息

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

FeedParser API

Parser API

附加说明

email.generator: 生成 MIME 文档

email.policy: Policy 对象

email.errors: 异常和缺陷类

email.headerregistry: 自定义标头对象

email.contentmanager: 管理 MIME 内容

内容管理器实例

email: 示例

email.message.Message: 使用 compat32 API 来表示电子邮件消息

email.mime: 从头创建电子邮件和 MIME 对象

email.header: 国际化标头

email.charset: 表示字符集

email.encoders: 编码器

email.utils: 其他工具

email.iterators: 迭代器

json --- JSON 编码和解码器

基本使用

编码器和解码器

异常

标准符合性和互操作性

字符编码

Infinite 和 NaN 数值

对象中的重复名称

顶级非对象，非数组值

实现限制

命令行界面

命令行选项

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

Mailbox 对象

Maildir

mbox

MH

Babyl

MMDF

Message 对象

MaildirMessage

mboxMessage

MHMessage

BabylMessage

MMDFMessage

异常

例子

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

MimeTypes 对象

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

安全考量

binhex --- 对binhex4文件进行编码和解码

备注

binascii --- 二进制和 ASCII 码互转

quopri --- 编码与解码经过 MIME 转码的可打印数据

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

源代码: Lib/email/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/email/__init__.py]

email 包是一个用于管理电子邮件消息的库。 它 并非 被设计为执行向 SMTP (RFC 2821 [https://datatracker.ietf.org/doc/html/rfc2821.html]), NNTP 或其他服务器发送电子邮件消息的操作；这些是 smtplib 和 nntplib 等模块的功能。 email 包试图尽可能地遵循 RFC，支持 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 和 RFC 6532 [https://datatracker.ietf.org/doc/html/rfc6532.html]，以及与 MIME 相关的各个 RFC 例如 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html], RFC 2046 [https://datatracker.ietf.org/doc/html/rfc2046.html], RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html], RFC 2183 [https://datatracker.ietf.org/doc/html/rfc2183.html] 和 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html]。

email 包的总体结构可以分为三个主要组件，另外还有第四个组件用于控制其他组件的行为。

这个包的中心组件是代表电子邮件消息的“对象模型”。 应用程序主要通过在 message 子模块中定义的对象模型接口与这个包进行交互。 应用程序可以使用此 API 来询问有关现有电子邮件的问题、构造新的电子邮件，或者添加或移除自身也使用相同对象模型接口的电子邮件子组件。 也就是说，遵循电子邮件消息及其 MIME 子组件的性质，电子邮件对象模型是所有提供 EmailMessage API 的对象所构成的树状结构。

这个包的另外两个主要组件是 parser 和 generator。 parser 接受电子邮件消息的序列化版本（字节流）并将其转换为 EmailMessage 对象树。 generator 接受 EmailMessage 并将其转回序列化的字节流。 (parser 和 generator 还能处理文本字符流，但不建议这种用法，因为这很容易导致某种形式的无效消息。

控制组件是 policy 模块。 每一个 EmailMessage、每一个 generator 和每一个 parser 都有一个相关联的 policy 对象来控制其行为。 通常应用程序只有在 EmailMessage 被创建时才需要指明控制策略，或者通过直接实例代 EmailMessage 来新建电子邮件，或者通过使用 parser 来解析输入流。 但是策略也可以在使用 generator 序列化消息时被更改。 例如，这允许从磁盘解析通用电子邮件消息，而在将消息发送到电子邮件服务器时使用标准 SMTP 设置对其进行序列化。

email 包会尽量地对应用程序隐藏各种控制类 RFC 的细节。 从概念上讲应用程序应当能够将电子邮件消息视为 Unicode 文本和二进制附件的结构化树，而不必担心在序列化时要如何表示它们。 但在实际中，经常有必要至少了解一部分控制类 MIME 消息及其结构的规划，特别是 MIME "内容类型" 的名称和性质以及它们是如何标识多部分文档的。 在大多数情况下这些知识应当仅对于更复杂的应用程序来说才是必需的，并且即便在那时它也应当仅是特定的高层级结构，而不是如何表示这些结构的细节信息。 由于 MIME 内容类型被广泛应用于现代因特网软件（而非只是电子邮件），因此这对许多程序员来说将是很熟悉的概念。

以下小节描述了 email 包的具体功能。 我们会从 message 对象模型开始，它是应用程序将要使用的主要接口，之后是 parser 和 generator 组件。 然后我们会介绍 policy 控制组件，它将完成对这个库的主要组件的处理。

接下来的三个小节会介绍这个包可能引发的异常以及 parser 可能检测到的缺陷（即与 RFC 不相符）。 然后我们会介绍 headerregistry 和 contentmanager 子组件，它们分别提供了用于更精细地操纵标题和载荷的工具。 这两个组件除了包含使用与生成非简单消息的相关特性，还记录了它们的可扩展性 API，这将是高级应用程序所感兴趣的内容。

在此之后是一组使用之前小节所介绍的 API 的基本部分的示例。

前面的内容是 email 包的现代（对 Unicode 支持良好）API。 从 Message 类开始的其余小节则介绍了旧式 compat32 API，它会更直接地处理如何表示电子邮件消息的细节。 compat32 API 不会 向应用程序隐藏 RFC 的相关细节，但对于需要进行此种层级操作的应用程序来说将是很有用的工具。 此文档对于因向下兼容理由而仍然使用 compat32 API 的应用程序也是很适合的。

在 3.6 版更改: 文档经过重新组织和撰写以鼓励使用新的 EmailMessage/EmailPolicy API。

email 包文档的内容:

email.message: 表示一封电子邮件信息

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

FeedParser API

Parser API

附加说明

email.generator: 生成 MIME 文档

email.policy: Policy 对象

email.errors: 异常和缺陷类

email.headerregistry: 自定义标头对象

email.contentmanager: 管理 MIME 内容

内容管理器实例

email: 示例

旧式 API:

email.message.Message: 使用 compat32 API 来表示电子邮件消息

email.mime: 从头创建电子邮件和 MIME 对象

email.header: 国际化标头

email.charset: 表示字符集

email.encoders: 编码器

email.utils: 其他工具

email.iterators: 迭代器

参见

smtplib 模块

SMTP (简单邮件传输协议) 客户端

poplib 模块

POP (邮局协议) 客户端

imaplib 模块

IMAP (互联网消息访问协议) 客户端

nntplib 模块

NNTP (网络新闻传输协议) 客户端

mailbox 模块

创建、读取和管理使用保存在磁盘中的多种标准格式的消息集的工具。

smtpd 模块

SMTP 服务器框架 (主要适用于测试)

email.message: 表示一封电子邮件信息

源代码: Lib/email/message.py [https://github.com/python/cpython/tree/3.10/Lib/email/message.py]

3.6 新版功能: 1

位于 email 包的中心的类就是 EmailMessage 类。这个类导入自 email.message 模块。它是 email 对象模型的基类。EmailMessage 为设置和查询头字段内容、访问信息体的内容、以及创建和修改结构化信息提供了核心功能。

一份电子邮件信息由 标头 和 载荷 （又被称为 内容 ）组成。 标头遵循 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 或者 RFC 6532 [https://datatracker.ietf.org/doc/html/rfc6532.html] 风格的字段名和值，字段名和字段值之间由一个冒号隔开。 这个冒号既不属于字段名，也不属于字段值。信息的载荷可能是一段简单的文字消息，也可能是一个二进制的对象，更可能是由多个拥有各自标头和载荷的子信息组成的结构化子信息序列。 对于后者类型的载荷，信息的 MIME 类型将会被指明为诸如 multipart/* 或 message/rfc822 的类型。

EmailMessage 对象所提供的抽象概念模型是一个头字段组成的有序字典加一个代表 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 标准的信息体的 载荷 。 载荷有可能是一系列子 EmailMessage 对象的列表。你除了可以通过一般的字典方法来访问头字段名和值，还可以使用特制方法来访问头的特定字段（比如说 MIME 内容类型字段）、操纵载荷、生成信息的序列化版本、递归遍历对象树。

EmailMessage 的类字典接口的字典索引是头字段名，头字段名必须是ASCII值。字典值是带有一些附加方法的字符串。虽然头字段的存储和获取都是保留其原始大小写的，但是字段名的匹配是大小写不敏感的。与真正的字典不同，键与键之间不但存在顺序关系，还可以重复。我们提供了额外的方法来处理含有重复键的头。

载荷 是多样的。对于简单的信息对象，它是字符串或字节对象；对于诸如 multipart/* 和 message/rfc822 信息对象的 MIME 容器文档，它是一个 EmailMessage 对象列表。

class email.message.EmailMessage(policy=default)

如果指定了 policy ，消息将由这个 policy 所指定的规则来更新和序列化信息的表达。如果没有指定 policy ，其将默认使用 default 策略。这个策略遵循电子邮件的RFC标准，除了行终止符号（RFC要求使用 \r\n ，此策略使用Python标准的 \n 行终止符）。请前往 policy 的文档获取更多信息。

as_string(unixfrom=False, maxheaderlen=None, policy=None)

以一段字符串的形式返回整个消息对象。 若可选的 unixform 参数为真，返回的字符串会包含信封头。 unixform 的默认值是 False。 为了保持与基类 Message 的兼容性，maxheaderlen 是被接受的，但是其默认值是 None。 这个默认值表示行长度由策略的 max_line_length 属性所控制。从信息实例所获取到的策略可以通过 policy 参数重写。 这样可以对该方法所产生的输出进行略微的控制，因为指定的 policy 会被传递到 Generator 当中。

扁平化信息可能会对 EmailMessage 做出修改。这是因为为了完成向字符串的转换，一些内容需要使用默认值填入（举个例子，MIME 边界字段可能会被生成或被修改）。

请注意，这个方法是为了便利而提供，不一定是适合你的应用程序的最理想的序列化信息的方法。这在你处理多封信息的时候尤甚。如果你需要使用更加灵活的API来序列化信息，请参见 email.generator.Generator 。同时请注意，当 utf8 属性为其默认值 False 的时候，本方法将限制其行为为生成以“7 bit clean”方式序列化的信息。

在 3.6 版更改: maxheaderlen 没有被指定时的默认行为从默认为0修改为默认为策略的 max_line_length 值。

__str__()

与 as_string(policy=self.policy.clone(utf8=True)) 等价。这将让 str(msg) 产生的字符串包含人类可读的的序列化信息内容。

在 3.4 版更改: 本方法开始使用 utf8=True ，而非 as_string() 的直接替身。使用 utf8=True 会产生类似于 RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html] 的信息表达。

as_bytes(unixfrom=False, policy=None)

以字节串对象的形式返回整个扁平化后的消息。 当可选的 unixfrom 为真值时，返回的字符串会包含信封标头。 unixfrom 的默认值为 False。 policy 参数可被用于覆盖从消息实例获取的默认 policy。 这可被用来控制该方法所产生的部分格式效果，因为指定的 policy 将被传递给 BytesGenerator。

扁平化信息可能会对 EmailMessage 做出修改。这是因为为了完成向字符串的转换，一些内容需要使用默认值填入（举个例子，MIME 边界字段可能会被生成或被修改）。

请注意，这个方法是为了便利而提供，不一定是适合你的应用程序的最理想的序列化信息的方法。这在你处理多封信息的时候尤甚。如果你需要使用更加灵活的API来序列化信息，请参见 email.generator.BytesGenerator 。

__bytes__()

与 as_bytes() 等价。这将让 bytes(msg) 产生一个包含序列化信息内容的字节序列对象。

is_multipart()

如果该信息的载荷是一个子 EmailMessage 对象列表，返回 True ；否则返回 False 。在 is_multipart() 返回 True 的场合下，载荷应当是一个字符串对象（有可能是一个使用了内容传输编码进行编码的二进制载荷）。请注意， is_multipart() 返回 True 不意味着 msg.get_content_maintype() == 'multipart' 也会返回 True 。举个例子， is_multipart 在 EmailMessage 是 message/rfc822 类型的信息的情况下，其返回值也是 True 。

set_unixfrom(unixfrom)

将信息的信封头设置为 unixform ，这应当是一个字符串。（在 mboxMessage 中有关于这个头的一段简短介绍。）

get_unixfrom()

返回消息的信封头。如果信封头从未被设置过，默认返回 None 。

以下方法实现了对信息的头字段进行访问的类映射接口。请留意，只是类映射接口，这与平常的映射接口（比如说字典映射）有一些语义上的不同。举个例子，在一个字典当中，键之间不可重复，但是信息头字段是可以重复的。不光如此，在字典当中调用 keys() 方法返回的结果，其顺序没有保证；但是在一个 EmailMessage 对象当中，返回的头字段永远以其在原信息当中出现的顺序，或以其加入信息的顺序为序。任何删了后又重新加回去的头字段总是添加在当时列表的末尾。

这些语义上的不同是刻意而为之的，是出于在绝大多数常见使用情景中都方便的初衷下设计的。

请注意在任何情况下，消息当中的任何封包标头都不会包含在映射接口当中。

__len__()

返回标头的总数，包括重复项。

__contains__(name)

如果消息对象中有一个名为 name 的字段，其返回值为 True 。匹配无视大小写差异， name 也不包含末尾的的冒号。 in 操作符的实现中用到了这个方法，比如说：

if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])

__getitem__(name)

返回头字段名对应的字段值。 name 不含冒号分隔符。如果字段未找到，返回 None 。 KeyError 异常永不抛出。

请注意，如果对应名字的字段找到了多个，具体返回哪个字段值是未定义的。请使用 get_all() 方法获取当前匹配字段名的所有字段值。

使用标准策略（非 compat32）时，返回值是 email.headerregistry.BaseHeader 的某个子类的一个实例。

__setitem__(name, val)

在信息头中添加名为 name 值为 val 的字段。这个字段会被添加在已有字段列表的结尾处。

请注意，这个方法 既不会 覆盖 也不会 删除任何字段名重名的已有字段。如果你确实想保证新字段是整个信息头当中唯一拥有 name 字段名的字段，你需要先把旧字段删除。例如：

del msg['subject']
msg['subject'] = 'Python roolz!'

如果 policy 明确要求某些字段是唯一的（至少标准策略就有这么做），对这些字段在已有同名字段的情况下仍然调用此方法尝试为字段名赋值会引发 ValueError 异常。这是为了一致性而刻意设计出的行为，不过我们随时可能会突然觉得“还是在这种情况下自动把旧字段删除比较好吧”而把这个行为改掉，所以不要以为这是特性而依赖这个行为。

__delitem__(name)

删除信息头当中字段名匹配 name 的所有字段。如果匹配指定名称的字段没有找到，也不会抛出任何异常。

keys()

以列表形式返回消息头中所有的字段名。

values()

以列表形式返回消息头中所有的字段值。

items()

以二元元组的列表形式返回消息头中所有的字段名和字段值。

get(name, failobj=None)

返回对应字段名的字段值。这个方法与 __getitem__() 是一样的，只不过如果对应字段名的字段没有找到，该方法会返回 failobj 。这个参数是可选的（默认值为 None ）。

以下是一些与头有关的更多有用方法：

get_all(name, failobj=None)

返回字段名为 name 的所有字段值的列表。如果信息内不存在匹配的字段，返回 failobj （其默认值为 None ）。

add_header(_name, _value, **_params)

高级头字段设定。这个方法与 __setitem__() 类似，不过你可以使用关键字参数为字段提供附加参数。 _name 是字段名， _value 是字段 主 值。

对于关键字参数字典 _params 的每个键值对而言，它的键被用作参数的名字，其中下划线被替换为短横杠（毕竟短横杠不是合法的Python标识符）。一般来讲，参数以 键="值" 的方式添加，除非值是 None 。要真的是这样的话，只有键会被添加。

如果值含有非 ASCII 字符，你可以将值写成 (CHARSET, LANGUAGE, VALUE) 形式的三元组，这样你可以人为控制字符的字符集和语言。 CHARSET 是一个字符串，它为你的值的编码命名； LANGUAGE 一般可以直接设为 None ，也可以直接设为空字符串（其他可能取值参见 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] ）； VALUE 是一个字符串值，其包含非ASCII的码点。如果你没有使用三元组，你的字符串又含有非 ASCII 字符，那么它就会使用 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 中， CHARSET 为 utf-8 ， LANGUAGE 为 None 的格式编码。

例如：

msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')

会添加一个形如下文的头字段：

Content-Disposition: attachment; filename="bud.gif"

带有非ASCII字符的拓展接口：

msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '', 'Fußballer.ppt'))

replace_header(_name, _value)

替换头字段。只会替换掉信息内找到的第一个字段名匹配 _name 的字段值。字段的顺序不变，原字段名的大小写也不变。如果没有找到匹配的字段，抛出 KeyError 异常。

get_content_type()

返回信息的内容类型，其形如 maintype/subtype ，强制全小写。如果信息的 Content-Type 头字段不存在则返回 get_default_type() 的返回值；如果信息的 Content-Type 头字段无效则返回 text/plain 。

（根据 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 所述，信息永远都有一个默认类型，所以 get_content_type() 一定会返回一个值。 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 定义信息的默认类型为 text/plain 或 message/rfc822 ，其中后者仅出现在消息头位于一个 multipart/digest 容器中的场合中。如果消息头的 Content-Type 字段所指定的类型是无效的， RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 令其默认类型为 text/plain 。）

get_content_maintype()

返回信息的主要内容类型。准确来说，此方法返回的是 get_content_type() 方法所返回的形如 maintype/subtype 的字符串当中的 maintype 部分。

get_content_subtype()

返回信息的子内容类型。准确来说，此方法返回的是 get_content_type() 方法所返回的形如 maintype/subtype 的字符串当中的 subtype 部分。

get_default_type()

返回默认的内容类型。绝大多数的信息，其默认内容类型都是 text/plain 。作为 multipart/digest 容器内子部分的信息除外，它们的默认内容类型是 message/rfc822 。

set_default_type(ctype)

设置默认的内容类型。 尽管并非强制，但是 ctype 仍应当是 text/plain 或 message/rfc822 二者取一。默认内容类型并不存储在 Content-Type 头字段当中，所以设置此项的唯一作用就是决定当 Content-Type 头字段在信息中不存在时，get_content_type 方法的返回值。

set_param(param, value, header='Content-Type', requote=True, charset=None, language='', replace=False)

在 Content-Type 头字段当中设置一个参数。如果该参数已于字段中存在，将其旧值替换为 value 。如果 header 是 Content-Type （默认值），并且该头字段于信息中尚未存在，则会先添加该字段，将其值设置为 text/plain ，并附加参数值。可选的 header 可以让你指定 Content-Type 之外的另一个头字段。

如果值包含非ASCII字符，其字符集和语言可以通过可选参数 charset 和 language 显式指定。可选参数 language 指定 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 当中的语言，其默认值是空字符串。 charset 和 language 都应当字符串。默认使用的是 utf8 charset ，language 为 None 。

如果 replace 为 False （默认值），该头字段会被移动到所有头字段列表的末尾。如果 replace 为 True ，字段会被原地更新。

于 EmailMessage 对象而言， requote 参数已被弃用。

请注意，头字段已有的参数值可以通过头字段的 params 属性来访问（举例： msg['Content-Type'].params['charset'] ）。

在 3.4 版更改: 添加了 replace 关键字。

del_param(param, header='content-type', requote=True)

从 Content-Type 头字段中完全移去给定的参数。头字段会被原地重写，重写后的字段不含参数和值。可选的 header 可以让你指定 Content-Type 之外的另一个字段。

于 EmailMessage 对象而言， requote 参数已被弃用。

get_filename(failobj=None)

返回信息头当中 Content-Disposition 字段当中名为 filename 的参数值。如果该字段当中没有此参数，该方法会退而寻找 Content-Type 字段当中的 name 参数值。如果这个也没有找到，或者这些个字段压根就不存在，返回 failobj 。返回的字符串永远按照 email.utils.unquote() 方法去除引号。

get_boundary(failobj=None)

返回信息头当中 Content-Type 字段当中名为 boundary 的参数值。如果字段当中没有此参数，或者这些个字段压根就不存在，返回 failobj 。返回的字符串永远按照 email.utils.unquote() 方法去除引号。

set_boundary(boundary)

将 Content-Type 头字段的 boundary 参数设置为 boundary 。 set_boundary() 方法永远都会在必要的时候为 boundary 添加引号。如果信息对象中没有 Content-Type 头字段，抛出 HeaderParseError 异常。

请注意使用这个方法与直接删除旧的 Content-Type 头字段然后使用 add_header() 方法添加一个带有新边界值参数的 Content-Type 头字段有细微差距。 set_boundary() 方法会保留 Content-Type 头字段在原信息头当中的位置。

get_content_charset(failobj=None)

返回 Content-Type 头字段中的 charset 参数，强制小写。如果字段当中没有此参数，或者这个字段压根不存在，返回 failobj 。

get_charsets(failobj=None)

返回一个包含了信息内所有字符集名字的列表。 如果信息是 multipart 类型的，那么列表当中的每一项都对应其载荷的子部分的字符集名字。 否则，该列表是一个长度为 1 的列表。

列表当中的每一项都是一个字符串，其值为对应子部分的 Content-Type 头字段的 charset 参数值。如果该子部分没有此头字段，或者没有此参数，或者其主要 MIME 类型并非 text ，那么列表中的那一项即为 failobj 。

is_attachment()

如果信息头当中存在一个名为 Content-Disposition 的字段，且该字段的值为 attachment （大小写无关），返回 True 。否则，返回 False 。

在 3.4.2 版更改: 为了与 is_multipart() 方法一致，is_attachment 现在是一个方法，不再是属性了。

get_content_disposition()

如果信息的 Content-Disposition 头字段存在，返回其字段值；否则返回 None 。返回的值均为小写，不包含参数。如果信息遵循 RFC 2183 [https://datatracker.ietf.org/doc/html/rfc2183.html] 标准，则此方法的返回值只可能在 inline 、 attachment 和 None 之间选择。

3.5 新版功能.

下列方法与信息内容（载荷）之访问与操控有关。

walk()

walk() 方法是一个多功能生成器。它可以被用来以深度优先顺序遍历信息对象树的所有部分和子部分。一般而言， walk() 会被用作 for 循环的迭代器，每一次迭代都返回其下一个子部分。

以下例子会打印出一封具有多部分结构之信息的每个部分的 MIME 类型。

>>> 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

walk 会遍历所有 is_multipart() 方法返回 True 的部分之子部分，哪怕 msg.get_content_maintype() == 'multipart' 返回的是 False 。使用 _structure 除错帮助函数可以帮助我们在下面这个例子当中看清楚这一点：

>>> 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

在这里， message 的部分并非 multiparts ，但是它们真的包含子部分！ is_multipart() 返回 True ， walk 也深入进这些子部分中。

get_body(preferencelist=('related', 'html', 'plain'))

返回信息的 MIME 部分。这个部分是最可能成为信息体的部分。

preferencelist 必须是一个字符串序列，其内容从 related 、 html 和 plain 这三者组成的集合中选取。这个序列代表着返回的部分的内容类型之偏好。

在 get_body 方法被调用的对象上寻找匹配的候选者。

如果 related 未包括在 preferencelist 中，可考虑将所遇到的任意相关的根部分（或根部分的子部分）在该（子）部分与一个首选项相匹配时作为候选项。

当遇到一个 multipart/related 时，将检查 start 形参并且如果找到了一个匹配 Content-ID 的部分，在查找候选匹配时只考虑它。 在其他情况下则只考虑 multipart/related 的第一个（默认的根）部分。

如果一个部分具有 Content-Disposition 标头，则当标头值为 inline 时将只考虑将该部分作为候选匹配。

如果没有任何候选部分匹配 preferencelist 中的任何首选项，则返回 None。

注: (1) 对于大多数应用来说有意义的 preferencelist 组合仅有 ('plain',), ('html', 'plain') 以及默认的 ('related', 'html', 'plain')。 (2) 由于匹配是从调用 get_body 的对象开始的，因此在 multipart/related 上调用 get_body 将返回对象本身，除非 preferencelist 具有非默认值。 (3) 未指定 Content-Type 或者 Content-Type 标头无效的消息（或消息部分）将被当作具有 text/plain 类型来处理，这有时可能导致 get_body 返回非预期的结果。

iter_attachments()

返回包含所有不是候选 "body" 部分的消息的直接子部分的迭代器。 也就是说，跳过首次出现的每个 text/plain, text/html, multipart/related 或 multipart/alternative (除非通过 Content-Disposition: attachment 将它们显式地标记为附件)，并返回所有的其余部分。 当直接应用于 multipart/related 时，将返回包含除根部分之外所有相关部分的迭代器（即由 start 形参所指向的部分，或者当没有 start 形参或 start 形参不能匹配任何部分的 Content-ID 时则为第一部分）。 当直接应用于 multipart/alternative 或非 multipart 时，将返回一个空迭代器。

iter_parts()

返回包含消息的所有直接子部分的迭代器，对于非 multipart 将为空对象。 （另请参阅 walk()。）

get_content(*args, content_manager=None, **kw)

调用 content_manager 的 get_content() 方法，将自身作为消息对象传入，并将其他参数或关键字作为额外参数传入。 如果未指定 content_manager，则会使用当前 policy 所指定的 content_manager。

set_content(*args, content_manager=None, **kw)

调用 content_manager 的 set_content() 方法，将自身作为消息传入，并将其他参数或关键字作为额外参数传入。 如果未指定 content_manager，则会使用当前 policy 所指定的 content_manager。

make_related(boundary=None)

将非 multipart 消息转换为 multipart/related 消息，将任何现有的 Content- 标头和载荷移入 multipart 的（新加）首部分。 如果指定了 boundary，会用它作为 multipart 中的分界字符串，否则会在必要时自动创建分界（例如当消息被序列化时）。

make_alternative(boundary=None)

将非 multipart 或 multipart/related 转换为 multipart/alternative，将任何现有的 Content- 标头和载荷移入 multipart 的（新加）首部分。 如果指定了 boundary，会用它作为 multipart 中的分界字符串，否则会在必要时自动创建分界（例如当消息被序列化时）。

make_mixed(boundary=None)

将非 multipart, multipart/related 或 multipart-alternative 转换为 multipart/mixed，将任何现有的 Content- 标头和载荷移入 multipart 的（新加）首部分。 如果指定了 boundary，会用它作为 multipart 中的分界字符串，否则会在必要时自动创建分界（例如当消息被序列化时）。

add_related(*args, content_manager=None, **kw)

如果消息为 multipart/related，则创建一个新的消息对象，将所有参数传给其 set_content() 方法，并将其 attach() 到 multipart。 如果消息为非 multipart，则先调用 make_related() 然后再继续上述步骤。 如果消息为任何其他类型的 multipart，则会引发 TypeError。 如果未指定 content_manager，则使用当前 policy 所指定的 content_manager。 如果添加的部分没有 Content-Disposition 标头，则会添加一个值为 inline 的标头。

add_alternative(*args, content_manager=None, **kw)

如果消息为 multipart/alternative，则创建一个新的消息对象，将所有参数传给其 set_content() 方法，并将其 attach() 到 multipart。 如果消息为非 multipart 或 multipart/related，则先调用 make_alternative() 然后再继续上述步骤。 如果消息为任何其他类型的 multipart，则会引发 TypeError。 如果未指定 content_manager，则会使用当前 policy 所指定的 content_manager。

add_attachment(*args, content_manager=None, **kw)

如果消息为 multipart/mixed，则创建一个新的消息对象，将所有参数传给其 set_content() 方法，并将其 attach() 到 multipart。 如果消息为非 multipart, multipart/related 或 multipart/alternative，则先调用 make_mixed() 然后再继续上述步骤。 如果未指定 content_manager，则使用当前 policy 所指定的 content_manager。 如果添加的部分没有 Content-Disposition 标头，则会添加一个值为 attachment 的标头。 此方法对于显式附件 (Content-Disposition: attachment) 和 inline 附件 (Content-Disposition: inline) 均可使用，只须向 content_manager 传入适当的选项即可。

clear()

移除所有载荷和所有标头。

clear_content()

移除载荷以及所有 Content- 标头，其他标头不加改变并且保持其原有顺序。

EmailMessage 对象具有下列实例属性:

preamble

MIME 文档格式在标头之后的空白行以及第一个多部分的分界字符串之间允许添加一些文本， 通常，此文本在支持 MIME 的邮件阅读器中永远不可见，因为它处在标准 MIME 保护范围之外。 但是，当查看消息的原始文本，或当在不支持 MIME 的阅读器中查看消息时，此文本会变得可见。

preamble 属性包含 MIME 文档开头部分的这些处于保护范围之外的文本。 当 Parser 在标头之后及第一个分界字符串之前发现一些文本时，它会将这些文本赋值给消息的 preamble 属性。 当 Generator 写出 MIME 消息的纯文本表示形式时，如果它发现消息具有 preamble 属性，它将在标头及第一个分界之间区域写出这些文本。 请参阅 email.parser 和 email.generator 了解更多细节。

请注意如果消息对象没有前导文本，则 preamble 属性将为 None。

epilogue

epilogue 属性的作用方式与 preamble 相同，区别在于它包含在最后一个分界及消息结尾之间出现的文本。 与 preamble 类似，如果没有附加文本，则此属性将为 None。

defects

defects 属性包含在解析消息时发现的所有问题的列表。 请参阅 email.errors 了解可能的解析缺陷的详细描述。

class email.message.MIMEPart(policy=default)

这个类代表 MIME 消息的子部分。 它与 EmailMessage 相似，不同之处在于当 set_content() 被调用时不会添加 MIME-Version 标头，因为子部分不需要有它们自己的 MIME-Version 标头。

备注

1

原先在3.4版本中以 provisional module 添加。过时的文档被移动至 email.message.Message: 使用 compat32 API 来表示电子邮件消息 。

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

源代码: Lib/email/parser.py [https://github.com/python/cpython/tree/3.10/Lib/email/parser.py]

使用以下两种方法的其中一种以创建消息对象结构：直接创建一个 EmailMessage 对象，使用字典接口添加消息头，并且使用 set_content() 和其他相关方法添加消息负载；或者通过解析一个电子邮件消息的序列化表达来创建消息对象结构。

email 包提供了一个可以理解包含 MIME 文档在内的绝大多数电子邮件文档结构的标准语法分析程序。 你可以传递给语法分析程序一个字节串、字符串或者文件对象，语法分析程序会返回给你对应于该对象结构的根 EmailMessage 实例。 对于简单的、非 MIME 的消息，这个根对象的负载很可能就是一个包含了该消息文字内容的字符串。 对于 MIME 消息，调用根对象的 is_multipart() 方法会返回 True，其子项可以通过负载操纵方法来进行访问，例如 get_body()、iter_parts() 还有 walk()。

事实上你可以使用的语法分析程序接口有两种: Parser API 和增量式的 FeedParser API。当你的全部消息内容都在内存当中，或者整个消息都保存在文件系统内的一个文件当中的时候，Parser API非常有用。当你从可能会为了等待更多输入而阻塞的数据流当中读取消息（比如从套接字当中读取电子邮件消息）的时候，FeedParser 会更合适。FeedParser 会增量读取并解析消息，并且只有在你关闭语法分析程序的时候才会返回根对象。

请注意，语法分析程序可以进行有限的拓展，你当然也可以完全从零开始实现你自己的语法分析程序。将 email 包中内置的语法分析程序和 EmailMessage 类连接起来的所有逻辑代码都包含在 policy 类当中，所以如有必要，自定义的语法分析程序可以通过实现自定义的对应 policy 方法来创建对应的消息对象树。

FeedParser API

从 email.feedparser 模块导入的 BytesFeedParser 类提供了一个适合于增量解析电子邮件消息的API，比如说在从一个可能会阻塞（例如套接字）的源当中读取消息文字的场合中它就会变得很有用。当然， BytesFeedParser 也可以用来解析一个已经完整包含在一个 bytes-like object 、字符串或文件内的电子邮件消息，但是在这些场合下使用 BytesParser API可能会更加方便。这两个语法分析程序API的语义和最终结果是一致的。

BytesFeedParser 的API十分简洁易懂：你创建一个语法分析程序的实例，向它不断输入大量的字节直到尽头，然后关闭这个语法分析程序就可以拿到根消息对象了。 在处理符合标准的消息的时候 BytesFeedParser 非常准确；在处理不符合标准的消息的时候它做的也不差，但这视消息损坏的程度而定。它会向消息对象的 defects 属性中写入它从消息中找到的问题列表。关于它能找到的所有问题类型的列表，详见 email.errors 模块。

这里是 BytesFeedParser 的 API：

class email.parser.BytesFeedParser(_factory=None, *, policy=policy.compat32)

创建一个 BytesFeedParser 实例。可选的 _factory 参数是一个不带参数的可调用对象；如果没有被指定，就会使用 policy 参数的 message_factory 属性。 每当需要一个新的消息对象的时候，_factory 都会被调用。

如果指定了 policy 参数，它就会使用这个参数所指定的规则来更新消息的表达方式。 如果没有设定 policy 参数，它就会使用 compat32 策略。 这个策略维持了对 Python 3.2 版本的 email 包的后向兼容性，并且使用 Message 作为默认的工厂。 其他策略使用 EmailMessage 作为默认的 _factory。 关于 policy 还会控制什么，参见 policy 的文档。

注: 一定要指定policy关键字。 在未来版本的 Python 当中，它的默认值会变成 email.policy.default。

3.2 新版功能.

在 3.3 版更改: 添加了 policy 关键字。

在 3.6 版更改: _factory 默认为策略 message_factory。

feed(data)

向语法分析程序输入更多数据。data 应当是一个包含一行或多行内容的 bytes-like object。 行内容可以是不完整的，语法分析程序会妥善的将这些不完整的行缝合在一起。每一行可以使用以下三种常见的终止符号的其中一种：回车符、换行符或回车符加换行符（三者甚至可以混合使用）。

close()

完成之前输入的所有数据的解析并返回根消息对象。 如果在这个方法被调用之后仍然调用 feed() 方法，结果是未定义的。

class email.parser.FeedParser(_factory=None, *, policy=policy.compat32)

行为跟 BytesFeedParser 类一致，只不过向 feed() 方法输入的内容必须是字符串。它的实用性有限，因为这种消息只有在其只含有ASCII文字，或者 utf8 被设置为 True 且没有二进制格式的附件的时候，才会有效。

在 3.3 版更改: 添加了 policy 关键字。

Parser API

BytesParser 类从 email.parser 模块导入，当消息的完整内容包含在一个 bytes-like object 或文件中时它提供了可用于解析消息的 API。 email.parser 模块还提供了 Parser 用来解析字符串，以及只用来解析消息头的 BytesHeaderParser 和 HeaderParser，如果你只对消息头感兴趣就可以使用后两者。 在这种场合下 BytesHeaderParser 和 HeaderParser 速度非常快，因为它们并不会尝试解析消息体，而是将载荷设为原始数据。

class email.parser.BytesParser(_class=None, *, policy=policy.compat32)

创建一个 BytesParser 实例。 _class 和 policy 参数在含义和语义上与 BytesFeedParser 的 _factory 和 policy 参数一致。

注: 一定要指定policy关键字。 在未来版本的 Python 当中，它的默认值会变成 email.policy.default。

在 3.3 版更改: 移除了在2.4版本中被弃用的 strict 参数。新增了 policy 关键字。

在 3.6 版更改: _class 默认为策略 message_factory。

parse(fp, headersonly=False)

从二进制的类文件对象 fp 中读取全部数据、解析其字节内容、并返回消息对象。 fp 必须同时支持 readline() 方法和 read() 方法。

fp 内包含的字节内容必须是一块遵循 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] （如果 utf8 为 True，则为 RFC 6532 [https://datatracker.ietf.org/doc/html/rfc6532.html] ）格式风格的消息头和消息头延续行，并可能紧跟一个信封头。 头块要么以数据结束，要么以一个空行为终止。 跟着头块的是消息体（消息体内可能包含 MIME 编码的子部分，这也包括 Content-Transfer-Encoding 字段为 8bit 的子部分）。

可选的 headersonly 指示了是否应当在读取完消息头后就终止。默认值为 False ，意味着它会解析整个文件的全部内容。

parsebytes(bytes, headersonly=False)

与 parse() 方法类似，只不过它要求输入为一个 bytes-like object 而不是类文件对象。于一个 bytes-like object 调用此方法相当于先将这些字节包装于一个 BytesIO 实例中，然后调用 parse() 方法。

可选的 headersonly 与 parse() 方法中的 headersonly 是一致的。

3.2 新版功能.

class email.parser.BytesHeaderParser(_class=None, *, policy=policy.compat32)

除了 headersonly 默认为 True，其他与 BytesParser 类完全一样。

3.3 新版功能.

class email.parser.Parser(_class=None, *, policy=policy.compat32)

这个类与 BytesParser 一样，但是处理字符串输入。

在 3.3 版更改: 移除了 strict 参数。添加了 policy 关键字。

在 3.6 版更改: _class 默认为策略 message_factory。

parse(fp, headersonly=False)

从文本模式的文件型对象 fp 读取所有数据，解析所读取的文本，并返回根消息对象。 fp 必须同时支持文件型对象上的 readline() 和 read() 方法。

除了文字模式的要求外，这个方法跟 BytesParser.parse() 的运行方式一致。

parsestr(text, headersonly=False)

与 parse() 方法类似，只不过它要求输入为一个字符串而不是类文件对象。于一个字符串对象调用此方法相当于先将 text 包装于一个 StringIO 实例中，然后调用 parse() 方法。

可选的 headersonly 与 parse() 方法中的 headersonly 是一致的。

class email.parser.HeaderParser(_class=None, *, policy=policy.compat32)

除了 headersonly 默认为 True ，其他与 Parser 类完全一样。

考虑到从一个字符串或一个文件对象中创建一个消息对象是非常常见的任务，我们提供了四个方便的函数。它们于顶层 email 包命名空间内可用。

email.message_from_bytes(s, _class=None, *, policy=policy.compat32)

从一个 bytes-like object 中返回消息对象。 这与 BytesParser().parsebytes(s) 等价。 可选的 _class 和 policy 参数与 BytesParser 类的构造函数的参数含义一致。

3.2 新版功能.

在 3.3 版更改: 移除了 strict 参数。添加了 policy 关键字。

email.message_from_binary_file(fp, _class=None, *, policy=policy.compat32)

从打开的二进制 file object 中返回消息对象。 这与 BytesParser().parse(fp) 等价。 _class 和 policy 参数与 BytesParser 类的构造函数的参数含义一致。

3.2 新版功能.

在 3.3 版更改: 移除了 strict 参数。添加了 policy 关键字。

email.message_from_string(s, _class=None, *, policy=policy.compat32)

从一个字符串中返回消息对象。 这与 Parser().parsestr(s) 等价。 _class 和 policy 参数与 Parser 类的构造函数的参数含义一致。

在 3.3 版更改: 移除了 strict 参数。添加了 policy 关键字。

email.message_from_file(fp, _class=None, *, policy=policy.compat32)

从一个打开的 file object 中返回消息对象。 这与 Parser().parse(fp) 等价。 _class 和 policy 参数与 Parser 类的构造函数的参数含义一致。

在 3.3 版更改: 移除了 strict 参数。添加了 policy 关键字。

在 3.6 版更改: _class 默认为策略 message_factory。

这里是一个展示了你如何在Python交互式命令行中使用 message_from_bytes() 的例子：

>>> import email
>>> msg = email.message_from_bytes(myBytes)

附加说明

在解析语义的时候请注意：

大多数非 multipart 类型的消息都会被解析为一个带有字符串负载的消息对象。这些对象在调用 is_multipart() 的时候会返回 False ，调用 iter_parts() 的时候会产生一个空列表。

所有 multipart 类型的消息都会被解析成一个容器消息对象。该对象的负载是一个子消息对象列表。外层的容器消息在调用 is_multipart() 的时候会返回 True ，在调用 iter_parts() 的时候会产生一个子部分列表。

大多数内容类型为 message/* （例如 message/delivery-status 和 message/rfc822 ）的消息也会被解析为一个负载是长度为1的列表的容器对象。在它们身上调用 is_multipart() 方法会返回 True ，调用 iter_parts() 所产生的单个元素会是一个子消息对象。

一些不遵循标准的消息在其内部关于它是否为 multipart 类型前后不一。这些消息可能在消息头的 Content-Type 字段中写明为 multipart ，但它们的 is_multipart() 方法的返回值可能是 False 。如果这种消息被 FeedParser 类解析，它们的 defects 属性列表当中会有一个 MultipartInvariantViolationDefect 类的实例。关于更多信息，详见 email.errors 。

email.generator: 生成 MIME 文档

源代码: Lib/email/generator.py [https://github.com/python/cpython/tree/3.10/Lib/email/generator.py]

最常见的任务之一是生成由消息对象结构表示的电子邮件消息的扁平（序列化）版本。 如果您想通过 smtplib.SMTP.sendmail() 或 nntplib 模块发送消息，或在控制台上打印消息， 则需要执行此操作。 将消息对象结构转换为序列化表示的工作由生成器类完成。

与 email.parser 模块一样，你并不会受限于已捆绑生成器的功能；你可以自己从头写一个。 不过，已捆绑生成器知道如何以符合标准的方式来生成大多数电子邮件，应该能够很好地处理 MIME 和非 MIME 电子邮件消息，并且被设计为面向字节的解析和生成操作是互逆的，它假定两者都使用同样的非转换型 policy。 也就是说，通过 BytesParser 类来解析序列化字节流然后再使用 BytesGenerator 来重新生成序列化字节流应当得到与输入相同的结果 1。 （而另一方面，在由程序所构造的 EmailMessage 上使用生成器可能导致对默认填入的 EmailMessage 对象的改变。。）

可以使用 Generator 类将消息扁平化为文本（而非二进制数据）的序列化表示形式，但是由于 Unicode 无法直接表示二进制数据，因此消息有必要被转换为仅包含 ASCII 字符的数据，这将使用标准电子邮件 RFC 内容传输编码格式技术来编码电子邮件消息以便通过非 “8 比特位兼容”的信道来传输。

为了适应 SMIME 签名消息的可重现处理过程，Generator 禁用了针对 multipart/signed 类型的消息部分及所有子部分的标头折叠。

class email.generator.BytesGenerator(outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

返回一个 BytesGenerator 对象，该对象将把提供给 flatten() 方法的任何消息或者提供给 write() 方法的任何经过代理转义编码的文本写入到 file-like object outfp。 outfp 必须支持接受二进制数据的 write 方法。

如果可选的 mangle_from_ 为 True，则会将一个 > 字符放到消息体中恰好以字符串 "From " 打头，即开头文本为 From 加一个空格的任何行的前面。 mangle_from_ 默认为 policy 的 mangle_from_ 设置值 (对于 compat32 策略为 True 而对于所有其他策略则为 False)。 mangle_from_ 被设计为在当消息以 Unix mbox 格式存储时使用 (参见 mailbox 和 WHY THE CONTENT-LENGTH FORMAT IS BAD [https://www.jwz.org/doc/content-length.html])。

如果 maxheaderlen 不为 None，则重新折叠任何长于 maxheaderlen 的标头行，或者如果为 0，则不重新包装任何标头。 如果 manheaderlen 为 None (默认值)，则根据 policy 设置包装标头和其他消息行。

如果指定了 policy，则使用该策略来控制消息的生成。 如果 policy 为 None (默认值)，则使用与传递给 flatten 的 Message 或 EmailMessage 对象相关联的策略来控制消息的生成。 请参阅 email.policy 了解有关 policy 所控制内容的详情。

3.2 新版功能.

在 3.3 版更改: 添加了 policy 关键字。

在 3.6 版更改: mangle_from_ 和 maxheaderlen 形参的默认行为是遵循策略。

flatten(msg, unixfrom=False, linesep=None)

将将以 msg 为根的消息对象结构体的文本表示形式打印到创建 BytesGenerator 实例时指定的输出文件。

如果 policy 选项 cte_type 为 8bit (默认值)，则会将未被修改的原始已解析消息中的任何标头拷贝到输出，其中会重新生成与原始数据相同的高比特位组字节数据，并保留具有它们的任何消息体部分的非 ASCII Content-Transfer-Encoding。 如果 cte_type 为 7bit，则会根据需要使用兼容 ASCII 的 Content-Transfer-Encoding 来转换高比特位组字节数据。 也就是说，将具有非 ASCII Content-Transfer-Encoding (Content-Transfer-Encoding: 8bit) 的部分转换为兼容 ASCII 的 Content-Transfer-Encoding，并使用 MIME unknown-8bit 字符集来编码标头中不符合 RFC 的非 ASCII 字节数据，以使其符合 RFC。

如果 unixfrom 为 True，则会在根消息对象的第一个 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 标头之前打印 Unix mailbox 格式 (参见 mailbox) 所使用的封包标头分隔符。 如果根对象没有封包标头，则会创建一个标准标头。 默认值为 False。 请注意对于子部分来说，不会打印任何封包标头。

如果 linesep 不为 None，则会将其用作扁平化消息的所有行之间的分隔符。 如果 linesep 为 None (默认值)，则使用在 policy 中指定的值。

clone(fp)

返回此 BytesGenerator 实例的独立克隆，具有完全相同的选项设置，而 fp 为新的 outfp。

write(s)

使用 ASCII 编解码器和 surrogateescape 错误处理程序编码 s，并将其传递给传入到 BytesGenerator 的构造器的 outfp 的 write 方法 。

作为一个便捷工具，EmailMessage 提供了 as_bytes() 和 bytes(aMessage) (即 __bytes__()) 等方法，它们简单地生成一个消息对象的序列化二进制表示形式。 更多细节请参阅 email.message。

因为字符串无法表示二进制数据，Generator 类必须将任何消息中扁平化的任何二进制数据转换为兼容 ASCII 的格式，具体将其转换为兼容 ASCII 的 Content-Transfer_Encoding。 使用电子邮件 RFC 的术语，你可以将其视作 Generator 序列化为不 "支持 8 比特" 的 I/O 流。 换句话说，大部分应用程序将需要使用 BytesGenerator，而非 Generator。

class email.generator.Generator(outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

返回一个 Generator，它将把提供给 flatten() 方法的任何消息，或者提供给 write() 方法的任何文本写入到 file-like object outfp。 outfp 必须支持接受字符串数据的 write 方法。

如果可选的 mangle_from_ 为 True，则会将一个 > 字符放到消息体中恰好以字符串 "From " 打头，即开头文本为 From 加一个空格的任何行的前面。 mangle_from_ 默认为 policy 的 mangle_from_ 设置值 (对于 compat32 策略为 True 而对于所有其他策略则为 False)。 mangle_from_ 被设计为在当消息以 Unix mbox 格式存储时使用 (参见 mailbox 和 WHY THE CONTENT-LENGTH FORMAT IS BAD [https://www.jwz.org/doc/content-length.html])。

如果 maxheaderlen 不为 None，则重新折叠任何长于 maxheaderlen 的标头行，或者如果为 0，则不重新包装任何标头。 如果 manheaderlen 为 None (默认值)，则根据 policy 设置包装标头和其他消息行。

如果指定了 policy，则使用该策略来控制消息的生成。 如果 policy 为 None (默认值)，则使用与传递给 flatten 的 Message 或 EmailMessage 对象相关联的策略来控制消息的生成。 请参阅 email.policy 了解有关 policy 所控制内容的详情。

在 3.3 版更改: 添加了 policy 关键字。

在 3.6 版更改: mangle_from_ 和 maxheaderlen 形参的默认行为是遵循策略。

flatten(msg, unixfrom=False, linesep=None)

将以 msg 为根的消息对象结构体的文本表示形式打印到当 Generator 实例被创建时所指定的输出文件。

如果 policy 选项 cte_type 为 8bit，则视同选项被设为 7bit 来生成消息。 （这是必需的，因为字符串无法表示非 ASCII 字节数据。） 将使用兼容 ASCII 的 Content-Transfer-Encoding 按需转换任何具有高比特位组的字节数据。 也就是说，将具有非 ASCII Content-Transfer-Encoding (Content-Transfer-Encoding: 8bit) 的部分转换为兼容 ASCII 的 Content-Transfer-Encoding，并使用 MIME unknown-8bit 字符集来编码标头中不符合 RFC 的非 ASCII 字节数据，以使其符合 RFC。

如果 unixfrom 为 True，则会在根消息对象的第一个 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 标头之前打印 Unix mailbox 格式 (参见 mailbox) 所使用的封包标头分隔符。 如果根对象没有封包标头，则会创建一个标准标头。 默认值为 False。 请注意对于子部分来说，不会打印任何封包标头。

如果 linesep 不为 None，则会将其用作扁平化消息的所有行之间的分隔符。 如果 linesep 为 None (默认值)，则使用在 policy 中指定的值。

在 3.2 版更改: 添加了对重编码 8bit 消息体的支持，以及 linesep 参数。

clone(fp)

返回此 Generator 实例的独立克隆，具有完全相同的选项设置，而 fp 为新的 outfp。

write(s)

将 s 写入到传给 Generator 的构造器的 outfp 的 write 方法。 这足够为 Generator 实际提供可用于 print() 函数的文件类 API。

作为一个便捷工具，EmailMessage 提供了 as_string() 和 str(aMessage) (即 __str__()) 等方法，它们简单地生成一个消息对象的已格式化字符串表示形式。 更多细节请参阅 email.message。

email.generator 模块还提供了一个派生类 DecodedGenerator，它类似于 Generator 基类，不同之处在于非 text 部分不会被序列化，而是被表示为 基于模板并填写了有关该部分的信息的字符串输出流的形式。

class email.generator.DecodedGenerator(outfp, mangle_from_=None, maxheaderlen=None, fmt=None, *, policy=None)

行为类似于 Generator，不同之处在于对传给 Generator.flatten() 的消息的任何子部分，如果该子部分的主类型为 text，则打印该子部分的已解码载荷，而如果其主类型不为 text，则不直接打印它而是使用来自该部分的信息填入字符串 fmt 并将填写完成的字符串打印出来。

要填入 fmt，则执行 fmt % part_info，其中 part_info 是由下列键和值组成的字典:

type -- 非 text 部分的完整 MIME 类型

maintype -- 非 text 部分的主 MIME 类型

subtype -- 非 text 部分的子 MIME 类型

filename -- 非 text 部分的文件名

description -- 与非 text 部分相关联的描述

encoding -- 非 text 部分的内容转换编码格式

如果 fmt 为 None，则使用下列默认 fmt:

"[忽略消息的非文本 (%(type)s) 部分，文件名 %(filename)s]"

可选的 _mangle_from_ 和 maxheaderlen 与 Generator 基类的相同。

备注

1

此语句假定你使用了正确的 unixfrom 设置，并且没有用于自动调整的 policy 设置调用（例如 refold_source 必须为 none，这 不是 默认值）。 这也不是 100% 为真，因为如果消息不遵循 RFC 标准则有时实际原始文本的信息会在解析错误恢复时丢失。 它的目标是在可能的情况下修复这些后续边缘情况。

email.policy: Policy 对象

3.3 新版功能.

源代码: Lib/email/policy.py [https://github.com/python/cpython/tree/3.10/Lib/email/policy.py]

email 的主要焦点是按照各种电子邮件和 MIME RFC 的描述来处理电子邮件消息。 但是电子邮件消息的基本格式（一个由名称加冒号加值的标头字段构成的区块，后面再加一个空白行和任意的‘消息体’）是在电子邮件领域以外也获得应用的格式。 这些应用的规则有些与主要电子邮件 RFC 十分接近，有些则很不相同。 即使是操作电子邮件，有时也可能需要打破严格的 RFC 规则，例如生成可与某些并不遵循标准的电子邮件服务器互联的电子邮件，或者是实现希望应用某些破坏标准的操作方式的扩展。

Policy 对象给予 email 包处理这些不同用例的灵活性。

Policy 对象封装了一组属性和方法用来在使用期间控制 email 包中各个组件的行为。 Policy 实例可以被传给 email 包中的多个类和方法以更改它们的默认行为。 可设置的值及其默认值如下所述。

在 email 包中的所有类会使用一个默认的策略。 对于所有 parser 类及相关的便捷函数，还有对于 Message 类来说，它是 Compat32 策略，通过其对应的预定义实例 compat32 来使用。 这个策略提供了与 Python3.3 版之前的 email 包的完全向下兼容性（在某些情况下，也包括对缺陷的兼容性）。

传给 EmailMessage 的 policy 关键字的默认值是 EmailPolicy 策略，表示为其预定义的实例 default。

在创建 Message 或 EmailMessage 对象时，它需要一个策略。 如果消息是由 parser 创建的，则传给该解析器的策略将是它所创建的消息所使用的策略。 如果消息是由程序创建的，则该策略可以在创建它的时候指定。 当消息被传递给 generator 时，生成器默认会使用来自该消息的策略，但你也可以将指定的策略传递给生成器，这将覆盖存储在消息对象上的策略。

email.parser 类和解析器便捷函数的 policy 关键字的默认值在未来的 Python 版本中 将会改变。 因此在调用任何 parser 模块所描述的类和函数时你应当 总是显式地指定你想要使用的策略。

本文档的第一部分介绍了 Policy 的特性，它是一个 abstract base class，定义了所有策略对象包括 compat32 的共有特性。 这些特性包括一些由 email 包内部调用的特定钩子方法，自定义策略可以重写这些方法以获得不同行为。 第二部分描述了实体类 EmailPolicy 和 Compat32，它们分别实现了提供标准行为和向下兼容行为与特性的钩子。

Policy 实例是不可变的，但它们可以被克隆，接受与类构造器一致的关键字参数并返回一个新的 Policy 实例，新实例是原实例的副本，但具有被改变的指定属性。

例如，以下代码可以被用来从一个 Unix 系统的磁盘文件中读取电子邮件消息并将其传递给系统的 sendmail 程序:

>>> 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()

这里我们让 BytesGenerator 在创建要送入 sendmail's stdin 的二进制字串时使用符合 RFC 的行分隔字符，默认的策略将会使用 \n 行分隔符。

某些 email 包的方法接受一个 policy 关键字参数，允许为该方法覆盖原有策略。 例如，以下代码使用了来自之前示例的 msg 对象的 as_bytes() 方法并使用其运行所在平台的本机行分隔符将消息写入一个文件:

>>> import os
>>> with open('converted.txt', 'wb') as f:
...     f.write(msg.as_bytes(policy=msg.policy.clone(linesep=os.linesep)))
17

Policy 对象也可使用加法运算符进行组合来产生一个新策略对象，其设置是被加总对象的非默认值的组合:

>>> compat_SMTP = policy.compat32.clone(linesep='\r\n')
>>> compat_strict = policy.compat32.clone(raise_on_defect=True)
>>> compat_strict_SMTP = compat_SMTP + compat_strict

此运算不满足交换律；也就是说对象的添加顺序很重要。 见以下演示:

>>> 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

class email.policy.Policy(**kw)

这是所有策略类的 abstract base class。 它提供了一些简单方法的默认实现，以及不可变特征属性，clone() 方法以及构造器语义的实现。

可以向策略类的构造器传入各种关键字参数。 可以指定的参数是该类的任何非方法特征属性，以及实体类的任何额外非方法特征属性。 在构造器中指定的值将覆盖相应属性的默认值。

这个类定义了下列特征属性，因此下列值可以被传给任何策略类的构造器:

max_line_length

序列化输出中任何行的最大长度，不计入行字符的末尾。 默认值为 78，基于 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html]。 值为 0 或 None 表示完全没有行包装。

linesep

用来在序列化输出中确定行的字符串。 默认值为 \n 因为这是 Python 所使用的内部行结束符规范，但 RFC 的要求是 \r\n。

cte_type

控制可能要求使用的内容传输编码格式类型。 可能的值包括:

7bit | 所有数据必须为 "纯 7 比特位" (仅 ASCII)。 这意味着在必要情况下数据将使用可打印引用形式或 base64 编码格式进行编码。
8bit | 数据不会被限制为纯 7 比特位。 标头中的数据仍要求仅 ASCII 因此将被编码（参阅下文的 fold_binary() 和 utf8 了解例外情况），但消息体部分可能使用 8bit CTE。

cte_type 值为 8bit 仅适用于 BytesGenerator 而非 Generator，因为字符串不能包含二进制数据。 如果 Generator 运行于指定了 cte_type=8bit 的策略，它的行为将与 cte_type 为 7bit 相同。

raise_on_defect

如为 True，则遇到的任何缺陷都将引发错误。 如为 False (默认值)，则缺陷将被传递给 register_defect() 方法。

mangle_from_

如为 True，则消息体中以 "From " 开头的行会通过在其前面放一个 > 来进行转义。 当消息被生成器执行序列化时会使用此形参。 默认值t: False。

3.5 新版功能: mangle_from_ 形参。

message_factory

用来构造新的空消息对象的工厂函数。 在构建消息时由解析器使用。 默认为 None，在此情况下会使用 Message。

3.6 新版功能.

verify_generated_headers

如为 True (默认值)，则生成器会引发 raise HeaderWriteError 而不是写入一个不正确地折叠或设限的标头，以便它可以被解析为多重标头或与相邻数据合并。 这样的标头可通过自定义标头类或 email 模块中的程序错误来生成。

由于它是一个安全特性，即使是在 Compat32 策略中该值也默认为 True。 为了保持向下兼容但是不安全的行为，它必须显式地被设为 False。

3.10.15 新版功能.

下列 Policy 方法是由使用 email 库的代码来调用以创建具有自室外设置的策略实例:

clone(**kw)

返回一个新的 Policy 实例，其属性与当前实例具有相同的值，除非是那些由关键字参数给出了新值的属性。

其余的 Policy 方法是由 email 包代码来调用的，而不应当被使用 email 包的应用程序所调用。 自定义的策略必须实现所有这些方法。

handle_defect(obj, defect)

处理在 obj 上发现的 defect。 当 email 包调用此方法时，defect 将总是 Defect 的一个子类。

默认实现会检查 raise_on_defect 旗标。 如果其为 True，则 defect 会被作为异常来引发。 如果其为 False (默认值)，则 obj 和 defect 会被传递给 register_defect()。

register_defect(obj, defect)

在 obj 上注册一个 defect。 在 email 包中，defect 将总是 Defect 的一个子类。

默认实现会调用 obj 的 defects 属性的 append 方法。 当 email 包调用 handle_defect 时，obj 通常将具有一个带 append 方法的 defects 属性。 配合 email 包使用的自定义对象类型（例如自定义的 Message 对象）也应当提供这样的属性，否则在被解析消息中的缺陷将引发非预期的错误。

header_max_count(name)

返回名为 name 的标头的最大允许数量。

当添加一个标头到 EmailMessage 或 Message 对象时被调用。 如果返回值不为 0 或 None，并且已有的名称为 name 的标头数量大于等于所返回的值，则会引发 ValueError。

由于 Message.__setitem__ 的默认行为是将值添加到标头列表，因此很容易不知情地创建重复的标头。 此方法允许在程序中限制可以被添加到 Message 中的特定标头的实例数量。 （解析器不会考虑此限制，它将忠实地产生被解析消息中存在的任意数量的标头。）

默认实现对于所有标头名称都返回 None。

header_source_parse(sourcelines)

email 包调用此方法时将传入一个字符串列表，其中每个字符串以在被解析源中找到的行分隔符结束。 第一行包括字段标头名称和分隔符。 源中的所有空白符都会被保留。 此方法应当返回 (name, value) 元组以保存至 Message 中来代表被解析的标头。

如果一个实现希望保持与现有 email 包策略的兼容性，则 name 应当为保留大小写形式的名称（所有字符直至 ':' 分隔符），而 value 应当为展开后的值（移除所有行分隔符，但空白符保持不变），并移除开头的空白符。

sourcelines 可以包含经替代转义的二进制数据。

此方法没有默认实现

header_store_parse(name, value)

当一个应用通过程序代码修改 Message (而不是由解析器创建 Message) 时，email 包会调用此方法并附带应用程序所提供的名称和值。 此方法应当返回 (name, value) 元组以保存至 Message 中用来表示标头。

如果一个实现希望保持与现有 email 包策略的兼容性，则 name 和 value 应当为字符串或字符串的子类，它们不会修改在参数中传入的内容。

此方法没有默认实现

header_fetch_parse(name, value)

当标头被应用程序所请求时，email 包会调用此方法并附带当前保存在 Message 中的 name 和 value，并且无论此方法返回什么它都会被回传给应用程序作为被提取标头的值。 请注意可能会有多个相同名称的标头被保存在 Message 中；此方法会将指定标头的名称和值返回给应用程序。

value 可能包含经替代转义的二进制数据。 此方法所返回的值应当没有经替代转义的二进制数据。

此方法没有默认实现

fold(name, value)

email 包调用此方法时会附带当前保存在 Message 中的给定标头的 name 和 value。 此方法应当返回一个代表该标头的（根据策略设置）通过处理 name 和 value 并在适当位置插入 linesep 字符来正确地“折叠”的字符串。 请参阅 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 了解有关折叠电子邮件标头的规则的讨论。

value 可能包含经替代转义的二进制数据。 此方法所返回的字符串应当没有经替代转义的二进制数据。

fold_binary(name, value)

与 fold() 类似，不同之处在于返回的值应当为字节串对象而非字符串。

value 可能包含经替代转义的二进制数据。 这些数据可以在被返回的字节串对象中被转换回二进制数据。

class email.policy.EmailPolicy(**kw)

这个实体 Policy 提供了完全遵循当前电子邮件 RFC 的行为。 这包括 (但不限于) RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html], RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 以及当前的各种 MIME RFC。

此策略添加了新的标头解析和折叠算法。 标头不是简单的字符串，而是带有依赖于字段类型的属性的 str 的子类。 这个解析和折叠算法完整实现了 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 和 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html]。

message_factory 属性的默认值为 EmailMessage。

除了上面列出的适用于所有策略的可设置属性，此策略还添加了下列额外属性:

3.6 新版功能: 1

utf8

如为 False，则遵循 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html]，通过编码为“已编码字”来支持标头中的非 ASCII 字符。 如为 True，则遵循 RFC 6532 [https://datatracker.ietf.org/doc/html/rfc6532.html] 并对标头使用 utf-8 编码格式。 以此方式格式化的消息可被传递给支持 SMTPUTF8 扩展 (RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html]) 的 SMTP 服务器。

refold_source

如果 Message 对象中标头的值源自 parser (而非由程序设置)，此属性会表明当将消息转换回序列化形式时是否应当由生成器来重新折叠该值。 可能的值如下:

none | 所有源值使用原始折叠
long | 具有任何长度超过 max_line_length 的行的源值将被折叠
all | 所有值会被重新折叠。

默认值为 long。

header_factory

该可调用对象接受两个参数，name 和 value，其中 name 为标头字段名而 value 为展开后的标头字段值，并返回一个表示该标头的字符串子类。 已提供的默认 header_factory (参见 headerregistry) 支持对各种地址和日期 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 标头字段类型及主要 MIME 标头字段类型的自定义解析。 未来还将添加对其他自定义解析的支持。

content_manager

此对象至少有两个方法: get_content 和 set_content。 当一个 EmailMessage 对象的 get_content() 或 set_content() 方法被调用时，它会调用此对象的相应方法，将消息对象作为其第一个参数，并将传给它的任何参数或关键字作为附加参数传入。 默认情况下 content_manager 会被设为 raw_data_manager。

3.4 新版功能.

这个类提供了下列对 Policy 的抽象方法的具体实现:

header_max_count(name)

返回用来表示具有给定名称的标头的专用类的 max_count 属性的值。

header_source_parse(sourcelines)

此名称会被作为到 ':' 止的所有内容来解析。 该值是通过从第一行的剩余部分去除前导空格，再将所有后续行连接到一起，并去除所有末尾回车符或换行符来确定的。

header_store_parse(name, value)

name 将会被原样返回。 如果输入值具有 name 属性并可在忽略大小写的情况下匹配 name，则 value 也会被原样返回。 在其他情况下 name 和 value 会被传递给 header_factory，并将结果标头对象作为值返回。 在此情况下如果输入值包含 CR 或 LF 字符则会引发 ValueError。

header_fetch_parse(name, value)

如果值具有 name 属性，它会被原样返回。 在其他情况下 name 和移除了所有 CR 和 LF 字符的 value 会被传递给 header_factory，并返回结果标头对象。 任何经替代转义的字节串会被转换为 unicode 未知字符字形。

fold(name, value)

标头折叠是由 refold_source 策略设置来控制的。 当且仅当一个值没有 name 属性（具有 name 属性就意味着它是某种标头对象）它才会被当作是“源值”。 如果一个原值需要按照策略来重新折叠，则会通过将 name 和去除了所有 CR 和 LF 字符的 value 传递给 header_factory 来将其转换为标头对象。 标头对象的折叠是通过调用其 fold 方法并附带当前策略来完成的。

源值会使用 splitlines() 来拆分成多行。 如果该值不被重新折叠，则会使用策略中的 linesep 重新合并这些行并将其返回。 例外的是包含非 ascii 二进制数据的行。 在此情况下无论 refold_source 如何设置该值都会被重新折叠，这会导致二进制数据使用 unknown-8bit 字符集进行 CTE 编码。

fold_binary(name, value)

如果 cte_type 为 7bit 则与 fold() 类似，不同之处在于返回的值是字节串。

如果 cte_type 为 8bit，则将非 ASCII 二进制数据转换回字节串。 带有二进制数据的标头不会被重新折叠，无论 refold_header 设置如何，因为无法知晓该二进制数据是由单字节字符还是多字节字符组成的。

以下 EmailPolicy 的实例提供了适用于特定应用领域的默认值。 请注意在未来这些实例（特别是 HTTP 实例）的行为可能会被调整以便更严格地遵循与其领域相关的 RFC。

email.policy.default

一个未改变任何默认值的 EmailPolicy 实例。 此策略使用标准的 Python \n 行结束符而非遵循 RFC 的 \r\n。

email.policy.SMTP

适用于按照符合电子邮件 RFC 的方式来序列化消息。 与 default 类似，但 linesep 被设为遵循 RFC 的 \r\n。

email.policy.SMTPUTF8

与 SMTP 类似但是 utf8 为 True。 适用于在不使用标头内已编码字的情况下对消息进行序列化。 如果发送方或接收方地址具有非 ASCII 字符则应当只被用于 SMTP 传输 (smtplib.SMTP.send_message() 方法会自动如此处理)。

email.policy.HTTP

适用于序列化标头以在 HTTP 通信中使用。 与 SMTP 类似但是 max_line_length 被设为 None (无限制)。

email.policy.strict

便捷实例。 与 default 类似但是 raise_on_defect 被设为 True。 这样可以允许通过以下写法来严格地设置任何策略:

somepolicy + policy.strict

因为所有这些 EmailPolicies，email 包的高效 API 相比 Python 3.2 API 发生了以下几方面变化:

在 Message 中设置标头将使得该标头被解析并创建一个标头对象。

从 Message 提取标头将使得该标头被解析并创建和返回一个标头对象。

任何标头对象或任何由于策略设置而被重新折叠的标头都会使用一种完全实现了 RFC 折叠算法的算法来进行折叠，包括知道在休息需要并允许已编码字。

从应用程序的视角来看，这意味着任何通过 EmailMessage 获得的标头都是具有附加属性的标头对象，其字符串值都是该标头的完全解码后的 unicode 值。 类似地，可以使用 unicode 对象为一个标头赋予新的值，或创建一个新的标头对象，并且该策略将负责把该 unicode 字符串转换为正确的 RFC 已编码形式。

标头对象及其属性的描述见 headerregistry。

class email.policy.Compat32(**kw)

这个实体 Policy 为向下兼容策略。 它复制了 Python 3.2 中 email 包的行为。 policy 模块还定义了该类的一个实例 compat32，用来作为默认策略。 因此 email 包的默认行为会保持与 Python 3.2 的兼容性。

下列属性具有与 Policy 默认值不同的值:

mangle_from_

默认值为 True。

这个类提供了下列对 Policy 的抽象方法的具体实现:

header_source_parse(sourcelines)

此名称会被作为到 ':' 止的所有内容来解析。 该值是通过从第一行的剩余部分去除前导空格，再将所有后续行连接到一起，并去除所有末尾回车符或换行符来确定的。

header_store_parse(name, value)

name 和 value 会被原样返回。

header_fetch_parse(name, value)

如果 value 包含二进制数据，则会使用 unknown-8bit 字符集来将其转换为 Header 对象。 在其他情况下它会被原样返回。

fold(name, value)

标头会使用 Header 折叠算法进行折叠，该算法保留 value 中现有的换行，并将每个结果行的长度折叠至 max_line_length。 非 ASCII 二进制数据会使用 unknown-8bit 字符串进行 CTE 编码。

fold_binary(name, value)

标头会使用 Header 折叠算法进行折叠，该算法保留 value 中现有的换行，并将每个结果行的长度折叠至 max_line_length。 如果 cte_type 为 7bit，则非 ascii 二进制数据会使用 unknown-8bit 字符集进行 CTE 编码。 在其他情况下则会使用原始的源标头，这将保留其现有的换行和所包含的任何（不符合 RFC 的）二进制数据。

email.policy.compat32

Compat32 的实例，提供与 Python 3.2 中的 email 包行为的向下兼容性。

备注

1

最初在 3.3 中作为 暂定特性 添加。

email.errors: 异常和缺陷类

源代码: Lib/email/errors.py [https://github.com/python/cpython/tree/3.10/Lib/email/errors.py]

以下异常类在 email.errors 模块中定义：

exception email.errors.MessageError

这是 email 包可以引发的所有异常的基类。 它源自标准异常 Exception 类，这个类没有定义其他方法。

exception email.errors.MessageParseError

这是由 Parser 类引发的异常的基类。它派生自 MessageError。 headerregistry 使用的解析器也在内部使用这个类。

exception email.errors.HeaderParseError

在解析消息的 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 标头时，某些错误条件下会触发，此类派生自 MessageParseError。 如果在调用方法时内容类型未知，则 set_boundary() 方法将引发此错误。 当尝试创建一个看起来包含嵌入式标头的标头时 Header 可能会针对某些 base64 解码错误引发此错误（也就是说，应该是一个 没有前导空格并且看起来像标题的延续行）。

exception email.errors.BoundaryError

已弃用和不再使用的。

exception email.errors.MultipartConversionError

当使用 add_payload() 将有效负载添加到 Message 对象时，有效负载已经是一个标量，而消息的 Content-Type 主类型不是 multipart 或者缺少时触发该异常。 MultipartConversionError 多重继承自 MessageError 和内置的 TypeError。

由于 Message.add_payload() 已被弃用，此异常实际上极少会被引发。 但是如果在派生自 MIMENonMultipart 的类 (例如 MIMEImage) 的实例上调用 attach() 方法也可以引发此异常。

exception email.errors.HeaderWriteError

当 generator 输出标头发生错误时将被引发。

以下是 FeedParser 在解析消息时可发现的缺陷列表。 请注意这些缺陷会在问题被发现时加入到消息中，因此举例来说，如果某条嵌套在 multipart/alternative 中的消息具有错误的标头，该嵌套消息对象就会有一条缺陷，但外层消息对象则没有。

所有缺陷类都是 email.errors.MessageDefect 的子类。

NoBoundaryInMultipartDefect -- 一条消息宣称有多个部分，但却没有 boundary 形参。

StartBoundaryNotFoundDefect -- 在 Content-Type 标头中宣称的开始边界无法被找到。

CloseBoundaryNotFoundDefect -- 找到了开始边界，但相应的结束边界无法被找到。

3.3 新版功能.

FirstHeaderLineIsContinuationDefect -- 消息以一个继续行作为其第一个标头行。

MisplacedEnvelopeHeaderDefect - 在标头块中间发现了一个 "Unix From" 标头。

MissingHeaderBodySeparatorDefect - 在解析没有前缀空格但又不包含 ':' 的标头期间找到一行内容。 解析将假定该行表示消息体的第一行以继续执行。

3.3 新版功能.

MalformedHeaderDefect -- 找到一个缺失了冒号或格式错误的标头。

3.3 版后已移除: 此缺陷在近几个 Python 版本中已不再使用。

MultipartInvariantViolationDefect -- 一条消息宣称为 multipart，但无法找到任何子部分。 请注意当一条消息有此缺陷时，其 is_multipart() 方法可能返回 False，即使其内容类型宣称为 multipart。

InvalidBase64PaddingDefect -- 当解码一个 base64 编码的字节分块时，填充的数据不正确。 虽然添加了足够的填充数据以执行解码，但作为结果的已解码字节串可能无效。

InvalidBase64CharactersDefect -- 当解码一个 base64 编码的字节分块时，遇到了 base64 字符表以外的字符。 这些字符会被忽略，但作为结果的已解码字节串可能无效。

InvalidBase64LengthDefect -- 当解码一个 base64 编码的字节分块时，非填充 base64 字符的数量无效（比 4 的倍数多 1）。 已编码分块会保持原样。

InvalidDateDefect -- 当解码一个无效或不可解析的数据字段时引发。 原始值会被保持原样。

email.headerregistry: 自定义标头对象

源代码: Lib/email/headerregistry.py [https://github.com/python/cpython/tree/3.10/Lib/email/headerregistry.py]

3.6 新版功能: 1

标头是由 str 的自定义子类来表示的。 用于表示给定标头的特定类则由创建标头时生效的 policy 的 header_factory 确定。 这一节记录了 email 包为处理兼容 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 的电子邮件消息所实现的特定 header_factory，它不仅为各种标头类型提供了自定义的标头对象，还为应用程序提供了添加其自定义标头类型的扩展机制。

当使用派生自 EmailPolicy 的任何策略对象时，所有标头都通过 HeaderRegistry 产生并且以 BaseHeader 作为其最后一个基类。 每个标头类都有一个由该标头类型确定的附加基类。 例如，许多标头都以 UnstructuredHeader 类作为其另一个基类。 一个标头专用的第二个类是由标头名称使用存储在 HeaderRegistry 中的查找表来确定的。 所有这些都针对典型应用程序进行透明的管理，但也为修改默认行为提供了接口，以便由更复杂的应用使用。

以下各节首先记录了标头基类及其属性，然后是用于修改 HeaderRegistry 行为的 API，最后是用于表示从结构化标头解析的数据的支持类。

class email.headerregistry.BaseHeader(name, value)

name 和 value 会从 header_factory 调用传递给 BaseHeader。 任何标头对象的字符串值都是完成解码为 unicode 的 value。

这个基类定义了下列只读属性:

name

标头的名称（字段在 ':' 之前的部分）。 这就是 name 的 header_factory 调用所传递的值；也就是说会保持大小写形式。

defects

一个包含 HeaderDefect 实例的元组，这些实例报告了在解析期间发现的任何 RFC 合规性问题。 email 包会尝试尽可能地检测合规性问题。 请参阅 errors 模块了解可能被报告的缺陷类型的相关讨论。

max_count

此类型标头可具有相同 name 的最大数量。 None 值表示无限制。 此属性的 BaseHeader 值为 None；专用的标头类预期将根据需要覆盖这个值。

BaseHeader 还提供了以下方法，它由 email 库代码调用，通常不应当由应用程序来调用。

fold(*, policy)

返回一个字符串，其中包含用来根据 policy 正确地折叠标头的 linesep 字符。 cte_type 为 8bit 时将被作为 7bit 来处理，因为标头不能包含任意二进制数据。 如果 utf8 为 False，则非 ASCII 数据将根据 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 来编码。

BaseHeader 本身不能被用于创建标头对象。 它定义了一个与每个专用标头相配合的协议以便生成标头对象。 具体来说，BaseHeader 要求专用类提供一个名为 parse 的 classmethod()。 此方法的调用形式如下:

parse(string, kwds)

kwds 是包含了一个预初始化键 defects 的字典。 defects 是一个空列表。 parse 方法应当将任何已检测到的缺陷添加到此列表中。 在返回时，kwds 字典 必须 至少包含 decoded 和 defects 等键的值。 decoded 应当是标头的字符串值（即完全解码为 unicode 的标头值）。 parse 方法应当假定 string 可能包含 content-transfer-encoded 部分，但也应当正确地处理全部有效的 unicode 字符以便它能解析未经编码的标头值。

随后 BaseHeader 的 __new__ 会创建标头实例，并调用其 init 方法。 专属类如果想要设置 BaseHeader 自身所提供的属性之外的附加属性，只需提供一个 init 方法。 这样的 init 看起来应该是这样:

def init(self, /, *args, **kw):
    self._myattr = kw.pop('myattr')
    super().init(*args, **kw)

也就是说，专属类放入 kwds 字典的任何额外内容都应当被移除和处理，并且 kw (和 args) 的剩余内容会被传递给 BaseHeader init 方法。

class email.headerregistry.UnstructuredHeader

"非结构化" 标头是 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 中默认的标头类型。 任何没有指定语法的标头都会被视为是非结构化的。 非结构化标头的经典例子是 Subject 标头。

在 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 中，非结构化标头是指一段以 ASCII 字符集表示的任意文本。 但是 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 具有一个 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 兼容机制用来将标头值中的非 ASCII 文本编码为 ASCII 字符。 当包含已编码字的 value 被传递给构造器时，UnstructuredHeader 解析器会按照非结构化文本的 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 规则将此类已编码字转换为 unicode。 解析器会使用启发式机制来尝试解码一些不合规的已编码字。 在此种情况下各类缺陷，例如已编码字或未编码文本中的无效字符问题等缺陷将会被注册。

此标头类型未提供附加属性。

class email.headerregistry.DateHeader

RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 为电子邮件标头内的日期指定了非常明确的格式。 DateHeader 解析器会识别该日期格式，并且也能识别间或出现的一些“不规范”变种形式。

这个标头类型提供了以下附加属性。

datetime

如果标头值能被识别为某一种有效的日期形式，此属性将包含一个代表该日期的 datetime 实例。 如果输入日期的时区被指定为 -0000 (表示它是 UTC 但不包含源时区的相关信息)，则 datetime 将为简单型 datetime。 如果找到了特定的时区时差值 (包括 +0000)，则 datetime 将包含一个使用 datetime.timezone 来记录时区时差的感知型 datetime。

标头的 decoded 值是由按照 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 对 datetime 进行格式化来确定的；也就是说，它会被设为:

email.utils.format_datetime(self.datetime)

当创建 DateHeader 时，value 可以为 datetime 实例。 例如这意味着以下代码是有效的并能实现人们预期的行为:

msg['Date'] = datetime(2011, 7, 15, 21)

因为这是个简单型 datetime 它将被解读为 UTC 时间戳，并且结果值的时区将为 -0000。 使用来自 utils 模块的 localtime() 函数会更有用:

msg['Date'] = utils.localtime()

这个例子将日期标头设为使用当前时区时差值的当前时间和日期。

class email.headerregistry.AddressHeader

地址标头是最复杂的结构化标头类型之一。 AddressHeader 类提供了适合任何地址标头的泛用型接口。

这个标头类型提供了以下附加属性。

groups

编码了在标头值中找到的地址和分组的 Group 对象的元组。 非分组成员的地址在此列表中表示为 display_name 为 None 的单地址 Groups。

addresses

编码了来自标头值的所有单独地址的 Address 对象的元组。 如果标头值包含任何分组，则来自分组的单个地址将包含在该分组出现在值中的点上列出（也就是说，地址列表会被“展平”为一维列表）。

标头的 decoded 值将为所有已编码字解码为 unicode 的结果。 idna 编码的域名也将被解码为 unicode。 decoded 值是通过对 groups 属性的元素的 str 值使用 ', ' 进行 join 来设置的。

可以使用 Address 与 Group 对象的任意组合的列表来设置一个地址标头的值。 display_name 为 None 的 Group 对象将被解读为单独地址，这允许一个地址列表可以附带通过使用从源标头的 groups 属性获取的列表而保留原分组。

class email.headerregistry.SingleAddressHeader

AddressHeader 的子类，添加了一个额外的属性:

address

由标头值编码的单个地址。 如果标头值实际上包含一个以上的地址（这在默认 policy 下将违反 RFC），则访问此属性将导致 ValueError。

上述类中许多还具有一个 Unique 变体 (例如 UniqueUnstructuredHeader)。 其唯一差别是在 Unique 变体中 max_count 被设为 1。

class email.headerregistry.MIMEVersionHeader

实际上 MIME-Version 标头只有一个有效的值，即 1.0。 为了将来的扩展，这个标头类还支持其他的有效版本号。 如果一个版本号是 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 的有效值，则标头对象的以下属性将具有不为 None 的值:

version

字符串形式的版本号。 任何空格和/或注释都会被移除。

major

整数形式的主版本号

minor

整数形式的次版本号

class email.headerregistry.ParameterizedMIMEHeader

MIME 标头都以前缀 'Content-' 打头。 每个特定标头都具有特定的值，其描述在该标头的类之中。 有些也可以接受一个具有通用格式的补充形参形表。 这个类被用作所有接受形参的 MIME 标头的基类。

params

一个将形参名映射到形参值的字典。

class email.headerregistry.ContentTypeHeader

处理 Content-Type 标头的 ParameterizedMIMEHeader 类。

content_type

maintype/subtype 形式的内容类型字符串。

maintype

subtype

class email.headerregistry.ContentDispositionHeader

处理 Content-Disposition 标头的 ParameterizedMIMEHeader 类。

content_disposition

inline 和 attachment 是仅有的常用有效值。

class email.headerregistry.ContentTransferEncoding

处理 Content-Transfer-Encoding 标头。

cte

可用的有效值为 7bit, 8bit, base64 和 quoted-printable。 更多信息请参阅 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html]。

class email.headerregistry.HeaderRegistry(base_class=BaseHeader, default_class=UnstructuredHeader, use_default_map=True)

这是由 EmailPolicy 在默认情况下使用的工厂函数。 HeaderRegistry 会使用 base_class 和从它所保存的注册表中获取的专用类来构建用于动态地创建标头实例的类。 当给定的标头名称未在注册表中出现时，则会使用由 default_class 所指定的类作为专用类。 当 use_default_map 为 True (默认值) 时，则会在初始化期间把将标头名称与类的标准映射拷贝到注册表中。 base_class 始终会是所生成类的 __bases__ 列表中的最后一个类。

默认的映射有:

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

HeaderRegistry 具有下列方法:

map_to_type(self, name, cls)

name 是要映射的标头名称。 它将在注册表中被转换为小写形式。 cls 是要与 base_class 一起被用来创建用于实例化与 name 相匹配的标头的类的专用类。

__getitem__(name)

构造并返回一个类来处理 name 标头的创建。

__call__(name, value)

从注册表获得与 name 相关联的专用标头 (如果 name 未在注册表中出现则使用 default_class) 并将其与 base_class 相组合以产生类，调用被构造类的构造器，传入相同的参数列表，并最终返回由此创建的类实例。

以下的类是用于表示从结构化标头解析的数据的类，并且通常会由应用程序使用以构造结构化的值并赋给特定的标头。

class email.headerregistry.Address(display_name='', username='', domain='', addr_spec=None)

用于表示电子邮件地址的类。 地址的一般形式为:

[display_name] <username@domain>

或者：

username@domain

其中每个部分都必须符合在 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 中阐述的特定语法规则。

为了方便起见可以指定 addr_spec 来替代 username 和 domain，在此情况下 username 和 domain 将从 addr_spec 中解析。 addr_spec 应当是一个正确地引用了 RFC 的字符串；如果它不是 Address 则将引发错误。 Unicode 字符也允许使用并将在序列化时被正确地编码。 但是，根据 RFC，地址的 username 部分 不允许 有 unicode。

display_name

地址的显示名称部分（如果有的话）并去除所有引用项。 如果地址没有显示名称，则此属性将为空字符串。

username

地址的 username 部分，去除所有引用项。

domain

地址的 domain 部分。

addr_spec

地址的 username@domain 部分，经过正确引用处理以作为纯地址使用（上面显示的第二种形式）。 此属性不可变。

__str__()

对象的 str 值是根据 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 规则进行引用处理的地址，但不带任何非 ASCII 字符的 Content Transfer Encoding。

为了支持 SMTP (RFC 5321 [https://datatracker.ietf.org/doc/html/rfc5321.html])，Address 会处理一种特殊情况：如果 username 和 domain 均为空字符串 (或为 None)，则 Address 的字符串值为 <>。

class email.headerregistry.Group(display_name=None, addresses=None)

用于表示地址组的类。 地址组的一般形式为:

display_name: [address-list];

作为处理由组和单个地址混合构成的列表的便捷方式，Group 也可以通过将 display_name 设为 None 以用来表示不是某个组的一部分的单独地址并提供单独地址的列表作为 addresses。

display_name

组的 display_name。 如果其为 None 并且恰好有一个 Address 在 addresses 中，则 Group 表示一个不在某个组中的单独地址。

addresses

一个可能为空的表示组中地址的包含 Address 对象的元组。

__str__()

Group 的 str 值会根据 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 进行格式化，但不带任何非 ASCII 字符的 Content Transfer Encoding。 如果 display_name 为空值且只有一个单独 Address 在 addresses 列表中，则 str 值将与该单独 Address 的 str 相同。

备注

1

最初在 3.3 中作为 暂定模块 添加

email.contentmanager: 管理 MIME 内容

源代码: Lib/email/contentmanager.py [https://github.com/python/cpython/tree/3.10/Lib/email/contentmanager.py]

3.6 新版功能: 1

class email.contentmanager.ContentManager

内容管理器的基类。 提供注册 MIME 内容和其他表示形式间转换器的标准注册机制，以及 get_content 和 set_content 发送方法。

get_content(msg, *args, **kw)

基于 msg 的 mimetype 查找处理函数（参见下一段），调用该函数，传递所有参数，并返回调用的结果。 预期的效果是处理程序将从 msg 中提取有效载荷并返回编码了有关被提取数据信息的对象。

要找到处理程序，将在注册表中查找以下键，找到第一个键即停止:

表示完整 MIME 类型的字符串 (maintype/subtype)

表示 maintype 的字符串

空字符串

如果这些键都没有产生处理程序，则为完整 MIME 类型引发一个 KeyError。

set_content(msg, obj, *args, **kw)

如果 maintype 为 multipart，则引发 TypeError；否则基于 obj 的类型（参见下一段）查找处理函数，在 msg 上调用 clear_content()，并调用处理函数，传递所有参数。 预期的效果是处理程序将转换 obj 并存入 msg，并可能对 msg 进行其他更改，例如添加各种 MIME 标头来编码需要用来解释所存储数据的信息。

要找到处理程序，将获取 obj 的类型 (typ = type(obj))，并在注册表中查找以下键，找到第一个键即停止:

类型本身 (typ)

类型的完整限定名称 (typ.__module__ + '.' + typ.__qualname__)。

类型的 qualname (typ.__qualname__)

类型的 name (typ.__name__)。

如果未匹配到上述的任何一项，则在 MRO (typ.__mro__) 中为每个类型重复上述的所有检测。 最后，如果没有其他键产生处理程序，则为 None 键检测处理程序。 如果也没有 None 的处理程序，则为该类型的完整限定名称引发 KeyError。

并会添加一个 MIME-Version 标头，如果没有的话 (另请参见 MIMEPart)。

add_get_handler(key, handler)

将 handler 函数记录为 key 的处理程序。 对于可能的 key 键，请参阅 get_content()。

add_set_handler(typekey, handler)

将 handler 记录为当一个匹配 typekey 的类型对象被传递给 set_content() 时所要调用的函数。 对于可能的 typekey 值，请参阅 set_content()。

内容管理器实例

目前 email 包只提供了一个实体内容管理器 raw_data_manager，不过在未来可能会添加更多。 raw_data_manager 是由 EmailPolicy 及其衍生工具所提供的 content_manager。

email.contentmanager.raw_data_manager

这个内容管理器仅提供了超出 Message 本身提供内容的最小接口：它只处理文本、原始字节串和 Message 对象。 不过相比基础 API，它具有显著的优势：在文本部分上执行 get_content 将返回一个 unicode 字符串而无需由应用程序来手动解码，set_content 为控制添加到一个部分的标头和控制内容传输编码格式提供了丰富的选项集合，并且它还启用了多种 add_ 方法，从而简化了多部分消息的创建过程。

email.contentmanager.get_content(msg, errors='replace')

将指定部分的有效载荷作为字符串（对于 text 部分）, EmailMessage 对象（对于 message/rfc822 部分）或 bytes 对象（对于所有其他非多部分类型）返回。 如果是在 multipart 上调用则会引发 KeyError。 如果指定部分是一个 text 部分并且指明了 errors，则会在将载荷解码为 unicode 时将其用作错误处理程序。 默认的错误处理程序是 replace。

email.contentmanager.set_content(msg, <'str'>, subtype="plain", charset='utf-8', cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

email.contentmanager.set_content(msg, <'bytes'>, maintype, subtype, cte="base64", disposition=None, filename=None, cid=None, params=None, headers=None)

email.contentmanager.set_content(msg, <'EmailMessage'>, cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

向 msg 添加标头和有效载荷:

添加一个带有 maintype/subtype 值的 Content-Type 标头。

对于 str，将 MIME maintype 设为 text，如果指定了子类型 subtype 则设为指定值，否则设为 plain。

对于 bytes，将使用指定的 maintype 和 subtype，如果未指定则会引发 TypeError。

对于 EmailMessage 对象，将 maintype 设为 message，并将指定的 subtype 设为 subtype，如果未指定则设为 rfc822。 如果 subtype 为 partial，则引发一个错误（必须使用 bytes 对象来构造 message/partial 部分）。

如果提供了 charset (这只对 str 适用)，则使用指定的字符集将字符串编码为字节串。 默认值为 utf-8。 如果指定的 charset 是某个标准 MIME 字符集名称的已知别名，则会改用该标准字符集。

如果设置了 cte，则使用指定的内容传输编码格式对有效载荷进行编码，并将 Content-Transfer-Encoding 标头设为该值。 可能的 cte 值有 quoted-printable, base64, 7bit, 8bit 和 binary。 如果输入无法以指定的编码格式被编码 (例如，对于包含非 ASCII 值的输入指定 cte 值为 7bit)，则会引发 ValueError。

对于 str 对象，如果 cte 未设置则会使用启发方式来确定最紧凑的编码格式。

对于 EmailMessage，按照 RFC 2046 [https://datatracker.ietf.org/doc/html/rfc2046.html]，如果为 subtype rfc822 请求的 cte 为 quoted-printable 或 base64 ，而为 7bit 以外的任何 cte 为 subtype external-body 则会引发一个错误。 对于 message/rfc822，如果 cte 未指定则会使用 8bit。 对于所有其他 subtype 值，都会使用 7bit。

注解

cte 值为 binary 实际上还不能正确工作。 由 set_content 所修改的 EmailMessage 对象是正确的，但 BytesGenerator 不会正确地将其序列化。

如果设置了 disposition，它会被用作 Content-Disposition 标头的值。 如果未设置，并且指定了 filename，则添加值为 attachment 的标头。 如果未设置 disposition 并且也未指定 filename，则不添加标头。 disposition 的有效值仅有 attachment 和 inline。

如果设置了 filename，则将其用作 Content-Disposition 标头的 filename 参数的值。

如果设置了 cid，则添加一个 Content-ID 标头并将其值设为 cid。

如果设置了 params，则迭代其 items 方法并使用输出的 (key, value) 结果对在 Content-Type 标头上设置附加参数。

如果设置了 headers 并且为 headername: headervalue 形式的字符串的列表或为 header 对象的列表（通过一个 name 属性与字符串相区分），则将标头添加到 msg。

备注

1

最初在 3.4 中作为 暂定模块 添加

email: 示例

以下是一些如何使用 email 包来读取、写入和发送简单电子邮件以及更复杂的MIME邮件的示例。

首先，让我们看看如何创建和发送简单的文本消息（文本内容和地址都可能包含unicode字符）：

# Import smtplib for the actual sending function
import smtplib

# Import the email modules we'll need
from email.message import EmailMessage

# Open the plain text file whose name is in textfile for reading.
with open(textfile) as fp:
    # Create a text/plain message
    msg = EmailMessage()
    msg.set_content(fp.read())

# me == the sender's email address
# you == the recipient's email address
msg['Subject'] = f'The contents of {textfile}'
msg['From'] = me
msg['To'] = you

# Send the message via our own SMTP server.
s = smtplib.SMTP('localhost')
s.send_message(msg)
s.quit()

解析 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 标题可以通过使用 parser 模块中的类来轻松完成：

# Import the email modules we'll need
from email.parser import BytesParser, Parser
from email.policy import default

# If the e-mail headers are in a file, uncomment these two lines:
# with open(messagefile, 'rb') as fp:
#     headers = BytesParser(policy=default).parse(fp)

#  Or for parsing headers in a string (this is an uncommon operation), use:
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')

#  Now the header items can be accessed as a dictionary:
print('To: {}'.format(headers['to']))
print('From: {}'.format(headers['from']))
print('Subject: {}'.format(headers['subject']))

# You can also access the parts of the addresses:
print('Recipient username: {}'.format(headers['to'].addresses[0].username))
print('Sender name: {}'.format(headers['from'].addresses[0].display_name))

以下是如何发送包含可能在目录中的一系列家庭照片的MIME消息示例：

# Import smtplib for the actual sending function
import smtplib

# And imghdr to find the types of our images
import imghdr

# Here are the email package modules we'll need
from email.message import EmailMessage

# Create the container email message.
msg = EmailMessage()
msg['Subject'] = 'Our family reunion'
# me == the sender's email address
# family = the list of all recipients' email addresses
msg['From'] = me
msg['To'] = ', '.join(family)
msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

# Open the files in binary mode.  Use imghdr to figure out the
# MIME subtype for each specific image.
for file in pngfiles:
    with open(file, 'rb') as fp:
        img_data = fp.read()
    msg.add_attachment(img_data, maintype='image',
                                 subtype=imghdr.what(None, img_data))

# Send the email via our own SMTP server.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)

以下是如何将目录的全部内容作为电子邮件消息发送的示例： 1

#!/usr/bin/env python3

"""Send the contents of a directory as a MIME message."""

import os
import smtplib
# For guessing MIME type based on file name extension
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 = '.'
    # Create the message
    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
        # Guess the content type based on the file's extension.  Encoding
        # will be ignored, although we should check for simple things like
        # gzip'd or compressed files.
        ctype, encoding = mimetypes.guess_type(path)
        if ctype is None or encoding is not None:
            # No guess could be made, or the file is encoded (compressed), so
            # use a generic bag-of-bits type.
            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)
    # Now send or store the message
    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()

以下是如何将上述MIME消息解压缩到文件目录中的示例：

#!/usr/bin/env python3

"""Unpack a MIME message into a directory of files."""

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/* are just containers
        if part.get_content_maintype() == 'multipart':
            continue
        # Applications should really sanitize the given filename so that an
        # email message can't be used to overwrite important files
        filename = part.get_filename()
        if not filename:
            ext = mimetypes.guess_extension(part.get_content_type())
            if not ext:
                # Use a generic bag-of-bits extension
                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()

以下是如何使用备用纯文本版本创建 HTML 消息的示例。 为了让事情变得更有趣，我们在 html 部分中包含了一个相关的图像，我们保存了一份我们要发送的内容到硬盘中，然后发送它。

#!/usr/bin/env python3

import smtplib

from email.message import EmailMessage
from email.headerregistry import Address
from email.utils import make_msgid

# Create the base text message.
msg = EmailMessage()
msg['Subject'] = "Ayons asperges pour le déjeuner"
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!

Cela ressemble à un excellent recipie[1] déjeuner.

[1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718

--Pepé
""")

# Add the html version.  This converts the message into a multipart/alternative
# container, with the original text message as the first part and the new html
# message as the second part.
asparagus_cid = make_msgid()
msg.add_alternative("""\
<html>
  <head></head>
  <body>
    <p>Salut!</p>
    <p>Cela ressemble à un excellent
        <a href="http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718">
            recipie
        </a> déjeuner.
    </p>
    <img src="cid:{asparagus_cid}" />
  </body>
</html>
""".format(asparagus_cid=asparagus_cid[1:-1]), subtype='html')
# note that we needed to peel the <> off the msgid for use in the html.

# Now add the related image to the html part.
with open("roasted-asparagus.jpg", 'rb') as img:
    msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',
                                     cid=asparagus_cid)

# Make a local copy of what we are going to send.
with open('outgoing.msg', 'wb') as f:
    f.write(bytes(msg))

# Send the message via local SMTP server.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)

如果我们发送最后一个示例中的消息，这是我们可以处理它的一种方法：

import os
import sys
import tempfile
import mimetypes
import webbrowser

# Import the email modules we'll need
from email import policy
from email.parser import BytesParser

def magic_html_parser(html_text, partfiles):
    """Return safety-sanitized html linked to partfiles.

    Rewrite the href="cid:...." attributes to point to the filenames in partfiles.
    Though not trivial, this should be possible using html.parser.
    """
    raise NotImplementedError("Add the magic needed")

# In a real program you'd get the filename from the arguments.
with open('outgoing.msg', 'rb') as fp:
    msg = BytesParser(policy=policy.default).parse(fp)

# Now the header items can be accessed as a dictionary, and any non-ASCII will
# be converted to unicode:
print('To:', msg['to'])
print('From:', msg['from'])
print('Subject:', msg['subject'])

# If we want to print a preview of the message content, we can extract whatever
# the least formatted payload is and print the first three lines.  Of course,
# if the message has no plain text part printing the first three lines of html
# is probably useless, but this is just a conceptual example.
simplest = msg.get_body(preferencelist=('plain', 'html'))
print()
print(''.join(simplest.get_content().splitlines(keepends=True)[:3]))

ans = input("View full message?")
if ans.lower()[0] == 'n':
    sys.exit()

# We can extract the richest alternative in order to display it:
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())
            # again strip the <> to go from email form of cid to html form.
            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)

# Of course, there are lots of email messages that could break this simple
# minded program, but it will handle the most common ones.

直到输出提示，上面的输出是：

To: Penelope Pussycat <penelope@example.com>, Fabrette Pussycat <fabrette@example.com>
From: Pepé Le Pew <pepe@example.com>
Subject: Ayons asperges pour le déjeuner

Salut!

Cela ressemble à un excellent recipie[1] déjeuner.

备注

1

感谢 Matthew Dixon Cowles 提供最初的灵感和示例。

email.message.Message: 使用 compat32 API 来表示电子邮件消息

Message 类与 EmailMessage 类非常相似，但没有该类所添加的方法，并且某些方法的默认行为也略有不同。 我们还在这里记录了一些虽然被 EmailMessage 类所支持但并不推荐的方法，除非你是在处理旧有代码。

在其他情况下这两个类的理念和结构都是相同的。

本文档描述了默认 (对于 Message) 策略 Compat32 之下的行为。 如果你要使用其他策略，你应当改用 EmailMessage 类。

电子邮件消息由多个 标头 和一个 载荷 组成。 标头必须为 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html] 风格的名称和值，其中字典名和值由冒号分隔。 冒号不是字段名或字段值的组成部分。 载荷可以是简单的文本消息，或是二进制对象，或是多个子消息的结构化序列，每个子消息都有自己的标头集合和自己的载荷。 后一种类型的载荷是由具有 multipart/* 或 message/rfc822 等 MIME 类型的消息来指明的。

Message 对象所提供了概念化模型是由标头组成的有序字典，加上用于访问标头中的特殊信息以及访问载荷的额外方法，以便能生成消息的序列化版本，并递归地遍历对象树。 请注意重复的标头是受支持的，但必须使用特殊的方法来访问它们。

Message 伪字典以标头名作为索引，标头名必须为 ASCII 值。 字典的值为应当只包含 ASCII 字符的字符串；对于非 ASCII 输入有一些特殊处理，但这并不总能产生正确的结果。 标头以保留原大小写的形式存储和返回，但字段名称匹配对大小写不敏感。 还可能会有一个单独的封包标头，也称 Unix-From 标头或 From_ 标头。 载荷 对于简单消息对象的情况是一个字符串或字节串，对于 MIME 容器文档的情况 (例如 multipart/* 和 message/rfc822) 则是一个 Message 对象。

以下是 Message 类的方法:

class email.message.Message(policy=compat32)

如果指定了 policy (它必须为 policy 类的实例) 则使用它所设置的规则来更新和序列化消息的表示形式。 如果未设置 policy，则使用 compat32 策略，该策略会保持对 Python 3.2 版 email 包的向下兼容性。 更多信息请参阅 policy 文档。

在 3.3 版更改: 增加了 policy 关键字参数。

as_string(unixfrom=False, maxheaderlen=0, policy=None)

以展平的字符串形式返回整个消息对象。 或可选的 unixfrom 为真值，返回的字符串会包括封包标头。 unixfrom 的默认值是 False。 出于保持向下兼容性的原因，maxheaderlen 的默认值是 0，因此如果你想要不同的值你必须显式地重写它（在策略中为 max_line_length 指定的值将被此方法忽略）。 policy 参数可被用于覆盖从消息实例获取的默认策略。 这可以用来对该方法所输出的格式进行一些控制，因为指定的 policy 将被传递给 Generator。

如果需要填充默认值以完成对字符串的转换则展平消息可能触发对 Message 的修改（例如，MIME 边界可能会被生成或被修改）。

请注意此方法是出于便捷原因提供的，并可能无法总是以你想要的方式来格式化消息。 例如，在默认情况下它不会按 Unix mbox 格式的要求对以 From 打头的行执行调整。 为了获得更高灵活性，请实例化一个 Generator 实例并直接使用其 flatten() 方法。 例如:

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()

如果消息对象包含未按照 RFC 标准进行编码的二进制数据，则这些不合规数据将被 unicode "unknown character" 码位值所替代。 （另请参阅 as_bytes() 和 BytesGenerator。）

在 3.4 版更改: 增加了 policy 关键字参数。

__str__()

与 as_string() 等价。 这将让 str(msg) 产生一个包含已格式化消息的字符号。

as_bytes(unixfrom=False, policy=None)

以字节串对象的形式返回整个扁平化后的消息。 当可选的 unixfrom 为真值时，返回的字符串会包括封包标头。 unixfrom 的默认值为 False。 policy 参数可被用于覆盖从消息实例获取的默认策略。 这可被用来控制该方法所产生的部分格式化效果，因为指定的 policy 将被传递给 BytesGenerator。

如果需要填充默认值以完成对字符串的转换则展平消息可能触发对 Message 的修改（例如，MIME 边界可能会被生成或被修改）。

请注意此方法是出于便捷原因提供的，并可能无法总是以你想要的方式来格式化消息。 例如，在默认情况下它不会按 Unix mbox 格式的要求对以 From 打头的行执行调整。 为了获得更高灵活性，请实例化一个 BytesGenerator 实例并直接使用其 flatten() 方法。 例如:

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()

3.4 新版功能.

__bytes__()

与 as_bytes() 等价。 这将让 bytes(msg) 产生一个包含已格式化消息的字节串对象。

3.4 新版功能.

is_multipart()

如果该消息的载荷是一个子 Message 对象列表则返回 True，否则返回 False。 当 is_multipart() 返回 False 时，载荷应当是一个字符串对象（有可能是一个 CTE 编码的二进制载荷）。 （请注意 is_multipart() 返回 True 并不意味着 "msg.get_content_maintype() == 'multipart'" 将返回 True。 例如，is_multipart 在 Message 类型为 message/rfc822 时也将返回 True。）

set_unixfrom(unixfrom)

将消息的封包标头设为 unixfrom，这应当是一个字符串。

get_unixfrom()

返回消息的信封头。如果信封头从未被设置过，默认返回 None 。

attach(payload)

将给定的 payload 添加到当前载荷中，当前载荷在该调用之前必须为 None 或是一个 Message 对象列表。 在调用之后，此载荷将总是一个 Message 对象列表。 如果你想将此载荷设为一个标量对象（如字符串），请改用 set_payload()。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被 set_content() 及相应的 make 和 add 方法所替代。

get_payload(i=None, decode=False)

返回当前的载荷，它在 is_multipart() 为 True 时将是一个 Message 对象列表，在 is_multipart() 为 False 时则是一个字符串。 如果该载荷是一个列表且你修改了这个列表对象，那么你就是原地修改了消息的载荷。

传入可选参数 i 时，如果 is_multipart() 为 True，get_payload() 将返回载荷从零开始计数的第 i 个元素。 如果 i 小于 0 或大于等于载荷中的条目数则将引发 IndexError。 如果载荷是一个字符串 (即 is_multipart() 为 False) 且给出了 i，则会引发 TypeError。

可选的 decode 是一个指明载荷是否应根据 Content-Transfer-Encoding 标头被解码的旗标。 当其值为 True 且消息没有多个部分时，如果此标头值为 quoted-printable 或 base64 则载荷将被解码。 如果使用了其他编码格式，或者找不到 Content-Transfer-Encoding 标头时，载荷将被原样返回（不编码）。 在所有情况下返回值都是二进制数据。 如果消息有多个部分且 decode 旗标为 True，则将返回 None。 如果载荷为 base64 但内容不完全正确（如缺少填充符、存在 base64 字母表以外的字符等），则将在消息的缺陷属性中添加适当的缺陷值 (分别为 InvalidBase64PaddingDefect 或 InvalidBase64CharactersDefect)。

当 decode 为 False (默认值) 时消息体会作为字符串返回而不解码 Content-Transfer-Encoding。 但是，对于 Content-Transfer-Encoding 为 8bit 的情况，会尝试使用 Content-Type 标头指定的 charset 来解码原始字节串，并使用 replace 错误处理程序。 如果未指定 charset，或者如果指定的 charset 未被 email 包所识别，则会使用默认的 ASCII 字符集来解码消息体。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被 get_content() 和 iter_parts() 方法所替代。

set_payload(payload, charset=None)

将整个消息对象的载荷设为 payload。 客户端要负责确保载荷的不变性。 可选的 charset 用于设置消息的默认字符集；详情请参阅 set_charset()。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被 set_content() 方法所替代。

set_charset(charset)

将载荷的字符集设为 charset，它可以是 Charset 实例 (参见 email.charset)、字符集名称字符串或 None。 如果是字符串，它将被转换为一个 Charset 实例。 如果 charset 是 None，charset 形参将从 Content-Type 标头中被删除（消息将不会进行其他修改）。 任何其他值都将导致 TypeError。

如果 MIME-Version 标头不存在则将被添加。 如果 Content-Type 标头不存在，则将添加一个值为 text/plain 的该标头。 无论 Content-Type 标头是否已存在，其 charset 形参都将被设为 charset.output_charset。 如果 charset.input_charset 和 charset.output_charset 不同，则载荷将被重编码为 output_charset。 如果 Content-Transfer-Encoding 标头不存在，则载荷将在必要时使用指定的 Charset 来转换编码，并将添加一个具有相应值的标头。 如果 Content-Transfer-Encoding 标头已存在，则会假定载荷已使用该 Content-Transfer-Encoding 进行正确编码并不会再被修改。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被 email.emailmessage.EmailMessage.set_content() 方法的 charset 形参所替代。

get_charset()

返回与消息的载荷相关联的 Charset 实例。

这是一个过时的方法。 在 EmailMessage 类上它将总是返回 None。

以下方法实现了用于访问消息的 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 标头的类映射接口。 请注意这些方法和普通映射（例如字典）接口之间存在一些语义上的不同。 举例来说，在一个字典中不能有重复的键，但消息标头则可能有重复。 并且，在字典中由 keys() 返回的键的顺序是没有保证的，但在 Message 对象中，标头总是会按它们在原始消息中的出现或后继加入顺序返回。 任何已删除再重新加入的标头总是会添加到标头列表的末尾。

这些语义上的差异是有意为之且其目的是为了提供最大的便利性。

请注意在任何情况下，消息当中的任何封包标头都不会包含在映射接口当中。

在由字符串生成的模型中，任何包含非 ASCII 字节数据（违反 RFC）的标头值在通过此接口来获取时，将被表示为使用 unknown-8bit 字符集的 Header 对象。

__len__()

返回标头的总数，包括重复项。

__contains__(name)

如果消息对象中有一个名为 name 的字段则返回 True。 匹配操作对大小写不敏感并且 name 不应包括末尾的冒号。 用于 in 运算符，例如:

if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])

__getitem__(name)

返回指定名称标头字段的值。 name 不应包括作为字段分隔符的冒号。 如果标头未找到，则返回 None；KeyError 永远不会被引发。

请注意如果指定名称的字段在消息标头中多次出现，具体将返回哪个字段值是未定义的。 请使用 get_all() 方法来获取所有指定名称标头的值。

__setitem__(name, val)

将具有字段名 name 和值 val 的标头添加到消息中。 字段会被添加到消息的现有字段的末尾。

请注意，这个方法 既不会 覆盖 也不会 删除任何字段名重名的已有字段。如果你确实想保证新字段是整个信息头当中唯一拥有 name 字段名的字段，你需要先把旧字段删除。例如：

del msg['subject']
msg['subject'] = 'Python roolz!'

__delitem__(name)

删除信息头当中字段名匹配 name 的所有字段。如果匹配指定名称的字段没有找到，也不会抛出任何异常。

keys()

以列表形式返回消息头中所有的字段名。

values()

以列表形式返回消息头中所有的字段值。

items()

以二元元组的列表形式返回消息头中所有的字段名和字段值。

get(name, failobj=None)

返回指定名称标头字段的值。 这与 __getitem__() 是一样的，不同之处在于如果指定名称标头未找到则会返回可选的 failobj (默认为 None)。

以下是一些有用的附加方法:

get_all(name, failobj=None)

返回字段名为 name 的所有字段值的列表。如果信息内不存在匹配的字段，返回 failobj （其默认值为 None ）。

add_header(_name, _value, **_params)

高级头字段设定。这个方法与 __setitem__() 类似，不过你可以使用关键字参数为字段提供附加参数。 _name 是字段名， _value 是字段 主 值。

对于关键字参数字典 _params 中的每一项，其键会被当作形参名，并执行下划线和连字符间的转换（因为连字符不是合法的 Python 标识符）。 通常，形参将以 key="value" 的形式添加，除非值为 None，在这种情况下将只添加键。 如果值包含非 ASCII 字符，可将其指定为格式为 (CHARSET, LANGUAGE, VALUE) 的三元组，其中 CHARSET 为要用来编码值的字符集名称字符串，LANGUAGE 通常可设为 None 或空字符串（请参阅 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 了解其他可能的取值），而 VALUE 为包含非 ASCII 码位的字符串值。 如果不是传入一个三元组且值包含非 ASCII 字符，则会自动以 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 格式使用 CHARSET 为 utf-8 和 LANGUAGE 为 None 对其进行编码。

以下是为示例代码:

msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')

会添加一个形如下文的头字段：

Content-Disposition: attachment; filename="bud.gif"

使用非 ASCII 字符的示例代码:

msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '', 'Fußballer.ppt'))

它的输出结果为

Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt"

replace_header(_name, _value)

替换一个标头。 将替换在匹配 _name 的消息中找到的第一个标头，标头顺序和字段名大小写保持不变。 如果未找到匹配的标头，则会引发 KeyError。

get_content_type()

返回消息的内容类型。 返回的字符串会强制转换为 maintype/subtype 的全小写形式。 如果消息中没有 Content-Type 标头则将返回由 get_default_type() 给出的默认类型。 因为根据 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html]，消息总是要有一个默认类型，所以 get_content_type() 将总是返回一个值。

RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 将消息的默认类型定义为 text/plain，除非它是出现在 multipart/digest 容器内，在这种情况下其类型应为 message/rfc822。 如果 Content-Type 标头指定了无效的类型，RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 规定其默认类型应为 text/plain。

get_content_maintype()

返回信息的主要内容类型。准确来说，此方法返回的是 get_content_type() 方法所返回的形如 maintype/subtype 的字符串当中的 maintype 部分。

get_content_subtype()

返回信息的子内容类型。准确来说，此方法返回的是 get_content_type() 方法所返回的形如 maintype/subtype 的字符串当中的 subtype 部分。

get_default_type()

返回默认的内容类型。绝大多数的信息，其默认内容类型都是 text/plain 。作为 multipart/digest 容器内子部分的信息除外，它们的默认内容类型是 message/rfc822 。

set_default_type(ctype)

设置默认的内容类型。 ctype 应当为 text/plain 或者 message/rfc822，尽管这并非强制。 默认的内容类型不会存储在 Content-Type 标头中。

get_params(failobj=None, header='content-type', unquote=True)

将消息的 Content-Type 形参作为列表返回。 所返回列表的元素为以 '=' 号拆分出的键/值对 2 元组。 '=' 左侧的为键，右侧的为值。 如果形参值中没有 '=' 号，否则该将值如 get_param() 描述并且在可选 unquote 为 True (默认值) 时会被取消转义。

可选的 failobj 是在没有 Content-Type 标头时要返回的对象。 可选的 header 是要替代 Content-Type 被搜索的标头。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被标头访问方法所返回的单独标头对象的 params 特征属性所替代。

get_param(param, failobj=None, header='content-type', unquote=True)

将 Content-Type 标头的形参 param 作为字符串返回。 如果消息没有 Content-Type 标头或者没有这样的形参，则返回 failobj (默认为 None)。

如果给出可选的 header，它会指定要替代 Content-Type 来使用的消息标头。

形参的键总是以大小写不敏感的方式来比较的。 返回值可以是一个字符串，或者如果形参以 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 编码则是一个 3 元组。 当为 3 元组时，值中的元素采用 (CHARSET, LANGUAGE, VALUE) 的形式。 请注意 CHARSET 和 LANGUAGE 都可以为 None，在此情况下你应当将 VALUE 当作以 us-ascii 字符集来编码。 你可以总是忽略 LANGUAGE。

如果你的应用不关心形参是否以 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 来编码，你可以通过调用 email.utils.collapse_rfc2231_value() 来展平形参值，传入来自 get_param() 的返回值。 当值为元组时这将返回一个经适当编码的 Unicode 字符串，否则返回未经转换的原字符串。 例如:

rawparam = msg.get_param('foo')
param = email.utils.collapse_rfc2231_value(rawparam)

无论在哪种情况下，形参值（或为返回的字符串，或为 3 元组形式的 VALUE 条目）总是未经转换的，除非 unquote 被设为 False。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被标头访问方法所返回的单独标头对象的 params 特征属性所替代。

set_param(param, value, header='Content-Type', requote=True, charset=None, language='', replace=False)

在 Content-Type 标头中设置一个形参。 如果该形参已存在于标头中，它的值将被替换为 value。 如果此消息还未定义 Content-Type 标头，它将被设为 text/plain 且新的形参值将按 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 的要求添加。

可选的 header 指定一个 Content-Type 的替代标头，并且所有形参将根据需要被转换，除非可选的 requote 为 False (默认为 True)。

如果指定了可选的 charset，形参将按照 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 来编码。 可选的 language 指定了 RFC 2231 的语言，默认为空字符串。 charset 和 language 都应为字符串。

如果 replace 为 False （默认值），该头字段会被移动到所有头字段列表的末尾。如果 replace 为 True ，字段会被原地更新。

在 3.4 版更改: 添加了 replace 关键字。

del_param(param, header='content-type', requote=True)

从 Content-Type 标头中完全移除给定的形参。 标头将被原地重写并不带该形参或它的值。 所有的值将根据需要被转换，除非 requote 为 False (默认为 True)。 可选的 header 指定 Content-Type 的一个替代项。

set_type(type, header='Content-Type', requote=True)

设置 Content-Type 标头的主类型和子类型。 type 必须为 maintype/subtype 形式的字符串，否则会引发 ValueError。

此方法可替换 Content-Type 标头，并保持所有形参不变。 如果 requote 为 False，这会保持原有标头引用转换不变，否则形参将被引用转换（默认行为）。

可以在 header 参数中指定一个替代标头。 当 Content-Type 标头被设置时也会添加一个 MIME-Version 标头。

这是一个过时的方法。 在 EmailMessage 类上它的功能已被 make_ 和 add_ 方法所替代。

get_filename(failobj=None)

返回信息头当中 Content-Disposition 字段当中名为 filename 的参数值。如果该字段当中没有此参数，该方法会退而寻找 Content-Type 字段当中的 name 参数值。如果这个也没有找到，或者这些个字段压根就不存在，返回 failobj 。返回的字符串永远按照 email.utils.unquote() 方法去除引号。

get_boundary(failobj=None)

返回信息头当中 Content-Type 字段当中名为 boundary 的参数值。如果字段当中没有此参数，或者这些个字段压根就不存在，返回 failobj 。返回的字符串永远按照 email.utils.unquote() 方法去除引号。

set_boundary(boundary)

将 Content-Type 头字段的 boundary 参数设置为 boundary 。 set_boundary() 方法永远都会在必要的时候为 boundary 添加引号。如果信息对象中没有 Content-Type 头字段，抛出 HeaderParseError 异常。

请注意使用这个方法与删除旧的 Content-Type 标头并通过 add_header() 添加一个带有新边界的新标头有细微的差异，因为 set_boundary() 会保留 Content-Type 标头在原标头列表中的顺序。 但是，它 不会 保留原 Content-Type 标头中可能存在的任何连续的行。

get_content_charset(failobj=None)

返回 Content-Type 头字段中的 charset 参数，强制小写。如果字段当中没有此参数，或者这个字段压根不存在，返回 failobj 。

请注意此方法不同于 get_charset()，后者会返回 Charset 实例作为消息体的默认编码格式。

get_charsets(failobj=None)

返回一个包含了信息内所有字符集名字的列表。 如果信息是 multipart 类型的，那么列表当中的每一项都对应其载荷的子部分的字符集名字。 否则，该列表是一个长度为 1 的列表。

列表中的每一项都是字符串，它们是其所表示的子部分的 Content-Type 标头中 charset 形参的值。 但是，如果该子部分没有 Content-Type 标头，或没有 charset 形参，或者主 MIME 类型不是 text，则所返回列表中的对应项将为 failobj。

get_content_disposition()

如果信息的 Content-Disposition 头字段存在，返回其字段值；否则返回 None 。返回的值均为小写，不包含参数。如果信息遵循 RFC 2183 [https://datatracker.ietf.org/doc/html/rfc2183.html] 标准，则此方法的返回值只可能在 inline 、 attachment 和 None 之间选择。

3.5 新版功能.

walk()

walk() 方法是一个多功能生成器。它可以被用来以深度优先顺序遍历信息对象树的所有部分和子部分。一般而言， walk() 会被用作 for 循环的迭代器，每一次迭代都返回其下一个子部分。

以下例子会打印出一封具有多部分结构之信息的每个部分的 MIME 类型。

>>> 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

walk 会遍历所有 is_multipart() 方法返回 True 的部分之子部分，哪怕 msg.get_content_maintype() == 'multipart' 返回的是 False 。使用 _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

在这里， message 的部分并非 multiparts ，但是它们真的包含子部分！ is_multipart() 返回 True ， walk 也深入进这些子部分中。

Message 对象也可以包含两个可选的实例属性，它们可被用于生成纯文本的 MIME 消息。

preamble

MIME 文档格式在标头之后的空白行以及第一个多部分的分界字符串之间允许添加一些文本， 通常，此文本在支持 MIME 的邮件阅读器中永远不可见，因为它处在标准 MIME 保护范围之外。 但是，当查看消息的原始文本，或当在不支持 MIME 的阅读器中查看消息时，此文本会变得可见。

preamble 属性包含 MIME 文档开头部分的这些处于保护范围之外的文本。 当 Parser 在标头之后及第一个分界字符串之前发现一些文本时，它会将这些文本赋值给消息的 preamble 属性。 当 Generator 写出 MIME 消息的纯文本表示形式时，如果它发现消息具有 preamble 属性，它将在标头及第一个分界之间区域写出这些文本。 请参阅 email.parser 和 email.generator 了解更多细节。

请注意如果消息对象没有前导文本，则 preamble 属性将为 None。

epilogue

epilogue 属性的作用方式与 preamble 属性相同，区别在于它包含出现于最后一个分界与消息结尾之间的文本。

你不需要将 epilogue 设为空字符串以便让 Generator 在文件末尾打印一个换行符。

defects

defects 属性包含在解析消息时发现的所有问题的列表。 请参阅 email.errors 了解可能的解析缺陷的详细描述。

email.mime: 从头创建电子邮件和 MIME 对象

源代码: Lib/email/mime/ [https://github.com/python/cpython/tree/3.10/Lib/email/mime/]

此模块是旧版 (Compat32) 电子邮件 API 的组成部分。 它的功能在新版 API 中被 contentmanager 部分替代，但在某些应用中这些类仍可能有用，即使是在非旧版代码中。

通常，你是通过传递一个文件或一些文本到解析器来获得消息对象结构体的，解析器会解析文本并返回根消息对象。 不过你也可以从头开始构建一个完整的消息结构体，甚至是手动构建单独的 Message 对象。 实际上，你也可以接受一个现有的结构体并添加新的 Message 对象并移动它们。 这为切片和分割 MIME 消息提供了非常方便的接口。

你可以通过创建 Message 实例并手动添加附件和所有适当的标头来创建一个新的对象结构体。 不过对于 MIME 消息来说，email 包提供了一些便捷子类来让事情变得更容易。

这些类列示如下:

class email.mime.base.MIMEBase(_maintype, _subtype, *, policy=compat32, **_params)

模块: email.mime.base

这是 Message 的所有 MIME 专属子类。 通常你不会创建专门的 MIMEBase 实例，尽管你可以这样做。 MIMEBase 主要被提供用来作为更具体的 MIME 感知子类的便捷基类。

_maintype 是 Content-Type 的主类型 (例如 text 或 image)，而 _subtype 是 Content-Type 的次类型 (例如 plain 或 gif)。 _params 是一个形参键/值字典并会被直接传递给 Message.add_header。

如果指定了 policy (默认为 compat32 策略)，它将被传递给 Message。

MIMEBase 类总是会添加一个 Content-Type 标头 (基于 _maintype, _subtype 和 _params)，以及一个 MIME-Version 标头 (总是设为 1.0)。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

class email.mime.nonmultipart.MIMENonMultipart

模块: email.mime.nonmultipart

MIMEBase 的子类，这是用于非 multipart MIME 消息的中间基类。 这个类的主要目标是避免使用 attach() 方法，该方法仅对 multipart 消息有意义。 如果 attach() 被调用，则会引发 MultipartConversionError 异常。

class email.mime.multipart.MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)

模块: email.mime.multipart

MIMEBase 的子类，这是用于 multipart MIME 消息的中间基类。 可选的 _subtype 默认为 mixed，但可被用来指定消息的子类型。 将会在消息对象中添加一个 multipart/_subtype 的 Content-Type 标头。 并还将添加一个 MIME-Version 标头。

可选的 boundary 是多部分边界字符串。 当为 None (默认值) 时，则会在必要时（例如当消息被序列化时）计算边界。

_subparts 是载荷初始子部分的序列。 此序列必须可以被转换为列表。 你总是可以使用 Message.attach 方法将新的子部分附加到消息中。

可选的 policy 参数默认为 compat32。

用于 Content-Type 标头的附加形参会从关键字参数中获取，或者传入到 _params 参数，该参数是一个关键字的字典。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

class email.mime.application.MIMEApplication(_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

模块: email.mime.application

MIMENonMultipart 的子类，MIMEApplication 类被用来表示主类型为 application 的 MIME 消息。 _data 为包含原始应用程序数据的字节串。 可选的 _subtype 指定 MIME 子类型并默认为 octet-stream。

可选的 _encoder 是一个可调用对象（即函数），它将执行实际的数据编码以便传输。 这个可调用对象接受一个参数，该参数是 MIMEApplication 的实例。 它应当使用 get_payload() 和 set_payload() 来将载荷改为已编码形式。 它还应根据需要将任何 Content-Transfer-Encoding 或其他标头添加到消息对象中。 默认编码格式为 base64。 请参阅 email.encoders 模块来查看内置编码器列表。

可选的 policy 参数默认为 compat32。

_params 会被直接传递给基类的构造器。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

class email.mime.audio.MIMEAudio(_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

模块: email.mime.audio

A subclass of MIMENonMultipart, the MIMEAudio class is used to create MIME message objects of major type audio. _audiodata contains the bytes for the raw audio data. If this data can be decoded by the standard Python module sndhdr, then the subtype will be automatically included in the Content-Type header. Otherwise you can explicitly specify the audio subtype via the _subtype argument. If the minor type could not be guessed and _subtype was not given, then TypeError is raised.

可选的 _encoder 是一个可调用对象（即函数），它将执行实际的音频数据编码以便传输。 这个可调用对象接受一个参数，该参数是 MIMEAudio 的实例。 它应当使用 get_payload() 和 set_payload() 来将载荷改为已编码形式。 它还应根据需要将任何 Content-Transfer-Encoding 或其他标头添加到消息对象中。 默认编码格式为 base64。 请参阅 email.encoders 模块来查看内置编码器列表。

可选的 policy 参数默认为 compat32。

_params 会被直接传递给基类的构造器。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

class email.mime.image.MIMEImage(_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

模块: email.mime.image

A subclass of MIMENonMultipart, the MIMEImage class is used to create MIME message objects of major type image. _imagedata contains the bytes for the raw image data. If this data can be decoded by the standard Python module imghdr, then the subtype will be automatically included in the Content-Type header. Otherwise you can explicitly specify the image subtype via the _subtype argument. If the minor type could not be guessed and _subtype was not given, then TypeError is raised.

可选的 _encoder 是一个可调用对象（即函数），它将执行实际的图像数据编码以便传输。 这个可调用对象接受一个参数，该参数是 MIMEImage 的实例。 它应当使用 get_payload() 和 set_payload() 来将载荷改为已编码形式。 它还应根据需要将任何 Content-Transfer-Encoding 或其他标头添加到消息对象中。 默认编码格式为 base64。 请参阅 email.encoders 模块来查看内置编码器列表。

可选的 policy 参数默认为 compat32。

_params 会被直接传递给 MIMEBase 构造器。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

class email.mime.message.MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32)

模块: email.mime.message

MIMENonMultipart 的子类，MIMEMessage 类被用来创建主类型为 message 的 MIME 对象。 _msg 将被用作载荷，并且必须为 Message 类（或其子类）的实例，否则会引发 TypeError。

可选的 _subtype 设置消息的子类型；它的默认值为 rfc822。

可选的 policy 参数默认为 compat32。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

class email.mime.text.MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32)

模块: email.mime.text

MIMENonMultipart 的子类，MIMEText 类被用来创建主类型为 text 的 MIME 对象。 _text 是用作载荷的字符串。 _subtype 指定子类型并且默认为 plain。 _charset 是文本的字符集并会作为参数传递给 MIMENonMultipart 构造器；如果该字符串仅包含 ascii 码位则其默认值为 us-ascii，否则为 utf-8。 _charset 形参接受一个字符串或是一个 Charset 实例。

除非 _charset 参数被显式地设为 None，否则所创建的 MIMEText 对象将同时具有附带 charset 形参的 Content-Type 标头，以及 Content-Transfer-Encoding 标头。 这意味着后续的 set_payload 调用将不再产生已编码的载荷，即使它在 set_payload 命令中被传入。 你可以通过删除 Content-Transfer-Encoding 标头来“重置”此行为，在此之后的 set_payload 调用将自动编码新的载荷（并添加新的 Content-Transfer-Encoding 标头）。

可选的 policy 参数默认为 compat32。

在 3.5 版更改: _charset 也可接受 Charset 实例。

在 3.6 版更改: 添加了 policy 仅限关键字形参。

email.header: 国际化标头

源代码: Lib/email/header.py [https://github.com/python/cpython/tree/3.10/Lib/email/header.py]

此模块是旧式 (Compat32) email API 的一部分。 在当前的 API 中标头的编码和解码是由 EmailMessage 类的字典型 API 来透明地处理的。 除了在旧有代码中使用，此模块在需要完全控制当编码标头时所使用的字符集时也很有用处。

本节中的其余文本是此模块的原始文档。

RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 是描述电子邮件消息格式的基础标准。 它派生自更早的 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 标准，该标准在大多数电子邮件仅由 ASCII 字符组成时已被广泛使用。 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 所描述的规范假定电子邮件都只包含 7 位 ASCII 字符。

当然，随着电子邮件在全球部署，它已经变得国际化了，例如电子邮件消息中现在可以使用特定语言的专属字符集。 这个基础标准仍然要求电子邮件消息只使用 7 位 ASCII 字符来进行传输，为此编写了大量 RFC 来描述如何将包含非 ASCII 字符的电子邮件编码为符合 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 的格式。 这些 RFC 包括 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html], RFC 2046 [https://datatracker.ietf.org/doc/html/rfc2046.html], RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 和 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html]。 email 包在其 email.header 和 email.charset 模块中支持了这些标准。

如果你想在你的电子邮件标头中包括非 ASCII 字符，比如说是在 Subject 或 To 字段中，你应当使用 Header 类并将 Message 对象中的字段赋值为 Header 的实例而不是使用字符串作为字段值。 请从 email.header 模块导入 Header 类。 例如:

>>> 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'

是否注意到这里我们是如何希望 Subject 字段包含非 ASCII 字符的？ 我们通过创建一个 Header 实例并传入字节串编码所用的字符集来做到这一点。 当后续的 Message 实例被展平时，Subject 字段会正确地按 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 来编码。 可感知 MIME 的电子邮件阅读器将会使用嵌入的 ISO-8859-1 字符来显示此标头。

以下是 Header 类描述:

class email.header.Header(s=None, charset=None, maxlinelen=None, header_name=None, continuation_ws=' ', errors='strict')

创建符合 MIME 要求的标头，其中可包含不同字符集的字符串。

可选的 s 是初始标头值。 如果为 None (默认值)，则表示初始标头值未设置。 你可以在稍后使用 append() 方法调用向标头添加新值。 s 可以是 bytes 或 str 的实例，注意参阅 append() 文档了解相关语义。

可选的 charset 用于两种目的：它的含义与 append() 方法的 charset 参数相同。 它还会为所有省略了 charset 参数的后续 append() 调用设置默认字符集。 如果 charset 在构造器中未提供（默认设置），则会将 us-ascii 字符集用作 s 的初始字符集以及后续 append() 调用的默认字符集。

通过 maxlinelen 可以显式指定最大行长度。 要将第一行拆分为更短的值 (以适应未被包括在to account for the field header which isn't included in s 中的字段标头，例如 Subject)，则将字段名称作为 header_name 传入。 maxlinelen 默认值为 76，而 header_name 默认值为 None，表示不考虑拆分超长标头的第一行。

可选的 continuation_ws 必须为符合 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 的折叠用空白符，通常是空格符或硬制表符。 这个字符将被加缀至连续行的开头。 continuation_ws 默认为一个空格符。

可选的 errors 会被直接传递给 append() 方法。

append(s, charset=None, errors='strict')

将字符串 s 添加到 MIME 标头。

如果给出可选的 charset，它应当是一个 Charset 实例 (参见 email.charset) 或字符集名称，该参数将被转换为一个 Charset 实例。 如果为 None (默认值) 则表示会使用构造器中给出的 charset。

s 可以是 bytes 或 str 的实例。 如果它是 bytes 的实例，则 charset 为该字节串的编码格式，如果字节串无法用该字符集来解码则将引发 UnicodeError。

如果 s 是 str 的实例，则 charset 是用来指定字符串中字符字符集的提示。

在这两种情况下，当使用 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 规则产生符合 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 的标头时，将使用指定字符集的输出编解码器来编码字符串。 如果字符串无法使用该输出编解码器来编码，则将引发 UnicodeError。

可选的 errors 会在 s 为字节串时被作为 errors 参数传递给 decode 调用。

encode(splitchars=';, \t', maxlinelen=None, linesep='\n')

将消息标头编码为符合 RFC 的格式，可能会对过长的行采取折行并将非 ASCII 部分以 base64 或 quoted-printable 编码格式进行封装。

可选的 splitchars 是一个字符串，其中包含应在正常的标头折行处理期间由拆分算法赋予额外权重的字符。 这是对于 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 中 '更高层级语法拆分' 的很粗略的支持：在拆分期间会首选在 splitchar 之前的拆分点，字符的优先级是基于它们在字符串中的出现顺序。 字符串中可包含空格和制表符以指明当其他拆分字符未在被拆分行中出现时是否要将某个字符作为优先于另一个字符的首选拆分点。 拆分字符不会影响以 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 编码的行。

如果给出 maxlinelen，它将覆盖实例的最大行长度值。

linesep 指定用来分隔已折叠标头行的字符。 它默认为 Python 应用程序代码中最常用的值 (\n)，但也可以指定为 \r\n 以便产生带有符合 RFC 的行分隔符的标头。

在 3.2 版更改: 增加了 linesep 参数。

Header 类还提供了一些方法以支持标准运算符和内置函数。

__str__()

以字符串形式返回 Header 的近似表示，使用不受限制的行长度。 所有部分都会使用指定编码格式转换为 unicode 并适当地连接起来。 任何带有 'unknown-8bit' 字符集的部分都会使用 'replace' 错误处理程序解码为 ASCII。

在 3.2 版更改: 增加对 'unknown-8bit' 字符集的处理。

__eq__(other)

这个方法允许你对两个 Header 实例进行相等比较。

__ne__(other)

这个方法允许你对两个 Header 实例进行不等比较。

email.header 模块还提供了下列便捷函数。

email.header.decode_header(header)

在不转换字符集的情况下对消息标头值进行解码。 header 为标头值。

这个函数返回一个 (decoded_string, charset) 对的列表，其中包含标头的每个已解码部分。 对于标头的未编码部分 charset 为 None，在其他情况下则为一个包含已编码字符串中所指定字符集名称的小写字符串。

以下是为示例代码:

>>> from email.header import decode_header
>>> decode_header('=?iso-8859-1?q?p=F6stal?=')
[(b'p\xf6stal', 'iso-8859-1')]

email.header.make_header(decoded_seq, maxlinelen=None, header_name=None, continuation_ws=' ')

基于 decode_header() 所返回的数据对序列创建一个 Header 实例。

decode_header() 接受一个标头值字符串并返回格式为 (decoded_string, charset) 的数据对序列，其中 charset 是字符集名称。

这个函数接受这样的数据对序列并返回一个 Header 实例。 可选的 maxlinelen, header_name 和 continuation_ws 与 Header 构造器中的含义相同。

email.charset: 表示字符集

源代码: Lib/email/charset.py [https://github.com/python/cpython/tree/3.10/Lib/email/charset.py]

此模块是旧版 (Compat32) email API 的组成部分。 在新版 API 中只会使用其中的别名表。

本节中的其余文本是此模块的原始文档。

此模块提供了一个 Charset 类用来表示电子邮件消息中的字符集和字符集转换操作，以及一个字符集注册表和几个用于操作此注册表的便捷方法。 Charset 的实例在 email 包的其他几个模块中也有使用。

请从 email.charset 模块导入这个类。

class email.charset.Charset(input_charset=DEFAULT_CHARSET)

将字符集映射到其 email 特征属性。

这个类提供了特定字符集对于电子邮件的要求的相关信息。 考虑到适用编解码器的可用性，它还为字符集之间的转换提供了一些便捷例程。 在给定字符集的情况下，它将尽可能地以符合 RFC 的方式在电子邮件消息中提供有关如何使用该字符集的信息。

特定字符集当在电子邮件标头或消息体中使用时必须以 quoted-printable 或 base64 来编码。 某些字符集则必须被立即转换，不允许在电子邮件中使用。

可选的 input_charset 说明如下；它总是会被强制转为小写。 在进行别名正规化后它还会被用来查询字符集注册表以找出用于该字符集的标头编码格式、消息体编码格式和输出转换编解码器。 举例来说，如果 input_charset 为 iso-8859-1，则标头和消息体将会使用 quoted-printable 来编码并且不需要输出转换编解码器。 如果 input_charset 为 euc-jp，则标头将使用 base64 来编码，消息体将不会被编码，但输出文本将从 euc-jp 字符集转换为 iso-2022-jp 字符集。

Charset 实例具有下列数据属性:

input_charset

指定的初始字符集。 通用别名会被转换为它们的 官方 电子邮件名称 (例如 latin_1 会被转换为 iso-8859-1)。 默认值为 7 位 us-ascii。

header_encoding

如果字符集在用于电子邮件标头之前必须被编码，此属性将被设为 charset.QP (表示 quoted-printable 编码格式), charset.BASE64 (表示 base64 编码格式) 或 charset.SHORTEST 表示 QP 或 BASE64 编码格式中最简短的一个。 在其他情况下，该属性将为 None。

body_encoding

与 header_encoding 一样，但是用来描述电子邮件消息体的编码格式，它实际上可以与标头编码格式不同。 charset.SHORTEST 不允许被用作 body_encoding。

output_charset

某些字符集在用于电子邮件标头或消息体之前必须被转换。 如果 input_charset 是这些字符集之一，该属性将包含输出将要转换的字符集名称。 在其他情况下，该属性将为 None。

input_codec

用于将 input_charset 转换为 Unicode 的 Python 编解码器名称。 如果不需要任何转换编解码器，该属性将为 None。

output_codec

用于将 Unicode 转换为 output_charset 的 Python 编解码器名称。 如果不需要任何转换编解码器，该属性将具有与 input_codec 相同的值。

Charset 实例还有下列方法:

get_body_encoding()

返回用于消息体编码的内容转换编码格式。

根据所使用的编码格式返回 quoted-printable 或 base64，或是返回一个函数，在这种情况下你应当调用该函数并附带一个参数，即被编码的消息对象。 该函数应当自行将 Content-Transfer-Encoding 标头设为适当的值。

如果 body_encoding 为 QP 则返回字符串 quoted-printable，如果 body_encoding 为 BASE64 则返回字符串 base64，并在其他情况下返回字符串 7bit。

get_output_charset()

返回输出字符集。

如果 output_charset 属性不为 None 则返回该属性，否则返回 input_charset。

header_encode(string)

对字符串 string 执行标头编码。

编码格式的类型 (base64 或 quoted-printable) 将取决于 header_encoding 属性。

header_encode_lines(string, maxlengths)

通过先将 string 转换为字节串来对其执行标头编码。

这类似于 header_encode()，区别是字符串会被调整至参数 maxlengths 所给出的最大行长度，它应当是一个迭代器：该迭代器返回的每个元素将提供下一个最大行长度。

body_encode(string)

对字符串 string 执行消息体编码。

编码格式的类型 (base64 或 quoted-printable) 将取决于 body_encoding 属性。

Charset 类还提供了一些方法以支持标准运算和内置函数。

__str__()

将 input_charset 以强制转为小写的字符串形式返回。 __repr__() 是 __str__() 的别名。

__eq__(other)

这个方法允许你对两个 Charset 实例进行相等比较。

__ne__(other)

这个方法允许你对两个 Charset 实例进行相等比较。

email.charset 模块还提供了下列函数用于向全局字符集、别名以及编解码器注册表添加新条目:

email.charset.add_charset(charset, header_enc=None, body_enc=None, output_charset=None)

向全局注册表添加字符特征属性。

charset 是输入字符集，它必须为某个字符集的正规名称。

可选的 header_enc 和 body_enc 可以是 charset.QP 表示 quoted-printable 编码格式, charset.BASE64 表示 base64 编码格式, charset.SHORTEST 表示 quoted-printable 或 base64 编码格式中较短的一个，或者为 None 表示没有编码格式。 SHORTEST 仅对 header_enc 有效。 默认值为 None 表示没有编码格式。

可选的 output_charset 是输出所应当采用的字符集。 当 Charset.convert() 方法被调用时将会执行从输入字符集到输出字符集的转换。 默认情况下输出字符集将与输入字符集相同。

input_charset 和 output_charset 都必须在模块的字符集-编解码器映射中具有 Unicode 编解码器条目；使用 add_codec() 可添加本模块还不知道的编解码器。 请参阅 codecs 模块的文档来了解更多信息。

全局字符集注册表保存在模块全局字典 CHARSETS 中。

email.charset.add_alias(alias, canonical)

添加一个字符集别名。 alias 为特定的别名，例如 latin-1。 canonical 是字符集的正规名称，例如 iso-8859-1。

全局字符集注册表保存在模块全局字典 ALIASES 中。

email.charset.add_codec(charset, codecname)

添加在给定字符集的字符和 Unicode 之间建立映射的编解码器。

charset 是某个字符集的正规名称。 codecname 是某个 Python 编解码器的名称，可以被用来作为 str 的 encode() 方法的第二个参数。

email.encoders: 编码器

源代码: Lib/email/encoders.py [https://github.com/python/cpython/tree/3.10/Lib/email/encoders.py]

此模块是旧版 (Compat32) email API 的组成部分。 在新版 API 中将由 set_content() 方法的 cte 形参提供该功能。

此模块在 Python 3 中已弃用。 这里提供的函数不应被显式地调用，因为 MIMEText 类会在类实例化期间使用 _subtype 和 _charset 值来设置内容类型和 CTE 标头。

本节中的其余文本是此模块的原始文档。

当创建全新的 Message 对象时，你经常需要对载荷编码以便通过兼容的邮件服务器进行传输。 对于包含二进制数据的 image/* 和 text/* 类型的消息来说尤其如此。

email 包在其 encoders 模块中提供了一些方便的编码器。 这些编码器实际上由 MIMEAudio 和 MIMEImage 类构造器所使用以提供默认编码格式。 所有编码器函数都只接受一个参数，即要编码的消息对象。 它们通常会提取有效载荷，对其进行编码，并将载荷重置为这种新编码的值。 它们还应当相应地设置 Content-Transfer-Encoding 标头。

请注意，这些函数对于多段消息没有意义。 它们必须应用到各个单独的段上面，而不是整体。如果直接传递一个多段类型的消息，会产生一个 TypeError 错误。

下面是提供的编码函数：

email.encoders.encode_quopri(msg)

将有效数据编码为经转换的可打印形式，并将 Content-Transfer-Encoding 标头设置为 quoted-printable 1。 当大多数实际的数据是普通的可打印数据但包含少量不可打印的字符时，这是一个很好的编码。

email.encoders.encode_base64(msg)

将有效载荷编码为 base64 形式，并将 Content-Transfer-Encoding 标头设为 base64。 当你的载荷主要包含不可打印数据时这是一种很好用的编码格式，因为它比 quoted-printable 更紧凑。 base64 编码格式的缺点是它会使文本变成人类不可读的形式。

email.encoders.encode_7or8bit(msg)

此函数并不实际改变消息的有效载荷，但它会基于载荷数据将 Content-Transfer-Encoding 标头相应地设为 7bit 或 8bit。

email.encoders.encode_noop(msg)

此函数什么都不会做；它甚至不会设置 Content-Transfer-Encoding 标头。

备注

1

请注意使用 encode_quopri() 编码格式还会对数据中的所有制表符和空格符进行编码。

email.utils: 其他工具

源代码: Lib/email/utils.py [https://github.com/python/cpython/tree/3.10/Lib/email/utils.py]

email.utils 模块提供如下几个工具

email.utils.localtime(dt=None)

以感知型 datetime 对象返回当地时间。 如果调用时参数为空，则返回当前时间。 否则 dt 参数应该是一个 datetime 实例，并根据系统时区数据库转换为当地时区。 如果 dt 是简单型的 （即 dt.tzinfo 是 None )，则假定为当地时间。 在这种情况下，为正值或零的 isdst 会使 localtime 假定夏季时间（例如，夏令时）对指定时间（分别）生效或不生效。 负值 isdst 会使 localtime 预测夏季时间对指定时间是否生效。

3.3 新版功能.

email.utils.make_msgid(idstring=None, domain=None)

返回一个适合作为兼容 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 的 Message-ID 标头的字符串。可选参数 idstring 可传入一字符串以增强该消息 ID 的唯一性。可选参数 domain 可用于提供消息 ID 中字符 '@' 之后的部分，其默认值是本机的主机名。正常情况下无需覆盖此默认值，但在特定情况下覆盖默认值可能会有用，比如构建一个分布式系统，在多台主机上采用一致的域名。

在 3.2 版更改: 增加了关键字 domain

下列函数是旧（Compat32）电子邮件 API 的一部分。新 API 提供的解析和格式化在标头解析机制中已经被自动完成，故在使用新 API 时没有必要直接使用它们函数。

email.utils.quote(str)

返回一个新的字符串， str 中的反斜杠被替换为两个反斜杠，并且双引号被替换为反斜杠加双引号。

email.utils.unquote(str)

返回 str 被去除引用版本的字符串。如果 str 开头和结尾均是双引号，则这对双引号被去除。类似地，如果 str 开头和结尾都是尖角括号，这对尖角括号会被去除。

email.utils.parseaddr(address, *, strict=True)

将地址（应为诸如 To 或者 Cc 之类包含地址的字段值）解析为构成之的 真实名字 和 电子邮件地址 部分。返回包含这两个信息的一个元组；如若解析失败，则返回一个二元组 ('', '') 。

如果 strict 为真值，将使用拒绝错误形式输入的严格解析器。

在 3.10.15 版更改: 增加了 strict 可选形参并将默认拒绝错误形式输入。

email.utils.formataddr(pair, charset='utf-8')

是 parseaddr() 的逆操作，接受一个 (真实名字, 电子邮件地址) 的二元组，并返回适合于 To or Cc 标头的字符串。如果第一个元素为假性值，则第二个元素将被原样返回。

可选地，如果指定 charset，则被视为一符合 RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] 的编码字符集，用于编码 真实名字 中的非 ASCII 字符。可以是一个 str 类的实例，或者一个 Charset 类。默认为 utf-8 。

在 3.3 版更改: 添加了 charset 选项。

email.utils.getaddresses(fieldvalues, *, strict=True)

该方法返回一个与 parseaddr() 返回值形式相同的 2 元组。 fieldvalues 是与 Message.get_all 返回值形式相同的由标头字段值组成的序列。

如果 strict 为真值，将使用拒绝错误形式输入的严格解析器。

下面简单示例可获取一条消息的所有接收方:

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)

在 3.10.15 版更改: 增加了 strict 可选形参并将默认拒绝错误形式输入。

email.utils.parsedate(date)

尝试根据 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 的规则解析一个日期。然而，有些寄信人不严格遵守这一格式，所以这种情况下 parsedate() 会尝试猜测其形式。date 是一个字符串包含了一个形如 "Mon, 20 Nov 1995 19:12:08 -0500" 的 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 格式日期。如果日期解析成功， parsedate() 将返回一个九元组，可直接传递给 time.mktime()；否则返回 None。注意返回的元组中下标为 6、7、8 的部分是无用的。

email.utils.parsedate_tz(date)

执行与 parsedate() 相同的功能，但会返回 None 或是一个 10 元组；前 9 个元素构成一个可以直接传给 time.mktime() 的元组，而第十个元素则是该日期的时区与 UTC (格林威治平均时 GMT 的正式名称) 1 的时差。 如果输入字符串不带时区，则所返回元组的最后一个元素将为 0，这表示 UTC。 请注意结果元组的索引号 6, 7 和 8 是不可用的。

email.utils.parsedate_to_datetime(date)

format_datetime() 的逆操作。 执行与 parsedate() 相同的功能，但会在成功时返回一个 datetime；否则如果 date 包含无效的值例如小时值大于 23 或时区偏移量不在 -24 和 24 时范围之内则会引发 ValueError。 如果输入日期的时区值为 -0000，则 datetime 将为一个简单形 datetime，而如果日期符合 RFC 标准则它将代表一个 UTC 时间，但是并不指明日期所在消息的实际源时区。 如果输入日期具有任何其他有效的时区偏移量，则 datetime 将是一个感知型 datetime 并与 timezone tzinfo 相对应。

3.3 新版功能.

email.utils.mktime_tz(tuple)

将 parsedate_tz() 所返回的 10 元组转换为一个 UTC 时间戳（相距 Epoch 纪元初始的秒数）。 如果元组中的时区项为 None，则视为当地时间。

email.utils.formatdate(timeval=None, localtime=False, usegmt=False)

返回 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 标准的日期字符串，例如:

Fri, 09 Nov 2001 01:08:47 -0000

可选的 timeval 如果给出，则是一个可被 time.gmtime() 和 time.localtime() 接受的浮点数时间值，否则会使用当前时间。

可选的 localtime 是一个旗标，当为 True 时，将会解析 timeval，并返回一个相对于当地时区而非 UTC 的日期值，并会适当地考虑夏令时。 默认值 False 表示使用 UTC。

可选的 usegmt 是一个旗标，当为 True 时，将会输出一个日期字符串，其中时区表示为 ascii 字符串 GMT 而非数字形式的 -0000。 这对某些协议（例如 HTTP）来说是必要的。 这仅在 localtime 为 False 时应用。 默认值为 False。

email.utils.format_datetime(dt, usegmt=False)

类似于 formatdate，但输入的是一个 datetime 实例。 如果实例是一个简单型 datetime，它会被视为 "不带源时区信息的 UTC"，并且使用传统的 -0000 作为时区。 如果实例是一个感知型 datetime，则会使用数字形式的时区时差。 如果实例是感知型且时区时差为零，则 usegmt 可能会被设为 True，在这种情况下将使用字符串 GMT 而非数字形式的时区时差。 这提供了一种生成符合标准 HTTP 日期标头的方式。

3.3 新版功能.

email.utils.decode_rfc2231(s)

根据 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 解码字符串 s。

email.utils.encode_rfc2231(s, charset=None, language=None)

根据 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 对字符串 s 进行编码。 可选的 charset 和 language 如果给出，则为指明要使用的字符集名称和语言名称。 如果两者均未给出，则会原样返回 s。 如果给出 charset 但未给出 language，则会使用空字符串作为 language 值来对字符串进行编码。

email.utils.collapse_rfc2231_value(value, errors='replace', fallback_charset='us-ascii')

当以 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 格式来编码标头形参时，Message.get_param 可能返回一个包含字符集、语言和值的 3 元组。 collapse_rfc2231_value() 会将此返回为一个 unicode 字符串。 可选的 errors 会被传递给 str 的 encode() 方法的 errors 参数；它的默认值为 'replace'。 可选的 fallback_charset 指定当 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 标头中的字符集无法被 Python 识别时要使用的字符集；它的默认值为 'us-ascii'。

为方便起见，如果传给 collapse_rfc2231_value() 的 value 不是一个元组，则应为一个字符串并会将其原样返回。

email.utils.decode_params(params)

根据 RFC 2231 [https://datatracker.ietf.org/doc/html/rfc2231.html] 解码参数列表。 params 是一个包含 (content-type, string-value) 形式的元素的 2 元组的序列。

备注

1

请注意时区时差的符号与同一时区的 time.timezone 变量的符号相反；后者遵循 POSIX 标准而此模块遵循 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html]。

email.iterators: 迭代器

源代码: Lib/email/iterators.py [https://github.com/python/cpython/tree/3.10/Lib/email/iterators.py]

通过 Message.walk 方法来迭代消息对象树是相当容易的。 email.iterators 模块提供了一些适用于消息对象树的高层级迭代器。

email.iterators.body_line_iterator(msg, decode=False)

此函数会迭代 msg 的所有子部分中的所有载荷，逐行返回字符串载荷。 它会跳过所有子部分的标头，并且它也会跳过任何包含不为 Python 字符串的载荷的子部分。 这基本上等价于使用 readline() 从一个文件读取消息的纯文本表示形式，并跳过所有中间的标头。

可选的 decode 会被传递给 Message.get_payload。

email.iterators.typed_subpart_iterator(msg, maintype='text', subtype=None)

此函数会迭代 msg 的所有子部分，只返回其中与 maintype 和 subtype 所指定的 MIME 类型相匹配的子部分。

请注意 subtype 是可选项；如果省略，则仅使用主类型来进行子部分 MIME 类型的匹配。 maintype 也是可选项；它的默认值为 text。

因此，在默认情况下 typed_subpart_iterator() 会返回每一个 MIME 类型为 text/* 的子部分。

增加了以下函数作为有用的调试工具。 它 不应当 被视为该包所支持的公共接口的组成部分。

email.iterators._structure(msg, fp=None, level=0, include_default=False)

打印消息对象结构的内容类型的缩进表示形式。 例如:

>>> 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

可选项 fp 是一个作为打印输出目标的文件型对象。 它必须适用于 Python 的 print() 函数。 level 是供内部使用的。 include_default 如果为真值，则会同时打印默认类型。

json --- JSON 编码和解码器

源代码: Lib/json/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/json/__init__.py]

JSON (JavaScript Object Notation) [http://json.org]，由 RFC 7159 [https://datatracker.ietf.org/doc/html/rfc7159.html] (它取代了 RFC 4627 [https://datatracker.ietf.org/doc/html/rfc4627.html]) 和 ECMA-404 [http://www.ecma-international.org/publications/standards/Ecma-404.htm] 指定，是一个受 JavaScript [https://en.wikipedia.org/wiki/JavaScript] 的对象字面值句法启发的轻量级数据交换格式，尽管它不仅仅是一个严格意义上的 JavaScript 的子集 1。

警告

在解析来自不受信任恶劣的 JSON 数据时要小心谨慎。 恶意的 JSON 字符串可能导致解码器消耗大量 CPU 和内存资源。 建议对要解析的数据大小进行限制。

json 提供了与标准库 marshal 和 pickle 相似的API接口。

对基本的 Python 对象层次结构进行编码：

>>> 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"]'

紧凑编码：

>>> import json
>>> json.dumps([1, 2, 3, {'4': 5, '6': 7}], separators=(',', ':'))
'[1,2,3,{"4":5,"6":7}]'

美化输出：

>>> import json
>>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))
{
    "4": 5,
    "6": 7
}

JSON解码：

>>> 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']

特殊 JSON 对象解码：

>>> 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')

扩展 JSONEncoder：

>>> 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 json.JSONEncoder.default(self, 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', ']']

从命令行使用 json.tool 来验证并美化输出：

$ echo '{"json":"obj"}' | python -m json.tool
{
    "json": "obj"
}
$ echo '{1.2:3.4}' | python -m json.tool
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

详细文档请参见 命令行界面。

注解

JSON 是 YAML [https://yaml.org/] 1.2 的一个子集。 由该模块的默认设置所产生的 JSON（尤其是默认的 separators 值）也是 YAML 1.0 和 1.1 的一个子集。 因此该模块也能被用作 YAML 序列化器。

注解

这个模块的编码器和解码器默认保护输入和输出的顺序。仅当底层的容器未排序时才会失去顺序。

基本使用

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)

使用这个 转换表 将 obj 序列化为 JSON 格式化流形式的 fp (支持 .write() 的 file-like object)。

如果 skipkeys 是 true （默认为 False），那么那些不是基本对象（包括 str, int、float、bool、None）的字典的键会被跳过；否则引发一个 TypeError。

json 模块始终产生 str 对象而非 bytes 对象。因此，fp.write() 必须支持 str 输入。

如果 ensure_ascii 是 true （即默认值），输出保证将所有输入的非 ASCII 字符转义。如果 ensure_ascii 是 false，这些字符会原样输出。

如果 check_circular 是为假值 (默认为 True)，那么容器类型的循环引用检验会被跳过并且循环引用会引发一个 RecursionError (或者更糟的情况)。

如果 allow_nan 是 false（默认为 True），那么在对严格 JSON 规格范围外的 float 类型值（nan、inf 和 -inf）进行序列化时会引发一个 ValueError。如果 allow_nan 是 true，则使用它们的 JavaScript 等价形式（NaN、Infinity 和 -Infinity）。

如果 indent 是一个非负整数或者字符串，那么 JSON 数组元素和对象成员会被美化输出为该值指定的缩进等级。 如果缩进等级为零、负数或者 ""，则只会添加换行符。 None (默认值) 选择最紧凑的表达。 使用一个正整数会让每一层缩进同样数量的空格。 如果 indent 是一个字符串 (比如 "\t")，那个字符串会被用于缩进每一层。

在 3.2 版更改: 现允许使用字符串作为 indent 而不再仅仅是整数。

当被指定时，separators 应当是一个 (item_separator, key_separator) 元组。当 indent 为 None 时，默认值取 (', ', ': ')，否则取 (',', ': ')。为了得到最紧凑的 JSON 表达式，你应该指定其为 (',', ':') 以消除空白字符。

在 3.4 版更改: 现当 indent 不是 None 时，采用 (',', ': ') 作为默认值。

当 default 被指定时，其应该是一个函数，每当某个对象无法被序列化时它会被调用。它应该返回该对象的一个可以被 JSON 编码的版本或者引发一个 TypeError。如果没有被指定，则会直接引发 TypeError。

如果 sort_keys 是 true（默认为 False），那么字典的输出会以键的顺序排序。

为了使用一个自定义的 JSONEncoder 子类（比如：覆盖了 default() 方法来序列化额外的类型）， 通过 cls 关键字参数来指定；否则将使用 JSONEncoder。

在 3.6 版更改: 所有可选形参现在都是 仅限关键字参数。

注解

与 pickle 和 marshal 不同，JSON 不是一个具有框架的协议，所以尝试多次使用同一个 fp 调用 dump() 来序列化多个对象会产生一个不合规的 JSON 文件。

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)

使用这个 转换表 将 obj 序列化为 JSON 格式的 str。 其参数的含义与 dump() 中的相同。

注解

JSON 中的键-值对中的键永远是 str 类型的。当一个对象被转化为 JSON 时，字典中所有的键都会被强制转换为字符串。这所造成的结果是字典被转换为 JSON 然后转换回字典时可能和原来的不相等。换句话说，如果 x 具有非字符串的键，则有 loads(dumps(x)) != x。

json.load(fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

使用这个 转换表 将 fp (一个支持 .read() 并包含一个 JSON 文档的 text file 或者 binary file) 反序列化为一个 Python 对象。

object_hook 是一个将附带任意已解码的对象字面值 (即 dict) 来调用的可选函数。 object_hook 的返回值会代替 dict 使用。 此特性可被用于实现自定义解码器 (例如 JSON-RPC [https://www.jsonrpc.org] 的类型提示)。

object_pairs_hook 是一个可选的函数，它会被调用于每一个有序列表对解码出的对象字面量。 object_pairs_hook 的返回值将会取代原本的 dict 。这一特性能够被用于实现自定义解码器。如果 object_hook 也被定义， object_pairs_hook 优先。

在 3.1 版更改: 添加了对 object_pairs_hook 的支持。

parse_float ，如果指定，将与每个要解码 JSON 浮点数的字符串一同调用。默认状态下，相当于 float(num_str) 。可以用于对 JSON 浮点数使用其它数据类型和语法分析程序 （比如 decimal.Decimal ）。

parse_int ，如果指定，将与每个要解码 JSON 整数的字符串一同调用。默认状态下，相当于 int(num_str) 。可以用于对 JSON 整数使用其它数据类型和语法分析程序 （比如 float ）。

在 3.10.7 版更改: 现在 int() 默认的 parse_int 会通过解释器的 整数字符串长度上限 来限制整数字符串的最大长度以帮助避免拒绝服务攻击。

parse_constant ，如果指定，将要与以下字符串中的一个一同调用： '-Infinity' ， 'Infinity' ， 'NaN' 。如果遇到无效的 JSON 数字则可以使用它引发异常。

在 3.1 版更改: parse_constant 不再调用 'null' ， 'true' ， 'false' 。

要使用自定义的 JSONDecoder 子类，用 cls 指定他；否则使用 JSONDecoder 。额外的关键词参数会通过类的构造函数传递。

如果反序列化的数据不是有效 JSON 文档，引发 JSONDecodeError 错误。

在 3.6 版更改: 所有可选形参现在都是 仅限关键字参数。

在 3.6 版更改: fp 现在可以是 binary file 。输入编码应当是 UTF-8 ， UTF-16 或者 UTF-32 。

json.loads(s, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

使用这个 转换表 将 s (一个包含 JSON 文档的 str, bytes 或 bytearray 实例) 反序列化为 Python 对象。

其他参数的含义与 load() 中的相同。

如果反序列化的数据不是有效 JSON 文档，引发 JSONDecodeError 错误。

在 3.6 版更改: s 现在可以为 bytes 或 bytearray 类型。 输入编码应为 UTF-8, UTF-16 或 UTF-32。

在 3.9 版更改: 关键字参数 encoding 已被移除。

编码器和解码器

class json.JSONDecoder(*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)

简单的JSON解码器。

默认情况下，解码执行以下翻译:

JSON | Python
object -- 对象 | dict
array | list
string | str
number (int) | int
number (real) | float
true | True
false | False
null | None

它还将“NaN”、“Infinity”和“-Infinity”理解为它们对应的“float”值，这超出了JSON规范。

如果指定了 object_hook，它将附带每个已解码 JSON 对象的结果来调用并将被用于替代给定的 dict。 这可被用于提供自定义的反序列化操作（例如支持 JSON-RPC [https://www.jsonrpc.org] 类提示）。

如果指定了 object_pairs_hook 则它将被调用并传入以对照值有序列表进行解码的每个 JSON 对象的结果。 object_pairs_hook 的结果值将被用来替代 dict。 这一特性可被用于实现自定义解码器。 如果还定义了 object_hook，则 object_pairs_hook 的优先级更高。

在 3.1 版更改: 添加了对 object_pairs_hook 的支持。

parse_float ，如果指定，将与每个要解码 JSON 浮点数的字符串一同调用。默认状态下，相当于 float(num_str) 。可以用于对 JSON 浮点数使用其它数据类型和语法分析程序 （比如 decimal.Decimal ）。

parse_int ，如果指定，将与每个要解码 JSON 整数的字符串一同调用。默认状态下，相当于 int(num_str) 。可以用于对 JSON 整数使用其它数据类型和语法分析程序 （比如 float ）。

parse_constant ，如果指定，将要与以下字符串中的一个一同调用： '-Infinity' ， 'Infinity' ， 'NaN' 。如果遇到无效的 JSON 数字则可以使用它引发异常。

如果 strict 为 false （默认为 True ），那么控制字符将被允许在字符串内。在此上下文中的控制字符编码在范围 0--31 内的字符，包括 '\t' (制表符）， '\n' ， '\r' 和 '\0' 。

如果反序列化的数据不是有效 JSON 文档，引发 JSONDecodeError 错误。

在 3.6 版更改: 所有形参现在都是 仅限关键字参数。

decode(s)

返回 s 的 Python 表示形式（包含一个 JSON 文档的 str 实例）。

如果给定的 JSON 文档无效则将引发 JSONDecodeError。

raw_decode(s)

从 s 中解码出 JSON 文档（以 JSON 文档开头的一个 str 对象）并返回一个 Python 表示形式为 2 元组以及指明该文档在 s 中结束位置的序号。

这可以用于从一个字符串解码JSON文档，该字符串的末尾可能有无关的数据。

class json.JSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

用于Python数据结构的可扩展JSON编码器。

默认支持以下对象和类型：

Python | JSON
dict | object -- 对象
list, tuple | array
str | string
int, float, int 和 float 派生的枚举 | 数字
True | true
False | false
None | null

在 3.4 版更改: 添加了对 int 和 float 派生的枚举类的支持

为了将其拓展至识别其他对象，需要子类化并实现 default() 方法于另一种返回 o 的可序列化对象的方法如果可行，否则它应该调用超类实现（来引发 TypeError ）。

如果 skipkeys 为假值（默认），则当尝试对非 str, int, float 或 None 的键进行编码时将会引发 TypeError。 如果 skipkeys 为真值，这些条目将被直接跳过。

如果 ensure_ascii 是 true （即默认值），输出保证将所有输入的非 ASCII 字符转义。如果 ensure_ascii 是 false，这些字符会原样输出。

如果 check_circular 为 true （默认），那么列表，字典，和自定义编码的对象在编码期间会被检查重复循环引用防止无限递归（无限递归将导致 RecursionError ）。否则，这样进行检查。

如果 allow_nan 为 true （默认），那么 NaN ， Infinity ，和 -Infinity 进行编码。此行为不符合 JSON 规范，但与大多数的基于 Javascript 的编码器和解码器一致。否则，它将是一个 ValueError 来编码这些浮点数。

如果 sort_keys 为 true （默认为： False ），那么字典的输出是按照键排序；这对回归测试很有用，以确保可以每天比较 JSON 序列化。

如果 indent 是一个非负整数或者字符串，那么 JSON 数组元素和对象成员会被美化输出为该值指定的缩进等级。 如果缩进等级为零、负数或者 ""，则只会添加换行符。 None (默认值) 选择最紧凑的表达。 使用一个正整数会让每一层缩进同样数量的空格。 如果 indent 是一个字符串 (比如 "\t")，那个字符串会被用于缩进每一层。

在 3.2 版更改: 现允许使用字符串作为 indent 而不再仅仅是整数。

当被指定时，separators 应当是一个 (item_separator, key_separator) 元组。当 indent 为 None 时，默认值取 (', ', ': ')，否则取 (',', ': ')。为了得到最紧凑的 JSON 表达式，你应该指定其为 (',', ':') 以消除空白字符。

在 3.4 版更改: 现当 indent 不是 None 时，采用 (',', ': ') 作为默认值。

当 default 被指定时，其应该是一个函数，每当某个对象无法被序列化时它会被调用。它应该返回该对象的一个可以被 JSON 编码的版本或者引发一个 TypeError。如果没有被指定，则会直接引发 TypeError。

在 3.6 版更改: 所有形参现在都是 仅限关键字参数。

default(o)

在子类中实现这种方法使其返回 o 的可序列化对象，或者调用基础实现（引发 TypeError ）。

例如，为了支持任意的迭代器，你可以这样来实现 default():

def default(self, o):
   try:
       iterable = iter(o)
   except TypeError:
       pass
   else:
       return list(iterable)
   # Let the base class default method raise the TypeError
   return json.JSONEncoder.default(self, o)

encode(o)

返回 Python o 数据结构的 JSON 字符串表达方式。例如:

>>> json.JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'

iterencode(o)

编码给定对象 o ，并且让每个可用的字符串表达方式。例如:

for chunk in json.JSONEncoder().iterencode(bigobject):
    mysocket.write(chunk)

异常

exception json.JSONDecodeError(msg, doc, pos)

拥有以下附加属性的 ValueError 的子类：

msg

未格式化的错误消息。

doc

正在解析的 JSON 文档。

pos

The start index of doc where parsing failed.

lineno

The line corresponding to pos.

colno

The column corresponding to pos.

3.5 新版功能.

标准符合性和互操作性

JSON 格式由 RFC 7159 [https://datatracker.ietf.org/doc/html/rfc7159.html] 和 ECMA-404 [http://www.ecma-international.org/publications/standards/Ecma-404.htm] 指定。此段落详细讲了这个模块符合 RFC 的级别。简单来说， JSONEncoder 和 JSONDecoder 子类，和明确提到的参数以外的参数，不作考虑。

此模块不严格遵循于 RFC ，它实现了一些扩展是有效的 Javascript 但不是有效的 JSON。尤其是：

无限和 NaN 数值是被接受并输出；

对象内的重复名称是接受的，并且仅使用最后一对属性-值对的值。

自从 RFC 允许符合 RFC 的语法分析程序接收 不符合 RFC 的输入文本以来，这个模块的解串器在默认状态下默认符合 RFC 。

字符编码

RFC 要求使用 UTF-8 ， UTF-16 ，或 UTF-32 之一来表示 JSON ，为了最大互通性推荐使用 UTF-8 。

RFC允许，尽管不是必须的，这个模块的序列化默认设置为 ensure_ascii=True ，这样消除输出以便结果字符串至容纳 ASCII 字符。

ensure_ascii 参数以外，此模块是严格的按照在 Python 对象和 Unicode strings 间的转换定义的，并且因此不能直接解决字符编码的问题。

RFC 禁止添加字符顺序标记（ BOM ）在 JSON 文本的开头，这个模块的序列化器不添加 BOM 标记在它的输出上。 RFC，准许 JSON 反序列化器忽略它们输入中的初始 BOM 标记，但不要求。此模块的反序列化器引发 ValueError 当存在初始 BOM 标记。

RFC 不会明确禁止包含字节序列的 JSON 字符串这不对应有效的 Unicode 字符（比如 不成对的 UTF-16 的替代物），但是它确实指出它们可能会导致互操作性问题。默认下，模块对这样的序列接受和输出（当在原始 str 存在时）代码点。

Infinite 和 NaN 数值

RFC 不允许 infinite 或者 NaN 数值的表达方式。尽管这样，默认情况下，此模块接受并且输出 Infinity ， -Infinity，和 NaN 好像它们是有效的JSON数字字面值

>>> # Neither of these calls raises an exception, but the results are not valid JSON
>>> json.dumps(float('-inf'))
'-Infinity'
>>> json.dumps(float('nan'))
'NaN'
>>> # Same when deserializing
>>> json.loads('-Infinity')
-inf
>>> json.loads('NaN')
nan

序列化器中， allow_nan 参数可用于替代这个行为。反序列化器中， parse_constant 参数，可用于替代这个行为。

对象中的重复名称

RFC 具体说明了 在 JSON对象里的名字应该是唯一的，但没有规定如何处理JSON对象中的重复名称。默认下，此模块不引发异常；作为替代，对于给定名它将忽略除姓-值对之外的所有对:

>>> weird_json = '{"x": 1, "x": 2, "x": 3}'
>>> json.loads(weird_json)
{'x': 3}

The object_pairs_hook parameter can be used to alter this behavior.

顶级非对象，非数组值

过时的 RFC 4627 [https://datatracker.ietf.org/doc/html/rfc4627.html] 指定的旧版本 JSON 要求 JSON 文本顶级值必须是 JSON 对象或数组（ Python dict 或 list ），并且不能是 JSON null 值，布尔值，数值或者字符串值。 RFC 7159 [https://datatracker.ietf.org/doc/html/rfc7159.html] 移除这个限制，此模块没有并且从未在序列化器和反序列化器中实现这个限制。

无论如何，为了最大化地获取互操作性，你可能希望自己遵守该原则。

实现限制

一些 JSON 反序列化器的实现应该在以下方面做出限制：

可接受的 JSON 文本大小

嵌套 JSON 对象和数组的最高水平

JSON 数字的范围和精度

JSON 字符串的内容和最大长度

此模块不强制执行任何上述限制，除了相关的 Python 数据类型本身或者 Python 解释器本身的限制以外。

当序列化为 JSON ，在应用中当心此类限制这可能破坏你的 JSON 。特别是，通常将 JSON 数字反序列化为 IEEE 754 双精度数字，从而受到该表示方式的范围和精度限制。这是特别相关的，当序列化非常大的 Python int 值时，或者当序列化 "exotic" 数值类型的实例时比如 decimal.Decimal 。

命令行界面

源代码： Lib/json/tool.py [https://github.com/python/cpython/tree/3.10/Lib/json/tool.py]

The json.tool module provides a simple command line interface to validate and pretty-print JSON objects.

如果未指定可选的 infile 和 outfile 参数，则将分别使用 sys.stdin 和 sys.stdout:

$ echo '{"json": "obj"}' | python -m json.tool
{
    "json": "obj"
}
$ echo '{1.2:3.4}' | python -m json.tool
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

在 3.5 版更改: 输出现在将与输入顺序保持一致。 请使用 --sort-keys 选项来将输出按照键的字母顺序排序。

命令行选项

infile

要被验证或美化打印的 JSON 文件：

$ python -m json.tool mp_films.json
[
    {
        "title": "And Now for Something Completely Different",
        "year": 1971
    },
    {
        "title": "Monty Python and the Holy Grail",
        "year": 1975
    }
]

如果 infile 未指定，则从 sys.stdin 读取。

outfile

将 infile 输出写入到给定的 outfile。 在其他情况下写入到 sys.stdout。

--sort-keys

将字典输出按照键的字母顺序排序。

3.5 新版功能.

--no-ensure-ascii

禁用非 ASCII 字符的转义，详情参见 json.dumps()。

3.9 新版功能.

--json-lines

将每个输入行解析为单独的 JSON 对象。

3.8 新版功能.

--indent, --tab, --no-indent, --compact

用于空白符控制的互斥选项。

3.9 新版功能.

-h, --help

显示帮助消息。

备注

1

正如 RFC 7159 的勘误表 [https://www.rfc-editor.org/errata_search.php?rfc=7159] 所说明的，JSON 允许以字符串表示字面值字符 U+2028 (LINE SEPARATOR) 和 U+2029 (PARAGRAPH SEPARATOR)，而 JavaScript (在 ECMAScript 5.1 版中) 不允许。

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

源代码： Lib/mailbox.py [https://github.com/python/cpython/tree/3.10/Lib/mailbox.py]

本模块定义了两个类，Mailbox 和 Message，用于访问和操作磁盘中的邮箱及其所包含的电子邮件。 Mailbox 提供了类似字典的从键到消息的映射。 Message 为 email.message 模块的 Message 类增加了特定格式专属的状态和行为。 支持的邮箱格式有 Maildir, mbox, MH, Babyl 以及 MMDF。

参见

模块 email

表示和操作邮件消息。

Mailbox 对象

class mailbox.Mailbox

一个邮箱，它可以被检视和修改。

Mailbox 类定义了一个接口并且它不应被实例化。 而是应该让格式专属的子类继承 Mailbox 并且你的代码应当实例化一个特定的子类。

Mailbox 接口类似于字典，其中每个小键都有对应的消息。 键是由 Mailbox 实例发出的，它们将由实例来使用并且只对该 Mailbox 实例有意义。 键会持续标识一条消息，即使对应的消息已被修改，例如被另一条消息所替代。

可以使用 set 型方法 add() 将消息添加到 Mailbox 并可以使用 del 语句或 set 型方法 remove() 和 discard() 将其移除。

Mailbox 接口语义在某些值得注意的方面与字典语义有所不同。 每次请求消息时，都会基于邮箱的当前状态生成一个新的表示形式（通常为 Message 实例）。 类似地，当向 Mailbox 实例添加消息时，所提供的消息表示形式的内容将被复制。 无论在哪种情况下 Mailbox 实例都不会保留对消息表示形式的引用。

默认的 Mailbox 迭代器会迭代消息表示形式，而不像默认的字典迭代器那样迭代键。 此外，在迭代期间修改邮箱是安全且有明确定义的。 在创建迭代器之后被添加到邮箱的消息将对该迭代不可见。 在迭代器产出消息之前被从邮箱移除的消息将被静默地跳过，但是使用来自迭代器的键也有可能导致 KeyError 异常，如果对应的消息后来被移除的话。

警告

在修改可能同时被其他某个进程修改的邮箱时要非常小心。 用于此种任务的最安全邮箱格式是 Maildir；请尽量避免使用 mbox 之类的单文件格式进行并发写入。 如果你正在修改一个邮箱，你 必须 在读取文件中的任何消息或者执行添加或删除消息等修改操作 之前 通过调用 lock() 以及 unlock() 方法来锁定它。 如果未锁定邮箱则将导致丢失消息或损坏整个邮箱的风险。

Mailbox 实例具有下列方法:

add(message)

将 message 添加到邮箱并返回分配给它的键。

形参 message 可以是 Message 实例、email.message.Message 实例、字符串、字节串或文件型对象（应当以二进制模式打开）。 如果 message 是适当的格式专属 Message 子类的实例（举例来说，如果它是一个 mboxMessage 实例而这是一个 mbox 实例），将使用其格式专属的信息。 在其他情况下，则会使用合理的默认值作为格式专属的信息。

在 3.2 版更改: 增加了对二进制输入的支持。

remove(key)

__delitem__(key)

discard(key)

从邮箱中删除对应于 key 的消息。

当消息不存在时，如果此方法是作为 remove() 或 __delitem__() 调用则会引发 KeyError 异常，而如果此方法是作为 discard() 调用则不会引发异常。 如果下层邮箱格式支持来自其他进程的并发修改则 discard() 的行为可能是更为适合的。

__setitem__(key, message)

将 key 所对应的消息替换为 message。 如果没有与 key 所对应的消息则会引发 KeyError 异常。

与 add() 一样，形参 message 可以是 Message 实例、email.message.Message 实例、字符串、字节串或文件型对象（应当以二进制模式打开）。 如果 message 是适当的格式专属 Message 子类的实例（举例来说，如果它是一个 mboxMessage 实例而这是一个 mbox 实例），将使用其格式专属的信息。 在其他情况下，当前与 key 所对应的消息的格式专属信息则会保持不变。

iterkeys()

keys()

如果通过 iterkeys() 调用则返回一个迭代所有键的迭代器，或者如果通过 keys() 调用则返回一个键列表。

itervalues()

__iter__()

values()

如果通过 itervalues() 或 __iter__() 调用则返回一个迭代所有消息的表示形式的迭代器，或者如果通过 values() 调用则返回一个由这些表示形式组成的列表。 消息会被表示为适当的格式专属 Message 子类的实例，除非当 Mailbox 实例被初始化时指定了自定义的消息工厂函数。

注解

__iter__() 的行为与字典不同，后者是对键进行迭代。

iteritems()

items()

如果通过 iteritems() 调用则返回一个迭代 (key, message) 对的迭代器，其中 key 为键而 message 为消息的表示形式，或者如果通过 items() 调用则返回一个由这种键值对组成的列表。 消息会被表示为适当的格式专属 Message 子类的实例，除非当 Mailbox 实例被初始化时指定了自定义的消息工厂函数。

get(key, default=None)

__getitem__(key)

返回对应于 key 的消息的表示形式。 当对应的消息不存在时，如果通过 get() 调用则返回 default 而如果通过 __getitem__() 调用此方法则会引发 KeyError 异常。 消息会被表示为适当的格式专属 Message 子类的实例，除非当 Mailbox 实例被初始化时指定了自定义的消息工厂函数。

get_message(key)

将对应于 key 的消息的表示形式作为适当的格式专属 Message 子类的实例返回，或者如果对应的消息不存在则会引发 KeyError 异常。

get_bytes(key)

返回对应于 key 的消息的字节表示形式，或者如果对应的消息不存在则会引发 KeyError 异常。

3.2 新版功能.

get_string(key)

返回对应于 key 的消息的字符串表示形式，或者如果对应的消息不存在则会引发 KeyError 异常。 消息是通过 email.message.Message 处理来将其转换为纯 7bit 表示形式的。

get_file(key)

返回对应于 key 的消息的文件类表示形式，或者如果对应的消息不存在则会引发 KeyError 异常。 文件类对象的行为相当于以二进制模式打开。 当不再需要此文件时应当将其关闭。

在 3.2 版更改: 此文件对象实际上是二进制文件；之前它被不正确地以文本模式返回。 并且，此文件类对象现在还支持上下文管理协议：你可以使用 with 语句来自动关闭它。

注解

不同于其他消息表示形式，文件类表示形式并不一定独立于创建它们的 Mailbox 实例或下层的邮箱。 每个子类都会提供更具体的文档。

__contains__(key)

如果 key 有对应的消息则返回 True，否则返回 False。

__len__()

返回邮箱中消息的数量。

clear()

从邮箱中删除所有消息。

pop(key, default=None)

返回对应于 key 的消息的表示形式并删除该消息。 如果对应的消息不存在则返回 default。 消息会被表示为适当的格式专属 Message 子类的实例，除非当 Mailbox 实例被初始化时指定了自定义的消息工厂函数。

popitem()

返回一个任意的 (key, message) 对，其中 key 为键而 message 为消息的表示形式，并删除对应的消息。 如果邮箱为空，则会引发 KeyError 异常。 消息会被表示为适当的格式专属 Message 子类的实例，除非当 Mailbox 实例被初始化时指定了自定义的消息工厂函数。

update(arg)

形参 arg 应当是 key 到 message 的映射或 (key, message) 对的可迭代对象。 用来更新邮箱以使得对于每个给定的 key 和 message，与 key 相对应的消息会被设为 message，就像通过使用 __setitem__() 一样。 类似于 __setitem__()，每个 key 都必须在邮箱中有一个对应的消息否则将会引发 KeyError 异常，因此在通常情况下将 arg 设为 Mailbox 实例是不正确的。

注解

与字典不同，关键字参数是不受支持的。

flush()

将所有待定的更改写入到文件系统。 对于某些 Mailbox 子类来说，更改总是被立即写入因而 flush() 并不会做任何事，但您仍然应当养成调用此方法的习惯。

lock()

在邮箱上获取一个独占式咨询锁以使其他进程知道不能修改它。 如果锁无法被获取则会引发 ExternalClashError。 所使用的具体锁机制取决于邮箱的格式。 在对邮箱内容进行任何修改之前你应当 总是 锁定它。

unlock()

释放邮箱上的锁，如果存在的话。

close()

刷新邮箱，如果必要则将其解锁。 并关闭所有打开的文件。 对于某些 Mailbox 子类来说，此方法并不会做任何事。

Maildir

class mailbox.Maildir(dirname, factory=None, create=True)

Mailbox 的一个子类，用于 Maildir 格式的邮箱。 形参 factory 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 factory 为 None，则会使用 MaildirMessage 作为默认的消息表示形式。 如果 create 为 True，则当邮箱不存在时会创建它。

如果 create 为 True 且 dirname 路径存在，它将被视为已有的 maildir 而无需尝试验证其目录布局。

使用 dirname 这个名称而不使用 path 是出于历史原因。

Maildir 是一种基于目录的邮箱格式，它是针对 qmail 邮件传输代理而发明的，现在也得到了其他程序的广泛支持。 Maildir 邮箱中的消息存储在一个公共目录结构中的单独文件内。 这样的设计允许 Maildir 邮箱被多个彼此无关的程序访问和修改而不会导致数据损坏，因此文件锁定操作是不必要的。

Maildir 邮箱包含三个子目录，分别是: tmp, new 和 cur。 消息会不时地在 tmp 子目录中创建然后移至 new 子目录来结束投递。 后续电子邮件客户端可能将消息移至 cur 子目录并将有关消息状态的信息存储在附带到其文件名的特殊 "info" 小节中。

Courier 电子邮件传输代理所引入的文件夹风格也是受支持的。 主邮箱中任何子目录只要其名称的第一个字符是 '.' 就会被视为文件夹。 文件夹名称会被 Maildir 表示为不带前缀 '.' 的形式。 每个文件夹自身都是一个 Maildir 邮箱但不应包含其他文件夹。 逻辑嵌套关系是使用 '.' 来划定层级，例如 "Archived.2005.07"。

注解

Maildir 规范要求使用在特定消息文件名中使用冒号 (':')。 但是，某些操作系统不允许将此字符用于文件名，如果你希望在这些操作系统上使用类似 Maildir 的格式，你应当指定改用另一个字符。 叹号 ('!') 是一个受欢迎的选择。 例如:

import mailbox
mailbox.Maildir.colon = '!'

colon 属性也可以在每个实例上分别设置。

Maildir 实例具有 Mailbox 的所有方法及下列附加方法:

list_folders()

返回所有文件夹名称的列表。

get_folder(folder)

返回表示名称为 folder 的文件夹的 Maildir 实例。 如果文件夹不存在则会引发 NoSuchMailboxError 异常。

add_folder(folder)

创建名称为 folder 的文件夹并返回表示它的 Maildir 实例。

remove_folder(folder)

删除名称为 folder 的文件夹。 如果文件夹包含任何消息，则将引发 NotEmptyError 异常且该文件夹将不会被删除。

clean()

从邮箱中删除最近 36 小时内未被访问过的临时文件。 Maildir 规范要求邮件阅读程序应当时常进行此操作。

Maildir 所实现的某些 Mailbox 方法值得进行特别的说明:

add(message)

__setitem__(key, message)

update(arg)

警告

这些方法会基于当前进程 ID 来生成唯一文件名。 当使用多线程时，可能发生未被检测到的名称冲突并导致邮箱损坏，除非是对线程进行协调以避免使用这些方法同时操作同一个邮箱。

flush()

对 Maildir 邮箱的所有更改都会立即被应用，所以此方法并不会做任何事情。

lock()

unlock()

Maildir 邮箱不支持（或要求）锁定操作，所以此方法并不会做任何事情。

close()

Maildir 实例不保留任何打开的文件并且下层的邮箱不支持锁定操作，所以此方法不会做任何事情。

get_file(key)

根据主机平台的不同，当返回的文件保持打开状态时可能无法修改或移除下层的消息。

参见

maildir man page from Courier [https://www.courier-mta.org/maildir.html]

该格式的规格说明。 描述了用于支持文件夹的通用扩展。

使用 maildir 格式 [https://cr.yp.to/proto/maildir.html]

Maildir 发明者对它的说明。 包括已更新的名称创建方案和 "info" 语义的相关细节。

mbox

class mailbox.mbox(path, factory=None, create=True)

Mailbox 的子类，用于 mbox 格式的邮箱。 形参 factory 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 factory 为 None，则会使用 mboxMessage 作为默认的消息表示形式。 如果 create 为 True，则当邮箱不存在时会创建它。

mbox 格式是在 Unix 系统上存储电子邮件的经典格式。 mbox 邮箱中的所有消息都存储在一个单独文件中，每条消息的开头由前五个字符为 "From " 的行来指明。

还有一些 mbox 格式变种对原始格式中发现的缺点做了改进，mbox 只实现原始格式，有时被称为 mboxo。 这意味着当存储消息时 Content-Length 标头如果存在则会被忽略并且消息体中出现于行开头的任何 "From " 会被转换为 ">From "，但是当读取消息时 ">From " 则不会被转换为 "From "。

mbox 所实现的某些 Mailbox 方法值得进行特别的说明:

get_file(key)

在 mbox 实例上调用 flush() 或 close() 之后再使用文件可能产生无法预料的结果或者引发异常。

lock()

unlock()

使用三种锁机制 --- dot 锁，以及可能情况下的 flock() 和 lockf() 系统调用。

参见

tin 上的 mbox 指南页面 [http://www.tin.org/bin/man.cgi?section=5&topic=mbox]

该格式的规格说明，包括有关锁的详情。

在 Unix 上配置 Netscape Mail: 为何 Content-Length 格式是不好的 [https://www.jwz.org/doc/content-length.html]

使用原始 mbox 格式而非其变种的一些理由。

"mbox" 是由多个彼此不兼容的邮箱格式构成的家族 [https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml]

有关 mbox 变种的历史。

MH

class mailbox.MH(path, factory=None, create=True)

Mailbox 的子类，用于 MH 格式的邮箱。 形参 factory 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 factory 为 None，则会使用 MHMessage 作为默认的消息表示形式。 如果 create 为 True，则当邮箱不存在时会创建它。

MH 是一种基于目录的邮箱格式，它是针对 MH Message Handling System 电子邮件用户代理而发明的。 在 MH 邮箱的每条消息都放在单独文件中。 MH 邮箱中除了邮件消息还可以包含其他 MH 邮箱 (称为 文件夹)。 文件夹可以无限嵌套。 MH 邮箱还支持 序列，这是一种命名列表，用来对消息进行逻辑分组而不必将其移入子文件夹。 序列是在每个文件夹中名为 .mh_sequences 的文件内定义的。

MH 类可以操作 MH 邮箱，但它并不试图模拟 mh 的所有行为。 特别地，它并不会修改 context 或 .mh_profile 文件也不会受其影响，这两个文件是 mh 用来存储状态和配置数据的。

MH 实例具有 Mailbox 的所有方法及下列附加方法:

list_folders()

返回所有文件夹名称的列表。

get_folder(folder)

返回表示名称为 folder 的文件夹的 MH 实例。 如果文件夹不存在则会引发 NoSuchMailboxError 异常。

add_folder(folder)

创建名称为 folder 的文件夹并返回表示它的 MH 实例。

remove_folder(folder)

删除名称为 folder 的文件夹。 如果文件夹包含任何消息，则将引发 NotEmptyError 异常且该文件夹将不会被删除。

get_sequences()

返回映射到键列表的序列名称字典。 如果不存在任何序列，则返回空字典。

set_sequences(sequences)

根据由映射到键列表的名称组成的字典 sequences 来重新定义邮箱中的序列，该字典与 get_sequences() 返回值的形式一样。

pack()

根据需要重命名邮箱中的消息以消除序号中的空缺。 序列列表中的条目会做相应的修改。

注解

已发送的键会因此操作而失效并且不应当被继续使用。

MH 所实现的某些 Mailbox 方法值得进行特别的说明:

remove(key)

__delitem__(key)

discard(key)

这些方法会立即删除消息。 通过在名称前加缀一个冒号作为消息删除标记的 MH 惯例不会被使用。

lock()

unlock()

使用三种锁机制 --- dot 锁，以及可能情况下下 flock() 和 lockf() 系统调用。 对于 MH 邮箱来说，锁定邮箱意味着锁定 .mh_sequences 文件，并且仅在执行会影响单独消息文件的操作期间锁定单独消息文件。

get_file(key)

根据主机平台的不同，当返回的文件保持打开状态时可能无法移除下层的消息。

flush()

对 MH 邮箱的所有更改都会立即被应用，所以此方法并不会做任何事情。

close()

MH 实例不保留任何打开的文件，所以此方法等价于 unlock()。

参见

nmh - Message Handling System [https://www.nongnu.org/nmh/]

nmh 的主页，这是原始 mh 的更新版本。

MH & nmh: Email for Users & Programmers [https://rand-mh.sourceforge.io/book/]

使用 GPL 许可证的介绍 mh 与 nmh 的图书，包含有关该邮箱格式的各种信息。

Babyl

class mailbox.Babyl(path, factory=None, create=True)

Mailbox 的子类，用于 Babyl 格式的邮箱。 形参 factory 是一个可调用对象，它接受一个文件类表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 factory 为 None，则会使用 BabylMessage 作为默认的消息表示形式。 如果 create 为 True，则当邮箱不存在时会创建它。

Babyl 是 Rmail 电子邮箱用户代理所使用单文件邮箱格式，包括在 Emacs 中。 每条消息的开头由一个包含 Control-Underscore ('\037') 和 Control-L ('\014') 这两个字符的行来指明。 消息的结束由下一条消息的开头来指明，或者当为最后一条消息时则由一个包含 Control-Underscore ('\037') 字符的行来指明。

Babyl 邮箱中的消息带有两组标头：原始标头和所谓的可见标头。 可见标头通常为原始标头经过重格式化和删减以更易读的子集。 Babyl 邮箱中的每条消息都附带了一个 标签 列表，即记录消息相关额外信息的短字符串，邮箱中所有的用户定义标签列表会存储于 Babyl 的选项部分。

Babyl 实例具有 Mailbox 的所有方法及下列附加方法:

get_labels()

返回邮箱中使用的所有用户定义标签名称的列表。

注解

邮箱中存在哪些标签会通过检查实际的消息而非查询 Babyl 选项部分的标签列表，但 Babyl 选项部分会在邮箱被修改时更新。

Babyl 所实现的某些 Mailbox 方法使得进行特别的说明:

get_file(key)

在 Babyl 邮箱中，消息的标头并不是与消息体存储在一起的。 要生成文件类表示形式，标头和消息体会被一起拷贝到一个 io.BytesIO 实例中，它具有与文件相似的 API。 因此，文件型对象实际上独立于下层邮箱，但与字符串表达形式相比并不会更节省内存。

lock()

unlock()

使用三种锁机制 --- dot 锁，以及可能情况下的 flock() 和 lockf() 系统调用。

参见

Format of Version 5 Babyl Files [https://quimby.gnus.org/notes/BABYL]

Babyl 格式的规格说明。

Reading Mail with Rmail [https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html]

Rmail 的帮助手册，包含了有关 Babyl 语义的一些信息。

MMDF

class mailbox.MMDF(path, factory=None, create=True)

Mailbox 的子类，用于 MMDF 格式的邮箱。 形参 factory 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 factory 为 None，则会使用 MMDFMessage 作为默认的消息表示形式。 如果 create 为 True，则当邮箱不存在时会创建它。

MMDF 是一种专用于电子邮件传输代理 Multichannel Memorandum Distribution Facility 的单文件邮箱格式。 每条消息使用与 mbox 消息相同的形式，但其前后各有包含四个 Control-A ('\001') 字符的行。 与 mbox 格式一样，每条消息的开头由一个前五个字符为 "From " 的行来指明，但当存储消息时额外出现的 "From " 不会被转换为 ">From " 因为附加的消息分隔符可防止将这些内容误认为是后续消息的开头。

MMDF 所实现的某些 Mailbox 方法值得进行特别的说明:

get_file(key)

在 MMDF 实例上调用 flush() 或 close() 之后再使用文件可能产生无法预料的结果或者引发异常。

lock()

unlock()

使用三种锁机制 --- dot 锁，以及可能情况下的 flock() 和 lockf() 系统调用。

参见

tin 上的 mmdf 指南页面 [http://www.tin.org/bin/man.cgi?section=5&topic=mmdf]

MMDF 格式的规格说明，来自新闻阅读器 tin 的文档。

MMDF [https://en.wikipedia.org/wiki/MMDF]

一篇描述 Multichannel Memorandum Distribution Facility 的维基百科文章。

Message 对象

class mailbox.Message(message=None)

email.message 模块的 Message 的子类。 mailbox.Message 的子类添加了特定邮箱格式专属的状态和行为。

如果省略了 message，则新实例会以默认的空状态被创建。 如果 message 是一个 email.message.Message 实例，其内容会被拷贝；此外，如果 message 是一个 Message 实例，则任何格式专属信息会尽可能地被拷贝。 如果 message 是一个字符串、字节串或文件，则它应当包含兼容 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 的消息，该消息会被读取和解析。 文档应当以二进制模式打开，但文本模式的文件也会被接受以向下兼容。

各个子类所提供的格式专属状态和行为各有不同，但总的来说只有那些不仅限于特定邮箱的特性才会被支持（虽然这些特性可能专属于特定邮箱格式）。 例如，例如，单文件邮箱格式的文件偏移量和基于目录的邮箱格式的文件名都不会被保留，因为它们都仅适用于对应的原始邮箱。 但消息是否已被用户读取或标记为重要等状态则会被保留，因为它们适用于消息本身。

不要求用 Message 实例来表示使用 Mailbox 实例所提取到的消息。 在某些情况下，生成 Message 表示形式所需的时间和内存空间可能是不可接受的。 对于此类情况，Mailbox 实例还提供了字符串和文件类表示形式，并可在初始化 Mailbox 实例时指定自定义的消息工厂函数。

MaildirMessage

class mailbox.MaildirMessage(message=None)

具有 Maildir 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

通常，邮件用户代理应用程序会在用户第一次打开并关闭邮箱之后将 new 子目录中的所有消息移至 cur 子目录，将这些消息记录为旧消息，无论它们是否真的已被阅读。 cur 下的每条消息都有一个 "info" 部分被添加到其文件名中以存储有关其状态的信息。 （某些邮件阅读器还会把 "info" 部分也添加到 new 下的消息中。） "info" 部分可以采用两种形式之一：它可能包含 "2," 后面跟一个经标准化的旗标列表（例如 "2,FR"）或者它可能包含 "1," 后面跟所谓的实验性信息。 Maildir 消息的标准旗标如下:

标志位 | 含意 | 说明
D | 草稿 | 正在撰写中
F | 已标记 | 已被标记为重要
P | 已检视 | 转发，重新发送或退回
R | 已回复 | 回复给
S | 已查看 | 已阅读
T | 已删除 | 标记为可被删除

MaildirMessage 实例提供以下方法：

get_subdir()

返回 "new" (如果消息应当被存储在 new 子目录下) 或者 "cur" (如果消息应当被存储在 cur 子目录下)。

注解

消息通常会在其邮箱被访问后被从 new 移至 cur，无论该消息是否已被阅读。如果 "S" in msg.get_flags() 为 True 则说明消息 msg 已被阅读。

set_subdir(subdir)

设置消息应当被存储到的子目录。 形参 subdir 必须为 "new" 或 "cur"。

get_flags()

返回一个指明当前所设旗标的字符串。 如果消息符合标准的 Maildir 格式，则结果为零或按字母顺序各自出现一次的 'D', 'F', 'P', 'R', 'S' 和 'T' 的拼接。 如果未设任何旗标或者如果 "info" 包含实验性语义则返回空字符串。

set_flags(flags)

设置由 flags 所指定的旗标并重置所有其它旗标。

add_flag(flag)

设置由 flag 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，flag 可以为包含一个以上字符的字符串。 当前 "info" 会被覆盖，无论它是否只包含实验性信息而非旗标。

remove_flag(flag)

重置由 flag 所指明的旗标而不改变其他旗标。 要一次性移除一个以上的旗标，flag 可以为包含一个以上字符的字符串。 如果 "info" 包含实验性信息而非旗标，则当前的 "info" 不会被修改。

get_date()

以表示 Unix 纪元秒数的浮点数形式返回消息的发送日期。

set_date(date)

将消息的发送日期设为 date，一个表示 Unix 纪元秒数的浮点数。

get_info()

返回一个包含消息的 "info" 的字符串。 这适用于访问和修改实验性的 "info" (即不是由旗标组成的列表)。

set_info(info)

将 "info" 设为 info，这应当是一个字符串。

当一个 MaildirMessage 实例基于 mboxMessage 或 MMDFMessage 实例被创建时，将会忽略 Status 和 X-Status 标头并进行下列转换:

结果状态 | mboxMessage 或 MMDFMessage 状态
"cur" 子目录 | O 旗标
F 旗标 | F 旗标
R 旗标 | A 旗标
S 旗标 | R 旗标
T 旗标 | D 旗标

当一个 MaildirMessage 实例基于 MHMessage 实例被创建时，将进行下列转换:

结果状态 | MHMessage 状态
"cur" 子目录 | "unseen" 序列
"cur" 子目录和 S 旗标 | 非 "unseen" 序列
F 旗标 | "flagged" 序列
R 旗标 | "replied" 序列

当一个 MaildirMessage 实例基于 BabylMessage 实例被创建时，将进行下列转换:

结果状态 | BabylMessage 状态
"cur" 子目录 | "unseen" 标签
"cur" 子目录和 S 旗标 | 非 "unseen" 标签
P 旗标 | "forwarded" 或 "resent" 标签
R 旗标 | "answered" 标签
T 旗标 | "deleted" 标签

mboxMessage

class mailbox.mboxMessage(message=None)

具有 mbox 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

mbox 邮箱中的消息会一起存储在单个文件中。 发件人的信封地址和发送时间通常存储在指明每条消息的起始的以 "From " 打头的行中，不过在 mbox 的各种实现之间此数据的确切格式具有相当大的差异。 指明消息状态的各种旗标，例如是否已读或标记为重要等等通常存储在 Status 和 X-Status 标头中。

传统的 mbox 消息旗标如下:

标志位 | 含意 | 说明
R | 已阅读 | 已阅读
O | 旧消息 | 之前已经过 MUA 检测
D | 已删除 | 标记为可被删除
F | 已标记 | 已被标记为重要
A | 已回复 | 回复给

"R" 和 "O" 旗标存储在 Status 标头中，而 "D", "F" 和 "A" 旗标存储在 X-Status 标头中。 旗标和标头通常会按上述顺序显示。

mboxMessage 实例提供了下列方法:

get_from()

返回一个表示在 mbox 邮箱中标记消息起始的 "From " 行的字符串。 开头的 "From " 和末尾的换行符会被去除。

set_from(from_, time_=None)

将 "From " 行设为 from_，这应当被指定为不带开头的 "From " 或末尾的换行符。 为方便起见，可以指定 time_ 并将经过适当的格式化再添加到 from_。 如果指定了 time_，它应当是一个 time.struct_time 实例，适合传入 time.strftime() 的元组或者 True (以使用 time.gmtime())。

get_flags()

返回一个指明当前所设旗标的字符串。 如果消息符合规范格式，则结果为零或各自出现一次的 'R', 'O', 'D', 'F' 和 'A' 按上述顺序的拼接。

set_flags(flags)

设置由 flags 所指明的旗标并重启所有其他旗标。 形参 flags 应当为零或各自出现多次的 'R', 'O', 'D', 'F' 和 'A' 按任意顺序的拼接。

add_flag(flag)

设置由 flag 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，flag 可以为包含一个以上字符的字符串。

remove_flag(flag)

重置由 flag 所指明的旗标而不改变其他旗标。 要一次性移除一个以上的旗标，flag 可以为包含一个以上字符的字符串。

当一个 mboxMessage 实例基于 MaildirMessage 实例被创建时，"From " 行会基于 MaildirMessage 实例的发送时间被生成，并进行下列转换:

结果状态 | MaildirMessage 状态
R 旗标 | S 旗标
O 旗标 | "cur" 子目录
D 旗标 | T 旗标
F 旗标 | F 旗标
A 旗标 | R 旗标

当一个 mboxMessage 实例基于 MHMessage 实例被创建时，将进行下列转换:

结果状态 | MHMessage 状态
R 旗标 和 O 旗标 | 非 "unseen" 序列
O 旗标 | "unseen" 序列
F 旗标 | "flagged" 序列
A 旗标 | "replied" 序列

当一个 mboxMessage 实例基于 BabylMessage 实例被创建时，将进行下列转换:

结果状态 | BabylMessage 状态
R 旗标 和 O 旗标 | 非 "unseen" 标签
O 旗标 | "unseen" 标签
D 旗标 | "deleted" 标签
A 旗标 | "answered" 标签

当一个 Message 实例基于 MMDFMessage 实例被创建时，"From " 行会被拷贝并直接对应所有旗标。

结果状态 | MMDFMessage 状态
R 旗标 | R 旗标
O 旗标 | O 旗标
D 旗标 | D 旗标
F 旗标 | F 旗标
A 旗标 | A 旗标

MHMessage

class mailbox.MHMessage(message=None)

具有 MH 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

MH 消息不支持传统意义上的标记或旗标，但它们支持序列，即对任意消息的逻辑分组。 某些邮件阅读程序 (但不包括标准 mh 和 nmh) 以与其他格式使用旗标类似的方式来使用序列，如下所示:

序列 | 说明
unseen | 未阅读，但之前已经过 MUA 检测
已回复 | 回复给
已标记 | 已被标记为重要

MHMessage 实例提供了下列方法:

get_sequences()

返回一个包含此消息的序列的名称的列表。

set_sequences(sequences)

设置包含此消息的序列的列表。

add_sequence(sequence)

将 sequence 添加到包含此消息的序列的列表。

remove_sequence(sequence)

将 sequence 从包含此消息的序列的列表中移除。

当一个 MHMessage 实例基于 MaildirMessage 实例被创建时，将进行下列转换:

结果状态 | MaildirMessage 状态
"unseen" 序列 | 非 S 旗标
"replied" 序列 | R 旗标
"flagged" 序列 | F 旗标

当一个 MHMessage 实例基于 mboxMessage 或 MMDFMessage 实例被创建时，将会忽略 Status 和 X-Status 标头并进行下列转换:

结果状态 | mboxMessage 或 MMDFMessage 状态
"unseen" 序列 | 非 R 旗标
"replied" 序列 | A 旗标
"flagged" 序列 | F 旗标

当一个 MHMessage 实例基于 BabylMessage 实例被创建时，将进入下列转换:

结果状态 | BabylMessage 状态
"unseen" 序列 | "unseen" 标签
"replied" 序列 | "answered" 标签

BabylMessage

class mailbox.BabylMessage(message=None)

具有 Babyl 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

某些消息标签被称为 属性，根据惯例被定义为具有特殊的含义。 这些属性如下所示:

标签 | 说明
unseen | 未阅读，但之前已经过 MUA 检测
deleted | 标记为可被删除
filed | 复制到另一个文件或邮箱
answered | 回复给
forwarded | 已转发
edited | 已被用户修改
resent | 已重发

默认情况下，Rmail 只显示可见标头。 不过 BabylMessage 类会使用原始标头因为它们更完整。 如果需要可以显式地访问可见标头。

BabylMessage 实例提供了下列方法:

get_labels()

返回邮件上的标签列表。

set_labels(labels)

将消息上的标签列表设置为 labels 。

add_label(label)

将 label 添加到消息上的标签列表中。

remove_label(label)

从消息上的标签列表中删除 label 。

get_visible()

返回一个 Message 实例，其标头为消息的可见标头而其消息体为空。

set_visible(visible)

将消息的可见标头设为与 message 中的标头一致。 形参 visible 应当是一个 Message 实例，email.message.Message 实例，字符串或文件型对象（且应当以文本模式打开）。

update_visible()

当一个 BabylMessage 实例的原始标头被修改时，可见标头不会自动进行对应修改。 此方法将按以下方式更新可见标头：每个具有对应原始标头的可见标头会被设为原始标头的值，每个没有对应原始标头的可见标头会被移除，而任何存在于原始标头但不存在于可见标头中的 Date, From, Reply-To, To, CC 和 Subject 会被添加至可见标头。

当一个 BabylMessage 实例基于 MaildirMessage 实例被创建时，将进行下列转换:

结果状态 | MaildirMessage 状态
"unseen" 标签 | 非 S 旗标
"deleted" 标签 | T 旗标
"answered" 标签 | R 旗标
"forwarded" 标签 | P 旗标

当一个 BabylMessage 实例基于 mboxMessage 或 MMDFMessage 实例被创建时，将会忽略 Status 和 X-Status 标头并进入下列转换:

结果状态 | mboxMessage 或 MMDFMessage 状态
"unseen" 标签 | 非 R 旗标
"deleted" 标签 | D 旗标
"answered" 标签 | A 旗标

当一个 BabylMessage 实例基于 MHMessage 实例被创建时，将进入下列转换:

结果状态 | MHMessage 状态
"unseen" 标签 | "unseen" 序列
"answered" 标签 | "replied" 序列

MMDFMessage

class mailbox.MMDFMessage(message=None)

具有 MMDF 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

与 mbox 邮箱中的消息类似，MMDF 消息会与将发件人的地址和发送日期作为以 "From " 打头的初始行一起存储。 同样地，指明消息状态的旗标通常存储在 Status 和 X-Status 标头中。

传统的 MMDF 消息旗标与 mbox 消息的类似，如下所示:

标志位 | 含意 | 说明
R | 已阅读 | 已阅读
O | 旧消息 | 之前已经过 MUA 检测
D | 已删除 | 标记为可被删除
F | 已标记 | 已被标记为重要
A | 已回复 | 回复给

"R" 和 "O" 旗标存储在 Status 标头中，而 "D", "F" 和 "A" 旗标存储在 X-Status 标头中。 旗标和标头通常会按上述顺序显示。

MMDFMessage 实例提供了下列方法，与 mboxMessage 所提供的类似:

get_from()

返回一个表示在 mbox 邮箱中标记消息起始的 "From " 行的字符串。 开头的 "From " 和末尾的换行符会被去除。

set_from(from_, time_=None)

将 "From " 行设为 from_，这应当被指定为不带开头的 "From " 或末尾的换行符。 为方便起见，可以指定 time_ 并将经过适当的格式化再添加到 from_。 如果指定了 time_，它应当是一个 time.struct_time 实例，适合传入 time.strftime() 的元组或者 True (以使用 time.gmtime())。

get_flags()

返回一个指明当前所设旗标的字符串。 如果消息符合规范格式，则结果为零或各自出现一次的 'R', 'O', 'D', 'F' 和 'A' 按上述顺序的拼接。

set_flags(flags)

设置由 flags 所指明的旗标并重启所有其他旗标。 形参 flags 应当为零或各自出现多次的 'R', 'O', 'D', 'F' 和 'A' 按任意顺序的拼接。

add_flag(flag)

设置由 flag 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，flag 可以为包含一个以上字符的字符串。

remove_flag(flag)

重置由 flag 所指明的旗标而不改变其他旗标。 要一次性移除一个以上的旗标，flag 可以为包含一个以上字符的字符串。

当一个 MMDFMessage 实例基于 MaildirMessage 实例被创建时，"From " 行会基于 MaildirMessage 实例的发送日期被生成，并进入下列转换:

结果状态 | MaildirMessage 状态
R 旗标 | S 旗标
O 旗标 | "cur" 子目录
D 旗标 | T 旗标
F 旗标 | F 旗标
A 旗标 | R 旗标

当一个 MMDFMessage 实例基于 MHMessage 实例被创建时，将进行下列转换:

结果状态 | MHMessage 状态
R 旗标 和 O 旗标 | 非 "unseen" 序列
O 旗标 | "unseen" 序列
F 旗标 | "flagged" 序列
A 旗标 | "replied" 序列

当一个 MMDFMessage 实例基于 BabylMessage 实例被创建时，将进行下列转换:

结果状态 | BabylMessage 状态
R 旗标 和 O 旗标 | 非 "unseen" 标签
O 旗标 | "unseen" 标签
D 旗标 | "deleted" 标签
A 旗标 | "answered" 标签

当一个 MMDFMessage 实例基于 mboxMessage 实例被创建时，"From " 行会被拷贝并直接对应所有旗标:

结果状态 | mboxMessage 状态
R 旗标 | R 旗标
O 旗标 | O 旗标
D 旗标 | D 旗标
F 旗标 | F 旗标
A 旗标 | A 旗标

异常

mailbox 模块中定义了下列异常类:

exception mailbox.Error

所有其他模块专属异常的基类。

exception mailbox.NoSuchMailboxError

在期望获得一个邮箱但未找到时被引发，例如当使用不存在的路径来实例化一个 Mailbox 子类时 (且将 create 形参设为 False)，或是当打开一个不存在的路径时。

exception mailbox.NotEmptyError

在期望一个邮箱为空但不为空时被引发，例如当删除一个包含消息的文件夹时。

exception mailbox.ExternalClashError

在某些邮箱相关条件超出了程序控制范围导致其无法继续运行时被引发，例如当要获取的锁已被另一个程序获取时，或是当要生成的唯一性文件名已存在时等等。

exception mailbox.FormatError

在某个文件中的数据无法被解析时被引发，例如当一个 MH 实例尝试读取已损坏的 .mh_sequences 文件时。

例子

一个打印指定邮箱中所有消息的主题的简单示例:

import mailbox
for message in mailbox.mbox('~/mbox'):
    subject = message['subject']       # Could possibly be None.
    if subject and 'python' in subject.lower():
        print(subject)

要将所有邮件从 Babyl 邮箱拷贝到 MH 邮箱，请转换所有可转换的格式专属信息:

import mailbox
destination = mailbox.MH('~/Mail')
destination.lock()
for message in mailbox.Babyl('~/RMAIL'):
    destination.add(mailbox.MHMessage(message))
destination.flush()
destination.unlock()

这个示例将来自多个邮件列表的邮件分类放入不同的邮箱，小心避免由于其他程序的并发修改导致的邮件损坏，由于程序中断导致的邮件丢失，或是由于邮箱中消息格式错误导致的意外终止:

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                # The message is malformed. Just leave it.

    for name in list_names:
        list_id = message['list-id']
        if list_id and name in list_id:
            # Get mailbox to use
            box = boxes[name]

            # Write copy to disk before removing original.
            # If there's a crash, you might duplicate a message, but
            # that's better than losing a message completely.
            box.lock()
            box.add(message)
            box.flush()
            box.unlock()

            # Remove original message
            inbox.lock()
            inbox.discard(key)
            inbox.flush()
            inbox.unlock()
            break               # Found destination, so stop looking.

for box in boxes.itervalues():
    box.close()

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

源代码: Lib/mimetypes.py [https://github.com/python/cpython/tree/3.10/Lib/mimetypes.py]

mimetypes 模块可以在文件名或 URL 和关联到文件扩展名的 MIME 类型之间执行转换。 所提供的转换包括从文件名到 MIME 类型和从 MIME 类型到文件扩展名；后一种转换不支持编码格式。

该模块提供了一个类和一些便捷函数。 这些函数是该模块通常的接口，但某些应用程序可能也会希望使用类。

下列函数提供了此模块的主要接口。 如果此模块尚未被初始化，它们将会调用 init()，如果它们依赖于 init() 所设置的信息的话。

mimetypes.guess_type(url, strict=True)

根据 url 给出的文件名、路径或 URL 来猜测文件的类型，URL 可以为字符串或 path-like object。

返回值是一个元组 (type, encoding) 其中 type 在无法猜测（后缀不存在或者未知）时为 None，或者为 'type/subtype' 形式的字符串，可以作为 MIME content-type 标头。

encoding 在无编码格式时为 None，或者为程序所用的编码格式 (例如 compress 或 gzip)。 它可以作为 Content-Encoding 标头，但 不可 作为 Content-Transfer-Encoding 标头。 映射是表格驱动的。 编码格式前缀对大小写敏感；类型前缀会先以大小写敏感方式检测再以大小写不敏感方式检测。

可选的 strict 参数是一个旗标，指明要将已知 MIME 类型限制在 IANA 已注册 [https://www.iana.org/assignments/media-types/media-types.xhtml] 的官方类型之内。 当 strict 为 True 时（默认值），则仅支持 IANA 类型；当 strict 为 False 时，则还支持某些附加的非标准但常用的 MIME 类型。

在 3.8 版更改: 增加了 path-like object 作为 url 的支持。

mimetypes.guess_all_extensions(type, strict=True)

根据由 type 给出的文件 MIME 类型猜测其扩展名。 返回值是由所有可能的文件扩展名组成的字符串列表，包括开头的点号 ('.')。 这些扩展名不保证能关联到任何特定的数据流，但是将会由 guess_type() 映射到 MIME 类型 type。

可选的 strict 参数具有与 guess_type() 函数一致的含义。

mimetypes.guess_extension(type, strict=True)

根据由 type 给出的文件 MIME 类型猜测其扩展名。 返回值是一个表示文件扩展名的字符串，包括开头的点号 ('.')。 该扩展名不保证能关联到任何特定的数据流，但是将会由 guess_type() 映射到 MIME 类型 type。 如果不能猜测出 type 的扩展名，则将返回 None。

可选的 strict 参数具有与 guess_type() 函数一致的含义。

有一些附加函数和数据项可被用于控制此模块的行为。

mimetypes.init(files=None)

初始化内部数据结构。 files 如果给出则必须是一个文件名序列，它应当被用于协助默认的类型映射。 如果省略则要使用的文件名会从 knownfiles 中获取； 在 Windows 上，将会载入当前注册表设置。 在 files 或 knownfiles 中指定的每个文件名的优先级将高于在它之前的文件名。 init() 允许被重复调用。

为 files 指定一个空列表将防止应用系统默认选项：将只保留来自内置列表的常用值。

如果 files 为 None 则内部数据结构会完全重建为其初始默认值。 这是一个稳定操作并将在多次调用时产生相同的结果。

在 3.2 版更改: 在之前版本中，Windows 注册表设置会被忽略。

mimetypes.read_mime_types(filename)

载入在文件 filename 中给定的类型映射，如果文件存在的话。 返回的类型映射会是一个字典，其中的键值对为文件扩展名包括开头的点号 ('.') 与 'type/subtype' 形式的字符串。 如果文件 filename 不存在或无法被读取，则返回 None。

mimetypes.add_type(type, ext, strict=True)

添加一个从 MIME 类型 type 到扩展名 ext 的映射。 当扩展名已知时，新类型将替代旧类型。 当类型已知时，扩展名将被添加到已知扩展名列表。

当 strict 为 True 时（默认值），映射将被添加到官方 MIME 类型，否则添加到非标准类型。

mimetypes.inited

指明全局数据结构是否已被初始化的旗标。 这会由 init() 设为 True。

mimetypes.knownfiles

通常安装的类型映射文件名列表。 这些文件一般被命名为 mime.types 并会由不同的包安装在不同的位置。

mimetypes.suffix_map

将后缀映射到其他后缀的字典。 它被用来允许识别已编码的文件，其编码格式和类型是由相同的扩展名来指明的。 例如，.tgz 扩展名被映射到 .tar.gz 以允许编码格式和类型被分别识别。

mimetypes.encodings_map

映射文件扩展名到编码格式类型的字典。

mimetypes.types_map

映射文件扩展名到 MIME 类型的字典。

mimetypes.common_types

映射文件扩展名到非标准但常见的 MIME 类型的字典。

此模块一个使用示例:

>>> 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'

MimeTypes 对象

MimeTypes 类可以被用于那些需要多个 MIME 类型数据库的应用程序；它提供了与 mimetypes 模块所提供的类似接口。

class mimetypes.MimeTypes(filenames=(), strict=True)

这个类表示 MIME 类型数据库。 默认情况下，它提供了对与此模块其余部分一致的数据库的访问权限。 这个初始数据库是此模块所提供数据库的一个副本，并可以通过使用 read() 或 readfp() 方法将附加的 mime.types 样式文载入到数据库中来进行扩展。 如果不需要默认数据的话这个映射字典也可以在载入附加数据之前先被清空。

可选的 filenames 形参可被用来让附加文件被载入到默认数据库“之上”。

suffix_map

将后缀映射到其他后缀的字典。 它被用来允许识别已编码的文件，其编码格式和类型是由相同的扩展名来指明的。 例如，.tgz 扩展名被映射到 .tar.gz 以允许编码格式和类型被分别识别。 这是在模块中定义的全局 suffix_map 的一个副本。

encodings_map

映射文件扩展名到编码格式类型的字典。 这是在模块中定义的全局 encodings_map 的一个副本。

types_map

包含两个字典的元组，将文件扩展名映射到 MIME 类型：第一个字典针对非标准类型而第二个字典针对标准类型。 它们会由 common_types 和 types_map 来初始化。

types_map_inv

包含两个字典的元组，将 MIME 类型映射到文件扩展名列表：第一个字典针对非标准类型而第二个字典针对标准类型。 它们会由 common_types 和 types_map 来初始化。

guess_extension(type, strict=True)

类似于 guess_extension() 函数，使用存储的表作为对象的一部分。

guess_type(url, strict=True)

类似于 guess_type() 函数，使用存储的表作为对象的一部分。

guess_all_extensions(type, strict=True)

类似于 guess_all_extensions() 函数，使用存储的表作为对象的一部分。

read(filename, strict=True)

从名称为 filename 的文件载入 MIME 信息。 此方法使用 readfp() 来解析文件。

如果 strict 为 True，信息将被添加到标准类型列表，否则添加到非标准类型列表。

readfp(fp, strict=True)

从打开的文件 fp 载入 MIME 类型信息。 文件必须具有标准 mime.types 文件的格式。

如果 strict 为 True，信息将被添加到标准类型列表，否则添加到非标准类型列表。

read_windows_registry(strict=True)

从 Windows 注册表载入 MIME 类型信息。

可用性: Windows。

如果 strict 为 True，信息将被添加到标准类型列表，否则添加到非标准类型列表。

3.2 新版功能.

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

源代码： Lib/base64.py [https://github.com/python/cpython/tree/3.10/Lib/base64.py]

此模块提供了将二进制数据编码为可打印的 ASCII 字符以及将这种编码格式解码回二进制数据的函数。 它为 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 所定义的 Base16, Base32 和 Base64 算法及已成为事实标准的 Ascii85 和 Base85 编码格式提供了编码和解码函数。

RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 中的编码格式适用于编码二进制数据使得它能安全地通过电子邮件发送、用作 URL 的一部分，或者包括在 HTTP POST 请求之中。 此编码格式算法与 uuencode 程序并不相同。

此模块提供了两个接口。 较新的接口支持将 字节类对象 编码为 ASCII bytes，以及将 字节类对象 或包含 ASCII 的字符串解码为 bytes。 在 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 中定义的几种 base-64 字母表（普通的以及 URL 和文件系统安全的）都受到支持。

旧的接口不提供从字符串的解码操作，但提供了操作 文件对象 的编码和解码函数。旧接口只支持标准的 Base64 字母表，并且按照 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] 的规范每 76 个字符增加一个换行符。注意：如果你需要支持 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html]，那么使用 email 模块可能更加合适。

在 3.3 版更改: 新的接口提供的解码函数现在已经支持只包含 ASCII 的 Unicode 字符串。

在 3.4 版更改: 所有 类字节对象 现在已经被所有编码和解码函数接受。添加了对 Ascii85/Base85 的支持。

新的接口提供：

base64.b64encode(s, altchars=None)

对 bytes-like object s 进行 Base64 编码，并返回编码后的 bytes。

可选项 altchars 必须是一个长度为 2 的 bytes-like object，它指定了用于替换 + 和 / 的字符表。 这允许应用程序生成对 URL 或文件系统安全的 Base64 字符串。 默认值为 None，即使用标准 Base64 字符表。

如果 altchars 的长度不为 2 则可以断言或引发 ValueError。 如果 altchars 不是 bytes-like object 则会引发 TypeError。

base64.b64decode(s, altchars=None, validate=False)

解码 Base64 编码过的 bytes-like object 或 ASCII 字符串 s 并返回解码过的 bytes。

可选项 altchars 必须是一个长度为 2 的 bytes-like object 或 ASCII 字符串，它指定了用于替换 + 和 / 的字符表。

如果 s 被不正确地填写，一个 binascii.Error 错误将被抛出。

如果 validate 值为 False （默认情况），则在填充检查前，将丢弃既不在标准 base-64 字母表之中也不在备用字母表中的字符。如果 validate 为 True，这些非 base64 字符将导致 binascii.Error。

如果 altchars 不为 2 则可以断言设定或引发 ValueError。

base64.standard_b64encode(s)

编码 bytes-like object s，使用标准 Base64 字母表并返回编码过的 bytes。

base64.standard_b64decode(s)

解码 bytes-like object 或 ASCII 字符串 s，使用标准 Base64 字母表并返回编码过的 bytes。

base64.urlsafe_b64encode(s)

编码 bytes-like object s，使用 URL 与文件系统安全的字母表，使用 - 以及 _ 代替标准 Base64 字母表中的 + 和 /。返回编码过的 bytes。结果中可能包含 =。

base64.urlsafe_b64decode(s)

解码 bytes-like object 或 ASCII 字符串 s，使用 URL 与文件系统安全的字母表，使用 - 以及 _ 代替标准 Base64 字母表中的 + 和 /。返回解码过的 bytes

base64.b32encode(s)

用 Base32 编码 bytes-like object s 并返回编码过的 bytes

base64.b32decode(s, casefold=False, map01=None)

解码 Base32 编码过的 bytes-like object 或 ASCII 字符串 s 并返回解码过的 bytes。

可选的 casefold 是一个指定小写字幕是否可接受为输入的标志。为了安全考虑，默认值为 False。

RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 允许可以选择将数码 0 (zero) 映射为字母 O (oh)，并可以选择将数码 1 (one) 映射为字母 I (eye) 或字母 L (el)。 可选参数 map01 在不为 None 时，指定数码 1 应当映射为哪个字母 (当 map01 不为 None 时，数码 0 总是被映射为字母 O)。 出于安全考虑其默认值为 None，因而在输入中不允许 0 和 1。

如果 s 被错误地填写或输入中存在字母表之外的字符，将抛出 binascii.Error。

base64.b32hexencode(s)

类似于 b32encode() 但是使用 Extended Hex Alphabet，如 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 所定义。

3.10 新版功能.

base64.b32hexdecode(s, casefold=False)

类似于 b32decode() 但是使用 Extended Hex Alphabet，如 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 所定义。

这个版本不允许数字 0（零）与字母 O（oh）和数字 1（一）与字母 I（eye）或字母 L （el）的映射，所有这些字符都包含在扩展的十六进制字母表中，不能互换。

3.10 新版功能.

base64.b16encode(s)

用 Base16 编码 bytes-like object s 并返回编码过的 bytes

base64.b16decode(s, casefold=False)

解码 Base16 编码过的 bytes-like object 或 ASCII 字符串 s 并返回解码过的 bytes。

可选的 casefold 是一个指定小写字幕是否可接受为输入的标志。为了安全考虑，默认值为 False。

如果 s 被错误地填写或输入中存在字母表之外的字符，将抛出 binascii.Error。

base64.a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

用 Ascii85 编码 bytes-like object s 并返回编码过的 bytes

foldspaces 是一个可选的标志，使用特殊的短序列 'y' 代替 'btoa' 提供的 4 个连续空格 (ASCII 0x20)。这个特性不被 "标准" Ascii85 编码支持。

wrapcol 控制了输出是否包含换行符 (b'\n'). 如果该值非零, 则每一行只有该值所限制的字符长度.

pad 控制在编码之前输入是否填充为4的倍数。请注意，btoa 实现总是填充。

adobe 控制编码后的字节序列是否要加上 <~ 和 ~>，这是 Adobe 实现所使用的。

3.4 新版功能.

base64.a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')

解码 Ascii85 编码过的 bytes-like object 或 ASCII 字符串 s 并返回解码过的 bytes。

foldspaces 旗标指明是否应接受 'y' 短序列作为 4 个连续空格 (ASCII 0x20) 的快捷方式。 此特性不被 "标准" Ascii85 编码格式所支持。

adobe 控制输入序列是否为 Adobe Ascii85 格式 (即附加 <~ 和 ~>)。

ignorechars 应当是一个 bytes-like object 或 ASCII 字符串，其中包含要从输入中忽略的字符。 这应当只包含空白字符，并且默认包含 ASCII 中所有的空白字符。

3.4 新版功能.

base64.b85encode(b, pad=False)

用 base85（如 git 风格的二进制 diff 数据所用格式）编码 bytes-like object b 并返回编码后的 bytes。

如果 pad 为真值，输入将以 b'\0' 填充以使其编码前长度为 4 字节的倍数。

3.4 新版功能.

base64.b85decode(b)

解码 base85 编码过的 bytes-like object 或 ASCII 字符串 b 并返回解码过的 bytes。 如有必要，填充会被隐式地移除。

3.4 新版功能.

旧式接口:

base64.decode(input, output)

解码二进制 input 文件的内容并将结果二进制数据写入 output 文件。 input 和 output 必须为 文件对象. input 将被读取直至 input.readline() 返回空字节串对象。

base64.decodebytes(s)

解码 bytes-like object s，该对象必须包含一行或多行 base64 编码的数据，并返回已解码的 bytes。

3.1 新版功能.

base64.encode(input, output)

编码二进制 input 文件的内容并将经 base64 编码的数据写入 output 文件。 input 和 output 必须为 文件对象。 input 将被读取直到 input.read() 返回空字节串对象。 encode() 会在每输出 76 个字节之后插入一个换行符 (b'\n')，并会确保输出总是以换行符来结束，如 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] (MIME) 所规定的那样。

base64.encodebytes(s)

编码 bytes-like object s，其中可以包含任意二进制数据，并返回包含经 base64 编码数据的 bytes，每输出 76 个字节之后将带一个换行符 (b'\n')，并会确保在末尾也有一个换行符，如 RFC 2045 [https://datatracker.ietf.org/doc/html/rfc2045.html] (MIME) 所规定的那样。

3.1 新版功能.

此模块的一个使用示例:

>>> import base64
>>> encoded = base64.b64encode(b'data to be encoded')
>>> encoded
b'ZGF0YSB0byBiZSBlbmNvZGVk'
>>> data = base64.b64decode(encoded)
>>> data
b'data to be encoded'

安全考量

在 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html] 中新增了安全事项部分（第 12 节）；对于要部署到生产环境的任何代码都建议充分考虑此安全事项部分。

参见

模块 binascii

支持模块，包含ASCII到二进制和二进制到ASCII转换。

RFC 1521 [https://datatracker.ietf.org/doc/html/rfc1521.html] - MIME (Multipurpose Internet Mail Extensions) 第一部分：规定并描述因特网消息体的格式的机制。

第 5.2 节，“Base64 内容转换编码格式” 提供了 base64 编码格式的定义。

binhex --- 对binhex4文件进行编码和解码

源代码: Lib/binhex.py [https://github.com/python/cpython/tree/3.10/Lib/binhex.py]

3.9 版后已移除.

此模块以binhe4格式对文件进行编码和解码，该格式允许Macintosh文件以ASCII格式表示。仅处理数据分支。

binhex 模块定义了以下功能：

binhex.binhex(input, output)

将带有文件名 输入 的二进制文件转换为binhex文件 输出 。输出参数可以是文件名或类文件对象（ write() 和 close() 方法的任何对象）。

binhex.hexbin(input, output)

解码binhex文件输入。 输入 可以是支持 read() 和 close() 方法的文件名或类文件对象。生成的文件将写入名为 output 的文件，除非参数为 None ，在这种情况下，从binhex文件中读取输出文件名。

还定义了以下异常：

exception binhex.Error

当无法使用binhex格式编码某些内容时（例如，文件名太长而无法放入文件名字段中），或者输入未正确编码的binhex数据时，会引发异常。

参见

模块 binascii

支持模块，包含ASCII到二进制和二进制到ASCII转换。

备注

还有一个替代的、功能更强大的编码器和解码器接口，详细信息请参见源代码。

如果您在非Macintosh平台上编码或解码文本文件，它们仍将使用旧的Macintosh换行符约定（回车符作为行尾）。

binascii --- 二进制和 ASCII 码互转

binascii 模块包含很多在二进制和二进制表示的各种ASCII码之间转换的方法。 通常情况不会直接使用这些函数，而是使用像 uu ， base64 ，或 binhex 这样的封装模块。 为了执行效率高，binascii 模块含有许多用 C 写的低级函数，这些底层函数被一些高级模块所使用。

注解

a2b_* 函数接受只含有 ASCII 码的Unicode 字符串。其他函数只接受 字节类对象 （例如 bytes，bytearray 和其他支持缓冲区协议的对象）。

在 3.3 版更改: ASCII-only unicode strings are now accepted by the a2b_* functions.

binascii 模块定义了以下函数：

binascii.a2b_uu(string)

将单行 uu 编码数据转换成二进制数据并返回。uu 编码每行的数据通常包含45 个（二进制）字节，最后一行除外。每行数据后面可能跟有空格。

binascii.b2a_uu(data, *, backtick=False)

将二进制数据转换为 ASCII 编码字符，返回值是转换后的行数据，包括换行符。 data 的长度最多为45。如果 backtick 为ture，则零由 '`' 而不是空格表示。

在 3.7 版更改: 增加 backtick 形参。

binascii.a2b_base64(string)

将 base64 数据块转换成二进制并以二进制数据形式返回。一次可以传递多行数据。

binascii.b2a_base64(data, *, newline=True)

将二进制数据转换为一行用 base64 编码的ASCII字符串。返回值是转换后的行数据，如果 newline 为true，则返回值包括换行符。该函数的输出符合：rfc：3548。

在 3.6 版更改: 增加 newline 形参。

binascii.a2b_qp(data, header=False)

将一个引号可打印的数据块转换成二进制数据并返回。一次可以转换多行。如果可选参数 header 存在且为true，则数据中的下划线将被解码成空格。

binascii.b2a_qp(data, quotetabs=False, istext=True, header=False)

将二进制数据转换为一行或多行带引号可打印编码的ASCII字符串。返回值是转换后的行数据。如果可选参数 quotetabs 存在且为真值，则对所有制表符和空格进行编码。如果可选参数 istext 存在且为真值，则不对新行进行编码，但将对尾随空格进行编码。如果可选参数 header 存在且为true，则空格将被编码为下划线 RFC 1522 [https://datatracker.ietf.org/doc/html/rfc1522.html]。如果可选参数 header 存在且为假值，则也会对换行符进行编码;不进行换行转换编码可能会破坏二进制数据流。

binascii.a2b_hqx(string)

将 binhex4 格式的 ASCII 数据不进行 RLE 解压缩直接转换为二进制数据。该字符串应包含完整数量的二进制字节，或者（在binhex4 数据最后部分）剩余位为零。

3.9 版后已移除.

binascii.rledecode_hqx(data)

根据 binhex4 标准对数据执行 RLE 解压缩。该算法在一个字节的数据后使用 0x90 作为重复指示符，然后计数。计数 0 指定字节值 0x90 。该例程返回解压缩的数据，输入数据以孤立的重复指示符结束的情况下，将引发 Incomplete 异常。

在 3.2 版更改: 仅接受 bytestring 或 bytearray 对象作为输入。

3.9 版后已移除.

binascii.rlecode_hqx(data)

在 data 上执行 binhex4 游程编码压缩并返回结果。

3.9 版后已移除.

binascii.b2a_hqx(data)

执行 hexbin4 类型二进制到 ASCII 码的转换并返回结果字符串。输入数据应经过 RLE 编码，且数据长度可被3整除（除了最后一个片段）。

3.9 版后已移除.

binascii.crc_hqx(data, value)

以 value 作为初始 CRC 计算 data 的16位 CRC 值，返回其结果。这里使用 CRC-CCITT 生成多项式 x¹⁶ + x¹² + x⁵ + 1 ，通常表示为0x1021。该 CRC 被用于 binhex4 格式。

binascii.crc32(data[, value])

计算 CRC-32，即 data 的无符号 32 位校验和，初始 CRC 值为 value。 默认的初始 CRC 值为零。 该算法与 ZIP 文件校验和算法一致。 由于该算法被设计用作校验和算法，因此不适合用作通用哈希算法。 使用方式如下:

print(binascii.crc32(b"hello world"))
# Or, in two pieces:
crc = binascii.crc32(b"hello")
crc = binascii.crc32(b" world", crc)
print('crc32 = {:#010x}'.format(crc))

在 3.0 版更改: 结果值将始终为无符号类型。 要在使用 Python 2 或更早版本时生成同样的数值，请使用 crc32(data) & 0xffffffff。

binascii.b2a_hex(data[, sep[, bytes_per_sep=1]])

binascii.hexlify(data[, sep[, bytes_per_sep=1]])

返回二进制数据 data 的十六进制表示形式。 data 的每个字节都被转换为相应的2位十六进制表示形式。因此返回的字节对象的长度是 data 的两倍。

使用：bytes.hex() 方法也可以方便地实现相似的功能（但仅返回文本字符串）。

如果指定了 sep，它必须为单字符 str 或 bytes 对象。 它将被插入每个 bytes_per_sep 输入字节之后。 分隔符位置默认从输出的右端开始计数，如果你希望从左端开始计数，请提供一个负的 bytes_per_sep 值。

>>> 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'

在 3.8 版更改: 添加了 sep 和 bytes_per_sep 形参。

binascii.a2b_hex(hexstr)

binascii.unhexlify(hexstr)

返回由十六进制字符串 hexstr 表示的二进制数据。此函数功能与 b2a_hex() 相反。 hexstr 必须包含偶数个十六进制数字（可以是大写或小写），否则会引发 Error 异常。

使用：bytes.fromhex() 类方法也实现相似的功能（仅接受文本字符串参数，不限制其中的空白字符）。

exception binascii.Error

通常是因为编程错误引发的异常。

exception binascii.Incomplete

数据不完整引发的异常。通常不是编程错误导致的，可以通过读取更多的数据并再次尝试来处理该异常。

参见

模块 base64

支持在16，32，64，85进制中进行符合 RFC 协议的 base64 样式编码。

模块 binhex

支持在 Macintosh 上使用的 binhex 格式。

模块 uu

支持 Unix 使用的 UU 编码。

模块 quopri

支持在 MIME 版本电子邮件中使用引号可打印编码。

quopri --- 编码与解码经过 MIME 转码的可打印数据

源代码: Lib/quopri.py [https://github.com/python/cpython/tree/3.10/Lib/quopri.py]

此模块会执行转换后可打印的传输编码与解码，具体定义见 RFC 1521 [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"。 转换后可打印的编码格式被设计用于只包含相对较少的不可打印字符的数据；如果存在大量这样的字符，通过 base64 模块所提供的 base64 编码方案会更为紧凑，例如当发送图片文件时。

quopri.decode(input, output, header=False)

解码 input 文件的内容并将已解码二进制数据结果写入 output 文件。 input 和 output 必须为 二进制文件对象。 如果提供了可选参数 header 且为真值，下划线将被解码为空格。 此函数可用于解码“Q”编码的头数据，具体描述见 RFC 1522 [https://datatracker.ietf.org/doc/html/rfc1522.html]: "MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text"。

quopri.encode(input, output, quotetabs, header=False)

编码 input 文件的内容并将转换后可打印的数据结果写入 output 文件。 input 和 output 必须为 二进制文件对象. quotetabs 是一个非可选的旗标，它控制是否要编码内嵌的空格与制表符；当为真值时将编码此类内嵌空白符，当为假值时则保持原样不进行编码。 请注意出现在行尾的空格与制表符总是会被编码，具体描述见 RFC 1521 [https://datatracker.ietf.org/doc/html/rfc1521.html]。 header 旗标控制空格符是否要编码为下划线，具体描述见 RFC 1522 [https://datatracker.ietf.org/doc/html/rfc1522.html]。

quopri.decodestring(s, header=False)

类似 decode()，区别在于它接受一个源 bytes 并返回对应的已解码 bytes。

quopri.encodestring(s, quotetabs=False, header=False)

类型 encode()，区别在于它接受一个源 bytes 并返回对应的已编码 bytes。 在默认情况下，它会发送 False 值给 encode() 函数的 quotetabs 形参。

参见

模块 base64

编码与解码 MIME base64 数据

结构化标记处理工具

Python 支持各种模块，以处理各种形式的结构化数据标记。 这包括使用标准通用标记语言（SGML）和超文本标记语言（HTML）的模块，以及使用可扩展标记语言（XML）的几个接口。

html --- 超文本标记语言支持

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

HTML 解析器的示例程序

HTMLParser 方法

例子

html.entities --- HTML 一般实体的定义

XML处理模块

XML 漏洞

defusedxml 包

xml.etree.ElementTree --- ElementTree XML API

教程

XML 树和元素

解析 XML

用于非阻塞解析的拉取 API

查找感兴趣的元素

修改XML文件

构建 XML 文档

解析带有命名空间的 XML

XPath支持

示例

支持的XPath语法

参考

函数

XInclude 支持

示例

参考

函数

元素对象

ElementTree 对象

QName 对象

TreeBuilder 对象

XMLParser对象

XMLPullParser对象

异常

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

模块内容

DOM 中的对象

DOMImplementation 对象

节点对象

节点列表对象

文档类型对象

Document 对象

元素对象

Attr 对象

NamedNodeMap 对象

注释对象

Text 和 CDATASection 对象

ProcessingInstruction 对象

异常

一致性

类型映射

访问器方法

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.saxutils --- SAX 工具集

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

XMLReader 对象

IncrementalParser 对象

Locator 对象

InputSource 对象

Attributes 接口

AttributesNS 接口

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

XMLParser对象

ExpatError 异常

示例

内容模型描述

Expat 错误常量

html --- 超文本标记语言支持

源码： Lib/html/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/html/__init__.py]

该模块定义了操作HTML的工具。

html.escape(s, quote=True)

将字符串 s 中的字符 & 、 < 和 > 转换为安全的HTML序列。 如果需要在 HTML 中显示可能包含此类字符的文本，请使用此选项。 如果可选的标志 quote 为真值，则字符 (") 和 (') 也被转换；这有助于包含在由引号分隔的 HTML 属性中，如 <a href="...">。

3.2 新版功能.

html.unescape(s)

将字符串 s 中的所有命名和数字字符引用 (例如 &gt;, &#62;, &#x3e;) 转换为相应的Unicode字符。 此函数使用HTML 5标准为有效和无效字符引用定义的规则，以及 HTML 5 命名字符引用列表。

3.4 新版功能.

html 包中的子模块是：

html.parser —— 具有宽松解析模式的HTML / XHTML解析器

html.entities -- HTML 实体定义

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

源代码： Lib/html/parser.py [https://github.com/python/cpython/tree/3.10/Lib/html/parser.py]

这个模块定义了一个 HTMLParser 类，为 HTML（超文本标记语言）和 XHTML 文本文件解析提供基础。

class html.parser.HTMLParser(*, convert_charrefs=True, scripting=False)

创建一个能解析无效标记的解析器实例。

如果 convert_charrefs 为真值（默认），则所有字符引用（除了元素中的字符引用 script 和 style 除外）都会自动转换为对应的 Unicode 字符。

如果 scripting 为假值（默认），则 noscript 元素中的内容将被正常解析；如果为真值，它将不加解析地原样返回。

一个 HTMLParser 类的实例用来接受 HTML 数据，并在标记开始、标记结束、文本、注释和其他元素标记出现的时候调用对应的方法。要实现具体的行为，请使用 HTMLParser 的子类并重写其方法。

这个解析器不检查结束标记是否与开始标记匹配，也不会因外层元素完毕而隐式关闭了的元素引发结束标记处理。

在 3.4 版更改: convert_charrefs 关键字参数被添加。

在 3.5 版更改: convert_charrefs 参数的默认值现在为 True。

在 3.10.20 版更改: 增加了 scripting 形参。

HTML 解析器的示例程序

下面是简单的 HTML 解析器的一个基本示例，使用 HTMLParser 类，当遇到开始标记、结束标记以及数据的时候将内容打印出来。

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>')

输出是:

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

HTMLParser 方法

HTMLParser 实例有下列方法：

HTMLParser.feed(data)

填充一些文本到解析器中。如果包含完整的元素，则被处理；如果数据不完整，将被缓冲直到更多的数据被填充，或者 close() 被调用。data 必须为 str 类型。

HTMLParser.close()

如同后面跟着一个文件结束标记一样，强制处理所有缓冲数据。这个方法能被派生类重新定义，用于在输入的末尾定义附加处理，但是重定义的版本应当始终调用基类 HTMLParser 的 close() 方法。

HTMLParser.reset()

重置实例。丢失所有未处理的数据。在实例化阶段被隐式调用。

HTMLParser.getpos()

返回当前行号和偏移值。

HTMLParser.get_starttag_text()

返回最近打开的开始标记中的文本。 结构化处理时通常应该不需要这个，但在处理“已部署”的 HTML 或是在以最小改变来重新生成输入时可能会有用处（例如可以保留属性间的空格等）。

下列方法将在遇到数据或者标记元素的时候被调用。他们需要在子类中重写。基类的实现中没有任何实际操作（除了 handle_startendtag() ）：

HTMLParser.handle_starttag(tag, attrs)

调用此方法来处理一个元素的开始标记 (例如 <div id="main">)。

tag 参数是小写的标记名。attrs 参数是一个 (name, value) 形式的列表，包含了所有在标记的 <> 括号中找到的属性。name 转换为小写，value 的引号被去除，字符和实体引用都会被替换。

实例中，对于标签 <A HREF="https://www.cwi.nl/">，这个方法将以下列形式被调用 handle_starttag('a', [('href', 'https://www.cwi.nl/')]) 。

html.entities 中的所有实体引用，会被替换为属性值。

HTMLParser.handle_endtag(tag)

此方法被用来处理元素的结束标记（例如： </div> ）。

tag 参数是小写的标签名。

HTMLParser.handle_startendtag(tag, attrs)

类似于 handle_starttag(), 只是在解析器遇到 XHTML 样式的空标记时被调用（ <img ... />）。这个方法能被需要这种特殊词法信息的子类重写；默认实现仅简单调用 handle_starttag() 和 handle_endtag() 。

HTMLParser.handle_data(data)

调用此方法来处理任意数据（例如文本节点和元素如 script 和 style 中的内容）。

HTMLParser.handle_entityref(name)

调用此方法来处理 &name; 形式的命名字符引用 (例如 &gt;)，其中 name 是通用的实体引用 (例如 'gt')。 此方法仅在 convert_charrefs 为假值时会被调用。

HTMLParser.handle_charref(name)

This method is called to process decimal and hexadecimal numeric character references of the form &#NNN; and &#xNNN;. For example, the decimal equivalent for &gt; is &#62;, whereas the hexadecimal is &#x3E;; in this case the method will receive '62' or 'x3E'. This method is only called if convert_charrefs is false.

HTMLParser.handle_comment(data)

这个方法在遇到注释的时候被调用（例如： <!--comment--> ）。

例如， <!-- comment --> 这个注释会用 ' comment ' 作为参数调用此方法。

Internet Explorer 条件注释（condcoms）的内容也被发送到这个方法，因此，对于 <!--[if IE 9]>IE9-specific content<![endif]--> ，这个方法将接收到 '[if IE 9]>IE9-specific content<![endif]' 。

HTMLParser.handle_decl(decl)

这个方法用来处理 HTML doctype 申明（例如 <!DOCTYPE html> ）。

decl 形参为 <!...> 标记中的所有内容（例如： 'DOCTYPE html' ）。

HTMLParser.handle_pi(data)

此方法在遇到处理指令的时候被调用。data 形参将包含整个处理指令。例如，对于处理指令 <?proc color='red'> ，这个方法将以 handle_pi("proc color='red'") 形式被调用。它旨在被派生类重写；基类实现中无任何实际操作。

注解

HTMLParser 类使用 SGML 语法规则处理指令。使用 '?' 结尾的 XHTML 处理指令将导致 '?' 包含在 data 中。

HTMLParser.unknown_decl(data)

当解析器读到无法识别的声明时，此方法被调用。

data 形参为 <![...]> 标记中的所有内容。某些时候对派生类的重写很有用。基类实现中无任何实际操作。

例子

下面的类实现了一个解析器，用于更多示例的演示:

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()

解析一个文档类型声明:

>>> 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"

解析一个具有一些属性和标题的元素:

>>> 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

The content of elements like script and style is returned as is, without further parsing:

>>> 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

解析注释:

>>> parser.feed('<!-- a comment -->'
...             '<!--[if IE 9]>IE-specific content<![endif]-->')
Comment  :  a comment
Comment  : [if IE 9]>IE-specific content<![endif]

解析命名或数字形式的字符引用，并把他们转换到正确的字符（注意：这 3 种转义都是 '>' ）:

>>> parser.feed('&gt;&#62;&#x3E;')
Named ent: >
Num ent  : >
Num ent  : >

Feeding incomplete chunks to feed() works, but handle_data() might be called more than once if convert_charrefs is false:

>>> 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

解析无效的 HTML (例如：未引用的属性）也能正常运行:

>>> 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

html.entities --- HTML 一般实体的定义

源码： Lib/html/entities.py [https://github.com/python/cpython/tree/3.10/Lib/html/entities.py]

该模块定义了四个词典， html5、 name2codepoint、 codepoint2name、以及 entitydefs。

html.entities.html5

将 HTML5 命名字符引用 1 映射到等效的 Unicode 字符的字典，例如 html5['gt;'] == '>'。 请注意，尾随的分号包含在名称中（例如 'gt;' ），但是即使没有分号，一些名称也会被标准接受，在这种情况下，名称出现时带有和不带有 ';'。另见 html.unescape()。

3.3 新版功能.

html.entities.entitydefs

将 XHTML 1.0 实体定义映射到 ISO Latin-1 中的替换文本的字典。

html.entities.name2codepoint

将 HTML 实体名称映射到 Unicode 代码点的字典。

html.entities.codepoint2name

将 Unicode 代码点映射到 HTML 实体名称的字典。

备注

1

参见 https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references

XML处理模块

源码： Lib/xml/ [https://github.com/python/cpython/tree/3.10/Lib/xml/]

用于处理XML的Python接口分组在 xml 包中。

警告

XML 模块对于错误或恶意构造的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞 和 defusedxml 包 部分。

值得注意的是 xml 包中的模块要求至少有一个 SAX 兼容的 XML 解析器可用。在 Python 中包含 Expat 解析器，因此 xml.parsers.expat 模块将始终可用。

xml.dom 和 xml.sax 包的文档是 DOM 和 SAX 接口的 Python 绑定的定义。

XML 处理子模块包括:

xml.etree.ElementTree： ElementTree API，一个简单而轻量级的XML处理器

xml.dom：DOM API 定义

xml.dom.minidom：最小的 DOM 实现

xml.dom.pulldom：支持构建部分 DOM 树

xml.sax：SAX2 基类和便利函数

xml.parsers.expat：Expat解析器绑定

XML 漏洞

XML 处理模块对于恶意构造的数据是不安全的。 攻击者可能滥用 XML 功能来执行拒绝服务攻击、访问本地文件、生成与其它计算机的网络连接或绕过防火墙。

下表概述了已知的攻击以及各种模块是否容易受到攻击。

种类 | sax | etree | minidom | pulldom | xmlrpc
billion laughs | 易受攻击 (1) | 易受攻击 (1) | 易受攻击 (1) | 易受攻击 (1) | 易受攻击 (1)
quadratic blowup | 易受攻击 (1) | 易受攻击 (1) | 易受攻击 (1) | 易受攻击 (1) | 易受攻击 (1)
external entity expansion | 安全 (5) | 安全 (2) | 安全 (3) | 安全 (5) | 安全 (4)
DTD [https://en.wikipedia.org/wiki/Document_type_definition] retrieval | 安全 (5) | 安全 | 安全 | 安全 (5) | 安全
decompression bomb | 安全 | 安全 | 安全 | 安全 | 易受攻击
解析大量词元 | 易受攻击 (6) | 易受攻击 (6) | 易受攻击 (6) | 易受攻击 (6) | 易受攻击 (6)

Expat 2.4.1 及更新的版本不易受 "billion laughs" 和 "quadratic blowup" 漏洞的攻击。 因为可能要依赖系统提供的库而仍被列为易受攻击的项目。 请检查 pyexpat.EXPAT_VERSION。

xml.etree.ElementTree 不会扩展外部实体并在实体发生时引发 ParserError。

xml.dom.minidom 不会扩展外部实体，只是简单地返回未扩展的实体。

xmlrpclib 不扩展外部实体并省略它们。

从 Python 3.7.1 开始，默认情况下不再处理外部通用实体。

Expat 2.6.0 及更新的版本不易受到因解析大量词元而导致利用指数级运行时间的拒绝服务攻击。 由于对系统所提供的库的潜在依赖仍会有一些项目被列为易受攻击。 请检查 pyexpat.EXPAT_VERSION。

billion laughs / exponential entity expansion （狂笑/递归实体扩展）

Billion Laughs [https://en.wikipedia.org/wiki/Billion_laughs] 攻击 -- 也称为递归实体扩展 -- 使用多级嵌套实体。 每个实体多次引用另一个实体，最终实体定义包含一个小字符串。 指数级扩展导致几千 GB 的文本，并消耗大量内存和 CPU 时间。

quadratic blowup entity expansion（二次爆炸实体扩展）

二次爆炸攻击类似于 Billion Laughs [https://en.wikipedia.org/wiki/Billion_laughs] 攻击；它也滥用了实体扩展。 它不是嵌套实体，而是一遍又一遍地重复一个具有几千个字符的大型实体。 这种攻击不如递归情况有效，但它可避免触发禁止深度嵌套实体的解析器对策。

external entity expansion

实体声明可以包含的不仅仅是替换文本。 它们还可以指向外部资源或本地文件。 XML 解析器访问资源并将内容嵌入到 XML 文档中。

DTD [https://en.wikipedia.org/wiki/Document_type_definition] retrieval

Python 的一些 XML 库 xml.dom.pulldom 从远程或本地位置检索文档类型定义。 该功能与外部实体扩展问题具有相似的含义。

decompression bomb

Decompression bombs（解压炸弹，又名 ZIP bomb [https://en.wikipedia.org/wiki/Zip_bomb]）适用于所有可以解析压缩 XML 流（例如 gzip 压缩的 HTTP 流或 LZMA 压缩的文件）的 XML 库。 对于攻击者来说，它可以将传输的数据量减少三个量级或更多。

解析大量词元

Expat 需要重新解析未完成的词元；在没有 Expat 2.6.0 所引入的防护措施的情况下，这会导致可被用来在解析 XML 的应用程序中制造拒绝服务攻击的指数级运行时间。 此问题被称为 CVE-2023-52425 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2023-52425]。

PyPI上 defusedxml [https://pypi.org/project/defusedxml/] 的文档包含有关所有已知攻击向量的更多信息以及示例和参考。

defusedxml 包

defusedxml [https://pypi.org/project/defusedxml/] 是一个纯 Python 软件包，它修改了所有标准库 XML 解析器的子类，可以防止任何潜在的恶意操作。 对于解析不受信任的XML数据的任何服务器代码，建议使用此程序包。 该软件包还提供了有关更多 XML 漏洞（如 XPath 注入）的示例漏洞和扩展文档。

xml.etree.ElementTree --- ElementTree XML API

源代码： Lib/xml/etree/ElementTree.py [https://github.com/python/cpython/tree/3.10/Lib/xml/etree/ElementTree.py]

xml.etree.ElementTree 模块实现了一个简单高效的API，用于解析和创建XML数据。

在 3.3 版更改: 此模块将在可能的情况下使用快速实现。

3.3 版后已移除: xml.etree.cElementTree 模块已被弃用。

警告

xml.etree.ElementTree 模块对于恶意构建的数据是不安全的。如果需要解析不可信或未经身份验证的数据，请参见 XML 漏洞 。

教程

这是一个使用 xml.etree.ElementTree （简称 ET ）的简短教程。目标是演示模块的一些构建块和基本概念。

XML 树和元素

XML 是一种继承性的分层数据格式，最自然的表示方法是使用树。 为此， ET 有两个类 -- ElementTree 将整个XML文档表示为一个树， Element 表示该树中的单个节点。 与整个文档的交互（读写文件）通常在 ElementTree 级别完成。 与单个 XML 元素及其子元素的交互是在 Element 级别完成的。

解析 XML

我们将使用以下 XML 文档作为本节的示例数据：

<?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>

可以通过从文件中读取来导入此数据：

import xml.etree.ElementTree as ET
tree = ET.parse('country_data.xml')
root = tree.getroot()

或直接从字符串中解析：

root = ET.fromstring(country_data_as_string)

fromstring() 将 XML 从字符串直接解析为 Element ，该元素是已解析树的根元素。 其他解析函数可能会创建一个 ElementTree 。 确切信息请查阅文档。

作为 Element ， root 具有标签和属性字典:

>>> root.tag
'data'
>>> root.attrib
{}

还有可以迭代的子节点：

>>> for child in root:
...     print(child.tag, child.attrib)
...
country {'name': 'Liechtenstein'}
country {'name': 'Singapore'}
country {'name': 'Panama'}

子级是可以嵌套的，我们可以通过索引访问特定的子级节点：

>>> root[0][1].text
'2008'

注解

并非 XML 输入的所有元素都将作为解析树的元素结束。 目前，此模块跳过输入中的任何 XML 注释、处理指令和文档类型声明。 然而，使用这个模块的 API 而不是从 XML 文本解析构建的树可以包含注释和处理指令，生成 XML 输出时同样包含这些注释和处理指令。 可以通过将自定义 TreeBuilder 实例传递给 XMLParser 构造器来访问文档类型声明。

用于非阻塞解析的拉取 API

此模块所提供了大多数解析函数都要求在返回任何结果之前一次性读取整个文档。 可以使用 XMLParser 并以增量方式添加数据，但这是在回调目标上调用方法的推送式 API。 有时用户真正想要的是能够以增量方式解析 XML 而无需阻塞操作，同时享受完整的已构造 Element 对象。

针对此需求的最强大工具是 XMLPullParser。 它不要求通过阻塞式读取来获得 XML 数据，而是通过执行 XMLPullParser.feed() 调用来增量式地添加数据。 要获得已解析的 XML 元素，应调用 XMLPullParser.read_events()。 下面是一个示例:

>>> 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

常见的用例是针对以非阻塞方式进行的应用程序，其中 XML 是从套接字接收或从某些存储设备增量式读取的。 在这些用例中，阻塞式读取是不可接受的。

因为其非常灵活，XMLPullParser 在更简单的用例中使用起来可能并不方便。 如果你不介意你的应用程序在读取 XML 数据时造成阻塞但仍希望具有增量解析能力，可以考虑 iterparse()。 它在你读取大型 XML 文档并且不希望将它完全放去内存时会很适用。

在需要通过事件获得 即时 反馈的场合中，调用方法 XMLPullParser.flush() 将有助于减少延迟；请注意研究相关的安全说明。

查找感兴趣的元素

Element 有一些很有效的方法，可帮助递归遍历其下的所有子树（包括子级，子级的子级，等等）。例如 Element.iter():

>>> 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'}

Element.findall() 仅查找当前元素的直接子元素中带有指定标签的元素。 Element.find() 找带有特定标签的 第一个 子级，然后可以用 Element.text 访问元素的文本内容。 Element.get 访问元素的属性:

>>> for country in root.findall('country'):
...     rank = country.find('rank').text
...     name = country.get('name')
...     print(name, rank)
...
Liechtenstein 1
Singapore 4
Panama 68

通过使用 XPath ，可以更精确地指定要查找的元素。

修改XML文件

ElementTree 提供了一种构建XML文档并将其写入文件的简单方法。调用 ElementTree.write() 方法就可以实现。

创建后可以直接操作 Element 对象。例如：使用 Element.text 修改文本字段，使用 Element.set() 方法添加和修改属性，以及使用 Element.append() 添加新的子元素。

假设我们要为每个国家/地区的中添加一个排名，并在排名元素中添加一个 updated 属性：

>>> 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')

生成的XML现在看起来像这样：

<?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>

可以使用 Element.remove() 删除元素。假设我们要删除排名高于50的所有国家/地区:

>>> for country in root.findall('country'):
...     # using root.findall() to avoid removal during traversal
...     rank = int(country.find('rank').text)
...     if rank > 50:
...         root.remove(country)
...
>>> tree.write('output.xml')

请注意在迭代时进行并发修改可能会导致问题，就像在迭代并修改 Python 列表或字典时那样。 因此，这个示例先通过 root.findall() 收集了所有匹配的元素，在此之后再对匹配项列表进行迭代。

生成的XML现在看起来像这样：

<?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>

构建 XML 文档

SubElement() 函数还提供了一种便捷方法来为给定元素创建新的子元素:

>>> 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>

解析带有命名空间的 XML

如果 XML 输入带有 命名空间 [https://en.wikipedia.org/wiki/XML_namespace]，则具有前缀的 prefix:sometag 形式的标记和属性将被扩展为 {uri}sometag，其中 prefix 会被完整 URI 所替换。 并且，如果存在 默认命名空间 [https://www.w3.org/TR/xml-names/#defaulting]，则完整 URI 会被添加到所有未加前缀的标记之前。

下面的 XML 示例包含两个命名空间，一个具有前缀 "fictional" 而另一个则作为默认命名空间:

<?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>

搜索和探查这个 XML 示例的一种方式是手动为 find() 或 findall() 的 xpath 中的每个标记或属性添加 URI:

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)

一种更好的方式是搜索带命名空间的 XML 示例创建一个字典来存放你自己的前缀并在搜索函数中使用它们:

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)

这两种方式都会输出:

John Cleese
 |--> Lancelot
 |--> Archie Leach
Eric Idle
 |--> Sir Robin
 |--> Gunther
 |--> Commander Clement

XPath支持

此模块提供了对 XPath 表达式 [https://www.w3.org/TR/xpath] 的有限支持用于在树中定位元素。 其目标是支持一个简化语法的较小子集；完整的 XPath 引擎超出了此模块的适用范围。

示例

下面是一个演示此模块的部分 XPath 功能的例子。 我们将使用来自 解析 XML 小节的 countrydata XML 文档:

import xml.etree.ElementTree as ET

root = ET.fromstring(countrydata)

# Top-level elements
root.findall(".")

# All 'neighbor' grand-children of 'country' children of the top-level
# elements
root.findall("./country/neighbor")

# Nodes with name='Singapore' that have a 'year' child
root.findall(".//year/..[@name='Singapore']")

# 'year' nodes that are children of nodes with name='Singapore'
root.findall(".//*[@name='Singapore']/year")

# All 'neighbor' nodes that are the second child of their parent
root.findall(".//neighbor[2]")

对于带有命名空间的 XML，应使用通常的限定 {namespace}tag 标记法:

# All dublin-core "title" tags in the document
root.findall(".//{http://purl.org/dc/elements/1.1/}title")

支持的XPath语法

语法 | 含意
tag | 选择具有给定标记的所有子元素。 例如，spam 是选择名为 spam 的所有子元素，而 spam/egg 是在名为 spam 的子元素中选择所有名为 egg 的孙元素，{*}spam 是在任意（或无）命名空间中选择名为 spam 的标记，而 {}* 是只选择不在一个命名空间中的标记。 在 3.8 版更改: 增加了对星号通配符的支持。
* | 选择所有子元素，包括注释和处理说明。例如 */egg 选择所有名为 egg 的孙元素。
. | 选择当前节点。这在路径的开头非常有用，用于指示它是相对路径。
// | 选择所有子元素 在当前元素的所有下级中选择所有下级元素。 例如，.//egg 是在整个树中选择所有 egg 元素。
.. | 选择父元素。 如果路径试图前往起始元素的上级（元素的 find 被调用）则返回 None。
[@attrib] | 选择具有给定属性的所有元素。
[@attrib='value'] | 选择给定属性具有给定值的所有元素。该值不能包含引号。
[@attrib!='value'] | 选择给定属性不具有给定值的所有元素。 该值不能包含引号。 3.10 新版功能.
[tag] | 选择所有包含 tag 子元素的元素。只支持直系子元素。
[.='text'] | 选择完整文本内容等于 text 的所有元素（包括后代）。 3.7 新版功能.
[.!='text'] | 选择完整文本内容包括其下级内容不等于给定的 text 的所有元素。 3.10 新版功能.
[tag='text'] | 选择所有包含名为 tag 的子元素的元素，这些子元素（包括后代）的完整文本内容等于给定的 text 。
[tag!='text'] | 选择具有名为 tag 的子元素的所有元素，这些子元素包括其下级元素的完整文本内容不等于给定的 text。 3.10 新版功能.
[position] | 选择位于给定位置的所有元素。 位置可以是一个整数 (1 表示首位)，表达式 last() (表示末位)，或者相对于末位的位置 (例如 last()-1)。

谓词（方括号内的表达式）之前必须带有标签名称，星号或其他谓词。position 谓词前必须有标签名称。

参考

函数

xml.etree.ElementTree.canonicalize(xml_data=None, *, out=None, from_file=None, **options)

C14N 2.0 [https://www.w3.org/TR/xml-c14n2/] 转换功能。.

规整化是标准化 XML 输出的一种方式，该方式允许按字节比较和数字签名。 它降低了 XML 序列化器所具有的自由度并改为生成更受约束的 XML 表示形式。 主要限制涉及命名空间声明的位置、属性的顺序和可忽略的空白符等。

此函数接受一个 XML 数字字符串 (xml_data) 或文件路径或者文件型对象 (from_file) 作为输入，将其转换为规整形式，并在提供了 out 文件（类）对象的情况下将其写到该对象的话，或者如果未提供则将其作为文本字符串返回。 输出文件接受文本而非字节数据。 因此它应当以使用 utf-8 编码格式的文本模式来打开。

典型使用:

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)

配置选项 options 如下:

with_comments: 设为真值以包括注释 (默认为假值)

strip_text: 设为真值以去除文本内容前后的空白符

（默认值：否）

rewrite_prefixes: 设为真值以替换带有 "n{number}" 前缀的命名空间

（默认值：否）

qname_aware_tags: 一组可感知限定名称的标记名称，其中的前缀

应当在文本内容中被替换 (默认为空值)

qname_aware_attrs: 一组可感知限定名称的属性名称，其中的前缀

应当在文本内容中被替换 (默认为空值)

exclude_attrs: 一组不应当被序列化的属性名称

exclude_tags: 一组不应当被序列化的标记名称

在上面的选项列表中，"一组" 是指任意多项集或包含字符串的可迭代对象，排序是不必要的。

3.8 新版功能.

xml.etree.ElementTree.Comment(text=None)

注释元素工厂函数。 这个工厂函数可创建一个特殊元素，它将被标准序列化器当作 XML 注释来进行序列化。 注释字串可以是字节串或是 Unicode 字符串。 text 是包含注释字串的字符串。 返回一个表示注释的元素实例。

请注意 XMLParser 会跳过输入中的注释而不会为其创建注释对象。 ElementTree 将只在当使用某个 Element 方法向树插入了注释节点时才会包含注释节点。

xml.etree.ElementTree.dump(elem)

将一个元素树或元素结构体写入到 sys.stdout。 此函数应当只被用于调试。

实际输出格式是依赖于具体实现的。 在这个版本中，它将以普通 XML 文件的格式写入。

elem 是一个元素树或单独元素。

在 3.8 版更改: dump() 函数现在会保留用户指定的属性顺序。

xml.etree.ElementTree.fromstring(text, parser=None)

根据一个字符串常量解析 XML 的节。 与 XML() 类似。 text 是包含 XML 数据的字符串。 parser 是可选的解析器实例。 如果未给出，则会使用标准 XMLParser 解析器。 返回一个 Element 实例。

xml.etree.ElementTree.fromstringlist(sequence, parser=None)

根据一个字符串片段序列解析 XML 文档。 sequence 是包含 XML 数据片段的列表或其他序列对象。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 返回一个 Element 实例。

3.2 新版功能.

xml.etree.ElementTree.indent(tree, space=' ', level=0)

添加空格到子树来实现树的缩进效果。 这可以被用来生成美化打印的 XML 输出。 tree 可以为 Element 或 ElementTree。 space 是对应将被插入的每个缩进层级的空格字符串，默认为两个空格符。 要对已缩进的树的部分子树进行缩进，请传入初始缩进层级作为 level。

3.9 新版功能.

xml.etree.ElementTree.iselement(element)

检测一个对象是否为有效的元素对象。 element 是一个元素实例。 如果对象是一个元素对象则返回 True。

xml.etree.ElementTree.iterparse(source, events=None, parser=None)

以增量方式将一个 XML 节解析为元素树，并向用户报告执行情况。 source 是包含 XML 数据的文件名或 file object。 events 是要报告的事件序列。 所支持的事件字符串有 "start", "end", "comment", "pi", "start-ns" 和 "end-ns" ("ns" 事件用于获取详细的命名空间信息)。 如果 events 被省略，则只有 "end" 事件会被报告。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 parser 必须为 XMLParser 的子类并且只能使用默认的 TreeBuilder 作为目标。 返回一个提供 (event, elem) 对的 iterator。

请注意虽然 iterparse() 是以增量方式构建树，但它会对 source (或其所指定的文件) 发出阻塞式读取。 因此，它不适用于不可执行阻塞式读取的应用。 对于完全非阻塞式的解析，请参看 XMLPullParser。

注解

iterparse() 只会确保当发出 "start" 事件时看到了开始标记的 ">" 字符，因而在这个点上属性已被定义，但文本容和末尾属性还未被定义。 这同样适用于元素的下级；它们可能存在也可能不存在。

如果你需要已完全填充的元素，请改为查找 "end" 事件。

3.4 版后已移除: parser 参数。

在 3.8 版更改: 增加了 comment 和 pi 事件。

xml.etree.ElementTree.parse(source, parser=None)

将一个 XML 的节解析为元素树。 source 是包含 XML 数据的文件名或文件对象。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 返回一个 ElementTree 实例。

xml.etree.ElementTree.ProcessingInstruction(target, text=None)

PI 元素工厂函数。 这个工厂函数可创建一个特殊元素，它将被当作 XML 处理指令来进行序列化。 target 是包含 PI 目标的字符串。 text 如果给出则是包含 PI 内容的字符串。 返回一个表示处理指令的元素实例。

请注意 XMLParser 会跳过输入中的处理指令而不会为其创建注释对象。 ElementTree 将只在当使用某个 Element 方法向树插入了处理指令节点时才会包含处理指令节点。

xml.etree.ElementTree.register_namespace(prefix, uri)

注册一个命名空间前缀。 这个注册表是全局的，并且任何对应给定前缀或命名空间 URI 的现有映射都会被移除。 prefix 是命名空间前缀。 uri 是命名空间 URI。 如果可能的话，这个命名空间中的标记和属性将附带给定的前缀来进行序列化。

3.2 新版功能.

xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)

子元素工厂函数。 这个函数会创建一个元素实例，并将其添加到现有的元素。

元素名、属性名和属性值可以是字节串或 Unicode 字符串。 parent 是父元素。 tag 是子元素名。 attrib 是一个可选的字典，其中包含元素属性。 extra 包含额外的属性，以关键字参数形式给出。 返回一个元素实例。

xml.etree.ElementTree.tostring(element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

生成一个 XML 元素的字符串表示形式，包括所有子元素。 element 是一个 Element 实例。 encoding 1 是输出编码格式（默认为 US-ASCII）。 请使用 encoding="unicode" 来生成 Unicode 字符串（否则生成字节串）。 method 是 "xml", "html" 或 "text" (默认为 "xml")。 xml_declaration, default_namespace 和 short_empty_elements 具有与 ElementTree.write() 中一致的含义。 返回一个包含 XML 数据（可选）已编码的字符串。

3.4 新版功能: short_empty_elements 形参。

3.8 新版功能: xml_declaration 和 default_namespace 形参。

在 3.8 版更改: tostring() 函数现在会保留用户指定的属性顺序。

xml.etree.ElementTree.tostringlist(element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

生成一个 XML 元素的字符串表示形式，包括所有子元素。 element 是一个 Element 实例。 encoding 1 是输出编码格式（默认为 US-ASCII）。 请使用 encoding="unicode" 来生成 Unicode 字符串（否则生成字节串）。 method 是 "xml", "html" 或 "text" (默认为 "xml")。 xml_declaration, default_namespace 和 short_empty_elements 具有与 ElementTree.write() 中一致的含义。 返回一个包含 XML 数据（可选）已编码字符串的列表。 它并不保证任何特定的序列，除了 b"".join(tostringlist(element)) == tostring(element)。

3.2 新版功能.

3.4 新版功能: short_empty_elements 形参。

3.8 新版功能: xml_declaration 和 default_namespace 形参。

在 3.8 版更改: tostringlist() 函数现在会保留用户指定的属性顺序。

xml.etree.ElementTree.XML(text, parser=None)

根据一个字符串常量解析 XML 的节。 此函数可被用于在 Python 代码中嵌入“XML 字面值”。 text 是包含 XML 数据的字符串。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 返回一个 Element 实例。

xml.etree.ElementTree.XMLID(text, parser=None)

根据一个字符串常量解析 XML 的节，并且还将返回一个将元素的 id:s 映射到元素的字典。 text 是包含 XML 数据的字符串。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 返回一个包含 Element 实例和字典的元组。

XInclude 支持

此模块通过 xml.etree.ElementInclude 辅助模块提供了对 XInclude 指令 [https://www.w3.org/TR/xinclude/] 的有限支持，这个模块可被用来根据元素树的信息在其中插入子树和文本字符串。

示例

以下是一个演示 XInclude 模块用法的例子。 要在当前文本中包括一个 XML 文档，请使用 {http://www.w3.org/2001/XInclude}include 元素并将 parse 属性设为 "xml"，并使用 href 属性来指定要包括的文档。

<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <xi:include href="source.xml" parse="xml" />
</document>

默认情况下，href 属性会被当作文件名来处理。 你可以使用自定义加载器来覆盖此行为。 还要注意标准辅助器不支持 XPointer 语法。

要处理这个文件，请正常加载它，并将根元素传给 xml.etree.ElementTree 模块:

from xml.etree import ElementTree, ElementInclude

tree = ElementTree.parse("document.xml")
root = tree.getroot()

ElementInclude.include(root)

ElementInclude 模块使用来自 source.xml 文档的根元素替代 {http://www.w3.org/2001/XInclude}include 元素。 结果看起来大概是这样:

<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <para>This is a paragraph.</para>
</document>

如果省略了 parse 属性，它会取默认的 "xml"。 要求有 href 属性。

要包括文本文档，请使用 {http://www.w3.org/2001/XInclude}include 元素，并将 parse 属性设为 "text":

<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) <xi:include href="year.txt" parse="text" />.
</document>

结果可能如下所示：

<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) 2003.
</document>

参考

函数

xml.etree.ElementInclude.default_loader(href, parse, encoding=None)

默认的加载器。 这个默认的加载器会从磁盘读取所包括的资源。 href 是一个 URL。 parse 是 "xml" 或 "text" 表示解析模式。 encoding 是可选的文本编码格式。 如果未给出，则编码格式为 utf-8。 返回已扩展的资源。 如果解析模式为 "xml"，则它是一个 ElementTree 实例。 如果解析模式为 "text"，则它是一个 Unicode 字符串。 如果加载器失败，它可以返回 None 或者引发异常。

xml.etree.ElementInclude.include(elem, loader=None, base_url=None, max_depth=6)

这个函数会扩展 XInclude 指令。 elem 是根元素。 loader 是可选的资源加载器。 如果省略，则它默认为 default_loader()。 如果给出，则它应当是一个实现了与 default_loader() 相同的接口的可调用对象。 base_url 是原文件的基准 URL，用于求解相对的包括文件引用。 max_depth 是递归包括的最大数量。 此限制是为了降低恶意内容爆破的风险。 传入一个负值可禁用此限制。

返回已扩展的资源。 如果解析模式为 "xml"，则它是一个 ElementTree 实例。 如果解析模式为 "text"，则它是一个 Unicode 字符串。 如果加载器失败，它可以返回 None 或者引发异常。

3.9 新版功能: base_url 和 max_depth 形参。

元素对象

class xml.etree.ElementTree.Element(tag, attrib={}, **extra)

元素类。 这个类定义了 Element 接口，并提供了这个接口的引用实现。

元素名、属性名和属性值可以是字节串或 Unicode 字符串。 tag 是元素名。 attrib 是一个可选的字典，其中包含元素属性。 extra 包含额外的属性，以关键字参数形式给出。

tag

一个标识此元素意味着何种数据的字符串(换句话说，元素类型)。

text

tail

这些属性可被用于存放与元素相关联的额外数据。 它们的值通常为字符串但也可以是任何应用专属的对象。 如果元素是基于 XML 文件创建的，text 属性会存放元素的开始标记及其第一个子元素或结束标记之间的文本，或者为 None，而 tail 属性会存放元素的结束标记及下一个标记之间的文本，或者为 None。 对于 XML 数据

<a><b>1<c>2<d/>3</c></b>4</a>

a 元素的 text 和 tail 属性均为 None，b 元素的 text 为 "1" 而 tail 为 "4"，c 元素的 text 为 "2" 而 tail 为 None，d 元素的 text 为 None 而 tail 为 "3"。

要获取一个元素的内部文本，请参阅 itertext()，例如 "".join(element.itertext())。

应用程序可以将任意对象存入这些属性。

attrib

一个包含元素属性的字典。 请注意虽然 attrib 值总是一个真正可变的 Python 字典，但 ElementTree 实现可以选择其他内部表示形式，并只在有需要时才创建字典。 为了发挥这种实现的优势，请在任何可能情况下使用下列字典方法。

以下字典类方法作用于元素属性。

clear()

重设一个元素。 此方法会移除所有子元素，清空所有属性，并将 text 和 tail 属性设为 None。

get(key, default=None)

获取名为 key 的元素属性。

返回属性的值，或者如果属性未找到则返回 default。

items()

将元素属性以 (name, value) 对序列的形式返回。 所返回属性的顺序任意。

keys()

将元素属性名称以列表的形式返回。 所返回名称的顺序任意。

set(key, value)

将元素的 key 属性设为 value。

以下方法作用于元素的下级（子元素）。

append(subelement)

将元素 subelement 添加到此元素的子元素内部列表。 如果 subelement 不是一个 Element 则会引发 TypeError。

extend(subelements)

使用具有零个或多个元素的序列对象添加 subelements。 如果某个子元素不是 Element 则会引发 TypeError。

3.2 新版功能.

find(match, namespaces=None)

查找第一个匹配 match 的子元素。 match 可以是一个标记名称或者 路径。 返回一个元素实例或 None。 namespaces 是可选的从命名空间前缀到完整名称的映射。 传入 '' 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。

findall(match, namespaces=None)

根据标记名称或者 路径 查找所有匹配的子元素。 返回一个包含所有匹配元素按文档顺序排序的列表。 namespaces 是可选的从命名空间前缀到完整名称的映射。 传入 '' 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。

findtext(match, default=None, namespaces=None)

查找第一个匹配 match 的子元素的文本。 match 可以是一个标记名称或者 路径。 反回第一个匹配的元素的文本内容，或者如果元素未找到则返回 default。 请注意如果匹配的元素没有文本内容则会返回一个空字符串。 namespaces 是可选的从命名空间前缀到完整名称的映射。 传入 '' 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。

insert(index, subelement)

将 subelement 插入到此元素的给定位置中。 如果 subelement 不是一个 Element 则会引发 TypeError。

iter(tag=None)

创建一个以当前元素为根元素的树的 iterator。 该迭代器将以文档（深度优先）顺序迭代此元素及其所有下级元素。 如果 tag 不为 None 或 '*'，则迭代器只返回标记为 tag 的元素。 如果树结构在迭代期间被修改，则结果是未定义的。

3.2 新版功能.

iterfind(match, namespaces=None)

根据标记名称或者 路径 查找所有匹配的子元素。 返回一个按文档顺序产生所有匹配元素的可迭代对象。 namespaces 是可选的从命名空间前缀到完整名称的映射。

3.2 新版功能.

itertext()

创建一个文本迭代器。 该迭代器将按文档顺序遍历此元素及其所有子元素，并返回所有内部文本。

3.2 新版功能.

makeelement(tag, attrib)

创建一个与此元素类型相同的新元素对象。 请不要调用此方法，而应改用 SubElement() 工厂函数。

remove(subelement)

从元素中移除 subelement。 与 find* 方法不同的是此方法会基于实例的标识来比较元素，而不是基于标记的值或内容。

Element 对象还支持下列序列类型方法以配合子元素使用: __delitem__(), __getitem__(), __setitem__(), __len__()。

注意：不带子元素的元素将被检测为 False。 此行为将在未来的版本中发生变化。 请改用 len(elem) 或 elem is None 进行检测。

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")

在 Python 3.8 之前，元素的 XML 属性的序列化顺序会通过按其名称排序来强制使其可被预期。 由于现在字典已保证是有序的，这个强制重排序在 Python 3.8 中已被移除以保留原本由用户代码解析或创建的属性顺序。

通常，用户代码应当尽量不依赖于特定的属性顺序，因为 XML 信息设定 [https://www.w3.org/TR/xml-infoset/] 明确地排除了用属性顺序转递信息的做法。 代码应当准备好处理任何输入顺序。 对于要求确定性的 XML 输出的情况，例如加密签名或检测数据集等，可以通过规范化 canonicalize() 函数来进行传统的序列化。

对于规范化输出不可用但仍然要求输出特定属性顺序的情况，代码应当设法直接按要求的顺序来创建属性，以避免代码阅读者产生不匹配的感觉。 如果这一点是难以做到的，可以在序列化之前应用以下写法来强制实现顺序不依赖于元素的创建:

def reorder_attributes(root):
    for el in root.iter():
        attrib = el.attrib
        if len(attrib) > 1:
            # adjust attribute order, e.g. by sorting
            attribs = sorted(attrib.items())
            attrib.clear()
            attrib.update(attribs)

ElementTree 对象

class xml.etree.ElementTree.ElementTree(element=None, file=None)

ElementTree 包装器类。 这个类表示一个完整的元素层级结构，并添加了一些对于标准 XML 序列化的额外支持。

element 是根元素。 如果给出 XML file 则将使用其内容来初始化树结构。

_setroot(element)

替换该树结构的根元素。 这将丢弃该树结构的当前内容，并将其替换为给定的元素。 请小心使用。 element 是一个元素实例。

find(match, namespaces=None)

与 Element.find() 类似，从树的根节点开始。

findall(match, namespaces=None)

与 Element.findall() 类似，从树的根节点开始。

findtext(match, default=None, namespaces=None)

与 Element.findtext() 类似，从树的根节点开始。

getroot()

返回这个树的根元素。

iter(tag=None)

创建并返回根元素的树结构迭代器。 该迭代器会以节顺序遍历这个树的所有元素。 tag 是要查找的标记（默认返回所有元素）。

iterfind(match, namespaces=None)

与 Element.iterfind() 类似，从树的根节点开始。

3.2 新版功能.

parse(source, parser=None)

将一个外部 XML 节载入到此元素树。 source 是一个文件名或 file object。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 返回该节的根元素。

write(file, encoding='us-ascii', xml_declaration=None, default_namespace=None, method='xml', *, short_empty_elements=True)

将元素树以 XML 格式写入到文件。 file 为文件名，或是以写入模式打开的 file object。 encoding 1 为输出编码格式 (默认为 US-ASCII)。 xml_declaration 控制是否要将 XML 声明添加到文件中。 使用 False 表示从不添加，True 表示总是添加，None 表示仅在非 US-ASCII 或 UTF-8 或 Unicode 时添加 (默认为 None)。 default_namespace 设置默认 XML 命名空间 (用于 "xmlns")。 method 为 "xml", "html" 或 "text" (默认为 "xml")。 仅限关键字形参 short_empty_elements 控制不包含内容的元素的格式。 如为 True (默认值)，它们会被输出为单个自结束标记，否则它们会被输出为一对开始/结束标记。

输出是一个字符串 (str) 或字节串 (bytes)。 由*encoding* 参数来控制。 如果 encoding 为 "unicode"，则输出是一个字符串；否则为字节串；请注意这可能与 file 的类型相冲突，如果它是一个打开的 file object 的话；请确保你不会试图写入字符串到二进制流或者反向操作。

3.4 新版功能: short_empty_elements 形参。

在 3.8 版更改: write() 方法现在会保留用户指定的属性顺序。

这是将要被操作的 XML 文件:

<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>

修改第一段中的每个链接的 "target" 属性的示例:

>>> from xml.etree.ElementTree import ElementTree
>>> tree = ElementTree()
>>> tree.parse("index.xhtml")
<Element 'html' at 0xb77e6fac>
>>> p = tree.find("body/p")     # Finds first occurrence of tag p in body
>>> p
<Element 'p' at 0xb77ec26c>
>>> links = list(p.iter("a"))   # Returns list of all links
>>> links
[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
>>> for i in links:             # Iterates through all found links
...     i.attrib["target"] = "blank"
>>> tree.write("output.xhtml")

QName 对象

class xml.etree.ElementTree.QName(text_or_uri, tag=None)

QName 包装器。 这可被用来包装 QName 属性值，以便在输出中获得适当的命名空间处理。 text_or_uri 是一个包含 QName 值的字符串，其形式为 {uri}local，或者如果给出了 tag 参数，则为 QName 的 URI 部分。 如果给出了 tag，则第一个参数会被解读为 URI，而这个参数会被解读为本地名称。 QName 实例是不透明的。

TreeBuilder 对象

class 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 函数，它们的行为应当像 Comment() 和 ProcessingInstruction() 函数一样创建注释和处理指令。 如果未给出，则将使用默认工厂函数。 当 insert_comments 和/或 insert_pis 为真值时，如果 comments/pis 在根元素之中（但不在其之外）出现则它们将被插入到树中。

close()

刷新构建器缓存，并返回最高层级的文档元素。 返回一个 Element 实例。

data(data)

将文本添加到当前元素。 data 为要添加的文本。 这应当是一个字节串或 Unicode 字符串。

end(tag)

关闭当前元素。 tag 是元素名称。 返回已关闭的元素。

start(tag, attrs)

打开一个新元素。 tag 是元素名称。 attrs 是包含元素属性的字典。 返回打开的元素。

comment(text)

使用给定的 text 创建一条注释。 如果 insert_comments 为真值，这还会将其添加到树结构中。

3.8 新版功能.

pi(target, text)

使用给定的 target 名称和 text 创建一条注释。 如果 insert_pis 为真值，这还会将其添加到树结构中。

3.8 新版功能.

此外，自定义的 TreeBuilder 对象还提供了以下方法:

doctype(name, pubid, system)

处理一条 doctype 声明。 name 为 doctype 名称。 pubid 为公有标识。 system 为系统标识。 此方法不存在于默认的 TreeBuilder 类中。

3.2 新版功能.

start_ns(prefix, uri)

在定义了 start() 回调的打开元素的该回调被调用之前，当解析器遇到新的命名空间声明时都会被调用。 prefix 对于默认命名空间为 '' 或者在其他情况下为被声明的命名空间前缀名称。 uri 是命名空间 URI。

3.8 新版功能.

end_ns(prefix)

在声明了命名空间前缀映射的元素的 end() 回调之后被调用，附带超出作用域的 prefix 的名称。

3.8 新版功能.

class 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 [https://www.w3.org/TR/xml-c14n2/] 写入器。 其参数与 canonicalize() 函数的相同。 这个类并不会构建树结构而是使用 write 函数将回调事件直接转换为序列化形式。

3.8 新版功能.

XMLParser对象

class xml.etree.ElementTree.XMLParser(*, target=None, encoding=None)

这个类是此模块的低层级构建单元。 它使用 xml.parsers.expat 来实现高效、基于事件的 XML 解析。 它可以通过 feed() 方法增量式地收受 XML 数据，并且解析事件会被转换为推送式 API —— 通过在 target 对象上发起对回调的调用。 如果省略 target，则会使用标准的 TreeBuilder。 如果给出了 encoding 1 ，该值将覆盖在 XML 文件中指定的编码格式。

在 3.8 版更改: 所有形参现在都是 仅限关键字形参。 html 参数不再受支持。

close()

结束向解析器提供数据。 返回调用在构造期间传入的 target 的 close() 方法的结果；在默认情况下，这是最高层级的文档元素。

feed(data)

将数据送入解析器。 data 是编码后的数据。

flush()

触发对之前送入的未解析数据的解析，这可被用于确保更为实时的反馈，尤其是对于 Expat >=2.6.0 的情况。 flush() 的实现会暂时禁用 Expat 的重新解析延迟（如果当前已启用）并触发重新解析。 禁用重新解析延迟会带来安全性的影响；请参阅 xml.parsers.expat.xmlparser.SetReparseDeferralEnabled() 了解详情。

请注意 flush() 已作为安全修正被向下移植到一些较早的 CPython 发布版。 如果在运行于多个 Python 版本的代码中要用到 flush() 请使用 hasattr() 来检查其可用性。

3.10.14 新版功能.

XMLParser.feed() 会为每个打开的标记调用 target 的 start(tag, attrs_dict) 方法，为每个关闭的标记调用它的 end(tag) 方法，并通过 data(data) 方法来处理数据。 有关更多受支持的回调方法，请参阅 TreeBuilder 类。 XMLParser.close() 会调用 target 的 close() 方法。 XMLParser 不仅仅可被用来构建树结构。 下面是一个统计 XML 文件最大深度的示例:

>>> from xml.etree.ElementTree import XMLParser
>>> class MaxDepth:                     # The target object of the parser
...     maxDepth = 0
...     depth = 0
...     def start(self, tag, attrib):   # Called for each opening tag.
...         self.depth += 1
...         if self.depth > self.maxDepth:
...             self.maxDepth = self.depth
...     def end(self, tag):             # Called for each closing tag.
...         self.depth -= 1
...     def data(self, data):
...         pass            # We do not need to do anything with data.
...     def close(self):    # Called when all data has been parsed.
...         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

XMLPullParser对象

class xml.etree.ElementTree.XMLPullParser(events=None)

适用于非阻塞应用程序的拉取式解析器。 它的输入侧 API 与 XMLParser 的类似，但不是向回调目标推送调用，XMLPullParser 会收集一个解析事件的内部列表并让用户来读取它。 events 是要报告的事件序列。 受支持的事件字符串有 "start", "end", "comment", "pi", "start-ns" 和 "end-ns" ("ns" 事件被用于获取详细的命名空间信息)。 如果 events 被省略，则只报告 "end" 事件。

feed(data)

将给定的字节数据送入解析器。

flush()

触发对之前送入的未解析数据的解析，这可被用于确保更为实时的反馈，尤其是对于 Expat >=2.6.0 的情况。 flush() 的实现会暂时禁用 Expat 的重新解析延迟（如果当前已启用）并触发重新解析。 禁用重新解析延迟会带来安全性的影响；请参阅 xml.parsers.expat.xmlparser.SetReparseDeferralEnabled() 了解详情。

请注意 flush() 已作为安全修正被向下移植到一些较早的 CPython 发布版。 如果在运行于多个 Python 版本的代码中要用到 flush() 请使用 hasattr() 来检查其可用性。

3.10.14 新版功能.

close()

通知解析器数据流已终结。 不同于 XMLParser.close()，此方法总是返回 None。 当解析器被关闭时任何还未被获取的事件仍可通过 read_events() 被读取。

read_events()

返回包含在送入解析器的数据中遇到的事件的迭代器。 此迭代器会产生 (event, elem) 对，其中 event 是代表事件类型的字符串 (例如 "end") 而 elem 是遇到的 Element 对象，或者以下的其他上下文值。

start, end: 当前元素。

comment, pi: 当前注释 / 处理指令

start-ns: 一个指定所声明命名空间映射的元组 (prefix, uri)。

end-ns: None (这可能在未来版本中改变)

在之前对 read_events() 的调用中提供的事件将不会被再次产生。 事件仅当它们从迭代器中被取出时才会在内部队列中被消费，因此多个读取方对获取自 read_events() 的迭代器进行平行迭代将产生无法预料的结果。

注解

XMLPullParser 只会确保当发出 "start" 事件时看到了开始标记的 ">" 字符，因而在这个点上属性已被定义，但文本内容和末尾属性还未被定义。 这同样适用于元素的下级；它们可能存在也可能不存在。

如果你需要已完全填充的元素，请改为查找 "end" 事件。

3.4 新版功能.

在 3.8 版更改: 增加了 comment 和 pi 事件。

异常

class xml.etree.ElementTree.ParseError

XML 解析器错误，由此模块中的多个解析方法在解析失败时引发。 此异常的实例的字符串表示将包含用户友好的错误消息。 此外，它将具有下列可用属性:

code

来自外部解析器的数字错误代码。 请参阅 xml.parsers.expat 的文档查看错误代码列表及它们的含义。

position

一个包含 line, column 数值的元组，指明错误发生的位置。

备注

1(1,2,3,4)

包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl 和 https://www.iana.org/assignments/character-sets/character-sets.xhtml。

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

源代码: Lib/xml/dom/__init__.py [https://github.com/python/cpython/tree/3.10/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 层级的建议。

DOM 应用程序通常从将某些 XML 解析为 DOM 开始。 此操作如何实现完全未被 DOM 第 1 层级所涉及，而第 2 层级也只提供了有限的改进：有一个 DOMImplementation 对象类，它提供对 Document 创建方法的访问，但却没有办法以不依赖具体实现的方式访问 XML 读取器/解析器/文档创建器。 也没有当不存在 Document 对象的情况下访问这些方法的定义良好的方式。 在 Python 中，每个 DOM 实现将提供一个函数 getDOMImplementation()。 DOM 第 3 层级增加了一个载入/存储规格说明，它定义了与读取器的接口，但这在 Python 标准库中尚不可用。

一旦你得到了 DOM 文档对象，你就可以通过 XML 文档的属性和方法访问它的各个部分。 这些属性定义在 DOM 规格说明当中；参考指南的这一部分描述了 Python 对此规格说明的解读。

W3C 提供的规格说明定义了适用于 Java, ECMAScript 和 OMG IDL 的 DOM API。 这里定义的 Python 映射很大程度上是基于此规格说明的 IDL 版本，但并不要求严格映射（但具体实现可以自由地支持对 IDL 的严格映射）。 请参阅 一致性 一节查看有关映射要求的详细讨论。

参见

文档对象模型 (DOM) 第 2 层级规格说明 [https://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/]

被 Python DOM API 作为基础的 W3C 建议。

文档对象模型 (DOM) 第 1 层级规格说明 [https://www.w3.org/TR/REC-DOM-Level-1/]

被 xml.dom.minidom 所支持的 W3C 针对 DOM 的建议。

Python 语言映射规格说明 [https://www.omg.org/spec/PYTH/1.2/PDF]

此文档指明了从 OMG IDL 到 Python 的映射。

模块内容

xml.dom 包含下列函数:

xml.dom.registerDOMImplementation(name, factory)

注册 factory 函数并使用名称 name。 该工厂函数应当返回一个实现了 DOMImplementation 接口的对象。 该工厂函数可每次都返回相同对象，或每次调用都返回新的对象，视具体实现的要求而定（例如该实现是否支持某些定制功能）。

xml.dom.getDOMImplementation(name=None, features=())

返回一个适当的 DOM 实现。 name 是通用名称、DOM 实现的模块名称或者 None。 如果它不为 None，则会导入相应模块并在导入成功时返回一个 DOMImplementation 对象。 如果没有给出名称，并且如果设置了 PYTHON_DOM 环境变量，此变量会被用来查找相应的实现。

如果未给出 name，此函数会检查可用的实现来查找具有所需特性集的一个。 如果找不到任何实现，则会引发 ImportError。 features 集必须是包含 (feature, version) 对的序列，它会被传给可用的 DOMImplementation 对象上的 hasFeature() 方法。

还提供了一些便捷常量:

xml.dom.EMPTY_NAMESPACE

该值用于指明没有命名空间被关联到 DOM 中的某个节点。 它通常被作为某个节点的 namespaceURI，或者被用作某个命名空间专属方法的 namespaceURI 参数。

xml.dom.XML_NAMESPACE

关联到保留前缀 xml 的命名空间 URI，如 XML 中的命名空间 [https://www.w3.org/TR/REC-xml-names/] （第 4 节） 所定义的。

xml.dom.XMLNS_NAMESPACE

命名空间声明的命名空间 URI，如 文档对象模型 (DOM) 第 2 层级核心规格说明 [https://www.w3.org/TR/DOM-Level-2-Core/core.html] (第 1.1.8节) 所定义的。

xml.dom.XHTML_NAMESPACE

XHTML 命名空间的 URI，如 XHTML 1.0: 扩展超文本标记语言 [https://www.w3.org/TR/xhtml1/] (第 3.1.1 节) 所定义的。

此外，xml.dom 还包含一个基本 Node 类和一些 DOM 异常类。 此模块提供的 Node 类未实现 DOM 规格描述所定义的任何方法和属性；实际的 DOM 实现必须提供它们。 提供 Node 类作为此模块的一部分并没有提供用于实际的 Node 对象的 nodeType 属性的常量；它们是位于类内而不是位于模块层级以符合 DOM 规格描述。

DOM 中的对象

DOM 的权威文档是来自 W3C 的 DOM 规格描述。

请注意，DOM 属性也可以作为节点而不是简单的字符串进行操作。 然而，必须这样做的情况相当少见，所以这种用法还没有被写入文档。

接口 | 部件 | 目的
DOMImplementation | DOMImplementation 对象 | 底层实现的接口。
Node | 节点对象 | 文档中大多数对象的基本接口。
NodeList | 节点列表对象 | 节点序列的接口。
DocumentType | 文档类型对象 | 有关处理文档所需声明的信息。
Document | Document 对象 | 表示整个文档的对象。
Element | 元素对象 | 文档层次结构中的元素节点。
Attr | Attr 对象 | 元素节点上的属性值节点。
Comment | 注释对象 | 源文档中注释的表示形式。
Text | Text 和 CDATASection 对象 | 包含文档中文本内容的节点。
ProcessingInstruction | ProcessingInstruction 对象 | 处理指令表示形式。

描述在 Python 中使用 DOM 定义的异常的小节。

DOMImplementation 对象

DOMImplementation 接口提供了一种让应用程序确定他们所使用的 DOM 中某一特性可用性的方式。 DOM 第 2 级还添加了使用 DOMImplementation 来创建新的 Document 和 DocumentType 对象的能力。

DOMImplementation.hasFeature(feature, version)

如果字符串对 feature 和 version 所标识的特性已被实现则返回 True。

DOMImplementation.createDocument(namespaceUri, qualifiedName, doctype)

返回一个新的 Document 对象 (DOM 的根节点)，包含一个具有给定 namespaceUri 和 qualifiedName 的下级 Element 对象。 doctype 必须为由 createDocumentType() 创建的 DocumentType 对象，或者为 None。 在 Python DOM API 中，前两个参数也可为 None 以表示不要创建任何下级 Element。

DOMImplementation.createDocumentType(qualifiedName, publicId, systemId)

返回一个新的封装了给定 qualifiedName, publicId 和 systemId 字符串的 DocumentType 对象，它表示包含在 XML 文档类型声明中的信息。

节点对象

XML 文档的所有组成部分都是 Node 的子类。

Node.nodeType

一个代表节点类型的整数。 类型符号常量在 Node 对象上: ELEMENT_NODE, ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, ENTITY_NODE, PROCESSING_INSTRUCTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE。 这是个只读属性。

Node.parentNode

当前节点的上级，或者对于文档节点则为 None。 该值总是一个 Node 对象或者 None。 对于 Element 节点，这将为上级元素，但对于根元素例外，在此情况下它将为 Document 对象。 对于 Attr 节点，它将总是为 None。 这是个只读属性。

Node.attributes

属性对象的 NamedNodeMap。 这仅对元素才有实际值；其它对象会为该属性提供 None 值。 这是个只读属性。

Node.previousSibling

在此节点之前具有相同上级的相邻节点。 例如结束标记紧接在在 self 元素的开始标记之前的元素。 当然，XML 文档并非只是由元素组成，因此之前相邻节点可以是文本、注释或者其他内容。 如果此节点是上级的第一个子节点，则该属性将为 None。 这是一个只读属性。

Node.nextSibling

在此节点之后具有相同上级的相邻节点。 另请参见 previousSibling。 如果此节点是上级的最后一个子节点，则该属性将为 None。 这是一个只读属性。

Node.childNodes

包含在此节点中的节点列表。 这是一个只读属性。

Node.firstChild

节点的第一个下级，如果有的话，否则为 None。 这是个只读属性。

Node.lastChild

节点的最后一个下级，如果有的话，否则为 None。 这是个只读属性。

Node.localName

tagName 在冒号之后的部分，如果有冒号的话，否则为整个 tagName。 该值为一个字符串。

Node.prefix

tagName 在冒号之前的部分，如果有冒号的话，否则为空字符串。 该值为一个字符串或者为 None。

Node.namespaceURI

关联到元素名称的命名空间。 这将是一个字符串或为 None。 这是个只读属性。

Node.nodeName

这对于每种节点类型具有不同的含义；请查看 DOM 规格说明来了解详情。 你总是可以从其他特征属性例如元素的 tagName 特征属性或属性的 name 特征属性获取你能从这里获取的信息。 对于所有节点类型，这个属性的值都将是一个字符串或为 None。 这是一个只读属性。

Node.nodeValue

这对于每种节点类型具有不同的含义；请查看 DOM 规格说明来了解详情。 具体情况与 nodeName 的类似。 该值是一个字符串或为 None。

Node.hasAttributes()

如果该节点具有任何属性则返回 True。

Node.hasChildNodes()

如果该节点具有任何子节点则返回 True。

Node.isSameNode(other)

如果 other 指向的节点就是此节点则返回 True。 这对于使用了任何代理架构的 DOM 实现来说特别有用（因为多个对象可能指向相同节点）。

注解

这是基于已提议的 DOM 第 3 等级 API，目前尚处于“起草”阶段，但这个特定接口看来并不存在争议。 来自 W3C 的修改将不会影响 Python DOM 接口中的这个方法（不过针对它的任何新 W3C API 也将受到支持）。

Node.appendChild(newChild)

在子节点列表末尾添加一个新的子节点，返回 newChild。 如果节点已存在于树结构中，它将先被移除。

Node.insertBefore(newChild, refChild)

在现有的子节点之前插入一个新的子节点。 它必须属于 refChild 是这个节点的子节点的情况；如果不是，则会引发 ValueError。newChild 会被返回。 如果 refChild 为 None，它会将 newChild 插入到子节点列表的末尾。

Node.removeChild(oldChild)

移除一个子节点。 oldChild 必须是这个节点的子节点；如果不是，则会引发 ValueError。 成功时 oldChild 会被返回。 如果 oldChild 将不再被继续使用，则将调用它的 unlink() 方法。

Node.replaceChild(newChild, oldChild)

将一个现有节点替换为新的节点。 这必须属于 oldChild 是该节点的子节点的情况；如果不是，则会引发 ValueError。

Node.normalize()

合并相邻的文本节点以便将所有文本段存储为单个 Text 实例。 这可以简化许多应用程序处理来自 DOM 树文本的操作。

Node.cloneNode(deep)

克隆此节点。 设置 deep 表示也克隆所有子节点。 此方法将返回克隆的节点。

节点列表对象

NodeList 代表一个节点列表。 在 DOM 核心建议中这些对象有两种使用方式: 由 Element 对象提供作为其子节点列表，以及由 Node 的 getElementsByTagName() 和 getElementsByTagNameNS() 方法通过此接口返回对象来表示查询结果。

DOM 第 2 层级建议为这些对象定义一个方法和一个属性:

NodeList.item(i)

从序列中返回第 i 项，如果序列不为空的话，否则返回 None。 索引号 i 不允许小于零或大于等于序列的长度。

NodeList.length

序列中的节点数量。

此外，Python DOM 接口还要求提供一些额外支持来允许将 NodeList 对象用作 Python 序列。 所有 NodeList 实现都必须包括对 __len__() 和 __getitem__() 的支持；这样 NodeList 就允许使用 for 语句进行迭代并能正确地支持 len() 内置函数。

如果一个 DOM 实现支持文档的修改，则 NodeList 实现还必须支持 __setitem__() 和 __delitem__() 方法。

文档类型对象

有关一个文档所声明的标注和实体的信息（包括解析器所使用并能提供信息的外部子集）可以从 DocumentType 对象获取。 文档的 DocumentType 可从 Document 对象的 doctype 属性中获取；如果一个文档没有 DOCTYPE 声明，则该文档的 doctype 属性将被设为 None 而非此接口的一个实例。

DocumentType 是 Node 是专门化，并增加了下列属性:

DocumentType.publicId

文档类型定义的外部子集的公有标识。 这将为一个字符串或者为 None。

DocumentType.systemId

文档类型定义的外部子集的系统标识。 这将为一个字符串形式的 URI，或者为 None。

DocumentType.internalSubset

一个给出来自文档的完整内部子集的字符串。 这不包括子集外面的圆括号。 如果文档没有内部子集，则应为 None。

DocumentType.name

DOCTYPE 声明中给出的根元素名称，如果有的话。

DocumentType.entities

这是给出外部实体定义的 NamedNodeMap。 对于多次定义的实体名称，则只提供第一次的定义（其他的会按照 XML 建议被忽略）。 这可能为 None，如果解析器未提供此信息，或者如果未定义任何实体的话。

DocumentType.notations

这是给出标注定义的 NamedNodeMap。 对于多次定义的标注，则只提供第一次的定义（其他的会按照 XML 建议被忽略）。 这可能为 None，如果解析器未提供此信息，或者如果未定义任何标注的话。

Document 对象

Document 代表一个完整的 XML 文档，包括其组成元素、属性、处理指令和注释等。 请记住它会继承来自 Node 的属性。

Document.documentElement

文档唯一的根元素。

Document.createElement(tagName)

创建并返回一个新的元素节点。 当元素被创建时不会被插入到文档中。 你需要通过某个其他方法例如 insertBefore() 或 appendChild() 来显示地插入它。

Document.createElementNS(namespaceURI, tagName)

创建并返回一个新的带有命名空间的元素。 tagName 可以带有前缀。 当元素被创建时不会被插入到文档中。 你需要通过某个其他方法例如 insertBefore() 或 appendChild() 来显式地插入它。

Document.createTextNode(data)

创建并返回一个包含作为形参被传入的数据的文本节点。 与其他创建方法一样，此方法不会将节点插入到树中。

Document.createComment(data)

创建并返回一个包含作为形参被传入的数据的注释节点。 与其他创建方法一样，此方法不会将节点插入到树中。

Document.createProcessingInstruction(target, data)

创建并返回一个包含作为形参被传入的 target 和 data 的处理指令节点。 与其他创建方法一样，此方法不会将节点插入到树中。

Document.createAttribute(name)

创建并返回一个属性节点。 此方法不会将属性节点关联到任何特定的元素。 你必须在正确的 Element 对象上使用 setAttributeNode() 来使用新创建的属性实例。

Document.createAttributeNS(namespaceURI, qualifiedName)

创建并返回一个带有命名空间的属性节点。 tagName 可以带有前缀。 此方法不会将属性节点关联到任何特定的元素。 你必须在正确的 Element 对象上使用 setAttributeNode() 来使用新创建的属性实例。

Document.getElementsByTagName(tagName)

搜索全部具有特定元素类型名称的后继元素（直接下级、下级的下级等等）。

Document.getElementsByTagNameNS(namespaceURI, localName)

搜索全部具有特定命名空间 URI 和 localname 的后继元素（直接下级、下级的下级等等）。 localname 是命名空间在前缀之后的部分。

元素对象

Element 是 Node 的子类，因此会继承该类的全部属性。

Element.tagName

元素类型名称。 在使用命名空间的文档中它可能包含冒号。 该值是一个字符串。

Element.getElementsByTagName(tagName)

与 Document 类中的对应方法相同。

Element.getElementsByTagNameNS(namespaceURI, localName)

与 Document 类中的对应方法相同。

Element.hasAttribute(name)

如果元素带有名称为 name 的属性则返回 True。

Element.hasAttributeNS(namespaceURI, localName)

如果元素带有名称为 namespaceURI 加 localName 的属性则返回 True。

Element.getAttribute(name)

将名称为 name 的属性的值作为字符串返回。 如果指定属性不存在，则返回空字符串，就像该属性没有对应的值一样。

Element.getAttributeNode(attrname)

返回名称为 attrname 的属性对应的 Attr 节点。

Element.getAttributeNS(namespaceURI, localName)

将名称为 namespaceURI 加 localName 的属性的值作为字符串返回。 如果指定属性不存在，则返回空字符串，就像该属性没有对应的值一样。

Element.getAttributeNodeNS(namespaceURI, localName)

将给定 namespaceURI 加 localName 的属性的值作为节点返回。

Element.removeAttribute(name)

移除指定名称的节点。 如果没有匹配的属性，则会引发 NotFoundErr。

Element.removeAttributeNode(oldAttr)

从属性列表中移除并返回 oldAttr，如果该属性存在的话。 如果 oldAttr 不存在，则会引发 NotFoundErr。

Element.removeAttributeNS(namespaceURI, localName)

移除指定名称的属性。 请注意它是使用 localName 而不是 qname。 如果没有匹配的属性也不会引发异常。

Element.setAttribute(name, value)

将属性值设为指定的字符串。

Element.setAttributeNode(newAttr)

将一个新的属性节点添加到元素，当匹配到 name 属性时如有必要会替换现有的属性。 如果发生了替换，将返回原有属性节点。 如果 newAttr 已经被使用，则会引发 InuseAttributeErr。

Element.setAttributeNodeNS(newAttr)

将一个新的属性节点添加到元素，当匹配到 namespaceURI 和 localName 属性时如有必要会替换现有的属性。 如果发生了替换，将返回原有属性节点。 如果 newAttr 已经被使用，则会引发 InuseAttributeErr。

Element.setAttributeNS(namespaceURI, qname, value)

将属性值设为 namespaceURI 和 qname 所给出的字符串。 请注意 qname 是整个属性名称。 这与上面的方法不同。

Attr 对象

Attr 继承自 Node，因此会继承其全部属性。

Attr.name

属性名称。 在使用命名空间的文档中可能会包括冒号。

Attr.localName

名称在冒号之后的部分，如果有的话，否则为完整名称。 这是个只读属性。

Attr.prefix

名称在冒号之前的部分，如果有冒号的话，否则为空字符串。

Attr.value

属性的文本值。 这与 nodeValue 属性同义。

NamedNodeMap 对象

NamedNodeMap 不是 继承自 Node。

NamedNodeMap.length

属性列表的长度。

NamedNodeMap.item(index)

返回特定带有索引号的属性。 获取属性的顺序是强制规定的，但在 DOM 的生命期内会保持一致。 其中每一项均为属性节点。 可使用 value 属性获取其值。

还有一些试验性方法给予这个类更多的映射行为。 你可以使用这些方法或者使用 Element 对象上标准化的 getAttribute*() 方法族。

注释对象

Comment 代表 XML 文档中的注释。 它是 Node 的子类，但不能拥有下级节点。

Comment.data

注释的内容是一个字符串。 该属性包含在开头 <!-- 和末尾 --> 之间的所有字符，但不包括这两个符号。

Text 和 CDATASection 对象

Text 接口代表 XML 文档中的文本。 如果解析器和 DOM 实现支持 DOM 的 XML 扩展，则包裹在 CDATA 标记的节中的部分会被存储到 CDATASection 对象中。 这两个接口很相似，但是提供了不同的 nodeType 属性值。

这些接口扩展了 Node 接口。 它们不能拥有下级节点。

Text.data

字符串形式的文本节点内容。

注解

CDATASection 节点的使用并不表示该节点代表一个完整的 CDATA 标记节，只是表示该节点的内容是 CDATA 节的一部分。 单个 CDATA 节可以由文档树中的多个节点来表示。 没有什么办法能确定两个相邻的 CDATASection 节点是否代表不同的 CDATA 标记节。

ProcessingInstruction 对象

代表 XML 文档中的处理指令。 它继承自 Node 接口并且不能拥有下级节点。

ProcessingInstruction.target

到第一个空格符为止的处理指令内容。 这是个只读属性。

ProcessingInstruction.data

在第一个空格符之后的处理指令内容。

异常

DOM 第 2 层级推荐定义一个异常 DOMException，以及多个变量用来允许应用程序确定发生了何种错误。 DOMException 实例带有 code 属性用来提供特定异常所对应的值。

Python DOM 接口提供了一些常量，但还扩展了异常集以使 DOM 所定义的每个异常代码都存在特定的异常。 接口的具体实现必须引发正确的特定异常，它们各自带有正确的 code 属性值。

exception xml.dom.DOMException

所有特定 DOM 异常所使用的异常基类。 该异常类不可被直接实例化。

exception xml.dom.DomstringSizeErr

当指定范围的文本不能适配一个字符串时被引发。 此异常在 Python DOM 实现中尚不可用，但可从不是以 Python 编写的 DOM 实现中接收。

exception xml.dom.HierarchyRequestErr

当尝试插入一个节点但该节点类型不被允许时被引发。

exception xml.dom.IndexSizeErr

当一个方法的索引或大小参数为负值或超出允许的值范围时被引发。

exception xml.dom.InuseAttributeErr

当尝试插入一个 Attr 节点但该节点已存在于文档中的某处时被引发。

exception xml.dom.InvalidAccessErr

当某个参数或操作在底层对象中不受支持时被引发。

exception xml.dom.InvalidCharacterErr

当某个字符串参数包含的字符在使用它的上下文中不被 XML 1.0 标准建议所允许时引发。 例如，尝试创建一个元素类型名称中带有空格的 Element 节点将导致此错误被引发。

exception xml.dom.InvalidModificationErr

当尝试修改某个节点的类型时被引发。

exception xml.dom.InvalidStateErr

当尝试使用未定义或不再可用的的对象时被引发。

exception xml.dom.NamespaceErr

如果试图以 XML 中的命名空间 [https://www.w3.org/TR/REC-xml-names/] 建议所不允许的方式修改任何对象，则会引发此异常。

exception xml.dom.NotFoundErr

当某个节点不存在于被引用的上下文中时引发的异常。 例如，NamedNodeMap.removeNamedItem() 将在所传入的节点不在于于映射中时引发此异常。

exception xml.dom.NotSupportedErr

当具体实现不支持所请求的对象类型或操作时被引发。

exception xml.dom.NoDataAllowedErr

当为某个不支持数据 的节点指定数据时被引发。

exception xml.dom.NoModificationAllowedErr

当尝试修改某个不允许修改的对象（例如只读节点）时被引发。

exception xml.dom.SyntaxErr

当指定了无效或非法的字符串时被引发。

exception xml.dom.WrongDocumentErr

当将某个节点插入非其当前所属的另一个文档，并且具体实现不支持从一个文档向一个文档迁移节点时被引发。

DOM 建议映射中针对上述异常而定义的异常代码如下表所示:

常量 | 异常
DOMSTRING_SIZE_ERR | DomstringSizeErr
HIERARCHY_REQUEST_ERR | HierarchyRequestErr
INDEX_SIZE_ERR | IndexSizeErr
INUSE_ATTRIBUTE_ERR | InuseAttributeErr
INVALID_ACCESS_ERR | InvalidAccessErr
INVALID_CHARACTER_ERR | InvalidCharacterErr
INVALID_MODIFICATION_ERR | InvalidModificationErr
INVALID_STATE_ERR | InvalidStateErr
NAMESPACE_ERR | NamespaceErr
NOT_FOUND_ERR | NotFoundErr
NOT_SUPPORTED_ERR | NotSupportedErr
NO_DATA_ALLOWED_ERR | NoDataAllowedErr
NO_MODIFICATION_ALLOWED_ERR | NoModificationAllowedErr
SYNTAX_ERR | SyntaxErr
WRONG_DOCUMENT_ERR | WrongDocumentErr

一致性

本节描述了 Python DOM API、W3C DOM 建议以及 Python 的 OMG IDL 映射之间的一致性要求和关系。

类型映射

将根据下表，将DOM规范中使用的IDL类型映射为Python类型。

IDL 类型 | Python 类型
boolean | bool 或 int
int | int
long int | int
unsigned int | int
DOMString | str 或 bytes
null | None

访问器方法

从 OMG IDL 到 Python 的映射以类似于 Java 映射的方式定义了针对 IDL attribute 声明的访问器函数。 映射以下 IDL 声明

readonly attribute string someValue;
         attribute string anotherValue;

会产生三个访问器函数: someValue 的 "get" 方法 (_get_someValue())，以及 anotherValue 的 "get" 和 "set" 方法 (_get_anotherValue() 和 _set_anotherValue())。 特别地，该映射不要求 IDL 属性像普通 Python 属性那样可访问: object.someValue 并非 必须可用，并可能引发 AttributeError。

但是，Python DOM API 则 确实 要求普通属性访问可用。 这意味着由 Python IDL 解译器生成的典型代理有可能会不可用，如果 DOM 对象是通过 CORBA 来访问则在客户端可能需要有包装对象。 虽然这确实要求为 CORBA DOM 客户端进行额外的考虑，但具有从 Python 通过 CORBA 使用 DOM 经验的实现并不会认为这是个问题。 已经声明了 readonly 的属性不必在所有 DOM 实现中限制写入访问。

在 Python DOM API 中，访问器函数不是必须的。 如果提供，则它们应当采用由 Python IDL 映射所定义的形式，但这些方法会被认为不必要，因为这些属性可以从 Python 直接访问。 永远都不要为 readonly 属性提供 "set" 访问器。

IDL 定义没有完全体现 W3C DOM API 的要求，如特定对象的概念，又如 getElementsByTagName() 的返回值为 "live" 等。 Python DOM API 并不强制具体实现执行这些要求。

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

源代码: Lib/xml/dom/minidom.py [https://github.com/python/cpython/tree/3.10/Lib/xml/dom/minidom.py]

xml.dom.minidom 是文档对象模型接口的最小化实现，具有与其他语言类似的 API。 它的目标是比完整 DOM 更简单并且更为小巧。 对于 DOM 还不十分熟悉的用户则应当考虑改用 xml.etree.ElementTree 模块来进行 XML 处理。

警告

xml.dom.minidom 模块对于恶意构建的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

DOM 应用程序通常会从将某个 XML 解析为 DOM 开始。 使用 xml.dom.minidom 时，这是通过各种解析函数来完成的:

from xml.dom.minidom import parse, parseString

dom1 = parse('c:\\temp\\mydata.xml')  # parse an XML file by name

datasource = open('c:\\temp\\mydata.xml')
dom2 = parse(datasource)  # parse an open file

dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>')

parse() 函数可接受一个文件名或者打开的文件对象。

xml.dom.minidom.parse(filename_or_file, parser=None, bufsize=None)

根据给定的输入返回一个 Document。 filename_or_file 可以是一个文件名，或是一个文件型对象。 如果给定 parser 则它必须是一个 SAX2 解析器对象。 此函数将修改解析器的处理程序并激活命名空间支持；其他解析器配置（例如设置一个实体求解器）必须已经提前完成。

如果你将 XML 存放为字符串形式，则可以改用 parseString() 函数:

xml.dom.minidom.parseString(string, parser=None)

返回一个代表 string 的 Document。 此方法会为指定字符串创建一个 io.StringIO 对象并将其传递给 parse()。

两个函数均返回一个代表文档内容的 Document 对象。object representing the content of the document.

parse() 和 parseString() 函数所做的是将 XML 解析器连接到一个 "DOM 构建器"，它可以从任意 SAX 解析器接收解析事件并将其转换为 DOM 树结构。 这两个函数的名称可能有些误导性，但在学习此接口时是很容易掌握的。 文档解析操作将在这两个函数返回之前完成；简单地说这两个函数本身并不提供解析器实现。

你也可以通过在一个 "DOM 实现" 对象上调用方法来创建 Document。 此对象可通过调用 xml.dom 包或者 xml.dom.minidom 模块中的 getDOMImplementation() 函数来获取。 一旦你获得了一个 Document，你就可以向它添加子节点来填充 DOM:

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)

一旦你得到了 DOM 文档对象，你就可以通过其属性和方法访问对应 XML 文档的各个部分。 这些属性定义在 DOM 规格说明当中；文档对象的主要特征属性是 documentElement。 它给出了 XML 文档中的主元素：即包含了所有其他元素的元素。 以下是一个示例程序:

dom3 = parseString("<myxml>Some data</myxml>")
assert dom3.documentElement.tagName == "myxml"

当你完成对一个 DOM 树的处理时，你可以选择调用 unlink() 方法来鼓励尽早清除已不再需要的对象。 unlink() 是针对 DOM API 的 xml.dom.minidom 专属扩展，它会将特定节点及其下级标记为不再有用。 在其他情况下，Python 的垃圾回收器将负责最终处理树结构中的对象。

参见

文档对象模型 (DOM) 第 1 层级规格说明 [https://www.w3.org/TR/REC-DOM-Level-1/]

被 xml.dom.minidom 所支持的 W3C 针对 DOM 的建议。

DOM 对象

Python 的 DOM API 定义被作为 xml.dom 模块文档的一部分给出。 这一节列出了该 API 和 xml.dom.minidom 之间的差异。

Node.unlink()

破坏 DOM 的内部引用以便它能在没有循环 GC 的 Python 版本上垃圾回收器回收。 即使在循环 GC 可用的时候，使用此方法也可让大量内存更快变为可用，因此当 DOM 对象不再被需要时尽早调用它们的这个方法是很好的做法。 此方法只须在 Document 对象上调用，但也可以在下级节点上调用以丢弃该节点的下级节点。

你可以通过使用 with 语句来避免显式调用此方法。 以下代码会在 with 代码块退出时自动取消链接 dom:

with xml.dom.minidom.parse(datasource) as dom:
    ... # Work with dom.

Node.writexml(writer, indent='', addindent='', newl='', encoding=None, standalone=None)

将 XML 写入到写入器对象。 写入器接受文本而非字节串作为输入，它应当具有与文件对象接口相匹配的 write() 方法。 indent 形参是当前节点的缩进层级。 addindent 形参是用于当前节点的下级节点的缩进量。 newl 形参指定用于一行结束的字符串。

对于 Document 节点，可以使用附加的关键字参数 encoding 来指定 XML 标头的编码格式字段。

类似地，显式指明 standalone 参数将会使单独的文档声明被添加到 XML 文档的开头部分。 如果将该值设为 True，则会添加 standalone="yes"，否则它会被设为 "no"。 未指明该参数将使文档声明被省略。

在 3.8 版更改: writexml() 方法现在会保留用户指定的属性顺序。

在 3.9 版更改: 增加了 standalone 形参。

Node.toxml(encoding=None, standalone=None)

返回一个包含 XML DOM 节点所代表的 XML 的字符串或字节串。

带有显式的 encoding 1 参数时，结果为使用指定编码格式的字节串。 没有 encoding 参数时，结果为 Unicode 字符串，并且结果字符串中的 XML 声明将不指定编码格式。 使用 UTF-8 以外的编码格式对此字符串进行编码通常是不正确的，因为 UTF-8 是 XML 的默认编码格式。

standalone 参数的行为与 writexml() 中的完全一致。

在 3.8 版更改: toxml() 方法现在会保留用户指定的属性顺序。

在 3.9 版更改: 增加了 standalone 形参。

Node.toprettyxml(indent='\t', newl='\n', encoding=None, standalone=None)

返回文档的美化打印版本。 indent 指定缩进字符串并默认为制表符；newl 指定标示每行结束的字符串并默认为 \n。

encoding 参数的行为类似于 toxml() 的对应参数。

standalone 参数的行为与 writexml() 中的完全一致。

在 3.8 版更改: toprettyxml() 方法现在会保留用户指定的属性顺序。

在 3.9 版更改: 增加了 standalone 形参。

DOM 示例

此示例程序是个相当实际的简单程序示例。 在这个特定情况中，我们没有过多地利用 DOM 的灵活性。

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 ''.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("<title>%s</title>" % getText(title.childNodes))

def handleSlideTitle(title):
    print("<h2>%s</h2>" % getText(title.childNodes))

def handlePoints(points):
    print("<ul>")
    for point in points:
        handlePoint(point)
    print("</ul>")

def handlePoint(point):
    print("<li>%s</li>" % getText(point.childNodes))

def handleToc(slides):
    for slide in slides:
        title = slide.getElementsByTagName("title")[0]
        print("<p>%s</p>" % getText(title.childNodes))

handleSlideshow(dom)

minidom 和 DOM 标准

xml.dom.minidom 模块实际上是兼容 DOM 1.0 的 DOM 并带有部分 DOM 2 特性（主要是命名空间特性）。

Python 中 DOM 接口的用法十分直观。 会应用下列映射规则:

接口是通过实例对象来访问的。 应用程序不应实例化这些类本身；它们应当使用 Document 对象提供的创建器函数。 派生的接口支持上级接口的所有操作（和属性），并添加了新的操作。

操作以方法的形式使用。 因由 DOM 只使用 in 形参，参数是以正常顺序传入的（从左至右）。 不存在可选参数。 void 操作返回 None。

IDL 属性会映射到实例属性。 为了兼容针对 Python 的 OMG IDL 语言映射，属性 foo 也可通过访问器方法 _get_foo() 和 _set_foo() 来访问。 readonly 属性不可被修改；运行时并不强制要求这一点。

short int, unsigned int, unsigned long long 和 boolean 类型都会映射为 Python 整数类型。

DOMString 类型会映射为 Python 字符串。 xml.dom.minidom 支持字节串或字符串，但通常是产生字符串。 DOMString 类型的值也可以为 None，W3C 的 DOM 规格说明允许其具有 IDL null 值。

const 声明会映射为它们各自的作用域内的变量 (例如 xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE)；它们不可被修改。

DOMException 目前不被 xml.dom.minidom 所支持。 xml.dom.minidom 会改为使用标准 Python 异常例如 TypeError 和 AttributeError。

NodeList 对象是使用 Python 内置列表类型来实现的。 这些对象提供了 DOM 规格说明中定义的接口，但在较早版本的 Python 中它们不支持官方 API。 相比在 W3C 建议中定义的接口，它们要更加的 "Pythonic"。

下列接口未在 xml.dom.minidom 中实现:

DOMTimeStamp

EntityReference

这些接口所反映的 XML 文档信息对于大多数 DOM 用户来说没有什么帮助。

备注

1

包括在 XML 输出中的编码格式名称应当遵循适当的标准。 例如，"UTF-8" 是有效的，但 "UTF8" 在 XML 文档的声明中是无效的，即使 Python 接受其作为编码格式名称。 详情参见 https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl 和 https://www.iana.org/assignments/character-sets/character-sets.xhtml。

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

源代码: Lib/xml/dom/pulldom.py [https://github.com/python/cpython/tree/3.10/Lib/xml/dom/pulldom.py]

xml.dom.pulldom 模块提供了一个“拉取解析器”，它能在必要时被用于产生文件的可访问 DOM 的片段。 其基本概念包括从输入的 XML 流拉取“事件”并处理它们。 与同样地同时应用了事件驱动处理模型加回调函数的 SAX 不同，拉取解析器的用户要负责显式地从流拉取事件，并循环遍历这些事件直到处理结束或者发生了错误条件。

警告

xml.dom.pulldom 模块对于恶意构建的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

在 3.7.1 版更改: SAX 解析器默认不再处理一般外部实体以提升在默认情况下的安全性。 要启用外部实体处理，请传入一个自定义的解析器实例:

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)

示例:

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())

event 是一个常量，可以取下列值之一:

START_ELEMENT

END_ELEMENT

COMMENT

START_DOCUMENT

END_DOCUMENT

CHARACTERS

PROCESSING_INSTRUCTION

IGNORABLE_WHITESPACE

node 是一个 xml.dom.minidom.Document, xml.dom.minidom.Element 或 xml.dom.minidom.Text 类型的对象。

由于文档是被当作“展平”的事件流来处理的，文档“树”会被隐式地遍历并且无论所需元素在树中的深度如何都会被找到。 换句话说，不需要考虑层级问题，例如文档节点的递归搜索等，但是如果元素的内容很重要，则有必要保留一些上下文相关的状态（例如记住任意给定点在文档中的位置）或者使用 DOMEventStream.expandNode() 方法并切换到 DOM 相关的处理过程。

class xml.dom.pulldom.PullDom(documentFactory=None)

xml.sax.handler.ContentHandler 的子类。

class xml.dom.pulldom.SAX2DOM(documentFactory=None)

xml.sax.handler.ContentHandler 的子类。

xml.dom.pulldom.parse(stream_or_string, parser=None, bufsize=None)

基于给定的输入返回一个 DOMEventStream。 stream_or_string 可以是一个文件名，或是一个文件型对象。 parser 如果给出，则必须是一个 XMLReader 对象。 此函数将改变解析器的文档处理程序并激活命名空间支持；其他解析器配置（例如设置实体解析器）必须在之前已完成。

如果你将 XML 存放为字符串形式，则可以改用 parseString() 函数:

xml.dom.pulldom.parseString(string, parser=None)

返回一个 DOMEventStream 来表示 (Unicode) string。

xml.dom.pulldom.default_bufsize

将 bufsize 形参的默认值设为 parse()。

此变量的值可在调用 parse() 之前修改并使新值生效。

DOMEventStream 对象

class xml.dom.pulldom.DOMEventStream(stream, parser, bufsize)

3.8 版后已移除: 对 序列协议 的支持已被弃用。

getEvent()

返回一个元组，其中包含 event 和 xml.dom.minidom.Document 形式的当前 node 如果 event 等于 START_DOCUMENT，包含 xml.dom.minidom.Element 如果 event 等于 START_ELEMENT 或 END_ELEMENT 或者 xml.dom.minidom.Text 如果 event 等于 CHARACTERS。 当前 node 不包含有关其子节点的信息，除非 expandNode() 被调用。

expandNode(node)

将 node 的所有子节点扩展到 node 中。 例如:

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':
        # Following statement only prints '<p/>'
        print(node.toxml())
        doc.expandNode(node)
        # Following statement prints node with all its children '<p>Some text <div>and more</div></p>'
        print(node.toxml())

reset()

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

源代码: Lib/xml/sax/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/xml/sax/__init__.py]

xml.sax 包提供多个模块，它们在 Python 上实现了用于 XML (SAX) 接口的简单 API。 这个包本身为 SAX API 用户提供了一些最常用的 SAX 异常和便捷函数。

警告

xml.sax 模块对于恶意构建的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

在 3.7.1 版更改: SAX 解析器默认不会再处理通用外部实体以便提升安全性。 在此之前，解析器会创建网络连接来获取远程文件或是从 DTD 和实体文件系统中加载本地文件。 此特性可通过在解析器对象上调用 setFeature() 对象并传入参数 feature_external_ges 来重新启用。

可用的便捷函数如下所列:

xml.sax.make_parser(parser_list=[])

创建并返回一个 SAX XMLReader 对象。 将返回第一个被找到的解析器。 如果提供了 parser_list，它必须为一个包含字符串的可迭代对象，这些字符串指定了具有名为 create_parser() 函数的模块。 在 parser_list 中列出的模块将在默认解析器列表中的模块之前被使用。

在 3.8 版更改: parser_list 参数可以是任意可迭代对象，而不一定是列表。

xml.sax.parse(filename_or_stream, handler, error_handler=handler.ErrorHandler())

创建一个 SAX 解析器并用它来解析文档。 用于传入文档的 filename_or_stream 可以是一个文件名或文件对象。 handler 形参必须是一个 SAX ContentHandler 实例。 如果给出了 error_handler，则它必须是一个 SAX ErrorHandler 实例；如果省略，则对于任何错误都将引发 SAXParseException。 此函数没有返回值；所有操作必须由传入的 handler 来完成。

xml.sax.parseString(string, handler, error_handler=handler.ErrorHandler())

类似于 parse()，但解析对象是作为形参传入的缓冲区 string。 string 必须为 str 实例或者 bytes-like object。

在 3.5 版更改: 增加了对 str 实例的支持。

典型的 SAX 应用程序会使用三种对象：读取器、处理器和输入源。 “读取器”在此上下文中与解析器同义，即某个从输入源读取字节或字符，并产生事件序列的代码段。 事件随后将被分发给处理器对象，即由读取器唤起处理器上的某个方法。 因此 SAX 应用程序必须获取一个读取器对象，创建或打开输入源，创建处理器，并一起连接到这些对象。 作为准备工作的最后一步，将调用读取器来解析输入内容。 在解析过程中，会根据来自输入数据的结构化和语义化事件来调用处理器对象上的方法。

就这些对象而言，只有接口部分是需要关注的；它们通常不是由应用程序本身来实例化。 由于 Python 没有显式的接口标记法，它们的正式引入形式是类，但应用程序可能会使用并非从已提供的类继承而来的实现。 InputSource, Locator, Attributes, AttributesNS 以及 XMLReader 接口是在 xml.sax.xmlreader 模块中定义的。 处理器接口是在 xml.sax.handler 中定义的。 为了方便起见，InputSource (它往往会被直接实例化) 和处理器类也可以从 xml.sax 获得。 这些接口的描述见下文。

除了这些类，xml.sax 还提供了如下异常类。

exception xml.sax.SAXException(msg, exception=None)

封装某个 XML 错误或警告。 这个类可以包含来自 XML 解析器或应用程序的基本错误或警告信息：它可以被子类化以提供额外的功能或是添加本地化信息。 请注意虽然在 ErrorHandler 接口中定义的处理器可以接收该异常的实例，但是并不要求实际引发该异常 --- 它也可以被用作信息的容器。

当实例化时，msg 应当是适合人类阅读的错误描述。 如果给出了可选的 exception 形参，它应当为 None 或者解析代码所捕获的异常并会被作为信息传递出去。

这是其他 SAX 异常类的基类。

exception xml.sax.SAXParseException(msg, exception, locator)

SAXException 的子类，针对解析错误引发。 这个类的实例会被传递给 SAX ErrorHandler 接口的方法来提供关于解析错误的信息。 这个类支持 SAX Locator 接口以及 SAXException 接口。

exception xml.sax.SAXNotRecognizedException(msg, exception=None)

SAXException 的子类，当 SAX XMLReader 遇到不可识别的特性或属性时引发。 SAX 应用程序和扩展可能会出于类似目的而使用这个类。

exception xml.sax.SAXNotSupportedException(msg, exception=None)

SAXException 的子类，当 SAX XMLReader 被要求启用某个不受支持的特性，或者将某个属性设为具体实现不支持的值时引发。 SAX 应用程序和扩展可能会出于类似目的而使用这个类。

参见

SAX: The Simple API for XML [http://www.saxproject.org/]

这个网站是 SAX API 定义的焦点。 它提供了一个 Java 实现以及在线文档。 还包括其他实现的链接和历史信息。

xml.sax.handler 模块

应用程序所提供对象的接口定义。

xml.sax.saxutils 模块

可在 SAX 应用程序中使用的便捷函数。

xml.sax.xmlreader 模块

解析器所提供对象的接口定义。

SAXException 对象

SAXException 异常类支持下列方法:

SAXException.getMessage()

返回描述错误条件的适合人类阅读的消息。

SAXException.getException()

返回一个封装的异常对象或者 None。

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

源代码: Lib/xml/sax/handler.py [https://github.com/python/cpython/tree/3.10/Lib/xml/sax/handler.py]

SAX API 定义了五种处理器：内容处理器、DTD 处理器、错误处理器、实体解析器以及词法处理器。 应用程序通常只需要实现他们感兴趣的事件对应的接口；他们可以在单个对象或多个对象中实现这些接口。 处理器的实现应当继承自 xml.sax.handler 模块所提供的基类，以便所有方法都能获得默认的实现。

class xml.sax.handler.ContentHandler

这是 SAX 中的主回调接口，也是对应用程序来说最重要的一个接口。 此接口中事件的顺序反映了文档中信息的顺序。

class xml.sax.handler.DTDHandler

处理 DTD 事件。

这个接口仅指定了基本解析（未解析的实体和属性）所需的那些 DTD 事件。

class xml.sax.handler.EntityResolver

用于解析实体的基本接口。 如果你创建了实现此接口的对象，然后用你的解析器注册该对象，该解析器将调用你的对象中的方法来解析所有外部实体。

class xml.sax.handler.ErrorHandler

解析器用来向应用程序表示错误和警告的接口。 这个对象的方法控制错误是要立即转换为异常还是以某种其他该来来处理。

class xml.sax.handler.LexicalHandler

解析器用来代表低频度事件的接口，这些事件可能是许多应用程序都不感兴趣的。

除了这些类，xml.sax.handler 还提供了表示特性和属性名称的符号常量。

xml.sax.handler.feature_namespaces

值: "http://xml.org/sax/features/namespaces"

true: 执行命名空间处理。

false: 可选择不执行命名空间处理 (这意味着 namespace-prefixes; default)。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.feature_namespace_prefixes

值: "http://xml.org/sax/features/namespace-prefixes"

true: 报告原始的带前缀名称和用于命名空间声明的属性。

false: 不报告用于命名空间声明的属性，可选择不报告原始的带前缀名称（默认）。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.feature_string_interning

值: "http://xml.org/sax/features/string-interning"

true: 所有元素名称、前缀、属性名称、命名空间 URI 以及本地名称都使用内置的 intern 函数进行内化。

false: 名称不要求被内化，但也可以被内化（默认）。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.feature_validation

值: "http://xml.org/sax/features/validation"

true: 报告所有的验证错误（包括 external-general-entities 和 external-parameter-entities）。

false: 不报告验证错误。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.feature_external_ges

值: "http://xml.org/sax/features/external-general-entities"

true: 包括所有的外部通用（文本）实体。

false: 不包括外部通用实体。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.feature_external_pes

值: "http://xml.org/sax/features/external-parameter-entities"

true: 包括所有的外部参数实体，也包括外部 DTD 子集。

false: 不包括任何外部参数实体，也不包括外部 DTD 子集。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.all_features

全部特性列表。

xml.sax.handler.property_lexical_handler

值: "http://xml.org/sax/properties/lexical-handler"

数据类型: xml.sax.handler.LexicalHandler (在 Python 2 中不受支持)

描述: 可选的扩展处理器，用于注释等词法事件。

访问: 读/写

xml.sax.handler.property_declaration_handler

值: "http://xml.org/sax/properties/declaration-handler"

数据类型: xml.sax.sax2lib.DeclHandler (在 Python 2 中不受支持)

描述: 可选的扩展处理器，用于标注和未解析实体以外的 DTD 相关事件。

访问: 读/写

xml.sax.handler.property_dom_node

值: "http://xml.org/sax/properties/dom-node"

数据类型: org.w3c.dom.Node (在 Python 2 中不受支持)

描述: 在解析时，如果这是一个 DOM 迭代器则为当前被访问的 DOM 节点；不在解析时，则将根 DOM 节点用于迭代。

access: (解析) 只读; (不解析) 读/写

xml.sax.handler.property_xml_string

值: "http://xml.org/sax/properties/xml-string"

数据类型: Bytes

描述: 作为当前事件来源的字符串字面值。

访问: 只读

xml.sax.handler.all_properties

已知属性名称列表。

ContentHandler 对象

用户应当子类化 ContentHandler 来支持他们的应用程序。 以下方法会由解析器在输入文档的适当事件上调用:

ContentHandler.setDocumentLocator(locator)

由解析器调用来给予应用程序一个定位器以确定文档事件来自何处。

强烈建议（虽然不是绝对的要求） SAX 解析器提供一个定位器：如果提供的话，它必须在唤起 DocumentHandler 接口的任何其他方法之前通过唤起此方法来提供定位器。

定位器允许应用程序确定任何文档相关事件的结束位置，即使解析器没有报告错误。 通常，应用程序将使用这些信息来报告它自己的错误（例如未匹配到应用程序业务规则的字符内容）。 定位器所返回的信息可能不足以与搜索引擎配合使用。

请注意定位器只有在发唤起此接口中的事件时才会返回正确的信息。 应用程序不应试图在其他任何时刻使用它。

ContentHandler.startDocument()

接收一个文档开始的通知。

SAX 解析器将只唤起这个方法一次，并且会在调用这个接口或 DTDHandler 中的任何其他方法之前 (setDocumentLocator() 除外)。

ContentHandler.endDocument()

接收一个文档结束的通知。

SAX 解析器将只唤起这个方法一次，并且它将是在解析过程中最后被唤起的方法。 解析器在（因不可恢复的错误）放弃解析或到达输入的终点之前不应唤起这个方法。

ContentHandler.startPrefixMapping(prefix, uri)

开始一个前缀 URI 命名空间映射的范围。

来自此事件的信息对于一般命名空间处理来说是不必要的：当 feature_namespaces 特性被启用时（默认）SAX XML 读取器将自动为元素和属性名称替换前缀。

但是也存在一些情况，当应用程序需要在字符数据或属性值中使用前缀，而它们无法被安全地自动扩展；startPrefixMapping() 和 endPrefixMapping() 事件会向应用程序提供信息以便在这些上下文内部扩展前缀，如果有必要的话。

请注意 startPrefixMapping() 和 endPrefixMapping() 事件并不保证能够相对彼此被正确地嵌套：所有 startPrefixMapping() 事件都将在对应的 startElement() 事件之前发生，而所有 endPrefixMapping() 事件都将在对应的 endElement() 事件之后发生，但它们的并不保证一致。

ContentHandler.endPrefixMapping(prefix)

结束一个前缀 URI 映射的范围。

请参看 startPrefixMapping() 了解详情。 此事件将总是会在对应的 endElement() 事件之后发生，但 endPrefixMapping() 事件的顺序则并没有保证。

ContentHandler.startElement(name, attrs)

在非命令空间模式下指示一个元素的开始。

name 形参包含字符串形式的元素类型原始 XML 1.0 名称而 attrs 形参存放包含元素属性的 Attributes 接口对象 (参见 Attributes 接口)。 作为 attrs 传入的对象可能被解析器所重用；维持一个对它的引用不是保持属性副本的可靠方式。 要保持这些属性的一个副本，请使用 attrs 对象的 copy() 方法。

ContentHandler.endElement(name)

在非命名空间模式下指示一个元素的结束。

name 形参包含元素类型的名称，与 startElement() 事件的一样。

ContentHandler.startElementNS(name, qname, attrs)

在命名空间模式下指示一个元素的开始。

name 形参包含以 (uri, localname) 元组表示的元素类型名称，qname 形参包含源文档中使用的原始 XML 1.0 名称，而 attrs 形参存放包含元素属性的 AttributesNS 接口实例 (参见 AttributesNS 接口)。 如果没有命名空间被关联到元素，则 name 的 uri 部分将为 None。 作为 attrs 传入的对象可能被解析器所重用；维持一个对它的引用不是保持属性副本的可靠方式。 要保持这些属性的一个副本，请使用 attrs 对象的 copy() 方法。

解析器可将 qname 形参设为 None，除非 feature_namespace_prefixes 特性已被激活。

ContentHandler.endElementNS(name, qname)

在命名空间模式下指示一个元素的结束。

name 形参包含元素类型的名称，与 startElementNS() 方法的一样，qname 形参也是类似的。

ContentHandler.characters(content)

接收字符数据的通知。

解析器将调用此方法来报告每一个字符数据分块。 SAX 解析器可以将所有连续字符数据返回为一个单独分块，或者将其拆成几个分块；但是，在任意单个事件中的所有字符都必须来自同一个外部实体以便定位器提供有用的信息。

content 可以是一个字符串或字节串实例；expat 读取器模块总是会产生字符串。

注解

Python XML 特别关注小组所提供的早期 SAX 1 接口针对此方法使用了一个更类似于 Java 的接口。 由于 Python 所使用的大多数解析器都没有利用老式的接口，因而选择了更简单的签名来替代它。 要将旧代码转换为新接口，请使用 content 而不要通过旧的 offset 和 length 形参来对内容进行切片。

ContentHandler.ignorableWhitespace(whitespace)

接收元素内容中可忽略空白符的通知。

验证解析器必须使用此方法来报告每个可忽略的空白符分块（参见 W3C XML 1.0 建议第 2.10 节）：非验证解析器如果能够解析并使用内容模型的话也可以使用此方法。

SAX 解析器可以将所有连续字符数据返回为一个单独分块，或者将其拆成几个分块；但是，在任意单个事件中的所有字符都必须来自同一个外部实体以便定位器提供有用的信息。

ContentHandler.processingInstruction(target, data)

接受一条处理指令的通知。

解析器将为已找到的每条处理指令唤起该方法一次：请注意处理指令可能出现在主文档元素之前或之后。

SAX 解析器绝不应当使用此方法来报告 XML 声明（XML 1.0 第 2.8 节）或文本声明（XML 1.0 第 4.3.1 节）。

ContentHandler.skippedEntity(name)

接收一个已跳过实体的通知。

解析器将为每个已跳过实体唤起此方法一次。 非验证处理程序可能会跳过未看到声明的实体（例如，由于实体是在一个外部because, for example, the entity was declared in an external DTD 子集中声明的）。 所有处理程序都可以跳过外部实体，具体取决于 feature_external_ges 和 feature_external_pes 属性的值。

DTDHandler 对象

DTDHandler 实例提供了下列方法:

DTDHandler.notationDecl(name, publicId, systemId)

处理标注声明事件。

DTDHandler.unparsedEntityDecl(name, publicId, systemId, ndata)

处理未解析的实体声明事件。

EntityResolver 对象

EntityResolver.resolveEntity(publicId, systemId)

求解一个实体的系统标识符并返回一个字符串形式的系统标识符作为读取源，或是一个 InputSource 作为读取源。 默认的实现会返回 systemId。

ErrorHandler 对象

带有这个接口的对象被用于接收来自 XMLReader 的错误和警告信息。 如果你创建了一个实现这个接口的对象，然后用你的 XMLReader 注册这个对象，则解析器将调用你的对象中的这个方法来报告所有的警告和错误。 有三个可用的错误级别：警告、（或许）可恢复的错误和不可恢复的错误。 所有方法都接受 SAXParseException 作为唯一的形参。 错误和警告可以通过引发所传入的异常对象来转换为异常。

ErrorHandler.error(exception)

当解析器遇到一个可恢复的错误时调用。 如果此方法没有引发异常，则解析可能会继续，但是应用程序不能预期获得更多的文档信息。 允许解析器继续可能会允许在输入文档中发现额外的错误。

ErrorHandler.fatalError(exception)

当解析器遇到一个不可恢复的错误时调用；在此方法返回时解析应当终止。

ErrorHandler.warning(exception)

当解析器向应用程序提供次要警告信息时调用。 在此方法返回时解析应当继续，并且文档信息将继续被传递给应用程序。 在此方法中引发异常将导致解析结束。

LexicalHandler 对象

可选的词法事件 SAX2 处理器。

这个处理器被用来获取一个 XML 文档的相关词法信息。 词法信息包括描述所使用的文档编码格式和嵌入文档中的 XML 注释，以及 DTD 和任何 CDATA 部分的节边界。 词法处理器的使用方式与内容处理器相同。

通过使用带有属性标识符 'http://xml.org/sax/properties/lexical-handler' 的 setProperty 方法来设置一个 XMLReader 的 LexicalHandler。

LexicalHandler.comment(content)

报告在文档中任何地方（包括 DTD 和文档元素以外）的注释。

LexicalHandler.startDTD(name, public_id, system_id)

如果文档有关联的 DTD 则报告 DTD 声明的开始。

LexicalHandler.endDTD()

报告 DTD 声明的结束。

LexicalHandler.startCDATA()

报告 CDATA 标记部分的开始。

CDATA 标记部分的内容将通过字符处理器来报告。

LexicalHandler.endCDATA()

报告 CDATA 标记部分的结束。

xml.sax.saxutils --- SAX 工具集

源代码: Lib/xml/sax/saxutils.py [https://github.com/python/cpython/tree/3.10/Lib/xml/sax/saxutils.py]

xml.sax.saxutils 模块包含一些在创建 SAX 应用程序时十分有用的类和函数，它们可以被直接使用，或者是作为基类使用。

xml.sax.saxutils.escape(data, entities={})

对数据字符串中的 '&', '<' 和 '>' 进行转义。

你可以通过传入一个字典作为可选的 entities 形参来对其他字符串数据进行转义。 字典的键和值必须为字符串；每个键将被替换为其所对应的值。 字符 '&', '<' 和 '>' 总是会被转义，即使提供了 entities。

xml.sax.saxutils.unescape(data, entities={})

对字符串数据中的 '&amp;', '&lt;' 和 '&gt;' 进行反转义。

你可以通过传入一个字典作为可选的 entities 形参来对其他数据字符串进行转义。 字典的键和值必须都为字符串；每个键将被替换为所对应的值。 '&amp', '&lt;' 和 '&gt;' 将总是保持不被转义，即使提供了 entities。

xml.sax.saxutils.quoteattr(data, entities={})

类似于 escape()，但还会对 data 进行处理以将其用作属性值。 返回值是 data 加上任何额外要求的替换的带引号版本。quoteattr() 将基于 data 的内容选择一个引号字符，以尽量避免在字符串中编码任何引号字符。 如果单双引号字符在 data 中都存在，则双引号字符将被编码并且 data 将使用双引号来标记。 结果字符串可被直接用作属性值:

>>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef"))
<element attr="ab ' cd &quot; ef">

此函数适用于为 HTML 或任何使用引用实体语法的 SGML 生成属性值。

class xml.sax.saxutils.XMLGenerator(out=None, encoding='iso-8859-1', short_empty_elements=False)

这个类通过将 SAX 事件写回到 XML 文档来实现 ContentHandler 接口。 换句话说，使用 XMLGenerator 作为内容处理程序将重新产生所解析的原始文档。 out 应当为一个文件型对象，它默认将为 sys.stdout。 encoding 为输出流的编码格式，它默认将为 'iso-8859-1'。 short_empty_elements 控制不包含内容的元素的格式化：如为 False (默认值) 则它们会以开始/结束标记对的形式被发送，如果设为 True 则它们会以单个自结束标记的形式被发送。

3.2 新版功能: short_empty_elements 形参。

class xml.sax.saxutils.XMLFilterBase(base)

这个类被设计用来分隔 XMLReader 和客户端应用的事件处理程序。 在默认情况下，它除了将请求传送给读取器并将事件传送给处理程序之外什么都不做，但其子类可以重载特定的方法以在传送它们的时候修改事件流或配置请求。

xml.sax.saxutils.prepare_input_source(source, base='')

此函数接受一个输入源和一个可选的基准 URL 并返回一个经过完整解析可供读取的 InputSource。 输入源的给出形式可以为字符串、文件类对象或 InputSource 对象；解析器将使用此函数来针对它们的 parse() 方法实现多态 source 参数。

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

源代码: Lib/xml/sax/xmlreader.py [https://github.com/python/cpython/tree/3.10/Lib/xml/sax/xmlreader.py]

SAX 解析器实现了 XMLReader 接口。 它们是在一个 Python 模块中实现的，该模块必须提供一个 create_parser() 函数。 该函数由 xml.sax.make_parser() 不带参数地唤起来创建新的解析器对象。

class xml.sax.xmlreader.XMLReader

可由 SAX 解析器继承的基类。

class xml.sax.xmlreader.IncrementalParser

在某些情况下，最好不要一次性地解析输入源，而是在可用的时候分块送入。 请注意读取器通常不会读取整个文件，它同样也是分块读取的； 并且 parse() 在处理完整个文档之前不会返回。 所以如果不希望 parse() 出现阻塞行为则应当使用这些接口。

当解析器被实例化时它已准备好立即开始接受来自 feed 方法的数据。 在通过调用 close 方法结束解析时 reset 方法也必须被调用以使解析器准备好接受新的数据，无论它是来自于 feed 还是使用 parse 方法。

请注意这些方法 不可 在解析期间被调用，即在 parse 被调用之后及其返回之前。

默认情况下，该类还使用 IncrementalParser 接口的 feed, close 和 reset 方法来实现 XMLReader 接口的 parse 方法以方便 SAX 2.0 驱动的编写者。

class xml.sax.xmlreader.Locator

用于关联一个 SAX 事件与一个文档位置的接口。 定位器对象只有在调用 DocumentHandler 的方法期间才会返回有效的结果；在其他任何时候，结果都是不可预测的。 如果信息不可用，这些方法可能返回 None。

class xml.sax.xmlreader.InputSource(system_id=None)

XMLReader 读取实体所需信息的封装。

这个类可能包括了关于公有标识符、系统标识符、字节流（可能带有字符编码格式信息）和/或一个实体的字符流的信息。

应用程序将创建这个类的对象以便在 XMLReader.parse() 方法中使用或是用于从 EntityResolver.resolveEntity 返回值。

InputSource 属于应用程序，XMLReader 不能修改从应用程序传递给它的 InputSource 对象，但它可以创建副本并进行修改。

class xml.sax.xmlreader.AttributesImpl(attrs)

这是 Attributes 接口（参见 Attributes 接口 一节）的具体实现。 这是一个 startElement() 调用中的元素属性的字典类对象。 除了最有用处的字典操作，它还支持接口所描述的一些其他方法。 该类的对象应当由读取器来实例化；attrs 必须为包含从属性名到属性值的映射的字典类对象。

class xml.sax.xmlreader.AttributesNSImpl(attrs, qnames)

可感知命名空间的 AttributesImpl 变体形式，它将被传递给 startElementNS()。 它派生自 AttributesImpl，但会将属性名称解读为 namespaceURI 和 localname 二元组。 此外，它还提供了一些期望接收在原始文档中出现的限定名称的方法。 这个类实现了 AttributesNS 接口（参见 AttributesNS 接口 一节）。

XMLReader 对象

XMLReader 接口支持下列方法:

XMLReader.parse(source)

处理输入源，产生 SAX 事件。 source 对象可以是一个系统标识符（标识输入源的字符串 -- 通常为文件名或 URL）, pathlib.Path 或 路径类 对象，或者是 InputSource 对象。 当 parse() 返回时，输入会被全部处理完成，解析器对象可以被丢弃或重置。

在 3.5 版更改: 添加了对字符流的支持。

在 3.8 版更改: 增加了对路径类对象的支持。

XMLReader.getContentHandler()

返回当前的 ContentHandler。

XMLReader.setContentHandler(handler)

设置当前的 ContentHandler。 如果没有设置 ContentHandler，内容事件将被丢弃。

XMLReader.getDTDHandler()

返回当前的 DTDHandler。

XMLReader.setDTDHandler(handler)

设置当前的 DTDHandler。 如果没有设置 DTDHandler，DTD 事件将被丢弃。

XMLReader.getEntityResolver()

返回当前的 EntityResolver。

XMLReader.setEntityResolver(handler)

设置当前的 EntityResolver。 如果没有设置 EntityResolver，尝试解析一个外部实体将导致打开该实体的系统标识符，并且如果它不可用则操作将失败。

XMLReader.getErrorHandler()

返回当前的 ErrorHandler。

XMLReader.setErrorHandler(handler)

设置当前的错误处理器。 如果没有设置 ErrorHandler，错误将作为异常被引发，并将打印警告信息。

XMLReader.setLocale(locale)

允许应用程序为错误和警告设置语言区域。

SAX 解析器不要求为错误和警告提供本地化信息；但是如果它们无法支持所请求的语言区域，则必须引发一个 SAX 异常。 应用程序可以在解析的中途请求更改语言区域。

XMLReader.getFeature(featurename)

返回 featurename 特性的当前设置。 如果特性无法被识别，则会引发 SAXNotRecognizedException。 在 xml.sax.handler 模块中列出了常见的特性名称。

XMLReader.setFeature(featurename, value)

将 featurename 设为 value。 如果特性无法被识别，则会引发 SAXNotRecognizedException。 如果特性或其设置不被解析器所支持，则会引发 SAXNotSupportedException。

XMLReader.getProperty(propertyname)

返回 propertyname 属性的当前设置。 如果属性无法被识别，则会引发 SAXNotRecognizedException。 在 xml.sax.handler 模块中列出了常见的属性名称。

XMLReader.setProperty(propertyname, value)

将 propertyname 设为 value。 如果属性无法被识别，则会引发 SAXNotRecognizedException。 如果属性或其设置不被解析器所支持，则会引发 SAXNotSupportedException。

IncrementalParser 对象

IncrementalParser 的实例额外提供了下列方法:

IncrementalParser.feed(data)

处理 data 的一个分块。

IncrementalParser.close()

确定文档的结尾。 这将检查只能在结尾处检查的格式是否良好的条件，唤起处理程序，并可能会清理在解析期间分配的资源。

IncrementalParser.reset()

此方法会在调用 close 来重置解析器以便其准备好解析新的文档之后被调用。 在 close 之后未调用 reset 即调用 parse 或 feed 的结果是未定义的。

Locator 对象

Locator 的实例提供了下列方法:

Locator.getColumnNumber()

返回当前事件开始位置的列号。

Locator.getLineNumber()

返回当前事件开始位置的行号。

Locator.getPublicId()

返回当前事件的公有标识符。

Locator.getSystemId()

返回当前事件的系统标识符。

InputSource 对象

InputSource.setPublicId(id)

设置该 InputSource 的公有标识符。

InputSource.getPublicId()

返回此 InputSource 的公有标识符。

InputSource.setSystemId(id)

设置此 InputSource 的系统标识符。

InputSource.getSystemId()

返回此 InputSource 的系统标识符。

InputSource.setEncoding(encoding)

设置此 InputSource 的字符编码格式。

编码格式必须是 XML 编码声明可接受的字符串（参见 XML 建议规范第 4.3.3 节）。

如果 InputSource 还包含一个字符流则 InputSource 的 encoding 属性会被忽略。

InputSource.getEncoding()

获取此 InputSource 的字符编码格式。

InputSource.setByteStream(bytefile)

设置此输入源的字节流（为 binary file 对象）。

如果还指定了一个字符流被则 SAX 解析器会忽略此设置，但它将优先使用字节流而不是自己打开一个 URI 连接。

如果应用程序知道字节流的字符编码格式，它应当使用 setEncoding 方法来设置它。

InputSource.getByteStream()

获取此输入源的字节流。

getEncoding 方法将返回该字节流的字符编码格式，如果未知则返回 None。

InputSource.setCharacterStream(charfile)

设置此输入源的字符流 (为 text file 对象)。

如果指定了一个字符流，SAX 解析器将忽略任何字节流并且不会尝试打开一个指向系统标识符的 URI 连接。

InputSource.getCharacterStream()

获取此输入源的字符流。

Attributes 接口

Attributes 对象实现了一部分 映射协议，包括 copy(), get(), __contains__(), items(), keys() 和 values() 等方法。 还提供了下列方法:

Attributes.getLength()

返回属性的数量。

Attributes.getNames()

返回属性的名称。

Attributes.getType(name)

返回属性 name 的类型，通常为 'CDATA'。

Attributes.getValue(name)

返回属性 name 的值。

AttributesNS 接口

此接口是 Attributes 接口（参见 Attributes 接口 章节）的一个子类型。 那个接口所支持的所有方法在 AttributesNS 对象上也都可用。

下列方法也是可用的:

AttributesNS.getValueByQName(name)

返回一个限定名称的值。

AttributesNS.getNameByQName(name)

返回限定名称 name 的 (namespace, localname) 对。

AttributesNS.getQNameByName(name)

返回 (namespace, localname) 对的限定名称。

AttributesNS.getQNames()

返回所有属性的限定名称。

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

警告

pyexpat 模块对于恶意构建的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

xml.parsers.expat 模块是针对 Expat 非验证 XML 解析器的 Python 接口。 此模块提供了一个扩展类型 xmlparser，它代表一个 XML 解析器的当前状态。 在创建一个 xmlparser 对象之后，该对象的各个属性可被设置为相应的处理器函数。 随后当将一个 XML 文档送入解析器时，就会为该 XML 文档中的字符数据和标记调用处理器函数。

此模块使用 pyexpat 模块来提供对 Expat 解析器的访问。 直接使用 pyexpat 模块的方式已被弃用。

此模块提供了一个异常和一个类型对象:

exception xml.parsers.expat.ExpatError

此异常会在 Expat 报错时被引发。 请参阅 ExpatError 异常 一节了解有关解读 Expat 错误的更多信息。

exception xml.parsers.expat.error

ExpatError 的别名。

xml.parsers.expat.XMLParserType

来自 ParserCreate() 函数的返回值的类型。

xml.parsers.expat 模块包含两个函数:

xml.parsers.expat.ErrorString(errno)

返回给定错误号 errno 的解释性字符串。

xml.parsers.expat.ParserCreate(encoding=None, namespace_separator=None)

创建并返回一个新的 xmlparser 对象。 如果指定了 encoding，它必须为指定 XML 数据所使用的编码格式名称的字符串。 Expat 支持的编码格式没有 Python 那样多，而且它的编码格式库也不能被扩展；它支持 UTF-8, UTF-16, ISO-8859-1 (Latin1) 和 ASCII。 如果给出了 encoding 1 则它将覆盖隐式或显式指定的文档编码格式。

通过 ParserCreate() 创建的解析器称为“根”解析器，就是说它们没有关联任何父解析器。 非根解析器则是由 parser.ExternalEntityParserCreate 创建的。

可以选择让 Expat 为你做 XML 命名空间处理，这是通过提供 namespace_separator 值来启用的。 该值必须是一个单字符的字符串；如果字符串的长度不合法则将引发 ValueError (None 被视为等同于省略)。 当命名空间处理被启用时，属于特定命名空间的元素类型名称和属性名称将被展开。 传递给The element name passed to the 元素处理器 StartElementHandler 和 EndElementHandler 的元素名称将为命名空间 URI，命名空间分隔符和名称的本地部分的拼接。 如果命名空间分隔符是一个零字节 (chr(0)) 则命名空间 URI 和本地部分将被直接拼接而不带任何分隔符。

举例来说，如果 namespace_separator 被设为空格符 (' ') 并对以下文档进行解析:

<?xml version="1.0"?>
<root xmlns    = "http://default-namespace.org/"
      xmlns:py = "http://www.python.org/ns/">
  <py:elem1 />
  <elem2 xmlns="" />
</root>

StartElementHandler 将为每个元素获取以下字符串:

http://default-namespace.org/ root
http://www.python.org/ns/ elem1
elem2

由于 pyexpat 所使用的 Expat 库的限制，被返回的 xmlparser 实例只能被用来解析单个 XML 文档。 请为每个文档调用 ParserCreate 来提供单独的解析器实例。

参见

The Expat XML Parser [http://www.libexpat.org/]

Expat 项目的主页。

XMLParser对象

xmlparser 对象具有以下方法:

xmlparser.Parse(data[, isfinal])

解析字符串 data 的内容，调用适当的处理函数来处理解析后的数据。 在对此方法的最后一次调用时 isfinal 必须为真值；它允许以片段形式解析单个文件，而不是提交多个文件。 data 在任何时候都可以为空字符串。

xmlparser.ParseFile(file)

解析从对象 file 读取的 XML 数据。 file 仅需提供 read(nbytes) 方法，当没有更多数据可读时将返回空字符串。

xmlparser.SetBase(base)

设置要用于解析声明中的系统标识符的相对 URI 的基准。 解析相对标识符的任务会留给应用程序进行：这个值将作为 base 参数传递给 ExternalEntityRefHandler(), NotationDeclHandler() 和 UnparsedEntityDeclHandler() 函数。

xmlparser.GetBase()

返回包含之前调用 SetBase() 所设置的基准位置的字符串，或者如果未调用 SetBase() 则返回 None。

xmlparser.GetInputContext()

将生成当前事件的输入数据以字符串形式返回。 数据为包含文本的实体的编码格式。 如果被调用时未激活事件处理器，则返回值将为 None。

xmlparser.ExternalEntityParserCreate(context[, encoding])

创建一个“子”解析器，可被用来解析由父解析器解析的内容所引用的外部解析实体。 context 形参应当是传递给 ExternalEntityRefHandler() 处理函数的字符串，具体如下所述。 子解析器创建时 ordered_attributes 和 specified_attributes 会被设为此解析器的值。

xmlparser.SetParamEntityParsing(flag)

控制参数实体（包括外部 DTD 子集）的解析。 可能的 flag 值有 XML_PARAM_ENTITY_PARSING_NEVER, XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE 和 XML_PARAM_ENTITY_PARSING_ALWAYS。 如果该旗标设置成功则返回真值。

xmlparser.UseForeignDTD([flag])

调用时将 flag 设为真值（默认）将导致 Expat 调用 ExternalEntityRefHandler 时将所有参数设为 None 以允许加载替代的 DTD。 如果文档不包含文档类型声明，ExternalEntityRefHandler 仍然会被调用，但 StartDoctypeDeclHandler 和 EndDoctypeDeclHandler 将不会被调用。

为 flag 传入假值将将撤消之前传入真值的调用，除此之外没有其他影响。

此方法只能在调用 Parse() 或 ParseFile() 方法之前被调用；在已调用过这两个方法之后调用它会导致引发 ExpatError 且 code 属性被设为 errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]。

xmlparser.SetReparseDeferralEnabled(enabled)

警告

调用 SetReparseDeferralEnabled(False) 会对安全产生影响，详情见下文；在使用 SetReparseDeferralEnabled 方法之前请务必了解这些后果。

Expat 2.6.0 引入了一种名为“重新解析延迟”的安全机制，这种机制不会发生因重新解析大量词元的指数级运行时而导致的拒绝服务，而是会在默认情况下延迟对未完成词元的重新解析直到达到足够的输入量。 由于这种延迟，已注册的处理器有可能 —— 具体取决于推送到 Expat 的输入块大小 —— 不会在向解析器 推送新输入后立即被调用。 如果希望获得即时反馈并接管防止大量词元导致拒绝服务的责任，可以调用 SetReparseDeferralEnabled(False) 暂时或完全禁用当前 Expat 解析器实例的重解析延迟。 调用 SetReparseDeferralEnabled(True) 将再次启用重新解析延迟。

请注意 SetReparseDeferralEnabled() 已作为安全修正被向下移植到一些较早的 CPython 发布版。 如果在运行于多个 Python 版本的代码中要用到 SetReparseDeferralEnabled() 请使用 hasattr() 来检查其可用性。

3.10.14 新版功能.

xmlparser.GetReparseDeferralEnabled()

返回当前是否为给定的 Expat 解析器实例启用了重新解析延迟。

3.10.14 新版功能.

xmlparser 对象拥有以下方法以消解某些常见的 XML 缺陷。

xmlparser.SetAllocTrackerActivationThreshold(threshold, /)

设置动态内存的分配字节数以激活对不适当地使用 RAM 的保护机制。

在默认情况下，解析器对象的分配激活上限为 64 MiB，等于 67,108,864 字节。

如果此方法是在 non-root 解释器上调用则会引发 ExpatError。 对应的 lineno 和 offset 不应被使用因为它们可能没有特别意义。

3.10.20 新版功能.

xmlparser.SetAllocTrackerMaximumAmplification(max_factor, /)

设置直接输入与已分配动态内存字节数量之间的最大放大系数。

该放大系数在解析时将被计算为 allocated / direct，其中 direct 是在解析中从原始文档读取的字节数量而 allocated 是在解析器层级结构中已分配的动态内存字节数量。

max_factor 值必须是一个大于等于 1.0 的非 NaN float 值。 在实践中大于 100.0 的放大系数可能出现于解析开始的时候，即使是良性的文件也不能避免。 具体而言，激活上限应当谨慎选择以避免假阳性结果。

在默认情况下，解析器对象的最大放大系统为 100.0。

如果此方法是在 non-root 解析器上调用或者如果 max_factor 是在有效范围之外则会引发 ExpatError。 对应的 lineno 和 offset 不应被使用因为它们可能没有特别意义。

注解

最大放大系数只有在超出了可由 SetAllocTrackerActivationThreshold() 调整的上限时才会被纳入考虑。

3.10.20 新版功能.

xmlparser 对象具有下列属性:

xmlparser.buffer_size

当 buffer_text 为真值时所使用的缓冲区大小。 可以通过将此属性赋一个新的整数值来设置一个新的缓冲区大小。 当大小发生改变时，缓冲区将被刷新。

xmlparser.buffer_text

将此属性设为真值会使得 xmlparser 对象缓冲 Expat 所返回的文本内容以尽可能地避免多次调用 CharacterDataHandler() 回调。 这可以显著地提升性能，因为 Expat 通常会将字符数据在每个行结束的位置上进行分块。 此属性默认为假值，但可以在任何时候被更改。

xmlparser.buffer_used

当 buffer_text 被启用时，缓冲区中存储的字节数。 这些字节数据表示以 UTF-8 编码的文本。 当 buffer_text 为假值时此属性没有任何实际意义。

xmlparser.ordered_attributes

将该属性设为非零整数会使得各个属性被报告为列表而非字典。 各个属性会按照在文档文本中的出现顺序显示。 对于每个属性，将显示两个列表条目：属性名和属性值。 （该模块的较旧版本也使用了此格式。） 默认情况下，该属性为假值；它可以在任何时候被更改。

xmlparser.specified_attributes

如果设为非零整数，解析器将只报告在文档实例中指明的属性而不报告来自属性声明的属性。 设置此属性的应用程序需要特别小心地使用从声明中获得的附加信息以符合 XML 处理程序的行为标准。 默认情况下，该属性为假值；它可以在任何时候被更改。

下列属性包含与 xmlparser 对象遇到的最近发生的错误有关联的值，并且一旦对 Parse() 或 ParseFile() 的调用引发了 xml.parsers.expat.ExpatError 异常就将只包含正确的值。

xmlparser.ErrorByteIndex

错误发生位置的字节索引号。

xmlparser.ErrorCode

指明问题的的数字代码。 该值可被传给 ErrorString() 函数，或是与在 errors 对象中定义的常量之一进行比较。

xmlparser.ErrorColumnNumber

错误发生位置的列号。

xmlparser.ErrorLineNumber

错误发生位置的行号。

下列属性包含 xmlparser 对象中关联到当前解析位置的值。 在回调报告解析事件期间它们将指示生成事件的字符序列的第一个字符的位置。 当在回调的外部被调用时，所指示的位置将恰好位于最后的解析事件之后（无论是否存在关联的回调）。

xmlparser.CurrentByteIndex

解析器输入的当前字节索引号。

xmlparser.CurrentColumnNumber

解析器输入的当前列号。

xmlparser.CurrentLineNumber

解析器输入的当前行号。

可被设置的处理器列表。 要在一个 xmlparser 对象 o 上设置处理器，请使用 o.handlername = func。 handlername 必须从下面的列表中获取，而 func 必须为接受正确数量参数的可调用对象。 所有参数均为字符串，除非另外指明。

xmlparser.XmlDeclHandler(version, encoding, standalone)

当解析 XML 声明时被调用。 XML 声明是 XML 建议适用版本、文档文本的编码格式，以及可选的“独立”声明的（可选）声明。 version 和 encoding 将为字符串，而 standalone 在文档被声明为独立时将为 1，在文档被声明为非独立时将为 0，或者在 standalone 短语被省略时则为 -1。 这仅适用于 Expat 的 1.95.0 或更新版本。

xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset)

当 Expat 开始解析文档类型声明 (<!DOCTYPE ...) 时被调用。 doctypeName 会完全按所显示的被提供。 systemId 和 publicId 形参给出所指定的系统和公有标识符，如果被省略则为 None。 如果文档包含内部文档声明子集则 has_internal_subset 将为真值。 这要求 Expat 1.2 或更新的版本。

xmlparser.EndDoctypeDeclHandler()

当 Expat 完成解析文档类型声明时被调用。 这要求 Expat 1.2 或更新版本。

xmlparser.ElementDeclHandler(name, model)

为每个元素类型声明调用一次。 name 为元素类型名称，而 model 为内容模型的表示形式。

xmlparser.AttlistDeclHandler(elname, attname, type, default, required)

为一个元素类型的每个已声明属性执行调用。 如果一个属性列表声明声明了三个属性，这个处理器会被调用三次，每个属性一次。 elname 是声明所适用的元素的名称而 attname 是已声明的属性的名称。 属性类型是作为 type 传入的字符串；可能的值有 'CDATA', 'ID', 'IDREF', ... default 给出了当属性未被文档实例所指明时该属性的默认值，或是为 None，如果没有默认值 (#IMPLIED 值) 的话。 如果属性必须在文档实例中给出，则 required 将为真值。 这要求 Expat 1.95.0 或更新的版本。

xmlparser.StartElementHandler(name, attributes)

在每个元素开始时调用。 name 是包含元素名称的字符串，而 attributes 是元素的属性。 如果 ordered_attributes 为真值，则属性为列表形式 (完整描述参见 ordered_attributes)。 否则为将名称映射到值的字典。

xmlparser.EndElementHandler(name)

在每个元素结束时调用。

xmlparser.ProcessingInstructionHandler(target, data)

在每次处理指令时调用。

xmlparser.CharacterDataHandler(data)

针对字符数据调用。 此方法将被用于普通字符数据、CDATA 标记内容以及可忽略的空白符。 需要区分这几种情况的应用程序可以使用 StartCdataSectionHandler, EndCdataSectionHandler 和 ElementDeclHandler 回调来收集必要的信息。

xmlparser.UnparsedEntityDeclHandler(entityName, base, systemId, publicId, notationName)

针对未解析（NDATA）实体声明调用。 此方法仅存在于 Expat 库的 1. 2 版；对于更新的版本，请改用 EntityDeclHandler。 （下层 Expat 库中的对应函数已被声明为过时。）

xmlparser.EntityDeclHandler(entityName, is_parameter_entity, value, base, systemId, publicId, notationName)

针对所有实体声明被调用。 对于形参和内部实体，value 将为给出实体的声明内容的字符串；对于外部实体将为 None。 notationName 形参对于已解析实体将为 None，对于未解析实体则为标注的名称。 如果实体为形参实体则 is_parameter_entity 将为真值而如果为普通实体则为假值（大多数应用程序只需要关注普通实体）。 此方法仅从 1.95.0 版 Expat 库开始才可用。

xmlparser.NotationDeclHandler(notationName, base, systemId, publicId)

针对标注声明被调用。 notationName, base, systemId 和 publicId 如果给出则均应为字符串。 如果省略公有标识符，则 publicId 将为 None。

xmlparser.StartNamespaceDeclHandler(prefix, uri)

当一个元素包含命名空间声明时被调用。 命名空间声明会在为声明所在的元素调用 StartElementHandler 之前被处理。

xmlparser.EndNamespaceDeclHandler(prefix)

当到达包含命名空间声明的元素的关闭标记时被调用。 此方法会按照调用 StartNamespaceDeclHandler 以指明每个命名空间作用域的开始的逆顺序为元素上的每个命名空间声明调用一次。 对这个处理器的调用是在相应的 EndElementHandler 之后针对元素的结束而进行的。

xmlparser.CommentHandler(data)

针对注释被调用。 data 是注释的文本，不包括开头的 '<!--' 和末尾的 '-->'。

xmlparser.StartCdataSectionHandler()

在一个 CDATA 节的开头被调用。 需要此方法和 EndCdataSectionHandler 以便能够标识 CDATA 节的语法开始和结束。

xmlparser.EndCdataSectionHandler()

在一个 CDATA 节的末尾被调用。

xmlparser.DefaultHandler(data)

针对 XML 文档中没有指定适用处理器的任何字符被调用。 这包括了所有属于可被报告的结构的一部分，但未提供处理器的字符。

xmlparser.DefaultHandlerExpand(data)

这与 DefaultHandler() 相同，但不会抑制内部实体的扩展。 实体引用将不会被传递给默认处理器。

xmlparser.NotStandaloneHandler()

当 XML 文档未被声明为独立文档时被调用。 这种情况发生在出现外部子集或对参数实体的引用，但 XML 声明没有在 XML 声明中将 standalone 设为 yes 的时候。 如果这个处理器返回 0，那么解析器将引发 XML_ERROR_NOT_STANDALONE 错误。 如果这个处理器没有被设置，那么解析器就不会为这个条件引发任何异常。

xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId)

为对外部实体的引用执行调用。 base 为当前的基准，由之前对 SetBase() 的调用设置。 公有和系统标识符 systemId 和 publicId 如果给出则圴为字符串；如果公有标识符未给出，则 publicId 将为 None。 context 是仅根据以下说明来使用的不透明值。

对于要解析的外部实体，这个处理器必须被实现。 它负责使用 ExternalEntityParserCreate(context) 来创建子解析器，通过适当的回调将其初始化，并对实体进行解析。 这个处理器应当返回一个整数；如果它返回 0，则解析器将引发 XML_ERROR_EXTERNAL_ENTITY_HANDLING 错误，否则解析将会继续。

如果未提供这个处理器，外部实体会由 DefaultHandler 回调来报告，如果提供了该回调的话。

ExpatError 异常

ExpatError 异常包含几个有趣的属性:

ExpatError.code

Expat 对于指定错误的内部错误号。 errors.messages 字典会将这些错误号映射到 Expat 的错误消息。 例如:

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])

errors 模块也提供了一些错误消息常量和一个将这些消息映射回错误码的字典 codes，参见下文。

ExpatError.lineno

检测到错误所在的行号。 首行的行号为 1。

ExpatError.offset

错误发生在行中的字符偏移量。 首列的列号为 0。

示例

以下程序定义了三个处理器，会简单地打印出它们的参数。:

import xml.parsers.expat

# 3 handler functions
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)

来自这个程序的输出是:

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

内容模型描述

内容模型是使用嵌套的元组来描述的。 每个元素包含四个值：类型、限定符、名称和一个子元组。 子元组就是附加的内容模型描述。

前两个字段的值是在 xml.parsers.expat.model 模块中定义的常量。 这些常量可分为两组：模型类型组和限定符组。

模型类型组中的常量有:

xml.parsers.expat.model.XML_CTYPE_ANY

模型名称所指定的元素被声明为具有 ANY 内容模型。

xml.parsers.expat.model.XML_CTYPE_CHOICE

命名元素允许从几个选项中选择；这被用于 (A | B | C) 形式的内容模型。

xml.parsers.expat.model.XML_CTYPE_EMPTY

被声明为 EMPTY 的元素具有此模型类型。

xml.parsers.expat.model.XML_CTYPE_MIXED

xml.parsers.expat.model.XML_CTYPE_NAME

xml.parsers.expat.model.XML_CTYPE_SEQ

代表彼此相连的一系列模型的模型用此模型类型来指明。 这被用于 (A, B, C) 形式的模型。

限定符组中的常量有:

xml.parsers.expat.model.XML_CQUANT_NONE

未给出限定符，这样它可以只出现一次，例如 A。

xml.parsers.expat.model.XML_CQUANT_OPT

模型是可选的：它可以出现一次或完全不出现，例如 A?。

xml.parsers.expat.model.XML_CQUANT_PLUS

模型必须出现一次或多次 (例如 A+)。

xml.parsers.expat.model.XML_CQUANT_REP

模型必须出现零次或多次，例如 A*。

Expat 错误常量

下列常量是在 xml.parsers.expat.errors 模块中提供的。 这些常量在有错误发生时解读被引发的 ExpatError 异常对象的某些属性时很有用处。 出于保持向下兼容性的理由，这些常量的值是错误 消息 而不是数字形式的错误 代码，为此你可以将它的 code 属性和 errors.codes[errors.XML_ERROR_CONSTANT_NAME] 进行比较。

errors 模块具有以下属性:

xml.parsers.expat.errors.codes

将字符串描述映射到其错误代码的字典。

3.2 新版功能.

xml.parsers.expat.errors.messages

将数字形式的错误代码映射到其字符串描述的字典。

3.2 新版功能.

xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY

xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF

属性值中指向一个外部实体而非内部实体的实体引用。

xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF

指向一个在 XML 不合法的字符的字符引用 (例如，字符 0 或 '&#0;')。

xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF

指向一个使用标注声明，因而无法被解析的实体的实体引用。

xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE

一个属性在一个开始标记中被使用超过一次。

xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING

xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN

当一个输入字节无法被正确分配给一个字符时引发；例如，在 UTF-8 输入流中的 NUL 字节 (值为 0)。

xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT

在文档元素之后出现空白符以外的内容。

xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI

在输入数据开始位置以外的地方发现 XML 声明。

xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS

文档不包含任何元素（XML 要求所有文档都包含恰好一个最高层级元素）。

xml.parsers.expat.errors.XML_ERROR_NO_MEMORY

Expat 无法在内部分配内存。

xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF

在不被允许的位置发现一个参数实体引用。

xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR

在输入中发出一个不完整的字符。

xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF

一个实体引用包含了对同一实体的另一个引用；可能是通过不同的名称，并可能是间接的引用。

xml.parsers.expat.errors.XML_ERROR_SYNTAX

遇到了某个未指明的语法错误。

xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH

一个结束标记不能匹配到最内层的未关闭开始标记。

xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN

某些记号（例如开始标记）在流结束或遇到下一个记号之前还未关闭。

xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY

对一个未定义的实体进行了引用。

xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING

文档编码格式不被 Expat 所支持。

xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION

一个 CDATA 标记节还未关闭。

xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING

xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE

解析器确定文档不是“独立的”但它却在 XML 声明中声明自己是独立的，并且 NotStandaloneHandler 被设置为返回 0。

xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE

xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE

xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD

请求了一个需要已编译 DTD 支持的操作，但 Expat 被配置为不带 DTD 支持。 此错误应当绝对不会被 xml.parsers.expat 模块的标准构建版本所报告。

xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING

在解析开始之后请求一个只能在解析开始之前执行的行为改变。 此错误（目前）只能由 UseForeignDTD() 所引发。

xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX

当命名空间处理被启用时发现一个未声明的前缀。

xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX

文档试图移除与某个前缀相关联的命名空间声明。

xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE

一个参数实体包含不完整的标记。

xml.parsers.expat.errors.XML_ERROR_XML_DECL

文档完全未包含任何文档元素。

xml.parsers.expat.errors.XML_ERROR_TEXT_DECL

解析一个外部实体中的文本声明时出现错误。

xml.parsers.expat.errors.XML_ERROR_PUBLICID

在公有 id 中发现不被允许的字符。

xml.parsers.expat.errors.XML_ERROR_SUSPENDED

在挂起的解析器上请求执行操作，但未获得允许。 这包括提供额外输入或停止解析器的尝试。

xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED

在解析器未被挂起的时候执行恢复解析器的尝试。

xml.parsers.expat.errors.XML_ERROR_ABORTED

此错误不应当被报告给 Python 应用程序。

xml.parsers.expat.errors.XML_ERROR_FINISHED

在一个已经完成解析输入的解析器上请求执行操作，但未获得允许。 这包括提供额外输入或停止解析器的尝试。

xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE

备注

1

包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl 和 https://www.iana.org/assignments/character-sets/character-sets.xhtml。

互联网协议和支持

本章介绍的模块实现了互联网协议以及相关技术支持。 它们都是用 Python 实现的。 这些模块大多需要依赖于系统的模块 socket 作为前提，该模块在大多数流行系统平台上都受到支持。 下面是一份概览:

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

浏览器控制器对象

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

wsgiref.util -- WSGI 环境工具

wsgiref.headers -- WSGI 响应标头工具

wsgiref.simple_server -- 一个简单的 WSGI HTTP 服务器

wsgiref.validate --- WSGI 一致性检查器

wsgiref.handlers -- 服务器/网关基类

例子

urllib --- URL 处理模块

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 对象

例子

已停用的接口

urllib.request 的限制

urllib.response --- urllib 使用的 Response 类

urllib.parse 用于解析 URL

URL 解析

URL 解析安全

解析ASCII编码字节

结构化解析结果

URL 转码

urllib.error --- urllib.request 引发的异常类

urllib.robotparser --- robots.txt 语法分析程序

http --- HTTP 模块

HTTP 状态码

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

HTTPConnection 对象

HTTPResponse 对象

例子

HTTPMessage 对象

ftplib --- FTP 协议客户端

FTP 对象

FTP_TLS 对象

poplib --- POP3 协议客户端

POP3 对象

POP3 示例

imaplib --- IMAP4 协议客户端

IMAP4 对象

IMAP4 示例

smtplib --- SMTP 协议客户端

SMTP 对象

SMTP 示例

uuid --- RFC 4122 定义的UUID对象

示例

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

服务器创建的说明

Server 对象

请求处理器对象

例子

socketserver.TCPServer 示例

socketserver.UDPServer 示例

异步混合类

http.server --- HTTP 服务器

安全考量

http.cookies --- HTTP状态管理

Cookie 对象

Morsel 对象

示例

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

CookieJar 和 FileCookieJar 对象

FileCookieJar 的子类及其与 Web 浏览器的协同

CookiePolicy 对象

DefaultCookiePolicy 对象

Cookie 对象

例子

xmlrpc --- XMLRPC 服务端与客户端模块

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

ServerProxy 对象

DateTime 对象

Binary 对象

Fault 对象

ProtocolError 对象

MultiCall 对象

便捷函数

客户端用法的示例

客户端与服务器用法的示例

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

SimpleXMLRPCServer 对象

SimpleXMLRPCServer 示例

CGIXMLRPCRequestHandler

文档 XMLRPC 服务器

DocXMLRPCServer 对象

DocCGIXMLRPCRequestHandler

ipaddress --- IPv4/IPv6 操作库

方便的工厂函数

IP 地址

地址对象

转换字符串和整数

运算符

比较运算符

算术运算符

IP网络的定义

前缀、网络掩码和主机掩码

网络对象

运算符

逻辑运算符

迭代

作为地址容器的网络

接口对象

运算符

逻辑运算符

其他模块级别函数

自定义异常

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

源码： Lib/webbrowser.py [https://github.com/python/cpython/tree/3.10/Lib/webbrowser.py]

webbrowser 模块提供了一个高层级接口，允许向用户显示基于 Web 的文档。 在大多数情况下，只需调用此模块的 open() 函数就可以了。

在 Unix 下，图形浏览器在 X11 下是首选，但如果图形浏览器不可用或 X11 显示不可用，则将使用文本模式浏览器。 如果使用文本模式浏览器，则调用进程将阻塞，直到用户退出浏览器。

如果存在环境变量 BROWSER ，则将其解释为 os.pathsep 分隔的浏览器列表，以便在平台默认值之前尝试。 当列表部分的值包含字符串 ％s 时，它被解释为一个文字浏览器命令行，用于替换 ％s 的参数 URL ；如果该部分不包含 ％s，则它只被解释为要启动的浏览器的名称。 1

对于非 Unix 平台，或者当 Unix 上有远程浏览器时，控制过程不会等待用户完成浏览器，而是允许远程浏览器在显示界面上维护自己的窗口。 如果 Unix 上没有远程浏览器，控制进程将启动一个新的浏览器并等待。

脚本 webbrowser 可用作模块的命令行界面。它接受一个 URL 作为参数，并接受以下可选参数：-n 在可能的情况下在新的浏览器窗口中打开 URL；-t 在新的浏览器页面（"tab"）中打开 URL。这些选项自然是相互排斥的。使用示例：

python -m webbrowser -t "https://www.python.org"

定义了以下异常：

exception webbrowser.Error

发生浏览器控件错误时引发异常。

定义了以下函数：

webbrowser.open(url, new=0, autoraise=True)

使用默认浏览器显示 url。 如果 new 为 0，则尽可能在同一浏览器窗口中打开 url。 如果 new 为 1，则尽可能打开新的浏览器窗口。 如果 new 为 2，则尽可能打开新的浏览器页面（“标签”）。 如果 autoraise 为 “True”，则会尽可能置前窗口（请注意，在许多窗口管理器下，无论此变量的设置如何，都会置前窗口）。

请注意，在某些平台上，尝试使用此函数打开文件名，可能会起作用并启动操作系统的关联程序。 但是，这种方式不被支持也不可移植。

引发一个 审计事件 webbrowser.open 并附带参数 url。

webbrowser.open_new(url)

如果可能，在默认浏览器的新窗口中打开 url，否则，在唯一的浏览器窗口中打开 url。

webbrowser.open_new_tab(url)

如果可能，在默认浏览器的新页面（“标签”）中打开 url，否则等效于 open_new()。

webbrowser.get(using=None)

返回浏览器类型为 using 指定的控制器对象。 如果 using 为 None，则返回适用于调用者环境的默认浏览器的控制器。

webbrowser.register(name, constructor, instance=None, *, preferred=False)

注册 name 浏览器类型。 注册浏览器类型后， get() 函数可以返回该浏览器类型的控制器。 如果没有提供 instance，或者为 None，constructor 将在没有参数的情况下被调用，以在需要时创建实例。 如果提供了 instance，则永远不会调用 constructor，并且可能是 None。

将 preferred 设置为 True 使得这个浏览器成为 get() 不带参数调用的首选结果。 否则，只有在您计划设置 BROWSER 变量，或使用与您声明的处理程序的名称相匹配的非空参数调用 get() 时，此入口点才有用。

在 3.7 版更改: 添加了仅关键字参数 preferred。

预定义了许多浏览器类型。 此表给出了可以传递给 get() 函数的类型名称以及控制器类的相应实例化，这些都在此模块中定义。

类型名 | 类名 | 备注
'mozilla' | Mozilla('mozilla') |
'firefox' | Mozilla('mozilla') |
'netscape' | Mozilla('netscape') |
'galeon' | Galeon('galeon') |
'epiphany' | Galeon('epiphany') |
'skipstone' | BackgroundBrowser('skipstone') |
'kfmclient' | Konqueror() | (1)
'konqueror' | Konqueror() | (1)
'kfm' | Konqueror() | (1)
'mosaic' | BackgroundBrowser('mosaic') |
'opera' | Opera() |
'grail' | Grail() |
'links' | GenericBrowser('links') |
'elinks' | Elinks('elinks') |
'lynx' | GenericBrowser('lynx') |
'w3m' | GenericBrowser('w3m') |
'windows-default' | WindowsDefault | (2)
'macosx' | MacOSXOSAScript('default') | (3)
'safari' | MacOSXOSAScript('safari') | (3)
'google-chrome' | Chrome('google-chrome') |
'chrome' | Chrome('chrome') |
'chromium' | Chromium('chromium') |
'chromium-browser' | Chromium('chromium-browser') |

注释：

"Konqueror" 是用于 Unix 的 KDE 桌面环境的文件管理器，只有在运行 KDE 时使用才有意义。最好能有某种方法可靠地检测 KDE；仅有 KDEDIR 变量还不够。还要注意的是，即使在 KDE 2 中使用命令:program:konqueror，"kfm" 这个名字也会被使用 —— 实现会选择运行 Konqueror 的最佳策略。

仅限 Windows 平台。

仅适用于 macOS 平台。

3.3 新版功能: 添加了对 Chrome/Chromium 的支持。

以下是一些简单的例子:

url = 'https://docs.python.org/'

# Open URL in a new tab, if a browser window is already open.
webbrowser.open_new_tab(url)

# Open URL in new window, raising the window if possible.
webbrowser.open_new(url)

浏览器控制器对象

浏览器控制器提供三个与模块级便捷函数相同的方法：

controller.open(url, new=0, autoraise=True)

使用此控制器处理的浏览器显示 url。 如果 new 为 1，则尽可能打开新的浏览器窗口。 如果 new 为 2，则尽可能打开新的浏览器页面（“标签”）。

controller.open_new(url)

如果可能，在此控制器处理的浏览器的新窗口中打开 url ，否则，在唯一的浏览器窗口中打开 url 。 别名 open_new()。

controller.open_new_tab(url)

如果可能，在此控制器处理的浏览器的新页面（“标签”）中打开 url，否则等效于 open_new()。

备注

1

这里命名的不带完整路径的可执行文件将在 PATH 环境变量给出的目录中搜索。

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

源代码: Lib/wsgiref [https://github.com/python/cpython/tree/3.10/Lib/wsgiref]

警告

wsgiref 是一个参考实现，不建议用于生产环境。 该模块仅实现了基本的安全检查。

Web 服务器网关接口（WSGI）是 Web 服务器软件和用 Python 编写的 Web 应用程序之间的标准接口。 具有标准接口能够让支持 WSGI 的应用程序与多种不同的 Web 服务器配合使用。

只有 Web 服务器和编程框架的开发者才需要了解 WSGI 设计的每个细节和边界情况。 你不需要了解 WSGI 的每个细节而只需要安装一个 WSGI 应用程序或编写使用现有框架的 Web 应用程序。

wsgiref 是一个 WSGI 规范的参考实现，可被用于将 WSGI 支持添加到 Web 服务器或框架中。 它提供了操作 WSGI 环境变量和响应标头的工具，实现 WSGI 服务器的基类，一个可部署 WSGI 应用程序的演示性 HTTP 服务器，以及一个用于检查 WSGI 服务器和应用程序是否符合 WSGI 规范的验证工具 (PEP 3333 [https://www.python.org/dev/peps/pep-3333])。

参看 wsgi.readthedocs.io [https://wsgi.readthedocs.io/] 获取有关 WSGI 的更多信息，以及教程和其他资源的链接。

wsgiref.util -- WSGI 环境工具

本模块提供了多种工具配合 WSGI 环境使用。 WSGI 环境就是一个包含 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 所描述的 HTTP 请求变量的目录。 所有接受 environ 形参的函数都会预期被得到一个符合 WSGI 规范的目录；请参阅 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 来了解相关规范的细节。

wsgiref.util.guess_scheme(environ)

返回对于 wsgi.url_scheme 应为 "http" 还是 "https" 的猜测，具体方式是在 environ 中检查 HTTPS 环境变量。 返回值是一个字符串。

此函数适用于创建一个包装了 CGI 或 CGI 类协议例如 FastCGI 的网关。 通常，提供这种协议的服务器将包括一个 HTTPS 变量并会在通过 SSL 接收请求时将其值设为 "1", "yes" 或 "on"。 这样，此函数会在找到上述值时返回 "https"，否则返回 "http"。

wsgiref.util.request_uri(environ, include_query=True)

使用 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 的 "URL Reconstruction" 一节中的算法返回完整的请求 URL，可能包括查询字符串。 如果 include_query 为假值，则结果 URI 中将不包括查询字符串。

wsgiref.util.application_uri(environ)

类似于 request_uri()，区别在于 PATH_INFO 和 QUERY_STRING 变量会被忽略。 结果为请求所指定的应用程序对象的基准 URI。

wsgiref.util.shift_path_info(environ)

将单个名称从 PATH_INFO 变换为 SCRIPT_NAME 并返回该名称。 environ 目录将被原地 修改；如果你需要保留原始 PATH_INFO 或 SCRIPT_NAME 不变请使用一个副本。

如果 PATH_INFO 中没有剩余的路径节，则返回 None。

通常，此例程被用来处理请求 URI 路径的每个部分，比如说将路径当作是一系列字典键。 此例程会修改传入的环境以使其适合唤起位于目标 URI 上的其他 WSGI 应用程序，如果有一个 WSGI 应用程序位于 /foo，而请求 URI 路径为 /foo/bar/baz，且位于 /foo 的 WSGI 应用程序调用了 shift_path_info()，它将获得字符串 "bar"，而环境将被更新以适合传递给位于 /foo/bar 的 WSGI 应用程序。 也就是说，SCRIPT_NAME 将由 /foo 变为 /foo/bar，而 PATH_INFO 将由 /bar/baz 变为 /baz。

当 PATH_INFO 只是 "/" 时，此例程会返回一个空字符串并在 SCRIPT_NAME 末尾添加一个斜杠，虽然空的路径节通常会被忽略，并且 SCRIPT_NAME 通常也不以斜杠作为结束。 此行为是有意为之的，用来确保应用程序在使用此例程执行对象遍历时能区分以 /x 结束的和以 /x/ 结束的 URI。

wsgiref.util.setup_testing_defaults(environ)

以简短的默认值更新 environ 用于测试目的。

此例程会添加 WSGI 所需要的各种参数，包括 HTTP_HOST, SERVER_NAME, SERVER_PORT, REQUEST_METHOD, SCRIPT_NAME, PATH_INFO 以及 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 中定义的所有 wsgi.* 变量。 它只提供默认值，而不会替换这些变量的现有设置。

此例程的目的是让 WSGI 服务器的单元测试以及应用程序设置测试环境更为容易。 它不应该被实际的 WSGI 服务器或应用程序所使用，因为它用的是假数据！

用法示例:

from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server

# A relatively simple WSGI application. It's going to print out the
# environment dictionary after being updated by 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('', 8000, simple_app) as httpd:
    print("Serving on port 8000...")
    httpd.serve_forever()

除了上述的环境函数，wsgiref.util 模块还提供了以下辅助工具:

wsgiref.util.is_hop_by_hop(header_name)

如果 'header_name' 是 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] 所定义的 HTTP/1.1 "Hop-by-Hop" 标头则返回 True。

class wsgiref.util.FileWrapper(filelike, blksize=8192)

一个将文件类对象转换为 iterator 的包装器。 结果对象同时支持 __getitem__() 和 __iter__() 迭代形式，以便兼容 Python 2.1 和 Jython。 当对象被迭代时，可选的 blksize 形参将被反复地传给 filelike 对象的 read() 方法以获取字节串并输出。 当 read() 返回空字节串时，迭代将结束并不可再恢复。

如果 filelike 具有 close() 方法，返回的对象也将具有 close() 方法，并且它将在被调用时唤起 filelike 对象的 close() 方法。

用法示例:

from io import StringIO
from wsgiref.util import FileWrapper

# We're using a StringIO-buffer for as the file-like object
filelike = StringIO("This is an example file-like object"*10)
wrapper = FileWrapper(filelike, blksize=5)

for chunk in wrapper:
    print(chunk)

3.8 版后已移除: 对 序列协议 的支持已被弃用。

wsgiref.headers -- WSGI 响应标头工具

此模块提供了一个单独的类 Headers，可以方便地使用一个映射类接口操作 WSGI 响应标头。

class wsgiref.headers.Headers([headers])

创建一个包装了 headers 的映射类对象，它必须为如 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 所描述的由标头名称/值元组构成的列表。 headers 的默认值为一个空列表。

Headers 对象支持典型的映射操作包括 __getitem__(), get(), __setitem__(), setdefault(), __delitem__() 和 __contains__()。 对于以上各个方法，映射的键是标头名称（大小写不敏感），而值是关联到该标头名称的第一个值。 设置一个标头会移除该标头的任何现有值，再将一个新值添加到所包装的标头列表末尾。 标头的现有顺序通常会保持不变，只在所包装的列表末尾添加新的标头。

与字典不同，当你试图获取或删除所包装的标头列表中不存在的键时 Headers 对象不会引发错误。 获取一个不存在的标头只是返回 None，而删除一个不存在的标头则没有任何影响。

Headers 对象还支持 keys(), values() 以及 items() 方法。 如果存在具有多个值的键则 keys() 和 items() 所返回的列表可能包括多个相同的键。 对 Headers 对象执行 len() 的结果与 items() 的长度相同，也与所包装的标头列表的长度相同。 实际上，items() 方法只是返回所包装的标头列表的一个副本。

在 Headers 对象上调用 bytes() 将返回适用于作为 HTTP 响应标头来传输的已格式化字节串。 每个标头附带以逗号加空格分隔的值放置在一行中。 每一行都以回车符加换行符结束，且该字节串会以一个空行作为结束。

除了映射接口和格式化特性，Headers 对象还具有下列方法用来查询和添加多值标头，以及添加具有 MIME 参数的标头:

get_all(name)

返回包含指定标头的所有值的列表。

返回的列表项将按它们在原始标头列表中的出现或被添加到实例中的顺序排序，并可能包含重复项。 任何被删除并重新插入的字段总是会被添加到标头列表末尾。 如果给定名称的字段不存在，则返回一个空列表。

add_header(name, value, **_params)

添加一个（可能有多个值）标头，带有通过关键字参数指明的可选的 MIME 参数。

name 是要添加的标头字段。 可以使用关键字参数来为标头字段设置 MIME 参数。 每个参数必须为字符串或 None。 参数名中的下划线会被转换为连字符，因为连字符不可在 Python 标识符中出现，但许多 MIME 参数名都包括连字符。 如果参数值为字符串，它会以 name="value" 的形式被添加到标头值参数中。 如果为 None，则只会添加参数名。 （这适用于没有值的 MIME 参数。） 示例用法:

h.add_header('content-disposition', 'attachment', filename='bud.gif')

以上代码将添加一个这样的标头:

Content-Disposition: attachment; filename="bud.gif"

在 3.5 版更改: headers 形参是可选的。

wsgiref.simple_server -- 一个简单的 WSGI HTTP 服务器

此模块实现了一个简单的 HTTP 服务器 (基于 http.server) 来发布 WSGI 应用程序。 每个服务器实例会在给定的主机名和端口号上发布一个 WSGI 应用程序。 如果你想在一个主机名和端口号上发布多个应用程序，你应当创建一个通过解析 PATH_INFO 来选择每个请求要唤起哪个应用程序的 WSGI 应用程序。 (例如，使用 wsgiref.util 中的 shift_path_info() 函数。)

wsgiref.simple_server.make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)

创建一个新的 WSGI 服务器并在 host 和 port 上进行监听，接受对 app 的连接。 返回值是所提供的 server_class 的实例，并将使用指定的 handler_class 来处理请求。 app 必须是一个如 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 所定义的 WSGI 应用程序对象。

用法示例:

from wsgiref.simple_server import make_server, demo_app

with make_server('', 8000, demo_app) as httpd:
    print("Serving HTTP on port 8000...")

    # Respond to requests until process is killed
    httpd.serve_forever()

    # Alternative: serve one request, then exit
    httpd.handle_request()

wsgiref.simple_server.demo_app(environ, start_response)

此函数是一个小巧但完整的 WSGI 应用程序，它返回一个包含消息 "Hello world!" 以及 environ 形参中提供的键/值对的文本页面。 它适用于验证 WSGI 服务器 (例如 wsgiref.simple_server) 是否能够正确地运行一个简单的 WSGI 应用程序。

class wsgiref.simple_server.WSGIServer(server_address, RequestHandlerClass)

创建一个 WSGIServer 实例。 server_address 应当是一个 (host,port) 元组，而 RequestHandlerClass 应当是 http.server.BaseHTTPRequestHandler 的子类，它将被用来处理请求。

你通常不需要调用此构造器，因为 make_server() 函数能为你处理所有的细节。

WSGIServer 是 http.server.HTTPServer 的子类，因此它所有的方法 (例如 serve_forever() 和 handle_request()) 都是可用的。 WSGIServer 还提供了以下 WSGI 专属的方法:

set_app(application)

将可调用对象 application 设为将要接受请求的 WSGI 应用程序。

get_app()

返回当前设置的应用程序可调用对象。

但是，你通常不需要使用这些附加的方法，因为 set_app() 通常会由 make_server() 来调用，而 get_app() 主要是针对请求处理器实例的。

class wsgiref.simple_server.WSGIRequestHandler(request, client_address, server)

为给定的 request 创建一个 HTTP 处理器 (例如套接字)，client_address (一个 (host,port) 元组)，以及 server (WSGIServer 实例)。

你不需要直接创建该类的实例；它们会根据 WSGIServer 对象的需要自动创建。 但是，你可以子类化该类并将其作为 handler_class 提供给 make_server() 函数。 一些可能在子类中重载的相关方法:

get_environ()

返回包含针对一个请求的 WSGI 环境的字典。 默认实现会拷贝 WSGIServer 对象的 base_environ 字典属性的内容并添加从 HTTP 请求获取的各种标头。 对此方法的每个调用应当返回一个 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 所指明的包含所有相关 CGI 环境变量的新字典。

get_stderr()

返回应被用作 wsgi.errors 流的对象。 默认实现将只返回 sys.stderr。

handle()

处理 HTTP 请求。 默认的实现会使用 wsgiref.handlers 类创建一个处理器实例来实现实际的 WSGI 应用程序接口。

wsgiref.validate --- WSGI 一致性检查器

当创建新的 WSGI 应用程序对象、框架、服务器或中间件时，使用 wsgiref.validate 来验证新代码的一致性是很有用的。 此模块提供了一个创建 WSGI 应用程序对象的函数来验证 WSGI 服务器或网关与 WSGI 应用程序对象之间的通信，以便检查双方的协议一致性。

请注意这个工具并不保证完全符合 PEP 3333 [https://www.python.org/dev/peps/pep-3333]；此模块没有报告错误并不一定表示不存在错误。 但是，如果此模块确实报告了错误，那么几乎可以肯定服务器或应用程序不是 100% 符合要求的。

此模块是基于 Ian Bicking 的 "Python Paste" 库的 paste.lint 模块。

wsgiref.validate.validator(application)

包装 application 并返回一个新的 WSGI 应用程序对象。 返回的应用程序将转发所有请求到原始的 application，并将检查 application 和唤起它的服务器是否都符合 WSGI 规范和 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html]。

任何被检测到的不一致性都会导致引发 AssertionError；但是请注意，如何对待这些错误取决于具体服务器。 例如，wsgiref.simple_server 和其他基于 wsgiref.handlers 的服务器（它们没有重载错误处理方法来做其他操作）将简单地输出一条消息报告发生了错误，并将回溯转给 sys.stderr 或者其他错误数据流。

这个包装器也可能会使用 warnings 模块生成输出来指明存在问题但实际上未被 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 所禁止的行为。 除非它们被 Python 命令行选项或 warnings API 所屏蔽，否则任何此类警告都将被写入到 sys.stderr (不是 wsgi.errors，除非它们恰好是同一个对象)。

用法示例:

from wsgiref.validate import validator
from wsgiref.simple_server import make_server

# Our callable object which is intentionally not compliant to the
# standard, so the validator is going to break
def simple_app(environ, start_response):
    status = '200 OK'  # HTTP Status
    headers = [('Content-type', 'text/plain')]  # HTTP Headers
    start_response(status, headers)

    # This is going to break because we need to return a list, and
    # the validator is going to inform us
    return b"Hello World"

# This is the application wrapped in a validator
validator_app = validator(simple_app)

with make_server('', 8000, validator_app) as httpd:
    print("Listening on port 8000....")
    httpd.serve_forever()

wsgiref.handlers -- 服务器/网关基类

此模块提供了用于实现 WSGI 服务器和网关的处理器基类。 这些基类可处理大部分与 WSGI 应用程序通信的工作，只要给予它们一个带有输入、输出和错误流的 CGI 类环境。

class wsgiref.handlers.CGIHandler

通过 sys.stdin, sys.stdout, sys.stderr 和 os.environ 发起基于 CGI 的调用。 这在当你有一个 WSGI 应用程序并想将其作为 CGI 脚本运行时很有用处。 只需唤起 CGIHandler().run(app)，其中 app 是你想要唤起的 WSGI 应用程序。

该类是 BaseCGIHandler 的子类，它将设置 wsgi.run_once 为真值，wsgi.multithread 为假值，wsgi.multiprocess 为真值，并总是使用 sys 和 os 来获取所需的 CGI 流和环境。

class wsgiref.handlers.IISCGIHandler

CGIHandler 的一个专门化替代，用于在 Microsoft 的 IIS Web 服务器上部署，无需设置 config allowPathInfo 选项 (IIS>=7) 或 metabase allowPathInfoForScriptMappings (IIS<7)。

默认情况下，IIS 给出的 PATH_INFO 会与前面的 SCRIPT_NAME 重复，导致想要实现路由的 WSGI 应用程序出现问题。 这个处理器会去除任何这样的重复路径。

IIS 可被配置为传递正确的 PATH_INFO，但这会导致另一个 PATH_TRANSLATED 出错的问题。 幸运的是这个变量很少被使用并且不被 WSGI 所保证。 但是在 IIS<7 上，这个设置只能在 vhost 层级上进行，影响到所有其他脚本映射，其中许多在受 PATH_TRANSLATED 问题影响时都会中断运行。 因此 IIS<7 的部署几乎从不附带这样的修正（即使 IIS7 也很少使用它，因为它仍然不带 UI）。

CGI 代码没有办法确定该选项是否已设置，因此提供了一个单独的处理器类。 它的用法与 CGIHandler 相同，即通过调用 IISCGIHandler().run(app)，其中 app 是你想要唤起的 WSGI 应用程序。

3.2 新版功能.

class wsgiref.handlers.BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

类似于 CGIHandler，但是改用 sys 和 os 模块，CGI 环境和 I/O 流会被显式地指定。 multithread 和 multiprocess 值被用来为处理器实例所运行的任何应用程序设置 wsgi.multithread 和 wsgi.multiprocess 旗标。

该类是 SimpleHandler 的子类，旨在用于 HTTP "原始服务器" 以外的软件。 如果你在编写一个网关协议实现（例如 CGI, FastCGI, SCGI 等等），它使用 Status: 标头来发布 HTTP 状态，你可能会想要子类化该类而不是 SimpleHandler。

class wsgiref.handlers.SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

类似于 BaseCGIHandler，但被设计用于 HTTP 原始服务器。 如果你在编写一个 HTTP 服务器实现，你可能会想要子类化该类而不是 BaseCGIHandler。

该类是 BaseHandler 的子类。 它重载了 __init__(), get_stdin(), get_stderr(), add_cgi_vars(), _write() 和 _flush() 方法以支持通过构造器显式地设置环境和流。 所提供的环境和流存储在 stdin, stdout, stderr 和 environ 属性中。

stdout 的 write() 方法应该完整写入每个数据块，与 io.BufferedIOBase 一样。

class wsgiref.handlers.BaseHandler

这是适用于运行 WSGI 应用程序的抽象基类。 每个实例将处理一个单独的 HTTP 请求，不过在原则上你也可以创建一个可针对多个请求重用的子类。

BaseHandler 实例只有一个方法提供给外部使用:

run(app)

运行指定的 WSGI 应用程序 app。

所有的 BaseHandler 其他方法都是在运行应用程序过程中由该方法唤起的，因此主要是为了允许定制运行过程。

以下方法必须在子类中被重载:

_write(data)

缓冲字节数据 data 以便传输给客户端。 如果此方法真的传输了数据也是可以的；BaseHandler 只有在底层系统真有这样的区分时才会区分写入和刷新操作以提高效率。

_flush()

强制将缓冲的数据传输给客户端。 如果此方法无任何操作也是可以的（例如，_write() 实际上已发送了数据）。

get_stdin()

返回一个适合被用作当前所处理请求的 wsgi.input 的输入流对象。

get_stderr()

返回一个适合被用作当前所处理请求的 wsgi.errors 的输出流对象。

add_cgi_vars()

将当前请求的 CGI 变量插入到 environ 属性。

以下是一些你可能会想要重载的其他方法。 但这只是个简略的列表，它不包括每个可被重载的方法。 你应当在在尝试创建自定义的 BaseHandler 子类之前参阅文档字符串和源代码来了解更多信息。

用于自定义 WSGI 环境的属性和方法:

wsgi_multithread

用于 wsgi.multithread 环境变量的值。 它在 BaseHandler 中默认为真值，但在其他子类中可能有不同的默认值（或是由构造器来设置）。

wsgi_multiprocess

用于 wsgi.multiprocess 环境变量的值。 它在 BaseHandler 中默认为真值，但在其他子类中可能有不同的默认值（或是由构造器来设置）。

wsgi_run_once

用于 wsgi.run_once 环境变量的值。 它在 BaseHandler 中默认为假值，但在 CGIHandler 中默认为真值。

os_environ

要包括在每个请求的 WSGI 环境中的默认环境变量。 在默认情况下，这是当 wsgiref.handlers 被导入时的 os.environ 的一个副本，但也可以在类或实例层级上创建它们自己的子类。 请注意该字典应当被当作是只读的，因为默认值会在多个类和实际之间共享。

server_software

如果设置了 origin_server 属性，该属性的值会被用来设置默认的 SERVER_SOFTWARE WSGI 环境变量，并且还会被用来设置 HTTP 响应中默认的 Server: 标头。 它会被不是 HTTP 原始服务器的处理器所忽略 (例如 BaseCGIHandler 和 CGIHandler)。

在 3.3 版更改: 名称 "Python" 会被替换为实现专属的名称如 "CPython", "Jython" 等等。

get_scheme()

返回当前请求所使用的 URL 方案。 默认的实现会使用来自 wsgiref.util 的 guess_scheme() 函数根据当前请求的 environ 变量来猜测方案应该是 "http" 还是 "https"。

setup_environ()

将 environ 属性设为填充了完整内容的 WSGI 环境。 默认的实现会使用上述的所有方法和属性，加上 get_stdin(), get_stderr() 和 add_cgi_vars() 方法以及 wsgi_file_wrapper 属性。 它还会在 SERVER_SOFTWARE 不存在时插入该键，只要 origin_server 属性为真值并且设置了 server_software 属性。

用于自定义异常处理的方法和属性:

log_exception(exc_info)

将 exc_info 元素记录到服务器日志。 exc_info 是一个 (type, value, traceback) 元组。 默认的实现会简单地将回溯信息写入请求的 wsgi.errors 流并刷新它。 子类可以重写此方法来修改格式或重设输出目标，通过邮件将回溯信息发给管理员，或执行任何其他符合要求的动作。

traceback_limit

要包括在默认 log_exception() 方法的回溯信息输出中的最大帧数。 如果为 None，则会包括所有的帧。

error_output(environ, start_response)

此方法是一个为用户生成错误页面的 WSGI 应用程序。 它仅当将标头发送给客户端之前发生错误时会被唤起。

此方法可使用 sys.exc_info() 来访问当前错误信息，并应当在调用 start_response 时将该信息传递给它（如 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 的 "Error Handling" 部分所描述的）。

默认的实现只是使用 error_status, error_headers, 和 error_body 属性来生成一个输出页面。 子类可以重写此方法来产生更动态化的错误输出。

但是请注意，从安全角度看来是不建议将诊断信息暴露给任何用户的；理想的做法是你应当通过特别处理来启用诊断输出，因此默认的实现并不包括这样的内容。

error_status

用于错误响应的 HTTP 状态。 这应当是一个在 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 中定义的字符串；它默认为代码 500 以相应的消息。

error_headers

用于错误响应的 HTTP 标头。 这应当是由 WSGI 响应标头 ((name, value) 元组) 构成的列表，如 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 所定义的。 默认的列表只是将内容类型设为 text/plain。

error_body

错误响应体。 这应当是一个 HTTP 响应体字节串。 它默认为纯文本 "A server error occurred. Please contact the administrator."

用于 PEP 3333 [https://www.python.org/dev/peps/pep-3333] 的 "可选的平台专属文件处理" 特性的方法和属性:

wsgi_file_wrapper

一个 wsgi.file_wrapper 工厂对象，或为 None。 该属性的默认值是 wsgiref.util.FileWrapper 类。

sendfile()

重载以实现平台专属的文件传输。 此方法仅在应用程序的返回值是由 wsgi_file_wrapper 属性指定的类的实例时会被调用。 如果它能够成功地传输文件则应当返回真值，以使得默认的传输代码将不会被执行。 此方法的默认实现只会返回假值。

杂项方法和属性:

origin_server

该属性在处理器的 _write() 和 _flush() 被用于同客户端直接通信而不是通过需要 HTTP 状态为某种特殊 Status: 标头的 CGI 类网关协议时应当被设为真值

该属性在 BaseHandler 中默认为真值，但在 BaseCGIHandler 和 CGIHandler 中则为假值。

http_version

如果 origin_server 为真值，则该字符串属性会被用来设置给客户端的响应的 HTTP 版本。 它的默认值为 "1.0"。

wsgiref.handlers.read_environ()

将来自 os.environ 的 CGI 变量转码为 PEP 3333 [https://www.python.org/dev/peps/pep-3333] "bytes in unicode" 字符串，返回一个新的字典。 此函数被 CGIHandler 和 IISCGIHandler 用来替代直接使用 os.environ，后者不一定在所有使用 Python 3 的平台和 Web 服务器上都符合 WSGI 标准 -- 特别是当 OS 的实际环境为 Unicode 时 (例如 Windows)，或者当环境为字节数据，但被 Python 用来解码它的系统编码格式不是 ISO-8859-1 时 (例如使用 UTF-8 的 Unix 系统)。

如果你要实现自己的基于 CGI 的处理器，你可能会想要使用此例程而不是简单地从 os.environ 直接拷贝值。

3.2 新版功能.

例子

这是一个可运行的 "Hello World" WSGI 应用程序:

from wsgiref.simple_server import make_server

# Every WSGI application must have an application object - a callable
# object that accepts two arguments. For that purpose, we're going to
# use a function (note that you're not limited to a function, you can
# use a class for example). The first argument passed to the function
# is a dictionary containing CGI-style environment variables and the
# second variable is the callable object.
def hello_world_app(environ, start_response):
    status = '200 OK'  # HTTP Status
    headers = [('Content-type', 'text/plain; charset=utf-8')]  # HTTP Headers
    start_response(status, headers)

    # The returned object is going to be printed
    return [b"Hello World"]

with make_server('', 8000, hello_world_app) as httpd:
    print("Serving on port 8000...")

    # Serve until process is killed
    httpd.serve_forever()

一个发布当前目录的 WSGI 应用程序示例，接受通过命令行指定可选的目录和端口号 (默认值: 8000):

#!/usr/bin/env python3
'''
Small wsgiref based web server. Takes a path to serve from and an
optional port number (defaults to 8000), then tries to serve files.
Mime types are guessed from the file names, 404 errors are raised
if the file is not found. Used for the make serve target in Doc.
'''
import sys
import os
import mimetypes
from wsgiref import simple_server, util

def app(environ, respond):

    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')
    type = mimetypes.guess_type(fn)[0]

    if os.path.exists(fn):
        respond('200 OK', [('Content-Type', 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
    httpd = simple_server.make_server('', port, app)
    print("Serving {} on port {}, control-C to stop".format(path, port))
    try:
        httpd.serve_forever()
    except KeyboardInterrupt:
        print("Shutting down.")
        httpd.server_close()

urllib --- URL 处理模块

源代码: Lib/urllib/ [https://github.com/python/cpython/tree/3.10/Lib/urllib/]

urllib 是一个收集了多个涉及 URL 的模块的包：

urllib.request 打开和读取 URL

urllib.error 包含 urllib.request 抛出的异常

urllib.parse 用于解析 URL

urllib.robotparser 用于解析 robots.txt 文件

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

源码： Lib/urllib/request.py [https://github.com/python/cpython/tree/3.10/Lib/urllib/request.py]

urllib.request 模块定义了适用于在各种复杂情况下打开 URL（主要为 HTTP）的函数和类 --- 例如基本认证、摘要认证、重定向、cookies 及其它。

参见

对于更高级别的 HTTP 客户端接口，建议使用 Requests [https://requests.readthedocs.io/en/master/] 。

urllib.request 模块定义了以下函数：

urllib.request.urlopen(url, data=None, [timeout, ]*, cafile=None, capath=None, cadefault=False, context=None)

打开统一资源定位符 url，可以是一个字符串或一个 Request 对象。

data 必须是一个对象，用于给出要发送到服务器的附加数据，若不需要发送数据则为 None。详情请参阅 Request 。

urllib.request 模块采用 HTTP/1.1 协议，并且在其 HTTP 请求中包含 Connection:close 头部信息。

timeout 为可选参数，用于指定阻塞操作（如连接尝试）的超时时间，单位为秒。如未指定，将使用全局默认超时参数）。本参数实际仅对 HTTP、HTTPS 和 FTP 连接有效。

如果给定了 context 参数，则必须是一个 ssl.SSLContext 实例，用于描述各种 SSL 参数。更多详情请参阅 HTTPSConnection 。

cafile 和 capath 为可选参数，用于为 HTTPS 请求指定一组受信 CA 证书。cafile 应指向包含CA 证书的单个文件， capath 则应指向哈希证书文件的目录。更多信息可参阅 ssl.SSLContext.load_verify_locations() 。

参数 cadefault 将被忽略。

本函数总会返回一个对象，该对象可作为 context manager 使用，带有 url、headers 和 status 属性。有关这些属性的更多详细信息，请参阅 urllib.response.addinfourl 。

对于 HTTP 和 HTTPS 的 URL 而言，本函数将返回一个稍经修改的 http.client.HTTPResponse 对象。除了上述 3 个新的方法之外，还有 msg 属性包含了与 reason 属性相同的信息---服务器返回的原因描述文字，而不是 HTTPResponse 的文档所述的响应头部信息。

对于 FTP、文件、数据的URL，以及由传统的 URLopener  和 FancyURLopener 类处理的请求，本函数将返回一个 urllib.response.addinfourl 对象。

协议发生错误时，将会引发 URLError 。

请注意，如果没有处理函数对请求进行处理，则有可能会返回 None 。尽管默认安装的全局 OpenerDirector 会用 UnknownHandler 来确保不会发生这种情况。

此外，如果检测到设置了代理（比如设置了 http_proxy 之类的环境变量），默认会安装 ProxyHandler 并确保通过代理处理请求。

Python 2.6 以下版本中留存的 urllib.urlopen 函数已停止使用了； urllib.request.urlopen() 对应于传统的 urllib2.urlopen 。对代理服务的处理是通过将字典参数传给 urllib.urlopen 来完成的，可以用 ProxyHandler 对象获取到代理处理函数。

默认会触发一条 审计事件 urllib.Request ，参数 fullurl 、 data 、headers 、method 均取自请求对象。

在 3.2 版更改: 增加了 cafile 与 capath。

在 3.2 版更改: 只要条件允许（指 ssl.HAS_SNI 为真），现在能够支持 HTTPS 虚拟主机。

3.2 新版功能: data 可以是一个可迭代对象。

在 3.3 版更改: 增加了 cadefault。

在 3.4.3 版更改: 增加了 context。

在 3.10 版更改: 当未给出 context 时，HTTPS 连接现在会发送一个带有协议指示器 http/1.1 的 ALPN 扩展。 自定义 context 应当用 set_alpn_protocol() 来设置 ALPN 协议。

3.6 版后已移除: cafile 、 capath 和 cadefault 已废弃，转而推荐使用 context。请改用 ssl.SSLContext.load_cert_chain() 或让 ssl.create_default_context() 选取系统信任的 CA 证书。

urllib.request.install_opener(opener)

安装一个 OpenerDirector 实例，作为默认的全局打开函数。仅当 urlopen 用到该打开函数时才需要安装；否则，只需调用 OpenerDirector.open() 而不是 urlopen()。代码不会检查是否真的属于 OpenerDirector 类，所有具备适当接口的类都能适用。

urllib.request.build_opener([handler, ...])

返回一个 OpenerDirector 实例，以给定顺序把处理函数串联起来。处理函数可以是 BaseHandler 的实例，也可以是 BaseHandler 的子类（这时构造函数必须允许不带任何参数的调用）。以下类的实例将位于 处理函数 之前，除非 处理函数 已包含这些类、其实例或其子类： ProxyHandler （如果检测到代理设置）、UnknownHandler 、HTTPHandler 、HTTPDefaultErrorHandler 、HTTPRedirectHandler 、 FTPHandler 、 FileHandler 、HTTPErrorProcessor 。

若 Python 安装时已带了 SSL 支持（指可以导入 ssl 模块），则还会加入 HTTPSHandler 。

A BaseHandler subclass may also change its handler_order attribute to modify its position in the handlers list.

urllib.request.pathname2url(path)

将路径名 path 从路径本地写法转换为 URL 路径部分所采用的格式。本函数不会生成完整的 URL。返回值将会用 quote() 函数加以编码。

urllib.request.url2pathname(path)

从百分号编码的 URL 中将 path 部分转换为本地路径的写法。本函数不接受完整的 URL，并利用 unquote() 函数对 path 进行解码。

urllib.request.getproxies()

此辅助函数将返回一个将各个方案映射到代理服务器 URL 的字典。 它会先为所有操作系统以大小写不敏感的方式扫描名为 <scheme>_proxy 的环境变量，当无法找到时，则会在 macOS 上从系统配置中而在 Windows 上从 Windows 系统注册表中查找代理信息。 如果同时存在小写和大写形式的环境变量（且内容不一致），则会首先小写形式。

注解

如果存在环境变量 REQUEST_METHOD ，通常表示脚本运行于 CGI 环境中，则环境变量 HTTP_PROXY （大写的 _PROXY）将会被忽略。这是因其可以由客户端用 HTTP 头部信息 “Proxy:”注入。若要在 CGI 环境中使用 HTTP 代理，请显式使用 `ProxyHandler ，或确保变量名称为小写（或至少是 _proxy 后缀）。

提供了以下类：

class urllib.request.Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None)

URL 请求对象的抽象类。

url 应为包含合法 URL 的字符串。

data 必须是一个对象，用于给定发往服务器的附加数据，若无需此类数据则为 None 。 目前 唯一用到 data 的只有 HTTP 请求。支持的对象类型包括字节串、类文件对象和可遍历的类字节串对象。如果没有提供 Content-Length 和 Transfer-Encoding 头部字段， HTTPHandler 会根据 data 的类型设置这些头部字段。Content-Length 将用于发送字节对象，而 RFC 7230 [https://datatracker.ietf.org/doc/html/rfc7230.html] 第 3.3.1 节中定义的 Transfer-Encoding: chunked 将用于发送文件和其他可遍历对象。

对于 HTTP POST 请求方法而言，data 应该是标准 application/x-www-form-urlencoded 格式的缓冲区。 urllib.parse.urlencode() 函数的参数为映射对象或二元组序列，并返回一个该编码格式的 ASCII 字符串。在用作 data 参数之前，应将其编码为字节串。

headers 应当是一个字典，并将被视同附带了每个键和值作为参数去调用 add_header()。 这通常被用于 "伪装" User-Agent 标头值，浏览器会使用标头值来标识自己 -- 某些 HTTP 服务器只允许来自普通浏览器的请求而不允许来自脚本的请求。 例如，Mozilla Firefox 可能将自己标识为 "Mozilla/5.0 (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"，而 urllib 的默认用户代理字符串则是 "Python-urllib/2.6" (在 Python 2.6 中)。 所有发送的标头键都使用驼峰命名法。

如果给出了 data 参数，则应当包含合适的 Content-Type 头部信息。若未提供且 data 不是 None，则会把 Content-Type: application/x-www-form-urlencoded 加入作为默认值。

接下来的两个参数，只对第三方 HTTP cookie 的处理才有用：

origin_req_host 应为发起初始会话的请求主机，定义参见 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 。默认指为 http.cookiejar.request_host(self) 。这是用户发起初始请求的主机名或 IP 地址。假设请求是针对 HTML 文档中的图片数据发起的，则本属性应为对包含图像的页面发起请求的主机。

unverifiable 应该标示出请求是否无法验证，定义参见 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 。默认值为 False 。所谓无法验证的请求，是指用户没有机会对请求的 URL 做验证。例如，如果请求是针对 HTML 文档中的图像，用户没有机会去许可能自动读取图像，则本参数应为 True。

method 应为字符串，标示要采用的 HTTP 请求方法（例如 'HEAD' ）。如果给出本参数，其值会存储在 method 属性中，并由 get_method() 使用。如果 data 为 None 则默认值为 'GET' ，否则为 'POST'。子类可以设置 method 属性来标示不同的默认请求方法。

注解

如果 data 对象无法分多次传递其内容（比如文件或只能生成一次内容的可迭代对象）并且由于 HTTP 重定向或身份验证而发生请求重试行为，则该请求不会正常工作。 data 是紧挨着头部信息发送给 HTTP 服务器的。现有库不支持 HTTP 100-continue 的征询。

在 3.3 版更改: Request 类增加了 Request.method 参数。

在 3.4 版更改: 默认 Request.method 可以在类中标明。

在 3.6 版更改: 如果给出了 Content-Length ，且 data 既不为 None 也不是字节串对象，则不会触发错误。而会退而求其次采用分块传输的编码格式。

class urllib.request.OpenerDirector

OpenerDirector 类通过串接在一起的 BaseHandler 打开 URL，并负责管理 handler 链及从错误中恢复。

class urllib.request.BaseHandler

这是所有已注册 handler 的基类，只做了简单的注册机制。

class urllib.request.HTTPDefaultErrorHandler

为 HTTP 错误响应定义的默认 handler，所有出错响应都会转为 HTTPError 异常。

class urllib.request.HTTPRedirectHandler

一个用于处理重定向的类。

class urllib.request.HTTPCookieProcessor(cookiejar=None)

一个用于处理 HTTP Cookies 的类。

class urllib.request.ProxyHandler(proxies=None)

让请求转往代理服务。 如果给出了 proxies，则它必须是一个将协议名称映射到代理 URL 的字典。 默认是从环境变量 <protocol>_proxy 中读取代理列表。 如果没有设置代理服务的环境变量，则在 Windows 环境下代理设置会从注册表的 Internet Settings 部分获取，而在 macOS 环境下代理信息会从 System Configuration Framework 获取。

若要禁用自动检测出来的代理，请传入空的字典对象。

环境变量 no_proxy 可用于指定不必通过代理访问的主机；应为逗号分隔的主机名后缀列表，可加上 :port ，例如 cern.ch,ncsa.uiuc.edu,some.host:8080 。

注解

如果设置了 REQUEST_METHOD 变量，则会忽略 HTTP_PROXY ；参阅 getproxies() 文档。

class urllib.request.HTTPPasswordMgr

维护 (realm, uri) -> (user, password) 映射数据库。

class urllib.request.HTTPPasswordMgrWithDefaultRealm

维护 (realm, uri) -> (user, password) 映射数据库。realm 为 None 视作全匹配，若没有其他合适的安全区域就会检索它。

class urllib.request.HTTPPasswordMgrWithPriorAuth

HTTPPasswordMgrWithDefaultRealm 的一个变体，也带有 uri -> is_authenticated 映射数据库。可被 BasicAuth 处理函数用于确定立即发送身份认证凭据的时机，而不是先等待 401 响应。

3.5 新版功能.

class urllib.request.AbstractBasicAuthHandler(password_mgr=None)

这是一个帮助完成 HTTP 身份认证的混合类，对远程主机和代理都适用。参数 password_mgr 应与 HTTPPasswordMgr 兼容；关于必须支持哪些接口，请参阅 HTTPPasswordMgr 对象 对象的章节。如果 password_mgr 还提供 is_authenticated 和 update_authenticated 方法（请参阅 HTTPPasswordMgrWithPriorAuth 对象 对象），则 handler 将对给定 URI 用到 is_authenticated 的结果，来确定是否随请求发送身份认证凭据。如果该 URI 的 is_authenticated 返回 True，则发送凭据。如果 is_authenticated 为 False ，则不发送凭据，然后若收到 401 响应，则使用身份认证凭据重新发送请求。如果身份认证成功，则调用 update_authenticated 设置该 URI 的 is_authenticated 为 True，这样后续对该 URI 或其所有父 URI 的请求将自动包含该身份认证凭据。

3.5 新版功能: 增加了对 is_authenticated 的支持。

class urllib.request.HTTPBasicAuthHandler(password_mgr=None)

处理远程主机的身份认证。 password_mgr 应与 HTTPPasswordMgr 兼容；有关哪些接口是必须支持的，请参阅 HTTPPasswordMgr 对象 章节。如果给出错误的身份认证方式， HTTPBasicAuthHandler 将会触发 ValueError 。

class urllib.request.ProxyBasicAuthHandler(password_mgr=None)

处理有代理服务时的身份认证。 password_mgr 应与 HTTPPasswordMgr 兼容；有关哪些接口是必须支持的，请参阅 HTTPPasswordMgr 对象 章节。

class urllib.request.AbstractDigestAuthHandler(password_mgr=None)

这是一个帮助完成 HTTP 身份认证的混合类，对远程主机和代理都适用。参数 password_mgr 应与 HTTPPasswordMgr 兼容；关于必须支持哪些接口，请参阅 HTTPPasswordMgr 对象 的章节。

class urllib.request.HTTPDigestAuthHandler(password_mgr=None)

处理远程主机的身份认证。 password_mgr 应与 HTTPPasswordMgr 兼容；有关哪些接口是必须支持的，请参阅 HTTPPasswordMgr 对象 章节。如果同时添加了 digest 身份认证 handler 和basic 身份认证 handler，则会首先尝试 digest 身份认证。如果 digest 身份认证再返回 40x 响应，会再发送到 basic 身份验证 handler 进行处理。如果给出 Digest 和 Basic 之外的身份认证方式， 本 handler 方法将会触发 ValueError 。

在 3.3 版更改: 碰到不支持的认证方式时，将会触发 ValueError 。

class urllib.request.ProxyDigestAuthHandler(password_mgr=None)

处理有代理服务时的身份认证。 password_mgr 应与 HTTPPasswordMgr 兼容；有关哪些接口是必须支持的，请参阅 HTTPPasswordMgr 对象 章节。

class urllib.request.HTTPHandler

用于打开 HTTP URL 的 handler 类。

class urllib.request.HTTPSHandler(debuglevel=0, context=None, check_hostname=None)

用于打开 HTTPS URL 的 handler 类。context 和 check_hostname 的含义与 http.client.HTTPSConnection 的一样。

在 3.2 版更改: 添加 context 和 check_hostname 参数。

class urllib.request.FileHandler

打开本地文件。

class urllib.request.DataHandler

打开数据 URL。

3.4 新版功能.

class urllib.request.FTPHandler

打开 FTP URL。

class urllib.request.CacheFTPHandler

打开 FTP URL，并将打开的 FTP 连接存入缓存，以便最大程度减少延迟。

class urllib.request.UnknownHandler

处理所有未知类型 URL 的兜底类。

class urllib.request.HTTPErrorProcessor

处理出错的 HTTP 响应。

Request 对象

以下方法介绍了 Request 的公开接口，因此子类可以覆盖所有这些方法。这里还定义了几个公开属性，客户端可以利用这些属性了解经过解析的请求。

Request.full_url

传给构造函数的原始 URL。

在 3.4 版更改.

Request.full_url 是一个带有 setter、getter 和 deleter 的属性。读取 full_url 属性将会返回附带片段（fragment）的初始请求 URL。

Request.type

URI 方式。

Request.host

URI 权限，通常是整个主机，但也有可能带有冒号分隔的端口号。

Request.origin_req_host

请求的原始主机，不含端口。

Request.selector

URI 路径。若 Request 使用代理，selector 将会是传给代理的完整 URL。

Request.data

请求的数据体，未给出则为 None 。

在 3.4 版更改: 现在如果修改 Request.data 的值，则会删除之前设置或计算过的“Content-Length”头部信息。

Request.unverifiable

布尔值，标识本请求是否属于 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 中定义的无法验证的情况。

Request.method

要采用的 HTTP 请求方法。默认为 None，表示 get_method() 将对方法进行正常处理。设置本值可以覆盖 get_method() 中的默认处理过程，设置方式可以是在 Request 的子类中给出默认值，也可以通过 method 参数给 Request 构造函数传入一个值。

3.3 新版功能.

在 3.4 版更改: 现在可以在子类中设置默认值；而之前只能通过构造函数的实参进行设置。

Request.get_method()

返回表示 HTTP 请求方法的字符串。如果 Request.method 不为 None ，则返回其值。否则若 Request.data 为 则返回 'GET'，不为 None 则返回 'POST' 。只对 HTTP 请求有效。

在 3.3 版更改: 现在 get_method 会兼顾 Request.method 的值。

Request.add_header(key, val)

向请求添加一个标头。 标头目前会被所有处理器忽略但只有 HTTP 处理器是例外，该处理器会将它们加入发给服务器的标头列表中。 请注意同名的标头只能有一个，当 key 发生冲突时后续的调用将会覆盖之前的调用。 目前，这并不会造成 HTTP 功能的损失，因为所有可多次使用而仍有意义的标头都有（特定标头专属的）方式来获得与仅使用一个标头时相同的功能。 请注意使用此方法添加的标头也会被添加到重定向的请求中。

Request.add_unredirected_header(key, header)

添加一项不会被加入重定向请求的头部信息。

Request.has_header(header)

返回本实例是否带有命名头部信息（对常规数据和非重定向数据都会检测）。

Request.remove_header(header)

从本请求实例中移除指定命名的头部信息（对常规数据和非重定向数据都会检测）。

3.4 新版功能.

Request.get_full_url()

返回构造器中给定的 URL。

在 3.4 版更改.

返回 Request.full_url

Request.set_proxy(host, type)

连接代理服务器，为当前请求做准备。 host 和 type 将会取代本实例中的对应值，selector 将会是构造函数中给出的初始 URL。

Request.get_header(header_name, default=None)

返回给定头部信息的数据。如果该头部信息不存在，返回默认值。

Request.header_items()

返回头部信息，形式为（名称, 数据）的元组列表。

在 3.4 版更改: 自 3.3 起已弃用的下列方法已被删除：add_data、has_data、get_data、get_type、get_host、get_selector、get_origin_req_host 和 is_unverifiable 。

OpenerDirector 对象

OpenerDirector 实例有以下方法：

OpenerDirector.add_handler(handler)

handler 应为 BaseHandler 的实例。将检索以下类型的方法，并将其添加到对应的处理链中（注意 HTTP 错误是特殊情况）。请注意，下文中的 protocol 应替换为要处理的实际协议，例如 http_response() 将是 HTTP 协议响应处理函数。并且 type 也应替换为实际的 HTTP 代码，例如 http_error_404() 将处理 HTTP 404 错误。

<protocol>_open() — 表明该 handler 知道如何打开 protocol 协议的URL。

更多信息请参阅 BaseHandler.<protocol>_open() 。

http_error_<type>() — 表明该 handler 知道如何处理代码为 type 的 HTTP 错误。

更多信息请参阅 BaseHandler.http_error_<nnn>() 。

<protocol>_error() — 表明该 handler 知道如何处理来自协议为 protocol （非http）的错误。

<protocol>_request() — 表明该 handler 知道如何预处理协议为 protocol 的请求。

更多信息请参阅 BaseHandler.<protocol>_request() 。

<protocol>_response() — 表明该 handler 知道如何后处理协议为 protocol 的响应。

更多信息请参阅 BaseHandler.<protocol>_response() 。

OpenerDirector.open(url, data=None[, timeout])

打开给定的 url (可以是一个请求对象或一个字符串），可以选择传入给定的 data。 参数、返回值和被引发的异常均与 urlopen() 的相同 (它只是简单地在当前安装的全局 OpenerDirector 上调用 open() 方法)。 可选的 timeout 形参指定了针对阻塞操作例如连接尝试的超时值 (如果未指明，则将使用全局默认的超时设置)。 超时特性仅适用于 HTTP, HTTPS 和 FTP 连接。

OpenerDirector.error(proto, *args)

处理给定协议的错误。将用给定的参数（协议相关）调用已注册的给定协议的错误处理程序。HTTP 协议是特殊情况，采用 HTTP 响应码来确定具体的错误处理程序；请参考 handler 类的 http_error_<type>() 方法。

返回值和异常均与 urlopen() 相同。

OpenerDirector 对象分 3 个阶段打开 URL：

每个阶段中调用这些方法的次序取决于 handler 实例的顺序。

每个具有 _request() 这类方法的 handler 都会调用本方法对请求进行预处理。

调用具有 _open() 这类方法的 handler 来处理请求。当 handler 返回非None 值（即响应）或引发异常（通常是 URLError）时，本阶段结束。本阶段能够传播异常。

事实上，以上算法首先会尝试名为 default_open() 的方法。 如果这些方法全都返回 None，则会对名为 <protocol>_open() 的方法重复此算法。 如果这些方法也全都返回 None，则会继续对名为 unknown_open() 的方法重复此算法。

请注意，这些方法的代码可能会调用 OpenerDirector 父实例的 open() 和 error() 方法。

每个具有 _response() 这类方法的 handler 都会调用这些方法，以对响应进行后处理。

BaseHandler 对象

BaseHandler 对象提供了一些直接可用的方法，以及其他一些可供派生类使用的方法。以下是可供直接使用的方法：

BaseHandler.add_parent(director)

将 director 加为父 OpenerDirector。

BaseHandler.close()

移除所有父 OpenerDirector。

以下属性和方法仅供 BaseHandler 的子类使用：

注解

以下约定已被采纳：定义 <protocol>_request() 或 <protocol>_response() 方法的子类应命名为 *Processor；所有其他子类都应命名为 *Handler 。

BaseHandler.parent

一个可用的 OpenerDirector，可用于以其他协议打开 URI，或处理错误。

BaseHandler.default_open(req)

本方法在 BaseHandler 中 未 予定义，但其子类若要捕获所有 URL 则应进行定义。

如果实现了本方法，则它将被父类 OpenerDirector 所调用。 它应当返回一个如 OpenerDirector 的 open() 方法的返回值所描述的文件类对象，或是返回 None。 它应当引发 URLError，除非发生真正的异常 (例如，MemoryError 就不应被映射为 URLError)。

本方法将会在所有协议的 open 方法之前被调用。

BaseHandler.<protocol>_open(req)

本方法在 BaseHandler 中 未 予定义，但其子类若要处理给定协议的 URL 则应进行定义。

若定义了本方法，将会被父 OpenerDirector 对象调用。返回值和 default_open() 的一样。

BaseHandler.unknown_open(req)

本方法在 BaseHandler 中 未 予定义，但其子类若要捕获并打开所有未注册 handler 的 URL，则应进行定义。

若实现了本方法，将会被 parent 属性指向的父 OpenerDirector 调用。返回值和 default_open() 的一样。

BaseHandler.http_error_default(req, fp, code, msg, hdrs)

本方法在 BaseHandler 中 未 予定义，但其子类若要为所有未定义 handler 的 HTTP 错误提供一个兜底方法，则应进行重写。OpenerDirector 会自动调用本方法，获取错误信息，而通常在其他时候不应去调用。

req 会是一个 Request 对象，fp 是一个带有 HTTP 错误体的文件型对象，code 是三位数的错误码，msg 是供用户阅读的解释信息，hdrs 则是一个包含出错头部信息的字典对象。

返回值和触发的异常应与 urlopen() 的相同。

BaseHandler.http_error_<nnn>(req, fp, code, msg, hdrs)

nnn 应为三位数的 HTTP 错误码。本方法在 BaseHandler 中也未予定义，但当子类的实例发生代码为 nnn 的 HTTP 错误时，若方法存在则会被调用。

子类应该重写本方法，以便能处理相应的 HTTP 错误。

参数、返回值和触发的异常应与 http_error_default() 相同。

BaseHandler.<protocol>_request(req)

本方法在 BaseHandler 中 未 予定义，但其子类若要对给定协议的请求进行预处理，则应进行定义。

若实现了本方法，将会被父 OpenerDirector 调用。req 将为 Request 对象。返回值应为 Request 对象。

BaseHandler.<protocol>_response(req, response)

本方法在 BaseHandler 中 未 予定义，但其子类若要对给定协议的请求进行后处理，则应进行定义。

若实现了本方法，将会被父 OpenerDirector 调用。req 将为 Request 对象。response 应实现与 urlopen() 返回值相同的接口。返回值应实现与 urlopen() 返回值相同的接口。

HTTPRedirectHandler 对象

注解

某些 HTTP 重定向操作需要本模块的客户端代码提供的功能。这时会触发 HTTPError。有关各种重定向代码的确切含义，请参阅 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] 。

如果给到 HTTPRedirectHandler 的重定向 URL 不是 HTTP、HTTPS 或 FTP URL，则出于安全考虑将触发 HTTPError 异常。

HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)

返回 Request 或 None 对象作为重定向行为的响应。当服务器接收到重定向请求时， http_error_30*() 方法的默认实现代码将会调用本方法。如果确实应该发生重定向，则返回一个新的 Request 对象，使得 http_error_30*() 能重定向至 newurl。否则，若没有 handler 会处理此 URL，则会引发 HTTPError；或者本方法不能处理但或许会有其他 handler 会处理，则返回 None 。

注解

本方法的默认实现代码并未严格遵循 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html]，即 POST 请求的 301 和 302 响应不得在未经用户确认的情况下自动进行重定向。现实情况下，浏览器确实允许自动重定向这些响应，将 POST 更改为 GET ，于是默认实现代码就复现了这种处理方式。

HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)

重定向到 Location: 或 URI: URL。 当得到 HTTP 'moved permanently' 响应时，本方法会被父级 OpenerDirector 调用。

HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)

与 http_error_301() 相同，不过是发生“found”响应时的调用。

HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)

与 http_error_301() 相同，不过是发生“see other”响应时的调用。

HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)

与 http_error_301() 相同，不过是发生“temporary redirect”响应时的调用。

HTTPCookieProcessor 对象

HTTPCookieProcessor 的实例具备一个属性：

HTTPCookieProcessor.cookiejar

cookie 存放在 http.cookiejar.CookieJar 中。

ProxyHandler 对象

ProxyHandler.<protocol>_open(request)

ProxyHandler 将为每种 protocol 准备一个 _open() 方法，在构造函数给出的 proxies 字典中包含对应的代理服务器信息。通过调用 request.set_proxy()，本方法将把请求转为通过代理服务器，并会调用 handler 链中的下一个 handler 来完成对应的协议处理。

HTTPPasswordMgr 对象

以下方法 HTTPPasswordMgr 和 HTTPPasswordMgrWithDefaultRealm 对象均有提供。

HTTPPasswordMgr.add_password(realm, uri, user, passwd)

uri 可以是单个 URI，也可以是 URI 列表。realm、user 和 passwd 必须是字符串。这使得在为 realm 和超级 URI 进行身份认证时，(user, passwd) 可用作认证令牌。

HTTPPasswordMgr.find_user_password(realm, authuri)

为给定 realm 和 URI 获取用户名和密码。如果没有匹配的用户名和密码，本方法将会返回 (None, None) 。

对于 HTTPPasswordMgrWithDefaultRealm 对象，如果给定 realm 没有匹配的用户名和密码，将搜索 realm None。

HTTPPasswordMgrWithPriorAuth 对象

这是 HTTPPasswordMgrWithDefaultRealm 的扩展，以便对那些需要一直发送认证凭证的 URI 进行跟踪。

HTTPPasswordMgrWithPriorAuth.add_password(realm, uri, user, passwd, is_authenticated=False)

realm、uri、user、passwd 的含义与 HTTPPasswordMgr.add_password() 的相同。is_authenticated 为给定 URI 或 URI 列表设置 is_authenticated 标志的初始值。如果 is_authenticated 设为 True ，则会忽略 realm。

HTTPPasswordMgrWithPriorAuth.find_user_password(realm, authuri)

与 HTTPPasswordMgrWithDefaultRealm 对象的相同。

HTTPPasswordMgrWithPriorAuth.update_authenticated(self, uri, is_authenticated=False)

更新给定 uri 或 URI 列表的 is_authenticated 标志。

HTTPPasswordMgrWithPriorAuth.is_authenticated(self, authuri)

返回给定 URI is_authenticated 标志的当前状态。

AbstractBasicAuthHandler 对象

AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers)

通过获取用户名和密码并重新尝试请求，以处理身份认证请求。 authreq 应该是请求中包含 realm 的头部信息名称，host 指定了需要进行身份认证的 URL 和路径，req 应为 (已失败的) Request 对象 , headers 应该是出错的头部信息。

host 要么是一个认证信息（例如 "python.org" ），要么是一个包含认证信息的 URL（如 "http://python.org/" ）。 不论是哪种格式，认证信息中都不能包含用户信息（因此， "python.org" 和 "python.org:80" 没问题，而 "joe:password@python.org" 则不行）。

HTTPBasicAuthHandler 对象

HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。

ProxyBasicAuthHandler 对象

ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。

AbstractDigestAuthHandler 对象

AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers)

authreq 应为请求中有关 realm 的头部信息名称，host 应为需要进行身份认证的主机，req 应为（已失败的） Request 对象， headers 则应为出错的头部信息。

HTTPDigestAuthHandler 对象

HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。

ProxyDigestAuthHandler 对象

ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。

HTTPHandler 对象

HTTPHandler.http_open(req)

发送 HTTP 请求，根据 req.has_data() 的结果，可能是 GET 或 POST 格式。

HTTPSHandler 对象

HTTPSHandler.https_open(req)

发送 HTTPS 请求，根据 req.has_data() 的结果，可能是 GET 或 POST 格式。

FileHandler 对象

FileHandler.file_open(req)

若无主机名或主机名为 'localhost' ，则打开本地文件。

在 3.2 版更改: 本方法仅适用于本地主机名。如果给出的是远程主机名，将会触发 URLError 。

DataHandler 对象

DataHandler.data_open(req)

读取内含数据的 URL。这种 URL 本身包含了经过编码的数据。 RFC 2397 [https://datatracker.ietf.org/doc/html/rfc2397.html] 中给出了数据 URL 的语法定义。目前的代码库将忽略经过 base64 编码的数据 URL 中的空白符，因此 URL 可以放入任何源码文件中。如果数据 URL 的 base64 编码尾部缺少填充，即使某些浏览器不介意，但目前的代码库仍会引发 ValueError。

FTPHandler 对象

FTPHandler.ftp_open(req)

打开由 req 给出的 FTP 文件。登录时的用户名和密码总是为空。

CacheFTPHandler 对象

CacheFTPHandler 对象即为加入以下方法的 FTPHandler 对象：

CacheFTPHandler.setTimeout(t)

设置连接超时为 t 秒。

CacheFTPHandler.setMaxConns(m)

设置已缓存的最大连接数为 m 。

UnknownHandler 对象

UnknownHandler.unknown_open()

触发 URLError 异常。

HTTPErrorProcessor 对象

HTTPErrorProcessor.http_response(request, response)

处理出错的 HTTP 响应。

对于 200 错误码，响应对象应立即返回。

对于 200 以外的错误码，只通过 OpenerDirector.error() 将任务传给 handler 的 http_error_<type>() 方法。如果最终没有 handler 处理错误， HTTPDefaultErrorHandler 将触发 HTTPError。

HTTPErrorProcessor.https_response(request, response)

HTTPS 出错响应的处理。

与 http_response() 方法相同。

例子

如何利用 urllib 包获取网络资源 中给出了更多的示例。

以下示例将读取 python.org 主页并显示前 300 个字节的内容：

>>> import urllib.request
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(300))
...
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
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n
<meta http-equiv="content-type" content="text/html; charset=utf-8" />\n
<title>Python Programming '

请注意，urlopen 将返回字节对象。这是因为 urlopen 无法自动确定由 HTTP 服务器收到的字节流的编码。通常，只要能确定或猜出编码格式，就应将返回的字节对象解码为字符串。

下述 W3C 文档 https://www.w3.org/International/O-charset列出了可用于指明（X）HTML 或 XML 文档编码信息的多种方案。

python.org 网站已在 meta 标签中指明，采用的是 utf-8 编码，因此这里将用同样的格式对字节串进行解码。

>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(100).decode('utf-8'))
...
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm

不用 context manager 方法也能获得同样的结果：

>>> import urllib.request
>>> f = urllib.request.urlopen('http://www.python.org/')
>>> print(f.read(100).decode('utf-8'))
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm

以下示例将会把数据流发送给某 CGI 的 stdin，并读取返回数据。请注意，该示例只能工作于 Python 装有 SSL 支持的环境。

>>> 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"

上述示例中的 CGI 代码如下所示：

#!/usr/bin/env python
import sys
data = sys.stdin.read()
print('Content-type: text/plain\n\nGot Data: "%s"' % data)

下面是利用 Request 发送 PUT 请求的示例：

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)

基本 HTTP 认证示例：

import urllib.request
# Create an OpenerDirector with support for Basic HTTP Authentication...
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)
# ...and install it globally so it can be used with urlopen.
urllib.request.install_opener(opener)
urllib.request.urlopen('http://www.example.com/login.html')

build_opener() 默认提供了很多现成的 handler，包括 ProxyHandler。 默认情况下，ProxyHandler 会使用名为 <scheme>_proxy 的环境变量，其中的 <scheme> 是相关的 URL 协议。 例如，可以读取 http_proxy 环境变量来获取 HTTP 代理的 URL。

这个示例将默认的 ProxyHandler 替换为使用以编程方式提供的代理 URL，并通过 ProxyBasicAuthHandler 添加代理认证支持。

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)
# This time, rather than install the OpenerDirector, we use it directly:
opener.open('http://www.example.com/login.html')

添加 HTTP 头部信息：

可利用 Request 构造函数的 headers 参数，或者是：

import urllib.request
req = urllib.request.Request('http://www.example.com/')
req.add_header('Referer', 'http://www.python.org/')
# Customize the default User-Agent header value:
req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)')
r = urllib.request.urlopen(req)

OpenerDirector 自动会在每个 Request 中加入一项 User-Agent 头部信息。若要修改，请参见以下语句：

import urllib.request
opener = urllib.request.build_opener()
opener.addheaders = [('User-agent', 'Mozilla/5.0')]
opener.open('http://www.example.com/')

另请记得，当 Request 传给 urlopen() （或 OpenerDirector.open()）时，会加入一些标准的头部信息（ Content-Length 、 Content-Type 和 Host）。

以下会话示例用 GET 方法读取包含参数的 URL。

>>> 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'))
...

以下示例换用 POST 方法。请注意 urlencode 输出结果先被编码为字节串 data，再送入 urlopen。

>>> 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'))
...

以下示例显式指定了 HTTP 代理，以覆盖环境变量中的设置：

>>> import urllib.request
>>> proxies = {'http': 'http://proxy.example.com:8080/'}
>>> opener = urllib.request.FancyURLopener(proxies)
>>> with opener.open("http://www.python.org") as f:
...     f.read().decode('utf-8')
...

以下示例根本不用代理，也覆盖了环境变量中的设置：

>>> import urllib.request
>>> opener = urllib.request.FancyURLopener({})
>>> with opener.open("http://www.python.org/") as f:
...     f.read().decode('utf-8')
...

已停用的接口

以下函数和类是由 Python 2 模块 urllib （相对早于 urllib2 ）移植过来的。将来某个时候可能会停用。

urllib.request.urlretrieve(url, filename=None, reporthook=None, data=None)

将 URL 形式的网络对象复制为本地文件。如果 URL 指向本地文件，则必须提供文件名才会执行复制。返回值为元组 (filename, headers) ，其中 filename 是保存网络对象的本地文件名， headers 是由 urlopen() 返回的远程对象 info() 方法的调用结果。可能触发的异常与 urlopen() 相同。

第二个参数指定文件的保存位置（若未给出，则会是名称随机生成的临时文件）。第三个参数是个可调用对象，在建立网络连接时将会调用一次，之后每次读完数据块后会调用一次。该可调用对象将会传入 3 个参数：已传输的块数、块的大小（以字节为单位）和文件总的大小。如果面对的是老旧 FTP 服务器，文件大小参数可能会是 -1 ，这些服务器响应读取请求时不会返回文件大小。

以下例子演示了大部分常用场景：

>>> import urllib.request
>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
>>> html = open(local_filename)
>>> html.close()

如果 url 使用 http: 方式的标识符，则可能给出可选的 data 参数来指定一个 POST 请求 (通常的请求类型为 GET)。 data 参数必须是标准 application/x-www-form-urlencoded 格式的字节串对象；参见 urllib.parse.urlencode() 函数。

urlretrieve() 在检测到可用数据少于预期的大小（即由 Content-Length 标头所报告的大小）时将引发 ContentTooShortError。 例如，这可能会在下载中断时发生。

Content-Length 会被视为大小的下限：如果存在更多的可用数据，urlretrieve 会读取更多的数据，但是如果可用数据少于该值，则会引发异常。

在这种情况下你仍然能够获取已下载的数据，它会存放在异常实例的 content 属性中。

如果未提供 Content-Length 标头，urlretrieve 就无法检查它所下载的数据大小，只是简单地返回它。 在这种情况下你只能假定下载是成功的。

urllib.request.urlcleanup()

清理之前调用 urlretrieve() 时可能留下的临时文件。

class urllib.request.URLopener(proxies=None, **x509)

3.3 版后已移除.

用于打开和读取 URL 的基类。 除非你需要支持使用 http:, ftp: 或 file: 以外的方式来打开对象，那你也许可以使用 FancyURLopener。

在默认情况下，URLopener 类会发送一个内容为 urllib/VVV 的 User-Agent 标头，其中 VVV 是 urllib 的版本号。 应用程序可以通过子类化 URLopener 或 FancyURLopener 并在子类定义中将类属性 version 设为适当的字符串值来定义自己的 User-Agent 标头。

可选的 proxies 形参应当是一个将方式名称映射到代理 URL 的字典，如为空字典则会完全关闭代理。 它的默认值为 None，在这种情况下如果存在环境代理设置则将使用它，正如上文 urlopen() 的定义中所描述的。

一些归属于 x509 的额外关键字形参可在使用 https: 方式时被用于客户端的验证。 支持通过关键字 key_file 和 cert_file 来提供 SSL 密钥和证书；对客户端验证的支持需要提供这两个形参。

如果服务器返回错误代码则 URLopener 对象将引发 OSError 异常。

open(fullurl, data=None)

使用适当的协议打开 fullurl。 此方法会设置缓存和代理信息，然后调用适当的打开方法并附带其输入参数。 如果方式无法被识别，则会调用 open_unknown()。 data 参数的含义与 urlopen() 中的 data 参数相同。

此方法总是会使用 quote() 来对 fullurl 进行转码。

open_unknown(fullurl, data=None)

用于打开未知 URL 类型的可重载接口。

retrieve(url, filename=None, reporthook=None, data=None)

提取 url 的内容并将其存放到 filename 中。 返回值为元组，由一个本地文件名和一个包含响应标头 (对于远程 URL) 的 email.message.Message 对象或者 None (对于本地 URL)。 之后调用方必须打开并读取 filename 的内容。 如果 filename 未给出并且 URL 指向一个本地文件，则会返回输入文件名。 如果 URL 非本地并且 filename 未给出，则文件名为带有与输入 URL 的路径末尾部分后缀相匹配的后缀的 tempfile.mktemp() 的输出。 如果给出了 reporthook，它必须为接受三个数字形参的函数：数据分块编号、读入分块的最大数据量和下载的总数据量 (未知则为 -1)。 它将在开始时和从网络读取每个数据分块之后被调用。 对于本地 URL reporthook 会被忽略。

如果 url 使用 http: 方式的标识符，则可能给出可选的 data 参数来指定一个 POST 请求 (通常的请求类型为 GET)。 data 参数必须为标准的 application/x-www-form-urlencoded 格式 ；参见 urllib.parse.urlencode() 函数。

version

指明打开器对象的用户代理名称的变量。 以便让 urllib 告诉服务器它是某个特定的用户代理，请在子类中将其作为类变量来设置或是在调用基类构造器之前在构造器中设置。

class urllib.request.FancyURLopener(...)

3.3 版后已移除.

FancyURLopener 子类化了 URLopener 以提供对以下 HTTP 响应代码的默认处理: 301, 302, 303, 307 和 401。 对于上述的 30x 响应代码，会使用 Location 标头来获取实际 URL。 对于 401 响应代码 (authentication required)，则会执行基本 HTTP 验证。 对于 30x 响应代码，递归层数会受 maxtries 属性值的限制，该值默认为 10。

对于所有其他响应代码，会调用 http_error_default() 方法，你可以在子类中重写此方法来正确地处理错误。

注解

根据 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] 的说明，对 POST 请求的 301 和 302 响应不可在未经用户确认的情况下自动进行重定向。 在现实情况下，浏览器确实允许自动重定义这些响应，将 POST 更改为 GET，于是 urllib 就会复现这种行为。

传给此构造器的形参与 URLopener 的相同。

注解

当执行基本验证时，FancyURLopener 实例会调用其 prompt_user_passwd() 方法。 默认的实现将向用户询问控制终端所要求的信息。 如有必要子类可以重写此方法来支持更适当的行为。

FancyURLopener 类附带了一个额外方法，它应当被重载以提供适当的行为:

prompt_user_passwd(host, realm)

返回指定的安全体系下在给定的主机上验证用户所需的信息。 返回的值应当是一个元组 (user, password)，它可被用于基本验证。

该实现会在终端上提示此信息；应用程序应当重写此方法以使用本地环境下适当的交互模型。

urllib.request 的限制

目前，仅支持下列协议: HTTP (0.9 和 1.0 版), FTP, 本地文件, 以及数据 URL。

在 3.4 版更改: 增加了对数据URL 的支持。

urlretrieve() 的缓存特性已被禁用，等待有人有时间去正确地解决过期时间标头的处理问题。

应当有一个函数来查询特定 URL 是否在缓存中。

为了保持向下兼容性，如果某个 URL 看起来是指向本地文件但该文件无法被打开，则该 URL 会使用 FTP 协议来重新解读。 这有时可能会导致令人迷惑的错误消息。

urlopen() 和 urlretrieve() 函数在等待网络连接建立时会导致任意长时间的延迟。 这意味着在不使用线程的情况下搭建一个可交互的 Web 客户端是非常困难的。

由 urlopen() 或 urlretrieve() 返回的数据就是服务器所返回的原始数据。 这可以是二进制数据（如图片）、纯文本或 HTML 代码等。 HTTP 协议在响应标头中提供了类型信息，这可以通过读取 Content-Type 标头来查看。 如果返回的数据是 HTML，你可以使用 html.parser 模块来解析它。

处理 FTP 协议的代码无法区分文件和目录。 这在尝试读取指向不可访问的 URL 时可能导致意外的行为。 如果 URL 以一个 / 结束，它会被认为指向一个目录并将作相应的处理。 但是如果读取一个文件的尝试导致了 550 错误（表示 URL 无法找到或不可访问，这常常是由于权限原因），则该路径会被视为一个目录以便处理 URL 是指定一个目录但略去了末尾 / 的情况。 这在你尝试获取一个因其设置了读取权限因而无法访问的文件时会造成误导性的结果；FTP 代码将尝试读取它，因 550 错误而失败，然后又为这个不可读取的文件执行目录列表操作。 如果需要细粒度的控制，请考虑使用 ftplib 模块，子类化 FancyURLopener，或是修改 _urlopener 来满足你的需求。

urllib.response --- urllib 使用的 Response 类

urllib.response 模块定义了一些函数和提供最小化文件类接口包括 read() 和 readline() 等的类。 此模块定义的函数会由 urllib.request 模块在内部使用。 典型的响应对象是一个 urllib.response.addinfourl 实例:

class urllib.response.addinfourl

url

已读取资源的 URL，通常用于确定是否进行了重定向。

headers

以 EmailMessage 实例的形式返回响应的标头。

status

3.9 新版功能.

由服务器返回的状态码。

geturl()

3.9 版后已移除: 已弃用，建议改用 url。

info()

3.9 版后已移除: 已弃用，建议改用 headers。

code

3.9 版后已移除: 已弃用，建议改用 status。

getcode()

3.9 版后已移除: 已弃用，建议改用 status。

urllib.parse 用于解析 URL

源代码: Lib/urllib/parse.py [https://github.com/python/cpython/tree/3.10/Lib/urllib/parse.py]

该模块定义了一个标准接口，用于将统一资源定位符（URL）字符串拆分为不同部分（协议、网络位置、路径等），或将各个部分组合回 URL 字符串，并将“相对 URL”转换为基于给定的“基准 URL”的绝对 URL。

该模块被设计为匹配针对相对统一资源定位符的因特网 RFC。 它支持下列 URL 类型: file, ftp, gopher, hdl, http, https, imap, mailto, mms, news, nntp, prospero, rsync, rtsp, rtspu, sftp, shttp, sip, sips, snews, svn, svn+ssh, telnet, wais, ws, wss.

urllib.parse 模块定义的函数可分为两个主要门类: URL 解析和 URL 转码。 这些函数将在以下各节中详细说明。

URL 解析

URL 解析函数用于将一个 URL 字符串分割成其组成部分，或者将 URL 的多个部分组合成一个 URL 字符串。

urllib.parse.urlparse(urlstring, scheme='', allow_fragments=True)

将一个 URL 解析为六个部分，返回一个包含 6 项的 named tuple。 这对应于 URL 的主要结构: scheme://netloc/path;parameters?query#fragment。 每个元组项均为字符串，可能为空字符串。 这些部分不会再被拆分为更小的部分（例如，netloc 将为单个字符串），并且 % 转义不会被扩展。 上面显示的分隔符不会出现在结果中，只有 path 部分的开头斜杠例外，它如果存在则会被保留。 例如:

>>> from urllib.parse import urlparse
>>> urlparse("scheme://netloc/path;parameters?query#fragment")
ParseResult(scheme='scheme', netloc='netloc', path='/path;parameters', params='',
            query='query', fragment='fragment')
>>> o = urlparse("http://docs.python.org:80/3/library/urllib.parse.html?"
...              "highlight=params#url-parsing")
>>> o
ParseResult(scheme='http', netloc='docs.python.org:80',
            path='/3/library/urllib.parse.html', params='',
            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'

根据 RFC 1808 [https://datatracker.ietf.org/doc/html/rfc1808.html] 中的语法规范，urlparse 仅在 netloc 前面正确地附带了 '//' 的情况下才会识别它。 否则输入会被当作是一个相对 URL 因而以路径的组成部分开头。

>>> from urllib.parse import urlparse
>>> urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            params='', query='', fragment='')
>>> urlparse('www.cwi.nl/%7Eguido/Python.html')
ParseResult(scheme='', netloc='', path='www.cwi.nl/%7Eguido/Python.html',
            params='', query='', fragment='')
>>> urlparse('help/Python.html')
ParseResult(scheme='', netloc='', path='help/Python.html', params='',
            query='', fragment='')

scheme 参数给出了默认的协议，只有在 URL 未指定协议的情况下才会被使用。 它应该是与 urlstring 相同的类型（文本或字节串），除此之外默认值 '' 也总是被允许，并会在适当情况下自动转换为 b''。

如果 allow_fragments 参数为假值，则片段标识符不会被识别。 它们会被解析为路径、参数或查询部分，在返回值中 fragment 会被设为空字符串。

返回值是一个 named tuple，这意味着它的条目可以通过索引或作为命名属性来访问，这些属性是：

属性 | 索引 | 值 | 值（如果不存在）
scheme | 0 | URL 协议说明符 | scheme 参数
netloc | 1 | 网络位置部分 | 空字符串
path | 2 | 分层路径 | 空字符串
params | 3 | 最后路径元素的参数 | 空字符串
query | 4 | 查询组件 | 空字符串
fragment | 5 | 片段标识符 | 空字符串
username |  | 用户名 | None
password |  | 密码 | None
hostname |  | 主机名（小写） | None
port |  | 端口号为整数（如果存在） | None

如果在 URL 中指定了无效的端口，读取 port 属性将引发 ValueError。 有关结果对象的更多信息请参阅 结构化解析结果 一节。

在 netloc 属性中不匹配的方括号将引发 ValueError。

如果 netloc 属性中的字符在 NFKC 规范化下（如 IDNA 编码格式所使用的）被分解成 /, ?, #, @ 或 : 则将引发 ValueError。 如果在解析之前 URL 就被分解，则不会引发错误。

与所有具名元组的情况一样，该子类还有一些特别有用的附加方法和属性。 其中一个方法是 _replace()。 _replace() 方法将返回一个新的 ParseResult 对象来将指定字段替换为新的值。

>>> from urllib.parse import urlparse
>>> u = urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
>>> u
ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            params='', query='', fragment='')
>>> u._replace(scheme='http')
ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            params='', query='', fragment='')

警告

urlparse() 不会执行验证。 请参阅 URL 解析安全 了解详情。

在 3.2 版更改: 添加了IPv6 URL解析功能。

在 3.3 版更改: 会对所有 URL 协议解析片段（除非 allow_fragment 为假值），依据 RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html] 的规范。 在之前版本中，存在一个支持片段的协议允许名单。

在 3.6 版更改: 超范围的端口号现在会引发 ValueError，而不是返回 None。

在 3.8 版更改: 在 NFKC 规范化下会影响 netloc 解析的字符现在将引发 ValueError。

urllib.parse.parse_qs(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

解析以字符串参数形式（类型为 application/x-www-form-urlencoded 的数据）给出的查询字符串。 返回字典形式的数据。 结果字典的键为唯一的查询变量名而值为每个变量名对应的值列表。

可选参数 keep_blank_values 是一个旗标，指明是否要将以百分号转码的空值作为空字符串处理。 真值表示空值应当被保留作为空字符串。 默认的假值表示空值会被忽略并将其视作未包括的值。

可选参数 strict_parsing 是一个旗标，指明要如何处理解析错误。 如为假值（默认），错误会被静默地忽略。 如为真值，错误会引发 ValueError 异常。

可选的 encoding 和 errors 形参指定如何将以百分号编码的序列解码为 Unicode 字符，即作为 bytes.decode() 方法所接受的数据。

可选参数 max_num_fields 是要读取的最大字段数量的。 如果设置，则如果读取的字段超过 max_num_fields 会引发 ValueError。

可选参数 separator 是用来分隔查询参数的符号。 默认为 &。

使用 urllib.parse.urlencode() 函数 (并将 doseq 形参设为 True) 将这样的字典转换为查询字符串。

在 3.2 版更改: 增加了 encoding 和 errors 形参。

在 3.8 版更改: 增加了 max_num_fields 形参。

在 3.10 版更改: 增加了 separator 形参，默认值为 &。 Python 在早于 Python 3.10 的版本中允许使用 ; 和 & 作为查询参数分隔符。 此设置已被改为只允许单个分隔符键，并以 & 作为默认的分隔符。

urllib.parse.parse_qsl(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

解析以字符串参数形式（类型为 application/x-www-form-urlencoded 的数据）给出的查询字符串。 数据以字段名和字段值对列表的形式返回。

可选参数 keep_blank_values 是一个旗标，指明是否要将以百分号转码的空值作为空字符串处理。 真值表示空值应当被保留作为空字符串。 默认的假值表示空值会被忽略并将其视作未包括的值。

可选参数 strict_parsing 是一个旗标，指明要如何处理解析错误。 如为假值（默认），错误会被静默地忽略。 如为真值，错误会引发 ValueError 异常。

可选的 encoding 和 errors 形参指定如何将以百分号编码的序列解码为 Unicode 字符，即作为 bytes.decode() 方法所接受的数据。

可选参数 max_num_fields 是要读取的最大字段数量的。 如果设置，则如果读取的字段超过 max_num_fields 会引发 ValueError。

可选参数 separator 是用来分隔查询参数的符号。 默认为 &。

使用 urllib.parse.urlencode() 函数将这样的名值对列表转换为查询字符串。

在 3.2 版更改: 增加了 encoding 和 errors 形参。

在 3.8 版更改: 增加了 max_num_fields 形参。

在 3.10 版更改: 增加了 separator 形参，默认值为 &。 Python 在早于 Python 3.10 的版本中允许使用 ; 和 & 作为查询参数分隔符。 此设置已被改为只允许单个分隔符键，并以 & 作为默认的分隔符。

urllib.parse.urlunparse(parts)

根据 urlparse() 所返回的元组来构造一个 URL。 parts 参数可以是任何包含六个条目的可迭代对象。 构造的结果可能是略有不同但保持等价的 URL，如果被解析的 URL 原本包含不必要的分隔符（例如，带有空查询的 ?；RFC 已声明这是等价的）。

urllib.parse.urlsplit(urlstring, scheme='', allow_fragments=True)

此函数类似于 urlparse()，但不会拆分来自 URL 的参数。 此函数通常应当在需要允许将参数应用到 URL 的 path 部分的每个分节的较新的 URL 语法的情况下 (参见 RFC 2396 [https://datatracker.ietf.org/doc/html/rfc2396.html]) 被用来代替 urlparse()。 需要使用一个拆分函数来拆分路径分节和参数。 此函数将返回包含 5 个条目的 named tuple:

(addressing scheme, network location, path, query, fragment identifier).

返回值是一个 named tuple，它的条目可以通过索引或作为命名属性来访问:

属性 | 索引 | 值 | 值（如果不存在）
scheme | 0 | URL 协议说明符 | scheme 参数
netloc | 1 | 网络位置部分 | 空字符串
path | 2 | 分层路径 | 空字符串
query | 3 | 查询组件 | 空字符串
fragment | 4 | 片段标识符 | 空字符串
username |  | 用户名 | None
password |  | 密码 | None
hostname |  | 主机名（小写） | None
port |  | 端口号为整数（如果存在） | None

如果在 URL 中指定了无效的端口，读取 port 属性将引发 ValueError。 有关结果对象的更多信息请参阅 结构化解析结果 一节。

在 netloc 属性中不匹配的方括号将引发 ValueError。

如果 netloc 属性中的字符在 NFKC 规范化下（如 IDNA 编码格式所使用的）被分解成 /, ?, #, @ 或 : 则将引发 ValueError。 如果在解析之前 URL 就被分解，则不会引发错误。

按照针对 RFC 3986 进行更新的 WHATWG spec [https://url.spec.whatwg.org/#concept-basic-url-parser]，打头的 C0 控制符和空格符将从 URL 中去除。 任意位置上的 \n, \r 和制表符 \t 等字符也将从 URL 中去除。at any position.

警告

urlsplit() 不会执行验证。 请参阅 URL 解析安全 了解详情。

在 3.6 版更改: 超范围的端口号现在会引发 ValueError，而不是返回 None。

在 3.8 版更改: 在 NFKC 规范化下会影响 netloc 解析的字符现在将引发 ValueError。

在 3.10 版更改: ASCII 换行符和制表符会从 URL 中被去除。

在 3.10.12 版更改: 打头的 WHATWG C0 控制符和空格符将从 URL 中去除。

urllib.parse.urlunsplit(parts)

将 urlsplit() 所返回的元组中的元素合并为一个字符串形式的完整 URL。 parts 参数可以是任何包含五个条目的可迭代对象。 其结果可能是略有不同但保持等价的 URL，如果被解析的 URL 原本包含不必要的分隔符（例如，带有空查询的 ?；RFC 已声明这是等价的）。

urllib.parse.urljoin(base, url, allow_fragments=True)

通过合并一个 "基准 URL" (base) 和另一个 URL (url) 来构造一个完整 ("absolute") URL。 在非正式情况下，这将使用基准 URL 的各部分，特别是地址协议、网络位置和 (一部分) 路径来提供相对 URL 中缺失的部分。 例如:

>>> from urllib.parse import urljoin
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html')
'http://www.cwi.nl/%7Eguido/FAQ.html'

allow_fragments 参数具有与 urlparse() 中的对应参数一致的含义与默认值。

注解

如果 url 为绝对 URL (即以 // 或 scheme:// 打头)，则 url 的主机名和/或协议将出现在结果中。 例如:

>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html',
...         '//www.python.org/%7Eguido')
'http://www.python.org/%7Eguido'

如果你不想要那样的行为，请使用 urlsplit() 和 urlunsplit() 对 url 进行预处理，移除可能存在的 scheme 和 netloc 部分。

在 3.5 版更改: 更新行为以匹配 RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html] 中定义的语义。

urllib.parse.urldefrag(url)

如果 url 包含片段标识符，则返回不带片段标识符的 url 修改版本。 如果 url 中没有片段标识符，则返回未经修改的 url 和一个空字符串。

返回值是一个 named tuple，它的条目可以通过索引或作为命名属性来访问:

属性 | 索引 | 值 | 值（如果不存在）
url | 0 | 不带片段的 URL | 空字符串
fragment | 1 | 片段标识符 | 空字符串

请参阅 结构化解析结果 一节了解有关结果对象的更多信息。

在 3.2 版更改: 结果为已构造好的对象而不是一个简单的 2 元组。-tuple.

urllib.parse.unwrap(url)

从已包装的 URL (即被格式化为 <URL:scheme://host/path>, <scheme://host/path>, URL:scheme://host/path 或 scheme://host/path 的字符串) 中提取 URL。 如果 url 不是一个已包装的 URL，它将被原样返回。

URL 解析安全

urlsplit() 和 urlparse() API 不会对输入进行 验证。 它们可能不会因其他应用程序认为不合法的输入而引发错误。 它们还可能在其他地方认为不是 URL 的输入上成功运行。 它们的目标是达成实际的功能而不是保持纯净。

他们在非正常的输入上可能不会引发异常，而是以空字符串的形式返回某些部分。 或者可能会包含某些不应包含的部分。

我们建议这些 API 的用户在任何使用的值具有安全意义的地方应用防御性代码。 在你的代码中进行某些验证之后再信任被返回的组件。 这个 scheme 合理吗？那个 path 正确吗？ 那个 hostname 是否存在怪异之处？等等。

解析ASCII编码字节

这些 URL 解析函数最初设计只用于操作字符串。 但在实践中，它也能够操作经过正确转码和编码的 ASCII 字节序列形式的 URL。 相应地，此模块中的 URL 解析函数既可以操作 str 对象也可以操作 bytes 和 bytearray 对象。

如果传入 str 数据，结果将只包含 str 数据。 如果传入 bytes 或 bytearray 数据，则结果也将只包含 bytes 数据。

试图在单个函数调用中混用 str 数据和 bytes 或 bytearray 数据将导致引发 TypeError，而试图传入非 ASCII 字节值则将引发 UnicodeDecodeError。

为了支持结果对象在 str 和 bytes 之间方便地转换，所有来自 URL 解析函数的返回值都会提供 encode() 方法 (当结果包含 str 数据) 或 decode() 方法 (当结果包含 bytes 数据)。 这些方法的签名与 str 和 bytes 的对应方法相匹配 (不同之处在于其默认编码格式是 'ascii' 而非 'utf-8')。 每个方法会输出包含相应类型的 bytes 数据 (对于 encode() 方法) 或 str 数据 (对于 decode() 方法) 的值。

对于某些需要在有可能不正确地转码的包含非 ASCII 数据的 URL 上进行操作的应用程序来说，在唤起 URL 解析方法之前必须自行将字节串解码为字符。

在本节中描述的行为仅适用于 URL 解析函数。 URL 转码函数在产生和消耗字节序列时使用它们自己的规则，详情参见单独 URL 转码函数的文档。

在 3.2 版更改: URL 解析函数现在接受 ASCII 编码的字节序列

结构化解析结果

urlparse(), urlsplit() 和 urldefrag() 函数的结果对象是 tuple 类型的子类。 这些子类中增加了在那些函数的文档中列出的属性，之前小节中描述的编码和解码支持，以及一个附加方法:

urllib.parse.SplitResult.geturl()

以字符串形式返回原始 URL 的重合并版本。 这可能与原始 URL 有所不同，例如协议的名称可能被正规化为小写字母、空的组成部分可能被丢弃。 特别地，空的参数、查询和片段标识符将会被移除。

对于 urldefrag() 的结果，只有空的片段标识符会被移除。 对于 urlsplit() 和 urlparse() 的结果，所有被记录的改变都会被应用到此方法所返回的 URL 上。

如果是通过原始的解析方法传回则此方法的结果会保持不变:

>>> 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/'

下面的类提供了当在 str 对象上操作时对结构化解析结果的实现:

class urllib.parse.DefragResult(url, fragment)

用于 urldefrag() 结果的实体类，包含有 str 数据。 encode() 方法会返回一个 DefragResultBytes 实例。

3.2 新版功能.

class urllib.parse.ParseResult(scheme, netloc, path, params, query, fragment)

用于 urlparse() 结果的实体类，包含有 str 数据。 encode() 方法会返回一个 ParseResultBytes 实例。

class urllib.parse.SplitResult(scheme, netloc, path, query, fragment)

用于 urlsplit() 结果的实体类，包含有 str 数据。 encode() 方法会返回一个 SplitResultBytes 实例。

下面的类提供了当在 bytes 或 bytearray 对象上操作时对解析结果的实现:

class urllib.parse.DefragResultBytes(url, fragment)

用于 urldefrag() 结果的实体类，包含有 bytes 数据。 decode() 方法会返回一个 DefragResult 实例。

3.2 新版功能.

class urllib.parse.ParseResultBytes(scheme, netloc, path, params, query, fragment)

用于 urlparse() 结果的实体类，包含有 bytes 数据。 decode() 方法会返回一个 ParseResult 实例。

3.2 新版功能.

class urllib.parse.SplitResultBytes(scheme, netloc, path, query, fragment)

用于 urlsplit() 结果的实体类，包含有 bytes 数据。 decode() 方法会返回一个 SplitResult 实例。

3.2 新版功能.

URL 转码

URL 转码函数的功能是接收程序数据并通过对特殊字符进行转码并正确编码非 ASCII 文本来将其转为可以安全地用作 URL 组成部分的形式。 它们还支持逆转此操作以便从作为 URL 组成部分的内容中重建原始数据，如果上述的 URL 解析函数还未覆盖此功能的话。

urllib.parse.quote(string, safe='/', encoding=None, errors=None)

使用 %xx 转义符替换 string 中的特殊字符。 字母、数字和 '_.-~' 等字符一定不会被转码。 在默认情况下，此函数只对 URL 的路径部分进行转码。 可选的 safe 形参额外指定不应被转码的 ASCII 字符 --- 其默认值为 '/'。

string 可以是 str 或 bytes 对象。

在 3.7 版更改: 从 RFC 2396 [https://datatracker.ietf.org/doc/html/rfc2396.html] 迁移到 RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html] 以转码 URL 字符串。 "~" 现在已被包括在非保留字符集中。

可选的 encoding 和 errors 形参指明如何处理非 ASCII 字符，与 str.encode() 方法所接受的值一样。 encoding 默认为 'utf-8'。 errors 默认为 'strict'，表示不受支持的字符将引发 UnicodeEncodeError。 如果 string 为 bytes 则不可提供 encoding 和 errors，否则将引发 TypeError。

请注意 quote(string, safe, encoding, errors) 等价于 quote_from_bytes(string.encode(encoding, errors), safe)。

例如: quote('/El Niño/') 将产生 '/El%20Ni%C3%B1o/'。

urllib.parse.quote_plus(string, safe='', encoding=None, errors=None)

类似于 quote()，但还会使用加号来替换空格，如在构建放入 URL 的查询字符串时对于转码 HTML 表单值时所要求的那样。 原始字符串中的加号会被转义，除非它们已包括在 safe 中。 它也不会将 safe 的默认值设为 '/'。

例如: quote_plus('/El Niño/') 将产生 '%2FEl+Ni%C3%B1o%2F'。

urllib.parse.quote_from_bytes(bytes, safe='/')

类似于 quote()，但是接受 bytes 对象而非 str，并且不执行从字符串到字节串的编码。

例如: quote_from_bytes(b'a&\xef') 将产生 'a%26%EF'。

urllib.parse.unquote(string, encoding='utf-8', errors='replace')

将 %xx 转义符替换为其单字符等价物。 可选的 encoding 和 errors 形参指定如何将以百分号编码的序列解码为 Unicode 字符，即 bytes.decode() 方法所接受的数据。

string 可以是 str 或 bytes 对象。

encoding 默认为 'utf-8'。 errors 默认为 'replace'，表示无效的序列将被替换为占位字符。

例如: unquote('/El%20Ni%C3%B1o/') 将产生 '/El Niño/'。

在 3.9 版更改: string 形参支持 bytes 和 str 对象（之前仅支持 str）。

urllib.parse.unquote_plus(string, encoding='utf-8', errors='replace')

类似于 unquote()，但还会将加号替换为空格，如反转码表单值所要求的。

string 必须为 str。

例如: unquote_plus('/El+Ni%C3%B1o/') 将产生 '/El Niño/'。

urllib.parse.unquote_to_bytes(string)

将 %xx 转义符替换为其单八位等价物，并返回一个 bytes 对象。

string 可以是 str 或 bytes 对象。

如果它是 str，则 string 中未转义的非 ASCII 字符会被编码为 UTF-8 字节串。

例如: unquote_to_bytes('a%26%EF') y将产生 b'a&\xef'。

urllib.parse.urlencode(query, doseq=False, safe='', encoding=None, errors=None, quote_via=quote_plus)

将一个包含有 str 或 bytes 对象的映射对象或二元组序列转换为以百分号编码的 ASCII 文本字符串。 如果所产生的字符串要被用作 urlopen() 函数的 POST 操作的 data，则它应当被编码为字节串，否则它将导致 TypeError。

结果字符串是一系列 key=value 对，由 '&' 字符进行分隔，其中 key 和 value 都已使用 quote_via 函数转码。 在默认情况下，会使用 quote_plus() 来转码值，这意味着空格会被转码为 '+' 字符而 '/' 字符会被转码为 %2F，即遵循 GET 请求的标准 (application/x-www-form-urlencoded)。 另一个可以作为 quote_via 传入的替代函数是 quote()，它将把空格转码为 %20 并且不编码 '/' 字符。 为了最大程度地控制要转码的内容，请使用 quote 并指定 safe 的值。

当使用二元组序列作为 query 参数时，每个元组的第一个元素为键而第二个元素为值。 值元素本身也可以为一个序列，在那种情况下，如果可选的形参 doseq 的值为 True，则每个键的值序列元素生成单个 key=value 对（以 '&' 分隔）。 被编码的字符串中的参数顺序将与序列中的形参元素顺序相匹配。

safe, encoding 和 errors 形参会被传递给 quote_via (encoding 和 errors 形参仅在查询元素为 str 时会被传递)。

为了反向执行这个编码过程，此模块提供了 parse_qs() 和 parse_qsl() 来将查询字符串解析为 Python 数据结构。

请参考 urllib 示例 来了解如何使用 urllib.parse.urlencode() 方法来生成 URL 的查询字符串或 POST 请求的数据。

在 3.2 版更改: 查询支持字节和字符串对象。

3.5 新版功能: quote_via 参数.

参见

WHATWG [https://url.spec.whatwg.org/] - URL 现有标准

定义 URL、域名、IP 地址、application/x-www-form-urlencoded 格式及其 API 的工作组。

RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html] - 统一资源标识符

这是当前的标准 (STD66)。 任何对于 urllib.parse 模块的修改都必须遵循该标准。 某些偏离也可能会出现，这大都是出于向下兼容的目的以及特定的经常存在于各主要浏览器上的实际解析需求。

RFC 2732 [https://datatracker.ietf.org/doc/html/rfc2732.html] - URL 中的 IPv6 Addresses 地址显示格式。

这指明了 IPv6 URL 的解析要求。

RFC 2396 [https://datatracker.ietf.org/doc/html/rfc2396.html] - 统一资源标识符（URI）：通用语法

描述统一资源名称 (URN) 和统一资源定位符 (URL) 通用语义要求的文档。

RFC 2368 [https://datatracker.ietf.org/doc/html/rfc2368.html] - mailto URL 模式。

mailto URL 模式的解析要求。

RFC 1808 [https://datatracker.ietf.org/doc/html/rfc1808.html] - 相对统一资源定位符

这个请求注释包括联结绝对和相对 URL 的规则，其中包括大量控制边界情况处理的 "异常示例"。

RFC 1738 [https://datatracker.ietf.org/doc/html/rfc1738.html] - 统一资源定位符 (URL)

这指明了绝对 URL 的正式语义和句法。

urllib.error --- urllib.request 引发的异常类

源代码： Lib/urllib/error.py [https://github.com/python/cpython/tree/3.10/Lib/urllib/error.py]

urllib.error 模块为 urllib.request 所引发的异常定义了异常类。 基础异常类是 URLError。

下列异常会被 urllib.error 按需引发：

exception urllib.error.URLError

处理程序在遇到问题时会引发此异常（或其派生的异常）。 它是 OSError 的一个子类。

reason

此错误的原因。 它可以是一个消息字符串或另一个异常实例。

在 3.3 版更改: URLError 已被设为 OSError 而不是 IOError 的子类。

exception urllib.error.HTTPError

虽然是一个异常（URLError 的一个子类），HTTPError 也可以作为一个非异常的文件类返回值（与 urlopen() 返所回的对象相同）。 这适用于处理特殊 HTTP 错误例如作为认证请求的时候。

code

一个 HTTP 状态码，具体定义见 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html]。 这个数字的值对应于存放在 http.server.BaseHTTPRequestHandler.responses 代码字典中的某个值。

reason

这通常是一个解释本次错误原因的字符串。

headers

导致 HTTPError 的特定 HTTP 请求的 HTTP 响应头。

3.4 新版功能.

exception urllib.error.ContentTooShortError(msg, content)

此异常会在 urlretrieve() 函数检测到已下载的数据量小于期待的数据量（由 Content-Length 头给定）时被引发。 content 属性中将存放已下载（可能被截断）的数据。

urllib.robotparser --- robots.txt 语法分析程序

源代码： Lib/urllib/robotparser.py [https://github.com/python/cpython/tree/3.10/Lib/urllib/robotparser.py]

此模块提供了一个单独的类 RobotFileParser，它可以回答关于某个特定用户代理能否在发布了 robots.txt 文件的网站抓取特定 URL 的问题。 有关 robots.txt 文件结构的更多细节，请参阅 http://www.robotstxt.org/orig.html。

class urllib.robotparser.RobotFileParser(url='')

这个类提供了一些可以读取、解析和回答关于 url 上的 robots.txt 文件的问题的方法。

set_url(url)

设置指向 robots.txt 文件的 URL。

read()

读取 robots.txt URL 并将其输入解析器。

parse(lines)

解析行参数。

can_fetch(useragent, url)

如果允许 useragent 按照被解析 robots.txt 文件中的规则来获取 url 则返回 True。

mtime()

返回最近一次获取 robots.txt 文件的时间。 这适用于需要定期检查 robots.txt 文件更新情况的长时间运行的网页爬虫。

modified()

将最近一次获取 robots.txt 文件的时间设置为当前时间。

crawl_delay(useragent)

为指定的 useragent 从 robots.txt 返回 Crawl-delay 形参。 如果此形参不存在或不适用于指定的 useragent 或者此形参的 robots.txt 条目存在语法错误，则返回 None。

3.6 新版功能.

request_rate(useragent)

以 named tuple RequestRate(requests, seconds) 的形式从 robots.txt 返回 Request-rate 形参的内容。 如果此形参不存在或不适用于指定的 useragent 或者此形参的 robots.txt 条目存在语法错误，则返回 None。

3.6 新版功能.

site_maps()

以 list() 的形式从 robots.txt 返回 Sitemap 形参的内容。 如果此形参不存在或者此形参的 robots.txt 条目存在语法错误，则返回 None。

3.8 新版功能.

下面的例子演示了 RobotFileParser 类的基本用法:

>>> import urllib.robotparser
>>> rp = urllib.robotparser.RobotFileParser()
>>> rp.set_url("http://www.musi-cal.com/robots.txt")
>>> rp.read()
>>> rrate = rp.request_rate("*")
>>> rrate.requests
3
>>> rrate.seconds
20
>>> rp.crawl_delay("*")
6
>>> rp.can_fetch("*", "http://www.musi-cal.com/cgi-bin/search?city=San+Francisco")
False
>>> rp.can_fetch("*", "http://www.musi-cal.com/")
True

http --- HTTP 模块

源代码: Lib/http/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/http/__init__.py]

http 是一个包，它收集了多个用于处理超文本传输协议的模块:

http.client 是一个底层的 HTTP 协议客户端；对于高层级的 URL 访问请使用 urllib.request

http.server 包含基于 socketserver 的基本 HTTP 服务类

http.cookies 包含一些有用来实现通过 cookies 进行状态管理的工具

http.cookiejar 提供了 cookies 的持久化

http 也是一个通过 http.HTTPStatus 枚举定义了一些 HTTP 状态码以及相关联消息的模块

class http.HTTPStatus

3.5 新版功能.

enum.IntEnum 的子类，它定义了组 HTTP 状态码，原理短语以及用英语书写的长描述文本。

用法：

>>> from http import HTTPStatus
>>> HTTPStatus.OK
<HTTPStatus.OK: 200>
>>> HTTPStatus.OK == 200
True
>>> HTTPStatus.OK.value
200
>>> HTTPStatus.OK.phrase
'OK'
>>> HTTPStatus.OK.description
'Request fulfilled, document follows'
>>> list(HTTPStatus)
[<HTTPStatus.CONTINUE: 100>, <HTTPStatus.SWITCHING_PROTOCOLS:101>, ...]

HTTP 状态码

已支持并且已在 http.HTTPStatus IANA 注册 [https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml] 的状态码有：

双字母代码 | 映射名 | 详情
100 | CONTINUE：继续 | HTTP/1.1 RFC 7231 [https://datatracker.ietf.org/doc/html/rfc7231.html], 6.2.1 节
101 | SWITCHING_PROTOCOLS | HTTP/1.1 RFC 7231, 6.2.2 节
102 | PROCESSING | WebDAV RFC 2518, 10.1 节
103 | EARLY_HINTS | 用于指定提示 RFC 8297 [https://datatracker.ietf.org/doc/html/rfc8297.html] 的 HTTP 状态码
200 | OK | HTTP/1.1 RFC 7231, 6.3.1 节
201 | CREATED | HTTP/1.1 RFC 7231, 6.3.2 节
202 | ACCEPTED | HTTP/1.1 RFC 7231, 6.3.3 节
203 | NON_AUTHORITATIVE_INFORMATION | HTTP/1.1 RFC 7231, 6.3.4 节
204 | NO_CONTENT: 没有内容 | HTTP/1.1 RFC 7231, 6.3.5 节
205 | RESET_CONTENT | HTTP/1.1 RFC 7231, 6.3.6 节
206 | PARTIAL_CONTENT | HTTP/1.1 RFC 7233, 4.1 节
207 | MULTI_STATUS | WebDAV RFC 4918, 11.1 节
208 | ALREADY_REPORTED | WebDAV Binding Extensions RFC 5842, 7.1 节（实验性）
226 | IM_USED | Delta Encoding in HTTP RFC 3229, 10.4.1 节
300 | MULTIPLE_CHOICES：有多种资源可选择 | HTTP/1.1 RFC 7231, 6.4.1 节
301 | MOVED_PERMANENTLY：永久移动 | HTTP/1.1 RFC 7231, 6.4.2 节
302 | FOUND：临时移动 | HTTP/1.1 RFC 7231, 6.4.3 节
303 | SEE_OTHER：已经移动 | HTTP/1.1 RFC 7231, 6.4.4 节
304 | NOT_MODIFIED：没有修改 | HTTP/1.1 RFC 7232, 4.1 节
305 | USE_PROXY：使用代理 | HTTP/1.1 RFC 7231, 6.4.5 节
307 | TEMPORARY_REDIRECT：临时重定向 | HTTP/1.1 RFC 7231 [https://datatracker.ietf.org/doc/html/rfc7231.html], 6.4.7 节
308 | PERMANENT_REDIRECT：永久重定向 | Permanent Redirect RFC 7238 [https://datatracker.ietf.org/doc/html/rfc7238.html], Section 3 (Experimental)
400 | BAD_REQUEST：错误请求 | HTTP/1.1 RFC 7231, 6.5.1 节
401 | UNAUTHORIZED：未授权 | HTTP/1.1 Authentication RFC 7235, 3.1 节
402 | PAYMENT_REQUIRED：保留，将来使用 | HTTP/1.1 RFC 7231, 6.5.2 节
403 | FORBIDDEN：禁止 | HTTP/1.1 RFC 7231, 6.5.3 节
404 | NOT_FOUND：没有找到 | HTTP/1.1 RFC 7231, 6.5.4 节
405 | METHOD_NOT_ALLOWED：该请求方法不允许 | HTTP/1.1 RFC 7231, 6.5.5 节
406 | NOT_ACCEPTABLE：不可接受 | HTTP/1.1 RFC 7231, 6.5.6 节
407 | PROXY_AUTHENTICATION_REQUIRED：要求使用代理验明正身 | HTTP/1.1 Authentication RFC 7235, 3.1 节
408 | REQUEST_TIMEOUT：请求超时 | HTTP/1.1 RFC 7231 [https://datatracker.ietf.org/doc/html/rfc7231.html], 6.5.7 节
409 | CONFLICT：冲突 | HTTP/1.1 RFC 7231, 6.5.8 节
410 | GONE：已经不在了 | HTTP/1.1 RFC 7231, 6.5.9 节
411 | LENGTH_REQUIRED：长度要求 | HTTP/1.1 RFC 7231, 6.5.10 节
412 | PRECONDITION_FAILED：前提条件错误 | HTTP/1.1 RFC 7232, 4.2 节
413 | REQUEST_ENTITY_TOO_LARGE：请求体太大了 | HTTP/1.1 RFC 7231, 6.5.11 节
414 | REQUEST_URI_TOO_LONG：请求URI太长了 | HTTP/1.1 RFC 7231, 6.5.12 节
415 | UNSUPPORTED_MEDIA_TYPE：不支持的媒体格式 | HTTP/1.1 RFC 7231, 6.5.13 节
416 | REQUESTED_RANGE_NOT_SATISFIABLE | HTTP/1.1 Range Requests RFC 7233, 4.4 节
417 | EXPECTATION_FAILED：期望失败 | HTTP/1.1 RFC 7231, 6.5.14 节
418 | IM_A_TEAPOT | HTCPCP/1.0 RFC 2324 [https://datatracker.ietf.org/doc/html/rfc2324.html], Section 2.3.2
421 | MISDIRECTED_REQUEST | HTTP/2 RFC 7540 [https://datatracker.ietf.org/doc/html/rfc7540.html], 9.1.2 节
422 | UNPROCESSABLE_ENTITY：可加工实体 | WebDAV RFC 4918, 11.2 节
423 | LOCKED：锁着 | WebDAV RFC 4918, 11.3 节
424 | FAILED_DEPENDENCY：失败的依赖 | WebDAV RFC 4918, 11.4 节
425 | TOO_EARLY | 使用 HTTP RFC 8470 [https://datatracker.ietf.org/doc/html/rfc8470.html] 中的早期数据
426 | UPGRADE_REQUIRED：升级需要 | HTTP/1.1 RFC 7231, 6.5.15 节
428 | PRECONDITION_REQUIRED：先决条件要求 | Additional HTTP Status Codes RFC 6585
429 | TOO_MANY_REQUESTS：太多的请求 | Additional HTTP Status Codes RFC 6585
431 | REQUEST_HEADER_FIELDS_TOO_LARGE：请求头太大 | Additional HTTP Status Codes RFC 6585
451 | UNAVAILABLE_FOR_LEGAL_REASONS | HTTP 状态码用于报告法律障碍 RFC 7725 [https://datatracker.ietf.org/doc/html/rfc7725.html]
500 | INTERNAL_SERVER_ERROR：内部服务错误 | HTTP/1.1 RFC 7231, 6.6.1 节
501 | NOT_IMPLEMENTED：不可执行 | HTTP/1.1 RFC 7231, 6.6.2 节
502 | BAD_GATEWAY：无效网关 | HTTP/1.1 RFC 7231, 6.6.3 节
503 | SERVICE_UNAVAILABLE：服务不可用 | HTTP/1.1 RFC 7231, 6.6.4 节
504 | GATEWAY_TIMEOUT：网关超时 | HTTP/1.1 RFC 7231, 6.6.5 节
505 | HTTP_VERSION_NOT_SUPPORTED：HTTP版本不支持 | HTTP/1.1 RFC 7231, 6.6.6 节
506 | VARIANT_ALSO_NEGOTIATES：服务器存在内部配置错误 | 透明内容协商在： HTTP RFC 2295 [https://datatracker.ietf.org/doc/html/rfc2295.html], 8.1 节（实验性）
507 | INSUFFICIENT_STORAGE：存储不足 | WebDAV RFC 4918, 11.5 节
508 | LOOP_DETECTED：循环检测 | WebDAV Binding Extensions RFC 5842, 7.2 节（实验性）
510 | NOT_EXTENDED：不扩展 | WebDAV Binding Extensions RFC 5842, 7.2 节（实验性）
511 | NETWORK_AUTHENTICATION_REQUIRED：要求网络身份验证 | Additional HTTP Status Codes RFC 6585 [https://datatracker.ietf.org/doc/html/rfc6585.html], 6 节

为了保持向后兼容性，枚举值也以常量形式出现在 http.client 模块中，。 枚举名等于常量名 (例如 http.HTTPStatus.OK 也可以是 http.client.OK)。

在 3.7 版更改: 添加了 421 MISDIRECTED_REQUEST 状态码。

3.8 新版功能: 添加了 451 UNAVAILABLE_FOR_LEGAL_REASONS 状态码。

3.9 新版功能: 增加了 103 EARLY_HINTS, 418 IM_A_TEAPOT 和 425 TOO_EARLY 状态码

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

源代码： Lib/http/client.py [https://github.com/python/cpython/tree/3.10/Lib/http/client.py]

这个模块定义了实现 HTTP 和 HTTPS 协议客户端的类。 它通常不直接使用 --- 模块 urllib.request 会用它来处理使用 HTTP 和 HTTPS 的 URL。

参见

对于更高级别的 HTTP 客户端接口，建议使用 Requests [https://requests.readthedocs.io/en/master/] 。

注解

HTTPS 支持仅在编译 Python 时启用了 SSL 支持的情况下（通过 ssl 模块）可用。

该模块支持以下类：

class http.client.HTTPConnection(host, port=None, [timeout, ]source_address=None, blocksize=8192)

HTTPConnection 的实例代表与 HTTP 服务器的一个连接事务。 它在实例化时应当传入一个主机和可选的端口号。 若未传入端口号，则如果主机字符串的形式为 host:port 则会从中提取端口，否则将使用默认的 HTTP 端口（80）。 如果给出了可选的 timeout 形参，则阻塞操作（如连接尝试）将在指定的秒数之后超时（如果未给出，则使用全局默认超时设置）。 可选的 source_address 形参可以是一个 (host, port) 元组，用作进行 HTTP 连接的源地址。 可选的 blocksize 形参以字节为单位设置缓冲区的大小，用来发送文件类消息体。

举个例子，以下调用都是创建连接到同一主机和端口的服务器的实例：

>>> 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)

在 3.2 版更改: 添加了*source_address* 参数

在 3.4 版更改: 移除了 strict 形参。 不再支持 HTTP 0.9 风格的“简单响应”。

在 3.7 版更改: 添加了 blocksize 参数。

class http.client.HTTPSConnection(host, port=None, key_file=None, cert_file=None, [timeout, ]source_address=None, *, context=None, check_hostname=None, blocksize=8192)

HTTPConnection 的子类，使用 SSL 与安全服务器进行通信。 默认端口为 443。 如果指定了 context，它必须为一个描述 SSL 各选项的 ssl.SSLContext 实例。

请参阅 安全考量 了解有关最佳实践的更多信息。

在 3.2 版更改: 添加了 source_address, context 和 check_hostname。

在 3.2 版更改: 这个类目前会在可能的情况下（即如果 ssl.HAS_SNI 为真值）支持 HTTPS 虚拟主机。

在 3.4 版更改: 删除了 strict 参数，不再支持 HTTP 0.9 风格的“简单响应”。

在 3.4.3 版更改: 目前这个类在默认情况下会执行所有必要的证书和主机检查。 要回复到先前的非验证行为，可以将 ssl._create_unverified_context() 传递给 context 参数。

在 3.8 版更改: 该类现在对于默认的 context 或在传入 cert_file 并附带自定义 context 时会启用 TLS 1.3 ssl.SSLContext.post_handshake_auth。

在 3.10 版更改: 现在，若未给出 context，则会发送一个带有协议指示器 http/1.1 的ALPN 扩展。自定义 context 应用 set_alpn_protocol() 设置 ALPN 协议。

3.6 版后已移除: key_file 和 cert_file 已弃用并转而推荐 context。 请改用 ssl.SSLContext.load_cert_chain() 或让 ssl.create_default_context() 为你选择系统所信任的 CA 证书。

check_hostname 参数也已弃用；应当改用 context 的 ssl.SSLContext.check_hostname 属性。

class http.client.HTTPResponse(sock, debuglevel=0, method=None, url=None)

在成功连接后返回类的实例，而不是由用户直接实例化。

在 3.4 版更改: 删除了 strict 参数，不再支持HTTP 0.9 风格的“简单响应”。

这个模块定义了以下函数：

http.client.parse_headers(fp)

从文件指针 fp 中解析头部信息，该文件代表 HTTP 请求/响应。该文件必须是 BufferedIOBase reader 对象（即不是文本），并且必须提供符合 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 格式的头部。

该函数返回 http.client.HTTPMessage 的实例，带有头部各个字段，但不带正文数据（与 HTTPResponse.msg 和 http.server.BaseHTTPRequestHandler.headers 一样）。返回之后，文件指针 fp 已为读取 HTTP 正文做好准备了。

注解

parse_headers() 不会解析 HTTP 消息的开始行；只会解析各 Name: value 行。文件必须为读取这些字段做好准备，所以在调用该函数之前，第一行应该已经被读取过了。

下列异常可以适当地被引发:

exception http.client.HTTPException

此模块中其他异常的基类。 它是 Exception 的一个子类。

exception http.client.NotConnected

HTTPException 的一个子类。

exception http.client.InvalidURL

HTTPException 的一个子类，如果给出了一个非数字或为空值的端口就会被引发。

exception http.client.UnknownProtocol

HTTPException 的一个子类。

exception http.client.UnknownTransferEncoding

HTTPException 的一个子类。

exception http.client.UnimplementedFileMode

HTTPException 的一个子类。

exception http.client.IncompleteRead

HTTPException 的一个子类。

exception http.client.ImproperConnectionState

HTTPException 的一个子类。

exception http.client.CannotSendRequest

ImproperConnectionState 的一个子类。

exception http.client.CannotSendHeader

ImproperConnectionState 的一个子类。

exception http.client.ResponseNotReady

ImproperConnectionState 的一个子类。

exception http.client.BadStatusLine

HTTPException 的一个子类。 如果服务器反馈了一个我们不理解的 HTTP 状态码就会被引发。

exception http.client.LineTooLong

HTTPException 的一个子类。 如果在 HTTP 协议中从服务器接收到过长的行就会被引发。

exception http.client.RemoteDisconnected

ConnectionResetError 和 BadStatusLine 的一个子类。 当尝试读取响应时的结果是未从连接读取到数据时由 HTTPConnection.getresponse() 引发，表明远端已关闭连接。

3.5 新版功能: 在此之前引发的异常为 BadStatusLine('')。

此模块中定义的常量为：

http.client.HTTP_PORT

HTTP 协议默认的端口号 (总是 80)。

http.client.HTTPS_PORT

HTTPS 协议默认的端口号 (总是 443)。

http.client.responses

这个字典把 HTTP 1.1 状态码映射到 W3C 名称。

例如：http.client.responses[http.client.NOT_FOUND] 是 'NOT FOUND （未发现）。

本模块中可用的 HTTP 状态码常量可以参见 HTTP 状态码 。

HTTPConnection 对象

HTTPConnection 实例拥有以下方法：

HTTPConnection.request(method, url, body=None, headers={}, *, encode_chunked=False)

这会使用 HTTP 请求方法 method 和选择器 url 向服务器发送请求。

如果给定 body，那么给定的数据会在信息头完成之后发送。它可能是一个 字符串，一个 bytes-like object，一个打开的 file object，或者 bytes 迭代器。如果 body 是字符串，它会按 HTTP 默认的 ISO-8859-1 编码。如果是一个字节类对象，它会按原样发送。如果是 file object，文件的内容会被发送，这个文件对象应该至少支持 read() 方法。如果这个文件对象是一个 io.TextIOBase 实例，由 read() 方法返回的数据会按 ISO-8859-1 编码，否则由 read() 方法返回的数据会按原样发送。如果 body 是一个迭代器，迭代器中的元素会被发送，直到迭代器耗尽。

headers 参数应是额外的随请求发送的 HTTP 信息头的字典。

如果 headers 既不包含 Content-Length 也没有 Transfer-Encoding，但存在请求正文，那么这些头字段中的一个会自动设定。如果 body 是 None，那么对于要求正文的方法 (PUT，POST，和 PATCH)，Content-Length 头会被设为 0。如果 body 是字符串或者类似字节的对象，并且也不是 文件，Content-Length 头会设为正文的长度。任何其他类型的 body （一般是文件或迭代器）会按块编码，这时会自动设定 Transfer-Encoding 头以代替 Content-Length。

在 headers 中指定 Transfer-Encoding 时， encode_chunked 是唯一相关的参数。如果 encode_chunked 为 False，HTTPConnection 对象会假定所有的编码都由调用代码处理。如果为 True，正文会按块编码。

注解

HTTP 协议在 1.1 版中添加了块传输编码。除非明确知道 HTTP 服务器可以处理 HTTP 1.1，调用者要么必须指定 Content-Length，要么必须传入 str 或字节类对象，注意该对象不能是表达 body 的文件。

3.2 新版功能: body 现在可以是可迭代对象了。

在 3.6 版更改: 如果 Content-Length 和 Transfer-Encoding 都没有在 headers 中设置，文件和可迭代的 body 对象现在会按块编码。添加了 encode_chunked 参数。不会尝试去确定文件对象的 Content-Length。

HTTPConnection.getresponse()

应当在发送一个请求从服务器获取响应时被调用。 返回一个 HTTPResponse 的实例。

注解

请注意你必须在读取了整个响应之后才能向服务器发送新的请求。

在 3.5 版更改: 如果引发了 ConnectionError 或其子类， HTTPConnection 对象将在发送新的请求时准备好重新连接。

HTTPConnection.set_debuglevel(level)

设置调试等级。 默认的调试等级为 0，意味着不会打印调试输出。 任何大于 0 的值将使得所有当前定义的调试输出被打印到 stdout。 debuglevel 会被传给任何新创建的 HTTPResponse 对象。

3.1 新版功能.

HTTPConnection.set_tunnel(host, port=None, headers=None)

为 HTTP 连接隧道设置主机和端口。 这将允许通过代理服务器运行连接。

host 和 port 参数指明隧道连接的位置（即 CONNECT 请求所包含的地址，而 不是 代理服务器的地址）。

headers 参数应为一个随 CONNECT 请求发送的额外 HTTP 标头的映射。

例如，要通过一个运行于本机 8080 端口的 HTTPS 代理服务器隧道，我们应当向 HTTPSConnection 构造器传入代理的地址，并将我们最终想要访问的主机地址传给 set_tunnel() 方法:

>>> import http.client
>>> conn = http.client.HTTPSConnection("localhost", 8080)
>>> conn.set_tunnel("www.python.org")
>>> conn.request("HEAD","/index.html")

3.2 新版功能.

HTTPConnection.connect()

当对象被创建后连接到指定的服务器。 默认情况下，如果客户端还未建立连接，此函数会在发送请求时自动被调用。

引发一个 审计事件 http.client.connect 并附带参数 self, host, port。

HTTPConnection.close()

关闭到服务器的连接。

HTTPConnection.blocksize

用于发送文件类消息体的缓冲区大小。

3.7 新版功能.

作为对使用上述 request() 方法的替代同，你也可以通过使用下面的四个函数，分步骤发送请的请求。

HTTPConnection.putrequest(method, url, skip_host=False, skip_accept_encoding=False)

应为连接服务器之后首先调用的函数。将向服务器发送一行数据，包含 method 字符串、url 字符串和 HTTP 版本（HTTP/1.1）。若要禁止自动发送 Host: 或 Accept-Encoding: 头部信息（比如需要接受其他编码格式的内容），请将 skip_host 或 skip_accept_encoding 设为非 False 值。

HTTPConnection.putheader(header, argument[, ...])

向服务器发送一个 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 格式的头部。将向服务器发送一行由头、冒号和空格以及第一个参数组成的数据。 如果还给出了其他参数，将在后续行中发送，每行由一个制表符和一个参数组成。

HTTPConnection.endheaders(message_body=None, *, encode_chunked=False)

向服务器发送一个空行，表示头部文件结束。可选的 message_body 参数可用于传入一个与请求相关的消息体。

如果 encode_chunked 为 True，则对 message_body 的每次迭代结果将依照 RFC 7230 [https://datatracker.ietf.org/doc/html/rfc7230.html] 3.3.1 节的规范进行分块编码。数据如何编码取决于 message_body 的类型。 如果 message_body 实现了 buffer 接口，编码将生成一个数据块。如果 message_body 是 collections.abc.Iterable，则 message_body 的每次迭代都会产生一个块。 如果 message_body 为 file object，那么每次调用 .read() 都会产生一个数据块。在 message_body 结束后，本方法立即会自动标记分块编码数据的结束。

注解

由于分块编码的规范要求，迭代器本身产生的空块将被分块编码器忽略。这是为了避免目标服务器因错误编码而过早终止对请求的读取。

3.6 新版功能: 支持分块编码。加入了 encode_chunked 参数。

HTTPConnection.send(data)

发送数据到服务器。本函数只应在调用 endheaders() 方法之后且调用 getresponse() 之前直接调用。

引发一个 审计事件 http.client.send 并附带参数 self, data。

HTTPResponse 对象

HTTPResponse 实例封装了来自服务器的 HTTP 响应。通过它可以访问请求头和响应体。响应是可迭代对象，可在 with 语句中使用。

在 3.5 版更改: 现在已实现了 io.BufferedIOBase 接口，并且支持所有的读取操作。

HTTPResponse.read([amt])

读取并返回响应体，或后续 amt 个字节。

HTTPResponse.readinto(b)

读取响应体的后续 len(b) 个字节到缓冲区 b。返回读取的字节数。

3.3 新版功能.

HTTPResponse.getheader(name, default=None)

返回标头 name 的值，或者如果没有匹配 name 的标头则返回 default。 如果名为 name 的标头不止一个，则返回以 ', ' 连接的所有值。 如果 default 是任何不为单个字符串的可迭代对象，则其元素同样会以逗号连接的形式返回。

HTTPResponse.getheaders()

返回 (header, value) 元组构成的列表。

HTTPResponse.fileno()

返回底层套接字的 fileno。

HTTPResponse.msg

包含响应头的 http.client.HTTPMessage 实例。http.client.HTTPMessage 是 email.message 的子类。

HTTPResponse.version

服务器采用的 HTTP 协议版本。10 代表 HTTP/1.0，11 代表 HTTP/1.1。

HTTPResponse.url

已读取资源的 URL，通常用于确定是否进行了重定向。

HTTPResponse.headers

响应的头部信息，形式为 email.message.EmailMessage 的实例。

HTTPResponse.status

由服务器返回的状态码。

HTTPResponse.reason

服务器返回的原因短语。

HTTPResponse.debuglevel

一个调试钩子。如果 debuglevel 大于零，状态信息将在读取和解析响应数据时打印输出到 stdout。

HTTPResponse.closed

如果流被关闭，则为 True。

HTTPResponse.geturl()

3.9 版后已移除: 已弃用，建议用 url。

HTTPResponse.info()

3.9 版后已移除: 已弃用，建议用 headers。

HTTPResponse.getcode()

3.9 版后已移除: 已弃用，建议用 status 。

例子

下面是使用 GET 方法的会话示例：

>>> 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()  # This will return entire content.
>>> # The following example demonstrates reading data in chunks.
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> while chunk := r1.read(200):
...     print(repr(chunk))
b'<!doctype html>\n<!--[if"...
...
>>> # Example of an invalid request
>>> 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()

以下是使用 HEAD 方法的会话示例。 请注意，HEAD 方法从不返回任何数据。

>>> 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''
True

下面是一个使用 POST 方法的会话示例:

>>> 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()

客户端 HTTP PUT 请求与 POST 请求非常相似。 区别仅在于服务器端 HTTP 服务器将允许通过 PUT 请求创建资源。 应该注意自定义的 HTTP 方法也可以在 urllib.request.Request 中通过设置适当的方法属性来进行处理。 下面是一个使用 PUT 方法的会话示例:

>>> # This creates an HTTP request
>>> # with the content of BODY as the enclosed representation
>>> # for the resource 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

HTTPMessage 对象

http.client.HTTPMessage 的实例存有 HTTP 响应的头部信息。利用 email.message.Message 类实现。

ftplib --- FTP 协议客户端

源代码： Lib/ftplib.py [https://github.com/python/cpython/tree/3.10/Lib/ftplib.py]

本模块定义了 FTP 类和一些相关项目。 FTP 类实现了 FTP 协议的客户端。 你可以用这个类来编写执行各种自动化 FTP 任务的 Python 程序，例如镜像其他 FTP 服务器等。 它还被 urllib.request 模块用来处理使用 FTP 的 URL。 有关 FTP (文件传输协议) 的更多信息，请参阅 RFC 959 [https://datatracker.ietf.org/doc/html/rfc959.html]。

默认编码为 UTF-8，遵循 RFC 2640 [https://datatracker.ietf.org/doc/html/rfc2640.html]。

以下是使用 ftplib 模块的会话示例:

>>> from ftplib import FTP
>>> ftp = FTP('ftp.us.debian.org')  # connect to host, default port
>>> ftp.login()                     # user anonymous, passwd anonymous@
'230 Login successful.'
>>> ftp.cwd('debian')               # change into "debian" directory
'250 Directory successfully changed.'
>>> ftp.retrlines('LIST')           # list directory contents
-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.'

这个模块定义了以下内容：

class ftplib.FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None, *, encoding='utf-8')

返回一个 FTP 类的新实例。当传入 host 时，将调用 connect(host) 方法。当传入 user 时，将额外调用 login(user, passwd, acct) 方法（其中 passwd 和 acct 若没有传入则默认为空字符串）。可选参数 timeout 指定阻塞操作（如连接尝试）的超时（以秒为单位，如果未指定超时，将使用全局默认超时设置）。source_address 是一个 2 元组 (host, port)，套接字在连接前绑定它，作为其源地址。encoding 参数指定目录和文件名的编码。

FTP 类支持 with 语句，例如：

>>> 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
>>>

在 3.2 版更改: 添加了对 with 语句的支持。

在 3.3 版更改: 添加了 source_address 参数。

在 3.9 版更改: 如果 timeout 参数设置为 0，创建非阻塞套接字时，它将引发 ValueError 来阻止该操作。添加了 encoding 参数，且为了遵循 RFC 2640 [https://datatracker.ietf.org/doc/html/rfc2640.html]，该参数默认值从 Latin-1 改为了 UTF-8。

class ftplib.FTP_TLS(host='', user='', passwd='', acct='', keyfile=None, certfile=None, context=None, timeout=None, source_address=None, *, encoding='utf-8')

一个 FTP 的子类，它为 FTP 添加了 TLS 支持，如 RFC 4217 [https://datatracker.ietf.org/doc/html/rfc4217.html] 所述。它将像通常一样连接到 21 端口，暗中保护在身份验证前的 FTP 控制连接。而保护数据连接需要用户明确调用 prot_p() 方法。context 是一个 ssl.SSLContext 对象，该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的（可以长久存在的）结构中。请阅读 安全考量 以获取最佳实践。

keyfile 和 certfile 是可以代替 context 的传统方案，它们可以分别指向 PEM 格式的私钥和证书链文件，用于进行 SSL 连接。

3.2 新版功能.

在 3.3 版更改: 添加了 source_address 参数。

在 3.4 版更改: 本类现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 （参阅 ssl.HAS_SNI）进行主机名检查。

3.6 版后已移除: keyfile 和 certfile 已弃用并转而推荐 context。 请改用 ssl.SSLContext.load_cert_chain() 或让 ssl.create_default_context() 为你选择系统所信任的 CA 证书。

在 3.9 版更改: 如果 timeout 参数设置为 0，创建非阻塞套接字时，它将引发 ValueError 来阻止该操作。添加了 encoding 参数，且为了遵循 RFC 2640 [https://datatracker.ietf.org/doc/html/rfc2640.html]，该参数默认值从 Latin-1 改为了 UTF-8。

以下是使用 FTP_TLS 类的会话示例:

>>> 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']

exception ftplib.error_reply

从服务器收到意外答复时，将引发本异常。

exception ftplib.error_temp

收到表示临时错误的错误代码（响应代码在 400--499 范围内）时，将引发本异常。

exception ftplib.error_perm

收到表示永久性错误的错误代码（响应代码在 500--599 范围内）时，将引发本异常。

exception ftplib.error_proto

从服务器收到不符合 FTP 响应规范的答复，比如以数字 1--5 开头时，将引发本异常。

ftplib.all_errors

所有异常的集合（一个元组），由于 FTP 连接出现问题（并非调用者的编码错误），FTP 实例的方法可能会引发这些异常。该集合包括上面列出的四个异常以及 OSError 和 EOFError。

参见

netrc 模块

.netrc 文件格式解析器。FTP 客户端在响应用户之前，通常使用 .netrc 文件来加载用户认证信息。

FTP 对象

一些方法可以按照两种方式来使用：一种处理文本文件，另一种处理二进制文件。方法名称与相应的命令相同，文本版中命令后面跟着 lines，二进制版中命令后面跟着 binary。

FTP 实例具有下列方法:

FTP.set_debuglevel(level)

设置实例的调试级别，它控制着调试信息的数量。默认值 0 不产生调试信息。值 1 产生中等数量的调试信息，通常每个请求产生一行。大于或等于 2 的值产生的调试信息最多，FTP 控制连接上发送和接收的每一行都将被记录下来。

FTP.connect(host='', port=0, timeout=None, source_address=None)

连接到给定的主机和端口。默认端口号由 FTP 协议规范规定，为 21。偶尔才需要指定其他端口号。每个实例只应调用一次本函数，如果在创建实例时就传入了 host，则根本不应调用它。所有其他方法只能在建立连接后使用。可选参数 timeout 指定连接尝试的超时（以秒为单位）。如果没有传入 timeout，将使用全局默认超时设置。source_address 是一个 2 元组 (host, port)，套接字在连接前绑定它，作为其源地址。

引发一个 审计事件 ftplib.connect 并附带参数 self, host, port。

在 3.3 版更改: 添加了 source_address 参数。

FTP.getwelcome()

返回服务器发送的欢迎消息，作为连接开始的回复。（该消息有时包含与用户有关的免责声明或帮助信息。）

FTP.login(user='anonymous', passwd='', acct='')

以 user 的身份登录。passwd 和 acct 是可选参数，默认为空字符串。如果没有指定 user，则默认为 'anonymous'。如果 user 为 'anonymous'，那么默认的 passwd 是 'anonymous@'。连接建立后，每个实例只应调用一次本函数；如果在创建实例时传入了 host 和 user，则完全不应该调用本函数。在客户端登录后，才允许执行大多数 FTP 命令。acct 参数提供记账信息 ("accounting information")；仅少数系统实现了该特性。

FTP.abort()

中止正在进行的文件传输。本方法并不总是有效，但值得一试。

FTP.sendcmd(cmd)

将一条简单的命令字符串发送到服务器，返回响应的字符串。

引发一个 审计事件 ftplib.sendcmd 并附带参数 self, cmd。

FTP.voidcmd(cmd)

将一条简单的命令字符串发送到服务器，并处理响应内容。如果收到的响应代码表示的是成功（代码范围 200--299），则不返回任何内容。否则将引发 error_reply。

引发一个 审计事件 ftplib.sendcmd 并附带参数 self, cmd。

FTP.retrbinary(cmd, callback, blocksize=8192, rest=None)

以二进制传输模式下载文件。cmd 应为恰当的 RETR 命令：'RETR 文件名'。callback 函数会在收到每个数据块时调用，传入的参数是表示数据块的一个字节。为执行实际传输，创建了底层套接字对象，可选参数 blocksize 指定了读取该对象时的最大块大小（这也是传入 callback 的数据块的最大大小）。已经选择了合理的默认值。rest 的含义与 transfercmd() 方法中的含义相同。

FTP.retrlines(cmd, callback=None)

按照初始化时的 encoding 参数指定的编码，获取文件或目录列表。cmd 应是恰当的 RETR 命令（参阅 retrbinary()），也可以是诸如 LIST 或 NLST 之类的命令（通常就只是字符串 'LIST'）。LIST 获取文件列表以及那些文件的信息。NLST 获取文件名称列表。callback 函数会在每一行都调用，参数就是包含一行的字符串，删除了尾部的 CRLF。默认的 callback 会把行打印到 sys.stdout。

FTP.set_pasv(val)

如果 val 为 true，则打开“被动”模式，否则禁用被动模式。默认下被动模式是打开的。

FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None)

以二进制传输模式存储文件。 cmd 应为恰当的 STOR 命令: "STOR filename"。fp 是一个 文件对象 (以二进制模式打开)，将使用它的 read() 方法读取它，用于提供要存储的数据，直到遇到 EOF，读取时的块大小为 blocksize。 参数 blocksize 的默认值为 8192。 可选参数 callback 是单参数函数，在每个数据块发送后都会以该数据块作为参数来调用它。rest 的含义与 transfercmd() 方法中的含义相同。

在 3.2 版更改: 添加了 rest 参数。

FTP.storlines(cmd, fp, callback=None)

以文本行模式存储文件。cmd 应为恰当的 STOR 命令 (请参阅 storbinary())。 fp 是一个 文件对象 (以二进制模式打开)，将使用它的 readline() 方法读取它的每一行，用于提供要存储的数据，直到遇到 EOF。 可选参数 callback 是单参数函数，在每行发送后都会以该行作为参数来调用它。

FTP.transfercmd(cmd, rest=None)

在 FTP 数据连接上开始传输数据。如果传输处于活动状态，传输命令由 cmd 指定，需发送 EPRT 或 PORT 命令，然后接受连接 (accept)。如果服务器是被动服务器，需发送 EPSV 或 PASV 命令，连接到服务器 (connect)，然后启动传输命令。两种方式都将返回用于连接的套接字。

如果传入了可选参数 rest，则一条 REST 命令会被发送到服务器，并以 rest 作为参数。rest 通常表示请求文件中的字节偏移量，它告诉服务器重新开始发送文件的字节，从请求的偏移量处开始，跳过起始字节。但是请注意，transfercmd() 方法会将 rest 转换为字符串，但是不检查字符串的内容，转换用的编码是在初始化时指定的 encoding 参数。如果服务器无法识别 REST 命令，将引发 error_reply 异常。如果发生这种情况，只需不带 rest 参数调用 transfercmd()。

FTP.ntransfercmd(cmd, rest=None)

类似于 transfercmd()，但返回一个元组，包括数据连接和数据的预计大小。如果预计大小无法计算，则返回的预计大小为 None。cmd 和 rest 的含义与 transfercmd() 中的相同。

FTP.mlsd(path='', facts=[])

使用 MLSD 命令以标准格式列出目录内容 (RFC 3659 [https://datatracker.ietf.org/doc/html/rfc3659.html])。如果省略 path 则使用当前目录。facts 是字符串列表，表示所需的信息类型（如 ["type", "size", "perm"]）。返回一个生成器对象，每个在 path 中找到的文件都将在该对象中生成两个元素的元组。第一个元素是文件名，第二个元素是该文件的 facts 的字典。该字典的内容受 facts 参数限制，但不能保证服务器会返回所有请求的 facts。

3.3 新版功能.

FTP.nlst(argument[, ...])

返回一个文件名列表，文件名由 NLST 命令返回。可选参数 argument 是待列出的目录（默认为当前服务器目录）。可以使用多个参数，将非标准选项传递给 NLST 命令。

注解

如果目标服务器支持相关命令，那么 mlsd() 提供的 API 更好。

FTP.dir(argument[, ...])

生成目录列表，即 LIST 命令所返回的结果，并将其打印到标准输出。可选参数 argument 是待列出的目录（默认为当前服务器目录）。可以使用多个参数，将非标准选项传递给 LIST 命令。如果最后一个参数是一个函数，它将被用作 callback 函数，与 retrlines() 中的相同，默认将打印到 sys.stdout。本方法返回 None。

注解

如果目标服务器支持相关命令，那么 mlsd() 提供的 API 更好。

FTP.rename(fromname, toname)

将服务器上的文件 fromname 重命名为 toname。

FTP.delete(filename)

将服务器上名为 filename 的文件删除。如果删除成功，返回响应文本，如果删除失败，在权限错误时引发 error_perm，在其他错误时引发 error_reply。

FTP.cwd(pathname)

设置服务器端的当前目录。

FTP.mkd(pathname)

在服务器上创建一个新目录。

FTP.pwd()

返回服务器上当前目录的路径。

FTP.rmd(dirname)

将服务器上名为 dirname 的目录删除。

FTP.size(filename)

请求服务器上名为 filename 的文件大小。成功后以整数返回文件大小，未成功则返回 None。注意，SIZE 不是标准命令，但通常许多服务器的实现都支持该命令。

FTP.quit()

向服务器发送 QUIT 命令并关闭连接。 这是关闭一个连接的“礼貌”方式，但是如果服务器对 QUIT 命令的响应带有错误消息则这会引发一个异常。 这意味着对 close() 方法的调用，它将使得 FTP 实例对后继调用无效（见下文）。

FTP.close()

单方面关闭连接。 这不该被应用于已经关闭的连接，例如成功调用 quit() 之后的连接。 在此调用之后 FTP 实例不应被继续使用（在调用 close() 或 quit() 之后你不能通过再次唤起 login() 方法重新打开连接）。

FTP_TLS 对象

FTP_TLS 类继承自 FTP，它定义了下述其他对象：

FTP_TLS.ssl_version

欲采用的 SSL 版本（默认为 ssl.PROTOCOL_SSLv23）。

FTP_TLS.auth()

通过使用 TLS 或 SSL 来设置一个安全控制连接，具体取决于 ssl_version 属性是如何设置的。

在 3.4 版更改: 此方法现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 (参见 ssl.HAS_SNI) 进行主机名检查。

FTP_TLS.ccc()

将控制通道回复为纯文本。 这适用于发挥知道如何使用非安全 FTP 处理 NAT 而无需打开固定端口的防火墙的优势。

3.3 新版功能.

FTP_TLS.prot_p()

设置加密数据连接。

FTP_TLS.prot_c()

设置明文数据连接。

poplib --- POP3 协议客户端

源代码： Lib/poplib.py [https://github.com/python/cpython/tree/3.10/Lib/poplib.py]

本模块定义了一个 POP3 类，该类封装了到 POP3 服务器的连接过程，并实现了 RFC 1939 [https://datatracker.ietf.org/doc/html/rfc1939.html] 中定义的协议。POP3 类同时支持 RFC 1939 [https://datatracker.ietf.org/doc/html/rfc1939.html] 中最小的和可选的命令集。POP3 类还支持在 RFC 2595 [https://datatracker.ietf.org/doc/html/rfc2595.html] 中引入的 STLS 命令，用于在已建立的连接上启用加密通信。

本模块额外提供一个 POP3_SSL 类，在连接到 POP3 服务器时，该类为使用 SSL 作为底层协议层提供了支持。

注意，尽管 POP3 具有广泛的支持，但它已经过时。POP3 服务器的实现质量差异很大，而且大多很糟糕。如果邮件服务器支持 IMAP，则最好使用 imaplib.IMAP4 类，因为 IMAP 服务器一般实现得更好。

poplib 模块提供了两个类：

class poplib.POP3(host, port=POP3_PORT[, timeout])

本类实现实际的 POP3 协议。实例初始化时，连接就会建立。如果省略 port，则使用标准 POP3 端口（110）。可选参数 timeout 指定连接尝试的超时时间（以秒为单位，如果未指定超时，将使用全局默认超时设置）。

引发一个 审计事件 poplib.connect 并附带参数 self, host, port。

引发一个 审计事件 poplib.putline，附带参数 self, line。

在 3.9 版更改: 如果 timeout 参数设置为 0，创建非阻塞套接字时，它将引发 ValueError 来阻止该操作。

class poplib.POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)

一个 POP3 的子类，它使用经 SSL 加密的套接字连接到服务器。如果端口 port 未指定，则使用 995，它是标准的 POP3-over-SSL 端口。timeout 的作用与 POP3 构造函数中的相同。context 是一个可选的 ssl.SSLContext 对象，该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的（可以长久存在的）结构中。请阅读 安全考量 以获取最佳实践。

keyfile 和 certfile 是可以代替 context 的传统方案，它们可以分别指向 PEM 格式的私钥和证书链文件，用于进行 SSL 连接。

引发一个 审计事件 poplib.connect 并附带参数 self, host, port。

引发一个 审计事件 poplib.putline，附带参数 self, line。

在 3.2 版更改: 添加了 context 参数。

在 3.4 版更改: 本类现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 （参阅 ssl.HAS_SNI）进行主机名检查。

3.6 版后已移除: keyfile 和 certfile 已弃用并转而推荐 context。 请改用 ssl.SSLContext.load_cert_chain() 或让 ssl.create_default_context() 为你选择系统所信任的 CA 证书。

在 3.9 版更改: 如果 timeout 参数设置为 0，创建非阻塞套接字时，它将引发 ValueError 来阻止该操作。

定义了一个异常，它是作为 poplib 模块的属性定义的：

exception poplib.error_proto

此模块的所有错误都将引发本异常（来自 socket 模块的错误不会被捕获）。异常的原因将以字符串的形式传递给构造函数。

参见

imaplib 模块

标准的 Python IMAP 模块。

有关 Fetchmail 的常见问题 [http://www.catb.org/~esr/fetchmail/fetchmail-FAQ.html]

fetchmail POP/IMAP 客户端的“常见问题”收集了 POP3 服务器之间的差异和 RFC 不兼容的信息，如果要编写基于 POP 协议的应用程序，这可能会很有用。

POP3 对象

所有 POP3 命令均以同名的方法表示，小写，大多数方法返回的是服务器发送的响应文本。

POP3 实例具有下列方法：

POP3.set_debuglevel(level)

设置实例的调试级别，它控制着调试信息的数量。默认值 0 不产生调试信息。值 1 产生中等数量的调试信息，通常每个请求产生一行。大于或等于 2 的值产生的调试信息最多，FTP 控制连接上发送和接收的每一行都将被记录下来。

POP3.getwelcome()

返回 POP3 服务器发送的问候语字符串。

POP3.capa()

查询服务器支持的功能，这些功能在 RFC 2449 [https://datatracker.ietf.org/doc/html/rfc2449.html] 中有说明。返回一个 {'name': ['param'...]} 形式的字典。

3.4 新版功能.

POP3.user(username)

发送 user 命令，返回的响应应该指示需要一个密码。

POP3.pass_(password)

发送密码，响应包括邮件数和邮箱大小。注意：在调用 quit() 前，服务器上的邮箱都是锁定的。

POP3.apop(user, secret)

使用更安全的 APOP 身份验证登录到 POP3 服务器。

POP3.rpop(user)

使用 RPOP 身份验证（类似于 Unix r-命令）登录到 POP3 服务器。

POP3.stat()

获取邮箱状态。结果为 2 个整数组成的元组：(message count, mailbox size)。

POP3.list([which])

请求消息列表，结果的形式为 (response, ['mesg_num octets', ...], octets)。如果设置了 which，它表示需要列出的消息。

POP3.retr(which)

检索编号为 which 的整条消息，并设置其已读标志位。结果的形式为 (response, ['line', ...], octets)。

POP3.dele(which)

将编号为 which 的消息标记为待删除。在多数服务器上，删除操作直到 QUIT 才会实际执行（主要例外是 Eudora QPOP，它在断开连接时执行删除，故意违反了 RFC）。

POP3.rset()

移除邮箱中的所有待删除标记。

POP3.noop()

什么都不做。可以用于保持活动状态。

POP3.quit()

登出：提交更改，解除邮箱锁定，断开连接。

POP3.top(which, howmuch)

检索编号为 which 的消息，范围是消息头加上消息头往后数 howmuch 行。结果的形式为 (response, ['line', ...], octets)。

本方法使用 POP3 TOP 命令，不同于 RETR 命令，它不设置邮件的已读标志位。不幸的是，TOP 在 RFC 中说明不清晰，且在小众的服务器软件中往往不可用。信任并使用它之前，请先手动对目标 POP3 服务器测试本方法。

POP3.uidl(which=None)

返回消息摘要（唯一 ID）列表。如果指定了 which，那么结果将包含那条消息的唯一 ID，形式为 'response mesgnum uid，如果未指定，那么结果为列表 (response, ['mesgnum uid', ...], octets)。

POP3.utf8()

尝试切换至 UTF-8 模式。成功则返回服务器的响应，失败则引发 error_proto 异常。在 RFC 6856 [https://datatracker.ietf.org/doc/html/rfc6856.html] 中有说明。

3.5 新版功能.

POP3.stls(context=None)

在活动连接上开启 TLS 会话，在 RFC 2595 [https://datatracker.ietf.org/doc/html/rfc2595.html] 中有说明。仅在用户身份验证前允许这样做。

context 参数是一个 ssl.SSLContext 对象，该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的（可以长久存在的）结构中。请阅读 安全考量 以获取最佳实践。

此方法支持通过 ssl.SSLContext.check_hostname 和 服务器名称指示 (参见 ssl.HAS_SNI) 进行主机名检查。

3.4 新版功能.

POP3_SSL 实例没有额外方法。该子类的接口与其父类的相同。

POP3 示例

以下是一个最短示例（不带错误检查），该示例将打开邮箱，检索并打印所有消息:

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)

模块的最后有一段测试，其中包含的用法示例更加广泛。

imaplib --- IMAP4 协议客户端

源代码： Lib/imaplib.py [https://github.com/python/cpython/tree/3.10/Lib/imaplib.py]

本模块定义了三个类： IMAP4 、 IMAP4_SSL 和 IMAP4_stream 。这三个类封装了与IMAP4服务器的连接并实现了 RFC 2060 [https://datatracker.ietf.org/doc/html/rfc2060.html] 当中定义的大多数IMAP4rev1客户端协议。其与IMAP4（ RFC 1730 [https://datatracker.ietf.org/doc/html/rfc1730.html] ）服务器后向兼容，但是 STATUS 指令在IMAP4中不支持。

imaplib 模块提供了三个类，其中 IMAP4 是基类：

class imaplib.IMAP4(host='', port=IMAP4_PORT, timeout=None)

这个类实现了实际的 IMAP4 协议。 当其实例被实例化时会创建连接并确定协议版本 (IMAP4 或 IMAP4rev1)。 如果未指明 host，则会使用 '' (本地主机)。 如果省略 port，则会使用标准 IMAP4 端口 (143)。 可选的 timeout 形参指定连接尝试的超时秒数。 如果未指定超时或为 None，则会使用全局默认的套接字超时。

IMAP4 类支持 with 语句。 当这样使用时，IMAP4 LOGOUT 命令会在 with 语句退出时自动发出。 例如:

>>> from imaplib import IMAP4
>>> with IMAP4("domain.org") as M:
...     M.noop()
...
('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])

在 3.5 版更改: 添加了对 with 语句的支持。

在 3.9 版更改: 添加了可选的 timeout 形参。

有三个异常被定义为 IMAP4 类的属性:

exception IMAP4.error

任何错误都将引发该异常。 异常的原因会以字符串的形式传递给构造器。

exception IMAP4.abort

IMAP4 服务器错误会导致引发该异常。 这是 IMAP4.error 的子类。 请注意关闭此实例并实例化一个新实例通常将会允许从该异常中恢复。

exception IMAP4.readonly

当一个可写邮箱的状态被服务器修改时会引发此异常。 此异常是 IMAP4.error 的子类。 某个其他客户端现在会具有写入权限，将需要重新打开该邮箱以重新获得写入权限。

另外还有一个针对安全连接的子类:

class imaplib.IMAP4_SSL(host='', port=IMAP4_SSL_PORT, keyfile=None, certfile=None, ssl_context=None, timeout=None)

这是一个派生自 IMAP4 的子类，它使用经 SSL 加密的套接字进行连接 (为了使用这个类你需要编译时附带 SSL 支持的 socket 模块)。 如果未指定 host，则会使用 '' (本地主机)。 如果省略了 port，则会使用标准的 IMAP4-over-SSL 端口 (993)。 ssl_context 是一个 ssl.SSLContext 对象，它允许将 SSL 配置选项、证书和私钥打包放入一个单独的 (可以长久存在的) 结构体中。 请阅读 安全考量 以获取最佳实践。

keyfile 和 certfile 是 ssl_context 的旧式替代品 —— 它们可以指向 PEM 格式的私钥和证书链文件用于 SSL 连接。 请注意 keyfile/certfile 形参不能与 ssl_context 共存，如果 keyfile/certfile 与 ssl_context 一同被提供则会引发 ValueError。

可选的 timeout 形参指明连接尝试的超时秒数。 如果参数未给出或为 None，则会使用全局默认的套接字超时设置。

在 3.3 版更改: 增加了 ssl_context 形参。

在 3.4 版更改: 本类现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 （参阅 ssl.HAS_SNI）进行主机名检查。

3.6 版后已移除: keyfile 和 certfile 已弃用并转而推荐 ssl_context。 请改用 ssl.SSLContext.load_cert_chain()，或让 ssl.create_default_context() 为你选择系统所信任的 CA 证书。

在 3.9 版更改: 添加了可选的 timeout 形参。

第二个子类允许由子进程所创建的连接:

class imaplib.IMAP4_stream(command)

这是一个派生自 IMAP4 的子类，它可以连接 stdin/stdout 文件描述符，此种文件是通过向 subprocess.Popen() 传入 command 来创建的。

定义了下列工具函数:

imaplib.Internaldate2tuple(datestr)

解析一个 IMAP4 INTERNALDATE 字符串并返回对应的本地时间。 返回值是一个 time.struct_time 元组或者如果字符串格式错误则为 None。

imaplib.Int2AP(num)

将一个整数转换为使用字符集 [A .. P] 的字节串表示形式。

imaplib.ParseFlags(flagstr)

将一个 IMAP4 FLAGS 响应转换为包含单独旗标的元组。

imaplib.Time2Internaldate(date_time)

将 date_time 转换为 IMAP4 INTERNALDATE 表示形式。 返回值是以下形式的字符串: "DD-Mmm-YYYY HH:MM:SS +HHMM" (包括双引号)。 date_time 参数可以是一个代表距离纪元起始的秒数 (如 time.time() 的返回值) 的数字 (整数或浮点数)，一个代表本地时间的 9 元组，一个 time.struct_time 实例 (如 time.localtime() 的返回值)，一个感知型的 datetime.datetime 实例，或一个双引号字符串。 在最后一种情况下，它会被假定已经具有正确的格式。

请注意 IMAP4 消息编号会随邮箱的改变而改变；特别是在使用 EXPUNGE 命令执行删除后剩余的消息会被重新编号。 因此高度建议通过 UID 命令来改用 UID。

模块的最后有一段测试，其中包含的用法示例更加广泛。

参见

描述该协议的文档，实现该协议的服务器源代码，由华盛顿大学 IMAP 信息中心提供 (源代码) https://github.com/uw-imap/imap (不再维护)。

IMAP4 对象

所有 IMAP4rev1 命令都表示为同名的方法，可以为大写或小写形式。

命令的所有参数都会被转换为字符串，只有 AUTHENTICATE 例外，而 APPEND 的最后一个参数会被作为 IMAP4 字面值传入。 如有必要 (字符串包含 IMAP4 协议中的敏感字符并且未加圆括号或双引号) 每个字符串都会被转码。 但是，LOGIN 命令的 password 参数总是会被转码。 如果你想让某个参数字符串免于被转码 (例如: STORE 的 flags 参数) 则要为该字符串加上圆括号 (例如: r'(\Deleted)')。

每条命令均返回一个元组: (type, [data, ...]) 其中 type 通常为 'OK' 或 'NO'，而 data 为来自命令响应的文本，或为来自命令的规定结果。 每个 data 均为 bytes 或者元组。 如果为元组，则其第一部分是响应的标头，而第二部分将包含数据 (例如: 'literal' 值)。

以下命令的 message_set 选项为指定要操作的一条或多条消息的字符串。 它可以是一个简单的消息编号 ('1')，一段消息编号区间 ('2:4')，或者一组以逗号分隔的非连续区间 ('1:3,6:9')。 区间可以包含一个星号来表示无限的上界 ('3:*')。

IMAP4 实例具有下列方法:

IMAP4.append(mailbox, flags, date_time, message)

将 message 添加到指定的邮箱。

IMAP4.authenticate(mechanism, authobject)

认证命令 --- 要求对响应进行处理。

mechanism 指明要使用哪种认证机制 —— 它应当在实例变量 capabilities 中以 AUTH=mechanism 的形式出现。

authobject 必须是一个可调用对象:

data = authobject(response)

它将被调用以便处理服务器连续响应；传给它的 response 参数将为 bytes 类型。 它应当返回 base64 编码的 bytes 数据 并发送给服务器。 或者在客户端中止响应时返回 None 并应改为发送 *。

在 3.5 版更改: 字符串形式的用户名和密码现在会被执行 utf-8 编码而不限于 ASCII 字符。

IMAP4.check()

为服务器上的邮箱设置检查点。

IMAP4.close()

关闭当前选定的邮箱。 已删除的消息会从可写邮箱中被移除。 在 LOGOUT 之前建议执行此命令。

IMAP4.copy(message_set, new_mailbox)

将 message_set 消息拷贝到 new_mailbox 的末尾。

IMAP4.create(mailbox)

新建名为 mailbox 新邮箱。

IMAP4.delete(mailbox)

删除名为 mailbox 的旧邮箱。

IMAP4.deleteacl(mailbox, who)

删除邮箱上某人的 ACL (移除任何权限)。

IMAP4.enable(capability)

启用 capability (参见 RFC 5161 [https://datatracker.ietf.org/doc/html/rfc5161.html])。 大多数功能都不需要被启用。 目前只有 UTF8=ACCEPT 功能受到支持 (参见 RFC 6855 [https://datatracker.ietf.org/doc/html/rfc6855.html])。

3.5 新版功能: enable() 方法本身，以及 RFC 6855 [https://datatracker.ietf.org/doc/html/rfc6855.html] 支持。

IMAP4.expunge()

从选定的邮箱中永久移除被删除的条目。 为每条被删除的消息各生成一个 EXPUNGE 响应。 返回包含按接收时间排序的 EXPUNGE 消息编号的列表。

IMAP4.fetch(message_set, message_parts)

获取消息（的各个部分）。 message_parts 应为加圆标号的消息部分名称字符串，例如: "(UID BODY[TEXT])"。 返回的数据是由消息部分封包和数据组成的元组。

IMAP4.getacl(mailbox)

获取 mailbox 的 ACL。 此方法是非标准的，但是被 Cyrus 服务器所支持。

IMAP4.getannotation(mailbox, entry, attribute)

提取 mailbox 的特定 ANNOTATION。 此方法是非标准的，但是被 Cyrus 服务器所支持。

IMAP4.getquota(root)

获取 quota root 的资源使用和限制。 此方法是 rfc2087 定义的 IMAP4 QUOTA 扩展的组成部分。

IMAP4.getquotaroot(mailbox)

获取指定 mailbox 的 quota roots 列表。 此方法是 rfc2087 定义的 IMAP4 QUOTA 扩展的组成部分。

IMAP4.list([directory[, pattern]])

列出 directory 中与 pattern 相匹配的邮箱名称。 directory 默认为最高层级的电邮文件夹，而 pattern 默认为匹配任何文本。 返回的数据包含 LIST 响应列表。

IMAP4.login(user, password)

使用纯文本密码标识客户。 password 将被转码。

IMAP4.login_cram_md5(user, password)

在标识用户以保护密码时强制使用 CRAM-MD5 认证。 将只在服务器 CAPABILITY 响应包含 AUTH=CRAM-MD5 阶段时才有效。

IMAP4.logout()

关闭对服务器的连接。 返回服务器 BYE 响应。

在 3.8 版更改: 此方法不会再忽略静默的任意异常。

IMAP4.lsub(directory='""', pattern='*')

列出 directory 中抽取的与 pattern 相匹配的邮箱。 directory 默认为最高层级目录而 pattern 默认为匹配任何邮箱。 返回的数据为消息部分封包和数据的元组。

IMAP4.myrights(mailbox)

显示某个邮箱的本人 ACL (即本人在邮箱中的权限)。

IMAP4.namespace()

返回 RFC 2342 [https://datatracker.ietf.org/doc/html/rfc2342.html] 中定义的 IMAP 命名空间。

IMAP4.noop()

将 NOOP 发送给服务器。

IMAP4.open(host, port, timeout=None)

打开连接 host 上 port 的套接字。 可选的 timeout 形参指定连接尝试的超时秒数。 如果 timeout 未给出或为 None，则会使用全局默认的套接字超时。 另外请注意如果 timeout 形参被设为零，它将引发 ValueError 以拒绝创建非阻塞套接字。 此方法会由 IMAP4 构造器隐式地调用。 此方法所建立的连接对象将在 IMAP4.read(), IMAP4.readline(), IMAP4.send() 和 IMAP4.shutdown() 等方法中被使用。 你可以重写此方法。

引发一个 审计事件 imaplib.open 并附带参数 self, host, port。

在 3.9 版更改: 加入 timeout 参数。

IMAP4.partial(message_num, message_part, start, length)

获取消息被截断的部分。 返回的数据是由消息部分封包和数据组成的元组。

IMAP4.proxyauth(user)

作为 user 进行认证。 允许经权限的管理员通过代理进入任意用户的邮箱。

IMAP4.read(size)

从远程服务器读取 size 字节。 你可以重写此方法。

IMAP4.readline()

从远程服务器读取一行。 你可以重写此方法。

IMAP4.recent()

提示服务器进行更新。 如果没有新消息则返回的数据为 None，否则为 RECENT 响应的值。

IMAP4.rename(oldmailbox, newmailbox)

将名为 oldmailbox 的邮箱重命名为 newmailbox。

IMAP4.response(code)

如果收到响应 code 则返回其数据，否则返回 None。 返回给定的代码，而不是普通的类型。

IMAP4.search(charset, criterion[, ...])

在邮箱中搜索匹配的消息。 charset 可以为 None，在这种情况下在发给服务器的请求中将不指定 CHARSET。 IMAP 协议要求至少指定一个标准；当服务器返回错误时将会引发异常。 charset 为 None 对应使用 enable() 命令启用了 UTF8=ACCEPT 功能的情况。

示例:

# M is a connected IMAP4 instance...
typ, msgnums = M.search(None, 'FROM', '"LDJ"')

# or:
typ, msgnums = M.search(None, '(FROM "LDJ")')

IMAP4.select(mailbox='INBOX', readonly=False)

选择一个邮箱。 返回的数据是 mailbox 中消息的数量 (EXISTS 响应)。 默认的 mailbox 为 'INBOX'。 如果设置了 readonly 旗标，则不允许修改该邮箱。

IMAP4.send(data)

将 data 发送给远程服务器。 你可以重写此方法。

引发一个 审计事件 imaplib.send 并附带参数 self, data。

IMAP4.setacl(mailbox, who, what)

发送 mailbox 的 ACL。 此方法是非标准的，但是被 Cyrus 服务器所支持。

IMAP4.setannotation(mailbox, entry, attribute[, ...])

设置 mailbox 的 ANNOTATION。 此方法是非标准的，但是被 Cyrus 服务器所支持。

IMAP4.setquota(root, limits)

设置 quota root 的资源限制为 limits。 此方法是 rfc2087 定义的 IMAP4 QUOTA 扩展的组成部分。

IMAP4.shutdown()

关闭在 open 中建立的连接。 此方法会由 IMAP4.logout() 隐式地调用。 你可以重写此方法。

IMAP4.socket()

返回用于连接服务器的套接字实例。

IMAP4.sort(sort_criteria, charset, search_criterion[, ...])

sort 命令是 search 的变化形式，带有结果排序语句。 返回的数据包含以空格分隔的匹配消息编号列表。

sort 命令在 search_criterion 参数之前还有两个参数；一个带圆括号的 sort_criteria 列表，和搜索的 charset。 请注意不同于 search，搜索的 charset 参数是强制性的。 还有一个 uid sort 命令与 sort 对应，如同 uid search 与 search 对应一样。 sort 命令首先在邮箱中搜索匹配给定搜索条件的消息，使用 charset 参数来解读搜索条件中的字符串。 然后它将返回所匹配消息的编号。

这是一个 IMAP4rev1 扩展命令。

IMAP4.starttls(ssl_context=None)

发送一个 STARTTLS 命令。 ssl_context 参数是可选的并且应为一个 ssl.SSLContext 对象。 这将在 IMAP 连接上启用加密。 请阅读 安全考量 来了解最佳实践。

3.2 新版功能.

在 3.4 版更改: 此方法现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 (参见 ssl.HAS_SNI) 进行主机名检查。

IMAP4.status(mailbox, names)

针对 mailbox 请求指定的状态条件。

IMAP4.store(message_set, command, flag_list)

改变邮箱中消息的旗标处理。 command 由 RFC 2060 [https://datatracker.ietf.org/doc/html/rfc2060.html] 的 6.4.6 小节指明，应为 "FLAGS", "+FLAGS" 或 "-FLAGS" 之一，并可选择附带 ".SILENT" 后缀。

例如，要在所有消息上设置删除旗标:

typ, data = M.search(None, 'ALL')
for num in data[0].split():
   M.store(num, '+FLAGS', '\\Deleted')
M.expunge()

注解

创建包含 ']' 的旗标 (例如: "[test]") 会违反 RFC 3501 [https://datatracker.ietf.org/doc/html/rfc3501.html] (IMAP 协议)。 但是，imaplib 在历史上曾经允许创建这样的标签，并且流行的 IMAP 服务器如 Gmail 都会接受并生成这样的旗标。 有些非 Python 程序也会创建这样的旗标。 虽然它违反 RFC 并且 IMAP 客户端和服务器应当严格遵守规范，但是 imaplib 出于向下兼容的理由仍然继续允许创建这样的标签，并且在 Python 3.6 中会在其被服务器所发送时处理它们，因为这能提升实际的兼容性。

IMAP4.subscribe(mailbox)

订阅新邮箱。

IMAP4.thread(threading_algorithm, charset, search_criterion[, ...])

thread 命令是 search 的变化形式，带有针对结果的消息串句法。 返回的数据包含以空格分隔的消息串成员列表。

消息串成员由零个或多个消息编号组成，以空格分隔，标示了连续的上下级关系。

thread 命令在 search_criterion 参数之前还有两个参数；一个 threading_algorithm，以及搜索使用的 charset。 请注意不同于 search，搜索使用的 charset 参数是强制性的。 还有一个 uid thread 命令与 thread 对应，如同 uid search 与 search 对应一个。 thread 命令首先在邮箱中搜索匹配给定搜索条件的消息，使用 charset 参数来解读搜索条件中的字符串。 然后它将按照指定的消息串算法返回所匹配的消息串。

这是一个 IMAP4rev1 扩展命令。

IMAP4.uid(command, arg[, ...])

执行 command arg 并附带用 UID 所标识的消息，而不是用消息编号。 返回与命令对应的响应。 必须至少提供一个参数；如果不提供任何参数，服务器将返回错误并引发异常。

IMAP4.unsubscribe(mailbox)

取消订阅原有邮箱。

IMAP4.unselect()

imaplib.IMAP4.unselect() 会释放关联到选定邮箱的服务器资源并将服务器返回到已认证状态。 此命令会执行与 imaplib.IMAP4.close() 相同的动作，区别在于它不会从当前选定邮箱中永久性地移除消息。

3.9 新版功能.

IMAP4.xatom(name[, ...])

允许服务器在 CAPABILITY 响应中通知简单的扩展命令。

在 IMAP4 的实例上定义了下列属性:

IMAP4.PROTOCOL_VERSION

在服务器的 CAPABILITY 响应中最新的受支持协议。

IMAP4.debug

控制调试输出的整数值。 初始值会从模块变量 Debug 中获取。 大于三的值表示将追踪每一条命令。

IMAP4.utf8_enabled

通常为 False 的布尔值，但也可以被设为 True，如果成功地为 UTF8=ACCEPT 功能发送了 enable() 命令的话。

3.5 新版功能.

IMAP4 示例

以下是一个最短示例（不带错误检查），该示例将打开邮箱，检索并打印所有消息:

import getpass, imaplib

M = imaplib.IMAP4()
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()

smtplib --- SMTP 协议客户端

源代码： Lib/smtplib.py [https://github.com/python/cpython/tree/3.10/Lib/smtplib.py]

smtplib 模块定义了一个 SMTP 客户端会话对象，该对象可将邮件发送到互联网上任何带有 SMTP 或 ESMTP 监听程序的计算机。 关于 SMTP 和 ESMTP 操作的更多细节请参阅 RFC 821 [https://datatracker.ietf.org/doc/html/rfc821.html] (简单邮件传输协议) 和 RFC 1869 [https://datatracker.ietf.org/doc/html/rfc1869.html] (SMTP 服务扩展)。

class smtplib.SMTP(host='', port=0, local_hostname=None, [timeout, ]source_address=None)

SMTP 实例是对 SMTP 连接的封装。 它提供了支持各种 SMTP 和 ESMTP 操作的方法。 如果给出了可选的 host 和 port 形参，则会在初始化期间调用 SMTP connect() 方法并附带这些形参。 如果指定了 local_hostname，它将在 HELO/EHLO 命令中被用作本地主机的 FQDN。 在其他情况下，会使用 socket.getfqdn() 来找到本地主机名。 如果 connect() 调用返回了表示成功的代码以外的信息，则会引发 SMTPConnectError。 可选的 timeout 形参指定了阻塞操作如连接尝试的超时秒数（如果未指定，则将使用全局默认超时设置）。 如果达到超时限制，则会引发 TimeoutError。 可选的 source_address 形参允许在在有多张网卡的计算机中绑定到某些特定的源地址，和/或绑定到某些特定的源 TCP 端口。 它接受一个 2 元组 (host, port) 作为在连接之前所绑定作为其源地址的套接字。 如果省略（或者如果 host 或 port 为 '' 和/或分别为 0）则将使用 OS 的默认行为。

正常使用时，只需要初始化或 connect 方法，sendmail() 方法，再加上 SMTP.quit() 方法即可。下文包括了一个示例。

SMTP 类支持 with 语句。当这样使用时，with 语句一退出就会自动发出 SMTP QUIT 命令。例如:

>>> from smtplib import SMTP
>>> with SMTP("domain.org") as smtp:
...     smtp.noop()
...
(250, b'Ok')
>>>

引发一个 审计事件 smtplib.send，附带参数 self, data。

在 3.3 版更改: 添加了对 with 语句的支持。

在 3.3 版更改: 添加了 source_address 参数。

3.5 新版功能: 现在已支持 SMTPUTF8 扩展 (RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html])。

在 3.9 版更改: 如果 timeout 形参被设为零，则它将引发 ValueError 来阻止创建非阻塞的套接字

class smtplib.SMTP_SSL(host='', port=0, local_hostname=None, keyfile=None, certfile=None, [timeout, ]context=None, source_address=None)

SMTP_SSL 实例与 SMTP 实例的行为完全相同。在开始连接就需要 SSL，且 starttls() 不适合的情况下，应该使用 SMTP_SSL。如果未指定 host，则使用 localhost。如果 port 为 0，则使用标准 SMTP-over-SSL 端口（465）。可选参数 local_hostname、timeout 和 source_address 的含义与 SMTP 类中的相同。可选参数 context 是一个 SSLContext 对象，可以从多个方面配置安全连接。请阅读 安全考量 以获取最佳实践。

keyfile 和 certfile 是 context 的传统替代物，它们可以指向 PEM 格式的私钥和证书链文件用于 SSL 连接。

在 3.3 版更改: 增加了 context。

在 3.3 版更改: 添加了 source_address 参数。

在 3.4 版更改: 本类现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 （参阅 ssl.HAS_SNI）进行主机名检查。

3.6 版后已移除: keyfile 和 certfile 已弃用并转而推荐 context。 请改用 ssl.SSLContext.load_cert_chain() 或让 ssl.create_default_context() 为你选择系统所信任的 CA 证书。

在 3.9 版更改: 如果 timeout 形参被设为零，则它将引发 ValueError 来阻止创建非阻塞的套接字

class smtplib.LMTP(host='', port=LMTP_PORT, local_hostname=None, source_address=None[, timeout])

LMTP 协议与 ESMTP 非常相似，它很大程度上基于标准的 SMTP 客户端。将 Unix 套接字用于 LMTP 是很常见的，因此 connect() 方法支持 Unix 套接字，也支持常规的 host:port 服务器。可选参数 local_hostname 和 source_address 的含义与 SMTP 类中的相同。要指定 Unix 套接字，host 必须使用绝对路径，以 '/' 开头。

支持使用常规的 SMTP 机制来进行认证。 当使用 Unix 套接字时，LMTP 通常不支持或要求任何认证，但你的情况可能会有所不同。

在 3.9 版更改: 添加了可选的 timeout 形参。

同样地定义了一组精心选择的异常:

exception smtplib.SMTPException

OSError 的子类，它是本模块提供的所有其他异常的基类。

在 3.4 版更改: SMTPException 已成为 OSError 的子类

exception smtplib.SMTPServerDisconnected

当服务器意外断开连接，或在 SMTP 实例连接到服务器之前尝试使用它时将引发此异常。

exception smtplib.SMTPResponseException

包括 SMTP 错误代码的所有异常的基类。 这些异常会在 SMTP 服务器返回错误代码时在实例中生成。 错误代码存放在错误的 smtp_code 属性中，并且 smtp_error 属性会被设为错误消息。

exception smtplib.SMTPSenderRefused

发送方地址被拒绝。 除了在所有 SMTPResponseException 异常上设置的属性，还会将 'sender' 设为代表拒绝方 SMTP 服务器的字符串。

exception smtplib.SMTPRecipientsRefused

所有接收方地址被拒绝。 每个接收方的错误可通过属性 recipients 来访问，该属性是一个字典，其元素顺序与 SMTP.sendmail() 所返回的一致。

exception smtplib.SMTPDataError

SMTP 服务器拒绝接收消息数据。

exception smtplib.SMTPConnectError

在建立与服务器的连接期间发生了错误。

exception smtplib.SMTPHeloError

服务器拒绝了我们的 HELO 消息。

exception smtplib.SMTPNotSupportedError

尝试的命令或选项不被服务器所支持。

3.5 新版功能.

exception smtplib.SMTPAuthenticationError

SMTP 认证出现问题。 最大的可能是服务器不接受所提供的用户名/密码组合。

参见

RFC 821 [https://datatracker.ietf.org/doc/html/rfc821.html] - 简单邮件传输协议

SMTP 的协议定义。 该文件涵盖了 SMTP 的模型、操作程序和协议细节。

RFC 1869 [https://datatracker.ietf.org/doc/html/rfc1869.html] - SMTP 服务扩展

定义了 SMTP 的 ESMTP 扩展。 这描述了一个用新命令扩展 SMTP 的框架，支持动态发现服务器所提供的命令，并定义了一些额外的命令。

SMTP 对象

一个 SMTP 实例拥有以下方法：

SMTP.set_debuglevel(level)

设置调试输出级别。 如果 level 的值为 1 或 True ，就会产生连接的调试信息，以及所有发送和接收服务器的信息。 如果 level 的值为 2 ，则这些信息会被加上时间戳。

在 3.5 版更改: 添调试级别 2 。

SMTP.docmd(cmd, args='')

向服务器发送一条命令 cmd 。 可选的参数 args 被简单地串联到命令中，用一个空格隔开。

这将返回一个由数字响应代码和实际响应行组成的2元组（多行响应被连接成一个长行）。

在正常操作中，应该没有必要明确地调用这个方法。它被用来实现其他方法，对于测试私有扩展可能很有用。

如果在等待回复的过程中，与服务器的连接丢失， SMTPServerDisconnected 将被触发。

SMTP.connect(host='localhost', port=0)

连接到某个主机的某个端口。默认是连接到 localhost 的标准 SMTP 端口（25）上。如果主机名以冒号 (':') 结尾，后跟数字，则该后缀将被删除，且数字将视作要使用的端口号。如果在实例化时指定了 host，则构造函数会自动调用本方法。返回包含响应码和响应消息的 2 元组，它们由服务器在其连接响应中发送。

引发一个 审计事件 smtplib.connect 并附带参数 self, host, port。

SMTP.helo(name='')

使用 HELO 向 SMTP 服务器表明自己的身份。 hostname 参数默认为本地主机的完全合格域名。服务器返回的消息被存储为对象的 helo_resp 属性。

在正常操作中，应该没有必要明确调用这个方法。它将在必要时被 sendmail() 隐式调用。

SMTP.ehlo(name='')

使用 EHLO 向 ESMTP 服务器表明自己的身份。 hostname 参数默认为本地主机的完全合格域名。 检查 ESMTP 选项的响应，并存储它们供 has_extn() 使用。同时设置几个信息属性：服务器返回的消息被存储为 ehlo_resp 属性， does_esmtp 根据服务器是否支持 ESMTP 被设置为 True 或 False ，而 esmtp_features 将是一个字典，包含这个服务器支持的 SMTP 服务扩展的名称，以及它们的参数（如果有）。

除非你想在发送邮件前使用 has_extn() ，否则应该没有必要明确调用这个方法。 它将在必要时被 sendmail() 隐式调用。

SMTP.ehlo_or_helo_if_needed()

如果这个会话中没有先前的 EHLO 或 HELO 命令，该方法会调用 ehlo() 和/或 helo() 。它首先尝试 ESMTP EHLO 。

SMTPHeloError

服务器没有正确回复 HELO 问候。

SMTP.has_extn(name)

如果 name 在服务器返回的 SMTP 服务扩展集合中，返回 True ，否则为 False 。大小写被忽略。

SMTP.verify(address)

使用 SMTP VRFY 检查此服务器上的某个地址是否有效。 如果用户地址有效则返回一个由代码 250 和完整 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 地址（包括人名）组成的元组。 否则返回 400 或更大的 SMTP 错误代码以及一个错误字符串。

注解

许多网站都禁用 SMTP VRFY 以阻止垃圾邮件。

SMTP.login(user, password, *, initial_response_ok=True)

登录到一个需要认证的 SMTP 服务器。 参数是用于认证的用户名和密码。 如果会话在之前没有执行过 EHLO 或 HELO 命令，此方法会先尝试 ESMTP EHLO。 如果认证成功则此方法将正常返回，否则可能引发以下异常:

SMTPHeloError

服务器没有正确回复 HELO 问候。

SMTPAuthenticationError

服务器不接受所提供的用户名/密码组合。

SMTPNotSupportedError

服务器不支持 AUTH 命令。

SMTPException

未找到适当的认证方法。

smtplib 所支持的每种认证方法只要被服务器声明支持就会被依次尝试。 请参阅 auth() 获取受支持的认证方法列表。 initial_response_ok 会被传递给 auth()。

可选的关键字参数 initial_response_ok 对于支持它的认证方法，是否可以与 AUTH 命令一起发送 RFC 4954 [https://datatracker.ietf.org/doc/html/rfc4954.html] 中所规定的“初始响应”，而不是要求回复/响应。

在 3.5 版更改: 可能会引发 SMTPNotSupportedError，并添加 initial_response_ok 形参。

SMTP.auth(mechanism, authobject, *, initial_response_ok=True)

为指定的认证机制 mechanism 发送 SMTP AUTH 命令，并通过 authobject 处理回复响应。

mechanism 指定要使用何种认证机制作为 AUTH 命令的参数；可用的值是在 esmtp_features 的 auth 元素中列出的内容。

authobject 必须是接受一个可选的单独参数的可调用对象:

data = authobject(challenge=None)

如果可选的关键字参数 initial_response_ok 为真值，则将先不带参数地调用 authobject()。 它可以返回 RFC 4954 [https://datatracker.ietf.org/doc/html/rfc4954.html] "初始响应" ASCII str，其内容将被编码并使用下述的 AUTH 命令来发送。 如果 authobject() 不支持初始响应（例如由于要求一个回复），它应当将 None 作为附带 challenge=None 调用的返回值。 如果 initial_response_ok 为假值，则 authobject() 将不会附带 None 被首先调用。

如果初始响应检测返回了 None，或者如果 initial_response_ok 为假值，则将调用 authobject() 来处理服务器的回复响应；它所传递的 challenge 参数将为一个 bytes。 它应当返回用 base64 进行编码的 ASCII str data 并发送给服务器。

SMTP 类提供的 authobjects 针对 CRAM-MD5, PLAIN 和 LOGIN 等机制；它们的名称分别是 SMTP.auth_cram_md5, SMTP.auth_plain 和 SMTP.auth_login。 它们都要求将 user 和 password 这两个 SMTP 实例属性设为适当的值。

用户代码通常不需要直接调用 auth，而是调用 login() 方法，它将按上述顺序依次尝试上述每一种机制。 auth 被公开以便辅助实现 smtplib 没有（或尚未）直接支持的认证方法。

3.5 新版功能.

SMTP.starttls(keyfile=None, certfile=None, context=None)

将 SMTP 连接设为 TLS (传输层安全) 模式。 后续的所有 SMTP 命令都将被加密。 你应当随即再次调用 ehlo()。

如果提供了 keyfile 和 certfile，它们会被用来创建 ssl.SSLContext。

可选的 context 形参是一个 ssl.SSLContext 对象；它是使用密钥文件和证书的替代方式，如果指定了该形参则 keyfile 和 certfile 都应为 None。

如果这个会话中没有先前的 EHLO or HELO 命令，该方法会首先尝试 ESMTP EHLO。

3.6 版后已移除: keyfile 和 certfile 已弃用并转而推荐 context。 请改用 ssl.SSLContext.load_cert_chain() 或让 ssl.create_default_context() 为你选择系统所信任的 CA 证书。

SMTPHeloError

服务器没有正确回复 HELO 问候。

SMTPNotSupportedError

服务器不支持 STARTTLS 扩展。

RuntimeError

SSL/TLS 支持在你的 Python 解释器上不可用。

在 3.3 版更改: 增加了 context。

在 3.4 版更改: 此方法现在支持使用 SSLContext.check_hostname 和 服务器名称指示符 (参见 HAS_SNI) 进行主机名检查。

在 3.5 版更改: 因缺少 STARTTLS 支持而引发的错误现在是 SMTPNotSupportedError 子类而不是 SMTPException 基类。

SMTP.sendmail(from_addr, to_addrs, msg, mail_options=(), rcpt_options=())

发送邮件。必要参数是一个 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 发件地址字符串，一个 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 收件地址字符串列表（裸字符串将被视为含有 1 个地址的列表），以及一个消息字符串。调用者可以将 ESMTP 选项列表（如 8bitmime）作为 mail_options 传入，用于 MAIL FROM 命令。需要与所有 RCPT 命令一起使用的 ESMTP 选项（如 DSN 命令）可以作为 rcpt_options 传入。（如果需要对不同的收件人使用不同的 ESMTP 选项，则必须使用底层的方法来发送消息，如 mail(), rcpt() 和 data()。）

注解

from_addr 和 to_addrs 形参被用来构造传输代理所使用的消息封包。 sendmail 不会以任何方式修改消息标头。

msg 可以是一个包含 ASCII 范围内字符的字符串，或是一个字节串。 字符串会使用 ascii 编解码器编码为字节串，并且单独的 \r 和 \n 字符会被转换为 \r\n 字符序列。 字节串则不会被修改。

如果在此之前本会话没有执行过 EHLO 或 HELO 命令，此方法会先尝试 ESMTP EHLO。 如果服务器执行了 ESMTP，消息大小和每个指定的选项将被传递给它（如果指定的选项属于服务器声明的特性集）。 如果 EHLO 失败，则将尝试 HELO 并屏蔽 ESMTP 选项。

如果邮件被至少一个接收方接受则此方法将正常返回。 在其他情况下它将引发异常。 也就是说，如果此方法没有引发异常，则应当会有人收到你的邮件。 如果此方法没有引发异常，它将返回一个字典，其中的条目对应每个拒绝的接收方。 每个条目均包含由服务器发送的 SMTP 错误代码和相应错误消息所组成的元组。

如果 SMTPUTF8 包括在 mail_options 中，并且被服务器所支持，则 from_addr 和 to_addrs 可能包含非 ASCII 字符。

此方法可能引发以下异常:

SMTPRecipientsRefused

所有收件人都被拒绝。 无人收到邮件。 该异常的 recipients 属性是一个字典，其中有被拒绝收件人的信息（类似于至少有一个收件人接受邮件时所返回的信息）。

SMTPHeloError

服务器没有正确回复 HELO 问候。

SMTPSenderRefused

服务器不接受 from_addr。

SMTPDataError

服务器回复了一个意外的错误代码（而不是拒绝收件人）。

SMTPNotSupportedError

在 mail_options 中给出了 SMTPUTF8 但是不被服务器所支持。

除非另有说明，即使在引发异常之后连接仍将被打开。

在 3.2 版更改: msg 可以为字节串。

在 3.5 版更改: 增加了 SMTPUTF8 支持，并且如果指定了 SMTPUTF8 但是不被服务器所支持则可能会引发 SMTPNotSupportedError。

SMTP.send_message(msg, from_addr=None, to_addrs=None, mail_options=(), rcpt_options=())

本方法是一种快捷方法，用于带着消息调用 sendmail()，消息由 email.message.Message 对象表示。参数的含义与 sendmail() 中的相同，除了 msg，它是一个 Message 对象。

如果 from_addr 为 None 或 to_addrs 为 None ，那么 send_message 将根据 RFC 5322 [https://datatracker.ietf.org/doc/html/rfc5322.html]，从 msg 头部提取地址填充下列参数：如果头部存在 Sender 字段，则用它填充 from_addr，不存在则用 From 字段填充 from_addr。to_addrs 组合了 msg 中的 To, Cc 和 Bcc 字段的值（字段存在的情况下）。如果一组 Resent-* 头部恰好出现在 message 中，那么就忽略常规的头部，改用 Resent-* 头部。如果 message 包含多组 Resent-* 头部，则引发 ValueError，因为无法明确检测出哪一组 Resent- 头部是最新的。

send_message 使用 BytesGenerator 来序列化 msg，且将 \r\n 作为 linesep，并调用 sendmail() 来传输序列化后的结果。无论 from_addr 和 to_addrs 的值为何，send_message 都不会传输 msg 中可能出现的 Bcc 或 Resent-Bcc 头部。如果 from_addr 和 to_addrs 中的某个地址包含非 ASCII 字符，且服务器没有声明支持 SMTPUTF8，则引发 SMTPNotSupported 错误。如果服务器支持，则 Message 将按新克隆的 policy 进行序列化，其中的 utf8 属性被设置为 True，且 SMTPUTF8 和 BODY=8BITMIME 被添加到 mail_options 中。

3.2 新版功能.

3.5 新版功能: 支持国际化地址 (SMTPUTF8)。

SMTP.quit()

终结 SMTP 会话并关闭连接。 返回 SMTP QUIT 命令的结果。

与标准 SMTP/ESMTP 命令 HELP, RSET, NOOP, MAIL, RCPT 和 DATA 对应的低层级方法也是受支持的。 通常不需要直接调用这些方法，因此它们没有被写入本文档。 相关细节请参看模块代码。

SMTP 示例

这个例子提示用户输入消息封包所需的地址 ('To' 和 'From' 地址)，以及所要封包的消息。 请注意包括在消息中的标头必须包括在输入的消息中；这个例子不对 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 标头进行任何处理。 特别地，'To' 和 'From' 地址必须显式地包括在消息标头中。

import smtplib

def prompt(prompt):
    return input(prompt).strip()

fromaddr = prompt("From: ")
toaddrs  = prompt("To: ").split()
print("Enter message, end with ^D (Unix) or ^Z (Windows):")

# Add the From: and To: headers at the start!
msg = ("From: %s\r\nTo: %s\r\n\r\n"
       % (fromaddr, ", ".join(toaddrs)))
while True:
    try:
        line = input()
    except EOFError:
        break
    if not line:
        break
    msg = msg + line

print("Message length is", len(msg))

server = smtplib.SMTP('localhost')
server.set_debuglevel(1)
server.sendmail(fromaddr, toaddrs, msg)
server.quit()

注解

通常，你将需要使用 email 包的特性来构造电子邮件消息，然后你可以通过 send_message() 来发送它，参见 email: 示例。

uuid --- RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 定义的UUID对象

源代码： Lib/uuid.py [https://github.com/python/cpython/tree/3.10/Lib/uuid.py]

这个模块提供了不可变的 UUID 对象 (UUID 类) 和 uuid1(), uuid3(), uuid4(), uuid5() 等函数用于生成 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 所定义的第 1, 3, 4 和 5 版 UUID。

如果你想要的只是一个唯一的ID，你可能应该调用 uuid1() 或 uuid4()。 注意 uuid1() 可能会损害隐私，因为它创建了一个包含计算机网络地址的UUID。 uuid4() 可以创建一个随机UUID。

根据底层平台的支持，uuid1() 可能会也可能不会返回一个 "安全的" UUID。 安全的 UUID 是使用同步方法生成的，确保没有两个进程可以获得相同的 UUID。 所有 UUID 的实例都有一个 is_safe 属性，使用这个枚举来传递关于 UUID 安全的任何信息:

class uuid.SafeUUID

3.7 新版功能.

safe

该UUID是由平台以多进程安全的方式生成的。

unsafe

UUID不是以多进程安全的方式生成的。

unknown

该平台不提供UUID是否安全生成的信息。

class 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:

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)

必须给出 hex、bytes、bytes_le、fields 或 int 中的唯一一个。 version 参数是可选的；如果给定，产生的UUID将根据 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 设置其变体和版本号，覆盖给定的 hex、bytes、bytes_le、fields 或 int 中的位。

UUID 对象的比较是通过比较它们的 UUID.int 属性进行的。 与非 UUID 对象的比较会引发 TypeError。

str(uuid) 返回一个 12345678-1234-5678-1234-567812345678 形式的字符串，其中 32 位十六进制数字代表 UUID。

UUID 实例有这些只读的属性:

UUID.bytes

UUID是一个16字节的字符串（包含6个大端字节序的整数字段）。

UUID.bytes_le

UUID 是一个 16 字节的字符串（其中 time_low、time_mid 和 time_hi_version 为小端字节顺序）。

UUID.fields

以元组形式存放的UUID的6个整数域，有六个单独的属性和两个派生属性：

域 | 含意
time_low | UUID的前32位
time_mid | 接前一域的16位
time_hi_version | 接前一域的16位
clock_seq_hi_variant | 接前一域的8位
clock_seq_low | 接前一域的8位
node | UUID的最后48位
time | UUID的总长60位的时间戳
clock_seq | 14位的序列号

UUID.hex

UUID 是一个 32 字符的小写十六进制数码字符串。

UUID.int

UUID是一个128位的整数。

UUID.urn

在 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 中定义的 URN 形式的 UUID。

UUID.variant

UUID 的变体，它决定了 UUID 的内部布局。 这将是 RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT 或 RESERVED_FUTURE 中的一个。

UUID.version

UUID 版本号（1 到 5，只有当变体为 RFC_4122 时才有意义）。

UUID.is_safe

一个 SafeUUID 的枚举，表示平台是否以多进程安全的方式生成 UUID。

3.7 新版功能.

uuid 模块定义了以下函数：

uuid.getnode()

获取 48 位正整数形式的硬件地址。 第一次运行时，它可能会启动一个单独的程序，这可能会相当慢。 如果所有获取硬件地址的尝试都失败了，我们会按照 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 中的建议，选择一个随机的 48 位数字，其多播位 (第一个八进制数的最小有效位) 设置为 1。 “硬件地址”是指一个网络接口的 MAC 地址。 在一台有多个网络接口的机器上，普遍管理的 MAC 地址 (即第一个八位数的第二个最小有效位是 未设置的) 将比本地管理的 MAC 地址优先，但没有其他排序保证。

在 3.7 版更改: 普遍管理的MAC地址优于本地管理的MAC地址，因为前者保证是全球唯一的，而后者则不是。

uuid.uuid1(node=None, clock_seq=None)

根据主机 ID、序列号和当前时间生成一个 UUID。 如果没有给出 node，则使用 getnode() 来获取硬件地址。 如果给出了 clock_seq，它将被用作序列号；否则将选择一个随机的 14 比特位序列号。

uuid.uuid3(namespace, name)

根据命名空间标识符（这是一个UUID）和名称（这是一个字符串）的MD5哈希值，生成一个UUID。

uuid.uuid4()

生成一个随机的UUID。

uuid.uuid5(namespace, name)

根据命名空间标识符（这是一个UUID）和名称（这是一个字符串）的SHA-1哈希值生成一个UUID。

uuid 模块定义了以下命名空间标识符，供 uuid3() 或 uuid5() 使用。

uuid.NAMESPACE_DNS

当指定这个命名空间时，name 字符串是一个完全限定的域名。

uuid.NAMESPACE_URL

当指定这个命名空间时，name 字符串是一个 URL。

uuid.NAMESPACE_OID

当指定这个命名空间时，name 字符串是一个 ISO OID。

uuid.NAMESPACE_X500

当指定这个命名空间时，name 字符串是 DER 或文本输出格式的 X.500 DN。

uuid 模块为 variant 属性的可能值定义了以下常量:

uuid.RESERVED_NCS

为NCS兼容性保留。

uuid.RFC_4122

指定 RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] 中给出的 UUID 布局。

uuid.RESERVED_MICROSOFT

为微软的兼容性保留。

uuid.RESERVED_FUTURE

保留给未来的定义。

参见

RFC 4122 [https://datatracker.ietf.org/doc/html/rfc4122.html] - 通用唯一标识符（UUID）URN命名空间

本规范定义了UUID的统一资源名称空间，UUID的内部格式，以及生成UUID的方法。

示例

下面是一些 uuid 模块的典型使用例子:

>>> 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')

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

源代码: Lib/socketserver.py [https://github.com/python/cpython/tree/3.10/Lib/socketserver.py]

socketserver 模块简化了编写网络服务器的任务。

该模块具有四个基础实体服务器类:

class socketserver.TCPServer(server_address, RequestHandlerClass, bind_and_activate=True)

该类使用互联网 TCP 协议，它可以提供客户端与服务器之间的连续数据流。 如果 bind_and_activate 为真值，该类的构造器会自动尝试唤起 server_bind() 和 server_activate()。 其他形参会被传递给 BaseServer 基类。

class socketserver.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)

该类使用数据包，即一系列离散的信息分包，它们可能会无序地到达或在传输中丢失。 该类的形参与 TCPServer 的相同。

class socketserver.UnixStreamServer(server_address, RequestHandlerClass, bind_and_activate=True)

class socketserver.UnixDatagramServer(server_address, RequestHandlerClass, bind_and_activate=True)

这两个更常用的类与 TCP 和 UDP 类相似，但使用 Unix 域套接字；它们在非 Unix 系统平台上不可用。 它们的形参与 TCPServer 的相同。

这四个类会 同步地 处理请求；每个请求必须完成才能开始下一个请求。 这就不适用于每个请求要耗费很长时间来完成的情况，或者因为它需要大量的计算，又或者它返回了大量的数据而客户端处理起来很缓慢。 解决方案是创建单独的进程或线程来处理每个请求；ForkingMixIn 和 ThreadingMixIn 混合类可以被用于支持异步行为。

创建一个服务器需要分几个步骤进行。 首先，你必须通过子类化 BaseRequestHandler 类并重载其 handle() 方法来创建一个请求处理器类；这个方法将处理传入的请求。 其次，你必须实例化某个服务器类，将服务器地址和请求处理器类传给它。 建议在 with 语句中使用该服务器。 然后再调用服务器对象的 handle_request() 或 serve_forever() 方法来处理一个或多个请求。 最后，调用 server_close() 来关闭套接字（除非你使用了 with 语句）。

当从 ThreadingMixIn 继承线程连接行为时，你应当显式地声明你希望在突然关机时你的线程采取何种行为。 ThreadingMixIn 类定义了一个属性 daemon_threads，它指明服务器是否应当等待线程终止。 如果你希望线程能自主行动你应当显式地设置这个旗标；默认值为 False，表示 Python 将不会在 ThreadingMixIn 所创建的所有线程都退出之前退出。

服务器类具有同样的外部方法和属性，无论它们使用哪种网络协议。

服务器创建的说明

在继承图中有五个类，其中四个代表四种类型的同步服务器:

+------------+
| BaseServer |
+------------+
      |
      v
+-----------+        +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+        +------------------+
      |
      v
+-----------+        +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+        +--------------------+

请注意 UnixDatagramServer 是派生自 UDPServer，而不是派生自 UnixStreamServer --- IP 和 Unix 流服务器的唯一区别地址族。

class socketserver.ForkingMixIn

class socketserver.ThreadingMixIn

每种服务器类型的分叉和线程版本都可以使用这些混合类来创建。 例如，ThreadingUDPServer 的创建方式如下:

class ThreadingUDPServer(ThreadingMixIn, UDPServer):
    pass

混合类先出现，因为它重载了 UDPServer 中定义的一个方法。 设置各种属性也会改变下层服务器机制的行为。

ForkingMixIn 和下文提及的分叉类仅在支持 fork() 的 POSIX 系统平台上可用。

socketserver.ForkingMixIn.server_close() 会等待直到所有子进程完成，除非 socketserver.ForkingMixIn.block_on_close 属性为假值。

socketserver.ThreadingMixIn.server_close() 会等待直到所有非守护类线程完成，除非 socketserver.ThreadingMixIn.block_on_close 属性为假值。 请将 ThreadingMixIn.daemon_threads 设为 True 来使用守护类线程以便不等待线完成。

在 3.7 版更改: socketserver.ForkingMixIn.server_close() 和 socketserver.ThreadingMixIn.server_close() 现在会等待直到所有子进程和非守护类线程完成。 请新增一个 socketserver.ForkingMixIn.block_on_close 类属性来选择 3.7 版之前的行为。

class socketserver.ForkingTCPServer

class socketserver.ForkingUDPServer

class socketserver.ThreadingTCPServer

class socketserver.ThreadingUDPServer

这些类都是使用混合类来预定义的。

要实现一个服务，你必须从 BaseRequestHandler 派生一个类并重定义其 handle() 方法。 然后你可以通过组合某种服务器类型与你的请求处理器类来运行各种版本的服务。 请求处理器类对于数据报和流服务必须是不相同的。 这可以通过使用处理器子类 StreamRequestHandler 或 DatagramRequestHandler 来隐藏。

当然，你仍然需要动点脑筋！ 举例来说，如果服务包含可能被不同请求所修改的内存状态则使用分叉服务器是没有意义的，因为在子进程中的修改将永远不会触及保存在父进程中的初始状态并传递到各个子进程。 在这种情况下，你可以使用线程服务器，但你可能必须使用锁来保护共享数据的一致性。

另一方面，如果你是在编写一个所有数据保存在外部（例如文件系统）的 HTTP 服务器，同步类实际上将在正在处理某个请求的时候“失聪” -- 如果某个客户端在接收它所请求的所有数据时很缓慢这可能会是非常长的时间。 这时线程或分叉服务器会更为适用。

在某些情况下，合适的做法是同步地处理请求的一部分，但根据请求数据在分叉的子进程中完成处理。 这可以通过使用一个同步服务器并在请求处理器类 handle() 中进行显式分叉来实现。

还有一种可以在既不支持线程也不支持 fork() 的环境（或者对于本服务来说这两者开销过大或是不适用）中处理多个同时请求的方式是维护一个显式的部分完成的请求表并使用 selectors 来决定接下来要处理哪个请求（或者是否要处理一个新传入的请求）。 这对于流服务来说特别重要，因为每个客户端可能会连接很长的时间（如果不能使用线程或子进程）。 请参阅 asyncore 来了解另一种管理方式。

Server 对象

class socketserver.BaseServer(server_address, RequestHandlerClass)

这是本模块中所有 Server 对象的超类。 它定义了下文给出的接口，但没有实现大部分的方法，它们应在子类中实现。 两个形参存储在对应的 server_address 和 RequestHandlerClass 属性中。

fileno()

返回服务器正在监听的套接字的以整数表示的文件描述符。 此函数最常被传递给 selectors，以允许在同一进程中监控多个服务器。

handle_request()

处理单个请求。 此函数会依次调用下列方法: get_request(), verify_request() 和 process_request()。 如果用户提供的处理器类的 handle() 方法引发了异常，则将调用服务器的 handle_error() 方法。 如果在 timeout 秒内未接收到请求，将会调用 handle_timeout() 并将返回 handle_request()。

serve_forever(poll_interval=0.5)

对请求进行处理直至收到显式的 shutdown() 请求。 每隔 poll_interval 秒对 shutdown 进行轮询。 忽略 timeout 属性。 它还会调用 service_actions()，这可被子类或混合类用来提供某个给定服务的专属操作。 例如，ForkingMixIn 类使用 service_actions() 来清理僵尸子进程。

在 3.3 版更改: 将 service_actions 调用添加到 serve_forever 方法。

service_actions()

此方法会在 the serve_forever() 循环中被调用。 此方法可被子类或混合类所重载以执行某个给定服务的专属操作，例如清理操作。

3.3 新版功能.

shutdown()

通知 serve_forever() 循环停止并等待它完成。 shutdown() 必须在 serve_forever() 运行于不同线程时被调用否则它将发生死锁。

server_close()

清理服务器。 此方法可被重载。

address_family

服务器套接字所属的协议族。 常见的例子有 socket.AF_INET 和 socket.AF_UNIX。

RequestHandlerClass

用户提供的请求处理器类；将为每个请求创建该类的实例。

server_address

服务器所监听的地址。 地址的格式因具体协议族而不同；请参阅 socket 模块的文档了解详情。 对于互联网协议，这将是一个元组，其中包含一个表示地址的字符串，和一个表示端口号的整数，例如: ('127.0.0.1', 80)。

socket

将由服务器用于监听入站请求的套接字对象。

服务器类支持下列类变量:

allow_reuse_address

服务器是否要允许地址的重用。 默认值为 False，并可在子类中设置以改变策略。

request_queue_size

请求队列的长度。 如果处理单个请求要花费很长的时间，则当服务器正忙时到达的任何请求都会被加入队列，最多加入 request_queue_size 个请求。 一旦队列被加满，来自客户端的更多请求将收到 "Connection denied" 错误。 默认值为 5，但可在子类中重载。

socket_type

服务器使用的套接字类型；常见的有 socket.SOCK_STREAM 和 socket.SOCK_DGRAM 这两个值。

timeout

超时限制，以秒数表示，或者如果不限制超时则为 None。 如果在超时限制期间没有收到 handle_request()，则会调用 handle_timeout() 方法。

有多个服务器方法可被服务器基类的子类例如 TCPServer 所重载；这些方法对服务器对象的外部用户来说并无用处。

finish_request(request, client_address)

通过实例化 RequestHandlerClass 并调用其 handle() 方法来实际处理请求。

get_request()

必须接受来自套接字的请求，并返回一个 2 元组，其中包含用来与客户端通信的 new 套接字对象，以及客户端的地址。

handle_error(request, client_address)

此函数会在 RequestHandlerClass 实例的 handle() 方法引发异常时被调用。 默认行为是将回溯信息打印到标准错误并继续处理其他请求。

在 3.6 版更改: 现在只针对派生自 Exception 类的异常调用此方法。

handle_timeout()

此函数会在 timeout 属性被设为 None 以外的值并且在超出时限之后仍未收到请求时被调用。 分叉服务器的默认行为是收集任何已退出的子进程状态，而在线程服务器中此方法则不做任何操作。

process_request(request, client_address)

调用 finish_request() 来创建 RequestHandlerClass 的实例。 如果需要，此函数可创建一个新的进程或线程来处理请求；ForkingMixIn 和 ThreadingMixIn 类能完成此任务。

server_activate()

由服务器的构造器调用以激活服务器。 TCP 服务器的默认行为只是在服务器的套接字上唤起 listen()。 可以被重载。

server_bind()

由服务器的构造器调用以将套接字绑定到所需的地址。 可以被重载。

verify_request(request, client_address)

必须返回一个布尔值；如果值为 True，请求将被处理。 而如果值为 False，请求将被拒绝。 此函数可被重载以实现服务器的访问控制。 默认实现总是返回 True。

在 3.6 版更改: 添加了对 context manager 协议的支持。 退出上下文管理器与调用 server_close() 等效。

请求处理器对象

class socketserver.BaseRequestHandler

这是所有请求处理器对象的超类。 它定义了下文列出的接口。 一个实体请求处理器子类必须定义新的 handle() 方法，并可重载任何其他方法。 对于每个请求都会创建一个新的子类的实例。

setup()

会在 handle() 方法之前被调用以执行任何必要的初始化操作。 默认实现不执行任何操作。

handle()

此函数必须执行为请求提供服务所需的全部操作。 默认实现不执行任何操作。 它有几个可用的实例属性；请求为 self.request；客户端地址为 self.client_address；服务器实例为 self.server，如果它需要访问特定服务器信息的话。

针对数据报或流服务的 self.request 类型是不同的。 对于流服务，self.request 是一个套接字对象；对于数据报服务，self.request 是一对字符串与套接字。

finish()

在 handle() 方法之后调用以执行任何需要的清理操作。 默认实现不执行任何操作。 如果 setup() 引发了异常，此函数将不会被调用。

class socketserver.StreamRequestHandler

class socketserver.DatagramRequestHandler

这些 BaseRequestHandler 子类重载了 setup() 和 finish() 方法，并提供了 self.rfile 和 self.wfile 属性。 self.rfile 和 self.wfile 属性可以被分别读取或写入，以便获取请求数据或将数据返回给客户端。 rfile 属性支持 io.BufferedIOBase 可读接口，而 wfile 属性支持 io.BufferedIOBase 可写接口。

在 3.6 版更改: StreamRequestHandler.wfile 也支持 io.BufferedIOBase 可写接口。

例子

socketserver.TCPServer 示例

以下是服务端:

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 is the TCP socket connected to the client
        self.data = self.request.recv(1024).strip()
        print("{} wrote:".format(self.client_address[0]))
        print(self.data)
        # just send back the same data, but upper-cased
        self.request.sendall(self.data.upper())

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999

    # Create the server, binding to localhost on port 9999
    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:
        # Activate the server; this will keep running until you
        # interrupt the program with Ctrl-C
        server.serve_forever()

一个使用流（通过提供标准文件接口来简化通信的文件型对象）的替代请求处理器类:

class MyTCPHandler(socketserver.StreamRequestHandler):

    def handle(self):
        # self.rfile is a file-like object created by the handler;
        # we can now use e.g. readline() instead of raw recv() calls
        self.data = self.rfile.readline().strip()
        print("{} wrote:".format(self.client_address[0]))
        print(self.data)
        # Likewise, self.wfile is a file-like object used to write back
        # to the client
        self.wfile.write(self.data.upper())

区别在于第二个处理器的 readline() 调用将多次调用 recv() 直至遇到一个换行符，而第一个处理器的单次 recv() 调用只是返回在一次 sendall() 调用中由客户端发送的内容。

以下是客户端:

import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# Create a socket (SOCK_STREAM means a TCP socket)
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
    # Connect to server and send data
    sock.connect((HOST, PORT))
    sock.sendall(bytes(data + "\n", "utf-8"))

    # Receive data from the server and shut down
    received = str(sock.recv(1024), "utf-8")

print("Sent:     {}".format(data))
print("Received: {}".format(received))

这个示例程序的输出应该是像这样的:

服务器:

$ python TCPServer.py
127.0.0.1 wrote:
b'hello world with TCP'
127.0.0.1 wrote:
b'python is nice'

客户端:

$ 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

socketserver.UDPServer 示例

以下是服务端:

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("{} wrote:".format(self.client_address[0]))
        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()

以下是客户端:

import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# SOCK_DGRAM is the socket type to use for UDP sockets
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

# As you can see, there is no connect() call; UDP has no connections.
# Instead, data is directly sent to the recipient via sendto().
sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))
received = str(sock.recv(1024), "utf-8")

print("Sent:     {}".format(data))
print("Received: {}".format(received))

这个示例程序的输出应该是与 TCP 服务器示例相一致的。

异步混合类

要构建异步处理器，请使用 ThreadingMixIn 和 ForkingMixIn 类。

ThreadingMixIn 类的示例:

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__":
    # Port 0 means to select an arbitrary unused port
    HOST, PORT = "localhost", 0

    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
    with server:
        ip, port = server.server_address

        # Start a thread with the server -- that thread will then start one
        # more thread for each request
        server_thread = threading.Thread(target=server.serve_forever)
        # Exit the server thread when the main thread terminates
        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()

这个示例程序的输出应该是像这样的:

$ 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

ForkingMixIn 类的使用方式是相同的，区别在于服务器将为每个请求产生一个新的进程。 仅在支持 fork() 的 POSIX 系统平台上可用。

http.server --- HTTP 服务器

源代码： Lib/http/server.py [https://github.com/python/cpython/tree/3.10/Lib/http/server.py]

这个模块定义了用于实现 HTTP 服务器的类。

警告

http.server 不推荐用于生产环境。它仅仅实现了 basic security checks 的要求。

HTTPServer 是 socketserver.TCPServer 的一个子类。它会创建和侦听 HTTP 套接字，并将请求分发给处理程序。创建和运行 HTTP 服务器的代码类似如下所示：

def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    httpd.serve_forever()

class http.server.HTTPServer(server_address, RequestHandlerClass)

该类基于 TCPServer 类，并在实例变量 server_name 和 server_port 中保存 HTTP 服务器地址。处理程序可通过实例变量 server 访问 HTTP 服务器。

class http.server.ThreadingHTTPServer(server_address, RequestHandlerClass)

该类相似于 HTTPServer ，只是会利用 ThreadingMixIn 对请求进行多线程处理。当需要对 Web 浏览器预先打开套接字进行处理时，这就很有用，这时 HTTPServer 会一直等待请求。

3.7 新版功能.

实例化 HTTPServer 和 ThreadingHTTPServer 时，必须给出一个 RequestHandlerClass，本模块提供了该对象的三种变体：

class http.server.BaseHTTPRequestHandler(request, client_address, server)

这个类用于处理到达服务器的 HTTP 请求。 它本身无法响应任何实际的 HTTP 请求；它必须被子类化以处理每个请求方法（例如 GET 或 POST）。 BaseHTTPRequestHandler 提供了许多供子类使用的类和实例变量以及方法。

这个处理程序将解析请求和标头，然后调用特定请求类型对应的方法。 方法名称将根据请求来构造。 例如，对于请求方法 SPAM，将不带参数地调用 do_SPAM() 方法。 所有相关信息会被保存在该处理程序的实际变量中。 子类不需要重载或扩展 __init__() 方法。

BaseHTTPRequestHandler 具有下列实例变量:

client_address

包含 (host, port) 形式的指向客户端地址的元组。

server

包含服务器实例。

close_connection

应当在 handle_one_request() 返回之前设定的布尔值，指明是否要期待另一个请求，还是应当关闭连接。

requestline

包含 HTTP 请求行的字符串表示。 末尾的 CRLF 会被去除。 该属性应当由 handle_one_request() 来设定。 如果无有效请求行被处理，则它应当被设为空字符串。

command

包含具体的命令（请求类型）。 例如 'GET'。

path

包含请求路径。如果URL的查询部分存在， path 会包含这个查询部分。使用 RFC 3986 [https://datatracker.ietf.org/doc/html/rfc3986.html] 的术语来说，在这里， path 包含 hier-part 和 query 。

request_version

包含请求的版本字符串。 例如 'HTTP/1.0'。

headers

存放由 MessageClass 类变量所指定的类的实例。 该实例会解析并管理 HTTP 请求中的标头。 http.client 中的 parse_headers() 函数将被用来解析标头并且它需要 HTTP 请求提供一个有效的 RFC 2822 [https://datatracker.ietf.org/doc/html/rfc2822.html] 风格的标头。

rfile

一个 io.BufferedIOBase 输入流，准备从可选的输入数据的开头进行读取。

wfile

包含用于写入响应并发回给客户端的输出流。 在写入流时必须正确遵守 HTTP 协议以便成功地实现与 HTTP 客户端的互操作。

在 3.6 版更改: 这是一个 io.BufferedIOBase 流。

BaseHTTPRequestHandler 具有下列属性：

server_version

指定服务器软件版本。 你可能会想要重写该属性。 该属性的格式为多个以空格分隔的字符串，其中每个字符串的形式为 name[/version]。 例如 'BaseHTTP/0.2'。

sys_version

包含 Python 系统版本，采用 version_string 方法和 server_version 类变量所支持的形式。 例如 'Python/1.4'。

error_message_format

指定应当被 send_error() 方法用来构建发给客户端的错误响应的格式字符串。 该字符串应使用来自 responses 的变量根据传给 send_error() 的状态码来填充默认值。

error_content_type

指定发送给客户端的错误响应的 Content-Type HTTP 标头。 默认值为 'text/html'。

protocol_version

该属性指定在响应中使用的 HTTP 协议版本。 如果设为 'HTTP/1.1'，服务器将允许 HTTP 永久连接；但是，这样你的服务器 必须 在发给客户端的所有响应中包括一个准确的 Content-Length 标头 (使用 send_header())。 为了向下兼容，该设置默认为 'HTTP/1.0'。

MessageClass

指定一个 email.message.Message 这样的类来解析 HTTP 标头。 通常该属性不会被重写，其默认值为 http.client.HTTPMessage。

responses

该属性包含一个整数错误代码与由短消息和长消息组成的二元组的映射。 例如，{code: (shortmessage, longmessage)}。 shortmessage 通常是作为消息响应中的 message 键，而 longmessage 则是作为 explain 键。 该属性会被 send_response_only() 和 send_error() 方法所使用。

BaseHTTPRequestHandler 实例具有下列方法:

handle()

调用 handle_one_request() 一次（或者如果启用了永久连接则为多次）来处理传入的 HTTP 请求。 你应该完全不需要重载它；而是要实现适当的 do_*() 方法。

handle_one_request()

此方法将解析并将请求分配给适当的 do_*() 方法。 你应该完全不需要重载它。

handle_expect_100()

当一个符合 HTTP/1.1 标准的服务器收到 Expect: 100-continue 请求标头时它会以 100 Continue 加 200 OK 的标头作为响应。 如果服务器不希望客户端继续则可以重载此方法引发一个错误。 例如服务器可以选择发送 417 Expectation Failed 作为响应标头并 return False。

3.2 新版功能.

send_error(code, message=None, explain=None)

发送并记录回复给客户端的完整错误信息。 数字形式的 code 指明 HTTP 错误代码，可选的 message 为简短的易于人类阅读的错误描述。 explain 参数可被用于提供更详细的错误信息；它将使用 error_message_format 属性来进行格式化并在一组完整的标头之后作为响应体被发送。 responses 属性存放了 message 和 explain 的默认值，它们将在未提供时被使用；对于未知代码两者的默认值均为字符串 ???。 如果方法为 HEAD 或响应代码是下列值之一则响应体将为空: 1xx, 204 No Content, 205 Reset Content, 304 Not Modified。

在 3.4 版更改: 错误响应包括一个 Content-Length 标头。 增加了 explain 参数。

send_response(code, message=None)

将一个响应标头添加到标头缓冲区并记录被接受的请求。 HTTP 响应行会被写入到内部缓冲区，后面是 Server 和 Date 标头。 这两个标头的值将分别通过 version_string() 和 date_time_string() 方法获取。 如果服务器不打算使用 send_header() 方法发送任何其他标头，则 send_response() 后面应该跟一个 end_headers() 调用。

在 3.3 版更改: 标头会被存储到内部缓冲区并且需要显式地调用 end_headers()。

send_header(keyword, value)

将 HTTP 标头添加到内部缓冲区，它将在 end_headers() 或 flush_headers() 被唤起时写入输出流。 keyword 应当指定标头关键字，并以 value 指定其值。 请注意，在 send_header 调用结束之后，必须调用 end_headers() 以便完成操作。

在 3.2 版更改: 标头将被存入内部缓冲区。

send_response_only(code, message=None)

只发送响应标头，用于当 100 Continue 响应被服务器发送给客户端的场合。 标头不会被缓冲而是直接发送到输出流。 如果未指定 message，则会发送与响应 code 相对应的 HTTP 消息。

3.2 新版功能.

end_headers()

将一个空行（指明响应中 HTTP 标头的结束）添加到标头缓冲区并调用 flush_headers()。

在 3.2 版更改: 已缓冲的标头会被写入到输出流。

flush_headers()

最终将标头发送到输出流并清空内部标头缓冲区。

3.3 新版功能.

log_request(code='-', size='-')

记录一次被接受（成功）的请求。 code 应当指定与请求相关联的 HTTP 代码。 如果请求的大小可用，则它应当作为 size 形参传入。

log_error(...)

当请求无法完成时记录一次错误。 默认情况下，它会将消息传给 log_message()，因此它接受同样的参数 (format 和一些额外的值)。

log_message(format, ...)

将任意一条消息记录到 sys.stderr。 此方法通常会被重写以创建自定义的错误日志记录机制。 format 参数是标准 printf 风格的格式字符串，其中会将传给 log_message() 的额外参数用作格式化操作的输入。 每条消息日志记录的开头都会加上客户端 IP 地址和当前日期时间。

version_string()

返回服务器软件的版本字符串。 该值为 server_version 与 sys_version 属性的组合。

date_time_string(timestamp=None)

返回由 timestamp 所给定的日期和时间（参数应为 None 或为 time.time() 所返回的格式），格式化为一个消息标头。 如果省略 timestamp，则会使用当前日期和时间。

结果看起来像 'Sun, 06 Nov 1994 08:49:37 GMT'。

log_date_time_string()

返回当前的日期和时间，为日志格式化

address_string()

返回客户端的地址

在 3.3 版更改: 在之前版本中，会执行一次名称查找。 为了避免名称解析的时延，现在将总是返回 IP 地址。

class http.server.SimpleHTTPRequestHandler(request, client_address, server, directory=None)

这个类会为目录 directory 及以下的文件提供发布服务，或者如果未提供 directory 则为当前目录，直接将目录结构映射到 HTTP 请求。

3.7 新版功能: directory 形参。

在 3.9 版更改: directory 形参接受一个 path-like object。

诸如解析请求之类的大量工作都是由基类 BaseHTTPRequestHandler 完成的。本类实现了 do_GET() 和 do_HEAD() 函数。

以下是 SimpleHTTPRequestHandler 的类属性。

server_version

这会是 "SimpleHTTP/" + __version__，其中 __version__ 定义于模块级别。

extensions_map

将后缀映射为 MIME 类型的字典，其中包含了覆盖系统默认值的自定义映射关系。不区分大小写，因此字典键只应为小写值。

在 3.9 版更改: 此字典不再填充默认的系统映射，而只包含覆盖值。

SimpleHTTPRequestHandler 类定义了以下方法：

do_HEAD()

本方法为 'HEAD' 请求提供服务：它将发送等同于 GET 请求的头文件。关于合法头部信息的更完整解释，请参阅 do_GET() 方法。

do_GET()

通过将请求解释为相对于当前工作目录的路径，将请求映射到某个本地文件。

如果请求被映射到目录，则会依次检查该目录是否存在 index.html 或 index.htm 文件。若存在则返回文件内容；否则会调用 list_directory() 方法生成目录列表。本方法将利用 os.listdir() 扫描目录，如果 listdir() 失败，则返回 404 出错应答。

如果请求被映射到文件，则会打开该文件。 打开文件时的任何 OSError 异常都会被映射为 404, 'File not found' 错误。 如果请求中带有 'If-Modified-Since' 标头，而在此时间点之后文件未作修改，则会发送 304, 'Not Modified' 的响应。 否则会调用 guess_type() 方法猜测内容的类型，该方法会反过来用到 extensions_map 变量，并返回文件内容。

将会输出 'Content-type:' 头部信息，带上猜出的内容类型，然后是 'Content-Length:' 头部信息，带有文件的大小，以及 'Last-Modified:' 头部信息，带有文件的修改时间。

后面是一个空行，标志着头部信息的结束，然后输出文件的内容。如果文件的 MIME 类型以 text/ 开头，文件将以文本模式打开；否则将使用二进制模式。

示例用法请见在 Lib/http/server.py [https://github.com/python/cpython/tree/3.10/Lib/http/server.py] 中 test 函数的实现。

在 3.7 版更改: 为 'If-Modified-Since' 头部信息提供支持。

SimpleHTTPRequestHandler 类的用法可如下所示，以便创建一个非常简单的 Web 服务，为相对于当前目录的文件提供服务：

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()

http.server 也可以使用解释器的 -m 参数直接调用。 与前面的例子类似，这将提供相对于当前目录的文件:

python -m http.server

服务器默认监听端口为8000。可以通过传递所需的端口号作为参数来覆盖默认值:

python -m http.server 9000

默认情况下，服务器将自己绑定到所有接口。 选项 -b/--bind 指定了一个特定的地址，它应该与之绑定。 IPv4 和 IPv6 地址都被支持。例如，下面的命令使服务器只绑定到 localhost:

python -m http.server --bind 127.0.0.1

3.4 新版功能: 引入了 --bind 参数。

3.8 新版功能: 为了支持 IPv6 改进了 --bind 参数。

默认情况下，服务器使用当前目录。选项 -d/--directory 指定了一个它应该提供文件的目录。例如，下面的命令使用一个特定的目录:

python -m http.server --directory /tmp/

3.7 新版功能: --directory 参数被引入。

class http.server.CGIHTTPRequestHandler(request, client_address, server)

该类可为当前及以下目录中的文件或输出 CGI 脚本提供服务。注意，把 HTTP 分层结构映射到本地目录结构，这与 SimpleHTTPRequestHandler 完全一样。

注解

由 CGIHTTPRequestHandler 类运行的 CGI 脚本不能进行重定向操作（HTTP 代码302），因为在执行 CGI 脚本之前会发送代码 200（接下来就输出脚本）。这样状态码就冲突了。

然而，如果这个类猜测它是一个 CGI 脚本，那么就会运行该 CGI 脚本，而不是作为文件提供出去。 只会识别基于目录的 CGI —— 另有一种常用的服务器设置，即标识 CGI 脚本是通过特殊的扩展名。

如果请求指向 cgi_directories 以下的路径，do_GET() 和 do_HEAD() 函数已作修改，不是给出文件，而是运行 CGI 脚本并输出结果。

CGIHTTPRequestHandler 定义了以下数据成员：

cgi_directories

默认为 ['/cgi-bin', '/htbin']，视作 CGI 脚本所在目录。

CGIHTTPRequestHandler 定义了以下方法：

do_POST()

本方法服务于 'POST' 请求，仅用于 CGI 脚本。如果试图向非 CGI 网址发送 POST 请求，则会输出错误 501：Can only POST to CGI scripts"。

请注意，为了保证安全性，CGI 脚本将以用户 nobody 的 UID 运行。CGI 脚本运行错误将被转换为错误 403。

通过在命令行传入 --cgi 参数，可以启用 CGIHTTPRequestHandler ：

python -m http.server --cgi

安全考量

当处理请求时，SimpleHTTPRequestHandler 会解析符号链接，这有可能使得指定文件夹以外的文件被暴露。

较早版本的 Python 不会擦除从 python -m http.server 或默认的 BaseHTTPRequestHandler .log_message 实现发送到 stderr 的日志消息中的控制字符。 这可以允许连接到你的服务器的远程客户端向你的终端发送邪恶的控制代码。

3.10.9 新版功能: 控制字符会在 stderr 日志中被擦除。

http.cookies --- HTTP状态管理

源代码: Lib/http/cookies.py [https://github.com/python/cpython/tree/3.10/Lib/http/cookies.py]

http.cookies 模块定义的类将 cookie 的概念抽象了出来，这是一种 HTTP 状态的管理机制。它既支持简单的纯字符串形式的 cookie，也为任何可序列化数据类型的 cookie 提供抽象。

以前，该模块严格套用 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] 和 RFC 2068 [https://datatracker.ietf.org/doc/html/rfc2068.html] 规范中描述的解析规则。后来人们发现，MSIE 3.0 并不遵循这些规范中的字符规则，而且目前许多浏览器和服务器在处理 cookie 时也放宽了解析规则。 因此，这里用到的解析规则没有那么严格。

字符集 string.ascii_letters 、 string.digits 和 !#$%&'*+-.^_`|~: 给出了本模块允许出现在 cookie 名称中的有效字符集（如 key）。

在 3.3 版更改: “:”字符可用于有效的 cookie 名称。

注解

当遇到无效 cookie 时会触发 CookieError，所以若 cookie 数据来自浏览器，一定要做好应对无效数据的准备，并在解析时捕获 CookieError。

exception http.cookies.CookieError

出现异常的原因，可能是不符合 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] ：属性不正确、Set-Cookie 头部信息不正确等等。

class http.cookies.BaseCookie([input])

类似字典的对象，字典键为字符串，字典值是 Morsel 实例。请注意，在将键值关联时，首先会把值转换为包含键和值的 Morsel 对象。

若给出 input ，将会传给 load() 方法。

class http.cookies.SimpleCookie([input])

该类派生于 BaseCookie，并覆盖了 value_decode() 和 value_encode() 方法。SimpleCookie 允许用字符串作为 cookie 值。在设置值时，SimpleCookie 将调用内置的 str() 将其转换为字符串。从 HTTP 接收到的值将作为字符串保存。

参见

http.cookiejar 模块

处理网络 客户端 的 HTTP cookie。 http.cookiejar 和 http.cookies 模块相互没有依赖关系。

RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] - HTTP状态管理机制

这是本模块实现的状态管理规范。

Cookie 对象

BaseCookie.value_decode(val)

由字符串返回元组 (real_value, coded_value)。real_value 可为任意类型。BaseCookie 中的此方法未实现任何解码工作——只为能被子类重写。

BaseCookie.value_encode(val)

返回元组 (real_value, coded_value)。val 可为任意类型，coded_value 则会转换为字符串。 BaseCookie 中的此方法未实现任何编码工作——只为能被子类重写。

通常在 value_decode 的取值范围内，value_encode() 和 value_decode() 应为可互逆操作。

BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\r\n')

返回可作为 HTTP 标头信息发送的字符串表示。 attrs 和 header 会传给每个 Morsel 的 output() 方法。 sep 用来将标头连接在一起，默认为 '\r\n' (CRLF) 组合。

BaseCookie.js_output(attrs=None)

返回一段可供嵌入的 JavaScript 代码，若在支持 JavaScript 的浏览器上运行，其作用如同发送 HTTP 头部信息一样。

attrs 的含义与 output() 的相同。

BaseCookie.load(rawdata)

若 rawdata 为字符串，则会作为 HTTP_COOKIE 进行解析，并将找到的值添加为 Morsel。 如果是字典值，则等价于:

for k, v in rawdata.items():
    cookie[k] = v

Morsel 对象

class http.cookies.Morsel

对键/值对的抽象，带有 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] 的部分属性。

morsel 对象类似于字典，键的组成是常量——均为有效的 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] 属性，包括：

expires

path

comment

domain

max-age

secure

version

httponly

samesite

httponly 属性指明了该 cookie 仅在 HTTP 请求中传输，且不能通过 JavaScript 访问。这是为了减轻某些跨站脚本攻击的危害。

samesite 属性指明了浏览器不得与跨站请求一起发送该 cookie。这有助于减轻 CSRF 攻击的危害。此属性的有效值为 “Strict”和“Lax”。

键不区分大小写，默认值为 ''。

在 3.5 版更改: 现在，__eq__() 会同时考虑 key 和 value 。

在 3.7 版更改: Attributes key, value and coded_value are read-only. Use set() for setting them.

在 3.8 版更改: 增加对 samesite 属性的支持。

Morsel.value

Cookie的值。

Morsel.coded_value

编码后的 cookie 值——也即要发送的内容。

Morsel.key

cookie 名称

Morsel.set(key, value, coded_value)

设置 key、value 和 coded_value 属性。

Morsel.isReservedKey(K)

判断 K 是否属于 Morsel 的键。

Morsel.output(attrs=None, header='Set-Cookie:')

返回 morsel 的字符串形式，适用于作为 HTTP 头部信息进行发送。默认包含所有属性，除非给出 attrs 属性列表。header 默认为 "Set-Cookie:"。

Morsel.js_output(attrs=None)

返回一段可供嵌入的 JavaScript 代码，若在支持 JavaScript 的浏览器上运行，其作用如同发送 HTTP 头部信息一样。

attrs 的含义与 output() 的相同。

Morsel.OutputString(attrs=None)

返回 morsel 的字符串形式，不含 HTTP 或 JavaScript 数据。

attrs 的含义与 output() 的相同。

Morsel.update(values)

用字典 values 中的值更新 morsel 字典中的值。若有 values 字典中的键不是有效的 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] 属性，则会触发错误。

在 3.5 版更改: 无效键会触发错误。

Morsel.copy(value)

返回 morsel 对象的浅表复制副本。

在 3.5 版更改: 返回一个 morsel 对象，而非字典。

Morsel.setdefault(key, value=None)

若 key 不是有效的 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] 属性则触发错误，否则与 dict.setdefault() 相同。

示例

以下例子演示了 http.cookies 模块的用法。

>>> from http import cookies
>>> C = cookies.SimpleCookie()
>>> C["fig"] = "newton"
>>> C["sugar"] = "wafer"
>>> print(C) # generate HTTP headers
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> print(C.output()) # same thing
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") # load from a string (HTTP header)
>>> 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 # equivalent to 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

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

源代码： Lib/http/cookiejar.py [https://github.com/python/cpython/tree/3.10/Lib/http/cookiejar.py]

http.cookiejar 模块定义了用于自动处理 HTTP cookie 的类。这对访问需要小段数据 —— cookies 的网站很有用，这些数据由 Web 服务器的 HTTP 响应在客户端计算机上设置，然后在以后的 HTTP 请求中返回给服务器。

常规的 Netscape cookie 协议和由 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 定义的协议都可以被处理。 RFC 2965 的处理默认是关闭的。 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] cookie 被解析为 Netscape cookie ，随后根据当前使用的 "策略"，被视为 Netscape 或 RFC 2965 cookie。http.cookiejar 试图遵循事实上的 Netscape cookie 协议（它与原始Netscape规范中的协议有很大不同），包括注意到 RFC 2965 中引入的 max-age 和 port cookie 属性。

注解

在 Set-Cookie 和 Set-Cookie2 头中找到的各种命名参数通常指 attributes。为了不与 Python 属性相混淆，模块文档使用 cookie-attribute 代替。

此模块定义了以下异常：

exception http.cookiejar.LoadError

FileCookieJar 实例在从文件加载 cookies 出错时抛出这个异常。 LoadError 是 OSError 的一个子类。

在 3.3 版更改: LoadError 成为 OSError 的子类而不是 IOError。

提供了以下类：

class http.cookiejar.CookieJar(policy=None)

policy 是实现了 CookiePolicy 接口的一个对象。

CookieJar 类储存 HTTP cookies。它从 HTTP 请求提取 cookies，并在 HTTP 响应中返回它们。 CookieJar 实例在必要时自动处理包含 cookie 的到期情况。子类还负责储存和从文件或数据库中查找 cookies。

class http.cookiejar.FileCookieJar(filename=None, delayload=None, policy=None)

policy 是实现了 CookiePolicy 接口的一个对象。对于其他参数，参考相应属性的文档。

一个可以从硬盘中文件加载或保存 cookie 的 CookieJar。 Cookies 不 会在 load() 或 revert() 方法调用前从命名的文件中加载。子类的文档位于段落 FileCookieJar 的子类及其与 Web 浏览器的协同。

此类不应被直接初始化 —— 请改用它的下列子类。

在 3.8 版更改: 文件名形参支持 path-like object。

class http.cookiejar.CookiePolicy

此类负责确定是否应从服务器接受每个 cookie 或将其返回给服务器。

class 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 如果不是 None，则是仅有的我们会接受或返回的域名序列。secure_protocols 是可以添加安全 cookies 的协议序列。默认将 https 和 wss （安全 WebSocket）考虑为安全协议。对于其他参数，参考 CookiePolicy 和 DefaultCookiePolicy 对象的文档。

DefaultCookiePolicy 实现了 Netscape 和 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] cookies 的标准接受 / 拒绝规则。 默认情况下，RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] cookies（即在 Set-Cookie 头中收到的 cookie-attribute 版本为 1 的 cookies ）将按照 RFC 2965 规则处理。 然而，如果 RFC 2965 的处理被关闭，或者 rfc2109_as_netscape 为 True，Cookie 实例的 version 属性设置将被为 0， RFC 2109 cookies CookieJar 实例将 "降级" 为 Netscape cookies。 DefaultCookiePolicy 也提供一些参数以允许一些策略微调。

class http.cookiejar.Cookie

这个类代表 Netscape、RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] 和 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 的 cookie 。 我们不希望 http.cookiejar 的用户构建他们自己的 Cookie 实例。 如果有必要，请在一个 CookieJar 实例上调用 make_cookies() 。

参见

模块 urllib.request

URL 打开带有自动的 cookie 处理。

模块 http.cookies

HTTP cookie类，主要是对服务端代码有用。 http.cookiejar 和 http.cookies 模块不相互依赖。

https://curl.se/rfc/cookie_spec.html

原始 Netscape cookie 协议的规范。 虽然这仍然是主流协议，但所有主要浏览器（以及 http.cookiejar ）实现的 "Netscape cookie协议" 与 cookie_spec.html 中描述的协议仅有几分相似之处。

RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] - HTTP状态管理机制

被 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 所取代。使用 Set-Cookie version=1 。

RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] - HTTP状态管理机制

修正了错误的 Netscape 协议。 使用 Set-Cookie2 来代替 Set-Cookie 。 没有广泛被使用。

http://kristol.org/cookie/errata.html

未完成的 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 勘误表。

RFC 2964 [https://datatracker.ietf.org/doc/html/rfc2964.html] - HTTP状态管理使用方法

CookieJar 和 FileCookieJar 对象

CookieJar 对象支持 iterator 协议，用于迭代包含的 Cookie 对象。

CookieJar 有以下方法：

CookieJar.add_cookie_header(request)

在 request 中添加正确的 Cookie 头。

如果策略允许（即 rfc2965 和 hide_cookie2 属性在 CookieJar 的 CookiePolicy 实例中分别为 True 和 False ）， Cookie2 标头也会在适当时候添加。

如 urllib.request 文档所言 request 对象（通常是 urllib.request.Request 的实例）必须支持 get_full_url(), has_header(), get_header(), header_items(), add_unredirected_header() 等方法以及 host, type, unverifiable 和 origin_req_host 等属性。

在 3.3 版更改: request 对象需要 origin_req_host 属性。对已废弃的方法 get_origin_req_host() 的依赖已被移除。

CookieJar.extract_cookies(response, request)

从HTTP response 中提取 cookie，并在政策允许的情况下，将它们存储在 CookieJar 中。

CookieJar 将 在*response* 参数中寻找允许的 Set-Cookie 和 Set-Cookie2 头信息，并适当地存储cookies（须经 CookiePolicy.set_ok() 方法批准）。

response 对象（通常是调用 urllib.request.urlopen() 或类似方法的结果）应该支持 info() 方法，它返回 email.message.Message 实例。

如 urllib.request 文档所言 request 对象（通常是 urllib.request.Request 的实例）必须支持 get_full_url() 方法以及 host, unverifiable 和 origin_req_host 等属性。 该请求被用于设置 cookie-attributes 的默认值并检查 cookie 是否允许被设置。

在 3.3 版更改: request 对象需要 origin_req_host 属性。对已废弃的方法 get_origin_req_host() 的依赖已被移除。

CookieJar.set_policy(policy)

设置要使用的 CookiePolicy 实例。

CookieJar.make_cookies(response, request)

返回从 response 对象中提取的 Cookie 对象的序列。

关于 response 和 request 参数所需的接口，请参见 extract_cookies() 的文档。

CookieJar.set_cookie_if_ok(cookie, request)

如果策略规定可以这样做，就设置一个 Cookie 。

CookieJar.set_cookie(cookie)

设置一个 Cookie，不需要检查策略是否应该被设置。

CookieJar.clear([domain[, path[, name]]])

清除一些cookie。

如果调用时没有参数，则清除所有的cookie。 如果给定一个参数，只有属于该 domain 的cookies将被删除。如果给定两个参数，那么属于指定的 domain 和 URL path 的cookie将被删除。 如果给定三个参数，那么属于指定的 domain 、path 和 name 的cookie将被删除

如果不存在匹配的 cookie，则会引发 KeyError。

CookieJar.clear_session_cookies()

丢弃所有的会话 cookie。

丢弃所有 discard 属性为真值的已包含 cookie（通常是因为它们没有 max-age 或 expires cookie 属性，或者显式的 discard cookie 属性）。 对于交互式浏览器，会话的结束通常对应于关闭浏览器窗口。

请注意 save() 方法并不会保存会话的 cookie，除非你通过传入一个真值给 ignore_discard 参数来提出明确的要求。

FileCookieJar 实现了下列附加方法:

FileCookieJar.save(filename=None, ignore_discard=False, ignore_expires=False)

将 cookie 保存到文件。

基类会引发 NotImplementedError。 子类可以继续不实现该方法。

filename 为要用来保存 cookie 的文件名称。 如果未指定 filename，则会使用 self.filename (该属性默认为传给构造器的值，如果有传入的话)；如果 self.filename 为 None，则会引发 ValueError。

ignore_discard: 即使设定了丢弃 cookie 仍然保存它们。 ignore_expires: 即使 cookie 已超期仍然保存它们

文件如果已存在则会被覆盖，这将清除其所包含的全部 cookie。 已保存的 cookie 可以使用 load() 或 revert() 方法来恢复。

FileCookieJar.load(filename=None, ignore_discard=False, ignore_expires=False)

从文件加载 cookie。

旧的 cookie 将被保留，除非是被新加载的 cookie 所覆盖。

其参数与 save() 的相同。

指定的文件必须为该类所能理解的格式，否则将引发 LoadError。 也可能会引发 OSError，例如当文件不存在的时候。

在 3.3 版更改: 过去触发的 IOError，现在是 OSError 的别名。

FileCookieJar.revert(filename=None, ignore_discard=False, ignore_expires=False)

清除所有 cookie 并从保存的文件重新加载 cookie。

revert() 可以引发与 load() 相同的异常。 如果执行失败，对象的状态将不会被改变。

FileCookieJar 实例具有下列公有属性:

FileCookieJar.filename

默认的保存 cookie 的文件的文件名。 该属性可以被赋值。

FileCookieJar.delayload

如为真值，则惰性地从磁盘加载 cookie。 该属性不应当被赋值。 这只是一个提示，因为它只会影响性能，而不会影响行为（除非磁盘中的 cookie 被改变了）。 CookieJar 对象可能会忽略它。 任何包括在标准库中的 FileCookieJar 类都不会惰性地加载 cookie。

FileCookieJar 的子类及其与 Web 浏览器的协同

提供了以下 CookieJar 子类用于读取和写入。

class http.cookiejar.MozillaCookieJar(filename=None, delayload=None, policy=None)

一个能够以 Mozilla cookies.txt 文件格式（该格式也被 curl 和 Lynx 以及 Netscape 浏览器所使用）从硬盘加载和存储 cookie 的 FileCookieJar。

注解

这会丢失有关 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] cookie 的信息，以及有关较新或非标准的 cookie 属性例如 port。

警告

在存储之前备份你的 cookie，如果你的 cookie 丢失/损坏会造成麻烦的话（有一些微妙的因素可能导致文件在加载/保存的往返过程中发生细微的变化）。

还要注意在 Mozilla 运行期间保存的 cookie 将可能被 Mozilla 清除。

class http.cookiejar.LWPCookieJar(filename=None, delayload=None, policy=None)

一个能够以 libwww-perl 库的 Set-Cookie3 文件格式从磁盘加载和存储 cookie 的 FileCookieJar。 这适用于当你想以人类可读的文件来保存 cookie 的情况。

在 3.8 版更改: 文件名形参支持 path-like object。

CookiePolicy 对象

实现了 CookiePolicy 接口的对象具有下列方法:

CookiePolicy.set_ok(cookie, request)

返回指明是否应当从服务器接受 cookie 的布尔值。

cookie 是一个 Cookie 实例。 request 是一个实现了由 CookieJar.extract_cookies() 的文档所定义的接口的对象。

CookiePolicy.return_ok(cookie, request)

返回指明是否应当将 cookie 返回给服务器的布尔值。

cookie 是一个 Cookie 实例。 request 是一个实现了 CookieJar.add_cookie_header() 的文档所定义的接口的对象。

CookiePolicy.domain_return_ok(domain, request)

对于给定的 cookie 域如果不应当返回 cookie 则返回 False。

此方法是一种优化操作。 它消除了检查每个具有特定域的 cookie 的必要性（这可能会涉及读取许多文件）。 从 domain_return_ok() 和 path_return_ok() 返回真值并将所有工作留给 return_ok()。

如果 domain_return_ok() 为 cookie 域返回真值，则会为 cookie 路径调用 path_return_ok()。 在其他情况下，则不会为该 cookie 域调用 path_return_ok() 和 return_ok()。 如果 path_return_ok() 返回真值，则会调用 return_ok() 并附带 Cookie 对象本身以进行全面检查。 在其他情况下，都永远不会为该 cookie 路径调用 return_ok()。

请注意 domain_return_ok() 会针对每个 cookie 域被调用，而非只针对 request 域。 例如，该函数会针对 ".example.com" 和 "www.example.com" 被调用，如果 request 域为 "www.example.com" 的话。 对于 path_return_ok() 也是如此。

request 参数与 return_ok() 的文档所说明的一致。

CookiePolicy.path_return_ok(path, request)

对于给定的 cookie 路径如果不应当返回 cookie 返回 False。

请参阅 domain_return_ok() 的文档。

除了实现上述方法，CookiePolicy 接口的实现还必须提供下列属性，指明应当使用哪种协议以及如何使用。 所有这些属性都可以被赋值。

CookiePolicy.netscape

实现 Netscape 协议。

CookiePolicy.rfc2965

实现 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 协议。

CookiePolicy.hide_cookie2

不要向请求添加 Cookie2 标头（此标头是提示服务器请求方能识别 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] cookie）。

定义 CookiePolicy 类的最适用方式是通过子类化 DefaultCookiePolicy 并重写部分或全部上述的方法。 CookiePolicy 本身可被用作 '空策略' 以允许设置和接收所有的 cookie（但这没有什么用处）。

DefaultCookiePolicy 对象

实现接收和返回 cookie 的标准规则。

RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 和 Netscape cookie 均被涵盖。 RFC 2965 处理默认关闭。

提供自定义策略的最容易方式是重写此类并在你重写的实现中添加你自己的额外检查之前调用其方法:

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

在实现 CookiePolicy 接口所要求的特性之外，该类还允许你阻止和允许特定的域设置和接收 cookie。 还有一些严格性开关允许你将相当宽松的 Netscape 协议规则收紧一点（代价是可能会阻止某些无害的 cookie）。

提供了域阻止名单和允许名单（默认都是关闭的）。 只有不存在于阻止列表且存在于允许列表（如果允许名单被启用）的域才能参与 cookie 的设置与返回。 请使用 blocked_domains 构造器参数，以及 blocked_domains() 和 set_blocked_domains() 方法（以及and the corresponding argument and methods for allowed_domains 的相应参数和方法）。 如果你设置了允许名单，你可以通过将其设为 None 来关闭它。

阻止名单或允许名单中不以点号开头的域名必须与要匹配的 cookie 域完全相等。 例如， "example.com" 将匹配阻止名单条目 "example.com"，但不匹配 "www.example.com"。 以点号开头的域名也能与更明确的域相匹配。 例如，"www.example.com" 和 "www.coyote.example.com" 将匹配 ".example.com" (但不匹配 "example.com" 本身)。 IP 地址不在此例，而是必须完全匹配。 例如，如果 blocked_domains 包含 "192.168.1.2" 和 ".168.1.2"，则会阻止 192.168.1.2，但不会阻止 193.168.1.2。

DefaultCookiePolicy 实现了下列附加方法:

DefaultCookiePolicy.blocked_domains()

返回被阻止域的序列（元组类型）。

DefaultCookiePolicy.set_blocked_domains(blocked_domains)

设置被阻止域的序列。

DefaultCookiePolicy.is_blocked(domain)

返回 domain 是否在设置或接收 cookie 的阻止名单上。

DefaultCookiePolicy.allowed_domains()

返回 None，或者被允许域的序列（元组类型）。

DefaultCookiePolicy.set_allowed_domains(allowed_domains)

设置被允许域的序列，或者为 None。

DefaultCookiePolicy.is_not_allowed(domain)

返回 domain 是否在设置或接收 cookie 的允许名单上。

DefaultCookiePolicy 实例具有下列属性，它们都是基于同名的构造器参数来初始化的，并且都可以被赋值。

DefaultCookiePolicy.rfc2109_as_netscape

如为真值，则请求 CookieJar 实例将 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] cookie (即在带有 version 值为 1 的 cookie 属性的 Set-Cookie 标头中接收到的 cookie) 降级为 Netscape cookie: 即将 Cookie 实例的 version 属性设为 0。 默认值为 None，在此情况下 RFC 2109 cookie 仅在s are downgraded if and only if RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 处理被关闭时才会被降级。 因此，RFC 2109 cookie 默认会被降级。

通用严格性开关:

DefaultCookiePolicy.strict_domain

不允许网站设置带国家码顶级域的包含两部分的域名例如 .co.uk, .gov.uk, .co.nz 等。 此开关尚未十分完善，并不保证有效！

RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 协议严格性开关:

DefaultCookiePolicy.strict_rfc2965_unverifiable

遵循针对不可验证事务的 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 规则（不可验证事务通常是由重定向或请求发布在其它网站的图片导致的）。 如果该属性为假值，则 永远不会 基于可验证性而阻止 cookie。

Netscape 协议严格性开关:

DefaultCookiePolicy.strict_ns_unverifiable

即便是对 Netscape cookie 也要应用 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 规则。

DefaultCookiePolicy.strict_ns_domain

指明针对 Netscape cookie 的域匹配规则的严格程度。 可接受的值见下文。

DefaultCookiePolicy.strict_ns_set_initial_dollar

忽略 Set-Cookie 中的 cookie: 即名称前缀为 '{TX-PL-LABEL}#x27; 的标头。

DefaultCookiePolicy.strict_ns_set_path

不允许设置路径与请求 URL 路径不匹配的 cookie。

strict_ns_domain 是一组旗标。 其值是通过或运算来构造的（例如，DomainStrictNoDots|DomainStrictNonDomain 表示同时设置两个旗标）。

DefaultCookiePolicy.DomainStrictNoDots

当设置 cookie 时，'host prefix' 不可包含点号（例如 www.foo.bar.com 不能为 .bar.com 设置 cookie，因为 www.foo 包含了一个点号）。

DefaultCookiePolicy.DomainStrictNonDomain

没有显式指明Cookies that did not explicitly specify a domain cookie 属性的 cookie 只能被返回给与设置 cookie 的域相同的域（例如 spam.example.com 不会是来自 example.com 的返回 cookie，如果该域名没有 domain cookie 属性的话）。

DefaultCookiePolicy.DomainRFC2965Match

当设置 cookie 时，要求完整的 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 域匹配。

下列属性是为方便使用而提供的，是上述旗标的几种最常用组合:

DefaultCookiePolicy.DomainLiberal

等价于 0 (即所有上述 Netscape 域严格性旗标均停用)。

DefaultCookiePolicy.DomainStrict

等价于 DomainStrictNoDots|DomainStrictNonDomain。

Cookie 对象

Cookie 实例具有与各种 cookie 标准中定义的标准 cookie 属性大致对应的 Python 属性。 这并非一一对应，因为存在复杂的赋默认值的规则，因为 max-age 和 expires cookie 属性包含相同信息，也因为 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] cookie 可以被 http.cookiejar 从第 1 版 '降级为' 第 0 版 (Netscape) cookie。

对这些属性的赋值在 CookiePolicy 方法的极少数情况以外应该都是不必要的。 该类不会强制内部一致性，因此如果这样做则你应当清楚自己在做什么。

Cookie.version

整数或 None。 Netscape cookie 的 version 值为 0。 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] 和 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] cookie 的 version cookie 属性值为 1。 但是，请注意 http.cookiejar 可以将 RFC 2109 cookie '降级' 为 Netscape cookie，在此情况下 version 值也为 0。

Cookie.name

Cookie 名称（一个字符串）。

Cookie.value

Cookie 值（一个字符串），或为 None。

Cookie.port

代表一个端口或一组端口（例如 '80' 或 '80,8080'）的字符串，或为 None。

Cookie.path

Cookie 路径 (字符串类型，例如 '/acme/rocket_launchers')。

Cookie.secure

如果 cookie 应当只能通过安全连接返回则为 True。

Cookie.expires

整数类型的过期时间，以距离 Unix 纪元的秒数表示，或者为 None。 另请参阅 is_expired() 方法。

Cookie.discard

如果是会话 cookie 则为 True。

Cookie.comment

来自服务器的解释此 cookie 功能的字符串形式的注释，或者为 None。

Cookie.comment_url

链接到来自服务器的解释此 cookie 功能的注释的 URL，或者为 None。

Cookie.rfc2109

如果 cookie 是作为 RFC 2109 [https://datatracker.ietf.org/doc/html/rfc2109.html] cookie 被接收（即该 cookie 是在 Set-Cookie 标头中送达，且该标头的 Version cookie 属性的值为 1）则为 True。 之所以要提供该属性是因为 http.cookiejar 可能会从 RFC 2109 cookies '降级' 为 Netscape cookie，在此情况下 version 值为 0。

Cookie.port_specified

如果服务器显式地指定了一个端口或一组端口（在 Set-Cookie / Set-Cookie2 标头中）则为 True。

Cookie.domain_specified

如果服务器显式地指定了一个域则为 True。

Cookie.domain_initial_dot

该属性为 True 表示服务器显式地指定了以一个点号 ('.') 打头的域。

Cookie 可能还有额外的非标准 cookie 属性。 这些属性可以通过下列方法来访问:

Cookie.has_nonstandard_attr(name)

如果 cookie 具有相应名称的 cookie 属性则返回 True。

Cookie.get_nonstandard_attr(name, default=None)

如果 cookie 具有相应名称的 cookie 属性，则返回其值。 否则，返回 default。

Cookie.set_nonstandard_attr(name, value)

设置指定名称的 cookie 属性的值。

Cookie 类还定义了下列方法:

Cookie.is_expired(now=None)

如果 cookie 传入了服务器请求其所应过期的时间则为 True。 如果给出 now 值（距离 Unix 纪元的秒数），则返回在指定的时间 cookie 是否已过期。

例子

第一个例子显示了 http.cookiejar 的最常见用法:

import http.cookiejar, urllib.request
cj = http.cookiejar.CookieJar()
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")

这个例子演示了如何使用你的 Netscape, Mozilla 或 Lynx cookie 打开一个 URL (假定 cookie 文件位置采用 Unix/Netscape 惯例):

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/")

下一个例子演示了 DefaultCookiePolicy 的使用。 启用 RFC 2965 [https://datatracker.ietf.org/doc/html/rfc2965.html] cookie，在设置和返回 Netscape cookie 时更严格地限制域，以及阻止某些域设置 cookie 或返回它们:

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/")

xmlrpc --- XMLRPC 服务端与客户端模块

XML-RPC 是一种远程过程调用方法，它使用通过 HTTP 传递的 XML 作为载体。 有了它，客户端可以在远程服务器上调用带参数的方法（服务器以 URI 命名）并获取结构化的数据。

xmlrpc 是一个集合了 XML-RPC 服务端与客户端实现模块的包。 这些模块是:

xmlrpc.client

xmlrpc.server

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

源代码: Lib/xmlrpc/client.py [https://github.com/python/cpython/tree/3.10/Lib/xmlrpc/client.py]

XML-RPC 是一种远程过程调用方法，它以使用 HTTP(S) 传递的 XML 作为载体。 通过它，客户端可以在远程服务器（服务器以 URI 指明）上调用带参数的方法并获取结构化的数据。 本模块支持编写 XML-RPC 客户端代码；它会处理在通用 Python 对象和 XML 之间进行在线翻译的所有细节。

警告

xmlrpc.client 模块对于恶意构建的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

在 3.5 版更改: 对于 HTTPS URI，现在 xmlrpc.client 默认会执行所有必要的证书和主机名检查。

class xmlrpc.client.ServerProxy(uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False, use_builtin_types=False, *, headers=(), context=None)

ServerProxy 实例是管理与远程 XML-RPC 服务器通信的对象。 要求的第一个参数为 URI (统一资源定位符)，通常就是服务器的 URL。 可选的第二个参数为传输工厂实例；在默认情况下对于 https: URL 是一个内部 SafeTransport 实例，在其他情况下则是一个内部 HTTP Transport 实例。 可选的第三个参数为编码格式，默认为 UTF-8。 可选的第四个参数为调试旗标。

下列形参控制所返回代理实例的使用。 如果 allow_none 为真值，则 Python 常量 None 将被转写至 XML；默认行为是针对 None 引发 TypeError。 这是对 XML-RPC 规格的一个常用扩展，但并不被所有客户端和服务器所支持；请参阅 http://ontosys.com/xml-rpc/extensions.php [https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php] 了解详情。 use_builtin_types 旗标可被用来将日期/时间值表示为 datetime.datetime 对象而将二进制数据表示为 bytes 对象；此旗标默认为假值。 datetime.datetime, bytes 和 bytearray 对象可以被传给调用操作。 headers 形参为可选的随每次请求发送的 HTTP 标头序列，其形式为包含代表标头名称和值的二元组序列 (例如 [('Header-Name', 'value')])。 已淘汰的 use_datetime 旗标与 use_builtin_types 类似但它只针对日期/时间值。

在 3.3 版更改: 增加了 use_builtin_types 旗标。

在 3.8 版更改: 增加了 headers 形参。

HTTP 和 HTTPS 传输均支持用于 HTTP 基本身份验证的 URL 语法扩展: http://user:pass@host:port/path。 user:pass 部分将以 base64 编码为 HTTP 'Authorization' 标头，并在唤起 XML-RPC 方法时作为连接过程的一部分发送给远程服务器。 你只需要在远程服务器要求基本身份验证账号和密码时使用此语法。 如果提供了 HTTPS URL，context 可以为 ssl.SSLContext 并配置有下层 HTTPS 连接的 SSL 设置。

返回的实例是一个代理对象，具有可被用来在远程服务器上发起相应 RPC 调用的方法。 如果远程服务器支持内省 API，则也可使用该代理对象在远程服务器上查询它所支持的方法（服务发现）并获取其他服务器相关的元数据

适用的类型（即可通过 XML 生成 marshall 对象），包括如下类型（除了已说明的例外，它们都会被反 marshall 为同样的 Python 类型）:

XML-RPC类型 | Python 类型
boolean | bool
int, i1, i2, i4, i8 或者 biginteger | int 的范围从 -2147483648 到 2147483647。值将获得 <int> 标志。
double 或 float | float。值将获得 <double> 标志。
string | str
array | list 或 tuple 包含整合元素。数组以 lists 形式返回。
struct | dict。 键必须为字符串，值可以为任何适用的类型。 可以传入用户自定义类的对象；只有其 __dict__ 属性会被传输。
dateTime.iso8601 | DateTime 或 datetime.datetime。返回的类型取决于 use_builtin_types 和 use_datetime 标志的值。
base64 | Binary, bytes 或 bytearray。返回的类型取决于 use_builtin_types 标志的值。
nil | None 常量。仅当 allow_none 为true时才允许传递。
bigdecimal | decimal.Decimal. 仅返回类型。

这是This is the full set of data types supported by XML-RPC 所支持数据类型的完整集合。 方法调用也可能引发一个特殊的 Fault 实例，用来提示 XML-RPC 服务器错误，或是用 ProtocolError 来提示 HTTP/HTTPS 传输层中的错误。 Fault 和 ProtocolError 都派生自名为 Error 的基类。 请注意 xmlrpc client 模块目前不可 marshal 内置类型的子类的实例。

当传入字符串时，XML 中的特殊字符如 <, > 和 & 将被自动转义。 但是，调用方有责任确保字符串中没有 XML 中不允许的字符，例如 ASCII 值在 0 和 31 之间的控制字符（当然，制表、换行和回车除外）；不这样做将导致 XML-RPC 请求的 XML 格式不正确。 如果你必须通过 XML-RPC 传入任意字节数据，请使用 bytes 或 bytearray 类或者下文描述的 Binary 包装器类。

Server 被保留作为 ServerProxy 的别名用于向下兼容。 新的代码应当使用 ServerProxy。

在 3.5 版更改: 增加了 context 参数。

在 3.6 版更改: 增加了对带有前缀的类型标签的支持 (例如 ex:nil)。 增加了对反 marshall 被 Apache XML-RPC 实现用于表示数值的附加类型的支持: i1, i2, i8, biginteger, float 和 bigdecimal。 请参阅 https://ws.apache.org/xmlrpc/types.html 了解详情。

参见

XML-RPC HOWTO [https://www.tldp.org/HOWTO/XML-RPC-HOWTO/index.html]

以多种语言对 XML-RPC 操作和客户端软件进行了很好的说明。 包含 XML-RPC 客户端开发者所需知道的几乎任何事情。

XML-RPC Introspection [https://xmlrpc-c.sourceforge.net/introspection.html]

描述了用于内省的 XML-RPC 协议扩展。

XML-RPC Specification [http://xmlrpc.scripting.com/spec.html]

官方规范说明。

ServerProxy 对象

ServerProxy 实例有一个方法与 XML-RPC 服务器所接受的每个远程过程调用相对应。 调用该方法会执行一个 RPC，通过名称和参数签名来调度（例如同一个方法名可通过多个参数签名来重载）。 RPC 结束时返回一个值，它可以是适用类型的返回数据或是表示错误的 Fault 或 ProtocolError 对象。

支持 XML 内省 API 的服务器还支持一些以保留的 system 属性分组的通用方法:

ServerProxy.system.listMethods()

此方法返回一个字符串列表，每个字符串都各自对应 XML-RPC 服务器所支持的（非系统）方法。

ServerProxy.system.methodSignature(name)

此方法接受一个形参，即某个由 XML-RPC 服务器所实现的方法名称。 它返回一个由此方法可能的签名组成的数组。 一个签名就是一个类型数组。 这些类型中的第一个是方法的的返回类型，其余的均为形参。

由于允许多个签名（即重载），此方法是返回一个签名列表而非一个单例。

签名本身被限制为一个方法所期望的最高层级形参。 举例来说如果一个方法期望有一个结构体数组作为形参，并返回一个字符串，则其签名就是 "string, array"。 如果它期望有三个整数并返回一个字符串，则其签名是 "string, int, int, int"。

如果方法没有定义任何签名，则将返回一个非数组值。 在 Python 中这意味着返回值的类型为列表以外的类型。

ServerProxy.system.methodHelp(name)

此方法接受一个形参，即 XML-RPC 服务器所实现的某个方法的名称。 它返回描述相应方法用法的文档字符串。 如果没有可用的文档字符串，则返回空字符串。 文档字符串可以包含 HTML 标记。

在 3.5 版更改: ServerProxy 的实例支持 context manager 协议用于关闭下层传输。

以下是一个可运行的示例。 服务器端代码:

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()

前述服务器的客户端代码:

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)))

DateTime 对象

class xmlrpc.client.DateTime

该类的初始化可以使用距离 Unix 纪元的秒数、时间元组、ISO 8601 时间/日期字符串或 datetime.datetime 实例。 它具有下列方法，主要是为 marshall 和反 marshall 代码的内部使用提供支持:

decode(string)

接受一个字符串作为实例的新时间值。

encode(out)

将此 DateTime 条目的 XML-RPC 编码格式写入到 out 流对象。

它还通过富比较和 __repr__() 方法来支持某些 Python 内置运算符。

以下是一个可运行的示例。 服务器端代码:

import datetime
from xmlrpc.server import SimpleXMLRPCServer
import xmlrpc.client

def today():
    today = datetime.datetime.today()
    return xmlrpc.client.DateTime(today)

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(today, "today")
server.serve_forever()

前述服务器的客户端代码:

import xmlrpc.client
import datetime

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")

today = proxy.today()
# convert the ISO8601 string to a datetime object
converted = datetime.datetime.strptime(today.value, "%Y%m%dT%H:%M:%S")
print("Today: %s" % converted.strftime("%d.%m.%Y, %H:%M"))

Binary 对象

class xmlrpc.client.Binary

该类的初始化可以使用字节数据（可包括 NUL）。 对 Binary 对象的初始访问是由一个属性来提供的:

data

被 Binary 实例封装的二进制数据。 该数据以 bytes 对象的形式提供。

Binary 对象具有下列方法，支持这些方法主要是供 marshall 和反 marshall 代码在内部使用:

decode(bytes)

接受一个 base64 bytes 对象并将其解码为实例的新数据。

encode(out)

将此二进制条目的 XML-RPC base 64 编码格式写入到 out 流对象。

被编码数据将依据 RFC 2045 第 6.8 节 [https://datatracker.ietf.org/doc/html/rfc2045.html#section-6.8] 每 76 个字符换行一次，这是撰写 XML-RPC 规范说明时 base64 规范的事实标准。

它还通过 __eq__() 和 __ne__() 方法来支持某些 Python 内置运算符。

该二进制对象的示例用法。 我们将通过 XMLRPC 来传输一张图片:

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()

客户端会获取图片并将其保存为一个文件:

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)

Fault 对象

class xmlrpc.client.Fault

Fault 对象封装了 XML-RPC fault 标签的内容。 Fault 对象具有下列属性:

faultCode

一个指明 fault 类型的整数。

faultString

一个包含与 fault 相关联的诊断消息的字符串。

在接下来的示例中我们将通过返回一个复数类型的值来故意引发一个 Fault。 服务器端代码:

from xmlrpc.server import SimpleXMLRPCServer

# A marshalling error is going to occur because we're returning a
# complex number
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()

前述服务器的客户端代码:

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)

ProtocolError 对象

class xmlrpc.client.ProtocolError

ProtocolError 对象描述了下层传输层中的协议错误（例如当 URI 所指定的服务器不存在时的 404 'not found' 错误）。 它具有下列属性:

url

触发错误的 URI 或 URL。

errcode

错误代码。

errmsg

错误消息或诊断字符串。

headers

一个包含触发错误的 HTTP/HTTPS 请求的标头的字典。

在接下来的示例中我们将通过提供一个无效的 URI 来故意引发一个 ProtocolError:

import xmlrpc.client

# create a ServerProxy with a URI that doesn't respond to XMLRPC requests
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)

MultiCall 对象

MultiCall 对象提供了一种将对远程服务器的多个调用封装为一个单独请求的方式 1。

class xmlrpc.client.MultiCall(server)

创建一个用于盒式方法调用的对象。 server 是调用的最终目标。 可以针对结果对象被唤起，但它们将立即返回 None，并只在 MultiCall 对象中存储调用名称和形参。 调用该对象本身会导致所有已存储的调用作为一个单独的 system.multicall 请求被发送。 此调用的结果是一个 generator；迭代这个生成器会产生各个结果。

以下是该类的用法示例。 服务器端代码:

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

# A simple server with simple arithmetic functions
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()

前述服务器的客户端代码:

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))

便捷函数

xmlrpc.client.dumps(params, methodname=None, methodresponse=None, encoding=None, allow_none=False)

请 params 转换为一个 XML-RPC 请求。 或者当 methodresponse 为真值时则转换为一个请求。 params 可以是一个参数元组或是一个 Fault 异常类的实例。 如果 methodresponse 为真值，只有单独的值可以被返回，这意味着 params 的长度必须为 1。 如果提供了 encoding，则在生成的 XML 会使用该编码格式；默认的编码格式为 UTF-8。 Python 的 None 值不可在标准 XML-RPC 中使用；要通过扩展来允许使用它，请为 allow_none 提供一个真值。

xmlrpc.client.loads(data, use_datetime=False, use_builtin_types=False)

将一个 XML-RPC 请求或响应转换为 Python 对象 (params, methodname)。 params 是一个参数元组；methodname 是一个字符串，或者如果数据包没有提供方法名则为 None。 如果 XML-RPC 数据包是代表一个故障条件，则此函数将引发一个 Fault 异常。 use_builtin_types 旗标可被用于将日期/时间值表示为 datetime.datetime 对象并将二进制数据表示为 bytes 对象；此旗标默认为假值。

已过时的 use_datetime 旗标与 use_builtin_types 类似但只作用于日期/时间值。

在 3.3 版更改: 增加了 use_builtin_types 旗标。

客户端用法的示例

# simple test program (from the XML-RPC specification)
from xmlrpc.client import ServerProxy, Error

# server = ServerProxy("http://localhost:8000") # local server
with ServerProxy("http://betty.userland.com") as proxy:

    print(proxy)

    try:
        print(proxy.examples.getStateName(41))
    except Error as v:
        print("ERROR", v)

要通过 HTTP 代理访问一个 XML-RPC 服务器，你必须自行定义一个传输。 下面的例子演示了具体做法:

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))

客户端与服务器用法的示例

参见 SimpleXMLRPCServer 示例。

备注

1

此做法被首次提及是在 a discussion on xmlrpc.com [https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic]。

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

源代码: Lib/xmlrpc/server.py [https://github.com/python/cpython/tree/3.10/Lib/xmlrpc/server.py]

xmlrpc.server 模块为以 Python 编写 XML-RPC 服务器提供了一个基本服务器框架。 服务器可以是独立的，使用 SimpleXMLRPCServer，或是嵌入某个 CGI 环境中，使用 CGIXMLRPCRequestHandler。

警告

xmlrpc.server 模块对于恶意构建的数据是不安全的。 如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)

创建一个新的服务器实例。 这个类提供了一些用来注册可以被 XML-RPC 协议所调用的函数的方法。 requestHandler 形参应该是一个用于请求处理器实例的工厂函数；它默认为 SimpleXMLRPCRequestHandler。 addr 和 requestHandler 形参会被传给 socketserver.TCPServer 构造器。 如果 logRequests 为真值（默认），请求将被记录到日志；将此形参设为假值将关闭日志记录。 allow_none 和 encoding 形参会被传给 xmlrpc.client 并控制将从服务器返回的 XML-RPC 响应。 bind_and_activate 形参控制 server_bind() 和 server_activate() 是否会被构造器立即调用；它默认为真值。 将其设为假值将允许代码在地址被绑定之前操作 allow_reuse_address 类变量。 use_builtin_types 形参会被传给 loads() 函数并控制当收到日期/时间值或二进制数据时将处理哪些类型；它默认为假值。

在 3.3 版更改: 增加了 use_builtin_types 旗标。

class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)

创建一个新的实例来处理 CGI 环境中的 XML-RPC 请求。 allow_none 和 encoding 形参会被传递给 xmlrpc.client 并控制将要从服务器返回的 XML-RPC 响应。 use_builtin_types 形参会被传递给 loads() 函数并控制当接收到日期/时间值或二进制数据时要处理哪种类型；该形参默认为假值。

在 3.3 版更改: 增加了 use_builtin_types 旗标。

class xmlrpc.server.SimpleXMLRPCRequestHandler

创建一个新的请求处理器实例。 该请求处理器支持 POST 请求并会修改日志记录操作以便使用传递给 SimpleXMLRPCServer 构造器形参的 logRequests 形参。

SimpleXMLRPCServer 对象

SimpleXMLRPCServer 类是基于 socketserver.TCPServer 并提供了一个创建简单、独立的 XML-RPC 服务器的方式。

SimpleXMLRPCServer.register_function(function=None, name=None)

注册一个可以响应 XML-RPC 请求的函数。 如果给出了 name，则它将成为与 function 相关联的方法名，否则将使用 function.__name__。 name 是一个字符串，并可能包含不可在 Python 标识符中出现的字符，包括句点符。

此方法也可被用作装饰器。 当被用作装饰器时，name 只能被指定为以 name 注册的 function 的一个关键字参数。 如果没有指定 name，则将使用 function.__name__。

在 3.7 版更改: register_function() 可被用作装饰器。

SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)

注册一个被用来公开未使用 register_function() 注册的方法名的对象。 如果 instance 包含 _dispatch() 方法，它将被调用并附带被请求的方法名和来自请求的形参。 它的 API 是 def _dispatch(self, method, params) (请注意 params 并不表示变量参数列表)。 如果它调用了一个下层函数来执行任务，该函数将以 func(*params) 的形式被调用，即扩展了形参列表。 来自 _dispatch() 的返回值将作为结果被返回给客户端。 如果 instance 不包含 _dispatch() 方法，则会在其中搜索与被请求的方法名相匹配的属性。

如果可选的 allow_dotted_names 参数为真值且该实例没有 _dispatch() 方法，则如果被请求的方法名包含句点符，会单独搜索该方法名的每个组成部分，其效果就是执行了简单的分层级搜索。 通过搜索找到的值将随即附带来自请求的形参被调用，并且返回值会被回传给客户端。

警告

启用 allow_dotted_names 选项将允许入侵者访问你的模块的全局变量并可能允许入侵者在你的机器上执行任意代码。 仅可在安全、封闭的网络中使用此选项。

SimpleXMLRPCServer.register_introspection_functions()

注册 XML-RPC 内省函数 system.listMethods, system.methodHelp 和 system.methodSignature。

SimpleXMLRPCServer.register_multicall_functions()

注册 XML-RPC 多调用函数 system.multicall。

SimpleXMLRPCRequestHandler.rpc_paths

一个必须为元组类型的属性值，其中列出所接收 XML-RPC 请求的有效路径部分。 发送到其他路径的请求将导致 404 "no such page" HTTP 错误。 如果此元组为空，则所有路径都将被视为有效。 默认值为 ('/', '/RPC2')。

SimpleXMLRPCServer 示例

服务器端代码:

from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

# Restrict to a particular path.
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

# Create server
with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # Register pow() function; this will use the value of
    # pow.__name__ as the name, which is just 'pow'.
    server.register_function(pow)

    # Register a function under a different name
    def adder_function(x, y):
        return x + y
    server.register_function(adder_function, 'add')

    # Register an instance; all the methods of the instance are
    # published as XML-RPC methods (in this case, just 'mul').
    class MyFuncs:
        def mul(self, x, y):
            return x * y

    server.register_instance(MyFuncs())

    # Run the server's main loop
    server.serve_forever()

以下客户端代码将调用上述服务器所提供的方法:

import xmlrpc.client

s = xmlrpc.client.ServerProxy('http://localhost:8000')
print(s.pow(2,3))  # Returns 2**3 = 8
print(s.add(2,3))  # Returns 5
print(s.mul(5,2))  # Returns 5*2 = 10

# Print list of available methods
print(s.system.listMethods())

register_function() 也可被用作装饰器。 上述服务器端示例可以通过装饰器方式来注册函数:

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()

    # Register pow() function; this will use the value of
    # pow.__name__ as the name, which is just 'pow'.
    server.register_function(pow)

    # Register a function under a different name, using
    # register_function as a decorator. *name* can only be given
    # as a keyword argument.
    @server.register_function(name='add')
    def adder_function(x, y):
        return x + y

    # Register a function under function.__name__.
    @server.register_function
    def mul(x, y):
        return x * y

    server.serve_forever()

以下包括在 Lib/xmlrpc/server.py 模块中的例子演示了一个允许带点号名称并注册有多调用函数的服务器。

警告

启用 allow_dotted_names 选项将允许入侵者访问你的模块的全局变量并可能允许入侵者在你的机器上执行任意代码。 仅可在安全、封闭的网络中使用此示例。

import datetime

class ExampleService:
    def getData(self):
        return '42'

    class currentTime:
        @staticmethod
        def getCurrentTime():
            return datetime.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)

这个 ExampleService 演示程序可通过命令行来唤起:

python -m xmlrpc.server

可与上述服务器进行交互的客户端包括在 Lib/xmlrpc/client.py 中:

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)

这个可与示例 XMLRPC 服务器进行交互的客户端的启动方式如下:

python -m xmlrpc.client

CGIXMLRPCRequestHandler

CGIXMLRPCRequestHandler 类可被用来处理发送给 Python CGI 脚本的 XML-RPC 请求。

CGIXMLRPCRequestHandler.register_function(function=None, name=None)

注册一个可以响应 XML-RPC 请求的函数。 如果给出了 name，则它将成为与 function 相关联的方法名，否则将使用 function.__name__。 name 是一个字符串，并可能包含不可在 Python 标识符中出现的字符，包括句点符。

此方法也可被用作装饰器。 当被用作装饰器时，name 只能被指定为以 name 注册的 function 的一个关键字参数。 如果没有指定 name，则将使用 function.__name__。

在 3.7 版更改: register_function() 可被用作装饰器。

CGIXMLRPCRequestHandler.register_instance(instance)

注册一个对象用来公开未使用 register_function() 进行注册的方法名。 如果实例包含 _dispatch() 方法，它会附带所请求的方法名和来自请求的形参被调用；返回值会作为结果被返回给客户端。 如果实例不包含 _dispatch() 方法，则在其中搜索与所请求方法名相匹配的属性；如果所请求方法名包含句点，则会分别搜索方法名的每个部分，其效果就是执行了简单的层级搜索。 搜索找到的值将附带来自请求的形参被调用，其返回值会被返回给客户端。

CGIXMLRPCRequestHandler.register_introspection_functions()

注册 XML-RPC 内海函数 system.listMethods, system.methodHelp 和 system.methodSignature。

CGIXMLRPCRequestHandler.register_multicall_functions()

注册 XML-RPC 多调用函数 system.multicall。

CGIXMLRPCRequestHandler.handle_request(request_text=None)

处理一个 XML-RPC 请求。 如果给出了 request_text，它应当是 HTTP 服务器所提供的 POST 数据，否则将使用 stdin 的内容。

示例:

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()

文档 XMLRPC 服务器

这些类扩展了上面的类以发布响应 HTTP GET 请求的 HTML 文档。 服务器可以是独立的，使用 DocXMLRPCServer，或是嵌入某个 CGI 环境中，使用 DocCGIXMLRPCRequestHandler。

class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)

创建一个新的服务器实例。 所有形参的含义与 SimpleXMLRPCServer 的相同；requestHandler 默认为 DocXMLRPCRequestHandler。

在 3.3 版更改: 增加了 use_builtin_types 旗标。

class xmlrpc.server.DocCGIXMLRPCRequestHandler

创建一个新的实例来处理 CGI 环境中的 XML-RPC 请求。

class xmlrpc.server.DocXMLRPCRequestHandler

创建一个新的请求处理器实例。 该请求处理器支持 XML-RPC POST 请求、文档 GET 请求并会修改日志记录操作以便使用传递给 DocXMLRPCServer 构造器形参的 logRequests 形参。

DocXMLRPCServer 对象

DocXMLRPCServer 类派生自 SimpleXMLRPCServer 并提供了一种创建自动记录文档的、独立的 XML-RPC 服务器的方式。 HTTP POST 请求将作为 XML-RPC 方法调用来处理。 HTTP GET 请求将通过生成 pydoc 风格的 HTML 文档来处理。 这将允许服务器自己提供基于 Web 的文档。

DocXMLRPCServer.set_server_title(server_title)

设置所生成 HTML 文档要使用的标题。 此标题将在 HTML "title" 元素中使用。

DocXMLRPCServer.set_server_name(server_name)

设置所生成 HTML 文档要使用的名称。 此名称将出现在所生成文档顶部的 "h1" 元素中。

DocXMLRPCServer.set_server_documentation(server_documentation)

设置所生成Set the description used in the generated HTML 文档要使用的描述。 此描述将显示为文档中的一个段落，位于服务器名称之下。

DocCGIXMLRPCRequestHandler

DocCGIXMLRPCRequestHandler 类派生自 CGIXMLRPCRequestHandler 并提供了一种创建自动记录文档的 XML-RPC CGI 脚本的方式。 HTTP POST 请求将作为 XML-RPC 方法调用来处理。 HTTP GET 请求将通过生成 pydoc 风格的 HTML 文档来处理。 这将允许服务器自己提供基于 Web 的文档。

DocCGIXMLRPCRequestHandler.set_server_title(server_title)

设置所生成 HTML 文档要使用的标题。 此标题将在 HTML "title" 元素中使用。

DocCGIXMLRPCRequestHandler.set_server_name(server_name)

设置所生成 HTML 文档要使用的名称。 此名称将出现在所生成文档顶部的 "h1" 元素中。

DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)

设置所生成Set the description used in the generated HTML 文档要使用的描述。 此描述将显示为文档中的一个段落，位于服务器名称之下。

ipaddress --- IPv4/IPv6 操作库

源代码： Lib/ipaddress.py [https://github.com/python/cpython/tree/3.10/Lib/ipaddress.py]

ipaddress 提供了创建、处理和操作 IPv4 和 IPv6 地址和网络的功能。

该模块中的函数和类可以直接处理与IP地址相关的各种任务，包括检查两个主机是否在同一个子网中，遍历某个子网中的所有主机，检查一个字符串是否是一个有效的IP地址或网络定义等等。

这是完整的模块 API 参考—若要查看概述，请见 ipaddress模块介绍.

3.3 新版功能.

方便的工厂函数

ipaddress 模块提供来工厂函数来方便地创建 IP 地址，网络和接口：

ipaddress.ip_address(address)

返回一个 IPv4Address 或 IPv6Address 对象，取决于作为参数传递的 IP 地址。可以提供IPv4或IPv6地址，小于 2**32 的整数默认被认为是 IPv4。如果 address 不是有效的 IPv4 或 IPv6 地址，则会抛出 ValueError。

>>> ipaddress.ip_address('192.168.0.1')
IPv4Address('192.168.0.1')
>>> ipaddress.ip_address('2001:db8::')
IPv6Address('2001:db8::')

ipaddress.ip_network(address, strict=True)

返回一个 IPv4Network 或 IPv6Network 对象，具体取决于作为参数传入的 IP 地址。 address 是表示 IP 网址的字符串或整数。 可以提供 IPv4 或 IPv6 网址；小于 2**32 的整数默认被视为 IPv4。 strict 会被传给 IPv4Network 或 IPv6Network 构造器。 如果 address 不表示有效的 IPv4 或 IPv6 网址，或者网络设置了 host 比特位，则会引发 ValueError。

>>> ipaddress.ip_network('192.168.0.0/28')
IPv4Network('192.168.0.0/28')

ipaddress.ip_interface(address)

返回一个 IPv4Interface 或 IPv6Interface 对象，取决于作为参数传递的 IP 地址。 address 是代表 IP 地址的字符串或整数。 可以提供 IPv4 或 IPv6 地址，小于 2**32 的整数默认认为是 IPv4。 如果 address 不是有效的IPv4 或 IPv6 地址，则会抛出一个 ValueError。

这些方便的函数的一个缺点是需要同时处理IPv4和IPv6格式，这意味着提供的错误信息并不精准，因为函数不知道是打算采用IPv4还是IPv6格式。更详细的错误报告可以通过直接调用相应版本的类构造函数来获得。

IP 地址

地址对象

IPv4Address 和 IPv6Address 对象有很多共同的属性。一些只对IPv6 地址有意义的属性也在 IPv4Address 对象实现，以便更容易编写正确处理两种 IP 版本的代码。地址对象是可哈希的 hashable，所以它们可以作为字典中的键来使用。

class ipaddress.IPv4Address(address)

构造一个 IPv4 地址。 如果 address 不是一个有效的 IPv4 地址，会抛出 AddressValueError 。

以下是有效的 IPv4 地址：

以十进制小数点表示的字符串，由四个十进制整数组成，范围为0--255，用点隔开(例如 192.168.0.1 )。每个整数代表地址中的八位（一个字节）。不允许使用前导零，以免与八进制表示产生歧义。

一个32位可容纳的整数。

一个长度为 4 的封装在 bytes 对象中的整数(高位优先)。

>>> 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')

在 3.8 版更改: 前导零可被接受，即使是在可能与八进制表示混淆的情况下也会被接受。

在 3.10 版更改: 前导零不再被接受，并且会被视作错误。IPv4地址字符串现在严格按照glibc的 inet_pton() 函数进行解析。

在 3.9.5 版更改: 上述变更也在自3.9.5版本起的Python 3.9当中被包含。

在 3.8.12 版更改: 从3.8.12版本开始，Python 3.8中也包含了上述变化。

version

合适的版本号：IPv4为 4 ，IPv6为 6 。

max_prefixlen

在该版本的地址表示中，比特数的总数：IPv4为 32 ；IPv6为 128 。

前缀定义了地址中的前导位数量，通过比较来确定一个地址是否是网络的一部分。

compressed

exploded

以点符号分割十进制表示的字符串。表示中不包括前导零。

由于IPv4没有为八位数设为零的地址定义速记符号，这两个属性始终与IPv4地址的 str(addr) 相同。暴露这些属性使得编写能够处理IPv4和IPv6地址的显示代码变得更加容易。

packed

这个地址的二进制表示——一个适当长度的 bytes 对象（最高的八位在最前）。 对于 IPv4 来说是 4 字节，对于 IPv6 来说是 16 字节。

reverse_pointer

IP地址的反向DNS PTR记录的名称，例如:

>>> 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'

这是可用于执行PTR查询的名称，而不是已解析的主机名本身。

3.5 新版功能.

is_multicast

如果该地址被保留用作多播用途，返回 True 。关于多播地址，请参见 RFC 3171 [https://datatracker.ietf.org/doc/html/rfc3171.html] （IPv4）和 RFC 2373 [https://datatracker.ietf.org/doc/html/rfc2373.html] （IPv6）。

is_private

如果地址被 iana-ipv4-special-registry [https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml] (针对 IPv4) 或 iana-ipv6-special-registry [https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml] (针对 IPv6) 定义为非全局可用则为 True，例外情况如下：

对于共享地址空间 (100.64.0.0/10) is_private 为 False

对于映射 IPv4 的 IPv6 地址来说 is_private 值由下层 IPv4 地址的语义决定并且以下条件将保持成立 (见 IPv6Address.ipv4_mapped):

address.is_private == address.ipv4_mapped.is_private

is_private 具有与 is_global 相反的值，除了对于共享的地址空间（即 100.64.0.0/10 范围）来说它们均为 False。

在 3.10.15 版更改: 修复了一些错误的正值和错误的负值。

192.0.0.0/24 被视为私有但 192.0.0.9/32 和 192.0.0.10/32 除外（之前：只有 192.0.0.0/29 子范围被视为私有）。

64:ff9b:1::/48 被视为私有。

2002::/16 被视为私有。

在 2001::/23 中存在例外（其余范围被视为私有）: 2001:1::1/128, 2001:1::2/128, 2001:3::/32, 2001:4:112::/48, 2001:20::/28, 2001:30::/28。 这些例外不被视为私有。

is_global

如果地址被 iana-ipv4-special-registry [https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml] (针对 IPv4) 或 iana-ipv6-special-registry [https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml] (针对 IPv6) 定义为全局可用则为 True，例外情况如下：

对于映射 IPv4 的 IPv6 地址来说 is_private 值由下层 IPv4 地址的语义决定并且以下条件将保持成立 (见 IPv6Address.ipv4_mapped):

address.is_global == address.ipv4_mapped.is_global

is_global 具有与 is_private 相反的值，除了对于共享的地址空间（即 100.64.0.0/10 范围）来说它们均为 False。

3.4 新版功能.

在 3.10.15 版更改: 修复了一些错误的正值和错误的负值，请参阅 is_private 了解详情。

is_unspecified

当地址未指定时为 True 。 参见 RFC 5735 [https://datatracker.ietf.org/doc/html/rfc5735.html] (IPv4) 或 RFC 2373 [https://datatracker.ietf.org/doc/html/rfc2373.html] (IPv6).

is_reserved

如果该地址属于互联网工程任务组（IETF）所规定的其他保留地址，返回 True 。

is_loopback

如果该地址为一个回环地址，返回 True 。关于回环地址，请见 RFC 3330 [https://datatracker.ietf.org/doc/html/rfc3330.html] （IPv4）和 RFC 2373 [https://datatracker.ietf.org/doc/html/rfc2373.html] （IPv6）。

is_link_local

如果该地址被保留用于本地链接则为 True。 参见 RFC 3927 [https://datatracker.ietf.org/doc/html/rfc3927.html]。

IPv4Address.__format__(fmt)

返回一个IP地址的字符串表示，由一个明确的格式字符串控制。fmt 可以是以下之一: 's'，默认选项，相当于 str()，'b' 用于零填充的二进制字符串，'X' 或者 'x' 用于大写或小写的十六进制表示，或者 'n' 相当于 'b' 用于 IPv4 地址和 'x' 用于 IPv6 地址。 对于二进制和十六进制表示法，可以使用形式指定器 '#' 和分组选项 '_'。 __format__ 被 format、 str.format 和 f 字符串使用。

>>> 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'

3.9 新版功能.

class ipaddress.IPv6Address(address)

构造一个 IPv6 地址。 如果 address 不是一个有效的 IPv6 地址，会抛出 AddressValueError 。

以下是有效的 IPv6 地址：

一个由八组四个16进制数字组成的字符串, 每组展示为16位. 以冒号分隔. 这可以描述为 分解 (普通书写). 此字符可以被 压缩 (速记书写) . 详见 RFC 4291 [https://datatracker.ietf.org/doc/html/rfc4291.html] . 例如, "0000:0000:0000:0000:0000:0abc:0007:0def" 可以被精简为 "::abc:7:def".

可选择的是，该字符串也可以有一个作用域ID，用后缀 %scope_id 表示。如果存在，作用域ID必须是非空的，并且不能包含 %。详见 RFC 4007 [https://datatracker.ietf.org/doc/html/rfc4007.html]。例如，fe80::1234%1 可以识别节点第一条链路上的地址 fe80::1234

适合 128 位的整数.

一个打包在长度为 16 字节的大端序 bytes 对象中的整数。

>>> ipaddress.IPv6Address('2001:db8::1000')
IPv6Address('2001:db8::1000')
>>> ipaddress.IPv6Address('ff02::5678%1')
IPv6Address('ff02::5678%1')

compressed

地址表示的简短形式，省略了组中的前导零，完全由零组成的最长的组序列被折叠成一个空组。

这也是 str(addr) 对IPv6地址返回的值。

exploded

地址的长形式表示，包括所有前导零和完全由零组成的组。

关于以下属性和方法，请参见 IPv4Address 类的相应文档。

packed

reverse_pointer

version

max_prefixlen

is_multicast

is_private

is_global

is_unspecified

is_reserved

is_loopback

is_link_local

3.4 新版功能: is_global

is_site_local

如果地址被保留用于本地站点则为 True。 请注意本地站点地址空间已被 RFC 3879 [https://datatracker.ietf.org/doc/html/rfc3879.html] 弃用。 请使用 is_private 来检测此地址是否位于 RFC 4193 [https://datatracker.ietf.org/doc/html/rfc4193.html] 所定义的本地唯一地址空间中。

ipv4_mapped

地址为映射的IPv4地址 (起始为 ::FFFF/96), 此属性记录为嵌入IPv4地址. 其他的任何地址, 此属性为 None.

scope_id

对于 RFC 4007 [https://datatracker.ietf.org/doc/html/rfc4007.html] 定义的作用域地址，此属性以字符串的形式确定地址所属的作用域的特定区域。当没有指定作用域时，该属性将是 None。

sixtofour

对于看起来是6to4的地址（以 2002::/16``开头），如 :RFC:`3056` 所定义的，此属性将返回嵌入的IPv4地址。 对于任何其他地址，该属性将是``None。

teredo

对于看起来是 RFC 4380 [https://datatracker.ietf.org/doc/html/rfc4380.html] 定义的Teredo地址（以 2001::/32 开头）的地址，此属性将返回嵌入式IP地址对 (server, client)。 对于任何其他地址，该属性将是 None。

IPv6Address.__format__(fmt)

请参考 IPv4Address 中对应的方法文档。

3.9 新版功能.

转换字符串和整数

与网络模块互操作像套接字模块, 地址必须转换为字符串或整数. 这是使用 str() 和 int() 内置函数:

>>> 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

请注意，IPv6范围内的地址被转换为没有范围区域ID的整数。

运算符

地址对象支持一些运算符。 除非另有说明，运算符只能在兼容对象之间应用（即IPv4与IPv4，IPv6与IPv6）。

比较运算符

地址对象可以用通常的一组比较运算符进行比较。具有不同范围区域ID的相同IPv6地址是不平等的。一些例子:

>>> 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

算术运算符

整数可以被添加到地址对象或从地址对象中减去。 一些例子:

>>> 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

IP网络的定义

IPv4Network 和 IPv6Network 对象提供了一个定义和检查IP网络定义的机制。一个网络定义由一个 掩码 和一个 网络地址 组成，因此定义了一个IP地址的范围，当用掩码屏蔽（二进制AND）时，等于网络地址。 例如，一个带有掩码 255.255.255.0 和网络地址 192.168.1.0 的网络定义由包括 192.168.1.0 到 192.168.1.255 的IP地址组成。

前缀、网络掩码和主机掩码

有几种相等的方法来指定IP网络掩码。 前缀 /<nbits> 是一个符号，表示在网络掩码中设置了多少个高阶位。 一个 网络掩码 是一个设置了一定数量高阶位的IP地址。 因此，前缀 /24 等同于IPv4中的网络掩码 255.255.255.0 或IPv6中的网络掩码 ffff:ff00:: 。 此外，主机掩码 是 网络掩码 的逻辑取反，有时被用来表示网络掩码（例如在Cisco访问控制列表中）。 在IPv4中，相当于主机掩码 0.0.0.255 的是 /24 。

网络对象

所有由地址对象实现的属性也由网络对象实现。 此外，网络对象还实现了额外的属性。所有这些在 IPv4Network 和 IPv6Network 之间是共同的，所以为了避免重复，它们只在 IPv4Network 中记录。网络对象是 hashable，所以它们可以作为字典中的键使用。

class ipaddress.IPv4Network(address, strict=True)

构建一个 IPv4 网络定义。 address 可以是以下之一：

一个由 IP 地址和可选掩码组成的字符串，用斜线 (/) 分开。 IP 地址是网络地址，掩码可以是一个单一的数字，这意味着它是一个 前缀，或者是一个 IPv4 地址的字符串表示。 如果是后者，如果掩码以非零字段开始，则被解释为 网络掩码，如果以零字段开始，则被解释为 主机掩码，唯一的例外是全零的掩码被视为 网络掩码。 如果没有提供掩码，它就被认为是 /32。

例如，以下的*地址*描述是等同的：192.168.1.0/24，192.168.1.0/255.255.255.0``和``192.168.1.0/0.0.0.255

一个可转化为32位的整数。 这相当于一个单地址的网络，网络地址是*address*，掩码是 /32。

一个整数被打包成一个长度为 4 的大端序 bytes 对象。 其解释类似于一个整数 address。

一个地址描述和一个网络掩码的双元组，其中地址描述是一个字符串，一个 32 位的整数，一个 4 字节的打包整数，或一个现有的 IPv4Address 对象；而网络掩码是一个代表前缀长度的整数 (例如 24) 或一个代表前缀掩码的字符串 (例如 255.255.255.0)。

如果 address 不是一个有效的 IPv4 地址则会引发 AddressValueError。 如果掩码不是有效的 IPv4 地址则会引发 NetmaskValueError。

如果 strict 是 True，并且在提供的地址中设置了主机位，那么 ValueError 将被触发。 否则，主机位将被屏蔽掉，以确定适当的网络地址。

除非另有说明，如果参数的 IP 版本与 self 不兼容，所有接受其他网络/地址对象的网络方法都将引发 TypeError。

在 3.5 版更改: 为*address*构造函数参数添加了双元组形式。

version

max_prefixlen

请参考 IPv4Address 中的相应属性文档。

is_multicast

is_private

is_unspecified

is_reserved

is_loopback

is_link_local

如果这些属性对网络地址和广播地址都是True，那么它们对整个网络来说就是True。

network_address

网络的网络地址。网络地址和前缀长度一起唯一地定义了一个网络。

broadcast_address

网络的广播地址。发送到广播地址的数据包应该被网络上的每台主机所接收。

hostmask

主机掩码，作为一个 IPv4Address 对象。

netmask

网络掩码，作为一个 IPv4Address 对象。

with_prefixlen

compressed

exploded

网络的字符串表示，其中掩码为前缀符号。

with_prefixlen 和 compressed 总是与 str(network) 相同，exploded 使用分解形式的网络地址。

with_netmask

网络的字符串表示，掩码用网络掩码符号表示。

with_hostmask

网络的字符串表示，其中的掩码为主机掩码符号。

num_addresses

网络中的地址总数。

prefixlen

网络前缀的长度，以比特为单位。

hosts()

返回一个网络中可用主机的迭代器。 可用的主机是属于该网络的所有IP地址，除了网络地址本身和网络广播地址。 对于掩码长度为31的网络，网络地址和网络广播地址也包括在结果中。掩码为32的网络将返回一个包含单一主机地址的列表。

>>> 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')]

overlaps(other)

如果这个网络部分或全部包含在*other*中，或者*other*全部包含在这个网络中，则为 True。

address_exclude(network)

计算从这个网络中移除给定的 network 后产生的网络定义。 返回一个网络对象的迭代器。 如果 network 不完全包含在这个网络中则会引发 ValueError。

>>> 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')]

subnets(prefixlen_diff=1, new_prefix=None)

根据参数值，加入的子网构成当前的网络定义。 prefixlen_diff 是我们的前缀长度应该增加的数量。 new_prefix 是所需的子网的新前缀；它必须大于我们的前缀。 必须设置 prefixlen_diff 和 new_prefix 中的一个，且只有一个。 返回一个网络对象的迭代器。

>>> 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')]

supernet(prefixlen_diff=1, new_prefix=None)

包含这个网络定义的超级网，取决于参数值。 prefixlen_diff 是我们的前缀长度应该减少的数量。 new_prefix 是超级网的新前缀；它必须比我们的前缀小。 必须设置 prefixlen_diff 和 new_prefix 中的一个，而且只有一个。 返回一个单一的网络对象。

>>> 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')

subnet_of(other)

如果这个网络是*other*的子网，则返回 True。

>>> a = ip_network('192.168.1.0/24')
>>> b = ip_network('192.168.1.128/30')
>>> b.subnet_of(a)
True

3.7 新版功能.

supernet_of(other)

如果这个网络是*other*的超网，则返回 True。

>>> a = ip_network('192.168.1.0/24')
>>> b = ip_network('192.168.1.128/30')
>>> a.supernet_of(b)
True

3.7 新版功能.

compare_networks(other)

将这个网络与*ohter*网络进行比较。 在这个比较中，只考虑网络地址；不考虑主机位。 返回是 -1 、 0``或``1。

>>> 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

3.7 版后已移除: 它使用与"<"、"=="和">"相同的排序和比较算法。

class ipaddress.IPv6Network(address, strict=True)

构建一个 IPv6 网络定义。 address 可以是以下之一：

一个由IP地址和可选前缀长度组成的字符串，用斜线（ /）分开。 IP地址是网络地址，前缀长度必须是一个数字，即*prefix*。 如果没有提供前缀长度，就认为是 /128。

请注意，目前不支持扩展的网络掩码。 这意味着 2001:db00::0/24 是一个有效的参数，而 2001:db00::0/ffff:ff00:: 不是。

一个适合128位的整数。 这相当于一个单地址网络，网络地址是*address*，掩码是 /128。

一个整数被打包成一个长度为 16 的大端序 bytes 对象。 其解释类似于一个整数的 address。

一个地址描述和一个网络掩码的双元组，其中地址描述是一个字符串，一个 128 位的整数，一个 16 字节的打包整数，或者一个现有的 IPv6Address 对象；而网络掩码是一个代表前缀长度的整数。

如果 address 不是一个有效的 IPv6 地址则会引发 AddressValueError。 如果掩码对 IPv6 地址无效则会引发 NetmaskValueError。

如果 strict 是 True，并且在提供的地址中设置了主机位，那么 ValueError 将被触发。 否则，主机位将被屏蔽掉，以确定适当的网络地址。

在 3.5 版更改: 为*address*构造函数参数添加了双元组形式。

version

max_prefixlen

is_multicast

is_private

is_unspecified

is_reserved

is_loopback

is_link_local

network_address

broadcast_address

hostmask

netmask

with_prefixlen

compressed

exploded

with_netmask

with_hostmask

num_addresses

prefixlen

hosts()

返回一个网络中可用主机的迭代器。 可用的主机是属于该网络的所有IP地址，除了Subnet-Router任播的地址。 对于掩码长度为127的网络，子网-路由器任播地址也包括在结果中。掩码为128的网络将返回一个包含单一主机地址的列表。

overlaps(other)

address_exclude(network)

subnets(prefixlen_diff=1, new_prefix=None)

supernet(prefixlen_diff=1, new_prefix=None)

subnet_of(other)

supernet_of(other)

compare_networks(other)

请参考 IPv4Network 中的相应属性文档。

is_site_local

如果这些属性对网络地址和广播地址都是True，那么对整个网络来说就是True。

运算符

网络对象支持一些运算符。 除非另有说明，运算符只能在兼容的对象之间应用（例如，IPv4与IPv4，IPv6与IPv6）。

逻辑运算符

网络对象可以用常规的逻辑运算符集进行比较。网络对象首先按网络地址排序，然后按网络掩码排序。

迭代

网络对象可以被迭代，以列出属于该网络的所有地址。 对于迭代，所有 主机都会被返回，包括不可用的主机（对于可用的主机，使用 hosts() 方法）。 一个例子:

>>> 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')

作为地址容器的网络

网络对象可以作为地址的容器。 一些例子:

>>> 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

接口对象

接口对象是 hashable 的，所以它们可以作为字典中的键使用。

class ipaddress.IPv4Interface(address)

构建一个 IPv4 接口。 address 的含义与 IPv4Network 构造器中的一样，不同之处在于任意主机地址总是会被接受。

IPv4Interface 是 IPv4Address 的一个子类，所以它继承了该类的所有属性。 此外，还有以下属性可用：

ip

地址（IPv4Address）没有网络信息。

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.ip
IPv4Address('192.0.2.5')

network

该接口所属的网络（IPv4Network）。

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.network
IPv4Network('192.0.2.0/24')

with_prefixlen

用前缀符号表示的接口与掩码的字符串。

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_prefixlen
'192.0.2.5/24'

with_netmask

带有网络的接口的网络掩码字符串表示。

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_netmask
'192.0.2.5/255.255.255.0'

with_hostmask

带有网络的接口的主机掩码字符串表示。

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_hostmask
'192.0.2.5/0.0.0.255'

class ipaddress.IPv6Interface(address)

构建一个 IPv6 接口。 address 的含义与 IPv6Network 构造器中的一样，不同之处在于任意主机地址总是会被接受。

IPv6Interface 是 IPv6Address 的一个子类，所以它继承了该类的所有属性。 此外，还有以下属性可用：

ip

network

with_prefixlen

with_netmask

with_hostmask

请参考 IPv4Interface 中的相应属性文档。

运算符

接口对象支持一些运算符。 除非另有说明，运算符只能在兼容的对象之间应用（即IPv4与IPv4，IPv6与IPv6）。

逻辑运算符

接口对象可以用通常的逻辑运算符集进行比较。

对于相等比较（== 和 !=），IP地址和网络都必须是相同的对象才会相等。 一个接口不会与任何地址或网络对象相等。

对于排序 (<、> 等)，规则是不同的。 具有相同 IP 版本的接口和地址对象可以被比较，而地址对象总是在接口对象之前排序。 两个接口对象首先通过它们的网络进行比较，如果它们是相同的，则通过它们的 IP 地址进行比较。

其他模块级别函数

该模块还提供以下模块级函数：

ipaddress.v4_int_to_packed(address)

以网络（大端序）顺序将一个地址表示为 4 个打包的字节。address 是一个 IPv4 IP 地址的整数表示。 如果整数是负数或太大而不满足 IPv4 IP 地址要求，会触发一个 ValueError。

>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.v4_int_to_packed(3221225985)
b'\xc0\x00\x02\x01'

ipaddress.v6_int_to_packed(address)

以网络（大端序）顺序将一个地址表示为 4 个打包的字节。address 是一个IPv6 IP地址的整数表示。 如果整数是负数或太大而不满足 IPv6 IP 地址要求，会触发一个 ValueError。

ipaddress.summarize_address_range(first, last)

给出第一个和最后一个 IP 地址，返回总结的网络范围的迭代器。 first 是范围内的第一个 IPv4Address 或 IPv6Address，last 是范围内的最后一个 IPv4Address 或 IPv6Address。 如果 first 或 last 不是IP地址或不是同一版本则会引发 TypeError。 如果 last 不大于 first，或者 first 的地址版本不是 4 或 6 则会引发 ValueError。

>>> [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')]

ipaddress.collapse_addresses(addresses)

返回一个 IPv4Network 或 IPv6Network 对象的迭代器。 addresses 是一个 IPv4Network 或 IPv6Network 对象的迭代器。 如果 addresses 包含混合版本的对象则会引发 TypeError。

>>> [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')]

ipaddress.get_mixed_type_key(obj)

返回一个适合在网络和地址之间进行排序的键。 地址和网络对象在默认情况下是不可排序的；它们在本质上是不同的，所以表达式:

IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')

是没有意义的。 然而，有些时候，你可能希望让 ipaddress 对这些进行排序。 如果你需要这样做，你可以使用这个函数作为 sorted() 的 key 参数。

obj 是一个网络或地址对象。

自定义异常

为了支持来自类构造函数的更具体的错误报告，模块定义了以下异常：

exception ipaddress.AddressValueError(ValueError)

与地址有关的任何数值错误。

exception ipaddress.NetmaskValueError(ValueError)

与网络掩码有关的任何数值错误。

多媒体服务

本章描述的模块实现了主要用于多媒体应用的各种算法或接口。 它们可在安装时自行决定。 这是一个概述：

wave --- 读写WAV格式文件

Wave_read对象

Wave_write 对象

colorsys --- 颜色系统间的转换

wave --- 读写WAV格式文件

源代码: Lib/wave.py [https://github.com/python/cpython/tree/3.10/Lib/wave.py]

The wave module provides a convenient interface to the WAV sound format. Only files using WAVE_FORMAT_PCM are supported. Note that this does not include files using WAVE_FORMAT_EXTENSIBLE even if the subformat is PCM.

wave 模块定义了以下函数和异常:

wave.open(file, mode=None)

如果 file 是一个字符串，打开对应文件名的文件。否则就把它作为文件型对象来处理。mode 可以为以下值：

'rb'

只读模式。

'wb'

只写模式。

注意不支持同时读写WAV文件。

mode 设为 'rb' 时返回一个 Wave_read 对象，而 mode 设为 'wb' 时返回一个 Wave_write 对象。如果省略 mode 并指定 file 来传入一个文件型对象，则 file.mode 会被用作 mode 的默认值。

如果操作的是文件对象，当使用 wave 对象的 close() 方法时，并不会真正关闭文件对象，这需要调用者负责来关闭文件对象。

open() 函数可以在 with 语句中使用。 当 with 阻塞结束时，Wave_read.close() 或 Wave_write.close() 方法会被调用。

在 3.4 版更改: 添加了对不可搜索文件的支持。

exception wave.Error

当不符合WAV格式或无法操作时引发的错误。

Wave_read对象

由 open() 返回的 Wave_read 对象，有以下几种方法:

Wave_read.close()

关闭 wave 打开的数据流并使对象不可用。当对象销毁时会自动调用。

Wave_read.getnchannels()

返回声道数量（1 为单声道，2 为立体声）

Wave_read.getsampwidth()

返回采样字节长度。

Wave_read.getframerate()

返回采样频率。

Wave_read.getnframes()

返回音频总帧数。

Wave_read.getcomptype()

返回压缩类型（只支持 'NONE' 类型）

Wave_read.getcompname()

getcomptype() 的通俗版本。使用 'not compressed' 代替 'NONE'。

Wave_read.getparams()

返回一个 namedtuple() (nchannels, sampwidth, framerate, nframes, comptype, compname)，与 get*() 方法的输出相同。

Wave_read.readframes(n)

读取并返回以 bytes 对象表示的最多 n 帧音频。

Wave_read.rewind()

重置文件指针至音频开头.

以下两个方法是为了和 aifc 保持兼容，实际不做任何事情。

Wave_read.getmarkers()

返回 None。

Wave_read.getmark(id)

引发错误异常。

以下两个方法都使用指针，具体实现由其底层决定。

Wave_read.setpos(pos)

设置文件指针到指定位置。

Wave_read.tell()

返回当前文件指针位置。

Wave_write 对象

对于可查找的输出流，wave 头将自动更新以反映实际写入的帧数。 对于不可查找的流，当写入第一帧时 nframes 值必须准确。 获取准确的 nframes 值可以通过调用 setnframes() 或 setparams() 并附带 close() 被调用之前将要写入的帧数，然后使用 writeframesraw() 来写入帧数据，或者通过调用 writeframes() 并附带所有要写入的帧。 在后一种情况下 writeframes() 将计算数据中的帧数并在写入帧数据之前相应地设置 nframes。

由 open() 返回的 Wave_write 对象，有以下几种方法:

在 3.4 版更改: 添加了对不可搜索文件的支持。

Wave_write.close()

确保 nframes 是正确的，并在文件被 wave 打开时关闭它。 此方法会在对象收集时被调用。 如果输出流不可查找且 nframes 与实际写入的帧数不匹配时引发异常。

Wave_write.setnchannels(n)

设置声道数。

Wave_write.setsampwidth(n)

设置采样字节长度为 n。

Wave_write.setframerate(n)

设置采样频率为 n。

在 3.2 版更改: 对此方法的非整数输入会被舍入到最接近的整数。

Wave_write.setnframes(n)

设置总帧数为 n。 如果与之后实际写入的帧数不一致此值将会被更改（ 如果输出流不可查找则此更改尝试将引发错误）。

Wave_write.setcomptype(type, name)

设置压缩格式。目前只支持 NONE 即无压缩格式。

Wave_write.setparams(tuple)

tuple 应该是 (nchannels, sampwidth, framerate, nframes, comptype, compname)，每项的值应可用于 set*() 方法。设置所有形参。

Wave_write.tell()

返回当前文件指针，其指针含义和 Wave_read.tell() 以及 Wave_read.setpos() 是一致的。

Wave_write.writeframesraw(data)

写入音频数据但不更新 nframes。

在 3.4 版更改: 现在可接受任意 bytes-like object。

Wave_write.writeframes(data)

写入音频帧并确保 nframes 是正确的。 如果输出流不可查找且在 data 被写入之后写入的总帧数与之前设定的 nframes 值不匹配将会引发错误。

在 3.4 版更改: 现在可接受任意 bytes-like object。

注意在调用 writeframes() 或 writeframesraw() 之后再设置任何格式参数是无效的，而且任何这样的尝试将引发 wave.Error。

colorsys --- 颜色系统间的转换

源代码： Lib/colorsys.py [https://github.com/python/cpython/tree/3.10/Lib/colorsys.py]

colorsys 模块定义了计算机显示器所用的 RGB (Red Green Blue) 色彩空间与三种其他色彩坐标系统 YIQ, HLS (Hue Lightness Saturation) 和 HSV (Hue Saturation Value) 表示的颜色值之间的双向转换。 所有这些色彩空间的坐标都使用浮点数值来表示。 在 YIQ 空间中，Y 坐标取值为 0 和 1 之间，而 I 和 Q 坐标均可以为正数或负数。 在所有其他空间中，坐标取值均为 0 和 1 之间。

参见

有关色彩空间的更多信息可访问 https://poynton.ca/ColorFAQ.html 和 https://www.cambridgeincolour.com/tutorials/color-spaces.htm。

colorsys 模块定义了如下函数：

colorsys.rgb_to_yiq(r, g, b)

把颜色从RGB值转为YIQ值。

colorsys.yiq_to_rgb(y, i, q)

把颜色从YIQ值转为RGB值。

colorsys.rgb_to_hls(r, g, b)

把颜色从RGB值转为HLS值。

colorsys.hls_to_rgb(h, l, s)

把颜色从HLS值转为RGB值。

colorsys.rgb_to_hsv(r, g, b)

把颜色从RGB值转为HSV值。

colorsys.hsv_to_rgb(h, s, v)

把颜色从HSV值转为RGB值。

示例:

>>> 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)

国际化

本章中介绍的模块通过提供选择要在程序信息中使用的语言的机制或通过定制输出以匹配本地约定来帮助你编写不依赖于语言和区域设置的软件。

本章中描述的模块列表是：

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

GNU gettext API

基于类的 API

NullTranslations 类

GNUTranslations 类

Solaris 消息编目支持

编目构造器

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

本地化你的模块

本地化你的应用程序

即时更改语言

延迟翻译

致谢

locale --- 国际化服务

背景、细节、提示、技巧和注意事项

针对扩展程序编写人员和嵌入Python 运行的程序

访问消息目录

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

源代码： Lib/gettext.py [https://github.com/python/cpython/tree/3.10/Lib/gettext.py]

gettext 模块为 Python 模块和应用程序提供国际化 (Internationalization, I18N) 和本地化 (Localization, L10N) 服务。它同时支持 GNU gettext 消息编目 API 和更高级的、基于类的 API，后者可能更适合于 Python 文件。下方描述的接口允许用户使用一种自然语言编写模块和应用程序消息，并提供翻译后的消息编目，以便在不同的自然语言下运行。

同时还给出一些本地化 Python 模块及应用程序的小技巧。

GNU gettext API

模块 gettext 定义了下列 API，这与 gettext API 类似。如果你使用该 API，将会对整个应用程序产生全局的影响。如果你的应用程序支持多语种，而语言选择取决于用户的语言环境设置，这通常正是你所想要的。而如果你正在本地化某个 Python 模块，或者你的应用程序需要在运行时切换语言，相反你或许想用基于类的API。

gettext.bindtextdomain(domain, localedir=None)

将 domain 绑定到本地目录 localedir。 更具体地来说，模块 gettext 将使用路径 (在 Unix 系统中): localedir/language/LC_MESSAGES/domain.mo 查找二进制 .mo 文件，此处对应地查找 language 的位置是环境变量 LANGUAGE, LC_ALL, LC_MESSAGES 和 LANG 中。

如果遗漏了 localedir 或者设置为 None，那么将返回当前 domain 所绑定的值 1

gettext.bind_textdomain_codeset(domain, codeset=None)

将 domain 绑定到 codeset，修改 lgettext(), ldgettext(), lngettext() 和 ldngettext() 函数返回的字节串的字符编码。如果省略了 codeset，则返回当前绑定的编码集。

Deprecated since version 3.8, removed in version 3.10.

gettext.textdomain(domain=None)

修改或查询当前的全局域。如果 domain 为 None，则返回当前的全局域，不为 None 则将全局域设置为 domain，并返回它。

gettext.gettext(message)

返回 message 的本地化翻译，依据包括当前的全局域、语言和语言环境目录。本函数在本地命名空间中通常有别名 _() （参考下面的示例）。

gettext.dgettext(domain, message)

与 gettext() 类似，但在指定的 domain 中查找 message。

gettext.ngettext(singular, plural, n)

与 gettext() 类似，但考虑了复数形式。如果找到了翻译，则将 n 代入复数公式，然后返回得出的消息（某些语言具有两种以上的复数形式）。如果未找到翻译，则 n 为 1 时返回 singular，为其他数时返回 plural。

复数公式取自编目头文件。它是 C 或 Python 表达式，有一个自变量 n，该表达式计算的是所需复数形式在编目中的索引号。关于在 .po 文件中使用的确切语法和各种语言的公式，请参阅 GNU gettext 文档 [https://www.gnu.org/software/gettext/manual/gettext.html] 。

gettext.dngettext(domain, singular, plural, n)

与 ngettext() 类似，但在指定的 domain 中查找 message。

gettext.pgettext(context, message)

gettext.dpgettext(domain, context, message)

gettext.npgettext(context, singular, plural, n)

gettext.dnpgettext(domain, context, singular, plural, n)

与前缀中没有 p 的相应函数类似（即 gettext(), dgettext(), ngettext(), dngettext() ），但是仅翻译给定的 message context。

3.8 新版功能.

gettext.lgettext(message)

gettext.ldgettext(domain, message)

gettext.lngettext(singular, plural, n)

gettext.ldngettext(domain, singular, plural, n)

与前缀中没有 l 的相应函数等效（ gettext(), dgettext(), ngettext() 和 dngettext() ），但是如果没有用 bind_textdomain_codeset() 显式设置其他编码，则返回的翻译将以首选系统编码来编码字节串。

警告

在 Python 3 中应避免使用这些函数，因为它们返回的是编码后的字节串。最好使用返回 Unicode 字符串的其他方法，因为大多数 Python 应用程序都希望将人类可读的文本作为字符串而不是字节来处理。此外，如果翻译后的字符串存在编码问题，则可能会意外出现与 Unicode 相关的异常。

Deprecated since version 3.8, removed in version 3.10.

注意，GNU gettext 还定义了 dcgettext() 方法，但它被认为不实用，因此目前没有实现它。

这是该 API 的典型用法示例:

import gettext
gettext.bindtextdomain('myapplication', '/path/to/my/language/directory')
gettext.textdomain('myapplication')
_ = gettext.gettext
# ...
print(_('This is a translatable string.'))

基于类的 API

与 GNU gettext API 相比，gettext 模块的基于类的 API 提供了更多的灵活性和更强的便利性。这是本地化 Python 应用程序和模块的推荐方法。gettext 定义了一个 GNUTranslations 类，该类实现了 GNU .mo 格式文件的解析，并且具有用于返回字符串的方法。本类的实例也可以将自身作为函数 _() 安装到内建命名空间中。

gettext.find(domain, localedir=None, languages=None, all=False)

本函数实现了标准的 .mo 文件搜索算法。它接受一个 domain，它与 textdomain() 接受的域相同。可选参数 localedir 与 bindtextdomain() 中的相同。可选参数 languages 是多条字符串的列表，其中每条字符串都是一种语言代码。

如果没有传入 localedir，则使用默认的系统语言环境目录。 2 如果没有传入 languages，则搜索以下环境变量：LANGUAGE、LC_ALL、LC_MESSAGES 和 LANG。从这些变量返回的第一个非空值将用作 languages 变量。环境变量应包含一个语言列表，由冒号分隔，该列表会被按冒号拆分，以产生所需的语言代码字符串列表。

find() 将扩展并规范化 language，然后遍历它们，搜索由这些组件构建的现有文件:

localedir/language/LC_MESSAGES/domain.mo

find() 返回找到类似的第一个文件名。如果找不到这样的文件，则返回 None。如果传入了 all，它将返回一个列表，包含所有文件名，并按它们在语言列表或环境变量中出现的顺序排列。

gettext.translation(domain, localedir=None, languages=None, class_=None, fallback=False, codeset=None)

根据 domain、localedir 和 languages，返回 *Translations 实例，首先应将前述参数传入 find() 以获取关联的 .mo 文件路径的列表。名字与 .mo 文件名相同的实例将被缓存。如果传入 class_，它将是实际被实例化的类，否则实例化 GNUTranslations。类的构造函数必须只接受一个 文件对象 参数。如果传入 codeset，那么在 lgettext() 和 lngettext() 方法中，对翻译后的字符串进行编码的字符集将被改变。

如果找到多个文件，后找到的文件将用作先前文件的替补。为了设置替补，将使用 copy.copy() 从缓存中克隆每个 translation 对象。实际的实例数据仍在缓存中共享。

如果 .mo 文件未找到，且 fallback 为 false（默认值），则本函数引发 OSError 异常，如果 fallback 为 true，则返回一个 NullTranslations 实例。

在 3.3 版更改: 曾经是 IOError 被引发而不是 OSError 。

Deprecated since version 3.8, removed in version 3.10: codeset 参数。

gettext.install(domain, localedir=None, codeset=None, names=None)

根据传入 translation() 函数的 domain、localedir 和 codeset，在 Python 内建命名空间中安装 _() 函数。

names 参数的信息请参阅 translation 对象的 install() 方法的描述。

如下所示，通常将字符串包括在 _() 函数的调用中，以标记应用程序中待翻译的字符串，就像这样:

print(_('This string will be translated.'))

为了方便，一般将 _() 函数安装在 Python 内建命名空间中，以便在应用程序的所有模块中轻松访问它。

Deprecated since version 3.8, removed in version 3.10: codeset 参数。

NullTranslations 类

translation 类实际实现的是，将原始源文件消息字符串转换为已翻译的消息字符串。所有 translation 类使用的基类为 NullTranslations，它提供了基本的接口，可用于编写自己定制的 translation 类。以下是 NullTranslations 的方法：

class gettext.NullTranslations(fp=None)

接受一个可选参数 文件对象 fp，该参数会被基类忽略。初始化由派生类设置的 "protected" （受保护的）实例变量 _info 和 _charset，与 _fallback 类似，但它是通过 add_fallback() 来设置的。如果 fp 不为 None，就会调用 self._parse(fp)。

_parse(fp)

在基类中没有操作，本方法接受文件对象 fp，从该文件读取数据，用来初始化消息编目。如果你手头的消息编目文件的格式不受支持，则应重写本方法来解析你的格式。

add_fallback(fallback)

添加 fallback 为当前 translation 对象的替补对象。如果 translation 对象无法为指定消息提供翻译，则应向替补查询。

gettext(message)

如果设置了替补，则转发 gettext() 给替补。否则返回 message。在派生类中被重写。

ngettext(singular, plural, n)

如果设置了替补，则转发 ngettext() 给替补。否则，n 为 1 时返回 singular，为其他时返回 plural。在派生类中被重写。

pgettext(context, message)

如果设置了替补，则转发 pgettext() 给替补。否则返回已翻译的消息。在派生类中被重写。

3.8 新版功能.

npgettext(context, singular, plural, n)

如果设置了替补，则转发 npgettext() 给替补。否则返回已翻译的消息。在派生类中被重写。

3.8 新版功能.

lgettext(message)

lngettext(singular, plural, n)

与 gettext() 和 ngettext() 等效，但是如果没有用 set_output_charset() 显式设置编码，则返回的翻译将以首选系统编码来编码字节串。在派生类中被重写。

警告

应避免在 Python 3 中使用这些方法。请参阅 lgettext() 函数的警告。

Deprecated since version 3.8, removed in version 3.10.

info()

返回 "protected"（受保护的） _info 变量，它是一个字典，包含在消息编目文件中找到的元数据。

charset()

返回消息编目文件的编码。

output_charset()

返回由 lgettext() 和 lngettext() 翻译出的消息的编码。

Deprecated since version 3.8, removed in version 3.10.

set_output_charset(charset)

更改翻译出的消息的编码。

Deprecated since version 3.8, removed in version 3.10.

install(names=None)

本方法将 gettext() 安装至内建命名空间，并绑定为 _。

如果传入 names 参数，该参数必须是一个序列，包含除 _() 外其他要安装在内建命名空间中的函数的名称。支持的名称有 'gettext', 'ngettext', 'pgettext', 'npgettext', 'lgettext' 和 'lngettext'。

注意，这仅仅是使 _() 函数在应用程序中生效的一种方法，尽管也是最方便的方法。由于它会影响整个应用程序全局，特别是内建命名空间，因此已经本地化的模块不应该安装 _()，而是应该用下列代码使 _() 在各自模块中生效:

import gettext
t = gettext.translation('mymodule', ...)
_ = t.gettext

这只将 _() 放在其模块的全局命名空间中，所以只影响其模块内的调用。

在 3.8 版更改: 添加了 'pgettext' 和 'npgettext'。

GNUTranslations 类

gettext 模块提供了一个派生自 NullTranslations 的其他类：GNUTranslations。该类重写了 _parse()，同时能以大端序和小端序格式读取 GNU gettext 格式的 .mo 文件。

GNUTranslations 从翻译编目中解析出可选的元数据。GNU gettext 约定，将元数据包括在空字符串的翻译中。该元数据采用 RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] 样式的 key: value 键值对，且应该包含 Project-Id-Version 键。如果找到 Content-Type 键，那么将用 charset 属性去初始化 "protected"（受保护的） _charset 实例变量，而该变量在未找到键的情况下默认为 None。如果指定了字符编码，那么从编目中读取的所有消息 ID 和消息字符串都将使用此编码转换为 Unicode，若未指定编码，则假定编码为 ASCII。

由于消息 ID 也是作为 Unicode 字符串读取的，因此所有 *gettext() 方法都假定消息 ID 为 Unicode 字符串，而不是字节串。

整个键/值对集合将被放入一个字典，并设置为 "protected"（受保护的） _info 实例变量。

如果 .mo 文件的魔法值 (magic number) 无效，或遇到意外的主版本号，或在读取文件时发生其他问题，则实例化 GNUTranslations 类会引发 OSError。

class gettext.GNUTranslations

下列方法是根据基类实现重写的：

gettext(message)

在编目中查找 message ID，并以 Unicode 字符串形式返回相应的消息字符串。如果在编目中没有 message ID 条目，且配置了替补，则查找请求将被转发到替补的 gettext() 方法。否则，返回 message ID。

ngettext(singular, plural, n)

查找消息 ID 的复数形式。singular 用作消息 ID，用于在编目中查找，同时 n 用于确定使用哪种复数形式。返回的消息字符串是 Unicode 字符串。

如果在编目中没有找到消息 ID，且配置了替补，则查找请求将被转发到替补的 ngettext() 方法。否则，当 n 为 1 时返回 singular，其他情况返回 plural。

例如：

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}

pgettext(context, message)

在编目中查找 context 和 message ID，并以 Unicode 字符串形式返回相应的消息字符串。如果在编目中没有 message ID 和 context 条目，且配置了替补，则查找请求将被转发到替补的 pgettext() 方法。否则，返回 message ID。

3.8 新版功能.

npgettext(context, singular, plural, n)

查找消息 ID 的复数形式。singular 用作消息 ID，用于在编目中查找，同时 n 用于确定使用哪种复数形式。

如果在编目中没有找到 context 对应的消息 ID，且配置了替补，则查找请求将被转发到替补的 npgettext() 方法。否则，当 n 为 1 时返回 singular，其他情况返回 plural。

3.8 新版功能.

lgettext(message)

lngettext(singular, plural, n)

与 gettext() 和 ngettext() 等效，但是如果没有用 set_output_charset() 显式设置编码，则返回的翻译将以首选系统编码来编码字节串。

警告

应避免在 Python 3 中使用这些方法。请参阅 lgettext() 函数的警告。

Deprecated since version 3.8, removed in version 3.10.

Solaris 消息编目支持

Solaris 操作系统定义了自己的二进制 .mo 文件格式，但由于找不到该格式的文档，因此目前不支持该格式。

编目构造器

GNOME 用的 gettext 模块是 James Henstridge 写的版本，但该版本的 API 略有不同。它文档中的用法是:

import gettext
cat = gettext.Catalog(domain, localedir)
_ = cat.gettext
print(_('hello world'))

为了与本模块的旧版本兼容，Catalog() 函数是上述 translation() 函数的别名。

本模块与 Henstridge 的模块有一个区别：他的编目对象支持通过映射 API 进行访问，但是该特性似乎从未使用过，因此目前不支持该特性。

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

国际化 (I18N) 是指使程序可切换多种语言的操作。本地化 (L10N) 是指程序的适配能力，一旦程序被国际化，就能适配当地的语言和文化习惯。为了向 Python 程序提供不同语言的消息，需要执行以下步骤：

准备程序或模块，将可翻译的字符串特别标记起来

在已标记的文件上运行一套工具，用来生成原始消息编目

创建消息编目的不同语言的翻译

使用 gettext 模块，以便正确翻译消息字符串

为了准备代码以达成 I18N，需要巡视文件中的所有字符串。所有要翻译的字符串都应包括在 _('...') 内，以此打上标记——也就是调用 _() 函数。例如:

filename = 'mylog.txt'
message = _('writing a log message')
with open(filename, 'w') as fp:
    fp.write(message)

在这个例子中，字符串 'writing a log message' 被标记为待翻译，而字符串 'mylog.txt' 和 'w' 没有被标记。

有一些工具可以将待翻译的字符串提取出来。 原版的 GNU gettext 仅支持 C 或 C++ 源代码，但其扩展版 xgettext 可以扫描多种语言的代码，包括 Python 在内，来找出标记为可翻译的字符串。 Babel [https://babel.pocoo.org/] 是一个包括了可用于提取并编译消息编目的 pybabel 脚本的 Python 国际化库。 François Pinard 的 xpot 程序也能完成类似的工作并可在他的 po-utils 包 [https://github.com/pinard/po-utils] 中获取。

（Python 还包括了这些程序的纯 Python 版本，称为 pygettext.py 和 msgfmt.py，某些 Python 发行版已经安装了它们。pygettext.py 类似于 xgettext，但只能理解 Python 源代码，无法处理诸如 C 或 C++ 的其他编程语言。pygettext.py 支持的命令行界面类似于 xgettext，查看其详细用法请运行 pygettext.py --help。msgfmt.py 与 GNU msgfmt 是二进制兼容的。有了这两个程序，可以不需要 GNU gettext 包来国际化 Python 应用程序。）

xgettext、pygettext 或类似工具生成的 .po 文件就是消息编目。它们是结构化的人类可读文件，包含源代码中所有被标记的字符串，以及这些字符串的翻译的占位符。

然后把这些 .po 文件的副本交给各个人工译者，他们为所支持的每种自然语言编写翻译。译者以 <语言名称>.po 文件的形式发送回翻译完的某个语言的版本，将该文件用 msgfmt 程序编译为机器可读的 .mo 二进制编目文件。gettext 模块使用 .mo 文件在运行时进行实际的翻译处理。

如何在代码中使用 gettext 模块取决于国际化单个模块还是整个应用程序。接下来的两节将讨论每种情况。

本地化你的模块

如果要本地化模块，则切忌进行全局性的更改，如更改内建命名空间。不应使用 GNU gettext API，而应使用基于类的 API。

假设你的模块叫做 "spam"，并且该模块的各种自然语言翻译 .mo 文件存放于 /usr/share/locale，为 GNU gettext 格式。以下内容应放在模块顶部:

import gettext
t = gettext.translation('spam', '/usr/share/locale')
_ = t.gettext

本地化你的应用程序

如果正在本地化应用程序，可以将 _() 函数全局安装到内建命名空间中，通常在应用程序的主文件中安装。这将使某个应用程序的所有文件都能使用 _('...')，而不必在每个文件中显式安装它。

最简单的情况，就只需将以下代码添加到应用程序的主程序文件中:

import gettext
gettext.install('myapplication')

如果需要设置语言环境目录，可以将其传递给 install() 函数:

import gettext
gettext.install('myapplication', '/usr/share/locale')

即时更改语言

如果程序需要同时支持多种语言，则可能需要创建多个翻译实例，然后在它们之间进行显式切换，如下所示:

import gettext

lang1 = gettext.translation('myapplication', languages=['en'])
lang2 = gettext.translation('myapplication', languages=['fr'])
lang3 = gettext.translation('myapplication', languages=['de'])

# start by using language1
lang1.install()

# ... time goes by, user selects language 2
lang2.install()

# ... more time goes by, user selects language 3
lang3.install()

延迟翻译

在大多数代码中，字符串会在编写位置进行翻译。但偶尔需要将字符串标记为待翻译，实际翻译却推迟到后面。一个典型的例子是:

animals = ['mollusk',
           'albatross',
           'rat',
           'penguin',
           'python', ]
# ...
for a in animals:
    print(a)

此处希望将 animals 列表中的字符串标记为可翻译，但不希望在打印之前对它们进行翻译。

这是处理该情况的一种方式:

def _(message): return message

animals = [_('mollusk'),
           _('albatross'),
           _('rat'),
           _('penguin'),
           _('python'), ]

del _

# ...
for a in animals:
    print(_(a))

该方法之所以可行，是因为 _() 的虚定义只是简单地返回了原本的字符串。并且该虚定义将临时覆盖内建命名空间中 _() 的定义（直到 del 命令）。即使先前在本地命名空间中已经有了 _() 的定义也请注意。

注意，第二次使用 _() 不会认为 "a" 可以传递给 gettext 程序去翻译，因为该参数不是字符串文字。

解决该问题的另一种方法是下面这个例子:

def N_(message): return message

animals = [N_('mollusk'),
           N_('albatross'),
           N_('rat'),
           N_('penguin'),
           N_('python'), ]

# ...
for a in animals:
    print(_(a))

这种情况下标记可翻译的字符串使用的是函数 N_()，该函数不会与 _() 的任何定义冲突。但是，需要教会消息提取程序去寻找用 N_() 标记的可翻译字符串。xgettext, pygettext, pybabel extract 和 xpot 都支持此功能，使用 -k 命令行开关即可。这里选择 N_() 为名称完全是任意的，它也能轻易改为 MarkThisStringForTranslation()。

致谢

以下人员为创建此模块贡献了代码、反馈、设计建议、早期实现和宝贵的经验：

Peter Funk

James Henstridge

Juan David Ibáñez Palomar

Marc-André Lemburg

Martin von Löwis

François Pinard

Barry Warsaw

Gustavo Niemeyer

备注

1

不同系统的默认语言环境目录是不同的；比如在 RedHat Linux 上是 /usr/share/locale，在 Solaris 上是 /usr/lib/locale。gettext 模块不会支持这些基于不同系统的默认值；而它的默认值为 sys.base_prefix/share/locale （请参阅 sys.base_prefix）。基于上述原因，最好每次都在应用程序的开头使用明确的绝对路径来调用 bindtextdomain()。

2

参阅上方 bindtextdomain() 的脚注。

locale --- 国际化服务

源代码： Lib/locale.py [https://github.com/python/cpython/tree/3.10/Lib/locale.py]

locale 模块开通了 POSIX 本地化数据库和功能的访问。POSIX 本地化机制让程序员能够为应用程序处理某些本地化的问题，而不需要去了解运行软件的每个国家的全部语言习惯。

locale 模块是在 _locale 模块的基础上实现的，而 _locale 则又用到了 ANSI C 语言实现的本地化功能。

locale 模块定义了以下异常和函数：

exception locale.Error

当传给 setlocale() 的 locale 无法识别时，会触发异常。

locale.setlocale(category, locale=None)

如果给定了 locale 而不是 None，setlocale() 会修改 category 的 locale 设置。可用的类别会在下面的数据描述中列出。locale 可以是一个字符串，也可以是两个字符串（语言代码和编码）组成的可迭代对象。若为可迭代对象，则会用地区别名引擎转换为一个地区名称。若为空字符串则指明采用用户的默认设置。如果 locale 设置修改失败，会触发 Error 异常。如果成功则返回新的 locale 设置。

如果省略 locale 或为 None，将返回 category 但当前设置。

setlocale() 在大多数系统上都不是线程安全的。应用程序通常会如下调用：

import locale
locale.setlocale(locale.LC_ALL, '')

这会把所有类别的 locale 都设为用户的默认设置（通常在 LANG 环境变量中指定）。如果后续 locale 没有改动，则使用多线程应该不会产生问题。

locale.localeconv()

以字典的形式返回本地约定的数据库。此字典具有以下字符串作为键：

类别 | 键 | 含意
LC_NUMERIC | 'decimal_point' | 小数点字符。
| 'grouping' | 数字列表，指定 'thousands_sep' 应该出现的位置。 如果列表以 CHAR_MAX 结束，则不会作分组。如果列表以 0 结束，则重复使用最后的分组大小。
| 'thousands_sep' | 组之间使用的字符。
LC_MONETARY | 'int_curr_symbol' | 国际货币符号。
| 'currency_symbol' | 当地货币符号。
| 'p_cs_precedes/n_cs_precedes' | 货币符号是否在值之前（对于正值或负值）。
| 'p_sep_by_space/n_sep_by_space' | 货币符号是否通过空格与值分隔（对于正值或负值）。
| 'mon_decimal_point' | 用于货币金额的小数点。
| 'frac_digits' | 货币值的本地格式中使用的小数位数。
| 'int_frac_digits' | 货币价值的国际格式中使用的小数位数。
| 'mon_thousands_sep' | 用于货币值的组分隔符。
| 'mon_grouping' | 相当于 'grouping' ，用于货币价值。
| 'positive_sign' | 用于标注正货币价值的符号。
| 'negative_sign' | 用于注释负货币价值的符号。
| 'p_sign_posn/n_sign_posn' | 符号的位置（对于正值或负值），见下文。

可以将所有数值设置为 CHAR_MAX ，以指示本 locale 中未指定任何值。

下面给出了 'p_sign_posn' 和 'n_sign_posn' 的可能值。

值 | 说明
0 | 被括号括起来的货币和金额。
1 | 该标志应位于值和货币符号之前。
2 | 该标志应位于值和货币符号之后。
3 | 标志应该紧跟在值之前。
4 | 标志应该紧跟在值之后。
CHAR_MAX | 该地区未指定内容。

此函数可临时性地将 LC_CTYPE 语言区域设为 LC_NUMERIC 语言区域或者如果语言区域不同且数字或货币字符串是非 ASCII 的则设为 LC_MONETARY 语言区域。 这个临时性地改变会影响到其他线程。

在 3.7 版更改: 现在此函数在某些情况下会临时性地将 LC_CTYPE 语言区域设为 LC_NUMERIC 语言区域。

locale.nl_langinfo(option)

以字符串形式返回一些地区相关的信息。本函数并非在所有系统都可用，而且可用的 option 在不同平台上也可能不同。可填的参数值为数值，在 locale 模块中提供了对应的符号常量。

nl_langinfo() 函数可接受以下值。大部分含义都取自 GNU C 库。

locale.CODESET

获取一个字符串，代表所选地区采用的字符编码名称。

locale.D_T_FMT

获取一个字符串，可用作 time.strftime() 的格式串，以便以地区特定格式表示日期和时间。

locale.D_FMT

获取一个字符串，可用作 time.strftime() 的格式串，以便以地区特定格式表示日期。

locale.T_FMT

获取一个字符串，可用作 time.strftime() 的格式串，以便以地区特定格式表示时间。

locale.T_FMT_AMPM

获取一个字符串，可用作 time.strftime() 的格式串，以便以 am/pm 的格式表示时间。

DAY_1 ... DAY_7

获取一周中第 n 天的名称。

注解

这里遵循美国惯例，即 DAY_1 是星期天，而不是国际惯例（ISO 8601），即星期一是一周的第一天。

ABDAY_1 ... ABDAY_7

获取一周中第 n 天的缩写名称。

MON_1 ... MON_12

获取第 n 个月的名称。

ABMON_1 ... ABMON_12

获取第 n 个月的缩写名称。

locale.RADIXCHAR

获取小数点字符（小数点、小数逗号等）。

locale.THOUSEP

获取千位数（三位数一组）的分隔符。

locale.YESEXPR

获取一个可供 regex 函数使用的正则表达式，用于识别需要回答是或否的问题的肯定回答。

locale.NOEXPR

获取一个可供 regex(3) 函数使用的正则表达式，用于识别需要回答是或否的问题的否定回答。

注解

YESEXPR 和 NOEXPR 中的正则表达式使用了适合来自 C 库的 regex() 函数的语法，它与 re 中使用的语法会有所不同。

locale.CRNCYSTR

获取货币符号，如果符号应位于数字之前，则在其前面加上“-”；如果符号应位于数字之后，则前面加“+”；如果符号应取代小数点字符，则前面加“.”。

locale.ERA

获取一个字符串，代表当前地区使用的纪元。

大多数地区都没有定义该值。定义了该值的一个案例日本。日本传统的日期表示方法中，包含了当时天皇统治朝代的名称。

通常没有必要直接使用该值。在格式串中指定 E 符号，会让 time.strftime() 函数启用此信息。返回字符串的格式并没有定义，因此不得假定各个系统都能理解。

locale.ERA_D_T_FMT

获取一个字符串，可用作 time.strftime() 的格式串，以便以地区特定格式表示带纪元的日期和时间。

locale.ERA_D_FMT

获取一个字符串，可用作 time.strftime() 的格式串，以便以地区特定格式表示带纪元的日期。

locale.ERA_T_FMT

获取一个字符串，可用作 time.strftime() 的格式串，以便以地区特定格式表示带纪元的时间。

locale.ALT_DIGITS

获取 0 到 99 的表示法，最多不超过 100 个值。

locale.getdefaultlocale([envvars])

尝试确定默认的地区设置，并以 (language code, encoding) 元组的形式返回。

根据 POSIX 的规范，未调用 setlocale(LC_ALL, '') 的程序采用可移植的 'C' 区域设置运行。 调用 setlocale(LC_ALL, '') 则可采用 LANG 变量定义的默认区域。 由于不想干扰当前的区域设置，因此就以上述方式进行了模拟。

为了维持与其他平台的兼容性，不仅需要检测 LANG 变量，还需要检测 envvars 参数给出的变量列表。首先发现的定义将被采用。 envvars 默认为 GNU gettext 采用的搜索路径；必须包含 'LANG' 变量。 GNU gettext 的搜索路径依次包含了 'LC_ALL'、'LC_CTYPE'、'LANG' 和 'LANGUAGE'。

除了 'C' 之外，语言代码对应 RFC 1766 [https://datatracker.ietf.org/doc/html/rfc1766.html] 标准。若 语言代码 和 编码 无法确定，则可为 None。

locale.getlocale(category=LC_CTYPE)

以列表的形式返回指定地区类别的当前设置，结果包括 语言代码 、编码。category 可以是 LC_* 之一， LC_ALL 除外。默认为 LC_CTYPE。

除了 'C' 之外，语言代码对应 RFC 1766 [https://datatracker.ietf.org/doc/html/rfc1766.html] 标准。若 语言代码 和 编码 无法确定，则可为 None。

locale.getpreferredencoding(do_setlocale=True)

根据用户的偏好，返回用于文本数据的 locale encoding。用户偏好在不同的系统上有不同的表达方式，而且在某些系统上可能无法以编程方式获取到，所以本函数只是返回猜测结果。

某些系统必须调用 setlocale() 才能获取用户偏好，所以本函数不是线程安全的。如果不需要或不希望调用 setlocale，do_setlocale 应设为 False。

在 Android 系统中，或者启用了 Python UTF-8 Mode，则一定会返回 'UTF-8'， locale encoding 和 do_setlocale 参数将被忽略。

Python preinitialization 用于配置 LC_CTYPE 区域。还请参阅 filesystem encoding and error handler。

在 3.7 版更改: 现在，本函数在 Android 上或启用 Python UTF-8 Mode 时，总会返回 UTF-8。

locale.normalize(localename)

为给定的区域名称返回标准代码。返回的区域代码已经格式化，可供 setlocale() 使用。 如果标准化操作失败，则返回原名称。

如果给出的编码无法识别，则本函数默认采用区域代码的默认编码，这正类似于 setlocale()。

locale.resetlocale(category=LC_ALL)

将 category 的区域设为默认值。

默认设置通过调用 getdefaultlocale() 确定。category 默认为 LC_ALL。

locale.strcoll(string1, string2)

根据当前的 LC_COLLATE 设置，对两个字符串进行比较。与其他比较函数一样，根据 string1 位于 string2 之前、之后或是相同，返回负值、、正值或者 0。

locale.strxfrm(string)

将字符串转换为可用于本地化比较的字符串。例如 strxfrm(s1) < strxfrm(s2) 相当于 strcoll(s1, s2) < 0。在重复比较同一个字符串时，可能会用到本函数，比如整理字符串列表时。

locale.format_string(format, val, grouping=False, monetary=False)

根据当前的 LC_NUMERIC 设置对数字 val 进行格式化。 此格式将遵循 % 运算符的约定。 对于浮点数值，会根据具体情况修改小数点。 如果 grouping 为 True，还会将分组纳入考虑。

若 monetary 为 True，则会用到货币千位分隔符和分组字符串。

格式化符的处理类似 format % val ，但会考虑到当前的区域设置。

在 3.7 版更改: 增加了关键字参数 monetary 。

locale.format(format, val, grouping=False, monetary=False)

请注意，本函数的工作原理与 format_string() 类似，但只认一种 %char 格式符。 比如 '%f' 和 '%.0f' 都是有效的格式符，但 '%f KiB' 则不是。

若想用到全部的格式化串，请采用 format_string()。

3.7 版后已移除: 请改用 format_string() 。

locale.currency(val, symbol=True, grouping=False, international=False)

根据当前的 LC_MONETARY 设置，对数字 val 进行格式化。

如果 symbol 为真值则返回的字符串将包括货币符号，该参数默认为真值。 如果 grouping 为 True (非默认值)，则会对值进行分组。 如果 international 为 True (非默认值)，则会使用国际货币符号。

注解

此函数将不适用于 'C' 语言区域，所以你必须先通过 setlocale() 设置一个语言区域。

locale.str(float)

对浮点数进行格式化，格式要求与内置函数 str(float) 相同，但会考虑小数点。

locale.delocalize(string)

根据 LC_NUMERIC 的设置，将字符串转换为标准化的数字字符串。

3.5 新版功能.

locale.localize(string, grouping=False, monetary=False)

根据 LC_NUMERIC 的设置，将标准化的数字字符串转换为格式化的字符串。

3.10 新版功能.

locale.atof(string, func=float)

将一个字符串转换为数字，遵循 LC_NUMERIC 设置，通过在 string 上调用 delocalize() 的结果上调用 func 来实现。

locale.atoi(string)

按照 LC_NUMERIC 的约定，将字符串转换为整数。

locale.LC_CTYPE

字符型函数的区域类别。根据该类别的设置，模块 string 中处理大小写的函数会改变操作方式。

locale.LC_COLLATE

字符串排序会用到的区域类别。 将会影响 locale 模块的 strcoll() 和 strxfrm() 函数。

locale.LC_TIME

格式化时间时会用到的区域类别。 time.strftime() 函数会参考这些约定。

locale.LC_MONETARY

格式化货币值时会用到的区域类别。可用值可由 localeconv() 函数获取。

locale.LC_MESSAGES

显示消息时用到的区域类别。目前 Python 不支持应用定制的本地化消息。 由操作系统显示的消息，比如由 os.strerror() 返回的消息可能会受到该类别的影响。

这个值在不符合 POSIX 标准的操作系统上可能不可用，最主要是指 Windows。

locale.LC_NUMERIC

格式化数字时用到的区域类别。 locale 模块的 format() 、 atoi() 、 atof() 和 str() 函数会受到该类别的影响。其他所有数字格式化操作不受影响。

locale.LC_ALL

混合所有的区域设置。如果在区域改动时使用该标志，将尝试设置所有类别的区域参数。只要有任何一个类别设置失败，就不会修改任何类别。在使用此标志获取区域设置时，会返回一个代表所有类别设置的字符串。之后可用此字符串恢复设置。

locale.CHAR_MAX

一个符号常量， localeconv() 返回多个值时将会用到。

示例:

>>> import locale
>>> loc = locale.getlocale()  # get current locale
# use German locale; name might vary with platform
>>> locale.setlocale(locale.LC_ALL, 'de_DE')
>>> locale.strcoll('f\xe4n', 'foo')  # compare a string containing an umlaut
>>> locale.setlocale(locale.LC_ALL, '')   # use user's preferred locale
>>> locale.setlocale(locale.LC_ALL, 'C')  # use default (C) locale
>>> locale.setlocale(locale.LC_ALL, loc)  # restore saved locale

背景、细节、提示、技巧和注意事项

C 语言标准将区域定义为程序级别的属性，修改的代价可能相对较高。此外，有某些实现代码写得不好，频繁改变区域可能会导致内核崩溃。于是要想正确使用区域就变得有些痛苦。

当程序第一次启动时，无论用户偏好定义成什么，区域值都是 C。不过有一个例外，就是在启动时修改 LC_CTYPE 类别，设置当前区域编码为用户偏好编码。程序必须调用 setlocale(LC_ALL, '') 明确表示用户偏好区域将设为其他类别。

若要从库程序中调用 setlocale() ，通常这不是个好主意，因为副作用是会影响整个程序。保存和恢复区域设置也几乎一样糟糕：不仅代价高昂，而且会影响到恢复之前运行的其他线程。

如果是要编写通用模块，需要有一种不受区域设置影响的操作方式（比如某些用到 time.strftime() 的格式），将不得不寻找一种不用标准库的方案。更好的办法是说服自己，可以采纳区域设置。只有在万不得已的情况下，才能用文档标注出模块与非 C 区域设置不兼容。

根据区域设置进行数字运算的唯一方法，就是采用本模块定义的函数：atof() 、 atoi() 、 format() 、 str()。

无法根据区域设置进行大小写转换和字符分类。对于（Unicode）文本字符串来说，这些操作都是根据字符值进行的；而对于字节符串来说，转换和分类则是根据字节的 ASCII 值进行的，高位被置位的字节（即非 ASCII 字节）永远不会被转换或被视作字母或空白符之类。

针对扩展程序编写人员和嵌入Python 运行的程序

除了要查询当前区域，扩展模块不应去调用 setlocale()。但由于返回值只能用于恢复设置，所以也没什么用（也许只能用于确认是否为 C）。

当 Python 代码利用 locale 模块修改区域设置时，也会影响到嵌入 Python 运行的应用程序。如果嵌入运行的程序不希望发生这种情况，则应从 config.c 文件的内置模块表中删除 _locale 扩展模块（所有操作均是由它完成的），并确保 _locale 模块不能成为一个共享库。

访问消息目录

locale.gettext(msg)

locale.dgettext(domain, msg)

locale.dcgettext(domain, msg, category)

locale.textdomain(domain)

locale.bindtextdomain(domain, dir)

在提供 gettext 接口的系统中，locale 模块暴露出了 C 库的接口。它由 gettext() 、dgettext() 、dcgettext() 、 textdomain() 、bindtextdomain() 和 bind_textdomain_codeset() 等函数组成。 他们与 gettext 模块中的同名函数类似，但采用了 C 库二进制格式的消息目录，以及 C 库的搜索算法来查找消息目录。

Python 应用程序通常不需要调用这些函数，而应改用 gettext。这条规则的一个已知例外，是与附加 C 库链接的应用程序，他们在内部调用了 gettext() 或 dcgettext()。对于这些应用程序，可能有必要绑定文本域，以便库可以准确找到其消息目录。

程序框架

本章中描述的模块是很大程度上决定程序结构的框架。 目前，这里描述的模块都面向编写命令行接口。

本章描述的完整模块列表如下：

turtle --- 海龟绘图

概述

可用的 Turtle 和 Screen 方法概览

Turtle 方法

TurtleScreen/Screen 方法

RawTurtle/Turtle 方法和对应函数

海龟动作

获取海龟的状态

度量单位设置

画笔控制

绘图状态

颜色控制

填充

更多绘图控制

海龟状态

可见性

外观

使用事件

特殊海龟方法

复合形状

TurtleScreen/Screen 方法及对应函数

窗口控制

动画控制

使用屏幕事件

输入方法

设置与特殊方法

Screen 专有方法, 而非继承自 TurtleScreen

公共类

帮助与配置

如何使用帮助

文档字符串翻译为不同的语言

如何配置 Screen 和 Turtle

turtledemo --- 演示脚本集

Python 2.6 之后的变化

Python 3.0 之后的变化

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

Cmd 对象

Cmd 例子

shlex —— 简单的词法分析

shlex 对象

解析规则

改进的 shell 兼容性

turtle --- 海龟绘图

源码： Lib/turtle.py [https://github.com/python/cpython/tree/3.10/Lib/turtle.py]

概述

海龟绘图很适合用来引导孩子学习编程。 最初来自于 Wally Feurzeig, Seymour Papert 和 Cynthia Solomon 于 1967 年所创造的 Logo 编程语言。

请想象绘图区有一只机器海龟，起始位置在 x-y 平面的 (0, 0) 点。先执行 import turtle，再执行 turtle.forward(15)，它将(在屏幕上)朝所面对的 x 轴正方向前进 15 像素，随着它的移动画出一条线段。再执行 turtle.right(25)，它将原地右转 25 度。

Turtle star

使用海龟绘图可以编写重复执行简单动作的程序画出精细复杂的形状。

from turtle import *
color('red', 'yellow')
begin_fill()
while True:
    forward(200)
    left(170)
    if abs(pos()) < 1:
        break
end_fill()
done()

通过组合使用此类命令，可以轻松地绘制出精美的形状和图案。

turtle 模块是基于 Python 标准发行版 2.5 以来的同名模块重新编写并进行了功能扩展。

新模块尽量保持了原模块的特点，并且(几乎)100%与其兼容。这就意味着初学编程者能够以交互方式使用模块的所有命令、类和方法——运行 IDLE 时注意加 -n 参数。

turtle 模块提供面向对象和面向过程两种形式的海龟绘图基本组件。由于它使用 tkinter 实现基本图形界面，因此需要安装了 Tk 支持的 Python 版本。

面向对象的接口主要使用“2+2”个类：

TurtleScreen 类定义图形窗口作为绘图海龟的运动场。它的构造器需要一个 tkinter.Canvas 或 ScrolledCanvas 作为参数。应在 turtle 作为某个程序的一部分的时候使用。

Screen() 函数返回一个 TurtleScreen 子类的单例对象。此函数应在 turtle 作为独立绘图工具时使用。作为一个单例对象，其所属的类是不可被继承的。

TurtleScreen/Screen 的所有方法还存在对应的函数，即作为面向过程的接口组成部分。

RawTurtle (别名: RawPen) 类定义海龟对象在 TurtleScreen 上绘图。它的构造器需要一个 Canvas, ScrolledCanvas 或 TurtleScreen 作为参数，以指定 RawTurtle 对象在哪里绘图。

从 RawTurtle 派生出子类 Turtle (别名: Pen)，该类对象在 Screen 实例上绘图，如果实例不存在则会自动创建。

RawTurtle/Turtle 的所有方法也存在对应的函数，即作为面向过程的接口组成部分。

过程式接口提供与 Screen 和 Turtle 类的方法相对应的函数。函数名与对应的方法名相同。当 Screen 类的方法对应函数被调用时会自动创建一个 Screen 对象。当 Turtle 类的方法对应函数被调用时会自动创建一个 (匿名的) Turtle 对象。

如果屏幕上需要有多个海龟，就必须使用面向对象的接口。

注解

以下文档给出了函数的参数列表。对于方法来说当然还有额外的第一个参数 self，这里省略了。

可用的 Turtle 和 Screen 方法概览

Turtle 方法

海龟动作

移动和绘制

forward() | fd() 前进

backward() | bk() | back() 后退

right() | rt() 右转

left() | lt() 左转

goto() | setpos() | setposition() 前往/定位

setx() 设置x坐标

sety() 设置y坐标

setheading() | seth() 设置朝向

home() 返回原点

circle() 画圆

dot() 画点

stamp() 印章

clearstamp() 清除印章

clearstamps() 清除多个印章

undo() 撤消

speed() 速度

获取海龟的状态

position() | pos() 位置

towards() 目标方向

xcor() x坐标

ycor() y坐标

heading() 朝向

distance() 距离

设置与度量单位

degrees() 角度

radians() 弧度

画笔控制

绘图状态

pendown() | pd() | down() 画笔落下

penup() | pu() | up() 画笔抬起

pensize() | width() 画笔粗细

pen() 画笔

isdown() 画笔是否落下

颜色控制

color() 颜色

pencolor() 画笔颜色

fillcolor() 填充颜色

填充

filling() 是否填充

begin_fill() 开始填充

end_fill() 结束填充

更多绘图控制

reset() 重置

clear() 清空

write() 书写

海龟状态

可见性

showturtle() | st() 显示海龟

hideturtle() | ht() 隐藏海龟

isvisible() 是否可见

外观

shape() 形状

resizemode() 大小调整模式

shapesize() | turtlesize() 形状大小

shearfactor() 剪切因子

settiltangle() 设置倾角

tiltangle() 倾角

tilt() 倾斜

shapetransform() 变形

get_shapepoly() 获取形状多边形

使用事件

onclick() 当鼠标点击

onrelease() 当鼠标释放

ondrag() 当鼠标拖动

特殊海龟方法

begin_poly() 开始记录多边形

end_poly() 结束记录多边形

get_poly() 获取多边形

clone() 克隆

getturtle() | getpen() 获取海龟画笔

getscreen() 获取屏幕

setundobuffer() 设置撤消缓冲区

undobufferentries() 撤消缓冲区条目数

TurtleScreen/Screen 方法

窗口控制

bgcolor() 背景颜色

bgpic() 背景图片

clearscreen()

resetscreen()

screensize() 屏幕大小

setworldcoordinates() 设置世界坐标系

动画控制

delay() 延迟

tracer() 追踪

update() 更新

使用屏幕事件

listen() 监听

onkey() | onkeyrelease() 当键盘按下并释放

onkeypress() 当键盘按下

onclick() | onscreenclick() 当点击屏幕

ontimer() 当达到定时

mainloop() | done() 主循环

设置与特殊方法

mode()

colormode() 颜色模式

getcanvas() 获取画布

getshapes() 获取形状

register_shape() | addshape() 添加形状

turtles() 所有海龟

window_height() 窗口高度

window_width() 窗口宽度

输入方法

textinput() 文本输入

numinput() 数字输入

Screen 专有方法

bye() 退出

exitonclick() 当点击时退出

setup() 设置

title() 标题

RawTurtle/Turtle 方法和对应函数

本节中的大部分示例都使用 Turtle 类的一个实例，命名为 turtle。

海龟动作

turtle.forward(distance)

turtle.fd(distance)

参数

distance -- 一个数值 (整型或浮点型)

海龟前进 distance 指定的距离，方向为海龟的朝向。

>>> turtle.position()
(0.00,0.00)
>>> turtle.forward(25)
>>> turtle.position()
(25.00,0.00)
>>> turtle.forward(-75)
>>> turtle.position()
(-50.00,0.00)

turtle.back(distance)

turtle.bk(distance)

turtle.backward(distance)

参数

distance -- 一个数值

海龟后退 distance 指定的距离，方向与海龟的朝向相反。不改变海龟的朝向。

>>> turtle.position()
(0.00,0.00)
>>> turtle.backward(30)
>>> turtle.position()
(-30.00,0.00)

turtle.right(angle)

turtle.rt(angle)

参数

angle -- 一个数值 (整型或浮点型)

海龟右转 angle 个单位。(单位默认为角度，但可通过 degrees() 和 radians() 函数改变设置。) 角度的正负由海龟模式确定，参见 mode()。

>>> turtle.heading()
22.0
>>> turtle.right(45)
>>> turtle.heading()
337.0

turtle.left(angle)

turtle.lt(angle)

参数

angle -- 一个数值 (整型或浮点型)

海龟左转 angle 个单位。(单位默认为角度，但可通过 degrees() 和 radians() 函数改变设置。) 角度的正负由海龟模式确定，参见 mode()。

>>> turtle.heading()
22.0
>>> turtle.left(45)
>>> turtle.heading()
67.0

turtle.goto(x, y=None)

turtle.setpos(x, y=None)

turtle.setposition(x, y=None)

参数

x -- 一个数值或数值对/向量

y -- 一个数值或 None

如果 y 为 None，x 应为一个表示坐标的数值对或 Vec2D 类对象 (例如 pos() 返回的对象).

海龟移动到一个绝对坐标。如果画笔已落下将会画线。不改变海龟的朝向。

 >>> 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)

turtle.setx(x)

参数

x -- 一个数值 (整型或浮点型)

设置海龟的横坐标为 x，纵坐标保持不变。

>>> turtle.position()
(0.00,240.00)
>>> turtle.setx(10)
>>> turtle.position()
(10.00,240.00)

turtle.sety(y)

参数

y -- 一个数值 (整型或浮点型)

设置海龟的纵坐标为 y，横坐标保持不变。

>>> turtle.position()
(0.00,40.00)
>>> turtle.sety(-10)
>>> turtle.position()
(0.00,-10.00)

turtle.setheading(to_angle)

turtle.seth(to_angle)

参数

to_angle -- 一个数值 (整型或浮点型)

设置海龟的朝向为 to_angle。以下是以角度表示的几个常用方向：

标准模式 | logo 模式
0 - 东 | 0 - 北
90 - 北 | 90 - 东
180 - 西 | 180 - 南
270 - 南 | 270 - 西

>>> turtle.setheading(90)
>>> turtle.heading()
90.0

turtle.home()

海龟移至初始坐标 (0,0)，并设置朝向为初始方向 (由海龟模式确定，参见 mode())。

>>> turtle.heading()
90.0
>>> turtle.position()
(0.00,-10.00)
>>> turtle.home()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0

turtle.circle(radius, extent=None, steps=None)

参数

radius -- 一个数值

extent -- 一个数值 (或 None)

steps -- 一个整型数 (或 None)

绘制一个 radius 指定半径的圆。圆心在海龟左边 radius 个单位；extent 为一个夹角，用来决定绘制圆的一部分。如未指定 extent*则绘制整个圆。如果 *extent 不是完整圆周，则以当前画笔位置为一个端点绘制圆弧。如果 radius 为正值则朝逆时针方向绘制圆弧，否则朝顺时针方向。最终海龟的朝向会依据 extent 的值而改变。

圆实际是以其内切正多边形来近似表示的，其边的数量由 steps 指定。如果未指定边数则会自动确定。此方法也可用来绘制正多边形。

>>> 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)  # draw a semicircle
>>> turtle.position()
(0.00,240.00)
>>> turtle.heading()
180.0

turtle.dot(size=None, *color)

参数

size -- 一个整型数 >= 1 (如果指定)

color -- 一个颜色字符串或颜色数值元组

绘制一个直径为 size，颜色为 color 的圆点。如果 size 未指定，则直径取 pensize+4 和 2*pensize 中的较大值。

>>> turtle.home()
>>> turtle.dot()
>>> turtle.fd(50); turtle.dot(20, "blue"); turtle.fd(50)
>>> turtle.position()
(100.00,-0.00)
>>> turtle.heading()
0.0

turtle.stamp()

在海龟当前位置印制一个海龟形状。返回该印章的 stamp_id，印章可以通过调用 clearstamp(stamp_id) 来删除。

>>> turtle.color("blue")
>>> turtle.stamp()
11
>>> turtle.fd(50)

turtle.clearstamp(stampid)

参数

stampid -- 一个整型数，必须是之前 stamp() 调用的返回值

删除 stampid 指定的印章。

>>> 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)

turtle.clearstamps(n=None)

参数

n -- 一个整型数 (或 None)

删除全部或前/后 n 个海龟印章。如果 n 为 None 则删除全部印章，如果 n > 0 则删除前 n 个印章，否则如果 n < 0 则删除后 n 个印章。

>>> for i in range(8):
...     turtle.stamp(); turtle.fd(30)
13
14
15
16
17
18
19
20
>>> turtle.clearstamps(2)
>>> turtle.clearstamps(-2)
>>> turtle.clearstamps()

turtle.undo()

撤消 (或连续撤消) 最近的一个 (或多个) 海龟动作。可撤消的次数由撤消缓冲区的大小决定。

>>> for i in range(4):
...     turtle.fd(50); turtle.lt(80)
...
>>> for i in range(8):
...     turtle.undo()

turtle.speed(speed=None)

参数

speed -- 一个 0..10 范围内的整型数或速度字符串 (见下)

设置海龟移动的速度为 0..10 表示的整型数值。如未指定参数则返回当前速度。

如果输入数值大于 10 或小于 0.5 则速度设为 0。速度字符串与速度值的对应关系如下:

"fastest": 0 最快

"fast": 10 快

"normal": 6 正常

"slow": 3 慢

"slowest": 1 最慢

速度值从 1 到 10，画线和海龟转向的动画效果逐级加快。

注意: speed = 0 表示 没有 动画效果。forward/back 将使海龟向前/向后跳跃，同样的 left/right 将使海龟立即改变朝向。

>>> turtle.speed()
3
>>> turtle.speed('normal')
>>> turtle.speed()
6
>>> turtle.speed(9)
>>> turtle.speed()
9

获取海龟的状态

turtle.position()

turtle.pos()

返回海龟当前的坐标 (x,y) (为 Vec2D 矢量类对象)。

>>> turtle.pos()
(440.00,-0.00)

turtle.towards(x, y=None)

参数

x -- 一个数值或数值对/矢量，或一个海龟实例

y -- 一个数值——如果 x 是一个数值，否则为 None

返回从海龟位置到由 (x,y)、矢量或另一海龟所确定位置的连线的夹角。 此数值依赖于海龟的初始朝向，这又取决于 "standard"/"world" 或 "logo" 模式设置。

>>> turtle.goto(10, 10)
>>> turtle.towards(0,0)
225.0

turtle.xcor()

返回海龟的 x 坐标。

>>> turtle.home()
>>> turtle.left(50)
>>> turtle.forward(100)
>>> turtle.pos()
(64.28,76.60)
>>> print(round(turtle.xcor(), 5))
64.27876

turtle.ycor()

返回海龟的 y 坐标。

>>> turtle.home()
>>> turtle.left(60)
>>> turtle.forward(100)
>>> print(turtle.pos())
(50.00,86.60)
>>> print(round(turtle.ycor(), 5))
86.60254

turtle.heading()

返回海龟当前的朝向 (数值依赖于海龟模式参见 mode())。

>>> turtle.home()
>>> turtle.left(67)
>>> turtle.heading()
67.0

turtle.distance(x, y=None)

参数

x -- 一个数值或数值对/矢量，或一个海龟实例

y -- 一个数值——如果 x 是一个数值，否则为 None

返回从海龟位置到由 (x,y)，适量或另一海龟对应位置的单位距离。

>>> turtle.home()
>>> turtle.distance(30,40)
50.0
>>> turtle.distance((30,40))
50.0
>>> joe = Turtle()
>>> joe.forward(77)
>>> turtle.distance(joe)
77.0

度量单位设置

turtle.degrees(fullcircle=360.0)

参数

fullcircle -- 一个数值

设置角度的度量单位，即设置一个圆周为多少 "度"。默认值为 360 度。

>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0

Change angle measurement unit to grad (also known as gon,
grade, or gradian and equals 1/100-th of the right angle.)
>>> turtle.degrees(400.0)
>>> turtle.heading()
100.0
>>> turtle.degrees(360)
>>> turtle.heading()
90.0

turtle.radians()

设置角度的度量单位为弧度。其值等于 degrees(2*math.pi)。

>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0
>>> turtle.radians()
>>> turtle.heading()
1.5707963267948966

画笔控制

绘图状态

turtle.pendown()

turtle.pd()

turtle.down()

画笔落下 -- 移动时将画线。

turtle.penup()

turtle.pu()

turtle.up()

画笔抬起 -- 移动时不画线。

turtle.pensize(width=None)

turtle.width(width=None)

参数

width -- 一个正数值

设置线条的粗细为 width 或返回该值。如果 resizemode 设为 "auto" 并且 turtleshape 为多边形，该多边形也以同样组细的线条绘制。如未指定参数，则返回当前的 pensize。

>>> turtle.pensize()
1
>>> turtle.pensize(10)   # from here on lines of width 10 are drawn

turtle.pen(pen=None, **pendict)

参数

pen -- 一个包含部分或全部下列键的字典

pendict -- 一个或多个以下列键为关键字的关键字参数

返回或设置画笔的属性，以一个包含以下键值对的 "画笔字典" 表示:

"shown": True/False

"pendown": True/False

"pencolor": 颜色字符串或颜色元组

"fillcolor": 颜色字符串或颜色元组

"pensize": 正数值

"speed": 0..10 范围内的数值

"resizemode": "auto" 或 "user" 或 "noresize"

"stretchfactor": (正数值, 正数值)

"outline": 正数值

"tilt": 数值

此字典可作为后续调用 pen() 时的参数，以恢复之前的画笔状态。另外还可将这些属性作为关键词参数提交。使用此方式可以用一条语句设置画笔的多个属性。

>>> 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', ''), ('outline', 1), ('pencolor', 'yellow')]
>>> turtle.pen(penstate, fillcolor="green")
>>> sorted(turtle.pen().items())[:3]
[('fillcolor', 'green'), ('outline', 1), ('pencolor', 'red')]

turtle.isdown()

如果画笔落下返回 True，如果画笔抬起返回 False。

>>> turtle.penup()
>>> turtle.isdown()
False
>>> turtle.pendown()
>>> turtle.isdown()
True

颜色控制

turtle.pencolor(*args)

返回或设置画笔颜色。

允许以下四种输入格式:

pencolor()

返回以颜色描述字符串或元组 (见示例) 表示的当前画笔颜色。可用作其他 color/pencolor/fillcolor 调用的输入。

pencolor(colorstring)

设置画笔颜色为 colorstring 指定的 Tk 颜色描述字符串，例如 "red"、"yellow" 或 "#33cc8c"。

pencolor((r, g, b))

设置画笔颜色为以 r, g, b 元组表示的 RGB 颜色。r, g, b 的取值范围应为 0..colormode，colormode 的值为 1.0 或 255 (参见 colormode())。

pencolor(r, g, b)

设置画笔颜色为以 r, g, b 表示的 RGB 颜色。r, g, b 的取值范围应为 0..colormode。

如果 turtleshape 为多边形，该多边形轮廓也以新设置的画笔颜色绘制。

 >>> 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)

turtle.fillcolor(*args)

返回或设置填充颜色。

允许以下四种输入格式:

fillcolor()

返回以颜色描述字符串或元组 (见示例) 表示的当前填充颜色。可用作其他 color/pencolor/fillcolor 调用的输入。

fillcolor(colorstring)

设置填充颜色为 colorstring 指定的 Tk 颜色描述字符串，例如 "red"、"yellow" 或 "#33cc8c"。

fillcolor((r, g, b))

设置填充颜色为以 r, g, b 元组表示的 RGB 颜色。r, g, b 的取值范围应为 0..colormode，colormode 的值为 1.0 或 255 (参见 colormode())。

fillcolor(r, g, b)

设置填充颜色为 r, g, b 表示的 RGB 颜色。r, g, b 的取值范围应为 0..colormode。

如果 turtleshape 为多边形，该多边形内部也以新设置的填充颜色填充。

 >>> turtle.fillcolor("violet")
 >>> turtle.fillcolor()
 'violet'
 >>> turtle.pencolor()
 (50.0, 193.0, 143.0)
 >>> turtle.fillcolor((50, 193, 143))  # Integers, not floats
 >>> turtle.fillcolor()
 (50.0, 193.0, 143.0)
 >>> turtle.fillcolor('#ffffff')
 >>> turtle.fillcolor()
 (255.0, 255.0, 255.0)

turtle.color(*args)

返回或设置画笔颜色和填充颜色。

允许多种输入格式。使用如下 0 至 3 个参数:

color()

返回以一对颜色描述字符串或元组表示的当前画笔颜色和填充颜色，两者可分别由 pencolor() 和 fillcolor() 返回。

color(colorstring), color((r,g,b)), color(r,g,b)

输入格式与 pencolor() 相同，同时设置填充颜色和画笔颜色为指定的值。

color(colorstring1, colorstring2), color((r1,g1,b1), (r2,g2,b2))

相当于 pencolor(colorstring1) 加 fillcolor(colorstring2)，使用其他输入格式的方法也与之类似。

如果 turtleshape 为多边形，该多边形轮廓与填充也使用新设置的颜色。

 >>> turtle.color("red", "green")
 >>> turtle.color()
 ('red', 'green')
 >>> color("#285078", "#a0c8f0")
 >>> color()
 ((40.0, 80.0, 120.0), (160.0, 200.0, 240.0))

另参见: Screen 方法 colormode()。

填充

turtle.filling()

返回填充状态 (填充为 True，否则为 False)。

 >>> turtle.begin_fill()
 >>> if turtle.filling():
 ...    turtle.pensize(5)
 ... else:
 ...    turtle.pensize(3)

turtle.begin_fill()

在绘制要填充的形状之前调用。

turtle.end_fill()

填充上次调用 begin_fill() 之后绘制的形状。

自相交多边形或多个形状间的重叠区域是否填充取决于操作系统的图形引擎、重叠的类型以及重叠的层数。 例如上面的 Turtle 多芒星可能会全部填充为黄色，也可能会有一些白色区域。

>>> turtle.color("black", "red")
>>> turtle.begin_fill()
>>> turtle.circle(80)
>>> turtle.end_fill()

更多绘图控制

turtle.reset()

从屏幕中删除海龟的绘图，海龟回到原点并设置所有变量为默认值。

>>> 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

turtle.clear()

从屏幕中删除指定海龟的绘图。不移动海龟。海龟的状态和位置以及其他海龟的绘图不受影响。

turtle.write(arg, move=False, align='left', font=('Arial', 8, 'normal'))

参数

arg -- 要书写到 TurtleScreen 的对象

move -- True/False

align -- 字符串 "left", "center" 或 "right"

font -- 一个三元组 (fontname, fontsize, fonttype)

基于 align ("left", "center" 或 "right") 并使用给定的字体将文本 —— arg 的字符串表示形式 —— 写到当前海龟位置。 如果 move 为真值，画笔会移至文本的右下角。 默认情况下 move 为 False。

>>> turtle.write("Home = ", True, align="center")
>>> turtle.write((0,0), True)

海龟状态

可见性

turtle.hideturtle()

turtle.ht()

使海龟不可见。当你绘制复杂图形时这是个好主意，因为隐藏海龟可显著加快绘制速度。

>>> turtle.hideturtle()

turtle.showturtle()

turtle.st()

使海龟可见。

>>> turtle.showturtle()

turtle.isvisible()

如果海龟显示返回 True，如果海龟隐藏返回 False。

>>> turtle.hideturtle()
>>> turtle.isvisible()
False
>>> turtle.showturtle()
>>> turtle.isvisible()
True

外观

turtle.shape(name=None)

参数

name -- 一个有效的形状名字符串

设置海龟形状为 name 指定的形状名，如未指定形状名则返回当前的形状名。name 指定的形状名应存在于 TurtleScreen 的 shape 字典中。多边形的形状初始时有以下几种: "arrow", "turtle", "circle", "square", "triangle", "classic"。要了解如何处理形状请参看 Screen 方法 register_shape()。

>>> turtle.shape()
'classic'
>>> turtle.shape("turtle")
>>> turtle.shape()
'turtle'

turtle.resizemode(rmode=None)

参数

rmode -- 字符串 "auto", "user", "noresize" 其中之一

设置大小调整模式为以下值之一: "auto", "user", "noresize"。如未指定 rmode 则返回当前的大小调整模式。不同的大小调整模式的效果如下:

"auto": 根据画笔粗细值调整海龟的外观。

"user": 根据拉伸因子和轮廓宽度 (outline) 值调整海龟的外观，两者是由 shapesize() 设置的。

"noresize": 不调整海龟的外观大小。

resizemode("user") 会由 shapesize() 带参数使用时被调用。

>>> turtle.resizemode()
'noresize'
>>> turtle.resizemode("auto")
>>> turtle.resizemode()
'auto'

turtle.shapesize(stretch_wid=None, stretch_len=None, outline=None)

turtle.turtlesize(stretch_wid=None, stretch_len=None, outline=None)

参数

stretch_wid -- 正数值

stretch_len -- 正数值

outline -- 正数值

返回或设置画笔的属性 x/y 拉伸因子和/或轮廓。 设置大小调整模式为 "user"。 当且仅当大小调整模式为 "user" 时，海龟会基于其拉伸因子调整外观: stretch_wid 为垂直于其朝向的宽度拉伸因子，stretch_len 为平行于其朝向的长度拉伸因子，outline 决定形状轮廓线的宽度。

>>> 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)

turtle.shearfactor(shear=None)

参数

shear -- 数值 (可选)

设置或返回当前的剪切因子。根据 share 指定的剪切因子即剪切角度的切线来剪切海龟形状。不 改变海龟的朝向 (移动方向)。如未指定 shear 参数: 返回当前的剪切因子即剪切角度的切线，与海龟朝向平行的线条将被剪切。

 >>> turtle.shape("circle")
 >>> turtle.shapesize(5,2)
 >>> turtle.shearfactor(0.5)
 >>> turtle.shearfactor()
 0.5

turtle.tilt(angle)

参数

angle -- 一个数值

海龟形状自其当前的倾角转动 angle 指定的角度，但 不 改变海龟的朝向 (移动方向)。

>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(30)
>>> turtle.fd(50)
>>> turtle.tilt(30)
>>> turtle.fd(50)

turtle.settiltangle(angle)

参数

angle -- 一个数值

旋转海龟形状使其指向 angle 指定的方向，忽略其当前的倾角，不 改变海龟的朝向 (移动方向)。

>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.settiltangle(45)
>>> turtle.fd(50)
>>> turtle.settiltangle(-45)
>>> turtle.fd(50)

3.1 版后已移除.

turtle.tiltangle(angle=None)

参数

angle -- 一个数值 (可选)

设置或返回当前的倾角。如果指定 angle 则旋转海龟形状使其指向 angle 指定的方向，忽略其当前的倾角。不 改变海龟的朝向 (移动方向)。如果未指定 angle: 返回当前的倾角，即海龟形状的方向和海龟朝向 (移动方向) 之间的夹角。

>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(45)
>>> turtle.tiltangle()
45.0

turtle.shapetransform(t11=None, t12=None, t21=None, t22=None)

参数

t11 -- 一个数值 (可选)

t12 -- 一个数值 (可选)

t21 -- 一个数值 (可选)

t12 -- 一个数值 (可选)

设置或返回海龟形状的当前变形矩阵。

如未指定任何矩阵元素，则返回以 4 元素元组表示的变形矩阵。 否则就根据设置指定元素的矩阵来改变海龟形状，矩阵第一排的值为 t11, t12 而第二排的值为 t21, t22。 行列式 t11 * t22 - t12 * t21 必须不为零，否则会引发错误。 根据指定矩阵修改拉伸因子 stretchfactor, 剪切因子 shearfactor 和倾角 tiltangle。

>>> turtle = Turtle()
>>> turtle.shape("square")
>>> turtle.shapesize(4,2)
>>> turtle.shearfactor(-0.5)
>>> turtle.shapetransform()
(4.0, -1.0, -0.0, 2.0)

turtle.get_shapepoly()

返回以坐标值对元组表示的当前形状多边形。这可以用于定义一个新形状或一个复合形状的多个组成部分。

>>> turtle.shape("square")
>>> turtle.shapetransform(4, -1, 0, 2)
>>> turtle.get_shapepoly()
((50, -20), (30, 20), (-50, 20), (-30, -20))

使用事件

turtle.onclick(fun, btn=1, add=None)

参数

fun -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

btn -- 鼠标按钮编号，默认值为 1 (鼠标左键)

add -- True 或 False -- 如为 True 则将添加一个新绑定，否则将取代先前的绑定

将 fun 指定的函数绑定到鼠标点击此海龟事件。如果 fun 值为 None，则移除现有的绑定。以下为使用匿名海龟即过程式的示例:

>>> def turn(x, y):
...     left(180)
...
>>> onclick(turn)  # Now clicking into the turtle will turn it.
>>> onclick(None)  # event-binding will be removed

turtle.onrelease(fun, btn=1, add=None)

参数

fun -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

btn -- 鼠标按钮编号，默认值为 1 (鼠标左键)

add -- True 或 False -- 如为 True 则将添加一个新绑定，否则将取代先前的绑定

将 fun 指定的函数绑定到在此海龟上释放鼠标按键事件。如果 fun 值为 None，则移除现有的绑定。

>>> class MyTurtle(Turtle):
...     def glow(self,x,y):
...         self.fillcolor("red")
...     def unglow(self,x,y):
...         self.fillcolor("")
...
>>> turtle = MyTurtle()
>>> turtle.onclick(turtle.glow)     # clicking on turtle turns fillcolor red,
>>> turtle.onrelease(turtle.unglow) # releasing turns it to transparent.

turtle.ondrag(fun, btn=1, add=None)

参数

fun -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

btn -- 鼠标按钮编号，默认值为 1 (鼠标左键)

add -- True 或 False -- 如为 True 则将添加一个新绑定，否则将取代先前的绑定

将 fun 指定的函数绑定到在此海龟上移动鼠标事件。如果 fun 值为 None，则移除现有的绑定。

注: 在海龟上移动鼠标事件之前应先发生在此海龟上点击鼠标事件。

>>> turtle.ondrag(turtle.goto)

在此之后点击并拖动海龟可在屏幕上手绘线条 (如果画笔为落下)。

特殊海龟方法

turtle.begin_poly()

开始记录多边形的顶点。当前海龟位置为多边形的第一个顶点。

turtle.end_poly()

停止记录多边形的顶点。当前海龟位置为多边形的最后一个顶点。它将连线到第一个顶点。

turtle.get_poly()

返回最新记录的多边形。

>>> 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)

turtle.clone()

创建并返回海龟的克隆体，具有相同的位置、朝向和海龟属性。

>>> mick = Turtle()
>>> joe = mick.clone()

turtle.getturtle()

turtle.getpen()

返回海龟对象自身。唯一合理的用法: 作为一个函数来返回 "匿名海龟":

>>> pet = getturtle()
>>> pet.fd(50)
>>> pet
<turtle.Turtle object at 0x...>

turtle.getscreen()

返回作为海龟绘图场所的 TurtleScreen 类对象。该对象将可调用 TurtleScreen 方法。

>>> ts = turtle.getscreen()
>>> ts
<turtle._Screen object at 0x...>
>>> ts.bgcolor("pink")

turtle.setundobuffer(size)

参数

size -- 一个整型数值或 None

设置或禁用撤销缓冲区。 如果 size 为整数，则开辟一个给定大小的空撤销缓冲区。 size 给出了可以通过 undo() 方法/函数撤销海龟动作的最大次数。 如果 size 为 None，则禁用撤销缓冲区。

>>> turtle.setundobuffer(42)

turtle.undobufferentries()

返回撤销缓冲区里的条目数。

>>> while undobufferentries():
...     undo()

复合形状

要使用由多个不同颜色多边形构成的复合海龟形状，你必须明确地使用辅助类 Shape，具体步骤如下:

创建一个空 Shape 对象，类型为 "compound"。

可根据需要使用 addcomponent() 方法向此对象添加多个组件。

例如:

>>> 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")

接下来将 Shape 对象添加到 Screen 对象的形状列表并使用它:

>>> register_shape("myshape", s)
>>> shape("myshape")

注解

Shape 类在 register_shape() 方法的内部以多种方式使用。应用程序编写者 只有 在使用上述的复合形状时才需要处理 Shape 类。

TurtleScreen/Screen 方法及对应函数

本节中的大部分示例都使用 TurtleScreen 类的一个实例，命名为 screen。

窗口控制

turtle.bgcolor(*args)

参数

args -- 一个颜色字符串或三个取值范围 0..colormode 内的数值或一个取值范围相同的数值3元组

设置或返回 TurtleScreen 的背景颜色。

>>> screen.bgcolor("orange")
>>> screen.bgcolor()
'orange'
>>> screen.bgcolor("#800080")
>>> screen.bgcolor()
(128.0, 0.0, 128.0)

turtle.bgpic(picname=None)

参数

picname -- 一个字符串, gif-文件名, "nopic", 或 None

设置背景图片或返回当前背景图片名称。如果 picname 为一个文件名，则将相应图片设为背景。如果 picname 为 "nopic"，则删除当前背景图片。如果 picname 为 None，则返回当前背景图片文件名。:

>>> screen.bgpic()
'nopic'
>>> screen.bgpic("landscape.gif")
>>> screen.bgpic()
"landscape.gif"

turtle.clear()

注解

此 TurtleScreen 方法作为全局函数时只有一个名字 clearscreen。全局函数 clear 所对应的是 Turtle 方法 clear。

turtle.clearscreen()

从中删除所有海龟的全部绘图。将已清空的 TurtleScreen 重置为初始状态: 白色背景，无背景片，无事件绑定并启用追踪。

turtle.reset()

注解

此 TurtleScreen 方法作为全局函数时只有一个名字 resetscreen。全局函数 reset 所对应的是 Turtle 方法 reset。

turtle.resetscreen()

重置屏幕上的所有海龟为其初始状态。

turtle.screensize(canvwidth=None, canvheight=None, bg=None)

参数

canvwidth -- 正整型数，以像素表示画布的新宽度值

canvheight -- 正整型数，以像素表示画面的新高度值

bg -- 颜色字符串或颜色元组，新的背景颜色

如未指定任何参数，则返回当前的 (canvaswidth, canvasheight)。否则改变作为海龟绘图场所的画布大小。不改变绘图窗口。要观察画布的隐藏区域，可以使用滚动条。通过此方法可以令之前绘制于画布之外的图形变为可见。

>>> screen.screensize()
(400, 300)
>>> screen.screensize(2000,1500)
>>> screen.screensize()
(2000, 1500)

也可以用来寻找意外逃走的海龟 ;-)

turtle.setworldcoordinates(llx, lly, urx, ury)

参数

llx -- 一个数值, 画布左下角的 x-坐标

lly -- 一个数值, 画布左下角的 y-坐标

urx -- 一个数值, 画面右上角的 x-坐标

ury -- 一个数值, 画布右上角的 y-坐标

设置用户自定义坐标系并在必要时切换模式为 "world"。这会执行一次 screen.reset()。如果 "world" 模式已激活，则所有图形将根据新的坐标系重绘。

注意: 在用户自定义坐标系中，角度可能显得扭曲。

>>> screen.reset()
>>> screen.setworldcoordinates(-50,-7.5,50,7.5)
>>> for _ in range(72):
...     left(10)
...
>>> for _ in range(8):
...     left(45); fd(2)   # a regular octagon

动画控制

turtle.delay(delay=None)

参数

delay -- 正整型数

设置或返回以毫秒数表示的延迟值 delay。(这约等于连续两次画布刷新的间隔时间。) 绘图延迟越长，动画速度越慢。

可选参数:

>>> screen.delay()
10
>>> screen.delay(5)
>>> screen.delay()
5

turtle.tracer(n=None, delay=None)

参数

n -- 非负整型数

delay -- 非负整型数

启用/禁用海龟动画并设置刷新图形的延迟时间。如果指定 n 值，则只有每第 n 次屏幕刷新会实际执行。(可被用来加速复杂图形的绘制。) 如果调用时不带参数，则返回当前保存的 n 值。第二个参数设置延迟值 (参见 delay())。

>>> screen.tracer(8, 25)
>>> dist = 2
>>> for i in range(200):
...     fd(dist)
...     rt(90)
...     dist += 2

turtle.update()

执行一次 TurtleScreen 刷新。在禁用追踪时使用。

另参见 RawTurtle/Turtle 方法 speed()。

使用屏幕事件

turtle.listen(xdummy=None, ydummy=None)

设置焦点到 TurtleScreen (以便接收按键事件)。使用两个 Dummy 参数以便能够传递 listen() 给 onclick 方法。

turtle.onkey(fun, key)

turtle.onkeyrelease(fun, key)

参数

fun -- 一个无参数的函数或 None

key -- 一个字符串: 键 (例如 "a") 或键标 (例如 "space")

绑定 fun 指定的函数到按键释放事件。如果 fun 值为 None，则移除事件绑定。注: 为了能够注册按键事件，TurtleScreen 必须得到焦点。(参见 method listen() 方法。)

>>> def f():
...     fd(50)
...     lt(60)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()

turtle.onkeypress(fun, key=None)

参数

fun -- 一个无参数的函数或 None

key -- 一个字符串: 键 (例如 "a") 或键标 (例如 "space")

绑定 fun 指定的函数到指定键的按下事件。如未指定键则绑定到任意键的按下事件。注: 为了能够注册按键事件，必须得到焦点。(参见 listen() 方法。)

>>> def f():
...     fd(50)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()

turtle.onclick(fun, btn=1, add=None)

turtle.onscreenclick(fun, btn=1, add=None)

参数

fun -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

btn -- 鼠标按钮编号，默认值为 1 (鼠标左键)

add -- True 或 False -- 如为 True 则将添加一个新绑定，否则将取代先前的绑定

绑定 fun 指定的函数到鼠标点击屏幕事件。如果 fun 值为 None，则移除现有的绑定。

以下示例使用一个 TurtleScreen 实例 screen 和一个 Turtle 实例 turtle:

>>> screen.onclick(turtle.goto) # Subsequently clicking into the TurtleScreen will
>>>                             # make the turtle move to the clicked point.
>>> screen.onclick(None)        # remove event binding again

注解

此 TurtleScreen 方法作为全局函数时只有一个名字 onscreenclick。全局函数 onclick 所对应的是 Turtle 方法 onclick。

turtle.ontimer(fun, t=0)

参数

fun -- 一个无参数的函数

t -- 一个数值 >= 0

安装一个计时器，在 t 毫秒后调用 fun 函数。

>>> running = True
>>> def f():
...     if running:
...         fd(50)
...         lt(60)
...         screen.ontimer(f, 250)
>>> f()   ### makes the turtle march around
>>> running = False

turtle.mainloop()

turtle.done()

开始事件循环 - 调用 Tkinter 的 mainloop 函数。必须作为一个海龟绘图程序的结束语句。如果一个脚本是在以 -n 模式 (无子进程) 启动的 IDLE 中运行时 不可 使用 - 用于实现海龟绘图的交互功能。:

>>> screen.mainloop()

输入方法

turtle.textinput(title, prompt)

参数

title -- string

prompt -- string

弹出一个对话框窗口用来输入一个字符串。形参 title 为对话框窗口的标题，prompt 为一条文本，通常用来提示要输入什么信息。返回输入的字符串。如果对话框被取消则返回 None。:

>>> screen.textinput("NIM", "Name of first player:")

turtle.numinput(title, prompt, default=None, minval=None, maxval=None)

参数

title -- string

prompt -- string

default -- 数值 (可选)

minval -- 数值 (可选)

maxval -- 数值 (可选)

弹出一个对话框窗口用来输入一个数值。title 为对话框窗口的标题，prompt 为一条文本，通常用来描述要输入的数值信息。default: 默认值, minval: 可输入的最小值, maxval: 可输入的最大值。输入数值的必须在指定的 minval .. maxval 范围之内，否则将给出一条提示，对话框保持打开等待修改。返回输入的数值。如果对话框被取消则返回 None。:

>>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000)

设置与特殊方法

turtle.mode(mode=None)

参数

mode -- 字符串 "standard", "logo" 或 "world" 其中之一

设置海龟模式 ("standard", "logo" 或 "world") 并执行重置。如未指定模式则返回当前的模式。

"standard" 模式与旧的 turtle 兼容。"logo" 模式与大部分 Logo 海龟绘图兼容。"world" 模式使用用户自定义的 "世界坐标系"。注意: 在此模式下，如果 x/y 单位比率不等于 1 则角度会显得扭曲。

模式 | 初始海龟朝向 | 正数角度
"standard" | 朝右 (东) | 逆时针
"logo" | 朝上 (北) | 顺时针

>>> mode("logo")   # resets turtle heading to north
>>> mode()
'logo'

turtle.colormode(cmode=None)

参数

cmode -- 数值 1.0 或 255 其中之一

返回颜色模式或将其设为 1.0 或 255。构成颜色三元组的 r, g, b 数值必须在 0..cmode 范围之内。

>>> 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)

turtle.getcanvas()

返回此 TurtleScreen 的 Canvas 对象。供了解 Tkinter 的 Canvas 对象内部机理的人士使用。

>>> cv = screen.getcanvas()
>>> cv
<turtle.ScrolledCanvas object ...>

turtle.getshapes()

返回所有当前可用海龟形状的列表。

>>> screen.getshapes()
['arrow', 'blank', 'circle', ..., 'turtle']

turtle.register_shape(name, shape=None)

turtle.addshape(name, shape=None)

调用此函数有三种不同方式:

name 为一个 gif 文件的文件名， shape 为 None: 安装相应的图像形状。:

>>> screen.register_shape("turtle.gif")

注解

当海龟转向时图像形状 不会 转动，因此无法显示海龟的朝向!

name 为指定的字符串，shape 为由坐标值对构成的元组: 安装相应的多边形形状。

>>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))

name 为指定的字符串， 为一个 (复合) Shape 类对象: 安装相应的复合形状。

将一个海龟形状加入 TurtleScreen 的形状列表。只有这样注册过的形状才能通过执行 shape(shapename) 命令来使用。

turtle.turtles()

返回屏幕上的海龟列表。

>>> for turtle in screen.turtles():
...     turtle.color("red")

turtle.window_height()

返回海龟窗口的高度。:

>>> screen.window_height()
480

turtle.window_width()

返回海龟窗口的宽度。:

>>> screen.window_width()
640

Screen 专有方法, 而非继承自 TurtleScreen

turtle.bye()

关闭海龟绘图窗口。

turtle.exitonclick()

将 bye() 方法绑定到 Screen 上的鼠标点击事件。

如果配置字典中 "using_IDLE" 的值为 False (默认值) 则同时进入主事件循环。注: 如果启动 IDLE 时使用了 -n 开关 (无子进程)，turtle.cfg 中此数值应设为 True。在此情况下 IDLE 本身的主事件循环同样会作用于客户脚本。

turtle.setup(width=_CFG['width'], height=_CFG['height'], startx=_CFG['leftright'], starty=_CFG['topbottom'])

设置主窗口的大小和位置。默认参数值保存在配置字典中，可通过 turtle.cfg 文件进行修改。

参数

width -- 如为一个整型数值，表示大小为多少像素，如为一个浮点数值，则表示屏幕的占比；默认为屏幕的 50%

height -- 如为一个整型数值，表示高度为多少像素，如为一个浮点数值，则表示屏幕的占比；默认为屏幕的 75%

startx -- 如为正值，表示初始位置距离屏幕左边缘多少像素，负值表示距离右边缘，None 表示窗口水平居中

starty -- 如为正值，表示初始位置距离屏幕上边缘多少像素，负值表示距离下边缘，None 表示窗口垂直居中

>>> screen.setup (width=200, height=200, startx=0, starty=0)
>>>              # sets window to 200x200 pixels, in upper left of screen
>>> screen.setup(width=.75, height=0.5, startx=None, starty=None)
>>>              # sets window to 75% of screen by 50% of screen and centers

turtle.title(titlestring)

参数

titlestring -- 一个字符串，显示为海龟绘图窗口的标题栏文本

设置海龟窗口标题为 titlestring 指定的文本。

>>> screen.title("Welcome to the turtle zoo!")

公共类

class turtle.RawTurtle(canvas)

class turtle.RawPen(canvas)

参数

canvas -- 一个 tkinter.Canvas , ScrolledCanvas 或 TurtleScreen 类对象

创建一个海龟。海龟对象具有 "Turtle/RawTurtle 方法" 一节所述的全部方法。

class turtle.Turtle

RawTurtle 的子类，具有相同的接口，但其绘图场所为默认的 Screen 类对象，在首次使用时自动创建。

class turtle.TurtleScreen(cv)

参数

cv -- 一个 tkinter.Canvas 类对象

提供面向屏幕的方法如 bgcolor() 等。 说明见上文。

class turtle.Screen

TurtleScreen 的子类，增加了四个方法.

class turtle.ScrolledCanvas(master)

参数

master -- 可容纳 ScrolledCanvas 的 Tkinter 部件，即添加了滚动条的 Tkinter-canvas

由 Screen 类使用，使其能够自动提供一个 ScrolledCanvas 作为海龟的绘图场所。

class turtle.Shape(type_, data)

参数

type_ -- 字符串 "polygon", "image", "compound" 其中之一

实现形状的数据结构。(type_, data) 必须遵循以下定义:

type_ | data
"polygon" | 一个多边形元组，即由坐标值对构成的元组
"image" | 一个图片 (此形式仅限内部使用!)
"compound" | None (复合形状必须使用 addcomponent() 方法来构建)

addcomponent(poly, fill, outline=None)

参数

poly -- 一个多边形，即由数值对构成的元组

fill -- 一种颜色，将用来填充 poly 指定的多边形

outline -- 一种颜色，用于多边形的轮廓 (如有指定)

示例:

>>> poly = ((0,0),(10,-5),(0,10),(-10,-5))
>>> s = Shape("compound")
>>> s.addcomponent(poly, "red", "blue")
>>> # ... add more components and then use register_shape()

参见 复合形状。

class turtle.Vec2D(x, y)

一个二维矢量类，用来作为实现海龟绘图的辅助类。也可能在海龟绘图程序中使用。派生自元组，因此矢量也属于元组!

提供的运算 (a, b 为矢量, k 为数值):

a + b 矢量加法

a - b 矢量减法

a * b 内积

k * a 和 a * k 与标量相乘

abs(a) a 的绝对值

a.rotate(angle) 旋转

帮助与配置

如何使用帮助

Screen 和 Turtle 类的公用方法以文档字符串提供了详细的文档。因此可以利用 Python 帮助工具获取这些在线帮助信息:

当使用 IDLE 时，输入函数/方法调用将弹出工具提示显示其签名和文档字符串的头几行。

对文法或函数调用 help() 将显示其文档字符串:

>>> 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()

方法对应函数的文档字符串的形式会有一些修改:

>>> 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()

这些修改版文档字符串是在导入时与方法对应函数的定义一起自动生成的。

文档字符串翻译为不同的语言

可使用工具创建一个字典，键为方法名，值为 Screen 和 Turtle 类公共方法的文档字符串。

turtle.write_docstringdict(filename='turtle_docstringdict')

参数

filename -- 一个字符串，表示文件名

创建文档字符串字典并将其写入 filename 指定的 Python 脚本文件。此函数必须显示地调用 (海龟绘图类并不使用此函数)。文档字符串字典将被写入到 Python 脚本文件 filename.py。该文件可作为模板用来将文档字符串翻译为不同语言。

如果你 (或你的学生) 想使用本国语言版本的 turtle 在线帮助，你必须翻译文档字符串并保存结果文件，例如 turtle_docstringdict_german.py.

如果你在 turtle.cfg 文件中加入了相应的条目，此字典将在导入模块时被读取并替代原有的英文版文档字符串。

在撰写本文档时已经有了德语和意大利语版的文档字符串字典。(更多需求请联系 glingl@aon.at)

如何配置 Screen 和 Turtle

内置的默认配置是模仿旧 turtle 模块的外观和行为，以便尽可能地与其保持兼容。

如果你想使用不同的配置，以便更好地反映此模块的特性或是更适合你的需求，例如在课堂中使用，你可以准备一个配置文件 turtle.cfg，该文件将在导入模块时被读取并根据其中的设定修改模块配置。

内置的配置对应了下面的 turtle.cfg:

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

选定条目的简短说明:

开头的四行对应了 Screen.setup 方法的参数。

第 5 和第 6 行对应于 Screen.screensize 方法的参数。

shape 可以是任何内置形状，即: arrow, turtle 等。更多信息可用 help(shape) 查看。

如果你想使用无填充色（即让海龟变透明），则你必须写 fillcolor = "" (但在but all nonempty strings must not have quotes in the cfg 文件中所有非空字符串都不可加引号)。

如果你想令海龟反映其状态，你必须使用 resizemode = auto。

如果你设置语言例如 language = italian 则文档字符串字典 turtle_docstringdict_italian.py 将在导入模块时被加载 (如果导入路径即 turtle 的目录中存在此文件。

exampleturtle 和 examplescreen 条目定义了相应对象在文档字符串中显示的名称。方法文档字符串转换为函数文档字符串时将从文档字符串中删去这些名称。

using_IDLE: 如果你经常使用 IDLE 并启用其 -n 开关 ("无子进程") 则应将此项设为 True，这将阻止 exitonclick() 进入主事件循环。

turtle.cfg 文件可以保存于 turtle 所在目录，当前工作目录也可以有一个同名文件。后者会重载覆盖前者的设置。

Lib/turtledemo 目录中也有一个 turtle.cfg 文件。你可以将其作为示例进行研究，并在运行演示时查看其作用效果 (但最好不要在演示查看器中运行)。

turtledemo --- 演示脚本集

turtledemo 包汇集了一组演示脚本。这些脚本可以通过以下命令打开所提供的演示查看器运行和查看:

python -m turtledemo

此外，你也可以单独运行其中的演示脚本。例如，:

python -m turtledemo.bytedesign

turtledemo 包目录中的内容:

一个演示查看器 __main__.py，可用来查看脚本的源码并即时运行。

多个脚本文件，演示 turtle 模块的不同特性。所有示例可通过 Examples 菜单打开。也可以单独运行每个脚本。

一个 turtle.cfg 文件，作为说明如何编写并使用模块配置文件的示例模板。

演示脚本清单如下:

名称 | 描述 | 相关特性
bytedesign | 复杂的传统海龟绘图模式 | tracer(), delay, update()
chaos | 绘制 Verhulst 动态模型，演示通过计算机的运算可能会生成令人惊叹的结果 | 世界坐标系
clock | 绘制模拟时钟显示本机的当前时间 | 海龟作为表针, ontimer
colormixer | 试验 r, g, b 颜色模式 | ondrag() 当鼠标拖动
forest | 绘制 3 棵广度优先树 | 随机化
fractalcurves | 绘制 Hilbert & Koch 曲线 | 递归
lindenmayer | 文化数学 (印度装饰艺术) | L-系统
minimal_hanoi | 汉诺塔 | 矩形海龟作为汉诺盘 (shape, shapesize)
nim | 玩经典的“尼姆”游戏，开始时有三堆小棒，与电脑对战。 | 海龟作为小棒，事件驱动 (鼠标, 键盘)
paint | 超极简主义绘画程序 | onclick() 当鼠标点击
peace | 初级技巧 | 海龟: 外观与动画
penrose | 非周期性地使用风筝和飞镖形状铺满平面 | stamp() 印章
planet_and_moon | 模拟引力系统 | 复合开关, Vec2D 类
rosette | 一个来自介绍海龟绘图的维基百科文章的图案 | clone(), undo()
round_dance | 两两相对并不断旋转舞蹈的海龟 | 复合形状, clone shapesize, tilt, get_shapepoly, update
sorting_animate | 动态演示不同的排序方法 | 简单对齐, 随机化
tree | 一棵 (图形化的) 广度优先树 (使用生成器) | clone() 克隆
two_canvases | 简单设计 | 两块画布上的海龟
yinyang | 另一个初级示例 | circle() 画圆

祝你玩得开心！

Python 2.6 之后的变化

Turtle.tracer, Turtle.window_width 和 Turtle.window_height 等方法已被去除。 具有这些名称和功能的方法现在只限于作为 Screen 的方法。 自这些方法派生的函数仍保持可用。 (实际上在 Python 2.6 中这些方法就已经只是对应 TurtleScreen/Screen 方法的副本了。)

Turtle.fill() 方法已被去除。 begin_fill() 和 end_fill() 的行为则有细微改变：现在每个填充过程必须以一个 end_fill() 调用来结束。

增加了一个 Turtle.filling 方法。 该方法返回一个布尔值：如果填充过程正在运行则为 True，否则为 False。 此行为对应于 Python 2.6 中一个不带参数的 fill() 调用。

Python 3.0 之后的变化

增加了 Turtle 方法 shearfactor(), shapetransform() 和 get_shapepoly()。 这样就可以使用所有的常规线性变换来改变海龟形状。 tiltangle() 的功能已得到加强：现在它可以被用来获取或设置倾斜角度。 settiltangle() 已被弃用。has been deprecated.

增加了 Screen 方法 onkeypress() 作为 onkey() 的补充。 当后者将动作绑定到松开按键事件时，还将为它添加一个别名: onkeyrelease()。

增加了 Screen.mainloop 方法，这样在操作 Screen 和 Turtle 对象时就无需再使用单独的 mainloop() 函数。

增加了两个输入方法: Screen.textinput 和 Screen.numinput。 这两个方法会弹出输入对话框接受输入并分别返回字符串和数字。 These pop up input dialogs and return strings and numbers respectively.

两个新的示例脚本 tdemo_nim.py 和 tdemo_round_dance.py 被加入到 Lib/turtledemo 目录中。

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

源代码: Lib/cmd.py [https://github.com/python/cpython/tree/3.10/Lib/cmd.py]

Cmd 类提供简单框架用于编写面向行的命令解释器。 这些通常对测试工具，管理工具和原型有用，这些工具随后将被包含在更复杂的接口中。

class cmd.Cmd(completekey='tab', stdin=None, stdout=None)

一个 Cmd 实例或子类实例是面向行的解释器框架结构。 实例化 Cmd 本身是没有充分理由的， 它作为自定义解释器类的超类是非常有用的为了继承 Cmd 的方法并且封装动作方法。

可选参数 completekey 是完成键的 readline 名称；默认是 Tab 。如果 completekey 不是 None 并且 readline 是可用的， 命令完成会自动完成。

可选参数 stdin 和 stdout 指定了Cmd实例或子类实例将用于输入和输出的输入和输出文件对象。如果没有指定，他们将默认为 sys.stdin 和 sys.stdout 。

如果你想要使用一个给定的 stdin ，确保将实例的 use_rawinput 属性设置为 False ，否则 stdin 将被忽略。

Cmd 对象

Cmd 实例有下列方法：

Cmd.cmdloop(intro=None)

反复发出提示，接受输入，从收到的输入中解析出一个初始前缀，并分派给操作方法，将其余的行作为参数传递给它们。

可选参数是在第一个提示之前发布的横幅或介绍字符串（这将覆盖 intro 类属性）。

如果 readline 继承模块被加载，输入将自动继承类似 bash的历史列表编辑（例如， Control-P 滚动回到最后一个命令， Control-N 转到下一个命令，以 Control-F 非破坏性的方式向右 Control-B 移动光标，破坏性地等）。

输入的文件结束符被作为字符串传回 'EOF' 。

解释器实例将会识别命令名称 foo 当且仅当它有方法 do_foo() 。有一个特殊情况，分派始于字符 '?' 的行到方法 do_help() 。另一种特殊情况，分派始于字符 '!' 的行到方法 do_shell() （如果定义了这个方法）

这个方法将返回当 postcmd() 方法返回一个真值 。参数 stop 到 postcmd() 是命令对应的返回值 do_*() 的方法。

如果激活了完成，全部命令将会自动完成，并且通过调用 complete_foo() 参数 text , line, begidx ,和 endidx 完成全部命令参数。 text 是我们试图匹配的字符串前缀，所有返回的匹配项必须以它为开头。 line 是删除了前导空格的当前的输入行， begidx 和 endidx 是前缀文本的开始和结束索引。，可以用于根据参数位置提供不同的完成。

所有 Cmd 的子类继承一个预定义 do_help() 。 这个方法使用参数 'bar' 调用， 调用对应的方法 help_bar() ，如果不存在，打印 do_bar() 的文档字符串，如果可用。没有参数的情况下， do_help() 方法会列出所有可用的帮助主题 （即所有具有相应的 help_*() 方法或命令的 文档字符串），也会列举所有未被记录的命令。

Cmd.onecmd(str)

解释该参数，就好像它是为响应提示而键入的一样。 这可能会被覆盖，但通常不应该被覆盖; 请参阅： precmd() 和 postcmd() 方法，用于执行有用的挂钩。 返回值是一个标志，指示解释器对命令的解释是否应该停止。 如果命令 str 有一个 do_*() 方法，则返回该方法的返回值，否则返回 default() 方法的返回值。

Cmd.emptyline()

在响应提示输入空行时调用的方法。如果此方法未被覆盖，则重复输入的最后一个非空命令。

Cmd.default(line)

当命令前缀不能被识别的时候在输入行调用的方法。如果此方法未被覆盖，它将输出一个错误信息并返回。

Cmd.completedefault(text, line, begidx, endidx)

当没有特定于命令的 complete_*() 方法可用时，调用此方法完成输入行。默认情况下，它返回一个空列表。

Cmd.precmd(line)

钩方法在命令行 line 被解释之前执行，但是在输入提示被生成和发出后。这个方法是一个在 Cmd 中的存根；它的存在是为了被子类覆盖。返回值被用作 onecmd() 方法执行的命令； precmd() 的实现或许会重写命令或者简单的返回 line 不变。

Cmd.postcmd(stop, line)

钩方法只在命令调度完成后执行。这个方法是一个在 Cmd 中的存根；它的存在是为了子类被覆盖。 line 是被执行的命令行， stop 是一个表示在调用 postcmd() 之后是否终止执行的标志；这将作为 onecmd() 方法的返回值。这个方法的返回值被用作与 stop 相关联的内部标志的新值；返回 false 将导致解释继续。

Cmd.preloop()

钩方法当 cmdloop() 被调用时执行一次。方法是一个在 Cmd 中的存根；它的存在是为了被子类覆盖。

Cmd.postloop()

钩方法在 cmdloop() 即将返回时执行一次。这个方法是一个在 Cmd 中的存根；它的存在是为了被子类覆盖。

Instances of Cmd subclasses have some public instance variables:

Cmd.prompt

发出提示以请求输入。

Cmd.identchars

接受命令前缀的字符串。

Cmd.lastcmd

看到最后一个非空命令前缀。

Cmd.cmdqueue

排队的输入行列表。当需要新的输入时，在 cmdloop() 中检查 cmdqueue 列表；如果它不是空的，它的元素将被按顺序处理，就像在提示符处输入一样。

Cmd.intro

要作为简介或横幅发出的字符串。 可以通过给 cmdloop() 方法一个参数来覆盖它。

Cmd.doc_header

如果帮助输出具有记录命令的段落，则发出头文件。

Cmd.misc_header

如果帮助输出其他帮助主题的部分（即与 do_*() 方法没有关联的 help_*() 方法），则发出头文件。

Cmd.undoc_header

如果帮助输出未被记录命令的部分（即与 help_*() 方法没有关联的 do_*() 方法），则发出头文件。

Cmd.ruler

用于在帮助信息标题的下方绘制分隔符的字符，如果为空，则不绘制标尺线。这个字符默认是 '=' 。

Cmd.use_rawinput

这是一个标志，默认为 true 。如果为 true ，, cmdloop() 使用 input() 先是提示并且阅读下一个命令；如果为 false ， sys.stdout.write() 和 sys.stdin.readline() 被使用。（这意味着解释器将会自动支持类似于 Emacs的行编辑和命令历史记录按键操作，通过导入 readline 在支持它的系统上。）

Cmd 例子

The cmd module is mainly useful for building custom shells that let a user work with a program interactively.

这部分提供了一个简单的例子来介绍如何使用一部分在 turtle 模块中的命令构建一个 shell 。

基础的 turtle 命令比如 forward() 被添加进一个 Cmd 子类，方法名为 do_forward() 。参数被转换成数字并且分发至 turtle 模块中。 docstring 是 shell 提供的帮助实用程序。

例子也包含使用 precmd() 方法实现基础的记录和回放的功能，这个方法负责将输入转换为小写并且将命令写入文件。 do_playback() 方法读取文件并添加记录命令至 cmdqueue 用于即时回放:

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

    # ----- basic turtle commands -----
    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

    # ----- record and playback -----
    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()

这是一个示例会话，其中 turtle shell 显示帮助功能，使用空行重复命令，以及简单的记录和回放功能：

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

shlex —— 简单的词法分析

源代码： Lib/shlex.py [https://github.com/python/cpython/tree/3.10/Lib/shlex.py]

shlex 类可用于编写类似 Unix shell 的简单词法分析程序。通常可用于编写“迷你语言”（如 Python 应用程序的运行控制文件）或解析带引号的字符串。

shlex 模块中定义了以下函数：

shlex.split(s, comments=False, posix=True)

用类似 shell 的语法拆分字符串 s。如果 comments 为 False (默认值)，则不会解析给定字符串中的注释 (commenters 属性的 shlex 实例设为空字符串)。 本函数默认工作于 POSIX 模式下，但若 posix 参数为 False，则采用非 POSIX 模式。

注解

Since the split() function instantiates a shlex instance, passing None for s will read the string to split from standard input.

3.9 版后已移除: 在以后的 Python 版本中，给 s 传入 None 将触发异常。

shlex.join(split_command)

将列表 split_command 中的词法单元（token）串联起来，返回一个字符串。本函数是 split() 的逆运算。

>>> from shlex import join
>>> print(join(['echo', '-n', 'Multiple words']))
echo -n 'Multiple words'

为防止注入漏洞，返回值是经过 shell 转义的（参见 quote() ）。

3.8 新版功能.

shlex.quote(s)

返回经过 shell 转义的字符串 s 。返回值为字符串，可以安全地用作 shell 命令行中的词法单元，可用于不能使用列表的场合。

警告

shlex 模块 仅适用于 Unix shell。

在不兼容 POSIX 的 shell 或其他操作系统（如Windows）的shell上，并不保证 quote() 函数能够正常使用。在这种 shell 中执行用本模块包装过的命令，有可能会存在命令注入漏洞。

请考虑采用命令参数以列表形式给出的函数，比如带了 shell=False 参数的 subprocess.run() 。

以下用法是不安全的：

>>> filename = 'somefile; rm -rf ~'
>>> command = 'ls -l {}'.format(filename)
>>> print(command)  # executed by a shell: boom!
ls -l somefile; rm -rf ~

用 quote() 可以堵住这种安全漏洞：

>>> 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 ~'"'"''

这种包装方式兼容于 UNIX shell 和 split() 。

>>> 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 ~']

3.3 新版功能.

shlex 模块中定义了以下类：

class shlex.shlex(instream=None, infile=None, posix=False, punctuation_chars=False)

shlex 及其子类的实例是一种词义分析器对象。 利用初始化参数可指定从哪里读取字符。 初始化参数必须是具备 read() 和 readline() 方法的文件/流对象，或者是一个字符串。 如果没有给出初始化参数，则会从 sys.stdin 获取输入。 第二个可选参数是个文件名字符串，用于设置 infile 属性的初始值。 如果 instream 参数被省略或等于 sys.stdin，则第二个参数默认为 "stdin"。 posix 参数定义了操作的模式：若 posix 不为真值（默认），则 shlex 实例将工作于兼容模式。 若运行于 POSIX 模式下，则 shlex 会尽可能地应用 POSIX shell 解析规则。 punctuation_chars 参数提供了一种使行为更接近于真正的 shell 解析的方式。 该参数可接受多种值：默认值、False、保持 Python 3.5 及更早版本的行为。 如果设为 True，则会改变对字符 ();<>|& 的解析方式：这些字符将作为独立的词法单元被返回（视作标点符号）。 如果设为非空字符串，则这些字符将被用作标点符号。 出现在 punctuation_chars 中的 wordchars 属性中的任何字符都会从 wordchars 中被删除。 请参阅 改进的 shell 兼容性 了解详情。 punctuation_chars 只能在创建 shlex 实例时设置，以后不能再作修改。

在 3.6 版更改: 加入 punctuation_chars 参数。

参见

configparser 模块

配置文件解析器，类似于 Windows 的 .ini 文件。

shlex 对象

shlex 实例具备以下方法：

shlex.get_token()

返回一个词法单元。如果所有单词已用 push_token() 堆叠在一起了，则从堆栈中弹出一个词法单元。否则就从输入流中读取一个。如果读取时遇到文件结束符，则会返回 eof`（在非 POSIX 模式下为空字符串 `''，在 POSIX 模式下为 ``None）。

shlex.push_token(str)

将参数值压入词法单元堆栈。

shlex.read_token()

读取一个原始词法单元。忽略堆栈，且不解释源请求。（通常没什么用，只是为了完整起见。）

shlex.sourcehook(filename)

当 shlex 检测到源请求（见下面的 source），以下词法单元可作为参数，并应返回一个由文件名和打开的文件对象组成的元组。

通常本方法会先移除参数中的引号。如果结果为绝对路径名，或者之前没有有效的源请求，或者之前的源请求是一个流对象（比如 sys.stdin），那么结果将不做处理。否则，如果结果是相对路径名，那么前面将会加上目录部分，目录名来自于源堆栈中前一个文件名（类似于 C 预处理器对 #include "file.h" 的处理方式）。

结果被视为一个文件名，并作为元组的第一部分返回，元组的第二部分以此为基础调用 open() 获得。（注意：这与实例初始化过程中的参数顺序相反！)

此钩子函数是公开的，可用于实现路径搜索、添加文件扩展名或黑入其他命名空间。没有对应的“关闭”钩子函数，但 shlex 实例在返回 EOF 时会调用源输入流的 close() 方法。

若要更明确地控制源堆栈，请采用 push_source() 和 pop_source() 方法。

shlex.push_source(newstream, newfile=None)

将输入源流压入输入堆栈。如果指定了文件名参数，以后错误信息中将会用到。sourcehook() 内部同样使用了本方法。

shlex.pop_source()

从输入堆栈中弹出最后一条输入源。当遇到输入流的 EOF 时，内部也使用同一方法。

shlex.error_leader(infile=None, lineno=None)

本方法生成一条错误信息的首部，以 Unix C 编译器错误标签的形式；格式为 '"%s", line %d: '，其中 %s 被替换为当前源文件的名称，%d 被替换为当前输入行号（可用可选参数覆盖）。

这是个快捷函数，旨在鼓励 shlex 用户以标准的、可解析的格式生成错误信息，以便 Emacs 和其他 Unix 工具理解。

shlex 子类的实例有一些公共实例变量，这些变量可以控制词义分析，也可用于调试。

shlex.commenters

将被视为注释起始字符串。从注释起始字符串到行尾的所有字符都将被忽略。默认情况下只包括 '#'。

shlex.wordchars

可连成多字符词法单元的字符串。默认包含所有 ASCII 字母数字和下划线。在 POSIX 模式下，Latin-1 字符集的重音字符也被包括在内。如果 punctuation_chars 不为空，则可出现在文件名规范和命令行参数中的 ~-./*?= 字符也将包含在内，任何 punctuation_chars 中的字符将从 wordchars 中移除。如果 whitespace_split 设为 True，则本规则无效。

shlex.whitespace

将被视为空白符并跳过的字符。空白符是词法单元的边界。默认包含空格、制表符、换行符和回车符。

shlex.escape

将视为转义字符。仅适用于 POSIX 模式，默认只包含 '\'。

shlex.quotes

将视为引号的字符。词法单元中的字符将会累至再次遇到同样的引号（因此，不同的引号会像在 shell 中一样相互包含。）默认包含 ASCII 单引号和双引号。

shlex.escapedquotes

quotes 中的字符将会解析 escape 定义的转义字符。这只在 POSIX 模式下使用，默认只包含 '"'。

shlex.whitespace_split

若为 True，则只根据空白符拆分词法单元。这很有用，比如用 shlex 解析命令行，用类似 shell 参数的方式读取各个词法单元。当与 punctuation_chars 一起使用时，将根据空白符和这些字符拆分词法单元。

在 3.8 版更改: punctuation_chars 属性已与 whitespace_split 属性兼容。

shlex.infile

当前输入的文件名，可能是在类实例化时设置的，或者是由后来的源请求堆栈生成的。在构建错误信息时可能会用到本属性。

shlex.instream

shlex 实例正从中读取字符的输入流。

shlex.source

本属性默认值为 None。 如果给定一个字符串，则会识别为包含请求，类似于各种 shell 中的 source 关键字。 也就是说，紧随其后的词法单元将作为文件名打开，作为输入流，直至遇到 EOF 后调用流的 close() 方法，然后原输入流仍变回输入源。Source 请求可以在词义堆栈中嵌套任意深度。

shlex.debug

如果本属性为大于 1 的数字，则 shlex 实例会把动作进度详细地输出出来。若需用到本属性，可阅读源代码来了解细节。

shlex.lineno

源的行数（到目前为止读到的换行符数量加 1）。

shlex.token

词法单元的缓冲区。在捕获异常时可能会用到。

shlex.eof

用于确定文件结束的词法单元。在非 POSIX 模式下，将设为空字符串 ''，在 POSIX 模式下被设为 None。

shlex.punctuation_chars

只读属性。表示应视作标点符号的字符。标点符号将作为单个词法单元返回。然而，请注意不会进行语义有效性检查：比如 “>>>” 可能会作为一个词法单元返回，虽然 shell 可能无法识别。

3.6 新版功能.

解析规则

在非 POSIX 模式下时，shlex 会试图遵守以下规则：

不识别单词中的引号（Do"Not"Separate 解析为一个单词 Do"Not"Separate）；

不识别转义字符；

引号包裹的字符保留字面意思；

成对的引号会将单词分离（"Do"Separate 解析为 "Do" 和 Separate）；

如果 whitespace_split 为 False，则未声明为单词字符、空白或引号的字符将作为单字符的词法单元返回。若为 True， 则 shlex 只根据空白符拆分单词。

EOF 用空字符串（''）表示；

空字符串无法解析，即便是加了引号。

在 POSIX 模式时，shlex 将尝试遵守以下解析规则：

引号会被剔除，且不会拆分单词（ "Do"Not"Separate" 将解析为单个单词 DoNotSeparate）；

未加引号包裹的转义字符（如 '\' ）保留后一个字符的字面意思；

引号中的字符不属于 escapedquotes （例如，"'"），则保留引号中所有字符的字面值；

若引号包裹的字符属于 escapedquotes （例如 '"'），则保留引号中所有字符的字面意思，属于 escape 中的字符除外。仅当后跟后半个引号或转义字符本身时，转义字符才保留其特殊含义。否则，转义字符将视作普通字符；

EOF 用 None 表示；

允许出现引号包裹的空字符串（''）。

改进的 shell 兼容性

3.6 新版功能.

shlex 类提供了与常见 Unix shell（如 bash、 dash 和 sh）的解析兼容性。为了充分利用这种兼容性，请在构造函数中设定 punctuation_chars 参数。该参数默认为 False，维持 3.6 以下版本的行为。如果设为 True，则会改变对 ();<>|& 字符的解析方式：这些字符都将视为单个的词法单元返回。虽然不算是完整的 shell 解析程序（考虑到 shell 的多样性，超出了标准库的范围），但确实能比其他方式更容易进行命令行的处理。以下代码段演示了两者的差异：

 >>> 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', ')']

当然，返回的词法单元对 shell 无效，需要对返回的词法单元自行进行错误检查。

punctuation_chars 参数可以不传入 True ，而是传入包含特定字符的字符串，用于确定由哪些字符构成标点符号。例如：

>>> import shlex
>>> s = shlex.shlex("a && b || c", punctuation_chars="|")
>>> list(s)
['a', '&', '&', 'b', '||', 'c']

注解

如果指定了 punctuation_chars，则 wordchars 属性的参数会是 ~-./*?=。因为这些字符可以出现在文件名（包括通配符）和命令行参数中（如 --color=auto）。因此：

>>> import shlex
>>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?',
...                 punctuation_chars=True)
>>> list(s)
['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']

不过为了尽可能接近于 shell ，建议在使用 punctuation_chars 时始终使用 posix 和 whitespace_split ，这将完全否定 wordchars 。

为了达到最佳效果，punctuation_chars 应与 posix=True 一起设置。（注意 posix=False 是 shlex 的默认设置)。

Tk图形用户界面(GUI)

Tcl/Tk集成到Python中已经有一些年头了。Python程序员可以通过 tkinter 包和它的扩展， tkinter.tix 模块和 tkinter.ttk 模块，来使用这套鲁棒的、平台无关的窗口工具集。

tkinter 包是使用面向对象方式对 Tcl/Tk 进行的一层薄包装。 使用 tkinter，你不需要写 Tcl 代码，但你将需要参阅 Tk 文档，有时还需要参阅 Tcl 文档。 tkinter 是一组包装器，它将 Tk 的可视化部件实现为相应的 Python 类。

tkinter 的主要特点是速度很快，并且通常直接附带在 Python 中。 虽然它的官方文档做得不好，但还是有许多可用的资源，包括：在线参考、教程、入门书等等。 tkinter 还有众所周知的较过时的外观界面，这在 Tk 8.5 中已得到很大改进。 无论如何，你还可以考虑许多其他的 GUI 库。 Python wiki 例出了一些替代性的 GUI 框架和工具 [https://wiki.python.org/moin/GuiProgramming]。

tkinter —— Tcl/Tk 的 Python 接口

架构

Tkinter 模块

Tkinter 拾遗

Hello World 程序

重要的 Tk 概念

了解 Tkinter 如何封装 Tcl/Tk

我该如何...？这个选项会做...？

浏览 Tcl/Tk 参考手册

线程模型

快速参考

可选配置项

包装器

包装器的参数

部件与变量的关联

窗口管理器

Tk 参数的数据类型

绑定和事件

index 参数

图片

文件处理程序

tkinter.colorchooser --- 颜色选择对话框

tkinter.font --- Tkinter 字体封装

Tkinter 对话框

tkinter.simpledialog --- 标准 Tkinter 输入对话框

tkinter.filedialog --- 文件选择对话框.

原生的载入/保存对话框.

tkinter.commondialog --- 对话窗口模板

tkinter.messagebox --- Tkinter 消息提示

tkinter.scrolledtext --- 滚动文字控件

tkinter.dnd --- 拖放操作支持

tkinter.ttk --- Tk 风格的控件

ttk 的用法

ttk 控件

控件

标准属性

可滚动控件的属性

标签控件的属性

兼容性属性

控件状态

ttk.Widget

Combobox

属性

虚拟事件

ttk.Combobox

Spinbox

属性

虚拟事件

ttk.Spinbox

Notebook

属性

Tab 属性

Tab ID

虚拟事件

ttk.Notebook

Progressbar

属性

ttk.Progressbar

Separator

属性

Sizegrip

与平台相关的注意事项

Bug

Treeview

属性

数据项的属性

tag 属性

列标识

虚拟事件

ttk.Treeview

Ttk 样式

布局

tkinter.tix --- TK扩展包

使用 Tix

Tix 部件

基本部件

文件选择器

层级式列表框

表格式列表框

管理器部件

图像类型

其他部件

表单布局管理器

Tix 命令

IDLE

目录

文件菜单 （命令行和编辑器）

编辑菜单（命令行和编辑器）

格式菜单（仅 window 编辑器）

运行菜单（仅 window 编辑器）

Shell 菜单（仅限 Shell 窗口）

调试菜单（仅限 Shell 窗口）

选项菜单（命令行和编辑器）

Window 菜单（命令行和编辑器）

帮助菜单（命令行和编辑器）

上下文菜单

编辑和导航

编辑窗口

按键绑定

自动缩进

搜索和替换

补全

提示

代码上下文

Shell 窗口

文本颜色

启动和代码执行

命令行语法

启动失败

运行用户代码

Shell中的用户输出

开发 tkinter 应用程序

在没有子进程的情况下运行

帮助和首选项Help and Preferences

帮助源

首选项设置

macOS 上的IDLE

扩展

idlelib

tkinter —— Tcl/Tk 的 Python 接口

源代码: Lib/tkinter/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/__init__.py]

tkinter 包 ("Tk 接口") 是针对 Tcl/Tk GUI 工具包的标准 Python 接口。 Tk 和 tkinter 在大多数 Unix 平台，包括 macOS，以及 Windows 系统上均可使用。

若在命令行执行 python -m tkinter，应会弹出一个简单的 Tk 界面窗口， 表明 tkinter 包已安装完成，还会显示当前安装的 Tcl/Tk 版本，以便阅读对应版本的 Tcl/Tk 文档。

Tkinter 支持众多的 Tcl/Tk 版本，带或不带多线程版本均可。官方的 Python 二进制版本捆绑了 Tcl/Tk 8.6 多线程版本。关于可支持版本的更多信息，请参阅 _tkinter 模块的源代码。

Tkinter 并不只是做了简单的封装，而是增加了相当多的代码逻辑，让使用体验更具 Python 风格（pythonic） 。本文将集中介绍这些增加和变化部分，关于未改动部分的细节，请参考 Tcl/Tk 官方文档。

注解

Tcl/Tk 8.5 (2007) 引入了支持主题的现代风格用户界面组件集以及使用这些组件的新版 API。 旧版和新版 API 都可以使用。 你在网上所能找到的大多数文档仍然是使用旧版 API 因此也许已经相当过时。

参见

TkDocs [https://tkdocs.com/]

关于使用 Tkinter 创建用户界面的详细教程。 讲解了关键概念，并介绍了使用现代 API 的推荐方式。

Tkinter 8.5 参考手册：一种 Python GUI [https://www.tkdocs.com/shipman/]

详细讲解可用的类、方法和选项的 Tkinter 8.5 参考文档。

Tcl/Tk 资源:

Tk 命令 [https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm]

有关 Tkinter 所使用的每个底层 Tcl/Tk 命令的完整参考文档。

Tcl/Tk 主页 [https://www.tcl.tk]

额外的文档，以及 Tcl/Tk 核心开发相关链接。

书籍:

Modern Tkinter for Busy Python Developers [https://tkdocs.com/book.html]

Mark Roseman 著。 (ISBN 978-1999149567)

Python and Tkinter Programming [https://www.packtpub.com/product/python-gui-programming-with-tkinter/9781788835886]

Alan Moore 著。 (ISBN 978-1788835886)

Programming Python [https://learning-python.com/about-pp4e.html]

Mark Lutz 著；对 Tkinter 进行了精彩的讲解。 (ISBN 978-0596158101)

Tcl and the Tk Toolkit (2nd edition) [https://www.amazon.com/exec/obidos/ASIN/032133633X]

John Ousterhout ，Tcl/Tk 的创造者，与 Ken Jones 合著；未涉及 Tkinter。 (ISBN 978-0321336330)

架构

Tcl/Tk 不是只有单个库，而是由几个不同的模块组成的，每个模块都有各自的功能和各自的官方文档。 Python 的二进制发行版还会再附加一个模块。

Tcl

Tcl 是一种动态解释型编程语言，正如 Python 一样。尽管它可作为一种通用的编程语言单独使用，但最常见的用法还是作为脚本引擎或 Tk 工具包的接口嵌入到 C 程序中。Tcl 库有一个 C 接口，用于创建和管理一个或多个 Tcl 解释器实例，并在这些实例中运行 Tcl 命令和脚本，添加用 Tcl 或 C 语言实现的自定义命令。每个解释器都拥有一个事件队列，某些部件可向解释器发送事件交由其处理。与 Python 不同，Tcl 的执行模型是围绕协同多任务而设计的，Tkinter 协调了两者的差别（详见 Threading model ）。

Tk

Tk 是一个用 C 语言实现的 Tcl 包 [https://wiki.tcl-lang.org/37432]，它添加了用于创建和操纵 GUI 部件的自定义命令。 每个 Tk 对象都嵌入了自己的 Tcl 解释器实例并将 Tk 加载到其中。 Tk 的部件是高度可定制的，但其代价则是过时的外观。 Tk 使用 Tcl 的事件队列来生成并处理 GUI 事件。

Ttk

带有主题的 Tk（Ttk）是较新加入的 Tk 部件，相比很多经典的 Tk 部件，在各平台提供的界面更加美观。自 Tk 8.5 版本开始，Ttk 作为 Tk 的成员进行发布。Python 则捆绑在一个单独的模块中， tkinter.ttk。

在内部，Tk 和 Ttk 使用下层操作系统的工具库，例如在 Unix/X11 上是 Xlib，在 macOS 上是 Cocoa，在 Windows 上是 GDI。

当你的 Python 应用程序使用 Tkinter 中的某个类，例如创建一个部件时，tkinter 模块将首先生成一个 Tcl/Tk 命令字符串。 它会把这个 Tcl 命令字符串传给内部的 _tkinter 二进制模块，后者将随后调用 Tcl 解释器来对其求值。 Tcl 解释器随后将对 Tk 和/和 Ttk 包唤起，它们又将继续对 Xlib, Cocoa 或 GDI 发起调用。

Tkinter 模块

对 Tkinter 的支持分布在多个模块中。 大多数应用程序将需要主模块 tkinter，以及 tkinter.ttk 模块，后者提供了带主题的现代部件集及相应的 API:

from tkinter import *
from tkinter import ttk

class tkinter.Tk(screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)

构造一个最高层级的 Tk 部件，这通常是一个应用程序的主窗口，并为这个部件初始化 Tcl 解释器。 每个实例都有其各自所关联的 Tcl 解释器。

Tk 类通常全部使用默认值来初始化。 不过，目前还可识别下列关键字参数:

screenName

当（作为字符串）给出时，设置 DISPLAY 环境变量。 （仅限 X11）

baseName

预置文件的名称。 在默认情况下，baseName 是来自于程序名称 (sys.argv[0])。

className

控件类的名称。 会被用作预置文件同时也作为 Tcl 唤起的名称 (interp 中的 argv0)。

useTk

如果为 True，则初始化 Tk 子系统。 tkinter.Tcl() 函数会将其设为 False。

sync

如果为 True，则同步执行所有 X 服务器命令，以便立即报告错误。 可被用于调试。 （仅限 X11）

use

指定嵌入应用程序的窗口 id，而不是将其创建为独立的顶层窗口。 id 必须以与顶层控件的 -use 选项值相同的方式来指定（也就是说，它具有与 winfo_id() 的返回值相同的形式）。

请注意在某些平台上只有当 id 是指向一个启用了 -container 选项的 Tk 框架或顶层窗口时此参数才能正确生效。

Tk 读取并解释预置文件，其名称为 .className.tcl 和 .baseName.tcl，进入 Tcl 解释器并基于 .className.py 在 .baseName.py 的内容调用 exec()。 预置文件的路径为 HOME 环境变量，或者如果它未被设置，则为 os.curdir。

tk

通过实例化 Tk 创建的 Tk 应用程序对象。 这提供了对 Tcl 解释器的访问。 每个被附加到相同 Tk 实例的控件都具有相同的 tk 属性值。

master

包含此控件的控件对象。 对于 Tk，master 将为 None 因为它是主窗口。 术语 master 和 parent 是类似的且有时作为参数名称被交替使用；但是，调用 winfo_parent() 将返回控件名称字符串而 master 将返回控件对象。 parent/child 反映了树型关系而 master/slave 反映了容器结构。

children

以 dict 表示的此控件的直接下级其中的键为子控件名称而值为子实例对象。

tkinter.Tcl(screenName=None, baseName=None, className='Tk', useTk=False)

Tcl() 函数是一个工厂函数，它创建的对象类似于 Tk 类创建的，只是不会初始化 Tk 子系统。这在调动 Tcl 解释器时最为有用，这时不想创建多余的顶层窗口，或者无法创建（比如不带 X 服务的 Unix/Linux 系统）。由 Tcl() 创建的对象可调用 loadtk() 方法创建一个顶层窗口（且会初始化 Tk 子系统）。

提供 Tk 支持的模块包括:

tkinter

主 Tkinter 模块。

tkinter.colorchooser

让用户选择颜色的对话框。

tkinter.commondialog

本文其他模块定义的对话框的基类。

tkinter.filedialog

允许用户指定文件的通用对话框，用于打开或保存文件。

tkinter.font

帮助操作字体的工具。

tkinter.messagebox

访问标准的 Tk 对话框。

tkinter.scrolledtext

内置纵向滚动条的文本组件。

tkinter.simpledialog

基础对话框和一些便捷功能。

tkinter.ttk

在 Tk 8.5 中引入的带主题的控件集，提供了对应于 tkinter 模块中许多经典控件的现代替代。

附加模块:

_tkinter

一个包含低层级 Tcl/Tk 接口的二进制模块。 它会被主 tkinter 模块自动导入，且永远不应被应用程序员所直接使用。 它通常是一个共享库（或 DLL），但在某些情况下可能被动态链接到 Python 解释器。

idlelib

Python 的集成开发与学习环境（IDLE）。 基于 tkinter。

tkinter.constants

当向 Tkinter 调用传入各种形参时可被用来代替字符串的符号常量。 由主 tkinter 模块自动导入。

tkinter.dnd

针对 tkinter 的（实验性的）拖放支持。 当以 Tk DND 代替时它将会被弃用。

tkinter.tix

（已弃用）一个增加了部分新控件的较老的第三方 Tcl/Tk 包。 对多数人来说可以在 tkinter.ttk 中找到更好的替代品。

turtle

Tk 窗口中的海龟绘图库。

Tkinter 拾遗

这一章节的设计目的不是要编写有关 Tk 或 Tkinter 的冗长教程。 要获取教程，请参阅之前列出的外部资源之一。 相反地，这一章节提供了对于 Tkinter 应用程序大致样貌的快速指导，列出了基本的 Tk 概念，并解释了 Tkinter 包装器的构造是什么样的。

这一章节的剩余部分将帮助你识别在你的 Tkinter 应用程序中需要的类、方法和选项，以及在哪里可以找到有关它们的更详细文档，包括官方 Tcl/Tk 参考手册等。

Hello World 程序

让我们先来看一个 Tkinter 的 "Hello World" 应用程序。 这并不是我们所能写出的最简短版本，但也足够说明你所需要了解的一些关键概念。

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()

在导入语句之后，下一行语句创建了一个 Tk 类的实例，它会初始化 Tk 并创建与其关联的 Tcl 解释器。 它还会创建一个顶层窗口，名为 root 窗口，它将被作为应用程序的主窗口。

下一行创建了一个框架控件，在本示例中它会包含我们即将创建的一个标签和一个按钮。 框架被嵌在 root 窗口内部。

下一行创建了一个包含静态文本字符串的标签控件。 grid() 方法被用来指明标签在包含它的框架控件中的相对布局（定位），作用类似于 HTML 中的表格。

接下来创建了一个按钮控件，并被放置到标签的右侧。 当被按下时，它将调用 root 窗口的 destroy() 方法。

最后，mainloop() 方法将所有控件显示出来，并响应用户输入直到程序终结。

重要的 Tk 概念

即便是这样简单的程序也阐明了以下关键 Tk 概念:

控件

Tkinter 用户界面是由一个个 控件 组成的。 每个控件都由相应的 Python 对象表示，由 ttk.Frame, ttk.Label 以及 ttk.Button 这样的类来实例化。

控件层级结构

控件按 层级结构 来组织。 标签和按钮包含在框架中，框架又包含在根窗口中。 当创建每个 子 控件时，它的 父 控件会作为控件构造器的第一个参数被传入。

配置选项

控件具有 配置选项，配置选项会改变控件的外观和行为，例如要在标签或按钮中显示的文本。 不同的控件类会具有不同的选项集。

几何管理

小部件在创建时不会自动添加到用户界面。一个像 grid 的 几何管理器 控制这些小部件在用户界面的位置。

事件循环

只有主动运行一个 事件循环，Tkinter 才会对用户的输入做出反应，改变你的程序，以及刷新显示。如果你的程序没有运行事件循环，你的用户界面不会更新。

了解 Tkinter 如何封装 Tcl/Tk

当你的应用程序使用 Tkinter 的类和方法时，Tkinter 内部汇编代表 Tcl/Tk 命令的字符串，并且在连接到你的应用程序的 Tk 实例的 Tcl 解释器中执行这些命令。

无论是试图浏览参考文档，或是试图找到正确的方法或选项，调整一些现有的代码，亦或是调试 Tkinter 应用程序，有时候理解底层 Tcl/Tk 命令是什么样子的会很有用。

为了说明这一点，下面是 Tcl/Tk 等价于上面 Tkinter 脚本的主要部分。

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

Tcl 的语法类似于许多 shell 语言，其中第一个单词是要执行的命令，后面是该命令的参数，用空格分隔。不谈太多细节，请注意以下几点：

用于创建窗口小部件（如 ttk::frame）的命令对应于 Tkinter 中的 widget 类。

Tcl 窗口控件选项（如 -tex）对应于 Tkinter 中的关键字参数。

在 Tcl 中，小部件是通过 路径名 引用的（例如 .frm.btn），而 Tkinter 不使用名称，而是使用对象引用。

控件在控件层次结构中的位置在其（层次结构）路径名中编码，该路径名使用一个 . （点）作为路径分隔符。根窗口的路径名是 . （点）。在 Tkinter 中，层次结构不是通过路径名定义的，而是通过在创建每个子控件时指定父控件来定义的。

在 Tcl 中以独立的 命令 实现的操作（比如 grid 和 destroy ）在 Tkinter 控件对象上以 方法 表示。稍后您将看到，在其他时候，Tcl 在控件对象调用的方法，在 Tkinter 也有对应的使用。

我该如何...？这个选项会做...？

如果您不确定如何在 Tkinter 中做一些事情，并且您不能立即在您正在使用的教程或参考文档中找到它，这里有一些策略可以帮助您。

首先，请记住，在不同版本的 Tkinter 和 Tcl/Tk 中，各个控件如何工作的细节可能会有所不同。如果您正在搜索文档，请确保它与安装在系统上的 Python 和 Tcl/Tk 版本相对应。

在搜索如何使用 API 时，知道正在使用的类、选项或方法的确切名称会有所帮助。内省，无论是在交互式 Python shell 中，还是在 print() 中，都可以帮助你确定你需要什么。

要找出控件上可用的配置选项，请调用其 configure() 方法，该方法返回一个字典，其中包含每个对象的各种信息，包括其默认值和当前值。使用 keys() 获取每个选项的名称。

btn = ttk.Button(frm, ...)
print(btn.configure().keys())

由于大多数控件都有许多共同的配置选项，因此找出特定于特定控件类的配置选项可能会很有用。将选项列表与更简单的控件（如框架）的列表进行比较是一种方法。

print(set(btn.configure().keys()) - set(frm.configure().keys()))

类似地，你可以使用标准函数 dir() 来查找控件对象的可用方法。如果您尝试一下，您会发现有超过200种常见的控件方法，因此再次确认那些特定于控件类的方法是有帮助的。

print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))

浏览 Tcl/Tk 参考手册

如上所述，官方的 Tk commands [https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm] 参考手册（手册页）通常有对控件特定操作的最准确描述。即使您知道需要的选项或方法的名称，您可能仍然有一些地方可以查找。

虽然 Tkinter 中的所有操作都是通过对控件对象的方法调用来实现的，但您已经看到许多 Tcl/Tk 操作都是以命令的形式出现的，这些命令以小部件的路径名作为它的第一个参数，然后是可选参数，例如：

destroy .
grid .frm.btn -column 0 -row 0

但是，其他方法看起来更像在控件对象上调用的方法（实际上，当您在 Tcl/Tk 中创建小部件时，它会使用控件路径名创建 Tcl 命令，该命令的第一个参数是要调用的方法名）。

.frm.btn invoke
.frm.lbl configure -text "Goodbye"

在 Tcl/Tk 官方参考文档中，你会发现手册页上大多数操作看起来都像是特定控件的的方法调用（例如，你会在 ttk::button [https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_button.htm] 手册页上找到 invoke() 方法），而以控件作为参数的函数通常有自己的手册页（例如，grid [https://www.tcl.tk/man/tcl8.6/TkCmd/grid.htm] ）。

您将在 options [https://www.tcl.tk/man/tcl8.6/TkCmd/options.htm] 或 ttk::widget [https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_widget.htm] 手册页中找到许多常见的选项和方法，而其他的选项和方法可以在特定控件类的手册页中找到。

你还会发现许多 Tkinter 方法有复合名称，例如 winfo_x()，winfo_height()，winfo_viewable()。你可以在 winfo [https://www.tcl.tk/man/tcl8.6/TkCmd/winfo.htm] 页面找到这些文档。

注解

有些令人困惑的是，所有 Tkinter 小部件上还有一些方法实际上并不在控件上操作，而是在全局范围内操作，独立于任何控件。例如访问剪贴板或系统响铃的方法。（它们恰好被实现为所有 Tkinter 小部件都继承自的基类 Widget 中的方法）。

线程模型

Python 和 Tcl/Tk 的线程模型大不相同，而 tkinter 则会试图进行调和。若要用到线程，可能需要注意这一点。

一个 Python 解释器可能会关联很多线程。在 Tcl 中，可以创建多个线程，但每个线程都关联了单独的 Tcl 解释器实例。线程也可以创建一个以上的解释器实例，尽管每个解释器实例只能由创建它的那个线程使用。

tkinter 创建的每个 Tk 对象均包含一个 Tcl 解释器。 它还会记录解释器是由哪个线程创建的。对 tkinter 的调用可从任何 Python 线程发起。 如果唤起的线程不是创建 Tk 对象的线程，则会自动向解释器的事件队列中发送一条事件，在执行该事件时，会向发起调用的 Python 线程返回结果。

Tcl/Tk 应用程序通常是事件驱动的，这意味着在完成初始化以后，解释器会运行一个事件循环（即 Tk.mainloop()）并对事件做出响应。因为它是单线程的，所以事件处理程序必须快速响应，否则会阻塞其他事件的处理。为了避免阻塞，不应在事件处理程序中执行任何耗时很久的计算，而应利用计时器将任务分块，或者在其他线程中运行。而其他很多工具包的 GUI 是在一个完全独立的线程中运行的，独立于包括事件处理程序在内的所有代码。

如果 Tcl 解释器没有运行事件循环并处理解释器事件，则除运行 Tcl 解释器的线程外，任何其他线程发起的 tkinter 调用都会失败。

存在一些特殊情况：

Tcl/Tk 库可编译为不支持多线程的版本。这时 tkinter 会从初始 Python 线程调用底层库，即便那不是创建 Tcl 解释器的线程。会有一个全局锁来确保每次只会发生一次调用。

虽然 tkinter 允许创建一个以上的 Tk 实例（都带有自己的解释器），但所有属于同一线程的解释器均会共享同一个事件队列，这样很快就会一团糟。在实际编程时，一次创建的 Tk 实例不要超过一个。否则最好在不同的线程中创建，并确保运行的是支持多线程的 Tcl/Tk 版本。

为了防止 Tcl 解释器重新进入事件循环，阻塞事件处理程序并不是唯一的做法。甚至可以运行多个嵌套的事件循环，或者完全放弃事件循环。如果在处理事件或线程时碰到棘手的问题，请小心这些可能的事情。

有几个 tkinter 函数，目前只在创建 Tcl 解释器的线程中调用才行。

快速参考

可选配置项

配置参数可以控制组件颜色和边框宽度等。可通过三种方式进行设置：

在对象创建时，使用关键字参数

fred = Button(self, fg="red", bg="blue")

在对象创建后，将参数名用作字典索引

fred["fg"] = "red"
fred["bg"] = "blue"

利用 config() 方法修改对象的多个属性

fred.config(fg="red", bg="blue")

关于这些参数及其表现的完整解释，请参阅 Tk 手册中有关组件的 man 帮助页。

请注意，man 手册页列出了每个部件的“标准选项”和“组件特有选项”。前者是很多组件通用的选项列表，后者是该组件特有的选项。标准选项在 options(3) man 手册中有文档。

本文没有区分标准选项和部件特有选项。有些选项不适用于某类组件。组件是否对某选项做出响应，取决于组件的类别；按钮组件有一个 command 选项，而标签组件就没有。

组件支持的选项在其手册中有列出，也可在运行时调用 config() 方法（不带参数）查看，或者通过调用组件的 keys() 方法进行查询。这些调用的返回值为字典，字典的键是字符串格式的选项名（比如 'relief'），字典的值为五元组。

有些选项，比如 bg 是全名通用选项的同义词（bg 是 “background”的简写）。向 config() 方法传入选项的简称将返回一个二元组，而不是五元组。传回的二元组将包含同义词的全名和“真正的”选项（比如 ('bg', 'background')）。

索引 | 含意 | 示例
0 | 选项名称 | 'relief'
1 | 数据库查找的选项名称 | 'relief'
2 | 数据库查找的选项类 | 'Relief'
3 | 默认值 | 'raised'
4 | 当前值 | 'groove'

示例:

>>> print(fred.config())
{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')}

当然，输出的字典将包含所有可用选项及其值。这里只是举个例子。

包装器

包装器是 Tk 的形状管理机制之一。 形状（geometry ）管理器用于指定多个部件在容器（共同的 主 组件）内的相对位置。与更为麻烦的 定位器 相比（不太常用，这里不做介绍），包装器可接受定性的相对关系—— 上面 、左边 、填充 等，并确定精确的位置坐标。

主 部件的大小都由其内部的 “从属部件” 的大小决定。包装器用于控制从属部件在主部件中出现的位置。可以把部件包入框架，再把框架包入其他框架中，搭建出所需的布局。此外，只要完成了包装，组件的布局就会进行动态调整，以适应布局参数的变化。

请注意，只有用形状管理器指定几何形状后，部件才会显示出来。忘记设置形状参数是新手常犯的错误，惊讶于创建完部件却啥都没出现。部件只有在应用了类似于打包器的 pack() 方法之后才会显示在屏幕上。

调用 pack() 方法时可以给出由关键字/参数值组成的键值对，以便控制组件在其容器中出现的位置，以及主程序窗口大小变动时的行为。下面是一些例子：

fred.pack()                     # defaults to side = "top"
fred.pack(side="left")
fred.pack(expand=1)

包装器的参数

关于包装器及其可接受的参数，更多信息请参阅 man 手册和 John Ousterhout 书中的第 183 页。

anchor

anchor 类型。 表示包装器要放置的每个从属组件的位置。

expand

布尔型，0 或 1 。

fill

合法值为：'x' 、'y' 、'both' 、'none'。

ipadx 和 ipady

距离值，指定从属部件的内边距。

padx 和 pady

距离值，指定从属部件的外边距。

side

合法值为：'left'、 'right' 、 'top'、 'bottom'。

部件与变量的关联

通过一些特定参数，某些组件（如文本输入组件）的当前设置可直接与应用程序的变量关联。这些参数包括 variable 、 textvariable 、 onvalue 、 offvalue 、 value。这种关联是双向的：只要这些变量因任何原因发生变化，其关联的部件就会更新以反映新的参数值。

不幸的是，在目前 tkinter 的实现代码中，不可能通过 variable 或 textvariable 参数将任意 Python 变量移交给组件。变量只有是 tkinter 中定义的 Variable 类的子类，才能生效。

已经定义了很多有用的 Variable 子类： StringVar 、 IntVar 、DoubleVar 和 BooleanVar。调用 get() 方法可以读取这些变量的当前值；调用 set() 方法则可改变变量值。只要遵循这种用法，组件就会保持跟踪变量的值，而不需要更多的干预。

例如：

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master):
        super().__init__(master)
        self.pack()

        self.entrythingy = tk.Entry()
        self.entrythingy.pack()

        # Create the application variable.
        self.contents = tk.StringVar()
        # Set it to some value.
        self.contents.set("this is a variable")
        # Tell the entry widget to watch this variable.
        self.entrythingy["textvariable"] = self.contents

        # Define a callback for when the user hits return.
        # It prints the current value of the variable.
        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()

窗口管理器

Tk 有个实用命令 wm，用于与窗口管理器进行交互。wm 命令的参数可用于控制标题、位置、图标之类的东西。在 tkinter 中，这些命令已被实现为 Wm 类的方法。顶层部件是 Wm 类的子类，所以可以直接调用 Wm 的这些方法。

要获得指定部件所在的顶层窗口，通常只要引用该部件的主窗口即可。当然，如果该部件是包装在框架内的，那么主窗口不代表就是顶层窗口。为了获得任意组件所在的顶层窗口，可以调用 _root() 方法。该方法以下划线开头，表明其为 Python 实现的代码，而非 Tk 提供的某个接口。

以下是一些典型用法：

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# create the application
myapp = App()

#
# here are method calls to the window manager class
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# start the program
myapp.mainloop()

Tk 参数的数据类型

anchor

合法值是罗盘的方位点："n" 、"ne" 、"e" 、"se" 、"s" 、"sw" 、"w" 、"nw" 和 "center" 。

bitmap

内置已命名的位图有八个：'error'、 'gray25' 、'gray50' 、'hourglass'、 'info' 、'questhead' 、'question' 、'warning' 。若要指定位图的文件名，请给出完整路径，前面加一个 @，比如 "@/usr/contrib/bitmap/gumby.bit"。

boolean

可以传入整数 0 或 1，或是字符串 "yes" 或 "no"。

callback -- 回调

指任何无需调用参数的 Python 函数。 例如：

def print_it():
    print("hi there")
fred["command"] = print_it

color

可在 rgb.txt 文件中以颜色名的形式给出，或是 RGB 字符串的形式，4 位 ："#RGB" ，8 位 ："#RRGGBB"，12 位："#RRRGGGBBB"，16 位："#RRRRGGGGBBBB"，其中R、G、B 为合法的十六进制数值。 详见 Ousterhout 书中的第 160 页。

cursor

可采用 cursorfont.h 中的标准光标名称，去掉 XC_ 前缀。 比如要获取一个手形光标（XC_hand2），可以用字符串 "hand2"。也可以指定自己的位图和掩码文件作为光标。参见 Ousterhout 书中的第 179 页。

distance

屏幕距离可以用像素或绝对距离来指定。像素是数字，绝对距离是字符串，后面的字符表示单位：c 是厘米，i 是英寸，m 是毫米，p 则表示打印机的点数。例如，3.5 英寸可表示为 "3.5i"。

font

Tk 采用一串名称的格式表示字体，例如 {courier 10 bold}。正数的字体大小以点为单位，负数的大小以像素为单位。

geometry

这是一个 widthxheight 形式的字符串，其中宽度和高度对于大多数部件来说是以像素为单位的（对于显示文本的部件来说是以字符为单位的）。例如：fred["geometry"] = "200x100"。

justify

合法的值为字符串： "left" 、 "center" 、 "right" 和 "fill" 。

区域

这是包含四个元素的字符串，以空格分隔，每个元素是表示一个合法的距离值（见上文）。例如："2 3 4 5" 、 "3i 2i 4.5i 2i" 和 "3c 2c 4c 10.43c" 都是合法的区域值。

relief

决定了组件的边框样式。 合法值包括："raised"、 "sunken" 、"flat" 、"groove" 和 "ridge" 。

scrollcommand

这几乎就是带滚动条部件的 set() 方法，但也可是任一只有一个参数的部件方法。

wrap

只能是以下值之一："none" 、 "char" 、 "word"。

绑定和事件

部件命令中的 bind 方法可觉察某些事件，并在事件发生时触发一个回调函数。bind 方法的形式是：

def bind(self, sequence, func, add=''):

其中：

sequence

是一个表示事件的目标种类的字符串。（详情请看 bind(3tk) 的手册页和 John Outsterhout 的书，:title-reference:`Tcl and the Tk Toolkit (2nd edition)，第 201 页。）

func

是带有一个参数的 Python 函数，发生事件时将会调用。传入的参数为一个 Event 实例。（以这种方式部署的函数通常称为 回调函数。）

add

可选项， '' 或 '+' 。传入空字符串表示本次绑定将替换与此事件关联的其他所有绑定。传递 '+' 则意味着加入此事件类型已绑定函数的列表中。

例如：

def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)

请注意，在 turn_red() 回调函数中如何访问事件的 widget 字段。该字段包含了捕获 X 事件的控件。下表列出了事件可供访问的其他字段，及其在 Tk 中的表示方式，这在查看 Tk 手册时很有用处。

Tk | Tkinter 事件字段 | Tk | Tkinter 事件字段
%f | focus | %A | char
%h | height | %E | send_event
%k | keycode | %K | keysym
%s | state | %N | keysym_num
%t | time | %T | type
%w | width | %W | widget
%x | x | %X | x_root
%y | y | %Y | y_root

index 参数

很多控件都需要传入 index 参数。该参数用于指明 Text 控件中的位置，或指明 Entry 控件中的字符，或指明 Menu 控件中的菜单项。

Entry 控件的索引（index、view index 等）

Entry 控件带有索引属性，指向显示文本中的字符位置。这些 tkinter 函数可用于访问文本控件中的这些特定位置：

Text 控件的索引

Text 控件的索引语法非常复杂，最好还是在 Tk 手册中查看。

Menu 索引（menu.invoke()、menu.entryconfig() 等）

菜单的某些属性和方法可以操纵特定的菜单项。只要属性或参数需要用到菜单索引，就可用以下方式传入：

一个整数，指的是菜单项的数字位置，从顶部开始计数，从 0 开始；

字符串 "active"，指的是当前光标所在的菜单；

字符串 "last"，指的是上一个菜单项；

带有 @ 前缀的整数，比如 @6，这里的整数解释为菜单坐标系中的 y 像素坐标；

表示没有任何菜单条目的字符串 "none" 经常与 menu.activate() 一同被用来停用所有条目，以及 ——

与菜单项的文本标签进行模式匹配的文本串，从菜单顶部扫描到底部。请注意，此索引类型是在其他所有索引类型之后才会考虑的，这意味着文本标签为 last、active 或 none 的菜单项匹配成功后，可能会视为这些单词文字本身。

图片

通过 tkinter.Image 的各种子类可以创建相应格式的图片：

BitmapImage 对应 XBM 格式的图片。

PhotoImage 对应 PGM、PPM、GIF 和 PNG 格式的图片。后者自 Tk 8.6 开始支持。

这两种图片可通过 file 或 data 属性创建的（也可能由其他属性创建）。

然后可在某些支持 image 属性的控件中（如标签、按钮、菜单）使用图片对象。这时，Tk 不会保留对图片对象的引用。当图片对象的最后一个 Python 引用被删除时，图片数据也会删除，并且 Tk 会在用到图片对象的地方显示一个空白框。

参见

Pillow [https://python-pillow.org/] 包增加了对 BMP, JPEG, TIFF 和 WebP 等多种格式的支持。

文件处理程序

Tk 允许为文件操作注册和注销一个回调函数，当对文件描述符进行 I/O 时，Tk 的主循环会调用该回调函数。每个文件描述符只能注册一个处理程序。示例代码如下：

import tkinter
widget = tkinter.Tk()
mask = tkinter.READABLE | tkinter.WRITABLE
widget.tk.createfilehandler(file, mask, callback)
...
widget.tk.deletefilehandler(file)

在 Windows 系统中不可用。

由于不知道可读取多少字节，你可能不希望使用 BufferedIOBase 或 TextIOBase 的 read() 或 readline() 方法，因为这些方法必须读取预定数量的字节。 对于套接字，可使用 recv() 或 recvfrom() 方法；对于其他文件，可使用原始读取方法或 os.read(file.fileno(), maxbytecount)。

Widget.tk.createfilehandler(file, mask, func)

注册文件处理程序的回调函数 func。 file 参数可以是具备 fileno() 方法的对象（例如文件或套接字对象），也可以是整数文件描述符。 mask 参数是下述三个常量的逻辑“或”组合。回调函数将用以下格式调用：

callback(file, mask)

Widget.tk.deletefilehandler(file)

注销文件处理函数。

tkinter.READABLE

tkinter.WRITABLE

tkinter.EXCEPTION

Constants used in the mask arguments.

tkinter.colorchooser --- 颜色选择对话框

源代码: Lib/tkinter/colorchooser.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/colorchooser.py]

tkinter.colorchooser 模块提供了 Chooser 类作为原生颜色选择对话框的接口。 Chooser 实现了一个模式颜色选择对话框窗口。 Chooser 类继承自 Dialog 类。

class tkinter.colorchooser.Chooser(master=None, **options)

tkinter.colorchooser.askcolor(color=None, **options)

创建一个颜色选择对话框。 调用此方法将显示相应窗口，等待用户进行选择，并将选择的颜色 (或 None) 返回给调用者。

参见

模块 tkinter.commondialog

Tkinter 标准对话框模块

tkinter.font --- Tkinter 字体封装

源代码: Lib/tkinter/font.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/font.py]

tkinter.font 模块提供用于创建和使用命名字体的 Font 类。

不同的字体粗细和倾斜是：

tkinter.font.NORMAL

tkinter.font.BOLD

tkinter.font.ITALIC

tkinter.font.ROMAN

class tkinter.font.Font(root=None, font=None, name=None, exists=False, **options)

Font 类表示命名字体。Font 实例具有唯一的名称，可以通过其族、大小和样式配置进行指定。命名字体是 Tk 将字体创建和标识为单个对象的方法，而不是通过每次出现时的属性来指定字体。

参数：

font - 字体指示符元组 (family, size, options)

name - 唯一的字体名

exists - 指向现有命名字体（如果有）

其他关键字选项（如果指定了 font，则忽略）：

family - 字体系列，例如 Courier，Times

size - 字体大小

如果 size 为正数，则解释为以磅为单位的大小。

如果 size 是负数，则将其绝对值

解释为以像素为单位的大小。

weight - 字体强调 (NORMAL, BOLD)（普通，加粗）

slant - ROMAN, ITALIC（正体，斜体）

underline - 字体下划线（0 - 无下划线，1 - 有下划线）

overstrike - 字体删除线（0 - 无删除线，1 - 有删除线）

actual(option=None, displayof=None)

返回字体的属性。

cget(option)

检索字体的某一个属性值。

config(**options)

修改字体的某一个属性值。

copy()

返回当前字体的新实例。

measure(text, displayof=None)

返回以当前字体格式化时文本将在指定显示上占用的空间量。如果未指定显示，则假定为主应用程序窗口。

metrics(*options, **kw)

返回特定字体的数据。选项包括：

ascent - 基线和最高点之间的距离

（在该字体中的一个字符可以占用的空间中）

descent - 基线和最低点之间的距离

（在该字体中的一个字符可以占用的空间中）

linespace - 所需最小垂直间距（在两个

该字体的字符间，使得这两个字符在垂直方向上不重叠）。

fixed - 如果该字体宽度被固定则为1，否则为0。

tkinter.font.families(root=None, displayof=None)

返回不同的字体系列。

tkinter.font.names(root=None)

返回定义字体的名字。

tkinter.font.nametofont(name, root=None)

返回一个 Font 类，代表一个 tk 命名的字体。

在 3.10 版更改: 增加了 root 形参。

Tkinter 对话框

tkinter.simpledialog --- 标准 Tkinter 输入对话框

源码: Lib/tkinter/simpledialog.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/simpledialog.py]

tkinter.simpledialog 模块包含了一些便捷类和函数，用于创建简单的模态对话框，从用户那里读取一个值。

tkinter.simpledialog.askfloat(title, prompt, **kw)

tkinter.simpledialog.askinteger(title, prompt, **kw)

tkinter.simpledialog.askstring(title, prompt, **kw)

以上三个函数提供给用户输入期望值的类型的对话框.

class tkinter.simpledialog.Dialog(parent, title=None)

自定义对话框的基类.

body(master)

可以覆盖，用于构建对话框的界面，并返回初始焦点所在的部件。

buttonbox()

加入 OK 和 Cancel 按钮的默认行为. 重写自定义按钮布局.

tkinter.filedialog --- 文件选择对话框.

源码: Lib/tkinter/filedialog.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/filedialog.py]

tkinter.filedialog 模块提供了用于创建文件/目录选择窗口的类和工厂函数。

原生的载入/保存对话框.

以下类和函数提供了文件对话窗口，这些窗口带有原生外观，具备可定制行为的配置项。这些关键字参数适用于下列类和函数：

parent —— 对话框下方的窗口

title —— 窗口的标题

initialdir —— 对话框的启动目录

initialfile —— 打开对话框时选中的文件

filetypes —— （标签，匹配模式）元组构成的列表，允许使用 “*” 通配符

defaultextension —— 默认的扩展名，用于加到文件名后面（保存对话框）。

multiple —— 为 True 则允许多选

** 静态工厂函数 **

调用以下函数时，会创建一个模态的、原生外观的对话框，等待用户选取，然后将选中值或 None 返回给调用者。

tkinter.filedialog.askopenfile(mode='r', **options)

tkinter.filedialog.askopenfiles(mode='r', **options)

上述两个函数创建了 Open 对话框，并返回一个只读模式打开的文件对象。

tkinter.filedialog.asksaveasfile(mode='w', **options)

创建 SaveAs 对话框并返回一个写入模式打开的文件对象。

tkinter.filedialog.askopenfilename(**options)

tkinter.filedialog.askopenfilenames(**options)

以上两个函数创建了 Open 对话框，并返回选中的文件名，对应着已存在的文件。

tkinter.filedialog.asksaveasfilename(**options)

创建 SaveAs 对话框，并返回选中的文件名。

tkinter.filedialog.askdirectory(**options)

提示用户选择一个目录.

其他关键字参数：

mustexist —— 确定是否必须为已存在的目录。

class tkinter.filedialog.Open(master=None, **options)

class tkinter.filedialog.SaveAs(master=None, **options)

上述两个类提供了用于保存和加载文件的原生对话窗口。

** 便捷类 **

以下类用于从头开始创建文件/目录窗口。不会模仿当前系统的原生外观。

class tkinter.filedialog.Directory(master=None, **options)

创建对话框，提示用户选择一个目录。

注解

为了实现自定义的事件处理和行为，应继承 FileDialog 类。

class tkinter.filedialog.FileDialog(master, title=None)

创建一个简单的文件选择对话框。

cancel_command(event=None)

触发对话窗口的终止。

dirs_double_event(event)

目录双击事件的处理程序。

dirs_select_event(event)

目录单击事件的处理程序。

files_double_event(event)

文件双击事件的处理程序。

files_select_event(event)

文件单击事件的处理程序。

filter_command(event=None)

按目录筛选文件。

get_filter()

获取当前使用的文件筛选器。

get_selection()

获取当前选中项。

go(dir_or_file=os.curdir, pattern='*', default='', key=None)

显示对话框并启动事件循环。

ok_event(event)

退出对话框并返回当前选中项。

quit(how=None)

退出对话框并返回文件名。

set_filter(dir, pat)

设置文件筛选器。

set_selection(file)

将当前选中文件更新为 file。

class tkinter.filedialog.LoadFileDialog(master, title=None)

FileDialog 的一个子类，创建用于选取已有文件的对话窗口。

ok_command()

检测有否给出文件，以及选中的文件是否存在。

class tkinter.filedialog.SaveFileDialog(master, title=None)

FileDialog 的一个子类，创建用于选择目标文件的对话窗口。

ok_command()

检测选中文件是否为目录。如果选中了已存在文件，则需要用户进行确认。

tkinter.commondialog --- 对话窗口模板

源码:：Lib/tkinter/commondialog.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/commondialog.py]

tkinter.commondialog 模块提供了 Dialog 类，是其他模块定义的对话框的基类。

class tkinter.commondialog.Dialog(master=None, **options)

show(color=None, **options)

显示对话窗口。

参见

模块 tkinter.messagebox, 读写文件

tkinter.messagebox --- Tkinter 消息提示

源代码: Lib/tkinter/messagebox.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/messagebox.py]

tkinter.messagebox 模块提供了一个模板基类以及多个常用配置的便捷方法。 消息框为模式窗口并将基于用户的选择返回 (True, False, OK, None, Yes, No) 的一个子集。 常用消息框风格和布局包括但不限于:

class tkinter.messagebox.Message(master=None, **options)

创建一个默认信息消息框。

信息消息框

tkinter.messagebox.showinfo(title=None, message=None, **options)

警告消息框

tkinter.messagebox.showwarning(title=None, message=None, **options)

tkinter.messagebox.showerror(title=None, message=None, **options)

疑问消息框

tkinter.messagebox.askquestion(title=None, message=None, **options)

tkinter.messagebox.askokcancel(title=None, message=None, **options)

tkinter.messagebox.askretrycancel(title=None, message=None, **options)

tkinter.messagebox.askyesno(title=None, message=None, **options)

tkinter.messagebox.askyesnocancel(title=None, message=None, **options)

tkinter.scrolledtext --- 滚动文字控件

源代码： Lib/tkinter/scrolledtext.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/scrolledtext.py]

tkinter.scrolledtext 模块提供了一个同名的类，实现了带有垂直滚动条并被配置为可以“正常运作”的文本控件 。 使用 ScrolledText 类会比直接配置一个文本控件附加滚动条要简单得多。

文本控件与滚动条打包在一个 Frame 中， Grid 方法和 Pack 方法的布局管理器从 Frame 对象中获得。这允许 ScrolledText 控件可以直接用于实现大多数正常的布局管理行为。

如果需要更具体的控制，可以使用以下属性：

class tkinter.scrolledtext.ScrolledText(master=None, **kw)

frame

围绕文本和滚动条控件的框架。

vbar

滚动条控件。

tkinter.dnd --- 拖放操作支持

源代码: Lib/tkinter/dnd.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/dnd.py]

注解

此模块是实验性的且在为 Tk DND 所替代后将被弃用。

tkinter.dnd 模块为单个应用内部的对象提供了在同一窗口中或多个窗口间的拖放操作支持。 要将对象设为可拖放，你必须为其创建启动拖放进程的事件绑定。 通常，你要将 ButtonPress 事件绑定到你所编写的回调函数 (参见 绑定和事件)。 该函数应当调用 dnd_start()，其中 'source' 为要拖动的对象，而 'event' 为被唤起的事件（你的回调函数的参数）。

目标对象的选择方式如下:

从顶至底地在鼠标之下的区域中搜索目标控件

目标控件应当具有一个指向可调用对象的 dnd_accept 属性

如果 dnd_accept 不存在或是返回 None，则将转至父控件中搜索

如果目标控件未找到，则目标对象为 None

调用 <old_target>.dnd_leave(source, event)

调用 <new_target>.dnd_enter(source, event)

调用 <target>.dnd_commit(source, event) 来通知释放

调用 <source>.dnd_end(target, event) 来表明拖放的结束

class tkinter.dnd.DndHandler(source, event)

DndHandler 类处理拖放事件，在事件控件的根对象上跟踪 Motion 和 ButtonRelease 事件。

cancel(event=None)

取消拖放进程。

finish(event, commit=0)

执行结束播放函数。

on_motion(event)

在执行拖动期间为目标对象检查鼠标之下的区域。

on_release(event)

当释放模式被触发时表明拖动的结束。

tkinter.dnd.dnd_start(source, event)

用于拖放进程的工厂函数。

参见

绑定和事件

tkinter.ttk --- Tk 风格的控件

源代码: Lib/tkinter/ttk.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/ttk.py]

tkinter.ttk 模块自 Tk 8.5 开始引入，可用于访问 Tk 风格的控件包。如果 Python 未基于 Tk 8.5 编译，只要安装了 Tile 仍可访问本模块。前一种采用 Tk 8.5 的方式带有更多好处，比如在 X11 系统下支持反锯齿字体渲染和透明窗口（需要 X11 中的窗口组管理器）。

tkinter.ttk 的基本设计思路，就是尽可能地把控件的行为代码与实现其外观的代码分离开来。

参见

Tk 控件风格 [https://core.tcl.tk/tips/doc/trunk/tip/48.md]

介绍 Tk 风格的文档

ttk 的用法

使用 ttk 之前，首先要导入模块：

from tkinter import ttk

为了覆盖基础的 Tk 控件，应该在 Tk 之后进行导入：

from tkinter import *
from tkinter.ttk import *

这段代码会让以下几个 tkinter. ttk 控件（Button, Checkbutton, Entry, Frame, Label, LabelFrame, Menubutton, PanedWindow, Radiobutton, Scale 和 Scrollbar）自动替换掉 Tk 的对应控件。

使用新控件的直接好处，是拥有更好的跨平台的外观，但新旧控件并不完全兼容。主要区别在于，Ttk 组件不再包含“fg”、“bg”等与样式相关的属性 。而是用 ttk.Style 类来定义更美观的样式效果。

参见

将现有应用程序转换为使用 Tile 部件 [https://tktable.sourceforge.net/tile/doc/converting.txt]

此文介绍迁移为新控件时的常见差别（使用 Tcl ）。

ttk 控件

ttk 中有 18 种部件 ，其中 12 种在 tkinter 中已包含了： Button 、 Checkbutton 、Entry 、 Frame 、 Label, LabelFrame 、 Menubutton 、PanedWindow 、Radiobutton 、 Scale 、 Scrollbar 和 Spinbox。另有 6 种是新增的： Combobox 、 Notebook 、 Progressbar 、 Separator 、 Sizegrip 和 Treeview。这些控件全都是 Widget 的子类。

ttk 控件可以改善应用程序的外观。如上所述，修改样式的代码与 tk 控件存在差异。

Tk 代码:

l1 = tkinter.Label(text="Test", fg="black", bg="white")
l2 = tkinter.Label(text="Test", fg="black", bg="white")

Ttk 代码：

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")

有关 TtkStyling 的更多信息，请参阅 Style 类文档。

控件

ttk.Widget 定义了 Tk 风格控件支持的标准属性和方法，不应直接对其进行实例化。

标准属性

所有 ttk 控件均可设置以下属性：

属性 | 描述
class | 指定窗口类。若要从参数库中查找窗口的其他属性，或确认窗口的默认绑定标签，或选择控件的默认布局和样式，会用到 class 属性。该属性只读，且只能在创建窗口时指定。
cursor | 指定控件使用的鼠标光标。若设为空字符串（默认值），则会继承父控件的光标。
takefocus | 决定了窗口是否可用键盘获得焦点。返回 0 、1 或空字符串。若返回 0，则表示在用键盘遍历时应该跳过该窗口。如果为 1，则表示只要窗口可见即应接收输入焦点。而空字符串则表示由遍历代码决定窗口是否接收焦点。
style | 可用于指定自定义控件样式。

可滚动控件的属性

带滚动条的控件支持以下属性：

属性 | 描述
xscrollcommand | 用于与水平滚动条通讯. 当窗口中的可见内容发生变化时，控件将根据 scrollcommand 生成 Tcl 命令。 通常该属性由一些滚动条的 Scrollbar.set() 方法组成。当窗口中的可见内容发生变化时，将会刷新滚动条的状态。
yscrollcommand | 用于与垂直滚动条通讯，更多信息请参考上一条。

标签控件的属性

标签、按钮和类似按钮的控件支持以下属性。

属性 | 描述
text | 指定显示在控件内的文本。
textvariable | 指定一个变量名，其值将用于设置 text 属性。
underline | 设置文本字符串中带下划线字符的索引（基于0）。下划线字符用于激活快捷键。
image | 指定一个用于显示的图片。这是一个由1个或多个元素组成的列表。第一个元素是默认的图片名称。列表的其余部分是由 Style.map() 定义的“状态/值对”的序列，指定控件在某状态或状态组合时要采用的图片。列表中的所有图片应具备相同的尺寸。

compound

指定同时存在 text 和 image 属性时，应如何显示文本和对应的图片。合法的值包括：

text:：只显示文本

image：只显示图片

top、bottom、left、right：分别在文本的上、下、左、右显示图片。

none：默认值。 如果给出了图片则显示，否则显示文本。

width | 如果值大于零，指定文本标签留下多少空间，单位是字符数；如果值小于零，则指定最小宽度。如果等于零或未指定，则使用文本标签本身的宽度。

兼容性属性

属性 | 描述
state | 可以设为“normal”或“disabled”，以便控制“禁用”状态标志位。本属性只允许写入：用以改变控件的状态，但 Widget.state() 方法不影响本属性。

控件状态

控件状态是多个相互独立的状态标志位的组合。

标志位 | 描述
active | 鼠标光标经过控件并按下鼠标按钮，将引发动作。
disabled | 控件处于禁用状态，而由程序控制。
focus | 控件接受键盘焦点。
pressed | 控件已被按下。
selected | 勾选或单选框之类的控件，表示启用、选中状态。
background | Windows 和 Mac 系统的窗口具有“激活”或后台的概念。后台窗口的控件会设置 foreground 参数，而前台窗口的控件则会清除此状态。
readonly | 控件不允许用户修改。
alternate | 控件的备选显式格式。
invalid | 控件的值是无效的

所谓的控件状态，就是一串状态名称的组合，可在某个名称前加上感叹号，表示该状态位是关闭的。

ttk.Widget

除了以下方法之外，ttk.Widget 还支持 tkinter.Widget.cget() 和 tkinter.Widget.configure() 方法。

class tkinter.ttk.Widget

identify(x, y)

返回位于 x y 的控件名称，如果该坐标点不属于任何控件，则返回空字符串。

x 和 y 是控件内的相对坐标，单位是像素。

instate(statespec, callback=None, *args, **kw)

检测控件的状态。如果没有设置回调函数，那么当控件状态符合 statespec 时返回 True，否则返回 False。如果指定了回调函数，那么当控件状态匹配 statespec 时将会调用回调函数，且会带上后面的参数。

state(statespec=None)

修改或查询部件状态。 如果指定了 statespec，则会用它来设置部件状态并返回一个新的 statespec 来指明哪些旗标做过改动。 如果未指定 statespec，则返回当前启用的状态旗标。

statespec 通常是个列表或元组。

Combobox

ttk.Combobox 控件是文本框和下拉列表的组合体。该控件是 Entry 的子类。

除了从 Widget 继承的 Widget.cget() 、 Widget.configure() 、Widget.identify() 、Widget.instate() 和 Widget.state() 方法，以及从 Entry 继承的 Entry.bbox() 、 Entry.delete() 、 Entry.icursor() 、Entry.index() 、 Entry.insert() 、 Entry.selection() 、 Entry.xview() 方法，控件还自带了其他几个方法，在 ttk.Combobox 中都有介绍。

属性

控件可设置以下属性：

属性 | 描述
exportselection | 布尔值，如果设为 True，则控件的选中文字将关联为窗口管理器的选中文字（可由 Misc.selection_get 返回）。
justify | 指定文本在控件中的对齐方式。可为 left、center、right 之一。
height | 设置下拉列表框的高度。
postcommand | 在显示之前将被调用的代码（可用 Misc.register 进行注册）。可用于选择要显示的值。
state | normal 、readonly 或 disabled。在 readonly 状态下，数据不能直接编辑，用户只能从下拉列表中选取。在 normal 状态下，可直接编辑文本框。在 disabled 状态下，无法做任何交互。
textvariable | 设置一个变量名，其值与控件的值关联。每当该变量对应的值发生变动时，控件值就会更新，反之亦然。参见 tkinter.StringVar 。
values | 设置显示于下拉列表中的值。
width | 设置为整数值，表示输入窗口的应有宽度，单位是字符单位（控件字体的平均字符宽度）。

虚拟事件

当用户从下拉列表中选择某个元素时，控件会生成一条 <<ComboboxSelected>> 虚拟事件。

ttk.Combobox

class tkinter.ttk.Combobox

current(newindex=None)

如果给出了 newindex，则把控件值设为 newindex 位置的元素值。否则，返回当前值的索引，当前值未在列表中则返回 -1。

get()

返回控件的当前值。

set(value)

设置控件的值为 value 。

Spinbox

ttk.Spinbox 控件是 ttk.Entry 的扩展，带有递增和递减箭头。可用于数字或字符串列表。这是 Entry 的子类。

除了从 Widget 继承的 Widget.cget() 、 Widget.configure() 、Widget.identified() 、 Widget.instate() 和 Widget.state() 方法，以及从 Entry 继承的 Entry. bbox() 、 Entry.delete() 、 Entry.icursor() 、Entry.index() 、 Entry.insert() 、 Entry.xview() 方法，控件还自带了其他一些方法，在 ttk.Spinbox 中都有介绍。

属性

控件可设置以下属性：

属性 | 描述
from | 浮点值。如若给出，则为递减按钮能够到达的最小值。作为参数使用时必须写成 from_，因为 from 是 Python 关键字。
to | 浮点值。如若给出，则为递增按钮能够到达的最大值。
increment | 浮点值。指定递增/递减按钮每次的修改量。默认值为 1.0。
values | 字符串或浮点值构成的序列。如若给出，则递增/递减会在此序列元素间循环，而不是增减数值。
wrap | 布尔值。若为 True ，则递增和递减按钮会由 to 值循环至 from 值，或由 from 值循环至 to 值。
format | 字符串。指定递增/递减按钮的数字格式。必须以“%W.Pf”的格式给出，W 是填充的宽度，P 是小数精度，% 和 f 就是本身的含义。
command | Python 回调函数。只要递增或递减按钮按下之后，就会进行不带参数的调用。

虚拟事件

用户若按下 <Up> ，则控件会生成 <<Increment>> 虚拟事件，若按下 <Down> 则会生成 <<Decrement>> 事件。

ttk.Spinbox

class tkinter.ttk.Spinbox

get()

返回控件的当前值。

set(value)

设置控件值为 value。

Notebook

Ttk Notebook 部件可管理由窗口组成的多项集并每次显示其中的某一个。 每个子窗口都与一个选项卡相关联，用户可以选择该选项卡来改变当前所显示的窗口。

属性

控件可设置以下属性：

属性 | 描述
height | 如若给出且大于 0，则指定面板的应有高度（不含内部 padding 或 tab）。否则会采用所有子窗口面板的最大高度。
padding | 指定在控件外部添加的留白。padding 是最多包含四个值的列表，指定左顶右底的空间。如果给出的元素少于四个，底部值默认为顶部值，右侧值默认为左侧值，顶部值默认为左侧值。
width | 若给出且大于 0，则设置面板的应有宽度（不含内部 padding）。否则将采用所有子窗口面板的最大宽度。

Tab 属性

Tab 特有属性如下：

属性 | 描述
state | 可为 normal、disabled 或 disabled 之一。若为 disabled 则不能选中。若为 hidden 则不会显示。
sticky | 指定子窗口在面板内的定位方式。应为包含零个或多个 n、s、e 、w 字符的字符串。每个字母表示子窗口应紧靠的方向（北、南、东或西），正如 grid() 位置管理器所述。
padding | 指定控件和面板之间的留白空间。格式与本控件的 padding 属性相同。
text | 指定显示在 tab 上的文本。
image | 指定显示在 tab 上的图片。参见 Widget 的 image 属性。
compound | 当文本和图片同时存在时，指定图片相对于文本的显示位置。合法的属性值参见 Label Options 。
underline | 指定下划线在文本字符串中的索引（基于0）。如果调用过了 Notebook.enable_traversal()，带下划线的字符将用于激活快捷键。

Tab ID

The tab_id present in several methods of ttk.Notebook may take any of the following forms:

介于 0 和 tab 总数之间的整数值。

子窗口的名称。

以“@x,y”形式给出的位置，唯一标识了 tab 页。

字符串字面值 "current"，它标识当前被选中的选项卡

字符串字面值 "end"，它返回标签页的数量 (仅适用于 Notebook.index())

虚拟事件

当选中一个新 tab 页之后，控件会生成一条 <<NotebookTabChanged>> 虚拟事件。

ttk.Notebook

class tkinter.ttk.Notebook

add(child, **kw)

添加一个新 tab 页。

如果窗口是由 Notebook 管理但处于隐藏状态，则会恢复到之前的位置。

可用属性请参见 Tab Options 。

forget(tab_id)

删除 tab_id 指定的 tab 页，对其关联的窗口不再作映射和管理。

hide(tab_id)

隐藏 tab_id 指定的 tab 页。

tab 页不会显示出来，但关联的窗口仍接受 Notebook 的管理，其配置属性会继续保留。隐藏的 tab 页可由 add() 恢复。

identify(x, y)

返回 tab 页内位置为 x、y 的控件名称，若不存在则返回空字符串。

index(tab_id)

返回 tab_id 指定 tab 页的索引值，如果 tab_id 为 end 则返回 tab 页的总数。

insert(pos, child, **kw)

在指定位置插入一个 tab。

pos 可为字符串“end” 、整数索引值或子窗口名称。如果 child 已由 Notebook 管理，则将其移至指定位置。

可用属性请参见 Tab Options 。

select(tab_id=None)

选中 tab_id 指定 tab。

关联的子窗口将被显示，而之前所选择的窗口（如果不同）将被取消映射关系。 如果省略 tab_id，则返回当前被选中的面板的部件名称。

tab(tab_id, option=None, **kw)

查询或修改 tab_id 指定 tab 的属性。

如果未给出 kw ，则返回由 tab 属性组成的字典。如果指定了 option，则返回其值。否则，设置属性值。

tabs()

返回 Notebook 管理的窗口列表。

enable_traversal()

为包含 Notebook 的顶层窗口启用键盘遍历。

这将为包含 Notebook 的顶层窗口增加如下键盘绑定关系：

Control-Tab ：选中当前 tab 之后的页。

Shift-Control-Tab ：选中当前 tab 之前的页。

Alt-K ：这里 K 是任意 tab 页的快捷键（带下划线）字符，将会直接选中该 tab。

一个顶层窗口中可为多个 Notebook 启用键盘遍历，包括嵌套的 Notebook 。但仅当所有面板都将所在 Notebook 作为父控件时，键盘遍历才会生效。

Progressbar

ttk.Progressbar 控件可为长时间操作显示状态。可工作于两种模式：1）determinate 模式，显示相对完成进度；2） indeterminate 模式，显示动画让用户知道工作正在进行中。

属性

控件可设置以下属性：

属性 | 描述
orient | horizontal 或 vertical。指定进度条的显示方向。
length | 指定进度条长轴的长度（横向为宽度，纵向则为高度）。
mode | determinate 或 indeterminate。
maximum | 设定最大值。默认为 100。
value | 进度条的当前值。在 determinate 模式下代表已完成的工作量。在 indeterminate 模式下，解释为 maximum 的模；也就是说，当本值增至 maximum 时，进度条完成了一个“周期”。
variable | 与属性值关联的变量名。若给出，则当变量值变化时会自动设为进度条的值。
phase | 只读属性。只要值大于 0 且在 determinate 模式下小于最大值，控件就会定期增大该属性值。当前主题可利用本属性提供额外的动画效果。

ttk.Progressbar

class tkinter.ttk.Progressbar

start(interval=None)

开启自增模式：安排一个循环的定时器事件，每隔 interval 毫秒调用一次 Progressbar.step()。interval 可省略，默认为 50毫秒。

step(amount=None)

将进度条的值增加 amount。

amount 可省略，默认为 1.0。

stop()

停止自增模式：取消所有由 Progressbar.start() 启动的循环定时器事件。

Separator

ttk.Separator 控件用于显示横向或纵向的分隔条。

除由 ttk.Widget 继承而来的方法外，没有定义其他方法。

属性

属性如下：

属性 | 描述
orient | horizontal 或 vertical。指定分隔条的方向。

Sizegrip

ttk.Sizegrip 控件允许用户通过按下并拖动控制柄来调整内部顶层窗口的大小。

除由 ttk.Widget 继承的之外，没有其他属性和方法。

与平台相关的注意事项

在 macOS 上，顶层窗口默认自动包括了一个内置的大小控制柄。 再加一个 Sizegrip 也没什么坏处，因为内置的控制柄会盖住该控件。

Bug

假如内部的顶层窗口位置是相对于屏幕的右侧或底部进行设置的，那么 Sizegrip 控件将不会改变窗口的大小。

Sizegrip 仅支持往“东南”方向的缩放。

Treeview

ttk.Treeview 控件可将多项内容分层级显示。每个数据项都带有一个文本标签、一个可选的图片和一个可选的数据值列表。 这些数据值将在树标签后面分列显示。

数据值的显示顺序可用属性 displaycolumns 进行控制。树控件还可以显示列标题。数据列可通过数字或名称进行访问，各列的名称在属性 columns 中列出。参阅 Column Identifiers。

每个数据项都由唯一名称进行标识。如果调用者未提供数据项的 ID，树控件会自动生成。根有且只有一个，名为 {}。根本身不会显示出来；其子项将显示在顶层。

每个数据项均带有一个 tag 列表，可用于绑定事件及控制外观。

Treeview 组件支持水平和垂直滚动，滚动时会依据 Scrollable Widget Options 描述的属性和 Treeview.xview() 和 Treeview.yview() 方法。

属性

控件可设置以下属性：

属性 | 描述
columns | 列标识的列表，定义了列的数量和名称。
displaycolumns | 列标识的列表（索引可为符号或整数），指定要显示的数据列及显示顺序，或为字符串 “#all”。
height | 指定可见的行数。注意：所需宽度由各列宽度之和决定。
padding | 指定控件内部的留白。为不超过四个元素的长度列表。
selectmode | 控制内部类如何进行选中项的管理。可为 extended、browse 或 none。若设为 extended（默认），则可选中多个项。若为 browse ，则每次只能选中一项。若为 none，则无法修改选中项。 请注意，代码和 tag 绑定可自由进行选中操作，不受本属性的限制。

show

由0个或下列值组成的列表，指定要显示树的哪些元素。

tree ：在 #0 列显示树的文本标签。

headings ：显示标题行。

默认为“tree headings”，显示所有元素。

** 注意** ：第 #0 列一定是指 tree 列，即便未设置 show="tree" 也一样。

数据项的属性

可在插入和数据项操作时设置以下属性。

属性 | 描述
text | 用于显示的文本标签。
image | Tk 图片对象，显示在文本标签左侧。
values | 关联的数据值列表。 每个数据项关联的数据数量应与 columns 属性相同。如果比 columns 属性的少，剩下的值将视为空。如果多于 columns 属性的，多余数据将被忽略。
open | True 或 False，表明是否显示数据项的子树。
tags | 与该数据项关联的 tag 列表。

tag 属性

tag 可定义以下属性：

属性 | 描述
foreground | 定义文本前景色。
background | 定义单元格或数据项的背景色。
font | 定义文本的字体。
image | 定义数据项的图片，当 image 属性为空时使用。

列标识

列标识可用以下格式给出：

由 columns 属性给出的符号名。

整数值 n，指定第 n 列。

#n 的字符串格式，n 是整数，指定第 n 个显示列。

注释：

数据项属性的显示顺序可能与存储顺序不一样。

#0 列一定是指 tree 列，即便未指定 show="tree" 也是一样。

数据列号是指属性值列表中的索引值，显示列号是指显示在树控件中的列号。树的文本标签将显示在 #0 列。如果未设置 displaycolumns 属性，则数据列 n 将显示在第 #n+1 列。再次强调一下，#0 列一定是指 tree 列 。

虚拟事件

Treeview 控件会生成以下虚拟事件。

事件 | 描述
<<TreeviewSelect>> | 当选中项发生变化时生成。
<<TreeviewOpen>> | 当焦点所在项的 open= True 之前立即生成。
<<TreeviewClose>> | 当焦点所在项的 open= True 之后立即生成。

Treeview.focus() 和 Treeview.selection() 方法可用于确认涉及的数据项。

ttk.Treeview

class tkinter.ttk.Treeview

bbox(item, column=None)

返回某 数据项 的边界（相对于控件窗口的坐标），形式为 (x, y, width, height) 。

若给出了 column，则返回该单元格的边界。若该 数据项 不可见（即从属于已关闭项或滚动至屏幕外），则返回空字符串。

get_children(item=None)

返回 item 的下属数据项列表。

若未给出 item ，则返回根的下属数据。

set_children(item, *newchildren)

用 newchildren 替换 item 的下属数据。

对于 item 中存在而 newchildren 中不存在的数据项，会从树中移除。newchildren 中的数据不能是 item 的上级。注意，未给出 newchildren 会导致 item 的子项被解除关联。

column(column, option=None, **kw)

查询或修改列 column 的属性。

如果未给出 kw，则返回属性值的字典。若指定了 option，则会返回该属性值。否则将设置属性值。

合法的 属性/值 可为：

id

返回列名。这是只读属性。

anchor：标准的 Tk 锚点值。

指定该列的文本在单元格内的对齐方式。

minwidth：宽度。

列的最小宽度，单位是像素。在缩放控件或用户拖动某一列时，Treeview 会保证列宽不小于此值。

stretch： True/False

指明缩放控件时是否调整列宽。

width：宽度

列宽，单位为像素数。

若要设置 tree 列，请带上参数 column = "#0" 进行调用。

delete(*items)

删除所有 items 及其下属。

根不能删除。

detach(*items)

将所有 items 与树解除关联。

数据项及其下属依然存在，后续可以重新插入，目前只是不显示出来。

根不能解除关联。

exists(item)

如果给出的 item 位于树中，则返回 True。

focus(item=None)

如果给出 item 则设为当前焦点。否则返回当前焦点所在数据项，若无则返回 ''。

heading(column, option=None, **kw)

查询或修改某 column 的标题。

若未给出 kw，则返回列标题组成的列表。若给出了 option 则返回对应属性值。否则，设置属性值。

合法的 属性/值 可为：

text：文本。

显示为列标题的文本。

image：图片名称

指定显示在列标题右侧的图片。

anchor：锚点

指定列标题文本的对齐方式。应为标准的 Tk 锚点值。

command：回调函数

点击列标题时执行的回调函数。

若要对 tree 列进行设置，请带上 column = "#0" 进行调用。

identify(component, x, y)

返回 x、y 位置上 component 数据项的描述信息，如果此处没有该数据项，则返回空字符串。

identify_row(y)

返回 y 位置上的数据项 ID。

identify_column(x)

返回 x 位置上的单元格所在的数据列 ID。

tree 列的 ID 为 #0 。

identify_region(x, y)

返回以下值之一：

区域 | 含义
heading | 树的标题栏区域。
separator | 两个列标题之间的间隔区域。
tree | 树区域。
cell | 数据单元格。

可用性：Tk 8.6。

identify_element(x, y)

返回位于 x 、y 的数据项。

可用性：Tk 8.6。

index(item)

返回 item 在父项的子项列表中的整数索引。

insert(parent, index, iid=None, **kw)

新建一个数据项并返回其 ID。

parent 是父项的 ID，若要新建顶级项则为空字符串。 index 是整数或“end”，指明在父项的子项列表中的插入位置。如果 index 小于等于0，则在开头插入新节点；如果 index 大于或等于当前子节点数，则将其插入末尾。如果给出了 iid，则将其用作数据项 ID； iid 不得存在于树中。否则会新生成一个唯一 ID。

此处可设置的属性请参阅 Item Options 。

item(item, option=None, **kw)

查询或修改某 item 的属性。

如果未给出 option，则返回属性/值构成的字典。如果给出了 option，则返回该属性的值。否则，将属性设为 kw 给出的值。

move(item, parent, index)

将 item 移至指定位置，父项为 parent ，子项列表索引为 index 。

将数据项移入其子项之下是非法的。如果 index 小于等于0，item 将被移到开头；如果大于等于子项的总数，则被移至最后。如果 item 已解除关联，则会被重新关联。

next(item)

返回 item 的下一个相邻项，如果 item 是父项的最后一个子项，则返回 ''。

parent(item)

返回 item 的父项 ID，如果 item 为顶级节点，则返回 ''。

prev(item)

返回 item 的前一个相邻项，若 item 为父项的第一个子项，则返回 ''。

reattach(item, parent, index)

Treeview.move() 的别名。

see(item)

确保 item 可见。

将 item 所有上级的 open 属性设为 True，必要时会滚动控件，让 item 处于树的可见部分。

selection()

返回由选中项构成的元组。

在 3.8 版更改: selection() 不再接受参数了。若要改变选中的状态，请使用下面介绍的方法。

selection_set(*items)

让 items 成为新的选中项。

在 3.6 版更改: items 可作为多个单独的参数传递，而不只是作为一个元组。

selection_add(*items)

将 items 加入选中项。

在 3.6 版更改: items 可作为多个单独的参数传递，而不只是作为一个元组。

selection_remove(*items)

从选中项中移除 items 。

在 3.6 版更改: items 可作为多个单独的参数传递，而不只是作为一个元组。

selection_toggle(*items)

切换 items 中各项的选中状态。

在 3.6 版更改: items 可作为多个单独的参数传递，而不只是作为一个元组。

set(item, column=None, value=None)

若带一个参数，则返回 item 的列/值字典。若带两个参数，则返回 column 的当前值。若带三个参数，则将 item 的 column 设为 value。

tag_bind(tagname, sequence=None, callback=None)

为 tag 为 tagname 的数据项绑定事件 sequence 的回调函数。当事件分发给该数据项时，tag 参数为 tagname 的全部数据项的回调都会被调用到。

tag_configure(tagname, option=None, **kw)

查询或修改 tagname 指定项的属性。

如果给出了 kw，则返回 tagname 项的属性字典。如果给出了 option，则返回 tagname 项的 option 属性值。否则，设置 tagname 项的属性值。

tag_has(tagname, item=None)

如果给出了 item ，则依据 item 是否具备 tagname 而返回 1 或 0。否则，返回 tag 为 tagname 的所有数据项构成的列表。

可用性：Tk 8.6。

xview(*args)

查询或修改 Treeview 的横向位置。

yview(*args)

查询或修改 Treeview 的纵向位置。

Ttk 样式

ttk 的每种控件都赋有一个样式，指定了控件内的元素及其排列方式，以及元素属性的动态和默认设置。默认情况下，样式名与控件的类名相同，但可能会被控件的 style 属性覆盖。如果不知道控件的类名，可用 Misc.winfo_class() 方法获取（somewidget.winfo_class()）。

参见

Tcl'2004 会议报告 [https://tktable.sourceforge.net/tile/tile-tcl2004.pdf]

文章解释了主题引擎的工作原理。

class tkinter.ttk.Style

用于操控样式数据库的类。

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.

例如，要将默认按钮改为扁平样式，并带有留白和各种背景色：

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()

map(style, query_opt=None, **kw)

查询或设置 style 的指定属性的动态值。

kw 的每个键都是一个属性，每个值通常应为列表或元组，其中包含以元组、列表或其他形式组合而成的状态标识（statespec）。状态标识是由一个或多个状态组合，加上一个值组成。

举个例子能更清晰些：

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()

请注意，要点是属性的（状态，值）序列的顺序，如果前景色属性的顺序改为 [('active', 'blue'), ('pressed', 'red')] ，则控件处于激活或按下状态时的前景色将为蓝色。

lookup(style, option, state=None, default=None)

返回 style 中的 option 属性值。

如果给出了 state ，则应是一个或多个状态组成的序列。如果设置了 default 参数，则在属性值缺失时会用作后备值。

若要检测按钮的默认字体，可以：

from tkinter import ttk

print(ttk.Style().lookup("TButton", "font"))

layout(style, layoutspec=None)

按照 style 定义控件布局。如果省略了 layoutspec，则返回该样式的布局属性。

若给出了 layoutspec，则应为一个列表或其他的序列类型（不包括字符串），其中的数据项应为元组类型，第一项是布局名称，第二项的格式应符合 Layouts 的描述。

以下示例有助于理解这种格式（这里并没有实际意义）：

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()

element_create(elementname, etype, *args, **kw)

在当前主题中创建一个新元素 etype ，应为 image、from 或 vsapi。后者仅在 Windows XP 和 Vista 版的 Tk 8.6a 中可用，此处不再赘述。

如果用了 image，则 args 应包含默认的图片名，后面跟着 状态标识/值（这里是 imagespec），kw 可带有以下属性：

border=padding

padding 是由不超过四个整数构成的列表，分别定义了左、顶、右、底的边界。

height=height

定义了元素的最小高度。如果小于零，则默认采用图片本身的高度。

padding=padding

定义了元素的内部留白。若未指定则默认采用 border 值。

sticky=spec

定义了图片的对齐方式。spec 包含零个或多个 n、s、w、e 字符。

width=width

定义了元素的最小宽度。如果小于零，则默认采用图片本身的宽度。

如果 etype 的值用了 from，则 element_create() 将复制一个现有的元素。 args 应包含主题名和可选的要复制的元素。若未给出要克隆的元素，则采用空元素。 kw 参数将被丢弃。

element_names()

返回当前主题已定义的元素列表 。

element_options(elementname)

返回 elementname 元素的属性列表。

theme_create(themename, parent=None, settings=None)

新建一个主题。

如果 themename 已经存在，则会报错。如果给出了 parent，则新主题将从父主题继承样式、元素和布局。若给出了 settings ，则语法应与 theme_settings() 的相同。

theme_settings(themename, settings)

将当前主题临时设为 themename，并应用 settings，然后恢复之前的主题。

settings 中的每个键都是一种样式而每个值可能包含 'configure', 'map', 'layout' 和 'element create' 等键并且它们被预期具有与分别由 Style.configure(), Style.map(), Style.layout() 和 Style.element_create() 方法所指定的相符的格式。

以下例子会对 Combobox 的默认主题稍作修改：

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()

theme_names()

返回所有已知主题的列表。

theme_use(themename=None)

若未给出 themename，则返回正在使用的主题。否则，将当前主题设为 themename，刷新所有控件并引发 <<ThemeChanged>> 事件。

布局

布局在没有属性时可以为 None ，或是定义了元素排列方式的属性字典。布局机制采用了位置管理器的简化版本：给定一个初始容器（cavity），为每个元素都分配一个包装盒（parcel）。合法的选项/值包括：

side: whichside

指定元素置于容器的哪一侧； 顶、右、底或左。如果省略，则该元素将占据整个容器。

sticky: nswe

指定元素在已分配包装盒内的放置位置。

unit: 0 或 1

如果设为 1，则将元素及其所有后代均视作单个元素以供 Widget.identify() 等使用。 它被用于滚动条之类带有控制柄的东西。

children: [sublayout... ]

指定要放置于元素内的元素列表。每个元素都是一个元组（或其他序列类型），其中第一项是布局名称，另一项是个 Layout 。

tkinter.tix --- TK扩展包

源代码: Lib/tkinter/tix.py [https://github.com/python/cpython/tree/3.10/Lib/tkinter/tix.py]

3.6 版后已移除: 这个 TK 扩展已无人维护所以请不要在新代码中使用。 请改用 tkinter.ttk。

tkinter.tix (Tk Interface Extension) 模块提供了更丰富的额外可视化部件集。 虽然标准 Tk 库包含许多有用的部件，但还远不够完备。 tkinter.tix 库提供了标准 Tk 所缺少的大量常用部件: HList, ComboBox, Control (即 SpinBox) 以及一系列可滚动的部件。 tkinter.tix 还包括了大量在多种不同领域的应用中很常用的部件: NoteBook, FileEntry, PanedWindow 等等；总共有超过 40 种。

使用这些新增部件，你可以为应用程序引入新的交互技术，创建更好用且更直观的用户界面。 你在设计应用程序时可以通过选择最适合的部件来匹配你的应用程序和用户的特殊需求。

参见

Tix 主页 [https://tix.sourceforge.net/]

Tix 的主页。 其中包括附加文档和下载资源的链接。

Tix 指南页面 [https://tix.sourceforge.net/dist/current/man/]

在线版本的指南页面和参考材料。

Tix 编程指引 [https://tix.sourceforge.net/dist/current/docs/tix-book/tix.book.html]

在线版本的程序员参考材料。

Tix 开发应用程序 [https://tix.sourceforge.net/Tixapps/src/Tide.html]

开发 Tix 和 Tkinter 程序的 Tix 应用。 Tide 应用在 Tk 在 Tkinter 下工作，并包括了 TixInspect，这是一个可远程修改和调试 Tix/Tk/Tkinter 应用的检查工具。

使用 Tix

class tkinter.tix.Tk(screenName=None, baseName=None, className='Tix')

最常用于代表应用主窗口的最高层级部件。 它具有一个相关联的 Tcl 解释器。interpreter.

tkinter.tix 模块中的类子类化了 tkinter 中的类。 前者会导入后者，因此 tkinter.tix 要使用 Tkinter，你所要做的就是导入一个模块。 通常，你可以只导入 tkinter.tix，并将最高层级调用由 tkinter.Tk 替换为 tix.Tk:

from tkinter import tix
from tkinter.constants import *
root = tix.Tk()

要使用 tkinter.tix，你必须安装有 Tix 部件，通常会与你的 Tk 部分一起安装。 要测试你的安装，请尝试以下代码:

from tkinter import tix
root = tix.Tk()
root.tk.eval('package require Tix')

Tix 部件

Tix [https://tix.sourceforge.net/dist/current/man/html/TixCmd/TixIntro.htm] 将 40 多个部件 类引入到 tkinter 工具集中。

基本部件

class tkinter.tix.Balloon

Balloon [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixBalloon.htm] 是在部件 上弹出用于提供帮助信息的部件 。 当用户将光标移到一个与 Balloon 部件绑定的部件内时，将在屏幕上弹出一个显示描述性消息的小窗口。

class tkinter.tix.ButtonBox

ButtonBox [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixButtonBox.htm] 部件 会创建一组按钮框，例如常用的 Ok Cancel 按钮框。

class tkinter.tix.ComboBox

ComboBox [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixComboBox.htm] 部件 类似于 MS Windows 中的组合框控件。 用户可以通过在输入框子部件中输入或是在列表框子部件中选择来选定一个选项。

class tkinter.tix.Control

Control [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixControl.htm] 部件又名 SpinBox 部件。 用户可通过点按两个方向键或直接输内容来调整数值。 更新的数值将被检查是否在用户定义的上下限之内。

class tkinter.tix.LabelEntry

LabelEntry [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixLabelEntry.htm] 部件 将输入框部件和标签打包为一个部件。 它可被用来简化“输入表单”类界面的创建。

class tkinter.tix.LabelFrame

LabelFrame [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixLabelFrame.htm] 部件将框架部件和标签打包为一个部件。 要在一个 LabelFrame 部件中创建部件，应当创建与 frame 子部件相关联的新部件并在 frame 子部件中管理它们。

class tkinter.tix.Meter

Meter [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixMeter.htm] 部件可用来显示可能会耗费很长时间运行的后台任务的进度。

class tkinter.tix.OptionMenu

OptionMenu [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixOptionMenu.htm] 可创建一个选项按钮菜单。

class tkinter.tix.PopupMenu

PopupMenu [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixPopupMenu.htm] 部件可被用来替代 tk_popup 命令。 Tix PopupMenu 部件的优势在于它所需要操纵的应用代码较少。

class tkinter.tix.Select

Select [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixSelect.htm] 控件是一组按钮子控件的容器。 它可被用来为用户提供单选钮或复选钮形式的选项。

class tkinter.tix.StdButtonBox

StdButtonBox [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixStdButtonBox.htm] 部件是一个用于 Motif 风格对话框的标准按钮组。

文件选择器

class tkinter.tix.DirList

DirList [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixDirList.htm] 部件显示一个目录、它的上级目录和子目录的列表视图。 用户可以选择表中显示的某个目录或切换到另一个目录。

class tkinter.tix.DirTree

DirTree [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixDirTree.htm] 部件显示一个目录、它的上级目录和子目录的树状视图。 用户可以选择其中显示的某个目录或切换到另一个目录。

class tkinter.tix.DirSelectDialog

DirSelectDialog [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixDirSelectDialog.htm] 部件以对话框窗口形式表示文件系统中的目录。 用户可以使用该对话框窗口在文件系统中漫游以选择所需的目录。

class tkinter.tix.DirSelectBox

DirSelectBox 类似于标准的 Motif(TM) 目录选择框。 它通常用于让用户选择一个目录。 DirSelectBox 会将最近选择的目录存放在一个 ComboBox 部件中以便可以再次快速地选择它们。

class tkinter.tix.ExFileSelectBox

ExFileSelectBox [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixExFileSelectBox.htm] 部件通常是嵌入在 tixExFileSelectDialog 部件中。 它为用户提供了一种方便的选择文件方法。 ExFileSelectBox 部件的风格非常类似于 MS Windows 3.1 中的标准文件对话框。

class tkinter.tix.FileSelectBox

FileSelectBox [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixFileSelectBox.htm] 类似于标准的 Motif(TM) 文件选择框。 它通常用于让用户选择一个文件。 FileSelectBox 会将最近选择的文件存放在一个 ComboBox 部件中以便可以再次快速地选择它们。

class tkinter.tix.FileEntry

FileEntry [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixFileEntry.htm] 部件可被用于输入一个文件名。 用户可以手动输入文件名。 或者用户也可以按输入框旁边的按钮部件，这将打开一个文件选择对话框。

层级式列表框

class tkinter.tix.HList

HList [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixHList.htm] 部件可被用于显示任何具有层级结构的数据，例如文件系统目录树。 其中的列表条目带有缩进并按照排泄物的层级中的位置以分支线段相连。

class tkinter.tix.CheckList

CheckList [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixCheckList.htm] 部件可显示一个供用户选择的条目列表。 CheckList 的功能类似于 Tk 复选钮或单选钮部件，不同之处在于它能够处理比复选钮或单选钮多得多的条目。

class tkinter.tix.Tree

Tree [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixTree.htm] 部件可被用于以树形显示具有层级结构的数据。 用户可以通过打开或关闭部分树枝来调整树形视图。

表格式列表框

class tkinter.tix.TList

TList [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixTList.htm] 部件可被用于以表格形式显示数据。 TList 部件中的列表条目类似 Tk 列表框部件中的条目。 主要区别在于 (1) TList 部件能以二维格式显示列表条目 (2) 你可以在列表条目中使用图片以及多种颜色和字体。

管理器部件

class tkinter.tix.PanedWindow

PanedWindow [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixPanedWindow.htm] 部件允许用户交互式地控件多个面板的大小。 这些面板可以垂直或水平地排列。 用户通过拖动两个面板间的控制柄来改变面板的大小。

class tkinter.tix.ListNoteBook

ListNoteBook [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixListNoteBook.htm] 部件非常类似于 TixNoteBook 部件：它可被用于在有限空间内显示多个窗口，就像是一个笔记本。 笔记本被分成许多重叠的页面（窗口）。 同一时刻只能显示其中一个页面。 用户可以通过在 hlist 子部件中选择所需页面的名称来切换这些页面。

class tkinter.tix.NoteBook

NoteBook [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixNoteBook.htm] 部件可被用于在有限空间内显示多个窗口，就像是一个笔记本。 笔记本被分成许多重叠的页面。 同一时刻只能显示其中一个页面。 用户可以通过选择 NoteBook 部件顶端的可视化“选项卡”来切换这些页面。

图像类型

tkinter.tix 模块增加了:

pixmap [https://tix.sourceforge.net/dist/current/man/html/TixCmd/pixmap.htm] 功能提供给所有 tkinter.tix 和 tkinter 部件以使用 XPM 文件创建彩色图像。

Compound [https://tix.sourceforge.net/dist/current/man/html/TixCmd/compound.htm] 图像类型可被用于创建由许多水平行构成的图像；每一行都包含从左至右排列的一组条目（文本、位图、图像或空白）。 例如，某个组合图像可被用于在一个 Tk Button 部件内同时显示一张位图和一个文本字符串。

其他部件

class tkinter.tix.InputOnly

InputOnly [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixInputOnly.htm] 部件用于接受来自用户的输入，此功能可通过 bind 命令实现（仅限 Unix）。

表单布局管理器

tkinter.tix 还额外提供了以下部件来增强 tkinter 的功能:

class tkinter.tix.Form

Form [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tixForm.htm] 布局管理器是以针对所有 Tk 部件的附加规则为基础的。

Tix 命令

class tkinter.tix.tixCommand

tix 命令 [https://tix.sourceforge.net/dist/current/man/html/TixCmd/tix.htm] 提供了对 Tix 内部状态和 Tix 应用程序上下文等杂项元素的访问。 大部分由这些方法控制的信息会作为一个整体发给应用程序，或是发给一个屏幕或显示区域，而不是某个特定窗口。

要查看当前的设置，通常的用法是:

from tkinter import tix
root = tix.Tk()
print(root.tix_configure())

tixCommand.tix_configure(cnf=None, **kw)

查询或修改 Tix 应用程序上下文的配置选项。 如果未指定任何选项，则返回包含所有选项的字典。 如果指定了不带值的选项，则该方法返回描述指定选项的列表（如果未指定选项则此列表与所返回值对应的子列表相同）。 如果指定了一个或多个选项-值对，则该方法会将指定的选项修改为指定的值；在此情况下该方法将返回一个空字符串。 选项可以是配置选项中的任何一个。

tixCommand.tix_cget(option)

返回由 option 给出的配置选项的当前值。 选项可以是配置选项中的任何一个。

tixCommand.tix_getbitmap(name)

在某个位图目录中定位名称为 name.xpm 或 name 的位图文件（位图目录参见 tix_addbitmapdir() 方法）。 通过使用 tix_getbitmap()，你可以避免在你的应用程序中硬编码位图文件的路径名。 执行成功时，它返回位图文件的完整路径名，并带有前缀字符 @。 返回值可被用于配置 Tk 和 Tix 部件的 bitmap 选项。

tixCommand.tix_addbitmapdir(directory)

Tix 维护了一个列表以供 tix_getimage() 和 tix_getbitmap() 方法在其中搜索图像文件。 标准位图目录是 $TIX_LIBRARY/bitmaps。 tix_addbitmapdir() 方法向该列表添加了 directory。 通过使用此方法，应用程序的图像文件也可使用 tix_getimage() 或 tix_getbitmap() 方法来定位。

tixCommand.tix_filedialog([dlgclass])

返回可在来自该应用程序的同不调用之间共享的选择对话框。 此方法将在首次被调用时创建一个选择对话框部件。 此后对 tix_filedialog() 的所有调用都将返回该对话框。 可以传入一个字符串形式的可选形参 dlgclass 来指明所需的选择对话框类型。 可用的选项有 tix, FileSelectDialog 或 tixExFileSelectDialog。

tixCommand.tix_getimage(self, name)

在某个位图目录（参见上文的 tix_addbitmapdir() 方法）中定位名为 name.xpm, name.xbm 或 name.ppm 的图像文件。 如果存在多个同名文件（但扩展名不同），则会按照 X 显示的深度选择图像类型：单色显示选择 xbm 图像而彩色显示则选择彩色图像。 通过使用 tix_getimage()，你可以避免在你的应用程序中硬编码图像文件的路径名。 当执行成功时，此方法将返回新创建图像的名称，它可被用于配置 Tk 和 Tix 部件的 image 选项。

tixCommand.tix_option_get(name)

获取由 Tix 方案机制维护的选项。

tixCommand.tix_resetoptions(newScheme, newFontSet[, newScmPrio])

将 Tix 应用程序的方案与字体集分别重置为 newScheme 和 newFontSet。 这只会影响调用此方法之后创建的部件。 因此，最好是在 Tix 应用程序的任何部件被创建之前调用 resetoptions 方法。

可以给出可选的形参 newScmPrio 来重置由 Tix 方案所设置的 Tk 选项的优先级。

由于 Tk 处理 X 选项数据库的特别方式，在 Tix 被导入并初始化之后，将无法再使用 tix_config() 方法来重置颜色方案和字体集。 而必须要使用 tix_resetoptions() 方法。

IDLE

源代码： Lib/idlelib/ [https://github.com/python/cpython/tree/3.10/Lib/idlelib/]

IDLE 是 Python 所内置的开发与学习环境。

IDLE 具有以下特性：

编码于 100% 纯正的 Python，使用名为 tkinter 的图形用户界面工具

跨平台：在 Windows、Unix 和 macOS 上工作近似。

提供输入输出高亮和错误信息的 Python 命令行窗口 （交互解释器）

提供多次撤销操作、Python 语法高亮、智能缩进、函数调用提示、自动补全等功能的多窗口文本编辑器

在多个窗口中检索，在编辑器中替换文本，以及在多个文件中检索（通过 grep）

提供持久保存的断点调试、单步调试、查看本地和全局命名空间功能的调试器

配置、浏览以及其它对话框

目录

IDEL 有两种主要的窗口类型：Shell窗口和编辑器窗口。其中编辑器窗口可以同时打开多个。并且对于 Windows 和 Linux 平台，窗口顶部主菜单各不相同。以下每个菜单说明项，都标识了与之关联的平台类型。

导出窗口，例如使用 编辑=>在文件中查找 是编辑器窗口的的一个子类型。它们目前有着相同的主菜单，但是默认标题和上下文菜单不同。

在macOS上，只有一个应用程序菜单。它会根据当前选择的窗口动态变化。它具有一个IDLE菜单，并且下面描述的某些条目已移动到符合Apple准则的位置。

文件菜单 （命令行和编辑器）

新建文件

创建一个文件编辑器窗口。

打开...

使用打开窗口以打开一个已存在的文件。

打开模块...

打开一个已存在的模块 （搜索 sys.path）

近期文件

打开一个近期文件列表，选取一个以打开它。

模块浏览器

于当前所编辑的文件中使用树形结构展示函数、类以及方法。在命令行中，首先打开一个模块。

路径浏览

在树状结构中展示 sys.path 目录、模块、函数、类和方法。

保存

如果文件已经存在，则将当前窗口保存至对应的文件。自打开或上次保存之后经过修改的文件的窗口标题栏首尾将出现星号 * 。如果没有对应的文件，则使用“另存为”代替。

保存为...

通过 Save As 对话框保存当前窗口。 被保存的文件将成为关联到该窗口的新文件。 （如果你的文件管理器被设为隐藏扩展名，则当前扩展名将在文件名文本框中被省略。 如果新的文件名不带 '.'，则将为 Python 和文本文件添加 '.py' 和 '.txt'，除非是在 macOS Aqua, 上，这时将为所有文件添加 '.py'。）

另存为副本...

将当前窗口保存到不同的文件而不改变已关联的文件。 （请参阅上文 Save As 中有关文件扩展名的说明。）

打印窗口

通过默认打印机打印当前窗口。

关闭窗口

关闭当前窗口（如果是未保存的编辑器窗口，则会提示保存；如果是未保存的 Shell 窗口，则会提示退出执行）。 在Shell 窗口中调用 exit() 或 close() 也会关闭 Shell 窗口。 如果这是唯一的窗口，则还会退出 IDLE。

退出 IDLE

关闭所有窗口并退出 IDLE (将提示保存未保存的编辑窗口）。

编辑菜单（命令行和编辑器）

撤销操作

撤销当前窗口的最近一次操作。最高可以撤回 1000 条操作记录。

重做

重做当前窗口最近一次所撤销的操作。

全选

选择当前窗口的全部内容。

剪切

复制选区至系统剪贴板，然后删除选区。

复制

复制选区至系统剪贴板。

粘贴

插入系统剪贴板的内容至当前窗口。

剪贴板功能也可用于上下文目录。

查找...

打开一个提供多选项的查找窗口。

再次查找

重复上一次搜索（如果有的话）。

查找选区

查找当前选中的字符串，如果存在

在文件中查找...

打开文件查找对话框。将结果输出至新的输出窗口。

替换...

打开 查找并替换 对话框。

前往行

将光标移到所请求行的开头并使该行可见。 对于超过文件尾的请求将会移到文件尾。 清除所有选区并更新行列状态。

显示补全信息

打开一个可滚动列表以允许选择现有的名称。 请参阅下面编辑与导航一节中的 自动补全。

展开文本

展开键入的前缀以匹配同一窗口中的完整单词；重复以获得不同的扩展。

显示调用提示

在函数的右括号后，打开一个带有函数参数提示的小窗口。 请参阅下面的“编辑和导航”部分中的 调用提示。

显示周围括号

突出显示周围的括号。

格式菜单（仅 window 编辑器）

格式段落

在注释块或多行字符串或字符串中的选定行中，重新格式化当前以空行分隔的段落。段落中的所有行的格式都将少于N列，其中N默认为72。

增加缩进

将选定的行右缩进（默认为4个空格）。

减少缩进

将选定的行左缩进（默认为4个空格）。

注释

在所选行的前面插入 ##。

取消注释

从所选行中删除开头的 ＃ 或 ##。

制表符化

将 前导 空格变成制表符。 （注意：我们建议使用4个空格来缩进Python代码。）

取消制表符化

将 所有 制表符转换为正确的空格数。

缩进方式切换

打开一个对话框，以在制表符和空格之间切换。

缩进宽度调整

打开一个对话框以更改缩进宽度。 Python社区接受的默认值为4个空格。

去除尾随空格

通过将 str.rstrip 应用于每行（包括多行字符串中的行），删除行尾非空白字符之后的尾随空格和其他空白字符。除Shell窗口外，在文件末尾删除多余的换行符。

运行菜单（仅 window 编辑器）

运行模块

执行 检查模块 。如果没有错误，重新启动 shell 以清理环境，然后执行模块。输出显示在 shell 窗口中。请注意，输出需要使用 “打印” 或 “写入”。执行完成后，Shell 将保留焦点并显示提示。此时，可以交互地探索执行的结果。这类似于在命令行执行带有 python -i file 的文件。

运行... 定制

与 运行模块 相同，但使用自定义设置运行该模块。命令行参数 扩展 sys.argv ，就像在命令行上传递一样。该模块可以在命令行管理程序中运行，而无需重新启动。

检查模块

检查 “编辑器” 窗口中当前打开的模块的语法。如果尚未保存该模块，则 IDLE会提示用户保存或自动保存，如在 “空闲设置” 对话框的 “常规” 选项卡中所选择的那样。如果存在语法错误，则会在 “编辑器” 窗口中指示大概位置。

Python Shell

打开或唤醒Python Shell窗口。

Shell 菜单（仅限 Shell 窗口）

查看最近重启

将Shell窗口滚动到上一次Shell重启。

重启Shell

重启 shell 以清理环境，重置显示和异常处理。

上一条历史记录

循环浏览历史记录中与当前条目匹配的早期命令。

下一条历史记录

循环浏览历史记录中与当前条目匹配的后续命令。

中断执行

停止正在运行的程序。

调试菜单（仅限 Shell 窗口）

跳转到文件/行

查看当前行。 以光标提示，且上一行为文件名和行号。 如果找到目标，如果文件尚未打开则打开该文件，并显示目标行。 使用此菜单项来查看异常回溯中引用的源代码行以及用文件中查找功能找到的行。 也可在 Shell 窗口和 Output 窗口的上下文菜单中使用。

调试器（切换）

激活后，在Shell中输入的代码或从编辑器中运行的代码将在调试器下运行。在编辑器中，可以使用上下文菜单设置断点。此功能不完整，具有实验性。

堆栈查看器

在树状目录中显示最后一个异常的堆栈回溯，可以访问本地和全局。

自动打开堆栈查看器

在未处理的异常上切换自动打开堆栈查看器。

选项菜单（命令行和编辑器）

配置 IDLE

打开配置对话框并更改以下各项的首选项：字体、缩进、键绑定、文本颜色主题、启动窗口和大小、其他帮助源和扩展名。在MacOS上，通过在应用程序菜单中选择首选项来打开配置对话框。有关详细信息，请参阅：帮助和首选项下的 首选项设置。

大多数配置选项适用于所有窗口或将来的所有窗口。以下选项仅适用于活动窗口。

显示/隐藏代码上下文（仅限编辑器窗口）

在编辑窗口顶部打开一个面板来显示在窗口顶部滚动的代码块上下文。 请参阅下文“编辑与导航”章节中的 代码上下文。

显示/隐藏行号（仅限 Editor 窗口）

在编辑窗口左侧打开一个显示代码文本行编号的列。 默认为关闭显示，这可以在首选项中修改 (参见 设置首选项)。

缩放/还原高度

在窗口的正常尺寸和最大高度之间进行切换。 初始尺寸默认为 40 行每行 80 字符，除非在配置 IDLE 对话框的通用选项卡中做了修改。 屏幕的最大高度由首次在屏幕上将缩小的窗口最大化的操作来确定。 改变屏幕设置可能使保存的高度失效。 此切换操作在窗口最大化状态下无效。

Window 菜单（命令行和编辑器）

列出所有打开的窗口的名称；选择一个将其带到前台（必要时对其进行去符号化）。

帮助菜单（命令行和编辑器）

关于 IDLE

显示版本，版权，许可证，荣誉等。

IDLE 帮助

显示此 IDLE 文档，详细介绍菜单选项，基本编辑和导航以及其他技巧。

Python 文档

访问本地Python文档（如果已安装），或启动Web浏览器并打开docs.python.org显示最新的Python文档。

海龟演示

使用示例 Python 代码运行 turtledemo 模块和海龟绘图

可以在 “常规” 选项卡下的 “配置IDLE” 对话框中添加其他帮助源。有关“帮助”菜单选项的更多信息，请参见下面的 帮助源 小节。

上下文菜单

通过在窗口中右击（在 macOS 上则为按住 Control 键点击）来打开一个上下文菜单。 上下文菜单也具有编辑菜单中的标准剪贴板功能。

剪切

复制选区至系统剪贴板，然后删除选区。

复制

复制选区至系统剪贴板。

粘贴

插入系统剪贴板的内容至当前窗口。

编辑器窗口也具有断点功能。 设置了断点的行会被特别标记。 断点仅在启用调试器运行时有效。 文件的断点会被保存在用户的 .idlerc 目录中。

设置断点

在当前行设置断点

清除断点

清除当前行断点

shell 和输出窗口还具有以下内容。

跳转到文件/行

与调试菜单相同。

Shell 窗口也有一个输出折叠功能，参见下文的 Python Shell 窗口 小节。

压缩

如果将光标位于输出行上，则会折叠在上方代码和下方提示直到 'Squeezed text' 标签之间的所有输出。

编辑和导航

编辑窗口

IDLE 可以在启动时打开编辑器窗口，这取决于选项设置和你启动 IDLE 的方式。 在此之后，请使用 File 菜单。 对于给定的文件只能打开一个编辑器窗口。

标题栏包含文件名称、完整路径，以及运行该窗口的 Python 和 IDLE 版本。 状态栏包含行号 ('Ln') 和列号 ('Col')。 行号从 1 开始；列号则从 0 开始。

IDE 会定扩展名为 .py* 的文件包含 Python 代码而其他文件不包含。 可使用 Run 菜单来运行 Python 代码。

按键绑定

在本节中，'C' 是指 Windows 和 Unix 上的 Control 键，以及 macOS 上的 Command 键。

Backspace 向左删除; Del 向右删除

C-Backspace 向左删除单词; C-Del 向右删除单词

方向键和 Page Up/Page Down 移动

C-LeftArrow 和 C-RightArrow 按单词移动

Home/End 跳转到行首/尾

C-Home/C-End 跳转到文档首/尾

一些有用的Emacs绑定是从Tcl / Tk继承的：

C-a 行首

C-e 行尾

C-k 删除行（但未将其放入剪贴板）

C-l 将插入点设为窗口中心

C-b 后退一个字符而不删除该字符（通常你也可以用方向键进行此操作）

C-f 前进一个字符而不删除该字符（通常你也可以用方向键进行此操作）

C-p 向上一行（通常你也可以用方向键进行此操作）

C-d 删除下一个字符

标准的键绑定（例如 C-c 复制和 C-v 粘贴）仍会有效。 键绑定可在配置 IDLE 对话框中选择。

自动缩进

在一个代码块开头的语句之后，下一行会缩进 4 个空格符（在 Python Shell 窗口中是一个制表符）。 在特定关键字之后（break, return 等），下一行将不再缩进。 在开头的缩进中，按 Backspace 将会删除 4 个空格符。 Tab 则会插入空格符（在 Python Shell 窗口中是一个制表符），具体数量取决于缩进宽度。 目前，Tab 键按照 Tcl/Tk 的规定设置为四个空格符。

另请参阅 Format 菜单 的缩进/取消缩进区的命令。

搜索和替换

任何选择都将成为搜索目标。 但是，只有在同一行内的选择才有效因为搜索只针对行进行并会移除换行符。 如果勾选了 [x] Regular expresion，目标将按照 Python re 模块的规则来解读。

补全

当被请求并且可用时，将为模块名、类属性、函数或文件名提供补全。 每次请求方法将显示包含现有名称的补全提示框。 （例外情况参见下文的 Tab 补全。） 对于任意提示框，要改变被补全的名称和提示框中被高亮的条目，可以通过输入和删除字符、按 Up, Down, PageUp, PageDown, Home 和 End 键；或是在提示框中单击。 要关闭补全提示框可以通过 Escape, Enter 或按两次 Tab 键或是在提示框外单击。 在提示框内双击则将执行选择并关闭。

有一种打开提示框的方式是输入一个关键字符并等待预设的一段间隔。 此间隔默认为 2 秒；这可以在设置对话框中定制。 （要防止自动弹出，可将时延设为一个很大的豪秒数值，例如 100000000。） 对于导入的模块名或者类和函数属性，请输入 '.'。 对于根目录下的文件名，请在开头引号之后立即输入 os.sep 或 os.altsep。 （在 Windows 下，可以先指定一个驱动器。） 可通过输入目录名和分隔符来进入子目录。

除了等待，或是在提示框关闭之后，可以使用 Edit 菜单的 Show Completions 来立即打开一个补全提示框。 默认的热键是 C-space。 如果在打开提示框之前输入一某个名称的前缀，则将显示第一个匹配项或最接近的项。 结果将与在提示框已显示之后输入前缀时相同。 在一个引号之后执行 Show Completions 将会实例当前目录下的文件名而不是根目录下的。

在输入前缀后按 Tab 键的效果通常与 Show Completions 相同。 （如果未输入前缀则为缩进。） 但是，如果输入的前缀只有一个匹配项，则该匹配项会立即被添加到编辑器文本中而不打开补全提示框。

在字符串以外且开头不带 '.' 地输入前缀并执行 'Show Completions' 或按 Tab 键将打开一个包含关键字、内置名称和现有模块级名称的补全提示框。

当在编辑器（而非 Shell）中编辑代码时，可以通过运行你的代码并在此后不重启 Shell 来增加可用的模块级名称。 这在文件顶部添加了导入语句之后会特别有用。 这还会增加可用的属性补全。

补全提示框在初始时会排除以 '_' 打头的名称，对于模块还会排除未包括在 '__all__' 中的名称。 这些隐藏名称可通过在 '.' 之后输入 '_' 来访问，这在提示框打开之前或之后都是有效的。

提示

当在一个 可用的 函数名称之后输入 ( 时将自动显示一个调用提示。 函数名称表达式可以包括点号和方括号索引操作。 调用提示将保持打开直到它被点击、光标移出参数区、或是输入了 )。 当光标位于某个定义的参数区时，可以在菜单中选择 Edit 的 "Show Call Tip" 或是输入其快捷键来显示调用提示。

调用提示是由函数的签名和文档字符串到第一个空行或第五个非空行为止的内容组成的。 （某些内置函数没有可访问的签名。） 签名中的 '/' 或 '*' 指明其前面或后面的参数仅限以位置或名称（关键字）方式传入。 具体细节可能会改变。

在 Shell 中，可访问的函数取决于有哪些模块已被导入用户进程，包括由 IDLE 本身导入的模块，以及哪些定义已被运行，以上均从最近的重启动开始算起。

例如，重启动 Shell 并输入 itertools.count(。 将显示调用提示，因为 IDLE 出于自身需要已将 itertools 导入了用户进程。 （此行为可能会改变。） 输入 turtle.write( 则不显示任何提示。 因为 IDLE 本身不会导入 turtle。 菜单项和快捷键同样不会有任何反应。 输入 import turtle。 则在此之后，turtle.write( 将显示调用提示。

在编辑器中，import 语句在文件运行之前是没有效果的。 在输入 import 语句之后、添加函数定义之后，或是打开一个现有文件之后可以先运行一下文件。

代码上下文

在一个包含 Python 代码的编辑器窗口内部，可以切换代码上下文以便显示或隐藏窗口顶部的面板。 当显示时，此面板可以冻结代码块的开头行，例如以 class, def 或 if 关键字开头的行，这样的行在不显示时面板时可能离开视野。 此面板的大小将根据需要扩展和收缩以显示当前层级的全部上下文，直至达到配置 IDLE 对话框中所定义的最大行数（默认为 15）。 如果如果没有当前上下文行而此功能被启用，则将显示一个空行。 点击上下文面板中的某一行将把该行移至编辑器顶部。

上下文面板的文本和背景颜色可在配置 IDLE 对话框的 Highlights 选项卡中进行配置。

Shell 窗口

在 IDLE 的 Shell 中，输入、编辑和重新执行完整的语句。 （多数控制台和终端每次只能操作一个物理行）。

在光标位于行内任意位置的情况下按 Return 键来将单行语句提交执行。 如果带有强制换行的反斜杠 (\)，则光标必须位于最后一个物理行。 对于包含多行的复合语句要通过在语句之后额外输入一个空行来提交执行。

当将代码粘贴到 Shell 中时，它并不会被编译并执行除非如上所述地再按下 Return 键。 可以先对粘贴的代码进行编辑。 如果将多条语句粘贴到 Shell 中，则多条语句被当作一条语句来编译并引发 SyntaxError。

包含 RESTART 的行表明用户执行进程已被重启。 这种情况会在用户执行进程崩溃、在 Shell 菜单中选择重启，或在编辑器窗口中运行代码时发生。

之前小节中描述的编辑功能在交互式地输入代码时也可使用。 IDLE 的 Shell 窗口还会响应以下按键。

C-c 中断执行命令

C-d 发送文件结束命令；如果在 >>> 提示符后按下会关闭窗口。

Alt-/ (扩展单词) 也有助于减少按键量

历史命令

Alt-p 提取与你所输入键匹配的前一条命令。 在 macOS 上请使用 C-p。

Alt-n 提取下一条命令。 在 macOS 上请使用 C-n。

当光标位于之前的任意命令上时按 Return 键将提取该命令。

文本颜色

IDLE 文本默认为白底黑字，但有特殊含义的文本将以彩色显示。 对于 Shell 来说包括 Shell 输出，Shell 错误，用户输出和用户错误。 对于 Shell 提示符下或编辑器中的 Python 代码来说则包括关键字，内置类和函数名称，class 和 def 之后的名称，字符串和注释等。 对于任意文本窗口来说则包括光标（如果存在）、找到的文本（如果可能）和选定的文本。

IDLE 还会高亮显示模式匹配语句中的 软关键字 match, case 和 _。 但是，这种高亮显示并不完美，在某些极端情况下还会出现错误，包括 _ 在 case 模式中出现的时候。

广西着色是在背景上完成的，因此有时会看到非着色的文本。 要改变颜色方案，请使用配置 IDLE 对话框的高亮选项卡。 编辑器中的调试器断点行标记和弹出面板和对话框中的文本则是用户不可配置的。

启动和代码执行

在附带 -s 选项启用的情况下，IDLE 将会执行环境变量 IDLESTARTUP 或 PYTHONSTARTUP 所引用的文件。 IDLE 会先检查 IDLESTARTUP；如果 IDLESTARTUP 存在则会运行被引用的文件。 如果 IDLESTARTUP 不存在，则 IDLE 会检查 PYTHONSTARTUP。 这些环境变量所引用的文件是存放经常被 IDLE Shell 所使用的函数，或者执行导入常用模块的 import 语句的便捷场所。

此外，Tk 也会在存在启动文件时加载它。 请注意 Tk 文件会被无条件地加载。 此附加文件名为 .Idle.py 并且会在用户的家目录下查找。 此文件中的语句将在 Tk 的命名空间中执行，所以此文件不适用于导入要在 IDLE 的 Python Shell 中使用的函数。

命令行语法

idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...

-c command  run command in the shell window
-d          enable debugger and open shell window
-e          open editor window
-h          print help message with legal combinations and exit
-i          open shell window
-r file     run file in shell window
-s          run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
-t title    set title of shell window
-           run stdin in shell (- must be last option before args)

如果有参数：

如果使用了 -, -c 或 r，则放在 sys.argv[1:...] 和 sys.argv[0] 中的所有参数都会被设为 '', '-c' 或 '-r'。 不会打开任何编辑器窗口，即使是在选项对话框中的默认设置。

在其他情况下，参数为要打开编辑的文件而 sys.argv 反映的是传给 IDLE 本身的参数。

启动失败

IDLE 使用一个套接字在 IDLE GUI 进程和用户代码执行进程之间通信。 当 Shell 启动或重启动时必须建立一个连接。 （重启动会以一个内容为 'RESTART' 的分隔行来标示）。 如果用户进程无法连接到 GUI 进程，它通常会显示一个包含 'cannot connect' 消息的 Tk 错误提示框来引导用户。 随后将会退出程序。

有一个 Unix 系统专属的连接失败是由系统网络设置中错误配置的掩码规则导致的。 当从一个终端启动 IDLE 时，用户将看到一条以 ** Invalid host: 开头的消息。 有效的值为 127.0.0.1 (idlelib.rpc.LOCALHOST)。 用户可以在一个终端窗口输入 tcpconnect -irv 127.0.0.1 6543 并在另一个终端窗口中输入 tcplisten <same args> 来进行诊断。

导致连接失败的一个常见原因是用户创建的文件与标准库模块同名，例如 random.py 和 tkinter.py。 当这样的文件与要运行的文件位于同一目录中时，IDLE 将无法导入标准库模块。 可用的解决办法是重命名用户文件。

虽然现在已不太常见，但杀毒软件或防火墙程序也有可能会阻止连接。 如果无法将此类程序设为允许连接，那么为了运行 IDLE 就必须将其关闭。 允许这样的内部连接是安全的，因为数据在外部端口上不可见。 一个类似的问题是错误的网络配置阻止了连接。

Python 的安装问题有时会使 IDLE 退出：存在多个版本时可能导致程序崩溃，或者单独安装时可能需要管理员权限。 如果想要避免程序崩溃，或是不想以管理员身份运行，最简单的做法是完全卸载 Python 并重新安装。

有时会出现 pythonw.exe 僵尸进程问题。 在 Windows 上，可以使用任务管理员来检查并停止该进程。 有时由程序崩溃或键盘中断（control-C）所发起的重启动可能会出现连接失败。 关闭错误提示框或使用 Shell 菜单中的 Restart Shell 可能会修复此类临时性错误。

当 IDLE 首次启动时，它会尝试读取 ~/.idlerc/ 中的用户配置文件（~ 是用户的家目录）。 如果配置有问题，则应当显示一条错误消息。 除随机磁盘错误之外，此类错误均可通过不手动编辑这些文件来避免。 请使用 Options 菜单来打开配置对话框。 一旦用户配置文件出现错误，最好的解决办法就是删除它并使用配置对话框重新设置。

如果 IDLE 退出时没有发出任何错误消息，并且它不是通过控制台启动的，请尝试通过控制台或终端 (python -m idlelib) 来启动它以查看是否会出现错误消息。

在基于 Unix 的系统上使用 tcl/tk 低于 8.6.11 的版本 (查看 About IDLE) 时特定字体的特定字符可能导致终端提示 tk 错误消息。 这可能发生在启动 IDLE 编辑包此种字符的文件或是在之后输入此种字符的时候。 如果无法升级 tcl/tk，可以重新配置 IDLE 来使用其他的字体。

运行用户代码

除了少量例外，使用 IDLE 执行 Python 代码的结果应当与使用默认方法，即在文本模式的系统控制台或终端窗口中直接通过 Python 解释器执行同样的代码相同。 但是，不同的界面和操作有时会影响显示的结果。 例如，sys.modules 初始时具有更多条目，而 threading.active_count() 将返回 2 而不是 1。

在默认情况下，IDLE 会在单独的 OS 进程中运行用户代码而不是在运行 Shell 和编辑器的用户界面进程中运行。 在执行进程中，它会将 sys.stdin, sys.stdout 和 sys.stderr 替换为从 Shell 窗口获取输入并向其发送输出的对象。 保存在 sys.__stdin__, sys.__stdout__ 和 sys.__stderr__ 中的原始值不会被改变，但可能会为 None。

将打印输出从一个进程发送到另一个进程中的文本部件要比打印到同一个进程中的系统终端慢。 这在打印多个参数时将有更明显的影响，因为每个参数、每个分隔符和换行符对应的字符串都要单独发送。 在开发中，这通常不算是问题，但如果希望能在 IDLE 中更快地打印，可以将想要显示的所有内容先格式化并拼接到一起然后打印单个字符串。 格式字符串和 str.join() 都可以被用于合并字段和文本行。

IDLE 的标准流替换不会被执行进程中创建的子进程所继承，不论它是由用户代码直接创建还是由 multiprocessing 之类的模块创建的。 如果这样的子进程使用了 input 从 sys.stdin 输入或者使用了 print 或 write 向 sys.stdout 或 sys.stderr 输出，则应当在命令行窗口中启动 IDLE。 （在 Windows 中，要使用 python 或 py 而不是 pythonw 或 pyw。） 这样二级子进程将会被附加到该窗口进行输入和输出。

如果 sys 被用户代码重置，例如使用了 importlib.reload(sys)，则 IDLE 的修改将丢失，来自键盘的输入和向屏幕的输出将无法正确运作。

当 Shell 获得焦点时，它将控制键盘与屏幕。 这通常会保持透明，但一些直接访问键盘和屏幕的函数将会不起作用。 这也包括那些确定是否有键被按下以及是哪个键被按下的系统专属函数。

在执行进程中运行的 IDLE 代码会向调用栈添加在其他情况下不存在的帧。 IDLE 包装了 sys.getrecursionlimit 和 sys.setrecursionlimit 以减少额外栈帧的影响。

当用户代码直接或者通过调用 sys.exit 引发 SystemExit 时，IDLE 将返回 Shell 提示符而非完全退出。

Shell中的用户输出

当一个程序输出文本时，结果将由相应的输出设备来确定。 当 IDLE 执行用户代码时，sys.stdout 和 sys.stderr 会被连接到 IDLE Shell 的显示区。 它的某些特性是从底层的 Tk Text 部件继承而来。 其他特性则是程序所添加的。 总之，Shell 被设计用于开发环境而非生产环境运行。

例如，Shell 绝不会丢弃输出。 一个向 Shell 发送无限输出的程序将最终占满内存，导致内存错误。 作为对比，某些系统文本模式窗口只会保留输出的最后 n 行。 例如，Windows 控制台可由用户设置保留 1 至 9999 行，默认为 300 行。

IDLE 的 Shell 所使用的 Tk Text 部件可显示的字符 (码位) 为 Unicode 的 BMP (基本多语言平面) 子集。 具体哪些字符会显示为正确的字形而哪些会以方框代替取决于操作系统和所安装的字体。 制表符会使之后的文本从下一个制表位开始。 (每 8 个 '字符' 对应一个制表位)。 换行符会使之后的文本开始新的一行。 其他控制符会被忽略或是显示为空格、方框或其他形式，具体取决于操作系统和字体。 (使用方向键在这样的输出中移动文本光标有可能让显示间距发生怪异的变化。)

>>> s = 'a\tb\a<\x02><\r>\bc\nd'  # Enter 22 chars.
>>> len(s)
14
>>> s  # Display repr(s)
'a\tb\x07<\x02><\r>\x08c\nd'
>>> print(s, end='')  # Display s as is.
# Result varies by OS and font.  Try it.

repr 函数会被用于表达式值的交互式回显。 它将返回输入字符串的一个修改版本，其中的控制代码、部分 BMP 码位以及所有非 BMP 码位都将被替换为转义代码。 如上面所演示的，它使用户可以辨识字符串中的字符，无论它们会如何显示。

普通的与错误的输出通常会在与代码输入和彼此之间保持区分 (显示于不同的行)。 它们也会分别使用不同的高亮颜色。

对于 SyntaxError 回溯信息，表示检测到错误位置的正常 '^' 标记被替换为带有代表错误的文本颜色高亮。 当从文件运行的代码导致了其他异常时，用户可以右击回溯信息行在 IDLE 编辑器中跳转到相应的行。 如有必要将打开相应的文件。

Shell 具有将输出行折叠为一个 'Squeezed text' 标签的特殊功能。 此功能将自动应用于超过 N 行的输出 (默认 N = 50)。 N 可以在设置对话框中 General 页的 PyShell 区域中修改。 行数更少的输出也可通过在输出上右击来折叠。 此功能适用于过多的输出行数导致滚动操作变慢的情况。

已折叠的输出可通过双击该标签来原地展开。 也可通过右击该标签将其发送到剪贴板或单独的查看窗口。

开发 tkinter 应用程序

IDLE 有意与标准 Python 保持区别以方便 tkinter 程序的开发。 在标准 Python 中输入 import tkinter as tk; root = tk.Tk() 不会显示任何东西。 在 IDLE 中输入同样的代码则会显示一个 tk 窗口。 在标准 Python 中，还必须输入 root.update() 才会将窗口显示出来。 IDLE 会在幕后执行同样的方法，每秒大约 20 次，即每隔大约 50 毫秒。 下面输入 b = tk.Button(root, text='button'); b.pack()。 在标准 Python 中仍然不会有任何可见的变化，直到输入 root.update()。

大多数 tkinter 程序都会运行 root.mainloop()，它通常直到 tk 应用被销毁时才会返回。 如果程序是通过 python -i 或 IDLE 编辑器运行的，则 >>> Shell 提示符将直到 mainloop() 返回时才会出现，这时将结束程序的交互。

当通过 IDLE 编辑器运行 tkinter 程序时，可以注释掉 mainloop 调用。 这样将立即回到 Shell 提示符并可与正在运行的应用程序交互。 请记得当在标准 Python 中运行时重新启用 mainloop 调用。

在没有子进程的情况下运行

在默认情况下，IDLE 是通过一个套接字在单独的子进程中执行用户代码，它将使用内部的环回接口。 这个连接在外部不可见并且不会在互联网上发送或接收数据。 如果防火墙仍然会报警，你完全可以忽略。

如果创建套接字连接的尝试失败，IDLE 将会通知你。 这样的失败可能是暂时性的，但是如果持续存在，问题可能是防火墙阻止了连接或某个系统配置错误。 在问题得到解决之前，可以使用 -n 命令行开关来运行 IDLE。

如果 IDLE 启动时使用了 -n 命令行开关则它将在单个进程中运行并且将不再创建运行 RPC Python 执行服务器的子进程。 这适用于 Python 无法在你的系统平台上创建子进程或 RPC 套接字接口的情况。 但是，在这种模式下用户代码没有与 IDLE 本身相隔离。 而且，当选择 Run/Run Module (F5) 时运行环境也不会重启。 如果你的代码已被修改，你必须为受影响的模块执行 reload() 并重新导入特定的条目 (例如 from foo import baz) 才能让修改生效。 出于这些原因，在可能的情况下最好还是使用默认的子进程来运行 IDLE。

3.4 版后已移除.

帮助和首选项Help and Preferences

帮助源

Help 菜单项 "IDLE Help" 会显示标准库参考中 IDLE 一章的带格式 HTML 版本。 这些内容放在只读的 tkinter 文本窗口中，与在浏览器中看到的内容类似。 可使用鼠标滚轮、滚动条或上下方向键来浏览文本。 或是点击 TOC (Table of Contents) 按钮并在打开的选项框中选择一个节标题。

Help 菜单项 "Python Docs" 会打开更丰富的帮助源，包括教程，通过 docs.python.org/x.y 来访问，其中 'x.y' 是当前运行的 Python 版本。 如果你的系统有此文档的离线副本 (这可能是一个安装选项)，则将打开这个副本。

选定的 URL 可以使用配置 IDLE 对话框的 General 选项卡随时在帮助菜单中添加或移除。

首选项设置

字体首选项、高亮、按键和通用首选项可通过 Option 菜单的配置 IDLE 项来修改。 非默认的用户设置将保存在用户家目录下的 .idlerc 目录中。 用户配置文件错误导致的问题可通过编辑或删除 .idlerc 中的一个或多个文件来解决。

在 Font 选项卡中，可以查看使用多种语言的多个字符的示例文本来了解字体或字号效果。 可以编辑示例文本来添加想要的其他字符。 请使用示例文本选择等宽字体。 如果某些字符在 Shell 或编辑器中的显示有问题，可以将它们添加到示例文本的开头并尝试改变字号和字体。

在 Highlights 和 Keys 选项卡中，可以选择内置或自定义的颜色主题和按键集合。 要将更新的内置颜色主题或按键集合与旧版 IDLE 一起使用，可以将其保存为新的自定义主题或按键集合就将可在旧版 IDLE 中使用。

macOS 上的IDLE

在 System Preferences: Dock 中，可以将 "Prefer tabs when opening documents" 设为 "Always"。 但是该设置不能兼容 IDLE 所使用的 tk/tkinter GUI 框架，并会使得部分 IDLE 特性失效。

扩展

IDLE 可以包含扩展插件。 扩展插件的首选项可通过首选项对话框的 Extensions 选项卡来修改。 请查看 idlelib 目录下 config-extensions.def 的开头来了解详情。 目前唯一的扩展插件是 zzdummy，它也是一个测试用的示例。

idlelib

源代码: Lib/idlelib [https://github.com/python/cpython/tree/3.10/Lib/idlelib]

Lib/idlelib 包实现了 IDLE 应用程序。 请查看本页面的其余的内容来了解如何使用 IDLE。

有关 idlelib 中文件的描述见 idlelib/README.txt。 可以在 idlelib 中或者在 IDLE 中点击 Help => About IDLE 来查看它。 此文件还将 IDLE 菜单条目映射到了实现这些条目的代码。 除了在 'Startup' 中列出的文件以外，idlelib 代码都是 '私有' 的意即特性的修改可以被向下移植 (参见 PEP 434 [https://www.python.org/dev/peps/pep-0434])。

开发工具

本章中描述的各模块可帮你编写 Python 程序。例如，pydoc 模块接受一个模块并根据该模块的内容来生成文档。doctest 和 unittest 这两个模块包含了用于编写单元测试的框架，并可用于自动测试所编写的代码，验证预期的输出是否产生。2to3 程序能够将 Python 2.x 源代码翻译成有效的 Python 3.x 源代码。

本章中描述的模块列表是：

typing —— 对类型提示的支持

相关的 PEP

类型别名

NewType

可调对象（Callable）

泛型（Generic）

用户定义的泛型类型

Any 类型

名义子类型 vs 结构子类型

模块内容

特殊类型原语

特殊类型

特殊形式

构建泛型类型

其他特殊指令

泛型具象容器

对应的内置类型

collections 对应类型

其他具象类型

抽象基类

collections.abc 对应的容器

collections.abc 对应的其他类型

异步编程

上下文管理器类型

协议

函数与装饰器

内省辅助器

常量

pydoc --- 文档生成器和在线帮助系统

Python 开发模式

Python 开发模式的效果

ResourceWarning 示例

文件描述符错误示例

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

简单用法：检查Docstrings中的示例

简单的用法：检查文本文件中的例子

它是如何工作的

哪些文件串被检查了？

文档串的例子是如何被识别的？

什么是执行上下文？

异常如何处理？

选项标记

指令

警告

基本API

Unittest API

高级 API

DocTest 对象

Example 对象

DocTestFinder 对象

DocTestParser 对象

DocTestRunner 对象

OutputChecker 对象

调试

肥皂盒

unittest --- 单元测试框架

基本实例

命令行接口

命令行选项

探索性测试

组织你的测试代码

复用已有的测试代码

跳过测试与预计的失败

使用子测试区分测试迭代

类与函数

测试用例

一些已被弃用的别名

分组测试

加载和运行测试

load_tests 协议

类与模块设定

setUpClass 和 tearDownClass

setUpModule 和 tearDownModule

信号处理

unittest.mock --- 模拟对象库

快速上手

Mock 类

调用

删除属性

Mock 的名称与 name 属性

附加 Mock 作为属性

patch 装饰器

patch

patch.object

patch.dict

patch.multiple

补丁方法: start 和 stop

为内置函数打补丁

TEST_PREFIX

嵌套补丁装饰器

补丁的位置

对描述器和代理对象打补丁

MagicMock 与魔术方法支持

模拟魔术方法

MagicMock

辅助对象

sentinel

DEFAULT

call

create_autospec

ANY

FILTER_DIR

mock_open

自动 spec

将 mock 封包

unittest.mock --- 上手指南

使用 mock

模拟方法调用

对象上的方法调用的 mock

模拟类

命名你的 mock

追踪所有的调用

设置返回值和属性

通过 mock 引发异常

附带影响函数和可迭代对象

模拟异步迭代器

模拟异步上下文管理器

基于现有对象创建模拟对象

补丁装饰器

更多示例

模拟链式调用

部分模拟

模拟生成器方法

对每个测试方法应用相同的补丁

模拟未绑定方法

通过 mock 检查多次调用

处理可变参数

嵌套补丁

使用 MagicMock 模拟字典

模拟子类及其属性

通过 patch.dict 模拟导入

追踪调用顺序和不太冗长的调用断言

更复杂的参数匹配

2to3 --- 自动化的 Python 2 到 3 代码转写

使用 2to3

修复器

lib2to3 --- 2to3 的库

test --- Python 回归测试包

为 test 包编写单元测试

使用命令行界面运行测试

test.support --- 针对 Python 测试套件的工具

test.support.socket_helper --- 用于套接字测试的工具

test.support.script_helper --- 用于 Python 执行测试工具

test.support.bytecode_helper --- 用于测试正确字节码生成的支持工具

test.support.threading_helper --- 用于线程测试的工具

test.support.os_helper --- 用于操作系统测试的工具

test.support.import_helper --- 用于导入测试的工具

test.support.warnings_helper --- 用于警告测试的工具

typing —— 对类型提示的支持

3.5 新版功能.

源代码： Lib/typing.py [https://github.com/python/cpython/tree/3.10/Lib/typing.py]

注解

Python 运行时不强制要求函数与变量类型注解。它们可被类型检查器、IDE、错误检查器等第三方工具使用。

这个模块提供对类型提示的运行时支持。最基本的支持包括 Any , Union , Callable , TypeVar , 和 Generic 。关于完整的规范，请参考 PEP 484 [https://www.python.org/dev/peps/pep-0484] 。关于类型提示的简化介绍，请参考 PEP 483 [https://www.python.org/dev/peps/pep-0483] 。

下面的函数接收与返回的都是字符串，注解方式如下：

def greeting(name: str) -> str:
    return 'Hello ' + name

greeting 函数中，参数 name 的类型应是 str，返回类型是 str。子类型也可以作为参数。

新的功能频繁地被添加到 typing 模块中。typing_extensions [https://pypi.org/project/typing-extensions/] 包提供了这些新功能对旧版本 Python 的向后移植。

参见

For a quick overview of type hints, refer to this cheat sheet [https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html].

The "Type System Reference" section of https://mypy.readthedocs.io/ -- since the Python typing system is standardised via PEPs, this reference should broadly apply to most Python type checkers, although some parts may still be specific to mypy.

位于 https://typing.readthedocs.io/ 的文档提供有用的类型系统功能参考, 类型关系工具以及练习

相关的 PEP

自从在 PEP 484 [https://www.python.org/dev/peps/pep-0484] 和 PEP 483 [https://www.python.org/dev/peps/pep-0483] 中首次引入类型提示以来，一些 PEP 已经修改和增强了 Python 的类型注释框架。包括:

PEP 526 [https://www.python.org/dev/peps/pep-0526]: 变量注解的语法

引入 在函数定义之外标注变量的语法，以及 ClassVar 。

PEP 544 [https://www.python.org/dev/peps/pep-0544]: Protocol：结构子类型（静态鸭子类型）。

引入 Protocol 和 @runtime_checkable 装饰器。

PEP 585 [https://www.python.org/dev/peps/pep-0585]: 标准集合中的类型提示泛型

引入 types.GenericAlias 和使用标准库类作为 通用类型 的能力。

PEP 586 [https://www.python.org/dev/peps/pep-0586]: 文字类型

引入 Literal

PEP 589 [https://www.python.org/dev/peps/pep-0589]: TypedDict: 具有固定键集的字典的类型提示

引入 TypedDict

PEP 591 [https://www.python.org/dev/peps/pep-0591]: 为 typing 添加最终限定符

引入 Final 和 @final 装饰器

PEP 593 [https://www.python.org/dev/peps/pep-0593]: 灵活的函数和变量注解

引入 Annotated

PEP 604 [https://www.python.org/dev/peps/pep-0604]: 允许 X | Y 形式的联合类型写法

引入 types.UnionType 和使用二元或运算符 | 来表示 类型联合 的能力。

PEP 612 [https://www.python.org/dev/peps/pep-0612]: 形参规格变量

引入 ParamSpec 和 Concatenate

PEP 613 [https://www.python.org/dev/peps/pep-0613]: 显式类型别名

引入 TypeAlias

PEP 647 [https://www.python.org/dev/peps/pep-0647]: 用户自定义的类型保护器

引入 TypeGuard

类型别名

类型别名是通过为类型赋值为指定的别名来定义的。 在本例中，Vector 和 list[float] 将被视为可互换的同义词:

Vector = list[float]

def scale(scalar: float, vector: Vector) -> Vector:
    return [scalar * num for num in vector]

# passes type checking; a list of floats qualifies as a Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])

类型别名适用于简化复杂的类型签名。例如：

from collections.abc import Sequence

ConnectionOptions = dict[str, str]
Address = tuple[str, int]
Server = tuple[Address, ConnectionOptions]

def broadcast_message(message: str, servers: Sequence[Server]) -> None:
    ...

# The static type checker will treat the previous type signature as
# being exactly equivalent to this one.
def broadcast_message(
        message: str,
        servers: Sequence[tuple[tuple[str, int], dict[str, str]]]) -> None:
    ...

注意，None 能作为类型提示是一个特例，它会被自动替换为 type(None)。

NewType

用 NewType 助手创建与原类型不同的类型：

from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)

静态类型检查器把新类型当作原始类型的子类，这种方式适用于捕捉逻辑错误：

def get_user_name(user_id: UserId) -> str:
    ...

# passes type checking
user_a = get_user_name(UserId(42351))

# fails type checking; an int is not a UserId
user_b = get_user_name(-1)

UserId 类型的变量可执行所有 int 操作，但返回结果都是 int 类型。这种方式允许在预期 int 时传入 UserId，还能防止意外创建无效的 UserId：

# 'output' is of type 'int', not 'UserId'
output = UserId(23413) + UserId(54341)

注意，这些检查只由静态类型检查器强制执行。在运行时，语句 Derived = NewType('Derived', Base) 将产生一个 Derived 可调用对象，该对象立即返回你传递给它的任何参数。 这意味着语句 Derived(some_value) 不会创建一个新的类，也不会引入超出常规函数调用的很多开销。

更确切地说，在运行时，some_value is Derived(some_value) 表达式总为 True。

创建 Derived 的子类型是无效的:

from typing import NewType

UserId = NewType('UserId', int)

# Fails at runtime and does not pass type checking
class AdminUserId(UserId): pass

然而，我们可以在 "派生的" NewType 的基础上创建一个 NewType。

from typing import NewType

UserId = NewType('UserId', int)

ProUserId = NewType('ProUserId', UserId)

同时，ProUserId 的类型检查也可以按预期执行。

详见 PEP 484 [https://www.python.org/dev/peps/pep-0484]。

注解

请记住使用类型别名将声明两个类型是相互 等价 的。 使用 Alias = Original 将使静态类型检查器在任何情况下都把 Alias 视为与 Original 完全等价。 这在你想要简化复杂的类型签名时会很有用处。

反之，NewType 声明把一种类型当作另一种类型的 子类型。Derived = NewType('Derived', Original) 时，静态类型检查器把 Derived 当作 Original 的 子类 ，即，Original 类型的值不能用在预期 Derived 类型的位置。这种方式适用于以最小运行时成本防止逻辑错误。

3.5.2 新版功能.

在 3.10 版更改: NewType 现在是一个类而不是一个函数。 在调用 NewType 而不是普通的函数时，会有一些额外的运行时间成本。 然而，这种开销将在 3.11.0 中减少。

可调对象（Callable）

预期特定签名回调函数的框架可以用 Callable[[Arg1Type, Arg2Type], ReturnType] 实现类型提示。

例如：

from collections.abc import Callable

def feeder(get_next_item: Callable[[], str]) -> None:
    # Body

def async_query(on_success: Callable[[int], None],
                on_error: Callable[[int, Exception], None]) -> None:
    # Body

async def on_update(value: str) -> None:
    # Body
callback: Callable[[str], Awaitable[None]] = on_update

无需指定调用签名，用省略号字面量替换类型提示里的参数列表： Callable[..., ReturnType]，就可以声明可调对象的返回类型。

以其他可调用对象为参数的可调用对象可以使用 ParamSpec 来表明其参数类型是相互依赖的。 此外，如果该可调用对象增加或删除了其他可调用对象的参数，可以使用 Concatenate 操作符。 它们分别采取 Callable[ParamSpecVariable, ReturnType] 和 Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType] 的形式。

在 3.10 版更改: Callable 现在支持 ParamSpec 和 Concatenate。 详情见 PEP 612 [https://www.python.org/dev/peps/pep-0612]。

参见

ParamSpec 和 Concatenate 的文档提供了在 Callable 中使用的例子。

泛型（Generic）

容器中，对象的类型信息不能以泛型方式静态推断，因此，抽象基类扩展支持下标，用于表示容器元素的预期类型。

from collections.abc import Mapping, Sequence

def notify_by_email(employees: Sequence[Employee],
                    overrides: Mapping[str, str]) -> None: ...

要参数化泛型，可使用 typing 中的 TypeVar 工厂。

from collections.abc import Sequence
from typing import TypeVar

T = TypeVar('T')      # Declare type variable

def first(l: Sequence[T]) -> T:   # Generic function
    return l[0]

用户定义的泛型类型

用户定义的类可以定义为泛型类。

from typing import TypeVar, Generic
from logging import Logger

T = TypeVar('T')

class LoggedVar(Generic[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)

Generic[T] 是定义类 LoggedVar 的基类，该类使用单类型参数 T。在该类体内，T 是有效的类型。

The Generic base class defines __class_getitem__() so that LoggedVar[T] is valid as a type:

from collections.abc import Iterable

def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
    for var in vars:
        var.set(0)

一个泛型可以有任何数量的类型变量。所有种类的 TypeVar 都可以作为泛型的参数:

from typing import TypeVar, Generic, Sequence

T = TypeVar('T', contravariant=True)
B = TypeVar('B', bound=Sequence[bytes], covariant=True)
S = TypeVar('S', int, str)

class WeirdTrio(Generic[T, B, S]):
    ...

Generic 类型变量的参数应各不相同。下列代码就是无效的：

from typing import TypeVar, Generic
...

T = TypeVar('T')

class Pair(Generic[T, T]):   # INVALID
    ...

您可以通过 Generic 来使用多重继承：

from collections.abc import Sized
from typing import TypeVar, Generic

T = TypeVar('T')

class LinkedList(Sized, Generic[T]):
    ...

继承自泛型类时，可以修正某些类型变量：

from collections.abc import Mapping
from typing import TypeVar

T = TypeVar('T')

class MyDict(Mapping[str, T]):
    ...

在这个例子中，MyDict 就只有一个参数 T。

未指定泛型类的类型参数时，每个位置的类型都预设为 Any。下例中，MyIterable 不是泛型，但却隐式继承了 Iterable[Any]：

from collections.abc import Iterable

class MyIterable(Iterable): # Same as Iterable[Any]

还支持用户定义的泛型类型别名。例如：

from collections.abc import Iterable
from typing import TypeVar
S = TypeVar('S')
Response = Iterable[S] | int

# Return type here is same as Iterable[str] | int
def response(query: str) -> Response[str]:
    ...

T = TypeVar('T', int, float, complex)
Vec = Iterable[tuple[T, T]]

def inproduct(v: Vec[T]) -> T: # Same as Iterable[tuple[T, T]]
    return sum(x*y for x, y in v)

在 3.7 版更改: Generic 不再支持自定义元类。

用户定义的参数表达式的泛型也通过 Generic[P] 形式的参数规范变量来支持。该行为与上面描述的类型变量一致，因为参数规范变量被类型化模块视为一个专门的类型变量。 这方面的一个例外是，一个类型列表可以用来替代 ParamSpec:

>>> from typing import Generic, ParamSpec, TypeVar

>>> T = TypeVar('T')
>>> P = ParamSpec('P')

>>> class Z(Generic[T, P]): ...
...
>>> Z[int, [dict, float]]
__main__.Z[int, (<class 'dict'>, <class 'float'>)]

此外，一个只有一个参数规范变量的泛型将接受表格 X[[Type1, Type2, ...]] 中的参数列表，出于美观的考虑也包括 X[Type1, Type2, ...] 。 在内部，后者被转换为前者，所以下面的内容是等价的:

>>> class X(Generic[P]): ...
...
>>> X[int, str]
__main__.X[(<class 'int'>, <class 'str'>)]
>>> X[[int, str]]
__main__.X[(<class 'int'>, <class 'str'>)]

请注意，带有 ParamSpec 的泛型在某些情况下可能不会有正确的``__parameters__``，因为它们主要用于静态类型检查。

在 3.10 版更改: Generic 现在可以通过参数表达式进行参数化。参见 ParamSpec 和 PEP 612 [https://www.python.org/dev/peps/pep-0612] 以了解更多细节。

用户定义的泛型类可以将 ABC 作为基类而不会导致元类冲突。 参数化泛型的输出结果会被缓存，且 typing 模块中的大多数类型都是 hashable 并且支持相等性比较。

Any 类型

Any 是一种特殊的类型。静态类型检查器认为所有类型均与 Any 兼容，同样，Any 也与所有类型兼容。

也就是说，可对 Any 类型的值执行任何操作或方法调用，并赋值给任意变量：

from typing import Any

a: Any = None
a = []          # OK
a = 2           # OK

s: str = ''
s = a           # OK

def foo(item: Any) -> int:
    # Passes type checking; 'item' could be any type,
    # and that type might have a 'bar' method
    item.bar()
    ...

注意，Any 类型的值赋给更精确的类型时，不执行类型检查。例如，把 a 赋给 s，在运行时，即便 s 已声明为 str 类型，但接收 int 值时，静态类型检查器也不会报错。

此外，未指定返回值与参数类型的函数，都隐式地默认使用 Any：

def legacy_parser(text):
    ...
    return data

# A static type checker will treat the above
# as having the same signature as:
def legacy_parser(text: Any) -> Any:
    ...
    return data

需要混用动态与静态类型代码时，此操作把 Any 当作 应急出口。

Any 和 object 的区别。与 Any 相似，所有类型都是 object 的子类型。然而，与 Any 不同，object 不可逆：object 不是 其它类型的子类型。

就是说，值的类型是 object 时，类型检查器几乎会拒绝所有对它的操作，并且，把它赋给更精确的类型变量（或返回值）属于类型错误。例如：

def hash_a(item: object) -> int:
    # Fails type checking; an object does not have a 'magic' method.
    item.magic()
    ...

def hash_b(item: Any) -> int:
    # Passes type checking
    item.magic()
    ...

# Passes type checking, since ints and strs are subclasses of object
hash_a(42)
hash_a("foo")

# Passes type checking, since Any is compatible with all types
hash_b(42)
hash_b("foo")

使用 object，说明值能以类型安全的方式转为任何类型。使用 Any，说明值是动态类型。

名义子类型 vs 结构子类型

最初 PEP 484 [https://www.python.org/dev/peps/pep-0484] 将 Python 静态类型系统定义为使用 名义子类型。这意味着当且仅当类 A 是 B 的子类时，才满足有类 B 预期时使用类 A 。

此项要求以前也适用于抽象基类，例如，Iterable 。这种方式的问题在于，定义类时必须显式说明，既不 Pythonic，也不是动态类型式 Python 代码的惯用写法。例如，下列代码就遵从了 PEP 484 [https://www.python.org/dev/peps/pep-0484] 的规范：

from collections.abc import Sized, Iterable, Iterator

class Bucket(Sized, Iterable[int]):
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

PEP 544 [https://www.python.org/dev/peps/pep-0544] 允许用户在类定义时不显式说明基类，从而解决了这一问题，静态类型检查器隐式认为 Bucket 既是 Sized 的子类型，又是 Iterable[int] 的子类型。这就是 结构子类型 （又称为静态鸭子类型）：

from collections.abc import Iterator, Iterable

class Bucket:  # Note: no base classes
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

def collect(items: Iterable[int]) -> int: ...
result = collect(Bucket())  # Passes type check

此外，结构子类型的优势在于，通过继承特殊类 Protocol ，用户可以定义新的自定义协议（见下文中的例子）。

模块内容

本模块定义了下列类、函数和修饰器。

注解

本模块定义了一些类型，作为标准库中已有的类的子类，从而可以让 Generic 支持 [] 中的类型变量。Python 3.9 中，这些标准库的类已支持 [] ，因此，这些类型就变得冗余了。

Python 3.9 弃用了这些冗余类型，但解释器并未提供相应的弃用警告。标记弃用类型的工作留待支持 Python 3.9 及以上版本的类型检查器实现。

Python 3.9.0 发布五年后的首个 Python 发行版将从 typing 模块中移除这些弃用类型。详见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 《标准集合的类型提示泛型》。

特殊类型原语

特殊类型

这些类型可用于类型注解，但不支持 []。

typing.Any

特殊类型，表示没有约束的类型。

所有类型都与 Any 兼容。

Any 与所有类型都兼容。

typing.NoReturn

标记没有返回值的函数的特殊类型。例如：

from typing import NoReturn

def stop() -> NoReturn:
    raise RuntimeError('no way')

3.5.4 新版功能.

3.6.2 新版功能.

typing.TypeAlias

用于显式声明 类型别名 的特殊标注。 例如:

from typing import TypeAlias

Factors: TypeAlias = list[int]

关于显式类型别名的更多细节，请参见 PEP 613 [https://www.python.org/dev/peps/pep-0613]。

3.10 新版功能.

特殊形式

可用于类型注解，且支持 [] ，每种形式都有其独特的句法。

typing.Tuple

元组类型； Tuple[X, Y] 是二项元组类型，第一个元素的类型是 X，第二个元素的类型是 Y。空元组的类型可写为 Tuple[()]。

例：Tuple[T1, T2] 是二项元组，类型变量分别为 T1 和 T2。Tuple[int, float, str] 是由整数、浮点数、字符串组成的三项元组。

可用省略号字面量指定同质变长元组，例如，Tuple[int, ...] 。Tuple 与 Tuple[Any, ...] 等价，也与 tuple 等价。

3.9 版后已移除: builtins.tuple 现在支持下标操作（[]）。参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

typing.Union

联合类型； Union[X, Y] 等价于 X | Y ，意味着满足 X 或 Y 之一。

要定义一个联合类型，可以使用类似 Union[int, str] 或简写 int | str。建议使用这种简写。细节:

参数必须是某种类型，且至少有一个。

联合类型之联合类型会被展平，例如：

Union[Union[int, str], float] == Union[int, str, float]

单参数之联合类型就是该参数自身，例如：

Union[int] == int  # The constructor actually returns int

冗余的参数会被跳过，例如：

Union[int, str, int] == Union[int, str] == int | str

比较联合类型，不涉及参数顺序，例如：

Union[int, str] == Union[str, int]

不可创建 Union 的子类或实例。

没有 Union[X][Y] 这种写法。

在 3.7 版更改: 在运行时，不要移除联合类型中的显式子类。

在 3.10 版更改: 联合类型现在可以写成 X | Y。 参见 联合类型表达式。

typing.Optional

可选类型。

Optional[X] 等价于 X | None （或 Union[X, None] ） 。

注意，可选类型与含默认值的可选参数不同。含默认值的可选参数不需要在类型注解上添加 Optional 限定符，因为它仅是可选的。例如：

def foo(arg: int = 0) -> None:
    ...

另一方面，显式应用 None 值时，不管该参数是否可选， Optional 都适用。例如：

def foo(arg: Optional[int] = None) -> None:
    ...

在 3.10 版更改: 可选参数现在可以写成 X | None。 参见 联合类型表达式。

typing.Callable

可调类型； Callable[[int], str] 是把（int）转为 str 的函数。

下标句法必须与参数列表和返回类型这两个值一起使用。参数列表只能是类型列表或省略号；返回类型只能是单一类型。

没有说明可选参数或关键字参数的句法；这类函数类型很少用作回调类型。Callable[..., ReturnType] （省略号字面量）可用于为接受任意数量参数，并返回 ReturnType 的可调对象提供类型提示。纯 Callable 等价于 Callable[..., Any]，进而等价于 collections.abc.Callable 。

以其他可调用对象为参数的可调用对象可以使用 ParamSpec 来表明其参数类型是相互依赖的。 此外，如果该可调用对象增加或删除了其他可调用对象的参数，可以使用 Concatenate 操作符。 它们分别采取 Callable[ParamSpecVariable, ReturnType] 和 Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType] 的形式。

3.9 版后已移除: collections.abc.Callable 现在支持下标操作（[]）。参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

在 3.10 版更改: Callable 现在支持 ParamSpec 和 Concatenate。 详情见 PEP 612 [https://www.python.org/dev/peps/pep-0612]。

参见

ParamSpec 和 Concatenate 的文档提供了使用 Callable 的例子。

typing.Concatenate

与 Callable 和 ParamSpec 一起使用，对一个高阶可调用对象进行类型注释，该对象可以增加、删除或转换另一个可调用对象的参数。 使用形式为``Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]``。 Concatenate 目前只在作为 Callable 的第一个参数时有效。Concatenate 的最后一个参数必须是一个 ParamSpec。

例如，为了注释一个装饰器 with_lock，它为被装饰的函数提供了 threading.Lock，Concatenate 可以用来表示 with_lock 期望一个可调用对象，该对象接收一个 Lock 作为第一个参数，并返回一个具有不同类型签名的可调用对象。 在这种情况下，ParamSpec 表示返回的可调用对象的参数类型取决于被传入的可调用程序的参数类型:

from collections.abc import Callable
from threading import Lock
from typing import Concatenate, ParamSpec, TypeVar

P = ParamSpec('P')
R = TypeVar('R')

# Use this lock to ensure that only one thread is executing a function
# at any time.
my_lock = Lock()

def with_lock(f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
    '''A type-safe decorator which provides a lock.'''
    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
        # Provide the lock as the first argument.
        return f(my_lock, *args, **kwargs)
    return inner

@with_lock
def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
    '''Add a list of numbers together in a thread-safe manner.'''
    with lock:
        return sum(numbers)

# We don't need to pass in the lock ourselves thanks to the decorator.
sum_threadsafe([1.1, 2.2, 3.3])

3.10 新版功能.

参见

PEP 612 [https://www.python.org/dev/peps/pep-0612] -- 参数规范变量（引入 ParamSpec 和 Concatenate 的 PEP）。

ParamSpec 和 Callable。

class typing.Type(Generic[CT_co])

用 C 注解的变量可以接受类型 C 的值。反之，用 Type[C] 注解的变量可以接受类自身的值 — 准确地说，是接受 C 的 类对象，例如：

a = 3         # Has type 'int'
b = int       # Has type 'Type[int]'
c = type(a)   # Also has type 'Type[int]'

注意，Type[C] 为协变量：

class User: ...
class BasicUser(User): ...
class ProUser(User): ...
class TeamUser(User): ...

# Accepts User, BasicUser, ProUser, TeamUser, ...
def make_new_user(user_class: Type[User]) -> User:
    # ...
    return user_class()

Type[C] 为协变量的意思是指， C 的所有子类都应使用与 C 相同的构造器签名及类方法签名。类型检查器应标记违反此项规定的内容，但也应允许符合指定基类构造器调用的子类进行构造器调用。PEP 484 [https://www.python.org/dev/peps/pep-0484] 修订版将来可能会调整类型检查器对这种特例的处理方式。

 Type 合法的参数仅有类、Any 、类型变量 以及上述类型的联合类型。例如：

def new_non_team_user(user_class: Type[BasicUser | ProUser]): ...

 Type[Any] 等价于 Type，进而等价于 Python 元类架构的根基，type。

3.5.2 新版功能.

3.9 版后已移除: builtins.type 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

typing.Literal

表示类型检查器对应变量或函数参数的值等价于给定字面量（或多个字面量之一）的类型。例如：

def validate_simple(data: Any) -> Literal[True]:  # always returns True
    ...

MODE = Literal['r', 'rb', 'w', 'wb']
def open_helper(file: str, mode: MODE) -> str:
    ...

open_helper('/some/path', 'r')  # Passes type check
open_helper('/other/path', 'typo')  # Error in type checker

Literal[...] 不能创建子类。在运行时，任意值均可作为 Literal[...] 的类型参数，但类型检查器可以对此加以限制。字面量类型详见 PEP 586 [https://www.python.org/dev/peps/pep-0586] 。

3.8 新版功能.

在 3.9.1 版更改: Literal 现在能去除形参的重复。 Literal 对象的相等性比较不再依赖顺序。 现在如果有某个参数不为 hashable，Literal 对象在相等性比较期间将引发 TypeError。

typing.ClassVar

特殊类型注解构造，用于标注类变量。

如 PEP 526 [https://www.python.org/dev/peps/pep-0526] 所述，打包在 ClassVar 内的变量注解是指，给定属性应当用作类变量，而不应设置在类实例上。用法如下：

class Starship:
    stats: ClassVar[dict[str, int]] = {} # class variable
    damage: int = 10                     # instance variable

ClassVar 仅接受类型，也不能使用下标。

ClassVar 本身不是类，不应用于 isinstance() 或 issubclass()。ClassVar 不改变 Python 运行时行为，但可以用于第三方类型检查器。例如，类型检查器会认为以下代码有错：

enterprise_d = Starship(3000)
enterprise_d.stats = {} # Error, setting class variable on instance
Starship.stats = {}     # This is OK

3.5.3 新版功能.

typing.Final

告知类型检查器某名称不能再次赋值或在子类中重写的特殊类型构造器。例如：

MAX_SIZE: Final = 9000
MAX_SIZE += 1  # Error reported by type checker

class Connection:
    TIMEOUT: Final[int] = 10

class FastConnector(Connection):
    TIMEOUT = 1  # Error reported by type checker

这些属性没有运行时检查。详见 PEP 591 [https://www.python.org/dev/peps/pep-0591]。

3.8 新版功能.

typing.Annotated

PEP 593 [https://www.python.org/dev/peps/pep-0593] （灵活函数和变量注解）里引入的类型，可以用上下文特定元数据（Annotated 的参数可变，也可能用它的多个组成部分）装饰现有的类型。具体来说，就是类型提示 Annotated[T, x] 用元数据 x 注解类型 T。静态分析或运行时都能使用该元数据。库（或工具）处理类型提示 Annotated[T, x] 时，在元数据 x 不涉及特殊逻辑的情况下，可忽略该类型提示，仅把它当作类型 T。与 typing 模块中现有的 no_type_check 功能不同，该功能完全禁用了函数或类的类型检查注解，而 Annotated 类型则允许对 T 进行静态类型检查（可安全地忽略 x），也可以在特定应用程序中实现 x 的运行时访问。

毕竟，如何解释注解（如有）由处理 Annotated 类型的工具/库负责。工具/库处理 Annotated 类型时，扫描所有注解以确定是否需要进行处理（例如，使用 isinstance()）。

工具/库不支持注解，或遇到未知注解时，应忽略注解，并把注解类型当作底层类型。

是否允许客户端在一个类型上使用多个注解，以及如何合并这些注解，由处理注解的工具决定。

Annotated 类型支持把多个相同（或不同）的单个（或多个）类型注解置于任意节点。因此，使用这些注解的工具/库要负责处理潜在的重复项。例如，执行值范围分析时，应允许以下操作：

T1 = Annotated[int, ValueRange(-10, 5)]
T2 = Annotated[T1, ValueRange(-20, 3)]

传递 include_extras=True 至 get_type_hints() ，即可在运行时访问额外的注解。

语义详情：

Annotated 的第一个参数必须是有效的类型。

支持多个类型标注（Annotated 支持可变参数）：

Annotated[int, ValueRange(3, 10), ctype("char")]

调用 Annotated 至少要有两个参数（Annotated[int] 是无效的）

注解的顺序会被保留，且影响等价检查：

Annotated[int, ValueRange(3, 10), ctype("char")] != Annotated[
    int, ctype("char"), ValueRange(3, 10)
]

嵌套 Annotated 类型会被展平，元数据从最内层注解依序展开：

Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[
    int, ValueRange(3, 10), ctype("char")
]

不移除注解重复项：

Annotated[int, ValueRange(3, 10)] != Annotated[
    int, ValueRange(3, 10), ValueRange(3, 10)
]

Annotated 可用于嵌套或泛型别名：

T = TypeVar('T')
Vec = Annotated[list[tuple[T, T]], MaxLen(10)]
V = Vec[int]

V == Annotated[list[tuple[int, int]], MaxLen(10)]

3.9 新版功能.

typing.TypeGuard

用于注释用户定义的类型保护函数的返回类型的特殊类型化形式。 TypeGuard 只接受一个单一的类型参数。 在运行时，以这种方式标记的函数应该返回一个布尔值。

TypeGuard 旨在使 类型收窄 受益——这是静态类型检查器用以确定表达式在代码流中的较精确类型的一种技术。通常，类型收窄是以分析条件代码流并将收窄应用于一个代码块来完成的，涉及到的条件表达式有时即被称为“type guard”。

def is_str(val: str | float):
    # "isinstance" type guard
    if isinstance(val, str):
        # Type of ``val`` is narrowed to ``str``
        ...
    else:
        # Else, type of ``val`` is narrowed to ``float``.
        ...

定义一个布尔函数作为 type guard 有时会很方便，此时应使用 TypeGuard[...] 作为其返回类型以提醒静态类型检查器注意这一意图。

-> TypeGuard 告诉静态类型检查器，某函数：

返回一个布尔值。

如果返回值是 True，那么其参数的类型是 TypeGuard 内的类型。

例如：

def is_str_list(val: List[object]) -> TypeGuard[List[str]]:
    '''Determines whether all objects in the list are strings'''
    return all(isinstance(x, str) for x in val)

def func1(val: List[object]):
    if is_str_list(val):
        # Type of ``val`` is narrowed to ``List[str]``.
        print(" ".join(val))
    else:
        # Type of ``val`` remains as ``List[object]``.
        print("Not a list of strings!")

如果 is_str_list 是一个类或实例方法，那么 TypeGuard 中的类型映射到 cls 或 self 之后的第二个参数的类型。

简而言之，def foo(arg: TypeA) -> TypeGuard[TypeB]: ... 形式的意思是：如果 foo(arg) 返回 True，那么 arg 将把 TypeA 缩小为 TypeB。

注解

TypeB 不必是 TypeA 的缩小形式，它甚至可以是扩大形式。 主要原因是允许像把 List[object] 缩小到 List[str] 这样的事情，即使后者不是前者的一个子类型，因为 List 是不变的。 编写类型安全的类型防护的责任留给了用户。

TypeGuard 也适用于类型变量。 详情参见 PEP 647 [https://www.python.org/dev/peps/pep-0647]。

3.10 新版功能.

构建泛型类型

以下内容是创建泛型类型的基石，但不在注解内使用。

class typing.Generic

用于泛型类型的抽象基类。

泛型类型一般通过继承含一个或多个类型变量的类实例进行声明。例如，泛型映射类型定义如下：

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
        # Etc.

该类的用法如下：

X = TypeVar('X')
Y = TypeVar('Y')

def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y:
    try:
        return mapping[key]
    except KeyError:
        return default

class typing.TypeVar

类型变量。

用法：

T = TypeVar('T')  # Can be anything
S = TypeVar('S', bound=str)  # Can be any subtype of str
A = TypeVar('A', str, bytes)  # Must be exactly str or bytes

类型变量主要是为静态类型检查器提供支持，用于泛型类型与泛型函数定义的参数。有关泛型类型，详见 Generic。泛型函数的写法如下：

def repeat(x: T, n: int) -> Sequence[T]:
    """Return a list containing n references to x."""
    return [x]*n

def print_capitalized(x: S) -> S:
    """Print x capitalized, and return x."""
    print(x.capitalize())
    return x

def concatenate(x: A, y: A) -> A:
    """Add two strings or bytes objects together."""
    return x + y

请注意，类型变量可以是 被绑定的 ， 被约束的 ，或者两者都不是，但不能既是被绑定的 又是 被约束的。

约束类型变量和绑定类型变量在几个重要方面具有不同的语义。使用 约束 类型变量意味着它只能被解析为正好是所给的约束之一:

a = concatenate('one', 'two')  # Ok, variable 'a' has type 'str'
b = concatenate(StringSubclass('one'), StringSubclass('two'))  # Inferred type of variable 'b' is 'str',
                                                               # despite 'StringSubclass' being passed in
c = concatenate('one', b'two')  # error: type variable 'A' can be either 'str' or 'bytes' in a function call, but not both

然而，使用一个 绑定 类型变量，意味着将使用最具体的类型来解析 TypeVar

print_capitalized('a string')  # Ok, output has type 'str'

class StringSubclass(str):
    pass

print_capitalized(StringSubclass('another string'))  # Ok, output has type 'StringSubclass'
print_capitalized(45)  # error: int is not a subtype of str

类型变量可以被绑定到具体类型、抽象类型（ ABC 或 protocol ），甚至是类型的联合:

U = TypeVar('U', bound=str|bytes)  # Can be any subtype of the union str|bytes
V = TypeVar('V', bound=SupportsAbs)  # Can be anything with an __abs__ method

Bound type variables are particularly useful for annotating classmethods that serve as alternative constructors. In the following example (by Raymond Hettinger [https://www.youtube.com/watch?v=HTLu2DFOdTg]), the type variable C is bound to the Circle class through the use of a forward reference. Using this type variable to annotate the with_circumference classmethod, rather than hardcoding the return type as Circle, means that a type checker can correctly infer the return type even if the method is called on a subclass:

import math

C = TypeVar('C', bound='Circle')

class Circle:
    """An abstract circle"""

    def __init__(self, radius: float) -> None:
        self.radius = radius

    # Use a type variable to show that the return type
    # will always be an instance of whatever ``cls`` is
    @classmethod
    def with_circumference(cls: type[C], circumference: float) -> C:
        """Create a circle with the specified circumference"""
        radius = circumference / (math.pi * 2)
        return cls(radius)

class Tire(Circle):
    """A specialised circle (made out of rubber)"""

    MATERIAL = 'rubber'

c = Circle.with_circumference(3)  # Ok, variable 'c' has type 'Circle'
t = Tire.with_circumference(4)  # Ok, variable 't' has type 'Tire' (not 'Circle')

在运行时，isinstance(x, T) 会触发 TypeError 异常。一般而言，isinstance() 和 issubclass() 不应与类型搭配使用。

类型变量可以通过传递 covariant=True 或 contravariant=True 来标记协变或逆变。 更多细节请参见 PEP 484 [https://www.python.org/dev/peps/pep-0484] 。 默认情况下，类型变量是不变的。

class typing.ParamSpec(name, *, bound=None, covariant=False, contravariant=False)

参数规范变量。 类型变量 的一个专门版本。

用法：

P = ParamSpec('P')

参数规范变量的存在主要是为了使静态类型检查器受益。 它们被用来将一个可调用对象的参数类型转发给另一个可调用对象的参数类型——这种模式通常出现在高阶函数和装饰器中。 它们只有在 Concatenate 中使用时才有效，或者作为 Callable 的第一个参数，或者作为用户定义的泛型的参数。 参见 Generic 以了解更多关于泛型的信息。

例如，为了给一个函数添加基本的日志记录，我们可以创建一个装饰器 add_logging 来记录函数调用。 参数规范变量告诉类型检查器，传入装饰器的可调用对象和由其返回的新可调用对象有相互依赖的类型参数:

from collections.abc import Callable
from typing import TypeVar, ParamSpec
import logging

T = TypeVar('T')
P = ParamSpec('P')

def add_logging(f: Callable[P, T]) -> Callable[P, T]:
    '''A type-safe decorator to add logging to a function.'''
    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:
    '''Add two numbers together.'''
    return x + y

如果没有 ParamSpec，以前注释这个的最简单的方法是使用一个 TypeVar 与绑定 Callable[..., Any]。

类型检查器不能对 inner 函数进行类型检查，因为 *args 和 **kwargs 的类型必须是 Any。

cast() 在返回 inner 函数时，可能需要在 add_logging 装饰器的主体中进行，或者必须告诉静态类型检查器忽略 return inner。

args

kwargs

由于 ParamSpec 同时捕获了位置参数和关键字参数，P.args 和 P.kwargs 可以用来将 ParamSpec 分割成其组成部分。 P.args 代表给定调用中的位置参数的元组，只能用于注释 *args。 P.kwargs 代表给定调用中的关键字参数到其值的映射，只能用于注释 **kwargs。在运行时，P.args 和 P.kwargs 分别是 ParamSpecArgs 和 ParamSpecKwargs 的实例。

用 covariant=True 或 contravariant=True 创建的参数规范变量可以用来声明协变或逆变泛型类型。 参数 bound 也被接受，类似于 TypeVar。 然而这些关键字的实际语义还有待决定。

3.10 新版功能.

注解

只有在全局范围内定义的参数规范变量可以被 pickle。

参见

PEP 612 [https://www.python.org/dev/peps/pep-0612] -- 参数规范变量（引入 ParamSpec 和 Concatenate 的 PEP）。

Callable 和 Concatenate。

typing.ParamSpecArgs

typing.ParamSpecKwargs

ParamSpec`的参数和关键字参数属性。``ParamSpec` 的 P.args 属性是 ParamSpecArgs 的一个实例，P.kwargs 是 ParamSpecKwargs 的一个实例。 它们的目的是用于运行时内部检查的，对静态类型检查器没有特殊意义。

在这些对象中的任何一个上调用 get_origin()，都会返回原始的 ParamSpec:

P = ParamSpec("P")
get_origin(P.args)  # returns P
get_origin(P.kwargs)  # returns P

3.10 新版功能.

typing.AnyStr

AnyStr 定义为 AnyStr = TypeVar('AnyStr', str, bytes) 的 约束类型变量 。

这里指的是，它可以接受任意同类字符串，但不支持混用不同类别的字符串。例如：

def concat(a: AnyStr, b: AnyStr) -> AnyStr:
    return a + b

concat(u"foo", u"bar")  # Ok, output has type 'unicode'
concat(b"foo", b"bar")  # Ok, output has type 'bytes'
concat(u"foo", b"bar")  # Error, cannot mix unicode and bytes

class typing.Protocol(Generic)

Protocol 类的基类。Protocol 类的定义如下：

class Proto(Protocol):
    def meth(self) -> int:
        ...

这些类主要与静态类型检查器搭配使用，用来识别结构子类型（静态鸭子类型），例如：

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

请参阅 PEP 544 [https://www.python.org/dev/peps/pep-0544] 了解详情。 使用 runtime_checkable() 装饰的协议类（稍后将介绍）可作为只检查给定属性是否存在，而忽略其类型签名的简单的运行时协议。

Protocol 类可以是泛型，例如：

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...

3.8 新版功能.

@typing.runtime_checkable

用于把 Protocol 类标记为运行时协议。

该协议可以与 isinstance() 和 issubclass() 一起使用。应用于非协议的类时，会触发 TypeError。该指令支持简易结构检查，与 collections.abc 的 Iterable 非常类似，只擅长做一件事。 例如：

@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)

注解

runtime_checkable() will check only the presence of the required methods or attributes, not their type signatures or types. For example, ssl.SSLObject is a class, therefore it passes an issubclass() check against Callable. However, the ssl.SSLObject.__init__ method exists only to raise a TypeError with a more informative message, therefore making it impossible to call (instantiate) ssl.SSLObject.

注解

针对运行时可检查协议的 isinstance() 检查相比针对非协议类的 isinstance() 检查可能会惊人的缓慢。 请考虑在性能敏感的代码中使用替代性写法如 hasattr() 调用进行结构检查。

3.8 新版功能.

其他特殊指令

这些特殊指令是声明类型的基石，但不在注解内使用。

class typing.NamedTuple

collections.namedtuple() 的类型版本。

用法：

class Employee(NamedTuple):
    name: str
    id: int

这相当于：

Employee = collections.namedtuple('Employee', ['name', 'id'])

为字段提供默认值，要在类体内赋值：

class Employee(NamedTuple):
    name: str
    id: int = 3

employee = Employee('Guido')
assert employee.id == 3

带默认值的字段必须在不带默认值的字段后面。

由此产生的类有一个额外的属性 __annotations__ ，给出一个 dict ，将字段名映射到字段类型。（字段名在 _fields 属性中，默认值在 _field_defaults 属性中，这两者都是 namedtuple() API 的一部分。）

NamedTuple 子类也支持文档字符串与方法：

class Employee(NamedTuple):
    """Represents an employee."""
    name: str
    id: int = 3

    def __repr__(self) -> str:
        return f'<Employee {self.name}, id={self.id}>'

反向兼容用法：

Employee = NamedTuple('Employee', [('name', str), ('id', int)])

在 3.6 版更改: 添加了对 PEP 526 [https://www.python.org/dev/peps/pep-0526] 中变量注解句法的支持。

在 3.6.1 版更改: 添加了对默认值、方法、文档字符串的支持。

在 3.8 版更改: _field_types 和 __annotations__ 属性现已使用常规字典，不再使用 OrderedDict 实例。

在 3.9 版更改: 移除了 _field_types 属性， 改用具有相同信息，但更标准的 __annotations__ 属性。

class typing.NewType(name, tp)

一个辅助类，用于向类型检查器指示一个不同的类型，见 NewType。在运行时，它返回一个对象，在调用时返回其参数。用法:

UserId = NewType('UserId', int)
first_user = UserId(1)

3.5.2 新版功能.

在 3.10 版更改: NewType 现在是一个类而不是函数。

class typing.TypedDict(dict)

把类型提示添加至字典的特殊构造器。在运行时，它是纯 dict。

TypedDict 声明一个字典类型，该类型预期所有实例都具有一组键集，其中，每个键都与对应类型的值关联。运行时不检查此预期，而是由类型检查器强制执行。用法如下：

class Point2D(TypedDict):
    x: int
    y: int
    label: str

a: Point2D = {'x': 1, 'y': 2, 'label': 'good'}  # OK
b: Point2D = {'z': 3, 'label': 'bad'}           # Fails type check

assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')

为了允许在不支持 PEP 526 [https://www.python.org/dev/peps/pep-0526] 的旧版本的 Python 中使用这个特性， TypedDict 支持另外两种等价的语法形式:

Point2D = TypedDict('Point2D', x=int, y=int, label=str)
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})

当任何一个键不是有效的 标识符 时，例如因为它们是关键字或包含连字符，也应该使用函数式语法。例子:

# raises SyntaxError
class Point2D(TypedDict):
    in: int  # 'in' is a keyword
    x-y: int  # name with hyphens

# OK, functional syntax
Point2D = TypedDict('Point2D', {'in': int, 'x-y': int})

默认情况下，所有的键都必须出现在一个 TypedDict 中。 可以通过指定总数来重写这一点。用法:

class Point2D(TypedDict, total=False):
    x: int
    y: int

这意味着一个 Point2D TypedDict 可以省略任何一个键。 类型检查器只需要支持一个字面的 False 或 True 作为 total 参数的值。 True 是默认的，它使类主体中定义的所有项目都是必需的。

一个 TypedDict 类型有可能使用基于类的语法从一个或多个其他 TypedDict 类型继承。用法:

class Point3D(Point2D):
    z: int

Point3D 有三个项目 : x , y 和 z 。 其等价于定义:

class Point3D(TypedDict):
    x: int
    y: int
    z: int

TypedDict 不能继承于一个非 TypedDict 类，其中特别包括 Generic 。例如：

class X(TypedDict):
    x: int

class Y(TypedDict):
    y: int

class Z(object): pass  # A non-TypedDict class

class XY(X, Y): pass  # OK

class XZ(X, Z): pass  # raises TypeError

T = TypeVar('T')
class XT(X, Generic[T]): pass  # raises TypeError

TypedDict 可以通过注解字典（参见 注解最佳实践 了解更多关于注解的最佳实践）、 __total__ 、 __required_keys__ 和 __optional_keys__ 进行内省。

__total__

Point2D.__total__ gives the value of the total argument. 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

__required_keys__

3.9 新版功能.

__optional_keys__

Point2D.__required_keys__ 和 Point2D.__optional_keys__ 分别返回 frozenset 对象，其中包含必需和非必需键。目前，在同一个 中声明必需和非必需键的唯一方法是混合继承，用一个 total 参数值声明一个 TypedDict ，然后从另一个 total 参数值不同的 TypedDict 中继承它。用法：

>>> 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

3.9 新版功能.

更多示例与 TypedDict 的详细规则，详见 PEP 589 [https://www.python.org/dev/peps/pep-0589]。

3.8 新版功能.

泛型具象容器

对应的内置类型

class typing.Dict(dict, MutableMapping[KT, VT])

dict 的泛型版本。适用于注解返回类型。注解参数时，最好使用 Mapping 等抽象容器类型。

该类型用法如下：

def count_words(text: str) -> Dict[str, int]:
    ...

3.9 版后已移除: builtins.dict 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.List(list, MutableSequence[T])

list 的泛型版本。适用于注解返回类型。注解参数时，最好使用 Sequence 或 Iterable 等抽象容器类型。

该类型用法如下：

T = TypeVar('T', int, float)

def vec2(x: T, y: T) -> List[T]:
    return [x, y]

def keep_positives(vector: Sequence[T]) -> List[T]:
    return [item for item in vector if item > 0]

3.9 版后已移除: builtins.list 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Set(set, MutableSet[T])

builtins.set 的泛型版本。适用于注解返回类型。注解参数时，最好使用 AbstractSet 等抽象容器类型。

3.9 版后已移除: builtins.set 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.FrozenSet(frozenset, AbstractSet[T_co])

builtins.frozenset 的泛型版本。

3.9 版后已移除: builtins.frozenset 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

注解

Tuple 是一种特殊形式。

collections 对应类型

class typing.DefaultDict(collections.defaultdict, MutableMapping[KT, VT])

collections.defaultdict 的泛型版本。

3.5.2 新版功能.

3.9 版后已移除: collections.defaultdict 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])

collections.OrderedDict 的泛型版本。

3.7.2 新版功能.

3.9 版后已移除: collections.OrderedDict 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.ChainMap(collections.ChainMap, MutableMapping[KT, VT])

collections.ChainMap 的泛型版本。

3.5.4 新版功能.

3.6.1 新版功能.

3.9 版后已移除: collections.ChainMap 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Counter(collections.Counter, Dict[T, int])

collections.Counter 的泛型版本。

3.5.4 新版功能.

3.6.1 新版功能.

3.9 版后已移除: collections.Counter 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Deque(deque, MutableSequence[T])

collections.deque 的泛型版本。

3.5.4 新版功能.

3.6.1 新版功能.

3.9 版后已移除: collections.deque 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

其他具象类型

class typing.IO

class typing.TextIO

class typing.BinaryIO

泛型 IO[AnyStr] 及其子类 TextIO(IO[str])、BinaryIO(IO[bytes]) 表示 I/O 流——例如 open() 返回的对象——的类型。

Deprecated since version 3.8, will be removed in version 3.13: typing.io 命名空间被弃用并将被删除。 这些类型应该被直接从 typing 导入。

class typing.Pattern

class typing.Match

这些类型对应的是从 re.compile() 和 re.match() 返回的类型。 这些类型（及相应的函数）是 AnyStr 中的泛型并可通过编写 Pattern[str], Pattern[bytes], Match[str] 或 Match[bytes] 来具体指定。

Deprecated since version 3.8, will be removed in version 3.13: typing.re 命名空间被弃用并将被删除。 这些类型应该被直接从 typing 导入。

3.9 版后已移除: re 模块中的 Pattern 与 Match 类现已支持 []。详见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 与 GenericAlias 类型。

class typing.Text

Text 是 str 的别名。提供了对 Python 2 代码的向下兼容：Python 2 中，Text 是 unicode 的别名。

使用 Text 时，值中必须包含 unicode 字符串，以兼容 Python 2 和 Python 3：

def add_unicode_checkmark(text: Text) -> Text:
    return text + u' \u2713'

3.5.2 新版功能.

抽象基类

collections.abc 对应的容器

class typing.AbstractSet(Collection[T_co])

collections.abc.Set 的泛型版本。

3.9 版后已移除: collections.abc.Set 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.ByteString(Sequence[int])

collections.abc.ByteString 的泛型版本。

该类型代表了 bytes、bytearray、memoryview 等字节序列类型。

作为该类型的简称，bytes 可用于标注上述任意类型的参数。

3.9 版后已移除: collections.abc.ByteString now supports subscripting ([]). See PEP 585 [https://www.python.org/dev/peps/pep-0585] and GenericAlias 类型.

class typing.Collection(Sized, Iterable[T_co], Container[T_co])

collections.abc.Collection 的泛型版本。

3.6.0 新版功能.

3.9 版后已移除: collections.abc.Collection 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Container(Generic[T_co])

collections.abc.Container 的泛型版本。

3.9 版后已移除: collections.abc.Container 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.ItemsView(MappingView, AbstractSet[tuple[KT_co, VT_co]])

collections.abc.ItemsView 的泛型版本。

3.9 版后已移除: collections.abc.ItemsView 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.KeysView(MappingView, AbstractSet[KT_co])

collections.abc.KeysView 的泛型版本。

3.9 版后已移除: collections.abc.KeysView 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Mapping(Collection[KT], Generic[KT, VT_co])

collections.abc.Mapping 的泛型版本。用法如下：

def get_position_in_index(word_list: Mapping[str, int], word: str) -> int:
    return word_list[word]

3.9 版后已移除: collections.abc.Mapping 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.MappingView(Sized)

collections.abc.MappingView 的泛型版本。

3.9 版后已移除: collections.abc.MappingView 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.MutableMapping(Mapping[KT, VT])

collections.abc.MutableMapping 的泛型版本。

3.9 版后已移除: collections.abc.MutableMapping 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.MutableSequence(Sequence[T])

collections.abc.MutableSequence 的泛型版本。

3.9 版后已移除: collections.abc.MutableSequence 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.MutableSet(AbstractSet[T])

collections.abc.MutableSet 的泛型版本。

3.9 版后已移除: collections.abc.MutableSet 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Sequence(Reversible[T_co], Collection[T_co])

collections.abc.Sequence 的泛型版本。

3.9 版后已移除: collections.abc.Sequence 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.ValuesView(MappingView, Collection[_VT_co])

collections.abc.ValuesView 的泛型版本。

3.9 版后已移除: collections.abc.ValuesView 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

collections.abc 对应的其他类型

class typing.Iterable(Generic[T_co])

collections.abc.Iterable 的泛型版本。

3.9 版后已移除: collections.abc.Iterable 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Iterator(Iterable[T_co])

collections.abc.Iterator 的泛型版本。

3.9 版后已移除: collections.abc.Iterator 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])

生成器可以由泛型类型 Generator[YieldType, SendType, ReturnType] 注解。例如：

def echo_round() -> Generator[int, float, str]:
    sent = yield 0
    while sent >= 0:
        sent = yield round(sent)
    return 'Done'

注意，与 typing 模块里的其他泛型不同， Generator 的 SendType 属于逆变行为，不是协变或不变行为。

如果生成器只产生值，可将 SendType 与 ReturnType 设为 None：

def infinite_stream(start: int) -> Generator[int, None, None]:
    while True:
        yield start
        start += 1

此外，还可以把生成器的返回类型注解为 Iterable[YieldType] 或 Iterator[YieldType]：

def infinite_stream(start: int) -> Iterator[int]:
    while True:
        yield start
        start += 1

3.9 版后已移除: collections.abc.Generator 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Hashable

collections.abc.Hashable 的别名。

class typing.Reversible(Iterable[T_co])

collections.abc.Reversible 的泛型版本。

3.9 版后已移除: collections.abc.Reversible 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Sized

collections.abc.Sized 的别名。

异步编程

class typing.Coroutine(Awaitable[V_co], Generic[T_co, T_contra, V_co])

collections.abc.Coroutine 的泛型版本。类型变量的差异和顺序与 Generator 的内容相对应，例如：

from collections.abc import Coroutine
c: Coroutine[list[str], str, int]  # Some coroutine defined elsewhere
x = c.send('hi')                   # Inferred type of 'x' is list[str]
async def bar() -> None:
    y = await c                    # Inferred type of 'y' is int

3.5.3 新版功能.

3.9 版后已移除: collections.abc.Coroutine 现在支持下标操作（[]）。参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra])

异步生成器可由泛型类型 AsyncGenerator[YieldType, SendType] 注解。例如：

async def echo_round() -> AsyncGenerator[int, float]:
    sent = yield 0
    while sent >= 0.0:
        rounded = await round(sent)
        sent = yield rounded

与常规生成器不同，异步生成器不能返回值，因此没有 ReturnType 类型参数。 与 Generator 类似，SendType 也属于逆变行为。

如果生成器只产生值，可将 SendType 设置为 None：

async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
    while True:
        yield start
        start = await increment(start)

此外，可用 AsyncIterable[YieldType] 或 AsyncIterator[YieldType] 注解生成器的返回类型：

async def infinite_stream(start: int) -> AsyncIterator[int]:
    while True:
        yield start
        start = await increment(start)

3.6.1 新版功能.

3.9 版后已移除: collections.abc.AsyncGenerator 现在支持下标操作（[]）。参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.AsyncIterable(Generic[T_co])

collections.abc.AsyncIterable 的泛型版本。

3.5.2 新版功能.

3.9 版后已移除: collections.abc.AsyncIterable 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.AsyncIterator(AsyncIterable[T_co])

collections.abc.AsyncIterator 的泛型版本。

3.5.2 新版功能.

3.9 版后已移除: collections.abc.AsyncIterator 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.Awaitable(Generic[T_co])

collections.abc.Awaitable 的泛型版本。

3.5.2 新版功能.

3.9 版后已移除: collections.abc.Awaitable 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

上下文管理器类型

class typing.ContextManager(Generic[T_co])

contextlib.AbstractContextManager 的泛型版本。

3.5.4 新版功能.

3.6.0 新版功能.

3.9 版后已移除: contextlib.AbstractContextManager 现在支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

class typing.AsyncContextManager(Generic[T_co])

contextlib.AbstractAsyncContextManager 的泛型版本。

3.5.4 新版功能.

3.6.2 新版功能.

3.9 版后已移除: contextlib.AbstractAsyncContextManager 现在 支持下标操作 ([])。 参见 PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 GenericAlias 类型。

协议

这些协议由 runtime_checkable() 装饰。

class typing.SupportsAbs

一个抽象基类，含一个抽象方法 __abs__，该方法与其返回类型协变。

class typing.SupportsBytes

一个抽象基类，含一个抽象方法 __bytes__。

class typing.SupportsComplex

一个抽象基类，含一个抽象方法 __complex__。

class typing.SupportsFloat

一个抽象基类，含一个抽象方法 __float__。

class typing.SupportsIndex

一个抽象基类，含一个抽象方法 __index__。

3.8 新版功能.

class typing.SupportsInt

一个抽象基类，含一个抽象方法 __int__。

class typing.SupportsRound

一个抽象基类，含一个抽象方法 __round__，该方法与其返回类型协变。

函数与装饰器

typing.cast(typ, val)

把一个值转换为指定的类型。

这会把值原样返回。对类型检查器而言这代表了返回值具有指定的类型，在运行时我们故意没有设计任何检查（我们希望让这尽量快）。

@typing.overload

@overload 装饰器可以修饰支持多个不同参数类型组合的函数或方法。@overload - 装饰定义的系列必须紧跟一个非 @overload-装饰定义（用于同一个函数/方法）。@overload-装饰定义仅是为了协助类型检查器， 因为该装饰器会被非 @overload-装饰定义覆盖，后者用于运行时，而且会被类型检查器忽略。在运行时直接调用 @overload 装饰的函数会触发 NotImplementedError。下面的重载示例给出了比联合类型或类型变量更精准的类型：

@overload
def process(response: None) -> None:
    ...
@overload
def process(response: int) -> tuple[int, str]:
    ...
@overload
def process(response: bytes) -> str:
    ...
def process(response):
    <actual implementation>

请参阅 PEP 484 [https://www.python.org/dev/peps/pep-0484] 了解更多细节以及与其他类型语义的比较。

@typing.final

告知类型检查器被装饰的方法不能被覆盖，且被装饰的类不能作为子类的装饰器，例如：

class Base:
    @final
    def done(self) -> None:
        ...
class Sub(Base):
    def done(self) -> None:  # Error reported by type checker
        ...

@final
class Leaf:
    ...
class Other(Leaf):  # Error reported by type checker
    ...

这些属性没有运行时检查。详见 PEP 591 [https://www.python.org/dev/peps/pep-0591]。

3.8 新版功能.

@typing.no_type_check

标明注解不是类型提示的装饰器。

用作类或函数的 decorator。用于类时，递归地应用于该类中定义的所有方法，（但不影响超类或子类中定义的方法）。

本方法可直接修改函数。

@typing.no_type_check_decorator

让其他装饰器具有 no_type_check() 效果的装饰器。

本装饰器用 no_type_check() 里的装饰函数打包其他装饰器。

@typing.type_check_only

标记类或函数内不可用于运行时的装饰器。

在运行时，该装饰器本身不可用。实现返回的是私有类实例时，它主要是用于标记在类型存根文件中定义的类。

@type_check_only
class Response:  # private or not available at runtime
    code: int
    def get_header(self, name: str) -> str: ...

def fetch_response() -> Response: ...

注意，建议不要返回私有类实例，最好将之设为公共类。

内省辅助器

typing.get_type_hints(obj, globalns=None, localns=None, include_extras=False)

返回函数、方法、模块、类对象的类型提示的字典。

一般情况下，与 obj.__annotations__ 相同。此外，可通过在 globals 与 locals 命名空间里进行评估，以此来处理编码为字符串字面量的前向引用。如有需要，在默认值设置为 None 时，可为函数或方法注解添加 Optional[t]。对于类 C，则返回由所有 __annotations__ 与 C.__mro__ 逆序合并而成的字典。

本函数以递归地方式用 T 替换所有 Annotated[T, ...]， 除非将 include_extras 的值设置为 True （详见 Annotated）。例如：

class Student(NamedTuple):
    name: Annotated[str, 'some marker']

get_type_hints(Student) == {'name': str}
get_type_hints(Student, include_extras=False) == {'name': str}
get_type_hints(Student, include_extras=True) == {
    'name': Annotated[str, 'some marker']
}

注解

get_type_hints() 在导入的 类型别名 中不工作，包括前向引用。启用注解的延迟评估（ PEP 563 [https://www.python.org/dev/peps/pep-0563] ）可能会消除对大多数前向引用的需要。

在 3.9 版更改: PEP 593 [https://www.python.org/dev/peps/pep-0593] 的组成部分，添加了 include_extras 参数。

typing.get_args(tp)

typing.get_origin(tp)

为泛型类型与特殊类型形式提供了基本的内省功能。

对于 X[Y, Z, ...] 形式的类型对象，这些函数返回 X 与 (Y, Z, ...)。如果 X 是内置对象或 collections class 的泛型别名， 会将其标准化为原始类。如果 X 是包含在其他泛型类型中的联合类型或 Literal，(Y, Z, ...) 的顺序会因类型缓存，而与原始参数 [Y, Z, ...] 的顺序不同。对于不支持的对象会相应地返回 None 或 ()。例如：

assert get_origin(Dict[str, int]) is dict
assert get_args(Dict[int, str]) == (int, str)

assert get_origin(Union[int, str]) is Union
assert get_args(Union[int, str]) == (int, str)

3.8 新版功能.

typing.is_typeddict(tp)

检查一个类型是否为 TypedDict。

例如：

class Film(TypedDict):
    title: str
    year: int

is_typeddict(Film)  # => True
is_typeddict(list | str)  # => False

3.10 新版功能.

class typing.ForwardRef

用于字符串前向引用的内部类型表示的类。 例如，List["SomeClass"] 会被隐式转换为 List[ForwardRef("SomeClass")]。 这个类不应由用户来实例化，但可以由内省工具使用。

注解

PEP 585 [https://www.python.org/dev/peps/pep-0585] 泛型类型例如 list["SomeClass"] 将不会被隐式地转换为 list[ForwardRef("SomeClass")] 因而将不会自动解析为 list[SomeClass]。

3.7.4 新版功能.

常量

typing.TYPE_CHECKING

被第三方静态类型检查器假定为 True 的特殊常量。 在运行时为 False。 用法如下:

if TYPE_CHECKING:
    import expensive_mod

def fun(arg: 'expensive_mod.SomeType') -> None:
    local_var: expensive_mod.AnotherType = other_fun()

第一个类型注解必须用引号标注，才能把它当作“前向引用”，从而在解释器运行时中隐藏 expensive_mod 引用。局部变量的类型注释不会被评估，因此，第二个注解不需要用引号引起来。

注解

若用了 from __future__ import annotations，函数定义时则不求值注解，直接把注解以字符串形式存在 __annotations__ 里。这时毋需为注解打引号（见 PEP 563 [https://www.python.org/dev/peps/pep-0563]）。

3.5.2 新版功能.

pydoc --- 文档生成器和在线帮助系统

源代码: Lib/pydoc.py [https://github.com/python/cpython/tree/3.10/Lib/pydoc.py]

pydoc 模块会根据 Python 模块来自动生成文档。 生成的文档可在控制台中显示为文本页面，提供给 Web 浏览器访问或者保存为 HTML 文件。

对于模块、类、函数和方法，显示的文档内容取自文档字符串（即 __doc__ 属性），并会递归地从其带文档的成员中获取。 如果没有文档字符串，pydoc 会尝试从类、函数或方法定义上方，或是模块顶部的注释行段落获取 (参见 inspect.getcomments()).

内置函数 help() 会发起调用交互式解释器的在线帮助系统，该系统使用 pydoc 在终端上生成文本形式的文档内容。 同样的文本文档也可以在 Python 解释器以外通过在操作系统的命令提示符下以脚本方式运行 pydoc 来查看。 例如，运行

python -m pydoc sys

在终端提示符下将通过 sys 模块显示文档内容，其样式类似于 Unix man 命令所显示的指南页面。 pydoc 的参数可以为函数、模块、包，或带点号的对模块中的类、方法或函数以及包中的模块的引用。 如果传给 pydoc 的参数像是一个路径（即包含所在操作系统的路径分隔符，例如 Unix 的正斜杠），并且其指向一个现有的 Python 源文件，则会为该文件生成文档内容。

注解

为了找到对象及其文档内容，pydoc 会导入文档所在的模块。 因此，任何模块层级的代码都将被执行。 请使用 if __name__ == '__main__': 语句来确保一个文件的特定代码仅在作为脚本被发起调用时执行而不是在被导入时执行。

当打印输出到控制台时，pydoc 会尝试对输出进行分页以方便阅读。 如果设置了 PAGER 环境变量，pydoc 将使用该变量值作为分页程序。

在参数前指定 -w 旗标将把 HTML 文档写入到当前目录下的一个文件中，而不是在控制台中显示文本。

在参数前指定 -k 旗标将在全部可用模块的提要行中搜索参数所给定的关键字，具体方式同样类似于 Unix man 命令。 模块的提要行就是其文档字符串的第一行。

你还可以使用 pydoc 在本机上启动一个 HTTP 服务器并向来访的 Web 浏览器展示文档。 python -m pydoc -p 1234 将在 1234 端口上启动 HTTP 服务器，允许在你所用的 Web 浏览器上通过 http://localhost:1234/ 来浏览文档。 指定 0 作为端口号将任意选择一个未使用的端口。

python -m pydoc -n <hostname> 将启动在给定主机名上监听的服务器。 默认的主机名为 'localhost' 但是如果你希望能从其他机器上搜索该服务器，你可能会想要改变服务器所响应的主机名。 在开发阶段此特性会特别有用，如果你想要在一个容器中运行 pydoc 的话。

python -m pydoc -b 将启动服务器并额外打开一个 Web 浏览器访问模块索引页。 所发布的每个页面顶端都带有导航栏，你可以点击 Get 来获取特定条目的帮助信息，点击 Search 在所有模块的摘要行中搜索某个关键词，或点击 Module index, Topics 和 Keywords 前往相应的页面。

当 pydoc 生成文档内容时，它会使用当前环境和路径来定位模块。 因此，唤起 pydoc spam 得到的文档版本会与你启动 Python 解释器并输入 import spam 时得到的模块版本完全相同。

核心模块的模块文档位置对应于 https://docs.python.org/X.Y/library/ 其中 X 和 Y 是 Python 解释器的主要版本号和小版本号。 这可通过设置 PYTHONDOCS 环境变量来重载为指向不同的 URL 或包含 Library Reference Manual 页面的本地目录。

在 3.2 版更改: 添加 -b 选项。

在 3.3 版更改: 命令行选项 -g 已经移除。

在 3.4 版更改: pydoc 现在会使用 inspect.signature() 而非 inspect.getfullargspec() 来从可调用对象中提取签名信息。

在 3.7 版更改: 添加 -n 选项。

Python 开发模式

3.7 新版功能.

开发模式下的 Python 加入了额外的运行时检查，由于开销太大，并非默认启用的。如果代码能够正确执行，默认的调试级别足矣，不应再提高了；仅当觉察到问题时再提升警告触发的级别。

使用 -X dev 命令行参数或将环境变量 PYTHONDEVMODE 置为 1 ，可以启用开发模式。

另请参考 Python debug build 。

Python 开发模式的效果

启用 Python 开发模式后的效果，与以下命令类似，不过还有下面的额外效果：

PYTHONMALLOC=debug PYTHONASYNCIODEBUG=1 python3 -W default -X faulthandler

Python 开发模式的效果：

加入 default warning filter 。下述警告信息将会显示出来：

DeprecationWarning

ImportWarning

PendingDeprecationWarning

ResourceWarning

通常上述警告是由默认的 warning filters 负责处理的。

效果类似于采用了 -W default 命令行参数。

使用命令行参数 -W error 或将环境变量 PYTHONWARNINGS 设为 error，可将警告视为错误。

在内存分配程序中安装调试钩子，用以查看：

缓冲区下溢

缓冲区上溢

内存分配 API 冲突

不安全的 GIL 调用

参见 C 函数 PyMem_SetupDebugHooks() 。

效果如同将环境变量 PYTHONMALLOC 设为 debug。

若要启用 Python 开发模式，却又不要在内存分配程序中安装调试钩子，请将 环境变量 PYTHONMALLOC 设为 default。

在启动 Python 时调用 faulthandler.enable() ，会安装 SIGSEGV 、 SIGFPE 、 SIGABRT 、 SIGBUS 和 SIGILL 信号的处理程序，以便在程序崩溃时将 Python 跟踪信息转储下来。

其行为如同使用了 -X faulthandler 命令行选项或将 PYTHONFAULTHANDLER 环境变量设为 1。

启用 asyncio debug mode。比如 asyncio 会检查没有等待的协程并记录下来。

效果如同将环境变量 PYTHONASYNCIODEBUG 设为 1。

检查字符串编码和解码函数的 encoding 和 errors 参数。例如： open() 、 str.encode() 和 bytes.decode()。

为了获得最佳性能，默认只会在第一次编码/解码错误时才会检查 errors 参数，有时 encoding 参数为空字符串时还会被忽略。

io.IOBase 的析构函数会记录 close() 触发的异常。

将 sys.flags 的 dev_mode 属性设为 True。

Python 开发模式下，默认不会启用 tracemalloc 模块，因为其性能和内存开销太大。启用 tracemalloc 模块后，能够提供有关错误来源的一些额外信息。例如，ResourceWarning 记录了资源分配的跟踪信息，而缓冲区溢出错误记录了内存块分配的跟踪信息。

Python 开发模式不会阻止命令行参数 -O 删除 assert 语句，也不会阻止将 __debug__ 设为 False。

Python 开发模式只能在 Python 启动时启用。其参数值可从 sys.flags.dev_mode 读取。

在 3.8 版更改: 现在， io.IOBase 的析构函数会记录 close() 触发的异常。

在 3.9 版更改: 现在，字符串编码和解码操作时会检查 encoding 和 errors 参数。

ResourceWarning 示例

以下示例将统计由命令行指定的文本文件的行数：

import sys

def main():
    fp = open(sys.argv[1])
    nlines = len(fp.readlines())
    print(nlines)
    # The file is closed implicitly

if __name__ == "__main__":
    main()

上述代码没有显式关闭文件。默认情况下，Python 不会触发任何警告。下面用 README.txt 文件测试下，有 269 行：

$ python3 script.py README.txt
269

启用 Python 开发模式后，则会显示一条 ResourceWarning 警告：

$ python3 -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

启用 tracemalloc 后，则还会显示打开文件的那行代码：

$ python3 -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])

修正方案就是显式关闭文件。下面用上下文管理器作为示例：

def main():
    # Close the file explicitly when exiting the with block
    with open(sys.argv[1]) as fp:
        nlines = len(fp.readlines())
    print(nlines)

未能显式关闭资源，会让资源打开时长远超预期；在退出 Python 时可能会导致严重问题。这在 CPython 中比较糟糕，但在 PyPy 中会更糟。显式关闭资源能让应用程序更加稳定可靠。

文件描述符错误示例

显示自身的第一行代码：

import os

def main():
    fp = open(__file__)
    firstline = fp.readline()
    print(firstline.rstrip())
    os.close(fp.fileno())
    # The file is closed implicitly

main()

默认情况下，Python 不会触发任何警告：

$ python3 script.py
import os

在 Python 开发模式下，会在析构文件对象时显示 ResourceWarning 并记录 “Bad file descriptor” 错误。

$ python3 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

os.close(fp.fileno()) 会关闭文件描述符。当文件对象析构函数试图再次关闭文件描述符时会失败，并触发 Bad file descriptor 错误。每个文件描述符只允许关闭一次。在最坏的情况下，关闭两次会导致程序崩溃（示例可参见 bpo-18748 [https://bugs.python.org/issue?@action=redirect&bpo=18748] ）。

修正方案是删除 os.close(fp.fileno()) 这一行，或者打开文件时带上 closefd=False 参数。

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

源代码： Lib/doctest.py [https://github.com/python/cpython/tree/3.10/Lib/doctest.py]

doctest 模块寻找像Python交互式代码的文本，然后执行这些代码来确保它们的确就像展示的那样正确运行，有许多方法来使用doctest：

通过验证所有交互式示例仍然按照记录的方式工作，以此来检查模块的文档字符串是否是最新的。

通过验证来自一个测试文件或一个测试对象的交互式示例按预期工作，来进行回归测试。

为一个包写指导性的文档，用输入输出的例子来说明。 取决于是强调例子还是说明性的文字，这有一种 "文本测试 "或 "可执行文档 "的风格。

下面是一个小却完整的示例模块:

"""
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:  # catch a value like 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()

如果你直接在命令行里运行 example.py ， doctest 将发挥它的作用。

$ python example.py
$

没有输出！ 这很正常，这意味着所有的例子都成功了。 把 -v 传给脚本，doctest 会打印出它所尝试的详细日志，并在最后打印出一个总结。

$ 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

以此类推，最终以：

Trying:
    factorial(1e100)
Expecting:
    Traceback (most recent call last):
        ...
    OverflowError: n too large
ok
2 items passed all tests:
   1 tests in __main__
   8 tests in __main__.factorial
9 tests in 2 items.
9 passed and 0 failed.
Test passed.
$

这就是对于高效地使用 doctest 你所需要知道的一切！开始上手吧。 下面的章节提供了完整的细节。 请注意，在标准的 Python 测试套件和库中有许多 doctest 的例子。特别有用的例子可以在标准测试文件 Lib/test/test_doctest.py 中找到。

简单用法：检查Docstrings中的示例

开始使用doctest的最简单方法（但不一定是你将继续这样做的方式）是结束每个模块 M 使用:

if __name__ == "__main__":
    import doctest
    doctest.testmod()

doctest 会随后检查模块 M 中的文档字符串。

以脚本形式运行该模块会使文档中的例子得到执行和验证:

python M.py

这不会显示任何东西，除非一个例子失败了，在这种情况下，失败的例子和失败的原因会被打印到stdout，最后一行的输出是 ***Test Failed*** N failures.，其中 N 是失败的例子的数量。

用 -v 来运行它来切换，而不是:

python M.py -v

并将所有尝试过的例子的详细报告打印到标准输出，最后还有各种总结。

你可以通过向 testmod() 传递 verbose=True 来强制执行 verbose 模式，或者通过传递 verbose=False 来禁止它。 在这两种情况下，sys.argv 都不会被 testmod() 检查（所以传递 -v 或不传递都没有影响）。

还有一个命令行快捷方式用于运行 testmod()。 你可以指示Python解释器直接从标准库中运行doctest模块，并在命令行中传递模块名称:

python -m doctest -v example.py

这将导入 example.py 作为一个独立的模块，并对其运行 testmod()。 注意，如果该文件是一个包的一部分，并且从该包中导入了其他子模块，这可能无法正确工作。

关于 testmod() 的更多信息，请参见 基本API 部分。

简单的用法：检查文本文件中的例子

doctest 的另一个简单应用是测试文本文件中的交互式例子。 这可以用 testfile() 函数来完成:

import doctest
doctest.testfile("example.txt")

这个简短的脚本执行并验证文件 example.txt 中包含的任何交互式 Python 示例。该文件的内容被当作一个巨大的文档串来处理；该文件不需要包含一个Python程序！例如，也许 example.txt 包含以下内容:

The ``example`` module
======================

Using ``factorial``
-------------------

This is an example text file in reStructuredText format.  First import
``factorial`` from the ``example`` module:

    >>> from example import factorial

Now use it:

    >>> factorial(6)
    120

运行 doctest.testfile("example.txt")，然后发现这个文档中的错误:

File "./example.txt", line 14, in example.txt
Failed example:
    factorial(6)
Expected:
    120
Got:
    720

与 testmod() 一样， testfile() 不会显示任何东西，除非一个例子失败。 如果一个例子失败了，那么失败的例子和失败的原因将被打印到stdout，使用的格式与 testmod() 相同。

默认情况下，testfile() 在调用模块的目录中寻找文件。参见章节 基本API，了解可用于告诉它在其他位置寻找文件的可选参数的描述。

像 testmod() 一样，testfile() 的详细程度可以通过命令行 -v 切换或可选的关键字参数 verbose 来设置。

还有一个命令行快捷方式用于运行 testfile()。 你可以指示Python解释器直接从标准库中运行doctest模块，并在命令行中传递文件名:

python -m doctest -v example.txt

因为文件名没有以 .py 结尾，doctest 推断它必须用 testfile() 运行，而不是 testmod()。

关于 testfile() 的更多信息，请参见 基本API 一节。

它是如何工作的

这一节详细研究了doctest的工作原理：它查看哪些文档串，它如何找到交互式的用例，它使用什么执行环境，它如何处理异常，以及如何用选项标志来控制其行为。这是你写doctest例子所需要知道的信息；关于在这些例子上实际运行doctest的信息，请看下面的章节。

哪些文件串被检查了？

模块的文档串以及所有函数、类和方法的文档串都将被搜索。 导入模块的对象不被搜索。

此外，如果 M.__test__ 存在并且 "为真值"，则它必须是一个字典，其中每个条目都将一个（字符串）名称映射到一个函数对象、类对象或字符串。 从 M.__test__ 找到的函数和类对象的文档字符串会被搜索，而字符串会被当作文档字符串来处理。 在输出时，每个键 K 在 M.__test__ 中都显示为其名称

<name of M>.__test__.K

任何发现的类都会以类似的方式进行递归搜索，以测试其包含的方法和嵌套类中的文档串。

文档串的例子是如何被识别的？

在大多数情况下，对交互式控制台会话的复制和粘贴功能工作得很好，但是 doctest 并不试图对任何特定的 Python shell 进行精确的模拟。

>>> # comments are ignored
>>> x = 12
>>> x
12
>>> if x == 13:
...     print("yes")
... else:
...     print("no")
...     print("NO")
...     print("NO!!!")
...
no
NO
NO!!!
>>>

任何预期的输出必须紧随包含代码的最后 '>>> ' 或 '... ' 行，预期的输出（如果有的话）延伸到下一 '>>> ' 行或全空白行。

fine输出：

预期输出不能包含一个全白的行，因为这样的行被认为是预期输出的结束信号。 如果预期的输出包含一个空行，在你的测试例子中，在每一个预期有空行的地方加上 <BLANKLINE>。

所有硬制表符都被扩展为空格，使用 8 列的制表符。由测试代码生成的输出中的制表符不会被修改。 因为样本输出中的任何硬制表符都会被扩展，这意味着如果代码输出包括硬制表符，文档测试通过的唯一方法是 NORMALIZE_WHITESPACE 选项或者 指令 是有效的。 另外，测试可以被重写，以捕获输出并将其与预期值进行比较，作为测试的一部分。这种对源码中标签的处理是通过试错得出的，并被证明是最不容易出错的处理方式。通过编写一个自定义的 DocTestParser 类，可以使用一个不同的算法来处理标签。

向stdout的输出被捕获，但不向stderr输出（异常回溯通过不同的方式被捕获）。

如果你在交互式会话中通过反斜线续行，或出于任何其他原因使用反斜线，你应该使用原始文件串，它将完全保留你输入的反斜线:

>>> def f(x):
...     r'''Backslashes in a raw docstring: m\n'''
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n

否则，反斜杠将被解释为字符串的一部分。例如，上面的 \n 会被解释为一个换行符。 另外，你可以在doctest版本中把每个反斜杠加倍（而不使用原始字符串）:

>>> def f(x):
...     '''Backslashes in a raw docstring: m\\n'''
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n

起始列并不重要:

>>> assert "Easy!"
      >>> import math
          >>> math.floor(1.9)
          1

并从预期的输出中剥离出与开始该例子的初始 '>>> ' 行中出现的同样多的前导空白字符。

什么是执行上下文？

默认情况下，每次 doctest 找到要测试的文档串时，它都会使用 M 的*浅层副本*，这样运行测试就不会改变模块的真正全局变量，而且 M 的一个测试也不会留下临时变量，从而意外地让另一个测试通过。这意味着例子可以自由地使用 M 中的任何顶级定义的名字，以及正在运行的文档串中早期定义的名字。用例不能看到其他文档串中定义的名字。

你可以通过将 globs=your_dict 传递给 testmod() 或 testfile() 来强制使用你自己的dict作为执行环境。

异常如何处理？

没问题，只要回溯是这个例子产生的唯一输出：只要粘贴回溯即可。1 由于回溯所包含的细节可能会迅速变化（例如，确切的文件路径和行号），这是doctest努力使其接受的内容具有灵活性的一种情况。

简单实例:

>>> [1, 2, 3].remove(42)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: list.remove(x): x not in list

如果 ValueError 被触发，该测试就会成功，list.remove(x): x not in list 的细节如图所示。

异常的预期输出必须以回溯头开始，可以是以下两行中的任何一行，缩进程度与例子中的第一行相同:

Traceback (most recent call last):
Traceback (innermost last):

回溯头的后面是一个可选的回溯堆栈，其内容被doctest忽略。 回溯堆栈通常是省略的，或者从交互式会话中逐字复制的。

回溯堆栈的后面是最有用的部分：包含异常类型和细节的一行（几行）。 这通常是回溯的最后一行，但如果异常有多行细节，则可以延伸到多行:

>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: multi
    line
detail

最后三行（以 ValueError 开头）将与异常的类型和细节进行比较，其余的被忽略。

最佳实践是省略回溯栈，除非它为这个例子增加了重要的文档价值。 因此，最后一个例子可能更好，因为:

>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
    ...
ValueError: multi
    line
detail

请注意，回溯的处理方式非常特别。 特别是，在重写的例子中，... 的使用与 doctest 的 ELLIPSIS 选项无关。 该例子中的省略号可以不写，也可以是三个（或三百个）逗号或数字，或者是一个缩进的 Monty Python 短剧的剧本。

有些细节你应该读一遍，但不需要记住：

Doctest 不能猜测你的预期输出是来自异常回溯还是来自普通打印。 因此，例如，一个期望 ValueError: 42 is prime 的用例将通过测试，无论 ValueError 是真的被触发，或者该用例只是打印了该回溯文本。 在实践中，普通输出很少以回溯标题行开始，所以这不会产生真正的问题。

回溯堆栈的每一行（如果有的话）必须比例子的第一行缩进， 或者 以一个非字母数字的字符开始。回溯头之后的第一行缩进程度相同，并且以字母数字开始，被认为是异常细节的开始。当然，这对真正的回溯来说是正确的事情。

当 IGNORE_EXCEPTION_DETAIL doctest 选项被指定时，最左边的冒号后面的所有内容以及异常名称中的任何模块信息都被忽略。

交互式 shell 省略了一些 SyntaxError 的回溯头行。但 doctest 使用回溯头行来区分异常和非异常。所以在罕见的情况下，如果你需要测试一个省略了回溯头的 SyntaxError，你将需要手动添加回溯头行到你的测试用例中。

对于一些 SyntaxError，Python 使用 ^ 标记显示语法错误的字符位置:

>>> 1 1
  File "<stdin>", line 1
    1 1
      ^
SyntaxError: invalid syntax

由于显示错误位置的行在异常类型和细节之前，它们不被doctest检查。 例如，下面的测试会通过，尽管它把 ^ 标记放在了错误的位置:

>>> 1 1
Traceback (most recent call last):
  File "<stdin>", line 1
    1 1
    ^
SyntaxError: invalid syntax

选项标记

一系列选项旗标控制着 doctest 的各方面行为。 旗标的符号名称以模块常量的形式提供，可以一起 bitwise ORed 并传递给各种函数。 这些名称也可以在 doctest directives 中使用，并且可以通过 -o 选项传递给 doctest 命令行接口。

3.4 新版功能: 命令行选项 -o 。

第一组选项定义了测试语义，控制doctest如何决定实际输出是否与用例的预期输出相匹配方面的问题。

doctest.DONT_ACCEPT_TRUE_FOR_1

默认情况下，如果一个预期的输出块只包含 1，那么实际的输出块只包含 1 或只包含 True 就被认为是匹配的，同样，0 与 False 也是如此。 当 DONT_ACCEPT_TRUE_FOR_1 被指定时，两种替换都不允许。 默认行为是为了适应 Python 将许多函数的返回类型从整数改为布尔值；期望 "小整数" 输出的测试在这些情况下仍然有效。 这个选项可能会消失，但不会在几年内消失。

doctest.DONT_ACCEPT_BLANKLINE

默认情况下，如果一个预期输出块包含一个只包含字符串 <BLANKLINE> 的行，那么该行将与实际输出中的一个空行相匹配。 因为一个真正的空行是对预期输出的限定，这是传达预期空行的唯一方法。 当 DONT_ACCEPT_BLANKLINE 被指定时，这种替换是不允许的。

doctest.NORMALIZE_WHITESPACE

当指定时，所有的空白序列（空白和换行）都被视为相等。预期输出中的任何空白序列将与实际输出中的任何空白序列匹配。默认情况下，空白必须完全匹配。 NORMALIZE_WHITESPACE 在预期输出非常长的一行，而你想把它包在源代码的多行中时特别有用。

doctest.ELLIPSIS

当指定时，预期输出中的省略号（ ... ）可以匹配实际输出中的任何子串。这包括跨行的子串和空子串，所以最好保持简单的用法。复杂的用法会导致与 .* 在正则表达式中容易出现的 "oops, it matched too much!"相同的意外情况。

doctest.IGNORE_EXCEPTION_DETAIL

当被指定时，只要有预期类型的异常被引发 doctests 就会预期异常测试通过，即使细节（消息和完整限定名称）并不匹配。

举例来说，一个预期 ValueError: 42 的用例在实际引发的异常为 ValueError: 3*14 将会通过，但是如果是引发 TypeError 则将会失败。 它也将忽略任何包括在异常类前面的完整限定名称，该名称在所使用的不同 Python 版本和代码/库中可能会不同。 因此，以下三种形式对于指定的旗标均有效:

>>> 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

请注意 ELLIPSIS 也可以被用来忽略异常消息中的细节，但这样的测试仍然可能根据特定模块名称是否存在或是否完全匹配而失败。

在 3.2 版更改: IGNORE_EXCEPTION_DETAIL 现在也忽略了与包含被测异常的模块有关的任何信息。

doctest.SKIP

当指定时，完全不运行这个用例。 这在doctest用例既是文档又是测试案例的情况下很有用，一个例子应该包括在文档中，但不应该被检查。例如，这个例子的输出可能是随机的；或者这个例子可能依赖于测试驱动程序所不能使用的资源。

SKIP标志也可用于临时 "注释" 用例。

doctest.COMPARISON_FLAGS

一个比特或运算将上述所有的比较标志放在一起。

第二组选项控制测试失败的报告方式：

doctest.REPORT_UDIFF

当指定时，涉及多行预期和实际输出的故障将使用统一的差异来显示。

doctest.REPORT_CDIFF

当指定时，涉及多行预期和实际输出的故障将使用上下文差异来显示。

doctest.REPORT_NDIFF

当指定时，差异由 difflib.Differ 来计算，使用与流行的:file:ndiff.py`工具相同的算法。这是唯一一种标记行内和行间差异的方法。 例如，如果一行预期输出包含数字 ``1` ，而实际输出包含字母 l ，那么就会插入一行，用圆点标记不匹配的列位置。

doctest.REPORT_ONLY_FIRST_FAILURE

当指定时，在每个 doctest 中显示第一个失败的用例，但隐藏所有其余用例的输出。 这将防止 doctest 报告由于先前的失败而中断的正确用例；但也可能隐藏独立于第一个失败的不正确用例。 当 REPORT_ONLY_FIRST_FAILURE 被指定时，其余的用例仍然被运行，并且仍然计入报告的失败总数；只是输出被隐藏了。

doctest.FAIL_FAST

当指定时，在第一个失败的用例后退出，不尝试运行其余的用例。因此，报告的失败次数最多为1。这个标志在调试时可能很有用，因为第一个失败后的用例甚至不会产生调试输出。

doctest 命令行接受选项 -f 作为 -o FAIL_FAST 的简洁形式。

3.4 新版功能.

doctest.REPORTING_FLAGS

一个比特或操作将上述所有的报告标志组合在一起。

还有一种方法可以注册新的选项标志名称，不过这并不有用，除非你打算通过子类来扩展 doctest 内部。

doctest.register_optionflag(name)

用给定的名称创建一个新的选项标志，并返回新标志的整数值。 register_optionflag() 可以在继承 OutputChecker 或 DocTestRunner 时使用，以创建子类支持的新选项。 register_optionflag() 应始终使用以下方式调用:

MY_FLAG = register_optionflag('MY_FLAG')

指令

Doctest指令可以用来修改单个例子的 option flags 。 Doctest指令是在一个用例的源代码后面的特殊Python注释。

directive             ::=  "#" "doctest:" directive_options
directive_options     ::=  directive_option ("," directive_option)*
directive_option      ::=  on_or_off directive_option_name
on_or_off             ::=  "+" | "-"
directive_option_name ::=  "DONT_ACCEPT_BLANKLINE" | "NORMALIZE_WHITESPACE" | ...

+ 或 - 与指令选项名称之间不允许有空格。 指令选项名称可以是上面解释的任何一个选项标志名称。

一个用例的 doctest 指令可以修改 doctest 对该用例的行为。 使用 + 来启用指定的行为，或者使用 - 来禁用它。

例如，这个测试将会通过:

>>> 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]

如果没有这个指令则它将失败，因为实际的输出在只有个位数的列表元素前没有两个空格，也因为实际的输出是单行的。 这个测试也会通过，并且也需要一个指令来完成:

>>> print(list(range(20)))  # doctest: +ELLIPSIS
[0, 1, ..., 18, 19]

在单个物理行中可以使用多条指令，以逗号分隔:

>>> print(list(range(20)))  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]

如果在单个用例中使用了多条指令注释，则它们会被合并:

>>> print(list(range(20)))  # doctest: +ELLIPSIS
...                         # doctest: +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]

正如前面的例子所示，你可以在你的用例中添加只包含指令的行 ...。 当一个用例太长以至于不能方便地放到同一行时这将会很有用:

>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
... # doctest: +ELLIPSIS
[0, ..., 4, 10, ..., 19, 30, ..., 39]

请注意，由于所有的选项都是默认禁用的，而指令只适用于它们出现的用例，所以启用选项 (通过指令中的 +) 通常是唯一有意义的选择。 然而，选项标志也可以被传递给运行测试的函数，建立不同的默认值。 在这种情况下，通过指令中的 - 来禁用一个选项可能是有用的。

警告

doctest 是严格地要求在预期输出中完全匹配。 如果哪怕只有一个字符不匹配，测试就会失败。 这可能会让你吃惊几次，在你确切地了解到 Python 对输出的保证和不保证之前。 例如，当打印一个集合时，Python 不保证元素以任何特定的顺序被打印出来，所以像:

>>> foo()
{"Hermione", "Harry"}

是不可靠的！一个变通方法是用:

>>> foo() == {"Hermione", "Harry"}
True

来取代。另一个是使用

>>> d = sorted(foo())
>>> d
['Harry', 'Hermione']

还有其他的问题，但你会明白的。

另一个不好的做法是打印嵌入了对象地址的值，例如

>>> id(1.0)  # certain to fail some of the time
7948648
>>> class C: pass
>>> C()  # the default repr() for instances embeds an address
<C object at 0x00AC18F0>

ELLIPSIS 指令为之前的例子提供了一个不错的方案:

>>> C()  # doctest: +ELLIPSIS
<C object at 0x...>

浮点数在不同的平台上也会有小的输出变化，因为Python在浮点数的格式化上依赖于平台的C库，而C库在这个问题上的质量差异很大。:

>>> 1./7  # risky
0.14285714285714285
>>> print(1./7) # safer
0.142857142857
>>> print(round(1./7, 6)) # much safer
0.142857

形式 I/2.**J 的数字在所有的平台上都是安全的，我经常设计一些测试的用例来产生该形式的数:

>>> 3./4  # utterly safe
0.75

简单的分数也更容易让人理解，这也使得文件更加完善。

基本API

函数 testmod() 和 testfile() 为 doctest 提供了一个简单的接口，应该足以满足大多数基本用途。关于这两个函数的不太正式的介绍，请参见 简单用法：检查Docstrings中的示例 和 简单的用法：检查文本文件中的例子 部分。

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 的文件中的用例。 返回 (failure_count, test_count)。

可选参数 module_relative 指定了文件名的解释方式。

如果 module_relative 是 True (默认)，那么 filename 指定一个独立于操作系统的模块相对路径。 默认情况下，这个路径是相对于调用模块的目录的；但是如果指定了 package 参数，那么它就是相对于该包的。 为了保证操作系统的独立性， filename 应该使用字符来分隔路径段，并且不能是一个绝对路径 (即不能以 / 开始)。

如果 module_relative 是 False，那么 filename 指定了一个操作系统特定的路径。路径可以是绝对的，也可以是相对的；相对路径是相对于当前工作目录而言的。

可选参数 name 给出了测试的名称；默认情况下，或者如果是 None，那么使用 os.path.basename(filename)。

可选参数 package 是一个 Python 包或一个 Python 包的名字，其目录应被用作模块相关文件名的基础目录。 如果没有指定包，那么调用模块的目录将作为模块相关文件名的基础目录。如果 module_relative 是 False，那么指定 package 是错误的。

可选参数 globs 给出了一个在执行示例时用作全局变量的dict。 这个dict的一个新的浅层副本将为doctest创建，因此它的用例将从一个干净的地方开始。默认情况下，或者如果为 None，使用一个新的空dict。

可选参数 extraglobs 给出了一个合并到用于执行用例全局变量中的dict。 这就像 dict.update() 一样：如果 globs 和 extraglobs 有一个共同的键，那么 extraglobs 中的相关值会出现在合并的dict中。 默认情况下，或者为 None ，则不使用额外的全局变量。这是一个高级功能，允许对 doctest 进行参数化。例如，可以为一个基类写一个测试，使用该类的通用名称，然后通过传递一个 extraglobs dict，将通用名称映射到要测试的子类，从而重复用于测试任何数量的子类。

可选的参数 verbose 如果为真值会打印很多东西，如果为假值则只打印失败信息；默认情况下，或者为 None，只有当 '-v' 在 sys.argv 中时才为真值。

可选参数 report 为True时，在结尾处打印一个总结，否则在结尾处什么都不打印。 在verbose模式下，总结是详细的，否则总结是非常简短的（事实上，如果所有的测试都通过了，总结就是空的）。

可选参数 optionflags （默认值为0）是选项标志的 bitwise OR 。参见章节 选项标记 。

可选参数 raise_on_error 默认为False。 如果是True，在一个用例中第一次出现失败或意外的异常时，会触发一个异常。这允许对失败进行事后调试。默认行为是继续运行例子。

可选参数 parser 指定一个 DocTestParser （或子类），它应该被用来从文件中提取测试。它默认为一个普通的解析器（即 DocTestParser()）。

可选参数 encoding 指定了一个编码，应该用来将文件转换为unicode。

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 （或模块 __main__ ，如果 m 没有被提供或为 None ）可达到的函数和类的文档串中的用例，从 m.__doc__ 开始。

也测试从dict m.__test__ 可达到的用例，如果它存在并且不是 None 。 m.__test__ 将名字（字符串）映射到函数、类和字符串；函数和类的文档串被搜索到的用例；字符串被直接搜索到，就像它们是文档串一样。

只搜索附属于模块 m 中的对象的文档串。

返回 (failure_count, test_count) 。

可选参数 name 给出了模块的名称；默认情况下，或者如果为 None ，则为 m.__name__ 。

可选参数 exclude_empty 默认为假值。 如果为真值，没有找到任何 doctest 的对象将被排除在考虑范围之外。 默认情况下是向后兼容，所以仍然使用 doctest.master.summarize() 和 testmod() 的代码会继续得到没有测试的对象的输出。 较新的 DocTestFinder 构造器的 exclude_empty 参数默认为真值。

可选参数 extraglobs 、 verbose 、 report 、 optionflags 、 raise_on_error 和 globs 与上述函数 testfile() 的参数相同，只是 globs 默认为 m.__dict__ 。

doctest.run_docstring_examples(f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)

与对象 f 相关的测试用例；例如， f 可以是一个字符串、一个模块、一个函数或一个类对象。

dict 参数 globs 的浅层拷贝被用于执行环境。

可选参数 name 在失败信息中使用，默认为 "NoName" 。

如果可选参数 verbose 为真，即使没有失败也会产生输出。 默认情况下，只有在用例失败的情况下才会产生输出。

可选参数 compileflags 给出了Python编译器在运行例子时应该使用的标志集。默认情况下，或者如果为 None ，标志是根据 globs 中发现的未来特征集推导出来的。

可选参数 optionflags 的作用与上述 testfile() 函数中的相同。

Unittest API

doctest 提供了两个函数，可以用来从模块和包含测试的文本文件中创建 unittest 测试套件。 要与 unittest 测试发现集成，请在你的测试模块中包含一个 load_tests() 函数：:

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

有两个主要函数用于从文本文件和带doctest的模块中创建 unittest.TestSuite 实例。

doctest.DocFileSuite(*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)

将一个或多个文本文件中的doctest测试转换为一个 unittest.TestSuite 。

返回的 unittest.TestSuite 将由 unittest 框架运行，并运行每个文件中的交互式示例。如果任何文件中的用例失败了，那么合成的单元测试就会失败，并触发一个 failureException 异常，显示包含该测试的文件名和一个（有时是近似的）行号。

传递一个或多个要检查的文本文件的路径（作为字符串）。

选项可以作为关键字参数提供：

可选参数 module_relative 指定了 paths 中的文件名应该如何解释。

如果 module_relative 是 True （默认值），那么 paths 中的每个文件名都指定了一个独立于操作系统的模块相对路径。 默认情况下，这个路径是相对于调用模块的目录的；但是如果指定了 package 参数，那么它就是相对于该包的。 为了保证操作系统的独立性，每个文件名都应该使用字符来分隔路径段，并且不能是绝对路径（即不能以 / 开始）。

如果 module_relative 是 False ，那么 paths 中的每个文件名都指定了一个操作系统特定的路径。 路径可以是绝对的，也可以是相对的；相对路径是关于当前工作目录的解析。

可选参数 package 是一个Python包或一个Python包的名字，其目录应该被用作 paths 中模块相关文件名的基本目录。 如果没有指定包，那么调用模块的目录将作为模块相关文件名的基础目录。 如果 module_relative 是 False ，那么指定 package 是错误的。

可选的参数 setUp 为测试套件指定了一个设置函数。在运行每个文件中的测试之前，它被调用。 setUp 函数将被传递给一个 DocTest 对象。 setUp函数可以通过测试的 globs 属性访问测试的全局变量。

可选的参数 tearDown 指定了测试套件的卸载函数。 在运行每个文件中的测试后，它会被调用。 tearDown 函数将被传递一个 DocTest 对象。 setUp函数可以通过测试的 globs 属性访问测试的全局变量。

可选参数 globs 是一个包含测试的初始全局变量的字典。 这个字典的一个新副本为每个测试创建。 默认情况下， globs 是一个新的空字典。

可选参数 optionflags 为测试指定默认的doctest选项，通过将各个选项的标志连接在一起创建。 参见章节 选项标记 。参见下面的函数 set_unittest_reportflags() ，以了解设置报告选项的更好方法。

可选参数 parser 指定一个 DocTestParser （或子类），它应该被用来从文件中提取测试。它默认为一个普通的解析器（即 DocTestParser()）。

可选参数 encoding 指定了一个编码，应该用来将文件转换为unicode。

该全局 __file__ 被添加到提供给用 DocFileSuite() 从文本文件加载的doctest的全局变量中。

doctest.DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, checker=None)

将一个模块的doctest测试转换为 unittest.TestSuite 。

返回的 unittest.TestSuite 将由 unittest 框架运行，并运行模块中的每个 doctest。 如果任何一个测试失败，那么合成的单元测试就会失败，并触发一个 failureException 异常，显示包含该测试的文件名和一个（有时是近似的）行号。

可选参数 module 提供了要测试的模块。 它可以是一个模块对象或一个（可能是带点的）模块名称。 如果没有指定，则使用调用此函数的模块。

可选参数 globs 是一个包含测试的初始全局变量的字典。 这个字典的一个新副本为每个测试创建。 默认情况下， globs 是一个新的空字典。

可选参数 extraglobs 指定了一组额外的全局变量，这些变量被合并到 globs 中。 默认情况下，不使用额外的全局变量。

可选参数 test_finder 是 DocTestFinder 对象（或一个可替换的对象），用于从模块中提取测试。

可选参数 setUp 、 tearDown 和 optionflags 与上述函数 DocFileSuite() 相同。

这个函数使用与 testmod() 相同的搜索技术。

在 3.5 版更改: 如果 module 不包含任何文件串，则 DocTestSuite() 返回一个空的 unittest.TestSuite，而不是触发 ValueError。

DocTestSuite() 从 doctest.DocTestCase 实例中创建一个 unittest.TestSuite ，而 DocTestCase 是 unittest.TestCase 的子类。 DocTestCase 在这里没有记录（这是一个内部细节），但研究其代码可以回答关于 unittest 集成的实际细节问题。

同样， DocFileSuite() 从 doctest.DocFileCase 实例中创建一个 unittest.TestSuite ，并且 DocFileCase 是 DocTestCase 的一个子类。

所以这两种创建 unittest.TestSuite 的方式都是运行 DocTestCase 的实例。这一点很重要，因为有一个微妙的原因：当你自己运行 doctest 函数时，你可以直接控制使用中的 doctest 选项，通过传递选项标志给 doctest 函数。 然而，如果你正在编写一个 unittest 框架， unittest 最终会控制测试的运行时间和方式。 框架作者通常希望控制 doctest 的报告选项（也许，例如，由命令行选项指定），但没有办法通过 unittest 向 doctest 测试运行者传递选项。

出于这个原因， doctest 也支持一个概念，即 doctest 报告特定于 unittest 支持的标志，通过这个函数：

doctest.set_unittest_reportflags(flags)

设置要使用的 doctest 报告标志。

参数 flags 是选项标志的 bitwise OR 。 参见章节 选项标记 。 只有 "报告标志" 可以被使用。

这是一个模块的全局设置，并影响所有未来由模块 unittest 运行的测试： DocTestCase 的 runTest() 方法会查看 DocTestCase 实例构建时为测试用例指定的选项标志。 如果没有指定报告标志（这是典型的和预期的情况）， doctest 的 unittest 报告标志被 bitwise ORed 到选项标志中，这样增加的选项标志被传递给 DocTestRunner 实例来运行doctest。 如果在构建 DocTestCase 实例时指定了任何报告标志，那么 doctest 的 unittest 报告标志会被忽略。

unittest 报告标志的值在调用该函数之前是有效的，由该函数返回。

高级 API

基本 API 是一个简单的封装，旨在使 doctest 易于使用。它相当灵活，应该能满足大多数用户的需求；但是，如果你需要对测试进行更精细的控制，或者希望扩展 doctest 的功能，那么你应该使用高级 API 。

高级API围绕着两个容器类，用于存储从 doctest 案例中提取的交互式用例:

Example: 一个单一的 Python statement ，与它的预期输出配对。

DocTest: 一组 Examples 的集合，通常从一个文档字符串或文本文件中提取。

定义了额外的处理类来寻找、解析和运行，并检查 doctest 的用例。

DocTestFinder : 查找给定模块中的所有文档串，并使用 DocTestParser 从每个包含交互式用例的文档串中创建一个 DocTest 。

DocTestParser : 从一个字符串（如一个对象的文档串）创建一个 DocTest 对象。

DocTestRunner : 执行 DocTest 中的用例，并使用 OutputChecker 来验证其输出。

OutputChecker : 将一个测试用例的实际输出与预期输出进行比较，并决定它们是否匹配。

这些处理类之间的关系总结在下图中:

                            list of:
+------+                   +---------+
|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results
+------+    |        ^     +---------+     |       ^    (printed)
            |        |     | Example |     |       |
            v        |     |   ...   |     v       |
           DocTestParser   | Example |   OutputChecker
                           +---------+

DocTest 对象

class doctest.DocTest(examples, globs, name, filename, lineno, docstring)

应该在单一命名空间中运行的doctest用例的集合。构造函数参数被用来初始化相同名称的属性。

DocTest 定义了以下属性。 它们由构造函数初始化，不应该被直接修改。

examples

一个 Example 对象的列表，它编码了应该由该测试运行的单个交互式 Python 用例。

globs

例子应该运行的命名空间（又称 globals ）。这是一个将名字映射到数值的字典。例子对名字空间的任何改变（比如绑定新的变量）将在测试运行后反映在 globs 中。

name

识别 DocTest 的字符串名称。 通常情况下，这是从测试中提取的对象或文件的名称。

filename

这个 DocTest 被提取的文件名；或者为 None，如果文件名未知，或者 DocTest 没有从文件中提取。

lineno

filename 中的行号，这个 DocTest 开始的地方，或者行号不可用时为 None。 这个行号相对于文件的开头来说是零的。

docstring

从测试中提取的字符串，或者如果字符串不可用，或者为 None ，如果测试没有从字符串中提取。

Example 对象

class doctest.Example(source, want, exc_msg=None, lineno=0, indent=0, options=None)

单个交互式用例，由一个 Python 语句及其预期输出组成。 构造函数参数被用来初始化相同名称的属性。

Example 定义了以下属性。 它们由构造函数初始化，不应该被直接修改。

source

一个包含该用例源码的字符串。 源码由一个 Python 语句组成，并且总是以换行结束；构造函数在必要时添加一个换行。

want

运行这个用例的源码的预期输出（可以是 stdout ，也可以是异常情况下的回溯）。 want 以一个换行符结束，除非没有预期的输出，在这种情况下它是一个空字符串。 构造函数在必要时添加一个换行。

exc_msg

用例产生的异常信息，如果这个例子被期望产生一个异常；或者为 None ，如果它不被期望产生一个异常。 这个异常信息与 traceback.format_exception_only() 的返回值进行比较。 exc_msg 以换行结束，除非是 None 。

lineno

包含本例的字符串中的行号，即本例的开始。 这个行号相对于包含字符串的开头来说是以零开始的。

indent

用例在包含字符串中的缩进，即在用例的第一个提示前有多少个空格字符。

options

一个从选项标志到 True 或 False 的字典映射，用于覆盖这个例子的默认选项。 任何不包含在这个字典中的选项标志都被保留为默认值（由 DocTestRunner 的 optionflags 指定）。默认情况下，没有选项被设置。

DocTestFinder 对象

class doctest.DocTestFinder(verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)

一个处理类，用于从一个给定的对象的 docstring 和其包含的对象的 docstring 中提取与之相关的 DocTest 。 DocTest 可以从模块、类、函数、方法、静态方法、类方法和属性中提取。

可选的参数 verbose 可以用来显示查找器搜索到的对象。 它的默认值是 False （无输出）。

可选的参数 parser 指定了 DocTestParser 对象（或一个可替换的对象），用于从文档串中提取 doctest 。

如果可选的参数 recurse 是 False ，那么 DocTestFinder.find() 将只检查给定的对象，而不是任何包含的对象。

如果可选参数 exclude_empty 为 False ，那么 DocTestFinder.find() 将包括对文档字符串为空的对象的测试。

DocTestFinder 定义了以下方法：

find(obj[, name][, module][, globs][, extraglobs])

返回 DocTest 的列表，该列表由 obj 的文档串或其包含的任何对象的文档串定义。

可选参数 name 指定了对象的名称；这个名称将被用来为返回的 DocTest 构建名称。 如果没有指定 name ，则使用 obj.__name__ 。

可选参数 module 是包含给定对象的模块。如果没有指定模块或者是 None ，那么测试查找器将试图自动确定正确的模块。 该对象被使用的模块：

作为一个默认的命名空间，如果没有指定 globs 。

为了防止 DocTestFinder 从其他模块导入的对象中提取 DocTest 。 (包含有除 module 以外的模块的对象会被忽略)。

找到包含该对象的文件名。

找到该对象在其文件中的行号。

如果 module 是 False ，将不会试图找到这个模块。 这是不明确的，主要用于测试 doctest 本身：如果 module 是 False ，或者是 None 但不能自动找到，那么所有对象都被认为属于（不存在的）模块，所以所有包含的对象将（递归地）被搜索到 doctest 。

每个 DocTest 的 globals 是由 globs 和 extraglobs 组合而成的（ extraglobs 的绑定覆盖 globs 的绑定）。 为每个 DocTest 创建一个新的 globals 字典的浅层拷贝。如果没有指定 globs ，那么它默认为模块的 __dict__ ，如果指定了或者为 {} ，则除外。 如果没有指定 extraglobs ，那么它默认为 {} 。

DocTestParser 对象

class doctest.DocTestParser

一个处理类，用于从一个字符串中提取交互式的用例，并使用它们来创建一个 DocTest 对象。

DocTestParser 定义了以下方法：

get_doctest(string, globs, name, filename, lineno)

从给定的字符串中提取所有的测试用例，并将它们收集到一个 DocTest 对象中。

globs 、 name 、 filename 和 lineno 是新的 DocTest 对象的属性。 更多信息请参见 DocTest 的文档。

get_examples(string, name='<string>')

从给定的字符串中提取所有的测试用例，并以 Example 对象列表的形式返回。 行数以 0 为基数。 可选参数 name 用于识别这个字符串的名称，只用于错误信息。

parse(string, name='<string>')

将给定的字符串分成用例和中间的文本，并以 Example 和字符串交替的列表形式返回。 Example 的行号以 0 为基数。 可选参数 name 用于识别这个字符串的名称，只用于错误信息。

DocTestRunner 对象

class doctest.DocTestRunner(checker=None, verbose=None, optionflags=0)

一个处理类，用于执行和验证 DocTest 中的交互式用例。

预期输出和实际输出之间的比较是由一个 OutputChecker 完成的。 这种比较可以用一些选项标志来定制；更多信息请看 选项标记 部分。 如果选项标志不够，那么也可以通过向构造函数传递 OutputChecker 的子类来定制比较。

测试运行器的显示输出可以通过两种方式控制。首先，一个输出函数可以被传递给 TestRunner.run() ；这个函数将被调用，并显示出应该显示的字符串。 它的默认值是 sys.stdout.write 。 如果捕获输出是不够的，那么也可以通过子类化 DocTestRunner 来定制显示输出，并重写 report_start() , report_success() , report_unexpected_exception() 和 report_failure() 方法。

可选的关键字参数 checker 指定了 OutputChecker 对象（或其相似替换），它应该被用来比较预期输出和 doctest 用例的实际输出。

可选的关键字参数 verbose 控制 DocTestRunner 的详细程度。 如果 verbose 是 True ，那么每个用例的信息都会被打印出来，当它正在运行时。 如果 verbose 是 False ，则只打印失败的信息。 当 verbose 没有指定，或者为 None ，如果使用了命令行开关 -v ，则使用verbose输出。

可选的关键字参数 optionflags 可以用来控制测试运行器如何比较预期输出和实际输出，以及如何显示失败。更多信息，请参见章节 选项标记 。

DocTestParser 定义了以下方法：

report_start(out, test, example)

报告测试运行器即将处理给定的用例。提供这个方法是为了让 DocTestRunner 的子类能够定制他们的输出；它不应该被直接调用。

example 是即将被处理的用。 test 是 包含用例 的测试。 out 是传递给 DocTestRunner.run() 的输出函数。

report_success(out, test, example, got)

报告给定的用例运行成功。 提供这个方法是为了让 DocTestRunner 的子类能够定制他们的输出；它不应该被直接调用。

example 是即将被处理的用例。 got 是这个例子的实际输出。 test 是包含 example 的测试。 out 是传递给 DocTestRunner.run() 的输出函数。

report_failure(out, test, example, got)

报告给定的用例运行失败。 提供这个方法是为了让 DocTestRunner 的子类能够定制他们的输出；它不应该被直接调用。

example 是即将被处理的用例。 got 是这个例子的实际输出。 test 是包含 example 的测试。 out 是传递给 DocTestRunner.run() 的输出函数。

report_unexpected_exception(out, test, example, exc_info)

报告给定的用例触发了一个异常。 提供这个方法是为了让 DocTestRunner 的子类能够定制他们的输出；它不应该被直接调用。

example 是将要被处理的用例。 exc_info 是一个元组，包含关于异常的信息（如由 sys.exc_info() 返回）。 test 是包含 example 的测试。 out 是传递给 DocTestRunner.run() 的输出函数。

run(test, compileflags=None, out=None, clear_globs=True)

在 test （一个 DocTest 对象）中运行这些用例，并使用写入函数 out 显示结果。

这些用例都是在命名空间 test.globs 中运行的。 如果 clear_globs 为 True （默认），那么这个命名空间将在测试运行后被清除，以帮助进行垃圾回收。如果你想在测试完成后检查命名空间，那么使用 clear_globs=False 。

compileflags 给出了 Python 编译器在运行例子时应该使用的标志集。如果没有指定，那么它将默认为适用于 globs 的 future-import 标志集。

每个用例的输出都使用 DocTestRunner 的输出检查器进行检查，结果由 DocTestRunner.report_*() 方法进行格式化。

summarize(verbose=None)

打印这个 DocTestRunner 运行过的所有测试用例的摘要，并返回一个 named tuple TestResults(failed, attempted) 。

可选的 verbose 参数控制摘要的详细程度。 如果没有指定 verbose ，那么将使用 DocTestRunner 的 verbose 。

OutputChecker 对象

class doctest.OutputChecker

一个用于检查测试用例的实际输出是否与预期输出相匹配的类。 OutputChecker 定义了两个方法： check_output() ，比较给定的一对输出，如果它们匹配则返回 True ； output_difference() ，返回一个描述两个输出之间差异的字符串。

OutputChecker 定义了以下方法：

check_output(want, got, optionflags)

如果一个用例的实际输出（ got ）与预期输出（ want ）匹配，则返回 True 。 如果这些字符串是相同的，总是被认为是匹配的；但是根据测试运行器使用的选项标志，也可能有几种非精确的匹配类型。 参见章节 选项标记 了解更多关于选项标志的信息。

output_difference(example, got, optionflags)

返回一个字符串，描述给定用例（ example ）的预期输出和实际输出（ got ）之间的差异。 optionflags 是用于比较 want 和 got 的选项标志集。

调试

Doctest 提供了几种调试 doctest 用例的机制：

有几个函数将测试转换为可执行的 Python 程序，这些程序可以在 Python 调试器， pdb 下运行。

DebugRunner 类是 DocTestRunner 的一个子类，它为第一个失败的用例触发一个异常，包含关于这个用例的信息。这些信息可以用来对这个用例进行事后调试。

由 DocTestSuite() 生成的 unittest 用例支持由 unittest.TestCase 定义的 debug() 方法，。

你可以在 doctest 的用例中加入对 pdb.set_trace() 的调用，当这一行被执行时，你会进入 Python 调试器。 然后你可以检查变量的当前值，等等。 例如，假设 a.py 只包含这个模块 docstring

"""
>>> def f(x):
...     g(x*2)
>>> def g(x):
...     print(x+3)
...     import pdb; pdb.set_trace()
>>> f(3)
9
"""

那么一个交互式Python会话可能是这样的:

>>> 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)
>>>

将测试转换为 Python 代码的函数，并可能在调试器下运行合成的代码:

doctest.script_from_examples(s)

将带有用例的文本转换为脚本。

参数 s 是一个包含测试用例的字符串。 该字符串被转换为 Python 脚本，其中 s 中的 doctest 用例被转换为常规代码，其他的都被转换为 Python 注释。 生成的脚本将以字符串的形式返回。例如，

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
"""))

显示:

# Set x and y to 1 and 2.
x, y = 1, 2
#
# Print their sum:
print(x+y)
# Expected:
## 3

这个函数在内部被其他函数使用（见下文），但当你想把一个交互式 Python 会话转化为 Python 脚本时，也会很有用。

doctest.testsource(module, name)

将一个对象的 doctest 转换为一个脚本。

参数 module 是一个模块对象，或者一个模块带点的名称，包含对其 doctest 感兴趣的对象。 参数 name 是具有感兴趣的测试的对象的名称（在模块中）。 结果是一个字符串，包含该对象的文本串转换为 Python 脚本，如上面 script_from_examples() 所述。 例如，如果模块 a.py 包含一个顶级函数 f() ，那么

import a, doctest
print(doctest.testsource(a, "a.f"))

打印函数 f() 的文档串的脚本版本，将测试转换为代码，其余部分放在注释中。

doctest.debug(module, name, pm=False)

对一个对象的 doctest 进行调试。

module 和 name 参数与上面函数 testsource() 的参数相同。 被命名对象的文本串的合成 Python 脚本被写入一个临时文件，然后该文件在 Python 调试器 pdb 的控制下运行。

module.__dict__ 的一个浅层拷贝被用于本地和全局的执行环境。

可选参数 pm 控制是否使用事后调试。 如果 pm 为 True ，则直接运行脚本文件，只有当脚本通过引发一个未处理的异常而终止时，调试器才会介入。如果是这样，就会通过 pdb.post_mortem() 调用事后调试，并传递未处理异常的跟踪对象。如果没有指定 pm ，或者是 False ，脚本将从一开始就在调试器下运行，通过传递一个适当的 exec() 调用给 pdb.run() 。

doctest.debug_src(src, pm=False, globs=None)

在一个字符串中调试 doctest 。

这就像上面的函数 debug() ，只是通过 src 参数，直接指定一个包含测试用例的字符串。

可选参数 pm 的含义与上述函数 debug() 的含义相同。

可选的参数 globs 给出了一个字典，作为本地和全局的执行环境。 如果没有指定，或者为 None ，则使用一个空的字典。如果指定，则使用字典的浅层拷贝。

DebugRunner 类，以及它可能触发的特殊异常，是测试框架作者最感兴趣的，在此仅作简要介绍。请看源代码，特别是 DebugRunner 的文档串（这是一个测试！）以了解更多细节。

class doctest.DebugRunner(checker=None, verbose=None, optionflags=0)

DocTestRunner 的一个子类，一旦遇到失败，就会触发一个异常。 如果一个意外的异常发生，就会引发一个 UnexpectedException 异常，包含测试、用例和原始异常。 如果输出不匹配，那么就会引发一个 DocTestFailure 异常，包含测试、用例和实际输出。

关于构造函数参数和方法的信息，请参见 DocTestRunner 部分的文档 高级 API 。

DebugRunner 实例可能会触发两种异常。

exception doctest.DocTestFailure(test, example, got)

DocTestRunner 触发的异常，表示一个 doctest 用例的实际输出与预期输出不一致。构造函数参数被用来初始化相同名称的属性。

DocTestFailure 定义了以下属性:

DocTestFailure.test

当该用例失败时正在运行的 DocTest 对象。

DocTestFailure.example

失败的 Example 。

DocTestFailure.got

用例的实际输出。

exception doctest.UnexpectedException(test, example, exc_info)

一个由 DocTestRunner 触发的异常，以提示一个 doctest 用例引发了一个意外的异常。 构造函数参数被用来初始化相同名称的属性。

UnexpectedException 定义了以下属性:

UnexpectedException.test

当该用例失败时正在运行的 DocTest 对象。

UnexpectedException.example

失败的 Example 。

UnexpectedException.exc_info

一个包含意外异常信息的元组，由 sys.ex_info() 返回。

肥皂盒

正如介绍中提到的， doctest 已经发展到有三个主要用途:

检查 docstring 中的用例。

回归测试。

可执行的文档/文字测试。

这些用途有不同的要求，区分它们是很重要的。特别是，用晦涩难懂的测试用例来填充你的文档字符串会使文档变得很糟糕。

在编写文档串时，要谨慎地选择文档串的用例。这是一门需要学习的艺术——一开始可能并不自然。用例应该为文档增加真正的价值。 一个好的用例往往可以抵得上许多文字。如果用心去做，这些用例对你的用户来说是非常有价值的，而且随着时间的推移和事情的变化，收集这些用例所花费的时间也会得到很多倍的回报。 我仍然惊讶于我的 doctest 用例在一个“无害”的变化后停止工作。

Doctest 也是回归测试的一个很好的工具，特别是如果你不吝啬解释的文字。 通过交错的文本和用例，可以更容易地跟踪真正的测试，以及为什么。当测试失败时，好的文本可以使你更容易弄清问题所在，以及如何解决。 的确，你可以在基于代码的测试中写大量的注释，但很少有程序员这样做。许多人发现，使用 doctest 方法反而能使测试更加清晰。 也许这只是因为 doctest 使写散文比写代码容易一些，而在代码中写注释则有点困难。 我认为它比这更深入：当写一个基于 doctest 的测试时，自然的态度是你想解释你的软件的细微之处，并用例子来说明它们。这反过来又自然地导致了测试文件从最简单的功能开始，然后逻辑地发展到复杂和边缘案例。 一个连贯的叙述是结果，而不是一个孤立的函数集合，似乎是随机的测试孤立的功能位。 这是一种不同的态度，产生不同的结果，模糊了测试和解释之间的区别。

回归测试最好限制在专用对象或文件中。 有几种组织测试的选择：

编写包含测试案例的文本文件作为交互式例子，并使用 testfile() 或 DocFileSuite() 来测试这些文件。 建议这样做，尽管对于新的项目来说是最容易做到的，从一开始就设计成使用 doctest 。

定义命名为 _regrtest_topic 的函数，由单个文档串组成，包含命名主题的测试用例。 这些函数可以包含在与模块相同的文件中，或分离出来成为一个单独的测试文件。

定义一个从回归测试主题到包含测试用例的文档串的 __test__ 字典映射。

当你把你的测试放在一个模块中时，这个模块本身就可以成为测试运行器。 当一个测试失败时，你可以安排你的测试运行器只重新运行失败的测试，同时调试问题。 下面是这样一个测试运行器的最小例子:

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("{} failures out of {} tests".format(fail, total))

备注

1

不支持同时包含预期输出和异常的用例。试图猜测一个在哪里结束，另一个在哪里开始，太容易出错了，而且这也会使测试变得混乱。

unittest --- 单元测试框架

源代码： Lib/unittest/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/unittest/__init__.py]

（如果你已经对测试的概念比较熟悉了，你可能想直接跳转到这一部分 断言方法。）

unittest 单元测试框架是受到 JUnit 的启发，与其他语言中的主流单元测试框架有着相似的风格。其支持测试自动化，配置共享和关机代码测试。支持将测试样例聚合到测试集中，并将测试与报告框架独立。

为了实现这些，unittest 通过面向对象的方式支持了一些重要的概念。

测试脚手架

test fixture 表示为了开展一项或多项测试所需要进行的准备工作，以及所有相关的清理操作。举个例子，这可能包含创建临时或代理的数据库、目录，再或者启动一个服务器进程。

测试用例

一个测试用例是一个独立的测试单元。它检查输入特定的数据时的响应。 unittest 提供一个基类： TestCase ，用于新建测试用例。

测试套件

test suite 是一系列的测试用例，或测试套件，或两者皆有。它用于归档需要一起执行的测试。

测试运行器（test runner）

test runner 是一个用于执行和输出测试结果的组件。这个运行器可能使用图形接口、文本接口，或返回一个特定的值表示运行测试的结果。

参见

doctest --- 文档测试模块

另一个风格完全不同的测试模块。

简单 Smalltalk 测试：便用模式 [https://web.archive.org/web/20150315073817/http://www.xprogramming.com/testfram.htm]

Kent Beck 有关使用 unittest 所共享的模式的测试框架的原创论文。

pytest [https://docs.pytest.org/]

第三方单元测试框架，提供轻量化的语法来编写测试，例如：assert func(10) == 42。

Python 测试工具分类 [https://wiki.python.org/moin/PythonTestingToolsTaxonomy]

一个 Python 测试工具的详细列表，包含测试框架和模拟对象库。

Python 中的测试 邮件列表

一个讨论 Python 中的测试和测试工具的特别兴趣小组。

随 Python 源代码分发的脚本 Tools/unittestgui/unittestgui.py 是一个一个用于发现和执行测试的用户图形界面工具。这主要是为了方便新手使用单元测试制作的。在生产环境中，测试应由一个持续集成（CI）系统运行，如 Buildbot [https://buildbot.net/], Jenkins [https://jenkins.io/] ，Travis-CI [https://travis-ci.com], 或 AppVeyor [https://www.appveyor.com/]。

基本实例

unittest 模块提供了一系列创建和运行测试的工具。这一段落演示了这些工具的一小部分，但也足以满足大部分用户的需求。

这是一段简短的代码，来测试三种字符串方法:

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'])
        # check that s.split fails when the separator is not a string
        with self.assertRaises(TypeError):
            s.split(2)

if __name__ == '__main__':
    unittest.main()

继承 unittest.TestCase 就创建了一个测试样例。上述三个独立的测试是三个类的方法，这些方法的命名都以 test 开头。 这个命名约定告诉测试运行者类的哪些方法表示测试。

每个测试的关键是：调用 assertEqual() 来检查预期的输出； 调用 assertTrue() 或 assertFalse() 来验证一个条件；调用 assertRaises() 来验证抛出了一个特定的异常。使用这些方法而不是 assert 语句是为了让测试运行者能聚合所有的测试结果并产生结果报告。

通过 setUp() 和 tearDown() 方法，可以设置测试开始前与完成后需要执行的指令。 在 组织你的测试代码 中，对此有更为详细的描述。

最后的代码块中，演示了运行测试的一个简单的方法。 unittest.main() 提供了一个测试脚本的命令行接口。当在命令行运行该测试脚本，上文的脚本生成如以下格式的输出:

...
----------------------------------------------------------------------
Ran 3 tests in 0.000s

OK

在调用测试脚本时添加 -v 参数使 unittest.main() 显示更为详细的信息，生成如以下形式的输出:

test_isupper (__main__.TestStringMethods) ... ok
test_split (__main__.TestStringMethods) ... ok
test_upper (__main__.TestStringMethods) ... ok

----------------------------------------------------------------------
Ran 3 tests in 0.001s

OK

以上例子演示了 unittest 中最常用的、足够满足许多日常测试需求的特性。文档的剩余部分详述该框架的完整特性。

命令行接口

unittest 模块可以通过命令行运行模块、类和独立测试方法的测试:

python -m unittest test_module1 test_module2
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method

你可以传入模块名、类或方法名或他们的任意组合。

同样的，测试模块可以通过文件路径指定:

python -m unittest tests/test_something.py

这样就可以使用 shell 的文件名补全指定测试模块。所指定的文件仍需要可以被作为模块导入。路径通过去除 '.py' 、把分隔符转换为 '.' 转换为模块名。若你需要执行不能被作为模块导入的测试文件，你需要直接执行该测试文件。

在运行测试时，你可以通过添加 -v 参数获取更详细（更多的冗余）的信息。

python -m unittest -v test_module

当运行时不包含参数，开始 探索性测试

python -m unittest

用于获取命令行选项列表：

python -m unittest -h

在 3.2 版更改: 在早期版本中，只支持运行独立的测试方法，而不支持模块和类。

命令行选项

unittest supports these command-line options:

-b, --buffer

在测试运行时，标准输出流与标准错误流会被放入缓冲区。成功的测试的运行时输出会被丢弃；测试不通过时，测试运行中的输出会正常显示，错误会被加入到测试失败信息。

-c, --catch

当测试正在运行时， Control-C 会等待当前测试完成，并在完成后报告已执行的测试的结果。当再次按下 Control-C 时，引发平常的 KeyboardInterrupt 异常。

See Signal Handling for the functions that provide this functionality.

-f, --failfast

当出现第一个错误或者失败时，停止运行测试。

-k

只运行匹配模式或子字符串的测试方法和类。 此选项可以被多次使用，在此情况下将会包括匹配任何给定模式的所有测试用例。

包含通配符（*）的模式使用 fnmatch.fnmatchcase() 对测试名称进行匹配。另外，该匹配是大小写敏感的。

模式对测试加载器导入的测试方法全名进行匹配。

例如，-k foo 可以匹配到 foo_tests.SomeTest.test_something 和 bar_tests.SomeTest.test_foo ，但是不能匹配到 bar_tests.FooTest.test_something 。

--locals

在回溯中显示局部变量。

3.2 新版功能: 添加命令行选项 -b, -c 和 -f 。

3.5 新版功能: 命令行选项 --locals 。

3.7 新版功能: 命令行选项 -k 。

命令行亦可用于探索性测试，以运行一个项目的所有测试或其子集。

探索性测试

3.2 新版功能.

Unittest支持简单的测试搜索。若需要使用探索性测试，所有的测试文件必须是 modules 或 packages （包括 namespace packages )并可从项目根目录导入（即它们的文件名必须是有效的 identifiers ）。

探索性测试在 TestLoader.discover() 中实现，但也可以通过命令行使用。它在命令行中的基本用法如下：

cd project_directory
python -m unittest discover

注解

方便起见， python -m unittest 与 python -m unittest discover 等价。如果你需要向探索性测试传入参数，必须显式地使用 discover 子命令。

discover 有以下选项：

-v, --verbose

更详细地输出结果。

-s, --start-directory directory

开始进行搜索的目录(默认值为当前目录 . )。

-p, --pattern pattern

用于匹配测试文件的模式（默认为 test*.py ）。

-t, --top-level-directory directory

指定项目的最上层目录（通常为开始时所在目录）。

-s ，-p 和 -t 选项可以按顺序作为位置参数传入。以下两条命令是等价的：

python -m unittest discover -s project_directory -p "*_test.py"
python -m unittest discover project_directory "*_test.py"

正如可以传入路径那样，传入一个包名作为起始目录也是可行的，如 myproject.subpackage.test 。你提供的包名会被导入，它在文件系统中的位置会被作为起始目录。

警告

探索性测试通过导入测试对测试进行加载。在找到所有你指定的开始目录下的所有测试文件后，它把路径转换为包名并进行导入。如 foo/bar/baz.py 会被导入为 foo.bar.baz 。

如果你有一个全局安装的包，并尝试对这个包的副本进行探索性测试，可能会从错误的地方开始导入。如果出现这种情况，测试会输出警告并退出。

如果你使用包名而不是路径作为开始目录，搜索时会假定它导入的是你想要的目录，所以你不会收到警告。

测试模块和包可以通过 load_tests protocol 自定义测试的加载和搜索。

在 3.4 版更改: 测试发现支持初始目录下的 命名空间包。注意你也需要指定顶层目录（例如：python -m unittest discover -s root/namespace -t root）。

组织你的测试代码

单元测试的构建单位是 test cases ：独立的、包含执行条件与正确性检查的方案。在 unittest 中，测试用例表示为 unittest.TestCase 的实例。通过编写 TestCase 的子类或使用 FunctionTestCase 编写你自己的测试用例。

一个 TestCase 实例的测试代码必须是完全自含的，因此它可以独立运行，或与其它任意组合任意数量的测试用例一起运行。

TestCase 的最简单的子类需要实现一个测试方法（例如一个命名以 test 开头的方法）以执行特定的测试代码：

import unittest

class DefaultWidgetSizeTestCase(unittest.TestCase):
    def test_default_widget_size(self):
        widget = Widget('The widget')
        self.assertEqual(widget.size(), (50, 50))

可以看到，为了进行测试，我们使用了基类 TestCase 提供的其中一个 assert*() 方法。若测试不通过，将会引发一个带有说明信息的异常，并且 unittest 会将这个测试用例标记为测试不通过。任何其它类型的异常将会被当做错误处理。

可能同时存在多个前置操作相同的测试，我们可以把测试的前置操作从测试代码中拆解出来，并实现测试前置方法 setUp() 。在运行测试时，测试框架会自动地为每个单独测试调用前置方法。

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')

注解

多个测试运行的顺序由内置字符串排序方法对测试名进行排序的结果决定。

在测试运行时，若 setUp() 方法引发异常，测试框架会认为测试发生了错误，因此测试方法不会被运行。

相似的，我们提供了一个 tearDown() 方法在测试方法运行后进行清理工作。

import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()

若 setUp() 成功运行，无论测试方法是否成功，都会运行 tearDown() 。

这样的一个测试代码运行的环境被称为 test fixture 。一个新的 TestCase 实例作为一个测试脚手架，用于运行各个独立的测试方法。在运行每个测试时，setUp() 、tearDown() 和 __init__() 会被调用一次。

推荐你根据用例所测试的功能将测试用 TestCase 分组。unittest 为此提供了 test suite：unittest 的 TestSuite 类是一个代表。通常情况下，调用 unittest.main() 就能正确地找到并执行这个模块下所有用 TestCase 分组的测试。

然而，如果你需要自定义你的测试套件的话，你可以参考以下方法组织你的测试：

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())

你可以把测试用例和测试套件放在与被测试代码相同的模块中（比如 widget.py），但将测试代码放在单独的模块中（比如 test_widget.py）有几个优势。

测试模块可以从命令行被独立调用。

更容易在分发的代码中剥离测试代码。

降低没有好理由的情况下修改测试代码以通过测试的诱惑。

测试代码应比被测试代码更少地被修改。

被测试代码可以更容易地被重构。

对用 C 语言写成的模块无论如何都得单独写成一个模块，为什么不保持一致呢？

如果测试策略发生了改变，没有必要修改源代码。

复用已有的测试代码

一些用户希望直接使用 unittest 运行已有的测试代码，而不需要把已有的每个测试函数转化为一个 TestCase 的子类。

因此， unittest 提供 FunctionTestCase 类。这个 TestCase 的子类可用于打包已有的测试函数，并支持设置前置与后置函数。

假定有一个测试函数：

def testSomething():
    something = makeSomething()
    assert something.name is not None
    # ...

可以创建等价的测试用例如下，其中前置和后置方法是可选的。

testcase = unittest.FunctionTestCase(testSomething,
                                     setUp=makeSomethingDB,
                                     tearDown=deleteSomethingDB)

注解

用 FunctionTestCase 可以快速将现有的测试转换成基于 unittest 的测试，但不推荐你这样做。花点时间继承 TestCase 会让以后重构测试无比轻松。

在某些情况下，现有的测试可能是用 doctest 模块编写的。 如果是这样， doctest 提供了一个 DocTestSuite 类，可以从现有基于 doctest 的测试中自动构建 unittest.TestSuite 用例。

跳过测试与预计的失败

3.1 新版功能.

Unittest 支持跳过单个或整组的测试用例。它还支持把测试标注成“预期失败”的测试。这些坏测试会失败，但不会算进 TestResult 的失败里。

要跳过测试只需使用 skip() decorator 或其附带条件的版本，在 setUp() 内部使用 TestCase.skipTest()，或是直接引发 SkipTest。

跳过测试的基本用法如下:

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):
        # Tests that work for only a certain version of the library.
        pass

    @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
    def test_windows_support(self):
        # windows specific testing code
        pass

    def test_maybe_skipped(self):
        if not external_resource_available():
            self.skipTest("external resource not available")
        # test code that depends on the external resource
        pass

在啰嗦模式下运行以上测试例子时，程序输出如下：

test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'
test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'
test_maybe_skipped (__main__.MyTestCase) ... skipped 'external resource not available'
test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'

----------------------------------------------------------------------
Ran 4 tests in 0.005s

OK (skipped=4)

跳过测试类的写法跟跳过测试方法的写法相似:

@unittest.skip("showing class skipping")
class MySkippedTestCase(unittest.TestCase):
    def test_not_run(self):
        pass

TestCase.setUp() 也可以跳过测试。可以用于所需资源不可用的情况下跳过接下来的测试。

使用 expectedFailure() 装饰器表明这个测试预计失败。:

class ExpectedFailureTestCase(unittest.TestCase):
    @unittest.expectedFailure
    def test_fail(self):
        self.assertEqual(1, 0, "broken")

你可以很容易地编写在测试时调用 skip() 的装饰器作为自定义的跳过测试装饰器。 下面这个装饰器会跳过测试，除非所传入的对象具有特定的属性:

def skipUnlessHasattr(obj, attr):
    if hasattr(obj, attr):
        return lambda func: func
    return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))

以下的装饰器和异常实现了跳过测试和预期失败两种功能：

@unittest.skip(reason)

跳过被此装饰器装饰的测试。 reason 为测试被跳过的原因。

@unittest.skipIf(condition, reason)

当 condition 为真时，跳过被装饰的测试。

@unittest.skipUnless(condition, reason)

跳过被装饰的测试，除非 condition 为真。

@unittest.expectedFailure

将测试标记为预期的失败或错误。 如果测试失败或在测试函数自身（而非在某个 test fixture 方法）中出现错误则将认为是测试成功。 如果测试通过，则将认为是测试失败。

exception unittest.SkipTest(reason)

引发此异常以跳过一个测试。

通常来说，你可以使用 TestCase.skipTest() 或其中一个跳过测试的装饰器实现跳过测试的功能，而不是直接引发此异常。

被跳过的测试的 setUp() 和 tearDown() 不会被运行。被跳过的类的 setUpClass() 和 tearDownClass() 不会被运行。被跳过的模组的 setUpModule() 和 tearDownModule() 不会被运行。

使用子测试区分测试迭代

3.4 新版功能.

当你的几个测试之间的差异非常小，例如只有某些形参不同时，unittest 允许你使用 subTest() 上下文管理器在一个测试方法体的内部区分它们。

例如，以下测试:

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)

可以得到以下输出:

======================================================================
FAIL: test_even (__main__.NumbersTest) (i=1)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 32, in test_even
    self.assertEqual(i % 2, 0)
AssertionError: 1 != 0

======================================================================
FAIL: test_even (__main__.NumbersTest) (i=3)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 32, in test_even
    self.assertEqual(i % 2, 0)
AssertionError: 1 != 0

======================================================================
FAIL: test_even (__main__.NumbersTest) (i=5)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 32, in test_even
    self.assertEqual(i % 2, 0)
AssertionError: 1 != 0

如果不使用子测试，程序遇到第一次错误之后就会停止。而且因为 i 的值不显示，错误也更难找。

======================================================================
FAIL: test_even (__main__.NumbersTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 32, in test_even
    self.assertEqual(i % 2, 0)
AssertionError: 1 != 0

类与函数

本节深入介绍了 unittest 的 API。

测试用例

class unittest.TestCase(methodName='runTest')

TestCase 类的实例代表了 unittest 宇宙中的逻辑测试单元。 该类旨在被当作基类使用，特定的测试将由其实体子类来实现。 该类实现了测试运行器所需的接口以允许它驱动测试，并实现了可被测试代码用来检测和报告各种类型的失败的方法。

每个 TestCase 实例将运行一个单位的基础方法：即名为 methodName 的方法。 在使用 TestCase 的大多数场景中，你都不需要修改 methodName 或重新实现默认的 runTest() 方法。

在 3.2 版更改: TestCase 不需要提供 methodName 即可成功实例化。 这使得从交互式解释器试验 TestCase 更为容易。

TestCase 的实例提供了三组方法：一组用来运行测试，另一组被测试实现用来检查条件和报告失败，还有一些查询方法用来收集有关测试本身的信息。

第一组（用于运行测试的）方法是：

setUp()

为测试预备而调用的方法。 此方法会在调用测试方法之前被调用；除了 AssertionError 或 SkipTest，此方法所引发的任何异常都将被视为错误而非测试失败。 默认的实现将不做任何事情。

tearDown()

在测试方法被调用并记录结果之后立即被调用的方法。 此方法即使在测试方法引发异常时仍会被调用，因此子类中的实现将需要特别注意检查内部状态。 除 AssertionError 或 SkipTest 外，此方法所引发的任何异常都将被视为额外的错误而非测试失败（因而会增加总计错误报告数）。 此方法将只在 setUp() 成功执行时被调用，无论测试方法的结果如何。 默认的实现将不做任何事情。

setUpClass()

在一个单独类中的测试运行之前被调用的类方法。 setUpClass 会被作为唯一的参数在类上调用且必须使用 classmethod() 装饰器:

@classmethod
def setUpClass(cls):
    ...

查看 Class and Module Fixtures 获取更详细的说明。

3.2 新版功能.

tearDownClass()

在一个单独类的测试完成运行之后被调用的类方法。 tearDownClass 会被作为唯一的参数在类上调用且必须使用 classmethod() 装饰器:

@classmethod
def tearDownClass(cls):
    ...

查看 Class and Module Fixtures 获取更详细的说明。

3.2 新版功能.

run(result=None)

运行测试，将结果收集至作为 result 传入的 TestResult。 如果 result 被省略或为 None，则会创建一个临时的结果对象（通过调用 defaultTestResult() 方法）并使用它。 结果对象会被返回给 run() 的调用方。

同样的效果也可通过简单地调用 TestCase 实例来达成。

在 3.3 版更改: 之前版本的 run 不会返回结果。 也不会对实例执行调用。

skipTest(reason)

在测试方法或 setUp() 执行期间调用此方法将跳过当前测试。 详情参见 跳过测试与预计的失败。

3.1 新版功能.

subTest(msg=None, **params)

返回一个上下文管理器以将其中的代码块作为子测试来执行。 可选的 msg 和 params 是将在子测试失败时显示的任意值，以便让你能清楚地标识它们。

一个测试用例可以包含任意数量的子测试声明，并且它们可以任意地嵌套。

查看 使用子测试区分测试迭代 获取更详细的信息。

3.4 新版功能.

debug()

运行测试而不收集结果。 这允许测试所引发的异常被传递给调用方，并可被用于支持在调试器中运行测试。

TestCase 类提供了一些断言方法用于检查并报告失败。 下表列出了最常用的方法（请查看下文的其他表来了解更多的断言方法）:

方法 | 检查对象 | 引入版本
assertEqual(a, b) | a == b |
assertNotEqual(a, b) | a != b |
assertTrue(x) | bool(x) is True |
assertFalse(x) | bool(x) is False |
assertIs(a, b) | a is b | 3.1
assertIsNot(a, b) | a is not b | 3.1
assertIsNone(x) | x is None | 3.1
assertIsNotNone(x) | x is not None | 3.1
assertIn(a, b) | a in b | 3.1
assertNotIn(a, b) | a not in b | 3.1
assertIsInstance(a, b) | isinstance(a, b) | 3.2
assertNotIsInstance(a, b) | not isinstance(a, b) | 3.2

这些断言方法都支持 msg 参数，如果指定了该参数，它将被用作测试失败时的错误消息 (另请参阅 longMessage)。 请注意将 msg 关键字参数传给 assertRaises(), assertRaisesRegex(), assertWarns(), assertWarnsRegex() 的前提是它们必须被用作上下文管理器。

assertEqual(first, second, msg=None)

测试 first 和 second 是否相等。 如果两个值的比较结果是不相等，则测试将失败。

此外，如果 first 和 second 的类型完全相同且属于 list, tuple, dict, set, frozenset 或 str 或者属于通过 addTypeEqualityFunc() 注册子类的类型则将会调用类型专属的相等判断函数以便生成更有用的默认错误消息 (另请参阅 类型专属方法列表)。

在 3.1 版更改: 增加了对类型专属的相等判断函数的自动调用。

在 3.2 版更改: 增加了 assertMultiLineEqual() 作为用于比较字符串的默认类型相等判断函数。

assertNotEqual(first, second, msg=None)

测试 first 和 second 是否不等。 如果两个值的比较结果是相等，则测试将失败。

assertTrue(expr, msg=None)

assertFalse(expr, msg=None)

测试 expr 是否为真值（或假值）。

请注意这等价于 bool(expr) is True 而不等价于 expr is True (后者要使用 assertIs(expr, True))。 当存在更专门的方法时也应避免使用此方法 (例如应使用 assertEqual(a, b) 而不是 assertTrue(a == b))，因为它们在测试失败时会提供更有用的错误消息。

assertIs(first, second, msg=None)

assertIsNot(first, second, msg=None)

测试 first 和 second 是 (或不是) 同一个对象。

3.1 新版功能.

assertIsNone(expr, msg=None)

assertIsNotNone(expr, msg=None)

测试 expr 是 (或不是) None。

3.1 新版功能.

assertIn(member, container, msg=None)

assertNotIn(member, container, msg=None)

测试 member 是 (或不是) container 的成员。

3.1 新版功能.

assertIsInstance(obj, cls, msg=None)

assertNotIsInstance(obj, cls, msg=None)

测试 obj 是 (或不是) cls (此参数可以为一个类或包含类的元组，即 isinstance() 所接受的参数) 的实例。 要检测是否为指定类型，请使用 assertIs(type(obj), cls)。

3.2 新版功能.

还可以使用下列方法来检查异常、警告和日志消息的产生:

方法 | 检查对象 | 引入版本
assertRaises(exc, fun, *args, **kwds) | fun(*args, **kwds) 引发了 exc |
assertRaisesRegex(exc, r, fun, *args, **kwds) | fun(*args, **kwds) 引发了 exc 并且消息可与正则表达式 r 相匹配 | 3.1
assertWarns(warn, fun, *args, **kwds) | fun(*args, **kwds) 引发了 warn | 3.2
assertWarnsRegex(warn, r, fun, *args, **kwds) | fun(*args, **kwds) 引发了 warn 并且消息可与正则表达式 r 相匹配 | 3.2
assertLogs(logger, level) | with 代码块在 logger 上使用了最小的 level 级别写入日志 | 3.4
assertNoLogs(logger, level) | with 代码块没有在 logger 上使用最小的 level 级别写入日志 | 3.10

assertRaises(exception, callable, *args, **kwds)

assertRaises(exception, *, msg=None)

测试当 callable 附带任何同时被传给 assertRaises() 的位置或关键字参数被调用时是否引发了异常。 如果引发了 exception 则测试通过，如果引发了另一个异常则报错，或者如果未引发任何异常则测试失败。 要捕获一组异常中的任何一个，可以将包含多个异常类的元组作为 exception 传入。

如果只给出了 exception 和可能的 msg 参数，则返回一个上下文管理器以便被测试的代码可以被写成内联形式而不是被写成函数:

with self.assertRaises(SomeException):
    do_something()

当被作为上下文管理器使用时，assertRaises() 接受额外的关键字参数 msg。

上下文管理器将把捕获的异常对象存入在其 exception 属性中。 这适用于需要对所引发异常执行额外检查的场合:

with self.assertRaises(SomeException) as cm:
    do_something()

the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)

在 3.1 版更改: 添加了将 assertRaises() 用作上下文管理器的功能。

在 3.2 版更改: 增加了 exception 属性。

在 3.3 版更改: 增加了 msg 关键字参数在作为上下文管理器时使用。

assertRaisesRegex(exception, regex, callable, *args, **kwds)

assertRaisesRegex(exception, regex, *, msg=None)

与 assertRaises() 类似但还会测试 regex 是否匹配被引发异常的字符串表示形式。 regex 可以是一个正则表达式对象或包含正则表达式的字符串以提供给 re.search() 使用。 例如:

self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",
                       int, 'XYZ')

或者：

with self.assertRaisesRegex(ValueError, 'literal'):
   int('XYZ')

3.1 新版功能: 以方法名 assertRaisesRegexp 添加。

在 3.2 版更改: 重命名为 assertRaisesRegex()。

在 3.3 版更改: 增加了 msg 关键字参数在作为上下文管理器时使用。

assertWarns(warning, callable, *args, **kwds)

assertWarns(warning, *, msg=None)

测试当 callable 附带任何同时被传给 assertWarns() 的位置或关键字参数被调用时是否触发了警告。 如果触发了 warning 则测试通过，否则测试失败。 引发任何异常则报错。 要捕获一组警告中的任何一个，可将包含多个警告类的元组作为 warnings 传入。

如果只给出了 warning 和可能的 msg 参数，则返回一个上下文管理器以便被测试的代码可以被写成内联形式而不是被写成函数:

with self.assertWarns(SomeWarning):
    do_something()

当被作为上下文管理器使用时，assertWarns() 接受额外的关键字参数 msg。

上下文管理器将把捕获的警告对象保存在其 warning 属性中，并把触发警告的源代码行保存在 filename 和 lineno 属性中。 这适用于需要对捕获的警告执行额外检查的场合:

with self.assertWarns(SomeWarning) as cm:
    do_something()

self.assertIn('myfile.py', cm.filename)
self.assertEqual(320, cm.lineno)

无论被调用时警告过滤器是否就位此方法均可工作。

3.2 新版功能.

在 3.3 版更改: 增加了 msg 关键字参数在作为上下文管理器时使用。

assertWarnsRegex(warning, regex, callable, *args, **kwds)

assertWarnsRegex(warning, regex, *, msg=None)

与 assertWarns() 类似但还会测试 regex 是否匹配被触发警告的消息文本。 regex 可以是一个正则表达式对象或包含正则表达式的字符串以提供给 re.search() 使用。 例如:

self.assertWarnsRegex(DeprecationWarning,
                      r'legacy_function\(\) is deprecated',
                      legacy_function, 'XYZ')

或者：

with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):
    frobnicate('/etc/passwd')

3.2 新版功能.

在 3.3 版更改: 增加了 msg 关键字参数在作为上下文管理器时使用。

assertLogs(logger=None, level=None)

一个上下文管理器，它测试在 logger 或其子对象上是否至少记录了一条至少为指定 level 以上级别的消息。

如果给出了 logger 则它应为一个 logging.Logger 对象或为一个指定日志记录器名称的 str。 默认为根日志记录器，它将捕获未被非传播型后继日志记录器所拦阻的所有消息。

如果给出了 level 则它应为一个用数字表示的日志记录级别或其字符串形式 (例如 "ERROR" 或 logging.ERROR)。 默认为 logging.INFO。

如果在 with 代码块内部发出了至少一条与 logger 和 level 条件相匹配的消息则测试通过，否则测试失败。

上下文管理器返回的对象是一个记录辅助器，它会记录所匹配的日志消息。 它有两个属性:

records

所匹配的日志消息 logging.LogRecord 对象组成的列表。

output

由 str 对象组成的列表，内容为所匹配消息经格式化后的输出。

示例:

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'])

3.4 新版功能.

assertNoLogs(logger=None, level=None)

一个上下文管理器，它测试在 logger 或其子对象上是否未记录任何至少为指定 level 以上级别的消息。

如果给出了 logger 则它应为一个 logging.Logger 对象或为一个指定日志记录器名称的 str。 默认为根日志记录器，它将捕获所有消息。

如果给出了 level 则它应为一个用数字表示的日志记录级别或其字符串形式 (例如 "ERROR" 或 logging.ERROR)。 默认为 logging.INFO。

与 assertLogs() 不同，上下文管理器将不返回任何对象。

3.10 新版功能.

还有其他一些方法可用于执行更专门的检查，例如:

方法 | 检查对象 | 引入版本
assertAlmostEqual(a, b) | round(a-b, 7) == 0 |
assertNotAlmostEqual(a, b) | round(a-b, 7) != 0 |
assertGreater(a, b) | a > b | 3.1
assertGreaterEqual(a, b) | a >= b | 3.1
assertLess(a, b) | a < b | 3.1
assertLessEqual(a, b) | a <= b | 3.1
assertRegex(s, r) | r.search(s) | 3.1
assertNotRegex(s, r) | not r.search(s) | 3.2
assertCountEqual(a, b) | a 和 b 具有同样数量的相同元素，无论其顺序如何。 | 3.2

assertAlmostEqual(first, second, places=7, msg=None, delta=None)

assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)

测试 first 与 second 是否几乎相等，比较的标准是计算差值并舍入到 places 所指定的十进制位数 (默认为 7 位)，再与零相比较。 请注意此方法是将结果值舍入到指定的 十进制位数 (即相当于 round() 函数) 而非 有效位数。

如果提供了 delta 而非 places 则 first 和 second 之间的差值必须小于等于 (或大于) delta。

同时提供 delta 和 places 将引发 TypeError。

在 3.2 版更改: assertAlmostEqual() 会自动将几乎相等的对象视为相等。 而如果对象相等则 assertNotAlmostEqual() 会自动测试失败。 增加了 delta 关键字参数。

assertGreater(first, second, msg=None)

assertGreaterEqual(first, second, msg=None)

assertLess(first, second, msg=None)

assertLessEqual(first, second, msg=None)

根据方法名分别测试 first 是否 >, >=, < 或 <= second。 如果不是，则测试失败:

>>> self.assertGreaterEqual(3, 4)
AssertionError: "3" unexpectedly not greater than or equal to "4"

3.1 新版功能.

assertRegex(text, regex, msg=None)

assertNotRegex(text, regex, msg=None)

测试一个 regex 搜索匹配（或不匹配） 文本。如果不匹配，错误信息中将包含匹配模式和 文本*（或部分匹配失败的 *文本）。regex 可以是正则表达式对象或能够用于 re.search() 的包含正则表达式的字符串。

3.1 新版功能: 以方法名 assertRegexpMatches 添加。

在 3.2 版更改: 方法 assertRegexpMatches() 已被改名为 assertRegex()。

3.2 新版功能: assertNotRegex()

3.5 新版功能: assertNotRegexpMatches 这个名字是 assertNotRegex() 的已被弃用的别名。

assertCountEqual(first, second, msg=None)

测试序列 first 与 second 是否包含同样的元素，无论其顺序如何。 当存在差异时，将生成一条错误消息来列出两个序列之间的差异。

重复的元素 不会 在 first 和 second 的比较中被忽略。 它会检查每个元素在两个序列中的出现次数是否相同。 等价于: assertEqual(Counter(list(first)), Counter(list(second))) 但还适用于包含不可哈希对象的序列。

3.2 新版功能.

assertEqual() 方法会将相同类型对象的相等性检查分派给不同的类型专属方法。 这些方法已被大多数内置类型所实现，但也可以使用 addTypeEqualityFunc() 来注册新的方法:

addTypeEqualityFunc(typeobj, function)

注册一个由 assertEqual() 调用的特定类型专属方法来检查恰好为相同 typeobj (而非子类) 的两个对象是否相等。 function 必须接受两个位置参数和第三个 msg=None 关键字参数，就像 assertEqual() 那样。 当检测到前两个形参之间不相等时它必须引发 self.failureException(msg) -- 可能还会提供有用的信息并在错误消息中详细解释不相等的原因。

3.1 新版功能.

以下是 assertEqual() 自动选用的不同类型的比较方法。一般情况下不需要直接在测试中调用这些方法。

方法 | 用作比较 | 引入版本
assertMultiLineEqual(a, b) | 字符串 | 3.1
assertSequenceEqual(a, b) | 序列 | 3.1
assertListEqual(a, b) | 列表 | 3.1
assertTupleEqual(a, b) | 元组 | 3.1
assertSetEqual(a, b) | 集合 | 3.1
assertDictEqual(a, b) | 字典 | 3.1

assertMultiLineEqual(first, second, msg=None)

测试多行字符串 first 是否与字符串 second 相等。 当不相等时将在错误消息中包括两个字符串之间差异的高亮显示。 此方法会在通过 assertEqual() 进行字符串比较时默认被使用。

3.1 新版功能.

assertSequenceEqual(first, second, msg=None, seq_type=None)

测试两个序列是否相等。 如果提供了 seq_type，则 first 和 second 都必须为 seq_type 的实例否则将引发失败。 如果两个序列不相等则会构造一个错误消息来显示两者之间的差异。

此方法不会被 assertEqual() 直接调用，但它会被用于实现 assertListEqual() 和 assertTupleEqual()。

3.1 新版功能.

assertListEqual(first, second, msg=None)

assertTupleEqual(first, second, msg=None)

测试两个列表或元组是否相等。 如果不相等，则会构造一个错误消息来显示两者之间的差异。 如果某个形参的类型不正确也会引发错误。 这些方法会在通过 assertEqual() 进行列表或元组比较时默认被使用。

3.1 新版功能.

assertSetEqual(first, second, msg=None)

测试两个集合是否相等。 如果不相等，则会构造一个错误消息来列出两者之间的差异。 此方法会在通过 assertEqual() 进行集合或冻结集合比较时默认被使用。

如果 first 或 second 没有 set.difference() 方法则测试失败。

3.1 新版功能.

assertDictEqual(first, second, msg=None)

测试两个字典是否相等。 如果不相等，则会构造一个错误消息来显示两个字典的差异。 此方法会在对 assertEqual() 的调用中默认被用来进行字典的比较。

3.1 新版功能.

最后 TestCase 还提供了以下的方法和属性:

fail(msg=None)

无条件地发出测试失败消息，附带错误消息 msg 或 None。

failureException

这个类属性给出测试方法所引发的异常。 如果某个测试框架需要使用专门的异常，并可能附带额外的信息，则必须子类化该类以便与框架“正常互动”。 这个属性的初始值为 AssertionError。

longMessage

这个类属性决定当将一个自定义失败消息作为 msg 参数传给一个失败的 assertXYY 调用时会发生什么。默认值为 True。 在此情况下，自定义消息会被添加到标准失败消息的末尾。 当设为 False 时，自定义消息会替换标准消息。

类设置可以通过在调用断言方法之前将一个实例属性 self.longMessage 赋值为 True 或 False 在单个测试方法中进行重载。

类设置会在每个测试调用之前被重置。

3.1 新版功能.

maxDiff

这个属性控制来自在测试失败时报告 diffs 的断言方法的 diffs 输出的最大长度。 它默认为 80*8 个字符。 这个属性所影响的断言方法有 assertSequenceEqual() (包括所有委托给它的序列比较方法), assertDictEqual() 以及 assertMultiLineEqual()。

将 maxDiff 设为 None 表示不限制 diffs 的最大长度。

3.2 新版功能.

测试框架可使用下列方法来收集测试的有关信息:

countTestCases()

返回此测试对象所提供的测试数量。 对于 TestCase 实例，该数量将总是为 1。

defaultTestResult()

返回此测试类所要使用的测试结果类的实例（如果未向 run() 方法提供其他结果实例）。

对于 TestCase 实例，该返回值将总是为 TestResult 的实例；TestCase 的子类应当在有必要时重写此方法。

id()

返回一个标识指定测试用例的字符串。 该返回值通常为测试方法的完整名称，包括模块名和类名。

shortDescription()

返回测试的描述，如果未提供描述则返回 None。 此方法的默认实现将在可用的情况下返回测试方法的文档字符串的第一行，或者返回 None。

在 3.1 版更改: 在 3.1 中已修改此方法将测试名称添加到简短描述中，即使存在文档字符串。 这导致了与单元测试扩展的兼容性问题因而在 Python 3.2 中将添加测试名称操作改到 TextTestResult 中。

addCleanup(function, /, *args, **kwargs)

在 tearDown() 之后添加了一个要调用的函数来清理测试期间所使用的资源。 函数将按它们被添加的相反顺序被调用 (LIFO)。 它们在调用时将附带它们被添加时传给 addCleanup() 的任何参数和关键字参数。

如果 setUp() 失败，即意味着 tearDown() 未被调用，则已添加的任何清理函数仍将被调用。

3.1 新版功能.

doCleanups()

此方法会在 tearDown() 之后，或者如果 setUp() 引发了异常则会在 setUp() 之后被调用。

它将负责调用由 addCleanup() 添加的所有清理函数。 如果你需要在 tearDown() 之前 调用清理函数则可以自行调用 doCleanups()。

doCleanups() 每次会弹出清理函数栈中的一个方法，因此它可以在任何时候被调用。

3.1 新版功能.

classmethod addClassCleanup(function, /, *args, **kwargs)

在Add a function to be called after tearDownClass() 之后添加了一个要调用的函数来清理测试类运行期间所使用的资源。 函数将按它们被添加的相反顺序被调用 (LIFO)。 它们在调用时将附带它们被添加时传给 addClassCleanup() 的任何参数和关键字参数。

如果 setUpClass() 失败，即意味着 tearDownClass() 未被调用，则已添加的任何清理函数仍将被调用。

3.8 新版功能.

classmethod doClassCleanups()

此方法会在 tearDownClass() 之后无条件地被调用，或者如果 setUpClass() 引发了异常则会在 setUpClass() 之后被调用。

它将负责访问由 addClassCleanup() 添加的所有清理函数。 如果你需要在 tearDownClass() 之前 调用清理函数则可以自行调用 doClassCleanups()。

doClassCleanups() 每次会弹出清理函数栈中的一个方法，因此它在任何时候被调用。

3.8 新版功能.

class unittest.IsolatedAsyncioTestCase(methodName='runTest')

这个类提供了与 TestCase 类似的 API 并也接受协程作为测试函数。

3.8 新版功能.

coroutine asyncSetUp()

为测试预备而调用的方法。 此方法会在 setUp() 之后被调用。 此方法将在调用测试方法之前立即被调用；除了 AssertionError 或 SkipTest，此方法所引发的任何异常都将被视为错误而非测试失败。 默认的实现将不做任何事情。

coroutine asyncTearDown()

在测试方法被调用并记录结果之后立即被调用的方法。 此方法会在 tearDown() 之前被调用。 此方法即使在测试方法引发异常时仍会被调用，因此子类中的实现将需要特别注意检查内部状态。 除 AssertionError 或 SkipTest 外，此方法所引发的任何异常都将被视为额外的错误而非测试失败（因而会增加总计错误报告数）。 此方法将只在 asyncSetUp() 成功执行时被调用，无论测试方法的结果如何。 默认的实现将不做任何事情。

addAsyncCleanup(function, /, *args, **kwargs)

此方法接受一个可被用作清理函数的协程。

run(result=None)

设置一个新的事件循环来运行测试，将结果收集至作为 result 传入的 TestResult。 如果 result 被省略或为 None，则会创建一个临时的结果对象（通过调用 defaultTestResult() 方法）并使用它。 结果对象会被返回给 run() 的调用方。 在测试结束时事件循环中的所有任务都将被取消。

一个显示先后顺序的例子:

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()

在运行测试之后，events 将会包含 ["setUp", "asyncSetUp", "test_response", "asyncTearDown", "tearDown", "cleanup"]。

class unittest.FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None)

这个类实现了 TestCase 的部分接口，允许测试运行方驱动测试，但不提供可被测试代码用来检查和报告错误的方法。 这个类被用于创建使用传统测试代码的测试用例，允许它被集成到基于 unittest 的测试框架中。

一些已被弃用的别名

由于历史原因，某些 TestCase 方法具有一个或几个已目前已弃用的别名。 下表列出了它们的正确名称和已弃用的别名:

方法名 | 已弃用的别名 | 已弃用的别名
assertEqual() | failUnlessEqual | assertEquals
assertNotEqual() | failIfEqual | assertNotEquals
assertTrue() | failUnless | assert_
assertFalse() | failIf |
assertRaises() | failUnlessRaises |
assertAlmostEqual() | failUnlessAlmostEqual | assertAlmostEquals
assertNotAlmostEqual() | failIfAlmostEqual | assertNotAlmostEquals
assertRegex() |  | assertRegexpMatches
assertNotRegex() |  | assertNotRegexpMatches
assertRaisesRegex() |  | assertRaisesRegexp

3.1 版后已移除: 在第二列中列出的 fail* 别名已经被弃用。

3.2 版后已移除: 在第三列中列出的 assert* 别名已经被弃用。

3.2 版后已移除: assertRegexpMatches 和 assertRaisesRegexp 已经被重命名为 assertRegex() 和 assertRaisesRegex()。

3.5 版后已移除: assertNotRegexpMatches 这个名称已被弃用并应改用 assertNotRegex()。

分组测试

class unittest.TestSuite(tests=())

这个类代表对单独测试用例和测试套件的聚合。 这个类提供给测试运行方所需的接口以允许其像任何其他测试用例一样运行。 运行一个 TestSuite 实例与对套件执行迭代来逐一运行每个测试的效果相同。

如果给出了 tests，则它必须是一个包含单独测试用例的可迭代对象或是将被用于初始构建测试套件的其他测试套件。 还有一些附加的方法会被提供用来在随后向测试集添加测试用例和测试套件。

TestSuite 对象的行为与 TestCase 对象很相似，区别在于它们并不会真正实现一个测试。 它们会被用来将测试聚合为多个要同时运行的测试分组。 还有一些附加的方法会被用来向 TestSuite 实例添加测试:

addTest(test)

向测试套件添加 TestCase 或 TestSuite。

addTests(tests)

将来自包含 TestCase 和 TestSuite 实例的可迭代对象的所有测试添加到这个测试套件。

这等价于对 tests 进行迭代，并为其中的每个元素调用 addTest()。

TestSuite 与 TestCase 共享下列方法:

run(result)

运行与这个套件相关联的测试，将结果收集到作为 result 传入的测试结果对象中。 请注意与 TestCase.run() 的区别，TestSuite.run() 必须传入结果对象。

debug()

运行与这个套件相关联的测试而不收集结果。 这允许测试所引发的异常被传递给调用方并可被用于支持在调试器中运行测试。

countTestCases()

返回此测试对象所提供的测试数量，包括单独的测试和子套件。

__iter__()

由 TestSuite 分组的测试总是可以通过迭代来访问。 其子类可以通过重载 __iter__() 来惰性地提供测试。 请注意此方法可在单个套件上多次被调用（例如在计数测试或相等性比较时），为此在 TestSuite.run() 之前重复迭代所返回的测试对于每次调用迭代都必须相同。 在 TestSuite.run() 之后，调用方不应继续访问此方法所返回的测试，除非调用方使用重载了 TestSuite._removeTestAtIndex() 的子类来保留对测试的引用。

在 3.2 版更改: 在较早的版本中 TestSuite 会直接访问测试而不是通过迭代，因此只重载 __iter__() 并不足以提供所有测试。

在 3.4 版更改: 在较早的版本中 TestSuite 会在 TestSuite.run() 之后保留对每个 TestCase 的引用。 其子类可以通过重载 TestSuite._removeTestAtIndex() 来恢复此行为。

在 TestSuite 对象的典型应用中，run() 方法是由 TestRunner 唤起而不是由最终用户测试来控制。

加载和运行测试

class unittest.TestLoader

TestLoader 类可被用来基于类和模块创建测试套件。 通常，没有必要创建该类的实例；unittest 模块提供了一个可作为 unittest.defaultTestLoader 共享的实例。 但是，使用子类或实例允许对某些配置属性进行定制。

TestLoader 对象具有下列属性:

errors

由在加载测试期间遇到的非致命错误组成的列表。 在任何时候都不会被加载方重围。 致命错误是通过相关方法引发一个异常来向调用方发出信号的。 非致命错误也是由一个将在运行时引发原始错误的合成测试来提示的。

3.5 新版功能.

TestLoader 对象具有下列方法:

loadTestsFromTestCase(testCaseClass)

返回一个包含在 TestCase 所派生的 testCaseClass 中的所有测试用例的测试套件。

会为每个由 getTestCaseNames() 指明的方法创建一个测试用例实例。 在默认情况下这些都是以 test 开头的方法名称。 如果 getTestCaseNames() 不返回任何方法，但 runTest() 方法已被实现，则会为该方法创建一个单独的测试用例。

loadTestsFromModule(module, pattern=None)

返回包含在给定模块中的所有测试用例的测试套件。 此方法会在 module 中搜索从派生自 TestCase 的类并为该类定义的每个测试方法创建一个类实例。

注解

虽然使用 TestCase 所派生的类的层级结构可以方便地共享配置和辅助函数，但在不打算直接实例化的基类上定义测试方法并不能很好地配合此方法使用。 不过，当配置有差异并且定义在子类当中时这样做还是有用处的。

如果一个模块提供了 load_tests 函数则它将被调用以加载测试。 这允许模块自行定制测试加载过程。 这就称为 load_tests protocol。 pattern 参数会被作为传给 load_tests 的第三个参数。

在 3.2 版更改: 添加了对 load_tests 的支持。

在 3.5 版更改: 未写入文档的非官方 use_load_tests 默认参数已被弃用并忽略，但是它仍然被接受以便向下兼容。 此方法现在还接受一个仅限关键字参数 pattern，它会被作为传给 load_tests 的第三个参数。

loadTestsFromName(name, module=None)

返回由给出了字符串形式规格描述的所有测试用例组成的测试套件。

描述名称 name 是一个“带点号的名称”，它可以被解析为一个模块、一个测试用例类、一个测试用例类内部的测试方法、一个 TestSuite 实例，或者一个返回 TestCase 或 TestSuite 实例的可调用对象。 这些检查将按在此列出的顺序执行；也就是说，一个可能的测试用例类上的方法将作为“一个测试用例内部的测试方法”而非作为“一个可调用对象”被选定。

举例来说，如果你有一个模块 SampleTests，其中包含一个派生自 TestCase 的类 SampleTestCase，其中包含三个测试方法 (test_one(), test_two() 和 test_three())。 则描述名称 'SampleTests.SampleTestCase' 将使此方法返回一个测试套件，它将运行全部三个测试方法。 使用描述名称 'SampleTests.SampleTestCase.test_two' 将使它返回一个测试套件，它将仅运行 test_two() 测试方法。 描述名称可以指向尚未被导入的模块和包；它们将作为附带影响被导入。

本模块可以选择相对于给定的 module 来解析 name。

在 3.5 版更改: 如果在遍历 name 时发生了 ImportError 或 AttributeError 则在运行时引发该错误的合成测试将被返回。 这些错误被包括在由 self.errors 所积累的错误中。

loadTestsFromNames(names, module=None)

类似于 loadTestsFromName()，但是接受一个名称序列而不是单个名称。 返回值是一个测试套件，它支持为每个名称所定义的所有测试。

getTestCaseNames(testCaseClass)

返回由 testCaseClass 中找到的方法名称组成的已排序的序列；这应当是 TestCase 的一个子类。

discover(start_dir, pattern='test*.py', top_level_dir=None)

通过从指定的开始目录向其子目录递归来找出所有测试模块，并返回一个包含该结果的 TestSuite 对象。 只有与 pattern 匹配的测试文件才会被加载。 （使用 shell 风格的模式匹配。） 只有可导入的模块名称（即有效的 Python 标识符）将会被加载。

所有测试模块都必须可以从项目的最高层级上导入。 如果起始目录不是最高层级目录则必须单独指明最高层级目录。

如果导入某个模块失败，比如因为存在语法错误，则会将其记录为单独的错误并将继续查找模块。 如果导入失败是因为引发了 SkipTest，则会将其记录为跳过而不是错误。

如果找到了一个包（即包含名为 __init__.py 的文件的目录），则将在包中查找 load_tests 函数。 如果存在此函数则将对其执行调用 package.load_tests(loader, tests, pattern)。 测试发现操作会确保在执行期间仅检查测试一次，即使 load_tests 函数本身调用了 loader.discover 也是如此。.

如果 load_tests 存在则发现操作 不会 对包执行递归处理，load_tests 将负责加载包中的所有测试。is responsible for loading all tests in the package.

模式特意地不被当作 loader 属性来保存以使包能够自己继续执行发现操作。 top_level_dir 则会被保存以使 load_tests 不需要将此参数传入到 loader.discover()。

start_dir 可以是一个带点号的名称或是一个目录。

3.2 新版功能.

在 3.4 版更改: 在导入时引发 SkipTest 的模块会被记录为跳过，而不是错误。

在 3.4 版更改: start_dir 可以是一个 命名空间包。

在 3.4 版更改: 路径在被导入之前会先被排序以使得执行顺序保持一致，即使下层文件系统的顺序不是取决于文件名的。

在 3.5 版更改: 现在 load_tests 会检查已找到的包，无论它们的路径是否与 pattern 匹配，因为包名称是无法与默认的模式匹配的。

TestLoader 的下列属性可通过子类化或在实例上赋值来配置:

testMethodPrefix

给出将被解读为测试方法的方法名称的前缀的字符串。 默认值为 'test'。

这会影响 getTestCaseNames() 以及所有 loadTestsFrom*() 方法。

sortTestMethodsUsing

将被用来在 getTestCaseNames() 以及所有 loadTestsFrom*() 方法中比较方法名称以便对它们进行排序。

suiteClass

根据一个测试列表来构造测试套件的可调用对象。 不需要结果对象上的任何方法。 默认值为 TestSuite 类。

这会影响所有 loadTestsFrom*() 方法。

testNamePatterns

由 Unix shell 风格通配符的测试名称模式组成的列表，供测试方法进行匹配以包括在测试套件中 （参见 -k 选项）。

如果该属性不为 None (默认值)，则将要包括在测试套件中的所有测试方法都必须匹配该列表中的某个模式。 请注意匹配总是使用 fnmatch.fnmatchcase()，因此不同于传给 -k 选项的模式，简单的子字符串模式将必须使用 * 通配符来进行转换。

这会影响所有 loadTestsFrom*() 方法。

3.7 新版功能.

class unittest.TestResult

这个类被用于编译有关哪些测试执行成功而哪些失败的信息。

存放一组测试的结果的 TestResult 对象。 TestCase 和 TestSuite 类将确保结果被正确地记录；测试创建者无须担心如何记录测试的结果。

建立在 unittest 之上的测试框架可能会想要访问通过运行一组测试所产生的 TestResult 对象用来报告信息；TestRunner.run() 方法是出于这个目的而返回 TestResult 实例的。

TestResult 实例具有下列属性，在检查运行一组测试的结果的时候很有用处。

errors

一个包含 TestCase 实例和保存了格式化回溯信息的字符串 2 元组的列表。 每个元组代表一个引发了非预期的异常的测试。

failures

一个包含 TestCase 实例和保存了格式化回溯信息的字符串 2 元组的列表。 每个元组代表一个使用 TestCase.assert*() 方法显式地发出失败信号的测试。

skipped

一个包含 2-tuples of TestCase 实例和保存了跳过测试原因的字符串 2 元组的列表。

3.1 新版功能.

expectedFailures

一个包含 TestCase 实例和保存了格式化回溯信息的 2 元组的列表。 每个元组代表测试用例的一个已预期的失败或错误。

unexpectedSuccesses

一个包含被标记为已预期失败，但却测试成功的 TestCase 实例的列表。

shouldStop

当测试的执行应当被 stop() 停止时则设为 True。

testsRun

目前已运行的测试的总数量。

buffer

如果设为真值，sys.stdout 和 sys.stderr 将在 startTest() 和 stopTest() 被调用之间被缓冲。 被收集的输出将仅在测试失败或发生错误时才会被回显到真正的 sys.stdout 和 sys.stderr。 任何输出还会被附加到失败/错误消息中。

3.2 新版功能.

failfast

如果设为真值则 stop() 将在首次失败或错误时被调用，停止测试运行。

3.2 新版功能.

tb_locals

如果设为真值则局部变量将被显示在回溯信息中。

3.5 新版功能.

wasSuccessful()

如果当前所有测试都已通过则返回 True，否则返回 False。

在 3.4 版更改: 如果有任何来自测试的 unexpectedSuccesses 被 expectedFailure() 装饰器所标记则返回 False。

stop()

此方法可被调用以提示正在运行的测试集要将 shouldStop 属性设为 True 来表示其应当被中止。 TestRunner 对象应当认同此旗标并返回而不再运行任何额外的测试。

例如，该特性会被 TextTestRunner 类用来在当用户从键盘发出一个中断信号时停止测试框架。 提供了 TestRunner 实现的交互式工具也可通过类似方式来使用该特性。

TestResult 类的下列方法被用于维护内部数据结构，并可在子类中被扩展以支持额外的报告需求。 这特别适用于构建支持在运行测试时提供交互式报告的工具。

startTest(test)

当测试用例 test 即将运行时被调用。

stopTest(test)

在测试用例 test 已经执行后被调用，无论其结果如何。

startTestRun()

在任何测试被执行之前被调用一次。

3.1 新版功能.

stopTestRun()

在所有测试被执行之后被调用一次。

3.1 新版功能.

addError(test, err)

当测试用例 test 引发了非预期的异常时将被调用。 err 是一个元组，其形式与 sys.exc_info() 的返回值相同: (type, value, traceback)。

默认实现会将一个元组 (test, formatted_err) 添加到实例的 errors 属性，其中 formatted_err 是派生自 err 的已格式化回溯信息。

addFailure(test, err)

当测试用例 test 发出了失败信号时将被调用。 err 是一个元组，其形式与 sys.exc_info() 的返回值相同: (type, value, traceback)。

默认实现会将一个元组 (test, formatted_err) 添加到实例的 failures 属性，其中 formatted_err 是派生自 err 的已格式化回溯信息。

addSuccess(test)

当测试用例 test 成功时被调用。

默认实现将不做任何操作。

addSkip(test, reason)

当测试用例 test 被跳过时将被调用。 reason 是给出的跳过测试的理由。

默认实现会将一个元组 (test, reason) 添加到实例的 skipped 属性。

addExpectedFailure(test, err)

当测试用例 test 失败或发生错误，但是使用了 expectedFailure() 装饰器来标记时将被调用。

默认实现会将一个元组 (test, formatted_err) 添加到实例的 expectedFailures 属性，其中 formatted_err 是派生自 err 的已格式化回溯信息。

addUnexpectedSuccess(test)

当测试用例 test 使用了was marked with the expectedFailure() 装饰器来标记，但是却执行成功时将被调用。

默认实现会将该测试添加到实例的 unexpectedSuccesses 属性。

addSubTest(test, subtest, outcome)

当一个子测试结束时将被调用。 test 是对应于该测试方法的测试用例。 subtest 是一个描述该子测试的 TestCase 实例。

如果 outcome 为 None，则该子测试执行成功。 否则，它将失败并引发一个异常，outcome 是一个元组，其形式与 sys.exc_info() 的返回值相同: (type, value, traceback)。

默认实现在测试结果为成功时将不做任何事，并会将子测试的失败记录为普通的失败。

3.4 新版功能.

class unittest.TextTestResult(stream, descriptions, verbosity)

TestResult 的一个具体实现，由 TextTestRunner 使用。

3.2 新版功能: 这个类在之前被命名为 _TextTestResult。 这个旧名字仍然作为别名存在，但已被弃用。

unittest.defaultTestLoader

用于分享的 TestLoader 类实例。 如果不需要自制 TestLoader，则可以使用该实例而不必重复创建新的实例。

class unittest.TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False)

一个将结果输出到流的基本测试运行器。 如果 stream 为默认的 None，则会使用 sys.stderr 作为输出流。 这个类具有一些配置形参，但实际上都非常简单。 运行测试套件的图形化应用程序应当提供替代实现。 这样的实现应当在添加新特性到 unittest 时接受 **kwargs 作为修改构造运行器的接口。

在默认情况下这个运行器会显示 DeprecationWarning, PendingDeprecationWarning, ResourceWarning 和 ImportWarning，即使它们 被默认忽略。 由 deprecated unittest methods 所导致的弃用警告也会被作为特例，并且当警告过滤器为 'default' 或 'always' 时，对于每个模块它们将仅显示一次，以避免过多的警告消息。 此种行为可使用 Python 的 -Wd 或 -Wa 选项 (参见 警告控制) 并让 warnings 保持为 None 来覆盖。

在 3.2 版更改: 增加了 warnings 参数。

在 3.2 版更改: 默认流会在实例化而不是在导入时被设为 sys.stderr。

在 3.5 版更改: 增加了 tb_locals 形参。

_makeResult()

此方法将返回由 run() 使用的 TestResult 实例。 它不应当被直接调用，但可在子类中被重载以提供自定义的 TestResult。

_makeResult() 会实例化传给 TextTestRunner 构造器的 resultclass 参数所指定的类或可迭代对象。 如果没有提供 resultclass 则默认为 TextTestResult。 结果类会使用以下参数来实例化:

stream, descriptions, verbosity

run(test)

此方法是 TextTestRunner 的主要公共接口。 此方法接受一个 TestSuite 或 TestCase 实例。 通过调用 _makeResult() 创建 TestResult 来运行测试并将结果打印到标准输出。

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 加载一组测试并运行它们的命令行程序；这主要是为了让测试模块能方便地执行。 此函数的最简单用法是在测试脚本末尾包括下列行:

if __name__ == '__main__':
    unittest.main()

你可以通过传入冗余参数运行测试以获得更详细的信息:

if __name__ == '__main__':
    unittest.main(verbosity=2)

defaultTest 参数是要运行的单个测试名称，或者如果未通过 argv 指定任何测试名称则是包含多个测试名称的可迭代对象。 如果未指定或为 None 且未通过 argv 指定任何测试名称，则会运行在 module 中找到的所有测试。

argv 参数可以是传给程序的选项列表，其中第一个元素是程序名。 如未指定或为 None，则会使用 sys.argv 的值。

testRunner 参数可以是测试运行器类或是其已创建的实例。 在默认情况下 main 会调用 sys.exit() 并附带一个退出码来指明测试运行是成功还是失败。

testLoader 参数必须是一个 TestLoader 实例，其默认值为 defaultTestLoader。

main 支持通过传入 exit=False 参数以便在交互式解释器中使用。 这将在标准输出中显示结果而不调用 sys.exit():

>>> from unittest import main
>>> main(module='test_module', exit=False)

failfast, catchbreak 和 buffer 形参的效果与同名的 command-line options 一致。

warnings 参数指定在运行测试时所应使用的 警告过滤器。 如果未指定，则默认的 None 会在将 -W 选项传给 python 命令时被保留 (参见 警告控制)，而在其他情况下将被设为 'default'。

调用 main 实际上将返回一个 TestProgram 类的实例。 这会把测试运行结果保存为 result 属性。

在 3.1 版更改: 增加了 exit 形参。

在 3.2 版更改: 增加了 verbosity, failfast, catchbreak, buffer 和 warnings 形参。

在 3.4 版更改: defaultTest 形参被修改为也接受一个由测试名称组成的迭代器。

load_tests 协议

3.2 新版功能.

模块或包可以通过实现一个名为 load_tests 的函数来定制在正常测试运行或测试发现期间要如何从中加载测试。

如果一个测试模块定义了 load_tests 则它将被 TestLoader.loadTestsFromModule() 调用并传入下列参数:

load_tests(loader, standard_tests, pattern)

其中 pattern 会通过 loadTestsFromModule 传入。 它的默认值为 None。

它应当返回一个 TestSuite。

loader 是执行载入操作的 TestLoader 实例。 standard_tests 是默认要从该模块载入的测试。 测试模块通常只需从标准测试集中添加或移除测试。 第三个参数是在作为测试发现的一部分载入包时使用的。

一个从指定 TestCase 类集合中载入测试的 load_tests 函数看起来可能是这样的:

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

如果发现操作是在一个包含包的目录中开始的，不论是通过命令行还是通过调用 TestLoader.discover()，则将在包 __init__.py 中检查 load_tests。 如果不存在此函数，则发现将在包内部执行递归，就像它是另一个目录一样。 在其他情况下，包中测试的发现操作将留给 load_tests 执行，它将附带下列参数被调用:

load_tests(loader, standard_tests, pattern)

这应当返回代表包中所有测试的 TestSuite。 (standard_tests 将只包含从 __init__.py 获取的测试。)

因为模式已被传入 load_tests 所以包可以自由地继续（还可能修改）测试发现操作。 针对一个测试包的 '无操作' load_tests 函数看起来是这样的:

def load_tests(loader, standard_tests, pattern):
    # top level directory cached on loader instance
    this_dir = os.path.dirname(__file__)
    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)
    standard_tests.addTests(package_tests)
    return standard_tests

在 3.5 版更改: 发现操作不会再检查包名称是否匹配 pattern，因为包名称不可能匹配默认的模式。

类与模块设定

类与模块设定是在 TestSuite 中实现的。 当测试套件遇到来自新类的测试时则来自之前的类（如果存在）的 tearDownClass() 会被调用，然后再调用来自新类的 setUpClass()。

类似地如果测试是来自之前的测试的另一个模块则来自之前模块的 tearDownModule 将被运行，然后再运行来自新模块的 setUpModule。

在所有测试运行完毕后最终的 tearDownClass 和 tearDownModule 将被运行。

请注意共享设定不适用于一些 [潜在的] 特性例如测试并行化并且它们会破坏测试隔离。 它们应当被谨慎地使用。

由 unittest 测试加载器创建的测试的默认顺序是将所有来自相同模块和类的测试归入相同分组。 这将导致 setUpClass / setUpModule (等) 对于每个类和模块都恰好被调用一次。 如果你将顺序随机化，以便使得来自不同模块和类的测试彼此相邻，那么这些共享的设定函数就可能会在一次测试运行中被多次调用。

共享的设定不适用与非标准顺序的套件。 对于不想支持共享设定的框架来说 BaseTestSuite 仍然可用。

如果在共享的设定函数中引发了任何异常则测试将被报告错误。 因为没有对应的测试实例，所以会创建一个 _ErrorHolder 对象（它具有与 TestCase 相同的接口）来代表该错误。 如果你只是使用标准 unittest 测试运行器那么这个细节并不重要，但是如果你是一个框架开发者那么这可能会有关系。

setUpClass 和 tearDownClass

这些必须被实现为类方法:

import unittest

class Test(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls._connection = createExpensiveConnectionObject()

    @classmethod
    def tearDownClass(cls):
        cls._connection.destroy()

如果你希望在基类上的 setUpClass 和 tearDownClass 被调用则你必须自己去调用它们。 在 TestCase 中的实现是空的。

如果在 setUpClass 中引发了异常则类中的测试将不会被运行并且 tearDownClass 也不会被运行。 跳过的类中的 setUpClass 或 tearDownClass 将不会被运行。 如果引发的异常是 SkipTest 异常则类将被报告为已跳过而非发生错误。

setUpModule 和 tearDownModule

这些应当被实现为函数:

def setUpModule():
    createConnection()

def tearDownModule():
    closeConnection()

如果在 setUpModule 中引发了异常则模块中的任何测试都将不会被运行并且 tearDownModule 也不会被运行。 如果引发的异常是 SkipTest 异常则模块将被报告为已跳过而非发生错误。

要添加即使在发生异常时也必须运行的清理代码，请使用 addModuleCleanup:

unittest.addModuleCleanup(function, /, *args, **kwargs)

在 tearDownModule() 之后添加一个要调用的函数来清理测试类运行期间所使用的资源。 函数将按它们被添加的相反顺序被调用 (LIFO)。 它们在调用时将附带它们被添加时传给 addModuleCleanup() 的任何参数和关键字参数。

如果 setUpModule() 失败，即意味着 tearDownModule() 未被调用，则已添加的任何清理函数仍将被调用。

3.8 新版功能.

unittest.doModuleCleanups()

此函数会在 tearDownModule() 之后无条件地被调用，或者如果 setUpModule() 引发了异常则会在 setUpModule() 之后被调用。

它将负责调用由It is responsible for calling all the cleanup functions added by addModuleCleanup() 添加的所有清理函数。 如果你需要在 tearDownModule() 之前 调用清理函数则可以自行调用 doModuleCleanups()。

doModuleCleanups() 每次会弹出清理函数栈中的一个方法，因此它可以在任何时候被调用。

3.8 新版功能.

信号处理

3.2 新版功能.

unittest 的 -c/--catch 命令行选项，加上 unittest.main() 的 catchbreak 形参，提供了在测试运行期间处理 control-C 的更友好方式。 在捕获中断行为被启用时 control-C 将允许当前运行的测试能够完成，而测试运行将随后结束并报告已有的全部结果。 第二个 control-C 将会正常地引发 KeyboardInterrupt。

处理 control-C 信号的处理器会尝试与安装了自定义 signal.SIGINT 处理器的测试代码保持兼容。 如果是 unittest 处理器而 不是 已安装的 signal.SIGINT 处理器被调用，即它被系统在测试的下层替换并委托处理，则它会调用默认的处理器。 这通常会是替换了已安装处理器并委托处理的代码所预期的行为。 对于需要禁用 unittest control-C 处理的单个测试则可以使用 removeHandler() 装饰器。

还有一些工具函数让框架开发者可以在测试框架内部启用 control-C 处理功能。

unittest.installHandler()

安装 control-C 处理器。 当接收到 signal.SIGINT 时（通常是响应用户按下 control-C）所有已注册的结果都会执行 stop() 调用。

unittest.registerResult(result)

注册一个 TestResult 对象用于 control-C 的处理。 注册一个结果将保存指向它的弱引用，因此这并不能防止结果被作为垃圾回收。

如果 control-C 未被启用则注册 TestResult 对象将没有任何附带影响，因此不论是否启用了该项处理测试框架都可以无条件地注册他们独立创建的所有结果。

unittest.removeResult(result)

移除一个已注册的结果。 一旦结果被移除则 stop() 将不再会作为针对 control-C 的响应在结果对象上被调用。

unittest.removeHandler(function=None)

当不附带任何参数被调用时此函数将移除已被安装的 control-C 处理器。 此函数还可被用作测试装饰器以在测试被执行时临时性地移除处理器:

@unittest.removeHandler
def test_signal_handling(self):
    ...

unittest.mock --- 模拟对象库

3.3 新版功能.

源代码： Lib/unittest/mock.py [https://github.com/python/cpython/tree/3.10/Lib/unittest/mock.py]

unittest.mock 是一个用于测试的Python库。它允许使用模拟对象来替换受测系统的一些部分，并对这些部分如何被使用进行断言判断。

unittest.mock 提供的 Mock 类，能在整个测试套件中模拟大量的方法。创建后，就可以断言调用了哪些方法/属性及其参数。还可以以常规方式指定返回值并设置所需的属性。

此外，mock 还提供了用于修补测试范围内模块和类级别属性的 patch() 装饰器，和用于创建独特对象的 sentinel 。 阅读 quick guide 中的案例了解如何使用 Mock ，MagicMock 和 patch() 。

mock 被设计为配合 unittest 使用且它是基于 'action -> assertion' 模式而非许多模拟框架所使用的 'record -> replay' 模式。

在 Python 的早期版本要单独使用 unittest.mock ，在 PyPI 获取 mock [https://pypi.org/project/mock] 。

快速上手

当您访问对象时， Mock 和 MagicMock 将创建所有属性和方法，并保存他们在使用时的细节。你可以通过配置，指定返回值或者限制可访问属性，然后断言他们如何被调用：

>>> 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')

通过 side_effect 设置副作用(side effects) ，可以是一个 mock 被调用时抛出的异常：

>>> mock = Mock(side_effect=KeyError('foo'))
>>> mock()
Traceback (most recent call last):
 ...
KeyError: 'foo'

>>> 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)

Mock 还可以通过其他方法配置和控制其行为。例如 mock 可以通过设置 spec 参数来从一个对象中获取其规格(specification)。如果访问 mock 的属性或方法不在 spec 中，会报 AttributeError 错误。

使用 patch() 装饰去/上下文管理器，可以更方便地测试一个模块下的类或对象。你指定的对象会在测试过程中替换成 mock （或者其他对象），测试结束后恢复。

>>> 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()

注解

当你嵌套 patch 装饰器时，mock 将以执行顺序传递给装饰器函数（Python 装饰器正常顺序）。由于从下至上，因此在上面的示例中，首先 mock 传入的 module.ClassName1 。

在查找对象的名称空间中修补对象使用 patch() 。使用起来很简单，阅读 在哪里打补丁 来快速上手。

patch() 也可以 with 语句中使用上下文管理。

>>> 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)

还有一个 patch.dict() 用于在一定范围内设置字典中的值，并在测试结束时将字典恢复为其原始状态：

>>> foo = {'key': 'value'}
>>> original = foo.copy()
>>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True):
...     assert foo == {'newkey': 'newvalue'}
...
>>> assert foo == original

Mock支持 Python 魔术方法 。使用模式方法最简单的方式是使用 MagicMock class. 。它可以做如下事情：

>>> mock = MagicMock()
>>> mock.__str__.return_value = 'foobarbaz'
>>> str(mock)
'foobarbaz'
>>> mock.__str__.assert_called_with()

Mock 能指定函数（或其他 Mock 实例）为魔术方法，它们将被适当地调用。 MagicMock 是预先创建了所有魔术方法（所有有用的方法） 的 Mock 。

下面是一个使用了普通 Mock 类的魔术方法的例子

>>> mock = Mock()
>>> mock.__str__ = Mock(return_value='wheeeeee')
>>> str(mock)
'wheeeeee'

使用 auto-speccing 可以保证测试中的模拟对象与要替换的对象具有相同的api 。在 patch 中可以通过 autospec 参数实现自动推断，或者使用 create_autospec() 函数。自动推断会创建一个与要替换对象相同的属相和方法的模拟对象，并且任何函数和方法（包括构造函数）都具有与真实对象相同的调用签名。

这么做是为了因确保不当地使用 mock 导致与生产代码相同的失败：

>>> 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: <lambda>() takes exactly 3 arguments (1 given)

在类中使用 create_autospec() 时，会复制 __init__ 方法的签名，另外在可调用对象上使用时，会复制 __call__ 方法的签名。

Mock 类

Mock 是一个可以灵活的替换存根 (stubs) 的对象，可以测试所有代码。 Mock 是可调用的，在访问其属性时创建一个新的 mock 1 。访问相同的属性只会返回相同的 mock 。 Mock 会保存调用记录，可以通过断言获悉代码的调用。

MagicMock 是 Mock 的子类，它有所有预创建且可使用的魔术方法。在需要模拟不可调用对象时，可以使用 NonCallableMock  和 NonCallableMagicMock

patch() 装饰器使得用 Mock 对象临时替换特定模块中的类非常方便。 默认情况下 patch() 将为你创建一个 MagicMock。 你可以使用 patch() 的 new_callable 参数指定替代 Mock 的类。

class unittest.mock.Mock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

创建一个新的 Mock 对象。通过可选参数指定 Mock 对象的行为：

spec: 可以是要给字符串列表，也可以是充当模拟对象规范的现有对象（类或实例）。如果传入一个对象，则通过在该对象上调用 dir 来生成字符串列表（不支持的魔法属性和方法除外）。访问不在此列表中的任何属性都将触发 AttributeError 。

如果 spec 是一个对象（而不是字符串列表），则 __class__ 返回 spec 对象的类。 这允许模拟程序通过 isinstance() 测试。

spec_set ：spec 的更严格的变体。如果使用了该属性，尝试模拟 set 或 get 的属性不在 spec_set 所包含的对象中时，会抛出 AttributeError 。

side_effect ：每当调用 Mock 时都会调用的函数。 参见 side_effect 属性。 对于引发异常或动态更改返回值很有用。 该函数使用与 mock 函数相同的参数调用，并且除非返回 DEFAULT ，否则该函数的返回值将用作返回值。

另外， side_effect 可以是异常类或实例。 此时，调用模拟程序时将引发异常。

如果 side_effect 是可迭代对象，则每次调用 mock 都将返回可迭代对象的下一个值。

设置 side_effect 为 None 即可清空。

return_value ：调用 mock 的返回值。 默认情况下，是一个新的Mock（在首次访问时创建）。 参见 return_value 属性 。

unsafe ：默认情况下，访问任何名字以 assert, assret, asert, aseert 或 assrt 开头的属性都将引发 AttributeError。 传入 unsafe=True 将允许访问这些属性。

3.5 新版功能.

wraps ：要包装的 mock 对象。 如果 wraps 不是 None ，那么调用 Mock 会将调用传递给 wraps 的对象（返回实际结果）。 对模拟的属性访问将返回一个 Mock 对象，该对象包装了 wraps 对象的相应属性（因此，尝试访问不存在的属性将引发 AttributeError ）。

如果明确指定 return_value ，则调用时不会返回包装对象，而是返回 return_value 。

name ：mock 的名称。 在调试时很有用。 名称会传递到子 mock 。

还可以使用任意关键字参数来调用 mock 。 创建模拟后，将使用这些属性来设置 mock 的属性。 有关详细信息，请参见 configure_mock() 方法。

assert_called()

断言 mock 已被调用至少一次。

>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called()

3.6 新版功能.

assert_called_once()

断言 mock 已被调用恰好一次。

>>> 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.

3.6 新版功能.

assert_called_with(*args, **kwargs)

此方法是断言上次调用已以特定方式进行的一种便捷方法：

>>> mock = Mock()
>>> mock.method(1, 2, 3, test='wow')
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_with(1, 2, 3, test='wow')

assert_called_once_with(*args, **kwargs)

断言 mock 已被调用恰好一次，并且向该调用传入了指定的参数。

>>> 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.

assert_any_call(*args, **kwargs)

断言 mock 已被调用并附带了指定的参数。

如果 mock 曾经 被调用过则断言通过，不同于 assert_called_with() 和 assert_called_once_with() 那样只有在调用是最近的一次时才会通过，而对于 assert_called_once_with() 则它还必须是唯一的一次调用。

>>> mock = Mock(return_value=None)
>>> mock(1, 2, arg='thing')
>>> mock('some', 'thing', 'else')
>>> mock.assert_any_call(1, 2, arg='thing')

assert_has_calls(calls, any_order=False)

断言 mock 已附带指定的参数被调用。 将针对这些调用检查 mock_calls 列表。

如果 any_order 为假值则调用必须是顺序进行的。 在指定的调用之前或之后还可以有额外的调用。

如果 any_order 为真值则调用可以是任意顺序的，但它们都必须在 mock_calls 中出现。

>>> 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)

assert_not_called()

断言 mock 从未被调用过。

>>> 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.

3.5 新版功能.

reset_mock(*, return_value=False, side_effect=False)

reset_mock 方法将在 mock 对象上重围所有的调用属性:

>>> mock = Mock(return_value=None)
>>> mock('hello')
>>> mock.called
True
>>> mock.reset_mock()
>>> mock.called
False

在 3.6 版更改: 向 reset_mock 函数添加了两个仅限关键字参数。

这在你想要创建一系列重用相同对象的断言时会很有用处。 请注意 reset_mock() 不会 清除返回值、side_effect 或任何你使用普通赋值所默认设置的子属性。 如果你想要重置 return_value 或 side_effect，则要为相应的形参传入 True。 子 mock 和返回值 mock (如果有的话) 也会被重置。

注解

return_value，以及 side_effect 均为仅限关键字参数。

mock_add_spec(spec, spec_set=False)

为 mock 添加描述。 spec 可以是一个对象或字符串列表。 只有 spec 上的属性可以作为来自 mock 的属性被获取。

如果 spec_set 为真值则只有 spec 上的属性可以被设置。

attach_mock(mock, attribute)

附加一个 mock 作为这一个的属性，替换它的名称和上级。 对附加 mock 的调用将记录在这一个的 method_calls 和 mock_calls 属性中。

configure_mock(**kwargs)

通过关键字参数在 mock 上设置属性。

属性加返回值和附带影响可以使用标准点号标记在子 mock 上设置并在方法调用中解包一个字典:

>>> 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

同样的操作可在对 mock 的构造器调用中达成:

>>> 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

configure_mock() 的存在是使得 mock 被创建之后的配置更为容易。

__dir__()

Mock 对象会将 dir(some_mock) 的结果限制为有用结果。 对于带有 spec 的 mock 这还包括 mock 的所有被允许的属性。

请查看 FILTER_DIR 了解此过滤做了什么，以及如何停用它。

_get_child_mock(**kw)

创建针对属性和返回值的子 mock。 默认情况下子 mock 将为与其上级相同的类型。 Mock 的子类可能需要重载它来定制子 mock 的创建方式。

对于非可调用的 mock 将会使用可调用的变化形式（而非不是任意的自定义子类）。

called

一个表示 mock 对象是否已被调用的布尔值:

>>> mock = Mock(return_value=None)
>>> mock.called
False
>>> mock()
>>> mock.called
True

call_count

一个告诉你 mock 对象已被调用多少次的整数值:

>>> mock = Mock(return_value=None)
>>> mock.call_count
0
>>> mock()
>>> mock()
>>> mock.call_count
2

return_value

设置这个来配置通过调用该 mock 所返回的值:

>>> mock = Mock()
>>> mock.return_value = 'fish'
>>> mock()
'fish'

默认的返回值是一个 mock 对象并且你可以通过正常方式来配置它:

>>> mock = Mock()
>>> mock.return_value.attribute = sentinel.Attribute
>>> mock.return_value()
<Mock name='mock()()' id='...'>
>>> mock.return_value.assert_called_with()

return_value 也可以在构造器中设置:

>>> mock = Mock(return_value=3)
>>> mock.return_value
3
>>> mock()
3

side_effect

这可以是当该This can either be a function to be called when the mock 被调用时将被调用的一个函数，可调用对象或者要被引发的异常（类或实例）。

如果你传入一个函数则它将附带与该 mock 相同的参数被调用并且除了该函数返回 DEFAULT 单例的情况以外对该 mock 的调用都将随后返回该函数所返回的任何东西。 如果该函数返回 DEFAULT 则该 mock 将返回其正常值 (来自 return_value)。

如果你传入一个可迭代对象，它会被用来获取一个在每次调用时必须产生一个值的迭代器。 这个值可以是一个要被引发的异常实例，或是一个要从该调用返回给 mock 的值 (DEFAULT 处理与函数的情况一致)。

一个引发异常（来测试 API 的异常处理）的 mock 的示例:

>>> mock = Mock()
>>> mock.side_effect = Exception('Boom!')
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!

使用 side_effect 来返回包含多个值的序列:

>>> mock = Mock()
>>> mock.side_effect = [3, 2, 1]
>>> mock(), mock(), mock()
(3, 2, 1)

使用一个可调用对象:

>>> mock = Mock(return_value=3)
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> mock.side_effect = side_effect
>>> mock()
3

side_effect 可以在构造器中设置。 下面是在 mock 被调用时增加一个该属性值并返回它的例子:

>>> side_effect = lambda value: value + 1
>>> mock = Mock(side_effect=side_effect)
>>> mock(3)
4
>>> mock(-8)
-7

将 side_effect 设为 None 可以清除它:

>>> m = Mock(side_effect=KeyError, return_value=3)
>>> m()
Traceback (most recent call last):
 ...
KeyError
>>> m.side_effect = None
>>> m()
3

call_args

这可以是 None (如果 mock 没有被调用)，或是 mock 最近一次被调用时附带的参数。 这将采用元组的形式：第一个成员也可以通过 args 特征属性来访问，它是 mock 被调用时所附带的任何位置参数 (或为空元组)，而第二个成员也可以通过 kwargs 特征属性来访问，它则是任何关键字参数 (或为空字典)。

>>> 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!'}

call_args，以及列表 call_args_list, method_calls 和 mock_calls 的成员都是 call 对象。 这些对象属性元组，因此它们可被解包以获得单独的参数并创建更复杂的断言。 参见 作为元组的 call。

在 3.8 版更改: 增加了 args 和 kwargs 特征属性。properties.

call_args_list

这是一个已排序的对 mock 对象的所有调用的列表（因此该列表的长度就是它已被调用的次数）。 在执行任何调用之前它将是一个空列表。 call 对象可以被用来方便地构造调用列表以与 call_args_list 相比较。

>>> 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

call_args_list 的成员均为 call 对象。 它们可作为元组被解包以获得单个参数。 参见 作为元组的 call。

method_calls

除了会追踪对其自身的调用，mock 还会追踪对方法和属性，以及 它们的 方法和属性的访问:

>>> 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()]

method_calls 的成员均为 call 对象。 它们可以作为元组被解包以获得单个参数。 参见 作为元组的 call。

mock_calls

mock_calls 会记录 所有 对 mock 对象、它的方法、魔术方法的调用 以及 返回值的 mock。

>>> 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

mock_calls 的成员均为 call 对象。 它们可以作为元组被解包以获得单个参数。 参见 作为元组的 call。

注解

mock_calls 的记录方式意味着在进行嵌套调用时，之前调用的形参不会被记录因而这样的比较将总是相等:

>>> 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

__class__

通常一个对象的 __class__ 属性将返回其类型。 对于具有 spec 的 mock 对象来说，__class__ 将改为返回 spec 类。 这将允许 mock 对象为它们所替换 / 屏蔽的对象跳过 isinstance() 测试:

>>> mock = Mock(spec=3)
>>> isinstance(mock, int)
True

__class__ 是可以被赋值的，这将允许 mock 跳过 isinstance() 检测而不强制要求你使用 spec:

>>> mock = Mock()
>>> mock.__class__ = dict
>>> isinstance(mock, dict)
True

class unittest.mock.NonCallableMock(spec=None, wraps=None, name=None, spec_set=None, **kwargs)

不可调用的 Mock 版本。 其构造器的形参具有与 Mock 相同的含义，区别在于 return_value 和 side_effect 在不可调用的 mock 上没有意义。

使用类或实例作为 spec 或 spec_set 的 mock 对象能够跳过 isinstance() 测试:

>>> mock = Mock(spec=SomeClass)
>>> isinstance(mock, SomeClass)
True
>>> mock = Mock(spec_set=SomeClass())
>>> isinstance(mock, SomeClass)
True

Mock 类具有对 mock 操作魔术方法的支持。 请参阅 魔术方法 了解完整细节。

mock 操作类和 patch() 装饰器都接受任意关键字参数用于配置。 对于 patch() 装饰器来说关键字参数会被传给所创建 mock 的构造器。 这些关键字被用于配置 mock 的属性:

>>> m = MagicMock(attribute=3, other='fish')
>>> m.attribute
3
>>> m.other
'fish'

子 mock 的返回值和附带效果也可使用带点号的标记通过相同的方式来设置。 由于你无法直接在调用中使用带点号的名称因此你需要创建一个字典并使用 ** 来解包它:

>>> 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

使用 spec (或 spec_set) 创建的可调用 mock 将在匹配调用与 mock 时内省规格说明对象的签名。 因此，它可以匹配实际调用的参数而不必关心它们是按位置还是按名称传入的:

>>> 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)

这适用于 assert_called_with(), assert_called_once_with(), assert_has_calls() 和 assert_any_call()。 当执行 自动 spec 时，它还将应用于 mock 对象的方法调用。

在 3.4 版更改: 添加了在附带规格说明和自动规格说明的 mock 对象上的签名内省

class unittest.mock.PropertyMock(*args, **kwargs)

旨在作为类的特征属性或其他描述器使用的 mock。 PropertyMock 提供了 __get__() 和 __set__() 方法以便你可以在它被提取时指定一个返回值。

当从一个对象提取 PropertyMock 实例时将不附带任何参数地调用该 mock。 如果设置它则调用该 mock 时将附带被设置的值。

>>> 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)]

由于 mock 属性的存储方式你无法直接将 PropertyMock 附加到一个 mock 对象。 但是你可以将它附加到 mock 类型对象:

>>> m = MagicMock()
>>> p = PropertyMock(return_value=3)
>>> type(m).foo = p
>>> m.foo
3
>>> p.assert_called_once_with()

class unittest.mock.AsyncMock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

MagicMock 的异步版本。 AsyncMock 对象的行为方式将使该对象被识别为异步函数，其调用的结果将为可等待对象。

>>> mock = AsyncMock()
>>> asyncio.iscoroutinefunction(mock)
True
>>> inspect.isawaitable(mock())
True

调用 mock() 的结果是一个异步函数，它在被等待之后将具有 side_effect 或 return_value 的结果:

如果 side_effect 是一个函数，则异步函数将返回该函数的结果,

如果 side_effect 是一个异常，则异步函数将引发该异常,

如果 side_effect 是一个可迭代对象，则异步函数将返回该可迭代对象的下一个值，但是，如果结果序列被耗尽，则会立即引发 StopAsyncIteration,

如果 side_effect 未被定义，则异步函数将返回is not defined, the async function will return the value defined by return_value 所定义的值，因而，在默认情况下，异步函数会返回一个新的 AsyncMock 对象。

将 Mock 或 MagicMock 的 spec 设为异步函数将导致在调用后返回一个协程对象。

>>> async def async_func(): pass
...
>>> mock = MagicMock(async_func)
>>> mock
<MagicMock spec='function' id='...'>
>>> mock()
<coroutine object AsyncMockMixin._mock_call at ...>

将 Mock, MagicMock 或 AsyncMock 的 spec 设为带有异步和同步函数的类将自动删除其中的同步函数并将它们设为 MagicMock (如果上级 mock 是 AsyncMock 或 MagicMock) 或者 Mock (如果上级 mock 是 Mock)。 所有异步函数都将为 AsyncMock。

>>> 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='...'>

3.8 新版功能.

assert_awaited()

断言 mock 已被等待至少一次。 请注意这是从被调用的对象中分离出来的，必须要使用 await 关键字:

>>> 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()

assert_awaited_once()

断言 mock 已被等待恰好一次。

>>> mock = AsyncMock()
>>> async def main():
...     await mock()
...
>>> asyncio.run(main())
>>> mock.assert_awaited_once()
>>> asyncio.run(main())
>>> mock.method.assert_awaited_once()
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited once. Awaited 2 times.

assert_awaited_with(*args, **kwargs)

断言上一次等待传入了指定的参数。

>>> 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 call not found.
Expected: mock('other')
Actual: mock('foo', bar='bar')

assert_awaited_once_with(*args, **kwargs)

断言 mock 已被等待恰好一次并且附带了指定的参数。

>>> 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.

assert_any_await(*args, **kwargs)

断言 mock 已附带了指定的参数被等待。

>>> 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

assert_has_awaits(calls, any_order=False)

断言 mock 已附带了指定的调用被等待。 将针对这些等待检查 await_args_list 列表。

如果 any_order 为假值则等待必须是顺序进行的。 在指定的等待之前或之后还可以有额外的调用。

如果 any_order 为真值则等待可以是任意顺序的，但它们都必须在 await_args_list 中出现。

>>> 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)

assert_not_awaited()

断言 mock 从未被等待过。

>>> mock = AsyncMock()
>>> mock.assert_not_awaited()

reset_mock(*args, **kwargs)

参见 Mock.reset_mock()。 还会将 await_count 设为 0，将 await_args 设为 None，并清空 await_args_list。

await_count

一个追踪 mock 对象已被等待多少次的整数值。

>>> mock = AsyncMock()
>>> async def main():
...     await mock()
...
>>> asyncio.run(main())
>>> mock.await_count
1
>>> asyncio.run(main())
>>> mock.await_count
2

await_args

这可能为 None (如果 mock 从未被等待)，或为该 mock 上一次被等待所附带的参数。 其功能与 Mock.call_args 相同。

>>> 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')

await_args_list

这是由对 mock 对象按顺序执行的所有等待组成的列表（因此该列表的长度即它被等待的次数）。 在有任何等待被执行之前它将为一个空列表。

>>> 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')]

调用

Mock 对象是可调用对象。 调用将把值集合作为 return_value 属性返回。 默认的返回值是一个新的 Mock 对象；它会在对返回值的首次访问（不论是显式访问还是通过调用 Mock）时被创建 —— 但它会被保存并且每次都返回相同的对象。

对该对象的调用将被记录在 call_args 和 call_args_list 等属性中。

如果设置了 side_effect 则它将在调用被记录之后被调用，因此如果 side_effect 引发了异常该调用仍然会被记录。

让一个 mock 在被调用时引发异常的最简单方式是将 side_effect 设为一个异常类或实例:

>>> 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')]

如果 side_effect 为函数则该函数所返回的对象就是调用该 mock 所返回的对象。 side_effect 函数在被调用时将附带与该 mock 相同的参数。 这允许你根据输入动态地改变返回值:

>>> 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)]

如果你想让该 mock 仍然返回默认的返回值（一个新的 mock对象），或是任何设定的返回值，那么有两种方式可以做到这一点。 从 side_effect 内部返回 mock.return_value，或者返回 DEFAULT:

>>> 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

要移除一个 side_effect，并返回到默认的行为，请将 side_effect 设为 None:

>>> 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

side_effect 也可以是任意可迭代对象。 对该 mock 的重复调用将返回来自该可迭代对象的值（直到该可迭代对象被耗尽并导致 StopIteration 被引发）:

>>> m = MagicMock(side_effect=[1, 2, 3])
>>> m()
1
>>> m()
2
>>> m()
3
>>> m()
Traceback (most recent call last):
  ...
StopIteration

如果该可迭代对象有任何成员属于异常则它们将被引发而不是被返回:

>>> iterable = (33, ValueError, 66)
>>> m = MagicMock(side_effect=iterable)
>>> m()
33
>>> m()
Traceback (most recent call last):
 ...
ValueError
>>> m()
66

删除属性

Mock 对象会根据需要创建属性。 这允许它们可以假装成任意类型的对象。

你可能想要一个 mock 对象在调用 hasattr() 时返回 False，或者在获取某个属性时引发 AttributeError。 你可以通过提供一个对象作为 mock 的 spec 属性来做到这点，但这并不总是很方便。

你可以通过删除属性来“屏蔽”它们。 属性一旦被删除，访问它将引发 AttributeError。

>>> 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

Mock 的名称与 name 属性

由于 "name" 是 Mock 构造器的参数之一，如果你想让你的 mock 对象具有 "name" 属性你不可以在创建时传入该参数。 有两个替代方式。 一个选项是使用 configure_mock():

>>> mock = MagicMock()
>>> mock.configure_mock(name='my_name')
>>> mock.name
'my_name'

一个更简单的选项是在 mock 创建之后简单地设置 "name" 属性:

>>> mock = MagicMock()
>>> mock.name = "foo"

附加 Mock 作为属性

当你附加一个 mock 作为另一个 mock 的属性（或作为返回值）时它会成为该 mock 的 "子对象"。 对子对象的调用会被记录在父对象的 method_calls 和 mock_calls 属性中。 这适用于配置子 mock 然后将它们附加到父对象，或是将 mock 附加到将记录所有对子对象的调用的父对象上并允许你创建有关 mock 之间的调用顺序的断言:

>>> 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)]

这里有一个例外情况是如果 mock 设置了名称。 这允许你在出于某些理由不希望其发生时避免 "父对象" 的影响。

>>> 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
[]

通过 patch() 创建的 mock 会被自动赋予名称。 要将具有名称的 mock 附加到父对象上你应当使用 attach_mock() 方法:

>>> 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')]

1

仅有的例外是魔术方法和属性（其名称前后都带有双下划线）。 Mock 不会创建它们而是将引发 AttributeError。 这是因为解释器将会经常隐式地请求这些方法，并且在它准备接受一个魔术方法却得到一个新的 Mock 对象时会 相当 困惑。 如果你需要魔术方法支持请参阅 魔术方法。

patch 装饰器

patch 装饰器仅被用于在它们所装饰的函数作用域内部为对象添加补丁。 它们会自动为你执行去除补丁的处理，即使是在引发了异常的情况下。 所有这些函数都还可在 with 语句中使用或是作为类装饰器。

patch

注解

问题的关键是要在正确的命名空间中打补丁。 参见 where to patch 一节。

unittest.mock.patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

patch() 可以作为函数装饰器、类装饰器或上下文管理器。 在函数或 with 语句的内部，target 会打上一个 new 对象补丁。 当函数/with 语句退出时补丁将被撤销。

如果 new 被省略，那么如果被打补丁的对象是一个异步函数则 target 将被替换为 AsyncMock 否则替换为 MagicMock。 如果 patch() 被用作装饰器并且 new 被省略，那么已创建的 mock 将作为一个附加参数传入被装饰的函数。 如果 patch() 被用作上下文管理器那么已创建的 mock 将被该上下文管理器所返回。

target 应当为 'package.module.ClassName' 形式的字符串。 target 将被导入并且该指定对象会被替换为 new 对象，因此 target 必须是可以从你调用 patch() 的环境中导入的。 target 会在被装饰的函数被执行的时候被导入，而非在装饰的时候。

spec 和 spec_set 关键字参数会被传递给 MagicMock，如果 patch 为你创建了此对象的话。

此外你还可以传入 spec=True 或 spec_set=True，这将使 patch 将被模拟的对象作为 spec/spec_set 对象传入。

new_callable 允许你指定一个不同的类，或者可调用对象，它将被调用以创建 新的 对象。 在默认情况下将指定 AsyncMock 用于异步函数，MagicMock 用于其他函数。

另一种更强形式的 spec 是 autospec。 如果你设置了 autospec=True 则将以来自被替换对象的 spec 来创建 mock。 mock 的所有属性也将具有被替换对象相应属性的 spec。 被模拟的方法和函数将检查它们的参数并且如果使用了错误的签名调用它们则将引发 TypeError。 对于替换了一个类的 mock，它们的返回值（即‘实例’）将具有与该类相同的 spec。 请参阅 create_autospec() 函数以及 自动 spec。

除了 autospec=True 你还可以传入 autospec=some_object 以使用任意对象而不是被替换的对象作为 spec。

在默认情况下 patch() 将无法替换不存在的属性。 如果你传入 create=True，且该属性并不存在，则 patch 将在调用被打补丁的函数时为你创建该属性，并在退出被打补丁的函数时再次删除它。 这适用于编写针对生产代码在运行时创建的属性的测试。 它默认是被关闭的因为这具有危险性。 当它被开启时你将能够针对实际上并不存在的 API 编写通过测试！

注解

在 3.5 版更改: 如果你要给某个模块的内置函数打补丁则不必传入 create=True，它默认就会被添加。

Patch 可以被用作 TestCase 类装饰器。 其作用是装饰类中的每个测试方法。 当你的测试方法共享同一个补丁集时这将减少模板代码。 patch() 会通过查找以 patch.TEST_PREFIX 打头的名称来找到测试。 其默认值为 'test'，这与 unittest 打到测试的方式一致。 你可以通过设置 patch.TEST_PREFIX 来指定其他的前缀。

Patch 可以通过 with 语句作为上下文管理器使用。 这时补丁将应用于 with 语句的缩进代码块。 如果你使用了 "as" 则打补丁的对象将被绑定到 "as" 之后的名称；这非常适用于当 patch() 为你创建 mock 对象的情况。

patch() 可接受任意关键字参数。 如果打补丁的对象是异步的则这些参数将被传给 AsyncMock，否则传给 MagicMock，或者是指定的 new_callable。

patch.dict(...), patch.multiple(...) 和 patch.object(...) 可用于其他使用场景。

patch() 作为函数装饰器，为你创建 mock 并将其传入被装饰的函数:

>>> @patch('__main__.SomeClass')
... def function(normal_argument, mock_class):
...     print(mock_class is SomeClass)
...
>>> function(None)
True

为类打补丁将把该类替换为 MagicMock 的 实例。 如果该类是在受测试的代码中被实例化的则它将为所要使用的 mock 的 return_value。

如果该类被多次实例化则你可以使用 side_effect 来每次返回一个新 mock。 或者你也可以将 return_value 设为你希望的任何对象。

要在被打补丁的类的 实例 的方法上配置返回值你必须在 return_value 操作。 例如:

>>> 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'
...

如果你使用 spec 或 spec_set 并且 patch() 替换的是 class，那么所创建的 mock 的返回值将具有同样的 spec。

>>> Original = Class
>>> patcher = patch('__main__.Class', spec=True)
>>> MockClass = patcher.start()
>>> instance = MockClass()
>>> assert isinstance(instance, Original)
>>> patcher.stop()

new_callable 参数适用于当你想要使用其他类来替代所创建的 mock 默认的 MagicMock 的场合。 例如，如果你想要使用 NonCallableMock:

>>> 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

另一个使用场景是用 io.StringIO 实例来替换某个对象:

>>> 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()

当 patch() 为你创建 mock 时，通常你需要做的第一件事就是配置该 mock。 某些配置可以在对 patch 的调用中完成。 你在调用时传入的任何关键字参数都将被用来在所创建的 mock 上设置属性:

>>> patcher = patch('__main__.thing', first='one', second='two')
>>> mock_thing = patcher.start()
>>> mock_thing.first
'one'
>>> mock_thing.second
'two'

除了所创建的 mock 的属性上的属性，例如 return_value 和 side_effect，还可以配置子 mock 的属性。 将这些属性直接作为关键字参数传入在语义上是无效的，但是仍然能够使用 ** 将以这些属性为键的字典扩展至一个 patch() 调用中

>>> 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

在默认情况下，尝试给某个模块中并不存在的函数（或者某个类中的方法或属性）打补丁将会失败并引发 AttributeError:

>>> @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'

但在对 patch() 的调用中添加 create=True 将使之前示例的效果符合预期:

>>> @patch('sys.non_existing_attribute', 42, create=True)
... def test(mock_stdout):
...     assert sys.non_existing_attribute == 42
...
>>> test()

在 3.8 版更改: 如果目标为异步函数那么 patch() 现在将返回一个 AsyncMock。

patch.object

patch.object(target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

用一个 mock 对象为对象 (target) 中指定名称的成员 (attribute) 打补丁。

patch.object() 可以被用作装饰器、类装饰器或上下文管理器。 new, spec, create, spec_set, autospec 和 new_callable 等参数的含义与 patch() 的相同。 与 patch() 类似，patch.object() 接受任意关键字参数用于配置它所创建的 mock 对象。

当用作类装饰器时 patch.object() 将认可 patch.TEST_PREFIX 作为选择所要包装方法的标准。

你可以附带三个参数或两个参数来调用 patch.object()。 三个参数的形式将接受要打补丁的对象、属性的名称以及将要替换该属性的对象。

将附带两个参数的形式调用时你将省略替换对象，还会为你创建一个 mock 并作为附加参数传入被装饰的函数:

>>> @patch.object(SomeClass, 'class_method')
... def test(mock_method):
...     SomeClass.class_method(3)
...     mock_method.assert_called_with(3)
...
>>> test()

传给 patch.object() 的 spec, create 和其他参数的含义与 patch() 的同名参数相同。

patch.dict

patch.dict(in_dict, values=(), clear=False, **kwargs)

为一个字典或字典类对象打补丁，并在测试之后将该目录恢复到其初始状态。

in_dict 可以是一个字典或映射类容器。 如果它是一个映射则它必须至少支持获取、设置和删除条目以及对键执行迭代。

in_dict 也可以是一个指定字典名称的字符串，然后将通过导入操作来获取该字典。

values 可以是一个要在字典中设置的值的字典。 values 也可以是一个包含 (key, value) 对的可迭代对象。

如果 clear 为真值则该字典将在设置新值之前先被清空。

patch.dict() 也可以附带任意关键字参数调用以设置字典中的值。

在 3.8 版更改: 现在当 patch.dict() 被用作上下文管理器时将返回被打补丁的字典。now returns the patched dictionary when used as a context manager.

patch.dict() 可被用作上下文管理器、装饰器或类装饰器:

>>> foo = {}
>>> @patch.dict(foo, {'newkey': 'newvalue'})
... def test():
...     assert foo == {'newkey': 'newvalue'}
>>> test()
>>> assert foo == {}

当被用作类装饰器时 patch.dict() 将认可 patch.TEST_PREFIX (默认值为 'test') 作为选择所在包装方法的标准:

>>> 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')

如果你在为你的测试使用不同的前缀，你可以通过设置 patch.TEST_PREFIX 来将不同的前缀告知打补丁方。 有关如何修改该值的详情请参阅 TEST_PREFIX。

patch.dict() 可被用来向一个字典添加成员，或者简单地让测试修改一个字典，并确保当测试结束时恢复该字典。

>>> 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 == {}

>>> import os
>>> with patch.dict('os.environ', {'newkey': 'newvalue'}):
...     print(os.environ['newkey'])
...
newvalue
>>> assert 'newkey' not in os.environ

可以在 patch.dict() 调用中使用关键字来设置字典的值:

>>> mymodule = MagicMock()
>>> mymodule.function.return_value = 'fish'
>>> with patch.dict('sys.modules', mymodule=mymodule):
...     import mymodule
...     mymodule.function('some', 'args')
...
'fish'

patch.dict() 可以用于实际上不是字典的字典类对象。 它们最少必须支持条目获取、设置、删除以及迭代或成员检测两者中的一个。 这对应于魔术方法 __getitem__(), __setitem__(), __delitem__() 以及 __iter__() 或 __contains__()。

>>> 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']

patch.multiple

patch.multiple(target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

在单个调用中执行多重补丁。 它接受要打补丁的对象（一个对象或一个通过导入来获取对象的字符串）以及用于补丁的关键字参数:

with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    ...

如果你希望 patch.multiple() 为你创建 mock 则要使用 DEFAULT 作为值。 在此情况下所创建的 mock 会通过关键字参数传入被装饰的函数，而当 patch.multiple() 被用作上下文管理器时则将返回一个字典。

patch.multiple() 可以被用作装饰器、类装饰器或上下文管理器。 spec, spec_set, create, autospec 和 new_callable 等参数的含义与 patch() 的相同。 这些参数将被应用到 patch.multiple() 所打的 所有 补丁。

当被用作类装饰器时 patch.multiple() 将认可 patch.TEST_PREFIX 作为选择所要包装方法的标准。

如果你希望 patch.multiple() 为你创建 mock，那么你可以使用 DEFAULT 作为值。 如果你使用 patch.multiple() 作为装饰器则所创建的 mock 会作为关键字参数传入被装饰的函数。

>>> 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()

patch.multiple() 可以与其他 patch 装饰器嵌套使用，但要将作为关键字传入的参数要放在 patch() 所创建的标准参数 之后:

>>> @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()

如果 patch.multiple() 被用作上下文管理器，则上下文管理器的返回值将是一个以所创建的 mock 的名称为键的字典:

>>> 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
...

补丁方法: start 和 stop

所有补丁对象都具有 start() 和 stop() 方法。 使用这些方法可以更简单地在 setUp 方法上打补丁，还可以让你不必嵌套使用装饰器或 with 语句就能打多重补丁。

要使用这些方法请按正常方式调用 patch(), patch.object() 或 patch.dict() 并保留一个指向所返回 patcher 对象的引用。 然后你可以调用 start() 来原地打补丁并调用 stop() 来恢复它。

如果你使用 patch() 来创建自己的 mock 那么将可通过调用 patcher.start 来返回它。

>>> 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

此操作的一个典型应用场景是在一个 TestCase 的 setUp 方法中执行多重补丁:

>>> 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()

警告

如果你要使用这个技巧则你必须通过调用 stop 来确保补丁被“恢复”。 这可能要比你想像的更麻烦，因为如果在 setUp 中引发了异常那么 tearDown 将不会被调用。 unittest.TestCase.addCleanup() 可以简化此操作:

>>> 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
...

一项额外的好处是你不再需要保留指向 patcher 对象的引用。

还可以通过使用 patch.stopall() 来停止已启动的所有补丁。

patch.stopall()

停止所有激活的补丁。 仅会停止通过 start 启动的补丁。

为内置函数打补丁

你可以为一个模块中的任何内置函数打补丁。 以以示例是为内置函数 ord() 打补丁:

>>> @patch('__main__.ord')
... def test(mock_ord):
...     mock_ord.return_value = 101
...     print(ord('c'))
...
>>> test()
101

TEST_PREFIX

所有补丁都可被用作类装饰器。 当以这种方式使用时它们将会包装类中的每个测试方法。 补丁会将以名字以 'test' 开头的方法识别为测试方法。 这与 unittest.TestLoader 查找测试方法的默认方式相同。

你可能会想要为你的测试使用不同的前缀。 你可以通过设置 patch.TEST_PREFIX 来告知打补丁方不同的前缀:

>>> 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

嵌套补丁装饰器

如果你想要应用多重补丁那么你可以简单地堆叠多个装饰器。

你可以使用以下模式来堆叠多个补丁装饰器:

>>> @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')

请注意装饰器是从下往上被应用的。 这是 Python 应用装饰器的标准方式。 被创建并传入你的测试函数的 mock 的顺序也将匹配这个顺序。

补丁的位置

patch() 通过（临时性地）修改某一个对象的 名称 指向另一个对象来发挥作用。 可以有多个名称指向任意单独对象，因此要让补丁起作用你必须确保已为被测试的系统所使用的名称打上补丁。

基本原则是你要在对象 被查找 的地方打补丁，这不一定就是它被定义的地方。 一组示例将有助于厘清这一点。

想像我们有一个想要测试的具有如下结构的项目:

a.py
    -> Defines SomeClass

b.py
    -> from a import SomeClass
    -> some_function instantiates SomeClass

现在我们要测试 some_function 但我们想使用 patch() 来模拟 SomeClass。 问题在于当我们导入模块 b 时，我们将必须让它从模块 a 导入 SomeClass。 如果我们使用 patch() 来模拟 a.SomeClass 那么它将不会对我们的测试造成影响；模块 b 已经拥有对 真正的 SomeClass 的引用因此看上去我们的补丁不会有任何影响。

关键在于对 SomeClass 打补丁操作是在它被使用（或它被查找）的地方。 在此情况下实际上 some_function 将在模块 b 中查找 SomeClass，而我们已经在那里导入了它。 补丁看上去应该是这样:

@patch('b.SomeClass')

但是，再考虑另一个场景，其中不是 from a import SomeClass 而是模块 b 执行了 import a 并且 some_function 使用了 a.SomeClass。 这两个导入形式都很常见。 在这种情况下我们要打补丁的类将在该模块中被查找因而我们必须改为对 a.SomeClass 打补丁:

@patch('a.SomeClass')

对描述器和代理对象打补丁

patch 和 patch.object 都能正确地对描述器打补丁并恢复：包含类方法、静态方法和特征属性。 你应当在 类 而不是实例上为它们打补丁。 它们也适用于代理属性访问的 部分 对象，例如 django settings object [https://web.archive.org/web/20200603181648/http://www.voidspace.org.uk/python/weblog/arch_d7_2010_12_04.shtml#e1198]。

MagicMock 与魔术方法支持

模拟魔术方法

Mock 支持模拟 Python 协议方法，或称“魔术方法”。 这允许 mock 对象替代容器或其他实现了 Python 协议的对象。

因为查找魔术方法的方式不同于普通方法 2，这种支持采用了特别的实现。 这意味着只有特定的魔术方法受到支持。 受支持的是 几乎 所有魔术方法。 如果有你需要但被遗漏的请告知我们。

你可以通过在某个函数或 mock 实例中设置魔术方法来模拟它们。 如果你是使用函数则它 必须 接受 self 作为第一个参数 3。

>>> def __str__(self):
...     return 'fooble'
...
>>> mock = Mock()
>>> mock.__str__ = __str__
>>> str(mock)
'fooble'

>>> mock = Mock()
>>> mock.__str__ = Mock()
>>> mock.__str__.return_value = 'fooble'
>>> str(mock)
'fooble'

>>> mock = Mock()
>>> mock.__iter__ = Mock(return_value=iter([]))
>>> list(mock)
[]

一个这样的应用场景是在 with 语句中模拟作为上下文管理器的对象:

>>> 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)

对魔术方法的调用不会在 method_calls 中出现，但它们会被记录在 mock_calls 中。

注解

如果你使用 spec 关键字参数来创建 mock 那么尝试设置不包含在 spec 中的魔术方法将引发 AttributeError。

受支持魔术方法的完整列表如下:

__hash__, __sizeof__, __repr__ 和 __str__

__dir__, __format__ 和 __subclasses__

__round__, __floor__, __trunc__ 和 __ceil__

比较运算: __lt__, __gt__, __le__, __ge__, __eq__ 和 __ne__

容器方法: __getitem__, __setitem__, __delitem__, __contains__, __len__, __iter__, __reversed__ 和 __missing__

上下文管理器: __enter__, __exit__, __aenter__ 和 __aexit__

单目数值运算方法: __neg__, __pos__ 和 __invert__

数值运算方法 (包括右手和原地形式): __add__, __sub__, __mul__, __matmul__, __div__, __truediv__, __floordiv__, __mod__, __divmod__, __lshift__, __rshift__, __and__, __xor__, __or__ 和 __pow__

数值转换方法: __complex__, __int__, __float__ 和 __index__

描述器方法: __get__, __set__ and __delete__

封存方法: __reduce__, __reduce_ex__, __getinitargs__, __getnewargs__, __getstate__ 和 __setstate__

文件系统路径表示: __fspath__

异步迭代方法: __aiter__ and __anext__

在 3.8 版更改: 增加了对 os.PathLike.__fspath__() 的支持。

在 3.8 版更改: 增加了对 __aenter__, __aexit__, __aiter__ 和 __anext__ 的支持。

下列方法均存在但是 不受 支持，因为它们或者被 mock 所使用，或者无法动态设置，或者可能导致问题:

__getattr__, __setattr__, __init__ 和 __new__

__prepare__, __instancecheck__, __subclasscheck__, __del__

MagicMock

存在两个版本的 MagicMock: MagicMock 和 NonCallableMagicMock.

class unittest.mock.MagicMock(*args, **kw)

MagicMock 是包含了大部分魔术方法的默认实现的 Mock 的子类。 你可以使用 MagicMock 而无须自行配置魔术方法。without having to configure the magic methods yourself.

构造器形参的含义与 Mock 的相同。

如果你使用了 spec 或 spec_set 参数则将 只有 存在于 spec 中的魔术方法会被创建。

class unittest.mock.NonCallableMagicMock(*args, **kw)

MagicMock 的不可调用版本。

其构造器的形参具有与 MagicMock 相同的含义，区别在于 return_value 和 side_effect 在不可调用的 mock 上没有意义。

魔术方法是通过 MagicMock 对象来设置的，因此你可以用通常的方式来配置它们并使用它们:

>>> mock = MagicMock()
>>> mock[3] = 'fish'
>>> mock.__setitem__.assert_called_with(3, 'fish')
>>> mock.__getitem__.return_value = 'result'
>>> mock[2]
'result'

在默认情况下许多协议方法都需要返回特定类型的对象。 这些方法都预先配置了默认的返回值，以便它们在你对返回值不感兴趣时可以不做任何事就能被使用。 如果你想要修改默认值则你仍然可以手动 设置 返回值。

方法及其默认返回值:

__lt__: NotImplemented

__gt__: NotImplemented

__le__: NotImplemented

__ge__: NotImplemented

__int__: 1

__contains__: False

__len__: 0

__iter__: iter([])

__exit__: False

__aexit__: False

__complex__: 1j

__float__: 1.0

__bool__: True

__index__: 1

__hash__: mock 的默认 hash

__str__: mock 的默认 str

__sizeof__: mock 的默认 sizeof

例如:

>>> mock = MagicMock()
>>> int(mock)
1
>>> len(mock)
0
>>> list(mock)
[]
>>> object() in mock
False

两个相等性方法 __eq__() 和 __ne__() 是特殊的。 它们基于标识号进行默认的相等性比较，使用 side_effect 属性，除非你修改它们的返回值以返回其他内容:

>>> MagicMock() == 3
False
>>> MagicMock() != 3
True
>>> mock = MagicMock()
>>> mock.__eq__.return_value = True
>>> mock == 3
True

MagicMock.__iter__() 的返回值可以是任意可迭代对象而不要求必须是迭代器:

>>> mock = MagicMock()
>>> mock.__iter__.return_value = ['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']

如果返回值 是 迭代器，则对其执行一次迭代就会将它耗尽因而后续执行的迭代将会输出空列表:

>>> mock.__iter__.return_value = iter(['a', 'b', 'c'])
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
[]

MagicMock 已配置了所有受支持的魔术方法，只有某些晦涩和过时的魔术方法是例外。 如果你需要仍然可以设置它们。

在 MagicMock 中受到支持但默认未被设置的魔术方法有:

__subclasses__

__dir__

__format__

__get__, __set__ 和 __delete__

__reversed__ 和 __missing__

__reduce__, __reduce_ex__, __getinitargs__, __getnewargs__, __getstate__ 和 __setstate__

__getformat__ 和 __setformat__

2

魔术方法 应当 是在类中而不是在实例中查找。 不同的 Python 版本对这个规则的应用并不一致。 受支持的协议方法应当适用于所有受支持的 Python 版本。

3

该函数基本上是与类挂钩的，但每个 Mock 实例都会与其他实例保持隔离。

辅助对象

sentinel

unittest.mock.sentinel

sentinel 对象提供了一种为你的测试提供独特对象的便捷方式。

属性是在你通过名称访问它们时按需创建的。 访问相同的属性将始终返回相同的对象。 返回的对象会有一个合理的 repr 以使测试失败消息易于理解。

在 3.7 版更改: 现在 sentinel 属性会在它们被 copy 或 pickle 时保存其标识。

在测试时你可能需要测试是否有一个特定的对象作为参数被传给了另一个方法，或是被其返回。 通常的做法是创建一个指定名称的 sentinel 对象来执行这种测试。 sentinel 提供了一种创建和测试此类对象的标识的便捷方式。

在这个示例中我们为 method 打上便捷补丁以返回 sentinel.some_object:

>>> 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

DEFAULT

unittest.mock.DEFAULT

DEFAULT 对象是一个预先创建的 sentinel (实际为 sentinel.DEFAULT)。 它可被 side_effect 函数用来指明其应当使用正常的返回值。

call

unittest.mock.call(*args, **kwargs)

call() 是一个可创建更简单断言的辅助对象，用于同 call_args, call_args_list, mock_calls 和 method_calls 进行比较。 call() 也可配合 assert_has_calls() 使用。

>>> 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

call.call_list()

对于代表多个调用的 call 对象，call_list() 将返回一个包含所有中间调用以及最终调用的列表。

call_list 特别适用于创建针对“链式调用”的断言。 链式调用是指在一行代码中执行的多个调用。 这将使得一个 mock 的中存在多个条目 mock_calls。 手动构造调用的序列将会很烦琐。

call_list() 可以根据同一个链式调用构造包含多个调用的序列:

>>> 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

根据构造方式的不同，call 对象可以是一个 (位置参数, 关键字参数) 或 (名称, 位置参数, 关键字参数) 元组。 当你自行构造它们时这没有什么关系，但是 Mock.call_args, Mock.call_args_list 和 Mock.mock_calls 属性当中的 call 对象可以被反查以获取它们所包含的单个参数。

Mock.call_args 和 Mock.call_args_list 中的 call 对象是 (位置参数, 关键字参数) 二元组而 Mock.mock_calls 中以及你自行构造的 call 对象则是 (名称, 位置参数, 关键字参数) 三元组。

你可以使用它们作为“元组”的特性来为更复杂的内省和断言功能获取单个参数。 位置参数是一个元组（如无位置参数则为空元组）而关键字参数是一个字典:

>>> 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

>>> 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

create_autospec

unittest.mock.create_autospec(spec, spec_set=False, instance=False, **kwargs)

使用另一对象作为 spec 来创建 mock 对象。 mock 的属性将使用 spec 对象上的对应属性作为其 spec。

被模拟的函数或方法的参数将会被检查以确保它们是附带了正确的签名被调用的。

如果 spec_set 为 True 则尝试设置不存在于 spec 对象中的属性将引发 AttributeError。

如果将类用作 spec 则 mock（该类的实例）的返回值将为这个 spec。 你可以通过传入 instance=True 来将某个类用作一个实例对象的 spec。 被返回的 mock 将仅在该 mock 的实例为可调用对象时才会是可调用对象。

create_autospec() 也接受被传入所创建 mock 的构造器的任意关键字参数。

请参阅 自动 spec 来了解如何通过 create_autospec() 以及 patch() 的 autospec 参数来自动设置 spec。

在 3.8 版更改: 如果目标为异步函数那么 create_autospec() 现在将返回一个 AsyncMock。

ANY

unittest.mock.ANY

有时你可能需要设置关于要模拟的调用中的 某些 参数的断言，但是又不想理会其他参数或者想要从 call_args 中单独拿出它们并针对它们设置更复杂的断言。

为了忽略某些参数你可以传入与 任意对象 相等的对象。 这样再调用 assert_called_with() 和 assert_called_once_with() 时无论传入什么参数都将执行成功。

>>> mock = Mock(return_value=None)
>>> mock('foo', bar=object())
>>> mock.assert_called_once_with('foo', bar=ANY)

ANY 也可被用在与 mock_calls 这样的调用列表相比较的场合:

>>> m = MagicMock(return_value=None)
>>> m(1)
>>> m(1, 2)
>>> m(object())
>>> m.mock_calls == [call(1), call(1, 2), ANY]
True

FILTER_DIR

unittest.mock.FILTER_DIR

FILTER_DIR 是一个控制 mock 对象响应 dir() 的方式的模块级变量（只适用于 Python 2.6 之后的版本）。 默认值为 True，这将使用下文描述的过滤操作，以便只显示有用的成员。 如果你不想要这样的过滤，或是出于诊断目的需要将其关闭，则应设置 mock.FILTER_DIR = False。

当启用过滤时，dir(some_mock) 将只显示有用的属性并将包括正常情况下不会被显示的任何动态创建的属性。 如果 mock 是使用 spec (当然也可以是 autospec) 创建的则原有的所有属性都将被显示，即使它们还未被访问过:

>>> 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',
 ...

许多不太有用的（是 Mock 的而不是被模拟对象的私有成员）开头带有下划线和双下划线的属性已从在 Mock 上对 dir() 的调用的结果中被过滤。 如果你不喜欢此行为你可以通过设置模块级开关 FILTER_DIR 来将其关闭:

>>> 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__',
 ...

或者你也可以直接使用 vars(my_mock) (实例成员) 和 dir(type(my_mock)) (类型成员) 来忽略 mock.FILTER_DIR 设置绕过过滤。

mock_open

unittest.mock.mock_open(mock=None, read_data=None)

创建 mock 来代替使用 open() 的辅助函数。 它对于 open() 被直接调用或被用作上下文管理器的情况都适用。

mock 参数是要配置的 mock 对象。 如为 None (默认值) 则将为你创建一个 MagicMock，其 API 会被限制为可用于标准文件处理的方法或属性。

read_data 是供文件处理的 read(), readline() 和 readlines() 方法返回的字符串。 调用这些方法将会从 read_data 获取数据直到它被耗尽。 对这些方法的模拟是相当简化的：每次 mock 被调用时，read_data 都将从头开始。 如果你需要对你提供给测试代码的数据有更多控制那么你将需要自行定制这个 mock。 如果这还不够用，那么通过一些 PyPI [https://pypi.org] 上的内存文件系统包可以提供更真实的测试文件系统。

在 3.4 版更改: 增加了对 readline() 和 readlines() 的支持。 对 read() 的模拟被改为消耗 read_data 而不是每次调用时返回它。

在 3.5 版更改: read_data 现在会在每次 mock 的调用时重置。

在 3.8 版更改: 为实现增加了 __iter__() 以使迭代操作（例如在 for 循环中）能正确地消耗 read_data。

将 open() 用作上下文管理器一确保你的文件处理被正确关闭的最佳方式因而十分常用:

with open('/some/path', 'w') as f:
    f.write('something')

这里的问题在于即使你模拟了对 open() 的调用但被用作上下文管理器（并调用其 __enter__() 和 __exit__() 方法）的也是 被返回的对象。

通过 MagicMock 来模拟上下文管理器是十分常见且十分麻烦的因此需要使用一个辅助函数。

>>> 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')

以及针对读取文件:

>>> 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'

自动 spec

自动 spec 是基于现有 mock 的 spec 特性。 它将 mock 的 api 限制为原始对象 (spec) 的 api，但它是递归（惰性实现）的因而 mock 的属性只有与 spec 的属性相同的 api。 除此之外被模块的函数 / 方法具有与原对应物相同的调用签名因此如果它们被不正确地调用时会引发 TypeError。

在我开始解释自动 spec 如何运作之前，先说明一下它的必要性。

Mock 是一个非常强大而灵活的对象，但当它被用来模拟来自被测试系统的对象时有两个缺陷。 其中一个缺陷是 Mock 的 api 特有的而另一个则是使用 mock 对象时普遍存在的问题。

第一个问题为 Mock 所专属。 Mock 具有两个特别好用的断言方法: assert_called_with() 和 assert_called_once_with()。

>>> mock = Mock(name='Thing', return_value=None)
>>> mock(1, 2, 3)
>>> mock.assert_called_once_with(1, 2, 3)
>>> mock(1, 2, 3)
>>> mock.assert_called_once_with(1, 2, 3)
Traceback (most recent call last):
 ...
AssertionError: Expected 'mock' to be called once. Called 2 times.

因为 mock 会根据需要自动创建属性，并允许你附带任意参数调用它们，所以如果你写错了这两个断言方法则你的断言将会失效:

>>> mock = Mock(name='Thing', return_value=None)
>>> mock(1, 2, 3)
>>> mock.assret_called_once_with(4, 5, 6)  # Intentional typo!

你的测试将因这个拼写错误而静默并且错误地通过。

第二个问题是 mock 操作中普遍存在的。 如果你重构了你的部分代码，例如修改了一些成员的名称等等，则代码中任何仍在使用 旧 api 但其使用的是 mock 而非真实对象的测试仍将通过。 这意味着即使你的代码已被破坏你的测试却仍可能全部通过。

请注意这是为什么你在单元测试之外还需要集成测试的原因之一。 孤立地测试每个部分时全都正常而顺滑，但是如果你没有测试你的各个单元“联成一体”的情况如何那么就仍然存在测试可以发现大量错误的空间。

mock 已经提供了一个对此有帮助的特性，称为 spec 控制。 如果你使用类或实例作为一个 mock 的 spec 那么你将仅能访问 mock 中只存在于实际的类中的属性。

>>> 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'

这个 spec 仅会应用于 mock 本身，因此对于 mock 中的任意方法我们仍然面临相同的问题:

>>> mock.has_data()
<mock.Mock object at 0x...>
>>> mock.has_data.assret_called_with()  # Intentional typo!

自动 spec 解决了这个问题。 你可以将 autospec=True 传给 patch() / patch.object() 或是使用 create_autospec() 函数来创建带有 spec 的 mock。 如果你是将 autospec=True 参数传给 patch() 那么被替代的那个对象将被用作 spec 对象。 因为 spec 控制是“惰性地”执行的（spec 在 mock 中的属性被访问时才会被创建）所以即使是非常复杂或深度嵌套的对象（例如需要导入本身已导入了多个模块的模块）你也可以使用它而不会有太大的性能损失。

以下是一个实际应用的示例:

>>> 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='...'>

你可以看到 request.Request 有一个 spec。 request.Request 的构造器接受两个参数 (其中一个是 self)。 如果我们尝试不正确地调用它则将导致:

>>> req = request.Request()
Traceback (most recent call last):
 ...
TypeError: <lambda>() takes at least 2 arguments (1 given)

该 spec 也将应用于被实例化的类（即附带i.e. the return value of spec 的 mock 的返回值）:

>>> req = request.Request('foo')
>>> req
<NonCallableMagicMock name='request.Request()' spec='Request' id='...'>

Request 对象是不可调用对象，因此实例化我们的被模拟 request.Request 的返回值是一个不可调用的 mock。 有了这个 spec 我们的断言中出现任何拼写问题都将引发正确的错误:

>>> req.add_header('spam', 'eggs')
<MagicMock name='request.Request().add_header()' id='...'>
>>> req.add_header.assret_called_with  # Intentional typo!
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
>>> req.add_header.assert_called_with('spam', 'eggs')

在许多情况下你将只需将 autospec=True 添加到你现有的 patch() 调用中即可防止拼写错误和 api 变化所导致的问题。

除了通过 patch() 来使用 autospec 还有一个 create_autospec() 可以直接创建带有自动 spec 的 mock:

>>> from urllib import request
>>> mock_request = create_autospec(request)
>>> mock_request.Request('foo', 'bar')
<NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>

不过这并非没有缺点和限制，这也就是为什么它不是默认行为。 为了知道在 spec 对象上有哪些属性是可用的，autospec 必须对 spec 进行自省（访问其属性）。 当你遍历 mock 上的属性时在原始对象上的对应遍历也将在底层进行。 如果你的任何带 spec 的对象具有可触发代码执行的特征属性或描述器则你可能会无法使用 autospec。 在另一方面更好的的做法是将你的对象设计为可以安全地执行自省 4。

一个更严重的问题在于实例属性往往是在 __init__() 方法中被创建而在类中完全不存在。 autospec 无法获取动态创建的属性而使得 api 被限制于可见的属性。

>>> 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'

要解决这个问题有几种不同的方式。 最容易但多少有些烦扰的方式是简单地在 mock 创建完成后再设置所需的属性。 Just because autospec 只是不允许你获取不存在于 spec 上的属性但并不会阻止你设置它们:

>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a = 33
...

spec 和 autospec 都有更严格的版本 确实能 阻止你设置不存在的属性。 这在你希望确保你的代码只能 设置 有效的属性时也很有用，但显然它会阻止下面这个特定的应用场景:

>>> 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'

解决此问题的最好方式可能是添加类属性作为在 __init__() 中初始化的实例属性的默认值。 请注意如果你只在 __init__() 中设置默认属性那么通过类属性来提供它们（当然会在实例之间共享）也将有更快的速度。 例如

class Something:
    a = 33

这带来了另一个问题。 为今后将变为不同类型对象的那些成员提供默认值 None 是比较常见的做法。 None 作为 spec 是没有用处的，因为它会使你无法访问 any 任何属性或方法。 由于 None 作为 spec 将 永远不会 有任何用处，并且有可能要指定某个通常为其他类型的成员，因此 autospec 不会为被设为 None 的成员使用 spec。 它们将为普通的 mock (嗯 —— 应为 MagicMocks):

>>> class Something:
...     member = None
...
>>> mock = create_autospec(Something)
>>> mock.member.foo.bar.baz()
<MagicMock name='mock.member.foo.bar.baz()' id='...'>

如果你不喜欢修改你的生产类来添加默认值那么还有其他的选项。 其中之一是简单地使用一个实例而非类作为 spec。 另一选项则是创建一个生产类的子类并向该子类添加默认值而不影响到生产类。 这两个选项都需要你使用一个替代对象作为 spec。 值得庆幸的是 patch() 支持这样做 —— 你可以简单地传入替代对象作为 autospec 参数:

>>> 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='...'>

4

这仅适用于类或已实例化的对象。 调用一个被模拟的类来创建一个 mock 实例 不会 创建真的实例。 只有属性查找 —— 以及对 dir() 的调用 —— 会被执行。

将 mock 封包

unittest.mock.seal(mock)

封包将在访问被封包的 mock 的属性或其任何已经被递归地模拟的属性时禁止自动创建 mock。

如果一个带有名称或 spec 的 mock 实例被分配给一个属性则将不会在封包链中处理它。 这可以防止人们对 mock 对象的固定部分执行封包。

>>> mock = Mock()
>>> mock.submock.attribute1 = 2
>>> mock.not_submock = mock.Mock(name="sample_name")
>>> seal(mock)
>>> mock.new_attribute  # This will raise AttributeError.
>>> mock.submock.attribute2  # This will raise AttributeError.
>>> mock.not_submock.attribute2  # This won't raise.

3.7 新版功能.

unittest.mock --- 上手指南

3.3 新版功能.

使用 mock

模拟方法调用

使用 Mock 的常见场景：

模拟函数调用

记录在对象上的方法调用

你可能需要替换一个对象上的方法，用于确认此方法被系统中的其他部分调用过，并且调用时使用了正确的参数。

>>> real = SomeClass()
>>> real.method = MagicMock(name='method')
>>> real.method(3, 4, 5, key='value')
<MagicMock name='method()' id='...'>

使用了 mock (本例中的 real.method) 之后，它有方法和属性可以让你针对它是被如何使用的下断言。

注解

在多数示例中，Mock 与 MagicMock 两个类可以相互替换，而 MagicMock 是一个更适用的类，通常情况下，使用它就可以了。

如果 mock 被调用，它的 called 属性就会变成 True，更重要的是，我们可以使用 assert_called_with() 或者 assert_called_once_with() 方法来确认它在被调用时使用了正确的参数。

在如下的测试示例中，验证对于 ProductionClass().method 的调用会导致 something 的调用。

>>> 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)

对象上的方法调用的 mock

上一个例子中我们直接在对象上给方法打补丁以检查它是否被正确地调用。 另一个常见的用例是将一个对象传给一个方法（或被测试系统的某个部分）然后检查它是否以正确的方式被使用。

下面这个简单的 ProductionClass 具有一个 closer 方法。 如果它附带一个对象被调用那么它就会调用其中的 close。

>>> class ProductionClass:
...     def closer(self, something):
...         something.close()
...

所以为了测试它我们需要传入一个带有 close 方法的对象并检查它是否被正确地调用。

>>> real = ProductionClass()
>>> mock = Mock()
>>> real.closer(mock)
>>> mock.close.assert_called_with()

我们不需要做任何事来在我们的 mock 上提供 'close' 方法。 访问 close 的操作就会创建它。 因此，如果 'close' 还未被调用那么在测试时访问它就将创建它，但是 assert_called_with() 则会引发一个失败的异常。

模拟类

一个常见的用例是模拟被测试的代码所实例化的类。 当你给一个类打上补丁，该类就会被替换为一个 mock。 实例是通过 调用该类 来创建的。 这意味着你要通过查看被模拟类的返回值来访问“mock 实例”。

在下面的例子中我们有一个函数 some_function 实例化了 Foo 并调用该实例中的一个方法。 对 patch() 的调用会将类 Foo 替换为一个 mock。 Foo 实例是调用该 mock 的结果，所以它是通过修改 return_value 来配置的。

>>> 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'

命名你的 mock

给你的 mock 起个名字可能会很有用。 名字会显示在 mock 的 repr 中并在 mock 出现于测试失败消息中时可以帮助理解。 这个名字也会被传播给 mock 的属性或方法:

>>> mock = MagicMock(name='foo')
>>> mock
<MagicMock name='foo' id='...'>
>>> mock.method
<MagicMock name='foo.method' id='...'>

追踪所有的调用

通常你会想要追踪对某个方法的多次调用。 mock_calls 属性记录了所有对 mock 的子属性的调用 —— 并且还包括对它们的子属性的调用。

>>> 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)]

如果你做了一个有关 mock_calls 的断言并且有任何非预期的方法被调用，则断言将失败。 这很有用处，因为除了断言你所预期的调用已被执行，你还会检查它们是否以正确的顺序被执行并且没有额外的调用:

你使用 call 对象来构造列表以便与 mock_calls 进行比较:

>>> expected = [call.method(), call.attribute.method(10, x=53)]
>>> mock.mock_calls == expected
True

然而，返回 mock 的调用的形参不会被记录，这意味着不可能追踪附带了重要形参的创建上级对象的嵌套调用:

>>> m = Mock()
>>> m.factory(important=True).deliver()
<Mock name='mock.factory().deliver()' id='...'>
>>> m.mock_calls[-1] == call.factory(important=False).deliver()
True

设置返回值和属性

在 mock 对象上设置返回值是非常容易的:

>>> mock = Mock()
>>> mock.return_value = 3
>>> mock()
3

当然你也可以对 mock 上的方法做同样的操作:

>>> mock = Mock()
>>> mock.method.return_value = 3
>>> mock.method()
3

返回值也可以在构造器中设置:

>>> mock = Mock(return_value=3)
>>> mock()
3

如果你需要在你的 mock 上设置一个属性，只需这样做:

>>> mock = Mock()
>>> mock.x = 3
>>> mock.x
3

有时你会想要模拟更复杂的情况，例如这个例子 mock.connection.cursor().execute("SELECT 1")。 如果我们希望这个调用返回一个列表，那么我们还必须配置嵌套调用的结果。

我们可以像这样使用 call 在一个“链式调用”中构造调用集合以便随后方便地设置断言:

>>> 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

对 .call_list() 的调用会将我们的调用对象转成一个代表链式调用的调用列表。

通过 mock 引发异常

一个很有用的属性是 side_effect。 如果你将该属性设为一个异常类或者实例那么当 mock 被调用时该异常将会被引发。

>>> mock = Mock(side_effect=Exception('Boom!'))
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!

附带影响函数和可迭代对象

side_effect 也可以被设为一个函数或可迭代对象。 side_effect 作为可迭代对象的应用场景适用于你的 mock 将要被多次调用，并且你希望每次调用都返回不同的值的情况。 当你将 side_effect 设为一个可迭代对象时每次对 mock 的调用将返回可迭代对象的下一个值。

>>> mock = MagicMock(side_effect=[4, 5, 6])
>>> mock()
4
>>> mock()
5
>>> mock()
6

对于更高级的用例，例如根据 mock 调用时附带的参数动态改变返回值，side_effect 可以指定一个函数。 该函数将附带与 mock 相同的参数被调用。 该函数所返回的就是调用所返回的对象:

>>> 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

模拟异步迭代器

从 Python 3.8 起，AsyncMock 和 MagicMock 支持通过 __aiter__ 来模拟 异步迭代器。 __aiter__ 的 return_value 属性可以被用来设置要用于迭代的返回值。

>>> 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]

模拟异步上下文管理器

从 Python 3.8 起，AsyncMock 和 MagicMock 支持通过 __aenter__ 和 __aexit__ 来模拟 异步上下文管理器。 在默认情况下，__aenter__ 和 __aexit__ 将为返回异步函数的 AsyncMock 实例。

>>> 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()

基于现有对象创建模拟对象

使用模拟操作的一个问题是它会将你的测试与你的 mock 实现相关联而不是与你的真实代码相关联。 假设你有一个实现了 some_method 的类。 在对另一个类的测试中，你提供了一个 同样 提供了 some_method 的模拟该对象的 mock 对象。 如果后来你重构了第一个类，使得它不再具有 some_method —— 那么你的测试将继续保持通过，尽管现在你的代码已经被破坏了！

Mock 允许你使用allows you to provide an object as a specification for the mock, using the spec 关键字参数来提供一个对象作为 mock 的规格说明。 在 mock 上访问不存在于你的规格说明对象中的方法 / 属性将立即引发一个属性错误。 如果你修改你的规格说明的实现，，那么使用了该类的测试将立即开始失败而不需要你在这些测试中实例化该类。

>>> mock = Mock(spec=SomeClass)
>>> mock.old_method()
Traceback (most recent call last):
   ...
AttributeError: object has no attribute 'old_method'

使用规格说明还可以启用对 mock 的调用的更聪明的匹配操作，无论是否有将某些形参作为位置或关键字参数传入:

>>> 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)

如果你想要让这些更聪明的匹配操作也适用于 mock 上的方法调用，你可以使用 auto-speccing。

如果你想要更强形式的规格说明以防止设置任意属性并获取它们那么你可以使用 spec_set 来代替 spec。

补丁装饰器

注解

在查找对象的名称空间中修补对象使用 patch() 。使用起来很简单，阅读 在哪里打补丁 来快速上手。

测试中的一个常见需求是为类属性或模块属性打补丁，例如修补内置对象或修补某个模块中的类来测试其是否被实例化。 模块和类都可算是全局对象，因此对它们打补丁的操作必须在测试完成之后被还原否则补丁将持续影响其他测试并导致难以诊断的问题。

为此 mock 提供了三个便捷的装饰器: patch(), patch.object() 和 patch.dict()。 patch 接受单个字符串，其形式 package.module.Class.attribute 指明你要修补的属性。 它还可选择接受一个值用来替换指定的属性（或者类对象等等）。 'patch.object' 接受一个对象和你想要修补的属性名称，并可选择接受要用作补丁的值。

patch.object:

>>> 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()

如果你要给一个模块 (包括 builtins) 打补丁则可使用 patch() 来代替 patch.object():

>>> 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"

如有必要模块名可以是“带点号”的，其形式如 package.module:

>>> @patch('package.module.ClassName.attribute', sentinel.attribute)
... def test():
...     from package.module import ClassName
...     assert ClassName.attribute == sentinel.attribute
...
>>> test()

一个良好的模式是实际地装饰测试方法本身:

>>> 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

如果你想要通过 Mock 来打补丁，你可以只附带一个参数使用 patch() (或附带两个参数使用 patch.object())。 这将为你创建 mock 并传递给测试函数 / 方法:

>>> 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()

你可以使用以下模式来堆叠多个补丁装饰器:

>>> 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()

当你嵌套 patch 装饰器时将以它们被应用的相同顺序（即 Python 应用装饰器的正常顺序）将 mock 传入被装饰的函数。 也就是说从下往上，因此在上面的示例中 test_module.ClassName2 的 mock 会被最先传入。

还有一个 patch.dict() 用于在一定范围内设置字典中的值，并在测试结束时将字典恢复为其原始状态：

>>> foo = {'key': 'value'}
>>> original = foo.copy()
>>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True):
...     assert foo == {'newkey': 'newvalue'}
...
>>> assert foo == original

patch, patch.object 和 patch.dict 都可被用作上下文管理器。

在你使用 patch() 为你创建 mock 时，你可以使用 with 语句的 "as" 形式来获得对 mock 的引用:

>>> 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)

作为替代 patch, patch.object 和 patch.dict 可以被用作类装饰器。 当以此方式使用时其效果与将装饰器单独应用到每个以 "test" 打头的方法上相同。

更多示例

下面是一些针对更为高级应用场景的补充示例。

模拟链式调用

实际上一旦你理解了 return_value 属性那么使用 mock 模拟链式调用就会相当直观。 当一个 mock 首次被调用，或者当你在它被调用前获取其 return_value 时，将会创建一个新的 Mock。

这意味着你可以通过检视 return_value mock 来了解从调用被模拟对象返回的对象是如何被使用的:

>>> mock = Mock()
>>> mock().foo(a=2, b=3)
<Mock name='mock().foo()' id='...'>
>>> mock.return_value.foo.assert_called_with(a=2, b=3)

从这里开始只需一个步骤即可配置并创建有关链式调用的断言。 当然还有另一种选择是首先以更易于测试的方式来编写你的代码...

因此，如果我们有这样一些代码:

>>> 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

假定 BackendProvider 已经过良好测试，我们要如何测试 method()？ 特别地，我们希望测试代码段 # more code 是否以正确的方式使用了响应对象。

由于这个链式调用来自一个实例属性我们可以对 backend 属性在 Something 实例上进行猴子式修补。 在这个特定情况下我们只对最后调用 start_call 的返回值感兴趣所以我们不需要进行太多的配置。 让我们假定它返回的是“文件类”对象，因此我们将确保我们的响应对象使用内置的 open() 作为其 spec。

为了做到这一点我们创建一个 mock 实例作为我们的 mock 后端并为它创建一个 mock 响应对象。 要将该响应对象设为最后的 start_call 的返回值我们可以这样做:

mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response

我们可以通过更好一些的方式做到这一点，即使用 configure_mock() 方法直接为我们设置返回值:

>>> 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)

有了这些我们就能准备好给“mock 后端”打上猴子补丁并可以执行真正的调用:

>>> something.backend = mock_backend
>>> something.method()

使用 mock_calls 我们可以通过一个断言来检查链式调用。 一个链式调用就是在一行代码中连续执行多个调用，所以在 mock_calls 中将会有多个条目。 我们可以使用 call.call_list() 来为我们创建这个调用列表:

>>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
>>> call_list = chained.call_list()
>>> assert mock_backend.mock_calls == call_list

部分模拟

在某些测试中我希望模拟对 datetime.date.today() 的调用以返回一个已知的日期，但我又不想阻止被测试的代码创建新的日期对象。 很不幸 datetime.date 是用 C 语言编写的，因此我不能简单地给静态的 date.today() 方法打上猴子补丁。

我找到了实现这一点的简单方式即通过一个 mock 来实际包装日期类，但通过对构造器的调用传递给真实的类（并返回真实的实例）。

这里使用 patch 装饰器 来模拟被测试模块中的 date 类。 模拟 date 类中的 side_effect 属性随后被设为一个返回真实日期的 lambda 函数。 当模拟 date 类被调用时将由 side_effect 构造并返回一个真实日期。

>>> from datetime import date
>>> with patch('mymodule.date') as mock_date:
...     mock_date.today.return_value = date(2010, 10, 8)
...     mock_date.side_effect = lambda *args, **kw: date(*args, **kw)
...
...     assert mymodule.date.today() == date(2010, 10, 8)
...     assert mymodule.date(2009, 6, 8) == date(2009, 6, 8)

请注意我们没有在全局范围上修补 datetime.date，我们只是在 使用 它的模块中给 date 打补丁。 参见 补丁的位置。

当 date.today() 被调用时将返回一个已知的日期，但对 date(...) 构造器的调用仍会返回普通的日期。 如果不是这样你会发现你必须使用与被测试的代码完全相同的算法来计算出预期的结果，这是测试工作中的一个经典的反模式。

对 date 构造器的调用会被记录在 mock_date 属性中 (call_count 等)，它们也可能对你的测试有用处。

有关处理模块日期或其他内置类的一种替代方式的讨论请参见 这篇博客文章 [https://williambert.online/2011/07/how-to-unit-testing-in-django-with-mocking-and-patching/]。

模拟生成器方法

Python 生成器是指在被迭代时使用 yield 语句来返回一系列值的函数或方法 1。

调用生成器方法 / 函数将返回生成器对象。 生成器对象随后会被迭代。 迭代操作对应的协议方法是 __iter__()，因此我们可以使用 MagicMock 来模拟它。

以下是一个使用 "iter" 方法模拟为生成器的示例类:

>>> class Foo:
...     def iter(self):
...         for i in [1, 2, 3]:
...             yield i
...
>>> foo = Foo()
>>> list(foo.iter())
[1, 2, 3]

我们要如何模拟这个类，特别是它的 "iter" 方法呢？

为了配置从迭代操作（隐含在对 list 的调用中）返回的值，我们需要配置调用 foo.iter() 所返回的对象。

>>> mock_foo = MagicMock()
>>> mock_foo.iter.return_value = iter([1, 2, 3])
>>> list(mock_foo.iter())
[1, 2, 3]

1

此外还有生成器表达式和更多的生成器 进阶用法 [http://www.dabeaz.com/coroutines/index.html]，但在这里我们不去关心它们。 有关生成器及其强大功能的一个很好的介绍请参阅: 针对系统程序员的生成器妙招 [http://www.dabeaz.com/generators/]。

对每个测试方法应用相同的补丁

如果你想要为多个测试方法准备好一些补丁那么最简单的方式就是将 patch 装饰器应用到每个方法。 这在感觉上会造成不必要的重复。 对于 Python 2.6 或更新的版本你可以使用 patch() (其所有不同的形式) 作为类装饰器。 这将把补丁应用于类中的所有测试方法。 测试方法是通过名称前缀为 test 来标识的:

>>> @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'

另一种管理补丁的方式是使用 补丁方法: start 和 stop。 它允许你将打补丁操作移至你的 setUp 和 tearDown 方法中。

>>> 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()

如果你要使用这个技巧则你必须通过调用 stop 来确保补丁被“恢复”。 这可能要比你想像的更麻烦，因为如果在 setUp 中引发了异常那么 tearDown 将不会被调用。 unittest.TestCase.addCleanup() 可以做到更方便:

>>> 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()

模拟未绑定方法

当前在编写测试时我需要修补一个 未绑定方法 (在类上而不是在实例上为方法打补丁)。 我需要将 self 作为第一个参数传入因为我想对哪些对象在调用这个特定方法进行断言。 问题是这里你不能用 mock 来打补丁，因为如果你用 mock 来替换一个未绑定方法那么当从实例中获取时它就不会成为一个已绑定方法，因而它不会获得传入的 self。 绕过此问题的办法是改用一个真正的函数来修补未绑定方法。 patch() 装饰器让使用 mock 来给方法打补丁变得如此简单以至于创建一个真正的函数成为一件麻烦事。

如果将 autospec=True 传给 patch 那么它就会用一个 真正的 函数对象来打补丁。 这个函数对象具有与它所替换的函数相同的签名，但会在内部将操作委托给一个 mock。 你仍然可以通过与以前完全相同的方式来自动创建你的 mock。 但是这将意味着一件事，就是如果你用它来修补一个类上的非绑定方法那么如果它是从一个实例中获取则被模拟的函数将被转为已绑定方法。 传给它的第一个参数将为 self，而这真是我想要的:

>>> 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)

如果我们不使用 autospec=True 那么这个未绑定方法会改为通过一个 Mock 补丁来修补，而不是附带 self 来调用。

通过 mock 检查多次调用

mock 有一个很好的 API 用于针对你的 mock 对象如何被使用来下断言。

>>> mock = Mock()
>>> mock.foo_bar.return_value = None
>>> mock.foo_bar('baz', spam='eggs')
>>> mock.foo_bar.assert_called_with('baz', spam='eggs')

如果你的 mock 只会被调用一次你可以使用 assert_called_once_with() 方法，这也将断言 call_count 为一。

>>> 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 to be called once. Called 2 times.

assert_called_with 和 assert_called_once_with 都是有关 最近 调用的断言。 如果你的 mock 将被多次调用，并且你想要针对 所有 这些调用下断言你可以使用 call_args_list:

>>> 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()]

使用 call 辅助对象可以方便地针对这些调用下断言。 你可以创建一个预期调用的列表并将其与 call_args_list 比较。 这看起来与 call_args_list 的 repr 非常相似:

>>> expected = [call(1, 2, 3), call(4, 5, 6), call()]
>>> mock.call_args_list == expected
True

处理可变参数

另一种很少见，但可能给你带来麻烦的情况会在你的 mock 附带可变参数被调用的时候发生。 call_args 和 call_args_list 将保存对这些参数的 引用。 如果这些参数被受测试的代码所改变那么你将无法再针对当该 mock 被调用时附带的参数值下断言。

下面是一些演示此问题的示例代码。 设想在 'mymodule' 中定义了下列函数:

def frob(val):
    pass

def grob(val):
    "First frob and then clear val"
    frob(val)
    val.clear()

当我们想要测试 grob 调用 frob 并附带了正确的参数时将可看到发生了什么:

>>> 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(),), {})

对于 mock 的一个可能性是复制你传入的参数。 如果你创建依赖于对象标识号相等性的断言那么这可能会在后面导致问题。

下面是一个使用 side_effect 功能的解决方案。 如果你为 mock 提供了 side_effect 函数那么 side_effect 将附带与该 mock 相同的参数被调用。 这使我们有机会拷贝这些参数并保存它们用于之后进行断言。 在这个例子中我使用了 另一个 mock 来保存参数以便我可以使用该 mock 的方法来进行断言。 在这里辅助函数再次为我设置好了所需的功能。

>>> 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})

调用 copy_call_args 时会传入将被调用的 mock。 它将返回一个新的 mock 供我们进行断言。 side_effect 函数会拷贝这些参数并附带该副本来调用我们的 new_mock。

注解

如果你的 mock 只会被使用一次那么有更容易的方式可以在它们被调用时检查参数。 你可以简单地在 side_effect 函数中执行检查。

>>> def side_effect(arg):
...     assert arg == {6}
...
>>> mock = Mock(side_effect=side_effect)
>>> mock({6})
>>> mock(set())
Traceback (most recent call last):
    ...
AssertionError

一个替代方式是创建一个 Mock 或 MagicMock 的子类来拷贝 (使用 copy.deepcopy()) 参数。 下面是一个示例实现:

>>> 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: mock({1})
Actual call: mock(set())
>>> c.foo
<CopyingMock name='mock.foo' id='...'>

当你子类化 Mock 或 MagicMock 时所有动态创建的属性以及 return_value 都将自动使用你的子类。 这意味着 CopyingMock 的所有子类也都将为 CopyingMock 类型。

嵌套补丁

使用 patch 作为上下文管理器很不错，但是如果你要执行多个补丁你将不断嵌套 with 语句使得代码越来越深地向右缩进:

>>> 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

使用 unittest cleanup 函数和 补丁方法: start 和 stop 我们可以达成同样的效果而无须嵌套缩进。 一个简单的辅助方法 create_patch 会为我们执行打补丁操作并返回所创建的 mock:

>>> 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

使用 MagicMock 模拟字典

你可能会想要模拟一个字典或其他容器对象，记录所有对它的访问并让它的行为仍然像是一个字典。

要做到这点我们可以用 MagicMock，它的行为类似于字典，并会使用 side_effect 将字典访问委托给下层的在我们控制之下的一个真正的字典。

当我们的 MagicMock 的 __getitem__() 和 __setitem__() 方法被调用（即普通的字典访问操作）时 side_effect 将附带键（对于 __setitem__ 则还将附带值）被调用。 我们也可以控制返回的对象。

在 MagicMock 被使用之后我们可以使用 call_args_list 等属性来针对该字典是如何被使用的下断言。

>>> 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

注解

MagicMock 的一个可用替代是使用 Mock 并 仅仅 提供你明确需要的魔术方法:

>>> mock = Mock()
>>> mock.__getitem__ = Mock(side_effect=getitem)
>>> mock.__setitem__ = Mock(side_effect=setitem)

第三个 选项是使用 MagicMock 但传入 dict 作为 spec (或 spec_set) 参数以使得所创建的 MagicMock 只有字典魔术方法是可用的:

>>> mock = MagicMock(spec_set=dict)
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem

通过提供这些附带影响函数，mock 的行为将类似于普通字典但又会记录所有访问。 如果你尝试访问一个不存在的键它甚至会引发 KeyError。

>>> 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'

在它被使用之后你可以使用普通的 mock 方法和属性进行有关访问操作的断言:

>>> 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'}

模拟子类及其属性

你可能出于各种原因想要子类化 Mock。 其中一个可能的原因是为了添加辅助方法。 下面是一个笨兮兮的示例:

>>> 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

The standard behaviour for Mock 实例的标准行为是属性和返回值 mock 具有与它们所访问的 mock 相同的类型。 这将确保 Mock 的属性均为 Mocks 而 MagicMock 的属性均为 MagicMocks 2。 因此如果你通过子类化来添加辅助方法那么它们也将在你的子类的实例的属性和返回值 mock 上可用。

>>> 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

有时这很不方便。 例如，有一位用户 [https://code.google.com/archive/p/mock/issues/105] 子类化 mock 来创建一个 Twisted 适配器 [https://twistedmatrix.com/documents/11.0.0/api/twisted.python.components.html]。 将它也应用到属性实际上会导致出错。

Mock (它的所有形式) 使用一个名为 _get_child_mock 的方法来创建这些用于属性和返回值的“子 mock”。 你可以通过重写此方法来防止你的子类被用于属性。 其签名被设为接受任意关键字参数 (**kwargs) 并且它们会被传递给 mock 构造器:

>>> 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)

2

此规则的一个例外涉及不可调用 mock。 属性会使用可调用对象版本是因为如非如此则不可调用 mock 将无法拥有可调用的方法。

通过 patch.dict 模拟导入

有一种会令模拟变困难的情况是当你在函数内部有局部导入。 这更难模拟的原因是它们不是使用来自我们能打补丁的模拟命名空间中的对象。

一般来说局部导入是应当避免的。 局部导入有时是为了防止循环依赖，而这个问题 通常 都有更好的解决办法（重构代码）或者通过延迟导入来防止“前期成本”。 这也可以通过比无条件地局部导入更好的方式来解决（将模块保存为一个类或模块属性并且只在首次使用时执行导入）。

除此之外还有一个办法可以使用 mock 来影响导入的结果。 导入操作会从 sys.modules 字典提取一个 对象。 请注意是提取一个 对象，它不是必须为模块。 首次导入一个模块将使一个模块对象被放入 sys.modules，因此通常当你执行导入时你将得到一个模块。 但是并非必然如此。

这意味着你可以使用 patch.dict() 来 临时性地 将一个 mock 放入 sys.modules。 在补丁激活期间的任何导入操作都将得到该 mock。 当补丁完成时（被装饰的函数退出，with 语句代码块结束或者 patcher.stop() 被调用）则之前存在的任何东西都将被安全地恢复。

下面是一个模拟 'fooble' 模拟的示例。

>>> 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()

你可以看到 import fooble 成功执行，而当退出时 sys.modules 中将不再有 'fooble'。

这同样适用于 from module import name 形式:

>>> 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()

稍微多做一点工作你还可以模拟包的导入:

>>> 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()

追踪调用顺序和不太冗长的调用断言

Mock 类允许你通过 method_calls 属性来追踪在你的 mock 对象上的方法调用的 顺序。 这并不允许你追踪单独 mock 对象之间的调用顺序，但是我们可以使用 mock_calls 来达到同样的效果。

因为 mock 会追踪 mock_calls 中对子 mock 的调用，并且访问 mock 的任意属性都会创建一个子 mock，所以我们可以基于父 mock 创建单独的子 mock。 随后对这些子 mock 的调用将按顺序被记录在父 mock 的 mock_calls 中:

>>> manager = Mock()
>>> mock_foo = manager.foo
>>> mock_bar = manager.bar

>>> mock_foo.something()
<Mock name='mock.foo.something()' id='...'>
>>> mock_bar.other.thing()
<Mock name='mock.bar.other.thing()' id='...'>

>>> manager.mock_calls
[call.foo.something(), call.bar.other.thing()]

我们可以随后通过与管理器 mock 上的 mock_calls 属性进行比较来进行有关这些调用，包括调用顺序的断言:

>>> expected_calls = [call.foo.something(), call.bar.other.thing()]
>>> manager.mock_calls == expected_calls
True

如果 patch 创建并准备好了你的 mock 那么你可以使用 attach_mock() 方法将它们附加到管理器 mock 上。 在附加之后所有调用都将被记录在管理器的 mock_calls 中。

>>> 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()]

如果已经进行了许多调用，但是你只对它们的一个特定序列感兴趣则有一种替代方式是使用 assert_has_calls() 方法。 这需要一个调用的列表（使用 call 对象来构建）。 如果该调用序列在 mock_calls 中则断言将成功。

>>> 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)

即使链式调用 m.one().two().three() 不是对 mock 的唯一调用，该断言仍将成功。

有时可能会对一个 mock 进行多次调用，而你只对断言其中的 某些 调用感兴趣。 你甚至可能对顺序也不关心。 在这种情况下你可以将 any_order=True 传给 assert_has_calls:

>>> 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)

更复杂的参数匹配

使用与 ANY 一样的基本概念我们可以实现匹配器以便在用作 mock 的参数的对象上执行更复杂的断言。

假设我们准备将某个对象传给一个在默认情况下基于对象标识相等（这是 Python 中用户自定义类的默认行为）的 mock。 要使用 assert_called_with() 我们就将必须传入完全相同的对象。 如果我们只对该对象的某些属性感兴趣那么我们可以创建一个能为我们检查这些属性的匹配器。

在这个示例中你可以看到为何执行对 assert_called_with 的‘标准’调用并不足够:

>>> 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(<__main__.Foo object at 0x...>)
Actual call: call(<__main__.Foo object at 0x...>)

一个针对我们的 Foo 类的比较函数看上去会是这样的:

>>> 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
...

而一个可以使用这样的比较函数进行相等性比较运算的匹配器对象看上去会是这样的:

>>> 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)
...

将所有这些放在一起:

>>> match_foo = Matcher(compare, Foo(1, 2))
>>> mock.assert_called_with(match_foo)

Matcher 是用我们的比较函数和我们想要比较的 Foo 对象来实例化的。 在 assert_called_with 中将会调用 Matcher 的相等性方法，它会将调用 mock 时附带的对象与我们创建我们的匹配器时附带的对象进行比较。 如果它们匹配则 assert_called_with 通过，而如果不匹配则会引发 AssertionError:

>>> 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...>,), {})

通过一些调整你可以让比较函数直接引发 AssertionError 并提供更有用的失败消息。

从 1.5 版开始，Python 测试库 PyHamcrest [https://pyhamcrest.readthedocs.io/] 提供了类似的功能，在这里可能会很有用，它采用的形式是相等性匹配器 (hamcrest.library.integration.match_equality [https://pyhamcrest.readthedocs.io/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality])。

2to3 --- 自动化的 Python 2 到 3 代码转写

2to3 是一个 Python 程序，它可以读取 Python 2.x 的源代码并使用一系列的 修复器 来将其转换为合法的 Python 3.x 代码。 标准库已包含了丰富的修复器，这足以处理几乎所有代码。 不过 2to3 的支持库 lib2to3 是一个很灵活通用的库，所以还可以编写你自己的 2to3 修复器。

使用 2to3

2to3 通常会作为脚本和 Python 解释器一起安装，你可以在 Python 根目录的 Tools/scripts 文件夹下找到它。

2to3 的基本调用参数是一个需要转换的文件或目录列表。对于目录，会递归地寻找其中的 Python 源码。

这里有一个 Python 2.x 的源码文件，example.py：

def greet(name):
    print "Hello, {0}!".format(name)
print "What's your name?"
name = raw_input()
greet(name)

它可以在命令行中使用 2to3 转换成 Python 3.x 版本的代码：

$ 2to3 example.py

这个命令会打印出和源文件的区别。通过传入 -w 参数，2to3 也可以把需要的修改写回到原文件中（除非传入了 -n 参数，否则会为原始文件创建一个副本）：

$ 2to3 -w example.py

在转换完成后，example.py 看起来像是这样：

def greet(name):
    print("Hello, {0}!".format(name))
print("What's your name?")
name = input()
greet(name)

注释和缩进都会在转换过程中保持不变。

默认情况下，2to3 会执行 预定义修复器 的集合。使用 -l 参数可以列出所有可用的修复器。使用 -f 参数可以明确指定需要使用的修复器集合。而使用 -x 参数则可以明确指定不使用的修复器。下面的例子会只使用 imports 和 has_key 修复器运行：

$ 2to3 -f imports -f has_key example.py

这个命令会执行除了 apply 之外的所有修复器：

$ 2to3 -x apply example.py

有一些修复器是需要 显式指定 的，它们默认不会执行，必须在命令行中列出才会执行。比如下面的例子，除了默认的修复器以外，还会执行 idioms 修复器：

$ 2to3 -f all -f idioms example.py

注意这里使用 all 来启用所有默认的修复器。

有些情况下 2to3 会找到源码中有一些需要修改，但是无法自动处理的代码。在这种情况下，2to3 会在差异处下面打印一个警告信息。你应该定位到相应的代码并对其进行修改，以使其兼容 Python 3.x。

2to3 也可以重构 doctests。使用 -d 开启这个模式。需要注意*只有* doctests 会被重构。这种模式下不需要文件是合法的 Python 代码。举例来说，reST 文档中类似 doctests 的示例也可以使用这个选项进行重构。

-v 选项可以输出更多转换程序的详细信息。

由于某些 print 语句可被解读为函数调用或是语句，2to3 并不总能读取包含 print 函数的文件。 当 2to3 检测到存在 from __future__ import print_function 编译器指令时，会修改其内部语法将 print() 解读为函数。 这一变动也可以使用 -p 旗标手动开启。 使用 -p 来为已转换过 print 语句的代码运行修复器。 也可以使用 -e 将 exec() 解读为函数。

-o 或 --output-dir 选项可以指定将转换后的文件写入其他目录中。由于这种情况下不会覆写原始文件，所以创建副本文件毫无意义，因此也需要使用 -n 选项来禁用创建副本。

3.2.3 新版功能: 增加了 -o 选项。

-W 或 --write-unchanged-files 选项用来告诉 2to3 始终需要输出文件，即使没有任何改动。这在使用 -o 参数时十分有用，这样就可以将整个 Python 源码包完整地转换到另一个目录。这个选项隐含了 -w 选项，否则等于没有作用。

3.2.3 新版功能: 增加了 -W 选项。

--add-suffix 选项接受一个字符串，用来作为后缀附加在输出文件名后面的后面。由于写入的文件名与原始文件不同，所以没有必要创建副本，因此 -n 选项也是必要的。举个例子：

$ 2to3 -n -W --add-suffix=3 example.py

这样会把转换后的文件写入 example.py3 文件。

3.2.3 新版功能: 增加了 --add-suffix 选项。

将整个项目从一个目录转换到另一个目录可以用这样的命令：

$ 2to3 --output-dir=python3-version/mycode -W -n python2-version/mycode

修复器

转换代码的每一个步骤都封装在修复器中。可以使用 2to3 -l 来列出可用的修复器。之前已经提到，每个修复器都可以独立地打开或是关闭。下面会对各个修复器做更详细的描述。

apply

移除对 apply() 的使用，举例来说，apply(function, *args, **kwargs) 会被转换成 function(*args, **kwargs)。

asserts

将已弃用的 unittest 方法替换为正确的。

从 | 到
failUnlessEqual(a, b) | assertEqual(a, b)
assertEquals(a, b) | assertEqual(a, b)
failIfEqual(a, b) | assertNotEqual(a, b)
assertNotEquals(a, b) | assertNotEqual(a, b)
failUnless(a) | assertTrue(a)
assert_(a) | assertTrue(a)
failIf(a) | assertFalse(a)
failUnlessRaises(exc, cal) | assertRaises(exc, cal)
failUnlessAlmostEqual(a, b) | assertAlmostEqual(a, b)
assertAlmostEquals(a, b) | assertAlmostEqual(a, b)
failIfAlmostEqual(a, b) | assertNotAlmostEqual(a, b)
assertNotAlmostEquals(a, b) | assertNotAlmostEqual(a, b)

basestring

将 basestring 转换为 str。

buffer

将 buffer 转换为 memoryview。这个修复器是可选的，因为 memoryview API 和 buffer 很相似，但不完全一样。

dict

修复字典迭代方法。dict.iteritems() 会转换成 dict.items()，dict.iterkeys() 会转换成 dict.keys()，dict.itervalues() 会转换成 dict.values()。类似的，dict.viewitems()，dict.viewkeys() 和 dict.viewvalues() 会分别转换成 dict.items()，dict.keys() 和 dict.values()。另外也会将原有的 dict.items()，dict.keys() 和 dict.values() 方法调用用 list 包装一层。

except

将 except X, T 转换为 except X as T。

exec

将 exec 语句转换为 exec() 函数调用。

execfile

移除 execfile() 的使用。execfile() 的实参会使用 open()，compile() 和 exec() 包装。

exitfunc

将对 sys.exitfunc 的赋值改为使用 atexit 模块代替。

filter

将 filter() 函数用 list 包装一层。

funcattrs

修复已经重命名的函数属性。比如 my_function.func_closure 会被转换为 my_function.__closure__。

future

移除 from __future__ import new_feature 语句。

getcwdu

将 os.getcwdu() 重命名为 os.getcwd()。

has_key

将 dict.has_key(key) 转换为 key in dict。

idioms

这是一个可选的修复器，会进行多种转换，将 Python 代码变成更加常见的写法。类似 type(x) is SomeClass 和 type(x) == SomeClass 的类型对比会被转换成 isinstance(x, SomeClass)。while 1 转换成 while True。这个修复器还会在合适的地方使用 sorted() 函数。举个例子，这样的代码块：

L = list(some_iterable)
L.sort()

会被转换为：

L = sorted(some_iterable)

import

检测 sibling imports，并将其转换成相对 import。

imports

处理标准库模块的重命名。

imports2

处理标准库中其他模块的重命名。这个修复器由于一些技术上的限制，因此和 imports 拆分开了。

input

将 input(prompt) 转换为 eval(input(prompt))。

intern

将 intern() 转换为 sys.intern()。

isinstance

修复 isinstance() 函数第二个实参中重复的类型。举例来说，isinstance(x, (int, int)) 会转换为 isinstance(x, int), isinstance(x, (int, float, int)) 会转换为 isinstance(x, (int, float))。

itertools_imports

移除 itertools.ifilter()，itertools.izip() 以及 itertools.imap() 的 import。对 itertools.ifilterfalse() 的 import 也会替换成 itertools.filterfalse()。

itertools

修改 itertools.ifilter()，itertools.izip() 和 itertools.imap() 的调用为对应的内建实现。itertools.ifilterfalse() 会替换成 itertools.filterfalse()。

long

将 long 重命名为 int。

map

用 list 包装 map()。同时也会将 map(None, x) 替换为 list(x)。使用 from future_builtins import map 禁用这个修复器。

metaclass

将老的元类语法（类体中的 __metaclass__ = Meta）替换为新的（class X(metaclass=Meta)）。

methodattrs

修复老的方法属性名。例如 meth.im_func 会被转换为 meth.__func__。

ne

转换老的不等语法，将 <> 转为 !=。

next

将迭代器的 next() 方法调用转为 next() 函数。也会将 next() 方法重命名为 __next__()。

nonzero

将被调用的方法定义 __nonzero__() 改名为 __bool__()。

numliterals

将八进制字面量转为新的语法。

operator

将 operator 模块中的许多方法调用转为其他的等效函数调用。如果有需要，会添加适当的 import 语句，比如 import collections.abc。有以下转换映射：

从 | 到
operator.isCallable(obj) | callable(obj)
operator.sequenceIncludes(obj) | operator.contains(obj)
operator.isSequenceType(obj) | isinstance(obj, collections.abc.Sequence)
operator.isMappingType(obj) | isinstance(obj, collections.abc.Mapping)
operator.isNumberType(obj) | isinstance(obj, numbers.Number)
operator.repeat(obj, n) | operator.mul(obj, n)
operator.irepeat(obj, n) | operator.imul(obj, n)

paren

在列表生成式中增加必须的括号。例如将 [x for x in 1, 2] 转换为 [x for x in (1, 2)]。

print

将 print 语句转换为 print() 函数。

raise

将 raise E, V 转换为 raise E(V)，将 raise E, V, T 转换为 raise E(V).with_traceback(T)。如果 E 是元组，这样的转换是不正确的，因为用元组代替异常的做法在 3.0 中已经移除了。

raw_input

将 raw_input() 转换为 input()。

reduce

将 reduce() 转换为 functools.reduce()。

reload

将 reload() 转换为 importlib.reload()。

renames

将 sys.maxint 转换为 sys.maxsize。

repr

将反引号 repr 表达式替换为 repr() 函数。

set_literal

将 set 构造函数替换为 set literals 写法。这个修复器是可选的。

standarderror

将 StandardError 重命名为 Exception。

sys_exc

将弃用的 sys.exc_value，sys.exc_type，sys.exc_traceback 替换为 sys.exc_info() 的用法。

throw

修复生成器的 throw() 方法的 API 变更。

tuple_params

移除隐式的元组参数解包。这个修复器会插入临时变量。

types

修复 type 模块中一些成员的移除引起的代码问题。

unicode

将 unicode 重命名为 str。

urllib

将 urllib 和 urllib2 重命名为 urllib 包。

ws_comma

移除逗号分隔的元素之间多余的空白。这个修复器是可选的。

xrange

将 xrange() 重命名为 range()，并用 list 包装原有的 range()。

xreadlines

将 for x in file.xreadlines() 转换为 for x in file。

zip

用 list 包装 zip()。如果使用了 from future_builtins import zip 的话会禁用。

lib2to3 --- 2to3 的库

源代码： Lib/lib2to3/ [https://github.com/python/cpython/tree/3.10/Lib/lib2to3/]

Deprecated since version 3.11, will be removed in version 3.13: Python 3.9 已切换至 PEG 解析器 (参见 PEP 617 [https://www.python.org/dev/peps/pep-0617]) 而 lib2to3 是使用不够灵活的 LL(1) 解析器。 Python 3.10 包括了 lib2to3 的 LL(1) 解析器所无法解析的新增语言特性 (参见 PEP 634 [https://www.python.org/dev/peps/pep-0634])。 lib2to3 模块已在 Python 3.9 中被标记为即将弃用 (在导入时会引发 PendingDeprecationWarning) 并会在 Python 3.11 中被正式弃用 (会引发 DeprecationWarning)。 它将在 Python 3.13 中被移出标准库。 请考虑使用 LibCST [https://libcst.readthedocs.io/] 或 parso [https://parso.readthedocs.io/] 等第三方替代品。

注解

lib2to3 API 并不稳定，并可能在未来大幅修改。

test --- Python 回归测试包

注解

test 包只供 Python 内部使用。它的记录是为了让 Python 的核心开发者受益。我们不鼓励在 Python 标准库之外使用这个包，因为这里提到的代码在 Python 的不同版本之间可能会改变或被删除而不另行通知。

test 包包含了 Python 的所有回归测试，以及 test.support 和 test.regrtest 模块。 test.support 用于增强你的测试，而 test.regrtest 驱动测试套件。

test`包中每个名字以 ``test_` 开头的模块都是一个特定模块或功能的测试套件。所有新的测试应该使用 unittest 或 doctest 模块编写。一些旧的测试是使用“传统”的测试风格编写的，即比较打印出来的输出到 sys.stdout；这种测试风格被认为是过时的。

参见

模块 unittest

编写 PyUnit 回归测试.

doctest --- 文档测试模块

嵌入到文档字符串的测试。

为 test 包编写单元测试

使用 unittest 模块的测试最好是遵循一些准则。 其中一条是测试模块的名称要以 test_ 打头并以被测试模块的名称结尾。 测试模块中的测试方法应当以 test_ 打头并以该方法所测试的内容的说明结尾。 这很有必要因为这样测试驱动程序就会将这些方法识别为测试方法。 此外，该方法不应当包括任何文档字符串。 应当使用注释 (例如 # Tests function returns only True or False) 来为测试方法提供文档说明。 这样做是因为文档字符串如果存在则会被打印出来因此无法指明正在运行哪个测试。

有一个基本模板经常会被使用:

import unittest
from test import support

class MyTestCase1(unittest.TestCase):

    # Only use setUp() and tearDown() if necessary

    def setUp(self):
        ... code to execute in preparation for tests ...

    def tearDown(self):
        ... code to execute to clean up after tests ...

    def test_feature_one(self):
        # Test feature one.
        ... testing code ...

    def test_feature_two(self):
        # Test feature two.
        ... testing code ...

    ... more test methods ...

class MyTestCase2(unittest.TestCase):
    ... same structure as MyTestCase1 ...

... more test classes ...

if __name__ == '__main__':
    unittest.main()

这种代码模式允许测试套件由 test.regrtest 运行，作为支持 unittest CLI 的脚本单独运行，或者通过 python -m unittest CLI 来运行。

回归测试的目标是尝试破坏代码。 这引出了一些需要遵循的准则:

测试套件应当测试所有的类、函数和常量。 这不仅包括要向外界展示的外部 API 也包括“私有”的代码。

白盒测试（在编写测试时检查被测试的代码）是最推荐的。 黑盒测试（只测试已发布的用户接口）因不够完整而不能确保所有边界和边缘情况都被测试到。

确保所有可能的值包括无效的值都被测试到。 这能确保不仅全部的有效值都可被接受而且不适当的值也能被正确地处理。

消耗尽可能多的代码路径。 测试发生分支的地方从而调整输入以确保通过代码采取尽可能多的不同路径。

为受测试的代码所发现的任何代码缺陷添加明确的测试。 这将确保如果代码在将来被改变错误也不会再次出现。

确保在你的测试完成后执行清理（例如关闭并删除所有临时文件）。

如果某个测试依赖于操作系统上的特定条件那么要在尝试测试之前先验证该条件是否已存在。

尽可能少地导入模块并尽可能快地完成操作。 这可以最大限度地减少测试的外部依赖性并且还可以最大限度地减少导入模块带来的附带影响所导致的异常行为。

尝试最大限度地重用代码。 在某些情况下，测试结果会因使用不同类型的输入这样的小细节而变化。 可通过一个指定输入的类来子类化一个基本测试类来最大限度地减少重复代码:

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)

当使用这种模式时，请记住所有继承自 unittest.TestCase 的类都会作为测试来运行。 上面例子中的 Mixin 类没有任何数据所以其本身是无法运行的，因此它不是继承自 unittest.TestCase。

参见

测试驱动的开发

Kent Beck 所著的阐述在实现代码之前编写驱动的书。

使用命令行界面运行测试

通过使用 -m 选项 test 包可以作为脚本运行以驱动 Python 的回归测试套件: python -m test。 在内部，它使用 test.regrtest；之前 Python 版本所使用的 python -m test.regrtest 调用仍然有效。 运行该脚本自身会自动开始运行 test 包中的所有回归测试。 它通过在包中查找所有名称以 test_ 打头的模块，导入它们，并在有 test_main() 函数时执行它或是在没有 test_main 时通过 unittest.TestLoader.loadTestsFromModule 载入测试。 要执行的测试的名称也可以被传递给脚本。 指定一个单独的回归测试 (python -m test test_spam) 将使输出最小化并且只打印测试通过或失败的消息。

直接运行 test 将允许设置哪些资源可供测试使用。 你可以通过使用 -u 命令行选项来做到这一点。 指定 all 作为 -u 选项的值将启用所有可能的资源: python -m test -uall。 如果只需要一项资源（这是更为常见的情况），可以在 all 之后加一个以逗号分隔的列表来指明不需要的资源。 命令 python -m test -uall,-audio,-largefile 将运行 test 并使用除 audio 和 largefile 资源之外的所有资源。 要查看所有资源的列表和更多的命令行选项，请运行 python -m test -h。

另外一些执行回归测试的方式依赖于执行测试所在的系统平台。 在 Unix 上，你可以在构建 Python 的最高层级目录中运行 make test。 在 Windows 上，在你的 PCbuild 目录中执行 rt.bat 将运行所有的回归测试。

test.support --- 针对 Python 测试套件的工具

test.support 模块提供了对 Python 的回归测试套件的支持。

注解

test.support 不是一个公用模块。 这篇文档是为了帮助 Python 开发者编写测试。 此模块的 API 可能被改变而不顾及发行版本之间的向下兼容性问题。

此模块定义了以下异常:

exception test.support.TestFailed

当一个测试失败时将被引发的异常。 此异常已被弃用而应改用基于 unittest 的测试以及 unittest.TestCase 的断言方法。

exception test.support.ResourceDenied

unittest.SkipTest 的子类。 当一个资源（例如网络连接）不可用时将被引发。 由 requires() 函数所引发。

test.support 模块定义了以下常量:

test.support.verbose

当启用详细输出时为 True。 当需要有关运行中的测试的更详细信息时应当被选择。 verbose 是由 test.regrtest 来设置的。

test.support.is_jython

如果所运行的解释器是 Jython 时为 True。

test.support.is_android

如果系统是 Android 时为 True。

test.support.unix_shell

如果系统不是 Windows 时则为 shell 的路径；否则为 None。

test.support.LOOPBACK_TIMEOUT

使用网络服务器监听网络本地环回接口如 127.0.0.1 的测试的以秒为单位的超时值。

该超时长到足以防止测试失败：它要考虑客户端和服务器可能会在不同线程甚至不同进程中运行。

该超时应当对于 socket.socket 的 connect(), recv() 和 send() 方法都足够长。

其默认值为5秒。

参见 INTERNET_TIMEOUT。

test.support.INTERNET_TIMEOUT

发往互联网的网络请求的以秒为单位的超时值。

该超时短到足以避免测试在互联网请求因任何原因被阻止时等待太久。

通常使用 INTERNET_TIMEOUT 的超时不应该将测试标记为失败，而是跳过测试：参见 transient_internet()。

其默认值是1分钟。

参见 LOOPBACK_TIMEOUT。

test.support.SHORT_TIMEOUT

如果测试耗时“太长”而要将测试标记为失败的以秒为单位的超时值。

该超时值取决于 regrtest --timeout 命令行选项。

如果一个使用 SHORT_TIMEOUT 的测试在慢速 buildbots 上开始随机失败，请使用 LONG_TIMEOUT 来代替。

其默认值为30秒。

test.support.LONG_TIMEOUT

用于检测测试何时挂起的以秒为单位的超时值。

它的长度足够在最慢的 Python buildbot 上降低测试失败的风险。 如果测试耗时“过长”也不应当用它将该测试标记为失败。 此超时值依赖于 regrtest --timeout 命令行选项。

其默认值为5分钟。

另请参见 LOOPBACK_TIMEOUT, INTERNET_TIMEOUT 和 SHORT_TIMEOUT。

test.support.PGO

当测试对 PGO 没有用处时设置是否要跳过测试。

test.support.PIPE_MAX_SIZE

一个通常大于下层 OS 管道缓冲区大小的常量，以产生写入阻塞。

test.support.SOCK_MAX_SIZE

一个通常大于下层 OS 套接字缓冲区大小的常量，以产生写入阻塞。

test.support.TEST_SUPPORT_DIR

设为包含 test.support 的最高层级目录。

test.support.TEST_HOME_DIR

设为 test 包的最高层级目录。

test.support.TEST_DATA_DIR

设为 test 包中的 data 目录。

test.support.MAX_Py_ssize_t

设为大内存测试的 sys.maxsize。

test.support.max_memuse

通过 set_memlimit() 设为针对大内存测试的内存限制。 受 MAX_Py_ssize_t 的限制。

test.support.real_max_memuse

通过 set_memlimit() 设为针对大内存测试的内存限制。 不受 MAX_Py_ssize_t 的限制。

test.support.MISSING_C_DOCSTRINGS

如果 Python 编译时不带文档字符串（即未定义 WITH_DOC_STRINGS 宏）则设为 True。 参见 configure --without-doc-strings 选项。

另请参阅 HAVE_DOCSTRINGS 变量。

test.support.HAVE_DOCSTRINGS

如果函数带有文档字符串则设为 True。 参见 python -OO 选项，该选项会去除在 Python 中实现的函数的文档字符串。

另请参阅 MISSING_C_DOCSTRINGS 变量。

test.support.TEST_HTTP_URL

定义用于网络测试的韧性 HTTP 服务器的 URL。

test.support.ALWAYS_EQ

等于任何对象的对象。 用于测试混合类型比较。

test.support.NEVER_EQ

不等于任何对象的对象 (即使是 ALWAYS_EQ)。 用于测试混合类型比较。

test.support.LARGEST

大于任何对象的对象（除了其自身）。 用于测试混合类型比较。

test.support.SMALLEST

小于任何对象的对象（除了其自身）。 用于测试混合类型比较。Used to test mixed type comparison.

test.support 模块定义了以下函数:

test.support.is_resource_enabled(resource)

如果 resource 已启用并可用则返回 True。 可用资源列表只有当 test.regrtest 正在执行测试时才会被设置。

test.support.python_is_optimized()

如果 Python 编译未使用 -O0 或 -Og 则返回 True。

test.support.with_pymalloc()

返回 _testcapi.WITH_PYMALLOC。

test.support.requires(resource, msg=None)

如果 resource 不可用则引发 ResourceDenied。 如果该异常被引发则 msg 为传给 ResourceDenied 的参数。 如果被 __name__ 为 '__main__' 的函数调用则总是返回 True。 在测试由 test.regrtest 执行时使用。

test.support.sortdict(dict)

返回 dict 按键排序的 repr。

test.support.findfile(filename, subdir=None)

返回名为 filename 的文件的路径。 如果未找到匹配结果则返回 filename。 这并不等于失败因为它也算是该文件的路径。

设置 subdir 指明要用来查找文件的相对路径而不是直接在路径目录中查找。

test.support.match_test(test)

确定 test 是否匹配在 set_match_tests() 中设置的模式。

test.support.set_match_tests(accept_patterns=None, ignore_patterns=None)

定义测试文件名和测试方法名的匹配模式用于筛选测试。

test.support.run_unittest(*classes)

执行传给函数的 unittest.TestCase 子类。 此函数会扫描类中带有 test_ 前缀的方法并单独执行这些测试。

将字符串作为形参传递也是合法的；这些形参应为 sys.modules 中的键。 每个被关联的模块将由 unittest.TestLoader.loadTestsFromModule() 执行扫描。 这通常出现在以下 test_main() 函数中:

def test_main():
    support.run_unittest(__name__)

这将运行在指定模块中定义的所有测试。

test.support.run_doctest(module, verbosity=None, optionflags=0)

在给定的 module 上运行 doctest.testmod()。 返回 (failure_count, test_count)。

如果 verbosity 为 None，doctest.testmod() 运行时的消息详细程度将设为 verbose。 否则，运行时的消息详细程度将设为 None。 optionflags 将作为 optionflags 传给 doctest.testmod()。

test.support.setswitchinterval(interval)

将 sys.setswitchinterval() 设为给定的 interval。 请为 Android 系统定义一个最小间隔以防止系统挂起。

test.support.check_impl_detail(**guards)

使用此检测来保护 CPython 实现专属的测试或者仅在有这些参数保护的实现上运行它们。 此函数将根据主机系统平台的不同返回 True 或 False。 用法示例:

check_impl_detail()               # Only on CPython (default).
check_impl_detail(jython=True)    # Only on Jython.
check_impl_detail(cpython=False)  # Everywhere except CPython.

test.support.set_memlimit(limit)

针对大内存测试设置 max_memuse 和 real_max_memuse 的值。

test.support.record_original_stdout(stdout)

存放来自 stdout 的值。 它会在回归测试开始时处理 stdout。

test.support.get_original_stdout()

返回 record_original_stdout() 所设置的原始 stdout 或者如果未设置则为 sys.stdout。

test.support.args_from_interpreter_flags()

返回在 sys.flags 和 sys.warnoptions 中重新产生当前设置的命令行参数列表。

test.support.optim_args_from_interpreter_flags()

返回在 sys.flags 中重新产生当前优化设置的命令行参数列表。

test.support.captured_stdin()

test.support.captured_stdout()

test.support.captured_stderr()

使用 io.StringIO 对象临时替换指定流的上下文管理器。

使用输出流的示例:

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"

使用输入流的示例:

with captured_stdin() as stdin:
    stdin.write('hello\n')
    stdin.seek(0)
    # call test code that consumes from sys.stdin
    captured = input()
self.assertEqual(captured, "hello")

test.support.disable_faulthandler()

临时禁用 faulthandler 的上下文管理器。

test.support.gc_collect()

强制收集尽可能多的对象。 这是有必要的因为垃圾回收器并不能保证及时回收资源。 这意味着 __del__ 方法的调用可能会晚于预期而弱引用的存活长于预期。

test.support.disable_gc()

在进入时禁用垃圾回收器的上下文管理器。 在退出时，垃圾回收器将恢复到先前状态。

test.support.swap_attr(obj, attr, new_val)

上下文管理器用一个新对象来交换一个属性。

用法：

with swap_attr(obj, "attr", 5):
    ...

这将把 obj.attr 设为 5 并在 with 语句块内保持，在语句块结束时恢复旧值。 如果 attr 不存在于 obj 中，它将被创建并在语句块结束时被删除。

旧值 (或者如果不存在旧值则为 None) 将被赋给 "as" 子句的目标，如果存在子句的话。

test.support.swap_item(obj, attr, new_val)

上下文件管理器用一个新对象来交换一个条目。

用法：

with swap_item(obj, "item", 5):
    ...

这将把 obj["item"] 设为 5 并在 with 语句块内保持，在语句块结束时恢复旧值。 如果 item 不存在于 obj 中，它将被创建并在语句块结束时被删除。

旧值 (或者如果不存在旧值则为 None) 将被赋给 "as" 子句的目标，如果存在子句的话。

test.support.print_warning(msg)

打印一个警告到 sys.__stderr__。 将消息格式化为: f"Warning -- {msg}"。 如果 msg 包含多行，则为每行添加 "Warning -- " 前缀。

3.9 新版功能.

test.support.wait_process(pid, *, exitcode, timeout=None)

等待直到进程 pid 结束并检查进程退出代码是否为 exitcode。

如果进程退出代码不等于 exitcode 则引发 AssertionError。

如果进程运行时长超过 timeout 秒 (默认为 SHORT_TIMEOUT)，则杀死进程并引发 AssertionError。 超时特性在 Windows 上不可用。

3.9 新版功能.

test.support.calcobjsize(fmt)

返回 PyObject 的大小，其结构成员由 fmt 定义。 返回的值包括 Python 对象头的大小和对齐方式。

test.support.calcvobjsize(fmt)

返回 PyVarObject 的大小，其结构成员由 fmt 定义。 返回的值包括 Python 对象头的大小和对齐方式。

test.support.checksizeof(test, o, size)

对于测试用例 test，断言 o 的 sys.getsizeof 加 GC 头的大小等于 size。

@test.support.anticipate_failure(condition)

一个有条件地用 unittest.expectedFailure() 来标记测试的装饰器。 任何对此装饰器的使用都应当具有标识相应追踪事项的有关联注释。

test.support.system_must_validate_cert(f)

一个在 TLS 证书验证失败时跳过被装饰测试的装饰器。

@test.support.run_with_locale(catstr, *locales)

一个在不同语言区域下运行函数的装饰器，并在其结束后正确地重置语言区域。 catstr 是字符串形式的语言区域类别 (例如 "LC_ALL")。 传入的 locales 将依次被尝试，并将使用第一个有效的语言区域。

@test.support.run_with_tz(tz)

一个在指定时区下运行函数的装饰器，并在其结束后正确地重置时区。

@test.support.requires_freebsd_version(*min_version)

当在 FreeBSD 上运行测试时指定最低版本的装饰器。 如果 FreeBSD 版本号低于指定值，测试将被跳过。

@test.support.requires_linux_version(*min_version)

当在 Linux 上运行测试时指定最低版本的装饰器。 如果 Linux 版本号低于指定值，测试将被跳过。

@test.support.requires_mac_version(*min_version)

当在 macOS 上运行测试时指定最低版本的装饰器。 如果 macOS 版本号低于指定值，测试将被跳过。

@test.support.requires_IEEE_754

用于在非 non-IEEE 754 平台上跳过测试的装饰器。

@test.support.requires_zlib

用于当 zlib 不存在时跳过测试的装饰器。

@test.support.requires_gzip

用于当 gzip 不存在时跳过测试的装饰器。

@test.support.requires_bz2

用于当 bz2 不存在时跳过测试的装饰器。

@test.support.requires_lzma

用于当 lzma 不存在时跳过测试的装饰器。

@test.support.requires_resource(resource)

用于当 resource 不可用时跳过测试的装饰器。

@test.support.requires_docstrings

用于仅当 HAVE_DOCSTRINGS 时才运行测试的装饰器。

@test.support.cpython_only

表示仅适用于 CPython 的测试的装饰器。

@test.support.impl_detail(msg=None, **guards)

用于在 guards 上唤起 check_impl_detail() 的装饰器。 如果调用返回 False，则使用 msg 作为跳过测试的原因。

@test.support.no_tracing

用于在测试期间临时关闭追踪的装饰器。

@test.support.refcount_test

用于涉及引用计数的测试的装饰器。 如果测试不是由 CPython 运行则该装饰器不会运行测试。 在测试期间会取消设置任何追踪函数以由追踪函数导致的意外引用计数。

@test.support.bigmemtest(size, memuse, dry_run=True)

用于大内存测试的装饰器。

size 是测试所请求的大小（以任意的，由测试解读的单位。） memuse 是测试的每单元字节数，或是对它的良好估计。 例如，一个需要两个字节缓冲区，每个缓冲区 4 GiB，则可以用 @bigmemtest(size=_4G, memuse=2) 来装饰。

size 参数通常作为额外参数传递给被测试的方法。 如果 dry_run 为 True，则传给测试方法的值可能少于所请求的值。 如果 dry_run 为 False，则意味着当当未指定 -M 时测试将不支持虚拟运行。

@test.support.bigaddrspacetest

用于填充地址空间的测试的装饰器。

test.support.check_syntax_error(testcase, statement, errtext='', *, lineno=None, offset=None)

用于通过尝试编译 statement 来测试 statement 中的语法错误。 testcase 是测试的 unittest 实例。 errtext 是应当匹配所引发的 SyntaxError 的字符串表示形式的正则表达式。 如果 lineno 不为 None，则与异常所在的行进行比较。 如果 offset 不为 None，则与异常的偏移量进行比较。

test.support.open_urlresource(url, *args, **kw)

打开 url。 如果打开失败，则引发 TestFailed。

test.support.reap_children()

只要有子进程启动就在 test_main 的末尾使用此函数。 这将有助于确保没有多余的子进程（僵尸）存在占用资源并在查找引用泄漏时造成问题。

test.support.get_attribute(obj, name)

获取一个属性，如果引发了 AttributeError 则会引发 unittest.SkipTest。

test.support.catch_unraisable_exception()

使用 sys.unraisablehook() 来捕获不可引发的异常的上下文管理器。

存储异常值 (cm.unraisable.exc_value) 会创建一个引用循环。 引用循环将在上下文管理器退出时被显式地打破。

存储对象 (cm.unraisable.object) 如果被设置为一个正在最终化的对象则可以恢复它。 退出上下文管理器将清除已存在对象。

用法：

with support.catch_unraisable_exception() as cm:
    # code creating an "unraisable exception"
    ...

    # check the unraisable exception: use cm.unraisable
    ...

# cm.unraisable attribute no longer exists at this point
# (to break a reference cycle)

3.8 新版功能.

test.support.load_package_tests(pkg_dir, loader, standard_tests, pattern)

在测试包中使用的 unittest load_tests 协议的通用实现。 pkg_dir 是包的根目录；loader, standard_tests 和 pattern 是 load_tests 所期望的参数。 在简单的情况下，测试包的 __init__.py 可以是下面这样的:

import os
from test.support import load_package_tests

def load_tests(*args):
    return load_package_tests(os.path.dirname(__file__), *args)

test.support.detect_api_mismatch(ref_api, other_api, *, ignore=())

返回未在 other_api 中找到的 ref_api 的属性、函数或方法的集合，除去在 ignore 中指明的要在这个检查中忽略的已定义条目列表。

在默认情况下这将跳过以 '_' 打头的私有属性但包括所有魔术方法，即以 '__' 打头和结尾的方法。

3.5 新版功能.

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 的一个有效属性。

test.support.run_in_subinterp(code)

在子解释器中运行 code。 如果启用了 tracemalloc 则会引发 unittest.SkipTest。

test.support.check_free_after_iterating(test, iter, cls, args=())

断言 cls 的实例在迭代后被释放。

test.support.missing_compiler_executable(cmd_names=[])

检查在 cmd_names 中列出名称的或者当 cmd_names 为空时所有的编译器可执行文件是否存在并返回第一个丢失的可执行文件或者如果未发现任何丢失则返回 None。

test.support.check__all__(test_case, module, name_of_module=None, extra=(), not_exported=())

断言 module 的 __all__ 变量包含全部公共名称。

模块的公共名称（它的 API）是根据它们是否符合公共名称惯例并在 module 中被定义来自动检测的。

name_of_module 参数可以（用字符串或元组的形式）指定一个 API 可以被定义为什么模块以便被检测为一个公共 API。 一种这样的情况会在 module 从其他模块，可能是一个 C 后端 (如 csv 和它的 _csv) 导入其公共 API 的某一组成部分时发生。

extra 参数可以是一个在其他情况下不会被自动检测为 "public" 的名称集合，例如没有适当 __module__ 属性的对象。 如果提供该参数，它将被添加到自动检测到的对象中。

not_exported 参数可以是一个不可被当作公共 API 的一部分的名称集合，即使其名称没有显式指明这一点。

用法示例:

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'}  # Undocumented name.
        # bar imports part of its API from _bar.
        support.check__all__(self, bar, ('bar', '_bar'),
                             extra=extra, not_exported=not_exported)

3.6 新版功能.

test.support.skip_if_broken_multiprocessing_synchronize()

如果没有 multiprocessing.synchronize 模块，没有可用的 semaphore 实现，或者如果创建一个锁会引发 OSError 则跳过测试。

3.10 新版功能.

test.support.check_disallow_instantiation(test_case, tp, *args, **kwds)

断言类型 tp 不能使用 args 和 kwds 来实例化。

3.10 新版功能.

test.support.adjust_int_max_str_digits(max_digits)

此函数返回一个将在上下文生效期间改变全局 sys.set_int_max_str_digits() 设置的上下文管理器以便允许执行当在整数和字符串之间进行转换时需要对位数有不同限制的测试代码。

3.10.7 新版功能.

test.support 模块定义了以下的类:

class test.support.SuppressCrashReport

一个用于在预期会使子进程崩溃的测试时尽量防止弹出崩溃对话框的上下文管理器。

在 Windows 上，它会使用 SetErrorMode [https://msdn.microsoft.com/en-us/library/windows/desktop/ms680621.aspx] 来禁用 Windows 错误报告对话框。

在 UNIX 上，会使用 resource.setrlimit() 来将 resource.RLIMIT_CORE 的软限制设为 0 以防止创建核心转储文件。

在这两个平台上，旧值都将被 __exit__() 恢复。

class test.support.SaveSignals

用于保存和恢复由 Python 句柄的所注册的信号处理器。

save(self)

将信号处理器保存到一个将信号编号映射到当前信号处理器的字典。

restore(self)

将来自 save() 字典的信号编号设置到已保存的处理器上。

class test.support.Matcher

matches(self, d, **kwargs)

尝试对单个字典与所提供的参数进行匹配。

match_value(self, k, dv, v)

尝试对单个已存储值 (dv) 与所提供的值 (v) 进行匹配。

class test.support.BasicTestRunner

run(test)

运行 test 并返回结果。

test.support.socket_helper --- 用于套接字测试的工具

test.support.socket_helper 模块提供了对套接字测试的支持。

3.9 新版功能.

test.support.socket_helper.IPV6_ENABLED

设置为 True 如果主机打开IPv6, 否则 False .

test.support.socket_helper.find_unused_port(family=socket.AF_INET, socktype=socket.SOCK_STREAM)

返回一个应当适合绑定的未使用端口。 这是通过创建一个与 sock 形参相同协议族和类型的临时套接字来达成的 (默认为 AF_INET, SOCK_STREAM)，并将其绑定到指定的主机地址 (默认为 0.0.0.0) 并将端口设为 0，以从 OS 引出一个未使用的瞬时端口。 这个临时套接字随后将被关闭并删除，然后返回该瞬时端口。

这个方法或 bind_port() 应当被用于任何在测试期间需要绑定到特定端口的测试。 具体使用哪个取决于调用方代码是否会创建 Python 套接字，或者是否需要在构造器中提供或向外部程序提供未使用的端口（例如传给 openssl 的 s_server 模式的 -accept 参数）。 在可能的情况下将总是优先使用 bind_port() 而非 find_unused_port()。 不建议使用硬编码的端口因为将使测试的多个实例无法同时运行，这对 buildbot 来说是个问题。

test.support.socket_helper.bind_port(sock, host=HOST)

将套接字绑定到一个空闲端口并返回端口号。 这依赖于瞬时端口以确保我们能使用一个未绑定端口。 这很重要因为可能会有许多测试同时运行，特别是在 buildbot 环境中。 如果 sock.family 为 AF_INET 而 sock.type 为 SOCK_STREAM，并且套接字上设置了 SO_REUSEADDR 或 SO_REUSEPORT 则此方法将引发异常。 测试绝不应该为 TCP/IP 套接字设置这些套接字选项。 唯一需要设置这些选项的情况是通过多个 UDP 套接字来测试组播。

此外，如果 SO_EXCLUSIVEADDRUSE 套接字选项是可用的（例如在 Windows 上），它将在套接字上被设置。 这将阻止其他任何人在测试期间绑定到我们的主机/端口。

test.support.socket_helper.bind_unix_socket(sock, addr)

绑定一个 Unix 套接字，如果 PermissionError 被引发则会引发 unittest.SkipTest。

@test.support.socket_helper.skip_unless_bind_unix_socket

一个用于运行需要 Unix 套接字 bind() 功能的测试的装饰器。

test.support.socket_helper.transient_internet(resource_name, *, timeout=30.0, errnos=())

一个在互联网连接的各种问题以异常的形式表现出来时会引发 ResourceDenied 的上下文管理器。

test.support.script_helper --- 用于 Python 执行测试工具

test.support.script_helper 模块提供了对 Python 的脚本执行测试的支持。

test.support.script_helper.interpreter_requires_environment()

如果 sys.executable interpreter 需要环境变量才能运行则返回 True。

这被设计用来配合 @unittest.skipIf() 以便标注需要使用to annotate tests that need to use an assert_python*() 函数来启动隔离模式 (-I) 或无环境模式 (-E) 子解释器的测试。

正常的编译和测试运行不会进入这种状况但它在尝试从一个使用 Python 的当前家目录查找逻辑找不到明确的家目录的解释器运行标准库测试套件时有可能发生。

设置 PYTHONHOME 是一种能让大多数测试套件在这种情况下运行的办法。 PYTHONPATH 或 PYTHONUSERSITE 是另外两个可影响解释器是否能启动的常见环境变量。

test.support.script_helper.run_python_until_end(*args, **env_vars)

基于 env_vars 设置环境以便在子进程中运行解释器。 它的值可以包括 __isolated, __cleanenv, __cwd, and TERM。

在 3.9 版更改: 此函数不会再从 stderr 去除空格符。

test.support.script_helper.assert_python_ok(*args, **env_vars)

断言附带 args 和可选的环境变量 env_vars 运行解释器会成功 (rc == 0) 并返回一个 (return code, stdout, stderr) 元组。

如果设置了 __cleanenv 仅限关键字形参，env_vars 会被用作一个全新的环境。

Python 是以隔离模式 (命令行选项 -I) 启动的，除非 __isolated 仅限关键字形参被设为 False。

在 3.9 版更改: 此函数不会再从 stderr 去除空格符。

test.support.script_helper.assert_python_failure(*args, **env_vars)

断言附带 args 和可选的环境变量 env_vars 运行解释器会失败 (rc != 0) 并返回一个 (return code, stdout, stderr) 元组。

更多选项请参阅 assert_python_ok()。

在 3.9 版更改: 此函数不会再从 stderr 去除空格符。

test.support.script_helper.spawn_python(*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)

使用给定的参数运行一个 Python 子进程。

kw 是要传给 subprocess.Popen() 的额外关键字参数。 返回一个 subprocess.Popen 对象。

test.support.script_helper.kill_python(p)

运行给定的 subprocess.Popen 进程直至完成并返回 stdout。

test.support.script_helper.make_script(script_dir, script_basename, source, omit_suffix=False)

在路径 script_dir 和 script_basename 中创建包含 source 的脚本。 如果 omit_suffix 为 False，则为名称添加 .py。 返回完整的脚本路径。

test.support.script_helper.make_zip_script(zip_dir, zip_basename, script_name, name_in_zip=None)

使用 zip_dir 和 zip_basename 创建扩展名为 zip 的 zip 文件，其中包含 script_name 中的文件。 name_in_zip 为归档名。 返回一个包含 (full path, full path of archive name) 的元组。

test.support.script_helper.make_pkg(pkg_dir, init_source='')

创建一个名为 pkg_dir 的目录，其中包含一个 __init__ 文件并以 init_source 作为其内容。

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 包目录，其中包含一个空的 __init__ 文件和一个包含 source 的文件 script_basename。 如果 compiled 为 True，则两个源文件将被编译并添加到 zip 包中。 返回一个以完整 zip 路径和 zip 文件归档名为元素的元组。

test.support.bytecode_helper --- 用于测试正确字节码生成的支持工具

test.support.bytecode_helper 模块提供了对测试和检查字节码生成的支持。

3.9 新版功能.

The module defines the following class:

class test.support.bytecode_helper.BytecodeTestCase(unittest.TestCase)

这个类具有用于检查字节码的自定义断言。

BytecodeTestCase.get_disassembly_as_string(co)

以字符串形式返回 co 的汇编码。

BytecodeTestCase.assertInBytecode(x, opname, argval=_UNSPECIFIED)

如果找到 opname 则返回 instr，否则抛出 AssertionError。

BytecodeTestCase.assertNotInBytecode(x, opname, argval=_UNSPECIFIED)

如果找到 opname 则抛出 AssertionError。

test.support.threading_helper --- 用于线程测试的工具

test.support.threading_helper 模块提供了对线程测试的支持。

3.10 新版功能.

test.support.threading_helper.join_thread(thread, timeout=None)

在 timeout 秒之内合并一个 thread。 如果线程在 timeout 秒后仍然存活则引发 AssertionError。

@test.support.threading_helper.reap_threads

用于确保即使测试失败线程仍然会被清理的装饰器。

test.support.threading_helper.start_threads(threads, unlock=None)

启动 threads 的上下文管理器，该参数为一个线程序列。 unlock 是一个在所有线程启动之后被调用的函数，即使引发了异常也会执行；一个例子是 threading.Event.set()。 start_threads 将在退出时尝试合并已启动的线程。

test.support.threading_helper.threading_cleanup(*original_values)

清理未在 original_values 中指定的线程。 被设计为如果有一个测试在后台离开正在运行的线程时会发出警告。

test.support.threading_helper.threading_setup()

返回当前线程计数和悬空线程的副本。

test.support.threading_helper.wait_threads_exit(timeout=None)

等待直到 with 语句中所有已创建线程退出的上下文管理器。

test.support.threading_helper.catch_threading_exception()

使用 threading.excepthook() 来捕获 threading.Thread 异常的上下文管理器。

当异常被捕获时要设置的属性:

exc_type

exc_value

exc_traceback

thread

参见 threading.excepthook() 文档。

这些属性在上下文管理器退出时将被删除。

用法：

with threading_helper.catch_threading_exception() as cm:
    # code spawning a thread which raises an exception
    ...

    # check the thread exception, use cm attributes:
    # exc_type, exc_value, exc_traceback, thread
    ...

# exc_type, exc_value, exc_traceback, thread attributes of cm no longer
# exists at this point
# (to avoid reference cycles)

3.8 新版功能.

test.support.os_helper --- 用于操作系统测试的工具

test.support.os_helper 模块提供了对操作系统测试的支持。

3.10 新版功能.

test.support.os_helper.FS_NONASCII

一个可通过 os.fsencode() 编码的非 ASCII 字符。

test.support.os_helper.SAVEDCWD

设置为 os.getcwd()。

test.support.os_helper.TESTFN

设置为一个可以安全地用作临时文件名的名称。 任何被创建的临时文件都应当被关闭和撤销链接（移除）。

test.support.os_helper.TESTFN_NONASCII

如果存在的话，设置为一个包含 FS_NONASCII 字符的文件名。 这会确保当文件名存在时，它可使用默认文件系统编码格式来编码和解码。 这允许需要非 ASCII 文件名的测试在其不可用的平台上被方便地跳过。

test.support.os_helper.TESTFN_UNENCODABLE

设置为一个应当在严格模式下不可使用文件系统编码格式来编码的文件名（str 类型）。 如果无法生成这样的文件名则可以为 None。

test.support.os_helper.TESTFN_UNDECODABLE

设置为一个应当在严格模式下不可使用文件系统编码格式来编码的文件名（bytes 类型）。 如果无法生成这样的文件名则可以为 None。

test.support.os_helper.TESTFN_UNICODE

设置为用于临时文件的非 ASCII 名称。

class test.support.os_helper.EnvironmentVarGuard

用于临时性地设置或取消设置环境变量的类。 其实例可被用作上下文管理器并具有完整的字典接口用来查询/修改下层的 os.environ。 在从上下文管理器退出之后所有通过此实例对环境变量进行的修改都将被回滚。

在 3.1 版更改: 增加了字典接口。

class test.support.os_helper.FakePath(path)

简单的 path-like object。 它实现了 __fspath__() 方法，该方法将返回 path 参数。 如果 path 为一个异常，它将在 __fspath__() 中被引发。

EnvironmentVarGuard.set(envvar, value)

临时性地将环境变量 envvar 的值设为 value。

EnvironmentVarGuard.unset(envvar)

临时性地取消设置环境变量 envvar。

test.support.os_helper.can_symlink()

如果操作系统支持符号链接则返回 True，否则返回 False。

test.support.os_helper.can_xattr()

如果操作系统支持 xattr 支返回 True，否则返回 False。

test.support.os_helper.change_cwd(path, quiet=False)

一个临时性地将当前工作目录改为 path 并输出该目录的上下文管理器。

如果 quiet 为 False，此上下文管理器将在发生错误时引发一个异常。 在其他情况下，它将只发出一个警告并将当前工作目录保持原状。

test.support.os_helper.create_empty_file(filename)

创建一个名为 filename 的空文件。 如果文件已存在，则清空其内容。

test.support.os_helper.fd_count()

统计打开的文件描述符数量。

test.support.os_helper.fs_is_case_insensitive(directory)

如果 directory 的文件系统对大小写敏感则返回 True。

test.support.os_helper.make_bad_fd()

通过打开并关闭临时文件来创建一个无效的文件描述符，并返回其描述器。

test.support.os_helper.rmdir(filename)

在 filename 上调用 os.rmdir()。 在 Windows 平台上，这将使用一个检测文件是否存在的等待循环来包装，需要这样做是因为反病毒程序会保持文件打开并阻止其被删除。

test.support.os_helper.rmtree(path)

在 path 上调用 shutil.rmtree() 或者调用 os.lstat() 和 os.rmdir() 来移除一个路径及其内容。 与 rmdir() 一样，在 Windows 平台上这将使用一个检测文件是否存在的等待循环来包装。

@test.support.os_helper.skip_unless_symlink

一个用于运行需要符号链接支持的测试的装饰器。

@test.support.os_helper.skip_unless_xattr

一个用于运行需要 xattr 支持的测试的装饰器。

test.support.os_helper.temp_cwd(name='tempcwd', quiet=False)

一个临时性地创建新目录并改变当前工作目录（CWD）的上下文管理器。

临时性地改变当前工作目录之前此上下文管理器会在当前目录下创建一个名为 name 的临时目录。 如果 name 为 None，则会使用 tempfile.mkdtemp() 创建临时目录。

如果 quiet 为 False 并且无法创建或修改 CWD，则会引发一个错误。 在其他情况下，只会引发一个警告并使用原始 CWD。

test.support.os_helper.temp_dir(path=None, quiet=False)

一个在 path 上创建临时目录并输出该目录的上下文管理器。

如果 path 为 None，则会使用 tempfile.mkdtemp() 来创建临时目录。 如果 quiet 为 False，则该上下文管理器在发生错误时会引发一个异常。 在其他情况下，如果 path 已被指定并且无法创建，则只会发出一个警告。

test.support.os_helper.temp_umask(umask)

一个临时性地设置进程掩码的上下文管理器。

test.support.os_helper.unlink(filename)

在 filename 上调用 os.unlink()。 与 rmdir() 一样，在 Windows 平台上这将使用一个检测文本是否存在的等待循环来包装。

test.support.import_helper --- 用于导入测试的工具

test.support.import_helper 模块提供了对导入测试的支持。

3.10 新版功能.

test.support.import_helper.forget(module_name)

从 sys.modules 移除名为 module_name 的模块并删除该模块的已编译字节码文件。

test.support.import_helper.import_fresh_module(name, fresh=(), blocked=(), deprecated=False)

此函数会在执行导入之前通过从 sys.modules 移除指定模块来导入并返回指定 Python 模块的新副本。 请注意这不同于 reload()，原来的模块不会受到此操作的影响。

fresh 是包含在执行导入之前还要从 sys.modules 缓存中移除的附加模块名称的可迭代对象。

blocked 是包含模块名称的可迭代对象，导入期间在模块缓存中它会被替换为 None 以确保尝试导入将引发 ImportError。

指定名称的模块以及任何在 fresh 和 blocked 形参中指明的模块会在开始导入之前被保存并在全新导入完成时被重新插入到 sys.modules 中。

如果 deprecated 为 True 则在此导入操作期间模块和包的弃用消息会被屏蔽。

如果指定名称的模块无法被导入则此函数将引发 ImportError。

用法示例:

# Get copies of the warnings module for testing without affecting the
# version being used by the rest of the test suite. One copy uses the
# C implementation, the other is forced to use the pure Python fallback
# implementation
py_warnings = import_fresh_module('warnings', blocked=['_warnings'])
c_warnings = import_fresh_module('warnings', fresh=['_warnings'])

3.1 新版功能.

test.support.import_helper.import_module(name, deprecated=False, *, required_on=())

此函数会导入并返回指定名称的模块。 不同于正常的导入，如果模块无法被导入则此函数将引发 unittest.SkipTest。

如果 deprecated 为 True 则在此导入操作期间模块和包的弃用消息会被屏蔽。 如果某个模块在特定平台上是必需的而在其他平台上是可选的，请为包含平台前缀的可迭代对象设置 required_on，此对象将与 sys.platform 进行比对。

3.1 新版功能.

test.support.import_helper.modules_setup()

返回 sys.modules 的副本。

test.support.import_helper.modules_cleanup(oldmodules)

移除 oldmodules 和 encodings 以外的模块以保留内部缓冲区。

test.support.import_helper.unload(name)

从 sys.modules 中删除 name。

test.support.import_helper.make_legacy_pyc(source)

将 PEP 3147 [https://www.python.org/dev/peps/pep-3147]/PEP 488 [https://www.python.org/dev/peps/pep-0488] pyc 文件移至旧版 pyc 位置并返回该旧版 pyc 文件的文件系统路径。 source 的值是源文件的文件系统路径。 它不必真实存在，但是 PEP 3147/488 pyc 文件必须存在。

class test.support.import_helper.CleanImport(*module_names)

强制导入以返回一个新的模块引用的上下文管理器。 这适用于测试模块层级的行为，例如在导入时发出 DeprecationWarning。 示例用法:

with CleanImport('foo'):
    importlib.import_module('foo')  # New reference.

class test.support.import_helper.DirsOnSysPath(*paths)

一个临时性地向 sys.path 添加目录的上下文管理器。

这将创建 sys.path 的一个副本，添加作为位置参数传入的任何目录，然后在上下文结束时将 sys.path 还原到副本的设置。

请注意该上下文管理器代码块中 所有 对 sys.path 的修改，包括对象的替换，都将在代码块结束时被还原。

test.support.warnings_helper --- 用于警告测试的工具

test.support.warnings_helper 模块提供了对警告测试的支持。

3.10 新版功能.

test.support.warnings_helper.ignore_warnings(*, category)

抑制作为 category 实例的警告，它必须为 Warning 或其子类。 大致等价于 warnings.catch_warnings() 设置 warnings.simplefilter('ignore', category=category)。 例如:

@warning_helper.ignore_warnings(category=DeprecationWarning)
def test_suppress_warning():
    # do something

3.8 新版功能.

test.support.warnings_helper.check_no_resource_warning(testcase)

检测是否没有任何 ResourceWarning 被引发的上下文管理器。 你必须在该上下文管理器结束之前移除可能发出 ResourceWarning 的对象。

test.support.warnings_helper.check_syntax_warning(testcase, statement, errtext='', *, lineno=1, offset=None)

用于通过尝试编译 statement 来测试 statement 中的语法警告。 还会测试 SyntaxWarning 是否只发出了一次，以及它在转成错误时是否将被转换为 SyntaxError。 testcase 是用于测试的 unittest 实例。 errtext 是应当匹配所发出的 SyntaxWarning 以及所引发的 SyntaxError 的字符串表示形式的正则表达式。 如果 lineno 不为 None，则与警告和异常所在的行进行比较。 如果 offset 不为 None，则与异常的偏移量进行比较。

3.8 新版功能.

test.support.warnings_helper.check_warnings(*filters, quiet=True)

一个用于 warnings.catch_warnings() 以更容易地测试特定警告是否被正确引发的便捷包装器。 它大致等价于调用 warnings.catch_warnings(record=True) 并将 warnings.simplefilter() 设为 always 并附带自动验证已记录结果的选项。

check_warnings 接受 ("message regexp", WarningCategory) 形式的 2 元组作为位置参数。 如果提供了一个或多个 filters，或者如果可选的关键字参数 quiet 为 False，则它会检查确认警告是符合预期的：每个已指定的过滤器必须匹配至少一个被包围的代码或测试失败时引发的警告，并且如果有任何未能匹配已指定过滤器的警告被引发则测试将失败。 要禁用这些检查中的第一项，请将 quiet 设为 True。

如果未指定任何参数，则默认为:

check_warnings(("", Warning), quiet=True)

在此情况下所有警告都会被捕获而不会引发任何错误。

在进入该上下文管理器时，将返回一个 WarningRecorder 实例。 来自 catch_warnings() 的下层警告列表可通过该记录器对象的 warnings 属性来访问。 作为一个便捷方式，该对象中代表最近的警告的属性也可通过该记录器对象来直接访问（参见以下示例）。 如果未引发任何警告，则在其他情况下预期代表一个警告的任何对象属性都将返回 None。

该记录器对象还有一个 reset() 方法，该方法会清空警告列表。

该上下文管理器被设计为像这样来使用:

with check_warnings(("assertion is always true", SyntaxWarning),
                    ("", UserWarning)):
    exec('assert(False, "Hey!")')
    warnings.warn(UserWarning("Hide me!"))

在此情况下如果两个警告都未被引发，或是引发了其他的警告，则 check_warnings() 将会引发一个错误。

当一个测试需要更深入地查看这些警告，而不是仅仅检查它们是否发生时，可以使用这样的代码:

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

在这里所有的警告都将被捕获，而测试代码会直接测试被捕获的警告。

在 3.2 版更改: 新增可选参数 filters 和 quiet。

class test.support.warnings_helper.WarningsRecorder

用于为单元测试记录警告的类。 请参阅以上 check_warnings() 的文档来了解详情。

调试和分析

这些库可以帮助你进行 Python 开发：调试器使你能够逐步执行代码，分析堆栈帧并设置中断点等等，性能分析器可以运行代码并为你提供执行时间的详细数据，使你能够找出你的程序中的瓶颈。 审计事件提供运行时行为的可见性，如果没有此工具则需要进行侵入式调试或修补。

审计事件表

bdb --- 调试器框架

faulthandler —— 转储 Python 的跟踪信息

转储跟踪信息

故障处理程序的状态

一定时间后转储跟踪数据。

转储用户信号的跟踪信息。

文件描述符相关话题

示例

pdb --- Python 的调试器

调试器命令

Python 性能分析器

性能分析器简介

实时用户手册

profile 和 cProfile 模块参考

Stats 类

什么是确定性性能分析？

局限性

准确估量

使用自定义计时器

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

基本示例

Python 接口

命令行接口

例子

trace —— 跟踪 Python 语句的执行

命令行用法

主要的可选参数

修饰器

过滤器

编程接口

tracemalloc --- 跟踪内存分配

例子

显示前10项

计算差异

获取一个内存块的溯源

美化的 top

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

API

函数

域过滤器

过滤器

帧

快照

统计

StatisticDiff

跟踪

回溯

审计事件表

下表包含了在整个 CPython 运行时和标准库中由 sys.audit() 或 PySys_Audit() 调用所引发的全部事件。 这些调用是在 3.8.0 或更高版本中添加了 (参见 PEP 578 [https://www.python.org/dev/peps/pep-0578])。

请参阅 sys.addaudithook() 和 PySys_AddAuditHook() 了解有关处理这些事件的详细信息。

CPython 实现细节： 此表是根据 CPython 文档生成的，可能无法表示其他实现所引发的事件。请参阅你的运行时专属的文档了解实际引发的事件。

Audit event | Arguments | References
array.__new__ | typecode, initializer | [1]
builtins.breakpoint | breakpointhook | [1]
builtins.id | id | [1]
builtins.input | prompt | [1]
builtins.input/result | result | [1]
code.__new__ | code, filename, name, argcount, posonlyargcount, kwonlyargcount, nlocals, stacksize, flags | [1]
compile | source, filename | [1]
cpython.PyInterpreterState_Clear |  | [1]
cpython.PyInterpreterState_New |  | [1]
cpython._PySys_ClearAuditHooks |  | [1]
cpython.run_command | command | [1]
cpython.run_file | filename | [1]
cpython.run_interactivehook | hook | [1]
cpython.run_module | module-name | [1]
cpython.run_startup | filename | [1]
cpython.run_stdin |  | [1][2][3]
ctypes.addressof | obj | [1]
ctypes.call_function | func_pointer, arguments | [1]
ctypes.cdata | address | [1]
ctypes.cdata/buffer | pointer, size, offset | [1][2]
ctypes.create_string_buffer | init, size | [1]
ctypes.create_unicode_buffer | init, size | [1]
ctypes.dlopen | name | [1]
ctypes.dlsym | library, name | [1]
ctypes.dlsym/handle | handle, name | [1]
ctypes.get_errno |  | [1]
ctypes.get_last_error |  | [1]
ctypes.seh_exception | code | [1]
ctypes.set_errno | errno | [1]
ctypes.set_last_error | error | [1]
ctypes.string_at | address, size | [1]
ctypes.wstring_at | address, size | [1]
ensurepip.bootstrap | root | [1]
exec | code_object | [1][2]
fcntl.fcntl | fd, cmd, arg | [1]
fcntl.flock | fd, operation | [1]
fcntl.ioctl | fd, request, arg | [1]
fcntl.lockf | fd, cmd, len, start, whence | [1]
ftplib.connect | self, host, port | [1]
ftplib.sendcmd | self, cmd | [1][2]
function.__new__ | code | [1]
gc.get_objects | generation | [1]
gc.get_referents | objs | [1]
gc.get_referrers | objs | [1]
glob.glob | pathname, recursive | [1][2]
glob.glob/2 | pathname, recursive, root_dir, dir_fd | [1][2]
http.client.connect | self, host, port | [1]
http.client.send | self, data | [1]
imaplib.open | self, host, port | [1]
imaplib.send | self, data | [1]
import | module, filename, sys.path, sys.meta_path, sys.path_hooks | [1]
marshal.dumps | value, version | [1]
marshal.load |  | [1]
marshal.loads | bytes | [1]
mmap.__new__ | fileno, length, access, offset | [1]
msvcrt.get_osfhandle | fd | [1]
msvcrt.locking | fd, mode, nbytes | [1]
msvcrt.open_osfhandle | handle, flags | [1]
nntplib.connect | self, host, port | [1][2]
nntplib.putline | self, line | [1][2]
object.__delattr__ | obj, name | [1]
object.__getattr__ | obj, name | [1]
object.__setattr__ | obj, name, value | [1]
open | file, mode, flags | [1][2][3]
os.add_dll_directory | path | [1]
os.chdir | path | [1][2]
os.chflags | path, flags | [1][2]
os.chmod | path, mode, dir_fd | [1][2][3]
os.chown | path, uid, gid, dir_fd | [1][2][3]
os.exec | path, args, env | [1]
os.fork |  | [1]
os.forkpty |  | [1]
os.fwalk | top, topdown, onerror, follow_symlinks, dir_fd | [1]
os.getxattr | path, attribute | [1]
os.kill | pid, sig | [1]
os.killpg | pgid, sig | [1]
os.link | src, dst, src_dir_fd, dst_dir_fd | [1]
os.listdir | path | [1]
os.listxattr | path | [1]
os.lockf | fd, cmd, len | [1]
os.mkdir | path, mode, dir_fd | [1][2]
os.posix_spawn | path, argv, env | [1][2]
os.putenv | key, value | [1]
os.remove | path, dir_fd | [1][2][3]
os.removexattr | path, attribute | [1]
os.rename | src, dst, src_dir_fd, dst_dir_fd | [1][2][3]
os.rmdir | path, dir_fd | [1]
os.scandir | path | [1]
os.setxattr | path, attribute, value, flags | [1]
os.spawn | mode, path, args, env | [1]
os.startfile | path, operation | [1]
os.startfile/2 | path, operation, arguments, cwd, show_cmd | [1]
os.symlink | src, dst, dir_fd | [1]
os.system | command | [1]
os.truncate | fd, length | [1][2]
os.unsetenv | key | [1]
os.utime | path, times, ns, dir_fd | [1]
os.walk | top, topdown, onerror, followlinks | [1]
pathlib.Path.glob | self, pattern | [1]
pathlib.Path.rglob | self, pattern | [1]
pdb.Pdb |  | [1]
pickle.find_class | module, name | [1]
poplib.connect | self, host, port | [1][2]
poplib.putline | self, line | [1][2]
pty.spawn | argv | [1]
resource.prlimit | pid, resource, limits | [1]
resource.setrlimit | resource, limits | [1]
setopencodehook |  | [1]
shutil.chown | path, user, group | [1]
shutil.copyfile | src, dst | [1][2][3]
shutil.copymode | src, dst | [1][2]
shutil.copystat | src, dst | [1][2]
shutil.copytree | src, dst | [1]
shutil.make_archive | base_name, format, root_dir, base_dir | [1]
shutil.move | src, dst | [1]
shutil.rmtree | path | [1]
shutil.unpack_archive | filename, extract_dir, format | [1]
signal.pthread_kill | thread_id, signalnum | [1]
smtplib.connect | self, host, port | [1]
smtplib.send | self, data | [1]
socket.__new__ | self, family, type, protocol | [1]
socket.bind | self, address | [1]
socket.connect | self, address | [1][2]
socket.getaddrinfo | host, port, family, type, protocol | [1]
socket.gethostbyaddr | ip_address | [1]
socket.gethostbyname | hostname | [1][2]
socket.gethostname |  | [1]
socket.getnameinfo | sockaddr | [1]
socket.getservbyname | servicename, protocolname | [1]
socket.getservbyport | port, protocolname | [1]
socket.sendmsg | self, address | [1]
socket.sendto | self, address | [1]
socket.sethostname | name | [1]
sqlite3.connect | database | [1]
sqlite3.connect/handle | connection_handle | [1]
sqlite3.enable_load_extension | connection, enabled | [1]
sqlite3.load_extension | connection, path | [1]
subprocess.Popen | executable, args, cwd, env | [1]
sys._current_exceptions |  | [1]
sys._current_frames |  | [1]
sys._getframe |  | [1]
sys.addaudithook |  | [1][2]
sys.excepthook | hook, type, value, traceback | [1]
sys.set_asyncgen_hooks_finalizer |  | [1]
sys.set_asyncgen_hooks_firstiter |  | [1]
sys.setprofile |  | [1]
sys.settrace |  | [1]
sys.unraisablehook | hook, unraisable | [1]
syslog.closelog |  | [1]
syslog.openlog | ident, logoption, facility | [1]
syslog.setlogmask | maskpri | [1]
syslog.syslog | priority, message | [1]
telnetlib.Telnet.open | self, host, port | [1]
telnetlib.Telnet.write | self, buffer | [1]
tempfile.mkdtemp | fullpath | [1][2]
tempfile.mkstemp | fullpath | [1][2][3]
urllib.Request | fullurl, data, headers, method | [1]
webbrowser.open | url | [1]
winreg.ConnectRegistry | computer_name, key | [1]
winreg.CreateKey | key, sub_key, access | [1][2]
winreg.DeleteKey | key, sub_key, access | [1][2]
winreg.DeleteValue | key, value | [1]
winreg.DisableReflectionKey | key | [1]
winreg.EnableReflectionKey | key | [1]
winreg.EnumKey | key, index | [1]
winreg.EnumValue | key, index | [1]
winreg.ExpandEnvironmentStrings | str | [1]
winreg.LoadKey | key, sub_key, file_name | [1]
winreg.OpenKey | key, sub_key, access | [1]
winreg.OpenKey/result | key | [1][2][3]
winreg.PyHKEY.Detach | key | [1]
winreg.QueryInfoKey | key | [1]
winreg.QueryReflectionKey | key | [1]
winreg.QueryValue | key, sub_key, value_name | [1][2]
winreg.SaveKey | key, file_name | [1]
winreg.SetValue | key, sub_key, type, value | [1][2]

下列事件只在内部被引发，不对应任何 CPython 公共 API:

审计事件 | 实参
_winapi.CreateFile | file_name, desired_access, share_mode, creation_disposition, flags_and_attributes
_winapi.CreateJunction | src_path, dst_path
_winapi.CreateNamedPipe | name, open_mode, pipe_mode
_winapi.CreatePipe |
_winapi.CreateProcess | application_name, command_line, current_directory
_winapi.OpenProcess | process_id, desired_access
_winapi.TerminateProcess | handle, exit_code
ctypes.PyObj_FromPtr | obj

bdb --- 调试器框架

源代码: Lib/bdb.py [https://github.com/python/cpython/tree/3.10/Lib/bdb.py]

bdb 模块处理基本的调试器函数，例如设置中断点或通过调试器来管理执行。

定义了以下异常：

exception bdb.BdbQuit

由 Bdb 类引发用于退出调试器的异常。

bdb 模块还定义了两个类:

class bdb.Breakpoint(self, file, line, temporary=False, cond=None, funcname=None)

这个类实现了临时性中断点、忽略计数、禁用与（重新）启用，以及条件设置等。

中断点通过一个名为 bpbynumber 的列表基于数字并通过 bplist 基于 (file, line) 对进行索引。 前者指向一个 Breakpoint 类的单独实例。 后者指向一个由这种实例组成的列表，因为在每一行中可能存在多个中断点。

当创建一个中断点时，它所关联的 文件名 应当为规范形式。 如果定义了 funcname，则当该函数的第一行被执行时将增加一次中断点 命中 次数。 有条件的 中断点将总是会计入 命中 次数。

Breakpoint 的实例具有下列方法:

deleteMe()

从关联到文件/行的列表中删除此中断点。 如果它是该位置上的最后一个中断点，还将删除相应的文件/行条目。

enable()

将此中断点标记为启用。

disable()

将此中断点标记为禁用。

bpformat()

返回一个带有关于此中断点的所有信息的，格式良好的字符串:

中断点编号 。

临时状态（删除或保留）。

文件/行位置。

中断条件

要忽略的次数。

命中的次数。

3.2 新版功能.

bpprint(out=None)

将 bpformat() 的输出打印到文件 out，或者如果为 None 则打印到标准输出。, to standard output.

Breakpoint 实例具有以下属性:

file

Breakpoint 的文件名。

line

Breakpoint 在 file 中的行号。

temporary

如果 (file, line) 上的 Breakpoint 是临时性的则返回 True。

cond

在 (file, line) 上对 Breakpoint 求值的条件。

funcname

用于定义在进入函数时一个 Breakpoint 是否命中的函数的名称。

enabled

如果 Breakpoint 被启用则为 True。

bpbynumber

一个 Breakpoint 单独实例的数字索引。

bplist

以 (file, line) 元组作为索引的 Breakpoint 实例的字典。

ignore

忽略一个 Breakpoint 的次数。

hits

命中一个 Breakpoint 的次数统计。

class bdb.Bdb(skip=None)

Bdb 类是作为通用的 Python 调试器基类。

这个类负责追踪工具的细节；所派生的类应当实现用户交互。 标准调试器类 (pdb.Pdb) 就是一个例子。

如果给出了 skip 参数，它必须是一个包含 glob 风格的模块名称模式的可迭代对象。 调试器将不会步进到来自与这些模式相匹配的模块的帧。 一个帧是否会被视为来自特定的模块是由帧的 __name__ 全局变量来确定的。

3.1 新版功能: skip 参数。

Bdb 的以下方法通常不需要被重写。

canonic(filename)

返回 filename 的规范形式。

对于真实的文件名称，此规范形式是一个依赖于具体操作系统的，大小写规范的 绝对路径。 在交互模式下生成的带有尖括号的 filename，如 "<stdin>"，会被不加修改地返回。

reset()

将 botframe, stopframe, returnframe 和 quitting 属性设置为准备开始调试的值。

trace_dispatch(frame, event, arg)

此函数被安装为被调试帧的追踪函数。 它的返回值是新的追踪函数（在大多数情况下就是它自身）。

默认实现会决定如何分派帧，这取决于即将被执行的事件的类型（作为字符串传入）。 event 可以是下列值之一:

"line": 一个新的代码行即将被执行。

"call": 一个函数即将被调用，或者进入了另一个代码块。

"return": 一个函数或其他代码块即将返回。

"exception": 一个异常已发生。

"c_call": 一个 C 函数即将被调用。

"c_return": 一个 C 函数已返回。

"c_exception": 一个 C 函数引发了异常。

对于 Python 事件，调用了专门的函数（见下文）。 对于 C 事件，不执行任何操作。

arg 形参取决于之前的事件。

请参阅 sys.settrace() 的文档了解追踪函数的更多信息。 对于代码和帧对象的详情，请参考 标准类型层级结构。

dispatch_line(frame)

如果调试器应当在当前行上停止，则发起调用 user_line() 方法（该方法应当在子类中被重写）。 如果设置了 Bdb.quitting 旗标（可以通过 user_line() 设置）则将引发 BdbQuit 异常。 返回一个对 trace_dispatch() 方法的引用以便在该作用域内进一步地追踪。

dispatch_call(frame, arg)

如果调试器应当在此函数调用上停止，则发起调用 user_call() 方法（该方法应当在子类中被重写）。 如果设置了 Bdb.quitting 旗标（可以通过 user_call() 设置）则将引发 BdbQuit 异常。 返回一个对 trace_dispatch() 方法的引用以便在该作用域内进一步地追踪。

dispatch_return(frame, arg)

如果调试器应当在此函数返回时停止，则发起调用 user_return() 方法（该方法应当在子类中被重写）。 如果设置了 Bdb.quitting 旗标（可以通过 user_return() 设置）则将引发 BdbQuit 异常。 返回一个对 trace_dispatch() 方法的引用以便在该作用域内进一步地追踪。

dispatch_exception(frame, arg)

如果调试器应当在此异常上停止，则发起调用 user_exception() 方法（该方法应当在子类中被重写）。 如果设置了 Bdb.quitting 旗标（可以通过 user_exception() 设置）则将引发 BdbQuit 异常。 返回一个对 trace_dispatch() 方法的引用以便在该作用域内进一步地追踪。

通常情况下派生的类不会重写下列方法，但是如果想要重新定义停止和中断点的定义则可能会重写它们。

is_skipped_line(module_name)

如果 module_name 匹配到任何跳过模式则返回 True。

stop_here(frame)

如果 frame 在栈的起始帧之下则返回 True。

break_here(frame)

如果该行有生效的中断点则返回 True。

检测某行或某函数是否存在中断点且处于生效状态。 基于来自 effective() 的信息删除临时中断点。

break_anywhere(frame)

如果存在任何针对 frame 的文件名的中断点则返回 True。

派生的类应当重写这些方法以获取调试器操作的控制权。

user_call(frame, argument_list)

如果中断可能在被调用的函数内停止则会从 dispatch_call() 来调用。

user_line(frame)

当 stop_here() 或 break_here() 返回 True 时则会从 dispatch_line() 来调用。

user_return(frame, return_value)

当 stop_here() 返回 True 时则会从 dispatch_return() 来调用。

user_exception(frame, exc_info)

当 stop_here() 返回 True 时则会从 dispatch_exception() 来调用。

do_clear(arg)

处理当一个中断点属于临时性中断点时是否必须要移除它。

此方法必须由派生类来实现。

派生类与客户端可以调用以下方法来影响步进状态。

set_step()

在一行代码之后停止。

set_next(frame)

在给定的帧以内或以下的下一行停止。

set_return(frame)

当从给定的帧返回时停止。

set_until(frame, lineno=None)

在 lineno 行大于当前所到达的行或者在从当前帧返回时停止。

set_trace([frame])

从 frame 开始调试。 如果未指定 frame，则从调用者的帧开始调试。

set_continue()

仅在中断点上或是当结束时停止。 如果不存在中断点，则将系统追踪函数设为 None。

set_quit()

将 quitting 属性设为 True。 这将在对某个 dispatch_*() 方法的下一次调用中引发 BdbQuit。

派生的类和客户端可以调用下列方法来操纵中断点。 如果出现错误则这些方法将返回一个包含错误消息的字符串，或者如果一切正常则返回 None。

set_break(filename, lineno, temporary=False, cond=None, funcname=None)

设置一个新的中断点。 如果对于作为参数传入的 filename 不存在 lineno，则返回一条错误消息。 filename 应为规范的形式，如在 canonic() 方法中描述的。

clear_break(filename, lineno)

删除位于 filename 和 lineno 的中断点。 如果未设置过中断点，则返回一条错误消息。

clear_bpbynumber(arg)

删除 Breakpoint.bpbynumber 中索引号为 arg 的中断点。 如果 arg 不是数字或超出范围，则返回一条错误消息。

clear_all_file_breaks(filename)

删除位于 filename 的所有中断点。 如果未设置过中断点，则返回一条错误消息。

clear_all_breaks()

删除所有现存的中断点。 如果未设置过中断点，则返回一条错误消息。

get_bpbynumber(arg)

返回由指定数字所指明的中断点。 如果 arg 是一个字符串，它将被转换为一个数字。 如果 arg 不是一个表示数字的字符串，如果给定的中断点不存在或者已被删除，则会引发 ValueError。

3.2 新版功能.

get_break(filename, lineno)

如果 filename 中的 lineno 上有中断点则返回 True。

get_breaks(filename, lineno)

返回 filename 中在 lineno 上的所有中断点，或者如果未设置任何中断点则返回一个空列表。

get_file_breaks(filename)

返回 filename 中的所有中断点，或者如果未设置任何中断点则返回一个空列表。

get_all_breaks()

返回已设置的所有中断点。

派生类与客户端可以调用以下方法来获取一个代表栈回溯信息的数组结构。

get_stack(f, t)

返回一个栈回溯中 (frame, lineno) 元组的列表，及一个大小值。

最近调用的帧将排在列表的末尾。 大小值即调试器被唤起所在帧之下的帧数量。

format_stack_entry(frame_lineno, lprefix=': ')

返回一个字符串，其内容为有关以 (frame, lineno) 元组表示的特定栈条目的信息。 返回的字符串包含:

包含该帧的规范文件名。

函数名称或 "<lambda>"。

输入参数。

返回值。

代码的行（如果存在）。

以下两个方法可由客户端调用以使用一个调试器来调试一条以字符串形式给出的 statement。

run(cmd, globals=None, locals=None)

调试一条通过 exec() 函数执行的语句。 globals 默认为 __main__.__dict__，locals 默认为 globals。

runeval(expr, globals=None, locals=None)

调试一条通过 eval() 函数执行的表达式。 globals 和 locals 的含义与在 run() 中的相同。

runctx(cmd, globals, locals)

为了保证向下兼容性。 调用 run() 方法。

runcall(func, /, *args, **kwds)

调试一个单独的函数调用，并返回其结果。

最后，这个模块定义了以下函数:

bdb.checkfuncname(b, frame)

如果要在此中断则返回 True，具体取决于 Breakpoint b 的设置方式。

如果是通过行号设置的，它将检查 b.line 是否与 frame 中的行一致。 如果中断点是通过 函数名称 设置的，则必须检查是否位于正确的 帧 (正确的函数) 以及是否位于其中第一个可执行的行。

bdb.effective(file, line, frame)

返回 (active breakpoint, delete temporary flag) 或 (None, None) 作为目标中断点。

激活的中断点 是 bplist 中对应 (file, line) 的第一个 已启用的 条目 (它必须存在)，对应的 checkfuncname() 为 True，并且没有 False cond 或为正值的 ignore 计数。 flag 表示临时中断点应当被删除，它仅在 cond 无法被求值时 (在此情况下，ignore 计数会被忽略) 才会为 False。

如果不存在这样的条目，则返回 (None, None)。

bdb.set_trace()

使用一个来自调用方的帧的 Bdb 实例开始调试。

faulthandler —— 转储 Python 的跟踪信息

3.3 新版功能.

当故障、超时或收到用户信号时，利用本模块内的函数可转储 Python 跟踪信息。调用 faulthandler.enable() 可安装 SIGSEGV 、 SIGFPE 、 SIGABRT 、 SIGBUS 和 SIGILL 信号的故障处理程序。通过设置 PYTHONFAULTHANDLER 环境变量或 -X faulthandler 命令行参数，还可以在启动时开启这些设置。

故障处理程序与操作系统的故障处理程序兼容，比如 Apport 或 Windows 故障处理程序等。如果 sigaltstack() 函数可用，本模块将为信号处理程序使用备用堆栈。这样即便堆栈溢出也能转储跟踪信息。

故障处理程序将在灾难性场合调用，因此只能使用信号安全的函数（比如不能在堆上分配内存）。由于这一限制，与正常的 Python 跟踪相比，转储量是最小的。

只支持 ASCII 码。编码时会用到 backslashreplace 错误处理程序。

每个字符串限制在 500 个字符以内。

只会显式文件名、函数名和行号。（不显示源代码）

上限是 100 页内存帧和 100 个线程。

反序排列：最近的调用最先显示。

默认情况下，Python 的跟踪信息会写入 sys.stderr。为了能看到跟踪信息，应用程序必须运行于终端中。日志文件也可以传给 faulthandler.enable()。

本模块是用 C 语言实现的，所以才能在崩溃或 Python 死锁时转储跟踪信息。

在 Python 启动时， Python 开发模式 会调用 faulthandler.enable()。

参见

模块 pdb

用于 Python 程序的交互式源代码调试器。

模块 traceback

提取、格式化和打印 Python 程序的栈回溯信息的标准接口。

转储跟踪信息

faulthandler.dump_traceback(file=sys.stderr, all_threads=True)

将所有线程的跟踪数据转储到 file 中。如果 all_threads 为 False，则只转储当前线程。

参见

traceback.print_tb()，可被用于打印回溯对象。

在 3.5 版更改: 增加了向本函数传入文件描述符的支持。

故障处理程序的状态

faulthandler.enable(file=sys.stderr, all_threads=True)

启用故障处理程序：为 SIGSEGV 、 SIGFPE 、 SIGABRT 、 SIGBUS 和 SIGILL 信号安装处理程序，以转储 Python 跟踪信息。如果 all_threads 为 True，则会为每个运行中的线程生成跟踪信息。否则只转储当前线程。

file 必须保持打开状态，直至停用故障处理程序为止：参见 文件描述符相关话题。

在 3.5 版更改: 增加了向本函数传入文件描述符的支持。

在 3.6 版更改: 在 Windows 系统中，同时会安装一个 Windows 异常处理程序。

在 3.10 版更改: 现在如果 all_threads 为 True，则转储信息会包含垃圾收集器是否正在运行。

faulthandler.disable()

停用故障处理程序：卸载由 enable() 安装的信号处理程序。

faulthandler.is_enabled()

检查故障处理程序是否被启用。

一定时间后转储跟踪数据。

faulthandler.dump_traceback_later(timeout, repeat=False, file=sys.stderr, exit=False)

在 timeout 秒超时后，转储所有线程的跟踪信息，如果 repeat 为 True，则每隔 timeout 秒转储一次。如果 exit 为 True，则在转储跟踪信息后调用 _exit()，参数 status=1。请注意， _exit() 会立即关闭进程，这意味着不做任何清理工作，如刷新文件缓冲区等。如果调用两次函数，则新的调用将取代之前的参数，超时时间也会重置。计时器的精度为亚秒级。

file 必须保持打开状态，直至跟踪信息转储完毕，或调用了 cancel_dump_traceback_later() ：参见 文件描述符相关话题。

本函数用一个看门狗线程实现。

在 3.7 版更改: 该函数现在总是可用。

在 3.5 版更改: 增加了向本函数传入文件描述符的支持。

faulthandler.cancel_dump_traceback_later()

取消 dump_traceback_later() 的最后一次调用。

转储用户信号的跟踪信息。

faulthandler.register(signum, file=sys.stderr, all_threads=True, chain=False)

注册一个用户信号：为 signum 信号安装一个处理程序，将所有线程或当前线程（all_threads 为 False 时）的跟踪信息转储到 file 中。如果 chain 为 True，则调用上一层处理程序。

file 必须保持打开状态，直至该信号被 unregister() 注销：参见 文件描述符相关话题。

Windows 中不可用。

在 3.5 版更改: 增加了向本函数传入文件描述符的支持。

faulthandler.unregister(signum)

注销一个用户信号：卸载由 register() 安装的 signum 信号处理程序。如果信号已注册，返回 True，否则返回 False。

Windows 中不可用。

文件描述符相关话题

enable() 、 dump_traceback_later() 和 register() 保留其 file 参数给出的文件描述符。 如果文件关闭，文件描述符将被一个新文件重新使用；或者用 os.dup2() 替换了文件描述符，则跟踪信息将被写入另一个文件。 每次文件被替换时，都会再次调用这些函数。

示例

在 Linux 中启用和停用内存段故障的默认处理程序：

$ python3 -c "import ctypes; ctypes.string_at(0)"
Segmentation fault

$ python3 -q -X faulthandler
>>> import ctypes
>>> ctypes.string_at(0)
Fatal Python error: Segmentation fault

Current thread 0x00007fb899f39700 (most recent call first):
  File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
  File "<stdin>", line 1 in <module>
Segmentation fault

pdb --- Python 的调试器

源代码： Lib/pdb.py [https://github.com/python/cpython/tree/3.10/Lib/pdb.py]

pdb 模块定义了一个交互式源代码调试器，用于 Python 程序。它支持在源码行间设置（有条件的）断点和单步执行，检视堆栈帧，列出源码列表，以及在任何堆栈帧的上下文中运行任意 Python 代码。它还支持事后调试，可以在程序控制下调用。

调试器是可扩展的——调试器实际被定义为 Pdb 类。该类目前没有文档，但通过阅读源码很容易理解它。扩展接口使用了 bdb 和 cmd 模块。

参见

模块 faulthandler

用于在发生错误、超时或用户信号时显式地转储 Python 回溯信息。

模块 traceback

提取、格式化和打印 Python 程序的栈回溯信息的标准接口。

调试器的提示符是 (Pdb)。在调试器的控制下运行程序的典型用法是:

>>> import pdb
>>> import mymodule
>>> pdb.run('mymodule.test()')
> <string>(0)?()
(Pdb) continue
> <string>(1)?()
(Pdb) continue
NameError: 'spam'
> <string>(1)?()
(Pdb)

在 3.3 版更改: 由 readline 模块实现的 Tab 补全可用于补全本模块的命令和命令的参数，例如，Tab 补全会提供当前的全局变量和局部变量，用作 p 命令的参数。

也可以将 pdb.py 作为脚本调用，来调试其他脚本。例如:

python -m pdb myscript.py

当作为脚本调用时，如果要调试的程序异常退出，pdb 调试将自动进入事后调试。事后调试之后（或程序正常退出之后），pdb 将重新启动程序。自动重启会保留 pdb 的状态（如断点），在大多数情况下，这比在退出程序的同时退出调试器更加实用。

3.2 新版功能: pdb.py 现在接受 -c 选项，可以执行命令，这与将该命令写入 .pdbrc 文件相同，请参阅 调试器命令。

3.7 新版功能: pdb.py now accepts a -m option that execute modules similar to the way python -m does. As with a script, the debugger will pause execution just before the first line of the module.

中断进入调试器的典型用法是插入:

import pdb; pdb.set_trace()

到你想进入调试器的位置，再运行程序。 然后你可以单步执行这条语句之后的代码，并使用 continue 命令来关闭调试器继续运行。

3.7 新版功能: 内置函数 breakpoint()，当以默认参数调用它时，可以用来代替 import pdb; pdb.set_trace()。

检查已崩溃程序的典型用法是:

>>> import pdb
>>> import mymodule
>>> mymodule.test()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "./mymodule.py", line 4, in test
    test2()
  File "./mymodule.py", line 3, in test2
    print(spam)
NameError: spam
>>> pdb.pm()
> ./mymodule.py(3)test2()
-> print(spam)
(Pdb)

本模块定义了下列函数，每个函数进入调试器的方式略有不同：

pdb.run(statement, globals=None, locals=None)

在调试器控制范围内执行 statement （以字符串或代码对象的形式提供）。调试器提示符会在执行代码前出现，你可以设置断点并键入 continue，也可以使用 step 或 next 逐步执行语句（上述所有命令在后文有说明）。可选参数 globals 和 locals 指定代码执行环境，默认时使用 __main__ 模块的字典。（请参阅内置函数 exec() 或 eval() 的说明。）

pdb.runeval(expression, globals=None, locals=None)

在调试器控制下对 expression (以字符串或代码对象的形式给出) 求值。 当 runeval() 返回时，它将返回 expression 的值。 在其他方面此函数与 run() 类似。

pdb.runcall(function, *args, **kwds)

使用给定的参数调用 function （以函数或方法对象的形式提供，不能是字符串）。runcall() 返回的是所调用函数的返回值。调试器提示符将在进入函数后立即出现。

pdb.set_trace(*, header=None)

在调用本函数的堆栈帧处进入调试器。用于硬编码一个断点到程序中的固定点处，即使该代码不在调试状态（如断言失败时）。如果传入 header，它将在调试开始前被打印到控制台。

在 3.7 版更改: 仅关键字参数 header。

pdb.post_mortem(traceback=None)

进入 traceback 对象的事后调试。如果没有给定 traceback，默认使用当前正在处理的异常之一（默认时，必须存在正在处理的异常）。

pdb.pm()

在 sys.last_traceback 中查找 traceback，并进入其事后调试。

run* 函数和 set_trace() 都是别名，用于实例化 Pdb 类和调用同名方法。如果要使用其他功能，则必须自己执行以下操作：

class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)

Pdb 是调试器类。

completekey、stdin 和 stdout 参数都会传递给底层的 cmd.Cmd 类，请参考相应的描述。

如果给出 skip 参数，则它必须是一个迭代器，可以迭代出 glob-style 样式的模块名称。如果遇到匹配上述样式的模块，调试器将不会进入来自该模块的堆栈帧。 1

默认情况下，当发出 continue 命令时，Pdb 将为 SIGINT 信号（信号当用户在控制台按 Ctrl-C 时发出的）设置一个处理器。 这使用户可以通过按 Ctrl-C 再次进入调试器。 如果你希望 Pdb 不要改变 SIGINT 处理器，请将 nosigint 设为真值。to true.

readrc 参数默认为 true，它控制 Pdb 是否从文件系统加载 .pdbrc 文件。

启用跟踪且带有 skip 参数的调用示范:

import pdb; pdb.Pdb(skip=['django.*']).set_trace()

引发一个不带参数的 审计事件 pdb.Pdb。

3.1 新版功能: skip 参数。

3.2 新版功能: nosigint 参数。在这之前，Pdb 不为 SIGINT 设置处理程序。

在 3.6 版更改: readrc 参数。

run(statement, globals=None, locals=None)

runeval(expression, globals=None, locals=None)

runcall(function, *args, **kwds)

set_trace()

请参阅上文解释同名函数的文档。

调试器命令

下方列出的是调试器可接受的命令。如下所示，大多数命令可以缩写为一个或两个字母。如 h(elp) 表示可以输入 h 或 help 来输入帮助命令（但不能输入 he 或 hel，也不能是 H 或 Help 或 HELP）。命令的参数必须用空格（空格符或制表符）分隔。在命令语法中，可选参数括在方括号 ([]) 中，使用时请勿输入方括号。命令语法中的选择项由竖线 (|) 分隔。

输入一个空白行将重复最后输入的命令。例外：如果最后一个命令是 list 命令，则会列出接下来的 11 行。

调试器无法识别的命令将被认为是 Python 语句，并在正在调试的程序的上下文中执行。Python 语句也可以用感叹号 (!) 作为前缀。这是检查正在调试的程序的强大方法，甚至可以修改变量或调用函数。当此类语句发生异常，将打印异常名称，但调试器的状态不会改变。

调试器支持 别名。别名可以有参数，使得调试器对被检查的上下文有一定程度的适应性。

在一行中可以输入多条命令，以 ;; 分隔。 （不能使用单个 ;，因为它已被用作传给 Python 解析器的一行中的多条命令的分隔符。） 命令切分所用的方式没有任何智能可言；输入总是会在第一个 ;; 对上被切分，即使它位于带引号的字符串中。 对于带有双分号的字符串可以使用隐式字符串拼接 ';'';' 或 ";"";" 来变通处理。

如果文件 .pdbrc 存在于用户主目录或当前目录中，则将其读入并执行，等同于在调试器提示符下键入该文件。这对于别名很有用。若两个文件都存在则首先读取主目录中的文件，且本地文件可以覆盖其中定义的别名。

在 3.2 版更改: .pdbrc 现在可以包含继续调试的命令，如 continue 或 next。文件中的这些命令以前是无效的。

h(elp) [command]

不带参数时，显示可用的命令列表。参数为 command 时，打印有关该命令的帮助。help pdb 显示完整文档（即 pdb 模块的文档字符串）。由于 command 参数必须是标识符，因此要获取 ! 的帮助必须输入 help exec。

w(here)

打印堆栈回溯，最新一帧在底部。有一个箭头指向当前帧，该帧决定了大多数命令的上下文。

d(own) [count]

在堆栈回溯中，将当前帧向下移动 count 级（默认为 1 级，移向更新的帧）。

u(p) [count]

在堆栈回溯中，将当前帧向上移动 count 级（默认为 1 级，移向更老的帧）。

b(reak) [([filename:]lineno | function) [, condition]]

如果带有 lineno 参数，则在当前文件相应行处设置一个断点。如果带有 function 参数，则在该函数的第一条可执行语句处设置一个断点。行号可以加上文件名和冒号作为前缀，以在另一个文件（可能是尚未加载的文件）中设置一个断点。另一个文件将在 sys.path 范围内搜索。请注意，每个断点都分配有一个编号，其他所有断点命令都引用该编号。

如果第二个参数存在，它应该是一个表达式，且它的计算值为 true 时断点才起作用。

如果不带参数执行，将列出所有中断，包括每个断点、命中该断点的次数、当前的忽略次数以及关联的条件（如果有）。

tbreak [([filename:]lineno | function) [, condition]]

临时断点，在第一次命中时会自动删除。它的参数与 break 相同。

cl(ear) [filename:lineno | bpnumber ...]

如果参数是 filename:lineno，则清除此行上的所有断点。如果参数是空格分隔的断点编号列表，则清除这些断点。如果不带参数，则清除所有断点（但会先提示确认）。

disable [bpnumber ...]

禁用断点，断点以空格分隔的断点编号列表给出。禁用断点表示它不会导致程序停止执行，但是与清除断点不同，禁用的断点将保留在断点列表中并且可以（重新）启用。

enable [bpnumber ...]

启用指定的断点。

ignore bpnumber [count]

为指定的断点编号设置忽略次数。 如果省略 count，则忽略次数将设置为 0。 当忽略次数为零时断点将变为活动状态。 如果为非零值，则在每次到达断点且断点未禁用且关联条件取真值时 count 就像递减。

condition bpnumber [condition]

为断点设置一个新 condition，它是一个表达式，且它的计算值为 true 时断点才起作用。如果没有给出 condition，则删除现有条件，也就是将断点设为无条件。

commands [bpnumber]

为编号是 bpnumber 的断点指定一系列命令。命令内容将显示在后续的几行中。输入仅包含 end 的行来结束命令列表。举个例子:

(Pdb) commands 1
(com) p some_variable
(com) end
(Pdb)

要删除断点上的所有命令，请输入 commands 并立即以 end 结尾，也就是不指定任何命令。

如果不带 bpnumber 参数，commands 作用于最后一个被设置的断点。

可以为断点指定命令来重新启动程序。只需使用 continue 或 step 命令或其他可以继续运行程序的命令。

如果指定了某个继续运行程序的命令（目前包括 continue, step, next, return, jump, quit 及它们的缩写）将终止命令列表（就像该命令后紧跟着 end）。因为在任何时候继续运行下去（即使是简单的 next 或 step），都可能会遇到另一个断点，该断点可能具有自己的命令列表，这导致要执行的列表含糊不清。

如果在命令列表中使用 silent 命令，那么在断点处停下时就不会打印常规信息。 这正是要打印特定消息然后继续运行的断点所想要的。 如果没有其他命令来打印任何消息，则你将不会看到已到达断点的迹象。

s(tep)

运行当前行，在第一个可以停止的位置（在被调用的函数内部或在当前函数的下一行）停下。

n(ext)

继续运行，直到运行到当前函数的下一行，或当前函数返回为止。（ next 和 step 之间的区别在于，step 进入被调用函数内部并停止，而 next （几乎）全速运行被调用函数，仅在当前函数的下一行停止。）

unt(il) [lineno]

如果不带参数，则继续运行，直到行号比当前行大时停止。

如果带有 lineno，则继续执行直至行号大于或等于 lineno。 在这两种情况下，在当前帧返回时也将停止。

在 3.2 版更改: 允许明确给定行号。

r(eturn)

继续运行，直到当前函数返回。

c(ont(inue))

继续运行，仅在遇到断点时停止。

j(ump) lineno

设置即将运行的下一行。仅可用于堆栈最底部的帧。它可以往回跳来再次运行代码，也可以往前跳来跳过不想运行的代码。

需要注意的是，不是所有的跳转都是允许的 -- 例如，不能跳转到 for 循环的中间或跳出 finally 子句。

l(ist) [first[, last]]

列出当前文件的源代码。如果不带参数，则列出当前行周围的 11 行，或延续前一次列出。如果用 . 作为参数，则列出当前行周围的 11 行。如果带有一个参数，则列出那一行周围的 11 行。如果带有两个参数，则列出所给的范围中的代码；如果第二个参数小于第一个参数，则将其解释为列出行数的计数。

当前帧中的当前行用 -> 标记。如果正在调试异常，且最早抛出或传递该异常的行不是当前行，则那一行用 >> 标记。

3.2 新版功能: >> 标记。

ll | longlist

列出当前函数或帧的所有源代码。相关行的标记与 list 相同。

3.2 新版功能.

a(rgs)

打印当前函数的参数列表。

p expression

在当前上下文中对 expression 求值并打印该值。

注解

print() 也可以使用，但它不是一个调试器命令 --- 它执行 Python print() 函数。

pp expression

与 p 命令类似，但 expression 的值将使用 pprint 模块美观地打印。

whatis expression

打印 expression 的类型。

source expression

尝试获取 expression 的源代码并显示它。

3.2 新版功能.

display [expression]

如果 expression 的值发生变化则显示它的值，每次都会停止执行当前帧。

如果不带 expression，则列出当前帧的所有显示表达式。

3.2 新版功能.

undisplay [expression]

不再显示当前帧中的 expression。 如果不带 expression，则清除当前帧的所有显示表达式。

3.2 新版功能.

interact

启动一个交互式解释器（使用 code 模块），它的全局命名空间将包含当前作用域中的所有（全局和局部）名称。

3.2 新版功能.

alias [name [command]]

创建一个名为 name 的别名用来执行 command。 command 外边 不可 带引号。 可替换形参可以用 %1, %2 等来指明，而 %* 将被所有形参所替换。 如果省略 command，则显示 name 的当前别名。 如未给出任何参数，则列出所有别名。

别名允许嵌套并可包含能在 pdb 提示符下合法输入的任何内容。 请注意内部 pdb 命令 可以 被别名所覆盖。 这样的命令将被隐藏直到别名被移除。 别名会递归地应用到命令行的第一个单词；行内的其他单词不会受影响。

作为示例，这里列出了两个有用的别名（特别适合放在 .pdbrc 文件中）:

# Print instance variables (usage "pi classInst")
alias pi for k in %1.__dict__.keys(): print(f"%1.{k} = {%1.__dict__[k]}")
# Print instance variables in self
alias ps pi self

unalias name

删除指定的别名 name。

! statement

在当前堆栈帧的上下文中执行 (单行) statement。 感叹号可以被省略，除非语句的第一个单词与调试器命令重名。 要设置全局变量，你可以在同一行上为赋值命令添加前缀的 global 语句，例如:

(Pdb) global list_options; list_options = ['-l']
(Pdb)

run [args ...]

restart [args ...]

重启被调试的 Python 程序。 如果提供了 args，它会用 shlex 来拆分且拆分结果将被用作新的 sys.argv。 历史、中断点、动作和调试器选项将被保留。 restart 是 run 的一个别名。

q(uit)

退出调试器。 被执行的程序将被中止。

debug code

进入一个对 code 执行步进的递归调试器（该参数是在当前环境中执行的任意表达式或语句）。

retval

打印函数最后一次返回的返回值。

备注

1

一个帧是否会被认为源自特定模块是由帧全局变量 __name__ 来决定的。

Python 性能分析器

源代码： Lib/profile.py [https://github.com/python/cpython/tree/3.10/Lib/profile.py] 和 Lib/pstats.py [https://github.com/python/cpython/tree/3.10/Lib/pstats.py]

性能分析器简介

cProfile 和 profile 提供了 Python 程序的 确定性性能分析 。 profile 是一组统计数据，描述程序的各个部分执行的频率和时间。这些统计数据可以通过 pstats 模块格式化为报表。

Python 标准库提供了同一分析接口的两种不同实现：

对于大多数用户，建议使用 cProfile ；这是一个 C 扩展插件，因为其合理的运行开销，所以适合于分析长时间运行的程序。该插件基于 lsprof ，由 Brett Rosen 和 Ted Chaotter 贡献。

profile 是一个纯 Python 模块（cProfile 就是模拟其接口的 C 语言实现），但它会显著增加配置程序的开销。如果你正在尝试以某种方式扩展分析器，则使用此模块可能会更容易完成任务。该模块最初由 Jim Roskind 设计和编写。

注解

profiler 分析器模块被设计为给指定的程序提供执行概要文件，而不是用于基准测试目的（ timeit 才是用于此目标的，它能获得合理准确的结果）。这特别适用于将 Python 代码与 C 代码进行基准测试：分析器为Python 代码引入开销，但不会为 C级别的函数引入开销，因此 C 代码似乎比任何Python 代码都更快。

实时用户手册

本节是为 “不想阅读手册” 的用户提供的。它提供了非常简短的概述，并允许用户快速对现有应用程序执行评测。

要分析采用单个参数的函数，可以执行以下操作：

import cProfile
import re
cProfile.run('re.compile("foo|bar")')

（如果 cProfile 在您的系统上不可用，请使用 profile 。）

上述操作将运行 re.compile() 并打印分析结果，如下所示：

      197 function calls (192 primitive calls) in 0.002 seconds

Ordered by: standard name

ncalls  tottime  percall  cumtime  percall filename:lineno(function)
     1    0.000    0.000    0.001    0.001 <string>:1(<module>)
     1    0.000    0.000    0.001    0.001 re.py:212(compile)
     1    0.000    0.000    0.001    0.001 re.py:268(_compile)
     1    0.000    0.000    0.000    0.000 sre_compile.py:172(_compile_charset)
     1    0.000    0.000    0.000    0.000 sre_compile.py:201(_optimize_charset)
     4    0.000    0.000    0.000    0.000 sre_compile.py:25(_identityfunction)
   3/1    0.000    0.000    0.000    0.000 sre_compile.py:33(_compile)

第一行显示监听了197个调用。在这些调用中，有192个是 原始的 ，这意味着调用不是通过递归引发的。下一行: Ordered by: standard name ，表示最右边列中的文本字符串用于对输出进行排序。列标题包括：

ncalls

调用次数

tottime

在指定函数中消耗的总时间（不包括调用子函数的时间）

percall

是 tottime 除以 ncalls 的商

cumtime

指定的函数及其所有子函数（从调用到退出）消耗的累积时间。这个数字对于递归函数来说是准确的。

percall

是 cumtime 除以原始调用（次数）的商（即：函数运行一次的平均时间）

filename:lineno(function)

提供相应数据的每个函数

如果第一列中有两个数字（例如3/1），则表示函数递归。第二个值是原始调用次数，第一个是调用的总次数。请注意，当函数不递归时，这两个值是相同的，并且只打印单个数字。

profile 运行结束时，打印输出不是必须的。也可以通过为 run() 函数指定文件名，将结果保存到文件中：

import cProfile
import re
cProfile.run('re.compile("foo|bar")', 'restats')

pstats.Stats 类从文件中读取 profile 结果，并以各种方式对其进行格式化。

cProfile 和 profile 文件也可以作为脚本调用，以分析另一个脚本。例如：

python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)

-o 将profile 结果写入文件而不是标准输出

-s 指定 sort_stats() 排序值之一以对输出进行排序。这仅适用于未提供 -o 的情况

-m 指定要分析的是模块而不是脚本。

3.7 新版功能: cProfile 添加 -m 选项

3.8 新版功能: profile 添加 -m 选项

pstats 模块的 Stats 类具有各种方法用来操纵和打印保存到性能分析结果文件的数据。

import pstats
from pstats import SortKey
p = pstats.Stats('restats')
p.strip_dirs().sort_stats(-1).print_stats()

strip_dirs() 方法移除了所有模块名称中的多余路径。 sort_stats() 方法按照打印出来的标准模块/行/名称对所有条目进行排序。 print_stats() 方法打印出所有的统计数据。 你可以尝试下列排序调用:

p.sort_stats(SortKey.NAME)
p.print_stats()

第一个调用实际上将按函数名称对列表进行排序，而第二个调用将打印出统计数据。 下面是一些可以尝试的有趣调用:

p.sort_stats(SortKey.CUMULATIVE).print_stats(10)

这将按一个函数中的累计时间对性能分析数据进行排序，然后只打印出最重要的十行。 如果你了解哪些算法在耗费时间，上面这一行就是你应该使用的。

如果你想要看看哪些函数的循环次数多，且耗费时间长，你应当这样做:

p.sort_stats(SortKey.TIME).print_stats(10)

以按照每个函数耗费的时间进行排序，然后打印前十个函数的统计数据。

你也可以尝试：

p.sort_stats(SortKey.FILENAME).print_stats('__init__')

这将按照文件名对所有统计数据进行排序，然后只打印出类初始化方法的统计数据 (因为它们的名称中都有 __init__)。 作为最后一个例子，你可以尝试:

p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init')

这一行以时间为主键，并以累计时间为次键进行排序，然后打印出部分统计数据。 具体来说，该列表首先被缩减至原始大小的 50% (即: .5)，然后只保留包含 init 的行，并打印该子列表。

如果你想知道有哪些函数调用了上述函数，你现在就可以做 (p 仍然会按照最后一个标准进行排序):

p.print_callers(.5, 'init')

这样你将得到每个被列出的函数的调用方列表。

如果你想要更多的功能，你就必须阅读手册，或者自行猜测下列函数的作用:

p.print_callees()
p.add('restats')

作为脚本被唤起，pstats 模块是一个用于读取和性能分析转储文件的统计数据浏览器。 它有一个简单的面向行的界面（使用 cmd 实现）和交互式的帮助。

profile 和 cProfile 模块参考

profile 和 cProfile 模块都提供下列函数：

profile.run(command, filename=None, sort=- 1)

此函数接受一个可被传递给 exec() 函数的单独参数，以及一个可选的文件名。 在所有情况下这个例程都会执行:

exec(command, __main__.__dict__, __main__.__dict__)

并收集执行过程中的性能分析统计数据。 如果未提供文件名，则此函数会自动创建一个 Stats 实例并打印一个简单的性能分析报告。 如果指定了 sort 值，则它会被传递给这个 Stats 实例以控制结果的排序方式。

profile.runctx(command, globals, locals, filename=None, sort=- 1)

此函数类似于 run()，带有为 command 字符串提供全局和局部字典的附加参数。 这个例程会执行:

exec(command, globals, locals)

并像在上述的 run() 函数中一样收集性能分析数据。

class profile.Profile(timer=None, timeunit=0.0, subcalls=True, builtins=True)

这个类通常只在需要比 cProfile.run() 函数所能提供的更精确的性能分析控制时被使用。

可以通过 timer 参数提供一个自定义计时器来测量代码运行花费了多长时间。 它必须是一个返回代表当前时间的单个数字的函数。 如果该数字为整数，则 timeunit 指定一个表示每个时间单位持续时间的乘数。 例如，如果定时器返回以千秒为计量单位的时间值，则时间单位将为 .001。

直接使用 Profile 类将允许格式化性能分析结果而无需将性能分析数据写入到文件:

import cProfile, pstats, io
from pstats import SortKey
pr = cProfile.Profile()
pr.enable()
# ... do something ...
pr.disable()
s = io.StringIO()
sortby = SortKey.CUMULATIVE
ps = pstats.Stats(pr, stream=s).sort_stats(sortby)
ps.print_stats()
print(s.getvalue())

Profile 类也可作为上下文管理器使用 (仅在 cProfile 模块中支持。 参见 上下文管理器类型):

import cProfile

with cProfile.Profile() as pr:
    # ... do something ...

    pr.print_stats()

在 3.8 版更改: 添加了上下文管理器支持。

enable()

开始收集分析数据。仅在 cProfile 可用。

disable()

停止收集分析数据。仅在 cProfile 可用。

create_stats()

停止收集分析数据，并在内部将结果记录为当前 profile。

print_stats(sort=- 1)

根据当前性能分析数据创建一个 Stats 对象并将结果打印到 stdout。

dump_stats(filename)

将当前profile 的结果写入 filename 。

run(cmd)

通过 exec() 对该命令进行性能分析。

runctx(cmd, globals, locals)

通过 exec() 并附带指定的全局和局部环境对该命令进行性能分析。

runcall(func, /, *args, **kwargs)

对 func(*args, **kwargs) 进行性能分析

请注意性能分析只有在被调用的命令/函数确实能返回时才可用。 如果解释器被终结（例如在被调用的命令/函数执行期间通过 sys.exit() 调用）则将不会打印性能分析结果。

Stats 类

性能数据的分析是使用 Stats 类来完成的。

class pstats.Stats(*filenames or profile, stream=sys.stdout)

这个类构造器会基于 filename (或文件名列表) 或者 Profile 实例创建一个“统计对象”。 输出将被打印到由 stream 所指定的流。

上述构造器所选择的文件必须由相应版本的 profile 或 cProfile 来创建。 具体来说，不会 保证文件与此性能分析器的未来版本兼容，也不会保证与其他性能分析器，或运行于不同操作系统的同一性能分析器所产生的文件兼容。 如果提供了几个文件，则相同函数的所有统计数据将被聚合在一起，这样就可以在单个报告中同时考虑几个进程的总体情况。 如果额外的文件需要与现有 Stats 对象中的数据相结合，则可以使用 add() 方法。

作为从一个文件读取性能分析数据的替代，可以使用 cProfile.Profile 或 profile.Profile 对象作为性能分析数据源。

Stats 对象有以下方法:

strip_dirs()

这个用于 Stats 类的方法会从文件名中去除所有前导路径信息。 它对于减少打印输出的大小以适应（接近） 80 列限制。 这个方法会修改对象，被去除的信息将会丢失。 在执行去除操作后，可以认为对象拥有的条目将使用“随机”顺序，就像它刚在对象初始化并加载之后一样。 如果 strip_dirs() 导致两个函数名变得无法区分（它们位于相同文件名的相同行，并且具有相同的函数名），那么这两个条目的统计数据将被累积到单个条目中。

add(*filenames)

Stats 类的这个方法会将额外的性能分析信息累积到当前的性能分析对象中。 它的参数应当指向由相应版本的 profile.run() 或 cProfile.run() 所创建的文件名。 相同名称（包括 file, line, name）函数的统计信息会自动累积到单个函数的统计信息。

dump_stats(filename)

将加载至 Stats 对象内的数据保存到名为 filename 的文件。 该文件如果不存在则将被创建，如果已存在则将被覆盖。 这等价于 profile.Profile 和 cProfile.Profile 类上的同名方法。

sort_stats(*keys)

此方法通过根据所提供的准则修改 Stats 对象的排序。 其参数可以是一个字符串或标识排序准则的 SortKey 枚举 (例如: 'time', 'name', SortKey.TIME 或 SortKey.NAME)。 SortKey 枚举参数优于字符串参数因为它更为健壮且更不容易出错。

当提供一个以上的键时，额外的键将在之前选择的所有键的值相等时被用作次级准则。 例如，sort_stats(SortKey.NAME, SortKey.FILE) 将根据其函数名对所有条目排序，并通过按文件名排序来处理所有平局（即函数名相同）。

对于字符串参数，可以对任何键名使用缩写形式，只要缩写是无歧义的。

以下是有效的字符串和 SortKey:

有效字符串参数 | 有效枚举参数 | 含意
'calls' | SortKey.CALLS | 调用次数
'cumulative' | SortKey.CUMULATIVE | 累积时间
'cumtime' | N/A | 累积时间
'file' | N/A | 文件名
'filename' | SortKey.FILENAME | 文件名
'module' | N/A | 文件名
'ncalls' | N/A | 调用次数
'pcalls' | SortKey.PCALLS | 原始调用计数
'line' | SortKey.LINE | 行号
'name' | SortKey.NAME | 函数名称
'nfl' | SortKey.NFL | 名称/文件/行
'stdname' | SortKey.STDNAME | 标准名称
'time' | SortKey.TIME | 内部时间
'tottime' | N/A | 内部时间

请注意对统计信息的所有排序都是降序的（将最耗时的条目放在最前面），其中名称、文件和行号搜索则是升序的（字母顺序）。 SortKey.NFL 和 SortKey.STDNAME 之间的细微区别在于标准名称是按打印形式来排序名称的，这意味着嵌入的行号将以一种怪异的方式进行比较。 例如，第 3, 20 和 40 行将会按字符串顺序 20, 3 和 40 显示（如果文件名相同的话）。 相反地，SortKey.NFL 则会对行号进行数值比较。 实际上，sort_stats(SortKey.NFL) 就等同于 sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE)。

出于向下兼容的理由，数值参数 -1, 0, 1 和 2 也是被允许的。 它们将被分别解读为 'stdname', 'calls', 'time' 和 'cumulative'。 如果使用这种老旧格式（数值），则将只使用一个排序键（数字键），额外的参数将被静默地忽略。

3.7 新版功能: 增加了 SortKey 枚举。

reverse_order()

这个用于 Stats 类的方法将会反转对象内基本列表的顺序。 请注意在默认情况下升序和降序排列将基于所选定的排序键来进行适当的选择。

print_stats(*restrictions)

这个用于 Stats 类的方法将打印出在 profile.run() 定义中描述的报告。

打印的顺序是基于在对象上执行的最后一次 sort_stats() 操作（需要注意 add() 和 strip_dirs() 规则）。

所提供的参数（如果存在）可被用来将列表限制为重要的条目。 在初始状态下，列表将为加入性能分析的函数的完整集合。 每条限制可以是一个整数（用来选择行数），或是一个 0.0 至 1.0 范围内左开右闭的十进制小数（用来选择行数百分比），或是一个将被解读为正则表达式的字符串（用来匹配要打印的标准名称的模式）。 如果提供了多条限制，则它们将逐个被应用。 例如:

print_stats(.1, 'foo:')

将首先限制为打印列表的前 10%，然后再限制为仅打印在名为 .*foo: 的文件内的函数。 作为对比，以下命令:

print_stats('foo:', .1)

将列表限制为名为 .*foo: 的文件内的所有函数，然后再限制为仅打印它们当中的前 10%。

print_callers(*restrictions)

这个用于 Stats 类的方法将打印调用了加入性能分析数据库的每个函数的所有函数的列表。 打印顺序与 print_stats() 所提供的相同，受限参数的定义也是相同的。 每个调用方将在单独的行中报告。 具体格式根据产生统计数据的性能分析器的不同而有所差异。

使用 profile 时，将在每个调用方之后的圆括号内显示一个数字来指明相应的调用执行了多少次。 为了方便起见，右侧还有第二个不带圆括号的数字来重复显示该函数累计耗费的时间。

使用 cProfile 时，每个调用方前面将有三个数字：这个调用的执行次数，以及当前函数在被这个调用方唤起期间共计和累计耗费的时间。

print_callees(*restrictions)

这个用于 Stats 类的方法将打印被指定的函数所调用的所有函数的列表。 除了调用方向是逆序的（对应：被调用和被调用方），其参数和顺序与 print_callers() 方法相同。

get_stats_profile()

此方法返回一个 StatsProfile 的实例，它包含从函数名称到 FunctionProfile 实例的映射。 每个 FunctionProfile 实例保存了相应函数性能分析的有关信息如函数运行耗费了多长时间，它被调用了多少次等等……

3.9 新版功能: 添加了以下数据类: StatsProfile, FunctionProfile。 添加了以下函数: get_stats_profile。

什么是确定性性能分析？

确定性性能分析 旨在反映这样一个事实：即所有 函数调用 、 函数返回 和 异常 事件都被监控，并且对这些事件之间的间隔（在此期间用户的代码正在执行）进行精确计时。相反，统计分析（不是由该模块完成）随机采样有效指令指针，并推断时间花费在哪里。后一种技术传统上涉及较少的开销（因为代码不需要检测），但只提供了时间花在哪里的相对指示。

在Python中，由于在执行过程中总有一个活动的解释器，因此执行确定性评测不需要插入指令的代码。Python 自动为每个事件提供一个 钩子 （可选回调）。此外，Python 的解释特性往往会给执行增加太多开销，以至于在典型的应用程序中，确定性分析往往只会增加很小的处理开销。结果是，确定性分析并没有那么代价高昂，但是它提供了有关 Python 程序执行的大量运行时统计信息。

调用计数统计信息可用于识别代码中的错误（意外计数），并识别可能的内联扩展点（高频调用）。内部时间统计可用于识别应仔细优化的 "热循环" 。累积时间统计可用于识别算法选择上的高级别错误。请注意，该分析器中对累积时间的异常处理，允许直接比较算法的递归实现与迭代实现的统计信息。

局限性

一个限制是关于时间信息的准确性。确定性性能分析存在一个涉及精度的基本问题。最明显的限制是，底层的 "时钟" 周期大约为0.001秒（通常）。因此，没有什么测量会比底层时钟更精确。如果进行了足够的测量，那么 "误差" 将趋于平均。不幸的是，删除第一个错误会导致第二个错误来源。

第二个问题是，从调度事件到分析器调用获取时间函数实际 获取 时钟状态，这需要 "一段时间" 。类似地，从获取时钟值（然后保存）开始，直到再次执行用户代码为止，退出分析器事件句柄时也存在一定的延迟。因此，多次调用单个函数或调用多个函数通常会累积此错误。尽管这种方式的误差通常小于时钟的精度（小于一个时钟周期），但它 可以 累积并变得非常可观。

与开销较低的 cProfile 相比， profile 的问题更为严重。出于这个原因， profile 提供了一种针对指定平台的自我校准方法，以便可以在很大程度上（平均地）消除此误差。 校准后，结果将更准确（在最小二乘意义上），但它有时会产生负数（当调用计数异常低，且概率之神对您不利时：-）。因此 不要 对产生的负数感到惊慌。它们应该只在你手工校准分析器的情况下才会出现，实际上结果比没有校准的情况要好。

准确估量

profile 模块的 profiler 会从每个事件处理时间中减去一个常量，以补偿调用 time 函数和存储结果的开销。默认情况下，常数为0。对于特定的平台，可用以下程序获得更好修正常数（ 局限性 ）。

import profile
pr = profile.Profile()
for i in range(5):
    print(pr.calibrate(10000))

此方法将执行由参数所给定次数的 Python 调用，在性能分析器之下直接和再次地执行，并对两次执行计时。 它将随后计算每个性能分析器事件的隐藏开销，并将其以浮点数的形式返回。 例如，在一台运行 macOS 的 1.8Ghz Intel Core i5 上，使用 Python 的 time.process_time() 作为计时器，魔数大约为 4.04e-6。

此操作的目标是获得一个相当稳定的结果。 如果你的计算机 非常 快速，或者你的计时器函数的分辨率很差，你可能必须传入 100000，甚至 1000000，才能得到稳定的结果。

当你有一个一致的答案时，有三种方法可以使用：

import profile

# 1. Apply computed bias to all Profile instances created hereafter.
profile.Profile.bias = your_computed_bias

# 2. Apply computed bias to a specific Profile instance.
pr = profile.Profile()
pr.bias = your_computed_bias

# 3. Specify computed bias in instance constructor.
pr = profile.Profile(bias=your_computed_bias)

如果你可以选择，那么选择更小的常量会更好，这样你的结果将“更不容易”在性能分析统计中显示负值。

使用自定义计时器

如果你想要改变当前时间的确定方式（例如，强制使用时钟时间或进程持续时间），请向 Profile 类构造器传入你想要的计时函数:

pr = profile.Profile(your_time_func)

结果性能分析器将随后调用 your_time_func。 根据你使用的是 profile.Profile 还是 cProfile.Profile，your_time_func 的返回值将有不同的解读方式:

profile.Profile

your_time_func 应当返回一个数字，或一个总和为当前时间的数字列表（如同 os.times() 所返回的内容）。 如果该函数返回一个数字，或所返回的数字列表长度为 2，则你将得到一个特别快速的调度例程版本。

请注意你应当为你选择的计时器函数校准性能分析器类 (参见 准确估量)。 对于大多数机器来说，一个返回长整数值的计时器在性能分析期间将提供在低开销方面的最佳结果。 (os.times() 是 相当 糟糕的，因为它返回一个浮点数值的元组)。 如果你想以最干净的方式替换一个更好的计时器，请派生一个类并硬连线一个能最佳地处理计时器调用的替换调度方法，并使用适当的校准常量。

cProfile.Profile

your_time_func 应当返回一个数字。 如果它返回整数，你还可以通过第二个参数指定一个单位时间的实际持续长度来唤起类构造器。 举例来说，如果 your_integer_time_func 返回以千秒为单位的时间，则你应当以如下方式构造 Profile 实例:

pr = cProfile.Profile(your_integer_time_func, 0.001)

由于 cProfile.Profile 类无法被校准，因此自定义计时器函数应当要小心地使用并应当尽可能地快速。 为了使自定义计时器获得最佳结果，可能需要在内部 _lsprof 模块的 C 源代码中对其进行硬编码。

Python 3.3 在 time 中添加了几个可被用来精确测量进程或时钟时间的新函数。 例如，参见 time.perf_counter()。

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

源码： Lib/timeit.py [https://github.com/python/cpython/tree/3.10/Lib/timeit.py]

此模块提供了一种简单的方法来计算一小段 Python 代码的耗时。 它有 命令行接口 以及一个 可调用 方法。 它避免了许多测量时间的常见陷阱。 另见 Tim Peter 在 O'Reilly 出版的 Python Cookbook 第二版中“算法”章节的概述。

基本示例

以下示例显示了如何使用 命令行接口 来比较三个不同的表达式：

$ python3 -m timeit '"-".join(str(n) for n in range(100))'
10000 loops, best of 5: 30.2 usec per loop
$ python3 -m timeit '"-".join([str(n) for n in range(100)])'
10000 loops, best of 5: 27.5 usec per loop
$ python3 -m timeit '"-".join(map(str, range(100)))'
10000 loops, best of 5: 23.2 usec per loop

这可以通过 Python 接口 实现

>>> 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

从 Python 接口 还可以传出一个可调用对象:

>>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000)
0.19665591977536678

但请注意 timeit() 仅在使用命令行界面时会自动确定重复次数。 在 例子 一节你可以找到更多的进阶示例。

Python 接口

该模块定义了三个便利函数和一个公共类：

timeit.timeit(stmt='pass', setup='pass', timer=<default timer>, number=1000000, globals=None)

使用给定语句、 setup 代码和 timer 函数创建一个 Timer 实例，并执行 number 次其 timeit() 方法。可选的 globals 参数指定用于执行代码的命名空间。

在 3.5 版更改: 添加可选参数 globals 。

timeit.repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)

使用给定语句、 setup 代码和 timer 函数创建一个 Timer 实例，并使用给定的 repeat 计数和 number 执行运行其 repeat() 方法。可选的 globals 参数指定用于执行代码的命名空间。

在 3.5 版更改: 添加可选参数 globals 。

在 3.7 版更改: repeat 的默认值由 3 更改为 5 。

timeit.default_timer()

默认的计时器，总是 time.perf_counter() 。

在 3.3 版更改: time.perf_counter() 现在是默认计时器。

class timeit.Timer(stmt='pass', setup='pass', timer=<timer function>, globals=None)

用于小代码片段的计数执行速度的类。

构造函数接受一个将计时的语句、一个用于设置的附加语句和一个定时器函数。两个语句都默认为 'pass' ；计时器函数与平台有关（请参阅模块文档字符串）。 stmt 和 setup 也可能包含多个以 ; 或换行符分隔的语句，只要它们不包含多行字符串文字即可。该语句默认在 timeit 的命名空间内执行；可以通过将命名空间传递给 globals 来控制此行为。

要测量第一个语句的执行时间，请使用 timeit() 方法。 repeat() 和 autorange() 方法是方便的方法来调用 timeit() 多次。

setup 的执行时间从总体计时执行中排除。

stmt 和 setup 参数也可以使用不带参数的可调用对象。这将在一个计时器函数中嵌入对它们的调用，然后由 timeit() 执行。请注意，由于额外的函数调用，在这种情况下，计时开销会略大一些。

在 3.5 版更改: 添加可选参数 globals 。

timeit(number=1000000)

执行 number 次主要语句。这将执行一次 setup 语句，然后返回执行主语句多次所需的时间，以秒为单位测量为浮点数。参数是通过循环的次数，默认为一百万。要使用的主语句、 setup 语句和 timer 函数将传递给构造函数。

注解

默认情况下， timeit() 暂时关闭 garbage collection 。这种方法的优点在于它使独立时序更具可比性。缺点是GC可能是所测量功能性能的重要组成部分。如果是这样，可以在 setup 字符串中的第一个语句重新启用GC。例如:

timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit()

autorange(callback=None)

自动决定调用多少次 timeit() 。

这是一个便利函数，它反复调用 timeit() ，以便总时间 >= 0.2 秒，返回最终（循环次数，循环所用的时间）。它调用 timeit() 的次数以序列 1, 2, 5, 10, 20, 50, ... 递增，直到所用的时间至少为0.2秒。

如果给出 callback 并且不是 None ，则在每次试验后将使用两个参数调用它： callback(number, time_taken) 。

3.6 新版功能.

repeat(repeat=5, number=1000000)

调用 timeit() 几次。

这是一个方便的函数，它反复调用 timeit() ，返回结果列表。第一个参数指定调用 timeit() 的次数。第二个参数指定 timeit() 的 number 参数。

注解

从结果向量计算并报告平均值和标准差这些是很诱人的。但是，这不是很有用。在典型情况下，最低值给出了机器运行给定代码段的速度的下限；结果向量中较高的值通常不是由Python的速度变化引起的，而是由于其他过程干扰你的计时准确性。所以结果的 min() 可能是你应该感兴趣的唯一数字。之后，你应该看看整个向量并应用常识而不是统计。

在 3.7 版更改: repeat 的默认值由 3 更改为 5 。

print_exc(file=None)

帮助程序从计时代码中打印回溯。

典型使用:

t = Timer(...)       # outside the try/except
try:
    t.timeit(...)    # or t.repeat(...)
except Exception:
    t.print_exc()

与标准回溯相比，优势在于将显示已编译模板中的源行。可选的 file 参数指向发送回溯的位置；它默认为 sys.stderr 。

命令行接口

从命令行调用程序时，使用以下表单:

python -m timeit [-n N] [-r N] [-u U] [-s S] [-h] [statement ...]

如果了解以下选项：

-n N, --number=N

执行 '语句' 多少次

-r N, --repeat=N

重复计时器的次数（默认为5）

-s S, --setup=S

最初要执行一次的语句（默认为 pass ）

-p, --process

测量进程时间，而不是 wallclock 时间，使用 time.process_time() 而不是 time.perf_counter() ，这是默认值

3.3 新版功能.

-u, --unit=U

指定定时器输出的时间单位；可以选择 nsec，usec，msec或sec

3.5 新版功能.

-v, --verbose

打印原始计时结果；重复更多位数精度

-h, --help

打印一条简短的使用信息并退出

可以通过将每一行指定为单独的语句参数来给出多行语句；通过在引号中包含参数并使用前导空格可以缩进行。多个 -s 选项的处理方式相似。

如果未给出 -n，则会通过尝试按序列 1, 2, 5, 10, 20, 50, ... 递增的数值来计算合适的循环次数，直到总计时间至少为 0.2 秒。

default_timer() 测量可能受到在同一台机器上运行的其他程序的影响，因此在需要精确计时时最好的做法是重复几次计时并使用最佳时间。 -r 选项对此有利；在大多数情况下，默认的 5 次重复可能就足够了。 你可以使用 time.process_time() 来测量CPU时间。

注解

执行 pass 语句会产生一定的基线开销。这里的代码不会试图隐藏它，但你应该知道它。可以通过不带参数调用程序来测量基线开销，并且Python版本之间可能会有所不同。

例子

可以提供一个在开头只执行一次的 setup 语句：

$ 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

在输出信息中，共有三个字段。 首先是 loop count，它告诉你每个计时循环重复运行了多少次语句体。 然后是 repetition count ('best of 5')，它告诉你计时循环重复了多少次，最后是语句体在计时循环重复中最好的平均耗时。 即最快一次重复的耗时除以循环计数。

>>> 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

使用 Timer 类及其方法可以完成同样的操作:

>>> 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]

以下示例显示如何计算包含多行的表达式。 在这里我们对比使用 hasattr() 与 try/except 的开销来测试缺失与提供对象属性:

$ 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

>>> import timeit
>>> # attribute is missing
>>> 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
>>>
>>> # attribute is present
>>> 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

要让 timeit 模块访问你定义的函数，你可以传递一个包含 import 语句的 setup 参数:

def test():
    """Stupid test function"""
    L = [i for i in range(100)]

if __name__ == '__main__':
    import timeit
    print(timeit.timeit("test()", setup="from __main__ import test"))

另一种选择是将 globals() 传递给 globals 参数，这将导致代码在当前的全局命名空间中执行。这比单独指定 import 更方便

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()))

trace —— 跟踪 Python 语句的执行

源代码 ： Lib/trace.py [https://github.com/python/cpython/tree/3.10/Lib/trace.py]

模块 trace 模块用于跟踪程序的执行过程，可生成带注释的语句覆盖率列表，打印调用/被调用关系，列出程序运行期间执行过的函数。该模块可在其他程序或命令行中使用。

参见

Coverage.py [https://coverage.readthedocs.io/]

流行的第三方代码覆盖工具，可输出 HTML ，并提供分支覆盖等高级功能。

命令行用法

trace 模块可由命令行调用。用法如此简单：

python -m trace --count -C . somefile.py ...

上述命令将执行 somefile.py ，并在当前目录生成执行期间所有已导入 Python 模块的带注解列表。

--help

显示用法并退出。

--version

显示模块版本并退出。

3.8 新版功能: 加入了 --module 选项，允许运行可执行模块。

主要的可选参数

在调用 trace 时，至少须指定以下可选参数之一。 -listfuncs 与 -trace 、 -count 相互排斥。如果给出 --listfuncs，就再不会接受 --count 和 --trace ，反之亦然。

-c, --count

在程序完成时生成一组带有注解的报表文件，显示每个语句被执行的次数。 参见下面的 -coverdir 、-file 和 -no-report。

-t, --trace

执行时显示每一行。

-l, --listfuncs

显示程序运行时执行到的函数。

-r, --report

由之前用了 --count 和 --file 运行的程序产生一个带有注解的报表。 不会执行代码。

-T, --trackcalls

显示程序运行时暴露出来的调用关系。

修饰器

-f, --file=<file>

用于累计多次跟踪运行计数的文件名。应与 --count 一起使用。

-C, --coverdir=<dir>

报表文件的所在目录。package.module 的覆盖率报表将被写入文件 dir/package/module.cover。

-m, --missing

生成带注解的报表时，用 >>>>>> 标记未执行的行。

-s, --summary

在用到 --count 或 --report 时，将每个文件的简短摘要输出到 stdout。

-R, --no-report

不生成带注解的报表。如果打算用 --count 执行多次运行，然后在最后产生一组带注解的报表，该选项就很有用。

-g, --timing

在每一行前面加上时间，自程序运行算起。只在跟踪时有用。

过滤器

以下参数可重复多次。

--ignore-module=<mod>

忽略给出的模块名及其子模块（若为包）。参数可为逗号分隔的名称列表。

--ignore-dir=<dir>

忽略指定目录及其子目录下的所有模块和包。参数可为 os.pathsep 分隔的目录列表。

编程接口

class 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 可以显示相对于跟踪开始时间的时间戳。

run(cmd)

执行命令，并根据当前跟踪参数从执行过程中收集统计数据。 cmd 必须为字符串或 code 对象，可供传入 exec()。

runctx(cmd, globals=None, locals=None)

在定义的全局和局部环境中，执行命令并收集当前跟踪参数下的执行统计数据。若没有定义 globals 和 locals ，则默认为空字典。

runfunc(func, /, *args, **kwds)

在 Trace 对象的控制下，用给定的参数调用 func，并采用当前的跟踪参数。

results()

返回一个 CoverageResults 对象，包含之前对指定 Trace 实例调用 run、runctx 和 runfunc 的累积结果。 累积的跟踪结果不会重置。

class trace.CoverageResults

存放代码覆盖结果的容器，由 Trace.results() 创建。用户不应直接去创建。

update(other)

从另一个 CoverageResults 对象中合并代码覆盖数据。

write_results(show_missing=True, summary=False, coverdir=None)

写入代码覆盖结果。设置 show_missing 可显示未命中的行。设置*summary* 可在输出中包含每个模块的覆盖率摘要信息。 coverdir 可指定覆盖率结果文件的输出目录，为 None 则结果将置于源文件所在目录中。

以下例子简单演示了编程接口的用法：

import sys
import trace

# create a Trace object, telling it what to ignore, and whether to
# do tracing or line-counting or both.
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# run the new command using the given tracer
tracer.run('main()')

# make a report, placing output in the current directory
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")

tracemalloc --- 跟踪内存分配

3.4 新版功能.

源代码： Lib/tracemalloc.py [https://github.com/python/cpython/tree/3.10/Lib/tracemalloc.py]

tracemalloc 模块是一个用于对 Python 已申请的内存块进行调试的工具。它能提供以下信息:

回溯对象分配内存的位置

按文件、按行统计python的内存块分配情况: 总大小、块的数量以及块平均大小。

对比两个内存快照的差异，以便排查内存泄漏

要追踪 Python 所分配的大部分内存块，模块应当通过将 PYTHONTRACEMALLOC 环境变量设置为 1，或是通过使用 -X tracemalloc 命令行选项来尽可能早地启动。 可以在运行时调用 tracemalloc.start() 函数来启动追踪 Python 内存分配。

在默认情况下，一个已分配内存块的追踪将只储存最新的帧 (1 帧)。 要要启动时储存 25 帧：将 PYTHONTRACEMALLOC 环境变量设为 25，或使用 -X tracemalloc=25 命令行选项。

例子

显示前10项

显示内存分配最多的10个文件：

import tracemalloc

tracemalloc.start()

# ... run your application ...

snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics('lineno')

print("[ Top 10 ]")
for stat in top_stats[:10]:
    print(stat)

Python测试套件的输出示例：

[ 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

我们可以看到 Python 从模块载入了 4855 KiB 数据（字节码和常量）并且 collections 模块分配了 244 KiB 来构建 namedtuple 类型。

更多选项，请参见 Snapshot.statistics()

计算差异

获取两个快照并显示差异：

import tracemalloc
tracemalloc.start()
# ... start your application ...

snapshot1 = tracemalloc.take_snapshot()
# ... call the function leaking memory ...
snapshot2 = tracemalloc.take_snapshot()

top_stats = snapshot2.compare_to(snapshot1, 'lineno')

print("[ Top 10 differences ]")
for stat in top_stats[:10]:
    print(stat)

运行 Python 测试套件的部分测试之前/之后的输出样例:

[ 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

我们可以看到 Python 已载入了 8173 KiB 模块数据（字节码和常量），并且这比测试之前，即保存前一个快照时载入的数据多出了 4428 KiB。 类似地， linecache 模块已缓存 940 KiB 的 Python 源代码至格式回溯中，即从前一个快照开始的所有数据。

如果系统空闲内存太少，可以使用 Snapshot.dump() 方法将快照写入磁盘来离线分析快照。 然后使用 Snapshot.load() 方法重载快照。

获取一个内存块的溯源

找出程序中最大内存块的溯源的代码:

import tracemalloc

# Store 25 frames
tracemalloc.start(25)

# ... run your application ...

snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics('traceback')

# pick the biggest memory block
stat = top_stats[0]
print("%s memory blocks: %.1f KiB" % (stat.count, stat.size / 1024))
for line in stat.traceback.format():
    print(line)

一段Python单元测试的输出案例(限制最大25层堆栈)

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)

我们可以看到大部分内存都被分配到 importlib 模块中以便从模块中加载数据（字节码和常量）: 870.1 KiB。 回溯位置是 importlib 最近加载数据的地方：在 doctest 模块的 import pdb 行。 如果加载了新模块则回溯可能发生改变。line of the. The traceback may change if a new module is loaded.

美化的 top

使用美化输出显示分配最多内存的 10 行的代码，忽略 <frozen importlib._bootstrap> 和 <unknown> 文件:

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()

# ... run your application ...

snapshot = tracemalloc.take_snapshot()
display_top(snapshot)

Python测试套件的输出示例：

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

更多选项，请参见 Snapshot.statistics()

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

以下代码通过创建一个包含数字的列表来低效率地计算总计值如 0 + 1 + 2 + ...。 该列表会临时消耗大量内存。 我们可以使用 get_traced_memory() 和 reset_peak() 来观察计算总计值之后的内存使用减少以及计算过程中的内存使用峰值:

import tracemalloc

tracemalloc.start()

# Example code: compute a sum with a large temporary list
large_sum = sum(list(range(100000)))

first_size, first_peak = tracemalloc.get_traced_memory()

tracemalloc.reset_peak()

# Example code: compute a sum with a small temporary list
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=}")

输出:

first_size=664, first_peak=3592984
second_size=804, second_peak=29704

使用 reset_peak() 将确保我们能够准确地记录 small_sum 计算期间的峰值，即使它远小于从 start() 调用以来内存块的总体峰值大小。 如果没有对 reset_peak() 的调用，second_peak 将仍为计算 large_sum 时的峰值 (也就是说，等于 first_peak)。 在这种情况下，两个峰值都将比最终的内存使用量高得多，这表明我们可以进行优化 (通过移除不必要的对 list 的调用，并改写为 sum(range(...)))。

API

函数

tracemalloc.clear_traces()

清空 Python 所分配的内存块的追踪数据。

另见 stop().

tracemalloc.get_object_traceback(obj)

获取 Python 对象 obj 被分配位置的回溯。 返回一个 Traceback 实例，或者如果 tracemalloc 模块未追踪任何内存分配或未追踪该对象的分配则返回 None。

另请参阅 gc.get_referrers() 和 sys.getsizeof() 函数。

tracemalloc.get_traceback_limit()

获取保存在一个追踪的回溯中的最大帧数。

tracemalloc 模块必须正在追踪内存分配才能获得该限制值，否则将引发异常。

该限制是由 start() 函数设置的。

tracemalloc.get_traced_memory()

获取一个元组形式的由 tracemalloc 模块所追踪的内存块的当前大小和峰值大小: (current: int, peak: int)。

tracemalloc.reset_peak()

将由 tracemalloc 模块所追踪的内存块的峰值大小设置为当前大小。

如果 tracemalloc 模块未在追踪内存分配则不做任何事。

此函数只修改已记录的峰值大小，而不会修改或清空任何追踪，这不同于 clear_traces()。 在调用 reset_peak() 之前使用 take_snapshot() 保存的快照可以与调用之后保存的快照进行有意义的比较。

另请参阅 get_traced_memory()。

3.9 新版功能.

tracemalloc.get_tracemalloc_memory()

获取 tracemalloc 模块用于保存内存块追踪所使用的内存字节数。 返回一个 int。

tracemalloc.is_tracing()

如果 tracemalloc 模块正在追踪 Python 内存分配则返回 True，否则返回 False。

另请参阅 start() 和 stop() 函数。

tracemalloc.start(nframe: int = 1)

开始追踪 Python 内存分配：在 Python 内存分配器上安装钩子。 收集的追踪回溯将被限制为 nframe 个帧。 在默认情况下，一个内存块的追踪将只保存最近的帧：即限制为 1。 nframe 必须大于等于 1。

你仍然可以通过访问 Traceback.total_nframe 属性来读取组成回溯的原始总帧数。

保存 1 帧以上仅适用于计算由 'traceback' 分组的统计数据或计算累积的统计数据：请参阅 Snapshot.compare_to() 和 Snapshot.statistics() 方法。

保存更多帧会增加 tracemalloc 模块的内存和 CPU 开销。 请使用 get_tracemalloc_memory() 函数来检测 tracemalloc 模块消耗了多少内存。

PYTHONTRACEMALLOC 环境变量 (PYTHONTRACEMALLOC=NFRAME) 和 -X tracemalloc=NFRAME 命令行选项可被用来在启动时开始追踪。

另请参阅 stop(), is_tracing() 和 get_traceback_limit() 等函数。

tracemalloc.stop()

停止追踪 Python 内存分配：卸载 Python 内存分配器上的钩子。 并清空之前收集的所有由 Python 分配的内存块的追踪。

调用 take_snapshot() 函数在清空追踪之前保存它们的快照。

另请参阅 start(), is_tracing() 和 clear_traces() 等函数。

tracemalloc.take_snapshot()

保存一个由 Python 分配的内存块的追踪的快照。 返回一个新的 Snapshot 实例。

该快照不包括在 tracemalloc 模块开始追踪内存分配之前分配的内存块。

追踪的回溯被限制为 get_traceback_limit() 个帧。 可使用 start() 函数的 nframe 形参来保存更多的帧。

tracemalloc 模块必须正在追踪内存分配才能保存快照，参见 start() 函数。

另请参阅 get_object_traceback() 函数。

域过滤器

class tracemalloc.DomainFilter(inclusive: bool, domain: int)

按地址空间（域）来过滤内存块的追踪。

3.6 新版功能.

inclusive

如果 inclusive 为 True (包括)，则匹配分配于地址空间 domain 中的内存块。

如果 inclusive 为 False (排除)，则匹配不是分配于地址空间 domain 中的内存块。

domain

内存块的地址空间 (int)。 只读的特征属性。 Read-only property.

过滤器

class tracemalloc.Filter(inclusive: bool, filename_pattern: str, lineno: int = None, all_frames: bool = False, domain: int = None)

对内存块的跟踪进行筛选。

请参阅 fnmatch.fnmatch() 函数来了解 filename_pattern 的语法。 '.pyc' 文件扩展名以 '.py' 替换。

示例：

Filter(True, subprocess.__file__) 只包括 subprocess 模块的追踪数据

Filter(False, tracemalloc.__file__) 排除了 tracemalloc 模块的追踪数据

Filter(False, "<unknown>") 排除了空的回溯信息

在 3.5 版更改: '.pyo' 文件扩展名不会再被替换为 '.py'。

在 3.6 版更改: 增加了 domain 属性。

domain

内存块的地址空间 (int 或 None)。

tracemalloc 使用 0 号域来追踪 Python 的内存分配操作。 C 扩展可以使用其他域来追踪其他资源。extensions can use other domains to trace other resources.

inclusive

如果 inclusive 为 True (包括)，则只匹配名称与 filename_pattern 匹配的文件在行号为 lineno 的位置上分配的内存块。

如果 inclusive 为 False (排除)，则忽略名称与 filename_pattern 匹配的文件在行号为 lineno 的位置上分配的内存块。

lineno

过滤器的行号 (int)。 如果 lineno 为 None，则该过滤器将匹配任意行号。

filename_pattern

过滤器的文件名模型 (str)。 只读的特征属性。

all_frames

如果 all_frames 为 True，则回溯的所有帧都会被检查。 如果 all_frames 为 False，则只有最近的帧会被检查。

如果回溯限制为 1 则该属性将没有效果。 参见 get_traceback_limit() 函数和 Snapshot.traceback_limit 属性。

帧

class tracemalloc.Frame

回溯的帧。

Traceback 类是一个 Frame 实例的序列。instances.

filename

文件名（字符串）

lineno

行号（整形）

快照

class tracemalloc.Snapshot

由 Python 分配的内存块的追踪的快照。

take_snapshot() 函数创建一个快照实例。

compare_to(old_snapshot: Snapshot, key_type: str, cumulative: bool = False)

计算与某个旧快照的差异。 获取按 key_type 分组的 StatisticDiff 实例的已排序列表形式的统计信息。

请参阅 Snapshot.statistics() 方法了解 key_type 和 cumulative 形参。

结果将按以下值从大到小排序: StatisticDiff.size_diff 的绝对值, StatisticDiff.size, StatisticDiff.count_diff 的绝对值, Statistic.count 然后是 StatisticDiff.traceback。

dump(filename)

将快照写入文件

使用 load() 重载快照。

filter_traces(filters)

使用已过滤的 traces 序列新建一个 Snapshot 实例，filters 是 DomainFilter 和 Filter 实例的列表。 如果 filters 为空列表，则返回一个包含追踪的副本的新的 Snapshot 实例。

包括的所有过滤器将同时被应用，一个追踪如果没有任何包括的过滤器与其匹配则会被忽略。 一个追踪如果有至少一个排除的过滤器与其匹配将会被忽略。

在 3.6 版更改: DomainFilter 实例现在同样被 filters 所接受。

classmethod load(filename)

从文件载入快照。

另见 dump().

statistics(key_type: str, cumulative: bool = False)

获取 Statistic 信息列表，按 key_type 分组排序：

key_type | description
'filename' | 文件名
'lineno' | 文件名和行号
'traceback' | 回溯

如果 cumulative 为 True，则累积一个追踪的回溯的所有帧的内存块的大小和数量，而不只是最近的帧。 累积模式只能在 key_type 等于 'filename' 和 'lineno' 的情况下使用。

结果将按以下值从大到小排序: Statistic.size, Statistic.count 然后是 Statistic.traceback。

traceback_limit

保存在 traces 的回溯中的帧的最大数量：当快照被保存时 get_traceback_limit() 的结果。

traces

由 Python 分配的所有内存块的追踪: Trace 实例的序列。

该序列的顺序是未定义的。 请使用 Snapshot.statistics() 方法来获取统计信息的已排序列表。

统计

class tracemalloc.Statistic

统计内存分配

Snapshot.statistics() 返回 Statistic 实例的列表。.

参见 StatisticDiff 类。

count

内存块数（整形）。

size

以字节数表示的内存块总计大小 (int)。

traceback

内存块分配位置的回溯，Traceback 实例。

StatisticDiff

class tracemalloc.StatisticDiff

在旧的和新的 Snapshot 实例之间内存分配上的统计差异。

Snapshot.compare_to() 返回一个 StatisticDiff 实例的列表。 另请参看 Statistic 类。

count

新快照中的内存块数量 (int): 如果在新快照中内存块已被释放则为 0。

count_diff

在旧的新的快照之间内存块数量之差 (int): 如果在新快照中内存块已被分配则为 0。

size

新快速中以字节数表示的内存块总计大小 (int): 如果在新快照中内存块已被释放则为 0。

size_diff

在旧的新的快照之间以字节数表示的内存块总计大小之差 (int): 如果在新快照中内存块已被分配则为 0。

traceback

内存块分配位置的回溯，Traceback 实例。

跟踪

class tracemalloc.Trace

一个内存块的跟踪信息。

Snapshot.traces 属性是一个 Trace 实例的序列。

在 3.6 版更改: 增加了 domain 属性。

domain

内存块的地址空间 (int)。 只读的特征属性。 Read-only property.

tracemalloc 使用 0 号域来追踪 Python 的内存分配操作。 C 扩展可以使用其他域来追踪其他资源。extensions can use other domains to trace other resources.

size

以字节数表示的内存块大小 (int)。

traceback

内存块分配位置的回溯，Traceback 实例。

回溯

class tracemalloc.Traceback

Frame 实例的序列将按从最旧的帧到最新的帧排序。

一个回溯包含至少 1 个帧。 如果 tracemalloc 模块无法获取帧，则会使用文件名 "<unknown>" 和行号 0。

当保存一个快照时，追踪的回溯被限制为 get_traceback_limit() 个帧。 参见 take_snapshot() 函数。 回溯的原始帧数存放在 Traceback.total_nframe 属性中。 这可以让人了解一个回溯是否因回溯限制而被截断。

Trace.traceback 属性是一个 Traceback 对象的实例。

在 3.7 版更改: 现在帧的排序是从最旧到最新，而不是从最新到最旧。

total_nframe

在截断之前组成回溯的总帧数。 如果此信息不可用则该属性可被设为 None。

在 3.9 版更改: 增加了 Traceback.total_nframe 属性。

format(limit=None, most_recent_first=False)

将回溯格式化为由行组成的列表。 使用 linecache 模块从源代码提取行。 如果设置了 limit，则当 limit 为正值时将格式化 limit 个最新的帧。 在其他情况下，则格式化 abs(limit) 个最新的帧。 如果 most_recent_first 为 True，则将反转已格式化帧的顺序，首先返回最新的帧而不是最旧的。

类似于 traceback.format_tb() 函数，不同之处是 format() 不包括换行符。

示例:

print("Traceback (most recent call first):")
for line in traceback:
    print(line)

输出:

Traceback (most recent call first):
  File "test.py", line 9
    obj = Object()
  File "test.py", line 12
    tb = tracemalloc.get_object_traceback(f())

软件打包和分发

这些库可帮助你发布和安装 Python 软件。 虽然这些模块设计为与 Python 包索引 [https://pypi.org] 结合使用，但它们也可以与本地索引服务器一起使用，或者根本不使用任何索引服务器。

distutils 构建和安装 Python 模块

ensurepip --- 引导 pip 安装器

命令行界面

模块 API

venv --- 创建虚拟环境

创建虚拟环境

虚拟环境是如何实现的

API

一个扩展 EnvBuilder 的例子

zipapp —— 管理可执行的 Python zip 打包文件

简单示例

命令行接口

Python API

例子

指定解释器程序

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

制作 Windows 可执行文件

注意事项

Python 打包应用程序的格式

distutils 构建和安装 Python 模块

distutils 计划在 Python 3.12 版本中移除，有关详细信息，请参阅 模块的变化 条目。

distutils 提供了对于构建和安装 Python 包的支持。新模块可以是由 100%-纯 Python 代码写成的，也可以是用 C 写成的扩展模块，甚至可以同时包括 Python 和 C。

大多数 Python 用户 不会 想要直接使用这个包，而是使用 Python 包官方维护的跨版本工具。特别地， setuptools [https://setuptools.readthedocs.io/en/latest/] 是一个对于 distutils 的增强选项，它能提供：

对声明项目依赖的支持

额外的用于配置哪些文件包含在源代码发布中的机制（包括与版本控制系统集成需要的插件）

生成项目“进入点”的能力，进入点可用作应用插件系统的基础

自动在安装时间生成 Windows 命令行可执行文件的能力，而不是需要预编译它们

跨所有受支持的 Python 版本上的一致的表现

推荐的 pip [https://pip.pypa.io/] 安装器用 setuptools 运行所有的 setup.py 脚本，即使脚本本身只引了 distutils 包。参考 Python Packaging User Guide [https://packaging.python.org]  获得更多信息。

为了打包工具的作者和用户能更好理解当前的打包和分发系统，遗留的基于 distutils 的用户文档和 API 参考保持可用：

安装Python模块（旧版）

分发 Python 模块（遗留版本）

ensurepip --- 引导 pip 安装器

3.4 新版功能.

源代码: Lib/ensurepip [https://github.com/python/cpython/tree/3.10/Lib/ensurepip]

ensurepip 包为在已有的Python安装实例或虚拟环境中引导 pip 安装器提供了支持。需要使用引导才能使用pip的这一事实也正好反映了 pip 是一个独立的项目，有其自己的发布周期，其最新版本随CPython解释器的维护版本和新特性版本一同捆绑。

在大多数情况下，Python的终端使用者不需要直接调用这个模块（ pip 默认应该已被引导），不过，如果在安装Python（或创建虚拟环境）之时跳过了安装 pip 步骤，或者日后特意卸载了 pip ，则需要使用这个模块。

注解

这个模块 无需 访问互联网。引导启动 pip 所需的全部组件均包含在包的内部。

参见

安装 Python 模块

安装Python包的终端使用者教程

PEP 453 [https://www.python.org/dev/peps/pep-0453]: 在Python安装实例中显式引导启动pip

这个模块的原始缘由以及规范文档

命令行界面

使用解释器的 -m 参数调用命令行接口。

最简单的调用方式为：

python -m ensurepip

该调用会在当前未安装 pip 的情况下安装 pip ，如已安装则无事发生。如要确保安装的 pip 版本至少为 ensurepip 所支援的最新版本，传入 --upgrade 参数：

python -m ensurepip --upgrade

在默认情况下，pip 会被安装到当前虚拟环境（如果激活了虚拟环境）或系统的包目录（如果未激活虚拟环境）。 安装位置可通过两个额外的命令行选项来控制:

--root 1: 相对于给定的根目录而不是当前已激活虚拟环境（如果存在）的根目录或当前 Python 安装版的默认根目录来安装 pip。

--user: 将 pip 安装到用户包目录而不是全局安装到当前 Python 安装版（此选项不允许在已激活虚拟环境中使用）。

在默认情况下，脚本 pipX 和 pipX.Y 将被安装（其中 X.Y 表示被用来唤起 ensurepip 的 Python 的版本）。 所安装的脚本可通过两个额外的命令行选项来控制:

--altinstall: 如果请求了一个替代安装版，则 pipX 脚本将 不会 被安装。

--default-pip: 如果请求了一个 "默认的 pip" 安装版，则除了两个常规脚本之外还将安装 pip 脚本。

同时提供这两个脚本选择选项将会触发异常。

模块 API

ensurepip 暴露了两个函数用于编程:

ensurepip.version()

返回一个指明在初始创建环境时将被安装的可用 pip 版本的字符串。

ensurepip.bootstrap(root=None, upgrade=False, user=False, altinstall=False, default_pip=False, verbosity=0)

初始创建 pip 到当前的或指定的环境中。

root 指明要作为相对安装路径的替代根目录。 如果 root 为 None，则安装会使用当前环境的默认安装位置。

upgrade 指明是否要将一个现有的较早版本的 pip 的安装版升级到可用的新版本。

user 指明是否使用针对用户的安装方案而不是全局安装。

在默认情况下，将会安装 pipX 和 pipX.Y 脚本（其中 X.Y 表示 Python 的当前版本）。

如果设置了 altinstall，则 pipX 将 不会 被安装。

如果设置了 default_pip，则除了两个常规脚本外还将安装 pip。

同时设置 altinstall 和 default_pip 将触发 ValueError。

verbosity 控制初始创建操作对 sys.stdout 的输出信息级别。

引发一个 审计事件 ensurepip.bootstrap 并附带参数 root。

注解

创建创建过程对于 sys.path 和 os.environ 都会有附带影响。 改为在子进程中唤起命令行接口可以避免这些附带影响。

注解

初始创建过程可能会安装 pip 所需的额外模块，但其他软件不应假定这些依赖将总是会默认存在（因为这些依赖可能会在未来的 pip 版本中被移除）。

venv --- 创建虚拟环境

3.3 新版功能.

源码： Lib/venv/ [https://github.com/python/cpython/tree/3.10/Lib/venv/]

venv 模块支持创建轻量的“虚拟环境”，每个虚拟环境将拥有它们自己独立的安装在其 site 目录中的 Python 软件包集合。 虚拟环境是在现有的 Python 安装版基础之上创建的，这被称为虚拟环境的“基础”Python，并且还可选择与基础环境中的软件包隔离开来，这样只有在虚拟环境中显式安装的软件包才是可用的。

当在一个虚拟环境内使用时，常见安装工具如 pip [https://pypi.org/project/pip/] 将把 Python 软件包安装到虚拟环境中而无需显式地指明这一点。

请参阅 PEP 405 [https://www.python.org/dev/peps/pep-0405] 了解有关 Python 虚拟环境的更多背景信息。

参见

Python 打包用户指南：创建和使用虚拟环境 [https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment]

创建虚拟环境

通过执行 venv 指令来创建一个 虚拟环境:

python -m venv /path/to/new/virtual/environment

运行此命令将创建目标目录（父目录若不存在也将创建），并放置一个 pyvenv.cfg 文件在其中，文件中有一个 home 键，它的值指向运行此命令的 Python 安装（目标目录的常用名称是 .venv）。它还会创建一个 bin 子目录（在 Windows 上是 Scripts），其中包含 Python 二进制文件的副本或符号链接（视创建环境时使用的平台或参数而定）。它还会创建一个（初始为空的） lib/pythonX.Y/site-packages 子目录（在 Windows 上是 Lib\site-packages）。如果指定了一个现有的目录，这个目录就将被重新使用。

3.6 版后已移除: pyvenv 是针对 Python 3.3 和 3.4 创建虚拟环境的推荐工具，并 在 Python 3.6 中被弃用。

在 3.5 版更改: 现在推荐使用 venv 来创建虚拟环境。

在 Windows 上，调用 venv 命令如下:

c:\>c:\Python35\python -m venv c:\path\to\myenv

或者，如果已经为 Python 安装 配置好 PATH 和 PATHEXT 变量:

c:\>python -m venv c:\path\to\myenv

本命令如果以 -h 参数运行，将显示可用的选项:

usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
            [--upgrade] [--without-pip] [--prompt PROMPT] [--upgrade-deps]
            ENV_DIR [ENV_DIR ...]

Creates virtual Python environments in one or more target directories.

positional arguments:
  ENV_DIR               A directory to create the environment in.

optional arguments:
  -h, --help            show this help message and exit
  --system-site-packages
                        Give the virtual environment access to the system
                        site-packages dir.
  --symlinks            Try to use symlinks rather than copies, when symlinks
                        are not the default for the platform.
  --copies              Try to use copies rather than symlinks, even when
                        symlinks are the default for the platform.
  --clear               Delete the contents of the environment directory if it
                        already exists, before environment creation.
  --upgrade             Upgrade the environment directory to use this version
                        of Python, assuming Python has been upgraded in-place.
  --without-pip         Skips installing or upgrading pip in the virtual
                        environment (pip is bootstrapped by default)
  --prompt PROMPT       Provides an alternative prompt prefix for this
                        environment.
  --upgrade-deps        Upgrade core dependencies: pip setuptools to the
                        latest version in PyPI

Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.

在 3.9 版更改: 添加 --upgrade-deps 选项，用于将 pip + setuptools 升级到 PyPI 上的最新版本

在 3.4 版更改: 默认安装 pip，并添加 --without-pip 和 --copies 选项

在 3.4 版更改: 在早期版本中，如果目标目录已存在，将引发错误，除非使用了 --clear 或 --upgrade 选项。

注解

虽然 Windows 支持符号链接，但不推荐使用它们。特别注意，在文件资源管理器中双击 python.exe 将立即解析符号链接，并忽略虚拟环境。

注解

在 Microsoft Windows 上，为了启用 Activate.ps1 脚本，可能需要修改用户的执行策略。可以运行以下 PowerShell 命令来执行此操作：

PS C:> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

参阅 About Execution Policies [https://go.microsoft.com/fwlink/?LinkID=135170] 以获取更多信息。

生成的 pyvenv.cfg 文件还包括 include-system-site-packages 键，如果运行 venv 时带有 --system-site-packages 选项，则键值为 true，否则为 false。

除非采用 --without-pip 选项，否则将会调用 ensurepip 将 pip 引导到虚拟环境中。

可以向 venv 传入多个路径，此时将根据给定的选项，在所给的每个路径上创建相同的虚拟环境。

虚拟环境是如何实现的

When a Python interpreter is running from a virtual environment, sys.prefix and sys.exec_prefix point to the directories of the virtual environment, whereas sys.base_prefix and sys.base_exec_prefix point to those of the base Python used to create the environment. It is sufficient to check sys.prefix == sys.base_prefix to determine if the current interpreter is running from a virtual environment.

A virtual environment may be "activated" using a script in its binary directory (bin on POSIX; Scripts on Windows). This will prepend that directory to your PATH, so that running python will invoke the environment's Python interpreter and you can run installed scripts without having to use their full path. The invocation of the activation script is platform-specific (<venv> must be replaced by the path to the directory containing the virtual environment):

平台 | Shell | 用于激活虚拟环境的命令
POSIX | bash/zsh | $ source <venv>/bin/activate
fish | $ source <venv>/bin/activate.fish
csh/tcsh | $ source <venv>/bin/activate.csh
PowerShell | $ <venv>/bin/Activate.ps1
Windows | cmd.exe | C:\> <venv>\Scripts\activate.bat
PowerShell | PS C:\> <venv>\Scripts\Activate.ps1

3.4 新版功能: fish 和 csh 激活脚本。

3.8 新版功能: 在 POSIX 上安装 PowerShell 激活脚本，以支持 PowerShell Core。

激活一个虚拟环境的操作 不是必需的，因为你完全可以在唤起 Python 时指明特定虚拟环境的 Python 解释器的完整路径。 更进一步地说，安装在虚拟环境中的所有脚本也都可以在不激活该虚拟环境的情况下运行。

In order to achieve this, scripts installed into virtual environments have a "shebang" line which points to the environment's Python interpreter, i.e. #!/<path-to-venv>/bin/python. This means that the script will run with that interpreter regardless of the value of PATH. On Windows, "shebang" line processing is supported if you have the 适用于Windows的Python启动器 installed. Thus, double-clicking an installed script in a Windows Explorer window should run it with the correct interpreter without the environment needing to be activated or on the PATH.

当一个虚拟环境已被激活时，VIRTUAL_ENV 环境变量会被设为该虚拟环境的路径。 由于使用虚拟环境并不需要显式地激活它，因此 VIRTUAL_ENV 并不能被用来可靠地确定是否正在使用虚拟环境。

警告

因为安装在虚拟环境中的脚本不应要求必须激活该虚拟环境，所以它们的“井号叹号”行会包含虚拟环境的绝对路径。 因为这一点，所以虚拟环境在通常情况下都是不可移植的。 你应当保证提供重建一个虚拟环境的简便方式（举例来说，如果你准备了需求文件 requirements.txt，则可以使用虚拟环境的 pip 执行 pip install -r requirements.txt 来安装虚拟环境所需的所有软件包）。 如果出于某种原因你需要将虚拟环境移动到一个新的位置，则你应当在目标位置上重建它并删除旧位置上的虚拟环境。 如果出于某种原因你移动了一个虚拟环境的上级目录，你也应当在新位置上重建该虚拟环境。 否则，安装到该虚拟环境的软件包可能无法正常工作。

你可以通过在 shell 中输入 deactivate 来取消激活一个虚拟环境。 取消激活的实现机制依赖于具体平台并且属于内部实现细节（通常，将会使用一个脚本或者 shell 函数）。

API

上述的高级方法使用了一个简单的 API，该 API 提供了一种机制，第三方虚拟环境创建者可以根据其需求自定义环境创建过程，该 API 为 EnvBuilder 类。

class venv.EnvBuilder(system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None, upgrade_deps=False)

EnvBuilder 类在实例化时接受以下关键字参数：

system_site_packages -- 一个布尔值，要求系统 Python 的 site-packages 对环境可用（默认为 False）。

clear -- 一个布尔值，如果为 true，则在创建环境前将删除目标目录的现有内容。

symlinks -- 一个布尔值，指示是否尝试符号链接 Python 二进制文件，而不是进行复制。

upgrade -- 一个布尔值，如果为 true，则将使用当前运行的 Python 去升级一个现有的环境，这主要在原位置的 Python 更新后使用（默认为 False）。

with_pip -- 一个布尔值，如果为 true，则确保在虚拟环境中已安装 pip。这使用的是带有 --default-pip 选项的 ensurepip。

prompt -- 激活虚拟环境后显示的提示符（默认为 None，表示使用环境所在的目录名称）。如果使用了 "." 这一特殊字符串，则使用当前目录的基本名称作为提示符。

upgrade_deps -- 将基本 venv 模块更新为 PyPI 上的最新版本。

在 3.4 版更改: 添加 with_pip 参数

3.6 新版功能: 添加 prompt 参数

3.9 新版功能: 添加 upgrade_deps 参数

第三方虚拟环境工具的创建者可以自由地将此处提供的 EnvBuilder 类作为基类。

返回的 env-builder 是一个对象，包含一个 create 方法：

create(env_dir)

指定要建立虚拟环境的目标目录（绝对路径或相对于当前路径）来创建虚拟环境。create 方法将在指定目录中创建环境，或者引发对应的异常。

EnvBuilder 类的 create 方法定义了可用于定制子类的钩子:

def create(self, env_dir):
    """
    Create a virtualized Python environment in a directory.
    env_dir is the target directory to create an environment in.
    """
    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)

每个方法 ensure_directories(), create_configuration(), setup_python(), setup_scripts() 和 post_setup() 都可以被重写。

ensure_directories(env_dir)

创建虚拟环境目录及尚不存在的所有必要的子目录，并返回一个上下文对象。 这个上下文对象被用于存放供其他方法使用的属性（如路径等）。 如果 EnvBuilder 是附带参数 clear=True 创建的，则虚拟环境的内容将被清除并将重新创建所有必要的子目录。

返回的上下文对象是一个具有以下属性的 types.SimpleNamespace:

env_dir - 虚拟环境的位置。 将被用作激活脚本中的 __VENV_DIR__ (参见 install_scripts())。

env_name - 虚拟环境的名称。 将被用作激活脚本中的 __VENV_NAME__ (参见 install_scripts())。

prompt - 激活脚本要使用的提示符。 将被用作激活脚本中的 __VENV_PROMPT__ (参见 install_scripts())。

executable - 虚拟环境所使用的下层 Python 可执行文件。 这会将基于另一个虚拟环境创建虚拟环境的情况也纳入考虑。

inc_path - 虚拟环境的 include 路径。

lib_path - 虚拟环境的 purelib 路径。

bin_path - 虚拟环境的 script 路径。

bin_name - 相对于虚拟环境位置的 script 路径名称。 用于激活脚本中的 __VENV_BIN_NAME__ (参见 install_scripts())。

env_exe - 虚拟环境中 Python 解释器的名称。 用于激活脚本中的 __VENV_PYTHON__ (参见 install_scripts())。

env_exec_cmd - Python 解释器的名称，会将文件系统重定向也纳入考虑。 这可被用于在虚拟环境中运行 Python。

在 3.12 版更改: 将属性 lib_path 添加到上下文中，并将上下文对象写入文档。

在 3.11 版更改: venv sysconfig installation scheme 被用于构造所创建目录的路径。

create_configuration(context)

在环境中创建 pyvenv.cfg 配置文件。

setup_python(context)

在环境中创建 Python 可执行文件的拷贝或符号链接。在 POSIX 系统上，如果给定了可执行文件 python3.x，将创建指向该可执行文件的 python 和 python3 符号链接，除非相同名称的文件已经存在。

setup_scripts(context)

将适用于平台的激活脚本安装到虚拟环境中。

upgrade_dependencies(context)

升级环境中 venv 依赖的核心软件包（当前为 pip 和 setuptools）。通过在环境中使用 pip 可执行文件来完成。

3.9 新版功能.

post_setup(context)

占位方法，可以在第三方实现中重写，用于在虚拟环境中预安装软件包，或是其他创建后要执行的步骤。

在 3.7.2 版更改: Windows 现在为 python[w].exe 使用重定向脚本，而不是复制实际的二进制文件。仅在 3.7.2 中，除非运行的是源码树中的构建，否则 setup_python() 不会执行任何操作。

在 3.7.3 版更改: Windows 将重定向脚本复制为 setup_python() 的一部分而非 setup_scripts()。在 3.7.2 中不是这种情况。使用符号链接时，将链接至原始可执行文件。

此外，EnvBuilder 提供了如下实用方法，可以从子类的 setup_scripts() 或 post_setup() 调用，用来将自定义脚本安装到虚拟环境中。

install_scripts(context, path)

path 是一个目录的路径，该目录应包含子目录 "common", "posix", "nt"，每个子目录存有发往对应环境中 bin 目录的脚本。在下列占位符替换完毕后，将复制 "common" 的内容和与 os.name 对应的子目录：

__VENV_DIR__ 会被替换为环境目录的绝对路径。

__VENV_NAME__ 会被替换为环境名称（环境目录的最后一个字段）。

__VENV_PROMPT__ 会被替换为提示符（用括号括起来的环境名称紧跟着一个空格）。

__VENV_BIN_NAME__ 会被替换为 bin 目录的名称（ bin 或 Scripts ）。

__VENV_PYTHON__ 会被替换为环境可执行文件的绝对路径。

允许目录已存在（用于升级现有环境时）。

有一个方便实用的模块级别的函数:

venv.create(env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None, upgrade_deps=False)

通过关键词参数来创建一个 EnvBuilder，并且使用 env_dir 参数来调用它的 create() 方法。

3.3 新版功能.

在 3.4 版更改: 添加 with_pip 参数

在 3.6 版更改: 添加 prompt 参数

在 3.9 版更改: 添加 upgrade_deps 参数

一个扩展 EnvBuilder 的例子

下面的脚本展示了如何通过实现一个子类来扩展 EnvBuilder。这个子类会安装 setuptools 和 pip 到被创建的虚拟环境中。

import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlparse
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)
        # Can't install pip without setuptools
        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, _, _, _ = urlparse(url)
        fn = os.path.split(path)[-1]
        binpath = context.bin_path
        distpath = os.path.join(binpath, fn)
        # Download script into the virtual environment's binaries folder
        urlretrieve(url, distpath)
        progress = self.progress
        if self.verbose:
            term = '\n'
        else:
            term = ''
        if progress is not None:
            progress('Installing %s ...%s' % (name, term), 'main')
        else:
            sys.stderr.write('Installing %s ...%s' % (name, term))
            sys.stderr.flush()
        # Install in the virtual environment
        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')
        # Clean up - no longer needed
        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://bitbucket.org/pypa/setuptools/downloads/ez_setup.py'
        self.install_script(context, 'setuptools', url)
        # clear up the setuptools archive which gets downloaded
        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):
    compatible = True
    if sys.version_info < (3, 3):
        compatible = False
    elif not hasattr(sys, 'base_prefix'):
        compatible = False
    if not compatible:
        raise ValueError('This script is only for use with '
                         'Python 3.3 or later')
    else:
        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)

这个脚本同样可以 在线下载 [https://gist.github.com/vsajip/4673395]。

zipapp —— 管理可执行的 Python zip 打包文件

3.5 新版功能.

源代码： Lib/zipapp.py [https://github.com/python/cpython/tree/3.10/Lib/zipapp.py]

本模块提供了一套管理工具，用于创建包含 Python 代码的压缩文件，这些文件可以 直接由 Python 解释器执行。 本模块提供 命令行接口 和 Python API。

简单示例

下述例子展示了用 命令行接口 根据含有 Python 代码的目录创建一个可执行的打包文件。 运行后该打包文件时，将会执行 myapp 模块中的 main 函数。

$ python -m zipapp myapp -m "myapp:main"
$ python myapp.pyz
<output from myapp>

命令行接口

若要从命令行调用，则采用以下形式：

$ python -m zipapp source [options]

如果 source 是个目录，将根据 source 的内容创建一个打包文件。如果 source 是个文件，则应为一个打包文件，将会复制到目标打包文件中（如果指定了 -info 选项，将会显示 shebang 行的内容）。

可以接受以下参数：

-o <output>, --output=<output>

将程序的输出写入名为 output 的文件中。若未指定此参数，输出的文件名将与输入的 source 相同，并添加扩展名 .pyz。如果显式给出了文件名，将会原样使用（因此必要时应包含扩展名 .pyz）。

如果 source 是个打包文件，必须指定一个输出文件名（这时 output 必须与 source 不同）。

-p <interpreter>, --python=<interpreter>

给打包文件加入 #! 行，以便指定 解释器 作为运行的命令行。另外，还让打包文件在 POSIX 平台上可执行。默认不会写入 #! 行，也不让文件可执行。

-m <mainfn>, --main=<mainfn>

在打包文件中写入一个 __main__.py 文件，用于执行 mainfn。mainfn 参数的形式应为 “pkg.mod:fn”，其中 “pkg.mod”是打包文件中的某个包/模块，“fn”是该模块中的一个可调用对象。__main__.py 文件将会执行该可调用对象。

在复制打包文件时，不能设置 --main 参数。

-c, --compress

利用 deflate 方法压缩文件，减少输出文件的大小。默认情况下，打包文件中的文件是不压缩的。

在复制打包文件时，--compress 无效。

3.7 新版功能.

--info

显示嵌入在打包文件中的解释器程序，以便诊断问题。这时会忽略其他所有参数，SOURCE 必须是个打包文件，而不是目录。

-h, --help

打印简短的用法信息并退出。

Python API

该模块定义了两个快捷函数：

zipapp.create_archive(source, target=None, interpreter=None, main=None, filter=None, compressed=False)

由 source 创建一个应用程序打包文件。source 可以是以下形式之一：

一个目录名，或指向目录的 path-like object ，这时将根据目录内容新建一个应用程序打包文件。

一个已存在的应用程序打包文件名，或指向这类文件的 path-like object，这时会将该文件复制为目标文件（会稍作修改以反映出 interpreter 参数的值）。必要时文件名中应包括 .pyz 扩展名。

一个以字节串模式打开的文件对象。该文件的内容应为应用程序打包文件，且假定文件对象定位于打包文件的初始位置。

target 参数定义了打包文件的写入位置：

若是个文件名，或是 path-like object，打包文件将写入该文件中。

若是个打开的文件对象，打包文件将写入该对象，该文件对象必须在字节串写入模式下打开。

如果省略了 target （或为 None），则 source 必须为一个目录，target 将是与 source 同名的文件，并加上 .pyz 扩展名。

参数 interpreter 指定了 Python 解释器程序名，用于执行打包文件。这将以 “释伴（shebang）”行的形式写入打包文件的头部。在 POSIX 平台上，操作系统会进行解释，而在 Windows 平台则会由 Python 启动器进行处理。省略 interpreter 参数则不会写入释伴行。如果指定了解释器，且目标为文件名，则会设置目标文件的可执行属性位。

参数 main 指定某个可调用程序的名称，用作打包文件的主程序。仅当 source 为目录且不含 __main__.py 文件时，才能指定该参数。main 参数应采用 “pkg.module:callable”的形式，通过导入“pkg.module”并不带参数地执行给出的可调用对象，即可执行打包文件。如果 source 是目录且不含 __main__.py 文件，省略 main 将会出错，生成的打包文件将无法执行。

可选参数 filter 指定了回调函数，将传给代表被添加文件路径的 Path 对象（相对于源目录）。如若文件需要加入打包文件，则回调函数应返回 True。

可选参数 compressed 指定是否要压缩打包文件。若设为 True，则打包中的文件将用 deflate 方法进行压缩；否则就不会压缩。本参数在复制现有打包文件时无效。

若 source 或 target 指定的是文件对象，则调用者有责任在调用 create_archive 之后关闭这些文件对象。

当复制已有的打包文件时，提供的文件对象只需 read 和 readline 方法，或 write 方法。当由目录创建打包文件时，若目标为文件对象，将会将其传给 类，且必须提供 zipfile.ZipFile 类所需的方法。

3.7 新版功能: 加入了 filter 和 compressed 参数。

zipapp.get_interpreter(archive)

返回打包文件开头的 行指定的解释器程序。如果没有 #! 行，则返回 None。参数 archive 可为文件名或在字节串模式下打开以供读取的文件型对象。#! 行假定是在打包文件的开头。

例子

将目录打包成一个文件并运行它。

$ python -m zipapp myapp
$ python myapp.pyz
<output from myapp>

同样还可用 create_archive() 函数完成：

>>> import zipapp
>>> zipapp.create_archive('myapp', 'myapp.pyz')

要让应用程序能在 POSIX 平台上直接执行，需要指定所用的解释器。

$ python -m zipapp myapp -p "/usr/bin/env python"
$ ./myapp.pyz
<output from myapp>

若要替换已有打包文件中的释伴行，请用 create_archive() 函数另建一个修改好的打包文件：

>>> import zipapp
>>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')

若要原地更新打包文件，可用 BytesIO 对象在内存中进行替换，然后再覆盖源文件。 请注意原地覆盖文件存在发生错误时丢失原始文件的风险。 这段代码没有考虑发生错误的情况，但生产性代码应该要考虑。 另外，此方法将仅在内存能容纳打包文件时才适用:

>>> 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())

指定解释器程序

注意，如果指定了解释器程序再发布应用程序打包文件，需要确保所用到的解释器是可移植的。Windows 的 Python 启动器支持大多数常见的 POSIX #! 行，但还需要考虑一些其他问题。

如果采用“/usr/bin/env python”（或其他格式的 python 调用命令，比如“/usr/bin/python”)，需要考虑默认版本既可能是 Python 2 又可能是 Python 3，应让代码在两个版本下均能正常运行。

如果用到的 Python 版本明确，如“/usr/bin/env python3”，则没有该版本的用户将无法运行应用程序。（如果代码不兼容 Python 2，可能正该如此）。

因为无法指定“python X.Y以上版本”，所以应小心“/usr/bin/env python3.4”这种精确版本的指定方式，因为对于 Python 3.5 的用户就得修改释伴行，比如：

通常应该用“/usr/bin/env python2”或“/usr/bin/env python3”的格式，具体根据代码适用于 Python 2 还是 3 而定。

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

利用 zipapp 模块可以创建独立运行的 Python 程序，以便向最终用户发布，仅需在系统中装有合适版本的 Python 即可运行。操作的关键就是把应用程序代码和所有依赖项一起放入打包文件中。

创建独立运行打包文件的步骤如下：

照常在某个目录中创建应用程序，于是会有一个 myapp 目录，里面有个 __main__.py 文件，以及所有支持性代码。

用 pip 将应用程序的所有依赖项装入 myapp 目录。

$ python -m pip install -r requirements.txt --target myapp

（这里假定在 requirements.txt 文件中列出了项目所需的依赖项，也可以在 pip 命令行中列出依赖项）。

pip 在 myapp 中创建的 .dist-info 目录，是可以删除的。这些目录保存了 pip 用于管理包的元数据，由于接下来不会再用到 pip，所以不是必须存在，当然留下来也不会有什么坏处。

用以下命令打包：

$ python -m zipapp -p "interpreter" myapp

这会生成一个独立的可执行文件，可在任何装有合适解释器的机器上运行。详情参见 指定解释器程序。可以单个文件的形式分发给用户。

在 Unix 系统中， myapp.pyz 文件将以原有文件名执行。如果喜欢 “普通”的命令名，可以重命名该文件，去掉扩展名 .pyz 。在 Windows 系统中， myapp.pyz[w] 是可执行文件，因为 Python 解释器在安装时注册了扩展名 .pyz 和 .pyzw 。

制作 Windows 可执行文件

在 Windows 系统中，可能没有注册扩展名 .pyz，另外有些场合无法“透明”地识别已注册的扩展（最简单的例子是，subprocess.run(['myapp']) 就找不到——需要明确指定扩展名）。

因此，在 Windows 系统中，通常最好 由zipapp 创建一个可执行文件。虽然需要用到 C 编译器，但还是相对容易做到的。基本做法有赖于以下事实，即 zip 文件内可预置任意数据，Windows 的 exe 文件也可以附带任意数据。因此，创建一个合适的启动程序并将 .pyz 文件附在后面，最后就能得到一个单文件的可执行文件，可运行 Python 应用程序。

合适的启动程序可以简单如下：

#define Py_LIMITED_API 1
#include "Python.h"

#define WIN32_LEAN_AND_MEAN
#include <windows.h>

#ifdef WINDOWS
int WINAPI wWinMain(
    HINSTANCE hInstance,      /* handle to current instance */
    HINSTANCE hPrevInstance,  /* handle to previous instance */
    LPWSTR lpCmdLine,         /* pointer to command line */
    int nCmdShow              /* show state of window */
)
#else
int wmain()
#endif
{
    wchar_t **myargv = _alloca((__argc + 1) * sizeof(wchar_t*));
    myargv[0] = __wargv[0];
    memcpy(myargv + 1, __wargv, __argc * sizeof(wchar_t *));
    return Py_Main(__argc+1, myargv);
}

若已定义了预处理器符号 WINDOWS，上述代码将会生成一个 GUI 可执行文件。若未定义则生成一个可执行的控制台文件。

直接使用标准的 MSVC 命令行工具，或利用 distutils 知道如何编译 Python 源代码，即可编译可执行文件：

>>> from distutils.ccompiler import new_compiler
>>> import distutils.sysconfig
>>> import sys
>>> import os
>>> from pathlib import Path

>>> def compile(src):
>>>     src = Path(src)
>>>     cc = new_compiler()
>>>     exe = src.stem
>>>     cc.add_include_dir(distutils.sysconfig.get_python_inc())
>>>     cc.add_library_dir(os.path.join(sys.base_exec_prefix, 'libs'))
>>>     # First the CLI executable
>>>     objs = cc.compile([str(src)])
>>>     cc.link_executable(objs, exe)
>>>     # Now the GUI executable
>>>     cc.define_macro('WINDOWS')
>>>     objs = cc.compile([str(src)])
>>>     cc.link_executable(objs, exe + 'w')

>>> if __name__ == "__main__":
>>>     compile("zastub.c")

生成的启动程序用到了 “受限 ABI”，所以可在任意版本的 Python 3.x 中运行。只要用户的 PATH 中包含了 Python（python3.dll）路径即可。

若要得到完全独立运行的发行版程序，可将附有应用程序的启动程序，与“内嵌版” Python 打包在一起即可。这样在架构匹配（32位或64位）的任一 PC 上都能运行。

注意事项

要将应用程序打包为单个文件，存在一些限制。大多数情况下，无需对应用程序进行重大修改即可解决。

如果应用程序依赖某个带有 C 扩展的包，则此程序包无法由打包文件运行（这是操作系统的限制，因为可执行代码必须存在于文件系统中，操作系统才能加载）。这时可去除打包文件中的依赖关系，然后要求用户事先安装好该程序包，或者与打包文件一起发布并在 __main__.py 中增加代码，将未打包模块的目录加入 sys.path 中。采用增加代码方式时，一定要为目标架构提供合适的二进制文件（可能还需在运行时根据用户的机器选择正确的版本加入 sys.path）。

若要如上所述发布一个 Windows 可执行文件，就得确保用户在 PATH 中包含 python3.dll 的路径（安装程序默认不会如此），或者应把应用程序与内嵌版 Python 一起打包。

上述给出的启动程序采用了 Python 嵌入 API。 这意味着应用程序将会是 sys.executable ，而*不是*传统的 Python 解释器。代码及依赖项需做好准备。例如，如果应用程序用到了 multiprocessing 模块，就需要调用 multiprocessing.set_executable() 来让模块知道标准 Python 解释器的位置。

Python 打包应用程序的格式

自 2.6 版开始，Python 即能够执行包含 文件的打包文件了。为了能被 Python 执行，应用程序的打包文件必须为包含 __main__.py 文件的标准 zip 文件，__main__.py 文件将作为应用程序的入口运行。类似于常规的 Python 脚本，父级（这里指打包文件）将放入 sys.path ，因此可从打包文件中导入更多的模块。

zip 文件格式允许在文件中预置任意数据。利用这种能力，zip 应用程序格式在文件中预置了一个标准的 POSIX “释伴”行（#!/path/to/interpreter）。

因此，Python zip 应用程序的格式会如下所示：

可选的释伴行，包含字符 b'#!'，后面是解释器名，然后是换行符 （b'\n'）。 解释器名可为操作系统 “释伴”处理所能接受的任意值，或为 Windows 系统中的 Python 启动程序。解释器名在 Windows 中应用 UTF-8 编码，在 POSIX 中则用 sys.getfilesystemencoding()。

标准的打包文件由 zipfile 模块生成。其中 必须 包含一个名为 __main__.py 的文件（必须位于打包文件的“根”目录——不能位于某个子目录中）。打包文件中的数据可以是压缩或未压缩的。

如果应用程序的打包文件带有释伴行，则在 POSIX 系统中可能需要启用可执行属性，以允许直接执行。

不一定非要用本模块中的工具创建应用程序打包文件，本模块只是提供了便捷方案，上述格式的打包文件可用任何方式创建，均可被 Python 接受。

Python 运行时服务

本章描述的模块广泛服务于 Python 解释器及其与其环境的交互：

sys --- 系统相关的形参和函数

sysconfig —— 提供对 Python 配置信息的访问支持

配置变量

安装路径

其他功能

将 sysconfig 作为脚本使用

builtins --- 内建对象

__main__ ——顶层代码环境

__name__ == '__main__'

什么是“顶层代码环境”？

惯用法

打包考量

Python 包中的 __main__.py

惯用法

import __main__

warnings ——控制警告信息

警告类别

警告过滤器

警告过滤器的介绍

默认警告过滤器

重写默认的过滤器

暂时禁止警告

测试警告

为新版本的依赖关系更新代码

可用的函数

可用的上下文管理器

dataclasses --- 数据类

模块内容

初始化后处理

类变量

仅初始化变量

冻结的实例

继承

__init__() 中仅限关键字字段的重新排序

默认工厂函数

可变的默认值

描述器类型的字段

contextlib --- 为 with语句上下文提供的工具

工具

例子和配方

支持可变数量的上下文管理器

捕获 __enter__ 方法产生的异常

在一个 __enter__ 方法的实现中进行清理

替换任何对 try-finally 和旗标变量的使用

将上下文管理器作为函数装饰器使用

单独使用，可重用并可重进入的上下文管理器

重进入上下文管理器

可重用的上下文管理器

abc --- 抽象基类

atexit --- 退出处理器

atexit 示例

traceback —— 打印或读取栈回溯信息

TracebackException 对象

StackSummary 对象

FrameSummary 对象

回溯示例

__future__ --- Future 语句定义

gc --- 垃圾回收器接口

inspect --- 检查对象

类型和成员

获取源代码

使用 Signature 对象对可调用对象进行内省

类与函数

解释器栈

静态地获取属性

生成器和协程的当前状态

代码对象位标志

命令行界面

site —— 指定域的配置钩子

Readline 配置

模块内容

命令行界面

sys --- 系统相关的形参和函数

该模块提供了一些变量和函数。这些变量可能被解释器使用，也可能由解释器提供。这些函数会影响解释器。本模块总是可用的。

sys.abiflags

在POSIX系统上，以标准的 configure 脚本构建的 Python 中，这个变量会包含 PEP 3149 [https://www.python.org/dev/peps/pep-3149] 中定义的ABI标签。

在 3.8 版更改: 默认的 flags 变为了空字符串（用于 pymalloc 的 m 旗标已经移除）

3.2 新版功能.

sys.addaudithook(hook)

将可调用的对象 hook 附加到当前（子）解释器的活动的审计钩子列表中。

当通过 sys.audit() 函数引发审计事件时，每个钩子将按照其被加入的先后顺序被调用，调用时会传入事件名称和参数元组。 由 PySys_AddAuditHook() 添加的原生钩子会先被调用，然后是当前（子）解释器中添加的钩子。 接下来这些钩子会记录事件，引发异常来中止操作，或是完全终止进程。

请注意审计钩子主要是用于收集有关内部或在其他情况下不可观察操作的信息，可能是通过 Python 或者用 Python 编写的库。 它们不适合用于实现“沙盒”。 特别重要的一点是，恶意代码可以轻易地禁用或绕过使用此函数添加的钩子。 至少，在初始化运行时之前必须使用 C API PySys_AddAuditHook() 来添加任何安全敏感的钩子，并且应当完全删除或密切监视任何允许任意修改内存的模块 (如 ctypes)。

调用 sys.addaudithook() 时它自身将引发一个名为 sys.addaudithook 的审计事件且不附带参数。 如果任何现有的钩子引发了派生自 RuntimeError 的异常，则新的钩子不会被添加并且该异常会被抑制。 其结果就是，调用者无法确保他们的钩子已经被添加，除非他们控制了全部现有的钩子。

请参阅 审计事件表 以获取由 CPython 引发的所有事件，并参阅 PEP 578 [https://www.python.org/dev/peps/pep-0578] 了解最初的设计讨论。

3.8 新版功能.

在 3.8.1 版更改: 派生自 Exception （而非 RuntimeError ）的异常不会被抑制。

CPython 实现细节： 启用跟踪时（参阅 settrace() ），仅当可调用对象（钩子）的 __cantrace__ 成员设置为 true 时，才会跟踪该钩子。否则，跟踪功能将跳过该钩子。

sys.argv

一个列表，其中包含了被传递给 Python 脚本的命令行参数。 argv[0] 为脚本的名称（是否是完整的路径名取决于操作系统）。如果是通过 Python 解释器的命令行参数 -c 来执行的， argv[0] 会被设置成字符串 '-c' 。如果没有脚本名被传递给 Python 解释器， argv[0] 为空字符串。

为了遍历标准输入，或者通过命令行传递的文件列表，参照 fileinput 模块

另请参阅 sys.orig_argv。

注解

在 Unix 上，系统传递的命令行参数是字节类型的。Python 使用文件系统编码和 "surrogateescape" 错误处理方案对它们进行解码。当需要原始字节时，可以通过 [os.fsencode(arg) for arg in sys.argv] 来获取。

sys.audit(event, *args)

引发一个审计事件并触发任何激活的审计钩子。 event 是一个用于标识事件的字符串，args 会包含有关事件的更多信息的可选参数。 特定事件的参数的数量和类型会被视为是公有的稳定 API 且不应当在版本之间进行修改。

例如，有一个审计事件的名称为 os.chdir。 此事件具有一个名为 path 的参数，该参数将包含所请求的新工作目录。

sys.audit() 将调用现有的审计钩子，传入事件名称和参数，并将重新引发来自任何钩子的第一个异常。 通常来说，如果有一个异常被引发，则它不应当被处理且其进程应当被尽可能快地终止。 这将允许钩子实现来决定对特定事件要如何反应：它们可以只是将事件写入日志或是通过引发异常来中止操作。

钩子程序由 sys.addaudithook() 或 PySys_AddAuditHook() 函数添加。

与本函数相等效的原生函数是 PySys_Audit()，应尽量使用原生函数。

参阅 审计事件表 以获取 CPython 定义的所有审计事件。

3.8 新版功能.

sys.base_exec_prefix

在 site.py 运行之前， Python 启动的时候被设置为跟 exec_prefix 同样的值。如果不是运行在 虚拟环境 中，两个值会保持相同；如果 site.py 发现处于一个虚拟环境中， prefix 和 exec_prefix 将会指向虚拟环境。然而 base_prefix 和 base_exec_prefix 将仍然会指向基础的 Python 环境（用来创建虚拟环境的 Python 环境）

3.3 新版功能.

sys.base_prefix

在 site.py 运行之前， Python 启动的时候被设置为跟 prefix 同样的值。如果不是运行在 虚拟环境 中, 两个值会保持相同；如果 site.py 发现处于一个虚拟环境中， prefix 和 exec_prefix 将会指向虚拟环境。然而 base_prefix 和 base_exec_prefix 将仍然会指向基础的 Python 环境（用来创建虚拟环境的 Python 环境）

3.3 新版功能.

sys.byteorder

本地字节顺序的指示符。在大端序（最高有效位优先）操作系统上值为 'big' ，在小端序（最低有效位优先）操作系统上为 'little' 。

sys.builtin_module_names

一个包含所有被编译进 Python 解释器的模块的名称的字符串元组。 （此信息无法通过任何其他办法获取 --- modules.keys() 仅会列出导入的模块。）

另请参阅 sys.stdlib_module_names 列表。

sys.call_tracing(func, args)

在启用跟踪时调用 func(*args) 来保存跟踪状态，然后恢复跟踪状态。这将从检查点的调试器调用，以便递归地调试其他的一些代码。

sys.copyright

一个字符串，包含了 Python 解释器有关的版权信息

sys._clear_type_cache()

清除内部的类型缓存。类型缓存是为了加速查找方法和属性的。在调试引用泄漏的时候调用这个函数 只会 清除不必要的引用。

这个函数应该只在内部为了一些特定的目的使用。

sys._current_frames()

返回一个字典，存放着每个线程的标识符与（调用本函数时）该线程栈顶的帧（当前活动的帧）之间的映射。注意 traceback 模块中的函数可以在给定某一帧的情况下构建调用堆栈。

这对于调试死锁最有用：本函数不需要死锁线程的配合，并且只要这些线程的调用栈保持死锁，它们就是冻结的。在调用本代码来检查栈顶的帧的那一刻，非死锁线程返回的帧可能与该线程当前活动的帧没有任何关系。

这个函数应该只在内部为了一些特定的目的使用。

引发一个不带参数的 审计事件 sys._current_frames。

sys._current_exceptions()

返回一个字典，存放着每个线程的标识与调用此函数时该线程当前活动帧的栈顶异常之间的映射。 如果某个线程当前未在处理异常，它将不被包括在结果字典中。

这对于静态性能分析来说最为有用。

这个函数应该只在内部为了一些特定的目的使用。

引发一个不带参数的 审计事件 sys._current_exceptions。

sys.breakpointhook()

本钩子函数由内建函数 breakpoint() 调用。默认情况下，它将进入 pdb 调试器，但可以将其改为任何其他函数，以选择使用哪个调试器。

该函数的特征取决于其调用的函数。例如，默认绑定（即 pdb.set_trace() ）不要求提供参数，但可以将绑定换成要求提供附加参数（位置参数/关键字参数）的函数。内建函数 breakpoint() 直接将其 *args 和 **kws 传入。breakpointhooks() 返回的所有内容都会从 breakpoint() 返回。

默认的实现首先会查询环境变量 PYTHONBREAKPOINT。如果将该变量设置为 "0"，则本函数立即返回，表示在断点处无操作。如果未设置该环境变量或将其设置为空字符串，则调用 pdb.set_trace()。否则，此变量应指定要运行的函数，指定函数时应使用 Python 的点导入命名法，如 package.subpackage.module.function。这种情况下将导入 package.subpackage.module，且导入的模块必须有一个名为 function() 的可调用对象。该可调用对象会运行，*args 和 **kws 会传入，且无论 function() 返回什么，sys.breakpointhook() 都将返回到內建函数 breakpoint()。

请注意，如果在导入 PYTHONBREAKPOINT 指定的可调用对象时出错，则将报告一个 RuntimeWarning 并忽略断点。

另请注意，如果以编程方式覆盖 sys.breakpointhook()，则 不会 查询 PYTHONBREAKPOINT。

3.7 新版功能.

sys._debugmallocstats()

将有关 CPython 内存分配器状态的底层的信息打印至 stderr。

如果 Python 是 以调试模式编译的 (使用 --with-pydebug 配置选项)，它还会执行某些高开销的内部一致性检查。

3.3 新版功能.

CPython 实现细节： 本函数仅限 CPython。此处没有定义确切的输出格式，且可能会更改。

sys.dllhandle

指向 Python DLL 句柄的整数。

可用性: Windows。

sys.displayhook(value)

如果 value 不是 None，则本函数会将 repr(value) 打印至 sys.stdout，并将 value 保存在 builtins._ 中。如果 repr(value) 无法用 sys.stdout.errors 错误处理方案（可能为 'strict' ）编码为 sys.stdout.encoding，则用 'backslashreplace' 错误处理方案将其编码为 sys.stdout.encoding。

在交互式 Python 会话中运行 expression 产生结果后，将在结果上调用 sys.displayhook。若要自定义这些 value 的显示，可以将 sys.displayhook 指定为另一个单参数函数。

伪代码:

def displayhook(value):
    if value is None:
        return
    # Set '_' to None to avoid recursion
    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

在 3.2 版更改: 在发生 UnicodeEncodeError 时使用 'backslashreplace' 错误处理方案。

sys.dont_write_bytecode

如果该值为 true，则 Python 在导入源码模块时将不会尝试写入 .pyc 文件。该值会被初始化为 True 或 False，依据是 -B 命令行选项和 PYTHONDONTWRITEBYTECODE 环境变量，可以自行设置该值，来控制是否生成字节码文件。

sys.pycache_prefix

如果设置了该值 (不能为 None)，Python 会将字节码缓存文件 .pyc 写入到以该值指定的目录为根的并行目录树中（并从中读取），而不是在源代码树的 __pycache__ 目录下读写。 源代码树中所有的 __pycache__ 目录都将被忽略并且新的 .pyc 文件将被写入到 pycache 前缀指定的位置。 因此如果你使用 compileall 作为预编译步骤，你必须确保使用与在运行时相同的 pycache 前缀（如果有的话）来运行它。

相对路径将解释为相对于当前工作目录。

该值的初值设置，依据 -X pycache_prefix=PATH 命令行选项或 PYTHONPYCACHEPREFIX 环境变量的值（命令行优先）。如果两者均未设置，则为 None。

3.8 新版功能.

sys.excepthook(type, value, traceback)

本函数会将所给的回溯和异常输出到 sys.stderr 中。

当抛出一个异常，且未被捕获时，解释器将调用 sys.excepthook 并带有三个参数：异常类、异常实例和一个回溯对象。在交互式会话中，这会在控制权返回到提示符之前发生。在 Python 程序中，这会在程序退出之前发生。如果要自定义此类顶级异常的处理过程，可以将另一个 3 个参数的函数赋给 sys.excepthook。

引发一个 审计事件 sys.excepthook，附带参数 hook, type, value, traceback。

参见

sys.unraisablehook() 函数处理无法抛出的异常，threading.excepthook() 函数处理 threading.Thread.run() 抛出的异常。

sys.__breakpointhook__

sys.__displayhook__

sys.__excepthook__

sys.__unraisablehook__

程序开始时，这些对象存有 breakpointhook、displayhook、excepthook 和 unraisablehook 的初始值。保存它们是为了可以在 breakpointhook、displayhook 和 excepthook、unraisablehook 被破坏或被替换时恢复它们。

3.7 新版功能: __breakpointhook__

3.8 新版功能: __unraisablehook__

sys.exc_info()

本函数返回的元组包含三个值，它们给出当前正在处理的异常的信息。返回的信息仅限于当前线程和当前堆栈帧。如果当前堆栈帧没有正在处理的异常，则信息将从下级被调用的堆栈帧或上级调用者等位置获取，依此类推，直到找到正在处理异常的堆栈帧为止。此处的“处理异常”指的是“执行 except 子句”。任何堆栈帧都只能访问当前正在处理的异常的信息。

如果整个堆栈都没有正在处理的异常，则返回包含三个 None 值的元组。否则返回值为 (type, value, traceback)。它们的含义是：type 是正在处理的异常类型（它是 BaseException 的子类）；value 是异常实例（异常类型的实例）；traceback 是一个 回溯对象，该对象封装了最初发生异常时的调用堆栈。

sys.exec_prefix

一个字符串，提供特定域的目录前缀，该目录中安装了与平台相关的 Python 文件，默认也是 '/usr/local'。该目录前缀可以在构建时使用 configure 脚本的 --exec-prefix 参数进行设置。具体而言，所有配置文件（如 pyconfig.h 头文件）都安装在目录 exec_prefix/lib/pythonX.Y/config 中，共享库模块安装在 exec_prefix/lib/pythonX.Y/lib-dynload 中，其中 X.Y 是 Python 的版本号，如 3.2。

注解

如果在一个 虚拟环境 中，那么该值将在 site.py 中被修改，指向虚拟环境。Python 安装位置仍然可以用 base_exec_prefix 来获取。

sys.executable

一个字符串，提供 Python 解释器的可执行二进制文件的绝对路径，仅在部分系统中此值有意义。如果 Python 无法获取其可执行文件的真实路径，则 sys.executable 将为空字符串或 None。

sys.exit([arg])

引发一个 SystemExit 异常，表示打算退出解释器。

可选参数 arg 可以是表示退出状态的整数（默认为 0），也可以是其他类型的对象。如果它是整数，则 shell 等将 0 视为“成功终止”，非零值视为“异常终止”。大多数系统要求该值的范围是 0--127，否则会产生不确定的结果。某些系统为退出代码约定了特定的含义，但通常尚不完善；Unix 程序通常用 2 表示命令行语法错误，用 1 表示所有其他类型的错误。传入其他类型的对象，如果传入 None 等同于传入 0，如果传入其他对象则将其打印至 stderr，且退出代码为 1。特别地，sys.exit("some error message") 可以在发生错误时快速退出程序。

由于 exit() 最终 "只" 引发了一个异常，它只在从主线程调用时退出进程，而异常不会被拦截。 try 语句的 finally 子句所指定的清理动作会被遵守，并且有可能在外层拦截退出的尝试。

在 3.6 版更改: 在 Python 解释器捕获 SystemExit 后，如果在清理中发生错误（如清除标准流中的缓冲数据时出错），则退出状态码将变为 120。

sys.flags

具名元组 flags 含有命令行标志的状态。这些属性是只读的。

attribute -- 属性 | 标志
debug | -d
inspect | -i
interactive | -i
isolated | -I
optimize | -O 或 -OO
dont_write_bytecode | -B
no_user_site | -s
no_site | -S
ignore_environment | -E
verbose | -v
bytes_warning | -b
quiet | -q
hash_randomization | -R
dev_mode | -X dev (Python 开发模式)
utf8_mode | -X utf8
int_max_str_digits | -X int_max_str_digits (integer string conversion length limitation)

在 3.2 版更改: 为新的 -q 标志添加了 quiet 属性

3.2.3 新版功能: hash_randomization 属性

在 3.3 版更改: 删除了过时的 division_warning 属性

在 3.4 版更改: 为 -I isolated 标志添加了 isolated 属性。

在 3.7 版更改: 为新的 Python 开发模式 添加了 dev_mode 属性，为新的 -X utf8 标志添加了 utf8_mode 属性。

在 3.10.7 版更改: 增加了 int_max_str_digits 属性。

sys.float_info

一个 具名元组，存有浮点型的相关信息。它包含的是关于精度和内部表示的底层信息。这些值与标准头文件 float.h 中为 C 语言定义的各种浮点常量对应，详情请参阅 1999 ISO/IEC C 标准 [C99] 的 5.2.4.2.2 节，'Characteristics of floating types（浮点型的特性）'。

attribute -- 属性 | float.h 宏 | 说明
epsilon | DBL_EPSILON | 大于 1.0 的最小值和 1.0 之间的差，表示为浮点数 另请参阅 math.ulp()。
dig | DBL_DIG | 浮点数可以真实表示的最大十进制数字；见下文
mant_dig | DBL_MANT_DIG | 浮点数精度：radix 基数下的浮点数有效位数
max | DBL_MAX | 可表示的最大正浮点数（非无穷）
max_exp | DBL_MAX_EXP | 使得 radix**(e-1) 是可表示的浮点数（非无穷）的最大整数 e
max_10_exp | DBL_MAX_10_EXP | 使得 10**e 在可表示的浮点数（非无穷）范围内的最大整数 e
min | DBL_MIN | 可表示的最小正 规格化 浮点数 使用 math.ulp(0.0) 获取可表示的最小正 非规格化 浮点数
min_exp | DBL_MIN_EXP | 使得 radix**(e-1) 是规格化浮点数的最小整数 e
min_10_exp | DBL_MIN_10_EXP | 使得 10**e 是规格化浮点数的最小整数 e
radix | FLT_RADIX | 指数表示法中采用的基数
rounds | FLT_ROUNDS | 代表浮点算术舍入模式的整数。 这反映了在解释器启动时系统 FLT_ROUNDS 宏的值: -1 为不确定, 0 为向零舍入, 1 为向最接近的值舍入, 2 为向正无穷大舍入, 3 为向负无穷大舍入 FLT_ROUNDS 的所有其他值被用于代表具体实现所定义的舍入行为。

关于 sys.float_info.dig 属性的进一步说明。如果 s 是表示十进制数的字符串，而该数最多有 sys.float_info.dig 位有效数字，则将 s 转换为 float 再转回去将恢复原先相同十进制值的字符串:

>>> import sys
>>> sys.float_info.dig
15
>>> s = '3.14159265358979'    # decimal string with 15 significant digits
>>> format(float(s), '.15g')  # convert to float and back -> same value
'3.14159265358979'

但是对于超过 sys.float_info.dig 位有效数字的字符串，转换前后并非总是相同:

>>> s = '9876543211234567'    # 16 significant digits is too many!
>>> format(float(s), '.16g')  # conversion changes value
'9876543211234568'

sys.float_repr_style

一个字符串，反映 repr() 函数在浮点数上的行为。如果该字符串是 'short'，那么对于（非无穷的）浮点数 x，repr(x) 将会生成一个短字符串，满足 float(repr(x)) == x 的特性。这是 Python 3.1 及更高版本中的常见行为。否则 float_repr_style 的值将是 'legacy'，此时 repr(x) 的行为方式将与 Python 3.1 之前的版本相同。

3.1 新版功能.

sys.getallocatedblocks()

返回解释器当前已分配的内存块数，无论它们大小如何。本函数主要用于跟踪和调试内存泄漏。因为解释器有内部缓存，所以不同调用之间结果会变化。可能需要调用 _clear_type_cache() 和 gc.collect() 使结果更容易预测。

如果当前 Python 构建或实现无法合理地计算此信息，允许 getallocatedblocks() 返回 0。

3.4 新版功能.

sys.getandroidapilevel()

返回一个整数，表示 Android 构建时 API 版本。

可用性：Android。

3.7 新版功能.

sys.getdefaultencoding()

返回当前 Unicode 实现所使用的默认字符串编码格式名称。

sys.getdlopenflags()

返回当前 dlopen() 调用所使用的标志位的值。标志值对应的符号名称可以在 os 模块中找到（形如 RTLD_xxx 的常量，如 os.RTLD_LAZY ）。

可用性: Unix。

sys.getfilesystemencoding()

获取 文件系统编码格式: 该编码格式与 文件系统错误处理器 一起使用以便在 Unicode 文件名和字节文件名之间进行转换。 文件系统错误处理器是从 getfilesystemencodeerrors() 返回的。

为获得最佳兼容性，在任何时候都应使用 str 来表示文件名，尽管使用 bytes 来表示文件名也是受支持的。 接受还返回文件名的函数应当支持 str 或 bytes 并在内部将其转换为系统首选的表示形式。

应使用 os.fsencode() 和 os.fsdecode() 来保证所采用的编码和错误处理方案都是正确的。

filesystem encoding and error handler 是在 Python 启动时通过 PyConfig_Read() 函数来配置的：请参阅 PyConfig 的 filesystem_encoding 和 filesystem_errors 等成员。

在 3.2 版更改: getfilesystemencoding() 的结果将不再有可能是 None。

在 3.6 版更改: Windows 不再保证会返回 'mbcs'。详情请参阅 PEP 529 [https://www.python.org/dev/peps/pep-0529] 和 _enablelegacywindowsfsencoding()。

在 3.7 版更改: 返回 'utf-8'，如果启用了 Python UTF-8 模式 的话。

sys.getfilesystemencodeerrors()

获取 文件系统错误处理器: 该错误处理器与 文件系统编码格式 一起使用以便在 Unicode 文件名和字节文件名之间进程转换。 文件系统编码格式是由 getfilesystemencoding() 来返回的。

应使用 os.fsencode() 和 os.fsdecode() 来保证所采用的编码和错误处理方案都是正确的。

filesystem encoding and error handler 是在 Python 启动时通过 PyConfig_Read() 函数来配置的：请参阅 PyConfig 的 filesystem_encoding 和 filesystem_errors 等成员。

3.6 新版功能.

sys.get_int_max_str_digits()

返回 整数字符串转换长度限制 的当前值。 另请参阅 set_int_max_str_digits()。

3.10.7 新版功能.

sys.getrefcount(object)

返回 object 的引用计数。返回的计数通常比预期的多一，因为它包括了作为 getrefcount() 参数的这一次（临时）引用。

Note that the returned value may not actually reflect how many references to the object are actually held. Consequently, do not rely on the returned value to be accurate, other than a value of 0 or 1.

sys.getrecursionlimit()

返回当前的递归限制值，即 Python 解释器堆栈的最大深度。此限制可防止无限递归导致的 C 堆栈溢出和 Python 崩溃。该值可以通过 setrecursionlimit() 设置。

sys.getsizeof(object[, default])

返回对象的大小（以字节为单位）。该对象可以是任何类型。所有内建对象返回的结果都是正确的，但对于第三方扩展不一定正确，因为这与具体实现有关。

只计算直接分配给对象的内存消耗，不计算它所引用的对象的内存消耗。

对象不提供计算大小的方法时，如果传入过 default 则返回它，否则抛出 TypeError 异常。

如果对象由垃圾回收器管理，则 getsizeof() 将调用对象的 __sizeof__ 方法，并在上层添加额外的垃圾回收器。

可以参考 recursive sizeof recipe [https://code.activestate.com/recipes/577504] 中的示例，关于递归调用 getsizeof() 来得到各个容器及其所有内容物的大小。

sys.getswitchinterval()

返回解释器的“线程切换间隔时间”，请参阅 setswitchinterval()。

3.2 新版功能.

sys._getframe([depth])

返回来自调用栈的一个帧对象。如果传入可选整数 depth，则返回从栈顶往下相应调用层数的帧对象。如果该数比调用栈更深，则抛出 ValueError。depth 的默认值是 0，返回调用栈顶部的帧。

引发一个 审计事件 sys._getframe，没有附带参数。

CPython 实现细节： 这个函数应该只在内部为了一些特定的目的使用。不保证它在所有 Python 实现中都存在。

sys.getprofile()

返回由 setprofile() 设置的性能分析函数。

sys.gettrace()

返回由 settrace() 设置的跟踪函数。

CPython 实现细节： gettrace() 函数仅用于实现调试器，性能分析器，打包工具等。它的行为是实现平台的一部分，而不是语言定义的一部分，因此并非在所有 Python 实现中都可用。

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 包含一个三元组，其他所有值都是整数。元素也可以通过名称来访问，所以 sys.getwindowsversion()[0] 与 sys.getwindowsversion().major 是等效的。为保持与旧版本的兼容性，只有前 5 个元素可以用索引检索。

platform 将会是 2 (VER_PLATFORM_WIN32_NT)。

product_type 可能是以下值之一：

常量 | 含意
1 (VER_NT_WORKSTATION) | 系统是工作站。
2 (VER_NT_DOMAIN_CONTROLLER) | 系统是域控制器。
3 (VER_NT_SERVER) | 系统是服务器，但不是域控制器。

本函数包装了 Win32 GetVersionEx() 函数，参阅 Microsoft 文档有关 OSVERSIONINFOEX() 的内容可获取这些字段的更多信息。

platform_version 返回当前操作系统的主要版本、次要版本和编译版本号，而不是为该进程所模拟的版本。 它旨在用于日志记录而非特性检测。

注解

platform_version 会从 kernel32.dll 获取版本号，这个版本可能与 OS 版本不同。 请使用 platform 模块来获取准确的 OS 版本号。

可用性: Windows。

在 3.2 版更改: 更改为具名元组，添加 service_pack_minor, service_pack_major, suite_mask 和 product_type。

在 3.6 版更改: 添加了 platform_version

sys.get_asyncgen_hooks()

返回一个 asyncgen_hooks 对象，该对象类似于 (firstiter, finalizer) 形式的 namedtuple，其中 firstiter 和 finalizer 应为 None 或是一个接受 asynchronous generator iterator 作为参数的函数，并被用来在事件循环中调度异步生成器的最终化。

3.6 新版功能: 详情请参阅 PEP 525 [https://www.python.org/dev/peps/pep-0525]。

注解

本函数已添加至暂定软件包（详情请参阅 PEP 411 [https://www.python.org/dev/peps/pep-0411] ）。

sys.get_coroutine_origin_tracking_depth()

获取由 set_coroutine_origin_tracking_depth() 设置的协程来源的追踪深度。

3.7 新版功能.

注解

本函数已添加至暂定软件包（详情请参阅 PEP 411 [https://www.python.org/dev/peps/pep-0411] ）。仅将其用于调试目的。

sys.hash_info

一个 具名元组，给出数字类型的哈希的实现参数。关于数字类型的哈希的详情请参阅 数字类型的哈希运算。

attribute -- 属性 | 说明
width | 用于哈希值的位宽度
modulus | 用于数字散列方案的素数模数P。
inf | 为正无穷大返回的哈希值
nan | （该属性已不再被使用）
imag | 用于复数虚部的乘数
algorithm | 字符串、字节和内存视图的哈希算法的名称
hash_bits | 哈希算法的内部输出大小。
seed_bits | 散列算法的种子密钥的大小

3.2 新版功能.

在 3.4 版更改: 添加了 algorithm, hash_bits 和 seed_bits

sys.hexversion

编码为单个整数的版本号。该整数会确保每个版本都自增，其中适当包括了未发布版本。举例来说，要测试 Python 解释器的版本不低于 1.5.2，请使用:

if sys.hexversion >= 0x010502F0:
    # use some advanced feature
    ...
else:
    # use an alternative implementation or warn the user
    ...

之所以称它为 hexversion，是因为只有将它传入内置函数 hex() 后，其结果才看起来有意义。也可以使用 具名元组 sys.version_info，它对相同信息有着更人性化的编码。

关于 hexversion 的更多信息可以在 API 和 ABI 版本管理 中找到。

sys.implementation

一个对象，该对象包含当前运行的 Python 解释器的实现信息。所有 Python 实现中都必须存在下列属性。

name 是当前实现的标识符，如 'cpython'。实际的字符串由 Python 实现定义，但保证是小写字母。

version 是一个具名元组，格式与 sys.version_info 相同。它表示 Python 实现 的版本。 另一个（由 sys.version_info 表示）是当前解释器遵循的相应 Python 语言 的版本，两者具有不同的含义。 例如，对于 PyPy 1.8，sys.implementation.version 可能是 sys.version_info(1, 8, 0, 'final', 0)，而 sys.version_info 则是 sys.version_info(2, 7, 2, 'final', 0)。对于 CPython 而言两个值是相同的，因为它是参考实现。

hexversion 是十六进制的实现版本，类似于 sys.hexversion。

cache_tag 是导入机制使用的标记，用于已缓存模块的文件名。按照惯例，它将由实现的名称和版本组成，如 'cpython-33'。但如果合适，Python 实现可以使用其他值。如果 cache_tag 被置为 None，表示模块缓存已禁用。

sys.implementation 可能包含相应 Python 实现的其他属性。这些非标准属性必须以下划线开头，此处不详细阐述。无论其内容如何，sys.implementation 在解释器运行期间或不同实现版本之间都不会更改。（但是不同 Python 语言版本间可能会不同。）详情请参阅 PEP 421 [https://www.python.org/dev/peps/pep-0421]。

3.3 新版功能.

注解

新的必要属性的添加必须经过常规的 PEP 过程。详情请参阅 PEP 421 [https://www.python.org/dev/peps/pep-0421]。

sys.int_info

一个 具名元组，包含 Python 内部整数表示形式的信息。这些属性是只读的。

属性 | 说明
bits_per_digit | 每个数字占有的位数。Python 内部将整数存储在基底 2**int_info.bits_per_digit
sizeof_digit | 用于表示数字的C类型的字节大小
default_max_str_digits | sys.get_int_max_str_digits() 在未被显式配置时将使用的默认值。
str_digits_check_threshold | sys.set_int_max_str_digits(), PYTHONINTMAXSTRDIGITS 或 -X int_max_str_digits 的最小非零值。

3.1 新版功能.

在 3.10.7 版更改: 增加了 default_max_str_digits 和 str_digits_check_threshold。

sys.__interactivehook__

当本属性存在，则以 交互模式 启动解释器时，将自动（不带参数地）调用本属性的值。该过程是在读取 PYTHONSTARTUP 文件之后完成的，所以可以在该文件中设置这一钩子。site 模块 设置了这一属性。

引发一个 审计事件 cpython.run_interactivehook，附带参数 hook。

3.4 新版功能.

sys.intern(string)

将 string 插入 "interned" （驻留）字符串表，返回被插入的字符串 -- 它是 string 本身或副本。驻留字符串对提高字典查找的性能很有用 -- 如果字典中的键已驻留，且所查找的键也已驻留，则键（取散列后）的比较可以用指针代替字符串来比较。通常，Python 程序使用到的名称会被自动驻留，且用于保存模块、类或实例属性的字典的键也已驻留。

驻留字符串不是永久存在的，对 intern() 返回值的引用必须保留下来，才能发挥驻留字符串的优势。

sys.is_finalizing()

如果 Python 解释器 正在关闭 则返回 True，否则返回 False。

3.5 新版功能.

sys.last_type

sys.last_value

sys.last_traceback

这三个变量并非总是有定义，仅当有异常未处理，且解释器打印了错误消息和堆栈回溯时，才会给它们赋值。它们的预期用途，是允许交互中的用户导入调试器模块，进行事后调试，而不必重新运行导致错误的命令。（通常使用 import pdb; pdb.pm() 进入事后调试器，详情请参阅 pdb 模块。）

这些变量的含义与上述 exc_info() 返回值的含义相同。

sys.maxsize

一个整数，表示 Py_ssize_t 类型的变量可以取到的最大值。在 32 位平台上通常为 2**31 - 1，在 64 位平台上通常为 2**63 - 1。

sys.maxunicode

一个整数，表示最大的 Unicode 码点值，如 1114111 （十六进制为 0x10FFFF ）。

在 3.3 版更改: 在 PEP 393 [https://www.python.org/dev/peps/pep-0393] 之前，sys.maxunicode 曾是 0xFFFF 或 0x10FFFF，具体取决于配置选项，该选项指定将 Unicode 字符存储为 UCS-2 还是 UCS-4。

sys.meta_path

一个由 元路径查找器 对象组成的列表，将会调用这些对象的 find_spec() 方法来确定其中的某个对象能否找到要导入的模块。 在默认情况下，它将存放实现了 Python 默认导入语法的条目。 调用 find_spec() 方法至少需要附带待导入模块的绝对名称。 如果待导入模块包含在一个包中，则父包的 __path__ 属性将作为第二个参数被传入。 此方法将返回一个 模块规格说明，或者如果找不到模块则返回 None。

参见

importlib.abc.MetaPathFinder

抽象基类，定义了 meta_path 内的查找器对象的接口。

importlib.machinery.ModuleSpec

find_spec() 返回的实例所对应的具体类。

在 3.4 版更改: 在 Python 3.4 中通过 PEP 451 [https://www.python.org/dev/peps/pep-0451] 引入了 模块规格。早期版本的 Python 会寻找一个称为 find_module() 的方法。如果某个 meta_path 条目没有 find_spec() 方法，就会回退去调用前一种方法。

sys.modules

这是一个字典，它将模块名称映射到已经被加载的模块。 这可以被操纵来强制重新加载模块和其他技巧。然而，替换这个字典不一定会像预期的那样工作，从字典中删除重要的项目可能会导致 Python 出错。 如果你想对这个全局字典进行迭代，一定要使用 sys.modules.copy() 或 tuple(sys.modules) 来避免异常，因为它的大小在迭代过程中可能会因为其他线程中的代码或活动的副作用而改变。

sys.orig_argv

传给 Python 可执行文件的原始命令行参数列表。

另请参阅 sys.argv。

3.10 新版功能.

sys.path

一个由字符串组成的列表，用于指定模块的搜索路径。初始化自环境变量 PYTHONPATH，再加上一条与安装有关的默认路径。

程序启动时将初始化本列表，列表的第一项 path[0] 目录含有调用 Python 解释器的脚本。如果脚本目录不可用（比如以交互方式调用了解释器，或脚本是从标准输入中读取的），则 path[0] 为空字符串，这将导致 Python 优先搜索当前目录中的模块。注意，脚本目录将插入在 PYTHONPATH 的条目*之前*。

程序可以随意修改本列表用于自己的目的。只能向 sys.path 中添加 string 和 bytes 类型，其他数据类型将在导入期间被忽略。

参见

site 模块，该模块描述了如何使用 .pth 文件来扩展 sys.path。

sys.path_hooks

一个由可调用对象组成的列表，这些对象接受一个路径作为参数，并尝试为该路径创建一个 查找器。如果成功创建查找器，则可调用对象将返回它，否则将引发 ImportError 异常。

本特性最早在 PEP 302 [https://www.python.org/dev/peps/pep-0302] 中被提及。

sys.path_importer_cache

一个字典，作为 查找器 对象的缓存。key 是传入 sys.path_hooks 的路径，value 是相应已找到的查找器。如果路径是有效的文件系统路径，但在 sys.path_hooks 中未找到查找器，则存入 None。

本特性最早在 PEP 302 [https://www.python.org/dev/peps/pep-0302] 中被提及。

在 3.3 版更改: 未找到查找器时，改为存储 None，而不是 imp.NullImporter。

sys.platform

本字符串是一个平台标识符，举例而言，该标识符可用于将特定平台的组件追加到 sys.path 中。

对于 Unix 系统（除 Linux 和 AIX 外），该字符串是 Python 构建时的 uname -s 返回的小写操作系统名称，并附加了 uname -r 返回的系统版本的第一部分，如 'sunos5' 或 'freebsd8'。除非需要检测特定版本的系统，否则建议使用以下习惯用法:

if sys.platform.startswith('freebsd'):
    # FreeBSD-specific code here...
elif sys.platform.startswith('linux'):
    # Linux-specific code here...
elif sys.platform.startswith('aix'):
    # AIX-specific code here...

对于其他系统，值是：

系统 | 平台 值
AIX | 'aix'
Linux | 'linux'
Windows | 'win32'
Windows/Cygwin | 'cygwin'
macOS | 'darwin'

在 3.3 版更改: 在 Linux 上，sys.platform 将不再包含副版本号。它将总是 'linux' 而不是 'linux2' 或 'linux3'。由于旧版本的 Python 会包含该版本号，因此推荐总是使用上述 startswith 习惯用法。

在 3.8 版更改: 在 AIX 上，sys.platform 将不再包含副版本号。它将总是 'aix' 而不是 'aix5' 或 'aix7'。由于旧版本的 Python 会包含该版本号，因此推荐总是使用上述 startswith 习惯用法。

参见

os.name 更加简略。os.uname() 提供系统的版本信息。

platform 模块对系统的标识有更详细的检查。

sys.platlibdir

平台专用库目录。用于构建标准库的路径和已安装扩展模块的路径。

在大多数平台上，它等同于 "lib" 。在 Fedora 和 SuSE 上，它等同于给出了以下 sys.path 路径的 64 位平台上的 "lib64" （其中 X.Y 是 Python 的 major.minor 版本）。

/usr/lib64/pythonX.Y/：标准库（如 os 模块的 os.py ）

/usr/lib64/pythonX.Y/lib-dynload/：标准库的 C 扩展模块（如 errno 模块，确切的文件名取决于平台）

/usr/lib/pythonX.Y/site-packages/ (请使用 lib, 而非 sys.platlibdir): 第三方模块

/usr/lib64/pythonX.Y/site-packages/: 第三方包的 C 扩展模块

3.9 新版功能.

sys.prefix

一个指定用于安装与平台无关的 Python 文件的站点专属目录前缀的字符串；在 Unix 上，默认为 /usr/local。 这可以在构建时通过将 --prefix 参数传入 configure 脚本来设置。 请参阅 安装路径 了解衍生的路径。

注解

如果在一个 虚拟环境 中，那么该值将在 site.py 中被修改，指向虚拟环境。Python 安装位置仍然可以用 base_prefix 来获取。

sys.ps1

sys.ps2

字符串，指定解释器的首要和次要提示符。仅当解释器处于交互模式时，它们才有定义。这种情况下，它们的初值为 '>>> ' 和 '... '。如果赋给其中某个变量的是非字符串对象，则每次解释器准备读取新的交互式命令时，都会重新运行该对象的 str()，这可以用来实现动态的提示符。

sys.setdlopenflags(n)

设置解释器在调用 dlopen() 时用到的标志，例如解释器在加载扩展模块时。首先，调用 sys.setdlopenflags(0) 将在导入模块时对符号启用惰性解析。要在扩展模块之间共享符号，请调用 sys.setdlopenflags(os.RTLD_GLOBAL)。标志值的符号名称可以在 os 模块中找到（即 RTLD_xxx 常量，如 os.RTLD_LAZY ）。

可用性: Unix。

sys.set_int_max_str_digits(maxdigits)

设置解释器所使用的 整数字符串转换长度限制。 另请参阅 get_int_max_str_digits()。

3.10.7 新版功能.

sys.setprofile(profilefunc)

设置系统的性能分析函数，该函数使得在 Py​​thon 中能够实现一个 Python 源代码性能分析器。关于 Python Profiler 的更多信息请参阅 Python 性能分析器 章节。性能分析函数的调用方式类似于系统的跟踪函数（参阅 settrace() ），但它是通过不同的事件调用的，例如，不是每执行一行代码就调用它一次（仅在调用某函数和从某函数返回时才会调用性能分析函数，但即使某函数发生异常也会算作返回事件）。该函数是特定于单个线程的，但是性能分析器无法得知线程之间的上下文切换，因此在存在多个线程的情况下使用它是没有意义的。另外，因为它的返回值不会被用到，所以可以简单地返回 None。性能分析函数中的错误将导致其自身被解除设置。

性能分析函数应接收三个参数：frame、event 和 arg。frame 是当前的堆栈帧。event 是一个字符串：'call'、'return'、'c_call'、'c_return' 或 'c_exception'。arg 取决于事件类型。

引发一个不带参数的 审计事件 sys.setprofile。

这些事件具有以下含义：

'call'

表示调用了某个函数（或进入了其他的代码块）。性能分析函数将被调用，arg 为 None。

'return'

表示某个函数（或别的代码块）即将返回。性能分析函数将被调用，arg 是即将返回的值，如果此次返回事件是由于抛出异常，arg 为 None。

'c_call'

表示即将调用某个 C 函数。它可能是扩展函数或是内建函数。arg 是 C 函数对象。

'c_return'

表示返回了某个 C 函数。arg 是 C 函数对象。

'c_exception'

表示某个 C 函数抛出了异常。arg 是 C 函数对象。

sys.setrecursionlimit(limit)

将 Python 解释器堆栈的最大深度设置为 limit。此限制可防止无限递归导致的 C 堆栈溢出和 Python 崩溃。

不同平台所允许的最高限值不同。当用户有需要深度递归的程序且平台支持更高的限值，可能就需要调高限值。进行该操作需要谨慎，因为过高的限值可能会导致崩溃。

如果新的限值低于当前的递归深度，将抛出 RecursionError 异常。

在 3.5.1 版更改: 如果新的限值低于当前的递归深度，现在将抛出 RecursionError 异常。

sys.setswitchinterval(interval)

设置解释器的线程切换间隔时间（单位为秒）。该浮点数决定了“时间片”的理想持续时间，时间片将分配给同时运行的 Python 线程。请注意，实际值可能更高，尤其是使用了运行时间长的内部函数或方法时。同时，在时间间隔末尾调度哪个线程是操作系统的决定。解释器没有自己的调度程序。

3.2 新版功能.

sys.settrace(tracefunc)

设置系统的跟踪函数，使得用户在 Python 中就可以实现 Python 源代码调试器。该函数是特定于单个线程的，所以要让调试器支持多线程，必须为正在调试的每个线程都用 settrace() 注册一个跟踪函数，或使用 threading.settrace()。

跟踪函数应接收三个参数：frame、event 和 arg。frame 是当前的堆栈帧。event 是一个字符串：'call'、'line'、'return'、'exception' 或 'opcode'。arg 取决于事件类型。

每次进入 trace 函数的新的局部作用范围，都会调用 trace 函数（ event 会被设置为 'call' ），它应该返回一个引用，指向即将用在新作用范围上的局部跟踪函数；如果不需要跟踪当前的作用范围，则返回 None。

局部跟踪函数应返回对自身的引用（或对另一个函数的引用，用来在其作用范围内进行进一步的跟踪），或者返回 None 来停止跟踪其作用范围。

如果跟踪函数出错，则该跟踪函数将被取消设置，类似于调用 settrace(None)。

这些事件具有以下含义：

'call'

表示调用了某个函数（或进入了其他的代码块）。全局跟踪函数将被调用，arg 为 None。返回值将指定局部跟踪函数。

'line'

表示解释器即将执行新一行代码或重新执行循环条件。局部跟踪函数将被调用，arg 为 None，其返回值将指定新的局部跟踪函数。关于其工作原理的详细说明，请参见 Objects/lnotab_notes.txt。要在该堆栈帧禁用每行触发事件，可以在堆栈帧上将 f_trace_lines 设置为 False。

'return'

表示某个函数（或别的代码块）即将返回。局部跟踪函数将被调用，arg 是即将返回的值，如果此次返回事件是由于抛出异常，arg 为 None。跟踪函数的返回值将被忽略。

'exception'

表示发生了某个异常。局部跟踪函数将被调用，arg 是一个 (exception, value, traceback) 元组，返回值将指定新的局部跟踪函数。

'opcode'

表示解释器即将执行一个新的操作码（操作码的详情请参阅 dis ）。局部跟踪函数将被调用，arg 为 None，其返回值将指定新的局部跟踪函数。每操作码触发事件默认情况下都不发出：必须在堆栈帧上将 f_trace_opcodes 显式地设置为 True 来请求这些事件。

注意，由于异常是在链式调用中传播的，所以每一级都会产生一个 'exception' 事件。

更细微的用法是，可以显式地通过赋值 frame.f_trace = tracefunc 来设置跟踪函数，而不是用现有跟踪函数的返回值去间接设置它。当前帧上的跟踪函数必须激活，而 settrace() 还没有做这件事。注意，为了使上述设置起效，必须使用 settrace() 来安装全局跟踪函数才能启用运行时跟踪机制，但是它不必与上述是同一个跟踪函数（它可以是一个开销很低的跟踪函数，只返回 None，即在各个帧上立即将其自身禁用）。

关于代码对象和帧对象的更多信息请参考 标准类型层级结构。

引发一个不带参数的 审计事件 sys.settrace。

CPython 实现细节： settrace() 函数仅用于实现调试器，性能分析器，打包工具等。它的行为是实现平台的一部分，而不是语言定义的一部分，因此并非在所有 Python 实现中都可用。

在 3.7 版更改: 添加了 'opcode' 事件类型；为帧对象添加了 f_trace_lines 和 f_trace_opcodes 属性

sys.set_asyncgen_hooks(firstiter, finalizer)

接受两个可选的关键字参数，要求它们是可调用对象，且接受一个 异步生成器迭代器 作为参数。firstiter 对象将在异步生成器第一次迭代时调用。finalizer 将在异步生成器即将被销毁时调用。

引发一个不带参数的 审计事件 sys.set_asyncgen_hooks_firstiter。

引发一个不带参数的 审计事件 sys.set_asyncgen_hooks_finalizer。

之所以会引发两个审计事件，是因为底层的 API 由两个调用组成，每个调用都须要引发自己的事件。

3.6 新版功能: 更多详情请参阅 PEP 525 [https://www.python.org/dev/peps/pep-0525]，finalizer 方法的参考示例可参阅 Lib/asyncio/base_events.py [https://github.com/python/cpython/tree/3.10/Lib/asyncio/base_events.py] 中 asyncio.Loop.shutdown_asyncgens 的实现。

注解

本函数已添加至暂定软件包（详情请参阅 PEP 411 [https://www.python.org/dev/peps/pep-0411] ）。

sys.set_coroutine_origin_tracking_depth(depth)

用于启用或禁用协程溯源。启用后，协程对象上的 cr_origin 属性将包含一个元组，它由多个（文件名 filename，行号 line number，函数名 function name）元组组成，整个元组描述出了协程对象创建过程的回溯，元组首端是最近一次的调用。禁用后，cr_origin 将为 None。

要启用，请向 depth 传递一个大于零的值，它指定了有多少帧将被捕获信息。要禁用，请将 depth 置为零。

该设置是特定于单个线程的。

3.7 新版功能.

注解

本函数已添加至暂定软件包（详情请参阅 PEP 411 [https://www.python.org/dev/peps/pep-0411] ）。仅将其用于调试目的。

sys._enablelegacywindowsfsencoding()

将 filesystem encoding and error handler 分别修改为 'mbcs' 和 'replace'，以便与 3.6 之前版本的 Python 保持一致。

这等同于在启动 Python 前先定义好 PYTHONLEGACYWINDOWSFSENCODING 环境变量。

另请参阅 sys.getfilesystemencoding() 和 sys.getfilesystemencodeerrors()。

可用性: Windows。

3.6 新版功能: 更多详情请参阅 PEP 529 [https://www.python.org/dev/peps/pep-0529]。

sys.stdin

sys.stdout

sys.stderr

解释器用于标准输入、标准输出和标准错误的 文件对象：

stdin 用于所有交互式输入（包括对 input() 的调用）；

stdout 用于 print() 和 expression 语句的输出，以及用于 input() 的提示符；

解释器自身的提示符和它的错误消息都发往 stderr。

这些流都是常规 文本文件，与 open() 函数返回的对象一致。它们的参数选择如下：

编码格式和错误处理器是由 PyConfig.stdio_encoding 和 PyConfig.stdio_errors 来初始化的。

在 Windows 上，控制台设备使用 UTF-8。 非字符设备如磁盘文件和管道使用系统语言区域编码格式（例如 ANSI 代码页）。 非控制台字符设备如 NUL（例如当 isatty() 返回 True 时）会在启动时分别让 stdin 和 stdout/stderr 使用控制台输入和输出代码页。 如果进程初始化时没有被附加到控制台则会使用默认的系统 locale encoding。

要重写控制台的特殊行为，可以在启动 Python 前设置 PYTHONLEGACYWINDOWSSTDIO 环境变量。此时，控制台代码页将用于其他字符设备。

在所有平台上，都可以通过在 Python 启动前设置 PYTHONIOENCODING 环境变量来重写字符编码，或通过新的 -X utf8 命令行选项和 PYTHONUTF8 环境变量来设置。但是，对 Windows 控制台来说，上述方法仅在设置了 PYTHONLEGACYWINDOWSSTDIO 后才起效。

交互模式下，stdout 流是行缓冲的。其他情况下，它像常规文本文件一样是块缓冲的。两种情况下的 stderr 流都是行缓冲的。要使得两个流都变成无缓冲，可以传入 -u 命令行选项或设置 PYTHONUNBUFFERED 环境变量。

在 3.9 版更改: 非交互模式下，stderr 现在是行缓冲的，而不是全缓冲的。

注解

要从标准流写入或读取二进制数据，请使用底层二进制 buffer 对象。例如，要将字节写入 stdout，请使用 sys.stdout.buffer.write(b'abc')。

但是，如果你在写一个库（并且不限制执行库代码时的上下文），那么请注意，标准流可能会被替换为文件类对象，如 io.StringIO，它们是不支持 buffer 属性的。

sys.__stdin__

sys.__stdout__

sys.__stderr__

程序开始时，这些对象存有 stdin、stderr 和 stdout 的初始值。它们在程序结束前都可以使用，且在需要向实际的标准流打印内容时很有用，无论 sys.std* 对象是否已重定向。

如果实际文件已经被覆盖成一个损坏的对象了，那它也可用于将实际文件还原成能正常工作的文件对象。但是，本过程的最佳方法应该是，在原来的流被替换之前就显式地保存它，并使用这一保存的对象来还原。

注解

某些情况下的 stdin、stdout 和 stderr 以及初始值 __stdin__、__stdout__ 和 __stderr__ 可以是 None。通常发生在未连接到控制台的 Windows GUI app 中，以及在用 pythonw 启动的 Python app 中。

sys.stdlib_module_names

一个包含标准库模组名称字符串的冻结集合。

它在所有平台上都保持一致。 在某些平台上不可用的模块和在 Python 编译时被禁用的模块也会被列出。 所有种类的模块都会被列出：纯 Python 模块、内置模块、冻结模块和扩展模块等。 测试模块则会被排除掉。

对于包来说，仅会列出主包：子包和子模块不会被列出。 例如，email 包会被列出，但 email.mime 子包和 email.message 子模块不会被列出。

另请参阅 sys.builtin_module_names 列表。

3.10 新版功能.

sys.thread_info

一个 具名元组，包含线程实现的信息。

属性 | 说明

name

线程实现的名称：

'nt': Windows 线程

'pthread': POSIX 线程

'solaris': Solaris 线程

lock

锁实现的名称：

'semaphore': 锁使用信号量

'mutex+cond': 锁使用互斥和条件变量

None 如果此信息未知

version | 线程库的名称和版本。它是一个字符串，如果此信息未知，则为 None 。

3.3 新版功能.

sys.tracebacklimit

当该变量值设置为整数，在发生未处理的异常时，它将决定打印的回溯信息的最大层级数。默认为 1000。当将其设置为 0 或小于 0，将关闭所有回溯信息，并且只打印异常类型和异常值。

sys.unraisablehook(unraisable, /)

处理一个无法抛出的异常。

它会在发生了一个异常但 Python 没有办法处理时被调用。例如，当一个析构器引发了异常，或在垃圾回收 (gc.collect()) 期间引发了异常。

unraisable 参数具有以下属性:

exc_type: 异常类型

exc_value: 异常值，可以是 None.

exc_traceback: 异常回溯，可以是 None.

err_msg: 错误信息，可以是 None.

object: 导致异常的对象，可以为 None.

默认的钩子程序会将 err_msg 和 object 格式化为： f'{err_msg}: {object!r}'；如果 err_msg 为 None 则采用 "Exception ignored in" 错误信息。

要改变无法抛出的异常的处理过程，可以重写 sys.unraisablehook()。

使用定制钩子存放 exc_value 可能会创建引用循环。 它应当在不再需要异常时被显式地清空以打破引用循环。

如果一个 object 正在被销毁，那么使用自定义的钩子储存该对象可能会将其复活。请在自定义钩子生效后避免储存 object，以避免对象的复活。

另请参阅 excepthook()，它处理未捕获的异常。

引发一个审计事件 sys.unraisablehook 并附带参数 hook, unraisable。

3.8 新版功能.

sys.version

一个包含 Python 解释器版本号加编译版本号以及所用编译器等额外信息的字符串。 此字符串会在交互式解释器启动时显示。 请不要从中提取版本信息，而应当使用 version_info 以及 platform 模块所提供的函数。

sys.api_version

这个解释器的 C API 版本。当你在调试 Python及期扩展模板的版本冲突这个功能非常有用。

sys.version_info

一个包含版本号五部分的元组: major, minor, micro, releaselevel 和 serial。 除 releaselevel 外的所有值均为整数；发布级别值则为 'alpha', 'beta', 'candidate' 或 'final'。 对应于 Python 版本 2.0 的 version_info 值为 (2, 0, 0, 'final', 0)。 这些部分也可按名称访问，因此 sys.version_info[0] 就等价于 sys.version_info.major，依此类推。

在 3.1 版更改: 增加了以名称表示的各部分属性。

sys.warnoptions

这是警告框架的一个实现细节；请不要修改此值。 有关警告框架的更多信息请参阅 warnings 模块。

sys.winver

用于在 Windows 平台上作为注册表键的版本号。这在 Python DLL 中被存储为 1000 号字符串资源。 其值通常是正在运行的 Python 解释器的主要和次要版本号。 它在 sys 模块中提供是为了信息展示目的；修改此值不会影响 Python 所使用的注册表键。

可用性: Windows。

sys._xoptions

一个字典，包含通过 -X 命令行选项传递的旗标，这些旗标专属于各种具体实现。选项名称将会映射到对应的值（如果显式指定）或者 True。例如:

$ ./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}

CPython 实现细节： 这是 CPython 专属的访问通过 -X 传递的选项的方式。 其他实现可能会通过其他方式导出它们，或者完全不导出。

3.2 新版功能.

引用

C99

ISO/IEC 9899:1999. "Programming languages -- C." 该标准的公开草案可从 https://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf 获得。

sysconfig —— 提供对 Python 配置信息的访问支持

3.2 新版功能.

源代码： Lib/sysconfig.py [https://github.com/python/cpython/tree/3.10/Lib/sysconfig.py]

sysconfig 模块提供了对 Python 配置信息的访问支持，比如安装路径列表和有关当前平台的配置变量。

配置变量

Python 的发行版中包含一个 Makefile 和一个 pyconfig.h 头文件，这是构建 Python 二进制文件本身和用 distutils 编译的第三方 C 语言扩展所必需的。

sysconfig 将这些文件中的所有变量放在一个字典对象中，可用 get_config_vars() 或 get_config_var() 访问。

请注意在 Windows 上，这是一个小得多的集合。

sysconfig.get_config_vars(*args)

不带参数时，返回一个与当前平台相关的所有配置变量的字典。

带参数时，返回一个由在配置变量字典中查找每个参数的结果的值组成的列表。

对于每个参数，如果未找到值，则返回 None。

sysconfig.get_config_var(name)

返回单个变量 name 的值。 等价于 get_config_vars().get(name)。

如果未找到 name，则返回 None。

用法示例:

>>> 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++']

安装路径

Python 会使用根据平台和安装选项区别处理的安装方案。 这些方案保存在 sysconfig 中基于 os.name 的返回值来确定的唯一标识符下。

每个使用 distutils 或基于 Distutils 的系统安装的新组件都将遵循同样的方案将其文件拷贝到正确的位置。

Python 目前支持六种方案:

posix_prefix: 针对 POSIX 平台如 Linux 或 macOS 的方案。 这是在安装 Python 或者组件时的默认方案。

posix_home: 当在安装时使用了 home 选项时针对 POSIX 平台所使用的方案。 此方案会在通过 Distutils 附带指定的前缀安装组件时被使用。

posix_user: 当通过 Distutils 安装组件并且使用了 user 选项时针对 POSIX 平台所使用的方案。 此方案会在用户家目录下定义路径位置。

nt: 针对 NT 平台如 Windows 的方案。

nt_user: 针对 NT 平台，当使用了 user 选项时的方案。

osx_framework_user: 针对 macOS，当使用了 user 选项时的方案。

每个方案本身由一系列路径组成并且每个路径都有唯一的标识符。 Python 目前使用了八个路径:

stdlib: 包含非平台专属的标准 Python 库文件的目录。

platstdlib: 包含平台专属的标准 Python 库文件的目录。

platlib: 用于站点专属、平台专属的文件的目录。

purelib: 用于站点专属、非平台专属的文件的目录。

include: 用于非平台专属的头文件的目录。

platinclude: 用于平台专属的头文件的目录。

scripts: 用于脚本文件的目录。

data: 用于数据文件的目录。

sysconfig 提供了一些函数来确定这些路径。

sysconfig.get_scheme_names()

返回一个包含 sysconfig 目前支持的所有方案的元组。

sysconfig.get_default_scheme()

返回针对当前平台的默认方案的名称。

3.10 新版功能: 此函数之前被命名为 _get_default_scheme() 并被认为属性实现细节。

sysconfig.get_preferred_scheme(key)

返回针对由 key 所指定的安装布局的推荐方案的名称。

key 必须为 "prefix", "home" 或 "user"。

该返回值是 get_scheme_names() 中列出的一个方案名称。 它可以被传给接受 scheme 参数的 sysconfig 函数，如 get_paths()。

3.10 新版功能.

sysconfig._get_preferred_schemes()

返回一个包含当前平台推荐的方案名称的字典。 Python 的实现方和再分发方可以将他们推荐的方案添加到 _INSTALL_SCHEMES 模块层级全局值，并修改此函数以返回这些方案名称，例如为各种系统和语言的包管理器提供不同的方案，这样它们各自安装的包就不会彼此混淆。

最终用户不应使用此函数，而应改用 get_default_scheme() 和 get_preferred_scheme()。

3.10 新版功能.

sysconfig.get_path_names()

返回一个包含在 sysconfig 中目前支持的所有路径名称的元组。

sysconfig.get_path(name[, scheme[, vars[, expand]]])

返回一个对应于路径 name，来自名为 scheme 的安装方案的安装路径。

name 必须是一个来自 get_path_names() 所返回的列表的值。

sysconfig 会针对每个平台保存与每个路径名称相对应的安装路径，并带有可扩展的变量。 例如针对 nt 方案的 stdlib 路径是: {base}/Lib。

get_path() 将使用 get_config_vars() 所返回的变量来扩展路径。 所有变量对于每种平台都有相应的默认值因此使用者可以调用此函数来获取默认值。

如果提供了 scheme，则它必须是一个来自 get_scheme_names() 所返回的列表的值。 在其他情况下，将会使用针对当前平台的默认方案。

如果提供了 vars，则它必须是一个将要更新 get_config_vars() 所返回的字典的字典。

如果 expand 被设为 False，则将不使用这些变量来扩展路径。

如果 name 未找到，则会引发 KeyError。

sysconfig.get_paths([scheme[, vars[, expand]]])

返回一个包含与特定安装方案对应的安装路径的字典。 请参阅 get_path() 了解详情。

如果未提供 scheme，则将使用针对当前平台的默认方案。

如果提供了 vars，则它必须是一个将要更新用于扩展的字典的变量字典。

如果 expand 被设为假值，则路径将不会被扩展。

如果 scheme 不是一个现有的方案，则 get_paths() 将引发 KeyError。

其他功能

sysconfig.get_python_version()

以字符串形式 MAJOR.MINOR 返回 Python 版本号。 类似于 '%d.%d' % sys.version_info[:2]。

sysconfig.get_platform()

返回一个标识当前平台的字符串。

这主要被用来区分平台专属的构建目录和平台专属的构建分发版。 通常包括 OS 名称和版本以及架构（即 'os.uname()' 所提供的信息)，但是实际包括的信息取决于具体 OS；例如，在 Linux 上，内核版本号并不是特别重要。

返回值的示例：

linux-i586

linux-alpha (?)

solaris-2.6-sun4u

Windows将返回以下之一：

win-amd64 (在 AMD64, aka x86_64, Intel64, 和 EM64T上的64位 Windows )

win32（所有其他的 —— 确切地说，返回 sys.platform）

macOS 可以返回:

macosx-10.6-ppc

macosx-10.4-ppc64

macosx-10.3-i386

macosx-10.4-fat

对于其他非-POSIX 平台， 目前只是返回 sys.platform 。

sysconfig.is_python_build()

如果正在运行的 Python 解释器是使用源代码构建的并在其构建位置上运行，而不是在其他位置例如通过运行 make install 或通过二进制机器码安装程序安装则返回 True。

sysconfig.parse_config_h(fp[, vars])

解析一个 config.h 风格的文件。

fp 是一个指向 config.h 风格的文件的文件型对象。

返回一个包含名称/值对的字典。 如果传入一个可选的字典作为第二个参数，则将使用它而不是新的字典，并使用从文件中读取的值更新它。

sysconfig.get_config_h_filename()

返回 pyconfig.h 的目录

sysconfig.get_makefile_filename()

返回 Makefile 的目录

将 sysconfig 作为脚本使用

You can use sysconfig as a script with Python's -m option:

$ 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"
        ...

此调用将把 get_platform(), get_python_version(), get_path() 和 get_config_vars() 所返回的信息打印至标准输出。

builtins --- 内建对象

该模块提供对Python的所有“内置”标识符的直接访问；例如，builtins.open 是内置函数的全名 open() 。请参阅 内置函数 和 内置常量 的文档。

大多数应用程序通常不会显式访问此模块，但在提供与内置值同名的对象的模块中可能很有用，但其中还需要内置该名称。例如，在一个想要实现 open() 函数的模块中，它包装了内置的 open() ，这个模块可以直接使用:

import builtins

def open(path):
    f = builtins.open(path, 'r')
    return UpperCaser(f)

class UpperCaser:
    '''Wrapper around a file that converts output to upper-case.'''

    def __init__(self, f):
        self._f = f

    def read(self, count=-1):
        return self._f.read(count).upper()

    # ...

作为一个实现细节，大多数模块都将名称 __builtins__ 作为其全局变量的一部分提供。 __builtins__ 的值通常是这个模块或者这个模块的值 __dict__ 属性。由于这是一个实现细节，因此 Python 的替代实现可能不会使用它。

__main__ ——顶层代码环境

Python 的特殊名 __main__ 用于两个重要的构造：

程序的顶层环境的名称，可用表达式 __name__ == '__main__' 来检查；以及

Python 包中的文件 __main__.py。

这两个机制都与 Python 模块相关——用户与它们如何交互，及它们之间如何交互——下文详述。而教程的 模块 一节则为初学者介绍了 Python 模块。

__name__ == '__main__'

当一个 Python 模块或包被导入时，__name__ 被设为模块的名称——通常为 Python 文件本身的名称去掉 .py 后缀：

>>> import configparser
>>> configparser.__name__
'configparser'

如果文件是包的一部分，则 __name__ 还将包括父包的路径：

>>> from concurrent.futures import process
>>> process.__name__
'concurrent.futures.process'

而若模块是在顶层代码环境中执行的，则其 __name__ 被设为字符串 '__main__'。

什么是“顶层代码环境”？

__main__ 是顶层代码运行环境的名称。“顶层代码”是指由用户指定的最先开始运行的那一个 Python 模块。之所以它是“顶层”，是因为它将导入程序所需的所有其它模块。有时“顶层代码”被称为应用程序的 入口点。

顶层代码环境可以是：

交互提示符的作用域：

>>> __name__
'__main__'

作为文件参数传给 Python 解释器的 Python 模块：

$ python3 helloworld.py
Hello, world!

与 -m 一起传给 Python 解释器的 Python 模块或包：

$ python3 -m tarfile
usage: tarfile.py [-h] [-v] (...)

Python 解释器从标准输入中读取的 Python 代码：

$ echo "import this" | python3
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
...

与 -c 一起传给 Python 解释器的 Python 代码：

$ python3 -c "import this"
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
...

上述每种情况中的顶层模块的 __name__ 被设为 '__main__'。

作为结果，模块通过检查自己的 __name__ 可发现自己是否运行于顶层环境，使一些代码仅当模块不是被导入语句初始化的时候才执行：

if __name__ == '__main__':
    # Execute when the module is not initialized from an import statement.
    ...

参见

关于在所有情况下 __name__ 是被如何设置的，详见教程的 模块 一节。

惯用法

有些模块包含了仅供脚本使用的代码，比如解析命令行参数或从标准输入获取数据。 如果这样的模块被从不同的模块中导入，例如为了单元测试，脚本代码也会无意中执行。

这就是 if __name__ == '__main__' 代码块的用武之地。除非模块在顶层环境中被执行，否则该块内的代码不会运行。

将尽可能少的语句放在下面的 if __name___ == '__main__' 块中可以提高代码的清晰度和正确性。最常见的，一个名为 main 的函数封装了程序的主要行为:

# echo.py

import shlex
import sys

def echo(phrase: str) -> None:
   """A dummy wrapper around print."""
   # for demonstration purposes, you can imagine that there is some
   # valuable and reusable logic inside this function
   print(phrase)

def main() -> int:
    """Echo the input arguments to standard output"""
    phrase = shlex.join(sys.argv)
    echo(phrase)
    return 0

if __name__ == '__main__':
    sys.exit(main())  # next section explains the use of sys.exit

请注意，如果模块没有将代码封装在 main 函数内，而是直接放在 if __name__ == '__main__' 块内，那么这个 phrase 变量对整个模块来说就是全局变量。 这很容易出错，因为模块内的其他函数可能会无意中使用全局变量而不是局部名称。 一个 main 函数解决了这个问题。

使用 main 函数有一个额外的好处，就是 echo 函数本身是孤立的，可以在其他地方导入。当 echo.py 被导入时，echo 和 main 函数将被定义，但它们都不会被调用，因为 __name__ != '__main__' 。

打包考量

main 函数经常被用来创建命令行工具，把它们指定为控制台脚本的入口点。 当这样做时，pip [https://pip.pypa.io/] 将函数调用插入到模板脚本中，其中 main 的返回值被传递到 sys.exit() 。例如:

sys.exit(main())

由于 main 调用被包裹在 sys.exit() 中，期望你的函数将返回一些可被 sys.exit() 作为输入而接受的值；通常为一个整数或 None （如果你的函数没有返回语句，则隐含返回）。

通过主动遵循这一惯例，我们的模块在直接运行时（即 python3 echo.py ）会有相同的行为，如果我们以后把它打包成可用 pip 安装的包中的控制台脚本入口，它也会有相同的行为。

特别的是，要小心从你的 main 函数中返回字符串。 sys.exit() 将把一个字符串参数解释为失败信息，所以你的程序将有一个 1 的退出代码，表示失败。并且这个字符串将被写入 sys.stderr 。 前面的 echo.py 例子举例说明了使用 sys.exit(main()) 的约定。

参见

Python 打包用户指南 [https://packaging.python.org/] 包含了一系列关于如何用现代工具分发和安装 Python 包的教程和参考资料。

Python 包中的 __main__.py

如果你不熟悉Python包，请参阅本教程的 包 一节。最常见的是， __main__.py 文件被用来为一个包提供命令行接口。假设有下面这个虚构的包，"bandclass":

bandclass
  ├── __init__.py
  ├── __main__.py
  └── student.py

当使用 -m 标志从命令行直接调用软件包本身时，将执行 __main__.py 。比如说。

$ python3 -m bandclass

这个命令将导致 __main__.py 的运行。你如何利用这一机制将取决于你所编写的软件包的性质，但在这个假设的案例中，允许教师搜索学生可能是有意义的:

# bandclass/__main__.py

import sys
from .student import search_students

student_name = sys.argv[2] if len(sys.argv) >= 2 else ''
print(f'Found student: {search_students(student_name)}')

注意， from .student import search_students 是一个相对导入的例子。 这种导入方式可以在引用一个包内的模块时使用。 更多细节，请参见教程 模块 中的 相对导入 一节。

惯用法

__main__.py 的内容通常不是用 if __name__ == '__main__' 区块围起来的。 相反，这些文件保持简短，功能从其他模块执行。 那些其他模块可以很容易地进行单元测试，并且可以适当地重复使用。

如果使用，一个 if __name__ == '__main__' 区块仍然会像预期的那样对包内的 __main__.py 文件起作用，因为如果导入，它的 __name__ 属性将包括包的路径:

>>> import asyncio.__main__
>>> asyncio.__main__.__name__
'asyncio.__main__'

但这对 .zip 文件的根目录中的 __main__.py 文件不起作用。 因此，为了保持一致性，像下面提到的 venv 这样的最小 __main__.py 是首选。

参见

请参阅 venv 以获取标准库中具有最小化 __main__.py 的软件包示例。 它不包含 if __name__ == '__main__' 代码块。 你可以用 python -m venv [directory] 来唤起。

参见 runpy 以了解更多关于 -m 标志对解释器可执行包的细节。

参见 zipapp 了解如何运行打包成 .zip 文件的应用程序。在这种情况下，Python 会在归档文件的根目录下寻找一个 __main__.py 文件。

import __main__

不管 Python 程序是用哪个模块启动的，在同一程序中运行的其他模块可以通过导入 __main__ 模块来导入顶级环境的范围 ( namespace )。这并不是导入一个 __main__.py 文件，而是导入使用特殊名称 '__main__' 的哪个模块。

下面是一个使用 __main__ 命名空间的模块的例子:

# 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`!')

    if '__file__' in dir(__main__):
        print(__main__.my_name, "found in file", __main__.__file__)
    else:
        print(__main__.my_name)

该模块的用法示例如下:

# 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())

现在，如果我们启动我们的程序，结果会是这样的:

$ python3 start.py
Define the variable `my_name`!

该程序的退出代码为 1 ，表明有错误。取消对 my_name = "Dinsdale" 这一行的注释，就可以修复程序，现在它的退出状态代码为 0 ，表示成功。

$ python3 start.py
Dinsdale found in file /path/to/start.py

请注意，导入 __main__ 不会导致无意中运行旨在用于脚本的顶层代码的问题，这些代码被放在模块 start 的 if __name__ == "__main__" 块中。为什么这样做？

Python 解释器启动时会在 sys.modules 中插入一个空的 __main__ 模块，并通过运行顶层代码来填充它。 在我们的例子中这就是 start 模块，它逐行运行并导入 namely。 反过来，namely 会导入 __main__ (这其实是 start)。 这就是一个导入循环！ 幸运的是，由于部分填充的 __main__ 模块存在于 sys.modules 中，Python 会将其传递给 namely。 请参阅导入系统参考资料中 有关 __main__ 的特别考量 来了解其中的详情。

Python REPL 是另一个 "顶层环境 "的例子，所以在 REPL 中定义的任何东西都成为 __main__ 范围的一部分:

>>> 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

注意，在这种情况下， __main__ 范围不包含 __file__ 属性，因为它是交互式的。

__main__ 范围用于 pdb 和 rlcompleter 的实现。

warnings ——控制警告信息

源代码： Lib/warnings.py [https://github.com/python/cpython/tree/3.10/Lib/warnings.py]

通常以下情况会引发警告：提醒用户注意程序中的某些情况，而这些情况（通常）还不值得触发异常并终止程序。例如，当程序用到了某个过时的模块时，就可能需要发出一条警告。

Python 程序员可调用本模块中定义的 warn() 函数来发布警告。（C 语言程序员则用 PyErr_WarnEx() ； 详见 异常处理 ）。

警告信息通常会写入 sys.stderr ，但可以灵活改变，从忽略所有警告到变成异常都可以。警告的处理方式可以依据 警告类型 、警告信息的文本和发出警告的源位置而进行变化。同一源位置重复出现的警告通常会被抑制。

控制警告信息有两个阶段：首先，每次引发警告时，决定信息是否要发出；然后，如果要发出信息，就用可由用户设置的钩子进行格式化并打印输出。

警告过滤器 控制着是否发出警告信息，也即一系列的匹配规则和动作。调用 filterwarnings() 可将规则加入过滤器，调用 resetwarnings() 则可重置为默认状态。

警告信息的打印输出是通过调用 showwarning() 完成的，该函数可被重写；默认的实现代码是调用 formatwarning() 进行格式化，自己编写的代码也可以调用此格式化函数。

参见

利用 logging.captureWarnings() 可以采用标准的日志架构处理所有警告。

警告类别

警告的类别由一些内置的异常表示。这种分类有助于对警告信息进行分组过滤。

虽然在技术上警告类别属于 内置异常，但也只是在此记录一下而已，因为在概念上他们属于警告机制的一部分。

通过对某个标准的警告类别进行派生，用户代码可以定义其他的警告类别。 警告类别必须是 Warning 类的子类。

目前已定义了以下警告类别的类：

类 | 描述
Warning | 这是所有警告类别的基类。它是 Exception 的子类。
UserWarning | The default category for warn().
DeprecationWarning | 已废弃特性警告的基类，这些警告是为其他 Python 开发者准备的（默认会忽略，除非在 __main__ 中用代码触发）。
SyntaxWarning | 用于警告可疑语法的基类。
RuntimeWarning | 用于警告可疑运行时特性的基类。
FutureWarning | 用于警告已废弃特性的基类，这些警告是为 Python 应用程序的最终用户准备的。
PendingDeprecationWarning | 用于警告即将废弃功能的基类（默认忽略）。
ImportWarning | 导入模块时触发的警告的基类（默认忽略）。
UnicodeWarning | 用于 Unicode 相关警告的基类。
BytesWarning | bytes 和 bytearray 相关警告的基类。
ResourceWarning | 资源使用相关警告的基础类别（默认会被忽略）。ignored by default).

在 3.7 版更改: 以前 DeprecationWarning 和 FutureWarning 是根据某个功能是否完全删除或改变其行为来区分的。现在是根据受众和默认警告过滤器的处理方式来区分的。

警告过滤器

警告过滤器控制着警告是否被忽略、显示或转为错误（触发异常）。

从概念上讲，警告过滤器维护着一个经过排序的过滤器类别列表；任何具体的警告都会依次与列表中的每种过滤器进行匹配，直到找到一个匹配项；过滤器决定了匹配项的处理方式。每个列表项均为 ( action , message , category , module , lineno ) 格式的元组，其中：

action 是以下字符串之一：

值 | 处置
"default" | 为发出警告的每个位置（模块+行号）打印第一个匹配警告
"error" | 将匹配警告转换为异常
"ignore" | 从不打印匹配的警告
"always" | 总是打印匹配的警告
"module" | 为发出警告的每个模块打印第一次匹配警告（无论行号如何）
"once" | 无论位置如何，仅打印第一次出现的匹配警告

message 是一个包含警告消息的开头需要匹配的正则表达式的字符串，对大小写不敏感。 在 -W 和 PYTHONWARNINGS 中，message 是警告消息的开头需要包含的字符串字面值（对大小写不敏感），将忽略 message 开头和末尾的任何空格。

category 是警告类别的类（Warning 的子类），警告类别必须是其子类，才能匹配。

module 是一个包含完整限定模块名称的开头需要匹配的正则表达式的字符串，对大小写敏感。 在 -W 和 PYTHONWARNINGS 中，module 是完整限定模块名称需要与之相等的字符串字面值（对大小写敏感），将忽略 module 开头和末尾的任何空格。

lineno 是个整数，发生警告的行号必须与之匹配，或为 0 表示与所有行号匹配。

由于 Warning 类是由内置类 Exception 派生出来的，要把某个警告变成错误，只要触发 category(message) 即可。

如果警告不匹配所有已注册的过滤器，那就会应用 “default” 动作（正如其名）。

警告过滤器的介绍

警告过滤器由传给 Python 解释器的命令行 -W 选项和 PYTHONWARNINGS 环境变量初始化。解释器在 sys.warningoptions 中保存了所有给出的参数，但不作解释；warnings 模块在第一次导入时会解析这些参数（无效的选项被忽略，并会先向 sys.stderr 打印一条信息）。

每个警告过滤器的设定格式为冒号分隔的字段序列：

action:message:category:module:line

这些字段的含义在 警告过滤器 中描述。当一行中列出多个过滤器时（如 PYTHONWARNINGS），过滤器间用逗号隔开，后面的优先于前面的（因为是从左到右应用的，最近应用的过滤器优先于前面的）。

常用的警告过滤器适用于所有的警告、特定类别的警告、由特定模块和包引发的警告。下面是一些例子：

default                      # Show all warnings (even those ignored by default)
ignore                       # Ignore all warnings
error                        # Convert all warnings to errors
error::ResourceWarning       # Treat ResourceWarning messages as errors
default::DeprecationWarning  # Show DeprecationWarning messages
ignore,default:::mymodule    # Only report warnings triggered by "mymodule"
error:::mymodule             # Convert warnings to errors in "mymodule"

默认警告过滤器

Python 默认安装了几个警告过滤器，可以通过 -W 命令行参数、 PYTHONWARNINGS 环境变量及调用 filterwarnings() 进行覆盖。

在常规发布的版本中，默认的警告过滤器包括（按优先顺序排列）：

default::DeprecationWarning:__main__
ignore::DeprecationWarning
ignore::PendingDeprecationWarning
ignore::ImportWarning
ignore::ResourceWarning

在 调试版本 中，默认警告过滤器的列表是空的。

在 3.2 版更改: 除了 PendingDeprecationWarning 之外，DeprecationWarning 现在默认会被忽略。

在 3.7 版更改: DeprecationWarning 在被 __main__ 中的代码直接触发时，默认会再次显示。

在 3.7 版更改: 如果指定两次 -b，则 BytesWarning 不再出现在默认的过滤器列表中，而是通过 sys.warningoptions 进行配置。

重写默认的过滤器

Python 应用程序的开发人员可能希望在默认情况下向用户隐藏 所有 Python级别的警告，而只在运行测试或其他调试时显示这些警告。用于向解释器传递过滤器配置的 sys.warningoptions 属性可以作为一个标记，表示是否应该禁用警告：

import sys

if not sys.warnoptions:
    import warnings
    warnings.simplefilter("ignore")

建议 Python 代码测试的开发者使用如下代码，以确保被测代码默认显示 所有 警告：

import sys

if not sys.warnoptions:
    import os, warnings
    warnings.simplefilter("default") # Change the filter in this process
    os.environ["PYTHONWARNINGS"] = "default" # Also affect subprocesses

最后，建议在 __main__ 以外的命名空间运行用户代码的交互式开发者，请确保 DeprecationWarning 在默认情况下是可见的，可采用如下代码（这里 user_ns 是用于执行交互式输入代码的模块）：

import warnings
warnings.filterwarnings("default", category=DeprecationWarning,
                                   module=user_ns.get("__name__"))

暂时禁止警告

如果明知正在使用会引起警告的代码，比如某个废弃函数，但不想看到警告（即便警告已经通过命令行作了显式配置），那么可以使用 catch_warnings 上下文管理器来抑制警告。

import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    fxn()

在上下文管理器中，所有的警告将被简单地忽略。这样就能使用已知的过时代码而又不必看到警告，同时也不会限制警告其他可能不知过时的代码。注意：只能保证在单线程应用程序中生效。如果两个以上的线程同时使用 catch_warnings 上下文管理器，行为不可预知。

测试警告

要测试由代码引发的警告，请采用 catch_warnings 上下文管理器。有了它，就可以临时改变警告过滤器以方便测试。例如，以下代码可捕获所有的警告以便查看：

import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings(record=True) as w:
    # Cause all warnings to always be triggered.
    warnings.simplefilter("always")
    # Trigger a warning.
    fxn()
    # Verify some things
    assert len(w) == 1
    assert issubclass(w[-1].category, DeprecationWarning)
    assert "deprecated" in str(w[-1].message)

也可以用 error 取代 always ，让所有的警告都成为异常。需要注意的是，如果某条警告已经因为 once / default 规则而被引发，那么无论设置什么过滤器，该条警告都不会再出现，除非该警告有关的注册数据被清除。

一旦上下文管理器退出，警告过滤器将恢复到刚进此上下文时的状态。这样在多次测试时可防止意外改变警告过滤器，从而导致不确定的测试结果。模块中的 showwarning() 函数也被恢复到初始值。注意：这只能在单线程应用程序中得到保证。如果两个以上的线程同时使用 catch_warnings 上下文管理器，行为未定义。

当测试多项操作会引发同类警告时，重点是要确保每次操作都会触发新的警告（比如，将警告设置为异常并检查操作是否触发异常，检查每次操作后警告列表的长度是否有增加，否则就在每次新操作前将以前的警告列表项删除）。

为新版本的依赖关系更新代码

在默认情况下，主要针对 Python 开发者（而不是 Python 应用程序的最终用户）的警告类别，会被忽略。

值得注意的是，这个“默认忽略”的列表包含 DeprecationWarning （适用于每个模块，除了 __main__），这意味着开发人员应该确保在测试代码时应将通常忽略的警告显示出来，以便未来破坏性 API 变化时及时收到通知（无论是在标准库还是第三方包）。

理想情况下，代码会有一个合适的测试套件，在运行测试时会隐含地启用所有警告（由 unittest 模块提供的测试运行程序就是如此）。

在不太理想的情况下，可以通过向 Python 解释器传入 -Wd (这是 -W default 的简写) 或设置环境变量 PYTHONWARNINGS=default 来检查应用程序是否用到了已弃用的接口。 这样可以启用对所有警告的默认处理操作，包括那些默认忽略的警告。 要改变遇到警告后执行的动作，可以改变传给 -W 的参数 (例如 -W error)。 请参阅 -W 旗标来了解更多的细节。

可用的函数

warnings.warn(message, category=None, stacklevel=1, source=None)

引发警告、忽略或者触发异常。 如果给出 category 参数，则必须是 警告类别类 ；默认为 UserWarning。 或者 message 可为 Warning 的实例，这时 category 将被忽略，转而采用 message.__class__。 在这种情况下，错误信息文本将是 str(message)。 如果某条警告被 警告过滤器 改成了错误，本函数将触发一条异常。 参数 stacklevel 可供 Python 包装函数使用，比如:

def deprecation(message):
    warnings.warn(message, DeprecationWarning, stacklevel=2)

这会让警告指向 deprecation() 的调用者，而不是 deprecation() 本身的来源（因为后者会破坏引发警告的目的）。

source 是发出 ResourceWarning 的被销毁对象。

在 3.6 版更改: 加入 source  参数。

warnings.warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)

这是 warn() 函数的底层接口，显式传入消息、类别、文件名和行号，以及可选的模块名和注册表（应为模块的 __warningregistry__ 字典）。 模块名称默认为去除了 .py 的文件名；如果未传递注册表，警告就不会被抑制。 message 必须是个字符串，category 是 Warning 的子类；或者*message* 可为 Warning 的实例，且 category 将被忽略。

module_globals 应为发出警告的代码所用的全局命名空间。（该参数用于从 zip 文件或其他非文件系统导入模块时显式源码）。

source 是发出 ResourceWarning 的被销毁对象。

在 3.6 版更改: 加入 source 参数。

warnings.showwarning(message, category, filename, lineno, file=None, line=None)

将警告信息写入文件。默认的实现代码是调用 formatwarning(message, category, filename, lineno, line) 并将结果字符串写入 file ，默认文件为 sys.stderr。通过将任何可调用对象赋给 warnings.showwarning 可替换掉该函数。line 是要包含在警告信息中的一行源代码；如果未提供 line，showwarning() 将尝试读取由*filename* 和 lineno 指定的行。

warnings.formatwarning(message, category, filename, lineno, line=None)

以标准方式格式化一条警告信息。将返回一个字符串，可能包含内嵌的换行符，并以换行符结束。如果未提供 line，formatwarning() 将尝试读取由 filename 和 lineno 指定的行。

warnings.filterwarnings(action, message='', category=Warning, module='', lineno=0, append=False)

在 警告过滤器种类 列表中插入一条数据项。默认情况下，该数据项将被插到前面；如果 append 为 True，则会插到后面。这里会检查参数的类型，编译 message 和 module 正则表达式，并将他们作为一个元组插入警告过滤器的列表中。如果两者都与某种警告匹配，那么靠近列表前面的数据项就会覆盖后面的项。省略的参数默认匹配任意值。

warnings.simplefilter(action, category=Warning, lineno=0, append=False)

在 警告过滤器种类 列表中插入一条简单数据项。函数参数的含义与 filterwarnings() 相同，但不需要正则表达式，因为插入的过滤器总是匹配任何模块中的任何信息，只要类别和行号匹配即可。

warnings.resetwarnings()

重置警告过滤器。这将丢弃之前对 filterwarnings() 的所有调用，包括 -W 命令行选项和对 simplefilter() 的调用效果。

可用的上下文管理器

class warnings.catch_warnings(*, record=False, module=None)

该上下文管理器会复制警告过滤器和 showwarning() 函数，并在退出时恢复。 如果 record 参数是 False (默认)，则在进入时会返回 None。 如果 record 为 True，则返回一个列表，列表由自定义 showwarning() 函数所用对象逐步填充（该函数还会抑制 sys.stdout 的输出）。 列表中每个对象的属性与 showwarning() 的参数名称相同。

module 参数代表一个模块，当导入 warnings 时，将被用于代替返回的模块，其过滤器将被保护。该参数主要是为了测试 warnings 模块自身。

注解

catch_warnings 管理器的工作方式，是替换并随后恢复模块的 showwarning() 函数和内部的过滤器种类列表。这意味着上下文管理器将会修改全局状态，因此不是线程安全的。

dataclasses --- 数据类

源码： Lib/dataclasses.py [https://github.com/python/cpython/tree/3.10/Lib/dataclasses.py]

这个模块提供了一个装饰器和一些函数，用于自动添加生成的 special method，例如 __init__() 和 __repr__() 到用户定义的类。 它最初描述于 PEP 557 [https://www.python.org/dev/peps/pep-0557] 。

在这些生成的方法中使用的成员变量是使用 PEP 526 [https://www.python.org/dev/peps/pep-0526] 类型标注来定义的。例如以下代码：

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

将在添加的内容中包括如下所示的 __init__():

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

请注意，此方法会自动添加到类中：而不是在如上所示的 InventoryItem 定义中被直接指定。

3.7 新版功能.

模块内容

@dataclasses.dataclass(*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False)

这个函数是 decorator ，用于将生成的 special method 添加到类中，如下所述。

dataclass() 装饰器会检查类以查找 field —— field 被定义为具有 类型标注 的类变量。除了下面描述的两个例外，在 dataclass() 中没有什么东西会去检查这些变量标注成了何种类型。

这些字段在所有生成的方法中的顺序，都是它们在类定义中出现的顺序。

dataclass() 装饰器将向类中添加如下的各种 dunder 方法。如果所添加的方法已存在于类中，则行为将取决于下面所列出的形参。该装饰器会返回调用它的类；不会创建新的类。

如果 dataclass() 仅用作没有参数的简单装饰器，它将使用它的函数签名中的默认值。也就是说，这三种 dataclass() 用法是等价的：

@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)
class C:
   ...

dataclass() 的参数有：

init: 如果为真值（默认），将生成一个 __init__() 方法。

如果类已定义 __init__() ，则忽略此参数。

repr ：如果为真值（默认），将生成一个 __repr__() 方法。 生成的 repr 字符串将具有类名以及每个字段的名称和 repr ，按照它们在类中定义的顺序。不包括标记为从 repr 中排除的字段。 例如：InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)。

如果类已定义 __repr__() ，则忽略此参数。

eq ：如果为true（默认值），将生成 __eq__() 方法。此方法将类作为其字段的元组按顺序比较。比较中的两个实例必须是相同的类型。

如果类已定义 __eq__() ，则忽略此参数。

order ：如果为真值（默认为 False ），则 __lt__() 、 __le__() 、 __gt__() 和 __ge__() 方法将生成。 这将类作为其字段的元组按顺序比较。比较中的两个实例必须是相同的类型。如果 order 为真值并且 eq 为假值 ，则引发 ValueError 。

如果类已经定义了 __lt__() 、 __le__() 、 __gt__() 或者 __ge__() 中的任意一个，将引发 TypeError 。

unsafe_hash ：如果为 False （默认值），则根据 eq 和 frozen 的设置方式生成 __hash__() 方法。

__hash__() 由内置的 hash() 使用，当对象被添加到散列集合（如字典和集合）时。有一个 __hash__() 意味着类的实例是不可变的。可变性是一个复杂的属性，取决于程序员的意图， __eq__() 的存在性和行为，以及 dataclass() 装饰器中 eq 和 frozen 标志的值。

默认情况下， dataclass() 不会隐式添加 __hash__() 方法，除非这样做是安全的。 它也不会添加或更改现有的明确定义的 __hash__() 方法。 设置类属性 __hash__ = None 对 Python 具有特定含义，如 __hash__() 文档中所述。

如果 __hash__() 没有显式定义，或者它被设为 None，则 dataclass() 可能 会添加一个隐式 __hash__() 方法。 虽然并不推荐，但你可以用 unsafe_hash=True 来强制 dataclass() 创建一个 __hash__() 方法。 如果你的类在逻辑上不可变但却仍然可被修改那么可能就是这种情况。 这是一个特殊用例并且应当被仔细地考虑。

以下是隐式创建 __hash__() 方法的规则。请注意，你不能在数据类中都使用显式的 __hash__() 方法并设置 unsafe_hash=True ；这将导致 TypeError 。

如果 eq 和 frozen 都是 true，默认情况下 dataclass() 将为你生成一个 __hash__() 方法。如果 eq 为 true 且 frozen 为 false ，则 __hash__() 将被设置为 None ，标记它不可用（因为它是可变的）。如果 eq 为 false ，则 __hash__() 将保持不变，这意味着将使用超类的 __hash__() 方法（如果超类是 object ，这意味着它将回到基于id的hash）。

frozen: 如为真值 (默认值为 False)，则对字段赋值将会产生异常。 这模拟了只读的冻结实例。 如果在类中定义了 __setattr__() 或 __delattr__() 则将会引发 TypeError。 参见下文的讨论。

match_args: 如果为真值 (默认值为 True)，则将根据传给生成的 __init__() 方法的形参列表来创建 __match_args__ 元组 (即使没有生成 __init__() 也会创建，见上文)。 如果为假值，或者如果 __match_args__ 已在类中定义，则将不生成 __match_args__。

3.10 新版功能.

kw_only: 如果为真值 (默认值为 False)，则所有字段都将被标记为仅限关键字。 如果一个字段被标记为仅限关键字，则其唯一的影响是根据仅限关键字的字段生成的 __init__() 形参必须使用调用 __init__() 时传入的关键字来指定。 对于 dataclass 的任何其它方面都没有影响。 请参阅 parameter 术语表条目了解详情。 另请参阅 KW_ONLY 一节。

3.10 新版功能.

slots: 如果为真值 (默认值为 False)，则将生成 __slots__ 属性并将返回一个新类而非原来的类。 如果 __slots__ 已在类中定义，则会引发 TypeError。

3.10 新版功能.

可以用普通的 Python 语法为各个 field 指定默认值：

@dataclass
class C:
    a: int       # 'a' has no default value
    b: int = 0   # assign a default value for 'b'

在这个例子中， a 和 b 都将包含在添加的 __init__() 方法中，它们将被定义为:

def __init__(self, a: int, b: int = 0):

如果在具有默认值的字段之后存在没有默认值的字段，将会引发 TypeError。无论此情况是发生在单个类中还是作为类继承的结果，都是如此。

dataclasses.field(*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING)

大多数时候，对于简单常见的用途，前述的功能已经足够了。而有些功能需要字段提供额外的信息来启用。为了满足这种对附加信息的需求，你可以通过调用提供的 field() 函数来替换字段默认值。例如：

@dataclass
class C:
    mylist: list[int] = field(default_factory=list)

c = C()
c.mylist += [1, 2, 3]

如上所示，MISSING 值是一个哨兵对象，用于检测一些形参是否由用户提供。使用它是因为 None 对于一些形参来说是有效的用户值。任何代码都不应该直接使用 MISSING 值。

field() 的形参有：

default：如果提供，这将是该字段的默认值。设计这个形参是因为 field() 调用将会占据原来用来提供默认值的位置。

default_factory：如果提供，它必须是一个需要零个参数的可调用对象，当该字段需要一个默认值时，它将被调用。这能解决当默认值是可变对象时会带来的问题，如下所述。同时指定 default 和 default_factory 将产生错误。

init ：如果为true（默认值），则该字段作为参数包含在生成的 __init__() 方法中。

repr ：如果为true（默认值），则该字段包含在生成的 __repr__() 方法返回的字符串中。

hash ：这可以是布尔值或 None 。如果为true，则此字段包含在生成的 __hash__() 方法中。如果为 None （默认值），请使用 compare 的值，这通常是预期的行为。如果字段用于比较，则应在 hash 中考虑该字段。不鼓励将此值设置为 None 以外的任何值。

设置 hash=False 但 compare=True 的一个合理情况是，一个计算哈希值的代价很高的字段是检验等价性需要的，且还有其他字段可以用于计算类型的哈希值。可以从哈希值中排除该字段，但仍令它用于比较。

compare ：如果为true（默认值），则该字段包含在生成的相等性和比较方法中（ __eq__() ， __gt__() 等等）。

metadata：可以是映射或 None。None 被视为一个空的字典。这个值将被包装在 MappingProxyType() 中，使其只读，并暴露在 Field 对象上。数据类不使用它——它是作为第三方扩展机制提供的。多个第三方可以各自拥有自己的键，以用作元数据中的命名空间。

kw_only: 如果为真值，则此字段将被标记为仅限关键字。 这将在当计算出所生成的 __init__() 方法的形参时被使用。

3.10 新版功能.

如果通过调用 field() 指定字段的默认值，则该字段对应的类属性的值将最终被替换为指定的 default 值。如果没有提供 default，那么将删除该字段对应的类属性。目的是在 dataclass() 装饰器运行之后，类属性将包含字段的默认值，和直接指定了默认值一样。例如，在运行如下代码之后：

@dataclass
class C:
    x: int
    y: int = field(repr=False)
    z: int = field(repr=False, default=10)
    t: int = 20

类属性 C.z 将是 10，类属性 C.t 将是 20，类属性 C.x 和 C.y 将不设置。

class dataclasses.Field

Field 对象描述每个已定义的字段。这些对象在内部被创建，并由 fields() 模块级方法返回（见下）。用户永远不应该直接实例化 Field 对象。它的下列属性的含义是由文档规定的：

name：字段的名称。

type：字段的类型。

default, default_factory, init, repr, hash, compare, metadata 和 kw_only 具有与 field() 函数中对应参数相同的含义和值。

可能存在其他属性，但它们是私有的。用户不应检查或依赖于这些属性。

dataclasses.fields(class_or_instance)

返回一个能描述此数据类所包含的字段的元组，元组的每一项都是 Field 对象。接受数据类或数据类的实例。如果没有传递一个数据类或实例将引发 TypeError。不返回 ClassVar 或 InitVar 等伪字段。

dataclasses.asdict(obj, *, dict_factory=dict)

将数据类 obj 转换为一个字典（使用工厂函数 dict_factory）。每个数据类被转换为以 name: value 键值对来储存其字段的字典。数据类、字典、列表和元组的内容会被递归地访问。其它对象用 copy.deepcopy() 来复制。

在嵌套的数据类上使用 asdict() 的例子：

@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}]}

要创建一个浅拷贝，可以使用以下的变通方法：

dict((field.name, getattr(obj, field.name)) for field in fields(obj))

如果 obj 不是一个数据类实例，asdict() 引发 TypeError。

dataclasses.astuple(obj, *, tuple_factory=tuple)

将数据类 obj 转换为一个元组（使用工厂函数 tuple_factory）。每个数据类被转换为其字段的值的元组。数据类、字典、列表和元组的内容会被递归地访问。其它对象用 copy.deepcopy() 来复制。

继续前一个例子：

assert astuple(p) == (10, 20)
assert astuple(c) == ([(0, 0), (10, 4)],)

要创建一个浅拷贝，可以使用以下的变通方法：

tuple(getattr(obj, field.name) for field in dataclasses.fields(obj))

如果 obj 不是一个数据类实例，astuple() 引发 TypeError。

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)

新建一个名为 cls_name 的数据类，其字段在 fields 中定义，基类在 bases 中给出，并使用在 namespace 中给出的命名空间进行初始化。 fields 是一个可迭代对象，其中的每个元素均为 name, (name, type) 或 (name, type, Field)。 如果只提供了 name，则 typing.Any 会被用作 type。 init, repr, eq, order, unsafe_hash, frozen, match_args, kw_only 和 slots 等值与它们在 dataclass() 中的含义相同。

此函数不是必需的，因为任何用于创建带有 __annotations__ 的新类的 Python 机制都可以进一步用 dataclass() 函数将创建的类转换为数据类。提供此函数是为了方便。例如：

C = make_dataclass('C',
                   [('x', int),
                     'y',
                    ('z', int, field(default=5))],
                   namespace={'add_one': lambda self: self.x + 1})

等价于：

@dataclass
class C:
    x: int
    y: 'typing.Any'
    z: int = 5

    def add_one(self):
        return self.x + 1

dataclasses.replace(obj, /, **changes)

创建一个与 obj 类型相同的新对象，将字段替换为 changes 里的值。如果 obj 不是数据类，则抛出 TypeError 。如果 changes 里的值没有指定要替换的字段名，则抛出 TypeError。

新返回的对象通过调用数据类的 __init__() 方法创建。这确保了如果存在 __post_init__() ，其也被调用。

如果存在没有默认值的仅初始化变量，必须在调用 replace() 时指定，以便它们可以传递给 __init__() 和 __post_init__() 。

changes 包含任何定义为 init=False 的字段是错误的。在这种情况下会引发 ValueError 。

提前提醒， 字段在 replace() 被调用时的行为是，当它们被初始化时，不是从源对象直接复制，而是在 __post_init__() 中初始化。除非保持审慎，否则 init=False 字段大概很少能被正确地使用。如果有使用 init=False 的字段，那么使用另外的类构造器，或自定义 replace() 方法（或类似名称的方法）来复制实例，可能会更好。

dataclasses.is_dataclass(obj)

如果其形参为数据类，或其实例，返回 True，否则返回 False。

如果你需要知道一个类是否是一个数据类的实例（而不是一个数据类本身），那么再添加一个 not isinstance(obj, type) 检查：

def is_dataclass_instance(obj):
    return is_dataclass(obj) and not isinstance(obj, type)

dataclasses.MISSING

一个指明“没有提供 default 或 default_factory”的监视值。

dataclasses.KW_ONLY

一个用作类型标注的监视值。 任何在伪字段之后的类型为 KW_ONLY 的字段会被标记为仅限关键字字段。 请注意在其他情况下 KW_ONLY 类型的伪字段会被完全忽略。 这包括此类字段的名称。 根据惯例，名称 _ 会被用作 KW_ONLY 字段。 仅限关键字字段指明当类被实例化时 __init__() 形参必须以关键字形式来指定。

在这个例子中，字段 y 和 z 将被标记为仅限关键字字段:

@dataclass
class Point:
  x: float
  _: KW_ONLY
  y: float
  z: float

p = Point(0, y=1.5, z=2.0)

在单个数据类中，指定一个以上 KW_ONLY 类型的字段将导致错误。

3.10 新版功能.

exception dataclasses.FrozenInstanceError

在使用 frozen=True 定义的数据类上调用隐式定义的 __setattr__() 或 __delattr__() 时引发。 这是 AttributeError 的一个子类。

初始化后处理

生成的 __init__() 代码将调用一个名为 __post_init__() 的方法，如果在类上已经定义了 __post_init__() 。它通常被称为 self.__post_init__() 。但是，如果定义了任何 InitVar 字段，它们也将按照它们在类中定义的顺序传递给 __post_init__() 。 如果没有 __init__() 方法生成，那么 __post_init__() 将不会被自动调用。

在其他用途中，这允许初始化依赖于一个或多个其他字段的字段值。例如:

@dataclass
class C:
    a: float
    b: float
    c: float = field(init=False)

    def __post_init__(self):
        self.c = self.a + self.b

由 dataclass() 所生成的 __init__() 方法不会调用基类的 __init__() 方法。 如果基类有需要被调用的 __init__() 方法，通常是在 __post_init__() 方法中调用此方法:

@dataclass
class Rectangle:
    height: float
    width: float

@dataclass
class Square(Rectangle):
    side: float

    def __post_init__(self):
        super().__init__(self.side, self.side)

但是请注意，一般来说 dataclass 生成的 __init__() 方法不需要被调用，因为派生的 dataclass 将负责初始化任何自身为 dataclass 的基类的所有字段。

有关将参数传递给 __post_init__() 的方法，请参阅下面有关仅初始化变量的段落。另请参阅关于 replace() 处理 init=False 字段的警告。

类变量

在 dataclass() 会实际检查字段类型的少数几个地方之一是确定字符是否为如 PEP 526 [https://www.python.org/dev/peps/pep-0526] 所定义的类变量。 它通过检查字段的类型是否为 typing.ClassVar 来实现这一点。 如果一个字段是 ClassVar，它将被排除在考虑范围之外并被数据类机制所忽略。 这样的 ClassVar 伪字段将不会被模块层级的 fields() 函数返回。

仅初始化变量

Another place where dataclass() inspects a type annotation is to determine if a field is an init-only variable. It does this by seeing if the type of a field is of type dataclasses.InitVar. If a field is an InitVar, it is considered a pseudo-field called an init-only field. As it is not a true field, it is not returned by the module-level fields() function. Init-only fields are added as parameters to the generated __init__() method, and are passed to the optional __post_init__() method. They are not otherwise used by dataclasses.

例如，假设在创建类时没有为某个字段提供值，初始化时将从数据库中取值:

@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)

在这种情况下， fields() 将返回 i 和 j 的 Field 对象，但不包括 database 。

冻结的实例

无法创建真正不可变的 Python 对象。但是，通过将 frozen=True 传递给 dataclass() 装饰器，你可以模拟不变性。在这种情况下，数据类将向类添加 __setattr__() 和 __delattr__() 方法。 些方法在调用时会引发 FrozenInstanceError 。

使用 frozen=True 时会有很小的性能损失： __ init__() 不能使用简单的赋值来初始化字段，并必须使用 object.__setattr__()。

继承

当数据类由 dataclass() 装饰器创建时，它会按反向 MRO 顺序（即，从 object 开始）查看它的所有基类，并且将找到的每个数据类的字段添加到一个有序映射中。添加完所有基类字段后，它会将自己的字段添加到这个有序映射中。所有生成的方法都将使用这个有序映射。字段会遵守它们被插入的顺序，因此派生类会重写基类。一个例子：

@dataclass
class Base:
    x: Any = 15.0
    y: int = 0

@dataclass
class C(Base):
    z: int = 10
    x: int = 15

最后的字段列表依次是 x 、 y 、 z 。 x 的最终类型是 int ，如类 C 中所指定的那样。

为 C 生成的 __init__() 方法看起来像:

def __init__(self, x: int = 15, y: int = 0, z: int = 10):

__init__() 中仅限关键字字段的重新排序

在计算出 __init__() 所需要的形参之后，任何仅限关键字形参会被移至所有常规（非仅限关键字）形参的后面。 这是 Python 中实现仅限关键字形参所要求的：它们必须位于非仅限关键字形参之后。

在这个例子中，Base.y, Base.w, and D.t 是仅限关键字字段，而 Base.x 和 D.z 是常规字段:

@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)

为 D 生成的 __init__() 方法看起来像是这样:

def __init__(self, x: Any = 15.0, z: int = 10, *, y: int = 0, w: int = 1, t: int = 0):

请注意形参原来在字段列表中出现的位置已被重新排序：前面是来自常规字段的形参而后面是来自仅限关键字字段的形参。

仅限关键字形参的相对顺序会在重新排序的 __init__() 形参列表中保持原样。

默认工厂函数

如果一个 field() 指定了一个 default_factory ，当需要该字段的默认值时，将使用零参数调用它。例如，要创建列表的新实例，请使用:

mylist: list = field(default_factory=list)

如果一个字段被排除在 __init__() 之外（使用 init=False ）并且字段也指定 default_factory ，则默认的工厂函数将始终从生成的 __init__() 函数调用。发生这种情况是因为没有其他方法可以为字段提供初始值。

可变的默认值

Python 在类属性中存储默认成员变量值。思考这个例子，不使用数据类:

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

请注意，类 C 的两个实例共享相同的类变量 x ，如预期的那样。

使用数据类，如果 此代码有效：

@dataclass
class D:
    x: List = []
    def add(self, element):
        self.x += element

它生成的代码类似于:

class D:
    x = []
    def __init__(self, x=x):
        self.x = x
    def add(self, element):
        self.x += element

assert D().x is D().x

这与使用 C 类的原始示例具有相同的问题。 也就是说，当在创建类实例的时候 D 类的两个实例没有为 x 指定值则将共享同一个 x 的副本。 因为数据类只是使用普通的 Python 类创建方式所以它们也会共享此行为。 数据类没有任何通用方式来检测这种情况。 相反地，dataclass() 装饰器在检测到类型为 list, dict 或 set 的默认形参时将会引发 TypeError。 这是一个部分解决方案，但它确实能防止许多常见错误。

使用默认工厂函数是一种创建可变类型新实例的方法，并将其作为字段的默认值:

@dataclass
class D:
    x: list = field(default_factory=list)

assert D().x is not D().x

描述器类型的字段

当字段被 描述器对象 赋值为默认值时会遵循以下行为:

字段的值被传递到数据类的 __init__ 方法时，会传递给描述器的 __set__ 方法，而不会覆盖掉描述器对象。

相似的是，当我们获取或设置字段的值时，不会覆盖或返回描述器对象，而是会调用描述器的 __get__ 或 __set__ 方法后返回。

检测一个字段是否存在默认值时 ，dataclasses 将使用类方法（即 descriptor.__get__(obj=None, type=cls) ）调用描述器的 __get__ 方法。 在这种情况下，如果描述器拥有返回值 ，则返回值为该字段的默认值。如果在这种情况下描述器抛出 AttributeError 错误，则该字段不存在默认值。

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    # calls __set__ with 2.5
print(i.quantity_on_hand)   # 2

若一个字段的类型是描述器，但其默认值并不是描述器对象，那么该字段只会像普通的字段一样工作。

contextlib --- 为 with语句上下文提供的工具

源代码 Lib/contextlib.py [https://github.com/python/cpython/tree/3.10/Lib/contextlib.py]

此模块为涉及 with 语句的常见任务提供了实用的工具。更多信息请参见 上下文管理器类型 和 with 语句上下文管理器。

工具

提供的函数和类：

class contextlib.AbstractContextManager

一个为实现了 object.__enter__() 与 object.__exit__() 的类提供的 abstract base class。为 object.__enter__() 提供的一个默认实现是返回 self 而 object.__exit__() 是一个默认返回 None 的抽象方法。 参见 上下文管理器类型 的定义。

3.6 新版功能.

class contextlib.AbstractAsyncContextManager

一个为实现了 object.__aenter__() 与 object.__aexit__() 的类提供的 abstract base class。 为 object.__aenter__() 提供的一个默认实现是返回 self 而 object.__aexit__() 是一个默认返回 None 的抽象方法。 参见 异步上下文管理器 的定义。

3.7 新版功能.

@contextlib.contextmanager

这个函数是一个 decorator ，它可以定义一个支持 with 语句上下文管理器的工厂函数， 而不需要创建一个类或区 __enter__() 与 __exit__() 方法。

尽管许多对象原生支持使用 with 语句，但有些需要被管理的资源并不是上下文管理器，并且没有实现 close() 方法而不能使用 contextlib.closing 。

下面是一个抽象的示例，展示如何确保正确的资源管理:

from contextlib import contextmanager

@contextmanager
def managed_resource(*args, **kwds):
    # Code to acquire resource, e.g.:
    resource = acquire_resource(*args, **kwds)
    try:
        yield resource
    finally:
        # Code to release resource, e.g.:
        release_resource(resource)

随后可以这样使用此函数:

>>> with managed_resource(timeout=3600) as resource:
...     # Resource is released at the end of this block,
...     # even if code in the block raises an exception

被装饰的函数在被调用时，必须返回一个 generator 迭代器。 这个迭代器必须只 yield 一个值出来，这个值会被用在 with 语句中，绑定到 as 后面的变量，如果给定了的话。

当生成器发生 yield 时，嵌套在 with 语句中的语句体会被执行。 语句体执行完毕离开之后，该生成器将被恢复执行。 如果在该语句体中发生了未处理的异常，则该异常会在生成器发生 yield 时重新被引发。 因此，你可以使用 try...except...finally 语句来捕获该异常（如果有的话），或确保进行了一些清理。 如果仅出于记录日志或执行某些操作（而非完全抑制异常）的目的捕获了异常，生成器必须重新引发该异常。 否则生成器的上下文管理器将向 with 语句指示该异常已经被处理，程序将立即在 with 语句之后恢复并继续执行。

contextmanager() 使用 ContextDecorator 因此它创建的上下文管理器不仅可以用在 with 语句中，还可以用作一个装饰器。当它用作一个装饰器时，每一次函数调用时都会隐式创建一个新的生成器实例（这使得 contextmanager() 创建的上下文管理器满足了支持多次调用以用作装饰器的需求，而非“一次性”的上下文管理器）。

在 3.2 版更改: ContextDecorator 的使用。

@contextlib.asynccontextmanager

与 contextmanager() 类似，但创建的是 asynchronous context manager 。

这个函数是一个 decorator ，它可以定义一个支持 async with 语句的异步上下文管理器的工厂函数， 而不需要创建一个类或区分 __aenter__() 与 __aexit__() 方法。它必须被作用在一个 asynchronous generator 函数上

一个简单的示例：

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 ...')

3.7 新版功能.

使用 asynccontextmanager() 定义的上下文管理器可以用作装饰器，也可以在 async with 语句中使用。

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():
    # ... async code ...

用作装饰器时，每次函数调用都会隐式创建一个新的生成器实例。这使得由 asynccontextmanager() 创建的 “一次性” 上下文管理器能够满足作为装饰器所需要的支持多次调用的要求。

在 3.10 版更改: 使用 asynccontextmanager() 创建的异步上下文管理器可以用作装饰器。

contextlib.closing(thing)

返回一个在语句块执行完成时关闭 things 的上下文管理器。这基本上等价于：

from contextlib import contextmanager

@contextmanager
def closing(thing):
    try:
        yield thing
    finally:
        thing.close()

并允许你编写这样的代码：

from contextlib import closing
from urllib.request import urlopen

with closing(urlopen('https://www.python.org')) as page:
    for line in page:
        print(line)

而无需显式地关闭 page 。 即使发生错误，在退出 with 语句块时， page.close() 也同样会被调用。

contextlib.aclosing(thing)

返回一个在语句块执行完成时调用 aclose() 方法来关闭 things 的异步上下文管理器。这基本上等价于：

from contextlib import asynccontextmanager

@asynccontextmanager
async def aclosing(thing):
    try:
        yield thing
    finally:
        await thing.aclose()

重要的是，aclosing() 支持在异步生成器因遭遇 break 或异常而提前退出时对其执行确定性的清理。 例如:

from contextlib import aclosing

async with aclosing(my_generator()) as values:
    async for value in values:
        if value == 42:
            break

此模块将确保生成器的异步退出代码在与其迭代相同的上下文中执行（这样异常和上下文变量将能按预期工作，并且退出代码不会在其所依赖的某些任务的生命期结束后继续运行）。

3.10 新版功能.

contextlib.nullcontext(enter_result=None)

返回一个从 __enter__ 返回 enter_result 的上下文管理器，除此之外不执行任何操作。它旨在用于可选上下文管理器的一种替代，例如：

def myfunction(arg, ignore_exceptions=False):
    if ignore_exceptions:
        # Use suppress to ignore all exceptions.
        cm = contextlib.suppress(Exception)
    else:
        # Do not ignore any exceptions, cm has no effect.
        cm = contextlib.nullcontext()
    with cm:
        # Do something

一个使用 enter_result 的例子：

def process_file(file_or_path):
    if isinstance(file_or_path, str):
        # If string, open file
        cm = open(file_or_path)
    else:
        # Caller is responsible for closing file
        cm = nullcontext(file_or_path)

    with cm as file:
        # Perform processing on the file

它也可以替代 asynchronous context managers ：

async def send_http(session=None):
    if not session:
        # If no http session, create it with aiohttp
        cm = aiohttp.ClientSession()
    else:
        # Caller is responsible for closing the session
        cm = nullcontext(session)

    async with cm as session:
        # Send http requests with session

3.7 新版功能.

在 3.10 版更改: 增加了对 asynchronous context manager 的支持。

contextlib.suppress(*exceptions)

返回一个当指定的异常在 with 语句体中发生时会屏蔽它们然后从 with 语句结束后的第一条语言开始恢复执行的上下文管理器。

与完全抑制异常的任何其他机制一样，该上下文管理器应当只用来抑制非常具体的错误，并确保该场景下静默地继续执行程序是通用的正确做法。

例如：

from contextlib import suppress

with suppress(FileNotFoundError):
    os.remove('somefile.tmp')

with suppress(FileNotFoundError):
    os.remove('someotherfile.tmp')

这段代码等价于：

try:
    os.remove('somefile.tmp')
except FileNotFoundError:
    pass

try:
    os.remove('someotherfile.tmp')
except FileNotFoundError:
    pass

该上下文管理器是 reentrant 。

3.4 新版功能.

contextlib.redirect_stdout(new_target)

用于将 sys.stdout 临时重定向到一个文件或类文件对象的上下文管理器。

该工具给已有的将输出硬编码写到 stdout 的函数或类提供了额外的灵活性。

例如， help() 的输出通常会被发送到 sys.stdout。 你可以通过将输出重定向到一个 io.StringIO 对象来将该输出捕获到字符串。 替换的流是由 __enter__ 返回的因此可以被用作 with 语句的目标:

with redirect_stdout(io.StringIO()) as f:
    help(pow)
s = f.getvalue()

如果要把 help() 的输出写到磁盘上的一个文件，重定向该输出到一个常规文件：

with open('help.txt', 'w') as f:
    with redirect_stdout(f):
        help(pow)

如果要把 help() 的输出写到 sys.stderr ：

with redirect_stdout(sys.stderr):
    help(pow)

需要注意的点在于， sys.stdout 的全局副作用意味着此上下文管理器不适合在库代码和大多数多线程应用程序中使用。它对子进程的输出没有影响。不过对于许多工具脚本而言，它仍然是一个有用的方法。

该上下文管理器是 reentrant 。

3.4 新版功能.

contextlib.redirect_stderr(new_target)

与 redirect_stdout() 类似，不过是将 sys.stderr 重定向到一个文件或类文件对象。

该上下文管理器是 reentrant 。

3.5 新版功能.

class contextlib.ContextDecorator

一个使上下文管理器能用作装饰器的基类。

与往常一样，继承自 ContextDecorator  的上下文管理器必须实现 __enter__ 与 __exit__ 。即使用作装饰器， __exit__ 依旧会保持可能的异常处理。

ContextDecorator 被用在 contextmanager() 中，因此你自然获得了这项功能。

ContextDecorator 的示例:

from contextlib import ContextDecorator

class mycontext(ContextDecorator):
    def __enter__(self):
        print('Starting')
        return self

    def __exit__(self, *exc):
        print('Finishing')
        return False

随后可以这样使用该类:

>>> @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

这个改动只是针对如下形式的一个语法糖：

def f():
    with cm():
        # Do stuff

ContextDecorator 使得你可以这样改写：

@cm()
def f():
    # Do stuff

这能清楚地表明， cm 作用于整个函数，而不仅仅是函数的一部分（同时也能保持不错的缩进层级）。

现有的上下文管理器即使已经有基类，也可以使用 ContextDecorator 作为混合类进行扩展：

from contextlib import ContextDecorator

class mycontext(ContextBaseClass, ContextDecorator):
    def __enter__(self):
        return self

    def __exit__(self, *exc):
        return False

注解

由于被装饰的函数必须能够被多次调用，因此对应的上下文管理器必须支持在多个 with 语句中使用。如果不是这样，则应当使用原来的具有显式 with 语句的形式使用该上下文管理器。

3.2 新版功能.

class contextlib.AsyncContextDecorator

和 ContextDecorator 类似，但是用于异步函数。

AsyncContextDecorator 的示例:

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

随后可以这样使用该类:

>>> @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

3.10 新版功能.

class contextlib.ExitStack

该上下文管理器的设计目标是使得在编码中组合其他上下文管理器和清理函数更加容易，尤其是那些可选的或由输入数据驱动的上下文管理器。

例如，通过一个如下的 with 语句可以很容易处理一组文件：

with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # All opened files will automatically be closed at the end of
    # the with statement, even if attempts to open files later
    # in the list raise an exception

__enter__() 方法返回 ExitStack 实例，并且不会执行额外的操作。

每个实例维护一个注册了一组回调的栈，这些回调在实例关闭时以相反的顺序被调用（显式或隐式地在 with 语句的末尾）。请注意，当一个栈实例被垃圾回收时，这些回调将 不会 被隐式调用。

通过使用这个基于栈的模型，那些通过 __init__ 方法获取资源的上下文管理器（如文件对象）能够被正确处理。

由于注册的回调函数是按照与注册相反的顺序调用的，因此最终的行为就像多个嵌套的 with 语句用在这些注册的回调函数上。这个行为甚至扩展到了异常处理：如果内部的回调函数抑制或替换了异常，则外部回调收到的参数是基于该更新后的状态得到的。

这是一个相对底层的 API，它负责正确处理栈里回调退出时依次展开的细节。它为相对高层的上下文管理器提供了一个合适的基础，使得它能根据应用程序的需求使用特定方式操作栈。

3.3 新版功能.

enter_context(cm)

进入一个新的上下文管理器并将其 __exit__() 方法添加到回调栈中。 返回值是该上下文管理器自己的 __enter__() 方法的输出结果。

这些上下文管理器可能会屏蔽异常就如当它们作为 with 语句的一部分直接使用时通常表现的行为一样。

push(exit)

将一个上下文管理器的 __exit__() 方法添加到回调栈。

由于 __enter__ 没有 被发起调用，此方法可以被用来通过一个上下文管理器自己的 __exit__() 覆盖 __enter__() 的部分实现。

如果传递了一个不是上下文管理器的对象，此方法将假定它是一个回调 具有与上下文管理器的 __exit__() 方法相同的签名的回调并会直接将其添加到回调栈中。

通过返回真值，这些回调可以通过与上下文管理器 __exit__() 方法相同的方式屏蔽异常。

传入的对象将被该函数返回，允许此方法作为函数装饰器使用。

callback(callback, /, *args, **kwds)

接受一个任意的回调函数和参数并将其添加到回调栈。

与其他方法不同，通过此方式添加的回调无法屏蔽异常（因为异常的细节不会被传递给它们）。

传入的回调将被该函数返回，允许此方法作为函数装饰器使用。

pop_all()

将回调栈传输到一个新的 ExitStack 实例并返回它。 此操作不会唤起任何回调 —— 作为替代，现在当新栈被关闭时它们将（显式地或是在一条 with 语句结束时隐式地）被唤起。

例如，一组文件可以像下面这样以“一个都不能少”的操作方式被打开:

with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # Hold onto the close method, but don't call it yet.
    close_files = stack.pop_all().close
    # If opening any file fails, all previously opened files will be
    # closed automatically. If all files are opened successfully,
    # they will remain open even after the with statement ends.
    # close_files() can then be invoked explicitly to close them all.

close()

立即展开回调栈，按注册时的相反顺序唤起其中的回调。 对于任何已注册的上下文管理器和退出回调，传入的参数将表明没有发生异常。

class contextlib.AsyncExitStack

一个 异步上下文管理器，类似于 ExitStack，它支持组合同步和异步上下文管理器，并拥有针对清理逻辑的协程。

close() 方法没有被实现，使用 aclose() 替代。

coroutine enter_async_context(cm)

与 enter_context() 相似，但是需要一个异步上下文管理器。

push_async_exit(exit)

与 push() 相似，但是需要一个异步上下文管理器或协程函数。

push_async_callback(callback, /, *args, **kwds)

与 callback() 相似，但是需要一个协程函数。

coroutine aclose()

和 close() 相似，但是它正确处理了可等待对象。

从 asynccontextmanager() 的例子继续：

async with AsyncExitStack() as stack:
    connections = [await stack.enter_async_context(get_connection())
        for i in range(5)]
    # All opened connections will automatically be released at the end of
    # the async with statement, even if attempts to open a connection
    # later in the list raise an exception.

3.7 新版功能.

例子和配方

本节描述了一些用于有效利用 contextlib 所提供的工具的示例和步骤说明。

支持可变数量的上下文管理器

ExitStack 的主要应用场景已在该类的文档中给出：在单个 with 语句中支持可变数量的上下文管理器和其他清理操作。 这个可变性可以来自通过用户输入驱动所需的上下文管理器数量（例如打开用户所指定的文件集），或者来自将某些上下文管理器作为可选项。

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)
    # Perform operations that use the acquired resources

如上所示，ExitStack 还让使用 with 语句来管理任意非原生支持上下文管理协议的资源变得相当容易。

捕获 __enter__ 方法产生的异常

有时人们会想要从 __enter__ 方法的实现中捕获异常，而 不会 无意中捕获来自 with 语句体或上下文管理器的 __exit__ 方法的异常。 通过使用 ExitStack 可以将上下文管理协议中的步骤稍微分开以允许这样做:

stack = ExitStack()
try:
    x = stack.enter_context(cm)
except Exception:
    # handle __enter__ exception
else:
    with stack:
        # Handle normal case

实际上需要这样做很可能表明下层的 API 应该提供一个直接的资源管理接口以便与 try/except/finally 语句配合使用，但并不是所有的 API 在这方面都设计得很好。 当上下文管理器是所提供的唯一资源管理 API 时，则 ExitStack 可以让处理各种无法在 with 语句中直接处理的情况变得更为容易。

在一个 __enter__ 方法的实现中进行清理

正如 ExitStack.push() 的文档中所指出，如果在 __enter__() 实现中的后续步骤失败则此方法在清理已分配的资源时将很有用处。

下面是为一个上下文管理器做这件事的例子，该上下文管理器可接受资源获取和释放函数，以及可选的验证函数，并将它们映射到上下文管理协议:

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
            # The validation check passed and didn't raise an exception
            # Accordingly, we want to keep the resource, and pass it
            # back to our caller
            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):
        # We don't need to duplicate any of our resource release logic
        self.release_resource()

替换任何对 try-finally 和旗标变量的使用

一种你有时将看到的模式是 try-finally 语句附带一个旗标变量来指明 finally 子句体是否要被执行。 在其最简单的形式中（它无法仅仅通过改用一条 except 子句来预先处理），看起来会是这样:

cleanup_needed = True
try:
    result = perform_operation()
    if result:
        cleanup_needed = False
finally:
    if cleanup_needed:
        cleanup_resources()

就如任何基于 try 语句的代码一样，这可能会导致开发和审查方面的问题，因为设置代码和清理代码最终可能会被任意长的代码部分所分隔。

ExitStack 将允许选择在一条 with 语句末尾注册一个用于执行的回调的替代方式，等以后再决定是否跳过该回调的执行:

from contextlib import ExitStack

with ExitStack() as stack:
    stack.callback(cleanup_resources)
    result = perform_operation()
    if result:
        stack.pop_all()

这允许在事先显式地指明预期的清理行为，而不需要一个单独的旗标变量。

如果某个应用程序大量使用此模式，则可以通过使用一个较小的辅助类来进一步地简化它:

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()

如果资源清理操作尚未完善地捆绑到一个独立的函数中，则仍然可以使用 ExitStack.callback() 的装饰器形式来提前声明资源清理:

from contextlib import ExitStack

with ExitStack() as stack:
    @stack.callback
    def cleanup_resources():
        ...
    result = perform_operation()
    if result:
        stack.pop_all()

受装饰器协议工作方式的影响，以此方式声明的回调函数无法接受任何形参。 作为替代，任何要释放的资源必须作为闭包变量来访问。

将上下文管理器作为函数装饰器使用

ContextDecorator 类允许将上下文管理器作为函数装饰器使用，而不仅在 with 语句块中使用。

例如，有时将函数或语句组包装在一个可以跟踪进入和退出时间的记录器中是很有用的。 与其为任务同时编写函数装饰器和上下文管理器，不如继承 ContextDecorator 在一个定义中同时提供这两种能力:

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)

这个类的实例既可以被用作上下文管理器：

with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()

也可以被用作函数装饰器：

@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()

使用上下文管理器作为函数装饰器时，有一个额外限制：没有办法得到 __enter__() 的返回值。如果需要返回值，你仍然需要显式使用 with 语句。

参见

PEP 343 [https://www.python.org/dev/peps/pep-0343] - "with" 语句

Python with 语句的规范描述、背景和示例。

单独使用，可重用并可重进入的上下文管理器

大多数上下文管理器的编写方式意味着它们只能在一个 with 语句中被有效使用一次。 这些一次性使用的上下文管理器必须在每次被使用时重新创建 —— 试图第二次使用它们将会触发异常或是不能正确工作。

这个常见的限制意味着通常来说都建议在 with 语句开头上下文管理器被使用的位置直接创建它们（如下面所有的使用示例所显示的）。

文件是一个高效的单次使用上下文管理器的例子，因为第一个 with 语句将关闭文件，防止任何后续的使用该文件对象的 IO 操作。

使用 contextmanager() 创建的上下文管理器也是单次使用的上下文管理器，并会在试图第二次使用它们时报告下层生成器无法执行产生操作:

>>> 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

重进入上下文管理器

更复杂的上下文管理器可以“重进入”。 这些上下文管理器不但可以被用于多个 with 语句中，还可以被用于已经在使用同一个上下文管理器的 with 语句 内部。

threading.RLock 是一个可重入上下管理器的例子，suppress() 和 redirect_stdout() 也是如此。 下面是一个非常简单的可重入使用的示例:

>>> 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

现实世界的可重入例子更可能涉及到多个函数的相互调用因此会比这个例子要复杂得多。

还要注意可重入与线程安全 不是 一回事。 举例来说，redirect_stdout() 肯定不是线程安全的，因为它会通过将 sys.stdout 绑定到一个不同的流对系统状态做了全局性的修改。

可重用的上下文管理器

与单次使用和可重入上下文管理器都不同的还有“可重用”上下文管理器（或者，使用完全显式的表达应为“可重用，但不可重入”上下文管理器，因为可重入上下文管理器也会是可重用的）。 这些上下文管理器支持多次使用，但如果特定的上下文管理器实例已经在包含它的 with 语句中被使用过则将失败（或者不能正确工作）。

threading.Lock 是一个可重用，但是不可重入的上下文管理器的例子（对于可重入锁，则有必要使用 threading.RLock 来代替）。

另一个可重用，但不可重入的上下文管理器的例子是 ExitStack，因为它在离开任何 with 语句时会唤起 所有 当前已注册的回调，不论回调是在哪里添加的:

>>> 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

正如这个例子的输出所显示的，在多个 with 语句中重用一个单独的栈对象可以正确工作，但调试嵌套它们就将导致栈在最内层的 with 语句结束时被清空，这不大可能是符合期望的行为。

使用单独的 ExitStack 实例而不是重复使用一个实例可以避免此问题:

>>> 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

abc --- 抽象基类

源代码： Lib/abc.py [https://github.com/python/cpython/tree/3.10/Lib/abc.py]

该模块提供了在 Python 中定义 抽象基类 (ABC) 的组件，在 PEP 3119 [https://www.python.org/dev/peps/pep-3119] 中已有概述。查看 PEP 文档了解为什么需要在 Python 中增加这个模块。（也可查看 PEP 3141 [https://www.python.org/dev/peps/pep-3141] 以及 numbers 模块了解基于 ABC 的数字类型继承关系。）

collections 模块中有一些派生自 ABC 的实体类；当然，这些类还可以进一步被派生。 此外，collections.abc 子模块中有一些可被用于测试一个类或实例是否提供了特定接口的 ABC，例如，它是否为 hashable 或者是否为映射等。

该模块提供了一个元类 ABCMeta，可以用来定义抽象类，另外还提供一个工具类 ABC，可以用它以继承的方式定义抽象基类。

class abc.ABC

一个使用 ABCMeta 作为元类的工具类。抽象基类可以通过从 ABC 派生来简单地创建，这就避免了在某些情况下会令人混淆的元类用法，例如：

from abc import ABC

class MyABC(ABC):
    pass

注意 ABC 的类型仍然是 ABCMeta，因此继承 ABC 仍然需要关注元类使用中的注意事项，比如可能会导致元类冲突的多重继承。当然你也可以直接使用 ABCMeta 作为元类来定义抽象基类，例如：

from abc import ABCMeta

class MyABC(metaclass=ABCMeta):
    pass

3.4 新版功能.

class abc.ABCMeta

用于定义抽象基类（ABC）的元类。

使用该元类以创建抽象基类。抽象基类可以像 mix-in 类一样直接被子类继承。你也可以将不相关的具体类（包括内建类）和抽象基类注册为“抽象子类” —— 这些类以及它们的子类会被内建函数 issubclass() 识别为对应的抽象基类的子类，但是该抽象基类不会出现在其 MRO（Method Resolution Order，方法解析顺序）中，抽象基类中实现的方法也不可调用（即使通过 super() 调用也不行）。1

使用 ABCMeta 作为元类创建的类含有如下方法：

register(subclass)

将 subclass 注册为该 ABC 的“虚拟子类”。 例如:

from abc import ABC

class MyABC(ABC):
    pass

MyABC.register(tuple)

assert issubclass(tuple, MyABC)
assert isinstance((), MyABC)

在 3.3 版更改: 返回注册的子类，使其能够作为类装饰器。

在 3.4 版更改: 你可以使用 get_cache_token() 函数来检测对 register() 的调用。

你也可以在虚基类中重写这个方法。

__subclasshook__(subclass)

（必须定义为类方法。）

检查 subclass 是否是该抽象基类的子类。也就是说对于那些你希望定义为该抽象基类的子类的类，你不用对每个类都调用 register() 方法了，而是可以直接自定义 issubclass 的行为。（这个类方法是在抽象基类的 __subclasscheck__() 方法中调用的。）

该方法必须返回 True, False 或是 NotImplemented。如果返回 True，subclass 就会被认为是这个抽象基类的子类。如果返回 False，无论正常情况是否应该认为是其子类，统一视为不是。如果返回 NotImplemented，子类检查会按照正常机制继续执行。

为了对这些概念做一演示，请看以下定义 ABC 的示例：

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)

ABC MyIterable 定义了标准的迭代方法 __iter__() 作为一个抽象方法。这里给出的实现仍可在子类中被调用。get_iterator() 方法也是 MyIterable 抽象基类的一部分，但它并非必须被非抽象派生类所重载。

这里定义的 __subclasshook__() 类方法指明了任何在其 __dict__ (或在其通过 __mro__ 列表访问的基类) 中具有 __iter__() 方法的类也都会被视为 MyIterable。

最后，末尾行使得 Foo 成为 MyIterable 的一个虚子类，即便它并没有定义 __iter__() 方法（它使用了以 __len__() 和 __getitem__() 术语定义的旧式可迭代对象协议）。注意这将不会使 get_iterator 成为对 Foo 来说可用的方法，所以也另外提供了一个它。

此外，abc 模块还提供了这些装饰器：

@abc.abstractmethod

用于声明抽象方法的装饰器。

使用此装饰器要求类的元类是 ABCMeta 或是从该类派生。一个具有派生自 ABCMeta 的元类的类不可以被实例化，除非它全部的抽象方法和特征属性均已被重载。抽象方法可通过任何普通的“super”调用机制来调用。 abstractmethod() 可被用于声明特性属性和描述器的抽象方法。

动态地添加抽象方法到一个类，或尝试在方法或类被创建后修改其抽象状态等操作仅在使用 update_abstractmethods() 函数时受到支持。 abstractmethod() 只会影响使用常规继承所派生的子类；通过 ABC 的 register() 方法注册的“虚子类”不会受到影响。

当 abstractmethod() 与其他方法描述符配合应用时，它应当被应用为最内层的装饰器，如以下用法示例所示:

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)

为了正确地与抽象基类机制互操作，描述器必须使用 __isabstractmethod__ 将自身标为抽象的。通常，如果组成描述器的任一方法是抽象的，那么此属性就应为 True。例如，Python 内置的 property 所做的就等价于：

class Descriptor:
    ...
    @property
    def __isabstractmethod__(self):
        return any(getattr(f, '__isabstractmethod__', False) for
                   f in (self._fget, self._fset, self._fdel))

注解

不同于 Java 抽象方法，这些抽象方法可能具有一个实现。 这个实现可在重写它的类上通过 super() 机制来调用。 这在使用协作多重继承的框架中可以被用作 super 调用的一个终点。

abc 模块还支持下列旧式装饰器:

@abc.abstractclassmethod

3.2 新版功能.

3.3 版后已移除: 现在可以让 classmethod 配合 abstractmethod() 使用，使得此装饰器变得冗余。

内置 classmethod() 的子类，指明一个抽象类方法。 在其他方面它都类似于 abstractmethod()。

这个特例已被弃用，因为现在当 classmethod() 装饰器应用于抽象方法时它会被正确地标识为抽象的:

class C(ABC):
    @classmethod
    @abstractmethod
    def my_abstract_classmethod(cls, arg):
        ...

@abc.abstractstaticmethod

3.2 新版功能.

3.3 版后已移除: 现在可以让 staticmethod 配合 abstractmethod() 使用，使得此装饰器变得冗余。

内置 staticmethod() 的子类，指明一个抽象静态方法。 在其他方面它都类似于 abstractmethod()。

这个特例已被弃用，因为现在当 staticmethod() 装饰器应用于抽象方法时它会被正确地标识为抽象的:

class C(ABC):
    @staticmethod
    @abstractmethod
    def my_abstract_staticmethod(arg):
        ...

@abc.abstractproperty

3.3 版后已移除: 现在可以让 property, property.getter(), property.setter() 和 property.deleter() 配合 abstractmethod() 使用，使得此装饰器变得冗余。

内置 property() 的子类，指明一个抽象特性属性。

这个特例已被弃用，因为现在当 property() 装饰器应用于抽象方法时它会被正确地标识为抽象的:

class C(ABC):
    @property
    @abstractmethod
    def my_abstract_property(self):
        ...

上面的例子定义了一个只读特征属性；你也可以通过适当地将一个或多个下层方法标记为抽象的来定义可读写的抽象特征属性:

class C(ABC):
    @property
    def x(self):
        ...

    @x.setter
    @abstractmethod
    def x(self, val):
        ...

如果只有某些组件是抽象的，则只需更新那些组件即可在子类中创建具体的特征属性:

class D(C):
    @C.x.setter
    def x(self, val):
        ...

abc 模块还提供了这些函数：

abc.get_cache_token()

返回当前抽象基类的缓存令牌

此令牌是一个不透明对象（支持相等性测试），用于为虚子类标识抽象基类缓存的当前版本。 此令牌会在任何 ABC 上每次调用 ABCMeta.register() 时发生更改。

3.4 新版功能.

abc.update_abstractmethods(cls)

重新计算一个抽象类的抽象状态的函数。 如果一个类的抽象方法在类被创建后被实现或被修改则应当调用此函数。 通常，此函数应当在一个类装饰器内部被调用。

返回 cls，使其能够用作类装饰器。

如果 cls 不是 ABCMeta 的子类，则不做任何操作。

注解

此函数会假定 cls 的上级类已经被更新。 它不会更新任何子类。

3.10 新版功能.

备注

1

C++ 程序员需要注意：Python 中虚基类的概念和 C++ 中的并不相同。

atexit --- 退出处理器

atexit 模块定义了清理函数的注册和反注册函数. 被注册的函数会在解释器正常终止时执行. atexit 会按照注册顺序的*逆序*执行; 如果你注册了 A, B 和 C, 那么在解释器终止时会依序执行 C, B, A.

注意: 通过该模块注册的函数, 在程序被未被 Python 捕获的信号杀死时并不会执行, 在检测到 Python 内部致命错误以及调用了 os._exit() 时也不会执行.

在 3.7 版更改: 当配合 C-API 子解释器使用时，已注册函数是它们所注册解释器中的局部对象。

atexit.register(func, *args, **kwargs)

将 func 注册为终止时执行的函数. 任何传给 func 的可选的参数都应当作为参数传给 register(). 可以多次注册同样的函数及参数.

在正常的程序终止时 (举例来说, 当调用了 sys.exit() 或是主模块的执行完成时), 所有注册过的函数都会以后进先出的顺序执行. 这样做是假定更底层的模块通常会比高层模块更早引入, 因此需要更晚清理.

如果在 exit 处理器执行期间引发了异常，将会打印回溯信息 (除非引发的是 SystemExit) 并且异常信息会被保存。 在所有 exit 处理器都获得运行机会之后，所引发的最后一个异常会被重新引发。

这个函数返回 func 对象，可以把它当作装饰器使用。

atexit.unregister(func)

将 func 移出当解释器关闭时要运行的函数列表。 如果 func 之前未被注册则 unregister() 将静默地不做任何事。 如果 func 已被注册一次以上，则该函数每次在 atexit 调用栈中的出现都将被移除。 当取消注册时会在内部使用相等性比较 (==)，因而函数引用不需要具有匹配的标识号。

参见

模块 readline

使用 atexit 读写 readline 历史文件的有用的例子。

atexit 示例

以下简单例子演示了一个模块在被导入时如何从文件初始化一个计数器，并在程序终结时自动保存计数器的更新值，此操作不依赖于应用在终结时对此模块进行显式调用。:

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)

位置和关键字参数也可传入 register() 以便传递给被调用的已注册函数:

def goodbye(name, adjective):
    print('Goodbye %s, it was %s to meet you.' % (name, adjective))

import atexit

atexit.register(goodbye, 'Donny', 'nice')
# or:
atexit.register(goodbye, adjective='nice', name='Donny')

作为 decorator: 使用:

import atexit

@atexit.register
def goodbye():
    print('You are now leaving the Python sector.')

只有在函数不需要任何参数调用时才能工作.

traceback —— 打印或读取栈回溯信息

源代码： Lib/traceback.py [https://github.com/python/cpython/tree/3.10/Lib/traceback.py]

该模块提供了一个标准接口来提取、格式化和打印 Python 程序的栈跟踪结果。它完全模仿Python 解释器在打印栈跟踪结果时的行为。当您想要在程序控制下打印栈跟踪结果时，例如在“封装”解释器时，这是非常有用的。

这个模块使用 traceback 对象 —— 这是存储在 sys.last_traceback 中的对象类型变量，并作为 sys.exc_info() 的第三项被返回。

参见

模块 faulthandler

用于在发生错误、超时或用户信号时显式地转储 Python 回溯信息。

模块 pdb

用于 Python 程序的交互式源代码调试器。

这个模块定义了以下函数：

traceback.print_tb(tb, limit=None, file=None)

如果*limit*是正整数，那么从 traceback 对象 "tb" 输出最高 limit 个（从调用函数开始的）栈的堆栈回溯‎条目‎；如果 limit 是负数就输出 abs(limit) 个回溯条目；又如果 limit 被省略或者为 None ，那么就会输出所有回溯条目。如果 file 被省略或为 None 那么就会输出至标准输出 sys.stderr 否则它应该是一个打开的文件或者文件类对象来接收输出

在 3.5 版更改: 添加了对负数值 limit 的支持

traceback.print_exception(exc, /, [value, tb, ]limit=None, file=None, chain=True)

打印回溯对象 tb 到 file 的异常信息和整个堆栈回溯。这和 print_tb() 比有以下方面不同：

如果 tb 不为 None，它将打印头部 Traceback (most recent call last):

它将在栈回溯之后打印异常类型和 value

如果 type(value) 为 SyntaxError 且 value 具有适当的格式，它会打印发生语法错误的行并用一个圆点来指明错误的大致位置。

从 Python 3.10 开始，可以不再传递 value 和 tb，而是传递一个异常对象作为第一个参数。 如果提供了 value 和 tb，则第一个参数会被忽略以便提供向下兼容性。

可选的 limit 参数具有与 print_tb() 的相同含义。 如果 chain 为真值（默认），则链式异常（异常的 __cause__ 或 __context__ 属性）也将被打印出来，就像解释器本身在打印未处理的异常时一样。

在 3.5 版更改: etype 参数会被忽略并根据 value 推断出来。

在 3.10 版更改: etype 形参已被重命名为 exc 并且现在是仅限位置形参。

traceback.print_exc(limit=None, file=None, chain=True)

这是 print_exception(*sys.exc_info(), limit, file, chain) 的简写。

traceback.print_last(limit=None, file=None, chain=True)

这是 print_exception(sys.last_type, sys.last_value, sys.last_traceback, limit, file, chain) 的简写。 通常它将只在异常到达交互提示之后才会起作用 (参见 sys.last_type)。

traceback.print_stack(f=None, limit=None, file=None)

如果 limit 为正数则打印至多 limit 个栈回溯条目（从发起调用点开始）。 在其他情况下，则打印最后 abs(limit) 个条目。 如果 limit 被省略或为 None，则会打印所有条目。 可选的 f 参数可被用来指明一个用于开始的替代栈。 可选的 file 参数具有与 print_tb() 的相同含义。

在 3.5 版更改: 添加了对负数值 limit 的支持

traceback.extract_tb(tb, limit=None)

返回一个 StackSummary 对象来代表从回溯对象 tb 提取的 "预处理" 栈回溯条目列表。 它适用于栈回溯的替代格式化。 可选的 limit 参数具有与 print_tb() 的相同含义。 "预处理" 栈回溯条目是一个 FrameSummary 对象，其中包含代表通常为栈回溯打印的信息的 filename, lineno, name 和 line 等属性。 line 是一个去除了前导和末尾空白符的字符串；如果源代码不可用则它将为 None。

traceback.extract_stack(f=None, limit=None)

从当前的栈帧提取原始回溯信息。 返回值具有与 extract_tb() 的相同格式。 可选的 f 和 limit 参数具有与 print_stack() 的相同含义。

traceback.format_list(extracted_list)

给定一个由元组或如 extract_tb() 或 extract_stack() 所返回的 FrameSummary 对象组成的列表，返回一个可打印的字符串列表。 结果列表中的每个字符串都对应于参数列表中具有相同索引号的条目。 每个字符串以一个换行符结束；对于那些源文本行不为 None 的条目，字符串也可能包含内部换行符。

traceback.format_exception_only(exc, /[, value])

使用 sys.last_value 等给出的异常值来格式化回溯中的异常部分。 返回值是一个字符串的列表，每个字符串都以换行符结束。 通常，此列表只包含单个字符串；但是，对于 SyntaxError 异常，它将包含多行并且（当打印时）会显示有关语法错误在何处发生的详细信息。 指明发生了哪种异常的消息将总是该列表中的最后一个字符串。

从 Python 3.10 开始，可以不传入 value，而是传入一个异常对象作为第一个参数。 如果提供了 value，则第一个参数将被忽略以便提供向下兼容性。

在 3.10 版更改: etype 形参已被重命名为 exc 并且现在是仅限位置形参。

traceback.format_exception(exc, /, [value, tb, ]limit=None, chain=True)

格式化一个栈跟踪和异常信息。 参数的含义与传给 print_exception() 的相应参数相同。 返回值是一个字符串列表，每个字符串都以一个换行符结束且有些还包含内部换行符。 当这些行被拼接并打印时，打印的文本与 print_exception() 的完全相同。

在 3.5 版更改: etype 参数会被忽略并根据 value 推断出来。

在 3.10 版更改: 此函数的行为和签名已被修改以与 print_exception() 相匹配。

traceback.format_exc(limit=None, chain=True)

这类似于 print_exc(limit) 但会返回一个字符串而不是打印到一个文件。

traceback.format_tb(tb, limit=None)

是 format_list(extract_tb(tb, limit)) 的简写形式。

traceback.format_stack(f=None, limit=None)

是 format_list(extract_stack(f, limit)) 的简写形式。

traceback.clear_frames(tb)

通过调用每个帧对象的 clear() 方法来清除回溯 tb 中所有栈帧的局部变量。

3.4 新版功能.

traceback.walk_stack(f)

从给定的帧开始访问 f.f_back 之后的栈，产生每一帧的帧和行号。 如果 f 为 None，则会使用当前栈。 这个辅助函数要与 StackSummary.extract() 一起使用。

3.5 新版功能.

traceback.walk_tb(tb)

访问 tb_next 之后的回溯并产生每一帧的帧和行号。 这个辅助函数要与 StackSummary.extract() 一起使用。

3.5 新版功能.

此模块还定义了以下的类:

TracebackException 对象

3.5 新版功能.

TracebackException 对象基于实际的异常创建通过轻量的方式捕获数据以便随后打印。

class traceback.TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False, compact=False)

捕获一个异常以便随后渲染。 limit, lookup_lines 和 capture_locals 的含义与 StackSummary 类的相同。

如果 compact 为真值，则只有 TracebackException 的 format 方法所需要的数据会被保存在类属性中。 特别地，__context__ 字段只有在 __cause__ 为 None 且 __suppress_context__ 为假值时才会被计算。

请注意当局部变量被捕获时，它们也会被显示在回溯中。

__cause__

原始 __cause__ 的 TracebackException。

__context__

原始 __context__ 的 TracebackException。

__suppress_context__

来自原始异常的 __suppress_context__。

stack

代表回溯的 StackSummary。

exc_type

原始回溯的类。

filename

针对语法错误 —— 错误发生所在的文件名。

lineno

针对语法错误 —— 错误发生所在的行号。

end_lineno

针对语法错误 —— 错误发生所在的末尾行号。 如不存在则可以为 None。

3.10 新版功能.

text

针对语法错误 —— 错误发生所在的文本。

offset

针对语法错误 —— 错误发生所在的文本内部的偏移量。

end_offset

针对语法错误 —— 错误发生所在的文本末尾偏移量。 如不存在则可以为 None。

3.10 新版功能.

msg

针对语法错误 —— 编译器错误消息。

classmethod from_exception(exc, *, limit=None, lookup_lines=True, capture_locals=False)

捕获一个异常以便随后渲染。 limit, lookup_lines 和 capture_locals 的含义与 StackSummary 类的相同。

请注意当局部变量被捕获时，它们也会被显示在回溯中。

format(*, chain=True)

格式化异常。

如果 chain 不为 True，则 __cause__ 和 __context__ 将不会被格式化。

返回值是一个字符串的生成器，其中每个字符串都以换行符结束并且有些还会包含内部换行符。 print_exception() 是此方法的一个包装器，它只是将这些行打印到一个文件。

指明发生了哪种异常的消息总会是输出中的最后一个字符串。

format_exception_only()

格式化回溯的异常部分。

返回值是一个字符串的生成器，每个字符串都以一个换行符结束。

通常，生成器会发出单个字符串；不过，对于 SyntaxError 异常，它会发出（当打印时）显示有关语法错误发生在何处的详细信息的多个行。

指明发生了哪种异常的消息总会是输出中的最后一个字符串。

在 3.10 版更改: 增加了 compact 形参。

StackSummary 对象

3.5 新版功能.

代表一个可被格式化的调用栈的 StackSummary 对象。

class traceback.StackSummary

classmethod extract(frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)

构造一个来自帧生成器的 StackSummary 对象（如 walk_stack() 或 walk_tb() 所返回的一样）。

如果提供了 limit，则只从 frame_gen 提取指定数量的帧。 如果 lookup_lines 为 False，则返回的 FrameSummary 对象将不会读入它们的行，这使得创建 StackSummary 的开销更低（如果它不会被实际格式化这就会很有价值）。 如果 capture_locals 为 True 则每个 FrameSummary 中的局部变量会被捕获为对象表示形式。

classmethod from_list(a_list)

从所提供的 FrameSummary 对象列表或旧式的元组列表构造一个 StackSummary 对象。 每个元组都应当是以文件、行号、名称和行为元素的 4 元组。

format()

返回一个可打印的字符串列表。 结果列表中的每个字符串各自对应来自于栈的单独帧。 每个字符串都以一个换行符结束；对于带有源文本行的条目来说，字符串还可能包含内部换行符。

对于同一帧与行的长序列，将显示前几个重复项，后面跟一个指明之后的实际重复次数的摘要行。

在 3.6 版更改: 重复帧的长序列现在将被缩减。

FrameSummary 对象

3.5 新版功能.

FrameSummary 对象代表回溯中的一个单独帧。

class traceback.FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None)

代表回溯或栈中被格式化或打印的一个单独帧。 它有时可能还带有包括在其中的帧局部变量的字符串化版本。 如果 lookup_line 为 False，则不会查找源代码直到 FrameSummary 已经访问了 line 属性（这还将发生在将其转换为元组时）。 line 可能会被直接提供，并将完全阻止行查找的发生。 locals 是一个可选的局部变量字典，如果有提供的话这些变量的表示形式将被存储在摘要中以便随后显示。

回溯示例

这个简单示例是一个基本的读取-求值-打印循环，类似于（但实用性小于）标准 Python 交互式解释器循环。 对于解释器循环的更完整实现，请参阅 code 模块。

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)

下面的例子演示了打印和格式化异常与回溯的不同方式:

import sys, traceback

def lumberjack():
    bright_side_of_life()

def bright_side_of_life():
    return tuple()[0]

try:
    lumberjack()
except IndexError:
    exc_type, exc_value, exc_traceback = sys.exc_info()
    print("*** print_tb:")
    traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)
    print("*** print_exception:")
    traceback.print_exception(exc_value, 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_value)))
    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)

该示例的输出看起来像是这样的:

*** 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...>", line 10, in <module>\n    lumberjack()\n',
 '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_life()\n',
 '  File "<doctest...>", line 7, in bright_side_of_life\n    return tuple()[0]\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...>", line 10, in <module>\n    lumberjack()\n',
 '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_life()\n',
 '  File "<doctest...>", line 7, in bright_side_of_life\n    return tuple()[0]\n']
*** tb_lineno: 10

下面的例子演示了打印和格式化栈的不同方式:

>>> 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']

最后这个例子演示了最后几个格式化函数:

>>> 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(type(an_error), an_error)
['IndexError: tuple index out of range\n']

__future__ --- Future 语句定义

源代码： Lib/__future__.py [https://github.com/python/cpython/tree/3.10/Lib/__future__.py]

__future__ 是一个真正的模块，这主要有 3 个原因：

避免混淆已有的分析 import 语句并查找 import 的模块的工具。

确保 future 语句 在 2.1 之前的版本运行时至少能抛出 runtime 异常（import __future__ 会失败，因为 2.1 版本之前没有这个模块）。

当引入不兼容的修改时，可以记录其引入的时间以及强制使用的时间。这是一种可执行的文档，并且可以通过 import __future__ 来做程序性的检查。

__future__.py 中的每一条语句都是以下格式的：

FeatureName = _Feature(OptionalRelease, MandatoryRelease,
                       CompilerFlag)

通常 OptionalRelease 要比 MandatoryRelease 小，并且都是和 sys.version_info 格式一致的 5 元素元组。

(PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
 PY_MINOR_VERSION, # the 1; an int
 PY_MICRO_VERSION, # the 0; an int
 PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string
 PY_RELEASE_SERIAL # the 3; an int
)

OptionalRelease 记录了一个特性首次发布时的 Python 版本。

在 MandatoryRelases 还没有发布时，MandatoryRelease 表示该特性会变成语言的一部分的预测时间。

其他情况下，MandatoryRelease 用来记录这个特性是何时成为语言的一部分的。从该版本往后，使用该特性将不需要 future 语句，不过很多人还是会加上对应的 import。

MandatoryRelease 也可能是 None, 表示这个特性已经被撤销。

_Feature 类的实例有两个对应的方法，getOptionalRelease() 和 getMandatoryRelease()。

CompilerFlag 是一个（位）标记，对于动态编译的代码，需要将这个标记作为第四个参数传入内建函数 compile() 中以开启对应的特性。这个标记存储在 _Feature 类实例的 compiler_flag 属性中。

__future__ 中不会删除特性的描述。从 Python 2.1 中首次加入以来，通过这种方式引入了以下特性：

特性 | 可选版本 | 强制加入版本 | 效果
nested_scopes | 2.1.0b1 | 2.2 | PEP 227 [https://www.python.org/dev/peps/pep-0227]: 静态嵌套作用域
generators | 2.2.0a1 | 2.3 | PEP 255 [https://www.python.org/dev/peps/pep-0255]: 简单生成器
division | 2.2.0a2 | 3.0 | PEP 238 [https://www.python.org/dev/peps/pep-0238]: 修改除法运算符
absolute_import | 2.5.0a1 | 3.0 | PEP 328 [https://www.python.org/dev/peps/pep-0328]: 导入：多行与绝对/相对
with_statement | 2.5.0a1 | 2.6 | PEP 343 [https://www.python.org/dev/peps/pep-0343]: * "with" 语句*
print_function | 2.6.0a2 | 3.0 | PEP 3105 [https://www.python.org/dev/peps/pep-3105]: print 改为函数
unicode_literals | 2.6.0a2 | 3.0 | PEP 3112 [https://www.python.org/dev/peps/pep-3112]: Python 3000 中的字节字面值
generator_stop | 3.5.0b1 | 3.7 | PEP 479 [https://www.python.org/dev/peps/pep-0479]: 在生成器中处理 StopIteration
annotations | 3.7.0b1 | TBD 1 | PEP 563 [https://www.python.org/dev/peps/pep-0563]: Postponed evaluation of annotations

1

先前计划在 Python 3.10 中强制使用 from __future__ import annotations ，但Python指导委员会两次决定推迟这一改变（ Python 3.10 的公告 [https://mail.python.org/archives/list/python-dev@python.org/message/CLVXXPQ2T2LQ5MP2Y53VVQFCXYWQJHKZ/] ； Python 3.11 的公告 [https://mail.python.org/archives/list/python-dev@python.org/message/VIZEBX5EYMSYIJNDBF6DMUMZOCWHARSO/] ）。目前还没有做出最终决定。参见 PEP 563 [https://www.python.org/dev/peps/pep-0563] 和 PEP 649 [https://www.python.org/dev/peps/pep-0649] 。

参见

future 语句

编译器怎样处理 future import。

gc --- 垃圾回收器接口

此模块提供可选的垃圾回收器的接口，提供的功能包括：关闭收集器、调整收集频率、设置调试选项。它同时提供对回收器找到但是无法释放的不可达对象的访问。由于 Python 使用了带有引用计数的回收器，如果你确定你的程序不会产生循环引用，你可以关闭回收器。可以通过调用 gc.disable() 关闭自动垃圾回收。若要调试一个存在内存泄漏的程序，调用 gc.set_debug(gc.DEBUG_LEAK) ；需要注意的是，它包含 gc.DEBUG_SAVEALL ，使得被垃圾回收的对象会被存放在 gc.garbage 中以待检查。

gc 模块提供下列函数：

gc.enable()

启用自动垃圾回收

gc.disable()

停用自动垃圾回收

gc.isenabled()

如果启用了自动回收则返回 True。

gc.collect(generation=2)

若被调用时不包含参数，则启动完全的垃圾回收。可选的参数 generation 可以是一个整数，指明需要回收哪一代（从 0 到 2 ）的垃圾。当参数 generation 无效时，会引发 ValueError 异常。返回发现的不可达对象的数目。

每当运行完整收集或最高代 (2) 收集时，为多个内置类型所维护的空闲列表会被清空。 由于特定类型特别是 float 的实现，在某些空闲列表中并非所有项都会被释放。

gc.set_debug(flags)

设置垃圾回收器的调试标识位。调试信息会被写入 sys.stderr 。此文档末尾列出了各个标志位及其含义；可以使用位操作对多个标志位进行设置以控制调试器。

gc.get_debug()

返回当前调试标识位。

gc.get_objects(generation=None)

返回一个收集器所跟踪的所有对象的列表，所返回的列表除外。 如果 generation 不为 None，则只返回收集器所跟踪的属于该生成的对象。

在 3.8 版更改: 新的 generation 形参。

引发一个 审计事件 gc.get_objects 并附带参数 generation。

gc.get_stats()

返回一个包含三个字典对象的列表，每个字典分别包含对应代的从解释器开始运行的垃圾回收统计数据。字典的键的数目在将来可能发生改变，目前每个字典包含以下内容：

collections 是该代被回收的次数；

collected 是该代中被回收的对象总数；

uncollectable 是在这一代中被发现无法收集的对象总数 （因此被移动到 garbage 列表中）。

3.4 新版功能.

gc.set_threshold(threshold0[, threshold1[, threshold2]])

设置垃圾回收阈值（收集频率）。 将 threshold0 设为零会禁用回收。

垃圾回收器把所有对象分类为三代，其依据是对象在多少次垃圾回收后幸存。 新建对象会被放在最年轻代（第 0 代）。 如果一个对象在一次垃圾回收后幸存，它会被移入下一个较老代。 由于第 2 代是最老代，这一代的对象在一次垃圾回收后仍会保留原样。 为了确定何时要运行，垃圾回收器会跟踪自上一次回收后对象分配和释放的数量。 当分配数量减去释放数量的结果值大于 threshold0 时，垃圾回收就会开始。 初始时只有第 0 代会被检查。 如果自第 1 代被检查后第 0 代已被检查超过 threshold1 次，则第 1 也会被检查。 对于第三代来说情况还会更复杂，请参阅 Collecting the oldest generation [https://devguide.python.org/garbage_collector/#collecting-the-oldest-generation] 来了解详情。

gc.get_count()

将当前回收计数以形为 (count0, count1, count2) 的元组返回。

gc.get_threshold()

将当前回收阈值以形为 (threshold0, threshold1, threshold2) 的元组返回。

gc.get_referrers(*objs)

返回直接引用任意一个 objs 的对象列表。这个函数只定位支持垃圾回收的容器；引用了其它对象但不支持垃圾回收的扩展类型不会被找到。

需要注意的是，已经解除对 objs 引用的对象，但仍存在于循环引用中未被回收时，仍然会被作为引用者出现在返回的列表当中。若要获取当前正在引用 objs 的对象，需要调用 collect() 然后再调用 get_referrers() 。

警告

在使用 get_referrers() 返回的对象时必须要小心，因为其中一些对象可能仍在构造中因此处于暂时的无效状态。不要把 get_referrers() 用于调试以外的其它目的。

引发一个 审计事件 gc.get_referrers 并附带参数 objs。

gc.get_referents(*objs)

返回被任意一个参数中的对象直接引用的对象的列表。返回的被引用对象是被参数中的对象的C语言级别方法（若存在） tp_traverse 访问到的对象，可能不是所有的实际直接可达对象。只有支持垃圾回收的对象支持 tp_traverse  方法，并且此方法只会在需要访问涉及循环引用的对象时使用。因此，可以有以下例子：一个整数对其中一个参数是直接可达的，这个整数有可能出现或不出现在返回的结果列表当中。

引发一个 审计事件 gc.get_referents 并附带参数 objs。

gc.is_tracked(obj)

当对象正在被垃圾回收器监控时返回 True ，否则返回 False 。一般来说，原子类的实例不会被监控，而非原子类（如容器、用户自定义的对象）会被监控。然而，会有一些特定类型的优化以便减少垃圾回收器在简单实例（如只含有原子性的键和值的字典）上的消耗。

>>> gc.is_tracked(0)
False
>>> gc.is_tracked("a")
False
>>> gc.is_tracked([])
True
>>> gc.is_tracked({})
False
>>> gc.is_tracked({"a": 1})
False
>>> gc.is_tracked({"a": []})
True

3.1 新版功能.

gc.is_finalized(obj)

如果给定对象已被垃圾回收器终结则返回 True，否则返回 False。

>>> 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

3.9 新版功能.

gc.freeze()

冻结 gc 所跟踪的所有对象 —— 将它们移至永久代并忽略所有未来的集合。 这可以在 POSIX fork() 调用之前使用以便令对写入复制保持友好或加速收集。 并且在 POSIX fork() 调用之前的收集也可以释放页面以供未来分配，这也可能导致写入时复制，因此建议在主进程中禁用 gc 并在 fork 之前冻结，而在子进程中启用 gc。

3.7 新版功能.

gc.unfreeze()

解冻永久代中的对象，并将它们放回到年老代中。

3.7 新版功能.

gc.get_freeze_count()

返回永久代中的对象数量。

3.7 新版功能.

提供以下变量仅供只读访问（你可以修改但不应该重绑定它们）：

gc.garbage

一个回收器发现不可达而又无法被释放的对象（不可回收对象）列表。 从 Python 3.4 开始，该列表在大多数时候都应该是空的，除非使用了含有非 NULL tp_del 空位的 C 扩展类型的实例。

如果设置了 DEBUG_SAVEALL ，则所有不可访问对象将被添加至该列表而不会被释放。

在 3.2 版更改: 当 interpreter shutdown 即解释器关闭时，若此列表非空，会产生 ResourceWarning ，即资源警告，在默认情况下此警告不会被提醒。如果设置了 DEBUG_UNCOLLECTABLE ，所有无法被回收的对象会被打印。

在 3.4 版更改: 根据 PEP 442 [https://www.python.org/dev/peps/pep-0442] ，带有 __del__() 方法的对象最终不再会进入 gc.garbage 。

gc.callbacks

在垃圾回收器开始前和完成后会被调用的一系列回调函数。这些回调函数在被调用时使用两个参数： phase 和 info 。

phase 可为以下两值之一：

"start": 垃圾回收即将开始。

"stop": 垃圾回收已结束。

info is a dict providing more information for the callback. The following keys are currently defined:

"generation"（代） ：正在被回收的最久远的一代。

"collected"（已回收的 ）: 当*phase* 为 "stop" 时，被成功回收的对象的数目。

"uncollectable"（不可回收的）: 当 phase 为 "stop" 时，不能被回收并被放入 garbage 的对象的数目。

应用程序可以把他们自己的回调函数加入此列表。主要的使用场景有：

统计垃圾回收的数据，如：不同代的回收频率、回收所花费的时间。

使应用程序可以识别和清理他们自己的在 garbage 中的不可回收类型的对象。

3.3 新版功能.

以下常量被用于 set_debug() ：

gc.DEBUG_STATS

在回收完成后打印统计信息。当回收频率设置较高时，这些信息会比较有用。

gc.DEBUG_COLLECTABLE

当发现可回收对象时打印信息。

gc.DEBUG_UNCOLLECTABLE

打印找到的不可回收对象的信息（指不能被回收器回收的不可达对象）。这些对象会被添加到 garbage 列表中。

在 3.2 版更改: 当 interpreter shutdown 时，即解释器关闭时，若 garbage 列表中存在对象，这些对象也会被打印输出。

gc.DEBUG_SAVEALL

设置后，所有回收器找到的不可达对象会被添加进 garbage 而不是直接被释放。这在调试一个内存泄漏的程序时会很有用。

gc.DEBUG_LEAK

调试内存泄漏的程序时，使回收器打印信息的调试标识位。（等价于 DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL ）。

inspect --- 检查对象

源代码: Lib/inspect.py [https://github.com/python/cpython/tree/3.10/Lib/inspect.py]

inspect 模块提供了一些有用的函数帮助获取对象的信息，例如模块、类、方法、函数、回溯、帧对象以及代码对象。例如它可以帮助你检查类的内容，获取某个方法的源代码，取得并格式化某个函数的参数列表，或者获取你需要显示的回溯的详细信息。

该模块提供了4种主要的功能：类型检查、获取源代码、检查类与函数、检查解释器的调用堆栈。

类型和成员

getmembers() 函数获取对象的成员，例如类或模块。函数名以"is"开始的函数主要作为 getmembers() 的第2个参数使用。它们也可用于判定某对象是否有如下的特殊属性:

类型 | 属性 | 描述
module | __doc__ | 文档字符串
| __file__ | 文件名(内置模块没有文件名)
class | __doc__ | 文档字符串
| __name__ | 类定义时所使用的名称
| __qualname__ | qualified name -- 限定名称
| __module__ | 该类型被定义时所在的模块的名称
method -- 方法 | __doc__ | 文档字符串
| __name__ | 该方法定义时所使用的名称
| __qualname__ | qualified name -- 限定名称
| __func__ | 实现该方法的函数对象
| __self__ | 该方法被绑定的实例，若没有绑定则为 None
| __module__ | 定义此方法的模块的名称
function -- 函数 | __doc__ | 文档字符串
| __name__ | 用于定义此函数的名称
| __qualname__ | qualified name -- 限定名称
| __code__ | 包含已编译函数的代码对象 bytecode
| __defaults__ | 所有位置或关键字参数的默认值的元组
| __kwdefaults__ | 保存仅关键字参数的所有默认值的映射
| __globals__ | 此函数定义所在的全局命名空间
| __builtins__ | builtins 命名空间
| __annotations__ | 参数名称到注解的映射；保留键 "return" 用于返回值注解。
| __module__ | 此函数定义所在的模块名称
回溯 | tb_frame | 此层的帧对象
| tb_lasti | 在字节码中最后尝试的指令的索引
| tb_lineno | 当前行在 Python 源代码中的行号
| tb_next | 下一个内部回溯对象（由本层调用）
frame -- 帧 | f_back | 下一个外部帧对象（此帧的调用者）
| f_builtins | 此帧执行时所在的 builtins 命名空间
| f_code | 在此帧中执行的代码对象
| f_globals | 此帧执行时所在的全局命名空间
| f_lasti | 在字节码中最后尝试的指令的索引
| f_lineno | 当前行在 Python 源代码中的行号
| f_locals | 此帧所看到的局部命名空间
| f_trace | 此帧的追踪函数，或 None
code | co_argcount | 参数数量（不包括仅关键字参数、* 或 ** 参数）
| co_code | 字符串形式的原始字节码
| co_cellvars | 单元变量名称的元组(通过包含作用域引用)
| co_consts | 字节码中使用的常量元组
| co_filename | 创建此代码对象的文件的名称
| co_firstlineno | 第一行在Python源代码中的行号
| co_flags | CO_* 标志的位图，详见 此处
| co_lnotab | 编码的行号到字节码索引的映射
| co_freevars | 自由变量的名字组成的元组（通过函数闭包引用）
| co_posonlyargcount | 仅限位置参数的数量
| co_kwonlyargcount | 仅限关键字参数的数量（不包括 ** 参数）
| co_name | 定义此代码对象的名称
| co_names | 除参数和函数局部变量之外的名称元组
| co_nlocals | 局部变量的数量
| co_stacksize | 需要虚拟机堆栈空间
| co_varnames | 参数名和局部变量的元组
generator -- 生成器 | __name__ | name
| __qualname__ | qualified name -- 限定名称
| gi_frame | frame -- 帧
| gi_running | 生成器在运行吗？
| gi_code | code
| gi_yieldfrom | 通过 yield from``迭代的对象，或``None
coroutine -- 协程 | __name__ | name
| __qualname__ | qualified name -- 限定名称
| cr_await | 正在等待的对象，或 None
| cr_frame | frame -- 帧
| cr_running | 这个协程正在运行吗？
| cr_code | code
| cr_origin | 协程被创建的位置，或 None。参见 sys.set_coroutine_origin_tracking_depth()
builtin | __doc__ | 文档字符串
| __name__ | 此函数或方法的原始名称
| __qualname__ | qualified name -- 限定名称
| __self__ | 方法绑定到的实例，或 None

在 3.5 版更改: 为生成器添加 __qualname__ 和 gi_yieldfrom 属性。

生成器的 __name__ 属性现在由函数名称设置，而不是代码对象名称，并且现在可以被修改。

在 3.7 版更改: 为协程添加 cr_origin 属性。

在 3.10 版更改: 为函数添加 __builtins__ 属性。

inspect.getmembers(object[, predicate])

返回一个对象上的所有成员，组成以 (名称, 值) 对为元素的列表，按名称排序。如果提供了可选的 predicate 参数（会对每个成员的 值 对象进行一次调用），则仅包含该断言为真的成员。

注解

如果要让 getmembers() 返回元类中定义的类属性，那么实参须为一个类且这些属性在元类的自定义方法 __dir__() 中列出。

inspect.getmodulename(path)

返回由文件名 path 表示的模块名字，但不包括外层的包名。文件扩展名会检查是否在 importlib.machinery.all_suffixes() 列出的条目中。如果符合，则文件路径的最后一个组成部分会去掉后缀名后被返回；否则返回 None。

值得注意的是，这个函数 仅 返回可以作为 Python 模块的名字，而有可能指向一个 Python 包的路径仍然会返回 None。

在 3.3 版更改: 该函数直接基于 importlib。

inspect.ismodule(object)

当该对象是一个模块时返回 True。

inspect.isclass(object)

当该对象是一个类时返回 True，无论是内置类或者 Python 代码中定义的类。

inspect.ismethod(object)

当该对象是一个 Python 写成的绑定方法时返回 True。

inspect.isfunction(object)

当该对象是一个 Python 函数时（包括使用 lambda 表达式创造的函数），返回 True。

inspect.isgeneratorfunction(object)

当该对象是一个 Python 生成器函数时返回 True。

在 3.8 版更改: 对于使用 functools.partial() 封装的函数，如果被封装的函数是一个 Python 生成器函数，现在也会返回 True。

inspect.isgenerator(object)

当该对象是一个生成器时返回 True。

inspect.iscoroutinefunction(object)

当该对象是一个 协程函数 （通过 async def 语法定义的函数）时返回``True``。

3.5 新版功能.

在 3.8 版更改: 对于使用 functools.partial() 封装的函数，如果被封装的函数是一个 协程函数 ，现在也会返回 True。

inspect.iscoroutine(object)

当该对象是一个由 async def 函数创建的 协程 时返回 True。

3.5 新版功能.

inspect.isawaitable(object)

如果该对象可以在 await 表达式中使用时返回 True。

也可以用于区分基于生成器的协程和常规的生成器：

def gen():
    yield
@types.coroutine
def gen_coro():
    yield

assert not isawaitable(gen())
assert isawaitable(gen_coro())

3.5 新版功能.

inspect.isasyncgenfunction(object)

如果该对象是一个 异步生成器 函数则返回 True，例如：

>>> async def agen():
...     yield 1
...
>>> inspect.isasyncgenfunction(agen)
True

3.6 新版功能.

在 3.8 版更改: 对于使用 functools.partial() 封装的函数，如果被封装的函数是一个 异步生成器 ，现在也会返回 True。

inspect.isasyncgen(object)

如果该对象是一个由 异步生成器 函数创建的 异步生成器迭代器，则返回 True。

3.6 新版功能.

inspect.istraceback(object)

如果该对象是一个回溯则返回 True。

inspect.isframe(object)

如果该对象是一个帧对象则返回 True。

inspect.iscode(object)

如果该对象是一个代码对象则返回 True。

inspect.isbuiltin(object)

如果该对象是一个内置函数或一个绑定的内置方法，则返回 True。

inspect.isroutine(object)

如果该对象是一个用户定义的或内置的函数或者方法，则返回 True。

inspect.isabstract(object)

如果该对象是一个抽象基类则返回 True。

inspect.ismethoddescriptor(object)

如果该对象是一个方法描述器，但 ismethod() 、 isclass() 、 isfunction() 及 isbuiltin() 均不为真，则返回 True。

例如，该函数对于 int.__add__ 为真。一个通过此测试的对象可以有 __get__() 方法，但不能有 __set__() 方法，除此以外的属性集合是可变的。一个 __name__ 属性通常是合理的，而 __doc__ 属性常常也是。

即使是通过描述器实现的函数，如果通过其他某一个测试，则 ismethoddescriptor() 测试则会返回 False。这单纯是因为其他测试提供了更多保证。比如，当一个对象通过 ismethod() 测试时，你可以使用 __func__ 等属性。

inspect.isdatadescriptor(object)

如果该对象是一个数据描述器则返回 True。

数据描述器拥有 __set__ 或 __delete__ 方法。比如属性（通过 Python 定义）、getset 和成员。后二者是通过 C 定义的，并且也有对应的更具体的测试，并且在不同的 Python 实现中也是健壮的。典型地，数据描述器会拥有 __name__ 和 __doc__ 属性（属性、getset 和成员都包含这两个属性），但这并无保证。

inspect.isgetsetdescriptor(object)

如果该对象是一个 getset 描述器则返回 True。

CPython 实现细节： getset 是在扩展模块中通过 PyGetSetDef 结构体定义的属性。对于不包含这种类型的 Python 实现，这个方法将永远返回 False。

inspect.ismemberdescriptor(object)

如果该对象是一个成员描述器则返回 True。

CPython 实现细节： 成员描述器是在扩展模块中通过 PyMemberDef 结构体定义的属性。对于不包含这种类型的 Python 实现，这个方法将永远返回 False。

获取源代码

inspect.getdoc(object)

获取对象的文档字符串并通过 cleandoc() 进行清理。如果对象本身并未提供文档字符串并且这个对象是一个类、一个方法、一个特性或者一个描述器，将通过继承层次结构获取文档字符串。如果文档字符串无效或缺失，则返回 None。

在 3.5 版更改: 文档字符串没有被重写的话现在会被继承。

inspect.getcomments(object)

任意多行注释作为单一一个字符串返回。对于类、函数和方法，选取紧贴在该对象的源代码之前的注释；对于模块，选取 Python 源文件顶部的注释。如果对象的源代码不可获得，返回 None。这可能是因为对象是 C 语言中或者是在交互式命令行中定义的。

inspect.getfile(object)

返回定义了这个对象的文件名（包括文本文件或二进制文件）。如果该对象是一个内置模块、类或函数则会失败并引发一个 TypeError。

inspect.getmodule(object)

尝试猜测一个对象是在哪个模块中定义的。 如果无法确定模块则返回 None。

inspect.getsourcefile(object)

返回一个对象定义所在 Python 源文件的名称，如果无法获取源文件则返回 None。 如果对象是一个内置模块、类或函数则将失败并引发 TypeError。

inspect.getsourcelines(object)

返回一个源代码行的列表和对象的起始行号。 参数可以是一个模块、类、方法、函数、回溯或者代码对象。 源代码将以与该对象所对应的行的列表的形式返回并且行号指明其中第一行代码出现在初始源文件的那个位置。 如果源代码无法被获取则会引发 OSError。 如果对象是一个内置模块、类或函数则会引发 TypeError。

在 3.3 版更改: 现在会引发 OSError 而不是 IOError，后者现在是前者的一个别名。

inspect.getsource(object)

返回对象的源代码文本。 参数可以是一个模块、类、方法、函数、回溯帧或代码对象。 源代码将以单个字符串的形式被返回。 如果源代码无法被获取则会引发 OSError。 如果对象是一个内置模块、类或函数则会引发 TypeError。

在 3.3 版更改: 现在会引发 OSError 而不是 IOError，后者现在是前者的一个别名。

inspect.cleandoc(doc)

清理文档字符串中为对齐当前代码块进行的缩进

第一行的所有前缀空白符会被移除。从第二行开始所有可以被统一去除的空白符也会被去除。之后，首尾的空白行也会被移除。同时，所有制表符会被展开到空格。

使用 Signature 对象对可调用对象进行内省

3.3 新版功能.

Signature 对象代表了一个可调用对象的调用签名和返回值标注。要获取一个 Signature 对象，使用 signature() 函数。

inspect.signature(callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)

返回给定的 callable 的一个 Signature 对象：

>>> 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'>

接受各类的 Python 可调用对象，包括单纯的函数、类，到 functools.partial() 对象。

对于在字符串化标注模块（from __future__ import annotations）中定义的对象， signature() 会尝试使用 inspect.get_annotations() 自动地反字符串化这些标注。参数 global locals 和 eval_str 会在分析标注时被传入 inspect.get_annotations() 。如何运用这些参数请参见 inspect.get_annotations() 的文档。

如果没有签名可以提供，则引发 ValueError；如果不支持该对象类型，则引发 TypeError。同时，如果标注被反字符串化，并且 eval_str 不是假值，则 eval() 会被调用以反字符串化，此时有可能引发任何种类的异常。

函数签名中的斜杠（/）表示在它之前的参数是仅限位置的。详见 编程常见问题中关于仅限位置参数的条目

3.5 新版功能: follow_wrapped 形参。传递 False 来获得特定关于 callable 的签名（callable.__wrapped__ 将不会用来解包被修饰的可调用对象）。

3.10 新版功能: 添加参数 globals 、 locals 和 eval_str。

注解

一些可调用对象可能在特定 Python 实现中无法被内省。例如，在 CPython 中，部分通过 C 语言定义的内置函数不提供关于其参数的元数据。

class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)

一个 Signature 对象代表了一个函数的调用签名和返回值标注。对于函数接受的每个参数，它对应地在自身的 parameters 容器中存储一个 Parameter 对象。

可选参数 parameters 是一个 Parameter 对象组成的序列，它会在之后被验证不存在名字重复的参数，并且参数处于正确的顺序，即仅限位置参数最前，之后紧接着可位置可关键字参数，并且有默认值参数在无默认值参数之前。

可选参数 return_annotation 可以是任意 Python 对象，是该可调用对象中“返回值”的标注。

 Signature 对象是 不可变 的。使用 Signature.replace() 来构造一个修改后的副本。

在 3.5 版更改: Signature 对象是可封存的并且是 hashable。

empty

该类的一个特殊标记来明确指出返回值标注缺失。

parameters

一个参数名字到对应 Parameter 对象的有序映射。参数以严格的定义顺序出现，包括仅关键字参数。

在 3.7 版更改: Python 从 3.7 版起才显式地保证了它保持仅关键字参数的定义顺序，尽管实践上在 Python 3 中一直保持了这个顺序。

return_annotation

可调用对象的“返回值”标注。如果可调用对象没有“返回值”标注，这个属性会被设置为 Signature.empty。

bind(*args, **kwargs)

构造一个位置和关键字实参到形参的映射。如果 *args 和 **kwargs 符合签名，则返回一个 BoundArguments；否则引发一个 TypeError 。

bind_partial(*args, **kwargs)

与 Signature.bind() 作用方式相同，但允许省略部分必要的参数（模仿 functools.partial() 的行为）。返回 BoundArguments，或者在传入参数不符合签名的情况下，引发一个 TypeError。

replace(*[, parameters][, return_annotation])

基于 replace 函数被调用的目标，创建一个新的 Signature 实例。可以传递不同的 parameters 和/或 return_annotation 来覆盖原本签名的对应的属性。要从复制的 Signature 中移除 return_annotation，可以传入 Signature.empty 。

>>> 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'"

classmethod from_callable(obj, *, follow_wrapped=True, globalns=None, localns=None)

返回给定可调用对象 obj 的 Signature 对象（或其子类）。传入 follow_wrapped=False 来直接得到 obj 的签名，而不通过 __wrapped__ 链来解析包装。在解析标注时会将 globalns 和 localns 用作命名空间。

该函数简化了创建 Signature 的子类的过程：

class MySignature(Signature):
    pass
sig = MySignature.from_callable(min)
assert isinstance(sig, MySignature)

3.5 新版功能.

3.10 新版功能: 添加了参数 globalns 和 localns。

class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)

 Parameter 对象是 不可变 的。不要直接修改 Parameter 对象，而是通过 Parameter.replace() 来创建一个修改后的副本。

在 3.5 版更改: Parameter 对象是可封存的并且是 hashable。

empty

该类的一个特殊标记来明确指出默认值和标注的缺失。

name

参数的名字字符串。这个名字必须是一个合法的 Python 标识符。

CPython 实现细节： CPython 会为用于实现推导式和生成器表达式的代码对象构造形如 .0 的隐式形参名。

在 3.6 版更改: 这些形参名会被此模块暴露为形如 implicit0 一样的名字。

default

该参数的默认值。如果该参数没有默认值，这个属性会被设置为 Parameter.empty 。

annotation

该参数的标注。如果该参数没有标注，这个属性会被设置为 Parameter.empty 。

kind

描述参数值要如何绑定到形参。 可能的取值可通过 Parameter 获得 (如 Parameter.KEYWORD_ONLY)，并支持比较与排序，基于以下顺序:

名称 | 含意
POSITIONAL_ONLY | 值必须以位置参数的方式提供。仅限位置参数是在函数定义中出现在 / 之前（如果有）的条目。
POSITIONAL_OR_KEYWORD | 值既可以以关键字参数的形式提供，也可以以位置参数的形式提供（这是 Python 写成的函数的标准绑定行为的）。
VAR_POSITIONAL | 没有绑定到其他形参的位置实参组成的元组。这对应于 Python 函数定义中的 *args 形参。
KEYWORD_ONLY | 值必须以关键字参数的形式提供。仅限关键字形参是在 Python 函数定义中出现在 * 或 *args 之后的条目。
VAR_KEYWORD | 一个未绑定到其他形参的关键字参数的字典。这对应于 Python 函数定义中的 **kwargs 形参。

例如，打印所有没有默认值的仅关键字参数：

>>> 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

kind.description

描述 Parameter.kind 的枚举值。

3.8 新版功能.

例子：打印所有参数的描述：

>>> 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

replace(*[, name][, kind][, default][, annotation])

基于 replace 函数被调用的目标，创建一个新的 Parameter 实例。要覆写 Parameter 的属性，传递对应的参数。要移除 Parameter 的默认值和/或标注，传递 Parameter.empty。

>>> from inspect import Parameter
>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)
>>> str(param)
'foo=42'

>>> str(param.replace()) # Will create a shallow copy of 'param'
'foo=42'

>>> str(param.replace(default=Parameter.empty, annotation='spam'))
"foo:'spam'"

在 3.4 版更改: 在 Python 3.3 中， Parameter 对象当 kind 为 POSITIONAL_ONLY 时允许 name 被设置为 None。这现在已不再被允许。

class inspect.BoundArguments

调用 Signature.bind() 或 Signature.bind_partial() 的结果。容纳实参到函数的形参的映射。

arguments

一个形参名到实参值的可变映射。仅包含显式绑定的参数。对 arguments 的修改会反映到 args 和 kwargs 上。

应当在任何参数处理目的中与 Signature.parameters 结合使用。

注解

 Signature.bind() 和 Signature.bind_partial() 中采用默认值的参数被跳过。然而，如果有需要的话，可以使用 BoundArguments.apply_defaults() 来添加它们。

在 3.9 版更改:  arguments 现在的类型是 dict。之前，它的类型是 collections.OrderedDict。

args

位置参数的值的元组。由 arguments 属性动态计算。

kwargs

关键字参数值的字典。由 arguments 属性动态计算。

signature

向所属 Signature 对象的一个引用。

apply_defaults()

设置缺失的参数的默认值。

对于变长位置参数（*args），默认值是一个空元组。

对于变长关键字参数（**kwargs）默认值是一个空字典。

>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
{'a': 'spam', 'b': 'ham', 'args': ()}

3.5 新版功能.

 args 和 kwargs 属性可以被用于调用函数：

def test(a, *, b):
    ...

sig = signature(test)
ba = sig.bind(10, b=20)
test(*ba.args, **ba.kwargs)

参见

PEP 362 [https://www.python.org/dev/peps/pep-0362] - 函数签名对象。

包含具体的规范，实现细节和样例。

类与函数

inspect.getclasstree(classes, unique=False)

将给定的类的列表组织成嵌套列表的层级结构。每当一个内层列表出现时，它包含的类均派生自紧接着该列表之前的条目的类。每个条目均是一个二元组，包含一个类和它的基类组成的元组。如果 unique 参数为真值，则给定列表中的每个类将恰有一个对应条目。否则，运用了多重继承的类和它们的后代将出现多次。

inspect.getargspec(func)

获取一个 Python 函数的形参的名字和默认值。将返回一个 具名元组 ArgSpec(args, varargs, keywords, defaults)。 args 是一个形参名字的列表。 varargs 和 keywords 是 * 和 ** 形参的名字或 None。 defaults 是一个默认参数值的元组或没有默认值时取 None。如果该元组有 n 个元素，则它们对应 args 中的最后 n 个元素。

3.0 版后已移除: 通常可以替换为使用更新后的 API getfullargspec()，后者还能正确处理函数标注和仅限关键字形参。

又或者，使用 signature() 和 Signature 对象，这提供一个更加结构化的处理可调用对象的内省 API。

inspect.getfullargspec(func)

获取一个 Python 函数的形参的名字和默认值。将返回一个 具名元组：

FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)

args 是一个位置参数的名字的列表。 varargs 是 * 形参的名字或 None 表示不接受任意长位置参数时。 varkw 是 ** 参数的名字，或 None 表示不接受任意关键字参数。 defaults 是一个包含了默认参数值的 n 元组分别对应最后 n 个位置参数，或 None 则表示没有默认值。 kwonlyargs 是一个仅关键词参数列表，保持定义时的顺序。 kwonlydefaults 是一个字典映射自 kwonlyargs 中包含的形参名。 annotations 是一个字典，包含形参值到标注的映射。其中包含一个特殊的键 "return" 代表函数返回值的标注（如果有的话）。

注意： signature() 和 Signature 对象 提供可调用对象内省更推荐的 API，并且支持扩展模块 API 中可能出现的额外的行为（比如仅限位置参数）。该函数被保留的主要原因是保持兼容 Python 2 的 inspect 模块 API。

在 3.4 版更改: 该函数现在基于 signature() 但仍然忽略 __wrapped__ 属性，并且在签名中包含绑定方法中的第一个绑定参数。

在 3.6 版更改: 该方法在 Python 3.5 中曾因 signature() 被文档归为弃用。但该决定已被推翻以恢复一个明确受支持的标准接口，以便运用一份源码通用 Python 2/3 间遗留的 getargspec() API 的迁移。

在 3.7 版更改: Python 从 3.7 版起才显式地保证了它保持仅关键字参数的定义顺序，尽管实践上在 Python 3 中一直保持了这个顺序。

inspect.getargvalues(frame)

获取传入特定的帧的实参的信息。将返回一个 具名元组 ArgInfo(args, varargs, keywords, locals)。 args 是一个参数名字的列表。 varargs 和 keyword 是 * 和 ** 参数的名字或 None。 locals 是给定的帧的局部环境字典。

注解

该函数因疏忽在 Python 3.5 中被错误地标记为弃用。

inspect.formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])

将 getfullargspec() 的返回值格式化为美观的参数规格。

最初的七个参数是 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations) 。

其他6个参数分别是会被调用以转化参数名、* 参数名、** 参数名、默认值、返回标注和独立标注为字符串的函数。

例如:

>>> from inspect import formatargspec, getfullargspec
>>> def f(a: int, b: float):
...     pass
...
>>> formatargspec(*getfullargspec(f))
'(a: int, b: float)'

3.5 版后已移除: 使用 signature() 和 Signature 对象，它为可调用对象提供一个更好的内省 API。

inspect.formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])

将 getargvalues() 返回的四个值格式化为美观的参数规格。 format* 的参数是对应的可选格式化函数以转化名字和值为字符串。

注解

该函数因疏忽在 Python 3.5 中被错误地标记为弃用。

inspect.getmro(cls)

返回由类 cls 的全部基类按方法解析顺序组成的元组，包括 cls 本身。所有类不会在此元组中出现多于一次。注意方法解析顺序取决于 cls 的类型。除非使用一个非常奇怪的用户定义元类型，否则 cls 会是元组的第一个元素。

inspect.getcallargs(func, /, *args, **kwds)

仿照调用方式绑定 args 和 kwds 到 Python 函数或方法 func 参数名。对于绑定方法，也绑定第一个参数（通常命名为 self）到关联的实例。返回一个字典，映射自参数名（包括可能存在的 * 和 ** 参数）到他们对应于 args 和 kwds 中的值。假使 func 被错误地调用，即是说 func(*args, **kwds) 会因函数签名不一致引发一个异常，那么也会引发一个相同种类的异常，并附上相同或类似的消息。例如：

>>> 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'

3.2 新版功能.

3.5 版后已移除: 改使用 Signature.bind() 和 Signature.bind_partial()。

inspect.getclosurevars(func)

获取自 Python 函数或方法 func 引用的外部名字到它们的值的映射。返回一个 具名元组 ClosureVars(nonlocals, globals, builtins, unbound)。 nonlocals 映射引用的名字到词法闭包变量，globals 映射到函数的模块级全局， builtins 映射到函数体内可见的内置变量。 unbound 是在函数中引用但不能解析到给定的模块全局和内置变量的名字的集合。

如果 func 不是 Python 函数或方法，将引发 TypeError。

3.3 新版功能.

inspect.unwrap(func, *, stop=None)

获取 func 所包装的对象。它追踪 __wrapped__ 属性链并返回最后一个对象。

stop 是一个可选的回调，接受包装链的一个对象作为唯一参数，以允许通过让回调返回真值使解包装更早中止。如果回调不曾返回一个真值，将如常返回链中的最后一个对象。例如， signature() 使用该参数来在遇到具有 __signature__ 参数的对象时停止解包装。

如果遇到循环，则引发 ValueError。

3.4 新版功能.

inspect.get_annotations(obj, *, globals=None, locals=None, eval_str=False)

计算一个对象的标注字典。

 obj 可以是一个可调用对象、类或模块。传入其他类型的对象将引发 TypeError。

返回一个字典。 get_annotations() 每次调用均返回一个新的字典；对同一个对象调用两次将获得两个不同但相等的字典。

该函数帮助你处理若干细节：

如果 eval_str 为真， str 类型的值将会通过 eval() 来反字符串化。这被设计用于字符串化标注（from __future__ import annotations）。

如果 obj 不包含一个标注字典，返回一个空字典。（函数和方法永远包含一个标注字典；类、模块和其他类型的可调用对象则可能没有。）

对于类，忽略继承而来的标注。如果一个类不包含自己的标注字典，返回一个空字典。

因安全原因，所有对于对象成员和字典值的访问将通过 getattr() 和 dict.get() 完成。

请确保始终、始终、始终返回一个新创建的字典。

eval_str 控制 str 类型的值是否应该替换为对其调用 eval() 的结果：

如果 eval_str 为真， eval() 会被调用于 str 类型。（注意 get_annotations 并不捕获异常；如果 eval() 返回一个错误，它会将栈展开跳过 get_annotations 调用。）

如果 eval_str 为假（默认值）， str 类型的值将不会被改变。

globals 和 locals 会被直接传入函数 eval()，详见 eval() 的文档。如果 globals 或者 locals 是 None，则改函数视 type(obj) 而定，可能将相应的值替换为一个上下文有关的默认值。

如果 obj 是一个模块， globals 默认为 obj.__dict__。

如果 obj 是一个类， globals 默认值为 sys.modules[obj.__module__].__dict__ 并且 locals 默认值为 obj 的类命名空间。

如果 obj 是一个可调用对象， globals 默认为 obj.__globals__，而如果 obj 是一个包装过的函数，则它会先被解包装。

调用 get_annotations 是获取任何对象的标注字典的最佳实践。关于标注的最佳实践的更多信息，参见 注解最佳实践。

3.10 新版功能.

解释器栈

当下列函数返回“帧记录”时，每个记录是一个 具名元组 FrameInfo(frame, filename, lineno, function, code_context, index)。该元组包含帧对象、文件名、当前行的行号、函数名、来源于源代码的若干行上下文组成的列表和当前行在该列表中的索引。

在 3.5 版更改: 不再返回一个元组而是返回一个具名元组。

注解

保留帧对象的引用（可见于这些函数返回的帧记录的第一个元素）会导致你的程序产生循环引用。每当一个循环引用被创建，所有可从产生循环的对象访问的对象的生命周期将会被大幅度延长，即便 Python 的可选的循环检测器被启用。如果这类循环必须被创建，确保它们会被显式地打破以避免对象销毁被延迟从而导致占用内存增加。

尽管循环检测器能够处理这种情况，这些帧（包括其局部变量）的销毁可以通过在 finally 子句中移除循环来产生确定的行为。对于循环检测器在编译 Python 时被禁用或者使用 gc.disable() 时，这样处理更加尤为重要。比如：

def handle_stackframe_without_leak():
    frame = inspect.currentframe()
    try:
        # do something with the frame
    finally:
        del frame

如果你希望保持帧更长的时间（比如在之后打印回溯），你也可以通过 frame.clear() 方法打破循环引用。

大部分这些函数支持的可选的 context 参数指定返回时包含的上下文的行数，以当前行为中心。

inspect.getframeinfo(frame, context=1)

获取一个帧或者一个回溯对象的信息。返回一个 具名元组 Traceback(filename, lineno, function, code_context, index)。

inspect.getouterframes(frame, context=1)

获取某帧及其所有外部帧的帧记录的列表。这些帧表示了导致 frame 被创建的一系列调用。返回的列表中的第一个记录代表了 frame 本身；最后一个记录代表了 frame 的栈上的最外层的调用。

在 3.5 版更改: 返回一个 具名元组 FrameInfo(frame, filename, lineno, function, code_context, index) 的列表。

inspect.getinnerframes(traceback, context=1)

获取一个回溯所在的帧和它所有的内部的帧的列表。这些帧代表了作为 frame 的后续的帧。第一条记录代表了 traceback 本身；最后一条记录代表了引发异常的位置。

在 3.5 版更改: 返回一个 具名元组 FrameInfo(frame, filename, lineno, function, code_context, index) 的列表。

inspect.currentframe()

返回调用者的栈帧对应的帧对象。

CPython 实现细节： 该函数依赖于 Python 解释器对于栈帧的支持，这并非在 Python 的所有实现中被保证。该函数在不支持Python 栈帧的实现中运行会返回 None。

inspect.stack(context=1)

返回调用者的栈的帧记录列表。返回的列表中的第一个记录代表调用者，最后一个记录代表了栈上最外层的调用。

在 3.5 版更改: 返回一个 具名元组 FrameInfo(frame, filename, lineno, function, code_context, index) 的列表。

inspect.trace(context=1)

返回介于当前帧和引发了当前正在处理的异常的帧之间的所有帧记录的列表。列表中的第一条记录代表调用者；最后一条记录代表了引发异常的地方。

在 3.5 版更改: 返回一个 具名元组 FrameInfo(frame, filename, lineno, function, code_context, index) 的列表。

静态地获取属性

 getattr() 和 hasattr() 都可能会在获取或者判断属性是否存在时触发代码执行。描述符，就和特性一样，会被调用， __getattr__() 和 __getattribute__() 可能会被调用。

对于你想要静态地内省的情况，比如文档工具，这会显得不方便。 getattr_static() 拥有与 getattr() 相同的签名，但避免了获取属性时执行代码。

inspect.getattr_static(obj, attr, default=None)

获取属性而不触发描述器协议的动态查找能力 __getattr__() 或 __getattribute__()。

注意：该函数可能无法获取 getattr 能获取的全部的属性（比如动态地创建的属性），并且可能发现一些 getattr 无法找到的属性（比如描述器会引发 AttributeError）。它也能够返回描述器对象本身而非实例成员。

如果实例的 __dict__ 被其他成员遮盖（比如一个特性）则该函数无法找到实例成员。

3.2 新版功能.

 getattr_static() 不解析描述器。比如槽描述器或 C 语言中实现的 getset 描述器。该描述器对象会被直接返回，而不处理底层属性。

你可以用类似下方的代码的方法处理此事。注意，对于任意 getset 描述符，使用这段代码仍可能触发代码执行。

# example code for resolving the builtin descriptor types
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:
        # descriptors can raise AttributeError to
        # indicate there is no underlying value
        # in which case the descriptor itself will
        # have to do
        pass

生成器和协程的当前状态

当实现协程调度器或其他更高级的生成器用途时，判断一个生成器是正在执行、等待启动或继续或执行，又或者已经被终止是非常有用的。 getgeneratorstate() 允许方便地判断一个生成器的当前状态。

inspect.getgeneratorstate(generator)

获取生成器迭代器的当前状态。

可能的状态是：

GEN_CREATED：等待开始执行。

GEN_RUNNING：正在被解释器执行。

GEN_SUSPENDED：当前挂起于一个 yield 表达式。

GEN_CLOSED：执行已经完成。

3.2 新版功能.

inspect.getcoroutinestate(coroutine)

获取协程对象的当前状态。该函数设计为用于使用 async def 函数创建的协程函数，但也能接受任何包括 cr_running 和 cr_frame 的类似协程的对象。

可能的状态是：

CORO_CREATED：等待开始执行。

CORO_RUNNING：当前正在被解释器执行。

CORO_SUSPENDED：当前挂起于一个 await 表达式。

CORO_CLOSED：执行已经完成。

3.5 新版功能.

生成器当前的内部状态也可以被查询。这通常在测试目的中最为有用，来保证内部状态如预期一样被更新：

inspect.getgeneratorlocals(generator)

获取 generator 里的实时局部变量到当前值的映射。返回一个由名字映射到值的字典。这与在生成器的主体内调用 locals() 是等效的，并且相同的警告也适用。

如果 generator 是一个没有关联帧的 生成器，则返回一个空字典。如果 generator 不是一个 Python 生成器对象，则引发 TypeError。

CPython 实现细节： 该函数依赖于生成器为内省暴露一个 Python 栈帧，这并非在 Python 的所有实现中被保证。在这种情况下，该函数将永远返回一个空字典。

3.3 新版功能.

inspect.getcoroutinelocals(coroutine)

该函数可类比于 getgeneratorlocals()，只是作用于由 async def 函数创建的协程。

3.5 新版功能.

代码对象位标志

Python 代码对象有一个 co_flags 属性，它是下列标志的位图。

inspect.CO_OPTIMIZED

代码对象已经经过优化，会采用快速局部变量。

inspect.CO_NEWLOCALS

如果被置位，当代码对象被执行时会创建一个新的字典作为帧的 f_locals。

inspect.CO_VARARGS

代码对象拥有一个变长位置形参（类似 *args）。

inspect.CO_VARKEYWORDS

代码对象拥有一个可变关键字形参 (类似 **kwrags)。

inspect.CO_NESTED

该标志当代码对象是一个嵌套函数时被置位。

inspect.CO_GENERATOR

当代码对象是一个生成器函数，即调用时会返回一个生成器对象，则该标志被置位。

inspect.CO_NOFREE

当没有自由或单元变量时，标志被置位。

inspect.CO_COROUTINE

当代码对象是一个协程函数时被置位。当代码对象被执行时它返回一个协程。详见 PEP 492 [https://www.python.org/dev/peps/pep-0492]。

3.5 新版功能.

inspect.CO_ITERABLE_COROUTINE

该标志被用于将生成器转变为基于生成器的协程。包含此标志的生成器对象可以被用于 await 表达式，并可以 yield from 协程对象。详见 PEP 492 [https://www.python.org/dev/peps/pep-0492]。

3.5 新版功能.

inspect.CO_ASYNC_GENERATOR

当代码对象是一个异步生成器函数时该标志被置位。当代码对象被运行时它将返回一个异步生成器对象。详见 PEP 525 [https://www.python.org/dev/peps/pep-0525]。

3.6 新版功能.

注解

这些标志特指于 CPython，并且在其他 Python 实现中可能从未被定义。更进一步地说，这些标志是一种实现细节，并且可能在将来的 Python 发行中被移除或弃用。推荐使用 inspect 模块的公共 API 来进行任何内省需求。

命令行界面

inspect 模块也提供一个从命令行使用基本的内省能力。

默认地，命令行接受一个模块的名字并打印模块的源代码。也可通过后缀一个冒号和目标对象的限定名称来打印一个类或者一个函数。

--details

打印特定对象的信息而非源码。

site —— 指定域的配置钩子

源代码: Lib/site.py [https://github.com/python/cpython/tree/3.10/Lib/site.py]

这个模块将在初始化时被自动导入。 此自动导入可以通过使用解释器的 -S 选项来屏蔽。

导入此模块将会附加域特定的路径到模块搜索路径并且添加一些内建对象，除非使用了 -S 选项。 那样的话，模块可以被安全地导入，而不会对模块搜索路径和内建对象有自动的修改或添加。要明确地触发通常域特定的添加，调用函数 site.main()。

在 3.3 版更改: 在之前即便使用了 -S，导入此模块仍然会触发路径操纵。

它会从头部和尾部构建至多四个目录作为起点。 对于头部，它会使用 sys.prefix 和 sys.exec_prefix；空的头部会被跳过。 对于尾部，它会使用空字符串然后是 lib/site-packages (在 Windows 上) 或 lib/pythonX.Y/site-packages (在 Unix 和 macOS 上)。 对于每个不同的头-尾组合，它会查看其是否指向现有的目录，如果是的话，则将其添加到 sys.path 并且检查新添加目录中的配置文件。

在 3.5 版更改: 对 "site-python" 目录的支持已被移除。

如果名为 "pyvenv.cfg" 的文件存在于 sys.executable 之上的一个目录中，则 sys.prefix 和 sys.exec_prefix 将被设置为该目录，并且还会检查 site-packages （ sys.base_prefix 和 sys.base_exec_prefix 始终是 Python 安装的 "真实" 前缀）。 如果 "pyvenv.cfg" （引导程序配置文件）包含设置为非 "true"（不区分大小写）的 "include-system-site-packages" 键，则不会在系统级前缀中搜索 site-packages；反之则会。

一个路径配置文件是具有 name.pth 命名格式的文件，并且存在上面提到的四个目录之一中；它的内容是要添加到 sys.path 中的额外项目（每行一个）。不存在的项目不会添加到 sys.path，并且不会检查项目指向的是目录还是文件。项目不会被添加到 sys.path 超过一次。空行和由 # 起始的行会被跳过。以 import 开始的行（跟着空格或 TAB）会被执行。

注解

每次启动 Python，在 .pth 文件中的可执行行都将会被运行，而不管特定的模块实际上是否需要被使用。 因此，其影响应降至最低。可执行行的主要预期目的是使相关模块可导入（加载第三方导入钩子，调整 PATH 等）。如果它发生了，任何其他的初始化都应当在模块实际导入之前完成。将代码块限制为一行是一种有意采取的措施，不鼓励在此处放置更复杂的内容。

例如，假设 sys.prefix 和 sys.exec_prefix 已经被设置为 /usr/local。 Python X.Y 的库之后被安装为 /usr/local/lib/pythonX.Y。假设有一个拥有三个孙目录 foo, bar 和 spam 的子目录 /usr/local/lib/pythonX.Y/site-packages，并且有两个路径配置文件 foo.pth 和 bar.pth。假定 foo.pth 内容如下:

# foo package configuration

foo
bar
bletch

并且 bar.pth 包含:

# bar package configuration

bar

则下面特定版目录将以如下顺序被添加到 sys.path。

/usr/local/lib/pythonX.Y/site-packages/bar
/usr/local/lib/pythonX.Y/site-packages/foo

请注意 bletch 已被省略因为它并不存在；bar 目前在 foo 目录之前因为 bar.pth 按字母顺序排在 foo.pth 之前；而 spam 已被省略因为它在两个路径配置文件中都未被提及。

在这些路径操作之后，会尝试导入一个名为 sitecustomize 的模块，它可以执行任意站点专属的定制。 它通常是由系统管理员在 site-packages 目录下创建的。 如此此导入失败并引发 ImportError 或其子类异常，并且异常的 name 属性等于 'sitecustomize'，则它会被静默地忽略。 如果 Python 是在没有可用输出流的情况下启动的，例如在 Windows 上使用 pythonw.exe (它默认被用于启动 start IDLE)，则来自 sitecustomize 的输出尝试会被忽略。 任何其他异常都会导致静默且可能令人迷惑不解的进程失败。

在此之后，会尝试导入一个名为 usercustomize 的模块，它可以执行任意用户专属的定制，如果 ENABLE_USER_SITE 为真值的话。 这个文件应该在用户的 site-packages 目录中创建（见下文），该目录是 sys.path 的组成部分，除非被 -s 所禁用。 如果此导入失败并引发 ImportError 或者其子类异常，并且异常的 name 属性等于 'usercustomize'，它会被静默地忽略。

请注意对于某些非 Unix 系统来说，sys.prefix 和 sys.exec_prefix 均为空值，并且路径操作会被跳过；但是仍然会尝试导入 sitecustomize 和 usercustomize。

Readline 配置

在支持 readline 的系统上，这个模块也将导入并配置 rlcompleter 模块，如果 Python 是以 交互模式 启动并且不带 -S 选项的话。 默认的行为是启用 tab 键补全并使用 ~/.python_history 作为历史存档文件。 要禁用它，请删除（或重载）你的 sitecustomize 或 usercustomize 模块或 PYTHONSTARTUP 文件中的 sys.__interactivehook__ 属性。

在 3.4 版更改: rlcompleter 和 history 会被自动激活。

模块内容

site.PREFIXES

site-packages 目录的前缀列表。

site.ENABLE_USER_SITE

显示用户 site-packages 目录状态的旗标。 True 意味着它被启用并被添加到 sys.path。 False 意味着它按照用户请求被禁用 (通过 -s 或 PYTHONNOUSERSITE)。 None 意味着它因安全理由（user 或 group id 和 effective id 之间不匹配）或是被管理员所禁用。

site.USER_SITE

正在运行的 Python 的用户级 site-packages 的路径。 它可以为 None，如果 getusersitepackages() 尚未被调用的话。 默认值在 UNIX 和非框架 macOS 编译版上为 ~/.local/lib/pythonX.Y/site-packages，在 macOS 框架编译版上为 ~/Library/Python/X.Y/lib/python/site-packages，而在 Windows 上则为 %APPDATA%\Python\PythonXY\site-packages。 此目录属于站点目录，这意味着其中的 .pth 文件将会被处理。

site.USER_BASE

用户级 site-packages 的基准目录的路径。 它可以为 None，如果 getuserbase() 尚未被调用的话。 默认值在 UNIX 和 macOS 非框架编译版上为 ~/.local，在 macOS 框架编译版上为 ~/Library/Python/X.Y，而在 Windows 上则为 %APPDATA%\Python。 这个值会被 Distutils 用来计算脚本、数据文件和 Python 模块等的安装目录。 对于 用户安装规范。 另请参阅 PYTHONUSERBASE。

site.main()

将所有的标准站点专属目录添加到模块搜索路径。 这个函数会在导入此模块时被自动调用，除非 Python 解释器启动时附带了 -S 旗标。

在 3.3 版更改: 这个函数使用无条件调用。

site.addsitedir(sitedir, known_paths=None)

将一个目录添加到 sys.path 并处理其 .pth 文件。 通常被用于 sitecustomize 或 usercustomize (见下文)。

site.getsitepackages()

返回包含所有全局 site-packages 目录的列表。

3.2 新版功能.

site.getuserbase()

返回用户基准目录的路径 USER_BASE。 如果它尚未被初始化，则此函数还将参照 PYTHONUSERBASE 来设置它。

3.2 新版功能.

site.getusersitepackages()

返回用户专属 site-packages 目录的路径 USER_SITE。 如果它尚未被初始化，则此函数还将参照 USER_BASE 来设置它。 要确定用户专属 site-packages 是否已被添加到 sys.path 则应当使用 ENABLE_USER_SITE。

3.2 新版功能.

命令行界面

site 模块还提供了一个从命令行获取用户目录的方式:

$ python3 -m site --user-site
/home/user/.local/lib/python3.3/site-packages

如果它被不带参数地调用，它将在标准输出打印 sys.path 的内容，再打印 USER_BASE 的值以及该目录是否存在，然后打印 USER_SITE 的相应信息，最后打印 ENABLE_USER_SITE 的值。

--user-base

输出用户基本的路径。

--user-site

输出用户site-packages目录的路径。

如果同时给出了两个选项，则将打印用户基准目录和用户站点信息（总是按此顺序），并以 os.pathsep 分隔。

如果给出了其中一个选项，脚本将退出并返回以下值中的一个：如果用户级 site-packages 目录被启用则为 0，如果它被用户禁用则为 1，如果它因安全理由或被管理员禁用则为 2，如果发生错误则为大于 2 的值。

参见

PEP 370 [https://www.python.org/dev/peps/pep-0370] -- 分用户的 site-packages 目录

自定义 Python 解释器

本章中描述的模块允许编写类似于 Python 的交互式解释器的接口。 如果你想要一个支持附加某些特殊功能到 Python 语言的 Python 解释器，你应当看一下 code 模块。 (codeop 模块是低层级的，用于支持编译可能不完整的 Python 代码块。

本章描述的完整模块列表如下：

code --- 解释器基类

交互解释器对象

交互式控制台对象

codeop --- 编译Python代码

code --- 解释器基类

源代码： Lib/code.py [https://github.com/python/cpython/tree/3.10/Lib/code.py]

code 模块提供了在 Python 中实现 read-eval-print 循环的功能。它包含两个类和一些快捷功能，可用于构建提供交互式解释器的应用程序。

class code.InteractiveInterpreter(locals=None)

这个类处理解析器和解释器状态（用户命名空间的）；它不处理缓冲器、终端提示区或着输入文件名（文件名总是显示地传递）。可选的 locals 参数指定一个字典，字典里面包含将在此类执行的代码；它默认创建新的字典，其键 '__name__' 设置为 '__console__' ，键 '__doc__' 设置为 None 。

class code.InteractiveConsole(locals=None, filename='<console>')

尽可能模拟交互式 Python 解释器的行为。此类建立在 InteractiveInterpreter 的基础上，使用熟悉的 sys.ps1 和 sys.ps2 作为输入提示符，并有输入缓冲。

code.interact(banner=None, readfunc=None, local=None, exitmsg=None)

运行一个 read-eval-print 循环的便捷函数。这会创建一个新的 InteractiveConsole 实例。如果提供了 readfunc ，会设置为 InteractiveConsole.raw_input() 方法。如果提供了 local ，则将其传递给 InteractiveConsole 的构造函数，以用作解释器循环的默认命名空间。然后，如果提供了 banner 和 exitmsg ，实例的 interact() 方法会以此为标题和退出消息。控制台对象在使用后将被丢弃。

在 3.6 版更改: 加入 exitmsg 参数。

code.compile_command(source, filename='<input>', symbol='single')

这个函数主要用来模拟 Python 解释器的主循环（即 read-eval-print 循环）。难点的部分是当用户输入不完整命令时，判断能否通过之后的输入来完成（要么成为完整的命令，要么语法错误）。该函数 几乎 和实际的解释器主循环的判断是相同的。

source 是源字符串；filename 是可选的用作读取源的文件名，默认为 '<input>'；symbol 是可选的语法开启符号，应为 'single' (默认), 'eval' 或 'exec'。

如果命令完整且有效则返回一个代码对象 (等价于 compile(source, filename, symbol))；如果命令不完整则返回 None；如果命令完整但包含语法错误则会引发 SyntaxError 或 OverflowError 而如果命令包含无效字面值则将引发 ValueError。

交互解释器对象

InteractiveInterpreter.runsource(source, filename='<input>', symbol='single')

在解释器中编译并运行一段源码。 所用参数与 compile_command() 一样；filename 的默认值为 '<input>'，symbol 则为 'single'。 可能发生以下情况之一：

输入不正确；compile_command() 引发了一个异常 (SyntaxError 或 OverflowError)。 将通过调用 showsyntaxerror() 方法打印语法回溯信息。 runsource() 返回 False。

输入不完整，需要更多输入；函数 compile_command() 返回 None 。方法 runsource() 返回 True 。

输入完整；compile_command() 返回了一个代码对象。 将通过调用 runcode() 执行代码（该方法也会处理运行时异常，SystemExit 除外）。 runsource() 返回 False。

该返回值用于决定使用 sys.ps1 还是 sys.ps2 来作为下一行的输入提示符。

InteractiveInterpreter.runcode(code)

执行一个代码对象。当发生异常时，调用 showtraceback() 来显示回溯。除 SystemExit （允许传播）以外的所有异常都会被捕获。

有关 KeyboardInterrupt 的说明，该异常可能发生于此代码的其他位置，并且并不总能被捕获。 调用者应当准备好处理它。

InteractiveInterpreter.showsyntaxerror(filename=None)

显示刚发生的语法错误。 这不会显示堆栈回溯因为语法错误并无此种信息。 如果给出了 filename，它会被放入异常来替代 Python 解析器所提供的默认文件名，因为它在从一个字符串读取时总是会使用 '<string>'。 输出将由 write() 方法来写入。

InteractiveInterpreter.showtraceback()

显示刚发生的异常。 我们移除了第一个堆栈条目因为它从属于解释器对象的实现。 输出将由 write() 方法来写入。

在 3.5 版更改: 将显示完整的链式回溯，而不只是主回溯。

InteractiveInterpreter.write(data)

将一个字符串写入到标准错误流 (sys.stderr)。 所有派生类都应重写此方法以提供必要的正确输出处理。

交互式控制台对象

InteractiveConsole 类是 InteractiveInterpreter 的子类，因此它提供了解释器对象的所有方法，还有以下的额外方法。

InteractiveConsole.interact(banner=None, exitmsg=None)

近似地模拟交互式 Python 终端。 可选的 banner 参数指定要在第一次交互前打印的条幅；默认情况下会类似于标准 Python 解释器所打印的内容，并附上外加圆括号的终端对象类名（这样就不会与真正的解释器混淆 —— 因为确实太像了！）

可选的 exitmsg 参数指定要在退出时打印的退出消息。 传入空字符串可以屏蔽退出消息。 如果 exitmsg 未给出或为 None，则将打印默认消息。

在 3.4 版更改: 要禁止打印任何条幅消息，请传递一个空字符串。

在 3.6 版更改: 退出时打印退出消息。

InteractiveConsole.push(line)

将一行源文本推入解释器。 行内容不应带有末尾换行符；它可以有内部换行符。 行内容会被添加到一个缓冲区并且会调用解释器的 runsource() 方法，附带缓冲区内容的拼接结果作为源文本。 如果显示命令已执行或不合法，缓冲区将被重置；否则，则命令尚未结束，缓冲区将在添加行后保持原样。 如果要求更多输入则返回值为 True，如果行已按某种方式被处理则返回值为 False (这与 runsource() 相同)。

InteractiveConsole.resetbuffer()

从输入缓冲区中删除所有未处理的内容。

InteractiveConsole.raw_input(prompt='')

输出提示并读取一行。返回的行不包含末尾的换行符。当用户输入 EOF 键序列时，会引发 EOFError 异常。默认实现是从 sys.stdin 读取；子类可以用其他实现代替。

codeop --- 编译Python代码

源代码： Lib/codeop.py [https://github.com/python/cpython/tree/3.10/Lib/codeop.py]

codeop 模块提供了可以模拟Python读取-执行-打印循环的实用程序，就像在 code 模块中一样。因此，您可能不希望直接使用该模块；如果你想在程序中包含这样一个循环，你可能需要使用 code 模块。

这个任务有两个部分:

能够判断一行输入是否完成了一条 Python 语句：简而言之，就是告诉我们接下来是要打印 '>>>' 还是 '...'。

记住用户已输入了哪些 future 语句，这样后续的输入可以在这些语句生效的状态下被编译。

codeop 模块提供了分别以及同时执行这两个部分的方式。

只执行前一部分：

codeop.compile_command(source, filename='<input>', symbol='single')

尝试编译 source，这应当是一个 Python 代码字符串并且在 source 是有效的 Python 代码时返回一个对象对象。 在此情况下，代码对象的 filename 属性将为 filename，其默认值为 '<input>'。 如果 source 不是 not 有效的 Python 代码，而是有效的 Python 代码的一个前缀时将返回 None。

如果 source 存在问题，将引发异常。 如果存在无效的 Python 语法将引发 SyntaxError，而如果存在无效的字面值则将引发 OverflowError 或 ValueError。

symbol 参数确定 source 是作为一条语句 ('single'，为默认值)，作为一个 statement 的序列 ('exec') 还是作为一个 expression ('eval') 来进行编译。 任何其他值都将导致引发 ValueError。

注解

解析器有可能（但很不常见）会在到达源码结尾之前停止解析并成功输出结果；在这种情况下，末尾的符号可能会被忽略而不是引发错误。 例如，一个反斜杠加两个换行符之后可以跟随任何无意义的符号。 一旦解析器 API 得到改进将修正这个问题。

class codeop.Compile

这个类的实例具有 __call__() 方法，其签名与内置函数 compile() 相似，区别在于如果该实例编译了包含 __future__ 语句的程序文本，则实例会‘记住’并使用已生效的语句编译所有后续程序文本。

class codeop.CommandCompiler

Instances of this class have __call__() methods identical in signature to compile_command(); the difference is that if the instance compiles program text containing a __future__ statement, the instance 'remembers' and compiles all subsequent program texts with the statement in force.

导入模块

本章中介绍的模块提供了导入其他Python模块和挂钩以自定义导入过程的新方法。

本章描述的完整模块列表如下：

zipimport --- 从 Zip 存档中导入模块

zipimporter 对象

例子

pkgutil --- 包扩展工具

modulefinder --- 查找脚本使用的模块

ModuleFinder 的示例用法

runpy ——查找并执行 Python 模块

importlib --- import 的实现

概述

函数

importlib.abc —— 关于导入的抽象基类

importlib.resources -- 资源

importlib.machinery —— 导入器和路径钩子函数。

importlib.util —— 导入器的工具程序代码

例子

用编程方式导入

检查某模块可否导入。

直接导入源码文件。

实现延迟导入

导入器的配置

importlib.import_module() 的近似实现

使用 importlib.metadata

概述

函数式 API

入口点

分发的元数据

分发包的版本

分发包的文件

分发包的依赖

包的分发

分发包对象

扩展搜索算法

zipimport --- 从 Zip 存档中导入模块

源代码： Lib/zipimport.py [https://github.com/python/cpython/tree/3.10/Lib/zipimport.py]

此模块添加了从 ZIP 格式档案中导入 Python 模块（ *.py ， *.pyc ）和包的能力。通常不需要明确地使用 zipimport 模块，内置的 import 机制会自动将此模块用于 ZIP 档案路径的 sys.path 项目上。

通常， sys.path 是字符串的目录名称列表。此模块同样允许 sys.path 的一项成为命名 ZIP 文件档案的字符串。 ZIP 档案可以容纳子目录结构去支持包的导入，并且可以将归档文件中的路径指定为仅从子目录导入。比如说，路径 example.zip/lib/ 将只会从档案中的 lib/ 子目录导入。

任何文件都可以放到 ZIP 档案中，但只有 .py 和 .pyc 文件会触发导入器操作。 动态模块 (.pyd, .so) 的 ZIP 导入是不被允许的。 请注意如果一个档案只包含有 .py 文件，那么 Python 将不会尝试通过添加对应的 .pyc 文件来修改档案，这意味着如果一个 ZIP 档案不包含 .pyc 文件，则导入速度可能会相当慢。

在 3.8 版更改: 以前，不支持带有档案注释的 ZIP 档案。

参见

PKZIP Application Note [https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT]

Phil Katz 编写的 ZIP 文件格式文档，此格式和使用的算法的创建者。

PEP 273 [https://www.python.org/dev/peps/pep-0273] - 从 ZIP 压缩包导入模块

由 James C. Ahlstrom 编写，他也提供了实现。 Python 2.3 遵循 PEP 273 [https://www.python.org/dev/peps/pep-0273] 的规范，但是使用 Just van Rossum 编写的使用了 PEP 302 [https://www.python.org/dev/peps/pep-0302] 中描述的导入钩的实现。

importlib - 导入机制的实现

为所有导入器的实现提供相关协议的包。

此模块定义了一个异常：

exception zipimport.ZipImportError

异常由 zipimporter 对象引发。这是 ImportError 的子类，因此，也可以捕获为 ImportError 。

zipimporter 对象

zipimporter 是用于导入 ZIP 文件的类。

class zipimport.zipimporter(archivepath)

创建新的 zipimporter 实例。 archivepath 必须是指向 ZIP 文件的路径，或者 ZIP 文件中的特定路径。例如， foo/bar.zip/lib 的 archivepath 将在 ZIP 文件 foo/bar.zip 中的 lib 目录中查找模块（只要它存在）。

如果 archivepath 没有指向一个有效的 ZIP 档案，引发 ZipImportError 。

create_module(spec)

返回 None 来显式地请求默认语义的 importlib.abc.Loader.create_module() 实现。

3.10 新版功能.

exec_module(module)

importlib.abc.Loader.exec_module() 的实现。

3.10 新版功能.

find_loader(fullname, path=None)

importlib.abc.PathEntryFinder.find_loader() 的实现。

3.10 版后已移除: 使用 find_spec() 代替。

find_module(fullname, path=None)

搜索由 fullname 指定的模块。 fullname 必须是完全合格的（点分的）模块名。它返回 zipimporter 实例本身如果模块被找到，或者返回 None 如果没找到指定模块。可选的 path 被忽略，这是为了与导入器协议兼容。

3.10 版后已移除: 使用 find_spec() 代替。

find_spec(fullname, target=None)

importlib.abc.PathEntryFinder.find_spec() 的实现。

3.10 新版功能.

get_code(fullname)

返回指定模块的代码对象。 如果模块无法被导入则引发 ZipImportError。

get_data(pathname)

返回与 pathname 相关联的数据。如果不能找到文件则引发 OSError 错误。

在 3.3 版更改: 曾经是 IOError 被引发而不是 OSError 。

get_filename(fullname)

返回如果指定模块被导入则应当要设置的 __file__ 值。 如果模块无法被导入则引发 ZipImportError。

3.1 新版功能.

get_source(fullname)

返回指定模块的源代码。如果没有找到模块则引发 ZipImportError ，如果档案包含模块但是没有源代码，返回 None 。

is_package(fullname)

如果由 fullname 指定的模块是一个包则返回 True 。如果不能找到模块则引发 ZipImportError 错误。

load_module(fullname)

导入由 fullname 所指定的模块。 fullname 必须为（带点号的）完整限定名称。 成功时返回导入的模块，失败时引发 ZipImportError。

3.10 版后已移除: 使用 exec_module() 来代替。

invalidate_caches()

清除在 ZIP 归档文件中找到的相关文件信息的内部缓存。

3.10 新版功能.

archive

导入器关联的 ZIP 文件的文件名，没有可能的子路径。

prefix

ZIP 文件中搜索的模块的子路径。这是一个指向 ZIP 文件根目录的 zipimporter 对象的空字符串。

当与斜杠结合使用时， archive 和 prefix 属性等价于赋予 zipimporter 构造器的原始 archivepath 参数。

例子

这是一个从 ZIP 档案中导入模块的例子 - 请注意 zipimport 模块不需要明确地使用。

$ unzip -l example.zip
Archive:  example.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  11-26-02 22:30   jwzthreading.py
 --------                   -------
     8467                   1 file
$ ./python
Python 2.3 (#1, Aug 1 2003, 19:54:32)
>>> import sys
>>> sys.path.insert(0, 'example.zip')  # Add .zip file to front of path
>>> import jwzthreading
>>> jwzthreading.__file__
'example.zip/jwzthreading.py'

pkgutil --- 包扩展工具

源代码: Lib/pkgutil.py [https://github.com/python/cpython/tree/3.10/Lib/pkgutil.py]

该模块为导入系统提供了工具，尤其是在包支持方面。

class pkgutil.ModuleInfo(module_finder, name, ispkg)

一个包含模块信息的简短摘要的命名元组。

3.6 新版功能.

pkgutil.extend_path(path, name)

扩展组成包的模块的搜索路径。 预期用途是将以下代码放到包的 __init__.py 中:

from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

这将添加到包的 __path__ 所有在 sys.path 上以该包命名的目录的子目录。 这在想把一个逻辑包的不同部分作为多个目录来分发时很有用处。

它还会查找开头部分 * 与 name 参数相匹配的 *.pkg 文件。 此特性与 *.pth 文件类似（请参阅 site 模块了解更多信息），区别在于它不会对以 import 开头的行做特别对待。 将按外在值对 *.pkg 文件添加信任：除了检查重复项，，所有在 *.pkg 文件中找到的条目都会被添加到路径中，不管它们是否存在于文件系统中。 （这是特性而非缺陷。）

如果输入路径不是一个列表（已冻结包就是这种情况）则它将被原样返回。 输入路径不会被修改；将返回一个扩展的副本。 条目将被添加到副本的末尾。

sys.path 会被假定为一个序列。 sys.path 中的条目如果不是指向现有目录的字符串则会被忽略。 sys.path 上当用作文件名时会导致错误的 Unicode 条目可以会使得此函数引发异常（与 os.path.isdir() 的行为一致）。

class pkgutil.ImpImporter(dirname=None)

包装了 Python 的 "经典" 导入算法的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 查找器

如果 dirname 是一个字符串，将创建一个 PEP 302 [https://www.python.org/dev/peps/pep-0302] 查找器来搜索该目录。 如果 dirname 为 None，则将创建一个 PEP 302 [https://www.python.org/dev/peps/pep-0302] 来搜索当前 sys.path，加上任何已冻结或内置的模块。

请注意 ImpImporter 目前并不支持放置在 sys.meta_path 上使用。

3.3 版后已移除: 这种模拟已不再必要，因为标准的导入机制现在完全兼容 PEP 302 [https://www.python.org/dev/peps/pep-0302] 并且在 importlib 中可用。

class pkgutil.ImpLoader(fullname, file, filename, etc)

包装了 Python 的 "经典" 导入算法的 加载器。

3.3 版后已移除: 这种模拟已不再必要，因为标准的导入机制现在完全兼容 PEP 302 [https://www.python.org/dev/peps/pep-0302] 并且在 importlib 中可用。

pkgutil.find_loader(fullname)

为给定的 fullname 获取一个模块 loader。

这是针对 importlib.util.find_spec() 的向下兼容包装器，它将大多数失败转换为 ImportError 并且只返回加载器而不是完整的 ModuleSpec。

在 3.3 版更改: 更新为直接基于 importlib 而不是依赖于包内部的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟。

在 3.4 版更改: 更新为基于 PEP 451 [https://www.python.org/dev/peps/pep-0451]

pkgutil.get_importer(path_item)

为给定的 path_item 获取一个 finder。

返回的查找器如果是由一个路径钩子新建的则会被缓存至 sys.path_importer_cache。

如果需要重新扫描 sys.path_hooks 则缓存（或其一部分）可以被手动清空。

在 3.3 版更改: 更新为直接基于 importlib 而不是依赖于包内部的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟。

pkgutil.get_loader(module_or_name)

为 module_or_name 获取一个 loader。

如果模块或包可通过正常导入机制来访问，则会返回该机制相关部分的包装器。 如果模块无法找到或导入则返回 None。 如果指定的模块尚未被导入，则包含它的包（如果存在）会被导入，以便建立包 __path__。

在 3.3 版更改: 更新为直接基于 importlib 而不是依赖于包内部的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟。

在 3.4 版更改: 更新为基于 PEP 451 [https://www.python.org/dev/peps/pep-0451]

pkgutil.iter_importers(fullname='')

为给定的模块名称产生 finder 对象。

如果完整名称包含一个 '.'，查找器将针对包含该完整名称的包，否则它们将被注册为最高层级查找器（即同时用于 sys.meta_path 和 sys.path_hooks)。

如果指定的模块位于一个包内，则该包会作为唤起此函数的附带影响被导入。

如果未指定模块名称，则会产生所有的最高层级查找器。

在 3.3 版更改: 更新为直接基于 importlib 而不是依赖于包内部的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟。

pkgutil.iter_modules(path=None, prefix='')

为 path 上的所有子模块产生 ModuleInfo，或者如果 path 为 None，则为 sys.path 上的所有最高层级模块产生。

path 应当为 None 或一个作为查找模块目标的路径的列表。

prefix 是要在输出时输出到每个模块名称之前的字符串。

注解

只适用于定义了 iter_modules() 方法的 finder。 该接口是非标准的，因此本模块还提供了针对 importlib.machinery.FileFinder 和 zipimport.zipimporter 的实现。

在 3.3 版更改: 更新为直接基于 importlib 而不是依赖于包内部的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟。

pkgutil.walk_packages(path=None, prefix='', onerror=None)

在 path 上递归地为所有模块产生 ModuleInfo，或者如果 path 为 None，则为所有可访问的模块产生。

path 应当为 None 或一个作为查找模块目标的路径的列表。

prefix 是要在输出时输出到每个模块名称之前的字符串。

请注意此函数必须导入给定 path 上所有的 packages (而不是 所有的模块！)，以便能访问 __path__ 属性来查找子模块。

onerror 是在当试图导入包如果发生任何异常则将附带一个参数（被导入的包的名称）被调用的函数。 如果没有提供 onerror 函数，则 ImportError 会被捕获并被忽略，而其他异常则会被传播，导致模块搜索的终结。

示例:

# list all modules python can access
walk_packages()

# list all submodules of ctypes
walk_packages(ctypes.__path__, ctypes.__name__ + '.')

注解

只适用于定义了 iter_modules() 方法的 finder。 该接口是非标准的，因此本模块还提供了针对 importlib.machinery.FileFinder 和 zipimport.zipimporter 的实现。

在 3.3 版更改: 更新为直接基于 importlib 而不是依赖于包内部的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入模拟。

pkgutil.get_data(package, resource)

从包中获取一个资源。

这是一个针对 loader get_data API 的包装器。 package 参数应为一个标准模块格式 (foo.bar) 的包名称。 resource 参数应为相对路径文件名的形式，使用 / 作为路径分隔符。 父目录名 ..，以及根目录名 (以 / 打头) 均不允许使用。

返回指定资源内容的二进制串。

对于位于文件系统中，已经被导入的包来说，这大致等价于:

d = os.path.dirname(sys.modules[package].__file__)
data = open(os.path.join(d, resource), 'rb').read()

如果指定的包无法被定位或加载，或者如果它使用了不支持 get_data 的 loader，则将返回 None。 特别地，针对 命名空间包 的 loader 不支持 get_data。

pkgutil.resolve_name(name)

将一个名称解析为对象。

此功能被用在标准库的许多地方 (参见 bpo-12915 [https://bugs.python.org/issue?@action=redirect&bpo=12915]) —— 并且等价的功能也被广泛用于第三方包例如 setuptools, Django 和 Pyramid。

预期 name 将为以下格式之一，其中 W 是一个有效的 Python 标识符的缩写而点号表示这些伪正则表达式中的句点字面值:

W(.W)*

W(.W)*:(W(.W)*)?

第一种形式只是为了保持向下兼容性。 它假定带点号名称的某一部分是包，而其余部分则是该包内部的一个对象，并可能嵌套在其他对象之内。 因为包和对象层级结构之间的分界点无法通过观察来确定，所以使用这种形式必须重复尝试导入。

在第二种形式中，调用方通过提供一个单独冒号来明确分界点：冒号左边的带点号名称是要导入的包，而冒号右边的带点号名称则是对象层级结构。 使用这种形式只需要导入一次。 如果它以冒号结尾，则将返回一个模块对象。

此函数将返回一个对象（可能为模块），或是引发下列异常之一:

ValueError -- 如果 name 不为可识别的格式。

ImportError -- 如果导入本应成功但却失败。

AttributeError -- 当在遍历所导入包的对象层级结构以获取想要的对象时遭遇失败。

3.9 新版功能.

modulefinder --- 查找脚本使用的模块

源码： Lib/modulefinder.py [https://github.com/python/cpython/tree/3.10/Lib/modulefinder.py]

该模块提供了一个 ModuleFinder 类，可用于确定脚本导入的模块集。 modulefinder.py 也可以作为脚本运行，给出 Python 脚本的文件名作为参数，之后将打印导入模块的报告。

modulefinder.AddPackagePath(pkg_name, path)

记录名为 pkg_name 的包可以在指定的 path 中找到。

modulefinder.ReplacePackage(oldname, newname)

允许指定名为 oldname 的模块实际上是名为 newname 的包。

class modulefinder.ModuleFinder(path=None, debug=0, excludes=[], replace_paths=[])

该类提供 run_script() 和 report() 方法，用于确定脚本导入的模块集。 path 可以是搜索模块的目录列表；如果没有指定，则使用 sys.path 。 debug 设置调试级别；更高的值使类打印调试消息，关于它正在做什么。 excludes 是要从分析中排除的模块名称列表。 replace_paths 是将在模块路径中替换的 (oldpath, newpath) 元组的列表。

report()

将报告打印到标准输出，列出脚本导入的模块及其路径，以及缺少或似乎缺失的模块。

run_script(pathname)

分析 pathname 文件的内容，该文件必须包含 Python 代码。

modules

一个将模块名称映射到模块的字典。 请参阅 ModuleFinder 的示例用法。

ModuleFinder 的示例用法

稍后将分析的脚本（bacon.py）:

import re, itertools

try:
    import baconhameggs
except ImportError:
    pass

try:
    import guido.python.ham
except ImportError:
    pass

将输出 bacon.py 报告的脚本:

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='')
    print(','.join(list(mod.globalnames.keys())[:3]))

print('-'*50)
print('Modules not imported:')
print('\n'.join(finder.badmodules.keys()))

输出样例（可能因架构而异）:

Loaded modules:
_types:
copyreg:  _inverted_registry,_slotnames,__all__
sre_compile:  isstring,_sre,_optimize_unicode
_sre:
sre_constants:  REPEAT_ONE,makedict,AT_END_LINE
sys:
re:  __module__,finditer,_expand
itertools:
__main__:  re,itertools,baconhameggs
sre_parse:  _PATTERNENDERS,SRE_FLAG_UNICODE
array:
types:  __module__,IntType,TypeType
---------------------------------------------------
Modules not imported:
guido.python.ham
baconhameggs

runpy ——查找并执行 Python 模块

源代码： Lib/runpy.py [https://github.com/python/cpython/tree/3.10/Lib/runpy.py]

runpy 模块用于找到并运行 Python 的模块，而无需首先导入。主要用于实现 -m 命令行开关，以允许用 Python 模块命名空间而不是文件系统来定位脚本。

请注意，这 并非 一个沙盒模块——所有代码都在当前进程中运行，所有副作用（如其他模块对导入操作进行了缓存）在函数返回后都会留存。

此外，在 runpy 函数返回后，任何由已执行代码定义的函数和类都不能保证正确工作。如果某使用场景不能接收此限制，那么选用 importlib 可能更合适些。

runpy 模块提供两个函数：

runpy.run_module(mod_name, init_globals=None, run_name=None, alter_sys=False)

执行给定模块的代码，并返回结果模块的 globals 字典。 该模块的代码首先会用标准的导入机制去查找定位 (详情请参阅 PEP 302 [https://www.python.org/dev/peps/pep-0302])，然后在全新的模块命名空间中运行。

参数 mod_name 应该是一个绝对模块名。如果模块名指向一个包，而不是普通的模块，那么该包会被导入，然后执行包中的 __main__ 子模块，并返回结果模块的 globals 字典。

可选的字典参数 init_globals 可用来在代码执行前预填充模块的 globals 字典。给出的字典参数不会被修改。如果字典中定义了以下任意一个特殊全局变量，这些定义都会被 run_module() 覆盖。

The special global variables __name__, __spec__, __file__, __cached__, __loader__ and __package__ are set in the globals dictionary before the module code is executed (Note that this is a minimal set of variables - other variables may be set implicitly as an interpreter implementation detail).

若可选参数 __name__ 不为 None 则设为 run_name，若此名称的模块是一个包则设为 mod_name + '.__main__'，否则设为 mod_name 参数。

__spec__ 将设为合适的 实际 导入模块（也就是说，__spec__.name 一定是 mod_name 或 mod_name + '.__main__，而不是 run_name）。

__file__ 、__cached__、 __loader__ 和 __package__ 根据模块规格进行 常规设置

如果给出了参数 alter_sys 并且值为 True，那么 sys.argv[0] 将被更新为 __file__ 的值，sys.modules[__name__] 将被更新为临时模块对象。在函数返回前， sys.argv[0] 和 sys.modules[__name__] 将会复原。

注意，这种对 sys 的操作不是线程安全的。其他线程可能会看到初始化不完整的模块，以及变动后的参数列表。如果从线程中的代码调用此函数，建议单实例运行 sys 模块。

参见

-m 选项由命令行提供相同功能。

在 3.1 版更改: 加入了 查找 __main__ 子模块并执行软件包的能力。

在 3.2 版更改: 加入了 __cached__ 全局变量（参见 PEP 3147 [https://www.python.org/dev/peps/pep-3147] ）。

在 3.4 版更改: 充分利用 PEP 451 [https://www.python.org/dev/peps/pep-0451] 加入的模块规格功能。使得以这种方式运行的模块能够正确设置 __cached__，并确保真正的模块名称总是可以通过 __spec__.name 的形式访问。

runpy.run_path(path_name, init_globals=None, run_name=None)

执行指定位置的代码，并返回结果模块的 globals 字典。与提供给 CPython 命令行的脚本名称一样，给出的路径可以指向 Python 源文件、编译过的字节码文件或包含 __main__ 模块的有效 sys.path 项（例如一个包含顶级 __main__.py 文件的 zip 文件）。

对于直接的脚本而言，指定代码将直接在一个新的模块命名空间中运行。对于一个有效的 sys.path 项（通常是一个 zip 文件或目录），其首先会被添加到 sys.path 的开头。然后，本函数用更新后的路径查找并执行 __main__ 模块。请注意，即便在指定位置不存在主模块，也没有特别的保护措施来防止调用存在于 sys.path 其他地方的 __main__。

利用可选的字典参数 init_globals ，可在代码执行前预填模块的 globals 字典。给出的字典参数不会被修改。如果给出的字典中定义了下列特殊全局变量，这些定义均会被 run_module() 覆盖。

The special global variables __name__, __spec__, __file__, __cached__, __loader__ and __package__ are set in the globals dictionary before the module code is executed (Note that this is a minimal set of variables - other variables may be set implicitly as an interpreter implementation detail).

如果该可选参数不为 None，则 __name__ 被设为 run_name，否则为 '<run_path>'。

如果提供的路径直接引用了一个脚本文件（无论是源码文件还是预编译的字节码），那么 __file__ 将设为给出的路径，而 __spec__、__cached__、__loader__ 和 __package__ 都将设为 None。

如果给出的路径是对有效 sys.path 项的引用，那么 __spec__ 将为导入的 __main__ 模块进行正确设置 (也就是说，__spec__.name 将一定是 __main__)。 __file__, __cached__, __loader__ 和 __package__ 将依据模块规格 进行常规设置。

sys 模块也做了一些改动。 首先，sys.path 可能做上文所述的的修改。 sys.argv[0] 会被更新为 path_name 的值而 sys.modules[__name__] 会被更新为对应于正在被执行的模块的临时模块对象。 在函数返回之前对 sys 中条目的所有修改都会被复原。

注意，与 run_module() 不同的是，本函数对 sys 的修改不是可有可无的，因为这些调整对于 sys.path 项能够顺利执行至关重要。由于依然存在线程安全的限制，在线程代码中使用本函数时应采用导入锁进行序列运行，或者委托给一个单独的进程。

参见

接口选项 用于在命令行上实现同等功能（python path/to/script）。

3.2 新版功能.

在 3.4 版更改: 已作更新，以便充分利用 PEP 451 [https://www.python.org/dev/peps/pep-0451] 加入的模块规格功能。使得从有效 sys.path 项导入 __main__ 而不是直接执行的情况下，能够正确设置 __cached__。

参见

PEP 338 [https://www.python.org/dev/peps/pep-0338] -- 将模块作为脚本执行

PEP 由 Nick Coghlan 撰写并实现。

PEP 366 [https://www.python.org/dev/peps/pep-0366] ——主模块的显式相对导入

PEP 由 Nick Coghlan 撰写并实现。

PEP 451 [https://www.python.org/dev/peps/pep-0451] —— 导入系统采用的 ModuleSpec 类型

PEP 由 Eric Snow 撰写并实现。

命令行与环境 —— CPython 命令行详解

importlib.import_module() 函数

importlib --- import 的实现

3.1 新版功能.

源代码 Lib/importlib/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/importlib/__init__.py]

概述

importlib 包的目的有两个。 第一个目的是在 Python 源代码中提供 import 语句的实现（并且因此而扩展 __import__() 函数）。 这提供了一个可移植到任何 Python 解释器的 import 实现。 相比使用 Python 以外的编程语言实现方式，这一实现更加易于理解。

第二个目的是实现 import 的部分被公开在这个包中，使得用户更容易创建他们自己的自定义对象 (通常被称为 importer) 来参与到导入过程中。

参见

import 语句

import 语句的语言参考

包规格说明 [https://www.python.org/doc/essays/packages/]

包的初始规范。自从编写这个文档开始，一些语义已经发生改变了（比如基于 sys.modules 中 None 的重定向）。

__import__() 函数

import 语句是这个函数的语法糖。

PEP 235 [https://www.python.org/dev/peps/pep-0235]

在忽略大小写的平台上进行导入

PEP 263 [https://www.python.org/dev/peps/pep-0263]

定义 Python 源代码编码

PEP 302 [https://www.python.org/dev/peps/pep-0302]

新导入钩子

PEP 328 [https://www.python.org/dev/peps/pep-0328]

导入：多行和绝对/相对

PEP 366 [https://www.python.org/dev/peps/pep-0366]

主模块显式相对导入

PEP 420 [https://www.python.org/dev/peps/pep-0420]

隐式命名空间包

PEP 451 [https://www.python.org/dev/peps/pep-0451]

导入系统的一个模块规范类型

PEP 488 [https://www.python.org/dev/peps/pep-0488]

消除PYO文件

PEP 489 [https://www.python.org/dev/peps/pep-0489]

多阶段扩展模块初始化

PEP 552 [https://www.python.org/dev/peps/pep-0552]

确定性的 pyc 文件

PEP 3120 [https://www.python.org/dev/peps/pep-3120]

使用 UTF-8 作为默认的源编码

PEP 3147 [https://www.python.org/dev/peps/pep-3147]

PYC 仓库目录

函数

importlib.__import__(name, globals=None, locals=None, fromlist=(), level=0)

内置 __import__() 函数的实现。

注解

程序式地导入模块应该使用 import_module() 而不是这个函数。

importlib.import_module(name, package=None)

导入一个模块。 参数 name 指定了以绝对或相对导入方式导入什么模块 (比如要么像这样 pkg.mod 或者这样 ..mod)。 如果参数 name 使用相对导入的方式来指定，那么 package 参数必须设置为那个包名，这个包名作为解析这个包名的锚点 (比如 import_module('..mod', 'pkg.subpkg') 将会导入 pkg.mod)。

import_module() 函数是一个对 importlib.__import__() 进行简化的包装器。 这意味着该函数的所有语义都来自于 importlib.__import__()。 这两个函数之间最重要的不同点在于 import_module() 返回指定的包或模块 (例如 pkg.mod)，而 __import__() 返回最高层级的包或模块 (例如 pkg)。

如果动态导入一个自解释器开始执行以来被创建的模块（即创建了一个 Python 源代码文件），为了让导入系统知道这个新模块，可能需要调用 invalidate_caches()。

在 3.3 版更改: 父包会被自动导入。

importlib.find_loader(name, path=None)

查找一个模块的加载器，可选择地在指定的 path 里面。如果这个模块是在 sys.modules，那么返回 sys.modules[name].__loader__ (除非这个加载器是 None 或者是没有被设置， 在这样的情况下，会引起 ValueError 异常）。 否则使用 sys.meta_path 的一次搜索就结束。如果未发现加载器，则返回 None。

点状的名称没有使得它父包或模块隐式地导入，因为它需要加载它们并且可能不需要。为了适当地导入一个子模块，需要导入子模块的所有父包并且使用正确的参数提供给 path。

3.3 新版功能.

在 3.4 版更改: 如果没有设置 __loader__，会引起 ValueError 异常，就像属性设置为 None 的时候一样。

3.4 版后已移除: 使用 importlib.util.find_spec() 来代替。

importlib.invalidate_caches()

使查找器存储在 sys.meta_path 中的内部缓存无效。如果一个查找器实现了 invalidate_caches()，那么它会被调用来执行那个无效过程。 如果创建/安装任何模块，同时正在运行的程序是为了保证所有的查找器知道新模块的存在，那么应该调用这个函数。

3.3 新版功能.

importlib.reload(module)

重新加载之前导入的 module。 那个参数必须是一个模块对象，所以它之前必须已经成功导入了。 这在你已经使用外部编辑器编辑过了那个模块的源代码文件并且想在退出 Python 解释器之前试验这个新版本的模块的时候将很适用。 函数的返回值是那个模块对象（如果重新导入导致一个不同的对象放置在 sys.modules 中，那么那个模块对象是有可能会不同）。

当执行 reload() 的时候：

Python 模块的代码会被重新编译并且那个模块级的代码被重新执行，通过重新使用一开始加载那个模块的 loader，定义一个新的绑定在那个模块字典中的名称的对象集合。扩展模块的 init 函数不会被调用第二次。

与Python中的所有的其它对象一样，旧的对象只有在它们的引用计数为0之后才会被回收。

模块命名空间中的名称重新指向任何新的或更改后的对象。

其他旧对象的引用（例如那个模块的外部名称）不会被重新绑定到引用的新对象的，并且如果有需要，必须在出现的每个命名空间中进行更新。

有一些其他注意事项：

当一个模块被重新加载的时候，它的字典（包含了那个模块的全区变量）会被保留。名称的重新定义会覆盖旧的定义，所以通常来说这不是问题。如果一个新模块没有定义在旧版本模块中定义的名称，则将保留旧版本中的定义。这一特性可用于作为那个模块的优点，如果它维护一个全局表或者对象的缓存 —— 使用 try 语句，就可以测试表的存在并且跳过它的初始化，如果有需要的话:

try:
    cache
except NameError:
    cache = {}

重新加载内置的或者动态加载模块，通常来说不是很有用处。不推荐重新加载"sys，__main__，builtins 和其它关键模块。在很多例子中，扩展模块并不是设计为不止一次的初始化，并且当重新加载时，可能会以任意方式失败。

如果一个模块使用 from ... import ... 导入的对象来自另外一个模块，给其它模块调用 reload() 不会重新定义来自这个模块的对象 —— 解决这个问题的一种方式是重新执行 from 语句，另一种方式是使用 import 和限定名称(module.name)来代替。

如果一个模块创建一个类的实例，重新加载定义那个类的模块不影响那些实例的方法定义———它们继续使用旧类中的定义。对于子类来说同样是正确的。

3.4 新版功能.

在 3.7 版更改: 如果重新加载的模块缺少 ModuleSpec ，则会触发 ModuleNotFoundError 。

importlib.abc —— 关于导入的抽象基类

源代码： Lib/importlib/abc.py [https://github.com/python/cpython/tree/3.10/Lib/importlib/abc.py]

importlib.abc 模块包含了 import 使用到的所有核心抽象基类。在实现核心的 ABCs 中，核心抽象基类的一些子类也提供了帮助。

ABC 类的层次结构：

object
 +-- Finder (deprecated)
 +-- MetaPathFinder
 +-- PathEntryFinder
 +-- Loader
      +-- ResourceLoader --------+
      +-- InspectLoader          |
           +-- ExecutionLoader --+
                                 +-- FileLoader
                                 +-- SourceLoader

class importlib.abc.Finder

代表 finder 的一个抽象基类

3.3 版后已移除: 使用 MetaPathFinder 或 PathEntryFinder 来代替。

abstractmethod find_module(fullname, path=None)

为指定的模块查找 loader 定义的抽象方法。本来是在 PEP 302 [https://www.python.org/dev/peps/pep-0302] 指定的，这个方法是在 sys.meta_path 和基于路径的导入子系统中使用。

在 3.4 版更改: 当被调用的时候，返回 None 而不是引发 NotImplementedError。

3.10 版后已移除: 改为实现 MetaPathFinder.find_spec() 或 PathEntryFinder.find_spec() 。

class importlib.abc.MetaPathFinder

一个代表 meta path finder 的抽象基类。

3.3 新版功能.

在 3.10 版更改: 不再是 Finder 的子类。

find_spec(fullname, path, target=None)

一个抽象方法，用于查找指定模块的 spec 。若是顶层导入，path 将为 None。 否则就是查找子包或模块，path 将是父级包的 __path__ 值。找不到则会返回 None。传入的 target 是一个模块对象，查找器可以用来对返回的规格进行更有依据的猜测。在实现具体的 MetaPathFinders 代码时，可能会用到 importlib.util.spec_from_loader() 。

3.4 新版功能.

find_module(fullname, path)

一个用于查找指定的模块中 loader 的遗留方法。如果这是最高层级的导入，path 的值将会是 None。否则，这是一个查找子包或者模块的方法，并且 path 的值将会是来自父包的 __path__ 的值。如果未发现加载器，返回 None。

如果定义了 find_spec() 方法，则提供了向后兼容的功能。

在 3.4 版更改: 当调用这个方法的时候返回 None 而不是引发 NotImplementedError。 可以使用 find_spec() 来提供功能。

3.4 版后已移除: 使用 find_spec() 代替。

invalidate_caches()

当被调用的时候，一个可选的方法应该将查找器使用的任何内部缓存进行无效。将在 sys.meta_path 上的所有查找器的缓存进行无效的时候，这个函数被 importlib.invalidate_caches() 所使用。

在 3.4 版更改: 当方法被调用的时候，方法返回是 None 而不是 NotImplemented 。

class importlib.abc.PathEntryFinder

一个抽象基类，代表 path entry finder。虽然与 MetaPathFinder 有些相似之处，但 PathEntryFinder 仅用于 importlib.machinery.PathFinder 提供的基于路径的导入子系统中。

3.3 新版功能.

在 3.10 版更改: 不再是 Finder 的子类。

find_spec(fullname, target=None)

一个抽象方法，用于查找指定模块的 spec。搜索器将只在指定的 path entry 内搜索该模块。找不到则会返回 None。在实现具体的 PathEntryFinders 代码时，可能会用到 importlib.util.spec_from_loader() 。

3.4 新版功能.

find_loader(fullname)

一个用于在模块中查找一个 loader 的遗留方法。 返回一个 (loader, portion) 的2元组，portion 是一个贡献给命名空间包部分的文件系统位置的序列。 加载器可能是 None，同时正在指定的 portion 表示的是贡献给命名空间包的文件系统位置。portion 可以使用一个空列表来表示加载器不是命名空间包的一部分。 如果 loader 是 None 并且 portion 是一个空列表，那么命名空间包中无加载器或者文件系统位置可查找到（即在那个模块中未能找到任何东西）。

如果定义了 find_spec() ，则提供了向后兼容的功能。

在 3.4 版更改: 返回 (None, []) 而不是引发 NotImplementedError。 当可于提供相应的功能的时候，使用 find_spec()。

3.4 版后已移除: 使用 find_spec() 代替。

find_module(fullname)

Finder.find_module`的具体实现，该方法等价于``self.find_loader(fullname)[0]`()。

3.4 版后已移除: 使用 find_spec() 代替。

invalidate_caches()

可选方法，调用后应让查找器用到的所有内部缓存失效。要让所有缓存的查找器的缓存无效时，可供 importlib.machinery.PathFinder.invalidate_caches() 调用。

class importlib.abc.Loader

loader 的抽象基类。 关于一个加载器的实际定义请查看 PEP 302 [https://www.python.org/dev/peps/pep-0302]。

加载器想要支持资源读取应该实现一个由 importlib.abc.ResourceReader 指定的``get_resource_reader(fullname)`` 方法。

在 3.7 版更改: 引入了可选的 get_resource_reader() 方法。

create_module(spec)

当导入一个模块的时候，一个返回将要使用的那个模块对象的方法。这个方法可能返回 None ，这暗示着应该发生默认的模块创建语义。"

3.4 新版功能.

在 3.5 版更改: 从 Python 3.6 开始，当定义了 exec_module() 的时候，这个方法将不会是可选的。

exec_module(module)

当一个模块被导入或重新加载时，一个抽象方法在它自己的命名空间中执行那个模块。当调用 exec_module() 的时候，那个模块应该已经被初始化 了。当这个方法存在时，必须定义 create_module() 。

3.4 新版功能.

在 3.6 版更改: create_module() 也必须被定义。

load_module(fullname)

用于加载一个模块的传统方法。如果这个模块不能被导入，将引起 ImportError 异常，否则返回那个被加载的模块。

如果请求的模块已经存在 sys.modules，应该使用并且重新加载那个模块。 否则加载器应该是创建一个新的模块并且在任何家过程开始之前将这个新模块插入到 sys.modules 中，来阻止递归导入。 如果加载器插入了一个模块并且加载失败了，加载器必须从 sys.modules 中将这个模块移除。在加载器开始执行之前，已经在 sys.modules 中的模块应该被忽略 (查看 importlib.util.module_for_loader())。

加载器应该在模块上面设置几个属性。（要知道当重新加载一个模块的时候，那些属性某部分可以改变）：

__name__

模块的名字

__file__

模块数据存储的路径(不是为了内置的模块而设置)

__cached__

被存储或应该被存储的模块的编译版本的路径（当这个属性不恰当的时候不设置）。

__path__

指定在一个包中搜索路径的一个字符串列表。这个属性不在模块上面进行设置。

__package__

The fully qualified name of the package under which the module was loaded as a submodule (or the empty string for top-level modules). For packages, it is the same as __name__. The importlib.util.module_for_loader() decorator can handle the details for __package__.

__loader__

用来加载那个模块的加载器。 importlib.util.module_for_loader() 装饰器可以处理 __package__ 的细节。

当 exec_module() 可用的时候，那么则提供了向后兼容的功能。

在 3.4 版更改: 当这个方法被调用的时候，触发 ImportError 异常而不是 NotImplementedError。当 exec_module() 可用的时候，使用它的功能。

3.4 版后已移除: 加载模块推荐的使用的 API 是 exec_module() (和 create_module())。 加载器应该实现它而不是 load_module()。 当 exec_module() 被实现的时候，导入机制关心的是 load_module() 所有其他的责任。

module_repr(module)

一个遗留方法，在实现时计算并返回给定模块的 repr，作为字符串。 模块类型的默认 repr() 将根据需要使用此方法的结果。

3.3 新版功能.

在 3.4 版更改: 是可选的方法而不是一个抽象方法。

3.4 版后已移除: 现在导入机制会自动地关注这个方法。

class importlib.abc.ResourceReader

被 TraversableResources 取代

提供读取 resources 能力的一个 abstract base class 。

从这个 ABC 的视角出发，resource 指一个包附带的二进制文件。常见的如在包的 __init__.py 文件旁的数据文件。这个类存在的目的是为了将对数据文件的访问进行抽象，这样包就和其数据文件的存储方式无关了。不论这些文件是存放在一个 zip 文件里还是直接在文件系统内。

对于该类中的任一方法，resource 参数的值都需要是一个在概念上表示文件名称的 path-like object。 这意味着任何子目录的路径都不该出现在 resouce 参数值内。 因为对于阅读器而言，包的位置就代表着「目录」。 因此目录和文件名就分别对应于包和资源。 这也是该类的实例都需要和一个包直接关联（而不是潜在指代很多包或者一整个模块）的原因。

想支持资源读取的加载器需要提供一个返回实现了此 ABC 的接口的 get_resource_reader(fullname) 方法。如果通过全名指定的模块不是一个包，这个方法应该返回 None。 当指定的模块是一个包时，应该只返回一个与这个抽象类ABC兼容的对象。

3.7 新版功能.

abstractmethod open_resource(resource)

返回一个打开的 file-like object 用于 resource 的二进制读取。

如果无法找到资源，将会引发 FileNotFoundError。

abstractmethod resource_path(resource)

返回 resource 的文件系统路径。

如果资源并不实际存在于文件系统中，将会引发 FileNotFoundError。

abstractmethod is_resource(name)

如果 name 被视作资源，则返回True。如果 name 不存在，则引发 FileNotFoundError 异常。

abstractmethod contents()

反回由字符串组成的 iterable，表示这个包的所有内容。 请注意并不要求迭代器返回的所有名称都是实际的资源，例如返回 is_resource() 为假值的名称也是可接受的。

允许非资源名字被返回是为了允许存储的一个包和它的资源的方式是已知先验的并且非资源名字会有用的情况。比如，允许返回子目录名字，目的是当得知包和资源存储在文件系统上面的时候，能够直接使用子目录的名字。

这个抽象方法返回了一个不包含任何内容的可迭代对象。

class importlib.abc.ResourceLoader

一个 loader 的抽象基类，它实现了可选的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 协议用于从存储后端加载任意资源。

3.7 版后已移除: 由于要支持使用 importlib.abc.ResourceReader 类来加载资源，这个 ABC 已经被弃用了。

abstractmethod get_data(path)

一个用于返回位于 path 的字节数据的抽象方法。有一个允许存储任意数据的类文件存储后端的加载器能够实现这个抽象方法来直接访问这些被存储的数据。如果不能够找到 path，则会引发 OSError 异常。path 被希望使用一个模块的 __file 属性或来自一个包的 __path__ 来构建。

在 3.4 版更改: 引发 OSError 异常而不是 NotImplementedError 异常。

class importlib.abc.InspectLoader

一个实现加载器检查模块可选的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 协议的 loader 的抽象基类。

get_code(fullname)

返回一个模块的代码对象，或如果模块没有一个代码对象（例如，对于内置的模块来说，这会是这种情况），则为 None。 如果加载器不能找到请求的模块，则引发 ImportError 异常。

注解

当这个方法有一个默认的实现的时候，出于性能方面的考虑，如果有可能的话，建议覆盖它。

在 3.4 版更改: 不再抽象并且提供一个具体的实现。

abstractmethod get_source(fullname)

一个返回模块源的抽象方法。使用 universal newlines 作为文本字符串被返回，将所有可识别行分割符翻译成 '\n' 字符。 如果没有可用的源（例如，一个内置模块），则返回 None。 如果加载器不能找到指定的模块，则引发 ImportError 异常。

在 3.4 版更改: 引发 ImportError 而不是 NotImplementedError。

is_package(fullname)

可选方法，如果模块为包，则返回 True，否则返回 False。 如果 loader 找不到模块，则会触发 ImportError。

在 3.4 版更改: 引发 ImportError 而不是 NotImplementedError。

static source_to_code(data, path='<string>')

创建一个来自Python源码的代码对象。

参数 data 可以是任意 compile() 函数支持的类型（例如字符串或字节串）。 参数 path 应该是源代码来源的路径，这可能是一个抽象概念（例如位于一个 zip 文件中）。

在有后续代码对象的情况下，可以在一个模块中通过运行 exec(code, module.__dict__) 来执行它。

3.4 新版功能.

在 3.5 版更改: 使得这个方法变成静态的。

exec_module(module)

Loader.exec_module() 的实现。

3.4 新版功能.

load_module(fullname)

Loader.load_module() 的实现。

3.4 版后已移除: 使用 exec_module() 来代替。

class importlib.abc.ExecutionLoader

一个继承自 InspectLoader 的抽象基类，当被实现时，帮助一个模块作为脚本来执行。 这个抽象基类表示可选的 PEP 302 [https://www.python.org/dev/peps/pep-0302] 协议。

abstractmethod get_filename(fullname)

一个用来为指定模块返回 __file__ 的值的抽象方法。如果无路径可用，则引发 ImportError。

如果源代码可用，那么这个方法返回源文件的路径，不管是否是用来加载模块的字节码。

在 3.4 版更改: 引发 ImportError 而不是 NotImplementedError。

class importlib.abc.FileLoader(fullname, path)

一个继承自 ResourceLoader 和 ExecutionLoader，提供 ResourceLoader.get_data() 和 ExecutionLoader.get_filename() 具体实现的抽象基类。

参数 fullname 是加载器要处理的模块的完全解析的名字。参数 path 是模块文件的路径。

3.3 新版功能.

name

加载器可以处理的模块的名字。

path

模块的文件路径

load_module(fullname)

调用super的 load_module()。

3.4 版后已移除: 使用 Loader.exec_module() 来代替。

abstractmethod get_filename(fullname)

返回 path。

abstractmethod get_data(path)

读取 path 作为二进制文件并且返回来自它的字节数据。

class importlib.abc.SourceLoader

一个用于实现源文件（和可选地字节码）加载的抽象基类。这个类继承自 ResourceLoader 和 ExecutionLoader，需要实现：

ResourceLoader.get_data()

ExecutionLoader.get_filename()

应该是只返回源文件的路径；不支持无源加载。

由这个类定义的抽象方法用来添加可选的字节码文件支持。不实现这些可选的方法（或导致它们引发 NotImplementedError 异常）导致这个加载器只能与源代码一起工作。 实现这些方法允许加载器能与源 和 字节码文件一起工作。不允许只提供字节码的 无源式 加载。字节码文件是通过移除 Python 编译器的解析步骤来加速加载的优化，并且因此没有开放出字节码专用的 API。

path_stats(path)

返回一个包含关于指定路径的元数据的 dict 的可选的抽象方法。 支持的字典键有：

'mtime' (必选项): 一个表示源码修改时间的整数或浮点数；

'size' (可选项)：源码的字节大小。

字典中任何其他键会被忽略，以允许将来的扩展。 如果不能处理该路径，则会引发 OSError。

3.3 新版功能.

在 3.4 版更改: 引发 OSError 而不是 NotImplemented。

path_mtime(path)

返回指定文件路径修改时间的可选的抽象方法。

3.3 版后已移除: 在有了 path_stats() 的情况下，这个方法被弃用了。 没必要去实现它了，但是为了兼容性，它依然处于可用状态。 如果文件路径不能被处理，则引发 OSError 异常。

在 3.4 版更改: 引发 OSError 而不是 NotImplemented。

set_data(path, data)

往一个文件路径写入指定字节的的可选的抽象方法。任何中间不存在的目录不会被自动创建。

由于路径是只读的，当写入的路径产生错误时（errno.EACCES/PermissionError），不会传播异常。

在 3.4 版更改: 当被调用时，不再引起 NotImplementedError 异常。

get_code(fullname)

InspectLoader.get_code() 的具体实现。

exec_module(module)

Loader.exec_module() 的具体实现。

3.4 新版功能.

load_module(fullname)

Concrete implementation of Loader.load_module().

3.4 版后已移除: 使用 exec_module() 来代替。

get_source(fullname)

InspectLoader.get_source() 的具体实现。

is_package(fullname)

InspectLoader.is_package() 的具体实现。一个模块被确定为一个包的条件是：它的文件路径（由 ExecutionLoader.get_filename() 提供）当文件扩展名被移除时是一个命名为 __init__ 的文件，并且 这个模块名字本身不是以 __init__ 结束。

class importlib.abc.Traversable

一个具有 pathlib.Path 中方法的子集并适用于遍历目录和打开文件的对象。

对于该对象在文件系统中的表示形式，请使用 importlib.resources.as_file()。

3.9 新版功能.

abstractmethod name()

此对象不带任何父引用的基准名。

abstractmethod iterdir()

产出自身内部的可遍历对象。

abstractmethod is_dir()

如果自身是一个目录则返回 True。

abstractmethod is_file()

如果自身是一个文件则返回 True。

abstractmethod joinpath(child)

返回自身中可遍历的子对象。

abstractmethod __truediv__(child)

返回自身中可遍历的子对象。

abstractmethod open(mode='r', *args, **kwargs)

mode 可以为 'r' 或 'rb' 即以文本或二进制模式打开。 返回一个适用于读取的句柄（与 pathlib.Path.open 样同）。

当以文本模式打开时，接受与 io.TextIOWrapper 所接受的相同的编码格式形参。

read_bytes()

以字节串形式读取自身的内容。

read_text(encoding=None)

以文本形式读取自身的内容。

Note: In Python 3.11 and later, this class is found in importlib.resources.abc.

class importlib.abc.TraversableResources

An abstract base class for resource readers capable of serving the files interface. Subclasses ResourceReader and provides concrete implementations of the ResourceReader's abstract methods. Therefore, any loader supplying TraversableResources also supplies ResourceReader.

需要支持资源读取的加载器应实现此接口。

3.9 新版功能.

Note: In Python 3.11 and later, this class is found in importlib.resources.abc.

importlib.resources -- 资源

源码： Lib/importlib/resources.py [https://github.com/python/cpython/tree/3.10/Lib/importlib/resources.py]

3.7 新版功能.

这个模块使得Python的导入系统提供了访问 包 内的 资源 的功能。如果能够导入一个包，那么就能够访问那个包里面的资源。资源可以以二进制或文本模式方式被打开或读取。

资源非常类似于目录内部的文件，要牢记的是这仅仅是一个比喻。资源和包不是与文件系统上的物理文件和目录一样存在着。

注解

本模块提供了类似于 pkg_resources [https://setuptools.readthedocs.io/en/latest/pkg_resources.html] Basic Resource Access [http://setuptools.readthedocs.io/en/latest/pkg_resources.html#basic-resource-access] 的功能，但没有该包的性能开销。这样读取包中的资源就更为容易，语义也更稳定一致。

该模块有独立的向下移植版本， using importlib.resources [http://importlib-resources.readthedocs.io/en/latest/using.html] 和 migrating from pkg_resources to importlib.resources [http://importlib-resources.readthedocs.io/en/latest/migration.html] 提供了更多信息。

加载器想要支持资源读取应该实现一个由 importlib.abc.ResourceReader 指定的``get_resource_reader(fullname)`` 方法。

定义了以下类型。

importlib.resources.Package

Package 类型定义为 Union[str, ModuleType] 。这意味着只要函数说明接受 Package 的地方，就可以传入字符串或模块。模块对象必须拥有一个可解析的 __spec__.submodule_search_locations，不能是 None。

importlib.resources.Resource

此类型描述了传入本包各函数的资源名称。定义为 Union[str, os.PathLike]。

有以下函数可用：

importlib.resources.files(package)

Returns an importlib.abc.Traversable object representing the resource container for the package (think directory) and its resources (think files). A Traversable may contain other containers (think subdirectories).

package 是包名或符合 Package 要求的模块对象。

3.9 新版功能.

importlib.resources.as_file(traversable)

Given a importlib.abc.Traversable object representing a file, typically from importlib.resources.files(), return a context manager for use in a with statement. The context manager provides a pathlib.Path object.

退出上下文管理程序时，可以清理所有临时文件，比如从压缩文件中提取资源时创建的那些文件。

如果 Traversable 方法（read_text 等）不够用，需要文件系统中的实际文件时，请使用 as_file。

3.9 新版功能.

importlib.resources.open_binary(package, resource)

以二进制读方式打开 package 内的 resource。

package 是包名或符合 Package 要求的模块对象。 resource 是要在 package 内打开的资源名；不能包含路径分隔符，也不能有子资源（即不能为目录）。本函数将返回一个 typing.BinaryIO 实例以供读取，即一个已打开的二进制 I/O 流。

importlib.resources.open_text(package, resource, encoding='utf-8', errors='strict')

以文本读方式打开 package 内的 resource。默认情况下，资源将以 UTF-8 格式打开以供读取。

package 是包名或符合 Package 要求的模块对象。 resource 是要在 package 内打开的资源名；不能包含路径分隔符，也不能有子资源（即不能是目录）。encoding 和 errors 的含义与内置 open() 的一样。

本函数返回一个 typing.TextIO 实例，即一个打开的文本 I/O 流对象以供读取。

importlib.resources.read_binary(package, resource)

读取并返回 package 中的 resource 内容，格式为 bytes。

package 是包名或符合 Package 要求的模块对象。 resource 是要在 package 内打开的资源名；不能包含路径分隔符，也不能有子资源（即不能是目录）。资源内容以 bytes 的形式返回。

importlib.resources.read_text(package, resource, encoding='utf-8', errors='strict')

读取并返回 package 中 resource 的内容，格式为 str。默认情况下，资源内容将以严格的 UTF-8 格式读取。

package 是包名或符合 Package 要求的模块对象。 resource 是要在 package 内打开的资源名；不能包含路径分隔符，也不能有子资源（即不能是目录）。encoding 和 errors 的含义与内置 open() 的一样。资源内容将以 str 的形式返回。

importlib.resources.path(package, resource)

返回 resource 实际的文件系统路径。本函数返回一个上下文管理器，以供 with 语句中使用。上下文管理器提供一个 pathlib.Path 对象。

退出上下文管理程序时，可以清理所有临时文件，比如从压缩文件中提取资源时创建的那些文件。

package 是包名或符合 Package 要求的模块对象。 resource 是要在 package 内打开的资源名；不能包含路径分隔符，也不能有子资源（即不能是目录）。

importlib.resources.is_resource(package, name)

如果包中存在名为 name 的资源，则返回 True，否则返回 False。 请记住，目录 不是 资源！ package 为包名或符合 Package 要求的模块对象。

importlib.resources.contents(package)

返回一个用于遍历包内各命名项的可迭代对象。该可迭代对象将返回 str 资源（如文件）及非资源（如目录）。该迭代器不会递归进入子目录。

package 是包名或符合 Package 要求的模块对象。

importlib.machinery —— 导入器和路径钩子函数。

源代码： Lib/importlib/machinery.py [https://github.com/python/cpython/tree/3.10/Lib/importlib/machinery.py]

本模块包含多个对象，以帮助 import 查找并加载模块。

importlib.machinery.SOURCE_SUFFIXES

一个字符串列表，表示源模块的可识别的文件后缀。

3.3 新版功能.

importlib.machinery.DEBUG_BYTECODE_SUFFIXES

一个字符串列表，表示未经优化字节码模块的文件后缀。

3.3 新版功能.

3.5 版后已移除: 改用 BYTECODE_SUFFIXES 。

importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

一个字符串列表，表示已优化字节码模块的文件后缀。

3.3 新版功能.

3.5 版后已移除: 改用 BYTECODE_SUFFIXES 。

importlib.machinery.BYTECODE_SUFFIXES

一个字符串列表，表示字节码模块的可识别的文件后缀（包含前导的句点符号）。

3.3 新版功能.

在 3.5 版更改: 该值不再依赖于 __debug__ 。

importlib.machinery.EXTENSION_SUFFIXES

一个字符串列表，表示扩展模块的可识别的文件后缀。

3.3 新版功能.

importlib.machinery.all_suffixes()

返回字符串的组合列表，代表标准导入机制可识别模块的所有文件后缀。这是个助手函数，只需知道某个文件系统路径是否会指向模块，而不需要任何关于模块种类的细节（例如 inspect.getmodulename()）。

3.3 新版功能.

class importlib.machinery.BuiltinImporter

用于导入内置模块的 importer。 所有已知的内置模块都已列入 sys.builtin_module_names。 此类实现了 importlib.abc.MetaPathFinder 和 importlib.abc.InspectLoader 抽象基类。

此类只定义类的方法，以减轻实例化的开销。

在 3.5 版更改: 作为 PEP 489 [https://www.python.org/dev/peps/pep-0489] 的一部分，现在内置模块导入器实现了 Loader.create_module() 和 Loader.exec_module()。

class importlib.machinery.FrozenImporter

用于已冻结模块的 importer。 此类实现了 importlib.abc.MetaPathFinder 和 importlib.abc.InspectLoader 抽象基类。

此类只定义类的方法，以减轻实例化的开销。

在 3.4 版更改: 有了 create_module() 和 exec_module() 方法。

class importlib.machinery.WindowsRegistryFinder

Finder 用于查找在 Windows 注册表中声明的模块。该类实现了基础的 importlib.abc.MetaPathFinder 。

此类只定义类的方法，以减轻实例化的开销。

3.3 新版功能.

3.6 版后已移除: 改用 site 配置。未来版本的 Python 可能不会默认启用该查找器。

class importlib.machinery.PathFinder

用于 sys.path 和包的 __path__ 属性的 Finder 。该类实现了基础的 importlib.abc.MetaPathFinder。

此类只定义类的方法，以减轻实例化的开销。

classmethod find_spec(fullname, path=None, target=None)

类方法试图在 sys.path 或 path 上为 fullname 指定的模块查找 spec。对于每个路径条目，都会查看 sys.path_importer_cache 。如果找到非 False 的对象，则将其用作 path entry finder 来查找要搜索的模块。如果在 sys.path_importer_cache 中没有找到条目，那会在 sys.path_hooks 检索该路径条目的查找器，找到了则和查到的模块信息一起存入 sys.path_importer_cache 。如果查找器没有找到，则缓存中的查找器和模块信息都存为 None ，然后返回。

3.4 新版功能.

在 3.5 版更改: 如果当前工作目录不再有效（用空字符串表示），则返回 None，但在 sys.path_importer_cache 中不会有缓存值。

classmethod find_module(fullname, path=None)

一个过时的 find_spec() 封装对象。

3.4 版后已移除: 使用 find_spec() 代替。

classmethod invalidate_caches()

为所有存于 sys.path_importer_cache 中的查找器，调用其 importlib.abc.PathEntryFinder.invalidate_caches() 方法。 sys.path_importer_cache 中为 None 的条目将被删除。

在 3.7 版更改: sys.path_importer_cache 中为 None 的条目将被删除。

在 3.4 版更改: 调用 sys.path_hooks 中的对象，当前工作目录为 '' (即空字符串)。

class importlib.machinery.FileFinder(path, *loader_details)

importlib.abc.PathEntryFinder 的一个具体实现，它会缓存来自文件系统的结果。

参数 path 是查找器负责搜索的目录。

loader_details 参数是数量不定的二元组，每个元组包含加载器及其可识别的文件后缀列表。加载器应为可调用对象，可接受两个参数，即模块的名称和已找到文件的路径。

查找器将按需对目录内容进行缓存，通过对每个模块的检索进行状态统计，验证缓存是否过期。因为缓存的滞后性依赖于操作系统文件系统状态信息的粒度，所以搜索模块、新建文件、然后搜索新文件代表的模块，这会存在竞争状态。如果这些操作的频率太快，甚至小于状态统计的粒度，那么模块搜索将会失败。为了防止这种情况发生，在动态创建模块时，请确保调用 importlib.invalidate_caches()。

3.3 新版功能.

path

查找器将要搜索的路径。

find_spec(fullname, target=None)

尝试在 path 中找到处理 fullname 的规格。

3.4 新版功能.

find_loader(fullname)

试图在 path 内找到处理 fullname 的加载器。

3.10 版后已移除: 使用 find_spec() 代替。

invalidate_caches()

清理内部缓存。

classmethod path_hook(*loader_details)

一个类方法，返回供 sys.path_hooks 使用的闭包。根据直接给出的路径参数和间接给出的 loader_details，闭包会返回一个 FileFinder 的实例。

如果给闭包的参数不是已存在的目录，将会触发 ImportError。

class importlib.machinery.SourceFileLoader(fullname, path)

importlib.abc.SourceLoader 的一个具体实现，该实现子类化了 importlib.abc.FileLoader 并提供了其他一些方法的具体实现。

3.3 新版功能.

name

该加载器将要处理的模块名称。

path

源文件的路径

is_package(fullname)

如果 path 看似包的路径，则返回 True。

path_stats(path)

importlib.abc.SourceLoader.path_stats() 的具体代码实现。

set_data(path, data)

importlib.abc.SourceLoader.set_data() 的具体代码实现。

load_module(name=None)

importlib.abc.Loader.load_module() 的具体代码实现，这里要加载的模块名是可选的。

3.6 版后已移除: 改用 importlib.abc.Loader.exec_module() 。

class importlib.machinery.SourcelessFileLoader(fullname, path)

importlib.abc.FileLoader 的具体代码实现，可导入字节码文件（也即源代码文件不存在）。

请注意，直接用字节码文件（而不是源代码文件），会让模块无法应用于所有的 Python 版本或字节码格式有所改动的新版本 Python。

3.3 新版功能.

name

加载器将要处理的模块名。

path

二进制码文件的路径。

is_package(fullname)

根据 path 确定该模块是否为包。

get_code(fullname)

返回由 path 创建的 name 的代码对象。

get_source(fullname)

因为用此加载器时字节码文件没有源码文件，所以返回 None。

load_module(name=None)

importlib.abc.Loader.load_module() 的具体代码实现，这里要加载的模块名是可选的。

3.6 版后已移除: 改用 importlib.abc.Loader.exec_module() 。

class importlib.machinery.ExtensionFileLoader(fullname, path)

importlib.abc.ExecutionLoader 的具体代码实现，用于扩展模块。

参数 fullname 指定了加载器要支持的模块名。参数 path 是指向扩展模块文件的路径。

3.3 新版功能.

name

装载器支持的模块名。

path

扩展模块的路径。

create_module(spec)

根据 PEP 489 [https://www.python.org/dev/peps/pep-0489] ，由给定规范创建模块对象。

3.5 新版功能.

exec_module(module)

根据 PEP 489 [https://www.python.org/dev/peps/pep-0489]，初始化给定的模块对象。

3.5 新版功能.

is_package(fullname)

根据 EXTENSION_SUFFIXES ，如果文件路径指向某个包的 __init__ 模块，则返回 True。

get_code(fullname)

返回 None，因为扩展模块缺少代码对象。

get_source(fullname)

返回 None，因为扩展模块没有源代码。

get_filename(fullname)

返回 path。

3.4 新版功能.

class importlib.machinery.ModuleSpec(name, loader, *, origin=None, loader_state=None, is_package=None)

关于模块导入系统相关状态的规范。通常这是作为模块的 __spec__ 属性暴露出来。 在以下描述中，括号里的名字给出了模块对象中直接可用的属性。比如 module.__spec__.origin == module.__file__。 但是请注意，虽然 值 通常是相等的，但它们可以不同，因为两个对象之间没有进行同步。因此 __path__ 有可能在运行时做过更新，而这不会自动反映在 __spec__.submodule_search_locations 中。

3.4 新版功能.

name

（__name__）

A string for the fully qualified name of the module.

loader

（__loader__）

模块加载时应采用的 Loader 。 Finders 应确保设置本属性。

origin

（__file__）

装载模块所在位置的名称，如内置模块为 “buildin”，从源代码加载的模块为文件名。通常应设置 “origin” ，但它可能为 None (默认值)，表示未指定 (如命名空间包)。

submodule_search_locations

（__path__）

如果是包（否则为 ），子模块所在位置的字符串列表（否则为 None）。

loader_state

依模块不同的额外数据的容器，以供加载过程中使用（或 None）。

cached

（__cached__）

字符串，表示经过编译的模块所在位置（或 None）。

parent

（__package__）

(Read-only) The fully qualified name of the package under which the module should be loaded as a submodule (or the empty string for top-level modules). For packages, it is the same as __name__.

has_location

布尔值，表示模块的“origin”属性是否指向可加载的位置。

importlib.util —— 导入器的工具程序代码

源代码： Lib/importlib/util.py [https://github.com/python/cpython/tree/3.10/Lib/importlib/util.py]

本模块包含了帮助构建 importer 的多个对象。

importlib.util.MAGIC_NUMBER

代表字节码版本号的字节串。若要有助于加载/写入字节码，可考虑采用 importlib.abc.SourceLoader。

3.4 新版功能.

importlib.util.cache_from_source(path, debug_override=None, *, optimization=None)

返回 PEP 3147 [https://www.python.org/dev/peps/pep-3147]/PEP 488 [https://www.python.org/dev/peps/pep-0488] 定义的，与源 path 相关联的已编译字节码文件的路径。 例如，如果 path 为 /foo/bar/baz.py 则 Python 3.2 中的返回值将是 /foo/bar/__pycache__/baz.cpython-32.pyc。 字符串 cpython-32 来自于当前的魔法标签 (参见 get_tag(); 如果 sys.implementation.cache_tag 未定义则将会引发 NotImplementedError)。

参数 optimization 用于指定字节码文件的优化级别。空字符串代表没有优化，所以 optimization 为 的 /foo/bar/baz.py，将会得到字节码路径为 /foo/bar/__pycache__/baz.cpython-32.pyc。None 会导致采用解释器的优化。任何其他字符串都会被采用，所以 optimization 为 '' 的 /foo/bar/baz.py 会导致字节码路径为 /foo/bar/__pycache__/baz.cpython-32.opt-2.pyc。optimization 字符串只能是字母数字，否则会触发 ValueError。

debug_override 参数已废弃，可用于覆盖系统的 __debug__ 值。True 值相当于将 optimization 设为空字符串。False 则相当于*optimization* 设为 1。如果 debug_override 和 optimization 都不为 None，则会触发 TypeError。

3.4 新版功能.

在 3.5 版更改: 增加了 optimization 参数，废弃了 debug_override 参数。

在 3.6 版更改: 接受一个 path-like object。

importlib.util.source_from_cache(path)

根据指向一个 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 文件名的 path，返回相关联的源代码文件路径。 举例来说，如果 path 为 /foo/bar/__pycache__/baz.cpython-32.pyc 则返回的路径将是 /foo/bar/baz.py。 path 不需要已存在，但如果它未遵循 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 或 PEP 488 [https://www.python.org/dev/peps/pep-0488] 的格式，则会引发 ValueError。 如果未定义 sys.implementation.cache_tag，则会引发 NotImplementedError。

3.4 新版功能.

在 3.6 版更改: 接受一个 path-like object。

importlib.util.decode_source(source_bytes)

对代表源代码的字节串进行解码，并将其作为带有通用换行符的字符串返回（符合 importlib.abc.InspectLoader.get_source() 要求）。

3.4 新版功能.

importlib.util.resolve_name(name, package)

将模块的相对名称解析为绝对名称。

如果 name 前面没有句点，那就简单地返回 name。这样就能采用 importlib.util.resolve_name('sys', __spec__.parent) 之类的写法，而无需检查是否需要 package 参数。

如果 name 是相对模块名称，但 package 为 False 值（如 None 或空字符串），则会触发 ImportError。 如果相对名称会离开所在的包（如从 spam 包中请求 ..bacon），则还会触发 ImportError。

3.3 新版功能.

在 3.9 版更改: 为了改善与 import 语句的一致性，对于无效的相对导入尝试会引发 ImportError 而不是 ValueError。

importlib.util.find_spec(name, package=None)

查找模块的 spec，相对指定的 package 名为可选参数。如果该模块位于 sys.modules 中，则会返回 sys.modules[name].__spec__ （除非 spec为 None 或未作设置，这时会触发 ValueError)。否则将用 sys.meta_path 进行搜索。若找不到则返回 None。

如果 name 为一个子模块（带有一个句点），则会自动导入父级模块。

name 和 package 的用法与 import_module() 相同。

3.4 新版功能.

在 3.7 版更改: 如果 package 实际上不是一个包（即缺少 __path__ 属性）则会引发 ModuleNotFoundError 而不是 AttributeError。

importlib.util.module_from_spec(spec)

基于 spec 和 spec.loader.create_module 创建一个新模块。

如果 spec.loader.create_module 未返回 None，那么先前已存在的属性不会被重置。另外，如果 AttributeError 是在访问 spec 或设置模块属性时触发的，则不会触发 。

本函数比 types.ModuleType 创建新模块要好，因为用到 spec 模块设置了尽可能多的导入控制属性。

3.5 新版功能.

@importlib.util.module_for_loader

importlib.abc.Loader.load_module() 的一个 decorator，用来选取合适的模块对象以供加载。被装饰方法的签名应带有两个位置参数（如：load_module(self, module)），其中第二个参数将是加载器用到的模块 对象。请注意，由于假定有两个参数，所以装饰器对静态方法不起作用。

装饰的方法将接受要加载的模块的 name，正如 loader 一样。如果在 sys.modules 中没有找到该模块，那么将构造一个新模块。不管模块来自哪里， __loader__ 设置为 self ，并且 __package__ 是根据 importlib.abc.InspectLoader.is_package() 的返回值设置的。这些属性会无条件进行设置以便支持再次加载。

如果被装饰的方法触发异常，并且已有模块加入 sys.modules 中，那么该模块将被移除，以防 sys.modules 中残留一个部分初始化的模块。如果该模块原先已在 sys.modules 中，则会保留不变。

在 3.3 版更改: 有可能时自动设置 __loader__ 和 __package__ 。

在 3.4 版更改: 无条件设置 __name__ 、 __loader__ 、 __package__ 以支持再次加载。

3.4 版后已移除: 现在，导入机制直接执行本函数提供的所有功能。

@importlib.util.set_loader

一个 decorator，用于 importlib.abc.Loader.load_module() 在返回的模块上设置 __loader__ 属性。如果该属性已被设置，装饰器就什么都不做。这里假定被封装方法的第一个位置参数（即 self）就是 __loader__ 要设置的。

在 3.4 版更改: 如果设为 None ，则会去设置 __loader__ ，就像该属性不存在一样。

3.4 版后已移除: 导入机制会自动进行处理。

@importlib.util.set_package

一个用于 importlib.abc.Loader.load_module() 的 decorator ，以便设置返回模块的 __package__ 属性。如果 __package__ 已设置且不为 None，则不会做改动。

3.4 版后已移除: 导入机制会自动进行处理。

importlib.util.spec_from_loader(name, loader, *, origin=None, is_package=None)

一个工厂函数，用于创建基于加载器的 ModuleSpec 实例。参数的含义与 ModuleSpec 的相同。该函数会利用当前可用的 loader API，比如 InspectLoader.is_package()，以填充所有缺失的规格信息。

3.4 新版功能.

importlib.util.spec_from_file_location(name, location, *, loader=None, submodule_search_locations=None)

一个工厂函数，根据文件路径创建 ModuleSpec 实例。缺失的信息将根据 spec 进行填补，利用加载器 API ，以及模块基于文件的隐含条件。

3.4 新版功能.

在 3.6 版更改: 接受一个 path-like object。

importlib.util.source_hash(source_bytes)

以字节串的形式返回 source_bytes 的哈希值。基于哈希值的 .pyc 文件在头部嵌入了对应源文件内容的 source_hash()。

3.7 新版功能.

class importlib.util.LazyLoader(loader)

此类会延迟执行模块加载器，直至该模块有一个属性被访问到。

此类 只 适用于定义了 exec_module() 的加载器，因为需要控制模块的类型。 同理，加载器的 create_module() 方法必须返回 None 或 __class__ 属性可被改变且不用 slots 的类型。 最后，用于替换 sys.modules 内容的模块将无法工作，因为无法在整个解释器中安全地替换模块的引用；如果检测到这种替换，将触发 ValueError。

注解

如果项目对启动时间要求很高，只要模块未被用过，此类能够最小化加载模块的开销。对于启动时间并不重要的项目来说，由于加载过程中产生的错误信息会被暂时搁置，因此强烈不建议使用此类。

3.5 新版功能.

在 3.6 版更改: 开始调用 create_module()，移除 importlib.machinery.BuiltinImporter 和 importlib.machinery.ExtensionFileLoader 的兼容性警告。

classmethod factory(loader)

一个返回创建延迟加载器的可调用对象的类方法。 这专门被用于加载器由类而不是实例来传入的场合。

suffixes = importlib.machinery.SOURCE_SUFFIXES
loader = importlib.machinery.SourceFileLoader
lazy_loader = importlib.util.LazyLoader.factory(loader)
finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))

例子

用编程方式导入

要以编程方式导入一个模块，请使用 importlib.import_module() ：

import importlib

itertools = importlib.import_module('itertools')

检查某模块可否导入。

如果你需要在不实际执行导入的情况下确定某个模块是否可被导入，则你应当使用 importlib.util.find_spec()。

请注意如果 name 是一个子模块（即包含一个点号），则 importlib.util.find_spec() 将会导入父模块。

import importlib.util
import sys

# For illustrative purposes.
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:
    # If you chose to perform the actual import ...
    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")

直接导入源码文件。

若要直接导入 Python 源码文件，请使用一下方案（仅 Python 3.5 以上版本有效）：

import importlib.util
import sys

# For illustrative purposes.
import tokenize
file_path = tokenize.__file__
module_name = tokenize.__name__

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)

实现延迟导入

以下例子展示了如何实现延迟导入：

>>> 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 is a real module object,
>>> #but it is not loaded in memory yet.
>>> lazy_typing.TYPE_CHECKING
False

导入器的配置

对于深度定制的导入，通常需要实现一个 importer。 这意味着得同时管理 finder 和 loader。 根据不同的需求，有两种类型的查找器可供选择： meta path finder 或 path entry finder。 前者应位于 sys.meta_path 之上，而后者是用 path entry hook 在 sys.path_hooks 上创建但与 sys.path 一起工作，可能会创建一个查找器。以下例子将演示如何注册自己的导入器，以供导入使用（关于自建导入器请阅读本包内定义的类文档）：

import importlib.machinery
import sys

# For illustrative purposes only.
SpamMetaPathFinder = importlib.machinery.PathFinder
SpamPathEntryFinder = importlib.machinery.FileFinder
loader_details = (importlib.machinery.SourceFileLoader,
                  importlib.machinery.SOURCE_SUFFIXES)

# Setting up a meta path finder.
# Make sure to put the finder in the proper location in the list in terms of
# priority.
sys.meta_path.append(SpamMetaPathFinder)

# Setting up a path entry finder.
# Make sure to put the path hook in the proper location in the list in terms
# of priority.
sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))

importlib.import_module() 的近似实现

导入过程本身是用 Python 代码实现的，这样就能通过 importlib 将大多数导入机制暴露出来。以下代码近似实现了 importlib.import_module() ，以帮助说明 importlib 暴露出来的各种 API （importlib 的用法适用于 Python 3.4 以上版本 ，其他代码适用于 Python 3.6 以上版本）。

import importlib.util
import sys

def import_module(name, package=None):
    """An approximate implementation of import."""
    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

使用 importlib.metadata

3.8 新版功能.

在 3.10 版更改: importlib.metadata 不再是暂定的。

源代码: Lib/importlib/metadata/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/importlib/metadata/__init__.py]

importlib.metadata 是一个提供对已安装包的元数据访问的库。这个库部分建立在 Python 的导入系统上，旨在取代 pkg_resources 的 entry point API [https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points] 和 metadata API [https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api] 中的类似功能。 通过和 Python 3.7 或更高版本中的 importlib.resources 一同使用（对于旧版本的 Python 则作为 importlib_resources [https://importlib-resources.readthedocs.io/en/latest/index.html] 向后移植），这可以消除对使用较旧且较为低效的 pkg_resources 包的需要。

此处所说的 “已安装的包” 通常指通过 pip [https://pypi.org/project/pip/] 等工具安装在 Python site-packages 目录下的第三方包。具体来说，它指的是一个具有可发现的 dist-info 或 egg-info 目录以及 PEP 566 [https://www.python.org/dev/peps/pep-0566] 或其更早的规范所定义的元数据的包。默认情况下，包的元数据可以存在于文件系统中或 sys.path 上的压缩文件中。 通过扩展机制，元数据几乎可以存在于任何地方。

概述

假设你想得到你用 pip 安装的一个包的版本字符串。我们在创建的虚拟环境中安装一些东西：

$ python -m venv example
$ source example/bin/activate
(example) $ pip install wheel

你可以通过运行以下代码得到 wheel 的版本字符串：

(example) $ python
>>> from importlib.metadata import version
>>> version('wheel')
'0.32.3'

你也可以获得以组名为关键字的入口点集合，比如 console_scripts 和 distutils.commands 。每个组包含一个 入口点 对象的序列。

你可以获得 分发的元数据：

>>> 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']

你也可以获得 分发包的版本号，列出它的 构成文件，并且得到分发包的 分发包的依赖 列表。

函数式 API

这个包的公开 API 提供了以下功能。

入口点

entry_points() 函数返回入口点的字典。入口点表现为 EntryPoint 的实例；每个 EntryPoint 对象都有 .name ，.group 与 .value 属性，用于解析值的 .load() 方法， 来自 .value 属性的对应部分的 .module, .attr 与 .extras 属性。

查询所有的入口点：

>>> eps = entry_points()

entry_points() 函数返回值中的 EntryPoints 对象是一个含有``EntryPoint`` 对象的序列，且具有方便的 names 与 groups 属性：

>>> sorted(eps.groups)
['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']

EntryPoints 的 select 方法用于选择匹配特性的入口点。要选择 console_scripts 组中的入口点：

>>> scripts = eps.select(group='console_scripts')

你也可以向 entry_points 传递关键字参数 "group" 以实现相同的效果:

>>> scripts = entry_points(group='console_scripts')

选出命名为 “wheel” 的特定脚本（可以在 wheel 项目中找到）：

>>> 'wheel' in scripts.names
True
>>> wheel = scripts['wheel']

等价地，在选择过程中查询对应的入口点：

>>> (wheel,) = entry_points(group='console_scripts', name='wheel')
>>> (wheel,) = entry_points().select(group='console_scripts', name='wheel')

检查解析得到的入口点：

>>> 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>

group 和 name 是由包作者定义的任意值并且通常来说客户端会想要解析特定 group 的所有入口点。 请参阅 the setuptools docs [https://setuptools.pypa.io/en/latest/userguide/entry_point.html] 了解有关入口点，其定义和用法的更多信息。

兼容性说明

“可选择” 的入口点在 importlib_metadata 3.6，Python 3.10 中被引入。在此之前， entry_points 没有形参且总是返回一个以分组为键，以入口点为值的字典。为了兼容性，如果不带参数地调用 entry_points， 则会返回一个实现了字典接口的 SelectableGroups 对象。未来，不带参数调用 entry_points 会返回 EntryPoints 对象。用户只应该依靠选择接口来按组获得入口点。

分发的元数据

每个分发都包含某些元数据，你可以通过 metadata() 函数提取它们：

>>> wheel_metadata = metadata('wheel')

返回的数据结构 PackageMetadata 的键代表元数据的关键字，而值从分发的元数据中不被解析地返回：

>>> wheel_metadata['Requires-Python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

PackageMetadata 也提供了按照 PEP 566 [https://www.python.org/dev/peps/pep-0566] 将所有元数据以 JSON 兼容的方式返回的 json 属性：

>>> wheel_metadata.json['requires_python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

在 3.10 版更改: 当有效载荷中包含时，Description 以去除续行符的形式被包含于元数据中。

3.10 新版功能: 添加了 json 属性。

分发包的版本

version() 函数是以字符串形式获取分发的版本号的最快方式：

>>> version('wheel')
'0.32.3'

分发包的文件

你可以获得分发内包含的所有文件的集合。 files() 函数传入一个分发包的名字并返回所有这个分发安装的文件。每个返回的文件对象都是一个 pathlib.PurePath 的具有额外由元数据指定的 dist， size 和 hash 属性的子类 PackagePath 的实例。例如：

>>> 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>

当你获得了文件对象，你可以读取其内容：

>>> print(util.read_text())
import base64
import sys
...
def as_bytes(s):
    if isinstance(s, text_type):
        return s.encode('utf-8')
    return s

你也可以使用 locate 方法来获得文件的绝对路径：

>>> util.locate()
PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')

当列出包含文件的元数据文件（RECORD 或 SOURCES.txt）不存在时， files() 函数将返回 None 。调用者可能会想要将对 files() 的调用封装在 always_iterable [https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable] 中，或者用其他方法来应对目标分发元数据存在性未知的情况。

分发包的依赖

使用 requires() 函数来获得一个 分发 的所有依赖：

>>> requires('wheel')
["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]

包的分发

一个用来解析顶级 Python 包或者模块对应的分发的便捷方法（命名空间包可能会有多个分发）:

>>> packages_distributions()
{'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...}

3.10 新版功能.

分发包对象

以上的 API 是最常见而方便的用法，但是你也可以通过 Distribution 类获得以上所有信息。 Distribution 是一个代表 Python 包的元数据的抽象对象。你可以这样获取 Distribution 实例：

>>> from importlib.metadata import distribution
>>> dist = distribution('wheel')

因此，可以通过 Distribution 实例获得版本号：

>>> dist.version
'0.32.3'

Distribution 实例具有所有可用的附加元数据：

>>> dist.metadata['Requires-Python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
>>> dist.metadata['License']
'MIT'

此处并未描述全部可用的元数据集合。 请参见 PEP 566 [https://www.python.org/dev/peps/pep-0566] 以了解更多细节。

扩展搜索算法

包的元数据无法通过搜索 sys.path 或通过包加载器获得，而是通过导入系统的 查找器 找到的。 importlib.metadata 查询在 sys.meta_path 上的 元数据查找器 列表以获得分发包的元数据。

Python 默认的 PathFinder 包含一个调用 importlib.metadata.MetadataPathFinder 来查找从典型的文件系统路径加载发布的钩子。

抽象基类 importlib.abc.MetaPathFinder 定义了 Python 导入系统期望的查找器接口。 importlib.metadata 通过寻找 sys.meta_path 上查找器可选的 find_distributions 可调用的属性扩展这个协议，并将这个扩展接口作为 DistributionFinder 抽象基类提供，它定义了这个抽象方法：

@abc.abstractmethod
def find_distributions(context=DistributionFinder.Context()):
    """Return an iterable of all Distribution instances capable of
    loading the metadata for packages for the indicated ``context``.
    """

DistributionFinder.Context 对象提供了指示搜索路径和匹配名称的属性 .path 和 .name ，也可能提供其他相关的上下文。

这在实践中意味着要支持在文件系统外的其他位置查找分发包的元数据，你需要子类化 Distribution 并实现抽象方法，之后从一个自定义查找器的 find_distributions() 方法返回这个派生的 Distribution 实例。

Python 语言服务

Python 提供了许多模块来帮助使用 Python 语言。 这些模块支持标记化、解析、语法分析、字节码反汇编以及各种其他工具。

这些模块包括：

ast --- 抽象语法树

抽象文法

节点类

字面值

变量

表达式

抽取

推导式

语句

导入

控制流

模式匹配

函数与类定义

async 与 await

ast 中的辅助函数

编译器旗标

命令行用法

symtable ——访问编译器的符号表

符号表的生成

符号表的查看

token --- 与Python解析树一起使用的常量

keyword --- 检验Python关键字

tokenize --- 对 Python 代码使用的标记解析器

对输入进行解析标记

命令行用法

例子

tabnanny --- 模糊缩进检测

pyclbr --- Python 模块浏览器支持

Function 对象

Class 对象

py_compile --- 编译 Python 源文件

命令行接口

compileall --- 字节编译 Python 库

使用命令行

公有函数

dis --- Python 字节码反汇编器

字节码分析

分析函数

Python字节码说明

操作码集合

pickletools --- pickle 开发者工具集

命令行语法

命令行选项

编程接口

ast --- 抽象语法树

源代码： Lib/ast.py [https://github.com/python/cpython/tree/3.10/Lib/ast.py]

ast 模块帮助 Python 程序处理 Python 语法的抽象语法树。抽象语法或许会随着 Python 的更新版发行而改变；该模块能够帮助理解当前语法在编程层面的样貌。

抽象语法树可通过将 ast.PyCF_ONLY_AST 作为旗标传递给 compile() 内置函数来生成，或是使用此模块中提供的 parse() 辅助函数。返回结果将是一个由许多对象构成的树，这些对象所属的类都继承自 ast.AST。抽象语法树可被内置的 compile() 函数编译为一个 Python 代码对象。

抽象文法

抽象文法目前定义如下

-- 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)
          | AsyncFunctionDef(identifier name, arguments args,
                             stmt* body, expr* decorator_list, expr? returns,
                             string? type_comment)

          | ClassDef(identifier name,
             expr* bases,
             keyword* keywords,
             stmt* body,
             expr* decorator_list)
          | Return(expr? value)

          | Delete(expr* targets)
          | Assign(expr* targets, expr value, string? type_comment)
          | 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)
          | 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)
         | JoinedStr(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)
}

节点类

class ast.AST

这是所有 AST 节点类的基类。实际上，这些节点类来源于 Parser/Python.asdl 文件，文件内容已被完整展示 如上。它们在 C 模块 _ast 中定义，并在这个 ast 模块中被“再导出”给用户。

抽象文法中的每个等号左边的符号（比方说， ast.stmt 或者 ast.expr）定义了一个类。另外，在等号右边，对每一个构造器也定义了一个类；这些类继承自等号左边的类。比如，ast.BinOp 继承自 ast.expr。对于多分支产生式（也就是含有“ | ”的产生式），左边的类是抽象的；只有具体构造器类的实例能够被 compile 函数构造。

_fields

每个具体类都有属性 _fields，用来给出所有子节点的名字。

每个具体类的实例为自己的每个子节点都准备了一个属性来引用该子节点，属性的类型就是文法中所定义的。比如，ast.BinOp 的实例有个属性 left，类型是 ast.expr。

如果这些属性在文法中标记为可选（用问号标记），对应值可能会是 None。如果这些属性可有零或多个值（用星号标记），对应值会用Python的列表来表示。在用 compile() 将AST编译为可执行代码时，所有的属性必须已经被赋值为有效的值。

lineno

col_offset

end_lineno

end_col_offset

ast.expr 和 ast.stmt 的子类的实例的属性包括 lineno、col_offset、end_lineno 和 end_col_offset。lineno 和 end_lineno 是源码中属于该节点的部分从哪一行开始，到哪一行结束（数字 1 指第一行，以此类推）；col_offset 和 end_col_offset 是第一个和最后一个属于该节点的 token 的 UTF-8 字节偏移量。记录 UTF-8 偏移量的原因是解析器内部使用 UTF-8。

注意编译器不需要结束位置，所以结束位置是可选的。结束偏移在最后一个符号 之后 ，例如你可以通过 source_line[node.col_offset : node.end_col_offset] 获得一个单行表达式节点的源码片段。

ast.T 类的构造器像下面这样解析它的参数：

如果只用位置参数，参数的数量必须和 T._fields 中的项一样多；它们会按顺序赋值到这些属性上。

如果有关键字参数，它们会为与其关键字同名的属性赋值。

比方说，要创建和填充节点 ast.UnaryOp，你得用

node = ast.UnaryOp()
node.op = ast.USub()
node.operand = ast.Constant()
node.operand.value = 5
node.operand.lineno = 0
node.operand.col_offset = 0
node.lineno = 0
node.col_offset = 0

或者更紧凑点

node = ast.UnaryOp(ast.USub(), ast.Constant(5, lineno=0, col_offset=0),
                   lineno=0, col_offset=0)

在 3.8 版更改: ast.Constant 类现在用于所有常量。

在 3.9 版更改: 简单索引由它们的值表示，扩展切片表示为元组。

3.8 版后已移除: 旧的类 ast.Num、ast.Str、 ast.Bytes、ast.NameConstant 和 ast.Ellipsis 仍然有效，但是它们会在未来的 Python 版本中被移除。同时，实例化它们会返回一个不同类的实例。

3.9 版后已移除: 旧的类 ast.Index 和 ast.ExtSlice 仍然有效，但是它们会在未来的 Python 版本中被移除。同时，实例化它们会返回一个不同类的实例。

注解

在此显示的特定节点类的描述最初是改编自杰出的 Green Tree Snakes [https://greentreesnakes.readthedocs.io/en/latest/] 项目及其所有贡献者。

字面值

class ast.Constant(value)

一个常量。 Constant 字面值的 value 属性即为其代表的 Python 对象。它可以代表简单的数字，字符串或者 None 对象，但是也可以代表所有元素都是常量的不可变容器（例如元组或冻结集合）。

>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))

class ast.FormattedValue(value, conversion, format_spec)

节点是以一个 f-字符串形式的格式化字段来代表的。 如果该字符串只包含单个格式化字段而没有任何其他内容则节点可以被隔离，否则它将在 JoinedStr 中出现。

value 为任意的表达式节点（如一个字面值、变量或函数调用）。

conversion 是一个整数:

-1: 无格式化

115: !s 字符串格式化

114: !r repr 格式化

97: !a ascii 格式化

format_spec 是一个代表值的格式化的 JoinedStr 节点，或者如果未指定格式则为 None。 conversion 和 format_spec 可以被同时设置。

class ast.JoinedStr(values)

一个 f-字符串，由一系列 FormattedValue 和 Constant 节点组成。

>>> 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())],
                    keywords=[]),
                conversion=-1,
                format_spec=JoinedStr(
                    values=[
                        Constant(value='.3')]))]))

class ast.List(elts, ctx)

class ast.Tuple(elts, ctx)

一个列表或元组。 elts 保存一个代表元素的节点的列表。 ctx 在容器为赋值的目标时 (如 (x,y)=something) 是 Store，否则是 Load。

>>> 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()))

class ast.Set(elts)

一个集合。 elts 保存一个代表集合的元组的节点的列表。

>>> 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)]))

class ast.Dict(keys, values)

一个字典。 keys 和 values 保存分别代表键和值的节点的列表，按照匹配的顺序（即当调用 dictionary.keys() 和 dictionary.values() 时将返回的结果）。

当使用字典字面值进行字典解包操作时要扩展的表达式放入 values 列表，并将 None 放入 keys 的对应位置。

>>> 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())]))

变量

class ast.Name(id, ctx)

一个变量名。 id 将名称保存为字符串，而 ctx 为下列类型之一。

class ast.Load

class ast.Store

class ast.Del

变量引用可被用来载入一个变量的值，为其赋一个新值，或是将其删除。 变量引用会给出一个上下文来区分这几种情况。

>>> print(ast.dump(ast.parse('a'), indent=4))
Module(
    body=[
        Expr(
            value=Name(id='a', ctx=Load()))],
    type_ignores=[])

>>> print(ast.dump(ast.parse('a = 1'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='a', ctx=Store())],
            value=Constant(value=1))],
    type_ignores=[])

>>> print(ast.dump(ast.parse('del a'), indent=4))
Module(
    body=[
        Delete(
            targets=[
                Name(id='a', ctx=Del())])],
    type_ignores=[])

class ast.Starred(value, ctx)

一个 *var 变量引用。 value 保存变量，通常为一个 Name 节点。 此类型必须在构建 Call 节点并传入 *args 时被使用。

>>> 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()))],
    type_ignores=[])

表达式

class ast.Expr(value)

当一个表达式，例如函数调用，本身作为一个语句出现并且其返回值未被使用或存储时，它会被包装在此容器中。 value 保存本节中的其他节点之一，一个 Constant, Name, Lambda, Yield 或者 YieldFrom 节点。

>>> print(ast.dump(ast.parse('-a'), indent=4))
Module(
    body=[
        Expr(
            value=UnaryOp(
                op=USub(),
                operand=Name(id='a', ctx=Load())))],
    type_ignores=[])

class ast.UnaryOp(op, operand)

一个单目运算。 op 是运算符，而 operand 是任意表达式节点。

class ast.UAdd

class ast.USub

class ast.Not

class ast.Invert

单目运算符对应的形符。 Not 是 not 关键字，Invert 是 ~ 运算符。

>>> print(ast.dump(ast.parse('not x', mode='eval'), indent=4))
Expression(
    body=UnaryOp(
        op=Not(),
        operand=Name(id='x', ctx=Load())))

class ast.BinOp(left, op, right)

一个双目运算（如相加或相减）。 op 是运算符，而 left 和 right 是任意表达式节点。

>>> 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())))

class ast.Add

class ast.Sub

class ast.Mult

class ast.Div

class ast.FloorDiv

class ast.Mod

class ast.Pow

class ast.LShift

class ast.RShift

class ast.BitOr

class ast.BitXor

class ast.BitAnd

class ast.MatMult

双目运算符对应的形符。

class ast.BoolOp(op, values)

一个布尔运算，'or' 或者 'and'。 op 是 Or 或者 And。 values 是参与运算的值。 具有相同运算符的连续运算，如 a or b or c，会被折叠为具有多个值的单个节点。

这不包括 not，它属于 UnaryOp。

>>> 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())]))

class ast.And

class ast.Or

布尔运算符对应的形符。

class ast.Compare(left, ops, comparators)

两个或更多值之间的比较运算。 left 是参加比较的第一个值，ops 是由运算符组成的列表，而 comparators 是由参加比较的第一个元素之后的值组成的列表。

>>> 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)]))

class ast.Eq

class ast.NotEq

class ast.Lt

class ast.LtE

class ast.Gt

class ast.GtE

class ast.Is

class ast.IsNot

class ast.In

class ast.NotIn

比较运算符对应的形符。

class ast.Call(func, args, keywords, starargs, kwargs)

一个函数调用。 func 是函数，它通常是一个 Name 或 Attribute 对象。 对于其参数:

args 保存由按位置传入的参数组成的列表。

keywords 保存了一个代表以关键字传入的参数的 keyword 对象的列表。

当创建一个 Call 节点时，需要有 args 和 keywords，但它们可以为空列表。 starargs 和 kwargs 是可选的。

>>> 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()))]))

class ast.keyword(arg, value)

传给函数调用或类定义的关键字参数。 arg 是形参名称对应的原始字符串，value 是要传入的节点。

class ast.IfExp(test, body, orelse)

一个表达式例如 a if b else c。 每个字段保存一个单独节点，因而在下面的示例中，三个节点均为 Name 节点。

>>> 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())))

class ast.Attribute(value, attr, ctx)

属性访问，例如 d.keys。 value 是一个节点，通常为 Name。 attr 是一个给出属性名称的纯字符串，而 ctx 根据属性操作的方式可以为 Load, Store 或 Del。

>>> print(ast.dump(ast.parse('snake.colour', mode='eval'), indent=4))
Expression(
    body=Attribute(
        value=Name(id='snake', ctx=Load()),
        attr='colour',
        ctx=Load()))

class ast.NamedExpr(target, value)

一个带名称的表达式。 此 AST 节点是由赋值表达式运算符（或称海象运算符）产生的。 与第一个参数可以有多个节点的 Assign 节点不同，在此情况下 target 和 value 都必须为单独节点。

>>> print(ast.dump(ast.parse('(x := 4)', mode='eval'), indent=4))
Expression(
    body=NamedExpr(
        target=Name(id='x', ctx=Store()),
        value=Constant(value=4)))

抽取

class ast.Subscript(value, slice, ctx)

抽取操作，如 l[1]。 value 是被抽取的对象（通常为序列或映射）。 slice 是索引号、切片或键。 它可以是一个包含 Slice 的 Tuple。 ctx 根据抽取所执行的操作可以为 Load, Store 或 Del。

>>> 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()))

class ast.Slice(lower, upper, step)

常规切片 (形式如 lower:upper 或 lower:upper:step)。 只能在 Subscript 的 slice 字段内部出现，可以是直接切片对象或是作为 Tuple 的元素。

>>> 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()))

推导式

class ast.ListComp(elt, generators)

class ast.SetComp(elt, generators)

class ast.GeneratorExp(elt, generators)

class ast.DictComp(key, value, generators)

列表和集合推导式、生成器表达式以及字典推导式。 elt (或 key 和 value) 是一个代表将针对每个条目被求值的部分的单独节点。

generators 是一个由 comprehension 节点组成的列表。

>>> 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()),
                ifs=[],
                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()),
                ifs=[],
                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()),
                ifs=[],
                is_async=0)]))

class ast.comprehension(target, iter, ifs, is_async)

推导式中的一个 for 子句。 target 是针对每个元素使用的引用 —— 通常为一个 Name 或 Tuple 节点。 iter 是要执行迭代的对象。 ifs 是一个由测试表达式组成的列表：每个 for 子句都可以拥有多个 ifs。

is_async 表明推导式是异步的 (使用 async for 而不是 for)。 它的值是一个整数 (0 或 1)。

>>> print(ast.dump(ast.parse('[ord(c) for line in file for c in line]', mode='eval'),
...                indent=4)) # Multiple comprehensions in one.
Expression(
    body=ListComp(
        elt=Call(
            func=Name(id='ord', ctx=Load()),
            args=[
                Name(id='c', ctx=Load())],
            keywords=[]),
        generators=[
            comprehension(
                target=Name(id='line', ctx=Store()),
                iter=Name(id='file', ctx=Load()),
                ifs=[],
                is_async=0),
            comprehension(
                target=Name(id='c', ctx=Store()),
                iter=Name(id='line', ctx=Load()),
                ifs=[],
                is_async=0)]))

>>> print(ast.dump(ast.parse('(n**2 for n in it if n>5 if n<10)', mode='eval'),
...                indent=4)) # generator comprehension
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)) # Async comprehension
Expression(
    body=ListComp(
        elt=Name(id='i', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='i', ctx=Store()),
                iter=Name(id='soc', ctx=Load()),
                ifs=[],
                is_async=1)]))

语句

class ast.Assign(targets, value, type_comment)

一次赋值。 targets 是一个由节点组成的列表，而 value 是一个单独节点。

targets 中有多个节点表示将同一个值赋给多个目标。 解包操作是通过在 targets 中放入一个 Tuple 或 List 来表示的。

type_comment

type_comment 是带有以注释表示的类型标注的可选的字符串。

>>> print(ast.dump(ast.parse('a = b = 1'), indent=4)) # Multiple assignment
Module(
    body=[
        Assign(
            targets=[
                Name(id='a', ctx=Store()),
                Name(id='b', ctx=Store())],
            value=Constant(value=1))],
    type_ignores=[])

>>> print(ast.dump(ast.parse('a,b = c'), indent=4)) # Unpacking
Module(
    body=[
        Assign(
            targets=[
                Tuple(
                    elts=[
                        Name(id='a', ctx=Store()),
                        Name(id='b', ctx=Store())],
                    ctx=Store())],
            value=Name(id='c', ctx=Load()))],
    type_ignores=[])

class ast.AnnAssign(target, annotation, value, simple)

一次带有类型标注的赋值。 target 为单独节点并可以是 Name, Attribute 或 Subscript 之一。 annotation 为标注，例如一个 Constant 或 Name 节点。 value 为可选的单独节点。 simple 为一个布尔整数，其值对于 target 中不出现在括号之内因而是纯名称而非表达式的 Name 节点将为 True。

>>> 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)],
    type_ignores=[])

>>> print(ast.dump(ast.parse('(a): int = 1'), indent=4)) # Annotation with parenthesis
Module(
    body=[
        AnnAssign(
            target=Name(id='a', ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            value=Constant(value=1),
            simple=0)],
    type_ignores=[])

>>> print(ast.dump(ast.parse('a.b: int'), indent=4)) # Attribute annotation
Module(
    body=[
        AnnAssign(
            target=Attribute(
                value=Name(id='a', ctx=Load()),
                attr='b',
                ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=0)],
    type_ignores=[])

>>> print(ast.dump(ast.parse('a[1]: int'), indent=4)) # Subscript annotation
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)],
    type_ignores=[])

class ast.AugAssign(target, op, value)

增强赋值，如 a += 1。 在下面的例子中，target 是一个针对 x (带有 Store 上下文) 的 Name 节点，op 为 Add，而 value 是一个值为 1 的 Constant。

target 属性不可以是 Tuple 或 List 类，这与 Assign 的目标不同。

>>> print(ast.dump(ast.parse('x += 2'), indent=4))
Module(
    body=[
        AugAssign(
            target=Name(id='x', ctx=Store()),
            op=Add(),
            value=Constant(value=2))],
    type_ignores=[])

class ast.Raise(exc, cause)

一条 raise 语句。 exc 是要引发的异常，对于一个单独的 raise 通常为 Call 或 Name，或者为 None。 cause 是针对 raise x from y 中 y 的可选部分。

>>> 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()))],
    type_ignores=[])

class ast.Assert(test, msg)

一条断言。 test 保存条件，例如为一个 Compare 节点。 msg 保存失败消息。

>>> 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()))],
    type_ignores=[])

class ast.Delete(targets)

代表一条 del 语句。 targets 是一个由节点组成的列表，例如 Name, Attribute 或 Subscript 节点。

>>> 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())])],
    type_ignores=[])

class ast.Pass

一条 pass 语句。

>>> print(ast.dump(ast.parse('pass'), indent=4))
Module(
    body=[
        Pass()],
    type_ignores=[])

其他仅在函数或循环内部可用的语句将在其他小节中描述。

导入

class ast.Import(names)

一条导入语句。 names 是一个由 alias 节点组成的列表。

>>> print(ast.dump(ast.parse('import x,y,z'), indent=4))
Module(
    body=[
        Import(
            names=[
                alias(name='x'),
                alias(name='y'),
                alias(name='z')])],
    type_ignores=[])

class ast.ImportFrom(module, names, level)

代表 from x import y。 module 是一个 'from' 名称的原始字符串，不带任何前导点号，或者为 None 表示 from . import foo 这样的语句。 level 是一个保存相对导入层级的整数（0 表示绝对导入）。

>>> 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)],
    type_ignores=[])

class ast.alias(name, asname)

两个形参均为名称的原始字符串。 如果要使用常规名称则 asname 可以为 None。

>>> 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)],
    type_ignores=[])

控制流

注解

可选的子句如 else 如果不存在则会被存储为一个空列表。

class ast.If(test, body, orelse)

一条 if 语句。 test 保存一个单独节点，如一个 Compare 节点。 body 和 orelse 各自保存一个节点列表。

elif 子句在 AST 中没有特别的表示形式，而是作为上文介绍的 orelse 部分之内的一个额外 If 节点出现。

>>> 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))])])],
    type_ignores=[])

class ast.For(target, iter, body, orelse, type_comment)

一个 for 循环。 target 保存循环赋值的变量，是一个单独 Name, Tuple 或 List 节点。 iter 保存要被循环的条目，同样也是一个单独节点。 body 和 orelse 包含要执行的节点列表。 orelse 中的会在循环正常结束而不是通过 break 语句结束时被执行。

type_comment

type_comment 是带有以注释表示的类型标注的可选的字符串。

>>> 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))])],
    type_ignores=[])

class ast.While(test, body, orelse)

一个 while 循环。 test 保存条件，如一个 Compare 节点。

>> 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))])],
    type_ignores=[])

class ast.Break

class ast.Continue

break 和 continue 语句。

>>> 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()])],
            orelse=[])],
    type_ignores=[])

class ast.Try(body, handlers, orelse, finalbody)

try 代码块。 所有属性都是要执行的节点列表，除了 handlers，它是一个 ExceptHandler 节点列表。

>>> 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))])],
    type_ignores=[])

class ast.ExceptHandler(type, name, body)

一个单独的 except 子句。 type 是它将匹配的异常，通常为一个 Name 节点（或 None 表示捕获全部的 except: 子句）。 name 是一个用于存放异常的别名的原始字符串，或者如果子句没有 as foo 则为 None。 body 为一个节点列表。

>>> 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()])],
            orelse=[],
            finalbody=[])],
    type_ignores=[])

class ast.With(items, body, type_comment)

一个 with 代码块。 items 是一个代表上下文管理器的 withitem 节点列表，而 body 是该上下文中的缩进代码块。

type_comment

type_comment 是带有以注释表示的类型标注的可选的字符串。

class ast.withitem(context_expr, optional_vars)

一个 with 代码块中单独的上下文管理器。 context_expr 为上下文管理器，通常为一个 Call 节点。 optional_vars 为一个针对 as foo 部分的 Name, Tuple 或 List，或者如果未使用别名则为 None。

>>> 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())],
                        keywords=[]))])],
    type_ignores=[])

模式匹配

class ast.Match(subject, cases)

一条 match 语句。 subject 保存匹配的目标（与 cases 相匹配的对象）而 cases 包含一个由不同分支的 match_case 节点组成的可迭代对象。

class ast.match_case(pattern, guard, body)

一个 match 语句中单独的 case 模式。 pattern 包含目标将要去匹配的匹配模式。 请注意针对模式所产生的 AST 节点不同于针对表达式所产生的节点，即使它们共享相同的语法。

guard 属性包含一个当模式与目标相匹配时将被求值的表达式。

body 包含一个当模式匹配并且对 guard 表达式求值的结果为真时要执行的节点列表。

>>> 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()),
                        patterns=[],
                        kwd_attrs=[],
                        kwd_patterns=[]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])],
    type_ignores=[])

class ast.MatchValue(value)

一个按相等性进行比较的匹配字面值或值模式。 value 为一个表达式节点。 允许的值节点被限制为 match 语句文档中所描述的节点。 如果匹配目标等于 value 的求值结果则模式匹配成功。

>>> 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))])])],
    type_ignores=[])

class ast.MatchSingleton(value)

一个按标识号进行比较的匹配字面值模式。 value 为用于比较的单例对象: None, True 或 False。 如果匹配目标为给定的常量则该模式匹配成功。

>>> 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))])])],
    type_ignores=[])

class ast.MatchSequence(patterns)

一个匹配序列模式。 patterns 包含当目标为一个序列时要与目标元素进行匹配的模式。 如果某一子模式为 MatchStar 节点则将匹配一个变长度序列，否则将匹配一个固定长度序列。

>>> 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))])])],
    type_ignores=[])

class ast.MatchStar(name)

匹配一个可变长度匹配序列模式中的剩余部分序列。 如果 name 不为 None，则当整个序列模式匹配成功时将把一个包含剩余序列元素的列表绑定到该名称。

>>> 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))])])],
    type_ignores=[])

class ast.MatchMapping(keys, patterns, rest)

一个匹配的映射模式。 keys 为一个由表达式节点组成的序列。 patterns 为一个由对应的模式节点组成的序列。 rest 是一个可被指定用来捕获剩余映射元素的可选名称。 允许的关键字表达式被限制为与 match 语句文档中所描述的一致。

如果目标为一个映射、所有被求值的表达式都存在于该映射中，并且对应于每个键的值都与对应的子模式相匹配则此模式匹配成功。 如果 rest 不为 None，则当整个映射模式匹配成功时会将一个包含剩余映射元素的字典绑定到该名称。

>>> 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(keys=[], patterns=[], rest='rest'),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])],
    type_ignores=[])

class ast.MatchClass(cls, patterns, kwd_attrs, kwd_patterns)

一个 match 类模式。 cls 为一个给出要匹配的名义类的表达式。 patterns 为一个由要与该类所定义的模式匹配属性相匹配的模式节点组成的序列。 kwd_attrs 为一个由要匹配的附加属性（指定为该类模式中的关键字参数）组成的序列，kwd_patterns 为对应的模式（指定为该类模式中的关键字值）。

如果目标为被指名类的一个实例、所有的位置模式都与对应的类定义属性相匹配，并且任何被指定的关键字属性都与其对应的模式相匹配则此模式匹配成功。

注意：类可能会定义一个返回自身的特征属性以便能将一个模式节点与被匹配的实例相匹配。 某些内置类型也是以这种方式来匹配的，与 match 语句文档中所描述的一致。

>>> 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))],
                        kwd_attrs=[],
                        kwd_patterns=[]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='Point3D', ctx=Load()),
                        patterns=[],
                        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))])])],
    type_ignores=[])

class ast.MatchAs(pattern, name)

一个匹配 "as-模式"、捕获模式或通配符模式。 pattern 包含将要与目标相匹配的匹配模式。 如果模式为 None，则该节点代表一个捕获模式（即一个简单的名称）并将总是会成功。

name 属性包含当模式匹配成功时将要绑定的名称。 如果 name 为 None，则 pattern 也必须为 None 并且该节点代表的是通配符模式。

>>> 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))])])],
    type_ignores=[])

class ast.MatchOr(patterns)

一个匹配 "or-模式"。 or-模式会依次将其每个子模式与目标相匹配，直到有一个匹配成功。 此时该 or-模式将被视为匹配成功。 如果没有一个子模式匹配成功则该 or-模式匹配失败。 patterns 属性包含一个由将与目标相匹配的匹配模式节点组成的列表。

>>> 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))])])],
    type_ignores=[])

函数与类定义

class ast.FunctionDef(name, args, body, decorator_list, returns, type_comment)

一个函数定义。

name 是函数名称的原始字符串。

args 是一个 arguments 节点。

body 是函数内部的节点列表。

decorator_list 是要应用的装饰器列表，最外层的最先保存（即列表中的第一项将最后被应用）。

returns 是返回标注。

type_comment

type_comment 是带有以注释表示的类型标注的可选的字符串。

class ast.Lambda(args, body)

lambda 是可在表达式内部使用的最小化函数定义。 不同于 FunctionDef，body 是保存一个单独节点。

>>> print(ast.dump(ast.parse('lambda x,y: ...'), indent=4))
Module(
    body=[
        Expr(
            value=Lambda(
                args=arguments(
                    posonlyargs=[],
                    args=[
                        arg(arg='x'),
                        arg(arg='y')],
                    kwonlyargs=[],
                    kw_defaults=[],
                    defaults=[]),
                body=Constant(value=Ellipsis)))],
    type_ignores=[])

class ast.arguments(posonlyargs, args, vararg, kwonlyargs, kw_defaults, kwarg, defaults)

函数的参数。

posonlyargs, args 和 kwonlyargs 均为 arg 节点的列表。

vararg 和 kwarg 均为单独的 arg 节点，指向 *args, **kwargs 形参。

kw_defaults 是一个由仅限关键字参数默认值组成的列表。 如果有一个为 None，则对应的参数为必须的参数。

defaults 是一个由可按位置传入的参数的默认值组成的列表。 如果默认值个数少于参数个数，则它们将对应最后 n 个参数。

class ast.arg(arg, annotation, type_comment)

列表中的一个单独参数。 arg 为参数名称原始字符串，annotation 为其标注，如一个 Str 或 Name 节点。

type_comment

type_comment 是一个可选的将注释用作类型标注的字符串。

>>> 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(
                posonlyargs=[],
                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'))],
    type_ignores=[])

class ast.Return(value)

一条 return 语句。

>>> print(ast.dump(ast.parse('return 4'), indent=4))
Module(
    body=[
        Return(
            value=Constant(value=4))],
    type_ignores=[])

class ast.Yield(value)

class ast.YieldFrom(value)

一个 yield 或 yield from 表达式。 因为这些属于表达式，所以如果发回的值未被使用则必须将它们包装在 Expr 节点中。

>>> print(ast.dump(ast.parse('yield x'), indent=4))
Module(
    body=[
        Expr(
            value=Yield(
                value=Name(id='x', ctx=Load())))],
    type_ignores=[])

>>> print(ast.dump(ast.parse('yield from x'), indent=4))
Module(
    body=[
        Expr(
            value=YieldFrom(
                value=Name(id='x', ctx=Load())))],
    type_ignores=[])

class ast.Global(names)

class ast.Nonlocal(names)

global 和 nonlocal 语句。 names 为一个由原始字符串组成的列表。

>>> print(ast.dump(ast.parse('global x,y,z'), indent=4))
Module(
    body=[
        Global(
            names=[
                'x',
                'y',
                'z'])],
    type_ignores=[])

>>> print(ast.dump(ast.parse('nonlocal x,y,z'), indent=4))
Module(
    body=[
        Nonlocal(
            names=[
                'x',
                'y',
                'z'])],
    type_ignores=[])

class ast.ClassDef(name, bases, keywords, starargs, kwargs, body, decorator_list)

一个类定义。

name 为类名称的原始字符串。

bases 为一个由显式指明的基类节点组成的列表。

keywords 为一个由 keyword 节点组成的列表，主要用于‘元类’。 其他关键字将被传给这个元类，参见 PEP-3115 [https://www.python.org/dev/peps/pep-3115/]。

starargs 和 kwargs 各为一个单独的节点，与在函数调用中的一致。 starargs 将被展开加入到基类的列表中，而 kwargs 将被传给元类。

body 是一个由代表类定义内部代码的节点组成的列表。

decorator_list 是一个节点的列表，与 FunctionDef 中的一致。

>>> 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())])],
    type_ignores=[])

async 与 await

class ast.AsyncFunctionDef(name, args, body, decorator_list, returns, type_comment)

一个 async def 函数定义。 具有与 FunctionDef 相同的字段。

class ast.Await(value)

一个 await 表达式。 value 是它所等待的值。 仅在 AsyncFunctionDef 的函数体内可用。

>>> print(ast.dump(ast.parse("""\
... async def f():
...     await other_func()
... """), indent=4))
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_ignores=[])

class ast.AsyncFor(target, iter, body, orelse, type_comment)

class ast.AsyncWith(items, body, type_comment)

async for 循环和 async with 上下文管理器。 它们分别具有与 For 和 With 相同的字段。 仅在 AsyncFunctionDef 的函数体内可用。

注解

当一个字符串由 ast.parse() 来解析时，所返回的树中的运算符节点 (为 ast.operator, ast.unaryop, ast.cmpop, ast.boolop 和 ast.expr_context 的子类) 将均为单例对象。 对其中某一个 (例如 ast.Add) 的修改将反映到同一个值所出现的其他位置上。

ast 中的辅助函数

除了节点类， ast 模块里为遍历抽象语法树定义了这些工具函数和类:

ast.parse(source, filename='<unknown>', mode='exec', *, type_comments=False, feature_version=None)

把源码解析为AST节点。和 compile(source, filename, mode,ast.PyCF_ONLY_AST) 等价。

如果给出 type_comments=True，解析器会被修改以检查并返回 PEP 484 [https://www.python.org/dev/peps/pep-0484] 和 PEP 526 [https://www.python.org/dev/peps/pep-0526] 所描述的类型注释。 这相当于将 ast.PyCF_TYPE_COMMENTS 添加到传给 compile() 的旗标中。 这将报告针对未在正确放置类型注释的语法错误。 没有这个旗标，类型注释将被忽略，而指定 AST 节点上的 type_comment 字段将总是为 None。 此外，# type: ignore 注释的位置将作为 Module 的 type_ignores 属性被返回（在其他情况下则总是为空列表）。

并且，如果 mode 为 'func_type'，则输入语法会进行与 PEP 484 [https://www.python.org/dev/peps/pep-0484] "签名类型注释" 对应的修改，例如 (str, int) -> List[str]。

此外，将 feature_version 设为元组 (major, minor) 将会尝试使用该will attempt to parse using that Python 版本的语法来进行解析。 目前 major 必须等于 3。 例如，设置 feature_version=(3, 4) 将允许使用 async 和 await 作为变量名。 最低受支持版本为 (3, 4)；最高则为 sys.version_info[0:2]。

如果源包含一个空字符 ('0')，则会引发 ValueError。

警告

请注意成功将源代码解析为 AST 对象并不能保证该源代码提供了可被执行的有效 Python 代码，因为编译步骤还可能引发其他的 SyntaxError 异常。 例如，对于源代码 return 42 可以生成一条有效的 return 语句 AST 节点，但它不能被单独编译（它必须位于一个函数节点之内）。

特别地，ast.parse() 不会执行任何作用域检查，这是由编译步骤来做的。

警告

足够复杂或是巨大的字符串可能导致Python解释器的崩溃，因为Python的AST编译器是有栈深限制的。

在 3.8 版更改: 增加了 type_comments, mode='func_type' 和 feature_version。

ast.unparse(ast_obj)

反向解析一个 ast.AST 对象并生成一个包含当再次使用 ast.parse() 解析时将产生同样的 ast.AST 对象的代码的字符串。

警告

所产生的代码字符串将不一定与生成 ast.AST 对象的原始代码完全一致（不带任何编译器优化，例如常量元组/冻结集合等）。

警告

尝试反向解析一个高度复杂的表达式可能会导致 RecursionError。

3.9 新版功能.

ast.literal_eval(node_or_string)

对表达式节点或仅包含 Python 字面值或容器表示形式的字符串进行求值。 所提供的字符串或节点可能只包含下列 Python 字面值结构：字符串、字节串、数字、元组、字典、集合、布尔值、None 和 Ellipsis。

这可被用于对包含 Python 值的字符串进行求值而不必解析这些值本身。 它不能对任意的复杂表达式进行求值，例如涉及运算符或索引操作的表达式。

此函数过去曾被描述为“安全”但并未定义其含义。 这是存在误导性的。 此函数被专门设计为不执行 Python 代码，这与更通用的 eval() 不同。 它没有命名空间、没有名称查找或执行外部调用的能力。 但是它并不能完全避免攻击：一个相对较小的输入有可能导致内存耗尽或 C 栈耗尽，使得进程崩溃。 还可能在某些输入上出现过度消耗 CPU 的拒绝服务问题。 因此不建议在未被信任的数据上调用它。

警告

有可能由于 Python 的 AST 编译器中的栈深度限制而导致 Python 解释器的崩溃。

根据输入错误的具体形式它可能引发 ValueError, TypeError, SyntaxError, MemoryError 以及 RecursionError。

在 3.2 版更改: 目前支持字节和集合。

在 3.9 版更改: 现在支持通过 'set()' 创建空集合。

在 3.10 版更改: 对于字符串输入，打头的空格和制表符现在会被去除。

ast.get_docstring(node, clean=True)

返回给定 node (必须为 FunctionDef, AsyncFunctionDef, ClassDef 或 Module 节点) 的文档字符串，或者如果没有文档字符串则返回 None。 如果 clean 为真值，则通过 inspect.cleandoc() 清除文档字符串的缩进。

在 3.5 版更改: 目前支持 AsyncFunctionDef

ast.get_source_segment(source, node, *, padded=False)

获取生成 node 的 source 的源代码段。 如果丢失了某些位置信息 (lineno, end_lineno, col_offset 或 end_col_offset)，则返回 None。

如果 padded 为 True，则多行语句的第一行将以与其初始位置相匹配的空格填充。

3.8 新版功能.

ast.fix_missing_locations(node)

当你通过 compile() 来编译节点树时，编译器会准备接受每个支持 lineno 和 col_offset 属性的节点的相应信息。 对已生成节点来说这是相当繁琐的，因此这个辅助工具会递归地为尚未设置这些属性的节点添加它们，具体做法是将其设为父节点的对应值。 它将从 node 开始递归地执行。

ast.increment_lineno(node, n=1)

从 node 开始按 n 递增节点树中每个节点的行号和结束行号。 这在“移动代码”到文件中的不同位置时很有用处。

ast.copy_location(new_node, old_node)

在可能的情况下将源位置 (lineno, col_offset, end_lineno 和 end_col_offset) 从 old_node 拷贝到 new_node，并返回 new_node。

ast.iter_fields(node)

针对于 node 上在 node._fields 中出现的每个字段产生一个 (fieldname, value) 元组。

ast.iter_child_nodes(node)

产生 node 所有的直接子节点，也就是说，所有为节点的字段所有为节点列表的字段条目。

ast.walk(node)

递归地产生节点树中从 node 开始（包括 node 本身）的所有下级节点，没有确定的排序方式。 这在你仅想要原地修改节点而不关心具体上下文时很有用处。

class ast.NodeVisitor

一个遍历抽象语法树并针对所找到的每个节点调用访问器函数的节点访问器基类。 该函数可能会返回一个由 visit() 方法所提供的值。

这个类应当被子类化，并由子类来添加访问器方法。

visit(node)

访问一个节点。 默认实现会调用名为 self.visit_classname 的方法其中 classname 为节点类的名称，或者如果该方法不存在则为 generic_visit()。

generic_visit(node)

该访问器会在节点的所有子节点上调用 visit()。

请注意所有包含自定义访问器方法的节点的子节点将不会被访问除非访问器调用了 generic_visit() 或是自行访问它们。

如果你想在遍历期间应用对节点的修改则请不要使用 NodeVisitor。 对此目的可使用一个允许修改的特殊访问器 (NodeTransformer)。

3.8 版后已移除: visit_Num(), visit_Str(), visit_Bytes(), visit_NameConstant() 和 visit_Ellipsis() 等方法现在已被弃用且在未来的 Python 版本中将不会再被调用。 请添加 visit_Constant() 方法来处理所有常量节点。

class ast.NodeTransformer

子类 NodeVisitor 用于遍历抽象语法树，并允许修改节点。

NodeTransformer 将遍历抽象语法树并使用visitor方法的返回值去替换或移除旧节点。如果visitor方法的返回值为 None , 则该节点将从其位置移除，否则将替换为返回值。当返回值是原始节点时，无需替换。

如下是一个转换器示例，它将所有出现的名称 (foo) 重写为 data['foo']:

class RewriteName(NodeTransformer):

    def visit_Name(self, node):
        return Subscript(
            value=Name(id='data', ctx=Load()),
            slice=Constant(value=node.id),
            ctx=node.ctx
        )

请记住，如果您正在操作的节点具有子节点，则必须先转换其子节点或为该节点调用 generic_visit() 方法。

对于属于语句集合（适用于所有语句节点）的节点，访问者还可以返回节点列表而不仅仅是单个节点。

如果 NodeTransformer 引入了新的（不属于原节点树一部分的）节点而没有给出它们的位置信息（如 lineno 等），则应当调用 fix_missing_locations() 并传入新的子节点树来重新计算位置信息:

tree = ast.parse('foo', mode='eval')
new_tree = fix_missing_locations(RewriteName().visit(tree))

通常你可以像这样使用转换器:

node = YourTransformer().visit(node)

ast.dump(node, annotate_fields=True, include_attributes=False, *, indent=None)

返回 node 中树结构的格式化转储。 这主要适用于调试目的。 如果 annotate_fields 为真值（默认），返回的字符串将显示字段的名称和值。 如果 annotate_fields 为假值，结果字符串将通过省略无歧义的字段名称变得更为紧凑。 默认情况下不会转储行号和列偏移等属性。 如果需要，可将 include_attributes 设为真值。

如果 indent 是一个非负整数或者字符串，那么节点树将被美化输出为指定的缩进级别。 如果缩进级别为 0、负数或者 "" 则将只插入换行符。 None (默认) 将选择最紧凑的表示形式。 使用一个正整数将让每个级别缩进相应数量的空格。 如果 indent 是一个字符串 (如 "\t")，该字符串会被用于缩进每个级别。

在 3.9 版更改: 添加了 indent 选项。

编译器旗标

下列旗标可被传给 compile() 用来改变程序编译的效果:

ast.PyCF_ALLOW_TOP_LEVEL_AWAIT

启用对最高层级 await, async for, async with 以及异步推导式的支持。

3.8 新版功能.

ast.PyCF_ONLY_AST

生成并返回一个抽象语法树而不是返回一个已编译的代码对象。

ast.PyCF_TYPE_COMMENTS

启用对 PEP 484 [https://www.python.org/dev/peps/pep-0484] 和 PEP 526 [https://www.python.org/dev/peps/pep-0526] 风格的类型注释的支持 (# type: <type>, # type: ignore <stuff>)。

3.8 新版功能.

命令行用法

3.9 新版功能.

ast 模块可以在命令行下作为脚本来执行。 具体做法非常简单:

python -m ast [-m <mode>] [-a] [infile]

可以接受以下选项：

-h, --help

显示帮助信息并退出。

-m <mode>

--mode <mode>

指明哪种代码必须被编译，相当于 parse() 中的 mode 参数。

--no-type-comments

不要解析类型注释。

-a, --include-attributes

包括属性如行号和列偏移。

-i <indent>

--indent <indent>

AST 中节点的缩进（空格数）。

如果指定了 infile 则其内容将被解析为 AST 并转储至 stdout。 在其他情况下，将从 stdin 读取内容。

参见

Green Tree Snakes [https://greentreesnakes.readthedocs.io/]，一个外部文档资源，包含处理 Python AST 的完整细节。

ASTTokens [https://asttokens.readthedocs.io/en/latest/user-guide.html] 会为 Python AST 标注生成它们的源代码中的形符和文本的位置。 这对执行源代码转换的工具很有帮助。

leoAst.py [https://leoeditor.com/appendices.html#leoast-py] 通过在形符和 ast 节点之间插入双向链接统一了 python 程序基于形符的和基于解析树的视图。

LibCST [https://libcst.readthedocs.io/] 将代码解析为一个实体语法树（Concrete Syntax Tree），它看起来像是 ast 树而又保留了所有格式化细节。 它对构建自动化重构（codemod）应用和代码质量检查工具很有用处。

Parso [https://parso.readthedocs.io] 是一个支持错误恢复和不同 Python 版本的（在多个 Python 版本中）往返解析的 Python 解析器。 Parso 还能列出你的 Python 文件中的许多语法错误。

symtable ——访问编译器的符号表

Source code： Lib/symtable.py [https://github.com/python/cpython/tree/3.10/Lib/symtable.py]

符号表由编译器在生成字节码之前根据 AST 生成。符号表负责计算代码中每个标识符的作用域。 symtable 提供了一个查看这些表的接口。

符号表的生成

symtable.symtable(code, filename, compile_type)

返回 Python 源 代码 顶层的 SymbolTable。filename 是代码文件名。 compile_type 的含义类似 compile() 的 mode 参数。

符号表的查看

class symtable.SymbolTable

某个代码块的命名空间表。构造函数不公开。

get_type()

返回符号表的类型。可能是 'class' 、'module' 或 'function'。

get_id()

返回符号表的标识符

get_name()

返回符号表的名称。 若为类的符号表则返回类名；若为函数的符号表则为函数名；若是全局符号表则为 'top' (get_type() 返回 'module')。

get_lineno()

返回符号表所代表代码块的第一行编号。

is_optimized()

如果符号表中的局部变量可能被优化过，则返回 True。

is_nested()

如果代码块是嵌套类或函数，则返回 True。

has_children()

如果代码块中有嵌套的命名空间，则返回 True。可通过 get_children() 读取。

get_identifiers()

返回一个包含表中符号名称的视图对象。 参见 视图对象文档。

lookup(name)

在符号表中查找 name 并返回一个 Symbol 实例。

get_symbols()

返回符号表中所有符号的 Symbol 实例的列表。

get_children()

返回嵌套符号表的列表。

class symtable.Function

函数或方法的命名空间。该类继承自 SymbolTable。

get_parameters()

返回由函数的参数名组成的元组。

get_locals()

返回函数中局部变量名组成的元组。

get_globals()

返回函数中全局变量名组成的元组。

get_nonlocals()

返回函数中非局部变量名组成的元组。

get_frees()

返回函数中自由变量名组成的元组。

class symtable.Class

类的命名空间。继承自 SymbolTable。

get_methods()

返回类中声明的方法名组成的元组。

class symtable.Symbol

SymbolTable 中的数据项，对应于源码中的某个标识符。构造函数不公开。

get_name()

返回符号名

is_referenced()

如果符号在代码块中被引用了，则返回 True。

is_imported()

如果符号是由导入语句创建的，则返回 True。

is_parameter()

如果符号是参数，返回 True。

is_global()

如果符号是全局变量，则返回 True。

is_nonlocal()

如果符号为非局部变量，则返回 True。

is_declared_global()

如果符号用 global 声明为全局变量，则返回 True。

is_local()

如果符号是代码块内的局部变量，则返回 True。

is_annotated()

如果符号带有注解，则返回 True。

3.6 新版功能.

is_free()

如果符号在代码块中被引用，但未赋值，则返回 True。

is_assigned()

如果符号在代码块中赋值，则返回 True。

is_namespace()

如果符号名绑定引入了新的命名空间，则返回 True。

如果符号名用于函数或类定义语句，则为 True。

例如：

>>> table = symtable.symtable("def some_func(): pass", "string", "exec")
>>> table.lookup("some_func").is_namespace()
True

注意，一个符号名可以与多个对象绑定。如果结果为 True，则该符号名还可以绑定到其他对象上，比如 int 或 list ，且不会引入新的命名空间。

get_namespaces()

返回与符号名绑定的命名空间的列表。

get_namespace()

返回与符号名绑定的命名空间。如果绑定的命名空间超过一个，则会触发 ValueError。

token --- 与Python解析树一起使用的常量

源码： Lib/token.py [https://github.com/python/cpython/tree/3.10/Lib/token.py]

该模块提供了一些代表解析树的叶子节点的数字值的常量（终端形符）。 请参阅 Python 发布版中的 Grammar/Tokens 文件获取在该语言语法情境下的名称定义。 这些名称所映射的特定数字值有可能在各 Python 版本间发生变化。

该模块还提供从数字代码到名称和一些函数的映射。 这些函数镜像了 Python C 头文件中的定义。

token.tok_name

将此模块中定义的常量的数值映射回名称字符串的字典，允许生成更加人类可读的解析树表示。

token.ISTERMINAL(x)

对终端形符值返回 True。

token.ISNONTERMINAL(x)

对非终端形符值返回 True。

token.ISEOF(x)

如果 x 是表示输入结束的标记则返回 True。

形符常量有：

token.ENDMARKER

token.NAME

token.NUMBER

token.STRING

token.NEWLINE

token.INDENT

token.DEDENT

token.LPAR

"(" 的形符值。

token.RPAR

")" 的形符值。

token.LSQB

"[" 的形符值。

token.RSQB

"]" 的形符值。

token.COLON

":" 的形符值。

token.COMMA

"," 的形符值。

token.SEMI

";" 的形符值。

token.PLUS

"+" 的形符值。

token.MINUS

"-" 的形符值。

token.STAR

"*" 的形符值。

token.SLASH

"/" 的形符值。

token.VBAR

"|" 的形符值。

token.AMPER

"&" 的形符值。

token.LESS

"<" 的形符值。

token.GREATER

">" 的形符值。

token.EQUAL

"=" 的形符值。

token.DOT

"." 的形符值。

token.PERCENT

"%" 的形符值。

token.LBRACE

Token value for "{".

token.RBRACE

"}" 的形符值。

token.EQEQUAL

"==" 的形符值。

token.NOTEQUAL

"!=" 的形符值。

token.LESSEQUAL

"<=" 的形符值。

token.GREATEREQUAL

">=" 的形符值。

token.TILDE

"~" 的形符值。

token.CIRCUMFLEX

"^" 的形符值。

token.LEFTSHIFT

"<<" 的形符值。

token.RIGHTSHIFT

">>" 的形符值。

token.DOUBLESTAR

"**" 的形符值。

token.PLUSEQUAL

"+=" 的形符值。

token.MINEQUAL

"-=" 的形符值。

token.STAREQUAL

"*=" 的形符值。

token.SLASHEQUAL

"/=" 的形符值。

token.PERCENTEQUAL

"%=" 的形符值。

token.AMPEREQUAL

"&=" 的形符值。

token.VBAREQUAL

"|=" 的形符值。

token.CIRCUMFLEXEQUAL

"^=" 的形符值。

token.LEFTSHIFTEQUAL

"<<=" 的形符值。

token.RIGHTSHIFTEQUAL

">>=" 的形符值。

token.DOUBLESTAREQUAL

"**=" 的形符值。

token.DOUBLESLASH

"//" 的形符值。

token.DOUBLESLASHEQUAL

"//=" 的形符值。

token.AT

"@" 的形符值。

token.ATEQUAL

"@=" 的形符值。

token.RARROW

"->" 的形符值。

token.ELLIPSIS

"..." 的形符值。

token.COLONEQUAL

":=" 的形符值。

token.OP

token.AWAIT

token.ASYNC

token.TYPE_IGNORE

token.TYPE_COMMENT

token.SOFT_KEYWORD

token.ERRORTOKEN

token.N_TOKENS

token.NT_OFFSET

C 形符生成器不使用以下形符类型值，但 tokenize 模块需要它们。

token.COMMENT

形符值用于表示注释。

token.NL

形符值用于表示非终止换行符。 NEWLINE 形符表示 Python 代码逻辑行的结束；当在多条物理线路上继续执行逻辑代码行时，会生成 NL 形符。

token.ENCODING

指示用于将源字节解码为文本的编码的形符值。 tokenize.tokenize() 返回的第一个形符将始终是一个 ENCODING 形符。

token.TYPE_COMMENT

表示类型注释被识别的形符值。 此种形符仅在 ast.parse() 附带 type_comments=True 被发起调用时才会产生。

在 3.5 版更改: 增加 AWAIT 和 ASYNC 形符。

在 3.7 版更改: 形符 COMMENT、 NL 和 ENCODING 形符。

在 3.7 版更改: 移除 AWAIT 和 ASYNC 标记。 "async" 和 "await" 现在被标记为 NAME 标记。

在 3.8 版更改: 增加了 TYPE_COMMENT, TYPE_IGNORE, COLONEQUAL. Added AWAIT 和 ASYNC 形符（它们对于支持解析对于 ast.parse() 的 feature_version 设为 6 或更低的较老的 Python 版本是必须的）。

keyword --- 检验Python关键字

源码： Lib/keyword.py [https://github.com/python/cpython/tree/3.10/Lib/keyword.py]

此模块使 Python 程序可以确定某个字符串是否为 关键字 或 软关键字。

keyword.iskeyword(s)

如果 s 是一个 Python 关键字 则返回 True。

keyword.kwlist

包含解释器定义的所有 关键字 的序列。 如果所定义的任何关键字仅在特定 __future__ 语句生效时被激活，它们也将被包含在内。

keyword.issoftkeyword(s)

如果 s 是一个 Python 软关键字 则返回 True。

3.9 新版功能.

keyword.softkwlist

包含为解释器定义的所有 软关键字 的序列。 如果有任何被定义的软关键字是仅在当特定 __future__ 语句生效时才会被激活的，它们同样会被包括在内。

3.9 新版功能.

tokenize --- 对 Python 代码使用的标记解析器

源码： Lib/tokenize.py [https://github.com/python/cpython/tree/3.10/Lib/tokenize.py]

tokenize 模块为 Python 源代码提供了一个词法扫描器，用 Python 实现。该模块中的扫描器也将注释作为标记返回，这使得它对于实现“漂亮的输出器”非常有用，包括用于屏幕显示的着色器。

为了简化标记流的处理，所有的 运算符 和 定界符 以及 Ellipsis 返回时都会打上通用的 OP 标记。 可以通过 tokenize.tokenize() 返回的 named tuple 对象的 exact_type 属性来获得确切的标记类型。

警告

请注意本模块中的函数被设计为仅能解析符合语法的 Python 代码（当使用 ast.parse() 解析代码时不会引发异常）。 在提供无效的 Python 代码时本模块中函数的行为是 未定义 的并可能在任何时候发生改变。

对输入进行解析标记

主要的入口是一个 generator:

tokenize.tokenize(readline)

生成器 tokenize() 需要一个 readline 参数，这个参数必须是一个可调用对象，且能提供与文件对象的 io.IOBase.readline() 方法相同的接口。每次调用这个函数都要 返回字节类型输入的一行数据。

生成器产生 5 个具有这些成员的元组：令牌类型；令牌字符串；指定令牌在源中开始的行和列的 2 元组 (srow, scol) ；指定令牌在源中结束的行和列的 2 元组 (erow, ecol) ；以及发现令牌的行。所传递的行（最后一个元组项）是 实际的 行。 5 个元组以 named tuple 的形式返回，字段名是： type string start end line 。

返回的 named tuple 有一个额外的属性，名为 exact_type ，包含了 OP 标记的确切操作符类型。 对于所有其他标记类型， exact_type 等于命名元组的 type 字段。

在 3.1 版更改: 增加了对 named tuple 的支持。

在 3.3 版更改: 添加了对 exact_type 的支持。

根据 PEP 263 [https://www.python.org/dev/peps/pep-0263] ，tokenize() 通过寻找 UTF-8 BOM 或编码 cookie 来确定文件的源编码。

tokenize.generate_tokens(readline)

对读取 unicode 字符串而不是字节的源进行标记。

和 tokenize() 一样， readline 参数是一个返回单行输入的可调用参数。然而， generate_tokens() 希望 readline 返回一个 str 对象而不是字节。

其结果是一个产生具名元组的的迭代器，与 tokenize() 完全一样。 它不会产生 ENCODING 标记。

所有来自 token 模块的常量也可从 tokenize 导出。

提供了另一个函数来逆转标记化过程。这对于创建对脚本进行标记、修改标记流并写回修改后脚本的工具很有用。

tokenize.untokenize(iterable)

将令牌转换为 Python 源代码。 iterable 必须返回至少有两个元素的序列，即令牌类型和令牌字符串。任何额外的序列元素都会被忽略。

重构的脚本以单个字符串的形式返回。 结果被保证为标记回与输入相匹配，因此转换是无损的，并保证来回操作。 该保证只适用于标记类型和标记字符串，因为标记之间的间距（列位置）可能会改变。

它返回字节，使用 ENCODING 标记进行编码，这是由 tokenize() 输出的第一个标记序列。如果输入中没有编码令牌，它将返回一个字符串。

tokenize() 需要检测它所标记源文件的编码。它用来做这件事的函数是可用的：

tokenize.detect_encoding(readline)

detect_encoding() 函数用于检测解码 Python 源文件时应使用的编码。它需要一个参数， readline ，与 tokenize() 生成器的使用方式相同。

它最多调用 readline 两次，并返回所使用的编码（作为一个字符串）和它所读入的任何行（不是从字节解码的）的 list 。

它从 UTF-8 BOM 或编码 cookie 的存在中检测编码格式，如 PEP 263 [https://www.python.org/dev/peps/pep-0263] 所指明的。 如果 BOM 和 cookie 都存在，但不一致，将会引发 SyntaxError。 请注意，如果找到 BOM ，将返回 'utf-8-sig' 作为编码格式。

如果没有指定编码，那么将返回默认的 'utf-8' 编码.

使用 open() 来打开 Python 源文件：它使用 detect_encoding() 来检测文件编码。

tokenize.open(filename)

使用由 detect_encoding() 检测到的编码，以只读模式打开一个文件。

3.2 新版功能.

exception tokenize.TokenError

当文件中任何地方没有完成 docstring 或可能被分割成几行的表达式时触发，例如:

"""Beginning of
docstring

或者：

[1,
 2,
 3

注意，未封闭的单引号字符串不会导致错误发生。它们被标记为 ERRORTOKEN ，然后是其内容的标记化。

命令行用法

3.3 新版功能.

tokenize 模块可以作为一个脚本从命令行执行。这很简单:

python -m tokenize [-e] [filename.py]

可以接受以下选项：

-h, --help

显示此帮助信息并退出

-e, --exact

使用确切的类型显示令牌名称

如果 filename.py 被指定，其内容会被标记到 stdout 。否则，标记化将在 stdin 上执行。

例子

脚本改写器的例子，它将 float 文本转换为 Decimal 对象:

from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP
from io import BytesIO

def decistmt(s):
    """Substitute Decimals for floats in a string of statements.

    >>> from decimal import Decimal
    >>> s = 'print(+21.3e-5*-.1234/81.7)'
    >>> decistmt(s)
    "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"

    The format of the exponent is inherited from the platform C library.
    Known cases are "e-007" (Windows) and "e-07" (not Windows).  Since
    we're only showing 12 digits, and the 13th isn't close to 5, the
    rest of the output should be platform-independent.

    >>> exec(s)  #doctest: +ELLIPSIS
    -3.21716034272e-0...7

    Output from calculations with Decimal should be identical across all
    platforms.

    >>> 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:  # replace NUMBER tokens
            result.extend([
                (NAME, 'Decimal'),
                (OP, '('),
                (STRING, repr(tokval)),
                (OP, ')')
            ])
        else:
            result.append((toknum, tokval))
    return untokenize(result).decode('utf-8')

从命令行进行标记化的例子。 脚本:

def say_hello():
    print("Hello, World!")

say_hello()

将被标记为以下输出，其中第一列是发现标记的行 / 列坐标范围，第二列是标记的名称，最后一列是标记的值（如果有）。

$ 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         ''
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      ''

可以使用 -e 选项来显示确切的标记类型名称。

$ 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         ''
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      ''

以编程方式对文件进行标记的例子，用 generate_tokens() 读取 unicode 字符串而不是字节:

import tokenize

with tokenize.open('hello.py') as f:
    tokens = tokenize.generate_tokens(f.readline)
    for token in tokens:
        print(token)

或者通过 tokenize() 直接读取字节数据:

import tokenize

with open('hello.py', 'rb') as f:
    tokens = tokenize.tokenize(f.readline)
    for token in tokens:
        print(token)

tabnanny --- 模糊缩进检测

源代码: Lib/tabnanny.py [https://github.com/python/cpython/tree/3.10/Lib/tabnanny.py]

目前，该模块旨在作为脚本调用。但是可以使用下面描述的 check() 函数将其导入IDE。

注解

此模块提供的API可能会在将来的版本中更改；此类更改可能无法向后兼容。

tabnanny.check(file_or_dir)

如果 file_or_dir 是目录而非符号链接，则递归地在名为 file_or_dir 的目录树中下行，沿途检查所有 .py 文件。 如果 file_or_dir 是一个普通 Python 源文件，将检查其中的空格相关问题。 诊断消息将使用 print() 函数写入到标准输出。

tabnanny.verbose

此旗标指明是否打印详细消息。 如果作为脚本调用则是通过 -v 选项来增加。

tabnanny.filename_only

此旗标指明是否只打印包含空格相关问题文件的文件名。 如果作为脚本调用则是通过 -q 选项来设为真值。

exception tabnanny.NannyNag

如果检测到模糊缩进则由 process_tokens() 引发。 在 check() 中捕获并处理。

tabnanny.process_tokens(tokens)

此函数由 check() 用来处理由 tokenize 模块所生成的标记。

参见

模块 tokenize

用于Python源代码的词法扫描程序。

pyclbr --- Python 模块浏览器支持

源代码: Lib/pyclbr.py [https://github.com/python/cpython/tree/3.10/Lib/pyclbr.py]

pyclbr 模块提供了对于以 Python 编写的模块中定义的函数、类和方法的受限信息。 这种信息足够用来实现一个模块浏览器。 这种信息是从 Python 源代码中直接提取而非通过导入模块，因此该模块可以安全地用于不受信任的代码。 此限制使得非 Python 实现的模块无法使用此模块，包括所有标准和可选的扩展模块。

pyclbr.readmodule(module, path=None)

返回一个将模块层级的类名映射到类描述器的字典。 如果可能，将会包括已导入基类的描述器。 形参 module 为要读取模块名称的字符串；它可能是某个包内部的模块名称。 path 如果给出则为添加到 sys.path 开头的目录路径序列，它会被用于定位模块的源代码。

此函数为原始接口，仅保留用于向下兼容。 它会返回以下内容的过滤版本。

pyclbr.readmodule_ex(module, path=None)

返回一个基于字典的树，其中包含与模块中每个用 def 或 class 语句定义的函数和类相对应的函数和类描述器。 被返回的字典会将模块层级的函数和类名映射到它们的描述器。 嵌套的对象会被输入到它们的上级子目录中。 与 readmodule 一样，module 指明要读取的模块而 path 会被添加到 sys.path。 如果被读取的模块是一个包，则返回的字典将具有 '__path__' 键，其值是一个包含包搜索路径的列表。

3.7 新版功能: 嵌套定义的描述器。 它们通过新的子属性来访问。 每个定义都会有一个新的上级属性。

这些函数所返回的描述器是 Function 和 Class 类的实例。 用户不应自行创建这些类的实例。

Function 对象

Function 类的实例描述了由 def 语句所定义的函数。 它们具有下列属性:

Function.file

函数定义所在的文件名称。

Function.module

定义了所描述函数的模块名称。

Function.name

函数名称。

Function.lineno

定义在文件中起始位置的行号。

Function.parent

对于最高层级函数为 None。 对于嵌套函数则为上级函数。

3.7 新版功能.

Function.children

将名称映射到嵌套函数和类描述器的字典。

3.7 新版功能.

Function.is_async

True 针对使用 async 前缀定义的函数，其他情况下为 False。

3.10 新版功能.

Class 对象

Class 类的实例描述了由 class 语句所定义的类。 它们具有与 Function 对象相同的属性以及两个额外属性。

Class.file

类定义所在的文件名称。

Class.module

定义了所描述类的模块名称。

Class.name

类名称。

Class.lineno

定义在文件中起始位置的行号。

Class.parent

对于最高层级类为 None。 对于嵌套类则为上级类。

3.7 新版功能.

Class.children

将名称映射到嵌套函数和类描述器的字典。

3.7 新版功能.

Class.super

一个 Class 对象的列表，它们描述了所描述类的直接基类。 被命名为超类但无法被 readmodule_ex() 发现的类会作为类名字符串而非 Class 对象列出。

Class.methods

一个将方法名映射到行号的字典。 此属性可从更新的子目录中获取，仅保留用于向下兼容。

py_compile --- 编译 Python 源文件

源代码: Lib/py_compile.py [https://github.com/python/cpython/tree/3.10/Lib/py_compile.py]

py_compile 模块提供了用来从源文件生成字节码的函数和另一个用于当模块源文件作为脚本被调用时的函数。

虽然不太常用，但这个函数在安装共享模块时还是很有用的，特别是当一些用户可能没有权限在包含源代码的目录中写字节码缓存文件时。

exception py_compile.PyCompileError

当编译文件过程中发生错误时，抛出的异常。

py_compile.compile(file, cfile=None, dfile=None, doraise=False, optimize=- 1, invalidation_mode=PycInvalidationMode.TIMESTAMP, quiet=0)

将源文件编译成字节码并写入字节码缓存文件。 源代码将从名为 file 的文件中加载。 字节码会被写入到 cfile，它默认为 PEP 3147 [https://www.python.org/dev/peps/pep-3147]/PEP 488 [https://www.python.org/dev/peps/pep-0488] 路径，以 .pyc 结尾。 举例来说，如果 file 为 /foo/bar/baz.py 则对于 Python 3.2 cfile 将默认为 /foo/bar/__pycache__/baz.cpython-32.pyc。 如果指定了 dfile，则将用它而不是 file 作为在异常回溯中获取并显示的源文件的名称。 如果 doraise 为真值，则当编译 file 遇到错误时将引发 PyCompileError。 如果 doraise 为（默认的）假值，则会将错误字符串写入到 sys.stderr，但不会引发异常。 此函数返回已编译字节码文件的路径，即 cfile 所使用的值。

doraise 和 quiet 参数确定在编译文件时如何处理错误。 如果 quiet 为 0 或 1，并且 doraise 为假值，则会启用默认行为：写入错误信息到 sys.stderr，并且函数将返回 None 而非一个路径。 如果 doraise 为真值，则将改为引发 PyCompileError。 但是如果 quiet 为 2，则不会写入消息，并且 doraise 也不会有效果。

如果 cfile 所表示（显式指定或计算得出）的路径为符号链接或非常规文件，则将引发 FileExistsError。 此行为是用来警告如果允许写入编译后字节码文件到这些路径则导入操作将会把它们转为常规文件。 这是使用文件重命名来将最终编译后字节码文件放置到位以防止并发文件写入问题的导入操作的附带效果。

optimize 控制优化级别并会被传给内置的 compile() 函数。 默认值 -1 表示选择当前解释器的优化级别。

invalidation_mode 应当是 PycInvalidationMode 枚举的成员，它控制在运行时如何让已生成的字节码缓存失效。 如果设置了 SOURCE_DATE_EPOCH 环境变量则默认值为 PycInvalidationMode.CHECKED_HASH，否则默认值为 PycInvalidationMode.TIMESTAMP。

在 3.2 版更改: 将 cfile 的默认值改成与 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 兼容。 之前的默认值是 file + 'c' (如果启用优化则为 'o')。 同时也添加了 optimize 形参。

在 3.4 版更改: 将代码更改为使用 importlib 执行字节码缓存文件写入。 这意味着文件创建/写入的语义现在与 importlib 所做的相匹配，例如权限、写入和移动语义等等。 同时也添加了当 cfile 为符号链接或非常规文件时引发 FileExistsError 的预警设置。

在 3.7 版更改: invalidation_mode 形参是根据 PEP 552 [https://www.python.org/dev/peps/pep-0552] 的描述添加的。 如果设置了 SOURCE_DATE_EPOCH 环境变量，invalidation_mode 将被强制设为 PycInvalidationMode.CHECKED_HASH。

在 3.7.2 版更改: SOURCE_DATE_EPOCH 环境变量不会再覆盖 invalidation_mode 参数的值，而改为确定其默认值。

在 3.8 版更改: 增加了 quiet 形参。

class py_compile.PycInvalidationMode

一个由可用方法组成的枚举，解释器可以用来确定字节码文件是否与源文件保持一致。 .pyc 文件在其标头中指明了所需的失效模式。 请参阅 已缓存字节码的失效 了解有关 Python 在运行时如何让 .pyc 文件失效的更多信息。

3.7 新版功能.

TIMESTAMP

.pyc 文件包括时间戳和源文件的大小，Python 将在运行时将其与源文件的元数据进行比较以确定 .pyc 文件是否需要重新生成。

CHECKED_HASH

.pyc 文件包括源文件内容的哈希值，Python 将在运行时将其与源文件内容进行比较以确定 .pyc 文件是否需要重新生成。

UNCHECKED_HASH

类似于 CHECKED_HASH，.pyc 文件包括源文件内容的哈希值。 但是，Python 将在运行时假定 .pyc 文件是最新的而完全不会将 .pyc 与源文件进行验证。

此选项适用于 .pycs 由 Python 以外的某个系统例如构建系统来确保最新的情况。

命令行接口

这个模块可作为脚本被唤起以编译多个源文件。 在 filenames 中指定的文件会被编译并将结果字节码以普通方式进行缓存。 这个程序不会搜索目录结构来定位源文件；它只编译显式指定的文件。 如果某个文件无法被编译则退出状态为非零值。

<file> ... <fileN>

-

位置参数是要编译的文件。 如果 - 是唯一的形参，则文件列表将从标准输入获取。

-q, --quiet

屏蔽错误输出。

在 3.2 版更改: 添加了对 - 的支持。

在 3.10 版更改: 添加了对 -q 的支持。

参见

模块 compileall

编译一个目录树中所有 Python 源文件的工具。

compileall --- 字节编译 Python 库

源代码: Lib/compileall.py [https://github.com/python/cpython/tree/3.10/Lib/compileall.py]

这个模块提供了一些工具函数来支持安装 Python 库。 这些函数可以编译一个目录树中的 Python 源文件。 这个模块可被用来在安装库时创建缓存的字节码文件，这使得它们对于没有库目录写入权限的用户来说也是可用的。

使用命令行

此模块可以作为脚本运行 (使用 python -m compileall) 来编译 Python 源代码。

directory ...

file ...

位置参数是要编译的文件或包含源文件的目录，目录将被递归地遍历。 如果没有给出参数，则其行为如同使用了命令行 -l <directories from sys.path>。

-l

不要递归到子目录，只编译直接包含在指明或隐含的目录中的源代码文件。

-f

强制重新构建即使时间戳是最新的。

-q

不要打印已编译文件的列表。 如果传入一次，则错误消息仍将被打印。 如果传入两次 (-qq)，所有输出都会被屏蔽。

-d destdir

要附加到每个被编译文件的路径之前的目录。 这将出现在编译时回溯信息中，并且还会被编译到字节码文件中，届时它将在字节码文件被执行而源文件已不存在的情况下被用于回溯和其他消息。

-s strip_prefix

-p prepend_prefix

移除 (-s) 或添加 (-p) 记录在 .pyc 文件中的给定路径前缀。 不可与 -d 一同使用。

-x regex

regex 会被用于搜索每个要执行编译的文件的完整路径，而如果 regex 产生了一个匹配，则相应文件会被跳过。

-i list

读取文件 list 并将其包含的每一行添加到要编译的文件和目录列表中。 如果 list 为 -，则从 stdin 读取行。

-b

将字节码写入到它们的传统位置和名称，这可能会覆盖由另一版本的 Python 所创建的字节码文件。 默认是将文件写入到它们的 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 位置和名称，这允许来自多个版本的 Python 字节码文件共存。

-r

控制子目录的最大递归层级。 如果给出此选项，则 -l 选项将不会被考虑。 python -m compileall <directory> -r 0 等价于 python -m compileall <directory> -l。

-j N

使用 N 个工作者来编译给定目录中的文件。 如果使用 0，则将使用 os.cpu_count() 的结果。

--invalidation-mode [timestamp|checked-hash|unchecked-hash]

控制生成的字节码文件在运行时的失效规则。 值为 timestamp，意味着将生成嵌入了源时间戳和大小的 .pyc 文件。 checked-hash 和 unchecked-hash 等值将导致生成基于哈希的 pyc。 基于哈希的 pyc 嵌入了源文件内容的哈希值而不是时间戳。 请参阅 已缓存字节码的失效 了解有关 Python 在运行时如何验证字节码缓存文件的更多信息。 如果未设置 SOURCE_DATE_EPOCH 环境变量则默认值为 timestamp，而如果设置了 SOURCE_DATE_EPOCH 则为 checked-hash。

-o level

使用给定的优化级别进行编译。 可以多次使用来一次性地针对多个级别进行编译 (例如，compileall -o 1 -o 2)。

-e dir

忽略指向给定目录之外的符号链接。

--hardlink-dupes

如果两个不同优化级别的 .pyc 文件具有相同的内容，则使用硬链接来合并重复的文件。

在 3.2 版更改: 增加了 -i, -b 和 -h 选项。

在 3.5 版更改: 增加了 -j, -r 和 -qq 选项。 -q 选项改为多级别值。 -b 将总是产生以 .pyc 为后缀的字节码文件，而不是 .pyo。

在 3.7 版更改: 增加了 --invalidation-mode 选项。

在 3.9 版更改: 增加了 -s, -p, -e 和 --hardlink-dupes 选项。 将默认的递归限制从 10 提高到 sys.getrecursionlimit()。 增加允许多次指定 -o 选项。

没有可以控制 compile() 函数所使用的优化级别的命令行选项，因为 Python 解释器本身已经提供了该选项: python -O -m compileall。

类似地，compile() 函数会遵循 sys.pycache_prefix 设置。 所生成的字节码缓存将仅当 compile() 附带与将在运行时使用的相同 sys.pycache_prefix 时可用（如果存在该设置）。

公有函数

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 的目录树，在途中编译所有 .py 文件。 如果所有文件都编译成功则返回真值，否则返回假值。

maxlevels 形参被用来限制递归深度；它默认为 sys.getrecursionlimit()。

如果给出了 ddir，它会被附加到每个被编译的文件的路径之前以便在编译时回溯中使用，同时还会被编译到字节码文件中，届时它将在字节码文件被执行而源文件已不存在的情况下被用于回溯和其他消息中。

如果 force 为真值，则即使时间戳为最新模块也会被重新编译。

如果给出了 rx，则它的 search 方法会在准备编译的每个文件的完整路径上被调用，并且如果它返回真值，则该文件会被跳过。 这可被用来排除与一个正则表达式相匹配的文件，正则表达式将以 re.Pattern 对象的形式给出。

如果 quiet 为 False 或 0 (默认值)，则文件名和其他信息将被打印到标准输出。 如果设为 1，则只打印错误。 如果设为 2，则屏蔽所有输出。

如果 legacy 为真值，则将字节码文件写入到它们的传统位置和名称，这可能会覆盖由另一版本的 Python 所创建的字节码文件。 默认是将文件写入到它们的 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 位置和名称，这允许来自多个版本的 Python 字节码文件共存。

optimize 指明编译器的优化级别。 它会被传给内置 compile() 函数。 还接受一个优化层别列表这将在单次调用中多次编译一个 .py 文件。

参数 workers 指明要使用多少个工作进程来并行编译文件。 默认设置不使用多个工作进程。 如果平台不能使用多个工作进程而又给出了 workers 参数，则将回退为使用顺序编译。 如果 workers 为 0，则会使用系统的核心数量。 如果 workers 小于 0，则会引发 ValueError。

invalidation_mode 应为 py_compile.PycInvalidationMode 枚举的成员之一并将控制所生成的 pyc 在运行时以何种方式验证是否失效。

stripdir, prependdir 和 limit_sl_dest 参数分别对应上述的 -s, -p 和 -e 选项。 它们可以被指定为 str 或 os.PathLike。

如果 hardlink_dupes 为真值且两个使用不同优化级别的 .pyc 文件具有相同的内容，则会使用硬链接来合并重复的文件。

在 3.2 版更改: 增加了 legacy 和 optimize 形参。

在 3.5 版更改: 增加了 workers 形参。

在 3.5 版更改: quiet 形参已改为多级别值。

在 3.5 版更改: legacy 形参将只写入 .pyc 文件而非 .pyo 文件，无论 optimize 的值是什么。

在 3.6 版更改: 接受一个 path-like object。

在 3.7 版更改: 增加了 invalidation_mode 形参。

在 3.7.2 版更改: invalidation_mode 形参的默认值更新为 None。

在 3.8 版更改: 将 workers 设为 0 现在将会选择最优核心数量。

在 3.9 版更改: 增加了 stripdir, prependdir, limit_sl_dest 和 hardlink_dupes 参数。 maxlevels 的默认值从 10 改为 sys.getrecursionlimit()

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，则会向它的 search 方法传入准备编译的文件的完整路径，并且如果它返回真值，则不编译该文件并返回 True。 这可被用来排除与一个正则表达式相匹配的文件，正则表达式将以 re.Pattern 对象的形式给出。

如果 quiet 为 False 或 0 (默认值)，则文件名和其他信息将被打印到标准输出。 如果设为 1，则只打印错误。 如果设为 2，则屏蔽所有输出。

如果 legacy 为真值，则将字节码文件写入到它们的传统位置和名称，这可能会覆盖由另一版本的 Python 所创建的字节码文件。 默认是将文件写入到它们的 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 位置和名称，这允许来自多个版本的 Python 字节码文件共存。

optimize 指明编译器的优化级别。 它会被传给内置 compile() 函数。 还接受一个优化层别列表这将在单次调用中多次编译一个 .py 文件。

invalidation_mode 应为 py_compile.PycInvalidationMode 枚举的成员之一并将控制所生成的 pyc 在运行时以何种方式验证是否失效。

stripdir, prependdir 和 limit_sl_dest 参数分别对应上述的 -s, -p 和 -e 选项。 它们可以被指定为 str 或 os.PathLike。

如果 hardlink_dupes 为真值且两个使用不同优化级别的 .pyc 文件具有相同的内容，则会使用硬链接来合并重复的文件。

3.2 新版功能.

在 3.5 版更改: quiet 形参已改为多级别值。

在 3.5 版更改: legacy 形参将只写入 .pyc 文件而非 .pyo 文件，无论 optimize 的值是什么。

在 3.7 版更改: 增加了 invalidation_mode 形参。

在 3.7.2 版更改: invalidation_mode 形参的默认值更新为 None。

在 3.9 版更改: 增加了 stripdir, prependdir, limit_sl_dest 和 hardlink_dupes 参数。

compileall.compile_path(skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=- 1, invalidation_mode=None)

将在 sys.path 中找到的所有 .py 文件编译为字节码。 如果所有文件编译成功则返回真值，否则返回假值。

如果 skip_curdir 为真值（默认），则当前目录不会被包括在搜索中。 所有其他形参将被传递给 compile_dir() 函数。 请注意不同于其他编译函数，maxlevels 默认为 0。

在 3.2 版更改: 增加了 legacy 和 optimize 形参。

在 3.5 版更改: quiet 形参已改为多级别值。

在 3.5 版更改: legacy 形参将只写入 .pyc 文件而非 .pyo 文件，无论 optimize 的值是什么。

在 3.7 版更改: 增加了 invalidation_mode 形参。

在 3.7.2 版更改: invalidation_mode 形参的默认值更新为 None。

强制重新编译 Lib/ 子目录及其所有子目录下的全部 .py 文件:

import compileall

compileall.compile_dir('Lib/', force=True)

# Perform same compilation, excluding files in .svn directories.
import re
compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)

# pathlib.Path objects can also be used.
import pathlib
compileall.compile_dir(pathlib.Path('Lib/'), force=True)

参见

模块 py_compile

将单个源文件编译为字节码。

dis --- Python 字节码反汇编器

源代码: Lib/dis.py [https://github.com/python/cpython/tree/3.10/Lib/dis.py]

dis 模块通过反汇编支持CPython的 bytecode 分析。该模块作为输入的 CPython 字节码在文件 Include/opcode.h 中定义，并由编译器和解释器使用。

CPython 实现细节： 字节码是 CPython 解释器的实现细节。不保证不会在Python版本之间添加、删除或更改字节码。不应考虑将此模块的跨 Python VM 或 Python 版本的使用。

在 3.6 版更改: 每条指令使用2个字节。以前字节数因指令而异。

在 3.10 版更改: 跳转、异常处理和循环指令的参数现在将为指令偏移量而不是字节偏移量。

示例：给出函数 myfunc():

def myfunc(alist):
    return len(alist)

可以使用以下命令显示 myfunc() 的反汇编

>>> dis.dis(myfunc)
  2           0 LOAD_GLOBAL              0 (len)
              2 LOAD_FAST                0 (alist)
              4 CALL_FUNCTION            1
              6 RETURN_VALUE

("2" 是行号)。

字节码分析

3.4 新版功能.

字节码分析 API 允许将 Python 代码片段包装在 Bytecode 对象中，以便轻松访问已编译代码的详细信息。

class dis.Bytecode(x, *, first_line=None, current_offset=None)

分析的字节码对应于函数、生成器、异步生成器、协程、方法、源代码字符串或代码对象（由 compile() 返回）。

这是下面列出的许多函数的便利包装，最值得注意的是 get_instructions() ，迭代于 Bytecode 的实例产生字节码操作 Instruction 的实例。

如果 first_line 不是 None ，则表示应该为反汇编代码中的第一个源代码行报告的行号。否则，源行信息（如果有的话）直接来自反汇编的代码对象。

如果 current_offset 不是 None ，它指的就是汇编代码中的指令偏移量。设置它意味着 dis() 将针对指定的操作码显示“当前指令”标记。

classmethod from_traceback(tb)

从给定回溯构造一个 Bytecode 实例，将设置 current_offset 为异常负责的指令。

codeobj

已编译的代码对象。

first_line

代码对象的第一个源代码行（如果可用）

dis()

返回字节码操作的格式化视图（与 dis.dis() 打印相同，但作为多行字符串返回）。

info()

返回带有关于代码对象的详细信息的格式化多行字符串，如 code_info() 。

在 3.7 版更改: 现在可以处理协程和异步生成器对象。

示例:

>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
LOAD_GLOBAL
LOAD_FAST
CALL_FUNCTION
RETURN_VALUE

分析函数

dis 模块还定义了以下分析函数，它们将输入直接转换为所需的输出。如果只执行单个操作，它们可能很有用，因此中间分析对象没用：

dis.code_info(x)

返回格式化的多行字符串，其包含详细代码对象信息的用于被提供的函数、生成器、异步生成器、协程、方法、源代码字符串或代码对象。

请注意，代码信息字符串的确切内容是高度依赖于实现的，它们可能会在Python VM或Python版本中任意更改。

3.2 新版功能.

在 3.7 版更改: 现在可以处理协程和异步生成器对象。

dis.show_code(x, *, file=None)

将提供的函数、方法。源代码字符串或代码对象的详细代码对象信息打印到 file （如果未指定 file ，则为 sys.stdout ）。

这是 print(code_info(x), file=file) 的便捷简写，用于在解释器提示符下进行交互式探索。

3.2 新版功能.

在 3.4 版更改: 添加 file 形参。

dis.dis(x=None, *, file=None, depth=None)

反汇编 x 对象。 x 可以表示模块、类、方法、函数、生成器、异步生成器、协程、代码对象、源代码字符串或原始字节码的字节序列。对于模块，它会反汇编所有功能。对于一个类，它反汇编所有方法（包括类和静态方法）。对于代码对象或原始字节码序列，它每字节码指令打印一行。它还递归地反汇编嵌套代码对象（推导式代码，生成器表达式和嵌套函数，以及用于构建嵌套类的代码）。在被反汇编之前，首先使用 compile() 内置函数将字符串编译为代码对象。如果未提供任何对象，则此函数会反汇编最后一次回溯。

如果提供的话，反汇编将作为文本写入提供的 file 参数，否则写入 sys.stdout 。

递归的最大深度受 depth 限制，除非它是 None 。 depth=0 表示没有递归。

在 3.4 版更改: 添加 file 形参。

在 3.7 版更改: 实现了递归反汇编并添加了 depth 参数。

在 3.7 版更改: 现在可以处理协程和异步生成器对象。

dis.distb(tb=None, *, file=None)

如果没有传递，则使用最后一个回溯来反汇编回溯的堆栈顶部函数。 指示了导致异常的指令。

如果提供的话，反汇编将作为文本写入提供的 file 参数，否则写入 sys.stdout 。

在 3.4 版更改: 添加 file 形参。

dis.disassemble(code, lasti=- 1, *, file=None)

dis.disco(code, lasti=- 1, *, file=None)

反汇编代码对象，如果提供了 lasti ，则指示最后一条指令。输出分为以下几列：

行号，用于每行的第一条指令

当前指令，表示为 --> ，

一个标记的指令，用 >> 表示，

指令的地址，

操作码名称，

操作参数，和

括号中参数的解释。

参数解释识别本地和全局变量名称、常量值、分支目标和比较运算符。

如果提供的话，反汇编将作为文本写入提供的 file 参数，否则写入 sys.stdout 。

在 3.4 版更改: 添加 file 形参。

dis.get_instructions(x, *, first_line=None)

在所提供的函数、方法、源代码字符串或代码对象中的指令上返回一个迭代器。

迭代器生成一系列 Instruction ，命名为元组，提供所提供代码中每个操作的详细信息。

如果 first_line 不是 None ，则表示应该为反汇编代码中的第一个源代码行报告的行号。否则，源行信息（如果有的话）直接来自反汇编的代码对象。

3.4 新版功能.

dis.findlinestarts(code)

这个生成器函数使用代码对象 code 的 co_lines 方法来查找源代码中行开头的偏移量。 它们将作为 (offset, lineno) 对被生成。

在 3.6 版更改: 行号可能会减少。 以前，他们总是在增加。

在 3.10 版更改: 使用 PEP 626 [https://www.python.org/dev/peps/pep-0626] co_lines 方法而不是代码对象的 co_firstlineno 和 co_lnotab 属性。

dis.findlabels(code)

检测作为跳转目标的原始编译后字节码字符串 code 中的所有偏移量，并返回这些偏移量的列表。

dis.stack_effect(opcode, oparg=None, *, jump=None)

使用参数 oparg 计算 opcode 的堆栈效果。

如果代码有一个跳转目标并且 jump 是 True ，则 drag_effect() 将返回跳转的堆栈效果。如果 jump 是 False ，它将返回不跳跃的堆栈效果。如果 jump 是 None （默认值），它将返回两种情况的最大堆栈效果。

3.4 新版功能.

在 3.8 版更改: 添加 jump 参数。

Python字节码说明

get_instructions() 函数和 Bytecode 类提供字节码指令的详细信息的 Instruction 实例：

class dis.Instruction

字节码操作的详细信息

opcode

操作的数字代码，对应于下面列出的操作码值和 操作码集合 中的字节码值。

opname

人类可读的操作名称

arg

操作的数字参数（如果有的话），否则为 None

argval

已解析的 arg 值（如果已知），否则与 arg 相同

argrepr

人类可读的操作参数描述

offset

在字节码序列中的起始操作索引

starts_line

行由此操作码（如果有）启动，否则为 None

is_jump_target

如果其他代码跳到这里，则为 True ，否则为 False

3.4 新版功能.

Python编译器当前生成以下字节码指令。

一般指令

NOP

什么都不做。 用作字节码优化器的占位符。

POP_TOP

删除堆栈顶部（TOS）项。

ROT_TWO

交换两个最顶层的堆栈项。

ROT_THREE

将第二个和第三个堆栈项向上提升一个位置，顶项移动到位置三。

ROT_FOUR

将第二个、第三个和第四个堆栈项向上提升一个位置，将顶项移动到第四个位置。

3.8 新版功能.

DUP_TOP

复制堆栈顶部的引用。

3.2 新版功能.

DUP_TOP_TWO

复制堆栈顶部的两个引用，使它们保持相同的顺序。

3.2 新版功能.

一元操作

一元操作获取堆栈顶部元素，应用操作，并将结果推回堆栈。

UNARY_POSITIVE

实现 TOS = +TOS。

UNARY_NEGATIVE

实现 TOS = -TOS。

UNARY_NOT

实现 TOS = not TOS。

UNARY_INVERT

实现 TOS = ~TOS。

GET_ITER

实现 TOS = iter(TOS)。

GET_YIELD_FROM_ITER

如果 TOS 是一个 generator iterator 或 coroutine 对象则保持原样。否则实现 TOS = iter(TOS) 。

3.5 新版功能.

二元操作

二元操作从堆栈中删除堆栈顶部（TOS）和第二个最顶层堆栈项（TOS1）。 它们执行操作，并将结果放回堆栈。

BINARY_POWER

实现 TOS = TOS1 ** TOS 。

BINARY_MULTIPLY

实现 TOS = TOS1 * TOS 。

BINARY_MATRIX_MULTIPLY

实现 TOS = TOS1 @ TOS 。

3.5 新版功能.

BINARY_FLOOR_DIVIDE

实现 TOS = TOS1 // TOS。

BINARY_TRUE_DIVIDE

实现 TOS = TOS1 / TOS 。

BINARY_MODULO

实现 TOS = TOS1 % TOS 。

BINARY_ADD

实现 TOS = TOS1 + TOS 。

BINARY_SUBTRACT

实现 TOS = TOS1 - TOS 。

BINARY_SUBSCR

实现 TOS = TOS1[TOS]。

BINARY_LSHIFT

实现 TOS = TOS1 << TOS 。

BINARY_RSHIFT

实现 TOS = TOS1 >> TOS 。

BINARY_AND

实现 TOS = TOS1 & TOS 。

BINARY_XOR

实现 TOS = TOS1 ^ TOS 。

BINARY_OR

实现 TOS = TOS1 | TOS 。

就地操作

就地操作就像二元操作，因为它们删除了TOS和TOS1，并将结果推回到堆栈上，但是当TOS1支持它时，操作就地完成，并且产生的TOS可能是（但不一定） 原来的TOS1。

INPLACE_POWER

就地实现 TOS = TOS1 ** TOS 。

INPLACE_MULTIPLY

就地实现 TOS = TOS1 * TOS 。

INPLACE_MATRIX_MULTIPLY

就地实现 TOS = TOS1 @ TOS 。

3.5 新版功能.

INPLACE_FLOOR_DIVIDE

就地实现 TOS = TOS1 // TOS 。

INPLACE_TRUE_DIVIDE

就地实现 TOS = TOS1 / TOS 。

INPLACE_MODULO

就地实现 TOS = TOS1 % TOS 。

INPLACE_ADD

就地实现 TOS = TOS1 + TOS 。

INPLACE_SUBTRACT

就地实现 TOS = TOS1 - TOS 。

INPLACE_LSHIFT

就地实现 TOS = TOS1 << TOS 。

INPLACE_RSHIFT

就地实现 TOS = TOS1 >> TOS 。

INPLACE_AND

就地实现 TOS = TOS1 & TOS 。

INPLACE_XOR

就地实现 TOS = TOS1 ^ TOS 。

INPLACE_OR

就地实现 TOS = TOS1 | TOS 。

STORE_SUBSCR

实现 TOS1[TOS] = TOS2 。

DELETE_SUBSCR

实现 del TOS1[TOS] 。

协程操作码

GET_AWAITABLE

实现 TOS = get_awaitable(TOS) ，其中 get_awaitable(o) 返回 o 如果 o 是一个有 CO_ITERABLE_COROUTINE 标志的协程对象或生成器对象，否则解析 o.__await__ 。

3.5 新版功能.

GET_AITER

实现 TOS = TOS.__aiter__() 。

3.5 新版功能.

在 3.7 版更改: 已经不再支持从 __aiter__ 返回可等待对象。

GET_ANEXT

将 get_awaitable(TOS.__anext__()) 推入栈。 请参阅 GET_AWAITABLE 了解有关 get_awaitable 的详情。

3.5 新版功能.

END_ASYNC_FOR

终止一个 async for 循环。处理等待下一个项目时引发的异常。如果 TOS 是 StopAsyncIteration， 从堆栈弹出7个值，并使用后三个恢复异常状态。否则，使用堆栈中的三个值重新引发异常。从块堆栈中删除异常处理程序块。

3.8 新版功能.

BEFORE_ASYNC_WITH

从栈顶对象解析 __aenter__ 和 __aexit__ 。将 __aexit__ 和 __aenter__() 的结果推入堆栈。

3.5 新版功能.

SETUP_ASYNC_WITH

创建一个新的帧对象。

3.5 新版功能.

其他操作码

PRINT_EXPR

实现交互模式的表达式语句。TOS从堆栈中被移除并打印。在非交互模式下，表达式语句以 POP_TOP 终止。

SET_ADD(i)

调用 set.add(TOS1[-i], TOS) 。 用于实现集合推导。

LIST_APPEND(i)

调用 list.append(TOS1[-i], TOS)。 用于实现列表推导式。

MAP_ADD(i)

调用 dict.__setitem__(TOS1[-i], TOS1, TOS) 。 用于实现字典推导。

3.1 新版功能.

在 3.8 版更改: 映射值为 TOS ，映射键为 TOS1 。之前，它们被颠倒了。

对于所有 SET_ADD 、 LIST_APPEND 和 MAP_ADD 指令，当弹出添加的值或键值对时，容器对象保留在堆栈上，以便它可用于循环的进一步迭代。

RETURN_VALUE

返回 TOS 到函数的调用者。

YIELD_VALUE

弹出 TOS 并从一个 generator 生成它。

YIELD_FROM

弹出 TOS 并将其委托给它作为 generator 的子迭代器。

3.3 新版功能.

SETUP_ANNOTATIONS

检查 __annotations__ 是否在 locals() 中定义，如果没有，它被设置为空 dict 。只有在类或模块体静态地包含 variable annotations 时才会发出此操作码。

3.6 新版功能.

IMPORT_STAR

将所有不以 '_' 开头的符号直接从模块 TOS 加载到局部命名空间。加载所有名称后弹出该模块。这个操作码实现了 from module import * 。

POP_BLOCK

从块堆栈中删除一个块。有一块堆栈，每帧用于表示 try 语句等。

POP_EXCEPT

从块堆栈中删除一个块。 弹出的块必须是异常处理程序块，在进入 except 处理程序时隐式创建。除了从帧堆栈弹出无关值之外，最后三个弹出值还用于恢复异常状态。

RERAISE

重新引发当前位于栈顶的异常。 如果 oparg 为非零值，则将当前帧的 f_lasti 恢复为异常被引发时的值。

3.9 新版功能.

WITH_EXCEPT_START

调用堆栈中 7 号位置上的函数并附带栈顶位置的三项作为参数。 用来在 with 语句内发生异常时实现调用 context_manager.__exit__(*exc_info())。

3.9 新版功能.

LOAD_ASSERTION_ERROR

将 AssertionError 推入栈顶。 由 assert 语句使用。

3.9 新版功能.

LOAD_BUILD_CLASS

将 builtins .__ build_class__() 推到堆栈上。它之后被 CALL_FUNCTION 调用来构造一个类。

SETUP_WITH(delta)

此操作码会在 with 代码块开始之前执行多个操作。 首先，它从上下文管理器加载 __exit__() 并将其推入栈顶以供 WITH_EXCEPT_START 后续使用。 然后，调用 __enter__()，并推入一个指向 delta 的 finally 代码块。 最后，将调用 __enter__() 方法的结果推入栈顶。 下一个操作码将忽略它 (POP_TOP)，或将其存储在一个或多个变量 (STORE_FAST, STORE_NAME 或 UNPACK_SEQUENCE) 中。

3.2 新版功能.

COPY_DICT_WITHOUT_KEYS

TOS 是一个映射键的元组，而 TOS1 是匹配目标。 将 TOS 替换为由 TOS1 条目组成的 dict，但不包含任何 TOS 中的键。

3.10 新版功能.

GET_LEN

将 len(TOS) 推入栈顶。

3.10 新版功能.

MATCH_MAPPING

如果 TOS 是 collections.abc.Mapping 的实例（或者更准确地说：如果在它的 tp_flags 中设置了 Py_TPFLAGS_MAPPING 旗标），则将 True 推入栈顶。 否则，推入 False。

3.10 新版功能.

MATCH_SEQUENCE

如果 TOS 是 collections.abc.Sequence 的实例而 不是 str/bytes/bytearray 的实例（或者更准确地说：如果在它的 tp_flags 中设置了 Py_TPFLAGS_SEQUENCE 旗标），则将 True 推入栈顶。 否则 ，推入 False。

3.10 新版功能.

MATCH_KEYS

TOS 是一个映射键的元组，而 TOS1 是匹配目标。 如果 TOS1 包含 TOS 中的所有键，则推入一个包含对应值的 tuple，再推入 True。 否则，推入 None，再推入 False。

3.10 新版功能.

以下所有操作码均使用其参数。

STORE_NAME(namei)

实现 name = TOS。 namei 是 name 在代码对象的 co_names 属性中的索引。 在可能的情况下，编译器会尝试使用 STORE_FAST 或 STORE_GLOBAL。

DELETE_NAME(namei)

实现 del name ，其中 namei 是代码对象的 co_names 属性的索引。

UNPACK_SEQUENCE(count)

将 TOS 解包为 count 个单独的值，它们将按从右至左的顺序被放入堆栈。

UNPACK_EX(counts)

实现使用带星号的目标进行赋值：将 TOS 中的可迭代对象解包为单独的值，其中值的总数可以小于可迭代对象中的项数：新值之一将是由所有剩余项构成的列表。

counts 的低字节是列表值之前的值的数量，counts 中的高字节则是之后的值的数量。 结果值会按从右至左的顺序入栈。

STORE_ATTR(namei)

实现 TOS.name = TOS1，其中 namei 是 name 在 co_names 中的索引号。

DELETE_ATTR(namei)

实现 del TOS.name，使用 namei 作为 co_names 中的索引号。

STORE_GLOBAL(namei)

类似于 STORE_NAME 但会将 name 存储为全局变量。

DELETE_GLOBAL(namei)

类似于 DELETE_NAME 但会删除一个全局变量。

LOAD_CONST(consti)

将 co_consts[consti] 推入栈顶。

LOAD_NAME(namei)

将与 co_names[namei] 相关联的值推入栈顶。

BUILD_TUPLE(count)

创建一个使用了来自栈的 count 个项的元组，并将结果元组推入栈顶。

BUILD_LIST(count)

类似于 BUILD_TUPLE 但会创建一个列表。

BUILD_SET(count)

类似于 BUILD_TUPLE 但会创建一个集合。

BUILD_MAP(count)

将一个新字典对象推入栈顶。 弹出 2 * count 项使得字典包含 count 个条目: {..., TOS3: TOS2, TOS1: TOS}。

在 3.5 版更改: 字典是根据栈中的项创建而不是创建一个预设大小包含 count 项的空字典。

BUILD_CONST_KEY_MAP(count)

BUILD_MAP 版本专用于常量键。 弹出的栈顶元素包含一个由键构成的元组，然后从 TOS1 开始从构建字典的值中弹出 count 个值。

3.6 新版功能.

BUILD_STRING(count)

拼接 count 个来自栈的字符串并将结果字符串推入栈顶。

3.6 新版功能.

LIST_TO_TUPLE

从堆栈中弹出一个列表并推入一个包含相同值的元组。

3.9 新版功能.

LIST_EXTEND(i)

调用 list.extend(TOS1[-i], TOS)。 用于构建列表。

3.9 新版功能.

SET_UPDATE(i)

调用 set.update(TOS1[-i], TOS)。 用于构建集合。

3.9 新版功能.

DICT_UPDATE(i)

调用 dict.update(TOS1[-i], TOS)。 用于构建字典。

3.9 新版功能.

DICT_MERGE

类似于 DICT_UPDATE 但对于重复的键会引发异常。

3.9 新版功能.

LOAD_ATTR(namei)

将 TOS 替换为 getattr(TOS, co_names[namei])。

COMPARE_OP(opname)

执行布尔运算操作。 操作名称可在 cmp_op[opname] 中找到。

IS_OP(invert)

执行 is 比较，或者如果 invert 为 1 则执行 is not。

3.9 新版功能.

CONTAINS_OP(invert)

执行 in 比较，或者如果 invert 为 1 则执行 not in。

3.9 新版功能.

IMPORT_NAME(namei)

导入模块 co_names[namei]。 会弹出 TOS 和 TOS1 以提供 fromlist 和 level 参数给 __import__()。 模块对象会被推入栈顶。 当前命名空间不受影响：对于一条标准 import 语句，会执行后续的 STORE_FAST 指令来修改命名空间。

IMPORT_FROM(namei)

从在 TOS 内找到的模块中加载属性 co_names[namei]。 结果对象会被推入栈顶，以便由后续的 STORE_FAST 指令来保存。

JUMP_FORWARD(delta)

将字节码计数器的值增加 delta。

POP_JUMP_IF_TRUE(target)

如果 TOS 为真值，则将字节码计数器的值设为 target。 TOS 会被弹出。

3.1 新版功能.

POP_JUMP_IF_FALSE(target)

如果 TOS 为假值，则将字节码计数器的值设为 target。 TOS 会被弹出。

3.1 新版功能.

JUMP_IF_NOT_EXC_MATCH(target)

检测堆栈中的第二个值是否为匹配 TOS 的异常，如果不是则会跳转。 从堆栈中弹出两个值。

3.9 新版功能.

JUMP_IF_TRUE_OR_POP(target)

如果 TOS 为真值，则将字节码计数器的值设为 target 并将 TOS 留在栈顶。 否则（如 TOS 为假值），TOS 会被弹出。

3.1 新版功能.

JUMP_IF_FALSE_OR_POP(target)

如果 TOS 为假值，则将字节码计数器的值设为 target 并将 TOS 留在栈顶。 否则（如 TOS 为真值），TOS 会被弹出。

3.1 新版功能.

JUMP_ABSOLUTE(target)

将字节码计数器的值设为 target。

FOR_ITER(delta)

TOS 是一个 iterator。 请调用其 __next__() 方法。 如果此操作产生了一个新值，则将其推入栈顶（将迭代器留在其下方）。 如果迭代器提示已耗尽，TOS 会被弹出，并且字节码计数器将增加 delta。

LOAD_GLOBAL(namei)

加载名称为 co_names[namei] 的全局对象推入栈顶。

SETUP_FINALLY(delta)

将一个来自 try-finally 或 try-except 子句的 try 代码块推入代码块栈顶。 相对 finally 代码块或第一个 except 代码块 delta 个点数。

LOAD_FAST(var_num)

将指向局部对象 co_varnames[var_num] 的引用推入栈顶。

STORE_FAST(var_num)

将 TOS 存放到局部对象 co_varnames[var_num]。

DELETE_FAST(var_num)

移除局部对象 co_varnames[var_num]。

LOAD_CLOSURE(i)

将一个包含在单元的第 i 个空位中的对单元的引用推入栈顶并释放可用的存储空间。 如果 i 小于 co_cellvars 的长度则变量的名称为 co_cellvars[i]。 否则为 co_freevars[i - len(co_cellvars)]。

LOAD_DEREF(i)

加载包含在单元的第 i 个空位中的单元并释放可用的存储空间。 将一个对单元所包含对象的引用推入栈顶。

LOAD_CLASSDEREF(i)

类似于 LOAD_DEREF 但在查询单元之前会首先检查局部对象字典。 这被用于加载类语句体中的自由变量。

3.4 新版功能.

STORE_DEREF(i)

将 TOS 存放到包含在单元的第 i 个空位中的单元内并释放可用存储空间。

DELETE_DEREF(i)

清空包含在单元的第 i 个空位中的单元并释放可用存储空间。 被用于 del 语句。

3.2 新版功能.

RAISE_VARARGS(argc)

使用 raise 语句的 3 种形式之一引发异常，具体形式取决于 argc 的值：

0: raise (重新引发之前的异常)

1: raise TOS (在 TOS 上引发异常实例或类型)

2: raise TOS1 from TOS (在 TOS1 上引发异常实例或类型并将 __cause__ 设为 TOS)

CALL_FUNCTION(argc)

调用一个可调用对象并传入位置参数。 argc 指明位置参数的数量。 栈顶包含位置参数，其中最右边的参数在最顶端。 在参数之下是一个待调用的可调用对象。 CALL_FUNCTION 会从栈中弹出所有参数以及可调用对象，附带这些参数调用该可调用对象，并将可调用对象所返回的返回值推入栈顶。

在 3.6 版更改: 此操作码仅用于附带位置参数的调用。

CALL_FUNCTION_KW(argc)

调用一个可调用对象并传入位置参数（如果有的话）和关键字参数。 argc 指明位置参数和关键字参数的总数量。 栈顶元素包含一个关键字参数名称的元组，名称必须为字符串。 在元组之下是与元组顺序相对应的关键字参数值。 在它之下则是位置参数，其中最右边的参数在最顶端。 在参数之下是要调用的可调用对象。 CALL_FUNCTION_KW 会从栈中弹出所有参数及可调用对象，附带这些参数调用该可调用对象，并将可调用对象所返回的返回值推入栈顶。

在 3.6 版更改: 关键字参数会被打包为一个元组而非字典，argc 指明参数的总数量。

CALL_FUNCTION_EX(flags)

调用一个可调用对象并附带位置参数和关键字参数变量集合。 如果设置了 flags 的最低位，则栈顶包含一个由额外关键字参数组成的映射对象。 在调用该可调用对象之前，映射对象和可迭代对象会被分别“解包”并将它们的内容分别作为关键字参数和位置参数传入。 CALL_FUNCTION_EX 会中栈中弹出所有参数及可调用对象，附带这些参数调用该可调用对象，并将可调用对象所返回的返回值推入栈顶。

3.6 新版功能.

LOAD_METHOD(namei)

从 TOS 对象加载一个名为 co_names[namei] 的方法。 TOS 将被弹出。 此字节码可区分两种情况：如果 TOS 有一个名称正确的方法，字节码会将未绑定方法和 TOS 推入栈顶。 TOS 将在调用未绑定方法时被用作 CALL_METHOD 的第一个参数 (self)。 否则会将 NULL 和属性查找所返回的对象推入栈顶。

3.7 新版功能.

CALL_METHOD(argc)

调用一个方法。 argc 是位置参数的数量。 关键字参数不受支持。 此操作码被设计用于配合 LOAD_METHOD 使用。 位置参数放在栈顶。 在它们之下放在栈中的是由 LOAD_METHOD 所描述的两个条目（或者是 self 和一个未绑定方法对象，或者是 NULL 和一个任意可调用对象）。 它们会被全部弹出并将返回值推入栈顶。

3.7 新版功能.

MAKE_FUNCTION(flags)

将一个新函数对象推入栈顶。 从底端到顶端，如果参数带有指定的旗标值则所使用的栈必须由这些值组成。

0x01 一个默认值的元组，用于按位置排序的仅限位置形参以及位置或关键字形参

0x02 一个仅限关键字形参的默认值的字典

0x04 一个包含形参标注的字符串元组。

0x08 一个包含用于自由变量的单元的元组，生成一个闭包

与函数相关联的代码 (在 TOS1)

函数的 qualified name (在 TOS)

在 3.10 版更改: 旗标值 0x04 是一个字符串元组而非字典。

BUILD_SLICE(argc)

将一个切片对象推入栈顶。 argc 必须为 2 或 3。 如果为 2，则推入 slice(TOS1, TOS)；如果为 3，则推入 slice(TOS2, TOS1, TOS)。 请参阅 slice() 内置函数了解详细信息。

EXTENDED_ARG(ext)

为任意带有大到无法放入默认的单字节的参数的操作码添加前缀。 ext 存放一个附加字节作为参数中的高比特位。 对于每个操作码，最多允许三个 EXTENDED_ARG 前缀，构成两字节到三字节的参数。

FORMAT_VALUE(flags)

用于实现格式化字面值字符串（f-字符串）。 从栈中弹出一个可选的 fmt_spec，然后是一个必须的 value。 flags 的解读方式如下：

(flags & 0x03) == 0x00: value 按原样格式化。

(flags & 0x03) == 0x01: 在格式化 value 之前调用其 str()。

(flags & 0x03) == 0x02: 在格式化 value 之前调用其 repr()。

(flags & 0x03) == 0x03: 在格式化 value 之前调用其 ascii()。

(flags & 0x04) == 0x04: 从栈中弹出 fmt_spec 并使用它，否则使用空的 fmt_spec。

使用 PyObject_Format() 执行格式化。 结果会被推入栈顶。

3.6 新版功能.

MATCH_CLASS(count)

TOS 是一个包含关键字属性名称的元组，TOS1 是要匹配的类，而 TOS2 是匹配目标。 count 是位置子模式的数量。

弹出 TOS。 如果 TOS2 是 TOS1 的一个实例且具有 count 和 TOS 所要求的位置和关键字属性，则将 TOS 设为 True 并将 TOS1 设为包含已提取属性的元组。 否则，将 TOS 设为 False。

3.10 新版功能.

GEN_START(kind)

弹出 TOS。 kind 操作数与生成器或协程的类型相对应。 合法的类型有代表生成器的 0，代表协程的 1，以及代表异步生成器的 2。

3.10 新版功能.

ROT_N(count)

将栈的前 count 项向上提升一个位置，并将 TOS 下移至位置 count。

3.10 新版功能.

HAVE_ARGUMENT

这不是一个真正的操作码。 它用于标明不使用参数和使用参数的操作码 (分别为 < HAVE_ARGUMENT 和 >= HAVE_ARGUMENT) 之间的分隔。

在 3.6 版更改: 现在每条指令都带有参数，但操作码 < HAVE_ARGUMENT 会忽略它。 之前仅限操作码 >= HAVE_ARGUMENT 带有参数。

操作码集合

提供这些集合用于字节码指令的自动内省：

dis.opname

操作名称的序列，可使用字节码来索引。

dis.opmap

映射操作名称到字节码的字典

dis.cmp_op

所有比较操作名称的序列。

dis.hasconst

访问常量的字节码序列。

dis.hasfree

访问自由变量的字节码序列（请注意这里所说的‘自由’是指在当前作用域中被内部作用域所引用的名称，或在外部作用域中被此作用域所引用的名称。 它 并不 包括对全局或内置作用域的引用）。

dis.hasname

按名称访问属性的字节码序列。

dis.hasjrel

具有相对跳转目标的字节码序列。

dis.hasjabs

具有绝对跳转目标的字节码序列。

dis.haslocal

访问局部变量的字节码序列。

dis.hascompare

布尔运算的字节码序列。

pickletools --- pickle 开发者工具集

源代码: Lib/pickletools.py [https://github.com/python/cpython/tree/3.10/Lib/pickletools.py]

此模块包含与 pickle 模块内部细节有关的多个常量，一些关于具体实现的详细注释，以及一些能够分析封存数据的有用函数。 此模块的内容对需要操作 pickle 的 Python 核心开发者来说很有用处；pickle 的一般用户则可能会感觉 pickletools 模块与他们无关。

命令行语法

3.2 新版功能.

当从命令行唤起时，python -m pickletools 将对一个或更多 pickle 文件的内容进行拆解。 请注意如果你查看 pickle 中保存的 Python 对象而非 pickle 格式的细节，你可能需要改用 -m pickle。 但是，当你想检查的 pickle 文件来自某个不受信任的源时，-m pickletools 是更安全的选择，因为它不会执行 pickle 字节码。

例如，对于一个封存在文件 x.pickle 中的元组 (1, 2):

$ 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

命令行选项

-a, --annotate

使用简短的操作码描述来标注每一行。

-o, --output=<file>

输出应当写入到的文件名称。

-l, --indentlevel=<num>

一个新的 MARK 层级所需缩进的空格数。

-m, --memo

当反汇编多个对象时，保留各个反汇编的备忘记录。

-p, --preamble=<preamble>

当指定一个以上的 pickle 文件时，在每次反汇编之前打印给定的前言。

编程接口

pickletools.dis(pickle, out=None, memo=None, indentlevel=4, annotate=0)

将 pickle 的符号化反汇编数据输出到文件型对象 out，默认为 sys.stdout。 pickle 可以是一个字符串或一个文件型对象。 memo 可以是一个将被用作 pickle 的备忘记录的 Python 字典；它可被用来对由同一封存器创建的多个封存对象执行反汇编。 由 MARK 操作码指明的每个连续级别将会缩进 indentlevel 个空格。 如果为 annotate 指定了一个非零值，则输出中的每个操作码将以一个简短描述来标注。 annotate 的值会被用作标注所应开始的列的提示。

3.2 新版功能: annotate 参数。

pickletools.genops(pickle)

提供包含 pickle 中所有操作码的 iterator，返回一个 (opcode, arg, pos) 三元组的序列。 opcode 是 OpcodeInfo 类的一个实例；arg 是 Python 对象形式的 opcode 参数的已解码值；pos 是 opcode 所在的位置。 pickle 可以是一个字符串或一个文件型对象。

pickletools.optimize(picklestring)

在消除未使用的 PUT 操作码之后返回一个新的等效 pickle 字符串。 优化后的 pickle 将更为简短，耗费更少的传输时间，要求更少的存储空间并能更高效地解封。

Windows系统相关模块

本章节叙述的模块只在 Windows 平台上可用。

msvcrt --- 来自 MS VC++ 运行时的有用例程

文件操作

控制台 I/O

其他函数

winreg --- 访问 Windows 注册表

函数

常量

HKEY_* 常量

访问权限

64 位系统特有

注册表值的类型

注册表句柄对象

winsound —— Windows 系统的音频播放接口

msvcrt --- 来自 MS VC++ 运行时的有用例程

这些函数提供了对 Windows 平台上一些有用功能的访问。一些更高级别的模块使用这些函数来构建其服务的 Windows 实现。 例如， getpass 模块在实现 getpass() 函数时使用了这些函数。

关于这些函数的更多信息可以在平台 API 文档中找到。

该模块实现了控制台 I/O API 的普通和宽字符变体。普通的 API 只处理ASCII字符，国际化应用受限。应该尽可能地使用宽字符 API 。

在 3.3 版更改: 此模块中过去会引发 IOError 的操作现在将引发 OSError。

文件操作

msvcrt.locking(fd, mode, nbytes)

基于文件描述符 fd 从 C 运行时锁定文件的某一部分。 失败时引发 OSError。 锁定的文件区域从当前文件位置开始扩展 nbytes 个字节，并可能持续到超出文件末尾。 mode 必须为下面列出的 LK_* 之一。 一个文件中的多个区域可以被同时锁定，但是不能重叠。 相邻区域不会被合并；它们必须单独被解锁。

引发一个 审计事件 msvcrt.locking 并附带参数 fd, mode, nbytes。

msvcrt.LK_LOCK

msvcrt.LK_RLCK

锁定指定的字节数据。 如果字节数据无法被锁定，程序会在 1 秒之后立即重试。 如果在 10 次尝试后字节数据仍无法被锁定，则会引发 OSError。

msvcrt.LK_NBLCK

msvcrt.LK_NBRLCK

锁定指定的字节数据。 如果字节数据无法被锁定，则会引发 OSError。

msvcrt.LK_UNLCK

解锁指定的字节数据，该对象必须在之前被锁定。

msvcrt.setmode(fd, flags)

设置文件描述符 fd 的行结束符转写模式。 要将其设为文本模式，则 flags 应当为 os.O_TEXT；设为二进制模式，则应当为 os.O_BINARY。

msvcrt.open_osfhandle(handle, flags)

基于文件句柄 handle 创建一个 C 运行时文件描述符。 flags 形参应当 os.O_APPEND, os.O_RDONLY 和 os.O_TEXT 按位 OR 的结果。 返回的文件描述符可以被用作 os.fdopen() 的形参以创建一个文件对象。

引发一个 审计事件 msvcrt.open_osfhandle 并附带参数 handle, flags。

msvcrt.get_osfhandle(fd)

返回文件描述符 fd 的文件句柄。 如果 fd 不能被识别则会引发 OSError。

引发一个 审计事件 msvcrt.get_osfhandle 并附带参数 fd。

控制台 I/O

msvcrt.kbhit()

如果有某个按键正在等待被读取则返回 True。

msvcrt.getch()

读取一个按键并将结果字符返回为一个字节串。 不会有内容回显到缝制台。 如果还没有任何键被按下此调用将会阻塞，但它将不会等待 Enter 被按下。 如果按下的键是一个特殊功能键，此函数将返回 '\000' 或 '\xe0'；下一次调用将返回键代码。 Control-C 按钮无法使用此函数来读取。

msvcrt.getwch()

getch() 的宽字符版本，返回一个 Unicode 值。

msvcrt.getche()

类似于 getch()，但按键如果表示一个可打印字符则它将被回显。

msvcrt.getwche()

getche() 的宽字符版本，返回一个 Unicode 值。

msvcrt.putch(char)

将字符串 char 打印到终端，不使用缓冲区。

msvcrt.putwch(unicode_char)

putch() 的宽字符版本，接受一个 Unicode 值。

msvcrt.ungetch(char)

使得字节串 char 被“推回”终端缓冲区；它将是被 getch() 或 getche() 读取的下一个字符。

msvcrt.ungetwch(unicode_char)

ungetch() 的宽字符版本，接受一个 Unicode 值。

其他函数

msvcrt.heapmin()

强制 malloc() 堆清空自身并将未使用的块返回给操作系统。 失败时，这将引发 OSError。

winreg --- 访问 Windows 注册表

这些函数将 Windows 注册表 API 暴露给 Python。 为了确保即便程序员忘记显式关闭时也能够正确关闭，这里没有用整数作为注册表句柄，而是采用了 句柄对象。

在 3.3 版更改: 模块中有几个函数用于触发 WindowsError，此异常现在是 OSError 的别名。

函数

该模块提供了下列函数：

winreg.CloseKey(hkey)

关闭之前打开的注册表键。参数 hkey 指之前打开的键。

注解

如果没有使用该方法关闭 hkey (或者通过 hkey.Close())，在对象 hkey 被 Python 销毁时会将其关闭。

winreg.ConnectRegistry(computer_name, key)

建立到另一台计算机上的预定义注册表句柄的连接，并返回一个 句柄对象。

computer_name 是远程计算机的名称，以 r"\\computername" 的形式。如果是 None ，将会使用本地计算机。

key 是所连接到的预定义句柄。

返回值是所开打键的句柄。如果函数失败，则引发一个 OSError 异常。

引发一个 审计事件 winreg.ConnectRegistry 并附带参数 computer_name, key。

在 3.3 版更改: 参考 上文。

winreg.CreateKey(key, sub_key)

创建或打开特定的键，返回一个 handle 对象。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 是用于命名该方法所打开或创建的键的字符串。

如果 key 是预定义键之一，sub_key 可能会是 None。该情况下，返回的句柄就是传入函数的句柄。

如果键已经存在，则该函数打开已经存在的该键。

返回值是所开打键的句柄。如果函数失败，则引发一个 OSError 异常。

引发一个 审计事件 winreg.CreateKey 并附带参数 key, sub_key, access。

引发一个 审计事件 winreg.OpenKey/result 并附带参数 key。

在 3.3 版更改: 参考 上文。

winreg.CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE)

创建或打开特定的键，返回一个 handle 对象。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 是用于命名该方法所打开或创建的键的字符串。

reserved 是一个保留的整数，必须是零。 默认值为零。

access 为一个整数，用于给键的预期安全访问指定访问掩码。默认值为 KEY_WRITE。 参阅 Access Rights 了解其它允许值。

如果 key 是预定义键之一，sub_key 可能会是 None。该情况下，返回的句柄就是传入函数的句柄。

如果键已经存在，则该函数打开已经存在的该键。

返回值是所开打键的句柄。如果函数失败，则引发一个 OSError 异常。

引发一个 审计事件 winreg.CreateKey 并附带参数 key, sub_key, access。

引发一个 审计事件 winreg.OpenKey/result 并附带参数 key。

3.2 新版功能.

在 3.3 版更改: 参考 上文。

winreg.DeleteKey(key, sub_key)

删除指定的键。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 这个字符串必须是由 key 参数所指定键的一个子项。该值项不可以是 None，同时键也不可以有子项。

该方法不能删除带有子项的键。

如果方法成功，则整个键，包括其所有值项都会被移除。如果方法失败，则引发一个 OSError 异常。

引发一个 审计事件 winreg.DeleteKey 并附带参数 key, sub_key, access。

在 3.3 版更改: 参考 上文。

winreg.DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0)

删除指定的键。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 这个字符串必须是由 key 参数所指定键的一个子项。该值项不可以是 None，同时键也不可以有子项。

reserved 是一个保留的整数，必须是零。 默认值为零。

access 是一个指定描述注册表键所需的安全权限的访问掩码的整数。 默认值为 KEY_WOW64_64KEY。 在 32-bit Windows 上，WOW64 常量会被忽略。 请参阅 访问权限 了解其他可用的值。

该方法不能删除带有子项的键。

如果方法成功，则整个键，包括其所有值项都会被移除。如果方法失败，则引发一个 OSError 异常。

在不支持的 Windows 版本之上，将会引发 NotImplementedError 异常。

引发一个 审计事件 winreg.DeleteKey 并附带参数 key, sub_key, access。

3.2 新版功能.

在 3.3 版更改: 参考 上文。

winreg.DeleteValue(key, value)

从某个注册键中删除一个命名值项。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

value 为标识所要删除值项的字符串。

引发一个 审计事件 winreg.DeleteValue 并附带参数 key, value。

winreg.EnumKey(key, index)

列举某个已经打开注册表键的子项，并返回一个字符串。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

index 为一个整数，用于标识所获取键的索引。

每次调用该函数都会获取一个子项的名字。通常它会被反复调用，直到引发 OSError 异常，这说明已经没有更多的可用值了。

引发一个 审计事件 winreg.EnumKey 并附带参数 key, index。

在 3.3 版更改: 参考 上文。

winreg.EnumValue(key, index)

列举某个已经打开注册表键的值项，并返回一个元组。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

index 为一个整数，用于标识要获取值项的索引。

每次调用该函数都会获取一个子项的名字。通常它会被反复调用，直到引发 OSError 异常，这说明已经没有更多的可用值了。

结果为3元素的元组。

索引 | 含意
0 | 用于标识值项名称的字符串。
1 | 保存值项数据的对象，其类型取决于背后的注册表类型。
2 | 标识值项数据类型的整数。（请查阅 SetValueEx() 文档中的表格）

引发一个 审计事件 winreg.EnumValue 并附带参数 key, index。

在 3.3 版更改: 参考 上文。

winreg.ExpandEnvironmentStrings(str)

Expands environment variable placeholders %NAME% in strings like REG_EXPAND_SZ:

>>> ExpandEnvironmentStrings('%windir%')
'C:\\Windows'

引发一个 审计事件 winreg.ExpandEnvironmentStrings 并附带参数 str。

winreg.FlushKey(key)

将某个键的所有属性写入注册表。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

没有必要调用 FlushKey() 去改动注册表键。注册表的变动是由其延迟刷新机制更新到磁盘的。在系统关机时，也会将注册表的变动写入磁盘。与 CloseKey() 不同， FlushKey() 方法只有等到所有数据都写入注册表后才会返回。只有需要绝对确认注册表变动已写入磁盘时，应用程序才应去调用 FlushKey()。

注解

如果不知道是否要调用 FlushKey() ，可能就是不需要。

winreg.LoadKey(key, sub_key, file_name)

在指定键之下创建一个子键，并将指定文件中的注册表信息存入该子键中。

key 是由 ConnectRegistry() 返回的句柄，或者是常量 HKEY_USERS 或 HKEY_LOCAL_MACHINE。

sub_key 是个字符串，用于标识需要载入的子键。

file_name 是要加载注册表数据的文件名。该文件必须是用 SaveKey() 函数创建的。在文件分配表（FAT）文件系统中，文件名可能不带扩展名。

如果调用 LoadKey() 的进程没有 SE_RESTORE_PRIVILEGE 权限，则调用会失败。请注意，特权与权限不同 —— 更多细节请参阅 RegLoadKey 文档 [https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx]。

如果 key 是由 ConnectRegistry() 返回的句柄，那么 file_name 指定的路径是相对于远程计算机而言的。

引发一个 审计事件 winreg.LoadKey 并附带参数 key, sub_key, file_name。

winreg.OpenKey(key, sub_key, reserved=0, access=KEY_READ)

winreg.OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ)

打开指定的注册表键，返回 handle对象。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 是个字符串，标识了需要打开的子键。

reserved 是个保留整数，必须为零。默认值为零。

access 是个指定访问掩码的整数，掩码描述了注册表键所需的安全权限。 默认值为 KEY_READ。 其他合法值参见 访问权限。

返回结果为一个新句柄，指向指定的注册表键。

如果调用失败，则会触发 OSError 。

引发一个 审计事件 winreg.OpenKey 并附带参数 key, sub_key, access。

引发一个 审计事件 winreg.OpenKey/result 并附带参数 key。

在 3.2 版更改: 允许使用命名参数。

在 3.3 版更改: 参考 上文。

winreg.QueryInfoKey(key)

以元组形式返回某注册表键的信息。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

结果为3元素的元组。

索引 | 含意
0 | 整数值，给出了此注册表键的子键数量。
1 | 整数值，给出了此注册表键的值的数量。
2 | 整数值，给出了此注册表键的最后修改时间，单位为自 1601 年 1 月 1 日以来的 100 纳秒。

引发一个 审计事件 winreg.QueryInfoKey 并附带参数 key。

winreg.QueryValue(key, sub_key)

读取某键的未命名值，形式为字符串。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 是个字符串，用于保存与某个值相关的子键名称。如果本参数为 None 或空，函数将读取由 SetValue() 方法为 key 键设置的值。

注册表中的值包含名称、类型和数据。本方法将读取注册表键值的第一个名称为 NULL 的数据。可是底层的 API 调用不会返回类型，所以只要有可能就一定要使用 QueryValueEx()。

引发一个 审计事件 winreg.QueryValue 并附带参数 key, sub_key, value_name。

winreg.QueryValueEx(key, value_name)

读取已打开注册表键指定值名称的类型和数据。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

value_name 是字符串，表示要查询的值。

结果为二元组：

索引 | 含意
0 | 注册表项的值。
1 | 整数值，给出该值的注册表类型（请查看文档中的表格了解 SetValueEx() ）。

引发一个 审计事件 winreg.QueryValue 并附带参数 key, sub_key, value_name。

winreg.SaveKey(key, file_name)

将指定注册表键及其所有子键存入指定的文件。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

file_name 是要保存注册表数据的文件名。该文件不能已存在。如果文件名包括扩展名，也不能在文件分配表（FAT）文件系统中用于 LoadKey() 方法。

如果 key 代表远程计算机的注册表键，那么 file_name 所描述的路径是相对于远程计算机的。本方法的调用者必须拥有 SeBackupPrivilege 特权。请注意，特权与权限是不同的 —— 更多细节请参见 用户权利和权限之间的冲突文档 [https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx]。

本函数将 NULL 传给 API 的 security_attributes。

引发一个 审计事件 winreg.SaveKey 并附带参数 key, file_name。

winreg.SetValue(key, sub_key, type, value)

将值与指定的注册表键关联。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

sub_key 是个字符串，用于命名与该值相关的子键。

type 是个整数，用于指定数据的类型。目前这必须是 REG_SZ ，意味着只支持字符串。请用 SetValueEx() 函数支持其他的数据类型。

value 是设置新值的字符串。

如果 sub_key 参数指定的注册表键不存在，SetValue 函数会创建一个。

值的长度受到可用内存的限制。较长的值（超过 2048 字节）应存为文件，并将文件名存入配置注册表。这有助于提高注册表的使用效率。

由 key 参数标识的注册表键，必须已用 KEY_SET_VALUE 方式打开。

引发一个 审计事件 winreg.SetValue 并附带参数 key, sub_key, type, value。

winreg.SetValueEx(key, value_name, reserved, type, value)

将数据存入已打开的注册表键的值中。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

value_name 是个字符串，用于命名与值相关的子键。

reserved 可以是任意数据 —— 传给 API 的总是 0。

type 是个整数，用于指定数据的类型。请参阅 Value Types 了解可用的类型。

value 是设置新值的字符串。

本方法也可为指定的注册表键设置额外的值和类型信息。注册表键必须已用 KEY_SET_VALUE 方式打开。

请用 CreateKey() 或 OpenKey() 方法打开注册表键。

值的长度受到可用内存的限制。较长的值（超过 2048 字节）应存为文件，并将文件名存入配置注册表。这有助于提高注册表的使用效率。

引发一个 审计事件 winreg.SetValue 并附带参数 key, sub_key, type, value。

winreg.DisableReflectionKey(key)

禁用运行于 64 位操作系统的 32 位进程的注册表重定向。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

如果在 32 位操作系统上执行，一般会触发 NotImplementedError。

如果注册表键不在重定向列表中，函数会调用成功，但没有实际效果。禁用注册表键的重定向不会影响任何子键的重定向。

引发一个 审计事件 winreg.DisableReflectionKey 并附带参数 key。

winreg.EnableReflectionKey(key)

恢复已禁用注册表键的重定向。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

如果在 32 位操作系统上执行，一般会触发 NotImplementedError。

恢复注册表键的重定向不会影响任何子键的重定向。

引发一个 审计事件 winreg.EnableReflectionKey 并附带参数 key。

winreg.QueryReflectionKey(key)

确定给定注册表键的重定向状况。

key 为某个已经打开的键，或者预定义的 HKEY_* 常量 之一。

如果重定向已禁用则返回 True。

如果在 32 位操作系统上执行，一般会触发 NotImplementedError。

引发一个 审计事件 winreg.QueryReflectionKey 并附带参数 key。

常量

以下常量定义成可供很多 _winreg 函数使用。

HKEY_* 常量

winreg.HKEY_CLASSES_ROOT

本注册表键下的注册表项定义了文件的类型（或类别）及相关属性。Shell 和 COM 应用程序将使用该注册表键下保存的信息。

winreg.HKEY_CURRENT_USER

属于该注册表键的表项定义了当前用户的偏好。这些偏好值包括环境变量设置、程序组数据、颜色、打印机、网络连接和应用程序参数。

winreg.HKEY_LOCAL_MACHINE

属于该注册表键的表项定义了计算机的物理状态，包括总线类型、系统内存和已安装软硬件等数据。

winreg.HKEY_USERS

属于该注册表键的表项定义了当前计算机中新用户的默认配置和当前用户配置。

winreg.HKEY_PERFORMANCE_DATA

属于该注册表键的表项可用于读取性能数据。这些数据其实并不存放于注册表中；注册表提供功能让系统收集数据。

winreg.HKEY_CURRENT_CONFIG

包含有关本地计算机系统当前硬件配置的信息。

winreg.HKEY_DYN_DATA

Windows 98 以上版本不使用该注册表键。

访问权限

更多信息，请参阅 注册表密钥安全和访问 [https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx]。

winreg.KEY_ALL_ACCESS

组合了 STANDARD_RIGHTS_REQUIRED 、KEY_QUERY_VALUE 、 KEY_SET_VALUE 、 KEY_CREATE_SUB_KEY 、 KEY_ENUMERATE_SUB_KEYS 、 KEY_NOTIFY 和 KEY_CREATE_LINK 访问权限。

winreg.KEY_WRITE

组合了 STANDARD_RIGHTS_WRITE 、 KEY_SET_VALUE 和 KEY_CREATE_SUB_KEY 访问权限。

winreg.KEY_READ

组合了 STANDARD_RIGHTS_READ 、 KEY_QUERY_VALUE 、 KEY_ENUMERATE_SUB_KEYS 和 KEY_NOTIFY 。

winreg.KEY_EXECUTE

等价于 KEY_READ。

winreg.KEY_QUERY_VALUE

查询注册表键值时需要用到。

winreg.KEY_SET_VALUE

创建、删除或设置注册表值时需要用到。

winreg.KEY_CREATE_SUB_KEY

创建注册表键的子键时需要用到。

winreg.KEY_ENUMERATE_SUB_KEYS

枚举注册表键的子键时需要用到。

winreg.KEY_NOTIFY

为注册表键或子键请求修改通知时需要用到。

winreg.KEY_CREATE_LINK

保留给系统使用。

64 位系统特有

详情请参阅 Accessing an Alternate Registry View [https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx]。

winreg.KEY_WOW64_64KEY

表示一个应用程序在 64 位 Windows 上应当在 64 位的注册表视图上进行操作。 在 32 位 Windows 上，此常量会被忽略。

winreg.KEY_WOW64_32KEY

表示一个应用程序在 64 位 Windows 上应当在 32 位的注册表视图上进行操作。 在 32 位 Windows 上，此常量会被忽略。

注册表值的类型

详情请参阅 Registry Value Types [https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx]。

winreg.REG_BINARY

任意格式的二进制数据。

winreg.REG_DWORD

32 位数字。

winreg.REG_DWORD_LITTLE_ENDIAN

32 位低字节序格式的数字。相当于 REG_DWORD。

winreg.REG_DWORD_BIG_ENDIAN

32 位高字节序格式的数字。

winreg.REG_EXPAND_SZ

包含环境变量（%PATH%）的字符串，以空字符结尾。

winreg.REG_LINK

Unicode 符号链接。

winreg.REG_MULTI_SZ

一串以空字符结尾的字符串，最后以两个空字符结尾。Python 会自动处理这种结尾形式。

winreg.REG_NONE

未定义的类型。

winreg.REG_QWORD

64 位数字。

3.6 新版功能.

winreg.REG_QWORD_LITTLE_ENDIAN

64 位低字节序格式的数字。相当于 REG_QWORD。

3.6 新版功能.

winreg.REG_RESOURCE_LIST

设备驱动程序资源列表。

winreg.REG_FULL_RESOURCE_DESCRIPTOR

硬件设置。

winreg.REG_RESOURCE_REQUIREMENTS_LIST

硬件资源列表。

winreg.REG_SZ

空字符结尾的字符串。

注册表句柄对象

该对象封装了 Windows HKEY 对象，对象销毁时会自动关闭。为确保资源得以清理，可调用 Close() 方法或 CloseKey() 函数。

本模块中的所有注册表函数都会返回注册表句柄对象。

本模块中所有接受注册表句柄对象的注册表函数，也能接受一个整数，但鼓励大家使用句柄对象。

注册表句柄对象支持 __bool__() 语义 —— 因此如果当前句柄有效（未关闭或断开连接）：

if handle:
    print("Yes")

将会打印出 Yes 。

句柄对象还支持比较语义，因此若多个句柄对象都引用了同一底层 Windows 句柄值，那么比较操作结果将为 True。

句柄对象可转换为整数（如利用内置函数 int()），这时会返回底层的 Windows 句柄值。用 Detach() 方法也可返回整数句柄，同时会断开与 Windows 句柄的连接。

PyHKEY.Close()

关闭底层的 Windows 句柄。

如果句柄已关闭，不会引发错误。

PyHKEY.Detach()

断开与 Windows 句柄的连接。

结果为一个整数，存有被断开连接之前的句柄值。如果该句柄已断开连接或关闭，则返回 0。

调用本函数后，注册表句柄将被迅速禁用，但并没有关闭。当需要底层的 Win32 句柄在句柄对象的生命周期之后仍然存在时，可以调用这个函数。

引发一个 审计事件 winreg.PyHKEY.Detach 并附带参数 key。

PyHKEY.__enter__()

PyHKEY.__exit__(*exc_info)

HKEY 对象实现了 __enter__() 和 __exit__() 方法，因此支持 with 语句的上下文协议：

with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
    ...  # work with key

在离开 with 语句块时，key 会自动关闭。

winsound —— Windows 系统的音频播放接口

通过 winsound 模块可访问 Windows 平台的基础音频播放机制。包括一些函数和几个常量。

winsound.Beep(frequency, duration)

让 PC 的扬声器发出提示音。frequency 参数可指定声音的频率，单位是赫兹，必须位于 37 到 32,767 之间。duration 参数则指定了声音应持续的毫秒数。若系统无法让扬声器发声，则会触发 RuntimeError。

winsound.PlaySound(sound, flags)

由平台 API 调用底层的 PlaySound() 函数。 参数 sound 可以是文件名、系统音频的别名、bytes-like object 的音频数据或 None。 如何解释取决于 flags 的值，可为以下常数的二进制 OR 组合。 如果 sound 参数为 None，则当前播放的波形音频会全部停止。如果系统报错， 则会触发 RuntimeError。

winsound.MessageBeep(type=MB_OK)

由平台 API 调用底层的 MessageBeep() 函数。用于播放注册表中指定的音频。 type 参数指定播放的音频；可能的值是 -1、MB_ICONASTERISK、MB_ICONEXCLAMATION、MB_ICONHAND、MB_ICONQUESTION 和 MB_OK，下面会介绍。值 -1 会生成一个 "简单的嘀声"；若其他的音频无法播放，这是最后的退路。如果系统报错，则会触发 RuntimeError 。

winsound.SND_FILENAME

参数 sound 指明 WAV 文件名。不要与 SND_ALIAS 一起使用。

winsound.SND_ALIAS

参数 sound 是注册表内关联的音频名称。 如果注册表中无此名称，则播放系统默认的声音，除非同时设定了 SND_NODEFAULT 。 如果没有注册默认声音，则会触发 RuntimeError。 请勿与 SND_FILENAME 一起使用。

所有的 Win32 系统至少支持以下音频名称；大多数系统支持的音频都多于这些：

PlaySound() name 参数 | 对应的控制面板音频名
'SystemAsterisk' | 星号
'SystemExclamation' | 感叹号
'SystemExit' | 退出 Windows
'SystemHand' | 关键性停止
'SystemQuestion' | 问题

例如：

import winsound
# Play Windows exit sound.
winsound.PlaySound("SystemExit", winsound.SND_ALIAS)

# Probably play Windows default sound, if any is registered (because
# "*" probably isn't the registered name of any sound).
winsound.PlaySound("*", winsound.SND_ALIAS)

winsound.SND_LOOP

循环播放音频。为避免阻塞，必须同时使用 SND_ASYNC 标志。不能与 SND_MEMORY 一起使用。

winsound.SND_MEMORY

PlaySound() 的 sound 形参是一个 WAV 文件的内存镜像，作为一个 bytes-like object。

注解

本模块不支持异步播放音频的内存镜像，所以该标志和 SND_ASYNC 的组合将触发 RuntimeError。

winsound.SND_PURGE

停止播放指定音频的所有实例。

注解

新版 Windows 平台不支持本标志。

winsound.SND_ASYNC

立即返回，允许异步播放音频。

winsound.SND_NODEFAULT

即便找不到指定的音频，也不播放系统默认音频。

winsound.SND_NOSTOP

不打断正在播放的音频。

winsound.SND_NOWAIT

如果音频驱动程序忙，则立即返回。

注解

新版 Windows 平台不支持本标志。

winsound.MB_ICONASTERISK

播放 SystemDefault 音频。

winsound.MB_ICONEXCLAMATION

播放 SystemExclamation 音频。

winsound.MB_ICONHAND

播放 SystemHand 音频。

winsound.MB_ICONQUESTION

播放 SystemQuestion 音频。

winsound.MB_OK

播放 SystemDefault 音频。

Unix 专有服务

本章描述的模块提供了 Unix 操作系统独有特性的接口，在某些情况下也适用于它的某些或许多衍生版。 以下为模块概览：

posix --- 最常见的 POSIX 系统调用

大文件支持

重要的模块内容

pwd --- 用户密码数据库

grp --- 组数据库

termios --- POSIX 风格的 tty 控制

示例

tty --- 终端控制功能

pty --- 伪终端工具

示例

fcntl —— 系统调用 fcntl 和 ioctl

resource --- 资源使用信息

资源限制

资源用量

Unix syslog 库例程

例子

简单示例

posix --- 最常见的 POSIX 系统调用

此模块提供了对基于 C 标准和 POSIX 标准（一种稍加修改的 Unix 接口）进行标准化的系统功能的访问。

请勿直接导入此模块。 而应导入 os 模块，它提供了此接口的 可移植 版本。 在 Unix 上，os 模块提供了 posix 接口的一个超集。 在非 Unix 操作系统上 posix 模块将不可用，但会通过 os 接口提供它的一个可用子集。 一旦导入了 os，用它替代 posix 时就 没有 性能惩罚。 此外，os 还提供了一些附加功能，例如在 os.environ 中的某个条目被修改时会自动调用 putenv()。

错误将作为异常被报告；对于类型错误会给出普通异常，而系统调用所报告的异常则会引发 OSError。

大文件支持

某些操作系统（包括 AIX 和 Solaris）可对 int 和 long 为 32 位值的 C 编程模型提供大于 2 GiB 文件的支持。 这在通常情况下是以将相关数据的大小和偏移量类型定义为 64 位值的方式来实现的。 这样的文件有时被称为 大文件。

Python 中的大文件支持会在 off_t 的大小超过 long 且 long long 的大小至少与 off_t 一样时被启用。 要启用此模式可能必须在启用特定编译旗标的情况下配置和编译 Python。 例如，在 Solaris 2.6 和 2.7 中你需要执行这样的操作:

CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \
        ./configure

在支持大文件的 Linux 系统中，可以这样做:

CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \
        ./configure

重要的模块内容

除了 os 模块文档已说明的许多函数，posix 还定义了下列数据项:

posix.environ

一个表示解释器启动时间点的字符串环境的字典。 键和值的类型在Unix 上为 bytes 而在 Windows 上为 str。 例如，environ[b'HOME'] (Windows 上的 environ['HOME']) 是你的家目录的路径名，等价于 C 中的 getenv("HOME")。

修改此字典不会影响由 execv(), popen() 或 system() 所传入的字符串环境；如果你需要修改环境，请将 environ 传给 execve() 或者为 system() 或 popen() 的命令字符串添加变量赋值和 export 语句。

在 3.2 版更改: 在 Unix 上，键和值为 bytes 类型。

注解

os 模块提供了对 environ 的替代实现，它会在被修改时更新环境。 还要注意更新 os.environ 将导致此字典失效。 推荐使用这个 os 模块版本而不是直接访问 posix 模块。

pwd --- 用户密码数据库

此模块可以访问 Unix 用户账户名及密码数据库，在所有 Unix 版本上均可使用。

密码数据库中的条目以元组对象返回，属性对应 passwd 中的结构（属性如下所示，可参考 <pwd.h>）：

索引 | 属性 | 含意
0 | pw_name | 登录名
1 | pw_passwd | 密码，可能已经加密
2 | pw_uid | 用户 ID 数值
3 | pw_gid | 组 ID 数值
4 | pw_gecos | 用户名或备注
5 | pw_dir | 用户主目录
6 | pw_shell | 用户的命令解释器

其中 uid 和 gid 是整数，其他是字符串，如果找不到对应的项目，抛出 KeyError 异常。

注解

传统的 Unix 系统中，pw_passwd 的值通常使用 DES 导出的算法加密（参阅 crypt 模块）。不过现在的 unix 系统使用 影子密码 系统。在这些 unix 上，pw_passwd 只包含星号（'*'）或字母（'x'），而加密的密码存储在文件 /etc/shadow 中，此文件不是全局可读的。在 pw_passwd 中是否包含有用信息是系统相关的。如果可以访问到加密的密码，就需要使用 spwd 模块了。

本模块定义如下内容：

pwd.getpwuid(uid)

给定用户的数值 ID，返回密码数据库的对应项目。

pwd.getpwnam(name)

给定用户名，返回密码数据库的对应项目。

pwd.getpwall()

返回密码数据库中所有项目的列表，顺序不是固定的。

参见

模块 grp

针对用户组数据库的接口，与本模块类似。

模块 spwd

针对影子密码数据库的接口，与本模块类似。

grp --- 组数据库

该模块提供对Unix组数据库的访问。 它在所有Unix版本上都可用。

组数据库条目被报告为类似元组的对象，其属性对应于 group 结构的成员 (下面的属性字段，请参见 <grp.h>):

索引 | 属性 | 含意
0 | gr_name | 组名
1 | gr_passwd | （加密的）组密码； 通常为空
2 | gr_gid | 数字组ID
3 | gr_mem | 组内所有成员的用户名

gid 是整数，名称和密码是字符串，成员列表是字符串列表。 （注意，大多数用户未根据密码数据库显式列为所属组的成员。请检查两个数据库以获取完整的成员资格信息。还要注意，以 + 或 - 开头的 gr_name 可能是 YP/NIS 引用，可能无法通过 getgrnam() 或 getgrgid() 访问。）

本模块定义如下内容：

grp.getgrgid(id)

返回给定数字组 ID 的组数据库条目。 如果请求的条目无法找到则会引发 KeyError。

在 3.10 版更改: 对于非整数参数如浮点数或字符串将引发 TypeError。

grp.getgrnam(name)

返回给定组名的组数据库条目。 如果找不到要求的条目，则会引发 KeyError 错误。

grp.getgrall()

以任意顺序返回所有可用组条目的列表。

参见

模块 pwd

用户数据库的接口，与此类似。

模块 spwd

针对影子密码数据库的接口，与本模块类似。

termios --- POSIX 风格的 tty 控制

此模块提供了针对tty I/O 控制的 POSIX 调用的接口。 有关此类调用的完整描述，请参阅 termios(3) Unix 指南页。 它仅在当安装时配置了支持 POSIX termios 风格的 tty I/O 控制的 Unix 版本上可用。

此模块中的所有函数均接受一个文件描述符 fd 作为第一个参数。 这可以是一个整数形式的文件描述符，例如 sys.stdin.fileno() 所返回的对象，或是一个 file object，例如 sys.stdin 本身。

这个模块还定义了与此处所提供的函数一起使用的所有必要的常量；这些常量与它们在 C 中的对应常量同名。 请参考你的系统文档了解有关如何使用这些终端控制接口的更多信息。

这个模块定义了以下函数：

termios.tcgetattr(fd)

对于文件描述符 fd 返回一个包含 tty 属性的列表，形式如下: [iflag, oflag, cflag, lflag, ispeed, ospeed, cc]，其中 cc 为一个包含 tty 特殊字符的列表（每一项都是长度为 1 的字符串，索引号为 VMIN 和 VTIME 的项除外，这些字段如有定义则应为整数）。 对旗标和速度以及 cc 数组中索引的解读必须使用在 termios 模块中定义的符号常量来完成。

termios.tcsetattr(fd, when, attributes)

根据 attributes 列表设置文件描述符 fd 的 tty 属性，该列表即 tcgetattr() 所返回的对象。 when 参数确定何时改变属性: TCSANOW 表示立即改变，TCSADRAIN 表示在传输所有队列输出后再改变，或 TCSAFLUSH 表示在传输所有队列输出并丢失所有队列输入后再改变。

termios.tcsendbreak(fd, duration)

在文件描述符 fd 上发送一个中断。 duration 为零表示发送时长为 0.25--0.5 秒的中断；duration 非零值的含义取决于具体系统。

termios.tcdrain(fd)

进入等待状态直到写入文件描述符 fd 的所有输出都传送完毕。

termios.tcflush(fd, queue)

在文件描述符 fd 上丢弃队列数据。 queue 选择器指定哪个队列: TCIFLUSH 表示输入队列，TCOFLUSH 表示输出队列，或 TCIOFLUSH 表示两个队列同时。

termios.tcflow(fd, action)

在文件描述符 fd 上挂起一战恢复输入或输出。 action 参数可以为 TCOOFF 表示挂起输出，TCOON 表示重启输出，TCIOFF 表示挂起输入，或 TCION 表示重启输入。

参见

模块 tty

针对常用终端控制操作的便捷函数。

示例

这个函数可提示输入密码并且关闭回显。 请注意其采取的技巧是使用一个单独的 tcgetattr() 调用和一个 try ... finally 语句来确保旧的 tty 属性无论在何种情况下都会被原样保存:

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

tty --- 终端控制功能

Source code: Lib/tty.py [https://github.com/python/cpython/tree/3.10/Lib/tty.py]

tty 模块定义了将 tty 放入 cbreak 和 raw 模式的函数。

因为它需要 termios 模块，所以只能在 Unix 上运行。

tty 模块定义了以下函数：

tty.setraw(fd, when=termios.TCSAFLUSH)

将文件描述符 fd 的模式更改为 raw 。如果 when 被省略，则默认为 termios.TCSAFLUSH ，并传递给 termios.tcsetattr() 。

tty.setcbreak(fd, when=termios.TCSAFLUSH)

将文件描述符 fd 的模式更改为 cbreak 。如果 when 被省略，则默认为 termios.TCSAFLUSH ，并传递给 termios.tcsetattr() 。

参见

模块 termios

低级终端控制接口。

pty --- 伪终端工具

源代码: Lib/pty.py [https://github.com/python/cpython/tree/3.10/Lib/pty.py]

pty 模块定义了一些处理“伪终端”概念的操作：启动另一个进程并能以程序方式在其控制终端中进行读写。

伪终端处理高度依赖于具体平台。 此代码主要针对 Linux, FreeBSD 和 macOS 进行了测试（它应当也能在其他 POSIX 平台上工作，但是未经充分测试）。

pty 模块定义了下列函数:

pty.fork()

分叉。 将子进程的控制终端连接到一个伪终端。 返回值为 (pid, fd)。 请注意子进程获得 pid 0 而 fd 为 invalid。 父进程返回值为子进程的 pid 而 fd 为一个连接到子进程的控制终端（并同时连接到子进程的标准输入和输出）的文件描述符。

pty.openpty()

打开一个新的伪终端对，如果可能将使用 os.openpty()，或是针对通用 Unix 系统的模拟代码。 返回一个文件描述符对 (master, slave)，分别表示主从两端。

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 上）。

从子进程中的 os.waitpid() 返回退出状态值。

可以使用 waitstatus_to_exitcode() 来将退出状态转换为退出码。

引发一个 审计事件 pty.spawn 并附带参数 argv。

在 3.4 版更改: spawn() 现在会从子进程的 os.waitpid() 返回状态值。

示例

以下程序的作用类似于 Unix 命令 script(1)，它使用一个伪终端来记录一个 "typescript" 里终端进程的所有输入和输出:

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)

fcntl —— 系统调用 fcntl 和 ioctl

本模块基于文件描述符来进行文件控制和 I/O 控制。它是 Unix 系统调用 fcntl() 和 ioctl() 的接口。关于这些调用的完整描述，请参阅 Unix 手册的 fcntl(2) 和 ioctl(2) 页面。

本模块的所有函数都接受文件描述符 fd 作为第一个参数。可以是一个整数形式的文件描述符，比如 sys.stdin.fileno() 的返回结果，或为 io.IOBase 对象，比如 sys.stdin 提供一个 fileno()，可返回一个真正的文件描述符。

在 3.3 版更改: 本模块的操作以前触发的是 IOError，现在则会触发 OSError。

在 3.8 版更改: fcntl 模块现在有了 F_ADD_SEALS 、F_GET_SEALS 和 F_SEAL_* 常量，用于文件描述符 os.memfd_create() 的封装。

在 3.9 版更改: 在 macOS 上，fcntl 模块提供了 F_GETPATH 常量，从文件描述符获取文件的路径。 在 Linux(>=3.15) 上，fcntl 模块提供了 F_OFD_GETLK, F_OFD_SETLK 和 F_OFD_SETLKW 常量，它们将在处理打开文件描述锁时被使用。

在 3.10 版更改: 在 Linux 2.6.11 以上版本中，fcntl 模块提供了 F_GETPIPE_SZ 和 F_SETPIPE_SZ 常量，分别用于检查和修改管道的大小。

这个模块定义了以下函数：

fcntl.fcntl(fd, cmd, arg=0)

对文件描述符 fd 执行 cmd 操作（能够提供 fileno() 方法的文件对象也可以接受）。 cmd 可用的值与操作系统有关，在 fcntl 模块中可作为常量使用，名称与相关 C 语言头文件中的一样。参数 arg 可以是整数或 bytes 对象。若为整数值，则本函数的返回值是 C 语言 fcntl() 调用的整数返回值。若为字节串，则其代表一个二进制结构，比如由 struct.pack() 创建的数据。该二进制数据将被复制到一个缓冲区，缓冲区地址传给 C 调用 fcntl()。调用成功后的返回值位于缓冲区内，转换为一个 bytes 对象。返回的对象长度将与 arg 参数的长度相同。上限为 1024 字节。如果操作系统在缓冲区中返回的信息大于 1024 字节，很可能导致内存段冲突，或更为不易察觉的数据错误。

如果 fcntl() 调用失败，会触发 OSError 。

引发一个 审计事件 fcntl.fcntl 并附带参数 fd, cmd, arg。

fcntl.ioctl(fd, request, arg=0, mutate_flag=True)

本函数与 fcntl() 函数相同，只是参数的处理更加复杂。

request 参数的上限是 32位。termios 模块中包含了可用作 request 参数其他常量，名称与相关 C 头文件中定义的相同。

参数 arg 可为整数、支持只读缓冲区接口的对象（如 bytes ）或支持读写缓冲区接口的对象（如 bytearray ）。

除了最后一种情况，其他情况下的行为都与 fcntl() 函数一样。

如果传入的是个可变缓冲区，那么行为就由 mutate_flag 参数决定。

如果 mutate_flag 为 False，缓冲区的可变性将被忽略，行为与只读缓冲区一样，只是没有了上述 1024 字节的上限——只要传入的缓冲区能容纳操作系统放入的数据即可。

如果 mutate_flag 为 True（默认值），那么缓冲区（实际上）会传给底层的 系统调用 ioctl() ，其返回代码则会回传给调用它的 Python，而缓冲区的新数据则反映了 ioctl() 的运行结果。这里做了一点简化，因为若是给出的缓冲区少于 1024 字节，首先会被复制到一个 1024 字节长的静态缓冲区再传给 ioctl() ，然后把结果复制回给出的缓冲区去。

如果 ioctl() 调用失败，则会触发 OSError 异常。

举个例子：

>>> 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])

引发一个 审计事件 fcntl.ioctl 并附带参数 fd, request, arg。

fcntl.flock(fd, operation)

在文件描述符 fd 上执行加锁操作 operation (也接受能提供 fileno() 方法的文件对象)。 详见 Unix 手册 flock(2)。 (在某些系统中，此函数是用 fcntl() 模拟出来的。)

如果 flock() 调用失败，就会触发 OSError 异常。

引发一个 审计事件 fcntl.flock 并附带参数 fd, operation。

fcntl.lockf(fd, cmd, len=0, start=0, whence=0)

本质上是对 fcntl() 加锁调用的封装。fd 是要加解锁的文件描述符（也接受能提供 fileno() 方法的文件对象），cmd 是以下值之一：

LOCK_UN ——解锁

LOCK_SH —— 获取一个共享锁

LOCK_EX —— 获取一个独占锁

如果 cmd 为 LOCK_SH 或 LOCK_EX，则还可以与 LOCK_NB 进行按位或运算，以避免在获取锁时出现阻塞。 如果用了 LOCK_NB，无法获取锁时将触发 OSError，此异常的 errno 属性将被设为 EACCES 或 EAGAIN (视操作系统而定；为了保证可移植性，请检查这两个值)。 至少在某些系统上，只有当文件描述符指向需要写入而打开的文件时，才可以使用 LOCK_EX。

len 是要锁定的字节数，start 是自 whence 开始锁定的字节偏移量，whence 与 io.IOBase.seek() 的定义一样。

0 —— 自文件起始位置（os.SEEK_SET）。

1 —— 自缓冲区当前位置（ os.SEEK_CUR ）

2—— 自文件末尾（os.SEEK_END)

start 的默认值为 0，表示从文件起始位置开始。len 的默认值是 0，表示加锁至文件末尾。 whence 的默认值也是 0。

引发一个 审计事件 fcntl.lockf 并附带参数 fd, cmd, len, start, whence。

示例（都是运行于符合 SVR4 的系统）：

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)

注意，在第一个例子中，返回值变量 rv 将存有整数；在第二个例子中，该变量中将存有一个 bytes 对象。lockdata 变量的结构布局视系统而定——因此采用 flock() 调用可能会更好。

参见

模块 os

如果 os 模块中存在加锁标志 O_SHLOCK 和 O_EXLOCK （仅在BSD上），那么 os.open() 函数提供了 lockf() 和 flock() 函数的替代方案。

resource --- 资源使用信息

该模块提供了测量和控制程序所利用的系统资源的基本机制。

符号常量被用来指定特定的系统资源，并要求获得关于当前进程或其子进程的使用信息。

当系统调用失败时，会触发一个 OSError 。

exception resource.error

一个被弃用的 OSError 的别名。

在 3.3 版更改: 根据 PEP 3151 [https://www.python.org/dev/peps/pep-3151]，这个类是 OSError 的别名。

资源限制

资源的使用可以通过下面描述的 setrlimit() 函数来限制。每个资源都被一对限制所控制：一个软限制和一个硬限制。软限制是当前的限制，并且可以由一个进程随着时间的推移而降低或提高。软限制永远不能超过硬限制。硬限制可以降低到大于软限制的任何数值，但不能提高。（只有拥有超级用户有效UID的进程才能提高硬限制。)

可以被限制的具体资源取决于系统。它们在 man getrlimit(2) 中描述。 下面列出的资源在底层操作系统支持的情况下被支持；那些不能被操作系统检查或控制的资源在本模块中没有为这些平台定义。

resource.RLIM_INFINITY

用来表示无限资源的极限的常数。

resource.getrlimit(resource)

返回一个包含 resource 当前软限制和硬限制的元组。如果指定了一个无效的资源，则触发 ValueError ，如果底层系统调用意外失败，则引发 error 。

resource.setrlimit(resource, limits)

设置 resource 的新的消耗极限。参数 limits 必须是一个由两个整数组成的元组 (soft, hard) ，描述了新的限制。 RLIM_INFINITY 的值可以用来请求一个无限的限制。

如果指定了一个无效的资源，如果新的软限制超过了硬限制，或者如果一个进程试图提高它的硬限制，将触发 ValueError 。当资源的硬限制或系统限制不是无限时，指定一个 RLIM_INFINITY 的限制将导致 ValueError 。 一个有效 UID 为超级用户的进程可以请求任何有效的限制值，包括无限，但如果请求的限制超过了系统规定的限制，则仍然会产生 ValueError 。

如果底层系统调用失败， setrlimit 也可能触发 error 。

VxWorks只支持设置 RLIMIT_NOFILE 。

引发一个 审计事件 resource.setrlimit 并附带参数 resource, limits。

resource.prlimit(pid, resource[, limits])

将 setrlimit() 和 getrlimit() 合并为一个函数，支持获取和设置任意进程的资源限制。如果 pid 为0，那么该调用适用于当前进程。 resource 和 limits 的含义与 setrlimit() 相同，只是 limits 是可选的。

当 limits 没有给出时，该函数返回进程 pid 的 resource 限制。当 limits 被给定时，进程的 resource 限制被设置，并返回以前的资源限制。

当 pid 找不到时，触发 ProcessLookupError ；当用户没有进程的 CAP_SYS_RESOURCE 时，触发 PermissionError 。

引发一个 审计事件 resource.prlimit 并附带参数 pid, resource, limits。

Availability: Linux 2.6.36 或更新版本带有 glibc 2.13 或更新版本

3.4 新版功能.

这些符号定义了资源的消耗可以通过下面描述的 setrlimit() 和 getrlimit() 函数来控制。这些符号的值正是 C 程序所使用的常数。

Unix man 页面 getrlimit(2) 列出了可用的资源。注意，并非所有系统都使用相同的符号或相同的值来表示相同的资源。本模块并不试图掩盖平台的差异——没有为某一平台定义的符号在该平台上将无法从本模块中获得。

resource.RLIMIT_CORE

当前进程可以创建的核心文件的最大大小（以字节为单位）。如果需要更大的核心文件来包含整个进程的镜像，这可能会导致创建一个部分核心文件。

resource.RLIMIT_CPU

一个进程可以使用的最大处理器时间（以秒为单位）。如果超过了这个限制，一个 SIGXCPU 信号将被发送给进程。（参见 signal 模块文档，了解如何捕捉这个信号并做一些有用的事情，例如，将打开的文件刷新到磁盘上）。

resource.RLIMIT_FSIZE

进程可能创建的文件的最大大小。

resource.RLIMIT_DATA

进程的堆的最大大小（以字节为单位）。

resource.RLIMIT_STACK

当前进程的调用堆栈的最大大小（字节）。 这只影响到多线程进程中主线程的堆栈。

resource.RLIMIT_RSS

应该提供给进程的最大常驻内存大小。

resource.RLIMIT_NPROC

当前进程可能创建的最大进程数。

resource.RLIMIT_NOFILE

当前进程打开的文件描述符的最大数量。

resource.RLIMIT_OFILE

BSD 对 RLIMIT_NOFILE 的命名。

resource.RLIMIT_MEMLOCK

可能被锁定在内存中的最大地址空间。

resource.RLIMIT_VMEM

进程可能占用的最大映射内存区域。

resource.RLIMIT_AS

进程可能占用的地址空间的最大区域（以字节为单位）。

resource.RLIMIT_MSGQUEUE

可分配给 POSIX 消息队列的字节数。

Availability: Linux 2.6.8 或更新版本。

3.4 新版功能.

resource.RLIMIT_NICE

进程的 Nice 级别的上限（计算为 20 - rlim_cur ）。

Availability: Linux 2.6.12 或更新版本

3.4 新版功能.

resource.RLIMIT_RTPRIO

实时优先级的上限。

Availability: Linux 2.6.12 或更新版本

3.4 新版功能.

resource.RLIMIT_RTTIME

在实时调度下，一个进程在不进行阻塞性系统调用的情况下，可以花费的 CPU 时间限制（以微秒计）。

Availability: Linux 2.6.25 或更新版本

3.4 新版功能.

resource.RLIMIT_SIGPENDING

进程可能排队的信号数量。

Availability: Linux 2.6.8 或更新版本。

3.4 新版功能.

resource.RLIMIT_SBSIZE

这个用户使用的套接字缓冲区的最大大小（字节数）。这限制了这个用户在任何时候都可以持有的网络内存数量，因此也限制了 mbufs 的数量。

Availability: FreeBSD 9 或更新版本

3.4 新版功能.

resource.RLIMIT_SWAP

这个用户 ID 的所有进程可能保留或使用的交换空间的最大大小（字节数）。这个限制只有在 vm.overcommit sysctl的第 1 位被置 1 时才会被强制执行。请参阅 tuning(7) [https://www.freebsd.org/cgi/man.cgi?query=tuning&sektion=7] 以获得关于这个系统检测器的完整介绍。

Availability: FreeBSD 9 或更新版本

3.4 新版功能.

resource.RLIMIT_NPTS

该用户 ID 创建的伪终端的最大数量。

Availability: FreeBSD 9 或更新版本

3.4 新版功能.

resource.RLIMIT_KQUEUES

这个用户 ID 被允许创建的最大 kqueue 数量。

Availability: FreeBSD 11 或更新版本。

3.10 新版功能.

资源用量

这些函数被用来检索资源使用信息。

resource.getrusage(who)

这个函数返回一个对象，描述当前进程或其子进程所消耗的资源，由 who 参数指定。 who 参数应该使用下面描述的 RUSAGE_* 常数之一来指定。

一个简单的示例：

from resource import *
import time

# a non CPU-bound task
time.sleep(3)
print(getrusage(RUSAGE_SELF))

# a CPU-bound task
for i in range(10 ** 8):
   _ = 1 + 1
print(getrusage(RUSAGE_SELF))

返回值的字段分别描述了某一特定系统资源的使用情况，例如，在用户模式下运行的时间或进程从主内存中换出的次数。有些值取决于内部的时钟周期，例如进程使用的内存量。

为了向后兼容，返回值也可以作为一个 16 个元素的元组来访问。

返回值中的 ru_utime 和 ru_stime 字段是浮点值，分别代表在用户模式下执行的时间和在系统模式下执行的时间。其余的值是整数。关于这些值的详细信息，请查阅 getrusage(2) man page 。这里介绍一个简短的摘要。

索引 | 域 | 资源
0 | ru_utime | 用户模式下的时间（浮点数秒）
1 | ru_stime | 系统模式下的时间（浮点数秒）
2 | ru_maxrss | 最大的常驻内存大小
3 | ru_ixrss | 共享内存大小
4 | ru_idrss | 未共享的内存大小
5 | ru_isrss | 未共享的堆栈大小
6 | ru_minflt | 不需要 I/O 的页面故障数
7 | ru_majflt | 需要 I/O 的页面故障数
8 | ru_nswap | swap out 的数量
9 | ru_inblock | 块输入操作数
10 | ru_oublock | 块输出操作数
11 | ru_msgsnd | 发送消息数
12 | ru_msgrcv | 收到消息数
13 | ru_nsignals | 收到信号数
14 | ru_nvcsw | 主动上下文切换
15 | ru_nivcsw | 被动上下文切换

如果指定了一个无效的 who 参数，这个函数将触发一个 ValueError 。在特殊情况下，它也可能触发 error 异常。

resource.getpagesize()

返回一个系统页面的字节数。（这不需要和硬件页的大小相同）。

下面的 RUSAGE_* 符号被传递给 getrusage() 函数，以指定应该为哪些进程提供信息。

resource.RUSAGE_SELF

传递给 getrusage() 以请求调用进程消耗的资源，这是进程中所有线程使用的资源总和。

resource.RUSAGE_CHILDREN

传递给 getrusage() 以请求被终止和等待的调用进程的子进程所消耗的资源。

resource.RUSAGE_BOTH

传递给 getrusage() 以请求当前进程和子进程所消耗的资源。并非所有系统都能使用。

resource.RUSAGE_THREAD

传递给 getrusage() 以请求当前线程所消耗的资源。 并非所有系统都能使用。

3.2 新版功能.

Unix syslog 库例程

此模块提供一个接口到Unix syslog 日常库. 参考 Unix 手册页关于 syslog 设施的详细描述.

此模块包装了系统的 syslog 例程族。 一个能与 syslog 服务器对话的纯 Python 库则以 logging.handlers 模块中 SysLogHandler 类的形式提供。

这个模块定义了以下函数：

syslog.syslog(message)

syslog.syslog(priority, message)

将字符串 message 发送到系统日志记录器。 如有必要会添加末尾换行符。 每条消息都带有一个由 facility 和 level 组成的优先级标价签。 可选的 priority 参数默认值为 LOG_INFO，它确定消息的优先级。 如果未在 priority 中使用逻辑或 (LOG_INFO | LOG_USER) 对 facility 进行编码，则会使用在 openlog() 调用中所给定的值。

如果 openlog() 未在对 syslog() 的调用之前被调用，则将不带参数地调用 openlog()。

引发一个 审计事件 syslog.syslog 并附带参数 priority, message。

在 3.2 版更改: 在之前的版本中，如果 openlog() 未在对 syslog() 的调用之前被调用则它将不会被自动调用，而是由 syslog 实现来负责调用 openlog()。

syslog.openlog([ident[, logoption[, facility]]])

后续 syslog() 调用的日志选项可以通过调用 openlog() 来设置。 如果日志当前未打开则 syslog() 将不带参数地调用 openlog()。

可选的 ident 关键字参数是在每条消息前添加的字符串，默认为 sys.argv[0] 去除打头的路径部分。 可选的 logoption 关键字参数（默认为 0）是一个位字段 -- 请参见下文了解可能的组合值。 可选的 facility 关键字参数 (默认为 LOG_USER) 为没有显式编码 facility 的消息设置默认的 facility。

引发一个 审计事件 syslog.openlog 并附带参数 ident, logoption, facility。

在 3.2 版更改: 在之前的版本中，不允许使用关键字参数，并且要求必须有 ident。

syslog.closelog()

重置日志模块值并且调用系统库 closelog().

这使得此模块在初始导入时行为固定。 例如，openlog() 将在首次调用 syslog() 时被调用（如果 openlog() 还未被调用过），并且 ident 和其他 openlog() 形参会被重置为默认值。

引发一个不带参数的 审计事件 syslog.closelog。

syslog.setlogmask(maskpri)

将优先级掩码设为 maskpri 并返回之前的掩码值。 调用 syslog() 并附带未在 maskpri 中设置的优先级将会被忽略。 默认设置为记录所有优先级。 函数 LOG_MASK(pri) 可计算单个优先级 pri 的掩码。 函数 LOG_UPTO(pri) 可计算包括 pri 在内的所有优先级的掩码。

引发一个 审计事件 syslog.setlogmask 并附带参数 maskpri。

此模块定义了一下常量:

优先级级别 (高到低):

LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG.

设施:

LOG_KERN, LOG_USER, LOG_MAIL, LOG_DAEMON, LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP, LOG_CRON, LOG_SYSLOG, LOG_LOCAL0 to LOG_LOCAL7，如果 <syslog.h> 中有定义则还有 LOG_AUTHPRIV。

日志选项：

LOG_PID, LOG_CONS, LOG_NDELAY，如果 <syslog.h> 中有定义则还有 LOG_ODELAY, LOG_NOWAIT 以及 LOG_PERROR。

例子

简单示例

一个简单的示例集:

import syslog

syslog.syslog('Processing started')
if error:
    syslog.syslog(syslog.LOG_ERR, 'Processing started')

一个设置多种日志选项的示例，其中有在日志消息中包含进程 ID，以及将消息写入用于邮件日志记录的目标设施等:

syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL)
syslog.syslog('E-mail processing initiated...')

被取代的模块

本章中描述的模块均已弃用，仅保留用于向后兼容。 它们已经被其他模块所取代。

aifc --- 读写 AIFF 和 AIFC 文件

asynchat --- 异步套接字指令/响应处理程序

asynchat 示例

asyncore --- 异步套接字处理器

asyncore 示例基本 HTTP 客户端

asyncore 示例基本回显服务器

audioop --- 处理原始音频数据

cgi --- 通用网关接口支持

概述

使用 cgi 模块

更高层级的接口

函数

对于安全性的关注

在 Unix 系统上安装你的 CGI 脚本

测试你的 CGI 脚本

调试 CGI 脚本

常见问题和解决方案

cgitb --- 用于 CGI 脚本的回溯管理器

chunk --- 读取 IFF 分块数据

crypt —— 验证 Unix 口令的函数

哈希方法

模块属性

模块函数

例子

imghdr --- 推测图像类型

imp --- 访问 import 内部对象

例子

mailcap --- Mailcap 文件处理

msilib --- 读写 Microsoft Installer 文件

数据对象

视图对象

对象总览

记录对象

错误

CAB 对象

目录对象

相关特性

GUI 类

预计算的表

nis --- Sun 的 NIS (黄页) 接口

nntplib --- NNTP 协议客户端

NNTP 对象

属性

方法

工具函数

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

背景

术语

选项的作用是什么？

位置参数有什么用？

教程

理解选项动作

store 动作

处理布尔值（旗标）选项

其他动作

默认值

生成帮助

选项分组

打印版本字符串

optparse 如何处理错误handles errors

合并所有代码

参考指南

创建解析器

填充解析器

定义选项

选项属性

标准选项动作

标准选项类型

解析参数

查询和操纵你的选项解析器

选项之间的冲突

清理

其他方法

选项回调

定义回调选项

回调应当如何调用

在回调中引发错误

回调示例 1：最简回调

回调示例 2：检查选项顺序

回调示例 3：检查选项顺序（通用）

回调示例 4：检查任意条件

回调示例 5：固定的参数

回调示例 6：可变的参数

扩展 optparse

添加新的类型

添加新的动作

ossaudiodev --- 访问兼容OSS的音频设备

音频设备对象

混音器设备对象

pipes --- 终端管道接口

模板对象

smtpd --- SMTP 服务器

SMTPServer 对象

DebuggingServer 对象

PureProxy 对象

MailmanProxy 对象

SMTPChannel 对象

sndhdr --- 推测声音文件的类型

spwd —— shadow 密码库

sunau --- 读写 Sun AU 文件

AU_read 对象

AU_write 对象

telnetlib -- Telnet 客户端

Telnet 对象

Telnet 示例

uu --- 对 uuencode 文件进行编码与解码

xdrlib --- 编码与解码 XDR 数据

Packer 对象

Unpacker 对象

异常

aifc --- 读写 AIFF 和 AIFC 文件

源代码： Lib/aifc.py [https://github.com/python/cpython/tree/3.10/Lib/aifc.py]

3.11 版后已移除: aifc 模块已被弃用（详见 PEP 594 [https://www.python.org/dev/peps/pep-0594#aifc]）

本模块为读写 AIFF 和 AIFF-C 文件提供支持。AIFF 是音频交换文件格式 (Audio Interchange File Format)，一种用于在文件中存储数字音频采样的格式。AIFF-C 是该格式的新版本，包含了压缩音频数据的功能。

音频文件内有许多参数，用于描述音频数据。采样率或帧率是每秒对声音采样的次数。通道数表示音频是单声道，双声道还是四声道。每个通道的每个帧包含一次采样。采样大小是以字节表示的每次采样的大小。因此，一帧由 nchannels * samplesize （通道数*采样大小）字节组成，而一秒钟的音频包含 nchannels * samplesize * framerate （通道数*采样大小*帧率）字节。

例如，CD 质量的音频采样大小为 2 字节（16位），使用 2 个声道（立体声），且帧速率为 44,100 帧/秒。这表示帧大小为 4 字节 (2*2)，一秒钟占用 2*2*44100 字节（176,400 字节）。

aifc 模块定义了以下函数：

aifc.open(file, mode=None)

打开一个 AIFF 或 AIFF-C 文件并返回一个对象实例，该实例具有下方描述的方法。参数 file 是文件名称字符串或 文件对象。当打开文件用于读取时，mode 必须为 'r' 或 'rb'，当打开文件用于写入时，mode 必须为 'w' 或 'wb'。如果该参数省略，则使用 file.mode 的值（如果有），否则使用 'rb'。当文件用于写入时，文件对象应该支持 seek 操作，除非提前获知写入的采样总数，并使用 writeframesraw() 和 setnframes()。open() 函数可以在 with 语句中使用。当 with 块执行完毕，将调用 close() 方法。

在 3.4 版更改: 添加了对 with 语句的支持。

当打开文件用于读取时，由 open() 返回的对象具有以下几种方法：

aifc.getnchannels()

返回音频的通道数（单声道为 1，立体声为 2）。

aifc.getsampwidth()

返回以字节表示的单个采样的大小。

aifc.getframerate()

返回采样率（每秒的音频帧数）。

aifc.getnframes()

返回文件中的音频帧总数。

aifc.getcomptype()

返回一个长度为 4 的字节数组，描述了音频文件中使用的压缩类型。对于 AIFF 文件，返回值为 b'NONE'。

aifc.getcompname()

返回一个字节数组，可转换为人类可读的描述，描述的是音频文件中使用的压缩类型。对于 AIFF 文件，返回值为 b'not compressed'。

aifc.getparams()

返回一个 namedtuple() (nchannels, sampwidth, framerate, nframes, comptype, compname)，与 get*() 方法的输出相同。

aifc.getmarkers()

返回一个列表，包含音频文件中的所有标记。标记由一个 3 元素的元组组成。第一个元素是标记 ID（整数），第二个是标记位置，从数据开头算起的帧数（整数），第三个是标记的名称（字符串）。

aifc.getmark(id)

根据传入的标记 id 返回元组，元组与 getmarkers() 中描述的一致。

aifc.readframes(nframes)

从音频文件读取并返回后续 nframes 个帧。返回的数据是一个字符串，包含每个帧所有通道的未压缩采样值。

aifc.rewind()

倒回读取指针。下一次 readframes() 将从头开始。

aifc.setpos(pos)

移动读取指针到指定的帧上。

aifc.tell()

返回当前的帧号。

aifc.close()

关闭 AIFF 文件。调用此方法后，对象将无法再使用。

打开文件用于写入时，open() 返回的对象具有上述所有方法，但 readframes() 和 setpos() 除外，并额外具备了以下方法。只有调用了 set*() 方法之后，才能调用相应的 get*() 方法。在首次调用 writeframes() 或 writeframesraw() 之前，必须填写除帧数以外的所有参数。

aifc.aiff()

创建一个 AIFF 文件，默认创建 AIFF-C 文件，除非文件名以 '.aiff' 为后缀，在此情况下默认创建 AIFF 文件。

aifc.aifc()

创建一个 AIFF-C 文件。 默认创建 AIFF-C 文件，除非文件名以 '.aiff' 为后缀，在此情况下默认创建 AIFF 文件。

aifc.setnchannels(nchannels)

指明音频文件中的通道数。

aifc.setsampwidth(width)

指明以字节为单位的音频采样大小。

aifc.setframerate(rate)

指明以每秒帧数表示的采样频率。

aifc.setnframes(nframes)

指明要写入到音频文件的帧数。 如果未设定此形参或者未正确设定，则文件需要支持位置查找。

aifc.setcomptype(type, name)

指明压缩类型。 如果未指明，则音频数据将不会被压缩。 在 AIFF 文件中，压缩是无法实现的。 name 形参应当为以字节数组表示的人类可读的压缩类型描述，type 形参应当为长度为 4 的字节数组。 目前支持的压缩类型如下: b'NONE', b'ULAW', b'ALAW', b'G722'。

aifc.setparams(nchannels, sampwidth, framerate, comptype, compname)

一次性设置上述所有参数。 该参数是由多个形参组成的元组。 这意味着可以使用 getparams() 调用的结果作为 setparams() 的参数。

aifc.setmark(id, pos, name)

添加具有给定 id (大于 0)，以及在给定位置上给定名称的标记。 此方法可在 close() 之前的任何时候被调用。

aifc.tell()

返回输出文件中的当前写入位置。 适用于与 setmark() 进行协同配合。

aifc.writeframes(data)

将数据写入到输出文件。 此方法只能在设置了音频文件形参之后被调用。

在 3.4 版更改: 现在可接受任意 bytes-like object。

aifc.writeframesraw(data)

类似于 writeframes()，不同之处在于音频文件的标头不会被更新。

在 3.4 版更改: 现在可接受任意 bytes-like object。

aifc.close()

关闭 AIFF 文件。 文件的标头会被更新以反映音频数据的实际大小。 在调用此方法之后，对象将无法再被使用。

asynchat --- 异步套接字指令/响应处理程序

源代码: Lib/asynchat.py [https://github.com/python/cpython/tree/3.10/Lib/asynchat.py]

3.6 版后已移除: asynchat 将在 Python 3.12 版被移除（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#asynchat] 了解详情）。 请改用 asyncio。

注解

该模块仅为提供向后兼容。我们推荐在新代码中使用 asyncio 。

此模块在 asyncore 框架之上构建，简化了异步客户端和服务器并使得处理元素为以任意字符串结束或者为可变长度的协议更加容易。 asynchat 定义了一个可以由你来子类化的抽象类 async_chat，提供了 collect_incoming_data() 和 found_terminator() 等方法的实现。 它使用与 asyncore 相同的异步循环，并且可以在通道映射中自由地混合 asyncore.dispatcher 和 asynchat.async_chat 这两种类型的通道。 一般来说 asyncore.dispatcher 服务器通道在接收到传入的连接请求时会生成新的 asynchat.async_chat 通道对象。

class asynchat.async_chat

这个类是 asyncore.dispatcher 的抽象子类。 对于实际使用的代码你必须子类化 async_chat，提供有意义的 collect_incoming_data() 和 found_terminator() 方法。 asyncore.dispatcher 的方法也可以被使用，但它们在消息/响应上下文中并不是全都有意义。

与 asyncore.dispatcher 类似，async_chat 也定义了一组通过对 select() 调用之后的套接字条件进行分析所生成的事件。 一旦启动轮询循环 async_chat 对象的方法就会被事件处理框架调用而无须程序员方面做任何操作。

两个可被修改的类属性，用以提升性能，甚至也可能会节省内存。

ac_in_buffer_size

异步输入缓冲区大小 (默认为 4096)。

ac_out_buffer_size

异步输出缓冲区大小 (默认为 4096)。

与 asyncore.dispatcher 不同，async_chat 允许你定义一个 FIFO 队列 producers。 其中的生产者只需要一个方法 more()，该方法应当返回要在通道上传输的数据。 生产者通过让其 more() 方法返回空字节串对象来表明其处于耗尽状态 (意即 它已不再包含数据)。 此时 async_chat 对象会将该生产者从队列中移除并开始使用下一个生产者，如果有下一个的话。 当生产者队列为空时 handle_write() 方法将不执行任何操作。 你要使用通道对象的 set_terminator() 方法来描述如何识别来自远程端点的入站传输的结束或是重要的中断点。

要构建一个可用的 async_chat 子类，你的输入方法 collect_incoming_data() 和 found_terminator() 必须要处理通道异步接收的数据。 这些参数的描述见下文。

async_chat.close_when_done()

将 None 推入生产者队列。 当此生产者被弹出队列时它将导致通道被关闭。

async_chat.collect_incoming_data(data)

调用时附带 data，其中包含任意数量的已接收数据。 必须被重载的默认方法将引发一个 NotImplementedError 异常。

async_chat.discard_buffers()

在紧急情况下此方法将丢弃输入和/或输出缓冲区以及生产者队列中的任何数据。

async_chat.found_terminator()

当输入数据流能匹配 set_terminator() 所设定的终结条件时会被调用。 必须被重载的默认方法将引发一个 NotImplementedError 异常。 被缓冲的输入数据应当可以通过实例属性来获取。

async_chat.get_terminator()

返回通道的当前终结器。

async_chat.push(data)

将数据推入通道的队列以确保其被传输。 要让通道将数据写到网络中你只需要这样做就足够了，虽然以更复杂的方式使用你自己的生产者也是有可能的，例如为了实现加密和分块。

async_chat.push_with_producer(producer)

获取一个生产者对象并将其加入到与通道相关联的生产者队列中。 当所有当前已推入的生产者都已被耗尽时通道将通过调用其 more() 方法来耗用此生产者的数据并将数据发送至远程端点。

async_chat.set_terminator(term)

设置可在通道上被识别的终结条件。 term 可以是三种类型值中的任意一种 ，对应于处理入站协议数据的三种不同方式。

term | 描述
string | 当在输入流中发现该字符串时将会调用 found_terminator()
integer | 当接收到指定数量的字符时将会调用 found_terminator()
None | 通道会不断地持续收集数据

请注意终结器之后的任何数据将可在 found_terminator() 被调用后由通道来读取。

asynchat 示例

下面的例子片段显示了如何通过 async_chat 来读取 HTTP 请求。 Web 服务器可以为每个入站的客户端连接创建 http_request_handler 对象。 请注意在初始时通道终结器会被设置为匹配 HTTP 标头末尾的空行，并且会用一个旗标来指明标头正在被读取。

一旦完成了标头的读取，如果请求类型为 POST (表明输入流中存在更多的数据) 则会使用 Content-Length: 标头来设置一个数值终结器以从通道读取适当数量的数据。

一旦完成了对所有相关输入的处理，将会在设置通道终结器为 None 以确保忽略掉 Web 客户端所发送的任何无关数据之后调用 handle_request() 方法。

import asynchat

class http_request_handler(asynchat.async_chat):

    def __init__(self, sock, addr, sessions, log):
        asynchat.async_chat.__init__(self, sock=sock)
        self.addr = addr
        self.sessions = sessions
        self.ibuffer = []
        self.obuffer = b""
        self.set_terminator(b"\r\n\r\n")
        self.reading_headers = True
        self.handling = False
        self.cgi_data = None
        self.log = log

    def collect_incoming_data(self, data):
        """Buffer the data"""
        self.ibuffer.append(data)

    def found_terminator(self):
        if self.reading_headers:
            self.reading_headers = False
            self.parse_headers(b"".join(self.ibuffer))
            self.ibuffer = []
            if self.op.upper() == b"POST":
                clen = self.headers.getheader("content-length")
                self.set_terminator(int(clen))
            else:
                self.handling = True
                self.set_terminator(None)
                self.handle_request()
        elif not self.handling:
            self.set_terminator(None)  # browsers sometimes over-send
            self.cgi_data = parse(self.headers, b"".join(self.ibuffer))
            self.handling = True
            self.ibuffer = []
            self.handle_request()

asyncore --- 异步套接字处理器

源码： Lib/asyncore.py [https://github.com/python/cpython/tree/3.10/Lib/asyncore.py]

3.6 版后已移除: asyncore 将在 Python 3.12 版被移除（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#asyncore] 了解详情）。 请改用 asyncio。

注解

该模块仅为提供向后兼容。我们推荐在新代码中使用 asyncio 。

该模块提供用于编写异步套接字服务客户端与服务端的基础构件。

只有两种方法让单个处理器上的程序“同一时间完成不止一件事”。 多线程编程是最简单和最流行的方法，但是还有另一种非常不同的技术，它可以让你拥有多线程的几乎所有优点，而无需实际使用多线程。 它仅仅在你的程序主要受 I/O 限制时有用，那么。 如果你的程序受处理器限制，那么先发制人的预定线程可能就是你真正需要的。 但是，网络服务器很少受处理器限制。

如果你的操作系统在其 I/O 库中支持 select() 系统调用（几乎所有操作系统），那么你可以使用它来同时处理多个通信通道；在 I/O 正在“后台”时进行其他工作。 虽然这种策略看起来很奇怪和复杂，特别是起初，它在很多方面比多线程编程更容易理解和控制。 asyncore 模块为您解决了许多难题，使得构建复杂的高性能网络服务器和客户端的任务变得轻而易举。 对于“会话”应用程序和协议，伴侣 asynchat 模块是非常宝贵的。

这两个模块背后的基本思想是创建一个或多个网络 通道 ，类的实例 asyncore.dispatcher 和 asynchat.async_chat 。 创建通道会将它们添加到全局映射中，如果你不为它提供自己的 映射 ，则由 loop() 函数使用。

一旦创建了初始通道，调用 loop() 函数将激活通道服务，该服务将一直持续到最后一个通道（包括在异步服务期间已添加到映射中的任何通道）关闭。

asyncore.loop([timeout[, use_poll[, map[, count]]]])

进入一个轮询循环，其在循环计数超出或所有打开的通道关闭后终止。 所有参数都是可选的。 count 形参默认为 None ，导致循环仅在所有通道关闭时终止。 timeout 形参为适当的 select() 或 poll() 调用设置超时参数，以秒为单位; 默认值为30秒。 use_poll 形参，如果为 True ，则表示 poll() 应优先使用 select() (默认为 False)。

map 形参是一个条目为所监视通道的字典。 当通道关闭时它们会被从映射中删除。 如果省略 map，则会使用一个全局映射。 通道 (asyncore.dispatcher, asynchat.async_chat 及其子类的实例) 可以在映射中任意混合。

class asyncore.dispatcher

dispatcher 类是对低层级套接字对象的轻量包装器。 要让它更有用处，可以从异步循环调用一些事件处理方法。 在其他方面，它可以被当作是普通的非阻塞型套接字对象。

在特定时间或特定连接状态下触发的低层级事件可通知异步循环发生了特定的高层级事件。 例如，如果我们请求了一个套接字以连接到另一台主机，我们会在套接字首次变得可写时得知连接已建立（在此刻你将知道可以向其写入并预期能够成功）。 包含的高层级事件有:

事件 | 描述
handle_connect() | 由首个读取或写入事件引起
handle_close() | 由不带可用数据的读取事件引起
handle_accepted() | 由在监听套接字上的读取事件引起

在异步处理过程中，每个已映射通道的 readable() 和 writable() 方法会被用来确定是否要将通道的套接字添加到已执行 select() 或 poll() 用于读取和写入事件的通道列表中。

因此，通道事件的集合要大于基本套接字事件。 可以在你的子类中被重载的全部方法集合如下:

handle_read()

当异步循环检测到通道的套接字上的 read() 调用将要成功时会被调用。

handle_write()

当异步循环检测到一个可写套接字可以被写入时会被调用。 通常此方法将实现必要的缓冲机制以保证运行效率。 例如:

def handle_write(self):
    sent = self.send(self.buffer)
    self.buffer = self.buffer[sent:]

handle_expt()

当一个套接字连接存在带外（OOB）数据时会被调用。 这几乎从来不会发生，因为 OOB 虽然受支持但很少被使用。

handle_connect()

当活动打开方的套接字实际建立连接时会被调用。 可能会发送一条“欢迎”消息，或者向远程端点发起协议协商等。

handle_close()

当套接字关闭时会被调用。

handle_error()

当一个异常被引发并且未获得其他处理时会被调用。 默认版本将打印精简的回溯信息。

handle_accept()

当可以与发起对本地端点的 connect() 调用的新远程端点建立连接时会在侦听通道（被动打开方）上被调用。 在 3.2 版中已被弃用；请改用 handle_accepted()。

3.2 版后已移除.

handle_accepted(sock, addr)

当与发起对本地端点的 connect() 调用的新远程端点已建立连接时会在侦听通道（被动打开方）上被调用。 sock 是可被用于在连接上发送和接收数据的 新建 套接字对象，而 addr 是绑定到连接另一端的套接字的地址。

3.2 新版功能.

readable()

每次在异步循环之外被调用以确定是否应当将一个通道的套接字添加到可能在其上发生读取事件的列表中。 默认方法会简单地返回 True，表示在默认情况下，所有通道都希望能读取事件。

writable()

每次在异步循环之外被调用以确定是否应当将一个通道的套接字添加到可能在其上发生写入事件的列表中。 默认方法会简单地返回 True，表示在默认情况下，所有通道都希望能写入事件。

此外，每个通道都委托或扩展了许多套接字方法。 它们大部分都与其套接字的对应方法几乎一样。

create_socket(family=socket.AF_INET, type=socket.SOCK_STREAM)

这与普通套接字的创建相同，并会使用同样的创建选项。 请参阅 socket 文档了解有关创建套接字的信息。

在 3.3 版更改: family 和 type 参数可以被省略。

connect(address)

与普通套接字对象一样，address 是一个元组，它的第一个元素是要连接的主机，第二个元素是端口号。

send(data)

将 data 发送到套接字的远程端点。

recv(buffer_size)

从套接字的远程端点读取至多 buffer_size 个字节。 读到空字节串表明通道已从另一端被关闭。

请注意 recv() 可能会引发 BlockingIOError，即使 select.select() 或 select.poll() 报告套接字已准备好被读取。

listen(backlog)

侦听与套接字的连接。 backlog 参数指明排入连接队列的最大数量且至少应为 1；最大值取决于具体系统（通常为 5）。

bind(address)

将套接字绑定到 address。 套接字必须尚未被绑定。 (address 的格式取决于具体的地址族 --- 请参阅 socket 文档了解更多信息。) 要将套接字标记为可重用的 (设置 SO_REUSEADDR 选项)，请调用 dispatcher 对象的 set_reuse_addr() 方法。

accept()

接受一个连接。 此套接字必须绑定到一个地址上并且侦听连接。 返回值可以是 None 或一个 (conn, address) 对，其中 conn 是一个可用来在此连接上发送和接收数据的 新的 套接字对象，而 address 是绑定到连接另一端套接字的地址。 当返回 None 时意味着连接没有建立，在此情况下服务器应当忽略此事件并继续侦听后续的入站连接。

close()

关闭套接字。 在此套接字对象上的后续操作都将失败。 远程端点将不再接收任何数据（在排入队列的数据被清空之后）。 当套接字被垃圾回收时会自动关闭。

class asyncore.dispatcher_with_send

dispatcher 的一个添加了简单缓冲输出功能的子类，适用于简单客户端。 对于更复杂的用法请使用 asynchat.async_chat。

class asyncore.file_dispatcher

file_dispatcher 接受一个文件描述符或 file object 以及一个可选的 map 参数，并对其进行包装以配合 poll() 或 loop() 函数使用。 如果提供一个文件对象或任何具有 fileno() 方法的对象，其方法将被调用并传递给 file_wrapper 构造器。

可用性: Unix。

class asyncore.file_wrapper

file_wrapper 接受一个整数形式的文件描述符并调用 os.dup() 来复制其句柄，以便原始句柄可以独立于 file_wrapper 被关闭。 这个类实现了足够的方法来模拟套接字以供 file_dispatcher 类使用。

可用性: Unix。

asyncore 示例基本 HTTP 客户端

下面是一个非常基本的 HTTP 客户端，它使用了 dispatcher 类来实现套接字处理:

import asyncore

class HTTPClient(asyncore.dispatcher):

    def __init__(self, host, path):
        asyncore.dispatcher.__init__(self)
        self.create_socket()
        self.connect( (host, 80) )
        self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' %
                            (path, host), 'ascii')

    def handle_connect(self):
        pass

    def handle_close(self):
        self.close()

    def handle_read(self):
        print(self.recv(8192))

    def writable(self):
        return (len(self.buffer) > 0)

    def handle_write(self):
        sent = self.send(self.buffer)
        self.buffer = self.buffer[sent:]

client = HTTPClient('www.python.org', '/')
asyncore.loop()

asyncore 示例基本回显服务器

下面是一个基本的回显服务器，它使用了 dispatcher 类来接受连接并将入站连接发送给处理程序:

import asyncore

class EchoHandler(asyncore.dispatcher_with_send):

    def handle_read(self):
        data = self.recv(8192)
        if data:
            self.send(data)

class EchoServer(asyncore.dispatcher):

    def __init__(self, host, port):
        asyncore.dispatcher.__init__(self)
        self.create_socket()
        self.set_reuse_addr()
        self.bind((host, port))
        self.listen(5)

    def handle_accepted(self, sock, addr):
        print('Incoming connection from %s' % repr(addr))
        handler = EchoHandler(sock)

server = EchoServer('localhost', 8080)
asyncore.loop()

audioop --- 处理原始音频数据

3.11 版后已移除: audioop 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#audioop] 了解详情）。

audioop 模块包含针对声音片段的一些有用操作。它操作的声音片段由 8、16、24 或 32 位宽的有符号整型采样值组成，存储在 类字节串对象 中。除非特别说明，否则所有标量项目均为整数。

在 3.4 版更改: 增加了对 24 位采样的支持。现在，所有函数都接受任何 类字节串对象。而传入字符串会立即导致错误。

本模块提供对 a-LAW、u-LAW 和 Intel/DVI ADPCM 编码的支持。

部分更复杂的操作仅接受 16 位采样，而其他操作始终需要采样大小（以字节为单位）作为该操作的参数。

此模块定义了下列变量和函数：

exception audioop.error

所有错误都会抛出此异常，比如采样值的字节数未知等等。

audioop.add(fragment1, fragment2, width)

两个采样作为参数传入，返回一个片段，该片段是两个采样的和。width 是采样位宽（以字节为单位），可以取 1, 2, 3 或 4。两个片段的长度应相同。如果发生溢出，较长的采样将被截断。

audioop.adpcm2lin(adpcmfragment, width, state)

将 Intel/DVI ADPCM 编码的片段解码为线性片段。关于 ADPCM 编码的详情请参阅 lin2adpcm() 的描述。返回一个元组 (sample, newstate)，其中 sample 的位宽由 width 指定。

audioop.alaw2lin(fragment, width)

将 a-LAW 编码的声音片段转换为线性编码声音片段。由于 a-LAW 编码采样值始终为 8 位，因此这里的 width 仅指输出片段的采样位宽。

audioop.avg(fragment, width)

返回片段中所有采样值的平均值。

audioop.avgpp(fragment, width)

返回片段中所有采样值的平均峰峰值。由于没有进行过滤，因此该例程的实用性尚存疑。

audioop.bias(fragment, width, bias)

返回一个片段，该片段由原始片段中的每个采样值加上偏差组成。在溢出时采样值会回卷 (wrap around)。

audioop.byteswap(fragment, width)

“按字节交换”片段中的所有采样值，返回修改后的片段。将大端序采样转换为小端序采样，反之亦然。

3.4 新版功能.

audioop.cross(fragment, width)

将片段作为参数传入，返回其中过零点的数量。

audioop.findfactor(fragment, reference)

返回一个系数 F 使得 rms(add(fragment, mul(reference, -F))) 最小，即返回的系数乘以 reference 后与 fragment 最匹配。两个片段都应包含 2 字节宽的采样。

本例程所需的时间与 len(fragment) 成正比。

audioop.findfit(fragment, reference)

尽可能尝试让 reference 匹配 fragment 的一部分（fragment 应较长）。从概念上讲，完成这些靠从 fragment 中取出切片，使用 findfactor() 计算最佳匹配，并最小化结果。两个片段都应包含 2 字节宽的采样。返回一个元组 (offset, factor)，其中 offset 是在 fragment 中的偏移量（整数），表示从此处开始最佳匹配，而 factor 是由 findfactor() 定义的因数（浮点数）。

audioop.findmax(fragment, length)

在 fragment 中搜索所有长度为 length 的采样切片（不是字节！）中，能量最大的那一个切片，即返回 i 使得 rms(fragment[i*2:(i+length)*2]) 最大。两个片段都应包含 2 字节宽的采样。

本例程所需的时间与 len(fragment) 成正比。

audioop.getsample(fragment, width, index)

返回片段中采样值索引 index 的值。

audioop.lin2adpcm(fragment, width, state)

将采样转换为 4 位 Intel/DVI ADPCM 编码。ADPCM 编码是一种自适应编码方案，其中每个 4 比特数字是一个采样值与下一个采样值之间的差除以（不定的）步长。IMA 已选择使用 Intel/DVI ADPCM 算法，因此它很可能成为标准。

state 是一个表示编码器状态的元组。编码器返回一个元组 (adpcmfrag, newstate)，而 newstate 要在下一次调用 lin2adpcm() 时传入。在初始调用中，可以将 None 作为 state 传递。adpcmfrag 是 ADPCM 编码的片段，每个字节打包了 2 个 4 比特值。

audioop.lin2alaw(fragment, width)

将音频片段中的采样值转换为 a-LAW 编码，并将其作为字节对象返回。a-LAW 是一种音频编码格式，仅使用 8 位采样即可获得大约 13 位的动态范围。Sun 音频硬件等使用该编码。

audioop.lin2lin(fragment, width, newwidth)

将采样在 1、2、3 和 4 字节格式之间转换。

注解

在某些音频格式（如 .WAV 文件）中，16、24 和 32 位采样是有符号的，但 8 位采样是无符号的。因此，当将这些格式转换为 8 位宽采样时，还需使结果加上 128:

new_frames = audioop.lin2lin(frames, old_width, 1)
new_frames = audioop.bias(new_frames, 1, 128)

反之，将 8 位宽的采样转换为 16、24 或 32 位时，必须采用相同的处理。

audioop.lin2ulaw(fragment, width)

将音频片段中的采样值转换为 u-LAW 编码，并将其作为字节对象返回。u-LAW 是一种音频编码格式，仅使用 8 位采样即可获得大约 14 位的动态范围。Sun 音频硬件等使用该编码。

audioop.max(fragment, width)

返回片段中所有采样值的最大 绝对值。

audioop.maxpp(fragment, width)

返回声音片段中的最大峰峰值。

audioop.minmax(fragment, width)

返回声音片段中所有采样值的最小值和最大值组成的元组。

audioop.mul(fragment, width, factor)

返回一个片段，该片段由原始片段中的每个采样值乘以浮点值 factor 组成。如果发生溢出，采样将被截断。

audioop.ratecv(fragment, width, nchannels, inrate, outrate, state[, weightA[, weightB]])

转换输入片段的帧速率。

state 是一个表示转换器状态的元组。转换器返回一个元组 (newfragment, newstate)，而 newstate 要在下一次调用 ratecv() 时传入。初始调用应传入 None 作为 state。

参数 weightA 和 weightB 是简单数字滤波器的参数，默认分别为 1 和 0。

audioop.reverse(fragment, width)

将片段中的采样值反转，返回修改后的片段。

audioop.rms(fragment, width)

返回片段的均方根值，即 sqrt(sum(S_i^2)/n)。

测量音频信号的能量。

audioop.tomono(fragment, width, lfactor, rfactor)

将立体声片段转换为单声道片段。左通道乘以 lfactor，右通道乘以 rfactor，然后两个通道相加得到单声道信号。

audioop.tostereo(fragment, width, lfactor, rfactor)

由单声道片段生成立体声片段。立体声片段中的两对采样都是从单声道计算而来的，即左声道是乘以 lfactor，右声道是乘以 rfactor。

audioop.ulaw2lin(fragment, width)

将 u-LAW 编码的声音片段转换为线性编码声音片段。由于 u-LAW 编码采样值始终为 8 位，因此这里的 width 仅指输出片段的采样位宽。

请注意，诸如 mul() 或 max() 之类的操作在单声道和立体声间没有区别，即所有采样都作相同处理。如果出现问题，应先将立体声片段拆分为两个单声道片段，之后再重组。以下是如何进行该操作的示例:

def mul_stereo(sample, width, lfactor, rfactor):
    lsample = audioop.tomono(sample, width, 1, 0)
    rsample = audioop.tomono(sample, width, 0, 1)
    lsample = audioop.mul(lsample, width, lfactor)
    rsample = audioop.mul(rsample, width, rfactor)
    lsample = audioop.tostereo(lsample, width, 1, 0)
    rsample = audioop.tostereo(rsample, width, 0, 1)
    return audioop.add(lsample, rsample, width)

如果使用 ADPCM 编码器构造网络数据包，并且希望协议是无状态的（即能够容忍数据包丢失），则不仅需要传输数据，还应该传输状态。请注意，必须将*初始*状态（传入 lin2adpcm() 的状态）发送给解码器，不能发送最终状态（编码器返回的状态）。如果要使用 struct.Struct 以二进制保存状态，可以将第一个元素（预测值）用 16 位编码，将第二个元素（增量索引）用 8 位编码。

本 ADPCM 编码器从不与其他 ADPCM 编码器对立，仅针对自身。本开发者可能会误读标准，这种情况下它们将无法与相应标准互操作。

乍看之下 find*() 例程可能有些可笑。它们主要是用于回声消除，一种快速有效的方法是选取输出样本中能量最高的片段，在输入样本中定位该片段，然后从输入样本中减去整个输出样本:

def echocancel(outputdata, inputdata):
    pos = audioop.findmax(outputdata, 800)    # one tenth second
    out_test = outputdata[pos*2:]
    in_test = inputdata[pos*2:]
    ipos, factor = audioop.findfit(in_test, out_test)
    # Optional (for better cancellation):
    # factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)],
    #              out_test)
    prefill = '\0'*(pos+ipos)*2
    postfill = '\0'*(len(inputdata)-len(prefill)-len(outputdata))
    outputdata = prefill + audioop.mul(outputdata, 2, -factor) + postfill
    return audioop.add(inputdata, outputdata, 2)

cgi --- 通用网关接口支持

源代码： Lib/cgi.py [https://github.com/python/cpython/tree/3.10/Lib/cgi.py]

3.11 版后已移除: cgi 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#cgi] 了解详情及其替代品）。

通用网关接口 (CGI) 脚本的支持模块

本模块定义了一些工具供以 Python 编写的 CGI 脚本使用。

概述

CGI 脚本是由 HTTP 服务器发起调用，通常用来处理通过 HTML <FORM> 或 <ISINDEX> 元素提交的用户输入。

在大多数情况下，CGI 脚本存放在服务器的 cgi-bin 特殊目录下。 HTTP 服务器将有关请求的各种信息（例如客户端的主机名、所请求的 URL、查询字符串以及许多其他内容）放在脚本的 shell 环境中，然后执行脚本，并将脚本的输出发回到客户端。

脚本的输入也会被连接到客户端，并且有时表单数据也会以此方式来读取；在其他时候表单数据会通过 URL 的“查询字符串”部分来传递。 本模块的目标是处理不同的应用场景并向 Python 脚本提供一个更为简单的接口。 它还提供了一些工具为脚本调试提供帮助，而最近增加的还有对通过表单上传文件的支持（如果你的浏览器支持该功能的话）。

CGI 脚本的输出应当由两部分组成，并由一个空行分隔。 前一部分包含一些标头，它们告诉客户端后面会提供何种数据。 生成一个最小化标头部分的 Python 代码如下所示:

print("Content-Type: text/html")    # HTML is following
print()                             # blank line, end of headers

后一部分通常为 HTML，提供给客户端软件来显示格式良好包含标题的文本、内联图片等内容。 下面是打印一段简单 HTML 的 Python 代码:

print("<TITLE>CGI script output</TITLE>")
print("<H1>This is my first CGI script</H1>")
print("Hello, world!")

使用 cgi 模块

先在开头添加 import cgi。

当你在编写一个新脚本时，请考虑加上这些语句:

import cgitb
cgitb.enable()

这会激活一个特殊的异常处理器，它将在发生任何错误时将详细错误报告显示到 web 浏览器中。 如果你不希望向你的脚本的用户显示你的程序的内部细节，你可以改为将报告保存到文件中，使用这样的代码即可:

import cgitb
cgitb.enable(display=0, logdir="/path/to/logdir")

在脚本开发期间使用此特性会很有帮助。 cgitb 所产生的报告提供了在追踪程序问题时能为你节省大量时间的信息。 你可以在完成测试你的脚本并确信它能正确工作之后再移除 cgitb 行。

要获取提交的表单数据，请使用 FieldStorage 类。 如果表单包含非 ASCII 字符，请使用 encoding 关键字参数并设置为文档所定义的编码格式值。 它通常包含在 HTML 文档的 HEAD 部分的 META 标记中或者由 Content-Type 标头所指明。 这会从标准输入或环境读取表单内容（取决于根据 CGI 标准设置的多个环境变量的值）。 由于它可能会消耗标准输入，它应当只被实例化一次。

FieldStorage 实例可以像 Python 字典一样来检索。 它允许通过 in 运算符进行成员检测，也支持标准字典方法 keys() 和内置函数 len()。 包含空字符串的表单字段会被忽略而不会出现在字典中；要保留这样的值，请在创建 FieldStorage 实例时为可选的 keep_blank_values 关键字形参提供一个真值。

举例来说，下面的代码（假定 Content-Type 标头和空行已经被打印）会检查字段 name 和 addr 是否均被设为非空字符串:

form = cgi.FieldStorage()
if "name" not in form or "addr" not in form:
    print("<H1>Error</H1>")
    print("Please fill in the name and addr fields.")
    return
print("<p>name:", form["name"].value)
print("<p>addr:", form["addr"].value)
...further form processing here...

在这里的字段通过 form[key] 来访问，它们本身就是 FieldStorage (或 MiniFieldStorage，取决于表单的编码格式) 的实例。 实例的 value 属性会产生字段的字符串值。 getvalue() 方法直接返回这个字符串；它还接受可选的第二个参数作为当请求的键不存在时要返回的默认值。

如果提交的表单数据包含一个以上的同名字段，由 form[key] 所提取的对象将不是一个 FieldStorage 或 MiniFieldStorage 实例而是由这种实例组成的列表。 类似地，在这种情况下，form.getvalue(key) 将会返回一个字符串列表。 如果你预计到这种可能性（当你的 HTML 表单包含多个同名字段时），请使用 getlist() 方法，它总是返回一个值的列表（这样你就不需要对只有单个项的情况进行特别处理）。 例如，这段代码拼接了任意数量的 username 字段，以逗号进行分隔:

value = form.getlist("username")
usernames = ",".join(value)

如果一个字段是代表上传的文件，请通过 value 属性访问该值或是通过 getvalue() 方法以字节形式将整个文件读入内存。 这可能不是你想要的结果。 你可以通过测试 filename 属性或 file 属性来检测上传的文件。 然后你可以从 file 属性读取数据，直到它作为 FieldStorage 实例的垃圾回收的一部分被自动关闭 (read() 和 readline() 方法将返回字节数据):

fileitem = form["userfile"]
if fileitem.file:
    # It's an uploaded file; count lines
    linecount = 0
    while True:
        line = fileitem.file.readline()
        if not line: break
        linecount = linecount + 1

FieldStorage 对象还支持在 with 语句中使用，该语句结束时将自动关闭它们。

如果在获取上传文件的内容时遇到错误（例如，当用户点击回退或取消按钮中断表单提交时）该字段中对象的 done 属性值将被设为 -1。

文件上传标准草案考虑到了从一个字段上传多个文件的可能性（使用递归的 multipart/* 编码格式）。 当这种情况发生时，该条目将是一个类似字典的 FieldStorage 条目。 这可以通过检测它的 type 属性来确定，该属性应当是 multipart/form-data (或者可能是匹配 multipart/* 的其他 MIME 类型)。 在这种情况下，它可以像最高层级的表单对象一样被递归地迭代处理。

当一个表单按“旧”格式提交时（即以查询字符串或是单个 application/x-www-form-urlencoded 类型的数据部分的形式），这些条目实际上将是 MiniFieldStorage 类的实例。 在这种情况下，list, file 和 filename 属性将总是为 None。

通过 POST 方式提交并且也带有查询字符串的表单将同时包含 FieldStorage 和 MiniFieldStorage 条目。

在 3.4 版更改: file 属性会在创建 FieldStorage 实例的垃圾回收操作中被自动关闭。

在 3.5 版更改: 为 FieldStorage 类增加了上下文管理协议支持。

更高层级的接口

前面的部分解释了如何使用 FieldStorage 类来读取 CGI 表单数据。 本部分则会描述一个更高层级的接口，它被添加到此类中以允许人们以更为可读和自然的方式行事。 这个接口并不会完全取代前面的部分所描述的技巧 --- 例如它们在高效处理文件上传时仍然很有用处。

此接口由两个简单的方法组成。 你可以使用这两个方法以通用的方式处理表单数据，而无需担心在一个名称下提交的值是只有一个还是有多个。

在前面的部分中，你已学会当你预期用户在一个名称下提交超过一个值的时候编写以下代码:

item = form.getvalue("item")
if isinstance(item, list):
    # The user is requesting more than one item.
else:
    # The user is requesting only one item.

这种情况很常见，例如当一个表单包含具有相同名称的一组复选框的时候:

<input type="checkbox" name="item" value="1" />
<input type="checkbox" name="item" value="2" />

但是在多数情况下，一个表单中的一个特定名称只对应一个表单控件。 因此你可能会编写包含以下代码的脚本:

user = form.getvalue("user").upper()

这段代码的问题在于你绝不能预期客户端会向你的脚本提供合法的输入。 举例来说，如果一个好奇的用户向查询字符串添加了另一个 user=foo 对，则该脚本将会崩溃，因为在这种情况下 getvalue("user") 方法调用将返回一个列表而不是字符串。 在一个列表上调用 upper() 方法是不合法的（因为列表并没有这个方法）因而会引发 AttributeError 异常。

因此，读取表单数据值的正确方式应当总是使用检查所获取的值是单一值还是值列表的代码。 这很麻烦并且会使脚本缺乏可读性。

一种更便捷的方式是使用这个更高层级接口所提供的 getfirst() 和 getlist() 方法。

FieldStorage.getfirst(name, default=None)

此方法总是只返回与表单字段 name 相关联的单一值。 此方法在同一名称下提交了多个值的情况下将仅返回第一个值。 请注意所接收的值顺序在不同浏览器上可能发生变化因而是不确定的。 1 如果指定的表单字段或值不存在则此方法将返回可选形参 default 所指定的值。 如果未指定此形参则默认值为 None。

FieldStorage.getlist(name)

此方法总是返回与表单字段 name 相关联的值列表。 如果 name 指定的表单字段或值不存在则此方法将返回一个空列表。 如果指定的表单字段只包含一个值则它将返回只有一项的列表。

使用这两个方法你将能写出优雅简洁的代码:

import cgi
form = cgi.FieldStorage()
user = form.getfirst("user", "").upper()    # This way it's safe.
for item in form.getlist("item"):
    do_something(item)

函数

这些函数在你想要更多控制，或者如果你想要应用一些此模块中在其他场景下实现的算法时很有用处。

cgi.parse(fp=None, environ=os.environ, keep_blank_values=False, strict_parsing=False, separator='&')

在环境中或从某个文件中解析一个查询 (文件默认为 sys.stdin)。 keep_blank_values, strict_parsing 和 separator 形参会被原样传给 urllib.parse.parse_qs()。

cgi.parse_multipart(fp, pdict, encoding='utf-8', errors='replace', separator='&')

解析 multipart/form-data 类型（用于文件上传）的输入。 参数中 fp 为输入文件，pdict 为包含 Content-Type 标头中的其他形参的字典，encoding 为请求的编码格式。

像 urllib.parse.parse_qs() 那样返回一个字典：其中的键为字段名称，值为对应字段的值列表。 对于非文件字段，其值均为字符串列表。

这很容易使用，但如果你预期要上传巨量字节数据时就不太适合了 --- 在这种情况下，请改用更为灵活的 FieldStorage 类。

在 3.7 版更改: 增加了 encoding 和 errors 形参。 对于非文件字段，其值现在为字符串列表而非字节串列表。

在 3.10 版更改: 增加了 separator 形参。

cgi.parse_header(string)

将一个 MIME 标头 (例如 Content-Type) 解析为一个主值和一个参数字典。

cgi.test()

对 CGI 执行健壮性检测，适于作为主程序。 写入最小化的 HTTP 标头并以 HTML 格式来格式化提供给脚本的所有信息。

cgi.print_environ()

以 HTML 格式来格式化 shell 环境。

cgi.print_form(form)

以 HTML 格式来格式化表单。

cgi.print_directory()

以 HTML 格式来格式化当前目录。

cgi.print_environ_usage()

以 HTML 格式打印有用的环境变量列表（供 CGI 使用）。

对于安全性的关注

有一条重要的规则：如果你发起调用一个外部程序（通过 os.system(), os.popen() 或其他具有类似功能的函数），需要非常确定你不会把从客户端接收的任意字符串直接传给 shell。 这是一个著名的安全漏洞，网络中聪明的黑客可以通过它来利用容易上当的 CGI 脚本发起调用任何 shell 命令。 即便 URL 的一部分或字段名称也是不可信任的，因为请求并不一定是来自你的表单！

为了安全起见，如果你必须将从表单获取的字符串传给 shell 命令，你应当确保该字符串仅包含字母数字类字符、连字符、下划线和句点。

在 Unix 系统上安装你的 CGI 脚本

请阅读你的 HTTP 服务器的文档并咨询你所用系统的管理员来找到 CGI 脚本应当安装到哪个目录；通常是服务器目录树中的 cgi-bin 目录。

请确保你的脚本可被“其他人”读取和执行；Unix 文件模式应为八进制数 0o755 (使用 chmod 0755 filename)。 请确保脚本的第一行包含 #! 且位置是从第 1 列开始，后面带有 Python 解释器的路径名，例如:

#!/usr/local/bin/python

请确保该 Python 解释器存在并且可被“其他人”执行。

请确保你的脚本需要读取或写入的任何文件都分别是“其他人”可读取或可写入的 --- 它们的模式应为可读取 0o644 或可写入 0o666。 这是因为出于安全理由，HTTP 服务器是作为没有任何特殊权限的 "nobody" 用户来运行脚本的。 它只能读取（写入、执行）任何人都能读取（写入、执行）的文件。 执行时的当前目录（通常为服务器的 cgi-bin 目录）和环境变量集合也与你在登录时所得到的不同。 特别地，不可依赖于 shell 的可执行文件搜索路径 (PATH) 或 Python 模块搜索路径 (PYTHONPATH) 的任何相关设置。

如果你需要从 Python 的默认模块搜索路径之外的目录载入模块，你可以在导入其他模块之前在你的脚本中改变路径。 例如:

import sys
sys.path.insert(0, "/usr/home/joe/lib/python")
sys.path.insert(0, "/usr/local/lib/python")

（在此方式下，最后插入的目录将最先被搜索！）

针对非 Unix 系统的指导会有所变化；请查看你的 HTTP 服务器的文档（通常会有关于 CGI 脚本的部分）。

测试你的 CGI 脚本

很不幸，当你在命令行中尝试 CGI 脚本时它通常会无法运行，而能在命令行中完美运行的脚本则可能会在运行于服务器时神秘地失败。 但有一个理由使你仍然应当在命令行中测试你的脚本：如果它包含语法错误，Python 解释器将根本不会执行它，而 HTTP 服务器将很可能向客户端发送令人费解的错误信息。

假定你的脚本没有语法错误，但它仍然无法起作用，你将别无选择，只能继续阅读下一节。

调试 CGI 脚本

首先，请检查是否有安装上的小错误 --- 仔细阅读上面关于安装 CGI 脚本的部分可以使你节省大量时间。 如果你不确定你是否正确理解了安装过程，请尝试将此模块 (cgi.py) 的副本作为 CGI 脚本安装。 当作为脚本被发起调用时，该文件将以 HTML 格式转储其环境和表单内容。 请给它赋予正确的模式等，并向它发送一个请求。 如果它是安装在标准的 cgi-bin 目录下，应该可以通过在你的浏览器中输入表单的 URL 来向它发送请求。

http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home

如果此操作给出类型为 404 的错误，说明服务器找不到此脚本 -- 也许你需要将它安装到不同的目录。 如果它给出另一种错误，说明存在安装问题，你应当解决此问题才能继续操作。 如果你得到一个格式良好的环境和表单内容清单（在这个例子中，应当会列出的有字段 "addr" 值为 "At Home" 以及 "name" 值为 "Joe Blow"），则说明 cgi.py 脚本已正确安装。 如果你为自己的脚本执行了同样的过程，现在你应该能够调试它了。

下一步骤可以是在你的脚本中调用 cgi 模块的 test() 函数：用这一条语句替换它的主代码

cgi.test()

这将产生从安装 cgi.py 文件本身所得到的相同结果。

当某个常规 Python 脚本触发了未处理的异常，（无论出于什么原因：模块名称出错、文件无法打开等)，Python 解释器就会打印出一条完整的跟踪信息并退出。在 CGI 脚本触发异常时，Python 解释器依然会如此，但最有可能的是，跟踪信息只会停留在某个 HTTP 服务日志文件中，或者被完全丢弃。

幸运的是，只要执行 某些 代码，就可以利用 cgitb 模块将跟踪信息发送给浏览器。将以下几行代码加到代码顶部：

import cgitb
cgitb.enable()

然后再运行一下看；发生问题时应能看到详细的报告，或许能让崩溃的原因更清晰一些。

如果怀疑是 cgitb 模块导入的问题，可以采用一个功能更强的方法（只用到内置模块）：

import sys
sys.stderr = sys.stdout
print("Content-Type: text/plain")
print()
...your code here...

这得靠 Python 解释器来打印跟踪信息。输出的类型为纯文本，不经过任何 HTML 处理。如果代码正常，则客户端会显示原有的 HTML。如果触发了异常，很可能在输出前两行后会显示一条跟踪信息。因为不会继续进行 HTML 解析，所以跟踪信息肯定能被读到。

常见问题和解决方案

大部分 HTTP 服务器会对 CGI 脚本的输出进行缓存，等脚本执行完毕再行输出。这意味着在脚本运行时，不可能在客户端屏幕上显示出进度情况。

请查看上述安装说明。

请查看 HTTP 服务器的日志文件。（在另一个单独窗口中执行 tail -f logfile 可能会很有用！）

一定要先检查脚本是否有语法错误，做法类似：python script.py 。

如果脚本没有语法错误，试着在脚本的顶部添加 import cgitb; cgitb.enable()。

当调用外部程序时，要确保其可被读取。通常这意味着采用绝对路径名------ 在 CGI 脚本中， PATH 的值通常没什么用。

在读写外部文件时，要确保其能被 CGI 脚本归属的用户读写：通常是运行网络服务的用户，或由网络服务的 suexec 功能明确指定的一些用户。

不要试图给 CGI 脚本赋予 set-uid 模式。这在大多数系统上都行不通，出于安全考虑也不应如此。

备注

1

请注意，新版的 HTML 规范确实注明了请求字段的顺序，但判断请求是否合法非常繁琐和容易出错，可能来自不符合要求的浏览器，甚至不是来自浏览器。

cgitb --- 用于 CGI 脚本的回溯管理器

源代码: Lib/cgitb.py [https://github.com/python/cpython/tree/3.10/Lib/cgitb.py]

3.11 版后已移除: cgitb 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#cgitb] 了解详情）。

cgitb 模块提供了用于 Python 脚本的特殊异常处理程序。 （这个名称有一点误导性。 它最初是设计用来显示 HTML 格式的 CGI 脚本详细回溯信息。 但后来被一般化为也可显示纯文本格式的回溯信息。） 激活这个模块之后，如果发生了未被捕获的异常，将会显示详细的已格式化的报告。 报告显示内容包括每个层级的源代码摘录，还有当前正在运行的函数的参数和局部变量值，以帮助你调试问题。 你也可以选择将此信息保存至文件而不是将其发送至浏览器。

要启用此特性，只需简单地将此代码添加到你的 CGI 脚本的最顶端:

import cgitb
cgitb.enable()

enable() 函数的选项可以控制是将报告显示在浏览器中，还是将报告记录到文件供以后进行分析。

cgitb.enable(display=1, logdir=None, context=5, format='html')

此函数可通过设置 sys.excepthook 的值以使 cgitb 模块接管解释器默认的异常处理机制。

可选参数 display 默认为 1 并可被设为 0 来停止将回溯发送至浏览器。 如果给出了参数 logdir，则回溯会被写入文件。 logdir 的值应当是一个用于存放所写入文件的目录。 可选参数 context 是要在回溯中的当前源代码行前后显示的上下文行数；默认为 5。 如果可选参数 format 为 "html"，输出将为 HTML 格式。 任何其它值都会强制启用纯文本输出。 默认取值为 "html"。

cgitb.text(info, context=5)

此函数用于处理 info (一个包含 sys.exc_info() 返回结果的 3 元组) 所描述的异常，将其回溯格式化为文本并将结果作为字符串返回。 可选参数 context 是要在回溯中的当前源码行前后显示的上下文行数；默认为 5。

cgitb.html(info, context=5)

此函数用于处理 info (一个包含 sys.exc_info() 返回结果的 3 元组) 所描述的异常，将其回溯格式化为 HTML 并将结果作为字符串返回。 可选参数 context 是要在回溯中的当前源码行前后显示的上下文行数；默认为 5。

cgitb.handler(info=None)

此函数使用默认设置处理异常（即在浏览器中显示报告，但不记录到文件）。 当你捕获了一个异常并希望使用 cgitb 来报告它时可以使用此函数。 可选的 info 参数应为一个包含异常类型，异常值和回溯对象的 3 元组，与 sys.exc_info() 所返回的元组完全一致。 如果未提供 info 参数，则会从 sys.exc_info() 获取当前异常。

chunk --- 读取 IFF 分块数据

源代码: Lib/chunk.py [https://github.com/python/cpython/tree/3.10/Lib/chunk.py]

3.11 版后已移除: chunk 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#chunk] 了解详情）。

本模块提供了一个读取使用 EA IFF 85 分块的数据的接口chunks. 1 这种格式使用的场合有 Audio Interchange File Format (AIFF/AIFF-C) 和 Real Media File Format (RMFF) 等。 与它们密切相关的 WAVE 音频文件也可使用此模块来读取。

一个分块具有以下结构:

偏移 | 长度 | 目录
0 | 4 | 区块ID
4 | 4 | 大端字节顺序的块大小，不包括头
8 | n | 数据字节，其中 n 是前一字段中给出的大小
8 + n | 0 或 1 | 如果 n 为奇数且使用块对齐，则需要填充字节

ID是一个4字节的字符串，用于标识块的类型。

大小字段（32 位的值，使用大端字节序编码）给出分块数据的大小，不包括 8 字节的标头。

使用由一个或更多分块组成的 IFF 类型文件。 此处定义的 Chunk 类的建议使用方式是在每个分块开始时实例化一个实例并从实例读取直到其末尾，在那之后可以再实例化新的实例。 到达文件末尾时，创建新实例将会失败并引发 EOFError 异常。

class chunk.Chunk(file, align=True, bigendian=True, inclheader=False)

代表一个分块的类。 file 参数预期为一个文件型对象。 特别地也允许该类的实例。 唯一必需的方法是 read()。 如果存在 seek() 和 tell() 方法并且没有引发异常，它们也会被使用。 如果存在这些方法并且引发了异常，则它们不应改变目标对象。 如果可选参数 align 为真值，则分块应当以 2 字节边界对齐。 如果 align 为假值，则不使用对齐。 此参数默认为真值。 如果可选参数 bigendian 为假值，分块大小应当为小端序。 这对于 WAVE 音频文件是必须的。 此参数默认为真值。 如果可选参数 inclheader 为真值，则分块标头中给出的大小将包括标头的大小。 此参数默认为假值。

Chunk 对象支持下列方法：

getname()

返回分块的名称（ID）。 这是分块的头 4 个字节。

getsize()

返回分块的大小。

close()

关闭并跳转到分块的末尾。 这不会关闭下层的文件。

在 close() 方法已被调用后其余方法将会引发 OSError。 在 Python 3.3 之前，它们曾会引发 IOError，现在这是 OSError 的一个别名。

isatty()

返回 False。

seek(pos, whence=0)

设置分块的当前位置。 whence 参数为可选项并且默认为 0 (绝对文件定位)；其他值还有 1 (相对当前位置查找) 和 2 (相对文件末尾查找)。 没有返回值。 如果下层文件不支持查找，则只允许向前查找。

tell()

将当前位置返回到分块。

read(size=- 1)

从分块读取至多 size 个字节（如果在获得 size 个字节之前已到达分块末尾则读取的字节会少于此数量）。 如果 size 参数为负值或被省略，则读取所有字节直到分块末尾。 当立即遇到分块末尾则返回空字节串对象。

skip()

跳到分块末尾。此后对分块再次调用 read() 将返回 b''。 如果你对分块的内容不感兴趣，则应当调用此方法以使文件指向下一分块的开头。

备注

1

"EA IFF 85" 交换格式文件标准, Jerry Morrison, Electronic Arts, 1985 年 1 月。

crypt —— 验证 Unix 口令的函数

源代码： Lib/struct.py [https://github.com/python/cpython/tree/3.10/Lib/struct.py]

3.11 版后已移除: crypt 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#crypt] 了解详情及其替代品）。 hashlib 模块是针对特定用例的潜在替换选项。

本模块实现了连接 crypt(3) 的接口，是一个基于改进 DES 算法的单向散列函数；更多细节请参阅 Unix man 手册。可能的用途包括保存经过哈希的口令，这样就可以在不存储实际口令的情况下对其进行验证，或者尝试用字典来破解 Unix 口令。

请注意，本模块的执行取决于当前系统中 crypt(3) 的实际实现。 因此，当前实现版本可用的扩展均可在本模块使用。

可用性 ：Unix。在 VxWorks 中不可用。

哈希方法

3.3 新版功能.

crypt 模块定义了哈希方法的列表（不是所有的方法在所有平台上都可用）。

crypt.METHOD_SHA512

基于 SHA-512 哈希函数的模块化加密格式方法，具备 16 个字符的 salt 和 86个字符的哈希算法。这是最强的哈希算法。

crypt.METHOD_SHA256

另一种基于 SHA-256 哈希函数的模块化加密格式方法，具备 16 个字符的 salt 和 43 个字符的哈希算法。

crypt.METHOD_BLOWFISH

另一种基于 Blowfish 的模块化加密格式方法，有 22 个字符的 salt 和 31 个字符的哈希算法。

3.7 新版功能.

crypt.METHOD_MD5

另一种基于 MD5 哈希函数的模块化加密格式方法，具备 8 个字符的 salt 和 22 个字符的哈希算法。

crypt.METHOD_CRYPT

传统的方法，具备 2 个字符的 salt 和 13 个字符的哈希算法。这是最弱的方法。

模块属性

3.3 新版功能.

crypt.methods

可用口令哈希算法的列表，形式为 crypt.METHOD_* 对象。该列表从最强到最弱进行排序。

模块函数

crypt 模块定义了以下函数：

crypt.crypt(word, salt=None)

word 通常将是用户在提示符或图形界面上输入的口令。 可选参数 salt 要么是 mksalt() 所返回的字符串，即 crypt.METHOD_* 值之一（尽管不是在所有平台上都可用），要么就是一个包括 salt 的完全加密的口令，与本函数的返回值一样。 如果未给出 salt，则将使用 methods 中提供的最强方法。

查验口令通常是传入纯文本密码 word ，和之前 crypt() 调用的结果进行比较，应该与本次调用的结果相同。

salt (随机的 2 或 16 个字符的字符串，可能带有 $digit{TX-PL-LABEL}#x60; 前缀以提示相关方法) 将被用来扰乱加密算法。 salt 中的字符必须在 [./a-zA-Z0-9] 集合中，但 Modular Crypt Format 除外，它会带有 $digit{TX-PL-LABEL}#x60; 前缀。

返回哈希后的口令字符串，将由 salt 所在字母表中的字符组成。

由于有些 crypt(3) 扩展可以接受各种大小的 salt 值，建议在查验口令时采用完整的加密后口令作为 salt。

在 3.3 版更改: 除了字符串之外， salt 还可接受 crypt.METHOD_* 值。

crypt.mksalt(method=None, *, rounds=None)

返回用指定方法随机生成的 salt 值。 如果没有给出 method，则会使用 methods 中提供的最强方法。is used.

返回一个字符串，可用作传入 crypt() 的 salt 参数。

rounds 指定了 METHOD_SHA256, METHOD_SHA512 和 METHOD_BLOWFISH 的循环次数。 对于 METHOD_SHA256 和 METHOD_SHA512 而言，必须为介于 1000 和 999_999_999 之间的整数，默认值为 5000。 而对于 METHOD_BLOWFISH，则必须为 16 (2⁴) 和 2_147_483_648 (2³¹) 之间的二的幂，默认值为 4096 (2¹²)。

3.3 新版功能.

在 3.7 版更改: 加入 rounds 参数。

例子

以下简单示例演示了典型用法（需要一个时间固定的比较操作来限制留给计时攻击的暴露面。 hmac.compare_digest() 即很适用）：

import pwd
import crypt
import getpass
from hmac import compare_digest as compare_hash

def login():
    username = input('Python login: ')
    cryptedpasswd = pwd.getpwnam(username)[1]
    if cryptedpasswd:
        if cryptedpasswd == 'x' or cryptedpasswd == '*':
            raise ValueError('no support for shadow passwords')
        cleartext = getpass.getpass()
        return compare_hash(crypt.crypt(cleartext, cryptedpasswd), cryptedpasswd)
    else:
        return True

采用当前强度最高的方法生成哈希值，并与原口令进行核对：

import crypt
from hmac import compare_digest as compare_hash

hashed = crypt.crypt(plaintext)
if not compare_hash(hashed, crypt.crypt(plaintext, hashed)):
    raise ValueError("hashed version doesn't validate against original")

imghdr --- 推测图像类型

源代码 Lib/imghdr.py [https://github.com/python/cpython/tree/3.10/Lib/imghdr.py]

3.11 版后已移除: imghdr 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#imghdr] 了解详情及其替代品）。

imghdr 模块推测文件或字节流中的图像的类型。

imghdr 模块定义了以下类型：

imghdr.what(file, h=None)

测试包含在名为 file 的文件中的图像数据，并返回描述该图像类型的字符串。 如果提供了可选的 h，则 file 参数会被忽略并且 h 会被视为包含要测试的字节流。

在 3.6 版更改: 接受一个 path-like object。

接下来的图像类型是可识别的，返回值来自 what()：

值 | 图像格式
'rgb' | SGI 图像库文件
'gif' | GIF 87a 和 89a 文件
'pbm' | 便携式位图文件
'pgm' | 便携式灰度图文件
'ppm' | 便携式像素表文件
'tiff' | TIFF 文件
'rast' | Sun 光栅文件
'xbm' | X 位图文件
'jpeg' | JFIF 或 Exif 格式的 JPEG 数据
'bmp' | BMP 文件
'png' | 便携式网络图像
'webp' | WebP 文件
'exr' | OpenEXR 文件

3.5 新版功能: exr 和 webp 格式被添加。

你可以扩展此 imghdr 可以被追加的这个变量识别的文件格式的列表：

imghdr.tests

执行单个测试的函数列表。每个函数都有两个参数：字节流和类似开放文件的对象。当 what() 用字节流调用时，类文件对象将是 None。

如果测试成功，这个测试函数应当返回一个描述图像类型的字符串，否则返回 None。

示例:

>>> import imghdr
>>> imghdr.what('bass.gif')
'gif'

imp --- 访问 import 内部对象

源代码： Lib/imp.py [https://github.com/python/cpython/tree/3.10/Lib/imp.py]

3.4 版后已移除: imp 模块已被废弃，请改用 importlib。

本模块提供了一个接口，用于实现 import 语句的机制。这里定义了以下常量和函数：

imp.get_magic()

返回用于识别字节编译代码文件 (.pyc files) 的魔术字符串值。 （该值对于各个 Python 版本可能不同。）

3.4 版后已移除: 改用 importlib.util.MAGIC_NUMBER。

imp.get_suffixes()

返回一个 3 元素元组的列表，每个元组描述了一个特定的模块类型。 每个三元组的形式为 (suffix, mode, type)，其中 suffix 是要附加到模块名称上以组成要搜索的文件名的字符串，mode 是要传给内置 open() 函数以打开该文件的模式字符串 (可以为针对文本文件的 'r' 或针对二进制文件的 'rb')，而 type 是文件类型，它的值为 PY_SOURCE, PY_COMPILED 之一 C_EXTENSION，具体说明如下。

3.3 版后已移除: 改用在 importlib.machinery 上定义的常量。

imp.find_module(name[, path])

尝试找到模块 name。 如果 path 被省略或为 None，则会搜索 sys.path 给出的目录名列表，但在此前会先搜索几个特殊位置：该函数将尝试找到具有给定名称的内置模块 (C_BUILTIN)，然后是冻结模块 (PY_FROZEN)，并且在某些系统上还会查找其他几个位置（在 Windows 上，它将查看注册表，其中可能指向某一特定文件）。

在其他情况下，path 必须是一个目录名列表；将在每个目录中搜索具有上述 get_suffixes() 所返回的任何后缀的文件。 列表中的无效名称将被静默地忽略（但是所有列表条目都必须为字符串）。

如果搜索成功，返回值将是一个 3 元素元组 (file, pathname, description):

file 是一个放在最前面的已打开的 file object，pathname 是打到的文件的路径名，而 description 是一个描述所找到的模块种类的 3 元素元组，如 get_suffixes() 所返回的列表中包含的内容。

如果模块为内置或冻结模块则 file 和 pathname 都将为 None 并且 description 元组将包含空字符串来表示其后缀和模式；模块类型按上述圆括号中所给出的内容来指明。 如果搜索未成功，则会引发 ImportError。 其他异常被用于指示参数或环境问题。

如果模块是一个包，则 file 将为 None，pathname 将为包路径而 description 元组的最后一项将为 PKG_DIRECTORY。

此函数不会处理多层级的模块名称（包含点号的名称）。 为了找到 P.M，也就是 P 包的的子模块 M，请使用 find_module() 和 load_module() 来找到并载入 P 包，然后使用 find_module() 并将 path 参数设为 P.__path__。 当 P 本身也具有带点号的名称时，请递归地应用此步骤。

3.3 版后已移除: 请改用 importlib.util.find_spec() 除非需要兼容 Python 3.3，对于后一种情况请使用 importlib.find_loader()。 要查看对于前一种情况的示例用法，请参阅 importlib 文档的 例子 小节。

imp.load_module(name, file, pathname, description)

加载之前由 find_module() 所找到的模块（或由其他方式执行搜索所产生的兼容的结果）。 此函数所做的不只是导入模块：如果模块已经被导入，它将重新加载此模块！ name 参数指明完整的模块名称（包括包名，如果它是一个包的子模块的话）。 file 参数是一个打开的文件，而 pathname 是相应的文件名；当模块是一个包或者不是从文档加载时，它们可以分别为 None 和 ''。 description 参数是一个元组，如 get_suffixes() 将返回的内容一样，描述了必须加载什么样的模块。

如果加载成功，则返回值为相应的模块对象；否则，将引发一个异常 (通常为 ImportError)。

重要: 调用方需负责关闭 file 参数，如果它不为 None 的话，即使是在有异常被引发时。 这最好是使用 try ... finally 语句来实现。

3.3 版后已移除: 如果之前是与 imp.find_module() 一起使用则可考虑使用 importlib.import_module()，在其他情况下请使用你选择的 imp.find_module() 替代品所返回的加载器。 如果你直接附带文件路径参数调用 imp.load_module() 和相关函数则请使用 importlib.util.spec_from_file_location() 和 importlib.util.module_from_spec() 的组合。 参见 importlib 文档的 例子 小节来了解各种方式的细节。

imp.new_module(name)

返回一个新的名为 name 的空模块对象。 此对象 不会 被插入到 sys.modules 中。

3.4 版后已移除: 请改用 importlib.util.module_from_spec()。

imp.reload(module)

重新加载之前导入的 module。 该参数必须是一个模块对象，因此它之前必须已经被成功导入了。 这在当你已使用外部编辑器编辑过模块源代码文件并想在不退出 Python 解释器的情况下尝试新版本时会很有用处。 返回值为模块对象（与 module 参数所指向的相同）。

当 reload(module) 被执行时:

Python 模块的代码会被重新编译并且模块层级的代码将重新执行，定义一个新的绑定到模块字典中的名称的对象集合。 扩展模块的 init 函数不会被重复调用。

与Python中的所有的其它对象一样，旧的对象只有在它们的引用计数为0之后才会被回收。

模块命名空间中的名称重新指向任何新的或更改后的对象。

其他旧对象的引用（例如那个模块的外部名称）不会被重新绑定到引用的新对象的，并且如果有需要，必须在出现的每个命名空间中进行更新。

有一些其他注意事项：

当一个模块被重新加载的时候，它的字典（包含了那个模块的全区变量）会被保留。名称的重新定义会覆盖旧的定义，所以通常来说这不是问题。如果一个新模块没有定义在旧版本模块中定义的名称，则将保留旧版本中的定义。这一特性可用于作为那个模块的优点，如果它维护一个全局表或者对象的缓存 —— 使用 try 语句，就可以测试表的存在并且跳过它的初始化，如果有需要的话:

try:
    cache
except NameError:
    cache = {}

重新加载内置或动态加载的模块是合法操作但通常不是很有用处，除非是 sys, __main__ 和 builtins。 但是在许多情况下，扩展模块并不是被设计为可被多次初始化的，并可能在重新加载时以任意方式失败。

如果一个模块使用 from ... import ... 导入来自另一个模块的对象，则为另一个模块调用 reload() 并不会重新定义从其中导入的对象 --- 绕过此问题的一种方式是重新执行 from 语句，另一种方式是使用 import 和限定名称 (module.*name*) 来代替。

如果一个模块创建一个类的实例，重新加载定义那个类的模块不影响那些实例的方法定义———它们继续使用旧类中的定义。对于子类来说同样是正确的。

在 3.3 版更改: 依赖于 __name__ 和 __loader__ 而不仅是 __name__ 同时定义在被重新加载的模块上。

3.4 版后已移除: 使用 importlib.reload() 来代替。

下列函数可以方便地处理 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 字节编译的文件路径。

3.2 新版功能.

imp.cache_from_source(path, debug_override=None)

返回与源 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 定义的 path 相关联的已编译字节码文件的路径。 举例来说，如果 path 为 /foo/bar/baz.py 则 Python 3.2 中的返回值将是 /foo/bar/__pycache__/baz.cpython-32.pyc。 字符串 cpython-32 来自于当前的魔术标签 (参见 get_tag(); 如果 sys.implementation.cache_tag 未定义则将引发 NotImplementedError)。 通过为 debug_override 传入 True 或 False 你可以覆盖系统设置的 __debug__ 值，以生成优化的字节码。

path 不必存在。

在 3.3 版更改: 如果 sys.implementation.cache_tag 为 None，则会引发 NotImplementedError。

3.4 版后已移除: 使用 importlib.util.cache_from_source() 来代替。

在 3.5 版更改: debug_override 形参不会再创建 .pyo 文件。

imp.source_from_cache(path)

根据给定的 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 文件名的 path，返回相关联的源代码文件路径。 举例来说，如果 path 为 /foo/bar/__pycache__/baz.cpython-32.pyc 则返回的路径将是 /foo/bar/baz.py。 path 不必已存在，但是如果它未遵循 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 格式，则会引发 ValueError。 如果未定义 sys.implementation.cache_tag，则会引发 NotImplementedError。

在 3.3 版更改: 当未定义 sys.implementation.cache_tag 时将引发 NotImplementedError。

3.4 版后已移除: 使用 importlib.util.source_from_cache() 来代替。

imp.get_tag()

返回与此 Python 版本魔数相匹配的 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 魔术标签字符串，如 get_magic() 所返回的。

3.4 版后已移除: 从 Python 3.3 开始直接使用 sys.implementation.cache_tag。

以下函数可以帮助与导入系统的内部锁定机制进行交互。 导入的锁定语义是一个可能在不同发布版之间发生改变的实现细节。 但是，Python 会确保循环导入操作不会出现任何死锁。

imp.lock_held()

如果当前持有全局导入锁则返回 True，否则返回 False。 在没有线程的系统平台上，将总是返回 False。

在有线程的平台上，执行导入的线程首先会持有一个全局导入锁，然后为导入其余部分设置模块专属锁。 这将阻止其他线程导入相同的模块直到原始导入完成，防止其他线程看到由原始线程构建的不完整的模块对象。 循环导入是个例外情况，它在构造上就必须在某一时刻暴露不完整的模块对象。

在 3.3 版更改: 锁定方案在大多数情况下都已改为按模块锁定。 对于某些关键任务会保留一个全局导入锁，比如初始化每个模块的锁。

3.4 版后已移除.

imp.acquire_lock()

为当前线程获取解释器的全局导入锁。 这个锁应当由导入钩子来使用以确保导入模块时的线程安全。

一旦某个线程获取了导入锁，同一个线程可以再次获取它而不会阻塞；该线程每次获得它都必须再释放它一次。

在没有线程的平台上，此函数将不做任何操作。

在 3.3 版更改: 锁定方案在大多数情况下都已改为按模块锁定。 对于某些关键任务会保留一个全局导入锁，比如初始化每个模块的锁。

3.4 版后已移除.

imp.release_lock()

释放解释器的全局导入锁。 在没有线程的平台上，此函数将不做任何操作。

在 3.3 版更改: 锁定方案在大多数情况下都已改为按模块锁定。 对于某些关键任务会保留一个全局导入锁，比如初始化每个模块的锁。

3.4 版后已移除.

以下是在本模块中定义的具有整数值的常量，用来表示 find_module() 的搜索结果。

imp.PY_SOURCE

模块作为一个源文件被发现。

3.3 版后已移除.

imp.PY_COMPILED

模块作为一个已编译代码对象文件被发现。

3.3 版后已移除.

imp.C_EXTENSION

模块作为动态可加载共享库被发现。

3.3 版后已移除.

imp.PKG_DIRECTORY

模块作为一个包目录被发现。

3.3 版后已移除.

imp.C_BUILTIN

模块作为一个内置模块被发现。

3.3 版后已移除.

imp.PY_FROZEN

模块作为一个冻结模块被发现。

3.3 版后已移除.

class imp.NullImporter(path_string)

NullImporter 类型是一个在无法找到任何模块时处理非目录路径字符串 PEP 302 [https://www.python.org/dev/peps/pep-0302] 导入钩子。 调用此类型时传入一个现有目录或空字符串将引发 ImportError。 在其他情况下，将返回一个 NullImporter 实例。

这些实例只有一个方法:

find_module(fullname[, path])

此方法总是返回 None，表示所请求的模块无法找到。

在 3.3 版更改: 将把 None 插入到 sys.path_importer_cache 而不是 NullImporter 的实例。

3.4 版后已移除: 改为将 None 插入到 sys.path_importer_cache。

例子

以下函数模拟了 Python 1.4 及之前版本的标准导入语句（没有多层级的模块名称）。 （这个 实现 不可用于那些版本，因为 find_module() 已经被扩展而 load_module() 在 1.4 中已被添加。）

import imp
import sys

def __import__(name, globals=None, locals=None, fromlist=None):
    # Fast path: see if the module has already been imported.
    try:
        return sys.modules[name]
    except KeyError:
        pass

    # If any of the following calls raises an exception,
    # there's a problem we can't handle -- let the caller handle it.

    fp, pathname, description = imp.find_module(name)

    try:
        return imp.load_module(name, fp, pathname, description)
    finally:
        # Since we may exit via an exception, close fp explicitly.
        if fp:
            fp.close()

mailcap --- Mailcap 文件处理

源代码: Lib/mailcap.py [https://github.com/python/cpython/tree/3.10/Lib/mailcap.py]

3.11 版后已移除: mailcap 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#mailcap] 了解详情）。 mimetypes 模块提供了一个替代品。

Mailcap 文件可用来配置支持 MIME 的应用程序例如邮件阅读器和 Web 浏览器如何响应具有不同 MIME 类型的文件。 ("mailcap" 这个名称源自短语 "mail capability"。) 例如，一个 mailcap 文件可能包含 video/mpeg; xmpeg %s 这样的行。 然后，如果用户遇到 MIME 类型为 video/mpeg 的邮件消息或 Web 文档时，%s 将被替换为一个文件名 (通常属于临时文件) 并且会自动启动 xmpeg 程序来查看该文件。

mailcap 格式的说明文档见 RFC 1524 [https://datatracker.ietf.org/doc/html/rfc1524.html], "A User Agent Configuration Mechanism For Multimedia Mail Format Information"，但它并不是一个互联网标准。 不过，mailcap 文件在大多数 Unix 系统上都受到支持。

mailcap.findmatch(caps, MIMEtype, key='view', filename='/dev/null', plist=[])

返回一个 2 元组；其中第一个元素是包含所要执行命令的字符串 (它可被传递给 os.system())，第二个元素是对应于给定 MIME 类型的 mailcap 条目。 如果找不到匹配的 MIME 类型，则将返回 (None, None)。

key 是所需字段的名称，它代表要执行的活动类型；默认值是 'view'，因为在最通常的情况下你只是想要查看 MIME 类型数据的正文。 其他可能的值还有 'compose' 和 'edit'，分别用于想要创建给定 MIME 类型正文或修改现有正文数据的情况。 请参阅 RFC 1524 [https://datatracker.ietf.org/doc/html/rfc1524.html] 获取这些字段的完整列表。

filename 是在命令行中用来替换 %s 的文件名；默认值 '/dev/null' 几乎肯定不是你想要的，因此通常你要通过指定一个文件名来覆盖它。

plist 可以是一个包含命名形参的列表；默认值只是一个空列表。 列表中的每个条目必须为包含形参名称的字符串、等于号 ('=') 以及形参的值。 Mailcap 条目可以包含形如 %{foo} 的命名形参，它将由名为 'foo' 的形参的值所替换。 例如，如果命令行 showpartial %{id} %{number} %{total} 是在一个 mailcap 文件中，并且 plist 被设为 ['id=1', 'number=2', 'total=3']，则结果命令行将为 'showpartial 1 2 3'。

在 mailcap 文件中，可以指定可选的 "test" 字段来检测某些外部条件（例如所使用的机器架构或窗口系统）来确定是否要应用 mailcap 行。 findmatch() 将自动检查此类条件并在检查未通过时跳过条目。

在 3.10.8 版更改: 为了防止使用 shell 元字符（在 shell 命令行中具有特殊效果的符号）的安全问题，findmatch 会拒绝把字母数字和 @+=:,./-_ 以外的 ASCII 字符注入被返回的命令行。

如果有不被允许的字符出现在 filename 中，findmatch 将总是返回 (None, None) 就如同未找到任何条目一样。 如果这样的字符出现在其他地方（在 plist 或 MIMEtype 中的值，findmatch 将忽略所有使用这些值的 mailcap 条目。 在两种情况下都将引发 警告。

mailcap.getcaps()

返回一个将 MIME 类型映射到 mailcap 文件条目列表的字典。 此字典必须被传给 findmatch() 函数。 条目会被存储为字典列表，但并不需要了解此表示形式的细节。

此信息来自在系统中找到的所有 mailcap 文件。 用户的 mailcap 文件 $HOME/.mailcap 中的设置将覆盖系统 mailcap 文件 /etc/mailcap, /usr/etc/mailcap 和 /usr/local/etc/mailcap 中的设置。

一个用法示例:

>>> import mailcap
>>> d = mailcap.getcaps()
>>> mailcap.findmatch(d, 'video/mpeg', filename='tmp1223')
('xmpeg tmp1223', {'view': 'xmpeg %s'})

msilib --- 读写 Microsoft Installer 文件

源代码: Lib/msilib/__init__.py [https://github.com/python/cpython/tree/3.10/Lib/msilib/__init__.py]

3.11 版后已移除: msilib 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#msilib] 了解详情）。

msilib 支持创建 Microsoft 安装程序 (.msi) 文件。 由于这种文件往往包含一个嵌入的 "cabinet" 文件 (.cab)，它也暴露了一个用于创建 CAB 文件的 API。 目前没有实现对读取 .cab 文件的支持；对于读取 .msi 数据库的支持则是可能的。

这个包的目标是提供对 .msi 文件中的全部表的完整访问，因此，它是一个相当低层级的 API。 这个包的两个主要应用是 distutils 命令 bdist_msi，以及创建 Python 安装程序包本身 (尽管它目前是使用不同版本的 msilib)。

这个包的内容可以大致分为四个部分：低层级 CAB 例程、低层级 MSI 例程、高层级 MSI 例程以及标准表结构。

msilib.FCICreate(cabname, files)

新建一个名为 cabname 的 CAB 文件。 files 必须是一个元组的列表，其中每个元组包含磁盘文件的名称，以及 CAB 文件内文件的名称。

这些文件将按照它们在列表中出现的顺序被添加到 CAB 文件中。 所有文件都会被添加到单个 CAB 文件，使用 MSZIP 压缩算法。

目前没有暴露 MSI 创建的各个步骤对 Python 的回调。

msilib.UuidCreate()

返回一个新的唯一标识符的字符串表示形式。 这封装了 Windows API 函数 UuidCreate() 和 UuidToString()。

msilib.OpenDatabase(path, persist)

通过调用 MsiOpenDatabase 来返回一个新的数据库对象。 path 为 MSI 文件的名称；persist 可以是常量 MSIDBOPEN_CREATEDIRECT, MSIDBOPEN_CREATE, MSIDBOPEN_DIRECT, MSIDBOPEN_READONLY 或 MSIDBOPEN_TRANSACT 中的一个，并可能包括旗标 MSIDBOPEN_PATCHFILE。 请参阅 Microsoft 文档了解这些旗标的含义；根据这些旗标，将打开一个现有数据库，或者创建一个新数据库。

msilib.CreateRecord(count)

通过调用 MSICreateRecord() 来返回一个新的记录对象。 count 为记录的字段数量。

msilib.init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)

创建并返回一个新的数据库 name，使用 schema 来初始化它，并设置属性 ProductName, ProductCode, ProductVersion 和 Manufacturer。

schema 必须是一个包含 tables 和 _Validation_records 属性的模块对象；在通常情况下，msilib.schema 应当被使用。

此此函数返回时该数据库将只包含表结构和验证记录。

msilib.add_data(database, table, records)

将所有 records 添加到 database 中名为 table 的表。

table 参数必须为 MSI 方案中预定义的表之一，即 'Feature', 'File', 'Component', 'Dialog', 'Control' 等等。

records 应当为一个元组的列表，其中的每个元组都包含与表结构对应的记录的所有字段。 对于可选字段，可以传入 None。

字段值可以为整数、字符串或 Binary 类的实例。

class msilib.Binary(filename)

代表 Binary 表中的条目；使用 add_data() 插入这样的对象会将名为 filename 文件读入表中。

msilib.add_tables(database, module)

将来自 module 的所有表内容添加到 database。 module 必须包括一个列出其内容需要被添加的所有表的属性 tables，并且每个具有实际内容的表对应一个属性。

这通常被用来安装序列表。

msilib.add_stream(database, name, path)

将文件 path 添加到 database 的 _Stream 表，使用流名称 name。

msilib.gen_uuid()

返回一个新的UUID, 符合MSI格式要求 (包含圆括号, 十六进制大写形式)

参见

FCICreate [https://msdn.microsoft.com/en-us/library/bb432265.aspx] UuidCreate [https://msdn.microsoft.com/en-us/library/windows/desktop/aa379205.aspx] UuidToString [https://msdn.microsoft.com/en-us/library/windows/desktop/aa379352.aspx]

数据对象

Database.OpenView(sql)

通过调用 MSIDatabaseOpenView() 返回一个视图对象。 sql 是要执行的 SQL 语句。statement to execute.

Database.Commit()

通过调用 MSIDatabaseCommit() 提交当前事务中挂起的修改。

Database.GetSummaryInformation(count)

通过调用 MsiGetSummaryInformation() 返回一个新的概要信息对象。 count 为已更新值的最大数量。

Database.Close()

通过 MsiCloseHandle() 关闭数据库对象。

3.7 新版功能.

参见

MSIDatabaseOpenView [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370082.aspx] MSIDatabaseCommit [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370075.aspx] MSIGetSummaryInformation [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370301.aspx] MsiCloseHandle [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370067.aspx]

视图对象

View.Execute(params)

通过 MSIViewExecute() 执行视图的 SQL 查询。 如果 params 不为 None，它应是一条描述查询中形参名称的实际值的记录。

View.GetColumnInfo(kind)

通过调用 MsiViewGetColumnInfo() 返回一条描述视图的列的记录。 kind 可以是 MSICOLINFO_NAMES 或 MSICOLINFO_TYPES。

View.Fetch()

通过调用 MsiViewFetch() 返回查询的结果记录。

View.Modify(kind, data)

通过调用 MsiViewModify() 改变视图。 kind 可以是 MSIMODIFY_SEEK，MSIMODIFY_REFRESH，MSIMODIFY_INSERT，MSIMODIFY_UPDATE，MSIMODIFY_ASSIGN，MSIMODIFY_REPLACE，MSIMODIFY_MERGE，MSIMODIFY_DELETE，MSIMODIFY_INSERT_TEMPORARY，MSIMODIFY_VALIDATE，MSIMODIFY_VALIDATE_NEW，MSIMODIFY_VALIDATE_FIELD，MSIMODIFY_VALIDATE_DELETE 中的一种。

data 必须是一个描述新数据的记录。

View.Close()

通过 MsiViewClose() 关闭窗口。

参见

MsiViewExecute [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370513.aspx] MSIViewGetColumnInfo [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370516.aspx] MsiViewFetch [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370514.aspx] MsiViewModify [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370519.aspx] MsiViewClose [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370510.aspx]

对象总览

SummaryInformation.GetProperty(field)

通过 MsiSummaryInfoGetProperty() 返回概要的特征属性。 field 是属性的名称，可以是常量 PID_CODEPAGE, PID_TITLE, PID_SUBJECT, PID_AUTHOR, PID_KEYWORDS, PID_COMMENTS, PID_TEMPLATE, PID_LASTAUTHOR, PID_REVNUMBER, PID_LASTPRINTED, PID_CREATE_DTM, PID_LASTSAVE_DTM, PID_PAGECOUNT, PID_WORDCOUNT, PID_CHARCOUNT, PID_APPNAME 或 PID_SECURITY 中的一个。

SummaryInformation.GetPropertyCount()

通过 MsiSummaryInfoGetPropertyCount() 返回概要特征属性的数量。

SummaryInformation.SetProperty(field, value)

通过 MsiSummaryInfoSetProperty() 设置特征属性。 field 可以有与 GetProperty() 相同的值。 value 是属性的新值。 可用的值类型有整数和字符串。

SummaryInformation.Persist()

使用 MsiSummaryInfoPersist() 将已修改的特征属性写入到概要信息流。

参见

MsiSummaryInfoGetProperty [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370409.aspx] MsiSummaryInfoGetPropertyCount [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370488.aspx] MsiSummaryInfoSetProperty [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370491.aspx] MsiSummaryInfoPersist [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370490.aspx]

记录对象

Record.GetFieldCount()

通过 MsiRecordGetFieldCount() 返回记录字段的数量。

Record.GetInteger(field)

在可能的情况下将 field 的值以整数形式返回。 field 必须为整数。

Record.GetString(field)

在可能的情况下将 field 的值以字符串形式返回。 field 必须为整数。

Record.SetString(field, value)

通过 MsiRecordSetString() 将 field 设为 value。 field 必须是一个整数；value 是一个字符串。

Record.SetStream(field, value)

通过 MsiRecordSetStream() 将 field 设为名为 value 的文件的内容。 field 必须是一个整数；value 是一个字符串。

Record.SetInteger(field, value)

通过 MsiRecordSetInteger() 将 field 设为 value。 field 和 value 必须为整数。

Record.ClearData()

通过 MsiRecordClearData() 将记录的所有字段设为 0。

参见

MsiRecordGetFieldCount [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370366.aspx] MsiRecordSetString [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370373.aspx] MsiRecordSetStream [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370372.aspx] MsiRecordSetInteger [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370371.aspx] MsiRecordClearData [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370364.aspx]

错误

所有 MSI 函数的包装器都会引发 MSIError；异常内部的字符串将包含更多细节。

CAB 对象

class msilib.CAB(name)

CAB 类代表一个 CAB 文件。 在 MSI 构建过程中，文件将被同时添加到 Files 表，以及 CAB 中。 然后，当所有文件添加完成时，即可写入 CAB 文件，再添加到 MSI 文件中。

name 是 MSI 文件中 CAB 文件的名称。

append(full, file, logical)

将路径名为 full 的文件添加到 CAB 文件中，命名为 logical。 如果已存在名为 logical 的文件，则会创建一个新的文件名。

返回文件在 CAB 文件中的索引，以及文件在 CAB 文件中的新名称。

commit(database)

生成一个 CAB 文件，以流方式添加到 MSI 文件，将其放入 Media 表，并从磁盘移除所生成的文件。

目录对象

class msilib.Directory(database, cab, basedir, physical, logical, default[, componentflags])

在目录表中创建一个新目录。 在每个时点上对于该目录都有一个当前组件，它或是通过 start_component() 显式创建，或是在文件首次被加入时隐式创建。 文件会被加入当前组件，并被加入到 cab 文件中。 要创建一个目录，必须指定一个基准目录对象 (可以为 None)，指向物理目录的路径，以及一个逻辑目录名称。 default 指明目录表中的 DefaultDir 槽位。 componentflags 指明新组件所获得的默认旗标。

start_component(component=None, feature=None, flags=None, keyfile=None, uuid=None)

向组件表添加一个条目，并将该组件设为此目录的当前组件。 如果未给出组件名称，则将使用目录名称。 如果未给出 feature，则将使用当前特征。 如果未给出 flags，则将使用目录的默认旗标。 如果未给出 keyfile，则组件表中的 KeyPath 将保持为空值。

add_file(file, src=None, version=None, language=None)

向目录的当前组件添加一个文件，如果没有当前组件则会新建一个。 在默认情况下，源中的文件名和文件表将保持一致。 如果指定了 src 文件，它将被解读为相对于当前目录。 作为可选项，可以为文件表中的条目指定 version 和 language。

glob(pattern, exclude=None)

向当前组件添加一个通过 glob 模式指定的文件列表。 单个文件可以在 exclude 列表中排除。

remove_pyc()

在卸载时移除 .pyc 文件。

参见

Directory Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368295.aspx] File Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368596.aspx] Component Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368007.aspx] FeatureComponents Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368579.aspx]

相关特性

class msilib.Feature(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0)

使用值 id, parent.id, title, desc, display, level, directory 和 attributes 向 Feature 表添加一条新记录。 结果特征对象可被传给 Directory 的 start_component() 方法。

set_current()

将此特征设为 msilib 的当前特征。 新组件会自动被添加到默认特征，除非显式指定了一个特征。

参见

特征表 [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368585.aspx]

GUI 类

msilib provides several classes that wrap the GUI tables in an MSI database. However, no standard user interface is provided; use bdist_msi to create MSI files with a user-interface for installing Python packages.

class msilib.Control(dlg, name)

对话框控件的基类。 dlg 是控件所属的对话框对象，name 是控件的名称。

event(event, argument, condition=1, ordering=None)

在 ControlEvent 表中为该控件创建一个条目。

mapping(event, attribute)

在 EventMapping 表中为该控件创建一个条目。

condition(action, condition)

在 ControlCondition 表中为该控件创建一个条目。

class msilib.RadioButtonGroup(dlg, name, property)

创建一个名为 name 的单选钮控件。 property 是当单选钮被选中时设置的安装器属性。

add(name, x, y, width, height, text, value=None)

向分组添加一个名为 name 的单选钮，设置坐标为 x, y, width, height，标签为 text。 如果 value 为 None，则设置默认值 name。

class msilib.Dialog(db, name, x, y, w, h, attr, title, first, default, cancel)

返回一个新的 Dialog 对象。 将在 Dialog 表中创建一个条目，设置指定的坐标，对话框属性，标题，首个、默认和取消控件的名称。

control(name, type, x, y, width, height, attributes, property, text, control_next, help)

返回一个新的 Control 对象。 将在 Control 表中创建带有指定形参的条目。

这是一个通用方法；对于特定的类型，还提供了专用的方法。

text(name, x, y, width, height, attributes, text)

添加并返回一个 Text 控件。

bitmap(name, x, y, width, height, text)

添加并返回一个 Bitmap 控件。

line(name, x, y, width, height)

添加并返回一个 Line 控件。

pushbutton(name, x, y, width, height, attributes, text, next_control)

添加并返回一个 PushButton 控件。

radiogroup(name, x, y, width, height, attributes, property, text, next_control)

添加并返回一个 RadioButtonGroup 控件。

checkbox(name, x, y, width, height, attributes, property, text, next_control)

添加并返回一个 CheckBox 控件。

参见

Dialog Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368286.aspx] Control Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368044.aspx] Control Types [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368039.aspx] ControlCondition Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368035.aspx] ControlEvent Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368037.aspx] EventMapping Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa368559.aspx] RadioButton Table [https://msdn.microsoft.com/en-us/library/windows/desktop/aa370962.aspx]

预计算的表

msilib 提供了一些仅包含结构模式和表定义的子包。 这些定义基于 MSI 2.0 版。

msilib.schema

这是基于 MSI 2.0 的标准 MSI 结构模式，其中 tables 变量提供了一个由表定义组成的列表，而 _Validation_records 提供了用于 MSI 验证的数据。

msilib.sequence

此模块包含针对标准序列表的表内容: AdminExecuteSequence, AdminUISequence, AdvtExecuteSequence, InstallExecuteSequence 和 InstallUISequence。

msilib.text

此模块包含 UIText 和 ActionText 表的定义，用于标准安装器动作。

nis --- Sun 的 NIS (黄页) 接口

3.11 版后已移除: nis 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#nis] 了解详情）。

nis 模块提供了对 NIS 库的轻量级包装，适用于多个主机的集中管理。

因为 NIS 仅存在于 Unix 系统，此模块仅在 Unix 上可用。

nis 模块定义了以下函数：

nis.match(key, mapname, domain=default_domain)

返回 key 在映射 mapname 中的匹配结果，如无结果则会引发错误 (nis.error)。 两个参数都应为字符串，key 定长 8 个比特。 返回值为任意字节数组（可包含 NULL 和其他特殊值）。

请注意如果 mapname 是另一名称的别名则会先检查别名。

domain 参数可允许覆盖用于查找的 NIS 域。 如果未指定，则会在默认 NIS 域中查找。

nis.cat(mapname, domain=default_domain)

返回一个字典，其元素为 key 到 value 的映射使得 match(key, mapname)==value。 请注意字典的键和值均为任意字节数组。

请注意如果 mapname 是另一名称的别名则会先检查别名。

domain 参数可允许覆盖用于查找的 NIS 域。 如果未指定，则会在默认 NIS 域中查找。

nis.maps(domain=default_domain)

返回全部可用映射的列表。

domain 参数可允许覆盖用于查找的 NIS 域。 如果未指定，则会在默认 NIS 域中查找。

nis.get_default_domain()

返回系统默认的 NIS 域。

nis 模块定义了以下异常：

exception nis.error

当 NIS 函数返回一个错误码时引发的异常。

nntplib --- NNTP 协议客户端

源代码: Lib/nntplib.py [https://github.com/python/cpython/tree/3.10/Lib/nntplib.py]

3.11 版后已移除: nntplib 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594] 了解详情）。

此模块定义了 NNTP 类来实现网络新闻传输协议的客户端。 它可被用于实现一个新闻阅读或发布器，或是新闻自动处理程序。 它兼容了 RFC 3977 [https://datatracker.ietf.org/doc/html/rfc3977.html] 以及较旧的 RFC 977 [https://datatracker.ietf.org/doc/html/rfc977.html] 和 RFC 2980 [https://datatracker.ietf.org/doc/html/rfc2980.html]。

下面是此模块的两个简单用法示例。 列出某个新闻组的一些统计数据并打印最近 10 篇文章的主题:

>>> s = nntplib.NNTP('news.gmane.io')
>>> resp, count, first, last, name = s.group('gmane.comp.python.committers')
>>> print('Group', name, 'has', count, 'articles, range', first, 'to', last)
Group gmane.comp.python.committers has 1096 articles, range 1 to 1096
>>> resp, overviews = s.over((last - 9, last))
>>> for id, over in overviews:
...     print(id, nntplib.decode_header(over['subject']))
...
1087 Re: Commit privileges for Łukasz Langa
1088 Re: 3.2 alpha 2 freeze
1089 Re: 3.2 alpha 2 freeze
1090 Re: Commit privileges for Łukasz Langa
1091 Re: Commit privileges for Łukasz Langa
1092 Updated ssh key
1093 Re: Updated ssh key
1094 Re: Updated ssh key
1095 Hello fellow committers!
1096 Re: Hello fellow committers!
>>> s.quit()
'205 Bye!'

要基于一个二进制文件发布文章 (假定文章包含有效的标头，并且你有在特定新闻组上发布内容的权限):

>>> s = nntplib.NNTP('news.gmane.io')
>>> f = open('article.txt', 'rb')
>>> s.post(f)
'240 Article posted successfully.'
>>> s.quit()
'205 Bye!'

此模块本身定义了以下的类:

class nntplib.NNTP(host, port=119, user=None, password=None, readermode=None, usenetrc=False[, timeout])

返回一个新的 NNTP 对象，代表一个对运行于主机 host，在端口 port 上监听的 NNTP 服务器的连接。 可以为套接字连接指定可选的 timeout。 如果提供了可选的 user 和 password，或者如果在 /.netrc 中存在适合的凭证并且可选的旗标 usenetrc 为真值，则会使用 AUTHINFO USER 和 AUTHINFO PASS 命令在服务器上标识和认证用户。 如果可选的旗标 readermode 为真值，则会在执行认证之前发送 mode reader 命令。 在某些时候如果你是连接本地机器上的 NNTP 服务器并且想要调用读取者专属命令如 group 那么还必须使用读取者模式。 如果你收到预料之外的 NNTPPermanentError，你可能需要设置 readermode。 NNTP 类支持使用 with 语句来无条件地消费 OSError 异常并在结束时关闭 NNTP 连接，例如:

>>> from nntplib import NNTP
>>> with NNTP('news.gmane.io') as n:
...     n.group('gmane.comp.python.committers')
...
('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
>>>

引发一个 审计事件 nntplib.connect，附带参数 self, host, port。

引发一个 审计事件 nntplib.putline，附带参数 self, line。

在 3.2 版更改: usenetrc 现在默认为 False。

在 3.3 版更改: 添加了对 with 语句的支持。

在 3.9 版更改: 如果 timeout 参数设置为 0，创建非阻塞套接字时，它将引发 ValueError 来阻止该操作。

class nntplib.NNTP_SSL(host, port=563, user=None, password=None, ssl_context=None, readermode=None, usenetrc=False[, timeout])

返回一个新的 NNTP_SSL 对象，代表一个对运行于主机 host，在端口 port 上监听的 NNTP 服务器的连接。 NNTP_SSL 对象具有与 NNTP 对象相同的方法。 如果 port 被省略，则会使用端口 563 (NNTPS)。 ssl_context 也是可选的，且为一个 SSLContext 对象。 请阅读 安全考量 来了解最佳实践。 所有其他形参的行为都与 NNTP 的相同。

请注意 RFC 4642 [https://datatracker.ietf.org/doc/html/rfc4642.html] 不再推荐使用 563 端口的 SSL，建议改用下文描述的 STARTTLS。 但是，某些服务器只支持前者。

引发一个 审计事件 nntplib.connect，附带参数 self, host, port。

引发一个 审计事件 nntplib.putline，附带参数 self, line。

3.2 新版功能.

在 3.4 版更改: 本类现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 （参阅 ssl.HAS_SNI）进行主机名检查。

在 3.9 版更改: 如果 timeout 参数设置为 0，创建非阻塞套接字时，它将引发 ValueError 来阻止该操作。

exception nntplib.NNTPError

派生自标准异常 Exception，这是 nntplib 模块中引发的所有异常的基类。 该类的实例具有以下属性:

response

可用的服务器响应，为一 str 对象。

exception nntplib.NNTPReplyError

从服务器收到意外答复时，将引发本异常。

exception nntplib.NNTPTemporaryError

收到 400--499 范围内的响应代码时所引发的异常。

exception nntplib.NNTPPermanentError

收到 500--599 范围内的响应代码时所引发的异常。

exception nntplib.NNTPProtocolError

当从服务器收到不是以数字 1--5 开头的答复时所引发的异常。

exception nntplib.NNTPDataError

当响应数据中存在错误时所引发的异常。

NNTP 对象

当连接时，NNTP 和 NNTP_SSL 对象支持以下方法和属性。

属性

NNTP.nntp_version

代表服务器所支持的 NNTP 协议版本的整数。 在实践中，这对声明遵循 RFC 3977 [https://datatracker.ietf.org/doc/html/rfc3977.html] 的服务器应为 2 而对其他服务器则为 1。

3.2 新版功能.

NNTP.nntp_implementation

描述 NNTP 服务器软件名称和版本的字符串，如果服务器未声明此信息则为 None。

3.2 新版功能.

方法

作为几乎全部方法所返回元组的第一项返回的 response 是服务器的响应：以三位数字代码打头的字符串。 如果服务器的响应是提示错误，则方法将引发上述异常之一。

以下方法中许多都接受一个可选的仅限关键字参数 file。 当提供了 file 参数时，它必须为打开用于二进制写入的 file object，或要写入的磁盘文件名称。 此类方法随后将把服务器返回的任意数据（除了响应行和表示结束的点号）写入到文件中；此类方法通常返回的任何行列表、元组或对象都将为空值。

在 3.2 版更改: 以下方法中许多都已被重写和修正，这使得它们不再与 3.1 中的同名方法相兼容。

NNTP.quit()

发送 QUIT 命令并关闭连接。 一旦此方法被调用，NNTP 对象的其他方法都不应再被调用。

NNTP.getwelcome()

返回服务器发送的欢迎消息，作为连接开始的回复。（该消息有时包含与用户有关的免责声明或帮助信息。）

NNTP.getcapabilities()

返回服务器所声明的 RFC 3977 [https://datatracker.ietf.org/doc/html/rfc3977.html] 功能，其形式为将功能名称映射到（可能为空的）值列表的 dict 实例。 在不能识别 CAPABILITIES 命令的旧式服务器上，会返回一个空字典。

>>> s = NNTP('news.gmane.io')
>>> 'POST' in s.getcapabilities()
True

3.2 新版功能.

NNTP.login(user=None, password=None, usenetrc=True)

发送 AUTHINFO 命令并附带用户名和密码。 如果 user 和 password 为 None 且 usenetrc 为真值，则会在可能的情况下使用来自 ~/.netrc 的凭证。

除非被有意延迟，登录操作通常会在 NNTP 对象初始化期间被执行因而没有必要单独调用此函数。 要强制延迟验证，你在创建该对象时不能设置 user 或 password，并必须将 usenetrc 设为 False。

3.2 新版功能.

NNTP.starttls(context=None)

发送 STARTTLS 命令。 这将在 NNTP 连接上启用加密。 context 参数是可选的且应为 ssl.SSLContext 对象。 请阅读 安全考量 了解最佳实践。

请注意此操作可能不会在传输验证信息之后立即完成，只要有可能验证默认会在 NNTP 对象初始化期间发生。 请参阅 NNTP.login() 了解有关如何屏蔽此行为的信息。

3.2 新版功能.

在 3.4 版更改: 此方法现在支持使用 ssl.SSLContext.check_hostname 和 服务器名称指示 (参见 ssl.HAS_SNI) 进行主机名检查。

NNTP.newgroups(date, *, file=None)

发送 NEWGROUPS 命令。 date 参数应为 datetime.date 或 datetime.datetime 对象。 返回一个 (response, groups) 对，其中 groups 是代表给定i date 以来所新建的新闻组。 但是如果提供了 file，则 groups 将为空值。

>>> from datetime import date, timedelta
>>> resp, groups = s.newgroups(date.today() - timedelta(days=3))
>>> len(groups)
85
>>> groups[0]
GroupInfo(group='gmane.network.tor.devel', last='4', first='1', flag='m')

NNTP.newnews(group, date, *, file=None)

发送 NEWNEWS 命令。 这里，group 是新闻组名称或为 '*'，而 date 与 newgroups() 中的含义相同。 返回一个 (response, articles) 对，其中 articles 为消息 ID 列表。

此命令经常会被 NNTP 服务器管理员禁用。

NNTP.list(group_pattern=None, *, file=None)

发送 LIST 或 LIST ACTIVE 命令。 返回一个 (response, list) 对，其中 list 是代表此 NNTP 服务器上所有可用新闻组的元组列表，并可选择匹配模式字符串 group_pattern。 每个元组的形式为 (group, last, first, flag)，其中 group 为新闻组名称，last 和 first 是最后一个和第一个文章的编号，而 flag 通常为下列值之一:

y: 允许来自组员的本地发帖和文章。

m: 新闻组受到管制因而所有发帖必须经过审核。

n: 不允许本地发帖，只允许来自组员的文章。

j: 来自组员的文章会被转入垃圾分组。

x: 不允许本地发帖，而来自组员的文章会被忽略。

=foo.bar: 文章会被转入 foo.bar 分组。

如果 flag 具有其他值，则新闻组的状态应当被视为未知。

此命令可能返回非常庞大的结果，特别是当未指明 group_pattern 的时候。 最好是离线缓存其结果，除非你确实需要刷新它们。

在 3.2 版更改: 增加了 group_pattern。

NNTP.descriptions(grouppattern)

发送 LIST NEWSGROUPS 命令，其中 grouppattern 为 RFC 3977 [https://datatracker.ietf.org/doc/html/rfc3977.html] 中规定的 wildmat 字符串（它实际上与 DOS 或 UNIX shell 通配字符串相同）。 返回一个 (response, descriptions) 对，其中 descriptions 是将新闻组名称映射到文本描述的字典。

>>> resp, descs = s.descriptions('gmane.comp.python.*')
>>> len(descs)
295
>>> descs.popitem()
('gmane.comp.python.bio.general', 'BioPython discussion list (Moderated)')

NNTP.description(group)

获取单个新闻组 group 的描述。 如果匹配到一个以上的新闻组（如果 'group' 是一个真实的 wildmat 字符串），则返回第一个匹配结果。 如果未匹配到任何新闻组，则返回空字符串。

此方法略去了来自服务器的响应代码。 如果需要响应代码，请使用 descriptions()。

NNTP.group(name)

发送 GROUP 命令，其中 name 为新闻组名称。 该新闻组如果存在，则会被选定为当前新闻组。 返回一个元组 (response, count, first, last, name)，其中 count 是该新闻组中（估计的）文章数量，first 是新闻组中第一篇文章的编号，last 是新闻组中最后一篇文章的编号，而 name 是新闻组名称。

NNTP.over(message_spec, *, file=None)

发送 OVER 命令，或是旧式服务器上的 XOVER 命令。 message_spec 可以是表示消息 ID 的字符串，或是指明当前新闻组内文章范围的数字元组 (first, last)，或是指明当前新闻组内从 (first, None) first 到最后一篇文章的元组，或者为 None 表示选定当前新闻组内的当前文章。

返回一个 (response, overviews) 对。 其中 overviews 是一个包含 (article_number, overview) 元组的列表，每个元组对应 message_spec 所选定的一篇文章。 每个 overview 则是包含同样数量条目的字典，但具体数量取决于服务器。 这些条目或是为消息标头（对应键为小写的标头名称）或是为 metadata 项（对应键为以 ":" 打头的 metadata 名称）。 以下条目会由 NNTP 规范描述来确保提供:

subject, from, date, message-id 和 references 标头

:bytes metadata: 整个原始文章数据的字节数（包括标头和消息体）

:lines metadata: 文章消息体的行数

每个条目的值或者为字符串，或者在没有值时为 None。

建议在标头值可能包含非 ASCII 字符的时候对其使用 decode_header() 函数:

>>> _, _, first, last, _ = s.group('gmane.comp.python.devel')
>>> resp, overviews = s.over((last, last))
>>> art_num, over = overviews[0]
>>> art_num
117216
>>> list(over.keys())
['xref', 'from', ':lines', ':bytes', 'references', 'date', 'message-id', 'subject']
>>> over['from']
'=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= <martin@v.loewis.de>'
>>> nntplib.decode_header(over['from'])
'"Martin v. Löwis" <martin@v.loewis.de>'

3.2 新版功能.

NNTP.help(*, file=None)

发送 HELP 命令。 返回一个 (response, list) 对，其中 list 为帮助字符串列表。

NNTP.stat(message_spec=None)

发送 STAT 命令，其中 message_spec 为消息 ID (包裹在 '<' 和 '>' 中) 或者当前新闻组中的文章编号。 如果 message_spec 被省略或为 None，则会选择当前新闻组中的当前文章。 反回一个三元组 (response, number, id)，其中 number 为文章编号而 id 为消息 ID。

>>> _, _, first, last, _ = s.group('gmane.comp.python.devel')
>>> resp, number, message_id = s.stat(first)
>>> number, message_id
(9099, '<20030112190404.GE29873@epoch.metaslash.com>')

NNTP.next()

发送 NEXT 命令。 返回与 stat() 类似的结果。

NNTP.last()

发送 LAST 命令。 返回与 stat() 类似的结果。

NNTP.article(message_spec=None, *, file=None)

发送 ARTICLE 命令，其中 message_spec 的含义与 stat() 中的相同。 返回一个元组 (response, info)，其中 info 是一个 namedtuple，包含三个属性 number, message_id 和 lines (按此顺序)。 number 是新闻组中的文章数量 (或者如果该信息不可用则为 0)，message_id 为字符串形式的消息 ID，而 lines 为由包括标头和消息体的原始消息的行组成的列表 (不带末尾换行符)。

>>> resp, info = s.article('<20030112190404.GE29873@epoch.metaslash.com>')
>>> info.number
0
>>> info.message_id
'<20030112190404.GE29873@epoch.metaslash.com>'
>>> len(info.lines)
65
>>> info.lines[0]
b'Path: main.gmane.org!not-for-mail'
>>> info.lines[1]
b'From: Neal Norwitz <neal@metaslash.com>'
>>> info.lines[-3:]
[b'There is a patch for 2.3 as well as 2.2.', b'', b'Neal']

NNTP.head(message_spec=None, *, file=None)

与 article() 类似，但会发送 HEAD 命令。 返回的 lines (或写入到 file) 将只包含消息标头，不包含消息体。

NNTP.body(message_spec=None, *, file=None)

与 article() 类似，但会发送 BODY 命令。 返回的 lines (或写入到 file) 将只包含消息体，不包含标头。

NNTP.post(data)

使用 POST 命令发布文章。 data 参数是以二进制读取模式打开的 file object，或是任意包含字节串对象的可迭代对象 (表示要发布的文章的原始行数据)。 它应当代表一篇适当格式的新闻组文章，包含所需的标头。 post() 方法会自动对以 . 打头的行数据进行转义并添加结束行。

如果此方法执行成功，将返回服务器的响应。 如果服务器拒绝响应，则会引发 NNTPReplyError。

NNTP.ihave(message_id, data)

发送 IHAVE 命令。 message_id 为要发给服务器的消息 ID (包裹在 '<' 和 '>' 中)。 data 形参和返回值与 post() 的一致。

NNTP.date()

返回一个 (response, date) 对。 date 是包含服务器当前日期与时间的 datetime 对象。

NNTP.slave()

发送 SLAVE 命令。 返回服务器的 响应。

NNTP.set_debuglevel(level)

设置实例的调试级别。 它控制着打印调试输出信息的数量。 默认值 0 不产生调试输出。 值 1 产生中等数量的调试输出，通常每个请求或响应各产生一行。 大于等于 2 的值产生最多的调试输出，在连接上发送和接收的每一行信息都会被记录下来（包括消息文本）。

以下是在 RFC 2980 [https://datatracker.ietf.org/doc/html/rfc2980.html] 中定义的可选 NNTP 扩展。 其中一些已被 RFC 3977 [https://datatracker.ietf.org/doc/html/rfc3977.html] 中的新命令所取代。

NNTP.xhdr(hdr, str, *, file=None)

发送 XHDR 命令。 hdr 参数是标头关键字，例如 'subject'。 str 参数的形式应为 'first-last'，其中 first 和 last 是要搜索的首篇和末篇文章编号。 返回一个 (response, list) 对，其中 list 是 (id, text) 对的列表，其中 id 是文章编号（字符串类型）而 text 是该文章的请求标头。 如果提供了 file 形参，则 XHDR 命令的输出会保存到文件中。 如果 file 为字符串，则此方法将打开指定名称的文件，向其写入内容并将其关闭。 如果 file 为 file object，则将在该文件对象上调用 write() 方法来保存命令所输出的行信息。 如果提供了 file，则返回的 list 将为空列表。

NNTP.xover(start, end, *, file=None)

发送 XOVER 命令。 start 和 end 是限制所选取文章范围的文章编号。 返回值与 over() 的相同。 推荐改用 over()，因为它将在可能的情况下自动使用更新的 OVER 命令。

工具函数

这个模块还定义了下列工具函数:

nntplib.decode_header(header_str)

解码标头值，恢复任何被转义的非 ASCII 字符。 header_str 必须为 str 对象。 将返回被恢复的值。 推荐使用此函数来以人类可读的形式显示某些标头:

>>> decode_header("Some subject")
'Some subject'
>>> decode_header("=?ISO-8859-15?Q?D=E9buter_en_Python?=")
'Débuter en Python'
>>> decode_header("Re: =?UTF-8?B?cHJvYmzDqG1lIGRlIG1hdHJpY2U=?=")
'Re: problème de matrice'

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

源代码： Lib/optparse.py [https://github.com/python/cpython/tree/3.10/Lib/optparse.py]

3.2 版后已移除: optparse 模块已被弃用并且将不再继续开发；开发将转至 argparse 模块进行。

optparse 是一个相比原有 getopt 模块更为方便、灵活和强大的命令行选项解析库。 optparse 使用更为显明的命令行解析风格：创建一个 OptionParser 的实例，向其中填充选项，然后解析命令行。 optparse 允许用户以传统的 GNU/POSIX 语法来指定选项，并为你生成额外的用法和帮助消息。

下面是在一个简单脚本中使用 optparse 的示例:

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()

通过这几行代码，你的脚本的用户可以在命令行上完成“常见任务”，例如:

<yourscript> --file=outfile -q

在它解析命令行时，optparse 会根据用户提供的命令行值设置 parse_args() 所返回的 options 对象的属性。 当 parse_args() 从解析此命令行返回时，options.filename 将为 "outfile" 而 options.verbose 将为 False。 optparse 支持长短两种形式的选项，允许多个短选项合并到一起，并允许选项以多种方式与其参数相关联。 因此，以下命令行均等价于以上示例:

<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

此外，用户还可以运行以下命令之一

<yourscript> -h
<yourscript> --help

这样 optparse 将打印出你的脚本的选项概要:

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

其中 yourscript 的值是在运行时确定的 (通常来自 sys.argv[0])。

背景

optparse 被显式设计为鼓励创建带有简洁直观、符合惯例的命令行接口的程序。 为了这个目标，它仅支持最常见的命令行语法和在 Unix 下使用的规范语义。 如果你不熟悉这些惯例，请阅读本小节来使自己熟悉它们。

术语

argument -- 参数

在命令行中输入的字符串，并会被 shell 传给 execl() 或 execv()。 在 Python 中，参数将是 sys.argv[1:] 的元素 (sys.argv[0] 是被执行的程序的名称)。 Unix shell 也使用术语 "word" 来指代参数。

有时替换 sys.argv[1:] 以外的参数列表也是必要的，所以你应当将 "参数" 当作是 "sys.argv[1:] 的一个元素，或者是作为 sys.argv[1:] 的替代的其他列表"。

选项

一个用来提供额外信息以指导或定制程序的执行的参数。 对于选项有许多不同的语法；传统的 Unix 语法是一个连字符 ("-") 后面跟单个字母，例如 -x 或 -F。 此外，传统的 Unix 语法允许将多个选项合并为一个参数，例如 -x -F 就等价于 -xF。 GNU 项目引入了 -- 后面跟一串以连字符分隔的单词，例如 --file 或 --dry-run。 它们是 optparse 所提供的仅有的两种选项语法。

存在于世上的其他一些选项语法包括:

一个连字符后面跟几个字母，例如 -pf (这与多个选项合并成单个参数 并不 一样)

一个连字符后面跟一个完整单词，例如 -file (这在技术上等同于前面的语法，但它们通常不在同一个程序中出现)

一个加号后面跟一个字母，或几个字母，或一个单词，例如 +f, +rgb

一个斜杠后面跟一个字母，或几个字母，或一个单词，例如 /f, /file

这些选项语法都不被 optparse 所支持，也永远不会支持。 这是有意为之的：前三种在任何环境下都是非标准的，而最后一种只在你专门针对 Windows 或某些旧平台（例如 VMS, MS-DOS）时才有意义。

可选参数:

一个跟在某个选项之后的参数，与该选项紧密相关，并会在该选项被消耗时从参数列表中被消耗。 使用 optparse，选项参数可以是其对应选项以外的一个单独参数:

-f foo
--file foo

或是包括在同一个参数中:

-ffoo
--file=foo

通常，一个给定的选项将接受一个参数或是不接受。 许多人想要“可选的可选参数”特性，即某些选项将在看到特定参数时接受它，而如果没看到特定参数则不接受。 在某种程度上说这一特性是存在争议的，因它它将使解析发生歧义：如果 -a 接受一个可选参数而 -b 是完全不同的另一个选项，那我们该如何解读 -ab 呢？ 由于这会存在歧义，因此 optparse 不支持这一特性。

positional argument -- 位置参数

在解析选项之后，即在选项及其参数解析完成并从参数列表中移除后参数列表中余下的内容。

必选选项

必须在命令行中提供的选项；请注意在英文中 "required option" 这个短语是自相矛盾的。 optparse 不会阻止你实现必须选项，但也不会在这方面给你什么帮助。

例如，考虑这个假设的命令行:

prog -v --report report.txt foo bar

-v 和 --report 都是选项。 假定 --report 接受一个参数，report.txt 是一个选项参数。 foo 和 bar 是位置参数。

选项的作用是什么？

选项被用来提供额外信息以便微调或定制程序的执行。 需要明确的一点是，选项通常都是 可选的。 一个程序应当能在没有设置任何选项的的情况下正常运行。 （从 Unix 或 GNU 工具集中随机挑选一个程序。 它是否能在未设置任何选项的情况下运行并且仍然得到有意义的结果？ 主要的例外有 find, tar 和 dd --- 它们都是些因为语法不标准和界面混乱而受到公正抨击的变异奇行种。）

有很多人希望他们的程序具有“必需选项”。 请再思考一下。 如果某个项是必需的，那么它就 不是可选的！ 如果你的程序必需要有某项信息才能成功运行，则它更适合作为位置参数。

作为良好的命令行界面设计的一个例子，请看基本的用于拷贝文件的 cp 工具。 试图拷贝文件而不提供一个目标和至少一个源是没有什么意义的。 因此，如果你不带参数地运行 cp 它将会报错。 不过，它具有一个完全不需要任何选项的灵活、易用的语法:

cp SOURCE DEST
cp SOURCE ... DEST-DIR

你只使用这个语法就能畅行无阻。 大多数 cp 实现还提供了许多精确调整文件拷贝方式的选项：你可以保留模式和修改时间，避免跟随符号链接，覆盖现有文件之前先询问，诸如此类。 但这些都不会破坏 cp 的核心任务，即将一个文件拷贝为另一个文件，或将多个文件拷贝到另一个目录。

位置参数有什么用？

位置参数是对于你的程序运行来说绝对、肯定需要的信息片段。

一个好的用户界面应当尽可能少地设置绝对必需提供的信息。 如果你的程序必需提供 17 项不同的信息片段才能成功运行，那么你要 如何 从用户获取这些信息将不是问题的关键 --- 大多数人会在他们成功运行此程序之前放弃并离开。 无论用户界面是命令行、配置文件还是 GUI 都一样适用：如果你对你的用户提出如此多的要求，它们大多将会直接放弃。

简而言之，请尽量最小化绝对要求用户提供的信息量 --- 只要有可能就使用合理的默认值。 当然，你希望程序足够灵活也是合理的。 这就是选项的作用。 同样，选项是配置文件中的条目，GUI 中的“首选项”对话框中的控件，还是命令行选项不是问题的关键 --- 你实现的选项越多，你的程序就越灵活，它的具体实现也会变得更为复杂。 当然，太大的灵活性也存在缺点；过多的选项会让用户更难掌握并使你的代码更难维护。

教程

虽然 optparse 非常灵活和强大，但在大多数情况下它也很简明易用。 本小节介绍了任何基于 optparse 的程序中常见的代码模式。

首先，你需要导入 OptionParser 类；然后在主程序的开头部分，创建一个 OptionParser 实例:

from optparse import OptionParser
...
parser = OptionParser()

然后你可以开始定义选项。 基本语法如下:

parser.add_option(opt_str, ...,
                  attr=value, ...)

每个选项有一个或多个选项字符串，如 -f 或 --file，以及一些选项属性用来告诉 optparse 当它在命令行中遇到该选项时将得到什么和需要做什么。

通常，每个选项都会有一个短选项字符串和一个长选项字符串，例如

parser.add_option("-f", "--file", ...)

你可以随你的喜好自由定义任意数量的短选项字符串和任意数量的长选项字符串（包括零个），只要总计至少有一个选项字符串。

传给 OptionParser.add_option() 的选项字符串实际上是特定调用所定义的选项的标签。 为了表述简单，我们将经常会说在命令行中 遇到一个选项；而实际上，optparse 是遇到了 选项字符串 并根据它们来查找选项。

一旦你定义好所有的选项，即可指令 optparse 来解析你的程序的命令行:

(options, args) = parser.parse_args()

（如果你愿意，你可以将自定义的参数列表传给 parse_args()，但很少有必要这样做：默认它将使用 sys.argv[1:]。）

parse_args() 返回两个值：

options，一个包含你所有的选项的值的对象 --- 举例来说，如果 --file 接受一个字符串参数，则 options.file 将为用户所提供的文件名，或者如果用户未提供该选项则为 None

args，由解析选项之后余下的位置参数组成的列表

本教学章节只介绍了四个最重要的选项属性: action, type, dest (destination) 和 help。 其中，action 是最基本的一个。

理解选项动作

动作是告诉 optparse 当它在命令行中遇到某个选项时要做什么。 有一个固定的动作集被硬编码到 optparse 内部；添加新的动作是将在 扩展 optparse 章节中介绍的进阶内容。 大多数动作都是告诉 optparse 将特定的值存储到某个变量中 --- 例如，从命令行接收一个字符串并将其存储到 options 的某个选项中。

如果你没有指定一个选项动作，optparse 将默认选择 store。

store 动作

最常用的选项动作是 store，它告诉 optparse 接收下一个参数（或当前参数的剩余部分），确认其为正确的类型，并将其保存至你选择的目标。

例如：

parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")

现在让我们编一个虚假的命令行并让 optparse 来解析它:

args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)

当 optparse 看到选项字符串 -f 时，它将获取下一个参数 foo.txt，并将其保存到 options.filename 中。 因此，在这个对 parse_args() 的调用之后，options.filename 将为 "foo.txt"。

受到 optparse 支持的其他一些选项类型有 int 和 float。 下面是一个接受整数参数的选项:

parser.add_option("-n", type="int", dest="num")

请注意这个选项没有长选项字符串，这是完全可接受的。 而且，它也没有显式的动作，因为使用默认的 store。

让我们解析另一个虚假的命令行。 这一次，我们将让选项参数与选项紧贴在一起：因为 -n42 (一个参数) 与 -n 42 (两个参数) 是等价的，以下代码

(options, args) = parser.parse_args(["-n42"])
print(options.num)

将会打印 42。

如果你没有指明类型，optparse 会假定类型为 string。 加上默认动作为 store 这一事实，意味着我们的第一个示例可以变得更加简短:

parser.add_option("-f", "--file", dest="filename")

如果你没有提供目标，optparse 会从选项字符串推断出一个合理的默认目标：如果第一个长选项字符串为 --foo-bar，则默认目标为 foo_bar。 如果没有长选项字符串，则 optparse 会查找第一个短选项字符串：针对 -f 的默认目标将为 f。

optparse 还包括了内置的 complex 类型。 添加类型的方式将在 扩展 optparse 一节中介绍。

处理布尔值（旗标）选项

旗标选项 --- 当看到特定选项时将某个变量设为真值或假值 --- 是相当常见的。 optparse 通过两个单独的动作支持它们，store_true 和 store_false。 例如，你可能会有个 verbose 旗标将通过 -v 来启用并通过 -q 来禁用:

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")

这里我们有两个相同目标的不同选项，这是完全可行的。 （只是这意味着在设置默认值时你必须更加小心 --- 见下文所述。）

当 optparse 在命令行中遇到 -v 时，它会将 options.verbose 设为 True；当它遇到 -q 时，则会将 options.verbose 设为 False。

其他动作

受到 optparse 支持的其他动作还有:

"store_const"

存储一个常量值，通过 Option.const 预设

"append"

将此选项的参数添加到一个列表

"count"

让指定的计数器加一

"callback"

调用指定函数

这些在 参考指南，以及 选项回调 等章节中有说明。

默认值

上述示例全都涉及当看到特定命令行选项时设置某些变量（即“目标”）的操作。 如果从未看到这些选项那么会发生什么叱？由于我们没有提供任何默认值，它们全都会被设为 None。 这通常是可以的，但有时你会想要更多的控制。 optparse 允许你为每个目标提供默认值，它们将在解析命令行之前被赋值。

首先，考虑这个 verbose/quiet 示例。 如果我们希望 optparse 将 verbose 设为 True 除非看到了 -q，那么我们可以这样做:

parser.add_option("-v", action="store_true", dest="verbose", default=True)
parser.add_option("-q", action="store_false", dest="verbose")

由于默认值将应用到 destination 而不是任何特定选项，并且这两个选项正好具有相同的目标，因此这是完全等价的:

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose", default=True)

考虑一下：

parser.add_option("-v", action="store_true", dest="verbose", default=False)
parser.add_option("-q", action="store_false", dest="verbose", default=True)

同样地，verbose 的默认值将为 True: 最终生效的将是最后提供给任何特定目标的默认值。

一种更清晰的默认值指定方式是使用 OptionParser 的 set_defaults() 方法，你可以在调用 parse_args() 之前的任何时候调用它:

parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()

如前面一样，最终生效的将是最后为特定选项目标指定的值。 为清楚起见，请使用一种或另外一种设置默认值的方法，而不要同时使用。

生成帮助

optparse 自动生成帮助和用法文本的功能适用于创建用户友好的命令行界面。 你所要做的只是为每个选项提供 help 值，并可选项为你的整个程序提供一条简短的用法消息。 下面是一个填充了用户友好的（文档）选项的 OptionParser:

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]")

如果 optparse 在命令行中遇到了 -h 或 --help，或者如果你调用了 parser.print_help()，它会把以下内容打印到标准输出:

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]

（如果帮助输出是由 help 选项触发的，optparse 将在打印帮助文本之后退出。）

在这里为帮助 optparse 生成尽可能好的帮助消息做了很多工作:

该脚本定义了自己的用法消息:

usage = "usage: %prog [options] arg1 arg2"

optparse 会将用法字符串中的 %prog 扩展为当前程序的名称，即 os.path.basename(sys.argv[0])。 随后将在详细选项帮助之前打印这个经过扩展的字符串。

如果你未提供用法字符串，optparse 将使用一个直白而合理的默认值: "Usage: %prog [options]"，这在你的脚本不接受任何位置参数时是可以的。

每个选项都定义了帮助字符串，并且不用担心换行问题 --- optparse 将负责执行换行并使帮助输出有良好的外观格式。

需要接受值的选项会在它们自动生成的帮助消息中提示这一点，例如对于 "mode" 选项:

-m MODE, --mode=MODE

在这里，"MODE" 被称为元变量：它代表预期用户会提供给 -m/--mode 的参数。 在默认情况下，optparse 会将目标变量名转换为大写形式并将其用作元变量。 有时，这并不是你所希望的 --- 例如，--filename 选项显式地设置了 metavar="FILE"，结果将自动生成这样的选项描述:

-f FILE, --filename=FILE

不过，这具有比节省一点空间更重要的作用：手动编写的帮助文本使用元变量 FILE 来提示用户在半正式的语法 -f FILE 和非正式的描述 "write output to FILE" 之间存在联系。 这是一种使你的帮助文本更清晰并对最终用户来说更易用的简单而有效的方式。

具有默认值的选项可以在帮助字符串中包括 %default --- optparse 将用该选项的默认值的 str() 来替代它。 如果一个选项没有默认值 (或默认值为 None)，则 %default 将被扩展为 none。

选项分组

在处理大量选项时，可以方便地将选项进行分组以提供更好的帮助输出。 OptionParser 可以包含多个选项分组，每个分组可以包含多个选项。

选项分组是使用 OptionGroup 类来生成的:

class optparse.OptionGroup(parser, title, description=None)

其中

parser 是分组将被插入的 OptionParser 实例

title 是分组的标题

description，可选项，是分组的长描述文本

OptionGroup 继承自 OptionContainer (类似 OptionParser) 因此 add_option() 方法可被用来向分组添加选项。

一旦声明了所有选项，使用 OptionParser 方法 add_option_group() 即可将分组添加到之前定义的解析器。

继续使用前一节定义的解析器，很容易将 OptionGroup 添加到解析器中:

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)

这将产生以下帮助输出:

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.

更完整一些的示例可能涉及使用多个分组：继续扩展之前的例子:

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)

这会产生以下输出:

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

另一个有趣的方法，特别适合在编程处理选项分组时使用:

OptionParser.get_option_group(opt_str)

返回短或长选项字符串 opt_str (例如 '-o' 或 '--option') 所属的 OptionGroup。 如果没有对应的 OptionGroup，则返回 None。

打印版本字符串

与简短用法字符串类似，optparse 还可以打印你的程序的版本字符串。 你必须将该字符串作为 version 参数提供给 OptionParser:

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

%prog 会像在 usage 中那样被扩展。 除了这一点，version 还可包含你想存放的任何东西。 当你提供它时，optparse 将自动向你的解析器添加一个 --version 选项。 如果它在命令行中遇到了该选项，它将扩展你的 version 字符串 (通过替换 %prog)，将其打印到标准输出，然后退出。

举例来说，如果你的脚本是 /usr/bin/foo:

$ /usr/bin/foo --version
foo 1.0

下列两个方法可被用来打印和获取 version 字符串:

OptionParser.print_version(file=None)

将当前程序的版本消息 (self.version) 打印到 file (默认为 stdout)。 就像 print_usage() 一样，任何在 self.version 中出现的 %prog 将被替换为当前程序的名称。 如果 self.version 为空或未定义则不做任何操作。

OptionParser.get_version()

与 print_version() 相似但是会返回版本字符串而不是打印它。

optparse 如何处理错误handles errors

optparse 必须考虑两种宽泛的错误类：程序员错误和用户错误。 程序员错误通常是对 OptionParser.add_option() 的错误调用，例如无效的选项字符串，未知的选项属性，不存在的选项属性等等。 这些错误将以通常的方式来处理：引发一个异常 (或者是 optparse.OptionError 或者是 TypeError) 并让程序崩溃。

处理用户错误更为重要，因为无论你的代码有多稳定他们都肯定会发生。 optparse 可以自动检测部分用户错误，例如不正确的选项参数（如传入 -n 4x 而 -n 接受整数参数），缺少参数（如 -n 位于命令行的末尾，而 -n 接受任意类型的参数）。 并且，你可以调用 OptionParser.error() 来指明应用程序自定义的错误条件:

(options, args) = parser.parse_args()
...
if options.a and options.b:
    parser.error("options -a and -b are mutually exclusive")

在两种情况下，optparse 都是以相同方式处理错误的：它会将程序的用法消息和错误消息打印到标准错误并附带错误状态 2 退出。

考虑上面的第一个示例，当用户向一个接受整数的选项传入了 4x:

$ /usr/bin/foo -n 4x
Usage: foo [options]

foo: error: option -n: invalid integer value: '4x'

或者，当用户未传入任何值:

$ /usr/bin/foo -n
Usage: foo [options]

foo: error: -n option requires an argument

optparse 生成的错误消息总是会确保提示在错误中涉及的选项；请确保在从你的应用程序代码调用 OptionParser.error() 时也做同样的事。

如果 optparse 的默认错误处理行为不适合你的需求，你需要子类化 OptionParser 并重写它的 exit() 和/或 error() 方法。

合并所有代码

下面是基于 optparse 的脚本通常的结构:

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()

参考指南

创建解析器

使用 optparse 的第一步是创建 OptionParser 实例。

class optparse.OptionParser(...)

OptionParser 构造器没有必需的参数，只有一些可选的关键字参数。 你应当始终以关键字参数形式传入它们，即不要依赖于声明参数所在位置的顺序。

usage (默认: "%prog [options]")

当你的程序不正确地运行或附带 help 选项运行时将打印的用法说明。 当 optparse 打印用法字符串时，它会将 %prog 扩展为 os.path.basename(sys.argv[0]) (或者如果你传入 prog 则为该关键字参数值)。 要屏蔽用法说明，请传入特殊值 optparse.SUPPRESS_USAGE。

option_list (默认: [])

一个用于填充解析器的由 Option 对象组成的列表。 option_list 中的选项将添加在 standard_option_list (一个可由 OptionParser 的子类设置的类属性) 中的任何选项之后，以及任何版本或帮助选项之前。 已被弃用；请改为在创建解析器之后使用 add_option()。

option_class (默认: optparse.Option)

当在 add_option() 中向解析器添加选项时要使用的类。

version (默认: None)

当用户提供了 version 选项时将会打印的版本字符串。 如果你为 version 提供真值，optparse 将自动添加单个选项字符串 --version 形式的 version 选项。 子字符串 %prog 会以与 usage 相同的方式扩展。

conflict_handler (默认: "error")

指定当有相互冲突的选项字符串的选项被添加到解析器时要如何做；参见 选项之间的冲突 一节。

description (默认: None)

一段提供你的程序的简短介绍的文本。 optparse 会重格式化段落以适合当前终端宽度并在用户请求帮助时打印其内容（在 usage 之后，选项列表之前）。

formatter (默认: 一个新的 IndentedHelpFormatter)

一个将被用于打印帮助文本的 optparse.HelpFormatter 实例。 optparse 为此目的提供了两个实体类: IndentedHelpFormatter 和 TitledHelpFormatter。

add_help_option (默认: True)

如为真值，optparse 将向解析器添加一个 help 选项 (使用选项字符串 -h 和 --help)。

prog

当在 usage 和 version 中用于代替 os.path.basename(sys.argv[0]) 来扩展 %prog 的字符串。

epilog (默认: None)

一段将在选项帮助之后打印的帮助文本。

填充解析器

有几种方式可以为解析器填充选项。 最推荐的方式是使用 OptionParser.add_option()，如 教程 一节所演示的。 add_option() 可以通过两种方式来调用:

传入一个 Option 实例（即 make_option() 所返回的对象）

传入 make_option() 可接受的（即与 Option 构造器相同的）任意位置和关键字参数组合，它将为你创建 Option 实例

另一种方式是将由预先构造的 Option 实例组成的列表传给 OptionParser 构造器，如下所示:

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)

(make_option() 是一个用于创建 Option 实例的工厂函数；目前它是 Option 构造器的一个别名。 未来的 optparse 版本可能会将 Option 拆分为多个类，而 make_option() 将选择适当的类来实例化。 请不要直接实例化 Option。)

定义选项

每个 Option 实例代表一组同义的命令行选项字符串，例如 -f 和 --file。 你可以指定任意数量的短和长选项字符串，但你必须指定总计至少一个选项字符串。

创建 Option 的正规方式是使用 OptionParser 的 add_option() 方法。

OptionParser.add_option(option)

OptionParser.add_option(*opt_str, attr=value, ...)

定义只有一个短选项字符串的选项:

parser.add_option("-f", attr=value, ...)

以及定义只有一个长选项字符串的选项:

parser.add_option("--foo", attr=value, ...)

该关键字参数定义新 Option 对象的属性。 最重要的选项属性是 action，它主要负责确定其他的属性是相关的还是必须的。 如果你传入了不相关的选项属性，或是未能传入必须的属性，optparse 将引发一个 OptionError 异常来说明你的错误。

选项的 action 决定当 optparse 在命令行中遇到该选项时要做什么。 硬编码在 optparse 中的标准选项动作有:

"store"

存储此选项的参数（默认）

"store_const"

存储一个常量值，通过 Option.const 预设

"store_true"

存储 True

"store_false"

存储 False

"append"

将此选项的参数添加到一个列表

"append_const"

将指定常量值添加到一个列表，可通过 Option.const 预设

"count"

让指定的计数器加一

"callback"

调用指定函数

"help"

打印用法消息，包括所有选项和它们的文档

（如果你没有提供动作，则默认为 "store"。 对于此动作，你还可以提供 type 和 dest 选项属性；参见 标准选项动作。）

如你所见，大多数动作都涉及在某处保存或更新一个值。 optparse 总是会为此创建一个特殊对象，在习惯上命名为 options (它恰好是 optparse.Values 的实例)。 选项参数 (以及几种其他的值) 将根据 dest (目标) 选项属性被保存为该对象的属性。

例如，当你调用

parser.parse_args()

optparse 首先会做的一件事情是创建 options 对象:

options = Values()

如果该解析器中的某个选项定义带有

parser.add_option("-f", "--file", action="store", type="string", dest="filename")

并且被解析的命令行包括以下任意一项:

-ffoo
-f foo
--file=foo
--file foo

那么 optparse 在看到此选项时，将执行这样的操作

options.filename = "foo"

type 和 dest 选项属性几乎与 action 一样重要，但 action 是唯一对 所有 选项都有意义的。

选项属性

下列选项属性可以作为关键字参数传给 OptionParser.add_option()。 如果你传入一个与特定选项无关的选项属性，或是未能传入必要的选项属性，optparse 将会引发 OptionError。

Option.action

(默认: "store")

用于当在命令行中遇到此选项时确定 optparse 的行为；可用的选项记录在 这里。

Option.type

(默认: "string")

此选项所接受的参数类型 (例如 "string" 或 "int")；可用的选项类型记录在 这里。

Option.dest

(默认: 获取自选项字符串)

如果此选项的动作涉及在某处写入或修改一个值，该属性将告诉 optparse 将它写入到哪里: dest 指定 optparse 在解析命令行时构建的 options 对象的某个属性。

Option.default

当未在命令行中遇到此选项时将被用作此选项的目标的值。 另请参阅 OptionParser.set_defaults()。

Option.nargs

(默认: 1)

当遇到此选项时应当读取多少个 type 类型的参数。 如果 > 1，optparse 会将由多个值组成的元组保存到 dest。

Option.const

对于保存常量值的动作，指定要保存的常量值。

Option.choices

对于 "choice" 类型的选项，由用户可选择的字符串组成的列表。

Option.callback

对于使用 "callback" 动作的选项，当遇到此选项时要调用的可调用对象。 请参阅 选项回调 一节了解关于传给可调用对象的参数的详情。

Option.callback_args

Option.callback_kwargs

将在四个标准回调参数之后传给 callback 的额外的位置和关键字参数。

Option.help

当用户提供 help 选项 (例如 --help) 之后将在列出所有可用选项时针对此选项打印的帮助文本。 如果没有提供帮助文本，则列出选项时将不附带帮助文本。 要隐藏此选项，请使用特殊值 optparse.SUPPRESS_HELP。

Option.metavar

(默认: 获取自选项字符串)

当打印帮助文本时要使用的代表选项参数的名称。 请参阅 教程 一节查看相应示例。

标准选项动作

各种选项动作具有略微不同的要求和效果。 大多数动作都具有几个可被你指定的独步选项属性用来控制 optparse 的行为；少数还具有一些必需属性，你必须为任何使用该动作的选项指定这些属性。

"store" [关联: type, dest, nargs, choices]

该选项后必须跟一个参数，它将根据 type 被转换为相应的值并保存至 dest。 如果 nargs > 1，则将从命令行读取多个参数；它们将全部根据 type 被转换并以元组形式保存至 dest。 参见 标准选项类型 一节。

如果提供了 choices (由字符串组成的列表和元组)，则类型默认为 "choice"。

如果未提供 type，则默认为 "string"。

如果未提供 dest，则 optparse 会从第一个长选项字符串派生出目标 (例如 --foo-bar 将对应 foo_bar)。 如果不存在长选项字符串，则 optparse 会从第一个短选项字符串派生出目标 (例如 -f 将对应 f)。

示例:

parser.add_option("-f")
parser.add_option("-p", type="float", nargs=3, dest="point")

当它解析命令行

-f foo.txt -p 1 -3.5 4 -fbar.txt

optparse 将设置

options.f = "foo.txt"
options.point = (1.0, -3.5, 4.0)
options.f = "bar.txt"

"store_const" [要求: const; 关联: dest]

值 const 将存放到 dest 中。

示例:

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")

如果看到了 --noisy，optparse 将设置

options.verbose = 2

"store_true" [关联: dest]

将 True 存放到 dest 中的 "store_const" 的特例。

"store_false" [关联: dest]

类似于 "store_true"，但是存放 False。

示例:

parser.add_option("--clobber", action="store_true", dest="clobber")
parser.add_option("--no-clobber", action="store_false", dest="clobber")

"append" [关联: type, dest, nargs, choices]

该选项必须跟一个参数，该参数将被添加到 dest 的列表中。 如果未提供 dest 的默认值，那么当 optparse 首次在命令行中遇到该选项时将自动创建一个空列表。 如果 nargs > 1，则会读取多个参数，并将一个长度为 nargs 的元组添加到 dest。

type 和 dest 的默认值与 "store" 动作的相同。

示例:

parser.add_option("-t", "--tracks", action="append", type="int")

如果在命令行中遇到 -t3，optparse 将执行这样的操作:

options.tracks = []
options.tracks.append(int("3"))

如果，在稍后的时候，再遇到 --tracks=4，它将执行:

options.tracks.append(int("4"))

append 动作会在选项的当前值上调用 append 方法。 这意味着任何被指定的默认值必须具有 append 方法。 这还意味着如果默认值非空，则其中的默认元素将存在于选项的已解析值中，而任何来自命令行的值将被添加到这些默认值之后:

>>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])
>>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])
>>> opts.files
['~/.mypkg/defaults', 'overrides.mypkg']

"append_const" [需要: const; 关联: dest]

与 "store_const" 类似，但 const 值将被添加到 dest；与 "append" 一样，dest 默认为 None，并且当首次遇到该选项时将自动创建一个空列表。

"count" [关联: dest]

对保存在 dest 的整数执行递增。 如果未提供默认值，则 dest 会在第一次执行递增之前被设为零。

示例:

parser.add_option("-v", action="count", dest="verbosity")

第一次在命令行中看到 -v 时，optparse 将执行这样的操作:

options.verbosity = 0
options.verbosity += 1

后续每次出现 -v 都将导致

options.verbosity += 1

"callback" [需要: callback; 关联: type, nargs, callback_args, callback_kwargs]

调用 callback 所指定的函数，它将以如下形式被调用

func(option, opt_str, value, parser, *args, **kwargs)

请参阅 选项回调 一节了解详情。

"help"

为当前选项解析器中所有的选项打印完整帮助消息。 该帮助消息是由传给 OptionParser 的构造器的 usage 字符串和传给每个选项的 help 字符串构造而成的。

如果没有为某个选项提供 help 字符串，它仍将在帮助消息中列出。 要完全略去某个选项，请使用特殊值 optparse.SUPPRESS_HELP。

optparse 将自动为所有OptionParser 添加 help 选项，因此你通常不需要创建选项。

示例:

from optparse import OptionParser, SUPPRESS_HELP

# usually, a help option is added automatically, but that can
# be suppressed using the add_help_option argument
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)

如果 optparse 在命令行中看到 -h 或 --help，它将将类似下面这样的帮助消息打印到 stdout (假设 sys.argv[0] 为 "foo.py"):

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

在打印帮助消息之后，optparse 将使用 sys.exit(0) 来终结你的进程。

"version"

将提供给 OptionParser 的版本号打印到 stdout 并退出。 该版本号实际上是由 OptionParser 的 print_version() 方法进行格式化并打印的。 这通常只在向 OptionParser 构造器提供了 version 参数时才有意义。 与 help 选项类似，你很少会创建 version 选项，因为 optparse 会在需要时自动添加它们。

标准选项类型

optparse 有五种内置选项类型: "string", "int", "choice", "float" 和 "complex"。 如果你需要添加新的选项类型，请参阅 扩展 optparse 一节。

传给 string 类型选项的参数不会以任何方式进行检查或转换：命令行中的文本将被原样保存至目标（或传给回调）。

整数参数 ("int" 类型) 将以如下方式解析:

如果数字开头为 0x，它将被解析为十六进制数

如果数字开头为 0，它将被解析为八进制数

如果数字开头为 0b，它将被解析为二进制数

在其他情况下，数字将被解析为十进制数

转换操作是通过调用 int() 并传入适当的 base (2, 8, 10 或 16) 来完成的。 如果转换失败， optparse 也将失败，但它会附带更有用的错误消息。

"float" 和 "complex" 选项参数会直接通过 float() 和 complex() 来转换，使用类似的错误处理。

"choice" 选项是 "string" 选项的子类型。 choices 选项属性（由字符串组成的序列）定义了允许的选项参数的集合。 optparse.check_choice() 将用户提供的选项参数与这个主列表进行比较并会在给出无效的字符串时引发 OptionValueError。

解析参数

创建和填充 OptionParser 的基本目的是调用其 parse_args() 方法:

(options, args) = parser.parse_args(args=None, values=None)

输入参数的位置

args

要处理的参数列表 (默认: sys.argv[1:])

values

要用于存储选项参数的 optparse.Values 对象 (默认：一个新的 Values 实例) -- 如果你给出一个现有对象，则不会基于它来初始化选项的默认值

返回值为

options

同一个对象将作为 values，或 optparse 所创建的 optparse.Values 实例传入

args

在所有选项被处理完毕后余下的位置参数

最常见的用法是不提供任何关键字参数。 如果你提供了 values，它将通过重复的 setattr() 调用来修改（大致为每个存储到指定选项目标的选项参数调用一次）并由 parse_args() 返回。

如果 parse_args() 在参数列表中遇到任何错误，它将调用 OptionParser 的 error() 方法并附带适当的最终用户错误消息。 这会完全终结你的进程并将退出状态设为 2 (传统的针对命令行错误的 Unix 退出状态)。

查询和操纵你的选项解析器

选项解析器的默认行为可被轻度地定制，并且你还可以调整你的选项解析器查看实际效果如何。 OptionParser 提供了一些方法来帮助你进行定制:

OptionParser.disable_interspersed_args()

设置解析在第一个非选项处停止。 举例来说，如果 -a 和 -b 都是不接受参数的简单选项，则 optparse 通常会接受这样的语法:

prog -a arg1 -b arg2

并会这样处理它

prog -a -b arg1 arg2

要禁用此特性，则调用 disable_interspersed_args()。 这将恢复传统的 Unix 语法，其中选项解析会在第一个非选项参数处停止。

如果你用一个命令处理程序来运行另一个拥有它自己的选项的命令而你希望参确保这些选项不会被混淆就可以使用此方法。 例如，每个命令可能具有不同的选项集合。

OptionParser.enable_interspersed_args()

设置解析不在第一个非选项处停止，允许多个命令行参数的插入相互切换。 这是默认的行为。

OptionParser.get_option(opt_str)

返回具有选项字符串 opt_str 的的 Option 实例，或者如果不存在具有该选项字符串的选项则返回 None。

OptionParser.has_option(opt_str)

如果 OptionParser 包含一个具有选项字符串 opt_str 的选项 (例如 -q 或 --verbose) 则返回 True。

OptionParser.remove_option(opt_str)

如果 OptionParser 包含一个对应于 opt_str 的选项，则移除该选项。 如果该选项提供了任何其他选项字符串，这些选项字符串将全部不可用。 如果 opt_str 不存在于任何属于此 OptionParser 的选项之中，则会引发 ValueError。

选项之间的冲突

如果你不够小心，很容易会定义具有相互冲突的选项字符串的多个选项:

parser.add_option("-n", "--dry-run", ...)
...
parser.add_option("-n", "--noisy", ...)

（当你自定义具有某些标准选项的 OptionParser 时特别容易发生这种情况。）

每当你添加一个选项时，optparse 会检查它是否与现有选项冲突。 如果发现存在冲突，它将唤起当前的冲突处理机制。 你可以选择在构造器中设置冲突处理机制:

parser = OptionParser(..., conflict_handler=handler)

或是在单独调用中设置:

parser.set_conflict_handler(handler)

可用的冲突处理器有:

"error" (默认)

将选项冲突视为编程错误并引发 OptionConflictError

"resolve"

智能地解决选项冲突（见下文）

举例来说，让我们定义一个智能地解决冲突的 OptionParser 并向其添加相互冲突的选项:

parser = OptionParser(conflict_handler="resolve")
parser.add_option("-n", "--dry-run", ..., help="do no harm")
parser.add_option("-n", "--noisy", ..., help="be noisy")

这时，optparse 会检测到之前添加的选项已经在使用 -n 选项字符串。 由于 conflict_handler 为 "resolve"，它将通过在之前选项的选项字符串列表中移除 -n 来解决冲突。 现在 --dry-run 将是用户激活该选项的唯一方式。 如果用户要获取帮助，帮助消息将反映这一变化:

Options:
  --dry-run     do no harm
  ...
  -n, --noisy   be noisy

之前添加的选项有可能不断更取代直到一个都不剩，这样用户将无法再从命令行唤起相应的选项。 在这种情况下，optparse 将完全移除这样的选项，使它不会在帮助文本或任何其他地方显示。 如果我们继续修改现有的 OptionParser:

parser.add_option("--dry-run", ..., help="new dry-run option")

这时，原有的 -n/--dry-run 选项将不再可用，因此 optparse 会将其移除，帮助文本将变成这样:

Options:
  ...
  -n, --noisy   be noisy
  --dry-run     new dry-run option

清理

OptionParser 实例存在一些循环引用。 这对 Python 的垃圾回收器来说应该不是问题，但你可能希望在你完成对 OptionParser 的使用后通过调用其 destroy() 来显式地中断循环引用。 这在可以从你的 OptionParser 访问大型对象图的长期运行应用程序中特别有用。

其他方法

OptionParser 还支持其他一些公有方法:

OptionParser.set_usage(usage)

根据上述的规则为 usage 构造器关键字参数设置用法字符串。 传入 None 将设置默认的用法字符串；使用 optparse.SUPPRESS_USAGE 将屏蔽用法消息。

OptionParser.print_usage(file=None)

将当前程序的用法消息 (self.usage) 打印到 file (默认为 stdout)。 出现在 self.usage 中的字符串 %prog 将全部被替换为当前程序的名称。 如果 self.usage 为空或未定义则不做任何事情。

OptionParser.get_usage()

与 print_usage() 类似但是将返回用法字符串而不是打印它。

OptionParser.set_defaults(dest=value, ...)

一次性地为多个选项目标设置默认值。 使用 set_defaults() 是为选项设置默认值的推荐方式同，因为多个选项可以共享同一个目标。 举例来说，如果几个 "mode" 选项全部设置了相同的目标，则它们中的任何一个都可以设置默认值，而最终生效的将是最后一次设置的默认值:

parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced",
                  default="novice")    # overridden below
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # overrides above setting

为避免混淆，请使用 set_defaults():

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")

选项回调

当 optparse 的内置动作和类型不能满足你的需要时，你有两个选择：扩展 optparse 或定义一个回调选项。 扩展 optparse 的方式更为通用，但对许多简单场景来说是大材小用了。 你所需要的往往只是一个简单的回调。

定义一个回调选项分为两步:

使用 "callback" 动作定义选项本身

编写回调；它是一个接受至少四个参数的函数（或方法），如下所述

定义回调选项

一般来说，定义回调选项的最简单方式是使用 OptionParser.add_option() 方法。 在 action 之外，你必须指定的唯一选项属性是 callback，即要调用的函数:

parser.add_option("-c", action="callback", callback=my_callback)

callback 是一个函数（或其他可调用对象），因此当你创建这个回调选项时你必须已经定义了 my_callback()。 在这个简单的例子中，optparse 甚至不知道 -c 是否接受任何参数，这通常意味着该选项不接受任何参数 --- 它需要知道的就是存在命令行参数 -c。 但是，在某些情况下，你可能希望你的回调接受任意数量的命令行参数。 这是编写回调的一个麻烦之处；本小节将稍后讲解这个问题。

optparse 总是会向你的回调传递四个特定参数，它只会在你通过 callback_args 和 callback_kwargs 进行指定时才传入额外的参数。 因此，最小化的回调函数签名如下:

def my_callback(option, opt, value, parser):

对传给回调的四个参数的说明见下文。

当你定义回调选项时还可以提供一些其他的选项属性:

type

具有其通常的含义：与在 "store" 或 "append" 动作中一样，它指示 optparse 读取一个参数并将其转换为 type。 但是，optparse 并不会将所转换的值保存到某个地方，而是将其传给你的回调函数。

nargs

同样具有其通常的含义：如果提供了该属性并且其值 > 1，optparse 将读取 nargs 个参数，每个参数都必须可被转换为 type。 随后它会将被转换值的元组传给你的回调。

callback_args

一个要传给回调的由额外位置参数组成的元组

callback_kwargs

一个要传给回调的由额外关键字参数组成的字典

回调应当如何调用

所有回调都将使用以下方式调用:

func(option, opt_str, value, parser, *args, **kwargs)

其中

option

是调用该回调的 Option 实例

opt_str

是在触发回调的命令行参数中出现的选项字符串。 （如果使用了长选项的缩写形式，则 opt_str 将为完整规范的选项字符串 --- 举例来说，如果用户在命令行中将 --foo 作为 --foobar 的缩写形式，则 opt_str 将为 "--foobar"。）

value

是在命令行中提供给该选项的参数。 optparse 将只在设置了 type 的时候才接受参数；value 将为该选项的类型所指定的类型。 如果该选项的 type 为 None (不接受参数)，则 value 将为 None。 如果 nargs > 1，则 value 将为由指定类型的值组成的元组。

parser

是驱动选项解析过程的 OptionParser 实例，主要作用在于你可以通过其实例属性访问其他一些相关数据:

parser.largs

当前的剩余参数列表，即已被读取但不属于选项或选项参数的参数。 可以任意修改 parser.largs，例如向其添加更多的参数。 （该列表将成为 args，即 parse_args() 的第二个返回值。）

parser.rargs

当前的保留参数列表，即移除了 opt_str 和 value (如果可用)，并且只有在它们之后的参数才会被保留。 可以任意修改 parser.rargs，例如通过读取更多的参数。

parser.values

作为选项值默认保存位置的对象（一个 optparse.OptionValues 实例）。 这使得回调能使用与 optparse 的其他部分相同的机制来保存选项值；你不需要手动处理全局变量或闭包。 你还可以访问或修改在命令行中遇到的任何选项的值。

args

是一个由通过 callback_args 选项属性提供的任意位置参数组成的元组。

kwargs

是一个由通过 callback_kwargs 提供的任意关键字参数组成的字典。

在回调中引发错误

如果选项或其参数存在任何问题则回调函数应当引发 OptionValueError。 optparse 将捕获该异常并终止程序，将你提供的错误消息打印到 stderr。 你的消息应当清晰、简洁、准确并指明出错的选项。 否则，用户将很难弄清楚自己做错了什么。

回调示例 1：最简回调

下面是一个不接受任何参数，只是简单地记录所遇见的选项的回调选项示例:

def record_foo_seen(option, opt_str, value, parser):
    parser.values.saw_foo = True

parser.add_option("--foo", action="callback", callback=record_foo_seen)

当然，你也可以使用 "store_true" 动作做到这一点。

回调示例 2：检查选项顺序

下面是一个更有趣些的示例：当看到 -a 出现时将会记录，而如果它在命令行中出现于 -b 之后则将报告错误。

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")

回调示例 3：检查选项顺序（通用）

如果你希望为多个类似的选项重用此回调（设置旗标，而在看到 -b 出现时触发），则需要一些额外工作：它设置的错误消息和旗标必须进行通用化。

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')

回调示例 4：检查任意条件

当然，你可以设置任何条件 --- 并不限于检查已定义选项的值。 举例来说，如果你有一个不应当在满月时被调用的选项，你就可以这样做:

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")

（定义 is_moon_full() 的任务将作为留给读者的练习。）

回调示例 5：固定的参数

当你定义接受固定数量参数的 callback 选项时情况会变得更有趣一点。 指定一个 callback 选项接受参数的操作类似于定义一个 "store" 或 "append" 选项：如果你定义 type，那么该选项将接受一个必须可被转换为相应类型的参数；如果你进一步定义 nargs，那么该选项将接受 nargs 个参数。

下面是一个模拟了标准 "store" 动作的示例:

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")

请注意 optparse 将为你读取 3 个参数并将它们转换为整数；你所要做的只是保存它们。 （或任何其他操作；对于这个示例显然你不需要使用回调。）

回调示例 6：可变的参数

当你想要一个选项接受可变数数量的参数时情况会变得更麻烦一点。 对于这种场景，你必须编写一个回调，因为 optparse 没有为它提供任何内置的相应功能。 而你必须处理 optparse 通常会为你处理的传统 Unix 命令行的某些细节问题。 特别地，回调应当实现单个 -- 和 - 参数的惯例规则:

-- 或 - 都可以作为选项参数

单个 -- (如果不是某个选项的参数): 停止命令行处理并丢弃该 --

单个 - (如果不是某个选项的参数): 停止命令行处理但保留 - (将其添加到 parser.largs)

如果你想要一个选项接受可变数量的参数，那么有几个微妙、棘手的问题需要考虑到。 你选择的具体实现将基于你的应用程序对于各方面利弊的权衡（这就是为什么 optparse 没有直接支持这一功能）。

无论如何，下面是一个对于接受可变参数的选项的回调的尝试:

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)

扩展 optparse

由于控制 optparse 如何读取命令行选项的两个主要因子是每个选项的动作和类型，所以扩展最可能的方向就是添加新的动作和新的类型。

添加新的类型

要添加新的类型，你必须自定义 optparse 的 Option 类的子类。 这个类包含几个用来定义 optparse 的类型的属性: TYPES 和 TYPE_CHECKER。

Option.TYPES

一个由类型名称组成的元组；在你的子类中，简单地定义一个在标准元组基础上构建的新元组 TYPES。

Option.TYPE_CHECKER

一个将类型名称映射到类型检查函数的字典。 类型检查函数具有如下签名:

def check_mytype(option, opt, value)

其中 option 是一个 Option 实例，opt 是一个选项字符串 (例如 -f)，而 value 是来自命令行的必须被检查并转换为你想要的类型的字符串。 check_mytype() 应当返回假设的类型 mytype 的对象。 类型检查函数所返回的值将最终出现在 OptionParser.parse_args() 所返回的 OptionValues 实例中，或是作为 value 形参传给一个回调。

如果你的类型检查函数遇到任何问题则应当引发 OptionValueError。 OptionValueError 接受一个字符串参数，该参数将被原样传递给 OptionParser 的 error() 方法，该方法将随后附加程序名称和字符串 "error:" 并在终结进程之前将所有信息打印到 stderr。

下面这个很傻的例子演示了如何添加一个 "complex" 选项类型以便在命令行中解析 Python 风格的复数。 （现在这个例子比以前更傻了，因为 optparse 1.3 增加了对复数的内置支持，但是不必管它了。）

首先，必要的导入操作:

from copy import copy
from optparse import Option, OptionValueError

你必须先定义自己的类型检查器，因为以后它会被引用（在你的 Option 子类的 TYPE_CHECKER 类属性中）:

def check_complex(option, opt, value):
    try:
        return complex(value)
    except ValueError:
        raise OptionValueError(
            "option %s: invalid complex value: %r" % (opt, value))

最后，是 Option 子类:

class MyOption (Option):
    TYPES = Option.TYPES + ("complex",)
    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    TYPE_CHECKER["complex"] = check_complex

（如果我们不对 Option.TYPE_CHECKER 执行 copy()，我们就将修改 optparse 的 Option 类的 TYPE_CHECKER 属性。 Python 就是这样，除了礼貌和常识以外没有任何东西能阻止你这样做。）

就是这样！ 现在你可以编写一个脚本以与其他基于 optparse 的脚本相同的方式使用新的选项类型，除了你必须指示你的 OptionParser 使用 MyOption 而不是 Option:

parser = OptionParser(option_class=MyOption)
parser.add_option("-c", type="complex")

作为替代选择，你可以构建你自己的选项列表并将它传给 OptionParser；如果你不是以上述方式使用 add_option()，则你不需要告诉 OptionParser 使用哪个选项类:

option_list = [MyOption("-c", action="store", type="complex", dest="c")]
parser = OptionParser(option_list=option_list)

添加新的动作

添加新的动作有一点复杂，因为你必须理解 optparse 对于动作有几种分类:

"store" 类动作

会使得 optparse 将某个值保存到当前 OptionValues 实例的特定属性中的动作；这些选项要求向 Option 构造器提供一个 dest 属性。attribute to be supplied to the constructor.

"typed" 类动作

从命令行接受某个值并预期它是一个特定类型；或者更准确地说，是可被转换为一个特定类型的字符串的动作。 这些选项要求向 Option 构造器提供一个 type 属性。attribute to the constructor.

这些是相互重叠的集合：默认的 "store" 类动作有 "store", "store_const", "append" 和 "count"，而默认的 "typed" 类动作有 "store", "append" 和 "callback"。

当你添加一个动作时，你需要将它列在 Option 的以下类属性的至少一个当中以对它进行分类（全部为字符串列表）:

Option.ACTIONS

所有动作必须在 ACTIONS 中列出。

Option.STORE_ACTIONS

"store" 类动作要额外地在此列出。

Option.TYPED_ACTIONS

"typed" 类动作要额外地在此列出。

Option.ALWAYS_TYPED_ACTIONS

总是会接受一个类型的动作（即其选项总是会接受一个值）要额外地在此列出。 它带来的唯一影响是 optparse 会将默认类型 "string" 赋值给动作在 ALWAYS_TYPED_ACTIONS 中列出而未显式指定类型的选项。

为了真正实现你的新动作，你必须重写 Option 的 take_action() 方法并添加一个识别你的动作的分支。

例如，让我们添加一个 "extend" 动作。 它类似于标准的 "append" 动作，但 "extend" 不是从命令行接受单个值并将其添加到现有列表，而是接受形式为以单个逗号分隔的多个值的字符串，并用这些值来扩展现有列表。 也就是说，如果 --names 是一个类型为 "string" 的 "extend" 选项，则命令行

--names=foo,bar --names blah --names ding,dong

将得到一个列表

["foo", "bar", "blah", "ding", "dong"]

我们再定义一个 Option 的子类:

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)

应注意的特性:

"extend" 既预期在命令行接受一个值又会将该值保存到某处，因此它同时被归类于 STORE_ACTIONS 和 TYPED_ACTIONS。

为确保 optparse 将 "string" 的默认类型赋值给 "extend" 动作，我们同时将 "extend" 动作归类于 ALWAYS_TYPED_ACTIONS。

MyOption.take_action() 只实现了这一个新动作，并将控制权回传给 Option.take_action() 以执行标准的 optparse 动作。

values 是 optparse_parser.Values 类的一个实例，该类提供了非常有用的 ensure_value() 方法。 ensure_value() 实际就是一个带有安全阀的 getattr()；它的调用形式为

values.ensure_value(attr, value)

如果 values 的 attr 属性不存在或为 None，则 ensure_value() 会先将其设为 value，然后返回该值。 这非常适用于 "extend", "append" 和 "count" 等动作，它们会将数据累积在一个变量中并预期该变量属于特定的类型（前两项是一个列表，后一项是一个整数）。 使用 ensure_value() 意味着使用你的动作的脚本无需关心为相应的选项目标设置默认值；可以简单地保持默认的 None 则 ensure_value() 将在必要时负责为其设置适当的值。

ossaudiodev --- 访问兼容OSS的音频设备

3.11 版后已移除: ossaudiodev 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#ossaudiodev] 了解详情）。

该模块允许您访问 OSS（开放式音响系统）音频接口。 OSS 可用于广泛的开源和商业 Unices，并且是 Linux 和最新版本的 FreeBSD 的标准音频接口。

在 3.3 版更改: 此模块中过去会引发 IOError 的操作现在将引发 OSError。

参见

开放之声系统程序员指南 [http://www.opensound.com/pguide/oss.pdf]

OSS C API 的官方文档

该模块定义了大量由OSS设备驱动提供的常量； 请参阅 <sys/soundcard.h> Linux 或 FreeBSD 上的列表。

ossaudiodev 定义了下列变量和函数:

exception ossaudiodev.OSSAudioError

此异常会针对特定错误被引发。 其参数为一个描述错误信息的字符串。

（如果 ossaudiodev 从系统调用例如 open(), write() 或 ioctl() 接收到错误，它将引发 OSError。 由 ossaudiodev 直接检测到的错误将引发 OSSAudioError。）

（为了向下兼容，此异常类也可通过 ossaudiodev.error 访问。）

ossaudiodev.open(mode)

ossaudiodev.open(device, mode)

打开一个音频设备并返回 OSS 音频设备对象。 此对象支持许多文件类方法，例如 read(), write() 和 fileno() (不过传统的 Unix 读/写语义与 OSS 音频设备的存在一些细微的差异)。 它还支持一些音频专属的方法；完整的方法列表见下文。

device 是要使用的音频设备文件名。 如果未指定，则此模块会先在环境变量 AUDIODEV 中查找要使用的设备。 如果未找到，它将回退为 /dev/dsp。

mode 可以为 'r' 表示只读（录音）访问，'w' 表示只写（回放）访问以及 'rw' 表示同时读写。 由于许多声卡在同一时间只允许单个进程打开录音机或播放器，因此好的做法是只根据活动的需要打开设备。 并且，有些声卡是半双工的：它们可以被打开用于读取或写入，但不能同时读写。

请注意这里特殊的调用语法: first 参数是可选的，而第二个参数则是必需的。 这是出于历史原因要与 ossaudiodev 所替代的 linuxaudiodev 模块保持兼容。

ossaudiodev.openmixer([device])

打开一个混音设备并返回 OSS 混音设备对象。 device 是要使用的混音设备文件名。 如果未指定，则此模块会先在环境变量 MIXERDEV 中查找要使用的设备。 如果未找到，它将回退为 /dev/mixer。

音频设备对象

在你写入或读取音频设备之前，你必须按照正确的顺序调用三个方法:

setfmt() 设置输出格式

channels() 设置声道数量

speed() 设置采样率

或者，你也可以使用 setparameters() 方法一次性地设置全部三个音频参数。 这更为便捷，但可能不会在所有场景下都一样灵活。

open() 所返回的音频设备对象定义了下列方法和（只读）属性:

oss_audio_device.close()

显式地关闭音频设备。 当你完成写入或读取音频设备后，你应当显式地关闭它。 已关闭的设备不可被再次使用。

oss_audio_device.fileno()

返回与设备相关联的文件描述符。

oss_audio_device.read(size)

从音频输入设备读取 size 个字节并返回为 Python 字节串。 与大多数 Unix 设备驱动不同，处于阻塞模式（默认）的 OSS 音频设备将阻塞 read() 直到所请求大小的数据全部可用。

oss_audio_device.write(data)

将一个 bytes-like object data 写入音频设备并返回写入的字节数。 如果音频设备处于阻塞模式（默认），则总是会写入完整数据（这还是不同于通常的 Unix 设备语义）。 如果设备处于非阻塞模式，则可能会有部分数据未被写入 --- 参见 writeall()。

在 3.5 版更改: 现在接受可写的 字节类对象。

oss_audio_device.writeall(data)

将一个 bytes-like object data 写入音频设备：等待直到音频设备能够接收数据，将根据其所能接收的数据量尽可能多地写入，并重复操作直至 data 被完全写入。 如果设备处于阻塞模式（默认），则其效果与 write() 相同；writeall() 仅适用于非阻塞模式。 它没有返回值，因为写入的数据量总是等于所提供的数据量。

在 3.5 版更改: 现在接受可写的 字节类对象。

在 3.2 版更改: 音频设备对象还支持上下文管理协议，就是说它们可以在 with 语句中使用。

下列方法各自映射一个 ioctl() 系统调用。 对应关系很明显：例如，setfmt() 对应 SNDCTL_DSP_SETFMT ioctl，而 sync() 对应 SNDCTL_DSP_SYNC (这在查阅 OSS 文档时很有用)。 如果下层的 ioctl() 失败，它们将引发 OSError。

oss_audio_device.nonblock()

将设备转为非阻塞模式。 一旦处于非阻塞模式，将无法将其转回阻塞模式。

oss_audio_device.getfmts()

返回声卡所支持的音频输出格式的位掩码。 OSS 支持的一部分格式如下:

格式 | 描述
AFMT_MU_LAW | 一种对数编码格式（被 Sun .au 文件和 /dev/audio 所使用）
AFMT_A_LAW | 一种对数编码格式
AFMT_IMA_ADPCM | 一种 4:1 压缩格式，由 Interactive Multimedia Association 定义
AFMT_U8 | 无符号的 8 位音频
AFMT_S16_LE | 有符号的 16 位音频，采用小端字节序（如 Intel 处理器所用的）
AFMT_S16_BE | 有符号的 16 位音频，采用大端字节序（如 68k, PowerPC, Sparc 所用的）
AFMT_S8 | 有符号的 8 位音频
AFMT_U16_LE | 无符号的 16 位小端字节序音频
AFMT_U16_BE | 无符号的 16 位大端字节序音频

请参阅 OSS 文档获取音频格式的完整列表，还要注意大多数设备都只支持这些列表的一个子集。 某些较旧的设备仅支持 AFMT_U8；目前最为常用的格式是 AFMT_S16_LE。

oss_audio_device.setfmt(format)

尝试将当前音频格式设为 format --- 请参阅 getfmts() 获取格式列表。 返回为设备设置的音频格式，这可能并非所请求的格式。 也可被用来返回当前音频格式 --- 这可以通过传入特殊的 "音频格式" AFMT_QUERY 来实现。

oss_audio_device.channels(nchannels)

将输出声道数设为 nchannels。 值为 1 表示单声道，2 表示立体声。 某些设备可能拥有 2 个以上的声道，并且某些高端设备还可能不支持单声道。 返回为设备设置的声道数。

oss_audio_device.speed(samplerate)

尝试将音频采样率设为每秒 samplerate 次采样。 返回实际设置的采样率。 大多数设备都不支持任意的采样率。 常见的采样率为:

采样率 | 描述
8000 | /dev/audio 的默认采样率
11025 | 语音录音
22050 |
44100 | CD品质的音频（16位采样和2通道）
96000 | DVD品质的音频（24位采样）

oss_audio_device.sync()

等待直到音频设备播放完其缓冲区中的所有字节。 （这会在设备被关闭时隐式地发生。） OSS 建议关闭再重新打开设备而不是使用 sync()。

oss_audio_device.reset()

立即停止播放或录制并使设备返回可接受命令的状态。 OSS 文档建议在调用 reset() 之后关闭并重新打开设备。

oss_audio_device.post()

告知设备在输出中可能有暂停，使得设备可以更智能地处理暂停。 你可以在播放一个定点音效之后、等待用户输入之前或执行磁盘 I/O 之前使用此方法。

下列便捷方法合并了多个 ioctl，或是合并了一个 ioctl 与某些简单的运算。

oss_audio_device.setparameters(format, nchannels, samplerate[, strict=False])

在一次方法调用中设置关键的音频采样参数 --- 采样格式、声道数和采样率。 format, nchannels 和 samplerate 应当与在 setfmt(), channels() 和 speed() 方法中所指定的一致。 如果 strict 为真值，则 setparameters() 会检查每个参数是否确实被设置为所请求的值，如果不是则会引发 OSSAudioError。 返回一个元组 (format, nchannels, samplerate) 指明由设备驱动实际设置的参数值 (即与 setfmt(), channels() 和 speed() 的返回值相同)。

例如，:

(fmt, channels, rate) = dsp.setparameters(fmt, channels, rate)

等价于

fmt = dsp.setfmt(fmt)
channels = dsp.channels(channels)
rate = dsp.rate(rate)

oss_audio_device.bufsize()

返回硬件缓冲区的大小，以采样数表示。

oss_audio_device.obufcount()

返回硬件缓冲区中待播放的采样数。

oss_audio_device.obuffree()

返回可以被加入硬件缓冲区队列以非阻塞模式播放的采样数。

音频设备对象还支持几个只读属性:

oss_audio_device.closed

指明设备是否已被关闭的布尔值。

oss_audio_device.name

包含设备文件名称的字符串。

oss_audio_device.mode

文件的 I/O 模式，可以为 "r", "rw" 或 "w"。

混音器设备对象

混音器对象提供了两个文件类方法:

oss_mixer_device.close()

此方法会关闭打开的混音器设备文件。 在文件被关闭后任何继续使用混音器的尝试都将引发 OSError。

oss_mixer_device.fileno()

返回打开的混音器设备文件的文件句柄号。

在 3.2 版更改: 混音器设备还支持上下文管理协议。

其余方法都是混音专属的:

oss_mixer_device.controls()

此方法返回一个表示可用的混音控件的位掩码 ("控件" 是专用的可混合 "声道"，例如 SOUND_MIXER_PCM 或 SOUND_MIXER_SYNTH)。 该掩码会指定所有可用混音控件的一个子集 --- 它们是在模块层级上定义的 SOUND_MIXER_* 常量。 举例来说，要确定当前混音器对象是否支持 PCM 混音器，就使用以下 Python 代码:

mixer=ossaudiodev.openmixer()
if mixer.controls() & (1 << ossaudiodev.SOUND_MIXER_PCM):
    # PCM is supported
    ... code ...

对于大多数目的来说，SOUND_MIXER_VOLUME (主音量) 和 SOUND_MIXER_PCM 控件应该足够了 --- 但使用混音器的代码应当在选择混音器控件时保持灵活。 例如在 Gravis Ultrasound 上，SOUND_MIXER_VOLUME 是不存在的。

oss_mixer_device.stereocontrols()

返回一个表示立体声混音控件的位掩码。 如果设置了比特位，则对应的控件就是立体声的；如果未设置，则控件为单声道或者不被混音器所支持（请配合 controls() 使用以确定是哪种情况）。

请查看 controls() 函数的代码示例了解如何从位掩码获取数据。

oss_mixer_device.reccontrols()

返回一个指明可被用于录音的混音器控件的位掩码。 请查看 controls() 的代码示例了解如何读取位掩码。

oss_mixer_device.get(control)

返回给定混音控件的音量。 返回的音量是一个 2 元组 (left_volume,right_volume)。 音量被表示为从 0 (静音) 到 100 (最大音量) 的数字。 如果控件是单声道的，仍然会返回一个 2 元组，但两个音量必定相同。

如果指定了无效的控件则会引发 OSSAudioError，或者如果指定了不受支持的控件则会引发 OSError。

oss_mixer_device.set(control, (left, right))

将给定混音控件的音量设为 (left,right)。 left 和 right 必须为整数并在 0 (静音) 至 100 (最大音量) 之间。 当执行成功的，新的音量将以 2 元组形式返回。 请注意这可能不完全等于所指定的音量，因为某些声卡的混音器有精度限制。

如果指定了无效的混音控件，或者指定的音量超出限制则会引发 OSSAudioError。

oss_mixer_device.get_recsrc()

此方法返回一个表示当前被用作录音源的的控件的位掩码。

oss_mixer_device.set_recsrc(bitmask)

调用此函数来指定一个录音源。 如果成功则返回一个指明新录音源的位掩码；如果指定了无效的源则会引发 OSError。 如果要将当前录音源设为麦克风输入:

mixer.setrecsrc (1 << ossaudiodev.SOUND_MIXER_MIC)

pipes --- 终端管道接口

源代码： Lib/pipes.py [https://github.com/python/cpython/tree/3.10/Lib/pipes.py]

3.11 版后已移除: pipes 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#pipes] 了解详情）。 请改用 subprocess 模块。

pipes 定义了一个类用来抽象 pipeline 的概念 --- 将数据从一个文件转到另一文件的转换器序列。

由于模块使用了 /bin/sh 命令行，因此要求有 POSIX 或兼容 os.system() 和 os.popen() 的终端程序。

可用性: Unix。 在 VxWorks 上不可用。

pipes 模块定义了以下的类:

class pipes.Template

对管道的抽象。

示例:

>>> import pipes
>>> t = pipes.Template()
>>> t.append('tr a-z A-Z', '--')
>>> f = t.open('pipefile', 'w')
>>> f.write('hello world')
>>> f.close()
>>> open('pipefile').read()
'HELLO WORLD'

模板对象

模板对象有以下方法:

Template.reset()

将一个管道模板恢复为初始状态。

Template.clone()

返回一个新的等价的管道模板。

Template.debug(flag)

如果 flag 为真值，则启用调试。 否则禁用调试。 当启用调试时，要执行的命令会被打印出来，并且会给予终端 set -x 命令以输出更详细的信息。

Template.append(cmd, kind)

在末尾添加一个新的动作。 cmd 变量必须为一个有效的 bourne 终端命令。 kind 变量由两个字母组成。

第一个字母可以为 '-' (这表示命令将读取其标准输入), 'f' (这表示命令将读取在命令行中给定的文件) 或 '.' (这表示命令将不读取输入，因而必须放在前面。)

类似地，第二个字母可以为 '-' (这表示命令将写入到标准输出), 'f' (这表示命令将写入在命令行中给定的文件) 或 '.' (这表示命令将不执行写入，因而必须放在末尾。)

Template.prepend(cmd, kind)

在开头添加一个新的动作。 请参阅 append() 获取相应参数的说明。

Template.open(file, mode)

返回一个文件型对象，打开到 file，但是将从管道读取或写入。 请注意只能给出 'r', 'w' 中的一个。

Template.copy(infile, outfile)

通过管道将 infile 拷贝到 outfile。

smtpd --- SMTP 服务器

源代码: Lib/smtpd.py [https://github.com/python/cpython/tree/3.10/Lib/smtpd.py]

该模块提供了几个类来实现 SMTP （电子邮件）服务器。

3.6 版后已移除: smtpd 将在 Python 3.12 中移除（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#smtpd] 了解详情）。 aiosmtpd [https://aiosmtpd.readthedocs.io/] 包是这个模块的推荐替代品。 它基于 asyncio 并提供了更简洁直观的 API。

有几个服务器的实现；一个是通用的无为实现，可以被重写，而另外两个则提供特定的邮件发送策略。

此外， SMTPChannel 可以被扩展以实现与 SMTP 客户端非常具体的交互行为。

该代码支持 RFC 5321 [https://datatracker.ietf.org/doc/html/rfc5321.html] ，加上 RFC 1870 [https://datatracker.ietf.org/doc/html/rfc1870.html] SIZE和 RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html] SMTPUTF8 扩展。

SMTPServer 对象

class smtpd.SMTPServer(localaddr, remoteaddr, data_size_limit=33554432, map=None, enable_SMTPUTF8=False, decode_data=False)

新建一个 SMTPServer 对象，它会绑定到本机地址 localaddr。 它将把 remoteaddr 当作上游 SMTP 中继器。 localaddr 和 remoteaddr 都应当是 (host, port) 元组。 该对象继承自 asyncore.dispatcher，因而会在实例化时将自己插入到 asyncore 的事件循环。

data_size_limit 指定将在 DATA 命令中被接受的最大字节数。 值为 None 或 0 表示无限制。

map 是用于连接的套接字映射（初始为空的字典是适当的值）。 如果未指定则会使用 asyncore 全局套接字映射。

enable_SMTPUTF8 决定是否应当启用 SMTPUTF8 扩展（如 RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html] 所定义的。 默认值为 False。 当设为 True 时，会接受 SMTPUTF8 作为 MAIL 命令的形参并在被提供时将其传给 kwargs['mail_options'] 列表中的 process_message()。 decode_data 和 enable_SMTPUTF8 不可同时被设为 True。

decode_data 指明 SMTP 事务的数据部分是否应当使用 UTF-8 来解码。 当 decode_data 为 False 时（默认值），服务器会声明 8BITMIME 扩展 (RFC 6152 [https://datatracker.ietf.org/doc/html/rfc6152.html])，接受来自 MAIL 命令的 BODY=8BITMIME 形参，并在该形参存在时将其传给 kwargs['mail_options'] 列表中的 process_message() 方法。 decode_data 和 enable_SMTPUTF8 不可同时被设为 True。

process_message(peer, mailfrom, rcpttos, data, **kwargs)

引发 NotImplementedError 异常。 请在子类中重载此方法以实际运用此消息。 在构造器中作为 remoteaddr 传入的任何东西都可以 _remoteaddr 属性的形式来访问。 peer 是远程主机的地址，mailfrom 是封包的发送方，rcpttos 是封包的接收方而 data 是包含电子邮件内容的字符串（应该为 RFC 5321 [https://datatracker.ietf.org/doc/html/rfc5321.html] 格式）。

如果构造器关键字参数 decode_data 被设为 True，则 data 参数将为 Unicode 字符串。 如果被设为 False，则将为字节串对象。

kwargs 是包含附加信息的字典。 如果给出 decode_data=True 作为初始参数则该字典为空，否则它会包含以下的键:

mail_options:

由 MAIL 命令所接收的所有参数组成的列表 (其元素为大写形式的字符串；例如: ['BODY=8BITMIME', 'SMTPUTF8'])。

rcpt_options:

与 mail_options 类似但是针对 RCPT 命令。 目前不支持任何 RCPT TO 选项，因此其值将总是为空列表。

process_message 的实现应当使用 **kwargs 签名来接收任意关键字参数，因为未来的增强特性可能会向 kwargs 字典添加新键。

返回 None 以请求一个正常的 250 Ok 响应；在其他情况下则以 RFC 5321 [https://datatracker.ietf.org/doc/html/rfc5321.html] 格式返回所需的响应字符串。

channel_class

重载这个子类以使用自定义的 SMTPChannel 来管理 SMTP 客户端。

3.4 新版功能: map 构造器参数。

在 3.5 版更改: localaddr 和 remoteaddr 现在可以包含 IPv6 地址。

3.5 新版功能: decode_data 和 enable_SMTPUTF8 构造器形参，以及当 decode_data 为 False 时传给 process_message() 的 kwargs 形参。

在 3.6 版更改: decode_data 现在默认为 False。

DebuggingServer 对象

class smtpd.DebuggingServer(localaddr, remoteaddr)

创建一个新的调试服务器。 参数是针对每个 SMTPServer。 消息将被丢弃，并在 stdout 上打印出来。

PureProxy 对象

class smtpd.PureProxy(localaddr, remoteaddr)

创建一个新的纯代理服务器。 参数是针对每个 SMTPServer。 一切都将被转发到 remoteaddr。 请注意运行此对象有很大的机会令你成为一个开放的中继站，所以需要小心。

MailmanProxy 对象

class smtpd.MailmanProxy(localaddr, remoteaddr)

Deprecated since version 3.9, will be removed in version 3.11: MailmanProxy 已被弃用，它依赖于一个已不存在的 Mailman 模块因而本来就不再可用了。

创建一个新的纯代理服务器。 参数是针对每个 SMTPServer。 一切都将被转发到 remoteaddr，除非本地 mailman 配置知道另一个地址，在那种情况下它将由 mailman 来处理。 请注意运行此对象有很大的机会令你成为一个开放的中继站，所以需要小心。

SMTPChannel 对象

class smtpd.SMTPChannel(server, conn, addr, data_size_limit=33554432, map=None, enable_SMTPUTF8=False, decode_data=False)

创建一个新的 SMTPChannel 对象，该对象会管理服务器和单个 SMTP 客户端之间的通信。

conn 和 addr 是针对下述的每个实例变量。

data_size_limit 指定将在 DATA 命令中被接受的最大字节数。 值为 None 或 0 表示无限制。

enable_SMTPUTF8 确定 SMTPUTF8 扩展 (如 RFC 6531 [https://datatracker.ietf.org/doc/html/rfc6531.html] 所定义的) 是否应当被启用。 默认值为 False。 decode_data 和 enable_SMTPUTF8 不能被同时设为 True。

可以在 map 中指定一个字典以避免使用全局套接字映射。

decode_data 指明 SMTP 事务的数据部分是否应当使用 UTF-8 来解码。 默认值为 False。 decode_data 和 enable_SMTPUTF8 不能被同时设为 True。

要使用自定义的 SMTPChannel 实现你必须重载你的 SMTPServer 的 SMTPServer.channel_class。

在 3.5 版更改: 添加了 decode_data 和 enable_SMTPUTF8 形参。

在 3.6 版更改: decode_data 现在默认为 False。

SMTPChannel 具有下列实例变量:

smtp_server

存放生成此通道的 SMTPServer。

conn

存放连接到客户端的套接字对象。

addr

存放客户端的地址，socket.accept 所返回的第二个值。

received_lines

存放从客户端接收的行字符串列表 (使用 UTF-8 解码)。 所有行的 "\r\n" 行结束符都会被转写为 "\n"。

smtp_state

存放通道的当前状态。 其初始值将为 COMMAND 而在客户端发送 "DATA" 行后将为 DATA。

seen_greeting

存放包含客户端在其 "HELO" 中发送的问候信息的字符串。

mailfrom

存放包含客户端在 "MAIL FROM:" 行中标识的地址的字符串。

rcpttos

存放包含客户端在 "RCPT TO:" 行中标识的地址的字符串。

received_data

存放客户端在 DATA 状态期间发送的所有数据的字符串，直至但不包括末尾的 "\r\n.\r\n"。

fqdn

Holds the fully qualified domain name of the server as returned by socket.getfqdn().

peer

存放由 conn.getpeername() 所返回的客户端对等方名称，其中 conn 为 conn。

SMTPChannel 在接收到来自客户端的命令行时会通过发起调用名为 smtp_<command> 的方法来进行操作。 在基类 SMTPChannel 中具有用于处理下列命令（并对他们作出适当反应）的方法:

命令 | 所采取的行动
HELO | 接受来自客户端的问候语，并将其存储在 seen_greeting 中。将服务器设置为基本命令模式。
EHLO | 接受来自客户的问候并将其存储在 seen_greeting 中。将服务器设置为扩展命令模式。
NOOP | 不采取任何行动。
QUIT | 干净地关闭连接。
MAIL | 接受 "MAIL FROM:" 句法并将所提供的地址保存为 mailfrom。 在扩展命令模式下，还接受 RFC 1870 [https://datatracker.ietf.org/doc/html/rfc1870.html] SIZE 属性并根据 data_size_limit 的值作出适当返应。
RCPT | 接受 "RCPT TO:" 句法并将所提供的地址保存在 rcpttos 列表中。
RSET | 重置 mailfrom, rcpttos, 和 received_data ，但不重置问候语。
DATA | 将内部状态设为 DATA 并将来自客户端的剩余行保存在 received_data 中直至接收到终止符 "\r\n.\r\n"。
HELP | 返回有关命令语法的最少信息
VRFY | 返回代码252（服务器不知道该地址是否有效）
EXPN | 报告该命令未实现。

sndhdr --- 推测声音文件的类型

源代码 Lib/sndhdr.py [https://github.com/python/cpython/tree/3.10/Lib/sndhdr.py]

3.11 版后已移除: sndhdr 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#sndhdr] 了解详情及其替代品）。

sndhdr 提供了企图猜测文件中的声音数据类型的功能函数。当这些函数可以推测出存储在文件中的声音数据的类型是，它们返回一个 collections.namedtuple()，包含了五种属性：（filetype, framerate, nchannels, nframes, sampwidth）。这些 type 的值表示数据的类型，会是以下字符串之一： 'aifc', 'aiff', 'au', 'hcom', 'sndr', 'sndt', 'voc', 'wav', '8svx', 'sb', 'ub', or 'ul' 。 sampling_rate 可能是实际值或者当未知或者难以解码时的 0。类似的， channels 也会返回实际值或者在无法推测或者难以解码时返回 0。 frames 则是实际值或 -1。 元组的最后一项， bits_per_sample 将会为比特表示的 sample 大小或者 A-LAW 时为 'A'， u-LAW 时为 'U'。

sndhdr.what(filename)

使用 whathdr() 推测存储在 filename 文件中的声音数据的类型。如果成功，返回上述的命名元组，否则返回 None。

在 3.5 版更改: 将结果从元组改为命名元组。

sndhdr.whathdr(filename)

基于文件头推测存储在文件中的声音数据类型。文件名由 filename 给出。这个函数在成功时返回上述命名元组，或者在失败时返回 None。

在 3.5 版更改: 将结果从元组改为命名元组。

spwd —— shadow 密码库

3.11 版后已移除: spwd 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#spwd] 了解详情及其替代品）。

该模块提供对 Unix shadow 密码库的访问能力。可用于各种 Unix 版本。

访问 shadow 密码数据库须拥有足够的权限（通常意味着必须采用 root 账户）。

shadow 密码库中的每条记录均表示为一个类似元组的对象，其属性对应着 spwd 结构的成员（下面列出了各属性字段，参见 ` <shadow.h>）。

索引 | 属性 | 含意
0 | sp_namp | 登录名
1 | sp_pwdp | 加密后的密码
2 | sp_lstchg | 最后修改日期
3 | sp_min | 两次修改间隔的最小天数
4 | sp_max | 两次修改间隔的最大天数
5 | sp_warn | 提前警告用户密码过期的天数
6 | sp_inact | 密码过期至账户禁用之间的天数
7 | sp_expire | 账户过期的天数，自 1970-01-01 算起
8 | sp_flag | 保留字段

sp_namp 和 sp_pwdp 条目是字符串，其他的均为整数。 如果未找到所需条目则会触发 KeyError。

定义了以下函数：

spwd.getspnam(name)

返回指定用户名的 shadow 密码库记录。

在 3.6 版更改: 如果当前用户权限不足，会触发 PermissionError，而非 KeyError。

spwd.getspall()

返回所有可用的 shadow 密码库记录列表，顺序随机。

参见

模块 grp

针对用户组数据库的接口，与本模块类似。

模块 pwd

访问普通密码库的接口，与本模块类似。

sunau --- 读写 Sun AU 文件

源代码: Lib/sunau.py [https://github.com/python/cpython/tree/3.10/Lib/sunau.py]

3.11 版后已移除: sunau 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#sunau] 了解详情）。

sunau 模拟提供了一个处理 Sun AU 声音格式的便利接口。请注意此模块与 aifc 和 wave 是兼容接口的。

音频文件由标头和数据组成。标头的字段为：

域 | 目录
magic word | 四个字节 .snd
header size | 标头的大小，包括信息，以字节为单位。
data size | 数据的物理大小，以字节为单位。
encoding | 指示音频样本的编码方式。
sample rate | 采样率
# of channels | 采样中的通道数。
info | 提供音频文件描述的ASCII字符串（用空字节填充）。

除了 info 字段，所有标头字段的大小都是 4 字节。 它们都是采用大端字节序编码的 32 位无符号整数。

sunau 模块定义了以下函数:

sunau.open(file, mode)

如果 file 是一个字符串，打开相应名称的文件，否则就把它作为可定位的文件型对象来处理。 mode 可以是

'r'

只读模式。

'w'

只写模式。

注意它不支持同时读/写文件。

mode 为 'r' 时返回一个 AU_read 对象，而 mode 为 'w' 或 'wb' 时返回一个 AU_write 对象。

sunau 模块定义了以下异常:

exception sunau.Error

当 Sun AU 规范或实现的低效导致无法操作时引发的错误。

sunau 模块定义了以下数据条目:

sunau.AUDIO_FILE_MAGIC

位于每个有效的 Sun AU 文件开头的整数，以大端序形式存储。 这是一个被当作整数来解读的字符串 .snd。

sunau.AUDIO_FILE_ENCODING_MULAW_8

sunau.AUDIO_FILE_ENCODING_LINEAR_8

sunau.AUDIO_FILE_ENCODING_LINEAR_16

sunau.AUDIO_FILE_ENCODING_LINEAR_24

sunau.AUDIO_FILE_ENCODING_LINEAR_32

sunau.AUDIO_FILE_ENCODING_ALAW_8

AU 标头中被此模块所支持的 encoding 字段值。

sunau.AUDIO_FILE_ENCODING_FLOAT

sunau.AUDIO_FILE_ENCODING_DOUBLE

sunau.AUDIO_FILE_ENCODING_ADPCM_G721

sunau.AUDIO_FILE_ENCODING_ADPCM_G722

sunau.AUDIO_FILE_ENCODING_ADPCM_G723_3

sunau.AUDIO_FILE_ENCODING_ADPCM_G723_5

AU 标头中附加的已知但不被此模块所支持的 encoding 字段值。

AU_read 对象

由上面的 open() 所返回的 AU_read 对象具有以下几种方法:

AU_read.close()

关闭流，并使实例不可用。 （此方法会在删除对象时自动调用。）

AU_read.getnchannels()

返回音频的通道数（单声道为 1，立体声为 2）。

AU_read.getsampwidth()

返回采样字节长度。

AU_read.getframerate()

返回采样频率。

AU_read.getnframes()

返回音频总帧数。

AU_read.getcomptype()

返回压缩类型。 受支持的压缩类型有 'ULAW', 'ALAW' 和 'NONE'。

AU_read.getcompname()

getcomptype() 的人类可读的版本。 受支持的类型将为相应的名称 'CCITT G.711 u-law', 'CCITT G.711 A-law' 和 'not compressed'。

AU_read.getparams()

返回一个 namedtuple() (nchannels, sampwidth, framerate, nframes, comptype, compname)，与 get*() 方法的输出相同。

AU_read.readframes(n)

读取至多 n 帧音频并作为 bytes 对象返回。 数据将以线性格式返回。 如果原始数据为 u-LAW 格式，则它将被转换。

AU_read.rewind()

重置文件指针至音频开头.

以下两个方法都使用指针，具体实现由其底层决定。

AU_read.setpos(pos)

设置文件指针到特定位置。 只有从 tell() 返回的值才可被用作 pos。

AU_read.tell()

返回当前文件指针的位置。 请注意该返回值与文件中的实例位置无关。

以下两个函数是为了与 aifc 保持兼容而定义的，实际不做任何事情。

AU_read.getmarkers()

返回 None。

AU_read.getmark(id)

引发错误异常。

AU_write 对象

由上面的 open() 所返回的 AU_write 对象具有以下几种方法:

AU_write.setnchannels(n)

设置声道数。

AU_write.setsampwidth(n)

设置采样宽度（字节长度。）

在 3.4 版更改: 增加了对 24 位采样的支持。

AU_write.setframerate(n)

设置帧速率。

AU_write.setnframes(n)

设置总帧数。 如果写入了更多的帧，此值将会被更改。

AU_write.setcomptype(type, name)

设置压缩类型和描述。 对于输出只支持 'NONE' 和 'ULAW'。

AU_write.setparams(tuple)

tuple 应该是 (nchannels, sampwidth, framerate, nframes, comptype, compname)，每项的值可用于 set*() 方法。 设置所有形参。

AU_write.tell()

返回文件中的当前位置，其含义与 AU_read.tell() 和 AU_read.setpos() 方法的一致。

AU_write.writeframesraw(data)

写入音频数据但不更新 nframes。

在 3.4 版更改: 现在可接受任意 bytes-like object。

AU_write.writeframes(data)

写入音频数据并更新 nframes。

在 3.4 版更改: 现在可接受任意 bytes-like object。

AU_write.close()

确保 nframes 正确，并关闭文件。

此方法会在删除时被调用。

请注意在调用 writeframes() 和 writeframesraw() 之后再设置任何形参都是无效的。

telnetlib -- Telnet 客户端

源代码： Lib/telnetlib.py [https://github.com/python/cpython/tree/3.10/Lib/telnetlib.py]

3.11 版后已移除: telnetlib 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#telnetlib] 了解详情及其替代品）。

telnetlib 模块提供一个实现Telnet协议的类 Telnet。关于此协议的细节请参见 RFC 854 [https://datatracker.ietf.org/doc/html/rfc854.html] 。此外，它还为协议字符（见下文）和 telnet 选项提供了对应的符号常量。telnet选项对应的符号名遵循 arpa/telnet.h 中的定义，但删除了前缀 TELOPT_。对于不在 arpa/telnet.h 的选项的符号常量名，请参考本模块源码。

telnet命令的符号常量名有： IAC, DONT, DO, WONT, WILL, SE (Subnegotiation End), NOP (No Operation), DM (Data Mark), BRK (Break), IP (Interrupt process), AO (Abort output), AYT (Are You There), EC (Erase Character), EL (Erase Line), GA (Go Ahead), SB (Subnegotiation Begin).

class telnetlib.Telnet(host=None, port=0[, timeout])

Telnet 表示到 Telnet 服务器的连接. 实例初始化后默认不连接；必须使用 open() 方法来建立连接。或者， 可选参数 host 和 port 也可以传递给构造函数，在这种情况下，到服务器的连接将在构造函数返回前建立。可选参数 timeout 为阻塞操作（如连接尝试）指定一个以秒为单位的超时时间（如果没有指定，将使用全局默认设置） 。

不要重新打开一个已经连接的实例。

这个类有很多 read_*() 方法。 请注意，其中一些方法在读取结束时会触发 EOFError 异常，这是由于连接对象可能出于其它原因返回一个空字符串。 请参阅下面的个别描述。

Telnet 对象一个上下文管理器，可以在 with 语句中使用。当 with 块结束，close() 方法会被调用:

>>> from telnetlib import Telnet
>>> with Telnet('localhost', 23) as tn:
...     tn.interact()
...

在 3.6 版更改: 添加了上下文管理器的支持

参见

RFC 854 [https://datatracker.ietf.org/doc/html/rfc854.html] - Telnet 协议规范

Telnet 协议的定义。

Telnet 对象

Telnet 实例有以下几种方法：

Telnet.read_until(expected, timeout=None)

读取直到遇到给定字节串 expected 或 timeout 秒已经过去。

当没有找到匹配时，返回可用的内容，也可能返回空字节。如果连接已关闭且没有可用的熟数据，将触发 EOFError。

Telnet.read_all()

读取数据，直到遇到 EOF；连接关闭前都会保持阻塞。

Telnet.read_some()

在达到 EOF 前，读取至少一个字节的熟数据。如果命中 EOF，返回 b''。如果没有立即可用的数据，则阻塞。

Telnet.read_very_eager()

在不阻塞 I/O 的情况下读取所有的内容（eager）。

如果连接已关闭并且没有可用的熟数据，将会触发 EOFError 。如果没有熟数据可用返回 b'' 。除非在一个 IAC 序列的中间，否则不要进行阻塞。

Telnet.read_eager()

读取现成的数据。

如果连接已关闭并且没有可用的熟数据，将会触发 EOFError 。如果没有熟数据可用返回 b'' 。除非在一个 IAC 序列的中间，否则不要进行阻塞。

Telnet.read_lazy()

处理并返回已经在队列中的数据（lazy）。

如果连接已关闭并且没有可用的数据，将会触发 EOFError 。如果没有熟数据可用则返回 b'' 。除非在一个 IAC 序列的中间，否则不要进行阻塞。

Telnet.read_very_lazy()

返回熟数据队列任何可用的数据（very lazy）。

如果连接已关闭并且没有可用的数据，将会触发 EOFError 。如果没有熟数据可用则返回 b'' 。该方法永远不会阻塞。

Telnet.read_sb_data()

返回在 SB/SE 对之间收集的数据（子选项 begin/end）。当使用 SE 命令调用回调函数时，该回调函数应该访问这些数据。该方法永远不会阻塞。

Telnet.open(host, port=0[, timeout])

连接主机。第二个可选参数是端口号，默认为标准 Telnet 端口（23）。可选参数 timeout 指定一个以秒为单位的超时时间用于像连接尝试这样的阻塞操作（如果没有指定，将使用全局默认超时设置）。

不要尝试重新打开一个已经连接的实例。

触发 auditing event telnetlib.Telnet.open ，参数为 self，host，port。

Telnet.msg(msg, *args)

当调试级别 > 0 时打印一条调试信息。如果存在额外参数，则它们会被替换在使用标准字符串格式化操作符的信息中。

Telnet.set_debuglevel(debuglevel)

设置调试级别。debuglevel 的值越高，得到的调试输出越多（在 sys.stdout ）。

Telnet.close()

关闭连接对象。

Telnet.get_socket()

返回内部使用的套接字对象。

Telnet.fileno()

返回内部使用的套接字对象的文件描述符。

Telnet.write(buffer)

向套接字写入一个字节字符串，将所有 IAC 字符加倍。如果连接被阻塞，这可能也会阻塞。如果连接关闭可能触发 OSError。

触发 auditing event telnetlib.Telnet.write ，参数为 self，buffer。

在 3.3 版更改: 曾经该函数抛出 socket.error，现在这是 OSError 的别名。

Telnet.interact()

交互函数，模拟一个非常笨拙的 Telnet 客户端。

Telnet.mt_interact()

多线程版的 interact().

Telnet.expect(list, timeout=None)

一直读取，直到匹配列表中的某个正则表达式。

第一个参数是一个正则表达式列表，可以是已编译的 (正则表达式对象)，也可以是未编译的 (字节串)。 第二个可选参数是超时，单位是秒；默认一直阻塞。

返回一个包含三个元素的元组：列表中的第一个匹配的正则表达式的索引；返回的匹配对象；包括匹配在内的读取过的字节。

如果找到了文件的结尾且没有字节被读取，触发 EOFError。否则，当没有匹配时,返回 (-1, None, data)，其中 data 是到目前为止接受到的字节（如果发生超时，则可能是空字节）。

如果一个正则表达式以贪婪匹配结束（例如 .*），或者多个表达式可以匹配同一个输出，则结果是不确定的，可能取决于 I/O 计时。

Telnet.set_option_negotiation_callback(callback)

每次在输入流上读取 telnet 选项时，这个带有如下参数的 callback （如果设置了）会被调用： callback(telnet socket, command (DO/DONT/WILL/WONT), option)。telnetlib 之后不会再执行其它操作。

Telnet 示例

一个简单的说明性典型用法例子:

import getpass
import telnetlib

HOST = "localhost"
user = input("Enter your remote account: ")
password = getpass.getpass()

tn = telnetlib.Telnet(HOST)

tn.read_until(b"login: ")
tn.write(user.encode('ascii') + b"\n")
if password:
    tn.read_until(b"Password: ")
    tn.write(password.encode('ascii') + b"\n")

tn.write(b"ls\n")
tn.write(b"exit\n")

print(tn.read_all().decode('ascii'))

uu --- 对 uuencode 文件进行编码与解码

源代码: Lib/uu.py [https://github.com/python/cpython/tree/3.10/Lib/uu.py]

3.11 版后已移除: uu 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#uu-and-the-uu-encoding] 了解详情）。 base64 是一个更现代化的替代品。

此模块使用 uuencode 格式来编码和解码文件，以便任意二进制数据可通过仅限 ASCII 码的连接进行传输。 在任何要求文件参数的地方，这些方法都接受文件型对象。 为了保持向下兼容，也接受包含路径名称的字符串，并且将打开相应的文件进行读写；路径名称 '-' 被解读为标准输入或输出。 但是，此接口已被弃用；在 Windows 中调用者最好是自行打开文件，并在需要时确保模式为 'rb' or 'wb'。

此代码由 Lance Ellinghouse 贡献，并由 Jack Jansen 修改。

uu 模块定义了以下函数：

uu.encode(in_file, out_file, name=None, mode=None, *, backtick=False)

使用 uuencode 将 in_file 文件编码为 out_file 文件。 经过 uuencoded 编码的文件将具有指定 name 和 mode 作为解码该文件默认结果的标头。 默认值会相应地从 in_file 或 '-' 以及 0o666 中提取。 如果 backtick 为真值，零会用 '`' 而不是空格来表示。

在 3.7 版更改: 增加 backtick 形参。

uu.decode(in_file, out_file=None, mode=None, quiet=False)

调用此函数会解码 uuencod 编码的 in_file 文件并将结果放入 out_file 文件。 如果 out_file 是一个路径名称，mode 会在必须创建文件时用于设置权限位。 out_file 和 mode 的默认值会从 uuencode 标头中提取。 但是，如果标头中指定的文件已存在，则会引发 uu.Error。

如果输入由不正确的 uuencode 编码器生成，decode() 可能会打印一条警告到标准错误 ，这样 Python 可以从该错误中恢复。 将 quiet 设为真值可以屏蔽此警告。

exception uu.Error

Exception 的子类，此异常可由 uu.decode() 在多种情况下引发，如上文所述，此外还包括格式错误的标头或被截断的输入文件等。

参见

模块 binascii

支持模块，包含ASCII到二进制和二进制到ASCII转换。

xdrlib --- 编码与解码 XDR 数据

源代码: Lib/xdrlib.py [https://github.com/python/cpython/tree/3.10/Lib/xdrlib.py]

3.11 版后已移除: xdrlib 模块已被弃用（请参阅 PEP 594 [https://www.python.org/dev/peps/pep-0594#xdrlib] 了解详情）。

xdrlib 模块为外部数据表示标准提供支持，该标准的描述见 RFC 1014 [https://datatracker.ietf.org/doc/html/rfc1014.html]，由 Sun Microsystems, Inc. 在 1987 年 6 月撰写。 它支持该 RFC 中描述的大部分数据类型。

xdrlib 模块定义了两个类，一个用于将变量打包为 XDR 表示形式，另一个用于从 XDR 表示形式解包。 此外还有两个异常类。

class xdrlib.Packer

Packer 是用于将数据打包为 XDR 表示形式的类。 Packer 类的实例化不附带参数。

class xdrlib.Unpacker(data)

Unpacker 是用于相应地从字符串缓冲区解包 XDR 数据值的类。 输入缓冲区将作为 data 给出。

参见

RFC 1014 [https://datatracker.ietf.org/doc/html/rfc1014.html] - XDR: 外部数据表示标准

这个 RFC 定义了最初编写此模块时 XDR 所用的数据编码格式。 显然它已被 RFC 1832 [https://datatracker.ietf.org/doc/html/rfc1832.html] 所淘汰。

RFC 1832 [https://datatracker.ietf.org/doc/html/rfc1832.html] - XDR: 外部数据表示标准

更新的 RFC，它提供了经修订的 XDR 定义。

Packer 对象

Packer 实例具有下列方法:

Packer.get_buffer()

将当前打包缓冲区以字符串的形式返回。

Packer.reset()

将打包缓冲区重置为空字符串。

总体来说，你可以通过调用适当的 pack_type() 方法来打包任何最常见的 XDR 数据类型。 每个方法都是接受单个参数，即要打包的值。 受支持的简单数据类型打包方法如下: pack_uint(), pack_int(), pack_enum(), pack_bool(), pack_uhyper() 以及 pack_hyper()。

Packer.pack_float(value)

打包单精度浮点数 value。

Packer.pack_double(value)

打包双精度浮点数 value。

以下方法支持打包字符串、字节串以及不透明数据。

Packer.pack_fstring(n, s)

打包固定长度字符串 s。 n 为字符串的长度，但它 不会 被打包进数据缓冲区。 如有必要字符串会以空字节串填充以保证 4 字节对齐。

Packer.pack_fopaque(n, data)

打包固定长度不透明数据流，类似于 pack_fstring()。

Packer.pack_string(s)

打包可变长度字符串 s。 先将字符串的长度打包为无符号整数，再用 pack_fstring() 来打包字符串数据。

Packer.pack_opaque(data)

打包可变长度不透明数据流，类似于 pack_string()。

Packer.pack_bytes(bytes)

打包可变长度字节流，类似于 pack_string()。

下列方法支持打包数组和列表:

Packer.pack_list(list, pack_item)

打包由同质条目构成的 list。 此方法适用于不确定长度的列表；即其长度无法在遍历整个列表之前获知。 对于列表中的每个条目，先打包一个无符号整数 1，再添加列表中数据的值。 pack_item 是在打包单个条目时要调用的函数。 在列表的末尾，会再打包一个无符号整数 0。

例如，要打包一个整数列表，代码看起来会是这样:

import xdrlib
p = xdrlib.Packer()
p.pack_list([1, 2, 3], p.pack_int)

Packer.pack_farray(n, array, pack_item)

打包由同质条目构成的固定长度列表 (array)。 n 为列表长度；它 不会 被打包到缓冲区，但是如果 len(array) 不等于 n 则会引发 ValueError。 如上所述，pack_item 是在打包每个元素时要使用的函数。

Packer.pack_array(list, pack_item)

打包由同质条目构成的可变长度 list。 先将列表的长度打包为无符号整数，再像上面的 pack_farray() 一样打包每个元素。

Unpacker 对象

Unpacker 类提供以下方法:

Unpacker.reset(data)

使用给定的 data 重置字符串缓冲区。

Unpacker.get_position()

返回数据缓冲区中的当前解包位置。

Unpacker.set_position(position)

将数据缓冲区的解包位置设为 position。 你应当小心使用 get_position() 和 set_position()。

Unpacker.get_buffer()

将当前解包数据缓冲区以字符串的形式返回。

Unpacker.done()

表明解包完成。 如果数据没有全部完成解包则会引发 Error 异常。

此外，每种可通过 Packer 打包的数据类型都可通过 Unpacker 来解包。 解包方法的形式为 unpack_type()，并且不接受任何参数。 该方法将返回解包后的对象。

Unpacker.unpack_float()

解包单精度浮点数。

Unpacker.unpack_double()

解包双精度浮点数，类似于 unpack_float()。

此外，以下方法可用来解包字符串、字节串以及不透明数据:

Unpacker.unpack_fstring(n)

解包并返回固定长度字符串。 n 为期望的字符数量。 会预设以空字节串填充以保证 4 字节对齐。

Unpacker.unpack_fopaque(n)

解包并返回固定长度数据流，类似于 unpack_fstring()。

Unpacker.unpack_string()

解包并返回可变长度字符串。 先将字符串的长度解包为无符号整数，再用 unpack_fstring() 来解包字符串数据。

Unpacker.unpack_opaque()

解包并返回可变长度不透明数据流，类似于 unpack_string()。

Unpacker.unpack_bytes()

解包并返回可变长度字节流，类似于 unpack_string()。

下列方法支持解包数组和列表:

Unpacker.unpack_list(unpack_item)

解包并返回同质条目的列表。 该列表每次解包一个元素，先解包一个无符号整数旗标。 如果旗标为 1，则解包条目并将其添加到列表。 旗标为 0 表明列表结束。 unpack_item 为在解包条目时调用的函数。

Unpacker.unpack_farray(n, unpack_item)

解包并（以列表形式）返回由同质条目构成的固定长度数组。 n 为期望的缓冲区内列表元素数量。 如上所述，unpack_item 是解包每个元素时要使用的函数。

Unpacker.unpack_array(unpack_item)

解包并返回由同质条目构成的可变长度 list。 先将列表的长度解包为无符号整数，再像上面的 unpack_farray() 一样解包每个元素。

异常

此模块中的异常会表示为类实例代码:

exception xdrlib.Error

基本异常类。 Error 具有一个公共属性 msg，其中包含对错误的描述。

exception xdrlib.ConversionError

从 Error 所派生的类。 不包含额外的实例变量。

以下是一个应该如何捕获这些异常的示例:

import xdrlib
p = xdrlib.Packer()
try:
    p.pack_double(8.01)
except xdrlib.ConversionError as instance:
    print('packing the double failed:', instance.msg)

安全考量

下列模块具有专门的安全事项:

base64: base64 安全事项，参见 RFC 4648 [https://datatracker.ietf.org/doc/html/rfc4648.html]

cgi: CGI 安全事项

hashlib: 所有构造器都接受一个 "usedforsecurity" 仅限关键字参数以停用已知的不安全和已封禁的算法

http.server 不适合生产用途，只实现了基本的安全检查。 请参阅 安全性考量。

logging: 日志记录配置使用了 eval()

multiprocessing: Connection.recv() 使用了 pickle

pickle: 在 pickle 中限制全局变量

random 不应当被用于安全目的，而应改用 secrets

shelve: shelve 是基于 pickle 的因此不适用于处理不受信任的源

ssl: SSL/TLS 安全事项

subprocess: 子进程安全事项

tempfile: mktemp 由于存在竞争条件缺陷已被弃用

xml: XML 安全缺陷

zipfile: 恶意处理的 .zip 文件可能导致硬盘空间耗尽

扩展和嵌入 Python 解释器

本文档描述了如何使用 C 或 C++ 编写模块以使用新模块来扩展 Python 解释器的功能。 这些模块不仅可以定义新的函数，还可以定义新的对象类型及其方法。 该文档还描述了如何将 Python 解释器嵌入到另一个应用程序中，以用作扩展语言。 最后，它展示了如何编译和链接扩展模块，以便它们可以动态地（在运行时）加载到解释器中，如果底层操作系统支持此特性的话。

本文档假设你具备有关 Python 的基本知识。有关该语言的非正式介绍，请参阅 Python 教程 。 Python 语言参考手册 给出了更正式的语言定义。 Python 标准库 包含现有的对象类型、函数和模块（内置和用 Python 编写）的文档，使语言具有广泛的应用范围。

关于整个 Python/C API 的详细介绍，请参阅独立的 Python/C API 参考手册 。

推荐的第三方工具

本指南仅介绍了作为此 CPython 版本的一部分提供的创建扩展的基本工具。 第三方工具如 Cython [https://cython.org/], cffi [https://cffi.readthedocs.io], SWIG [https://www.swig.org] 和 Numba [https://numba.pydata.org/] 提供了更简单或更复杂的方式来为 Python 创建 C 和 C++ 扩展。

参见

Python Packaging User Guide: Binary Extensions [https://packaging.python.org/guides/packaging-binary-extensions/]

“ Python Packaging User Guide ”不仅涵盖了几个简化二进制扩展创建的可用工具，还讨论了为什么首先创建扩展模块的各种原因。

不使用第三方工具创建扩展

本指南的这一部分包括在没有第三方工具帮助的情况下创建 C 和 C ++ 扩展。它主要用于这些工具的创建者，而不是建议你创建自己的 C 扩展的方法。

1. 使用 C 或 C++ 扩展 Python

1.1. 一个简单的例子

1.2. 关于错误和异常

1.3. 回到例子

1.4. 模块方法表和初始化函数

1.5. 编译和链接

1.6. 在C中调用Python函数

1.7. 提取扩展函数的参数

1.8. 给扩展函数的关键字参数

1.9. 构造任意值

1.10. 引用计数

1.11. 在C++中编写扩展

1.12. 给扩展模块提供C API

2. 自定义扩展类型：教程

2.1. 基础

2.2. 向基本示例添加数据和方法

2.3. 提供对于数据属性的更精细控制

2.4. 支持循环垃圾回收

2.5. 子类化其他类型

3. 定义扩展类型：已分类主题

3.1. 终结和内存释放

3.2. 对象展示

3.3. 属性管理

3.4. 对象比较

3.5. 抽象协议支持

3.6. 弱引用支持

3.7. 更多建议

4. 构建C/C++扩展

4.1. 使用distutils构建C和C++扩展

4.2. 发布你的扩展模块

5. 在 Windows 上构建 C 和 C++ 扩展

5.1. 菜谱式说明

5.2. Unix 和 Windows 之间的差异

5.3. DLL 的实际使用

在更大的应用程序中嵌入 CPython 运行时

有时，不是要创建在 Python 解释器中作为主应用程序运行的扩展，而是希望将 CPython 运行时嵌入到更大的应用程序中。 本节介绍了成功完成此操作所涉及的一些细节。

1. 在其它应用程序嵌入 Python

1.1. 高层次的嵌入

1.2. 突破高层次嵌入的限制：概述

1.3. 只做嵌入

1.4. 对嵌入 Python 功能进行扩展

1.5. 在 C++ 中嵌入 Python

1.6. 在类 Unix 系统中编译和链接

1. 使用 C 或 C++ 扩展 Python

如果你会用 C，添加新的 Python 内置模块会很简单。以下两件不能用 Python 直接做的事，可以通过 extension modules 来实现：实现新的内置对象类型；调用 C 的库函数和系统调用。

为了支持扩展，Python API（应用程序编程接口）定义了一系列函数、宏和变量，可以访问 Python 运行时系统的大部分内容。Python 的 API 可以通过在一个 C 源文件中引用 "Python.h" 头文件来使用。

扩展模块的编写方式取决与你的目的以及系统设置；下面章节会详细介绍。

注解

C扩展接口特指CPython，扩展模块无法在其他Python实现上工作。在大多数情况下，应该避免写C扩展，来保持可移植性。举个例子，如果你的用例调用了C库或系统调用，你应该考虑使用 ctypes 模块或 cffi [https://cffi.readthedocs.io/] 库，而不是自己写C代码。这些模块允许你写Python代码来接口C代码，并且相较于编写和编译C扩展模块，该方法在不同Python实现之间具有更高的可移植性。

1.1. 一个简单的例子

让我们创建一个扩展模块 spam (Monty Python 粉丝最喜欢的食物...) 并且想要创建对应 C 库函数 system() 1 的 Python 接口。 这个函数接受一个以 null 结尾的字符串参数并返回一个整数。 我们希望可以在 Python 中以如下方式调用此函数:

>>> import spam
>>> status = spam.system("ls -l")

首先创建一个 spammodule.c 文件。（传统上，如果一个模块叫 spam，则对应实现它的 C 文件叫 spammodule.c；如果这个模块名字非常长，比如 spammify，则这个模块的文件可以直接叫 spammify.c。）

文件中开始的两行是：

#define PY_SSIZE_T_CLEAN
#include <Python.h>

这会导入 Python API（如果你喜欢，你可以在这里添加描述模块目标和版权信息的注释)。

注解

由于 Python 可能会定义一些能在某些系统上影响标准头文件的预处理器定义，因此在包含任何标准头文件之前，你 必须 先包含 Python.h。

推荐总是在 Python.h 前定义 PY_SSIZE_T_CLEAN 。查看 提取扩展函数的参数 来了解这个宏的更多内容。

所有在 Python.h 中定义的用户可见的符号都具有 Py 或 PY 前缀，已在标准头文件中定义的那些除外。 考虑到便利性，也由于其在 Python 解释器中被广泛使用，"Python.h" 还包含了一些标准头文件: <stdio.h>，<string.h>，<errno.h> 和 <stdlib.h>。 如果后面的头文件在你的系统上不存在，它还会直接声明函数 malloc()，free() 和 realloc()。

下面添加C函数到扩展模块，当调用 spam.system(string) 时会做出响应，(我们稍后会看到调用)：

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);
}

有个直接翻译参数列表的方法(举个例子，单独的 "ls -l" )到要传递给C函数的参数。C函数总是有两个参数，通常名字是 self 和 args 。

对模块级函数， self 参数指向模块对象；对于方法则指向对象实例。

args 参数是指向一个 Python 的 tuple 对象的指针，其中包含参数。 每个 tuple 项对应一个调用参数。 这些参数也全都是 Python 对象 --- 要在我们的 C 函数中使用它们就需要先将其转换为 C 值。 Python API 中的函数 PyArg_ParseTuple() 会检查参数类型并将其转换为 C 值。 它使用模板字符串确定需要的参数类型以及存储被转换的值的 C 变量类型。 细节将稍后说明。

PyArg_ParseTuple() 在所有参数都有正确类型且组成部分按顺序放在传递进来的地址里时，返回真(非零)。其在传入无效参数时返回假(零)。在后续例子里，还会抛出特定异常，使得调用的函数可以理解返回 NULL (也就是例子里所见)。

1.2. 关于错误和异常

整个 Python 解释器系统有一个如下所述的重要惯例：当一个函数运行失败时，它应当设置一个异常条件并返回一个错误值（通常为 -1 或 NULL 指针）。 异常信息保存在解释器线程状态的三个成员中。 如果没有异常则它们的值为 NULL。 在其他情况下它们是 sys.exc_info() 所返回的 Python 元组的成员的 C 对应物。 它们分别是异常类型、异常实例和回溯对象。 理解它们对于理解错误是如何被传递的非常重要。

Python API中定义了一些函数来设置这些变量。

最常用的就是 PyErr_SetString()。 其参数是异常对象和 C 字符串。 异常对象一般是像 PyExc_ZeroDivisionError 这样的预定义对象。 C 字符串指明异常原因，并被转换为一个 Python 字符串对象存储为异常的“关联值”。

另一个有用的函数是 PyErr_SetFromErrno() ，仅接受一个异常对象，异常描述包含在全局变量 errno 中。最通用的函数还是 PyErr_SetObject() ，包含两个参数，分别为异常对象和异常描述。你不需要使用 Py_INCREF() 来增加传递到其他函数的参数对象的引用计数。

你可以通过 PyErr_Occurred() 在不造成破坏的情况下检测是否设置了异常。 这将返回当前异常对象，或者如果未发生异常则返回 NULL。 你通常不需要调用 PyErr_Occurred() 来查看函数调用中是否发生了错误，因为你应该能从返回值中看出来。

当一个函数 f 调用另一个函数 g 时检测到后者出错了，f 应当自己返回一个错误值 (通常为 NULL 或 -1)。 它 不应 调用某个 PyErr_* 函数 --- 这类函数已经被 g 调用过了。 f 的调用者随后也应当返回一个错误来提示 它的 调用者，同样 不应 调用 PyErr_*，依此类推 --- 错误的最详细原因已经由首先检测到它的函数报告了。 一旦这个错误到达 Python 解释器的主循环，它会中止当前执行的 Python 代码并尝试找出由 Python 程序员所指定的异常处理器。

（在某些情况下模块确实能够通过调用其它 PyErr_* 函数来给出更为详细的错误消息，并且在这些情况下是可以这样做的。 但是按照一般规则，这是不必要的，并可能导致有关错误的信息丢失：大多数操作会由于种种原因而失败。）

想要忽略由一个失败的函数调用所设置的异常，异常条件必须通过调用 PyErr_Clear() 显式地被清除。 C 代码应当调用 PyErr_Clear() 的唯一情况是如果它不想将错误传给解释器而是想完全由自己来处理它（可能是尝试其他方法，或是假装没有出错）。

每次失败的 malloc() 调用必须转换为一个异常。 malloc() (或 realloc() )的直接调用者必须调用 PyErr_NoMemory() 来返回错误来提示。所有对象创建函数(例如 PyLong_FromLong() )已经这么做了，所以这个提示仅用于直接调用 malloc() 的情况。

还要注意的是，除了 PyArg_ParseTuple() 等重要的例外，返回整数状态码的函数通常都是返回正值或零来表示成功，而以 -1 表示失败，如同 Unix 系统调用一样。

最后，当你返回一个错误指示器时要注意清理垃圾（通过为你已经创建的对象执行 Py_XDECREF() 或 Py_DECREF() 调用）！

选择引发哪个异常完全取决于你的喜好。 所有内置的 Python 异常都有对应的预声明 C 对象，例如 PyExc_ZeroDivisionError，你可以直接使用它们。 当然，你应当明智地选择异常 --- 不要使用 PyExc_TypeError 来表示一个文件无法被打开 (那大概应该用 PyExc_IOError)。 如果参数列表有问题，PyArg_ParseTuple() 函数通常会引发 PyExc_TypeError。 如果你想要一个参数的值必须处于特定范围之内或必须满足其他条件，则适宜使用 PyExc_ValueError。

你也可以为你的模块定义一个唯一的新异常。需要在文件前部声明一个静态对象变量，如:

static PyObject *SpamError;

并且在你的模块的初始化函数 (PyInit_spam()) 中使用一个异常对象来初始化:

PyMODINIT_FUNC
PyInit_spam(void)
{
    PyObject *m;

    m = PyModule_Create(&spammodule);
    if (m == NULL)
        return NULL;

    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    Py_XINCREF(SpamError);
    if (PyModule_AddObject(m, "error", SpamError) < 0) {
        Py_XDECREF(SpamError);
        Py_CLEAR(SpamError);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

注意异常对象的Python名字是 spam.error 。而 PyErr_NewException() 函数可以创建一个类，其基类为 Exception (除非是另一个类传入以替换 NULL )， 细节参见 内置异常 。

同样注意的是创建类保存了 SpamError 的一个引用，这是有意的。为了防止被垃圾回收掉，否则 SpamError 随时会成为野指针。

一会讨论 PyMODINIT_FUNC 作为函数返回类型的用法。

spam.error 异常可以在扩展模块中抛出，通过 PyErr_SetString() 函数调用，如下：

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);
}

1.3. 回到例子

回到前面的例子，你应该明白下面的代码:

if (!PyArg_ParseTuple(args, "s", &command))
    return NULL;

如果在参数列表中检测到错误，它将返回 NULL (该值是返回对象指针的函数所使用的错误提示)，这取决于 PyArg_ParseTuple() 设置的异常。 在其他情况下参数的字符串值会被拷贝到局部变量 command。 这是一个指针赋值并且你不应该修改它所指向的字符串 (因此在标准 C 中，变量 command 应当被正确地声明为 const char *command)。

下一个语句使用UNIX系统函数 system() ，传递给他的参数是刚才从 PyArg_ParseTuple() 取出的:

sts = system(command);

我们的 spam.system() 函数必须返回 sts 的值作为Python对象。这通过使用函数 PyLong_FromLong() 来实现。

return PyLong_FromLong(sts);

在这种情况下，会返回一个整数对象，(这个对象会在Python堆里面管理)。

如果你有一个不返回有用参数的 C 函数（即返回 void 的函数），则对应的 Python 函数必须返回 None。 你必须使用这种写法（它是通过 Py_RETURN_NONE 宏来实现的）

Py_INCREF(Py_None);
return Py_None;

Py_None 是特殊 Python 对象 None 所对应的 C 名称。 它是一个真正的 Python 对象而不是 NULL 指针，如我们所见，后者在大多数上下文中都意味着“错误”。

1.4. 模块方法表和初始化函数

为了展示 spam_system() 如何被Python程序调用。把函数声明为可以被Python调用，需要先定义一个方法表 "method table" 。

static PyMethodDef SpamMethods[] = {
    ...
    {"system",  spam_system, METH_VARARGS,
     "Execute a shell command."},
    ...
    {NULL, NULL, 0, NULL}        /* Sentinel */
};

注意第三个参数 ( METH_VARARGS ) ，这个标志指定会使用C的调用惯例。可选值有 METH_VARARGS 、 METH_VARARGS | METH_KEYWORDS 。值 0 代表使用 PyArg_ParseTuple() 的陈旧变量。

如果单独使用 METH_VARARGS ，函数会等待Python传来tuple格式的参数，并最终使用 PyArg_ParseTuple() 进行解析。

METH_KEYWORDS 值表示接受关键字参数。这种情况下C函数需要接受第三个 PyObject * 对象，表示字典参数，使用 PyArg_ParseTupleAndKeywords() 来解析出参数。

这个方法表必须被模块定义结构所引用。

static struct PyModuleDef spammodule = {
    PyModuleDef_HEAD_INIT,
    "spam",   /* name of module */
    spam_doc, /* module documentation, may be NULL */
    -1,       /* size of per-interpreter state of the module,
                 or -1 if the module keeps state in global variables. */
    SpamMethods
};

这个结构体必须传递给解释器的模块初始化函数。初始化函数必须命名为 PyInit_name() ，其中 name 是模块的名字，并应该定义为非 static ，且在模块文件里：

PyMODINIT_FUNC
PyInit_spam(void)
{
    return PyModule_Create(&spammodule);
}

注意 PyMODINIT_FUNC 将函数声明为 PyObject * 返回类型，声明了任何平台所要求的特殊链接声明，并针对 C++ 将函数声明为 extern "C"。

当 Python 程序首次导入 spam 模块时， PyInit_spam() 会被调用。 （有关嵌入 Python 的注释参见下文。） 它将调用 PyModule_Create()，该函数会返回一个模块对象，并基于在模块定义中找到的表将内置函数对象插入到新创建的模块中（该表是一个 PyMethodDef 结构体的数组）。 PyModule_Create() 返回一个指向它所创建的模块对象的指针。 它可能会因程度严重的特定错误而中止，或者在模块无法成功初始化时返回 NULL。 初始化函数必须返回模块对象给其调用者，这样它就可以被插入到 sys.modules 中。

当嵌入Python时， PyInit_spam() 函数不会被自动调用，除非放在 PyImport_Inittab 表里。要添加模块到初始化表，使用 PyImport_AppendInittab() ，可选的跟着一个模块的导入。

int
main(int argc, char *argv[])
{
    wchar_t *program = Py_DecodeLocale(argv[0], NULL);
    if (program == NULL) {
        fprintf(stderr, "Fatal error: cannot decode argv[0]\n");
        exit(1);
    }

    /* Add a built-in module, before Py_Initialize */
    if (PyImport_AppendInittab("spam", PyInit_spam) == -1) {
        fprintf(stderr, "Error: could not extend in-built modules table\n");
        exit(1);
    }

    /* Pass argv[0] to the Python interpreter */
    Py_SetProgramName(program);

    /* Initialize the Python interpreter.  Required.
       If this step fails, it will be a fatal error. */
    Py_Initialize();

    /* Optionally import the module; alternatively,
       import can be deferred until the embedded script
       imports it. */
    PyObject *pmodule = PyImport_ImportModule("spam");
    if (!pmodule) {
        PyErr_Print();
        fprintf(stderr, "Error: could not import module 'spam'\n");
    }

    ...

    PyMem_RawFree(program);
    return 0;
}

注解

要从 sys.modules 删除实体或导入已编译模块到一个进程里的多个解释器(或使用 fork() 而没用 exec() )会在一些扩展模块上产生错误。扩展模块作者可以在初始化内部数据结构时给出警告。

更多关于模块的现实的例子包含在 Python 源码发布包的 Modules/xxmodule.c 中。 此文件可以被用作代码模板或是学习样例。

注解

不像我们的 spam 例子， xxmodule 使用了 多阶段初始化 (Python3.5开始引入)， PyInit_spam 会返回一个 PyModuleDef 结构体，然后创建的模块放到导入机制。细节参考 PEP 489 [https://www.python.org/dev/peps/pep-0489] 的多阶段初始化。

1.5. 编译和链接

在你能使用你的新写的扩展之前，你还需要做两件事情：使用 Python 系统来编译和链接。如果你使用动态加载，这取决于你使用的操作系统的动态加载机制；更多信息请参考编译扩展模块的章节（ 构建C/C++扩展 章节），以及在 Windows 上编译需要的额外信息（ 在 Windows 上构建 C 和 C++ 扩展 章节）。

如果你不使用动态加载，或者想要让模块永久性的作为Python解释器的一部分，就必须修改配置设置，并重新构建解释器。幸运的是在Unix上很简单，只需要把你的文件 ( spammodule.c 为例) 放在解压缩源码发行包的 Modules/ 目录下，添加一行到 Modules/Setup.local 来描述你的文件：

spam spammodule.o

然后在顶层目录运行 make 来重新构建解释器。你也可以在 Modules/ 子目录使用 make，但是你必须先重建 Makefile 文件，然后运行 'make Makefile' 命令。（你每次修改 Setup 文件都需要这样操作。）

如果你的模块需要额外的链接，这些内容可以列出在配置文件里，举个实例：

spam spammodule.o -lX11

1.6. 在C中调用Python函数

迄今为止，我们一直把注意力集中于让Python调用C函数，其实反过来也很有用，就是用C调用Python函数。这在回调函数中尤其有用。如果一个C接口使用回调，那么就要实现这个回调机制。

幸运的是，Python解释器是比较方便回调的，并给标准Python函数提供了标准接口。(这里就不再详述解析Python字符串作为输入的方式，如果有兴趣可以参考 Python/pythonmain.c 中的 -c 命令行代码。)

调用Python函数很简单，首先Python程序要传递Python函数对象。应该提供个函数(或其他接口)来实现。当调用这个函数时，用全局变量保存Python函数对象的指针，还要调用 (Py_INCREF()) 来增加引用计数，当然不用全局变量也没什么关系。举个例子，如下函数可能是模块定义的一部分：

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);         /* Add a reference to new callback */
        Py_XDECREF(my_callback);  /* Dispose of previous callback */
        my_callback = temp;       /* Remember new callback */
        /* Boilerplate to return "None" */
        Py_INCREF(Py_None);
        result = Py_None;
    }
    return result;
}

这个函数必须使用 METH_VARARGS 标志注册到解释器，这在 模块方法表和初始化函数 章节会描述。 PyArg_ParseTuple() 函数及其参数的文档在 提取扩展函数的参数 。

Py_XINCREF() 和 Py_XDECREF() 这两个宏可增加/减少一个对象的引用计数，并且当存在 NULL 指针时仍可保证安全 (但请注意在这个上下文中 temp 将不为 NULL)。 更多相关信息请参考 引用计数 章节。

随后，当要调用此函数时，你将调用 C 函数 PyObject_CallObject()。 该函数有两个参数，它们都属于指针，指向任意 Python 对象：即 Python 函数，及其参数列表。 参数列表必须总是一个元组对象，其长度即参数的个数量。 要不带参数地调用 Python 函数，则传入 NULL 或一个空元组；要带一个参数调用它，则传入一个单元组。 Py_BuildValue() 会在其格式字符串包含一对圆括号内的零个或多个格式代码时返回一个元组。 例如:

int arg;
PyObject *arglist;
PyObject *result;
...
arg = 123;
...
/* Time to call the callback */
arglist = Py_BuildValue("(i)", arg);
result = PyObject_CallObject(my_callback, arglist);
Py_DECREF(arglist);

PyObject_CallObject() 返回Python对象指针，这也是Python函数的返回值。 PyObject_CallObject() 是一个对其参数 "引用计数无关" 的函数。例子中新的元组创建用于参数列表，并且在 PyObject_CallObject() 之后立即使用了 Py_DECREF() 。

PyObject_CallObject() 的返回值总是“新”的：要么是一个新建的对象；要么是已有对象，但增加了引用计数。所以除非你想把结果保存在全局变量中，你需要对这个值使用 Py_DECREF()，即使你对里面的内容（特别！）不感兴趣。

但是在你这么做之前，很重要的一点是检查返回值不是 NULL。 如果是的话，Python 函数会终止并引发异常。 如果调用 PyObject_CallObject() 的 C 代码是在 Python 中唤起的，它应当立即返回一个错误来告知其 Python 调用者，以便解释器能打印栈回溯信息，或者让调用方 Python 代码能处理该异常。 如果这无法做到或不合本意，则应当通过调用 PyErr_Clear() 来清除异常。 例如:

if (result == NULL)
    return NULL; /* Pass error back */
...use result...
Py_DECREF(result);

依赖于具体的回调函数，你还要提供一个参数列表到 PyObject_CallObject() 。在某些情况下参数列表是由Python程序提供的，通过接口再传到回调函数对象。这样就可以不改变形式直接传递。另外一些时候你要构造一个新的元组来传递参数。最简单的方法就是 Py_BuildValue() 函数构造tuple。举个例子，你要传递一个事件代码时可以用如下代码:

PyObject *arglist;
...
arglist = Py_BuildValue("(l)", eventcode);
result = PyObject_CallObject(my_callback, arglist);
Py_DECREF(arglist);
if (result == NULL)
    return NULL; /* Pass error back */
/* Here maybe use the result */
Py_DECREF(result);

注意 Py_DECREF(arglist) 所在处会立即调用，在错误检查之前。当然还要注意一些常规的错误，比如 Py_BuildValue() 可能会遭遇内存不足等等。

当你调用函数时还需要注意，用关键字参数调用 PyObject_Call() ，需要支持普通参数和关键字参数。有如如上例子中，我们使用 Py_BuildValue() 来构造字典。

PyObject *dict;
...
dict = Py_BuildValue("{s:i}", "name", val);
result = PyObject_Call(my_callback, NULL, dict);
Py_DECREF(dict);
if (result == NULL)
    return NULL; /* Pass error back */
/* Here maybe use the result */
Py_DECREF(result);

1.7. 提取扩展函数的参数

函数 PyArg_ParseTuple() 的声明如下：

int PyArg_ParseTuple(PyObject *arg, const char *format, ...);

参数 arg 必须是一个元组对象，包含从 Python 传递给 C 函数的参数列表。format 参数必须是一个格式字符串，语法请参考 Python C/API 手册中的 解析参数并构建值变量。剩余参数是各个变量的地址，类型要与格式字符串对应。

注意 PyArg_ParseTuple() 会检测他需要的Python参数类型，却无法检测传递给他的C变量地址，如果这里出错了，可能会在内存中随机写入东西，小心。

注意任何由调用者提供的 Python 对象引用是 借来的 引用；不要递减它们的引用计数！

一些调用的例子：

#define PY_SSIZE_T_CLEAN  /* Make "s#" use Py_ssize_t rather than int. */
#include <Python.h>

int ok;
int i, j;
long k, l;
const char *s;
Py_ssize_t size;

ok = PyArg_ParseTuple(args, ""); /* No arguments */
    /* Python call: f() */

ok = PyArg_ParseTuple(args, "s", &s); /* A string */
    /* Possible Python call: f('whoops!') */

ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* Two longs and a string */
    /* Possible Python call: f(1, 2, 'three') */

ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);
    /* A pair of ints and a string, whose size is also returned */
    /* Possible Python call: f((1, 2), 'three') */

{
    const char *file;
    const char *mode = "r";
    int bufsize = 0;
    ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);
    /* A string, and optionally another string and an integer */
    /* Possible Python calls:
       f('spam')
       f('spam', 'w')
       f('spam', 'wb', 100000) */
}

{
    int left, top, right, bottom, h, v;
    ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)",
             &left, &top, &right, &bottom, &h, &v);
    /* A rectangle and a point */
    /* Possible Python call:
       f(((0, 0), (400, 300)), (10, 10)) */
}

{
    Py_complex c;
    ok = PyArg_ParseTuple(args, "D:myfunction", &c);
    /* a complex, also providing a function name for errors */
    /* Possible Python call: myfunction(1+2j) */
}

1.8. 给扩展函数的关键字参数

函数 PyArg_ParseTupleAndKeywords() 声明如下：

int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
                                const char *format, char *kwlist[], ...);

arg 与 format 形参与 PyArg_ParseTuple() 函数所定义的一致。 kwdict 形参是作为第三个参数从 Python 运行时接收的关键字字典。 kwlist 形参是以 NULL 结尾的字符串列表，它被用来标识形参；名称从左至右与来自 format 的类型信息相匹配。 如果执行成功，PyArg_ParseTupleAndKeywords() 会返回真值，否则返回假值并引发一个适当的异常。

注解

嵌套的元组在使用关键字参数时无法生效，不在 kwlist 中的关键字参数会导致 TypeError 异常。

如下例子是使用关键字参数的例子模块，作者是 Geoff Philbrick (philbrick@hks.com):

#define PY_SSIZE_T_CLEAN  /* Make "s#" use Py_ssize_t rather than int. */
#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[] = {
    /* The cast of the function is necessary since PyCFunction values
     * only take two PyObject* parameters, and keywdarg_parrot() takes
     * three.
     */
    {"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 keywdargmodule = {
    PyModuleDef_HEAD_INIT,
    "keywdarg",
    NULL,
    -1,
    keywdarg_methods
};

PyMODINIT_FUNC
PyInit_keywdarg(void)
{
    return PyModule_Create(&keywdargmodule);
}

1.9. 构造任意值

这个函数与 PyArg_ParseTuple() 很相似，声明如下：

PyObject *Py_BuildValue(const char *format, ...);

接受一个格式字符串，与 PyArg_ParseTuple() 相同，但是参数必须是原变量的地址指针(输入给函数，而非输出)。最终返回一个Python对象适合于返回C函数调用给Python代码。

一个与 PyArg_ParseTuple() 的不同是，后面可能需要的要求返回一个元组(Python参数里诶包总是在内部描述为元组)，比如用于传递给其他Python函数以参数。 Py_BuildValue() 并不总是生成元组，在多于1个格式字符串时会生成元组，而如果格式字符串为空则返回 None ，一个参数则直接返回该参数的对象。如果要求强制生成一个长度为0的元组，或包含一个元素的元组，需要在格式字符串中加上括号。

例子(左侧是调用，右侧是Python值结果)：

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))

1.10. 引用计数

在C/C++语言中，程序员负责动态分配和回收堆heap当中的内存。在C里，通过函数 malloc() 和 free() 来完成。在C++里是操作 new 和 delete 来实现相同的功能。

每个由 malloc() 分配的内存块，最终都要由 free() 退回到可用内存池里面去。而调用 free() 的时机非常重要，如果一个内存块忘了 free() 则会导致内存泄漏，这块内存在程序结束前将无法重新使用。这叫做 内存泄漏 。而如果对同一内存块 free() 了以后，另外一个指针再次访问，则再次使用 malloc() 复用这块内存会导致冲突。这叫做 野指针 。等同于使用未初始化的数据，core dump，错误结果，神秘的崩溃等。

内存泄露往往发生在一些并不常见的代码流程上面。比如一个函数申请了内存以后，做了些计算，然后释放内存块。现在一些对函数的修改可能增加对计算的测试并检测错误条件，然后过早的从函数返回了。这很容易忘记在退出前释放内存，特别是后期修改的代码。这种内存泄漏，一旦引入，通常很长时间都难以检测到，错误退出被调用的频度较低，而现代电脑又有非常巨大的虚拟内存，所以泄漏仅在长期运行或频繁调用泄漏函数时才会变得明显。因此，有必要避免内存泄漏，通过代码规范会策略来最小化此类错误。

Python通过 malloc() 和 free() 包含大量的内存分配和释放，同样需要避免内存泄漏和野指针。他选择的方法就是 引用计数 。其原理比较简单：每个对象都包含一个计数器，计数器的增减与对象引用的增减直接相关，当引用计数为0时，表示对象已经没有存在的意义了，对象就可以删除了。

另一个叫法是 自动垃圾回收 。(有时引用计数也被看作是垃圾回收策略，于是这里的"自动"用以区分两者)。自动垃圾回收的优点是用户不需要明确的调用 free() 。(另一个优点是改善速度或内存使用，然而这并不难)。缺点是对C，没有可移植的自动垃圾回收器，而引用计数则可以可移植的实现(只要 malloc() 和 free() 函数是可用的，这也是C标准担保的)。也许以后有一天会出现可移植的自动垃圾回收器，但在此前我们必须与引用计数一起工作。

Python使用传统的引用计数实现，也提供了循环监测器，用以检测引用循环。这使得应用无需担心直接或间接的创建了循环引用，这是引用计数垃圾收集的一个弱点。引用循环是对象(可能直接)的引用了本身，所以循环中的每个对象的引用计数都不是0。典型的引用计数实现无法回收处于引用循环中的对象，或者被循环所引用的对象，哪怕没有循环以外的引用了。

循环检测器能够检测垃圾回收循环并能回收它们。 gc 模块提供了一种运行该检测器的方式 (collect() 函数)，以及多个配置接口和在运行时禁用该检测器的功能。

1.10.1. Python中的引用计数

有两个宏 Py_INCREF(x) 和 Py_DECREF(x) ，会处理引用计数的增减。 Py_DECREF() 也会在引用计数到达0时释放对象。为了灵活，并不会直接调用 free() ，而是通过对象的 类型对象 的函数指针来调用。为了这个目的(或其他的)，每个对象同时包含一个指向自身类型对象的指针。

最大的问题依旧：何时使用 Py_INCREF(x) 和 Py_DECREF(x) ？我们首先引入一些概念。没有人"拥有"一个对象，你可以 拥有一个引用 到一个对象。一个对象的引用计数定义为拥有引用的数量。引用的拥有者有责任调用 Py_DECREF() ，在引用不再需要时。引用的拥有关系可以被传递。有三种办法来处置拥有的引用：传递、存储、调用 Py_DECREF() 。忘记处置一个拥有的引用会导致内存泄漏。

还可以 借用 2 一个对象的引用。借用的引用不应该调用 Py_DECREF() 。借用者必须确保不能持有对象超过拥有者借出的时间。在拥有者处置对象后使用借用的引用是有风险的，应该完全避免 3 。

借用相对于引用的优点是你无需担心整条路径上代码的引用，或者说，通过借用你无需担心内存泄漏的风险。借用的缺点是一些看起来正确代码上的借用可能会在拥有者处置后使用对象。

借用可以变为拥有引用，通过调用 Py_INCREF()。 这不会影响已经借出的拥有者的状态。 这会创建一个新的拥有引用，并给予完全的拥有者责任（新的拥有者必须恰当的处置引用，就像之前的拥有者那样）。

1.10.2. 拥有规则

当一个对象引用传递进出一个函数时，函数的接口应该指定拥有关系的传递是否包含引用。

大多数函数返回一个对象的引用，并传递引用拥有关系。通常，所有创建对象的函数，例如 PyLong_FromLong() 和 Py_BuildValue() ，会传递拥有关系给接收者。即便是对象不是真正新的，你仍然可以获得对象的新引用。一个实例是 PyLong_FromLong() 维护了一个流行值的缓存，并可以返回已缓存项目的新引用。

很多另一个对象提取对象的函数，也会传递引用关系，例如 PyObject_GetAttrString() 。这里的情况不够清晰，一些不太常用的例程是例外的 PyTuple_GetItem() ， PyList_GetItem() ， PyDict_GetItem() ， PyDict_GetItemString() 都是返回从元组、列表、字典里借用的引用。

函数 PyImport_AddModule() 也会返回借用的引用，哪怕可能会返回创建的对象：这个可能因为一个拥有的引用对象是存储在 sys.modules 里。

当你传递一个对象引用到另一个函数时，通常函数是借用出去的。如果需要存储，就使用 Py_INCREF() 来变成独立的拥有者。这个规则有两个重要的例外： PyTuple_SetItem() 和 PyList_SetItem() 。这些函数接受传递来的引用关系，哪怕会失败！(注意 PyDict_SetItem() 及其同类不会接受引用关系，他们是"正常的")。

当一个C函数被Python调用时，会从调用方传来的参数借用引用。调用者拥有对象的引用，所以借用的引用生命周期可以保证到函数返回。只要当借用的引用需要存储或传递时，就必须转换为拥有的引用，通过调用 Py_INCREF() 。

Python调用从C函数返回的对象引用时必须是拥有的引用---拥有关系被从函数传递给调用者。

1.10.3. 危险的薄冰

有少数情况下，借用的引用看起来无害，但却可能导致问题。这通常是因为解释器的隐式调用，并可能导致引用拥有者处置这个引用。

首先需要特别注意的情况是使用 Py_DECREF() 到一个无关对象，而这个对象的引用是借用自一个列表的元素。举个实例：

void
bug(PyObject *list)
{
    PyObject *item = PyList_GetItem(list, 0);

    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    PyObject_Print(item, stdout, 0); /* BUG! */
}

这个函数首先借用一个引用 list[0] ，然后替换 list[1] 为值 0 ，最后打印借用的引用。看起来无害是吧，但却不是。

我们跟着控制流进入 PyList_SetItem() 。列表拥有者引用了其所有成员，所以当成员1被替换时，就必须处置原来的成员1。现在假设原来的成员1是用户定义类的实例，且假设这个类定义了 __del__() 方法。如果这个类实例的引用计数是1，那么处置动作就会调用 __del__() 方法。

既然是Python写的， __del__() 方法可以执行任意Python代码。是否可能在 bug() 的 item 废止引用呢，是的。假设列表传递到 bug() 会被 __del__() 方法所访问，就可以执行一个语句来实现 del list[0] ，然后假设这是最后一个对对象的引用，就需要释放内存，从而使得 item 无效化。

解决方法是，当你知道了问题的根源，就容易了：临时增加引用计数。正确版本的函数代码如下：

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);
}

这是个真实的故事。一个旧版本的Python包含了这个bug的变种，而一些人花费了大量时间在C调试器上去寻找为什么 __del__() 方法会失败。

这个问题的第二种情况是借用的引用涉及线程的变种。通常，Python解释器里多个线程无法进入对方的路径，因为有个全局锁保护着Python整个对象空间。但可以使用宏 Py_BEGIN_ALLOW_THREADS 来临时释放这个锁，重新获取锁用 Py_END_ALLOW_THREADS 。这通常围绕在阻塞I/O调用外，使得其他线程可以在等待I/O期间使用处理器。显然，如下函数会跟之前那个有一样的问题：

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! */
}

1.10.4. NULL指针

通常，接受对象引用作为参数的函数不希望你传给它们 NULL 指针，并且当你这样做时将会转储核心（或在以后导致核心转储）。 返回对象引用的函数通常只在要指明发生了异常时才返回 NULL。 不检测 NULL 参数的原因在于这些函数经常要将它们所接收的对象传给其他函数 --- 如果每个函数都检测 NULL，将会导致大量的冗余检测而使代码运行得更缓慢。

更好的做法是仅在“源头”上检测 NULL，即在接收到一个可能为 NULL 的指针，例如来自 malloc() 或是一个可能引发异常的函数的时候。

Py_INCREF() 和 Py_DECREF() 等宏不会检测 NULL 指针 --- 但是，它们的变种 Py_XINCREF() 和 Py_XDECREF() 则会检测。

用于检测特定对象类型的宏 (Pytype_Check()) 不会检测 NULL 指针 --- 同样地，有大量代码会连续调用这些宏来测试一个对象是否为几种不同预期类型之一，这将会生成冗余的测试。 不存在带有 NULL 检测的变体。

C 函数调用机制会保证传给 C 函数的参数列表 (本示例中为 args) 绝不会为 NULL --- 实际上它会保证其总是为一个元组 4。

任何时候将 NULL 指针“泄露”给 Python 用户都会是个严重的错误。

1.11. 在C++中编写扩展

还可以在C++中编写扩展模块，只是有些限制。如果主程序(Python解释器)是使用C编译器来编译和链接的，全局或静态对象的构造器就不能使用。而如果是C++编译器来链接的就没有这个问题。函数会被Python解释器调用(通常就是模块初始化函数)必须声明为 extern "C" 。而是否在 extern "C" {...} 里包含Python头文件则不是那么重要，因为如果定义了符号 __cplusplus 则已经是这么声明的了(所有现代C++编译器都会定义这个符号)。

1.12. 给扩展模块提供C API

很多扩展模块提供了新的函数和类型供Python使用，但有时扩展模块里的代码也可以被其他扩展模块使用。例如，一个扩展模块可以实现一个类型 "collection" 看起来是没有顺序的。就像是Python列表类型，拥有C API允许扩展模块来创建和维护列表，这个新的集合类型可以有一堆C函数用于给其他扩展模块直接使用。

开始看起来很简单：只需要编写函数(无需声明为 static )，提供恰当的头文件，以及C API的文档。实际上在所有扩展模块都是静态链接到Python解释器时也是可以正常工作的。当模块以共享库链接时，一个模块中的符号定义对另一个模块不可见。可见的细节依赖于操作系统，一些系统的Python解释器使用全局命名空间(例如Windows)，有些则在链接时需要一个严格的已导入符号列表(一个例子是AIX)，或者提供可选的不同策略(如Unix系列)。即便是符号是全局可见的，你要调用的模块也可能尚未加载。

可移植性需要不能对符号可见性做任何假设。这意味着扩展模块里的所有符号都应该声明为 static ，除了模块的初始化函数，来避免与其他扩展模块的命名冲突(在段落 模块方法表和初始化函数 中讨论) 。这意味着符号应该 必须 通过其他导出方式来供其他扩展模块访问。

Python 提供了一个特别的机制用来从一个扩展模块向另一个扩展模块传递 C 层级的信息 (指针): Capsule。 一个 Capsule 就是一个存储了指针 (void*) 的 Python 数据类型。 Capsule 只能通过其 C API 来创建和访问，但它们可以像任何其他 Python 对象一样被传递。 特别地，它们可以被赋值给扩展模块命名空间中的一个名称。 其他扩展模块将可以导入这个模块，获取该名称对应的值，然后从 Capsule 中获取指针。

Capsule可以用多种方式导出C API给扩展模块。每个函数可以用自己的Capsule，或者所有C API指针可以存储在一个数组里，数组地址再发布给Capsule。存储和获取指针也可以用多种方式，供客户端模块使用。

无论你选择哪个方法，为你的 Capsule 指定适当的名称都很重要。 函数 PyCapsule_New() 接受一个 name 形参 (const char*)；允许你传入一个 NULL 作为名称，但我们强烈推荐你指定名称。 正确地命名的 Capsule 提供了一定的运行时类型安全性；没有可行的方式能区别两个未命名的 Capsule。

通常来说，Capsule用于暴露C API，其名字应该遵循如下规范：

modulename.attributename

便利函数 PyCapsule_Import() 可以方便的载入通过Capsule提供的C API，仅在Capsule的名字匹配时。这个行为为C API用户提供了高度的确定性来载入正确的C API。

下面的例子演示了一种将大部分负担交给导出模块编写者的处理方式，这对于常用的库模块来说是合适的。 它会将所有 C API 指针（在这个例子里只有一个！）储存到一个 void 指针数组，它将成为一个 Capsule 的值。 与模块对应的头文件提供了一个宏用来管理导入模块和获取其 C API 指针；客户端模块只需要在访问 C API 之前调用这个宏即可。

导出的模块修改自 spam 模块，来自 一个简单的例子 段落。函数 spam.system() 不会直接调用C库函数 system() ，但一个函数 PySpam_System() 会负责调用，当然现实中会更复杂些(例如添加 "spam" 到每个命令)。函数 PySpam_System() 也会导出给其他扩展模块。

函数 PySpam_System() 是个纯C函数，声明 static 就像其他地方那样:

static int
PySpam_System(const char *command)
{
    return system(command);
}

函数 spam_system() 按照如下方式修改:

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);
}

在模块开头，在此行后:

#include <Python.h>

添加另外两行:

#define SPAM_MODULE
#include "spammodule.h"

#define 用于告知头文件需要包含给导出的模块，而不是客户端模块。最终，模块的初始化函数必须负责初始化C API指针数组:

PyMODINIT_FUNC
PyInit_spam(void)
{
    PyObject *m;
    static void *PySpam_API[PySpam_API_pointers];
    PyObject *c_api_object;

    m = PyModule_Create(&spammodule);
    if (m == NULL)
        return NULL;

    /* Initialize the C API pointer array */
    PySpam_API[PySpam_System_NUM] = (void *)PySpam_System;

    /* Create a Capsule containing the API pointer array's address */
    c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);

    if (PyModule_AddObject(m, "_C_API", c_api_object) < 0) {
        Py_XDECREF(c_api_object);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

注意 PySpam_API 声明为 static ；此外指针数组会在 PyInit_spam() 结束后消失!

头文件 spammodule.h 里的一堆工作，看起来如下所示:

#ifndef Py_SPAMMODULE_H
#define Py_SPAMMODULE_H
#ifdef __cplusplus
extern "C" {
#endif

/* Header file for spammodule */

/* C API functions */
#define PySpam_System_NUM 0
#define PySpam_System_RETURN int
#define PySpam_System_PROTO (const char *command)

/* Total number of C API pointers */
#define PySpam_API_pointers 1

#ifdef SPAM_MODULE
/* This section is used when compiling spammodule.c */

static PySpam_System_RETURN PySpam_System PySpam_System_PROTO;

#else
/* This section is used in modules that use spammodule's API */

static void **PySpam_API;

#define PySpam_System \
 (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM])

/* Return -1 on error, 0 on success.
 * PyCapsule_Import will set an exception if there's an error.
 */
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) */

客户端模块必须在其初始化函数里按顺序调用函数 import_spam() (或其他宏)才能访问函数 PySpam_System() 。

PyMODINIT_FUNC
PyInit_client(void)
{
    PyObject *m;

    m = PyModule_Create(&clientmodule);
    if (m == NULL)
        return NULL;
    if (import_spam() < 0)
        return NULL;
    /* additional initialization can happen here */
    return m;
}

这种方法的主要缺点是，文件 spammodule.h 过于复杂。当然，对每个要导出的函数，基本结构是相似的，所以只需要学习一次。

最后需要提醒的是Capsule提供了额外的功能，用于存储在Capsule里的指针的内存分配和释放。细节参考 Python/C API参考手册的章节 Capsule 对象 和Capsule的实现(在Python源码发行包的 Include/pycapsule.h 和 Objects/pycapsule.c )。

备注

1

这个函数的接口已经在标准模块 os 里了，这里作为一个简单而直接的例子。

2

术语"借用"一个引用是不完全正确的：拥有者仍然有引用的拷贝。

3

检查引用计数至少为1 没有用 ，引用计数本身可以在已经释放的内存里，并有可能被其他对象所用。

4

当你使用 "旧式" 风格调用约定时，这些保证不成立，尽管这依旧存在于很多旧代码中。

2. 自定义扩展类型：教程

Python 允许编写 C 扩展模块定义可以从 Python 代码中操纵的新类型，这很像内置的 str 和 list 类型。所有扩展类型的代码都遵循一个模式，但是在您开始之前，您需要了解一些细节。这份文件是对这个主题介绍。

2.1. 基础

CPython 运行时会将所有 Python 对象都视为 PyObject* 类型的变量，这是所有 Python 对象的“基础类型”。 PyObject 结构体本身只包含对象的 reference count 和指向对象的“类型对象”的指针。 这是动作所针对的目标。 类型对象决定解释器要调用哪些 (C) 函数，例如，在对象上查找一个属性，调用一个方法，或者与另一个对象相乘等。 这些 C 函数被称为“类型方法”。

所以，如果你想要定义新的扩展类型，需要创建新的类型对象。

这类事情只能用例子解释，这里用一个最小化但完整的的模块，定义了新的类型叫做 Custom 在C扩展模块 custom 里。

注解

这里展示的方法是定义 static 扩展类型的传统方法。可以适合大部分用途。C API也可以定义在堆上分配的扩展类型，使用 PyType_FromSpec() 函数，但不在本入门里讨论。

#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct {
    PyObject_HEAD
    /* Type-specific fields go here. */
} CustomObject;

static PyTypeObject CustomType = {
    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 PyModuleDef custommodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "custom",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
};

PyMODINIT_FUNC
PyInit_custom(void)
{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    Py_INCREF(&CustomType);
    if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
        Py_DECREF(&CustomType);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

这部分很容易理解，这是为了跟上一章能对接上。这个文件定义了三件事：

Custom 类的对象 object 包含了： CustomObject 结构，这会为每个 Custom 实例分配一次。

Custom type 的行为：这是 CustomType 结构体，其定义了一堆标识和函数指针，会指向解释器里请求的操作。

初始化 custom 模块： PyInit_custom 函数和对应的 custommodule 结构体。

结构的第一块是

typedef struct {
    PyObject_HEAD
} CustomObject;

这就是一个自定义对象将会包含的内容。 PyObject_HEAD 是强制要求放在每个对象结构体之前并定义一个名为 ob_base 的 PyObject 类型的字段，其中包含一个指向类型对象和引用计数的指针（这两者可以分别使用宏 Py_TYPE 和 Py_REFCNT 来区分）。 使用宏的理由是将布局抽象出来并在 调试编译版中 中启用附加字段。

注解

注意在宏 PyObject_HEAD 后没有分号。意外添加分号会导致编译器提示出错。

当然，对象除了在 PyObject_HEAD 存储数据外，还有额外数据；例如，如下定义了标准的Python浮点数:

typedef struct {
    PyObject_HEAD
    double ob_fval;
} PyFloatObject;

第二个位是类型对象的定义:

static PyTypeObject CustomType = {
    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,
};

注解

推荐使用如上C99风格的初始化，以避免列出所有的 PyTypeObject 字段，其中很多是你不需要关心的，这样也可以避免关注字段的定义顺序。

在 object.h 中实际定义的 PyTypeObject 具有比如上定义更多的 字段。 剩余的字段会由 C 编译器用零来填充，通常的做法是不显式地指定它们，除非你确实需要它们。

我们先挑选一部分，每次一个字段:

PyVarObject_HEAD_INIT(NULL, 0)

这一行是强制的样板，用以初始化如上提到的 ob_base 字段:

.tp_name = "custom.Custom",

我们的类型的名称。 这将出现在我们的对象的默认文本表示形式和某些错误消息中，例如:

>>> "" + custom.Custom()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: can only concatenate str (not "custom.Custom") to str

注意，名字是一个带点的名字，包括模块名称和模块中的类型名称。本例中的模块是 custom，类型是 Custom，所以我们将类型名设为 custom.Custom。使用真正的点状导入路径很重要，可以使你的类型与 pydoc 和 pickle 模块兼容。

.tp_basicsize = sizeof(CustomObject),
.tp_itemsize = 0,

这样能让 Python 知道当创建新的 Custom 实例时需要分配多少内存。 tp_itemsize 仅用于可变大小的对象而在其他情况下都应为零。

注解

如果你希望你的类型可在 Python 中被子类化，并且你的类型具有与其基础类型相同的 tp_basicsize，那么你可能会遇到多重继承问题。 你的类型在 Python 中的子类将必须在其 __bases__ 中将你的类型列在最前面，否则它在调用你的类型的 __new__() 方法时就会遇到错误。 你可以通过确保你的类型具有比其基础类型更大的 tp_basicsize 值来避免此问题。 在大多数时候，这都是可以的，因为或者你的基础类型为 object，或者你会向你的基础类型增加数据成员，并因而增加其大小。

我们将类旗标设为 Py_TPFLAGS_DEFAULT。

.tp_flags = Py_TPFLAGS_DEFAULT,

所有类型都应当在它们的旗标中包括此常量。 该常量将启用至少在 Python 3.3 之前定义的全部成员。 如果你需要更多的成员，你将需要对相应的旗标进行 OR 运算。

我们为 tp_doc 类型提供一个文档字符串.

.tp_doc = PyDoc_STR("Custom objects"),

要启用对象创建，我们需要提供一个 tp_new 处理器。 这等价于 Python 方法 __new__()，但是必须显式地指定。 在这个场景中，我们可以直接使用 API 函数 PyType_GenericNew() 所提供的默认实现。

.tp_new = PyType_GenericNew,

该文件的其他部分应该都很容易理解，除了 PyInit_custom() 中的某些代码:

if (PyType_Ready(&CustomType) < 0)
    return;

这将初始化 Custom 类型，为一部分成员填充适当的默认值，包括我们在初始时设为 NULL 的 ob_type。

Py_INCREF(&CustomType);
if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
    Py_DECREF(&CustomType);
    Py_DECREF(m);
    return NULL;
}

这将把类型添加到模块字典。 这使我们能通过调用 Custom 类来创建 Custom 实例:

>>> import custom
>>> mycustom = custom.Custom()

好了！ 接下来要做的就是编译它；将上述代码放到名为 custom.c 的文件中然后:

from distutils.core import setup, Extension
setup(name="custom", version="1.0",
      ext_modules=[Extension("custom", ["custom.c"])])

在名为 setup.py 的文件中；然后输入

$ python setup.py build

到 shell 中应当会在一个子目录中产生文件 custom.so；进入该目录并运行 Python --- 你应当能够执行 import custom 并尝试使用 Custom 对象。

这并不难，对吗？

当然，当前的自定义类型非常无趣。它没有数据，也不做任何事情。它甚至不能被子类化。

注解

虽然本文档演示了用于构建 C 扩展的标准 distutils 模块，但在真实场景中还是推荐使用更新且维护得更好的 setuptools 库。 有关其用法的文档超出了本文档的范围，可以访问 Python 打包用户指南 [https://packaging.python.org/tutorials/distributing-packages/] 来获取。

2.2. 向基本示例添加数据和方法

让我们通过添加一些数据和方法来扩展这个基本示例。 让我们再使原类型可以作为基类使用。 我们将创建一个新模块 custom2 来添加这些功能:

#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include "structmember.h"

typedef struct {
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
} CustomObject;

static void
Custom_dealloc(CustomObject *self)
{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) 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 = 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;
}

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
{
    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;
}

static PyMemberDef Custom_members[] = {
    {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,
     "first name"},
    {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,
     "last name"},
    {"number", T_INT, offsetof(CustomObject, number), 0,
     "custom number"},
    {NULL}  /* Sentinel */
};

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
{
    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", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    },
    {NULL}  /* Sentinel */
};

static PyTypeObject CustomType = {
    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 = (initproc) Custom_init,
    .tp_dealloc = (destructor) Custom_dealloc,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
};

static PyModuleDef custommodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "custom2",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
};

PyMODINIT_FUNC
PyInit_custom2(void)
{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    Py_INCREF(&CustomType);
    if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
        Py_DECREF(&CustomType);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

该模块的新版本包含多处修改。

我们已经添加呢一个外部导入:

#include <structmember.h>

这包括提供被我们用来处理属性的声明，正如我们稍后所描述的。

现在 Custom 类型的 C 结构体中有三个数据属性，first, last 和 number。 其中 first 和 last 变量是包含头一个和末一个名称的 Python 字符串。 number 属性是一个 C 整数。

对象的结构将被相应地更新:

typedef struct {
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
} CustomObject;

因为现在我们有数据需要管理，我们必须更加小心地处理对象的分配和释放。 至少，我们需要有一个释放方法:

static void
Custom_dealloc(CustomObject *self)
{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) self);
}

它会被赋值给 tp_dealloc 成员:

.tp_dealloc = (destructor) Custom_dealloc,

此方法会先清空两个 Python 属性的引用计数。 Py_XDECREF() 可正确地处理其参数为 NULL 的情况（这可能在 tp_new 中途失败时发生）。 随后它将调用对象类型的 tp_free 成员（通过 Py_TYPE(self) 获取对象类型）来释放对象的内存。 请注意对象类型可以不是 CustomType，因为对象可能是一个子类的实例。

注解

上面需要强制转换 destructor 是因为我们定义了 Custom_dealloc 接受一个 CustomObject * 参数，但 tp_dealloc 函数指针预期接受一个 PyObject * 参数。 如果不这样做，编译器将发出警告。 这是 C 语言中面向对象的多态性！

我们希望确保头一个和末一个名称被初始化为空字符串，因此我们提供了一个 tp_new 实现:

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;
}

并在 tp_new 成员中安装它:

.tp_new = Custom_new,

tp_new 处理器负责创建（而不是初始化）该类型的对象。 它在 Python 中被暴露为 __new__() 方法。 它不需要定义 tp_new 成员，实际上许多扩展类型会简单地重用 PyType_GenericNew()，就像上面第一版 Custom 类型所作的那样。 在此情况下，我们使用 tp_new 处理器来将 first 和 last 属性初始化为非 NULL 的默认值。

tp_new 将接受被实例化的类型（不要求为 CustomType，如果被实例化的是一个子类）以及在该类型被调用时传入的任何参数，并预期返回所创建的实例。 tp_new 处理器总是接受位置和关键字参数，但它们总是会忽略这些参数，而将参数处理留给初始化（即 C 中的 tp_init 或 Python 中的 __init__ 函数）方法来执行。

注解

tp_new 不应显式地调用 tp_init，因为解释器会自行调用它。

tp_new 实现会调用 tp_alloc 槽位来分配内存:

self = (CustomObject *) type->tp_alloc(type, 0);

由于内存分配可能会失败，我们必须在继续执行之前检查 tp_alloc 结果确认其不为 NULL。

注解

我们没有自行填充 tp_alloc 槽位。 而是由 PyType_Ready() 通过从我们的基类继承来替我们填充它，其中默认为 object。 大部分类型都是使用默认的分配策略。

注解

如果你要创建一个协作 tp_new (它会调用基类型的 tp_new 或 __new__())，那么你 不能 在运行时尝试使用方法解析顺序来确定要调用的方法。 必须总是静态地确定你要调用的类型，并直接调用它的 tp_new，或是通过 type->tp_base->tp_new。 如果你不这样做，你的类型的同样从其他 Python 定义的类继承的 Python 子类可能无法正确工作。 (特别地，你可能无法创建这样的子类的实例而是会引发 TypeError。)

我们还定义了一个接受参数来为我们的实例提供初始值的初始化函数:

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
{
    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;
}

通过填充 tp_init 槽位。

.tp_init = (initproc) Custom_init,

tp_init 槽位在 Python 中暴露为 __init__() 方法。 它被用来在对象被创建后初始化它。 初始化器总是接受位置和关键字参数，它们应当在成功时返回 0 而在出错时返回 -1。

不同于 tp_new 处理器，tp_init 不保证一定会被调用 (例如，在默认情况下 pickle 模块不会在被解封的实例上调用 __init__())。 它还可能被多次调用。 任何人都可以在我们的对象上调用 __init__() 方法。 由于这个原因，我们在为属性赋新值时必须非常小心。 我们可能会被误导，例如像这样给 first 成员赋值:

if (first) {
    Py_XDECREF(self->first);
    Py_INCREF(first);
    self->first = first;
}

但是这可能会有危险。 我们的类型没有限制 first 成员的类型，因此它可以是任何种类的对象。 它可以带有一个会执行尝试访问 first 成员的代码的析构器；或者该析构器可能会释放 全局解释器锁 并让任意代码在其他线程中运行来访问和修改我们的对象。

为了保持谨慎并使我们避免这种可能性，我们几乎总是要在减少成员的引用计数之前给它们重新赋值。 什么时候我们可以不必再这样做？

当我们明确知道引用计数大于 1 的时候;

当我们知道对象的释放 1 既不会释放 GIL 也不会导致任何对我们的类型的代码的回调的时候;

当减少一个 tp_dealloc 处理器内不支持循环垃圾回收的类型的引用计数的时候 2.

我们可能会想将我们的实例变量暴露为属性。 有几种方式可以做到这一点。 最简单的方式是定义成员的定义:

static PyMemberDef Custom_members[] = {
    {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,
     "first name"},
    {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,
     "last name"},
    {"number", T_INT, offsetof(CustomObject, number), 0,
     "custom number"},
    {NULL}  /* Sentinel */
};

并将定义放置到 tp_members 槽位中:

.tp_members = Custom_members,

每个成员的定义都有成员名称、类型、偏移量、访问旗标和文档字符串。 请参阅下面的 泛型属性管理 小节来了解详情。section below for details.

此方式的缺点之一是它没有提供限制可被赋值给 Python 属性的对象类型的办法。 我们预期 first 和 last 的名称为字符串，但它们可以被赋值为任意 Python 对象。 此外，这些属性还可以被删除，并将 C 指针设为 NULL。 即使我们可以保证这些成员被初始化为非 NULL 值，如果这些属性被删除这些成员仍可被设为 NULL。

我们定义了一个单独的方法，Custom.name()，它将对象名称输出为 first 和 last 名称的拼接。

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
{
    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);
}

该方法的实现形式是一个接受 Custom (或 Custom 的子类) 实例作为第一个参数的 C 函数。 方法总是接受一个实例作为第一个参数。 方法也总是接受位置和关键字参数，但在本例中我们未接受任何参数也不需要接受位置参数元组或关键字参数字典。 该方法等价于以下 Python 方法:

def name(self):
    return "%s %s" % (self.first, self.last)

请注意我们必须检查我们的 first 和 last 成员是否可能为 NULL。 这是因为它们可以被删除，在此情况下它们会被设为 NULL。 更好的做法是防止删除这些属性并将属性的值限制为字符串。 我们将在下一节了解如何做到这一点。

现在我们已经定义好了方法，我们需要创建一个方法定义数组:

static PyMethodDef Custom_methods[] = {
    {"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    },
    {NULL}  /* Sentinel */
};

（请注意我们使用 METH_NOARGS 旗标来指明该方法不准备接受 self 以外的任何参数）

并将其赋给 tp_methods 槽位:

.tp_methods = Custom_methods,

最后，我们将使我们的类型可被用作派生子类的基类。 我们精心地编写我们的方法以便它们不会随意假定被创建或使用的对象类型，所以我们需要做的就是将 Py_TPFLAGS_BASETYPE 添加到我们的类旗标定义中:

.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

我们将 PyInit_custom() 重命名为 PyInit_custom2()，更新 PyModuleDef 结构体中的模块名，并更新 PyTypeObject 结构体中的完整类名。

最后，我们更新我们的 setup.py 文件来生成新的模块。

from distutils.core import setup, Extension
setup(name="custom", version="1.0",
      ext_modules=[
         Extension("custom", ["custom.c"]),
         Extension("custom2", ["custom2.c"]),
         ])

2.3. 提供对于数据属性的更精细控制

在本小节中，我们将对 Custom 示例中 first 和 last 属性的设置提供更细致的控制。 在我们上一版本的模块中，实例变量 first 和 last 可以被设为非字符串值甚至被删除。 我们希望这些属性总是包含字符串。

#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include "structmember.h"

typedef struct {
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
} CustomObject;

static void
Custom_dealloc(CustomObject *self)
{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) 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 = 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;
}

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
{
    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;
}

static PyMemberDef Custom_members[] = {
    {"number", T_INT, offsetof(CustomObject, number), 0,
     "custom number"},
    {NULL}  /* Sentinel */
};

static PyObject *
Custom_getfirst(CustomObject *self, void *closure)
{
    Py_INCREF(self->first);
    return self->first;
}

static int
Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
{
    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;
}

static PyObject *
Custom_getlast(CustomObject *self, void *closure)
{
    Py_INCREF(self->last);
    return self->last;
}

static int
Custom_setlast(CustomObject *self, PyObject *value, void *closure)
{
    PyObject *tmp;
    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;
    }
    tmp = self->last;
    Py_INCREF(value);
    self->last = value;
    Py_DECREF(tmp);
    return 0;
}

static PyGetSetDef Custom_getsetters[] = {
    {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
     "first name", NULL},
    {"last", (getter) Custom_getlast, (setter) Custom_setlast,
     "last name", NULL},
    {NULL}  /* Sentinel */
};

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
{
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
}

static PyMethodDef Custom_methods[] = {
    {"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    },
    {NULL}  /* Sentinel */
};

static PyTypeObject CustomType = {
    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 = (initproc) Custom_init,
    .tp_dealloc = (destructor) Custom_dealloc,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
    .tp_getset = Custom_getsetters,
};

static PyModuleDef custommodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "custom3",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
};

PyMODINIT_FUNC
PyInit_custom3(void)
{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    Py_INCREF(&CustomType);
    if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
        Py_DECREF(&CustomType);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

为了提供对于 first 和 last 属性更强的控制，我们将使用自定义的读取和设置函数。 下面就是用于读取和设置 first 属性的函数:

static PyObject *
Custom_getfirst(CustomObject *self, void *closure)
{
    Py_INCREF(self->first);
    return self->first;
}

static int
Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
{
    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;
}

读取函数接受一个 Custom 对象和一个“闭包”，它是一个空指针。 在本例中，该闭包会被忽略。 （该闭包支持将定义数据传给读取器和设置器的进阶用法。 例如，这可以被用来允许单组读取和设置函数根据闭包中的数据来决定要读取或设置的属性。）

设置器函数将接受 Custom 对象、新值以及闭包。 新值可以为 NULL，在此情况下属性将被删除。 在我们的设置器中，如果属性被删除或者如果它的新值不是字符串则我们将引发一个错误。

我们创建一个 PyGetSetDef 结构体的数组:

static PyGetSetDef Custom_getsetters[] = {
    {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
     "first name", NULL},
    {"last", (getter) Custom_getlast, (setter) Custom_setlast,
     "last name", NULL},
    {NULL}  /* Sentinel */
};

并在 tp_getset 槽位中注册它:

.tp_getset = Custom_getsetters,

在 PyGetSetDef 结构体中的最后一项是上面提到的“闭包”。 在本例中，我们没有使用闭包，因此我们只传入 NULL。

我们还移除了这些属性的成员定义:

static PyMemberDef Custom_members[] = {
    {"number", T_INT, offsetof(CustomObject, number), 0,
     "custom number"},
    {NULL}  /* Sentinel */
};

我们还需要将 tp_init 处理器更新为只允许传入字符串 3:

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
{
    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;
}

通过这些更改，我们能够确保 first 和 last 成员一定不为 NULL 以便我们能在几乎所有情况下移除 NULL 值检查。 这意味着大部分 Py_XDECREF() 调用都可以被转换为 Py_DECREF() 调用。 我们不能更改这些调用的唯一场合是在 tp_dealloc 实现中，那里这些成员的初始化有可能在 tp_new 中失败。

我们还重命名了模块初始化函数和初始化函数中的模块名称，就像我们之前所做的一样，我们还向 setup.py 文件添加了一个额外的定义。

2.4. 支持循环垃圾回收

Python 具有一个可以标识不再需要的对象的 循环垃圾回收器 (GC) 即使它们的引用计数并不为零。 这种情况会在对象被循环引用时发生。 例如，设想:

>>> l = []
>>> l.append(l)
>>> del l

在这个例子中，我们创建了一个包含其自身的列表。 当我们删除它的时候，它将仍然具有一个来自其本身的引用。 它的引用计数并未降为零。 幸运的是，Python 的循环垃圾回收器将最终发现该列表是无用的垃圾并释放它。

在 Custom 示例的第二个版本中，我们允许任意各类的对象存储到 first 或 last 属性中 4。 此外，在第二个和第三个版本中，我们还允许子类化 Custom，并且子类可以添加任意属性。 出于这两个原因中的任何一个，Custom 对象都可以加入循环:

>>> import custom3
>>> class Derived(custom3.Custom): pass
...
>>> n = Derived()
>>> n.some_attribute = n

要允许一个参加引用循环的 Custom 实例被循环 GC 正确地删除并回收，我们的 Custom 类型需要填充两个额外槽位并增加启用这些槽位的旗标:

#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include "structmember.h"

typedef struct {
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
} CustomObject;

static int
Custom_traverse(CustomObject *self, visitproc visit, void *arg)
{
    Py_VISIT(self->first);
    Py_VISIT(self->last);
    return 0;
}

static int
Custom_clear(CustomObject *self)
{
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
}

static void
Custom_dealloc(CustomObject *self)
{
    PyObject_GC_UnTrack(self);
    Custom_clear(self);
    Py_TYPE(self)->tp_free((PyObject *) 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 = 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;
}

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
{
    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;
}

static PyMemberDef Custom_members[] = {
    {"number", T_INT, offsetof(CustomObject, number), 0,
     "custom number"},
    {NULL}  /* Sentinel */
};

static PyObject *
Custom_getfirst(CustomObject *self, void *closure)
{
    Py_INCREF(self->first);
    return self->first;
}

static int
Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
{
    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_INCREF(value);
    Py_CLEAR(self->first);
    self->first = value;
    return 0;
}

static PyObject *
Custom_getlast(CustomObject *self, void *closure)
{
    Py_INCREF(self->last);
    return self->last;
}

static int
Custom_setlast(CustomObject *self, PyObject *value, void *closure)
{
    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_INCREF(value);
    Py_CLEAR(self->last);
    self->last = value;
    return 0;
}

static PyGetSetDef Custom_getsetters[] = {
    {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
     "first name", NULL},
    {"last", (getter) Custom_getlast, (setter) Custom_setlast,
     "last name", NULL},
    {NULL}  /* Sentinel */
};

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
{
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
}

static PyMethodDef Custom_methods[] = {
    {"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    },
    {NULL}  /* Sentinel */
};

static PyTypeObject CustomType = {
    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 = (initproc) Custom_init,
    .tp_dealloc = (destructor) Custom_dealloc,
    .tp_traverse = (traverseproc) Custom_traverse,
    .tp_clear = (inquiry) Custom_clear,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
    .tp_getset = Custom_getsetters,
};

static PyModuleDef custommodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "custom4",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
};

PyMODINIT_FUNC
PyInit_custom4(void)
{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    Py_INCREF(&CustomType);
    if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
        Py_DECREF(&CustomType);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

首先，遍历方法让循环 GC 知道能够参加循环的子对象:

static int
Custom_traverse(CustomObject *self, visitproc visit, void *arg)
{
    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;
}

对于每个能够参加循环的子对象，我们需要调用 visit() 函数，向它传入该遍历方法。 visit() 函数接受该子对象作为参数并接受传给遍历方法的额外参数 arg。 它返回一个必须在非零时返回的整数值。

Python 提供了一个可自动调用 visit 函数的 Py_VISIT() 宏。 使用 Py_VISIT()，我们可以最小化 Custom_traverse 中的准备工作量:

static int
Custom_traverse(CustomObject *self, visitproc visit, void *arg)
{
    Py_VISIT(self->first);
    Py_VISIT(self->last);
    return 0;
}

注解

tp_traverse 实现必须将其参数准确命名为 visit 和 arg 以便使用 Py_VISIT()。

第二，我们需要提供一个方法用来清除任何可以参加循环的子对象:

static int
Custom_clear(CustomObject *self)
{
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
}

请注意 Py_CLEAR() 宏的使用。 它是清除任意类型的数据属性并减少其引用计数的推荐的且安全的方式。 如果你要选择在将属性设为 NULL 之间在属性上调用 Py_XDECREF()，则属性的析构器有可能会回调再次读取该属性的代码 (特别是 如果存在引用循环的话)。

注解

你可以通过以下写法来模拟 Py_CLEAR():

PyObject *tmp;
tmp = self->first;
self->first = NULL;
Py_XDECREF(tmp);

无论如何，在删除属性时始终使用Nevertheless, it is much easier and less error-prone to always use Py_CLEAR() 都是更简单且更不易出错的。 请不要尝试以健壮性为代价的微小优化！

释放器 Custom_dealloc 可能会在清除属性时调用任意代码。 这意味着循环 GC 可以在函数内部被触发。 由于 GC 预期引用计数不为零，我们需要通过调用 PyObject_GC_UnTrack() 来让 GC 停止追踪相关的对象。 下面是我们使用 PyObject_GC_UnTrack() 和 Custom_clear 重新实现的释放器:

static void
Custom_dealloc(CustomObject *self)
{
    PyObject_GC_UnTrack(self);
    Custom_clear(self);
    Py_TYPE(self)->tp_free((PyObject *) self);
}

最后，我们将 Py_TPFLAGS_HAVE_GC 旗标添加到类旗标中:

.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,

这样就差不多了。 如果我们编写了自定义的 tp_alloc 或 tp_free 处理器，则我们需要针对循环垃圾回收来修改它。 大多数扩展都将使用自动提供的版本。

2.5. 子类化其他类型

创建派生自现有类型的新类型是有可能的。 最容易的做法是从内置类型继承，因为扩展可以方便地使用它所需要的 PyTypeObject。 在不同扩展模块之间共享这些 PyTypeObject 结构体则是困难的。

在这个例子中我们将创建一个继承自内置 list 类型的 SubList 类型。 这个新类型将完全兼容常规列表，但将拥有一个额外的 increment() 来增加内部计数器的值:

>>> import sublist
>>> s = sublist.SubList(range(3))
>>> s.extend(s)
>>> print(len(s))
6
>>> print(s.increment())
1
>>> print(s.increment())
2

#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct {
    PyListObject list;
    int state;
} SubListObject;

static PyObject *
SubList_increment(SubListObject *self, PyObject *unused)
{
    self->state++;
    return PyLong_FromLong(self->state);
}

static PyMethodDef SubList_methods[] = {
    {"increment", (PyCFunction) SubList_increment, METH_NOARGS,
     PyDoc_STR("increment state counter")},
    {NULL},
};

static int
SubList_init(SubListObject *self, PyObject *args, PyObject *kwds)
{
    if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)
        return -1;
    self->state = 0;
    return 0;
}

static PyTypeObject SubListType = {
    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 = (initproc) SubList_init,
    .tp_methods = SubList_methods,
};

static PyModuleDef sublistmodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "sublist",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
};

PyMODINIT_FUNC
PyInit_sublist(void)
{
    PyObject *m;
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0)
        return NULL;

    m = PyModule_Create(&sublistmodule);
    if (m == NULL)
        return NULL;

    Py_INCREF(&SubListType);
    if (PyModule_AddObject(m, "SubList", (PyObject *) &SubListType) < 0) {
        Py_DECREF(&SubListType);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

如你所见，此源代码与之前小节中的 Custom 示例非常相似。 我们将逐一讲解它们之间的主要区别。

typedef struct {
    PyListObject list;
    int state;
} SubListObject;

派生类型对象的主要差异在于基类型的对象结构体必须是第一个值。 基类型将已经在其结构体的开头包括了 PyObject_HEAD()。

当一个 Python 对象是 SubList 的实例时，它的 PyObject * 指针可以被安全地强制转换为 PyListObject * 和 SubListObject *:

static int
SubList_init(SubListObject *self, PyObject *args, PyObject *kwds)
{
    if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)
        return -1;
    self->state = 0;
    return 0;
}

我们可以在上面看到如何调用至基类型的 __init__ 方法。

这个模式在编写具有自定义 tp_new 和 tp_dealloc 成员的类型时很重要。 tp_new 处理器不应为具有 tp_alloc 的对象实际分配内存，而是让基类通过调用自己的 tp_new 来处理它。

PyTypeObject 支持用 tp_base 指定类型的实体基类。 由于跨平台编译器问题，你无法使用对 PyList_Type 的引用来直接填充该字段；它应当随后在模块初始化函数中完成:

PyMODINIT_FUNC
PyInit_sublist(void)
{
    PyObject* m;
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0)
        return NULL;

    m = PyModule_Create(&sublistmodule);
    if (m == NULL)
        return NULL;

    Py_INCREF(&SubListType);
    if (PyModule_AddObject(m, "SubList", (PyObject *) &SubListType) < 0) {
        Py_DECREF(&SubListType);
        Py_DECREF(m);
        return NULL;
    }

    return m;
}

在调用 PyType_Ready() 之前，类型结构体必须已经填充 tp_base 槽位。 当我们从现有类型派生时，它不需要将 tp_alloc 槽位填充为 PyType_GenericNew() -- 来自基类型的分配函数将会被继承。

在那之后，调用 PyType_Ready() 并向模块添加类型对象是与基本的 Custom 示例一样的。

备注

1

当我们知道该对象属于基本类型，如字符串或浮点数时情况就是如此。

2

在本示例中我们需要 tp_dealloc 处理器中的这一机制，因为我们的类型不支持垃圾回收。

3

现在我们知道 first 和 last 成员都是字符串，因此也许我们可以对减少它们的引用计数不必太过小心，但是，我们还接受字符串子类的实例。 即使释放普通字符串不会对我们的对象执行回调，我们也不能保证释放一个字符串子类的实例不会对我们的对象执行回调。

4

而且，即使是将我们的属性限制为字符串实例，用户还是可以传入任意 str 子类因而仍能造成引用循环。

3. 定义扩展类型：已分类主题

本章节目标是提供一个各种你可以实现的类型方法及其功能的简短介绍。

这是 C 类型 PyTypeObject 的定义，省略了只用于 调试构建 的字段：

typedef struct _typeobject {
    PyObject_VAR_HEAD
    const char *tp_name; /* For printing, in format "<module>.<name>" */
    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

    /* Methods to implement standard operations */

    destructor tp_dealloc;
    Py_ssize_t tp_vectorcall_offset;
    getattrfunc tp_getattr;
    setattrfunc tp_setattr;
    PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
                                    or tp_reserved (Python 3) */
    reprfunc tp_repr;

    /* Method suites for standard classes */

    PyNumberMethods *tp_as_number;
    PySequenceMethods *tp_as_sequence;
    PyMappingMethods *tp_as_mapping;

    /* More standard operations (here for binary compatibility) */

    hashfunc tp_hash;
    ternaryfunc tp_call;
    reprfunc tp_str;
    getattrofunc tp_getattro;
    setattrofunc tp_setattro;

    /* Functions to access object as input/output buffer */
    PyBufferProcs *tp_as_buffer;

    /* Flags to define presence of optional/expanded features */
    unsigned long tp_flags;

    const char *tp_doc; /* Documentation string */

    /* Assigned meaning in release 2.0 */
    /* call function for all accessible objects */
    traverseproc tp_traverse;

    /* delete references to contained objects */
    inquiry tp_clear;

    /* Assigned meaning in release 2.1 */
    /* rich comparisons */
    richcmpfunc tp_richcompare;

    /* weak reference enabler */
    Py_ssize_t tp_weaklistoffset;

    /* Iterators */
    getiterfunc tp_iter;
    iternextfunc tp_iternext;

    /* Attribute descriptor and subclassing stuff */
    struct PyMethodDef *tp_methods;
    struct PyMemberDef *tp_members;
    struct PyGetSetDef *tp_getset;
    // Strong reference on a heap type, borrowed reference on a static type
    struct _typeobject *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; /* Low-level free-memory routine */
    inquiry tp_is_gc; /* For PyObject_IS_GC */
    PyObject *tp_bases;
    PyObject *tp_mro; /* method resolution order */
    PyObject *tp_cache;
    PyObject *tp_subclasses;
    PyObject *tp_weaklist;
    destructor tp_del;

    /* Type attribute cache version tag. Added in version 2.6 */
    unsigned int tp_version_tag;

    destructor tp_finalize;
    vectorcallfunc tp_vectorcall;
} PyTypeObject;

这里有 很多 方法。但是不要太担心，如果你要定义一个类型，通常只需要实现少量的方法。

正如你猜到的一样，我们正要一步一步详细介绍各种处理程序。因为有大量的历史包袱影响字段的排序，所以我们不会根据它们在结构体里定义的顺序讲解。通常非常容易找到一个包含你需要的字段的例子，然后改变值去适应你新的类型。

const char *tp_name; /* For printing */

类型的名字 - 上一章提到过的，会出现在很多地方，几乎全部都是为了诊断目的。尝试选择一个好名字，对于诊断很有帮助。

Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

这些字段告诉运行时在创造这个类型的新对象时需要分配多少内存。Python为了可变长度的结构（想下：字符串，元组）有些内置支持，这是 tp_itemsize 字段存在的原由。这部分稍后解释。

const char *tp_doc;

这里你可以放置一段字符串（或者它的地址），当你想在Python脚本引用 obj.__doc__ 时返回这段文档字符串。

现在我们来看一下基本类型方法 - 大多数扩展类型将实现的方法。

3.1. 终结和内存释放

destructor tp_dealloc;

当您的类型实例的引用计数减少为零并且Python解释器想要回收它时，将调用此函数。如果你的类型有内存可供释放或执行其他清理，你可以把它放在这里。 对象本身也需要在这里释放。 以下是此函数的示例：

static void
newdatatype_dealloc(newdatatypeobject *obj)
{
    free(obj->obj_UnderlyingDatatypePtr);
    Py_TYPE(obj)->tp_free((PyObject *)obj);
}

如果你的类型支持垃圾回收，则析构器应当在清理任何成员字段之前调用 PyObject_GC_UnTrack():

static void
newdatatype_dealloc(newdatatypeobject *obj)
{
    PyObject_GC_UnTrack(obj);
    Py_CLEAR(obj->other_obj);
    ...
    Py_TYPE(obj)->tp_free((PyObject *)obj);
}

一个重要的释放器函数实现要求是把所有未决异常放着不动。这很重要是因为释放器会被解释器频繁的调用，当栈异常退出时(而非正常返回)，不会有任何办法保护释放器看到一个异常尚未被设置。此事释放器的任何行为都会导致额外增加的Python代码来检查异常是否被设置。这可能导致解释器的误导性错误。正确的保护方法是，在任何不安全的操作前，保存未决异常，然后在其完成后恢复。者可以通过 PyErr_Fetch() 和 PyErr_Restore() 函数来实现:

static void
my_dealloc(PyObject *obj)
{
    MyObject *self = (MyObject *) obj;
    PyObject *cbresult;

    if (self->my_callback != NULL) {
        PyObject *err_type, *err_value, *err_traceback;

        /* This saves the current exception state */
        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);

        /* This restores the saved exception state */
        PyErr_Restore(err_type, err_value, err_traceback);

        Py_DECREF(self->my_callback);
    }
    Py_TYPE(obj)->tp_free((PyObject*)self);
}

注解

你能在释放器函数中安全执行的操作是有限的。 首先，如果你的类型支持垃圾回收 (使用 tp_traverse 和/或 tp_clear)，对象的部分成员可以在调用 tp_dealloc 时被清空或终结。 其次，在 tp_dealloc 中，你的对象将处于不稳定状态：它的引用计数等于零。 任何对非琐碎对象或 API 的调用 (如上面的示例所做的) 最终都可能会再次调用 tp_dealloc，导致双重释放并发生崩溃。

从 Python 3.4 开始，推荐不要在 tp_dealloc 放复杂的终结代码，而是使用新的 tp_finalize 类型方法。

参见

PEP 442 [https://www.python.org/dev/peps/pep-0442] 解释了新的终结方案。

3.2. 对象展示

在 Python 中，有两种方式可以生成对象的文本表示: repr() 函数和 str() 函数。 (print() 函数会直接调用 str()。) 这些处理程序都是可选的。

reprfunc tp_repr;
reprfunc tp_str;

tp_repr 处理程序应该返回一个字符串对象，其中包含调用它的实例的表示形式。 下面是一个简单的例子:

static PyObject *
newdatatype_repr(newdatatypeobject * obj)
{
    return PyUnicode_FromFormat("Repr-ified_newdatatype{{size:%d}}",
                                obj->obj_UnderlyingDatatypePtr->size);
}

如果没有指定 tp_repr 处理器，解释器将提供一个使用类型的 tp_name 的表示形式以及对象的唯一标识值。

tp_str 处理器对于 str() 就如上述的 tp_repr 处理器对于 repr() 一样；也就是说，它会在当 Python 代码在你的对象的某个实例上调用 str() 时被调用。 它的实现与 tp_repr 函数非常相似，但其结果字符串是供人类查看的。 如果未指定 tp_str，则会使用 tp_repr 处理器来代替。

下面是一个简单的例子:

static PyObject *
newdatatype_str(newdatatypeobject * obj)
{
    return PyUnicode_FromFormat("Stringified_newdatatype{{size:%d}}",
                                obj->obj_UnderlyingDatatypePtr->size);
}

3.3. 属性管理

对于每个可支持属性操作的对象，相应的类型必须提供用于控制属性获取方式的函数。 需要有一个能够检索属性的函数（如果定义了任何属性）还要有另一个函数负责设置属性（如果允许设置属性）。 移除属性是一种特殊情况，在此情况下要传给处理器的新值为 NULL。

Python 支持两对属性处理器；一个支持属性操作的类型只需要实现其中一对的函数。 两者的差别在于一对接受 char* 作为属性名称，而另一对则接受 PyObject*。 每种类型都可以选择使用对于实现的便利性来说更有意义的那一对。

getattrfunc  tp_getattr;        /* char * version */
setattrfunc  tp_setattr;
/* ... */
getattrofunc tp_getattro;       /* PyObject * version */
setattrofunc tp_setattro;

如果访问一个对象的属性总是为简单操作（这将在下文进行解释），则有一些泛用实现可被用来提供 PyObject* 版本的属性管理函数。 从 Python 2.2 开始对于类型专属的属性处理器的实际需要几乎已完全消失，尽管还存在着许多尚未理新为使用某种新的可选泛用机制的例子。

3.3.1. 泛型属性管理

大多数扩展类型只使用 简单 属性，那么，是什么让属性变得“简单”呢？只需要满足下面几个条件：

当调用 PyType_Ready() 时，必须知道属性的名称。

不需要特殊的处理来记录属性是否被查找或设置，也不需要根据值采取操作。

请注意，此列表不对属性的值、值的计算时间或相关数据的存储方式施加任何限制。

当 PyType_Ready() 被调用时，它会使用由类型对象所引用的三个表来创建要放置到类型对象的字典中的 descriptor。 每个描述器控制对实例对象的一个属性的访问。 每个表都是可选的；如果三个表全都为 NULL，则该类型的实例将只有从它们的基础类型继承来的属性，并且还应当让 tp_getattro 和 tp_setattro 字段保持为 NULL，以允许由基础类型处理这些属性。

表被声明为object::类型的三个字段:

struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;

如果 tp_methods 不为 NULL，则它必须指向一个由 PyMethodDef 结构体组成的数组。 表中的每个条目都是该结构体的一个实例:

typedef struct PyMethodDef {
    const char  *ml_name;       /* method name */
    PyCFunction  ml_meth;       /* implementation function */
    int          ml_flags;      /* flags */
    const char  *ml_doc;        /* docstring */
} PyMethodDef;

应当为该类型所提供的每个方法都定义一个条目；从基础类型继承来的方法不需要条目。 还需要在末尾加一个额外的条目；它是一个标记数组结束的哨兵条目。 该哨兵条目的 ml_name 字段必须为 NULL。

第二个表被用来定义要直接映射到实例中的数据的属性。 各种原始 C 类型均受到支持，并且访问方式可以为只读或读写。 表中的结构体被定义为:

typedef struct PyMemberDef {
    const char *name;
    int         type;
    int         offset;
    int         flags;
    const char *doc;
} PyMemberDef;

对于表中的每个条目，将构建一个 descriptor 并添加到类型中使其能够从实例结构体中提取值。 type 字段应当包含在 structmember.h 头文件中定义的某个类型的代码；该值将被用来确定如何将 Python 值转换为 C 值或者反之。 flags 字段将被用来储存控制属性可以如何被访问的旗标。

以下标志常量定义在:file: ' structmember.h ';它们可以使用bitwise-OR组合。

常量 | 含意
READONLY | 没有可写的
PY_AUDIT_READ | 在读取之前发送一个 object.__getattr__ 审计事件。

在 3.10 版更改: RESTRICTED, READ_RESTRICTED 和 WRITE_RESTRICTED 已被弃用。 但是，READ_RESTRICTED 是 PY_AUDIT_READ 的一个别名，因此指定了 RESTRICTED 或 READ_RESTRICTED 的字段也会引发审计事件。

使用 tp_members 表来构建用于运行时的描述器还有一个有趣的优点是任何以这种方式定义的属性都可以简单地通过在表中提供文本来设置一个相关联的文档字符串。 一个应用程序可以使用自省 API 从类对象获取描述器，并使用其 __doc__ 属性来获取文档字符串。

与 tp_methods 表一样，需要有一个值为 NULL 的哨兵条目 name。

3.3.2. 类型专属的属性管理

为了简单起见，这里只演示 char* 版本； name 形参的类型是 char* 和 PyObject* 风格接口之间的唯一区别。 这个示例实际上做了与上面的泛用示例相同的事情，但没有使用在 Python 2.2 中增加的泛用支持。 它解释了处理器函数是如何被调用的，因此如果你确实需要扩展它们的功能，你就会明白有什么是需要做的。

tp_getattr 处理器会在对象需要查找属性时被调用。 它被调用的情况与一个类的 __getattr__() 方法要被调用的情况相同。

例如：

static PyObject *
newdatatype_getattr(newdatatypeobject *obj, char *name)
{
    if (strcmp(name, "data") == 0)
    {
        return PyLong_FromLong(obj->data);
    }

    PyErr_Format(PyExc_AttributeError,
                 "'%.50s' object has no attribute '%.400s'",
                 tp->tp_name, name);
    return NULL;
}

tp_setattr 处理器会在要调用一个类实例的 __setattr__() 或 __delattr__() 方法时被调用。 当一个属性应当被删除时，第三个形参将为 NULL。 下面是一个简单地引发异常的例子；如果这确实是你想要的，则 tp_setattr 处理器应当被设为 NULL。

static int
newdatatype_setattr(newdatatypeobject *obj, char *name, PyObject *v)
{
    PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name);
    return -1;
}

3.4. 对象比较

richcmpfunc tp_richcompare;

tp_richcompare 处理器会在需要进行比较时被调用。 它类似于 富比较方法，例如 __lt__()，并会被 PyObject_RichCompare() 和 PyObject_RichCompareBool() 所调用。

此函数被调用时将传入两个 Python 对象和运算符作为参数，其中运算符为 Py_EQ, Py_NE, Py_LE, Py_GE, Py_LT 或 Py_GT 之一。 它应当使用指定的运算符来比较两个对象并在比较操作成功时返回 Py_True 或 Py_False，如果比较操作未被实现并应尝试其他对象比较方法时则返回 Py_NotImplemented，或者如果设置了异常则返回 NULL。

下面是一个示例实现，该数据类型如果内部指针的大小相等就认为是相等的:

static PyObject *
newdatatype_richcmp(PyObject *obj1, PyObject *obj2, int op)
{
    PyObject *result;
    int c, size1, size2;

    /* code to make sure that both arguments are of type
       newdatatype omitted */

    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;
    Py_INCREF(result);
    return result;
 }

3.5. 抽象协议支持

Python 支持多种 抽象 '协议'；被提供来使用这些接口的专门接口说明请在 抽象对象层 中查看。

这些抽象接口很多都是在 Python 实现开发的早期被定义的。 特别地，数字、映射和序列协议从一开始就已经是 Python 的组成部分。 其他协议则是后来添加的。 对于依赖某些来自类型实现的处理器例程的协议来说，较旧的协议被定义为类型对象所引用的处理器的可选块。 对于较新的协议来说在主类型对象中还有额外的槽位，并带有一个预设旗标位来指明存在该槽位并应当由解释器来检查。 （此旗标位并不会指明槽位值非 NULL 的情况，可以设置该旗标来指明一个槽位的存在，但此本位仍可能保持未填充的状态。）

PyNumberMethods   *tp_as_number;
PySequenceMethods *tp_as_sequence;
PyMappingMethods  *tp_as_mapping;

如果你希望你的对象的行为类似一个数字、序列或映射对象，那么你就要分别放置一个实现了 C 类型 PyNumberMethods, PySequenceMethods 或 PyMappingMethods, 的结构体的地址。 你要负责将适当的值填入这些结构体。 你可以在 Python 源代码发布版的 Objects 目录中找到这些对象各自的用法示例。

hashfunc tp_hash;

如果你选择提供此函数，则它应当为你的数据类型的实例返回一个哈希数值。 下面是一个简单的示例:

static Py_hash_t
newdatatype_hash(newdatatypeobject *obj)
{
    Py_hash_t result;
    result = obj->some_size + 32767 * obj->some_number;
    if (result == -1)
       result = -2;
    return result;
}

Py_hash_t 是一个在宽度取决于具体平台的有符号整数类型。 从 tp_hash 返回 -1 表示发生了错误，这就是为什么你应当注意避免在哈希运算成功时返回它，如上面所演示的。

ternaryfunc tp_call;

此函数会在“调用”你的数据类型实例时被调用，举例来说，如果 obj1 是你的数据类型的实例而 Python 脚本包含了 obj1('hello')，则将唤起 tp_call 处理器。

此函数接受三个参数:

self 是作为调用目标的数据类型实例。 如果调用是 obj1('hello')，则 self 为 obj1。

args 是包含调用参数的元组。 你可以使用 PyArg_ParseTuple() 来提取参数。

kwds 是由传入的关键字参数组成的字典。 如果它不为 NULL 且你支持关键字参数，则可使用 PyArg_ParseTupleAndKeywords() 来提取参数。 如果你不想支持关键字参数而它为非 NULL 值，则会引发 TypeError 并附带一个提示不支持关键字参数的消息。

下面是一个演示性的 tp_call 实现:

static PyObject *
newdatatype_call(newdatatypeobject *self, PyObject *args, PyObject *kwds)
{
    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",
        obj->obj_UnderlyingDatatypePtr->size,
        arg1, arg2, arg3);
    return result;
}

/* Iterators */
getiterfunc tp_iter;
iternextfunc tp_iternext;

这些函数提供了对迭代器协议的支持。 两个处理器都只接受一个形参，即它们被调用时所使用的实例，并返回一个新的引用。 当发生错误时，它们应当设置一个异常并返回 NULL。 tp_iter 对应于 Python __iter__() 方法，而 tp_iternext 对应于 Python __next__() 方法。

任何 iterable 对象都必须实现 tp_iter 处理器，该处理器必须返回一个 iterator 对象。 下面是与 Python 类所应用的同一个指导原则:

对于可以支持多个独立迭代器的多项集（如列表和元组），则应当在每次调用 tp_iter 时创建并返回一个新的迭代器。

只能被迭代一次的对象（通常是由于迭代操作的附带影响，例如文件对象）可以通过返回一个指向自身的新引用来实现 tp_iter -- 并且为此还应当实现 tp_iternext 处理器。

任何 iterator 对象都应当同时实现 tp_iter 和 tp_iternext。 一个迭代器的 tp_iter 处理器应当返回一个指向该迭代器的新引用。 它的 tp_iternext 处理器应当返回一个指向迭代操作的下一个对象的新引用，如果还有下一个对象的话。 如果迭代已到达末尾，则 tp_iternext 可以返回 NULL 而不设置异常，或者也可以在返回 NULL 的基础上 额外 设置 StopIteration；避免异常可以产生更好的性能。 如果发生了实际的错误，则 tp_iternext 应当总是设置一个异常并返回 NULL。

3.6. 弱引用支持

One of the goals of Python 弱引用实现的目标之一是允许任意类型参与弱引用机制而不会在重视性能的对象（例如数字）上产生额外开销。

参见

weakref 模块的文档。

对于可弱引用的对象，扩展类型必须做两件事:

在 C 对象结构体中包括一个专门用于弱引用机制的 PyObject* 字段。 该对象的构造器应当让它保持为 NULL (当使用默认的 tp_alloc 时这将会自动设置)。

将 tp_weaklistoffset 类型成员设置为 C 对象结构体中上述字段的偏移量，这样解释器就能知道如何访问和修改该字段。

具体来说，下面是一个微小的对象结构体如何被增强为具有所需的字段:

typedef struct {
    PyObject_HEAD
    PyObject *weakreflist;  /* List of weak references */
} TrivialObject;

以及在静态声明的类型对象中的相应成员:

static PyTypeObject TrivialType = {
    PyVarObject_HEAD_INIT(NULL, 0)
    /* ... other members omitted for brevity ... */
    .tp_weaklistoffset = offsetof(TrivialObject, weakreflist),
};

唯一的额外补充是如果字段不为 NULL 则 tp_dealloc 需要清除任何弱引用 (通过调用 PyObject_ClearWeakRefs())。:

static void
Trivial_dealloc(TrivialObject *self)
{
    /* Clear weakrefs first before calling any destructors */
    if (self->weakreflist != NULL)
        PyObject_ClearWeakRefs((PyObject *) self);
    /* ... remainder of destruction code omitted for brevity ... */
    Py_TYPE(self)->tp_free((PyObject *) self);
}

3.7. 更多建议

为了学习如何为你的新数据类型实现任何特定方法，请获取 CPython 源代码。 进入 Objects 目录，然后在 C 源文件中搜索 tp_ 加上你想要的函数 (例如，tp_richcompare)。 你将找到你想要实现的函数的例子。

当你需要验证一个对象是否为你实现的类型的具体实例时，请使用 PyObject_TypeCheck() 函数。 它的一个用法示例如下:

if (!PyObject_TypeCheck(some_object, &MyType)) {
    PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");
    return NULL;
}

参见

下载CPython源代码版本。

https://www.python.org/downloads/source/

GitHub上开发CPython源代码的CPython项目。

https://github.com/python/cpython

4. 构建C/C++扩展

一个CPython的C扩展是一个共享库(例如一个Linux上的 .so ，或者Windows上的 .pyd )，其会导出一个 初始化函数 。

为了可导入，共享库必须在 PYTHONPATH 中有效，且必须命名遵循模块名字，通过适当的扩展。当使用distutils时，会自动生成正确的文件名。

初始化函数的声明如下：

PyObject *PyInit_modulename(void)

该函数返回完整初始化过的模块，或一个 PyModuleDef 实例。 请查看 初始化 C 模块 了解详情。

对于仅有ASCII编码的模块名，函数必须是 PyInit_<modulename> ，将 <modulename> 替换为模块的名字。当使用 多阶段初始化 时，允许使用非ASCII编码的模块名。此时初始化函数的名字是 PyInitU_<modulename> ，而 <modulename> 需要用Python的 punycode 编码，连字号需替换为下划线。在Python里:

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

可以在一个动态库里导出多个模块，通过定义多个初始化函数。而导入他们需要符号链接或自定义导入器，因为缺省时只有对应了文件名的函数才会被发现。查看 "一个库里的多模块" 章节，在 PEP 489 [https://www.python.org/dev/peps/pep-0489] 了解更多细节。

4.1. 使用distutils构建C和C++扩展

扩展模块可以用distutils来构建，这是Python自带的。distutils也支持创建二进制包，用户无需编译器而distutils就能安装扩展。

一个distutils包包含了一个驱动脚本 setup.py 。这是个纯Python文件，大多数时候也很简单，看起来如下：

from distutils.core import setup, Extension

module1 = Extension('demo',
                    sources = ['demo.c'])

setup (name = 'PackageName',
       version = '1.0',
       description = 'This is a demo package',
       ext_modules = [module1])

通过文件 setup.py ，和文件 demo.c ，运行如下

python setup.py build

这会编译 demo.c ，然后产生一个扩展模块叫做 demo 在目录 build 里。依赖于系统，模块文件会放在某个子目录形如 build/lib.system ，名字可能是 demo.so 或 demo.pyd 。

在文件 setup.py 里，所有动作的入口通过 setup 函数。该函数可以接受可变数量个关键字参数，上面的例子只使用了一个子集。特别需要注意的例子指定了构建包的元信息，以及指定了包内容。通常一个包会包括多个模块，就像Python的源码模块、文档、子包等。请参数distutils的文档，在 分发 Python 模块（遗留版本） 来了解更多distutils的特性；本章节只解释构建扩展模块的部分。

通常预计算参数给 setup() ，想要更好的结构化驱动脚本。有如如上例子函数 setup() 的 ext_modules 参数是一列扩展模块，每个是一个 Extension 类的实例。例子中的实例定义了扩展命名为 demo ，从单一源码文件构建 demo.c 。

更多时候，构建一个扩展会复杂的多，需要额外的预处理器定义和库。如下例子展示了这些。

from distutils.core import setup, Extension

module1 = Extension('demo',
                    define_macros = [('MAJOR_VERSION', '1'),
                                     ('MINOR_VERSION', '0')],
                    include_dirs = ['/usr/local/include'],
                    libraries = ['tcl83'],
                    library_dirs = ['/usr/local/lib'],
                    sources = ['demo.c'])

setup (name = 'PackageName',
       version = '1.0',
       description = 'This is a demo package',
       author = 'Martin v. Loewis',
       author_email = 'martin@v.loewis.de',
       url = 'https://docs.python.org/extending/building',
       long_description = '''
This is really just a demo package.
''',
       ext_modules = [module1])

例子中函数 setup() 在调用时额外传递了元信息，是推荐发布包构建时的内容。对于这个扩展，其指定了预处理器定义，include目录，库目录，库。依赖于编译器，distutils还会用其他方式传递信息给编译器。例如在Unix上，结果是如下编译命令

gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o

gcc -shared build/temp.linux-i686-2.2/demo.o -L/usr/local/lib -ltcl83 -o build/lib.linux-i686-2.2/demo.so

这些行代码仅用于展示目的；distutils用户应该相信distutils能正确调用。

4.2. 发布你的扩展模块

当一个扩展已经成功地被构建时，有三种方式来使用它。

最终用户通常想要安装模块，可以这么运行

python setup.py install

模块维护者应该制作源码包；要实现可以运行

python setup.py sdist

有些情况下，需要在源码发布包里包含额外的文件；这通过 MANIFEST.in 文件实现，查看 指定要分发的文件 了解细节。

如果源码发行包被成功地构建，维护者还可以创建二进制发行包。 取决于具体平台，以下命令中的一个可以用来完成此任务

python setup.py bdist_rpm
python setup.py bdist_dumb

5. 在 Windows 上构建 C 和 C++ 扩展

这一章简要介绍了如何使用 Microsoft Visual C++ 创建 Python 的 Windows 扩展模块，然后再提供有关其工作机理的详细背景信息。 这些说明材料同时适用于 Windows 程序员学习构建 Python 扩展以及 Unix 程序员学习如何生成在 Unix 和 Windows 上均能成功构建的软件。

鼓励模块作者使用 distutils 方式来构建扩展模块，而不使用本节所描述的方式。 你仍将需要使用 C 编译器来构建 Python；通常为 Microsoft Visual C++。

注解

这一章提及了多个包括已编码 Python 版本号的文件名。 这些文件名以显示为 XY 的版本号来代表；在实践中，'X' 将为你所使用的 Python 发布版的主版本号而 'Y' 将为次版本号。 例如，如果你所使用的是 Python 2.2.1，XY 将为 22。

5.1. 菜谱式说明

在 Windows 和 Unix 上构建扩展模块都有两种方式：使用 distutils 包来控制构建过程，或者全手动操作。 distutils 方式适用于大多数扩展；使用 distutils 构建和打包扩展模块的文档见 分发 Python 模块（遗留版本）。 如果你发现你确实需要手动操作，那么研究一下 winsound [https://github.com/python/cpython/tree/3.10/PCbuild/winsound.vcxproj] 标准库模块的项目文件可能会很有帮助。

5.2. Unix 和 Windows 之间的差异

Unix 和 Windows 对于代码的运行时加载使用了完全不同的范式。 在你尝试构建可动态加载的模块之前，要先了解你所用系统是如何工作的。

在 Unix 中，一个共享对象 (.so) 文件中包含将由程序来使用的代码，也包含在程序中可被找到的函数名称和数据。 当文件被合并到程序中时，对在文件代码中这些函数和数据的全部引用都会被改为指向程序中函数和数据在内存中所放置的实际位置。 这基本上是一个链接操作。

在 Windows 中，一个动态链接库 (.dll) 文件中没有悬挂的引用。 而是通过一个查找表执行对函数或数据的访问。 因此在运行时 DLL 代码不必在运行时进行修改；相反地，代码已经使用了 DLL 的查找表，并且在运行时查找表会被修改以指向特定的函数和数据。

在 Unix 中，只存在一种库文件 (.a)，它包含来自多个对象文件 (.o) 的代码。 在创建共享对象文件 (.so) 的链接阶段，链接器可能会发现它不知道某个标识符是在哪里定义的。 链接器将在各个库的对象文件中查找它；如果找到了它，链接器将会包括来自该对象文件的所有代码。

在 Windows 中，存在两种库类型，静态库和导入库 (扩展名都是 .lib)。 静态库类似于 Unix 的 .a 文件；它包含在必要时可被包括的代码。 导入库基本上仅用于让链接器能确保特定标识符是合法的，并且将在 DLL 被加载时出现于程序中。 这样链接器可使用来自导入库的信息构建查找表以便使用未包括在 DLL 中的标识符。 当一个应用程序或 DLL 被链接时，可能会生成一个导入库，它将需要被用于应用程序或 DLL 中未来所有依赖于这些符号的 DLL。

假设你正在编译两个动态加载模块 B 和 C，它们应当共享另一个代码块 A。 在 Unix 上，你 不应 将 A.a 传给链接器作为 B.so 和 C.so；那会导致它被包括两次，这样 B 和 C 将分别拥有它们自己的副本。 在 Windows 上，编译 A.dll 将同时编译 A.lib。 你 应当 将 A.lib 传给链接器用于 B 和 C。 A.lib 并不包含代码；它只包含将在运行时被用于访问 A 的代码的信息。

在 Windows 上，使用导入库有点像是使用 import spam；它让你可以访问 spam 中的名称，但并不会创建一个单独副本。 在 Unix 上，链接到一个库更像是 from spam import *；它会创建一个单独副本。

5.3. DLL 的实际使用

Windows Python 是在 Microsoft Visual C++ 中构建的；使用其他编译器可能会也可能不会工作。本节的其余部分是针对 MSVC++ 的。

当在 Windows 中创建 DLL 时，你必须将 pythonXY.lib 传给链接器。 要编译两个 DLL，spam 和 ni (会使用 spam 中找到的 C 函数)，你应当使用以下命令:

cl /LD /I/python/include spam.c ../libs/pythonXY.lib
cl /LD /I/python/include ni.c spam.lib ../libs/pythonXY.lib

第一条命令创建了三个文件: spam.obj, spam.dll 和 spam.lib。 Spam.dll 不包含任何 Python 函数 (例如 PyArg_ParseTuple())，但它通过 pythonXY.lib 可以知道如何找到所需的 Python 代码。

第二条命令创建了 ni.dll (以及 .obj 和 .lib)，它知道如何从 spam 以及 Python 可执行文件中找到所需的函数。

不是每个标识符都会被导出到查找表。 如果你想要任何其他模块（包括 Python）都能看到你的标识符，你必须写上 _declspec(dllexport)，就如在 void _declspec(dllexport) initspam(void) 或 PyObject _declspec(dllexport) *NiGetSpamData(void) 中一样。

Developer Studio 将加入大量你并不真正需要的导入库，使你的可执行文件大小增加 100K。 要摆脱它们，请使用项目设置对话框的链接选项卡指定 忽略默认库。 将正确的 msvcrtxx.lib 添加到库列表中。

1. 在其它应用程序嵌入 Python

前几章讨论了如何对 Python 进行扩展，也就是如何用 C 函数库 扩展 Python 的功能。反过来也是可以的：将 Python 嵌入到 C/C++ 应用程序中丰富其功能。这种嵌入可以让应用程序用 Python 来实现某些功能，而不是用 C 或 C++ 。用途会有很多；比如允许用户用 Python 编写一些脚本，以便定制应用程序满足需求。如果某些功能用 Python 编写起来更为容易，那么开发人员自己也能这么干。

Python 的嵌入类似于扩展，但不完全相同。不同之处在于，扩展 Python 时应用程序的主程序仍然是 Python 解释器，而嵌入 Python 时的主程序可能与 Python 完全无关——而是应用程序的某些部分偶尔会调用 Python 解释器来运行一些 Python 代码。

因此，若要嵌入 Python，就要提供自己的主程序。此主程序要做的事情之一就是初始化 Python 解释器。至少得调用函数 Py_Initialize()。还有些可选的调用可向 Python 传递命令行参数。之后即可从应用程序的任何地方调用解释器了。

调用解释器的方式有好几种：可向 PyRun_SimpleString() 传入一个包含 Python 语句的字符串，也可向 PyRun_SimpleFile() 传入一个 stdio 文件指针和一个文件名（仅在错误信息中起到识别作用）。还可以调用前面介绍过的底层操作来构造并使用 Python 对象。

参见

Python/C API 参考手册

本文详细介绍了 Python 的 C 接口。这里有大量必要的信息。

1.1. 高层次的嵌入

最简单的 Python 嵌入形式就是采用非常高层的接口。该接口的目标是只执行一段 Python 脚本，而无需与应用程序直接交互。比如以下代码可以用来对某个文件进行一些操作。

#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
{
    wchar_t *program = Py_DecodeLocale(argv[0], NULL);
    if (program == NULL) {
        fprintf(stderr, "Fatal error: cannot decode argv[0]\n");
        exit(1);
    }
    Py_SetProgramName(program);  /* optional but recommended */
    Py_Initialize();
    PyRun_SimpleString("from time import time,ctime\n"
                       "print('Today is', ctime(time()))\n");
    if (Py_FinalizeEx() < 0) {
        exit(120);
    }
    PyMem_RawFree(program);
    return 0;
}

在 Py_Initialize() 之前，应该先调用 Py_SetProgramName() 函数，以便向解释器告知 Python运行库的路径。接下来，Py_Initialize() 会初始化 Python 解释器，然后执行硬编码的 Python 脚本，打印出日期和时间。之后，调用 Py_FinalizeEx() 关闭解释器，程序结束。在真实的程序中，可能需要从其他来源获取 Python 脚本，或许是从文本编辑器例程、文件，或者某个数据库。利用 PyRun_SimpleFile() 函数可以更好地从文件中获取 Python 代码，可省去分配内存空间和加载文件内容的麻烦。

1.2. 突破高层次嵌入的限制：概述

高级接口能从应用程序中执行任何 Python 代码，但至少交换数据可说是相当麻烦的。如若需要交换数据，应使用较低级别的调用。几乎可以实现任何功能，代价是得写更多的 C 代码。

应该注意，尽管意图不同，但扩展 Python 和嵌入 Python 的过程相当类似。前几章中讨论的大多数主题依然有效。为了说明这一点，不妨来看一下从 Python 到 C 的扩展代码到底做了什么：

将 Python 的数据转换为 C 格式，

用转换后的数据执行 C 程序的函数调用，

将调用返回的数据从 C 转换为 Python 格式。

嵌入 Python 时，接口代码会这样做：

将 C 数据转换为 Python 格式，

用转换后的数据执行对 Python 接口的函数调用，

将调用返回的数据从 Python 转换为 C 格式。

可见只是数据转换的步骤交换了一下顺序，以顺应跨语言的传输方向。唯一的区别是在两次数据转换之间调用的函数不同。在执行扩展时，调用一个 C 函数，而执行嵌入时调用的是个 Python 函数。

本文不会讨论如何将数据从 Python 转换到 C 去，反之亦然。另外还假定读者能够正确使用引用并处理错误。由于这些地方与解释器的扩展没有区别，请参考前面的章节以获得所需的信息。

1.3. 只做嵌入

第一个程序的目标是执行 Python 脚本中的某个函数。就像高层次接口那样，Python 解释器并不会直接与应用程序进行交互（但下一节将改变这一点）。

要运行 Python 脚本中定义的函数，代码如下：

#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]);
    /* Error checking of pName left out */

    pModule = PyImport_Import(pName);
    Py_DECREF(pName);

    if (pModule != NULL) {
        pFunc = PyObject_GetAttrString(pModule, argv[2]);
        /* pFunc is a new reference */

        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 reference stolen here: */
                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;
}

上述代码先利用 argv[1] 加载 Python 脚本，再调用 argv[2] 指定的函数。函数的整数参数是 argv 数组中的其余值。如果 编译并链接 该程序（此处将最终的可执行程序称作 call）, 并用它执行一个 Python 脚本，例如：

def multiply(a,b):
    print("Will compute", a, "times", b)
    c = 0
    for i in range(0, a):
        c = c + b
    return c

然后结果应该是：

$ call multiply multiply 3 2
Will compute 3 times 2
Result of call: 6

尽管相对其功能而言，该程序体积相当庞大，但大部分代码是用于 Python 和 C 之间的数据转换，以及报告错误。嵌入 Python 的有趣部分从此开始：

Py_Initialize();
pName = PyUnicode_DecodeFSDefault(argv[1]);
/* Error checking of pName left out */
pModule = PyImport_Import(pName);

初始化解释器之后，则用 PyImport_Import() 加载脚本。此函数的参数需是个 Python 字符串，一个用 PyUnicode_FromString() 数据转换函数构建的字符串。

pFunc = PyObject_GetAttrString(pModule, argv[2]);
/* pFunc is a new reference */

if (pFunc && PyCallable_Check(pFunc)) {
    ...
}
Py_XDECREF(pFunc);

脚本一旦加载完毕，就会用 PyObject_GetAttrString() 查找属性名称。如果名称存在，并且返回的是可调用对象，即可安全地视其为函数。然后程序继续执行，照常构建由参数组成的元组。然后用以下方式调用 Python 函数：

pValue = PyObject_CallObject(pFunc, pArgs);

当函数返回时，pValue 要么为 NULL，要么包含对函数返回值的引用。请确保用完后释放该引用。

1.4. 对嵌入 Python 功能进行扩展

到目前为止，嵌入的 Python 解释器还不能访问应用程序本身的功能。Python API 通过扩展嵌入解释器实现了这一点。 也就是说，用应用程序提供的函数对嵌入的解释器进行扩展。虽然听起来有些复杂，但也没那么糟糕。只要暂时忘记是应用程序启动了 Python 解释器。而把应用程序看作是一堆子程序，然后写一些胶水代码让 Python 访问这些子程序，就像编写普通的 Python 扩展程序一样。 例如：

static int numargs=0;

/* Return the number of arguments of the application command line */
static PyObject*
emb_numargs(PyObject *self, PyObject *args)
{
    if(!PyArg_ParseTuple(args, ":numargs"))
        return NULL;
    return PyLong_FromLong(numargs);
}

static PyMethodDef EmbMethods[] = {
    {"numargs", emb_numargs, METH_VARARGS,
     "Return the number of arguments received by the process."},
    {NULL, NULL, 0, NULL}
};

static PyModuleDef EmbModule = {
    PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,
    NULL, NULL, NULL, NULL
};

static PyObject*
PyInit_emb(void)
{
    return PyModule_Create(&EmbModule);
}

在 main() 函数之前插入上述代码。并在调用 Py_Initialize() 之前插入以下两条语句：

numargs = argc;
PyImport_AppendInittab("emb", &PyInit_emb);

这两行代码初始化了 numargs 变量，并让 emb.numargs() 函数能被嵌入的 Python 解释器访问到。有了这些扩展，Python 脚本可以执行类似以下功能：

import emb
print("Number of arguments", emb.numargs())

在真实的应用程序中，这种方法将把应用的 API 暴露给 Python 使用。

1.5. 在 C++ 中嵌入 Python

还可以将 Python 嵌入到 C++ 程序中去；确切地说，实现方式将取决于 C++ 系统的实现细节；一般需用 C++ 编写主程序，并用 C++ 编译器来编译和链接程序。不需要用 C++ 重新编译 Python 本身。

1.6. 在类 Unix 系统中编译和链接

为了将 Python 解释器嵌入应用程序，找到正确的编译参数传给编译器 (和链接器) 并非易事，特别是因为 Python 加载的库模块是以 C 动态扩展（.so 文件）的形式实现的。

为了得到所需的编译器和链接器参数，可执行 pythonX.Y-config 脚本，它是在安装 Python 时生成的（也可能存在 python3-config 脚本）。该脚本有几个参数，其中以下几个参数会直接有用：

pythonX.Y-config --cflags 将给出建议的编译参数。

$ /opt/bin/python3.11-config --cflags
-I/opt/include/python3.11 -I/opt/include/python3.11 -Wsign-compare  -DNDEBUG -g -fwrapv -O3 -Wall

pythonX.Y-config --ldflags --embed 将给出在链接时建议的旗标:

$ /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

注解

为了避免多个 Python 安装版本引发混乱（特别是在系统安装版本和自己编译版本之间），建议用 pythonX.Y-config 指定绝对路径，如上例所述。

如果上述方案不起作用（不能保证对所有 Unix 类平台都生效；欢迎提出 bug 报告），就得阅读系统关于动态链接的文档，并检查 Python 的 Makefile （用 sysconfig.get_makefile_filename() 找到所在位置）和编译参数。这时 sysconfig 模块会是个有用的工具，可用编程方式提取需组合在一起的配置值。比如：

>>> import sysconfig
>>> sysconfig.get_config_var('LIBS')
'-lpthread -ldl  -lutil'
>>> sysconfig.get_config_var('LINKFORSHARED')
'-Xlinker -export-dynamic'

Python/C API 参考手册

本手册描述了希望编写扩展模块并将 Python 解释器嵌入其应用程序中的 C 和 C++ 程序员可用的 API。同时可以参阅 扩展和嵌入 Python 解释器 ，其中描述了扩展编写的一般原则，但没有详细描述 API 函数。

概述

代码标准

包含文件

有用的宏

对象、类型和引用计数

异常

嵌入Python

调试构建

C API 的稳定性

应用程序二进制接口的稳定版

平台的考虑

受限 API 的内容

极高层级 API

引用计数

异常处理

打印和清理

抛出异常

发出警告

查询错误指示器

信号处理

Exception 类

异常对象

Unicode 异常对象

递归控制

标准异常

标准警告类别

工具

操作系统实用工具

系统功能

过程控制

导入模块

数据 marshal 操作支持

解析参数并构建值变量

字符串转换与格式化

反射

编解码器注册与支持功能

抽象对象层

对象协议

调用协议

数字协议

序列协议

映射协议

迭代器协议

缓冲协议

旧缓冲协议

具体的对象层

基本对象

数值对象

序列对象

容器对象

Function 对象

其他对象

初始化，最终化和线程

在Python初始化之前

全局配置变量

初始化和最终化解释器

进程级参数

线程状态和全局解释器锁

子解释器支持

异步通知

分析和跟踪

高级调试器支持

线程本地存储支持

Python初始化配置

示例

PyWideStringList

PyStatus

PyPreConfig

使用 PyPreConfig 预初始化 Python

PyConfig

使用 PyConfig 初始化

隔离配置

Python 配置

Python 路径配置

Py_RunMain()

Py_GetArgcArgv()

多阶段初始化私有暂定 API

内存管理

概述

分配器域

原始内存接口

内存接口

对象分配器

默认内存分配器

自定义内存分配器

Python 内存分配器的调试钩子

pymalloc 分配器

tracemalloc C API

例子

对象实现支持

在堆上分配对象

公用对象结构体

类型对象

数字对象结构体

映射对象结构体

序列对象结构体

缓冲区对象结构体

异步对象结构体

槽位类型 typedef

例子

使对象类型支持循环垃圾回收

API 和 ABI 版本管理

概述

Python 的应用编程接口（API）使得 C 和 C++ 程序员可以在多个层级上访问 Python 解释器。该 API 在 C++ 中同样可用，但为简化描述，通常将其称为 Python/C API。使用 Python/C API 有两个基本的理由。第一个理由是为了特定目的而编写 扩展模块；它们是扩展 Python 解释器功能的 C 模块。这可能是最常见的使用场景。第二个理由是将 Python 用作更大规模应用的组件；这种技巧通常被称为在一个应用中 embedding Python。

编写扩展模块的过程相对来说更易于理解，可以通过“菜谱”的形式分步骤介绍。使用某些工具可在一定程度上自动化这一过程。虽然人们在其他应用中嵌入 Python 的做法早已有之，但嵌入 Python 的过程没有编写扩展模块那样方便直观。

许多 API 函数在你嵌入或是扩展 Python 这两种场景下都能发挥作用；此外，大多数嵌入 Python 的应用程序也需要提供自定义扩展，因此在尝试在实际应用中嵌入 Python 之前先熟悉编写扩展应该会是个好主意。

代码标准

如果你想要编写可包含于 CPython 的 C 代码，你 必须 遵循在 PEP 7 [https://www.python.org/dev/peps/pep-0007] 中定义的指导原则和标准。这些指导原则适用于任何你所要扩展的 Python 版本。在编写你自己的第三方扩展模块时可以不必遵循这些规范，除非你准备在日后向 Python 贡献这些模块。

包含文件

使用 Python/C API 所需要的全部函数、类型和宏定义可通过下面这行语句包含到你的代码之中：

#define PY_SSIZE_T_CLEAN
#include <Python.h>

这意味着包含以下标准头文件：<stdio.h>，<string.h>，<errno.h>，<limits.h>，<assert.h> 和 <stdlib.h>（如果可用）。

注解

由于 Python 可能会定义一些能在某些系统上影响标准头文件的预处理器定义，因此在包含任何标准头文件之前，你 必须 先包含 Python.h。

推荐总是在 Python.h 前定义 PY_SSIZE_T_CLEAN 。查看 解析参数并构建值变量 来了解这个宏的更多内容。

Python.h 所定义的全部用户可见名称（由包含的标准头文件所定义的除外）都带有前缀 Py 或者 _Py。以 _Py 打头的名称是供 Python 实现内部使用的，不应被扩展编写者使用。结构成员名称没有保留前缀。

注解

用户代码永远不应该定义以 Py 或 _Py 开头的名称。这会使读者感到困惑，并危及用户代码对未来Python版本的可移植性，这些版本可能会定义以这些前缀之一开头的其他名称。

头文件通常会与 Python 一起安装。 在 Unix 上，它们位于 prefix/include/pythonversion/ 和 exec_prefix/include/pythonversion/ 目录，其中 prefix 和 exec_prefix 是由向 Python 的 configure 脚本传入的对应形参定义，而 version 则为 '%d.%d' % sys.version_info[:2]。 在 Windows 上，头文件安装于 prefix/include，其中 prefix 是为安装程序指定的安装目录。

要包括这些头文件，请将两个目录（如果不同）都放到你所用编译器用于包括头文件的搜索目录中。 请 不要 将父目录放入搜索路径然后使用 #include <pythonX.Y/Python.h>；这将使得多平台编译不可用，因为 prefix 下与平台无关的头文件包括了来自 exec_prefix 的平台专属头文件。

C++ 用户应该注意，尽管 API 是完全使用 C 来定义的，但头文件正确地将入口点声明为 extern "C"，因此 API 在 C++ 中使用此 API 不必再做任何特殊处理。

有用的宏

Python 头文件中定义了一些有用的宏。许多是在靠近它们被使用的地方定义的（例如 Py_RETURN_NONE）。其他更为通用的则定义在这里。这里所显示的并不是一个完整的列表。

Py_UNREACHABLE()

这个可以在你有一个设计上无法到达的代码路径时使用。例如，当一个 switch 语句中所有可能的值都已被 case 子句覆盖了，就可将其用在 default: 子句中。当你非常想在某个位置放一个 assert(0) 或 abort() 调用时也可以用这个。

在 release 模式下，该宏帮助编译器优化代码，并避免发出不可到达代码的警告。例如，在 GCC 的 release 模式下，该宏使用 __builtin_unreachable() 实现。

Py_UNREACHABLE() 的一个用法是调用一个不会返回，但却没有声明 _Py_NO_RETURN 的函数之后。

如果一个代码路径不太可能是正常代码，但在特殊情况下可以到达，就不能使用该宏。例如，在低内存条件下，或者一个系统调用返回超出预期范围值，诸如此类，最好将错误报告给调用者。如果无法将错误报告给调用者，可以使用 Py_FatalError() 。

3.7 新版功能.

Py_ABS(x)

返回 x 的绝对值。

3.3 新版功能.

Py_MIN(x, y)

返回 x 和 y 当中的最小值。

3.3 新版功能.

Py_MAX(x, y)

返回 x 和 y 当中的最大值。

3.3 新版功能.

Py_STRINGIFY(x)

将 x 转换为 C 字符串。例如 Py_STRINGIFY(123) 返回 "123"。

3.4 新版功能.

Py_MEMBER_SIZE(type, member)

返回结构 (type) member 的大小，以字节表示。

3.6 新版功能.

Py_CHARMASK(c)

参数必须为 [-128, 127] 或 [0, 255] 范围内的字符或整数类型。这个宏将 c 强制转换为 unsigned char 返回。

Py_GETENV(s)

与 getenv(s) 类似，但是如果命令行上传递了 -E ，则返回 NULL （即如果设置了 Py_IgnoreEnvironmentFlag ）。

Py_UNUSED(arg)

用于函数定义中未使用的参数，从而消除编译器警告。例如： int func(int a, int Py_UNUSED(b)) { return a; } 。

3.4 新版功能.

Py_DEPRECATED(version)

弃用声明。该宏必须放置在符号名称前。

示例:

Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);

在 3.8 版更改: 添加了 MSVC 支持。

PyDoc_STRVAR(name, str)

创建一个可以在文档字符串中使用的，名字为 name 的变量。如果不和文档字符串一起构建 Python，该值将为空。

如 PEP 7 [https://www.python.org/dev/peps/pep-0007] 所述，使用 PyDoc_STRVAR 作为文档字符串，以支持不和文档字符串一起构建 Python 的情况。

示例:

PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element.");

static PyMethodDef deque_methods[] = {
    // ...
    {"pop", (PyCFunction)deque_pop, METH_NOARGS, pop_doc},
    // ...
}

PyDoc_STR(str)

为给定的字符串输入创建一个文档字符串，或者当文档字符串被禁用时，创建一个空字符串。

如 PEP 7 [https://www.python.org/dev/peps/pep-0007] 所述，使用 PyDoc_STR 指定文档字符串，以支持不和文档字符串一起构建 Python 的情况。

示例:

static PyMethodDef pysqlite_row_methods[] = {
    {"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS,
        PyDoc_STR("Returns the keys of the row.")},
    {NULL, NULL}
};

对象、类型和引用计数

多数 Python/C API 函数都有一个或多个参数以及一个 PyObject* 类型的返回值。 这种类型是指向任意 Python 对象的不透明数据类型的指针。 由于所有 Python 对象类型在大多数情况下都被 Python 语言用相同的方式处理（例如，赋值、作用域规则和参数传递等），因此用单个 C 类型来表示它们是很适宜的。 几乎所有 Python 对象都存在于堆中：你不可声明一个类型为 PyObject 的自动或静态的变量，只能声明类型为 PyObject* 的指针变量。 唯一的例外是 type 对象；因为这种对象永远不能被释放，所以它们通常都是静态的 PyTypeObject 对象。

所有 Python 对象（甚至 Python 整数）都有一个 type 和一个 reference count。对象的类型确定它是什么类型的对象（例如整数、列表或用户定义函数；还有更多，如 标准类型层级结构 中所述）。对于每个众所周知的类型，都有一个宏来检查对象是否属于该类型；例如，当（且仅当） a 所指的对象是 Python 列表时 PyList_Check(a) 为真。

引用计数

引用计数之所以重要是因为现有计算机的内存大小是有限的（并且往往限制得很严格）；它会计算有多少不同的地方对一个对象进行了 strong reference。 这些地方可以是另一个对象，也可以是全局（或静态）C 变量，或是某个 C 函数中的局部变量。 当某个对象的最后一个 strong reference 被释放时（即其引用计数变为零），该对象就会被取消分配。 如果该对象包含对其他对象的引用，则会释放这些引用。 如果不再有对其他对象的引用，这些对象也会同样地被取消分配，依此类推。 （在这里对象之间的相互引用显然是个问题；目前的解决办法，就是“不要这样做”。）

对于引用计数总是会显式地执行操作。 通常的做法是使用 Py_INCREF() 宏来获取对象的新引用（即让引用计数加一），并使用 Py_DECREF() 宏来释放引用（即让引用计数减一）。 Py_DECREF() 宏比 incref 宏复杂得多，因为它必须检查引用计数是否为零然后再调用对象的释放器。 释放器是一个函数指针，它包含在对象的类型结构体中。 如果对象是复合对象类型，如列表，则特定于类型的释放器会负责释放对象中包含的其他对象的引用，并执行所需的其他终结化操作。 引用计数不会发生溢出；用于保存引用计数的位数至少会与虚拟内存中不同内存位置的位数相同 (假设 sizeof(Py_ssize_t) >= sizeof(void*))。 因此，引用计数的递增是一个简单的操作。

没有必要为每个包含指向对象指针的局部变量持有 strong reference (即增加引用计数)。 理论上说，当变量指向对象时对象的引用计数就会加一，而当变量离开其作用域时引用计数就会减一。 不过，这两种情况会相互抵消，所以最后引用计数并没有改变。 使用引用计数的唯一真正原因在于只要我们的变量指向对象就可以防止对象被释放。 只要我们知道至少还有一个指向某对象的引用与我们的变量同时存在，就没有必要临时获取一个新的 strong reference (即增加引用计数)。 出现引用计数增加的一种重要情况是对象作为参数被传递给扩展模块中的 C 函数而这些函数又在 Python 中被调用；调用机制会保证在调用期间对每个参数持有一个引用。

然而，一个常见的陷阱是从列表中提取对象并在不获取新引用的情况下将其保留一段时间。 某个其他操作可能在无意中从列表中移除该对象，释放这个引用，并可能撤销分配其资源。 真正的危险在于看似无害的操作可能会唤起任意的 Python 代码来做这件事；有一条代码路径允许控制权从 Py_DECREF() 流回到用户，因此几乎任何操作都有潜在的危险。

安全的做法是始终使用泛型操作（名称以 PyObject_, PyNumber_, PySequence_ 或 PyMapping_ 开头的函数）。 这些操作总是为其返回的对象创建一个新的 strong reference (即增加引用计数)。 这使得调用者有责任在获得结果之后调用 Py_DECREF()；这种做法很快就能习惯成自然。

引用计数细节

Python/C API 中函数的引用计数最好是使用 引用所有权 来解释。 所有权是关联到引用，而不是对象（对象不能被拥有：它们总是会被共享）。 “拥有一个引用”意味着当不再需要该引用时必须在其上调用 Py_DECREF。 所有权也可以被转移，这意味着接受该引用所有权的代码在不再需要它时必须通过调用 Py_DECREF() 或 Py_XDECREF() 来最终释放它 --- 或是继续转移这个责任（通常是转给其调用方）。 当一个函数将引用所有权转给其调用方时，则称调用方收到一个 新的 引用。 当未转移所有权时，则称调用方是 借入 这个引用。 对于 borrowed reference 来说不需要任何额外操作。

相反地，当调用方函数传入一个对象的引用时，存在两种可能：该函数 窃取 了一个对象的引用，或是没有窃取。 窃取引用 意味着当你向一个函数传入引用时，该函数会假定它拥有该引用，而你将不再对它负有责任。

很少有函数会窃取引用；两个重要的例外是 PyList_SetItem() 和 PyTuple_SetItem()，它们会窃取对条目的引用（但不是条目所在的元组或列表！）。 这些函数被设计为会窃取引用是因为在使用新创建的对象来填充元组或列表时有一个通常的惯例；例如，创建元组 (1, 2, "three") 的代码看起来可以是这样的（暂时不要管错误处理；下面会显示更好的代码编写方式）:

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"));

在这里，PyLong_FromLong() 返回了一个新的引用并且它立即被 PyTuple_SetItem() 所窃取。 当你想要继续使用一个对象而对它的引用将被窃取时，请在调用窃取引用的函数之前使用 Py_INCREF() 来抓取另一个引用。

顺便提一下，PyTuple_SetItem() 是设置元组条目的 唯一 方式；PySequence_SetItem() 和 PyObject_SetItem() 会拒绝这样做因为元组是不可变数据类型。 你应当只对你自己创建的元组使用 PyTuple_SetItem()。

等价于填充一个列表的代码可以使用 PyList_New() 和 PyList_SetItem() 来编写。

然而，在实践中，你很少会使用这些创建和填充元组或列表的方式。 有一个通用的函数 Py_BuildValue() 可以根据 C 值来创建大多数常用对象，由一个 格式字符串 来指明。 例如，上面的两个代码块可以用下面的代码来代替（还会负责错误检测）:

PyObject *tuple, *list;

tuple = Py_BuildValue("(iis)", 1, 2, "three");
list = Py_BuildValue("[iis]", 1, 2, "three");

在对条目使用 PyObject_SetItem() 等操作时更常见的做法是只借入引用，比如将参数传递给你正在编写的函数。 在这种情况下，它们在引用方面的行为更为清晰，因为你不必为了把引用转走而获取一个新的引用（“让它被偷取”）。 例如，这个函数将列表（实际上是任何可变序列）中的所有条目都设为给定的条目:

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;
}

对于函数返回值的情况略有不同。 虽然向大多数函数传递一个引用不会改变你对该引用的所有权责任，但许多返回一个引用的函数会给你该引用的所有权。 原因很简单：在许多情况下，返回的对象是临时创建的，而你得到的引用是对该对象的唯一引用。 因此，返回对象引用的通用函数，如 PyObject_GetItem() 和 PySequence_GetItem()，将总是返回一个新的引用（调用方将成为该引用的所有者）。

一个需要了解的重点在于你是否拥有一个由函数返回的引用只取决于你所调用的函数 --- 附带物 (作为参数传给函数的对象的类型) 不会带来额外影响！ 因此，如果你使用 PyList_GetItem() 从一个列表提取条目，你并不会拥有其引用 --- 但是如果你使用 PySequence_GetItem() (它恰好接受完全相同的参数) 从同一个列表获取同样的条目，你就会拥有一个对所返回对象的引用。

下面是说明你要如何编写一个函数来计算一个整数列表中条目的示例；一个是使用 PyList_GetItem()，而另一个是使用 PySequence_GetItem()。

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); /* Can't fail */
        if (!PyLong_Check(item)) continue; /* Skip non-integers */
        value = PyLong_AsLong(item);
        if (value == -1 && PyErr_Occurred())
            /* Integer too big to fit in a C long, bail out */
            return -1;
        total += value;
    }
    return total;
}

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; /* Has no length */
    for (i = 0; i < n; i++) {
        item = PySequence_GetItem(sequence, i);
        if (item == NULL)
            return -1; /* Not a sequence, or other failure */
        if (PyLong_Check(item)) {
            value = PyLong_AsLong(item);
            Py_DECREF(item);
            if (value == -1 && PyErr_Occurred())
                /* Integer too big to fit in a C long, bail out */
                return -1;
            total += value;
        }
        else {
            Py_DECREF(item); /* Discard reference ownership */
        }
    }
    return total;
}

类型

在 Python/C API 中扮演重要角色的其他数据类型很少；大多为简单 C 类型如 int, long, double 和 char* 等。 有一些结构类型被用来燃烧液体于列出模块所导出的函数或者某个新对象类型的个的一个，还有一个结构类型被用来描述复数的值。 这些结构类型将与使用它们的函数放到一起讨论。

type Py_ssize_t

Part of the Stable ABI.

一个使得 sizeof(Py_ssize_t) == sizeof(size_t) 的有符号整数类型。 C99 没有直接定义这样的东西（size_t 是一个无符号整数类型）。 请参阅 PEP 353 [https://www.python.org/dev/peps/pep-0353] 了解详情。 PY_SSIZE_T_MAX 是 Py_ssize_t 类型的最大正数值。

异常

Python程序员只需要处理特定需要处理的错误异常；未处理的异常会自动传递给调用者，然后传递给调用者的调用者，依此类推，直到他们到达顶级解释器，在那里将它们报告给用户并伴随堆栈回溯。

然而，对于 C 程序员来说，错误检查必须总是显式进行的。 Python/C API 中的所有函数都可以引发异常，除非在函数的文档中另外显式声明。 一般来说，当一个函数遇到错误时，它会设置一个异常，丢弃它所拥有的任何对象引用，并返回一个错误标示。 如果没有说明例外的文档，这个标示将为 NULL 或 -1，具体取决于函数的返回类型。 有少量函数会返回一个布尔真/假结果值，其中假值表示错误。 有极少的函数没有显式的错误标示或是具有不明确的返回值，并需要用 PyErr_Occurred() 来进行显式的检测。 这些例外总是会被明确地记入文档中。

异常状态是在各个线程的存储中维护的（这相当于在一个无线程的应用中使用全局存储）。 一个线程可以处在两种状态之一：异常已经发生，或者没有发生。 函数 PyErr_Occurred() 可以被用来检查此状态：当异常发生时它将返回一个借入的异常类型对象的引用，在其他情况下则返回 NULL。 有多个函数可以设置异常状态: PyErr_SetString() 是最常见的（尽管不是最通用的）设置异常状态的函数，而 PyErr_Clear() 可以清除异常状态。

完整的异常状态由三个对象组成 (它为都可以为 NULL): 异常类型、相应的异常值，以及回溯信息。 这些对象的含义与 Python 中 sys.exc_info() 的结果相同；然而，它们并不是一样的：Python 对象代表由 Python try ... except 语句所处理的最后一个异常，而 C 层级的异常状态只在异常被传入到 C 函数或在它们之间传递时存在直至其到达 Python 字节码解释器的主事件循环，该事件循环会负责将其转移至 sys.exc_info() 等处。

请注意自 Python 1.5 开始，从 Python 代码访问异常状态的首选的、线程安全的方式是调用函数 sys.exc_info()，它将返回 Python 代码的分线程异常状态。 此外，这两种访问异常状态的方式的语义都发生了变化因而捕获到异常的函数将保存并恢复其线程的异常状态以保留其调用方的异常状态。 这将防止异常处理代码中由一个看起来很无辜的函数覆盖了正在处理的异常所造成的常见错误；它还减少了在回溯由栈帧所引用的对象的往往不被需要的生命其延长。

作为一般的原则，一个调用另一个函数来执行某些任务的函数应当检查被调用的函数是否引发了异常，并在引发异常时将异常状态传递给其调用方。 它应当丢弃它所拥有的任何对象引用，并返回一个错误标示，但它 不应 设置另一个异常 --- 那会覆盖刚引发的异常，并丢失有关错误确切原因的重要信息。

一个检测异常并传递它们的简单例子在上面的 sum_sequence() 示例中进行了演示。 这个例子恰好在检测到错误时不需要清理所拥有的任何引用。 下面的示例函数演示了一些错误清理操作。 首先，为了向你提示 Python 的优势，我们展示了等效的 Python 代码:

def incr_item(dict, key):
    try:
        item = dict[key]
    except KeyError:
        item = 0
    dict[key] = item + 1

对应的 C 代码如下：

int
incr_item(PyObject *dict, PyObject *key)
{
    /* Objects all initialized to NULL for Py_XDECREF */
    PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;
    int rv = -1; /* Return value initialized to -1 (failure) */

    item = PyObject_GetItem(dict, key);
    if (item == NULL) {
        /* Handle KeyError only: */
        if (!PyErr_ExceptionMatches(PyExc_KeyError))
            goto error;

        /* Clear the error and use zero: */
        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; /* Success */
    /* Continue with cleanup code */

 error:
    /* Cleanup code, shared by success and failure path */

    /* Use Py_XDECREF() to ignore NULL references */
    Py_XDECREF(item);
    Py_XDECREF(const_one);
    Py_XDECREF(incremented_item);

    return rv; /* -1 for error, 0 for success */
}

这个例子代表了 C 语言中 goto 语句一种受到认可的用法！ 它说明了如何使用 PyErr_ExceptionMatches() 和 PyErr_Clear() 来处理特定的异常，以及如何使用 Py_XDECREF() 来处理可能为 NULL 的自有引用（注意名称中的 'X'；Py_DECREF() 在遇到 NULL 引用时将会崩溃）。 重要的一点在于用来保存自有引用的变量要被初始化为 NULL 才能发挥作用；类似地，建议的返回值也要被初始化为 -1 (失败) 并且只有在最终执行的调用成功后才会被设置为成功。

嵌入Python

只有 Python 解释器的嵌入方（相对于扩展编写者而言）才需要担心的一项重要任务是它的初始化，可能还有它的最终化。 解释器的大多数功能只有在解释器被初始化之后才能被使用。

基本的初始化函数是 Py_Initialize()。 此函数将初始化已加载模块表，并创建基本模块 builtins, __main__ 和 sys。 它还将初始化模块搜索路径 (sys.path)。

Py_Initialize() 不会设置 "脚本参数列表" (sys.argv)。 如果随后将要执行的 Python 代码需要此变量，则必须在调用 Py_Initialize() 之后通过调用 PySys_SetArgvEx(argc, argv, updatepath) 来显式地设置它。

在大多数系统上（特别是 Unix 和 Windows，虽然在细节上有所不同），Py_Initialize() 将根据对标准 Python 解释器可执行文件的位置的最佳猜测来计算模块搜索路径，并设定 Python 库可在相对于 Python 解释器可执行文件的固定位置上找到。 特别地，它将相对于在 shell 命令搜索路径 (环境变量 PATH) 上找到的名为 python 的可执行文件所在父目录中查找名为 lib/pythonX.Y 的目录。

举例来说，如果 Python 可执行文件位于 /usr/local/bin/python，它将假定库位于 /usr/local/lib/pythonX.Y。 （实际上，这个特定路径还将成为“回退”位置，会在当无法在 PATH 中找到名为 python 的可执行文件时被使用。） 用户可以通过设置环境变量 PYTHONHOME，或通过设置 PYTHONPATH 在标准路径之前插入额外的目录来覆盖此行为。

嵌入的应用程序可以通过在调用 Py_Initialize() 之前 调用 Py_SetProgramName(file) 来改变搜索次序。 请注意 PYTHONHOME 仍然会覆盖此设置并且 PYTHONPATH 仍然会被插入到标准路径之前。 需要完全控制权的应用程序必须提供它自己的 Py_GetPath(), Py_GetPrefix(), Py_GetExecPrefix() 和 Py_GetProgramFullPath() 实现（这些函数均在 Modules/getpath.c 中定义）。

有时，还需要对 Python 进行“反初始化”。 例如，应用程序可能想要重新启动 (再次调用 Py_Initialize()) 或者应用程序对 Python 的使用已经完成并想要释放 Python 所分配的内存。 这可以通过调用 Py_FinalizeEx() 来实现。 如果当前 Python 处于已初始化状态则 Py_IsInitialized() 函数将返回真值。 有关这些函数的更多信息将在之后的章节中给出。 请注意 Py_FinalizeEx() 不会 释放所有由 Python 解释器所分配的内存，例如由扩展模块所分配的内存目前是不会被释放的。

调试构建

Python 可以附带某些宏来编译以启用对解释器和扩展模块的额外检查。 这些检查会给运行时增加大量额外开销因此它们默认未被启用。

各种调试构建版的完整列表见 Python 源代码颁发包中的 Misc/SpecialBuilds.txt。 可用的构建版有支持追踪引用计数，调试内存分配器，或是对主解释器事件循环的低层级性能分析等等。 本节的剩余部分将只介绍最常用的几种构建版。

附带定义 Py_DEBUG 宏来编译解释器将产生通常所称的 Python 调试编译版。 Py_DEBUG 在 Unix 编译中启用是通过添加 --with-pydebug 到 ./configure 命令来实现的。 它也可通过提供非 Python 专属的 _DEBUG 宏来启用。 当 Py_DEBUG 在 Unix 编译中启用时，编译器优化将被禁用。

除了下文描述的引用计数调试，还会执行额外检查，请参阅 Python Debug Build。

定义 Py_TRACE_REFS 将启用引用追踪 (参见 configure --with-trace-refs 选项)。 当定义了此宏时，将通过在每个 PyObject 上添加两个额外字段来维护一个活动对象的循环双链列表。 总的分配量也会被追踪。 在退出时，所有现存的引用将被打印出来。 （在交互模式下这将在解释器运行每条语句之后发生）。

有关更多详细信息，请参阅Python源代码中的 Misc/SpecialBuilds.txt 。

C API 的稳定性

Python 的 C 语言 API 包含于向下兼容政策 PEP 387 [https://www.python.org/dev/peps/pep-0387] 中。C API 会跟随小版本的发布而发生变化（比如 3.9 到 3.10 的时候），不过大多数变化都是源代码级兼容的，通常只会增加新的 API。已有 API 的修改或删除，只有在废止期过后或修复严重问题时才会进行。

CPython 的应用二进制接口（ABI）可以跨小版本实现前后兼容（只要以同样方式编译；参见下面的 平台的考虑 ）。因此，用 Python 3.10.0 编译的代码可以在 3.10.8 上运行，反之亦然，但针对 3.9.x 和 3.10.x 则需分别进行编译。

带下划线前缀的是私有 API，如 _Py_InternalState，即便是补丁发布版本中也可能不加通知地进行改动。

应用程序二进制接口的稳定版

Python 3.2 引入了 受限 API，Python 的 C API 的一个子集。 只使用受限 API 的扩展可以被一次性编译而适用于多个 Python 版本。 受限 API 的内容 如下所示。

为了实现这一点，Python 提供了一个 稳定 ABI: 一个将在各 Python 3.x 版本中保持兼容性的符号集合。 稳定 ABI 包含了在受限 API 中暴露的符号，但还包含其他符号 – 例如，支持旧版受限 API 所需的函数。

（简单起见，本文档只讨论了 扩展，但受限 API 和稳定 ABI 对于 API 的所有用法都同样适用 – 例如，嵌入 Python 等。）

Py_LIMITED_API

请在包括 Python.h 之前定义这个宏以选择只使用受限 API，并选择受限 API 的版本。

将 Py_LIMITED_API 定义为对应你的扩展所支持的最低 Python 版本的 PY_VERSION_HEX 的值。 扩展无需重编译即可适用于从指定版本开始的所有 Python 3 发布版，并可使用到该版本为止所引入的受限 API。

不直接使用 PY_VERSION_HEX 宏，而是碍编码一个最小的次要版本（例如 0x030A0000 表示 Python 3.10）以便在使用未来的 Python 版本进行编译时保持稳定。

你还可以将 Py_LIMITED_API 定义为 3。 其效果与 0x03020000 相同（即 Python 3.2，引入受限 API 的版本）。

在 Windows 上，使用稳定 ABI 的扩展应当被链接到 python3.dll 而不是版本专属的库如 python39.dll。

在某些平台上，Python 将查找并载入名称中带有 abi3 标签的共享库文件 (例如 mymodule.abi3.so)。 它不会检查这样的扩展是否兼容稳定 ABI。 使用方 (或其打包工具) 需要确保这一些，例如，基于 3.10+ 受限 API 编译的扩展不可被安装于更低版本的 Python 中。

稳定 ABI 中的所有函数都会作为 Python 的共享库中的函数存在，而不仅是作为宏。 这使得它们可以在不使用 C 预处理器的语言中使用。

受限 API 的作用域和性能

受限 API 的目标是允许使用在完整 C API 中可用的任何东西，但可能会有性能上的损失。

例如，虽然 PyList_GetItem() 是可用的，但其 “不安全的” 宏版本 PyList_GET_ITEM() 则是不可用的。 这个宏的运行速度更快因为它可以利用版本专属的列表对象实现细节。

在未定义 Py_LIMITED_API 的情况下，某些 C API 函数将由宏来执行内联或替换。 定义 Py_LIMITED_API 会禁用这样的内联，允许提升 Python 的数据结构稳定性，但有可能降低性能。

通过省略 Py_LIMITED_API 定义，可以使基于版本专属的 ABI 来编译受限 API 扩展成为可能。 这能提升其在相应 Python 版本上的性能，但也将限制其兼容性。 基于 Py_LIMITED_API 进行编译将产生一个可在版本专属扩展不可用的场合分发的扩展 – 例如，针对即将发布的 Python 版本的预发布包。

受限 API 警示

请注意基于 Py_LIMITED_API 进行编译 不能 完全保证代码兼容受限 API 或稳定 ABI。 Py_LIMITED_API 仅涵盖了定义，但是一个 API 还包括其他因素，例如预期的语义等。

Py_LIMITED_API 不能处理的一个问题是附带在较低 Python 版本中无效的参数调用某个函数。 例如，考虑一个接受 NULL 作为参数的函数。 在 Python 3.9 中，NULL 现在会选择一个默认行为，但在 Python 3.8 中，该参数将被直接使用，导致一个 NULL 引用被崩溃。 类似的参数也适用于结构体的字段。

另一个问题是当定义了 Py_LIMITED_API 时某些结构体字段目前不会被隐藏，即使它们是受限 API 的一部分。

出于这些原因，我们建议用要支持的 所有 Python 小版本号来测试一个扩展，并最好是用其中 最低 的版本来编译它。

我们还建议查看所使用 API 的全部文档以检查其是否显式指明为受限 API 的一部分。 即使定义了 Py_LIMITED_API，少数私有声明还是会出于技术原因（或者甚至是作为程序缺陷在无意中）被暴露出来。

还要注意受限 API 并不必然是稳定的：在 Python 3.8 上用 Py_LIMITED_API 编译扩展意味着该扩展能在 Python 3.12 上运行，但它将不一定能用 Python 3.12 编译。 特别地，在稳定 ABI 保持稳定的情况下，部分受限 API 可能会被弃用并被移除。

平台的考虑

ABI 的稳定性不仅取决于 Python，还取决于所使用的编译器、低层库和编译器选项。 对于稳定 ABI 的目标来说，这些细节定义了一个 “平台”。 它们通常会取决于 OS 类型和处理器架构。

确保在特定平台上的所有 Python 版本都以不破坏稳定 ABI 的方式构建是每个特定 Python 分发方的责任。 来自 python.org 以及许多第三方分发商的 Windows 和 macOS 发布版都必于这种情况。

受限 API 的内容

目前，受限 API 包括下面这些项:

PyAIter_Check()

PyArg_Parse()

PyArg_ParseTuple()

PyArg_ParseTupleAndKeywords()

PyArg_UnpackTuple()

PyArg_VaParse()

PyArg_VaParseTupleAndKeywords()

PyArg_ValidateKeywordArguments()

PyBaseObject_Type

PyBool_FromLong()

PyBool_Type

PyByteArrayIter_Type

PyByteArray_AsString()

PyByteArray_Concat()

PyByteArray_FromObject()

PyByteArray_FromStringAndSize()

PyByteArray_Resize()

PyByteArray_Size()

PyByteArray_Type

PyBytesIter_Type

PyBytes_AsString()

PyBytes_AsStringAndSize()

PyBytes_Concat()

PyBytes_ConcatAndDel()

PyBytes_DecodeEscape()

PyBytes_FromFormat()

PyBytes_FromFormatV()

PyBytes_FromObject()

PyBytes_FromString()

PyBytes_FromStringAndSize()

PyBytes_Repr()

PyBytes_Size()

PyBytes_Type

PyCFunction

PyCFunctionWithKeywords

PyCFunction_Call()

PyCFunction_GetFlags()

PyCFunction_GetFunction()

PyCFunction_GetSelf()

PyCFunction_New()

PyCFunction_NewEx()

PyCFunction_Type

PyCMethod_New()

PyCallIter_New()

PyCallIter_Type

PyCallable_Check()

PyCapsule_Destructor

PyCapsule_GetContext()

PyCapsule_GetDestructor()

PyCapsule_GetName()

PyCapsule_GetPointer()

PyCapsule_Import()

PyCapsule_IsValid()

PyCapsule_New()

PyCapsule_SetContext()

PyCapsule_SetDestructor()

PyCapsule_SetName()

PyCapsule_SetPointer()

PyCapsule_Type

PyClassMethodDescr_Type

PyCodec_BackslashReplaceErrors()

PyCodec_Decode()

PyCodec_Decoder()

PyCodec_Encode()

PyCodec_Encoder()

PyCodec_IgnoreErrors()

PyCodec_IncrementalDecoder()

PyCodec_IncrementalEncoder()

PyCodec_KnownEncoding()

PyCodec_LookupError()

PyCodec_NameReplaceErrors()

PyCodec_Register()

PyCodec_RegisterError()

PyCodec_ReplaceErrors()

PyCodec_StreamReader()

PyCodec_StreamWriter()

PyCodec_StrictErrors()

PyCodec_Unregister()

PyCodec_XMLCharRefReplaceErrors()

PyComplex_FromDoubles()

PyComplex_ImagAsDouble()

PyComplex_RealAsDouble()

PyComplex_Type

PyDescr_NewClassMethod()

PyDescr_NewGetSet()

PyDescr_NewMember()

PyDescr_NewMethod()

PyDictItems_Type

PyDictIterItem_Type

PyDictIterKey_Type

PyDictIterValue_Type

PyDictKeys_Type

PyDictProxy_New()

PyDictProxy_Type

PyDictRevIterItem_Type

PyDictRevIterKey_Type

PyDictRevIterValue_Type

PyDictValues_Type

PyDict_Clear()

PyDict_Contains()

PyDict_Copy()

PyDict_DelItem()

PyDict_DelItemString()

PyDict_GetItem()

PyDict_GetItemString()

PyDict_GetItemWithError()

PyDict_Items()

PyDict_Keys()

PyDict_Merge()

PyDict_MergeFromSeq2()

PyDict_New()

PyDict_Next()

PyDict_SetItem()

PyDict_SetItemString()

PyDict_Size()

PyDict_Type

PyDict_Update()

PyDict_Values()

PyEllipsis_Type

PyEnum_Type

PyErr_BadArgument()

PyErr_BadInternalCall()

PyErr_CheckSignals()

PyErr_Clear()

PyErr_Display()

PyErr_ExceptionMatches()

PyErr_Fetch()

PyErr_Format()

PyErr_FormatV()

PyErr_GetExcInfo()

PyErr_GivenExceptionMatches()

PyErr_NewException()

PyErr_NewExceptionWithDoc()

PyErr_NoMemory()

PyErr_NormalizeException()

PyErr_Occurred()

PyErr_Print()

PyErr_PrintEx()

PyErr_ProgramText()

PyErr_ResourceWarning()

PyErr_Restore()

PyErr_SetExcFromWindowsErr()

PyErr_SetExcFromWindowsErrWithFilename()

PyErr_SetExcFromWindowsErrWithFilenameObject()

PyErr_SetExcFromWindowsErrWithFilenameObjects()

PyErr_SetExcInfo()

PyErr_SetFromErrno()

PyErr_SetFromErrnoWithFilename()

PyErr_SetFromErrnoWithFilenameObject()

PyErr_SetFromErrnoWithFilenameObjects()

PyErr_SetFromWindowsErr()

PyErr_SetFromWindowsErrWithFilename()

PyErr_SetImportError()

PyErr_SetImportErrorSubclass()

PyErr_SetInterrupt()

PyErr_SetInterruptEx()

PyErr_SetNone()

PyErr_SetObject()

PyErr_SetString()

PyErr_SyntaxLocation()

PyErr_SyntaxLocationEx()

PyErr_WarnEx()

PyErr_WarnExplicit()

PyErr_WarnFormat()

PyErr_WriteUnraisable()

PyEval_AcquireLock()

PyEval_AcquireThread()

PyEval_CallFunction()

PyEval_CallMethod()

PyEval_CallObjectWithKeywords()

PyEval_EvalCode()

PyEval_EvalCodeEx()

PyEval_EvalFrame()

PyEval_EvalFrameEx()

PyEval_GetBuiltins()

PyEval_GetFrame()

PyEval_GetFuncDesc()

PyEval_GetFuncName()

PyEval_GetGlobals()

PyEval_GetLocals()

PyEval_InitThreads()

PyEval_ReleaseLock()

PyEval_ReleaseThread()

PyEval_RestoreThread()

PyEval_SaveThread()

PyEval_ThreadsInitialized()

PyExc_ArithmeticError

PyExc_AssertionError

PyExc_AttributeError

PyExc_BaseException

PyExc_BlockingIOError

PyExc_BrokenPipeError

PyExc_BufferError

PyExc_BytesWarning

PyExc_ChildProcessError

PyExc_ConnectionAbortedError

PyExc_ConnectionError

PyExc_ConnectionRefusedError

PyExc_ConnectionResetError

PyExc_DeprecationWarning

PyExc_EOFError

PyExc_EncodingWarning

PyExc_EnvironmentError

PyExc_Exception

PyExc_FileExistsError

PyExc_FileNotFoundError

PyExc_FloatingPointError

PyExc_FutureWarning

PyExc_GeneratorExit

PyExc_IOError

PyExc_ImportError

PyExc_ImportWarning

PyExc_IndentationError

PyExc_IndexError

PyExc_InterruptedError

PyExc_IsADirectoryError

PyExc_KeyError

PyExc_KeyboardInterrupt

PyExc_LookupError

PyExc_MemoryError

PyExc_ModuleNotFoundError

PyExc_NameError

PyExc_NotADirectoryError

PyExc_NotImplementedError

PyExc_OSError

PyExc_OverflowError

PyExc_PendingDeprecationWarning

PyExc_PermissionError

PyExc_ProcessLookupError

PyExc_RecursionError

PyExc_ReferenceError

PyExc_ResourceWarning

PyExc_RuntimeError

PyExc_RuntimeWarning

PyExc_StopAsyncIteration

PyExc_StopIteration

PyExc_SyntaxError

PyExc_SyntaxWarning

PyExc_SystemError

PyExc_SystemExit

PyExc_TabError

PyExc_TimeoutError

PyExc_TypeError

PyExc_UnboundLocalError

PyExc_UnicodeDecodeError

PyExc_UnicodeEncodeError

PyExc_UnicodeError

PyExc_UnicodeTranslateError

PyExc_UnicodeWarning

PyExc_UserWarning

PyExc_ValueError

PyExc_Warning

PyExc_WindowsError

PyExc_ZeroDivisionError

PyExceptionClass_Name()

PyException_GetCause()

PyException_GetContext()

PyException_GetTraceback()

PyException_SetCause()

PyException_SetContext()

PyException_SetTraceback()

PyFile_FromFd()

PyFile_GetLine()

PyFile_WriteObject()

PyFile_WriteString()

PyFilter_Type

PyFloat_AsDouble()

PyFloat_FromDouble()

PyFloat_FromString()

PyFloat_GetInfo()

PyFloat_GetMax()

PyFloat_GetMin()

PyFloat_Type

PyFrameObject

PyFrame_GetCode()

PyFrame_GetLineNumber()

PyFrozenSet_New()

PyFrozenSet_Type

PyGC_Collect()

PyGC_Disable()

PyGC_Enable()

PyGC_IsEnabled()

PyGILState_Ensure()

PyGILState_GetThisThreadState()

PyGILState_Release()

PyGILState_STATE

PyGetSetDef

PyGetSetDescr_Type

PyImport_AddModule()

PyImport_AddModuleObject()

PyImport_AppendInittab()

PyImport_ExecCodeModule()

PyImport_ExecCodeModuleEx()

PyImport_ExecCodeModuleObject()

PyImport_ExecCodeModuleWithPathnames()

PyImport_GetImporter()

PyImport_GetMagicNumber()

PyImport_GetMagicTag()

PyImport_GetModule()

PyImport_GetModuleDict()

PyImport_Import()

PyImport_ImportFrozenModule()

PyImport_ImportFrozenModuleObject()

PyImport_ImportModule()

PyImport_ImportModuleLevel()

PyImport_ImportModuleLevelObject()

PyImport_ImportModuleNoBlock()

PyImport_ReloadModule()

PyIndex_Check()

PyInterpreterState

PyInterpreterState_Clear()

PyInterpreterState_Delete()

PyInterpreterState_Get()

PyInterpreterState_GetDict()

PyInterpreterState_GetID()

PyInterpreterState_New()

PyIter_Check()

PyIter_Next()

PyIter_Send()

PyListIter_Type

PyListRevIter_Type

PyList_Append()

PyList_AsTuple()

PyList_GetItem()

PyList_GetSlice()

PyList_Insert()

PyList_New()

PyList_Reverse()

PyList_SetItem()

PyList_SetSlice()

PyList_Size()

PyList_Sort()

PyList_Type

PyLongObject

PyLongRangeIter_Type

PyLong_AsDouble()

PyLong_AsLong()

PyLong_AsLongAndOverflow()

PyLong_AsLongLong()

PyLong_AsLongLongAndOverflow()

PyLong_AsSize_t()

PyLong_AsSsize_t()

PyLong_AsUnsignedLong()

PyLong_AsUnsignedLongLong()

PyLong_AsUnsignedLongLongMask()

PyLong_AsUnsignedLongMask()

PyLong_AsVoidPtr()

PyLong_FromDouble()

PyLong_FromLong()

PyLong_FromLongLong()

PyLong_FromSize_t()

PyLong_FromSsize_t()

PyLong_FromString()

PyLong_FromUnsignedLong()

PyLong_FromUnsignedLongLong()

PyLong_FromVoidPtr()

PyLong_GetInfo()

PyLong_Type

PyMap_Type

PyMapping_Check()

PyMapping_GetItemString()

PyMapping_HasKey()

PyMapping_HasKeyString()

PyMapping_Items()

PyMapping_Keys()

PyMapping_Length()

PyMapping_SetItemString()

PyMapping_Size()

PyMapping_Values()

PyMem_Calloc()

PyMem_Free()

PyMem_Malloc()

PyMem_Realloc()

PyMemberDef

PyMemberDescr_Type

PyMemoryView_FromMemory()

PyMemoryView_FromObject()

PyMemoryView_GetContiguous()

PyMemoryView_Type

PyMethodDef

PyMethodDescr_Type

PyModuleDef

PyModuleDef_Base

PyModuleDef_Init()

PyModuleDef_Type

PyModule_AddFunctions()

PyModule_AddIntConstant()

PyModule_AddObject()

PyModule_AddObjectRef()

PyModule_AddStringConstant()

PyModule_AddType()

PyModule_Create2()

PyModule_ExecDef()

PyModule_FromDefAndSpec2()

PyModule_GetDef()

PyModule_GetDict()

PyModule_GetFilename()

PyModule_GetFilenameObject()

PyModule_GetName()

PyModule_GetNameObject()

PyModule_GetState()

PyModule_New()

PyModule_NewObject()

PyModule_SetDocString()

PyModule_Type

PyNumber_Absolute()

PyNumber_Add()

PyNumber_And()

PyNumber_AsSsize_t()

PyNumber_Check()

PyNumber_Divmod()

PyNumber_Float()

PyNumber_FloorDivide()

PyNumber_InPlaceAdd()

PyNumber_InPlaceAnd()

PyNumber_InPlaceFloorDivide()

PyNumber_InPlaceLshift()

PyNumber_InPlaceMatrixMultiply()

PyNumber_InPlaceMultiply()

PyNumber_InPlaceOr()

PyNumber_InPlacePower()

PyNumber_InPlaceRemainder()

PyNumber_InPlaceRshift()

PyNumber_InPlaceSubtract()

PyNumber_InPlaceTrueDivide()

PyNumber_InPlaceXor()

PyNumber_Index()

PyNumber_Invert()

PyNumber_Long()

PyNumber_Lshift()

PyNumber_MatrixMultiply()

PyNumber_Multiply()

PyNumber_Negative()

PyNumber_Or()

PyNumber_Positive()

PyNumber_Power()

PyNumber_Remainder()

PyNumber_Rshift()

PyNumber_Subtract()

PyNumber_ToBase()

PyNumber_TrueDivide()

PyNumber_Xor()

PyOS_AfterFork()

PyOS_AfterFork_Child()

PyOS_AfterFork_Parent()

PyOS_BeforeFork()

PyOS_CheckStack()

PyOS_FSPath()

PyOS_InputHook

PyOS_InterruptOccurred()

PyOS_double_to_string()

PyOS_getsig()

PyOS_mystricmp()

PyOS_mystrnicmp()

PyOS_setsig()

PyOS_sighandler_t

PyOS_snprintf()

PyOS_string_to_double()

PyOS_strtol()

PyOS_strtoul()

PyOS_vsnprintf()

PyObject

PyObject.ob_refcnt

PyObject.ob_type

PyObject_ASCII()

PyObject_AsCharBuffer()

PyObject_AsFileDescriptor()

PyObject_AsReadBuffer()

PyObject_AsWriteBuffer()

PyObject_Bytes()

PyObject_Call()

PyObject_CallFunction()

PyObject_CallFunctionObjArgs()

PyObject_CallMethod()

PyObject_CallMethodObjArgs()

PyObject_CallNoArgs()

PyObject_CallObject()

PyObject_Calloc()

PyObject_CheckReadBuffer()

PyObject_ClearWeakRefs()

PyObject_DelItem()

PyObject_DelItemString()

PyObject_Dir()

PyObject_Format()

PyObject_Free()

PyObject_GC_Del()

PyObject_GC_IsFinalized()

PyObject_GC_IsTracked()

PyObject_GC_Track()

PyObject_GC_UnTrack()

PyObject_GenericGetAttr()

PyObject_GenericGetDict()

PyObject_GenericSetAttr()

PyObject_GenericSetDict()

PyObject_GetAIter()

PyObject_GetAttr()

PyObject_GetAttrString()

PyObject_GetItem()

PyObject_GetIter()

PyObject_HasAttr()

PyObject_HasAttrString()

PyObject_Hash()

PyObject_HashNotImplemented()

PyObject_Init()

PyObject_InitVar()

PyObject_IsInstance()

PyObject_IsSubclass()

PyObject_IsTrue()

PyObject_Length()

PyObject_Malloc()

PyObject_Not()

PyObject_Realloc()

PyObject_Repr()

PyObject_RichCompare()

PyObject_RichCompareBool()

PyObject_SelfIter()

PyObject_SetAttr()

PyObject_SetAttrString()

PyObject_SetItem()

PyObject_Size()

PyObject_Str()

PyObject_Type()

PyProperty_Type

PyRangeIter_Type

PyRange_Type

PyReversed_Type

PySeqIter_New()

PySeqIter_Type

PySequence_Check()

PySequence_Concat()

PySequence_Contains()

PySequence_Count()

PySequence_DelItem()

PySequence_DelSlice()

PySequence_Fast()

PySequence_GetItem()

PySequence_GetSlice()

PySequence_In()

PySequence_InPlaceConcat()

PySequence_InPlaceRepeat()

PySequence_Index()

PySequence_Length()

PySequence_List()

PySequence_Repeat()

PySequence_SetItem()

PySequence_SetSlice()

PySequence_Size()

PySequence_Tuple()

PySetIter_Type

PySet_Add()

PySet_Clear()

PySet_Contains()

PySet_Discard()

PySet_New()

PySet_Pop()

PySet_Size()

PySet_Type

PySlice_AdjustIndices()

PySlice_GetIndices()

PySlice_GetIndicesEx()

PySlice_New()

PySlice_Type

PySlice_Unpack()

PyState_AddModule()

PyState_FindModule()

PyState_RemoveModule()

PyStructSequence_Desc

PyStructSequence_Field

PyStructSequence_GetItem()

PyStructSequence_New()

PyStructSequence_NewType()

PyStructSequence_SetItem()

PySuper_Type

PySys_AddWarnOption()

PySys_AddWarnOptionUnicode()

PySys_AddXOption()

PySys_FormatStderr()

PySys_FormatStdout()

PySys_GetObject()

PySys_GetXOptions()

PySys_HasWarnOptions()

PySys_ResetWarnOptions()

PySys_SetArgv()

PySys_SetArgvEx()

PySys_SetObject()

PySys_SetPath()

PySys_WriteStderr()

PySys_WriteStdout()

PyThreadState

PyThreadState_Clear()

PyThreadState_Delete()

PyThreadState_Get()

PyThreadState_GetDict()

PyThreadState_GetFrame()

PyThreadState_GetID()

PyThreadState_GetInterpreter()

PyThreadState_New()

PyThreadState_SetAsyncExc()

PyThreadState_Swap()

PyThread_GetInfo()

PyThread_ReInitTLS()

PyThread_acquire_lock()

PyThread_acquire_lock_timed()

PyThread_allocate_lock()

PyThread_create_key()

PyThread_delete_key()

PyThread_delete_key_value()

PyThread_exit_thread()

PyThread_free_lock()

PyThread_get_key_value()

PyThread_get_stacksize()

PyThread_get_thread_ident()

PyThread_get_thread_native_id()

PyThread_init_thread()

PyThread_release_lock()

PyThread_set_key_value()

PyThread_set_stacksize()

PyThread_start_new_thread()

PyThread_tss_alloc()

PyThread_tss_create()

PyThread_tss_delete()

PyThread_tss_free()

PyThread_tss_get()

PyThread_tss_is_created()

PyThread_tss_set()

PyTraceBack_Here()

PyTraceBack_Print()

PyTraceBack_Type

PyTupleIter_Type

PyTuple_GetItem()

PyTuple_GetSlice()

PyTuple_New()

PyTuple_Pack()

PyTuple_SetItem()

PyTuple_Size()

PyTuple_Type

PyTypeObject

PyType_ClearCache()

PyType_FromModuleAndSpec()

PyType_FromSpec()

PyType_FromSpecWithBases()

PyType_GenericAlloc()

PyType_GenericNew()

PyType_GetFlags()

PyType_GetModule()

PyType_GetModuleState()

PyType_GetSlot()

PyType_IsSubtype()

PyType_Modified()

PyType_Ready()

PyType_Slot

PyType_Spec

PyType_Type

PyUnicodeDecodeError_Create()

PyUnicodeDecodeError_GetEncoding()

PyUnicodeDecodeError_GetEnd()

PyUnicodeDecodeError_GetObject()

PyUnicodeDecodeError_GetReason()

PyUnicodeDecodeError_GetStart()

PyUnicodeDecodeError_SetEnd()

PyUnicodeDecodeError_SetReason()

PyUnicodeDecodeError_SetStart()

PyUnicodeEncodeError_GetEncoding()

PyUnicodeEncodeError_GetEnd()

PyUnicodeEncodeError_GetObject()

PyUnicodeEncodeError_GetReason()

PyUnicodeEncodeError_GetStart()

PyUnicodeEncodeError_SetEnd()

PyUnicodeEncodeError_SetReason()

PyUnicodeEncodeError_SetStart()

PyUnicodeIter_Type

PyUnicodeTranslateError_GetEnd()

PyUnicodeTranslateError_GetObject()

PyUnicodeTranslateError_GetReason()

PyUnicodeTranslateError_GetStart()

PyUnicodeTranslateError_SetEnd()

PyUnicodeTranslateError_SetReason()

PyUnicodeTranslateError_SetStart()

PyUnicode_Append()

PyUnicode_AppendAndDel()

PyUnicode_AsASCIIString()

PyUnicode_AsCharmapString()

PyUnicode_AsDecodedObject()

PyUnicode_AsDecodedUnicode()

PyUnicode_AsEncodedObject()

PyUnicode_AsEncodedString()

PyUnicode_AsEncodedUnicode()

PyUnicode_AsLatin1String()

PyUnicode_AsMBCSString()

PyUnicode_AsRawUnicodeEscapeString()

PyUnicode_AsUCS4()

PyUnicode_AsUCS4Copy()

PyUnicode_AsUTF16String()

PyUnicode_AsUTF32String()

PyUnicode_AsUTF8AndSize()

PyUnicode_AsUTF8String()

PyUnicode_AsUnicodeEscapeString()

PyUnicode_AsWideChar()

PyUnicode_AsWideCharString()

PyUnicode_BuildEncodingMap()

PyUnicode_Compare()

PyUnicode_CompareWithASCIIString()

PyUnicode_Concat()

PyUnicode_Contains()

PyUnicode_Count()

PyUnicode_Decode()

PyUnicode_DecodeASCII()

PyUnicode_DecodeCharmap()

PyUnicode_DecodeCodePageStateful()

PyUnicode_DecodeFSDefault()

PyUnicode_DecodeFSDefaultAndSize()

PyUnicode_DecodeLatin1()

PyUnicode_DecodeLocale()

PyUnicode_DecodeLocaleAndSize()

PyUnicode_DecodeMBCS()

PyUnicode_DecodeMBCSStateful()

PyUnicode_DecodeRawUnicodeEscape()

PyUnicode_DecodeUTF16()

PyUnicode_DecodeUTF16Stateful()

PyUnicode_DecodeUTF32()

PyUnicode_DecodeUTF32Stateful()

PyUnicode_DecodeUTF7()

PyUnicode_DecodeUTF7Stateful()

PyUnicode_DecodeUTF8()

PyUnicode_DecodeUTF8Stateful()

PyUnicode_DecodeUnicodeEscape()

PyUnicode_EncodeCodePage()

PyUnicode_EncodeFSDefault()

PyUnicode_EncodeLocale()

PyUnicode_FSConverter()

PyUnicode_FSDecoder()

PyUnicode_Find()

PyUnicode_FindChar()

PyUnicode_Format()

PyUnicode_FromEncodedObject()

PyUnicode_FromFormat()

PyUnicode_FromFormatV()

PyUnicode_FromObject()

PyUnicode_FromOrdinal()

PyUnicode_FromString()

PyUnicode_FromStringAndSize()

PyUnicode_FromWideChar()

PyUnicode_GetDefaultEncoding()

PyUnicode_GetLength()

PyUnicode_GetSize()

PyUnicode_InternFromString()

PyUnicode_InternImmortal()

PyUnicode_InternInPlace()

PyUnicode_IsIdentifier()

PyUnicode_Join()

PyUnicode_Partition()

PyUnicode_RPartition()

PyUnicode_RSplit()

PyUnicode_ReadChar()

PyUnicode_Replace()

PyUnicode_Resize()

PyUnicode_RichCompare()

PyUnicode_Split()

PyUnicode_Splitlines()

PyUnicode_Substring()

PyUnicode_Tailmatch()

PyUnicode_Translate()

PyUnicode_Type

PyUnicode_WriteChar()

PyVarObject

PyVarObject.ob_base

PyVarObject.ob_size

PyWeakReference

PyWeakref_GetObject()

PyWeakref_NewProxy()

PyWeakref_NewRef()

PyWrapperDescr_Type

PyWrapper_New()

PyZip_Type

Py_AddPendingCall()

Py_AtExit()

Py_BEGIN_ALLOW_THREADS

Py_BLOCK_THREADS

Py_BuildValue()

Py_BytesMain()

Py_CompileString()

Py_DecRef()

Py_DecodeLocale()

Py_END_ALLOW_THREADS

Py_EncodeLocale()

Py_EndInterpreter()

Py_EnterRecursiveCall()

Py_Exit()

Py_FatalError()

Py_FileSystemDefaultEncodeErrors

Py_FileSystemDefaultEncoding

Py_Finalize()

Py_FinalizeEx()

Py_GenericAlias()

Py_GenericAliasType

Py_GetBuildInfo()

Py_GetCompiler()

Py_GetCopyright()

Py_GetExecPrefix()

Py_GetPath()

Py_GetPlatform()

Py_GetPrefix()

Py_GetProgramFullPath()

Py_GetProgramName()

Py_GetPythonHome()

Py_GetRecursionLimit()

Py_GetVersion()

Py_HasFileSystemDefaultEncoding

Py_IncRef()

Py_Initialize()

Py_InitializeEx()

Py_Is()

Py_IsFalse()

Py_IsInitialized()

Py_IsNone()

Py_IsTrue()

Py_LeaveRecursiveCall()

Py_Main()

Py_MakePendingCalls()

Py_NewInterpreter()

Py_NewRef()

Py_ReprEnter()

Py_ReprLeave()

Py_SetPath()

Py_SetProgramName()

Py_SetPythonHome()

Py_SetRecursionLimit()

Py_UCS4

Py_UNBLOCK_THREADS

Py_UTF8Mode

Py_VaBuildValue()

Py_XNewRef()

Py_intptr_t

Py_ssize_t

Py_uintptr_t

allocfunc

binaryfunc

descrgetfunc

descrsetfunc

destructor

getattrfunc

getattrofunc

getiterfunc

getter

hashfunc

initproc

inquiry

iternextfunc

lenfunc

newfunc

objobjargproc

objobjproc

reprfunc

richcmpfunc

setattrfunc

setattrofunc

setter

ssizeargfunc

ssizeobjargproc

ssizessizeargfunc

ssizessizeobjargproc

symtable

ternaryfunc

traverseproc

unaryfunc

visitproc

极高层级 API

本章节的函数将允许你执行在文件或缓冲区中提供的 Python 源代码，但它们将不允许你在更细节化的方式与解释器进行交互。

这些函数中有几个可以接受特定的前缀语法符号作为形参。 可用的前缀符号有 Py_eval_input, Py_file_input 以及 Py_single_input。 这些符号会在接受它们作为形参的函数文档中加以说明。

Note also that several of these functions take FILE* parameters. One particular issue which needs to be handled carefully is that the FILE structure for different C libraries can be different and incompatible. Under Windows (at least), it is possible for dynamically linked extensions to actually use different libraries, so care should be taken that FILE* parameters are only passed to these functions if it is certain that they were created by the same library that the Python runtime is using.

int Py_Main(int argc, wchar_t **argv)

Part of the Stable ABI.

针对标准解释器的主程序。 嵌入了 Python 的程序将可使用此程序。 所提供的 argc 和 argv 形参应当与传给 C 程序的 main() 函数的形参相同（将根据用户的语言区域转换为）。 一个重要的注意事项是参数列表可能会被修改（但参数列表中字符串所指向的内容不会被修改）。 如果解释器正常退出（即未引发异常）则返回值将为 0，如果解释器因引发异常而退出则返回 1，或者如果形参列表不能表示有效的 Python 命令行则返回 2。

请注意如果引发了一个在其他场合下未处理的 SystemExit，此函数将不会返回 1，而是退出进程，只要 Py_InspectFlag 还未被设置。

int Py_BytesMain(int argc, char **argv)

Part of the Stable ABI since version 3.8.

类似于 Py_Main() 但 argv 是一个包含字节串的数组。

3.8 新版功能.

int PyRun_AnyFile(FILE *fp, const char *filename)

这是针对下面 PyRun_AnyFileExFlags() 的简化版接口，将 closeit 设为 0 而将 flags 设为 NULL。

int PyRun_AnyFileFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)

这是针对下面 PyRun_AnyFileExFlags() 的简化版接口，将 closeit 参数设为 0。

int PyRun_AnyFileEx(FILE *fp, const char *filename, int closeit)

这是针对下面 PyRun_AnyFileExFlags() 的简化版接口，将 flags 参数设为 NULL。

int PyRun_AnyFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

如果 fp 指向一个关联到交互设备（控制台或终端输入或 Unix 伪终端）的文件，则返回 PyRun_InteractiveLoop() 的值，否则返回 PyRun_SimpleFile() 的结果。 filename 会使用文件系统的编码格式 (sys.getfilesystemencoding()) 来解码。 如果 filename 为 NULL，此函数会使用 "???" 作为文件名。 如果 closeit 为真值，文件会在 PyRun_SimpleFileExFlags() 返回之前被关闭。

int PyRun_SimpleString(const char *command)

这是针对下面 PyRun_SimpleStringFlags() 的简化版接口，将 PyCompilerFlags* 参数设为 NULL。

int PyRun_SimpleStringFlags(const char *command, PyCompilerFlags *flags)

根据 flags 参数，在 __main__ 模块中执行 Python 源代码。 如果 __main__ 尚不存在，它将被创建。 成功时返回 0，如果引发异常则返回 -1。 如果发生错误，则将无法获得异常信息。 对于 flags 的含义，请参阅下文。

请注意如果引发了一个在其他场合下未处理的 SystemExit，此函数将不会返回 -1，而是退出进程，只要 Py_InspectFlag 还未被设置。

int PyRun_SimpleFile(FILE *fp, const char *filename)

这是针对下面 PyRun_SimpleFileExFlags() 的简化版接口，将 closeit 设为 0 而将 flags 设为 NULL。

int PyRun_SimpleFileEx(FILE *fp, const char *filename, int closeit)

这是针对下面 PyRun_SimpleFileExFlags() 的简化版接口，将 flags 设为 NULL。

int PyRun_SimpleFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

类似于 PyRun_SimpleStringFlags()，但 Python 源代码是从 fp 读取而不是一个内存中的字符串。 filename 应为文件名，它将使用 filesystem encoding and error handler 来解码。 如果 closeit 为真值，则文件将在 PyRun_SimpleFileExFlags() 返回之前被关闭。

注解

在 Windows 上，fp 应当以二进制模式打开 (即 fopen(filename, "rb"))。 否则，Python 可能无法正确地处理使用 LF 行结束符的脚本文件。

int PyRun_InteractiveOne(FILE *fp, const char *filename)

这是针对下面 PyRun_InteractiveOneFlags() 的简化版接口，将 flags 设为 NULL。

int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)

根据 flags 参数读取并执行来自与交互设备相关联的文件的一条语句。 用户将得到使用 sys.ps1 和 sys.ps2 的提示。 filename 将使用 filesystem encoding and error handler 来解码。

当输入被成功执行时返回 0，如果引发异常则返回 -1，或者如果存在解析错误则返回来自作为 Python 的组成部分发布的 errcode.h 包括文件的错误代码。 （请注意 errcode.h 并未被 Python.h 所包括，因此如果需要则必须专门地包括。）

int PyRun_InteractiveLoop(FILE *fp, const char *filename)

这是针对下面 PyRun_InteractiveLoopFlags() 的简化版接口，将 flags 设为 NULL。

int PyRun_InteractiveLoopFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)

读取并执行来自与交互设备相关联的语句直至到达 EOF。 用户将得到使用 sys.ps1 和 sys.ps2 的提示。 filename 将使用 filesystem encoding and error handler 来解码。 当位于 EOF 时将返回 0，或者当失败时将返回一个负数。

int (*PyOS_InputHook)(void)

Part of the Stable ABI.

可以被设为指向一个原型为 int func(void) 的函数。 该函数将在Python 的解释器提示符即将空闲并等待用户从终端输入时被调用。 返回值会被忽略。 重写这个钩子可被用来将解释器的提示符集成到其他事件循环中，就像 Python 码中 Modules/_tkinter.c 所做的那样。

char *(*PyOS_ReadlineFunctionPointer)(FILE*, FILE*, const char*)

可以被设为指向一个原型为 char *func(FILE *stdin, FILE *stdout, char *prompt) 的函数，重写被用来读取解释器提示符的一行输入的默认函数。 该函数被预期为如果字符串 prompt 不为 NULL 就输出它，然后从所提供的标准输入文件读取一行输入，并返回结果字符串。 例如，readline 模块将这个钩子设置为提供行编辑和 tab 键补全等功能。

结果必须是一个由 PyMem_RawMalloc() 或 PyMem_RawRealloc() 分配的字符串，或者如果发生错误则为 NULL。

在 3.4 版更改: 结果必须由 PyMem_RawMalloc() 或 PyMem_RawRealloc() 分配，而不是由 PyMem_Malloc() 或 PyMem_Realloc() 分配。

PyObject *PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)

返回值：新的引用。

这是针对下面 PyRun_StringFlags() 的简化版接口，将 flags 设为 NULL。

PyObject *PyRun_StringFlags(const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)

返回值：新的引用。

在由对象 globals 和 locals 指定的上下文中执行来自 str 的 Python 源代码，并使用以 flags 指定的编译器旗标。 globals 必须是一个字典；locals 可以是任何实现了映射协议的对象。 形参 start 指定了应当被用来解析源代码的起始形符。

返回将代码作为 Python 对象执行的结果，或者如果引发了异常则返回 NULL。

PyObject *PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)

返回值：新的引用。

这是针对下面 PyRun_FileExFlags() 的简化版接口，将 closeit 设为 0 并将 flags 设为 NULL。

PyObject *PyRun_FileEx(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)

返回值：新的引用。

这是针对下面 PyRun_FileExFlags() 的简化版接口，将 flags 设为 NULL。

PyObject *PyRun_FileFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)

返回值：新的引用。

这是针对下面 PyRun_FileExFlags() 的简化版接口，将 closeit 设为 0。

PyObject *PyRun_FileExFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)

返回值：新的引用。

类似于 PyRun_StringFlags()，但 Python 源代码是从 fp 读取而不是一个内存中的字符串。 filename 应为文件名，它将使用 filesystem encoding and error handler 来解码。 如果 closeit 为真值，则文件将在 PyRun_FileExFlags() 返回之前被关闭。

PyObject *Py_CompileString(const char *str, const char *filename, int start)

返回值：新的引用。 Part of the Stable ABI.

这是针对下面 Py_CompileStringFlags() 的简化版接口，将 flags 设为 NULL。

PyObject *Py_CompileStringFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags)

返回值：新的引用。

这是针对下面 Py_CompileStringExFlags() 的简化版接口，将 optimize 设为 -1。

PyObject *Py_CompileStringObject(const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)

返回值：新的引用。

解析并编译 str 中的 Python 源代码，返回结果代码对象。 开始形符由 start 给出；这可被用来限制可被编译的代码并且应为 Py_eval_input, Py_file_input 或 Py_single_input。 由 filename 指定的文件名会被用来构造代码对象并可能出现在回溯信息或 SyntaxError 异常消息中。 如果代码无法被解析或编译则此函数将返回 NULL。

整数 optimize 指定编译器的优化级别；值 -1 将选择与 -O 选项相同的解释器优化级别。 显式级别为 0 (无优化；__debug__ 为真值)、1 (断言被移除，__debug__ 为假值) 或 2 (文档字符串也被移除)。

3.4 新版功能.

PyObject *Py_CompileStringExFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)

返回值：新的引用。

与 Py_CompileStringObject() 类似，但 filename 是以 filesystem encoding and error handler 解码出的字节串。

3.2 新版功能.

PyObject *PyEval_EvalCode(PyObject *co, PyObject *globals, PyObject *locals)

返回值：新的引用。 Part of the Stable ABI.

这是针对 PyEval_EvalCodeEx() 的简化版接口，只附带代码对象，以及全局和局部变量。 其他参数均设为 NULL。

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)

返回值：新的引用。 Part of the Stable ABI.

对一个预编译的代码对象求值，为其求值给出特定的环境。 此环境由全局变量的字典，局部变量映射对象，参数、关键字和默认值的数组，仅限关键字 参数的默认值的字典和单元的封闭元组构成。

type PyFrameObject

Part of the Limited API (as an opaque struct).

用于描述帧对象的 C 对象结构体。 此类型的字段可能在任何时候被改变。

PyObject *PyEval_EvalFrame(PyFrameObject *f)

返回值：新的引用。 Part of the Stable ABI.

对一个执行帧求值。 这是针对 PyEval_EvalFrameEx() 的简化版接口，用于保持向下兼容性。

PyObject *PyEval_EvalFrameEx(PyFrameObject *f, int throwflag)

返回值：新的引用。 Part of the Stable ABI.

这是 Python 解释运行不带修饰的主函数。 与执行帧 f 相关联的代码对象将被执行，解释字节码并根据需要执行调用。 额外的 throwflag 形参基本可以被忽略 —— 如果为真值，则会导致立即抛出一个异常；这会被用于生成器对象的 throw() 方法。

在 3.4 版更改: 该函数现在包含一个调试断言，用以确保不会静默地丢弃活动的异常。

int PyEval_MergeCompilerFlags(PyCompilerFlags *cf)

此函数会修改当前求值帧的旗标，并在成功时返回真值，失败时返回假值。

int Py_eval_input

Python 语法中用于孤立表达式的起始符号；配合 Py_CompileString() 使用。

int Py_file_input

Python 语法中用于从文件或其他源读取语句序列的起始符号；配合 Py_CompileString() 使用。 这是在编译任意长的 Python 源代码时要使用的符号。

int Py_single_input

Python 语法中用于单独语句的起始符号；配合 Py_CompileString() 使用。 这是用于交互式解释器循环的符号。

struct PyCompilerFlags

这是用来存放编译器旗标的结构体。 对于代码仅被编译的情况，它将作为 int flags 传入，而对于代码要被执行的情况，它将作为 PyCompilerFlags *flags 传入。 在这种情况下，from __future__ import 可以修改 flags。

当 PyCompilerFlags *flags 为 NULL 时，cf_flags 将被当作等于 0 来处理，而任何 from __future__ import 所导致的修改都会被丢弃。

int cf_flags

编译器旗标。

int cf_feature_version

cf_feature_version 是 Python 的小版本号。 它应当被初始化为 PY_MINOR_VERSION。

此字段默认会被忽略，当且仅当在 cf_flags 中设置了 PyCF_ONLY_AST 旗标它才会被使用。

在 3.8 版更改: 增加了 cf_feature_version 字段。

int CO_FUTURE_DIVISION

这个标志位可在 flags 中设置以使得除法运算符 / 被解读为 PEP 238 [https://www.python.org/dev/peps/pep-0238] 所规定的“真除法”。

引用计数

本节介绍的宏被用于管理 Python 对象的引用计数。

void Py_INCREF(PyObject *o)

表示为对象 o 获取一个新的 strong reference，指明该对象正在被使用且不应被销毁。

此函数通常被用来将 borrowed reference 原地转换为 strong reference。 Py_NewRef() 函数可被用来创建新的 strong reference。

当对象使用完毕后，可调用 Py_DECREF() 释放它。

此对象必须不为 NULL；如果你不能确定它不为 NULL，请使用 Py_XINCREF()。

Do not expect this function to actually modify o in any way.

void Py_XINCREF(PyObject *o)

与 Py_INCREF() 类似，但对象 o 可以为 NULL，在这种情况下此函数将没有任何效果。

另请参阅 Py_XNewRef()。

PyObject *Py_NewRef(PyObject *o)

Part of the Stable ABI since version 3.10.

为对象创建一个新的 strong reference: 在 o 上调用 Py_INCREF() 并返回对象 o。

当不再需要这个 strong reference 时，应当在其上调用 Py_DECREF() 来释放引用。

对象 o 必须不为 NULL；如果 o 可以为 NULL 则应改用 Py_XNewRef()。

例如：

Py_INCREF(obj);
self->attr = obj;

可以写成:

self->attr = Py_NewRef(obj);

另请参阅 Py_INCREF()。

3.10 新版功能.

PyObject *Py_XNewRef(PyObject *o)

Part of the Stable ABI since version 3.10.

类似于 Py_NewRef()，但对象 o 可以为 NULL。

如果对象 o 为 NULL，该函数也·将返回 NULL。

3.10 新版功能.

void Py_DECREF(PyObject *o)

释放一个指向对象 o 的 strong reference，表明该引用不再被使用。

当最后一个 strong reference 被释放时 (即对象的引用计数变为 0)，将会唤起该对象所属类型的 deallocation 函数 (它必须不为 NULL)。

此函数通常被用于在退出作用域之前删除一个 strong reference。

此对象必须不为 NULL；如果你不能确定它不为 NULL，请使用 Py_XDECREF()。

Do not expect this function to actually modify o in any way.

警告

释放函数可导致任意 Python 代码被发起调用（例如当一个带有 __del__() 方法的类实例被释放时就是如此）。 虽然此类代码中的异常不会被传播，但被执行的代码能够自由访问所有 Python 全局变量。 这意味着任何可通过全局变量获取的对象在 Py_DECREF() 被发起调用之前都应当处于完好状态。 例如，从一个列表中删除对象的代码应当将被删除对象的引用拷贝到一个临时变量中，更新列表数据结构，然后再为临时变量调用 Py_DECREF()。

void Py_XDECREF(PyObject *o)

与 Py_DECREF() 类似，但对象 o 可以为 NULL，在这种情况下此函数将没有任何效果。 来自 Py_DECREF() 的警告同样适用于此处。

void Py_CLEAR(PyObject *o)

释放一个指向对象 o 的 strong reference。 对象可以为 NULL，在此情况下该宏将没有任何效果；在其他情况下其效果与 Py_DECREF() 相同，区别在于其参数也会被设为 NULL。 针对 Py_DECREF() 的警告不适用于所传递的对象，因为该宏会细心地使用一个临时变量并在释放引用之前将参数设为 NULL。

当需要释放指向一个在垃圾回收期间可能被会遍历的对象的引用时使用该宏是一个好主意。

void Py_IncRef(PyObject *o)

Part of the Stable ABI.

表示获取一个指向对象 o 的新 strong reference。 Py_XINCREF() 的函数版本。 它可被用于 Python 的运行时动态嵌入。

void Py_DecRef(PyObject *o)

Part of the Stable ABI.

释放一个指向对象 o 的 strong reference。 Py_XDECREF() 的函数版本。 它可被用于 Python 的运行时动态嵌入。

以下函数或宏仅可在解释器核心内部使用: _Py_Dealloc(), _Py_ForgetReference(), _Py_NewReference() 以及全局变量 _Py_RefTotal。

异常处理

本章描述的函数将让你处理和触发 Python 异常。 了解一些 Python 异常处理的基础知识是很重要的。 它的工作原理有点像 POSIX errno 变量: (每个线程) 有一个最近发生的错误的全局指示器。 大多数 C API 函数在成功执行时将不理会它。 大多数 C API 函数也会返回一个错误指示器，如果它们应当返回一个指针则会返回 NULL，或者如果它们应当返回一个整数则会返回 -1 (例外情况: PyArg_* 函数返回 1 表示成功而 0 表示失败)。

具体地说，错误指示器由三个对象指针组成：异常的类型，异常的值，和回溯对象。如果没有错误被设置，这些指针都可以是 NULL （尽管一些组合使禁止的，例如，如果异常类型是 NULL，你不能有一个非 NULL 的回溯）。

当一个函数由于它调用的某个函数失败而必须失败时，通常不会设置错误指示器；它调用的那个函数已经设置了它。而它负责处理错误和清理异常，或在清除其拥有的所有资源后返回（如对象应用或内存分配）。如果不准备处理异常，则 不 应该正常地继续。如果是由于一个错误返回，那么一定要向调用者表明已经设置了错误。如果错误没有得到处理或小心传播，对 Python/C API的其它调用可能不会有预期的行为，并且可能会以某种神秘的方式失败。

注解

错误指示器 不是 sys.exc_info() 的执行结果。前者对应尚未捕获的异常（异常还在传播），而后者在捕获异常后返回这个异常（异常已经停止传播）。

打印和清理

void PyErr_Clear()

Part of the Stable ABI.

清除错误指示器。如果没有设置错误指示器，则不会有作用。

void PyErr_PrintEx(int set_sys_last_vars)

Part of the Stable ABI.

将标准回溯打印到 sys.stderr 并清除错误指示器。除非 错误是 SystemExit，这种情况下不会打印回溯进程，且会退出 Python 进程，并显示 SystemExit 实例指定的错误代码。

只有在错误指示器被设置时才需要调用这个函数，否则这会导致错误！

如果 set_sys_last_vars 非零，则变量 sys.last_type，sys.last_value 和 sys.last_traceback 将分别设置为打印异常的类型，值和回溯。

void PyErr_Print()

Part of the Stable ABI.

PyErr_PrintEx(1) 的别名。

void PyErr_WriteUnraisable(PyObject *obj)

Part of the Stable ABI.

使用当前异常和 obj 参数调用 sys.unraisablehook()。

当设置了异常，但解释器不可能实际地触发异常时，这个实用函数向 sys.stderr 打印一个警告信息。例如，当 __del__() 方法中发生异常时使用这个函数。

该函数使用单个参数 obj 进行调用，该参数标识发生不可触发异常的上下文。如果可能，obj 的报告将打印在警告消息中。

调用此函数时必须设置一个异常。

抛出异常

这些函数可帮助你设置当前线程的错误指示器。为了方便起见，一些函数将始终返回 NULL 指针，以便用于 return 语句。

void PyErr_SetString(PyObject *type, const char *message)

Part of the Stable ABI.

这是设置错误指示器最常用的方式。 第一个参数指定异常类型；它通常为某个标准异常，例如 PyExc_RuntimeError。 你无需为其创建新的 strong reference (例如使用 Py_INCREF())。 第二个参数是一条错误消息；它是用 'utf-8' 解码的。

void PyErr_SetObject(PyObject *type, PyObject *value)

Part of the Stable ABI.

此函数类似于 PyErr_SetString()，但是允许你为异常的“值”指定任意一个 Python 对象。

PyObject *PyErr_Format(PyObject *exception, const char *format, ...)

返回值：恒为 NULL。 Part of the Stable ABI.

这个函数设置了一个错误指示器并且返回了 NULL，exception 应当是一个 Python 中的异常类。format 和随后的形参会帮助格式化这个错误的信息；它们与 PyUnicode_FromFormat() 有着相同的含义和值。format 是一个ASCII编码的字符串。

PyObject *PyErr_FormatV(PyObject *exception, const char *format, va_list vargs)

返回值：恒为 NULL。 Part of the Stable ABI since version 3.5.

和 PyErr_Format() 相同，但它接受一个 va_list 类型的参数而不是可变数量的参数集。

3.5 新版功能.

void PyErr_SetNone(PyObject *type)

Part of the Stable ABI.

这是 PyErr_SetObject(type, Py_None) 的简写。

int PyErr_BadArgument()

Part of the Stable ABI.

这是 PyErr_SetString(PyExc_TypeError, message) 的简写，其中 message 指出使用了非法参数调用内置操作。它主要用于内部使用。

PyObject *PyErr_NoMemory()

返回值：恒为 NULL。 Part of the Stable ABI.

这是 PyErr_SetNone(PyExc_MemoryError) 的简写；它返回 NULL ，以便当内存耗尽时，对象分配函数可以写 return PyErr_NoMemory(); 。

PyObject *PyErr_SetFromErrno(PyObject *type)

返回值：恒为 NULL。 Part of the Stable ABI.

这是个便捷函数，当 C 库函数返回错误并设置 errno 时，这个函数会触发异常。它构造一个元组对象，其第一项是整数值 errno，第二项是相应的错误消息（从 strerror() 获取），然后调用 PyErr_SetObject(type, object)。在 Unix 上，当 errno 值是 EINTR ，即中断的系统调用时，这个函数会调用 PyErr_CheckSignals() ，如果设置了错误指示器，则将其设置为该值。该函数永远返回 NULL ，因此当系统调用返回错误时，围绕系统调用的包装函数可以写成 return PyErr_SetFromErrno(type);。

PyObject *PyErr_SetFromErrnoWithFilenameObject(PyObject *type, PyObject *filenameObject)

返回值：恒为 NULL。 Part of the Stable ABI.

类似于 PyErr_SetFromErrno() ，附加的行为是如果 filenameObject 不为 NULL ，它将作为第三个参数传递给 type 的构造函数。举个例子，在 OSError 异常中，filenameObject 将用来定义异常实例的 filename 属性。

PyObject *PyErr_SetFromErrnoWithFilenameObjects(PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)

返回值：恒为 NULL。 Part of the Stable ABI since version 3.7.

类似于 PyErr_SetFromErrnoWithFilenameObject() ，但接受第二个 filename 对象，用于当一个接受两个 filename 的函数失败时触发错误。

3.4 新版功能.

PyObject *PyErr_SetFromErrnoWithFilename(PyObject *type, const char *filename)

返回值：恒为 NULL。 Part of the Stable ABI.

类似于 PyErr_SetFromErrnoWithFilenameObject()，但文件名以 C 字符串形式给出。 filename 是用 filesystem encoding and error handler 解码的。

PyObject *PyErr_SetFromWindowsErr(int ierr)

返回值：恒为 NULL。 Part of the Stable ABI on Windows since version 3.7.

This is a convenience function to raise WindowsError. If called with ierr of 0, the error code returned by a call to GetLastError() is used instead. It calls the Win32 function FormatMessage() to retrieve the Windows description of error code given by ierr or GetLastError(), then it constructs a tuple object whose first item is the ierr value and whose second item is the corresponding error message (gotten from FormatMessage()), and then calls PyErr_SetObject(PyExc_WindowsError, object). This function always returns NULL.

可用性: Windows。

PyObject *PyErr_SetExcFromWindowsErr(PyObject *type, int ierr)

返回值：恒为 NULL。 Part of the Stable ABI on Windows since version 3.7.

类似于 PyErr_SetFromWindowsErr() ，额外的参数指定要触发的异常类型。

可用性: Windows。

PyObject *PyErr_SetFromWindowsErrWithFilename(int ierr, const char *filename)

返回值：恒为 NULL。 Part of the Stable ABI on Windows since version 3.7.

类似于 PyErr_SetFromWindowsErrWithFilenameObject() ，但是 filename 是以 C 字符串形式给出的。 filename 是从文件系统编码（os.fsdecode()）解码出来的。

可用性: Windows。

PyObject *PyErr_SetExcFromWindowsErrWithFilenameObject(PyObject *type, int ierr, PyObject *filename)

返回值：恒为 NULL。 Part of the Stable ABI on Windows since version 3.7.

类似于 PyErr_SetFromWindowsErrWithFilenameObject() ，额外参数指定要触发的异常类型。

可用性: Windows。

PyObject *PyErr_SetExcFromWindowsErrWithFilenameObjects(PyObject *type, int ierr, PyObject *filename, PyObject *filename2)

返回值：恒为 NULL。 Part of the Stable ABI on Windows since version 3.7.

类似于 PyErr_SetExcFromWindowsErrWithFilenameObject() ，但是接受第二个 filename 对象。

可用性: Windows。

3.4 新版功能.

PyObject *PyErr_SetExcFromWindowsErrWithFilename(PyObject *type, int ierr, const char *filename)

返回值：恒为 NULL。 Part of the Stable ABI on Windows since version 3.7.

类似于 PyErr_SetFromWindowsErrWithFilename() ，额外参数指定要触发的异常类型。

可用性: Windows。

PyObject *PyErr_SetImportError(PyObject *msg, PyObject *name, PyObject *path)

返回值：恒为 NULL。 Part of the Stable ABI since version 3.7.

这是触发 ImportError 的便捷函数。 msg 将被设为异常的消息字符串。 name 和 path ，（都可以为 NULL ），将用来被设置 ImportError 对应的属性 name 和 path。

3.3 新版功能.

PyObject *PyErr_SetImportErrorSubclass(PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)

返回值：恒为 NULL。 Part of the Stable ABI since version 3.6.

和 PyErr_SetImportError() 很类似，但这个函数允许指定一个 ImportError 的子类来触发。

3.6 新版功能.

void PyErr_SyntaxLocationObject(PyObject *filename, int lineno, int col_offset)

设置当前异常的文件，行和偏移信息。如果当前异常不是 SyntaxError ，则它设置额外的属性，使异常打印子系统认为异常是 SyntaxError。

3.4 新版功能.

void PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset)

Part of the Stable ABI since version 3.7.

类似于 PyErr_SyntaxLocationObject()，但 filename 是用 filesystem encoding and error handler 解码的字节串。

3.2 新版功能.

void PyErr_SyntaxLocation(const char *filename, int lineno)

Part of the Stable ABI.

类似于 PyErr_SyntaxLocationEx()，但省略了 col_offset parameter 形参。

void PyErr_BadInternalCall()

Part of the Stable ABI.

这是 PyErr_SetString(PyExc_SystemError, message) 的缩写，其中 message 表示使用了非法参数调用内部操作（例如，Python/C API 函数）。它主要用于内部使用。

发出警告

这些函数可以从 C 代码中发出警告。它们仿照了由 Python 模块 warnings 导出的那些函数。它们通常向 sys.stderr 打印一条警告信息；当然，用户也有可能已经指定将警告转换为错误，在这种情况下，它们将触发异常。也有可能由于警告机制出现问题，使得函数触发异常。如果没有触发异常，返回值为 0 ；如果触发异常，返回值为 -1。（无法确定是否实际打印了警告信息，也无法确定异常触发的原因。这是故意为之）。如果触发了异常，调用者应该进行正常的异常处理（例如，Py_DECREF() 持有引用并返回一个错误值）。

int PyErr_WarnEx(PyObject *category, const char *message, Py_ssize_t stack_level)

Part of the Stable ABI.

发出一个警告信息。参数 category 是一个警告类别（见下面）或 NULL ； message 是一个 UTF-8 编码的字符串。 stack_level 是一个给出栈帧数量的正数；警告将从该栈帧中当前正在执行的代码行发出。 stack_level 为 1 的是调用 PyErr_WarnEx() 的函数，2 是在此之上的函数，以此类推。

警告类别必须是 PyExc_Warning 的子类， PyExc_Warning 是 PyExc_Exception 的子类；默认警告类别是 PyExc_RuntimeWarning 。标准 Python 警告类别作为全局变量可用，所有其名称见 标准警告类别 。

有关警告控制的信息，参见模块文档 warnings 和命令行文档中的 -W 选项。没有用于警告控制的 C API。

int PyErr_WarnExplicitObject(PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)

发出一个对所有警告属性进行显式控制的警告消息。 这是位于 Python 函数 warnings.warn_explicit() 外层的直接包装；请查看其文档了解详情。 module 和 registry 参数可被设为 NULL 以得到相关文档所描述的默认效果。

3.4 新版功能.

int PyErr_WarnExplicit(PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)

Part of the Stable ABI.

类似于 PyErr_WarnExplicitObject() 不过 message 和 module 是 UTF-8 编码的字符串，而 filename 是由 filesystem encoding and error handler 解码的。

int PyErr_WarnFormat(PyObject *category, Py_ssize_t stack_level, const char *format, ...)

Part of the Stable ABI.

类似于 PyErr_WarnEx() 的函数，但使用 PyUnicode_FromFormat() 来格式化警告消息。 format 是使用 ASCII 编码的字符串。

3.2 新版功能.

int PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...)

Part of the Stable ABI since version 3.6.

类似于 PyErr_WarnFormat() 的函数，但 category 是 ResourceWarning 并且它会将 source 传给 warnings.WarningMessage()。

3.6 新版功能.

查询错误指示器

PyObject *PyErr_Occurred()

返回值：借入的引用。 Part of the Stable ABI.

测试是否设置了错误指示器。 如已设置，则返回异常 type (传给对某个 PyErr_Set* 函数或 PyErr_Restore() 的最后一次调用的第一个参数)。 如未设置，则返回 NULL。 你并不会拥有对返回值的引用，因此你不需要对它执行 Py_DECREF()。

调用时必须携带GIL。

注解

不要将返回值与特定的异常进行比较；请改为使用 PyErr_ExceptionMatches()，如下所示。 （比较很容易失败因为对于类异常来说，异常可能是一个实例而不是类，或者它可能是预期的异常的一个子类。）

int PyErr_ExceptionMatches(PyObject *exc)

Part of the Stable ABI.

等价于 PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)。 此函数应当只在实际设置了异常时才被调用；如果没有任何异常被引发则将发生非法内存访问。

int PyErr_GivenExceptionMatches(PyObject *given, PyObject *exc)

Part of the Stable ABI.

如果 given 异常与 exc 中的异常类型相匹配则返回真值。 如果 exc 是一个类对象，则当 given 是一个子类的实例时也将返回真值。 如果 exc 是一个元组，则该元组（以及递归的子元组）中的所有异常类型都将被搜索进行匹配。

void PyErr_Fetch(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)

Part of the Stable ABI.

将错误指示符提取到三个变量中并传递其地址。 如果未设置错误指示符，则将三个变量都设为 NULL。 如果已设置，则将其清除并且你将得到对所提取的每个对象的引用。 值和回溯对象可以为 NULL 即使类型对象不为空。

注解

此函数通常只被需要捕获异常的代码或需要临时保存和恢复错误指示符的代码所使用，例如:

{
   PyObject *type, *value, *traceback;
   PyErr_Fetch(&type, &value, &traceback);

   /* ... code that might produce other errors ... */

   PyErr_Restore(type, value, traceback);
}

void PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)

Part of the Stable ABI.

基于三个对象设置错误指示符。 如果错误指示符已设置，它将首先被清除。 如果三个对象均为 NULL，错误指示器将被清除。 请不要传入 NULL 类型和非 NULL 值或回溯。 异常类型应当是一个类。 请不要传入无效的异常类型或值。 （违反这些规则将导致微妙的后续问题。） 此调用会带走对每个对象的引用：你必须在调用之前拥有对每个对象的引用且在调用之后你将不再拥有这些引用。 （如果你不理解这一点，就不要使用此函数。 勿谓言之不预。）

注解

此函数通常只被需要临时保存和恢复错误指示符的代码所使用。 请使用 PyErr_Fetch() 来保存当前的错误指示符。

void PyErr_NormalizeException(PyObject **exc, PyObject **val, PyObject **tb)

Part of the Stable ABI.

在特定情况下，下面 PyErr_Fetch() 所返回的值可以是“非正规化的”，即 *exc 是一个类对象而 *val 不是同一个类的实例。 在这种情况下此函数可以被用来实例化类。 如果值已经是正规化的，则不做任何操作。 实现这种延迟正规化是为了提升性能。

注解

此函数 不会 显式地在异常值上设置 __traceback__ 属性。 如果想要适当地设置回溯，还需要以下附加代码片段:

if (tb != NULL) {
  PyException_SetTraceback(val, tb);
}

void PyErr_GetExcInfo(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)

Part of the Stable ABI since version 3.7.

提取异常信息，即从 sys.exc_info() 所得到的。 这是指一个 已被捕获 的异常，而不是刚被引发的异常。 返回分别指向三个对象的新引用，其中任何一个均可以为 NULL。 不会修改异常信息的状态。

注解

此函数通常不会被需要处理异常的代码所使用。 它被使用的场合是在代码需要临时保存并恢复异常状态的时候。 请使用 PyErr_SetExcInfo() 来恢复或清除异常状态。

3.3 新版功能.

void PyErr_SetExcInfo(PyObject *type, PyObject *value, PyObject *traceback)

Part of the Stable ABI since version 3.7.

设置异常信息，即从 sys.exc_info() 所得到的。 这是指一个 已被捕获 的异常，而不是刚被引发的异常。 此函数会偷取对参数的引用。 要清空异常状态，请为所有三个参数传入 NULL。 对于有关三个参数的一般规则，请参阅 PyErr_Restore()。

注解

此函数通常不会被需要处理异常的代码所使用。 它被使用的场合是在代码需要临时保存并恢复异常状态的情况。 请使用 PyErr_GetExcInfo() 来读取异常状态。

3.3 新版功能.

信号处理

int PyErr_CheckSignals()

Part of the Stable ABI.

这个函数与Python的信号处理交互。

如果在主 Python 解释器下从主线程调用该函数，它将检查是否向进程发送了信号，如果是，则唤起相应的信号处理器。 如果支持 signal 模块，则可以唤起以 Python 编写的信号处理器。

该函数会尝试处理所有待处理信号，然后返回 0。 但是，如果 Python 信号处理器引发了异常，则设置错误指示符并且函数将立即返回 -1 (这样其他待处理信号可能还没有被处理：它们将在下次唤起 PyErr_CheckSignals() 时被处理)。

如果函数从非主线程调用，或在非主Python解释器下调用，则它不执行任何操作并返回0。

这个函数可以由希望被用户请求(例如按Ctrl-C)中断的长时间运行的C代码调用。

注解

针对 SIGINT 的默认 Python 信号处理器会引发 KeyboardInterrupt 异常。

void PyErr_SetInterrupt()

Part of the Stable ABI.

模拟一个 SIGINT 信号到达的效果。 这等价于 PyErr_SetInterruptEx(SIGINT)。

注解

此函数是异步信号安全的。 它可以不带 GIL 并由 C 信号处理器来调用。

int PyErr_SetInterruptEx(int signum)

Part of the Stable ABI since version 3.10.

模拟一个信号到达的效果。 当下次 PyErr_CheckSignals() 被调用时，将会调用针对指定的信号编号的 Python 信号处理器。

此函数可由自行设置信号处理，并希望 Python 信号处理器会在请求中断时（例如当用户按下 Ctrl-C 来中断操作时）按照预期被唤起的 C 代码来调用。

如果给定的信号不是由 Python 来处理的 (即被设为 signal.SIG_DFL 或 signal.SIG_IGN)，它将会被忽略。

如果 signum 在被允许的信号编号范围之外，将返回 -1。 在其他情况下，则返回 0。 错误指示符绝不会被此函数所修改。

注解

此函数是异步信号安全的。 它可以不带 GIL 并由 C 信号处理器来调用。

3.10 新版功能.

int PySignal_SetWakeupFd(int fd)

这个工具函数指定了一个每当收到信号时将被作为以单个字节的形式写入信号编号的目标的文件描述符。 fd 必须是非阻塞的。 它将返回前一个这样的文件描述符。

设置值 -1 将禁用该特性；这是初始状态。 这等价于 Python 中的 signal.set_wakeup_fd()，但是没有任何错误检查。 fd 应当是一个有效的文件描述符。 此函数应当只从主线程来调用。

在 3.5 版更改: 在 Windows 上，此函数现在也支持套接字处理。

Exception 类

PyObject *PyErr_NewException(const char *name, PyObject *base, PyObject *dict)

返回值：新的引用。 Part of the Stable ABI.

这个工具函数会创建并返回一个新的异常类。 name 参数必须为新异常的名称，是 module.classname 形式的 C 字符串。 base 和 dict 参数通常为 NULL。 这将创建一个派生自 Exception 的类对象（在 C 中可以通过 PyExc_Exception 访问）。

新类的 __module__ 属性将被设为 name 参数的前半部分（最后一个点号之前），而类名将被设为后半部分（最后一个点号之后）。 base 参数可被用来指定替代基类；它可以是一个类或是一个由类组成的元组。 dict 参数可被用来指定一个由类变量和方法组成的字典。

PyObject *PyErr_NewExceptionWithDoc(const char *name, const char *doc, PyObject *base, PyObject *dict)

返回值：新的引用。 Part of the Stable ABI.

和 PyErr_NewException() 一样，除了可以轻松地给新的异常类一个文档字符串：如果 doc 属性非空，它将用作异常类的文档字符串。

3.2 新版功能.

异常对象

PyObject *PyException_GetTraceback(PyObject *ex)

返回值：新的引用。 Part of the Stable ABI.

将与异常相关联的回溯作为一个新引用返回，可以通过 __traceback__ 在 Python 中访问。 如果没有已关联的回溯，则返回 NULL。

int PyException_SetTraceback(PyObject *ex, PyObject *tb)

Part of the Stable ABI.

将异常关联的回溯设置为 tb 。使用 Py_None 清除它。

PyObject *PyException_GetContext(PyObject *ex)

返回值：新的引用。 Part of the Stable ABI.

将与异常相关联的上下文（在处理 ex 的过程中引发的另一个异常实例）作为一个新引用返回，可以通过 __context__ 在 Python 中访问。 如果没有已关联的上下文，则返回 NULL。

void PyException_SetContext(PyObject *ex, PyObject *ctx)

Part of the Stable ABI.

将与异常相关联的上下文设置为 ctx。 使用 NULL 来清空它。 没有用来确保 ctx 是一个异常实例的类型检查。 这将窃取一个指向 ctx 的引用。

PyObject *PyException_GetCause(PyObject *ex)

返回值：新的引用。 Part of the Stable ABI.

将与异常相关联的原因（一个异常实例，或是 None，由 raise ... from ... 设置）作为一个新引用返回，可在 Python 中通过 __cause__ 来访问。

void PyException_SetCause(PyObject *ex, PyObject *cause)

Part of the Stable ABI.

将与异常相关联的原因设置为 cause。 使用 NULL 来清空它。 它没有用来确保 cause 是一个异常实例或 None 的类型检查。 这将偷取一个指向 cause 的引用。

__suppress_context__ 会被此函数隐式地设为 True。

Unicode 异常对象

下列函数被用于创建和修改来自 C 的 Unicode 异常。

PyObject *PyUnicodeDecodeError_Create(const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)

返回值：新的引用。 Part of the Stable ABI.

创建一个 UnicodeDecodeError 对象并附带 encoding, object, length, start, end 和 reason 等属性。 encoding 和 reason 为 UTF-8 编码的字符串。

PyObject *PyUnicodeEncodeError_Create(const char *encoding, const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)

返回值：新的引用。

创建一个 UnicodeEncodeError 对象并附带 encoding, object, length, start, end 和 reason。 encoding 和 reason 都是以 UTF-8 编码的字符串。

3.3 版后已移除: 3.11

Py_UNICODE 自 Python 3.3 起已被弃用。 请迁移至 PyObject_CallFunction(PyExc_UnicodeEncodeError, "sOnns", ...)。

PyObject *PyUnicodeTranslateError_Create(const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)

返回值：新的引用。

创建一个 UnicodeTranslateError 对象并附带 object, length, start, end 和 reason。 reason 是一个以 UTF-8 编码的字符串。

3.3 版后已移除: 3.11

Py_UNICODE 自 Python 3.3 起已被弃用。 请迁移至 PyObject_CallFunction(PyExc_UnicodeTranslateError, "Onns", ...)。

PyObject *PyUnicodeDecodeError_GetEncoding(PyObject *exc)

PyObject *PyUnicodeEncodeError_GetEncoding(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

返回给定异常对象的 encoding 属性

PyObject *PyUnicodeDecodeError_GetObject(PyObject *exc)

PyObject *PyUnicodeEncodeError_GetObject(PyObject *exc)

PyObject *PyUnicodeTranslateError_GetObject(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

返回给定异常对象的 object 属性

int PyUnicodeDecodeError_GetStart(PyObject *exc, Py_ssize_t *start)

int PyUnicodeEncodeError_GetStart(PyObject *exc, Py_ssize_t *start)

int PyUnicodeTranslateError_GetStart(PyObject *exc, Py_ssize_t *start)

Part of the Stable ABI.

获取给定异常对象的 start 属性并将其放入 *start。 start 必须不为 NULL。 成功时返回 0，失败时返回 -1。

int PyUnicodeDecodeError_SetStart(PyObject *exc, Py_ssize_t start)

int PyUnicodeEncodeError_SetStart(PyObject *exc, Py_ssize_t start)

int PyUnicodeTranslateError_SetStart(PyObject *exc, Py_ssize_t start)

Part of the Stable ABI.

将给定异常对象的 start 属性设为 start。 成功时返回 0，失败时返回 -1。

int PyUnicodeDecodeError_GetEnd(PyObject *exc, Py_ssize_t *end)

int PyUnicodeEncodeError_GetEnd(PyObject *exc, Py_ssize_t *end)

int PyUnicodeTranslateError_GetEnd(PyObject *exc, Py_ssize_t *end)

Part of the Stable ABI.

获取给定异常对象的 end 属性并将其放入 *end。 end 必须不为 NULL。 成功时返回 0，失败时返回 -1。

int PyUnicodeDecodeError_SetEnd(PyObject *exc, Py_ssize_t end)

int PyUnicodeEncodeError_SetEnd(PyObject *exc, Py_ssize_t end)

int PyUnicodeTranslateError_SetEnd(PyObject *exc, Py_ssize_t end)

Part of the Stable ABI.

将给定异常对象的 end 属性设为 end。 成功时返回 0，失败时返回 -1。

PyObject *PyUnicodeDecodeError_GetReason(PyObject *exc)

PyObject *PyUnicodeEncodeError_GetReason(PyObject *exc)

PyObject *PyUnicodeTranslateError_GetReason(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

返回给定异常对象的 reason 属性

int PyUnicodeDecodeError_SetReason(PyObject *exc, const char *reason)

int PyUnicodeEncodeError_SetReason(PyObject *exc, const char *reason)

int PyUnicodeTranslateError_SetReason(PyObject *exc, const char *reason)

Part of the Stable ABI.

将给定异常对象的 reason 属性设为 reason。 成功时返回 0，失败时返回 -1。

递归控制

这两个函数提供了一种在 C 层级上进行安全的递归调用的方式，在核心模块与扩展模块中均适用。 当递归代码不一定会唤起 Python 代码（后者会自动跟踪其递归深度）时就需要用到它们。 它们对于 tp_call 实现来说也无必要因为 调用协议 会负责递归处理。

int Py_EnterRecursiveCall(const char *where)

Part of the Stable ABI since version 3.9.

标记一个递归的 C 层级调用即将被执行的点位。

如果定义了 USE_STACKCHECK，此函数会使用 PyOS_CheckStack() 来检查操作系统堆栈是否溢出。 在这种情况下，它将设置一个 MemoryError 并返回非零值。

随后此函数将检查是否达到递归限制。 如果是的话，将设置一个 RecursionError 并返回一个非零值。 在其他情况下，则返回零。

where 应为一个 UTF-8 编码的字符串如 " in instance check"，它将与由递归深度限制所导致的 RecursionError 消息相拼接。

在 3.9 版更改: 此函数现在也在受限 API 中可用。

void Py_LeaveRecursiveCall(void)

Part of the Stable ABI since version 3.9.

结束一个 Py_EnterRecursiveCall()。 必须针对 Py_EnterRecursiveCall() 的每个 成功的 唤起操作执行一次调用。

在 3.9 版更改: 此函数现在也在受限 API 中可用。

正确地针对容器类型实现 tp_repr 需要特别的递归处理。 在保护栈之外，tp_repr 还需要追踪对象以防止出现循环。 以下两个函数将帮助完成此功能。 从实际效果来说，这两个函数是 C 中对应 reprlib.recursive_repr() 的等价物。

int Py_ReprEnter(PyObject *object)

Part of the Stable ABI.

在 tp_repr 实现的开头被调用以检测循环。

如果对象已经被处理，此函数将返回一个正整数。 在此情况下 tp_repr 实现应当返回一个指明发生循环的字符串对象。 例如，dict 对象将返回 {...} 而 list 对象将返回 [...]。

如果已达到递归限制则此函数将返回一个负正数。 在此情况下 tp_repr 实现通常应当返回 NULL。

在其他情况下，此函数将返回零而 tp_repr 实现将可正常继续。

void Py_ReprLeave(PyObject *object)

Part of the Stable ABI.

结束一个 Py_ReprEnter()。 必须针对每个返回零的 Py_ReprEnter() 的唤起操作调用一次。

标准异常

所有的标准 Python 异常都可作为名称为 PyExc_ 跟上 Python 异常名称的全局变量来访问。 这些变量的类型为 PyObject*；它们都是类对象。 下面完整列出了全部的变量:

C 名称 | Python 名称 | 备注
PyExc_BaseException | BaseException | 1
PyExc_Exception | Exception | 1
PyExc_ArithmeticError | ArithmeticError | 1
PyExc_AssertionError | AssertionError |
PyExc_AttributeError | AttributeError |
PyExc_BlockingIOError | BlockingIOError |
PyExc_BrokenPipeError | BrokenPipeError |
PyExc_BufferError | BufferError |
PyExc_ChildProcessError | ChildProcessError |
PyExc_ConnectionAbortedError | ConnectionAbortedError |
PyExc_ConnectionError | ConnectionError |
PyExc_ConnectionRefusedError | ConnectionRefusedError |
PyExc_ConnectionResetError | ConnectionResetError |
PyExc_EOFError | EOFError |
PyExc_FileExistsError | FileExistsError |
PyExc_FileNotFoundError | FileNotFoundError |
PyExc_FloatingPointError | FloatingPointError |
PyExc_GeneratorExit | GeneratorExit |
PyExc_ImportError | ImportError |
PyExc_IndentationError | IndentationError |
PyExc_IndexError | IndexError |
PyExc_InterruptedError | InterruptedError |
PyExc_IsADirectoryError | IsADirectoryError |
PyExc_KeyError | KeyError |
PyExc_KeyboardInterrupt | KeyboardInterrupt |
PyExc_LookupError | LookupError | 1
PyExc_MemoryError | MemoryError |
PyExc_ModuleNotFoundError | ModuleNotFoundError |
PyExc_NameError | NameError |
PyExc_NotADirectoryError | NotADirectoryError |
PyExc_NotImplementedError | NotImplementedError |
PyExc_OSError | OSError | 1
PyExc_OverflowError | OverflowError |
PyExc_PermissionError | PermissionError |
PyExc_ProcessLookupError | ProcessLookupError |
PyExc_RecursionError | RecursionError |
PyExc_ReferenceError | ReferenceError |
PyExc_RuntimeError | RuntimeError |
PyExc_StopAsyncIteration | StopAsyncIteration |
PyExc_StopIteration | StopIteration |
PyExc_SyntaxError | SyntaxError |
PyExc_SystemError | SystemError |
PyExc_SystemExit | SystemExit |
PyExc_TabError | TabError |
PyExc_TimeoutError | TimeoutError |
PyExc_TypeError | TypeError |
PyExc_UnboundLocalError | UnboundLocalError |
PyExc_UnicodeDecodeError | UnicodeDecodeError |
PyExc_UnicodeEncodeError | UnicodeEncodeError |
PyExc_UnicodeError | UnicodeError |
PyExc_UnicodeTranslateError | UnicodeTranslateError |
PyExc_ValueError | ValueError |
PyExc_ZeroDivisionError | ZeroDivisionError |

3.3 新版功能: PyExc_BlockingIOError, PyExc_BrokenPipeError, PyExc_ChildProcessError, PyExc_ConnectionError, PyExc_ConnectionAbortedError, PyExc_ConnectionRefusedError, PyExc_ConnectionResetError, PyExc_FileExistsError, PyExc_FileNotFoundError, PyExc_InterruptedError, PyExc_IsADirectoryError, PyExc_NotADirectoryError, PyExc_PermissionError, PyExc_ProcessLookupError and PyExc_TimeoutError 介绍如下 PEP 3151 [https://www.python.org/dev/peps/pep-3151].

3.5 新版功能: PyExc_StopAsyncIteration 和 PyExc_RecursionError.

3.6 新版功能: PyExc_ModuleNotFoundError.

这些是兼容性别名 PyExc_OSError:

C 名称 | 备注
PyExc_EnvironmentError |
PyExc_IOError |
PyExc_WindowsError | 2

在 3.3 版更改: 这些别名曾经是单独的异常类型。

注释：

1(1,2,3,4,5)

这是其他标准异常的基类。

2

仅在 Windows 中定义；检测是否定义了预处理程序宏 MS_WINDOWS ，以便保护用到它的代码。

标准警告类别

所有的标准 Python 警告类别都可以用作全局变量，其名称为 PyExc_ 加上 Python 异常名称。 这些类型是 PyObject* 类型；它们都是类对象。 以下列出了全部的变量名称:

C 名称 | Python 名称 | 备注
PyExc_Warning | Warning | 3
PyExc_BytesWarning | BytesWarning |
PyExc_DeprecationWarning | DeprecationWarning |
PyExc_FutureWarning | FutureWarning |
PyExc_ImportWarning | ImportWarning |
PyExc_PendingDeprecationWarning | PendingDeprecationWarning |
PyExc_ResourceWarning | ResourceWarning |
PyExc_RuntimeWarning | RuntimeWarning |
PyExc_SyntaxWarning | SyntaxWarning |
PyExc_UnicodeWarning | UnicodeWarning |
PyExc_UserWarning | UserWarning |

3.2 新版功能: PyExc_ResourceWarning.

注释：

3

这是其他标准警告类别的基类。

工具

本章中的函数执行各种实用工具任务，包括帮助 C 代码提升跨平台可移植性，在 C 中使用 Python 模块，以及解析函数参数并根据 C 中的值构建 Python 中的值等等。

操作系统实用工具

系统功能

过程控制

导入模块

数据 marshal 操作支持

解析参数并构建值变量

解析参数

字符串和缓存区

数字

其他对象

API 函数

创建变量

字符串转换与格式化

反射

编解码器注册与支持功能

Codec 查找API

用于Unicode编码错误处理程序的注册表API

操作系统实用工具

PyObject *PyOS_FSPath(PyObject *path)

返回值：新的引用。 Part of the Stable ABI since version 3.6.

返回 path 在文件系统中的表示形式。 如果该对象是一个 str 或 bytes 对象，则返回一个新的 strong reference。 如果对象实现了 os.PathLike 接口，则只要它是一个 str 或 bytes 对象就将返回 __fspath__()。 在其他情况下将引发 TypeError 并返回 NULL。

3.6 新版功能.

int Py_FdIsInteractive(FILE *fp, const char *filename)

如果名称为 filename 的标准 I/O 文件 fp 被确认为可交互的则返回真（非零）值。 isatty(fileno(fp)) 为真值的文件均属于这种情况。 如果全局旗标 Py_InteractiveFlag 为真值，此函数在 filename 指针为 NULL 或者其名称等于字符串 '<stdin>' 或 '???' 时也将返回真值。

void PyOS_BeforeFork()

Part of the Stable ABI on platforms with fork() since version 3.7.

在进程分叉之前准备某些内部状态的函数。 此函数应当在调用 fork() 或者任何类似的克隆当前进程的函数之前被调用。 只适用于定义了 fork() 的系统。

警告

C fork() 调用应当只在 "main" 线程 (位于 "main" 解释器) 中进行。 对于 PyOS_BeforeFork() 来说也是如此。

3.7 新版功能.

void PyOS_AfterFork_Parent()

Part of the Stable ABI on platforms with fork() since version 3.7.

在进程分叉之后更新某些内部状态的函数。 此函数应当在调用 fork() 或任何类似的克隆当前进程的函数之后被调用，无论进程克隆是否成功。 只适用于定义了 fork() 的系统。

警告

C fork() 调用应当只在 "main" 线程 (位于 "main" 解释器) 中进行。 对于 PyOS_AfterFork_Parent() 来说也是如此。

3.7 新版功能.

void PyOS_AfterFork_Child()

Part of the Stable ABI on platforms with fork() since version 3.7.

在进程分叉之后更新内部解释器状态的函数。 此函数必须在调用 fork() 或任何类似的克隆当前进程的函数之后在子进程中被调用，如果该进程有机会回调到 Python 解释器的话。 只适用于定义了 fork() 的系统。

警告

C fork() 调用应当只在 "main" 线程 (位于 "main" 解释器) 中进行。 对于 PyOS_AfterFork_Child() 来说也是如此。

3.7 新版功能.

参见

os.register_at_fork() 允许注册可被 PyOS_BeforeFork(), PyOS_AfterFork_Parent() 和 PyOS_AfterFork_Child() 调用的自定义 Python 函数。

void PyOS_AfterFork()

Part of the Stable ABI on platforms with fork().

在进程分叉之后更新某些内部状态的函数；如果要继续使用 Python 解释器则此函数应当在新进程中被调用。 如果已将一个新的可执行文件载入到新进程中，则不需要调用此函数。

3.7 版后已移除: 此函数已被 PyOS_AfterFork_Child() 取代。

int PyOS_CheckStack()

Part of the Stable ABI on platforms with USE_STACKCHECK since version 3.7.

当解释器的栈空间耗尽时返回真值。 这是一个可靠的检查，但仅在定义了 USE_STACKCHECK 时可用（目前在 Windows 上使用 Microsoft Visual C++ 编译器）。 USE_STACKCHECK 将被自动定义；你绝不应该在你自己的代码中改变此定义。

PyOS_sighandler_t PyOS_getsig(int i)

Part of the Stable ABI.

返回信号 i 的当前信号处理程序。 这是 sigaction() 或 signal() 的精简封装。 请不要直接调用这些函数！ PyOS_sighandler_t 是 void (*)(int) 的类型定义别名。

PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h)

Part of the Stable ABI.

将信号 i 的信号处理程序设为 h；返回旧的信号处理程序。这是 sigaction() 或 signal() 的精简封装。 不要直接调用这些函数！ PyOS_sighandler_t 是 void (*)(int) 的类型定义别名。

wchar_t *Py_DecodeLocale(const char *arg, size_t *size)

Part of the Stable ABI since version 3.7.

警告

此函数不应当被直接调用：请使用 PyConfig API 以及可确保 对 Python 进行预初始化 的 PyConfig_SetBytesString() 函数。

此函数不可在This function must not be called before 对 Python 进行预初始化 之前被调用以便正确地配置 LC_CTYPE 语言区域：请参阅 Py_PreInitialize() 函数。

使用 filesystem encoding and error handler 来解码一个字节串。 如果错误处理器为 surrogateescape 错误处理器，则不可解码的字节将被解码为 U+DC80..U+DCFF 范围内的字符；而如果一个字节序列可被解码为代理字符，则其中的字节会使用 surrogateescape 错误处理器来转义而不是解码它们。

返回一个指向新分配的由宽字符组成的字符串的指针，使用 PyMem_RawFree() 来释放内存。 如果 size 不为 NULL，则将排除了 null 字符的宽字符数量写入到 *size

在解码错误或内存分配错误时返回 NULL。 如果 size 不为 NULL，则 *size 将在内存错误时设为 (size_t)-1 或在解码错误时设为 (size_t)-2。

filesystem encoding and error handler 是由 PyConfig_Read() 来选择的: 参见 PyConfig 的 filesystem_encoding 和 filesystem_errors 等成员。

解码错误绝对不应当发生，除非 C 库有程序缺陷。

请使用 Py_EncodeLocale() 函数来将字符串编码回字节串。

参见

PyUnicode_DecodeFSDefaultAndSize() 和 PyUnicode_DecodeLocaleAndSize() 函数。

3.5 新版功能.

在 3.7 版更改: 现在此函数在 Python UTF-8 模式 下将使用 UTF-8 编码格式。

在 3.8 版更改: 现在如果在 Windows 上 Py_LegacyWindowsFSEncodingFlag 为零则此函数将使用 UTF-8 编码格式；

char *Py_EncodeLocale(const wchar_t *text, size_t *error_pos)

Part of the Stable ABI since version 3.7.

将一个由宽字符组成的字符串编码为 filesystem encoding and error handler。 如果错误处理器为 surrogateescape 错误处理器，则在 U+DC80..U+DCFF 范围内的代理字符会被转换为字节值 0x80..0xFF。

返回一个指向新分配的字节串的指针，使用 PyMem_Free() 来释放内存。 当发生编码错误或内存分配错误时返回 NULL。

如果 error_pos 不为 NULL，则成功时会将 *error_pos 设为 (size_t)-1，或是在发生编码错误时设为无效字符的索引号。

filesystem encoding and error handler 是由 PyConfig_Read() 来选择的: 参见 PyConfig 的 filesystem_encoding 和 filesystem_errors 等成员。

请使用 Py_DecodeLocale() 函数来将字节串解码回由宽字符组成的字符串。

警告

此函数不可在This function must not be called before 对 Python 进行预初始化 之前被调用以便正确地配置 LC_CTYPE 语言区域：请参阅 Py_PreInitialize() 函数。

参见

PyUnicode_EncodeFSDefault() 和 PyUnicode_EncodeLocale() 函数。

3.5 新版功能.

在 3.7 版更改: 现在此函数在 Python UTF-8 模式 下将使用 UTF-8 编码格式。

在 3.8 版更改: 现在如果在 Windows 上 Py_LegacyWindowsFSEncodingFlag 为零则此函数将使用 UTF-8 编码格式。

系统功能

这些是使来自 sys 模块的功能可以让 C 代码访问的工具函数。 它们都可用于当前解释器线程的 sys 模块的字典，该字典包含在内部线程状态结构体中。

PyObject *PySys_GetObject(const char *name)

返回值：借入的引用。 Part of the Stable ABI.

返回来自 sys 模块的对象 name 或者如果它不存在则返回 NULL，并且不会设置异常。

int PySys_SetObject(const char *name, PyObject *v)

Part of the Stable ABI.

将 sys 模块中的 name 设为 v 除非 v 为 NULL，在此情况下 name 将从 sys 模块中被删除。 成功时返回 0，发生错误时返回 -1。

void PySys_ResetWarnOptions()

Part of the Stable ABI.

将 sys.warnoptions 重置为空列表。 此函数可在 Py_Initialize() 之前被调用。

void PySys_AddWarnOption(const wchar_t *s)

Part of the Stable ABI.

将 s 添加到 sys.warnoptions。 此函数必须在 Py_Initialize() 之前被调用以便影响警告过滤器列表。

void PySys_AddWarnOptionUnicode(PyObject *unicode)

Part of the Stable ABI.

将 unicode 添加到 sys.warnoptions。

注意：目前此函数不可在 CPython 实现之外使用，因为它必须在 Py_Initialize() 中的 warnings 显式导入之前被调用，但是要等运行时已初始化到足以允许创建 Unicode 对象时才能被调用。

void PySys_SetPath(const wchar_t *path)

Part of the Stable ABI.

将 sys.path 设为由在 path 中找到的路径组成的列表对象，该参数应为使用特定平台的搜索路径分隔符 (在 Unix 上为 :，在 Windows 上为 ;) 分隔的路径的列表。

void PySys_WriteStdout(const char *format, ...)

Part of the Stable ABI.

将以 format 描述的输出字符串写入到 sys.stdout。 不会引发任何异常，即使发生了截断（见下文）。

format 应当将已格式化的输出字符串的总大小限制在 1000 字节以下 -- 超过 1000 字节后，输出字符串会被截断。 特别地，这意味着不应出现不受限制的 "%s" 格式；它们应当使用 "%.<N>s" 来限制，其中 <N> 是一个经计算使得 <N> 与其他已格式化文本的最大尺寸之和不会超过 1000 字节的十进制数字。 还要注意 "%f"，它可能为非常大的数字打印出数以百计的数位。

如果发生了错误，sys.stdout 会被清空，已格式化的消息将被写入到真正的 (C 层级) stdout。

void PySys_WriteStderr(const char *format, ...)

Part of the Stable ABI.

类似 PySys_WriteStdout()，但改为写入到 sys.stderr 或 stderr。

void PySys_FormatStdout(const char *format, ...)

Part of the Stable ABI.

类似 PySys_WriteStdout() 的函数将会使用 PyUnicode_FromFormatV() 来格式化消息并且不会将消息截短至任意长度。

3.2 新版功能.

void PySys_FormatStderr(const char *format, ...)

Part of the Stable ABI.

类似 PySys_FormatStdout()，但改为写入到 sys.stderr 或 stderr。

3.2 新版功能.

void PySys_AddXOption(const wchar_t *s)

Part of the Stable ABI since version 3.7.

将 s 解析为一个由 -X 选项组成的集合并将它们添加到 PySys_GetXOptions() 所返回的当前选项映射。 此函数可以在 Py_Initialize() 之前被调用。

3.2 新版功能.

PyObject *PySys_GetXOptions()

返回值：借入的引用。 Part of the Stable ABI since version 3.7.

返回当前 -X 选项的字典，类似于 sys._xoptions。 发生错误时，将返回 NULL 并设置一个异常。

3.2 新版功能.

int PySys_Audit(const char *event, const char *format, ...)

引发一个审计事件并附带任何激活的钩子。 成功时返回零值或在失败时返回非零值并设置一个异常。

如果已添加了任何钩子，则将使用 format 和其他参数来构造一个用入传入的元组。 除 N 以外，在 Py_BuildValue() 中使用的格式字符均可使用。 如果构建的值不是一个元组，它将被添加到一个单元素元组中。 （格式选项 N 会消耗一个引用，但是由于没有办法知道此函数的参数是否将被消耗，因此使用它可能导致引用泄漏。）

请注意 # 格式字符应当总是被当作 Py_ssize_t 来处理，无论是否定义了 PY_SSIZE_T_CLEAN。

sys.audit() 会执行与来自 Python 代码的函数相同的操作。

3.8 新版功能.

在 3.8.2 版更改: 要求 Py_ssize_t 用于 # 格式字符。 在此之前，会引发一个不可避免的弃用警告。

int PySys_AddAuditHook(Py_AuditHookFunction hook, void *userData)

将可调用对象 hook 添加到激活的审计钩子列表。 在成功时返回零而在失败时返回非零值。 如果运行时已经被初始化，还会在失败时设置一个错误。 通过此 API 添加的钩子会针对在运行时创建的所有解释器被调用。

userData 指针会被传入钩子函数。 因于钩子函数可能由不同的运行时调用，该指针不应直接指向 Python 状态。

此函数可在 Py_Initialize() 之前被安全地调用。 如果在运行时初始化之后被调用，现有的审计钩子将得到通知并可能通过引发一个从 Exception 子类化的错误静默地放弃操作（其他错误将不会被静默）。

这个钩子函数的类型为 int (*)(const char *event, PyObject *args, void *userData)，其中 args 会保证为 PyTupleObject。 这个钩子函数总是会附带引发该事件的 Python 解释器所持有的 GIL 来调用。

请参阅 PEP 578 [https://www.python.org/dev/peps/pep-0578] 了解有关审计的详细描述。 在运行时和标准库中会引发审计事件的函数清单见 审计事件表。 更多细节见每个函数的文档。

如果解释器已被初始化，此函数将引发审计事件 sys.addaudithook 且不附带任何参数。 如果有任何现存的钩子引发了一个派生自 Exception 的异常，新的钩子将不会被添加且该异常会被清除。 因此，调用方不可假定他们的钩子已被添加除非他们能控制所有现存的钩子。

3.8 新版功能.

过程控制

void Py_FatalError(const char *message)

Part of the Stable ABI.

打印一个致命错误消息并杀掉进程。 不会执行任何清理。 此函数应当仅在检测到可能令继续使用 Python 解释器变得危险的条件时被发起调用；例如，当对象管理已被破坏的时候。 在 Unix 上，标准 C 库函数 abort() 会被调用并将由它来尝试产生一个 core 文件。

The Py_FatalError() function is replaced with a macro which logs automatically the name of the current function, unless the Py_LIMITED_API macro is defined.

在 3.9 版更改: 自动记录函数名称。

void Py_Exit(int status)

Part of the Stable ABI.

退出当前进程。 这将调用 Py_FinalizeEx() 然后再调用标准 C 库函数 exit(status)。 如果 Py_FinalizeEx() 提示错误，退出状态将被设为 120。

在 3.6 版更改: 来自最终化的错误不会再被忽略。

int Py_AtExit(void (*func)())

Part of the Stable ABI.

注册一个由 Py_FinalizeEx() 调用的清理函数。 调用清理函数将不传入任何参数且不应返回任何值。 最多可以注册32 个清理函数。 当注册成功时，Py_AtExit() 将返回 0；失败时，它将返回 -1。 最后注册的清理函数会最先被调用。 每个清理函数将至多被调用一次。 由于 Python 的内部最终化将在清理函数之前完成，因此 Python API 不应被 func 调用。

导入模块

PyObject *PyImport_ImportModule(const char *name)

返回值：新的引用。 Part of the Stable ABI.

这是下面 PyImport_ImportModuleEx() 的简化版接口，将 globals 和 locals 参数设为 NULL 并将 level 设为 0。 当 name 参数包含一个点号（即指定了一个包的子模块）时，fromlist 参数会被设为列表 ['*'] 这样返回值将为所指定的模块而不像在其他情况下那样为包含模块的最高层级包。 （不幸的是，这在 name 实际上是指定一个子包而非子模块时将有一个额外的副作用：在包的 __all__ 变量中指定的子模块会被加载。） 返回一个对所导入模块的新引用，或是在导入失败时返回 NULL 并设置一个异常。 模块导入失败同模块不会留 在 sys.modules 中。

该函数总是使用绝对路径导入。

PyObject *PyImport_ImportModuleNoBlock(const char *name)

返回值：新的引用。 Part of the Stable ABI.

该函数是 PyImport_ImportModule() 的一个被遗弃的别名。

在 3.3 版更改: 在导入锁被另一线程掌控时此函数会立即失败。 但是从 Python 3.3 起，锁方案在大多数情况下都已切换为针对每个模块加锁，所以此函数的特殊行为已无必要。

PyObject *PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)

返回值：新的引用。

导入一个模块。 请参阅内置 Python 函数 __import__() 获取完善的相关描述。

返回值是一个对所导入模块或最高层级包的新引用，或是在导入失败时则为 NULL 并设置一个异常。 与 __import__() 类似，当请求一个包的子模块时返回值通常为该最高层级包，除非给出了一个非空的 fromlist。

导入失败将移动不完整的模块对象，就像 PyImport_ImportModule() 那样。

PyObject *PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

导入一个模块。 关于此函数的最佳说明请参考内置 Python 函数 __import__()，因为标准 __import__() 函数会直接调用此函数。

返回值是一个对所导入模块或最高层级包的新引用，或是在导入失败时则为 NULL 并设置一个异常。 与 __import__() 类似，当请求一个包的子模块时返回值通常为该最高层级包，除非给出了一个非空的 fromlist。

3.3 新版功能.

PyObject *PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)

返回值：新的引用。 Part of the Stable ABI.

类似于 PyImport_ImportModuleLevelObject()，但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。

在 3.3 版更改: 不再接受 level 为负数值。

PyObject *PyImport_Import(PyObject *name)

返回值：新的引用。 Part of the Stable ABI.

这是一个调用了当前“导入钩子函数”的更高层级接口（显式指定 level 为 0，表示绝对导入）。 它将唤起当前全局作用域下 __builtins__ 中的 __import__() 函数。 这意味着将使用当前环境下安装的任何导入钩子来完成导入。

该函数总是使用绝对路径导入。

PyObject *PyImport_ReloadModule(PyObject *m)

返回值：新的引用。 Part of the Stable ABI.

重载一个模块。 返回一个指向被重载模块的新引用，或者在失败时返回 NULL 并设置一个异常（在此情况下模块仍然会存在）。

PyObject *PyImport_AddModuleObject(PyObject *name)

返回值：借入的引用。 Part of the Stable ABI since version 3.7.

返回对应于某个模块名称的模块对象。 name 参数的形式可以为 package.module。 如果存在 modules 字典则首先检查该字典，如果找不到，则创建一个新模块并将其插入到 modules 字典。 在失败时返回 NULL 并设置一个异常。

注解

此函数不会加载或导入指定模块；如果模块还未被加载，你将得到一个空的模块对象。 请使用 PyImport_ImportModule() 或它的某个变体形式来导入模块。 name 使用带点号名称的包结构如果尚不存在则不会被创建。

3.3 新版功能.

PyObject *PyImport_AddModule(const char *name)

返回值：借入的引用。 Part of the Stable ABI.

类似于 PyImport_AddModuleObject()，但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。object.

PyObject *PyImport_ExecCodeModule(const char *name, PyObject *co)

返回值：新的引用。 Part of the Stable ABI.

给定一个模块名称（可能为 package.module 形式）和一个从 Pyhon 字节码文件读取或从内置函数 compile() 获取的代码对象，加载该模块。 返回对该模块对象的新引用，或者如果发生错误则返回 NULL 并设置一个异常。 在发生错误的情况下 name 会从 sys.modules 中被移除，即使 name 在进入 PyImport_ExecCodeModule() 时已存在于 sys.modules 中。 在 sys.modules 中保留未完全初始化的模块是危险的，因为导入这样的模块没有办法知道模块对象是否处于一种未知的（对于模块作业的意图来说可能是已损坏的）状态。

模块的 __spec__ 和 __loader__ 如果尚未设置的话，将被设置为适当的值。 相应 spec 的加载器（如果已设置）将被设为模块的 __loader__ 而在其他情况下设为 SourceFileLoader 的实例。

模块的 __file__ 属性将被设为代码对象的 co_filename。 如果适用，__cached__ 也将被设置。

如果模块已被导入则此函数将重载它。 请参阅 PyImport_ReloadModule() 了解重载模块的预定方式。

如果 name 指向一个形式为 package.module 的带点号的名称，则任何尚未创建的包结构仍然不会被创建。

另请参阅 PyImport_ExecCodeModuleEx() 和 PyImport_ExecCodeModuleWithPathnames()。

PyObject *PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)

返回值：新的引用。 Part of the Stable ABI.

类似于 PyImport_ExecCodeModule()，但如果 pathname 不为 NULL 则会被设为模块对象的 __file__ 属性的值。

参见 PyImport_ExecCodeModuleWithPathnames()。

PyObject *PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

类似于 PyImport_ExecCodeModuleEx()，但如果 cpathname 不为 NULL 则会被设为模块对象的 __cached__ 值。 在三个函数中，这是推荐使用的一个。

3.3 新版功能.

PyObject *PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)

返回值：新的引用。 Part of the Stable ABI.

类似于 PyImport_ExecCodeModuleObject()，但 name, pathname 和 cpathname 为 UTF-8 编码的字符串。如果 pathname 也被设为 NULL 则还会尝试根据 cpathname 推断出前者的值。

3.2 新版功能.

在 3.3 版更改: 如果只提供了字节码路径则会使用 imp.source_from_cache() 来计算源路径。

long PyImport_GetMagicNumber()

Part of the Stable ABI.

返回 Python 字节码文件（即 .pyc 文件）的魔数。 此魔数应当存在于字节码文件的开头四个字节中，按照小端字节序。 出错时返回 -1。

在 3.3 版更改: 失败时返回值 -1。

const char *PyImport_GetMagicTag()

Part of the Stable ABI.

针对 PEP 3147 [https://www.python.org/dev/peps/pep-3147] 格式的 Python 字节码文件名返回魔术标签字符串。 请记住在 sys.implementation.cache_tag 上的值是应当被用来代替此函数的更权威的值。

3.2 新版功能.

PyObject *PyImport_GetModuleDict()

返回值：借入的引用。 Part of the Stable ABI.

返回用于模块管理的字典 (即 sys.modules)。 请注意这是针对每个解释器的变量。

PyObject *PyImport_GetModule(PyObject *name)

返回值：新的引用。 Part of the Stable ABI since version 3.8.

返回给定名称的已导入模块。 如果模块尚未导入则返回 NULL 但不会设置错误。 如果查找失败则返回 NULL 并设置错误。

3.7 新版功能.

PyObject *PyImport_GetImporter(PyObject *path)

返回值：新的引用。 Part of the Stable ABI.

返回针对一个 sys.path/pkg.__path__ 中条目 path 的查找器对象，可能会通过 sys.path_importer_cache 字典来获取。 如果它尚未被缓存，则会遍历 sys.path_hooks 直至找到一个能处理该 path 条目的钩子。 如果没有可用的钩子则返回 None；这将告知调用方 path based finder 无法为该 path 条目找到查找器。 结果将缓存到 sys.path_importer_cache。 返回一个指向查找器对象的新引用。

int PyImport_ImportFrozenModuleObject(PyObject *name)

Part of the Stable ABI since version 3.7.

加载名称为 name 的已冻结模块。 成功时返回 1，如果未找到模块则返回 0，如果初始化失败则返回 -1 并设置一个异常。 要在加载成功后访问被导入的模块，请使用 PyImport_ImportModule()。 （请注意此名称有误导性 --- 如果模块已被导入此函数将重载它。）

3.3 新版功能.

在 3.4 版更改: __file__ 属性将不再在模块上设置。

int PyImport_ImportFrozenModule(const char *name)

Part of the Stable ABI.

类似于 PyImport_ImportFrozenModuleObject()，但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。

struct _frozen

这是针对已冻结模块描述器的结构类型定义，与由 freeze 工具所生成的一致 (请参看 Python 源代码发行版中的 Tools/freeze/)。 其定义可在 Include/import.h 中找到:

struct _frozen {
    const char *name;
    const unsigned char *code;
    int size;
};

const struct _frozen *PyImport_FrozenModules

该指针被初始化为指向一个 _frozen 记录的数组，以一个所有成员均为 NULL 或零的记录表示结束。 当一个冻结模块被导入时，它将在此表中被搜索。 第三方代码可以利用此方式来提供动态创建的冻结模块集。

int PyImport_AppendInittab(const char *name, PyObject *(*initfunc)(void))

Part of the Stable ABI.

向现有的内置模块表添加一个模块。 这是对 PyImport_ExtendInittab() 的便捷包装，如果无法扩展表则返回 -1。 新的模块可使用名称 name 来导入，并使用函数 initfunc 作为在第一次尝试导入时调用的初始化函数。 此函数应当在 Py_Initialize() 之前调用。

struct _inittab

描述内置模块列表中的一个条目的结构体。 每个结构体都给出了内置在解释器中的某个模块的名称和初始化函数。 名称是一个 ASCII 编码的字符串。 嵌入了 Python 的程序可以使用该结构体的数组来与 PyImport_ExtendInittab() 相结合以提供额外的内置模块。 该结构体在 Include/import.h 中被定义为:

struct _inittab {
    const char *name;           /* ASCII encoded string */
    PyObject* (*initfunc)(void);
};

int PyImport_ExtendInittab(struct _inittab *newtab)

将内置模块表添加一组模块。 newtab 数组必须以一个包含以 NULL 作为 name 字段的岗哨条目结束；未能提供岗哨值会导致内存错误。 成功时返回 0 或者如果无法分配足够内存来扩展内部表则返回 -1。 当发生失败时，将不会添加模块到内部表。 此函数必须在 Py_Initialize() 之前调用。

如果 Python 要被多次初始化，则 PyImport_AppendInittab() 或 PyImport_ExtendInittab() 必须在每次 Python 初始化之前调用。

数据 marshal 操作支持

这些例程允许 C 代码处理与 marshal 模块所用相同数据格式的序列化对象。 其中有些函数可用来将数据写入这种序列化格式，另一些函数则可用来读取并恢复数据。 用于存储 marshal 数据的文件必须以二进制模式打开。

数字值在存储时会将最低位字节放在开头。

此模块支持两种数据格式版本：第 0 版为历史版本，第 1 版本会在文件和 marshal 反序列化中共享固化的字符串。 第 2 版本会对浮点数使用二进制格式。 Py_MARSHAL_VERSION 指明了当前文件的格式（当前取值为 2）。

void PyMarshal_WriteLongToFile(long value, FILE *file, int version)

将一个 long 整数 value 以 marshal 格式写入 file。 这将只写入 value 中最低的 32 个比特位；无论本机的 long 类型的大小如何。 version 指明文件格式的版本。

此函数可能失败，在这种情况下它半设置错误提示符。 请使用 PyErr_Occurred() 进行检测。

void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version)

将一个 Python 对象 value 以 marshal 格式写入 file。 version 指明文件格式的版本。

此函数可能失败，在这种情况下它半设置错误提示符。 请使用 PyErr_Occurred() 进行检测。

PyObject *PyMarshal_WriteObjectToString(PyObject *value, int version)

返回值：新的引用。

返回一个包含 value 的 marshal 表示形式的字节串对象。 version 指明文件格式的版本。

以下函数允许读取并恢复存储为 marshal 格式的值。

long PyMarshal_ReadLongFromFile(FILE *file)

从打开用于读取的 FILE* 对应的数据流返回一个 C long。 使用此函数只能读取 32 位的值，无论本机 long 类型的大小如何。

发生错误时，将设置适当的异常 (EOFError) 并返回 -1。

int PyMarshal_ReadShortFromFile(FILE *file)

从打开用于读取的 FILE* 对应的数据流返回一个 C short。使用此函数只能读取 16 位的值，无论本机 short 类型的大小如何。

发生错误时，将设置适当的异常 (EOFError) 并返回 -1。

PyObject *PyMarshal_ReadObjectFromFile(FILE *file)

返回值：新的引用。

从打开用于读取的 FILE* 对应的数据流返回一个 Python 对象。

发生错误时，将设置适当的异常 (EOFError, ValueError 或 TypeError) 并返回 NULL。

PyObject *PyMarshal_ReadLastObjectFromFile(FILE *file)

返回值：新的引用。

从打开用于读取的 FILE* 对应的数据流返回一个 Python 对象。 不同于 PyMarshal_ReadObjectFromFile()，此函数假定将不再从该文件读取更多的对象，允许其将文件数据积极地载入内存，以便反序列化过程可以在内存中的数据上操作而不是每次从文件读取一个字节。 只有当你确定不会再从文件读取任何内容时方可使用此形式。

发生错误时，将设置适当的异常 (EOFError, ValueError 或 TypeError) 并返回 NULL。

PyObject *PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len)

返回值：新的引用。

从包含指向 data 的 len 个字节的字节缓冲区对应的数据流返回一个 Python 对象。

发生错误时，将设置适当的异常 (EOFError, ValueError 或 TypeError) 并返回 NULL。

解析参数并构建值变量

在创建你自己的扩展函数和方法时，这些函数是有用的。其它的信息和样例见 扩展和嵌入 Python 解释器 。

这些函数描述的前三个，PyArg_ParseTuple()，PyArg_ParseTupleAndKeywords()，以及 PyArg_Parse()，它们都使用 格式化字符串 来将函数期待的参数告知函数。这些函数都使用相同语法规则的格式化字符串。

解析参数

一个格式化字符串包含 0 或者更多的格式单元。一个格式单元用来描述一个 Python 对象；它通常是一个字符或者由括号括起来的格式单元序列。除了少数例外，一个非括号序列的格式单元通常对应这些函数的具有单一地址的参数。在接下来的描述中，双引号内的表达式是格式单元；圆括号 () 内的是对应这个格式单元的 Python 对象类型；方括号 [] 内的是传递的 C 变量(变量集)类型。

字符串和缓存区

这些格式允许将对象按照连续的内存块形式进行访问。你没必要提供返回的 unicode 字符或者字节区的原始数据存储。

除非另有说明，缓冲区是不会以空终止的。

有三种办法可以将字符串和缓冲区转换到 C 类型:

像 y* 和 s* 这样的格式会填充一个 Py_buffer 结构体。 这将锁定下层缓冲区以便调用者随后使用这个缓冲区即使是在 Py_BEGIN_ALLOW_THREADS 块中也不会有可变数据因大小调整或销毁所带来的风险。 因此，在你结束处理数据（或任何更早的中止场景）之前 你必须调用 PyBuffer_Release()。

es, es#, et 和 et# 等格式会分配结果缓冲区。 在你结束处理数据（或任何更早的中止场景）之后 你必须调用 PyMem_Free()。

其他格式接受一个 str 或只读的 bytes-like object，如 bytes，并向其缓冲区提供一个 const char * 指针。 在缓冲区是“被借入”的情况下：它将由对应的 Python 对象来管理，并共享此对象的生命期。 你不需要自行释放任何内存。

为确保下层缓冲区可以安全地被借入，对象的 PyBufferProcs.bf_releasebuffer 字段必须为 NULL。 这将不允许普通的可变对象如 bytearray，以及某些只读对象如 bytes 的 memoryview。

在这个 bf_releasebuffer 要求以外，没有用于验证输入对象是否为不可变对象的检查（例如它是否会接受可写缓冲区的请求，或者另一个线程是否能改变此数据）。

注解

对于所有 # 格式的变体（s#、y# 等），宏 PY_SSIZE_T_CLEAN 必须在包含 Python.h 之前定义。 在 Python 3.9 及更早版本上，如果定义了 PY_SSIZE_T_CLEAN 宏，则长度参数的类型为 Py_ssize_t，否则为 int。

s (str) [const char *]

将一个 Unicode 对象转换成一个指向字符串的 C 指针。一个指针指向一个已经存在的字符串，这个字符串存储的是传如的字符指针变量。C 字符串是已空结束的。Python 字符串不能包含嵌入的无效的代码点；如果由，一个 ValueError 异常会被引发。Unicode 对象被转化成 'utf-8' 编码的 C 字符串。如果转换失败，一个 UnicodeError 异常被引发。

注解

这个表达式不接受 bytes-like objects。如果你想接受文件系统路径并将它们转化成 C 字符串，建议使用 O& 表达式配合 PyUnicode_FSConverter() 作为 转化函数。

在 3.5 版更改: 以前，当 Python 字符串中遇到了嵌入的 null 代码点会引发 TypeError 。

s* (str or bytes-like object) [Py_buffer]

这个表达式既接受 Unicode 对象也接受类字节类型对象。它为由调用者提供的 Py_buffer 结构赋值。这里结果的 C 字符串可能包含嵌入的 NUL 字节。Unicode 对象通过 'utf-8' 编码转化成 C 字符串。

s# (str, read-only bytes-like object) [const char *, Py_ssize_t]

像是 s*，区别在于它提供了一个 借入的缓冲区。 结果存储在两个 C 变量中，第一个是指向 C 字符串的指针，第二个是其长度。 该字符串可能包含嵌入的空字节。 Unicode 对象会使用 'utf-8' 编码格式转换为 C 字符串。

z (str or None) [const char *]

与 s 类似，但 Python 对象也可能为 None，在这种情况下，C 指针设置为 NULL。

z* (str, bytes-like object or None) [Py_buffer]

与 s* 类似，但 Python 对象也可能为 None，在这种情况下，Py_buffer 结构的 buf 成员设置为 NULL。

z# (str, read-only bytes-like object 或者 None) [const char *, Py_ssize_t]

与 s# 类似，但 Python 对象也可能为 None，在这种情况下，C 指针设置为 NULL。

y (read-only bytes-like object) [const char *]

这个格式会将一个类字节对象转换为一个指向 借入的 字符串的 C 指针；它不接受 Unicode 对象。 字节缓冲区不可包含嵌入的空字节；如果包含这样的内容，将会引发 ValueError 异常。exception is raised.

在 3.5 版更改: 以前，当字节缓冲区中遇到了嵌入的 null 字节会引发 TypeError 。

y* (bytes-like object) [Py_buffer]

s* 的变式，不接受 Unicode 对象，只接受类字节类型变量。这是接受二进制数据的推荐方法。

y# (read-only bytes-like object) [const char *, Py_ssize_t]

s# 的变式，不接受 Unicode 对象，只接受类字节类型变量。

S (bytes) [PyBytesObject *]

要求 Python 对象为 bytes 对象，不尝试进行任何转换。 如果该对象不为 bytes 对象则会引发 TypeError。 C 变量也可被声明为 PyObject*。

Y (bytearray) [PyByteArrayObject *]

要求 Python 对象为 bytearray 对象，不尝试进行任何转换。 如果该对象不为 bytearray 对象则会引发 TypeError。 C 变量也可被声明为 PyObject*。

u (str) [const Py_UNICODE *]

将一个 Python Unicode 对象转化成指向一个以空终止的 Unicode 字符缓冲区的指针。你必须传入一个 Py_UNICODE 指针变量的地址，存储了一个指向已经存在的 Unicode 缓冲区的指针。请注意一个 Py_UNICODE 类型的字符宽度取决于编译选项(16 位或者 32 位)。Python 字符串必须不能包含嵌入的 null 代码点；如果有，引发一个 ValueError 异常。

在 3.5 版更改: 以前，当 Python 字符串中遇到了嵌入的 null 代码点会引发 TypeError 。

Deprecated since version 3.3, will be removed in version 3.12: 这是旧版样式 Py_UNICODE API; 请迁移至 PyUnicode_AsWideCharString().

u# (str) [const Py_UNICODE *, Py_ssize_t]

u 的变式，存储两个 C 变量，第一个指针指向一个 Unicode 数据缓存区，第二个是它的长度。它允许 null 代码点。

Deprecated since version 3.3, will be removed in version 3.12: 这是旧版样式 Py_UNICODE API; 请迁移至 PyUnicode_AsWideCharString().

Z (str 或 None) [const Py_UNICODE *]

与 u 类似，但 Python 对象也可能为 None，在这种情况下 Py_UNICODE 指针设置为 NULL。

Deprecated since version 3.3, will be removed in version 3.12: 这是旧版样式 Py_UNICODE API; 请迁移至 PyUnicode_AsWideCharString().

Z# (str 或 None) [const Py_UNICODE *, Py_ssize_t]

与 u# 类似，但 Python 对象也可能为 None，在这种情况下 Py_UNICODE 指针设置为 NULL。

Deprecated since version 3.3, will be removed in version 3.12: 这是旧版样式 Py_UNICODE API; 请迁移至 PyUnicode_AsWideCharString().

U (str) [PyObject *]

要求 Python 对象为 Unicode 对象，不尝试进行任何转换。 如果该对象不为 Unicode 对象则会引发 TypeError。 C 变量也可被声明为 PyObject*。

w* (可读写 bytes-like object) [Py_buffer]

这个表达式接受任何实现可读写缓存区接口的对象。它为调用者提供的 Py_buffer 结构赋值。缓冲区可能存在嵌入的 null 字节。当缓冲区使用完后调用者需要调用 PyBuffer_Release()。

es (str) [const char *encoding, char **buffer]

s 的变式，它将编码后的 Unicode 字符存入字符缓冲区。它只处理没有嵌 NUL 字节的已编码数据。

此格式需要两个参数。 第一个仅用作输入，并且必须为 const char*，它指向一个以 NUL 结束的字符串表示的编码格式名称，或者为 NULL，这种情况会使用 'utf-8' 编码格式。 如果 Python 无法识别指定的编码格式则会引发异常。 第二个参数必须为 char**；它所引用的指针值将被设为带有参数文本内容的缓冲区。 文本将以第一个参数所指定的编码格式进行编码。

PyArg_ParseTuple() 会分配一个足够大小的缓冲区，将编码后的数据拷贝进这个缓冲区并且设置 *buffer 引用这个新分配的内存空间。调用者有责任在使用后调用 PyMem_Free() 去释放已经分配的缓冲区。

et (str, bytes or bytearray) [const char *encoding, char **buffer]

和 es 相同，除了不用重编码传入的字符串对象。相反，它假设传入的参数是编码后的字符串类型。

es# (str) [const char *encoding, char **buffer, Py_ssize_t *buffer_length]

s# 的变式，它将已编码的 Unicode 字符存入字符缓冲区。不像 es 表达式，它允许传入的数据包含 NUL 字符。

它需要三个参数。 第一个仅用作输入，并且必须为 const char*，它指向一个以 NUL 结束的字符串表示的编码格式名称，或者为 NULL，这种情况会使用 'utf-8' 编码格式。 如果 Python 无法识别指定的编码格式则会引发异常。 第二个参数必须为 char**；它所引用的指针值将被设为带有参数文本内容的缓冲区。 文本将以第一个参数所指定的编码格式进行编码。 第三个参数必须为指向一个整数的指针；被引用的整数将被设为输出缓冲区中的字节数。

有两种操作方式：

如果 *buffer 指向 NULL 指针，则函数将分配所需大小的缓冲区，将编码的数据复制到此缓冲区，并设置 *buffer 以引用新分配的存储。 呼叫者负责调用 PyMem_Free() 以在使用后释放分配的缓冲区。

如果 *buffer 指向非 NULL 指针（已分配的缓冲区），则 PyArg_ParseTuple() 将使用此位置作为缓冲区，并将 *buffer_length 的初始值解释为缓冲区大小。 然后，它将将编码的数据复制到缓冲区，并终止它。 如果缓冲区不够大，将设置一个 ValueError。

在这两个例子中，*buffer_length 被设置为编码后结尾不为 NUL 的数据的长度。

et# (str, bytes 或 bytearray) [const char *encoding, char **buffer, Py_ssize_t *buffer_length]

和 es# 相同，除了不用重编码传入的字符串对象。相反，它假设传入的参数是编码后的字符串类型。

数字

b (int) [unsigned char]

将非负的 Python 整数转换为无符号的微整数，存储为一个 C unsigned char。

B (int) [unsigned char]

将 Python 整数转换为微整数并且不进行溢出检查，存储为一个 C unsigned char。

h (int) [short int]

将 Python 整数转换为 C short int。

H (int) [unsigned short int]

将 Python 整数转换为 C unsigned short int，不进行溢出检查。

i (int) [int]

将 Python 整数转换为 C int。

I (int) [unsigned int]

将 Python 整数转换为 C unsigned int，不进行溢出检查。

l (int) [long int]

将 Python 整数转换为 C long int。

k (int) [unsigned long]

将 Python 整数转换为 C unsigned long，不进行溢出检查。

L (int) [long long]

将 Python 整数转换为 C long long。

K (int) [unsigned long long]

将Python整数转换为C:C:expr:'unsigned long-long'，而不进行溢出检查。

n (int) [Py_ssize_t]

将一个 Python 整型转化成一个 C Py_ssize_t Python 元大小类型。

c (bytes 或者 bytearray 长度为 1) [char]

将一个 Python 字节类型，如一个长度为 1 的 bytes 或 bytearray 对象，转换为 C char 。

在 3.3 版更改: 允许 bytearray 类型的对象。

C (str 长度为 1) [int]

将一个 Python 字符，如一个长度为 1 的 str 对象，转换为 C int。

f (float) [float]

将一个 Python 浮点数转换为 C float。

d (float) [double]

将一个 Python 浮点数转换为 C double。

D (complex) [Py_complex]

将一个 Python 复数类型转化成一个 C Py_complex Python 复数类型。

其他对象

O (object) [PyObject *]

将 Python 对象（未经任何转换）存储到一个 C 对象指针中。 这样 C 程序就能接收到实际传递的对象。 对象的新 strong reference 不会被创建（即其引用计数不会增加）。 存储的指针将不为 NULL。

O! (object) [typeobject, PyObject *]

将一个 Python 对象存入一个 C 对象指针。 这类似于 O，但是接受两个 C 参数：第一个是 Python 类型对象的地址，第二个是存储对象指针的 C 变量 (类型为 PyObject*)。 如果 Python 对象不具有所要求的类型，则会引发 TypeError。

O& (object) [converter, anything]

通过 converter 函数将 Python 对象转换为 C 变量。这需要两个参数：第一个是函数，第二个是 C 变量（任意类型）的地址，转换为 void*。转换器 函数依次调用如下：

status = converter(object, address);

其中 object 是待转换的 Python 对象而 address 为传给 PyArg_Parse* 函数的 void* 参数。 返回的 status 应当以 1 代表转换成功而以 0 代表转换失败。 当转换失败时，converter 函数应当引发异常并让 address 的内容保持未修改状态。

如果 converter 返回 Py_CLEANUP_SUPPORTED ，则如果参数解析最终失败，它可能会再次调用该函数，从而使转换器有机会释放已分配的任何内存。在第二个调用中，object 参数将为 NULL ;因此，该参数将为 NULL ;因此，该参数将为 NULL ，因此，该参数将为 NULL （如果值）为 NULL address 的值与原始呼叫中的值相同。

在 3.1 版更改: Py_CLEANUP_SUPPORTED 被添加。

p (bool) [int]

测试传入的值是否为真(一个布尔判断)并且将结果转化为相对应的 C true/false 整型值。如果表达式为真置 1，假则置 0。它接受任何合法的 Python 值。参见 逻辑值检测 获取更多关于 Python 如何测试值为真的信息。

3.3 新版功能.

(items) (tuple) [matching-items]

对象必须是 Python 序列，它的长度是 items 中格式单元的数量。C 参数必须对应 items 中每一个独立的格式单元。序列中的格式单元可能有嵌套。

传递 "long" 整型(整型的值超过了平台的 LONG_MAX 限制)是可能的，然而没有进行适当的范围检测——当接收字段太小而接收不到值时，最重要的位被静默地截断(实际上，C 语言会在语义继承的基础上强制类型转换——期望的值可能会发生变化)。

格式化字符串中还有一些其他的字符具有特殊的涵义。这些可能并不嵌套在圆括号中。它们是：

|

表明在 Python 参数列表中剩下的参数都是可选的。C 变量对应的可选参数需要初始化为默认值——当一个可选参数没有指定时， PyArg_ParseTuple() 不能访问相应的 C 变量(变量集)的内容。

$

PyArg_ParseTupleAndKeywords() only：表明在 Python 参数列表中剩下的参数都是强制关键字参数。当前，所有强制关键字参数都必须也是可选参数，所以格式化字符串中 | 必须一直在 $ 前面。

3.3 新版功能.

:

格式单元的列表结束标志；冒号后的字符串被用来作为错误消息中的函数名(PyArg_ParseTuple() 函数引发的“关联值”异常)。

;

格式单元的列表结束标志；分号后的字符串被用来作为错误消息取代默认的错误消息。 : 和 ; 相互排斥。

请注意提供给调用者的任何 Python 对象引用都是 借入 引用；不要释放它们（即不要递减它们的引用计数）！

传递给这些函数的附加参数必须是由格式化字符串确定的变量的地址；这些都是用来存储输入元组的值。有一些情况，如上面的格式单元列表中所描述的，这些参数作为输入值使用；在这种情况下，它们应该匹配指定的相应的格式单元。

为了让转换成功，arg 对象必须匹配格式并且格式必须被用尽。 当成功时，PyArg_Parse* 函数将返回真值，否则将返回假值并引发适当的异常。 当 PyArg_Parse* 函数由于某个格式单元转换出错而失败时，该格式单元及其后续格式单元对应的地址上的变量都将保持原样。

API 函数

int PyArg_ParseTuple(PyObject *args, const char *format, ...)

Part of the Stable ABI.

解析一个函数的参数，表达式中的参数按参数位置顺序存入局部变量中。成功返回 true；失败返回 false 并且引发相应的异常。

int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)

Part of the Stable ABI.

和 PyArg_ParseTuple() 相同，然而它接受一个 va_list 类型的参数而不是可变数量的参数集。

int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...)

Part of the Stable ABI.

分析将位置参数和关键字参数同时转换为局部变量的函数的参数。 keywords 参数是关键字参数名称的 NULL 终止数组。 空名称表示 positional-only parameters。成功时返回 true;发生故障时，它将返回 false 并引发相应的异常。

在 3.6 版更改: 添加了 positional-only parameters 的支持。

int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)

Part of the Stable ABI.

和 PyArg_ParseTupleAndKeywords() 相同，然而它接受一个va_list类型的参数而不是可变数量的参数集。

int PyArg_ValidateKeywordArguments(PyObject*)

Part of the Stable ABI.

确保字典中的关键字参数都是字符串。这个函数只被使用于 PyArg_ParseTupleAndKeywords() 不被使用的情况下，后者已经不再做这样的检查。

3.2 新版功能.

int PyArg_Parse(PyObject *args, const char *format, ...)

Part of the Stable ABI.

函数被用来析构“旧类型”函数的参数列表——这些函数使用的 METH_OLDARGS 参数解析方法已从 Python 3 中移除。这不被推荐用于新代码的参数解析，并且在标准解释器中的大多数代码已被修改，已不再用于该目的。它仍然方便于分解其他元组，然而可能因为这个目的被继续使用。

int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)

Part of the Stable ABI.

A simpler form of parameter retrieval which does not use a format string to specify the types of the arguments. Functions which use this method to retrieve their parameters should be declared as METH_VARARGS in function or method tables. The tuple containing the actual parameters should be passed as args; it must actually be a tuple. The length of the tuple must be at least min and no more than max; min and max may be equal. Additional arguments must be passed to the function, each of which should be a pointer to a PyObject* variable; these will be filled in with the values from args; they will contain borrowed references. The variables which correspond to optional parameters not given by args will not be filled in; these should be initialized by the caller. This function returns true on success and false if args is not a tuple or contains the wrong number of elements; an exception will be set if there was a failure.

这是一个使用此函数的示例，取自 _weakref 帮助模块用来弱化引用的源代码：

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;
}

这个例子中调用 PyArg_UnpackTuple() 完全等价于调用 PyArg_ParseTuple():

PyArg_ParseTuple(args, "O|O:ref", &object, &callback)

创建变量

PyObject *Py_BuildValue(const char *format, ...)

返回值：新的引用。 Part of the Stable ABI.

基于类似 PyArg_Parse* 函数族所接受内容的格式字符串和一个值序列来创建一个新值。 返回该值或在发生错误的情况下返回 NULL；如果返回 NULL 则将引发一个异常。

Py_BuildValue() 并不一直创建一个元组。只有当它的格式化字符串包含两个或更多的格式单元才会创建一个元组。如果格式化字符串是空，它返回 None；如果它包含一个格式单元，它返回由格式单元描述的的任一对象。用圆括号包裹格式化字符串可以强制它返回一个大小为 0 或者 1 的元组。

当内存缓存区的数据以参数形式传递用来构建对象时，如 s 和 s# 格式单元，会拷贝需要的数据。调用者提供的缓冲区从来都不会被由 Py_BuildValue() 创建的对象来引用。换句话说，如果你的代码调用 malloc() 并且将分配的内存空间传递给 Py_BuildValue()，你的代码就有责任在 Py_BuildValue() 返回时调用 free() 。

在下面的描述中，双引号的表达式使格式单元；圆括号 () 内的是格式单元将要返回的 Python 对象类型；方括号 [] 内的是传递的 C 变量(变量集)的类型。

字符例如空格，制表符，冒号和逗号在格式化字符串中会被忽略(但是不包括格式单元，如 s#)。这可以使很长的格式化字符串具有更好的可读性。

s (str 或 None) [const char *]

使用 'utf-8' 编码将空终止的 C 字符串转换为 Python str 对象。如果 C 字符串指针为 NULL，则使用 None。

s# (str 或 None) [const char *, Py_ssize_t]

使用 'utf-8' 编码将 C 字符串及其长度转换为 Python str 对象。如果 C 字符串指针为 NULL，则长度将被忽略，并返回 None。

y (bytes) [const char *]

这将 C 字符串转换为 Python bytes 对象。 如果 C 字符串指针为 NULL，则返回 None。

y# (bytes) [const char *, Py_ssize_t]

这会将 C 字符串及其长度转换为一个 Python 对象。 如果该 C 字符串指针为 NULL，则返回 None。

z (str or None) [const char *]

和 s 一样。

z# (str 或 None) [const char *, Py_ssize_t]

和 s# 一样。

u (str) [const wchar_t *]

Convert a null-terminated wchar_t buffer of Unicode (UTF-16 or UCS-4) data to a Python Unicode object. If the Unicode buffer pointer is NULL, None is returned.

u# (str) [const wchar_t *, Py_ssize_t]

将 Unicode （UTF-16 或 UCS-4） 数据缓冲区及其长度转换为 Python Unicode 对象。 如果 Unicode 缓冲区指针为 NULL，则长度将被忽略，并返回 None。

U (str 或 None) [const char *]

和 s 一样。

U# (str 或 None) [const char *, Py_ssize_t]

和 s# 一样。

i (int) [int]

将一个基本 C int 转换为 Python 整数对象。

b (int) [char]

将一个基本 C char 转换为 Python 整数对象。

h (int) [short int]

将一个基本 C short int 转换为 Python 整数对象。

l (int) [long int]

将一个 C long int 转换为 Python 整数对象。

B (int) [unsigned char]

将一个 C unsigned char 转换为 Python 整数对象。

H (int) [unsigned short int]

将一个 C unsigned short int 转换为 Python 整数对象。

I (int) [unsigned int]

将一个 C unsigned int 转换为 Python 整数对象。

k (int) [unsigned long]

将一个 C unsigned long 转换为 Python 整数对象。

L (int) [long long]

将一个 C long long 转换为 Python 整数对象。

K (int) [unsigned long long]

将一个 C unsigned long long 转换为 Python 整数对象。

n (int) [Py_ssize_t]

将一个 C Py_ssize_t 类型转化为 Python 整型。

c (bytes 长度为1 ) [char]

将一个代表单个字节的 C int 转换为长度为 1 的 Python bytes 对象。

C (str 长度为 1) [int]

将一个代表单个字符的 C int 转换为长度为 1 的 Python str 对象。

d (float) [double]

将一个 C double 转换为 Python 浮点数。

f (float) [float]

将一个 C float 转换为 Python 浮点数。

D (complex) [Py_complex *]

将一个 C Py_complex 类型的结构转化为 Python 复数类型。

O (object) [PyObject *]

原封不动地传递一个 Python 对象，但为其创建一个新的 strong reference (即其引用计数加一)。 如果传入的对象是一个 NULL 指针，则会假定这是因为产生该参数的调用发现了错误并设置了异常。 因此，Py_BuildValue() 将返回 NULL 但不会引发异常。 如果尚未引发异常，则会设置 SystemError。

S (object) [PyObject *]

和 O 相同。

N (object) [PyObject *]

与 O 相同，但它不会创建新的 strong reference。 如果对象是通过调用参数列表中的对象构造器来创建的则该方法将很有用处。

O& (object) [converter, anything]

通过 converter 函数将 anything 转换为 Python 对象。 该函数在调用时附带 anything (它应当兼容 void*) 作为其参数并且应返回一个 "新的" Python 对象，或者如果发生错误则返回 NULL。

(items) (tuple) [matching-items]

将一个 C 变量序列转换成 Python 元组并保持相同的元素数量。

[items] (list) [相关的元素]

将一个 C 变量序列转换成 Python 列表并保持相同的元素数量。

{items} (dict) [相关的元素]

将一个C变量序列转换成 Python 字典。每一对连续的 C 变量对作为一个元素插入字典中，分别作为关键字和值。

如果格式字符串中出现错误，则设置 SystemError 异常并返回 NULL。

PyObject *Py_VaBuildValue(const char *format, va_list vargs)

返回值：新的引用。 Part of the Stable ABI.

和 Py_BuildValue() 相同，然而它接受一个 va_list 类型的参数而不是可变数量的参数集。

字符串转换与格式化

用于数字转换和格式化字符串输出的函数

int PyOS_snprintf(char *str, size_t size, const char *format, ...)

Part of the Stable ABI.

根据格式字符串 format 和额外参数，输出不超过 size 个字节到 str。 参见 Unix 手册页面 snprintf(3)。

int PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va)

Part of the Stable ABI.

根据格式字符串 format 和变量参数列表 va，输出不超过 size 个字节到 str。 参见 Unix 手册页面 vsnprintf(3)。

PyOS_snprintf() 和 PyOS_vsnprintf() 包装 C 标准库函数 snprintf() 和 vsnprintf() 。它们的目的是保证在极端情况下的一致行为，而标准 C 的函数则不然。

此包装器会确保 str[size-1] 在返回时始终为 '\0'。 它们从不写入超过 size 字节 (包括末尾的 '\0') 到 str。 两个函数都要求 str != NULL, size > 0, format != NULL 且 size < INT_MAX。 请注意这意味着不存在可确定所需缓冲区大小的 C99 n = snprintf(NULL, 0, ...) 的等价物。

这些函数的返回值（ rv ）应按照以下规则被解释：

当 0 <= rv < size 时，输出转换即成功并将 rv 个字符写入到 str (不包括末尾 str[rv] 位置的 '\0' 字节)。

当 rv >= size 时，输出转换会被截断并且需要一个具有 rv + 1 字节的缓冲区才能成功执行。 在此情况下 str[size-1] 为 '\0'。

当 rv < 0 时，"会发生不好的事情。" 在此情况下 str[size-1] 也为 '\0'，但 str 的其余部分是未定义的。 错误的确切原因取决于底层平台。

以下函数提供与语言环境无关的字符串到数字转换。

double PyOS_string_to_double(const char *s, char **endptr, PyObject *overflow_exception)

Part of the Stable ABI.

将字符串 s 转换为 double 类型，失败时会引发 Python 异常。 接受的字符串集合对应于可被 Python 的 float() 构造器所接受的字符集集合，除了 s 必须没有前导或尾随空格。 转换必须独立于当前的语言区域。

如果 endptr 是 NULL ，转换整个字符串。引发 ValueError 并且 返回 -1.0 如果字符串不是浮点数的有效的表达方式。

如果 endptr 不是 NULL ，尽可能多的转换字符串并将 *endptr 设置为指向第一个未转换的字符。如果字符串的初始段不是浮点数的有效的表达方式，将 *endptr 设置为指向字符串的开头，引发 ValueError 异常，并且返回 -1.0 。

如果 s 表示一个太大而不能存储在一个浮点数中的值（比方说， "1e500" 在许多平台上是一个字符串）然后如果 overflow_exception 是 NULL 返回 Py_HUGE_VAL （用适当的符号）并且不设置任何异常。 在其他方面， overflow_exception 必须指向一个 Python 异常对象；引发异常并返回 -1.0 。在这两种情况下，设置 *endptr 指向转换值之后的第一个字符。

如果在转换期间发生任何其他错误（比如一个内存不足的错误），设置适当的 Python 异常并且返回 -1.0 。

3.1 新版功能.

char *PyOS_double_to_string(double val, char format_code, int precision, int flags, int *ptype)

Part of the Stable ABI.

将 double val 转换为一个使用给定的 format_code, precision 和 flags 的字符串。

格式码 必须是以下其中之一, 'e', 'E', 'f', 'F', 'g', 'G' 或者 'r'。对于 'r' , 提供的 精度 必须是0。'r' 格式码指定了标准函数 repr() 格式。

flags 可以为零或者其他值 Py_DTSF_SIGN, Py_DTSF_ADD_DOT_0 或 Py_DTSF_ALT 或其组合：

Py_DTSF_SIGN 表示总是在返回的字符串前附加一个符号字符，即使 val 为非负数。

Py_DTSF_ADD_DOT_0 表示确保返回的字符串看起来不像是一个整数。

Py_DTSF_ALT 表示应用 "替代的" 格式化规则。 相关细节请参阅 PyOS_snprintf() '#' 定义文档。

如果 ptype 不为 NULL，则它指向的值将被设为 Py_DTST_FINITE, Py_DTST_INFINITE 或 Py_DTST_NAN 中的一个，分别表示 val 是一个有限数字、无限数字或非数字。

返回值是一个指向包含转换后字符串的 buffer 的指针，如果转换失败则为 NULL。 调用方要负责调用 PyMem_Free() 来释放返回的字符串。

3.1 新版功能.

int PyOS_stricmp(const char *s1, const char *s2)

字符串不区分大小写。该函数几乎与 strcmp() 的工作方式相同，只是它忽略了大小写。

int PyOS_strnicmp(const char *s1, const char *s2, Py_ssize_t size)

字符串不区分大小写。该函数几乎与 strncmp() 的工作方式相同，只是它忽略了大小写。

反射

PyObject *PyEval_GetBuiltins(void)

返回值：借入的引用。 Part of the Stable ABI.

返回当前执行帧中内置函数的字典，如果当前没有帧正在执行，则返回线程状态的解释器。

PyObject *PyEval_GetLocals(void)

返回值：借入的引用。 Part of the Stable ABI.

返回当前执行帧中局部变量的字典，如果没有当前执行的帧则返回 NULL。

PyObject *PyEval_GetGlobals(void)

返回值：借入的引用。 Part of the Stable ABI.

返回当前执行帧中全局变量的字典，如果没有当前执行的帧则返回 NULL。

PyFrameObject *PyEval_GetFrame(void)

返回值：借入的引用。 Part of the Stable ABI.

返回当前线程状态的帧，如果没有当前执行的帧则返回 NULL。

另请参阅 PyThreadState_GetFrame()。

PyFrameObject *PyFrame_GetBack(PyFrameObject *frame)

获取 frame 为下一个外部帧。

返回一个 strong reference，或者如果 frame 没有外部帧则返回 NULL。

frame 必须不为 NULL。

3.9 新版功能.

PyCodeObject *PyFrame_GetCode(PyFrameObject *frame)

Part of the Stable ABI since version 3.10.

获取 frame 的代码。

返回一个 strong reference。

frame 必须不为 NULL。 结果（帧的代码）不能为 NULL。

3.9 新版功能.

int PyFrame_GetLineNumber(PyFrameObject *frame)

Part of the Stable ABI since version 3.10.

返回 frame 当前正在执行的行号。

frame 必须不为 NULL。

const char *PyEval_GetFuncName(PyObject *func)

Part of the Stable ABI.

如果 func 是函数、类或实例对象，则返回它的名称，否则返回 func 的类型的名称。

const char *PyEval_GetFuncDesc(PyObject *func)

Part of the Stable ABI.

根据 func 的类型返回描述字符串。 返回值包括函数和方法的 "()", " constructor", " instance" 和 " object"。 与 PyEval_GetFuncName() 的结果连接，结果将是 func 的描述。

编解码器注册与支持功能

int PyCodec_Register(PyObject *search_function)

Part of the Stable ABI.

注册一个新的编解码器搜索函数。

作为副作用，其尝试加载 encodings 包，如果尚未完成，请确保它始终位于搜索函数列表的第一位。

int PyCodec_Unregister(PyObject *search_function)

Part of the Stable ABI since version 3.10.

注销一个编解码器搜索函数并清空注册表缓存。 如果指定搜索函数未被注册，则不做任何操作。 成功时返回 0。 出错时引发一个异常并返回 -1。

3.10 新版功能.

int PyCodec_KnownEncoding(const char *encoding)

Part of the Stable ABI.

根据注册的给定 encoding 的编解码器是否已存在而返回 1 或 0。此函数总能成功。

PyObject *PyCodec_Encode(PyObject *object, const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

泛型编解码器基本编码 API。

object 使用由 errors 所定义的错误处理方法传递给定 encoding 的编码器函数。 errors 可以为 NULL 表示使用为编码器所定义的默认方法。 如果找不到编码器则会引发 LookupError。

PyObject *PyCodec_Decode(PyObject *object, const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

泛型编解码器基本解码 API。

object 使用由 errors 所定义的错误处理方法传递给定 encoding 的解码器函数。 errors 可以为 NULL 表示使用为编解码器所定义的默认方法。 如果找不到编解码器则会引发 LookupError。

Codec 查找API

在下列函数中，encoding 字符串会被查找并转换为小写字母形式，这使得通过此机制查找编码格式实际上对大小写不敏感。 如果未找到任何编解码器，则将设置 KeyError 并返回 NULL。

PyObject *PyCodec_Encoder(const char *encoding)

返回值：新的引用。 Part of the Stable ABI.

为给定的 encoding 获取一个编码器函数。

PyObject *PyCodec_Decoder(const char *encoding)

返回值：新的引用。 Part of the Stable ABI.

为给定的 encoding 获取一个解码器函数。

PyObject *PyCodec_IncrementalEncoder(const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

为给定的 encoding 获取一个 IncrementalEncoder 对象。

PyObject *PyCodec_IncrementalDecoder(const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

为给定的 encoding 获取一个 IncrementalDecoder 对象。

PyObject *PyCodec_StreamReader(const char *encoding, PyObject *stream, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

为给定的 encoding 获取一个 StreamReader 工厂函数。

PyObject *PyCodec_StreamWriter(const char *encoding, PyObject *stream, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

为给定的 encoding 获取一个 StreamWriter 工厂函数。

用于Unicode编码错误处理程序的注册表API

int PyCodec_RegisterError(const char *name, PyObject *error)

Part of the Stable ABI.

在给定的 name 之下注册错误处理回调函数 error。 该回调函数将在一个编解码器遇到无法编码的字符/无法解码的字节数据并且 name 被指定为 encode/decode 函数调用的 error 形参时由该编解码器来调用。

该回调函数会接受一个 UnicodeEncodeError, UnicodeDecodeError 或 UnicodeTranslateError 的实例作为单独参数，其中包含关于有问题字符或字节序列及其在原始序列的偏移量信息（请参阅 Unicode 异常对象 了解提取此信息的函数详情）。 该回调函数必须引发给定的异常，或者返回一个包含有问题序列及相应替换序列的二元组，以及一个表示偏移量的整数，该整数指明应在什么位置上恢复编码/解码操作。

成功则返回 0，失败则返回 -1。

PyObject *PyCodec_LookupError(const char *name)

返回值：新的引用。 Part of the Stable ABI.

查找在 name 之下注册的错误处理回调函数。 作为特例还可以传入 NULL，在此情况下将返回针对 "strict" 的错误处理回调函数。

PyObject *PyCodec_StrictErrors(PyObject *exc)

返回值：恒为 NULL。 Part of the Stable ABI.

引发 exc 作为异常。

PyObject *PyCodec_IgnoreErrors(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

忽略 unicode 错误，跳过错误的输入。

PyObject *PyCodec_ReplaceErrors(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

使用 ? 或 U+FFFD 替换 unicode 编码错误。

PyObject *PyCodec_XMLCharRefReplaceErrors(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

使用 XML 字符引用替换 unicode 编码错误。

PyObject *PyCodec_BackslashReplaceErrors(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI.

使用反斜杠转义符 (\x, \u 和 \U) 替换 unicode 编码错误。

PyObject *PyCodec_NameReplaceErrors(PyObject *exc)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

使用 \N{...} 转义符替换 unicode 编码错误。

3.5 新版功能.

抽象对象层

本章中的函数与 Python对象交互，无论其类型，或具有广泛类的对象类型（例如，所有数值类型，或所有序列类型）。当使用对象类型并不适用时，他们会产生一个 Python 异常。

这些函数是不可能用于未正确初始化的对象的，如一个列表对象被 PyList_New() 创建，但其中的项目没有被设置为一些非 NULL 的值。

对象协议

调用协议

tp_call 协议

Vectorcall 协议

递归控制

Vectorcall 支持 API

调用对象的 API

调用支持 API

数字协议

序列协议

映射协议

迭代器协议

缓冲协议

缓冲区结构

缓冲区请求的类型

与请求无关的字段

只读，格式

形状，步幅，子偏移量

连续性的请求

复合请求

复杂数组

NumPy-风格：形状和步幅

PIL-风格：形状，步幅和子偏移量

缓冲区相关函数

旧缓冲协议

对象协议

PyObject *Py_NotImplemented

NotImplemented 单例，用于标记某个操作没有针对给定类型组合的实现。

Py_RETURN_NOTIMPLEMENTED

正确处理从 C 语言函数中返回 Py_NotImplemented 的问题（即新建一个指向 NotImplemented 的 strong reference 并返回它）。

int PyObject_Print(PyObject *o, FILE *fp, int flags)

将对象 o 写入到文件 fp。 出错时返回 -1 。 旗标参数被用于启用特定的输出选项。 目前唯一支持的选项是 Py_PRINT_RAW；如果给出该选项，则将写入对象的 str() 而不是 repr()。

int PyObject_HasAttr(PyObject *o, PyObject *attr_name)

Part of the Stable ABI.

如果 o 带有属性 attr_name，则返回 1，否则返回 0。这相当于 Python 表达式 hasattr(o, attr_name)。 此函数总是成功。

注意，在调用 __getattr__() 和 __getattribute__() 方法时发生的异常将被抑制。若要获得错误报告，请换用 PyObject_GetAttr() 。

int PyObject_HasAttrString(PyObject *o, const char *attr_name)

Part of the Stable ABI.

如果 o 带有属性 attr_name，则返回 1，否则返回 0。这相当于 Python 表达式 hasattr(o, attr_name)。 此函数总是成功。

注意，在调用 __getattr__() 和 __getattribute__() 方法并创建一个临时字符串对象时，异常将被抑制。若要获得错误报告，请换用 PyObject_GetAttrString() 。

PyObject *PyObject_GetAttr(PyObject *o, PyObject *attr_name)

返回值：新的引用。 Part of the Stable ABI.

从对象 o 中读取名为 attr_name 的属性。成功返回属性值，失败则返回 NULL。 这相当于 Python 表达式 o.attr_name。

PyObject *PyObject_GetAttrString(PyObject *o, const char *attr_name)

返回值：新的引用。 Part of the Stable ABI.

从对象 o 中读取一个名为 attr_name 的属性。成功时返回属性值，失败则返回 NULL。这相当于 Python 表达式 o.attr_name。

PyObject *PyObject_GenericGetAttr(PyObject *o, PyObject *name)

返回值：新的引用。 Part of the Stable ABI.

通用的属性获取函数，用于放入类型对象的 tp_getattro 槽中。它在类的字典中（位于对象的 MRO 中）查找某个描述符，并在对象的 __dict__ 中查找某个属性。正如 实现描述器 所述，数据描述符优先于实例属性，而非数据描述符则不优先。失败则会触发 AttributeError 。

int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v)

Part of the Stable ABI.

将对象 o 中名为 attr_name 的属性值设为 v 。失败时引发异常并返回 -1；成功时返 回 0 。这相当于 Python 语句 o.attr_name = v。

如果 v 为 NULL，该属性将被删除。 此行为已被弃用而应改用 PyObject_DelAttr()，但目前还没有移除它的计划。

int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v)

Part of the Stable ABI.

将对象 o 中名为 attr_name 的属性值设为 v 。失败时引发异常并返回 -1；成功时返 回 0 。这相当于 Python 语句 o.attr_name = v。

如果 v 为 NULL，该属性将被删除，但是此功能已被弃用而应改用 PyObject_DelAttrString()。

int PyObject_GenericSetAttr(PyObject *o, PyObject *name, PyObject *value)

Part of the Stable ABI.

通用的属性设置和删除函数，用于放入类型对象的 tp_setattro 槽。它在类的字典中（位于对象的MRO中）查找数据描述器，如果找到，则将比在实例字典中设置或删除属性优先执行。否则，该属性将在对象的 __dict__ 中设置或删除。如果成功将返回 0，否则将引发 AttributeError 并返回 -1。

int PyObject_DelAttr(PyObject *o, PyObject *attr_name)

删除对象 o 中名为 attr_name 的属性。失败时返回 -1。这相当于 Python 语句 del o.attr_name。

int PyObject_DelAttrString(PyObject *o, const char *attr_name)

删除对象 o 中名为 attr_name 的属性。失败时返回 -1。这相当于 Python 语句 del o.attr_name。

PyObject *PyObject_GenericGetDict(PyObject *o, void *context)

返回值：新的引用。 Part of the Stable ABI since version 3.10.

__dict__ 描述符的获取函数的一种通用实现。必要时会创建该字典。

3.3 新版功能.

int PyObject_GenericSetDict(PyObject *o, PyObject *value, void *context)

Part of the Stable ABI since version 3.7.

__dict__ 描述符设置函数的一种通用实现。这里不允许删除该字典。

3.3 新版功能.

PyObject *PyObject_RichCompare(PyObject *o1, PyObject *o2, int opid)

返回值：新的引用。 Part of the Stable ABI.

用 opid 指定的操作比较 o1 和 o2 的值，必须是 Py_LT 、 Py_LE 、 Py_EQ 、 Py_NE 、 Py_GT 或 Py_GE 之一，分别对应于``<、``<= 、== 、 != 、> 或 >=。这相当于 Python 表达式 o1 op o2，其中 op 是对应于 opid 的操作符。成功时返回比较值，失败时返回 NULL。

int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)

Part of the Stable ABI.

用 opid 指定的操作比较 o1 和 o2 的值，必须是 Py_LT 、 Py_LE 、 Py_EQ 、 Py_NE 、 Py_GT 或 Py_GE 之一，分别对应于 < 、<=、 == 、!= 、> 或 >=。错误时返回 -1，若结果为 false 则返回 0，否则返回 1。这相当于 Python 表达式 o1 op o2，其中 op 是对应于 opid 的操作符。

注解

如果 o1 和 o2 是同一个对象，PyObject_RichCompareBool() 为 Py_EQ 则返回 1 ，为 Py_NE 则返回 0。

PyObject *PyObject_Format(PyObject *obj, PyObject *format_spec)

Part of the Stable ABI.

格式 obj 使用 format_spec。 这等价于 Python 表达式 format(obj, format_spec)。

format_spec 可以为 NULL。 在此情况下调用将等价于 format(obj)。 成功时返回已格式化的字符串，失败时返回 NULL。

PyObject *PyObject_Repr(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

计算对象 o 的字符串形式。 成功时返回字符串，失败时返回 NULL。 这相当于 Python 表达式 repr(o)。 由内置函数 repr() 调用。

在 3.4 版更改: 该函数现在包含一个调试断言，用以确保不会静默地丢弃活动的异常。

PyObject *PyObject_ASCII(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

与 PyObject_Repr() 一样，计算对象 o 的字符串形式，但在 PyObject_Repr() 返回的字符串中用 \x、\u 或 \U 转义非 ASCII 字符。这将生成一个类似于 Python 2 中由 PyObject_Repr() 返回的字符串。由内置函数 ascii() 调用。

PyObject *PyObject_Str(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

计算对象 o 的字符串形式。 成功时返回字符串，失败时返回 NULL。 这相当于 Python 表达式 str(o)。由内置函数 str() 调用，因此也由 print() 函数调用。

在 3.4 版更改: 该函数现在包含一个调试断言，用以确保不会静默地丢弃活动的异常。

PyObject *PyObject_Bytes(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

计算对象 o 的字节形式。失败时返回 NULL，成功时返回一个字节串对象。这相当于 o 不是整数时的 Python 表达式 bytes(o) 。与 bytes(o) 不同的是，当 o 是整数而不是初始为 0 的字节串对象时，会触发 TypeError。

int PyObject_IsSubclass(PyObject *derived, PyObject *cls)

Part of the Stable ABI.

如果 derived 类与 cls 类相同或为其派生类，则返回 1，否则返回 0。 如果出错则返回 -1。

如果 cls 是元组，则会对 cls 进行逐项检测。如果至少有一次检测返回 1，结果将为 1，否则将是 0。

正如 PEP 3119 [https://www.python.org/dev/peps/pep-3119] 所述，如果 cls 带有 __subclasscheck__() 方法，将会被调用以确定子类的状态。 否则，如果 derived 是个直接或间接子类，即包含在 cls.__mro__ 中，那么它就是 cls 的一个子类。

通常只有类对象才会被视为类，即 type 或派生类的实例。然而，对象可以通过拥有 __bases__ 属性（必须是基类的元组）来覆盖这一点。

int PyObject_IsInstance(PyObject *inst, PyObject *cls)

Part of the Stable ABI.

如果 inst 是 cls 类或其子类的实例，则返回 1，如果不是则返回 0。 如果出错则返回 -1 并设置一个异常。

如果 cls 是元组，则会对 cls 进行逐项检测。如果至少有一次检测返回 1，结果将为 1，否则将是 0。

正如 PEP 3119 [https://www.python.org/dev/peps/pep-3119] 所述，如果 cls 带有 __subclasscheck__() 方法，将会被调用以确定子类的状态。 否则，如果 derived 是 cls 的子类，那么它就是 cls 的一个实例。

实例 inst 可以通过 __class__ 属性来覆盖其所属类。

对象 cls 是否被认作类，以及基类是什么，均可通过 __bases__ 属性（必须是基类的元组）进行覆盖。

Py_hash_t PyObject_Hash(PyObject *o)

Part of the Stable ABI.

计算并返回对象的哈希值 o。 失败时返回 -1。这相当于 Python 表达式 hash(o)。

在 3.2 版更改: 现在的返回类型是 Py_hash_t。 这是一个大小与 Py_ssize_t 相同的有符号整数。

Py_hash_t PyObject_HashNotImplemented(PyObject *o)

Part of the Stable ABI.

设置一个 TypeError 来指明 type(o) 不是 hashable 并返回 -1。 此函数在存储于 tp_hash 槽位内时会获得特别对待，允许某个类型显式地向解释器指明它是不可哈希对象。

int PyObject_IsTrue(PyObject *o)

Part of the Stable ABI.

如果对象 o 被认为是 true，则返回 1，否则返回 0。这相当于 Python 表达式 not not o。 失败则返回 -1。

int PyObject_Not(PyObject *o)

Part of the Stable ABI.

如果对象 o 被认为是 true，则返回 1，否则返回 0。这相当于 Python 表达式 not not o。 失败则返回 -1。

PyObject *PyObject_Type(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

当 o 不为 NULL 时，返回一个与对象 o 的类型相对应的类型对象。 当失败时，将引发 SystemError 并返回 NULL。 这等同于 Python 表达式 type(o)。 该函数会新建一个指向返回值的 strong reference。 实际上没有多少理由使用此函数来替代 Py_TYPE() 函数，后者将返回一个 PyTypeObject* 类型的指针，除非是需要一个新的 strong reference。

int PyObject_TypeCheck(PyObject *o, PyTypeObject *type)

如果对象 o 是 type 类型或其子类型，则返回非零，否则返回 0。两个参数都必须非 NULL。

Py_ssize_t PyObject_Size(PyObject *o)

Py_ssize_t PyObject_Length(PyObject *o)

Part of the Stable ABI.

返回对象 o 的长度。 如果对象 o 支持序列和映射协议，则返回序列长度。 出错时返回 -1。这等同于 Python 表达式 len(o)。

Py_ssize_t PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)

返回对象 o 的估计长度。首先尝试返回实际长度，然后用 __length_hint__() 进行估计，最后返回默认值。出错时返回 -1。这等同于 Python 表达式 operator.length_hint(o, defaultvalue)。

3.4 新版功能.

PyObject *PyObject_GetItem(PyObject *o, PyObject *key)

返回值：新的引用。 Part of the Stable ABI.

返回对象 key 对应的 o 元素，或在失败时返回 NULL。这等同于 Python 表达式 o[key]。

int PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v)

Part of the Stable ABI.

将对象 key 映射到值 v。 失败时引发异常并返回 -1；成功时返回 0。 这相当于 Python 语句 o[key] = v。该函数 不会 偷取 v 的引用计数。

int PyObject_DelItem(PyObject *o, PyObject *key)

Part of the Stable ABI.

从对象 o 中移除对象 key 的映射。失败时返回 -1。 这相当于 Python 语句 del o[key]。

PyObject *PyObject_Dir(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

相当于 Python 表达式 dir(o)，返回一个（可能为空）适合对象参数的字符串列表，如果出错则返回 NULL。 如果参数为 NULL，类似 Python 的 dir()，则返回当前 locals 的名字；这时如果没有活动的执行框架，则返回 NULL，但 PyErr_Occurred() 将返回 false。

PyObject *PyObject_GetIter(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

等同于 Python 表达式 iter(o)。为对象参数返回一个新的迭代器，如果该对象已经是一个迭代器，则返回对象本身。如果对象不能被迭代，会引发 TypeError ，并返回 NULL。

PyObject *PyObject_GetAIter(PyObject *o)

返回值：新的引用。 Part of the Stable ABI since version 3.10.

等同于 Python 表达式 aiter(o)。接受一个 AsyncIterable 对象，并为其返回一个 AsyncIterator。通常返回的是一个新迭代器，但如果参数是一个 AsyncIterator，将返回其自身。如果该对象不能被迭代，会引发 TypeError，并返回 NULL。

3.10 新版功能.

调用协议

CPython 支持两种不同的调用协议：tp_call 和矢量调用。

tp_call 协议

设置 tp_call 的类的实例都是可调用的。 槽位的签名为:

PyObject *tp_call(PyObject *callable, PyObject *args, PyObject *kwargs);

一个调用是用一个元组表示位置参数，用一个dict表示关键字参数，类似于Python代码中的 callable(*args, **kwargs)。args*必须是非空的（如果没有参数，会使用一个空元组），但如果没有关键字参数，*kwargs*可以是*NULL。

这个约定不仅被*tp_call*使用： tp_new 和 tp_init 也这样传递参数。

要调用一个对象，请使用 PyObject_Call() 或者其他的 调用 API。

Vectorcall 协议

3.9 新版功能.

vectorcall 协议是在 PEP 590 [https://www.python.org/dev/peps/pep-0590] 被引入的，它是使调用函数更加有效的附加协议。

作为经验法则，如果可调用程序支持 vectorcall，CPython 会更倾向于内联调用。 然而，这并不是一个硬性规定。 此外，一些第三方扩展直接使用 tp_call (而不是使用 PyObject_Call())。 因此，一个支持 vectorcall 的类也必须实现 tp_call。 此外，无论使用哪种协议，可调对象的行为都必须是相同的。 推荐的方法是将 tp_call 设置为 PyVectorcall_Call()。值得一提的是:

警告

一个支持 Vectorcall 的类 必须 也实现具有相同语义的 tp_call。

如果一个类的vectorcall比*tp_call*慢，就不应该实现vectorcall。例如，如果被调用者需要将参数转换为args 元组和kwargs dict，那么实现vectorcall就没有意义。

类可以通过启用 Py_TPFLAGS_HAVE_VECTORCALL 标志并将 tp_vectorcall_offset 设置为对象结构中的 vectorcallfunc 的 offset 来实现 vectorcall 协议。这是一个指向具有以下签名的函数的指针:

typedef PyObject *(*vectorcallfunc)(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)

callable 是指被调用的对象。

args 是一个C语言数组，由位置参数和后面的

关键字参数的值。如果没有参数，这个值可以是 NULL 。

nargsf 是位置参数的数量加上可能的

PY_VECTORCALL_ARGUMENTS_OFFSET 标志。 要从 nargsf 获得实际的位置参数数，请使用 PyVectorcall_NARGS()。

kwnames 是一包含所有关键字名称的元组。

换句话说，就是 kwargs 字典的键。 这些名字必须是字符串 (str 或其子类的实例)，并且它们必须是唯一的。 如果没有关键字参数，那么 kwnames 可以用 NULL 代替。

PY_VECTORCALL_ARGUMENTS_OFFSET

如果在 vectorcall 的 nargsf 参数中设置了此标志，则允许被调用者临时更改 args[-1] 的值。换句话说， args 指向分配向量中的参数 1（不是 0 ）。被调用方必须在返回之前还原 args[-1] 的值。

对于 PyObject_VectorcallMethod() ，这个标志的改变意味着 args[0] 可能改变了。

当调用方可以以几乎无代价的方式（无额外的内存申请），那么调用者被推荐适用： PY_VECTORCALL_ARGUMENTS_OFFSET。这样做将允许诸如绑定方法之类的可调用函数非常有效地进行向前调用（其中包括一个带前缀的 self 参数）。

要调用一个实现了 vectorcall 的对象，请使用某个 call API 函数，就像其他可调对象一样。 PyObject_Vectorcall() 通常是最有效的。

注解

在 CPython 3.8 中，vectorcall API 和相关的函数暂定以带开头下划线的名称提供: _PyObject_Vectorcall, _Py_TPFLAGS_HAVE_VECTORCALL, _PyObject_VectorcallMethod, _PyVectorcall_Function, _PyObject_CallOneArg, _PyObject_CallMethodNoArgs, _PyObject_CallMethodOneArg。 此外， PyObject_VectorcallDict 以 _PyObject_FastCallDict 的名称提供。 旧名称仍然被定义为不带下划线的新名称的别名。

递归控制

在使用 tp_call 时，被调用者不必担心 递归: CPython 对于使用 tp_call 进行的调用会使用 Py_EnterRecursiveCall() 和 Py_LeaveRecursiveCall()。

为保证效率，这不适用于使用 vectorcall 的调用：被调用方在需要时应当使用 Py_EnterRecursiveCall 和 Py_LeaveRecursiveCall。

Vectorcall 支持 API

Py_ssize_t PyVectorcall_NARGS(size_t nargsf)

给定一个 vectorcall nargsf 实参，返回参数的实际数量。 目前等同于:

(Py_ssize_t)(nargsf & ~PY_VECTORCALL_ARGUMENTS_OFFSET)

然而，应使用 PyVectorcall_NARGS 函数以便将来扩展。

3.8 新版功能.

vectorcallfunc PyVectorcall_Function(PyObject *op)

如果*op*不支持vectorcall协议（要么是因为类型不支持，要么是因为具体实例不支持），返回*NULL*。否则，返回存储在*op*中的vectorcall函数指针。这个函数从不触发异常。

这在检查 op 是否支持 vectorcall 时最有用处，可以通过检查 PyVectorcall_Function(op) != NULL 来实现。

3.8 新版功能.

PyObject *PyVectorcall_Call(PyObject *callable, PyObject *tuple, PyObject *dict)

调用*可调对象*的 vectorcallfunc，其位置参数和关键字参数分别以元组和dict形式给出。

这是一个专门函数，其目的是被放入 tp_call 槽位或是用于 tp_call 的实现。 它不会检查 Py_TPFLAGS_HAVE_VECTORCALL 旗标并且它不会回退到 tp_call。

3.8 新版功能.

调用对象的 API

有多个函数可被用来调用 Python 对象。 各个函数会将其参数转换为被调用对象所支持的惯例 – 可以是 tp_call 或 vectorcall。 为了尽可能少地进行转换，请选择一个适合你所拥有的数据格式的函数。

下表总结了可用的功能； 请参阅各个文档以了解详细信息。

函数 | callable -- 可调用对象 | args | kwargs
PyObject_Call() | PyObject * | 元组 | dict/NULL
PyObject_CallNoArgs() | PyObject * | --- | ---
PyObject_CallOneArg() | PyObject * | 1个对象 | ---
PyObject_CallObject() | PyObject * | 元组/NULL | ---
PyObject_CallFunction() | PyObject * | format | ---
PyObject_CallMethod() | 对象 + char* | format | ---
PyObject_CallFunctionObjArgs() | PyObject * | 可变参数 | ---
PyObject_CallMethodObjArgs() | 对象 + 名称 | 可变参数 | ---
PyObject_CallMethodNoArgs() | 对象 + 名称 | --- | ---
PyObject_CallMethodOneArg() | 对象 + 名称 | 1个对象 | ---
PyObject_Vectorcall() | PyObject * | vectorcall | vectorcall
PyObject_VectorcallDict() | PyObject * | vectorcall | dict/NULL
PyObject_VectorcallMethod() | 参数 + 名称 | vectorcall | vectorcall

PyObject *PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs)

返回值：新的引用。 Part of the Stable ABI.

调用一个可调用的 Python 对象 callable，附带由元组 args 所给出的参数，以及由字典 kwargs 所给出的关键字参数。

args 必须不为 NULL；如果不想要参数请使用一个空元组。 如果不想要关键字参数，则 kwargs 可以为 NULL。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

这等价于 Python 表达式 callable(*args, **kwargs)。

PyObject *PyObject_CallNoArgs(PyObject *callable)

Part of the Stable ABI since version 3.10.

调用一个可调用的 Python 对象 callable 并不附带任何参数。 这是不带参数调用 Python 可调用对象的最有效方式。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

3.9 新版功能.

PyObject *PyObject_CallOneArg(PyObject *callable, PyObject *arg)

调用一个可调用的 Python 对象 callable 并附带恰好 1 个位置参数 arg 而没有关键字参数。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

3.9 新版功能.

PyObject *PyObject_CallObject(PyObject *callable, PyObject *args)

返回值：新的引用。 Part of the Stable ABI.

调用一个可调用的 Python 对象 callable，附带由元组 args 所给出的参数。 如果不想要传入参数，则 args 可以为 NULL。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

这等价于 Python 表达式 callable(*args)。

PyObject *PyObject_CallFunction(PyObject *callable, const char *format, ...)

返回值：新的引用。 Part of the Stable ABI.

调用一个可调用的 Python 对象 callable，附带可变数量的 C 参数。 这些 C 参数使用 Py_BuildValue() 风格的格式字符串来描述。 format 可以为 NULL，表示没有提供任何参数。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

这等价于 Python 表达式 callable(*args)。

请注意如果你只传入 PyObject* 参数，则 PyObject_CallFunctionObjArgs() 是更快速的选择。

在 3.4 版更改: 这个 format 类型已从 char * 更改。

PyObject *PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...)

返回值：新的引用。 Part of the Stable ABI.

调用 obj 对象中名为 name 的方法并附带可变数量的 C 参数。 这些 C 参数由 Py_BuildValue() 格式字符串来描述并应当生成一个元组。

格式可以为 NULL ，表示未提供任何参数。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

这和Python表达式 obj.name(arg1, arg2, ...) 是一样的。

请注意如果你只传入 PyObject* 参数，则 PyObject_CallMethodObjArgs() 是更快速的选择。

在 3.4 版更改: The types of name and format were changed from char *.

PyObject *PyObject_CallFunctionObjArgs(PyObject *callable, ...)

返回值：新的引用。 Part of the Stable ABI.

调用一个 Python 可调用对象 callable，附带可变数量的 PyObject* 参数。 这些参数以可变数量的形参的形式提供并以 NULL 结尾。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

这和Python表达式 callable(arg1, arg2, ...) 是一样的。

PyObject *PyObject_CallMethodObjArgs(PyObject *obj, PyObject *name, ...)

返回值：新的引用。 Part of the Stable ABI.

调用 Python 对象 obj 中的一个方，其中方法名称由 name 中的 Python 字符串对象给出。 它将附带可变数量的 PyObject* 参数被调用。 这些参数以可变数量的形参的形式提供并以 NULL 结尾。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

PyObject *PyObject_CallMethodNoArgs(PyObject *obj, PyObject *name)

调用 Python 对象 obj 中的一个方法并不附带任何参数，其中方法名称由 name 中的 Python 字符串对象给出。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

3.9 新版功能.

PyObject *PyObject_CallMethodOneArg(PyObject *obj, PyObject *name, PyObject *arg)

调用 Python 对象 obj 中的一个方法并附带单个位置参数 arg，其中方法名称由 name 中的 Python 字符串对象给出。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

3.9 新版功能.

PyObject *PyObject_Vectorcall(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)

调用一个可调用的 Python 对象 callable。 附带的参数与 vectorcallfunc 相同。 如果 callable 支持 vectorcall，则它会直接调用存放在 callable 中的 vectorcall 函数。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

3.9 新版功能.

PyObject *PyObject_VectorcallDict(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwdict)

调用 callable 并附带与在 vectorcall 协议中传入的完全相同的位置参数，但会加上以字典 kwdict 形式传入的关键字参数。 args 数组将只包含位置参数。

无论在内部使用哪种协议，都需要进行参数的转换。 因此，此函数应当仅在调用方已经拥有作为关键字参数的字典，但没有作为位置参数的元组时才被使用。

3.9 新版功能.

PyObject *PyObject_VectorcallMethod(PyObject *name, PyObject *const *args, size_t nargsf, PyObject *kwnames)

使用 vectorcall 调用惯例来调用一个方法。 方法的名称以 Python 字符串 name 的形式给出。 调用方法的对象为 args[0]，而 args 数组从 args[1] 开始的部分则代表调用的参数。 必须传入至少一个位置参数。 nargsf 为包括 args[0] 在内的位置参数的数量，如果 args[0] 的值可能被临时改变则要再加上 PY_VECTORCALL_ARGUMENTS_OFFSET。 关键字参数可以像在 PyObject_Vectorcall() 中一样被传入。

如果对象具有 Py_TPFLAGS_METHOD_DESCRIPTOR 特性，此函数将调用调用未绑定的方法对象并附带完整的 args vector 作为参数。

成功时返回结果，在失败时抛出一个异常并返回 NULL。

3.9 新版功能.

调用支持 API

int PyCallable_Check(PyObject *o)

Part of the Stable ABI.

确定对象 o 是可调对象。如果对象是可调对象则返回 1 ，其他情况返回 0 。这个函数不会调用失败。

数字协议

int PyNumber_Check(PyObject *o)

Part of the Stable ABI.

如果对象 o 提供数字的协议，返回真 1，否则返回假。这个函数不会调用失败。

在 3.8 版更改: 如果 o 是一个索引整数则返回 1。

PyObject *PyNumber_Add(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 、o2 相加的结果，如果失败，返回 NULL。等价于 Python 表达式 o1 + o2。

PyObject *PyNumber_Subtract(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 减去 o2 的结果，如果失败，返回 NULL。等价于 Python 表达式 o1 - o2。

PyObject *PyNumber_Multiply(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 、 o2 相乘的结果，如果失败，返回 NULL。等价于 Python 表达式 o1 * o2。

PyObject *PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

返回 o1 、o2 做矩阵乘法的结果，如果失败，返回 NULL。等价于 Python 表达式 o1 @ o2。

3.5 新版功能.

PyObject *PyNumber_FloorDivide(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 除以 o2 向下取整的值，失败时返回 NULL。 这等价于 Python 表达式 o1 // o2。

PyObject *PyNumber_TrueDivide(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 除以 o2 的数学值的合理近似值，或失败时返回 NULL。 返回的是 "近似值" 因为二进制浮点数本身就是近似值；不可能以二进制精确表示所有实数。 此函数可以在传入两个整数时返回一个浮点值。 此函数等价于 Python 表达式 o1 / o2。

PyObject *PyNumber_Remainder(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 除以 o2 得到的余数，如果失败，返回 NULL。等价于 Python 表达式 o1 % o2。

PyObject *PyNumber_Divmod(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

参考内置函数 divmod()。如果失败，返回 NULL。等价于 Python 表达式 divmod(o1, o2)。

PyObject *PyNumber_Power(PyObject *o1, PyObject *o2, PyObject *o3)

返回值：新的引用。 Part of the Stable ABI.

请参阅内置函数 pow()。 如果失败，返回 NULL。 等价于 Python 中的表达式 pow(o1, o2, o3)，其中 o3 是可选的。如果要忽略 o3，则需传入 Py_None 作为代替（如果传入 NULL 会导致非法内存访问）。

PyObject *PyNumber_Negative(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回 o 的负值，如果失败，返回 NULL 。等价于 Python 表达式 -o。

PyObject *PyNumber_Positive(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回 o，如果失败，返回 NULL 。等价于 Python 表达式 +o。

PyObject *PyNumber_Absolute(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回 o 的绝对值，如果失败，返回 NULL。等价于 Python 表达式 abs(o)。

PyObject *PyNumber_Invert(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回 o 的按位取反后的结果，如果失败，返回 NULL。等价于 Python 表达式 ~o。

PyObject *PyNumber_Lshift(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 左移 o2 个比特后的结果，如果失败，返回 NULL。等价于 Python 表达式 o1 << o2。

PyObject *PyNumber_Rshift(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 右移 o2 个比特后的结果，如果失败，返回 NULL 。等价于 Python 表达式 o1 >> o2。

PyObject *PyNumber_And(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 和 o2 “按位与”的结果，如果失败，返回 NULL 。等价于 Python 表达式 o1 & o2。

PyObject *PyNumber_Xor(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 和 o2 “按位异或”的结果，如果失败，返回 NULL 。等价于 Python 表达式 o1 ^ o2。

PyObject *PyNumber_Or(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 和 o2 “按位或”的结果，如果失败，返回 NULL 。等价于 Python 表达式 o1 | o2。

PyObject *PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 、o2 相加的结果，如果失败，返回 NULL。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 += o2。

PyObject *PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 、o2 相减的结果，如果失败，返回 NULL 。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 -= o2。

PyObject *PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 、o2*相乘的结果，如果失败，返回 ``NULL`` 。当 *o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 *= o2。

PyObject *PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

返回 o1 、o2 做矩阵乘法后的结果，如果失败，返回 NULL 。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 @= o2。

3.5 新版功能.

PyObject *PyNumber_InPlaceFloorDivide(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 除以 o2 后向下取整的结果，如果失败，返回 NULL。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 //= o2。

PyObject *PyNumber_InPlaceTrueDivide(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 除以 o2 的数学值的合理近似值，或失败时返回 NULL。 返回的是 "近似值" 因为二进制浮点数本身就是近似值；不可能以二进制精确表示所有实数。 此函数可以在传入两个整数时返回一个浮点数。 此运算在 o1 支持的时候会 原地 执行。此函数等价于 Python 语句 o1 /= o2。

PyObject *PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 除以 o2 得到的余数，如果失败，返回 NULL。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 %= o2。

PyObject *PyNumber_InPlacePower(PyObject *o1, PyObject *o2, PyObject *o3)

返回值：新的引用。 Part of the Stable ABI.

请参阅内置函数 pow()。 如果失败，返回 NULL。当 o1 支持时，这个运算直接使用它储存结果。当 o3 是 Py_None 时，等价于 Python 语句 o1 **= o2；否则等价于在原来位置储存结果的 pow(o1, o2, o3) 。如果要忽略 o3，则需传入 Py_None （传入 NULL 会导致非法内存访问）。

PyObject *PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 左移 o2 个比特后的结果，如果失败，返回 NULL。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 <<= o2。

PyObject *PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

返回 o1 右移 o2 个比特后的结果，如果失败，返回 NULL。当 o1 支持时，这个运算直接使用它储存结果。 等价于 Python 语句 o1 >>= o2。

PyObject *PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o1 和 o2 "按位与" 的结果，失败时返回 NULL。 在 o1 支持的前提下该操作将 原地 执行。 等价与 Python 语句 o1 &= o2。

PyObject *PyNumber_InPlaceXor(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o1 和 o2 "按位异或的结果，失败时返回 NULL。 在 o1 支持的前提下该操作将 原地 执行。 等价与 Python 语句 o1 ^= o2。

PyObject *PyNumber_InPlaceOr(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o1 和 o2 "按位或" 的结果，失败时返回 NULL。 在 o1 支持的前提下该操作将 原地 执行。 等价于 Python 语句 o1 |= o2。

PyObject *PyNumber_Long(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o 转换为整数对象后的结果，失败时返回 NULL。 等价于 Python 表达式 int(o)。

PyObject *PyNumber_Float(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o 转换为浮点对象后的结果，失败时返回 NULL。 等价于 Python 表达式 float(o)。

PyObject *PyNumber_Index(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o 转换为 Python int 类型后的结果，失败时返回 NULL 并引发 TypeError 异常。

在 3.10 版更改: 结果总是为 int 类型。 在之前版本中，结果可能为 int 的子类的实例。

PyObject *PyNumber_ToBase(PyObject *n, int base)

返回值：新的引用。 Part of the Stable ABI.

返回整数 n 转换成以 base 为基数的字符串后的结果。这个 base 参数必须是 2，8，10 或者 16 。对于基数 2，8，或 16 ，返回的字符串将分别加上基数标识 '0b', '0o', or '0x'。如果 n 不是 Python 中的整数 int 类型，就先通过 PyNumber_Index() 将它转换成整数类型。

Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc)

Part of the Stable ABI.

如果 o 可以被解读为一个整数则返回 o 转换成的 Py_ssize_t 值。 如果调用失败，则会引发一个异常并返回 -1。

如果 o 可以被转换为 Python 的 int 值但尝试转换为 Py_ssize_t 值则会引发 OverflowError，则 exc 参数将为所引发的异常类型 (通常为 IndexError 或 OverflowError)。 如果 exc 为 NULL，则异常会被清除并且值会在为负整数时被裁剪为 PY_SSIZE_T_MIN 而在为正整数时被裁剪为 PY_SSIZE_T_MAX。

int PyIndex_Check(PyObject *o)

Part of the Stable ABI since version 3.8.

返回 1 如果 o 是一个索引整数（将 nb_index 槽位填充到 tp_as_number 结构体），或者在其他情况下返回 0。 此函数总是会成功执行。

序列协议

int PySequence_Check(PyObject *o)

Part of the Stable ABI.

如果对象提供了序列协议则返回 1，否则返回 0。 请注意它将为具有 __getitem__() 方法的 Python 类返回 1，除非它们是 dict 的子类，因为在通常情况下无法确定这种类支持哪种键类型。 此函数总是会成功执行。

Py_ssize_t PySequence_Size(PyObject *o)

Py_ssize_t PySequence_Length(PyObject *o)

Part of the Stable ABI.

成功时返回序列中*o*的对象数,失败时返回 -1 . 相当于Python的 len(o) 表达式.

PyObject *PySequence_Concat(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o1 和 o2 的拼接，失败时返回 NULL。 这等价于 Python 表达式 o1 + o2。

PyObject *PySequence_Repeat(PyObject *o, Py_ssize_t count)

返回值：新的引用。 Part of the Stable ABI.

返回序列对象 o 重复 count 次的结果，失败时返回 NULL。 这等价于 Python 表达式 o * count。

PyObject *PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)

返回值：新的引用。 Part of the Stable ABI.

成功时返回 o1 和 o2 的拼接，失败时返回 NULL。 在 o1 支持的情况下操作将 原地 完成。 这等价于 Python 表达式 o1 += o2。

PyObject *PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)

返回值：新的引用。 Part of the Stable ABI.

Return the result of repeating sequence object返回序列对象 o 重复 count 次的结果，失败时返回 NULL。 在 o 支持的情况下该操作会 原地 完成。 这等价于 Python 表达式 o *= count。

PyObject *PySequence_GetItem(PyObject *o, Py_ssize_t i)

返回值：新的引用。 Part of the Stable ABI.

返回 o 中的第 i 号元素，失败时返回 NULL。 这等价于 Python 表达式 o[i]。

PyObject *PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)

返回值：新的引用。 Part of the Stable ABI.

返回序列对象 o 的 i1 到 i2 的切片，失败时返回 NULL。 这等价于 Python 表达式 o[i1:i2]。

int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)

Part of the Stable ABI.

将对象 v 赋值给 o 的第 i 号元素。 失败时会引发异常并返回 -1；成功时返回 0。 这相当于 Python 语句 o[i] = v。 此函数 不会 改变对 v 的引用。

如果 v 为 NULL，元素将被删除，但是此特性已被弃用而应改用 PySequence_DelItem()。

int PySequence_DelItem(PyObject *o, Py_ssize_t i)

Part of the Stable ABI.

删除对象 o 的第 i 号元素。 失败时返回 -1。 这相当于 Python 语句 del o[i]。

int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)

Part of the Stable ABI.

将序列对象 v 赋值给序列对象 o 的从 i1 到 i2 切片。 这相当于 Python 语句 o[i1:i2] = v。

int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)

Part of the Stable ABI.

删除序列对象 o 的从 i1 到 i2 的切片。 失败时返回 -1。 这相当于 Python 语句 del o[i1:i2]。

Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)

Part of the Stable ABI.

返回 value 在 o 中出现的次数，即返回使得 o[key] == value 的键的数量。 失败时返回 -1。 这相当于 Python 表达式 o.count(value)。

int PySequence_Contains(PyObject *o, PyObject *value)

Part of the Stable ABI.

确定 o 是否包含 value。 如果 o 中的某一项等于 value，则返回 1，否则返回 0。 出错时，返回 -1。 这相当于 Python 表达式 value in o。

Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)

Part of the Stable ABI.

返回第一个索引*i*,其中 o[i] == value .出错时,返回 -1 .相当于Python的 o.index(value) 表达式.

PyObject *PySequence_List(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回一个列表对象，其内容与序列或可迭代对象 o 相同，失败时返回 NULL。 返回的列表保证是一个新对象。 这等价于 Python 表达式 list(o)。

PyObject *PySequence_Tuple(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回一个元组对象，其内容与序列或可迭代对象 o 相同，失败时返回 NULL。 如果 o 为元组，则将返回一个新的引用，在其他情况下将使用适当的内容构造一个元组。 这等价于 Python 表达式 tuple(o)。

PyObject *PySequence_Fast(PyObject *o, const char *m)

返回值：新的引用。 Part of the Stable ABI.

将序列或可迭代对象 o 作为其他 PySequence_Fast* 函数族可用的对象返回。 如果该对象不是序列或可迭代对象，则会引发 TypeError 并将 m 作为消息文本。 失败时返回 NULL。

PySequence_Fast* 函数之所以这样命名，是因为它们会假定 o 是一个 PyTupleObject 或 PyListObject 并直接访问 o 的数据字段。

作为 CPython 的实现细节，如果 o 已经是一个序列或列表，它将被直接返回。

Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)

在 o 由 PySequence_Fast() 返回且 o 不为 NULL 的情况下返回 o 长度。 也可以通过在 o 上调用 PySequence_Size() 来获取大小，但是 PySequence_Fast_GET_SIZE() 的速度更快因为它可以假定 o 为列表或元组。

PyObject *PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)

返回值：借入的引用。

在 o 由 PySequence_Fast() 返回且 o 不 NULL，并且 i d在索引范围内的情况下返回 o 的第 i 号元素。

PyObject **PySequence_Fast_ITEMS(PyObject *o)

返回 PyObject 指针的底层数组。 假设 o 由 PySequence_Fast() 返回且 o 不为 NULL。

请注意,如果列表调整大小,重新分配可能会重新定位items数组.因此,仅在序列无法更改的上下文中使用基础数组指针.

PyObject *PySequence_ITEM(PyObject *o, Py_ssize_t i)

返回值：新的引用。

返回 o 的第 i 个元素或在失败时返回 NULL。 此形式比 PySequence_GetItem() 理馔，但不会检查 o 上的 PySequence_Check() 是否为真值，也不会对负序号进行调整。

映射协议

参见 PyObject_GetItem()、PyObject_SetItem() 与 PyObject_DelItem()。

int PyMapping_Check(PyObject *o)

Part of the Stable ABI.

如果对象提供了映射协议或是支持切片则返回 1，否则返回 0。 请注意它将为具有 __getitem__() 方法的 Python 类返回 1，因为在通常情况下无法确定该类所支持的键类型。 此函数总是会成功执行。

Py_ssize_t PyMapping_Size(PyObject *o)

Py_ssize_t PyMapping_Length(PyObject *o)

Part of the Stable ABI.

成功时返回对象 o 中键的数量，失败时返回 -1。 这相当于 Python 表达式 len(o)。

PyObject *PyMapping_GetItemString(PyObject *o, const char *key)

返回值：新的引用。 Part of the Stable ABI.

返回 o 中对应于字符串 key 的元素，或者失败时返回 NULL。 这相当于 Python 表达式 o[key]。 另请参见 also PyObject_GetItem()。

int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)

Part of the Stable ABI.

在对象 o 中将字符串 key 映射到值 v。 失败时返回 -1。 这相当于 Python 语句 o[key] = v。 另请参见 PyObject_SetItem()。 此函数 不会 增加对 v 的引用。

int PyMapping_DelItem(PyObject *o, PyObject *key)

从对象 o 中移除对象 key 的映射。 失败时返回 -1。 这相当于 Python 语句 del o[key]。 这是 PyObject_DelItem() 的一个别名。

int PyMapping_DelItemString(PyObject *o, const char *key)

从对象 o 中移除字符串 key 的映射。 失败时返回 -1。 这相当于 Python 语句 del o[key]。

int PyMapping_HasKey(PyObject *o, PyObject *key)

Part of the Stable ABI.

如果映射对象具有键 key 则返回 1，否则返回 0。 这相当于 Python 表达式 key in o。 此函数总是会成功执行。

请注意在调用 __getitem__() 方法期间发生的异常将会被屏蔽。 要获取错误报告请改用 PyObject_GetItem()。

int PyMapping_HasKeyString(PyObject *o, const char *key)

Part of the Stable ABI.

如果映射对象具有键 key 则返回 1，否则返回 0。 这相当于 Python 表达式 key in o。 此函数总是会成功执行。

请注意在调用 __getitem__() 方法期间发生的异常将会被屏蔽。 要获取错误报告请改用 PyMapping_GetItemString()。

PyObject *PyMapping_Keys(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

成功时，返回对象 o 中的键的列表。 失败时，返回 NULL。

在 3.7 版更改: 在之前版本中，此函数返回一个列表或元组。

PyObject *PyMapping_Values(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

成功时，返回对象 o 中的值的列表。 失败时，返回 NULL。

在 3.7 版更改: 在之前版本中，此函数返回一个列表或元组。

PyObject *PyMapping_Items(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

成功时，返回对象 o 中条目的列表，其中每个条目是一个包含键值对的元组。 失败时，返回 NULL。

在 3.7 版更改: 在之前版本中，此函数返回一个列表或元组。

迭代器协议

迭代器有两个函数。

int PyIter_Check(PyObject *o)

Part of the Stable ABI since version 3.8.

如果对象Return non-zero if the object o 可以被安全把传给 PyIter_Next() 则返回非零值，否则返回 0。 此函数总是会成功执行。

int PyAIter_Check(PyObject *o)

Part of the Stable ABI since version 3.10.

如果对象 o 提供了 AsyncIterator 协议则返回非零值，否则返回 0。 此函数总是会成功执行。

3.10 新版功能.

PyObject *PyIter_Next(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

从迭代器 o 返回下一个值。 对象必须可被 PyIter_Check() 确认为迭代器（需要调用方来负责检查）。 如果没有剩余的值，则返回 NULL 并且不设置异常。 如果在获取条目时发生了错误，则返回 NULL 并且传递异常。

要为迭代器编写一个一个循环，C代码应该看起来像这样

PyObject *iterator = PyObject_GetIter(obj);
PyObject *item;

if (iterator == NULL) {
    /* propagate error */
}

while ((item = PyIter_Next(iterator))) {
    /* do something with item */
    ...
    /* release reference when done */
    Py_DECREF(item);
}

Py_DECREF(iterator);

if (PyErr_Occurred()) {
    /* propagate error */
}
else {
    /* continue doing useful work */
}

type PySendResult

用于代表 PyIter_Send() 的不同结果的枚举值。

3.10 新版功能.

PySendResult PyIter_Send(PyObject *iter, PyObject *arg, PyObject **presult)

Part of the Stable ABI since version 3.10.

将 arg 值发送到迭代器 iter。 返回:

PYGEN_RETURN，如果迭代器返回的话。 返回值会通过 presult 来返回。

PYGEN_NEXT，如果迭代器生成值的话。 生成的值会通过 presult 来返回。

PYGEN_ERROR，如果迭代器引发异常的话。 presult 会被设为 NULL。

3.10 新版功能.

缓冲协议

在 Python 中可使用一些对象来包装对底层内存数组或称 缓冲 的访问。此类对象包括内置的 bytes 和 bytearray 以及一些如 array.array 这样的扩展类型。第三方库也可能会为了特殊的目的而定义它们自己的类型，例如用于图像处理和数值分析等。

虽然这些类型中的每一种都有自己的语义，但它们具有由可能较大的内存缓冲区支持的共同特征。 在某些情况下，希望直接访问该缓冲区而无需中间复制。

Python 以 缓冲协议 的形式在 C 层级上提供这样的功能。 此协议包括两个方面:

在生产者这一方面，该类型的协议可以导出一个“缓冲区接口”，允许公开它的底层缓冲区信息。该接口的描述信息在 缓冲区对象结构体 一节中；

在消费者一侧，有几种方法可用于获得指向对象的原始底层数据的指针（例如一个方法的形参）。

一些简单的对象例如 bytes 和 bytearray 会以面向字节的形式公开它们的底层缓冲区。 也可能会用其他形式；例如 array.array 所公开的元素可以是多字节值。

缓冲区接口的消费者的一个例子是文件对象的 write() 方法：任何可以输出为一系列字节流的对象可以被写入文件。然而 write() 方法只需要对于传入对象的只读权限，其他的方法，如 readinto() 需要参数内容的写入权限。缓冲区接口使得对象可以选择性地允许或拒绝读写或只读缓冲区的导出。

对于缓冲区接口的使用者而言，有两种方式来获取一个目的对象的缓冲：

使用正确的参数来调用 PyObject_GetBuffer() 函数；

调用 PyArg_ParseTuple() (或其同级对象之一) 并传入 y*, w* or s* 格式代码 中的一个。

在这两种情况下，当不再需要缓冲区时必须调用 PyBuffer_Release() 。如果此操作失败，可能会导致各种问题，例如资源泄漏。

缓冲区结构

缓冲区结构(或者简单地称为“buffers”)对于将二进制数据从另一个对象公开给 Python 程序员非常有用。它们还可以用作零拷贝切片机制。使用它们引用内存块的能力，可以很容易地将任何数据公开给 Python 程序员。内存可以是 C 扩展中的一个大的常量数组，也可以是在传递到操作系统库之前用于操作的原始内存块，或者可以用来传递本机内存格式的结构化数据。

与 Python 解释器公开的大多部数据类型不同，缓冲区不是 PyObject 指针而是简单的 C 结构。 这使得它们可以非常简单地创建和复制。 当需要为缓冲区加上泛型包装器时，可以创建一个 内存视图 对象。

有关如何编写并导出对象的简短说明，请参阅 缓冲区对象结构。 要获取缓冲区对象，请参阅 PyObject_GetBuffer()。

type Py_buffer

void *buf

指向由缓冲区字段描述的逻辑结构开始的指针。 这可以是导出程序底层物理内存块中的任何位置。 例如，使用负的 strides 值可能指向内存块的末尾。

对于 contiguous ，‘邻接’数组，值指向内存块的开头。

PyObject *obj

对导出对象的新引用。 该引用由消费方拥有，并由 PyBuffer_Release() 自动释放（即引用计数递减）并设置为 NULL。 该字段相当于任何标准 C-API 函数的返回值。

作为一种特殊情况，对于由 PyMemoryView_FromBuffer() 或 PyBuffer_FillInfo() 包装的 temporary 缓冲区，此字段为 NULL。 通常，导出对象不得使用此方案。

Py_ssize_t len

product(shape) * itemsize。对于连续数组，这是基础内存块的长度。对于非连续数组，如果逻辑结构复制到连续表示形式，则该长度将具有该长度。

仅当缓冲区是通过保证连续性的请求获取时，才访问 ((char *)buf)[0] up to ((char *)buf)[len-1] 时才有效。在大多数情况下，此类请求将为 PyBUF_SIMPLE 或 PyBUF_WRITABLE。

int readonly

缓冲区是否为只读的指示器。此字段由 PyBUF_WRITABLE 标志控制。

Py_ssize_t itemsize

单个元素的项大小（以字节为单位）。与 struct.calcsize() 调用非 NULL format 的值相同。

重要例外：如果使用者请求的缓冲区没有 PyBUF_FORMAT 标志，format 将设置为 NULL，但 itemsize 仍具有原始格式的值。

如果 shape 存在，则相等的 product(shape) * itemsize == len 仍然存在，使用者可以使用 itemsize 来导航缓冲区。

如果 shape 是 NULL，因为结果为 PyBUF_SIMPLE 或 PyBUF_WRITABLE 请求，则使用者必须忽略 itemsize，并假设 itemsize == 1。

const char *format

在 struct 模块样式语法中 NUL 字符串，描述单个项的内容。如果这是 NULL，则假定为 "B" (无符号字节) 。

此字段由 PyBUF_FORMAT 标志控制。

int ndim

内存表示为 n 维数组的维数。 如果是 0， buf 指向表示标量的单个项目。 在这种情况下，shape、strides 和 suboffsets 必须是 NULL 。

宏 PyBUF_MAX_NDIM 将最大维度数限制为 64。 导出程序必须遵守这个限制，多维缓冲区的使用者应该能够处理最多 PyBUF_MAX_NDIM 维度。

Py_ssize_t *shape

一个长度为 Py_ssize_t 的数组 ndim 表示作为 n 维数组的内存形状。 请注意，shape[0] * ... * shape[ndim-1] * itemsize 必须等于 len。

Shape 形状数组中的值被限定在 shape[n] >= 0 。 shape[n] == 0 这一情形需要特别注意。更多信息请参阅 complex arrays 。

shape 数组对于使用者来说是只读的。

Py_ssize_t *strides

一个长度为 Py_ssize_t 的数组 ndim 给出要跳过的字节数以获取每个尺寸中的新元素。

Stride 步幅数组中的值可以为任何整数。对于常规数组，步幅通常为正数，但是使用者必须能够处理 strides[n] <= 0 的情况。更多信息请参阅 complex arrays 。

strides数组对用户来说是只读的。

Py_ssize_t *suboffsets

一个长度为 ndim 类型为 Py_ssize_t 的数组 。如果 suboffsets[n] >= 0，则第 n 维存储的是指针，suboffset 值决定了解除引用时要给指针增加多少字节的偏移。suboffset 为负值，则表示不应解除引用（在连续内存块中移动）。

如果所有子偏移均为负（即无需取消引用），则此字段必须为 NULL （默认值）。

Python Imaging Library (PIL) 中使用了这种类型的数组表达方式。请参阅 complex arrays 来了解如何从这样一个数组中访问元素。

suboffsets 数组对于使用者来说是只读的。

void *internal

供输出对象内部使用。比如可能被输出程序重组为一个整数，用于存储一个标志，标明在缓冲区释放时是否必须释放 shape、strides 和 suboffsets 数组。消费者程序 不得 修改该值。

缓冲区请求的类型

通常，通过 PyObject_GetBuffer() 向输出对象发送缓冲区请求，即可获得缓冲区。由于内存的逻辑结构复杂，可能会有很大差异，缓冲区使用者可用 flags 参数指定其能够处理的缓冲区具体类型。

所有 Py_buffer 字段均由请求类型明确定义。

与请求无关的字段

以下字段不会被 flags 影响，并且必须总是用正确的值填充：obj, buf，len，itemsize，ndim。

只读，格式

PyBUF_WRITABLE

控制 readonly 字段。如果设置了，输出程序 必须 提供一个可写的缓冲区，否则报告失败。若未设置，输出程序 可以 提供只读或可写的缓冲区，但对所有消费者程序 必须 保持一致。

PyBUF_FORMAT

控制 format 字段。 如果设置，则必须正确填写此字段。其他情况下，此字段必须为 NULL。

PyBUF_WRITABLE 可以和下一节的所有标志联用。由于 PyBUF_SIMPLE 定义为 0，所以 PyBUF_WRITABLE 可以作为一个独立的标志，用于请求一个简单的可写缓冲区。

PyBUF_FORMAT 可以被设为除了 PyBUF_SIMPLE 之外的任何标志。 后者已经按暗示了 B (无符号字节串)格式。

形状，步幅，子偏移量

控制内存逻辑结构的标志按照复杂度的递减顺序列出。注意，每个标志包含它下面的所有标志。

请求 | 形状 | 步幅 | 子偏移量
PyBUF_INDIRECT | 是 | 是 | 如果需要的话
PyBUF_STRIDES | 是 | 是 | NULL
PyBUF_ND | 是 | NULL | NULL
PyBUF_SIMPLE | NULL | NULL | NULL

连续性的请求

可以显式地请求C 或 Fortran 连续 ，不管有没有步幅信息。若没有步幅信息，则缓冲区必须是 C-连续的。

请求 | 形状 | 步幅 | 子偏移量 | 邻接
PyBUF_C_CONTIGUOUS | 是 | 是 | NULL | C
PyBUF_F_CONTIGUOUS | 是 | 是 | NULL | F
PyBUF_ANY_CONTIGUOUS | 是 | 是 | NULL | C 或 F
PyBUF_ND | 是 | NULL | NULL | C

复合请求

所有可能的请求都由上一节中某些标志的组合完全定义。为方便起见，缓冲区协议提供常用的组合作为单个标志。

在下表中，U 代表连续性未定义。消费者程序必须调用 PyBuffer_IsContiguous() 以确定连续性。

请求 | 形状 | 步幅 | 子偏移量 | 邻接 | readonly | format
PyBUF_FULL | 是 | 是 | 如果需要的话 | U | 0 | 是
PyBUF_FULL_RO | 是 | 是 | 如果需要的话 | U | 1 或 0 | 是
PyBUF_RECORDS | 是 | 是 | NULL | U | 0 | 是
PyBUF_RECORDS_RO | 是 | 是 | NULL | U | 1 或 0 | 是
PyBUF_STRIDED | 是 | 是 | NULL | U | 0 | NULL
PyBUF_STRIDED_RO | 是 | 是 | NULL | U | 1 或 0 | NULL
PyBUF_CONTIG | 是 | NULL | NULL | C | 0 | NULL
PyBUF_CONTIG_RO | 是 | NULL | NULL | C | 1 或 0 | NULL

复杂数组

NumPy-风格：形状和步幅

NumPy 风格数组的逻辑结构由 itemsize 、 ndim 、 shape 和 strides 定义。

如果 ndim == 0 ， buf 指向的内存位置被解释为大小为 itemsize 的标量。这时， shape 和 strides 都为 NULL。

如果 strides 为 NULL，则数组将被解释为一个标准的 n 维 C 语言数组。否则，消费者程序必须按如下方式访问 n 维数组：

ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1];
item = *((typeof(item) *)ptr);

如上所述，buf 可以指向实际内存块中的任意位置。输出者程序可以用该函数检查缓冲区的有效性。

def verify_structure(memlen, itemsize, ndim, shape, strides, offset):
    """Verify that the parameters represent a valid array within
       the bounds of the allocated memory:
           char *mem: start of the physical memory block
           memlen: length of the physical memory block
           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

PIL-风格：形状，步幅和子偏移量

除了常规项之外， PIL 风格的数组还可以包含指针，必须跟随这些指针才能到达维度的下一个元素。例如，常规的三维 C 语言数组 char v[2][2][3] 可以看作是一个指向 2 个二维数组的 2 个指针：char (*v[2])[2][3]。在子偏移表示中，这两个指针可以嵌入在 buf 的开头，指向两个可以位于内存任何位置的 char x[2][3] 数组。

这是一个函数，当n维索引所指向的N-D数组中有 NULL 步长和子偏移量时，它返回一个指针

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;
}

缓冲区相关函数

int PyObject_CheckBuffer(PyObject *obj)

如果 obj 支持缓冲区接口，则返回 1，否则返回 0。 返回 1 时不保证 PyObject_GetBuffer() 一定成功。本函数一定调用成功。

int PyObject_GetBuffer(PyObject *exporter, Py_buffer *view, int flags)

向 输出器程序 发送请求，按照 flags 指定的内容填充 view。如果 输出器程序不能提供准确类型的缓冲区，必须 触发 PyExc_BufferError，设置 view->obj 为 NULL 并返回 -1。

成功时，填充 view，将 view->obj 设为对 exporter 的新引用，并返回 0。 当链式缓冲区提供程序将请求重定向到一个对象时，view->obj 可以引用该对象而不是 exporter (参见 缓冲区对象结构)。

PyObject_GetBuffer() 必须与 PyBuffer_Release() 同时调用成功，类似于 malloc() 和 free()。因此，消费者程序用完缓冲区后， PyBuffer_Release() 必须保证被调用一次。

void PyBuffer_Release(Py_buffer *view)

释放缓冲区 view 并释放对视图的支持对象 view->obj 的 strong reference (即递减引用计数)。 该函数必须在缓冲区不再使用时调用，否则可能会发生引用泄漏。

若该函数针对的缓冲区不是通过 PyObject_GetBuffer() 获得的，将会出错。

Py_ssize_t PyBuffer_SizeFromFormat(const char *format)

返回 itemsize 中隐含的 format 。如果出错，会触发异常并返回 -1。

3.9 新版功能.

int PyBuffer_IsContiguous(Py_buffer *view, char order)

如果 view 定义的内存是 C 风格（order 为 'C'）或 Fortran 风格（order 为 'F'） contiguous 或其中之一（order 是 'A'），则返回 1。否则返回 0。该函数总会成功。

void *PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)

获取给定 view 内的 indices 所指向的内存区域。indices 必须指向一个 view->ndim 索引的数组。

int PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)

从 buf 复制连续的 len 字节到 view 。fort 可以是 'C' 或 'F' （对应于 C 风格或 Fortran 风格的顺序）。成功时返回 0 ，错误时返回 -1 。

int PyBuffer_ToContiguous(void *buf, Py_buffer *src, Py_ssize_t len, char order)

从 src 复制 len 字节到 buf ，成为连续字节串的形式。order 可以是 'C' 或 'F' 或 'A' （对应于 C 风格、Fortran 风格的顺序或其中任意一种）。成功时返回 0 ，出错时返回 -1 。

如果 len != src->len 则此函数将报错。

void PyBuffer_FillContiguousStrides(int ndims, Py_ssize_t *shape, Py_ssize_t *strides, int itemsize, char order)

用给定形状的 contiguous 字节串数组 (如果 order 为 'C' 则为 C 风格，如果 order 为 'F' 则为 Fortran 风格) 来填充 strides 数组，每个元素具有给定的字节数。

int PyBuffer_FillInfo(Py_buffer *view, PyObject *exporter, void *buf, Py_ssize_t len, int readonly, int flags)

处理导出程序的缓冲区请求，该导出程序要公开大小为 len 的 buf ，并根据 readonly 设置可写性。bug 被解释为一个无符号字节序列。

参数 flags 表示请求的类型。该函数总是按照 flag 指定的内容填入 view，除非 buf 设为只读，并且 flag 中设置了 PyBUF_WRITABLE 标志。

成功时，将 view->obj 设为 exporter 的新引用，并返回 0。否则，引发 PyExc_BufferError ，将 view->obj 设为 NULL，并返回 -1。

如果此函数用作 getbufferproc 的一部分，则 exporter 必须设置为导出对象，并且必须在未修改的情况下传递 flags。否则，exporter 必须是 NULL。

旧缓冲协议

3.0 版后已移除.

这些函数是 Python 2 中“旧缓冲协议”API 的组成部分。 在 Python 3 中，此协议已不复存在，但这些函数仍然被公开以便移植 2.x 的代码。 它们被用作 新缓冲协议 的兼容性包装器，但它们并不会在缓冲被导出时向你提供对所获资源的生命周期控制。

因此，推荐你调用 PyObject_GetBuffer() (或者配合 PyArg_ParseTuple() 函数族使用 y* 或 w* 格式码) 来获取一个对象的缓冲视图，并在缓冲视图可被释放时调用 PyBuffer_Release()。

int PyObject_AsCharBuffer(PyObject *obj, const char **buffer, Py_ssize_t *buffer_len)

Part of the Stable ABI.

返回一个指向可用作基于字符的输入的只读内存地址的指针。 obj 参数必须支持单段字符缓冲接口。 成功时返回 0，将 buffer 设为内存地址并将 buffer_len 设为缓冲区长度。 出错时返回 -1 并设置一个 TypeError。

int PyObject_AsReadBuffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len)

Part of the Stable ABI.

返回一个指向包含任意数据的只读内存地址的指针。 obj 参数必须支持单段可读缓冲接口。 成功时返回 0，将 buffer 设为内存地址并将 buffer_len 设为缓冲区长度。 出错时返回 -1 并设置一个 TypeError。

int PyObject_CheckReadBuffer(PyObject *o)

Part of the Stable ABI.

如果 o 支持单段可读缓冲接口则返回 1。 否则返回 0。 此函数总是会成功执行。

请注意此函数会尝试获取并释放一个缓冲区，并且在调用对应函数期间发生的异常会被屏蔽。 要获取错误报告则应改用 PyObject_GetBuffer()。

int PyObject_AsWriteBuffer(PyObject *obj, void **buffer, Py_ssize_t *buffer_len)

Part of the Stable ABI.

返回一个指向可写内存地址的指针。 obj 必须支持单段字符缓冲接口。 成功时返回 0，将 buffer 设为内存地址并将 buffer_len 设为缓冲区长度。 出错时返回 -1 并设置一个 TypeError。

具体的对象层

本章中的函数特定于某些 Python 对象类型。 将错误类型的对象传递给它们并不是一个好主意；如果您从 Python 程序接收到一个对象，但不确定它是否具有正确的类型，则必须首先执行类型检查；例如，要检查对象是否为字典，请使用 PyDict_Check()。 本章的结构类似于 Python 对象类型的“家族树”。

警告

虽然本章所描述的函数会仔细检查传入对象的类型，但是其中许多函数不会检查传入的对象是否为 NULL。 允许传入 NULL 可能导致内存访问冲突和解释器的立即终止。

基本对象

本节描述Python类型对象和单一实例对象 象None。

类型对象

创建堆分配类型

None 对象

数值对象

整数型对象

布尔对象

浮点数对象

复数对象

表示复数的C结构体

表示复数的Python对象

序列对象

序列对象的一般操作在前一章中讨论过;本节介绍Python语言固有的特定类型的序列对象。

bytes 对象

字节数组对象

类型检查宏

直接 API 函数

宏

Unicode对象和编解码器

Unicode对象

Unicode类型

Unicode字符属性

创建和访问 Unicode 字符串

已弃用的 Py_UNICODE API

语言区域编码格式

文件系统编码格式

wchar_t 支持

内置编解码器

泛型编解码器

UTF-8 编解码器

UTF-32 编解码器

UTF-16 编解码器

UTF-7 编解码器

Unicode-Escape 编解码器

Raw-Unicode-Escape 编解码器

Latin-1 编解码器

ASCII 编解码器

字符映射编解码器

Windows 中的 MBCS 编解码器

方法和槽位

方法与槽位函数

元组对象

结构序列对象

列表对象

容器对象

字典对象

集合对象

Function 对象

Function 对象

实例方法对象

方法对象

Cell 对象

代码对象

其他对象

文件对象

模块对象

初始化 C 模块

单阶段初始化

多阶段初始化

底层模块创建函数

支持函数

查找模块

迭代器对象

描述符对象

切片对象

Ellipsis 对象

MemoryView 对象

弱引用对象

Capsule 对象

生成器对象

协程对象

上下文变量对象

DateTime 对象

类型注解对象

类型对象

type PyTypeObject

Part of the Limited API (as an opaque struct).

对象的 C 结构用于描述 built-in 类型。

PyTypeObject PyType_Type

Part of the Stable ABI.

这是属于 type 对象的 type object，它在 Python 层面和 type 是相同的对象。

int PyType_Check(PyObject *o)

如果对象 o 是一个类型对象，包括派生自标准类型对象的类型实例则返回非零值。 在所有其它情况下都返回 0。 此函数将总是成功执行。

int PyType_CheckExact(PyObject *o)

如果对象 o 是一个类型对象，但不是标准类型对象的子类型则返回非零值。 在所有其它情况下都返回 0。 此函数将总是成功执行。

unsigned int PyType_ClearCache()

Part of the Stable ABI.

清空内部查找缓存。 返回当前版本标签。

unsigned long PyType_GetFlags(PyTypeObject *type)

Part of the Stable ABI.

返回 type 的 tp_flags 成员。 此函数主要是配合 Py_LIMITED_API 使用；单独的旗标位会确保在各个 Python 发布版之间保持稳定，但对 tp_flags 本身的访问并不是受限 API 的一部分。

3.2 新版功能.

在 3.4 版更改: 返回类型现在是 unsigned long 而不是 long。

void PyType_Modified(PyTypeObject *type)

Part of the Stable ABI.

使该类型及其所有子类型的内部查找缓存失效。 此函数必须在对该类型的属性或基类进行任何手动修改之后调用。

int PyType_HasFeature(PyTypeObject *o, int feature)

如果类型对象 o 设置了特性 feature 则返回非零值。 类型特性是用单个比特位旗标来表示的。

int PyType_IS_GC(PyTypeObject *o)

如果类型对象包括对循环检测器的支持则返回真值；这会测试类型旗标 Py_TPFLAGS_HAVE_GC。

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)

Part of the Stable ABI.

如果 a 是 b 的子类型则返回真值。

此函数只检查实际的子类型，这意味着 __subclasscheck__() 不会在 b 上被调用。 请调用 PyObject_IsSubclass() 来执行与 issubclass() 所做的相同检查。

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)

返回值：新的引用。 Part of the Stable ABI.

类型对象的 tp_alloc 槽位的通用处理器。 请使用 Python 的默认内存分配机制来分配一个新的实例并将其所有内容初始化为 NULL。

PyObject *PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)

返回值：新的引用。 Part of the Stable ABI.

类型对象的 tp_new 槽位的通用处理器。 请使用类型的 tp_alloc 槽位来创建一个新的实例。

int PyType_Ready(PyTypeObject *type)

Part of the Stable ABI.

最终化一个类型对象。 这应当在所有类型对象上调用以完成它们的初始化。 此函数会负责从一个类型的基类添加被继承的槽位。 成功时返回 0，或是在出错时返回 -1 并设置一个异常。

注解

如果某些基类实现了 GC 协议并且所提供的类型的旗标中未包括 Py_TPFLAGS_HAVE_GC，则将自动从其父类实现 GC 协议。 相反地，如果被创建的类型的旗标中未包括 Py_TPFLAGS_HAVE_GC 则它 必须 自己通过实现 tp_traverse 句柄来实现 GC 协议。

void *PyType_GetSlot(PyTypeObject *type, int slot)

Part of the Stable ABI since version 3.4.

返回存储在给定槽位中的函数指针。 如果结果为 NULL，则表示或者该槽位为 NULL，或者该函数调用传入了无效的形参。 调用方通常要将结果指针转换到适当的函数类型。

请参阅 PyType_Slot.slot 查看可用的 slot 参数值。

3.4 新版功能.

在 3.10 版更改: PyType_GetSlot() 现在可以接受所有类型。 在此之前，它被限制为 堆类型。

PyObject *PyType_GetModule(PyTypeObject *type)

Part of the Stable ABI since version 3.10.

返回当使用 PyType_FromModuleAndSpec() 创建类型时关联到给定类型的模块对象。

如果没有关联到给定类型的模块，则设置 TypeError 并返回 NULL。

此函数通常被用于获取方法定义所在的模块。 请注意在这样的方法中，PyType_GetModule(Py_TYPE(self)) 可能不会返回预期的结果。 Py_TYPE(self) 可以是目标类的一个 子类，而子类并不一定是在与其上级类相同的模块中定义的。 请参阅 PyCMethod 了解如何获取方法定义所在的类。

3.9 新版功能.

void *PyType_GetModuleState(PyTypeObject *type)

Part of the Stable ABI since version 3.10.

返回关联到给定类型的模块对象的状态。 这是一个在 PyType_GetModule() 的结果上调用 PyModule_GetState() 的快捷方式。

如果没有关联到给定类型的模块，则设置 TypeError 并返回 NULL。

如果 type 有关联的模块但其状态为 NULL，则返回 NULL 且不设置异常。

3.9 新版功能.

创建堆分配类型

下列函数和结构体可被用来创建 堆类型。

PyObject *PyType_FromModuleAndSpec(PyObject *module, PyType_Spec *spec, PyObject *bases)

返回值：新的引用。 Part of the Stable ABI since version 3.10.

根据 spec (Py_TPFLAGS_HEAPTYPE) 创建并返回一个 堆类型。

bases 参数可被用来指定基类；它可以是单个类或由多个类组成的元组。 如果 bases 为 NULL，则会改用 Py_tp_bases 槽位。 如果该槽位也为 NULL，则会改用 Py_tp_base 槽位。 如果该槽位同样为 NULL，则新类型将派生自 object。

module 参数可被用来记录新类定义所在的模块。 它必须是一个模块对象或为 NULL。 如果不为 NULL，则该模块会被关联到新类型并且可在之后通过 PyType_GetModule() 来获取。 这个关联模块不可被子类继承；它必须为每个类单独指定。

此函数会在新类型上调用 PyType_Ready()。

3.9 新版功能.

在 3.10 版更改: 此函数现在接受一个单独类作为 bases 参数并接受 NULL 作为 tp_doc 槽位。

PyObject *PyType_FromSpecWithBases(PyType_Spec *spec, PyObject *bases)

返回值：新的引用。 Part of the Stable ABI since version 3.3.

等价于 PyType_FromModuleAndSpec(NULL, spec, bases)。

3.3 新版功能.

PyObject *PyType_FromSpec(PyType_Spec *spec)

返回值：新的引用。 Part of the Stable ABI.

等价于 PyType_FromSpecWithBases(spec, NULL)。

type PyType_Spec

Part of the Stable ABI (including all members).

定义一个类型的行为的结构体。

const char *PyType_Spec.name

类型的名称，用来设置 PyTypeObject.tp_name。

int PyType_Spec.basicsize

int PyType_Spec.itemsize

以字节数表示的实例大小，用来设置 PyTypeObject.tp_basicsize 和 PyTypeObject.tp_itemsize。

int PyType_Spec.flags

类型旗标，用来设置 PyTypeObject.tp_flags。

如果未设置 Py_TPFLAGS_HEAPTYPE 旗标，则 PyType_FromSpecWithBases() 会自动设置它。

PyType_Slot *PyType_Spec.slots

PyType_Slot 结构体的数组。 以特殊槽位值 {0, NULL} 来结束。

type PyType_Slot

Part of the Stable ABI (including all members).

定义一个类型的可选功能的结构体，包含一个槽位 ID 和一个值指针。

int PyType_Slot.slot

槽位 ID。

槽位 ID 的类名像是结构体 PyTypeObject, PyNumberMethods, PySequenceMethods, PyMappingMethods 和 PyAsyncMethods 的字段名附加一个 Py_ 前缀。 举例来说，使用:

Py_tp_dealloc 设置 PyTypeObject.tp_dealloc

Py_nb_add 设置 PyNumberMethods.nb_add

Py_sq_length 设置 PySequenceMethods.sq_length

下列字段完全无法使得 PyType_Spec 和 PyType_Slot 来设置:

tp_dict

tp_mro

tp_cache

tp_subclasses

tp_weaklist

tp_vectorcall

tp_weaklistoffset (参见 PyMemberDef)

tp_dictoffset (参见 PyMemberDef)

tp_vectorcall_offset (参见 PyMemberDef)

下列字段在受限 API 下无法使用 PyType_Spec 和 PyType_Slot 来设置:

bf_getbuffer

bf_releasebuffer

设置 Py_tp_bases 或 Py_tp_base 在某些平台上可能会有问题。 为了避免问题，请改用 PyType_FromSpecWithBases() 的 bases 参数。

在 3.9 版更改: PyBufferProcs 中的槽位可能会在不受限 API 中被设置。

void *PyType_Slot.pfunc

该槽位的预期值。 在大多数情况下，这将是一个指向函数的指针。

Py_tp_doc 以外的槽位均不可为 NULL。

None 对象

请注意， None 的 PyTypeObject 不会直接在 Python / C API 中公开。 由于 None 是单例，测试对象标识（在C中使用 == ）就足够了。 由于同样的原因，没有 PyNone_Check() 函数。

PyObject *Py_None

Python None 对象，表示缺乏值。 这个对象没有方法。 它需要像引用计数一样处理任何其他对象。

Py_RETURN_NONE

正确处理来自C函数内的 Py_None 返回（也就是说，增加 None 的引用计数并返回它。）

整数型对象

所有整数都实现为长度任意的长整数对象。

在出错时，大多数 PyLong_As* API 都会返回 (return type)-1，这与数字无法区分开。请采用 PyErr_Occurred() 来加以区分。

type PyLongObject

Part of the Limited API (as an opaque struct).

表示 Python 整数对象的 PyObject 子类型。

PyTypeObject PyLong_Type

Part of the Stable ABI.

这个 PyTypeObject 的实例表示 Python 的整数类型。与 Python 语言中的 int 相同。

int PyLong_Check(PyObject *p)

如果参数是 PyLongObject 或 PyLongObject 的子类型，则返回 True。该函数一定能够执行成功。

int PyLong_CheckExact(PyObject *p)

如果其参数属于 PyLongObject，但不是 PyLongObject 的子类型则返回真值。 此函数总是会成功执行。

PyObject *PyLong_FromLong(long v)

返回值：新的引用。 Part of the Stable ABI.

由 v 返回一个新的 PyLongObject 对象，失败时返回 NULL 。

当前的实现维护着一个整数对象数组，包含 -5 和 256 之间的所有整数对象。 若创建一个位于该区间的 int 时，实际得到的将是对已有对象的引用。

PyObject *PyLong_FromUnsignedLong(unsigned long v)

返回值：新的引用。 Part of the Stable ABI.

基于 C unsigned long 返回一个新的 PyLongObject 对象，失败时返回 NULL。

PyObject *PyLong_FromSsize_t(Py_ssize_t v)

返回值：新的引用。 Part of the Stable ABI.

由 C Py_ssize_t 返回一个新的 PyLongObject 对象，失败时返回 NULL 。

PyObject *PyLong_FromSize_t(size_t v)

返回值：新的引用。 Part of the Stable ABI.

由 C size_t 返回一个新的 PyLongObject 对象，失败则返回 NULL 。

PyObject *PyLong_FromLongLong(long long v)

返回值：新的引用。 Part of the Stable ABI.

基于 C long long 返回一个新的 PyLongObject，失败时返回 NULL。

PyObject *PyLong_FromUnsignedLongLong(unsigned long long v)

返回值：新的引用。 Part of the Stable ABI.

基于 C unsigned long long 返回一个新的 PyLongObject 对象，失败时返回 NULL。

PyObject *PyLong_FromDouble(double v)

返回值：新的引用。 Part of the Stable ABI.

由 v 的整数部分返回一个新的 PyLongObject 对象，失败则返回 NULL 。

PyObject *PyLong_FromString(const char *str, char **pend, int base)

返回值：新的引用。 Part of the Stable ABI.

根据 str 字符串值返回一个新的 PyLongObject ，base 指定了整数的基。如果 pend 不为 NULL ，则 /*pend 将指向 str 中表示数字部分后面的第一个字符。如果 base 为 0 ， str 将采用 整数字面值 的定义进行解释；这时非零十进制数的前导零会触发 ValueError 。如果 base 不为 0 ，则须位于 2 和 36 之间（含 2 和 36）。基之后及数字之间的前导空格、单下划线将被忽略。如果不存在数字，将触发 ValueError。

参见

Python 方法 int.to_bytes() 和 int.from_bytes() 用于 PyLongObject 到/从字节数组之间以 256 为基数进行转换。 你可以使用 PyObject_CallMethod() 从 C 调用它们。

PyObject *PyLong_FromUnicodeObject(PyObject *u, int base)

返回值：新的引用。

将字符串 u 中的 Unicode 数字序列转换为 Python 整数值。

3.3 新版功能.

PyObject *PyLong_FromVoidPtr(void *p)

返回值：新的引用。 Part of the Stable ABI.

从指针 p 创建一个 Python 整数。可以使用 PyLong_AsVoidPtr() 返回的指针值。

long PyLong_AsLong(PyObject *obj)

Part of the Stable ABI.

Return a C long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() method (if present) to convert it to a PyLongObject.

如果 obj 的值超出了 long 的取值范围则会引发 OverflowError。

出错则返回 -1 。请用 PyErr_Occurred() 找出具体问题。

在 3.8 版更改: 如果可用将使用 __index__()。

在 3.10 版更改: 本函数不再使用 __int__() 。

long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)

Part of the Stable ABI.

Return a C long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() method (if present) to convert it to a PyLongObject.

如果 obj 的值大于 LONG_MAX 或小于 LONG_MIN，则会把 *overflow 分别置为``1`` 或 -1，并返回 1；否则，将 *overflow 置为 0。如果发生其他异常，则会按常规把 *overflow 置为 0，并返回 -1。

出错则返回 -1 。请用 PyErr_Occurred() 找出具体问题。

在 3.8 版更改: 如果可用将使用 __index__()。

在 3.10 版更改: 本函数不再使用 __int__() 。

long long PyLong_AsLongLong(PyObject *obj)

Part of the Stable ABI.

Return a C long long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() method (if present) to convert it to a PyLongObject.

如果 obj 值超出 long long 的取值范围则会引发 OverflowError。

出错则返回 -1 。请用 PyErr_Occurred() 找出具体问题。

在 3.8 版更改: 如果可用将使用 __index__()。

在 3.10 版更改: 本函数不再使用 __int__() 。

long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)

Part of the Stable ABI.

Return a C long long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() method (if present) to convert it to a PyLongObject.

如果 obj 的值大于 LLONG_MAX 或小于 LLONG_MIN，则按常规将 *overflow 分别置为 1 或 -1，并返回 -1，否则将 *overflow 置为 0。如果触发其他异常则 *overflow 置为 0 并返回 -1。

出错则返回 -1 。请用 PyErr_Occurred() 找出具体问题。

3.2 新版功能.

在 3.8 版更改: 如果可用将使用 __index__()。

在 3.10 版更改: 本函数不再使用 __int__() 。

Py_ssize_t PyLong_AsSsize_t(PyObject *pylong)

Part of the Stable ABI.

返回 pylong 的 C 语言 Py_ssize_t 形式。pylong 必须是 PyLongObject 的实例。

如果 pylong 的值超出了 Py_ssize_t 的取值范围则会引发 OverflowError。

出错则返回 -1 。请用 PyErr_Occurred() 找出具体问题。

unsigned long PyLong_AsUnsignedLong(PyObject *pylong)

Part of the Stable ABI.

返回 pylong 的 C unsigned long 表示形式。 pylong 必须是 PyLongObject 的实例。

如果 pylong 的值超出了 unsigned long 的取值范围则会引发 OverflowError。

出错时返回 (unsigned long)-1 ，请利用 PyErr_Occurred() 辨别具体问题。

size_t PyLong_AsSize_t(PyObject *pylong)

Part of the Stable ABI.

返回 pylong 的 C 语言 size_t 形式。pylong 必须是 PyLongObject 的实例。

如果 pylong 的值超出了 size_t 的取值范围则会引发 OverflowError。

出错时返回 (size_t)-1 ，请利用 PyErr_Occurred() 辨别具体问题。

unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong)

Part of the Stable ABI.

返回 pylong 的 C unsigned long long 表示形式。 pylong 必须是 PyLongObject 的实例。

如果 pylong 的值超出 unsigned long long 的取值范围则会引发 OverflowError。

出错时返回 (unsigned long long)-1，请利用 PyErr_Occurred() 辨别具体问题。

在 3.1 版更改: 现在 pylong 为负值会触发 OverflowError，而不是 TypeError。

unsigned long PyLong_AsUnsignedLongMask(PyObject *obj)

Part of the Stable ABI.

Return a C unsigned long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() method (if present) to convert it to a PyLongObject.

如果 obj 的值超出了 unsigned long 的取值范围，则返回该值对 ULONG_MAX + 1 求模的余数。

出错时返回 (unsigned long)-1，请利用 PyErr_Occurred() 辨别具体问题。

在 3.8 版更改: 如果可用将使用 __index__()。

在 3.10 版更改: 本函数不再使用 __int__() 。

unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj)

Part of the Stable ABI.

Return a C unsigned long long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() method (if present) to convert it to a PyLongObject.

如果 obj 的值超出了 unsigned long long 的取值范围，则返回该值对 ULLONG_MAX + 1 求模的余数。

出错时返回 (unsigned long long)-1，请利用 PyErr_Occurred() 辨别具体问题。

在 3.8 版更改: 如果可用将使用 __index__()。

在 3.10 版更改: 本函数不再使用 __int__() 。

double PyLong_AsDouble(PyObject *pylong)

Part of the Stable ABI.

返回 pylong 的 C double 表示形式。 pylong 必须是 PyLongObject 的实例。

如果 pylong 的值超出了 double 的取值范围则会引发 OverflowError。

出错时返回 -1.0 ，请利用 PyErr_Occurred() 辨别具体问题。

void *PyLong_AsVoidPtr(PyObject *pylong)

Part of the Stable ABI.

将一个 Python 整数 pylong 转换为 C void 指针。 如果 pylong 无法被转换，则将引发 OverflowError。 这只是为了保证将通过 PyLong_FromVoidPtr() 创建的值产生一个可用的 void 指针。

出错时返回 NULL，请利用 PyErr_Occurred() 辨别具体问题。

布尔对象

Python 中的布尔值是作为整数的子类实现的。只有 Py_False 和 Py_True 两个布尔值。因此，正常的创建和删除功能不适用于布尔值。但是，下列宏可用。

int PyBool_Check(PyObject *o)

如果 o 的类型为 PyBool_Type 则返回真值。 此函数总是会成功执行。

PyObject *Py_False

Python的 False 对象。该对象没有任何方法。它应该象其它使用引用计数管理的对象一样使用。

PyObject *Py_True

Python的 True 对象。该对象没有任何方法。它应该象其它使用引用计数管理的对象一样使用。

Py_RETURN_FALSE

从函数返回 Py_False 时，需要增加它的引用计数。

Py_RETURN_TRUE

从函数返回 Py_True 时，需要增加它的引用计数。

PyObject *PyBool_FromLong(long v)

返回值：新的引用。 Part of the Stable ABI.

根据 v 的实际值，返回一个 Py_True 或者 Py_False 的新引用。

浮点数对象

type PyFloatObject

这个C类型 PyObject 的子类型代表一个Python浮点数对象。

PyTypeObject PyFloat_Type

Part of the Stable ABI.

这是个属于C类型 PyTypeObject 的代表Python浮点类型的实例。在Python层面的类型 float 是同一个对象。

int PyFloat_Check(PyObject *p)

如果它的参数是一个 PyFloatObject 或者 PyFloatObject 的子类型则返回真值。 此函数总是会成功执行。

int PyFloat_CheckExact(PyObject *p)

如果它的参数是一个 PyFloatObject 但不是 PyFloatObject 的子类型则返回真值。 此函数总是会成功执行。

PyObject *PyFloat_FromString(PyObject *str)

返回值：新的引用。 Part of the Stable ABI.

根据字符串 str 的值创建一个 PyFloatObject，失败时返回 NULL。

PyObject *PyFloat_FromDouble(double v)

返回值：新的引用。 Part of the Stable ABI.

根据 v 创建一个 PyFloatObject 对象，失败时返回 NULL。

double PyFloat_AsDouble(PyObject *pyfloat)

Part of the Stable ABI.

Return a C double representation of the contents of pyfloat. If pyfloat is not a Python floating point object but has a __float__() method, this method will first be called to convert pyfloat into a float. If __float__() is not defined then it falls back to __index__(). This method returns -1.0 upon failure, so one should call PyErr_Occurred() to check for errors.

在 3.8 版更改: 如果可用将使用 __index__()。

double PyFloat_AS_DOUBLE(PyObject *pyfloat)

返回 pyfloat 的 C double 表示形式，但不带错误检测。

PyObject *PyFloat_GetInfo(void)

返回值：新的引用。 Part of the Stable ABI.

返回一个 structseq 实例，其中包含有关 float 的精度、最小值和最大值的信息。 它是头文件 float.h 的一个简单包装。

double PyFloat_GetMax()

Part of the Stable ABI.

返回 C double 形式的最大可表示有限浮点数 DBL_MAX。

double PyFloat_GetMin()

Part of the Stable ABI.

返回 C double 形式的最小正规化正浮点数 DBL_MIN。

复数对象

从C API看，Python的复数对象由两个不同的部分实现：一个是在Python程序使用的Python对象，另外的是一个代表真正复数值的C结构体。API提供了函数共同操作两者。

表示复数的C结构体

需要注意的是接受这些结构体的作为参数并当做结果返回的函数，都是传递“值”而不是引用指针。此规则适用于整个API。

type Py_complex

这是一个对应Python复数对象的值部分的C结构体。绝大部分处理复数对象的函数都用这类型的结构体作为输入或者输出值，它可近似地定义为：

typedef struct {
   double real;
   double imag;
} Py_complex;

Py_complex _Py_c_sum(Py_complex left, Py_complex right)

返回两个复数的和，用 C 类型 Py_complex 表示。

Py_complex _Py_c_diff(Py_complex left, Py_complex right)

返回两个复数的差，用 C 类型 Py_complex 表示。

Py_complex _Py_c_neg(Py_complex num)

返回复数 num 的负值，用 C Py_complex 表示。

Py_complex _Py_c_prod(Py_complex left, Py_complex right)

返回两个复数的乘积，用 C 类型 Py_complex 表示。

Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)

返回两个复数的商，用 C 类型 Py_complex 表示。

如果 divisor 为空，这个方法返回零并设置 errno 为 EDOM。

Py_complex _Py_c_pow(Py_complex num, Py_complex exp)

返回 num 的 exp 次幂，用 C 类型 Py_complex 表示。

如果 num 为空且 exp 不是正实数，这个方法返回零并设置 errno 为 EDOM。

表示复数的Python对象

type PyComplexObject

这个C类型 PyObject 的子类型代表一个 Python 复数对象。

PyTypeObject PyComplex_Type

Part of the Stable ABI.

这是个属于 PyTypeObject 的代表Python复数类型的实例。在Python层面的类型 complex 是同一个对象。

int PyComplex_Check(PyObject *p)

如果它的参数是一个 PyComplexObject 或者 PyComplexObject 的子类型则返回真值。 此函数总是会成功执行。

int PyComplex_CheckExact(PyObject *p)

如果它的参数是一个 PyComplexObject 但不是 PyComplexObject 的子类型则返回真值。 此函数总是会成功执行。

PyObject *PyComplex_FromCComplex(Py_complex v)

返回值：新的引用。

根据C类型 Py_complex 的值生成一个新的Python复数对象。

PyObject *PyComplex_FromDoubles(double real, double imag)

返回值：新的引用。 Part of the Stable ABI.

根据 real 和 imag 返回一个新的C类型 PyComplexObject 对象。

double PyComplex_RealAsDouble(PyObject *op)

Part of the Stable ABI.

以 C 类型 double 返回 op 的实部。

double PyComplex_ImagAsDouble(PyObject *op)

Part of the Stable ABI.

以 C 类型 double 返回 op 的虚部。

Py_complex PyComplex_AsCComplex(PyObject *op)

返回复数 op 的C类型 Py_complex 值。

如果 op 不是一个 Python 复数对象，但是具有 __complex__() 方法，此方法将首先被调用，将 op 转换为一个 Python 复数对象。 如果 __complex__() 未定义则将回退至 __float__()，如果 __float__() 未定义则将回退至 __index__()。 如果失败，此方法将返回 -1.0 作为实数值。

在 3.8 版更改: 如果可用将使用 __index__()。

bytes 对象

这些函数在期望附带一个字节串形参但却附带了一个非字节串形参被调用时会引发 TypeError。

type PyBytesObject

这种 PyObject 的子类型表示一个 Python 字节对象。

PyTypeObject PyBytes_Type

Part of the Stable ABI.

PyTypeObject 的实例代表一个 Python 字节类型，在 Python 层面它与 bytes 是相同的对象。

int PyBytes_Check(PyObject *o)

如果对象 o 是一个 bytes 对象或者 bytes 类型的子类型的实例则返回真值。 此函数总是会成功执行。

int PyBytes_CheckExact(PyObject *o)

如果对象 o 是一个 bytes 对象但不是 bytes 类型的子类型的实例则返回真值。 此函数总是会成功执行。

PyObject *PyBytes_FromString(const char *v)

返回值：新的引用。 Part of the Stable ABI.

成功时返回一个以字符串 v 的副本为值的新字节串对象，失败时返回 NULL。 形参 v 不可为 NULL；它不会被检查。

PyObject *PyBytes_FromStringAndSize(const char *v, Py_ssize_t len)

返回值：新的引用。 Part of the Stable ABI.

成功时返回一个以字符串 v 的副本为值且长度为 len 的新字节串对象，失败时返回 NULL。 如果 v 为 NULL，则不初始化字节串对象的内容。

PyObject *PyBytes_FromFormat(const char *format, ...)

返回值：新的引用。 Part of the Stable ABI.

接受一个 C printf() 风格的 format 字符串和可变数量的参数，计算结果 Python 字节串对象的大小并返回参数值经格式化后的字节串对象。 可变数量的参数必须均为 C 类型并且必须恰好与 format 字符串中的格式字符相对应。 允许使用下列格式字符串:

格式字符 | 类型 | 注释
%% | 不适用 | 文字%字符。
%c | int | 一个字节，被表示为一个 C 语言的整型
%d | int | 相当于 printf("%d"). 1
%u | unsigned int | 相当于 printf("%u"). 1
%ld | 长整型 | 相当于 printf("%ld"). 1
%lu | unsigned long | 相当于 printf("%lu"). 1
%zd | Py_ssize_t | 相当于 printf("%zd"). 1
%zu | size_t | 相当于 printf("%zu"). 1
%i | int | 相当于 printf("%i"). 1
%x | int | 相当于 printf("%x"). 1
%s | const char* | 以 null 为终止符的 C 字符数组。
%p | const void* | 一个 C 指针的十六进制表示形式。 基本等价于 printf("%p") 但它会确保以字面值 0x 开头，不论系统平台上 printf 的输出是什么。

无法识别的格式字符会导致将格式字符串的其余所有内容原样复制到结果对象，并丢弃所有多余的参数。

1(1,2,3,4,5,6,7,8)

对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。

PyObject *PyBytes_FromFormatV(const char *format, va_list vargs)

返回值：新的引用。 Part of the Stable ABI.

与 PyBytes_FromFormat() 完全相同，除了它需要两个参数。

PyObject *PyBytes_FromObject(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

返回字节表示实现缓冲区协议的对象*o*。

Py_ssize_t PyBytes_Size(PyObject *o)

Part of the Stable ABI.

返回字节对象*o*中字节的长度。

Py_ssize_t PyBytes_GET_SIZE(PyObject *o)

宏版本的 PyBytes_Size() 但是不带错误检测。

char *PyBytes_AsString(PyObject *o)

Part of the Stable ABI.

返回对应 o 的内容的指针。 该指针指向 o 的内部缓冲区，其中包含 len(o) + 1 个字节。 缓冲区的最后一个字节总是为空，不论是否存在其他空字节。 该数据不可通过任何形式来修改，除非是刚使用 PyBytes_FromStringAndSize(NULL, size) 创建该对象。 它不可被撤销分配。 如果 o 根本不是一个字节串对象，则 PyBytes_AsString() 将返回 NULL 并引发 TypeError。

char *PyBytes_AS_STRING(PyObject *string)

宏版本的 PyBytes_AsString() 但是不带错误检测。

int PyBytes_AsStringAndSize(PyObject *obj, char **buffer, Py_ssize_t *length)

Part of the Stable ABI.

通过输出变量 buffer 和 length 返回以 null 为终止符的对象 obj 的内容。

如果 length 为 NULL，字节串对象就不包含嵌入的空字节；如果包含，则该函数将返回 -1 并引发 ValueError。

该缓冲区指向 obj 的内部缓冲，它的末尾包含一个额外的空字节（不算在 length 当中）。 该数据不可通过任何方式来修改，除非是刚使用 PyBytes_FromStringAndSize(NULL, size) 创建该对象。 它不可被撤销分配。 如果 obj 根本不是一个字节串对象，则 PyBytes_AsStringAndSize() 将返回 -1 并引发 TypeError。

在 3.5 版更改: 以前，当字节串对象中出现嵌入的空字节时将引发 TypeError。

void PyBytes_Concat(PyObject **bytes, PyObject *newpart)

Part of the Stable ABI.

在 *bytes 中创建新的字节串对象，其中包含添加到 bytes 的 newpart 的内容；调用者将获得新的引用。 对 bytes 原值的引用将被收回。 如果无法创建新对象，对 bytes 的旧引用仍将被丢弃且 *bytes 的值将被设为 NULL；并将设置适当的异常。

void PyBytes_ConcatAndDel(PyObject **bytes, PyObject *newpart)

Part of the Stable ABI.

在 *bytes 中创建一个新的字节串对象，其中包含添加到 bytes 的 newpart 的内容。 此版本将释放对 newpart 的 strong reference (即递减其引用计数)。

int _PyBytes_Resize(PyObject **bytes, Py_ssize_t newsize)

改变字节串大小的一种方式，即使其为“不可变对象”。 此方式仅用于创建全新的字节串对象；如果字节串在代码的其他部分已知则不可使用此方式。 如果输入字节串对象的引用计数不为一则调用此函数将报错。 传入一个现有字节串对象的地址作为 lvalue（它可能会被写入），并传入希望的新大小。 当成功时，*bytes 将存放改变大小后的字节串对象并返回 0；*bytes 中的地址可能与其输入值不同。 如果重新分配失败，则 *bytes 上的原字节串对象将被撤销分配，*bytes 会被设为 NULL，同时设置 MemoryError 并返回 -1。

字节数组对象

type PyByteArrayObject

这个 PyObject 的子类型表示一个 Python 字节数组对象。

PyTypeObject PyByteArray_Type

Part of the Stable ABI.

Python bytearray 类型表示为 PyTypeObject 的实例；这与Python层面的 bytearray 是相同的对象。

类型检查宏

int PyByteArray_Check(PyObject *o)

如果对象 o 是一个 bytearray 对象或者 bytearray 类型的子类型的实例则返回真值。 此函数总是会成功执行。

int PyByteArray_CheckExact(PyObject *o)

如果对象 o 是一个 bytearray 对象但不是 bytearray 类型的子类型的实例则返回真值。 此函数总是会成功执行。

直接 API 函数

PyObject *PyByteArray_FromObject(PyObject *o)

返回值：新的引用。 Part of the Stable ABI.

根据任何实现了 缓冲区协议 的对象 o，返回一个新的字节数组对象。

PyObject *PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len)

返回值：新的引用。 Part of the Stable ABI.

根据 string 及其长度 len 创建一个新的 bytearray 对象。 当失败时返回 NULL。

PyObject *PyByteArray_Concat(PyObject *a, PyObject *b)

返回值：新的引用。 Part of the Stable ABI.

连接字节数组 a 和 b 并返回一个带有结果的新的字节数组。

Py_ssize_t PyByteArray_Size(PyObject *bytearray)

Part of the Stable ABI.

在检查 NULL 指针后返回 bytearray 的大小。

char *PyByteArray_AsString(PyObject *bytearray)

Part of the Stable ABI.

在检查 NULL 指针后返回将 bytearray 返回为一个字符数组。 返回的数组总是会附加一个额外的空字节。

int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)

Part of the Stable ABI.

将 bytearray 的内部缓冲区的大小调整为 len。

宏

这些宏减低安全性以换取性能，它们不检查指针。

char *PyByteArray_AS_STRING(PyObject *bytearray)

C函数 PyByteArray_AsString() 的宏版本。

Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)

C函数 PyByteArray_Size() 的宏版本。

Unicode对象和编解码器

Unicode对象

自从python3.3中实现了 PEP 393 [https://www.python.org/dev/peps/pep-0393] 以来，Unicode对象在内部使用各种表示形式，以便在保持内存效率的同时处理完整范围的Unicode字符。对于所有代码点都低于128、256或65536的字符串，有一些特殊情况；否则，代码点必须低于1114112（这是完整的Unicode范围）。

Py_UNICODE* 和 UTF-8 表示形式将按需创建并缓存至 Unicode 对象。 Py_UNICODE* 表示形式是已弃用且低效率的。

由于旧API和新API之间的转换，Unicode对象内部可以处于两种状态，这取决于它们的创建方式：

“规范”Unicode对象是由非弃用的Unicode API创建的所有对象。它们使用实现所允许的最有效的表达方式。

"legacy" Unicode objects have been created through one of the deprecated APIs (typically PyUnicode_FromUnicode()) and only bear the Py_UNICODE* representation; you will have to call PyUnicode_READY() on them before calling any other API.

注解

The "legacy" Unicode object will be removed in Python 3.12 with deprecated APIs. All Unicode objects will be "canonical" since then. See PEP 623 [https://www.python.org/dev/peps/pep-0623] for more information.

Unicode类型

以下是用于Python中Unicode实现的基本Unicode对象类型：

type Py_UCS4

type Py_UCS2

type Py_UCS1

Part of the Stable ABI.

这些类型是无符号整数类型的类型定义，其宽度足以分别包含 32 位、16 位和 8 位字符。 当需要处理单个 Unicode 字符时，请使用 Py_UCS4。

3.3 新版功能.

type Py_UNICODE

This is a typedef of wchar_t, which is a 16-bit type or 32-bit type depending on the platform.

在 3.3 版更改: 在以前的版本中，这是16位类型还是32位类型，这取决于您在构建时选择的是“窄”还是“宽”Unicode版本的Python。

type PyASCIIObject

type PyCompactUnicodeObject

type PyUnicodeObject

这些关于 PyObject 的子类型表示了一个 Python Unicode 对象。 在几乎所有情形下，它们不应该被直接使用，因为所有处理 Unicode 对象的 API 函数都接受并返回 PyObject 类型的指针。

3.3 新版功能.

PyTypeObject PyUnicode_Type

Part of the Stable ABI.

这个 PyTypeObject 实例代表 Python Unicode 类型。 它作为 str 公开给 Python 代码。

The following APIs are really C macros and can be used to do fast checks and to access internal read-only data of Unicode objects:

int PyUnicode_Check(PyObject *o)

如果对象*o*是Unicode对象或Unicode子类型的实例，则返回“真"。此函数始终成功。

int PyUnicode_CheckExact(PyObject *o)

如果对象*o*是Unicode对象，但不是子类型的实例，则返回“真”。此函数始终成功。

int PyUnicode_READY(PyObject *o)

确保字符串对象*o*处于“规范的”表达方式。在使用下面描述的任何访问宏之前，这是必需的。

Returns 0 on success and -1 with an exception set on failure, which in particular happens if memory allocation fails.

3.3 新版功能.

Deprecated since version 3.10, will be removed in version 3.12: This API will be removed with PyUnicode_FromUnicode().

Py_ssize_t PyUnicode_GET_LENGTH(PyObject *o)

返回Unicode字符串的长度（以代码点为单位）*o*必须是“规范”表达方式中的Unicode对象（未选中）。

3.3 新版功能.

Py_UCS1 *PyUnicode_1BYTE_DATA(PyObject *o)

Py_UCS2 *PyUnicode_2BYTE_DATA(PyObject *o)

Py_UCS4 *PyUnicode_4BYTE_DATA(PyObject *o)

Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4 integer types for direct character access. No checks are performed if the canonical representation has the correct character size; use PyUnicode_KIND() to select the right macro. Make sure PyUnicode_READY() has been called before accessing this.

3.3 新版功能.

PyUnicode_WCHAR_KIND

PyUnicode_1BYTE_KIND

PyUnicode_2BYTE_KIND

PyUnicode_4BYTE_KIND

返回 PyUnicode_KIND() 宏的值。

3.3 新版功能.

Deprecated since version 3.10, will be removed in version 3.12: PyUnicode_WCHAR_KIND 已被弃用。

unsigned int PyUnicode_KIND(PyObject *o)

返回一个PyUnicode类常量（见上文），指示此Unicode对象用于存储其数据的每个字符的字节数*o*必须是“规范”表达方式中的Unicode对象（未选中）。

3.3 新版功能.

void *PyUnicode_DATA(PyObject *o)

返回指向原始Unicode缓冲区的空指针*o*必须是“规范”表达方式中的Unicode对象（未选中）。

3.3 新版功能.

void PyUnicode_WRITE(int kind, void *data, Py_ssize_t index, Py_UCS4 value)

Write into a canonical representation data (as obtained with PyUnicode_DATA()). This macro does not do any sanity checks and is intended for usage in loops. The caller should cache the kind value and data pointer as obtained from other macro calls. index is the index in the string (starts at 0) and value is the new code point value which should be written to that location.

3.3 新版功能.

Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index)

从规范表示的 data (如同用 PyUnicode_DATA() 获取) 中读取一个码位。 不会执行检查或就绪调用。

3.3 新版功能.

Py_UCS4 PyUnicode_READ_CHAR(PyObject *o, Py_ssize_t index)

从 Unicode 对象 o 读取一个字符，必须使用“规范”表示形式。 如果你执行行多次连续读取则此函数的效率将低于 PyUnicode_READ()。

3.3 新版功能.

PyUnicode_MAX_CHAR_VALUE(o)

返回适合于基于*o*创建另一个字符串的最大代码点，该字符串必须在“规范”表达方式中。这始终是一种近似，但比在字符串上迭代更有效。

3.3 新版功能.

Py_ssize_t PyUnicode_GET_SIZE(PyObject *o)

Return the size of the deprecated Py_UNICODE representation, in code units (this includes surrogate pairs as 2 units). o has to be a Unicode object (not checked).

Deprecated since version 3.3, will be removed in version 3.12: 旧式 Unicode API 的一部分，请迁移到使用 PyUnicode_GET_LENGTH()。

Py_ssize_t PyUnicode_GET_DATA_SIZE(PyObject *o)

Return the size of the deprecated Py_UNICODE representation in bytes. o has to be a Unicode object (not checked).

Deprecated since version 3.3, will be removed in version 3.12: 旧式 Unicode API 的一部分，请迁移到使用 PyUnicode_GET_LENGTH()。

Py_UNICODE *PyUnicode_AS_UNICODE(PyObject *o)

const char *PyUnicode_AS_DATA(PyObject *o)

Return a pointer to a Py_UNICODE representation of the object. The returned buffer is always terminated with an extra null code point. It may also contain embedded null code points, which would cause the string to be truncated when used in most C functions. The AS_DATA form casts the pointer to const char*. The o argument has to be a Unicode object (not checked).

在 3.3 版更改: This macro is now inefficient -- because in many cases the Py_UNICODE representation does not exist and needs to be created -- and can fail (return NULL with an exception set). Try to port the code to use the new PyUnicode_nBYTE_DATA() macros or use PyUnicode_WRITE() or PyUnicode_READ().

Deprecated since version 3.3, will be removed in version 3.12: 旧式 Unicode API 的一部分，请迁移到使用 PyUnicode_nBYTE_DATA() 宏族。

int PyUnicode_IsIdentifier(PyObject *o)

Part of the Stable ABI.

如果字符串按照语言定义是合法的标识符则返回 1，参见 标识符和关键字 小节。 否则返回 0。

在 3.9 版更改: 如果字符串尚未就绪则此函数不会再调用 Py_FatalError()。

Unicode字符属性

Unicode提供了许多不同的字符特性。最常需要的宏可以通过这些宏获得，这些宏根据Python配置映射到C函数。

int Py_UNICODE_ISSPACE(Py_UCS4 ch)

根据 ch 是否为空白字符返回 1 或 0。

int Py_UNICODE_ISLOWER(Py_UCS4 ch)

根据 ch 是否为小写字符返回 1 或 0。

int Py_UNICODE_ISUPPER(Py_UCS4 ch)

根据 ch 是否为大写字符返回 1 或 0

int Py_UNICODE_ISTITLE(Py_UCS4 ch)

根据 ch 是否为标题化的大小写返回 1 或 0。

int Py_UNICODE_ISLINEBREAK(Py_UCS4 ch)

根据 ch 是否为换行类字符返回 1 或 0。

int Py_UNICODE_ISDECIMAL(Py_UCS4 ch)

根据 ch 是否为十进制数字符返回 1 或 0。

int Py_UNICODE_ISDIGIT(Py_UCS4 ch)

根据 ch 是否为数码类字符返回 1 或 0。

int Py_UNICODE_ISNUMERIC(Py_UCS4 ch)

根据 ch 是否为数值类字符返回 1 或 0。

int Py_UNICODE_ISALPHA(Py_UCS4 ch)

根据 ch 是否为字母类字符返回 1 或 0。

int Py_UNICODE_ISALNUM(Py_UCS4 ch)

根据 ch 是否为字母数字类字符返回 1 或 0。

int Py_UNICODE_ISPRINTABLE(Py_UCS4 ch)

根据 ch 是否为可打印字符返回 1 或``0``。 不可打印字符是指在 Unicode 字符数据库中被定义为 "Other" 或 "Separator" 的字符，例外情况是 ASCII 空格 (0x20) 被视为可打印字符。 (请注意在此语境下可打印字符是指当在字符串上唤起 repr() 时不应被转义的字符。 它们字符串写入 sys.stdout 或 sys.stderr 时所需的处理无关)。

这些 API 可用于快速直接的字符转换：

Py_UCS4 Py_UNICODE_TOLOWER(Py_UCS4 ch)

返回转换为小写形式的字符 ch。

3.3 版后已移除: 此函数使用简单的大小写映射。

Py_UCS4 Py_UNICODE_TOUPPER(Py_UCS4 ch)

返回转换为大写形式的字符 ch。

3.3 版后已移除: 此函数使用简单的大小写映射。

Py_UCS4 Py_UNICODE_TOTITLE(Py_UCS4 ch)

返回转换为标题大小写形式的字符 ch。

3.3 版后已移除: 此函数使用简单的大小写映射。

int Py_UNICODE_TODECIMAL(Py_UCS4 ch)

Return the character ch converted to a decimal positive integer. Return -1 if this is not possible. This macro does not raise exceptions.

int Py_UNICODE_TODIGIT(Py_UCS4 ch)

Return the character ch converted to a single digit integer. Return -1 if this is not possible. This macro does not raise exceptions.

double Py_UNICODE_TONUMERIC(Py_UCS4 ch)

Return the character ch converted to a double. Return -1.0 if this is not possible. This macro does not raise exceptions.

这些 API 可被用来操作代理项：

Py_UNICODE_IS_SURROGATE(ch)

检测 ch 是否为代理项 (0xD800 <= ch <= 0xDFFF)。

Py_UNICODE_IS_HIGH_SURROGATE(ch)

检测 ch 是否为高代理项 (0xD800 <= ch <= 0xDBFF)。

Py_UNICODE_IS_LOW_SURROGATE(ch)

检测 ch 是否为低代理项 (0xDC00 <= ch <= 0xDFFF)。

Py_UNICODE_JOIN_SURROGATES(high, low)

Join two surrogate characters and return a single Py_UCS4 value. high and low are respectively the leading and trailing surrogates in a surrogate pair.

创建和访问 Unicode 字符串

要创建 Unicode 对象和访问其基本序列属性，请使用这些 API：

PyObject *PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar)

返回值：新的引用。

创建一个新的 Unicode 对象。 maxchar 应为可放入字符串的实际最大码位。 作为一个近似值，它可被向上舍入到序列 127, 255, 65535, 1114111 中最接近的值。

这是分配新的 Unicode 对象的推荐方式。 使用此函数创建的对象不可改变大小。

3.3 新版功能.

PyObject *PyUnicode_FromKindAndData(int kind, const void *buffer, Py_ssize_t size)

返回值：新的引用。

以给定的 kind 创建一个新的 Unicode 对象（可能的值为 PyUnicode_1BYTE_KIND 等，即 PyUnicode_KIND() 所返回的值）。 buffer 必须指向由此分类所给出的，以每字符 1, 2 或 4 字节单位的 size 大小的数组。

3.3 新版功能.

PyObject *PyUnicode_FromStringAndSize(const char *u, Py_ssize_t size)

返回值：新的引用。 Part of the Stable ABI.

Create a Unicode object from the char buffer u. The bytes will be interpreted as being UTF-8 encoded. The buffer is copied into the new object. If the buffer is not NULL, the return value might be a shared object, i.e. modification of the data is not allowed.

If u is NULL, this function behaves like PyUnicode_FromUnicode() with the buffer set to NULL. This usage is deprecated in favor of PyUnicode_New(), and will be removed in Python 3.12.

PyObject *PyUnicode_FromString(const char *u)

返回值：新的引用。 Part of the Stable ABI.

根据 UTF-8 编码的以空值结束的字符缓冲区 u 创建一个 Unicode 对象。

PyObject *PyUnicode_FromFormat(const char *format, ...)

返回值：新的引用。 Part of the Stable ABI.

Take a C printf()-style format string and a variable number of arguments, calculate the size of the resulting Python Unicode string and return a string with the values formatted into it. The variable arguments must be C types and must correspond exactly to the format characters in the format ASCII-encoded string. The following format characters are allowed:

格式字符 | 类型 | 注释
%% | 不适用 | 文字%字符。
%c | int | 单个字符，表示为C 语言的整型。
%d | int | 相当于 printf("%d"). 1
%u | unsigned int | 相当于 printf("%u"). 1
%ld | 长整型 | 相当于 printf("%ld"). 1
%li | 长整型 | 相当于 printf("%li"). 1
%lu | unsigned long | 相当于 printf("%lu"). 1
%lld | long long | 相当于 printf("%lld"). 1
%lli | long long | 相当于 printf("%lli"). 1
%llu | unsigned long long | 相当于 printf("%llu"). 1
%zd | Py_ssize_t | 相当于 printf("%zd"). 1
%zi | Py_ssize_t | 相当于 printf("%zi"). 1
%zu | size_t | 相当于 printf("%zu"). 1
%i | int | 相当于 printf("%i"). 1
%x | int | 相当于 printf("%x"). 1
%s | const char* | 以 null 为终止符的 C 字符数组。
%p | const void* | 一个 C 指针的十六进制表示形式。 基本等价于 printf("%p") 但它会确保以字面值 0x 开头，不论系统平台上 printf 的输出是什么。
%A | PyObject* | ascii() 调用的结果。
%U | PyObject* | 一个 Unicode 对象。
%V | PyObject*, const char* | 一个 Unicode 对象 (可以为 NULL) 和一个以空值结束的 C 字符数组作为第二个形参（如果第一个形参为 NULL，第二个形参将被使用）。
%S | PyObject* | 调用 PyObject_Str() 的结果。
%R | PyObject* | 调用 PyObject_Repr() 的结果。

An unrecognized format character causes all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded.

注解

The width formatter unit is number of characters rather than bytes. The precision formatter unit is number of bytes for "%s" and "%V" (if the PyObject* argument is NULL), and a number of characters for "%A", "%U", "%S", "%R" and "%V" (if the PyObject* argument is not NULL).

1(1,2,3,4,5,6,7,8,9,10,11,12,13)

For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd, zi, zu, i, x): the 0-conversion flag has effect even when a precision is given.

在 3.2 版更改: 增加了对 "%lld" 和 "%llu" 的支持。

在 3.3 版更改: 增加了对 "%li", "%lli" 和 "%zi" 的支持。

在 3.4 版更改: 增加了对 "%s", "%A", "%U", "%V", "%S", "%R" 的宽度和精度格式符支持。

PyObject *PyUnicode_FromFormatV(const char *format, va_list vargs)

返回值：新的引用。 Part of the Stable ABI.

等同于 PyUnicode_FromFormat() 但它将接受恰好两个参数。

PyObject *PyUnicode_FromEncodedObject(PyObject *obj, const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

将一个已编码的对象 obj 解码为 Unicode 对象。

bytes, bytearray 和其他 字节类对象 将按照给定的 encoding 来解码并使用由 errors 定义的错误处理方式。 两者均可为 NULL 即让接口使用默认值（请参阅 内置编解码器 了解详情）。

所有其他对象，包括 Unicode 对象，都将导致设置 TypeError。

如有错误该 API 将返回 NULL。 调用方要负责递减指向所返回对象的引用。

Py_ssize_t PyUnicode_GetLength(PyObject *unicode)

Part of the Stable ABI since version 3.7.

返回 Unicode 对象码位的长度。

3.3 新版功能.

Py_ssize_t PyUnicode_CopyCharacters(PyObject *to, Py_ssize_t to_start, PyObject *from, Py_ssize_t from_start, Py_ssize_t how_many)

Copy characters from one Unicode object into another. This function performs character conversion when necessary and falls back to memcpy() if possible. Returns -1 and sets an exception on error, otherwise returns the number of copied characters.

3.3 新版功能.

Py_ssize_t PyUnicode_Fill(PyObject *unicode, Py_ssize_t start, Py_ssize_t length, Py_UCS4 fill_char)

使用一个字符填充字符串：将 fill_char 写入 unicode[start:start+length]。

如果 fill_char 值大于字符串最大字符值，或者如果字符串有 1 以上的引用将执行失败。

返回写入的字符数量，或者在出错时返回 -1 并引发一个异常。

3.3 新版功能.

int PyUnicode_WriteChar(PyObject *unicode, Py_ssize_t index, Py_UCS4 character)

Part of the Stable ABI since version 3.7.

将一个字符写入到字符串。 字符串必须通过 PyUnicode_New() 创建。 由于 Unicode 字符串应当是不可变的，因此该字符串不能被共享，或是被哈希。

该函数将检查 unicode 是否为 Unicode 对象，索引是否未越界，并且对象是否可被安全地修改（即其引用计数为一）。

3.3 新版功能.

Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index)

Part of the Stable ABI since version 3.7.

Read a character from a string. This function checks that unicode is a Unicode object and the index is not out of bounds, in contrast to the macro version PyUnicode_READ_CHAR().

3.3 新版功能.

PyObject *PyUnicode_Substring(PyObject *str, Py_ssize_t start, Py_ssize_t end)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

返回 str 的一个子串，从字符索引 start (包括) 到字符索引 end (不包括)。 不支持负索引号。

3.3 新版功能.

Py_UCS4 *PyUnicode_AsUCS4(PyObject *u, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)

Part of the Stable ABI since version 3.7.

将字符串 u 拷贝到一个 UCS4 缓冲区，包括一个空字符，如果设置了 copy_null 的话。 出错时返回 NULL 并设置一个异常（特别是当 buflen 小于 u 的长度时，SystemError 将被设置）。 成功时返回 buffer。

3.3 新版功能.

Py_UCS4 *PyUnicode_AsUCS4Copy(PyObject *u)

Part of the Stable ABI since version 3.7.

将字符串 u 拷贝到使用 PyMem_Malloc() 分配的新 UCS4 缓冲区。 如果执行失败，将返回 NULL 并设置 MemoryError。 返回的缓冲区将总是会添加一个额外的空码位。

3.3 新版功能.

已弃用的 Py_UNICODE API

Deprecated since version 3.3, will be removed in version 3.12.

These API functions are deprecated with the implementation of PEP 393 [https://www.python.org/dev/peps/pep-0393]. Extension modules can continue using them, as they will not be removed in Python 3.x, but need to be aware that their use can now cause performance and memory hits.

PyObject *PyUnicode_FromUnicode(const Py_UNICODE *u, Py_ssize_t size)

返回值：新的引用。

Create a Unicode object from the Py_UNICODE buffer u of the given size. u may be NULL which causes the contents to be undefined. It is the user's responsibility to fill in the needed data. The buffer is copied into the new object.

If the buffer is not NULL, the return value might be a shared object. Therefore, modification of the resulting Unicode object is only allowed when u is NULL.

If the buffer is NULL, PyUnicode_READY() must be called once the string content has been filled before using any of the access macros such as PyUnicode_KIND().

Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using PyUnicode_FromKindAndData(), PyUnicode_FromWideChar(), or PyUnicode_New().

Py_UNICODE *PyUnicode_AsUnicode(PyObject *unicode)

Return a read-only pointer to the Unicode object's internal Py_UNICODE buffer, or NULL on error. This will create the Py_UNICODE* representation of the object if it is not yet available. The buffer is always terminated with an extra null code point. Note that the resulting Py_UNICODE string may also contain embedded null code points, which would cause the string to be truncated when used in most C functions.

Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using PyUnicode_AsUCS4(), PyUnicode_AsWideChar(), PyUnicode_ReadChar() or similar new APIs.

PyObject *PyUnicode_TransformDecimalToASCII(Py_UNICODE *s, Py_ssize_t size)

返回值：新的引用。

Create a Unicode object by replacing all decimal digits in Py_UNICODE buffer of the given size by ASCII digits 0--9 according to their decimal value. Return NULL if an exception occurs.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using Py_UNICODE_TODECIMAL().

Py_UNICODE *PyUnicode_AsUnicodeAndSize(PyObject *unicode, Py_ssize_t *size)

Like PyUnicode_AsUnicode(), but also saves the Py_UNICODE() array length (excluding the extra null terminator) in size. Note that the resulting Py_UNICODE* string may contain embedded null code points, which would cause the string to be truncated when used in most C functions.

3.3 新版功能.

Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using PyUnicode_AsUCS4(), PyUnicode_AsWideChar(), PyUnicode_ReadChar() or similar new APIs.

Py_ssize_t PyUnicode_GetSize(PyObject *unicode)

Part of the Stable ABI.

Return the size of the deprecated Py_UNICODE representation, in code units (this includes surrogate pairs as 2 units).

Deprecated since version 3.3, will be removed in version 3.12: 旧式 Unicode API 的一部分，请迁移到使用 PyUnicode_GET_LENGTH()。

PyObject *PyUnicode_FromObject(PyObject *obj)

返回值：新的引用。 Part of the Stable ABI.

Copy an instance of a Unicode subtype to a new true Unicode object if necessary. If obj is already a true Unicode object (not a subtype), return the reference with incremented refcount.

非 Unicode 或其子类型的对象将导致 TypeError。

语言区域编码格式

当前语言区域编码格式可被用来解码来自操作系统的文本。

PyObject *PyUnicode_DecodeLocaleAndSize(const char *str, Py_ssize_t len, const char *errors)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

解码字符串在 Android 和 VxWorks 上使用 UTF-8，在其他平台上则使用当前语言区域编码格式。 支持的错误处理器有 "strict" 和 "surrogateescape" (PEP 383 [https://www.python.org/dev/peps/pep-0383])。 如果 errors 为 NULL 则解码器将使用 "strict" 错误处理器。 str 必须以一个空字符结束但不可包含嵌入的空字符。

Use PyUnicode_DecodeFSDefaultAndSize() to decode a string from Py_FileSystemDefaultEncoding (the locale encoding read at Python startup).

此函数将忽略 Python UTF-8 模式。

参见

The Py_DecodeLocale() 函数。

3.3 新版功能.

在 3.7 版更改: 此函数现在也会为 surrogateescape 错误处理器使用当前语言区域编码格式，但在 Android 上例外。 在之前版本中，Py_DecodeLocale() 将被用于 surrogateescape，而当前语言区域编码格式将被用于 strict。

PyObject *PyUnicode_DecodeLocale(const char *str, const char *errors)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

Similar to PyUnicode_DecodeLocaleAndSize(), but compute the string length using strlen().

3.3 新版功能.

PyObject *PyUnicode_EncodeLocale(PyObject *unicode, const char *errors)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

编码 Unicode 对象在 Android 和 VxWorks 上使用 UTF-8，在其他平台上使用当前语言区域编码格式。 支持的错误处理器有 "strict" 和 "surrogateescape" (PEP 383 [https://www.python.org/dev/peps/pep-0383])。 如果 errors 为 NULL 则编码器将使用 "strict" 错误处理器。 返回一个 bytes 对象。 unicode 不可包含嵌入的空字符。

Use PyUnicode_EncodeFSDefault() to encode a string to Py_FileSystemDefaultEncoding (the locale encoding read at Python startup).

此函数将忽略 Python UTF-8 模式。

参见

Py_EncodeLocale() 函数。

3.3 新版功能.

在 3.7 版更改: 此函数现在也会为 surrogateescape 错误处理器使用当前语言区域编码格式，但在 Android 上例外。 在之前版本中，Py_EncodeLocale() 将被用于 surrogateescape，而当前语言区域编码格式将被用于 strict。

文件系统编码格式

To encode and decode file names and other environment strings, Py_FileSystemDefaultEncoding should be used as the encoding, and Py_FileSystemDefaultEncodeErrors should be used as the error handler (PEP 383 [https://www.python.org/dev/peps/pep-0383] and PEP 529 [https://www.python.org/dev/peps/pep-0529]). To encode file names to bytes during argument parsing, the "O&" converter should be used, passing PyUnicode_FSConverter() as the conversion function:

int PyUnicode_FSConverter(PyObject *obj, void *result)

Part of the Stable ABI.

ParseTuple 转换器：编码 str 对象 -- 直接获取或是通过 os.PathLike 接口 -- 使用 PyUnicode_EncodeFSDefault() 转为 bytes；bytes 对象将被原样输出。 result 必须为 PyBytesObject* 并将在其不再被使用时释放。

3.1 新版功能.

在 3.6 版更改: 接受一个 path-like object。

要在参数解析期间将文件名解码为 str，应当使用 "O&" 转换器，传入 PyUnicode_FSDecoder() 作为转换函数：

int PyUnicode_FSDecoder(PyObject *obj, void *result)

Part of the Stable ABI.

ParseTuple 转换器：解码 bytes 对象 -- 直接获取或是通过 os.PathLike 接口间接获取 -- 使用 PyUnicode_DecodeFSDefaultAndSize() 转为 str；str 对象将被原样输出。 result 必须为 PyUnicodeObject* 并将在其不再被使用时释放。

3.2 新版功能.

在 3.6 版更改: 接受一个 path-like object。

PyObject *PyUnicode_DecodeFSDefaultAndSize(const char *s, Py_ssize_t size)

返回值：新的引用。 Part of the Stable ABI.

使用 filesystem encoding and error handler 解码字符串。

If Py_FileSystemDefaultEncoding is not set, fall back to the locale encoding.

Py_FileSystemDefaultEncoding is initialized at startup from the locale encoding and cannot be modified later. If you need to decode a string from the current locale encoding, use PyUnicode_DecodeLocaleAndSize().

参见

The Py_DecodeLocale() 函数。

在 3.6 版更改: Use Py_FileSystemDefaultEncodeErrors error handler.

PyObject *PyUnicode_DecodeFSDefault(const char *s)

返回值：新的引用。 Part of the Stable ABI.

使用 filesystem encoding and error handler 解码以空值结尾的字符串。

If Py_FileSystemDefaultEncoding is not set, fall back to the locale encoding.

Use PyUnicode_DecodeFSDefaultAndSize() if you know the string length.

在 3.6 版更改: Use Py_FileSystemDefaultEncodeErrors error handler.

PyObject *PyUnicode_EncodeFSDefault(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

Encode a Unicode object to Py_FileSystemDefaultEncoding with the Py_FileSystemDefaultEncodeErrors error handler, and return bytes. Note that the resulting bytes object may contain null bytes.

If Py_FileSystemDefaultEncoding is not set, fall back to the locale encoding.

Py_FileSystemDefaultEncoding is initialized at startup from the locale encoding and cannot be modified later. If you need to encode a string to the current locale encoding, use PyUnicode_EncodeLocale().

参见

Py_EncodeLocale() 函数。

3.2 新版功能.

在 3.6 版更改: Use Py_FileSystemDefaultEncodeErrors error handler.

wchar_t 支持

wchar_t support for platforms which support it:

PyObject *PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size)

返回值：新的引用。 Part of the Stable ABI.

Create a Unicode object from the wchar_t buffer w of the given size. Passing -1 as the size indicates that the function must itself compute the length, using wcslen. Return NULL on failure.

Py_ssize_t PyUnicode_AsWideChar(PyObject *unicode, wchar_t *w, Py_ssize_t size)

Part of the Stable ABI.

Copy the Unicode object contents into the wchar_t buffer w. At most size wchar_t characters are copied (excluding a possibly trailing null termination character). Return the number of wchar_t characters copied or -1 in case of an error. Note that the resulting wchar_t* string may or may not be null-terminated. It is the responsibility of the caller to make sure that the wchar_t* string is null-terminated in case this is required by the application. Also, note that the wchar_t* string might contain null characters, which would cause the string to be truncated when used with most C functions.

wchar_t *PyUnicode_AsWideCharString(PyObject *unicode, Py_ssize_t *size)

Part of the Stable ABI since version 3.7.

Convert the Unicode object to a wide character string. The output string always ends with a null character. If size is not NULL, write the number of wide characters (excluding the trailing null termination character) into *size. Note that the resulting wchar_t string might contain null characters, which would cause the string to be truncated when used with most C functions. If size is NULL and the wchar_t* string contains null characters a ValueError is raised.

Returns a buffer allocated by PyMem_Alloc() (use PyMem_Free() to free it) on success. On error, returns NULL and *size is undefined. Raises a MemoryError if memory allocation is failed.

3.2 新版功能.

在 3.7 版更改: 如果 size 为 NULL 且 wchar_t* 字符串包含空字符则会引发 ValueError。

内置编解码器

Python 提供了一组以 C 编写以保证运行速度的内置编解码器。 所有这些编解码器均可通过下列函数直接使用。

下列 API 大都接受 encoding 和 errors 两个参数，它们具有与在内置 str() 字符串对象构造器中同名参数相同的语义。

Setting encoding to NULL causes the default encoding to be used which is UTF-8. The file system calls should use PyUnicode_FSConverter() for encoding file names. This uses the variable Py_FileSystemDefaultEncoding internally. This variable should be treated as read-only: on some systems, it will be a pointer to a static string, on others, it will change at run-time (such as when the application invokes setlocale).

错误处理方式由 errors 设置并且也可以设为 NULL 表示使用为编解码器定义的默认处理方式。 所有内置编解码器的默认错误处理方式是 "strict" (会引发 ValueError)。

编解码器都使用类似的接口。 为了保持简单只有与下列泛型编解码器的差异才会记录在文档中。

泛型编解码器

以下是泛型编解码器的 API:

PyObject *PyUnicode_Decode(const char *s, Py_ssize_t size, const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码已编码字符串 s 的 size 个字节创建一个 Unicode 对象。 encoding 和 errors 具有与 str() 内置函数中同名形参相同的含义。 要使用的编解码器将使用 Python 编解码器注册表来查找。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_AsEncodedString(PyObject *unicode, const char *encoding, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

编码一个 Unicode 对象并将结果作为 Python 字节串对象返回。 encoding 和 errors 具有与 Unicode encode() 方法中同名形参相同的含义。 要使用的编解码器将使用 Python 编解码器注册表来查找。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_Encode(const Py_UNICODE *s, Py_ssize_t size, const char *encoding, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer s of the given size and return a Python bytes object. encoding and errors have the same meaning as the parameters of the same name in the Unicode encode() method. The codec to be used is looked up using the Python codec registry. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsEncodedString().

UTF-8 编解码器

以下是 UTF-8 编解码器 API:

PyObject *PyUnicode_DecodeUTF8(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码 UTF-8 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

返回值：新的引用。 Part of the Stable ABI.

如果 consumed 为 NULL，则行为类似于 PyUnicode_DecodeUTF8()。 如果 consumed 不为 NULL，则末尾的不完整 UTF-8 字节序列将不被视为错误。 这些字节将不会被解码并且已被解码的字节数将存储在 consumed 中。

PyObject *PyUnicode_AsUTF8String(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

使用 UTF-8 编码 Unicode 对象并将结果作为 Python 字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

const char *PyUnicode_AsUTF8AndSize(PyObject *unicode, Py_ssize_t *size)

Part of the Stable ABI since version 3.10.

返回一个指向 Unicode 对象的 UTF-8 编码格式数据的指针，并将已编码数据的大小（以字节为单位）存储在 size 中。 size 参数可以为 NULL；在此情况下数据的大小将不会被存储。 返回的缓冲区总是会添加一个额外的空字节（不包括在 size 中），无论是否存在任何其他的空码位。

在发生错误的情况下，将返回 NULL 附带设置一个异常并且不会存储 size 值。

这将缓存 Unicode 对象中字符串的 UTF-8 表示形式，并且后续调用将返回指向同一缓存区的指针。 调用方不必负责释放该缓冲区。 缓冲区会在 Unicode 对象被作为垃圾回收时被释放并使指向它的指针失效。

3.3 新版功能.

在 3.7 版更改: 返回类型现在是 const char * 而不是 char *。

在 3.10 版更改: This function is a part of the limited API.

const char *PyUnicode_AsUTF8(PyObject *unicode)

类似于 PyUnicode_AsUTF8AndSize()，但不会存储大小值。

3.3 新版功能.

在 3.7 版更改: 返回类型现在是 const char * 而不是 char *。

PyObject *PyUnicode_EncodeUTF8(const Py_UNICODE *s, Py_ssize_t size, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer s of the given size using UTF-8 and return a Python bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsUTF8String(), PyUnicode_AsUTF8AndSize() or PyUnicode_AsEncodedString().

UTF-32 编解码器

以下是 UTF-32 编解码器 API:

PyObject *PyUnicode_DecodeUTF32(const char *s, Py_ssize_t size, const char *errors, int *byteorder)

返回值：新的引用。 Part of the Stable ABI.

从 UTF-32 编码的缓冲区数据解码 size 个字节并返回相应的 Unicode 对象。 errors (如果不为 NULL) 定义了错误处理方式。 默认为 "strict"。

如果 byteorder 不为 NULL，解码器将使用给定的字节序进行解码:

*byteorder == -1: little endian
*byteorder == 0:  native order
*byteorder == 1:  big endian

如果 *byteorder 为零，且输入数据的前四个字节为字节序标记 (BOM)，则解码器将切换为该字节序并且 BOM 将不会被拷贝到结果 Unicode 字符串中。 如果 *byteorder 为 -1 或 1，则字节序标记会被拷贝到输出中。

在完成后，*byteorder 将在输入数据的末尾被设为当前字节序。

如果 byteorder 为 NULL，编解码器将使用本机字节序。

如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_DecodeUTF32Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)

返回值：新的引用。 Part of the Stable ABI.

如果 consumed 为 NULL，则行为类似于 PyUnicode_DecodeUTF32()。 如果 consumed 不为 NULL，则 PyUnicode_DecodeUTF32Stateful() 将不把末尾的不完整 UTF-32 字节序列（如字节数不可被四整除）视为错误。 这些字节将不会被解码并且已被解码的字节数将存储在 consumed 中。

PyObject *PyUnicode_AsUTF32String(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

返回使用 UTF-32 编码格式本机字节序的 Python 字节串。 字节串将总是以 BOM 标记打头。 错误处理方式为 "strict"。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_EncodeUTF32(const Py_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)

返回值：新的引用。

Return a Python bytes object holding the UTF-32 encoded value of the Unicode data in s. Output is written according to the following byte order:

byteorder == -1: little endian
byteorder == 0:  native byte order (writes a BOM mark)
byteorder == 1:  big endian

If byteorder is 0, the output string will always start with the Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is prepended.

If Py_UNICODE_WIDE is not defined, surrogate pairs will be output as a single code point.

如果编解码器引发了异常则返回 NULL。

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsUTF32String() or PyUnicode_AsEncodedString().

UTF-16 编解码器

以下是 UTF-16 编解码器的 API:

PyObject *PyUnicode_DecodeUTF16(const char *s, Py_ssize_t size, const char *errors, int *byteorder)

返回值：新的引用。 Part of the Stable ABI.

从 UTF-16 编码的缓冲区数据解码 size 个字节并返回相应的 Unicode 对象。 errors (如果不为 NULL) 定义了错误处理方式。 默认为 "strict"。

如果 byteorder 不为 NULL，解码器将使用给定的字节序进行解码:

*byteorder == -1: little endian
*byteorder == 0:  native order
*byteorder == 1:  big endian

如果 *byteorder 为零，且输入数据的前两个字节为字节序标记 (BOM)，则解码器将切换为该字节序并且 BOM 将不会被拷贝到结果 Unicode 字符串中。 如果 *byteorder 为 -1 或 1，则字节序标记会被拷贝到输出中 (它将是一个 \ufeff 或 \ufffe 字符)。

在完成后，*byteorder 将在输入数据的末尾被设为当前字节序。

如果 byteorder 为 NULL，编解码器将使用本机字节序。

如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_DecodeUTF16Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)

返回值：新的引用。 Part of the Stable ABI.

如果 consumed 为 NULL，则行为类似于 PyUnicode_DecodeUTF16()。 如果 consumed 不为 NULL，则 PyUnicode_DecodeUTF16Stateful() 将不把末尾的不完整 UTF-16 字节序列（如为奇数个字节或为分开的替代对）视为错误。 这些字节将不会被解码并且已被解码的字节数将存储在 consumed 中。

PyObject *PyUnicode_AsUTF16String(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

返回使用 UTF-16 编码格式本机字节序的 Python 字节串。 字节串将总是以 BOM 标记打头。 错误处理方式为 "strict"。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_EncodeUTF16(const Py_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)

返回值：新的引用。

Return a Python bytes object holding the UTF-16 encoded value of the Unicode data in s. Output is written according to the following byte order:

byteorder == -1: little endian
byteorder == 0:  native byte order (writes a BOM mark)
byteorder == 1:  big endian

If byteorder is 0, the output string will always start with the Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is prepended.

If Py_UNICODE_WIDE is defined, a single Py_UNICODE value may get represented as a surrogate pair. If it is not defined, each Py_UNICODE values is interpreted as a UCS-2 character.

如果编解码器引发了异常则返回 NULL。

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsUTF16String() or PyUnicode_AsEncodedString().

UTF-7 编解码器

以下是 UTF-7 编解码器 API:

PyObject *PyUnicode_DecodeUTF7(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码 UTF-7 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

返回值：新的引用。 Part of the Stable ABI.

如果 consumed 为 NULL，则行为类似于 PyUnicode_DecodeUTF7()。 如果 consumed 不为 NULL，则末尾的不完整 UTF-7 base-64 部分将不被视为错误。 这些字节将不会被解码并且已被解码的字节数将存储在 consumed 中。

PyObject *PyUnicode_EncodeUTF7(const Py_UNICODE *s, Py_ssize_t size, int base64SetO, int base64WhiteSpace, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using UTF-7 and return a Python bytes object. Return NULL if an exception was raised by the codec.

If base64SetO is nonzero, "Set O" (punctuation that has no otherwise special meaning) will be encoded in base-64. If base64WhiteSpace is nonzero, whitespace will be encoded in base-64. Both are set to zero for the Python "utf-7" codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsEncodedString().

Unicode-Escape 编解码器

以下是 "Unicode Escape" 编解码器的 API:

PyObject *PyUnicode_DecodeUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码 Unicode-Escape 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_AsUnicodeEscapeString(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

使用 Unicode-Escape 编码 Unicode 对象并将结果作为字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

PyObject *PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using Unicode-Escape and return a bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsUnicodeEscapeString().

Raw-Unicode-Escape 编解码器

以下是 "Raw Unicode Escape" 编解码器的 API:

PyObject *PyUnicode_DecodeRawUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码 Raw-Unicode-Escape 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

使用 Raw-Unicode-Escape 编码 Unicode 对象并将结果作为字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

PyObject *PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using Raw-Unicode-Escape and return a bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsRawUnicodeEscapeString() or PyUnicode_AsEncodedString().

Latin-1 编解码器

以下是 Latin-1 编解码器的 API: Latin-1 对应于前 256 个 Unicode 码位且编码器在编码期间只接受这些码位。

PyObject *PyUnicode_DecodeLatin1(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码 Latin-1 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_AsLatin1String(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

使用 Latin-1 编码 Unicode 对象并将结果作为 Python 字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

PyObject *PyUnicode_EncodeLatin1(const Py_UNICODE *s, Py_ssize_t size, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using Latin-1 and return a Python bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsLatin1String() or PyUnicode_AsEncodedString().

ASCII 编解码器

以下是 ASCII 编解码器的 API。 只接受 7 位 ASCII 数据。 任何其他编码的数据都将导致错误。

PyObject *PyUnicode_DecodeASCII(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过解码 ASCII 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_AsASCIIString(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI.

使用 ASCII 编码 Unicode 对象并将结果作为 Python 字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

PyObject *PyUnicode_EncodeASCII(const Py_UNICODE *s, Py_ssize_t size, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using ASCII and return a Python bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsASCIIString() or PyUnicode_AsEncodedString().

字符映射编解码器

This codec is special in that it can be used to implement many different codecs (and this is in fact what was done to obtain most of the standard codecs included in the encodings package). The codec uses mappings to encode and decode characters. The mapping objects provided must support the __getitem__() mapping interface; dictionaries and sequences work well.

以下是映射编解码器的 API:

PyObject *PyUnicode_DecodeCharmap(const char *data, Py_ssize_t size, PyObject *mapping, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过使用给定的 mapping 对象解码已编码字节串 s 的 size 个字节创建 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

如果 mapping 为 NULL，则将应用 Latin-1 编码格式。 否则 mapping 必须为字节码位值（0 至 255 范围内的整数）到 Unicode 字符串的映射、整数（将被解读为 Unicode 码位）或 None。 未映射的数据字节 -- 这样的数据将导致 LookupError，以及被映射到 None 的数据，0xFFFE 或 '\ufffe'，将被视为未定义的映射并导致报错。

PyObject *PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping)

返回值：新的引用。 Part of the Stable ABI.

使用给定的 mapping 对象编码 Unicode 对象并将结果作为字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

mapping 对象必须将整数 Unicode 码位映射到字节串对象、0 至 255 范围内的整数或 None。 未映射的字符码位（将导致 LookupError 的数据）以及映射到 None 的数据将被视为“未定义的映射”并导致报错。

PyObject *PyUnicode_EncodeCharmap(const Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using the given mapping object and return the result as a bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsCharmapString() or PyUnicode_AsEncodedString().

以下特殊的编解码器 API 会将 Unicode 映射至 Unicode。

PyObject *PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)

返回值：新的引用。 Part of the Stable ABI.

通过应用字符映射表来转写字符串并返回结果 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

字符映射表必须将整数 Unicode 码位映射到整数 Unicode 码位或 None (这将删除相应的字符)。

Mapping tables need only provide the __getitem__() interface; dictionaries and sequences work well. Unmapped character ordinals (ones which cause a LookupError) are left untouched and are copied as-is.

errors 具有用于编解码器的通常含义。 它可以为 NULL 表示使用默认的错误处理方式。

PyObject *PyUnicode_TranslateCharmap(const Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const char *errors)

返回值：新的引用。

Translate a Py_UNICODE buffer of the given size by applying a character mapping table to it and return the resulting Unicode object. Return NULL when an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_Translate(). or generic codec based API

Windows 中的 MBCS 编解码器

以下是 MBCS 编解码器的 API。 目前它们仅在 Windows 中可用并使用 Win32 MBCS 转换器来实现转换。 请注意 MBCS（或 DBCS）是一类编码格式，而非只有一个。 目标编码格式是由运行编解码器的机器上的用户设置定义的。

PyObject *PyUnicode_DecodeMBCS(const char *s, Py_ssize_t size, const char *errors)

返回值：新的引用。 Part of the Stable ABI on Windows since version 3.7.

通过解码 MBCS 编码的字节串 s 的 size 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 NULL。

PyObject *PyUnicode_DecodeMBCSStateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)

返回值：新的引用。 Part of the Stable ABI on Windows since version 3.7.

如果 consumed 为 NULL，则行为类似于 PyUnicode_DecodeMBCS()。 如果 consumed 不为 NULL，则 PyUnicode_DecodeMBCSStateful() 将不会解码末尾的不完整字节并且已被解码的字节数将存储在 consumed 中。

PyObject *PyUnicode_AsMBCSString(PyObject *unicode)

返回值：新的引用。 Part of the Stable ABI on Windows since version 3.7.

使用 MBCS 编码 Unicode 对象并将结果作为 Python 字节串对象返回。 错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 NULL。

PyObject *PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors)

返回值：新的引用。 Part of the Stable ABI on Windows since version 3.7.

Encode the Unicode object using the specified code page and return a Python bytes object. Return NULL if an exception was raised by the codec. Use CP_ACP code page to get the MBCS encoder.

3.3 新版功能.

PyObject *PyUnicode_EncodeMBCS(const Py_UNICODE *s, Py_ssize_t size, const char *errors)

返回值：新的引用。

Encode the Py_UNICODE buffer of the given size using MBCS and return a Python bytes object. Return NULL if an exception was raised by the codec.

Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using PyUnicode_AsMBCSString(), PyUnicode_EncodeCodePage() or PyUnicode_AsEncodedString().

方法和槽位

方法与槽位函数

以下 API 可以处理输入的 Unicode 对象和字符串（在描述中我们称其为字符串）并返回适当的 Unicode 对象或整数值。

如果发生异常它们都将返回 NULL 或 -1。

PyObject *PyUnicode_Concat(PyObject *left, PyObject *right)

返回值：新的引用。 Part of the Stable ABI.

拼接两个字符串得到一个新的 Unicode 字符串。

PyObject *PyUnicode_Split(PyObject *s, PyObject *sep, Py_ssize_t maxsplit)

返回值：新的引用。 Part of the Stable ABI.

拆分一个字符串得到一个 Unicode 字符串的列表。 如果 sep 为 NULL，则将根据空格来拆分所有子字符串。 否则，将根据指定的分隔符来拆分。 最多拆分数为 maxsplit。 如为负值，则没有限制。 分隔符不包括在结果列表中。

PyObject *PyUnicode_Splitlines(PyObject *s, int keepend)

返回值：新的引用。 Part of the Stable ABI.

根据分行符来拆分 Unicode 字符串，返回一个 Unicode 字符串的列表。 CRLF 将被视为一个分行符。 如果 keepend 为 0，则行分隔符不包括在结果列表中。

PyObject *PyUnicode_Join(PyObject *separator, PyObject *seq)

返回值：新的引用。 Part of the Stable ABI.

使用给定的 separator 合并一个字符串列表并返回结果 Unicode 字符串。

Py_ssize_t PyUnicode_Tailmatch(PyObject *str, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)

Part of the Stable ABI.

如果 substr 在给定的端点 (direction == -1 表示前缀匹配，direction == 1 表示后缀匹配) 与 str[start:end] 相匹配则返回 1，否则返回 0。 如果发生错误则返回 -1。

Py_ssize_t PyUnicode_Find(PyObject *str, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)

Part of the Stable ABI.

返回使用给定的 direction (direction == 1 表示前向搜索，direction == -1 表示后向搜索) 时 substr 在 str[start:end] 中首次出现的位置。 返回值为首个匹配的索引号；值为 -1 表示未找到匹配，-2 则表示发生错误并设置了异常。

Py_ssize_t PyUnicode_FindChar(PyObject *str, Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)

Part of the Stable ABI since version 3.7.

返回使用给定的 direction (direction == 1 表示前向搜索，direction == -1 表示后向搜索) 时字符 ch 在 str[start:end] 中首次出现的位置。 返回值为首个匹配的索引号；值为 -1 表示未找到匹配，-2 则表示发生错误并设置了异常。

3.3 新版功能.

在 3.7 版更改: 现在 start 和 end 被调整为与 str[start:end] 类似的行为。

Py_ssize_t PyUnicode_Count(PyObject *str, PyObject *substr, Py_ssize_t start, Py_ssize_t end)

Part of the Stable ABI.

返回 substr 在 str[start:end] 中不重叠出现的次数。 如果发生错误则返回 -1。

PyObject *PyUnicode_Replace(PyObject *str, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)

返回值：新的引用。 Part of the Stable ABI.

将 str 中 substr 在替换为 replstr 至多 maxcount 次并返回结果 Unicode 对象。 maxcount == -1 表示全部替换。

int PyUnicode_Compare(PyObject *left, PyObject *right)

Part of the Stable ABI.

比较两个字符串并返回 -1, 0, 1 分别表示小于、等于和大于。

此函数执行失败时返回 -1，因此应当调用 PyErr_Occurred() 来检查错误。

int PyUnicode_CompareWithASCIIString(PyObject *uni, const char *string)

Part of the Stable ABI.

将 Unicode 对象 uni 与 string 进行比较并返回 -1, 0, 1 分别表示小于、等于和大于。 最好只传入 ASCII 编码的字符串，但如果输入字符串包含非 ASCII 字符则此函数会将其按 ISO-8859-1 编码来解读。

此函数不会引发异常。

PyObject *PyUnicode_RichCompare(PyObject *left, PyObject *right, int op)

返回值：新的引用。 Part of the Stable ABI.

对两个 Unicode 字符串执行富比较并返回以下值之一:

NULL 用于引发了异常的情况

Py_True or Py_False for successful comparisons

Py_NotImplemented in case the type combination is unknown

Possible values for op are Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, and Py_LE.

PyObject *PyUnicode_Format(PyObject *format, PyObject *args)

返回值：新的引用。 Part of the Stable ABI.

根据 format 和 args 返回一个新的字符串对象；这等同于 format % args。

int PyUnicode_Contains(PyObject *container, PyObject *element)

Part of the Stable ABI.

检查 element 是否包含在 container 中并相应返回真值或假值。

element 必须强制转成一个单元素 Unicode 字符串。 如果发生错误则返回 -1。

void PyUnicode_InternInPlace(PyObject **string)

Part of the Stable ABI.

Intern the argument *string in place. The argument must be the address of a pointer variable pointing to a Python Unicode string object. If there is an existing interned string that is the same as *string, it sets *string to it (releasing the reference to the old string object and creating a new strong reference to the interned string object), otherwise it leaves *string alone and interns it (creating a new strong reference). (Clarification: even though there is a lot of talk about references, think of this function as reference-neutral; you own the object after the call if and only if you owned it before the call.)

PyObject *PyUnicode_InternFromString(const char *v)

返回值：新的引用。 Part of the Stable ABI.

PyUnicode_FromString() 和 PyUnicode_InternInPlace() 的组合操作，返回一个已内部化的新 Unicode 字符串对象，或一个指向具有相同值的原有内部化字符串对象的新的（“拥有的”）引用。

元组对象

type PyTupleObject

这个 PyObject 的子类型代表一个 Python 的元组对象。

PyTypeObject PyTuple_Type

Part of the Stable ABI.

PyTypeObject 的实例代表一个 Python 元组类型，这与 Python 层面的 tuple 是相同的对象。

int PyTuple_Check(PyObject *p)

如果 p 是一个 tuple 对象或者 tuple 类型的子类型的实例则返回真值。 此函数总是会成功执行。

int PyTuple_CheckExact(PyObject *p)

如果 p 是一个 tuple 对象但不是 tuple 类型的子类型的实例则返回真值。 此函数总是会成功执行。

PyObject *PyTuple_New(Py_ssize_t len)

返回值：新的引用。 Part of the Stable ABI.

成功时返回一个新的元组对象，长度为 len，失败时返回 NULL。

PyObject *PyTuple_Pack(Py_ssize_t n, ...)

返回值：新的引用。 Part of the Stable ABI.

成功时返回一个新的元组对象，大小为 n ，失败时返回 NULL。 元组值初始化为指向 Python 对象的后续 n 个 C 参数。 PyTuple_Pack(2, a, b) 和 Py_BuildValue("(OO)", a, b) 相等。

Py_ssize_t PyTuple_Size(PyObject *p)

Part of the Stable ABI.

获取指向元组对象的指针，并返回该元组的大小。

Py_ssize_t PyTuple_GET_SIZE(PyObject *p)

返回元组 p 的大小，它必须为非 NULL 并且指向一个元组；不执行错误检查。

PyObject *PyTuple_GetItem(PyObject *p, Py_ssize_t pos)

返回值：借入的引用。 Part of the Stable ABI.

返回 p 所指向的元组中位于 pos 处的对象。 如果 pos 为负值或超出范围，则返回 NULL 并设置一个 IndexError 异常。

PyObject *PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos)

返回值：借入的引用。

类似于 PyTuple_GetItem()，但不检查其参数。

PyObject *PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high)

返回值：新的引用。 Part of the Stable ABI.

返回 p 所指向的元组的切片，在 low 和 high 之间，或者在失败时返回 NULL。 这等同于 Python 表达式 p[low:high]。 不支持从列表末尾索引。

int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)

Part of the Stable ABI.

在 p 指向的元组的 pos 位置插入对对象 o 的引用。 成功时返回 0；如果 pos 越界，则返回 -1，并抛出一个 IndexError 异常。

注解

此函数会“窃取”对 o 的引用，并丢弃对元组中已在受影响位置的条目的引用。

void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o)

类似于 PyTuple_SetItem()，但不进行错误检查，并且应该 只是 被用来填充全新的元组。

注解

这个宏会“偷走”一个对 o 的引用，但与 PyTuple_SetItem() 不同，它 不会 丢弃对任何被替换项的引用；元组中位于 pos 位置的任何引用都将被泄漏。

int _PyTuple_Resize(PyObject **p, Py_ssize_t newsize)

可以用于调整元组的大小。 newsize 将是元组的新长度。 因为元组 被认为 是不可变的，所以只有在对象仅有一个引用时，才应该使用它。 如果元组已经被代码的其他部分所引用，请不要使用此项。 元组在最后总是会增长或缩小。 把它看作是销毁旧元组并创建一个新元组，只会更有效。 成功时返回 0 。 客户端代码不应假定 *p 的结果值将与调用此函数之前的值相同。 如果替换了 *p 引用的对象，则原始的 *p 将被销毁。 失败时，返回 -1，将 *p 设置为 NULL，并引发 MemoryError 或者 SystemError。

结构序列对象

结构序列对象是等价于 namedtuple() 的 C 对象，即一个序列，其中的条目也可以通过属性访问。 要创建结构序列，你首先必须创建特定的结构序列类型。

PyTypeObject *PyStructSequence_NewType(PyStructSequence_Desc *desc)

返回值：新的引用。 Part of the Stable ABI.

根据 desc 中的数据创建一个新的结构序列类型，如下所述。 可以使用 PyStructSequence_New() 创建结果类型的实例。

void PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc)

从 desc 就地初始化结构序列类型 type。

int PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc)

与 PyStructSequence_InitType 相同，但成功时返回 0 ，失败时返回 -1 。

3.4 新版功能.

type PyStructSequence_Desc

Part of the Stable ABI (including all members).

包含要创建的结构序列类型的元信息。

域 | C 类型 | 含意
name | const char * | 结构序列类型的名称
doc | const char * | 指向要忽略类型的文档字符串或 NULL 的指针
fields | PyStructSequence_Field * | 指向以 NULL 结尾的数组的指针，其字段名称为新类型
n_in_sequence | int | Python侧可见的字段数（如果用作元组）

type PyStructSequence_Field

Part of the Stable ABI (including all members).

描述结构序列的一个字段。 当结构序列被建模为元组时，所有字段的类型都是 PyObject*。 在 PyStructSequence_Desc 的 fields 数组中的索引确定了结构序列描述的是哪个字段。

域 | C 类型 | 含意
name | const char * | 字段的名称或 NULL ，若要结束命名字段的列表，请设置为 PyStructSequence_UnnamedField 以保留未命名字段
doc | const char * | 要忽略的字段文档字符串或 NULL

const char *const PyStructSequence_UnnamedField

字段名的特殊值将保持未命名状态。

在 3.9 版更改: 这个类型已从 char * 更改。

PyObject *PyStructSequence_New(PyTypeObject *type)

返回值：新的引用。 Part of the Stable ABI.

创建 type 的实例，该实例必须使用 PyStructSequence_NewType() 创建。

PyObject *PyStructSequence_GetItem(PyObject *p, Py_ssize_t pos)

返回值：借入的引用。 Part of the Stable ABI.

返回 p 所指向的结构序列中，位于 pos 处的对象。不需要进行边界检查。

PyObject *PyStructSequence_GET_ITEM(PyObject *p, Py_ssize_t pos)

返回值：借入的引用。

PyStructSequence_GetItem() 的宏版本。

void PyStructSequence_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)

Part of the Stable ABI.

将结构序列 p 的索引 pos 处的字段设置为值 o。 与 PyTuple_SET_ITEM() 一样，它应该只用于填充全新的实例。

注解

这个函数“窃取”了指向 o 的一个引用。

void PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o)

PyStructSequence_SetItem() 的宏版本。

注解

这个函数“窃取”了指向 o 的一个引用。

列表对象

type PyListObject

这个C类型 PyObject 的子类型代表一个Python列表对象。

PyTypeObject PyList_Type

Part of the Stable ABI.

这是个属于 PyTypeObject 的代表Python列表类型的实例。在Python层面和类型 list 是同一个对象。

int PyList_Check(PyObject *p)

如果 p 是一个 list 对象或者 list 类型的子类型的实例则返回真值。 此函数总是会成功执行。

int PyList_CheckExact(PyObject *p)

如果 p 是一个 list 对象但不是 list 类型的子类型的实例则返回真值。 此函数总是会成功执行。

PyObject *PyList_New(Py_ssize_t len)

返回值：新的引用。 Part of the Stable ABI.

成功时返回一个长度为 len 的新列表，失败时返回 NULL。

注解

当 len 大于零时，被返回的列表对象项目被设成 NULL。因此你不能用类似C函数 PySequence_SetItem() 的抽象API或者用C函数 PyList_SetItem() 将所有项目设置成真实对象前对Python代码公开这个对象。

Py_ssize_t PyList_Size(PyObject *list)

Part of the Stable ABI.

返回 list 中列表对象的长度；这等于在列表对象调用 len(list) 。

Py_ssize_t PyList_GET_SIZE(PyObject *list)

宏版本的C函数 PyList_Size() ，没有错误检测。

PyObject *PyList_GetItem(PyObject *list, Py_ssize_t index)

返回值：借入的引用。 Part of the Stable ABI.

返回 list 所指向列表中 index 位置上的对象。 位置值必须为非负数；不支持从列表末尾进行索引。 如果 index 超出边界 (<0 or >=len(list))，则返回 NULL 并设置 IndexError 异常。

PyObject *PyList_GET_ITEM(PyObject *list, Py_ssize_t i)

返回值：借入的引用。

宏版本的C函数 PyList_GetItem() ，没有错误检测。

int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item)

Part of the Stable ABI.

将列表中索引为 index 的项设为 item。 成功时返回 0。 如果 index 超出范围则返回 -1 并设定 IndexError 异常。

注解

此函数会“偷走”一个对 item 的引用并丢弃一个对列表中受影响位置上的已有条目的引用。

void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o)

不带错误检测的宏版本 PyList_SetItem()。 这通常只被用于新列表中之前没有内容的位置进行填充。

注解

该宏会“偷走”一个对 item 的引用，但与 PyList_SetItem() 不同的是它 不会 丢弃对任何被替换条目的引用；在 list 的 i 位置上的任何引用都将被泄露。

int PyList_Insert(PyObject *list, Py_ssize_t index, PyObject *item)

Part of the Stable ABI.

将条目 item 插入到列表 list 索引号 index 之前的位置。 如果成功将返回 0；如果不成功则返回 -1 并设置一个异常。 相当于 list.insert(index, item)。

int PyList_Append(PyObject *list, PyObject *item)

Part of the Stable ABI.

将对象 item 添加到列表 list 的末尾。 如果成功将返回 0；如果不成功则返回 -1 并设置一个异常。 相当于 list.append(item)。

PyObject *PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high)

返回值：新的引用。 Part of the Stable ABI.

返回一个对象列表，包含 list 当中位于 low 和 high 之间 的对象。 如果不成功则返回 NULL 并设置异常。 相当于 list[low:high]。 不支持从列表末尾进行索引。

int PyList_SetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)

Part of the Stable ABI.

将 list 当中 low 与 high 之间的切片设为 itemlist 的内容。 相当于 list[low:high] = itemlist。 itemlist 可以为 NULL，表示赋值为一个空列表（删除切片）。 成功时返回 0，失败时返回 -1。 这里不支持从列表末尾进行索引。

int PyList_Sort(PyObject *list)

Part of the Stable ABI.

对 list 中的条目进行原地排序。 成功时返回 0，失败时返回 -1。 这等价于 list.sort()。

int PyList_Reverse(PyObject *list)

Part of the Stable ABI.

对 list 中的条目进行原地反转。 成功时返回 0，失败时返回 -1。 这等价于 list.reverse()。

PyObject *PyList_AsTuple(PyObject *list)

返回值：新的引用。 Part of the Stable ABI.

返回一个新的元组对象，其中包含 list 的内容；等价于 tuple(list)。

字典对象

type PyDictObject

这个 PyObject 的子类型代表一个Python字典对象。

PyTypeObject PyDict_Type

Part of the Stable ABI.

Python字典类型表示为 PyTypeObject 的实例。这与Python层面的 dict 是相同的对象。

int PyDict_Check(PyObject *p)

如果 p 是一个 dict 对象或者 dict 类型的子类型的实例则返回真值。 此函数总是会成功执行。

int PyDict_CheckExact(PyObject *p)

如果 p 是一个 dict 对象但不是 dict 类型的子类型的实例则返回真值。 此函数总是会成功执行。

PyObject *PyDict_New()

返回值：新的引用。 Part of the Stable ABI.

返回一个新的空字典，失败时返回 NULL。

PyObject *PyDictProxy_New(PyObject *mapping)

返回值：新的引用。 Part of the Stable ABI.

返回 types.MappingProxyType 对象，用于强制执行只读行为的映射。这通常用于创建视图以防止修改非动态类类型的字典。

void PyDict_Clear(PyObject *p)

Part of the Stable ABI.

清空现有字典的所有键值对。

int PyDict_Contains(PyObject *p, PyObject *key)

Part of the Stable ABI.

确定 key 是否包含在字典 p 中。如果 key 匹配上 p 的某一项，则返回 1 ，否则返回 0 。返回 -1 表示出错。这等同于Python表达式 key in p 。

PyObject *PyDict_Copy(PyObject *p)

返回值：新的引用。 Part of the Stable ABI.

返回与 p 包含相同键值对的新字典。

int PyDict_SetItem(PyObject *p, PyObject *key, PyObject *val)

Part of the Stable ABI.

使用 key 作为键将 val 插入字典 p。 key 必须为 hashable；如果不是，则将引发 TypeError。 成功时返回 0，失败时返回 -1。 此函数 不会 附带对 val 的引用。

int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val)

Part of the Stable ABI.

使用 key 作为键将 val 插入到字典 p 中。 key 应为 const char*。 键对象是使用 PyUnicode_FromString(key) 创建的。成功时返回 0，失败时返回 -1。 此函数 不会 窃取对 val 的引用。

int PyDict_DelItem(PyObject *p, PyObject *key)

Part of the Stable ABI.

移除字典 p 中键为 key 的条目。 key 必须是 hashable；如果不是，则会引发 TypeError。 如果字典中没有 key，则会引发 KeyError。 成功时返回 0 或者失败时返回 -1。

int PyDict_DelItemString(PyObject *p, const char *key)

Part of the Stable ABI.

移除字典 p 中由字符串 key 指定的键的条目。 如果字典中没有 key，则会引发 KeyError。 成功时返回 0，失败时返回 -1。

PyObject *PyDict_GetItem(PyObject *p, PyObject *key)

返回值：借入的引用。 Part of the Stable ABI.

从字典 p 中返回以 key 为键的对象。 如果键名 key 不存在但 没有 设置一个异常则返回 NULL。

需要注意的是，调用 __hash__() 和 __eq__() 方法产生的异常不会被抛出。改用 PyDict_GetItemWithError() 获得错误报告。

在 3.10 版更改: 在不保持 GIL 的情况下调用此 API 曾因历史原因而被允许。 现在已不再被允许。

PyObject *PyDict_GetItemWithError(PyObject *p, PyObject *key)

返回值：借入的引用。 Part of the Stable ABI.

PyDict_GetItem() 的变种，它不会屏蔽异常。 当异常发生时将返回 NULL 并且 设置一个异常。 如果键不存在则返回 NULL 并且不会 设置一个异常。

PyObject *PyDict_GetItemString(PyObject *p, const char *key)

返回值：借入的引用。 Part of the Stable ABI.

这与 PyDict_GetItem() 一样，但是 key 被指定为 const char*，而不是 PyObject*。

需要注意的是，调用 __hash__() 、 __eq__() 方法和创建一个临时的字符串对象时产生的异常不会被抛出。改用 PyDict_GetItemWithError() 获得错误报告。

PyObject *PyDict_SetDefault(PyObject *p, PyObject *key, PyObject *defaultobj)

返回值：借入的引用。

这跟Python层面的 dict.setdefault() 一样。如果键 key 存在，它返回在字典 p 里面对应的值。如果键不存在，它会和值 defaultobj 一起插入并返回 defaultobj 。这个函数只计算 key 的哈希函数一次，而不是在查找和插入时分别计算它。

3.4 新版功能.

PyObject *PyDict_Items(PyObject *p)

返回值：新的引用。 Part of the Stable ABI.

返回一个包含字典中所有键值项的 PyListObject。

PyObject *PyDict_Keys(PyObject *p)

返回值：新的引用。 Part of the Stable ABI.

返回一个包含字典中所有键(keys)的 PyListObject。

PyObject *PyDict_Values(PyObject *p)

返回值：新的引用。 Part of the Stable ABI.

返回一个包含字典中所有值(values)的 PyListObject。

Py_ssize_t PyDict_Size(PyObject *p)

Part of the Stable ABI.

返回字典中项目数，等价于对字典 p 使用 len(p)。

int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)

Part of the Stable ABI.

迭代字典 p 中的所有键值对。 在第一次调用此函数开始迭代之前，由 ppos 所引用的 Py_ssize_t 必须被初始化为 0；该函数将为字典中的每个键值对返回真值，一旦所有键值对都报告完毕则返回假值。 形参 pkey 和 pvalue 应当指向 PyObject* 变量，它们将分别使用每个键和值来填充，或者也可以为 NULL。 通过它们返回的任何引用都是暂借的。 ppos 在迭代期间不应被更改。 它的值表示内部字典结构中的偏移量，并且由于结构是稀疏的，因此偏移量并不连续。

例如：

PyObject *key, *value;
Py_ssize_t pos = 0;

while (PyDict_Next(self->dict, &pos, &key, &value)) {
    /* do something interesting with the values... */
    ...
}

字典 p 不应该在遍历期间发生改变。在遍历字典时，改变键中的值是安全的，但仅限于键的集合不发生改变。例如:

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);
}

int PyDict_Merge(PyObject *a, PyObject *b, int override)

Part of the Stable ABI.

对映射对象 b 进行迭代，将键值对添加到字典 a。 b 可以是一个字典，或任何支持 PyMapping_Keys() 和 PyObject_GetItem() 的对象。 如果 override 为真值，则如果在 b 中找到相同的键则 a 中已存在的相应键值对将被替换，否则如果在 a 中没有相同的键则只是添加键值对。 当成功时返回 0 或者当引发异常时返回 -1。

int PyDict_Update(PyObject *a, PyObject *b)

Part of the Stable ABI.

这与 C 中的 PyDict_Merge(a, b, 1) 一样，也类似于 Python 中的 a.update(b)，差别在于 PyDict_Update() 在第二个参数没有 "keys" 属性时不会回退到迭代键值对的序列。 当成功时返回 0 或者当引发异常时返回 -1。

int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override)

Part of the Stable ABI.

将 seq2 中的键值对更新或合并到字典 a。 seq2 必须为产生长度为 2 的用作键值对的元素的可迭代对象。 当存在重复的键时，如果 override 真值则最后出现的键胜出。 当成功时返回 0 或者当引发异常时返回 -1。 等价的 Python 代码（返回值除外）:

def PyDict_MergeFromSeq2(a, seq2, override):
    for key, value in seq2:
        if override or key not in a:
            a[key] = value

集合对象

这一节详细介绍了针对 set 和 frozenset 对象的公共 API。 任何未在下面列出的功能最好是使用抽象对象协议 (包括 PyObject_CallMethod(), PyObject_RichCompareBool(), PyObject_Hash(), PyObject_Repr(), PyObject_IsTrue(), PyObject_Print() 以及 PyObject_GetIter()) 或者抽象数字协议 (包括 PyNumber_And(), PyNumber_Subtract(), PyNumber_Or(), PyNumber_Xor(), PyNumber_InPlaceAnd(), PyNumber_InPlaceSubtract(), PyNumber_InPlaceOr() 以及 PyNumber_InPlaceXor())。

type PySetObject

这个 PyObject 的子类型被用来保存 set 和 frozenset 对象的内部数据。 它类似于 PyDictObject 的地方在于对小尺寸集合来说它是固定大小的（很像元组的存储方式），而对于中等和大尺寸集合来说它将指向单独的可变大小的内存块（很像列表的存储方式）。 此结构体的字段不应被视为公有并且可能发生改变。 所有访问都应当通过已写入文档的 API 来进行而不可通过直接操纵结构体中的值。

PyTypeObject PySet_Type

Part of the Stable ABI.

这是一个 PyTypeObject 实例，表示 Python set 类型。

PyTypeObject PyFrozenSet_Type

Part of the Stable ABI.

这是一个 PyTypeObject 实例，表示 Python frozenset 类型。

下列类型检查宏适用于指向任意 Python 对象的指针。 类似地，这些构造函数也适用于任意可迭代的 Python 对象。

int PySet_Check(PyObject *p)

如果 p 是一个 set 对象或者是其子类型的实例则返回真值。 此函数总是会成功执行。

int PyFrozenSet_Check(PyObject *p)

如果 p 是一个 frozenset 对象或者是其子类型的实例则返回真值。 此函数总是会成功执行。

int PyAnySet_Check(PyObject *p)

如果 p 是一个 set 对象、frozenset 对象或者是其子类型的实例则返回真值。 此函数总是会成功执行。

int PySet_CheckExact(PyObject *p)

如果 p 是一个 set 对象但不是其子类型的实例则返回真值。 此函数总是会成功执行。

3.10 新版功能.

int PyAnySet_CheckExact(PyObject *p)

如果 p 是一个 set 或 frozenset 对象但不是其子类型的实例则返回真值。 此函数总是会成功执行。

int PyFrozenSet_CheckExact(PyObject *p)

如果 p 是一个 frozenset 对象但不是其子类型的实例则返回真值。 此函数总是会成功执行。

PyObject *PySet_New(PyObject *iterable)

返回值：新的引用。 Part of the Stable ABI.

返回一个新的 set，其中包含 iterable 所返回的对象。 iterable 可以为 NULL 表示创建一个新的空集合。 成功时返回新的集合，失败时返回 NULL。 如果 iterable 实际上不是可迭代对象则引发 TypeError。 该构造器也适用于拷贝集合 (c=set(s))。

PyObject *PyFrozenSet_New(PyObject *iterable)

返回值：新的引用。 Part of the Stable ABI.

返回一个新的 frozenset，其中包含 iterable 所返回的对象。 iterable 可以为 NULL 表示创建一个新的空冻结集合。 成功时返回新的冻结集合，失败时返回 NULL。 如果 iterable 实际上不是可迭代对象则引发 TypeError。

下列函数和宏适用于 set 或 frozenset 的实例或是其子类型的实例。

Py_ssize_t PySet_Size(PyObject *anyset)

Part of the Stable ABI.

返回 set 或 frozenset 对象的长度。 等价于 len(anyset)。 如果 anyset 不是 set, frozenset 或其子类型的实例则会引发 PyExc_SystemError。

Py_ssize_t PySet_GET_SIZE(PyObject *anyset)

宏版本的 PySet_Size()，不带错误检测。

int PySet_Contains(PyObject *anyset, PyObject *key)

Part of the Stable ABI.

如果找到返回 1，如果未找到返回 0，如果遇到错误则返回 -1。 不同于 Python __contains__() 方法，此函数不会自动将不可哈希的集合转换为临时的冻结集合。 如果 key 为不可哈希对象则会引发 TypeError。 如果 anyset 不是 set, frozenset 或其子类型的实例则会引发 PyExc_SystemError。

int PySet_Add(PyObject *set, PyObject *key)

Part of the Stable ABI.

添加 key 到一个 set 实例。 也可用于 frozenset 实例（与 PyTuple_SetItem() 的类似之处是它也可被用来为全新的冻结集合在公开给其他代码之前填充全新的值）。 成功时返回 0 而失败时返回 -1。 如果 key 为不可哈希对象则会引发 TypeError。 如果没有增长空间则会引发 MemoryError。 如果 set 不是 set 或其子类型的实例则会引发 SystemError。

下列函数适用于 set 或其子类型的实例，但不可用于 frozenset 或其子类型的实例。

int PySet_Discard(PyObject *set, PyObject *key)

Part of the Stable ABI.

如果找到并移除返回 1，如果未找到（无操作）返回 0，如果遇到错误则返回 -1。 对于不存在的键不会引发 KeyError。 如果 key 为不可哈希对象则会引发 TypeError。 不同于 Python discard() 方法，此函数不会自动将不可哈希的集合转换为临时的冻结集合。 如果 set 不是 set 或其子类型的实例则会引发 PyExc_SystemError。

PyObject *PySet_Pop(PyObject *set)

返回值：新的引用。 Part of the Stable ABI.

返回 set 中任意对象的新引用，并从 set 中移除该对象。 失败时返回 NULL。 如果集合为空则会引发 KeyError。 如果 set 不是 set 或其子类型的实例则会引发 SystemError。

int PySet_Clear(PyObject *set)

Part of the Stable ABI.

清空现有字典的所有键值对。

Function 对象

有一些特定于 Python 函数的函数。

type PyFunctionObject

用于函数的 C 结构体。

PyTypeObject PyFunction_Type

这是一个 PyTypeObject 实例并表示 Python 函数类型。 它作为 types.FunctionType 向 Python 程序员公开。

int PyFunction_Check(PyObject *o)

如果 o 是一个函数对象 (类型为 PyFunction_Type) 则返回真值。 形参必须不为 NULL。 此函数总是会成功执行。

PyObject *PyFunction_New(PyObject *code, PyObject *globals)

返回值：新的引用。

返回与代码对象 code 关联的新函数对象。 globals 必须是一个字典，该函数可以访问全局变量。

从代码对象中提取函数的文档字符串和名称。 __module__ 会从 globals 中提取。 参数 defaults, annotations 和 closure 设为 NULL。 __qualname__ 设为与函数名称相同的值。

PyObject *PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)

返回值：新的引用。

类似 PyFunction_New()，但还允许设置函数对象的 __qualname__ 属性。 qualname 应当是 unicode 对象或 NULL；如果是 NULL 则 __qualname__ 属性设为与其 __name__ 属性相同的值。

3.3 新版功能.

PyObject *PyFunction_GetCode(PyObject *op)

返回值：借入的引用。

返回与函数对象 op 关联的代码对象。

PyObject *PyFunction_GetGlobals(PyObject *op)

返回值：借入的引用。

返回与函数对象*op*相关联的全局字典。

PyObject *PyFunction_GetModule(PyObject *op)

返回值：借入的引用。

向函数对象 op 的 __module__ 属性返回一个 borrowed reference。 该值可以为 NULL。

这通常为一个包含模块名称的字符串，但可以通过 Python 代码设为任何其他对象。

PyObject *PyFunction_GetDefaults(PyObject *op)

返回值：借入的引用。

返回函数对象 op 的参数默认值。 这可以是一个参数元组或 NULL。

int PyFunction_SetDefaults(PyObject *op, PyObject *defaults)

为函数对象 op 设置参数默认值。 defaults 必须为 Py_None 或一个元组。

失败时引发 SystemError 异常并返回 -1 。

PyObject *PyFunction_GetClosure(PyObject *op)

返回值：借入的引用。

返回关联到函数对象 op 的闭包。 这可以是 NULL 或 cell 对象的元组。

int PyFunction_SetClosure(PyObject *op, PyObject *closure)

设置关联到函数对象 op 的闭包。 closure 必须为 Py_None 或 cell 对象的元组。

失败时引发 SystemError 异常并返回 -1 。

PyObject *PyFunction_GetAnnotations(PyObject *op)

返回值：借入的引用。

返回函数对象 op 的标注。 这可以是一个可变字典或 NULL。

int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)

设置函数对象 op 的标注。 annotations 必须为一个字典或 Py_None。

失败时引发 SystemError 异常并返回 -1 。

实例方法对象

实例方法是 PyCFunction 的包装器，也是将 PyCFunction 绑定到类对象的一种新方式。 它替代了原先的调用 PyMethod_New(func, NULL, class)。

PyTypeObject PyInstanceMethod_Type

这个 PyTypeObject 实例代表 Python 实例方法类型。 它并不对 Python 程序公开。

int PyInstanceMethod_Check(PyObject *o)

如果 o 是一个实例方法对象 (类型为 PyInstanceMethod_Type) 则返回真值。 形参必须不为 NULL。 此函数总是会成功执行。

PyObject *PyInstanceMethod_New(PyObject *func)

返回值：新的引用。

返回一个新的实例方法对象，func 应为任意可调用对象。 func 将在实例方法被调用时作为函数被调用。

PyObject *PyInstanceMethod_Function(PyObject *im)

返回值：借入的引用。

返回关联到实例方法 im 的函数对象。

PyObject *PyInstanceMethod_GET_FUNCTION(PyObject *im)

返回值：借入的引用。

宏版本的 PyInstanceMethod_Function()，略去了错误检测。

方法对象

方法是绑定的函数对象。 方法总是会被绑定到一个用户自定义类的实例。 未绑定方法（绑定到一个类的方法）已不再可用。

PyTypeObject PyMethod_Type

这个 PyTypeObject 实例代表 Python 方法类型。 它作为 types.MethodType 向 Python 程序公开。

int PyMethod_Check(PyObject *o)

如果 o 是一个方法对象 (类型为 PyMethod_Type) 则返回真值。 形参必须不为 NULL。 此函数总是会成功执行。

PyObject *PyMethod_New(PyObject *func, PyObject *self)

返回值：新的引用。

返回一个新的方法对象，func 应为任意可调用对象，self 为该方法应绑定的实例。 在方法被调用时 func 将作为函数被调用。 self 必须不为 NULL。

PyObject *PyMethod_Function(PyObject *meth)

返回值：借入的引用。

返回关联到方法 meth 的函数对象。

PyObject *PyMethod_GET_FUNCTION(PyObject *meth)

返回值：借入的引用。

宏版本的 PyMethod_Function()，略去了错误检测。

PyObject *PyMethod_Self(PyObject *meth)

返回值：借入的引用。

返回关联到方法 meth 的实例。

PyObject *PyMethod_GET_SELF(PyObject *meth)

返回值：借入的引用。

宏版本的 PyMethod_Self()，略去了错误检测。

Cell 对象

“Cell”对象用于实现由多个作用域引用的变量。 对于每个这样的变量，一个“Cell”对象为了存储该值而被创建；引用该值的每个堆栈框架的局部变量包含同样使用该变量的对外部作用域的“Cell”引用。 访问该值时，将使用“Cell”中包含的值而不是单元格对象本身。 这种对“Cell”对象的非关联化的引用需要支持生成的字节码；访问时不会自动非关联化这些内容。 “Cell”对象在其他地方可能不太有用。

type PyCellObject

用于Cell对象的C结构体。

PyTypeObject PyCell_Type

与 Cell 对象对应的类型对​​象。

int PyCell_Check(ob)

如果 ob 是一个 cell 对象则返回真值；ob 必须不为 NULL。 此函数总是会成功执行。

PyObject *PyCell_New(PyObject *ob)

返回值：新的引用。

创建并返回一个包含值 ob 的新 cell 对象。形参可以为 NULL。

PyObject *PyCell_Get(PyObject *cell)

返回值：新的引用。

返回 cell 对象 cell 的内容。

PyObject *PyCell_GET(PyObject *cell)

返回值：借入的引用。

返回 cell 对象 cell 的内容，但是不检测 cell 是否非 NULL 并且为一个 cell 对象。

int PyCell_Set(PyObject *cell, PyObject *value)

将 cell 对象 cell 的内容设为 value。 这将释放任何对 cell 对象当前内容的引用。 value 可以为 NULL。 cell 必须为非 NULL；如果它不是一个 cell 对象则将返回 -1。 如果设置成功则将返回 0。

void PyCell_SET(PyObject *cell, PyObject *value)

将 cell 对象 cell 的值设为 value。 不会调整引用计数，并且不会进行检测以保证安全；cell 必须为非 NULL 并且为一个 cell 对象。

代码对象

代码对象是 CPython 实现的低层级细节。 每个代表一块尚未绑定到函数中的可执行代码。

type PyCodeObject

用于描述代码对象的对象的 C 结构。 此类型字段可随时更改。

PyTypeObject PyCode_Type

这是一个 PyTypeObject 实例，其表示Python的 code 类型。

int PyCode_Check(PyObject *co)

如果 co 是一个 code 对象则返回真值。 此函数总是会成功执行。

int PyCode_GetNumFree(PyCodeObject *co)

返回 co 中的自由变量数。

PyCodeObject *PyCode_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, int firstlineno, PyObject *lnotab)

返回值：新的引用。

返回一个新的代码对象。 如果你需要一个虚拟代码对象来创建一个代码帧，请使用 PyCode_NewEmpty()。 调用 PyCode_New() 直接可以绑定到准确的 Python 版本，因为字节码的定义经常变化。

PyCodeObject *PyCode_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, int firstlineno, PyObject *lnotab)

返回值：新的引用。

类似于 PyCode_New()，但带有一个额外的 "posonlyargcount" 用于仅限位置参数。

3.8 新版功能.

PyCodeObject *PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)

返回值：新的引用。

返回具有指定文件名、函数名和第一行号的新空代码对象。 对于 exec() 或 eval() 生成的代码对象是非法的。

int PyCode_Addr2Line(PyCodeObject *co, int byte_offset)

返回在 byte_offset 位置或之前以及之后发生的指令的行号。 如果你只需要一个帧的行号，请改用 PyFrame_GetLineNumber()。

要高效地迭代一个代码对象中的行号，请使用 PEP 626 描述的 API [https://www.python.org/dev/peps/pep-0626/#out-of-process-debuggers-and-profilers]。

文件对象

这些 API 是对内置文件对象的 Python 2 C API 的最小化模拟，它过去依赖于 C 标准库的带缓冲 I/O (FILE*) 支持。 在 Python 3 中，文件和流使用新的 io 模块，该萨凡纳的操作系统的低层级无缓冲 I/O 之上定义了几个层。 下面介绍的函数是针对这些新 API 的便捷 C 包装器，主要用于解释器的内部错误报告；建议第三方代码改为访问 io API。

PyObject *PyFile_FromFd(int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd)

返回值：新的引用。 Part of the Stable ABI.

根据已打开文件 fd 的文件描述符创建一个 Python 文件对象。 参数 name, encoding, errors 和 newline 可以为 NULL 表示使用默认值；buffering 可以为 -1 表示使用默认值。 name 会被忽略仅保留用于向下兼容。 失败时返回 NULL。 有关参数的更全面描述，请参阅 io.open() 函数的文档。

警告

由于Python流具有自己的缓冲层，因此将它们与 OS 级文件描述符混合会产生各种问题（例如数据的意外排序）。

在 3.2 版更改: 忽略 name 属性。

int PyObject_AsFileDescriptor(PyObject *p)

Part of the Stable ABI.

将与 p 关联的文件描述符作为 int 返回。 如果对象是整数，则返回其值。 如果不是，则如果对象存在 fileno() 方法则调用该方法；该方法必须返回一个整数，它将作为文件描述符的值返回。 失败时将设置异常并返回 -1。

PyObject *PyFile_GetLine(PyObject *p, int n)

返回值：新的引用。 Part of the Stable ABI.

等价于 p.readline([n]) ，这个函数从对象 p 中读取一行。 p 可以是文件对象或具有 readline() 方法的任何对象。 如果 n 是 0 ，则无论该行的长度如何，都会读取一行。 如果 n 大于 0，则从文件中读取不超过 n 个字节；可以返回行的一部分。 在这两种情况下，如果立即到达文件末尾，则返回空字符串。 但是，如果 n 小于 0 ，则无论长度如何都会读取一行，但是如果立即到达文件末尾，则引发 EOFError。

int PyFile_SetOpenCodeHook(Py_OpenCodeHookFunction handler)

重写 io.open_code() 的正常行为，将其形参通过所提供的处理程序来传递。

处理器是一个类型为 PyObject *(*)(PyObject *path, void *userData) 的函数，其中 path 会确保为 PyUnicodeObject。

userData 指针会被传入钩子函数。 因于钩子函数可能由不同的运行时调用，该指针不应直接指向 Python 状态。

鉴于这个钩子专门在导入期间使用的，请避免在新模块执行期间进行导入操作，除非已知它们为冻结状态或者是在 sys.modules 中可用。

一旦钩子被设定，它就不能被移除或替换，之后对 PyFile_SetOpenCodeHook() 的调用也将失败，如果解释器已经被初始化，函数将返回 -1 并设置一个异常。

此函数可以安全地在 Py_Initialize() 之前调用。

引发一个不带参数的 审计事件 setopencodehook。

3.8 新版功能.

int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)

Part of the Stable ABI.

将对象 obj 写入文件对象 p 。 flags 唯一支持的标志是 Py_PRINT_RAW；如果给定，则写入对象的 str() 而不是 repr()。成功时返回 0，失败时返回 -1。 将设置适当的例外。

int PyFile_WriteString(const char *s, PyObject *p)

Part of the Stable ABI.

将字符串 s 写入文件对象 p。 成功返回 0 失败返回 -1；将设定相应的异常。

模块对象

PyTypeObject PyModule_Type

Part of the Stable ABI.

这个 C 类型实例 PyTypeObject 用来表示Python中的模块类型。在 Python 程序中该实例被暴露为 types.ModuleType。

int PyModule_Check(PyObject *p)

当 p 为模块类型的对象，或是模块子类型的对象时返回真值。该函数永远有返回值。

int PyModule_CheckExact(PyObject *p)

当 p 为模块类型的对象且不是 PyModule_Type 的子类型的对象时返回真值。该函数永远有返回值。

PyObject *PyModule_NewObject(PyObject *name)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

返回新的模块对象，其属性 __name__ 为 name 。模块的如下属性 __name__, __doc__, __package__, and __loader__ 都会被自动填充。（所有属性除了 __name__ 都被设为 None）。调用时应当提供 __file__ 属性。

3.3 新版功能.

在 3.4 版更改: 属性 __package__ 和 __loader__ 被设为 None。

PyObject *PyModule_New(const char *name)

返回值：新的引用。 Part of the Stable ABI.

这类似于 PyModule_NewObject()， 但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。

PyObject *PyModule_GetDict(PyObject *module)

返回值：借入的引用。 Part of the Stable ABI.

返回实现 module 的命名空间的字典对象；此对象与模块对象的 __dict__ 属性相同。 如果 module 不是一个模块对象（或模块对象的子类型），则会引发 SystemError 并返回 NULL。

建议扩展使用其他 PyModule_* 和 PyObject_* 函数而不是直接操纵模块的 __dict__。

PyObject *PyModule_GetNameObject(PyObject *module)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

返回 module 的 __name__ 值。 如果模块未提供该值，或者如果它不是一个字符串，则会引发 SystemError 并返回 NULL。

3.3 新版功能.

const char *PyModule_GetName(PyObject *module)

Part of the Stable ABI.

类似于 PyModule_GetNameObject() 但返回 'utf-8' 编码的名称。

void *PyModule_GetState(PyObject *module)

Part of the Stable ABI.

返回模块的“状态”，也就是说，返回指向在模块创建时分配的内存块的指针，或者 NULL。 参见 PyModuleDef.m_size。

PyModuleDef *PyModule_GetDef(PyObject *module)

Part of the Stable ABI.

返回指向模块创建所使用的 PyModuleDef 结构体的指针，或者如果模块不是使用结构体定义创建的则返回 NULL。

PyObject *PyModule_GetFilenameObject(PyObject *module)

返回值：新的引用。 Part of the Stable ABI.

返回使用 module 的 __file__ 属性所加载的 模块 的文件名。 如果属性未定义，或者如果它不是一个 Unicode 字符串，则会引发 SystemError 并返回 NULL；在其他情况下将返回一个指向 Unicode 对象的引用。

3.2 新版功能.

const char *PyModule_GetFilename(PyObject *module)

Part of the Stable ABI.

类似于 PyModule_GetFilenameObject() 但会返回编码为 'utf-8' 的文件名。

3.2 版后已移除: PyModule_GetFilename() 对于不可编码的文件名会引发 UnicodeEncodeError，请改用 PyModule_GetFilenameObject()。

初始化 C 模块

模块对象通常是基于扩展模块（导出初始化函数的共享库），或内部编译模块（其中使用 PyImport_AppendInittab() 添加初始化函数）。 请参阅 构建C/C++扩展 或 对嵌入 Python 功能进行扩展 了解详情。

初始化函数可以向 PyModule_Create() 传入一个模块定义实例，并返回结果模块对象，或者通过返回定义结构体本身来请求“多阶段初始化”。

type PyModuleDef

Part of the Stable ABI (including all members).

模块定义结构，它保存创建模块对象所需的所有信息。每个模块通常只有一个这种类型的静态初始化变量

PyModuleDef_Base m_base

总是将此成员初始化为 PyModuleDef_HEAD_INIT。

const char *m_name

新模块的名称。

const char *m_doc

模块的文档字符串；一般会使用通过 PyDoc_STRVAR 创建的文档字符串变量。

Py_ssize_t m_size

可以把模块的状态保存在为单个模块分配的内存区域中，使用 PyModule_GetState() 检索，而不是保存在静态全局区。这使得模块可以在多个子解释器中安全地使用。

这个内存区域在模块创建时根据 m_size 分配，并在调用 m_free （如果存在）释放模块对象后释放。

将 m_size 设置为 -1，意味着这个模块具有全局状态，因此不支持子解释器。

将其设置为非负值，意味着模块可以重新初始化，并指定其状态所需要的额外内存大小。多阶段初始化需要非负的 m_size。

请参阅 PEP 3121 [https://www.python.org/dev/peps/pep-3121] 了解详情。

PyMethodDef *m_methods

一个指向模块函数表的指针，由 PyMethodDef 描述。如果模块没有函数，可以为 NULL。

PyModuleDef_Slot *m_slots

由针对多阶段初始化的槽位定义组成的数组，以一个 {0, NULL} 条目结束。 当使用单阶段初始化时，m_slots 必须为 NULL。

在 3.5 版更改: 在 3.5 版之前，此成员总是被设为 NULL，并被定义为:

inquiry m_reload

traverseproc m_traverse

在模块对象的垃圾回收遍历期间所调用的遍历函数，如果不需要则为 NULL。

如果模块状态已被请求但尚未被分配，则不会调用此函数。例如在模块刚刚创建完成之后、被执行之前（Py_mod_exec 函数）时的情况。更准确地说，如果 m_size 大于0，并且模块状态（由 PyModule_GetState() 返回）为 NULL，则不会调用此函数。

在 3.9 版更改: 在模块状态被分配之前不再调用。

inquiry m_clear

在模块对象的垃圾回收清理期间所调用的清理函数，如果不需要则为 NULL。

如果模块状态已被请求但尚未被分配，则不会调用此函数。例如在模块刚刚创建完成之后、被执行之前（Py_mod_exec 函数）时的情况。更准确地说，如果 m_size 大于0，并且模块状态（由 PyModule_GetState() 返回）为 NULL，则不会调用此函数。

就像 PyTypeObject.tp_clear 那样，这个函数并不总是在模块被释放前被调用。例如，当引用计数足以确定一个对象不再被使用时，就会直接调用 m_free，而不使用循环垃圾回收器。

在 3.9 版更改: 在模块状态被分配之前不再调用。

freefunc m_free

在模块对象的释放期间所调用的函数，如果不需要则为 NULL。

如果模块状态已被请求但尚未被分配，则不会调用此函数。例如在模块刚刚创建完成之后、被执行之前（Py_mod_exec 函数）时的情况。更准确地说，如果 m_size 大于0，并且模块状态（由 PyModule_GetState() 返回）为 NULL，则不会调用此函数。

在 3.9 版更改: 在模块状态被分配之前不再调用。

单阶段初始化

模块初始化函数可以直接创建并返回模块对象，称为“单阶段初始化”，使用以下两个模块创建函数中的一个：

PyObject *PyModule_Create(PyModuleDef *def)

返回值：新的引用。

创建一个新的模块对象，在参数 def 中给出定义。它等同于将参数 module_api_version 设置为 PYTHON_API_VERSION 的 PyModule_Create2() 函数。

PyObject *PyModule_Create2(PyModuleDef *def, int module_api_version)

返回值：新的引用。 Part of the Stable ABI.

创建一个新的模块对象，在参数 def 中给出定义，设定API版本为参数 module_api_version 。如果该版本与正在运行的解释器版本不匹配，则会触发 RuntimeWarning。

注解

大多数时候应该使用 PyModule_Create() 代替使用此函数，除非你确定需要使用它。

在初始化函数返回之前，生成的模块对象通常使用 PyModule_AddObjectRef() 等函数进行填充。

多阶段初始化

另一种指定扩展的方式是“多阶段初始化”。以这种方式创建的扩展模块的行为更类似 Python 模块：初始化分成两个阶段，创建阶段 创建模块对象，执行阶段 填充模块对象。它们的区别类似类的 __new__() 和 __init__() 方法。

与使用单阶段初始化创建的模块不同，这些模块不是单例：如果 sys.modules 被移除、模块被重新导入，将会创建一个新的模块对象，旧模块将进入常规的垃圾回收——就像 Python 模块那样。默认情况下，根据同一个定义创建的多个模块应该是相互独立的：修改其中之一不应该影响其它模块。这意味着所有状态都应该特定于模块对象（例如使用 PyModule_GetState()），或是它的内容（例如模块的 __dict__ 属性，或是使用 PyType_FromSpec() 创建的独立的类）。

所有使用多阶段初始化创建的模块都应该支持 子解释器。保证多个模块之间相互独立，通常就可以实现这一点。

要请求多阶段初始化，初始化函数 (PyInit_modulename) 返回一个包含非空的 m_slots 属性的 PyModuleDef 实例。在它被返回之前，这个 PyModuleDef 实例必须先使用以下函数初始化：

PyObject *PyModuleDef_Init(PyModuleDef *def)

返回值：借入的引用。 Part of the Stable ABI since version 3.5.

确保模块定义是一个正确初始化的Python对象，拥有正确的类型和引用计数。

返回转换为 PyObject* 的 def ，如果发生错误，则返回 NULL。

3.5 新版功能.

模块定义的 m_slots 成员必须指向一个 PyModuleDef_Slot 结构体数组:

type PyModuleDef_Slot

int slot

槽位 ID，从下面介绍的可用值中选择。

void *value

槽位值，其含义取决于槽位 ID。

3.5 新版功能.

m_slots 数组必须以一个 id 为 0 的槽位结束。

可用的槽位类型是:

Py_mod_create

指定一个函数供调用以创建模块对象本身。 该槽位的 value 指针必须指向一个具有如下签名的函数:

PyObject *create_module(PyObject *spec, PyModuleDef *def)

该函数接受一个 ModuleSpec 实例，如 PEP 451 [https://www.python.org/dev/peps/pep-0451] 所定义的，以及模块定义。 它应当返回一个新的模块对象，或者设置一个错误并返回 NULL。

此函数应当保持最小化。 特别地，它不应当调用任意 Python 代码，因为尝试再次导入同一个模块可能会导致无限循环。

多个 Py_mod_create 槽位不能在一个模块定义中指定。

如果未指定 Py_mod_create，导入机制将使用 PyModule_New() 创建一个普通的模块对象。 名称是获取自 spec 而非定义，以允许扩展模块动态地调整它们在模块层级结构中的位置并通过符号链接以不同的名称被导入，同时共享同一个模块定义。

不要求返回的对象必须为 PyModule_Type 的实例。 任何类型均可使用，只要它支持设置和获取导入相关的属性。 但是，如果 PyModuleDef 具有非 NULL 的 m_traverse, m_clear, m_free；非零的 m_size；或者 Py_mod_create 以外的槽位则只能返回 PyModule_Type 的实例。

Py_mod_exec

指定一个供调用以 执行 模块的函数。 这造价于执行一个 Python 模块的代码：通常，此函数会向模块添加类和常量。 此函数的签名为:

int exec_module(PyObject *module)

如果指定了多个 Py_mod_exec 槽位，将按照它们在*m_slots*数组中出现的顺序进行处理。

有关多阶段初始化的更多细节，请参阅PEP:489

底层模块创建函数

当使用多阶段初始化时，将会调用以下函数。例如，在动态创建模块对象的时候，可以直接使用它们。注意，必须调用 PyModule_FromDefAndSpec 和 PyModule_ExecDef 来完整地初始化一个模块。

PyObject *PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)

返回值：新的引用。

Create a new module object, given the definition in def and the ModuleSpec spec. This behaves like PyModule_FromDefAndSpec2() with module_api_version set to PYTHON_API_VERSION.

3.5 新版功能.

PyObject *PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

创建一个新的模块对象，在参数 def 和 spec 中给出定义，设置API版本为参数 module_api_version。如果该版本与正在运行的解释器版本不匹配，则会触发 RuntimeWarning。

注解

大多数时候应该使用 PyModule_FromDefAndSpec() 代替使用此函数，除非你确定需要使用它。

3.5 新版功能.

int PyModule_ExecDef(PyObject *module, PyModuleDef *def)

Part of the Stable ABI since version 3.7.

执行参数*def*中给出的任意执行槽（Py_mod_exec）。

3.5 新版功能.

int PyModule_SetDocString(PyObject *module, const char *docstring)

Part of the Stable ABI since version 3.7.

将*module*的文档字符串设置为*docstring*。当使用 PyModule_Create 或 PyModule_FromDefAndSpec 从 PyModuleDef 创建模块时，会自动调用此函数。

3.5 新版功能.

int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)

Part of the Stable ABI since version 3.7.

将以 NULL 结尾的*functions*数组中的函数添加到*module*模块中。有关单个条目的更多细节，请参与 PyMethodDef 文档（由于缺少共享的模块命名空间，在C中实现的模块级“函数”通常将模块作为它的第一个参数，与Python类的实例方法类似）。当使用 PyModule_Create 或 PyModule_FromDefAndSpec 从 PyModuleDef 创建模块时，会自动调用此函数。

3.5 新版功能.

支持函数

模块初始化函数（单阶段初始化）或通过模块的执行槽位调用的函数（多阶段初始化），可以使用以下函数，来帮助初始化模块的状态：

int PyModule_AddObjectRef(PyObject *module, const char *name, PyObject *value)

Part of the Stable ABI since version 3.10.

将一个名称为*name*的对象添加到*module*模块中。这是一个方便的函数，可以在模块的初始化函数中使用。

如果成功，返回 0。如果发生错误，引发异常并返回 -1。

如果*value*为 NULL，返回 NULL。在调用它时发生这种情况，必须抛出异常。

用法示例:

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;
 }

这个例子也可以写成不显式地检查 obj 是否为 NULL:

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;
 }

注意在此情况下应当使用 Py_XDECREF() 而不是 Py_DECREF()，因为 obj 可能为 NULL。

3.10 新版功能.

int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)

Part of the Stable ABI.

类似于 PyModule_AddObjectRef()，但会在成功时偷取一个对 value 的引用（如果它返回 0 值）。

推荐使用新的 PyModule_AddObjectRef() 函数，因为误用 PyModule_AddObject() 函数很容易导致引用泄漏。

注解

与其他窃取引用的函数不同，PyModule_AddObject() 只在 成功 时释放对 value 的引用。

这意味着必须检查它的返回值，调用方必须在发生错误时手动为*value*调用 Py_DECREF()。

用法示例:

static int
add_spam(PyObject *module, int value)
{
    PyObject *obj = PyLong_FromLong(value);
    if (obj == NULL) {
        return -1;
    }
    if (PyModule_AddObject(module, "spam", obj) < 0) {
        Py_DECREF(obj);
        return -1;
    }
    // PyModule_AddObject() stole a reference to obj:
    // Py_DECREF(obj) is not needed here
    return 0;
}

这个例子也可以写成不显式地检查 obj 是否为 NULL:

static int
add_spam(PyObject *module, int value)
{
    PyObject *obj = PyLong_FromLong(value);
    if (PyModule_AddObject(module, "spam", obj) < 0) {
        Py_XDECREF(obj);
        return -1;
    }
    // PyModule_AddObject() stole a reference to obj:
    // Py_DECREF(obj) is not needed here
    return 0;
}

注意在此情况下应当使用 Py_XDECREF() 而不是 Py_DECREF()，因为 obj 可能为 NULL。

int PyModule_AddIntConstant(PyObject *module, const char *name, long value)

Part of the Stable ABI.

将一个名称为*name*的整型常量添加到*module*模块中。这个方便的函数可以在模块的初始化函数中使用。如果发生错误，返回 -1，成功返回 0。

int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)

Part of the Stable ABI.

将一个名称为*name*的字符串常量添加到*module*模块中。这个方便的函数可以在模块的初始化函数中使用。字符串*value*必须以 NULL 结尾。如果发生错误，返回 -1 ，成功返回 0 。

int PyModule_AddIntMacro(PyObject *module, macro)

将一个整型常量添加到*module*模块中。名称和值取自*macro*参数。例如， PyModule_AddIntMacro(module, AF_INET) 将值为*AF_INET*的整型常量*AF_INET*添加到*module*模块中。如果发生错误，返回 -1 ，成功返回 0 。

int PyModule_AddStringMacro(PyObject *module, macro)

将一个字符串常量添加到*module*模块中。

int PyModule_AddType(PyObject *module, PyTypeObject *type)

Part of the Stable ABI since version 3.10.

将一个类型对象添加到 module 模块中。类型对象通过在函数内部调用 PyType_Ready() 完成初始化。类型对象的名称取自 tp_name 最后一个点号之后的部分。如果发生错误，返回 -1，成功返回 0。

3.9 新版功能.

查找模块

单阶段初始化创建可以在当前解释器上下文中被查找的单例模块。这使得仅通过模块定义的引用，就可以检索模块对象。

这些函数不适用于通过多阶段初始化创建的模块，因为可以从一个模块定义创建多个模块对象。

PyObject *PyState_FindModule(PyModuleDef *def)

返回值：借入的引用。 Part of the Stable ABI.

返回当前解释器中由 def 创建的模块对象。此方法要求模块对象此前已通过 PyState_AddModule() 函数附加到解释器状态中。如果找不到相应的模块对象，或模块对象还未附加到解释器状态，返回 NULL。

int PyState_AddModule(PyObject *module, PyModuleDef *def)

Part of the Stable ABI since version 3.3.

将传给函数的模块对象附加到解释器状态。 这将允许通过 PyState_FindModule() 来访问该模块对象。

仅在使用单阶段初始化创建的模块上有效。

Python 会在导入一个模块后自动调用 PyState_AddModule，因此从模块初始化代码中调用它是没有必要的（但也没有害处）。 显式的调用仅在模块自己的初始化代码后继调用了 PyState_FindModule 的情况下才是必要的。 此函数主要是为了实现替代导入机制（或是通过直接调用它，或是通过引用它的实现来获取所需的状态更新详情）。

调用时必须携带GIL。

成功是返回 0 或者失败时返回 -1。

3.3 新版功能.

int PyState_RemoveModule(PyModuleDef *def)

Part of the Stable ABI since version 3.3.

从解释器状态中移除由 def 创建的模块对象。 成功时返回 0，者失败时返回 -1。

调用时必须携带GIL。

3.3 新版功能.

迭代器对象

Python 提供了两个通用迭代器对象。 第一个是序列迭代器，它使用支持 __getitem__() 方法的任意序列。 第二个使用可调用对象和一个 sentinel 值，为序列中的每个项调用可调用对象，并在返回 sentinel 值时结束迭代。

PyTypeObject PySeqIter_Type

Part of the Stable ABI.

PySeqIter_New() 返回迭代器对象的类型对象和内置序列类型内置函数 iter() 的单参数形式。

int PySeqIter_Check(op)

如果 op 的类型为 PySeqIter_Type 则返回真值。 此函数总是会成功执行。

PyObject *PySeqIter_New(PyObject *seq)

返回值：新的引用。 Part of the Stable ABI.

返回一个与常规序列对象一起使用的迭代器 seq。 当序列订阅操作引发 IndexError 时，迭代结束。

PyTypeObject PyCallIter_Type

Part of the Stable ABI.

由函数 PyCallIter_New() 和 iter() 内置函数的双参数形式返回的迭代器对象类型对象。

int PyCallIter_Check(op)

如果 op 的类型为 PyCallIter_Type 则返回真值。 此函数总是会成功执行。

PyObject *PyCallIter_New(PyObject *callable, PyObject *sentinel)

返回值：新的引用。 Part of the Stable ABI.

返回一个新的迭代器。 第一个参数 callable 可以是任何可以在没有参数的情况下调用的 Python 可调用对象；每次调用都应该返回迭代中的下一个项目。 当 callable 返回等于 sentinel 的值时，迭代将终止。

描述符对象

“描述符”是描述对象的某些属性的对象。它们存在于类型对象的字典中。

PyTypeObject PyProperty_Type

Part of the Stable ABI.

内建描述符类型的类型对象。

PyObject *PyDescr_NewGetSet(PyTypeObject *type, struct PyGetSetDef *getset)

返回值：新的引用。 Part of the Stable ABI.

PyObject *PyDescr_NewMember(PyTypeObject *type, struct PyMemberDef *meth)

返回值：新的引用。 Part of the Stable ABI.

PyObject *PyDescr_NewMethod(PyTypeObject *type, struct PyMethodDef *meth)

返回值：新的引用。 Part of the Stable ABI.

PyObject *PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)

返回值：新的引用。

PyObject *PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)

返回值：新的引用。 Part of the Stable ABI.

int PyDescr_IsData(PyObject *descr)

如果描述符对象 descr 描述的是一个数据属性则返回非零值，或者如果它描述的是一个方法则返回 0。 descr 必须为一个描述符对象；不会进行错误检测。

PyObject *PyWrapper_New(PyObject*, PyObject*)

返回值：新的引用。 Part of the Stable ABI.

切片对象

PyTypeObject PySlice_Type

Part of the Stable ABI.

切片对象的类型对象。 它与 Python 层面的 slice 是相同的对象。

int PySlice_Check(PyObject *ob)

如果 ob 是一个 slice 对象则返回真值；ob 必须不为 NULL。 此函数总是会成功执行。

PyObject *PySlice_New(PyObject *start, PyObject *stop, PyObject *step)

返回值：新的引用。 Part of the Stable ABI.

返回一个具有给定值的新切片对象。 start, stop 和 step 形参会被用作 slice 对象相应名称的属性的值。 这些值中的任何一个都可以为 NULL，在这种情况下将使用 None 作为对应属性的值。 如果新对象无法被分配则返回 NULL。

int PySlice_GetIndices(PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)

Part of the Stable ABI.

从切片对象 slice 提取 start, stop 和 step 索引号，将序列长度视为 length。 大于 length 的序列号将被当作错误。

成功时返回 0，出错时返回 -1 并且不设置异常（除非某个序列号不为 None 且无法被转换为整数，在这种情况下会返回 -1 并且设置一个异常）。

你可能不会打算使用此函数。

在 3.2 版更改: 之前 slice 形参的形参类型是 PySliceObject*。

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)

Part of the Stable ABI.

PySlice_GetIndices() 的可用替代。 从切片对象 slice 提取 start, stop 和 step 索引号，将序列长度视为 length，并将切片的长度保存在 slicelength 中，超出范围的索引号会以与普通切片一致的方式进行剪切。

成功时返回 0，出错时返回 -1 并且不设置异常。

注解

此函数对于可变大小序列来说是不安全的。 对它的调用应被替换为 PySlice_Unpack() 和 PySlice_AdjustIndices() 的组合，其中

if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) {
    // return error
}

会被替换为

if (PySlice_Unpack(slice, &start, &stop, &step) < 0) {
    // return error
}
slicelength = PySlice_AdjustIndices(length, &start, &stop, step);

在 3.2 版更改: 之前 slice 形参的形参类型是 PySliceObject*。

在 3.6.1 版更改: 如果 Py_LIMITED_API 未设置或设置为 0x03050400 与 0x03060000 之间的值（不包括边界）或 0x03060100 或更大则 PySlice_GetIndicesEx() 会被实现为一个使用 PySlice_Unpack() 和 PySlice_AdjustIndices() 的宏。 参数 start, stop 和 step 会被多被求值。

3.6.1 版后已移除: 如果 Py_LIMITED_API 设置为小于 0x03050400 或 0x03060000 与 0x03060100 之间的值（不包括边界）则 PySlice_GetIndicesEx() 为已弃用的函数。

int PySlice_Unpack(PyObject *slice, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)

Part of the Stable ABI since version 3.7.

从切片对象中将 start, stop 和 step 数据成员提取为 C 整数。 会静默地将大于 PY_SSIZE_T_MAX 的值减小为 PY_SSIZE_T_MAX，静默地将小于 PY_SSIZE_T_MIN 的 start 和 stop 值增大为 PY_SSIZE_T_MIN，并静默地将小于 -PY_SSIZE_T_MAX 的 step 值增大为 -PY_SSIZE_T_MAX。

出错时返回 -1，成功时返回 0。

3.6.1 新版功能.

Py_ssize_t PySlice_AdjustIndices(Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step)

Part of the Stable ABI since version 3.7.

将 start/end 切片索引号根据指定的序列长度进行调整。 超出范围的索引号会以与普通切片一致的方式进行剪切。

返回切片的长度。 此操作总是会成功。 不会调用 Python 代码。

3.6.1 新版功能.

Ellipsis 对象

PyObject *Py_Ellipsis

Python 的 Ellipsis 对象。 该对象没有任何方法。 它必须以与任何其他对象一样的方式遵循引用计数。 它与 Py_None 一样属于单例对象。

MemoryView 对象

一个 memoryview 对象C级别的 缓冲区接口 暴露为一个可以像任何其他对象一样传递的 Python 对象。

PyObject *PyMemoryView_FromObject(PyObject *obj)

返回值：新的引用。 Part of the Stable ABI.

从提供缓冲区接口的对象创建 memoryview 对象。 如果 obj 支持可写缓冲区导出，则 memoryview 对象将可以被读/写，否则它可能是只读的，也可以是导出器自行决定的读/写。

PyObject *PyMemoryView_FromMemory(char *mem, Py_ssize_t size, int flags)

返回值：新的引用。 Part of the Stable ABI since version 3.7.

使用 mem 作为底层缓冲区创建一个 memoryview 对象。 flags 可以是 PyBUF_READ 或者 PyBUF_WRITE 之一.

3.3 新版功能.

PyObject *PyMemoryView_FromBuffer(Py_buffer *view)

返回值：新的引用。

创建一个包含给定缓冲区结构 view 的 memoryview 对象。 对于简单的字节缓冲区，PyMemoryView_FromMemory() 是首选函数。

PyObject *PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order)

返回值：新的引用。 Part of the Stable ABI.

从定义缓冲区接口的对象创建一个 memoryview 对象 contiguous 内存块（在 'C' 或 'F'ortran order 中）。 如果内存是连续的，则 memoryview 对象指向原始内存。 否则，复制并且 memoryview 指向新的 bytes 对象。

int PyMemoryView_Check(PyObject *obj)

如果 obj 是一个 memoryview 对象则返回真值。 目前不允许创建 memoryview 的子类。 此函数总是会成功执行。

Py_buffer *PyMemoryView_GET_BUFFER(PyObject *mview)

返回指向 memoryview 的导出缓冲区私有副本的指针。 mview 必须 是一个 memoryview 实例；这个宏不检查它的类型，你必须自己检查，否则你将面临崩溃风险。

PyObject *PyMemoryView_GET_BASE(PyObject *mview)

返回 memoryview 所基于的导出对象的指针，或者如果 memoryview 已由函数 PyMemoryView_FromMemory() 或 PyMemoryView_FromBuffer() 创建则返回 NULL。 mview 必须 是一个 memoryview 实例。

弱引用对象

Python 支持 “弱引用” 作为一类对象。具体来说，有两种直接实现弱引用的对象。第一种就是简单的引用对象，第二种尽可能地作用为一个原对象的代理。

int PyWeakref_Check(ob)

如果 ob 是一个引用或代理对象则返回真值。 此函数总是会成功执行。

int PyWeakref_CheckRef(ob)

如果 ob 是一个引用对象则返回真值。 此函数总是会成功执行。

int PyWeakref_CheckProxy(ob)

如果 ob 是一个代理对象则返回真值。 此函数总是会成功执行。

PyObject *PyWeakref_NewRef(PyObject *ob, PyObject *callback)

返回值：新的引用。 Part of the Stable ABI.

返回对象 ob 的一个弱引用对象。 该函数总是会返回一个新引用，但不保证创建一个新的对象；它有可能返回一个现有的引用对象。 第二个形参 callback 可以是一个可调用对象，它会在 ob 被作为垃圾回收时接收通知；它应当接受一个单独形参，即弱引用对象本身。 callback 也可以为 None 或 NULL。 如果 ob 不是一个弱引用对象，或者如果 callback 不是可调用对象、None 或 NULL，则该函数将返回 NULL 并引发 TypeError。

PyObject *PyWeakref_NewProxy(PyObject *ob, PyObject *callback)

返回值：新的引用。 Part of the Stable ABI.

返回对象 ob 的一个弱引用代理对象。 该函数将总是返回一个新的引用，但不保证创建一个新的对象；它有可能返回一个现有的代理对象。 第二个形参 callback 可以是一个可调用对象，它会在 ob 被作为垃圾回收时接收通敌；它应当接受一个单独形参，即弱引用对象本身。 callback 也可以为 None 或 NULL。 如果 ob 不是一个弱引用对象，或者如果 callback 不是可调用对象、None 或 NULL，则该函数将返回 NULL 并引发 TypeError。

PyObject *PyWeakref_GetObject(PyObject *ref)

返回值：借入的引用。 Part of the Stable ABI.

返回弱引用对象 ref 的被引用对象。如果被引用对象不再存在，则返回 Py_None。

注解

该函数返回被引用对象的一个 borrowed reference。 这意味着应该总是在该对象上调用 Py_INCREF()，除非是当它在借入引用的最后一次被使用之前无法被销毁的时候。

PyObject *PyWeakref_GET_OBJECT(PyObject *ref)

返回值：借入的引用。

类似 PyWeakref_GetObject()，但实现为一个不做类型检查的宏。

void PyObject_ClearWeakRefs(PyObject *object)

Part of the Stable ABI.

此函数将被 tp_dealloc 处理器调用以清空弱引用。

此函数将迭代 object 的弱引用并调用这些引用中可能存在的回调。 它将在尝试了所有回调之后返回。

Capsule 对象

有关使用这些对象的更多信息请参阅 给扩展模块提供C API。

3.1 新版功能.

type PyCapsule

这个 PyObject 的子类型代表一个隐藏的值，适用于需要将隐藏值（作为 void* 指针）通过 Python 代码传递到其他 C 代码的 C 扩展模块。 它常常被用来让在一个模块中定义的 C 函数指针在其他模块中可用，这样就可以使用常规导入机制来访问在动态加载的模块中定义的 C API。

type PyCapsule_Destructor

Part of the Stable ABI.

Capsule 的析构器回调的类型。 定义如下：

typedef void (*PyCapsule_Destructor)(PyObject *);

参阅 PyCapsule_New() 来获取 PyCapsule_Destructor 返回值的语义。

int PyCapsule_CheckExact(PyObject *p)

如果参数是一个 PyCapsule 则返回真值。 此函数总是会成功执行。

PyObject *PyCapsule_New(void *pointer, const char *name, PyCapsule_Destructor destructor)

返回值：新的引用。 Part of the Stable ABI.

创建一个封装了 pointer 的 PyCapsule。 pointer 参考可以不为 NULL。

在失败时设置一个异常并返回 NULL。

字符串 name 可以是 NULL 或是一个指向有效的 C 字符串的指针。 如果不为 NULL，则此字符串必须比 capsule 长（虽然也允许在 destructor 中释放它。）

如果 destructor 参数不为 NULL，则当它被销毁时将附带 capsule 作为参数来调用。

如果此 capsule 将被保存为一个模块的属性，则 name 应当被指定为 modulename.attributename。 这将允许其他模块使用 PyCapsule_Import() 来导入此 capsule。

void *PyCapsule_GetPointer(PyObject *capsule, const char *name)

Part of the Stable ABI.

提取保存在 capsule 中的 pointer。 在失败时设置一个异常并返回 NULL。

name 形参必须与保存在 capsule 中的名称进行精确比较。 如果保存在 capsule 中的名称为 NULL，则传入的 name 也必须为 NULL。 Python 会使用 C 函数 strcmp() 来比较 capsule 名称。

PyCapsule_Destructor PyCapsule_GetDestructor(PyObject *capsule)

Part of the Stable ABI.

返回保存在 capsule 中的当前析构器。 在失败时设置一个异常并返回 NULL。

capsule 具有 NULL 析构器是合法的。 这会使得 NULL 返回码有些歧义；请使用 PyCapsule_IsValid() 或 PyErr_Occurred() 来消除歧义。

void *PyCapsule_GetContext(PyObject *capsule)

Part of the Stable ABI.

返回保存在 capsule 中的当前上下文。 在失败时设置一个异常并返回 NULL。

capsule 具有 NULL 上下文是全法的。 这会使得 NULL 返回码有些歧义；请使用 PyCapsule_IsValid() 或 PyErr_Occurred() 来消除歧义。

const char *PyCapsule_GetName(PyObject *capsule)

Part of the Stable ABI.

返回保存在 capsule 中的当前名称。 在失败时设置一个异常并返回 NULL。

capsule 具有 NULL 名称是合法的。 这会使得 NULL 返回码有些歧义；请使用 PyCapsule_IsValid() 或 PyErr_Occurred() 来消除歧义。

void *PyCapsule_Import(const char *name, int no_block)

Part of the Stable ABI.

从一个模块的 capsule 属性导入指向 C 对象的指针。 name 形参应当指定属性的完整名称，与 module.attribute 中的一致。 保存在 capsule 中的 name 必须完全匹配此字符串。 如果 no_block 为真值，则以无阻塞模式导入模块 (使用 PyImport_ImportModuleNoBlock())。 如果 no_block 为假值，则以传统模式导入模块 (使用 PyImport_ImportModule())。

成功时返回 capsule 的内部 指针。 在失败时设置一个异常并返回 NULL。

int PyCapsule_IsValid(PyObject *capsule, const char *name)

Part of the Stable ABI.

确定 capsule 是否是一个有效的。 有效的 capsule 必须不为 NULL，传递 PyCapsule_CheckExact()，在其中存储一个不为 NULL 的指针，并且其内部名称与 name 形参相匹配。 （请参阅 PyCapsule_GetPointer() 了解如何对 capsule 名称进行比较的有关信息。）

换句话说，如果 PyCapsule_IsValid() 返回真值，则任何对访问器（以 PyCapsule_Get() 开头的任何函数）的调用都保证会成功。

如果对象有效并且匹配传入的名称则返回非零值。 否则返回 0。 此函数一定不会失败。

int PyCapsule_SetContext(PyObject *capsule, void *context)

Part of the Stable ABI.

将 capsule 内部的上下文指针设为 context。

成功时返回 0。 失败时返回非零值并设置一个异常。

int PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor)

Part of the Stable ABI.

将 capsule 内部的析构器设为 destructor。

成功时返回 0。 失败时返回非零值并设置一个异常。

int PyCapsule_SetName(PyObject *capsule, const char *name)

Part of the Stable ABI.

将 capsule 内部的名称设为 name。 如果不为 NULL，则名称的存在期必须比 capsule 更长。 如果之前保存在 capsule 中的 name 不为 NULL，则不会尝试释放它。

成功时返回 0。 失败时返回非零值并设置一个异常。

int PyCapsule_SetPointer(PyObject *capsule, void *pointer)

Part of the Stable ABI.

将 capsule 内部的空指针设为 pointer。 指针不可为 NULL。

成功时返回 0。 失败时返回非零值并设置一个异常。

生成器对象

生成器对象是Python用来实现生成器迭代器的对象。它们通常通过迭代产生值的函数来创建，而不是显式调用 PyGen_New() 或 PyGen_NewWithQualName()。

type PyGenObject

用于生成器对象的C结构体。

PyTypeObject PyGen_Type

与生成器对象对应的类型对​​象。

int PyGen_Check(PyObject *ob)

如果 ob 是一个 generator 对象则返回真值；ob 必须不为 NULL。 此函数总是会成功执行。

int PyGen_CheckExact(PyObject *ob)

如果 ob 的类型是 PyGen_Type 则返回真值；ob 必须不为 NULL。 此函数总是会成功执行。

PyObject *PyGen_New(PyFrameObject *frame)

返回值：新的引用。

基于 frame 对象创建并返回一个新的生成器对象。 此函数会取走一个对 frame 的引用。 参数必须不为 NULL。

PyObject *PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname)

返回值：新的引用。

基于 frame 对象创建并返回一个新的生成器对象，其中 __name__ 和 __qualname__ 设为 name 和 qualname。 此函数会取走一个对 frame 的引用。 frame 参数必须不为 NULL。

协程对象

3.5 新版功能.

协程对象是使用 async 关键字声明的函数返回的。

type PyCoroObject

用于协程对象的C结构体。

PyTypeObject PyCoro_Type

与协程对象对应的类型对​​象。

int PyCoro_CheckExact(PyObject *ob)

如果 ob 的类型是 PyCoro_Type 则返回真值；ob 必须不为 NULL。 此函数总是会成功执行。

PyObject *PyCoro_New(PyFrameObject *frame, PyObject *name, PyObject *qualname)

返回值：新的引用。

基于 frame 对象创建并返回一个新的协程对象，其中 __name__ 和 __qualname__ 设为 name 和 qualname。 此函数会取得一个对 frame 的引用。 frame 参数必须不为 NULL。

上下文变量对象

注解

在 3.7.1 版更改:

在 Python 3.7.1 中，所有上下文变量 C API 的签名被 更改 为使用 PyObject 指针而不是 PyContext, PyContextVar 以及 PyContextToken，例如:

// in 3.7.0:
PyContext *PyContext_New(void);

// in 3.7.1+:
PyObject *PyContext_New(void);

请参阅 bpo-34762 [https://bugs.python.org/issue?@action=redirect&bpo=34762] 了解详情。

3.7 新版功能.

本节深入介绍了 contextvars 模块的公用 C API。

type PyContext

用于表示 contextvars.Context 对象的 C 结构体。

type PyContextVar

用于表示 contextvars.ContextVar 对象的 C 结构体。

type PyContextToken

用于表示 contextvars.Token 对象的 C 结构体。

PyTypeObject PyContext_Type

表示 context 类型的类型对象。

PyTypeObject PyContextVar_Type

表示 context variable 类型的类型对象。

PyTypeObject PyContextToken_Type

表示 context variable token 类型的类型对象。

类型检查宏：

int PyContext_CheckExact(PyObject *o)

如果 o 的类型为 PyContext_Type 则返回真值。 o 必须不为 NULL。 此函数总是会成功执行。

int PyContextVar_CheckExact(PyObject *o)

如果 o 的类型为 PyContextVar_Type 则返回真值。 o 必须不为 NULL。 此函数总是会成功执行。

int PyContextToken_CheckExact(PyObject *o)

如果 o 的类型为 PyContextToken_Type 则返回真值。 o 必须不为 NULL。 此函数总是会成功执行。

上下文对象管理函数:

PyObject *PyContext_New(void)

返回值：新的引用。

创建一个新的空上下文对象。 如果发生错误则返回 NULL。

PyObject *PyContext_Copy(PyObject *ctx)

返回值：新的引用。

创建所传入的 ctx 上下文对象的浅拷贝。 如果发生错误则返回 NULL。

PyObject *PyContext_CopyCurrent(void)

返回值：新的引用。

创建当前线程上下文的浅拷贝。 如果发生错误则返回 NULL。

int PyContext_Enter(PyObject *ctx)

将 ctx 设为当前线程的当前上下文。 成功时返回 0，出错时返回 -1。

int PyContext_Exit(PyObject *ctx)

取消激活 ctx 上下文并将之前的上下文恢复为当前线程的当前上下文。 成功时返回 0，出错时返回 -1。

上下文变量函数:

PyObject *PyContextVar_New(const char *name, PyObject *def)

返回值：新的引用。

创建一个新的 ContextVar 对象。 形参 name 用于自我检查和调试目的。 形参 def 为上下文变量指定默认值，或为 NULL 表示无默认值。 如果发生错误，这个函数会返回 NULL。

int PyContextVar_Get(PyObject *var, PyObject *default_value, PyObject **value)

获取上下文变量的值。如果在查找过程中发生错误，返回' ' -1 ' '，如果没有发生错误，无论是否找到值，都返回' ' 0 ' '，

如果找到上下文变量，value 将是指向它的指针。 如果上下文变量 没有 找到，value 将指向：

default_value，如果非 NULL;

var 的默认值，如果不是 NULL；

NULL

除了返回 NULL，这个函数会返回一个新的引用。

PyObject *PyContextVar_Set(PyObject *var, PyObject *value)

返回值：新的引用。

在当前上下文中将 var 设为 value。 返回针对此修改的新凭据对象，或者如果发生错误则返回 NULL。

int PyContextVar_Reset(PyObject *var, PyObject *token)

将上下文变量 var 的状态重置为它在返回 token 的 PyContextVar_Set() 被调用之前的状态。 此函数成功时返回 0，出错时返回 -1。

DateTime 对象

datetime 模块提供了各种日期和时间对象。 在使用任何这些函数之前，必须在你的源码中包含头文件 datetime.h (请注意此文件并未包含在 Python.h 中)，并且宏 PyDateTime_IMPORT 必须被发起调用，通常是作为模块初始化函数的一部分。 这个宏会将指向特定 C 结构的指针放入一个静态变量 PyDateTimeAPI 中，它会由下面的宏来使用。

宏访问UTC单例:

PyObject *PyDateTime_TimeZone_UTC

返回表示 UTC 的时区单例，与 datetime.timezone.utc 为同一对象。

3.7 新版功能.

类型检查宏：

int PyDate_Check(PyObject *ob)

如果 ob 为 PyDateTime_DateType 类型或 PyDateTime_DateType 的某个子类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyDate_CheckExact(PyObject *ob)

如果 ob 为 PyDateTime_DateType 类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyDateTime_Check(PyObject *ob)

如果 ob 为 PyDateTime_DateTimeType 类型或 PyDateTime_DateTimeType 的某个子类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyDateTime_CheckExact(PyObject *ob)

如果 ob 为 PyDateTime_DateTimeType 类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyTime_Check(PyObject *ob)

如果 ob 的类型是 PyDateTime_TimeType 或是 PyDateTime_TimeType 的子类型则返回真值。 ob 必须不为 NULL。 此函数总是会成功执行。

int PyTime_CheckExact(PyObject *ob)

如果 ob 为 PyDateTime_TimeType 类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyDelta_Check(PyObject *ob)

如果 ob 为 PyDateTime_DeltaType 类型或 PyDateTime_DeltaType 的某个子类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyDelta_CheckExact(PyObject *ob)

如果 ob 为 PyDateTime_DeltaType 类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

int PyTZInfo_Check(PyObject *ob)

如果 ob 的类型是 PyDateTime_TZInfoType 或是 PyDateTime_TZInfoType 的子类型则返回真值。 ob 必须不为 NULL。 此函数总是会成功执行。

int PyTZInfo_CheckExact(PyObject *ob)

如果 ob 为 PyDateTime_TZInfoType 类型则返回真值。 ob 不能为 NULL。 此函数总是会成功执行。

用于创建对象的宏：

PyObject *PyDate_FromDate(int year, int month, int day)

返回值：新的引用。

返回指定年、月、日的 datetime.date 对象。

PyObject *PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond)

返回值：新的引用。

返回具有指定 year, month, day, hour, minute, second 和 microsecond 属性的 datetime.datetime 对象。

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 属性的 datetime.datetime 对象。

3.6 新版功能.

PyObject *PyTime_FromTime(int hour, int minute, int second, int usecond)

返回值：新的引用。

返回具有指定 hour, minute, second and microsecond 属性的 datetime.time 对象。

PyObject *PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold)

返回值：新的引用。

返回具有指定 hour, minute, second, microsecond 和 fold 属性的 datetime.time 对象。

3.6 新版功能.

PyObject *PyDelta_FromDSU(int days, int seconds, int useconds)

返回值：新的引用。

返回代表给定天、秒和微秒数的 datetime.timedelta 对象。 将执行正规化操作以使最终的微秒和秒数处在 datetime.timedelta 对象的文档指明的区间之内。

PyObject *PyTimeZone_FromOffset(PyDateTime_DeltaType *offset)

返回值：新的引用。

返回一个 datetime.timezone 对象，该对象具有以 offset 参数表示 的未命名固定时差。

3.7 新版功能.

PyObject *PyTimeZone_FromOffsetAndName(PyDateTime_DeltaType *offset, PyUnicode *name)

返回值：新的引用。

返回一个 datetime.timezone 对象，该对象具有以 offset 参数表示的固定时差和时区名称 name。

3.7 新版功能.

一些用来从 date 对象中提取字段的宏。 参数必须是 PyDateTime_Date 包括其子类 (例如 PyDateTime_DateTime) 的实例。 参数必须不为 NULL，并且类型不被会检查:

int PyDateTime_GET_YEAR(PyDateTime_Date *o)

以正整数的形式返回年份值。

int PyDateTime_GET_MONTH(PyDateTime_Date *o)

返回月，从0到12的整数。

int PyDateTime_GET_DAY(PyDateTime_Date *o)

返回日期，从0到31的整数。

一些用来从 datetime 对象中提取字段的宏。 参数必须是 PyDateTime_DateTime 包括其子类的实例。 参数必须不为 NULL，并且类型不会被检查:

int PyDateTime_DATE_GET_HOUR(PyDateTime_DateTime *o)

返回小时，从0到23的整数。

int PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o)

返回分钟，从0到59的整数。

int PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o)

返回秒，从0到59的整数。

int PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o)

返回微秒，从0到999999的整数。

int PyDateTime_DATE_GET_FOLD(PyDateTime_DateTime *o)

返回折叠值，为整数 0 或 1。

3.6 新版功能.

PyObject *PyDateTime_DATE_GET_TZINFO(PyDateTime_DateTime *o)

返回 tzinfo (可以为 None)。

3.10 新版功能.

一些用来从 time 对象中提取字段的宏。 参数必须是 PyDateTime_Time 包括其子类的实例。 参数必须不为 NULL，并且类型不会被检查:

int PyDateTime_TIME_GET_HOUR(PyDateTime_Time *o)

返回小时，从0到23的整数。

int PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o)

返回分钟，从0到59的整数。

int PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o)

返回秒，从0到59的整数。

int PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o)

返回微秒，从0到999999的整数。

int PyDateTime_TIME_GET_FOLD(PyDateTime_Time *o)

返回折叠值，为整数 0 或 1。

3.6 新版功能.

PyObject *PyDateTime_TIME_GET_TZINFO(PyDateTime_Time *o)

返回 tzinfo (可以为 None)。

3.10 新版功能.

一些用来从 timedelta 对象中提取字段的宏。 参数必须是 PyDateTime_Delta 包括其子类的实例。 参数必须不为 NULL，并且类型不会被检查:

int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o)

返回天数，从-999999999到999999999的整数。

3.3 新版功能.

int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o)

返回秒数，从0到86399的整数。

3.3 新版功能.

int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o)

返回微秒数，从0到999999的整数。

3.3 新版功能.

一些便于模块实现 DB API 的宏:

PyObject *PyDateTime_FromTimestamp(PyObject *args)

返回值：新的引用。

创建并返回一个给定元组参数的新 datetime.datetime 对象，适合传给 datetime.datetime.fromtimestamp()。

PyObject *PyDate_FromTimestamp(PyObject *args)

返回值：新的引用。

创建并返回一个给定元组参数的新 datetime.date 对象，适合传给 datetime.date.fromtimestamp()。

类型注解对象

提供几种用于类型提示的内置类型。 目前存在两种类型 -- GenericAlias 和 Union。 只有 GenericAlias 会向 C 开放。

PyObject *Py_GenericAlias(PyObject *origin, PyObject *args)

Part of the Stable ABI since version 3.9.

创建一个 GenericAlias 对象。 相当于调用 Python 类 types.GenericAlias。 参数 origin 和 args 分别设置 GenericAlias 的 __origin__ 和 __args__ 属性。 origin 应该是一个 PyTypeObject*，而 args 可以是一个 PyTupleObject* 或者任意 PyObject*。 如果传递的 args 不是一个元组，则会自动构造一个单元组并将 __args__ 设置为 (args,)。 对参数进行了最小限度的检查，因此即使 origin 不是类型函数也会成功。 GenericAlias 的 __parameters__ 属性是从 __args__ 懒加载的。 如果失败，则会引发一个异常并返回 NULL。

下面是一个如何创建一个扩展类型泛型的例子:

...
static PyMethodDef my_obj_methods[] = {
    // Other methods.
    ...
    {"__class_getitem__", (PyCFunction)Py_GenericAlias, METH_O|METH_CLASS, "See PEP 585"}
    ...
}

参见

数据模型的方法 __class_getitem__() 。

3.9 新版功能.

PyTypeObject Py_GenericAliasType

Part of the Stable ABI since version 3.9.

由 Py_GenericAlias() 所返回的对象的 C 类型。等价于 Python 中的 types.GenericAlias 。

3.9 新版功能.

初始化，最终化和线程

请参阅 Python 初始化配置 。

在Python初始化之前

在一个植入了 Python 的应用程序中，Py_Initialize() 函数必须在任何其他 Python/C API 函数之前被调用；例外的只有个别函数和 全局配置变量。

在初始化Python之前，可以安全地调用以下函数：

配置函数：

PyImport_AppendInittab()

PyImport_ExtendInittab()

PyInitFrozenExtensions()

PyMem_SetAllocator()

PyMem_SetupDebugHooks()

PyObject_SetArenaAllocator()

Py_SetPath()

Py_SetProgramName()

Py_SetPythonHome()

Py_SetStandardStreamEncoding()

PySys_AddWarnOption()

PySys_AddXOption()

PySys_ResetWarnOptions()

信息函数：

Py_IsInitialized()

PyMem_GetAllocator()

PyObject_GetArenaAllocator()

Py_GetBuildInfo()

Py_GetCompiler()

Py_GetCopyright()

Py_GetPlatform()

Py_GetVersion()

工具

Py_DecodeLocale()

内存分配器：

PyMem_RawMalloc()

PyMem_RawRealloc()

PyMem_RawCalloc()

PyMem_RawFree()

注解

以下函数 不应该 在 Py_Initialize(): Py_EncodeLocale(), Py_GetPath(), Py_GetPrefix(), Py_GetExecPrefix(), Py_GetProgramFullPath(), Py_GetPythonHome(), Py_GetProgramName() 和 PyEval_InitThreads() 前调用。

全局配置变量

Python 有负责控制全局配置中不同特性和选项的变量。这些标志默认被 命令行选项。

当一个选项设置一个旗标时，该旗标的值将是设置选项的次数。 例如，-b 会将 Py_BytesWarningFlag 设为 1 而 -bb 会将 Py_BytesWarningFlag 设为 2.

int Py_BytesWarningFlag

当将 bytes 或 bytearray 与 str 比较或者将 bytes 与 int 比较时发出警告。 如果大于等于 2 则报错。

由 -b 选项设置。

int Py_DebugFlag

开启解析器调试输出（限专家使用，依赖于编译选项）。

由 -d 选项和 PYTHONDEBUG 环境变量设置。

int Py_DontWriteBytecodeFlag

如果设置为非零, Python 不会在导入源代码时尝试写入 .pyc 文件

由 -B 选项和 PYTHONDONTWRITEBYTECODE 环境变量设置。

int Py_FrozenFlag

当在 Py_GetPath() 中计算模块搜索路径时屏蔽错误消息。

由 _freeze_importlib 和 frozenmain 程序使用的私有旗标。

int Py_HashRandomizationFlag

如果 PYTHONHASHSEED 环境变量被设为非空字符串则设为 1。

如果该旗标为非零值，则读取 PYTHONHASHSEED 环境变量来初始化加密哈希种子。

int Py_IgnoreEnvironmentFlag

忽略所有 PYTHON* 环境变量，例如，已设置的 PYTHONPATH 和 PYTHONHOME。

由 -E 和 -I 选项设置。

int Py_InspectFlag

当将脚本作为第一个参数传入或是使用了 -c 选项时，则会在执行该脚本或命令后进入交互模式，即使在 sys.stdin 并非一个终端时也是如此。

由 -i 选项和 PYTHONINSPECT 环境变量设置。

int Py_InteractiveFlag

由 -i 选项设置。

int Py_IsolatedFlag

以隔离模式运行 Python. 在隔离模式下 sys.path 将不包含脚本的目录或用户的 site-packages 目录。

由 -I 选项设置。

3.4 新版功能.

int Py_LegacyWindowsFSEncodingFlag

如果该旗标为非零值，则使用 mbcs 编码和``replace`` 错误处理器，而不是 UTF-8 编码和 surrogatepass 错误处理器作用 filesystem encoding and error handler。

如果 PYTHONLEGACYWINDOWSFSENCODING 环境变量被设为非空字符串则设为 1。

更多详情请参阅 PEP 529 [https://www.python.org/dev/peps/pep-0529]。

可用性: Windows。

int Py_LegacyWindowsStdioFlag

如果该旗标为非零值，则会使用 io.FileIO 而不是 WindowsConsoleIO 作为 sys 的标准流。

如果 PYTHONLEGACYWINDOWSSTDIO 环境变量被设为非空字符串则设为 1。

有关更多详细信息，请参阅 PEP 528 [https://www.python.org/dev/peps/pep-0528]。

可用性: Windows。

int Py_NoSiteFlag

禁用 site 的导入及其所附带的基于站点对 sys.path 的操作。 如果 site 会在稍后被显式地导入也会禁用这些操作 (如果你希望触发它们则应调用 site.main())。

由 -S 选项设置。

int Py_NoUserSiteDirectory

不要将 用户 site-packages 目录 添加到 sys.path。

由 -s 和 -I 选项以及 PYTHONNOUSERSITE 环境变量设置。

int Py_OptimizeFlag

由 -O 选项和 PYTHONOPTIMIZE 环境变量设置。

int Py_QuietFlag

即使在交互模式下也不显示版权和版本信息。

由 -q 选项设置。

3.2 新版功能.

int Py_UnbufferedStdioFlag

强制 stdout 和 stderr 流不带缓冲。

由 -u 选项和 PYTHONUNBUFFERED 环境变量设置。

int Py_VerboseFlag

每次初始化模块时打印一条消息，显示加载模块的位置（文件名或内置模块）。 如果大于或等于 2，则为搜索模块时检查的每个文件打印一条消息。 此外还会在退出时提供模块清理信息。

由 -v 选项和 PYTHONVERBOSE 环境变量设置。

初始化和最终化解释器

void Py_Initialize()

Part of the Stable ABI.

初始化 Python 解释器。 在嵌入 Python 的应用程序中，它应当在使用任何其他 Python/C API 函数之前被调用；请参阅 在 Python 初始化之前 了解少数的例外情况。

这将初始化已加载模块表 (sys.modules)，并创建基本模块 builtins、__main__ 和 sys。 它还会初始化模块搜索路径 (sys.path)。 它不会设置 sys.argv；如有需要请使用 PySys_SetArgvEx()。 当第二次调用时 (在未事先调用 Py_FinalizeEx() 的情况下) 将不会执行任何操作。 它没有返回值；如果初始化失败则会发生致命错误。

注解

在 Windows 上，将控制台模式从 O_TEXT 改为 O_BINARY，这还将影响使用 C 运行时的非 Python 的控制台使用。

void Py_InitializeEx(int initsigs)

Part of the Stable ABI.

如果 initsigs 为 1 则该函数的工作方式与 Py_Initialize() 类似。 如果 initsigs 为 0，它将跳过信号处理器的初始化注册，这在嵌入 Python 时可能会很有用处。

int Py_IsInitialized()

Part of the Stable ABI.

如果 Python 解释器已初始化，则返回真值（非零）；否则返回假值（零）。 在调用 Py_FinalizeEx() 之后，此函数将返回假值直到 Py_Initialize() 再次被调用。

int Py_FinalizeEx()

Part of the Stable ABI since version 3.6.

撤销 Py_Initialize() 所做的所有初始化操作和后续对 Python/C API 函数的使用，并销毁自上次调用 Py_Initialize() 以来创建但尚未销毁的所有子解释器（参见下文 Py_NewInterpreter() 一节)。 在理想情况下，这会释放 Python 解释器分配的所有内存。 当第二次调用时（在未再次调用 Py_Initialize() 的情况下），这将不执行任何操作。 正常情况下返回值是 0。 如果在最终化（刷新缓冲数据）过程中出现错误，则返回 -1。

提供此函数的原因有很多。嵌入应用程序可能希望重新启动Python，而不必重新启动应用程序本身。从动态可加载库（或DLL）加载Python解释器的应用程序可能希望在卸载DLL之前释放Python分配的所有内存。在搜索应用程序内存泄漏的过程中，开发人员可能希望在退出应用程序之前释放Python分配的所有内存。

Bugs and caveats: The destruction of modules and objects in modules is done in random order; this may cause destructors (__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. 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 Py_Initialize() and Py_FinalizeEx() more than once.

引发一个不带参数的 审计事件 cpython._PySys_ClearAuditHooks。

3.6 新版功能.

void Py_Finalize()

Part of the Stable ABI.

这是一个不考虑返回值的 Py_FinalizeEx() 的向下兼容版本。

进程级参数

int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)

如果要调用该函数，应当在 Py_Initialize() 之前调用。 它指定了标准 IO 使用的编码格式和错误处理方式，其含义与 str.encode() 中的相同。

它覆盖了 PYTHONIOENCODING 的值，并允许嵌入代码以便在环境变量不起作用时控制 IO 编码格式。

encoding 和/或 errors 可以为 NULL 以使用 PYTHONIOENCODING 和/或默认值（取决于其他设置）。

请注意无论是否有此设置（或任何其他设置），sys.stderr 都会使用 "backslashreplace" 错误处理器。

如果调用了 Py_FinalizeEx()，则需要再次调用该函数以便影响对 Py_Initialize() 的后续调用。

成功时返回 0，出错时返回非零值（例如在解释器已被初始化后再调用）。

3.4 新版功能.

void Py_SetProgramName(const wchar_t *name)

Part of the Stable ABI.

如果要调用该函数，应当在首次调用 Py_Initialize() 之前调用它。 它将告诉解释器程序的 main() 函数的 argv[0] 参数的值（转换为宽字符）。 Py_GetPath() 和下面的某些其他函数会使用它在相对于解释器的位置上查找可执行文件的 Python 运行时库。 默认值是 'python'。 参数应当指向静态存储中的一个以零值结束的宽字符串，其内容在程序执行期间不会发生改变。 Python 解释器中的任何代码都不会改变该存储的内容。

使用 Py_DecodeLocale() 来解码字节串以得到一个 wchar_* 字符串。

wchar *Py_GetProgramName()

Part of the Stable ABI.

返回用 Py_SetProgramName() 设置的程序名称，或默认的名称。 返回的字符串指向静态存储；调用者不应修改其值。

此函数不应在 Py_Initialize() 之前被调用，否则将返回 NULL。

在 3.10 版更改: 现在如果它在 Py_Initialize() 之前被调用将返回 NULL。

wchar_t *Py_GetPrefix()

Part of the Stable ABI.

返回针对已安装的独立于平台文件的 prefix。 这是通过基于使用 Py_SetProgramName() 设置的程序名称和某些环境变量所派生的一系列复杂规则获得的；举例来说，如果程序名称为 '/usr/local/bin/python'，则 prefix 为 '/usr/local'。 返回的字符串将指向静态存储；调用方不应修改其值。 这对应于最高层级 Makefile 中的 prefix 变量以及在编译时传给 configure 脚本的 --prefix 参数。 该值将以 sys.prefix 的名称供 Python 代码使用。 它仅适用于 Unix。 另请参见下一个函数。

此函数不应在 Py_Initialize() 之前被调用，否则将返回 NULL。

在 3.10 版更改: 现在如果它在 Py_Initialize() 之前被调用将返回 NULL。

wchar_t *Py_GetExecPrefix()

Part of the Stable ABI.

返回针对已安装的 依赖于 平台文件的 exec-prefix。 这是通过基于使用 Py_SetProgramName() 设置的程序名称和某些环境变量所派生的一系列复杂规则获得的；举例来说，如果程序名称为 '/usr/local/bin/python'，则 exec-prefix 为 '/usr/local'。 返回的字符串将指向静态存储；调用方不应修改其值。 这对应于最高层级 Makefile 中的 exec_prefix 变量以及在编译时传给 configure 脚本的 --exec-prefix 参数。 该值将以 sys.exec_prefix 的名称供 Python 代码使用。 它仅适用于 Unix。

背景：当依赖于平台的文件（如可执行文件和共享库）是安装于不同的目录树中的时候 exec-prefix 将会不同于 prefix。 在典型的安装中，依赖于平台的文件可能安装于 the /usr/local/plat 子目录树而独立于平台的文件可能安装于 /usr/local。

总而言之，平台是一组硬件和软件资源的组合，例如所有运行 Solaris 2.x 操作系统的 Sparc 机器会被视为相同平台，但运行 Solaris 2.x 的 Intel 机器是另一种平台，而运行 Linux 的 Intel 机器又是另一种平台。 相同操作系统的不同主要发布版通常也会构成不同的平台。 非 Unix 操作系统的情况又有所不同；这类系统上的安装策略差别巨大因此 prefix 和 exec-prefix 是没有意义的，并将被设为空字符串。 请注意已编译的 Python 字节码是独立于平台的（但并不独立于它们编译时所使用的 Python 版本！）

系统管理员知道如何配置 mount 或 automount 程序以在平台间共享 /usr/local 而让 /usr/local/plat 成为针对不同平台的不同文件系统。

此函数不应在 Py_Initialize() 之前被调用，否则将返回 NULL。

在 3.10 版更改: 现在如果它在 Py_Initialize() 之前被调用将返回 NULL。

wchar_t *Py_GetProgramFullPath()

Part of the Stable ABI.

返回 Python 可执行文件的完整程序名称；这是作为根据程序名称（由上述 Py_SetProgramName() 设置）派生默认模块搜索路径的附带影响计算得出的。 返回的字符串将指向静态存储；调用方不应修改其值。 该值将以 sys.executable 的名称供 Python 代码使用。

此函数不应在 Py_Initialize() 之前被调用，否则将返回 NULL。

在 3.10 版更改: 现在如果它在 Py_Initialize() 之前被调用将返回 NULL。

wchar_t *Py_GetPath()

Part of the Stable ABI.

返回默认模块搜索路径；这是根据程序名称（由上述 Py_SetProgramName() 设置）和某些环境变量计算得出的。 返回的字符串由一系列由依赖于平台的分隔符分开的目录名称组成。 分隔符在 Unix 和 macOS 上为 ':' 而在 Windows 上为 ';'。 返回的字符串将指向静态存储；调用方不应修改其值。 列表 sys.path 将在解释器启动时使用该值来初始化；它可以在随后被修改（并且通常都会被修改）以变更加载模块的搜索路径。

此函数不应在 Py_Initialize() 之前被调用，否则将返回 NULL。

在 3.10 版更改: 现在如果它在 Py_Initialize() 之前被调用将返回 NULL。

void Py_SetPath(const wchar_t*)

Part of the Stable ABI since version 3.7.

设置默认的模块搜索路径。 如果此函数在 Py_Initialize() 之前被调用，则 Py_GetPath() 将不会尝试计算默认的搜索路径而是改用已提供的路径。 这适用于由一个完全知晓所有模块的位置的应用程序来嵌入 Python 的情况。 路径组件应当由平台专属的分隔符来分隔，在 Unix 和 macOS 上是 ':' 而在 Windows 上则是 ';'。

这也将导致 sys.executable 被设为程序的完整路径 (参见 Py_GetProgramFullPath()) 而 sys.prefix 和 sys.exec_prefix 变为空值。 如果在调用 Py_Initialize() 之后有需要则应由调用方来修改它们。

使用 Py_DecodeLocale() 来解码字节串以得到一个 wchar_* 字符串。

路径参数会在内部被复制，使调用方可以在调用结束后释放它。

在 3.8 版更改: 现在 sys.executable 将使用程序的完整路径，而不是程序文件名。

const char *Py_GetVersion()

Part of the Stable ABI.

返回 Python 解释器的版本。 这将为如下形式的字符串

"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"

第一个单词（到第一个空格符为止）是当前的 Python 版本；前面的字符是以点号分隔的主要和次要版本号。 返回的字符串将指向静态存储；调用方不应修改其值。 该值将以 sys.version 的名称供 Python 代码使用。

const char *Py_GetPlatform()

Part of the Stable ABI.

返回当前平台的平台标识符。 在 Unix 上，这将以操作系统的“官方”名称为基础，转换为小写形式，再加上主版本号；例如，对于 Solaris 2.x，或称 SunOS 5.x，该值将为 'sunos5'。 在 macOS 上，它将为 'darwin'。 在 Windows 上它将为 'win'。 返回的字符串指向静态存储；调用方不应修改其值。 Python 代码可通过 sys.platform 获取该值。

const char *Py_GetCopyright()

Part of the Stable ABI.

返回当前 Python 版本的官方版权字符串，例如

'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'

返回的字符串指向静态存储；调用者不应修改其值。 Python 代码可通过 sys.copyright 获取该值。

const char *Py_GetCompiler()

Part of the Stable ABI.

返回用于编译当前 Python 版本的编译器指令，为带方括号的形式，例如:

"[GCC 2.7.2.2]"

返回的字符串指向静态存储；调用者不应修改其值。 Python 代码可以从变量 sys.version 中获取该值。

const char *Py_GetBuildInfo()

Part of the Stable ABI.

返回有关当前Python解释器实例的序列号和构建日期和时间的信息，例如：

"#67, Aug  1 1997, 22:34:28"

返回的字符串指向静态存储；调用者不应修改其值。 Python 代码可以从变量 sys.version 中获取该值。

void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)

Part of the Stable ABI.

根据 argc 和 argv 设置 sys.argv。 这些形参与传给程序的 main() 函数的类似，区别在于第一项应当指向要执行的脚本文件而不是 Python 解释器对应的可执行文件。 如果没有要运行的脚本，则 argv 中的第一项可以为空字符串。 如果此函数无法初始化 sys.argv，则将使用 Py_FatalError() 发出严重情况信号。

如果 updatepath 为零，此函数将完成操作。 如果 updatepath 为非零值，则此函数还将根据以下算法修改 sys.path:

如果在 argv[0] 中传入一个现有脚本，则脚本所在目录的绝对路径将被添加到 sys.path 的开头。

在其他情况下 (也就是说，如果 argc 为 0 或 argv[0] 未指向现有文件名)，则将在 sys.path 的开头添加一个空字符串，这等价于添加当前工作目录 (".")。

使用 Py_DecodeLocale() 来解码字节串以得到一个 wchar_* 字符串。

注解

建议在出于执行单个脚本以外的目的嵌入 Python 解释器的应用程序传入 0 作为 updatepath，并在需要时更新 sys.path 本身。 参见 CVE-2008-5983 [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983]。

在 3.1.3 之前的版本中，你可以通过在调用 PySys_SetArgv() 之后手动弹出第一个 sys.path 元素，例如使用:

PyRun_SimpleString("import sys; sys.path.pop(0)\n");

3.1.3 新版功能.

void PySys_SetArgv(int argc, wchar_t **argv)

Part of the Stable ABI.

此函数相当于 PySys_SetArgvEx() 设置了 updatepath 为 1 除非 python 解释器启动时附带了 -I。

使用 Py_DecodeLocale() 来解码字节串以得到一个 wchar_* 字符串。

在 3.4 版更改: updatepath 值依赖于 -I。

void Py_SetPythonHome(const wchar_t *home)

Part of the Stable ABI.

设置默认的 "home" 目录，也就是标准 Python 库所在的位置。 请参阅 PYTHONHOME 了解该参数字符串的含义。

此参数应当指向静态存储中一个以零值结束的字符串，其内容在程序执行期间将保持不变。 Python 解释器中的代码绝不会修改此存储中的内容。

使用 Py_DecodeLocale() 来解码字节串以得到一个 wchar_* 字符串。

wchar_t *Py_GetPythonHome()

Part of the Stable ABI.

返回默认的 "home"，就是由之前对 Py_SetPythonHome() 的调用所设置的值，或者在设置了 PYTHONHOME 环境变量的情况下该环境变量的值。

此函数不应在 Py_Initialize() 之前被调用，否则将返回 NULL。

在 3.10 版更改: 现在如果它在 Py_Initialize() 之前被调用将返回 NULL。

线程状态和全局解释器锁

Python 解释器不是完全线程安全的。 为了支持多线程的 Python 程序，设置了一个全局锁，称为 global interpreter lock 或 GIL，当前线程必须在持有它之后才能安全地访问 Python 对象。 如果没有这个锁，即使最简单的操作也可能在多线程的程序中导致问题：例如，当两个线程同时增加相同对象的引用计数时，引用计数可能最终只增加了一次而不是两次。

因此，规则要求只有获得 GIL 的线程才能在 Python对象上执行操作或调用 Python/C API 函数。 为了模拟并发执行，解释器会定期尝试切换线程 (参见 sys.setswitchinterval())。 锁也会在读写文件等可能造成阻塞的 I/O 操作时释放，以便其他 Python 线程可以同时运行。

Python 解释器会在一个名为 PyThreadState 的数据结构体中保存一些线程专属的记录信息。 还有一个全局变量指向当前的 PyThreadState: 它可以使用 PyThreadState_Get() 来获取。

从扩展扩展代码中释放 GIL

大多数操作 GIL 的扩展代码具有以下简单结构：

Save the thread state in a local variable.
Release the global interpreter lock.
... Do some blocking I/O operation ...
Reacquire the global interpreter lock.
Restore the thread state from the local variable.

这是如此常用因此增加了一对宏来简化它:

Py_BEGIN_ALLOW_THREADS
... Do some blocking I/O operation ...
Py_END_ALLOW_THREADS

Py_BEGIN_ALLOW_THREADS 宏将打开一个新块并声明一个隐藏的局部变量；Py_END_ALLOW_THREADS 宏将关闭这个块。

上面的代码块可扩展为下面的代码:

PyThreadState *_save;

_save = PyEval_SaveThread();
... Do some blocking I/O operation ...
PyEval_RestoreThread(_save);

这些函数的工作原理如下：全局解释器锁被用来保护指向当前线程状态的指针。 当释放锁并保存线程状态时，必须在锁被释放之前获取当前线程状态指针 （因为另一个线程可以立即获取锁并将自己的线程状态存储到全局变量中）。 相应地，当获取锁并恢复线程状态时，必须在存储线程状态指针之前先获取锁。

注解

调用系统 I/O 函数是释放 GIL 的最常见用例，但它在调用不需要访问 Python 对象的长期运行计算，比如针对内存缓冲区进行操作的压缩或加密函数之前也很有用。 举例来说，在对数据执行压缩或哈希操作时标准 zlib 和 hashlib 模块就会释放 GIL。

非Python创建的线程

当使用专门的 Python API（如 threading 模块）创建线程时，会自动关联一个线程状态因而上面显示的代码是正确的。 但是，如果线程是用 C 创建的（例如由具有自己的线程管理的第三方库创建），它们就不持有 GIL 也没有对应的线程状态结构体。

如果你需要从这些线程调用 Python 代码（这通常会是上述第三方库所提供的回调 API 的一部分），你必须首先通过创建线程状态数据结构体向解释器注册这些线程，然后获取 GIL，最后存储它们的线程状态指针，这样你才能开始使用 Python/C API。 完成以上步骤后，你应当重置线程状态指针，释放 GIL，最后释放线程状态数据结构体。

PyGILState_Ensure() 和 PyGILState_Release() 函数会自动完成上述的所有操作。 从 C 线程调用到 Python 的典型方式如下:

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);

请注意 PyGILState_* 函数会假定只有一个全局解释器（由 Py_Initialize() 自动创建）。 Python 支持创建额外的解释器（使用 Py_NewInterpreter() 创建），但不支持混合使用多个解释器和 PyGILState_* API。

有关 fork() 的注意事项

有关线程的另一个需要注意的重要问题是它们在面对 C fork() 调用时的行为。 在大多数支持 fork() 的系统中，当一个进程执行 fork 之后将只有发出 fork 的线程存在。 这对需要如何处理锁以及CPython 的运行时内所有的存储状态都会有实质性的影响。

The fact that only the "current" thread remains means any locks held by other threads will never be released. Python solves this for os.fork() by acquiring the locks it uses internally before the fork, and releasing them afterwards. In addition, it resets any 锁对象 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 pthread_atfork() would need to be used to accomplish the same thing. Additionally, when extending or embedding Python, calling fork() directly rather than through 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. PyOS_AfterFork_Child() tries to reset the necessary locks, but is not always able to.

所有其他线程都将结束这一事实也意味着 CPython 的运行时状态必须妥善清理，os.fork() 就是这样做的。 这意味着最终化归属于当前解释器的所有其他 PyThreadState 对象以及所有其他 PyInterpreterState 对象。 由于这一点以及 "main" 解释器 的特殊性质，fork() 应当只在该解释器 的 "main" 线程中被调用，而 CPython 全局运行时最初就是在该线程中初始化的。 只有当 exec() 将随后立即被调用的情况是唯一的例外。

高阶 API

这些是在编写 C 扩展代码或在嵌入 Python 解释器时最常用的类型和函数：

type PyInterpreterState

Part of the Limited API (as an opaque struct).

该数据结构代表多个合作线程所共享的状态。 属于同一解释器的线程将共享其模块管理以及其他一些内部条目。 该结构体中不包含公有成员。

最初归属于不同解释器的线程不会共享任何东西，但进程状态如可用内存、打开的文件描述符等等除外。 全局解释器锁也会被所有线程共享，无论它们归属于哪个解释器。

type PyThreadState

Part of the Limited API (as an opaque struct).

This data structure represents the state of a single thread. The only public data member is interp (PyInterpreterState*), which points to this thread's interpreter state.

void PyEval_InitThreads()

Part of the Stable ABI.

不执行任何操作的已弃用函数。

在 Python 3.6 及更老的版本中，此函数会在 GIL 不存在时创建它。

在 3.9 版更改: 此函数现在不执行任何操作。

在 3.7 版更改: 该函数现在由 Py_Initialize() 调用，因此你无需再自行调用它。

在 3.2 版更改: 此函数已不再被允许在 Py_Initialize() 之前调用。

Deprecated since version 3.9, will be removed in version 3.11.

int PyEval_ThreadsInitialized()

Part of the Stable ABI.

如果 PyEval_InitThreads() 已经被调用则返回非零值。 此函数可在不持有 GIL 的情况下被调用，因而可被用来避免在单线程运行时对加锁 API 的调用。

在 3.7 版更改: 现在 GIL 将由 Py_Initialize() 来初始化。

Deprecated since version 3.9, will be removed in version 3.11.

PyThreadState *PyEval_SaveThread()

Part of the Stable ABI.

释放全局解释器锁 (如果已创建) 并将线程状态重置为 NULL，返回之前的线程状态 (不为 NULL)。 如果锁已被创建，则当前线程必须已获取到它。

void PyEval_RestoreThread(PyThreadState *tstate)

Part of the Stable ABI.

获取全局解释器锁 (如果已创建) 并将线程状态设为 tstate，它必须不为 NULL。 如果锁已被创建，则当前线程必须尚未获取它，否则将发生死锁。

注解

当运行时正在最终化时从某个线程调用此函数将终结该线程，即使线程不是由 Python 创建的。 你可以在调用此函数之前使用 _Py_IsFinalizing() 或 sys.is_finalizing() 来检查解释器是否还处于最终化过程中以避免不必要的终结。

PyThreadState *PyThreadState_Get()

Part of the Stable ABI.

返回当前线程状态。 全局解释器锁必须被持有。 在当前状态为 NULL 时，这将发出一个致命错误 (这样调用方将无须检查是否为 NULL)。

PyThreadState *PyThreadState_Swap(PyThreadState *tstate)

Part of the Stable ABI.

交换当前线程状态与由参数 tstate (可能为 NULL) 给出的线程状态。 全局解释器锁必须被持有且未被释放。

下列函数使用线程级本地存储，并且不能兼容子解释器：

PyGILState_STATE PyGILState_Ensure()

Part of the Stable ABI.

确保当前线程已准备好调用 Python C API 而不管 Python 或全局解释器锁的当前状态如何。 只要每次调用都与 PyGILState_Release() 的调用相匹配就可以通过线程调用此函数任意多次。 一般来说，只要线程状态恢复到 Release() 之前的状态就可以在 PyGILState_Ensure() 和 PyGILState_Release() 调用之间使用其他与线程相关的 API。 例如，可以正常使用 Py_BEGIN_ALLOW_THREADS 和 Py_END_ALLOW_THREADS 宏。

返回值是一个当 PyGILState_Ensure() 被调用时的线程状态的不透明“句柄”，并且必须被传递给 PyGILState_Release() 以确保 Python 处于相同状态。 虽然允许递归调用，但这些句柄 不能 被共享 —— 每次对 PyGILState_Ensure() 的单独调用都必须保存其对 PyGILState_Release() 的调用的句柄。

当该函数返回时，当前线程将持有 GIL 并能够调用任意 Python 代码。 执行失败将导致致命级错误。

注解

当运行时正在最终化时从某个线程调用此函数将终结该线程，即使线程不是由 Python 创建的。 你可以在调用此函数之前使用 _Py_IsFinalizing() 或 sys.is_finalizing() 来检查解释器是否还处于最终化过程中以避免不必要的终结。

void PyGILState_Release(PyGILState_STATE)

Part of the Stable ABI.

释放之前获取的任何资源。 在此调用之后，Python 的状态将与其在对相应 PyGILState_Ensure() 调用之前的一样（但是通常此状态对调用方来说将是未知的，对 GILState API 的使用也是如此）。

对 PyGILState_Ensure() 的每次调用都必须与在同一线程上对 PyGILState_Release() 的调用相匹配。

PyThreadState *PyGILState_GetThisThreadState()

Part of the Stable ABI.

获取此线程的当前线程状态。 如果当前线程上没有使用过 GILState API 则可以返回 NULL。 请注意主线程总是会有这样一个线程状态，即使没有在主线程上执行过自动线程状态调用。 这主要是一个辅助/诊断函数。

int PyGILState_Check()

如果当前线程持有 GIL 则返回 1 否则返回 0。 此函数可以随时从任何线程调用。 只有当它的 Python 线程状态已经初始化并且当前持有 GIL 时它才会返回 1。 这主要是一个辅助/诊断函数。 例如在回调上下文或内存分配函数中会很有用处，当知道 GIL 被锁定时可以允许调用方执行敏感的操作或是在其他情况下做出不同的行为。

3.4 新版功能.

以下的宏被使用时通常不带末尾分号；请在 Python 源代码发布包中查看示例用法。

Py_BEGIN_ALLOW_THREADS

Part of the Stable ABI.

此宏会扩展为 { PyThreadState *_save; _save = PyEval_SaveThread();。 请注意它包含一个开头花括号；它必须与后面的 Py_END_ALLOW_THREADS 宏匹配。 有关此宏的进一步讨论请参阅上文。

Py_END_ALLOW_THREADS

Part of the Stable ABI.

此宏扩展为 PyEval_RestoreThread(_save); }。 注意它包含一个右花括号；它必须与之前的 Py_BEGIN_ALLOW_THREADS 宏匹配。 请参阅上文以进一步讨论此宏。

Py_BLOCK_THREADS

Part of the Stable ABI.

这个宏扩展为 PyEval_RestoreThread(_save);: 它等价于没有关闭花括号的 Py_END_ALLOW_THREADS。

Py_UNBLOCK_THREADS

Part of the Stable ABI.

这个宏扩展为 _save = PyEval_SaveThread();: 它等价于没有开始花括号和变量声明的 Py_BEGIN_ALLOW_THREADS。

底层级 API

下列所有函数都必须在 Py_Initialize() 之后被调用。

在 3.7 版更改: Py_Initialize() 现在会初始化 GIL。

PyInterpreterState *PyInterpreterState_New()

Part of the Stable ABI.

创建一个新的解释器状态对象。 不需要持有全局解释器锁，但如果有必要序列化对此函数的调用则可能会持有。

引发一个不带参数的 审计事件 cpython.PyInterpreterState_New。

void PyInterpreterState_Clear(PyInterpreterState *interp)

Part of the Stable ABI.

重置解释器状态对象中的所有信息。 必须持有全局解释器锁。

引发一个不带参数的 审计事件 cpython.PyInterpreterState_Clear。

void PyInterpreterState_Delete(PyInterpreterState *interp)

Part of the Stable ABI.

销毁解释器状态对象。 不需要持有全局解释器锁。 解释器状态必须使用之前对 PyInterpreterState_Clear() 的调用来重置。

PyThreadState *PyThreadState_New(PyInterpreterState *interp)

Part of the Stable ABI.

创建属于给定解释器对象的新线程状态对象。全局解释器锁不需要保持，但如果需要序列化对此函数的调用，则可以保持。

void PyThreadState_Clear(PyThreadState *tstate)

Part of the Stable ABI.

重置线程状态对象中的所有信息。 必须持有全局解释器锁。

在 3.9 版更改: 此函数现在会调用 PyThreadState.on_delete 回调。 在之前版本中，此操作是发生在 PyThreadState_Delete() 中的。

void PyThreadState_Delete(PyThreadState *tstate)

Part of the Stable ABI.

销毁线程状态对象。 不需要持有全局解释器锁。 线程状态必须使用之前对 PyThreadState_Clear() 的调用来重置。

void PyThreadState_DeleteCurrent(void)

销毁当前线程状态并释放全局解释器锁。 与 PyThreadState_Delete() 类似，不需要持有全局解释器锁。 线程状态必须已使用之前对 PyThreadState_Clear() 调用来重置。

PyFrameObject *PyThreadState_GetFrame(PyThreadState *tstate)

Part of the Stable ABI since version 3.10.

获取 Python 线程状态 tstate 的当前帧。

返回一个 strong reference。 如果没有当前执行的帧则返回 NULL。

另请参阅 PyEval_GetFrame()。

tstate 必须不为 NULL。

3.9 新版功能.

uint64_t PyThreadState_GetID(PyThreadState *tstate)

Part of the Stable ABI since version 3.10.

获取 Python 线程状态 tstate 的唯一线程状态标识符。

tstate 必须不为 NULL。

3.9 新版功能.

PyInterpreterState *PyThreadState_GetInterpreter(PyThreadState *tstate)

Part of the Stable ABI since version 3.10.

获取 Python 线程状态 tstate 对应的解释器。

tstate 必须不为 NULL。

3.9 新版功能.

PyInterpreterState *PyInterpreterState_Get(void)

Part of the Stable ABI since version 3.9.

获取当前解释器。

如果不存在当前 Python 线程状态或不存在当前解释器则将发出致命级错误信号。 它无法返回 NULL。

调用时必须携带GIL。

3.9 新版功能.

int64_t PyInterpreterState_GetID(PyInterpreterState *interp)

Part of the Stable ABI since version 3.7.

返回解释器的唯一 ID。 如果执行过程中发生任何错误则将返回 -1 并设置错误。

调用时必须携带GIL。

3.7 新版功能.

PyObject *PyInterpreterState_GetDict(PyInterpreterState *interp)

Part of the Stable ABI since version 3.8.

返回一个存储解释器专属数据的字典。 如果此函数返回 NULL 则没有任何异常被引发并且调用方应当将解释器专属字典视为不可用。

这不是 PyModule_GetState() 的替代，扩展仍应使用它来存储解释器专属的状态信息。

3.8 新版功能.

typedef PyObject *(*_PyFrameEvalFunction)(PyThreadState *tstate, PyFrameObject *frame, int throwflag)

帧评估函数的类型

throwflag 形参将由生成器的 throw() 方法来使用：如为非零值，则处理当前异常。

在 3.9 版更改: 此函数现在可接受一个 tstate 形参。

_PyFrameEvalFunction _PyInterpreterState_GetEvalFrameFunc(PyInterpreterState *interp)

获取帧评估函数。

请参阅 PEP 523 [https://www.python.org/dev/peps/pep-0523] "Adding a frame evaluation API to CPython"。

3.9 新版功能.

void _PyInterpreterState_SetEvalFrameFunc(PyInterpreterState *interp, _PyFrameEvalFunction eval_frame)

设置帧评估函数。

请参阅 PEP 523 [https://www.python.org/dev/peps/pep-0523] "Adding a frame evaluation API to CPython"。

3.9 新版功能.

PyObject *PyThreadState_GetDict()

返回值：借入的引用。 Part of the Stable ABI.

返回一个扩展可以在其中存储线程专属状态信息的字典。 每个扩展都应当使用一个独有的键用来在该字典中存储状态。 在没有可用的当前线程状态时也可以调用此函数。 如果此函数返回 NULL，则还没有任何异常被引发并且调用方应当假定没有可用的当前线程状态。

int PyThreadState_SetAsyncExc(unsigned long id, PyObject *exc)

Part of the Stable 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 the GIL held. 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 NULL, the pending exception (if any) for the thread is cleared. This raises no exceptions.

在 3.7 版更改: id 形参的类型已从 long 变为 unsigned long。

void PyEval_AcquireThread(PyThreadState *tstate)

Part of the Stable ABI.

获取全局解释器锁并将当前线程状态设为 tstate，它必须不为 NULL。 锁必须在此之前已被创建。 如果该线程已获取锁，则会发生死锁。

注解

当运行时正在最终化时从某个线程调用此函数将终结该线程，即使线程不是由 Python 创建的。 你可以在调用此函数之前使用 _Py_IsFinalizing() 或 sys.is_finalizing() 来检查解释器是否还处于最终化过程中以避免不必要的终结。

在 3.8 版更改: 已被更新为与 PyEval_RestoreThread(), Py_END_ALLOW_THREADS() 和 PyGILState_Ensure() 保持一致，如果在解释器正在最终化时被调用则会终结当前线程。

PyEval_RestoreThread() 是一个始终可用的（即使线程尚未初始化）更高层级函数。

void PyEval_ReleaseThread(PyThreadState *tstate)

Part of the Stable ABI.

将当前线程状态重置为 NULL 并释放全局解释器锁。 在此之前锁必须已被创建并且必须由当前的线程所持有。 tstate 参数必须不为 NULL，该参数仅被用于检查它是否代表当前线程状态 --- 如果不是，则会报告一个致命级错误。

PyEval_SaveThread() 是一个始终可用的（即使线程尚未初始化）更高层级函数。

void PyEval_AcquireLock()

Part of the Stable ABI.

获取全局解释器锁。锁必须在此之前已被创建。 如果该线程已经拥有锁，则会出现死锁。

3.2 版后已移除: 此函数不会更新当前线程状态。 请改用 PyEval_RestoreThread() 或 PyEval_AcquireThread()。

注解

当运行时正在最终化时从某个线程调用此函数将终结该线程，即使线程不是由 Python 创建的。 你可以在调用此函数之前使用 _Py_IsFinalizing() 或 sys.is_finalizing() 来检查解释器是否还处于最终化过程中以避免不必要的终结。

在 3.8 版更改: 已被更新为与 PyEval_RestoreThread(), Py_END_ALLOW_THREADS() 和 PyGILState_Ensure() 保持一致，如果在解释器正在最终化时被调用则会终结当前线程。

void PyEval_ReleaseLock()

Part of the Stable ABI.

释放全局解释器锁。 锁必须在此之前已被创建。

3.2 版后已移除: 此函数不会更新当前线程状态。 请改用 PyEval_SaveThread() 或 PyEval_ReleaseThread()。

子解释器支持

虽然在大多数用例中，你都只会嵌入一个单独的 Python 解释器，但某些场景需要你在同一个进程甚至同一个线程中创建多个独立的解释器。 子解释器让你能够做到这一点。

“主”解释器是在运行时初始化时创建的第一个解释器。 它通常是一个进程中唯一的 Python 解释器。 与子解释器不同，主解释器具有唯一的进程全局责任比如信号处理等。 它还负责在运行时初始化期间的执行并且通常还是运行时最终化期间的活动解释器。 PyInterpreterState_Main() 函数将返回一个指向其状态的指针。

你可以使用 PyThreadState_Swap() 函数在子解释器之间进行切换。 你可以使用下列函数来创建和销毁它们：

PyThreadState *Py_NewInterpreter()

Part of the Stable ABI.

新建一个子解释器。 这是一个 (几乎) 完全隔离的 Python 代码执行环境。 特别需要注意，新的子解释器具有全部已导入模块的隔离的、独立的版本，包括基本模块 builtins, __main__ 和 sys 等。 已加载模块表 (sys.modules) 和模块搜索路径 (sys.path) 也是隔离的。 新环境没有 sys.argv 变量。 它具有新的标准 I/O 流文件对象 sys.stdin, sys.stdout 和 sys.stderr (不过这些对象都指向相同的底层文件描述符)。

The return value points to the first thread state created in the new sub-interpreter. This thread state is made in the current thread state. Note that no actual thread is created; see the discussion of thread states below. If creation of the new interpreter is unsuccessful, NULL is returned; no exception is set since the exception state is stored in the current thread state and there may not be a current thread state. (Like all other Python/C API functions, the global interpreter lock must be held before calling this function and is still held when it returns; however, unlike most other Python/C API functions, there needn't be a current thread state on entry.)

扩展模块将以如下方式在（子）解释器之间共享：

对于使用多阶段初始化的模块 ，例如 PyModule_FromDefAndSpec()，将为每个解释器创建并初始化一个单独的模块对象。 只有 C 层级的静态和全局变量能在这些模块 对象之间共享。

对于使用单阶段初始化的模块，例如 PyModule_Create()，当特定扩展被首次导入时，它将被正常初始化，并会保存其模块字典的一个 (浅) 拷贝。 当同一扩展被另一个 (子) 解释器导入时，将初始化一个新模块并填充该拷贝的内容；扩展的 init 函数不会被调用。 因此模块字典中的对象最终会被 (子) 解释器所共享，这可能会导致预期之外的行为 (参见下文的 Bugs and caveats)。

请注意这不同于在调用 Py_FinalizeEx() 和 Py_Initialize() 完全重新初始化解释器之后导入扩展时所发生的情况；对于那种情况，扩展的 initmodule 函数 会被 再次调用。 与多阶段初始化一样，这意味着只有 C 层级的静态和全局变量能在这些模块之间共享。

void Py_EndInterpreter(PyThreadState *tstate)

Part of the Stable ABI.

Destroy the (sub-)interpreter represented by the given thread state. The given thread state must be the current thread state. See the discussion of thread states below. When the call returns, the current thread state is NULL. All thread states associated with this interpreter are destroyed. (The global interpreter lock must be held before calling this function and is still held when it returns.) Py_FinalizeEx() will destroy all sub-interpreters that haven't been explicitly destroyed at that point.

错误和警告

由于子解释器 (以及主解释器) 都是同一个进程的组成部分，它们之间的隔离状态并非完美 --- 举例来说，使用低层级的文件操作如 os.close() 时它们可能 (无意或恶意地) 影响它们各自打开的文件。 由于 (子) 解释器之间共享扩展的方式，某些扩展可能无法正常工作；在使用单阶段初始化或者 (静态) 全局变量时尤其如此。 在一个子解释器中创建的对象有可能被插入到另一个 (子) 解释器的命名空间中；这种情况应当尽可能地避免。

应当特别注意避免在子解释器之间共享用户自定义的函数、方法、实例或类，因为由这些对象执行的导入 操作可能会影响错误的已加载模块的 (子) 解释器的字典。 同样重要的一点是应当避免共享可被上述对象访问的对象 。

还要注意的一点是将此功能与 PyGILState_* API 结合使用是很微妙的，因为这些 API 会假定 Python线程状态与操作系统级线程之间存在双向投影关系，而子解释器的存在打破了这一假定。 强烈建议你不要在一对互相匹配的 PyGILState_Ensure() 和 PyGILState_Release() 调用之间切换子解释器。 此外，使用这些 API 以允许从非 Python 创建的线程调用 Python 代码的扩展 (如 ctypes) 在使用子解释器时很可能会出现问题。

异步通知

提供了一种向主解释器线程发送异步通知的机制。 这些通知将采用函数指针和空指针参数的形式。

int Py_AddPendingCall(int (*func)(void*), void *arg, )

Part of the Stable ABI.

将一个函数加入从主解释器线程调用的计划任务。 成功时，将返回 0 并将 func 加入要被主线程调用的等待队列。 失败时，将返回 -1 但不会设置任何异常。

当成功加入队列后，func 将 最终 附带参数 arg 被主解释器线程调用。 对于正常运行的 Python 代码来说它将被异步地调用，但要同时满足以下两个条件：

位于 bytecode 的边界上；

主线程持有 global interpreter lock (因此 func 可以使用完整的 C API)。

func 必须在成功时返回 0，或在失败时返回 -1 并设置一个异常集合。 func 不会被中断来递归地执行另一个异步通知，但如果全局解释器锁被释放则它仍可被中断以切换线程。

此函数的运行不需要当前线程状态，也不需要全局解释器锁。

要在子解释器中调用函数，调用方必须持有 GIL。 否则，函数 func 可能会被安排给错误的解释器来调用。

警告

这是一个低层级函数，只在非常特殊的情况下有用。 不能保证 func 会尽快被调用。 如果主线程忙于执行某个系统调用，func 将不会在系统调用返回之前被调用。 此函数 通常 不适合 从任意 C 线程调用 Python 代码。 作为替代，请使用 PyGILStateAPI。

在 3.9 版更改: 如果此函数在子解释器中被调用，则函数 func 将被安排在子解释器中调用，而不是在主解释器中调用。现在每个子解释器都有自己的计划调用列表。

3.1 新版功能.

分析和跟踪

Python 解释器为附加的性能分析和执行跟踪工具提供了一些低层级的支持。 它们可被用于性能分析、调试和覆盖分析工具。

这个 C 接口允许性能分析或跟踪代码避免调用 Python 层级的可调用对象带来的开销，它能直接执行 C 函数调用。 此工具的基本属性没有变化；这个接口允许针对每个线程安装跟踪函数，并且向跟踪函数报告的基本事件与之前版本中向 Python 层级跟踪函数报告的事件相同。

typedef int (*Py_tracefunc)(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg)

The type of the trace function registered using PyEval_SetProfile() and 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 PyTrace_CALL, PyTrace_EXCEPTION, PyTrace_LINE, PyTrace_RETURN, PyTrace_C_CALL, PyTrace_C_EXCEPTION, PyTrace_C_RETURN, or PyTrace_OPCODE, and arg depends on the value of what:

what 的值 | arg 的含义
PyTrace_CALL | 总是 Py_None.
PyTrace_EXCEPTION | sys.exc_info() 返回的异常信息。
PyTrace_LINE | 总是 Py_None.
PyTrace_RETURN | 返回给调用方的值，或者如果是由异常导致的则返回 NULL。
PyTrace_C_CALL | 正在调用函数对象。
PyTrace_C_EXCEPTION | 正在调用函数对象。
PyTrace_C_RETURN | 正在调用函数对象。
PyTrace_OPCODE | 总是 Py_None.

int PyTrace_CALL

当对一个函数或方法的新调用被报告，或是向一个生成器增加新条目时传给 Py_tracefunc 函数的 what 形参的值。 请注意针对生成器函数的迭代器的创建情况不会被报告因为在相应的帧中没有向 Python字节码转移控制权。

int PyTrace_EXCEPTION

当一个异常被引发时传给 Py_tracefunc 函数的 what 形参的值。 在处理完任何字节码之后将附带 what 的值调用回调函数，在此之后该异常将会被设置在正在执行的帧中。 这样做的效果是当异常传播导致 Python 栈展开时，被调用的回调函数将随异常传播返回到每个帧。 只有跟踪函数才会接收到这些事件；性能分析器并不需要它们。

int PyTrace_LINE

The value passed as the what parameter to a 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 f_trace_lines to 0 on that frame.

int PyTrace_RETURN

当一个调用即将返回时传给 Py_tracefunc 函数的 what 形参的值。

int PyTrace_C_CALL

当一个 C 函数即将被调用时传给 Py_tracefunc 函数的 what 形参的值。

int PyTrace_C_EXCEPTION

当一个 C 函数引发异常时传给 Py_tracefunc 函数的 what 形参的值。

int PyTrace_C_RETURN

当一个 C 函数返回时传给 Py_tracefunc 函数的 what 形参的值。

int PyTrace_OPCODE

The value for the what parameter to 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 f_trace_opcodes to 1 on the frame.

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 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 PyTrace_LINE PyTrace_OPCODE and PyTrace_EXCEPTION.

调用方必须持有 GIL。

void PyEval_SetTrace(Py_tracefunc func, PyObject *obj)

Set the tracing function to func. This is similar to 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 PyEval_SetTrace() will not receive PyTrace_C_CALL, PyTrace_C_EXCEPTION or PyTrace_C_RETURN as a value for the what parameter.

调用方必须持有 GIL。

高级调试器支持

这些函数仅供高级调试工具使用。

PyInterpreterState *PyInterpreterState_Head()

将解释器状态对象返回到由所有此类对象组成的列表的开头。

PyInterpreterState *PyInterpreterState_Main()

返回主解释器状态对象。

PyInterpreterState *PyInterpreterState_Next(PyInterpreterState *interp)

从由解释器状态对象组成的列表中返回 interp 之后的下一项。

PyThreadState *PyInterpreterState_ThreadHead(PyInterpreterState *interp)

在由与解释器 interp 相关联的线程组成的列表中返回指向第一个 PyThreadState 对象的指针。

PyThreadState *PyThreadState_Next(PyThreadState *tstate)

从由属于同一个 PyInterpreterState 对象的线程状态对象组成的列表中返回 tstate 之后的下一项。

线程本地存储支持

Python 解释器提供也对线程本地存储 (TLS) 的低层级支持，它对下层的原生 TLS 实现进行了包装以支持 Python 层级的线程本地存储 API (threading.local)。 CPython 的 C 层级 API 与 pthreads 和 Windows 所提供的类似：使用一个线程键和函数来为每个线程关联一个 void* 值。

当调用这些函数时 无须 持有 GIL；它们会提供自己的锁机制。

请注意 Python.h 并不包括 TLS API 的声明，你需要包括 pythread.h 来使用线程本地存储。

注解

这些 API 函数都不会为 void* 的值处理内存管理问题。 你需要自己分配和释放它们。 如果 void* 值碰巧为 PyObject*，这些函数也不会对它们执行引用计数操作。

线程专属存储 (TSS) API

引入 TSSAPI 是为了取代 CPython 解释器中现有 TLS API 的使用。 该 API 使用一个新类型 Py_tss_t 而不是 int 来表示线程键。

3.7 新版功能.

参见

"A New C-API for Thread-Local Storage in CPython" (PEP 539 [https://www.python.org/dev/peps/pep-0539])

type Py_tss_t

该数据结构表示线程键的状态，其定义可能依赖于下层的 TLS 实现，并且它有一个表示键初始化状态的内部字段。 该结构体中不存在公有成员。

当未定义 Py_LIMITED_API 时，允许由 Py_tss_NEEDS_INIT 执行此类型的静态分配。

Py_tss_NEEDS_INIT

这个宏将扩展为 Py_tss_t 变量的初始化器。 请注意这个宏不会用 Py_LIMITED_API 来定义。

动态分配

Py_tss_t 的动态分配，在使用 Py_LIMITED_API 编译的扩展模块中是必须的，在这些模块由于此类型的实现在编译时是不透明的因此它不可能静态分配。

Py_tss_t *PyThread_tss_alloc()

Part of the Stable ABI since version 3.7.

返回一个与使用 Py_tss_NEEDS_INIT 初始化的值的状态相同的值，或者当动态分配失败时则返回 NULL。

void PyThread_tss_free(Py_tss_t *key)

Part of the Stable ABI since version 3.7.

在首次调用 PyThread_tss_delete() 以确保任何相关联的线程局部变量已被撤销赋值之后释放由 PyThread_tss_alloc() 所分配的给定的 key。 如果 key 参数为 NULL 则这将无任何操作。

注解

A freed key becomes a dangling pointer. You should reset the key to NULL.

方法

这些函数的形参 key 不可为 NULL。 并且，如果给定的 Py_tss_t 还未被 PyThread_tss_create() 初始化则 PyThread_tss_set() 和 PyThread_tss_get() 的行为将是未定义的。

int PyThread_tss_is_created(Py_tss_t *key)

Part of the Stable ABI since version 3.7.

如果给定的 Py_tss_t 已通过has been initialized by PyThread_tss_create() 被初始化则返回一个非零值。

int PyThread_tss_create(Py_tss_t *key)

Part of the Stable ABI since version 3.7.

当成功初始化一个 TSS 键时将返回零值。 如果 key 参数所指向的值未被 Py_tss_NEEDS_INIT 初始化则其行为是未定义的。 此函数可在相同的键上重复调用 -- 在已初始化的键上调用它将不执行任何操作并立即成功返回。

void PyThread_tss_delete(Py_tss_t *key)

Part of the Stable ABI since version 3.7.

销毁一个 TSS 键以便在所有线程中遗忘与该键相关联的值，并将该键的初始化状态改为未初始化的。 已销毁的键可以通过 PyThread_tss_create() 再次被初始化。 此函数可以在同一个键上重复调用 -- 但在一个已被销毁的键上调用将是无效的。

int PyThread_tss_set(Py_tss_t *key, void *value)

Part of the Stable ABI since version 3.7.

返回零值来表示成功将一个 void* 值与当前线程中的 TSS 键相关联。 每个线程都有一个从键到 void* 值的独立映射。

void *PyThread_tss_get(Py_tss_t *key)

Part of the Stable ABI since version 3.7.

返回当前线程中与一个 TSS 键相关联的 void* 值。 如果当前线程中没有与该键相关联的值则返回 NULL。

线程本地存储 (TLS) API

3.7 版后已移除: 此 API 已被 线程专属存储 (TSS) API 所取代。

注解

这个 API 版本不支持原生 TLS 键采用无法被安全转换为 int 的的定义方式的平台。 在这样的平台上，PyThread_create_key() 将立即返回一个失败状态，并且其他 TLS 函数在这样的平台上也都无效。

由于上面提到的兼容性问题，不应在新代码中使用此版本的API。

int PyThread_create_key()

Part of the Stable ABI.

void PyThread_delete_key(int key)

Part of the Stable ABI.

int PyThread_set_key_value(int key, void *value)

Part of the Stable ABI.

void *PyThread_get_key_value(int key)

Part of the Stable ABI.

void PyThread_delete_key_value(int key)

Part of the Stable ABI.

void PyThread_ReInitTLS()

Part of the Stable ABI.

Python初始化配置

3.8 新版功能.

Python 可以使用 Py_InitializeFromConfig() 和 PyConfig 结构体来初始化。 它可以使用 Py_PreInitialize() 和 PyPreConfig 结构体来预初始化。

有两种配置方式：

Python 配置 可被用于构建一个定制的 Python，其行为与常规 Python 类似。 例如，环境变量和命令行参数可被用于配置 Python。

隔离配置 可被用于将 Python 嵌入到应用程序。 它将 Python 与系统隔离开来。 例如，环境变量将被忽略，LC_CTYPE 语言区域设置保持不变并且不会注册任何信号处理器。

Py_RunMain() 函数可被用来编写定制的 Python 程序。

参见 Initialization, Finalization, and Threads.

参见

PEP 587 [https://www.python.org/dev/peps/pep-0587] "Python 初始化配置".

示例

定制的 Python 的示例总是会以隔离模式运行:

int main(int argc, char **argv)
{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);
    config.isolated = 1;

    /* Decode command line arguments.
       Implicitly preinitialize Python (in isolated mode). */
    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;
    }
    /* Display the error message and exit the process with
       non-zero exit code */
    Py_ExitStatusException(status);
}

PyWideStringList

type PyWideStringList

由 wchar_t* 字符串组成的列表。

如果 length 为非零值，则 items 必须不为 NULL 并且所有字符串均必须不为 NULL。

方法

PyStatus PyWideStringList_Append(PyWideStringList *list, const wchar_t *item)

将 item 添加到 list。

Python 必须被预初始化以便调用此函数。

PyStatus PyWideStringList_Insert(PyWideStringList *list, Py_ssize_t index, const wchar_t *item)

将 item 插入到 list 的 index 位置上。

如果 index 大于等于 list 的长度，则将 item 添加到 list。

index must be greater than or equal to 0.

Python 必须被预初始化以便调用此函数。

结构体字段:

Py_ssize_t length

List 长度。

wchar_t **items

列表项目。

PyStatus

type PyStatus

存储初始函数状态：成功、错误或退出的结构体。

对于错误，它可以存储造成错误的 C 函数的名称。

结构体字段:

int exitcode

退出码。 传给 exit() 的参数。

const char *err_msg

错误信息

const char *func

造成错误的函数的名称，可以为 NULL。

创建状态的函数:

PyStatus PyStatus_Ok(void)

完成。

PyStatus PyStatus_Error(const char *err_msg)

带消息的初始化错误。

err_msg 不可为 NULL。

PyStatus PyStatus_NoMemory(void)

内存分配失败（内存不足）。

PyStatus PyStatus_Exit(int exitcode)

以指定的退出代码退出 Python。

处理状态的函数:

int PyStatus_Exception(PyStatus status)

状态为错误还是退出？如为真值，则异常必须被处理；例如通过调用 Py_ExitStatusException()。

int PyStatus_IsError(PyStatus status)

结果错误吗？

int PyStatus_IsExit(PyStatus status)

结果是否退出？

void Py_ExitStatusException(PyStatus status)

如果 status 是一个退出码则调用 exit(exitcode)。如果 status 是一个错误码则打印错误消息并设置一个非零退出码再退出。 必须在 PyStatus_Exception(status) 为非零值时才能被调用。

注解

在内部，Python 将使用设置 PyStatus.func 的宏，而创建状态的函数则会将 func 设为 NULL。

示例:

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;
}

PyPreConfig

type PyPreConfig

用于预初始化 Python 的结构体。

用于初始化预先配置的函数:

void PyPreConfig_InitPythonConfig(PyPreConfig *preconfig)

通过 Python 配置 来初始化预先配置。

void PyPreConfig_InitIsolatedConfig(PyPreConfig *preconfig)

通过 隔离配置 来初始化预先配置。

结构体字段:

int allocator

Python 内存分配器名称:

PYMEM_ALLOCATOR_NOT_SET (0): 不改变内存分配器 (使用默认)。

PYMEM_ALLOCATOR_DEFAULT (1): 默认内存分配器。

PYMEM_ALLOCATOR_DEBUG (2): 默认内存分配器 附带 调试钩子。

PYMEM_ALLOCATOR_MALLOC (3): 使用 C 库的 malloc()。

PYMEM_ALLOCATOR_MALLOC_DEBUG (4): 强制使用 malloc() 附带 调试钩子。

PYMEM_ALLOCATOR_PYMALLOC (5): Python pymalloc 内存分配器。

PYMEM_ALLOCATOR_PYMALLOC_DEBUG (6): Python pymalloc 内存分配器 附带 调试钩子。

如果 Python 是 使用 --without-pymalloc 进行配置 则 PYMEM_ALLOCATOR_PYMALLOC 和 PYMEM_ALLOCATOR_PYMALLOC_DEBUG 将不被支持。

参见 Memory Management.

默认值: PYMEM_ALLOCATOR_NOT_SET。

int configure_locale

将 LC_CTYPE 语言区域设为用户选择的语言区域。

If equals to 0, set coerce_c_locale and coerce_c_locale_warn members to 0.

参见 locale encoding。

默认值: 在 Python 配置中为 1，在隔离配置中为 0。

int coerce_c_locale

If equals to 2, coerce the C locale.

If equals to 1, read the LC_CTYPE locale to decide if it should be coerced.

参见 locale encoding。

默认值: 在 Python 配置中为 -1，在隔离配置中为 0。

int coerce_c_locale_warn

如为非零值，则会在 C 语言区域被强制转换时发出警告。

默认值: 在 Python 配置中为 -1，在隔离配置中为 0。

int dev_mode

If non-zero, enables the Python Development Mode: see PyConfig.dev_mode.

默认值: 在 Python 模式中为 -1，在隔离模式中为 0。

int isolated

隔离模式：参见 PyConfig.isolated。

默认值: 在 Python 模式中为 0，在隔离模式中为 1。

int legacy_windows_fs_encoding

如为非零值:

设置 PyPreConfig.utf8_mode 为 0,

设置 PyConfig.filesystem_encoding 为 "mbcs",

设置 PyConfig.filesystem_errors 为 "replace".

初始化来自 PYTHONLEGACYWINDOWSFSENCODING 的环境变量值。

仅在 Windows 上可用。 #ifdef MS_WINDOWS 宏可被用于 Windows 专属的代码。

默认值: 0.

int parse_argv

如为非零值，Py_PreInitializeFromArgs() 和 Py_PreInitializeFromBytesArgs() 将以与常规 Python 解析命令行参数的相同方式解析其 argv 参数：参见 命令行参数。

默认值: 在 Python 配置中为 1，在隔离配置中为 0。

int use_environment

使用 环境变量? 参见 PyConfig.use_environment。

默认值: 在 Python 配置中为 1 而在隔离配置中为 0。

int utf8_mode

如为非零值，则启用 Python UTF-8 模式。

Set by the -X utf8 command line option and the PYTHONUTF8 environment variable.

默认值: 在 Python 配置中为 -1 而在隔离配置中为 0。

使用 PyPreConfig 预初始化 Python

Python 的预初始化:

设置 Python 内存分配器 (PyPreConfig.allocator)

配置 LC_CTYPE 语言区域 (locale encoding)

设置 Python UTF-8 模式 (PyPreConfig.utf8_mode)

当前的预配置 (PyPreConfig 类型) 保存在 _PyRuntime.preconfig 中。

用于预初始化 Python 的函数：

PyStatus Py_PreInitialize(const PyPreConfig *preconfig)

根据 preconfig 预配置来预初始化 Python。

preconfig 不可为 NULL。

PyStatus Py_PreInitializeFromBytesArgs(const PyPreConfig *preconfig, int argc, char *const *argv)

根据 preconfig 预配置来预初始化 Python。

如果 preconfig 的 parse_argv 为非零值则解析 argv 命令行参数（字节串）。

preconfig 不可为 NULL。

PyStatus Py_PreInitializeFromArgs(const PyPreConfig *preconfig, int argc, wchar_t *const *argv)

根据 preconfig 预配置来预初始化 Python。

如果 preconfig 的 parse_argv 为非零值则解析 argv 命令行参数（宽字符串）。

preconfig 不可为 NULL。

调用方要负责使用 PyStatus_Exception() 和 Py_ExitStatusException() 来处理异常（错误或退出）。

对于 Python 配置 (PyPreConfig_InitPythonConfig())，如果 Python 是用命令行参数初始化的，那么在预初始化 Python 时也必须传递命令行参数，因为它们会对编码格式等预配置产生影响。 例如，-X utf8 命令行选项将启用 Python UTF-8 模式。

PyMem_SetAllocator() 可在 Py_PreInitialize() 之后、Py_InitializeFromConfig() 之前被调用以安装自定义的内存分配器。 如果 PyPreConfig.allocator 被设为 PYMEM_ALLOCATOR_NOT_SET 则可在 Py_PreInitialize() 之前被调用。

像 PyMem_RawMalloc() 这样的 Python 内存分配函数不能在 Python 预初始化之前使用，而直接调用 malloc() 和 free() 则始终会是安全的。 Py_DecodeLocale() 不能在 Python 预初始化之前被调用。

使用预初始化来启用 Python UTF-8 模式 的例子:

PyStatus status;
PyPreConfig preconfig;
PyPreConfig_InitPythonConfig(&preconfig);

preconfig.utf8_mode = 1;

status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) {
    Py_ExitStatusException(status);
}

/* at this point, Python speaks UTF-8 */

Py_Initialize();
/* ... use Python API here ... */
Py_Finalize();

PyConfig

type PyConfig

包含了大部分用于配置 Python 的形参的结构体。

在完成后，必须使用 PyConfig_Clear() 函数来释放配置内存。

结构体方法:

void PyConfig_InitPythonConfig(PyConfig *config)

通过 Python 配置 来初始化配置。

void PyConfig_InitIsolatedConfig(PyConfig *config)

通过 隔离配置 来初始化配置。

PyStatus PyConfig_SetString(PyConfig *config, wchar_t *const *config_str, const wchar_t *str)

将宽字符串 str 拷贝至 *config_str。

在必要时 预初始化 Python。

PyStatus PyConfig_SetBytesString(PyConfig *config, wchar_t *const *config_str, const char *str)

使用 Py_DecodeLocale() 对 str 进行解码并将结果设置到 *config_str。

在必要时 预初始化 Python。

PyStatus PyConfig_SetArgv(PyConfig *config, int argc, wchar_t *const *argv)

根据宽字符串列表 argv 设置命令行参数 (config 的 argv 成员)。

在必要时 预初始化 Python。

PyStatus PyConfig_SetBytesArgv(PyConfig *config, int argc, char *const *argv)

根据字节串列表 argv 设置命令行参数 (config 的 argv 成员)。 使用 Py_DecodeLocale() 对字节串进行解码。

在必要时 预初始化 Python。

PyStatus PyConfig_SetWideStringList(PyConfig *config, PyWideStringList *list, Py_ssize_t length, wchar_t **items)

将宽字符串列表 list 设置为 length 和 items。

在必要时 预初始化 Python。

PyStatus PyConfig_Read(PyConfig *config)

读取所有 Python 配置。

已经初始化的字段会保持不变。

PyConfig_Read() 函数只解析 PyConfig.argv 参数一次：在参数解析完成后，PyConfig.parse_argv 将被设为 2。 由于 Python 参数是从 PyConfig.argv 中剥离的，因此解析参数两次会将应用程序选项解析为 Python 选项。

在必要时 预初始化 Python。

在 3.10 版更改: PyConfig.argv 参数现在只会被解析一次，在参数解析完成后，PyConfig.parse_argv 将被设为 2，只有当 PyConfig.parse_argv 等于 1 时才会解析参数。

void PyConfig_Clear(PyConfig *config)

释放配置内存

如有必要大多数 PyConfig 方法将会 预初始化 Python。 在这种情况下，Python 预初始化配置 (PyPreConfig) 将以 PyConfig 为基础。 如果要调整与 PyPreConfig 相同的配置字段，它们必须在调用 PyConfig 方法之前被设置：

PyConfig.dev_mode

PyConfig.isolated

PyConfig.parse_argv

PyConfig.use_environment

Moreover, if PyConfig_SetArgv() or PyConfig_SetBytesArgv() is used, this method must be called before other methods, since the preinitialization configuration depends on command line arguments (if parse_argv is non-zero).

这些方法的调用者要负责使用 PyStatus_Exception() 和 Py_ExitStatusException() 来处理异常（错误或退出）。

结构体字段:

PyWideStringList argv

命令行参数: sys.argv。

将 parse_argv 设为 1 将以与普通 Python 解析 Python 命令行参数相同的方式解析 argv 再从 argv 中剥离 Python 参数。

如果 argv 为空，则会添加一个空字符串以确保 sys.argv 始终存在并且永远不为空。

默认值: NULL.

另请参阅 orig_argv 成员。

wchar_t *base_exec_prefix

sys.base_exec_prefix.

默认值: NULL.

Python 路径配置 的一部分。

wchar_t *base_executable

Python 基础可执行文件: sys._base_executable。

由 __PYVENV_LAUNCHER__ 环境变量设置。

如为 NULL 则从 PyConfig.executable 设置。

默认值: NULL.

Python 路径配置 的一部分。

wchar_t *base_prefix

sys.base_prefix.

默认值: NULL.

Python 路径配置 的一部分。

int buffered_stdio

If equals to 0 and configure_c_stdio is non-zero, disable buffering on the C streams stdout and stderr.

Set to 0 by the -u command line option and the PYTHONUNBUFFERED environment variable.

stdin 始终以缓冲模式打开。

默认值: 1.

int bytes_warning

If equals to 1, issue a warning when comparing bytes or bytearray with str, or comparing bytes with int.

If equal or greater to 2, raise a BytesWarning exception in these cases.

由 -b 命令行选项执行递增。

默认值: 0.

int warn_default_encoding

如为非零值，则在 io.TextIOWrapper 使用默认编码格式时发出 EncodingWarning 警告。 详情请参阅 选择性的 EncodingWarning。

默认值: 0.

3.10 新版功能.

wchar_t *check_hash_pycs_mode

控制基于哈希值的 .pyc 文件的验证行为: --check-hash-based-pycs 命令行选项的值。

有效的值：

L"always": 无论 'check_source' 旗标的值是什么都会对源文件进行哈希验证。

L"never": 假定基于哈希值的 pyc 始终是有效的。

L"default": 基于哈希值的 pyc 中的 'check_source' 旗标确定是否验证无效。

默认值： L"default"。

参见 PEP 552 [https://www.python.org/dev/peps/pep-0552] "Deterministic pycs"。

int configure_c_stdio

如为非零值，则配置 C 标准流:

在 Windows 中，在 stdin, stdout 和 stderr 上设置二进制模式 (O_BINARY)。

如果 buffered_stdio 等于零，则禁用 stdin, stdout 和 stderr 流的缓冲。

如果 interactive 为非零值，则启用 stdin 和 stdout 上的流缓冲（Windows 中仅限 stdout）。

默认值: 在 Python 配置中为 1，在隔离配置中为 0。

int dev_mode

如果为非零值，则启用 Python 开发模式。

默认值: 在 Python 模式中为 -1，在隔离模式中为 0。

int dump_refs

转储 Python 引用？

如果为非零值，则转储所有在退出时仍存活的对象。

由 PYTHONDUMPREFS 环境变量设置为 1。

需要定义了 Py_TRACE_REFS 宏的特殊 Python 编译版：参见 configure --with-trace-refs 选项。

默认值: 0.

wchar_t *exec_prefix

安装依赖于平台的 Python 文件的站点专属目录前缀: sys.exec_prefix。

默认值: NULL.

Python 路径配置 的一部分。

wchar_t *executable

Python 解释器可执行二进制文件的绝对路径: sys.executable。

默认值: NULL.

Python 路径配置 的一部分。

int faulthandler

启用 faulthandler？

如果为非零值，则在启动时调用 faulthandler.enable()。

通过 -X faulthandler 和 PYTHONFAULTHANDLER 环境变量设为 1。

默认值: 在 Python 模式中为 -1，在隔离模式中为 0。

wchar_t *filesystem_encoding

文件系统编码格式: sys.getfilesystemencoding()。

在 macOS, Android 和 VxWorks 上：默认使用 "utf-8"。

在 Windows 上：默认使用 "utf-8"，或者如果 PyPreConfig 的 legacy_windows_fs_encoding 为非零值则使用 "mbcs"。

在其他平台上的默认编码格式：

如果 PyPreConfig.utf8_mode 为非零值则使用 "utf-8"。

如果 Python 检测到 nl_langinfo(CODESET) 声明为 ASCII 编码格式，而 mbstowcs() 是从其他的编码格式解码（通常为 Latin1）则使用 "ascii"。

如果 nl_langinfo(CODESET) 返回空字符串则使用 "utf-8"。

在其他情况下，使用 locale encoding: nl_langinfo(CODESET) 的结果。

在 Python 启动时，编码格式名称会规范化为 Python 编解码器名称。 例如，"ANSI_X3.4-1968" 将被替换为 "ascii"。

参见 filesystem_errors 的成员。

wchar_t *filesystem_errors

文件系统错误处理器: sys.getfilesystemencodeerrors()。

在 Windows 上：默认使用 "surrogatepass"，或者如果 PyPreConfig 的 legacy_windows_fs_encoding 为非零值则使用 "replace"。

在其他平台上：默认使用 "surrogateescape"。

支持的错误处理器：

"strict"

"surrogateescape"

"surrogatepass" (仅支持 UTF-8 编码格式)

参见 filesystem_encoding 的成员。

unsigned long hash_seed

int use_hash_seed

随机化的哈希函数种子。

如果 use_hash_seed 为零，则在 Python 启动时随机选择一个种子，并忽略 hash_seed。

由 PYTHONHASHSEED 环境变量设置。

默认的 use_hash_seed 值：在 Python 模式下为 -1，在隔离模式下为 0。

wchar_t *home

Python 主目录。

如果 Py_SetPythonHome() 已被调用，则当其参数不为 NULL 时将使用它。

由 PYTHONHOME 环境变量设置。

默认值: NULL.

Python 路径配置 输入的一部分。

int import_time

如为非零值，则对导入时间执行性能分析。

通过 -X importtime 选项和 PYTHONPROFILEIMPORTTIME 环境变量设置为 1。

默认值: 0.

int inspect

在执行脚本或命令之后进入交互模式。

If greater than 0, enable inspect: when a script is passed as first argument or the -c option is used, enter interactive mode after executing the script or the command, even when sys.stdin does not appear to be a terminal.

通过 -i 命令行选项执行递增。 如果 PYTHONINSPECT 环境变量为非空值则设为 1。

默认值: 0.

int install_signal_handlers

安装 Python 信号处理器？

默认值：在 Python 模式下为 1，在隔离模式下为 0。

int interactive

If greater than 0, enable the interactive mode (REPL).

由 -i 命令行选项执行递增。

默认值: 0.

int isolated

If greater than 0, enable isolated mode:

sys.path contains neither the script's directory (computed from argv[0] or the current directory) nor the user's site-packages directory.

Python REPL 将不导入 readline 也不在交互提示符中启用默认的 readline 配置。

Set use_environment and user_site_directory to 0.

默认值: 在 Python 模式中为 0，在隔离模式中为 1。

另请参见 PyPreConfig.isolated 。

int legacy_windows_stdio

If non-zero, use io.FileIO instead of io.WindowsConsoleIO for sys.stdin, sys.stdout and sys.stderr.

如果 PYTHONLEGACYWINDOWSSTDIO 环境变量被设为非空字符串则设为 1。

仅在 Windows 上可用。 #ifdef MS_WINDOWS 宏可被用于 Windows 专属的代码。

默认值: 0.

另请参阅 PEP 528 [https://www.python.org/dev/peps/pep-0528] (将 Windows 控制台编码格式更改为 UTF-8)。

int malloc_stats

如为非零值，则在退出时转储 Python pymalloc 内存分配器 的统计数据。

由 PYTHONMALLOCSTATS 环境变量设置为 1。

如果 Python 是 使用 --without-pymalloc 选项进行配置 则该选项将被忽略。

默认值: 0.

wchar_t *platlibdir

平台库目录名称: sys.platlibdir。

由 PYTHONPLATLIBDIR 环境变量设置。

Default: value of the PLATLIBDIR macro which is set by the configure --with-platlibdir option (default: "lib").

Python 路径配置 输入的一部分。

3.9 新版功能.

wchar_t *pythonpath_env

Module search paths (sys.path) as a string separated by DELIM (os.path.pathsep).

由 PYTHONPATH 环境变量设置。

默认值: NULL.

Python 路径配置 输入的一部分。

PyWideStringList module_search_paths

int module_search_paths_set

模块搜索路径: sys.path。

If module_search_paths_set is equal to 0, the function calculating the Python Path Configuration overrides the module_search_paths and sets module_search_paths_set to 1.

默认值：空列表 (module_search_paths) 和 0 (module_search_paths_set)。

Python 路径配置 的一部分。

int optimization_level

编译优化级别：

0: Peephole 优化器，将 __debug__ 设为 True。

1: 0 级，移除断言，将 __debug__ 设为 False。

2: 1 级，去除文档字符串。

通过 -O 命令行选项递增。 设置为 PYTHONOPTIMIZE 环境变量值。

默认值: 0.

PyWideStringList orig_argv

传给 Python 可执行程序的原始命令行参数列表: sys.orig_argv。

如果 orig_argv 列表为空并且 argv 不是一个只包含空字符串的列表，PyConfig_Read() 将在修改 argv 之前把 argv 拷贝至 orig_argv (如果 parse_argv 不为空)。

另请参阅 argv 成员和 Py_GetArgcArgv() 函数。

默认值：空列表。

3.10 新版功能.

int parse_argv

解析命令行参数？

如果等于 1，则以与常规 Python 解析 命令行参数 相同的方式解析 argv，并从 argv 中剥离 Python 参数。

PyConfig_Read() 函数只解析 PyConfig.argv 参数一次：在参数解析完成后，PyConfig.parse_argv 将被设为 2。 由于 Python 参数是从 PyConfig.argv 中剥离的，因此解析参数两次会将应用程序选项解析为 Python 选项。

默认值：在 Python 模式下为 1，在隔离模式下为 0。

在 3.10 版更改: 现在只有当 PyConfig.parse_argv 等于 1 时才会解析 PyConfig.argv 参数。

int parser_debug

Parser debug mode. If greater than 0, turn on parser debugging output (for expert only, depending on compilation options).

通过 -d 命令行选项递增。 设置为 PYTHONDEBUG 环境变量值。

默认值: 0.

int pathconfig_warnings

On Unix, if non-zero, calculating the Python Path Configuration can log warnings into stderr. If equals to 0, suppress these warnings.

It has no effect on Windows.

默认值：在 Python 模式下为 1，在隔离模式下为 0。

Python 路径配置 输入的一部分。

wchar_t *prefix

安装依赖于平台的 Python 文件的站点专属目录前缀: sys.prefix。

默认值: NULL.

Python 路径配置 的一部分。

wchar_t *program_name

用于初始化 executable 和在 Python 初始化期间早期错误消息中使用的程序名称。

如果 Py_SetProgramName() 已被调用，将使用其参数。

在 macOS 上，如果设置了 PYTHONEXECUTABLE 环境变量则会使用它。

如果定义了 WITH_NEXT_FRAMEWORK 宏，当设置了 __PYVENV_LAUNCHER__ 环境变量时将会使用它。

如果 argv 的 argv[0] 可用并且不为空值则会使用它。

否则，在 Windows 上将使用 L"python"，在其他平台上将使用 L"python3"。

默认值: NULL.

Python 路径配置 输入的一部分。

wchar_t *pycache_prefix

缓存 .pyc 文件被写入到的目录: sys.pycache_prefix。

通过 -X pycache_prefix=PATH 命令行选项和 PYTHONPYCACHEPREFIX 环境变量设置。

如果为 NULL，则 sys.pycache_prefix 将被设为 None。

默认值: NULL.

int quiet

Quiet mode. If greater than 0, don't display the copyright and version at Python startup in interactive mode.

由 -q 命令行选项执行递增。

默认值: 0.

wchar_t *run_command

-c 命令行选项的值。

由 Py_RunMain() 使用。

默认值: NULL.

wchar_t *run_filename

Filename passed on the command line: trailing command line argument without -c or -m.

For example, it is set to script.py by the python3 script.py arg command.

由 Py_RunMain() 使用。

默认值: NULL.

wchar_t *run_module

-m 命令行选项的值。

由 Py_RunMain() 使用。

默认值: NULL.

int show_ref_count

在退出时显示引用总数？

Set to 1 by -X showrefcount command line option.

需要 Python 调试编译版 (必须定义 Py_REF_DEBUG 宏)。

默认值: 0.

int site_import

在启动时导入 site 模块？

如果等于零，则禁用模块站点的导入以及由此产生的与站点相关的 sys.path 操作。

如果以后显式地导入 site 模块也要禁用这些操作（如果你希望触发这些操作，请调用 site.main() 函数）。

通过 -S 命令行选项设置为 0。

sys.flags.no_site is set to the inverted value of site_import.

默认值: 1.

int skip_source_first_line

如为非零值，则跳过 PyConfig.run_filename 源的第一行。

它将允许使用非 Unix 形式的 #!cmd。 这是针对 DOS 专属的破解操作。

通过 -x 命令行选项设置为 1。

默认值: 0.

wchar_t *stdio_encoding

wchar_t *stdio_errors

sys.stdin、sys.stdout 和 sys.stderr 的编码格式和编码格式错误（但 sys.stderr 将始终使用 "backslashreplace" 错误处理器）。

如果 Py_SetStandardStreamEncoding() 已被调用，则当其 error 和 errors 参数不为 NULL 时将使用它们。

如果 PYTHONIOENCODING 环境变量非空则会使用它。

默认编码格式：

如果 PyPreConfig.utf8_mode 为非零值则使用 "UTF-8"。

在其他情况下，使用 locale encoding。

默认错误处理器：

在 Windows 上：使用 "surrogateescape"。

如果 PyPreConfig.utf8_mode 为非零值，或者如果 LC_CTYPE 语言区域为 "C" 或 "POSIX" 则使用 "surrogateescape"。

在其他情况下则使用 "strict"。

int tracemalloc

启用 tracemalloc？

如果为非零值，则在启动时调用 tracemalloc.start()。

通过 -X tracemalloc=N 命令行选项和 PYTHONTRACEMALLOC 环境变量设置。

默认值: 在 Python 模式中为 -1，在隔离模式中为 0。

int use_environment

使用 环境变量？

如果等于零，则忽略 环境变量。

默认值: 在 Python 配置中为 1 而在隔离配置中为 0。

int user_site_directory

如果为非零值，则将用户站点目录添加到 sys.path。

通过 -s 和 -I 命令行选项设置为 0。

由 PYTHONNOUSERSITE 环境变量设置为 0。

默认值：在 Python 模式下为 1，在隔离模式下为 0。

int verbose

Verbose mode. If greater than 0, print a message each time a module is imported, showing the place (filename or built-in module) from which it is loaded.

If greater or equal to 2, print a message for each file that is checked for when searching for a module. Also provides information on module cleanup at exit.

由 -v 命令行选项执行递增。

Set to the PYTHONVERBOSE environment variable value.

默认值: 0.

PyWideStringList warnoptions

warnings 模块用于构建警告过滤器的选项，优先级从低到高: sys.warnoptions。

warnings 模块以相反的顺序添加 sys.warnoptions: 最后一个 PyConfig.warnoptions 条目将成为 warnings.filters 的第一个条目并将最先被检查（最高优先级）。

-W 命令行选项会将其值添加到 warnoptions 中，它可以被多次使用。

PYTHONWARNINGS 环境变量也可被用于添加警告选项。 可以指定多个选项，并以逗号 (,) 分隔。

默认值：空列表。

int write_bytecode

If equal to 0, Python won't try to write .pyc files on the import of source modules.

通过 -B 命令行选项和 PYTHONDONTWRITEBYTECODE 环境变量设置为 0。

sys.dont_write_bytecode 会被初始化为 write_bytecode 取反后的值。

默认值: 1.

PyWideStringList xoptions

-X 命令行选项的值: sys._xoptions。

默认值：空列表。

如果 parse_argv 为非零值，则 argv 参数将以与常规 Python 解析 命令行参数 相同的方式被解析，并从 argv 中剥离 Python 参数。

xoptions 选项将会被解析以设置其他选项：参见 -X 命令行选项。

在 3.9 版更改: show_alloc_count 字段已被移除。

使用 PyConfig 初始化

用于初始化 Python 的函数：

PyStatus Py_InitializeFromConfig(const PyConfig *config)

根据 config 配置来初始化 Python。

调用方要负责使用 PyStatus_Exception() 和 Py_ExitStatusException() 来处理异常（错误或退出）。

如果使用了 PyImport_FrozenModules()、PyImport_AppendInittab() 或 PyImport_ExtendInittab()，则必须在 Python 预初始化之后、Python 初始化之前设置或调用它们。 如果 Python 被多次初始化，则必须在每次初始化 Python 之前调用 PyImport_AppendInittab() 或 PyImport_ExtendInittab()。

当前的配置 (PyConfig 类型) 保存在 PyInterpreterState.config 中。

设置程序名称的示例:

void init_python(void)
{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* Set the program name. Implicitly preinitialize 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);
}

More complete example modifying the default configuration, read the configuration, and then override some parameters:

PyStatus init_python(const char *program_name)
{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* Set the program name before reading the configuration
       (decode byte string from the locale encoding).

       Implicitly preinitialize Python. */
    status = PyConfig_SetBytesString(&config, &config.program_name,
                                     program_name);
    if (PyStatus_Exception(status)) {
        goto done;
    }

    /* Read all configuration at once */
    status = PyConfig_Read(&config);
    if (PyStatus_Exception(status)) {
        goto done;
    }

    /* Append our custom search path to sys.path */
    status = PyWideStringList_Append(&config.module_search_paths,
                                     L"/path/to/more/modules");
    if (PyStatus_Exception(status)) {
        goto done;
    }

    /* Override executable computed by PyConfig_Read() */
    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;
}

隔离配置

PyPreConfig_InitIsolatedConfig() 和 PyConfig_InitIsolatedConfig() 函数会创建一个配置来将 Python 与系统隔离开来。 例如，将 Python 嵌入到某个应用程序。

该配置将忽略全局配置变量、环境变量、命令行参数 (PyConfig.argv 将不会被解析) 和用户站点目录。 C 标准流 (例如 stdout) 和 LC_CTYPE 语言区域将保持不变。 信号处理器将不会被安装。

Configuration files are still used with this configuration. Set the Python Path Configuration ("output fields") to ignore these configuration files and avoid the function computing the default path configuration.

Python 配置

PyPreConfig_InitPythonConfig() 和 PyConfig_InitPythonConfig() 函数会创建一个配置来构建一个行为与常规 Python 相同的自定义 Python。

环境变量和命令行参数将被用于配置 Python，而全局配置变量将被忽略。

此函数将根据 LC_CTYPE 语言区域、PYTHONUTF8 和 PYTHONCOERCECLOCALE 环境变量启用 C 语言区域强制转换 (PEP 538 [https://www.python.org/dev/peps/pep-0538]) 和 Python UTF-8 模式 (PEP 540 [https://www.python.org/dev/peps/pep-0540])。

Python 路径配置

PyConfig 包含多个用于路径配置的字段：

路径配置输入：

PyConfig.home

PyConfig.platlibdir

PyConfig.pathconfig_warnings

PyConfig.program_name

PyConfig.pythonpath_env

当前工作目录：用于获取绝对路径

PATH 环境变量用于获取程序的完整路径 (来自 PyConfig.program_name)

__PYVENV_LAUNCHER__ 环境变量

（仅限 Windows only） 注册表 HKEY_CURRENT_USER 和 HKEY_LOCAL_MACHINE 的 "SoftwarePythonPythonCoreX.YPythonPath" 项下的应用程序目录（其中 X.Y 为 Python 版本）。

路径配置输出字段：

PyConfig.base_exec_prefix

PyConfig.base_executable

PyConfig.base_prefix

PyConfig.exec_prefix

PyConfig.executable

PyConfig.module_search_paths_set, PyConfig.module_search_paths

PyConfig.prefix

If at least one "output field" is not set, Python calculates the path configuration to fill unset fields. If module_search_paths_set is equal to 0, module_search_paths is overridden and module_search_paths_set is set to 1.

It is possible to completely ignore the function calculating the default path configuration by setting explicitly all path configuration output fields listed above. A string is considered as set even if it is non-empty. module_search_paths is considered as set if module_search_paths_set is set to 1. In this case, path configuration input fields are ignored as well.

Set pathconfig_warnings to 0 to suppress warnings when calculating the path configuration (Unix only, Windows does not log any warning).

如果 base_prefix 或 base_exec_prefix 字段未设置，它们将分别从 prefix 和 exec_prefix 继承其值。

Py_RunMain() 和 Py_Main() 将修改 sys.path:

如果 run_filename 已设置并且是一个包含 __main__.py 脚本的目录，则会将 run_filename 添加到 sys.path 的开头。

如果 isolated 为零：

如果设置了 run_module，则将当前目录添加到 sys.path 的开头。 如果无法读取当前目录则不执行任何操作。

如果设置了 run_filename，则将文件名的目录添加到 sys.path 的开头。

在其他情况下，则将一个空字符串添加到 sys.path 的开头。

如果 site_import 为非零值，则 sys.path 可通过 site 模块修改。 如果 user_site_directory 为非零值且用户的 site-package 目录存在，则 site 模块会将用户的 site-package 目录附加到 sys.path。

路径配置会使用以下配置文件：

pyvenv.cfg

python._pth (仅Windows)

pybuilddir.txt (仅Unix)

__PYVENV_LAUNCHER__ 环境变量将被用于设置 PyConfig.base_executable

Py_RunMain()

int Py_RunMain(void)

执行在命令行或配置中指定的命令 (PyConfig.run_command)、脚本 (PyConfig.run_filename) 或模块 (PyConfig.run_module)。

在默认情况下如果使用了 -i 选项，则运行 REPL。

最后，终结化 Python 并返回一个可传递给 exit() 函数的退出状态。

请参阅 Python 配置 查看一个使用 Py_RunMain() 在隔离模式下始终运行自定义 Python 的示例。

Py_GetArgcArgv()

void Py_GetArgcArgv(int *argc, wchar_t ***argv)

在 Python 修改原始命令行参数之前，获取这些参数。

另请参阅 PyConfig.orig_argv 成员。

多阶段初始化私有暂定 API

本节介绍的私有暂定 API 引入了多阶段初始化，它是 PEP 432 [https://www.python.org/dev/peps/pep-0432] 的核心特性：

“核心”初始化阶段，“最小化的基本 Python”：

内置类型；

内置异常；

内置和已冻结模块；

sys 模块仅部分初始化（例如: sys.path 尚不存在）。

"主要"初始化阶段，Python 被完全初始化：

安装并配置 importlib；

应用 路径配置；

安装信号处理器；

完成 sys 模块初始化 (例如：创建 sys.stdout 和 sys.path)；

启用 faulthandler 和 tracemalloc 等可选功能；

导入 site 模块；

等等.

私有临时API：

PyConfig._init_main: if set to 0, Py_InitializeFromConfig() stops at the "Core" initialization phase.

PyConfig._isolated_interpreter: if non-zero, disallow threads, subprocesses and fork.

PyStatus _Py_InitializeMain(void)

进入“主要”初始化阶段，完成 Python 初始化。

在“核心”阶段不会导入任何模块，也不会配置 importlib 模块: 路径配置 只会在“主要”阶段期间应用。 这可能允许在 Python 中定制 Python 以覆盖或微调 路径配置，也可能会安装自定义的 sys.meta_path 导入器或导入钩子等等。

It may become possible to calculatin the Path Configuration in Python, after the Core phase and before the Main phase, which is one of the PEP 432 [https://www.python.org/dev/peps/pep-0432] motivation.

“核心”阶段并没有完整的定义：在这一阶段什么应该可用什么不应该可用都尚未被指明。 该 API 被标记为私有和暂定的：也就是说该 API 可以随时被修改甚至被移除直到设计出适用的公共 API。

在“核心”和“主要”初始化阶段之间运行 Python 代码的示例:

void init_python(void)
{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);
    config._init_main = 0;

    /* ... customize 'config' configuration ... */

    status = Py_InitializeFromConfig(&config);
    PyConfig_Clear(&config);
    if (PyStatus_Exception(status)) {
        Py_ExitStatusException(status);
    }

    /* Use sys.stderr because sys.stdout is only created
       by _Py_InitializeMain() */
    int res = PyRun_SimpleString(
        "import sys; "
        "print('Run Python code before _Py_InitializeMain', "
               "file=sys.stderr)");
    if (res < 0) {
        exit(1);
    }

    /* ... put more configuration code here ... */

    status = _Py_InitializeMain();
    if (PyStatus_Exception(status)) {
        Py_ExitStatusException(status);
    }
}

内存管理

概述

在 Python 中，内存管理涉及到一个包含所有 Python 对象和数据结构的私有堆（heap）。这个私有堆的管理由内部的 Python 内存管理器（Python memory manager） 保证。Python 内存管理器有不同的组件来处理各种动态存储管理方面的问题，如共享、分割、预分配或缓存。

在最底层，一个原始内存分配器通过与操作系统的内存管理器交互，确保私有堆中有足够的空间来存储所有与 Python 相关的数据。在原始内存分配器的基础上，几个对象特定的分配器在同一堆上运行，并根据每种对象类型的特点实现不同的内存管理策略。例如，整数对象在堆内的管理方式不同于字符串、元组或字典，因为整数需要不同的存储需求和速度与空间的权衡。因此，Python 内存管理器将一些工作分配给对象特定分配器，但确保后者在私有堆的范围内运行。

Python 堆内存的管理是由解释器来执行，用户对它没有控制权，即使他们经常操作指向堆内内存块的对象指针，理解这一点十分重要。Python 对象和其他内部缓冲区的堆空间分配是由 Python 内存管理器按需通过本文档中列出的 Python/C API 函数进行的。

为了避免内存破坏，扩展的作者永远不应该试图用 C 库函数导出的函数来对 Python 对象进行操作，这些函数包括： malloc(), calloc(), realloc() 和 free()。这将导致 C 分配器和 Python 内存管理器之间的混用，引发严重后果，这是由于它们实现了不同的算法，并在不同的堆上操作。但是，我们可以安全地使用 C 库分配器为单独的目的分配和释放内存块，如下例所示：

PyObject *res;
char *buf = (char *) malloc(BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
...Do some I/O operation involving buf...
res = PyBytes_FromString(buf);
free(buf); /* malloc'ed */
return res;

在这个例子中，I/O 缓冲区的内存请求是由 C 库分配器处理的。Python 内存管理器只参与了分配作为结果返回的字节对象。

然而，在大多数情况下，都建议专门基于 Python 堆来分配内存，因为后者是由 Python 内存管理器控制的。 例如，当解释器使用 C 编写的新对象类型进行扩展时就必须这样做。 使用 Python 堆的另一个理由是需要能 通知 Python 内存管理器有关扩展模块的内存需求。 即使所请求的内存全部只用于内部的、高度特定的目的，将所有的内存请求交给 Python 内存管理器能让解释器对其内存占用的整体情况有更准确的了解。 因此，在特定情况下，Python 内存管理器可能会触发或不触发适当的操作，如垃圾回收、内存压缩或其他的预防性操作。 请注意通过使用前面例子所演示的 C 库分配器，为 I/O 缓冲区分配的内存将完全不受 Python 内存管理器的控制。

参见

环境变量 PYTHONMALLOC 可被用来配置 Python 所使用的内存分配器。

环境变量 PYTHONMALLOCSTATS 可以用来在每次创建和关闭新的 pymalloc 对象区域时打印 pymalloc 内存分配器 的统计数据。

分配器域

所有分配函数都属于三个不同的“分配器域”之一（见 PyMemAllocatorDomain）。这些域代表了不同的分配策略，并为不同目的进行了优化。每个域如何分配内存和每个域调用哪些内部函数的具体细节被认为是实现细节，但是出于调试目的，可以在 此处 找到一张简化的表格。没有硬性要求将属于给定域的分配函数返回的内存，仅用于该域提示的目的（虽然这是推荐的做法）。例如，你可以将 PyMem_RawMalloc() 返回的内存用于分配 Python 对象，或者将 PyObject_Malloc() 返回的内存用作缓冲区。

三个分配域分别是：

原始域：用于为通用内存缓冲区分配内存，分配*必须*转到系统分配器并且分配器可以在没有 GIL 的情况下运行。内存直接请求自系统。

"Mem" 域：用于为 Python 缓冲区和通用内存缓冲区分配内存，分配时必须持有 GIL。内存取自于 Python 私有堆。

对象域：用于分配属于 Python 对象的内存。内存取自于 Python 私有堆。

当释放属于给定域的分配函数先前分配的内存时，必须使用对应的释放函数。例如，PyMem_Free() 来释放 PyMem_Malloc() 分配的内存。

原始内存接口

以下函数集封装了系统分配器。这些函数是线程安全的，不需要持有 全局解释器锁。

default raw memory allocator 使用这些函数：malloc()、 calloc()、 realloc() 和 free()；申请零字节时则调用 malloc(1) （或 calloc(1, 1)）

3.4 新版功能.

void *PyMem_RawMalloc(size_t n)

分配 n 个字节并返回一个指向所分配内存的 void* 类型指针，如果请求失败则返回 NULL。

请求零字节可能返回一个独特的非 NULL 指针，就像调用了 PyMem_RawMalloc(1) 一样。但是内存不会以任何方式被初始化。

void *PyMem_RawCalloc(size_t nelem, size_t elsize)

分配 nelem 个元素，每个元素的大小为 elsize 个字节，并返回指向所分配的内存的 void* 类型指针，如果请求失败则返回 NULL。 内存会被初始化为零。

请求零字节可能返回一个独特的非 NULL 指针，就像调用了 PyMem_RawCalloc(1, 1) 一样。

3.5 新版功能.

void *PyMem_RawRealloc(void *p, size_t n)

将 p 指向的内存块大小调整为 n 字节。以新旧内存块大小中的最小值为准，其中内容保持不变，

如果 p 是 NULL ，则相当于调用 PyMem_RawMalloc(n) ；如果 n 等于 0，则内存块大小会被调整，但不会被释放，返回非 NULL 指针。

除非 p 是 NULL ，否则它必须是之前调用 PyMem_RawMalloc() 、 PyMem_RawRealloc() 或 PyMem_RawCalloc() 所返回的。

如果请求失败，PyMem_RawRealloc() 返回 NULL ， p 仍然是指向先前内存区域的有效指针。

void PyMem_RawFree(void *p)

释放 p 指向的内存块。 p 必须是之前调用 PyMem_RawMalloc() 、 PyMem_RawRealloc() 或 PyMem_RawCalloc() 所返回的指针。否则，或在 PyMem_RawFree(p) 之前已经调用过的情况下，未定义的行为会发生。

如果 p 是 NULL, 那么什么操作也不会进行。

内存接口

以下函数集，仿照 ANSI C 标准，并指定了请求零字节时的行为，可用于从Python堆分配和释放内存。

默认内存分配器 使用了 pymalloc 内存分配器.

警告

在使用这些函数时，必须持有 全局解释器锁（GIL） 。

在 3.6 版更改: 现在默认的分配器是 pymalloc 而非系统的 malloc() 。

void *PyMem_Malloc(size_t n)

Part of the Stable ABI.

分配 n 个字节并返回一个指向所分配内存的 void* 类型指针，如果请求失败则返回 NULL。

请求零字节可能返回一个独特的非 NULL 指针，就像调用了 PyMem_Malloc(1) 一样。但是内存不会以任何方式被初始化。

void *PyMem_Calloc(size_t nelem, size_t elsize)

Part of the Stable ABI since version 3.7.

分配 nelem 个元素，每个元素的大小为 elsize 个字节，并返回指向所分配的内存的 void* 类型指针，如果请求失败则返回 NULL。 内存会被初始化为零。

请求零字节可能返回一个独特的非 NULL 指针，就像调用了 PyMem_Calloc(1, 1) 一样。

3.5 新版功能.

void *PyMem_Realloc(void *p, size_t n)

Part of the Stable ABI.

将 p 指向的内存块大小调整为 n 字节。以新旧内存块大小中的最小值为准，其中内容保持不变，

如果 p 是 NULL ，则相当于调用 PyMem_Malloc(n) ；如果 n 等于 0，则内存块大小会被调整，但不会被释放，返回非 NULL 指针。

除非 p 是 NULL ，否则它必须是之前调用 PyMem_Malloc() 、 PyMem_Realloc() 或 PyMem_Calloc() 所返回的。

如果请求失败，PyMem_Realloc() 返回 NULL ， p 仍然是指向先前内存区域的有效指针。

void PyMem_Free(void *p)

Part of the Stable ABI.

释放 p 指向的内存块。 p 必须是之前调用 PyMem_Malloc() 、 PyMem_Realloc() 或 PyMem_Calloc() 所返回的指针。否则，或在 PyMem_Free(p) 之前已经调用过的情况下，未定义的行为会发生。

如果 p 是 NULL, 那么什么操作也不会进行。

以下面向类型的宏为方便而提供。 注意 TYPE 可以指任何 C 类型。

TYPE *PyMem_New(TYPE, size_t n)

与 PyMem_Malloc() 相同，但会分配 (n * sizeof(TYPE)) 字节的内存。 返回一个转换为 TYPE* 的指针。 内存将不会以任何方式被初始化。

TYPE *PyMem_Resize(void *p, TYPE, size_t n)

与 PyMem_Realloc() 相同，但内存块的大小被调整为 (n * sizeof(TYPE)) 字节。 返回一个转换为 TYPE* 的指针。 在返回时，p 将为一个指向新内存区域的指针，如果执行失败则为 NULL。

这是一个 C 预处理宏， p 总是被重新赋值。请保存 p 的原始值，以避免在处理错误时丢失内存。

void PyMem_Del(void *p)

与 PyMem_Free() 相同

此外，我们还提供了以下宏集用于直接调用 Python 内存分配器，而不涉及上面列出的 C API 函数。但是请注意，使用它们并不能保证跨 Python 版本的二进制兼容性，因此在扩展模块被弃用。

PyMem_MALLOC(size)

PyMem_NEW(type, size)

PyMem_REALLOC(ptr, size)

PyMem_RESIZE(ptr, type, size)

PyMem_FREE(ptr)

PyMem_DEL(ptr)

对象分配器

以下函数集，仿照 ANSI C 标准，并指定了请求零字节时的行为，可用于从Python堆分配和释放内存。

注解

当通过 自定义内存分配器 部分描述的方法拦截该域中的分配函数时，无法保证这些分配器返回的内存可以被成功地转换成 Python 对象。

默认对象分配器 使用 pymalloc 内存分配器.

警告

在使用这些函数时，必须持有 全局解释器锁（GIL） 。

void *PyObject_Malloc(size_t n)

Part of the Stable ABI.

分配 n 个字节并返回一个指向所分配内存的 void* 类型指针，如果请求失败则返回 NULL。

请求零字节可能返回一个独特的非 NULL 指针，就像调用了 PyObject_Malloc(1) 一样。但是内存不会以任何方式被初始化。

void *PyObject_Calloc(size_t nelem, size_t elsize)

Part of the Stable ABI since version 3.7.

分配 nelem 个元素，每个元素的大小为 elsize 个字节，并返回指向所分配的内存的 void* 类型指针，如果请求失败则返回 NULL。 内存会被初始化为零。

请求零字节可能返回一个独特的非 NULL 指针，就像调用了 PyObject_Calloc(1, 1) 一样。

3.5 新版功能.

void *PyObject_Realloc(void *p, size_t n)

Part of the Stable ABI.

将 p 指向的内存块大小调整为 n 字节。以新旧内存块大小中的最小值为准，其中内容保持不变，

如果*p*是 NULL，则相当于调用 PyObject_Malloc(n) ；如果 n 等于 0，则内存块大小会被调整，但不会被释放，返回非 NULL 指针。

除非 p 是 NULL ，否则它必须是之前调用 PyObject_Malloc() 、 PyObject_Realloc() 或 PyObject_Calloc() 所返回的。

如果请求失败，PyObject_Realloc() 返回 NULL ， p 仍然是指向先前内存区域的有效指针。

void PyObject_Free(void *p)

Part of the Stable ABI.

释放 p 指向的内存块。 p 必须是之前调用 PyObject_Malloc() 、 PyObject_Realloc() 或 PyObject_Calloc() 所返回的指针。否则，或在 PyObject_Free(p) 之前已经调用过的情况下，未定义行为会发生。

如果 p 是 NULL, 那么什么操作也不会进行。

默认内存分配器

默认内存分配器：

配置 | 名称 | PyMem_RawMalloc | PyMem_Malloc | PyObject_Malloc
发布版本 | "pymalloc" | malloc | pymalloc | pymalloc
调试构建 | "pymalloc_debug" | malloc + debug | pymalloc + debug | pymalloc + debug
没有 pymalloc 的发布版本 | "malloc" | malloc | malloc | malloc
没有 pymalloc 的调试构建 | "malloc_debug" | malloc + debug | malloc + debug | malloc + debug

说明：

名称：PYTHONMALLOC 环境变量的值。

malloc：来自 C 标准库的系统分配器，C 函数：malloc()、calloc()、realloc() 和 free()。

pymalloc：pymalloc 内存分配器.

"+ debug": 附带 Python 内存分配器的调试钩子.

“调试构建”：调试模式下的 Python 构建。

自定义内存分配器

3.4 新版功能.

type PyMemAllocatorEx

用于描述内存块分配器的结构体。 该结构体下列字段:

域 | 含意
void *ctx | 作为第一个参数传入的用户上下文
void* malloc(void *ctx, size_t size) | 分配一个内存块
void* calloc(void *ctx, size_t nelem, size_t elsize) | 分配一个初始化为 0 的内存块
void* realloc(void *ctx, void *ptr, size_t new_size) | 分配一个内存块或调整其大小
void free(void *ctx, void *ptr) | 释放一个内存块

在 3.5 版更改: The PyMemAllocator structure was renamed to PyMemAllocatorEx and a new calloc field was added.

type PyMemAllocatorDomain

用来识别分配器域的枚举类。域有：

PYMEM_DOMAIN_RAW

函数

PyMem_RawMalloc()

PyMem_RawRealloc()

PyMem_RawCalloc()

PyMem_RawFree()

PYMEM_DOMAIN_MEM

函数

PyMem_Malloc(),

PyMem_Realloc()

PyMem_Calloc()

PyMem_Free()

PYMEM_DOMAIN_OBJ

函数

PyObject_Malloc()

PyObject_Realloc()

PyObject_Calloc()

PyObject_Free()

void PyMem_GetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

获取指定域的内存块分配器。

void PyMem_SetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

设置指定域的内存块分配器。

当请求零字节时，新的分配器必须返回一个独特的非 NULL 指针。

对于 PYMEM_DOMAIN_RAW 域，分配器必须是线程安全的：当分配器被调用时，不持有 全局解释器锁 。

如果新的分配器不是钩子（不调用之前的分配器），必须调用 PyMem_SetupDebugHooks() 函数在新分配器上重新安装调试钩子。

警告

PyMem_SetAllocator() 没有以下合约:

可以在 Py_PreInitialize() 之后 Py_InitializeFromConfig() 之前调用它来安装自定义的内存分配器。 对于所安装的分配器除了域的规定以外没有任何其他限制（例如 Raw Domain 允许分配器在不持有 GIL 的情况下被调用）。 请参阅 有关分配器域的章节 来了解详情。

如果在 Python 已完成初始化之后（即 Py_InitializeFromConfig() 被调用之后）被调用则自定义分配器 must 必须包装现有的分配器。 将现有分配器替换为任意的其他分配器是 不受支持的。

void PyMem_SetupDebugHooks(void)

设置 Python 内存分配器的调试钩子 以检测内存错误。

Python 内存分配器的调试钩子

当 Python 在调试模式下构建，PyMem_SetupDebugHooks() 函数在 Python 预初始化 时被调用，以在 Python 内存分配器上设置调试钩子以检测内存错误。

PYTHONMALLOC 环境变量可被用于在以发行模式下编译的 Python 上安装调试钩子（例如：PYTHONMALLOC=debug）。

PyMem_SetupDebugHooks() 函数可被用于在调用了 PyMem_SetAllocator() 之后设置调试钩子。

这些调试钩子用特殊的、可辨认的位模式填充动态分配的内存块。新分配的内存用字节 0xCD （PYMEM_CLEANBYTE ）填充，释放的内存用字节 0xDD （PYMEM_DEADBYTE ）填充。内存块被填充了字节 0xFD （PYMEM_FORBIDDENBYTE ）的“禁止字节”包围。这些字节串不太可能是合法的地址、浮点数或ASCII字符串

运行时检查：

检测对 API 的违反。例如：检测对 PyMem_Malloc() 分配的内存块调用 PyObject_Free()。

检测缓冲区起始位置前的写入（缓冲区下溢）。

检测缓冲区终止位置后的写入（缓冲区溢出）。

检测当调用 PYMEM_DOMAIN_OBJ (如: PyObject_Malloc()) 和 PYMEM_DOMAIN_MEM (如: PyMem_Malloc()) 域的分配器函数时 GIL 已被持有。

在出错时，调试钩子使用 tracemalloc 模块来回溯内存块被分配的位置。只有当 tracemalloc 正在追踪 Python 内存分配，并且内存块被追踪时，才会显示回溯。

让 S = sizeof(size_t)。 将 2*S 个字节添加到每个被请求的 N 字节数据块的两端。 内存的布局像是这样，其中 p 代表由类似 malloc 或类似 realloc 的函数所返回的地址 (p[i:j] 表示从 *(p+i) 左侧开始到 *(p+j) 左侧止的字节数据切片；请注意对负索引号的处理与 Python 切片是不同的）:

p[-2*S:-S]

最初所要求的字节数。 这是一个 size_t，为大端序（易于在内存转储中读取）。

p[-S]

API 标识符（ASCII 字符）:

'r' 表示 PYMEM_DOMAIN_RAW。

'm' 表示 PYMEM_DOMAIN_MEM。

'o' 表示 PYMEM_DOMAIN_OBJ。

p[-S+1:0]

PYMEM_FORBIDDENBYTE 的副本。 用于捕获下层的写入和读取。

p[0:N]

所请求的内存，用 PYMEM_CLEANBYTE 的副本填充，用于捕获对未初始化内存的引用。 当调用 realloc 之类的函数来请求更大的内存块时，额外新增的字节也会用 PYMEM_CLEANBYTE 来填充。 当调用 free 之类的函数时，这些字节会用 PYMEM_DEADBYTE 来重写，以捕获对已释放内存的引用。 当调用 realloc 之类的函数来请求更小的内存块时，多余的旧字节也会用 PYMEM_DEADBYTE 来填充。

p[N:N+S]

PYMEM_FORBIDDENBYTE 的副本。 用于捕获超限的写入和读取。

p[N+S:N+2*S]

仅当定义了 PYMEM_DEBUG_SERIALNO 宏时会被使用（默认情况下将不定义）。

一个序列号，每次调用 malloc 之类或 realloc 之类的函数时自增 1。 大端序的 size_t。 如果之后检测到了“被破坏的内存”，此序列号提供了一个很好的手段用来在下次运行时设置中断点，以捕获该内存块被破坏的瞬间。 obmalloc.c 中的静态函数 bumpserialno() 是此序列号会发生自增的唯一地方，它的存在使你可以方便地设置这样的中断点。

一个 realloc 之类或 free 之类的函数会先检查两端的 PYMEM_FORBIDDENBYTE 字节是否完好。 如果它们被改变了，则会将诊断输出写入到 stderr，并且程序将通过 Py_FatalError() 中止。 另一种主要的失败模式是当程序读到某种特殊的比特模式并试图将其用作地址时触发内存错误。 如果你随即进入调试器并查看该对象，你很可能会看到它已完全被填充为 PYMEM_DEADBYTE (意味着已释放的内存被使用) 或 PYMEM_CLEANBYTE (意味着未初始货摊内存被使用)。

在 3.6 版更改: PyMem_SetupDebugHooks() 函数现在也能在使用发布模式编译的 Python 上工作。 当发生错误时，调试钩子现在会使用 tracemalloc 来获取已分配内存块的回溯信息。 调试钩子现在还会在 PYMEM_DOMAIN_OBJ 和 PYMEM_DOMAIN_MEM 作用域的函数被调用时检查是否持有 GIL。

在 3.8 版更改: 字节模式 0xCB (PYMEM_CLEANBYTE)、 0xDB (PYMEM_DEADBYTE) 和 0xFB (PYMEM_FORBIDDENBYTE) 已被 0xCD 、 0xDD 和 0xFD 替代以使用与 Windows CRT 调试 malloc() 和 free() 相同的值。

pymalloc 分配器

Python 有为具有短生命周期的小对象（小于或等于 512 字节）优化的 pymalloc 分配器。它使用固定大小为 256 KiB 的称为 "arenas" 的内存映射。对于大于512字节的分配，它回到使用 PyMem_RawMalloc() 和 PyMem_RawRealloc() 。

pymalloc 是 PYMEM_DOMAIN_MEM (例如: PyMem_Malloc()) 和 PYMEM_DOMAIN_OBJ (例如: PyObject_Malloc()) 域的 默认分配器 。

arena 分配器使用以下函数：

Windows 上的 VirtualAlloc() 和 VirtualFree() ,

mmap() 和 munmap() ，如果可用，

否则， malloc() 和 free() 。

如果 Python 配置了 --without-pymalloc 选项，那么此分配器将被禁用。也可以在运行时使用 PYTHONMALLOC`（例如：``PYTHONMALLOC=malloc`）环境变量来禁用它。

自定义 pymalloc Arena 分配器

3.4 新版功能.

type PyObjectArenaAllocator

用来描述一个 arena 分配器的结构体。这个结构体有三个字段：

域 | 含意
void *ctx | 作为第一个参数传入的用户上下文
void* alloc(void *ctx, size_t size) | 分配一块 size 字节的区域
void free(void *ctx, void *ptr, size_t size) | 释放一块区域

void PyObject_GetArenaAllocator(PyObjectArenaAllocator *allocator)

获取 arena 分配器

void PyObject_SetArenaAllocator(PyObjectArenaAllocator *allocator)

设置 arena 分配器

tracemalloc C API

3.7 新版功能.

int PyTraceMalloc_Track(unsigned int domain, uintptr_t ptr, size_t size)

在 tracemalloc 模块中跟踪一个已分配的内存块。

成功时返回 0，出错时返回 -1 (无法分配内存来保存跟踪信息)。 如果禁用了 tracemalloc 则返回 -2。

如果内存块已被跟踪，则更新现有跟踪信息。

int PyTraceMalloc_Untrack(unsigned int domain, uintptr_t ptr)

在 tracemalloc 模块中取消跟踪一个已分配的内存块。 如果内存块未被跟踪则不执行任何操作。

如果 tracemalloc 被禁用则返回 -2，否则返回 0。

例子

以下是来自 概述 小节的示例，经过重写以使 I/O 缓冲区是通过使用第一个函数集从 Python 堆中分配的:

PyObject *res;
char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Do some I/O operation involving buf... */
res = PyBytes_FromString(buf);
PyMem_Free(buf); /* allocated with PyMem_Malloc */
return res;

使用面向类型函数集的相同代码:

PyObject *res;
char *buf = PyMem_New(char, BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Do some I/O operation involving buf... */
res = PyBytes_FromString(buf);
PyMem_Del(buf); /* allocated with PyMem_New */
return res;

请注意在以上两个示例中，缓冲区总是通过归属于相同集的函数来操纵的。 事实上，对于一个给定的内存块必须使用相同的内存 API 族，以便使得混合不同分配器的风险减至最低。 以下代码序列包含两处错误，其中一个被标记为 fatal 因为它混合了两种在不同堆上操作的不同分配器。

char *buf1 = PyMem_New(char, BUFSIZ);
char *buf2 = (char *) malloc(BUFSIZ);
char *buf3 = (char *) PyMem_Malloc(BUFSIZ);
...
PyMem_Del(buf3);  /* Wrong -- should be PyMem_Free() */
free(buf2);       /* Right -- allocated via malloc() */
free(buf1);       /* Fatal -- should be PyMem_Del()  */

除了旨在处理来自 Python 堆的原始内存块的函数之外， Python 中的对象是通过 PyObject_New(), PyObject_NewVar() 和 PyObject_Del() 来分配和释放的。

这些将在有关如何在 C 中定义和实现新对象类型的下一章中讲解。

对象实现支持

本章描述了定义新对象类型时所使用的函数、类型和宏。

在堆上分配对象

公用对象结构体

基本的对象类型和宏

实现函数和方法

访问扩展类型的属性

类型对象

快速参考

"tp 槽位"

子槽位

槽位 typedef

PyTypeObject 定义

PyObject 槽位

PyVarObject 槽位

PyTypeObject 槽

静态类型

堆类型

数字对象结构体

映射对象结构体

序列对象结构体

缓冲区对象结构体

异步对象结构体

槽位类型 typedef

例子

使对象类型支持循环垃圾回收

控制垃圾回收器状态

在堆上分配对象

PyObject *_PyObject_New(PyTypeObject *type)

返回值：新的引用。

PyVarObject *_PyObject_NewVar(PyTypeObject *type, Py_ssize_t size)

返回值：新的引用。

PyObject *PyObject_Init(PyObject *op, PyTypeObject *type)

返回值：借入的引用。 Part of the Stable ABI.

用它的类型和初始引用来初始化新分配对象 op。返回已初始化的对象。如果 type 明该对象参与循环垃圾检测器，则将其添加到检测器的观察对象集中。 对象的其他字段不受影响。

PyVarObject *PyObject_InitVar(PyVarObject *op, PyTypeObject *type, Py_ssize_t size)

返回值：借入的引用。 Part of the Stable ABI.

它的功能和 PyObject_Init() 一样，并且会初始化变量大小对象的长度信息。

TYPE *PyObject_New(TYPE, PyTypeObject *type)

返回值：新的引用。

Allocate a new Python object using the C structure type TYPE and the Python type object type. Fields not defined by the Python object header are not initialized. The caller will own the only reference to the object (i.e. its reference count will be one). The size of the memory allocation is determined from the tp_basicsize field of the type object.

TYPE *PyObject_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size)

返回值：新的引用。

使用C的数据结构类型 TYPE 和Python的类型对象 type 分配一个新的Python对象。Python对象头文件中没有定义的字段不会被初始化。被分配的内存空间预留了 TYPE 结构加 type 对象中 tp_itemsize 字段提供的 size 字段的值。这对于实现类似元组这种能够在构造期决定自己大小的对象是很实用的。将字段的数组嵌入到相同的内存分配中可以减少内存分配的次数，这提高了内存分配的效率。

void PyObject_Del(void *op)

释放由 PyObject_New() 或者 PyObject_NewVar() 分配内存的对象。这通常由对象的type字段定义的 tp_dealloc 处理函数来调用。调用这个函数以后op对象中的字段都不可以被访问，因为原分配的内存空间已不再是一个有效的Python对象。

PyObject _Py_NoneStruct

这个对象是像 None 一样的 Python 对象。它可以使用 Py_None 宏访问，该宏的拿到指向该对象的指针。

参见

PyModule_Create()

分配内存和创建扩展模块

公用对象结构体

大量的结构体被用于定义Python的对象类型。这一节描述了这些的结构体和它们的使用方法。

基本的对象类型和宏

所有的 Python 对象都在对象的内存表示的开始部分共享少量的字段。 这些字段用 PyObject 或 PyVarObject 类型来表示，这些类型又由一些宏定义，这些宏也直接或间接地用于所有其他 Python 对象的定义。

type PyObject

Part of the Limited API. (Only some members are part of the stable ABI.)

所有对象类型都是此类型的扩展。 这是一个包含了 Python 将对象的指针当作对象来处理所需的信息的类型。 在一个普通的“发行”编译版中，它只包含对象的引用计数和指向对应类型对象的指针。 没有什么对象被实际声明为 PyObject，但每个指向 Python 对象的指针都可以被转换为 PyObject*。 对成员的访问必须通过使用 Py_REFCNT 和 Py_TYPE 宏来完成。

type PyVarObject

Part of the Limited API. (Only some members are part of the stable ABI.)

这是一个 PyObject 的添加了 ob_size 字段的扩展。 它仅用于具有某种 长度 标记的对象。 此类型并不经常在 Python/C API 中出现。 对成员的访问必须通过使用 Py_REFCNT, Py_TYPE 和 Py_SIZE 宏来完成。

PyObject_HEAD

这是一个在声明代表无可变长度对象的新类型时所使用的宏。 PyObject_HEAD 宏被扩展为:

PyObject ob_base;

参见上面 PyObject 的文档。

PyObject_VAR_HEAD

这是一个在声明代表每个实例具有可变长度的对象时所使用的宏。 PyObject_VAR_HEAD 宏被扩展为:

PyVarObject ob_base;

参见上面 PyVarObject 的文档。

int Py_Is(const PyObject *x, const PyObject *y)

Part of the Stable ABI since version 3.10.

测试 x 是否为 y 对象，与 Python 中的 x is y 相同。

3.10 新版功能.

int Py_IsNone(const PyObject *x)

Part of the Stable ABI since version 3.10.

测试一个对象是否为 None 单例，与 Python 中的 x is None 相同。

3.10 新版功能.

int Py_IsTrue(const PyObject *x)

Part of the Stable ABI since version 3.10.

测试一个对象是否为 True 单例，与 Python 中的 x is True 相同。

3.10 新版功能.

int Py_IsFalse(const PyObject *x)

Part of the Stable ABI since version 3.10.

测试一个对象是否为 False 单例，与 Python 中的 x is False 相同。

3.10 新版功能.

PyTypeObject *Py_TYPE(const PyObject *o)

获取 Python 对象 o 的类型。

返回一个 borrowed reference。

使用 Py_SET_TYPE() 函数来设置一个对象类型。

int Py_IS_TYPE(PyObject *o, PyTypeObject *type)

如果对象 o 的类型为 type 则返回非零值。 否则返回零。 等价于: Py_TYPE(o) == type。

3.9 新版功能.

void Py_SET_TYPE(PyObject *o, PyTypeObject *type)

将对象 o 的类型设为 type。

3.9 新版功能.

Py_ssize_t Py_REFCNT(const PyObject *o)

获取 Python 对象 o 的引用计数。

在 3.10 版更改: Py_REFCNT() is changed to the inline static function. Use Py_SET_REFCNT() to set an object reference count.

void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)

将对象 o 的引用计数器设为 refcnt。

3.9 新版功能.

Py_ssize_t Py_SIZE(const PyVarObject *o)

获取 Python 对象 o 的大小。

使用 Py_SET_SIZE() 函数来设置一个对象大小。

void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)

将对象 o 的大小设为 size。

3.9 新版功能.

PyObject_HEAD_INIT(type)

这是一个为新的 PyObject 类型扩展初始化值的宏。 该宏扩展为:

_PyObject_EXTRA_INIT
1, type,

PyVarObject_HEAD_INIT(type, size)

这是一个为新的 PyVarObject 类型扩展初始化值的宏，包括 ob_size 字段。 该宏扩展为:

_PyObject_EXTRA_INIT
1, type, size,

实现函数和方法

type PyCFunction

Part of the Stable ABI.

用于在 C 中实现大多数 Python 可调用对象的函数类型。 该类型的函数接受两个 PyObject* 形参并返回一个这样的值。 如果返回值为 NULL，则将设置一个异常。 如果不为 NULL，则返回值将被解读为 Python 中暴露的函数的返回值。 此函数必须返回一个新的引用。

函数的签名为:

PyObject *PyCFunction(PyObject *self,
                      PyObject *args);

type PyCFunctionWithKeywords

Part of the Stable ABI.

用于在 C 中实现具有 METH_VARARGS | METH_KEYWORDS 签名的 Python 可调用对象的函数类型。 函数的签名为:

PyObject *PyCFunctionWithKeywords(PyObject *self,
                                  PyObject *args,
                                  PyObject *kwargs);

type _PyCFunctionFast

用于在 C 中实现具有 METH_FASTCALL 签名的 Python 可调用对象的函数类型。 函数的签名为:

PyObject *_PyCFunctionFast(PyObject *self,
                           PyObject *const *args,
                           Py_ssize_t nargs);

type _PyCFunctionFastWithKeywords

用于在 C 中实现具有 METH_FASTCALL | METH_KEYWORDS 签名的 Python 可调用对象的函数类型。 函数的签名为:

PyObject *_PyCFunctionFastWithKeywords(PyObject *self,
                                       PyObject *const *args,
                                       Py_ssize_t nargs,
                                       PyObject *kwnames);

type PyCMethod

用于在 C 中实现具有 METH_METHOD | METH_FASTCALL | METH_KEYWORDS 签名的 Python 可调用对象的函数类型。 函数的签名为:

PyObject *PyCMethod(PyObject *self,
                    PyTypeObject *defining_class,
                    PyObject *const *args,
                    Py_ssize_t nargs,
                    PyObject *kwnames)

3.9 新版功能.

type PyMethodDef

Part of the Stable ABI (including all members).

用于描述一个扩展类型的方法的结构体。 该结构体有四个字段:

const char *ml_name

方法名

PyCFunction ml_meth

指向 C 实现的指针

int ml_flags

flags bits indicating how the call should be constructed

const char *ml_doc

指向文档字符串的内容

The ml_meth is a C function pointer. The functions may be of different types, but they always return PyObject*. If the function is not of the PyCFunction, the compiler will require a cast in the method table. Even though PyCFunction defines the first parameter as PyObject*, it is common that the method implementation uses the specific C type of the self object.

The ml_flags field is a bitfield which can include the following flags. The individual flags indicate either a calling convention or a binding convention.

调用惯例有如下这些:

METH_VARARGS

这是典型的调用惯例，其中方法的类型为 PyCFunction。 该函数接受两个 PyObject* 值。 第一个是用于方法的 self 对象；对于模块函数，它将为模块对象。 第二个形参 (常被命名为 args) 是一个代表所有参数的元组对象。 该形参通常是使用 PyArg_ParseTuple() 或 PyArg_UnpackTuple() 来处理的。

METH_VARARGS | METH_KEYWORDS

带有这些旗标的方法必须为 PyCFunctionWithKeywords 类型。 该函数接受三个形参: self, args, kwargs 其中 kwargs 是一个包含所有关键字参数的字典或者如果没有关键字参数则可以为 NULL。 这些形参通常是使用 PyArg_ParseTupleAndKeywords() 来处理的。

METH_FASTCALL

快速调用惯例仅支持位置参数。 这些方法的类型为 _PyCFunctionFast。 第一个形参为 self，第二个形参是由表示参数的 PyObject* 值组成的数组而第三个形参是参数的数量（数组的长度）。

3.7 新版功能.

在 3.10 版更改: METH_FASTCALL is now part of the stable ABI.

METH_FASTCALL | METH_KEYWORDS

Extension of METH_FASTCALL supporting also keyword arguments, with methods of type _PyCFunctionFastWithKeywords. Keyword arguments are passed the same way as in the vectorcall protocol: there is an additional fourth PyObject* parameter which is a tuple representing the names of the keyword arguments (which are guaranteed to be strings) or possibly NULL if there are no keywords. The values of the keyword arguments are stored in the args array, after the positional arguments.

3.7 新版功能.

METH_METHOD | METH_FASTCALL | METH_KEYWORDS

METH_FASTCALL | METH_KEYWORDS 的扩展支持 定义式类，也就是包含相应方法的类。 定义式类可以是 Py_TYPE(self) 的超类。

该方法必须为 PyCMethod 类型，与在 self 之后添加了 defining_class 参数的 METH_FASTCALL | METH_KEYWORDS 一样。

3.9 新版功能.

METH_NOARGS

没有形参的方法如果通过 METH_NOARGS 旗标列出了参数则不需要检查是否提供了参数。 它们必须为 PyCFunction 类型。 第一个形参通常命名为 self 并将存放一个指向模块或对象实例的引用。 在所有情况下第二个形参都将为 NULL。

METH_O

Methods with a single object argument can be listed with the METH_O flag, instead of invoking PyArg_ParseTuple() with a "O" argument. They have the type PyCFunction, with the self parameter, and a PyObject* parameter representing the single argument.

这两个常量不是被用来指明调用惯例而是在配合类方法使用时指明绑定。 它们不会被用于在模块上定义的函数。 对于任何给定方法这些旗标最多只会设置其中一个。

METH_CLASS

该方法将接受类型对象而不是类型的实例作为第一个形参。 它会被用于创建 类方法，类似于使用 classmethod() 内置函数所创建的结果。

METH_STATIC

该方法将接受 NULL 而不是类型的实例作为第一个形参。 它会被用于创建 静态方法，类似于使用 staticmethod() 内置函数所创建的结果。

另一个常量控制方法是否将被载入来替代具有相同方法名的另一个定义。

METH_COEXIST

该方法将被载入来替代现有的定义。 如果没有 METH_COEXIST，默认将跳过重复的定义。 由于槽位包装器会在方法表之前被载入，例如当存在 sq_contains 槽位时，将会生成一个名为 __contains__() 的已包装方法并阻止载入具有相同名称的对应 PyCFunction。 如果定义了此旗标，则 PyCFunction 将被载入来替代此包装器对象并将与槽位共存。 因为对This is helpful because calls to PyCFunctions 的调用比包装器对象调用更为优化所以这是很有帮助的。

访问扩展类型的属性

type PyMemberDef

Part of the Stable ABI (including all members).

描述与某个 C 结构体成员相对应的类型的属性的结构体。 它的字段有:

域 | C 类型 | 含意
name | const char * | 成员名称
type | int | C 结构体中成员的类型
offset | Py_ssize_t | 成员在类型的对象结构体中所在位置的以字节表示的偏移量
flags | int | 指明字段是否应为只读或可写的旗标位
doc | const char * | 指向文档字符串的内容

type 可以是与各种 C 类型相对应的许多 T_ 宏中的一个。 当在 Python 中访问该成员时，它将被转换为等价的 Python 类型。

宏名称 | C 类型
T_SHORT | short
T_INT | int
T_LONG | 长整型
T_FLOAT | float
T_DOUBLE | double
T_STRING | const char *
T_OBJECT | PyObject *
T_OBJECT_EX | PyObject *
T_CHAR | char
T_BYTE | char
T_UBYTE | unsigned char
T_UINT | unsigned int
T_USHORT | unsigned short
T_ULONG | unsigned long
T_BOOL | char
T_LONGLONG | long long
T_ULONGLONG | unsigned long long
T_PYSSIZET | Py_ssize_t

T_OBJECT 和 T_OBJECT_EX 的区别在于 T_OBJECT 返回 None 表示其成员为 NULL 并且 T_OBJECT_EX 引发了 AttributeError。 请尝试使用 T_OBJECT_EX 取代 T_OBJECT 因为 T_OBJECT_EX 处理在属性上使用 del 语句比 T_OBJECT 更正确。

flags 可以为 0 表示读写访问或 READONLY 表示只读访问。 使用 T_STRING 作为 type 表示 READONLY。 T_STRING 数据将被解读为 UTF-8 编码格式。 只有 T_OBJECT 和 T_OBJECT_EX 成员可以被删除。 (它们会被设为 NULL)。

堆分配类型 (使用 PyType_FromSpec() 或类似函数创建), PyMemberDef 可以包含特殊成员 __dictoffset__, __weaklistoffset__ 和 __vectorcalloffset__ 的定义，对应类型对象中的 tp_dictoffset, tp_weaklistoffset 和 tp_vectorcall_offset。 它们必须使用 T_PYSSIZET 和 READONLY 来定义，例如:

static PyMemberDef spam_type_members[] = {
    {"__dictoffset__", T_PYSSIZET, offsetof(Spam_object, dict), READONLY},
    {NULL}  /* Sentinel */
};

PyObject *PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)

获取属于地址Get an attribute belonging to the object at address obj_addr 上的对象的某个属性。 该属性是以 PyMemberDef m 来描述的。 出错时返回 NULL。

int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)

将属于位于地址 obj_addr 的对象的属性设置到对象 o。 要设置的属性由 PyMemberDef m 描述。 成功时返回 0 而失败时返回负值。

type PyGetSetDef

Part of the Stable ABI (including all members).

用于定义针对某个类型的特征属性式的访问的结构体。 另请参阅 PyTypeObject.tp_getset 槽位的描述。

域 | C 类型 | 含意
name | const char * | 属性名称
get | getter | 用于获取属性的 C 函数
set | setter | 用于设置或删除属性的可选 C 函数，如果省略则属性将为只读
doc | const char * | 可选的文档字符串
closure | void * | 可选的函数指针，为 getter 和 setter 提供附加数据

get 函数接受一个 PyObject* 形参 (实例) 和一个函数指针 (关联的 closure):

typedef PyObject *(*getter)(PyObject *, void *);

它应当在成功时返回一个新的引用或在失败时返回 NULL 并设置异常。

set 函数接受两个 PyObject* 形参 (实例和要设置的值) 和一个函数指针 (关联的 closure):

typedef int (*setter)(PyObject *, PyObject *, void *);

对于属性要被删除的情况第二个形参应为 NULL。 成功时应返回 0 或在失败时返回 -1 并设置异常。

类型对象

Python 对象系统中最重要的一个结构体也许是定义新类型的结构体: PyTypeObject 结构体。 类型对象可以使用任何 PyObject_* 或 PyType_* 函数来处理，但并未提供大多数 Python 应用程序会感兴趣的东西。 这些对象是对象行为的基础，所以它们对解释器本身及任何实现新类型的扩展模块都非常重要。

与大多数标准类型相比，类型对象相当大。这么大的原因是每个类型对象存储了大量的值，大部分是C函数指针，每个指针实现了类型功能的一小部分。本节将详细描述类型对象的字段。这些字段将按照它们在结构中出现的顺序进行描述。

除了下面的快速参考， 例子 小节提供了快速了解 PyTypeObject 的含义和用法的例子。

快速参考

"tp 槽位"

PyTypeObject 槽位 1 | 类型 | 特殊方法/属性 | 信息 2
O | T | D | I
<R> tp_name | const char * | __name__ | X | X |  |
tp_basicsize | Py_ssize_t |  | X | X |  | X
tp_itemsize | Py_ssize_t |  |  | X |  | X
tp_dealloc | destructor |  | X | X |  | X
tp_vectorcall_offset | Py_ssize_t |  |  | X |  | X
(tp_getattr) | getattrfunc | __getattribute__, __getattr__ |  |  |  | G
(tp_setattr) | setattrfunc | __setattr__, __delattr__ |  |  |  | G
tp_as_async | PyAsyncMethods * | 子槽位 |  |  |  | %
tp_repr | reprfunc | __repr__ | X | X |  | X
tp_as_number | PyNumberMethods * | 子槽位 |  |  |  | %
tp_as_sequence | PySequenceMethods * | 子槽位 |  |  |  | %
tp_as_mapping | PyMappingMethods * | 子槽位 |  |  |  | %
tp_hash | hashfunc | __hash__ | X |  |  | G
tp_call | ternaryfunc | __call__ |  | X |  | X
tp_str | reprfunc | __str__ | X |  |  | X
tp_getattro | getattrofunc | __getattribute__, __getattr__ | X | X |  | G
tp_setattro | setattrofunc | __setattr__, __delattr__ | X | X |  | G
tp_as_buffer | PyBufferProcs * |  |  |  |  | %
tp_flags | unsigned long |  | X | X |  | ?
tp_doc | const char * | __doc__ | X | X |  |
tp_traverse | traverseproc |  |  | X |  | G
tp_clear | inquiry |  |  | X |  | G
tp_richcompare | richcmpfunc | __lt__, __le__, __eq__, __ne__, __gt__, __ge__ | X |  |  | G
tp_weaklistoffset | Py_ssize_t |  |  | X |  | ?
tp_iter | getiterfunc | __iter__ |  |  |  | X
tp_iternext | iternextfunc | __next__ |  |  |  | X
tp_methods | PyMethodDef [] |  | X | X |  |
tp_members | PyMemberDef [] |  |  | X |  |
tp_getset | PyGetSetDef [] |  | X | X |  |
tp_base | PyTypeObject * | __base__ |  |  | X |
tp_dict | PyObject * | __dict__ |  |  | ? |
tp_descr_get | descrgetfunc | __get__ |  |  |  | X
tp_descr_set | descrsetfunc | __set__, __delete__ |  |  |  | X
tp_dictoffset | Py_ssize_t |  |  | X |  | ?
tp_init | initproc | __init__ | X | X |  | X
tp_alloc | allocfunc |  | X |  | ? | ?
tp_new | newfunc | __new__ | X | X | ? | ?
tp_free | freefunc |  | X | X | ? | ?
tp_is_gc | inquiry |  |  | X |  | X
<tp_bases> | PyObject * | __bases__ |  |  | ~ |
<tp_mro> | PyObject * | __mro__ |  |  | ~ |
[tp_cache] | PyObject * |  |  |  |
[tp_subclasses] | PyObject * | __subclasses__ |  |  |
[tp_weaklist] | PyObject * |  |  |  |
(tp_del) | destructor |  |  |  |  |
[tp_version_tag] | unsigned int |  |  |  |
tp_finalize | destructor | __del__ |  |  |  | X
tp_vectorcall | vectorcallfunc |  |  |  |  |

1

（）：括号中的插槽名称表示（实际上）已弃用。

<>: 尖括号内的名称在初始时应设为 NULL 并被视为是只读的。

[]: 方括号内的名称仅供内部使用。

<R> (作为前缀) 表示字段是必需的 (不能是 NULL)。

2

列：

"O": PyBaseObject_Type 必须设置

"T": PyType_Type 必须设置

"D": 默认设置(如果方法槽被设置为NULL)

X - PyType_Ready sets this value if it is NULL
~ - PyType_Ready always sets this value (it should be NULL)
? - PyType_Ready may set this value depending on other slots

Also see the inheritance column ("I").

"I": 继承

X - type slot is inherited via *PyType_Ready* if defined with a *NULL* value
% - the slots of the sub-struct are inherited individually
G - inherited, but only in combination with other slots; see the slot's description
? - it's complicated; see the slot's description

注意，有些方法槽是通过普通属性查找链有效继承的。

子槽位

槽位 | 类型 | 特殊方法
am_await | unaryfunc | __await__
am_aiter | unaryfunc | __aiter__
am_anext | unaryfunc | __anext__
am_send | sendfunc |
nb_add | binaryfunc | __add__ __radd__
nb_inplace_add | binaryfunc | __iadd__
nb_subtract | binaryfunc | __sub__ __rsub__
nb_inplace_subtract | binaryfunc | __isub__
nb_multiply | binaryfunc | __mul__ __rmul__
nb_inplace_multiply | binaryfunc | __imul__
nb_remainder | binaryfunc | __mod__ __rmod__
nb_inplace_remainder | binaryfunc | __imod__
nb_divmod | binaryfunc | __divmod__ __rdivmod__
nb_power | ternaryfunc | __pow__ __rpow__
nb_inplace_power | ternaryfunc | __ipow__
nb_negative | unaryfunc | __neg__
nb_positive | unaryfunc | __pos__
nb_absolute | unaryfunc | __abs__
nb_bool | inquiry | __bool__
nb_invert | unaryfunc | __invert__
nb_lshift | binaryfunc | __lshift__ __rlshift__
nb_inplace_lshift | binaryfunc | __ilshift__
nb_rshift | binaryfunc | __rshift__ __rrshift__
nb_inplace_rshift | binaryfunc | __irshift__
nb_and | binaryfunc | __and__ __rand__
nb_inplace_and | binaryfunc | __iand__
nb_xor | binaryfunc | __xor__ __rxor__
nb_inplace_xor | binaryfunc | __ixor__
nb_or | binaryfunc | __or__ __ror__
nb_inplace_or | binaryfunc | __ior__
nb_int | unaryfunc | __int__
nb_reserved | void * |
nb_float | unaryfunc | __float__
nb_floor_divide | binaryfunc | __floordiv__
nb_inplace_floor_divide | binaryfunc | __ifloordiv__
nb_true_divide | binaryfunc | __truediv__
nb_inplace_true_divide | binaryfunc | __itruediv__
nb_index | unaryfunc | __index__
nb_matrix_multiply | binaryfunc | __matmul__ __rmatmul__
nb_inplace_matrix_multiply | binaryfunc | __imatmul__
mp_length | lenfunc | __len__
mp_subscript | binaryfunc | __getitem__
mp_ass_subscript | objobjargproc | __setitem__, __delitem__
sq_length | lenfunc | __len__
sq_concat | binaryfunc | __add__
sq_repeat | ssizeargfunc | __mul__
sq_item | ssizeargfunc | __getitem__
sq_ass_item | ssizeobjargproc | __setitem__ __delitem__
sq_contains | objobjproc | __contains__
sq_inplace_concat | binaryfunc | __iadd__
sq_inplace_repeat | ssizeargfunc | __imul__
bf_getbuffer | getbufferproc() |
bf_releasebuffer | releasebufferproc() |

槽位 typedef

typedef | 参数类型 | 返回类型
allocfunc | PyTypeObject * Py_ssize_t | PyObject *
destructor | void * | void
freefunc | void * | void
traverseproc | void * visitproc void * | int
newfunc | PyObject * PyObject * PyObject * | PyObject *
initproc | PyObject * PyObject * PyObject * | int
reprfunc | PyObject * | PyObject *
getattrfunc | PyObject * const char * | PyObject *
setattrfunc | PyObject * const char * PyObject * | int
getattrofunc | PyObject * PyObject * | PyObject *
setattrofunc | PyObject * PyObject * PyObject * | int
descrgetfunc | PyObject * PyObject * PyObject * | PyObject *
descrsetfunc | PyObject * PyObject * PyObject * | int
hashfunc | PyObject * | Py_hash_t
richcmpfunc | PyObject * PyObject * int | PyObject *
getiterfunc | PyObject * | PyObject *
iternextfunc | PyObject * | PyObject *
lenfunc | PyObject * | Py_ssize_t
getbufferproc | PyObject * Py_buffer * int | int
releasebufferproc | PyObject * Py_buffer * | void
inquiry | void * | int
unaryfunc | PyObject * | PyObject *
binaryfunc | PyObject * PyObject * | PyObject *
ternaryfunc | PyObject * PyObject * PyObject * | PyObject *
ssizeargfunc | PyObject * Py_ssize_t | PyObject *
ssizeobjargproc | PyObject * Py_ssize_t PyObject * | int
objobjproc | PyObject * PyObject * | int
objobjargproc | PyObject * PyObject * PyObject * | int

请参阅 槽位类型 typedef 里有更多详细信息。

PyTypeObject 定义

PyTypeObject 的结构定义可以在 Include/object.h 中找到。 为了方便参考，此处复述了其中的定义:

typedef struct _typeobject {
    PyObject_VAR_HEAD
    const char *tp_name; /* For printing, in format "<module>.<name>" */
    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

    /* Methods to implement standard operations */

    destructor tp_dealloc;
    Py_ssize_t tp_vectorcall_offset;
    getattrfunc tp_getattr;
    setattrfunc tp_setattr;
    PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
                                    or tp_reserved (Python 3) */
    reprfunc tp_repr;

    /* Method suites for standard classes */

    PyNumberMethods *tp_as_number;
    PySequenceMethods *tp_as_sequence;
    PyMappingMethods *tp_as_mapping;

    /* More standard operations (here for binary compatibility) */

    hashfunc tp_hash;
    ternaryfunc tp_call;
    reprfunc tp_str;
    getattrofunc tp_getattro;
    setattrofunc tp_setattro;

    /* Functions to access object as input/output buffer */
    PyBufferProcs *tp_as_buffer;

    /* Flags to define presence of optional/expanded features */
    unsigned long tp_flags;

    const char *tp_doc; /* Documentation string */

    /* Assigned meaning in release 2.0 */
    /* call function for all accessible objects */
    traverseproc tp_traverse;

    /* delete references to contained objects */
    inquiry tp_clear;

    /* Assigned meaning in release 2.1 */
    /* rich comparisons */
    richcmpfunc tp_richcompare;

    /* weak reference enabler */
    Py_ssize_t tp_weaklistoffset;

    /* Iterators */
    getiterfunc tp_iter;
    iternextfunc tp_iternext;

    /* Attribute descriptor and subclassing stuff */
    struct PyMethodDef *tp_methods;
    struct PyMemberDef *tp_members;
    struct PyGetSetDef *tp_getset;
    // Strong reference on a heap type, borrowed reference on a static type
    struct _typeobject *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; /* Low-level free-memory routine */
    inquiry tp_is_gc; /* For PyObject_IS_GC */
    PyObject *tp_bases;
    PyObject *tp_mro; /* method resolution order */
    PyObject *tp_cache;
    PyObject *tp_subclasses;
    PyObject *tp_weaklist;
    destructor tp_del;

    /* Type attribute cache version tag. Added in version 2.6 */
    unsigned int tp_version_tag;

    destructor tp_finalize;
    vectorcallfunc tp_vectorcall;
} PyTypeObject;

PyObject 槽位

类型对象结构扩展了 PyVarObject 结构。 ob_size 字段用于动态类型 (由 type_new() 创建，通常通过 类 语句来调用)。 注意 PyType_Type (元类型) 会初始化 tp_itemsize，这意味着它的实例 (即类型对象) 必须 具有 ob_size 字段。

Py_ssize_t PyObject.ob_refcnt

Part of the Stable ABI.

这是类型对象的引用计数，由 PyObject_HEAD_INIT 宏初始化为 1。 请注意对于 静态分配的类型对象，类型的实例 (对象的 ob_type 指回该类型) 不会 被加入引用计数。 但对于 动态分配的类型对象，实例 确实 会被算作引用。

继承：

子类型不继承此字段。

PyTypeObject *PyObject.ob_type

Part of the Stable ABI.

这是类型的类型，换句话说就是元类型，它由宏 PyObject_HEAD_INIT 的参数来做初始化，它的值一般情况下是 &PyType_Type 。可是为了使动态可载入扩展模块至少在Windows上可用，编译器会报错这是一个不可用的初始化。因此按照惯例传递 NULL 给宏 PyObject_HEAD_INIT 并且在模块的初始化函数开始时候其他任何操作之前初始化这个字段。典型做法是这样的：

Foo_Type.ob_type = &PyType_Type;

这应该在创建该类型的任何实例之前完成。PyType_Ready() 检查 ob_type 是否为 NULL，如果是，则用基类的 ob_type 字段初始化它。如果该字段非零，则 PyType_Ready() 不会更改它。

继承：

此字段会被子类型继承。

PyObject *PyObject._ob_next

PyObject *PyObject._ob_prev

这些字段仅在定义了宏 Py_TRACE_REFS 时存在（参阅 configure --with-trace-refs option）。

由 PyObject_HEAD_INIT 宏负责将它们初始化为 NULL 。对于 静态分配的对象，这两个字段始终为 NULL 。对于 动态分配的对象，这两个字段用于将对象链接到堆上所有活动对象的双向链表中。

它们可用于各种调试目的。目前唯一的用途是 sys.getobjects() 函数，在设置了环境变量 PYTHONDUMPREFS 时，打印运行结束时仍然活跃的对象。

继承：

这些字段不会被子类型继承。

PyVarObject 槽位

Py_ssize_t PyVarObject.ob_size

Part of the Stable ABI.

对于 静态分配的内存对象，它应该初始化为 0。对于 动态分配的类型对象，该字段具有特殊的内部含义。

继承：

子类型不继承此字段。

PyTypeObject 槽

每个槽位都有一个部分来描述继承关系。如果 PyType_Ready() 会在该字段为 NULL 时设置它的值，那么也会有一个“默认”部分。（注意，在 PyBaseObject_Type 和 PyType_Type 中设置的许多字段实际上就是默认值。）

const char *PyTypeObject.tp_name

指针，指向以 NULL 结尾的表示类型名称的字符串。对于可以作为模块的全局变量访问的类型，字符串应该是完整的模块名，后跟一个点，再后跟类型名。对于内置类型，字符串应该只是类型名。如果模块是包的子模块，则完整的包名是完整的模块名的一部分。例如，包 P 的子包 Q 的模块 M 中定义的类型 T 的 tp_name 应该初始化为 "P.Q.M.T"。

对于 动态分配的类型对象，这应为类型名称，而模块名称将作为 '__module__' 键的值显式地保存在类型字典中。

对于 静态分配的类型对象，tp_name 字段应当包含一个点号。 最后一个点号之前的所有内容都可作为 __module__ 属性访问，而最后一个点号之后的所有内容都可作为 __name__ 属性访问。

如果不存在点号，则整个 tp_name 字段将作为 __name__ 属性访问，而 __module__ 属性则将是未定义的（除非在字典中显式地设置，如上文所述）。 这意味着你的类型将无法执行 pickle。 此外，用 pydoc 创建的模块文档中也不会列出该类型。

该字段不可为 NULL。 它是 PyTypeObject() 中唯一的必填字段（除了潜在的 tp_itemsize 以外）。

继承：

子类型不继承此字段。

Py_ssize_t PyTypeObject.tp_basicsize

Py_ssize_t PyTypeObject.tp_itemsize

通过这些字段可以计算出该类型实例以字节为单位的大小。

存在两种类型：具有固定长度实例的类型其 tp_itemsize 字段为零；具有可变长度实例的类型其 tp_itemsize 字段不为零。 对于具有固定长度实例的类型，所有实例的大小都相同，具体大小由 tp_basicsize 给出。

For a type with variable-length instances, the instances must have an ob_size field, and the instance size is tp_basicsize plus N times tp_itemsize, where N is the "length" of the object. The value of N is typically stored in the instance's ob_size field. There are exceptions: for example, ints use a negative ob_size to indicate a negative number, and N is abs(ob_size) there. Also, the presence of an ob_size field in the instance layout doesn't mean that the instance structure is variable-length (for example, the structure for the list type has fixed-length instances, yet those instances have a meaningful ob_size field).

The basic size includes the fields in the instance declared by the macro PyObject_HEAD or PyObject_VAR_HEAD (whichever is used to declare the instance struct) and this in turn includes the _ob_prev and _ob_next fields if they are present. This means that the only correct way to get an initializer for the tp_basicsize is to use the sizeof operator on the struct used to declare the instance layout. The basic size does not include the GC header size.

关于对齐的说明：如果变量条目需要特定的对齐，则应通过 tp_basicsize 的值来处理。 例如：假设某个类型实现了一个 double 数组。 tp_itemsize 就是 sizeof(double)。 程序员有责任确保 tp_basicsize 是 sizeof(double) 的倍数（假设这是 double 的对齐要求）。

对于任何具有可变长度实例的类型，该字段不可为 NULL。

继承：

这些字段将由子类分别继承。 如果基本类型有一个非零的 tp_itemsize，那么在子类型中将 tp_itemsize 设置为不同的非零值通常是不安全的（不过这取决于该基本类型的具体实现）。

destructor PyTypeObject.tp_dealloc

指向实例析构函数的指针。除非保证类型的实例永远不会被释放（就像单例对象 None 和 Ellipsis 那样），否则必须定义这个函数。函数声明如下：

void tp_dealloc(PyObject *self);

当引用计数为0时，由 Py_DECREF() 和 Py_XDECREF() 宏调用析构函数。此时，实例仍然存在，但已经没有了对它的引用。析构函数应该释放该实例拥有的所有引用，释放该实例拥有的所有内存缓冲区（通过分配内存对应的释放函数），并调用该类型的 tp_free 函数。如果该类型不可子类型化（没有设置 Py_TPFLAGS_BASETYPE 标志位），则允许直接调用对象的释放函数，不必调用 tp_free。对象的释放函数应该与分配函数对应：如果使用 PyObject_New() 或 PyObject_VarNew() 分配，通常为 PyObject_Del()；如果使用 PyObject_GC_New() 或 PyObject_GC_NewVar() 分配，通常为 PyObject_GC_Del()。

如果该类型支持垃圾回收（设置了 Py_TPFLAGS_HAVE_GC 标志位），析构器应该在清理任何成员字段之前调用 PyObject_GC_UnTrack()。

static void foo_dealloc(foo_object *self) {
    PyObject_GC_UnTrack(self);
    Py_CLEAR(self->ref);
    Py_TYPE(self)->tp_free((PyObject *)self);
}

Finally, if the type is heap allocated (Py_TPFLAGS_HEAPTYPE), the deallocator should release the owned reference to its type object (via Py_DECREF()) after calling the type deallocator. In order to avoid dangling pointers, the recommended way to achieve this is:

static void foo_dealloc(foo_object *self) {
    PyTypeObject *tp = Py_TYPE(self);
    // free references and buffers here
    tp->tp_free(self);
    Py_DECREF(tp);
}

继承：

此字段会被子类型继承。

Py_ssize_t PyTypeObject.tp_vectorcall_offset

一个相对使用 vectorcall 协议 实现调用对象的实例级函数的可选的偏移量，这是一种比简单的 tp_call 更有效的替代选择。

This field is only used if the flag Py_TPFLAGS_HAVE_VECTORCALL is set. If so, this must be a positive integer containing the offset in the instance of a vectorcallfunc pointer.

The vectorcallfunc pointer may be NULL, in which case the instance behaves as if Py_TPFLAGS_HAVE_VECTORCALL was not set: calling the instance falls back to tp_call.

任何设置了 Py_TPFLAGS_HAVE_VECTORCALL 的类也必须设置 tp_call 并确保其行为与 vectorcallfunc 函数一致。 这可以通过将 tp_call 设为 PyVectorcall_Call() 来实现。

警告

It is not recommended for heap types to implement the vectorcall protocol. When a user sets __call__ in Python code, only tp_call is updated, likely making it inconsistent with the vectorcall function.

在 3.8 版更改: 在 3.8 版之前，这个槽位被命名为 tp_print。 在 Python 2.x 中，它被用于打印到文件。 在 Python 3.0 至 3.7 中，它没有被使用。

继承：

This field is always inherited. However, the Py_TPFLAGS_HAVE_VECTORCALL flag is not always inherited. If it's not, then the subclass won't use vectorcall, except when PyVectorcall_Call() is explicitly called. This is in particular the case for heap types (including subclasses defined in Python).

getattrfunc PyTypeObject.tp_getattr

一个指向获取属性字符串函数的可选指针。

该字段已弃用。当它被定义时，应该和 tp_getattro 指向同一个函数，但接受一个C字符串参数表示属性名，而不是Python字符串对象。

继承：

分组: tp_getattr, tp_getattro

该字段会被子类和 tp_getattro 所继承：当子类型的 tp_getattr 和 tp_getattro 均为 NULL 时该子类型将从它的基类型同时继承 tp_getattr 和 tp_getattro。

setattrfunc PyTypeObject.tp_setattr

一个指向函数以便设置和删除属性的可选指针。

该字段已弃用。当它被定义时，应该和 tp_setattro 指向同一个函数，但接受一个C字符串参数表示属性名，而不是Python字符串对象。

继承：

分组: tp_setattr, tp_setattro

该字段会被子类型和 tp_setattro 所继承：当子类型的 tp_setattr 和 tp_setattro 均为 NULL 时该子类型将同时从它的基类型继承 tp_setattr 和 tp_setattro。

PyAsyncMethods *PyTypeObject.tp_as_async

指向一个包含仅与在 C 层级上实现 awaitable 和 asynchronous iterator 协议的对象相关联的字段的附加结构体。 请参阅 异步对象结构体 了解详情。

3.5 新版功能: 在之前被称为 tp_compare 和 tp_reserved。

继承：

tp_as_async 字段不会被继承，但所包含的字段会被单独继承。

reprfunc PyTypeObject.tp_repr

一个实现了内置函数 repr() 的函数的可选指针。

该签名与 PyObject_Repr() 的相同:

PyObject *tp_repr(PyObject *self);

该函数必须返回一个字符串或 Unicode 对象。 在理想情况下，该函数应当返回一个字符串，当将其传给 eval() 时，只要有合适的环境，就会返回一个具有相同值的对象。 如果这不可行，则它应当返回一个以 '<' 开头并以 '>' 结尾的可被用来推断出对象的类型和值的字符串。

继承：

此字段会被子类型继承。

默认：

如果未设置该字段，则返回 <%s object at %p> 形式的字符串，其中 %s 将替换为类型名称，%p 将替换为对象的内存地址。

PyNumberMethods *PyTypeObject.tp_as_number

指向一个附加结构体的指针，其中包含只与执行数字协议的对象相关的字段。 这些字段的文档参见 数字对象结构体。

继承：

tp_as_number 字段不会被继承，但所包含的字段会被单独继承。

PySequenceMethods *PyTypeObject.tp_as_sequence

指向一个附加结构体的指针，其中包含只与执行序列协议的对象相关的字段。 这些字段的文档见 序列对象结构体。

继承：

tp_as_sequence 字段不会被继承，但所包含的字段会被单独继承。

PyMappingMethods *PyTypeObject.tp_as_mapping

指向一个附加结构体的指针，其中包含只与执行映射协议的对象相关的字段。 这些字段的文档见 映射对象结构体。

继承：

tp_as_mapping 字段不会继承，但所包含的字段会被单独继承。

hashfunc PyTypeObject.tp_hash

一个指向实现了内置函数 hash() 的函数的可选指针。

其签名与 PyObject_Hash() 的相同:

Py_hash_t tp_hash(PyObject *);

-1 不应作为正常返回值被返回；当计算哈希值过程中发生错误时，函数应设置一个异常并返回 -1。

When this field is not set (and tp_richcompare is not set), an attempt to take the hash of the object raises TypeError. This is the same as setting it to PyObject_HashNotImplemented().

此字段可被显式设为 PyObject_HashNotImplemented() 以阻止从父类型继承哈希方法。在 Python 层面这被解释为 __hash__ = None 的等价物，使得 isinstance(o, collections.Hashable) 正确返回 False.。请注意反过来也是如此：在 Python 层面设置一个类的 __hash__ = None 会使得 tp_hash 槽位被设置为 PyObject_HashNotImplemented()。

继承：

分组: tp_hash, tp_richcompare

该字段会被子类型同 tp_richcompare 一起继承：当子类型的 tp_richcompare 和 tp_hash 均为 NULL 时子类型将同时继承 tp_richcompare 和 tp_hash。

ternaryfunc PyTypeObject.tp_call

一个可选的实现对象调用的指向函数的指针。 如果对象不是可调用对象则该值应为 NULL。 其签名与 PyObject_Call() 的相同:

PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);

继承：

此字段会被子类型继承。

reprfunc PyTypeObject.tp_str

一个可选的实现内置 str() 操作的函数的指针。 （请注意 str 现在是一个类型，str() 是调用该类型的构造器。 该构造器将调用 PyObject_Str() 执行实际操作，而 PyObject_Str() 将调用该处理器。）

其签名与 PyObject_Str() 的相同:

PyObject *tp_str(PyObject *self);

该函数必须返回一个字符串或 Unicode 对象。 它应当是一个“友好”的对象字符串表示形式，因为这就是要在 print() 函数中与其他内容一起使用的表示形式。

继承：

此字段会被子类型继承。

默认：

当未设置该字段时，将调用 PyObject_Repr() 来返回一个字符串表示形式。

getattrofunc PyTypeObject.tp_getattro

一个指向获取属性字符串函数的可选指针。

其签名与 PyObject_GetAttr() 的相同:

PyObject *tp_getattro(PyObject *self, PyObject *attr);

可以方便地将该字段设为 PyObject_GenericGetAttr()，它实现了查找对象属性的通常方式。

继承：

分组: tp_getattr, tp_getattro

该字段会被子类同 tp_getattr 一起继承：当子类型的 tp_getattr 和 tp_getattro 均为 NULL 时子类型将同时继承 tp_getattr 和 tp_getattro。

默认：

PyBaseObject_Type 使用 PyObject_GenericGetAttr()。

setattrofunc PyTypeObject.tp_setattro

一个指向函数以便设置和删除属性的可选指针。

其签名与 PyObject_SetAttr() 的相同:

int tp_setattro(PyObject *self, PyObject *attr, PyObject *value);

此外，还必须支持将 value 设为 NULL 来删除属性。 通常可以方便地将该字段设为 PyObject_GenericSetAttr()，它实现了设备对象属性的通常方式。

继承：

分组: tp_setattr, tp_setattro

该字段会被子类型同 tp_setattr 一起继承：当子类型的 tp_setattr 和 tp_setattro 均为 NULL 时子类型将同时继承 tp_setattr 和 tp_setattro。

默认：

PyBaseObject_Type 使用 PyObject_GenericSetAttr().

PyBufferProcs *PyTypeObject.tp_as_buffer

指向一个包含只与实现缓冲区接口的对象相关的字段的附加结构体的指针。 这些字段的文档参见 缓冲区对象结构体。

继承：

tp_as_buffer 字段不会被继承，但所包含的字段会被单独继承。

unsigned long PyTypeObject.tp_flags

该字段是针对多个旗标的位掩码。 某些旗标指明用于特定场景的变化语义；另一些旗标则用于指明类型对象（或通过 tp_as_number, tp_as_sequence, tp_as_mapping 和 tp_as_buffer 引用的扩展结构体）中的特定字段，它们在历史上并不总是有效；如果这样的旗标位是清晰的，则它所保护的类型字段必须不可被访问并且必须被视为具有零或 NULL 值。

继承：

Inheritance of this field is complicated. Most flag bits are inherited individually, i.e. if the base type has a flag bit set, the subtype inherits this flag bit. The flag bits that pertain to extension structures are strictly inherited if the extension structure is inherited, i.e. the base type's value of the flag bit is copied into the subtype together with a pointer to the extension structure. The Py_TPFLAGS_HAVE_GC flag bit is inherited together with the tp_traverse and tp_clear fields, i.e. if the Py_TPFLAGS_HAVE_GC flag bit is clear in the subtype and the tp_traverse and tp_clear fields in the subtype exist and have NULL values.

默认：

PyBaseObject_Type uses Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE.

位掩码:

目前定义了以下位掩码；可以使用 | 运算符对它们进行 OR 运算以形成 tp_flags 字段的值。 宏 PyType_HasFeature() 接受一个类型和一个旗标值 tp 和 f，并检查 tp->tp_flags & f 是否为非零值。

Py_TPFLAGS_HEAPTYPE

This bit is set when the type object itself is allocated on the heap, for example, types created dynamically using PyType_FromSpec(). In this case, the ob_type field of its instances is considered a reference to the type, and the type object is INCREF'ed when a new instance is created, and DECREF'ed when an instance is destroyed (this does not apply to instances of subtypes; only the type referenced by the instance's ob_type gets INCREF'ed or DECREF'ed).

继承：

？？？

Py_TPFLAGS_BASETYPE

当此类型可被用作另一个类型的基类型时该比特位将被设置。 如果该比特位被清除，则此类型将无法被子类型化（类似于 Java 中的 "final" 类）。

继承：

？？？

Py_TPFLAGS_READY

当此类型对象通过 PyType_Ready() 被完全实例化时该比特位将被设置。

继承：

？？？

Py_TPFLAGS_READYING

当 PyType_Ready() 处在初始化此类型对象过程中时该比特位将被设置。

继承：

？？？

Py_TPFLAGS_HAVE_GC

当此对象支持垃圾回收时该比特位将被设置。 如果设置了该比特位，则实例必须使用 PyObject_GC_New() 来创建并使用 PyObject_GC_Del() 来销毁。 更多信息见 使对象类型支持循环垃圾回收 一节。 该比特位还表明与类型对象中存在 GC 相关字段 tp_traverse 和 tp_clear。

继承：

分组: Py_TPFLAGS_HAVE_GC, tp_traverse, tp_clear

The Py_TPFLAGS_HAVE_GC flag bit is inherited together with the tp_traverse and tp_clear fields, i.e. if the Py_TPFLAGS_HAVE_GC flag bit is clear in the subtype and the tp_traverse and tp_clear fields in the subtype exist and have NULL values.

Py_TPFLAGS_DEFAULT

This is a bitmask of all the bits that pertain to the existence of certain fields in the type object and its extension structures. Currently, it includes the following bits: Py_TPFLAGS_HAVE_STACKLESS_EXTENSION.

继承：

？？？

Py_TPFLAGS_METHOD_DESCRIPTOR

这个位指明对象的行为类似于未绑定方法。

如果为 type(meth) 设置了该旗标，那么：

meth.__get__(obj, cls)(*args, **kwds) (其中 obj 不为 None) 必须等价于 meth(obj, *args, **kwds)。

meth.__get__(None, cls)(*args, **kwds) 必须等价于 meth(*args, **kwds)。

此旗标为 obj.meth() 这样的典型方法调用启用优化：它将避免为 obj.meth 创建临时的“绑定方法”对象。

3.8 新版功能.

继承：

This flag is never inherited by heap types. For extension types, it is inherited whenever tp_descr_get is inherited.

Py_TPFLAGS_LONG_SUBCLASS

Py_TPFLAGS_LIST_SUBCLASS

Py_TPFLAGS_TUPLE_SUBCLASS

Py_TPFLAGS_BYTES_SUBCLASS

Py_TPFLAGS_UNICODE_SUBCLASS

Py_TPFLAGS_DICT_SUBCLASS

Py_TPFLAGS_BASE_EXC_SUBCLASS

Py_TPFLAGS_TYPE_SUBCLASS

这些旗标被 PyLong_Check() 等函数用来快速确定一个类型是否为内置类型的子类；这样的专用检测比泛用检测如 PyObject_IsInstance() 要更快速。 继承自内置类型的自定义类型应当正确地设置其 tp_flags，否则与这样的类型进行交互的代码将因所使用的检测种类而出现不同的行为。

Py_TPFLAGS_HAVE_FINALIZE

当类型结构体中存在 tp_finalize 槽位时会设置这个比特位。

3.4 新版功能.

3.8 版后已移除: 此旗标已不再是必要的，因为解释器会假定类型结构体中总是存在 tp_finalize 槽位。

Py_TPFLAGS_HAVE_VECTORCALL

当类实现了 vectorcall 协议 时会设置这个比特位。 请参阅 tp_vectorcall_offset 了解详情。

继承：

This bit is inherited for static subtypes if tp_call is also inherited. Heap types do not inherit Py_TPFLAGS_HAVE_VECTORCALL.

3.9 新版功能.

Py_TPFLAGS_IMMUTABLETYPE

不可变的类型对象会设置这个比特位：类型属性无法被设置或删除。

PyType_Ready() 会自动对 静态类型 应用这个旗标。

继承：

这个旗标不会被继承。

3.10 新版功能.

Py_TPFLAGS_DISALLOW_INSTANTIATION

不允许创建此类型的实例：将 tp_new 设为 NULL 并且不会在类型字符中创建 __new__ 键。

这个旗标必须在创建该类型之前设置，而不是在之后。 例如，它必须在该类型调用 PyType_Ready() 之前被设置。

如果 tp_base 为 NULL 或者 &PyBaseObject_Type 和 tp_new 为 NULL 则该旗标会在 静态类型 上自动设置。

继承：

这个旗标不会被继承。 但是，子类将不能被实例化，除非它们提供了不为 NULL 的 tp_new (这只能通过 C API 实现)。

注解

要禁止直接实例化一个类但允许实例化其子类 (例如对于 abstract base class)，请勿使用此旗标。 替代的做法是，让 tp_new 只对子类可用。

3.10 新版功能.

Py_TPFLAGS_MAPPING

这个比特位指明该类的实例可以在被用作 match 代码块的目标时匹配映射模式。 它会在注册或子类化 collections.abc.Mapping 时自动设置，并在注册 collections.abc.Sequence 时取消设置。

注解

Py_TPFLAGS_MAPPING and Py_TPFLAGS_SEQUENCE are mutually exclusive; it is an error to enable both flags simultaneously.

继承：

This flag is inherited by types that do not already set Py_TPFLAGS_SEQUENCE.

参见

PEP 634 [https://www.python.org/dev/peps/pep-0634] —— 结构化模式匹配：规范

3.10 新版功能.

Py_TPFLAGS_SEQUENCE

这个比特位指明该类的实例可以在被用作 match 代码块的目标时匹配序列模式。 它会在注册或子类化 collections.abc.Sequence 时自动设置，并在注册 collections.abc.Mapping 时取消设置。

注解

Py_TPFLAGS_MAPPING and Py_TPFLAGS_SEQUENCE are mutually exclusive; it is an error to enable both flags simultaneously.

继承：

This flag is inherited by types that do not already set Py_TPFLAGS_MAPPING.

参见

PEP 634 [https://www.python.org/dev/peps/pep-0634] —— 结构化模式匹配：规范

3.10 新版功能.

const char *PyTypeObject.tp_doc

一个可选的指向给出该类型对象的文档字符串的以 NUL 结束的 C 字符串的指针。 该指针被暴露为类型和类型实例上的 __doc__ 属性。

继承：

这个字段 不会 被子类型继承。

traverseproc PyTypeObject.tp_traverse

An optional pointer to a traversal function for the garbage collector. This is only used if the Py_TPFLAGS_HAVE_GC flag bit is set. The signature is:

int tp_traverse(PyObject *self, visitproc visit, void *arg);

有关 Python 垃圾回收方案的更多信息可在 使对象类型支持循环垃圾回收 一节中查看。

The tp_traverse pointer is used by the garbage collector to detect reference cycles. A typical implementation of a tp_traverse function simply calls Py_VISIT() on each of the instance's members that are Python objects that the instance owns. For example, this is function local_traverse() from the _thread extension module:

static int
local_traverse(localobject *self, visitproc visit, void *arg)
{
    Py_VISIT(self->args);
    Py_VISIT(self->kw);
    Py_VISIT(self->dict);
    return 0;
}

请注意 Py_VISIT() 仅能在可以参加循环引用的成员上被调用。 虽然还存在一个 self->key 成员，但它只能为 NULL 或 Python 字符串因而不能成为循环引用的一部分。

在另一方面，即使你知道某个成员永远不会成为循环引用的一部分，作为调试的辅助你仍然可能想要访问它因此 gc 模块的 get_referents() 函数将会包括它。

警告

当实现 tp_traverse 时，只有实例所 拥有 的成员 (就是有指向它们的 强引用) 才必须被访问。 举例来说，如果一个对象通过 tp_weaklist 槽位支持弱引用，那么支持链表 (tp_weaklist 所指向的对象) 的指针就 不能 被访问因为实例并不直接拥有指向自身的弱引用 (弱引用列表被用来支持弱引用机制，但实例没有指向其中的元素的强引用，因为即使实例还存在它们也允许被删除)。

请注意 Py_VISIT() 要求传给 local_traverse() 的 visit 和 arg 形参具有指定的名称；不要随意命名它们。

堆分配类型 的实例会持有一个指向其类型的引用。 因此它们的遍历函数必须要么访问 Py_TYPE(self)，要么通过调用其他堆分配类型（例如一个堆分配超类）的 tp_traverse 将此任务委托出去。 如果没有这样做，类型对象可能不会被垃圾回收。

在 3.9 版更改: 堆分配类型应当访问 tp_traverse 中的 Py_TYPE(self)。 在较早的 Python 版本中，由于 bug 40217 [https://bugs.python.org/issue40217]，这样做可能会导致在超类中发生崩溃。

继承：

分组: Py_TPFLAGS_HAVE_GC, tp_traverse, tp_clear

This field is inherited by subtypes together with tp_clear and the Py_TPFLAGS_HAVE_GC flag bit: the flag bit, tp_traverse, and tp_clear are all inherited from the base type if they are all zero in the subtype.

inquiry PyTypeObject.tp_clear

An optional pointer to a clear function for the garbage collector. This is only used if the Py_TPFLAGS_HAVE_GC flag bit is set. The signature is:

int tp_clear(PyObject *);

tp_clear 成员函数被用来打破垃圾回收器在循环垃圾中检测到的循环引用。 总的来说，系统中的所有 tp_clear 函数必须合到一起以打破所有引用循环。 这是个微妙的问题，并且如有任何疑问都需要提供 tp_clear 函数。 例如，元组类型不会实现 tp_clear 函数，因为有可能证明完全用元组是不会构成循环引用的。 因此其他类型的 tp_clear 函数必须足以打破任何包含元组的循环。 这不是立即能明确的，并且很少会有避免实现 tp_clear 的适当理由。

tp_clear 的实现应当丢弃实例指向其成员的可能为 Python 对象的引用，并将指向这些成员的指针设为 NULL，如下面的例子所示:

static int
local_clear(localobject *self)
{
    Py_CLEAR(self->key);
    Py_CLEAR(self->args);
    Py_CLEAR(self->kw);
    Py_CLEAR(self->dict);
    return 0;
}

应当使用 Py_CLEAR() 宏，因为清除引用是很微妙的：指向被包含对象的引用必须在指向被包含对象的指针被设为 NULL 之后才能被释放 (通过 Py_DECREF())。 这是因为释放引用可能会导致被包含的对象变成垃圾，触发一连串的回收活动，其中可能包括唤起任意 Python 代码 (由于关联到被包含对象的终结器或弱引用回调)。 如果这样的代码有可能再次引用 self，那么这时指向被包含对象的指针为 NULL 就是非常重要的，这样 self 就知道被包含对象不可再被使用。 Py_CLEAR() 宏将以安全的顺序执行此操作。

请注意 tp_clear 并非 总是 在实例被取消分配之前被调用。 例如，当引用计数足以确定对象不再被使用时，就不会涉及循环垃圾回收器而是直接调用 tp_dealloc。

因为 tp_clear 函数的目的是打破循环引用，所以不需要清除所包含的对象如 Python 字符串或 Python 整数，它们无法参与循环引用。 另一方面，清除所包含的全部 Python 对象，并编写类型的 tp_dealloc 函数来唤起 tp_clear 也很方便。

有关 Python 垃圾回收方案的更多信息可在 使对象类型支持循环垃圾回收 一节中查看。

继承：

分组: Py_TPFLAGS_HAVE_GC, tp_traverse, tp_clear

This field is inherited by subtypes together with tp_traverse and the Py_TPFLAGS_HAVE_GC flag bit: the flag bit, tp_traverse, and tp_clear are all inherited from the base type if they are all zero in the subtype.

richcmpfunc PyTypeObject.tp_richcompare

一个可选的指向富比较函数的指针，函数的签名为:

PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);

第一个形参将保证为 PyTypeObject 所定义的类型的实例。

该函数应当返回比较的结果 (通常为 Py_True 或 Py_False)。 如果未定义比较运算，它必须返回 Py_NotImplemented，如果发生了其他错误则它必须返回 NULL 并设置一个异常条件。

以下常量被定义用作 tp_richcompare 和 PyObject_RichCompare() 的第三个参数：

常量 | 对照
Py_LT | <
Py_LE | <=
Py_EQ | ==
Py_NE | !=
Py_GT | >
Py_GE | >=

定义以下宏是为了简化编写丰富的比较函数：

Py_RETURN_RICHCOMPARE(VAL_A, VAL_B, op)

从该函数返回 Py_True 或 Py_False，这取决于比较的结果。 VAL_A 和 VAL_B 必须是可通过 C 比较运算符进行排序的（例如，它们可以为 C 整数或浮点数）。 第三个参数指明所请求的运算，与 PyObject_RichCompare() 的参数一样。

返回值是一个新的 strong reference。

发生错误时，将设置异常并从该函数返回 NULL。

3.7 新版功能.

继承：

分组: tp_hash, tp_richcompare

该字段会被子类型同 tp_hash 一起继承：当子类型的 tp_richcompare 和 tp_hash 均为 NULL 时子类型将同时继承 tp_richcompare 和 tp_hash。

默认：

PyBaseObject_Type provides a tp_richcompare implementation, which may be inherited. However, if only tp_hash is defined, not even the inherited function is used and instances of the type will not be able to participate in any comparisons.

Py_ssize_t PyTypeObject.tp_weaklistoffset

如果此类型的实例是可被弱引用的，则该字段将大于零并包含在弱引用列表头的实例结构体中的偏移量（忽略 GC 头，如果存在的话）；该偏移量将被 PyObject_ClearWeakRefs() 和 PyWeakref_* 函数使用。 实例结构体需要包括一个 PyObject* 类型的字段并初始化为 NULL。

不要将该字段与 tp_weaklist 混淆；后者是指向类型对象本身的弱引用的列表头。

继承：

该字段会被子类型继承，但注意参阅下面列出的规则。 子类型可以覆盖此偏移量；这意味着子类型将使用不同于基类型的弱引用列表。 由于列表头总是通过 tp_weaklistoffset 找到的，所以这应该不成问题。

When a type defined by a class statement has no __slots__ declaration, and none of its base types are weakly referenceable, the type is made weakly referenceable by adding a weak reference list head slot to the instance layout and setting the tp_weaklistoffset of that slot's offset.

When a type's __slots__ declaration contains a slot named __weakref__, that slot becomes the weak reference list head for instances of the type, and the slot's offset is stored in the type's tp_weaklistoffset.

When a type's __slots__ declaration does not contain a slot named __weakref__, the type inherits its tp_weaklistoffset from its base type.

getiterfunc PyTypeObject.tp_iter

一个可选的指向函数的指针，该函数返回对象的 iterator。 它的存在通常表明该类型的实例为 iterable (尽管序列在没有此函数的情况下也可能为可迭代对象)。

此函数的签名与 PyObject_GetIter() 的相同:

PyObject *tp_iter(PyObject *self);

继承：

此字段会被子类型继承。

iternextfunc PyTypeObject.tp_iternext

一个可选的指向函数的指针，该函数返回 iterator 中的下一项。 其签名为:

PyObject *tp_iternext(PyObject *self);

当该迭代器被耗尽时，它必须返回 NULL；StopIteration 异常可能会设置也可能不设置。 当发生另一个错误时，它也必须返回 NULL。 它的存在表明该类型的实际是迭代器。

迭代器类型也应当定义 tp_iter 函数，并且该函数应当返回迭代器实例本身（而不是新的迭代器实例）。

此函数的签名与 PyIter_Next() 的相同。

继承：

此字段会被子类型继承。

struct PyMethodDef *PyTypeObject.tp_methods

一个可选的指向 PyMethodDef 结构体的以 NULL 结束的静态数组的指针，它声明了此类型的常规方法。

对于该数组中的每一项，都会向类型的字典 (参见下面的 tp_dict) 添加一个包含方法描述器的条目。

继承：

该字段不会被子类型所继承（方法是通过不同的机制来继承的）。

struct PyMemberDef *PyTypeObject.tp_members

一个可选的指向 PyMemberDef 结构体的以 NULL 结束的静态数组的指针，它声明了此类型的常规数据成员（字段或槽位）。

对于该数组中的每一项，都会向类型的字典 (参见下面的 tp_dict) 添加一个包含方法描述器的条目。

继承：

该字段不会被子类型所继承（成员是通过不同的机制来继承的）。

struct PyGetSetDef *PyTypeObject.tp_getset

一个可选的指向 PyGetSetDef 结构体的以 NULL 结束的静态数组的指针，它声明了此类型的实例中的被计算属性。

对于该数组中的每一项，都会向类型的字典 (参见下面的 tp_dict) 添加一个包含读写描述器的条目。

继承：

该字段不会被子类型所继承（被计算属性是通过不同的机制来继承的）。

PyTypeObject *PyTypeObject.tp_base

一个可选的指向类型特征属性所继承的基类型的指针。 在这个层级上，只支持单继承；多重继承需要通过调用元类型动态地创建类型对象。

注解

槽位初始化需要遵循初始化全局变量的规则。 C99 要求初始化器为“地址常量”。 隐式转换为指针的函数指示器如 PyType_GenericNew() 都是有效的 C99 地址常量。

However, the unary '&' operator applied to a non-static variable like PyBaseObject_Type() is not required to produce an address constant. Compilers may support this (gcc does), MSVC does not. Both compilers are strictly standard conforming in this particular behavior.

因此，应当在扩展模块的初始化函数中设置 tp_base。

继承：

该字段不会被子类型继承（显然）。

默认：

该字段默认为 &PyBaseObject_Type (对 Python 程序员来说即 object 类型)。

PyObject *PyTypeObject.tp_dict

类型的字典将由 PyType_Ready() 存储到这里。

This field should normally be initialized to NULL before PyType_Ready is called; it may also be initialized to a dictionary containing initial attributes for the type. Once PyType_Ready() has initialized the type, extra attributes for the type may be added to this dictionary only if they don't correspond to overloaded operations (like __add__()).

继承：

该字段不会被子类型所继承（但在这里定义的属性是通过不同的机制来继承的）。

默认：

如果该字段为 NULL，PyType_Ready() 将为它分配一个新字典。

警告

通过字典 C-API 使用 PyDict_SetItem() 或修改 tp_dict 是不安全的。

descrgetfunc PyTypeObject.tp_descr_get

一个可选的指向“描述器获取”函数的指针。

函数的签名为:

PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);

继承：

此字段会被子类型继承。

descrsetfunc PyTypeObject.tp_descr_set

一个指向用于设置和删除描述器值的函数的选项指针。

函数的签名为:

int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);

将 value 参数设为 NULL 以删除该值。

继承：

此字段会被子类型继承。

Py_ssize_t PyTypeObject.tp_dictoffset

如果该类型的实例具有一个包含实例变量的字典，则此字段将为非零值并包含该实例变量字典的类型的实例的偏移量；该偏移量将由 PyObject_GenericGetAttr() 使用。

不要将该字段与 tp_dict 混淆；后者是由类型对象本身的属性组成的字典。

If the value of this field is greater than zero, it specifies the offset from the start of the instance structure. If the value is less than zero, it specifies the offset from the end of the instance structure. A negative offset is more expensive to use, and should only be used when the instance structure contains a variable-length part. This is used for example to add an instance variable dictionary to subtypes of str or tuple. Note that the tp_basicsize field should account for the dictionary added to the end in that case, even though the dictionary is not included in the basic object layout. On a system with a pointer size of 4 bytes, tp_dictoffset should be set to -4 to indicate that the dictionary is at the very end of the structure.

The real dictionary offset in an instance can be computed from a negative tp_dictoffset as follows:

dictoffset = tp_basicsize + abs(ob_size)*tp_itemsize + tp_dictoffset
if dictoffset is not aligned on sizeof(void*):
    round up to sizeof(void*)

where tp_basicsize, tp_itemsize and tp_dictoffset are taken from the type object, and ob_size is taken from the instance. The absolute value is taken because ints use the sign of ob_size to store the sign of the number. (There's never a need to do this calculation yourself; it is done for you by _PyObject_GetDictPtr().)

继承：

This field is inherited by subtypes, but see the rules listed below. A subtype may override this offset; this means that the subtype instances store the dictionary at a difference offset than the base type. Since the dictionary is always found via tp_dictoffset, this should not be a problem.

When a type defined by a class statement has no __slots__ declaration, and none of its base types has an instance variable dictionary, a dictionary slot is added to the instance layout and the tp_dictoffset is set to that slot's offset.

When a type defined by a class statement has a __slots__ declaration, the type inherits its tp_dictoffset from its base type.

(Adding a slot named __dict__ to the __slots__ declaration does not have the expected effect, it just causes confusion. Maybe this should be added as a feature just like __weakref__ though.)

默认：

This slot has no default. For static types, if the field is NULL then no __dict__ gets created for instances.

initproc PyTypeObject.tp_init

一个可选的指向实例初始化函数的指针。

This function corresponds to the __init__() method of classes. Like __init__(), it is possible to create an instance without calling __init__(), and it is possible to reinitialize an instance by calling its __init__() method again.

函数的签名为:

int tp_init(PyObject *self, PyObject *args, PyObject *kwds);

The self argument is the instance to be initialized; the args and kwds arguments represent positional and keyword arguments of the call to __init__().

tp_init 函数如果不为 NULL，将在通过调用类型正常创建其实例时被调用，即在类型的 tp_new 函数返回一个该类型的实例时。 如果 tp_new 函数返回了一个不是原始类型的子类型的其他类型的实例，则 tp_init 函数不会被调用；如果 tp_new 返回了一个原始类型的子类型的实例，则该子类型的 tp_init 将被调用。

成功时返回 0，发生错误时则返回 -1 并在错误上设置一个异常。and sets an exception on error.

继承：

此字段会被子类型继承。

默认：

对于 静态类型 来说该字段没有默认值。

allocfunc PyTypeObject.tp_alloc

指向一个实例分配函数的可选指针。

函数的签名为:

PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);

继承：

该字段会被静态子类型继承，但不会被动态子类型（通过 class 语句创建的子类型）继承。

默认：

对于动态子类型，该字段总是会被设为 PyType_GenericAlloc()，以强制应用标准的堆分配策略。

For static subtypes, PyBaseObject_Type uses PyType_GenericAlloc(). That is the recommended value for all statically defined types.

newfunc PyTypeObject.tp_new

一个可选的指向实例创建函数的指针。

函数的签名为:

PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);

subtype 参数是被创建的对象的类型；args 和 kwds 参数表示调用类型时传入的位置和关键字参数。 请注意 subtype 不是必须与被调用的 tp_new 函数所属的类型相同；它可以是该类型的子类型（但不能是完全无关的类型）。

tp_new 函数应当调用 subtype->tp_alloc(subtype, nitems) 来为对象分配空间，然后只执行绝对有必要的进一步初始化操作。 可以安全地忽略或重复的初始化操作应当放在 tp_init 处理器中。 一个关键的规则是对于不可变类型来说，所有初始化操作都应当在 tp_new 中发生，而对于可变类型，大部分初始化操作都应当推迟到 tp_init 再执行。

Set the Py_TPFLAGS_DISALLOW_INSTANTIATION flag to disallow creating instances of the type in Python.

继承：

该字段会被子类型所继承，例外情况是它不会被 tp_base 为 NULL 或 &PyBaseObject_Type 的 静态类型 所继承。

默认：

对于 静态类型 该字段没有默认值。 这意味着如果槽位被定义为 NULL，则无法调用此类型来创建新的实例；应当存在 其他办法来创建实例，例如工厂函数等。

freefunc PyTypeObject.tp_free

一个可选的指向实例释放函数的指针。 函数的签名为:

void tp_free(void *self);

一个兼容该签名的初始化器是 PyObject_Free()。

继承：

该字段会被静态子类型继承，但不会被动态子类型（通过 class 语句创建的子类型）继承

默认：

In dynamic subtypes, this field is set to a deallocator suitable to match PyType_GenericAlloc() and the value of the Py_TPFLAGS_HAVE_GC flag bit.

对于静态子类型，PyBaseObject_Type 使用 PyObject_Del.

inquiry PyTypeObject.tp_is_gc

可选的指向垃圾回收器所调用的函数的指针。

The garbage collector needs to know whether a particular object is collectible or not. Normally, it is sufficient to look at the object's type's tp_flags field, and check the Py_TPFLAGS_HAVE_GC flag bit. But some types have a mixture of statically and dynamically allocated instances, and the statically allocated instances are not collectible. Such types should define this function; it should return 1 for a collectible instance, and 0 for a non-collectible instance. The signature is:

int tp_is_gc(PyObject *self);

（此对象的唯一样例是类型本身。 元类型 PyType_Type 定义了该函数来区分静态和 动态分配的类型。）

继承：

此字段会被子类型继承。

默认：

This slot has no default. If this field is NULL, Py_TPFLAGS_HAVE_GC is used as the functional equivalent.

PyObject *PyTypeObject.tp_bases

基类型的元组。

此字段应当被设为 NULL 并被视为只读。 Python 将在类型 初始化时 填充它。

对于动态创建的类，可以使用 Py_tp_bases 槽位 来代替 PyType_FromSpecWithBases() 的 bases 参数。 推荐使用参数形式。

警告

多重继承不适合静态定义的类型。 如果你将 tp_bases 设为一个元组，Python 将不会引发错误，但某些槽位将只从第一个基类型继承。

继承：

这个字段不会被继承。

PyObject *PyTypeObject.tp_mro

包含基类型的扩展集的元组，以类型本身开始并以 object 作为结束，使用方法解析顺序。

此字段应当被设为 NULL 并被视为只读。 Python 将在类型 初始化时 填充它。

继承：

这个字段不会被继承；它是通过 PyType_Ready() 计算得到的。

PyObject *PyTypeObject.tp_cache

尚未使用。 仅供内部使用。

继承：

这个字段不会被继承。

PyObject *PyTypeObject.tp_subclasses

由对子类的弱引用组成的列表。 仅供内部使用。

继承：

这个字段不会被继承。

PyObject *PyTypeObject.tp_weaklist

弱引用列表头，用于指向该类型对象的弱引用。 不会被继承。 仅限内部使用。

继承：

这个字段不会被继承。

destructor PyTypeObject.tp_del

该字段已被弃用。 请改用 tp_finalize。

unsigned int PyTypeObject.tp_version_tag

用于索引至方法缓存。 仅限内部使用。

继承：

这个字段不会被继承。

destructor PyTypeObject.tp_finalize

一个可选的指向实例最终化函数的指针。 函数的签名为:

void tp_finalize(PyObject *self);

如果设置了 tp_finalize，解释器将在最终化特定实例时调用它一次。 它将由垃圾回收器调用（如果实例是单独循环引用的一部分）或是在对象被释放之前被调用。 不论是哪种方式，它都肯定会在尝试打破循环引用之前被调用，以确保它所操作的对象处于正常状态。

tp_finalize 不应改变当前异常状态；因此，编写非关键终结器的推荐做法如下:

static void
local_finalize(PyObject *self)
{
    PyObject *error_type, *error_value, *error_traceback;

    /* Save the current exception, if any. */
    PyErr_Fetch(&error_type, &error_value, &error_traceback);

    /* ... */

    /* Restore the saved exception. */
    PyErr_Restore(error_type, error_value, error_traceback);
}

另外还需要注意，在应用垃圾回收机制的 Python 中，tp_dealloc 可以从任意 Python 线程被调用，而不仅是创建该对象的线程（如果对象成为引用计数循环的一部分，则该循环可能会被任何线程上的垃圾回收操作所回收）。 这对 Python API 调用来说不是问题，因为 tp_dealloc 调用所在的线程将持有全局解释器锁（GIL）。 但是，如果被销毁的对象又销毁了来自其他 C 或 C++ 库的对象，则应当小心确保在调用 tp_dealloc 的线程上销毁这些对象不会破坏这些库的任何资源。

继承：

此字段会被子类型继承。

3.4 新版功能.

在 3.8 版更改: Before version 3.8 it was necessary to set the Py_TPFLAGS_HAVE_FINALIZE flags bit in order for this field to be used. This is no longer required.

参见

"安全的对象最终化" (PEP 442 [https://www.python.org/dev/peps/pep-0442])

vectorcallfunc PyTypeObject.tp_vectorcall

Vectorcall function to use for calls of this type object. In other words, it is used to implement vectorcall for type.__call__. If tp_vectorcall is NULL, the default call implementation using __new__ and __init__ is used.

继承：

这个字段不会被继承。

3.9 新版功能: （这个字段从 3.8 起即存在，但是从 3.9 开始投入使用）

静态类型

在传统上，在 C 代码中定义的类型都是 静态的，也就是说，PyTypeObject 结构体在代码中直接定义并使用 PyType_Ready() 来初始化。

这就导致了与在 Python 中定义的类型相关联的类型限制：

静态类型只能拥有一个基类；换句话说，他们不能使用多重继承。

静态类型对象（但并非它们的实例）是不可变对象。 不可能在 Python 中添加或修改类型对象的属性。

静态类型对象是跨 子解释器 共享的，因此它们不应包括任何子解释器专属的状态。

Also, since PyTypeObject is only part of the Limited API as an opaque struct, any extension modules using static types must be compiled for a specific Python minor version.

堆类型

An alternative to static types is heap-allocated types, or heap types for short, which correspond closely to classes created by Python's class statement. Heap types have the Py_TPFLAGS_HEAPTYPE flag set.

This is done by filling a PyType_Spec structure and calling PyType_FromSpec(), PyType_FromSpecWithBases(), or PyType_FromModuleAndSpec().

数字对象结构体

type PyNumberMethods

该结构体持有指向被对象用来实现数字协议的函数的指针。 每个函数都被 数字协议 一节中记录的对应名称的函数所使用。

结构体定义如下:

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;

注解

双目和三目函数必须检查其所有操作数的类型，并实现必要的转换（至少有一个操作数是所定义类型的实例）。 如果没有为所给出的操作数定义操作，则双目和三目函数必须返回 Py_NotImplemented，如果发生了其他错误则它们必须返回 NULL 并设置一个异常。

注解

The nb_reserved field should always be NULL. It was previously called nb_long, and was renamed in Python 3.0.1.

binaryfunc PyNumberMethods.nb_add

binaryfunc PyNumberMethods.nb_subtract

binaryfunc PyNumberMethods.nb_multiply

binaryfunc PyNumberMethods.nb_remainder

binaryfunc PyNumberMethods.nb_divmod

ternaryfunc PyNumberMethods.nb_power

unaryfunc PyNumberMethods.nb_negative

unaryfunc PyNumberMethods.nb_positive

unaryfunc PyNumberMethods.nb_absolute

inquiry PyNumberMethods.nb_bool

unaryfunc PyNumberMethods.nb_invert

binaryfunc PyNumberMethods.nb_lshift

binaryfunc PyNumberMethods.nb_rshift

binaryfunc PyNumberMethods.nb_and

binaryfunc PyNumberMethods.nb_xor

binaryfunc PyNumberMethods.nb_or

unaryfunc PyNumberMethods.nb_int

void *PyNumberMethods.nb_reserved

unaryfunc PyNumberMethods.nb_float

binaryfunc PyNumberMethods.nb_inplace_add

binaryfunc PyNumberMethods.nb_inplace_subtract

binaryfunc PyNumberMethods.nb_inplace_multiply

binaryfunc PyNumberMethods.nb_inplace_remainder

ternaryfunc PyNumberMethods.nb_inplace_power

binaryfunc PyNumberMethods.nb_inplace_lshift

binaryfunc PyNumberMethods.nb_inplace_rshift

binaryfunc PyNumberMethods.nb_inplace_and

binaryfunc PyNumberMethods.nb_inplace_xor

binaryfunc PyNumberMethods.nb_inplace_or

binaryfunc PyNumberMethods.nb_floor_divide

binaryfunc PyNumberMethods.nb_true_divide

binaryfunc PyNumberMethods.nb_inplace_floor_divide

binaryfunc PyNumberMethods.nb_inplace_true_divide

unaryfunc PyNumberMethods.nb_index

binaryfunc PyNumberMethods.nb_matrix_multiply

binaryfunc PyNumberMethods.nb_inplace_matrix_multiply

映射对象结构体

type PyMappingMethods

该结构体持有指向对象用于实现映射协议的函数的指针。 它有三个成员：

lenfunc PyMappingMethods.mp_length

该函数将被 PyMapping_Size() 和 PyObject_Size() 使用，并具有相同的签名。 如果对象没有定义长度则此槽位可被设为 NULL。

binaryfunc PyMappingMethods.mp_subscript

该函数将被 PyObject_GetItem() 和 PySequence_GetSlice() 使用，并具有与 PyObject_GetItem() 相同的签名。 此槽位必须被填充以便 PyMapping_Check() 函数返回 1，否则它可以为 NULL。

objobjargproc PyMappingMethods.mp_ass_subscript

This function is used by PyObject_SetItem(), PyObject_DelItem(), PyObject_SetSlice() and PyObject_DelSlice(). It has the same signature as PyObject_SetItem(), but v can also be set to NULL to delete an item. If this slot is NULL, the object does not support item assignment and deletion.

序列对象结构体

type PySequenceMethods

该结构体持有指向对象用于实现序列协议的函数的指针。

lenfunc PySequenceMethods.sq_length

此函数被 PySequence_Size() 和 PyObject_Size() 所使用，并具有与它们相同的签名。 它还被用于通过 sq_item 和 sq_ass_item 槽位来处理负索引号。

binaryfunc PySequenceMethods.sq_concat

此函数被 PySequence_Concat() 所使用并具有相同的签名。 在尝试通过 nb_add 槽位执行数值相加之后它还会被用于 + 运算符。

ssizeargfunc PySequenceMethods.sq_repeat

此函数被 PySequence_Repeat() 所使用并具有相同的签名。 在尝试通过 nb_multiply 槽位执行数值相乘之后它还会被用于 * 运算符。

ssizeargfunc PySequenceMethods.sq_item

此函数被 PySequence_GetItem() 所使用并具有相同的签名。 在尝试通过 mp_subscript 槽位执行下标操作之后它还会被用于 PyObject_GetItem()。 该槽位必须被填充以便 PySequence_Check() 函数返回 1，否则它可以为 NULL。

Negative indexes are handled as follows: if the sq_length slot is filled, it is called and the sequence length is used to compute a positive index which is passed to sq_item. If sq_length is NULL, the index is passed as is to the function.

ssizeobjargproc PySequenceMethods.sq_ass_item

此函数被 PySequence_SetItem() 所使用并具有相同的签名。 在尝试通过 mp_ass_subscript 槽位执行条目赋值和删除操作之后它还会被用于 PyObject_SetItem() 和 PyObject_DelItem()。 如果对象不支持条目和删除则该槽位可以保持为 NULL。

objobjproc PySequenceMethods.sq_contains

该函数可供 PySequence_Contains() 使用并具有相同的签名。 此槽位可以保持为 NULL，在此情况下 PySequence_Contains() 只需遍历该序列直到找到一个匹配。

binaryfunc PySequenceMethods.sq_inplace_concat

此函数被 PySequence_InPlaceConcat() 所使用并具有相同的签名。 它应当修改它的第一个操作数，并将其返回。 该槽位可以保持为 NULL，在此情况下 PySequence_InPlaceConcat() 将回退到 PySequence_Concat()。 在尝试通过 nb_inplace_add 槽位执行数字原地相加之后它还会被用于增强赋值运算符 +=。

ssizeargfunc PySequenceMethods.sq_inplace_repeat

此函数被 PySequence_InPlaceRepeat() 所使用并具有相同的签名。 它应当修改它的第一个操作数，并将其返回。 该槽位可以保持为 NULL，在此情况下 PySequence_InPlaceRepeat() 将回退到 PySequence_Repeat()。 在尝试通过 nb_inplace_multiply 槽位执行数字原地相乘之后它还会被用于增强赋值运算符 *=。

缓冲区对象结构体

type PyBufferProcs

此结构体持有指向 缓冲区协议 所需要的函数的指针。 该协议定义了导出方对象要如何向消费方对象暴露其内部数据。

getbufferproc PyBufferProcs.bf_getbuffer

此函数的签名为:

int (PyObject *exporter, Py_buffer *view, int flags);

处理发给 exporter 的请求来填充 flags 所指定的 view。 除第 (3) 点外，此函数的实现必须执行以下步骤：

Check if the request can be met. If not, raise PyExc_BufferError, set view->obj to NULL and return -1.

填充请求的字段。

递增用于保存导出次数的内部计数器。

将 view->obj 设为 exporter 并递增 view->obj。

返回 0。

如果 exporter 是缓冲区提供方的链式或树型结构的一部分，则可以使用两种主要方案：

重导出：树型结构的每个成员作为导出对象并将 view->obj 设为对其自身的新引用。

重定向：缓冲区请求将被重定向到树型结构的根对象。 在此，view->obj 将为对根对象的新引用。

view 中每个字段的描述参见 缓冲区结构体 一节，导出方对于特定请求应当如何反应参见 缓冲区请求类型 一节。

所有在 Py_buffer 结构体中被指向的内存都属于导出方并必须保持有效直到不再有任何消费方。 format, shape, strides, suboffsets 和 internal 对于消费方来说是只读的。

PyBuffer_FillInfo() 提供了一种暴露简单字节缓冲区同时正确处理地所有请求类型的简便方式。

PyObject_GetBuffer() 是针对包装此函数的消费方的接口。

releasebufferproc PyBufferProcs.bf_releasebuffer

此函数的签名为:

void (PyObject *exporter, Py_buffer *view);

处理释放缓冲区资源的请求。 如果不需要释放任何资源，则 PyBufferProcs.bf_releasebuffer 可以为 NULL。 在其他情况下，此函数的标准实现将执行以下的可选步骤：

递减用于保存导出次数的内部计数器。

如果计数器为 0，则释放所有关联到 view 的内存。

导出方必须使用 internal 字段来记录缓冲区专属的资源。 该字段将确保恒定，而消费方则可能将原始缓冲区作为 view 参数传入。

此函数不可递减 view->obj，因为这是在 PyBuffer_Release() 中自动完成的（此方案适用于打破循环引用）。

PyBuffer_Release() 是针对包装此函数的消费方的接口。

异步对象结构体

3.5 新版功能.

type PyAsyncMethods

此结构体将持有指向需要用来实现 awaitable 和 asynchronous iterator 对象的函数的指针。

结构体定义如下:

typedef struct {
    unaryfunc am_await;
    unaryfunc am_aiter;
    unaryfunc am_anext;
    sendfunc am_send;
} PyAsyncMethods;

unaryfunc PyAsyncMethods.am_await

此函数的签名为:

PyObject *am_await(PyObject *self);

返回的对象必须为 iterator，即对其执行 PyIter_Check() 必须返回 1。

如果一个对象不是 awaitable 则此槽位可被设为 NULL。

unaryfunc PyAsyncMethods.am_aiter

此函数的签名为:

PyObject *am_aiter(PyObject *self);

必须返回一个 asynchronous iterator 对象。 请参阅 __anext__() 了解详情。

如果一个对象没有实现异步迭代协议则此槽位可被设为 NULL。

unaryfunc PyAsyncMethods.am_anext

此函数的签名为:

PyObject *am_anext(PyObject *self);

Must return an awaitable object. See __anext__() for details. This slot may be set to NULL.

sendfunc PyAsyncMethods.am_send

此函数的签名为:

PySendResult am_send(PyObject *self, PyObject *arg, PyObject **result);

请参阅 PyIter_Send() 了解详情。 此槽位可被设为 NULL。

3.10 新版功能.

槽位类型 typedef

typedef PyObject *(*allocfunc)(PyTypeObject *cls, Py_ssize_t nitems)

Part of the Stable ABI.

The purpose of this function is to separate memory allocation from memory initialization. It should return a pointer to a block of memory of adequate length for the instance, suitably aligned, and initialized to zeros, but with ob_refcnt set to 1 and ob_type set to the type argument. If the type's tp_itemsize is non-zero, the object's ob_size field should be initialized to nitems and the length of the allocated memory block should be tp_basicsize + nitems*tp_itemsize, rounded up to a multiple of sizeof(void*); otherwise, nitems is not used and the length of the block should be tp_basicsize.

此函数不应执行任何其他实例初始化操作，即使是分配额外内存也不应执行；那应当由 tp_new 来完成。

typedef void (*destructor)(PyObject*)

Part of the Stable ABI.

typedef void (*freefunc)(void*)

参见 tp_free。

typedef PyObject *(*newfunc)(PyObject*, PyObject*, PyObject*)

Part of the Stable ABI.

参见 tp_new。

typedef int (*initproc)(PyObject*, PyObject*, PyObject*)

Part of the Stable ABI.

参见 tp_init。

typedef PyObject *(*reprfunc)(PyObject*)

Part of the Stable ABI.

参见 tp_repr。

typedef PyObject *(*getattrfunc)(PyObject *self, char *attr)

Part of the Stable ABI.

返回对象的指定属性的值。

typedef int (*setattrfunc)(PyObject *self, char *attr, PyObject *value)

Part of the Stable ABI.

为对象设置指定属性的值。 将 value 参数设为 NULL 将删除该属性。

typedef PyObject *(*getattrofunc)(PyObject *self, PyObject *attr)

Part of the Stable ABI.

返回对象的指定属性的值。

参见 tp_getattro。

typedef int (*setattrofunc)(PyObject *self, PyObject *attr, PyObject *value)

Part of the Stable ABI.

为对象设置指定属性的值。 将 value 参数设为 NULL 将删除该属性。

参见 tp_setattro。

typedef PyObject *(*descrgetfunc)(PyObject*, PyObject*, PyObject*)

Part of the Stable ABI.

参见 tp_descr_get。

typedef int (*descrsetfunc)(PyObject*, PyObject*, PyObject*)

Part of the Stable ABI.

参见 tp_descr_set。

typedef Py_hash_t (*hashfunc)(PyObject*)

Part of the Stable ABI.

参见 tp_hash。

typedef PyObject *(*richcmpfunc)(PyObject*, PyObject*, int)

Part of the Stable ABI.

参见 tp_richcompare。

typedef PyObject *(*getiterfunc)(PyObject*)

Part of the Stable ABI.

参见 tp_iter。

typedef PyObject *(*iternextfunc)(PyObject*)

Part of the Stable ABI.

参见 tp_iternext。

typedef Py_ssize_t (*lenfunc)(PyObject*)

Part of the Stable ABI.

typedef int (*getbufferproc)(PyObject*, Py_buffer*, int)

typedef void (*releasebufferproc)(PyObject*, Py_buffer*)

typedef PyObject *(*unaryfunc)(PyObject*)

Part of the Stable ABI.

typedef PyObject *(*binaryfunc)(PyObject*, PyObject*)

Part of the Stable ABI.

typedef PySendResult (*sendfunc)(PyObject*, PyObject*, PyObject**)

参见 am_send。

typedef PyObject *(*ternaryfunc)(PyObject*, PyObject*, PyObject*)

Part of the Stable ABI.

typedef PyObject *(*ssizeargfunc)(PyObject*, Py_ssize_t)

Part of the Stable ABI.

typedef int (*ssizeobjargproc)(PyObject*, Py_ssize_t, PyObject*)

Part of the Stable ABI.

typedef int (*objobjproc)(PyObject*, PyObject*)

Part of the Stable ABI.

typedef int (*objobjargproc)(PyObject*, PyObject*, PyObject*)

Part of the Stable ABI.

例子

下面是一些 Python 类型定义的简单示例。 其中包括你可能会遇到的通常用法。 有些演示了令人困惑的边际情况。 要获取更多示例、实践信息以及教程，请参阅 自定义扩展类型：教程 和 定义扩展类型：已分类主题。

一个基本的 静态类型:

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,
};

你可能还会看到带有更繁琐的初始化器的较旧代码（特别是在 CPython 代码库中）:

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 */
};

一个支持弱引用、实例字典和哈希运算的类型:

typedef struct {
    PyObject_HEAD
    const char *data;
    PyObject *inst_dict;
    PyObject *weakreflist;
} 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_weaklistoffset = offsetof(MyObject, weakreflist),
    .tp_dictoffset = offsetof(MyObject, inst_dict),
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
    .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,
};

A str subclass that cannot be subclassed and cannot be called to create instances (e.g. uses a separate factory func) using Py_TPFLAGS_DISALLOW_INSTANTIATION flag:

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,
};

最简单的固定长度实例 静态类型:

typedef struct {
    PyObject_HEAD
} MyObject;

static PyTypeObject MyObject_Type = {
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
};

最简单的具有可变长度实例的 静态类型:

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 *),
};

使对象类型支持循环垃圾回收

Python 对循环引用的垃圾检测与回收需要“容器”对象类型的支持，此类型的容器对象中可能包含其它容器对象。不保存其它对象的引用的类型，或者只保存原子类型（如数字或字符串）的引用的类型，不需要显式提供垃圾回收的支持。

若要创建一个容器类，类型对象的 tp_flags 字段必须包含 Py_TPFLAGS_HAVE_GC 并提供一个 tp_traverse 处理的实现。如果该类型的实例是可变的，还需要实现 tp_clear 。

Py_TPFLAGS_HAVE_GC

设置了此标志位的类型的对象必须符合此处记录的规则。为方便起见，下文把这些对象称为容器对象。

容器类型的构造函数必须符合两个规则：

必须使用 PyObject_GC_New() 或 PyObject_GC_NewVar() 为这些对象分配内存。

初始化了所有可能包含其他容器的引用的字段后，它必须调用 PyObject_GC_Track() 。

同样的，对象的释放器必须符合两个类似的规则：

在引用其它容器的字段失效前，必须调用 PyObject_GC_UnTrack() 。

必须使用 PyObject_GC_Del() 释放对象的内存。

警告

如果一个类型添加了 Py_TPFLAGS_HAVE_GC，则它 必须 实现至少一个 tp_traverse 句柄或显式地使用来自其一个或多个子类的句柄。

当调用 PyType_Ready() 或者 API 中某些间接调用它的函数例如 PyType_FromSpecWithBases() 或 PyType_FromSpec() 时解释器就自动填充 tp_flags, tp_traverse 和 tp_clear 字段，如果该类型是继承自实现了垃圾回收器协议的类并且该子类 没有 包括 Py_TPFLAGS_HAVE_GC 旗标的话。

TYPE *PyObject_GC_New(TYPE, PyTypeObject *type)

类似于 PyObject_New() ，适用于设置了 Py_TPFLAGS_HAVE_GC 标签的容器对象。

TYPE *PyObject_GC_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size)

类似于 PyObject_NewVar() ，适用于设置了 Py_TPFLAGS_HAVE_GC 标签的容器对象。

TYPE *PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize)

为 PyObject_NewVar() 所分配对象重新调整大小。 返回调整大小后的对象或在失败时返回 NULL。 op 必须尚未被垃圾回收器追踪。

void PyObject_GC_Track(PyObject *op)

Part of the Stable ABI.

把对象 op 加入到垃圾回收器跟踪的容器对象中。对象在被回收器跟踪时必须保持有效的，因为回收器可能在任何时候开始运行。在 tp_traverse 处理前的所有字段变为有效后，必须调用此函数，通常在靠近构造函数末尾的位置。

int PyObject_IS_GC(PyObject *obj)

如果对象实现了垃圾回收器协议则返回非零值，否则返回 0。

如果此函数返回 0 则对象无法被垃圾回收器追踪。

int PyObject_GC_IsTracked(PyObject *op)

Part of the Stable ABI since version 3.9.

如果 op 对象的类型实现了 GC 协议且 op 目前正被垃圾回收器追踪则返回 1， 否则返回 0。

这类似于 Python 函数 gc.is_tracked()。

3.9 新版功能.

int PyObject_GC_IsFinalized(PyObject *op)

Part of the Stable ABI since version 3.9.

如果 op 对象的类型实现了 GC 协议且 op 已经被垃圾回收器终结则返回 1， 否则返回 0。

这类似于 Python 函数 gc.is_finalized()。

3.9 新版功能.

void PyObject_GC_Del(void *op)

Part of the Stable ABI.

释放对象的内存，该对象初始化时由 PyObject_GC_New() 或 PyObject_GC_NewVar() 分配内存。

void PyObject_GC_UnTrack(void *op)

Part of the Stable ABI.

从回收器跟踪的容器对象集合中移除 op 对象。 请注意可以在此对象上再次调用 PyObject_GC_Track() 以将其加回到被跟踪对象集合。 释放器 (tp_dealloc 句柄) 应当在 tp_traverse 句柄所使用的任何字段失效之前为对象调用此函数。

在 3.8 版更改: _PyObject_GC_TRACK() 和 _PyObject_GC_UNTRACK() 宏已从公有 C API 中移除。

tp_traverse 处理接收以下类型的函数形参。

typedef int (*visitproc)(PyObject *object, void *arg)

Part of the Stable ABI.

传给 tp_traverse 处理的访问函数的类型。object 是容器中需要被遍历的一个对象，第三个形参对应于 tp_traverse 处理的 arg 。Python核心使用多个访问者函数实现循环引用的垃圾检测，不需要用户自行实现访问者函数。

tp_traverse 处理必须是以下类型：

typedef int (*traverseproc)(PyObject *self, visitproc visit, void *arg)

Part of the Stable ABI.

用于容器对象的遍历函数。 它的实现必须对 self 所直接包含的每个对象调用 visit 函数，visit 的形参为所包含对象和传给处理程序的 arg 值。 visit 函数调用不可附带 NULL 对象作为参数。 如果 visit 返回非零值，则该值应当被立即返回。

为了简化 tp_traverse 处理的实现，Python提供了一个 Py_VISIT() 宏。若要使用这个宏，必须把 tp_traverse 的参数命名为 visit 和 arg 。

void Py_VISIT(PyObject *o)

如果 o 不为 NULL，则调用 visit 回调函数，附带参数 o 和 arg。 如果 visit 返回一个非零值，则返回该值。 使用此宏之后，tp_traverse 处理程序的形式如下:

static int
my_traverse(Noddy *self, visitproc visit, void *arg)
{
    Py_VISIT(self->foo);
    Py_VISIT(self->bar);
    return 0;
}

tp_clear 处理程序必须为 inquiry 类型，如果对象不可变则为 NULL。

typedef int (*inquiry)(PyObject *self)

Part of the Stable ABI.

丢弃产生循环引用的引用。不可变对象不需要声明此方法，因为他们不可能直接产生循环引用。需要注意的是，对象在调用此方法后必须仍是有效的（不能对引用只调用 Py_DECREF() 方法）。当垃圾回收器检测到该对象在循环引用中时，此方法会被调用。

控制垃圾回收器状态

这个 C-API 提供了以下函数用于控制垃圾回收的运行。

Py_ssize_t PyGC_Collect(void)

Part of the Stable ABI.

执行完全的垃圾回收，如果垃圾回收器已启用的话。 （请注意 gc.collect() 会无条件地执行它。）

返回已回收的 + 无法回收的不可获取对象的数量。 如果垃圾回收器被禁用或已在执行回收，则立即返回 0。 在垃圾回收期间发生的错误会被传给 sys.unraisablehook。 此函数不会引发异常。

int PyGC_Enable(void)

Part of the Stable ABI since version 3.10.

启用垃圾回收器：类似于 gc.enable()。 返回之前的状态，0 为禁用而 1 为启用。

3.10 新版功能.

int PyGC_Disable(void)

Part of the Stable ABI since version 3.10.

禁用垃圾回收器：类似于 gc.disable()。 返回之前的状态，0 为禁用而 1 为启用。

3.10 新版功能.

int PyGC_IsEnabled(void)

Part of the Stable ABI since version 3.10.

查询垃圾回收器的状态：类似于 gc.isenabled()。 返回当前的状态，0 为禁用而 1 为启用。

3.10 新版功能.

API 和 ABI 版本管理

CPython 在下列宏中暴露其版本号。 请注意这对应于 编译 用版本代码，而不是 运行时 使用的版本。

请参阅 C API 的稳定性 查看跨版本的 API 和 ABI 稳定情。

PY_MAJOR_VERSION

3 (3.4.1a2 中的第一段)。

PY_MINOR_VERSION

4 (3.4.1a2 中的第二段)。

PY_MICRO_VERSION

1 (3.4.1a2 中第三段的数字)。

PY_RELEASE_LEVEL

a (3.4.1a2 中第3段的字母)。 可能为 0xA 即 alpha, 0xB 即 beta, 0xC 即 release candidate 或 0xF 即 final。

PY_RELEASE_SERIAL

2 (3.4.1a2 中的末尾数字)。 零代表最终发布版。

PY_VERSION_HEX

编码为单个整数形式的 Python 版本号。

底层的版本信息可通过按以下方式将其当作 32 比特的数字处理来获取:

字节串 | 位数（大端字节序） | 含意 | 3.4.1a2 的值
1 | 1-8 | PY_MAJOR_VERSION | 0x03
2 | 9-16 | PY_MINOR_VERSION | 0x04
3 | 17-24 | PY_MICRO_VERSION | 0x01
4 | 25-28 | PY_RELEASE_LEVEL | 0xA
29-32 | PY_RELEASE_SERIAL | 0x2

这样 3.4.1a2 即十六进制版本号的 0x030401a2 而 3.10.0 即十六进制版本号的 0x030a00f0。

所有提到的宏都定义在 Include/patchlevel.h [https://github.com/python/cpython/tree/3.10/Include/patchlevel.h]。

分发 Python 模块

电子邮箱

distutils-sig@python.org

作为一个流行的开源开发项目，Python拥有一个活跃的贡献者和用户支持社区，这些社区也可以让他们的软件可供其他Python开发人员在开源许可条款下使用。

这允许Python用户有效地共享和协作，从其他人已经创建的解决方案中受益于常见（有时甚至是罕见的）问题，以及可以提供他们自己的解决方案。

本指南涵盖了分发部分的流程。有关安装其他Python项目的指南，请参阅 安装指南。

注解

对于企业和其他机构用户，请注意许多组织都有自己的政策来使用和贡献开源软件。在使用Python提供的分发和安装工具时，请考虑这些政策。

关键术语

Python Package Index [https://pypi.org] 是一个开源许可的软件包公共存储库，可供所有 Python 用户使用。

Python Packaging Authority [https://www.pypa.io/] 是负责标准打包工具以及相关元数据和文件格式标准维护与改进的开发人员和文档作者团队。 他们基于 GitHub [https://github.com/pypa] 和 Bitbucket [https://bitbucket.org/pypa/] 这两个平台维护着各种工具、文档和问题追踪系统。

distutils 是 1998 年首次添加到 Python 标准库的原始构建和分发系统。 虽然直接使用 distutils 正在逐步淘汰，但它仍然为当前的打包和分发基础架构奠定了基础它不仅仍然是标准库的一部分，而且它的名称还以其他方式存在（例如用于协调 Python 打包标准开发的邮件列表的名称）。

setuptools [https://setuptools.readthedocs.io/en/latest/] （在很大程度上）是作为 distutils 的取代者，于 2004 年首次发布。 它对未经修改的 distutils 工具最重要的补充是能够声明对其他包的依赖。 目前它被推荐用来替代 distutils，其更新更为频繁，在更为多样的 Python 版本之上为最新的打包标准提供持续支持。

wheel [https://wheel.readthedocs.io/] （在此上下文中）是一个将 bdist_wheel 命令添加到 distutils/setuptools [https://setuptools.readthedocs.io/en/latest/] 的项目。这产生了一个跨平台的二进制打包格式（称为“轮子”或“轮子文件”，并在 PEP 427 [https://www.python.org/dev/peps/pep-0427] 中定义），它允许在系统上安装Python库，甚至包括二进制扩展的库，而不需在本地进行构建。

开源许可与协作

在世界上大多数地方，软件自动受版权保护。这意味着其他开发人员需要明确的权限来复制，使用，修改和重新分发软件。

开源许可是一种以相对一致的方式明确授予此类权限的方式，允许开发人员通过为各种问题免费提供通用解决方案来有效地共享和协作。这使得许多开发人员可以将更多时间用于关注他们特定情况相对独特的问题。

Python提供的分发工具旨在使开发人员选择开源时，可以合理地直接将其自己的贡献回馈到该公共软件池。

无论该软件是否作为开源软件发布，相同的分发工具也可用于在组织内分发软件。

安装相关工具

标准库不包括支持现代Python打包标准的构建工具，因为核心开发团队已经发现，即使在旧版本的Python上，使用一致工作的标准工具也很重要。

可以通过在命令行调用 pip 模块来安装当前推荐的构建和分发工具:

python -m pip install setuptools wheel twine

注解

对于 POSIX 用户（包括 macOS 和 Linux 用户），这些说明假定使用了 virtual environment 。

对于Windows用户，这些说明假定在安装Python时选择了调整系统PATH环境变量的选项。

Python 打包用户指南包含有关 当前推荐工具的 [https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations] 的更多详细信息。

阅读 Python 打包用户指南

“Python 打包用户指南”介绍了创建和发布项目所涉及的各个关键步骤和元素：

项目的结构

项目的构建与打包

Uploading the project to the Python Package Index

The .pypirc file

我该如何...？

这是一些常见任务的快速解答或相关链接。

...为我的项目选择一个名字？

这不是一个简单的主题，但这里有一些提示：

检查 Python Package Index 以查看该名称是否已被使用

检查流行的托管网站如 GitHub，Bitbucket 等等，看是否已有一个该名称的项目

检查您正在考虑的名称在网络搜索中出现的内容

避免使用特别常见的单词，尤其是具有多重含义的单词，因为它们会使用户在搜索时难以找到您的软件

...创建和分发二进制扩展？

这实际上是一个非常复杂的主题，根据您的目标，可以提供各种替代方案。 有关更多信息和建议，请参阅 Python 打包用户指南。

参见

Python 打包用户指南：二进制扩展 [https://packaging.python.org/guides/packaging-binary-extensions/]

安装 Python 模块

电子邮箱

distutils-sig@python.org

作为一个流行的开源开发项目，Python拥有一个活跃的贡献者和用户支持社区，这些社区也可以让他们的软件可供其他Python开发人员在开源许可条款下使用。

这允许Python用户有效地共享和协作，从其他人已经创建的解决方案中受益于常见（有时甚至是罕见的）问题，以及可以提供他们自己的解决方案。

本指南涵盖了分发部分的流程。有关安装其他Python项目的指南，请参阅 安装指南。

注解

对于企业和其他机构用户，请注意许多组织都有自己的政策来使用和贡献开源软件。在使用Python提供的分发和安装工具时，请考虑这些政策。

关键术语

pip 是首选的安装程序。从Python 3.4开始，它默认包含在Python二进制安装程序中。

virtual environment 是一种半隔离的 Python 环境，允许为特定的应用安装各自的包，而不是安装到整个系统。

venv 是创建虚拟环境的标准工具，从 Python 3.3 开始成为 Python 的组成部分。 从 Python 3.4 开始，它会默认安装 pip 到所创建的全部虚拟环境。

virtualenv 是 venv 的第三方替代（及其前身）。 它允许在 Python 3.4 之前的版本中使用虚拟环境，那些版本或是完全不提供 venv，或是不会自动安装 pip 到所创建的虚拟环境。

Python Package Index [https://pypi.org] 是一个开源许可的软件包公共存储库，可供所有 Python 用户使用。

Python Packaging Authority [https://www.pypa.io/] 是负责标准打包工具以及相关元数据和文件格式标准维护与改进的开发人员和文档作者团队。 他们基于 GitHub [https://github.com/pypa] 和 Bitbucket [https://bitbucket.org/pypa/] 这两个平台维护着各种工具、文档和问题追踪系统。

distutils 是最初的构建和分发系统，于 1998 年首次加入 Python 标准库。 虽然直接使用 distutils 的方式已被淘汰，它仍然是当前打包和分发架构的基础，而且它不仅仍然是标准库的一部分，这个名称还以其他方式存在（例如用于协调 Python 打包标准开发流程的邮件列表就以此命名）。

在 3.5 版更改: 现在推荐使用 venv 来创建虚拟环境。

参见

Python 软件包用户指南：创建和使用虚拟环境 [https://packaging.python.org/installing/#creating-virtual-environments]

基本使用

标准打包工具完全是针对命令行使用方式来设计的。

以下命令将从 Python Package Index 安装一个模块的最新版本及其依赖项:

python -m pip install SomePackage

注解

对于 POSIX 用户（包括 macOS 和 Linux 用户）本指南中的示例假定使用了 virtual environment。

对于 Windows 用户，本指南中的示例假定在安装 Python 时选择了修改系统 PATH 环境变量。

在命令行中指定一个准确或最小版本也是可以的。 当使用比较运算符例如 >, < 或其他某些可以被终端所解析的特殊字符时，包名称与版本号应当用双引号括起来:

python -m pip install SomePackage==1.0.4    # specific version
python -m pip install "SomePackage>=1.0.4"  # minimum version

通常，如果一个匹配的模块已安装，尝试再次安装将不会有任何效果。 要升级现有模块必须显式地发出请求:

python -m pip install --upgrade SomePackage

更多有关 pip 及其功能的信息和资源可以在 Python 软件包用户指南 [https://packaging.python.org] 中找到。

虚拟环境的创建可使用 venv 模块来完成。 向已激活虚拟环境安装软件包可使用上文所介绍的命令。

参见

Python 软件包用户指南：安装 Python 分发包 [https://packaging.python.org/installing/]

我应如何 ...？

这是一些常见任务的快速解答或相关链接。

... 在 Python 3.4 之前的 Python 版本中安装 pip ？

Python 捆绑 pip 是从 Python 3.4 才开始的。 对于更早的版本，pip 需要“引导安装”，具体说明参见 Python 软件包用户指南。

参见

Python 软件包用户指南：安装软件包的前提要求 [https://packaging.python.org/installing/#requirements-for-installing-packages]

... 只为当前用户安装软件包？

将 --user 选项传入 python -m pip install 将只为当前用户而非为系统中的所有用户安装软件包。

... 安装科学计算类 Python 软件包？

许多科学计算类 Python 软件包都有复杂的二进制编译文件依赖，直接使用 pip 安装目前并不太容易。 在当前情况下，通过 其他方式 [https://packaging.python.org/science/] 而非尝试用 pip 安装这些软件包对用户来说通常会更容易。

参见

Python 软件包用户指南：安装科学计算类软件包 [https://packaging.python.org/science/]

... 使用并行安装的多个 Python 版本？

在 Linux, macOS 以及其他 POSIX 系统中，使用带版本号的 Python 命令配合 -m 开关选项来运行特定版本的 pip:

python2   -m pip install SomePackage  # default Python 2
python2.7 -m pip install SomePackage  # specifically Python 2.7
python3   -m pip install SomePackage  # default Python 3
python3.4 -m pip install SomePackage  # specifically Python 3.4

也可以使用带特定版本号的 pip 命令。

在 Windows 中，使用 py Python 启动器命令配合 -m 开关选项:

py -2   -m pip install SomePackage  # default Python 2
py -2.7 -m pip install SomePackage  # specifically Python 2.7
py -3   -m pip install SomePackage  # default Python 3
py -3.4 -m pip install SomePackage  # specifically Python 3.4

常见的安装问题

在 Linux 的系统 Python 版本上安装

Linux 系统通常会将某个 Python 版本作为发行版的一部分包含在内。 将软件包安装到这个 Python 版本上需要系统 root 权限，并可能会干扰到系统包管理器和其他系统组件的运作，如果这些组件在使用 pip 时被意外升级的话。

在这样的系统上，通过 pip 安装软件包通常最好是使用虚拟环境或分用户安装。

未安装 pip

默认情况下可能未安装 pip，一种可选解决方案是:

python -m ensurepip --default-pip

还有其他附加资源可用来 安装 pip。 [https://packaging.python.org/en/latest/tutorials/installing-packages/#ensure-pip-setuptools-and-wheel-are-up-to-date]

安装二进制编译扩展

Python 通常非常依赖基于源代码的发布方式，也就是期望最终用户在安装过程中使用源码来编译生成扩展模块。

随着对二进制码 wheel 格式支持的引入，以及通过 Python Package Index 至少发布 Windows 和 macOS 版的 wheel 文件，预计此问题将逐步得到解决，因为用户将能够更频繁地安装预编译扩展，而不再需要自己编译它们。

某些用来安装 科学计算类软件包 [https://packaging.python.org/science/] 的解决方案对于尚未提供预编译 wheel 文件的那些扩展模块来说，也有助于用户在无需进行本机编译的情况下获取二进制码扩展模块。

参见

Python 软件包用户指南：二进制码扩展 [https://packaging.python.org/extensions/]

Python 指南

就像 Linux 文档项目的指南合集一样，每篇文章尝试完全覆盖一个单独、特定的主题并提供比 Python 库参考更详细的指南。

目前已有的指南如下：

将 Python 2 代码迁移到 Python 3

将扩展模块移植到 Python 3

用 Python 进行 Curses 编程

描述器使用指南

函数式编程指引

日志指南

日志专题手册

正则表达式指南

套接字编程指南

排序指南

Unicode 指南

如何利用 urllib 包获取网络资源

argparse 教程

ipaddress模块介绍

Argument Clinic 的用法

使用 DTrace 和 SystemTap 检测CPython

注解最佳实践

将 Python 2 代码迁移到 Python 3

作者

Brett Cannon

摘要

Python 3 是 Python 的未来，但 Python 2 仍处于活跃使用阶段，最好让您的项目在两个主要版本的Python 上都可用。本指南旨在帮助您了解如何最好地同时支持 Python 2 和 3。

如果您希望迁移扩展模块而不是纯 Python 代码，请参阅 将扩展模块移植到 Python 3。

如果你想了解核心 Python 开发者对于 Python 3 的出现有何看法，你可以阅读 Nick Coghlan 的 Python 3 Q & A [https://ncoghlan-devs-python-notes.readthedocs.io/en/latest/python3/questions_and_answers.html] 或 Brett Cannon 的 为什么要有 Python 3 [https://snarky.ca/why-python-3-exists].

关于迁移的帮助，你可以查看存档的 python-porting [https://mail.python.org/pipermail/python-porting/] 邮件列表。

简要说明

为了使你的项目以一份源代码与Python 2/3兼容，基本步骤如下:

只担心支持Python 2.7的问题

确保你有良好的测试覆盖率（可以用 coverage.py [https://pypi.org/project/coverage]；python -m pip install coverage）。

了解Python 2 和 3之间的区别

使用 Futurize [https://python-future.org/automatic_conversion.html] (或Modernize [https://python-modernize.readthedocs.io/]) 来更新你的代码 (例如 python -m pip install future)。

使用 Pylint [https://pypi.org/project/pylint] 来帮助确保你在Python 3支持上不倒退(python -m pip install pylint)

使用 caniusepython3 [https://pypi.org/project/caniusepython3] 来找出你的哪些依赖关系阻碍了你对 Python 3 的使用 (python -m pip install caniusepython3)

一旦你的依赖性不再阻碍你，使用持续集成来确保你与 Python 2 和 3 保持兼容 (tox [https://pypi.org/project/tox] 可以帮助对多个版本的 Python 进行测试；python -m pip install tox)

考虑使用可选的静态类型检查，以确保你的类型用法在 Python 2 和 3 中都适用 (例如，使用 mypy [http://mypy-lang.org/] 来检查你在 Python 2 和 Python 3 中的类型；python -m pip install mypy)。

注解

注意：使用 python -m pip install 来确保你发起调用的 pip 就是当前使用的 Python 所安装的那一个，无论它是系统级的 pip 还是安装在 虚拟环境 中的。

详情

同时支持Python 2和3的一个关键点是，你可以从**今天**开始！即使你的依赖关系还不支持Python 3，也不意味着你不能现在就对你的代码进行现代化改造以支持Python 3。支持Python 3所需的大多数变化都会使代码更干净，甚至在Python 2的代码中也会使用更新的做法。

另一个关键点是，使你的Python 2代码现代化以支持Python 3在很大程度上是为你自动化的。虽然由于Python 3清晰区分了文本数据与二进制数据，你可能必须做出一些API决定。但现在已经为你完成了大部分底层的工作，因此至少可以立即从自动化变化中受益。

当你继续阅读关于迁移你的代码以同时支持Python 2和3的细节时，请牢记这些关键点。

删除对Python 2.6及更早版本的支持

虽然你可以让 Python 2.5 与 Python 3 一起工作，但如果你只需要与 Python 2.7 一起工作，那就会 更加容易。 如果放弃 Python 2.5 不是一种选择，那么 six [https://pypi.org/project/six] 项目可以帮助你同时支持 Python 2.5 和 3 (python -m pip install six)。 不过请注意，本 HOWTO 中列出的几乎所有项目都有可能会不再可用。

如果你能够跳过Python 2.5和更早的版本，那么对你的代码所做的必要修改应该看起来和感觉上都是你已经习惯的Python代码。在最坏的情况下，你将不得不使用一个函数而不是一个实例方法，或者不得不导入一个函数而不是使用一个内置的函数，但除此之外，整体的转变应该不会让你感到陌生。

但你的目标应该是只支持 Python 2.7。Python 2.6 不再被免费支持，因此也就没有得到错误修复。这意味着**你**必须解决你在Python 2.6上遇到的任何问题。本HOWTO中提到的一些工具也不支持Python 2.6 (例如，Pylint [https://pypi.org/project/pylint])，随着时间的推移，这将变得越来越普遍。如果你只支持你必须支持的Python版本，那么对你来说会更容易。

确保你在你的 setup.py 文件中指定适当的版本支持

在你的 setup.py 文件中，你应该有适当的 trove classifier [https://pypi.org/classifiers] 指定你支持哪些版本的 Python。由于你的项目还不支持 Python 3，你至少应该指定 Programming Language :: Python :: 2 :: Only。理想情况下，你还应该指定你所支持的Python的每个主要/次要版本，例如：Programming Language :: Python :: 2.7。.

良好的测试覆盖率

一旦你的代码支持了你希望的Python 2的最老版本，你将希望确保你的测试套件有良好的覆盖率。一个好的经验法则是，如果你想对你的测试套件有足够的信心，在让工具重写你的代码后出现的任何故障都是工具中的实际错误，而不是你的代码中的错误。如果你想要一个目标数字，试着获得超过80%的覆盖率（如果你发现很难获得好于90%的覆盖率，也不要感到遗憾）。如果你还没有一个测量测试覆盖率的工具，那么推荐使用coverage.py [https://pypi.org/project/coverage]。

了解Python 2 和 3之间的区别

一旦你的代码经过了很好的测试，你就可以开始把你的代码移植到 Python 3 上了！ 但是为了充分了解你的代码将发生怎样的变化，以及你在编码时要注意什么，你将会想要了解 Python 3 相比 Python 2 的变化。 通常来说，两个最好的方法是阅读 Python 3 每个版本的 "What's New" 文档和 Porting to Python 3 [http://python3porting.com/] 书（在线免费版本）。还有一个来自 Python-Future 项目的便利 cheat sheet [https://python-future.org/compatible_idioms.html]。

更新代码

一旦你觉得你知道了 Python 3 与 Python 2 相比有什么不同，就是时候更新你的代码了！ 你可以选择两种工具来自动移植你的代码: Futurize [https://python-future.org/automatic_conversion.html] 和 Modernize [https://python-modernize.readthedocs.io/]。 你选择哪个工具将取决于你希望你的代码有多像 Python 3。 Futurize [https://python-future.org/automatic_conversion.html] 尽力使 Python 3 的习性和做法在 Python 2 中存在，例如，从 Python 3 中回传 bytes 类型，这样你就可以在 Python 的主要版本之间实现语义上的平等。 另一方面，Modernize [https://python-modernize.readthedocs.io/] 更加保守，它针对的是 Python 2/3 的子集，直接依靠 six [https://pypi.org/project/six] 来帮助提供兼容性。 由于 Python 3 是未来，最好考虑 Futurize，以开始适应 Python 3 所引入的、你还不习惯的任何新做法。

无论你选择哪种工具，它们都会更新你的代码，使之在Python 3下运行，同时与你开始使用的Python 2版本保持兼容。根据你想要的保守程度，你可能想先在你的测试套件上运行该工具，并目测差异以确保转换的准确性。在你转换了你的测试套件并验证了所有的测试仍然如期通过后，你就可以转换你的应用程序代码了，因为你知道任何测试失败都是转译的错误。

不幸的是，这些工具不能自动地使你的代码在Python 3下工作，因此有一些东西你需要手动更新以获得对Python 3的完全支持（这些步骤在不同的工具中是必要的）。阅读你选择使用的工具的文档，看看它默认修复了什么，以及它可以选择做什么，以了解哪些将（不）为你修复，哪些你可能必须自己修复（例如，在Modernize中使用 io.open() 覆写内置的 open() 函数默认是关闭的）。不过幸运的是，只有几件需要注意的事情，可以说是大问题，如果不注意的话，可能很难调试。

除法

在Python 3中， 5 / 2 == 2.5 而不是 2 ；所有 int 数值之间的除法都会产生一个 float 、这个变化实际上从2002年发布的Python 2.2开始就已经计划好了。从那时起，我们就鼓励用户在所有使用 / 和 // 运算符的文件中添加 from __future__ import division ，或者在运行解释器时使用 -Q 标志。如果你没有这样做，那么你需要检查你的代码并做两件事。

添加 from __future__ import division 到你的文件。

根据需要更新任何除法运算符，要么使用 // 来使用向下取整除法，要么继续使用 / 并得到一个浮点数

之所以没有简单地将 / 自动翻译成 //，是因为如果一个对象定义了一个 __truediv__ 方法，但没有定义 __floordiv__，那么你的代码就会运行失败（例如，一个用户定义的类用 / 来表示一些操作，但没有用 // 来表示同样的事情或根本没有定义）。

文本与二进制数据

在Python 2中，你可以对文本和二进制数据都使用 str``类型。不幸的是，这两个不同概念的融合可能会导致脆弱的代码，有时对任何一种数据都有效，有时则无效。如果人们没有明确说明某种接受``str``东西可以接受文本或二进制数据，而不是一种特定的类型，这也会导致API的混乱。这使情况变得复杂，特别是对于任何支持多种语言的人来说，因为API在声称支持文本数据时不会显式支持``unicode。

为了使文本和二进制数据之间的区别更加清晰和明显，Python 3做了大多数在互联网时代创建的语言所做的事情，使文本和二进制数据成为不能盲目混合在一起的不同类型（Python早于互联网的广泛使用）。对于任何只处理文本或只处理二进制数据的代码，这种分离并不构成问题。但是对于必须处理这两种数据的代码来说，这确实意味着你现在可能必须关心你何时使用文本或二进制数据，这就是为什么这不能完全自动化迁移。

首先，你需要决定哪些 API 接受文本，哪些接受二进制（由于保持代码工作的难度，强烈 建议你不要设计同时接受两种数据的 API；如前所述，这很难做得好）。在 Python 2 中，这意味着要确保处理文本的 API 能够与 unicode 一起工作，而处理二进制数据的 API 能够与 Python 3 中的 bytes 类型一起工作（在 Python 2 中是 str 的一个子集，在 Python 2 中作为 bytes 类型的别名）。通常最大的问题是意识到哪些方法同时存在于 Python 2 和 3 的哪些类型上 (对于文本来说，Python 2 中是 unicode，Python 3 中是 str，对于二进制来说，Python 2 中是 str/ bytes，Python 3 中是 bytes)。 下表列出了每个数据类型在 Python 2 和 3 中的 独特 的方法 (例如， decode() 方法在 Python 2 或 3 中的等价二进制数据类型上是可用的，但是它不能在 Python 2 和 3 之间被文本数据类型一致使用，因为 Python 3 中的 str 没有这个方法)。 请注意，从 Python 3.5 开始， __mod__ 方法被添加到 bytes 类型中。

文本数据 | 二进制数据
| decode
encode |
format |
isdecimal |
isnumeric |

通过在你的代码边缘对二进制数据和文本进行编码和解码，可以使这种区分更容易处理。这意味着，当你收到二进制数据的文本时，你应该立即对其进行解码。而如果你的代码需要将文本作为二进制数据发送，那么就尽可能晚地对其进行编码。这使得你的代码在内部只与文本打交道，从而不必再去跟踪你所处理的数据类型。

下一个问题是确保你知道你的代码中的字符串字头是代表文本还是二进制数据。你应该给任何呈现二进制数据的字面符号添加一个 b 前缀。对于文本，你应该给文本字面添加一个 u 前缀。（有一个 __future__ 导入来强制所有未指定的字头为Unicode，但实际使用情况表明它并不像给所有字头显式添加一个 b 或 u 前缀那样有效）

作为这种二分法的一部分，你还需要小心打开文件。除非你一直在 Windows 上工作，否则你有可能在打开二进制文件时没有一直费心地添加 b 模式 （例如，用 rb 进行二进制读取）。 在 Python 3 下，二进制文件和文本文件显然是不同的，而且是相互不兼容的；详见 io 模块。因此，你必须**决定**一个文件是用于二进制访问（允许读取和/或写入二进制数据）还是文本访问（允许读取和/或写入文本数据）。你还应该使用 io.open() 来打开文件，而不是内置的 open() 函数，因为 io 模块从 Python 2 到 3 是一致的，而内置的 open() 函数则不是 (在 Python 3 中它实际上是 io.open())。不要理会使用 codecs.open() 的过时做法，因为这只是为了保持与 Python 2.5 的兼容性。

在Python 2和3中， str 和 bytes 的构造函数对相同的参数有不同的语义。在Python 2中，传递一个整数给 bytes ，你将得到整数的字符串表示： bytes(3) == '3' 。但是在Python 3中，一个整数参数传递给 bytes 将给你一个与指定的整数一样长的bytes对象，其中充满了空字节： bytes(3) == b'\x00\x00\x00' 。当把bytes对象传给 str 时，类似的担心是必要的。 在Python 2中，你只是又得到了该bytes对象： str(b'3') == b'3' 。但是在Python 3中，你得到bytes对象的字符串表示： str(b'3') == "b'3'" 。

最后，二进制数据的索引需要仔细处理（切片 不需要 任何特殊处理）。在 Python 2 中 b'123'[1] == b'2'，而在 Python 3 中 b'123'[1] == 50。 因为二进制数据只是二进制数的集合，Python 3 会返回你索引的字节的整数值。 但是在 Python 2 中，因为 bytes == str，索引会返回一个单项的字节片断。 six [https://pypi.org/project/six] 项目有一个名为 six.indexbytes() 的函数，它将像在 Python 3 中一样返回一个整数: six.indexbytes(b'123', 1)。

总结一下：

决定你的API中哪些采用文本，哪些采用二进制数据

确保你对文本工作的代码也能对 unicode 工作，对二进制数据的代码在Python 2中能对 bytes 工作（关于每种类型不能使用的方法，见上表）。

用 b 前缀标记所有二进制字词，用 u 前缀标记文本字词

尽快将二进制数据解码为文本，尽可能晚地将文本编码为二进制数据

使用 io.open() 打开文件，并确保在适当时候指定 b 模式。

在对二进制数据进行索引时要小心

使用特征检测而不是版本检测

你不可避免地会有一些代码需要根据运行的 Python 版本来选择要做什么。做到这一点的最好方法是对你运行的 Python 版本是否支持你所需要的东西进行特征检测。如果由于某种原因这不起作用，那么你应该让版本检测针对 Python 2 而不是 Python 3。为了帮助解释这个问题，让我们看一个例子。

假设你需要访问 importlib 的一个功能，该功能自Python 3.3开始在Python的标准库中提供，并且通过PyPI上的 importlib2 [https://pypi.org/project/importlib2] 提供给Python 2。你可能会想写代码来访问例如 importlib.abc 模块，方法如下:

import sys

if sys.version_info[0] == 3:
    from importlib import abc
else:
    from importlib2 import abc

这段代码的问题是，当Python 4出来的时候会发生什么？最好是将Python 2作为例外情况，而不是Python 3，并假设未来的Python版本与Python 3的兼容性比Python 2更强:

import sys

if sys.version_info[0] > 2:
    from importlib import abc
else:
    from importlib2 import abc

不过，最好的解决办法是根本不做版本检测，而是依靠特征检测。这就避免了任何潜在的版本检测错误的问题，并有助于保持你对未来的兼容:

try:
    from importlib import abc
except ImportError:
    from importlib2 import abc

防止兼容性退步

一旦你完全翻译了你的代码，使之与 Python 3 兼容，你将希望确保你的代码不会退步，不会在 Python 3上停止工作。如果你有一个依赖关系阻碍了你目前在Python 3上的实际运行，那就更是如此了。

为了帮助保持兼容，你创建的任何新模块都应该在其顶部至少有以下代码块:

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

你也可以在运行Python 2时使用 -3 标志，对你的代码在执行过程中引发的各种兼容性问题进行警告。如果你用 -Werror 把警告变成错误，那么你可以确保你不会意外地错过一个警告。

你也可以使用 Pylint [https://pypi.org/project/pylint] 项目和它的 --py3k 标志来提示你的代码，当你的代码开始偏离 Python 3 的兼容性时，就会收到警告。这也避免了你不得不定期在你的代码上运行 Modernize [https://python-modernize.readthedocs.io/] 或 Futurize [https://python-future.org/automatic_conversion.html] 来捕捉兼容性的退步。这确实要求你只支持Python 2.7和Python 3.4或更新的版本，因为这是Pylint支持的最小Python版本。

检查哪些依赖性会阻碍你的过渡

在你使你的代码与 Python 3 兼容**之后**，你应该开始关心你的依赖关系是否也被移植了。 caniusepython3 [https://pypi.org/project/caniusepython3] 项目的建立是为了帮助你确定哪些项目——直接或间接地——阻碍了你对Python 3的支持。它既有一个命令行工具，也有一个在 https://caniusepython3.com 的网页界面。

该项目还提供了一些代码，你可以将其集成到你的测试套件中，这样，当你不再有依赖关系阻碍你使用Python 3时，你将有一个失败的测试。这使你不必手动检查你的依赖性，并在你可以开始在Python 3上运行时迅速得到通知。

更新你的 setup.py 文件以表示对Python 3的兼容

一旦你的代码在 Python 3 下工作，你应该更新你 setup.py 中的分类器，使其包含 Programming Language :: Python :: 3 并不指定单独的 Python 2 支持。这将告诉使用你的代码的人，你支持Python 2 和 3。理想情况下，你也希望为你现在支持的Python的每个主要/次要版本添加分类器。

使用持续集成以保持兼容

一旦你能够完全在Python 3下运行，你将希望确保你的代码总是在Python 2和3下工作。在多个Python解释器下运行测试的最好工具可能是 tox [https://pypi.org/project/tox] 。然后你可以将 tox 与你的持续集成系统集成，这样你就不会意外地破坏对 Python 2 或 3 的支持。

你可能还想在 Python 3 解释器中使用 -bb``标志，以便在你将bytes与string或bytes与int进行比较时触发一个异常（后者从 Python 3.5 开始可用）。默认情况下，类型不同的比较只是简单地返回``False，但是如果你在文本/二进制数据处理或字节的索引分离中犯了一个错误，你就不容易发现这个错误。当这些类型的比较发生时，这个标志会触发一个异常，使错误更容易被发现。

基本上就是这样了! 在这一点上，你的代码库同时与 Python 2 和 3 兼容。你的测试也将被设置为不会意外地破坏 Python 2 或 3 的兼容性，无论你在开发时通常在哪个版本下运行测试。

考虑使用可选的静态类型检查

另一个帮助移植你的代码的方法是在你的代码上使用静态类型检查器，如 mypy [http://mypy-lang.org/] 或 pytype [https://github.com/google/pytype]。这些工具可以用来分析你的代码，就像它在Python 2下运行一样，然后你可以第二次运行这个工具，就像你的代码在Python 3下运行一样。通过像这样两次运行静态类型检查器，你可以发现你是否错误地使用了二进制数据类型，例如在Python的一个版本中与另一个版本相比。如果你在你的代码中添加了可选的类型提示，你也可以明确说明你的API是使用文本数据还是二进制数据，这有助于确保在两个版本的Python中所有的功能都符合预期。

将扩展模块移植到 Python 3

对于将扩展模块移植到 Python 3，我们推荐下列资源：

Supporting Python 3: An in-depth guide 中的 Migrating C extensions [http://python3porting.com/cextensions.html] 这一章，这本书介绍了如何从 Python 2 迁移到 Python 3，包括指导读者如何移植扩展模块。

py3c 项目中的 Porting guide [https://py3c.readthedocs.io/en/latest/guide.html] 提供了有关支持代码的指导性建议。

Cython [https://cython.org/] 和 CFFI [https://cffi.readthedocs.io/en/latest/] 库提供了对于 Python 的 C API 的抽象。 扩展大都需要进行重写以使用两者中的一个，然后就可以通过库来处理各种 Python 版本和实现之间的差异。

用 Python 进行 Curses 编程

作者

A.M. Kuchling, Eric S. Raymond

发布版本

2.04

摘要

本文档介绍了如何使用 curses 扩展模块控制文本模式的显示。

curses 是什么？

curses 库为基于文本的终端提供了独立于终端的屏幕绘制和键盘处理功能；这些终端包括 VT100，Linux 控制台以及各种程序提供的模拟终端。显示终端支持各种控制代码以执行常见的操作，例如移动光标，滚动屏幕和擦除区域。不同的终端使用相差很大的代码，并且往往有自己的小怪癖。

在普遍使用图形显示的世界中，人们可能会问“为什么自找要麻烦”？毕竟字符单元显示终端确实是一种过时的技术，但是在某些领域中，能够用它们做花哨的事情仍然很有价值。一个小众市场是在不运行 X server 的小型或嵌入式 Unix 上。另一个是在提供图形支持之前，可能需要运行的工具，例如操作系统安装程序和内核配置程序。

curses 库提供了相当基础的功能，为程序员提供了包含多个非重叠文本窗口的显示的抽象。窗口的内容可以通过多种方式更改---添加文本，擦除文本，更改其外观---以及curses库将确定需要向终端发送哪些控制代码以产生正确的输出。 curses并没有提供诸多用户界面概念，例如按钮，复选框或对话框。如果需要这些功能，请考虑用户界面库，例如 Urwid [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 版不包括 curses 模块。 一个可用的移植版本是 UniCurses [https://pypi.org/project/UniCurses]。

Python 的 curses 模块

此 Python 模块相当简单地封装了 curses 提供的 C 函数；如果你已经熟悉在 C 语言中使用 curses 编程，把这些知识转移的 Python 是非常容易的。最大的差异在于 Python 中的接口通过把不同的 C 函数合并来让事情变得更简单，比如 addstr()、mvaddstr() 和 mvwaddstr() 三个 C 函数被并入 addstr() 这一个方法。下文中会描述更多的细节。

本 HOWTO 是关于使用 curses 和 Python 编写文本模式程序的概述。它并不被设计为一个 curses API 的完整指南；如需完整指南，请参见 ncurses 的 Python 库指南章节和 ncurses 的 C 手册页。相对地，本 HOWTO 将会给你一些基本思路。

开始和结束 curses 应用程序

在做任何事情之前，curses 必须先被初始化。可以通过调用函数 initscr() 来实现，它将查明终端的类型，向终端发送任何必须的设置代码，并创建多种内部数据结构。如果此操作成功，initscr() 将会返回一个代表整个屏幕的窗口对象；它通常会遵循对应的 C 变量名被称作 stdscr：

import curses
stdscr = curses.initscr()

使用 curses 的应用程序通常会关闭按键自动上屏，目的是读取按键并只在特定情况下展示它们。这需要调用函数 noecho()：

curses.noecho()

应用程序也会广泛地需要立即响应按键，而不需要按下回车键；这被称为 “cbreak” 模式，与通常的缓冲输入模式相对：

curses.cbreak()

终端通常会以多字节转义序列的形式返回特殊按键，比如光标键和导航键比如 Page Up 键和 Home 键。尽管你可以编写你的程序来应对这些序列，curses 能够代替你做到这件事，返回一个特殊值比如 curses.KEY_LEFT。为了让 curses 做这项工作，你需要启用 keypad 模式：

stdscr.keypad(True)

终止一个 curses 应用程序比建立一个容易得多，你只需要调用：

curses.nocbreak()
stdscr.keypad(False)
curses.echo()

来还原对终端作出的 curses 友好设置。然后，调用函数 endwin() 来将终端还原到它的原始操作模式：

curses.endwin()

调试一个 curses 应用程序时常会发生，一个应用程序还未能还原终端到原本的状态就意外退出了，这会搅乱你的终端。在 Python 中这常常会发生在你的代码中有 bug 并引发了一个未捕获的异常。当你尝试输入时按键不会上屏，这使得使用终端变得困难。

在 Python 中你可以避免这些复杂问题并让调试变得更简单，只需要导入 curses.wrapper() 函数并像这样使用它：

from curses import wrapper

def main(stdscr):
    # Clear screen
    stdscr.clear()

    # This raises ZeroDivisionError when i == 10.
    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)

函数 wrapper() 接受一个可调用对象并首先进行上述初始化过程，在终端支持着色时还会初始化颜色。接着 wrapper() 运行你提供的可调用对象。当该可调用对象返回时，wrapper() 会还原终端到初始状态。该可调用对象会在 try...except 这样的结构内被调用，当它捕获到异常时，会先还原终端再重新引发这个异常。所以你的终端不会因为异常而被留在一个搞笑的状态，你也可以正常阅读异常消息和回溯信息。

窗口和面板

窗口是 curses 中的基本抽象。一个窗口对象表示了屏幕上的一个矩形区域，并且提供方法来显示文本、擦除文本、允许用户输入字符串等等。

函数 initscr() 返回的 stdscr 对象覆盖整个屏幕。许多程序可能只需要这一个窗口，但你可能希望把屏幕分割为多个更小的窗口，来分别重绘或者清除它们。函数 newwin() 根据给定的尺寸创建一个新窗口，并返回这个新的窗口对象：

begin_x = 20; begin_y = 7
height = 5; width = 40
win = curses.newwin(height, width, begin_y, begin_x)

注意 curses 使用的坐标系统与寻常的不同。坐标始终是以 y,x 的顺序传递，并且左上角是坐标 (0,0)。这打破了正常的坐标处理约定，即 x 坐标在前。这是一个与其他计算机应用程序糟糕的差异，但这从 curses 最初被编写出来就已是它的一部分，现在想要修改它已为时已晚。

你的应用程序能够查明屏幕的尺寸，curses.LINES 和 curses.COLS 分别代表了 y 和 x 方向上的尺寸。合理的坐标应位于 (0,0) 到 (curses.LINES - 1, curses.COLS - 1) 范围内。

当你调用一个方法来显示或擦除文本时，效果并不会立即显示。相反，你必须调用窗口对象的 refresh() 方法来更新屏幕。

这是因为 curses 最初是为 300 波特的龟速终端连接编写的；在这些终端上，压制重绘屏幕的时间就非常重要。相对地，当你调用 refresh() 时，curses 会累积屏幕的修改并以效率最高的方式显示它们。打个比方，如果你的程序在一个窗口内显示一些文本然后清楚了这个窗口，那么这些原始文本不需要被发送，因为它们甚至不曾能被看见。

在实践中，显式地告诉 curses 来重绘一个窗口并不会太复杂化 curses 编程。大部分程序会显示一堆内容然后等待按键或者其他某些用户侧动作。你要做的事情就是，保证屏幕在暂停并等待用户输入前被重绘，只需要先调用 stdscr.refresh() 或者其他相关窗口的 refresh() 方法。

一个面板是一种特殊的窗口，它可以比实际的显示屏幕更大，并且能只显示它的一部分。创建面板需要指定面板的高度和宽度，但刷新一个面板需要给出屏幕坐标和面板的需要显示的局部。

pad = curses.newpad(100, 100)
# These loops fill the pad with letters; addch() is
# explained in the next section
for y in range(0, 99):
    for x in range(0, 99):
        pad.addch(y,x, ord('a') + (x*x+y*y) % 26)

# Displays a section of the pad in the middle of the screen.
# (0,0) : coordinate of upper-left corner of pad area to display.
# (5,5) : coordinate of upper-left corner of window area to be filled
#         with pad content.
# (20, 75) : coordinate of lower-right corner of window area to be
#          : filled with pad content.
pad.refresh( 0,0, 5,5, 20,75)

此 refresh() 调用会在屏幕坐标 (5,5) 到坐标 (20,75) 的矩形范围内显示面板的一个部分，被显示的部分在面板上的坐标是 (0,0)。除了上述差异，面板与常规的窗口相同，也支持相同的方法。

如果你在屏幕上有多个窗口和面板，有一个更有效率的方法来更新窗口，避免每个部分单独更新时烦人的屏幕闪烁。refresh() 实际上做了两件事：

调用每个窗口的 noutrefresh() 方法来更新一个表达屏幕期望状态的底层的数据结构。

调用函数 doupdate() 来改变物理屏幕来符合这个数据结构中记录的期望状态。

你可以改为调用在多个窗口上 noutrefresh() 方法来更新该数据结构，然后调用函数 doupdate() 来更新屏幕。

显示文字

从一名 C 语言程序员的视角来看，curses 有时看起来就像是一堆略有差异的函数组成的扭曲迷宫。举个例子，addstr() 在 stdscr 窗口的当前光标位置显示一个字符串，而 mvaddstr() 则是先移动到一个给定的 y,x 坐标再显示字符串。waddstr() 与 addstr() 类似，但允许指定一个窗口而非默认的 stdscr。mvwaddstr() 允许同时指定一个窗口和一个坐标。

幸运的是，Python 接口隐藏了所有这些细节。stdscr 和其他任何窗口一样是一个窗口对象，并且诸如 addstr() 之类的方法接受多种参数形式。通常有四种形式。

形式 | 描述
str 或 ch | 在当前位置显示字符串 str 或字符 ch
str 或 ch, attr | 在当前位置使用 attr 属性显示字符串 str 或字符 ch
y, x, str 或 ch | 移动到窗口内的 y,x 位置，并显示 str 或 ch
y, x, str 或 ch, attr | 移至窗口内的 y,x 位置，并使用 attr 属性显示 str 或 ch

属性允许以突出显示形态显示文本，比如加粗、下划线、反相或添加颜色。这些属性将来下一小节细说。

方法 addstr() 接受一个 Python 字符串或字节串作为用于显示的值。字节串的内容会被原样发送到终端。字符串会使用窗口的 encoding 属性值编码为字节，它默认为 locale.getpreferredencoding() 返回的系统默认编码。

方法 addch() 接受一个字符，可以是长度为 1 的字符串，长度为 1 的字节串或者一个整数。

对于特殊扩展字符有一些常量，这些常量是大于 255 的整数。比如，ACS_PLMINUS 是一个 “加减” 符号，ACS_ULCORNER 是一个框的左上角（方便绘制边界）。你也可以使用正确的 Unicode 字符。

窗口会记住上次操作之后光标所在位置，所以如果你忽略 y,x 坐标，字符串和字符会出现在上次操作结束的位置。你也可以通过 move(y,x) 的方法来移动光标。因为一些终端始终会显示一个闪烁的光标，你可能会想要保证光标处于一些不会让人感到分心的位置。在看似随机的位置出现一个闪烁的光标会令人非常迷惑。

如果你的应用程序完全不需要一个闪烁的光标，你可以调用 curs_set(False) 来使它隐形。为与旧版本 curses 的兼容性的关系，有函数 leaveok(bool) 作为 curs_set() 的等价替换。如果 bool 是真值，curses 库会尝试移除闪烁光标，并且你也不必担心它会留在一些奇怪的位置。

属性和颜色

字符可以以不同的方式显示。基于文本的应用程序常常以反相显示状态行，一个文本查看器可能需要突出显示某些单词。为了支持这种用法，curses 允许你为屏幕上的每个单元指定一个属性值。

属性值是一个整数，它的每一个二进制位代表一个不同的属性。你可以尝试以多种不属性位组合来显示文本，但 curses 不保证所有的组合都是有效的，或者看上去有明显不同。这一点取决于用户终端的能力，所以最稳妥的方式是只采用最常见的有效属性，见下表。

属性 | 描述
A_BLINK | 闪烁文本
A_BOLD | 超亮或粗体文本
A_DIM | 半明亮文本
A_REVERSE | 反相显示文本
A_STANDOUT | 可用的最佳突出显示模式
A_UNDERLINE | 带下划线的文本

所以，为了在屏幕顶部显示一个反相的状态行，你可以这么编写：

stdscr.addstr(0, 0, "Current mode: Typing mode",
              curses.A_REVERSE)
stdscr.refresh()

curses 库还支持在提供了颜色功能的终端上显示颜色的功能。最常见的提供颜色的终端很可能是 Linux 控制台，采用了 xterms 配色方案。

为了使用颜色，你必须在调用完函数 initscr() 后尽快调用函数 start_color()，来初始化默认颜色集 (curses.wrapper() 函数自动完成了这一点)。 当它完成后，如果使用中的终端支持显示颜色， has_colors() 会返回真值。 （注意：curses 使用美式拼写 “color”，而不是英式／加拿大拼写 “colour”。如果你习惯了英式拼写，你需要避免自己在这些函数上拼写错误。）

curses 库维护一个有限数量的颜色对，包括一个前景（文本）色和一个背景色。你可以使用函数 color_pair() 获得一个颜色对对应的属性值。它可以通过按位或运算与其他属性，比如 A_REVERSE 组合。但再说明一遍，这种组合并不保证在所有终端上都有效。

一个样例，用 1 号颜色对显示一行文本：

stdscr.addstr("Pretty text", curses.color_pair(1))
stdscr.refresh()

如前所述， 颜色对由前景色和背景色组成。 init_pair(n, f, b) 函数可改变颜色对 n 的定义 为前景色 f 和背景色 b。 颜色对 0 硬编码为黑底白字，不能改变。

颜色已经被编号，并且当其激活 color 模式时 start_color() 会初始化 8 种基本颜色。 它们是: 0:black, 1:red, 2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan 和 7:white。 curses 模块为这些颜色定义了相应的名称常量: curses.COLOR_BLACK, curses.COLOR_RED 等等。

让我们来做个综合练习。 要将颜色 1 改为红色文本白色背景，你应当调用:

curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)

当你改变一个颜色对时，任何已经使用该颜色对来显示的文本将会更改为新的颜色。 你还可以这样来显示新颜色的文本:

stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1))

某些非常花哨的终端可以将实际颜色定义修改为给定的 RGB 值。 这允许你将通常为红色的 1 号颜色改成紫色或蓝色或者任何你喜欢的颜色。 不幸的是，Linux 控制台不支持此特性，所以我无法尝试它，也无法提供任何示例。 想要检查你的终端是否能做到你可以调用 can_change_color()，如果有此功能则它将返回 True。 如果你幸运地拥有一个如此优秀的终端，请查询你的系统的帮助页面来了解详情。

用户输入

C curses 库提供了非常简单的输入机制。 Python 的 curses 模块添加了一个基本的文本输入控件。 （其他的库例如 Urwid [https://pypi.org/project/urwid/] 拥有更丰富的控件集。）

有两个方法可以从窗口获取输入:

getch() 会刷新屏幕然后等待用户按键，如果之前调用过 echo() 还会显示所按的键。 你还可以选择指定一个坐标以便在暂停之前让光标移动到那里。

getkey() 将做同样的事但是会把整数转换为字符串。 每个字符将返回为长度为 1 个字符的字符串，特殊键例如函数键将返回包含键名的较长字符串例如 KEY_UP 或 ^G。

使用 nodelay() 窗口方法可以做到不等待用户。 在 nodelay(True) 之后，窗口的 getch() 和 getkey() 将成为非阻塞的。 为表明输入未就绪，getch() 会返回 curses.ERR (值为 -1) 而 getkey() 会引发异常。 此外还有 halfdelay() 函数，它可被用来（实际地）在每个 getch() 上设置一个计时器；如果在指定的延迟内没有输入可用（以十分之一秒为单位），curses 将引发异常。

getch() 方法返回一个整数；如果数值在 0 到 255 之间，它代表所按下键的 ASCII 码。 大于 255 的值为特殊键例如 Page Up, Home 或方向键等。 你可以将返回的值与 curses.KEY_PPAGE, curses.KEY_HOME 或 curses.KEY_LEFT 等常量做比较。 你的程序主循环看起来可能是这样:

while True:
    c = stdscr.getch()
    if c == ord('p'):
        PrintDocument()
    elif c == ord('q'):
        break  # Exit the while loop
    elif c == curses.KEY_HOME:
        x = y = 0

curses.ascii 模块提供了一些 ASCII 类成员函数，它们接受整数或长度为 1 个字符的字符串参数；这些函数在为这样的循环编写更具可读性的测试时可能会很有用。 它还提供了一些转换函数，它们接受整数或长度为 1 个字符的字符串参数并返回同样的类型。 例如，curses.ascii.ctrl() 返回与其参数相对应的控制字符。

还有一个可以提取整个字符串的方法 getstr()。 它并不经常被使用，因为它的功能相当受限；可用的编辑键只有 Backspace 和 Enter 键，它们会结束字符串。 也可以选择限制为固定数量的字符。

curses.echo()            # Enable echoing of characters

# Get a 15-character string, with the cursor on the top line
s = stdscr.getstr(0,0, 15)

curses.textpad 模块提供了一个文本框，它支持类似 Emacs 的键绑定集。 Textbox 类的各种方法支持带输入验证的编辑及包含或不包含末尾空格地收集编辑结果。 下面是一个例子:

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)

    # Let the user edit until Ctrl-G is struck.
    box.edit()

    # Get resulting contents
    message = box.gather()

请查看 curses.textpad 的库文档了解更多细节。

更多的信息

本 HOWTO 没有涵盖一些进阶主题，例如读取屏幕的内容或从 xterm 实例捕获鼠标事件等，但是 curses 模块的 Python 库文档页面现在已相当完善。 接下来你应当去浏览一下其中的内容。

如果你对 curses 函数的细节行为有疑问，请查看你的 curses 实现版本的说明页面，不论它是 ncurses 还是特定 Unix 厂商的版本。 说明页面将记录任何具体问题，并提供所有函数、属性以及可用 ACS_* 字符的完整列表。

由于 curses API 是如此的庞大，某些函数并不被 Python 接口所支持。 这往往不是因为它们难以实现，而是因为还没有人需要它们。 此外，Python 尚不支持与 ncurses 相关联的菜单库。 欢迎提供添加这些功能的补丁；请参阅 Python 开发者指南 [https://devguide.python.org/] 了解有关为 Python 提交补丁的详情。

Writing Programs with NCURSES [https://invisible-island.net/ncurses/ncurses-intro.html]: 一个面向 C 程序员的详细教程。

ncurses 手册主页 [https://linux.die.net/man/3/ncurses]

ncurses 常见问题 [https://invisible-island.net/ncurses/ncurses.faq.html]

"使用 curses... 请勿爆粗" [https://www.youtube.com/watch?v=eN1eZtjLEnU]: 一场有关使用 curses 或 Urwid 来控制终端的 PyCon 2013 演讲的视频。

"使用 Urwid 的控制台应用程序" [https://pyvideo.org/video/1568/console-applications-with-urwid]: 一场演示使用 Urwid 编写应用程序的 PyCon CA 2012 演讲的视频。

描述器使用指南

作者

Raymond Hettinger（译者：wh2099 at outlook dot com）

联系方式

<python at rcn dot com>

目录

描述器使用指南

入门

简单示例：返回常量的描述器

动态查找

托管属性

定制名称

结束语

完整的实际例子

验证器类

自定义验证器

实际应用

技术教程

摘要

定义与介绍

描述器协议

描述器调用概述

通过实例调用

通过类调用

通过 super 调用

调用逻辑总结

自动名称通知

ORM （对象关系映射）示例

纯 Python 等价实现

属性

函数和方法

方法的种类

静态方法

类方法

成员对象和 __slots__

描述器 让对象能够自定义属性查找、存储和删除的操作。

本指南主要分为四个部分：

“入门” 部分从简单的示例着手，逐步添加特性，从而给出基本的概述。如果你是刚接触到描述器，请从这里开始。

第二部分展示了完整的、实用的描述器示例。如果您已经掌握了基础知识，请从此处开始。

第三部分提供了更多技术教程，详细介绍了描述器如何工作。大多数人并不需要深入到这种程度。

最后一部分有对内置描述器（用 C 编写）的纯 Python 等价实现。如果您想了解函数如何变成绑定方法或对 classmethod()， staticmethod()，property() 和 __slots__ 这类常见工具的实现感兴趣，请阅读此部分。

入门

现在，让我们从最基本的示例开始，然后逐步添加新功能。

简单示例：返回常量的描述器

Ten 类是一个描述器，其 __get__() 方法总是返回常量 10：

class Ten:
    def __get__(self, obj, objtype=None):
        return 10

要使用描述器，它必须作为一个类变量存储在另一个类中：

class A:
    x = 5                       # Regular class attribute
    y = Ten()                   # Descriptor instance

用交互式会话查看普通属性查找和描述器查找之间的区别：

>>> a = A()                     # Make an instance of class A
>>> a.x                         # Normal attribute lookup
5
>>> a.y                         # Descriptor lookup
10

在 a.x 属性查找中，点运算符会找到存储在类字典中的 'x': 5。 在 a.y 查找中，点运算符会根据描述器实例的 __get__ 方法将其识别出来，调用该方法并返回 10 。

请注意，值 10 既不存储在类字典中也不存储在实例字典中。相反，值 10 是在调用时才取到的。

这个简单的例子展示了一个描述器是如何工作的，但它不是很有用。在查找常量时，用常规属性查找会更好。

在下一节中，我们将创建更有用的东西，即动态查找。

动态查找

有趣的描述器通常运行计算而不是返回常量：

import os

class DirectorySize:

    def __get__(self, obj, objtype=None):
        return len(os.listdir(obj.dirname))

class Directory:

    size = DirectorySize()              # Descriptor instance

    def __init__(self, dirname):
        self.dirname = dirname          # Regular instance attribute

交互式会话显示查找是动态的，每次都会计算不同的，经过更新的返回值:

>>> s = Directory('songs')
>>> g = Directory('games')
>>> s.size                              # The songs directory has twenty files
20
>>> g.size                              # The games directory has three files
3
>>> os.remove('games/chess')            # Delete a game
>>> g.size                              # File count is automatically updated
2

除了说明描述器如何运行计算，这个例子也揭示了 __get__() 参数的目的。形参 self 接收的实参是 size，即 DirectorySize 的一个实例。形参 obj 接收的实参是 g 或 s，即 Directory 的一个实例。而正是 obj 让 __get__() 方法获得了作为目标的目录。形参 objtype 接收的实参是 Directory 类。

托管属性

描述器的一种流行用法是托管对实例数据的访问。描述器被分配给类字典中的公开属性，而实际数据作为私有属性存储在实例字典中。当访问公开属性时，会触发描述器的 __get__() 和 __set__() 方法。

在下面的例子中，age 是公开属性，_age 是私有属性。当访问公开属性时，描述器会记录下查找或更新的日志：

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()             # Descriptor instance

    def __init__(self, name, age):
        self.name = name                # Regular instance attribute
        self.age = age                  # Calls __set__()

    def birthday(self):
        self.age += 1                   # Calls both __get__() and __set__()

交互式会话展示中，对托管属性 age 的所有访问都被记录了下来，但常规属性 name 则未被记录：

>>> mary = Person('Mary M', 30)         # The initial age update is logged
INFO:root:Updating 'age' to 30
>>> dave = Person('David D', 40)
INFO:root:Updating 'age' to 40

>>> vars(mary)                          # The actual data is in a private attribute
{'name': 'Mary M', '_age': 30}
>>> vars(dave)
{'name': 'David D', '_age': 40}

>>> mary.age                            # Access the data and log the lookup
INFO:root:Accessing 'age' giving 30
30
>>> mary.birthday()                     # Updates are logged as well
INFO:root:Accessing 'age' giving 30
INFO:root:Updating 'age' to 31

>>> dave.name                           # Regular attribute lookup isn't logged
'David D'
>>> dave.age                            # Only the managed attribute is logged
INFO:root:Accessing 'age' giving 40
40

此示例的一个主要问题是私有名称 _age 在类 LoggedAgeAccess 中是硬耦合的。这意味着每个实例只能有一个用于记录的属性，并且其名称不可更改。

定制名称

当一个类使用描述器时，它可以告知每个描述器使用了什么变量名。

在此示例中， Person 类具有两个描述器实例 name 和 age。当类 Person 被定义的时候，他回调了 LoggedAccess 中的 __set_name__() 来记录字段名称，让每个描述器拥有自己的 public_name 和 private_name：

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()                # First descriptor instance
    age = LoggedAccess()                 # Second descriptor instance

    def __init__(self, name, age):
        self.name = name                 # Calls the first descriptor
        self.age = age                   # Calls the second descriptor

    def birthday(self):
        self.age += 1

交互交互式会话显示类 Person 调用了 __set_name__() 方法来记录字段的名称。在这里，我们调用 vars() 来查找描述器而不触发它：

>>> vars(vars(Person)['name'])
{'public_name': 'name', 'private_name': '_name'}
>>> vars(vars(Person)['age'])
{'public_name': 'age', 'private_name': '_age'}

现在，新类会记录对 name 和 age 二者的访问：

>>> 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

这两个 Person 实例仅包含私有名称:

>>> vars(pete)
{'_name': 'Peter P', '_age': 10}
>>> vars(kate)
{'_name': 'Catherine C', '_age': 20}

结束语

descriptor 就是任何一个定义了 __get__()，__set__() 或 __delete__() 的对象。

可选地，描述器可以具有 __set_name__() 方法。这仅在描述器需要知道创建它的类或分配给它的类变量名称时使用。（即使该类不是描述器，只要此方法存在就会调用。）

在属性查找期间，描述器由点运算符调用。如果使用 vars(some_class)[descriptor_name] 间接访问描述器，则返回描述器实例而不调用它。

描述器仅在用作类变量时起作用。放入实例时，它们将失效。

描述器的主要目的是提供一个挂钩，允许存储在类变量中的对象控制在属性查找期间发生的情况。

传统上，调用类控制查找过程中发生的事情。描述器反转了这种关系，并允许正在被查询的数据对此进行干涉。

描述器的使用贯穿了整个语言。就是它让函数变成绑定方法。常见工具诸如 classmethod()， staticmethod()，property() 和 functools.cached_property() 都作为描述器实现。

完整的实际例子

在此示例中，我们创建了一个实用而强大的工具来查找难以发现的数据损坏错误。

验证器类

验证器是一个用于托管属性访问的描述器。在存储任何数据之前，它会验证新值是否满足各种类型和范围限制。如果不满足这些限制，它将引发异常，从源头上防止数据损坏。

这个 Validator 类既是一个 abstract base class 也是一个托管属性描述器。

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

自定义验证器需要从 Validator 继承，并且必须提供 validate() 方法以根据需要测试各种约束。

自定义验证器

这是三个实用的数据验证工具：

OneOf 验证值是一组受约束的选项之一。

Number 验证值是否为 int 或 float。根据可选参数，它还可以验证值在给定的最小值或最大值之间。

String 验证值是否为 str。根据可选参数，它可以验证给定的最小或最大长度。它还可以验证用户定义的 predicate [https://en.wikipedia.org/wiki/Predicate_(mathematical_logic)]。

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 an 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}'
            )

实际应用

这是在真实类中使用数据验证器的方法：

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

描述器阻止无效实例的创建：

>>> Component('Widget', 'metal', 5)      # Blocked: 'Widget' is not all uppercase
Traceback (most recent call last):
    ...
ValueError: Expected <method 'isupper' of 'str' objects> to be true for 'Widget'

>>> Component('WIDGET', 'metle', 5)      # Blocked: 'metle' is misspelled
Traceback (most recent call last):
    ...
ValueError: Expected 'metle' to be one of {'metal', 'plastic', 'wood'}

>>> Component('WIDGET', 'metal', -5)     # Blocked: -5 is negative
Traceback (most recent call last):
    ...
ValueError: Expected -5 to be at least 0
>>> Component('WIDGET', 'metal', 'V')    # Blocked: 'V' isn't a number
Traceback (most recent call last):
    ...
TypeError: Expected 'V' to be an int or float

>>> c = Component('WIDGET', 'metal', 5)  # Allowed:  The inputs are valid

技术教程

接下来是专业性更强的技术教程，以及描述器工作原理的详细信息。

摘要

定义描述器，总结协议，并说明如何调用描述器。提供一个展示对象关系映射如何工作的示例。

学习描述器不仅能提供接触到更多工具集的途径，还能更深地理解 Python 工作的原理。

定义与介绍

一般而言，描述器是一个包含了描述器协议中的方法的属性值。 这些方法有 __get__(), __set__() 和 __delete__()。 如果为某个属性定义了这些方法中的任意一个，它就可以被称为 descriptor。

属性访问的默认行为是从一个对象的字典中获取、设置或删除属性。对于实例来说，a.x 的查找顺序会从 a.__dict__['x'] 开始，然后是 type(a).__dict__['x']，接下来依次查找 type(a) 的方法解析顺序（MRO）。 如果找到的值是定义了某个描述器方法的对象，则 Python 可能会重写默认行为并转而唤起描述器方法。这具体发生在优先级链的哪个环节则要根据所定义的描述器方法及其被调用的方式来决定。

描述器是一个强大而通用的协议。 它们是属性、方法、静态方法、类方法和 super() 背后的实现机制。 它们在 Python 内部被广泛使用。 描述器简化了底层的 C 代码并为 Python 的日常程序提供了一组灵活的新工具。

描述器协议

descr.__get__(self, obj, type=None) -> value

descr.__set__(self, obj, value) -> None

descr.__delete__(self, obj) -> None

描述器的方法就这些。一个对象只要定义了以上方法中的任何一个，就被视为描述器，并在被作为属性时覆盖其默认行为。

如果一个对象定义了 __set__() 或 __delete__()，则它会被视为数据描述器。 仅定义了 __get__() 的描述器称为非数据描述器（它们经常被用于方法，但也可以有其他用途）。

数据和非数据描述器的不同之处在于，如何计算实例字典中条目的替代值。如果实例的字典具有与数据描述器同名的条目，则数据描述器优先。如果实例的字典具有与非数据描述器同名的条目，则该字典条目优先。

为了使数据描述器成为只读的，应该同时定义 __get__() 和 __set__() ，并在 __set__() 中引发 AttributeError 。用引发异常的占位符定义 __set__() 方法使其成为数据描述器。

描述器调用概述

描述器可以通过 d.__get__(obj) 或 desc.__get__(None, cls) 直接调用。

但更常见的是通过属性访问自动调用描述器。

表达式 obj.x 在命名空间的链中查找 obj 的属性 x。如果搜索在实例 __dict__ 之外找到描述器，则根据下面列出的优先级规则调用其 __get__() 方法。

调用的细节取决于 obj 是对象、类还是超类的实例。

通过实例调用

实例查找通过命名空间链进行扫描，数据描述器的优先级最高，其次是实例变量、非数据描述器、类变量，最后是 __getattr__() （如果存在的话）。

如果 a.x 找到了一个描述器，那么将通过 desc.__get__(a, type(a)) 调用它。

点运算符的查找逻辑在 object.__getattribute__() 中。这里是一个等价的纯 Python 实现：

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)     # data descriptor
    if hasattr(obj, '__dict__') and name in vars(obj):
        return vars(obj)[name]                          # instance variable
    if descr_get is not null:
        return descr_get(cls_var, obj, objtype)         # non-data descriptor
    if cls_var is not null:
        return cls_var                                  # class variable
    raise AttributeError(name)

请注意，在 __getattribute__() 方法的代码中没有调用 __getattr__() 的钩子。这就是直接调用 __getattribute__() 或调用 super().__getattribute__ 会彻底绕过 __getattr__() 的原因。

相反，当 __getattribute__() 引发 AttributeError 时，点运算符和 getattr() 函数负责调用 __getattr__()。它们的逻辑封装在一个辅助函数中：

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__

通过类调用

像 A.x 这样的点操作符查找的逻辑在 type.__getattribute__() 中。步骤与 object.__getattribute__() 相似，但是实例字典查找改为搜索类的 method resolution order。

如果找到了一个描述器，那么将通过 desc.__get__(None, A) 调用它。

完整的 C 实现可在 Objects/typeobject.c [https://github.com/python/cpython/tree/3.10/Objects/typeobject.c] 中的 type_getattro() 和 _PyType_Lookup() 找到。

通过 super 调用

super 的点操作符查找的逻辑在 super() 返回的对象的 __getattribute__() 方法中。

类似 super(A, obj).m 形式的点分查找将在 obj.__class__.__mro__ 中搜索紧接在 A 之后的基类 B，然后返回 B.__dict__['m'].__get__(obj, A)。如果 m 不是描述器，则直接返回其值。

完整的 C 实现可以在 Objects/typeobject.c [https://github.com/python/cpython/tree/3.10/Objects/typeobject.c] 的 super_getattro() 中找到。纯 Python 等价实现可以在 Guido's Tutorial [https://www.python.org/download/releases/2.2.3/descrintro/#cooperation] 中找到。

调用逻辑总结

描述器的机制嵌入在 object，type 和 super() 的 __getattribute__() 方法中。

要记住的重要点是：

描述器由 __getattribute__() 方法调用。

类从 object，type 或 super() 继承此机制。

由于描述器的逻辑在 __getattribute__() 中，因而重写该方法会阻止描述器的自动调用。

object.__getattribute__() 和 type.__getattribute__() 会用不同的方式调用 __get__()。前一个会传入实例，也可以包括类。后一个传入的实例为 None ，并且总是包括类。

数据描述器始终会覆盖实例字典。

非数据描述器会被实例字典覆盖。

自动名称通知

有时，描述器想知道它分配到的具体类变量名。创建新类时，元类 type 将扫描新类的字典。如果有描述器，并且它们定义了 __set_name__()，则使用两个参数调用该方法。owner 是使用描述器的类，name 是分配给描述器的类变量名。

实现的细节在 Objects/typeobject.c [https://github.com/python/cpython/tree/3.10/Objects/typeobject.c] 中的 type_new() 和 set_names() 。

由于更新逻辑在 type.__new__() 中，因此通知仅在创建类时发生。之后如果将描述器添加到类中，则需要手动调用 __set_name__() 。

ORM （对象关系映射）示例

以下代码展示了如何使用数据描述器来实现简单的 对象关系映射 [https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping] 框架。

其核心思路是将数据存储在外部数据库中，Python 实例仅持有数据库表中对应的的键。描述器负责对值进行查找或更新：

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()

我们可以用 Field 类来定义描述了数据库中每张表的模式的 models [https://en.wikipedia.org/wiki/Database_model]。

class Movie:
    table = 'Movies'                    # Table name
    key = 'title'                       # Primary key
    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

要使用模型，首先要连接到数据库：

>>> import sqlite3
>>> conn = sqlite3.connect('entertainment.db')

交互式会话显示了如何从数据库中检索数据及如何对其进行更新：

>>> 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'

纯 Python 等价实现

描述器协议很简单，但它提供了令人兴奋的可能性。有几个用例非常通用，以至于它们已预先打包到内置工具中。属性、绑定方法、静态方法、类方法和 __slots__ 均基于描述器协议。

属性

调用 property() 是构建数据描述器的简洁方式，该数据描述器在访问属性时触发函数调用。它的签名是：

property(fget=None, fset=None, fdel=None, doc=None) -> property

该文档显示了定义托管属性 x 的典型用法：

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.")

要了解 property() 如何根据描述器协议实现，这里是一个纯 Python 的等价实现：

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
        self._name = ''

    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(f'unreadable attribute {self._name}')
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError(f"can't set attribute {self._name}")
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError(f"can't delete attribute {self._name}")
        self.fdel(obj)

    def getter(self, fget):
        prop = type(self)(fget, self.fset, self.fdel, self.__doc__)
        prop._name = self._name
        return prop

    def setter(self, fset):
        prop = type(self)(self.fget, fset, self.fdel, self.__doc__)
        prop._name = self._name
        return prop

    def deleter(self, fdel):
        prop = type(self)(self.fget, self.fset, fdel, self.__doc__)
        prop._name = self._name
        return prop

这个内置的 property() 每当用户访问属性时生效，随后的变化需要一个方法的参与。

例如，一个电子表格类可以通过 Cell('b10').value 授予对单元格值的访问权限。对程序的后续改进要求每次访问都要重新计算单元格；但是，程序员不希望影响直接访问该属性的现有客户端代码。解决方案是将对 value 属性的访问包装在属性数据描述器中:

class Cell:
    ...

    @property
    def value(self):
        "Recalculate the cell before returning value"
        self.recalc()
        return self._value

在此示例中，内置的 property() 或我们实现的的 Property() 均适用。

函数和方法

Python 的面向对象功能是在基于函数的环境构建的。通过使用非数据描述器，这两方面完成了无缝融合。

在调用时，存储在类词典中的函数将被转换为方法。方法与常规函数的不同之处仅在于对象实例被置于其他参数之前。方法与常规函数的不同之处仅在于第一个参数是为对象实例保留的。按照惯例，实例引用称为 self ，但也可以称为 this 或任何其他变量名称。

可以使用 types.MethodType 手动创建方法，其行为基本等价于：

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)

为了支持自动创建方法，函数包含 __get__() 方法以便在属性访问时绑定其为方法。这意味着函数其是非数据描述器，它在通过实例进行点查找时返回绑定方法，其运作方式如下：

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)

在解释器中运行以下类，这显示了函数描述器的实际工作方式：

class D:
    def f(self, x):
         return x

该函数具有 qualified name 属性以支持自省：

>>> D.f.__qualname__
'D.f'

通过类字典访问函数不会调用 __get__()。相反，它只返回基础函数对象：

>>> D.__dict__['f']
<function D.f at 0x00C45070>

来自类的点运算符访问会调用 __get__()，直接返回底层的函数。

>>> D.f
<function D.f at 0x00C45070>

有趣的行为发生在从实例进行点访问期间。点运算符查找调用 __get__()，返回绑定的方法对象：

>>> d = D()
>>> d.f
<bound method D.f of <__main__.D object at 0x00B18C90>>

绑定方法在内部存储了底层函数和绑定的实例：

>>> d.f.__func__
<function D.f at 0x00C45070>

>>> d.f.__self__
<__main__.D object at 0x1012e1f98>

如果你曾好奇常规方法中的 self 或类方法中的 cls 是从什么地方来的，就是这里了！

方法的种类

非数据描述器为把函数绑定为方法的通常模式提供了一种简单的机制。

概括地说，函数对象具有 __get__() 方法，以便在作为属性访问时可以将其转换为方法。非数据描述器将 obj.f(*args) 的调用会被转换为 f(obj, *args) 。调用 klass.f(*args) 因而变成 f(*args) 。

下表总结了绑定及其两个最有用的变体：

转换形式 | 通过对象调用 | 通过类调用
function -- 函数 | f(obj, *args) | f(*args)
静态方法 | f(*args) | f(*args)
类方法 | f(type(obj), *args) | f(cls, *args)

静态方法

静态方法返回底层函数，不做任何更改。调用 c.f 或 C.f 等效于通过 object.__getattribute__(c, "f") 或 object.__getattribute__(C, "f") 查找。这样该函数就可以从对象或类中进行相同的访问。

适合作为静态方法的是那些不引用 self 变量的方法。

例如，一个统计用的包可能包含一个实验数据的容器类。该容器类提供了用于计算数据的平均值，均值，中位数和其他描述性统计信息的常规方法。但是，可能有在概念上相关但不依赖于数据的函数。例如， erf(x) 是在统计中的便捷转换，但并不直接依赖于特定的数据集。可以从对象或类中调用它： s.erf(1.5) --> .9332 或 Sample.erf(1.5) --> .9332。

由于静态方法返回的底层函数没有任何变化，因此示例调用也是意料之中：

class E:
    @staticmethod
    def f(x):
        return x * 10

>>> E.f(3)
30
>>> E().f(3)
30

使用非数据描述器，纯 Python 版本的 staticmethod() 如下所示：

class StaticMethod:
    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f

    def __get__(self, obj, objtype=None):
        return self.f

    def __call__(self, *args, **kwds):
        return self.f(*args, **kwds)

类方法

与静态方法不同，类方法在调用函数之前将类引用放在参数列表的最前。无论调用方是对象还是类，此格式相同：

class F:
    @classmethod
    def f(cls, x):
        return cls.__name__, x

>>> F.f(3)
('F', 3)
>>> F().f(3)
('F', 3)

当方法仅需要具有类引用并且确实依赖于存储在特定实例中的数据时，此行为就很有用。类方法的一种用途是创建备用类构造函数。例如，类方法 dict.fromkeys() 从键列表创建一个新字典。纯 Python 的等价实现是：

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

现在可以这样构造一个新的唯一键字典：

>>> d = Dict.fromkeys('abracadabra')
>>> type(d) is Dict
True
>>> d
{'a': None, 'b': None, 'r': None, 'c': None, 'd': None}

使用非数据描述器协议，纯 Python 版本的 classmethod() 如下：

class ClassMethod:
    "Emulate PyClassMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f

    def __get__(self, obj, cls=None):
        if cls is None:
            cls = type(obj)
        if hasattr(type(self.f), '__get__'):
            return self.f.__get__(cls, cls)
        return MethodType(self.f, cls)

hasattr(type(self.f), '__get__') 的代码路径在 Python 3.9 中被加入并让 classmethod() 可以支持链式装饰器。 例如，一个类方法和特征属性可以被链接在一起:

class G:
    @classmethod
    @property
    def __doc__(cls):
        return f'A doc for {cls.__name__!r}'

>>> G.__doc__
"A doc for 'G'"

成员对象和 __slots__

当一个类定义了 __slots__，它会用一个固定长度的 slot 值数组来替换实例字典。 从用户的视角看，效果是这样的：

1. Provides immediate detection of bugs due to misspelled attribute assignments. Only attribute names specified in __slots__ are allowed:

class Vehicle:
    __slots__ = ('id_number', 'make', 'model')

>>> auto = Vehicle()
>>> auto.id_nubmer = 'VYE483814LQEX'
Traceback (most recent call last):
    ...
AttributeError: 'Vehicle' object has no attribute 'id_nubmer'

2. Helps create immutable objects where descriptors manage access to private attributes stored in __slots__:

class Immutable:

    __slots__ = ('_dept', '_name')          # Replace the instance dictionary

    def __init__(self, dept, name):
        self._dept = dept                   # Store to private attribute
        self._name = name                   # Store to private attribute

    @property                               # Read-only descriptor
    def dept(self):
        return self._dept

    @property
    def name(self):                         # Read-only descriptor
        return self._name

>>> mark = Immutable('Botany', 'Mark Watney')
>>> mark.dept
'Botany'
>>> mark.dept = 'Space Pirate'
Traceback (most recent call last):
    ...
AttributeError: can't set attribute
>>> mark.location = 'Mars'
Traceback (most recent call last):
    ...
AttributeError: 'Immutable' object has no attribute 'location'

3. Saves memory. On a 64-bit Linux build, an instance with two attributes takes 48 bytes with __slots__ and 152 bytes without. This flyweight design pattern [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 __slots__ (as measured with Python 3.10 on an Apple M1 processor).

5. Blocks tools like functools.cached_property() which require an instance dictionary to function correctly:

from functools import cached_property

class CP:
    __slots__ = ()                          # Eliminates the instance dict

    @cached_property                        # Requires an instance dict
    def pi(self):
        return 4 * sum((-1.0)**n / (2.0*n + 1.0)
                       for n in reversed(range(100_000)))

>>> CP().pi
Traceback (most recent call last):
  ...
TypeError: No '__dict__' attribute on 'CP' instance to cache 'pi' property.

要创建一个一模一样的纯 Python 版的 __slots__ 是不可能的，因为它需要直接访问 C 结构体并控制对象内存分配。 但是，我们可以构建一个非常相似的模拟版，其中作为 slot 的实际 C 结构体由一个私有的 _slotvalues 列表来模拟。 对该私有结构体的读写操作将由成员描述器来管理：

null = object()

class Member:

    def __init__(self, name, clsname, offset):
        'Emulate PyMemberDef in Include/structmember.h'
        # Also see descr_new() in Objects/descrobject.c
        self.name = name
        self.clsname = clsname
        self.offset = offset

    def __get__(self, obj, objtype=None):
        'Emulate member_get() in Objects/descrobject.c'
        # Also see PyMember_GetOne() in Python/structmember.c
        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}>'

type.__new__() 方法负责将成员对象添加到类变量：

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() calls PyTypeReady() which calls 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)

object.__new__() 方法负责创建具有 slot 而非实例字典的实例。 以下是一个纯 Python 的粗略模拟版：

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)

要在真实的类中使用这个模拟版，只需从 Object 继承并将 metaclass 设为 Type：

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

这时，metaclass 已经为 x 和 y 加载了成员对象：

>>> 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'>}

当实例被创建时，它们将拥有一个用于存放属性的 slot_values 列表：

>>> h = H(10, 20)
>>> vars(h)
{'_slotvalues': [10, 20]}
>>> h.x = 55
>>> vars(h)
{'_slotvalues': [55, 20]}

错误拼写或未赋值的属性将引发一个异常：

>>> h.xz
Traceback (most recent call last):
    ...
AttributeError: 'H' object has no attribute 'xz'

函数式编程指引

作者

A. M. Kuchling

发布版本

0.32

本文档提供恰当的 Python 函数式编程范例，在函数式编程简单的介绍之后，将简单介绍Python中关于函数式编程的特性如 iterator 和 generator 以及相关库模块如 itertools 和 functools 等。

概述

本章介绍函数式编程的基本概念。如您仅想学习 Python 语言的特性，可跳过本章直接查看 迭代器.

编程语言支持通过以下几种方式来解构具体问题：

大多数的编程语言都是 过程式 的，所谓程序就是一连串告诉计算机怎样处理程序输入的指令。C、Pascal 甚至 Unix shells 都是过程式语言。

在 声明式 语言中，你编写一个用来描述待解决问题的说明，并且这个语言的具体实现会指明怎样高效的进行计算。 SQL 可能是你最熟悉的声明式语言了。 一个 SQL 查询语句描述了你想要检索的数据集，并且 SQL 引擎会决定是扫描整张表还是使用索引，应该先执行哪些子句等等。

面向对象 程序会操作一组对象。 对象拥有内部状态，并能够以某种方式支持请求和修改这个内部状态的方法。Smalltalk 和 Java 都是面向对象的语言。 C++ 和 Python 支持面向对象编程，但并不强制使用面向对象特性。

函数式 编程则将一个问题分解成一系列函数。 理想情况下，函数只接受输入并输出结果，对一个给定的输入也不会有影响输出的内部状态。 著名的函数式语言有 ML 家族（Standard ML，Ocaml 以及其他变种）和 Haskell。

一些语言的设计者选择强调一种特定的编程方式。 这通常会让以不同的方式来编写程序变得困难。其他多范式语言则支持几种不同的编程方式。Lisp，C++ 和 Python 都是多范式语言；使用这些语言，你可以编写主要为过程式，面向对象或者函数式的程序和函数库。在大型程序中，不同的部分可能会采用不同的方式编写；比如 GUI 可能是面向对象的而处理逻辑则是过程式或者函数式。

在函数式程序里，输入会流经一系列函数。每个函数接受输入并输出结果。函数式风格反对使用带有副作用的函数，这些副作用会修改内部状态，或者引起一些无法体现在函数的返回值中的变化。完全不产生副作用的函数被称作“纯函数”。消除副作用意味着不能使用随程序运行而更新的数据结构；每个函数的输出必须只依赖于输入。

有些语言对纯洁性要求非常严格，甚至没有诸如 a=3 或 c = a + b 之类的赋值语句，但很难避免所有的副作用，如打印到屏幕上或写到磁盘文件之类的副作用。另一个例子是调用 print() 或 time.sleep() 函数，它们都没有返回一个有用的值。这两个函数被调用只是为了它们的副作用，即向屏幕发送一些文本或暂停执行一秒钟。

函数式风格的 Python 程序并不会极端到消除所有 I/O 或者赋值的程度；相反，他们会提供像函数式一样的接口，但会在内部使用非函数式的特性。比如，函数的实现仍然会使用局部变量，但不会修改全局变量或者有其他副作用。

函数式编程可以被认为是面向对象编程的对立面。对象就像是颗小胶囊，包裹着内部状态和随之而来的能让你修改这个内部状态的一组调用方法，以及由正确的状态变化所构成的程序。函数式编程希望尽可能地消除状态变化，只和流经函数的数据打交道。在 Python 里你可以把两种编程方式结合起来，在你的应用（电子邮件信息，事务处理）中编写接受和返回对象实例的函数。

函数式设计在工作中看起来是个奇怪的约束。为什么你要消除对象和副作用呢？不过函数式风格有其理论和实践上的优点：

形式证明。

模块化。

组合性。

易于调试和测试。

形式证明

一个理论上的优点是，构造数学证明来说明函数式程序是正确的相对更容易些。

很长时间，研究者们对寻找证明程序正确的数学方法都很感兴趣。这和通过大量输入来测试，并得出程序的输出基本正确，或者阅读一个程序的源代码然后得出代码看起来没问题不同；相反，这里的目标是一个严格的证明，证明程序对所有可能的输入都能给出正确的结果。

证明程序正确性所用到的技术是写出 不变量，也就是对于输入数据和程序中的变量永远为真的特性。然后对每行代码，你说明这行代码执行前的不变量 X 和 Y 以及执行后稍有不同的不变量 X' 和 Y' 为真。如此一直到程序结束，这时候在程序的输出上，不变量应该会与期望的状态一致。

函数式编程之所以要消除赋值，是因为赋值在这个技术中难以处理；赋值可能会破坏赋值前为真的不变量，却并不产生任何可以传递下去的新的不变量。

不幸的是，证明程序的正确性很大程度上是经验性质的，而且和 Python 软件无关。即使是微不足道的程序都需要几页长的证明；一个中等复杂的程序的正确性证明会非常庞大，而且，极少甚至没有你日常所使用的程序（Python 解释器，XML 解析器，浏览器）的正确性能够被证明。即使你写出或者生成一个证明，验证证明也会是一个问题；里面可能出了差错，而你错误地相信你证明了程序的正确性。

模块化

函数式编程的一个更实用的优点是，它强制你把问题分解成小的方面。因此程序会更加模块化。相对于一个进行了复杂变换的大型函数，一个小的函数更明确，更易于编写, 也更易于阅读和检查错误。

易于调试和测试

测试和调试函数式程序相对来说更容易。

调试很简单是因为函数通常都很小而且清晰明确。当程序无法工作的时候，每个函数都是一个可以检查数据是否正确的接入点。你可以通过查看中间输入和输出迅速找到出错的函数。

测试更容易是因为每个函数都是单元测试的潜在目标。在执行测试前，函数并不依赖于需要重现的系统状态；相反，你只需要给出正确的输入，然后检查输出是否和期望的结果一致。

组合性

当你编写函数式风格的程序时，你会写出很多带有不同输入和输出的函数。其中一些不可避免地会局限于特定的应用，但其他的却可以广泛的用在程序中。举例来说，一个接受文件夹目录返回所有文件夹中的 XML 文件的函数； 或是一个接受文件名，然后返回文件内容的函数，都可以应用在很多不同的场合。

久而久之你会形成一个个人工具库。通常你可以重新组织已有的函数来组成新的程序，然后为当前的工作写一些特殊的函数。

迭代器

我会从 Python 的一个语言特性， 编写函数式风格程序的重要基石开始说起：迭代器。

迭代器是一个表示数据流的对象；这个对象每次只返回一个元素。Python 迭代器必须支持 __next__() 方法；这个方法不接受参数，并总是返回数据流中的下一个元素。如果数据流中没有元素，__next__() 会抛出 StopIteration 异常。迭代器未必是有限的；完全有理由构造一个输出无限数据流的迭代器。

内置的 iter() 函数接受任意对象并试图返回一个迭代器来输出对象的内容或元素，并会在对象不支持迭代的时候抛出 TypeError 异常。Python 有几种内置数据类型支持迭代，最常见的就是列表和字典。如果一个对象能生成迭代器，那么它就会被称作 iterable。

你可以手动试验迭代器的接口。

>>> 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
>>>

Python 有不少要求使用可迭代的对象的地方，其中最重要的就是 for 表达式。在表达式 for X in Y，Y 要么自身是一个迭代器，要么能够由 iter() 创建一个迭代器。以下两种表达是等价的:

for i in iter(obj):
    print(i)

for i in obj:
    print(i)

可以用 list() 或 tuple() 这样的构造函数把迭代器具体化成列表或元组:

>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> t = tuple(iterator)
>>> t
(1, 2, 3)

序列的解压操作也支持迭代器：如果你知道一个迭代器能够返回 N 个元素，你可以把他们解压到有 N 个元素的元组:

>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> a, b, c = iterator
>>> a, b, c
(1, 2, 3)

像 max() 和 min() 这样的内置函数可以接受单个迭代器参数，然后返回其中最大或者最小的元素。 "in" 和 "not in" 操作也支持迭代器：如果能够在迭代器 iterator 返回的数据流中找到 X 的话，则 X in iterator 为真。很显然，如果迭代器是无限的，这么做你就会遇到问题；max() 和 min() 永远也不会返回；如果元素 X 也不出现在数据流中， "in" 和 "not in" 操作同样也永远不会返回。

注意你只能在迭代器中顺序前进；没有获取前一个元素的方法，除非重置迭代器，或者重新复制一份。迭代器对象可以提供这些额外的功能，但迭代器协议只明确了 __next__() 方法。函数可能因此而耗尽迭代器的输出，如果你要对同样的数据流做不同的操作，你必须重新创建一个迭代器。

支持迭代器的数据类型

我们已经知道列表和元组支持迭代器。实际上，Python 中的任何序列类型，比如字符串，都自动支持创建迭代器。

对字典调用 iter() 会返回一个遍历字典的键的迭代器:

>>> 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

注意从 Python 3.7 开始，字典的遍历顺序一定和输入顺序一样。先前的版本并没有明确这一点，所以不同的实现可能不一致。

对字典使用 iter() 总是会遍历键，但字典也有返回其他迭代器的方法。如果你只遍历值或者键/值对，你可以明确地调用 values() 或 items() 方法得到合适的迭代器。

dict() 构造函数可以接受一个迭代器，然后返回一个有限的 (key, value) 元组的数据流:

>>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')]
>>> dict(iter(L))
{'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'}

文件也可以通过调用 readline() 来遍历，直到穷尽文件中所有的行。这意味着你可以像这样读取文件中的每一行:

for line in file:
    # do something for each line
    ...

集合可以从可遍历的对象获取内容，也可以让你遍历集合的元素:

>>> S = {2, 3, 5, 7, 11, 13}
>>> for i in S:
...     print(i)
2
3
5
7
11
13

生成器表达式和列表推导式

迭代器的输出有两个很常见的使用方式，1) 对每一个元素执行操作，2) 选择一个符合条件的元素子集。比如，给定一个字符串列表，你可能想去掉每个字符串尾部的空白字符，或是选出所有包含给定子串的字符串。

列表推导式和生成器表达式 (简写: "listcomp" 和 "genexp") 让这些操作更加简明，这个形式借鉴自函数式编程语言 Haskell (https://www.haskell.org/)。 你可以用以下代码去掉一个字符串流中的所有空白符:

>>> line_list = ['  line 1\n', 'line 2  \n', ' \n', '']

>>> # Generator expression -- returns iterator
>>> stripped_iter = (line.strip() for line in line_list)

>>> # List comprehension -- returns list
>>> stripped_list = [line.strip() for line in line_list]

你可以加上条件语句 "if" 来选取特定的元素:

>>> stripped_list = [line.strip() for line in line_list
...                  if line != ""]

通过列表推导式，你会获得一个 Python 列表；stripped_list 就是一个包含所有结果行的列表，并不是迭代器。 生成器表达式会返回一个迭代器，它在必要的时候计算结果，避免一次性生成所有的值。 这意味着，如果迭代器返回一个无限数据流或者大量的数据，列表推导式就不太好用了。 这种情况下生成器表达式会更受青睐。

生成器表达式两边使用圆括号 ("()") ，而列表推导式则使用方括号 ("[]")。生成器表达式的形式为:

( 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 )

再次说明，列表推导式只有两边的括号不一样（方括号而不是圆括号）。

这些生成用于输出的元素会成为 expression 的后继值。其中 if 语句是可选的；如果给定的话 expression 只会在符合条件时计算并加入到结果中。

生成器表达式总是写在圆括号里面，不过也可以算上调用函数时用的括号。如果你想即时创建一个传递给函数的迭代器，可以这么写:

obj_total = sum(obj.count for obj in list_all_objects())

其中 for...in 语句包含了将要遍历的序列。这些序列并不必须同样长，因为它们会从左往右开始遍历，而 不是 同时执行。对每个 sequence1 中的元素，sequence2 会从头开始遍历。sequence3 会对每个 sequence1 和 sequence2 的元素对开始遍历。

换句话说，列表推导式器是和下面的 Python 代码等价:

for expr1 in sequence1:
    if not (condition1):
        continue   # Skip this element
    for expr2 in sequence2:
        if not (condition2):
            continue   # Skip this element
        ...
        for exprN in sequenceN:
            if not (conditionN):
                continue   # Skip this element

            # Output the value of
            # the expression.

这说明，如果有多个 for...in 语句而没有 if 语句，输出结果的长度就是所有序列长度的乘积。如果你的两个列表长度为3，那么输出的列表长度就是9:

>>> 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)]

为了不让 Python 语法变得含糊，如果 expression 会生成元组，那这个元组必须要用括号括起来。下面第一个列表推导式语法错误，第二个则是正确的:

# Syntax error
[x, y for x in seq1 for y in seq2]
# Correct
[(x, y) for x in seq1 for y in seq2]

生成器

生成器是一类用来简化编写迭代器工作的特殊函数。普通的函数计算并返回一个值，而生成器返回一个能返回数据流的迭代器。

毫无疑问，你已经对如何在 Python 和 C 中调用普通函数很熟悉了，这时候函数会获得一个创建局部变量的私有命名空间。当函数到达 return 表达式时，局部变量会被销毁然后把返回给调用者。之后调用同样的函数时会创建一个新的私有命名空间和一组全新的局部变量。但是，如果在退出一个函数时不扔掉局部变量会如何呢？如果稍后你能够从退出函数的地方重新恢复又如何呢？这就是生成器所提供的；他们可以被看成可恢复的函数。

这里有简单的生成器函数示例:

>>> def generate_ints(N):
...    for i in range(N):
...        yield i

任何包含了 yield 关键字的函数都是生成器函数；Python 的 bytecode 编译器会在编译的时候检测到并因此而特殊处理。

当你调用一个生成器函数，它并不会返回单独的值，而是返回一个支持生成器协议的生成器对象。当执行 yield 表达式时，生成器会输出 i 的值，就像 return 表达式一样。yield 和 return 最大的区别在于，到达 yield 的时候生成器的执行状态会挂起并保留局部变量。在下一次调用生成器 __next__() 方法的时候，函数会恢复执行。

这里有一个 generate_ints() 生成器的示例:

>>> 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

同样，你可以写出 for i in generate_ints(5)，或者 a, b, c = generate_ints(3)。

在生成器函数里面，return value 会触发从 __next__() 方法抛出 StopIteration(value) 异常。一旦抛出这个异常，或者函数结束，处理数据的过程就会停止，生成器也不会再生成新的值。

你可以手动编写自己的类来达到生成器的效果，把生成器的所有局部变量作为实例的成员变量存储起来。比如，可以这么返回一个整数列表：把 self.count 设为0，然后通过 count`()。然而，对于一个中等复杂程度的生成器，写出一个相应的类可能会相当繁杂。

包含在 Python 库中的测试套件 Lib/test/test_generators.py [https://github.com/python/cpython/tree/3.10/Lib/test/test_generators.py] 里有很多非常有趣的例子。这里是一个用生成器实现树的递归中序遍历示例。:

# A recursive generator that generates Tree leaves in in-order.
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x

        yield t.label

        for x in inorder(t.right):
            yield x

另外两个 test_generators.py 中的例子给出了 N 皇后问题（在 NxN 的棋盘上放置 N 个皇后，任何一个都不能吃掉另一个），以及马的遍历路线（在NxN 的棋盘上给马找出一条不重复的走过所有格子的路线）的解。

向生成器传递值

在 Python 2.4 及之前的版本中，生成器只产生输出。一旦调用生成器的代码创建一个迭代器，就没有办法在函数恢复执行的时候向它传递新的信息。你可以设法实现这个功能，让生成器引用一个全局变量或者一个调用者可以修改的可变对象，但是这些方法都很繁杂。

在 Python 2.5 里有一个简单的将值传递给生成器的方法。yield 变成了一个表达式，返回一个可以赋给变量或执行操作的值:

val = (yield i)

我建议你在处理 yield 表达式返回值的时候， 总是 两边写上括号，就像上面的例子一样。括号并不总是必须的，但是比起记住什么时候需要括号，写出来会更容易一点。

（PEP 342 [https://www.python.org/dev/peps/pep-0342] 解释了具体的规则，也就是 yield 表达式必须括起来，除非是出现在最顶级的赋值表达式的右边。这意味着你可以写 val = yield i，但是必须在操作的时候加上括号，就像 val = (yield i) + 12）

可以调用 send(value)() <generator.send> 方法向生成器发送值。这个方法会恢复执行生成器的代码，然后 yield 表达式返回特定的值。如果调用普通的 __next__`方法，``yield`() 会返回 None.

这里有一个简单的每次加1的计数器，并允许改变内部计数器的值。

def counter(maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # If value provided, change counter
        if val is not None:
            i = val
        else:
            i += 1

这是改变计数器的一个示例

>>> 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

因为 yield 很多时候会返回 None，所以你应该总是检查这个情况。不要在表达式中使用 yield 的值，除非你确定 send() 是唯一的用来恢复你的生成器函数的方法。

除了 send() 之外，生成器还有两个其他的方法:

throw(value) 用于在生成器内部抛出异常；这个异常会在生成器暂停执行的时候由 yield 表达式抛出。

generator.close() 会在生成器内部抛出 GeneratorExit 异常来结束迭代。当接收到这个异常时，生成器的代码会抛出 GeneratorExit 或者 StopIteration；捕捉这个异常作其他处理是非法的，并会出发 RuntimeError。close() 也会在 Python 垃圾回收器回收生成器的时候调用。

如果你要在 GeneratorExit 发生的时候清理代码，我建议使用 try: ... finally: 组合来代替 GeneratorExit。

这些改变的累积效应是，让生成器从单向的信息生产者变成了既是生产者，又是消费者。

生成器也可以成为 协程 ，一种更广义的子过程形式。子过程可以从一个地方进入，然后从另一个地方退出（从函数的顶端进入，从 return 语句退出），而协程可以进入，退出，然后在很多不同的地方恢复（yield 语句）。

内置函数

我们可以看看迭代器常常用到的函数的更多细节。

Python 内置的两个函数 map() 和 filter() 复制了生成器表达式的两个特性:

map(f, iterA, iterB, ...) 返回一个遍历序列的迭代器

f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2], iterB[2]), ....

>>> def upper(s):
...     return s.upper()

>>> list(map(upper, ['sentence', 'fragment']))
['SENTENCE', 'FRAGMENT']
>>> [upper(s) for s in ['sentence', 'fragment']]
['SENTENCE', 'FRAGMENT']

你当然也可以用列表推导式达到同样的效果。

filter(predicate, iter) 返回一个遍历序列中满足指定条件的元素的迭代器，和列表推导式的功能相似。 predicate （谓词）是一个在特定条件下返回真值的函数；要使用函数 filter()，谓词函数必须只能接受一个参数。

>>> def is_even(x):
...     return (x % 2) == 0

>>> list(filter(is_even, range(10)))
[0, 2, 4, 6, 8]

这也可以写成列表推导式:

>>> list(x for x in range(10) if is_even(x))
[0, 2, 4, 6, 8]

enumerate(iter, start=0) 计数可迭代对象中的元素，然后返回包含每个计数（从 start 开始）和元素两个值的元组。:

>>> for item in enumerate(['subject', 'verb', 'object']):
...     print(item)
(0, 'subject')
(1, 'verb')
(2, 'object')

enumerate() 常常用于遍历列表并记录达到特定条件时的下标:

f = open('data.txt', 'r')
for i, line in enumerate(f):
    if line.strip() == '':
        print('Blank line at line #%i' % i)

sorted(iterable, key=None, reverse=False) 会将 iterable 中的元素收集到一个列表中，然后排序并返回结果。其中 key 和 reverse 参数会传递给所创建列表的 sort() 方法。:

>>> 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]

（对排序更详细的讨论可参见 排序指南。）

内置函数 any(iter) 和 all(iter) 会查看一个可迭代对象内容的逻辑值。any() 在可迭代对象中任意一个元素为真时返回 True，而 all() 在所有元素为真时返回 True:

>>> 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

zip(iterA, iterB, ...) 从每个可迭代对象中选取单个元素组成列表并返回:

zip(['a', 'b', 'c'], (1, 2, 3)) =>
  ('a', 1), ('b', 2), ('c', 3)

它并不会在内存创建一个列表并因此在返回前而耗尽输入的迭代器；相反，只有在被请求的时候元组才会创建并返回。（这种行为的技术术语叫惰性计算，参见 lazy evaluation [https://en.wikipedia.org/wiki/Lazy_evaluation].）

这个迭代器设计用于长度相同的可迭代对象。如果可迭代对象的长度不一致，返回的数据流的长度会和最短的可迭代对象相同

zip(['a', 'b'], (1, 2, 3)) =>
  ('a', 1), ('b', 2)

然而，你应该避免这种情况，因为所有从更长的迭代器中取出的元素都会被丢弃。这意味着之后你也无法冒着跳过被丢弃元素的风险来继续使用这个迭代器。

itertools 模块

itertools 模块包含很多常用的迭代器以及用于组合多个迭代器的函数。 本节会用一些小例子来介绍这个模块的内容。

这个模块里的函数大致可以分为几类：

从已有的迭代器创建新的迭代器的函数。

接受迭代器元素作为参数的函数。

选取部分迭代器输出的函数。

给迭代器输出分组的函数。

创建新的迭代器

itertools.count(start, step) 返回一个等分的无限数据流。初始值默认为0，间隔默认为1，你也选择可以指定初始值和间隔:

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, ...

itertools.cycle(iter) 保存一份所提供的可迭代对象的副本，并返回一个能产生整个可迭代对象序列的新迭代器。新迭代器会无限重复这些元素。:

itertools.cycle([1, 2, 3, 4, 5]) =>
  1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ...

itertools.repeat(elem, [n]) 返回 n 次所提供的元素，当 n 不存在时，返回无数次所提供的元素。

itertools.repeat('abc') =>
  abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ...
itertools.repeat('abc', 5) =>
  abc, abc, abc, abc, abc

itertools.chain(iterA, iterB, ...) 接受任意数量的可迭代对象作为输入，首先返回第一个迭代器的所有元素，然后是第二个的所有元素，如此一直进行下去，直到消耗掉所有输入的可迭代对象。

itertools.chain(['a', 'b', 'c'], (1, 2, 3)) =>
  a, b, c, 1, 2, 3

itertools.islice(iter, [start], stop, [step]) 返回一个所输入的迭代器切片的数据流。如果只单独给定 stop 参数的话，它会返回从起始算起 stop 个数量的元素。如果你提供了起始下标 start，你会得到 stop-start 个元素；如果你给定了 step 参数，数据流会跳过相应的元素。和 Python 里的字符串和列表切片不同，你不能在 start, stop 或者 step 这些参数中使用负数。:

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

itertools.tee(iter, [n]) 可以复制一个迭代器；它返回 n 个能够返回源迭代器内容的独立迭代器。如果你不提供参数 n，默认值为 2。复制迭代器需要保存源迭代器的一部分内容，因此在源迭代器比较大的时候会显著地占用内存；同时，在所有新迭代器中，有一个迭代器会比其他迭代器占用更多的内存。

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, ...

对元素使用函数

operator 模块包含一组对应于 Python 操作符的函数。比如 operator.add(a, b) （把两个数加起来），operator.ne(a, b) （和 a != b 相同），以及 operator.attrgetter('id') （返回获取 .id 属性的可调用对象）。

itertools.starmap(func, iter) 假定可迭代对象能够返回一个元组的流，并且利用这些元组作为参数来调用 func:

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

选择元素

另外一系列函数根据谓词选取一个迭代器中元素的子集。

itertools.filterfalse(predicate, iter) 和 filter() 相反，返回所有让 predicate 返回 false 的元素:

itertools.filterfalse(is_even, itertools.count()) =>
  1, 3, 5, 7, 9, 11, 13, 15, ...

itertools.takewhile(predicate, iter) 返回一直让 predicate 返回 true 的元素。一旦 predicate 返回 false，迭代器就会发出终止结果的信号。:

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

itertools.dropwhile(predicate, iter) 在 predicate 返回 true 的时候丢弃元素，并且返回可迭代对象的剩余结果。:

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, ...

itertools.compress(data, selectors) 接受两个迭代器，然后返回 data 中使相应地 selector 中的元素为真的元素；它会在任一个迭代器耗尽的时候停止:

itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) =>
   1, 2, 5

组合函数

itertools.combinations(iterable, r) 返回一个迭代器，它能给出输入迭代器中所包含的元素的所有可能的 r 元元组的组合。:

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)

每个元组中的元素保持着 可迭代对象 返回他们的顺序。例如，在上面的例子中数字 1 总是会在 2, 3, 4 或 5 前面。一个类似的函数，itertools.permutations(iterable, r=None)，取消了保持顺序的限制，返回所有可能的长度为 r 的排列:

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)

如果你不提供 r 参数的值，它会使用可迭代对象的长度，也就是说会排列所有的元素。

注意这些函数会输出所有可能的位置组合，并不要求 可迭代对象 的内容不重复:

itertools.permutations('aba', 3) =>
  ('a', 'b', 'a'), ('a', 'a', 'b'), ('b', 'a', 'a'),
  ('b', 'a', 'a'), ('a', 'a', 'b'), ('a', 'b', 'a')

同一个元组 ('a', 'a', 'b') 出现了两次，但是两个 'a' 字符来自不同的位置。

itertools.combinations_with_replacement(iterable, r) 函数放松了一个不同的限制：元组中的元素可以重复。从概念讲，为每个元组第一个位置选取一个元素，然后在选择第二个元素前替换掉它。:

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)

为元素分组

我要讨论的最后一个函数，itertools.groupby(iter,key_func=None)，是最复杂的函数。 key_func(elem) 是一个可以对迭代器返回的每个元素计算键值的函数。 如果你不提供这个键值函数，它就会简化成每个元素自身。

groupby() 从所依据的可迭代对象中连续地收集具有相同值的元素，然后返回一个长度为2的元组的数据流, 每个元组包含键值以及对应这个键值的元素所组成的迭代器。

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')

groupby() 假定了所依据的可迭代对象的内容已经根据键值排序。注意，返回的迭代器也会使用所依据的可迭代对象，所以在请求迭代器 2和相应的键之前你必须先消耗迭代器 1 的结果。

functools 模块

Python 2.5 中的 functools 模块包含了一些高阶函数。 高阶函数 接受一个或多个函数作为输入，返回新的函数。 这个模块中最有用的工具是 functools.partial() 函数。

对于用函数式风格编写的程序，有时你会希望通过给定部分参数，将已有的函数构变形称新的函数。考虑一个 Python 函数 f(a, b, c)；你希望创建一个和 f(1, b, c) 等价的新函数 g(b, c)；也就是说你给定了 f() 的一个参数的值。这就是所谓的“部分函数应用”。

partial() 接受参数 (function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2)。它会返回一个可调用的对象，所以你能够直接调用这个结果以使用给定参数的 function。

这里有一个很小但很现实的例子:

import functools

def log(message, subsystem):
    """Write the contents of 'message' to the specified subsystem."""
    print('%s: %s' % (subsystem, message))
    ...

server_log = functools.partial(log, subsystem='server')
server_log('Unable to open socket')

functools.reduce(func, iter, [initial_value]) 持续地在可迭代对象的所有元素上执行操作，因此它不能够用在无限的可迭代对象上。func 必须是一个接受两个元素并返回一个值的函数。functools.reduce() 接受迭代器返回的前两个元素 A 和 B 并计算 func(A, B) 。然后它会请求第三个元素，C，计算 func(func(A, B), C)，然后把这个结果再和第四个元素组合并返回，如此继续下去直到消耗整个可迭代对象。如果输入的可迭代对象完全不返回任何值，TypeError 异常就会抛出。如果提供了初值(initial value)，它会被用作起始值，也就是先计算 func(initial_value, A) 。:

>>> 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

如果你在 functools.reduce() 中使用 operator.add()，你就会把可迭代对象中的所有元素加起来.这种情况非常常见, 所以 Python 有一个特殊的内置函数 sum():

>>> import functools, operator
>>> functools.reduce(operator.add, [1, 2, 3, 4], 0)
10
>>> sum([1, 2, 3, 4])
10
>>> sum([])
0

不过, 对于很多使用 functools.reduce() 的情形, 使用明显的 for 循环会更清晰:

import functools
# Instead of:
product = functools.reduce(operator.mul, [1, 2, 3], 1)

# You can write:
product = 1
for i in [1, 2, 3]:
    product *= i

一个相关的函数是 itertools.accumulate(iterable, func=operator.add) 。它执行同样的计算, 不过相对于只返回最终结果，accumulate() 会返回一个迭代器来输出所有中间结果:

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

operator 模块

前面已经提到了 operator 模块。它包含一系列对应于 Python 操作符的函数。在函数式风格的代码中，这些函数通常很有用，可以帮你省下不少时间，避免写一些琐碎的仅仅执行一个简单操作的函数。

这个模块里的一些函数：

数学运算： add()，sub()，mul()，floordiv()，abs()， ...

逻辑运算： not_()，truth()。

位运算： and_()，or_()，invert()。

比较： eq()，ne()，lt()，le()，gt()，和 ge()。

确认对象： is_()，is_not()。

全部函数列表可以参考 operator 模块的文档。

小函数和 lambda 表达式

编写函数式风格程序时，你会经常需要很小的函数，作为谓词函数或者以某种方式来组合元素。

如果合适的 Python 内置的或者其他模块中的函数，你就一点也不需要定义新的函数:

stripped_lines = [line.strip() for line in lines]
existing_files = filter(os.path.exists, file_list)

如果不存在你需要的函数，你就必须自己编写。一个编写小函数的方式是使用 lambda 表达式。lambda 接受一组参数以及组合这些参数的表达式，它会创建一个返回表达式值的匿名函数:

adder = lambda x, y: x+y

print_assign = lambda name, value: name + '=' + str(value)

另一种替代方案就是通常的使用 def 语句来定义函数:

def adder(x, y):
    return x + y

def print_assign(name, value):
    return name + '=' + str(value)

哪一种更受青睐呢？这是一个风格问题；我通常的做法是避免使用 lambda。

我这么偏好的一个原因是，lambda 能够定义的函数非常受限。函数的结果必须能够作为单独的表达式来计算，这意味着你不能使用多路 if... elif... else 比较，或者 try... except 语句。如果你尝试在 lambda 语句中做太多事情，你最终会把表达式过于复杂以至于难以阅读。你能快速的说出下面的代码做了什么事情吗？:

import functools
total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1]

你可以弄明白，不过要花上时间来理清表达式来搞清楚发生了什么。使用一个简短的嵌套的 def 语句可以让情况变得更好:

import functools
def combine(a, b):
    return 0, a[1] + b[1]

total = functools.reduce(combine, items)[1]

如果我仅仅使用一个 for 循环会更好:

total = 0
for a, b in items:
    total += b

或者使用内置的 sum() 和一个生成器表达式:

total = sum(b for a, b in items)

许多使用 functools.reduce() 的情形可以更清晰地写成 for 循环的形式。

Fredrik Lundh 曾经建议以下一组规则来重构 lambda 的使用:

写一个 lambda 函数。

写一句注释来说明这个 lambda 究竟干了什么。

研究一会这个注释，然后想出一个抓住注释本质的名字。

用这个名字，把这个 lambda 改写成 def 语句。

把注释去掉。

我非常喜欢这些规则，不过你完全有权利争辩这种消除 lambda 的风格是不是更好。

修订记录和致谢

作者要感谢以下人员对本文各种草稿给予的建议，更正和协助：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 版: 添加了有关 functional 模块的小节，由 Collin Winter 撰写；添加了有关 operator 模块的简短小节；其他少量修改。

参考文献

通用文献

Structure and Interpretation of Computer Programs, Harold Abelson, Gerald Jay Sussman 和 Julie Sussman 著。全文可见 https://mitpress.mit.edu/sicp/ 。在这部计算机科学的经典教科书中，第二和第三章讨论了使用序列和流来组织程序内部的数据传递。书中的示例采用 Scheme 语言，但其中这些章节中描述的很多设计方法同样适用于函数式风格的 Python 代码。

https://www.defmacro.org/ramblings/fp.html: 一个使用 Java 示例并且具有详细的历史说明的函数式编程的总体介绍。

https://en.wikipedia.org/wiki/Functional_programming: 一般性的函数式编程的 Wikipedia 条目。

https://en.wikipedia.org/wiki/Coroutine: 协程条目。

https://en.wikipedia.org/wiki/Currying: 函数柯里化条目。

Python 相关

https://gnosis.cx/TPiP/: David Mertz 书中的第一章 Text Processing in Python 中标题为 "Utilizing Higher-Order Functions in Text Processing" 的小节讨论了针对文本处理的函数式编程。

Mertz 还在 IBM 的 DeveloperWorks 站点上针对函数式编程撰写了一系列共 3 篇文章；参见 part 1 [https://developer.ibm.com/articles/l-prog/], part 2 [https://developer.ibm.com/tutorials/l-prog2/] 和 part 3 [https://developer.ibm.com/tutorials/l-prog3/],

Python 文档

itertools 模块文档。

functools 模块文档。

operator 模块文档。

PEP 289 [https://www.python.org/dev/peps/pep-0289]: "Generator Expressions"

PEP 342 [https://www.python.org/dev/peps/pep-0342]: "Coroutines via Enhanced Generators" 描述了 Python 2.5 中新的生成器特性。

日志指南

作者

Vinay Sajip <vinay_sajip at red-dove dot com>

日志基础教程

日志是对软件执行时所发生事件的一种追踪方式。软件开发人员对他们的代码添加日志调用，借此来指示某事件的发生。一个事件通过一些包含变量数据的描述信息来描述（比如：每个事件发生时的数据都是不同的）。开发者还会区分事件的重要性，重要性也被称为 等级 或 严重性。

什么时候使用日志

对于简单的日志使用来说日志功能提供了一系列便利的函数。它们是 debug()，info()，warning()，error() 和 critical()。想要决定何时使用日志，请看下表，其中显示了对于每个通用任务集合来说最好的工具。

你想要执行的任务 | 此任务最好的工具
对于命令行或程序的应用，结果显示在控制台。 | print()
在对程序的普通操作发生时提交事件报告(比如：状态监控和错误调查) | logging.info() 函数(当有诊断目的需要详细输出信息时使用 logging.debug() 函数)
提出一个警告信息基于一个特殊的运行时事件 | warnings.warn() 位于代码库中，该事件是可以避免的，需要修改客户端应用以消除告警 logging.warning() 不需要修改客户端应用，但是该事件还是需要引起关注
对一个特殊的运行时事件报告错误 | 引发异常
报告错误而不引发异常(如在长时间运行中的服务端进程的错误处理) | logging.error(), logging.exception() 或 logging.critical() 分别适用于特定的错误及应用领域

日志功能应以所追踪事件级别或严重性而定。各级别适用性如下（以严重性递增）：

级别 | 何时使用
DEBUG | 细节信息，仅当诊断问题时适用。
INFO | 确认程序按预期运行。
WARNING | 表明有已经或即将发生的意外（例如：磁盘空间不足）。程序仍按预期进行。
ERROR | 由于严重的问题，程序的某些功能已经不能正常执行
CRITICAL | 严重的错误，表明程序已不能继续执行

默认的级别是 WARNING，意味着只会追踪该级别及以上的事件，除非更改日志配置。

所追踪事件可以以不同形式处理。最简单的方式是输出到控制台。另一种常用的方式是写入磁盘文件。

一个简单的例子

一个非常简单的例子:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

如果你在命令行中输入这些代码并运行，你将会看到：

WARNING:root:Watch out!

输出到命令行。INFO 消息并没有出现，因为默认级别是 WARNING 。打印的信息包含事件的级别以及在日志调用中的对于事件的描述，例如 “Watch out!”。暂时不用担心 “root” 部分：之后会作出解释。输出格式可按需要进行调整，格式化选项同样会在之后作出解释。

记录日志到文件

一种很常见的情况是将日志事件记录到文件中，下面让我们来看这个问题。 请确认在一个新启动的 Python 解释器中尝试以下操作，而非在上面描述的会话中继续:

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

在 3.9 版更改: 增加了 encoding 参数。在更早的 Python 版本中或没有指定时，编码会用 open() 使用的默认值。尽管在上面的例子中没有展示，但也可以传入一个决定如何处理编码错误的 errors 参数。可使用的值和默认值，请参照 open() 的文档。

现在，如果我们打开日志文件，我们应当能看到日志信息：

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

该示例同样展示了如何设置日志追踪级别的阈值。该示例中，由于我们设置的阈值是 DEBUG，所有信息都将被打印。

如果你想从命令行设置日志级别，例如：

--log=INFO

并且你将 --log 命令的参数存进了变量 loglevel，你可以用：

getattr(logging, loglevel.upper())

获取要通过 level 参数传给 basicConfig() 的值。可如下对用户输入值进行错误检查：

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --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, ...)

对 basicConfig() 的调用应该在 debug()，info() 等之前。否则，这些函数会替你用默认配置调用 basicConfig()。它被设计为一次性的配置，只有第一次调用会进行操作，随后的调用不会产生有效操作。

如果多次运行上述脚本，则连续运行的消息将追加到文件 example.log 。 如果你希望每次运行重新开始，而不是记住先前运行的消息，则可以通过将上例中的调用更改为来指定 filemode 参数:

logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)

输出将与之前相同，但不再追加进日志文件，因此早期运行的消息将丢失。

从多个模块记录日志

如果你的程序包含多个模块，这里有一个如何组织日志记录的示例:

# myapp.py
import logging
import mylib

def main():
    logging.basicConfig(filename='myapp.log', level=logging.INFO)
    logging.info('Started')
    mylib.do_something()
    logging.info('Finished')

if __name__ == '__main__':
    main()

# mylib.py
import logging

def do_something():
    logging.info('Doing something')

如果你运行 myapp.py ，你应该在 myapp.log 中看到：

INFO:root:Started
INFO:root:Doing something
INFO:root:Finished

这是你期待看到的。 你可以使用 mylib.py 中的模式将此概括为多个模块。 请注意，对于这种简单的使用模式，除了查看事件描述之外，你不能通过查看日志文件来了解应用程序中消息的 来源 。 如果要跟踪消息的位置，则需要参考教程级别以外的文档 —— 请参阅 进阶日志教程 。

记录变量数据

要记录变量数据，请使用格式字符串作为事件描述消息，并附加传入变量数据作为参数。 例如:

import logging
logging.warning('%s before you %s', 'Look', 'leap!')

将显示：

WARNING:root:Look before you leap!

如你所见，将可变数据合并到事件描述消息中使用旧的 %-s形式的字符串格式化。 这是为了向后兼容：logging 包的出现时间早于较新的格式化选项例如 str.format() 和 string.Template。 这些较新格式化选项 是 受支持的，但探索它们超出了本教程的范围：有关详细信息，请参阅 生效于整个应用程序的格式化样式。

更改显示消息的格式

要更改用于显示消息的格式，你需要指定要使用的格式:

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')

这将输出：

DEBUG:This message should appear on the console
INFO:So should this
WARNING:And this, too

注意在前面例子中出现的 “root” 已消失。文档 LogRecord 属性 列出了可在格式字符串中出现的所有内容，但在简单的使用场景中，你只需要 levelname （严重性）、message （事件描述，包含可变的数据）或许再加上事件发生的时间。 这将在下一节中介绍。

在消息中显示日期/时间

要显示事件的日期和时间，你可以在格式字符串中放置 '%(asctime)s'

import logging
logging.basicConfig(format='%(asctime)s %(message)s')
logging.warning('is when this event was logged.')

应该打印这样的东西：

2010-12-12 11:41:42,612 is when this event was logged.

日期/时间显示的默认格式（如上所示）类似于 ISO8601 或 RFC 3339 [https://datatracker.ietf.org/doc/html/rfc3339.html] 。 如果你需要更多地控制日期/时间的格式，请为 basicConfig 提供 datefmt 参数，如下例所示:

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.')

这会显示如下内容：

12/12/2010 11:46:36 AM is when this event was logged.

datefmt 参数的格式与 time.strftime() 支持的格式相同。

后续步骤

基本教程到此结束。 它应该足以让你启动并运行日志记录。 logging 包提供了更多功能，但为了充分利用它，你需要花更多的时间来阅读以下部分。 如果你准备好了，可以拿一些你最喜欢的饮料然后继续。

如果你的日志记录需求很简单，那么使用上面的示例将日志记录合并到你自己的脚本中，如果你遇到问题或者不理解某些内容，请在 comp.lang.python Usenet 组上发布一个问题（在 https://groups.google.com/forum/#!forum/comp.lang.python ） ，你将在短时间内得到帮助。

还不够？ 你可以继续阅读接下来的几个部分，这些部分提供了比上面基本部分更高级或深入的教程。 之后，你可以看一下 日志专题手册 。

进阶日志教程

日志库采用模块化方法，并提供几类组件：记录器、处理器、过滤器和格式器。

记录器暴露了应用程序代码直接使用的接口。

处理器将日志记录（由记录器创建）发送到适当的目标。

过滤器提供了更细粒度的功能，用于确定要输出的日志记录。

格式器指定最终输出中日志记录的样式。

日志事件信息在 LogRecord 实例中的记录器、处理器、过滤器和格式器之间传递。

通过调用 Logger 类（以下称为 loggers ， 记录器）的实例来执行日志记录。 每个实例都有一个名称，它们在概念上以点（句点）作为分隔符排列在命名空间的层次结构中。 例如，名为 'scan' 的记录器是记录器 'scan.text' ，'scan.html' 和 'scan.pdf' 的父级。 记录器名称可以是你想要的任何名称，并指示记录消息源自的应用程序区域。

在命名记录器时使用的一个好习惯是在每个使用日志记录的模块中使用模块级记录器，命名如下:

logger = logging.getLogger(__name__)

这意味着记录器名称跟踪包或模块的层次结构，并且直观地从记录器名称显示记录事件的位置。

记录器层次结构的根称为根记录器。 这是函数 debug() 、 info() 、 warning() 、 error() 和 critical() 使用的记录器，它们就是调用了根记录器的同名方法。 函数和方法具有相同的签名。 根记录器的名称在输出中打印为 'root' 。

当然，可以将消息记录到不同的地方。 软件包中的支持包含，用于将日志消息写入文件、 HTTP GET/POST 位置、通过 SMTP 发送电子邮件、通用套接字、队列或特定于操作系统的日志记录机制（如 syslog 或 Windows NT 事件日志）。 目标由 handler 类提供。 如果你有任何内置处理器类未满足的特殊要求，则可以创建自己的日志目标类。

默认情况下，没有为任何日志消息设置目标。 你可以使用 basicConfig() 指定目标（例如控制台或文件），如教程示例中所示。 如果你调用函数 debug() 、 info() 、 warning() 、 error() 和 critical() ，它们将检查是否有设置目标；如果没有设置，将在委托给根记录器进行实际的消息输出之前设置目标为控制台（ sys.stderr ）并设置显示消息的默认格式。

由 basicConfig() 设置的消息默认格式为：

severity:logger name:message

你可以通过使用 format 参数将格式字符串传递给 basicConfig() 来更改此设置。有关如何构造格式字符串的所有选项，请参阅 格式器对象 。

记录流程

记录器和处理器中的日志事件信息流程如下图所示。

记录器

Logger 对象有三重任务。首先，它们向应用程序代码公开了几种方法，以便应用程序可以在运行时记录消息。其次，记录器对象根据严重性（默认过滤工具）或过滤器对象确定要处理的日志消息。第三，记录器对象将相关的日志消息传递给所有感兴趣的日志处理器。

记录器对象上使用最广泛的方法分为两类：配置和消息发送。

这些是最常见的配置方法：

Logger.setLevel() 指定记录器将处理的最低严重性日志消息，其中 debug 是最低内置严重性级别， critical 是最高内置严重性级别。 例如，如果严重性级别为 INFO ，则记录器将仅处理 INFO 、 WARNING 、 ERROR 和 CRITICAL 消息，并将忽略 DEBUG 消息。

Logger.addHandler() 和 Logger.removeHandler() 从记录器对象中添加和删除处理器对象。处理器在以下内容中有更详细的介绍 处理器 。

Logger.addFilter() 和 Logger.removeFilter() 可以添加或移除记录器对象中的过滤器。 过滤器对象 包含更多的过滤器细节。

你不需要总是在你创建的每个记录器上都调用这些方法。 请参阅本节的最后两段。

配置记录器对象后，以下方法将创建日志消息：

Logger.debug() 、 Logger.info() 、 Logger.warning() 、 Logger.error() 和 Logger.critical() 都创建日志记录，包含消息和与其各自方法名称对应的级别。该消息实际上是一个格式化字符串，它可能包含标题字符串替换语法 %s 、 %d 、 %f 等等。其余参数是与消息中的替换字段对应的对象列表。关于 **kwargs ，日志记录方法只关注 exc_info 的关键字，并用它来确定是否记录异常信息。

Logger.exception() 创建与 Logger.error() 相似的日志信息。 不同之处是， Logger.exception() 同时还记录当前的堆栈追踪。仅从异常处理程序调用此方法。

Logger.log() 将日志级别作为显式参数。对于记录消息而言，这比使用上面列出的日志级别便利方法更加冗长，但这是使用自定义日志级别的方法。

getLogger() 返回对具有指定名称的记录器实例的引用（如果已提供），或者如果没有则返回 root 。名称是以句点分隔的层次结构。多次调用 getLogger() 具有相同的名称将返回对同一记录器对象的引用。在分层列表中较低的记录器是列表中较高的记录器的子项。例如，给定一个名为 foo 的记录器，名称为 foo.bar 、 foo.bar.baz 和 foo.bam 的记录器都是 foo 子项。

记录器具有 有效等级 的概念。如果未在记录器上显式设置级别，则使用其父记录器的级别作为其有效级别。如果父记录器没有明确的级别设置，则检查 其 父级。依此类推，搜索所有上级元素，直到找到明确设置的级别。根记录器始终具有明确的级别配置（默认情况下为 WARNING ）。在决定是否处理事件时，记录器的有效级别用于确定事件是否传递给记录器相关的处理器。

子记录器将消息传播到与其父级记录器关联的处理器。因此，不必为应用程序使用的所有记录器定义和配置处理器。一般为顶级记录器配置处理器，再根据需要创建子记录器就足够了。（但是，你可以通过将记录器的 propagate 属性设置为 False 来关闭传播。）

处理器

Handler 对象负责将适当的日志消息（基于日志消息的严重性）分派给处理器的指定目标。 Logger 对象可以使用 addHandler() 方法向自己添加零个或多个处理器对象。作为示例场景，应用程序可能希望将所有日志消息发送到日志文件，将错误或更高的所有日志消息发送到标准输出，以及将所有关键消息发送至一个邮件地址。 此方案需要三个单独的处理器，其中每个处理器负责将特定严重性的消息发送到特定位置。

标准库包含很多处理器类型（参见 有用的处理器 ）；教程主要使用 StreamHandler 和 FileHandler 。

处理器中很少有方法可供应用程序开发人员使用。使用内置处理器对象（即不创建自定义处理器）的应用程序开发人员能用到的仅有以下配置方法：

setLevel() 方法，就像在记录器对象中一样，指定将被分派到适当目标的最低严重性。为什么有两个 setLevel() 方法？记录器中设置的级别确定将传递给其处理器的消息的严重性。每个处理器中设置的级别确定该处理器将发送哪些消息。

setFormatter() 选择一个该处理器使用的 Formatter 对象。

addFilter() 和 removeFilter() 分别在处理器上配置和取消配置过滤器对象。

应用程序代码不应直接实例化并使用 Handler 的实例。 相反， Handler 类是一个基类，它定义了所有处理器应该具有的接口，并建立了子类可以使用（或覆盖）的一些默认行为。

格式器

格式化器对象配置日志消息的最终顺序、结构和内容。 与 logging.Handler 类不同，应用程序代码可以实例化格式器类，但如果应用程序需要特殊行为，则可能会对格式化器进行子类化定制。构造函数有三个可选参数 —— 消息格式字符串、日期格式字符串和样式指示符。

logging.Formatter.__init__(fmt=None, datefmt=None, style='%')

如果没有消息格式字符串，则默认使用原始消息。如果没有日期格式字符串，则默认日期格式为：

%Y-%m-%d %H:%M:%S

在末尾加上毫秒数。 style 是 '%', '{' 或 '{TX-PL-LABEL}#x27; 之一。 如果未指定其中之一，则将使用 '%'。

如果 style 为 '%'，则消息格式字符串将使用 %(<dictionary key>)s 样式的字符串替换；可用的键值记录在 LogRecord 属性 中。 如果样式为 '{'，则将假定消息格式字符串与 str.format() 兼容（使用关键字参数），而如果样式为 '{TX-PL-LABEL}#x27; 则消息格式字符串应当符合 string.Template.substitute() 的预期。

在 3.2 版更改: 添加 style 形参。

以下消息格式字符串将以人类可读的格式记录时间、消息的严重性以及消息的内容，按此顺序:

'%(asctime)s - %(levelname)s - %(message)s'

格式器通过用户可配置的函数将记录的创建时间转换为元组。 默认情况下，使用 time.localtime() ；要为特定格式器实例更改此项，请将实例的 converter 属性设置为与 time.localtime() 或 time.gmtime() 具有相同签名的函数。 要为所有格式器更改它，例如，如果你希望所有记录时间都以 GMT 显示，请在格式器类中设置 converter 属性（对于 GMT 显示，设置为 time.gmtime ）。

配置日志记录

开发者可以通过三种方式配置日志记录：

使用调用上面列出的配置方法的 Python 代码显式创建记录器、处理器和格式器。

创建日志配置文件并使用 fileConfig() 函数读取它。

创建配置信息字典并将其传递给 dictConfig() 函数。

有关最后两个选项的参考文档，请参阅 配置函数 。 以下示例使用 Python 代码配置一个非常简单的记录器、一个控制台处理器和一个简单的格式器:

import logging

# create logger
logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)

# create console handler and set level to debug
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# create formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# add formatter to ch
ch.setFormatter(formatter)

# add ch to logger
logger.addHandler(ch)

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

从命令行运行此模块将生成以下输出：

$ 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

以下 Python 模块创建的记录器、处理器和格式器几乎与上面列出的示例中的相同，唯一的区别是对象的名称:

import logging
import logging.config

logging.config.fileConfig('logging.conf')

# create logger
logger = logging.getLogger('simpleExample')

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

这是 logging.conf 文件：

[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

其输出与不基于配置文件的示例几乎相同：

$ 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

你可以看到配置文件方法相较于 Python 代码方法有一些优势，主要是配置和代码的分离以及非开发者轻松修改日志记录属性的能力。

警告

fileConfig() 函数接受一个默认参数 disable_existing_loggers ，出于向后兼容的原因，默认为 True 。这可能与您的期望不同，因为除非在配置中明确命名它们（或其父级），否则它将导致在 fileConfig() 调用之前存在的任何非 root 记录器被禁用。有关更多信息，请参阅参考文档，如果需要，请将此参数指定为 False 。

传递给 dictConfig() 的字典也可以用键 disable_existing_loggers 指定一个布尔值，如果没有在字典中明确指定，也默认被解释为 True 。这会导致上面描述的记录器禁用行为，这可能与你的期望不同——在这种情况下，请明确地为其提供 False 值。

请注意，配置文件中引用的类名称需要相对于日志记录模块，或者可以使用常规导入机制解析的绝对值。因此，你可以使用 WatchedFileHandler （相对于日志记录模块）或 mypackage.mymodule.MyHandler （对于在 mypackage 包中定义的类和模块 mymodule ，其中 mypackage 在 Python 导入路径上可用）。

在 Python 3.2 中，引入了一种新的配置日志记录的方法，使用字典来保存配置信息。 这提供了上述基于配置文件方法的功能的超集，并且是新应用程序和部署的推荐配置方法。 因为 Python 字典用于保存配置信息，并且由于你可以使用不同的方式填充该字典，因此你有更多的配置选项。 例如，你可以使用 JSON 格式的配置文件，或者如果你有权访问 YAML 处理功能，则可以使用 YAML 格式的文件来填充配置字典。当然，你可以在 Python 代码中构造字典，通过套接字以 pickle 形式接收它，或者使用对你的应用程序合理的任何方法。

以下是与上述相同配置的示例，采用 YAML 格式，用于新的基于字典的方法：

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]

有关使用字典进行日志记录的更多信息，请参阅 配置函数。

如果没有提供配置会发生什么

如果未提供日志记录配置，则可能出现需要输出日志记录事件但无法找到输出事件的处理器的情况。 在这些情况下，logging 包的行为取决于 Python 版本。

对于 3.2 之前的 Python 版本，行为如下：

如果 logging.raiseExceptions 为 False （生产模式），则会以静默方式丢弃该事件。

如果 logging.raiseExceptions 为 True （开发模式），则会打印一条消息 'No handlers could be found for logger X.Y.Z'。

在 Python 3.2 及更高版本中，行为如下：

事件使用 “最后的处理器” 输出，存储在 logging.lastResort 中。 这个内部处理器与任何记录器都没有关联，它的作用类似于 StreamHandler ，它将事件描述消息写入 sys.stderr 的当前值（因此服从任何可能的重定向影响）。 没有对消息进行格式化——只打印裸事件描述消息。处理器的级别设置为 WARNING，因此将输出此级别和更高级别的所有事件。

要获得 3.2 之前的行为，可以设置 logging.lastResort 为 None。

为库配置日志

在开发带日志的库时，你应该在文档中详细说明，你的库会如何使用日志——例如，使用的记录器的名称。还需要考虑其日志配置。如果使用库的应用程序不使用日志，且库代码调用日志进行记录，那么（如上一节所述）严重性为 WARNING 和更高级别的事件将被打印到 sys.stderr。这被认为是最好的默认行为。

如果由于某种原因，你 不 希望在没有任何日志记录配置的情况下打印这些消息，则可以将无操作处理器附加到库的顶级记录器。这样可以避免打印消息，因为将始终为库的事件找到处理器：它不会产生任何输出。如果库用户配置应用程序使用的日志记录，可能是配置将添加一些处理器，如果级别已适当配置，则在库代码中进行的日志记录调用将正常地将输出发送给这些处理器。

日志包中包含一个不做任何事情的处理器： NullHandler （自 Python 3.1 起）。可以将此处理器的实例添加到库使用的日志记录命名空间的顶级记录器中（ 如果 你希望在没有日志记录配置的情况下阻止库的记录事件输出到 sys.stderr ）。如果库 foo 的所有日志记录都是使用名称匹配 'foo.x' ， 'foo.x.y' 等的记录器完成的，那么代码:

import logging
logging.getLogger('foo').addHandler(logging.NullHandler())

应该有预计的效果。如果一个组织生成了许多库，则指定的记录器名称可以是 “orgname.foo” 而不仅仅是 “foo” 。

注解

强烈建议你 不要将 NullHandler 以外的任何处理器添加到库的记录器中 。这是因为处理器的配置是使用你的库的应用程序开发人员的权利。应用程序开发人员了解他们的目标受众以及哪些处理器最适合他们的应用程序：如果你在“底层”添加处理器，则可能会干扰他们执行单元测试和提供符合其要求的日志的能力。

日志级别

日志记录级别的数值在下表中给出。如果你想要定义自己的级别，并且需要它们具有相对于预定义级别的特定值，那么这你可能对以下内容感兴趣。如果你定义具有相同数值的级别，它将覆盖预定义的值；预定义的名称将失效。

级别 | 数值
CRITICAL | 50
ERROR | 40
WARNING | 30
INFO | 20
DEBUG | 10
NOTSET | 0

级别也可以与记录器关联，可以由开发人员设置，也可以通过加载保存的日志配置来设置。在记录器上调用记录方法时，记录器会将自己的级别与调用的方法的级别进行比较。如果记录器的级别高于调用的方法的级别，则实际上不会生成任何记录消息。这是控制日志记录输出详细程度的基本机制。

日志消息被编码为 LogRecord 类的实例。当记录器决定实际记录一个事件时，将从记录消息创建一个 LogRecord 实例。

使用 Handler 类的子例的实例 handlers，可以为日志消息建立分派机制。处理器负责确保记录的消息（以 LogRecord 的形式）最终到达对该消息的目标受众（如最终用户、技术支持员工、系统管理员或开发人员）有用的一个或多个位置上。想要去到特定目标的 LogRecord 实例会被传给相应的处理器。每个记录器可以有零、一或多个与之相关联的处理器（通过 Logger 的 addHandler() 方法）。除了与记录器直接关联的所有处理器之外，还会将消息分派给 记录器的所有祖先关联的各个处理器*（除非某个记录器的 *propagate 旗标被设为假值，这将使向祖先的传递在其处终止）。

就像记录器一样，处理器可以具有与它们相关联的级别。处理器的级别作为过滤器，其方式与记录器级别相同。如果处理器决定调度一个事件，则使用 emit() 方法将消息发送到其目标。大多数用户定义的 Handler 子类都需要重写 emit()。

自定义级别

定义你自己的级别是可能的，但不一定是必要的，因为现有级别是根据实践经验选择的。但是，如果你确信需要自定义级别，那么在执行此操作时应特别小心，如果你正在开发库，则 定义自定义级别可能是一个非常糟糕的主意 。 这是因为如果多个库作者都定义了他们自己的自定义级别，那么使用开发人员很难控制和解释这些多个库的日志记录输出，因为给定的数值对于不同的库可能意味着不同的东西。

有用的处理器

作为 Handler 基类的补充，提供了很多有用的子类：

StreamHandler 实例发送消息到流（类似文件对象）。

FileHandler 实例将消息发送到硬盘文件。

BaseRotatingHandler 是轮换日志文件的处理器的基类。它并不应该直接实例化。而应该使用 RotatingFileHandler 或 TimedRotatingFileHandler 代替它。

RotatingFileHandler 实例将消息发送到硬盘文件，支持最大日志文件大小和日志文件轮换。

TimedRotatingFileHandler 实例将消息发送到硬盘文件，以特定的时间间隔轮换日志文件。

SocketHandler 实例将消息发送到 TCP/IP 套接字。从 3.4 开始，也支持 Unix 域套接字。

DatagramHandler 实例将消息发送到 UDP 套接字。从 3.4 开始，也支持 Unix 域套接字。

SMTPHandler 实例将消息发送到指定的电子邮件地址。

SysLogHandler 实例将消息发送到 Unix syslog 守护程序，可能在远程计算机上。

NTEventLogHandler 实例将消息发送到 Windows NT/2000/XP 事件日志。

MemoryHandler 实例将消息发送到内存中的缓冲区，只要满足特定条件，缓冲区就会刷新。

HTTPHandler 实例使用 GET 或 POST 方法将消息发送到 HTTP 服务器。

WatchedFileHandler 实例会监视他们要写入日志的文件。如果文件发生更改，则会关闭该文件并使用文件名重新打开。此处理器仅在类 Unix 系统上有用； Windows 不支持依赖的基础机制。

QueueHandler 实例将消息发送到队列，例如在 queue 或 multiprocessing 模块中实现的队列。

NullHandler 实例对错误消息不执行任何操作。它们由想要使用日志记录的库开发人员使用，但是想要避免如果库用户没有配置日志记录，则显示 'No handlers could be found for logger XXX' 消息的情况。更多有关信息，请参阅 为库配置日志 。

3.1 新版功能: NullHandler 类。

3.2 新版功能: QueueHandler 类。

The NullHandler 、 StreamHandler 和 FileHandler 类在核心日志包中定义。其他处理器定义在 logging.handlers 中。（还有另一个子模块 logging.config ，用于配置功能）

记录的消息通过 Formatter 类的实例进行格式化后呈现。 它们使用能与 ％ 运算符一起使用的格式字符串和字典进行初始化。

要批量格式化多个消息，可以使用 BufferingFormatter 的实例。除了格式字符串（应用于批处理中的每个消息）之外，还提供了标题和尾部格式字符串。

当基于记录器级别和处理器级别的过滤不够时，可以将 Filter 的实例添加到 Logger 和 Handler 实例（通过它们的 addFilter() 方法）。在决定进一步处理消息之前，记录器和处理器都会查询其所有过滤器以获得许可。如果任何过滤器返回 false 值，则不会进一步处理该消息。

基本 Filter 的功能允许按特定的记录器名称进行过滤。如果使用此功能，则允许通过过滤器发送到指定记录器及其子项的消息，并丢弃其他所有消息。

记录日志时引发的异常

logging 包被设计为，当在生产环境下使用时，忽略记录日志时发生的异常。这样，处理与日志相关的事件时发生的错误（例如日志配置错误、网络或其它类似错误）不会导致使用日志的应用程序终止。

SystemExit 和 KeyboardInterrupt 异常永远不会被忽略。在 Handler 的子类的 emit() 方法中发生的其它异常将被传递给其 handleError() 方法。

Handler 中的 handleError() 的默认实现是检查是否设置了模块级变量 raiseExceptions。如有设置，则会将回溯打印到 sys.stderr。如果未设置，则忽略异常。

注解

raiseExceptions 的默认值是 True。这是因为在开发期间，你通常想要在发生异常时收到通知。建议你将 raiseExceptions 设为 False 供生产环境下使用。

使用任意对象作为消息

在前面的部分和示例中，都假设记录事件时传递的消息是字符串。 但是，这不是唯一的可能性。你可以将任意对象作为消息传递，并且当日志记录系统需要将其转换为字符串表示时，将调用其 __ str__() 方法。实际上，如果你愿意，你可以完全避免计算字符串表示。例如， SocketHandler 用 pickle 处理事件后，通过网络发送。

优化

消息参数的格式化将被推迟，直到无法避免。但是，计算传递给日志记录方法的参数也可能很消耗资源，如果记录器只是丢弃你的事件，你可能希望避免这样做。要决定做什么，可以调用 isEnabledFor() 方法，该方法接受一个 level 参数，如果记录器为该级别的调用创建了该事件，则返回 true 。 你可以写这样的代码:

if logger.isEnabledFor(logging.DEBUG):
    logger.debug('Message with %s, %s', expensive_func1(),
                                        expensive_func2())

因此，如果记录器的阈值设置在“DEBUG”以上，则永远不会调用 expensive_func1() 和 expensive_func2() 。

注解

在某些情况下， isEnabledFor() 本身可能比你想要的更消耗资源（例如，对于深度嵌套的记录器，其中仅在记录器层次结构中设置了显式级别）。在这种情况下（或者如果你想避免在紧密循环中调用方法），你可以在本地或实例变量中将调用的结果缓存到 isEnabledFor() ，并使用它而不是每次调用方法。在日志记录配置在应用程序运行时动态更改（这不常见）时，只需要重新计算这样的缓存值即可。

对于需要对收集的日志信息进行更精确控制的特定应用程序，还可以进行其他优化。以下列出了在日志记录过程中您可以避免的非必须处理操作：

你不想收集的内容 | 如何避免收集它
有关调用来源的信息 | 将 logging._srcfile 设置为 None 。这避免了调用 sys._getframe() ，如果 PyPy 支持 Python 3.x ，这可能有助于加速 PyPy （无法加速使用 sys._getframe() 的代码）等环境中的代码。
线程信息 | 将 logging.logThreads 设为 False。
当前进程 ID (os.getpid()) | 将 logging.logProcesses 设为 False。
当使用 multiprocessing 来管理多个进程时的当前进程名称。 | 将 logging.logMultiprocessing 设为 False。

另请注意，核心日志记录模块仅包含基本处理器。如果你不导入 logging.handlers 和 logging.config ，它们将不会占用任何内存。

参见

模块 logging

日志记录模块的 API 参考。

logging.config 模块

日志记录模块的配置 API 。

logging.handlers 模块

日志记录模块附带的有用处理器。

日志操作手册

日志专题手册

作者

Vinay Sajip <vinay_sajip at red-dove dot com>

本页面包含多个与日志相关的专题，历史证明它们是很有用的。教程和参考信息的链接另见 其它资源。

在多模块中使用日志

无论对 logging.getLogger('someLogger') 进行多少次调用，都会返回同一个 logger 对象的引用。不仅在同一个模块内如此，只要是在同一个 Python 解释器进程中，跨模块调用也是一样。同样是引用同一个对象，应用程序也可以在一个模块中定义和配置一个父 logger，而在另一个单独的模块中创建（但不配置）子 logger，对于子 logger 的所有调用都会传给父 logger。以下是主模块：

import logging
import auxiliary_module

# create logger with 'spam_application'
logger = logging.getLogger('spam_application')
logger.setLevel(logging.DEBUG)
# create file handler which logs even debug messages
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# create formatter and add it to the handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# add the handlers to the logger
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()')

以下是辅助模块：

import logging

# create logger
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"')

输出结果会像这样:

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()

在多个线程中记录日志

多线程记录日志并不需要特殊处理，以下示例演示了在主线程（起始线程）和其他线程中记录日志的过程：

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()

脚本会运行输出类似下面的内容:

   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

以上如期显示了不同线程的日志是交替输出的。当然更多的线程也会如此。

多个 handler 和多种 formatter

日志是个普通的 Python 对象。 addHandler() 方法可加入不限数量的日志 handler。有时候，应用程序需把严重错误信息记入文本文件，而将一般错误或其他级别的信息输出到控制台。若要进行这样的设定，只需多配置几个日志 handler 即可，应用程序的日志调用代码可以保持不变。下面对之前的分模块日志示例略做修改：

import logging

logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)
# create file handler which logs even debug messages
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# create formatter and add it to the handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# add the handlers to logger
logger.addHandler(ch)
logger.addHandler(fh)

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

需要注意的是，“应用程序”内的代码并不关心是否存在多个日志 handler。示例中所做的改变，只是新加入并配置了一个名为 fh 的 handler。

在编写和测试应用程序时，若能创建日志 handler 对不同严重级别的日志信息进行过滤，这将十分有用。调试时无需用多条 print 语句，而是采用 logger.debug ：print 语句以后还得注释或删掉，而 logger.debug 语句可以原样留在源码中保持静默。当需要再次调试时，只要改变日志对象或 handler 的严重级别即可。

在多个地方记录日志

假定要根据不同的情况将日志以不同的格式写入控制台和文件。比如把 DEBUG 以上级别的日志信息写于文件，并且把 INFO 以上的日志信息输出到控制台。再假设日志文件需要包含时间戳，控制台信息则不需要。以下演示了做法：

import logging

# set up logging to file - see previous section for more details
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')
# define a Handler which writes INFO messages or higher to the sys.stderr
console = logging.StreamHandler()
console.setLevel(logging.INFO)
# set a format which is simpler for console use
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# tell the handler to use this format
console.setFormatter(formatter)
# add the handler to the root logger
logging.getLogger('').addHandler(console)

# Now, we can log to the root logger, or any other logger. First the root...
logging.info('Jackdaws love my big sphinx of quartz.')

# Now, define a couple of other loggers which might represent areas in your
# application:

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.')

当运行后，你会看到控制台如下所示

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.

而日志文件将如下所示：

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.

如您所见，DEBUG 级别的日志信息只出现在了文件中，而其他信息则两个地方都会输出。

上述示例只用到了控制台和文件 handler，当然还可以自由组合任意数量的日志 handler。

请注意上面选择的日志文件名 /tmp/myapp.log 表示在 POSIX 系统上使用临时文件的标准位置。 在 Windows 上，你可能需要为日志选择不同的目录名称 —— 只要确保该目录存在并且你有在其中创建和更新文件的权限。

自定义处理级别

有时，你想要做的可能略微不同于处理器中标准的级别处理方式，即某个界限以上的所有级别都会被处理器所处理。 要做到这一点，你需要使用过滤器。 让我们来看一个假设你想要执行如下安排的场景:

将严重级别为 INFO 和 WARNING 的消息发送到 sys.stdout

将严重级别为 ERROR 及以上的消息发送到 sys.stderr

将严重级别为 DEBUG 及以上的消息发送到文件 app.log

假定你使用以下 JSON 来配置日志记录:

{
    "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"
        ]
    }
}

这个配置 几乎 能做到我们想要的，除了 sys.stdout 在 INFO 和 WARNING 消息之外还会显示严重级别 ERROR 及以上的消息。 为防止这种情况，我们可以设置一个排除掉这些消息的过滤器并将其添加到相应的处理器。 这可以通过添加一个平行于 formatters 和 handlers 的 filters 节来配置:

{
    "filters": {
        "warnings_and_below": {
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        }
    }
}

并修改 stdout 处理器上的节来添加它:

{
    "stdout": {
        "class": "logging.StreamHandler",
        "level": "INFO",
        "formatter": "simple",
        "stream": "ext://sys.stdout",
        "filters": ["warnings_and_below"]
    }
}

过滤器就是一个函数，因此我们可以定义 filter_maker (工厂函数) 如下:

def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter

此函数将传入的字符串参数转换为数字级别，并返回一个仅在传入等于或低于指定数字级别的级别时返回 True 的函数。 请注意在这个示例中我是将 filter_maker 定义在一个从命令行运行的测试脚本 main.py 中，因此其所属模块将为 __main__ —— 即在过滤器配置中写作 __main__.filter_maker。 如果你在不同的模块中定义它则需要加以修改。

在添加该过滤器后，我们就可以运行 main.py，完整代码如下:

import json
import logging
import logging.config

CONFIG = '''
{
    "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"
        ]
    }
}
'''

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')

使用这样的命令运行它之后:

python main.py 2>stderr.log >stdout.log

我们可以看到结果是符合预期的:

$ 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

日志配置服务器示例

以下是一个用到了日志配置服务器的模块示例：

import logging
import logging.config
import time
import os

# read initial config file
logging.config.fileConfig('logging.conf')

# create and start listener on port 9999
t = logging.config.listen(9999)
t.start()

logger = logging.getLogger('simpleExample')

try:
    # loop through logging calls to see the difference
    # new configurations make, until Ctrl+C is pressed
    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:
    # cleanup
    logging.config.stopListening()
    t.join()

以下脚本将接受文件名作为参数，然后将此文件发送到服务器，前面加上文件的二进制编码长度，做为新的日志配置：

#!/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')

处理日志 handler 的阻塞

有时你必须让日志记录处理程序的运行不会阻塞你要记录日志的线程。 这在 Web 应用程序中是很常见，当然在其他场景中也可能发生。

有一种原因往往会让程序表现迟钝，这就是 SMTPHandler：由于很多因素是开发人员无法控制的（例如邮件或网络基础设施的性能不佳），发送电子邮件可能需要很长时间。不过几乎所有网络 handler 都可能会发生阻塞：即使是 SocketHandler 操作也可能在后台执行 DNS 查询，而这种查询实在太慢了（并且 DNS 查询还可能在很底层的套接字库代码中，位于 Python 层之下，超出了可控范围）。

有一种解决方案是分成两部分实现。第一部分，针对那些对性能有要求的关键线程，只为日志对象连接一个 QueueHandler。日志对象只需简单地写入队列即可，可为队列设置足够大的容量，或者可以在初始化时不设置容量上限。尽管为以防万一，可能需要在代码中捕获 queue.Full 异常,不过队列写入操作通常会很快得以处理。如果要开发库代码，包含性能要求较高的线程，为了让使用该库的开发人员受益，请务必在开发文档中进行标明（包括建议仅连接 QueueHandlers ）。

解决方案的另一部分就是 QueueListener，它被设计为 QueueHandler 的对应部分。QueueListener 非常简单：传入一个队列和一些 handler，并启动一个内部线程，用于侦听 QueueHandlers （或其他 LogRecords 源）发送的 LogRecord 队列。LogRecords 会从队列中移除并传给 handler 处理。

QueueListener 作为单独的类，好处就是可以用同一个实例为多个 QueueHandlers 服务。这比把现有 handler 类线程化更加资源友好，后者会每个 handler 会占用一个线程，却没有特别的好处。

以下是这两个类的运用示例（省略了 import 语句）：

que = queue.Queue(-1)  # no limit on size
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()
# The log output will display the thread which generated
# the event (the main thread) rather than the internal
# thread which monitors the internal queue. This is what
# you want to happen.
root.warning('Look out!')
listener.stop()

在运行后会产生:

MainThread: Look out!

注解

虽然前面的讨论没有专门提及异步代码，但需要注意当在异步代码中记录日志时，网络甚至文件处理器都可能会导致问题（阻塞事件循环）因为某些日志记录是在 asyncio 内部完成的。 如果在应用程序中使用了任何异步代码，最好的做法是使用上面的日志记录方式，这样任何阻塞式代码都将只在 QueueListener 线程中运行。

在 3.5 版更改: 在 Python 3.5 之前，QueueListener 总会把由队列接收到的每条信息都传递给已初始化的每个处理程序。（因为这里假定级别过滤操作已在写入队列时完成了。）从 3.5 版开始，可以修改这种处理方式，只要将关键字参数 respect_handler_level=True 传给侦听器的构造函数即可。这样侦听器将会把每条信息的级别与 handler 的级别进行比较，只在适配时才会将信息传给 handler 。

通过网络收发日志事件

假定现在要通过网络发送日志事件，并在接收端进行处理。有一种简单的方案，就是在发送端的根日志对象连接一个 SocketHandler 实例：

import logging, logging.handlers

rootLogger = logging.getLogger('')
rootLogger.setLevel(logging.DEBUG)
socketHandler = logging.handlers.SocketHandler('localhost',
                    logging.handlers.DEFAULT_TCP_LOGGING_PORT)
# don't bother with a formatter, since a socket handler sends the event as
# an unformatted pickle
rootLogger.addHandler(socketHandler)

# Now, we can log to the root logger, or any other logger. First the root...
logging.info('Jackdaws love my big sphinx of quartz.')

# Now, define a couple of other loggers which might represent areas in your
# application:

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.')

在接收端，可以用 socketserver 模块设置一个接收器。简要示例如下：

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):
        # if a name is specified, we use the named logger rather than the one
        # implied by the record.
        if self.server.logname is not None:
            name = self.server.logname
        else:
            name = record.name
        logger = logging.getLogger(name)
        # N.B. EVERY record gets logged. This is because Logger.handle
        # is normally called AFTER logger-level filtering. If you want
        # to do filtering, do it at the client end to save wasting
        # cycles and network bandwidth!
        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()

先运行服务端，再运行客户端。客户端控制台不会显示什么信息；在服务端应该会看到如下内容：

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.

请注意，某些时候 pickle 会存在一些安全问题。若有问题可换用自己的序列化方案，只要覆盖 makePickle() 方法即可，并调整上述脚本以采用自己的序列化方案。

在生产中运行日志套接字侦听器

要在生产环境中运行日志记录监听器，你可能需要使用一个进程管理工具如 Supervisor [http://supervisord.org/]。 这个 Gist [https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b] 提供了使用 Supervisor 来运行上述功能的基本框架文件。 它由以下文件组成:

文件 | 目的
prepare.sh | 用于准备针对测试的环境的 Bash 脚本
supervisor.conf | Supervisor 配置文件，其中有用于侦听器和多进程 Web 应用程序的条目
ensure_app.sh | 用于确保 Supervisor 在使用上述配置运行的 Bash 脚本
log_listener.py | 接收日志事件并将其记录到文件中的套接字监听器
main.py | 一个通过连接到监听器的套接字来执行日志记录的简单 Web 应用程序
webapp.json | 一个针对 Web 应用程序的 JSON 配置文件
client.py | 使用 Web 应用程序的 Python 脚本

该 Web 应用程序使用了 Gunicorn [https://gunicorn.org/]，这个流行的 Web 应用服务器可启动多个工作进程来处理请求。 这个示例设置演示了多个工作进程是如何写入相同的日志文件而不会相互冲突的 --- 它们都通过套接字监听器进程操作。

要测试这些文件，请在 POSIX 环境中执行以下操作:

使用 Download ZIP 按钮将 此 Gist [https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b] 下载为 ZIP 归档文件。

将上述文件从归档解压缩到一个初始目录中。

在初始目录中，运行 bash prepare.sh 完成准备工作。 这将创建一个 run 子目录来包含 Supervisor 相关文件和日志文件，以及一个 venv 子目录来包含安装了 bottle, gunicorn 和 supervisor 的虚拟环境。

运行 bash ensure_app.sh 以确保 Supervisor 正在使用上述配置运行。

运行 venv/bin/python client.py 来使用 Web 应用程序，这将使得记录被写入到日志中。

检查 run 子目录中的日志文件。 你应当看到匹配模式为 app.log* 的文件中最新的日志记录行。 它们不会有任何特定的顺序，因为它们是由不同的工作进程以不确定的方式并发地处理的。

你可以通过运行 venv/bin/supervisorctl -c supervisor.conf shutdown 来关闭监听器和 Web 应用程序。

你可能需要在配置的端口与你的测试环境中其他程序发生意外冲突的情况下调整配置文件。

在自己的输出日志中添加上下文信息

有时，除了调用日志对象时传入的参数之外，还希望日志输出中能包含上下文信息。 比如在网络应用程序中，可能需要在日志中记录某客户端的信息（如远程客户端的用户名或 IP 地址）。 这虽然可以用 extra 参数实现，但传递起来并不总是很方便。 虽然为每个网络连接都创建 Logger 实例貌似不错，但并不是个好主意，因为这些实例不会被垃圾回收。 虽然在实践中不是问题，但当 Logger 实例的数量取决于应用程序要采用的日志粒度时，如果 Logger 实例的数量实际上是无限的，则有可能难以管理。

利用 LoggerAdapter 传递上下文信息

要传递上下文信息和日志事件信息，有一种简单方案是利用 LoggerAdapter 类。这个类设计得类似 Logger，所以可以直接调用 debug()、info()、 warning()、 error()、exception()、 critical() 和 log()。这些方法的签名与 Logger 对应的方法相同，所以这两类实例可以交换使用。

当你创建一个 LoggerAdapter 的实例时，你会传入一个 Logger 的实例和一个包含了上下文信息的字典对象。当你调用一个 LoggerAdapter 实例的方法时，它会把调用委托给内部的 Logger 的实例，并为其整理相关的上下文信息。这是 LoggerAdapter 的一个代码片段:

def debug(self, msg, /, *args, **kwargs):
    """
    Delegate a debug call to the underlying logger, after adding
    contextual information from this adapter instance.
    """
    msg, kwargs = self.process(msg, kwargs)
    self.logger.debug(msg, *args, **kwargs)

LoggerAdapter 的 process() 方法是将上下文信息添加到日志的输出中。 它传入日志消息和日志调用的关键字参数，并传回（隐式的）这些修改后的内容去调用底层的日志记录器。此方法的默认参数只是一个消息字段，但留有一个 'extra' 的字段作为关键字参数传给构造器。当然，如果你在调用适配器时传入了一个 'extra' 字段的参数，它会被静默覆盖。

使用 'extra' 的优点是这些键值对会被传入 LogRecord 实例的 __dict__ 中，让你通过 Formatter 的实例直接使用定制的字符串，实例能找到这个字典类对象的键。 如果你需要一个其他的方法，比如说，想要在消息字符串前后增加上下文信息，你只需要创建一个 LoggerAdapter 的子类，并覆盖它的 process() 方法来做你想做的事情，以下是一个简单的示例:

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

你可以这样使用:

logger = logging.getLogger(__name__)
adapter = CustomAdapter(logger, {'connid': some_conn_id})

然后，你记录在适配器中的任何事件消息前将添加 some_conn_id 的值。

使用除字典之外的其它对象传递上下文信息

你不需要将一个实际的字典传递给 LoggerAdapter-你可以传入一个实现了 __getitem__ 和 __iter__ 的类的实例，这样它就像是一个字典。这对于你想动态生成值（而字典中的值往往是常量）将很有帮助。

使用过滤器传递上下文信息

你也可以使用一个用户定义的类 Filter 在日志输出中添加上下文信息。Filter 的实例是被允许修改传入的 LogRecords，包括添加其他的属性，然后可以使用合适的格式化字符串输出，或者可以使用一个自定义的类 Formatter。

例如，在一个web应用程序中，正在处理的请求（或者至少是请求的一部分），可以存储在一个线程本地 (threading.local) 变量中，然后从 Filter 中去访问。请求中的信息，如IP地址和用户名将被存储在 LogRecord 中，使用上例 LoggerAdapter 中的 'ip' 和 'user' 属性名。在这种情况下，可以使用相同的格式化字符串来得到上例中类似的输出结果。这是一段示例代码:

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')

在运行时，产生如下内容:

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

contextvars 的使用

自 Python 3.7 起，contextvars 模块提供了同时适用于 threading 和 asyncio 处理需求的上下文本地存储。 因此这种存储类型通常要比线程本地存储更好。 下面的例子演示了在多线程环境中日志如何用上下文信息来填充内容，例如 Web 应用程序所处理的请求属性。

出于说明的目的，比方说你有几个不同的 Web 应用程序，彼此都保持独立状态但运行在同一个 Python 进程中并且它们共同使用了某个库。 这些应用程序要如何拥有各自的日志记录，其中来自这个库的日志消息（以及其他请求处理代码）会发到对应的应用程序的日志文件，同时在日志中包括额外的上下文信息如客户端 IP、HTTP 请求方法和客户端用户名呢？

让我们假定这个库可以通过以下代码来模拟:

# webapplib.py
import logging
import time

logger = logging.getLogger(__name__)

def useful():
    # Just a representative event logged from the library
    logger.debug('Hello from webapplib!')
    # Just sleep for a bit so other threads get to run
    time.sleep(0.01)

我们可以通过两个简单的类 Request 和 WebApp 来模拟多个 Web 应用程序。 它们模拟了真正的多线程 Web 应用程序是如何工作的 —— 每个请求均由单独的线程来处理:

# 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

# A dummy set of requests which will be used in the simulation - we'll just pick
# from this list randomly. Note that all GET requests are from 192.168.2.XXX
# addresses, whereas POST requests are from 192.16.3.XXX addresses. Three users
# are represented in the sample requests.

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'),
]

# Note that the format string includes references to request context information
# such as HTTP method, client IP and username

formatter = logging.Formatter('%(threadName)-11s %(appName)s %(name)-9s %(user)-6s %(ip)s %(method)-4s %(message)s')

# Create our context variables. These will be filled at the start of request
# processing, and used in the logging that happens during that processing

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()

    # Create the dummy webapps and put them in a list which we can use to select
    # from randomly
    app1 = WebApp('app1')
    app2 = WebApp('app2')
    apps = [app1, app2]
    threads = []
    # Add a common handler which will capture all events
    handler = logging.FileHandler('app.log', 'w')
    handler.setFormatter(formatter)
    root.addHandler(handler)

    # Generate calls to process requests
    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

    # Wait for the threads to terminate
    for t in threads:
        t.join()

    for app in apps:
        print('%s processed %s requests' % (app.name, app.num_requests))

if __name__ == '__main__':
    main()

如果你运行上面的代码，你将会发现约有半数请求是发给 app1.log 而其余的则是发给 app2.log，并且所有请求都会被记录至 app.log。 每个 Web 应用专属的日志将只包含该 Web 应用的日志条目，请求信息也将以一致的方式显示在日志里（即每个模拟请求中的信息将总是在一个日志行中一起显示）。 如下面的 shell 输出所示:

~/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

在处理器中传递上下文信息

每个 Handler 都有自己的过滤器链。 如果你想向一个 LogRecord 添加上下文信息而不使其泄露给其它处理器，你可以使用一个返回新 LogRecord 而不是原地修改它的过滤器，如下面的脚本所示:

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')

从多个进程记录至单个文件

尽管 logging 是线程安全的，将单个进程中的多个线程日志记录至单个文件也 是 受支持的，但将 多个进程 中的日志记录至单个文件则 不是 受支持的，因为在 Python 中并没有在多个进程中实现对单个文件访问的序列化的标准方案。 如果你需要将多个进程中的日志记录至单个文件，有一个方案是让所有进程都将日志记录至一个 SocketHandler，然后用一个实现了套接字服务器的单独进程一边从套接字中读取一边将日志记录至文件。 （如果愿意的话，你可以在一个现有进程中专门开一个线程来执行此项功能。） 这一部分 文档对此方式有更详细的介绍，并包含一个可用的套接字接收器，你自己的应用可以在此基础上进行适配。

你也可以编写你自己的处理程序，让其使用 multiprocessing 模块中的 Lock 类来顺序访问你的多个进程中的文件。 现有的 FileHandler 及其子类目前并不使用 multiprocessing，尽管它们将来可能会这样做。 请注意在目前，multiprocessing 模块并未在所有平台上都提供可用的锁功能 (参见 https://bugs.python.org/issue3770)。

或者，你也可以使用 Queue 和 QueueHandler 将所有的日志事件发送至你的多进程应用的一个进程中。 以下示例脚本演示了如何执行此操作。 在示例中，一个单独的监听进程负责监听其他进程的日志事件，并根据自己的配置记录。 尽管示例只演示了这种方法（例如你可能希望使用单独的监听线程而非监听进程 —— 它们的实现是类似的），但你也可以在应用程序的监听进程和其他进程使用不同的配置，它可以作为满足你特定需求的一个基础:

# You'll need these imports in your own code
import logging
import logging.handlers
import multiprocessing

# Next two import lines for this demo only
from random import choice, random
import time

#
# Because you'll want to define the logging configurations for listener and workers, the
# listener and worker process functions take a configurer parameter which is a callable
# for configuring logging for that process. These functions are also passed the queue,
# which they use for communication.
#
# In practice, you can configure the listener however you want, but note that in this
# simple example, the listener does not apply level or filter logic to received records.
# In practice, you would probably want to do this logic in the worker processes, to avoid
# sending events which would be filtered out between processes.
#
# The size of the rotated files is made small so you can see the results easily.
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)

# This is the listener process top-level loop: wait for logging events
# (LogRecords)on the queue and handle them, quit when you get a None for a
# LogRecord.
def listener_process(queue, configurer):
    configurer()
    while True:
        try:
            record = queue.get()
            if record is None:  # We send this as a sentinel to tell the listener to quit.
                break
            logger = logging.getLogger(record.name)
            logger.handle(record)  # No level or filter logic applied - just do it!
        except Exception:
            import sys, traceback
            print('Whoops! Problem:', file=sys.stderr)
            traceback.print_exc(file=sys.stderr)

# Arrays used for random selections in this demo

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',
]

# The worker configuration is done at the start of the worker process run.
# Note that on Windows you can't rely on fork semantics, so each process
# will run the logging configuration code when it starts.
def worker_configurer(queue):
    h = logging.handlers.QueueHandler(queue)  # Just the one handler needed
    root = logging.getLogger()
    root.addHandler(h)
    # send all messages, for demo; no other level or filter logic applied.
    root.setLevel(logging.DEBUG)

# This is the worker process top-level loop, which just logs ten events with
# random intervening delays before terminating.
# The print messages are just so you know it's doing something!
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)

# Here's where the demo gets orchestrated. Create the queue, create and start
# the listener, create ten workers and start them, wait for them to finish,
# then send a None to the queue to tell the listener to finish.
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()

上面脚本的一个变种，仍然在主进程中记录日志，但使用一个单独的线程:

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()
    # At this point, the main process could do some useful work of its own
    # Once it's done that, it can wait for the workers to terminate...
    for wp in workers:
        wp.join()
    # And now tell the logging thread to finish up, too
    q.put(None)
    lp.join()

这段变种的代码展示了如何使用特定的日志记录配置 - 例如 foo 记录器使用了特殊的处理程序，将 foo 子系统中所有的事件记录至一个文件 mplog-foo.log 。在主进程（即使是在工作进程中产生的日志事件）的日志记录机制中将直接使用恰当的配置。

concurrent.futures.ProcessPoolExecutor 的用法

若要利用 concurrent.futures.ProcessPoolExecutor 启动工作进程，创建队列的方式应稍有不同。不能是：

queue = multiprocessing.Queue(-1)

而应是：

queue = multiprocessing.Manager().Queue(-1)  # also works with the examples above

然后就可以将以下工作进程的创建过程：

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()

改为 (记得要先导入 concurrent.futures):

with concurrent.futures.ProcessPoolExecutor(max_workers=10) as executor:
    for i in range(10):
        executor.submit(worker_process, queue, worker_configurer)

使用 Gunicorn 和 uWSGI 来部署 Web 应用程序

当使用 Gunicorn [https://gunicorn.org/] 或 uWSGI [https://uwsgi-docs.readthedocs.io/en/latest/] (或其他类似工具) 来部署 Web 应用时，会创建多个工作进程来处理客户端请求。 在这种环境下，要避免在你的 Web 应用中直接创建基于文件的处理器。 而应改为使用一个 SocketHandler 将来自 Web 应用的日志发送到在单独进程中运行的监听器。 这可以通过使用一个进程管理工具例如 Supervisor 来进行设置 —— 请参阅 Running a logging socket listener in production 了解详情。

轮换日志文件

有时，你希望当日志文件不断记录增长至一定大小时，打开一个新的文件接着记录。 你可能希望只保留一定数量的日志文件，当不断的创建文件到达该数量时，又覆盖掉最开始的文件形成循环。 对于这种使用场景，日志包提供了 RotatingFileHandler:

import glob
import logging
import logging.handlers

LOG_FILENAME = 'logging_rotatingfile_example.out'

# Set up a specific logger with our desired output level
my_logger = logging.getLogger('MyLogger')
my_logger.setLevel(logging.DEBUG)

# Add the log message handler to the logger
handler = logging.handlers.RotatingFileHandler(
              LOG_FILENAME, maxBytes=20, backupCount=5)

my_logger.addHandler(handler)

# Log some messages
for i in range(20):
    my_logger.debug('i = %d' % i)

# See what files are created
logfiles = glob.glob('%s*' % LOG_FILENAME)

for filename in logfiles:
    print(filename)

结果应该是6个单独的文件，每个文件都包含了应用程序的部分历史日志:

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

最新的文件始终是 logging_rotatingfile_example.out，每次到达大小限制时，都会使用后缀 .1 重命名。每个现有的备份文件都会被重命名并增加其后缀（例如 .1 变为 .2 ），而 .6 文件会被删除掉。

显然，这个例子将日志长度设置得太小，这是一个极端的例子。 你可能希望将 maxBytes 设置为一个合适的值。

使用其他日志格式化方式

当日志模块被添加至 Python 标准库时，只有一种格式化消息内容的方法即 %-formatting。 在那之后，Python 又增加了两种格式化方法: string.Template (在 Python 2.4 中新增) 和 str.format() (在 Python 2.6 中新增)。

日志（从 3.2 开始）为这两种格式化方式提供了更多支持。Formatter 类可以添加一个额外的可选关键字参数 style。它的默认值是 '%'，其他的值 '{' 和 '$' 也支持，对应了其他两种格式化样式。其保持了向后兼容（如您所愿），但通过显示指定样式参数，你可以指定格式化字符串的方式是使用 str.format() 或 string.Template。 这里是一个控制台会话的示例，展示了这些方式：

>>> 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
>>>

请注意最终输出到日志的消息格式完全独立于单条日志消息的构造方式。 它仍然可以使用 %-formatting，如下所示:

>>> 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
>>>

日志调用（logger.debug() 、logger.info() 等）接受的位置参数只会用于日志信息本身，而关键字参数仅用于日志调用的可选处理参数（如关键字参数 exc_info 表示应记录跟踪信息， extra 则标识了需要加入日志的额外上下文信息）。所以不能直接用 str.format() 或 string.Template 语法进行日志调用，因为日志包在内部使用 %-f 格式来合并格式串和参数变量。在保持向下兼容性时，这一点不会改变，因为已有代码中的所有日志调用都会使用%-f 格式串。

还有一种方法可以构建自己的日志信息，就是利用 {}- 和 $- 格式。回想一下，任意对象都可用为日志信息的格式串，日志包将会调用该对象的 str() 方法，以获取最终的格式串。不妨看下一下两个类：

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)

上述两个类均可代替格式串，使得能用 {}- 或 $-formatting 构建最终的“日志信息”部分，这些信息将出现在格式化后的日志输出中，替换 %(message)s 或“{message}”或“$message”。每次写入日志时都要使用类名，有点不大实用，但如果用上 __ 之类的别名就相当合适了（双下划线 --- 不要与 _ 混淆，单下划线用作 gettext.gettext() 或相关函数的同义词/别名 ）。

Python 并没有上述两个类，当然复制粘贴到自己的代码中也很容易。用法可如下所示（假定在名为 wherever 的模块中声明）：

>>> 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
>>>

上述示例用了 print() 演示格式化输出的过程，实际记录日志时当然会用类似 logger.debug() 的方法来应用。

值得注意的是，上述做法对性能并没什么影响：格式化过程其实不是在日志记录调用时发生的，而是在日志信息即将由 handler 输出到日志时发生。因此，唯一可能让人困惑的稍不寻常的地方，就是包裹在格式串和参数外面的括号，而不是格式串。因为 __ 符号只是对 XXXMessage 类的构造函数调用的语法糖。

只要愿意，上述类似的效果即可用 LoggerAdapter 实现，如下例所示：

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 __init__(self, logger, extra=None):
        super().__init__(logger, extra or {})

    def log(self, level, msg, /, *args, **kwargs):
        if self.isEnabledFor(level):
            msg, kwargs = self.process(msg, kwargs)
            self.logger._log(level, Message(msg, args), (), **kwargs)

logger = StyleAdapter(logging.getLogger(__name__))

def main():
    logger.debug('Hello, {}', 'world!')

if __name__ == '__main__':
    logging.basicConfig(level=logging.DEBUG)
    main()

在用 Python 3.2 以上版本运行时，上述代码应该会把 Hello, world! 写入日志。

自定义 LogRecord

每条日志事件都由一个 LogRecord 实例表示。当某事件要记入日志并且没有被某级别过滤掉时，就会创建一个 LogRecord 对象，并将有关事件的信息填入，传给该日志对象的 handler（及其祖先，直至对象禁止向上传播为止）。在 Python 3.2 之前，只有两个地方会进行事件的创建：

Logger.makeRecord()，在事件正常记入日志的过程中调用。这会直接调用 LogRecord 来创建一个实例。

makeLogRecord()，调用时会带上一个字典参数，其中存放着要加入 LogRecord 的属性。这通常在通过网络接收到合适的字典时调用（如通过 SocketHandler 以 pickle 形式，或通过 HTTPHandler 以 JSON 形式）。

于是这意味着若要对 LogRecord 进行定制，必须进行下述某种操作。

创建 Logger  自定义子类，重写 Logger.makeRecord()，并在实例化所需日志对象之前用 setLoggerClass() 进行设置。

为日志对象添加 Filter 或 handler，当其 filter() 方法被调用时，会执行必要的定制操作。

比如说在有多个不同库要完成不同操作的场景下，第一种方式会有点笨拙。 每次都要尝试设置自己的 Logger 子类，而起作用的是最后一次尝试。

第二种方式在多数情况下效果都比较良好，但不允许你使用特殊化的 LogRecord 子类。 库开发者可以为他们的日志记录器设置合适的过滤器，但他们应当要记得每次引入新的日志记录器时都需如此（他们只需通过添加新的包或模块并执行以下操作即可）:

logger = logging.getLogger(__name__)

或许这样要顾及太多事情。开发人员还可以将过滤器附加到其顶级日志对象的 NullHandler 中，但如果应用程序开发人员将 handler 附加到较底层库的日志对象，则不会调用该过滤器 --- 所以 handler 输出的内容不会符合库开发人员的预期。

在 Python 3.2 以上版本中，LogRecord 的创建是通过工厂对象完成的，工厂对象可以指定。工厂对象只是一个可调用对象，可以用 setLogRecordFactory() 进行设置，并用 getLogRecordFactory() 进行查询。工厂对象的调用参数与 LogRecord 的构造函数相同，因为 LogRecord 是工厂对象的默认设置。

这种方式可以让自定义工厂对象完全控制 LogRecord 的创建过程。比如可以返回一个子类，或者在创建的日志对象中加入一些额外的属性，使用方式如下所示：

old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)

这种模式允许不同的库将多个工厂对象链在一起，只要不会覆盖彼此的属性或标准属性，就不会出现意外。但应记住，工厂链中的每个节点都会增加日志操作的运行开销，本技术仅在采用 Filter 无法达到目标时才应使用。

子类化 QueueHandler - ZeroMQ 示例

你可以使用 QueueHandler 子类将消息发送给其他类型的队列 ，比如 ZeroMQ 'publish' 套接字。 在以下示例中，套接字将单独创建并传给处理器 (作为它的 'queue'):

import zmq   # using pyzmq, the Python binding for ZeroMQ
import json  # for serializing records portably

ctx = zmq.Context()
sock = zmq.Socket(ctx, zmq.PUB)  # or zmq.PUSH, or other suitable value
sock.bind('tcp://*:5556')        # or wherever

class ZeroMQSocketHandler(QueueHandler):
    def enqueue(self, record):
        self.queue.send_json(record.__dict__)

handler = ZeroMQSocketHandler(sock)

当然还有其他方案，比如通过 hander 传入所需数据，以创建 socket：

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()

子类化 QueueListener —— ZeroMQ 示例

你还可以子类化 QueueListener 来从其他类型的队列中获取消息，比如从 ZeroMQ 'subscribe' 套接字。 下面是一个例子:

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, '')  # subscribe to everything
        socket.connect(uri)
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self):
        msg = self.queue.recv_json()
        return logging.makeLogRecord(msg)

参见

模块 logging

日志记录模块的 API 参考。

logging.config 模块

日志记录模块的配置 API 。

logging.handlers 模块

日志记录模块附带的有用处理器。

日志操作基础教程

日志操作的高级教程

基于字典进行日志配置的示例

以下是日志配置字典的一个示例——它取自 Django 项目的`文档<https://docs.djangoproject.com/en/stable/topics/logging/#configuring-logging>`_。此字典将被传给 dictConfig() 以使配置生效:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': {
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(message)s'
        },
    },
    'filters': {
        'special': {
            '()': 'project.logging.SpecialFilter',
            'foo': 'bar',
        }
    },
    'handlers': {
        'null': {
            'level':'DEBUG',
            'class':'django.utils.log.NullHandler',
        },
        'console':{
            'level':'DEBUG',
            'class':'logging.StreamHandler',
            'formatter': 'simple'
        },
        'mail_admins': {
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['special']
        }
    },
    'loggers': {
        'django': {
            'handlers':['null'],
            'propagate': True,
            'level':'INFO',
        },
        'django.request': {
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        },
        'myproject.custom': {
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
            'filters': ['special']
        }
    }
}

有关本配置的更多信息，请参阅 Django 文档的 有关章节 [https://docs.djangoproject.com/en/stable/topics/logging/#configuring-logging] 。

利用 rotator 和 namer 自定义日志轮换操作

下面的可运行代码给出了你可以怎样定义命名器和轮换器的例子，其中演示了日志文件的 gzip 压缩过程:

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}')

运行此脚本后，你将看到六个新文件，其中五个是已压缩的:

$ 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

更加详细的多道处理示例

以下可运行的示例显示了如何利用配置文件在多进程中应用日志。这些配置相当简单，但足以说明如何在真实的多进程场景中实现较为复杂的配置。

上述示例中，主进程产生一个侦听器进程和一些工作进程。每个主进程、侦听器进程和工作进程都有三种独立的日志配置（工作进程共享同一套配置）。大家可以看到主进程的日志记录过程、工作线程向 QueueHandler 写入日志的过程，以及侦听器实现 QueueListener 和较为复杂的日志配置，如何将由队列接收到的事件分发给配置指定的 handler。请注意，这些配置纯粹用于演示，但应该能调整代码以适用于自己的场景。

以下是代码——但愿文档字符串和注释能有助于理解其工作原理：

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):
            # The process name is transformed just to show that it's the listener
            # doing the logging to files and console
            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':
        # On POSIX, the setup logger will have been configured in the
        # parent process, but should have been disabled following the
        # dictConfig call.
        # On Windows, since fork isn't used, the setup logger won't
        # exist in the child, so it would be created and the message
        # would appear - hence the "if posix" clause.
        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':
        # On POSIX, the setup logger will have been configured in the
        # parent process, but should have been disabled following the
        # dictConfig call.
        # On Windows, since fork isn't used, the setup logger won't
        # exist in the child, so it would be created and the message
        # would appear - hence the "if posix" clause.
        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()
    # The main process gets a simple configuration which prints to the console.
    config_initial = {
        'version': 1,
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
                'level': 'INFO'
            }
        },
        'root': {
            'handlers': ['console'],
            'level': 'DEBUG'
        }
    }
    # The worker process configuration is just a QueueHandler attached to the
    # root logger, which allows all messages to be sent to the queue.
    # We disable existing loggers to disable the "setup" logger used in the
    # parent process. This is needed on POSIX because the logger will
    # be there in the child following a fork().
    config_worker = {
        'version': 1,
        'disable_existing_loggers': True,
        'handlers': {
            'queue': {
                'class': 'logging.handlers.QueueHandler',
                'queue': q
            }
        },
        'root': {
            'handlers': ['queue'],
            'level': 'DEBUG'
        }
    }
    # The listener process configuration shows that the full flexibility of
    # logging configuration is available to dispatch events to handlers however
    # you want.
    # We disable existing loggers to disable the "setup" logger used in the
    # parent process. This is needed on POSIX because the logger will
    # be there in the child following a 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'
        }
    }
    # Log some initial events, just to show that logging in the parent works
    # normally.
    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')
    # We now hang around for the workers to finish their work.
    for wp in workers:
        wp.join()
    # Workers all done, listening can now stop.
    # Logging in the parent still works normally.
    logger.info('Telling listener to stop ...')
    stop_event.set()
    lp.join()
    logger.info('All done.')

if __name__ == '__main__':
    main()

在发送给 SysLogHandler 的信息中插入一个 BOM。

RFC 5424 [https://datatracker.ietf.org/doc/html/rfc5424.html] 要求，Unicode 信息应采用字节流形式发送到系统 syslog 守护程序，字节流结构如下所示：可选的纯 ASCII部分，后跟 UTF-8 字节序标记（BOM），然后是采用 UTF-8 编码的 Unicode。（参见 相关规范 [https://datatracker.ietf.org/doc/html/rfc5424.html#section-6] 。）

在 Python 3.1 的 SysLogHandler 中，已加入了在日志信息中插入 BOM 的代码，但不幸的是，代码并不正确，BOM 出现在了日志信息的开头，因此在它之前就不允许出现纯 ASCII 内容了。

由于无法正常工作， Python 3.2.4 以上版本已删除了出错的插入 BOM 代码。但已有版本的代码不会被替换，若要生成与 RFC 5424 [https://datatracker.ietf.org/doc/html/rfc5424.html] 兼容的日志信息，包括一个 BOM 符，前面有可选的纯 ASCII 字节流，后面为 UTF-8 编码的任意 Unicode，那么 需要执行以下操作：

为 SysLogHandler 实例串上一个 Formatter 实例，格式串可如下：

'ASCII section\ufeffUnicode section'

用 UTF-8 编码时，Unicode 码位 U+FEFF 将会编码为 UTF-8 BOM——字节串 b'\xef\xbb\xbf' 。

用任意占位符替换 ASCII 部分，但要保证替换之后的数据一定是 ASCII 码（这样在 UTF-8 编码后就会维持不变）。

用任意占位符替换 Unicode 部分；如果替换后的数据包含超出 ASCII 范围的字符，没问题——他们将用 UTF-8 进行编码。

SysLogHandler 将 对格式化后的日志信息进行 UTF-8 编码。如果遵循上述规则，应能生成符合 RFC 5424 [https://datatracker.ietf.org/doc/html/rfc5424.html] 的日志信息。否则，日志记录过程可能不会有什么反馈，但日志信息将不与 RFC 5424 兼容，syslog 守护程序可能会有出错反应。

结构化日志的实现代码

大多数日志信息是供人阅读的，所以机器解析起来并不容易，但某些时候可能希望以结构化的格式输出，以 能够 被程序解析（无需用到复杂的正则表达式）。这可以直接用 logging 包实现。实现方式有很多，以下是一种比较简单的方案，利用 JSON 以机器可解析的方式对事件信息进行序列化：

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   # optional, to improve readability

logging.basicConfig(level=logging.INFO, format='%(message)s')
logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))

上述代码运行后的结果是：

message 1 >>> {"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"}

请注意，根据 Python 版本的不同，各项数据的输出顺序可能会不一样。

若需进行更为定制化的处理，可以使用自定义 JSON 编码对象，下面给出完整示例：

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   # optional, to improve readability

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()

上述代码运行后的结果是：

message 1 >>> {"snowman": "\u2603", "set_value": [1, 2, 3]}

请注意，根据 Python 版本的不同，各项数据的输出顺序可能会不一样。

利用 dictConfig() 自定义 handler

有时需要以特定方式自定义日志 handler，如果采用 dictConfig()，可能无需生成子类就可以做到。比如要设置日志文件的所有权。在 POSIX 上，可以利用 shutil.chown() 轻松完成，但 stdlib 中的文件 handler 并不提供内置支持。于是可以用普通函数自定义 handler 的创建，例如：

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)

然后，你可以在传给 dictConfig() 的日志配置中指定通过调用此函数来创建日志处理程序:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'default': {
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        },
    },
    'handlers': {
        'file':{
            # The values below are popped from this dictionary and
            # used to create the handler, set the handler's level and
            # its formatter.
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # The values below are passed to the handler creator callable
            # as keyword arguments.
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        },
    },
    'root': {
        'handlers': ['file'],
        'level': 'DEBUG',
    },
}

出于演示目的，以下示例设置用户和用户组为 pulse。代码置于一个可运行的脚本文件 chowntest.py 中：

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':{
            # The values below are popped from this dictionary and
            # used to create the handler, set the handler's level and
            # its formatter.
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # The values below are passed to the handler creator callable
            # as keyword arguments.
            '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')

可能需要 root 权限才能运行：

$ 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

请注意此示例用的是 Python 3.3，因为 shutil.chown() 是从此版本开始出现的。 此方式应当适用于任何支持 dictConfig() 的 Python 版本 —— 例如 Python 2.7, 3.2 或更新的版本。 对于 3.3 之前的版本，你应当使用 os.chown() 之类的函数来实现实际的所有权修改。

实际应用中，handler 的创建函数可能位于项目的工具模块中。以下配置：

'()': owned_file_handler,

应使用：

'()': 'ext://project.util.owned_file_handler',

这里的 project.util 可以换成函数所在包的实际名称。 在上述的可用脚本中，应该可以使用 'ext://__main__.owned_file_handler'。 在这里，实际的可调用对象是由 dictConfig() 从 ext:// 说明中解析出来的。

上述示例还指明了其他的文件修改类型的实现方案 —— 比如同样利用 os.chmod() 设置 POSIX 访问权限位。

当然，以上做法也可以扩展到 FileHandler 之外的其他类型的 handler ——比如某个轮换文件 handler，或类型完全不同的其他 handler。

生效于整个应用程序的格式化样式

在 Python 3.2 中，Formatter 增加了一个 style 关键字形参，它默认为 % 以便向下兼容，但是允许采用 { 或 $ 来支持 str.format() 和 string.Template 所支持的格式化方式。 请注意此形参控制着用用于最终输出到日志的日志消息格式，并且与单独日志消息的构造方式完全无关。

日志调用 (debug(), info() 等) 只接受包含实际日志消息自身的位置参数，而关键字参数仅用于确定如何处理日志调用的选项 (例如 exc_info 关键字参数表示应将回溯信息记入日志，而 extra 关键字参数则指定要添加到日志的额外上下文信息)。 所以你不能直接使用 str.format() 或 string.Template 语法来直接执行日志调用，因为 logging 包在内部是使用 % 格式符来合并格式字符串和可变参数的。 这一点不应被改变以保持向下兼容性，因为现有代码中所有的日志调用都将使用 % 格式化字符串。

有人建议将格式化样式与特定的日志对象进行关联，但其实也会遇到向下兼容的问题，因为已有代码可能用到了某日志对象并采用了 %-f 格式串。

为了让第三方库和自编代码都能够交互使用日志功能，需要决定在单次日志记录调用级别采用什么格式。于是就出现了其他几种格式化样式方案。

LogRecord 工厂的用法

在 Python 3.2 中，伴随着 Formatter 的上述变化，logging 包增加了允许用户使用 setLogRecordFactory() 函数来。设置自己的 LogRecord 子类的功能。 你可以使用此功能来设置自己的 LogRecord 子类，它会通过重写 getMessage() 方法来完成适当的操作。 msg % args 格式化是在此方法的基类实现中进行的，你可以在那里用你自己的格式化操作来替换；但是，你应当注意要支持全部的格式化样式并允许将 %-formatting 作为默认样式，以确保与其他代码进行配合。 还应当注意调用 str(self.msg)，正如基类实现所做的一样。

更多信息请参阅 setLogRecordFactory() 和 LogRecord 的参考文档。

自定义信息对象的使用

另一种方案可能更为简单，可以利用 {}- 和 $- 格式构建自己的日志消息。大家或许还记得（来自 使用任意对象作为消息），可以用任意对象作为日志信息的格式串，日志包将调用该对象上 str() 获取实际的格式串。看下以下两个类：

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)

以上两个类均都可用于替代格式串，以便用 {}- 或 $-formatting 构建实际的“日志信息”部分，此部分将出现在格式化后的日志输出中，替换 %(message)s 、“{message}”或“$message”。每次要写入日志时都使用类名，如果觉得使用不便，可以采用 M 或 _ 之类的别名（如果将 _ 用于本地化操作，则可用 __）。

下面给出示例。 首先用 str.format() 进行格式化：

>>> __ = 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)

然后，用 string.Template 格式化：

>>> __ = DollarMessage
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>

值得注意的是，上述做法对性能并没什么影响：格式化过程其实不是在日志调用时发生的，而是在日志信息即将由 handler 输出到日志时发生。因此，唯一可能让人困惑的稍不寻常的地方，就是包裹在格式串和参数外面的括号，而不是格式串。因为 __ 符号只是对 XXXMessage 类的构造函数调用的语法糖。

利用 dictConfig() 定义过滤器

用 dictConfig() 可以 对日志过滤器进行设置，尽管乍一看做法并不明显（所以才需要本秘籍）。 由于 Filter 是标准库中唯一的日志过滤器类，不太可能满足众多的要求（它只是作为基类存在），通常需要定义自己的 Filter 子类，并重写 filter() 方法。为此，请在过滤器的配置字典中设置 () 键，指定要用于创建过滤器的可调用对象（最明显可用的就是给出一个类，但也可以提供任何一个可调用对象，只要能返回 Filter 实例即可）。下面是一个完整的例子：

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')

以上示例展示了将配置数据传给构造实例的可调用对象，形式是关键字参数。运行后将会输出：

changed: hello

这说明过滤器按照配置的参数生效了。

需要额外注意的地方：

如果在配置中无法直接引用可调用对象（比如位于不同的模块中，并且不能在配置字典所在的位置直接导入），则可以采用 ext://... 的形式，正如 访问外部对象 所述。例如，在上述示例中可以使用文本 'ext://__main__.MyFilter' 而不是 MyFilter 对象。

与过滤器一样，上述技术还可用于配置自定义 handler 和格式化对象。有关如何在日志配置中使用用户自定义对象的更多信息，请参阅 用户定义对象，以及上述 利用 dictConfig() 自定义 handler 的其他指南。

异常信息的自定义格式化

有时可能需要设置自定义的异常信息格式——考虑到会用到参数，假定要让每条日志事件只占一行，即便存在异常信息也一样。这可以用自定义格式化类来实现，如下所示：

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)  # or format into one line however you want to

    def format(self, record):
        s = super().format(record)
        if record.exc_text:
            s = s.replace('\n', '') + '|'
        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()

运行后将会生成只有两行信息的文件：

28/01/2015 07:21:23|INFO|Sample message|
28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'|

虽然上述处理方式很简单，但也给出了根据喜好对异常信息进行格式化输出的方案。或许 traceback 模块能满足更专门的需求。

语音播报日志信息

有时可能需要以声音的形式呈现日志消息。如果系统自带了文本转语音 （TTS）功能，即便没与 Python 关联也很容易做到。大多数 TTS 系统都有一个可运行的命令行程序，在 handler 中可以用 subprocess 进行调用。这里假定 TTS 命令行程序不会与用户交互，或需要很长时间才会执行完毕，写入日志的信息也不会多到影响用户查看，并且可以接受每次播报一条信息，以下示例实现了等一条信息播完再处理下一条，可能会导致其他 handler 的等待。这个简短示例仅供演示，假定 espeak TTS 包已就绪：

import logging
import subprocess
import sys

class TTSHandler(logging.Handler):
    def emit(self, record):
        msg = self.format(record)
        # Speak slowly in a female English voice
        cmd = ['espeak', '-s150', '-ven+f3', msg]
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT)
        # wait for the program to finish
        p.communicate()

def configure_logging():
    h = TTSHandler()
    root = logging.getLogger()
    root.addHandler(h)
    # the default formatter just returns the message
    root.setLevel(logging.DEBUG)

def main():
    logging.info('Hello')
    logging.debug('Goodbye')

if __name__ == '__main__':
    configure_logging()
    sys.exit(main())

运行后将会以女声播报“Hello”和“Goodbye”。

当然，上述方案也适用于其他 TTS 系统，甚至可以通过利用命令行运行的外部程序来处理消息。

缓冲日志消息并有条件地输出它们

在某些情况下，你可能希望在临时区域中记录日志消息，并且只在发生某种特定的情况下才输出它们。 例如，你可能希望起始在函数中记录调试事件，如果函数执行完成且没有错误，你不希望输出收集的调试信息以避免造成日志混乱，但如果出现错误，那么你希望所有调试以及错误消息被输出。

下面是一个示例，展示如何在你的日志记录函数上使用装饰器以实现这一功能。该示例使用 logging.handlers.MemoryHandler ，它允许缓冲已记录的事件直到某些条件发生，缓冲的事件才会被刷新（flushed） - 传递给另一个处理程序（ target handler）进行处理。 默认情况下， MemoryHandler 在其缓冲区被填满时被刷新，或者看到一个级别大于或等于指定阈值的事件。 如果想要自定义刷新行为，你可以通过更专业的 MemoryHandler 子类来使用这个秘诀。

这个示例脚本有一个简单的函数 foo ，它只是在所有的日志级别中循环运行，写到 sys.stderr ，说明它要记录在哪个级别上，然后在这个级别上实际记录一个消息。你可以给 foo 传递一个参数，如果为 true ，它将在ERROR和CRITICAL级别记录，否则，它只在DEBUG、INFO和WARNING级别记录。

脚本只是使用了一个装饰器来装饰 foo，这个装饰器将记录执行所需的条件。装饰器使用一个记录器作为参数，并在调用被装饰的函数期间附加一个内存处理程序。装饰器可以使用目标处理程序、记录级别和缓冲区的容量（缓冲记录的数量）来附加参数。这些参数分别默认为写入 sys.stderr 的 StreamHandler ， logging.ERROR 和 100。

以下是脚本：

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)

运行此脚本时，应看到以下输出：

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

如你所见，实际日志记录输出仅在消息等级为ERROR或更高的事件时发生，但在这种情况下，任何之前较低消息等级的事件还会被记录。

你当然可以使用传统的装饰方法:

@log_if_errors(logger)
def foo(fail=False):
    ...

将日志消息发送至电子邮件，附带缓存支持

为演示如何通过电子邮件发送日志消息，让每封电子邮件发送指定数量的日志消息，你可以子类化 BufferingHandler。 对于下面的例子，你可以继续调整以适合你自己的特定需求，它提供了简单的测试代码来允许你附带命令行参数运行该脚本来指定你需要通过 SMTP 发送的内容。 （请附带 -h 参数运行已下载的脚本来查看必须的和可选的参数。）

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()

如果你运行此脚本并且你的 SMTP 服务器已正确设置，你将发现它会向你指定的地址发出十一封电子邮件。 前十封邮件每封各有十条日志消息，第十一封将有两条消息。 如脚本所指定的总计为 102 条消息。

通过配置使用UTC (GMT) 格式化时间

有时你会想要使用 UTC 时间格式，这可以用 UTCFormatter 这样的类来实现，如下所示:

import logging
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime

然后你可以在你的代码中使用 UTCFormatter，而不是 Formatter。 如果你想通过配置来实现这一功能，你可以使用 dictConfig() API 来完成，该方法在以下完整示例中展示:

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())

脚本会运行输出类似下面的内容:

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

展示了如何将时间格式化为本地时间和UTC两种形式，其中每种形式对应一个日志处理器 。

使用上下文管理器的可选的日志记录

有时候，我们需要暂时更改日志配置，并在执行某些操作后将其还原。为此，上下文管理器是实现保存和恢复日志上下文的最明显的方式。这是一个关于上下文管理器的简单例子，它允许你在上下文管理器的作用域内更改日志记录等级以及增加日志处理器：

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()
        # implicit return of None => don't swallow exceptions

如果指定上下文管理器的日志记录等级属性，则在上下文管理器的with语句所涵盖的代码中，日志记录器的记录等级将临时设置为上下文管理器所配置的日志记录等级。 如果指定上下文管理的日志处理器属性，则该句柄在进入上下文管理器的上下文时添加到记录器中，并在退出时被删除。 如果你再也不需要该日志处理器时，你可以让上下文管理器在退出上下文管理器的上下文时关闭它。

为了说明它是如何工作的，我们可以在上面添加以下代码块:

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.')

我们最初设置日志记录器的消息等级为 INFO ，因此消息#1出现，消息#2没有出现。在接下来的 with 代码块中我们暂时将消息等级变更为 DEBUG ，从而消息 #3 出现。在这一代码块退出后，日志记录器的消息等级恢复为 INFO ，从而消息 #4 没有出现。在下一个 with 代码块中，我们再一次将设置消息等级设置为 DEBUG ，同时添加一个将消息写入 sys.stdout 的日志处理器。因此，消息#5在控制台出现两次 (分别通过 stderr 和 stdout )。在 with 语句完成后，状态与之前一样，因此消息 #6 出现（类似消息 #1），而消息 #7 没有出现（类似消息 #2）。

如果我们运行生成的脚本，结果如下：

$ 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.

我们将 stderr 标准错误重定向到 /dev/null ，我再次运行生成的脚步，唯一被写入 stdout 标准输出的消息，即我们所能看见的消息，如下：

$ python logctx.py 2>/dev/null
5. This should appear twice - once on stderr and once on stdout.

再一次，将 stdout 标准输出重定向到 /dev/null，我获得如下结果：

$ 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.

在这种情况下，与预期一致，打印到 stdout 标准输出的消息＃5不会出现。

当然，这里描述的方法可以被推广，例如临时附加日志记录过滤器。 请注意，上面的代码适用于Python 2以及Python 3。

命令行日志应用起步

下面的示例提供了如下功能：

根据命令行参数确定日志级别

在单独的文件中分发多条子命令，同一级别的子命令均以一致的方式记录。

最简单的配置用法

假定有一个命令行应用程序，用于停止、启动或重新启动某些服务。为了便于演示，不妨将 app.py 作为应用程序的主代码文件，并在 start.py 、 stop.py 和 restart.py 中实现单独的命令。再假定要通过命令行参数控制应用程序的日志粒度，默认为 logging.INFO 。以下是 app.py 的一个示例：

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()
    # the code to dispatch commands could all be in this file. For the purposes
    # of illustration only, we implement each command in a separate module.
    try:
        mod = importlib.import_module(options.command)
        cmd = getattr(mod, 'command')
    except (ImportError, AttributeError):
        print('Unable to find the code for command \'%s\'' % options.command)
        return 1
    # Could get fancy here and load configuration from file or dictionary
    logging.basicConfig(level=options.log_level,
                        format='%(levelname)s %(name)s %(message)s')
    cmd(options)

if __name__ == '__main__':
    sys.exit(main())

start、stop 和 restart 命令可以在单独的模块中实现，启动命令的代码可如下：

# start.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    logger.debug('About to start %s', options.name)
    # actually do the command processing here ...
    logger.info('Started the \'%s\' service.', options.name)

然后是停止命令的代码：

# stop.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = ''
        services = '\'%s\'' % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'' % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to stop %s', services)
    # actually do the command processing here ...
    logger.info('Stopped the %s service%s.', services, plural)

重启命令类似：

# restart.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = ''
        services = '\'%s\'' % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'' % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to restart %s', services)
    # actually do the command processing here ...
    logger.info('Restarted the %s service%s.', services, plural)

如果以默认日志级别运行该程序，会得到以下结果：

$ 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.

第一个单词是日志级别，第二个单词是日志事件所在的模块或包的名称。

如果修改了日志级别，发送给日志的信息就能得以改变。如要显示更多信息，则可：

$ 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.

若要显示的信息少一些，则：

$ 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

这里的命令不会向控制台输出任何信息，因为没有记录 WARNING 以上级别的日志。

Qt GUI 日志示例

GUI 应用程序如何记录日志，这是个常见的问题。 Qt [https://www.qt.io/] 框架是一个流行的跨平台 UI 框架，采用的是 PySide2 [https://pypi.org/project/PySide2/] 或 PyQt5 [https://pypi.org/project/PyQt5/] 库。

下面的例子演示了将日志写入 Qt GUI 程序的过程。这里引入了一个简单的 QtHandler 类，参数是一个可调用对象，其应为嵌入主线程某个“槽位”中运行的，因为GUI 的更新由主线程完成。这里还创建了一个工作线程，以便演示由 UI（通过人工点击日志按钮）和后台工作线程（此处只是记录级别和时间间隔均随机生成的日志信息）将日志写入 GUI 的过程。

该工作线程是用 Qt 的 QThread 类实现的，而不是 threading 模块，因为某些情况下只能采用 `QThread，它与其他 Qt 组件的集成性更好一些。

以下代码应能适用于最新版的 PySide2 或 PyQt5。对于低版本的 Qt 应该也能适用。更多详情，请参阅代码注释。

import datetime
import logging
import random
import sys
import time

# Deal with minor differences between PySide2 and PyQt5
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)
            level = random.choice(LEVELS)
            logger.log(level, 'Message after delay of %3.1f: %d', delay, i, 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')
        f.setStyleHint(f.Monospace)
        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()
    sys.exit(app.exec_())

if __name__=='__main__':
    main()

将日志记录到带有 RFC5424 支持的 syslog

虽然 RFC 5424 [https://datatracker.ietf.org/doc/html/rfc5424.html] 诞生于 2009 年，但大多数 syslog 服务器都默认被配置为使用更旧的 RFC 3164 [https://datatracker.ietf.org/doc/html/rfc3164.html]，它诞生于 2001 年。 当 logging 在 2003 年被加入到 Python 时，它支持了当时（唯一存在的）较早版本的协议。 在 RFC5424 诞生后，它还没有被广泛部署到 syslog 服务器上，因此 SysLogHandler 的功能也没有被更新。

RFC 5424 包括一些有用的特性例如对结构化数据的支持等，如果你想要能够将日志记录到带有该协议支持的 syslog 服务器上，你可以使用一个看起来像是这样的子类化处理器来实现:

import datetime
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 = datetime.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 = ''.join(parts)
        return f'{version} {asctime} {hostname} {appname} {procid} {msgid} {sdata} {msg}'

你需要熟悉 RFC 5424 才能完全理解上面的代码，你还可能会有稍加变化的的需求（例如你要如何将结构化数据记入日志）。 不管怎样，上面的代码应当根据你的特定需求来灵活调整。 通过上面的处理器，你可以使用类似这样的代码来传入结构化数据:

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)

如何将日志记录器作为输出流

有时，你需要通过接口访问某个预期要写入到文件型对象第三方 API，但你希望将 API 的输出重定向到一个日志记录器。 你可以使用一个以文件类 API 来包装日志记录器的类。 下面是一个演示这样的类的简短脚本:

import logging

class LoggerWriter:
    def __init__(self, logger, level):
        self.logger = logger
        self.level = level

    def write(self, message):
        if message != '\n':  # avoid printing bare newlines, if you like
            self.logger.log(self.level, message)

    def flush(self):
        # doesn't actually do anything, but might be expected of a file-like
        # object - so optional depending on your situation
        pass

    def close(self):
        # doesn't actually do anything, but might be expected of a file-like
        # object - so optional depending on your situation. You might want
        # to set a flag so that later calls to write raise an exception
        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()

当此脚本运行时，它将打印

INFO:demo:An INFO message
DEBUG:demo:A DEBUG message

你还可以使用 LoggerWriter 通过下面这样的做法来重定向 sys.stdout 和 sys.stderr:

import sys

sys.stdout = LoggerWriter(logger, logging.INFO)
sys.stderr = LoggerWriter(logger, logging.WARNING)

你应当在根据需要配置日志记录 之后 再这样做。 在上面的例子中，basicConfig() 调用执行了此操作（在 sys.stderr 被一个 LoggerWriter 实例覆盖 之前 使用它的值）。 然后，你将得到这样的结果:

>>> print('Foo')
INFO:demo:Foo
>>> print('Bar', file=sys.stderr)
WARNING:demo:Bar
>>>

Of course, these above examples show output according to the format used by basicConfig(), but you can use a different formatter when you configure logging.

请注意当使用上面的预置方案时，你将在一定程度上受到你所拦截的写入调用的缓冲和顺序的控制。 例如，在使用上述 LoggerWriter 的定义的情况下，如果你使用代码段

sys.stderr = LoggerWriter(logger, logging.WARNING)
1 / 0

则运行该脚本的结果为

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

你可以看到，这个输出并不很理解。 那是因为在下层写入到 sys.stderr 的代码会执行多次写入，每次写入将产生一条单独的日志记录行（例如，上面的最后三行）。 要避免这个问题，你需要使用缓冲并且只在看到换行符时才输出日志记录行。 让我们使用一个更好些的 LoggerWriter 实现:

class BufferingLoggerWriter(LoggerWriter):
    def __init__(self, logger, level):
        super().__init__(logger, level)
        self.buffer = ''

    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)

这段代码对内容进行了缓冲直至遇到换行符，然后将完整的行写入日志记录。 通过这种方式，你将得到更好的输出:

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

理应避免的用法

前几节虽介绍了几种方案，描述了可能需要处理的操作，但值得一提的是，有些用法是 没有好处 的，大多数情况下应该避免使用。下面几节的顺序不分先后。

多次打开同一个日志文件

因会导致 "文件被其他进程占用 "错误，所以在 Windows 中一般无法多次打开同一个文件。但在 POSIX 平台中，多次打开同一个文件不会报任何错误。这种操作可能是意外发生的，比如：

多次添加指向同一文件的 handler（比如通过复制/粘贴，或忘记修改）。

打开两个貌似不同（文件名不一样）的文件，但一个是另一个的符号链接，所以其实是同一个文件。

进程 fork，然后父进程和子进程都有对同一文件的引用。 例如，这可能是通过使用 multiprocessing 模块实现的。

在大多数情况下，多次打开同一个文件 貌似 一切正常，但实际会导致很多问题。

由于多个线程或进程会尝试写入同一个文件，日志输出可能会出现乱码。尽管日志对象可以防止多个线程同时使用同一个 handler 实例，但如果两个不同的线程使用不同的 handler 实例同时写入文件，而这两个 handler 又恰好指向同一个文件，那么就失去了这种防护。

尝试删除文件（例如在轮换日志文件时）会静默地失败，因为存在另一个指向它的引用。 这可能导致混乱并浪费调试时间 —— 日志条目会出现在意想不到的地方，或者完全丢失。 或者会有应当移除的文件仍然保持存在，文件还会在已经设置了基于文件大小的轮换的情况下仍然增长到预料之外的大小。

请用 从多个进程记录至单个文件 中介绍的技术来避免上述问题。

将日志对象用作属性或传递参数

虽然特殊情况下可能有必要如此，但一般来说没有意义，因为日志是单实例对象。代码总是可以通过 logging.getLogger(name) 用名称访问一个已有的日志对象实例，因此将实例作为参数来传递，或作为属性留存，都是毫无意义的。请注意，在其他语言中，如 Java 和 C#，日志对象通常是静态类属性。但在 Python 中是没有意义的，因为软件拆分的单位是模块（而不是类）。

给日志库代码添加 NullHandler 之外的其他 handler

通过添加 handler、formatter 和 filter 来配置日志，这是应用程序开发人员的责任，而不是库开发人员该做的。如果正在维护一个库，请确保不要向任何日志对象添加 NullHandler 实例以外的 handler。

创建大量的日志对象

日志是单实例对象，在代码执行过程中不会被释放，因此创建大量的日志对象会占用很多内存，而这些内存又不能被释放。与其为每个文件或网络连接创建一个日志，还不如利用 已有机制 将上下文信息传给自定义日志对象，并将创建的日志对象限制在应用程序内的指定区域（通常是模块，但偶尔会再精细些）使用。

其它资源

参见

模块 logging

日志记录模块的 API 参考。

logging.config 模块

日志记录模块的配置 API 。

logging.handlers 模块

日志记录模块附带的有用处理器。

基础教程

进阶教程

正则表达式指南

作者

A.M. Kuchling <amk@amk.ca>

摘要

本文是关于在 Python 中通过 re 模块使用正则表达式的入门教程。它提供了比“标准库参考”的相关章节更平易的介绍。

概述

正则表达式（Regular expressions，也叫 REs、 regexs 或 regex patterns），本质上是嵌入 Python 内部并通过 re 模块提供的一种微小的、高度专业化的编程语言。使用这种小语言，你可以为想要匹配的可能字符串编写规则；这些字符串可能是英文句子、邮箱地址、TeX 命令或任何你喜欢的内容。然后，你可以提出诸如“此字符串是否与表达式匹配？”、“字符串中是否存在表达式的匹配项？”之类的问题。你还可以用正则来修改字符串，或以各种方式将其拆分。

正则表达式会被编译成一系列字节码，然后由 C 语言编写的匹配引擎执行。对于高级用途，可能有必要特别注意引擎将如何执行一个给定的正则，并以某种方式写入正则，以生成运行更快的字节码。本文不涉及优化问题，因为这要求你对正则引擎的匹配过程有很好的了解。

正则表达式语言相对较小且受限，因此并非所有可能的字符串处理任务都可以使用正则表达式完成。有些任务尽管 可以 用正则表达式来完成，但表达式会变得非常复杂。 这些情况下，最好通过编写 Python 代码来进行处理。 也许 Python 代码会比精心设计的正则表达式慢，但它可能更容易理解。

简单正则

让我们从最简单的正则表达式开始吧。由于正则表达式是用来操作字符串的，我们将从最常见的任务开始：匹配字符。

关于正则表达式背后的计算机科学的详细解释（确定性和非确定性有限自动机），你可以参考几乎所有关于编写编译器的教科书。

匹配字符

大多数字母和符号都会简单地匹配自身。例如，正则表达式 test 将会精确地匹配到 test 。（你可以启用不区分大小写模式，让这个正则也匹配 Test 或 TEST ，稍后会详细介绍。）

但该规则有例外。有些字符是特殊的 元字符（metacharacters），并不匹配自身。事实上，它们表示匹配一些非常规的内容，或者通过重复它们或改变它们的含义来影响正则的其他部分。本文的大部分内容都致力于讨论各种元字符及其作用。

这是元字符的完整列表。它们的含义将在本 HOWTO 的其余部分进行讨论。

. ^ $ * + ? { } [ ] \ | ( )

首先介绍的元字符是 [ 和 ] 。这两个元字符用于指定一个字符类，也就是你希望匹配的字符的一个集合。这些字符可以单独地列出，也可以用字符范围来表示（给出两个字符并用 '-' 分隔）。例如，[abc] 将匹配 a、b、c 之中的任意一个字符；这与 [a-c] 相同，后者使用一个范围来表达相同的字符集合。如果只想匹配小写字母，则正则表达式将是 [a-z] 。

元字符 (除了 \) 在字符类中是不起作用的。 例如，[akm$] 将会匹配以下任一字符 'a', 'k', 'm' 或 '$'；'$' 通常是一个元字符，但在一个字符类中它的特殊性被消除了。

你可以通过对集合 取反 来匹配字符类中未列出的字符。方法是把 '^' 放在字符类的最开头。 例如，[^5] 将匹配除 '5' 之外的任何字符。 如果插入符出现在字符类的其他位置，则它没有特殊含义。 例如：[5^] 将匹配 '5' 或 '^'。

也许最重要的元字符是反斜杠，\ 。 与 Python 字符串字面量一样，反斜杠后面可以跟各种字符来表示各种特殊序列。它还用于转义元字符，以便可以在表达式中匹配元字符本身。例如，如果需要匹配一个 [ 或 \ ，可以在其前面加上一个反斜杠来消除它们的特殊含义：\[ 或 \\ 。

一些以 '\' 开头的特殊序列表示预定义的字符集合，这些字符集通常很有用，例如数字集合、字母集合或非空白字符集合。

让我们举一个例子：\w 匹配任何字母数字字符。 如果正则表达式以 bytes 类型表示，\w 相当于字符类 [a-zA-Z0-9_] 。如果正则表达式是 str 类型，\w 将匹配由 unicodedata 模块提供的 Unicode 数据库中标记为字母的所有字符。 通过在编译正则表达式时提供 re.ASCII 标志，可以在 str 表达式中使用较为狭窄的 \w 定义。

以下为特殊序列的不完全列表。 有关 Unicode 字符串正则表达式的序列和扩展类定义的完整列表，参见标准库参考中 正则表达式语法 的最后一部分 。通常，Unicode 版本的字符类会匹配 Unicode 数据库的相应类别中的任何字符。

\d

匹配任何十进制数字，等价于字符类 [0-9] 。

\D

匹配任何非数字字符，等价于字符类 [^0-9] 。

\s

匹配任何空白字符，等价于字符类 [ \t\n\r\f\v] 。

\S

匹配任何非空白字符，等价于字符类 [^ \t\n\r\f\v] 。

\w

匹配任何字母与数字字符，等价于字符类 [a-zA-Z0-9_] 。

\W

匹配任何非字母与数字字符，等价于字符类 [^a-zA-Z0-9_] 。

这些序列可以包含在字符类中。 例如，[\s,.] 是一个匹配任何空白字符、',' 或 '.' 的字符类。

本节的最后一个元字符是 . 。 它匹配除换行符之外的任何字符，并且有一个可选模式（ re.DOTALL ），在该模式下它甚至可以匹配换行符。 . 通常用于你想匹配“任何字符”的场景。

重复

能够匹配各种各样的字符集合是正则表达式可以做到的第一件事，而这是字符串方法所不能做到的。但是，如果正则表达式就只有这么一个附加功能，它很难说的上有多大优势。另一个功能是，你可以指定正则的某部分必须重复一定的次数。

我们先来说说重复元字符 * 。 * 并不是匹配一个字面字符 '*' 。实际上，它指定前一个字符可以匹配零次或更多次，而不是只匹配一次。

例如，ca*t 将匹配 'ct' （ 0 个 'a' ）、'cat' （ 1 个 'a' ）、 'caaat' （ 3 个 'a' ）等等。

类似 * 这样的重复是 贪婪的 。当重复正则时，匹配引擎将尝试重复尽可能多的次数。 如果表达式的后续部分不匹配，则匹配引擎将回退并以较少的重复次数再次尝试。

通过一个逐步示例更容易理解这一点。让我们分析一下表达式 a[bcd]*b 。 该表达式首先匹配一个字母 'a' ，接着匹配字符类 [bcd] 中的零个或更多个字母，最后以一个 'b' 结尾。 现在想象一下用这个正则来匹配字符串 'abcbd' 。

步骤 | 匹配 | 说明
1 | a | 正则中的 a 匹配成功。
2 | abcbd | 引擎尽可能多地匹配 [bcd]* ，直至字符串末尾。
3 | 失败 | 引擎尝试匹配 b ，但是当前位置位于字符串末尾，所以匹配失败。
4 | abcb | 回退，让 [bcd]* 少匹配一个字符。
5 | 失败 | 再次尝试匹配 b ， 但是当前位置上的字符是最后一个字符 'd' 。
6 | abc | 再次回退，让 [bcd]* 只匹配 bc 。
6 | abcb | 再次尝试匹配 b 。 这一次当前位置的字符是 'b' ，所以它成功了。

此时正则表达式已经到达了尽头，并且匹配到了 'abcb' 。 这个例子演示了匹配引擎一开始会尽其所能地进行匹配，如果没有找到匹配，它将逐步回退并重试正则的剩余部分，如此往复，直至 [bcd]* 只匹配零次。如果随后的匹配还是失败了，那么引擎会宣告整个正则表达式与字符串匹配失败。

另一个重复元字符是 + ，表示匹配一次或更多次。请注意 * 与 + 之间的差别。 * 表示匹配 零次 或更多次，也就是说它所重复的内容是可以完全不出现的。而 + 则要求至少出现一次。举一个类似的例子， ca+t 可以匹配 'cat' （ 1 个 'a' ）或 'caaat' （ 3 个 'a'），但不能匹配 'ct' 。

还有两个重复限定符。 问号 ? 表示匹配一次或零次。你可以认为它把内容变成了可选的。例如，home-?brew 可以 匹配 'homebrew' 或 'home-brew'。

最复杂的重复限定符是 {m,n}，其中 m 和 n 是十进制整数。 该限定符意味着必须至少重复 m 次，最多重复 n 次。 例如，a/{1,3}b 可以匹配 'a/b'、'a//b' 或者 'a///b' ，但不能匹配中间没有斜杆的 'ab'，或者四个斜杆的 'a////b' 。

m 和 n 不是必填的，缺失的情况下会设定为默认值。缺失 m 会解释为最少重复 0 次 ，缺失 n 则解释为最多重复无限次。

细心的读者也许注意到了，前面的三个重复限定符都可以用这种标记法来表示。 {0,} 等同于 * ，{1,} 等同于 + ，{0,1} 等同于 ? 。 如果可以的话，最好使用 * 、+ 、或 ? ，因为后者更简洁易读。

使用正则表达式

现在我们已经了解了一些简单的正则表达式，那么我们如何在 Python 中实际使用它们呢？ re 模块提供了正则表达式引擎的接口，可以让你将正则编译为对象，然后用它们来进行匹配。

编译正则表达式

正则表达式被编译成模式对象，模式对象具有各种操作的方法，例如搜索模式匹配或执行字符串替换。:

>>> import re
>>> p = re.compile('ab*')
>>> p
re.compile('ab*')

re.compile() 也接受一个可选的 flags 参数，用于启用各种特殊功能和语法变体。 我们稍后将介绍可用的设置，但现在只需一个例子

>>> p = re.compile('ab*', re.IGNORECASE)

正则作为字符串传递给 re.compile() 。 正则被处理为字符串，因为正则表达式不是核心Python语言的一部分，并且没有创建用于表达它们的特殊语法。 （有些应用程序根本不需要正则，因此不需要通过包含它们来扩展语言规范。）相反，re 模块只是Python附带的C扩展模块，就类似于 socket 或 zlib 模块。

将正则放在字符串中可以使 Python 语言更简单，但有一个缺点是下一节的主题。

反斜杠灾难

如前所述，正则表达式使用反斜杠字符 ('\') 来表示特殊形式或允许使用特殊字符而不调用它们的特殊含义。 这与 Python 在字符串文字中用于相同目的的相同字符的使用相冲突。

假设你想要编写一个与字符串 \section 相匹配的正则，它可以在 LaTeX 文件中找到。 要找出在程序代码中写入的内容，请从要匹配的字符串开始。 接下来，您必须通过在反斜杠前面添加反斜杠和其他元字符，从而产生字符串 \\section。 必须传递给 re.compile() 的结果字符串必须是 \\section。 但是，要将其表示为 Python 字符串文字，必须 再次 转义两个反斜杠。

字符 | 阶段
\section | 被匹配的字符串
\\section | 为 re.compile() 转义的反斜杠
"\\\\section" | 为字符串字面转义的反斜杠

简而言之，要匹配文字反斜杠，必须将 '\\\\' 写为正则字符串，因为正则表达式必须是 \\，并且每个反斜杠必须表示为 \\ 在常规Python字符串字面中。 在反复使用反斜杠的正则中，这会导致大量重复的反斜杠，并使得生成的字符串难以理解。

解决方案是使用 Python 的原始字符串表示法来表示正则表达式；反斜杠不以任何特殊的方式处理前缀为 'r' 的字符串字面，因此 r"\n" 是一个包含 '\' 和 'n' 的双字符字符串，而 "\n" 是一个包含换行符的单字符字符串。 正则表达式通常使用这种原始字符串表示法用 Python 代码编写。

此外，在正则表达式中有效但在 Python 字符串文字中无效的特殊转义序列现在导致 DeprecationWarning 并最终变为 SyntaxError。 这意味着如果未使用原始字符串表示法或转义反斜杠，序列将无效。

常规字符串 | 原始字符串
"ab*" | r"ab*"
"\\\\section" | r"\\section"
"\\w+\\s+\\1" | r"\w+\s+\1"

应用匹配

一旦你有一个表示编译正则表达式的对象，你用它做什么？ 模式对象有几种方法和属性。 这里只介绍最重要的内容；请参阅 re 文档获取完整列表。

方法 / 属性 | 目的
match() | 确定正则是否从字符串的开头匹配。
search() | 扫描字符串，查找此正则匹配的任何位置。
findall() | 找到正则匹配的所有子字符串，并将它们作为列表返回。
finditer() | 找到正则匹配的所有子字符串，并将它们返回为一个 iterator。

如果没有找到匹配， match() 和 search() 返回 None 。如果它们成功， 一个 匹配对象 实例将被返回，包含匹配相关的信息：起始和终结位置、匹配的子串以及其它。

你可以通过与 re 模块进行交互式的试验来学习这个。 如果你有 tkinter，你也可以看看 Tools/demo/redemo.py [https://github.com/python/cpython/tree/3.10/Tools/demo/redemo.py]，这是一个 Python 发行版自带的演示程序。 它允许你输入正则和字符串，并显示正则是匹配还是失败。 redemo.py 在调试复杂的正则时非常有用。

本 HOWTO 使用标准 Python 解释器作为示例。 首先，运行 Python 解释器，导入 re 模块，然后编译一个正则

>>> import re
>>> p = re.compile('[a-z]+')
>>> p
re.compile('[a-z]+')

现在，你可以尝试匹配正则 [a-z]+ 的各种字符串。 空字符串根本不匹配，因为 + 表示“一次或多次重复”。 match() 在这种情况下应返回 None，这将导致解释器不打印输出。 你可以显式打印 match() 的结果，使其清晰。:

>>> p.match("")
>>> print(p.match(""))
None

现在，让我们尝试一下它应该匹配的字符串，例如 tempo。在这个例子中 match() 将返回一个 匹配对象，因此你应该将结果储存到一个变量中以供稍后使用。

>>> m = p.match('tempo')
>>> m
<re.Match object; span=(0, 5), match='tempo'>

现在你可以检查 匹配对象 以获取有关匹配字符串的信息。 匹配对象实例也有几个方法和属性；最重要的是：

方法 / 属性 | 目的
group() | 返回正则匹配的字符串
start() | 返回匹配的开始位置
end() | 返回匹配的结束位置
span() | 返回包含匹配 (start, end) 位置的元组

尝试这些方法很快就会清楚它们的含义:

>>> m.group()
'tempo'
>>> m.start(), m.end()
(0, 5)
>>> m.span()
(0, 5)

group() 返回正则匹配的子字符串。 start() 和 end() 返回匹配的起始和结束索引。 span() 在单个元组中返回开始和结束索引。 由于 match() 方法只检查正则是否在字符串的开头匹配，所以 start() 将始终为零。 但是，模式的 search() 方法会扫描字符串，因此在这种情况下匹配可能不会从零开始。:

>>> 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)

在实际程序中，最常见的样式是在变量中存储 匹配对象，然后检查它是否为 None。 这通常看起来像:

p = re.compile( ... )
m = p.match( 'string goes here' )
if m:
    print('Match found: ', m.group())
else:
    print('No match')

两种模式方法返回模式的所有匹配项。 findall() 返回匹配字符串的列表:

>>> p = re.compile(r'\d+')
>>> p.findall('12 drummers drumming, 11 pipers piping, 10 lords a-leaping')
['12', '11', '10']

在这个例子中需要 r 前缀，使字面为原始字符串字面，因为普通的“加工”字符串字面中的转义序列不能被 Python 识别为正则表达式，导致 DeprecationWarning 并最终产生 SyntaxError。 请参阅 反斜杠灾难。

findall() 必须先创建整个列表才能返回结果。 finditer() 方法将一个 匹配对象 的序列返回为一个 iterator

>>> 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)

模块级函数

你不必创建模式对象并调用其方法；re 模块还提供了顶级函数 match()，search()，findall()，sub() 等等。 这些函数采用与相应模式方法相同的参数，并将正则字符串作为第一个参数添加，并仍然返回 None 或 匹配对象 实例。:

>>> 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 '>

本质上，这些函数只是为你创建一个模式对象，并在其上调用适当的方法。 它们还将编译对象存储在缓存中，因此使用相同的未来调用将不需要一次又一次地解析该模式。

你是否应该使用这些模块级函数，还是应该自己获取模式并调用其方法？ 如果你正在循环中访问正则表达式，预编译它将节省一些函数调用。 在循环之外，由于有内部缓存，没有太大区别。

编译标志

编译标志允许你修改正则表达式的工作方式。 标志在 re 模块中有两个名称，长名称如 IGNORECASE 和一个简短的单字母形式，例如 I。 （如果你熟悉 Perl 的模式修饰符，则单字母形式使用和其相同的字母；例如， re.VERBOSE 的缩写形式为 re.X。）多个标志可以 通过按位或运算来指定它们；例如，re.I | re.M 设置 I 和 M 标志。

这是一个可用标志表，以及每个标志的更详细说明。

标志位 | 含意
ASCII, A | 使几个转义如 \w、\b、\s 和 \d 匹配仅与具有相应特征属性的 ASCII 字符匹配。
DOTALL, S | 使 . 匹配任何字符，包括换行符。
IGNORECASE, I | 进行大小写不敏感匹配。
LOCALE, L | 进行区域设置感知匹配。
MULTILINE, M | 多行匹配，影响 ^ 和 $。
VERBOSE, X （为 '扩展'） | 启用详细的正则，可以更清晰，更容易理解。

I

IGNORECASE

执行不区分大小写的匹配；字符类和字面字符串将通过忽略大小写来匹配字母。 例如，[A-Z] 也匹配小写字母。 除非使用 ASCII 标志来禁用非ASCII匹配，否则完全 Unicode 匹配也有效。 当 Unicode 模式 [a-z] 或 [A-Z] 与 IGNORECASE 标志结合使用时，它们将匹配 52 个 ASCII 字母和 4 个额外的非 ASCII 字母：'İ' (U+0130，拉丁大写字母 I，带上面的点)，'ı' (U+0131，拉丁文小写字母无点 i)，'s' (U+017F，拉丁文小写字母长 s) 和'K' (U+212A，开尔文符号)。 Spam 将匹配 'Spam'，'spam'，'spAM' 或 'ſpam' (后者仅在 Unicode 模式下匹配)。 此小写不考虑当前区域设置；如果你还设置了 LOCALE 标志，则将考虑。

L

LOCALE

使 \w、\W、\b、\B 和大小写敏感匹配依赖于当前区域而不是 Unicode 数据库。

区域设置是 C 库的一个功能，旨在帮助编写考虑到语言差异的程序。例如，如果你正在处理编码的法语文本，那么你希望能够编写 \w+ 来匹配单词，但 \w 只匹配字符类 [A-Za-z] 字节模式；它不会匹配对应于 é 或 ç 的字节。如果你的系统配置正确并且选择了法语区域设置，某些C函数将告诉程序对应于 é 的字节也应该被视为字母。在编译正则表达式时设置 LOCALE 标志将导致生成的编译对象将这些C函数用于 \w；这比较慢，但也可以使 \w+ 匹配你所期望的法语单词。在 Python 3 中不鼓励使用此标志，因为语言环境机制非常不可靠，它一次只处理一个“文化”，它只适用于 8 位语言环境。默认情况下，Python 3 中已经为 Unicode（str）模式启用了 Unicode 匹配，并且它能够处理不同的区域/语言。

M

MULTILINE

(^ 和 $ 还没有解释；它们将在以下部分介绍 更多元字符。)

通常 ^ 只匹配字符串的开头，而 $ 只匹配字符串的结尾，紧接在字符串末尾的换行符（如果有的话）之前。 当指定了这个标志时，^ 匹配字符串的开头和字符串中每一行的开头，紧跟在每个换行符之后。 类似地，$ 元字符匹配字符串的结尾和每行的结尾（紧接在每个换行符之前）。

S

DOTALL

使 '.' 特殊字符匹配任何字符，包括换行符；没有这个标志，'.' 将匹配任何字符 除了 换行符。

A

ASCII

使 \w、\W、\b、\B、\s 和 \S 执行仅 ASCII 匹配而不是完整匹配 Unicode 匹配。 这仅对 Unicode 模式有意义，并且对于字节模式将被忽略。

X

VERBOSE

此标志允许你编写更易读的正则表达式，方法是为您提供更灵活的格式化方式。 指定此标志后，将忽略正则字符串中的空格，除非空格位于字符类中或前面带有未转义的反斜杠；这使你可以更清楚地组织和缩进正则。 此标志还允许你将注释放在正则中，引擎将忽略该注释；注释标记为 '#' 既不是在字符类中，也不是在未转义的反斜杠之前。

例如，这里的正则使用 re.VERBOSE；看看阅读有多容易？:

charref = re.compile(r"""
 &[#]                # Start of a numeric entity reference
 (
     0[0-7]+         # Octal form
   | [0-9]+          # Decimal form
   | x[0-9a-fA-F]+   # Hexadecimal form
 )
 ;                   # Trailing semicolon
""", re.VERBOSE)

如果没有详细设置，正则将如下所示:

charref = re.compile("&#(0[0-7]+"
                     "|[0-9]+"
                     "|x[0-9a-fA-F]+);")

在上面的例子中，Python的字符串文字的自动连接已被用于将正则分解为更小的部分，但它仍然比以下使用 re.VERBOSE 版本更难理解。

更多模式能力

到目前为止，我们只介绍了正则表达式的一部分功能。 在本节中，我们将介绍一些新的元字符，以及如何使用组来检索匹配的文本部分。

更多元字符

我们还没有涉及到一些元字符。 其中大部分内容将在本节中介绍。

要讨论的其余一些元字符是 零宽度断言 。 它们不会使解析引擎在字符串中前进一个字符；相反，它们根本不占用任何字符，只是成功或失败。例如，\b 是一个断言，指明当前位置位于字边界；这个位置根本不会被 \b 改变。这意味着永远不应重复零宽度断言，因为如果它们在给定位置匹配一次，它们显然可以无限次匹配。

|

或者“or”运算符。 如果 A 和 B 是正则表达式，A|B 将匹配任何与 A 或 B 匹配的字符串。 | 具有非常低的优先级，以便在交替使用多字符字符串时使其合理地工作。 Crow|Servo 将匹配 'Crow' 或 'Servo'，而不是 'Cro'、'w' 或 'S' 和 'ervo'。

要匹配字面 '|'，请使用 \|，或将其括在字符类中，如 [|]。

^

在行的开头匹配。 除非设置了 MULTILINE 标志，否则只会在字符串的开头匹配。 在 MULTILINE 模式下，这也在字符串中的每个换行符后立即匹配。

例如，如果你希望仅在行的开头匹配单词 From，则要使用的正则 ^From。:

>>> print(re.search('^From', 'From Here to Eternity'))
<re.Match object; span=(0, 4), match='From'>
>>> print(re.search('^From', 'Reciting From Memory'))
None

要匹配字面 '^'，使用 \^。

$

匹配行的末尾，定义为字符串的结尾，或者后跟换行符的任何位置。:

>>> 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='}'>

以匹配字面 '$'，使用 \$ 或者将其包裹在一个字符类中，例如 [$]。

\A

仅匹配字符串的开头。 当不在 MULTILINE 模式时，\A 和 ^ 实际上是相同的。 在 MULTILINE 模式中，它们是不同的: \A 仍然只在字符串的开头匹配，但 ^ 可以匹配在换行符之后的字符串内的任何位置。

\Z

只匹配字符串尾。

\b

字边界。 这是一个零宽度断言，仅在单词的开头或结尾处匹配。 单词被定义为一个字母数字字符序列，因此单词的结尾由空格或非字母数字字符表示。

以下示例仅当它是一个完整的单词时匹配 class；当它包含在另一个单词中时将不会匹配。

>>> 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

使用这个特殊序列时，你应该记住两个细微之处。 首先，这是 Python 的字符串文字和正则表达式序列之间最严重的冲突。 在 Python 的字符串文字中，\b 是退格字符，ASCII 值为8。 如果你没有使用原始字符串，那么 Python 会将 \b 转换为退格，你的正则不会按照你的预期匹配。 以下示例与我们之前的正则看起来相同，但省略了正则字符串前面的 'r'。:

>>> 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'>

其次，在一个字符类中，这个断言没有用处，\b 表示退格字符，以便与 Python 的字符串文字兼容。

\B

另一个零宽度断言，这与 \b 相反，仅在当前位置不在字边界时才匹配。

分组

通常，你需要获取更多信息，而不仅仅是正则是否匹配。 正则表达式通常用于通过将正则分成几个子组来解析字符串，这些子组匹配不同的感兴趣组件。 例如，RFC-822 标题行分为标题名称和值，用 ':' 分隔，如下所示：

From: author@example.com
User-Agent: Thunderbird 1.5.0.9 (X11/20061227)
MIME-Version: 1.0
To: editor@example.com

这可以通过编写与整个标题行匹配的正则表达式来处理，并且具有与标题名称匹配的一个组，以及与标题的值匹配的另一个组。

组由 '('，')' 元字符标记。 '(' 和 ')' 与数学表达式的含义大致相同；它们将包含在其中的表达式组合在一起，你可以使用重复限定符重复组的内容，例如 *，+，? 或 {m,n}。 例如，(ab)* 将匹配 ab 的零次或多次重复。:

>>> p = re.compile('(ab)*')
>>> print(p.match('ababababab').span())
(0, 10)

用 '('，')' 表示的组也捕获它们匹配的文本的起始和结束索引；这可以通过将参数传递给 group()、start()、end() 以及 span()。 组从 0 开始编号。组 0 始终存在；它表示整个正则，所以 匹配对象 方法都将组 0 作为默认参数。 稍后我们将看到如何表达不捕获它们匹配的文本范围的组。:

>>> p = re.compile('(a)b')
>>> m = p.match('ab')
>>> m.group()
'ab'
>>> m.group(0)
'ab'

子组从左到右编号，从 1 向上编号。 组可以嵌套；要确定编号，只需计算从左到右的左括号字符。:

>>> p = re.compile('(a(b)c)d')
>>> m = p.match('abcd')
>>> m.group(0)
'abcd'
>>> m.group(1)
'abc'
>>> m.group(2)
'b'

group() 可以一次传递多个组号，在这种情况下，它将返回一个包含这些组的相应值的元组。:

>>> m.group(2,1,2)
('b', 'abc', 'b')

groups() 方法返回一个元组，其中包含所有子组的字符串，从1到最后一个子组。:

>>> m.groups()
('abc', 'b')

模式中的后向引用允许你指定还必须在字符串中的当前位置找到先前捕获组的内容。 例如，如果可以在当前位置找到组 1 的确切内容，则 \1 将成功，否则将失败。 请记住，Python 的字符串文字也使用反斜杠后跟数字以允许在字符串中包含任意字符，因此正则中引入反向引用时务必使用原始字符串。

例如，以下正则检测字符串中重复的单词。:

>>> p = re.compile(r'\b(\w+)\s+\1\b')
>>> p.search('Paris in the the spring').group()
'the the'

像这样的后向引用通常不仅仅用于搜索字符串 —— 很少有文本格式以这种方式重复数据 —— 但是你很快就会发现它们在执行字符串替换时 非常 有用。

非捕获和命名组

精心设计的正则可以使用许多组，既可以捕获感兴趣的子串，也可以对正则本身进行分组和构建。 在复杂的正则中，很难跟踪组号。 有两个功能可以帮助解决这个问题。 它们都使用常用语法进行正则表达式扩展，因此我们首先看一下。

Perl 5 以其对标准正则表达式的强大补充而闻名。 对于这些新功能，Perl 开发人员无法选择新的单键击元字符或以 \ 开头的新特殊序列，否则 Perl 的正则表达式与标准正则容易混淆。 例如，如果他们选择 & 作为一个新的元字符，旧的表达式将假设 & 是一个普通字符，并且不会编写 \& 或 [&]。

Perl 开发人员选择的解决方案是使用 (?...) 作为扩展语法。 括号后面紧跟 ? 是一个语法错误，因为 ? 没有什么可重复的，所以这样并不会带来任何兼容性问题。 紧跟在 ? 之后的字符表示正在使用的扩展语法，所以 (?=foo) 是一种语法（一个前视断言）和 (?:foo) 是另一种语法（ 包含子表达式 foo 的非捕获组）。

Python 支持一些 Perl 的扩展，并增加了新的扩展语法用于 Perl 的扩展语法。 如果在问号之后的第一个字符为 P，即表明其为 Python 专属的扩展。

现在我们已经了解了一般的扩展语法，我们可以回到简化复杂正则中组处理的功能。

有时你会想要使用组来表示正则表达式的一部分，但是对检索组的内容不感兴趣。 你可以通过使用非捕获组来显式表达这个事实: (?:...)，你可以用任何其他正则表达式替换 ...。:

>>> m = re.match("([abc])+", "abc")
>>> m.groups()
('c',)
>>> m = re.match("(?:[abc])+", "abc")
>>> m.groups()
()

除了你无法检索组匹配内容的事实外，非捕获组的行为与捕获组完全相同；你可以在里面放任何东西，用重复元字符重复它，比如 *，然后把它嵌入其他组（捕获或不捕获）。 (?:...) 在修改现有模式时特别有用，因为你可以添加新组而不更改所有其他组的编号方式。 值得一提的是，捕获和非捕获组之间的搜索没有性能差异；两种形式没有一种更快。

更重要的功能是命名组：不是通过数字引用它们，而是可以通过名称引用组。

命名组的语法是Python特定的扩展之一: (?P<name>...)。 name 显然是该组的名称。 命名组的行为与捕获组完全相同，并且还将名称与组关联。 处理捕获组的 匹配对象 方法都接受按编号引用组的整数或包含所需组名的字符串。 命名组仍然是给定的数字，因此你可以通过两种方式检索有关组的信息:

>>> p = re.compile(r'(?P<word>\b\w+\b)')
>>> m = p.search( '(((( Lots of punctuation )))' )
>>> m.group('word')
'Lots'
>>> m.group(1)
'Lots'

此外，你可以通过 groupdict() 将命名分组提取为一个字典:

>>> m = re.match(r'(?P<first>\w+) (?P<last>\w+)', 'Jane Doe')
>>> m.groupdict()
{'first': 'Jane', 'last': 'Doe'}

命名分组很方便因为它们让你可以使用容易记忆的名称，而不必记忆数字。 下面是一个来自 imaplib 模块的正则表达式示例:

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'"')

检索 m.group('zonem') 显然要容易得多，而不必记住检索第 9 组。

表达式中的后向引用语法，例如 (...)\1，指的是组的编号。 当然有一种变体使用组名而不是数字。 这是另一个 Python 扩展: (?P=name) 表示在当前点再次匹配名为 name 的组的内容。 用于查找重复单词的正则表达式，\b(\w+)\s+\1\b 也可以写为 \b(?P<word>\w+)\s+(?P=word)\b:

>>> p = re.compile(r'\b(?P<word>\w+)\s+(?P=word)\b')
>>> p.search('Paris in the the spring').group()
'the the'

前视断言

另一个零宽断言是前视断言。 前视断言有肯定型和否定型两种形式，如下所示：

(?=…)

肯定型前视断言。如果内部的表达式（这里用 ... 来表示）在当前位置可以匹配，则匹配成功，否则匹配失败。 但是，内部表达式尝试匹配之后，正则引擎并不会向前推进；正则表达式的其余部分依然会在断言开始的地方尝试匹配。

(?!…)

否定型前视断言。 与肯定型断言正好相反，如果内部表达式在字符串中的当前位置 不 匹配，则成功。

更具体一些，来看一个前视的实用案例。 考虑用一个简单的表达式来匹配文件名并将其拆分为基本名称和扩展名，以 . 分隔。 例如，在 news.rc 中，news 是基本名称，rc 是文件名的扩展名。

与此匹配的模式非常简单：

.*[.].*$

请注意，. 需要特别处理，因为它是元字符，所以它在字符类中只能匹配特定字符。 还要注意尾随的 $；添加此项以确保扩展名中的所有其余字符串都必须包含在扩展名中。 这个正则表达式匹配 foo.bar、autoexec.bat、sendmail.cf 和 printers.conf。

现在，考虑使更复杂一点的问题；如果你想匹配扩展名不是 bat 的文件名怎么办？ 一些错误的尝试：

.*[.][^b].*$ 上面的第一次尝试试图通过要求扩展名的第一个字符不是 b 来排除 bat。 这是错误的，因为模式也与 foo.bar 不匹配。

.*[.]([^b]..|.[^a].|..[^t])$

当你尝试通过要求以下一种情况匹配来修补第一个解决方案时，表达式变得更加混乱：扩展的第一个字符不是 b。 第二个字符不 a；或者第三个字符不是 t。 这接受 foo.bar 并拒绝 autoexec.bat，但它需要三个字母的扩展名，并且不接受带有两个字母扩展名的文件名，例如 sendmail.cf。 为了解决这个问题，我们会再次使模式复杂化。

.*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$

在第三次尝试中，第二个和第三个字母都是可选的，以便允许匹配的扩展名短于三个字符，例如 sendmail.cf。

模式现在变得非常复杂，这使得它难以阅读和理解。 更糟糕的是，如果问题发生变化并且你想要将 bat 和 exe 排除为扩展，那么该模式将变得更加复杂和混乱。

否定型前视可以解决所有这些困扰：

.*[.](?!bat$)[^.]*$ 否定型前视意味着：如果表达式 bat 在当前位置不能匹配，则可以接着尝试正则表达式的其余部分；如果 bat$ 能匹配，则整个正则表达式将匹配失败。尾随的 $ 是必需的，以确保可以匹配到像 sample.batch 这样以 bat 开头的文件名。当文件名中有多个点号时， [^.]* 可以确保表达式依然有效。

现在很容易排除另一个文件扩展名；只需在断言中添加它作为替代。 以下模块排除以 bat 或 exe:

.*[.](?!bat$|exe$)[^.]*$

修改字符串

到目前为止，我们只是针对静态字符串执行搜索。 正则表达式通常也用于以各种方式修改字符串，使用以下模式方法：

方法 / 属性 | 目的
split() | 将字符串拆分为一个列表，在正则匹配的任何地方将其拆分
sub() | 找到正则匹配的所有子字符串，并用不同的字符串替换它们
subn() | 与 sub() 相同，但返回新字符串和替换次数

分割字符串

模式的 split() 方法在正则匹配的任何地方拆分字符串，返回一个片段列表。 它类似于 split() 字符串方法，但在分隔符的分隔符中提供了更多的通用性；字符串的 split() 仅支持按空格或固定字符串进行拆分。 正如你所期望的那样，还有一个模块级 re.split() 函数。

.split(string[, maxsplit=0])

通过正则表达式的匹配拆分 字符串。 如果在正则中使用捕获括号，则它们的内容也将作为结果列表的一部分返回。 如果 maxsplit 非零，则最多执行 maxsplit 次拆分。

你可以通过传递 maxsplit 的值来限制分割的数量。 当 maxsplit 非零时，将最多进行 maxsplit 次拆分，并且字符串的其余部分将作为列表的最后一个元素返回。 在以下示例中，分隔符是任何非字母数字字符序列。:

>>> 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', '']
>>> p.split('This is a test, short and sweet, of split().', 3)
['This', 'is', 'a', 'test, short and sweet, of split().']

有时你不仅对分隔符之间的文本感兴趣，而且还需要知道分隔符是什么。 如果在正则中使用捕获括号，则它们的值也将作为列表的一部分返回。 比较以下调用:

>>> p = re.compile(r'\W+')
>>> p2 = re.compile(r'(\W+)')
>>> p.split('This... is a test.')
['This', 'is', 'a', 'test', '']
>>> p2.split('This... is a test.')
['This', '... ', 'is', ' ', 'a', ' ', 'test', '.', '']

模块级函数 re.split() 添加要正则作为第一个参数，但在其他方面是相同的。:

>>> re.split(r'[\W]+', 'Words, words, words.')
['Words', 'words', 'words', '']
>>> re.split(r'([\W]+)', 'Words, words, words.')
['Words', ', ', 'words', ', ', 'words', '.', '']
>>> re.split(r'[\W]+', 'Words, words, words.', 1)
['Words', 'words, words.']

搜索和替换

另一个常见任务是找到模式的所有匹配项，并用不同的字符串替换它们。 sub() 方法接受一个替换值，可以是字符串或函数，也可以是要处理的字符串。

.sub(replacement, string[, count=0])

返回通过替换 replacement 替换 string 中正则的最左边非重叠出现而获得的字符串。 如果未找到模式，则 string 将保持不变。

可选参数 count 是要替换的模式最大的出现次数；count 必须是非负整数。 默认值 0 表示替换所有。

这是一个使用 sub() 方法的简单示例。 它用 colour 这个词取代颜色名称:

>>> 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'

subn() 方法完成相同的工作，但返回一个包含新字符串值和已执行的替换次数的 2 元组:

>>> 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)

仅当空匹配与前一个空匹配不相邻时，才会替换空匹配。:

>>> p = re.compile('x*')
>>> p.sub('-', 'abxd')
'-a-b--d-'

如果 replacement 是一个字符串，则处理其中的任何反斜杠转义。 也就是说，\n 被转换为单个换行符，\r 被转换为回车符，依此类推。 诸如 \& 之类的未知转义是孤立的。 后向引用，例如 \6，被替换为正则中相应组匹配的子字符串。 这使你可以在生成的替换字符串中合并原始文本的部分内容。

这个例子匹配单词 section 后跟一个用 {，} 括起来的字符串，并将 section 改为 subsection

>>> p = re.compile('section{ ( [^}]* ) }', re.VERBOSE)
>>> p.sub(r'subsection{\1}','section{First} section{second}')
'subsection{First} subsection{second}'

还有一种语法用于引用由 (?P<name>...) 语法定义的命名组。 \g<name> 将使用名为 name 的组匹配的子字符串，\g<number> 使用相应的组号。 因此 \g<2> 等同于 \2，但在诸如 \g<2>0 之类的替换字符串中并不模糊。 (\20 将被解释为对组 20 的引用，而不是对组 2 的引用，后跟字面字符 '0'。) 以下替换都是等效的，但使用所有三种变体替换字符串。:

>>> 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}'

replacement 也可以是一个函数，它可以为你提供更多控制。 如果 replacement 是一个函数，则为 pattern 的每次非重叠出现将调用该函数。 在每次调用时，函数都会传递一个匹配的 匹配对象 参数，并可以使用此信息计算所需的替换字符串并将其返回。

在以下示例中，替换函数将小数转换为十六进制:

>>> def hexrepl(match):
...     "Return the hex string for a decimal number"
...     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.'

使用模块级别 re.sub() 函数时，模式作为第一个参数传递。 模式可以是对象或字符串；如果需要指定正则表达式标志，则必须使用模式对象作为第一个参数，或者在模式字符串中使用嵌入式修饰符，例如: sub("(?i)b+", "x", "bbbb BBBB") 返回 'x x'。

常见问题

正则表达式对于某些应用程序来说是一个强大的工具，但在某些方面，它们的行为并不直观，有时它们的行为方式与你的预期不同。 本节将指出一些最常见的陷阱。

使用字符串方法

有时使用 re 模块是一个错误。 如果你匹配固定字符串或单个字符类，并且你没有使用任何 re 功能，例如 IGNORECASE 标志，那么正则表达式的全部功能可能不是必需的。 字符串有几种方法可以使用固定字符串执行操作，它们通常要快得多，因为实现是一个针对此目的而优化的单个小 C 循环，而不是大型、更通用的正则表达式引擎。

一个例子可能是用另一个固定字符串替换一个固定字符串；例如，你可以用 deed 替换 word 。 re.sub() 看起来像是用于此的函数，但请考虑 replace() 方法。 注意 replace() 也会替换单词里面的 word ，把 swordfish 变成 sdeedfish ，但简单的正则 word 也会这样做。 （为了避免对单词的部分进行替换，模式必须是 \bword\b，以便要求 word 在任何一方都有一个单词边界。这使得工作超出了 replace() 的能力。）

另一个常见任务是从字符串中删除单个字符的每个匹配项或将其替换为另一个字符。 你可以用 re.sub('\n', ' ', S) 之类的东西来做这件事，但是 translate() 能够完成这两项任务，并且比任何正则表达式都快。

简而言之，在转向 re 模块之前，请考虑是否可以使用更快更简单的字符串方法解决问题。

match() 和 search()

The match() function only checks if the RE matches at the beginning of the string while search() will scan forward through the string for a match. It's important to keep this distinction in mind. Remember, match() will only report a successful match which will start at 0; if the match wouldn't start at zero, match() will not report it.

>>> print(re.match('super', 'superstition').span())
(0, 5)
>>> print(re.match('super', 'insuperable'))
None

另一方面， search() 将向前扫描字符串，报告它找到的第一个匹配项。:

>>> print(re.search('super', 'superstition').span())
(0, 5)
>>> print(re.search('super', 'insuperable').span())
(2, 7)

有时你会被诱惑继续使用 re.match() ，只需在你的正则前面添加 .* 。抵制这种诱惑并使用 re.search() 代替。 正则表达式编译器对正则进行一些分析，以加快寻找匹配的过程。 其中一个分析可以确定匹配的第一个特征必须是什么；例如，以 Crow 开头的模式必须与 'C' 匹配。 分析让引擎快速扫描字符串，寻找起始字符，只在找到 'C' 时尝试完全匹配。

添加 .* 会使这个优化失效，需要扫描到字符串的末尾，然后回溯以找到正则的其余部分的匹配。 使用 re.search() 代替。

贪婪与非贪婪

当重复一个正则表达式时，就像在 a* 中一样，最终的动作就是消耗尽可能多的模式。 当你尝试匹配一对对称分隔符，例如 HTML 标记周围的尖括号时，这个事实经常会让你感到困惑。因为 .* 的贪婪性质， 用于匹配单个 HTML 标记的简单模式不起作用。

>>> 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>

正则匹配 '<' 中的 '<html>' 和 .* 消耗字符串的其余部分。 正则中还有更多的剩余东西，并且 > 在字符串的末尾不能匹配，所以正则表达式引擎必须逐个字符地回溯，直到它找到匹配 > 。最终匹配从 '<html>' 中的 '<' 扩展到 '</title>' 中的 '>' ，而这并不是你想要的结果。

在这种情况下，解决方案是使用非贪婪的限定符 *? 、 +? 、 ?? 或 {m,n}? ，匹配为尽可能 少 的文字。 在上面的例子中，在第一次 '<' 匹配后立即尝试 '>' ，当它失败时，引擎一次前进一个字符，每一步都重试 '>' 。 这产生了正确的结果:

>>> print(re.match('<.*?>', s).group())
<html>

（请注意，使用正则表达式解析 HTML 或 XML 很痛苦。快而脏的模式将处理常见情况，但 HTML 和 XML 有特殊情况会破坏明显的正则表达式；当你编写正则表达式处理所有可能的情况时，模式将非常复杂。使用 HTML 或 XML 解析器模块来执行此类任务。）

使用 re.VERBOSE

到目前为止，你可能已经注意到正则表达式是一种非常紧凑的表示法，但它们并不是非常易读。 具有中等复杂度的正则可能会成为反斜杠、括号和元字符的冗长集合，使其难以阅读和理解。

对于这样的正则，在编译正则表达式时指定 re.VERBOSE 标志可能会有所帮助，因为它允许你更清楚地格式化正则表达式。

re.VERBOSE 标志有几种效果。 正则表达式中的 不是 在字符类中的空格将被忽略。 这意味着表达式如 dog | cat 等同于不太可读的 dog|cat ，但 [a b] 仍将匹配字符 'a' 、 'b' 或空格。 此外，你还可以在正则中放置注释；注释从 # 字符扩展到下一个换行符。 当与三引号字符串一起使用时，这使正则的格式更加整齐:

pat = re.compile(r"""
 \s*                 # Skip leading whitespace
 (?P<header>[^:]+)   # Header name
 \s* :               # Whitespace, and a colon
 (?P<value>.*?)      # The header's value -- *? used to
                     # lose the following trailing whitespace
 \s*$                # Trailing whitespace to end-of-line
""", re.VERBOSE)

这更具有可读性:

pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")

反馈

正则表达式是一个复杂的主题。 这份文档是否有助于你理解它们？ 是否存在不清楚的部分，或者你遇到的问题未在此处涉及？ 如果是，请向作者发送改进建议。

关于正则表达式的最完整的书几乎肯定是由 O'Reilly 出版的 Jeffrey Friedl 的 Mastering Regular Expressions 。 不幸的是，它专注于 Perl 和 Java 的正则表达式，并且根本不包含任何 Python 材料，因此它不能用作 Python 编程的参考。 （第一版涵盖了 Python 现在删除的 regex 模块，这对你没有多大帮助。）考虑从你的图书馆中查找它。

套接字编程指南

作者

Gordon McMillan

摘要

套接字几乎无处不在，但是它却是被误解最严重的技术之一。这是一篇简单的套接字概述。并不是一篇真正的教程 —— 你需要做更多的事情才能让它工作起来。其中也并没有涵盖细节（细节会有很多），但是我希望它能提供足够的背景知识，让你像模像样的开始使用套接字

套接字

我将只讨论关于 INET（比如：IPv4 地址族）的套接字，但是它将覆盖几乎 99% 的套接字使用场景。并且我将仅讨论 STREAM（比如：TCP）类型的套接字 - 除非你真的知道你在做什么（那么这篇 HOWTO 可能并不适合你），使用 STREAM 类型的套接字将会得到比其它类型更好的表现与性能。我将尝试揭开套接字的神秘面纱，也会讲到一些阻塞与非阻塞套接字的使用。但是我将以阻塞套接字为起点开始讨论。只有你了解它是如何工作的以后才能处理非阻塞套接字。

理解这些东西的难点之一在于「套接字」可以表示很多微妙差异的东西，这取决于上下文。所以首先，让我们先分清楚「客户端」套接字和「服务端」套接字之间的不同，客户端套接字表示对话的一端，服务端套接字更像是总机接线员。客户端程序只能（比如：你的浏览器）使用「客户端」套接字；网络服务器则可以使用「服务端」套接字和「客户端」套接字来会话

历史

目前为止，在各种形式的 IPC 中，套接字是最流行的。在任何指定的平台上，可能会有其它更快的 IPC 形式，但是就跨平台通信来说，套接字大概是唯一的玩法

套接字作为 Unix 的 BSD 分支的一部分诞生于 Berkeley。 它们像野火一样在互联网上传播。 这是有充分理由的 --- 套接字与 INET 的结合让世界各地的任何机器之间的通信变得令人难以置信的简单（至少是与其他方案相比）。

创建套接字

简略地说，当你点击带你来到这个页面的链接时，你的浏览器就已经做了下面这几件事情:

# create an INET, STREAMing socket
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# now connect to the web server on port 80 - the normal http port
s.connect(("www.python.org", 80))

当连接完成，套接字可以用来发送请求来接收页面上显示的文字。同样是这个套接字也会用来读取响应，最后再被销毁。是的，被销毁了。客户端套接字通常用来做一次交换（或者说一小组序列的交换）。

网络服务器发生了什么这个问题就有点复杂了。首页，服务器创建一个「服务端套接字」:

# create an INET, STREAMing socket
serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# bind the socket to a public host, and a well-known port
serversocket.bind((socket.gethostname(), 80))
# become a server socket
serversocket.listen(5)

有几件事需要注意：我们使用了 socket.gethostname()，所以套接字将外网可见。如果我们使用的是 s.bind(('localhost', 80)) 或者 s.bind(('127.0.0.1', 80))，也会得到一个「服务端」套接字，但是后者只在同一机器上可见。s.bind(('', 80)) 则指定套接字可以被机器上的任何地址碰巧连接

第二个需要注点是：低端口号通常被一些「常用的」服务（HTTP, SNMP 等）所保留。如果你想把程序跑起来，最好使用一个高位端口号（通常是4位的数字）。

最后，listen 方法的参数会告诉套接字库，我们希望在队列中累积多达 5 个（通常的最大值）连接请求后再拒绝外部连接。 如果所有其他代码都准确无误，这个队列长度应该是足够的。

现在我们已经有一个「服务端」套接字，监听了 80 端口，我们可以进入网络服务器的主循环了:

while True:
    # accept connections from outside
    (clientsocket, address) = serversocket.accept()
    # now do something with the clientsocket
    # in this case, we'll pretend this is a threaded server
    ct = client_thread(clientsocket)
    ct.run()

事际上，通常有 3 种方法可以让这个循环工作起来 - 调度一个线程来处理 客户端套接字，或者把这个应用改成使用非阻塞模式套接字，亦或是使用 select 库来实现「服务端」套接字与任意活动 客户端套接字 之间的多路复用。稍后会详细介绍。现在最重要的是理解：这就是一个 服务端 套接字做的 所有 事情。它并没有发送任何数据。也没有接收任何数据。它只创建「客户端」套接字。每个 客户端套接字 都是为了响应某些其它客户端套接字 connect() 到我们绑定的主机。一旦创建 客户端套接字 完成，就会返回并监听更多的连接请求。现个客户端可以随意通信 - 它们使用了一些动态分配的端口，会话结束时端口才会被回收

进程间通信

如果你需要在同一台机器上进行两个进程间的快速 IPC 通信，你应该了解管道或者共享内存。如果你决定使用 AF_INET 类型的套接字，绑定「服务端」套接字到 'localhost' 。在大多数平台，这将会使用一个许多网络层间的通用快捷方式（本地回环地址）并且速度会快很多

参见

multiprocessing 模块使跨平台 IPC 通信成为一个高层的 API

使用一个套接字

首先需要注意，浏览器的「客户端」套接字和网络服务器的「客户端」套接字是极为相似的。即这种会话是「点对点」的。或者也可以说 你作为设计师需要自行决定会话的规则和礼节 。通常情况下，连接 套接字通过发送一个请求或者信号来开始一次会话。但这属于设计决定，并不是套接字规则。

现在有两组用于通信的动词。你可以使用 send 和 recv ，或者你可以把客户端套接字改成文件类型的形式来使用 read 和 write 方法。后者是 Java 语言中表示套接字的方法，我将不会在这儿讨论这个，但是要提醒你需要调用套接字的 flush 方法。这些是“缓冲”的文件，一个经常出现的错误是 write 一些东西，然后就直接开始 read 一个响应。如果不调用 flush ，你可能会一直等待这个响应，因为请求可能还在你的输出缓冲中。

现在我来到了套接字的两个主要的绊脚石 - send 和 recv 操作网络缓冲区。它们并不一定可以处理所有你想要（期望）的字节，因为它们主要关注点是处理网络缓冲。通常，它们在关联的网络缓冲区 send 或者清空 recv 时返回。然后告诉你处理了多少个字节。你 的责任是一直调用它们直到你所有的消息处理完成。

当 recv 方法返回 0 字节时，就表示另一端已经关闭（或者它所在的进程关闭）了连接。你再也不能从这个连接上获取到任何数据了。你可以成功的发送数据；我将在后面讨论这一点。

像 HTTP 这样的协议只使用一个套接字进行一次传输。客户端发送一个请求，然后读取响应。就这么简单。套接字会被销毁。 表示客户端可以通过接收 0 字节序列表示检测到响应的结束。

但是如果你打算在随后来的传输中复用套接字的话，你需要明白 套接字里面是不存在 :abbr:`EOT (传输结束)` 的。重复一下：套接字 send 或者 recv 完 0 字节后返回，连接会中断。如果连接没有被断开，你可能会永远处于等待 recv 的状态，因为（就目前来说）套接字 不会 告诉你不用再读取了。现在如果你细心一点，你可能会意识到套接字基本事实：消息必须要么具有固定长度，要么可以界定，要么指定了长度（比较好的做法），要么以关闭连接为结束。选择完全由你而定（这比让别人定更合理）。

假定你不希望结束连接，那么最简单的解决方案就是使用定长消息:

class MySocket:
    """demonstration class only
      - coded for clarity, not efficiency
    """

    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'':
                raise RuntimeError("socket connection broken")
            chunks.append(chunk)
            bytes_recd = bytes_recd + len(chunk)
        return b''.join(chunks)

发送分部代码几乎可用于任何消息传递方案 —— 在 Python 中你发送字符串，可以使用 len() 方法来确定它的长度（即使它嵌入了 \0 字符），主要是接收代码变得更复杂。（在 C 语言中，并没有更糟糕，除非消息嵌入了 \0 字符而且你又无法使用 strlen ）

最简单的改进是让消息的第一个字符表示消息类型，由类型决定长度。现在你需要两次 recv- 第一次取（至少）第一个字符来知晓长度，第二次在循环中获取剩余所有的消息。如果你决定到分界线，你将收到一些任意大小的块，（4096 或者 8192 通常是比较合适的网络缓冲区大小），扫描你接收到的分界符

一个需要意识到的复杂情况是：如果你的会话协议允许多个消息被发送回来（没有响应），调用 recv 传入任意大小的块，你可能会因为读到后续接收的消息而停止读取。你需要将它放在一边并保存，直到它需要为止。

以其长度（例如，作为5个数字字符）作为消息前缀时会变得更复杂，因为（信不信由你）你可能无法在一个 recv 中获得所有5个字符。在一般使用时，你会侥幸避免该状况；但是在高网络负载中，除非你使用两个 recv 循环，否则你的代码将很快中断 —— 第一个用于确定长度，第二个用于获取消息的数据部分。这很讨厌。当你发现 send 并不总是设法在支持搞定一切时，你也会有这种感觉。 尽管已经阅读过这篇文章，但最终还是会有所了解！

限于篇幅，建立你的角色，（保持与我的竞争位置），这些改进将留给读者做为练习。现在让我们继续。

二进制数据

通过套接字发送二进制数据是完全可能的。主要问题是，并非所有机器都使用相同的二进制数据格式。例如，网络字节顺序 [https://en.wikipedia.org/wiki/Endianness#Networking] 是大端序的，最大的字节在前，所以一个值为 1 的16位整数将是两个十六进制字节 00 01 。然而，大多数常见的处理器（ x86 / AMD64 ，ARM，RISC-V）是小端序的，最小的字节在前 -- 同样的 1 将是 01 00 。

Socket 库有转换 16 位和 32 位整数的调用 - ntohl, htonl, ntohs, htons ，其中 "n" 表示 网络 ， "h" 表示 主机 ， "s" 表示 short ， "l" 表示 long 。当网络顺序与主机顺序相同时，这些调用不做任何事情，但当机器的字节序相反时，这些调用会适当地交换字节。

在现今的 64 位机器中，二进制数据的 ASCII 表示往往比二进制表示要小。这是因为在非常多的时候所大部分整数的值均为 0 或者 1。字符串形式的 "0" 为两个字节，而一个完整的 64 位整数将是八个。当然这不适用于固定长度的信息。自行决定，请自行决定。

断开连接

严格地讲，你应该在 close 它之前将套接字 shutdown 。 shutdown 是发送给套接字另一端的一种建议。调用时参数不同意义也不一样，它可能意味着「我不会再发送了，但我仍然会监听」，或者「我没有监听了，真棒！」。然而，大多数套接字库或者程序员都习惯了忽略使用这种礼节，因为通常情况下 close 与 shutdown(); close() 是一样的。所以在大多数情况下，不需要显式的 shutdown 。

高效使用 shutdown 的一种方法是在类似 HTTP 的交换中。客户端发送请求，然后执行 shutdown(1) 。 这告诉服务器“此客户端已完成发送，但仍可以接收”。服务器可以通过接收 0 字节来检测 “EOF” 。它可以假设它有完整的请求。服务器发送回复。如果 send 成功完成，那么客户端仍在接收。

Python 进一步自动关闭，并说当一个套接字被垃圾收集时，如果需要它会自动执行 close 。但依靠这个机制是一个非常坏的习惯。如果你的套接字在没有 close 的情况下就消失了，那么另一端的套接字可能会无限期地挂起，以为你只是慢了一步。完成后 请 close 你的套接字。

套接字何时销毁

使用阻塞套接字最糟糕的事情可能就是当另一边下线时（没有 close ）会发生什么。你的套接字可能会挂起。 TCP 是一种可靠的协议，它会在放弃连接之前等待很长时间。如果你正在使用线程，那么整个线程基本上已经死了。你无能为力。只要你没有做一些愚蠢的事情，比如在进行阻塞读取时持有一个锁，那么线程并没有真正消耗掉资源。 不要 尝试杀死线程 —— 线程比进程更有效的部分原因是它们避免了与自动回收资源相关的开销。换句话说，如果你设法杀死线程，你的整个进程很可能被搞坏。

非阻塞的套接字

如果你已理解上述内容，那么你已经了解了使用套接字的机制所需了解的大部分内容。你仍将以相同的方式使用相同的函数调用。 只是，如果你做得对，你的应用程序几乎是由内到外的。

在 Python 中是使用 socket.setblocking(False) 来设置非阻塞。 在 C 中的做法更为复杂（例如，你需要在 BSD 风格的 O_NONBLOCK 和几乎无区别的 POSIX 风格的 O_NDELAY 之间作出选择，这与 TCP_NODELAY 完全不一样），但其思路实际上是相同的。 你要在创建套接字之后但在使用它之前执行此操作。 （实际上，如果你是疯子的话也可以反复进行切换。）

主要的机制差异是 send 、 recv 、 connect 和 accept 可以在没有做任何事情的情况下返回。 你（当然）有很多选择。你可以检查返回代码和错误代码，通常会让自己发疯。如果你不相信我，请尝试一下。你的应用程序将变得越来越大、越来越 Bug 、吸干 CPU。因此，让我们跳过脑死亡的解决方案并做正确的事。

使用 select 库

在 C 中，编码 select 相当复杂。 在 Python 中，它是很简单，但它与 C 版本足够接近，如果你在 Python 中理解 select ，那么在 C 中你会几乎不会遇到麻烦:

ready_to_read, ready_to_write, in_error = \
               select.select(
                  potential_readers,
                  potential_writers,
                  potential_errs,
                  timeout)

你传递给 select 三个列表：第一个包含你可能想要尝试读取的所有套接字；第二个是你可能想要尝试写入的所有套接字，以及要检查错误的最后一个（通常为空）。你应该注意，套接字可以进入多个列表。 select 调用是阻塞的，但你可以给它一个超时。这通常是一件明智的事情 —— 给它一个很长的超时（比如一分钟），除非你有充分的理由不这样做。

作为返回，你将获得三个列表。它们包含实际可读、可写和有错误的套接字。 这些列表中的每一个都是你传入的相应列表的子集（可能为空）。

如果一个套接字在输出可读列表中，那么你可以像我们一样接近这个业务，那个套接字上的 recv 将返回 一些内容 。可写列表的也相同，你将能够发送 一些内容 。 也许不是你想要的全部，但 有些东西 比没有东西更好。 （实际上，任何合理健康的套接字都将以可写方式返回 —— 它只是意味着出站网络缓冲区空间可用。）

如果你有一个“服务器”套接字，请将其放在 potential_readers 列表中。如果它出现在可读列表中，那么你的 accept （几乎肯定）会起作用。如果你已经创建了一个新的套接字 connect 其他人，请将它放在 potential_writers 列表中。如果它出现在可写列表中，那么它有可能已连接。

实际上，即使使用阻塞套接字， select 也很方便。这是确定是否阻塞的一种方法 —— 当缓冲区中存在某些内容时，套接字返回为可读。然而，这仍然无助于确定另一端是否完成或者只是忙于其他事情的问题。

可移植性警告 ：在 Unix 上， select 适用于套接字和文件。 不要在 Windows 上尝试。在 Windows 上， select 仅适用于套接字。另请注意，在 C 中，许多更高级的套接字选项在 Windows 上的执行方式不同。事实上，在 Windows 上我通常在使用我的套接字使用线程（非常非常好）。

排序指南

作者

Andrew Dalke 与 Raymond Hettinger

发布版本

0.1

内置列表方法 list.sort() 原地修改列表，而内置函数 sorted() 由可迭代对象新建有序列表。

在本文档中，我们将探索使用 Python 对数据进行排序的各种技术。

排序的基础知识

普通的升序排序非常容易：只需调用 sorted() 函数。它返回新有序列表：

>>> sorted([5, 2, 3, 1, 4])
[1, 2, 3, 4, 5]

亦可用 list.sort() 方法。它原地修改原列表（并返回 None 以避免混淆）。往往不如 sorted() 方便——但若不需原列表，用它会略高效些。

>>> a = [5, 2, 3, 1, 4]
>>> a.sort()
>>> a
[1, 2, 3, 4, 5]

另一个区别是 list.sort() 方法只为列表定义，而 sorted() 函数接受任何可迭代对象。

>>> sorted({1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'})
[1, 2, 3, 4, 5]

键函数

list.sort() 和 sorted() 皆有 key 形参用以指定在比较前要对每个列表元素调用的函数（或其它可调用对象）。

例如，这是个不区分大小写的字符串比较：

>>> sorted("This is a test string from Andrew".split(), key=str.lower)
['a', 'Andrew', 'from', 'is', 'string', 'test', 'This']

key 形参的值需为一元函数（或其它可调用对象），其返回值用于排序。这很快，因为键函数只需在输入的每个记录上调用恰好一次。

常见的模式是用对象的某一些索引作为键对复杂对象排序。例如：

>>> student_tuples = [
...     ('john', 'A', 15),
...     ('jane', 'B', 12),
...     ('dave', 'B', 10),
... ]
>>> sorted(student_tuples, key=lambda student: student[2])   # sort by age
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

同样的方法对于有具名属性的对象也适用。例如：

>>> 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)   # sort by age
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

Operator 模块函数

上面显示的键函数模式非常常见，因此 Python 提供了便利功能，使访问器功能更容易，更快捷。 operator 模块有 itemgetter() 、 attrgetter() 和 methodcaller() 函数。

用了那些函数之后，前面的示例变得更简单，运行起来也更快：

>>> 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)]

运算符模块的函数可以用来作多级排序。例如，按 grade 排序，然后按 age 排序：

>>> 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)]

升序与降序

list.sort() 和 sorted() 接受布尔形参 reverse 用于标记降序排序。例如，将学生数据按 age 倒序排序：

>>> 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)]

排序稳定性与复杂排序

排序保证 稳定 [https://en.wikipedia.org/wiki/Sorting_algorithm#Stability]：等键记录保持原始顺序。

>>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
>>> sorted(data, key=itemgetter(0))
[('blue', 1), ('blue', 2), ('red', 1), ('red', 2)]

注意 blue 的两个记录是如何保序的：('blue', 1) 保证先于 ('blue', 2)。

这个了不起的特性使得借助一系列排序步骤构建出复杂排序成为可能。例如，要按 grade 降序后 age 升序排序学生数据，只需先用 age 排序再用 grade 排序即可：

>>> s = sorted(student_objects, key=attrgetter('age'))     # sort on secondary key
>>> sorted(s, key=attrgetter('grade'), reverse=True)       # now sort on primary key, descending
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

可抽象为包装函数，依据接收的一些字段序的元组对接收的列表做多趟排序。

>>> 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)]

Python 中曾用的 Timsort [https://en.wikipedia.org/wiki/Timsort] 算法借助数据集中任何已有的有序性来高效进行多种排序。

使用装饰-排序-去装饰的旧方法

装饰-排序-去装饰 (Decorate-Sort-Undecorate) 得名于它的三个步骤：

首先，用控制排序顺序的新值装饰初始列表。

其次，排序装饰后的列表。

最后，去除装饰即得按新顺序排列的初始值的列表。

例如，用 DSU 方法按 grade 排序学生数据：

>>> decorated = [(student.grade, i, student) for i, student in enumerate(student_objects)]
>>> decorated.sort()
>>> [student for grade, i, student in decorated]               # undecorate
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]

这方法语有效是因为元组按字典顺序进行比较，先比较第一项；如果它们相同则比较第二个项目，依此类推。

不一定在所有情况下都要在装饰列表中包含索引 i ，但包含它有两个好处：

排序是稳定的——如果两个项具有相同的键，它们的顺序将保留在排序列表中。

原始项目不必具有可比性，因为装饰元组的排序最多由前两项决定。 因此，例如原始列表可能包含无法直接排序的复数。

这个方法的另一个名字是 Randal L. Schwartz 在 Perl 程序员中推广的 Schwartzian transform [https://en.wikipedia.org/wiki/Schwartzian_transform]。

既然 Python 排序提供了键函数，那么通常不需要这种技术。

使用 cmp 参数的旧方法

本 HOWTO 中给出的许多结构都假定为 Python 2.4 或更高版本。在此之前，没有内置 sorted() ， list.sort() 也没有关键字参数。相反，所有 Py2.x 版本都支持 cmp 参数来处理用户指定的比较函数。

在 Py3.0 中， cmp 参数被完全删除（作为简化和统一语言努力的一部分，消除了丰富的比较与 __cmp__() 魔术方法之间的冲突）。

在 Py2.x 中， sort 允许一个可选函数，可以调用它来进行比较。该函数应该采用两个参数进行比较，然后返回负值为小于，如果它们相等则返回零，或者返回大于大于的正值。例如，我们可以这样做：

>>> def numeric_compare(x, y):
...     return x - y
>>> sorted([5, 2, 4, 1, 3], cmp=numeric_compare)
[1, 2, 3, 4, 5]

或者你可反转比较的顺序：

>>> def reverse_numeric(x, y):
...     return y - x
>>> sorted([5, 2, 4, 1, 3], cmp=reverse_numeric)
[5, 4, 3, 2, 1]

在将代码从 Python 2.x 移植到 3.x 时，如果让用户提供比较函数并且需要将其转换为键函数则会出现这种情况。 以下包装器使得做到这点变得很容易。

def cmp_to_key(mycmp):
    'Convert a cmp= function into a key= function'
    class K:
        def __init__(self, obj, *args):
            self.obj = obj
        def __lt__(self, other):
            return mycmp(self.obj, other.obj) < 0
        def __gt__(self, other):
            return mycmp(self.obj, other.obj) > 0
        def __eq__(self, other):
            return mycmp(self.obj, other.obj) == 0
        def __le__(self, other):
            return mycmp(self.obj, other.obj) <= 0
        def __ge__(self, other):
            return mycmp(self.obj, other.obj) >= 0
        def __ne__(self, other):
            return mycmp(self.obj, other.obj) != 0
    return K

要转换为键函数，只需包装旧的比较函数：

>>> sorted([5, 2, 4, 1, 3], key=cmp_to_key(reverse_numeric))
[5, 4, 3, 2, 1]

在 Python 3.2 中， functools.cmp_to_key() 函数被添加到标准库中的 functools 模块中。

其它

对于区域相关的排序，请使用 locale.strxfrm() 作为键函数，或者 locale.strcoll() 作为比较函数。

reverse 参数仍然保持排序稳定性（因此具有相等键的记录保留原始顺序）。 有趣的是，通过使用内置的 reversed() 函数两次，可以在没有参数的情况下模拟该效果：

>>> 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)]

在对两个对象进行比较时，排序例程使用 < 。因此，通过定义一个 __lt__() 方法，很容易为一个类添加一个标准的排序顺序。

>>> Student.__lt__ = lambda self, other: self.age < other.age
>>> sorted(student_objects)
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

然而，请注意，如果 __gt__() 没有实现，< 可以退回到使用 __lt__() （见 object.__lt__() ）。

键函数不需要直接依赖于被排序的对象。键函数还可以访问外部资源。例如，如果学生成绩存储在字典中，则可以使用它们对单独的学生姓名列表进行排序：

>>> students = ['dave', 'john', 'jane']
>>> newgrades = {'john': 'F', 'jane':'A', 'dave': 'C'}
>>> sorted(students, key=newgrades.__getitem__)
['jane', 'dave', 'john']

Unicode 指南

发布版本

1.12

本文介绍了 Python 对表示文本数据的 Unicode 规范的支持，并对各种 Unicode 常见使用问题做了解释。

Unicode 概述

定义

如今的程序需要能够处理各种各样的字符。应用程序通常做了国际化处理，用户可以选择不同的语言显示信息和输出数据。同一个程序可能需要以英语、法语、日语、希伯来语或俄语输出错误信息。网页内容可能由这些语言书写，并且可能包含不同的表情符号。Python 的字符串类型采用 Unicode 标准来表示字符，使得 Python 程序能够正常处理所有这些不同的字符。

Unicode 规范（https://www.unicode.org/）旨在罗列人类语言所用到的所有字符，并赋予每个字符唯一的编码。该规范一直在进行修订和更新，不断加入新的语种和符号。

一个 字符 是文本的最小组件。‘A’、‘B’、‘C’ 等都是不同的字符。‘È’ 和 ‘Í’ 也一样。字符会随着语言或者上下文的变化而变化。比如，‘Ⅰ’ 是一个表示 “罗马数字 1” 的字符，它与大写字母 ‘I’ 不同。他们往往看起来相同，但这是两个有着不同含义的字符。

Unicode 标准描述了字符是如何用 码位（code point） 表示的。码位的取值范围是 0 到 0x10FFFF 的整数（大约 110 万个值，实际分配的数字 [https://www.unicode.org/versions/latest/#Summary] 没有那么多）。在 Unicode 标准和本文中，码位采用 U+265E 的形式，表示值为 0x265e 的字符（十进制为 9822）。

Unicode 标准中包含了许多表格，列出了很多字符及其对应的码位。

0061    'a'; LATIN SMALL LETTER A
0062    'b'; LATIN SMALL LETTER B
0063    'c'; LATIN SMALL LETTER C
...
007B    '{'; LEFT CURLY BRACKET
...
2167    'Ⅷ'; ROMAN NUMERAL EIGHT
2168    'Ⅸ'; ROMAN NUMERAL NINE
...
265E    '♞'; BLACK CHESS KNIGHT
265F    '♟'; BLACK CHESS PAWN
...
1F600   '😀'; GRINNING FACE
1F609   '😉'; WINKING FACE
...

严格地说，上述定义暗示了以下说法是没有意义的：“这是字符 U+265E”。U+265E 只是一个码位，代表某个特定的字符；这里它代表了字符 “国际象棋黑骑士” '♞'。在非正式的上下文中，有时会忽略码位和字符的区别。

一个字符在屏幕或纸上被表示为一组图形元素，被称为 字形（glyph） 。比如，大写字母 A 的字形，是两笔斜线和一笔横线，而具体的细节取决于所使用的字体。大部分 Python 代码不必担心字形，找到正确的显示字形通常是交给 GUI 工具包或终端的字体渲染程序来完成。

编码

上一段可以归结为：一个 Unicode 字符串是一系列码位（从 0 到 0x10FFFF 或者说十进制的 1,114,111 的数字）组成的序列。这一序列在内存中需被表示为一组 码元（code unit） ， 码元 会映射成包含八个二进制位的字节。将 Unicode 字符串翻译成字节序列的规则称为 字符编码 ，或者 编码 。

大家首先会想到的编码可能是用 32 位的整数作为代码位，然后采用 CPU 对 32 位整数的表示法。字符串 “Python” 用这种表示法可能会如下所示：

   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

这种表示法非常直白，但也存在 一些问题。

不具可移植性；不同的处理器的字节序不同。

非常浪费空间。 在大多数文本中，大部分码位都小于 127 或 255，因此字节 0x00 占用了大量空间。相较于 ASCII 表示法所需的 6 个字节，以上字符串需要占用 24 个字节。RAM 用量的增加没那么要紧（台式计算机有成 GB 的 RAM，而字符串通常不会有那么大），但要把磁盘和网络带宽的用量增加 4 倍是无法忍受的。

与现有的 C 函数（如 strlen() ）不兼容，因此需要采用一套新的宽字符串函数。

因此这种编码用得不多，人们转而选择其他更高效、更方便的编码，比如 UTF-8。

UTF-8 是最常用的编码之一，Python 往往默认会采用它。UTF 代表“Unicode Transformation Format”，'8' 表示编码采用 8 位数。（UTF-16 和 UTF-32 编码也是存在的，但其使用频率不如 UTF-8。）UTF-8 的规则如下：

如果码位 < 128，则直接用对应的字节值表示。

如果码位 >= 128，则转换为 2、3、4 个字节的序列，每个字节值都位于 128 和 255 之间。

UTF-8 有几个很方便的特性：

可以处理任何 Unicode 码位。

Unicode 字符串被转换为一个字节序列，仅在表示空（null ）字符（U+0000）时才会包含零值的字节。这意味着 strcpy() 之类的C 函数可以处理 UTF-8 字符串，而且用那些不能处理字符串结束符之外的零值字节的协议也能发送。

ASCII 字符串也是也是也是合法的 UTF-8 文本。

UTF-8 相当紧凑；大多数常用字符均可用一两个字节表示。

如果字节数据被损坏或丢失，则可以找出下一个 UTF-8 码点的开始位置并重新开始同步。随机的 8 位数据也不太可能像是有效的 UTF-8 编码。

UTF-8 是一种面向字节的编码。编码规定了每个字符由一个或多个字节的序列表示。这避免了整数和双字节编码（如 UTF-16 和 UTF-32）可能出现的字节顺序问题，那时的字节序列会因执行编码的硬件而异。

参考文献

Unicode Consortium 站点 [https://www.unicode.org] 包含 Unicode 规范的字符图表、词汇表和 PDF 版本。请做好准备，有些内容读起来有点难度。该网站上还提供了 Unicode 起源和发展的 年表 [https://www.unicode.org/history/] 。

在 Computerphile 的 Youtube 频道上，Tom Scott 简要地 讨论了 Unicode 和 UTF-8 [https://www.youtube.com/watch?v=MijmeoH9LT4] （9 分 36 秒）的历史。

为了帮助理解该标准，Jukka Korpela 编写了阅读 Unicode 字符表的 介绍性指南 [https://jkorpela.fi/unicode/guide.html] 。

Joel Spolsky 撰写了另一篇不错的介绍性文章 <https://www.joelonsoftware.com/2003/10/08/the-absolute-minimum-every-software-developer-absolutely-positively-must-know-about-unicode-and-character- set-no-excuses/>`_ 。如果本文没让您弄清楚，那应在继续之前先试着读读这篇文章。

Wikipedia 条目通常也有帮助；请参阅“字符编码 [https://en.wikipedia.org/wiki/Character_encoding]”和 UTF-8 [https://en.wikipedia.org/wiki/UTF-8] 的条目，例如：

Python对Unicode的支持

现在您已经了解了 Unicode 的基础知识，可以看下 Python 的 Unicode 特性。

字符串类型

从 Python 3.0 开始， str 类型包含了 Unicode 字符，这意味着用 "unicode rocks!"、'unicode rocks!' 或三重引号字符串语法创建的任何字符串都会存储为 Unicode。

Python 源代码的默认编码是 UTF-8，因此可以直接在字符串中包含 Unicode 字符：

try:
    with open('/tmp/input.txt', 'r') as f:
        ...
except OSError:
    # 'File not found' error message.
    print("Fichier non trouvé")

旁注：Python 3 还支持在标识符中使用 Unicode 字符：

répertoire = "/tmp/records.log"
with open(répertoire, "w") as f:
    f.write("test\n")

如果无法在编辑器中输入某个字符，或出于某种原因想只保留 ASCII 编码的源代码，则还可以在字符串中使用转义序列。（根据系统的不同，可能会看到真的大写 Delta 字体而不是 u 转义符。）：

>>> "\N{GREEK CAPITAL LETTER DELTA}"  # Using the character name
'\u0394'
>>> "\u0394"                          # Using a 16-bit hex value
'\u0394'
>>> "\U00000394"                      # Using a 32-bit hex value
'\u0394'

此外，可以用 bytes 的 decode() 方法创建一个字符串。 该方法可以接受 encoding 参数，比如可以为 UTF-8 ，以及可选的 errors 参数。

若无法根据编码规则对输入字符串进行编码，errors 参数指定了响应策略。 该参数的合法值可以是 'strict' (触发 UnicodeDecodeError 异常)、'replace' (用 U+FFFD、REPLACEMENT CHARACTER)、'ignore' (只是将字符从 Unicode 结果中去掉)，或 'backslashreplace' (插入一个 \xNN 转义序列)。 以下示例演示了这些不同的参数:

>>> 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'

编码格式以包含编码格式名称的字符串来指明。 Python 有大约 100 种不同的编码格式；清单详见 Python 库参考文档 标准编码。 一些编码格式有多个名称，比如 'latin-1'、'iso_8859_1' 和 '8859 都是指同一种编码。

利用内置函数 chr() 还可以创建单字符的 Unicode 字符串，该函数可接受整数参数，并返回包含对应码位的长度为 1 的 Unicode 字符串。内置函数 ord() 是其逆操作，参数为单个字符的 Unicode 字符串，并返回码位值：

>>> chr(57344)
'\ue000'
>>> ord('\ue000')
57344

转换为字节

bytes.decode() 的逆方法是 str.encode() ，它会返回 Unicode 字符串的 bytes 形式，已按要求的 encoding 进行了编码。

参数 errors 的意义与 decode() 方法相同，但支持更多可能的handler。除了 'strict' 、 'ignore' 和 'replace' （这时会插入问号替换掉无法编码的字符），还有 'xmlcharrefreplace' （插入一个 XML 字符引用）、 backslashreplace （插入一个 \uNNNN 转义序列）和 namereplace （插入一个 \N{...} 转义序列 ）。

以下例子演示了各种不同的结果：

>>> 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'

用于注册和访问可用编码格式的底层函数，位于 codecs 模块中。 若要实现新的编码格式，则还需要了解 codecs 模块。 不过该模块返回的编码和解码函数通常更为底层一些，不大好用，编写新的编码格式是一项专业的任务，因此本文不会涉及该模块。

Python 源代码中的 Unicode 文字

在 Python 源代码中，可以用 \u 转义序列书写特定的 Unicode 码位，该序列后跟 4 个代表码位的十六进制数字。\U 转义序列用法类似，但要用8 个十六进制数字，而不是 4 个：

>>> s = "a\xac\u1234\u20ac\U00008000"
... #     ^^^^ two-digit hex escape
... #         ^^^^^^ four-digit Unicode escape
... #                     ^^^^^^^^^^ eight-digit Unicode escape
>>> [ord(c) for c in s]
[97, 172, 4660, 8364, 32768]

对大于 127 的码位使用转义序列，数量不多时没什么问题，但如果要用到很多重音字符，这会变得很烦人，类似于程序中的信息是用法语或其他使用重音的语言写的。也可以用内置函数 chr() 拼装字符串，但会更加乏味。

理想情况下，都希望能用母语的编码书写文本。还能用喜好的编辑器编辑 Python 源代码，编辑器要能自然地显示重音符，并在运行时使用正确的字符。

默认情况下，Python 支持以 UTF-8 格式编写源代码，但如果声明要用的编码，则几乎可以使用任何编码。只要在源文件的第一行或第二行包含一个特殊注释即可：

#!/usr/bin/env python
# -*- coding: latin-1 -*-

u = 'abcdé'
print(ord(u[-1]))

上述语法的灵感来自于 Emacs 用于指定文件局部变量的符号。Emacs 支持许多不同的变量，但 Python 仅支持“编码”。 -*- 符号向 Emacs 标明该注释是特殊的；这对 Python 没有什么意义，只是一种约定。Python 会在注释中查找 coding: name 或 coding=name 。

如果没有这种注释，则默认编码将会是前面提到的 UTF-8。更多信息请参阅 PEP 263 [https://www.python.org/dev/peps/pep-0263] 。

Unicode属性

Unicode 规范包含了一个码位信息数据库。对于定义的每一个码位，都包含了字符的名称、类别、数值（对于表示数字概念的字符，如罗马数字、分数如三分之一和五分之四等）。还有有关显示的属性，比如如何在双向文本中使用码位。

以下程序显示了几个字符的信息，并打印一个字符的数值：

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))

# Get numeric value of second character
print(unicodedata.numeric(u[1]))

当运行时，这将打印出：

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

类别代码是描述字符性质的一个缩写。分为“字母”、“数字”、“标点符号”或“符号”等类别，而这些类别又分为子类别。就以上输出的代码而言，'Ll' 表示“字母，小写”，'No' 表示“数字，其他”，'Mn' 表示“标记，非空白符” , 'So' 是“符号，其他”。有关类别代码的清单，请参阅 Unicode 字符库文档 [https://www.unicode.org/reports/tr44/#General_Category_Values] 的“通用类别值”部分。

字符串比较

Unicode 让字符串的比较变得复杂了一些，因为同一组字符可能由不同的码位序列组成。例如，像“ê”这样的字母可以表示为单码位 U+00EA，或是 U+0065 U+0302，即“e”的码位后跟“COMBINING CIRCUMFLEX ACCENT”的码位。虽然在打印时会产生同样的输出，但一个是长度为 1 的字符串，另一个是长度为 2 的字符串。

一种不区分大小写比较的工具是字符串方法 casefold() ，将按照 Unicode 标准描述的算法将字符串转换为不区分大小写的形式。该算法对诸如德语字母“ß”（代码点 U+00DF）之类的字符进行了特殊处理，变为一对小写字母“ss”。

>>> street = 'Gürzenichstraße'
>>> street.casefold()
'gürzenichstrasse'

第二个工具是 unicodedata 模块的 normalize() 函数，将字符串转换为几种规范化形式之一，其中后跟组合字符的字母将被替换为单个字符。 normalize() 可用于执行字符串比较，即便两个字符串采用不同的字符组合，也不会错误地报告两者不相等：

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))

当运行时，这将输出：

$ python3 compare-strs.py
length of first string= 1
length of second string= 2
True

normalize() 函数的第一个参数是个字符串，给出所需的规范化形式，可以是“NFC”、“NFKC”、“NFD”和“NFKD”之一。

Unicode 标准还设定了如何进行不区分大小写的比较：

import unicodedata

def compare_caseless(s1, s2):
    def NFD(s):
        return unicodedata.normalize('NFD', s)

    return NFD(NFD(s1).casefold()) == NFD(NFD(s2).casefold())

# Example usage
single_char = 'ê'
multiple_chars = '\N{LATIN CAPITAL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}'

print(compare_caseless(single_char, multiple_chars))

这将打印 True 。（为什么 NFD() 会被调用两次？因为有几个字符让 casefold() 返回非规范化的字符串，所以结果需要再次进行规范化。参见 Unicode 标准的 3.13 节 的一个讨论和示例。）

Unicode 正则表达式

re 模块支持的正则表达式可以用字节串或字符串的形式提供。有一些特殊字符序列，比如 \d 和 \w 具有不同的含义，具体取决于匹配模式是以字节串还是字符串形式提供的。例如，\d 将匹配字节串中的字符 [0-9] ，但对于字符串将会匹配 'Nd' 类别中的任何字符。

上述示例中的字符串包含了泰语和阿拉伯数字书写的数字 57：

import re
p = re.compile(r'\d+')

s = "Over \u0e55\u0e57 57 flavours"
m = p.search(s)
print(repr(m.group()))

执行时，\d+ 将匹配上泰语数字并打印出来。如果向 compile() 提供的是 re.ASCII 标志，\d+ 则会匹配子串 "57"。

类似地，\w 将匹配多种 Unicode 字符，但对于字节串则只会匹配 [a-zA-Z0-9_] ，如果指定 re.ASCII ， \s 将匹配 Unicode 空白符或 [ \t\n\r\f\v] 。

参考文献

关于 Python 的 Unicode 支持，其他还有一些很好的讨论：

用 Python 3 处理文本文件 [https://python-notes.curiousefficiency.org/en/latest/python3/text_file_processing.html] ，作者 Nick Coghlan。

实用的 Unicode [https://nedbatchelder.com/text/unipain.html]，Ned Batchelder 在 PyCon 2012 上的演示。

str 类型在 Python 库参考文档 文本序列类型 --- str 中有介绍。

unicodedata 模块的文档

codecs 模块的文档

Marc-André Lemburg 在 EuroPython 2002 上做了一个题为“Python 和 Unicode”（PDF 幻灯片）<https://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf>`_ 的演示文稿。该幻灯片很好地概括了 Python 2 的 Unicode 功能设计（其中 Unicode 字符串类型称为 unicode，文字以 u 开头）。

Unicode 数据的读写

既然处理 Unicode 数据的代码写好了，下一个问题就是输入/输出了。如何将 Unicode 字符串读入程序，如何将 Unicode 转换为适于存储或传输的形式呢？

根据输入源和输出目标的不同，或许什么都不用干；请检查一下应用程序用到的库是否原生支持 Unicode。例如，XML 解析器往往会返回 Unicode 数据。许多关系数据库的字段也支持 Unicode 值，并且 SQL 查询也能返回 Unicode 值。

在写入磁盘或通过套接字发送之前，Unicode 数据通常要转换为特定的编码。可以自己完成所有工作：打开一个文件，从中读取一个 8 位字节对象，然后用 bytes.decode(encoding) 对字节串进行转换。但是，不推荐采用这种全人工的方案。

编码的多字节特性就是一个难题； 一个 Unicode 字符可以用几个字节表示。 如果要以任意大小的块（例如 1024 或 4096 字节）读取文件，那么在块的末尾可能只读到某个 Unicode 字符的部分字节，这就需要编写错误处理代码。 有一种解决方案是将整个文件读入内存，然后进行解码，但这样就没法处理很大的文件了；若要读取 2 GB 的文件，就需要 2 GB 的 RAM。（其实需要的内存会更多些，因为至少有一段时间需要在内存中同时存放已编码字符串及其 Unicode 版本。）

解决方案是利用底层解码接口去捕获编码序列不完整的情况。这部分代码已经是现成的：内置函数 open() 可以返回一个文件类的对象，该对象认为文件的内容采用指定的编码，read() 和 write() 等方法接受 Unicode 参数。只要用 open() 的 encoding 和 errors 参数即可，参数释义同 str.encode() 和 bytes.decode() 。

因此从文件读取 Unicode 就比较简单了：

with open('unicode.txt', encoding='utf-8') as f:
    for line in f:
        print(repr(line))

也可以在更新模式下打开文件，以便同时读取和写入：

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]))

Unicode 字符 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”编解码器自动忽略此标记。

Unicode 文件名

当今大多数操作系统都支持包含任意 Unicode 字符的文件名。 通常这是通过将 Unicode 字符串转换为某种根据具体系统而定的编码格式来实现的。 如今的 Python 倾向于使用 UTF-8：MacOS 上的 Python 已经在多个版本中使用了 UTF-8，而 Python 3.6 也已在 Windows 上改用了 UTF-8。 在 Unix 系统中，将只有一个 文件系统编码格式。 如果你已设置了 LANG 或 LC_CTYPE 环境变量的话；如果未设置，则默认编码格式还是 UTF-8。

sys.getfilesystemencoding() 函数将返回要在当前系统采用的编码，若想手动进行编码时即可用到，但无需多虑。在打开文件进行读写时，通常只需提供 Unicode 字符串作为文件名，会自动转换为合适的编码格式：

filename = 'filename\u4500abc'
with open(filename, 'w') as f:
    f.write('blah\n')

os 模块中的函数也能接受 Unicode 文件名，如 os.stat() 。

os.listdir() 函数返回文件名，这引发了一个问题：它应该返回文件名的 Unicode 版本，还是应该返回包含已编码版本的字节串？ 这两者 os.listdir() 都能做到，具体取决于你给出的目录路径是字节串还是 Unicode 字符串形式的。 如果你传入一个 Unicode 字符串作为路径，文件名将使用文件系统的编码格式进行解码并返回一个 Unicode 字符串列表，而传入一个字节串形式的路径则将返回字节串形式的文件名。 例如，假定默认 文件系统编码 为 UTF-8，运行以下程序:

fn = 'filename\u4500abc'
f = open(fn, 'w')
f.close()

import os
print(os.listdir(b'.'))
print(os.listdir('.'))

将产生以下输出：

$ python listdir-test.py
[b'filename\xe4\x94\x80abc', ...]
['filename\u4500abc', ...]

第一个列表包含 UTF-8 编码的文件名，第二个列表则包含 Unicode 版本的。

请注意，大多时候应该坚持用这些 API 处理 Unicode。字节串 API 应该仅用于可能存在不可解码文件名的系统；现在几乎仅剩 Unix 系统了。

识别 Unicode 的编程技巧

本节提供了一些关于编写 Unicode 处理软件的建议。

最重要的技巧如下：

程序应只在内部处理 Unicode 字符串，尽快对输入数据进行解码，并只在最后对输出进行编码。

如果尝试编写的处理函数对 Unicode 和字节串形式的字符串都能接受，就会发现组合使用两种不同类型的字符串时，容易产生差错。没办法做到自动编码或解码：如果执行 str + bytes，则会触发 TypeError。

当要使用的数据来自 Web 浏览器或其他不受信来源时，常用技术是在用该字符串生成命令行之前，或要存入数据库之前，先检查字符串中是否包含非法字符。请仔细检查解码后的字符串，而不是编码格式的字节串数据；有些编码可能具备一些有趣的特性，例如与 ASCII 不是一一对应或不完全兼容。如果输入数据还指定了编码格式，则尤其如此，因为攻击者可以选择一种巧妙的方式将恶意文本隐藏在经过编码的字节流中。

在文件编码格式之间进行转换

StreamRecoder 类可以在两种编码之间透明地进行转换，参数为编码格式为 #1 的数据流，表现行为则是编码格式为 #2 的数据流。

假设输入文件 f 采用 Latin-1 编码格式，即可用 StreamRecoder 包装后返回 UTF-8 编码的字节串：

new_f = codecs.StreamRecoder(f,
    # en/decoder: used by read() to encode its results and
    # by write() to decode its input.
    codecs.getencoder('utf-8'), codecs.getdecoder('utf-8'),

    # reader/writer: used to read and write to the stream.
    codecs.getreader('latin-1'), codecs.getwriter('latin-1') )

编码格式未知的文件

若需对文件进行修改，但不知道文件的编码，那该怎么办呢？如果已知编码格式与 ASCII 兼容，并且只想查看或修改 ASCII 部分，则可利用 surrogateescape 错误处理 handler 打开文件：

with open(fname, 'r', encoding="ascii", errors="surrogateescape") as f:
    data = f.read()

# make changes to the string 'data'

with open(fname + '.new', 'w',
          encoding="ascii", errors="surrogateescape") as f:
    f.write(data)

surrogateescape 错误处理 handler 会把所有非 ASCII 字节解码为 U+DC80 至 U+DCFF 这一特殊范围的码位。当 surrogateescape 错误处理 handler用于数据编码并回写时，这些码位将转换回原样。

参考文献

David Beazley 在 PyCon 2010 上的演讲 掌握 Python 3 输入/输出 [https://pyvideo.org/video/289/pycon-2010--mastering-python-3-io] 中，有一节讨论了文本和二进制数据的处理。

Marc-André Lemburg 演示的PDF 幻灯片“在 Python 中编写支持 Unicode 的应用程序” [https://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf] ，讨论了字符编码问题以及如何国际化和本地化应用程序。这些幻灯片仅涵盖 Python 2.x。

Python Unicode 实质 [https://pyvideo.org/video/1768/the-guts-of-unicode-in-python] 是 Benjamin Peterson 在 PyCon 2013 上的演讲，讨论了 Unicode 在 Python 3.3 中的内部表示。

致谢

本文初稿由 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。

如何利用 urllib 包获取网络资源

作者

Michael Foord [https://agileabstractions.com/]

注解

There is a French translation of an earlier revision of this HOWTO, available at urllib2 - Le Manuel manquant [https://web.archive.org/web/20200910051922/http://www.voidspace.org.uk/python/articles/urllib2_francais.shtml].

概述

Related Articles

关于如何用 Python 获取 web 资源，以下文章或许也很有用：

基本身份认证 [https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml]

基本认证 的教程，带有一些 Python 示例。

urllib.request 是用于获取 URL （统一资源定位符）的 Python 模块。它以 urlopen 函数的形式提供了一个非常简单的接口，能用不同的协议获取 URL。同时它还为处理各种常见情形提供了一个稍微复杂一些的接口——比如：基础身份认证、cookies、代理等等。这些功能是由名为 handlers 和 opener 的对象提供的。

urllib.request 支持多种 "URL 方案" （通过 URL中 ":" 之前的字符串加以区分——如 "ftp://python.org/" 中的 "ftp"）即为采用其关联网络协议（FTP、HTTP 之类）的 URL 方案 。本教程重点关注最常用的 HTTP 场景。

对于简单场景而言， urlopen 用起来十分容易。但只要在打开 HTTP URL 时遇到错误或非常情况，就需要对超文本传输协议有所了解才行。最全面、最权威的 HTTP 参考是 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] 。那是一份技术文档，并没有追求可读性。本 文旨在说明 urllib 的用法，为了便于阅读也附带了足够详细的 HTTP 信息。本文并不是为了替代 urllib.request 文档，只是其补充说明而已。

获取 URL 资源

urllib.request 最简单的使用方式如下所示：

import urllib.request
with urllib.request.urlopen('http://python.org/') as response:
   html = response.read()

如果想通过 URL 获取资源并临时存储一下，可以采用 shutil.copyfileobj() 和 tempfile.NamedTemporaryFile() 函数：

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

urllib 的很多用法就是这么简单（注意 URL 不仅可以 http: 开头，还可以是 ftp: 、file: 等）。不过本教程的目的是介绍更加复杂的应用场景，重点还是关注 HTTP。

HTTP 以请求和响应为基础——客户端生成请求，服务器发送响应。urllib.request 用 Request 对象来表示要生成的 HTTP 请求。最简单的形式就是创建一个 Request 对象，指定了想要获取的 URL。用这个 Request 对象作为参数调用 urlopen ，将会返回该 URL 的响应对象。响应对象类似于文件对象，就是说可以对其调用 .read() 之类的命令：

import urllib.request

req = urllib.request.Request('http://www.voidspace.org.uk')
with urllib.request.urlopen(req) as response:
   the_page = response.read()

请注意，urllib.request 用同一个 Request 接口处理所有 URL 方案。比如可生成 FTP 请求如下：

req = urllib.request.Request('ftp://example.com/')

就 HTTP 而言，Request 对象能够做两件额外的事情：首先可以把数据传给服务器。其次，可以将 有关 数据或请求本身的额外信息（metadata）传给服务器——这些信息将会作为 HTTP “头部”数据发送。下面依次看下。

数据

有时需要向某个 URL 发送数据，通常此 URL 会指向某个CGI（通用网关接口）脚本或其他 web 应用。对于 HTTP 而言，这通常会用所谓的 POST 请求来完成。当要把 Web 页填写的 HTML 表单提交时，浏览器通常会执行此操作。但并不是所有的 POST 都来自表单：可以用 POST 方式传输任何数据到自己的应用上。对于通常的 HTML 表单，数据需要以标准的方式编码，然后作为 data 参数传给 Request 对象。编码过程是用 urllib.parse 库的函数完成的：

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') # data should be bytes
req = urllib.request.Request(url, data)
with urllib.request.urlopen(req) as response:
   the_page = response.read()

请注意，有时还需要采用其他编码，比如由 HTML 表单上传文件——更多细节请参见 HTML 规范，提交表单 [https://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13] 。

如果不传递 data 参数，urllib 将采用 GET 请求。GET 和 POST 请求有一点不同，POST 请求往往具有“副作用”，他们会以某种方式改变系统的状态。例如，从网站下一个订单，购买一大堆罐装垃圾并运送到家。 尽管 HTTP 标准明确指出 POST 总是 要导致副作用，而 GET 请求 从来不会 导致副作用。但没有什么办法能阻止 GET 和 POST 请求的副作用。数据也可以在 HTTP GET 请求中传递，只要把数据编码到 URL 中即可。

做法如下所示：

>>> 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)

请注意，完整的 URL 是通过在其中添加 ? 创建的，后面跟着经过编码的数据。

HTTP 头部信息

下面介绍一个具体的 HTTP 头部信息，以此说明如何在 HTTP 请求加入头部信息。

有些网站 1 不愿被程序浏览到，或者要向不同的浏览器发送不同版本 2 的网页。默认情况下，urllib 将自身标识为“Python-urllib/xy”（其中 x 、 y 是 Python 版本的主、次版本号，例如 Python-urllib/2.5），这可能会让网站不知所措，或者干脆就使其无法正常工作。浏览器是通过头部信息 User-Agent 3 来标识自己的。在创建 Request 对象时，可以传入字典形式的头部信息。以下示例将生成与之前相同的请求，只是将自身标识为某个版本的 Internet Explorer 4 ：

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()

响应对象也有两个很有用的方法。请参阅有关 info 和 geturl 部分，了解出现问题时会发生什么。

异常的处理

如果 urlopen 无法处理响应信息，就会触发 URLError 。尽管与通常的 Python API 一样，也可能触发 ValueError 、 TypeError 等内置异常。

HTTPError 是 URLError 的子类，当 URL 是 HTTP 的情况时将会触发。

上述异常类是从 urllib.error 模块中导出的。

URLError

触发 URLError 的原因，通常是网络不通（或者没有到指定服务器的路由），或者指定的服务器不存在。这时触发的异常会带有一个 reason 属性，是一个包含错误代码和文本错误信息的元组。

例如：

>>> 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')

HTTPError

从服务器返回的每个 HTTP 响应都包含一个数字的 “状态码”。有时该状态码表明服务器无法完成该请求。默认的处理函数将会处理这其中的一部分响应。如若响应是“redirection”，这是要求客户端从另一 URL 处获取数据，urllib 将会自行处理。对于那些无法处理的状况，urlopen 将会引发 HTTPError 。典型的错误包括：“404”（页面无法找到）、“403”（请求遭拒绝）和“401”（需要身份认证）。

全部的 HTTP 错误码请参阅 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] 。

HTTPError 实例将包含一个整数型的“code”属性，对应于服务器发来的错误。

错误代码

由于默认处理函数会自行处理重定向（300 以内的错误码），而且 100--299 的状态码表示成功，因此通常只会出现 400--599 的错误码。

http.server.BaseHTTPRequestHandler.responses 是很有用的响应码字典，其中给出了 RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] 用到的所有响应代码。为方便起见，将此字典转载如下：

# Table mapping response codes to messages; entries have the
# form {code: (shortmessage, longmessage)}.
responses = {
    100: ('Continue', 'Request received, please continue'),
    101: ('Switching Protocols',
          'Switching to new protocol; obey Upgrade header'),

    200: ('OK', 'Request fulfilled, document follows'),
    201: ('Created', 'Document created, URL follows'),
    202: ('Accepted',
          'Request accepted, processing continues off-line'),
    203: ('Non-Authoritative Information', 'Request fulfilled from cache'),
    204: ('No Content', 'Request fulfilled, nothing follows'),
    205: ('Reset Content', 'Clear input form for further input.'),
    206: ('Partial Content', 'Partial content follows.'),

    300: ('Multiple Choices',
          'Object has several resources -- see URI list'),
    301: ('Moved Permanently', 'Object moved permanently -- see URI list'),
    302: ('Found', 'Object moved temporarily -- see URI list'),
    303: ('See Other', 'Object moved -- see Method and URL list'),
    304: ('Not Modified',
          'Document has not changed since given time'),
    305: ('Use Proxy',
          'You must use proxy specified in Location to access this '
          'resource.'),
    307: ('Temporary Redirect',
          'Object moved temporarily -- see URI list'),

    400: ('Bad Request',
          'Bad request syntax or unsupported method'),
    401: ('Unauthorized',
          'No permission -- see authorization schemes'),
    402: ('Payment Required',
          'No payment -- see charging schemes'),
    403: ('Forbidden',
          'Request forbidden -- authorization will not help'),
    404: ('Not Found', 'Nothing matches the given URI'),
    405: ('Method Not Allowed',
          'Specified method is invalid for this server.'),
    406: ('Not Acceptable', 'URI not available in preferred format.'),
    407: ('Proxy Authentication Required', 'You must authenticate with '
          'this proxy before proceeding.'),
    408: ('Request Timeout', 'Request timed out; try again later.'),
    409: ('Conflict', 'Request conflict.'),
    410: ('Gone',
          'URI no longer exists and has been permanently removed.'),
    411: ('Length Required', 'Client must specify Content-Length.'),
    412: ('Precondition Failed', 'Precondition in headers is false.'),
    413: ('Request Entity Too Large', 'Entity is too large.'),
    414: ('Request-URI Too Long', 'URI is too long.'),
    415: ('Unsupported Media Type', 'Entity body in unsupported format.'),
    416: ('Requested Range Not Satisfiable',
          'Cannot satisfy request range.'),
    417: ('Expectation Failed',
          'Expect condition could not be satisfied.'),

    500: ('Internal Server Error', 'Server got itself in trouble'),
    501: ('Not Implemented',
          'Server does not support this operation'),
    502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),
    503: ('Service Unavailable',
          'The server cannot process the request due to a high load'),
    504: ('Gateway Timeout',
          'The gateway server did not receive a timely response'),
    505: ('HTTP Version Not Supported', 'Cannot fulfill request.'),
    }

当触发错误时，服务器通过返回 HTTP 错误码 和 错误页面进行响应。可以将 HTTPError 实例用作返回页面的响应。这意味着除了 code 属性之外，错误对象还像 urllib.response 模块返回的那样具有 read、geturl 和 info 方法：

>>> 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
  ...

总之

若要准备处理 HTTPError  或 URLError ，有两种简单的方案。推荐使用第二种方案。

第一种方案

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:
    # everything is fine

注解

except HTTPError 必须 首先处理，否则 except URLError 将会 同时 捕获 HTTPError 。

第二种方案

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:
    # everything is fine

info 和 geturl 方法

由 urlopen （或者 HTTPError 实例）所返回的响应包含两个有用的方法： info() 和 geturl()，该响应由模块 urllib.response 定义。

geturl ——返回所获取页面的真实 URL。该方法很有用，因为 urlopen （或 opener 对象）可能已经经过了一次重定向。已获取页面的 URL 未必就是所请求的 URL 。

info - 该方法返回一个类似字典的对象，描述了所获取的页面，特别是由服务器送出的头部信息（headers） 。目前它是一个 http.client.HTTPMessage 实例。

典型的标头包括 'Content-length', 'Content-type' 等等。 请参阅 HTTP 标头快速参考 [https://jkorpela.fi/http.html] 获取 HTTP 标头的完整列表及其含义和用法的简要说明。

Opener 和 Handler

当你获取 URL 时会使用一个 opener (名称可能有些令人困惑的 urllib.request.OpenerDirector 的实例)。 通常我们会使用默认的 opener —— 通过 urlopen —— 但你也可以创建自定义的 opener。 opener 还会用到 handler。 所有 "繁重工作" 都是由 handler 来完成的。 每种 handler 都知道要以何种 URL 方案 (http, ftp 等等) 来打开特定的 URL，或是如何处理 URL 打开时的特定操作，例如 HTTP 重定向或 HTTP cookie 等。

若要用已安装的某个 handler 获取 URL，需要创建一个 opener 对象，例如处理 cookie 的 opener，或对重定向不做处理的 opener。

若要创建 opener，请实例化一个 OpenerDirector ，然后重复调用 .add_handler(some_handler_instance) 。

或者也可以用 build_opener ，这是个用单次调用创建 opener 对象的便捷函数。build_opener 默认会添加几个 handler，不过还提供了一种快速添加和/或覆盖默认 handler 的方法。

可能还需要其他类型的 handler，以便处理代理、身份认证和其他常见但稍微特殊的情况。

install_opener 可用于让 opener 对象成为（全局）默认 opener。这意味着调用 urlopen 时会采用已安装的 opener。

opener 对象带有一个 `open 方法，可供直接调用以获取 url，方式与 urlopen 函数相同。除非是为了调用方便，否则没必要去调用 install_opener 。

基本认证

为了说明 handler 的创建和安装过程，会用到 HTTPBasicAuthHandler 。有关该主题的更详细的介绍——包括基本身份认证的工作原理——请参阅 Basic Authentication Tutorial [http://www.voidspace.org.uk/python/articles/authentication.shtml] 。

如果需要身份认证，服务器会发送一条请求身份认证的头部信息（以及 401 错误代码）。这条信息中指明了身份认证方式和“安全区域（realm）”。格式如下所示：WWW-Authenticate: SCHEME realm="REALM" 。

例如

WWW-Authenticate: Basic realm="cPanel Users"

然后，客户端应重试发起请求，请求数据中的头部信息应包含安全区域对应的用户名和密码。这就是“基本身份认证”。为了简化此过程，可以创建 HTTPBasicAuthHandler 的一个实例及使用它的 opener。

HTTPBasicAuthHandler 用一个名为密码管理器的对象来管理 URL、安全区域与密码、用户名之间的映射关系。如果知道确切的安全区域（来自服务器发送的身份认证头部信息），那就可以用到 HTTPPasswordMgr 。通常人们并不关心安全区域是什么，这时用 HTTPPasswordMgrWithDefaultRealm 就很方便，允许为 URL 指定默认的用户名和密码。当没有为某个安全区域提供用户名和密码时，就会用到默认值。下面用 None 作为 add_password 方法的安全区域参数，表明采用默认用户名和密码。

首先需要身份认证的是顶级 URL。比传给 .add_password() 的 URL 级别“更深”的 URL 也会得以匹配：

# create a password manager
password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()

# Add the username and password.
# If we knew the realm, we could use it instead of None.
top_level_url = "http://example.com/foo/"
password_mgr.add_password(None, top_level_url, username, password)

handler = urllib.request.HTTPBasicAuthHandler(password_mgr)

# create "opener" (OpenerDirector instance)
opener = urllib.request.build_opener(handler)

# use the opener to fetch a URL
opener.open(a_url)

# Install the opener.
# Now all calls to urllib.request.urlopen use our opener.
urllib.request.install_opener(opener)

注解

在以上例子中，只向 build_opener 给出了 HTTPBasicAuthHandler 。默认情况下，opener 会有用于处理常见状况的 handler ——ProxyHandler （如果设置代理的话，比如设置了环境变量 http_proxy ），UnknownHandler 、HTTPHandler 、 HTTPDefaultErrorHandler 、 HTTPRedirectHandler 、 FTPHandler 、 FileHandler 、 DataHandler 、 HTTPErrorProcessor 。

top_level_url 其实 要么 是一条完整的 URL（包括 “http:” 部分和主机名及可选的端口号），比如 "http://example.com/" ， 要么 是一条“访问权限”（即主机名，及可选的端口号），比如 "example.com" 或 "example.com:8080" （后一个示例包含了端口号）。访问权限 不得 包含“用户信息”部分——比如 "joe:password@example.com" 就不正确。

代理

urllib 将自动检测并使用代理设置。 这是通过 ProxyHandler 实现的，当检测到代理设置时，是正常 handler 链中的一部分。通常这是一件好事，但有时也可能会无效 5。 一种方案是配置自己的 ProxyHandler ，不要定义代理。 设置的步骤与 Basic Authentication handler 类似:

>>> proxy_support = urllib.request.ProxyHandler({})
>>> opener = urllib.request.build_opener(proxy_support)
>>> urllib.request.install_opener(opener)

注解

目前 urllib.request 尚不 支持通过代理抓取 https 链接地址。 但此功能可以通过扩展 urllib.request 来启用，如以下例程所示 6。

注解

如果设置了 REQUEST_METHOD 变量，则会忽略 HTTP_PROXY ；参阅 getproxies() 文档。

套接字与分层

Python 获取 Web 资源的能力是分层的。urllib 用到的是 http.client 库，而后者又用到了套接字库。

从 Python 2.3 开始，可以指定套接字等待响应的超时时间。这对必须要读到网页数据的应用程序会很有用。默认情况下，套接字模块 不会超时 并且可以挂起。目前，套接字超时机制未暴露给 http.client 或 urllib.request 层使用。不过可以为所有套接字应用设置默认的全局超时。

import socket
import urllib.request

# timeout in seconds
timeout = 10
socket.setdefaulttimeout(timeout)

# this call to urllib.request.urlopen now uses the default timeout
# we have set in the socket module
req = urllib.request.Request('http://www.voidspace.org.uk')
response = urllib.request.urlopen(req)

备注

这篇文档由 John Lee 审订。

1

例如 Google。

2

对于网站设计而言，探测不同的浏览器是非常糟糕的做法——更为明智的做法是采用 web 标准构建网站。不幸的是，很多网站依然向不同的浏览器发送不同版本的网页。

3

MSIE 6 的 user-agent 信息是 “Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)”

4

有关 HTTP 请求的头部信息，详情请参阅 Quick Reference to HTTP Headers。

5

本人必须使用代理才能在工作中访问互联网。如果尝试通过代理获取 localhost URL，将会遭到阻止。IE 设置为代理模式，urllib 就会获取到配置信息。为了用 localhost 服务器测试脚本，我必须阻止 urllib 使用代理。

6

urllib 的 SSL 代理 opener（CONNECT  方法）： ASPN Cookbook Recipe [https://code.activestate.com/recipes/456195/] 。

argparse 教程

作者

Tshepang Lekhonkhobe

这篇教程旨在作为 argparse 的入门介绍，此模块是 Python 标准库中推荐的命令行解析模块。

注解

还有另外两个模块可以完成同样的任务，称为 getopt (对应于 C 语言中的 getopt() 函数) 和被弃用的 optparse。还要注意 argparse 是基于 optparse 的，因此用法与其非常相似。

概念

让我们利用 ls 命令来展示我们将要在这篇入门教程中探索的功能：

$ 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.
...

我们可以从这四个命令中学到几个概念：

ls 是一个即使在运行的时候没有提供任何选项，也非常有用的命令。在默认情况下他会输出当前文件夹包含的文件和文件夹。

如果我们想要使用比它默认提供的更多功能，我们需要告诉该命令更多信息。在这个例子里，我们想要查看一个不同的目录，pypy。我们所做的是指定所谓的位置参数。之所以这样命名，是因为程序应该如何处理该参数值，完全取决于它在命令行出现的位置。更能体现这个概念的命令如 cp，它最基本的用法是 cp SRC DEST。第一个位置参数指的是*你想要复制的*，第二个位置参数指的是*你想要复制到的位置*。

现在假设我们想要改变这个程序的行为。在我们的例子中，我们不仅仅只是输出每个文件的文件名，还输出了更多信息。在这个例子中，-l 被称为可选参数。

这是一段帮助文档的文字。它是非常有用的，因为当你遇到一个你从未使用过的程序时，你可以通过阅读它的帮助文档来弄清楚它是如何运行的。

基础

让我们从一个简单到（几乎）什么也做不了的例子开始：

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

以下是该代码的运行结果：

$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h]

options:
  -h, --help  show this help message and exit
$ python3 prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python3 prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

程序运行情况如下：

在没有任何选项的情况下运行脚本不会在标准输出显示任何内容。这没有什么用处。

第二行代码开始展现出 argparse 模块的作用。我们几乎什么也没有做，但已经得到一条很好的帮助信息。

--help 选项，也可缩写为 -h，是唯一一个可以直接使用的选项（即不需要指定该选项的内容）。指定任何内容都会导致错误。即便如此，我们也能直接得到一条有用的用法信息。

位置参数介绍

举个例子：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)

运行此程序：

$ python3 prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python3 prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

options:
  -h, --help  show this help message and exit
$ python3 prog.py foo
foo

程序运行情况如下：

我们增加了 add_argument() 方法，该方法用于指定程序能够接受哪些命令行选项。在这个例子中，我将选项命名为 echo，与其功能一致。

现在调用我们的程序必须要指定一个选项。

The parse_args() method actually returns some data from the options specified, in this case, echo.

这一变量是 argparse 免费施放的某种 “魔法”（即是说，不需要指定哪个变量是存储哪个值的）。你也可以注意到，这一名称与传递给方法的字符串参数一致，都是 echo。

然而请注意，尽管显示的帮助看起来清楚完整，但它可以比现在更有帮助。比如我们可以知道 echo 是一个位置参数，但我们除了靠猜或者看源代码，没法知道它是用来干什么的。所以，我们可以把它改造得更有用：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)

然后我们得到：

$ python3 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

现在，来做一些更有用的事情：

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)

以下是该代码的运行结果：

$ python3 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'

进展不太顺利。那是因为 argparse 会把我们传递给它的选项视作为字符串，除非我们告诉它别这样。所以，让我们来告诉 argparse 来把这一输入视为整数：

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)

以下是该代码的运行结果：

$ python3 prog.py 4
16
$ python3 prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

做得不错。当这个程序在收到错误的无效的输入时，它甚至能在执行计算之前先退出，还能显示很有帮助的错误信息。

可选参数介绍

到目前为止，我们一直在研究位置参数。让我们看看如何添加可选的：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
    print("verbosity turned on")

和输出：

$ python3 prog.py --verbosity 1
verbosity turned on
$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

options:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python3 prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

程序运行情况如下：

这一程序被设计为当指定 --verbosity 选项时显示某些东西，否则不显示。

不添加这一选项时程序没有提示任何错误而退出，表明这一选项确实是可选的。注意，如果一个可选参数没有被使用时，相关变量被赋值为 None，在此例中是 args.verbosity，这也就是为什么它在 if 语句中被当作逻辑假。

帮助信息有点不同。

使用 --verbosity 选项时，必须指定一个值，但可以是任何值。

上述例子接受任何整数值作为 --verbosity 的参数，但对于我们的简单程序而言，只有两个值有实际意义：True 或者 False。让我们据此修改代码：

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")

和输出：

$ python3 prog.py --verbose
verbosity turned on
$ python3 prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python3 prog.py --help
usage: prog.py [-h] [--verbose]

options:
  -h, --help  show this help message and exit
  --verbose   increase output verbosity

程序运行情况如下：

现在，这一选项更多地是一个标志，而非需要接受一个值的什么东西。我们甚至改变了选项的名字来符合这一思路。注意我们现在指定了一个新的关键词 action，并赋值为 "store_true"。这意味着，当这一选项存在时，为 args.verbose 赋值为 True。没有指定时则隐含地赋值为 False。

当你为其指定一个值时，它会报错，符合作为标志的真正的精神。

留意不同的帮助文字。

短选项

如果你熟悉命令行的用法，你会发现我还没讲到这一选项的短版本。这也很简单：

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")

效果就像这样：

$ python3 prog.py -v
verbosity turned on
$ python3 prog.py --help
usage: prog.py [-h] [-v]

options:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

可以注意到，这一新的能力也反映在帮助文本里。

结合位置参数和可选参数

我们的程序变得越来越复杂了：

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)

接着是输出：

$ python3 prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python3 prog.py 4
16
$ python3 prog.py 4 --verbose
the square of 4 equals 16
$ python3 prog.py --verbose 4
the square of 4 equals 16

我们带回了一个位置参数，结果发生了报错。

注意顺序无关紧要。

给我们的程序加上接受多个冗长度的值，然后实际来用用：

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)

和输出：

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python3 prog.py 4 -v 1
4^2 == 16
$ python3 prog.py 4 -v 2
the square of 4 equals 16
$ python3 prog.py 4 -v 3
16

除了最后一个，看上去都不错。最后一个暴露了我们的程序中有一个 bug。我们可以通过限制 --verbosity 选项可以接受的值来修复它：

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)

和输出：

$ python3 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)
$ python3 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 {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity

注意这一改变同时反应在错误信息和帮助信息里。

现在，让我们使用另一种的方式来改变冗长度。这种方式更常见，也和 CPython 的可执行文件处理它自己的冗长度参数的方式一致（参考 python --help 的输出）：

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)

我们引入了另一种动作 "count"，来统计特定选项出现的次数。

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
4^2 == 16
$ python3 prog.py 4 -vv
the square of 4 equals 16
$ python3 prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python3 prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python3 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
$ python3 prog.py 4 -vvv
16

是的，它现在比前一版本更像是一个标志（和 action="store_true" 相似）。这能解释它为什么报错。

它也表现得与 “store_true” 的行为相似。

这给出了一个关于 count 动作的效果的演示。你之前很可能应该已经看过这种用法。

如果你不添加 -v 标志，这一标志的值会是 None。

如期望的那样，添加该标志的长形态能够获得相同的输出。

可惜的是，对于我们的脚本获得的新能力，我们的帮助输出并没有提供很多信息，但我们总是可以通过改善文档来修复这一问题（比如通过 help 关键字参数）。

最后一个输出暴露了我们程序中的一个 bug。

让我们修复一下：

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)

这是它给我们的输出：

$ python3 prog.py 4 -vvv
the square of 4 equals 16
$ python3 prog.py 4 -vvvv
the square of 4 equals 16
$ python3 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'

第一组输出很好，修复了之前的 bug。也就是说，我们希望任何 >= 2 的值尽可能详尽。

第三组输出并不理想。

让我们修复那个 bug：

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)

我们刚刚引入了又一个新的关键字 default。我们把它设置为 0 来让它可以与其他整数值相互比较。记住，默认情况下如果一个可选参数没有被指定，它的值会是 None，并且它不能和整数值相比较（所以产生了 TypeError 异常）。

然后：

$ python3 prog.py 4
16

凭借我们目前已学的东西你就可以做到许多事情，而我们还仅仅学了一些皮毛而已。 argparse 模块是非常强大的，在结束本篇教程之前我们将再探索更多一些内容。

进行一些小小的改进

如果我们想扩展我们的简短程序来执行其他幂次的运算，而不仅是乘方:

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)

输出：

$ python3 prog.py
usage: prog.py [-h] [-v] x y
prog.py: error: the following arguments are required: x, y
$ python3 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
$ python3 prog.py 4 2 -v
4^2 == 16

请注意到目前为止我们一直在使用详细级别来 更改 所显示的文本。 以下示例则使用详细级别来显示 更多的 文本:

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)

输出：

$ python3 prog.py 4 2
16
$ python3 prog.py 4 2 -v
4^2 == 16
$ python3 prog.py 4 2 -vv
Running 'prog.py'
4^2 == 16

矛盾的选项

到目前为止，我们一直在使用 argparse.ArgumentParser 实例的两个方法。 让我们再介绍第三个方法 add_mutually_exclusive_group()。 它允许我们指定彼此相互冲突的选项。 让我们再更改程序的其余部分以便使用新功能更有意义：我们将引入 --quiet 选项，它将与 --verbose 正好相反:

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}")

我们的程序现在变得更简洁了，我们出于演示需要略去了一些功能。 无论如何，输出是这样的:

$ python3 prog.py 4 2
4^2 == 16
$ python3 prog.py 4 2 -q
16
$ python3 prog.py 4 2 -v
4 to the power 2 equals 16
$ python3 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
$ python3 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

这应该很容易理解。 我添加了末尾的输出这样你就可以看到其所达到的灵活性，即混合使用长和短两种形式的选项。

在我们收尾之前，你也许希望告诉你的用户这个程序的主要目标，以免他们还不清楚:

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}")

请注意用法文本中有细微的差异。 注意 [-v | -q]，它的意思是说我们可以使用 -v 或 -q，但不能同时使用两者：

$ python3 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

后记

除了这里显示的内容，argparse 模块还提供了更多功能。 它的文档相当详细和完整，包含大量示例。 完成这个教程之后，你应该能毫不困难地阅读该文档。

ipaddress模块介绍

作者

Peter Moody

作者

Nick Coghlan

概述

本文档旨在简要介绍 ipaddress 模块。 它主要针对那些不熟悉 IP 网络术语的用户，但也可能对想要速览 ipaddress 如何代表IP网络寻址概念的网络工程师有用。

创建 Address/Network/Interface 对象

因为 ipaddress 是一个用于检查和操作 IP 地址的模块，你要做的第一件事就是创建一些对象。 您可以使用 ipaddress 从字符串和整数创建对象。

关于IP版本的说明

对于不太熟悉 IP 寻址的读者来说，重要的一点是知道互联网协议 (IP) 目前正在从第 4 版协议迁移到第 6 版。 进行这样的迁移主要是因为第 4 版协议无法提供足够的地址来满足全世界的需求，特别是考虑到有越来越多的设备连接到了互联网中。

解释协议的两个版本之间的差异的细节超出了本介绍的范围，但读者需要至少知道存在这两个版本，并且有时需要强制使用一个版本或其他版本。

IP主机地址

通常称为“主机地址”的地址是使用IP寻址时最基本的单元。 创建地址的最简单方法是使用 ipaddress.ip_address() 工厂函数，该函数根据传入的值自动确定是创建 IPv4 还是 IPv6 地址：

>>> ipaddress.ip_address('192.0.2.1')
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address('2001:DB8::1')
IPv6Address('2001:db8::1')

地址也可以直接从整数创建，适配32位的值并假定为IPv4地址:

>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address(42540766411282592856903984951653826561)
IPv6Address('2001:db8::1')

要强制使用IPv4或IPv6地址，可以直接调用相关的类。 这对于强制为小整数创建IPv6地址特别有用:

>>> ipaddress.ip_address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv4Address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv6Address(1)
IPv6Address('::1')

定义网络

主机地址通常组合在一起形成IP网络，因此 ipaddress 提供了一种创建、检查和操作网络定义的方法。 IP网络对象由字符串构成，这些字符串定义作为该网络一部分的主机地址范围。 该信息的最简单形式是“网络地址/网络前缀”对，其中前缀定义了比较的前导比特数，以确定地址是否是网络的一部分，并且网络地址定义了那些位的预期值。

对于地址，提供了一个自动确定正确IP版本的工厂函数:

>>> 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')

网络对象不能设置任何主机位。 这样做的实际效果是 192.0.2.1/24 没有描述网络。 这种定义被称为接口对象，因为网络上IP表示法通常用于描述给定网络上的计算机的网络接口，并在下一节中进一步描述。

默认情况下，尝试创建一个设置了主机位的网络对象将导致 ValueError 被引发。 要请求将附加位强制为零，可以将标志 strict=False 传递给构造函数:

>>> 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')

虽然字符串形式提供了更大的灵活性，但网络也可以用整数定义，就像主机地址一样。 在这种情况下，网络被认为只包含由整数标识的单个地址，因此网络前缀包括整个网络地址:

>>> ipaddress.ip_network(3221225984)
IPv4Network('192.0.2.0/32')
>>> ipaddress.ip_network(42540766411282592856903984951653826560)
IPv6Network('2001:db8::/128')

与地址一样，可以通过直接调用类构造函数而不是使用工厂函数来强制创建特定类型的网络。

主机接口

如上所述，如果您需要描述特定网络上的地址，则地址和网络类都不够。 像 192.0.2.1/24 这样的表示法通常被网络工程师和为防火墙和路由器编写工具的人用作“ 192.0.2.0/24 网络上的主机 192.0.2.1 ”的简写。因此，ipaddress 提供了一组将地址与特定网络相关联的混合类。用于创建的接口与用于定义网络对象的接口相同，除了地址部分不限于是网络地址。

>>> 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')

接受整数输入（与网络一样），并且可以通过直接调用相关构造函数来强制使用特定IP版本。

审查 Address/Network/Interface 对象

你已经遇到了创建IPv(4|6)(Address|Network|Interface) 对象的麻烦，因此你可能希望获得有关它的信息。 ipaddress 试图让这个过程变得简单直观。

提取 IP 版本:

>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr6 = ipaddress.ip_address('2001:db8::1')
>>> addr6.version
6
>>> addr4.version
4

从接口获取网络:

>>> 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')

找出网络中有多少独立地址:

>>> 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

迭代网络上的“可用”地址:

>>> 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

获取网络掩码（即对应于网络前缀的设置位）或主机掩码（不属于网络掩码的任何位）：

>>> 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')

展开或压缩地址:

>>> 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'

虽然IPv4不支持展开或压缩，但关联对象仍提供相关属性，因此版本中性代码可以轻松确保最简洁或最详细的形式用于IPv6地址，同时仍能正确处理IPv4地址。

Network 作为 Address 列表

将网络视为列表有时很有用。 这意味着它可以像这样索引它们:

>>> 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')

它还意味着网络对象可以使用像这样的列表成员测试语法:

if address in network:
    # do something

根据网络前缀有效地完成包含性测试:

>>> 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

比较运算

ipaddress 有意义地提供了一些简单、希望直观的比较对象的方法:

>>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2')
True

如果你尝试比较不同版本或不同类型的对象，则会引发 TypeError 异常。

将IP地址与其他模块一起使用

其他使用IP地址的模块（例如 socket ）通常不会直接接受来自该模块的对象。 相反，它们必须被强制转换为另一个模块可接受的整数或字符串:

>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> str(addr4)
'192.0.2.1'
>>> int(addr4)
3221225985

实例创建失败时获取更多详细信息

使用与版本无关的工厂函数创建 address/network/interface 对象时，任何错误都将报告为 ValueError ，带有一般错误消息，只是说传入的值未被识别为该类型的对象。 缺少特定错误是因为有必要知道该值是*假设*是IPv4还是IPv6，以便提供有关其被拒绝原因的更多详细信息。

为了支持访问这些额外细节的用例，各个类构造函数实际上引发了 ValueError 子类 ipaddress.AddressValueError 和 ipaddress.NetmaskValueError 以准确指示定义的哪一部分无法正确解析。

直接使用类构造函数时，错误消息更加详细。 例如:

>>> 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

但是，两个模块特定的异常都有 ValueError 作为它们的父类，所以如果你不关心特定类型的错误，你仍然可以编写如下代码:

try:
    network = ipaddress.IPv4Network(address)
except ValueError:
    print('address/netmask is invalid for IPv4:', address)

Argument Clinic 的用法

作者

Larry Hastings

摘要

Argument Clinic 是 CPython 的一个 C 文件预处理器。旨在自动处理所有与“内置”参数解析有关的代码。本文展示了将 C 函数转换为配合 Argument Clinic 工作的做法，还介绍了一些关于 Argument Clinic 用法的进阶内容。

目前 Argument Clinic 视作仅供 CPython 内部使用。不支持在 CPython 之外的文件中使用，也不保证未来版本会向下兼容。换句话说：如果维护的是 CPython 的外部 C 语言扩展，欢迎在自己的代码中试用 Argument Clinic。但 Argument Clinic 与新版 CPython 中的版本 可能 完全不兼容，且会打乱全部代码。

Argument Clinic 的设计目标

Argument Clinic 的主要目标，是接管 CPython 中的所有参数解析代码。这意味着，如果要把某个函数转换为配合 Argument Clinic一起工作，则该函数不应再作任何参数解析工作——Argument Clinic 生成的代码应该是个“黑盒”，CPython 会在顶部发起调用，底部则调用自己的代码， PyObject *args （也许还有 PyObject *kwargs ）会神奇地转换成所需的 C 变量和类型。

Argument Clinic 为了能完成主要目标，用起来必须方便。目前，使用 CPython 的参数解析库是一件苦差事，需要在很多地方维护冗余信息。如果使用 Argument Clinic，则不必再重复代码了。

显然，除非 Argument Clinic 解决了自身的问题，且没有产生新的问题，否则没有人会愿意用它。所以，Argument Clinic 最重要的事情就是生成正确的代码。如果能加速代码的运行当然更好，但至少不应引入明显的减速。（最终 Argument Clinic 应该 可以实现较大的速度提升——代码生成器可以重写一下，以产生量身定做的参数解析代码，而不是调用通用的 CPython 参数解析库。 这会让参数解析达到最佳速度！）

此外，Argument Clinic 必须足够灵活，能够与任何参数解析的方法一起工作。Python 有一些函数具备一些非常奇怪的解析行为；Argument Clinic 的目标是支持所有这些函数。

最后，Argument Clinic 的初衷是为 CPython 内置程序提供内省“签名”。以前如果传入一个内置函数，内省查询函数会抛出异常。有了 Argument Clinic，再不会发生这种问题了！

在与 Argument Clinic 合作时，应该牢记一个理念：给它的信息越多，它做得就会越好。诚然，Argument Clinic 现在还比较简单。但会演变得越来越复杂，应该能够利用给出的全部信息干很多聪明而有趣的事情。

基本概念和用法

Argument Clinic 与 CPython 一起提供，位于 Tools/clinic/clinic.py 。若要运行它，请指定一个 C 文件作为参数。

$ python3 Tools/clinic/clinic.py foo.c

Argument Clinic 会扫描 C 文件，精确查找以下代码：

/*[clinic input]

一旦找到一条后，就会读取所有内容，直至遇到以下代码：

[clinic start generated code]*/

这两行之间的所有内容都是 Argument Clinic 的输入。所有行，包括开始和结束的注释行，统称为 Argument Clinic “块”。

Argument Clinic 在解析某一块时，会生成输出信息。输出信息会紧跟着该块写入 C 文件中，后面还会跟着包含校验和的注释。现在 Argument Clinic 块看起来应如下所示：

/*[clinic input]
... clinic input goes here ...
[clinic start generated code]*/
... clinic output goes here ...
/*[clinic end generated code: checksum=...]*/

如果对同一文件第二次运行 Argument Clinic，则它会丢弃之前的输出信息，并写入带有新校验行的输出信息。不过如果输入没有变化，则输出也不会有变化。

不应去改动 Argument Clinic 块的输出部分。而应去修改输入，直到生成所需的输出信息。（这就是校验和的用途——检测是否有人改动了输出信息，因为在 Argument Clinic 下次写入新的输出时，这些改动都会丢失）。

为了清晰起见，下面列出了 Argument Clinic 用到的术语：

注释的第一行 /*[clinic input] 是 起始行 。

注释（[clinic start generated code]*/）的最后一行是 结束行。

最后一行（/*[clinic end generated code: checksum=...]*/）是 校验和行 。

在起始行和结束行之间是 输入数据。

在结束行和校验和行之间是 输出数据 。

从开始行到校验和行的所有文本，都是 块。（Argument Clinic 尚未处理成功的块，没有输出或校验和行，但仍视作一个块）。

函数的转换

要想了解 Argument Clinic 是如何工作的，最好的方式就是转换一个函数与之合作。下面介绍需遵循的最基本步骤。请注意，若真的准备在 CPython 中进行检查，则应进行更深入的转换，使用一些本文后续会介绍到的高级概念（比如 “返回转换” 和 “自转换”）。但以下例子将维持简单，以供学习。

就此开始

请确保 CPython 是最新的已签出版本。

找到一个调用 PyArg_ParseTuple() 或 PyArg_ParseTupleAndKeywords() ，且未被转换为采用 Argument Clinic 的 Python 内置程序。这里用了 _pickle.Pickler.dump()。

如果对 PyArg_Parse 函数的调用采用了以下格式化单元：

O&
O!
es
es#
et
et#

或者多次调用 PyArg_ParseTuple()，则应再选一个函数。Argument Clinic 确实 支持上述这些状况。 但这些都是高阶内容——第一次就简单一些吧。

此外，如果多次调用 PyArg_ParseTuple() 或 PyArg_ParseTupleAndKeywords() 且同一参数需支持不同的类型，或者用到 PyArg_Parse 以外的函数来解析参数，则可能不适合转换为 Argument Clinic 形式。 Argument Clinic 不支持通用函数或多态参数。

在函数上方添加以下模板，创建块：

/*[clinic input]
[clinic start generated code]*/

剪下文档字符串并粘贴到 [clinic] 行之间，去除所有的无用字符，使其成为一个正确引用的 C 字符串。最有应该只留下带有左侧缩进的文本，且行宽不大于 80 个字符。（参数 Clinic 将保留文档字符串中的缩进。）

如果文档字符串的第一行看起来像是函数的签名，就把这一行去掉吧。（(文档串不再需要用到它——将来对内置函数调用 help() 时，第一行将根据函数的签名自动建立。）

示例：

/*[clinic input]
Write a pickled representation of obj to the open file.
[clinic start generated code]*/

如果文档字符串中没有“摘要”行，Argument Clinic 会报错。所以应确保带有摘要行。 “摘要”行应为在文档字符串开头的一个段落，由一个80列的单行构成。

（示例的文档字符串只包括一个摘要行，所以示例代码这一步不需改动）。

在文档字符串上方，输入函数的名称，后面是空行。这应是函数的 Python 名称，而且应是句点分隔的完整路径——以模块的名称开始，包含所有子模块名，若函数为类方法则还应包含类名。

示例：

/*[clinic input]
_pickle.Pickler.dump

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

如果是第一次在此 C 文件中用到 Argument Clinic 的模块或类，必须对其进行声明。清晰的 Argument Clinic 写法应于 C 文件顶部附近的某个单独块中声明这些，就像 include 文件和 statics 放在顶部一样。（在这里的示例代码中，将这两个块相邻给出。)

类和模块的名称应与暴露给 Python 的相同。请适时检查 PyModuleDef 或 PyTypeObject 中定义的名称。

在声明某个类时，还必须指定其 C 语言类型的两个部分：用于指向该类实例的指针的类型声明，和指向该类 PyTypeObject 的指针。

示例：

/*[clinic input]
module _pickle
class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
[clinic start generated code]*/

/*[clinic input]
_pickle.Pickler.dump

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

声明函数的所有参数。每个参数都应另起一行。所有的参数行都应对齐函数名和文档字符串进行缩进。

这些参数行的常规形式如下：

name_of_parameter: converter

如果参数带有缺省值，请加在转换器之后：

name_of_parameter: converter = default_value

Argument Clinic 对 “缺省值” 的支持方式相当复杂；更多信息请参见 关于缺省值的部分 。

在参数行下面添加一个空行。

What's a "converter"? It establishes both the type of the variable used in C, and the method to convert the Python value into a C value at runtime. For now you're going to use what's called a "legacy converter"—a convenience syntax intended to make porting old code into Argument Clinic easier.

每个参数都要从``PyArg_Parse()`` 格式参数中复制其 “格式单元”，并以带引号字符串的形式指定其转换器。（“格式单元”是 format 参数的1-3个字符的正式名称，用于让参数解析函数知晓该变量的类型及转换方法。关于格式单位的更多信息，请参阅 解析参数并构建值变量 ）。

对于像 z# 这样的多字符格式单元，要使用2-3个字符组成的整个字符串。

示例：

 /*[clinic input]
 module _pickle
 class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
 [clinic start generated code]*/

 /*[clinic input]
 _pickle.Pickler.dump

    obj: 'O'

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

如果函数的格式字符串包含 |，意味着有些参数带有缺省值，这可以忽略。Argument Clinic 根据参数是否有缺省值来推断哪些参数是可选的。

如果函数的格式字符串中包含 $，意味着只接受关键字参数，请在第一个关键字参数之前单独给出一行 *，缩进与参数行对齐。

（_pickle.Pickler.dump 两种格式字符串都没有，所以这里的示例不用改动。）

如果 C 函数调用的是 PyArg_ParseTuple() (而不是 PyArg_ParseTupleAndKeywords())，那么其所有参数均是仅限位置参数。

若要在 Argument Clinic 中把所有参数都标记为只认位置，请在最后一个参数后面一行加入一个 /，缩进程度与参数行对齐。

目前这个标记是全体生效；要么所有参数都是只认位置，要么都不是。（以后 Argument Clinic 可能会放宽这一限制。）

示例：

/*[clinic input]
module _pickle
class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
[clinic start generated code]*/

/*[clinic input]
_pickle.Pickler.dump

    obj: 'O'
    /

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

为每个参数都编写一个文档字符串，这很有意义。但这是可选项；可以跳过这一步。

下面介绍如何添加逐参数的文档字符串。逐参数文档字符串的第一行必须比参数定义多缩进一层。第一行的左边距即确定了所有逐参数文档字符串的左边距；所有文档字符串文本都要同等缩进。文本可以用多行编写。

示例：

/*[clinic input]
module _pickle
class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
[clinic start generated code]*/

/*[clinic input]
_pickle.Pickler.dump

    obj: 'O'
        The object to be pickled.
    /

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

保存并关闭该文件，然后运行 Tools/clinic/clinic.py 。 运气好的话就万事大吉——程序块现在有了输出信息，并且生成了一个 .c.h 文件！在文本编辑器中重新打开该文件，可以看到：

/*[clinic input]
_pickle.Pickler.dump

    obj: 'O'
        The object to be pickled.
    /

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

static PyObject *
_pickle_Pickler_dump(PicklerObject *self, PyObject *obj)
/*[clinic end generated code: output=87ecad1261e02ac7 input=552eb1c0f52260d9]*/

显然，如果 Argument Clinic 未产生任何输出，那是因为在输入信息中发现了错误。继续修正错误并重试，直至 Argument Clinic 正确地处理好文件。

为了便于阅读，大部分“胶水”代码已写入 .c.h 文件中。需在原 .c 文件中包含这个文件，通常是在 clinic 模块之后：

#include "clinic/_pickle.c.h"

请仔细检查 Argument Clinic 生成的参数解析代码，是否与原有代码基本相同。

首先，确保两种代码使用相同的参数解析函数。原有代码必须调用 PyArg_ParseTuple() 或 PyArg_ParseTupleAndKeywords() ；确保 Argument Clinic 生成的代码调用 完全 相同的函数。

其次，传给 PyArg_ParseTuple() 或 PyArg_ParseTupleAndKeywords() 的格式字符串应该 完全 与原有函数中的相同，直到冒号或分号为止。

（Argument Clinic 生成的格式串一定是函数名后跟着 :。如果现有代码的格式串以 ; 结尾，这种改动不会影响使用，因此不必担心。）

第三，如果格式单元需要指定两个参数（比如长度、编码字符串或指向转换函数的指针），请确保第二个参数在两次调用时 完全 相同。

第四，在输出部分会有一个预处理器宏，为该内置函数定义合适的静态 PyMethodDef 结构：

#define __PICKLE_PICKLER_DUMP_METHODDEF    \
{"dump", (PyCFunction)__pickle_Pickler_dump, METH_O, __pickle_Pickler_dump__doc__},

此静态结构应与本内置函数现有的静态结构 PyMethodDef 完全 相同。

只要上述这几点存在不一致，请调整 Argument Clinic 函数定义，并重新运行 Tools/clinic/clinic.py ，直至 完全 相同。

注意，输出部分的最后一行是“实现”函数的声明。也就是该内置函数的实现代码所在。删除需要修改的函数的现有原型，但保留开头的大括号。再删除其参数解析代码和输入变量的所有声明。注意现在 Python 所见的参数即为此实现函数的参数；如果实现代码给这些变量采用了不同的命名，请进行修正。

因为稍显怪异，所以还是重申一下。现在的代码应该如下所示：

static return_type
your_function_impl(...)
/*[clinic end generated code: checksum=...]*/
{
...

上面是 Argument Clinic 生成的校验值和函数原型。函数应该带有闭合的大括号，实现代码位于其中。

示例：

/*[clinic input]
module _pickle
class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
[clinic start generated code]*/
/*[clinic end generated code: checksum=da39a3ee5e6b4b0d3255bfef95601890afd80709]*/

/*[clinic input]
_pickle.Pickler.dump

    obj: 'O'
        The object to be pickled.
    /

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

PyDoc_STRVAR(__pickle_Pickler_dump__doc__,
"Write a pickled representation of obj to the open file.\n"
"\n"
...
static PyObject *
_pickle_Pickler_dump_impl(PicklerObject *self, PyObject *obj)
/*[clinic end generated code: checksum=3bd30745bf206a48f8b576a1da3d90f55a0a4187]*/
{
    /* Check whether the Pickler was initialized correctly (issue3664).
       Developers often forget to call __init__() in their subclasses, which
       would trigger a segfault without this check. */
    if (self->write == NULL) {
        PyErr_Format(PicklingError,
                     "Pickler.__init__() was not called by %s.__init__()",
                     Py_TYPE(self)->tp_name);
        return NULL;
    }

    if (_Pickler_ClearBuffer(self) < 0)
        return NULL;

    ...

还记得用到 PyMethodDef 结构的宏吧？找到函数中已有的 PyMethodDef 结构，并替换为宏的引用。（如果函数是模块级的，可能会在文件的末尾附近；如果函数是个类方法，则可能会在靠近实现代码的下方。)

注意，宏尾部带有一个逗号。所以若用宏替换已有的静态结构 PyMethodDef 时，请勿 在结尾添加逗号了。

示例：

static struct PyMethodDef Pickler_methods[] = {
    __PICKLE_PICKLER_DUMP_METHODDEF
    __PICKLE_PICKLER_CLEAR_MEMO_METHODDEF
    {NULL, NULL}                /* sentinel */
};

Compile, then run the relevant portions of the regression-test suite. This change should not introduce any new compile-time warnings or errors, and there should be no externally visible change to Python's behavior.

差别只有一个，即 inspect.signature() 运行于新的函数上，现在应该新提供一个有效的签名！

祝贺你，现在已经用 Argument Clinic 移植了第一个函数。

进阶

现在 Argument Clinic 的使用经验已具备了一些，该介绍一些高级内容了。

符号化默认值

提供给参数的默认值不能是表达式。目前明确支持以下形式：

数值型常数（整数和浮点数）。

字符串常量

True 、 False 和 None 。

以模块名开头的简单符号常量，如 sys.maxsize。

如果你感到好奇，这是在 from_builtin() ( Lib/inspect.py) 中实现的。

（未来可能需要加以细化，以便可以采用 CONSTANT - 1 之类的完整表达式。）

对 Argument Clinic 生成的 C 函数和变量进行重命名

Argument Clinic 会自动为其生成的函数命名。如果生成的名称与现有的 C 函数冲突，这偶尔可能会造成问题，有一个简单的解决方案：覆盖 C 函数的名称。只要在函数声明中加入关键字 "as" ，然后再加上要使用的函数名。Argument Clinic 将以该函数名为基础作为（生成的）函数名，然后在后面加上 "_impl"，并用作实现函数的名称。

例如，若对 pickle.Pickler.dump 生成的 C 函数进行重命名，应如下所示：

/*[clinic input]
pickle.Pickler.dump as pickler_dumper

...

原函数会被命名为 pickler_dumper()，而实现函数现在被命名为``pickler_dumper_impl()``。

同样的问题依然会出现：想给某个参数取个 Python 用名，但在 C 语言中可能用不了。Argument Clinic 允许在 Python 和 C 中为同一个参数取不同的名字，依然是利用 "as" 语法：

/*[clinic input]
pickle.Pickler.dump

    obj: object
    file as file_obj: object
    protocol: object = NULL
    *
    fix_imports: bool = True

这里 Python（签名和 keywords 数组中）中用的名称是 file，而 C 语言中的变量命名为 file_obj。

self 参数也可以进行重命名。

函数转换会用到 PyArg_UnpackTuple

若要将函数转换为采用 PyArg_UnpackTuple() 解析其参数，只需写出所有参数，并将每个参数定义为 object。可以指定 type 参数，以便能转换为合适的类型。所有参数都应标记为只认位置（在最后一个参数后面加上 /）。

目前，所生成的代码将会用到 PyArg_ParseTuple() ，但很快会做出改动。

可选参数组

有些过时的函数用到了一种让人头疼的函数解析方式：计算位置参数的数量，据此用 switch 语句进行各个不同的 PyArg_ParseTuple() 调用。（这些函数不能接受只认关键字的参数。）在没有 PyArg_ParseTupleAndKeywords() 之前，这种方式曾被用于模拟可选参数。

虽然这种函数通常可以转换为采用 PyArg_ParseTupleAndKeywords() 、可选参数和默认值的方式，但并不是全都可以做到。这些过时函数中， PyArg_ParseTupleAndKeywords() 并不能直接支持某些功能。最明显的例子是内置函数 range()，它的必需参数的 左 边存在一个可选参数！另一个例子是 curses.window.addch()，它的两个参数是一组，必须同时指定。（参数名为 x 和 y；如果调用函数时传入了 x，则必须同时传入``y``；如果未传入 x ，则也不能传入 y）。

不管怎么说，Argument Clinic 的目标就是在不改变语义的情况下支持所有现有 CPython 内置参数的解析。因此，Argument Clinic 采用所谓的 可选组 方案来支持这种解析方式。可选组是必须一起传入的参数组。他们可以在必需参数的左边或右边，只能 用于只认位置的参数。

注解

可选组 仅 适用于多次调用 PyArg_ParseTuple() 的函数！采用 任何 其他方式解析参数的函数，应该 几乎不 采用可选组转换为 Argument Clinic 解析。目前，采用可选组的函数在 Python 中无法获得准确的签名，因为 Python 不能理解这个概念。请尽可能避免使用可选组。

若要定义可选组，可在要分组的参数前面加上 [，在这些参数后加上``]`` ，要在同一行上。举个例子，下面是 curses.window.addch 采用可选组的用法，前两个参数和最后一个参数可选：

/*[clinic input]

curses.window.addch

    [
    x: int
      X-coordinate.
    y: int
      Y-coordinate.
    ]

    ch: object
      Character to add.

    [
    attr: long
      Attributes for the character.
    ]
    /

...

注释：

每一个可选组，都会额外传入一个代表分组的参数。 参数为 int 型，名为 group_{direction}_{number}，其中 {direction} 取决于此参数组位于必需参数 right 还是 left，而 {number} 是一个递增数字（从 1 开始），表示此参数组与必需参数之间的距离。 在调用函数时，若未用到此参数组则此参数将设为零，若用到了参数组则该参数为非零。 所谓的用到或未用到，是指在本次调用中形参是否收到了实参。

如果不存在必需参数，可选组的行为等同于出现在必需参数的右侧。

在模棱两可的情况下，参数解析代码更倾向于参数左侧（在必需参数之前）。

可选组只能包含只认位置的参数。

可选组 仅限 用于过时代码。请勿在新的代码中使用可选组。

采用真正的 Argument Clinic 转换器，而不是 “传统转换器”

为了节省时间，尽量减少要学习的内容，实现第一次适用 Argument Clinic 的移植，上述练习简述的是“传统转换器”的用法。“传统转换器”只是一种简便用法，目的就是更容易地让现有代码移植为适用于 Argument Clinic 。说白了，在移植 Python 3.4 的代码时，可以考虑采用。

不过从长远来看，可能希望所有代码块都采用真正的 Argument Clinic 转换器语法。原因如下：

合适的转换器可读性更好，意图也更清晰。

有些格式单元是“传统转换器”无法支持的，因为这些格式需要带上参数，而传统转换器的语法不支持指定参数。

后续可能会有新版的参数解析库，提供超过 PyArg_ParseTuple() 支持的功能；而这种灵活性将无法适用于传统转换器转换的参数。

因此，若是不介意多花一点精力，请使用正常的转换器，而不是传统转换器。

简而言之，Argument Clinic（非传统）转换器的语法看起来像是 Python 函数调用。但如果函数没有明确的参数（所有函数都取默认值），则可以省略括号。因此 bool 和 bool() 是完全相同的转换器。

Argument Clinic 转换器的所有参数都只认关键字。所有 Argument Clinic 转换器均可接受以下参数：

c_default

该参数在 C 语言中的默认值。具体来说，将是在“解析函数”中声明的变量的初始化器。用法参见 the section on default values 。定义为字符串。

annotation

参数的注解值。目前尚不支持，因为 PEP 8 [https://www.python.org/dev/peps/pep-0008] 规定 Python 库不得使用注解。

此外，某些转换器还可接受额外的参数。下面列出了这些额外参数及其含义：

accept

一些 Python 类型的集合（可能还有伪类型）；用于限制只接受这些类型的 Python 参数。（并非通用特性；只支持传统转换器列表中给出的类型）。

若要能接受 None，请在集合中添加 NoneType。

bitwise

仅用于无符号整数。写入形参的将是 Python 实参的原生整数值，不做任何越界检查，即便是负值也一样。

converter

仅用于 object 转换器。为某个 C 转换函数 指定名称，用于将对象转换为原生类型。

encoding

仅用于字符串。指定将 Python str(Unicode) 转换为 C 语言的 char * 时应该采用的编码。

subclass_of

仅用于 object 转换器。要求 Python 值是 Python 类型的子类，用 C 语言表示。

type

仅用于 object 和 self 转换器。指定用于声明变量的 C 类型。 默认值是 "PyObject *"。

zeroes

仅用于字符串。如果为 True，则允许在值中嵌入 NUL 字节（'\\0'）。字符串的长度将通过名为 <parameter_name>_length 的参数传入，跟在字符串参数的后面。

请注意，并不是所有参数的组合都能正常生效。通常这些参数是由相应的 PyArg_ParseTuple 格式单元 实现的，行为是固定的。比如目前不能不指定 bitwise=True 就去调用 unsigned_short。虽然完全有理由认为这样可行，但这些语义并没有映射到任何现有的格式单元。所以 Argument Clinic 并不支持。（或者说，至少目前还不支持。）

下表列出了传统转换器与真正的 Argument Clinic 转换器之间的映射关系。左边是传统的转换器，右边是应该换成的文本。

'B' | unsigned_char(bitwise=True)
'b' | unsigned_char
'c' | char
'C' | int(accept={str})
'd' | double
'D' | Py_complex
'es' | str(encoding='name_of_encoding')
'es#' | str(encoding='name_of_encoding', zeroes=True)
'et' | str(encoding='name_of_encoding', accept={bytes, bytearray, str})
'et#' | str(encoding='name_of_encoding', accept={bytes, bytearray, str}, zeroes=True)
'f' | float
'h' | short
'H' | unsigned_short(bitwise=True)
'i' | int
'I' | unsigned_int(bitwise=True)
'k' | unsigned_long(bitwise=True)
'K' | unsigned_long_long(bitwise=True)
'l' | long
'L' | long long
'n' | Py_ssize_t
'O' | object
'O!' | object(subclass_of='&PySomething_Type')
'O&' | object(converter='name_of_c_function')
'p' | bool
'S' | PyBytesObject
's' | str
's#' | str(zeroes=True)
's*' | Py_buffer(accept={buffer, str})
'U' | unicode
'u' | Py_UNICODE
'u#' | Py_UNICODE(zeroes=True)
'w*' | Py_buffer(accept={rwbuffer})
'Y' | PyByteArrayObject
'y' | str(accept={bytes})
'y#' | str(accept={robuffer}, zeroes=True)
'y*' | Py_buffer
'Z' | Py_UNICODE(accept={str, NoneType})
'Z#' | Py_UNICODE(accept={str, NoneType}, zeroes=True)
'z' | str(accept={str, NoneType})
'z#' | str(accept={str, NoneType}, zeroes=True)
'z*' | Py_buffer(accept={buffer, str, NoneType})

举个例子，下面是采用合适的转换器的例子 pickle.Pickler.dump：

/*[clinic input]
pickle.Pickler.dump

    obj: object
        The object to be pickled.
    /

Write a pickled representation of obj to the open file.
[clinic start generated code]*/

真正的转换器有一个优点，就是比传统的转换器更加灵活。例如，unsigned_int 转换器（以及所有 unsigned_ 转换器）可以不设置 bitwise=True 。 他们默认会对数值进行范围检查，而且不会接受负数。 用传统转换器就做不到这一点。

Argument Clinic 会列明其全部转换器。每个转换器都会给出可接受的全部参数，以及每个参数的默认值。只要运行 Tools/clinic/clinic.py --converters 就能得到完整的列表。

Py_buffer

在使用 Py_buffer 转换器（或者 's*'、'w*'、'*y' 或 'z*' 传统转换器）时，不可 在所提供的缓冲区上调用 PyBuffer_Release()。 Argument Clinic 生成的代码会自动完成此操作（在解析函数中）。

高级转换器

还记得编写第一个函数时跳过的那些格式单元吗，因为他们是高级内容？下面就来介绍这些内容。

其实诀窍在于，这些格式单元都需要给出参数——要么是转换函数，要么是类型，要么是指定编码的字符串。（但 “传统转换器”不支持参数。这就是为什么第一个函数要跳过这些内容）。为格式单元指定的参数于是就成了转换器的参数；参数可以是 converter``（对于 ``O&）、subclass_of``（对于 ``O!），或者是 encoding （对于 e 开头的格式单元）。

在使用 subclass_of 时，可能还需要用到 object() 的另一个自定义参数：type，用于设置参数的实际类型。例如，为了确保对象是 PyUnicode_Type 的子类，可能想采用转换器 object(type='PyUnicodeObject *', subclass_of='&PyUnicode_Type')。

Argument Clinic 用起来可能存在一个问题：丧失了 e 开头的格式单位的一些灵活性。在手工编写 PyArg_Parse 调用时，理论上可以在运行时决定传给 PyArg_ParseTuple() 的编码字符串。但现在这个字符串必须在 Argument-Clinic 预处理时进行硬编码。这个限制是故意设置的；以便简化对这种格式单元的支持，并允许以后进行优化。这个限制似乎并不合理；CPython 本身总是为 e 开头的格式单位参数传入静态的硬编码字符串。

参数的默认值

参数的默认值可以是多个值中的一个。最简单的可以是字符串、int 或 float 字面量。

foo: str = "abc"
bar: int = 123
bat: float = 45.6

还可以使用 Python 的任何内置常量。

yep:  bool = True
nope: bool = False
nada: object = None

对默认值 NULL 和简单表达式还提供特别的支持，下面将一一介绍。

默认值 NULL

对于字符串和对象参数而言，可以设为 None，表示没有默认值。但这意味着会将 C 变量初始化为 Py_None。为了方便起见，提供了一个特殊值 NULL，目的就是为了让 Python 认为默认值就是 None，而 C 变量则会初始化为 NULL。

设为默认值的表达式

参数的默认值不仅可以是字面量。还可以是一个完整的表达式，可采用数学运算符及对象的属性。但这种支持并没有那么简单，因为存在一些不明显的语义。

请考虑以下例子：

foo: Py_ssize_t = sys.maxsize - 1

sys.maxsize 在不同的系统平台可能有不同的值。因此，Argument Clinic 不能简单地在本底环境对表达式求值并用 C 语言硬编码。所以默认值将用表达式的方式存储下来，运行的时候在请求函数签名时会被求值。

在对表达式进行求值时，可以使用什么命名空间呢？求值过程运行于内置模块的上下文中。 因此，如果模块带有名为 max_widgets 的属性，直接引用即可。

foo: Py_ssize_t = max_widgets

如果表达式不在当前模块中，就会去 sys.modules 查找。比如 sys.maxsize 就是如此找到的。（因为事先不知道用户会加载哪些模块到解释器中，所以最好只用到 Python 会预加载的模块。）

仅当运行时才对缺省值求值，意味着 Argument Clinic 无法计算出正确的 C 缺省值。所以需显式给出。在使用表达式时，必须同时用转换器的``c_default`` 参数指定 C 语言中的等价表达式。

foo: Py_ssize_t(c_default="PY_SSIZE_T_MAX - 1") = sys.maxsize - 1

还有一个问题也比较复杂。Argument Clinic 无法事先知道表达式是否有效。 解析只能保证看起来是有效值，但无法 实际 知晓。在用表达式时须十分小心，确保在运行时能得到有效值。

最后一点，由于表达式必须能表示为静态的 C 语言值，所以存在许多限制。 以下列出了不得使用的 Python 特性：

功能

行内 if 语句（3 if foo else 5 ）

序列类自动解包（*[1, 2, 3]）

列表、集合、字典的解析和生成器表达式。

元组、列表、集合、字典的字面量

返回值转换器

Argument Clinic 生成的植入函数默认会返回 PyObject *。但是通常 C 函数的任务是要对某些 C 类型进行计算，然后将其转换为 PyObject * 作为结果。Argument Clinic 可以将输入参数由 Python 类型转换为本地 C 类型——为什么不让它将返回值由本地 C 类型转换为 Python 类型呢？

这就是“返回值转换器”的用途。它将植入函数修改成返回某种 C 语言类型，然后在生成的（非植入）函数中添加代码，以便将 C 语言值转换为合适的 PyObject *。

返回值转换器的语法与参数转换器的类似。返回值转换器的定义方式，类似于函数返回值的注解。返回值转换器的行为与参数转换器基本相同，接受参数，参数只认关键字，如果不修改默认参数则可省略括号。

（如果函数同时用到了 "as" 和返回值转换器， "as" 应位于返回值转换器之前。）

返回值转换器还存在一个复杂的问题：出错信息如何表示？通常函数在执行成功时会返回一个有效（非 NULL）指针，失败则返回 NULL。但如果使用了整数的返回值转换器，所有整数都是有效值。Argument Clinic 怎么检测错误呢？解决方案是：返回值转换器会隐含寻找一个代表错误的特殊值。如果返回该特殊值，且设置了出错标记（ PyErr_Occurred() 返回 True），那么生成的代码会传递该错误。否则，会对返回值进行正常编码。

目前 Argument Clinic 只支持少数几种返回值转换器。

bool
int
unsigned int
long
unsigned int
size_t
Py_ssize_t
float
double
DecodeFSDefault

这些转换器都不需要参数。前3个转换器如果返回 -1 则表示出错。DecodeFSDefault 的返回值类型是 const char *；若返回 NULL 指针则表示出错。

（还有一个 NoneType 转换器是实验性质的，成功时返回 Py_None ，失败则返回 NULL，且不会增加 Py_None 的引用计数。此转换器是否值得适用，尚不明确）。

只要运行 Tools/clinic/clinic.py --converters ，即可查看 Argument Clinic 支持的所有返回值转换器，包括其参数。

克隆已有的函数

如果已有一些函数比较相似，或许可以采用 Clinic 的“克隆”功能。 克隆之后能够复用以下内容：

参数，包括：

名称

转换器（带有全部参数）

默认值

参数前的文档字符串

类别 （只认位置、位置或关键字、只认关键字）

返回值转换器

唯一不从原函数中复制的是文档字符串；这样就能指定一个新的文档串。

下面是函数的克隆方法：

/*[clinic input]
module.class.new_function [as c_basename] = module.class.existing_function

Docstring for new_function goes here.
[clinic start generated code]*/

（原函数可以位于不同的模块或类中。示例中的 module.class 只是为了说明，两个 函数都必须使用全路径）。

对不起，没有用于部分克隆某个函数、或克隆某个函数并对其进行修改的语法。 克隆是一个只有全部和全无两种选项的操作。

另外，要克隆的函数必须在当前文件中已有定义。

调用 Python 代码

下面的高级内容需要编写 Python 代码，存于 C 文件中，并修改 Argument Clinic 的运行状态。其实很简单：只需定义一个 Python 块。

Python 块的分隔线与 Argument Clinic 函数块不同。如下所示：

/*[python input]
# python code goes here
[python start generated code]*/

Python 块内的所有代码都会在解析时执行。块内写入 stdout 的所有文本都被重定向到块后的“输出”部分。

以下例子包含了 Python 块，用于在 C 代码中添加一个静态整数变量：

/*[python input]
print('static int __ignored_unused_variable__ = 0;')
[python start generated code]*/
static int __ignored_unused_variable__ = 0;
/*[python checksum:...]*/

self 转换器的用法

Argument Clinic 用一个默认的转换器自动添加一个“self”参数。自动将 self 参数的 type 设为声明类型时指定的“指向实例的指针”。不过 Argument Clinic 的转换器可被覆盖，也即自己指定一个转换器。只要将自己的 self 参数作为块的第一个参数即可，并确保其转换器是 self_converter 的实例或其子类。

这有什么用呢？可用于覆盖 self 的类型，或为其给个不同的默认名称。

如何指定 self 对应的自定义类型呢？如果只有 self 类型相同的一两个函数，可以直接使用 Argument Clinic 现有的 self 转换器，把要用的类型作为 type 参数传入：

/*[clinic input]

_pickle.Pickler.dump

  self: self(type="PicklerObject *")
  obj: object
  /

Write a pickled representation of the given object to the open file.
[clinic start generated code]*/

如果有很多函数将使用同一类型的 self，则最好创建自己的转换器，继承自 self_converter 类但要覆盖其 type 成员：

/*[python input]
class PicklerObject_converter(self_converter):
    type = "PicklerObject *"
[python start generated code]*/

/*[clinic input]

_pickle.Pickler.dump

  self: PicklerObject
  obj: object
  /

Write a pickled representation of the given object to the open file.
[clinic start generated code]*/

“定义类”转换器

Argument Clinic 为访问方法定义所在的类提供了便利。因为 heap type 方法需要获取模块级的运行状态，所以就十分有用。PyType_FromModuleAndSpec() 会将堆类型与模块关联起来。然后类就可用 PyType_GetModuleState() 获取模块状态了，比如利用模块的方法进行获取。

示例来自 Modules/zlibmodule.c。首先，在 clinic 的输入块添加 defining_class ：

/*[clinic input]
zlib.Compress.compress

  cls: defining_class
  data: Py_buffer
    Binary data to be compressed.
  /

运行 Argument Clinic 工具后，会生成以下函数签名：

/*[clinic start generated code]*/
static PyObject *
zlib_Compress_compress_impl(compobject *self, PyTypeObject *cls,
                            Py_buffer *data)
/*[clinic end generated code: output=6731b3f0ff357ca6 input=04d00f65ab01d260]*/

现在，以下代码可以用 PyType_GetModuleState(cls) 获取模块状态了：

zlibstate *state = PyType_GetModuleState(cls);

每个方法只能有一个参数用到转换器，且须位于 self 之后 ，若未用到 self 则为第一个参数。该参数的类型为 PyTypeObject *。__text_signature__ 中不会包含该参数。

defining_class 转换器与 __init__ 及 __new__ 方法不兼容，他们不能使用 METH_METHOD 。

在插槽方法中无法使用 defining_class。为了能从插槽方法中获取模块的状态，请先用 _PyType_GetModuleByDef 进行模块定位，然后再用 PyModule_GetState() 获取。以下示例来自 Modules/_threadmodule.c 的 setattro 方法：

static int
local_setattro(localobject *self, PyObject *name, PyObject *v)
{
    PyObject *module = _PyType_GetModuleByDef(Py_TYPE(self), &thread_module);
    thread_module_state *state = get_thread_state(module);
    ...
}

参见 PEP 573 [https://www.python.org/dev/peps/pep-0573]。

编写自定义转换器

上一节中已有提及……可以编写自己的转换器！转换器就是一个继承自``CConverter`` 的 Python 类。假如有个参数采用了 O& 格式，对此参数进行解析就会去调用某个“转换器函数” PyArg_ParseTuple() ，也就会用到自定义转换器。

自定义转换器类应命名为 *something*_converter。只要按此规则命名，自定义转换器类就会在 Argument Clinic 中自动注册；转换器的名称就是去除了 _converter 后缀的类名。（通过元类完成）。

不得由 CConverter.__init__ 派生子类。而应编写一个 converter_init() 函数。converter_init() 必须能接受一个 self 参数；所有后续的其他参数 必须 是只认关键字的参数。传给 Argument Clinic 转换器的所有参数都会传入自定义 converter_init() 函数。

CConverter 的其他一些成员，可能需要在自定义子类中定义。下面列出了目前的成员：

type

变量要采用的 C 语言数据类型。type 应为 int 之类的 Python 字符串，用于指定变量的类型。若为指针类型，则字符串应以 ' *' 结尾。

default

该参数的缺省值，为 Python 数据类型。若无缺省值，则为 unspecified。

py_default

用 Python 代码表示的 default ，为字符串类型。若无缺省值，则为 None 。

c_default

用 C 代码表示的 default， 为字符串类型。若无缺省值，则为 None 。

c_ignored_default

在无默认值时用于初始化 C 变量的默认值，不指定默认值可能会导致 "变量未初始化" 警告。 这在使用选项组时很容易发生 — 尽管编写合理的代码将永远不会真的使用这个值，但该变量确实会被传入 impl，而 C 编译器将会报告 "使用了" 未初始化的值。 这个值应当总是一个非空字符串。

converter

C 转换器的名称，字符串类型。

impl_by_reference

布尔值。如果为 True，则 Argument Clinic 在将变量传入 impl 函数时，会在其名称前加上一个 &。

parse_by_reference

一个布尔值。 如果为真，则 Argument Clinic 在将其传入 PyArg_ParseTuple() 时将在变量名之前添加一个 &。

下面是最简单的自定义转换器示例，取自 Modules/zlibmodule.c ：

/*[python input]

class ssize_t_converter(CConverter):
    type = 'Py_ssize_t'
    converter = 'ssize_t_converter'

[python start generated code]*/
/*[python end generated code: output=da39a3ee5e6b4b0d input=35521e4e733823c7]*/

这个代码块为 Argument Clinic 添加了一个名为 ssize_t 的转换器。 声明为 ssize_t 的形参将被声明为 Py_ssize_t 类型，并将由 'O&' 格式单元来解析，它将调用 ssize_t_converter 转换器函数。 ssize_t 变量会自动支持默认值。

更复杂些的自定义转换器，可以插入自定义 C 代码来进行初始化和清理工作。可以在 CPython 源码中看到自定义转换器的更多例子；只要在 C 文件中搜索字符串 CConverter 即可。

编写自定义的返回值转换器

自定义的返回值转换器的写法，与自定义的转换器十分类似。因为返回值转换器本身就很简单，编写起来就简单一些。

返回值转换器必须是 CReturnConverter 的子类。因为自定义的返回值转换器还没有广泛应用，目前还没有示例。若要编写返回值转换器，请阅读``Tools/clinic/clinic.py`` ，特别是 CReturnConverter 及其所有子类的实现代码。

METH_O 和 METH_NOARGS

若要用 METH_O 对函数进行转换，请确保对该函数的单个参数使用 object 转换器，并将参数标为只认位置的：

/*[clinic input]
meth_o_sample

     argument: object
     /
[clinic start generated code]*/

若要用 METH_NOARGS 对函数进行转换，只需不定义参数即可。

依然可以采用一个 self 转换器、一个返回值转换器，并为 METH_O 的对象转换器指定一个 type 参数。

tp_new 和 tp_init functions

tp_new 和 tp_init 函数也可以转换。只要命名为 __new__ 或 __init__ 即可。注意：

为转换 __new__ 而生成的函数名不会以其默认名称结尾。只会是转换为合法 C 标识符的类名。

转换这些函数不会生成 PyMethodDef 、#define。

__init__ 函数将返回 int ，而不是 PyObject * 。

将文档字符串用作类文档字符串。

虽然 __new__ 和 __init__ 函数必须以 args 和 kwargs 对象作为参数，但在转换时可按个人喜好定义函数签名。（如果原函数不支持关键字参数，则生成的解析函数在收到关键字参数时会抛出异常）。

改变和重定向 Clinic 的输出

若是让 Clinic 的输出与传统的手写 C 代码交织在一起，可能会不方便阅读。 幸好可以对 Clinic 进行配置：可以将输出结果缓存起来以供输出，或将输出结果写入文件中。针对 Clinic 生成的输出结果，还可以为每一行都加上前缀或后缀。

虽然修改 Clinic 的输出提升了可读性，但可能会导致 Clinic 代码使用了未经定义的类型，或者会提前用到 Clinic 生成的代码。通过重新安排声明在代码文件的位置，或将 Clinic 生成的代码移个位置，即可轻松解决上述问题。（这就是 Clinic 默认是全部输出到当前代码块的原因；虽然许多人认为降低了可读性，但这样就根本不用重新编排代码来解决提前引用的问题）。

就从定义一些术语开始吧：

** 区块（field）**

在当前上下文中，区块是指 Clinic 输出的一个小节。例如，PyMethodDef 结构的 #define 是一个区块，名为 methoddef_define。Clinic 可为每个函数定义输出7个区块。

docstring_prototype
docstring_definition
methoddef_define
impl_prototype
parser_prototype
parser_definition
impl_definition

区块均以 "<a>_<b>" 形式命名，其中 "<a>" 是所代表的语义对象（解析函数、impl 函数、文档字符串或 methoddef 结构），"<b>" 表示该区块的类别。以 "_prototype" 结尾的区块名表示这只是个前向声明，没有实际的函数体或数据；以 "_definition" 结尾的区块名则表示这是实际的函数定义，包含了函数体和数据。（"methoddef" 比较特殊，是唯一一个以 "_define" 结尾的区块名，表明这是一个预处理器 #define。）

** 输出目标（destination）**

输出目标是 Clinic 可以进行输出的地方。内置的输出目标有5种：

block

默认的输出目标：在 Clinic 当前代码块的输出区域进行输出。

buffer

文本缓冲区，可将文本保存起来以便后续使用。输出的文本会加入现有文本的末尾。如果 Clinic 处理完文件后缓冲区中还留有文本，则会报错。

file

单独的 “Clinic 文件”，由 Clinic 自动创建。文件名会是``{basename}.clinic{extension}`` ，这里的 basename 和 extension 即为对当前文件运行 os.path.splitext() 后的结果。（比如：_pickle.c 的 file 目的地将会是 _pickle.clinic.c)。

重点：若要使用 ** ``file`` ** 作为输出目标，你 ** *必须签入* ** 生成的文件！

two-pass

类似于 buffer 的缓冲区。不过 two-pass 缓冲区只能转储一次，将会输出处理过程中发送给它的所有文本，甚至包括转储点**之后**的 Clinic 块。

suppress

禁止输出文本——抛弃输出。

Clinic 定义了5个新的指令，以便修改输出方式。

第一个新指令是 dump：

dump <destination>

将指定输出目标的当前内容转储到当前块的输出中，并清空输出目标。仅适用于 buffer 和 two-pass 目标。

第二个新指令是 output。output 最简单的格式如下所示：

output <field> <destination>

这会通知 Clinic 将指定**field**输出到指定**destination**中去。output 还支持一个特殊的元目标 everything，通知 Clinic 将**所有**区块都输出到该**目标**。

output 还包含一些函数：

output push
output pop
output preset <preset>

output push 和 output pop 能在内部的配置栈中压入和弹出配置，这样就可以临时修改输出配置，然后再轻松恢复之前的配置。只需在修改前入栈保存当前配置，在恢复配置时再弹出即可。

output preset 将 Clinic 的输出目标设为内置预设目标之一，如下所示：

block

Clinic 的初始设置。输入块后面紧接着写入所有内容。

关闭 parser_prototype 和 docstring_prototype，并将其他所有内容写入 block。

file

目的是全部输出至 “Clinic 文件”中。然后在文件顶部附近 #include 该文件。可能需要重新调整代码顺序才能正常运行，通常只要为 typedef``和``PyTypeObject 定义创建前向声明即可。

关闭 parser_prototype 和 docstring_prototype ，将 impl_definition 写入 block，其他内容写入 file 。

默认文件名为 "{dirname}/clinic/{basename}.h" 。

buffer

将 Clinic 的大部分输出保存起来，在快结束时写入文件。如果 Python 文件存放的是编写模块或内置类型的代码，建议紧挨着模块或内置类型的静态结构之前对缓冲区进行转储；这些结构通常位于结尾附近。如果在文件的中间位置定义了静态 PyMethodDef 数组，采用 buffer 输出所需的代码编辑工作可能比用 file 要多些。

关闭 parser_prototype 、impl_prototype 和 docstring_prototype，将 impl_definition 写入 block，其他输出都写入 file。

two-pass

类似于预设的 buffer 输出，但会把前向声明写入 two-pass 缓冲区，将函数定义写入 buffer。这与预设的 buffer 类似，但所需的代码编辑工作可能会减少。将 two-pass 缓冲区转储到文件的顶部，将 buffer 转储到文件末尾，就像预设的 buffer 一样。

关闭 impl_prototype ，将 impl_definition 写入 block ，将 docstring_prototype 、 methoddef_define 和 parser_prototype 写入 two-pass，其他输出都写入 buffer 。

partial-buffer

与预设的 buffer 类似，但会向 block 写入更多内容，而只向 buffer 写入真正大块的生成代码。这样能完全避免 buffer 的提前引用问题，代价是输出到代码块中的内容会稍有增加。在快结束时会转储 buffer，就像采用预设的 buffer 配置一样。

关闭 impl_prototype，将 docstring_definition 和 parser_definition 写入 buffer，其他输出都写入 block。

第三个新指令是 destination：

destination <name> <command> [...]

向名为 name 的目标执行输出。

定义了两个子命令：new 和 clear。

子命令 new 工作方式如下：

destination <name> new <type>

新建一个目标，名称为 <name>，类型为 <type> 。

输出目标的类型有5种：

suppress

忽略文本。

block

将文本写入当前代码块中。 这就是 Clinic 原来的做法。

buffer

简单的文本缓冲区，就像上述的内置 “buffer” 目标。

file

文本文件。文件目标多了一个参数，模板用于生成文件名，类似于：

destination <name> new <type> <file_template>

模版可以引用3个内部字符串，将会用文件名的对应部分替代：

{path}

文件的全路径，包含文件夹和完整的文件名。

{dirname}

文件所在文件夹名。

{basename}

只有文件名，不含文件夹。

{basename_root}

去除了扩展名后的文件名（不含最后一个“.”）。

{basename_extension}

包含最后一个“.”及后面的字符。如果文件名中不含句点，则为空字符串。

如果文件名中不含句点符，{basename} 和 {basename_root} 是一样的，而 {basename_extension} 则为空。“{basename_root}{basename_extension}” 与“{basename}”一定是完全相同的。（英文原文貌似有误）

two-pass

two-pass 缓冲区，类似于上述的内置“two-pass”输出目标。

子命令 clear 的工作方式如下：

destination <name> clear

清空输出目标中所有文本。（不知用途何在，但也许做实验时会有用吧。)

第4个新指令是 set ：

set line_prefix "string"
set line_suffix "string"

set' 能设置 Clinic 的两个内部变量值。``line_prefix` 是 Clinic 每行输出的前缀字符串；line_suffix 是 Clinic 每行输出的后缀字符串。

两者都支持两种格式字符串：

{block comment start}

转成字符串 /*，是 C 文件的注释起始标记。

{block comment end}

转成字符串 */，是 C 文件的注释结束标记。

最后一个新指令是无需直接使用的 preserve。

preserve

通知 Clinic 输出内容应保持原样。这是在转储至 file 文件中时，供 Clinic 内部使用的；以便 Clinic 能利用已有的校验函数，确保文件在被覆盖之前没进行人工修改过。

#ifdef 使用技巧

若要转换的函数并非通用于所有平台，可以采用一个技巧。当前代码可能如下所示：

#ifdef HAVE_FUNCTIONNAME
static module_functionname(...)
{
...
}
#endif /* HAVE_FUNCTIONNAME */

在底部的 PyMethodDef 结构中，当前代码如下：

#ifdef HAVE_FUNCTIONNAME
{'functionname', ... },
#endif /* HAVE_FUNCTIONNAME */

这时应将 impl 函数体用 #ifdef 包裹起来，如下所示：

#ifdef HAVE_FUNCTIONNAME
/*[clinic input]
module.functionname
...
[clinic start generated code]*/
static module_functionname(...)
{
...
}
#endif /* HAVE_FUNCTIONNAME */

然后，从 PyMethodDef 结构中删除以下3行，替换成 Argument Clinic 生成的宏：

MODULE_FUNCTIONNAME_METHODDEF

（在生成的代码中可找到宏的真实名称。或者可以自行求一下值：块的第一行定义的函数名，句点改为下划线，全部大写，并在末尾加上 "_METHODDEF" ）

如果 HAVE_FUNCTIONNAME 未定义怎么办？ 那么 MODULE_FUNCTIONNAME_METHODDEF 宏也不会定义。

这正是 Argument Clinic 变聪明的地方。它其实能检测到 #ifdef 屏蔽了Argument Clinic 块。于是会额外生成一小段代码，如下所示：

#ifndef MODULE_FUNCTIONNAME_METHODDEF
    #define MODULE_FUNCTIONNAME_METHODDEF
#endif /* !defined(MODULE_FUNCTIONNAME_METHODDEF) */

这样宏总是会生效。如果定义了函数，则会转换为正确的结构，包括尾部的逗号。如果函数未定义，就不做什么转换。

不过，这导致了一个棘手的问题：当使用 "block" 输出预设时 Argument Clinic 应该把额外的代码放到哪里呢？ 它不能放在输出代码块中，因为它可能会被 #ifdef 停用。 （它的作用就是这个！）

在此情况下，Argument Clinic 会将额外的代码的写入目标设为 "buffer"。 这意味着你可能会收到来自 Argument Clinic 的抱怨:

Warning in file "Modules/posixmodule.c" on line 12357:
Destination buffer 'buffer' not empty at end of file, emptying.

当发生这种问题时，只需打开你的文件，找到由 Argument Clinic 添加到你的文件的 dump buffer 代码块（它将位于文件末尾），并将其移到使用了那个宏的 PyMethodDef 结构体之上。

在 Python 文件中使用 Argument Clinic

实际上使用 Argument Clinic 来预处理 Python 文件也是可行的。 当然使用 Argument Clinic 代码块并没有什么意义，因为其输出对于 Python 解释器来说是没有意义的。 但是使用 Argument Clinic 来运行 Python 代码块可以让你将 Python 当作 Python 预处理器来使用！

由于 Python 注释不同于 C 注释，嵌入到 Python 文件的 Argument Clinic 代码块看起来会有一点不同。 它们看起来像是这样:

#/*[python input]
#print("def foo(): pass")
#[python start generated code]*/
def foo(): pass
#/*[python checksum:...]*/

使用 DTrace 和 SystemTap 检测CPython

作者

David Malcolm

作者

Łukasz Langa

DTrace和SystemTap是监控工具，它们都提供了一种检查计算机系统上的进程的方法。 它们都使用特定领域的语言，允许用户编写脚本，其中：

进程监视的过滤器

从感兴趣的进程中收集数据

生成有关数据的报告

从Python 3.6开始，CPython可以使用嵌入式“标记”构建，也称为“探测器”，可以通过DTrace或SystemTap脚本观察，从而更容易监视系统上的CPython进程正在做什么。

CPython 实现细节： DTrace标记是CPython解释器的实现细节。 不保证CPython版本之间的探针兼容性。 更改CPython版本时，DTrace脚本可能会停止工作或无法正常工作而不会发出警告。

启用静态标记

macOS内置了对DTrace的支持。 在Linux上，为了使用SystemTap的嵌入式标记构建CPython，必须安装SystemTap开发工具。

在Linux机器上，这可以通过：

$ yum install systemtap-sdt-devel

或者：

$ sudo apt-get install systemtap-sdt-dev

之后 CPython 必须 配置 --with-dtrace 选项:

checking for --with-dtrace... yes

在macOS上，您可以通过在后台运行Python进程列出可用的DTrace探测器，并列出Python程序提供的所有探测器：

$ 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

在Linux上，您可以通过查看是否包含“.note.stapsdt”部分来验证构建的二进制文件中是否存在SystemTap静态标记。

$ readelf -S ./python | grep .note.stapsdt
[30] .note.stapsdt        NOTE         0000000000000000 00308d78

如果你将 Python 编译为共享库（使用 --enable-shared 配置选项），那么你需要改为在共享库内部查看。 例如:

$ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt
[29] .note.stapsdt        NOTE         0000000000000000 00365b68

足够现代的readelf命令可以打印元数据：

$ 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

上述元数据包含 SystemTap 信息，它描述了如何修补策略性放置的机器码指令以启用 SystemTap 脚本所使用的跟踪钩子。

静态DTrace探针

下面的 DTrace 脚本示例可以用来显示一个 Python 脚本的调用/返回层次结构，只在调用名为 "start" 的函数内进行跟踪。换句话说，导入时的函数调用不会被列出。

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;
}

它可以这样调用:

$ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"

输出结果会像这样:

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

静态SystemTap标记

使用 SystemTap 集成的底层方法是直接使用静态标记。 这需要你显式地说明包含它们的二进制文件。

例如，这个SystemTap脚本可以用来显示Python脚本的调用/返回层次结构：

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);
}

它可以这样调用:

$ stap \
  show-call-hierarchy.stp \
  -c "./python test.py"

输出结果会像这样:

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

其中的列是：

脚本开始后经过的微秒数

可执行文件的名字

进程的PID

其余部分则表示脚本执行时的调用/返回层次结构。

对于 CPython 的 --enable-shared 编译版，这些标记包含在 libpython 共享库内部，并且 probe 的加点路径需要反映这个。 例如，上述示例的这一行:

probe process("python").mark("function__entry") {

应改为：

probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") {

(假定为 CPython 3.6 的 调试编译版)

可用的静态标记

function__entry(str filename, str funcname, int lineno)

这个标记表示一个Python函数的执行已经开始。它只对纯 Python （字节码）函数触发。

文件名、函数名和行号作为位置参数提供给跟踪脚本，必须使用 $arg1, $arg2, $arg3 访问：

$arg1 : (const char *) 文件名，使用 user_string($arg1) 访问

$arg2 : (const char *) 函数名，使用 user_string($arg2) 访问

$arg3 : int 行号

function__return(str filename, str funcname, int lineno)

这个标记与 function__entry() 相反，表示Python函数的执行已经结束 (通过 return 或者异常)。 它只对纯Python (字节码) 函数触发。

参数和 function__entry() 相同

line(str filename, str funcname, int lineno)

这个标记表示一个 Python 行即将被执行。它相当于用 Python 分析器逐行追踪。它不会在C函数中触发。

参数和 function__entry() 相同

gc__start(int generation)

当Python解释器启动一个垃圾回收循环时被触发。 arg0 是要扫描的生成器，如 gc.collect()。

gc__done(long collected)

当Python解释器完成一个垃圾回收循环时被触发。arg0 是收集到的对象的数量。

import__find__load__start(str modulename)

在 importlib 试图查找并加载模块之前被触发。arg0 是模块名称。

3.7 新版功能.

import__find__load__done(str modulename, int found)

在 importlib 的 find_and_load 函数被调用后被触发 。arg0 是模块名称， arg1 表示模块是否成功加载。

3.7 新版功能.

audit(str event, void *tuple)

当 sys.audit() 或 PySys_Audit() 被调用时启动。 arg0 是事件名称的 C 字符串，arg1 是一个指向元组对象的 PyObject 指针。

3.8 新版功能.

SystemTap Tapsets

使用SystemTap集成的更高层次的方法是使用 "tapset" 。SystemTap 的等效库，它隐藏了静态标记的一些底层细节。

这里是一个基于 CPython 的非共享构建的 tapset 文件。

/*
   Provide a higher-level wrapping around the function__entry and
   function__return markers:
 \*/
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
}

如果这个文件安装在 SystemTap 的 tapset 目录下（例如 /usr/share/systemtap/tapset ），那么这些额外的探测点就会变得可用。

python.function.entry(str filename, str funcname, int lineno, frameptr)

这个探针点表示一个Python函数的执行已经开始。它只对纯Python （字节码）函数触发。

python.function.return(str filename, str funcname, int lineno, frameptr)

这个探针点是 python.function.return 的反义操作，表示一个 Python 函数的执行已经结束（或是通过 return，或是通过异常）。 它只会针对纯 Python（字节码）函数触发。

例子

这个SystemTap脚本使用上面的tapset来更清晰地实现上面给出的跟踪Python函数调用层次结构的例子，而不需要直接命名静态标记。

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);
}

下面的脚本使用上面的 tapset 来提供所有运行中的 CPython 代码的类似 top 的视图，显示了整个系统中每一秒内前 20 个最频繁进入的字节码帧:

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;
}

注解最佳实践

作者

Larry Hastings

摘要

本文档旨在概括与注解字典打交道的最佳实践。查看 Python 对象的 __annotations__ 的代码应遵循下面的准则。

本文档按四部分组织：在 3.10 及更高版本的 Python 中查看对象注解的最佳实践、在 3.9 及更低版本的 Python 中查看对象注解的最佳实践、其它一些适于任何版本的 Python 的 __annotations__ 的最佳实践、__annotations__ 的一些“坑”。

本文是 __annotations__ 的文档，不是注解的用法。如果在寻找如何使用“类型提示”，请参阅 typing 模块。

在 3.10 及更高版本的 Python 中访问对象的注解字典

Python 3.10 在标准库中加入了一个新函数：inspect.get_annotations()。在 3.10 及更高版本的 Python 中，调用该函数就是访问任何支持注解的对象的注解字典的最佳实践。该函数还可以为你“解析”字符串化了的注解。

不用 inspect.get_annotations() 也可以手动访问``__annotations__`` 这一数据成员。该方法的最佳实践在 Python 3.10 中也发生了变化：从 Python 3.10 开始，对于 Python 函数、类和模块，o.__annotations__ 保证 会正常工作。只要你确信所检查的对象是这三种之一，你便可以用 o.__annotations__ 获取该对象的注解字典。

不过，其它类型的可调用对象可不一定定义了 __annotations__ 属性，就比如说，functools.partial() 创建的可调用对象。当访问某个未知对象的 __annotations__ 时，3.10 及更高版本的 Python 中的最佳实践是用三个参数去调用 getattr()，像 getattr(o, '__annotations__', None) 这样。

Python 3.10 之前，在一个没定义注解而其父类定义了注解的类上访问 __annotations__ 将返回父类的 __annotations__。在 3.10 及更高版本的 Python 中，这样的子类的注解是个空字典。

在 3.9 及更低版本的 Python 中访问对象的注解字典

在 3.9 及更低版本的 Python 中访问对象的注解字典要比新版复杂。这是低版本 Python 的设计缺陷，特别是类的注解。

访问其它对象——函数、其它可调用对象和模块——的注解字典的最佳实践与 3.10 版本相同，如果不用 inspect.get_annotations()，就用三个参数去调用 getattr() 以访问对象的 __annotations__ 属性。

不幸的是，对类而言，这并不是最佳实践。问题在于，由于 __annotations__ 在某个类上是可有可无的，而类又可以从基类继承属性，所以访问某个类的 __annotations__ 属性可能会无意间返回 基类 的注解字典。如：

class Base:
    a: int = 3
    b: str = 'abc'

class Derived(Base):
    pass

print(Derived.__annotations__)

会打印出 Base 的注解字典，而非 Derived 的。

若待检查的对象是类（即 isinstance(o, type)），代码不得不另辟蹊径。这时的最佳实践依赖于 3.9 及更低版本的 Python 中的一处实现细节：若类定义了注解，则注解会被放入类的 __dict__ 字典。类不一定有注解，故最佳实践是在类的字典上调用 get 方法。

综上所述，下面给出一些示例代码，可以在 Python 3.9 及之前版本安全地访问任意对象的 __annotations__ 属性：

if isinstance(o, type):
    ann = o.__dict__.get('__annotations__', None)
else:
    ann = getattr(o, '__annotations__', None)

运行之后，ann 应为一个字典对象或 None。建议在继续之前，先用 isinstance() 再次检查 ann 的类型。

请注意，有些特殊的或畸形的类型对象可能没有 __dict__ 属性，为了以防万一，可能还需要用 getattr() 来访问 __dict__。

解析字符串形式的注解

有时注释可能会被“字符串化”，解析这些字符串可以求得其所代表的 Python 值，最好是调用 inspect.get_annotations() 来完成这项工作。

如果是 Python 3.9 及之前的版本，或者由于某种原因无法使用 inspect.get_annotations() ，那就需要重现其代码逻辑。建议查看一下当前 Python 版本中 inspect.get_annotations() 的实现代码，并遵照实现。

简而言之，假设要对任一对象解析其字符串化的注释 o ：

如果 o 是个模块，在调用 eval() 时，o.__dict__ 可视为 globals 。

如果 o 是一个类，在调用 eval() 时，sys.modules[o.__module__].__dict__ 视作 globals，dict(vars(o)) 视作 locals 。

如果 o 是一个用 functools.update_wrapper() 、 functools.wraps() 或 functools.partial() 封装的可调用对象，可酌情访问 o.__wrapped__ 或 o.func 进行反复解包，直到你找到未经封装的根函数。

如果 o 是个可调用对象（但不是一个类），在调用 eval() 时，o.__dict__ 可视为 globals 。

但并不是所有注解字符串都可以通过 eval() 成功地转化为 Python 值。理论上，注解字符串中可以包含任何合法字符串，确实有一些类型提示的场合，需要用到特殊的 无法 被解析的字符串来作注解。比如：

在 Python 支持 PEP 604 [https://www.python.org/dev/peps/pep-0604] 的联合类型 | (Python 3.10) 之前使用它。

运行时用不到的定义，只在 typing.TYPE_CHECKING 为 True 时才会导入。

如果 eval() 试图求值，将会失败并触发异常。因此，当要设计一个可采用注解的库 API ，建议只在调用方显式请求的时才对字符串求值。

任何版本 Python 中使用 __annotations__ 的最佳实践

应避免直接给对象的 __annotations__ 成员赋值。请让 Python 来管理 __annotations__。

如果直接给某对象的 __annotations__ 成员赋值，应该确保设成一个 dict 对象。

如果直接访问某个对象的 __annotations__ 成员，在解析其值之前，应先确认其为字典类型。

应避免修改 __annotations__ 字典。

应避免删除对象的 __annotations__ 属性。

__annotations__ 的一些“坑”

在 Python 3 的所有版本中，如果对象没有定义注解，函数对象就会直接创建一个注解字典对象。用 del fn.__annotations__ 可删除 __annotations__ 属性，但如果后续再访问 fn.__annotations__，该对象将新建一个空的字典对象，用于存放并返回注解。在函数直接创建注解字典前，删除注解操作会抛出 AttributeError 异常；连续两次调用 del fn.__annotations__ 一定会抛出一次 AttributeError 异常。

以上同样适用于 Python 3.10 以上版本中的类和模块对象。

所有版本的 Python 3 中，均可将函数对象的 __annotations__ 设为 None。但后续用 fn.__annotations__ 访问该对象的注解时，会像本节第一段所述那样，直接创建一个空字典。但在任何 Python 版本中，模块和类均非如此，他们允许将 __annotations__ 设为任意 Python 值，并且会留存所设值。

如果 Python 会对注解作字符串化处理（用 from __future__ import annotations ），并且注解本身就是一个字符串，那么将会为其加上引号。实际效果就是，注解加了 两次 引号。例如：

from __future__ import annotations
def foo(a: "str"): pass

print(foo.__annotations__)

这会打印出 {'a': "'str'"}。这不应算是个“坑”；只是因为可能会让人吃惊，所以才提一下。

Python 常见问题

Python常见问题

编程常见问题

设计和历史常见问题

代码库和插件 FAQ

扩展/嵌入常见问题

Python在Windows上的常见问题

图形用户界面（GUI）常见问题

“为什么我的电脑上安装了 Python ？”

Python常见问题

目录

Python常见问题

一般信息

什么是 Python？

什么是 Python 软件基金会？

使用 Python 是否存在版权限制？

创造 Python 的最初理由是什么？

Python 适合做什么？

Python 版本的编号形式是怎样的？

我应如何获取一份 Python 源代码的副本？

我应如何获取 Python 的文档？

我之前从未接触过编程。 哪里有 Python 的教程？

是否有专门针对 Python 的新闻组或邮件列表？

我应如何获取 Python 的公开测试版本？

我应如何为 Python 提交错误报告和补丁？

是否有任何公开发表的 Python 相关文章可以供我参考引用？

是否有任何 Python 相关的书籍？

www.python.org 具体位于世界上的哪个地点？

为何命名为 Python？

我必须喜欢 "Monty Python 的飞行马戏团" 吗？

现实世界中的 Python

Python 有多稳定？

有多少人在使用 Python？

有哪些重要的项目是用 Python 开发的？

在未来可以期待 Python 将有什么新进展？

提议对 Python 加入不兼容的更改是否合理？

Python 是一种对编程初学者友好的语言吗？

一般信息

什么是 Python？

Python 是一种解释型、交互式、面向对象的编程语言。 它包含了模块、异常、动态类型、高层级动态数据类型以及类等特性。 在面向对象编程以外它还支持多种编程范式，例如过程式和函数式编程等。 Python 结合了超强的功能和极清晰的语法。 它带有许多系统调用和库以及多种窗口系统的接口，并且能用 C 或 C++ 来进行扩展。 它还可用作需要可编程接口的应用程序的扩展语言。 最后，Python 非常易于移植：它可以在包括 Linux 和 macOS 在内的许多 Unix 变种以及 Windows 上运行。

要了解更多详情，请先查看 Python 教程。 Python 新手指南 [https://wiki.python.org/moin/BeginnersGuide] 提供了学习 Python 的其他入门教程及资源的链接。

什么是 Python 软件基金会？

Python 软件基金会（Python Software Foundation，简称 PSF）是一个独立的非盈利组织，它拥有 Python 2.1 及以上各版本的版权。 PSF 的使命是推进与 Python 编程语言相关的开源技术，并推广 Python 的使用。 PSF 的主页是 https://www.python.org/psf/。

向 PSF 提供捐助在美国是免税的。 如果你在使用 Python 并且感觉它对你很有帮助，可以通过 PSF 捐助页 [https://www.python.org/psf/donations/] 进行捐助。

使用 Python 是否存在版权限制？

你可以任意使用源码，只要你保留版权信息并在你基于 Python 的产品文档中显示该版权信息。 如果你遵守此版权规则，就可以将 Python 用于商业领域，以源码或二进制码的形式（不论是否经过修改）销售 Python 的副本，或是以某种形式包含了 Python 的产品。 当然，我们仍然希望获知所有对 Python 的商业使用。

请参阅 PSF 许可页 [https://www.python.org/psf/license/] 以查看进一步的说明以及许可的完整文本内容的链接。

Python 的徽标是注册商标，在某些情况下需要获得允许方可使用。 请参阅 商标使用政策 [https://www.python.org/psf/trademarks/] 了解详情。

创造 Python 的最初理由是什么？

以下是有关最初缘起的一份 非常 简短的摘要，由 Guido van Rossum 本人撰写:

我在 CWI 的 ABC 部门时在实现解释型语言方面积累了丰富经验，通过与这个部门成员的协同工作，我学到了大量有关语言设计的知识。 这是许多 Python 特性的最初来源，包括使用缩进来组织语句以及包含非常高层级的数据结构（虽然在 Python 中具体的实现细节完全不同）。

我对 ABC 语言有过许多抱怨，但同时也很喜欢它的许多特性。 没有可能通过扩展 ABC 语言（或它的实现）来弥补我的不满 —— 实际上缺乏可扩展性就是它最大的问题之一。 我也有一些使用 Modula-2+ 的经验，并曾与 Modula-3 的设计者进行交流，还阅读了 Modula-3 的报告。 Modula-3 是 Python 中异常机制所用语法和语义，以及其他一些语言特性的最初来源。

我还曾在 CWI 的 Amoeba 分布式操作系统部门工作。 当时我们需要有一种比编写 C 程序或 Bash 脚本更好的方式来进行系统管理，因为 Amoeba 有它自己的系统调用接口，并且无法方便地通过 Bash 来访问。 我在 Amoeba 中处理错误的经验令我深刻地意识到异常处理在编程语言特性当中的重要地位。

我发现，某种具有 ABC 式的语法而又能访问 Amoeba 系统调用的脚本语言将可满足需求。 我意识到编写一种 Amoeba 专属的语言是愚蠢的，所以我决定编写一种具有全面可扩展性的语言。

在 1989 年的圣诞假期中，我手头的时间非常充裕，因此我决定开始尝试一下。 在接下来的一年里，虽然我仍然主要用我的业余时间来做这件事，但 Python 在 Amoeba 项目中的使用获得了很大的成功，来自同事的反馈让我得以增加了许多早期的改进。

到 1991 年 2 月，经过一年多的开发，我决定将其发布到 USENET。 之后的事情就都可以在 Misc/HISTORY 文件里面看了。

Python 适合做什么？

Python 是一种高层级的多用途编程语言，可用于解决许多不同门类的问题。

该语言自带一个庞大的标准库，涵盖了许多编程领域，例如字符串处理（正则表达式、Unicode、比较文件间的差异等），互联网协议（HTTP, FTP, SMTP, XML-RPC, POP, IMAP, CGI 编程等），软件工程（单元测试、日志记录、性能分析、Python 代码解析等）以及操作系统接口（系统调用、文件系统、TCP/IP 套接字等）。 请查看 Python 标准库 目录页以概览所有可用内容。 此外还有大量第三方扩展可供使用。 请访问 Python 软件包索引 [https://pypi.org] 来查找你感兴趣的软件包。

Python 版本的编号形式是怎样的？

Python 版本的编号形式为 "A.B.C" 或 "A.B":

A 是主版本号 -- 它仅会针对语言中非常重大的改变而递增。

B 是次版本号 -- 它会针对不太重大的改变而递增。

C 是微版本号 -- 它针对每次问题修正发布而递增。

请参阅 PEP 6 [https://www.python.org/dev/peps/pep-0006] 了解有关问题修正发布的更多信息。

发布版本并非都是问题修正版本。 在新的主要发布版本开发过程中，还会发布一系列的开发版，它们以 alpha (a), beta (b) 或 release candidate (rc) 来标示。 其中 alpha 版是早期发布的测试版，它的接口并未最终确定；在两个 alpha 发布版本间出现接口的改变并不意外。 而 beta 版更为稳定，它会保留现有的接口，但也可能增加新的模块，release candidate 版则会保持冻结状态不会再进行改变，除非有重大问题需要修正。

Alpha, beta 和候选发布版带有额外的后缀:

带有某个小数字 N 的 alpha 版后缀是 "aN"。

带有某个小数字 N 的 beta 版后缀是 "bN"。

带有某个小数字 N 的候选发布版后缀是 "rcN"。

换句话说，所有标记为 2.0aN 的版本都早于标记为 2.0bN 的版本，后者又都早于标记为 2.0rcN 的版本，而 后者 又都早于标记为 2.0 的版本。

你还可能看到带有“+”后缀的版本号，例如“2.2+”。 这表示未发布版本，直接基于 CPython 开发代码仓库构建。 在实际操作中，当一个小版本最终发布后，未发布版本号会递增到下一个小版本号，成为“a0”版本，例如“2.4a0”。

另请参阅 sys.version, sys.hexversion 以及 sys.version_info 的文档。

我应如何获取一份 Python 源代码的副本？

最新的 Python 发布版源代码总能从 python.org 获取，下载页链接为 https://www.python.org/downloads/。 最新的开发版源代码可以在 https://github.com/python/cpython/ 获取。

发布版源代码是一个以 gzip 压缩的 tar 文件，其中包含完整的 C 源代码、Sphinx 格式的文档、Python 库模块、示例程序以及一些有用的自由分发软件。 该源代码将可在大多数 UNIX 类平台上直接编译并运行。

请参阅 Python 开发者指南的初步上手部分 [https://devguide.python.org/setup/] 了解有关获取源代码并进行编译的更多信息。

我应如何获取 Python 的文档？

当前的 Python 稳定版本的标准文档可在 https://docs.python.org/3/ 查看。 也可在 https://docs.python.org/3/download.html 获取PDF、纯文本以及可下载的 HTML 版本。

文档以 reStructuredText 格式撰写并使用 Sphinx 文档工具 [https://www.sphinx-doc.org/] 生成。 文档的 reStructuredText 源文件是 Python 源代码发布版的一部分。

我之前从未接触过编程。 哪里有 Python 的教程？

有许多可选择的教程和书籍。 标准文档中也包含有 Python 教程。

请参阅 新手指南 [https://wiki.python.org/moin/BeginnersGuide] 以获取针对 Python 编程初学者的信息，包括教程的清单。

是否有专门针对 Python 的新闻组或邮件列表？

有一个新闻组 comp.lang.python 和一个邮件列表 python-list [https://mail.python.org/mailman/listinfo/python-list]。 新闻组和邮件列表是彼此互通的 —— 如果你可以阅读新闻就不必再订阅邮件列表。 comp.lang.python 的流量很大，每天会收到数以百计的发帖，Usenet 使用者通常更擅长处理这样大的流量。

有关新软件发布和活动的公告可以在 comp.lang.python.announce 中找到，这是个严格管理的低流量列表，每天会收到五个左右的发帖。 可以在 Python 公告邮件列表 [https://mail.python.org/mailman/listinfo/python-announce-list] 页面进行订阅。

有关其他邮件列表和新闻组的更多信息可以在 https://www.python.org/community/lists/ 找到。

我应如何获取 Python 的公开测试版本？

可以从 https://www.python.org/downloads/ 下载 alpha 和 beta 发布版。 所有发布版都会在 comp.lang.python 和 comp.lang.python.announce 新闻组以及 Python 主页 https://www.python.org/ 上进行公告；并会推送到 RSS 新闻源。

你还可以通过 Git 访问 Python 的开发版。 请参阅 Python 开发者指南 [https://devguide.python.org/] 了解详情。

我应如何为 Python 提交错误报告和补丁？

要报告错误或提交补丁，请使用安装于 https://bugs.python.org/ 上的 Roundup。

你必须拥有一个 Roundup 账号才能报告错误；这样我们就可以在有后续问题时与你联系。 这也使得 Roundup 能在我们处理所报告的错误时向你发送更新消息。 如果你之前使用过 SourceForge 向 Python 报告错误，你可以通过 Roundup 的 密码重置操作 [https://bugs.python.org/user?@template=forgotten] 来获取你的 Roundup 密码。

有关 Python 开发流程的更多信息，请参阅 Python 开发者指南 [https://devguide.python.org/]。

是否有任何公开发表的 Python 相关文章可以供我参考引用？

可能作为参考文献的最好方式还是引用你喜欢的 Python 相关书籍。

有关 Python 的 最早的文章 [https://ir.cwi.nl/pub/18204] 撰写于 1991 年因而现在已相当过时。

Guido van Rossum 与 Jelke de Boer, "使用 Python 编程语言交互式地测试远程服务器", CWI 季刊, 第 4 卷, 第 4 期 (1991 年 12 月), 阿姆斯特丹, 第 283--303 页。

是否有任何 Python 相关的书籍？

是的，相关的书籍很多，还有更多即将发行。 请访问 python.org 的 wiki 页面 https://wiki.python.org/moin/PythonBooks 获取一份清单。

你也可以到各大在线书店搜索 "Python" 并过滤掉对 Monty Python 的引用；或者也可以搜索 "Python" 加 "language"。

www.python.org 具体位于世界上的哪个地点？

Python 项目的基础设施分布于世界各地并由 Python 基础设施团队负责管理。 相关细节请访问 这里 [https://infra.psf.io]。

为何命名为 Python？

在着手编写 Python 实现的时候，Guido van Rossum 同时还阅读了刚出版的 "Monty Python 的飞行马戏团" [https://en.wikipedia.org/wiki/Monty_Python] 剧本，这是一部自 1970 年代开始播出的 BBC 系列喜剧。 Van Rossum 觉得他需要选择一个简短、独特而又略显神秘的名字，于是他决定将这个新语言命名为 Python。

我必须喜欢 "Monty Python 的飞行马戏团" 吗？

不必，但这对学习会有帮助。 :)

现实世界中的 Python

Python 有多稳定？

非常稳定。 自 1991 年起大约每隔 6 到 18 个月就会推出新的稳定发布版，这种状态看来还还持续。 从 3.9 版开始，Python 将会每隔 12 个月推出一个新的主要发布版 (PEP 602 [https://www.python.org/dev/peps/pep-0602])。

开发者也会推出旧版本的“问题修正”发布版，因此现有发布版的稳定性还会逐步提升。 问题修正发布版会以版本号第三部分的数字来标示（例如 3.5.3, 3.6.2），用于稳定性的管理；只有对已知问题的修正会包含在问题修正发布版中，同一系列的问题修正发布版中的接口确定将会始终保持一致。

最后的稳定版本总是可以在 Python 下载页 [https://www.python.org/downloads/] 中找到。 有两个生产环境可用的 Python　版本：2.x 和 3.x。 推荐的版本是 3.x，大多数被广泛使用的库都支持它。 虽然 2.x 也仍然被广泛使用，但是 它已经停止维护 [https://www.python.org/dev/peps/pep-0373/]。

有多少人在使用 Python？

使用者应该数以百万计，但很难获得一个精确的数字。

Python 可以免费下载，因此并不存在销量数据，此外它也可以从许多不同网站获取，并且包含于许多 Linux 发行版之中，因此下载量统计同样无法完全说明问题。

comp.lang.python 新闻组非常活跃，但不是所有 Python 用户都会在新闻组发帖，许多人甚至不会阅读新闻组。

有哪些重要的项目是用 Python 开发的？

请访问 https://www.python.org/about/success 查看使用了 Python 的项目列表。 阅览 历次 Python 会议 [https://www.python.org/community/workshops/] 的日程纪要可以看到许多不同公司和组织所做的贡献。

高水准的 Python 项目包括 Mailman 邮件列表管理器 [https://www.list.org] 和 Zope 应用服务器 [https://www.zope.dev]。 多个 Linux 发行版，其中最著名的是 Red Hat [https://www.redhat.com]，都使用 Python 来编写其部分或全部的安装器和系统管理软件。 在内部使用 Python 的公司包括了 Google, Yahoo 和 Lucasfilm 等等。

在未来可以期待 Python 将有什么新进展？

请访问 https://www.python.org/dev/peps/ 查看 Python 增强提议（PEP）。 PEP 是为 Python 加入某种新特性的提议进行描述的设计文档，其中会提供简明的技术规格说明与基本原理。 可以查找标题为“Python X.Y Release Schedule”的 PEP，其中 X.Y 是某个尚未公开发布的版本。

新版本的开发会在 python-dev 邮件列表 [https://mail.python.org/mailman/listinfo/python-dev/] 中进行讨论。

提议对 Python 加入不兼容的更改是否合理？

通常来说是不合理的。 世界上已存在的 Python 代码数以亿计，因此，任何对该语言的更改即便仅会使得现有程序中极少的一部分失效也是难以令人接受的。 就算你可以提供一个转换程序，也仍然存在需要更新全部文档的问题；另外还有大量已出版的 Python 书籍，我们不希望让它们在一瞬间全部变成废纸。

如果必须更改某个特性，则应该提供渐进式的升级路径。 PEP 5 [https://www.python.org/dev/peps/pep-0005] 描述了引入向后不兼容的更改所需遵循的流程，以尽可能减少对用户的干扰。

Python 是一种对编程初学者友好的语言吗？

有的。

从过程式、静态类型的编程语言例如 Pascal, C 或者 C++ 以及 Java 的某一子集开始引导学生入门仍然是常见的做法。 但以 Python 作为第一种编程语言进行学习对学生可能更有利。Python 具有非常简单和一致的语法和庞大的标准库，而且最重要的是，在编程入门教学中使用 Python 可以让学生专注于更重要的编程技能，例如问题分解与数据类型设计。 使用 Python，可以快速向学生介绍基本概念例如循环与过程等。 他们甚至有可能在第一次课里就开始接触用户自定义对象。

对于之前从未接触过编程的学生来说，使用静态类型语言会感觉不够自然。 这会给学生带来必须掌握的额外复杂性，并减慢教学的进度。 学生需要尝试像计算机一样思考，分解问题，设计一致的接口并封装数据。 虽然从长远来看，学习和使用一种静态类型语言是很重要的，但这并不是最适宜在学生的第一次编程课上就进行探讨的主题。

还有许多其他方面的特点使得 Python 成为很好的入门语言。 像 Java 一样，Python 拥有一个庞大的标准库，因此可以在课程非常早期的阶段就给学生布置一些 实用 的编程项目。 编程作业不必仅限于标准四则运算和账目检查程序。 通过使用标准库，学生可以在学习编程基础知识的同时开发真正的应用，从而获得更大的满足感。 使用标准库还能使学生了解代码重用的概念。 而像 PyGame 这样的第三方模块同样有助于扩大学生的接触领域。

Python 的解释器使学生能够在编程时测试语言特性。 他们可以在一个窗口中输入程序源代码的同时开启一个解释器运行窗口。 如果他们不记得列表有哪些方法，他们这以这样做:

>>> 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]

通过使用解释器，学生编写程序时参考文档总是能伴随在他们身边。

Python 还拥有一些很好的 IDE。 IDLE 是一个以 Python 基于 Tkinter 编写的跨平台 Python IDE。 Emacs 用户将高兴地了解到 Emacs 具有非常好的 Python 模式。 所有这些编程环境都提供语法高亮、自动缩进以及在编写代码时使用交互式解释器等功能。 请访问 Python wiki [https://wiki.python.org/moin/PythonEditors] 查看 Python 编程环境的完整列表。

如果你想要讨论 Python 在教育中的使用，你可能会有兴趣加入 edu-sig 邮件列表 [https://www.python.org/community/sigs/current/edu-sig]。

编程常见问题

目录

编程常见问题

一般问题

Python 有没有提供带有断点、单步调试等功能的源码级调试器？

是否有能帮助寻找漏洞或执行静态分析的工具？

如何由 Python 脚本创建能独立运行的二进制程序？

是否有 Python 编码标准或风格指南？

语言核心内容

变量明明有值，为什么还会出现 UnboundLocalError？

Python 的局部变量和全局变量有哪些规则？

为什么在循环中定义的参数各异的 lambda 都返回相同的结果？

如何跨模块共享全局变量？

导入模块的“最佳实践”是什么？

为什么对象之间会共享默认值？

如何将可选参数或关键字参数从一个函数传递到另一个函数？

形参和实参之间有什么区别？

为什么修改列表 'y' 也会更改列表 'x'？

如何编写带有输出参数的函数（按照引用调用）？

如何在 Python 中创建高阶函数？

如何复制 Python 对象？

如何找到对象的方法或属性？

如何用代码获取对象的名称？

逗号运算符的优先级是什么？

是否提供等价于 C 语言 "?:" 三目运算符的东西？

是否可以用 Python 编写让人眼晕的单行程序?

函数形参列表中的斜杠（/）是什么意思？

数字和字符串

如何给出十六进制和八进制整数？

为什么 -22 // 10 会返回 -3 ？

我如何获得 int 字面属性而不是 SyntaxError ？

如何将字符串转换为数字？

如何将数字转换为字符串？

如何修改字符串？

如何使用字符串调用函数/方法？

是否有与Perl 的chomp() 等效的方法，用于从字符串中删除尾随换行符？

是否有 scanf() 或 sscanf() 的等价函数？

'UnicodeDecodeError' 或 'UnicodeEncodeError' 错误是什么意思？

我能以奇数个反斜杠来结束一个原始字符串吗？

性能

我的程序太慢了。该如何加快速度？

将多个字符串连接在一起的最有效方法是什么？

序列（元组/列表）

如何在元组和列表之间进行转换？

什么是负数索引？

序列如何以逆序遍历？

如何从列表中删除重复项？

如何从列表中删除多个项？

如何在 Python 中创建数组？

如何创建多维列表？

如何将方法应用于一系列对象？

为什么 a_tuple[i] += ['item'] 会引发异常？

我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？

如何根据另一个列表的值对某列表进行排序？

对象

什么是类？

什么是方法？

什么是 self ？

如何检查对象是否为给定类或其子类的一个实例？

什么是委托？

如何在扩展基类的派生类中调用基类中定义的方法？

如何让代码更容易对基类进行修改？

如何创建静态类数据和静态类方法？

在 Python 中如何重载构造函数（或方法）？

在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。

类定义了 __del__ 方法，但是删除对象时没有调用它。

如何获取给定类的所有实例的列表？

为什么 id() 的结果看起来不是唯一的？

什么情况下可以依靠 is 运算符进行对象的身份相等性测试？

一个子类如何控制哪些数据被存储在一个不可变的实例中？

我该如何缓存方法调用？

模块

如何创建 .pyc 文件？

如何找到当前模块名称？

如何让模块相互导入？

__import__('x.y.z') 返回的是 <module 'x'> ；该如何得到 z 呢？

对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？

一般问题

Python 有没有提供带有断点、单步调试等功能的源码级调试器？

有的。

以下介绍了一些 Python 的调试器，用内置函数 breakpoint() 即可切入这些调试器中。

pdb 模块是一个简单但是够用的控制台模式 Python 调试器。 它是标准 Python 库的一部分，并且 已收录于库参考手册。 你也可以通过使用 pdb 代码作为样例来编写你自己的调试器。

作为标准 Python 发行版组成部分的 IDLE 交互式开发环境 (通常位于 Tools/scripts/idle3 [https://github.com/python/cpython/blob/main/Tools/scripts/idle3])，包括一个图形化的调试器。

PythonWin 是一种 Python IDE，其中包含了一个基于 pdb 的 GUI 调试器。PythonWin 的调试器会为断点着色，并提供了相当多的超酷特性，例如调试非 PythonWin 程序等。PythonWin 是 pywin32 [https://github.com/mhammond/pywin32] 项目的组成部分，也是 ActivePython [https://www.activestate.com/products/python/] 发行版的组成部分。

Eric [https://eric-ide.python-projects.org/] 是一个基于 PyQt 和 Scintilla 编辑组件的 IDE。

trepan3k [https://github.com/rocky/python3-trepan/] 是一个类似 gdb 的调试器。

Visual Studio Code [https://code.visualstudio.com/] 是包含了调试工具的 IDE，并集成了版本控制软件。

有许多商业 Python IDE 都包含了图形化调试器。包括：

Wing IDE [https://wingware.com/]

Komodo IDE [https://www.activestate.com/products/komodo-ide/]

PyCharm [https://www.jetbrains.com/pycharm/]

是否有能帮助寻找漏洞或执行静态分析的工具？

有的。

Pylint [https://pylint.pycqa.org/en/latest/index.html] 和 Pyflakes [https://github.com/PyCQA/pyflakes] 可执行基本检查来帮助你尽早捕捉漏洞。

静态类型检查器，例如 Mypy [http://mypy-lang.org/] 、 Pyre [https://pyre-check.org/] 和 Pytype [https://github.com/google/pytype] 可以检查Python源代码中的类型提示。

如何由 Python 脚本创建能独立运行的二进制程序？

如果只是想要一个独立的程序，以便用户不必预先安装 Python 即可下载和运行它，则不需要将 Python 编译成 C 代码。有许多工具可以检测程序所需的模块，并将这些模块与 Python 二进制程序捆绑在一起生成单个可执行文件。

一种方案是使用 freeze 工具，它以 Tools/freeze [https://github.com/python/cpython/tree/main/Tools/freeze] 的形式包含在 Python 源代码树中。 它可将 Python 字节码转换为 C 数组；你可以使用 C 编译器将你的所有模块嵌入到一个新程序中，再将其与标准 Python 模块进行链接。

它的工作原理是递归扫描源代码，获取两种格式的 import 语句，并在标准 Python 路径和源码目录（用于内置模块）检索这些模块。然后，把这些模块的 Python 字节码转换为 C 代码（可以利用 marshal 模块转换为代码对象的数组初始化器），并创建一个定制的配置文件，该文件仅包含程序实际用到的内置模块。然后，编译生成的 C 代码并将其与 Python 解释器的其余部分链接，形成一个自给自足的二进制文件，其功能与 Python 脚本代码完全相同。

下列包可以用于帮助创建控制台和 GUI 的可执行文件:

Nuitka [https://nuitka.net/] （跨平台）

PyInstaller [https://pyinstaller.org/] (跨平台)

PyOxidizer [https://pyoxidizer.readthedocs.io/en/stable/] （跨平台）

cx_Freeze [https://marcelotduarte.github.io/cx_Freeze/] （跨平台）

py2app [https://github.com/ronaldoussoren/py2app] （仅限 macOS）

py2exe [https://www.py2exe.org/] (仅限 Windows)

是否有 Python 编码标准或风格指南？

有的。 标准库模块所要求的编码风格记录于 PEP 8 [https://www.python.org/dev/peps/pep-0008] 之中。

语言核心内容

变量明明有值，为什么还会出现 UnboundLocalError？

当在函数内部某处添加了一条赋值语句，因而导致之前正常工作的代码报出 UnboundLocalError 错误，这确实有点令人惊讶。

以下代码：

>>> x = 10
>>> def bar():
...     print(x)
...
>>> bar()
10

正常工作，但是以下代码

>>> x = 10
>>> def foo():
...     print(x)
...     x += 1

在 UnboundLocalError 中的结果:

>>> foo()
Traceback (most recent call last):
  ...
UnboundLocalError: local variable 'x' referenced before assignment

原因就是，当对某作用域内的变量进行赋值时，该变量将成为该作用域内的局部变量，并覆盖外部作用域中的同名变量。由于 foo 的最后一条语句为 x 分配了一个新值，编译器会将其识别为局部变量。因此，前面的 print(x) 试图输出未初始化的局部变量，就会引发错误。

在上面的示例中，可以将外部作用域的变量声明为全局变量以便访问：

>>> x = 10
>>> def foobar():
...     global x
...     print(x)
...     x += 1
...
>>> foobar()
10

与类和实例变量貌似但不一样，其实以上是在修改外部作用域的变量值，为了提示这一点，这里需要显式声明一下。

>>> print(x)
11

你可以使用 nonlocal 关键字在嵌套作用域中执行类似的操作：

>>> def foo():
...    x = 10
...    def bar():
...        nonlocal x
...        print(x)
...        x += 1
...    bar()
...    print(x)
...
>>> foo()
10
11

Python 的局部变量和全局变量有哪些规则？

函数内部只作引用的 Python 变量隐式视为全局变量。如果在函数内部任何位置为变量赋值，则除非明确声明为全局变量，否则均将其视为局部变量。

起初尽管有点令人惊讶，不过考虑片刻即可释然。一方面，已分配的变量要求加上 global 可以防止意外的副作用发生。另一方面，如果所有全局引用都要加上 global ，那处处都得用上 global 了。那么每次对内置函数或导入模块中的组件进行引用时，都得声明为全局变量。这种杂乱会破坏 global 声明用于警示副作用的有效性。

为什么在循环中定义的参数各异的 lambda 都返回相同的结果？

假设用 for 循环来定义几个取值各异的 lambda（即便是普通函数也一样）：

>>> squares = []
>>> for x in range(5):
...     squares.append(lambda: x**2)

以上会得到一个包含5个 lambda 函数的列表，这些函数将计算 x**2。大家或许期望，调用这些函数会分别返回 0 、1 、 4 、 9 和 16。然而，真的试过就会发现，他们都会返回 16 ：

>>> squares[2]()
16
>>> squares[4]()
16

这是因为 x 不是 lambda 函数的内部变量，而是定义于外部作用域中的，并且 x 是在调用 lambda 时访问的——而不是在定义时访问。循环结束时 x 的值是 4 ，所以此时所有的函数都将返回 4**2 ，即 16 。通过改变 x 的值并查看 lambda 的结果变化，也可以验证这一点。

>>> x = 8
>>> squares[2]()
64

为了避免发生上述情况，需要将值保存在 lambda 局部变量，以使其不依赖于全局 x 的值：

>>> squares = []
>>> for x in range(5):
...     squares.append(lambda n=x: n**2)

以上 n=x 创建了一个新的 lambda 本地变量 n，并在定义 lambda 时计算其值，使其与循环当前时点的 x 值相同。这意味着 n 的值在第 1 个 lambda 中为 0 ，在第 2 个 lambda 中为 1 ，在第 3 个中为 2，依此类推。因此现在每个 lambda 都会返回正确结果：

>>> squares[2]()
4
>>> squares[4]()
16

请注意，上述表现并不是 lambda 所特有的，常规的函数也同样适用。

如何跨模块共享全局变量？

在单个程序中跨模块共享信息的规范方法是创建一个特殊模块（通常称为 config 或 cfg）。只需在应用程序的所有模块中导入该 config 模块；然后该模块就可当作全局名称使用了。因为每个模块只有一个实例，所以对该模块对象所做的任何更改将会在所有地方得以体现。 例如：

config.py：

x = 0   # Default value of the 'x' configuration setting

mod.py：

import config
config.x = 1

main.py：

import config
import mod
print(config.x)

请注意，出于同样的原因，使用模块也是实现单例设计模式的基础。

导入模块的“最佳实践”是什么？

通常请勿使用 from modulename import * 。因为这会扰乱 importer 的命名空间，且会造成未定义名称更难以被 Linter 检查出来。

请在代码文件的首部就导入模块。这样代码所需的模块就一目了然了，也不用考虑模块名是否在作用域内的问题。每行导入一个模块则增删起来会比较容易，每行导入多个模块则更节省屏幕空间。

按如下顺序导入模块就是一种好做法：

标准库模块——例如：sys、os、argparse、re 等。

第三方库模块（安装于 Python site-packages 目录中的内容）——例如：dateutil、requests、PIL.Image 等。

本地开发的模块

为了避免循环导入引发的问题，有时需要将模块导入语句移入函数或类的内部。Gordon McMillan 的说法如下：

当两个模块都采用 "import <module>" 的导入形式时，循环导入是没有问题的。但如果第 2 个模块想从第 1 个模块中取出一个名称（"from module import name"）并且导入处于代码的最顶层，那导入就会失败。原因是第 1 个模块中的名称还不可用，这时第 1 个模块正忙于导入第 2 个模块呢。

如果只是在一个函数中用到第 2 个模块，那这时将导入语句移入该函数内部即可。当调用到导入语句时，第 1 个模块将已经完成初始化，第 2 个模块就可以进行导入了。

如果某些模块是平台相关的，可能还需要把导入语句移出最顶级代码。这种情况下，甚至有可能无法导入文件首部的所有模块。于是在对应的平台相关代码中导入正确的模块，就是一种不错的选择。

只有为了避免循环导入问题，或有必要减少模块初始化时间时，才把导入语句移入类似函数定义内部的局部作用域。如果根据程序的执行方式，许多导入操作不是必需的，那么这种技术尤其有用。如果模块仅在某个函数中用到，可能还要将导入操作移入该函数内部。请注意，因为模块有一次初始化过程，所以第一次加载模块的代价可能会比较高，但多次加载几乎没有什么花费，代价只是进行几次字典检索而已。即使模块名超出了作用域，模块在 sys.modules 中也是可用的。

为什么对象之间会共享默认值？

新手程序员常常中招这类 Bug。请看以下函数：

def foo(mydict={}):  # Danger: shared reference to one dict for all calls
    ... compute something ...
    mydict[key] = value
    return mydict

第一次调用此函数时， mydict 中只有一个数据项。第二次调用 mydict 则会包含两个数据项，因为 foo() 开始执行时， mydict 中已经带有一个数据项了。

大家往往希望，函数调用会为默认值创建新的对象。但事实并非如此。默认值只会在函数定义时创建一次。如果对象发生改变，就如上例中的字典那样，则后续调用该函数时将会引用这个改动的对象。

按照定义，不可变对象改动起来是安全的，诸如数字、字符串、元组和 None 之类。而可变对象的改动则可能引起困惑，例如字典、列表和类实例等。

因此，不把可变对象用作默认值是一种良好的编程做法。而应采用 None 作为默认值，然后在函数中检查参数是否为 None 并新建列表、字典或其他对象。例如，代码不应如下所示：

def foo(mydict={}):
    ...

而应这么写：

def foo(mydict=None):
    if mydict is None:
        mydict = {}  # create a new dict for local namespace

参数默认值的特性有时会很有用处。 如果有个函数的计算过程会比较耗时，有一种常见技巧是将每次函数调用的参数和结果缓存起来，并在同样的值被再次请求时返回缓存的值。这种技巧被称为“memoize”，实现代码可如下所示：

# Callers can only provide two parameters and optionally pass _cache by keyword
def expensive(arg1, arg2, *, _cache={}):
    if (arg1, arg2) in _cache:
        return _cache[(arg1, arg2)]

    # Calculate the value
    result = ... expensive computation ...
    _cache[(arg1, arg2)] = result           # Store result in the cache
    return result

也可以不用参数默认值来实现，而是采用全局的字典变量；这取决于个人偏好。

如何将可选参数或关键字参数从一个函数传递到另一个函数？

请利用函数参数列表中的标识符 * 和 ** 归集实参；结果会是元组形式的位置实参和字典形式的关键字实参。然后就可利用 * 和 ** 在调用其他函数时传入这些实参：

def f(x, *args, **kwargs):
    ...
    kwargs['width'] = '14.3c'
    ...
    g(x, *args, **kwargs)

形参和实参之间有什么区别？

形参 是由出现在函数定义中的名称来定义的，而 参数 则是在调用函数时实际传入的值。 形参定义了一个函数能接受什么 参数种类。 例如，对于以下函数定义:

def func(foo, bar=None, **kwargs):
    pass

foo 、 bar 和 kwargs 是 func 的形参。 不过在调用 func 时，例如：

func(42, bar=314, extra=somevar)

42 、 314 和 somevar 则是实参。

为什么修改列表 'y' 也会更改列表 'x'？

如果代码编写如下：

>>> x = []
>>> y = x
>>> y.append(10)
>>> y
[10]
>>> x
[10]

或许大家很想知道，为什么在 y 中添加一个元素时， x 也会改变。

产生这种结果有两个因素：

变量只是指向对象的一个名称。执行 y = x 并不会创建列表的副本——而只是创建了一个新变量 y，并指向 x 所指的同一对象。这就意味着只存在一个列表对象，x 和 y 都是对它的引用。

列表属于 mutable 对象，这意味着它的内容是可以修改的。

在调用 append() 之后，该可变对象的内容由 [] 变为 [10]。由于 x 和 y 这两个变量引用了同一对象，因此用其中任意一个名称所访问到的都是修改后的值 [10]。

如果把赋给 x 的对象换成一个不可变对象：

>>> x = 5  # ints are immutable
>>> y = x
>>> x = x + 1  # 5 can't be mutated, we are creating a new object here
>>> x
6
>>> y
5

可见这时 x 和 y 就不再相等了。因为整数是 immutable 对象，在执行 x = x + 1 时，并不会修改整数对象 5，给它加上 1；而是创建了一个新的对象（整数对象 6 ）并将其赋给 x （也就是改变了 x 所指向的对象）。在赋值完成后，就有了两个对象（整数对象 6 和 5 ）和分别指向他俩的两个变量（ x 现在指向 6 而 y 仍然指向 5 ）。

某些操作 (例如 y.append(10) 和 y.sort()) 是改变原对象，而看上去相似的另一些操作 (例如 y = y + [10] 和 sorted(y) <sorted>) 则是创建新对象。 通常在 Python 中 (以及在标准库的所有代码中) 会改变原对象的方法将返回 ``None`() 以帮助避免混淆这两种不同类型的操作。 因此如果你错误地使用了 y.sort() 并期望它将返回一个经过排序的 y 的副本，你得到的结果将会是 None，这将导致你的程序产生一个容易诊断的错误。

不过还存在一类操作，用不同的类型执行相同的操作有时会发生不同的行为：即增量赋值运算符。例如，+= 会修改列表，但不会修改元组或整数（a_list += [1, 2, 3] 与 a_list.extend([1, 2, 3]) 同样都会改变 a_list，而 some_tuple += (1, 2, 3) 和 some_int += 1 则会创建新的对象）。

换而言之：

对于一个可变对象（ list 、 dict 、 set 等等），可以利用某些特定的操作进行修改，所有引用它的变量都会反映出改动情况。

对于一个不可变对象（ str 、 int 、 tuple 等），所有引用它的变量都会给出相同的值，但所有改变其值的操作都将返回一个新的对象。

如要知道两个变量是否指向同一个对象，可以利用 is 运算符或内置函数 id()。

如何编写带有输出参数的函数（按照引用调用）？

请记住，Python 中的实参是通过赋值传递的。由于赋值只是创建了对象的引用，所以调用方和被调用方的参数名都不存在别名，本质上也就不存在按引用调用的方式。通过以下几种方式，可以得到所需的效果。

返回一个元组：

>>> def func1(a, b):
...     a = 'new-value'        # a and b are local names
...     b = b + 1              # assigned to new objects
...     return a, b            # return new values
...
>>> x, y = 'old-value', 99
>>> func1(x, y)
('new-value', 100)

这差不多是最明晰的解决方案了。

使用全局变量。这不是线程安全的方案，不推荐使用。

传递一个可变（即可原地修改的） 对象：

>>> def func2(a):
...     a[0] = 'new-value'     # 'a' references a mutable list
...     a[1] = a[1] + 1        # changes a shared object
...
>>> args = ['old-value', 99]
>>> func2(args)
>>> args
['new-value', 100]

传入一个接收可变对象的字典:

>>> def func3(args):
...     args['a'] = 'new-value'     # args is a mutable dictionary
...     args['b'] = args['b'] + 1   # change it in-place
...
>>> args = {'a': 'old-value', 'b': 99}
>>> func3(args)
>>> args
{'a': 'new-value', 'b': 100}

或者把值用类实例封装起来：

>>> class Namespace:
...     def __init__(self, /, **args):
...         for key, value in args.items():
...             setattr(self, key, value)
...
>>> def func4(args):
...     args.a = 'new-value'        # args is a mutable Namespace
...     args.b = args.b + 1         # change object in-place
...
>>> args = Namespace(a='old-value', b=99)
>>> func4(args)
>>> vars(args)
{'a': 'new-value', 'b': 100}

没有什么理由要把问题搞得这么复杂。

最佳选择就是返回一个包含多个结果值的元组。

如何在 Python 中创建高阶函数？

有两种选择：嵌套作用域、可调用对象。假定需要定义 linear(a,b) ，其返回结果是一个计算出 a*x+b 的函数 f(x)。 采用嵌套作用域的方案如下：

def linear(a, b):
    def result(x):
        return a * x + b
    return result

或者可采用可调用对象：

class linear:

    def __init__(self, a, b):
        self.a, self.b = a, b

    def __call__(self, x):
        return self.a * x + self.b

采用这两种方案时：

taxes = linear(0.3, 2)

都会得到一个可调用对象，可实现 taxes(10e6) == 0.3 * 10e6 + 2 。

可调用对象的方案有个缺点，就是速度稍慢且生成的代码略长。不过值得注意的是，同一组可调用对象能够通过继承来共享签名（类声明）：

class exponential(linear):
    # __init__ inherited
    def __call__(self, x):
        return self.a * (x ** self.b)

对象可以为多个方法的运行状态进行封装：

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

以上 inc() 、 dec() 和 reset() 的表现，就如同共享了同一计数变量一样。

如何复制 Python 对象？

一般情况下，用 copy.copy() 或 copy.deepcopy() 基本就可以了。并不是所有对象都支持复制，但多数是可以的。

某些对象可以用更简便的方法进行复制。比如字典对象就提供了 copy() 方法：

newdict = olddict.copy()

序列可以用切片操作进行复制：

new_l = l[:]

如何找到对象的方法或属性？

对于一个用户定义类的实例 x，dir(x) 将返回一个按字母顺序排列的名称列表，其中包含实例属性及由类定义的方法和属性。

如何用代码获取对象的名称？

一般而言这是无法实现的，因为对象并不存在真正的名称。赋值本质上是把某个名称绑定到某个值上；def 和 class 语句同样如此，只是值换成了某个可调用对象。比如以下代码：

>>> class A:
...     pass
...
>>> B = A
>>> a = B()
>>> b = a
>>> print(b)
<__main__.A object at 0x16D07CC>
>>> print(a)
<__main__.A object at 0x16D07CC>

可以不太严谨地说上述类有一个名称：即使它绑定了两个名称并通过名称 B 唤起所创建的实例仍将被报告为类 A 的实例。 但是，没有办法肯定地说实例的名称是 a 还是 b，因为这两个名称都被绑定到同一个值上了。

代码一般没有必要去“知晓”某个值的名称。通常这种需求预示着还是改变方案为好，除非真的是要编写内审程序。

在 comp.lang.python 中，Fredrik Lundh 在回答这样的问题时曾经给出过一个绝佳的类比：

这就像要知道家门口的那只猫的名字一样：猫（对象）自己不会说出它的名字，它根本就不在乎自己叫什么——所以唯一方法就是问一遍你所有的邻居（命名空间），这是不是他们家的猫（对象）……

……并且如果你发现它有很多名字或根本没有名字，那也不必惊讶！

逗号运算符的优先级是什么？

逗号不是 Python 的运算符。 请看以下例子：

>>> "a" in "b", "a"
(False, 'a')

由于逗号不是运算符，而只是表达式之间的分隔符，因此上述代码就相当于：

("a" in "b"), "a"

而不是：

"a" in ("b", "a")

对于各种赋值运算符（ = 、 += 等）来说同样如此。他们并不是真正的运算符，而只是赋值语句中的语法分隔符。

是否提供等价于 C 语言 "?:" 三目运算符的东西？

有的。语法如下：

[on_true] if [expression] else [on_false]

x, y = 50, 25
small = x if x < y else y

在 Python 2.5 引入上述语法之前，通常的做法是使用逻辑运算符：

[expression] and [on_true] or [on_false]

然而这种做法并不保险，因为当 on_true 为布尔值“假”时，结果将会出错。所以肯定还是采用 ... if ... else ... 形式为妙。

是否可以用 Python 编写让人眼晕的单行程序?

可以。 这一般是通过在 lambda 中嵌套 lambda 来实现的。 请参阅以下三个示例，它们是基于 Ulf Bartelt 的代码改写的:

from functools import reduce

# Primes < 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)))))

# First 10 Fibonacci numbers
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))))

# Mandelbrot set
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))
#    \___ ___/  \___ ___/  |   |   |__ lines on screen
#        V          V      |   |______ columns on screen
#        |          |      |__________ maximum of "iterations"
#        |          |_________________ range on y axis
#        |____________________________ range on x axis

请不要在家里尝试，骚年！

函数形参列表中的斜杠（/）是什么意思？

函数参数列表中的斜杠表示在它之前的形参都是仅限位置形参。 仅限位置形参没有可供外部使用的名称。 在调用接受仅限位置形参的函数时，参数将只根据其位置被映射到形参上。 例如，divmod() 就是一个接受仅限位置形参的函数。 它的文档说明是这样的:

>>> 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.

形参列表尾部的斜杠说明，两个形参都是仅限位置形参。因此，用关键字参数调用 divmod() 将会引发错误：

>>> divmod(x=3, y=4)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: divmod() takes no keyword arguments

数字和字符串

如何给出十六进制和八进制整数？

要给出八进制数，需在八进制数值前面加上一个零和一个小写或大写字母 "o" 作为前缀。例如，要将变量 "a" 设为八进制的 "10" （十进制的 8），写法如下：

>>> a = 0o10
>>> a
8

十六进制数也很简单。只要在十六进制数前面加上一个零和一个小写或大写的字母 "x"。十六进制数中的字母可以为大写或小写。比如在 Python 解释器中输入：

>>> a = 0xa5
>>> a
165
>>> b = 0XB2
>>> b
178

为什么 -22 // 10 会返回 -3 ？

这主要是为了让 i % j 的正负与 j 一致，如果期望如此，且期望如下等式成立：

i == (i // j) * j + (i % j)

那么整除就必须返回向下取整的结果。C 语言同样要求保持这种一致性，于是编译器在截断 i // j 的结果时需要让 i % j 的正负与 i 一致。

对于 i % j 来说 j 为负值的应用场景实际上是非常少的。 而 j 为正值的情况则非常多，并且实际上在所有情况下让 i % j 的结果为 >= 0 会更有用处。 如果现在时间为 10 时，那么 200 小时前应是几时？ -190 % 12 == 2 是有用处的；-190 % 12 == -10 则是会导致意外的漏洞。

我如何获得 int 字面属性而不是 SyntaxError ？

尝试以正式方式查找一个 int 字面值属性会发生 SyntaxError 因为句点会被当作是小数点:

>>> 1.__class__
  File "<stdin>", line 1
  1.__class__
   ^
SyntaxError: invalid decimal literal

解决办法是用空格或括号将字词与句号分开。

>>> 1 .__class__
<class 'int'>
>>> (1).__class__
<class 'int'>

如何将字符串转换为数字？

对于整数，可使用内置的 int() 类型构造器，例如 int('144') == 144。 类似地，可使用 float() 转换为浮点数，例如 float('144') == 144.0。

默认情况下，这些操作会将数字按十进制来解读，因此 int('0144') == 144 为真值，而 int('0x144') 会引发 ValueError。 int(string, base) 接受第二个可选参数指定转换的基数，例如 int( '0x144', 16) == 324。 如果指定基数为 0，则按 Python 规则解读数字：前缀 '0o' 表示八进制，而 '0x' 表示十六进制。

如果只是想把字符串转为数字，请不要使用内置函数 eval()。 eval() 的速度慢很多且存在安全风险：别人可能会传入带有不良副作用的 Python 表达式。比如可能会传入 __import__('os').system("rm -rf $HOME") ，这会把 home 目录给删了。

eval() 还有把数字解析为 Python 表达式的后果，因此如 eval('09') 将会导致语法错误，因为 Python 不允许十进制数带有前导 '0'（'0' 除外）。

如何将数字转换为字符串？

例如，要把数字 144 转换为字符串 '144'，可使用内置类型构造器 str()。 如果你需要十六进制或八进制表示形式，可使用内置函数 hex() 或 oct()。 更复杂的格式化方式，请参阅 格式字符串字面值 和 格式字符串语法 等章节，例如 "{:04d}".format(144) 将产生 '0144' 而 "{:.3f}".format(1.0/3.0) 将产生 '0.333'。

如何修改字符串？

无法修改，因为字符串是不可变对象。 在大多数情况下，只要将各个部分组合起来构造出一个新字符串即可。如果需要一个能原地修改 Unicode 数据的对象，可以试试 io.StringIO 对象或 array 模块：

>>> 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('u', s)
>>> print(a)
array('u', 'Hello, world')
>>> a[0] = 'y'
>>> print(a)
array('u', 'yello, world')
>>> a.tounicode()
'yello, world'

如何使用字符串调用函数/方法？

有多种技巧可供选择。

最好的做法是采用一个字典，将字符串映射为函数。其主要优势就是字符串不必与函数名一样。这也是用来模拟 case 结构的主要技巧：

def a():
    pass

def b():
    pass

dispatch = {'go': a, 'stop': b}  # Note lack of parens for funcs

dispatch[get_input()]()  # Note trailing parens to call function

利用内置函数 getattr() ：

import foo
getattr(foo, 'bar')()

请注意 getattr() 可用于任何对象，包括类、类实例、模块等等。

标准库就多次使用了这个技巧，例如：

class Foo:
    def do_foo(self):
        ...

    def do_bar(self):
        ...

f = getattr(foo_instance, 'do_' + opname)
f()

用 locals() 解析出函数名：

def myFunc():
    print("hello")

fname = "myFunc"

f = locals()[fname]
f()

是否有与Perl 的chomp() 等效的方法，用于从字符串中删除尾随换行符？

可以使用 S.rstrip("\r\n") 从字符串 S 的末尾删除所有的换行符，而不删除其他尾随空格。如果字符串 S 表示多行，且末尾有几个空行，则将删除所有空行的换行符：

>>> lines = ("line 1 \r\n"
...          "\r\n"
...          "\r\n")
>>> lines.rstrip("\n\r")
'line 1 '

由于通常只在一次读取一行文本时才需要这样做，所以使用 S.rstrip() 这种方式工作得很好。

是否有 scanf() 或 sscanf() 的等价函数？

没有。

对于简单的输入解析，最容易的做法通常是用字符串对象的 split() 方法将一行内容按空白分隔符拆分为多个单词再用 int() 或 float() 将十进制数值字符串转换为数值。 split() 支持可选的 "sep" 形参，适用于分隔符不是空白符的情况。

对于更复杂的输入解析，正则表达式相比 C 的 sscanf 更为强大也更为适合。

'UnicodeDecodeError' 或 'UnicodeEncodeError' 错误是什么意思？

见 Unicode 指南

我能以奇数个反斜杠来结束一个原始字符串吗？

以奇数个反斜杠结尾的原始字符串将会转义用于标记字符串的引号:

>>> r'C:\this\will\not\work\'
  File "<stdin>", line 1
    r'C:\this\will\not\work\'
         ^
SyntaxError: unterminated string literal (detected at line 1)

有几种绕过此问题的办法。 其中之一是使用常规字符串以及双反斜杠:

>>> 'C:\\this\\will\\work\\'
'C:\\this\\will\\work\\'

另一种办法是将一个包含被转义反斜杠的常规字符串拼接到原始字符串上:

>>> r'C:\this\will\work' '\\'
'C:\\this\\will\\work\\'

在 Windows 上还可以使用 os.path.join() 来添加反斜杠:

>>> os.path.join(r'C:\this\will\work', '')
'C:\\this\\will\\work\\'

请注意虽然在确定原始字符串的结束位置时反斜杠会对引号进行“转义“，但在解析原始字符串的值时并不会发生转义。 也就是说，反斜杠会被保留在原始字符串的值中:

>>> r'backslash\'preserved'
"backslash\\'preserved"

另请参阅 语言参考 中的规范说明。

性能

我的程序太慢了。该如何加快速度？

总的来说，这是个棘手的问题。在进一步讨论之前，首先应该记住以下几件事：

不同的 Python 实现具有不同的性能特点。 本 FAQ 着重解答的是 CPython。

不同操作系统可能会有不同表现，尤其是涉及 I/O 和多线程时。

在尝试优化代码 之前 ，务必要先找出程序中的热点（请参阅 profile 模块）。

编写基准测试脚本，在寻求性能提升的过程中就能实现快速迭代（请参阅 timeit 模块）。

强烈建议首先要保证足够高的代码测试覆盖率（通过单元测试或其他技术），因为复杂的优化有可能会导致代码回退。

话虽如此，Python 代码的提速还是有很多技巧的。以下列出了一些普适性的原则，对于让性能达到可接受的水平会有很大帮助：

相较于试图对全部代码铺开做微观优化，优化算法（或换用更快的算法）可以产出更大的收益。

使用正确的数据结构。参考 内置类型 和 collections 模块的文档。

如果标准库已为某些操作提供了基础函数，则可能（当然不能保证）比所有自编的函数都要快。对于用 C 语言编写的基础函数则更是如此，比如内置函数和一些扩展类型。例如，一定要用内置方法 list.sort() 或 sorted() 函数进行排序（某些高级用法的示例请参阅 排序指南 ）。

抽象往往会造成中间层，并会迫使解释器执行更多的操作。如果抽象出来的中间层级太多，工作量超过了要完成的有效任务，那么程序就会被拖慢。应该避免过度的抽象，而且往往也会对可读性产生不利影响，特别是当函数或方法比较小的时候。

如果你已经达到纯 Python 允许的限制，那么有一些工具可以让你走得更远。 例如，Cython [https://cython.org] 可以将稍加修改的 Python 代码版本编译为 C 扩展，并能在许多不同的平台上使用。 Cython 可以利用编译（和可选的类型标注）来让你的代码显著快于解释运行时的速度。 如果你对自己的 C 编程技能有信心，还可以自行 编写 C 扩展模块。

参见

专门介绍 性能提示 [https://wiki.python.org/moin/PythonSpeed/PerformanceTips] 的wiki页面。

将多个字符串连接在一起的最有效方法是什么？

str 和 bytes 对象是不可变的，因此连接多个字符串的效率会很低，因为每次连接都会创建一个新的对象。一般情况下，总耗时与字符串总长是二次方的关系。

如果要连接多个 str 对象，通常推荐的方案是先全部放入列表，最后再调用 str.join() ：

chunks = []
for s in my_strings:
    chunks.append(s)
result = ''.join(chunks)

（还有一种合理高效的习惯做法，就是利用 io.StringIO ）

如果要连接多个 bytes 对象，推荐做法是用 bytearray 对象的原地连接操作（ += 运算符）追加数据：

result = bytearray()
for b in my_bytes_objects:
    result += b

序列（元组/列表）

如何在元组和列表之间进行转换？

类型构造器 tuple(seq) 可将任意序列（实际上是任意可迭代对象）转换为数据项和顺序均不变的元组。

例如，tuple([1, 2, 3]) 会生成 (1, 2, 3) ， tuple('abc') 则会生成 ('a', 'b', 'c') 。 如果参数就是元组，则不会创建副本而是返回同一对象，因此如果无法确定某个对象是否为元组时，直接调用 tuple() 也没什么代价。

类型构造器 list(seq) 可将任意序列或可迭代对象转换为数据项和顺序均不变的列表。例如，list((1, 2, 3)) 会生成 [1, 2, 3] 而 list('abc') 则会生成 ['a', 'b', 'c']。如果参数即为列表，则会像 seq[:] 那样创建一个副本。

什么是负数索引？

Python 序列的索引可以是正数或负数。索引为正数时，0 是第一个索引值， 1 为第二个，依此类推。索引为负数时，-1 为倒数第一个索引值，-2 为倒数第二个，依此类推。可以认为 seq[-n] 就相当于 seq[len(seq)-n]。

使用负数序号有时会很方便。 例如 S[:-1] 就是原字符串去掉最后一个字符，这可以用来移除某个字符串末尾的换行符。

序列如何以逆序遍历？

使用内置函数 reversed() ：

for x in reversed(sequence):
    ...  # do something with x ...

原序列不会变化，而是构建一个逆序的新副本以供遍历。

如何从列表中删除重复项？

许多完成此操作的的详细介绍，可参阅 Python Cookbook：

https://code.activestate.com/recipes/52560/

如果列表允许重新排序，不妨先对其排序，然后从列表末尾开始扫描，依次删除重复项：

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]

如果列表的所有元素都能用作集合的键（即都是 hashable ），以下做法速度往往更快：

mylist = list(set(mylist))

以上操作会将列表转换为集合，从而删除重复项，然后返回成列表。

如何从列表中删除多个项？

类似于删除重复项，一种做法是反向遍历并根据条件删除。不过更简单快速的做法就是切片替换操作，采用隐式或显式的正向迭代遍历。以下是三种变体写法：

mylist[:] = filter(keep_function, mylist)
mylist[:] = (x for x in mylist if keep_condition)
mylist[:] = [x for x in mylist if keep_condition]

列表推导式可能是最快的。

如何在 Python 中创建数组？

用列表：

["this", 1, "is", "an", "array"]

列表在时间复杂度方面相当于 C 或 Pascal 的数组；主要区别在于，Python 列表可以包含多种不同类型的对象。

array 模块也提供了一些创建具有紧凑表示形式的固定类型数据的方法，但其索引速度要比列表慢。 还可关注 NumPy [https://numpy.org/] 和其他一些第三方包也定义了一些各具特色的数组类结构体。

要获得 Lisp 风格的列表，可以使用元组来模拟 cons 单元:

lisp_list = ("like",  ("this",  ("example", None) ) )

如果需要可变特性，你可以用列表来代替元组。 在这里模拟 Lisp car 的是 lisp_list[0] 而模拟 cdr 的是 lisp_list[1]。 只有在你确定真有需要时才这样做，因为这通常会比使用 Python 列表要慢上许多。

如何创建多维列表？

多维数组或许会用以下方式建立：

>>> A = [[None] * 2] * 3

打印出来貌似没错：

>>> A
[[None, None], [None, None], [None, None]]

但如果给某一项赋值，结果会同时在多个位置体现出来：

>>> A[0][0] = 5
>>> A
[[5, None], [5, None], [5, None]]

原因在于用 * 对列表执行重复操作并不会创建副本，而只是创建现有对象的引用。 *3 创建的是包含 3 个引用的列表，每个引用指向的是同一个长度为 2 的列表。1 处改动会体现在所有地方，这一定不是应有的方案。

推荐做法是先创建一个所需长度的列表，然后将每个元素都填充为一个新建列表。

A = [None] * 3
for i in range(3):
    A[i] = [None] * 2

以上生成了一个包含 3 个列表的列表，每个子列表的长度为 2。也可以采用列表推导式：

w, h = 2, 3
A = [[None] * w for i in range(h)]

或者，你也可以使用提供矩阵数据类型的扩展；其中最著名的是 NumPy [https://numpy.org/]。

如何将方法应用于一系列对象？

可以使用列表推导式：

result = [obj.method() for obj in mylist]

为什么 a_tuple[i] += ['item'] 会引发异常？

这是由两个因素共同导致的，一是增强赋值运算符属于 赋值 运算符，二是 Python 可变和不可变对象之间的差别。

只要元组的元素指向可变对象，这时对元素进行增强赋值，那么这里介绍的内容都是适用的。在此只以 list 和 += 举例。

如果你写成这样:

>>> a_tuple = (1, 2)
>>> a_tuple[0] += 1
Traceback (most recent call last):
   ...
TypeError: 'tuple' object does not support item assignment

触发异常的原因显而易见： 1 会与指向（1）的对象 a_tuple[0] 相加，生成结果对象 2，但在试图将运算结果 2 赋值给元组的 0 号元素时就会报错，因为元组元素的指向无法更改。

其实在幕后，上述增强赋值语句的执行过程大致如下：

>>> result = a_tuple[0] + 1
>>> a_tuple[0] = result
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment

由于元组是不可变的，因此赋值这步会引发错误。

如果写成以下这样：

>>> a_tuple = (['foo'], 'bar')
>>> a_tuple[0] += ['item']
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment

这时触发异常会令人略感惊讶，更让人吃惊的是虽有报错，但加法操作却生效了：

>>> a_tuple[0]
['foo', 'item']

要明白为何会这样，你需要知道 (a) 如果一个对象实现了 __iadd__() 魔术方法，它会在执行 += 增强赋值时被调用，并且其返回值将在赋值语句中被使用； (b) 对于列表而言，__iadd__() 等价于在列表上调用 extend() 并返回该列表。 所以对于列表我们可以这样说，+= 就是 list.extend() 的“快捷方式”

>>> a_list = []
>>> a_list += [1]
>>> a_list
[1]

这相当于：

>>> result = a_list.__iadd__([1])
>>> a_list = result

a_list 所引用的对象已被修改，而引用被修改对象的指针又重新被赋值给 a_list。 赋值的最终结果没有变化，因为它是引用 a_list 之前所引用的同一对象的指针，但仍然发生了赋值操作。

因此，在此元组示例中，发生的事情等同于：

>>> result = a_tuple[0].__iadd__(['item'])
>>> a_tuple[0] = result
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment

__iadd__() 执行成功，因此列表得到了扩充，但是即使 result 是指向 a_tuple[0] 所指向的同一个对象，最后的赋值仍然会导致错误，因为元组是不可变的。

我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？

归功于 Perl 社区的 Randal Schwartz，该技术根据度量值对列表进行排序，该度量值将每个元素映射为“顺序值”。在 Python 中，请利用 list.sort() 方法的 key 参数：

Isorted = L[:]
Isorted.sort(key=lambda s: int(s[10:15]))

如何根据另一个列表的值对某列表进行排序？

将它们合并到元组的迭代器中，对结果列表进行排序，然后选择所需的元素。

>>> 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']

对象

什么是类？

类是通过执行 class 语句创建的某种对象的类型。创建实例对象时，用 Class 对象作为模板，实例对象既包含了数据（属性），又包含了数据类型特有的代码（方法）。

类可以基于一个或多个其他类（称之为基类）进行创建。基类的属性和方法都得以继承。这样对象模型就可以通过继承不断地进行细化。比如通用的 Mailbox 类提供了邮箱的基本访问方法.，它的子类 MboxMailbox、 MaildirMailbox、 OutlookMailbox 则能够处理各种特定的邮箱格式。

什么是方法？

方法是属于对象的函数，对于对象 x ，通常以 x.name(arguments...) 的形式调用。方法以函数的形式给出定义，位于类的定义内：

class C:
    def meth(self, arg):
        return arg * 2 + self.attribute

什么是 self ？

Self 只是方法的第一个参数的习惯性名称。假定某个类中有个方法定义为 meth(self, a, b, c) ，则其实例 x 应以 x.meth(a, b, c) 的形式进行调用；而被调用的方法则应视其为做了 meth(x, a, b, c) 形式的调用。

另请参阅 为什么必须在方法定义和调用中显式使用“self”？ 。

如何检查对象是否为给定类或其子类的一个实例？

使用内置函数 isinstance(obj, cls)。 你可以检测对象是否属于多个类中的某一个的实例，只要提供一个元组而非单个类即可，如 isinstance(obj, (class1, class2, ...))，还可以检测对象是否属于 Python 的某个内置类型，如 isinstance(obj, str) 或 isinstance(obj, (int, float, complex))。

请注意 isinstance() 还会检测派生自 abstract base class 的虚继承。 因此对于已注册的类，即便没有直接或间接继承自抽象基类，对抽象基类的检测都将返回 True 。要想检测“真正的继承”，请扫描类的 MRO:

from collections.abc import Mapping

class P:
     pass

class C(P):
    pass

Mapping.register(P)

>>> c = C()
>>> isinstance(c, C)        # direct
True
>>> isinstance(c, P)        # indirect
True
>>> isinstance(c, Mapping)  # virtual
True

# Actual inheritance chain
>>> type(c).__mro__
(<class 'C'>, <class 'P'>, <class 'object'>)

# Test for "true inheritance"
>>> Mapping in type(c).__mro__
False

请注意，大多数程序不会经常用 isinstance() 对用户自定义类进行检测。 如果是自已开发的类，更合适的面向对象编程风格应该是在类中定义多种方法，以封装特定的行为，而不是检查对象属于什么类再据此干不同的事。假定有如下执行某些操作的函数:

def search(obj):
    if isinstance(obj, Mailbox):
        ...  # code to search a mailbox
    elif isinstance(obj, Document):
        ...  # code to search a document
    elif ...

更好的方法是在所有类上定义一个 search() 方法，然后调用它：

class Mailbox:
    def search(self):
        ...  # code to search a mailbox

class Document:
    def search(self):
        ...  # code to search a document

obj.search()

什么是委托？

委托是一种面向对象的技术（也称为设计模式）。假设对象 x 已经存在，现在想要改变其某个方法的行为。可以创建一个新类，其中提供了所需修改方法的新实现，而将所有其他方法都委托给 x 的对应方法。

Python 程序员可以轻松实现委托。比如以下实现了一个类似于文件的类，只是会把所有写入的数据转换为大写：

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)

这里 UpperOut 类重新定义了 write() 方法，在调用下层的 self._outfile.write() 方法之前将参数字符串转换为大写形式。 所有其他方法都被委托给下层的 self._outfile 对象。 委托是通过 __getattr__() 方法完成的；请参阅 语言参考 了解有关控制属性访问的更多信息。

请注意在更一般的情况下委托可能会变得比较棘手。 当属性即需要被设置又需要被提取时，类还必须定义 __setattr__() 方法，而这样做必须十分小心。 __setattr__() 的基本实现大致如下所示:

class X:
    ...
    def __setattr__(self, name, value):
        self.__dict__[name] = value
    ...

大多数 __setattr__() 实现都必须修改 self.__dict__ 来为自身保存局部状态而不至于造成无限递归。

如何在扩展基类的派生类中调用基类中定义的方法？

使用内置的 super() 函数：

class Derived(Base):
    def meth(self):
        super().meth()  # calls Base.meth

在下面的例子中，super() 将自动根据它的调用方 (self 值) 来确定实例对象，使用 type(self).__mro__ 查找 method resolution order (MRO)，并返回 MRO 中位于 Derived 之后的项: Base。

如何让代码更容易对基类进行修改？

可以为基类赋一个别名并基于该别名进行派生。这样只要修改赋给该别名的值即可。顺便提一下，如要动态地确定（例如根据可用的资源）该使用哪个基类，这个技巧也非常方便。例如：

class Base:
    ...

BaseAlias = Base

class Derived(BaseAlias):
    ...

如何创建静态类数据和静态类方法？

Python 支持静态数据和静态方法（以 C++ 或 Java 的定义而言）。

静态数据只需定义一个类属性即可。若要为属性赋新值，则必须在赋值时显式使用类名：

class C:
    count = 0   # number of times C.__init__ called

    def __init__(self):
        C.count = C.count + 1

    def getcount(self):
        return C.count  # or return self.count

对于所有符合 isinstance(c, C) 的 c， c.count 也同样指向 C.count ，除非被 c 自身或者被从 c.__class__ 回溯到基类 C 的搜索路径上的某个类所覆盖。

注意：在 C 的某个方法内部，像 self.count = 42 这样的赋值将在 self 自身的字典中新建一个名为 "count" 的不相关实例。 想要重新绑定类静态数据名称就必须总是指明类名，无论是在方法内部还是外部:

C.count = 314

Python 支持静态方法：

class C:
    @staticmethod
    def static(arg1, arg2, arg3):
        # No 'self' parameter!
        ...

不过为了获得静态方法的效果，还有一种做法直接得多，也即使用模块级函数即可：

def getcount():
    return C.count

如果代码的结构化比较充分，每个模块只定义了一个类（或者多个类的层次关系密切相关），那就具备了应有的封装。

在 Python 中如何重载构造函数（或方法）？

这个答案实际上适用于所有方法，但问题通常首先出现于构造函数的应用场景中。

在 C++ 中，代码会如下所示：

class C {
    C() { cout << "No arguments\n"; }
    C(int i) { cout << "Argument is " << i << "\n"; }
}

在 Python 中，只能编写一个构造函数，并用默认参数捕获所有情况。例如：

class C:
    def __init__(self, i=None):
        if i is None:
            print("No arguments")
        else:
            print("Argument is", i)

这不完全等同，但在实践中足够接近。

也可以试试采用变长参数列表，例如：

def __init__(self, *args):
    ...

上述做法同样适用于所有方法定义。

在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。

以双下划线打头的变量名会被“破坏”，以便以一种简单高效的方式定义类私有变量。任何形式为 __spam 的标识符（至少前缀两个下划线，至多后缀一个下划线）文本均会被替换为 _classname__spam，其中 classname 为去除了全部前缀下划线的当前类名称。

这并不能保证私密性：外部用户仍然可以访问 "_classname__spam" 属性，私有变量值也在对象的 __dict__ 中可见。 许多 Python 程序员根本不操心要去使用私有变量名。

类定义了 __del__ 方法，但是删除对象时没有调用它。

这有几个可能的原因。

del 语句不一定要调用 __del__() -- 它只是减少对象的引用计数，如果计数达到零才会调用 __del__()。

如果你的数据结构包含循环链接（如树每个子节点都带有父节点的引用，而每个父节点也带有子节点的列表），引用计数永远不会回零。 尽管 Python 偶尔会用某种算法检测这种循环引用，但在数据结构的最后一条引用消失之后，垃圾收集器可能还要过段时间才会运行，因此 __del__() 方法可能会在不方便或随机的时刻被调用。 这对于重现一个问题是非常不方便的。 更糟糕的是，各个对象的 __del__() 方法是以随机顺序执行的。 虽然你可以运行 gc.collect() 来强制执行垃圾回收操作，但 仍会存在 一些对象永远不会被回收的失控情况。

尽管有垃圾回收器，但当对象使用完毕时在要调用的对象上定义显式的 close() 方法仍然是个好主意。 close() 方法可以随后移除引用子对象的属性。 请不要直接调用 __del__() -- __del__() 应当调用 close() 并且 close() 应当确保被可以被同一对象多次调用。

另一种避免循环引用的做法是利用 weakref 模块，该模块允许指向对象但不增加其引用计数。例如，树状数据结构应该对父节点和同级节点使用弱引用（如果真要用的话！）

最后，如果你的 __del__() 方法引发了异常，会将警告消息打印到 sys.stderr。

如何获取给定类的所有实例的列表？

Python 不会记录类（或内置类型）的实例。可以在类的构造函数中编写代码，通过保留每个实例的弱引用列表来跟踪所有实例。

为什么 id() 的结果看起来不是唯一的？

id() 返回一个整数，该整数在对象的生命周期内保证是唯一的。 因为在 CPython 中，这是对象的内存地址，所以经常发生在从内存中删除对象之后，下一个新创建的对象被分配在内存中的相同位置。 这个例子说明了这一点：

>>> id(1000)
13901272
>>> id(2000)
13901272

这两个 id 属于不同的整数对象，之前先创建了对象，执行 id() 调用后又立即被删除了。若要确保检测 id 时的对象仍处于活动状态，请再创建一个对该对象的引用：

>>> a = 1000; b = 2000
>>> id(a)
13901272
>>> id(b)
13891296

什么情况下可以依靠 is 运算符进行对象的身份相等性测试？

is 运算符可用于测试对象的身份相等性。a is b 等价于 id(a) == id(b)。

身份相等性最重要的特性就是对象总是等同于自身，a is a 一定返回 True。身份相等性测试的速度通常比相等性测试要快。而且与相等性测试不一样，身份相等性测试会确保返回布尔值 True 或 False。

但是，身份相等性测试 只能 在对象身份确定的场景下才可替代相等性测试。一般来说，有以下3种情况对象身份是可以确定的：

1） 赋值操作创建了新的名称但没有改变对象身份。 在赋值操作 new = old 之后，可以保证 new is old。

2） 将对象置入存放对象引用的容器，对象身份不会改变。在列表赋值操作 s[0] = x 之后，可以保证 s[0] is x。

3） 单例对象，也即该对象只能存在一个实例。在赋值操作 a = None 和 b = None 之后，可以保证 a is b，因为 None 是单例对象。

其他大多数情况下，都不建议使用身份相等性测试，而应采用相等性测试。尤其是不应将身份相等性测试用于检测常量值，例如 int 和 str，因为他们并不一定是单例对象：

>>> a = 1000
>>> b = 500
>>> c = b + 500
>>> a is c
False

>>> a = 'Python'
>>> b = 'Py'
>>> c = b + 'thon'
>>> a is c
False

同样地，可变容器的新实例，对象身份一定不同：

>>> a = []
>>> b = []
>>> a is b
False

在标准库代码中，给出了一些正确使用对象身份测试的常见模式：

1） 正如 PEP 8 [https://www.python.org/dev/peps/pep-0008] 所推荐的，对象身份测试是 None 值的推荐检测方式。这样的代码读起来就像自然的英文，并可以避免与其他可能为布尔值且计算结果为 False 的对象相混淆。

2) Detecting optional arguments can be tricky when None is a valid input value. In those situations, you can create a singleton sentinel object guaranteed to be distinct from other objects. For example, here is how to implement a method that behaves like dict.pop():

_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

3） 编写容器的实现代码时，有时需要用对象身份测试来加强相等性检测。这样代码就不会被 float('NaN') 这类与自身不相等的对象所干扰。

例如，以下是 collections.abc.Sequence.__contains__() 的实现代码：

def __contains__(self, value):
    for v in self:
        if v is value or v == value:
            return True
    return False

一个子类如何控制哪些数据被存储在一个不可变的实例中？

当子类化一个不可变类型时，请重写 __new__() 方法而不是 __init__() 方法。 后者只在一个实例被创建 之后 运行，这对于改变不可变实例中的数据来说太晚了。

所有这些不可变的类都有一个与它们的父类不同的签名:

from datetime import date

class FirstOfMonthDate(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 = ''.join([c for c in s if c.isalnum() or c == '-'])
        return super().__new__(cls, s)

这些类可以这样使用:

>>> FirstOfMonthDate(2012, 2, 14)
FirstOfMonthDate(2012, 2, 1)
>>> NamedInt('ten')
10
>>> NamedInt(20)
20
>>> TitleStr('Blog: Why Python Rocks')
'blog-why-python-rocks'

我该如何缓存方法调用？

缓存方法的两个主要工具是 functools.cached_property() 和 functools.lru_cache()。 前者在实例层级上存储结果而后者在类层级上存储结果。

cached_property 方式仅适用于不接受任何参数的方法。 它不会创建对实例的引用。 被缓存的方法结果将仅在实例的生存其内被保留。

其优点是，当一个实例不再被使用时，缓存的方法结果将被立即释放。缺点是，如果实例累积起来，累积的方法结果也会增加。它们可以无限制地增长。

lru_cache 方式适用于具有 hashable 参数的方法。 它会创建对实例的引用，除非特别设置了传入弱引用。

最少近期使用算法的优点是缓存会受指定的 maxsize 限制。 它的缺点是实例会保持存活，直到其达到生存期或者缓存被清空。

这个例子演示了几种不同的方式:

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"
        # Depends on the station_id, date, and units.

上面的例子假定 station_id 从不改变。 如果相关实例属性是可变对象，则 cached_property 方式就不再适用，因为它无法检测到属性的改变。

lru_cache 方式仍然能够适用，但类需要定义 __eq__ 和 __hash__ 方法以便缓存能够检测到相关属性的更新:

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'
        # Depends on the station_id, date, and units.

模块

如何创建 .pyc 文件？

当首次导入模块时（或当前已编译文件创建之后源文件发生了改动），在 .py 文件所在目录的 __pycache__ 子目录下会创建一个包含已编译代码的 .pyc 文件。该 .pyc 文件的名称开头部分将与 .py 文件名相同，并以 .pyc 为后缀，中间部分则依据创建它的 python 版本而各不相同。（详见 PEP 3147 [https://www.python.org/dev/peps/pep-3147]。）

.pyc 文件有可能会无法创建，原因之一是源码文件所在的目录存在权限问题，这样就无法创建 __pycache__ 子目录。假如以某个用户开发程序而以另一用户运行程序，就有可能发生权限问题，测试 Web 服务器就属于这种情况。

除非设置了 PYTHONDONTWRITEBYTECODE 环境变量，否则导入模块并且 Python 能够创建 __pycache__ 子目录并把已编译模块写入该子目录（权限、存储空间等等）时，.pyc 文件就将自动创建。

在最高层级运行的 Python 脚本不会被视为经过了导入操作，因此不会创建 .pyc 文件。假定有一个最高层级的模块文件 foo.py，它导入了另一个模块 xyz.py，当运行 foo 模块（通过输入 shell 命令 python foo.py ），则会为 xyz 创建一个 .pyc，因为 xyz 是被导入的，但不会为 foo 创建 .pyc 文件，因为 foo.py 不是被导入的。

若要为 foo 创建 .pyc 文件 —— 即为未做导入的模块创建 .pyc 文件 —— 可以利用 py_compile 和 compileall 模块。

py_compile 模块能够手动编译任意模块。 一种做法是交互式地使用该模块中的 compile() 函数:

>>> import py_compile
>>> py_compile.compile('foo.py')

这将会将 .pyc 文件写入与 foo.py 相同位置下的 __pycache__ 子目录（或者你也可以通过可选参数 cfile 来重写该行为）。

还可以用 compileall 模块自动编译一个或多个目录下的所有文件。只要在命令行提示符中运行 compileall.py 并给出要编译的 Python 文件所在目录路径即可：

python -m compileall .

如何找到当前模块名称？

模块可以查看预定义的全局变量 __name__ 获悉自己的名称。如其值为 '__main__' ，程序将作为脚本运行。通常，许多通过导入使用的模块同时也提供命令行接口或自检代码，这些代码只在检测到处于 __name__ 之后才会执行：

def main():
    print('Running test...')
    ...

if __name__ == '__main__':
    main()

如何让模块相互导入？

假设有以下模块：

foo.py:

from bar import bar_var
foo_var = 1

bar.py:

from foo import foo_var
bar_var = 2

问题是解释器将执行以下步骤：

首先导入 foo

为 foo 创建空的全局变量

编译 foo 并开始执行

foo 导入 bar

为 bar 创建空的全局变量

编译 bar 并开始执行

bar 导入 foo (该步骤无操作，因为已经有一个名为 foo 的模块)。

导入机制尝试从 foo_var 全局变量读取 foo，用来设置 bar.foo_var = foo.foo_var

最后一步失败了，因为 Python 还没有完成对 foo 的解释，foo 的全局符号字典仍然是空的。

当你使用 import foo ，然后尝试在全局代码中访问 foo.foo_var 时，会发生同样的事情。

这个问题有（至少）三种可能的解决方法。

Guido van Rossum 建议完全避免使用 from <module> import ... ，并将所有代码放在函数中。全局变量和类变量的初始化只应使用常量或内置函数。这意味着导入模块中的所有内容都以 <module>.<name> 的形式引用。

Jim Roskind 建议每个模块都应遵循以下顺序：

导出（全局变量、函数和不需要导入基类的类）

import 语句

本模块的功能代码（包括根据导入值进行初始化的全局变量）。

Van Rossum 不太喜欢这种方法，因为import出现在一个奇怪的地方，但它确实有效。

Matthias Urlichs 建议对代码进行重构，使得递归导入根本就没必要发生。

这些解决方案并不相互排斥。

__import__('x.y.z') 返回的是 <module 'x'> ；该如何得到 z 呢？

不妨考虑换用 importlib 中的函数 import_module() ：

z = importlib.import_module('x.y.z')

对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？

出于效率和一致性的原因，Python 仅在第一次导入模块时读取模块文件。否则，在一个多模块的程序中，每个模块都会导入相同的基础模块，那么基础模块将会被一而再、再而三地解析。如果要强行重新读取已更改的模块，请执行以下操作：

import importlib
import modname
importlib.reload(modname)

警告：这种技术并非万无一失。尤其是模块包含了以下语句时：

from modname import some_objects

仍将继续使用前一版的导入对象。如果模块包含了类的定义，并 不会 用新的类定义更新现有的类实例。这样可能会导致以下矛盾的行为：

>>> 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

只要把类对象的 id 打印出来，问题的性质就会一目了然：

>>> hex(id(c.__class__))
'0x7352a0'
>>> hex(id(cls.C))
'0x4198d0'

设计和历史常见问题

目录

设计和历史常见问题

为什么 Python 使用缩进来分组语句？

为什么简单的算术运算得到奇怪的结果？

为什么浮点计算不准确？

为什么Python字符串是不可变的？

为什么必须在方法定义和调用中显式使用“self”？

为什么不能在表达式中赋值？

为什么Python对某些功能（例如list.index()）使用方法来实现，而其他功能（例如len(List)）使用函数实现？

为什么 join() 是一个字符串方法而不是列表或元组方法？

异常有多快？

为什么Python中没有switch或case语句？

难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？

为什么lambda表达式不能包含语句？

可以将Python编译为机器代码，C或其他语言吗？

Python如何管理内存？

为什么CPython不使用更传统的垃圾回收方案？

CPython退出时为什么不释放所有内存？

为什么有单独的元组和列表数据类型？

列表是如何在CPython中实现的？

字典是如何在CPython中实现的？

为什么字典key必须是不可变的？

为什么 list.sort() 没有返回排序列表？

如何在Python中指定和实施接口规范？

为什么没有goto？

为什么原始字符串（r-strings）不能以反斜杠结尾？

为什么Python没有属性赋值的“with”语句？

生成器为什么不支持 with 语句？

为什么 if/while/def/class语句需要冒号？

为什么Python在列表和元组的末尾允许使用逗号？

为什么 Python 使用缩进来分组语句？

Guido van Rossum 认为使用缩进进行分组非常优雅，并且大大提高了普通 Python 程序的清晰度。 大多数人在一段时间后就会喜欢上这个特性。

由于没有开始/结束括号，因此解析器感知的分组与人类读者之间不会存在分歧。 偶尔 C 程序员会遇到像这样的代码片段:

if (x <= y)
        x++;
        y--;
z++;

如果条件为真，则只执行 x++ 语句，但缩进会使你认为情况并非如此。 即使是经验丰富的 C 程序员有时也会长久地盯着它发呆，不明白为什么在 x > y 时 y 也会减少。

因为没有开始/结束花括号，所以 Python 更不容易发生代码风格冲突。 在 C 中有许多不同的放置花括号的方式。 在习惯了阅读和编写某种特定风格的代码之后，当阅读（或被要求编写）另一种风格的代码时通常都会令人感觉有点不舒服）。

许多编码风格将开始/结束括号单独放在一行上。这使得程序相当长，浪费了宝贵的屏幕空间，使得更难以对程序进行全面的了解。 理想情况下，函数应该适合一个屏幕（例如，20--30行）。 20 行 Python 可以完成比 20 行 C 更多的工作。 这不仅仅是由于没有开始/结束括号 -- 无需声明以及高层级的数据类型也是其中的原因 -- 但基于缩进的语法肯定有帮助。

为什么简单的算术运算得到奇怪的结果？

请看下一个问题。

为什么浮点计算不准确？

用户经常对这样的结果感到惊讶:

>>> 1.2 - 1.0
0.19999999999999996

并且认为这是 Python 中的一个 bug。其实不是这样。这与 Python 关系不大，而与底层平台如何处理浮点数字关系更大。

CPython 中的 float 类型使用C语言的 double 类型进行存储。 float 对象的值是以固定的精度（通常为 53 位）存储的二进制浮点数，由于 Python 使用 C 操作，而后者依赖于处理器中的硬件实现来执行浮点运算。 这意味着就浮点运算而言，Python 的行为类似于许多流行的语言，包括 C 和 Java。

许多可以轻松地用十进制表示的数字不能用二进制浮点表示。例如，在输入以下语句后:

>>> x = 1.2

为 x 存储的值是与十进制的值 1.2 (非常接近) 的近似值，但不完全等于它。 在典型的机器上，实际存储的值是：

1.0011001100110011001100110011001100110011001100110011 (binary)

它对应于十进制数值:

1.1999999999999999555910790149937383830547332763671875 (decimal)

典型的 53 位精度为 Python 浮点数提供了 15-16 位小数的精度。

要获得更完整的解释，请参阅 Python 教程中的 浮点算术 一章。

为什么Python字符串是不可变的？

有几个优点。

一个是性能：知道字符串是不可变的，意味着我们可以在创建时为它分配空间，并且存储需求是固定不变的。这也是元组和列表之间区别的原因之一。

另一个优点是，Python 中的字符串被视为与数字一样“基本”。 任何动作都不会将值 8 更改为其他值，在 Python 中，任何动作都不会将字符串 "8" 更改为其他值。

为什么必须在方法定义和调用中显式使用“self”？

这个想法借鉴了 Modula-3 语言。 出于多种原因它被证明是非常有用的。

首先，更明显的显示出，使用的是方法或实例属性而不是局部变量。 阅读 self.x 或 self.meth() 可以清楚地表明，即使您不知道类的定义，也会使用实例变量或方法。在 C++ 中，可以通过缺少局部变量声明来判断（假设全局变量很少见或容易识别） —— 但是在 Python 中没有局部变量声明，所以必须查找类定义才能确定。 一些 C++ 和 Java 编码标准要求实例属性具有 m_ 前缀，因此这种显式性在这些语言中仍然有用。

其次，这意味着如果要显式引用或从特定类调用该方法，不需要特殊语法。 在 C++ 中，如果你想使用在派生类中重写基类中的方法，你必须使用 :: 运算符 -- 在 Python 中你可以编写 baseclass.methodname(self, <argument list>)。 这对于 __init__() 方法非常有用，特别是在派生类方法想要扩展同名的基类方法，而必须以某种方式调用基类方法时。

最后，它解决了变量赋值的语法问题：为了 Python 中的局部变量（根据定义！）在函数体中赋值的那些变量（并且没有明确声明为全局）赋值，就必须以某种方式告诉解释器一个赋值是为了分配一个实例变量而不是一个局部变量，它最好是通过语法实现的（出于效率原因）。 C++ 通过声明来做到这一点，但是 Python 没有声明，仅仅为了这个目的而引入它们会很可惜。 使用显式的 self.var 很好地解决了这个问题。 类似地，对于使用实例变量，必须编写 self.var 意味着对方法内部的非限定名称的引用不必搜索实例的目录。 换句话说，局部变量和实例变量存在于两个不同的命名空间中，您需要告诉 Python 使用哪个命名空间。

为什么不能在表达式中赋值？

自 Python 3.8 开始，你能做到的！

赋值表达式使用海象运算符 := 在表达式中为变量赋值:

while chunk := fp.read(200):
   print(chunk)

请参阅 PEP 572 [https://www.python.org/dev/peps/pep-0572] 了解详情。

为什么Python对某些功能（例如list.index()）使用方法来实现，而其他功能（例如len(List)）使用函数实现？

正如Guido所说：

(a) 对于某些操作，前缀表示法比后缀更容易阅读 -- 前缀（和中缀！）运算在数学中有着悠久的传统，就像在视觉上帮助数学家思考问题的记法。比较一下我们将 x*(a+b) 这样的公式改写为 x*a+x*b 的容易程度，以及使用原始OO符号做相同事情的笨拙程度。

(b) 当读到写有len(X)的代码时，就知道它要求的是某件东西的长度。这告诉我们两件事：结果是一个整数，参数是某种容器。相反，当阅读x.len()时，必须已经知道x是某种实现接口的容器，或者是从具有标准len()的类继承的容器。当没有实现映射的类有get()或key()方法，或者不是文件的类有write()方法时，我们偶尔会感到困惑。

—https://mail.python.org/pipermail/python-3000/2006-November/004643.html

为什么 join() 是一个字符串方法而不是列表或元组方法？

从 Python 1.6 开始，字符串变得更像其他标准类型，当添加方法时，这些方法提供的功能与始终使用 String 模块的函数时提供的功能相同。这些新方法中的大多数已被广泛接受，但似乎让一些程序员感到不舒服的一种方法是：

", ".join(['1', '2', '4', '8', '16'])

结果如下:

"1, 2, 4, 8, 16"

反对这种用法有两个常见的论点。

第一条是这样的：“使用字符串文本(String Constant)的方法看起来真的很难看”，答案是也许吧，但是字符串文本只是一个固定值。如果在绑定到字符串的名称上允许使用这些方法，则没有逻辑上的理由使其在文字上不可用。

第二个异议通常是这样的：“我实际上是在告诉序列使用字符串常量将其成员连接在一起”。遗憾的是并非如此。出于某种原因，把 split() 作为一个字符串方法似乎要容易得多，因为在这种情况下，很容易看到:

"1, 2, 4, 8, 16".split(", ")

是对字符串文本的指令，用于返回由给定分隔符分隔的子字符串（或在默认情况下，返回任意空格）。

join() 是字符串方法，因为在使用该方法时，您告诉分隔符字符串去迭代一个字符串序列，并在相邻元素之间插入自身。此方法的参数可以是任何遵循序列规则的对象，包括您自己定义的任何新的类。对于字节和字节数组对象也有类似的方法。

异常有多快？

如果没有引发异常，则try/except块的效率极高。实际上捕获异常是昂贵的。在2.0之前的Python版本中，通常使用这个习惯用法:

try:
    value = mydict[key]
except KeyError:
    mydict[key] = getvalue(key)
    value = mydict[key]

只有当你期望dict在任何时候都有key时，这才有意义。如果不是这样的话，你就是应该这样编码：

if key in mydict:
    value = mydict[key]
else:
    value = mydict[key] = getvalue(key)

对于这种特定的情况，您还可以使用 value = dict.setdefault(key, getvalue(key))，但前提是调用 getvalue() 足够便宜，因为在所有情况下都会对其进行评估。

为什么Python中没有switch或case语句？

你可以足够方便地使用一串 if... elif... elif... else 来做到这一点。 对于字面值或某一命名空间内的常量，你还可以 使用 match ... case 语句。

对于需要从大量可能性中进行选择的情况，可以创建一个字典，将case 值映射到要调用的函数。例如：

functions = {'a': function_1,
             'b': function_2,
             'c': self.method_1}

func = functions[value]
func()

对于对象调用方法，可以通过使用 getattr() 内置检索具有特定名称的方法来进一步简化：

class MyVisitor:
    def visit_a(self):
        ...

    def dispatch(self, value):
        method_name = 'visit_' + str(value)
        method = getattr(self, method_name)
        method()

建议对方法名使用前缀，例如本例中的 visit_ 。如果没有这样的前缀，如果值来自不受信任的源，攻击者将能够调用对象上的任何方法。

难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？

答案1： 不幸的是，解释器为每个Python堆栈帧推送至少一个C堆栈帧。此外，扩展可以随时回调Python。因此，一个完整的线程实现需要对C的线程支持。

答案2： 幸运的是， Stackless Python [https://github.com/stackless-dev/stackless/wiki] 有一个完全重新设计的解释器循环，可以避免C堆栈。

为什么lambda表达式不能包含语句？

Python 的 lambda 表达式不能包含语句，因为Python的语法框架不能处理嵌套在表达式内部的语句。然而，在 Python 中，这并不是一个严重的问题。 与其他语言中添加功能的 lambda 形式不同，Python 的 lambda 只是一种速记符号，如果您懒得定义函数的话。

函数已经是 Python 中的第一等对象，并且可以在局部作用域中声明。 因此使用 lambda 而非局部定义函数的唯一优点是你不需要为函数指定名称 -- 但那只是一个被赋值为函数对象（它的类型与 lambda 表达式所产生的对象完全相同）的局部变量！

可以将Python编译为机器代码，C或其他语言吗？

Cython [https://cython.org/] 会将带有可选标注的修改版 Python 编译为 C 扩展。 Nuitka [https://www.nuitka.net/] 是一个 Python 至 C++ 代码的新兴编译器，它的目标是支持完整的 Python 语言。

Python如何管理内存？

Python 内存管理的细节取决于实现。 Python 的标准实现 CPython 使用引用计数来检测不可访问的对象，并使用另一种机制来收集引用循环，定期执行循环检测算法来查找不可访问的循环并删除所涉及的对象。 gc 模块提供了执行垃圾回收、获取调试统计信息和优化收集器参数的函数。

不同，其他实现 (如 Jython [https://www.jython.org] 或 PyPy [https://www.pypy.org]) 可能会依赖不同的机制，如完全的垃圾回收器。 如果你的 Python 代码依赖于引用计数实现的行为则这种差异可能会导致某些微妙的移植问题。

在一些Python实现中，以下代码（在CPython中工作的很好）可能会耗尽文件描述符:

for file in very_long_list_of_files:
    f = open(file)
    c = f.read(1)

实际上，使用CPython的引用计数和析构函数方案， 每个新赋值的 f 都会关闭前一个文件。然而，对于传统的GC，这些文件对象只能以不同的时间间隔（可能很长的时间间隔）被收集（和关闭）。

如果要编写可用于任何python实现的代码，则应显式关闭该文件或使用 with 语句；无论内存管理方案如何，这都有效：

for file in very_long_list_of_files:
    with open(file) as f:
        c = f.read(1)

为什么CPython不使用更传统的垃圾回收方案？

首先，这不是C标准特性，因此不能移植。(是的，我们知道Boehm GC库。它包含了 大多数 常见平台（但不是所有平台）的汇编代码，尽管它基本上是透明的，但也不是完全透明的; 要让Python使用它，需要使用补丁。)

当Python嵌入到其他应用程序中时，传统的GC也成为一个问题。在独立的Python中，可以用GC库提供的版本替换标准的malloc()和free()，嵌入Python的应用程序可能希望用 它自己 替代malloc()和free()，而可能不需要Python的。现在，CPython可以正确地实现malloc()和free()。

CPython退出时为什么不释放所有内存？

当Python退出时，从全局命名空间或Python模块引用的对象并不总是被释放。 如果存在循环引用，则可能发生这种情况 C库分配的某些内存也是不可能释放的（例如像Purify这样的工具会抱怨这些内容）。 但是，Python在退出时清理内存并尝试销毁每个对象。

如果要强制 Python 在释放时删除某些内容，请使用 atexit 模块运行一个函数，强制删除这些内容。

为什么有单独的元组和列表数据类型？

虽然列表和元组在许多方面是相似的，但它们的使用方式通常是完全不同的。可以认为元组类似于Pascal记录或C结构；它们是相关数据的小集合，可以是不同类型的数据，可以作为一个组进行操作。例如，笛卡尔坐标适当地表示为两个或三个数字的元组。

另一方面，列表更像其他语言中的数组。它们倾向于持有不同数量的对象，所有对象都具有相同的类型，并且逐个操作。例如， os.listdir('.') 返回表示当前目录中的文件的字符串列表。如果向目录中添加了一两个文件，对此输出进行操作的函数通常不会中断。

元组是不可变的，这意味着一旦创建了元组，就不能用新值替换它的任何元素。列表是可变的，这意味着您始终可以更改列表的元素。只有不变元素可以用作字典的key，因此只能将元组和非列表用作key。

列表是如何在CPython中实现的？

CPython的列表实际上是可变长度的数组，而不是lisp风格的链表。该实现使用对其他对象的引用的连续数组，并在列表头结构中保留指向该数组和数组长度的指针。

这使得索引列表 a[i] 的操作成本与列表的大小或索引的值无关。

当添加或插入项时，将调整引用数组的大小。并采用了一些巧妙的方法来提高重复添加项的性能; 当数组必须增长时，会分配一些额外的空间，以便在接下来的几次中不需要实际调整大小。

字典是如何在CPython中实现的？

CPython的字典实现为可调整大小的哈希表。与B-树相比，这在大多数情况下为查找（目前最常见的操作）提供了更好的性能，并且实现更简单。

字典的工作方式是使用 hash() 内置函数计算字典中存储的每个键的hash代码。hash代码根据键和每个进程的种子而变化很大；例如，"Python" 的hash值为-539294296，而"python"(一个按位不同的字符串)的hash值为1142331976。然后，hash代码用于计算内部数组中将存储该值的位置。假设您存储的键都具有不同的hash值，这意味着字典需要恒定的时间 -- O(1)，用Big-O表示法 -- 来检索一个键。

为什么字典key必须是不可变的？

字典的哈希表实现使用从键值计算的哈希值来查找键。如果键是可变对象，则其值可能会发生变化，因此其哈希值也会发生变化。但是，由于无论谁更改键对象都无法判断它是否被用作字典键值，因此无法在字典中修改条目。然后，当你尝试在字典中查找相同的对象时，将无法找到它，因为其哈希值不同。如果你尝试查找旧值，也不会找到它，因为在该哈希表中找到的对象的值会有所不同。

如果你想要一个用列表索引的字典，只需先将列表转换为元组；用函数 tuple(L) 创建一个元组，其条目与列表 L 相同。 元组是不可变的，因此可以用作字典键。

已经提出的一些不可接受的解决方案：

哈希按其地址（对象ID）列出。这不起作用，因为如果你构造一个具有相同值的新列表，它将无法找到；例如:

mydict = {[1, 2]: '12'}
print(mydict[[1, 2]])

会引发一个 KeyError 异常，因为第二行中使用的 [1, 2] 的 id 与第一行中的 id 不同。换句话说，应该使用 == 来比较字典键，而不是使用 is 。

使用列表作为键时进行复制。这没有用的，因为作为可变对象的列表可以包含对自身的引用，然后复制代码将进入无限循环。

允许列表作为键，但告诉用户不要修改它们。当你意外忘记或修改列表时，这将产生程序中的一类难以跟踪的错误。它还使一个重要的字典不变量无效： d.keys() 中的每个值都可用作字典的键。

将列表用作字典键后，应标记为其只读。问题是，它不仅仅是可以改变其值的顶级对象；你可以使用包含列表作为键的元组。将任何内容作为键关联到字典中都需要将从那里可到达的所有对象标记为只读 —— 并且自引用对象可能会导致无限循环。

如果需要，可以使用以下方法来解决这个问题，但使用它需要你自担风险：你可以将一个可变结构包装在一个类实例中，该实例同时具有 __eq__() 和 __hash__() 方法。然后，你必须确保驻留在字典（或其他基于 hash 的结构）中的所有此类包装器对象的哈希值在对象位于字典（或其他结构）中时保持固定。:

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

注意，哈希计算由于列表的某些成员可能不可用以及算术溢出的可能性而变得复杂。

此外，必须始终如此，如果 o1 == o2 （即 o1.__eq__(o2) is True ）则 hash(o1) == hash(o2) （即 o1.__hash__() == o2.__hash__() ），无论对象是否在字典中。 如果你不能满足这些限制，字典和其他基于 hash 的结构将会出错。

对于 ListWrapper ，只要包装器对象在字典中，包装列表就不能更改以避免异常。除非你准备好认真考虑需求以及不正确地满足这些需求的后果，否则不要这样做。请留意。

为什么 list.sort() 没有返回排序列表？

在性能很重要的情况下，仅仅为了排序而复制一份列表将是一种浪费。因此， list.sort() 对列表进行了适当的排序。为了提醒您这一事实，它不会返回已排序的列表。这样，当您需要排序的副本，但也需要保留未排序的版本时，就不会意外地覆盖列表。

如果要返回新列表，请使用内置 sorted() 函数。此函数从提供的可迭代列表中创建新列表，对其进行排序并返回。例如，下面是如何迭代遍历字典并按keys排序:

for key in sorted(mydict):
    ...  # do whatever with mydict[key]...

如何在Python中指定和实施接口规范？

由C++和Java等语言提供的模块接口规范描述了模块的方法和函数的原型。许多人认为接口规范的编译时强制执行有助于构建大型程序。

Python 2.6添加了一个 abc 模块，允许定义抽象基类 (ABCs)。然后可以使用 isinstance() 和 issubclass() 来检查实例或类是否实现了特定的ABC。 collections.abc 模块定义了一组有用的ABCs 例如 Iterable ， Container , 和 MutableMapping

对于 Python，接口规范的许多好处可以通过组件的适当测试规程来获得。

一个好的模块测试套件既可以提供回归测试，也可以作为模块接口规范和一组示例。许多Python模块可以作为脚本运行，以提供简单的“自我测试”。即使是使用复杂外部接口的模块，也常常可以使用外部接口的简单“桩代码（stub）”模拟进行隔离测试。可以使用 doctest 和 unittest 模块或第三方测试框架来构造详尽的测试套件，以运行模块中的每一行代码。

适当的测试规程可以帮助在Python中构建大型的、复杂的应用程序以及接口规范。事实上，它可能会更好，因为接口规范不能测试程序的某些属性。例如， append() 方法将向一些内部列表的末尾添加新元素；接口规范不能测试您的 append() 实现是否能够正确执行此操作，但是在测试套件中检查这个属性是很简单的。

编写测试套件非常有用，并且你可能希望将你的代码设计为易于测试。 一种日益流行的技术是面向测试的开发，它要求在编写任何实际代码之前首先编写测试套件的各个部分。 当然 Python 也允许你采用更粗率的方式，不必编写任何测试用例。

为什么没有goto？

在 1970 年代人们了解到不受限制的 goto 可能导致混乱得像“意大利面”那样难以理解和修改的代码。 在高级语言中，它也是不必要的，只需有实现分支 (在 Python 中是使用 if 语句以及 or, and 和 if-else 表达式) 和循环 (使用 while 和 for 语句，并可能包含 continue 和 break) 的手段就足够了。

人们还可以使用异常捕获来提供甚至能跨函数调用的“结构化 goto”。 许多人认为异常可以方便地模拟 C, Fortran 和其他语言中所有合理使用的“go”或“goto”构造。 例如:

class label(Exception): pass  # declare a label

try:
    ...
    if condition: raise label()  # goto label
    ...
except label:  # where to goto
    pass
...

但是不允许你跳到循环的中间，这通常被认为是滥用goto。谨慎使用。

为什么原始字符串（r-strings）不能以反斜杠结尾？

更准确地说，它们不能以奇数个反斜杠结束：结尾处的不成对反斜杠会转义结束引号字符，留下未结束的字符串。

原始字符串的设计是为了方便想要执行自己的反斜杠转义处理的处理器(主要是正则表达式引擎)创建输入。此类处理器将不匹配的尾随反斜杠视为错误，因此原始字符串不允许这样做。反过来，允许通过使用引号字符转义反斜杠转义字符串。当r-string用于它们的预期目的时，这些规则工作的很好。

如果您正在尝试构建Windows路径名，请注意所有Windows系统调用都使用正斜杠:

f = open("/mydir/file.txt")  # works fine!

如果您正在尝试为DOS命令构建路径名，请尝试以下示例

dir = r"\this\is\my\dos\dir" "\\"
dir = r"\this\is\my\dos\dir\ "[:-1]
dir = "\\this\\is\\my\\dos\\dir\\"

为什么Python没有属性赋值的“with”语句？

Python 具有 'with' 语句，它能将一个代码块的执行包装起来，在进入和退出代码块时调用特定的代码。 有些语言具有这样的结构:

with obj:
    a = 1               # equivalent to obj.a = 1
    total = total + 1   # obj.total = obj.total + 1

在Python中，这样的结构是不明确的。

其他语言，如ObjectPascal、Delphi和C++ 使用静态类型，因此可以毫不含糊地知道分配给什么成员。这是静态类型的要点 -- 编译器 总是 在编译时知道每个变量的作用域。

Python使用动态类型。事先不可能知道在运行时引用哪个属性。可以动态地在对象中添加或删除成员属性。这使得无法通过简单的阅读就知道引用的是什么属性：局部属性、全局属性还是成员属性？

例如，采用以下不完整的代码段:

def foo(a):
    with a:
        print(x)

该代码段假设 "a" 必须有一个名为 "x" 的成员属性。然而，Python中并没有告诉解释器这一点。假设 "a" 是整数，会发生什么？如果有一个名为 "x" 的全局变量，它是否会在with块中使用？如您所见，Python的动态特性使得这样的选择更加困难。

然而，Python 可以通过赋值轻松实现 "with" 和类似语言特性（减少代码量）的主要好处。代替:

function(args).mydict[index][index].a = 21
function(args).mydict[index][index].b = 42
function(args).mydict[index][index].c = 63

写成这样:

ref = function(args).mydict[index][index]
ref.a = 21
ref.b = 42
ref.c = 63

这也具有提高执行速度的附带效果，因为 Python 在运行时解析名称绑定，而第二个版本只需要执行一次解析。

生成器为什么不支持 with 语句？

由于技术原因，直接作为上下文管理器使用的生成器将无法正常工作。最常见的情况是，当生成器被用作迭代器运行到完成时，不需要手动关闭。如果需要，在 'with' 语句中把它包装成 "contextlib.closing(generator)" 。

为什么 if/while/def/class语句需要冒号？

冒号主要用于增强可读性(ABC语言实验的结果之一)。考虑一下这个:

if a == b
    print(a)

与

if a == b:
    print(a)

注意第二种方法稍微容易一些。请进一步注意，在这个FAQ解答的示例中，冒号是如何设置的；这是英语中的标准用法。

另一个次要原因是冒号使带有语法突出显示的编辑器更容易工作；他们可以寻找冒号来决定何时需要增加缩进，而不必对程序文本进行更精细的解析。

为什么Python在列表和元组的末尾允许使用逗号？

Python 允许您在列表，元组和字典的末尾添加一个尾随逗号:

[1, 2, 3,]
('a', 'b', 'c',)
d = {
    "A": [1, 5],
    "B": [6, 7],  # last trailing comma is optional but good style
}

有几个理由允许这样做。

如果列表，元组或字典的字面值分布在多行中，则更容易添加更多元素，因为不必记住在上一行中添加逗号。这些行也可以重新排序，而不会产生语法错误。

不小心省略逗号会导致难以诊断的错误。例如:

x = [
  "fee",
  "fie"
  "foo",
  "fum"
]

这个列表看起来有四个元素，但实际上包含三个 : "fee", "fiefoo" 和 "fum" 。总是加上逗号可以避免这个错误的来源。

允许尾随逗号也可以使编程代码更容易生成。

代码库和插件 FAQ

目录

代码库和插件 FAQ

通用的代码库问题

如何找到可以用来做 X 任务的模块或应用？

math.py（socket.py，regex.py 等）的源文件在哪？

在 Unix 中怎样让 Python 脚本可执行？

Python 中有 curses/termcap 包吗？

Python 中存在类似 C 的 onexit() 函数的东西吗？

为什么我的信号处理函数不能工作？

通用任务

怎样测试 Python 程序或组件？

怎样用 docstring 创建文档？

怎样一次只获取一个按键？

线程相关

程序中怎样使用线程？

我的线程都没有运行，为什么？

如何将任务分配给多个工作线程？

怎样修改全局变量是线程安全的？

不能删除全局解释器锁吗？

输入与输出

怎样删除文件？（以及其他文件相关的问题……）

怎样复制文件？

怎样读取（或写入）二进制数据？

似乎 os.popen() 创建的管道不能使用 os.read()，这是为什么？

怎样访问（RS232）串口？

为什么关闭 sys.stdout（stdin，stderr）并不会真正关掉它？

网络 / Internet 编程

Python 中的 WWW 工具是什么？

怎样模拟发送 CGI 表单（METHOD=POST）？

生成 HTML 需要使用什么模块？

怎样使用 Python 脚本发送邮件？

socket 的 connect() 方法怎样避免阻塞？

数据库

Python 中有数据库包的接口吗？

在 Python 中如何实现持久化对象？

数学和数字

Python 中怎样生成随机数？

通用的代码库问题

如何找到可以用来做 X 任务的模块或应用？

在 标准库参考 中查找是否有适合的标准库模块。（如果你已经了解标准库的内容，可以跳过这一步）

对于第三方软件包，请搜索 Python Package Index [https://pypi.org] 或者是尝试 Google [https://www.google.com] 或其他网络搜索引擎。 搜索 "Python" 加上一两个你感兴趣的关键词通常就会找到一些有用的信息。

math.py（socket.py，regex.py 等）的源文件在哪？

如果找不到模块的源文件，可能它是一个内建的模块，或是使用 C，C++ 或其他编译型语言实现的动态加载模块。这种情况下可能是没有源码文件的，类似 mathmodule.c 这样的文件会存放在 C 代码目录中（但不在 Python 目录中）。

Python 中（至少）有三类模块：

使用 Python 编写的模块（.py)；

使用 C 编写的动态加载模块（.dll，.pyd，.so，.sl 等）；

使用 C 编写并链接到解释器的模块，要获取此列表，输入：

import sys
print(sys.builtin_module_names)

在 Unix 中怎样让 Python 脚本可执行？

你需要做两件事：文件必须是可执行的，并且第一行需要以 #! 开头，后面跟上 Python 解释器的路径。

第一点可以用执行 chmod +x scriptfile 或是 chmod 755 scriptfile 做到。

第二点有很多种做法，最直接的方式是：

#!/usr/local/bin/python

在文件第一行，使用你所在平台上的 Python 解释器的路径。

如果你希望脚本不依赖 Python 解释器的具体路径，你也可以使用 env 程序。假设你的 Python 解释器所在目录已经添加到了 PATH 环境变量中，几乎所有的类 Unix 系统都支持下面的写法：

#!/usr/bin/env python

不要 在 CGI 脚本中这样做。CGI 脚本的 PATH 环境变量通常会非常精简，所以你必须使用解释器的完整绝对路径。

有时候，用户的环境变量如果太长，可能会导致 /usr/bin/env 执行失败；又或者甚至根本就不存在 env 程序。在这种情况下，你可以尝试使用下面的 hack 方法（来自 Alex Rezinsky）：

#! /bin/sh
""":"
exec python $0 ${1+"$@"}
"""

这样做有一个小小的缺点，它会定义脚本的 __doc__ 字符串。不过可以这样修复：

__doc__ = """...Whatever..."""

Python 中有 curses/termcap 包吗？

对于类 Unix 系统：标准 Python 源码发行版会在 Modules [https://github.com/python/cpython/tree/3.10/Modules] 子目录中附带 curses 模块，但默认并不会编译。（注意：在 Windows 平台下不可用 —— Windows 中没有 curses 模块。）

curses 模块支持基本的 curses 特性，同时也支持 ncurses 和 SYSV curses 中的很多额外功能，比如颜色、不同的字符集支持、填充和鼠标支持。这意味着这个模块不兼容只有 BSD curses 模块的操作系统，但是目前仍在维护的系统应该都不会存在这种情况。

Python 中存在类似 C 的 onexit() 函数的东西吗？

atexit 模块提供了一个与 C 的 onexit() 函数类似的注册函数。

为什么我的信号处理函数不能工作？

最常见的问题是信号处理函数没有正确定义参数列表。它会被这样调用：

handler(signum, frame)

因此它应当声明为带有两个形参:

def handler(signum, frame):
    ...

通用任务

怎样测试 Python 程序或组件？

Python 带有两个测试框架。doctest 模块从模块的 docstring 中寻找示例并执行，对比输出是否与 docstring 中给出的是否一致。

unittest 模块是一个模仿 Java 和 Smalltalk 测试框架的更棒的测试框架。

为了使测试更容易，你应该在程序中使用良好的模块化设计。程序中的绝大多数功能都应该用函数或类方法封装 —— 有时这样做会有额外惊喜，程序会运行得更快（因为局部变量比全局变量访问要快）。除此之外，程序应该避免依赖可变的局部变量，这会使得测试困难许多。

程序的“全局主逻辑”应该尽量简单：

if __name__ == "__main__":
    main_logic()

并放置在程序主模块的最后面。

一旦你的程序已经组织为一个函数和类行为的有完整集合，你就应该编写测试函数来检测这些行为。 可以将自动执行一系列测试的测试集关联到每个模块。 这听起来似乎需要大量的工作，但是由于 Python 是如此简洁灵活因此它会极其容易。 你可以通过与“生产代码”同步编写测试函数使编程更为愉快和有趣，因为这将更容易并更早发现代码问题甚至设计缺陷。

程序主模块之外的其他“辅助模块”中可以增加自测试的入口。

if __name__ == "__main__":
    self_test()

通过使用 Python 实现的“假”接口，即使是需要与复杂的外部接口交互的程序也可以在外部接口不可用时进行测试。

怎样用 docstring 创建文档？

pydoc 模块可以用你的 Python 源代码中的文档字符串来创建 HTML。 纯粹通过文档字符串来创建 API 文档的一种替代方案是 epydoc [https://epydoc.sourceforge.net/]。 Sphinx [https://www.sphinx-doc.org] 也可以包括文档字符串的内容。

怎样一次只获取一个按键？

在类 Unix 系统中有多种方案。最直接的方法是使用 curses，但是 curses 模块太大了，难以学习。

线程相关

程序中怎样使用线程？

一定要使用 threading 模块，不要使用 _thread 模块。threading 模块对 _thread 模块提供的底层线程原语做了更易用的抽象。

我的线程都没有运行，为什么？

一旦主线程退出，所有的子线程都会被杀掉。你的主线程运行得太快了，子线程还没来得及工作。

简单的解决方法是在程序中加一个时间足够长的 sleep，让子线程能够完成运行。

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)  # <---------------------------!

但目前（在许多平台上）线程不是并行运行的，而是按顺序依次执行！原因是系统线程调度器在前一个线程阻塞之前不会启动新线程。

简单的解决方法是在运行函数的开始处加一个时间很短的 sleep。

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)

比起用 time.sleep() 猜一个合适的等待时间，使用信号量机制会更好些。有一个办法是使用 queue 模块创建一个 queue 对象，让每一个线程在运行结束时 append 一个令牌到 queue 对象中，主线程中从 queue 对象中读取与线程数量一致的令牌数量即可。

如何将任务分配给多个工作线程？

最简单的方式是使用 concurrent.futures 模块，特别是其中的 ThreadPoolExecutor 类。

或者，如果你想更好地控制分发算法，你也可以自己写逻辑实现。使用 queue 模块来创建任务列表队列。Queue 类维护一个了一个存有对象的列表，提供了 .put(obj) 方法添加元素，并且可以用 .get() 方法获取元素。这个类会使用必要的加锁操作，以此确保每个任务只会执行一次。

这是一个简单的例子：

import threading, queue, time

# The worker thread gets jobs off the queue.  When the queue is empty, it
# assumes there will be no more work and exits.
# (Realistically workers will run until terminated.)
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)

# Create queue
q = queue.Queue()

# Start a pool of 5 workers
for i in range(5):
    t = threading.Thread(target=worker, name='worker %i' % (i+1))
    t.start()

# Begin adding work to the queue
for i in range(50):
    q.put(i)

# Give threads time to run
print('Main thread sleeping')
time.sleep(5)

运行时会产生如下输出：

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
...

查看模块的文档以获取更多信息；Queue 类提供了多种接口。

怎样修改全局变量是线程安全的？

Python VM 内部会使用 global interpreter lock （GIL）来确保同一时间只有一个线程运行。通常 Python 只会在字节码指令之间切换线程；切换的频率可以通过设置 sys.setswitchinterval() 指定。从 Python 程序的角度来看，每一条字节码指令以及每一条指令对应的 C 代码实现都是原子的。

理论上说，具体的结果要看具体的 PVM 字节码实现对指令的解释。而实际上，对内建类型（int，list，dict 等）的共享变量的“类原子”操作都是原子的。

举例来说，下面的操作是原子的（L、L1、L2 是列表，D、D1、D2 是字典，x、y 是对象，i，j 是 int 变量）：

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()

这些不是原子的：

i = i+1
L.append(L[-1])
L[i] = L[j]
D[x] = D[x] + 1

覆盖其他对象的操作会在其他对象的引用计数变成 0 时触发其 __del__() 方法，这可能会产生一些影响。对字典和列表进行大量操作时尤其如此。如果有疑问的话，使用互斥锁！

不能删除全局解释器锁吗？

global interpreter lock （GIL）通常被视为 Python 在高端多核服务器上开发时的阻力，因为（几乎）所有 Python 代码只有在获取到 GIL 时才能运行，所以多线程的 Python 程序只能有效地使用一个 CPU。

在 Python 1.5 时代，Greg Stein 开发了一个完整的补丁包（“free threadings” 补丁），移除了 GIL，并用粒度更合适的锁来代替。Adam Olsen 最近也在他的 python-safethread [https://code.google.com/archive/p/python-safethread] 项目里做了类似的实验。不幸的是，由于为了移除 GIL 而使用了大量细粒度的锁，这两个实验在单线程测试中的性能都有明显的下降（至少慢 30%）。

但这并意味着你不能在多核机器上很好地使用 Python！你只需将任务划分为多*进程*，而不是多*线程*。新的 concurrent.futures 模块中的 ProcessPoolExecutor 类提供了一个简单的方法；如果你想对任务分发做更多控制，可以使用 multiprocessing 模块提供的底层 API。

恰当地使用 C 拓展也很有用；使用 C 拓展处理耗时较久的任务时，拓展可以在线程执行 C 代码时释放 GIL，让其他线程执行。zlib 和 hashlib 等标准库模块已经这样做了。

也有建议说 GIL 应该是解释器状态锁，而不是完全的全局锁；解释器不应该共享对象。不幸的是，这也不可能发生。由于目前许多对象的实现都有全局的状态，因此这是一个艰巨的工作。举例来说，小整型数和短字符串会缓存起来，这些缓存将不得不移动到解释器状态中。其他对象类型都有自己的自由变量列表，这些自由变量列表也必须移动到解释器状态中。等等。

我甚至怀疑这些工作是否可能在有限的时间内完成，因为同样的问题在第三方拓展中也会存在。第三方拓展编写的速度可比你将它们转换为把全局状态存入解释器状态中的速度快得多。

最后，假设多个解释器不共享任何状态，那么这样做比每个进程一个解释器好在哪里呢？

输入与输出

怎样删除文件？（以及其他文件相关的问题……）

使用 os.remove(filename) 或 os.unlink(filename)。查看 os 模块以获取更多文档。这两个函数是一样的，unlink() 是这个函数在 Unix 系统调用中的名字。

如果要删除目录，应该使用 os.rmdir()；使用 os.mkdir() 创建目录。os.makedirs(path) 会创建 path 中任何不存在的目录。os.removedirs(path) 则会删除其中的目录，只要它们都是空的；如果你想删除整个目录以及其中的内容，可以使用 shutil.rmtree()。

重命名文件可以使用 os.rename(old_path, new_path)。

如果需要截断文件，使用 f = open(filename, "rb+") 打开文件，然后使用 f.truncate(offset)；offset 默认是当前的搜索位置。也可以对使用 os.open() 打开的文件使用 os.ftruncate(fd, offset)，其中 fd 是文件描述符（一个小的整型数）。

shutil 模块也包含了一些处理文件的函数，包括 copyfile()，copytree() 和 rmtree()。

怎样复制文件？

shutil 模块包含一个 copyfile() 函数。注意，在 Windows NTFS 卷上，它不复制 替代数据流 [https://en.wikipedia.org/wiki/NTFS#Alternate_data_stream_(ADS)] ，也不复制 macOS HFS+ 卷上的 资源分叉 [https://en.wikipedia.org/wiki/Resource_fork] ，尽管这两者现在很少使用。它也不复制文件权限和元数据，尽管使用 shutil.copy2() 可以保留大部分（但不是全部）的内容。

怎样读取（或写入）二进制数据？

要读写复杂的二进制数据格式，最好使用 struct 模块。该模块可以读取包含二进制数据（通常是数字）的字符串并转换为 Python 对象，反之亦然。

举例来说，下面的代码会从文件中以大端序格式读取一个 2 字节的整型和一个 4 字节的整型：

import struct

with open(filename, "rb") as f:
    s = f.read(8)
    x, y, z = struct.unpack(">hhl", s)

格式字符串中的 ‘>’ 强制以大端序读取数据；字母 ‘h’ 从字符串中读取一个“短整型”（2 字节），字母 ‘l’ 读取一个“长整型”（4 字节）。

对于更常规的数据（例如整型或浮点类型的列表），你也可以使用 array 模块。

注解

要读写二进制数据的话，需要强制以二进制模式打开文件（这里为 open() 函数传入 "rb"）。如果（默认）传入 "r" 的话，文件会以文本模式打开，f.read() 会返回 str 对象，而不是 bytes 对象。

似乎 os.popen() 创建的管道不能使用 os.read()，这是为什么？

os.read() 是一个底层函数，它接收的是文件描述符 —— 用小整型数表示的打开的文件。os.popen() 创建的是一个高级文件对象，和内建的 open() 方法返回的类型一样。因此，如果要从 os.popen() 创建的管道 p 中读取 n 个字节的话，你应该使用 p.read(n)。

怎样访问（RS232）串口？

对于 Win32, OSX, Linux, BSD, Jython, IronPython:

https://pypi.org/project/pyserial/

对于 Unix，查看 Mitch Chapman 发布的帖子：

https://groups.google.com/groups?selm=34A04430.CF9@ohioee.com

为什么关闭 sys.stdout（stdin，stderr）并不会真正关掉它？

Python 文件对象 是一个对底层 C 文件描述符的高层抽象。

对于在 Python 中通过内建的 open() 函数创建的多数文件对象来说，f.close() 从 Python 的角度将其标记为已关闭，并且会关闭底层的 C 文件描述符。在 f 被垃圾回收的时候，析构函数中也会自动处理。

但由于 stdin，stdout 和 stderr 在 C 中的特殊地位，在 Python 中也会对它们做特殊处理。运行 sys.stdout.close() 会将 Python 的文件对象标记为已关闭，但是 不会 关闭与之关联的文件描述符。

要关闭这三者的 C 文件描述符的话，首先你应该确认确实需要关闭它（比如，这可能会影响到处理 I/O 的拓展）。如果确实需要这么做的话，使用 os.close()：

os.close(stdin.fileno())
os.close(stdout.fileno())
os.close(stderr.fileno())

或者也可以使用常量 0，1，2 代替。

网络 / Internet 编程

Python 中的 WWW 工具是什么？

参阅代码库参考手册中 互联网协议和支持 和 互联网数据处理 这两章的内容。Python 有大量模块来帮助你构建服务端和客户端 web 系统。

Paul Boddie 维护了一份可用框架的概览，见 https://wiki.python.org/moin/WebProgramming 。

Cameron Laird 在 https://web.archive.org/web/20210224183619/http://phaseit.net/claird/comp.lang.python/web_python 维护了一组有关 Python web 技术的实用网页。

怎样模拟发送 CGI 表单（METHOD=POST）？

我需要通过 POST 表单获取网页，有什么代码能简单做到吗？

是的。 这里是一个使用 urllib.request 的简单例子:

#!/usr/local/bin/python

import urllib.request

# build the query string
qs = "First=Josephine&MI=Q&Last=Public"

# connect and send the server a path
req = urllib.request.urlopen('http://www.some-server.out-there'
                             '/cgi-bin/some-cgi-script', data=qs)
with req:
    msg, hdrs = req.read(), req.info()

注意，通常在百分号编码的 POST 操作中，查询字符串必须使用 urllib.parse.urlencode() 处理一下。举个例子，如果要发送 name=Guy Steele, Jr. 的话：

>>> import urllib.parse
>>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'})
'name=Guy+Steele%2C+Jr.'

参见

查看 如何利用 urllib 包获取网络资源 获取更多示例。

生成 HTML 需要使用什么模块？

你可以在 Web 编程 wiki 页面 [https://wiki.python.org/moin/WebProgramming] 找到许多有用的链接。

怎样使用 Python 脚本发送邮件？

使用 smtplib 标准库模块。

下面是一个很简单的交互式发送邮件的代码。这个方法适用于任何支持 SMTP 协议的主机。

import sys, smtplib

fromaddr = input("From: ")
toaddrs  = input("To: ").split(',')
print("Enter message, end with ^D:")
msg = ''
while True:
    line = sys.stdin.readline()
    if not line:
        break
    msg += line

# The actual mail send
server = smtplib.SMTP('localhost')
server.sendmail(fromaddr, toaddrs, msg)
server.quit()

在 Unix 系统中还可以使用 sendmail。sendmail 程序的位置在不同系统中不一样，有时是在 /usr/lib/sendmail，有时是在 /usr/sbin/sendmail。sendmail 手册页面会对你有所帮助。以下是示例代码：

import os

SENDMAIL = "/usr/sbin/sendmail"  # sendmail location
p = os.popen("%s -t -i" % SENDMAIL, "w")
p.write("To: receiver@example.com\n")
p.write("Subject: test\n")
p.write("\n")  # blank line separating headers from body
p.write("Some text\n")
p.write("some more text\n")
sts = p.close()
if sts != 0:
    print("Sendmail exit status", sts)

socket 的 connect() 方法怎样避免阻塞？

通常会用 select 模块处理 socket 异步 I/O。

要防止 TCP 连接发生阻塞，你可以将 socket 设为非阻塞模式。 这样当你执行 socket.connect() 时，你将或是立即完成连接（不大可能）或是收到一个包含 .errno 错误码的异常。 errno.EINPROGRESS 表示连接正在进行但还没有完成。 不同的操作系统将返回不同的值，因此你需要确认你的系统会返回什么值。

你可以使用 socket.connect_ex() 方法来避免生成异常。 它将只返回 errno 值。 要进行轮询，你可以稍后再次调用 socket.connect_ex() -- 0 或 errno.EISCONN 表示连接已完成 -- 或者你也可以将此 socket 传给 select.select() 来检查它是否可写。

注解

asyncio 模块提供了通用的单线程并发异步库，它可被用来编写非阻塞的网络代码。 第三方的 Twisted [https://twistedmatrix.com/trac/] 库是一个热门且功能丰富的替代选择。

数据库

Python 中有数据库包的接口吗？

有的。

标准 Python 还包含了基于磁盘的哈希接口例如 DBM 和 GDBM 。除此之外还有 sqlite3 模块，该模块提供了一个轻量级的基于磁盘的关系型数据库。

大多数关系型数据库都已经支持。查看 数据库编程 wiki 页面 [https://wiki.python.org/moin/DatabaseProgramming] 获取更多信息。

在 Python 中如何实现持久化对象？

pickle 库模块以一种非常通用的方式解决了这个问题（虽然你依然不能用它保存打开的文件、套接字或窗口之类的东西），此外 shelve 库模块可使用 pickle 和 (g)dbm 来创建包含任意 Python 对象的持久化映射。

数学和数字

Python 中怎样生成随机数？

random 标准库模块实现了随机数生成器，使用起来非常简单：

import random
random.random()

这个函数会返回 [0, 1) 之间的随机浮点数。

该模块中还有许多其他的专门的生成器，例如：

randrange(a, b) 返回 [a, b) 区间内的一个整型数。

uniform(a, b) 返回 [a, b) 区间之间的浮点数。

normalvariate(mean, sdev) 使用正态（高斯）分布采样。

还有一些高级函数直接对序列进行操作，例如：

choice(S) 从给定的序列中随机选择一个元素。

shuffle(L) 会对列表执行原地重排，即将其随机地打乱。

还有 Random 类，你可以将其实例化，用来创建多个独立的随机数生成器。

扩展/嵌入常见问题

目录

扩展/嵌入常见问题

可以使用 C 语言创建自己的函数吗？

可以使用 C++ 语言创建自己的函数吗？

C很难写，有没有其他选择？

如何在 C 中执行任意 Python 语句？

如何在 C 中对任意 Python 表达式求值？

如何从Python对象中提取C的值？

如何使用Py_BuildValue()创建任意长度的元组？

如何从C调用对象的方法？

如何捕获PyErr_Print()（或打印到stdout / stderr的任何内容）的输出？

如何从C访问用Python编写的模块？

如何在 Python 中对接 C ++ 对象？

我使用Setup文件添加了一个模块，为什么make失败了？

如何调试扩展？

我想在Linux系统上编译一个Python模块，但是缺少一些文件。为什么?

如何区分“输入不完整”和“输入无效”？

如何找到未定义的g++符号__builtin_new或__pure_virtual？

能否创建一个对象类，其中部分方法在C中实现，而其他方法在Python中实现（例如通过继承）？

可以使用 C 语言创建自己的函数吗？

是的，您可以在C中创建包含函数、变量、异常甚至新类型的内置模块。在文档 扩展和嵌入 Python 解释器 中有说明。

大多数中级或高级的Python书籍也涵盖这个主题。

可以使用 C++ 语言创建自己的函数吗？

是的，可以使用 C++ 中兼容 C 的功能。 在 Python include 文件周围放置 extern "C" { ... } ，并在Python解释器调用的每个函数之前放置 extern "C" 。 具有构造函数的全局或静态 C++ 对象可能不是一个好主意。

C很难写，有没有其他选择？

编写自己的C扩展有很多选择，具体取决于您要做的事情。

Cython [https://cython.org] and its relative Pyrex [https://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/] are compilers that accept a slightly modified form of Python and generate the corresponding C code. Cython and Pyrex make it possible to write an extension without having to learn Python's C API.

如果你需要针对某些当前不存在 C or C++ library for which no Python 扩展的 C 或 C++ 库的接口，可以尝试使用 SWIG [https://www.swig.org] 等工具来包装这些库的数据类型和函数。 SIP [https://riverbankcomputing.com/software/sip/intro], CXX [https://cxx.sourceforge.net/] Boost [https://www.boost.org/libs/python/doc/index.html] 或者 Weave [https://github.com/scipy/weave] 也是用于包装 C++ 库的替代方案。

如何在 C 中执行任意 Python 语句？

执行此操作的最高层级函数为 PyRun_SimpleString()，它接受单个字符串参数用于在模块 __main__ 的上下文中执行并在成功时返回 0 而在发生异常 (包括 SyntaxError) 时返回 -1。 如果你想要更多可控性，可以使用 PyRun_String()；请在 Python/pythonrun.c 中查看 PyRun_SimpleString() 的源码。

如何在 C 中对任意 Python 表达式求值？

可以调用前一问题中介绍的函数 PyRun_String() 并附带起始标记符 Py_eval_input；它会解析表达式，对其求值并返回结果值。

如何从Python对象中提取C的值？

这取决于对象的类型。 如果是元组，PyTuple_Size() 可返回其长度而 PyTuple_GetItem() 可返回指定序号上的项。 对于列表也有类似的函数 PyListSize() 和 PyList_GetItem()。

对于字节串，PyBytes_Size() 可返回其长度而 PyBytes_AsStringAndSize() 提供一个指向其值和长度的指针。 请注意 Python 字节串可能为空，因此 C 的 strlen() 不应被使用。

要检测一个对象的类型，首先要确保它不为 NULL，然后使用 PyBytes_Check(), PyTuple_Check(), PyList_Check() 等等。

还有一个针对 Python 对象的高层级 API，通过所谓的‘抽象’接口提供 —— 请参阅 Include/abstract.h 了解详情。 它允许使用 PySequence_Length(), PySequence_GetItem() 这样的调用来与任意种类的 Python 序列进行对接，此外还可使用许多其他有用的协议例如数字 (PyNumber_Index() 等) 以及 PyMapping API 中的各种映射等等。

如何使用Py_BuildValue()创建任意长度的元组？

不可以。应该使用 PyTuple_Pack() 。

如何从C调用对象的方法？

可以使用 PyObject_CallMethod() 函数来调用某个对象的任意方法。 形参为该对象、要调用的方法名、类似 Py_BuildValue() 所用的格式字符串以及要传给方法的参数值:

PyObject *
PyObject_CallMethod(PyObject *object, const char *method_name,
                    const char *arg_format, ...);

这适用于任何具有方法的对象 —— 不论是内置方法还是用户自定义方法。 你需要负责对返回值进行最终的 Py_DECREF() 处理。

例如调用某个文件对象的 "seek" 方法并传入参数 10, 0 (假定文件对象的指针为 "f"):

res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0);
if (res == NULL) {
        ... an exception occurred ...
}
else {
        Py_DECREF(res);
}

请注意由于 PyObject_CallObject() 总是 接受一个元组作为参数列表，要调用不带参数的函数，则传入格式为 "()"，要调用只带一个参数的函数，则应将参数包含于圆括号中，例如 "(i)"。

如何捕获PyErr_Print()（或打印到stdout / stderr的任何内容）的输出？

在 Python 代码中，定义一个支持 write() 方法的对象。 将此对象赋值给 sys.stdout 和 sys.stderr。 调用 print_error 或者只是允许标准回溯机制生效。 在此之后，输出将转往你的 write() 方法所指向的任何地方。

做到这一点的最简单方式是使用 io.StringIO 类：

>>> import io, sys
>>> sys.stdout = io.StringIO()
>>> print('foo')
>>> print('hello world!')
>>> sys.stderr.write(sys.stdout.getvalue())
foo
hello world!

实现同样效果的自定义对象看起来是这样的：

>>> 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(''.join(sys.stdout.data))
foo
hello world!

如何从C访问用Python编写的模块？

你可以通过如下方式获得一个指向模块对象的指针:

module = PyImport_ImportModule("<modulename>");

如果模块尚未被导入（即它还不存在于 sys.modules 中），这会初始化该模块；否则它只是简单地返回 sys.modules["<modulename>"] 的值。 请注意它并不会将模块加入任何命名空间 —— 它只是确保模块被初始化并存在于 sys.modules 中。

之后你就可以通过如下方式来访问模块的属性（即模块中定义的任何名称）:

attr = PyObject_GetAttrString(module, "<attrname>");

调用 PyObject_SetAttrString() 为模块中的变量赋值也是可以的。

如何在 Python 中对接 C ++ 对象？

根据你的需求，可以选择许多方式。 手动的实现方式请查阅 "扩展与嵌入" 文档 来入门。 需要知道的是对于 Python 运行时系统来说，C 和 C++ 并不没有太大的区别 —— 因此围绕一个 C 结构（指针）类型构建新 Python 对象的策略同样适用于 C++ 对象。

有关C ++库，请参阅 C很难写，有没有其他选择？

我使用Setup文件添加了一个模块，为什么make失败了？

安装程序必须以换行符结束，如果没有换行符，则构建过程将失败。 （修复这个需要一些丑陋的shell脚本编程，而且这个bug很小，看起来不值得花这么大力气。)

如何调试扩展？

将GDB与动态加载的扩展名一起使用时，在加载扩展名之前，不能在扩展名中设置断点。

在您的 .gdbinit 文件中（或交互式）添加命令：

br _PyImport_LoadDynamicModule

然后运行GDB：

$ gdb /local/bin/python
gdb) run myscript.py
gdb) continue # repeat until your extension is loaded
gdb) finish   # so that your extension is loaded
gdb) br myfunction.c:50
gdb) continue

我想在Linux系统上编译一个Python模块，但是缺少一些文件。为什么?

大多数打包的Python版本不包含 /usr/lib/python2.x/config/ 目录，该目录中包含编译Python扩展所需的各种文件。

对于Red Hat，安装python-devel RPM以获取必要的文件。

对于Debian，运行 apt-get install python-dev 。

如何区分“输入不完整”和“输入无效”？

有时，希望模仿Python交互式解释器的行为，在输入不完整时(例如，您键入了“if”语句的开头，或者没有关闭括号或三个字符串引号)，给出一个延续提示，但当输入无效时，立即给出一条语法错误消息。

在Python中，您可以使用 codeop 模块，该模块非常接近解析器的行为。例如，IDLE就使用了这个。

在C中执行此操作的最简单方法是调用 PyRun_InteractiveLoop() （可能在单独的线程中）并让Python解释器为您处理输入。您还可以设置 PyOS_ReadlineFunctionPointer() 指向您的自定义输入函数。有关更多提示，请参阅 Modules/readline.c 和 Parser/myreadline.c 。

如何找到未定义的g++符号__builtin_new或__pure_virtual？

要动态加载g ++扩展模块，必须重新编译Python，要使用g ++重新链接（在Python Modules Makefile中更改LINKCC），及链接扩展模块（例如： g++ -shared -o mymodule.so mymodule.o ）。

能否创建一个对象类，其中部分方法在C中实现，而其他方法在Python中实现（例如通过继承）？

是的，您可以继承内置类，例如 int ， list ， dict 等。

Boost Python Library (BPL, https://www.boost.org/libs/python/doc/index.html) 提供了一种从 C++ 执行此操作的方式（即你可以使用 BPL 来继承用 C++ 编写的扩展类）。

Python在Windows上的常见问题

目录

Python在Windows上的常见问题

我怎样在Windows下运行一个Python程序？

我怎么让 Python 脚本可执行？

为什么有时候 Python 程序会启动缓慢？

我怎样使用 Python 脚本制作可执行文件？

*.pyd 文件和 DLL 文件相同吗？

我怎样将 Python 嵌入一个 Windows 程序？

如何让编辑器不要在我的 Python 源代码中插入 tab ？

如何在不阻塞的情况下检查按键？

我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0.dll 错误？

我怎样在Windows下运行一个Python程序？

这不一定是一个简单的问题。如果你已经熟悉在Windows的命令行中运行程序的方法，一切都显而易见；不然的话，你也许需要额外获得些许指导。

除非你使用某种集成开发环境，否则你最终会在所谓的 "命令提示窗口 "中 输入 Windows命令。 通常情况下，你可以在搜索栏中搜索 cmd 来创建这样一个窗口。你应该能够发现你已经启动了这样一个窗口，因为你会看到一个 Windows "命令提示符"，它通常看起来像这样。

C:\>

前面的字母可能会不同，而且后面有可能会有其他东西，所以你也许会看到类似这样的东西：

D:\YourName\Projects\Python>

出现的内容具体取决与你的电脑如何设置和最近用它做的事。 当你启动了这样一个窗口后，就可以开始运行Python程序了。

Python 脚本需要被另外一个叫做 Python 解释器 的程序来处理。 解释器读取脚本，把它编译成字节码，然后执行字节码来运行你的程序。 所以怎样安排解释器来处理你的 Python 脚本呢？

首先，确保命令窗口能够将“py”识别为指令来开启解释器。 如果你打开过一个命令窗口， 尝试输入命令 py 然后按回车：

C:\Users\YourName> py

然后你应当看见类似类似这样的东西：

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.
>>>

解释器已经以“交互模式”打开。这意味着你可以交互输入Python语句或表达式，并在等待时执行或评估它们。这是Python最强大的功能之一。输入几个表达式并看看结果：

>>> print("Hello")
Hello
>>> "Hello" * 3
'HelloHelloHello'

许多人把交互模式当作方便和高度可编程的计算器。 想结束交互式Python会话时，调用 exit() 函数，或者按住 Ctrl 键时输入 Z ，之后按 Enter 键返回Windows命令提示符。

你可能发现在开始菜单有这样一个条目 开始 ‣ 所有程序 ‣ Python 3.x ‣ Python (命令行)， 运行它后会出现一个有着 >>> 提示的新窗口。 在此之后，如果调用 exit() 函数或按 Ctrl-Z 组合键后窗口将会消失。 Windows 会在这个窗口中运行一个“python”命令，并且在你终止解释器的时候关闭它。

现在我们知道 py 命令已经被识别，可以输入 Python 脚本了。 你需要提供 Python 脚本的绝对路径或相对路径。 假设 Python 脚本位于桌面上并命名为 hello.py，并且命令提示符在用户主目录打开，那么可以看到类似于这样的东西:

C:\Users\YourName>

那么现在可以让 py 命令执行你的脚本，只需要输入 py 和脚本路径:

C:\Users\YourName> py Desktop\hello.py
hello

我怎么让 Python 脚本可执行？

在 Windows 上，标准 Python 安装程序已将 .py 扩展名与文件类型 (Python.File) 相关联，并为该文件类型提供运行解释器的打开命令 (D:\Program Files\Python\python.exe "%1" %*) 。 这足以使脚本在命令提示符下作为“foo.py”命令被执行。 如果希望通过简单地键入“foo”而无需输入文件扩展名来执行脚本，则需要将 .py 添加到 PATHEXT 环境变量中。

为什么有时候 Python 程序会启动缓慢？

通常，Python 在 Windows 上启动得很快，但偶尔会有错误报告说 Python 突然需要很长时间才能启动。更令人费解的是，在其他配置相同的 Windows 系统上，Python 却可以工作得很好。

该问题可能是由于计算机上的杀毒软件配置错误造成的。当将病毒扫描配置为监视文件系统中所有读取行为时，一些杀毒扫描程序会导致两个数量级的启动开销。请检查你系统安装的杀毒扫描程序的配置，确保两台机它们是同样的配置。已知的， McAfee 杀毒软件在将它设置为扫描所有文件系统访问时，会产生这个问题。

我怎样使用 Python 脚本制作可执行文件？

请参阅 如何由 Python 脚本创建能独立运行的二进制程序？ 查看可用来生成可执行文件的工具清单。

*.pyd 文件和 DLL 文件相同吗？

是的， .pyd 文件也是 dll ，但有一些差异。如果你有一个名为 foo.pyd 的DLL，那么它必须有一个函数 PyInit_foo() 。 然后你可以编写 Python 代码 “import foo” ，Python 将搜索 foo.pyd （以及 foo.py 、 foo.pyc ）。如果找到它，将尝试调用 PyInit_foo() 来初始化它。你不应将 .exe 与 foo.lib 链接，因为这会导致 Windows 要求存在 DLL 。

请注意， foo.pyd 的搜索路径是 PYTHONPATH ，与 Windows 用于搜索 foo.dll 的路径不同。此外， foo.pyd 不需要存在来运行你的程序，而如果你将程序与 dll 链接，则需要 dll 。 当然，如果你想 import foo ，则需要 foo.pyd 。在 DLL 中，链接在源代码中用 __declspec(dllexport) 声明。 在 .pyd 中，链接在可用函数列表中定义。

我怎样将 Python 嵌入一个 Windows 程序？

在 Windows 应用程序中嵌入 Python 解释器可以总结如下：

请 不要 直接将 Python 编译到你的 .exe 文件中。 在 Windows 上，Python 必须是一个 DLL 以便处理导入本身就是 DLL 的模块。 （这是首先要知道的未写入文档的关键事实。） 正确的做法，应该是链接到 pythonNN.dll；它通常安装在 C:\Windows\System 中。 NN 是 Python 的版本号，例如数字 "33" 代表 Python 3.3。

你可以通过两种不同的方式链接到 Python 。加载时链接意味着链接到 pythonNN.lib ，而运行时链接意味着链接 pythonNN.dll 。（一般说明： python NN.lib 是所谓的“import lib”，对应于 pythonNN.dll 。它只定义了链接器的符号。）

运行时链接极大地简化了链接选项，一切都在运行时发生。你的代码必须使用 Windows 的 LoadLibraryEx() 程序加载 pythonNN.dll 。代码还必须使用使用 Windows 的 GetProcAddress() 例程获得的指针访问 pythonNN.dll 中程序和数据（即 Python 的 C API ）。宏可以使这些指针对任何调用 Python C API 中的例程的 C 代码都是透明的。

如果你是使用 SWIG，那么很容易创建一个将使得应用的数据和方法可供 Python 使用的 "扩展模块"。 SWIG 将为你处理所有繁琐的细节。 结果是让你链接 置入 你的 .exe 文件当中的 C 代码 (!) 你 无需 创建一个 DLL 文件，而这也简化了链接过程。

SWIG 将创建一个 init 函数（一个 C 函数），其名称取决于扩展模块的名称。例如，如果模块的名称是 leo ，则 init 函数将被称为 initleo() 。 如果您使用 SWIG 阴影类，则 init 函数将被称为 initleoc() 。这初始化了一个由阴影类使用的隐藏辅助类。

你可以将步骤 2 中的 C 代码链接到 .exe 文件的原因是调用初始化函数等同于将模块导入 Python ！ （这是第二个关键的未记载事实。）

简而言之，你可以用以下代码使用扩展模块初始化 Python 解释器。

#include "python.h"
...
Py_Initialize();  // Initialize Python.
initmyAppc();  // Initialize (import) the helper class.
PyRun_SimpleString("import myApp");  // Import the shadow class.

Python C API 存在两个问题，如果你使用除 MSVC 之外的编译器用于构建 python.dll ，这将会变得明显。

问题 1: 接受 FILE * 参数的所谓的 "极高层级" 函数在多编译器环境中将不起作用，因为每个编译器中 struct FILE 的概念都会是不同的。 从实现的角度看来这些都是极低层级的函数。

问题2：在为 void 函数生成包装器时，SWIG 会生成以下代码：

Py_INCREF(Py_None);
_resultobj = Py_None;
return _resultobj;

Py_None 是一个宏，它扩展为对 pythonNN.dll 中名为 _Py_NoneStruct 的复杂数据结构的引用。同样，此代码将在多编译器环境中失败。将此类代码替换为：

return Py_BuildValue("");

有可能使用 SWIG 的 %typemap 命令自动进行更改，但我无法使其工作（我是一个完全的SWIG新手）。

使用 Python shell 脚本从 Windows 应用程序内部建立 Python 解释器窗口并不是一个好主意；生成的窗口将独立于应用程序的窗口系统。相反，你（或 wxPythonWindow 类）应该创建一个“本机”解释器窗口。将该窗口连接到Python解释器很容易。你可以将 Python的 i/o 重定向到支持读写的 _任意_ 对象，因此你只需要一个包含 read() 和 write() 方法的 Python 对象（在扩展模块中定义）。

如何让编辑器不要在我的 Python 源代码中插入 tab ？

本 FAQ 不建议使用制表符， Python 样式指南 PEP 8 [https://www.python.org/dev/peps/pep-0008] ，为发行的 Python 代码推荐 4 个空格；这也是 Emacs python-mode 默认值。

在任何编辑器下，混合制表符和空格都是一个坏主意。 MSVC 在这方面没有什么不同，并且很容易配置为使用空格： 点击 Tools ‣ Options ‣ Tabs，对于文件类型“Default”，设置“Tab size”和“Indent size”为 4 ，并选择“插入空格”单选按钮。

如果混合制表符和空格导致前导空格出现问题， Python 会引发 IndentationError 或 TabError 。你还可以运行 tabnanny 模块以批处理模式检查目录树。

如何在不阻塞的情况下检查按键？

使用 msvcrt 模块。 这是一个标准的 Windows 专属扩展模块。 它定义了一个函数 kbhit() 用于检查是否有键盘中的某个键被按下，以及 getch() 用于获取一个字符而不将其回显。

我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0.dll 错误？

这将在使用未安装全部更新的 Windows 8.1 或更旧的系统时发生于 Python 3.5 及之后的版本上。 首先请确保你的操作系统受支持并且已经更新补丁，如果此问题仍未解决，请访问 Microsoft support page [https://support.microsoft.com/en-us/help/3118401/] 获取有关手动安装 C 运行时更新补丁的指导。

图形用户界面（GUI）常见问题

目录

图形用户界面（GUI）常见问题

图形界面常见问题

Python 有哪些 GUI 工具包？

有关Tkinter的问题

我怎样“冻结”Tkinter程序？

在等待 I/O 操作时能够处理 Tk 事件吗？

在Tkinter中键绑定不工作：为什么？

图形界面常见问题

Python 有哪些 GUI 工具包？

Python 的标准构建包括一个指向 Tcl/Tk 部件集的面向对象的接口，称为 tkinter 。 这可能是最容易安装（因为它包含在大多数 Python 的 二进制发行版 [https://www.python.org/downloads/] 中）和使用的。关于 Tk 的更多信息，包括指向源代码的信息，见 Tcl/Tk 主页 [https://www.tcl.tk] 。 Tcl/Tk 可以完全移植到 macOS 、 Windows 和 Unix 平台。

存在多种选项，具体取决于你的目标平台。 Python Wiki 上提供了一个 跨平台 [https://wiki.python.org/moin/GuiProgramming#Cross-Platform_Frameworks] 和 平台专属 [https://wiki.python.org/moin/GuiProgramming#Platform-specific_Frameworks] 的 GUI 框架列表。

有关Tkinter的问题

我怎样“冻结”Tkinter程序？

Freeze （意为 “冻结”）是一个用来创建独立应用程序的工具。 当 “冻结” Tkinter 程序时，程序并不是真的能够独立运行，因为程序仍然需要 Tcl 和 Tk 库。

一种解决方法是将程序与 Tcl 和 Tk 库一同发布，并且在运行时使用环境变量 TCL_LIBRARY 和 TK_LIBRARY 指向他们的位置。

为了获得真正能独立运行的应用程序，来自该库的 Tcl 脚本也需要被整合进应用程序。 一个做这种事情的工具叫 SAM (独立模块)，它是 Tix 分发版的一部分 (https://tix.sourceforge.net/)。

在启用 SAM 时编译 Tix ，在 Python 文件 Modules/tkappinit.c 中执行对 Tclsam_init() 等的适当调用，并且将程序与 libtclsam 和 libtksam 相链接（可能也要包括 Tix 的库）。

在等待 I/O 操作时能够处理 Tk 事件吗？

在 Windows 以外的其他平台上可以，你甚至不需要使用线程！ 但是你必须稍微修改一下你的 I/O 代码。 Tk 有与 Xt 的 XtAddInput() 对应的调用，它允许你注册一个回调函数，当一个文件描述符可以进行 I/O 操作的时候，Tk 主循环将会调用这个回调函数。 参见 文件处理程序。

在Tkinter中键绑定不工作：为什么？

经常听到的抱怨是：已经通过 bind() 方法绑定了事件的处理程序，但是，当按下相关的按键后，这个处理程序却没有执行。

最常见的原因是，那个绑定的控件没有“键盘焦点”。请在 Tk 文档中查找 focus 指令。通常一个控件要获得“键盘焦点”，需要点击那个控件（而不是标签；请查看 takefocus 选项）。

“为什么我的电脑上安装了 Python ？”

什么是 Python？

Python 是一种程序语言，被许多应用程序使用。它不仅因易学而在许多高校用于编程入门，还被工作于 Google、NASA 和卢卡斯影业等公司的软件开发人员使用。

如果你想学习更多 Python，看看 Beginner's Guide to Python [https://wiki.python.org/moin/BeginnersGuide].

为什么我的电脑上安装了 Python ？

如果你不记得你曾主动安装过 Python，但它却出现在了你的电脑上，这里有一些可能的原因。

可能是这台电脑的其他用户因想学习编程而安装了它，你得琢磨一下谁用过这台电脑并安装了 Python。

电脑上安装的第三方应用程序可能由 Python 写成并附带了一份 Python。这样的应用程序有很多，例如GUI程序、网络服务器、管理脚本等。

一些 Windows 可能预装了 Python。在撰写本文时，我们了解到 Hewlett-Packard 和 Compaq 的计算机包含Python。显然，HP/Compaq 的一些管理工具是用 Python 编写的。

许多与Unix兼容的操作系统，如macOS和一些Linux发行版，都默认安装了Python；它包含在基本安装中。

我能删除 Python 吗？

这取决于所安装 Python 的来源

如果有人主动安装了 Python，你可以在不影响其它程序的情况下安全移除它。在 Windows 中，可使用“控制面板”中的“添加/删除程序”卸载。

如果 Python 来源于第三方应用程序，你也能删除它，但那些程序将不能正常工作。你应该使用那些应用程序的卸载器而不是直接删除 Python。

如果 Python 来自于你的操作系统，不推荐删除！如果删除了它，任何用 Python 写成的工具将无法工作，其中某些工具对于你来说可能十分重要。你甚至可能需要重装整个系统来修复因删除 Python 留下的烂摊子。

术语对照表

>>>

Python 交互模式下的默认提示符。通常可以在能在解释器中交互执行的代码示例中看到。

...

具有以下含义：

当输入带缩进的代码块时，以及在一对匹配的左右分隔符（括号、方括号、大括号或三引号）内，或在指定装饰器之后，交互式 Python 的默认提示符。

Ellipsis 内置常量。

2to3

这是一个尝试将 Python 2.x 代码转换为 Python 3.x 代码的工具，通过解析源代码和遍历解析树来处理大部分不兼容问题。

2to3 的标准库为 lib2to3；独立入口点为 Tools/scripts/2to3。 参见 2to3 --- 自动化的 Python 2 到 3 代码转写。

abstract base class -- 抽象基类

抽象基类简称 ABC，是对 duck-typing 的补充，它提供了一种定义接口的新方式，相比之下其他技巧例如 hasattr() 显得过于笨拙或有微妙错误（例如使用 魔术方法）。ABC 引入了虚拟子类，这种类并非继承自其他类，但却仍能被 isinstance() 和 issubclass() 所认可；详见 abc 模块文档。Python 自带许多内置的 ABC 用于实现数据结构（在 collections.abc 模块中）、数字（在 numbers 模块中）、流（在 io 模块中）、导入查找器和加载器（在 importlib.abc 模块中）。你可以使用 abc 模块来创建自己的 ABC。

annotation -- 标注

关联到某个变量、类属性、函数形参或返回值的标签，被约定作为 类型注解 来使用。

局部变量的标注在运行时不可访问，但全局变量、类属性和函数的标注会分别存放模块、类和函数的 __annotations__ 特殊属性中。

参见 variable annotation, function annotation, PEP 484 [https://www.python.org/dev/peps/pep-0484] 和 PEP 526 [https://www.python.org/dev/peps/pep-0526]，对此功能均有介绍。 另请参见 注解最佳实践 了解使用标注的最佳实践。

argument -- 参数

在调用函数时传给 function （或 method ）的值。参数分为两种：

关键字参数: 在函数调用中前面带有标识符（例如 name=）或者作为包含在前面带有 ** 的字典里的值传入。举例来说，3 和 5 在以下对 complex() 的调用中均属于关键字参数:

complex(real=3, imag=5)
complex(**{'real': 3, 'imag': 5})

位置参数: 不属于关键字参数的参数。位置参数可出现于参数列表的开头以及/或者作为前面带有 * 的 iterable 里的元素被传入。举例来说，3 和 5 在以下调用中均属于位置参数:

complex(3, 5)
complex(*(3, 5))

参数会被赋值给函数体中对应的局部变量。有关赋值规则参见 调用 一节。根据语法，任何表达式都可用来表示一个参数；最终算出的值会被赋给对应的局部变量。

另参见 parameter 术语表条目，常见问题中 参数与形参的区别 以及 PEP 362 [https://www.python.org/dev/peps/pep-0362]。

asynchronous context manager -- 异步上下文管理器

此种对象通过定义 __aenter__() 和 __aexit__() 方法来对 async with 语句中的环境进行控制。由 PEP 492 [https://www.python.org/dev/peps/pep-0492] 引入。

asynchronous generator -- 异步生成器

返回值为 asynchronous generator iterator 的函数。它与使用 async def 定义的协程函数很相似，不同之处在于它包含 yield 表达式以产生一系列可在 async for 循环中使用的值。

此术语通常是指异步生成器函数，但在某些情况下则可能是指 异步生成器迭代器。如果需要清楚表达具体含义，请使用全称以避免歧义。

一个异步生成器函数可能包含 await 表达式或者 async for 以及 async with 语句。

asynchronous generator iterator -- 异步生成器迭代器

asynchronous generator 函数所创建的对象。

此对象属于 asynchronous iterator，当使用 __anext__() 方法调用时会返回一个可等待对象来执行异步生成器函数的代码直到下一个 yield 表达式。

每个 yield 会临时暂停处理，记住当前位置执行状态 (包括局部变量和挂起的 try 语句)。当该 异步生成器迭代器 与其他 __anext__() 返回的可等待对象有效恢复时，它会从离开位置继续执行。参见 PEP 492 [https://www.python.org/dev/peps/pep-0492] 和 PEP 525 [https://www.python.org/dev/peps/pep-0525]。

asynchronous iterable -- 异步可迭代对象

可在 async for 语句中被使用的对象。必须通过它的 __aiter__() 方法返回一个 asynchronous iterator。由 PEP 492 [https://www.python.org/dev/peps/pep-0492] 引入。

asynchronous iterator -- 异步迭代器

实现了 __aiter__() 和 __anext__() 方法的对象。__anext__ 必须返回一个 awaitable 对象。async for 会处理异步迭代器的 __anext__() 方法所返回的可等待对象，直到其引发一个 StopAsyncIteration 异常。由 PEP 492 [https://www.python.org/dev/peps/pep-0492] 引入。

attribute -- 属性

关联到一个对象的值，通常使用点号表达式按名称来引用。 举例来说，如果对象 o 具有属性 a 则可以用 o.a 来引用它。

如果对象允许，将未被定义为 标识符和关键字 的非标识名称用作一个对象的属性也是可以的，例如使用 setattr()。 这样的属性将无法使用点号表达式来访问，而是必须通过 getattr() 来获取。

awaitable -- 可等待对象

能在 await 表达式中使用的对象。可以是 coroutine 或是具有 __await__() 方法的对象。参见 PEP 492 [https://www.python.org/dev/peps/pep-0492]。

BDFL

“终身仁慈独裁者”的英文缩写，即 Guido van Rossum [https://gvanrossum.github.io/]，Python 的创造者。

binary file -- 二进制文件

file object 能够读写 字节类对象。二进制文件的例子包括以二进制模式（'rb', 'wb' or 'rb+'）打开的文件、sys.stdin.buffer、sys.stdout.buffer 以及 io.BytesIO 和 gzip.GzipFile 的实例。

另请参见 text file 了解能够读写 str 对象的文件对象。

borrowed reference -- 借入引用

在 Python 的 C API 中，借用引用是指一种对象引用，使用该对象的代码并不持有该引用。 如果对象被销毁则它就会变成一个悬空指针。 例如，垃圾回收器可以移除对象的最后一个 strong reference 来销毁它。

推荐在 borrowed reference 上调用 Py_INCREF() 以将其原地转换为 strong reference，除非是当该对象无法在借入引用的最后一次使用之前被销毁。 Py_NewRef() 函数可以被用来创建一个新的 strong reference。

bytes-like object -- 字节型对象

支持 缓冲协议 并且能导出 C-contiguous 缓冲的对象。这包括所有 bytes、bytearray 和 array.array 对象，以及许多普通 memoryview 对象。 字节型对象可在多种二进制数据操作中使用；这些操作包括压缩、保存为二进制文件以及通过套接字发送等。

某些操作需要可变的二进制数据。这种对象在文档中常被称为“可读写字节类对象”。可变缓冲对象的例子包括 bytearray 以及 bytearray 的 memoryview。其他操作要求二进制数据存放于不可变对象 ("只读字节类对象")；这种对象的例子包括 bytes 以及 bytes 对象的 memoryview。

bytecode -- 字节码

Python 源代码会被编译为字节码，即 CPython 解释器中表示 Python 程序的内部代码。字节码还会缓存在 .pyc 文件中，这样第二次执行同一文件时速度更快（可以免去将源码重新编译为字节码）。这种 "中间语言" 运行在根据字节码执行相应机器码的 virtual machine 之上。请注意不同 Python 虚拟机上的字节码不一定通用，也不一定能在不同 Python 版本上兼容。

字节码指令列表可以在 dis 模块 的文档中查看。

callable -- 可调用对象

可调用对象就是可以执行调用运算的对象，并可能附带一组参数 (参见 argument)，使用以下语法:

callable(argument1, argument2, ...)

function，还可扩展到 method 等，就属于可调用对象。 实现了 __call__() 方法的类的实例也属于可调用对象。

callback -- 回调

一个作为参数被传入以用以在未来的某个时刻被调用的子例程函数。

class

用来创建用户定义对象的模板。类定义通常包含对该类的实例进行操作的方法定义。

class variable -- 类变量

在类中定义的变量，并且仅限在类的层级上修改 (而不是在类的实例中修改)。

coercion -- 强制类型转换

在包含两个相同类型参数的操作中，一种类型的实例隐式地转换为另一种类型。例如，int(3.15) 是将原浮点数转换为整型数 3，但在 3+4.5 中，参数的类型不一致（一个是 int, 一个是 float），两者必须转换为相同类型才能相加，否则将引发 TypeError。如果没有强制类型转换机制，程序员必须将所有可兼容参数归一化为相同类型，例如要写成 float(3)+4.5 而不是 3+4.5。

complex number -- 复数

对普通实数系统的扩展，其中所有数字都被表示为一个实部和一个虚部的和。虚数是虚数单位（-1 的平方根）的实倍数，通常在数学中写为 i，在工程学中写为 j。Python 内置了对复数的支持，采用工程学标记方式；虚部带有一个 j 后缀，例如 3+1j。如果需要 math 模块内对象的对应复数版本，请使用 cmath，复数的使用是一个比较高级的数学特性。如果你感觉没有必要，忽略它们也几乎不会有任何问题。

context manager -- 上下文管理器

在 with 语句中使用，通过定义 __enter__() 和 __exit__() 方法来控制环境状态的对象。参见 PEP 343 [https://www.python.org/dev/peps/pep-0343]。

context variable -- 上下文变量

一种根据其所属的上下文可以具有不同的值的变量。 这类似于在线程局部存储中每个执行线程可以具有不同的变量值。 不过，对于上下文变量来说，一个执行线程中可能会有多个上下文，而上下文变量的主要用途是对并发异步任务中变量进行追踪。 参见 contextvars。

contiguous -- 连续

一个缓冲如果是 C 连续 或 Fortran 连续 就会被认为是连续的。零维缓冲是 C 和 Fortran 连续的。在一维数组中，所有条目必须在内存中彼此相邻地排列，采用从零开始的递增索引顺序。在多维 C-连续数组中，当按内存地址排列时用最后一个索引访问条目时速度最快。但是在 Fortran 连续数组中则是用第一个索引最快。

coroutine -- 协程

协程是子例程的更一般形式。 子例程可以在某一点进入并在另一点退出。 协程则可以在许多不同的点上进入、退出和恢复。 它们可通过 async def 语句来实现。 参见 PEP 492 [https://www.python.org/dev/peps/pep-0492]。

coroutine function -- 协程函数

返回一个 coroutine 对象的函数。协程函数可通过 async def 语句来定义，并可能包含 await、async for 和 async with 关键字。这些特性是由 PEP 492 [https://www.python.org/dev/peps/pep-0492] 引入的。

CPython

Python 编程语言的规范实现，在 python.org [https://www.python.org] 上发布。"CPython" 一词用于在必要时将此实现与其他实现例如 Jython 或 IronPython 相区别。

decorator -- 装饰器

返回值为另一个函数的函数，通常使用 @wrapper 语法形式来进行函数变换。 装饰器的常见例子包括 classmethod() 和 staticmethod()。

装饰器语法只是一种语法糖，以下两个函数定义在语义上完全等价:

def f(arg):
    ...
f = staticmethod(f)

@staticmethod
def f(arg):
    ...

同样的概念也适用于类，但通常较少这样使用。有关装饰器的详情可参见 函数定义 和 类定义 的文档。

descriptor -- 描述器

任何定义了 __get__(), __set__() 或 __delete__() 方法的对象。当一个类属性为描述器时，它的特殊绑定行为就会在属性查找时被触发。通常情况下，使用 a.b 来获取、设置或删除一个属性时会在 a 的类字典中查找名称为 b 的对象，但如果 b 是一个描述器，则会调用对应的描述器方法。理解描述器的概念是更深层次理解 Python 的关键，因为这是许多重要特性的基础，包括函数、方法、属性、类方法、静态方法以及对超类的引用等等。

有关描述器的方法的更多信息，请参阅 实现描述器 或 描述器使用指南。

dictionary -- 字典

一个关联数组，其中的任意键都映射到相应的值。键可以是任何具有 __hash__() 和 __eq__() 方法的对象。在 Perl 语言中称为 hash。

dictionary comprehension -- 字典推导式

处理一个可迭代对象中的所有或部分元素并返回结果字典的一种紧凑写法。 results = {n: n ** 2 for n in range(10)} 将生成一个由键 n 到值 n ** 2 的映射构成的字典。 参见 列表、集合与字典的显示。

dictionary view -- 字典视图

从 dict.keys(), dict.values() 和 dict.items() 返回的对象被称为字典视图。它们提供了字典条目的一个动态视图，这意味着当字典改变时，视图也会相应改变。要将字典视图强制转换为真正的列表，可使用 list(dictview)。参见 字典视图对象。

docstring -- 文档字符串

作为类、函数或模块之内的第一个表达式出现的字符串字面值。它在代码执行时会被忽略，但会被解释器识别并放入所在类、函数或模块的 __doc__ 属性中。由于它可用于代码内省，因此是对象存放文档的规范位置。

duck-typing -- 鸭子类型

指一种编程风格，它并不依靠查找对象类型来确定其是否具有正确的接口，而是直接调用或使用其方法或属性（“看起来像鸭子，叫起来也像鸭子，那么肯定就是鸭子。”）由于强调接口而非特定类型，设计良好的代码可通过允许多态替代来提升灵活性。鸭子类型避免使用 type() 或 isinstance() 检测。(但要注意鸭子类型可以使用 抽象基类 作为补充。) 而往往会采用 hasattr() 检测或是 EAFP 编程。

EAFP

“求原谅比求许可更容易”的英文缩写。这种 Python 常用代码编写风格会假定所需的键或属性存在，并在假定错误时捕获异常。这种简洁快速风格的特点就是大量运用 try 和 except 语句。于其相对的则是所谓 LBYL 风格，常见于 C 等许多其他语言。

expression -- 表达式

可以求出某个值的语法单元。 换句话说，一个表达式就是表达元素例如字面值、名称、属性访问、运算符或函数调用的汇总，它们最终都会返回一个值。 与许多其他语言不同，并非所有语言构件都是表达式。 还存在不能被用作表达式的 statement，例如 while。 赋值也是属于语句而非表达式。

extension module -- 扩展模块

以 C 或 C++ 编写的模块，使用 Python 的 C API 来与语言核心以及用户代码进行交互。

f-string -- f-字符串

带有 'f' 或 'F' 前缀的字符串字面值通常被称为“f-字符串”即 格式化字符串字面值 的简写。参见 PEP 498 [https://www.python.org/dev/peps/pep-0498]。

file object -- 文件对象

对外提供面向文件 API 以使用下层资源的对象（带有 read() 或 write() 这样的方法）。根据其创建方式的不同，文件对象可以处理对真实磁盘文件，对其他类型存储，或是对通讯设备的访问（例如标准输入/输出、内存缓冲区、套接字、管道等等）。文件对象也被称为 文件类对象 或 流。

实际上共有三种类别的文件对象: 原始 二进制文件, 缓冲 二进制文件 以及 文本文件。它们的接口定义均在 io 模块中。 创建文件对象的规范方式是使用 open() 函数。

file-like object -- 文件型对象

file object 的同义词。

filesystem encoding and error handler -- 文件系统编码格式与错误处理器

Python 用来从操作系统解码字节串和向操作系统编码 Unicode 的编码格式与错误处理器。

文件系统编码格式必须保证能成功解码长度在 128 以下的所有字节串。 如果文件系统编码格式无法提供此保证，则 API 函数可能会引发 UnicodeError。

sys.getfilesystemencoding() 和 sys.getfilesystemencodeerrors() 函数可被用来获取文件系统编码格式与错误处理器。

filesystem encoding and error handler 是在 Python 启动时通过 PyConfig_Read() 函数来配置的：请参阅 PyConfig 的 filesystem_encoding 和 filesystem_errors 等成员。

另请参见 locale encoding。

finder -- 查找器

一种会尝试查找被导入模块的 loader 的对象。

从 Python 3.3 起存在两种类型的查找器: 元路径查找器 配合 sys.meta_path 使用，以及 path entry finders 配合 sys.path_hooks 使用。

更多详情可参见 PEP 302 [https://www.python.org/dev/peps/pep-0302], PEP 420 [https://www.python.org/dev/peps/pep-0420] 和 PEP 451 [https://www.python.org/dev/peps/pep-0451]。

floor division -- 向下取整除法

向下舍入到最接近的整数的数学除法。向下取整除法的运算符是 // 。例如，表达式 11 // 4 的计算结果是 2 ，而与之相反的是浮点数的真正除法返回 2.75 。注意 (-11) // 4 会返回 -3 因为这是 -2.75 向下 舍入得到的结果。见 PEP 238 [https://www.python.org/dev/peps/pep-0238] 。

function -- 函数

可以向调用者返回某个值的一组语句。还可以向其传入零个或多个 参数 并在函数体执行中被使用。另见 parameter, method 和 函数定义 等节。

function annotation -- 函数标注

即针对函数形参或返回值的 annotation 。

函数标注通常用于 类型提示：例如以下函数预期接受两个 int 参数并预期返回一个 int 值:

def sum_two_numbers(a: int, b: int) -> int:
   return a + b

函数标注语法的详解见 函数定义 一节。

参见 variable annotation 和 PEP 484 [https://www.python.org/dev/peps/pep-0484]，其中描述了此功能。 另请参阅 注解最佳实践 以了解使用标的最佳实践。

__future__

future 语句, from __future__ import <feature> 指示编译器使用将在未来的 Python 发布版中成为标准的语法和语义来编译当前模块。 __future__ 模块文档记录了可能 的 feature 取值。 通过导入此模块并对其变量求值，你可以看到每项新特性在何时被首次加入到该语言中以及它将（或已）在何时成为默认:

>>> import __future__
>>> __future__.division
_Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)

garbage collection -- 垃圾回收

释放不再被使用的内存空间的过程。Python 是通过引用计数和一个能够检测和打破循环引用的循环垃圾回收器来执行垃圾回收的。可以使用 gc 模块来控制垃圾回收器。

generator -- 生成器

返回一个 generator iterator 的函数。它看起来很像普通函数，不同点在于其包含 yield 表达式以便产生一系列值供给 for-循环使用或是通过 next() 函数逐一获取。

通常是指生成器函数，但在某些情况下也可能是指 生成器迭代器。如果需要清楚表达具体含义，请使用全称以避免歧义。

generator iterator -- 生成器迭代器

generator 函数所创建的对象。

每个 yield 会临时暂停处理，记住当前位置执行状态（包括局部变量和挂起的 try 语句）。当该 生成器迭代器 恢复时，它会从离开位置继续执行（这与每次调用都从新开始的普通函数差别很大）。

generator expression -- 生成器表达式

返回迭代器的表达式。它看起来像一个普通表达式，后面跟着一个:keyword:!for 子句，定义了一个循环变量、范围和一个可选的:keyword:!if 子句。以下复合表达式会为外层函数生成一系列值::

>>> sum(i*i for i in range(10))         # sum of squares 0, 1, 4, ... 81
285

generic function -- 泛型函数

为不同的类型实现相同操作的多个函数所组成的函数。在调用时会由调度算法来确定应该使用哪个实现。

另请参见 single dispatch 术语表条目、functools.singledispatch() 装饰器以及 PEP 443 [https://www.python.org/dev/peps/pep-0443]。

generic type -- 泛型

可参数化的 type；通常为 list 或 dict 这样的 容器类。用于 类型提示 和 注解。

更多细节参见 泛型别名类型、PEP 483 [https://www.python.org/dev/peps/pep-0483]、PEP 484 [https://www.python.org/dev/peps/pep-0484]、PEP 585 [https://www.python.org/dev/peps/pep-0585] 和 typing 模块。

GIL

参见 global interpreter lock。

global interpreter lock -- 全局解释器锁

CPython 解释器所采用的一种机制，它确保同一时刻只有一个线程在执行 Python bytecode。此机制通过设置对象模型（包括 dict 等重要内置类型）针对并发访问的隐式安全简化了 CPython 实现。给整个解释器加锁使得解释器多线程运行更方便，其代价则是牺牲了在多处理器上的并行性。

不过，某些标准库或第三方库的扩展模块被设计为在执行计算密集型任务如压缩或哈希时释放 GIL。 此外，在执行 I/O 操作时也总是会释放 GIL。

以往的创建实现 “线程自由” 的解释器（能以更细的粒度锁定共享数据）的努力并不成功，因为在常见的单处理器中性能会受到影响。我们认为，克服性能问题会使实现过程变得更加复杂，从而增加维护成本。

hash-based pyc -- 基于哈希的 pyc

使用对应源文件的哈希值而非最后修改时间来确定其有效性的字节码缓存文件。 参见 已缓存字节码的失效。

hashable -- 可哈希

一个对象的哈希值如果在其生命周期内绝不改变，就被称为 可哈希 （它需要具有 __hash__() 方法），并可以同其他对象进行比较（它需要具有 __eq__() 方法）。可哈希对象必须具有相同的哈希值比较结果才会相同。

可哈希性使得对象能够作为字典键或集合成员使用，因为这些数据结构要在内部使用哈希值。

大多数 Python 中的不可变内置对象都是可哈希的；可变容器（例如列表或字典）都不可哈希；不可变容器（例如元组和 frozenset）仅当它们的元素均为可哈希时才是可哈希的。 用户定义类的实例对象默认是可哈希的。 它们在比较时一定不相同（除非是与自己比较），它们的哈希值的生成是基于它们的 id()。

IDLE

Python 的集成开发与学习环境。 IDLE 是 Python 标准发行版附带的基本编辑器和解释器环境。

immutable -- 不可变对象

具有固定值的对象。不可变对象包括数字、字符串和元组。这样的对象不能被改变。如果必须存储一个不同的值，则必须创建新的对象。它们在需要常量哈希值的地方起着重要作用，例如作为字典中的键。

import path -- 导入路径

由多个位置（或 路径条目）组成的列表，会被模块的 path based finder 用来查找导入目标。在导入时，此位置列表通常来自 sys.path，但对次级包来说也可能来自上级包的 __path__ 属性。

importing -- 导入

令一个模块中的 Python 代码能为另一个模块中的 Python 代码所使用的过程。

importer -- 导入器

查找并加载模块的对象；此对象既属于 finder 又属于 loader。

interactive -- 交互

Python 有一个交互式解释器，这意味着你可以在解释器的提示符下输入语句和表达式，然后立即执行并查看结果。 只需在没有参数的情况下启动 python (如果有的话，还可以从计算机的主菜单中直接选择它来启动) 。这是测试新想法或检查模块和软件包的一种非常有效的方式 (别忘了试试``help(x)``) 。

interpreted -- 解释型

Python 一是种解释型语言，与之相对的是编译型语言，虽然两者的区别由于字节码编译器的存在而会有所模糊。这意味着源文件可以直接运行而不必显式地创建可执行文件再运行。解释型语言通常具有比编译型语言更短的开发/调试周期，但是其程序往往运行得更慢。参见 interactive。

interpreter shutdown -- 解释器关闭

当被要求关闭时，Python 解释器将进入一个特殊运行阶段并逐步释放所有已分配资源，例如模块和各种关键内部结构等。它还会多次调用 垃圾回收器。这会触发用户定义析构器或弱引用回调中的代码执行。在关闭阶段执行的代码可能会遇到各种异常，因为其所依赖的资源已不再有效（常见的例子有库模块或警告机制等）。

解释器需要关闭的主要原因有 __main__ 模块或所运行的脚本已完成执行。

iterable -- 可迭代对象

能够逐一返回其成员项的对象。 可迭代对象的例子包括所有序列类型 (例如 list, str 和 tuple) 以及某些非序列类型例如 dict, 文件对象 以及定义了 __iter__() 方法或是实现了 序列 语义的 __getitem__() 方法的任意自定义类对象。

可迭代对象被可用于 for 循环以及许多其他需要一个序列的地方（zip()、map() ...）。当一个可迭代对象作为参数传给内置函数 iter() 时，它会返回该对象的迭代器。这种迭代器适用于对值集合的一次性遍历。在使用可迭代对象时，你通常不需要调用 iter() 或者自己处理迭代器对象。for 语句会为你自动处理那些操作，创建一个临时的未命名变量用来在循环期间保存迭代器。参见 iterator、sequence 以及 generator。

iterator -- 迭代器

用来表示一连串数据流的对象。重复调用迭代器的 __next__() 方法（或将其传给内置函数 next()）将逐个返回流中的项。当没有数据可用时则将引发 StopIteration 异常。到这时迭代器对象中的数据项已耗尽，继续调用其 __next__() 方法只会再次引发 StopIteration 异常。迭代器必须具有 __iter__() 方法用来返回该迭代器对象自身，因此迭代器必定也是可迭代对象，可被用于其他可迭代对象适用的大部分场合。一个显著的例外是那些会多次重复访问迭代项的代码。容器对象（例如 list）在你每次向其传入 iter() 函数或是在 for 循环中使用它时都会产生一个新的迭代器。如果在此情况下你尝试用迭代器则会返回在之前迭代过程中被耗尽的同一迭代器对象，使其看起来就像是一个空容器。

更多信息可查看 迭代器类型。

CPython 实现细节： CPython 没有统一应用迭代器定义 __iter__() 的要求。

key function -- 键函数

键函数或称整理函数，是能够返回用于排序或排位的值的可调用对象。例如，locale.strxfrm() 可用于生成一个符合特定区域排序约定的排序键。

Python 中有许多工具都允许用键函数来控制元素的排位或分组方式。其中包括 min(), max(), sorted(), list.sort(), heapq.merge(), heapq.nsmallest(), heapq.nlargest() 以及 itertools.groupby()。

要创建一个键函数有多种方式。例如，str.lower() 方法可以用作忽略大小写排序的键函数。另外，键函数也可通过 lambda 表达式来创建，例如 lambda r: (r[0], r[2])。还有 operator 模块提供了三个键函数构造器：attrgetter()、itemgetter() 和 methodcaller()。请查看 如何排序 一节以获取创建和使用键函数的示例。

keyword argument -- 关键字参数

参见 argument。

lambda

由一个单独 expression 构成的匿名内联函数，表达式会在调用时被求值。创建 lambda 函数的句法为 lambda [parameters]: expression

LBYL

“先查看后跳跃”的英文缩写。这种代码编写风格会在进行调用或查找之前显式地检查前提条件。此风格与 EAFP 方式恰成对比，其特点是大量使用 if 语句。

在多线程环境中，LBYL 方式会导致“查看”和“跳跃”之间发生条件竞争风险。例如，以下代码 if key in mapping: return mapping[key] 可能由于在检查操作之后其他线程从 mapping 中移除了 key 而出错。这种问题可通过加锁或使用 EAFP 方式来解决。

locale encoding -- 语言区域编码格式

在 Unix 上，它是 LC_CTYPE 语言区域的编码格式。 它可以通过 locale.setlocale(locale.LC_CTYPE, new_locale) 来设置。

在 Windows 上，它是 ANSI 代码页 (例如: cp1252)。

locale.getpreferredencoding(False) 可被用来获取语言区域编码格式。

Python 使用 filesystem encoding and error handler 在 Unicode 文件名和字节串文件名之间进行转换。

list

Python 内置的一种 sequence。虽然名为列表，但更类似于其他语言中的数组而非链接列表，因为访问元素的时间复杂度为 O(1)。

list comprehension -- 列表推导式

处理一个序列中的所有或部分元素并返回结果列表的一种紧凑写法。result = ['{:#04x}'.format(x) for x in range(256) if x % 2 == 0] 将生成一个 0 到 255 范围内的十六进制偶数对应字符串（0x..）的列表。其中 if 子句是可选的，如果省略则 range(256) 中的所有元素都会被处理。

loader -- 加载器

负责加载模块的对象。它必须定义名为 load_module() 的方法。加载器通常由一个 finder 返回。详情参见 PEP 302 [https://www.python.org/dev/peps/pep-0302]，对于 abstract base class 可参见 importlib.abc.Loader。

magic method -- 魔术方法

special method 的非正式同义词 。

mapping -- 映射

一种支持任意键查找并实现了 Mapping 或 MutableMapping 抽象基类 中所规定方法的容器对象。 此类对象的例子包括 dict, collections.defaultdict, collections.OrderedDict 以及 collections.Counter。

meta path finder -- 元路径查找器

sys.meta_path 的搜索所返回的 finder。元路径查找器与 path entry finders 存在关联但并不相同。

请查看 importlib.abc.MetaPathFinder 了解元路径查找器所实现的方法。

metaclass -- 元类

一种用于创建类的类。类定义包含类名、类字典和基类列表。元类负责接受上述三个参数并创建相应的类。大部分面向对象的编程语言都会提供一个默认实现。Python 的特别之处在于可以创建自定义元类。大部分用户永远不需要这个工具，但当需要出现时，元类可提供强大而优雅的解决方案。它们已被用于记录属性访问日志、添加线程安全性、跟踪对象创建、实现单例，以及其他许多任务。

更多详情参见 元类。

method -- 方法

在类内部定义的函数。如果作为该类的实例的一个属性来调用，方法将会获取实例对象作为其第一个 argument (通常命名为 self)。参见 function 和 nested scope。

method resolution order -- 方法解析顺序

方法解析顺序就是在查找成员时搜索全部基类所用的先后顺序。请查看 Python 2.3 方法解析顺序 [https://www.python.org/download/releases/2.3/mro/] 了解自 2.3 版起 Python 解析器所用相关算法的详情。

module

此对象是 Python 代码的一种组织单位。各模块具有独立的命名空间，可包含任意 Python 对象。模块可通过 importing 操作被加载到 Python 中。

另见 package。

module spec -- 模块规格

一个命名空间，其中包含用于加载模块的相关导入信息。是 importlib.machinery.ModuleSpec 的实例。

MRO

参见 method resolution order。

mutable -- 可变对象

可变对象可以在其 id() 保持固定的情况下改变其取值。另请参见 immutable。

named tuple -- 具名元组

术语“具名元组”可用于任何继承自元组，并且其中的可索引元素还能使用名称属性来访问的类型或类。 这样的类型或类还可能拥有其他特性。

有些内置类型属于具名元组，包括 time.localtime() 和 os.stat() 的返回值。 另一个例子是 sys.float_info:

>>> sys.float_info[1]                   # indexed access
1024
>>> sys.float_info.max_exp              # named field access
1024
>>> isinstance(sys.float_info, tuple)   # kind of tuple
True

有些具名元组是内置类型（例如上面的例子）。 此外，具名元组还可通过常规类定义从 tuple 继承并定义名称字段的方式来创建。 这样的类可以手工编写，或者使用工厂函数 collections.namedtuple() 创建。 后一种方式还会添加一些手工编写或内置具名元组所没有的额外方法。

namespace -- 命名空间

命名空间是存放变量的场所。命名空间有局部、全局和内置的，还有对象中的嵌套命名空间（在方法之内）。命名空间通过防止命名冲突来支持模块化。例如，函数 builtins.open 与 os.open() 可通过各自的命名空间来区分。命名空间还通过明确哪个模块实现那个函数来帮助提高可读性和可维护性。例如，random.seed() 或 itertools.islice() 这种写法明确了这些函数是由 random 与 itertools 模块分别实现的。

namespace package -- 命名空间包

PEP 420 [https://www.python.org/dev/peps/pep-0420] 所引入的一种仅被用作子包的容器的 package，命名空间包可以没有实体表示物，其描述方式与 regular package 不同，因为它们没有 __init__.py 文件。

另可参见 module。

nested scope -- 嵌套作用域

在一个定义范围内引用变量的能力。例如，在另一函数之内定义的函数可以引用前者的变量。请注意嵌套作用域默认只对引用有效而对赋值无效。局部变量的读写都受限于最内层作用域。类似的，全局变量的读写则作用于全局命名空间。通过 nonlocal 关键字可允许写入外层作用域。

new-style class -- 新式类

对于目前已被应于所有类对象的类形式的旧称谓。在早先的 Python 版本中，只有新式类能够使用 Python 新增的更灵活特性，例如 __slots__、描述符、特征属性、__getattribute__()、类方法和静态方法等。

object -- 对象

任何具有状态（属性或值）以及预定义行为（方法）的数据。object 也是任何 new-style class 的最顶层基类名。

包

一种可包含子模块或递归地包含子包的 Python module。 从技术上说，包是具有 __path__ 属性的 Python 模块。

另参见 regular package 和 namespace package。

parameter -- 形参

function （或方法）定义中的命名实体，它指定函数可以接受的一个 argument （或在某些情况下，多个实参）。有五种形参：

positional-or-keyword：位置或关键字，指定一个可以作为 位置参数 传入也可以作为 关键字参数 传入的实参。这是默认的形参类型，例如下面的 foo 和 bar:

def func(foo, bar=None): ...

positional-only：仅限位置，指定一个只能通过位置传入的参数。 仅限位置形参可通过在函数定义的形参列表中它们之后包含一个 / 字符来定义，例如下面的 posonly1 和 posonly2:

def func(posonly1, posonly2, /, positional_or_keyword): ...

keyword-only：仅限关键字，指定一个只能通过关键字传入的参数。仅限关键字形参可通过在函数定义的形参列表中包含单个可变位置形参或者在多个可变位置形参之前放一个 * 来定义，例如下面的 kw_only1 和 kw_only2:

def func(arg, *, kw_only1, kw_only2): ...

var-positional：可变位置，指定可以提供由一个任意数量的位置参数构成的序列（附加在其他形参已接受的位置参数之后）。这种形参可通过在形参名称前加缀 * 来定义，例如下面的 args:

def func(*args, **kwargs): ...

var-keyword：可变关键字，指定可以提供任意数量的关键字参数（附加在其他形参已接受的关键字参数之后）。这种形参可通过在形参名称前加缀 ** 来定义，例如上面的 kwargs。

形参可以同时指定可选和必选参数，也可以为某些可选参数指定默认值。

另参见 argument 术语表条目、参数与形参的区别 中的常见问题、inspect.Parameter 类、函数定义 一节以及 PEP 362 [https://www.python.org/dev/peps/pep-0362]。

path entry -- 路径入口

import path 中的一个单独位置，会被 path based finder 用来查找要导入的模块。

path entry finder -- 路径入口查找器

任一可调用对象使用 sys.path_hooks (即 path entry hook) 返回的 finder，此种对象能通过 path entry 来定位模块。

请参看 importlib.abc.PathEntryFinder 以了解路径入口查找器所实现的各个方法。

path entry hook -- 路径入口钩子

一种可调用对象，在知道如何查找特定 path entry 中的模块的情况下能够使用 sys.path_hook 列表返回一个 path entry finder。

path based finder -- 基于路径的查找器

默认的一种 元路径查找器，可在一个 import path 中查找模块。

path-like object -- 路径类对象

代表一个文件系统路径的对象。路径类对象可以是一个表示路径的 str 或者 bytes 对象，还可以是一个实现了 os.PathLike 协议的对象。一个支持 os.PathLike 协议的对象可通过调用 os.fspath() 函数转换为 str 或者 bytes 类型的文件系统路径；os.fsdecode() 和 os.fsencode() 可被分别用来确保获得 str 或 bytes 类型的结果。此对象是由 PEP 519 [https://www.python.org/dev/peps/pep-0519] 引入的。

PEP

“Python 增强提议”的英文缩写。一个 PEP 就是一份设计文档，用来向 Python 社区提供信息，或描述一个 Python 的新增特性及其进度或环境。PEP 应当提供精确的技术规格和所提议特性的原理说明。

PEP 应被作为提出主要新特性建议、收集社区对特定问题反馈以及为必须加入 Python 的设计决策编写文档的首选机制。PEP 的作者有责任在社区内部建立共识，并应将不同意见也记入文档。

参见 PEP 1 [https://www.python.org/dev/peps/pep-0001]。

portion -- 部分

构成一个命名空间包的单个目录内文件集合（也可能存放于一个 zip 文件内），具体定义见 PEP 420 [https://www.python.org/dev/peps/pep-0420]。

positional argument -- 位置参数

参见 argument。

provisional API -- 暂定 API

暂定 API 是指被有意排除在标准库的向后兼容性保证之外的应用编程接口。虽然此类接口通常不会再有重大改变，但只要其被标记为暂定，就可能在核心开发者确定有必要的情况下进行向后不兼容的更改（甚至包括移除该接口）。此种更改并不会随意进行 -- 仅在 API 被加入之前未考虑到的严重基础性缺陷被发现时才可能会这样做。

即便是对暂定 API 来说，向后不兼容的更改也会被视为“最后的解决方案” —— 任何问题被确认时都会尽可能先尝试找到一种向后兼容的解决方案。

这种处理过程允许标准库持续不断地演进，不至于被有问题的长期性设计缺陷所困。详情见 PEP 411 [https://www.python.org/dev/peps/pep-0411]。

provisional package -- 暂定包

参见 provisional API。

Python 3000

Python 3.x 发布路线的昵称（这个名字在版本 3 的发布还遥遥无期的时候就已出现了）。有时也被缩写为“Py3k”。

Pythonic

指一个思路或一段代码紧密遵循了 Python 语言最常用的风格和理念，而不是使用其他语言中通用的概念来实现代码。例如，Python 的常用风格是使用 for 语句循环来遍历一个可迭代对象中的所有元素。许多其他语言没有这样的结构，因此不熟悉 Python 的人有时会选择使用一个数字计数器:

for i in range(len(food)):
    print(food[i])

而相应的更简洁更 Pythonic 的方法是这样的:

for piece in food:
    print(piece)

qualified name -- 限定名称

一个以点号分隔的名称，显示从模块的全局作用域到该模块中定义的某个类、函数或方法的“路径”，相关定义见 PEP 3155 [https://www.python.org/dev/peps/pep-3155]。对于最高层级的函数和类，限定名称与对象名称一致:

>>> class C:
...     class D:
...         def meth(self):
...             pass
...
>>> C.__qualname__
'C'
>>> C.D.__qualname__
'C.D'
>>> C.D.meth.__qualname__
'C.D.meth'

当被用于引用模块时，完整限定名称 意为标示该模块的以点号分隔的整个路径，其中包含其所有的父包，例如 email.mime.text:

>>> import email.mime.text
>>> email.mime.text.__name__
'email.mime.text'

reference count -- 引用计数

对特定对象的引用的数量。当一个对象的引用计数降为零时，所分配资源将被释放。引用计数对 Python 代码来说通常是不可见的，但它是 CPython 实现的一个关键元素。sys 模块定义了一个 getrefcount() 函数，程序员可调用它来返回特定对象的引用计数。

regular package -- 常规包

传统型的 package，例如包含有一个 __init__.py 文件的目录。

另参见 namespace package。

__slots__

一种写在类内部的声明，通过预先声明实例属性等对象并移除实例字典来节省内存。虽然这种技巧很流行，但想要用好却并不容易，最好是只保留在少数情况下采用，例如极耗内存的应用程序，并且其中包含大量实例。

sequence

一种 iterable，它支持通过 __getitem__() 特殊方法来使用整数索引进行高效的元素访问，并定义了一个返回序列长度的 __len__() 方法。内置的序列类型有 list、str、tuple 和 bytes。注意虽然 dict 也支持 __getitem__() 和 __len__()，但它被认为属于映射而非序列，因为它查找时使用任意的 immutable 键而非整数。

collections.abc.Sequence 抽象基类定义了一个更丰富的接口，它在 __getitem__() 和 __len__() 之外又添加了 count(), index(), __contains__() 和 __reversed__()。 实现此扩展接口的类型可以使用 register() 来显式地注册。

set comprehension -- 集合推导式

处理一个可迭代对象中的所有或部分元素并返回结果集合的一种紧凑写法。 results = {c for c in 'abracadabra' if c not in 'abc'} 将生成字符串集合 {'r', 'd'}。 参见 列表、集合与字典的显示。

single dispatch -- 单分派

一种 generic function 分派形式，其实现是基于单个参数的类型来选择的。

slice -- 切片

通常只包含了特定 sequence 的一部分的对象。切片是通过使用下标标记来创建的，在 [] 中给出几个以冒号分隔的数字，例如 variable_name[1:3:5]。方括号（下标）标记在内部使用 slice 对象。

special method -- 特殊方法

一种由 Python 隐式调用的方法，用来对某个类型执行特定操作例如相加等等。这种方法的名称的首尾都为双下划线。特殊方法的文档参见 特殊方法名称。

statement -- 语句

语句是程序段（一个代码“块”）的组成单位。一条语句可以是一个 expression 或某个带有关键字的结构，例如 if、while 或 for。

strong reference -- 强引用

在 Python 的 C API 中，强引用是指为持有引用的代码所拥有的对象的引用。 在创建引用时可通过调用 Py_INCREF() 来获取强引用而在删除引用时可通过 Py_DECREF() 来释放它。

Py_NewRef() 函数可被用于创建一个对象的强引用。 通常，必须在退出某个强引用的作用域时在该强引用上调用 Py_DECREF() 函数，以避免引用的泄漏。

另请参阅 borrowed reference。

text encoding -- 文本编码格式

在Python中，一个字符串是一串 Unicode 代码点（范围为 U+0000--U+10FFFF）。 为了存储或传输一个字符串，它需要被序列化为一串字节。

将一个字符串序列化为一个字节序列被称为“编码”，而从字节序列中重新创建字符串被称为“解码”。

有各种不同的文本序列化 编码器 ，它们被统称为 "文本编码格式"。

text file -- 文本文件

一种能够读写 str 对象的 file object。通常一个文本文件实际是访问一个面向字节的数据流并自动处理 text encoding。文本文件的例子包括以文本模式（'r' 或 'w'）打开的文件、sys.stdin、sys.stdout 以及 io.StringIO 的实例。

另请参看 binary file 了解能够读写 字节型对象 的文件对象。

triple-quoted string -- 三引号字符串

首尾各带三个连续双引号（"）或者单引号（'）的字符串。它们在功能上与首尾各用一个引号标注的字符串没有什么不同，但是有多种用处。它们允许你在字符串内包含未经转义的单引号和双引号，并且可以跨越多行而无需使用连接符，在编写文档字符串时特别好用。

type

类型决定一个 Python 对象属于什么种类；每个对象都具有一种类型。要知道对象的类型，可以访问它的 __class__ 属性，或是通过 type(obj) 来获取。

type alias -- 类型别名

一个类型的同义词，创建方式是把类型赋值给特定的标识符。

类型别名的作用是简化 类型注解。例如:

def remove_gray_shades(
        colors: list[tuple[int, int, int]]) -> list[tuple[int, int, int]]:
    pass

可以这样提高可读性:

Color = tuple[int, int, int]

def remove_gray_shades(colors: list[Color]) -> list[Color]:
    pass

参见 typing 和 PEP 484 [https://www.python.org/dev/peps/pep-0484]，其中有对此功能的详细描述。

type hint -- 类型注解

annotation 为变量、类属性、函数的形参或返回值指定预期的类型。

类型注解属于可选项，Python 不要求提供，但其可对静态类型分析工具起作用，并可协助 IDE 实现代码补全与重构。

全局变量、类属性和函数的类型注解可以使用 typing.get_type_hints() 来访问，但局部变量则不可以。

参见 typing 和 PEP 484 [https://www.python.org/dev/peps/pep-0484]，其中有对此功能的详细描述。

universal newlines -- 通用换行

一种解读文本流的方式，将以下所有符号都识别为行结束标志：Unix 的行结束约定 '\n'、Windows 的约定 '\r\n' 以及旧版 Macintosh 的约定 '\r'。参见 PEP 278 [https://www.python.org/dev/peps/pep-0278] 和 PEP 3116 [https://www.python.org/dev/peps/pep-3116] 和 bytes.splitlines() 了解更多用法说明。

variable annotation -- 变量标注

对变量或类属性的 annotation。

在标注变量或类属性时，还可选择为其赋值:

class C:
    field: 'annotation'

变量标注通常被用作 类型提示：例如以下变量预期接受 int 类型的值:

count: int = 0

变量标注语法的详细解释见 带标注的赋值语句 一节。

参见 function annotation, PEP 484 [https://www.python.org/dev/peps/pep-0484] 和 PEP 526 [https://www.python.org/dev/peps/pep-0526]，其中描述了此功能。 另请参阅 注解最佳实践 以了解使用标注的最佳实践。

virtual environment -- 虚拟环境

一种采用协作式隔离的运行时环境，允许 Python 用户和应用程序在安装和升级 Python 分发包时不会干扰到同一系统上运行的其他 Python 应用程序的行为。

另参见 venv。

virtual machine -- 虚拟机

一台完全通过软件定义的计算机。Python 虚拟机可执行字节码编译器所生成的 bytecode。

Zen of Python -- Python 之禅

列出 Python 设计的原则与哲学，有助于理解与使用这种语言。查看其具体内容可在交互模式提示符中输入 "import this"。

文档说明

这些文档是用 Sphinx [https://www.sphinx-doc.org/] 从 reStructuredText [https://docutils.sourceforge.io/rst.html] 源生成的，Sphinx 是一个专为处理 Python 文档而编写的文档生成器。

本文档及其工具链之开发，皆在于志愿者之努力，亦恰如 Python 本身。如果您想为此作出贡献，请阅读 处理错误 了解如何参与。我们随时欢迎新的志愿者！

特别鸣谢：

Fred L. Drake, Jr.，原始 Python 文档工具集之创造者，众多文档之作者；

用于创建 reStructuredText 和 Docutils 套件的 Docutils [https://docutils.sourceforge.io/] 项目；

Fredrik Lundh 的 Alternative Python Reference 项目，为 Sphinx 提供许多好的点子。

Python 文档的贡献者

有很多对 Python 语言，Python 标准库和 Python 文档有贡献的人，随 Python 源代码分发的 Misc/ACKS [https://github.com/python/cpython/tree/3.10/Misc/ACKS] 文件列出了部分贡献者。

有了 Python 社区的输入和贡献，Python 才有了如此出色的文档——谢谢你们！

处理错误

Python 是一门成熟的编程语言，以稳定著称。为维持其美誉，开发者希望获悉所有您在 Python 中发现的缺陷。

有时候自己修复漏洞并将补丁提交给 Python 能更快地解决问题，因为它简化了处理过程并且减少了参与的人力。 请参阅如何 提交补丁。

文档错误

如果你在这篇文档中找到了一个错误或是想指出一个可改进的地方，请在 tracker 上提交一个错误报告。 如果你有关于改进该问题的建议，请与报告一并提交。

你还可以在我们的 文档编撰论坛 [https://discuss.python.org/c/documentation/26] 上开启一个讨论条目。

如果您时间有限，还可以通过电子邮件将文档的错误报告发送至 docs@python.org（代码运行错误请发送至 python-list@python.org）。“docs@”是一个由志愿者运作的邮件列表；您的请求会得到关注，但可能需要一些时间才会被处理。

参见

文档错误

已提交给 Python 问题追踪系统的文档错误列表。

问题跟踪 [https://devguide.python.org/tracker/]

在追踪系统上参与问题改进的过程概述。

改进文档 [https://devguide.python.org/docquality/#helping-with-documentation]

给有兴趣为 Python 文档做出贡献的人。

文档翻译 [https://devguide.python.org/documenting/#translating]

文档翻译的 GitHub 页面及其主要联系人的列表

使用 Python 的问题追踪系统

针对 Python 本身的问题报告应当通过 GitHub 问题追踪系统 (https://github.com/python/cpython/issues) 来提交。 GitHub 问题追踪系统提供了一个网页表单用来输入并提交相关信息给开发者。

第一步是确定问题是否已经被报告了。 这样做的好处除了可以节省开发者的时间，还可以让你了解该问题是如何解决的；有可能该问题已在下一发布版中被修复，或者还需要额外的信息（在此情况下非常欢迎你来提供信息！）。 要确定这一点，请使用页面顶部的搜索框来搜索问题追踪系统。

如果你要报告的问题未出现在列表中，请登录 GitHub 报告。 如果你还没有 GitHub 账号，请使用 "Sign up" 链接新建一个账号。 错误报告是不可能自动被提交的。

当你登录之后，就可以提交问题了。 请点击顶端栏的 "New issue" 按钮来报告新问题。

提交表单有两个字段，"Title" 和 "Comment"。

对于 "Title" 字段，请输入对问题的 非常 简短的描述；最好是少于十个单词。

在“说明（Comment）”栏，请详细描述问题，包括您预期的情况和实际的情况。请确保包含任何涉及的拓展模块，以及您当时所使用的硬件和软件平台（如果可能，请附上版本信息）。

每个问题报告将由一位开发者进行审查并决定要以何种方式来修正该问题。 每当对该问题有新的处理措施时你都会收到更新的消息。

参见

如何有效地报告错误 [https://www.chiark.greenend.org.uk/~sgtatham/bugs.html]

该文章详细介绍了如何创建一份有用的错误报告。它描述了什么样的信息是有用的，以及为什么是有用的。

Bug Writing Guidelines [https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html]

关于写一份好的错误报告。部分仅针对 Mozilla 项目，不过其描述了通用的恰当做法。

开始为 Python 贡献您的知识

除了仅仅报告您所发现的错误之外，同样欢迎您提交修复它们的补丁。您可以在 Python 开发者指引 [https://mail.python.org/mailman3/lists/core-mentorship.python.org/] 中找到更多为 Python 打补丁的信息。如果您有任何问题，核心导师邮件列表 [https://devguide.python.org/] 是一个友好的去处，在那里， 你可以寻求修复 Python 相关问题的答案。

版权所有

Python 与这份文档：

版权所有 © 2001-2023 Python 软件基金会。 保留所有权利。

版权所有 © 2000 BeOpen.com。保留所有权利。

版权所有 © 1995-2000 Corporation for National Research Initiatives。保留所有权利。

版权所有 © 1991-1995 Stichting Mathematisch Centrum。保留所有权利。

有关完整的许可证和许可信息，请参见 历史和许可证。

历史和许可证

该软件的历史

Python 由荷兰数学和计算机科学研究学会（CWI，见 https://www.cwi.nl/ ）的 Guido van Rossum 于 1990 年代初设计，作为一门叫做 ABC 的语言的替代品。尽管 Python 包含了许多来自其他人的贡献，Guido 仍是其主要作者。

1995 年，Guido 在弗吉尼亚州的国家创新研究公司（CNRI，见 https://www.cnri.reston.va.us/ ）继续他在 Python 上的工作，并在那里发布了该软件的多个版本。

2000 年五月，Guido 和 Python 核心开发团队转到 BeOpen.com 并组建了 BeOpen PythonLabs 团队。 同年十月，PythonLabs 团队转到 Digital Creations (现为 Zope 公司；见 https://www.zope.org/)。 2001 年，Python 软件基金会 (PSF，见 https://www.python.org/psf/) 成立，这是一个专为拥有 Python 相关知识产权而创建的非营利组织。 Zope 公司现在是 Python 软件基金会的赞助成员。

所有的 Python 版本都是开源的（有关开源的定义参阅 https://opensource.org/ ）。历史上，绝大多数 Python 版本是 GPL 兼容的；下表总结了各个版本情况。

发布版本 | 源自 | 年份 | 所有者 | GPL 兼容？
0.9.0 至 1.2 | n/a | 1991-1995 | CWI | 是
1.3 至 1.5.2 | 1.2 | 1995-1999 | CNRI | 是
1.6 | 1.5.2 | 2000 | CNRI | 否
2.0 | 1.6 | 2000 | BeOpen.com | 否
1.6.1 | 1.6 | 2001 | CNRI | 否
2.1 | 2.0+1.6.1 | 2001 | PSF | 否
2.0.1 | 2.0+1.6.1 | 2001 | PSF | 是
2.1.1 | 2.1+2.0.1 | 2001 | PSF | 是
2.1.2 | 2.1.1 | 2002 | PSF | 是
2.1.3 | 2.1.2 | 2002 | PSF | 是
2.2 及更高 | 2.1.1 | 2001 至今 | PSF | 是

注解

GPL 兼容并不意味着 Python 在 GPL 下发布。与 GPL 不同，所有 Python 许可证都允许您分发修改后的版本，而无需开源所做的更改。GPL 兼容的许可证使得 Python 可以与其它在 GPL 下发布的软件结合使用；但其它的许可证则不行。

感谢众多在 Guido 指导下工作的外部志愿者，使得这些发布成为可能。

获取或以其他方式使用 Python 的条款和条件

Python 软件和文档的使用许可均基于 PSF 许可协议。

从 Python 3.8.6 开始，文档中的示例、操作指导和其他代码采用的是 PSF 许可协议和 零条款 BSD 许可 的双重使用许可。

某些包含在 Python 中的软件基于不同的许可。这些许可会与相应许可之下的代码一同列出。有关这些许可的不完整列表请参阅 收录软件的许可与鸣谢。

用于 PYTHON 3.10.20 的 PSF 许可协议

1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and
   the Individual or Organization ("Licensee") accessing and otherwise using Python
   3.10.20 software 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 3.10.20 alone or in any derivative
   version, provided, however, that PSF's License Agreement and PSF's notice of
   copyright, i.e., "Copyright © 2001-2023 Python Software Foundation; All Rights
   Reserved" are retained in Python 3.10.20 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 3.10.20 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
   3.10.20.

4. PSF is making Python 3.10.20 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 3.10.20 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 3.10.20
   FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 3.10.20, 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 3.10.20, Licensee agrees
   to be bound by the terms and conditions of this License Agreement.

用于 PYTHON 2.0 的 BEOPEN.COM 许可协议

BEOPEN PYTHON 开源许可协议第 1 版

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
   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.

用于 PYTHON 1.6.1 的 CNRI 许可协议

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: 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.

用于 PYTHON 0.9.0 至 1.2 的 CWI 许可协议

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.

ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON 3.10.20 DOCUMENTATION

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.

收录软件的许可与鸣谢

本节是Python发行版中收录的第三方软件的许可和致谢清单，该清单是不完整且不断增长的。

Mersenne Twister

_random 模块包含基于 http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html 下载的代码。以下是原始代码的完整注释（声明）：

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)

套接字

socket 模块使用了 getaddrinfo() 和 getnameinfo() 等函数，它们的代码位于 WIDE 项目的不同源文件中 https://www.wide.ad.jp/ 。

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.

异步套接字服务

asynchat 和 asyncore 模块包含以下声明:

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.

Cookie 管理

http.cookies 模块包含以下声明:

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.

执行追踪

trace 模块包含以下声明:

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.

UUencode 与 UUdecode 函数

uu 模块包含以下声明:

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

XML 远程过程调用

xmlrpc.client 模块包含以下声明:

    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.

test_epoll

test_epoll 模块包含以下声明:

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.

Select kqueue

select 模块关于 kqueue 的接口包含以下声明:

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.

SipHash24

Python/pyhash.c 文件包含 Marek Majkowski' 对 Dan Bernstein 的SipHash24 算法的实现。它包含以下声明:

<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)

strtod 和 dtoa

Python/dtoa.c 文件提供了 C 函数 dtoa 和 strtod，用于 C 双精度数值和字符串之间的转换，它派生自由 David M. Gay 编写的同名文件。 目前该文件可在 https://web.archive.org/web/20220517033456/http://www.netlib.org/fp/dtoa.c 访问。 在 2009 年 3 月 16 日 检索到的原始文件包含以下版权和许可声明:

/****************************************************************
 *
 * 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.
 *
 ***************************************************************/

OpenSSL

如果操作系统可用，则 hashlib、posix、ssl、crypt 模块使用 OpenSSL 库来提高性能。此外，适用于 Python 的 Windows 和 macoS 安装程序可能包括 OpenSSL 库的拷贝，所以在此处也列出了 OpenSSL 许可证的拷贝:

 LICENSE ISSUES
 ==============

 The OpenSSL toolkit stays under a dual license, i.e. both the conditions of
 the OpenSSL License and the original SSLeay license apply to the toolkit.
 See below for the actual license texts. Actually both licenses are BSD-style
 Open Source licenses. In case of any license issues related to OpenSSL
 please contact openssl-core@openssl.org.

 OpenSSL License
 ---------------

   /* ====================================================================
    * Copyright (c) 1998-2008 The OpenSSL 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. All advertising materials mentioning features or use of this
    *    software must display the following acknowledgment:
    *    "This product includes software developed by the OpenSSL Project
    *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
    *
    * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
    *    endorse or promote products derived from this software without
    *    prior written permission. For written permission, please contact
    *    openssl-core@openssl.org.
    *
    * 5. Products derived from this software may not be called "OpenSSL"
    *    nor may "OpenSSL" appear in their names without prior written
    *    permission of the OpenSSL Project.
    *
    * 6. Redistributions of any form whatsoever must retain the following
    *    acknowledgment:
    *    "This product includes software developed by the OpenSSL Project
    *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
    *
    * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
    * EXPRESSED 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 OpenSSL PROJECT OR
    * ITS 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.
    * ====================================================================
    *
    * This product includes cryptographic software written by Eric Young
    * (eay@cryptsoft.com).  This product includes software written by Tim
    * Hudson (tjh@cryptsoft.com).
    *
    */

Original SSLeay License
-----------------------

   /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
    * All rights reserved.
    *
    * This package is an SSL implementation written
    * by Eric Young (eay@cryptsoft.com).
    * The implementation was written so as to conform with Netscapes SSL.
    *
    * This library is free for commercial and non-commercial use as long as
    * the following conditions are aheared to.  The following conditions
    * apply to all code found in this distribution, be it the RC4, RSA,
    * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
    * included with this distribution is covered by the same copyright terms
    * except that the holder is Tim Hudson (tjh@cryptsoft.com).
    *
    * Copyright remains Eric Young's, and as such any Copyright notices in
    * the code are not to be removed.
    * If this package is used in a product, Eric Young should be given attribution
    * as the author of the parts of the library used.
    * This can be in the form of a textual message at program startup or
    * in documentation (online or textual) provided with the package.
    *
    * 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 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. All advertising materials mentioning features or use of this software
    *    must display the following acknowledgement:
    *    "This product includes cryptographic software written by
    *     Eric Young (eay@cryptsoft.com)"
    *    The word 'cryptographic' can be left out if the rouines from the library
    *    being used are not cryptographic related :-).
    * 4. If you include any Windows specific code (or a derivative thereof) from
    *    the apps directory (application code) you must include an acknowledgement:
    *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
    *
    * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``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.
    *
    * The licence and distribution terms for any publically available version or
    * derivative of this code cannot be changed.  i.e. this code cannot simply be
    * copied and put under another distribution licence
    * [including the GNU Public Licence.]
    */

expat

除非使用 --with-system-expat 配置了构建，否则 pyexpat 扩展都是用包含 expat源的拷贝构建的:

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.

libffi

除非使用 --with-system-libffi 配置了构建，否则 _ctypes 扩展都是包含 libffi源的拷贝构建的:

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.

zlib

如果系统上找到的zlib版本太旧而无法用于构建，则使用包含 zlib源代码的拷贝来构建 zlib 扩展:

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

cfuhash

tracemalloc 使用的哈希表的实现基于 cfuhash项目:

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.

libmpdec

除非使用 --with-system-libmpdec 配置了构建，否则 _decimal 模块都是用包含 libmpdec 库的拷贝构建的。

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.

W3C C14N 测试套件

test 包中的 C14N 2.0 测试集 (Lib/test/xmltestdata/c14n-20/) 提取自 W3C 网站 https://www.w3.org/TR/xml-c14n2-testcases/ 并根据 3 条款版 BSD 许可证发行:

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.

audioop

audioop 模块使用了 SoX 项目的 g771.c 文件中的基础代码。 https://sourceforge.net/projects/sox/files/sox/12.17.7/sox-12.17.7.tar.gz

此源代码是 Sun Microsystems, Inc. 的产品并可供无限制地使用。 用户可以拷贝或修改此源代码而无须付费。

SUN SOURCE CODE IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.

提供的 Sun 源代码不附带技术支持并且 Sun Microsystems, Inc. 也没有义务协助其使用、排错、修改或增强。

SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY THIS SOFTWARE OR ANY PART THEREOF.

在任何情况下 Sun Microsystems, Inc. 均不对任何收入或利润损失或其他特殊的、间接的和后续的损害负责，即使 Sun 已被告知可能发生此类损害。

Sun Microsystems, Inc. 2550 Garcia Avenue Mountain View, California 94043

分发 Python 模块（遗留版本）

作者

Greg Ward ， Anthony Baxter

电子邮箱

distutils-sig@python.org

参见

分发 Python 模块

最新的模块分发文档

注解

整个 distutils 包已被弃用并将在 Python 3.12 中被移除。 此文档仅保留作参考，并将随包一起被移除。 更多信息请参阅 有什么新变化 条目。

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

注解

本指南仅介绍构建和分发扩展的基本工具，这些扩展是作为此Python版本的一部分提供的。 第三方工具提供更易于使用和更安全的替代方案。有关详细信息，请参阅 Python 打包用户指南中的 快速推荐部分 [https://packaging.python.org/guides/tool-recommendations/] 。

本文档从模块开发人员的角度描述了 Python Distribution Utilities ("Distutils")。 描述了 setuptools 构建所依赖的下层功能，以允许 Python 开发者方便地为更广泛的受众编写 Python 模块和扩展。

1. Distutils 模块介绍

1.1. 概念和术语

1.2. 一个简单的例子

1.3. 通用的 Python 术语

1.4. Distutils 特定的术语

2. 编写安装脚本

2.1. 列出全部的包

2.2. 列出单独的模块

2.3. 描述扩展模块

2.4. 分发和软件包之间的关系

2.5. 安装脚本

2.6. 安装软件包数据

2.7. 安装其它文件

2.8. 附加元数据

2.9. 调试安装脚本

3. 编写设置脚本的配置文件

4. 创建源代码分发包

4.1. 指定要分发的文件

4.2. 声明相关选项

5. 创建构建分发版

5.1. 创建RPM软件包

5.2. 在 Windows 上的交叉编译

6. Distutils 示例

6.1. 纯 Python 分发（通过 module）

6.2. 纯 Python 分发（通过 包）

6.3. 单个扩展模块

6.4. 检查一个包

6.5. 读取元数据

7. 扩展 Distutils

7.1. 集成新的命令

7.2. 添加新的发布类型

8. 命令参考

8.1. 安装模块: install 命令族

8.2. 创建源码发行包: sdist 命令

9. API参考引用

9.1. distutils.core --- 分发包功能的核心

9.2. distutils.ccompiler --- CCompiler基类

9.3. distutils.unixccompiler --- Unix C Compiler

9.4. distutils.msvccompiler --- Microsoft Compiler

9.5. distutils.bcppcompiler --- Borland Compiler

9.6. distutils.cygwincompiler --- Cygwin Compiler

9.7. distutils.archive_util --- Archiving utilities

9.8. distutils.dep_util --- Dependency checking

9.9. distutils.dir_util --- Directory tree operations

9.10. distutils.file_util --- Single file operations

9.11. distutils.util --- Miscellaneous other utility functions

9.12. distutils.dist --- The Distribution class

9.13. distutils.extension --- The Extension class

9.14. distutils.debug --- Distutils debug mode

9.15. distutils.errors --- Distutils exceptions

9.16. distutils.fancy_getopt --- Wrapper around the standard getopt module

9.17. distutils.filelist --- The FileList class

9.18. distutils.log --- Simple PEP 282-style logging

9.19. distutils.spawn --- Spawn a sub-process

9.20. distutils.sysconfig --- System configuration information

9.21. distutils.text_file --- The TextFile class

9.22. distutils.version --- Version number classes

9.23. distutils.cmd --- Abstract base class for Distutils commands

9.24. Creating a new Distutils command

9.25. distutils.command --- Individual Distutils commands

9.26. distutils.command.bdist --- Build a binary installer

9.27. distutils.command.bdist_packager --- Abstract base class for packagers

9.28. distutils.command.bdist_dumb --- Build a "dumb" installer

9.29. distutils.command.bdist_msi --- Build a Microsoft Installer binary package

9.30. distutils.command.bdist_rpm --- Build a binary distribution as a Redhat RPM and SRPM

9.31. distutils.command.sdist --- Build a source distribution

9.32. distutils.command.build --- Build all files of a package

9.33. distutils.command.build_clib --- Build any C libraries in a package

9.34. distutils.command.build_ext --- Build any extensions in a package

9.35. distutils.command.build_py --- Build the .py/.pyc files of a package

9.36. distutils.command.build_scripts --- Build the scripts of a package

9.37. distutils.command.clean --- Clean a package build area

9.38. distutils.command.config --- Perform package configuration

9.39. distutils.command.install --- Install a package

9.40. distutils.command.install_data --- Install data files from a package

9.41. distutils.command.install_headers --- Install C/C++ header files from a package

9.42. distutils.command.install_lib --- Install library files from a package

9.43. distutils.command.install_scripts --- Install script files from a package

9.44. distutils.command.register --- Register a module with the Python Package Index

9.45. distutils.command.check --- Check the meta-data of a package

1. Distutils 模块介绍

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

本文档介绍了使用 Distutils 模块分发你的 Python 模块，主要是针对开发者/分发者的使用的——如果你想了解如何安装 Python 模块，你应该参考这个章节： 安装Python模块（旧版）。

1.1. 概念和术语

Distutils 用起来非常简单，对于模块开发者或安装第三方模块的用户/管理员均是如此。开发者的责任（当然还有编写可靠、良好文档和经过良好测试的代码！）就是：

编写一个设置脚本 (setup.py by convention)

(可选)编写设置脚本的配置文件

创建源码的发行版

（可选）创建一个或多个编译好（二进制）的发行版

这些操作在此文档均有讲解。

并非所有的模块开发者都能接触到众多的平台，所以期望他们创造众多的内置发行版不是总是可行的。最好是有一类名为 打包者 的中介，以满足这一需求。打包者将读取模块开发者发布的源代码，在一个或多个平台上进行编译，并发布构建出来的发行版。这样，最流行平台的用户就能以最自然的方式安装最流行的 Python 模块发行版，不必运行一段 setup 脚本或编译代码了。

1.2. 一个简单的例子

setup 脚本通常很简单，尽管是用 Python 编写的，它能干的事情没有限制，当然应小心别在 setup 脚本中加入什么运行缓慢的操作。与 Autoconf 风格的 configure 脚本不同，在构建和安装模块的过程中 setup 脚本可能会运行多次。

如果只想发布一个名为 foo 的模块，位于 foo.py 文件中，那么 setup 脚本可以如此简单：

from distutils.core import setup
setup(name='foo',
      version='1.0',
      py_modules=['foo'],
      )

注意要点：

提供给 Distutils 的大部分信息将作为关键字参数发给 setup() 函数。

这些关键字参数分为两类：包的元数据（名称、版本号）和包中内容的描述信息（本例中是纯 Python 模块的列表）。

模块由模块名指定，而不是文件名（包和扩展也是如此）。

建议多提供一些元数据，特别是开发者姓名、电子邮件地址和项目的URL（参见 编写安装脚本 中的例子）。

要为该模块创建一个源码发布版本，需要创建一段 setup 脚本 setup.py，包含上述代码，然后从终端运行以下命令：

python setup.py sdist

对于 Windows 用户来说，打开命令行窗口（Start ‣ Accessories）并且写上如下命令:

setup.py sdist

sdist 将创建一个归档文件（例如在 Unix 中为 tarball，在 Windows 中为 ZIP 文件），其中包含你的配置脚本 setup.py 以及你的模块 foo.py。 此归档文件将被命名为 foo-1.0.tar.gz (或 .zip)，并将解包到目录 foo-1.0 当中。

如果最终用户希望安装 foo 模块，只需下载 foo-1.0.tar.gz （或 .zip ）并解压，进入 foo-1.0 目录运行：

python setup.py install

这会把 foo.py 复制到 Python 安装环境的第三方模块目录中。

上述简单例子展示了 Distutils 的一些基本概念。首先，开发者和安装者拥有相同的基本用户界面，即 setup 脚本。区别在于使用哪种 Distutils 命令 ： sdist 命令几乎只适用于模块开发者，而 install 则更适用于安装者（当然大多数开发者偶尔也想要安装自己的代码）。

其他有用的内置分发格式是 RPM，可由 bdist_rpm 、Solaris pkgtool`（:command:`bdist_pkgtool）和 HP-UX swinstall`（:command:`bdist_sdux）实现。比如，以下命令将创建一个名为 foo-1.0.noarch.rpm 的RPM文件：

python setup.py bdist_rpm

（bdist_rpm 命令用到了 rpm 可执行文件，因此必须运行在基于 RPM 的系统中，如 Red Hat Linux 、 SuSE Linux 或 Mandrake Linux）。

可以随时运行以下命令，以便了解当前可用的分发格式：

python setup.py bdist --help-formats

1.3. 通用的 Python 术语

本文读者可能对模块、扩展等已有了很好的理解。但为确保所有人都站在同一起点上，下面提供了 Python 常用术语表：

module

实现 Python 代码重用的基本单位：可被其他代码导入的一段代码。有三种类型的模块与本文有关：纯 Python 模块、扩展模块和包。

纯 Python 模块

用 Python 编写的模块，包含在某 .py 文件中（可能还会有相关的 .pyc 文件）。有时被称为 "纯模块"。

extension module -- 扩展模块

用低级语言编写的 Python 模块。Python 用 C/C++ ，而 Jython 则用Java。通常包含在一个可动态加载的预编译文件中，比如 Unix 中的 Python 扩展是一个共享对象（.so）文件，Windows 中的 Python 扩展则是一个 DLL （扩展名为 .pyd )，而 Jython 的扩展是个 Java class 文件。（注意，目前，Distutils 只处理 Python 的 C/C++ 扩展。）

包

包含其他模块的模块；通常位于文件系统的某个目录中，区别于其他目录的标记就是存在一个 __init__.py 文件。

根包

包的层次结构的根。（其并非一个真正的包，因为没有 __init__.py 文件。但总得给它起个名字）。 绝大多数标准库都在根包中，还有许多不属于任何大型模块的小型、独立的第三方模块。与普通的包不同，根包中的模块可能会在很多目录中出现：事实上，sys.path 列出的每个目录都会为根包提供模块。

1.4. Distutils 特定的术语

以下属于更加特别地用于 Distutils 发布 Python 模块。

模块发行版

一组 Python 模块，作为可下载的资源组团发布，以便 大规模 安装。模块发布版的著名例子是 NumPy 、 SciPy 、 Pillow 或 mxBase。（这些会被称为 package，这个词在 Python 的语境中也使用过：一个模块发行版可能包含零个、一个或多个 Python 包。)

纯模块发行版

只包含纯 Python 模块和软件包的模块发布版。有时被称为“纯发行版”。

非纯模块发行版

至少包含一个扩展模块的模块发行版。 有时被称为“非纯发行版”。

根发行版

源代码树（或源代码发行版）的顶级目录；即 setup.py 所在的目录。 一般来说，setup.py 会在该目录下运行。

2. 编写安装脚本

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

安装脚本是使用 Distutils 进行构建、分发和安装模块的的入口。设置脚本的主要目的是向 Distutils 描述如何分发您的模块，以便对您的模块进行操作的各种命令正确运行。正如我们在上面的 一个简单的例子 部分中看到的，安装脚本主要包含对 setup() 的调用，并且模块开发人员提供给 Distutils 的大部分信息都通过关键字参数提供给 setup()。

这是一个略微复杂一点的例子，我们将在接下来的几节中继续追踪它：Distutils 本身的安装脚本。 （请记住，虽然 Distutils 被包括在 Python 1.6 及之后的版本中，但它们也仍保存独立存在因此 Python 1.5.2 用户可以使用它们来安装其他模块分发版。 这里所演示的 Distutils 本身的安装脚本，是用来将该软件包安装到 Python 1.5.2 中。）

#!/usr/bin/env python

from distutils.core import setup

setup(name='Distutils',
      version='1.0',
      description='Python Distribution Utilities',
      author='Greg Ward',
      author_email='gward@python.net',
      url='https://www.python.org/sigs/distutils-sig/',
      packages=['distutils', 'distutils.command'],
     )

这里与 一个简单的例子 一节中介绍的最简版单文件分发包只有两处差异：更多的元数据，以及按包列出纯 Python 模块，而非按模块列出。 这一点很重要因为 Distutils 是由（目前）分成两个包的几十个模块组成的；显式地列出每个模块将十分繁琐并且难以维护。 有关额外元数据的更多信息，请参阅 附加元数据 一节。

请注意在 setup 脚本中提供的任何路径名称（文件或目录）都应当使用 Unix 约定来书写，即以斜杠分隔。 Distutils 会负责在实际使用该路径名称之前将这个与平台无关的表示形式转换为适用于你的当前平台的形式 。 这使得你的 setup 脚本可以在跨操作系统进行移植，这当然是 Distutils 的主要目标之一。 基于此精神，在本文档中的所有路径名称都是以斜杠分隔的。

当然，这仅适用于提供给 Distutils 函数的路径名称。 举例来说，如果你使用标准 Python 函数例如 glob.glob() 或 os.listdir() 来指定文件，则你应当小心地编写可移植的代码而不是硬编码路径分隔符:

glob.glob(os.path.join('mydir', 'subdir', '*.html'))
os.listdir(os.path.join('mydir', 'subdir'))

2.1. 列出全部的包

packages 选项通知 Distutils 处理（构建、分发、安装等）在 packages 列表中提及的每个包中找到的所有纯 Python 模块。 当然，为做到这一点，包名称和文件系统的目录之间必须保持对应关系。 默认的对应关系是很显然的，即 distutils 包即相对于分发包根目录的 distutils 目录。 因此，当你在你的 setup 脚本中写 packages = ['foo'] 时，你就承诺了 Distutils 将在相对于你的 setup 脚本所在目录下找到一个文件 foo/__init__.py (在你的目录上可能会有不同的拼写形式，但意思已经很明白了)。 如果你违反此承诺，Distutils 将发出警告但无论如何仍会处理损坏的包。

如果你使用不同的约定来布局你的源目录，那也没有问题：你只需提供 package_dir 选项来告知 Distutils 你的约定。 例如，假设你将所有For example, say you keep all Python 源代码保存在 lib 下，以便“根包”中的模块（即不属于任何包的模块）位于 lib 中，foo 包中的模块位于 lib/foo 中，依此类推。 那么你应当编写:

package_dir = {'': 'lib'}

在你的 setup 脚本中。 这个字典的键是包名，空的包名代表根包。 字典的值是相对于你的发布包根目录的目录名。 在本例中，当你声明 packages = ['foo'] 时，你将承诺存在 lib/foo/__init__.py 这个文件。

另一种可能的约定是将 foo 包直接放在 lib 中，将 foo.bar 包放在 lib/bar 中等等。 这可以在 setup 脚本中写为

package_dir = {'foo': 'lib'}

package_dir 字典中的 package: dir 条目隐式地应用于 package 以下的所有包，因而在这里 foo.bar 的情况会被自动地处理。 在这个示例中，使用 packages = ['foo', 'foo.bar'] 告知 Distutils 要查找 lib/__init__.py 和 lib/bar/__init__.py。 （请记住虽然 package_dir 会递归地应用，但你必须在 packages 中显式地列出所有的包：Distutils 不会 递归地扫描你的源代码树来查找任何带有 __init__.py 文件的目录。）

2.2. 列出单独的模块

对于一个小型的模块分发包，你可能会倾向于列出所有的模块而不是只列出包 --- 特别是在“根包”中只有一个模块（即根本不存在包）的情况下。 这种最简单的情况见 一个简单的例子 一节；下面是一个稍微复杂一点的例子:

py_modules = ['mod1', 'pkg.mod2']

这描述了两个模块，其中一个是在 "root" 包中，另一个是在 pkg 包中。 同样地，默认的包/目录布局表明这两个模块位于 mod1.py 和 pkg/mod2.py 中，并且也存在 pkg/__init__.py。 同样地，你可以使用 package_dir 选项来重载包/目录的对应关系。

2.3. 描述扩展模块

正如编写Python扩展模块比编写纯Python模块要复杂一些一样，在Distutils中描述它们也要复杂一些。与纯模块不同，仅仅列出模块或包并期望Distutils出去找到正确的文件是不够的；您必须指定扩展名、源文件和任何编译/链接要求（包括要链接的目录、库等）。

所有这些都是通过 setup() 的另一个关键字参数 ext_modules 选项实现的。 ext_modules 是 由 Extension 实例组成的列表，每个实例描述一个扩展模块。 假设你的发行版包括一个扩展模块，名为 foo 并由 foo.c 实现。 如果不需要编译器/链接器的额外指令，描述这个扩展很简单:

Extension('foo', ['foo.c'])

Extension 类可以与 setup() 一起从 distutils.core 导入。 因此，只包含这一个扩展而不包含其他扩展的模块分发版的安装脚本可能是:

from distutils.core import setup, Extension
setup(name='foo',
      version='1.0',
      ext_modules=[Extension('foo', ['foo.c'])],
      )

Extension 类（实际上，由 build_ext 命令实现的底层扩展构建机制）在描述 Python 扩展时支持很大的灵活性，这将在以下部分中进行解释。

2.3.1. 扩展名和软件包

Extension 构造器的第一个参数始终是扩展的名称，包括任何包名称。 例如，:

Extension('foo', ['src/foo1.c', 'src/foo2.c'])

描述了根包中的一个扩展，而：:

Extension('pkg.foo', ['src/foo1.c', 'src/foo2.c'])

描述了 pkg 包中的相同扩展。 在这两种情况下，源文件和生成的目标代码是相同的；唯一的区别是所产生的扩展处在文件系统中的何处（相应地在 Python 的命名空间层级结构中处在何处）。

如果在同一个包中（或在同一基本包下）有多个扩展，请使用 setup() 的关键字参数 ext_package。 例如，:

setup(...,
      ext_package='pkg',
      ext_modules=[Extension('foo', ['foo.c']),
                   Extension('subpkg.bar', ['bar.c'])],
     )

将把 foo.c 编译为扩展 pkg.foo，把 bar.c 编译为 pkg.subpkg.bar。

2.3.2. 扩展的源文件

Extension 构造器的第二个参数是源文件列表。 由于 Distutils 目前只支持 C、C++ 和 Objective-C 扩展，因此这些扩展通常是 C/C++/Objective-C 源文件。 （请确保使用适当的扩展名来区分 C++ 源文件: .cc 和 .cpp 看来能够同时被 Unix 和 Windows 编译器所识别。）

但是，您也可以在列表中包括 SWIG 接口 (.i) 文件；build_ext 命令知道如何处理 SWIG 扩展：它将在接口文件上运行 SWIG，并将生成的 C/C++ 文件编译为你的扩展。

尽管有此警告，SWIG的选项目前可以这样传递

setup(...,
      ext_modules=[Extension('_foo', ['foo.i'],
                             swig_opts=['-modern', '-I../include'])],
      py_modules=['foo'],
     )

或者在命令行上，像这样

> python setup.py build_ext --swig-opts="-modern -I../include"

在某些平台上，可以包含由编译器处理并包含在扩展中的非源文件。目前，这只是指Visual C++的Windows消息文本（.mc）文件和资源定义（.rc）。这些文件将被编译为二进制资源（.res）文件，并链接到可执行文件中。

2.3.3. 预处理器选项

如果你需要指定要搜索的include目录或预处理器宏来define/undefine，那么：Extension`的三个可选参数将有所帮助：``include_dirs`、define_macros``和``undef_macros。

例如，如果你的扩展需要分发根目录下的 include 目录中的头文件，请使用 include_dirs 选项:

Extension('foo', ['foo.c'], include_dirs=['include'])

你可以在那里指定绝对目录；如果你知道你的扩展只能在安装到 /usr 的 X11R6 的 Unix 系统上构建，那么你就可以:

Extension('foo', ['foo.c'], include_dirs=['/usr/include/X11'])

如果你计划分发代码，应该避免这种不可移植的用法：最好像这样编写C代码

#include <X11/Xlib.h>

如果你需要包含来自其它 Python 扩展的头文件，你可以利用这样一个事实，即 Distutils install_headers 命令以一致的方式安装头文件。 例如，Numerical Python 头文件 (在标准 Unix 安装版上) 会安装到 /usr/local/include/python1.5/Numerical (具体位置将根据你的平台和 Python 安装版而有所不同）。 由于在构建Python 扩展时，Python include 目录 --- 在本例中为 /usr/local/include/python1.5 --- 总是会包含在搜索路径中，因此最好的做法是像这样编写 C 代码:

#include <Numerical/arrayobject.h>

但是，如果必须将 Numerical include 目录放在头文件搜索路径中，则可以使用 Distutils distutils.sysconfig 模块找到该目录:

from distutils.sysconfig import get_python_inc
incdir = os.path.join(get_python_inc(plat_specific=1), 'Numerical')
setup(...,
      Extension(..., include_dirs=[incdir]),
      )

尽管这是非常可移植的——无论平台如何，它都可以在任何Python安装中工作——但以合理的方式编写C代码可能更容易。

您可以使用``define_macros``和``undef_macros``选项 define 和 undefine 预处理器宏。define_macros``采用一个``(name, value)``元组列表，其中``name``是要定义的宏的名称（字符串），``value``是其值：字符串或“``None。（将宏``FOO``定义为``None``相当于C源代码中的空``#define FOO``：对于大多数编译器，这会将``FOO``设置为字符串``1``。）``undef_macros``只是一个undefine的宏列表。

例如：

Extension(...,
          define_macros=[('NDEBUG', '1'),
                         ('HAVE_STRFTIME', None)],
          undef_macros=['HAVE_FOO', 'HAVE_BAR'])

相当于将其放在每个C源文件的顶部

#define NDEBUG 1
#define HAVE_STRFTIME
#undef HAVE_FOO
#undef HAVE_BAR

2.3.4. 库选项

你还可以指定在构建扩展时要链接的库，以及搜索这些库的目录。 libraries 选项是要链接的库列表，library_dirs 是要在链接时搜索库的目录列表，runtime_library_dirs 是要在运行时搜索共享（动态加载）库的目录的列表。

例如，如果你需要链接到目标系统上标准库搜索路径中已知的库

Extension(...,
          libraries=['gdbm', 'readline'])

如果你需要链接到非标准位置的库，则必须将该位置包含在 library_dirs 中:

Extension(...,
          library_dirs=['/usr/X11R6/lib'],
          libraries=['X11', 'Xt'])

（同样，如果你打算分发代码，应该避免这种不可移植的构造。）

2.3.5. 其它选项

还有一些其它选项可以用于处理特殊情况。

optional 选项是一个布尔值；如果它为真值，则扩展中的生成失败不会中止生成过程，而是简单地不安装失败的扩展。

extra_objects 选项是要传递给链接器的对象文件列表。 这些文件不能有扩展名，因为使用的是编译器的默认扩展名。

extra_compile_args 和 extra_link_args 可用于为相应的编译器和链接器命令行指定额外的命令行选项。

export_symbols 仅在 Windows 上适用。 它可以包含要导出的符号（函数或变量）列表。 生成编译的扩展时不需要此选项：Distutils 会自动将 initmodule 添加到导出的符号列表中。

depends 选项是扩展所依赖的文件列表（例如头文件）。 build 命令将调用源上的编译器以重新生成扩展（如果自上一次生成以来此文件上的任何扩展已被修改）。

2.4. 分发和软件包之间的关系

一个分发可能以三种特定方式与软件包相关：

它可能需要软件包或模块。

它可能提供软件包或模块。

它可能废弃软件包或模块。

可以使用 distutils.core.setup() 函数的关键字参数来指定这些关系。

可以通过将 requires 关键字参数提供给 setup() 来指定对其他 Python 模块和包的依赖关系。 其值必须是字符串列表。 每个字符串都指定了所需的软件包，并可以选择哪些版本满足要求。

要指定需要模块或软件包的任何版本，字符串应该完全由模块或软件包的名称组成。 示例包括 'mymodule' 和 'xml.parsers.expat'。

如果需要特定的版本，可以在括号中提供一系列限定符。每个限定符可以由一个比较运算符和一个版本号组成。可接受的比较运算符为:

<    >    ==
<=   >=   !=

这些可以通过使用逗号分隔的多个限定符（以及可选的空格）进行组合。在这种情况下，所有限定符都必须匹配；使用逻辑AND来组合评估。

让我们看一堆例子：

Requires 表达式 | 说明
==1.0 | 只有``1.0``版本兼容
>1.0, !=1.5.1, <2.0 | 1.0 之后和 2.0 之前的任何版本都是兼容的，1.5.1 除外

既然我们可以指定依赖项，我们还需要能够指定我们提供的其它发行版可能需要的内容。这是通过将 provides 关键字参数用于 setup() 来完成的。 该关键字的值是一个字符串列表，每个字符串都命名一个Python模块或软件包，并可选择标识版本。 如果未指定版本，则假定与该发行版的版本相匹配。

一些例子：

Provides 表达式 | 说明
mypkg | Provide mypkg, 使用该分发版的版本
mypkg (1.1) | 提供版本为 1.1的``mypkg``，不管分发版的版本

一个软件包可以使用 obsoletes 关键字参数声明它已经废弃了其它软件包。它的值类似于 requires 关键字的值：一个给出模块或软件包说明符的字符串列表。每个说明符由一个模块或软件包名称组成，后面可选地跟有一个或多个版本限定符。版本限定符在模块或软件包名称后面的括号中给出。

限定符标识的版本是那些被所描述的分发版本废弃的版本。如果没有给出限定符，那么指定的模块或软件包的所有版本都被认为是废弃的。

2.5. 安装脚本

到目前为止，我们一直在处理纯Python模块和非纯Python模块，它们通常不是自己运行的，而是通过脚本导入的。

脚本是包含Python源代码的文件，旨在从命令行启动。脚本不需要Distutils来做任何非常复杂的事情。唯一聪明的功能是，如果脚本的第一行以``#!``开头并且包含单词“python”，Distutils将调整第一行以引用当前解释器位置。默认情况下，它被替换为当前解释器位置。选项:option:!--executable`（或:option:!-e`）将允许显式覆盖解释器路径。

scripts 选项只是要以这种方式处理的文件列表。 从 PyXML 安装脚本

setup(...,
      scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val']
      )

在 3.1 版更改: 如果没有提供模板，所有脚本也将被添加到 MANIFEST 文件中。请参见 指定要分发的文件。

2.6. 安装软件包数据

通常，需要将额外的文件安装到软件包中。这些文件通常是与软件包的实现密切相关的数据，或者是包含使用软件包的程序员可能感兴趣的文档的文本文件。这些文件被称为 package data。

可以使用 setup() 函数的关键字参数 package_data 将软件包数据添加到软件包中。 该值必须是从软件包名到应该复制到软件包中的相对路径名列表的映射。 路径被解释为相对于包含软件包的目录（如果合适，将使用来自 package_dir 映射的信息）；也就是说，这些文件应该是软件包源目录中的一部分。 它们也可能包含 glob 模式。

路径名称可以包含目录部分；任何必要的目录都将在安装过程中创建。

例如，如果一个软件包应该包含一个有多个数据文件的子目录，那么这些文件可以在源树中按如下方式排列

setup.py
src/
    mypkg/
        __init__.py
        module.py
        data/
            tables.dat
            spoons.dat
            forks.dat

对 setup() 的相应调用可能是

setup(...,
      packages=['mypkg'],
      package_dir={'mypkg': 'src/mypkg'},
      package_data={'mypkg': ['data/*.dat']},
      )

在 3.1 版更改: 如果没有提供模板，则所有与 package_data 匹配的文件都将添加到 MANIFEST 文件中。 请参见 指定要分发的文件。

2.7. 安装其它文件

data_files 选项可用于指定模块分发所需的其它文件：配置文件、消息目录、数据文件，以及任何不属于前述类别的文件。

data_files 以如下方式指定 (directory, files) 对的序列:

setup(...,
      data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
                  ('config', ['cfg/data.cfg'])],
     )

序列中的每队（directory，files）指定安装目录和要在其中安装的文件。

files 中的每个文件名都是相对于软件包源发行版顶部的 setup.py 脚本进行解释的。 请注意，您可以指定安装数据文件的目录，但不能重命名数据文件本身。

directory 应该是一个相对路径。它是相对于安装前缀来解释的（Python 的 sys.prefix 用于系统安装；site.USER_BASE 用于用户安装）。 Distutils 允许将 directory 作为一个绝对的安装路径，但这是不鼓励的，因为它与 wheel 封装格式不兼容。不使用来自 files 的目录信息来确定已安装文件的最终位置；只使用文件的名称。

你可以将 data_files 选项指定为一个简单的文件序列，而无需指定目标目录，但不建议这样做，在这种情况下，install 命令将打印警告。 要将数据文件直接安装到目标目录中，应提供一个空字符串作为目录。

在 3.1 版更改: 如果没有提供模板，则所有与 data_files 匹配的文件都将添加到 MANIFEST 文件中。 请参见 指定要分发的文件。

2.8. 附加元数据

安装脚本可以包括除了名称和版本之外的附加元数据。这些信息包括：

元数据 | 描述 | 值 | 备注
name | 包名称 | 短字符串 | (1)
version | 此发布的版本 | 短字符串 | (1)(2)
author | 软件包作者的姓名 | 短字符串 | (3)
author_email | 软件包的作者的电子邮件地址 | 电子邮件地址 | (3)
maintainer | 软件包维护者的名字 | 短字符串 | (3)
maintainer_email | 软件包维护者的电子邮件地址 | 电子邮件地址 | (3)
url | 软件包的网址 | 网址 | (1)
description | 软件包的简短摘要说明 | 短字符串 |
long_description | 软件包的详细说明 | 长字符串 | (4)
download_url | 可以下载软件包的网址 | 网址 |
classifiers | 分类列表 | 字符串列表 | (6)(7)
platforms | 平台清单 | 字符串列表 | (6)(8)
keywords | 关键字列表 | 字符串列表 | (6)(8)
license | 软件包许可证 | 短字符串 | (5)

注释：

这些字段是必需的。

建议版本采用 major.minor[.patch[.sub]] 的形式。

必须确定作者或维护者。如果提供了维护者，distutils 会在 PKG-INFO 中将其列为作者。

PyPI在发布软件包时使用``long_description``字段来构建其项目页面。

license 字段是一个文本，指示软件包中的许可证，其中该许可证不是从 “license” Trove分类器中选择的。请参见 Classifier 字段。 请注意，有一个 licence 分发选项，该选项已被弃用，但仍充当 license 字段的别名。

此字段必须是一个列表。

有效的分类器在 PyPI [https://pypi.org/classifiers] 上列出。

为了保持向后兼容性，此字段还接受一个字符串。如果传递逗号分隔的字符串``'foo, bar'，它将被转换为``['foo', 'bar']，否则，它将转换为一个字符串列表。

'短字符串'

一行文字，不超过200个字符。

'长字符串'

Multiple lines of plain text in reStructuredText format (see http://docutils.sourceforge.net/).

'字符串列表'

请参见下文。

对版本信息进行编码本身就是一门艺术。Python包通常遵循版本格式 major.minor[.patch][sub] 。初始的、实验性的软件版本的主数字是0。对于表示包中主要里程碑的版本，主版本会递增。当重要的新特性添加到包中时，次版本编号会增加。当发布错误修复程序时，补丁编号会增加。附加的尾随版本信息有时用于指示子版本。这些是“a1，a2，…，aN”（对于alpha版本，功能和API可能会更改），“b1，b2，…，bN”（针对beta版本，它只修复了错误）和“pr1，pr2，……，prN”（用于最终的预发布测试）。一些例子：

0.1.0

一个软件包的第一个实验性发布

1.0.1a2

1.0的第一个补丁版本的第二个alpha版本

classifiers 必须在列表中指定

setup(...,
      classifiers=[
          'Development Status :: 4 - Beta',
          'Environment :: Console',
          'Environment :: Web Environment',
          'Intended Audience :: End Users/Desktop',
          'Intended Audience :: Developers',
          'Intended Audience :: System Administrators',
          'License :: OSI Approved :: Python Software Foundation License',
          'Operating System :: MacOS :: MacOS X',
          'Operating System :: Microsoft :: Windows',
          'Operating System :: POSIX',
          'Programming Language :: Python',
          'Topic :: Communications :: Email',
          'Topic :: Office/Business',
          'Topic :: Software Development :: Bug Tracking',
          ],
      )

在 3.7 版更改: 现在 setup 在 classifiers、keywords 或 platforms 字段未指定为列表或字符串时发出警告。

2.9. 调试安装脚本

有时会出现问题，并且安装脚本不能执行开发人员想要的操作。

Distutils在运行安装脚本时捕获任何异常，并在脚本终止前打印一条简单的错误消息。这种行为的动机是为了不让那些对Python不太了解并试图安装软件包的管理员感到困惑。如果他们从Distutils的内部深处得到了一个很长的追溯，他们可能会认为这个软件包或Python安装坏了，因为他们没有一直读到底部，看到这是一个权限问题。

另一方面，这并不能帮助开发人员找到失败的原因。 为此，DISTUTILS_DEBUG 环境变量可以设置为除空字符串之外的任何值，distutils 现在将打印有关其正在执行的操作的详细信息，在发生异常时转储完整的回溯，并在外部程序（如 C 编译器）失败时打印整个命令行。

3. 编写设置脚本的配置文件

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

通常，在 事前 就写出构建发布包所需的一切是不可能的：你可能需要从用户或者用户的系统获取一些信息，才能继续下去。 只要这些信息相当简单 —— 例如一个用于搜索 C 头文件或库的目录列表 —— 那么提供配置文件 setup.cfg 供用户配置就是一个低成本且方便的解决方式。 配置文件还允许你为任何命令选项提供默认值，而安装器可以通过命令行或编辑配置文件来覆盖这些默认值。

安装配置文件是在安装脚本和安装脚本命令行之间一个适当的折衷方式 --- 安装脚本在理想情况下应当不受安装者的控制 1 --- 而安装脚本命令行则在你的控制范围之外且完全取决于安装者的选择。 实际上，setup.cfg (以及目标系统上的其他任何 Distutils 配置文件) 是在配置脚本之后、命令行之前被处理。 这导致了几个有用的后果:

安装者可以通过编辑 setup.cfg 来覆盖你放在 setup.py 中的配置

你可以为无法在 setup.py 中方便设置的选项提供非标准的默认值

安装者可以使用 setup.py 的命令行选项来覆盖 setup.cfg 中的一切

配置文件的基本语法很简单:

[command]
option=value
...

其中 command 是一个 Distutils 命令 (例如 build_py, install)，而 option 是该命令所支持的某个选项。 可以为每个命令提供任意数量的选项，并且可以在文件中包括任意数量的命令组。 空白行会被忽略，以一个 '#' 开始的注释行也是如此。 长选项值可以简单地通过缩进后续行的方式被拆分为多行。

你可以用通用的 --help 选项找出特定命令所支持的选项列表，例如

$ python setup.py --help build_ext
[...]
Options for 'build_ext' command:
  --build-lib (-b)     directory for compiled extension modules
  --build-temp (-t)    directory for temporary files (build by-products)
  --inplace (-i)       ignore build-lib and put compiled extensions into the
                       source directory alongside your pure Python modules
  --include-dirs (-I)  list of directories to search for header files
  --define (-D)        C preprocessor macros to define
  --undef (-U)         C preprocessor macros to undefine
  --swig-opts          list of SWIG command line options
[...]

请注意在命令行中拼写为 --foo-bar 的选项在配置文件中会拼写为 foo_bar。

例如，假设你希望你的扩展在“原地”构建 --- 就是说你有一个扩展 pkg.ext，你希望编译出的扩展文件 (例如在 Unix 上为 ext.so) 放在与你的纯 Python 模块 pkg.mod1 和 pkg.mod2 相同的源目录中。 你总是可以在命令行中使用 --inplace 选项来确保这一点:

python setup.py build_ext --inplace

但是这要求你总是显式地指定 build_ext 命令，并且记得提供 --inplace。 一个更容易的方式是通过将其编码在此发布包的配置文件 setup.cfg 中，“设置并忘记”该选项。

[build_ext]
inplace=1

这将影响此模块发布包的所有构建，不论你是否显式指定 build_ext。 如果你在你的源发布包中包括了 setup.cfg，它还将影响最终用户的构建 --- 对此选项来说这可能不是个好主意，因为总是原地构建扩展会破坏模块发布包的安装。 不过在某些特殊情况下，模块是在其安装目录中被构建的，因此这可能会是个有用的功能。 （但是，发布预期在其安装目录中被构建的扩展几乎总是一个坏主意。）

另一个例子：特定的命令会接受许多在多次运行中都不发生变化的选项；例如，bdist_rpm 需要知道为创建 RPM 发布包生成 "spec" 文件所要求的所有信息。 这些信息有的来自安装脚本，有的由 Distutils 自动生成（例如已安装文件列表）。 但有的则必须作为 bdist_rpm 的选项提供，每次运行时都在命令行中完成将会非常繁琐。 因此，这里提供 Distutils 本身的 setup.cfg 中的一段代码:

[bdist_rpm]
release = 1
packager = Greg Ward <gward@python.net>
doc_files = CHANGES.txt
            README.txt
            USAGE.txt
            doc/
            examples/

请注意 doc_files 选项只是一个空格分隔以提高可读性的多行字符串。

参见

"安装 Python 模块" 中的 Syntax of config files

有关配置文件的更多信息可在系统管理员手册中查看。

备注

1

在 Distutils 完全支持自动配置之前，这一理想可能是无法实现的。

4. 创建源代码分发包

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

如 一个简单的例子 一节所示，可以使用 sdist 命令来创建一个源代码分发包。 在最简单的场景下，:

python setup.py sdist

（假定你没有在设置脚本或配置文件中指定任何 sdist 选项），sdist 将创建基于当前平台的默认格式的归档。 在 Unix 上默认格式为 gzip 的 tar 文件，而在 Windows 上则为 ZIP 文件。

你可以使用 --formats 选项来指定任何你想要的格式，例如:

python setup.py sdist --formats=gztar,zip

是创建一个 gzip 的 tar 文件和一个 zip 文件。 可用的格式有:

格式 | 描述 | 备注
zip | zip 文件 (.zip) | (1),(3)
gztar | gzip 的 tar 文件 (.tar.gz) | (2)
bztar | bzip2 的 tar 文件 (.tar.bz2) | (5)
xztar | xz 的 tar 文件 (.tar.xz) | (5)
ztar | 带压缩的 tar 文件 (.tar.Z) | (4),(5)
tar | tar 文件 (.tar) | (5)

在 3.5 版更改: 添加了对 xztar 格式的支持

注释：

默认Windows

默认 Unix

需要有外部 zip 工具或 zipfile 模块（自 Python 1.6 起是标准 Python 库的一部分）

需要有 compress 程序。 请注意此格式计划要弃用并将在未来的 Python 版本中被移除。

已被 PEP 527 [https://www.python.org/dev/peps/pep-0527/] 弃用; PyPI [https://pypi.org] 只接受 .zip 和 .tar.gz 文件。

当使用任意 tar 格式 (gztar, bztar, xztar, ztar 或 tar) 时，在 Unix 中你可以指定将为每个归档成员设置的 owner 和 group 名称。

举例来说，如果你希望归档中的全部文件均为 root 所有:

python setup.py sdist --owner=root --group=root

4.1. 指定要分发的文件

如果你没有显式提供文件列表（或如何生成该列表的说明），则 sdist 命令会将一个最小化默认集加入源代码分发版:

通过 py_modules 和 packages 选项指明的所有 Python 源文件

在 ext_modules 在 libraries 选项提及的所有 C 源代码文件

通过 scripts 选项标识的脚本，参见 安装脚本。

任何看起来像是测试脚本的文件: test/test*.py (目前，Distutils 不会对测试脚本做除了将它们包括到源代码分发版以外的任何操作，但是在未来将会有一个测试 Python 模块分发版的标准)

任何标准的 README 文件 (README, README.txt 或 README.rst), setup.py (或任何你指定的安装脚本) 以及 setup.cfg。

所有匹配 package_data 元数据的文件。 参见 安装软件包数据。

所有匹配 data_files 元数据的文件。 参见 安装其它文件。

有时这就足够了，但通常你还会希望指定要分发的额外文件。 实现这一点的通常方式是编写一个 声明模板，默认名称为 MANIFEST.in。 声明模板就是一个有关如何生成你的声明文件 MANIFEST 的指令列表，也就是要实际包括在你的源代码分发版中的文件的列表。 sdist 命令会处理这个模板并基于其指令及其在文件系统中的查找结果生成一个声明文件。

如果你想要制作你自己的声明文件，格式很简单：每行一个文件名，仅限常规文件。 如果你提供你自己的 MANIFEST，你必须指明一切：上面描述的默认集将不适用于这种情况。

在 3.1 版更改: 现有的已生成 MANIFEST 将被生成而无需 sdist 来将其修改时间与 MANIFEST.in 或 setup.py 的修改时间进行比较。

在 3.1.3 版更改: MANIFEST 文件以一个表明它们已生成的注释开始。 没有这条注释的文件不会被覆盖或移除。

在 3.2.2 版更改: sdist 将在不存在 MANIFEST.in 时读取一个 MANIFEST 文件，如它以前所做的一样。

在 3.7 版更改: README.rst 现在已被包括在 distutils 标准 README 列表中。

声明模板每行都有一个命令，其中每个命令指定了一组源代码发布版中要包括或排除的文件。 举例来说，我们再次关注 Distutils 自己的声明模板:

include *.txt
recursive-include examples *.txt *.py
prune examples/sample?/build

其含义应当很清楚：包括发布在根目录中所有匹配 *.txt 的文件，在 examples 目录下任何位置上匹配 *.txt 或 *.py 的所有文件，并排除匹配 examples/sample?/build 的所有目录。 所有这些操作都将在标准的包括集 之后 执行，因此你可以通过在声明模板中的显式指令来排除标准集中的文件。 （或者，你也可以使用 --no-defaults 选项来完全禁用标准集。） 在声明模板迷你语言中还有一些其他的可用命令；参见 创建源码发行包: sdist 命令 小节。

声明模板中命令的顺序是很重要的：在初始状态下，我们有如上所述的默认文件列表，而模板中的每个命令将在该文件列表中添加或移除条目。 一旦我们完全处理好声明模板，我们将再移除不应包括在源代码发布版中的文件:

Distutils "构建" 目录树中的所有文件 (默认值 build/)

目录中所有名为 RCS, CVS, .svn, .hg, .git, .bzr 或 _darcs 的文件

现在我们有了完整的文件列表，它已被写入声明以供将来引用，并随后用于构建源代码分发压缩 包。

你可以通过 --no-defaults 选项禁用默认的包括文件集，你还可以通过 --no-prune 禁用默认的排除文件集。

跟随 Distutils 自己的声明模板，让我们追踪' own manifest template, let's trace how the sdist 命令是如何构建要包括在 Distutils 源代码分发版中的文件列表的:

包括 distutils 和 distutils/command 子目录中的所有 Python 源代码文件（因为与这两个目录对应的包在 setup 脚本的 packages 选项中被提及 --- 参见 编写安装脚本 一节）

包括 README.txt, setup.py 和 setup.cfg (标准文件)

包括 test/test*.py (标准文件)

包括分发根目录下的 *.txt (这将第二次找到 README.txt，但这样的冗余随后会被清除)

包括 examples 下所有子目录树中匹配 *.txt 或 *.py 的任何文件，

排除从匹配 examples/sample?/build 的目录开始的子目录树中的所有文件 --- 这可能会排除之前两个步骤所包括的文件，因此重要的一点是声明模板中的 prune 命令应放在 recursive-include 命令之后

排除整个 build 目录树，以及任何 RCS, CVS, .svn, .hg, .git, .bzr and _darcs 目录

就像在设置脚本中一样，声明模板中的文件和目录名应当总是以斜杠分隔；Distutils 将会负责把它们转化为你的系统平台上的标准表示形式。 通过这种方式，声明模板将可跨操作系统移植。

4.2. 声明相关选项

针对 sdist 命令的正常操作过程如下:

如果声明文件 (默认为 MANIFEST) 存在且第一行不为表示它是由 MANIFEST.in 生成的注释，则它会被不加修改地原样使用

如果声明文件不存在或是在此之前被自动生成的，则读取 MANIFEST.in 并创建声明文件

如果 MANIFEST 或 MANIFEST.in 均不存在，则使用默认文件集创建声明文件

使用当前 MANIFEST (刚生成的或读入的) 中的文件列表创建源代码分发压缩包

有数个选项可以修改此行为。 首先，使用 --no-defaults 和 --no-prune 来禁用标准的 "包括" 和 "排除" 集。

第二，你可能只是想要（重）生成声明文件，但不想要创建源代码分发包:

python setup.py sdist --manifest-only

-o 是 --manifest-only 的缩写。

5. 创建构建分发版

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

“构建分发版”即你通常所认为的“二进制包”或“安装程序”（取决于你的技术背景）。 但它并不一定是二进制的，因为它可能只包含 Python 源代码和/或字节码；并且我们也不将其称为包，因为这个词在 Python 中已经被使用。 （而“安装程序”是主流桌面系统领域的一个专有术语。）

分发版可以让你的模块分发安装器尽可能地方便易用：对于基于 RPM 的 Linux 系统的用户，它将为二进制 RPM；对于 Windows 的用户，它将为可执行文件安装器；对于基于 Debian 的 Linux 用户，它将为 Debian 安装包；诸如此类。 显然，没有人能为世界上所有的系统平台都构建分发版，因此 Distutils 被设计用来让模块开发者能够专注于他们的专长 --- 编写代码并创建源代码分发版 --- 而让另一群作为中介的 打包者 负责在尽可能多的受支持系统平台上将源代码分发版转换为构建分发版。

当然，模块开发者可以是自己模块的打包者；或者打包者也可以是住在别处的“某一位”能够接触到原始开发者接触不到的特定系统平台的志愿者；或者还可以是一个定期抓取新的源代码分发版并在尽可能多的受支持系统平台上将其转换为构建分发版的软件。 无论他们属于哪一种，打包者都会使用设置脚本和 bdist 命令族来生成构建分发版。

作为一个简单示例，如果我在 Distutils 源代码树中运行以下命令:

python setup.py bdist

则 Distutils 将构建我的模块分发版（在此情况下即 Distutils 本身），执行“模拟”安装（同样是在 build 目录中），并为我的系统平台创建默认类型的构建分发版。 构建分发版的默认格式在 Unix 上是一个“非自动” tar 文件，而在 Windows 上则是一个简单的可执行文件安装器。 （此 tar 文件被称为“非自动”是因为它必须在指定的位置上解包方可使用。）

这样，上述命令在 Unix 系统上将会创建 Distutils-1.0.plat.tar.gz；在正确的位置上解包这个 tar 文件将会装好 Distutils，就像是你下载了源代码分发版并运行 python setup.py install 一样。 （这个“正确的位置”可能是文件系统根目录或 Python 的 prefix 目录，具体取决于提供给 bdist_dumb 命令的选项；在默认情况下是相对于 prefix 创建非自动颁发版。）

显然，对于纯粹的 Python 分发版来说，这并不比运行 python setup.py install 更简单 --- 但是对于包括需要被编译的扩展的非纯粹的分发版来说，就可能是有人能使用你的扩展而有人不能使用的差别。 而创建“自动”构建分发版，例如 RPM 包或 Windows 的可执行文件安装器，对于用户来说就会更加方便，即使你的分发版不包括任何扩展。

bdist 命令有一个 --formats 选项，与 sdist 命令类似，你可以用该选项来选择要生成的构建分发版类型：例如，:

python setup.py bdist --format=zip

当在 Unix 系统上运行时，会再次创建 Distutils-1.0.plat.zip，这个归档文件将从根目录被解包以安装 Distutils。

构建分发版的可用格式有:

格式 | 描述 | 备注
gztar | gzipped tar 文件 (.tar.gz) | (1)
bztar | bzipped tar 文件 (.tar.bz2) |
xztar | xzipped tar 文件 (.tar.xz) |
ztar | 带压缩的 tar 文件 (.tar.Z) | (3)
tar | tar 文件 (.tar) |
zip | zip 文件 (.zip) | (2),(4)
rpm | RPM | (5)
pkgtool | Solaris pkgtool |
sdux | HP-UX swinstall |
msi | Microsoft安装程序。 |

在 3.5 版更改: 添加了对 xztar 格式的支持

注释：

默认 Unix

默认Windows

需要外部 compress 工具。

需要有外部 zip 工具或 zipfile 模块（自 Python 1.6 起是标准 Python 库的一部分）

需要有外部 rpm 工具，版本号为 3.0.4 或以上（可使用 rpm --version 查看你所使用的版本）

你不必附带 --formats 来使用 bdist 命令；你还可以使用直接实现了你想要的特定格式的命令。 某些这样的 bdist "子命令" 实际上会生成几种相似的格式；例如，bdist_dumb 命令将生成所有 "非自动" 归档格式 (tar, gztar, bztar, xztar, ztar 和 zip)，而 bdist_rpm 将同时生成二进制和源代码 RPM。 bdist 子命令以及每个子命令所生成的格式如下:

命令 | 格式
bdist_dumb | tar, gztar, bztar, xztar, ztar, zip
bdist_rpm | rpm, srpm
bdist_msi | msi

注解

bdist_msi 从 Python 3.9 起被弃用。

以下小节提供了每个 bdist_* 命令的详情。

5.1. 创建RPM软件包

RPM 格式被许多流行的 Linux 发行版所使用，包括 Red Hat, SuSE 和 Mandrake。 如果其中（或任何其他基于 RPM 的 Linux 发行版）的某一个是你的常用环境，那么为相同发行版的其他用户创建 RPM 包是很容易的。 根据你的模块分发版的复杂度以及 Linux 发行版之间的差异性，你还可能创建适用于多个基于 RPM 的发行版的 RPM 包。

为你的模块分发版创建 RPM 的通常方式是运行 bdist_rpm 命令:

python setup.py bdist_rpm

或者 bdist 命令附带 --format 选项:

python setup.py bdist --formats=rpm

前者允许你指定 RPM 专属的选项；后者允许你方便地一次性指定多种格式。 如果这两样你全都要，你可以显式地指定多个 bdist_* 命令及其选项:

python setup.py bdist_rpm --packager="John Doe <jdoe@example.org>"

创建 RPM 包的操作是由 .spec 文件驱动的，就像 Distutils 的使用是由 setup 脚本驱动的一样。 为了让你更方便，bdist_rpm 命令通常会根据你在 setup 脚本、命令行和任意 Distutils 配置文件中提供的信息创建一个 .spec 文件。 .spec 文件中的各种选项和小节从 setup 脚本中派生的情况如下:

RPM .spec 文件配置或选项 | Distutils安装脚本选项
名称 | name
摘要（在序言中） | description
版本 | version
供应商 | author 和 author_email, 或 --- & maintainer 和 maintainer_email
版权所有 | license
Url | url
%d描述（部分） | long_description

此外，在 .spec 文件中还有许多选项在 setup 脚本中没有对应的选项。 这些选项大多是通过传给 bdist_rpm 命令的选项来处理的，如下所示:

RPM .spec 文件配置或选项 | bdist_rpm 选项 | 默认值
发布版本 | release | "1"
组织 | group | "Development/Libraries"
供应商 | vendor | （同上）
打包 | packager | (none)
提供 | provides | (none)
需求 | requires | (none)
冲突 | conflicts | (none)
淘汰 | obsoletes | (none)
Distribution | distribution_name | (none)
构建要求 | build_requires | (none)
Icon | icon | (none)

显然，即使是在命令行中提供少量的此类选项也是很繁琐易出错的，因此通常最好是将它们放在 setup 配置文件 setup.cfg 中，参见 编写设置脚本的配置文件 一节。 如果你要分发或打包许多 Python 模块分发版，你可能会需要将适用于所有这些分发版的选项放在你私人的 Distutils 配置文件中 (~/.pydistutils.cfg)。 如果你想要临时禁用此文件，你可以将 --no-user-cfg 选项传给 setup.py。

构建一个二进制 RPM 包有三个步骤，它们全都是由 Distutils 自动处理的:

创建一个 .spec 文件，该文件对包进行了描述（类似于 Distutils setup 脚本；实际上 setup 脚本中的许多信息都会出现在 .spec 文件中）

创建源 RPM

创建“二进制”RPM（其中可能包含二进制代码也可能不包含，具体取决于你的模块分发版是否包含 Python 扩展）

通常，RPM 会将后两个步骤捆绑在一起；当你使用 Distutils 时，三个步骤通常都会捆绑在一起。

如果你愿意，你也可以将这三个步骤分开。 你可以使用 --spec-only 选项来让 bdist_rpm 只创建 .spec 文件并退出；在这种情况下，.spec 文件将被写到“分发目录” --- 通常为 dist/，但可通过 --dist-dir 选项来自定义。 （通常，.spec 文件会位于“构建树”的深处，在 bdist_rpm 所创建的一个临时目录中。）

5.2. 在 Windows 上的交叉编译

从 Python 2.6 开始，distutils 能够在不同 Windows 平台之间执行交叉编译。 实际上，这意味着只要安装了正确的工具，你可以使用 32 位版 Windows 来创建 64 位的扩展或是反向操作。

要针对替代平台进行编译，请为构建命令指定 --plat-name 选项。 目前的有效值为 'win32' 和d 'win-amd64'。 例如，在 32 位版 Windows 上，你可以执行:

python setup.py build --plat-name=win-amd64

来构建你的扩展的 64 位版。

将在你的 32 位版 Windows 上创建一个 64 位版的安装程序可执行文件。

要进行交叉编译，你必须下载 Python 源代码并针对你的目标平台交叉编译 Python 本身 —— 使用 Python 的二进制安装版是无法做到的（因为其中不包括针对其他平台的 .lib 等文件。） 实际上，这意味着 32 位操作系统的用户将需要使用 Visual Studio 2008 来打开 Python 源代码目录树下的 PCbuild/PCbuild.sln 解决方案并构建 'pythoncore' 项目的 "x64" 配置之后才能进行扩展的交叉编译。

请注意在默认情况下，Visual Studio 2008 并不会安装 64 位编译器或工具。 你可能需要重新执行 Visual Studio 安装过程并选择这些工具（使用控制面板 -> [添加/移除] 程序是检查或修改你的现有安装的一个便捷方式。）

5.2.1. 安装后脚本

从 Python 2.3 开始，可以通过 --install-script 选项指定一个安装后脚本。 必须要指定脚本的主文件名，并且该脚本文件名还必须在传给 setup 函数的参数中列出。

在安装时当所有文件拷贝完毕后该脚本将会在目标系统上运行，并将 argv[1] 设为 -install，而在卸载时当文件被移除前会再次运行并将 argv[1] 设为 -remove。

安装脚本嵌入在 Windows 安装程序中运行，每个输出 (sys.stdout, sys.stderr) 都会被重定向到一个缓冲区并将在脚本完成后显示到 GUI 中。

一些在此上下文中特别有用的功能在安装脚本中作为附加内置函数被提供。

directory_created(path)

file_created(path)

这些函数应当在安装时的安装后脚本创建某个目录或文件时被调用。 它会将 path 注册到卸载程序，这样当分发版被卸载时它将被移除。 安全起见，目录只有在为空时才会被移除。

get_special_folder_path(csidl_string)

此函数可被用来获取 Windows 中的特殊文件夹位置如 Start Menu 或 Desktop。 它将返回相应文件夹的完整路径。 csidl_string 必须为下列字符串之一:

"CSIDL_APPDATA"

"CSIDL_COMMON_STARTMENU"
"CSIDL_STARTMENU"

"CSIDL_COMMON_DESKTOPDIRECTORY"
"CSIDL_DESKTOPDIRECTORY"

"CSIDL_COMMON_STARTUP"
"CSIDL_STARTUP"

"CSIDL_COMMON_PROGRAMS"
"CSIDL_PROGRAMS"

"CSIDL_FONTS"

如果文件夹不能被检索到，会触发 OSError 。

有哪些可用的文件夹取决于的 Windows 的具体版本，并可能受特定配置的影响。 更多细节请参考 Microsoft 有关 SHGetSpecialFolderPath() 函数的文档。

create_shortcut(target, description, filename[, arguments[, workdir[, iconpath[, iconindex]]]])

此函数会创建一个快捷方式。 target 是此快捷方式要启动的程序的路径。 description 是快捷方式的描述文本。 filename 是用户将看到的快捷方式的标题。 arguments 指定命令行参数，如果有的话。 workdir 是程序的工作目录。 iconpath 是包含快捷方式的图标的文件，而 iconindex 是 iconpath 文件中图标的索引号。 同样地，更多细节请参考 Microsoft 有关 IShellLink 接口的文档。

6. Distutils 示例

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

本章节提供几个基础示例，来帮助用户入门 distutils。关于使用 distutils 的额外信息可以参考 Distutils Cookbook。

参见

Distutils Cookbook [https://wiki.python.org/moin/Distutils/Cookbook]

一套展示如何更好地控制和使用 distutils 的方法。

6.1. 纯 Python 分发（通过 module）

如果你要分发一组模块，特别是它们不在特定的包中，你可以在配置脚本中使用 py_modules 选项单独指定它们。

最简单的情况下，你只用关心两个文件：一个配置脚本，和单个你要分发的模块，这个示例中的 foo.py: ：

<root>/
        setup.py
        foo.py

（在本章节的所有图中，<root> 表示分发根目录。）这种情况下的一个最小配置脚本是：

from distutils.core import setup
setup(name='foo',
      version='1.0',
      py_modules=['foo'],
      )

注意分发的包名用 name 选项单独指定，没有规定它必须和包中单独的模块同名（虽然这也是个可以遵循的好习惯）。然而，分发名用来生成文件名，所以你应该坚持用字母、数字、下划线和连词号。

因为 py_modules 是个列表，你当然可以指定多个模块，比如，如果你要分发模块 foo 和 bar，你的配置可能是这样：

<root>/
        setup.py
        foo.py
        bar.py

并且配置脚本是：

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      py_modules=['foo', 'bar'],
      )

你可以把模块源文件放进另一个目录，但是如果你有足够的模块，也许用包指定模块更简单，而不是单独列出它们。

6.2. 纯 Python 分发（通过 包）

如果你有超过一组模块要分发，特别是它们在不同的包中，也许指定整个包更简单，而不是指定单独的模块。这样即使你的模块不在一个包中也有效；你可以直接令 Distutils 来从根包来处理模块，并且这样对任何其他包也有效（除非你不需要 __init__.py 文件）。

上一个示例的配置脚本也可以写成：

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      packages=[''],
      )

（空字符串表示根包。）

如果两个文件移动到子目录，但是依然在根包中，如：

<root>/
        setup.py
        src/      foo.py
                  bar.py

那么你依然需要指定根包，但是你还需要告诉 Distutils 根包中的源文件在哪：

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      package_dir={'': 'src'},
      packages=[''],
      )

更一般地，你要分发多个在同一个包（或者子包）中的模块。举个例子，假设 foo 和 bar 模块属于 foobar 包，排布源文件树的一种方式是：

<root>/
        setup.py
        foobar/
                 __init__.py
                 foo.py
                 bar.py

这其实是 Distutils 默认的排布，也是你的配置脚本中需要的工作量最小的。

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      packages=['foobar'],
      )

如果你要把模块放到没有按照它们的包名命名的目录里，那你需要再次使用 package_dir 选项。比如，如果 src 目录包含包 foobar 中的模块：

<root>/
        setup.py
        src/
                 __init__.py
                 foo.py
                 bar.py

一个合适的配置脚本可以是：

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      package_dir={'foobar': 'src'},
      packages=['foobar'],
      )

或者，你可以把主包中的模块直接放到分发根目录：

<root>/
        setup.py
        __init__.py
        foo.py
        bar.py

这样你的配置文件是：

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      package_dir={'foobar': ''},
      packages=['foobar'],
      )

（空字符串同样表示当前目录。）

如果你有子包，则它们必须显式列在 packages 中，但是 package_dir 中的任何条目会自动扩展到子包。（也就是说，Distutils 不会 扫描你的源码树，而是尝试通过查找 __init__.py 文件，来弄清哪些目录与 Python 包关联。）这样，如果默认排布产生一个子包：

<root>/
        setup.py
        foobar/
                 __init__.py
                 foo.py
                 bar.py
                 subfoo/
                           __init__.py
                           blah.py

则相应的配置脚本是：

from distutils.core import setup
setup(name='foobar',
      version='1.0',
      packages=['foobar', 'foobar.subfoo'],
      )

6.3. 单个扩展模块

扩展模块用 ext_modules 选项指定。package_dir 对在哪寻找扩展源文件无效；它只对纯 Python 模块的源文件有效。最简单的，一个用单个C源文件写的单扩展模块是：

<root>/
        setup.py
        foo.c

如果 foo 扩展属于根包，则配置脚本可以是：

from distutils.core import setup
from distutils.extension import Extension
setup(name='foobar',
      version='1.0',
      ext_modules=[Extension('foo', ['foo.c'])],
      )

如果扩展在包中，比如 foopkg，那么

使用完全相同的源文件树排布，通过改变扩展的名字，这个扩展很容易放入 foopkg 包中：

from distutils.core import setup
from distutils.extension import Extension
setup(name='foobar',
      version='1.0',
      ext_modules=[Extension('foopkg.foo', ['foo.c'])],
      )

6.4. 检查一个包

check 命令允许你校验你的包的元数据是否满足生成分发的最低要求。

直接使用你的 setup.py 脚本来运行它。如果缺了一些东西，check 会显示警告。

我们来用单个脚本举例：

from distutils.core import setup

setup(name='foobar')

运行 check 命令会显示一些警告：

$ python setup.py check
running check
warning: check: missing required meta-data: version, url
warning: check: missing meta-data: either (author and author_email) or
         (maintainer and maintainer_email) should be supplied

如果你在 long_description 域中使用 reStructuredText 语法，并且安装了 docutils [http://docutils.sourceforge.net] ，你可以用 check 命令，和 restructuredtext 选项检查语法是否正确。

比如，如果 setup.py 脚本改成：

from distutils.core import setup

desc = """\
My description
==============

This is the description of the ``foobar`` package.
"""

setup(name='foobar', version='1', author='tarek',
    author_email='tarek@ziade.org',
    url='http://example.com', long_description=desc)

长描述中有问题的地方，通过使用 docutils 解析器，check 能进行删除：

$ python setup.py check --restructuredtext
running check
warning: check: Title underline too short. (line 2)
warning: check: Could not finish the parsing.

6.5. 读取元数据

distutils.core.setup() 函数提供一个通过项目的 setup.py 脚本，来查询项目的元数据的域的命令行接口：

$ python setup.py --name
distribute

这个调用通过运行 distutils.core.setup() 函数读取 name 元数据。然而，当源文件或者二进制分发用 Distutils 创建时，元数据域写入一个名为 PKG-INFO 的静态文件。当一个基于Distutils的项目安装在 Python 中时，PKG-INFO 文件随着分发的模块和包一起复制到 NAME-VERSION-pyX.X.egg-info 中，其中 NAME 是项目的名字，VERSION 是元数据中定义的版本， pyX.X 则是 Python 的大版本和小版本，如 2.7 或者 3.2。

你可以读回静态文件，使用 distutils.dist.DistributionMetadata 类和它的 read_pkg_file() 方法：

>>> from distutils.dist import DistributionMetadata
>>> metadata = DistributionMetadata()
>>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info'))
>>> metadata.name
'distribute'
>>> metadata.version
'0.6.8'
>>> metadata.description
'Easily download, build, install, upgrade, and uninstall Python packages'

注意类也可以用元数据文件载入值来实例化：

>>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info'
>>> DistributionMetadata(pkg_info_path).name
'distribute'

7. 扩展 Distutils

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

Distutils 可以通过各种方式扩展。 大多数扩展都采用新命令或现有命令的替换形式。 例如，可以编写新命令以支持新的特定于平台的包格式，但是可以修改现有命令的替换，以修改命令在包上的操作细节。

distutils 的大多数扩展都在想要修改现有命令的 setup.py 脚本中编写；其中许多只是简单地在 .py 文件以外添加了一些应当被拷贝到包中的文件后缀以便使用。

大多部 distutils 命令的实现都是 distutils.cmd.Command 类的子类。 新增命令可直接继承自 Command，而替换命令往往间接派生自 Command， 直接子类化它们所替换的命令。 所有命令都要求自 Command 派生。

7.1. 集成新的命令

有多种方法可将新的命令实现集成到 distutils 中。 最困难的一种是鼓动在 distutils 自身内部包含新特性，并等待（以及要求）某个 Python 版本提供该支持。 出于多种原因，这确实是相当难的。

对于大多数需求来说最为常见并且可能最为合理的一种则是通过你自己的 setup.py 脚本来包含新的实现，然后让 distutils.core.setup() 函数使用它们:

from distutils.command.build_py import build_py as _build_py
from distutils.core import setup

class build_py(_build_py):
    """Specialized Python source builder."""

    # implement whatever needs to be different...

setup(cmdclass={'build_py': build_py},
      ...)

如果新的实现必须通过特定的包来使用则此方式最为适宜，因为每个对这个包感兴趣的人都将会需要有新的命令实现。

从 Python 2.4 开始，还有第三个选项可用，其目标是允许添加支持现有 setup.py 脚本的新命令，而不需要修改 Python 安装包。 这预计可允许第三方扩展提供对附加打包系统的支持，而相应命令又可用于任何 distutils 命令可被使用的地方。 新的配置选项 command_packages (命令行选项为 --command-packages) 可用来指定附加包，以在其中查找实现新增命令的模块。 像所有 distutils 选项一样，这可以通过命令行或配置文件来指定。 此选项只能在配置文件的 [global] 小节之中或在命令行的任何命令之前设置。 如果是设置在配置文件中，则它可被命令行设置重载；如果在命令行中将其设为空字符串则将会使用默认值。 此选项绝不应当在随特定包提供的配置文件中设置。

这个新选项可被用来添加任意数量的包到查找命令实现的包列表；多个包名应当以逗号分隔。 当未指明时，查找将只在 distutils.command 包中进行。 但是当 setup.py 附带 --command-packages distcmds,buildcmds 选项运行时，distutils.command, distcmds 和 buildcmds 包将按此顺序被查找。 新的命令应当在与命名同名的模块中由同名的类来实现。 给定上述示例命令行选项，则命令 bdist_openpkg 可由类 distcmds.bdist_openpkg.bdist_openpkg 或 buildcmds.bdist_openpkg.bdist_openpkg 来实现。

7.2. 添加新的发布类型

创建发布（在 dist/ 目录中的文件）的命令需要将 (command, filename) 二元组添加到 self.distribution.dist_files 以便 upload 可以将其上传到 PyPI。 二元组中的 filename 不包含路径信息而只有文件名本身。 在 dry-run 模式下，二元组仍然应当被添加以表示必须创建的内容。

8. 命令参考

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

8.1. 安装模块: install 命令族

install 命令会确保 build 命令已经运行，然后运行子命令 install_lib, install_data 和 install_scripts。

8.1.1. install_data

此命令会安装随发行包一同提供的所有数据文件。

8.1.2. install_scripts

此命令会安装发行包中的所有（Python）脚本。

8.2. 创建源码发行包: sdist 命令

列出的模板命令有:

命令 | 描述
include pat1 pat2 ... | 包括与列出的模式匹配的所有文件
exclude pat1 pat2 ... | 排除与列出的模式匹配的所有文件
recursive-include dir pat1 pat2 ... | 包括 dir 下与列出的模式匹配的所有文件
recursive-exclude dir pat1 pat2 ... | 排除 dir 下与列出的模式匹配的所有文件
global-include pat1 pat2 ... | 包括与源树匹配的所有文件---和任何列出的模式
global-exclude pat1 pat2 ... | 排除与源树匹配的所有文件---和任何列出的模式
prune dir | 排除 dir 下的所有文件
graft dir | 包括 dir 下的所有文件

此处的模式是 Unix 风格的 "glob" 模式: * 匹配任意的常规文件名字符序列，? 匹配任意单个常规文件名字符，而 [range] 匹配 range 范围内的任意字符 (例如 a-z, a-zA-Z, a-f0-9_.)。 “常规文件名字符”的定义取决于具体平台：在 Unix 上是指正斜杠以外的任何字符；在 Windows 则是指反斜杠或冒号以外的任何字符。

9. API参考引用

参见

New and changed setup.py arguments in setuptools [https://web.archive.org/web/20210614192516/https://setuptools.pypa.io/en/stable/userguide/keywords.html]

setuptools 项目为 setup 函数和其他 API 添加了新的功能，使得 API 在不同 Python 版本间保持一致，因此推荐以它来取代直接使用 distutils。

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

9.1. distutils.core --- 分发包功能的核心

The distutils.core 是为了使用 Distutils 工具唯一要安装的模块。它提供函数 setup() （该函数被 setup 脚本调用）。间接提供了类 distutils.dist.Distribution 和 distutils.cmd.Command.

distutils.core.setup(arguments)

基本的包办一切的函数，它完成了您可以从Distutils方法中请求的大部分事情。

setup函数接受大量参数。这些都列在下表中。

参数名称 | value | type
name | 包的名字 | 字符串
version | 包的版本号；参见 distutils.version | 字符串
description | 单行的包的描述 | 字符串
long_description | 更长的包描述 | 字符串
author | 包的作者 | 字符串
author_email | 包的作者的电子邮件 | 字符串
maintainer | 当前维护者的名字，如果与作者不同的话。 请注意，如果提供了维护者，distutils 将使用它作为 PKG-INFO 中的作者。 | 字符串
maintainer_email | 当前维护者的电子邮件地址（如果与作者不同） | 字符串
url | 包的URL（主页） | 字符串
download_url | 包的下载地址 | 字符串
packages | distutils将操作的Python软件包的列表 | 字符串列表
py_modules | distutils 会操作的 Python 模块列表 | 字符串列表
scripts | 要构建和安装的独立脚本文件的列表 | 字符串列表
ext_modules | 要构建的 Python 扩展的列表 | 类 distutils.core.Extension 的实例的列表
classifiers | 包的类别列表 | 一个字符串列表；可用的分类器已在 PyPI [https://pypi.org/classifiers] 上列出。
distclass | 要使用的类 Distribution 类 | distutils.core.Distribution 的子类
script_name | setup.py 脚本名称 —— 默认为 sys.argv[0] | 字符串
script_args | 提供给安装脚本的参数 | 字符串列表
options | 安装脚本的默认选项 | 字典
license | 包的许可证 | 字符串
keywords | 描述性的元数据，参见 PEP 314 [https://www.python.org/dev/peps/pep-0314] | 字符串列表或逗号分隔的字符串
platforms |  | 字符串列表或逗号分隔的字符串
cmdclass | 一个从命令名称到 Command 子类的映射 | 字典
data_files | 要安装的数据文件列表 | 列表
package_dir | 包到目录名的映射 | 字典

distutils.core.run_setup(script_name[, script_args=None, stop_after='run'])

在某种程度上受控制的环境中运行一个安装脚本，并返回驱动程序的 distutils.dist.Distribution 实例。 如果你需要查找分发元数据 (作为关键字 args 从 script 传递到 setup())，或者配置文件或命令行的内容，这将非常有用。

script_name 是一个将使用 exec() 读取和运行的文件。在调用期间，sys.argv[0] 将被替换为 script。 script_args 是一个字符串列表；如果提供了 sys.argv[1:]，则在调用期间将被 script_args 替换。

stop_after 告诉 setup() 何时停止处理；可能的值有：

value | description
init | Stop after the Distribution instance has been created and populated with the keyword arguments to setup()
config | Stop after config files have been parsed (and their data stored in the Distribution instance)
commandline | Stop after the command-line (sys.argv[1:] or script_args) have been parsed (and the data stored in the Distribution instance.)
run | Stop after all commands have been run (the same as if setup() had been called in the usual way). This is the default value.

In addition, the distutils.core module exposed a number of classes that live elsewhere.

来自 distutils.extension 的 Extension

来自 distutils.cmd 的 Command

Distribution from distutils.dist

A short description of each of these follows, but see the relevant module for the full reference.

class distutils.core.Extension

The Extension class describes a single C or C++ extension module in a setup script. It accepts the following keyword arguments in its constructor:

参数名称 | value | type
name | the full name of the extension, including any packages --- ie. not a filename or pathname, but Python dotted name | 字符串

sources

list of source filenames, relative to the distribution root (where the setup script lives), in Unix form (slash-separated) for portability. Source files may be C, C++, SWIG (.i), platform-specific resource files, or whatever else is recognized by the build_ext command as source for a Python extension.

字符串列表

include_dirs | list of directories to search for C/C++ header files (in Unix form for portability) | 字符串列表
define_macros | list of macros to define; each macro is defined using a 2-tuple (name, value), where value is either the string to define it to or None to define it without a particular value (equivalent of #define FOO in source or -DFOO on Unix C compiler command line) | 元组列表
undef_macros | 要明确取消定义的宏列表 | 字符串列表
library_dirs | list of directories to search for C/C++ libraries at link time | 字符串列表
libraries | 要链接的库名列表（不是文件名或路径） | 字符串列表
runtime_library_dirs | list of directories to search for C/C++ libraries at run time (for shared extensions, this is when the extension is loaded) | 字符串列表
extra_objects | list of extra files to link with (eg. object files not implied by 'sources', static library that must be explicitly specified, binary resource files, etc.) | 字符串列表
extra_compile_args | any extra platform- and compiler-specific information to use when compiling the source files in 'sources'. For platforms and compilers where a command line makes sense, this is typically a list of command-line arguments, but for other platforms it could be anything. | 字符串列表
extra_link_args | any extra platform- and compiler-specific information to use when linking object files together to create the extension (or to create a new static Python interpreter). Similar interpretation as for 'extra_compile_args'. | 字符串列表
export_symbols | list of symbols to be exported from a shared extension. Not used on all platforms, and not generally necessary for Python extensions, which typically export exactly one symbol: init + extension_name. | 字符串列表
depends | 扩展名依赖的文件列表 | 字符串列表
language | extension language (i.e. 'c', 'c++', 'objc'). Will be detected from the source extensions if not provided. | 字符串
optional | 指定扩展中的构建失败不应中止构建过程，而只是跳过扩展。 | 布尔

在 3.8 版更改: On Unix, C extensions are no longer linked to libpython except on Android and Cygwin.

class distutils.core.Distribution

A Distribution describes how to build, install and package up a Python software package.

See the setup() function for a list of keyword arguments accepted by the Distribution constructor. setup() creates a Distribution instance.

在 3.7 版更改: Distribution now warns if classifiers, keywords and platforms fields are not specified as a list or a string.

class distutils.core.Command

A Command class (or rather, an instance of one of its subclasses) implement a single distutils command.

9.2. distutils.ccompiler --- CCompiler基类

This module provides the abstract base class for the CCompiler classes. A CCompiler instance can be used for all the compile and link steps needed to build a single project. Methods are provided to set options for the compiler --- macro definitions, include directories, link path, libraries and the like.

This module provides the following functions.

distutils.ccompiler.gen_lib_options(compiler, library_dirs, runtime_library_dirs, libraries)

Generate linker options for searching library directories and linking with specific libraries. libraries and library_dirs are, respectively, lists of library names (not filenames!) and search directories. Returns a list of command-line options suitable for use with some compiler (depending on the two format strings passed in).

distutils.ccompiler.gen_preprocess_options(macros, include_dirs)

Generate C pre-processor options (-D, -U, -I) as used by at least two types of compilers: the typical Unix compiler and Visual C++. macros is the usual thing, a list of 1- or 2-tuples, where (name,) means undefine (-U) macro name, and (name, value) means define (-D) macro name to value. include_dirs is just a list of directory names to be added to the header file search path (-I). Returns a list of command-line options suitable for either Unix compilers or Visual C++.

distutils.ccompiler.get_default_compiler(osname, platform)

Determine the default compiler to use for the given platform.

osname should be one of the standard Python OS names (i.e. the ones returned by os.name) and platform the common value returned by sys.platform for the platform in question.

The default values are os.name and sys.platform in case the parameters are not given.

distutils.ccompiler.new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0)

Factory function to generate an instance of some CCompiler subclass for the supplied platform/compiler combination. plat defaults to os.name (eg. 'posix', 'nt'), and compiler defaults to the default compiler for that platform. Currently only 'posix' and 'nt' are supported, and the default compilers are "traditional Unix interface" (UnixCCompiler class) and Visual C++ (MSVCCompiler class). Note that it's perfectly possible to ask for a Unix compiler object under Windows, and a Microsoft compiler object under Unix---if you supply a value for compiler, plat is ignored.

distutils.ccompiler.show_compilers()

Print list of available compilers (used by the --help-compiler options to build, build_ext, build_clib).

class distutils.ccompiler.CCompiler([verbose=0, dry_run=0, force=0])

The abstract base class CCompiler defines the interface that must be implemented by real compiler classes. The class also has some utility methods used by several compiler classes.

The basic idea behind a compiler abstraction class is that each instance can be used for all the compile/link steps in building a single project. Thus, attributes common to all of those compile and link steps --- include directories, macros to define, libraries to link against, etc. --- are attributes of the compiler instance. To allow for variability in how individual files are treated, most of those attributes may be varied on a per-compilation or per-link basis.

The constructor for each subclass creates an instance of the Compiler object. Flags are verbose (show verbose output), dry_run (don't actually execute the steps) and force (rebuild everything, regardless of dependencies). All of these flags default to 0 (off). Note that you probably don't want to instantiate CCompiler or one of its subclasses directly - use the distutils.CCompiler.new_compiler() factory function instead.

The following methods allow you to manually alter compiler options for the instance of the Compiler class.

add_include_dir(dir)

Add dir to the list of directories that will be searched for header files. The compiler is instructed to search directories in the order in which they are supplied by successive calls to add_include_dir().

set_include_dirs(dirs)

Set the list of directories that will be searched to dirs (a list of strings). Overrides any preceding calls to add_include_dir(); subsequent calls to add_include_dir() add to the list passed to set_include_dirs(). This does not affect any list of standard include directories that the compiler may search by default.

add_library(libname)

Add libname to the list of libraries that will be included in all links driven by this compiler object. Note that libname should *not* be the name of a file containing a library, but the name of the library itself: the actual filename will be inferred by the linker, the compiler, or the compiler class (depending on the platform).

The linker will be instructed to link against libraries in the order they were supplied to add_library() and/or set_libraries(). It is perfectly valid to duplicate library names; the linker will be instructed to link against libraries as many times as they are mentioned.

set_libraries(libnames)

Set the list of libraries to be included in all links driven by this compiler object to libnames (a list of strings). This does not affect any standard system libraries that the linker may include by default.

add_library_dir(dir)

Add dir to the list of directories that will be searched for libraries specified to add_library() and set_libraries(). The linker will be instructed to search for libraries in the order they are supplied to add_library_dir() and/or set_library_dirs().

set_library_dirs(dirs)

Set the list of library search directories to dirs (a list of strings). This does not affect any standard library search path that the linker may search by default.

add_runtime_library_dir(dir)

Add dir to the list of directories that will be searched for shared libraries at runtime.

set_runtime_library_dirs(dirs)

Set the list of directories to search for shared libraries at runtime to dirs (a list of strings). This does not affect any standard search path that the runtime linker may search by default.

define_macro(name[, value=None])

Define a preprocessor macro for all compilations driven by this compiler object. The optional parameter value should be a string; if it is not supplied, then the macro will be defined without an explicit value and the exact outcome depends on the compiler used.

undefine_macro(name)

Undefine a preprocessor macro for all compilations driven by this compiler object. If the same macro is defined by define_macro() and undefined by undefine_macro() the last call takes precedence (including multiple redefinitions or undefinitions). If the macro is redefined/undefined on a per-compilation basis (ie. in the call to compile()), then that takes precedence.

add_link_object(object)

Add object to the list of object files (or analogues, such as explicitly named library files or the output of "resource compilers") to be included in every link driven by this compiler object.

set_link_objects(objects)

Set the list of object files (or analogues) to be included in every link to objects. This does not affect any standard object files that the linker may include by default (such as system libraries).

The following methods implement methods for autodetection of compiler options, providing some functionality similar to GNU autoconf.

detect_language(sources)

Detect the language of a given file, or list of files. Uses the instance attributes language_map (a dictionary), and language_order (a list) to do the job.

find_library_file(dirs, lib[, debug=0])

Search the specified list of directories for a static or shared library file lib and return the full path to that file. If debug is true, look for a debugging version (if that makes sense on the current platform). Return None if lib wasn't found in any of the specified directories.

has_function(funcname[, includes=None, include_dirs=None, libraries=None, library_dirs=None])

Return a boolean indicating whether funcname is supported on the current platform. The optional arguments can be used to augment the compilation environment by providing additional include files and paths and libraries and paths.

library_dir_option(dir)

Return the compiler option to add dir to the list of directories searched for libraries.

library_option(lib)

Return the compiler option to add lib to the list of libraries linked into the shared library or executable.

runtime_library_dir_option(dir)

Return the compiler option to add dir to the list of directories searched for runtime libraries.

set_executables(**args)

Define the executables (and options for them) that will be run to perform the various stages of compilation. The exact set of executables that may be specified here depends on the compiler class (via the 'executables' class attribute), but most will have:

attribute -- 属性 | description
compiler | C/C++ 编译器
linker_so | 用于创建共享对象和库的链接器
linker_exe | 用于创建二进制可执行文件的链接器
archiver | 静态库创建者

On platforms with a command-line (Unix, DOS/Windows), each of these is a string that will be split into executable name and (optional) list of arguments. (Splitting the string is done similarly to how Unix shells operate: words are delimited by spaces, but quotes and backslashes can override this. See distutils.util.split_quoted().)

The following methods invoke stages in the build process.

compile(sources[, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None])

Compile one or more source files. Generates object files (e.g. transforms a .c file to a .o file.)

sources must be a list of filenames, most likely C/C++ files, but in reality anything that can be handled by a particular compiler and compiler class (eg. MSVCCompiler can handle resource files in sources). Return a list of object filenames, one per source filename in sources. Depending on the implementation, not all source files will necessarily be compiled, but all corresponding object filenames will be returned.

If output_dir is given, object files will be put under it, while retaining their original path component. That is, foo/bar.c normally compiles to foo/bar.o (for a Unix implementation); if output_dir is build, then it would compile to build/foo/bar.o.

macros, if given, must be a list of macro definitions. A macro definition is either a (name, value) 2-tuple or a (name,) 1-tuple. The former defines a macro; if the value is None, the macro is defined without an explicit value. The 1-tuple case undefines a macro. Later definitions/redefinitions/undefinitions take precedence.

include_dirs, if given, must be a list of strings, the directories to add to the default include file search path for this compilation only.

debug is a boolean; if true, the compiler will be instructed to output debug symbols in (or alongside) the object file(s).

extra_preargs and extra_postargs are implementation-dependent. On platforms that have the notion of a command-line (e.g. Unix, DOS/Windows), they are most likely lists of strings: extra command-line arguments to prepend/append to the compiler command line. On other platforms, consult the implementation class documentation. In any event, they are intended as an escape hatch for those occasions when the abstract compiler framework doesn't cut the mustard.

depends, if given, is a list of filenames that all targets depend on. If a source file is older than any file in depends, then the source file will be recompiled. This supports dependency tracking, but only at a coarse granularity.

Raises CompileError on failure.

create_static_lib(objects, output_libname[, output_dir=None, debug=0, target_lang=None])

Link a bunch of stuff together to create a static library file. The "bunch of stuff" consists of the list of object files supplied as objects, the extra object files supplied to add_link_object() and/or set_link_objects(), the libraries supplied to add_library() and/or set_libraries(), and the libraries supplied as libraries (if any).

output_libname should be a library name, not a filename; the filename will be inferred from the library name. output_dir is the directory where the library file will be put.

debug is a boolean; if true, debugging information will be included in the library (note that on most platforms, it is the compile step where this matters: the debug flag is included here just for consistency).

target_lang is the target language for which the given objects are being compiled. This allows specific linkage time treatment of certain languages.

Raises LibError on failure.

link(target_desc, objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])

Link a bunch of stuff together to create an executable or shared library file.

The "bunch of stuff" consists of the list of object files supplied as objects. output_filename should be a filename. If output_dir is supplied, output_filename is relative to it (i.e. output_filename can provide directory components if needed).

libraries is a list of libraries to link against. These are library names, not filenames, since they're translated into filenames in a platform-specific way (eg. foo becomes libfoo.a on Unix and foo.lib on DOS/Windows). However, they can include a directory component, which means the linker will look in that specific directory rather than searching all the normal locations.

library_dirs, if supplied, should be a list of directories to search for libraries that were specified as bare library names (ie. no directory component). These are on top of the system default and those supplied to add_library_dir() and/or set_library_dirs(). runtime_library_dirs is a list of directories that will be embedded into the shared library and used to search for other shared libraries that *it* depends on at run-time. (This may only be relevant on Unix.)

export_symbols is a list of symbols that the shared library will export. (This appears to be relevant only on Windows.)

debug is as for compile() and create_static_lib(), with the slight distinction that it actually matters on most platforms (as opposed to create_static_lib(), which includes a debug flag mostly for form's sake).

extra_preargs and extra_postargs are as for compile() (except of course that they supply command-line arguments for the particular linker being used).

target_lang is the target language for which the given objects are being compiled. This allows specific linkage time treatment of certain languages.

Raises LinkError on failure.

link_executable(objects, output_progname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, target_lang=None])

Link an executable. output_progname is the name of the file executable, while objects are a list of object filenames to link in. Other arguments are as for the link() method.

link_shared_lib(objects, output_libname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])

Link a shared library. output_libname is the name of the output library, while objects is a list of object filenames to link in. Other arguments are as for the link() method.

link_shared_object(objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])

Link a shared object. output_filename is the name of the shared object that will be created, while objects is a list of object filenames to link in. Other arguments are as for the link() method.

preprocess(source[, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None])

Preprocess a single C/C++ source file, named in source. Output will be written to file named output_file, or stdout if output_file not supplied. macros is a list of macro definitions as for compile(), which will augment the macros set with define_macro() and undefine_macro(). include_dirs is a list of directory names that will be added to the default list, in the same way as add_include_dir().

Raises PreprocessError on failure.

The following utility methods are defined by the CCompiler class, for use by the various concrete subclasses.

executable_filename(basename[, strip_dir=0, output_dir=''])

Returns the filename of the executable for the given basename. Typically for non-Windows platforms this is the same as the basename, while Windows will get a .exe added.

library_filename(libname[, lib_type='static', strip_dir=0, output_dir=''])

Returns the filename for the given library name on the current platform. On Unix a library with lib_type of 'static' will typically be of the form liblibname.a, while a lib_type of 'dynamic' will be of the form liblibname.so.

object_filenames(source_filenames[, strip_dir=0, output_dir=''])

Returns the name of the object files for the given source files. source_filenames should be a list of filenames.

shared_object_filename(basename[, strip_dir=0, output_dir=''])

Returns the name of a shared object file for the given file name basename.

execute(func, args[, msg=None, level=1])

Invokes distutils.util.execute(). This method invokes a Python function func with the given arguments args, after logging and taking into account the dry_run flag.

spawn(cmd)

Invokes distutils.util.spawn(). This invokes an external process to run the given command.

mkpath(name[, mode=511])

Invokes distutils.dir_util.mkpath(). This creates a directory and any missing ancestor directories.

move_file(src, dst)

Invokes distutils.file_util.move_file(). Renames src to dst.

announce(msg[, level=1])

Write a message using distutils.log.debug().

warn(msg)

Write a warning message msg to standard error.

debug_print(msg)

If the debug flag is set on this CCompiler instance, print msg to standard output, otherwise do nothing.

9.3. distutils.unixccompiler --- Unix C Compiler

This module provides the UnixCCompiler class, a subclass of CCompiler that handles the typical Unix-style command-line C compiler:

通过 -Dname[=value] 定义的宏

通过 -Uname 取消定义的宏

包括通过 -Idir 指定的搜索目录

通过 -llib 指定的库

通过 -Ldir 指定的库搜索目录

compile handled by cc (or similar) executable with -c option: compiles .c to .o

link static library handled by ar command (possibly with ranlib)

link shared library handled by cc -shared

9.4. distutils.msvccompiler --- Microsoft Compiler

This module provides MSVCCompiler, an implementation of the abstract CCompiler class for Microsoft Visual Studio. Typically, extension modules need to be compiled with the same compiler that was used to compile Python. For Python 2.3 and earlier, the compiler was Visual Studio 6. For Python 2.4 and 2.5, the compiler is Visual Studio .NET 2003.

MSVCCompiler will normally choose the right compiler, linker etc. on its own. To override this choice, the environment variables DISTUTILS_USE_SDK and MSSdk must be both set. MSSdk indicates that the current environment has been setup by the SDK's SetEnv.Cmd script, or that the environment variables had been registered when the SDK was installed; DISTUTILS_USE_SDK indicates that the distutils user has made an explicit choice to override the compiler selection by MSVCCompiler.

9.5. distutils.bcppcompiler --- Borland Compiler

This module provides BorlandCCompiler, a subclass of the abstract CCompiler class for the Borland C++ compiler.

9.6. distutils.cygwincompiler --- Cygwin Compiler

This module provides the CygwinCCompiler class, a subclass of UnixCCompiler that handles the Cygwin port of the GNU C compiler to Windows. It also contains the Mingw32CCompiler class which handles the mingw32 port of GCC (same as cygwin in no-cygwin mode).

9.7. distutils.archive_util --- Archiving utilities

This module provides a few functions for creating archive files, such as tarballs or zipfiles.

distutils.archive_util.make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=0, dry_run=0])

Create an archive file (eg. zip or tar). base_name is the name of the file to create, minus any format-specific extension; format is the archive format: one of zip, tar, gztar, bztar, xztar, or ztar. root_dir is a directory that will be the root directory of the archive; ie. we typically chdir into root_dir before creating the archive. base_dir is the directory where we start archiving from; ie. base_dir will be the common prefix of all files and directories in the archive. root_dir and base_dir both default to the current directory. Returns the name of the archive file.

在 3.5 版更改: 添加了对 xztar 格式的支持

distutils.archive_util.make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])

'Create an (optional compressed) archive as a tar file from all files in and under base_dir. compress must be 'gzip' (the default), 'bzip2', 'xz', 'compress', or None. For the 'compress' method the compression utility named by compress must be on the default program search path, so this is probably Unix-specific. The output tar file will be named base_dir.tar, possibly plus the appropriate compression extension (.gz, .bz2, .xz or .Z). Return the output filename.

在 3.5 版更改: Added support for the xz compression.

distutils.archive_util.make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])

Create a zip file from all files in and under base_dir. The output zip file will be named base_name + .zip. Uses either the zipfile Python module (if available) or the InfoZIP zip utility (if installed and found on the default search path). If neither tool is available, raises DistutilsExecError. Returns the name of the output zip file.

9.8. distutils.dep_util --- Dependency checking

This module provides functions for performing simple, timestamp-based dependency of files and groups of files; also, functions based entirely on such timestamp dependency analysis.

distutils.dep_util.newer(source, target)

Return true if source exists and is more recently modified than target, or if source exists and target doesn't. Return false if both exist and target is the same age or newer than source. Raise DistutilsFileError if source does not exist.

distutils.dep_util.newer_pairwise(sources, targets)

Walk two filename lists in parallel, testing if each source is newer than its corresponding target. Return a pair of lists (sources, targets) where source is newer than target, according to the semantics of newer().

distutils.dep_util.newer_group(sources, target[, missing='error'])

如果 target 相对于 sources 中的任何文件已经过期，那么返回 true。换句话说，如果 target 存在且比 sources 中的每个文件都更新，那么返回 false；否则，返回 true。missing 参数控制当源文件缺失时的处理方式：默认值（'error'）会抛出 os.stat() 产生的 OSError；如果设为 'ignore'，那么静默忽略缺失的源文件；如果设为 'newer'，那么任何缺失的源文件都会导致假定 target 已经过期（这在“空运行”模式下很实用：即使由于输入文件缺失导致命令不能实际执行，该模式也会让你模拟执行这些命令，反正你也不会真正运行它们）。

9.9. distutils.dir_util --- Directory tree operations

This module provides functions for operating on directories and trees of directories.

distutils.dir_util.mkpath(name[, mode=0o777, verbose=0, dry_run=0])

Create a directory and any missing ancestor directories. If the directory already exists (or if name is the empty string, which means the current directory, which of course exists), then do nothing. Raise DistutilsFileError if unable to create some directory along the way (eg. some sub-path exists, but is a file rather than a directory). If verbose is true, print a one-line summary of each mkdir to stdout. Return the list of directories actually created.

distutils.dir_util.create_tree(base_dir, files[, mode=0o777, verbose=0, dry_run=0])

Create all the empty directories under base_dir needed to put files there. base_dir is just the name of a directory which doesn't necessarily exist yet; files is a list of filenames to be interpreted relative to base_dir. base_dir + the directory portion of every file in files will be created if it doesn't already exist. mode, verbose and dry_run flags are as for mkpath().

distutils.dir_util.copy_tree(src, dst[, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0])

Copy an entire directory tree src to a new location dst. Both src and dst must be directory names. If src is not a directory, raise DistutilsFileError. If dst does not exist, it is created with mkpath(). The end result of the copy is that every file in src is copied to dst, and directories under src are recursively copied to dst. Return the list of files that were copied or might have been copied, using their output name. The return value is unaffected by update or dry_run: it is simply the list of all files under src, with the names changed to be under dst.

preserve_mode and preserve_times are the same as for distutils.file_util.copy_file(); note that they only apply to regular files, not to directories. If preserve_symlinks is true, symlinks will be copied as symlinks (on platforms that support them!); otherwise (the default), the destination of the symlink will be copied. update and verbose are the same as for copy_file().

Files in src that begin with .nfs are skipped (more information on these files is available in answer D2 of the NFS FAQ page [http://nfs.sourceforge.net/#section_d]).

在 3.3.1 版更改: NFS files are ignored.

distutils.dir_util.remove_tree(directory[, verbose=0, dry_run=0])

Recursively remove directory and all files and directories underneath it. Any errors are ignored (apart from being reported to sys.stdout if verbose is true).

9.10. distutils.file_util --- Single file operations

This module contains some utility functions for operating on individual files.

distutils.file_util.copy_file(src, dst[, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0])

Copy file src to dst. If dst is a directory, then src is copied there with the same name; otherwise, it must be a filename. (If the file exists, it will be ruthlessly clobbered.) If preserve_mode is true (the default), the file's mode (type and permission bits, or whatever is analogous on the current platform) is copied. If preserve_times is true (the default), the last-modified and last-access times are copied as well. If update is true, src will only be copied if dst does not exist, or if dst does exist but is older than src.

link allows you to make hard links (using os.link()) or symbolic links (using os.symlink()) instead of copying: set it to 'hard' or 'sym'; if it is None (the default), files are copied. Don't set link on systems that don't support it: copy_file() doesn't check if hard or symbolic linking is available. It uses _copy_file_contents() to copy file contents.

Return a tuple (dest_name, copied): dest_name is the actual name of the output file, and copied is true if the file was copied (or would have been copied, if dry_run true).

distutils.file_util.move_file(src, dst[, verbose, dry_run])

Move file src to dst. If dst is a directory, the file will be moved into it with the same name; otherwise, src is just renamed to dst. Returns the new full name of the file.

警告

Handles cross-device moves on Unix using copy_file(). What about other systems?

distutils.file_util.write_file(filename, contents)

Create a file called filename and write contents (a sequence of strings without line terminators) to it.

9.11. distutils.util --- Miscellaneous other utility functions

This module contains other assorted bits and pieces that don't fit into any other utility module.

distutils.util.get_platform()

Return a string that identifies the current platform. This is used mainly to distinguish platform-specific build directories and platform-specific built distributions. Typically includes the OS name and version and the architecture (as supplied by 'os.uname()'), although the exact information included depends on the OS; e.g., on Linux, the kernel version isn't particularly important.

返回值的示例：

linux-i586

linux-alpha

solaris-2.6-sun4u

For non-POSIX platforms, currently just returns sys.platform.

For macOS systems the OS version reflects the minimal version on which binaries will run (that is, the value of MACOSX_DEPLOYMENT_TARGET during the build of Python), not the OS version of the current system.

For universal binary builds on macOS the architecture value reflects the universal binary status instead of the architecture of the current processor. For 32-bit universal binaries the architecture is fat, for 64-bit universal binaries the architecture is fat64, and for 4-way universal binaries the architecture is universal. Starting from Python 2.7 and Python 3.2 the architecture fat3 is used for a 3-way universal build (ppc, i386, x86_64) and intel is used for a universal build with the i386 and x86_64 architectures

macOS 上的返回值示例:

macosx-10.3-ppc

macosx-10.3-fat

macosx-10.5-universal

macosx-10.6-intel

For AIX, Python 3.9 and later return a string starting with "aix", followed by additional fields (separated by '-') that represent the combined values of AIX Version, Release and Technology Level (first field), Build Date (second field), and bit-size (third field). Python 3.8 and earlier returned only a single additional field with the AIX Version and Release.

Examples of returned values on AIX:

aix-5307-0747-32 # 32-bit build on AIX oslevel -s: 5300-07-00-0000

aix-7105-1731-64 # 64-bit build on AIX oslevel -s: 7100-05-01-1731

aix-7.2 # Legacy form reported in Python 3.8 and earlier

在 3.9 版更改: The AIX platform string format now also includes the technology level, build date, and ABI bit-size.

distutils.util.convert_path(pathname)

Return 'pathname' as a name that will work on the native filesystem, i.e. split it on '/' and put it back together again using the current directory separator. Needed because filenames in the setup script are always supplied in Unix style, and have to be converted to the local convention before we can actually use them in the filesystem. Raises ValueError on non-Unix-ish systems if pathname either starts or ends with a slash.

distutils.util.change_root(new_root, pathname)

Return pathname with new_root prepended. If pathname is relative, this is equivalent to os.path.join(new_root,pathname) Otherwise, it requires making pathname relative and then joining the two, which is tricky on DOS/Windows.

distutils.util.check_environ()

Ensure that 'os.environ' has all the environment variables we guarantee that users can use in config files, command-line options, etc. Currently this includes:

HOME - user's home directory (Unix only)

PLAT - description of the current platform, including hardware and OS (see get_platform())

distutils.util.subst_vars(s, local_vars)

Perform shell/Perl-style variable substitution on s. Every occurrence of $ followed by a name is considered a variable, and variable is substituted by the value found in the local_vars dictionary, or in os.environ if it's not in local_vars. os.environ is first checked/augmented to guarantee that it contains certain values: see check_environ(). Raise ValueError for any variables not found in either local_vars or os.environ.

Note that this is not a full-fledged string interpolation function. A valid $variable can consist only of upper and lower case letters, numbers and an underscore. No { } or ( ) style quoting is available.

distutils.util.split_quoted(s)

Split a string up according to Unix shell-like rules for quotes and backslashes. In short: words are delimited by spaces, as long as those spaces are not escaped by a backslash, or inside a quoted string. Single and double quotes are equivalent, and the quote characters can be backslash-escaped. The backslash is stripped from any two-character escape sequence, leaving only the escaped character. The quote characters are stripped from any quoted string. Returns a list of words.

distutils.util.execute(func, args[, msg=None, verbose=0, dry_run=0])

Perform some action that affects the outside world (for instance, writing to the filesystem). Such actions are special because they are disabled by the dry_run flag. This method takes care of all that bureaucracy for you; all you have to do is supply the function to call and an argument tuple for it (to embody the "external action" being performed), and an optional message to print.

distutils.util.strtobool(val)

Convert a string representation of truth to true (1) or false (0).

True values are y, yes, t, true, on and 1; false values are n, no, f, false, off and 0. Raises ValueError if val is anything else.

distutils.util.byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None])

Byte-compile a collection of Python source files to .pyc files in a __pycache__ subdirectory (see PEP 3147 [https://www.python.org/dev/peps/pep-3147] and PEP 488 [https://www.python.org/dev/peps/pep-0488]). py_files is a list of files to compile; any files that don't end in .py are silently skipped. optimize must be one of the following:

0 - don't optimize

1 - normal optimization (like python -O)

2 - extra optimization (like python -OO)

If force is true, all files are recompiled regardless of timestamps.

The source filename encoded in each bytecode file defaults to the filenames listed in py_files; you can modify these with prefix and basedir. prefix is a string that will be stripped off of each source filename, and base_dir is a directory name that will be prepended (after prefix is stripped). You can supply either or both (or neither) of prefix and base_dir, as you wish.

If dry_run is true, doesn't actually do anything that would affect the filesystem.

Byte-compilation is either done directly in this interpreter process with the standard py_compile module, or indirectly by writing a temporary script and executing it. Normally, you should let byte_compile() figure out to use direct compilation or not (see the source for details). The direct flag is used by the script generated in indirect mode; unless you know what you're doing, leave it set to None.

在 3.2.3 版更改: Create .pyc files with an import magic tag in their name, in a __pycache__ subdirectory instead of files without tag in the current directory.

在 3.5 版更改: Create .pyc files according to PEP 488 [https://www.python.org/dev/peps/pep-0488].

distutils.util.rfc822_escape(header)

Return a version of header escaped for inclusion in an RFC 822 [https://datatracker.ietf.org/doc/html/rfc822.html] header, by ensuring there are 8 spaces space after each newline. Note that it does no other modification of the string.

9.12. distutils.dist --- The Distribution class

This module provides the Distribution class, which represents the module distribution being built/installed/distributed.

9.13. distutils.extension --- The Extension class

This module provides the Extension class, used to describe C/C++ extension modules in setup scripts.

9.14. distutils.debug --- Distutils debug mode

本模块提供DEBUG标识。

9.15. distutils.errors --- Distutils exceptions

Provides exceptions used by the Distutils modules. Note that Distutils modules may raise standard exceptions; in particular, SystemExit is usually raised for errors that are obviously the end-user's fault (eg. bad command-line arguments).

This module is safe to use in from ... import * mode; it only exports symbols whose names start with Distutils and end with Error.

9.16. distutils.fancy_getopt --- Wrapper around the standard getopt module

This module provides a wrapper around the standard getopt module that provides the following additional features:

short and long options are tied together

options have help strings, so fancy_getopt() could potentially create a complete usage summary

options set attributes of a passed-in object

boolean options can have "negative aliases" --- eg. if --quiet is the "negative alias" of --verbose, then --quiet on the command line sets verbose to false.

distutils.fancy_getopt.fancy_getopt(options, negative_opt, object, args)

Wrapper function. options is a list of (long_option, short_option, help_string) 3-tuples as described in the constructor for FancyGetopt. negative_opt should be a dictionary mapping option names to option names, both the key and value should be in the options list. object is an object which will be used to store values (see the getopt() method of the FancyGetopt class). args is the argument list. Will use sys.argv[1:] if you pass None as args.

distutils.fancy_getopt.wrap_text(text, width)

Wraps text to less than width wide.

class distutils.fancy_getopt.FancyGetopt([option_table=None])

The option_table is a list of 3-tuples: (long_option, short_option, help_string)

If an option takes an argument, its long_option should have '=' appended; short_option should just be a single character, no ':' in any case. short_option should be None if a long_option doesn't have a corresponding short_option. All option tuples must have long options.

The FancyGetopt class provides the following methods:

FancyGetopt.getopt([args=None, object=None])

Parse command-line options in args. Store as attributes on object.

If args is None or not supplied, uses sys.argv[1:]. If object is None or not supplied, creates a new OptionDummy instance, stores option values there, and returns a tuple (args, object). If object is supplied, it is modified in place and getopt() just returns args; in both cases, the returned args is a modified copy of the passed-in args list, which is left untouched.

FancyGetopt.get_option_order()

Returns the list of (option, value) tuples processed by the previous run of getopt() Raises RuntimeError if getopt() hasn't been called yet.

FancyGetopt.generate_help([header=None])

Generate help text (a list of strings, one per suggested line of output) from the option table for this FancyGetopt object.

If supplied, prints the supplied header at the top of the help.

9.17. distutils.filelist --- The FileList class

This module provides the FileList class, used for poking about the filesystem and building lists of files.

9.18. distutils.log --- Simple PEP 282 [https://www.python.org/dev/peps/pep-0282]-style logging

9.19. distutils.spawn --- Spawn a sub-process

This module provides the spawn() function, a front-end to various platform-specific functions for launching another program in a sub-process. Also provides find_executable() to search the path for a given executable name.

9.20. distutils.sysconfig --- System configuration information

3.10 版后已移除: distutils.sysconfig has been merged into sysconfig.

The distutils.sysconfig module provides access to Python's low-level configuration information. The specific configuration variables available depend heavily on the platform and configuration. The specific variables depend on the build process for the specific version of Python being run; the variables are those found in the Makefile and configuration header that are installed with Python on Unix systems. The configuration header is called pyconfig.h for Python versions starting with 2.2, and config.h for earlier versions of Python.

Some additional functions are provided which perform some useful manipulations for other parts of the distutils package.

distutils.sysconfig.PREFIX

The result of os.path.normpath(sys.prefix).

distutils.sysconfig.EXEC_PREFIX

The result of os.path.normpath(sys.exec_prefix).

distutils.sysconfig.get_config_var(name)

Return the value of a single variable. This is equivalent to get_config_vars().get(name).

distutils.sysconfig.get_config_vars(...)

Return a set of variable definitions. If there are no arguments, this returns a dictionary mapping names of configuration variables to values. If arguments are provided, they should be strings, and the return value will be a sequence giving the associated values. If a given name does not have a corresponding value, None will be included for that variable.

distutils.sysconfig.get_config_h_filename()

Return the full path name of the configuration header. For Unix, this will be the header generated by the configure script; for other platforms the header will have been supplied directly by the Python source distribution. The file is a platform-specific text file.

distutils.sysconfig.get_makefile_filename()

Return the full path name of the Makefile used to build Python. For Unix, this will be a file generated by the configure script; the meaning for other platforms will vary. The file is a platform-specific text file, if it exists. This function is only useful on POSIX platforms.

The following functions are deprecated together with this module and they have no direct replacement.

distutils.sysconfig.get_python_inc([plat_specific[, prefix]])

Return the directory for either the general or platform-dependent C include files. If plat_specific is true, the platform-dependent include directory is returned; if false or omitted, the platform-independent directory is returned. If prefix is given, it is used as either the prefix instead of PREFIX, or as the exec-prefix instead of EXEC_PREFIX if plat_specific is true.

distutils.sysconfig.get_python_lib([plat_specific[, standard_lib[, prefix]]])

Return the directory for either the general or platform-dependent library installation. If plat_specific is true, the platform-dependent include directory is returned; if false or omitted, the platform-independent directory is returned. If prefix is given, it is used as either the prefix instead of PREFIX, or as the exec-prefix instead of EXEC_PREFIX if plat_specific is true. If standard_lib is true, the directory for the standard library is returned rather than the directory for the installation of third-party extensions.

The following function is only intended for use within the distutils package.

distutils.sysconfig.customize_compiler(compiler)

Do any platform-specific customization of a distutils.ccompiler.CCompiler instance.

This function is only needed on Unix at this time, but should be called consistently to support forward-compatibility. It inserts the information that varies across Unix flavors and is stored in Python's Makefile. This information includes the selected compiler, compiler and linker options, and the extension used by the linker for shared objects.

This function is even more special-purpose, and should only be used from Python's own build procedures.

distutils.sysconfig.set_python_build()

Inform the distutils.sysconfig module that it is being used as part of the build process for Python. This changes a lot of relative locations for files, allowing them to be located in the build area rather than in an installed Python.

9.21. distutils.text_file --- The TextFile class

This module provides the TextFile class, which gives an interface to text files that (optionally) takes care of stripping comments, ignoring blank lines, and joining lines with backslashes.

class distutils.text_file.TextFile([filename=None, file=None, **options])

This class provides a file-like object that takes care of all the things you commonly want to do when processing a text file that has some line-by-line syntax: strip comments (as long as # is your comment character), skip blank lines, join adjacent lines by escaping the newline (ie. backslash at end of line), strip leading and/or trailing whitespace. All of these are optional and independently controllable.

The class provides a warn() method so you can generate warning messages that report physical line number, even if the logical line in question spans multiple physical lines. Also provides unreadline() for implementing line-at-a-time lookahead.

TextFile instances are create with either filename, file, or both. RuntimeError is raised if both are None. filename should be a string, and file a file object (or something that provides readline() and close() methods). It is recommended that you supply at least filename, so that TextFile can include it in warning messages. If file is not supplied, TextFile creates its own using the open() built-in function.

The options are all boolean, and affect the values returned by readline()

选项名称 | description | 默认值
strip_comments | strip from '#' to end-of-line, as well as any whitespace leading up to the '#'---unless it is escaped by a backslash | true
lstrip_ws | strip leading whitespace from each line before returning it | false
rstrip_ws | strip trailing whitespace (including line terminator!) from each line before returning it. | true
skip_blanks | skip lines that are empty *after* stripping comments and whitespace. (If both lstrip_ws and rstrip_ws are false, then some lines may consist of solely whitespace: these will *not* be skipped, even if skip_blanks is true.) | true
join_lines | if a backslash is the last non-newline character on a line after stripping comments and whitespace, join the following line to it to form one logical line; if N consecutive lines end with a backslash, then N+1 physical lines will be joined to form one logical line. | false
collapse_join | strip leading whitespace from lines that are joined to their predecessor; only matters if (join_lines and not lstrip_ws) | false

Note that since rstrip_ws can strip the trailing newline, the semantics of readline() must differ from those of the built-in file object's readline() method! In particular, readline() returns None for end-of-file: an empty string might just be a blank line (or an all-whitespace line), if rstrip_ws is true but skip_blanks is not.

open(filename)

Open a new file filename. This overrides any file or filename constructor arguments.

close()

Close the current file and forget everything we know about it (including the filename and the current line number).

warn(msg[, line=None])

Print (to stderr) a warning message tied to the current logical line in the current file. If the current logical line in the file spans multiple physical lines, the warning refers to the whole range, such as "lines 3-5". If line is supplied, it overrides the current line number; it may be a list or tuple to indicate a range of physical lines, or an integer for a single physical line.

readline()

Read and return a single logical line from the current file (or from an internal buffer if lines have previously been "unread" with unreadline()). If the join_lines option is true, this may involve reading multiple physical lines concatenated into a single string. Updates the current line number, so calling warn() after readline() emits a warning about the physical line(s) just read. Returns None on end-of-file, since the empty string can occur if rstrip_ws is true but strip_blanks is not.

readlines()

Read and return the list of all logical lines remaining in the current file. This updates the current line number to the last line of the file.

unreadline(line)

Push line (a string) onto an internal buffer that will be checked by future readline() calls. Handy for implementing a parser with line-at-a-time lookahead. Note that lines that are "unread" with unreadline() are not subsequently re-cleansed (whitespace stripped, or whatever) when read with readline(). If multiple calls are made to unreadline() before a call to readline(), the lines will be returned most in most recent first order.

9.22. distutils.version --- Version number classes

9.23. distutils.cmd --- Abstract base class for Distutils commands

This module supplies the abstract base class Command.

class distutils.cmd.Command(dist)

定义命令类的抽象基类，这些类是 Distutils 的“工蜂”。每个命令类可以看作子程序，其行为由若干“选项”（局部变量）控制。选项在 initialize_options() 中声明，并在 finalize_options() 中定义（即赋予最终值），这两个方法都要由每个命令类实现。区分这两个阶段是必要的，因为选项值可能来自外部环境（命令行、配置文件等），任何依赖于其他选项的选项只能在这些外部影响因素处理完毕后才能计算得出——因此需要 finalize_options() 方法。子程序的主体部分（即根据选项值执行所有实际工作的部分）是 run() 方法，每个命令类也应当实现该方法。

The class constructor takes a single argument dist, a Distribution instance.

9.24. Creating a new Distutils command

This section outlines the steps to create a new Distutils command.

A new command lives in a module in the distutils.command package. There is a sample template in that directory called command_template. Copy this file to a new module with the same name as the new command you're implementing. This module should implement a class with the same name as the module (and the command). So, for instance, to create the command peel_banana (so that users can run setup.py peel_banana), you'd copy command_template to distutils/command/peel_banana.py, then edit it so that it's implementing the class peel_banana, a subclass of distutils.cmd.Command.

Subclasses of Command must define the following methods.

Command.initialize_options()

Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, initialize_options() implementations are just a bunch of self.foo = None assignments.

Command.finalize_options()

Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if foo depends on bar, then it is safe to set foo from bar as long as foo still has the same value it was assigned in initialize_options().

Command.run()

A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in initialize_options(), customized by other commands, the setup script, the command-line, and config files, and finalized in finalize_options(). All terminal output and filesystem interaction should be done by run().

Command.sub_commands

sub_commands formalizes the notion of a "family" of commands, e.g. install as the parent with sub-commands install_lib, install_headers, etc. The parent of a family of commands defines sub_commands as a class attribute; it's a list of 2-tuples (command_name, predicate), with command_name a string and predicate a function, a string or None. predicate is a method of the parent command that determines whether the corresponding command is applicable in the current situation. (E.g. install_headers is only applicable if we have any C header files to install.) If predicate is None, that command is always applicable.

sub_commands is usually defined at the end of a class, because predicates can be methods of the class, so they must already have been defined. The canonical example is the install command.

9.25. distutils.command --- Individual Distutils commands

9.26. distutils.command.bdist --- Build a binary installer

9.27. distutils.command.bdist_packager --- Abstract base class for packagers

9.28. distutils.command.bdist_dumb --- Build a "dumb" installer

9.29. distutils.command.bdist_msi --- Build a Microsoft Installer binary package

class distutils.command.bdist_msi.bdist_msi

3.9 版后已移除: Use bdist_wheel (wheel packages) instead.

Builds a Windows Installer [https://msdn.microsoft.com/en-us/library/cc185688(VS.85).aspx] (.msi) binary package.

9.30. distutils.command.bdist_rpm --- Build a binary distribution as a Redhat RPM and SRPM

9.31. distutils.command.sdist --- Build a source distribution

9.32. distutils.command.build --- Build all files of a package

9.33. distutils.command.build_clib --- Build any C libraries in a package

9.34. distutils.command.build_ext --- Build any extensions in a package

9.35. distutils.command.build_py --- Build the .py/.pyc files of a package

class distutils.command.build_py.build_py

class distutils.command.build_py.build_py_2to3

Alternative implementation of build_py which also runs the 2to3 conversion library on each .py file that is going to be installed. To use this in a setup.py file for a distribution that is designed to run with both Python 2.x and 3.x, add:

try:
    from distutils.command.build_py import build_py_2to3 as build_py
except ImportError:
    from distutils.command.build_py import build_py

to your setup.py, and later:

cmdclass = {'build_py': build_py}

to the invocation of setup().

9.36. distutils.command.build_scripts --- Build the scripts of a package

9.37. distutils.command.clean --- Clean a package build area

This command removes the temporary files created by build and its subcommands, like intermediary compiled object files. With the --all option, the complete build directory will be removed.

Extension modules built in place will not be cleaned, as they are not in the build directory.

9.38. distutils.command.config --- Perform package configuration

9.39. distutils.command.install --- Install a package

9.40. distutils.command.install_data --- Install data files from a package

9.41. distutils.command.install_headers --- Install C/C++ header files from a package

9.42. distutils.command.install_lib --- Install library files from a package

9.43. distutils.command.install_scripts --- Install script files from a package

9.44. distutils.command.register --- Register a module with the Python Package Index

The register command registers the package with the Python Package Index. This is described in more detail in PEP 301 [https://www.python.org/dev/peps/pep-0301].

9.45. distutils.command.check --- Check the meta-data of a package

The check command performs some tests on the meta-data of a package. For example, it verifies that all required meta-data are provided as the arguments passed to the setup() function.

安装Python模块（旧版）

作者

Greg Ward

注解

整个 distutils 包已被弃用并将在 Python 3.12 中被移除。 此文档仅保留作参考，并将随包一起被移除。 更多信息请参阅 有什么新变化 条目。

参见

安装 Python 模块

最新的模块安装文档。对于常规Python使用，你几乎肯定像使用该文档而非这个。

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

注解

本指南仅介绍构建和分发扩展的基本工具，这些扩展是作为此Python版本的一部分提供的。 第三方工具提供更易于使用和更安全的替代方案。有关详细信息，请参阅 Python 打包用户指南中的 快速推荐部分 [https://packaging.python.org/guides/tool-recommendations/] 。

概述

在Python 2.0中，distutils API 首次被添加到标准库中。这向Linux发行版维护者提供了一个将Python项目转换为发行版软件包的标准方法，以及向系统管理员们提供了直接将这些软件包安装到目标系统的标准方法。

自从很多年前 Python 2.0 发布，将构建系统和包安装器与语言运行时的释放循环紧密连接在一起产生了很多问题。现在推荐做法是在项目中使用 pip 包安装器和 setuptools 构建系统，而不是直接使用 distutils。

请参阅 安装 Python 模块 和 分发 Python 模块 了解更多细节。

这个旧文档将被保留，至到我们相信 setuptools 覆盖了所有内容。

基于 distutils 的源代码分发

如果你下载了一个模块源代码发布包，你可以很快地确定它是否按标准方式，即使用 Distutils 进行打包和分发。 首先，发布包的名称和版本号将在已下载归档文件的名称中明确显示，例如 foo-1.0.tar.gz 或 widget-0.9.7.zip。 然后，归档文件将被解包为类似名称的目录: foo-1.0 或 widget-0.9.7。 此外，发布包将包含一个安装脚本 setup.py，以及一个名为 README.txt 或是 README 的文件，它应当写明构建和安装模块发布包的方式是简单地在终端中运行一条命令:

python setup.py install

Windows 用户应该使用命令提示符来运行命令(Start ‣ Accessories):

setup.py install

如果这些事情都属实，那么您已经了解了如何构建和安装您已经下载的模块：只需运行如上的命令。除非您需要以非常规方式安装或者定制构建过程，您其实不需要本文档。更进一步说，以上命令就是您可以从文档中获得的全部。

标准构建及安装

正如 基于 distutils 的源代码分发 中所描述的那样，通过 Distutils 构建和安装发行的模块常常只需要在终端执行一个简单的命令。

python setup.py install

平台差异

您应当总是在分发文件的根目录处运行设置的命令，比如，模块分发的源代码最高的子目录。例如，如果您刚刚在 Unix 操作系统上下载了一个模块分发的源代码，您需要做的事：

gunzip -c foo-1.0.tar.gz | tar xf -    # unpacks into directory foo-1.0
cd foo-1.0
python setup.py install

在 Windows 上，你下载到的可能是 foo-1.0.zip。 如果你将归档文件下载到 C:\Temp，则它将被解包至 C:\Temp\foo-1.0；你可以使用带有图形用户界面的归档管理器（如 WinZip）或命令行工具（如 unzip 或 pkunzip 等）来解包归档文件。 然后，打开一个命令行提示符窗口并运行:

cd c:\Temp\foo-1.0
python setup.py install

拆分任务

Running setup.py install builds and installs all modules in one run. If you prefer to work incrementally---especially useful if you want to customize the build process, or if things are going wrong---you can use the setup script to do one thing at a time. This is particularly helpful when the build and install will be done by different users---for example, you might want to build a module distribution and hand it off to a system administrator for installation (or do it yourself, with super-user privileges).

For example, you can build everything in one step, and then install everything in a second step, by invoking the setup script twice:

python setup.py build
python setup.py install

If you do this, you will notice that running the install command first runs the build command, which---in this case---quickly notices that it has nothing to do, since everything in the build directory is up-to-date.

You may not need this ability to break things down often if all you do is install modules downloaded off the 'net, but it's very handy for more advanced tasks. If you get into distributing your own Python modules and extensions, you'll run lots of individual Distutils commands on their own.

How building works

As implied above, the build command is responsible for putting the files to install into a build directory. By default, this is build under the distribution root; if you're excessively concerned with speed, or want to keep the source tree pristine, you can change the build directory with the --build-base option. For example:

python setup.py build --build-base=/path/to/pybuild/foo-1.0

(Or you could do this permanently with a directive in your system or personal Distutils configuration file; see section Distutils 配置文件Configuration Files.) Normally, this isn't necessary.

The default layout for the build tree is as follows:

--- build/ --- lib/
or
--- build/ --- lib.<plat>/
               temp.<plat>/

where <plat> expands to a brief description of the current OS/hardware platform and Python version. The first form, with just a lib directory, is used for "pure module distributions"---that is, module distributions that include only pure Python modules. If a module distribution contains any extensions (modules written in C/C++), then the second form, with two <plat> directories, is used. In that case, the temp.plat directory holds temporary files generated by the compile/link process that don't actually get installed. In either case, the lib (or lib.plat) directory contains all Python modules (pure Python and extensions) that will be installed.

In the future, more directories will be added to handle Python scripts, documentation, binary executables, and whatever else is needed to handle the job of installing Python modules and applications.

How installation works

After the build command runs (whether you run it explicitly, or the install command does it for you), the work of the install command is relatively simple: all it has to do is copy everything under build/lib (or build/lib.plat) to your chosen installation directory.

If you don't choose an installation directory---i.e., if you just run setup.py install---then the install command installs to the standard location for third-party Python modules. This location varies by platform and by how you built/installed Python itself. On Unix (and macOS, which is also Unix-based), it also depends on whether the module distribution being installed is pure Python or contains extensions ("non-pure"):

平台 | 标准安装位置 | 默认值 | 备注
（单一）Unix | prefix/lib/pythonX.Y/site-packages | /usr/local/lib/pythonX.Y/site-packages | (1)
（类）Unix | exec-prefix/lib/pythonX.Y/site-packages | /usr/local/lib/pythonX.Y/site-packages | (1)
Windows | prefix\Lib\site-packages | C:\PythonXY\Lib\site-packages | (2)

注释：

Most Linux distributions include Python as a standard part of the system, so prefix and exec-prefix are usually both /usr on Linux. If you build Python yourself on Linux (or any Unix-like system), the default prefix and exec-prefix are /usr/local.

The default installation directory on Windows was C:\Program Files\Python under Python 1.6a1, 1.5.2, and earlier.

prefix and exec-prefix stand for the directories that Python is installed to, and where it finds its libraries at run-time. They are always the same under Windows, and very often the same under Unix and macOS. You can find out what your Python installation uses for prefix and exec-prefix by running Python in interactive mode and typing a few simple commands. Under Unix, just type python at the shell prompt. Under Windows, choose Start ‣ Programs ‣ Python X.Y ‣ Python (command line). Once the interpreter is started, you type Python code at the prompt. For example, on my Linux system, I type the three Python statements shown below, and get the output as shown, to find out my prefix and exec-prefix:

Python 2.4 (#26, Aug  7 2004, 17:19:02)
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.prefix
'/usr'
>>> sys.exec_prefix
'/usr'

A few other placeholders are used in this document: X.Y stands for the version of Python, for example 3.2; abiflags will be replaced by the value of sys.abiflags or the empty string for platforms which don't define ABI flags; distname will be replaced by the name of the module distribution being installed. Dots and capitalization are important in the paths; for example, a value that uses python3.2 on UNIX will typically use Python32 on Windows.

If you don't want to install modules to the standard location, or if you don't have permission to write there, then you need to read about alternate installations in section 可选安装形式. If you want to customize your installation directories more heavily, see section 自定义安装 on custom installations.

可选安装形式

Often, it is necessary or desirable to install modules to a location other than the standard location for third-party Python modules. For example, on a Unix system you might not have permission to write to the standard third-party module directory. Or you might wish to try out a module before making it a standard part of your local Python installation. This is especially true when upgrading a distribution already present: you want to make sure your existing base of scripts still works with the new version before actually upgrading.

The Distutils install command is designed to make installing module distributions to an alternate location simple and painless. The basic idea is that you supply a base directory for the installation, and the install command picks a set of directories (called an installation scheme) under this base directory in which to install files. The details differ across platforms, so read whichever of the following sections applies to you.

Note that the various alternate installation schemes are mutually exclusive: you can pass --user, or --home, or --prefix and --exec-prefix, or --install-base and --install-platbase, but you can't mix from these groups.

可选安装形式：用户方案

此方案被设计为针对没有全局 site-packages 目录写入权限或不想安装到该目录的用户的最便捷解决方案。 它可以通过一个简单的选项来启用:

python setup.py install --user

Files will be installed into subdirectories of site.USER_BASE (written as userbase hereafter). This scheme installs pure Python modules and extension modules in the same location (also known as site.USER_SITE). Here are the values for UNIX, including macOS:

文件类型 | 安装目录
模块 | userbase/lib/pythonX.Y/site-packages
脚本 | userbase/bin
数据 | userbase
C 头文件 | userbase/include/pythonX.Yabiflags/distname

以下是Windows上使用的值：

文件类型 | 安装目录
模块 | userbase\PythonXY\site-packages
脚本 | userbase\PythonXY\Scripts
数据 | userbase
C 头文件 | userbase\PythonXY\Include{distname}

The advantage of using this scheme compared to the other ones described below is that the user site-packages directory is under normal conditions always included in sys.path (see site for more information), which means that there is no additional step to perform after running the setup.py script to finalize the installation.

The build_ext command also has a --user option to add userbase/include to the compiler search path for header files and userbase/lib to the compiler search path for libraries as well as to the runtime search path for shared C libraries (rpath).

可选安装形式：家目录方案

“主方案”背后的理念是你可以构建并维护个人的 Python 模块集。 该方案的名称源自 Unix 上“主目录”的概念，因为通常 Unix 用户会将其主目录的布局设置为与 /usr/ 或 /usr/local/ 相似。 任何人都可以使用该方案，无论其安装的操作系统是什么。

Installing a new module distribution is as simple as

python setup.py install --home=<dir>

where you can supply any directory you like for the --home option. On Unix, lazy typists can just type a tilde (~); the install command will expand this to your home directory:

python setup.py install --home=~

To make Python find the distributions installed with this scheme, you may have to modify Python's search path or edit sitecustomize (see site) to call site.addsitedir() or edit sys.path.

The --home option defines the installation base directory. Files are installed to the following directories under the installation base as follows:

文件类型 | 安装目录
模块 | home/lib/python
脚本 | home/bin
数据 | home
C 头文件 | home/include/python/distname

（如果你是使用 Windows 请将斜杠替换为反斜杠。）

可选安装形式：Unix（前缀方案）

“前缀方案”适用于当你希望使用一个 Python 安装程序来执行构建/安装（即运行 setup 脚本），但需要将模块安装到另一个 Python 安装版（或看起来类似于另一个 Python 安装版）的第三方模块目录中的情况。 如果这听起来有点不寻常，确实如此 --- 这就是为什么要先介绍用户和主目录方案的原因。 然而，至少有两种已知的情况会用到前缀方案。

First, consider that many Linux distributions put Python in /usr, rather than the more traditional /usr/local. This is entirely appropriate, since in those cases Python is part of "the system" rather than a local add-on. However, if you are installing Python modules from source, you probably want them to go in /usr/local/lib/python2.X rather than /usr/lib/python2.X. This can be done with

/usr/bin/python setup.py install --prefix=/usr/local

Another possibility is a network filesystem where the name used to write to a remote directory is different from the name used to read it: for example, the Python interpreter accessed as /usr/local/bin/python might search for modules in /usr/local/lib/python2.X, but those modules would have to be installed to, say, /mnt/@server/export/lib/python2.X. This could be done with

/usr/local/bin/python setup.py install --prefix=/mnt/@server/export

In either case, the --prefix option defines the installation base, and the --exec-prefix option defines the platform-specific installation base, which is used for platform-specific files. (Currently, this just means non-pure module distributions, but could be expanded to C libraries, binary executables, etc.) If --exec-prefix is not supplied, it defaults to --prefix. Files are installed as follows:

文件类型 | 安装目录
Python 模块 | prefix/lib/pythonX.Y/site-packages
扩展模块 | exec-prefix/lib/pythonX.Y/site-packages
脚本 | prefix/bin
数据 | prefix
C 头文件 | prefix/include/pythonX.Yabiflags/distname

There is no requirement that --prefix or --exec-prefix actually point to an alternate Python installation; if the directories listed above do not already exist, they are created at installation time.

Incidentally, the real reason the prefix scheme is important is simply that a standard Unix installation uses the prefix scheme, but with --prefix and --exec-prefix supplied by Python itself as sys.prefix and sys.exec_prefix. Thus, you might think you'll never use the prefix scheme, but every time you run python setup.py install without any other options, you're using it.

Note that installing extensions to an alternate Python installation has no effect on how those extensions are built: in particular, the Python header files (Python.h and friends) installed with the Python interpreter used to run the setup script will be used in compiling extensions. It is your responsibility to ensure that the interpreter used to run extensions installed in this way is compatible with the interpreter used to build them. The best way to do this is to ensure that the two interpreters are the same version of Python (possibly different builds, or possibly copies of the same build). (Of course, if your --prefix and --exec-prefix don't even point to an alternate Python installation, this is immaterial.)

Alternate installation: Windows (the prefix scheme)

Windows has no concept of a user's home directory, and since the standard Python installation under Windows is simpler than under Unix, the --prefix option has traditionally been used to install additional packages in separate locations on Windows.

python setup.py install --prefix="\Temp\Python"

to install modules to the \Temp\Python directory on the current drive.

The installation base is defined by the --prefix option; the --exec-prefix option is not supported under Windows, which means that pure Python modules and extension modules are installed into the same location. Files are installed as follows:

文件类型 | 安装目录
模块 | prefix\Lib\site-packages
脚本 | prefix\Scripts
数据 | prefix
C 头文件 | prefix\Include{distname}

自定义安装

Sometimes, the alternate installation schemes described in section 可选安装形式 just don't do what you want. You might want to tweak just one or two directories while keeping everything under the same base directory, or you might want to completely redefine the installation scheme. In either case, you're creating a custom installation scheme.

To create a custom installation scheme, you start with one of the alternate schemes and override some of the installation directories used for the various types of files, using these options:

文件类型 | 覆盖选项
Python 模块 | --install-purelib
扩展模块 | --install-platlib
所有模块 | --install-lib
脚本 | --install-scripts
数据 | --install-data
C 头文件 | --install-headers

These override options can be relative, absolute, or explicitly defined in terms of one of the installation base directories. (There are two installation base directories, and they are normally the same---they only differ when you use the Unix "prefix scheme" and supply different --prefix and --exec-prefix options; using --install-lib will override values computed or given for --install-purelib and --install-platlib, and is recommended for schemes that don't make a difference between Python and extension modules.)

For example, say you're installing a module distribution to your home directory under Unix---but you want scripts to go in ~/scripts rather than ~/bin. As you might expect, you can override this directory with the --install-scripts option; in this case, it makes most sense to supply a relative path, which will be interpreted relative to the installation base directory (your home directory, in this case):

python setup.py install --home=~ --install-scripts=scripts

Another Unix example: suppose your Python installation was built and installed with a prefix of /usr/local/python, so under a standard installation scripts will wind up in /usr/local/python/bin. If you want them in /usr/local/bin instead, you would supply this absolute directory for the --install-scripts option:

python setup.py install --install-scripts=/usr/local/bin

(This performs an installation using the "prefix scheme", where the prefix is whatever your Python interpreter was installed with--- /usr/local/python in this case.)

If you maintain Python on Windows, you might want third-party modules to live in a subdirectory of prefix, rather than right in prefix itself. This is almost as easy as customizing the script installation directory---you just have to remember that there are two types of modules to worry about, Python and extension modules, which can conveniently be both controlled by one option:

python setup.py install --install-lib=Site

The specified installation directory is relative to prefix. Of course, you also have to ensure that this directory is in Python's module search path, such as by putting a .pth file in a site directory (see site). See section 修改 Python 的搜索路径 to find out how to modify Python's search path.

If you want to define an entire installation scheme, you just have to supply all of the installation directory options. The recommended way to do this is to supply relative paths; for example, if you want to maintain all Python module-related files under python in your home directory, and you want a separate directory for each platform that you use your home directory from, you might define the following installation scheme:

python setup.py install --home=~ \
                        --install-purelib=python/lib \
                        --install-platlib=python/lib.$PLAT \
                        --install-scripts=python/scripts
                        --install-data=python/data

或者，等价于

python setup.py install --home=~/python \
                        --install-purelib=lib \
                        --install-platlib='lib.$PLAT' \
                        --install-scripts=scripts
                        --install-data=data

$PLAT is not (necessarily) an environment variable---it will be expanded by the Distutils as it parses your command line options, just as it does when parsing your configuration file(s).

Obviously, specifying the entire installation scheme every time you install a new module distribution would be very tedious. Thus, you can put these options into your Distutils config file (see section Distutils 配置文件Configuration Files):

[install]
install-base=$HOME
install-purelib=python/lib
install-platlib=python/lib.$PLAT
install-scripts=python/scripts
install-data=python/data

或者，等价于，

[install]
install-base=$HOME/python
install-purelib=lib
install-platlib=lib.$PLAT
install-scripts=scripts
install-data=data

Note that these two are not equivalent if you supply a different installation base directory when you run the setup script. For example,

python setup.py install --install-base=/tmp

would install pure modules to /tmp/python/lib in the first case, and to /tmp/lib in the second case. (For the second case, you probably want to supply an installation base of /tmp/python.)

You probably noticed the use of $HOME and $PLAT in the sample configuration file input. These are Distutils configuration variables, which bear a strong resemblance to environment variables. In fact, you can use environment variables in config files on platforms that have such a notion but the Distutils additionally define a few extra variables that may not be in your environment, such as $PLAT. (And of course, on systems that don't have environment variables, such as Mac OS 9, the configuration variables supplied by the Distutils are the only ones you can use.) See section Distutils 配置文件Configuration Files for details.

注解

When a virtual environment is activated, any options that change the installation path will be ignored from all distutils configuration files to prevent inadvertently installing projects outside of the virtual environment.

修改 Python 的搜索路径

When the Python interpreter executes an import statement, it searches for both Python code and extension modules along a search path. A default value for the path is configured into the Python binary when the interpreter is built. You can determine the path by importing the sys module and printing the value of sys.path.

$ python
Python 2.2 (#11, Oct  3 2002, 13:31:27)
[GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path
['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
 '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload',
 '/usr/local/lib/python2.3/site-packages']
>>>

The null string in sys.path represents the current working directory.

The expected convention for locally installed packages is to put them in the .../site-packages/ directory, but you may want to install Python modules into some arbitrary directory. For example, your site may have a convention of keeping all software related to the web server under /www. Add-on Python modules might then belong in /www/python, and in order to import them, this directory must be added to sys.path. There are several different ways to add the directory.

The most convenient way is to add a path configuration file to a directory that's already on Python's path, usually to the .../site-packages/ directory. Path configuration files have an extension of .pth, and each line must contain a single path that will be appended to sys.path. (Because the new paths are appended to sys.path, modules in the added directories will not override standard modules. This means you can't use this mechanism for installing fixed versions of standard modules.)

Paths can be absolute or relative, in which case they're relative to the directory containing the .pth file. See the documentation of the site module for more information.

A slightly less convenient way is to edit the site.py file in Python's standard library, and modify sys.path. site.py is automatically imported when the Python interpreter is executed, unless the -S switch is supplied to suppress this behaviour. So you could simply edit site.py and add two lines to it:

import sys
sys.path.append('/www/python/')

However, if you reinstall the same major version of Python (perhaps when upgrading from 2.2 to 2.2.2, for example) site.py will be overwritten by the stock version. You'd have to remember that it was modified and save a copy before doing the installation.

There are two environment variables that can modify sys.path. PYTHONHOME sets an alternate value for the prefix of the Python installation. For example, if PYTHONHOME is set to /www/python, the search path will be set to ['', '/www/python/lib/pythonX.Y/', '/www/python/lib/pythonX.Y/plat-linux2', ...].

The PYTHONPATH variable can be set to a list of paths that will be added to the beginning of sys.path. For example, if PYTHONPATH is set to /www/python:/opt/py, the search path will begin with ['/www/python', '/opt/py']. (Note that directories must exist in order to be added to sys.path; the site module removes paths that don't exist.)

Finally, sys.path is just a regular Python list, so any Python application can modify it by adding or removing entries.

Distutils 配置文件Configuration Files

As mentioned above, you can use Distutils configuration files to record personal or site preferences for any Distutils options. That is, any option to any command can be stored in one of two or three (depending on your platform) configuration files, which will be consulted before the command-line is parsed. This means that configuration files will override default values, and the command-line will in turn override configuration files. Furthermore, if multiple configuration files apply, values from "earlier" files are overridden by "later" files.

Location and names of config files

The names and locations of the configuration files vary slightly across platforms. On Unix and macOS, the three configuration files (in the order they are processed) are:

文件类型 | 位置和文件名 | 备注
system | prefix/lib/pythonver/distutils/distutils.cfg | (1)
personal | $HOME/.pydistutils.cfg | (2)
local | setup.cfg | (3)

而在 Windows 中，配置文件为:

文件类型 | 位置和文件名 | 备注
system | prefix\Lib\distutils\distutils.cfg | (4)
personal | %HOME%\pydistutils.cfg | (5)
local | setup.cfg | (3)

On all platforms, the "personal" file can be temporarily disabled by passing the --no-user-cfg option.

注释：

Strictly speaking, the system-wide configuration file lives in the directory where the Distutils are installed; under Python 1.6 and later on Unix, this is as shown. For Python 1.5.2, the Distutils will normally be installed to prefix/lib/python1.5/site-packages/distutils, so the system configuration file should be put there under Python 1.5.2.

On Unix, if the HOME environment variable is not defined, the user's home directory will be determined with the getpwuid() function from the standard pwd module. This is done by the os.path.expanduser() function used by Distutils.

I.e., in the current directory (usually the location of the setup script).

(See also note (1).) Under Python 1.6 and later, Python's default "installation prefix" is C:\Python, so the system configuration file is normally C:\Python\Lib\distutils\distutils.cfg. Under Python 1.5.2, the default prefix was C:\Program Files\Python, and the Distutils were not part of the standard library---so the system configuration file would be C:\Program Files\Python\distutils\distutils.cfg in a standard Python 1.5.2 installation under Windows.

On Windows, if the HOME environment variable is not defined, USERPROFILE then HOMEDRIVE and HOMEPATH will be tried. This is done by the os.path.expanduser() function used by Distutils.

Syntax of config files

The Distutils configuration files all have the same syntax. The config files are grouped into sections. There is one section for each Distutils command, plus a global section for global options that affect every command. Each section consists of one option per line, specified as option=value.

For example, the following is a complete config file that just forces all commands to run quietly by default:

[global]
verbose=0

If this is installed as the system config file, it will affect all processing of any Python module distribution by any user on the current system. If it is installed as your personal config file (on systems that support them), it will affect only module distributions processed by you. And if it is used as the setup.cfg for a particular module distribution, it affects only that distribution.

You could override the default "build base" directory and make the build* commands always forcibly rebuild all files with the following:

[build]
build-base=blib
force=1

which corresponds to the command-line arguments

python setup.py build --build-base=blib --force

except that including the build command on the command-line means that command will be run. Including a particular command in config files has no such implication; it only means that if the command is run, the options in the config file will apply. (Or if other commands that derive values from it are run, they will use the values in the config file.)

You can find out the complete list of options for any command using the --help option, e.g.:

python setup.py build --help

and you can find out the complete list of global options by using --help without a command:

python setup.py --help

See also the "Reference" section of the "Distributing Python Modules" manual.

Building Extensions: Tips and Tricks

Whenever possible, the Distutils try to use the configuration information made available by the Python interpreter used to run the setup.py script. For example, the same compiler and linker flags used to compile Python will also be used for compiling extensions. Usually this will work well, but in complicated situations this might be inappropriate. This section discusses how to override the usual Distutils behaviour.

Tweaking compiler/linker flags

Compiling a Python extension written in C or C++ will sometimes require specifying custom flags for the compiler and linker in order to use a particular library or produce a special kind of object code. This is especially true if the extension hasn't been tested on your platform, or if you're trying to cross-compile Python.

In the most general case, the extension author might have foreseen that compiling the extensions would be complicated, and provided a Setup file for you to edit. This will likely only be done if the module distribution contains many separate extension modules, or if they often require elaborate sets of compiler flags in order to work.

A Setup file, if present, is parsed in order to get a list of extensions to build. Each line in a Setup describes a single module. Lines have the following structure:

module ... [sourcefile ...] [cpparg ...] [library ...]

Let's examine each of the fields in turn.

module is the name of the extension module to be built, and should be a valid Python identifier. You can't just change this in order to rename a module (edits to the source code would also be needed), so this should be left alone.

sourcefile is anything that's likely to be a source code file, at least judging by the filename. Filenames ending in .c are assumed to be written in C, filenames ending in .C, .cc, and .c++ are assumed to be C++, and filenames ending in .m or .mm are assumed to be in Objective C.

cpparg is an argument for the C preprocessor, and is anything starting with -I, -D, -U or -C.

library is anything ending in .a or beginning with -l or -L.

If a particular platform requires a special library on your platform, you can add it by editing the Setup file and running python setup.py build. For example, if the module defined by the line

foo foomodule.c

must be linked with the math library libm.a on your platform, simply add -lm to the line:

foo foomodule.c -lm

Arbitrary switches intended for the compiler or the linker can be supplied with the -Xcompiler arg and -Xlinker arg options:

foo foomodule.c -Xcompiler -o32 -Xlinker -shared -lm

The next option after -Xcompiler and -Xlinker will be appended to the proper command line, so in the above example the compiler will be passed the -o32 option, and the linker will be passed -shared. If a compiler option requires an argument, you'll have to supply multiple -Xcompiler options; for example, to pass -x c++ the Setup file would have to contain -Xcompiler -x -Xcompiler c++.

Compiler flags can also be supplied through setting the CFLAGS environment variable. If set, the contents of CFLAGS will be added to the compiler flags specified in the Setup file.

在 Windows 上使用非 Microsoft 编辑器

Borland/CodeGear C++

This subsection describes the necessary steps to use Distutils with the Borland C++ compiler version 5.5. First you have to know that Borland's object file format (OMF) is different from the format used by the Python version you can download from the Python or ActiveState web site. (Python is built with Microsoft Visual C++, which uses COFF as the object file format.) For this reason you have to convert Python's library python25.lib into the Borland format. You can do this as follows:

coff2omf python25.lib python25_bcpp.lib

The coff2omf program comes with the Borland compiler. The file python25.lib is in the Libs directory of your Python installation. If your extension uses other libraries (zlib, ...) you have to convert them too.

The converted files have to reside in the same directories as the normal libraries.

How does Distutils manage to use these libraries with their changed names? If the extension needs a library (eg. foo) Distutils checks first if it finds a library with suffix _bcpp (eg. foo_bcpp.lib) and then uses this library. In the case it doesn't find such a special library it uses the default name (foo.lib.) 1

To let Distutils compile your extension with Borland C++ you now have to type:

python setup.py build --compiler=bcpp

If you want to use the Borland C++ compiler as the default, you could specify this in your personal or system-wide configuration file for Distutils (see section Distutils 配置文件Configuration Files.)

参见

C++Builder Compiler [https://www.embarcadero.com/products]

有关 Borland 发布的免费 C++ 编译器的信息，包括下载页面的链接。

Creating Python Extensions Using Borland's Free Compiler [http://www.cyberus.ca/~g_will/pyExtenDL.shtml]

介绍如何使用 Borland 发布的免费命令行方式 C++ 编译器构建 Python 的文档。

GNU C / Cygwin / MinGW

This section describes the necessary steps to use Distutils with the GNU C/C++ compilers in their Cygwin and MinGW distributions. 2 For a Python interpreter that was built with Cygwin, everything should work without any of these following steps.

Not all extensions can be built with MinGW or Cygwin, but many can. Extensions most likely to not work are those that use C++ or depend on Microsoft Visual C extensions.

To let Distutils compile your extension with Cygwin you have to type:

python setup.py build --compiler=cygwin

and for Cygwin in no-cygwin mode 3 or for MinGW type:

python setup.py build --compiler=mingw32

If you want to use any of these options/compilers as default, you should consider writing it in your personal or system-wide configuration file for Distutils (see section Distutils 配置文件Configuration Files.)

旧版 Python 和 MinGW

The following instructions only apply if you're using a version of Python inferior to 2.4.1 with a MinGW inferior to 3.0.0 (with binutils-2.13.90-20030111-1).

These compilers require some special libraries. This task is more complex than for Borland's C++, because there is no program to convert the library. First you have to create a list of symbols which the Python DLL exports. (You can find a good program for this task at https://sourceforge.net/projects/mingw/files/MinGW/Extension/pexports/).

pexports python25.dll >python25.def

The location of an installed python25.dll will depend on the installation options and the version and language of Windows. In a "just for me" installation, it will appear in the root of the installation directory. In a shared installation, it will be located in the system directory.

Then you can create from these information an import library for gcc.

/cygwin/bin/dlltool --dllname python25.dll --def python25.def --output-lib libpython25.a

The resulting library has to be placed in the same directory as python25.lib. (Should be the libs directory under your Python installation directory.)

If your extension uses other libraries (zlib,...) you might have to convert them too. The converted files have to reside in the same directories as the normal libraries do.

参见

在 MS Windows 平台上使用 MinGW 构建 Python 模块 [https://old.zope.dev/Members/als/tips/win32_mingw_modules]

针对 MinGW 环境生成必要的库的相关信息

备注

1

这也意味着你可以将现有的全部 COFF 库替换为同名的 OMF 库。

2

请查看 https://www.sourceware.org/cygwin/ 了解更多信息

3

你将没有可用的 POSIX 模拟，但你也将不再需要 cygwin1.dll。

Python 模块索引

_ | a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | x | z

| _ |
| __future__ | Future statement definitions
| __main__ | The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``.
| _thread | Low-level threading API.
| a |
| abc | Abstract base classes according to :pep:`3119`.
| aifc | 已移除: Read and write audio files in AIFF or AIFC format.
| argparse | Command-line option and argument parsing library.
| array | Space efficient arrays of uniformly typed numeric values.
| ast | Abstract Syntax Tree classes and manipulation.
| asynchat | 已移除: Support for asynchronous command/response protocols.
| asyncio | Asynchronous I/O.
| asyncore | 已移除: A base class for developing asynchronous socket handling services.
| atexit | Register and execute cleanup functions.
| audioop | 已移除: Manipulate raw audio data.
| b |
| base64 | RFC 4648: Base16, Base32, Base64 Data Encodings; Base85 and Ascii85
| bdb | Debugger framework.
| binascii | Tools for converting between binary and various ASCII-encoded binary representations.
| binhex | Encode and decode files in binhex4 format.
| bisect | Array bisection algorithms for binary searching.
| builtins | The module that provides the built-in namespace.
| bz2 | Interfaces for bzip2 compression and decompression.
| c |
| calendar | Functions for working with calendars, including some emulation of the Unix cal program.
| cgi | 已移除: Helpers for running Python scripts via the Common Gateway Interface.
| cgitb | 已移除: Configurable traceback handler for CGI scripts.
| chunk | 已移除: Module to read IFF chunks.
| cmath | Mathematical functions for complex numbers.
| cmd | Build line-oriented command interpreters.
| code | Facilities to implement read-eval-print loops.
| codecs | Encode and decode data and streams.
| codeop | Compile (possibly incomplete) Python code.
- | collections | Container datatypes
|     collections.abc | Abstract base classes for containers
| colorsys | Conversion functions between RGB and other color systems.
| compileall | Tools for byte-compiling all Python source files in a directory tree.
- | concurrent |
|     concurrent.futures | Execute computations concurrently using threads or processes.
| configparser | Configuration file parser.
| contextlib | Utilities for with-statement contexts.
| contextvars | Context Variables
| copy | Shallow and deep copy operations.
| copyreg | Register pickle support functions.
| cProfile |
| crypt (Unix) | 已移除: The crypt() function used to check Unix passwords.
| csv | Write and read tabular data to and from delimited files.
| ctypes | A foreign function library for Python.
- | curses (Unix) | An interface to the curses library, providing portable terminal handling.
|     curses.ascii | Constants and set-membership functions for ASCII characters.
|     curses.panel | A panel stack extension that adds depth to curses windows.
|     curses.textpad | Emacs-like input editing in a curses window.
| d |
| dataclasses | Generate special methods on user-defined classes.
| datetime | Basic date and time types.
- | dbm | Interfaces to various Unix "database" formats.
|     dbm.dumb | Portable implementation of the simple DBM interface.
|     dbm.gnu (Unix) | GNU's reinterpretation of dbm.
|     dbm.ndbm (Unix) | The standard "database" interface, based on ndbm.
| decimal | Implementation of the General Decimal Arithmetic Specification.
| difflib | Helpers for computing differences between objects.
| dis | Disassembler for Python bytecode.
- | distutils | Support for building and installing Python modules into an existing Python installation.
|     distutils.archive_util | Utility functions for creating archive files (tarballs, zip files, ...)
|     distutils.bcppcompiler |
|     distutils.ccompiler | Abstract CCompiler class
|     distutils.cmd | Provides the abstract base class :class:`~distutils.cmd.Command`. This class is subclassed by the modules in the distutils.command subpackage.
|     distutils.command | Contains one module for each standard Distutils command.
|     distutils.command.bdist | Build a binary installer for a package
|     distutils.command.bdist_dumb | Build a "dumb" installer - a simple archive of files
|     distutils.command.bdist_msi | Build a binary distribution as a Windows MSI file
|     distutils.command.bdist_packager | Abstract base class for packagers
|     distutils.command.bdist_rpm | Build a binary distribution as a Redhat RPM and SRPM
|     distutils.command.build | Build all files of a package
|     distutils.command.build_clib | Build any C libraries in a package
|     distutils.command.build_ext | Build any extensions in a package
|     distutils.command.build_py | Build the .py/.pyc files of a package
|     distutils.command.build_scripts | Build the scripts of a package
|     distutils.command.check | Check the meta-data of a package
|     distutils.command.clean | Clean a package build area
|     distutils.command.config | Perform package configuration
|     distutils.command.install | Install a package
|     distutils.command.install_data | Install data files from a package
|     distutils.command.install_headers | Install C/C++ header files from a package
|     distutils.command.install_lib | Install library files from a package
|     distutils.command.install_scripts | Install script files from a package
|     distutils.command.register | Register a module with the Python Package Index
|     distutils.command.sdist | Build a source distribution
|     distutils.core | The core Distutils functionality
|     distutils.cygwinccompiler |
|     distutils.debug | Provides the debug flag for distutils
|     distutils.dep_util | Utility functions for simple dependency checking
|     distutils.dir_util | Utility functions for operating on directories and directory trees
|     distutils.dist | Provides the Distribution class, which represents the module distribution being built/installed/distributed
|     distutils.errors | Provides standard distutils exceptions
|     distutils.extension | Provides the Extension class, used to describe C/C++ extension modules in setup scripts
|     distutils.fancy_getopt | Additional getopt functionality
|     distutils.file_util | Utility functions for operating on single files
|     distutils.filelist | The FileList class, used for poking about the file system and building lists of files.
|     distutils.log | A simple logging mechanism, :pep:`282`-style
|     distutils.msvccompiler | Microsoft Compiler
|     distutils.spawn | Provides the spawn() function
|     distutils.sysconfig | Low-level access to configuration information of the Python interpreter.
|     distutils.text_file | Provides the TextFile class, a simple interface to text files
|     distutils.unixccompiler | UNIX C Compiler
|     distutils.util | Miscellaneous other utility functions
|     distutils.version | Implements classes that represent module version numbers.
| doctest | Test pieces of code within docstrings.
| e |
- | email | Package supporting the parsing, manipulating, and generating email messages.
|     email.charset | Character Sets
|     email.contentmanager | Storing and Retrieving Content from MIME Parts
|     email.encoders | Encoders for email message payloads.
|     email.errors | The exception classes used by the email package.
|     email.generator | Generate flat text email messages from a message structure.
|     email.header | Representing non-ASCII headers
|     email.headerregistry | Automatic Parsing of headers based on the field name
|     email.iterators | Iterate over a message object tree.
|     email.message | The base class representing email messages.
|     email.mime | Build MIME messages.
|     email.parser | Parse flat text email messages to produce a message object structure.
|     email.policy | Controlling the parsing and generating of messages
|     email.utils | Miscellaneous email package utilities.
- | encodings |
|     encodings.idna | Internationalized Domain Names implementation
|     encodings.mbcs | Windows ANSI codepage
|     encodings.utf_8_sig | UTF-8 codec with BOM signature
| ensurepip | Bootstrapping the "pip" installer into an existing Python installation or virtual environment.
| enum | Implementation of an enumeration class.
| errno | Standard errno system symbols.
| f |
| faulthandler | Dump the Python traceback.
| fcntl (Unix) | The fcntl() and ioctl() system calls.
| filecmp | Compare files efficiently.
| fileinput | Loop over standard input or a list of files.
| fnmatch | Unix shell style filename pattern matching.
| fractions | Rational numbers.
| ftplib | FTP protocol client (requires sockets).
| functools | Higher-order functions and operations on callable objects.
| g |
| gc | Interface to the cycle-detecting garbage collector.
| getopt | Portable parser for command line options; support both short and long option names.
| getpass | Portable reading of passwords and retrieval of the userid.
| gettext | Multilingual internationalization services.
| glob | Unix shell style pathname pattern expansion.
| graphlib | Functionality to operate with graph-like structures
| grp (Unix) | The group database (getgrnam() and friends).
| gzip | Interfaces for gzip compression and decompression using file objects.
| h |
| hashlib | Secure hash and message digest algorithms.
| heapq | Heap queue algorithm (a.k.a. priority queue).
| hmac | Keyed-Hashing for Message Authentication (HMAC) implementation
- | html | Helpers for manipulating HTML.
|     html.entities | Definitions of HTML general entities.
|     html.parser | A simple parser that can handle HTML and XHTML.
- | http | HTTP status codes and messages
|     http.client | HTTP and HTTPS protocol client (requires sockets).
|     http.cookiejar | Classes for automatic handling of HTTP cookies.
|     http.cookies | Support for HTTP state management (cookies).
|     http.server | HTTP server and request handlers.
| i |
| idlelib | Implementation package for the IDLE shell/editor.
| imaplib | IMAP4 protocol client (requires sockets).
| imghdr | 已移除: Determine the type of image contained in a file or byte stream.
| imp | 已移除: Access the implementation of the import statement.
- | importlib | The implementation of the import machinery.
|     importlib.abc | Abstract base classes related to import
|     importlib.machinery | Importers and path hooks
|     importlib.metadata | The implementation of the importlib metadata.
|     importlib.resources | Package resource reading, opening, and access
|     importlib.util | Utility code for importers
| inspect | Extract information and source code from live objects.
| io | Core tools for working with streams.
| ipaddress | IPv4/IPv6 manipulation library.
| itertools | Functions creating iterators for efficient looping.
| j |
- | json | Encode and decode the JSON format.
|     json.tool | A command line to validate and pretty-print JSON.
| k |
| keyword | Test whether a string is a keyword in Python.
| l |
| lib2to3 | The 2to3 library
| linecache | Provides random access to individual lines from text files.
| locale | Internationalization services.
- | logging | Flexible event logging system for applications.
|     logging.config | Configuration of the logging module.
|     logging.handlers | Handlers for the logging module.
| lzma | A Python wrapper for the liblzma compression library.
| m |
| mailbox | Manipulate mailboxes in various formats
| mailcap | 已移除: Mailcap file handling.
| marshal | Convert Python objects to streams of bytes and back (with different constraints).
| math | Mathematical functions (sin() etc.).
| mimetypes | Mapping of filename extensions to MIME types.
| mmap | Interface to memory-mapped files for Unix and Windows.
| modulefinder | Find modules used by a script.
| msilib (Windows) | 已移除: Creation of Microsoft Installer files, and CAB files.
| msvcrt (Windows) | Miscellaneous useful routines from the MS VC++ runtime.
- | multiprocessing | Process-based parallelism.
|     multiprocessing.connection | API for dealing with sockets.
|     multiprocessing.dummy | Dumb wrapper around threading.
|     multiprocessing.managers | Share data between process with shared objects.
|     multiprocessing.pool | Create pools of processes.
|     multiprocessing.shared_memory | Provides shared memory for direct access across processes.
|     multiprocessing.sharedctypes | Allocate ctypes objects from shared memory.
| n |
| netrc | Loading of .netrc files.
| nis (Unix) | 已移除: Interface to Sun's NIS (Yellow Pages) library.
| nntplib | 已移除: NNTP protocol client (requires sockets).
| numbers | Numeric abstract base classes (Complex, Real, Integral, etc.).
| o |
| operator | Functions corresponding to the standard operators.
| optparse | 已移除: Command-line option parsing library.
- | os | Miscellaneous operating system interfaces.
|     os.path | Operations on pathnames.
| ossaudiodev (Linux, FreeBSD) | 已移除: Access to OSS-compatible audio devices.
| p |
| pathlib | Object-oriented filesystem paths
| pdb | The Python debugger for interactive interpreters.
| pickle | Convert Python objects to streams of bytes and back.
| pickletools | Contains extensive comments about the pickle protocols and pickle-machine opcodes, as well as some useful functions.
| pipes (Unix) | 已移除: A Python interface to Unix shell pipelines.
| pkgutil | Utilities for the import system.
| platform | Retrieves as much platform identifying data as possible.
| plistlib | Generate and parse Apple plist files.
| poplib | POP3 protocol client (requires sockets).
| posix (Unix) | The most common POSIX system calls (normally used via module os).
| pprint | Data pretty printer.
| profile | Python source profiler.
| pstats | Statistics object for use with the profiler.
| pty (Unix) | Pseudo-Terminal Handling for Unix.
| pwd (Unix) | The password database (getpwnam() and friends).
| py_compile | Generate byte-code files from Python source files.
| pyclbr | Supports information extraction for a Python module browser.
| pydoc | Documentation generator and online help system.
| q |
| queue | A synchronized queue class.
| quopri | Encode and decode files using the MIME quoted-printable encoding.
| r |
| random | Generate pseudo-random numbers with various common distributions.
| re | Regular expression operations.
| readline (Unix) | GNU readline support for Python.
| reprlib | Alternate repr() implementation with size limits.
| resource (Unix) | An interface to provide resource usage information on the current process.
| rlcompleter | Python identifier completion, suitable for the GNU readline library.
| runpy | Locate and run Python modules without importing them first.
| s |
| sched | General purpose event scheduler.
| secrets | Generate secure random numbers for managing secrets.
| select | Wait for I/O completion on multiple streams.
| selectors | High-level I/O multiplexing.
| shelve | Python object persistence.
| shlex | Simple lexical analysis for Unix shell-like languages.
| shutil | High-level file operations, including copying.
| signal | Set handlers for asynchronous events.
| site | Module responsible for site-specific configuration.
| smtpd | 已移除: A SMTP server implementation in Python.
| smtplib | SMTP protocol client (requires sockets).
| sndhdr | 已移除: Determine type of a sound file.
| socket | Low-level networking interface.
| socketserver | A framework for network servers.
| spwd (Unix) | 已移除: The shadow password database (getspnam() and friends).
| sqlite3 | A DB-API 2.0 implementation using SQLite 3.x.
| ssl | TLS/SSL wrapper for socket objects
| stat | Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat().
| statistics | Mathematical statistics functions
| string | Common string operations.
| stringprep | String preparation, as per RFC 3453
| struct | Interpret bytes as packed binary data.
| subprocess | Subprocess management.
| sunau | 已移除: Provide an interface to the Sun AU sound format.
| symtable | Interface to the compiler's internal symbol tables.
| sys | Access system-specific parameters and functions.
| sysconfig | Python's configuration information
| syslog (Unix) | An interface to the Unix syslog library routines.
| t |
| tabnanny | Tool for detecting white space related problems in Python source files in a directory tree.
| tarfile | Read and write tar-format archive files.
| telnetlib | 已移除: Telnet client class.
| tempfile | Generate temporary files and directories.
| termios (Unix) | POSIX style tty control.
- | test | Regression tests package containing the testing suite for Python.
|     test.support | Support for Python's regression test suite.
|     test.support.bytecode_helper | Support tools for testing correct bytecode generation.
|     test.support.import_helper | Support for import tests.
|     test.support.os_helper | Support for os tests.
|     test.support.script_helper | Support for Python's script execution tests.
|     test.support.socket_helper | Support for socket tests.
|     test.support.threading_helper | Support for threading tests.
|     test.support.warnings_helper | Support for warnings tests.
| textwrap | Text wrapping and filling
| threading | Thread-based parallelism.
| time | Time access and conversions.
| timeit | Measure the execution time of small code snippets.
- | tkinter | Interface to Tcl/Tk for graphical user interfaces
|     tkinter.colorchooser (Tk) | Color choosing dialog
|     tkinter.commondialog (Tk) | Tkinter base class for dialogs
|     tkinter.dnd (Tk) | Tkinter drag-and-drop interface
|     tkinter.filedialog (Tk) | Dialog classes for file selection
|     tkinter.font (Tk) | Tkinter font-wrapping class
|     tkinter.messagebox (Tk) | Various types of alert dialogs
|     tkinter.scrolledtext (Tk) | Text widget with a vertical scroll bar.
|     tkinter.simpledialog (Tk) | Simple dialog windows
|     tkinter.tix | Tk Extension Widgets for Tkinter
|     tkinter.ttk | Tk themed widget set
| token | Constants representing terminal nodes of the parse tree.
| tokenize | Lexical scanner for Python source code.
| trace | Trace or track Python statement execution.
| traceback | Print or retrieve a stack traceback.
| tracemalloc | Trace memory allocations.
| tty (Unix) | Utility functions that perform common terminal control operations.
| turtle | An educational framework for simple graphics applications
| turtledemo | A viewer for example turtle scripts
| types | Names for built-in types.
| typing | Support for type hints (see :pep:`484`).
| u |
| unicodedata | Access the Unicode Database.
- | unittest | Unit testing framework for Python.
|     unittest.mock | Mock object library.
- | urllib |
|     urllib.error | Exception classes raised by urllib.request.
|     urllib.parse | Parse URLs into or assemble them from components.
|     urllib.request | Extensible library for opening URLs.
|     urllib.response | Response classes used by urllib.
|     urllib.robotparser | Load a robots.txt file and answer questions about fetchability of other URLs.
| uu | 已移除: Encode and decode files in uuencode format.
| uuid | UUID objects (universally unique identifiers) according to RFC 4122
| v |
| venv | Creation of virtual environments.
| w |
| warnings | Issue warning messages and control their disposition.
| wave | Provide an interface to the WAV sound format.
| weakref | Support for weak references and weak dictionaries.
| webbrowser | Easy-to-use controller for web browsers.
| winreg (Windows) | Routines and objects for manipulating the Windows registry.
| winsound (Windows) | Access to the sound-playing machinery for Windows.
- | wsgiref | WSGI Utilities and Reference Implementation.
|     wsgiref.handlers | WSGI server/gateway base classes.
|     wsgiref.headers | WSGI response header tools.
|     wsgiref.simple_server | A simple WSGI HTTP server.
|     wsgiref.util | WSGI environment utilities.
|     wsgiref.validate | WSGI conformance checker.
| x |
| xdrlib | 已移除: Encoders and decoders for the External Data Representation (XDR).
- | xml | Package containing XML processing modules
|     xml.dom | Document Object Model API for Python.
|     xml.dom.minidom | Minimal Document Object Model (DOM) implementation.
|     xml.dom.pulldom | Support for building partial DOM trees from SAX events.
|     xml.etree.ElementTree | Implementation of the ElementTree API.
|     xml.parsers.expat | An interface to the Expat non-validating XML parser.
|     xml.parsers.expat.errors |
|     xml.parsers.expat.model |
|     xml.sax | Package containing SAX2 base classes and convenience functions.
|     xml.sax.handler | Base classes for SAX event handlers.
|     xml.sax.saxutils | Convenience functions and classes for use with SAX.
|     xml.sax.xmlreader | Interface which SAX-compliant XML parsers must implement.
- | xmlrpc |
|     xmlrpc.client | XML-RPC client access.
|     xmlrpc.server | Basic XML-RPC server implementations.
| z |
| zipapp | Manage executable Python zip archives
| zipfile | Read and write ZIP-format archive files.
| zipimport | Support for importing Python modules from ZIP archives.
| zlib | Low-level interface to compression and decompression routines compatible with gzip.
| zoneinfo | IANA time zone support

索引

按照字母的索引页:

符号 | _ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | 例 | 內 | 关 | 包 | 对 | 模 | 环 | 语 | 运

一页的全部索引 (可能会很多)

Download Python 3.10.20 Documentation

Last updated on: 3月 09, 2026.

To download an archive containing all the documents for this version of Python in one of various formats, follow one of links in this table.

Format | Packed as .zip | Packed as .tar.bz2
HTML | Download (ca. 9 MiB) | Download (ca. 6 MiB)
Plain Text | Download (ca. 3 MiB) | Download (ca. 2 MiB)
EPUB | Download (ca. 5 MiB) |

These archives contain all the content in the documentation.

HTML Help (.chm) files are made available in the "Windows" section on the Python download page.

We no longer provide updates to the pre-built PDFs of the documentation. The previously-built archives are still available and may be of use: A4 PDF (.zip archive); A4 PDF (.tar.bz2 archive); US Letter PDF (.zip archive); US Letter PDF (.tar.bz2 archive). To build a PDF archive, follow the instructions in the Developer's Guide and run make dist-pdf in the Doc/ directory of a copy of the CPython repository.

Unpacking

Unix users should download the .tar.bz2 archives; these are bzipped tar archives and can be handled in the usual way using tar and the bzip2 program. The InfoZIP unzip program can be used to handle the ZIP archives if desired. The .tar.bz2 archives provide the best compression and fastest download times.

Windows users can use the ZIP archives since those are customary on that platform. These are created on Unix using the InfoZIP zip program.

Problems

If you have comments or suggestions for the Python documentation, please send email to docs@python.org.

索引 – A

A() (在 re 模块中)

A-LAW, [1]

a-LAW

a2b_base64() (在 binascii 模块中)

a2b_hex() (在 binascii 模块中)

a2b_hqx() (在 binascii 模块中)

a2b_qp() (在 binascii 模块中)

a2b_uu() (在 binascii 模块中)

a85decode() (在 base64 模块中)

a85encode() (在 base64 模块中)

abc

模块

ABC (abc 中的类)

ABCMeta (abc 中的类)

abiflags() (在 sys 模块中)

abort()

(asyncio.DatagramTransport 方法)

(asyncio.WriteTransport 方法)

(ftplib.FTP 方法)

(threading.Barrier 方法)

(在 os 模块中)

above() (curses.panel.Panel 方法)

ABOVE_NORMAL_PRIORITY_CLASS() (在 subprocess 模块中)

abs

內置函数, [1]

abs()

內置函数

abs() (decimal.Context 方法)

(在 operator 模块中)

AbsoluteLinkError

AbsolutePathError

abspath() (在 os.path 模块中)

abstract base class -- 抽象基类

AbstractAsyncContextManager (contextlib 中的类)

AbstractBasicAuthHandler (urllib.request 中的类)

AbstractChildWatcher (asyncio 中的类)

abstractclassmethod() (在 abc 模块中)

AbstractContextManager (contextlib 中的类)

AbstractDigestAuthHandler (urllib.request 中的类)

AbstractEventLoop (asyncio 中的类)

AbstractEventLoopPolicy (asyncio 中的类)

abstractmethod() (在 abc 模块中)

abstractproperty() (在 abc 模块中)

AbstractSet (typing 中的类)

abstractstaticmethod() (在 abc 模块中)

accept() (asyncore.dispatcher 方法)

(multiprocessing.connection.Listener 方法)

(socket.socket 方法)

access() (在 os 模块中)

accumulate() (在 itertools 模块中)

aclose() (agen 方法)

(contextlib.AsyncExitStack 方法)

aclosing() (在 contextlib 模块中)

acos() (在 cmath 模块中)

(在 math 模块中)

acosh() (在 cmath 模块中)

(在 math 模块中)

acquire() (_thread.lock 方法)

(asyncio.Condition 方法)

(asyncio.Lock 方法)

(asyncio.Semaphore 方法)

(logging.Handler 方法)

(multiprocessing.Lock 方法)

(multiprocessing.RLock 方法)

(threading.Condition 方法)

(threading.Lock 方法)

(threading.RLock 方法)

(threading.Semaphore 方法)

acquire_lock() (在 imp 模块中)

Action (argparse 中的类)

action (optparse.Option 属性)

ACTIONS (optparse.Option 属性)

active_children() (在 multiprocessing 模块中)

active_count() (在 threading 模块中)

actual() (tkinter.font.Font 方法)

Add (ast 中的类)

add() (decimal.Context 方法)

(frozenset 方法)

(graphlib.TopologicalSorter 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(msilib.RadioButtonGroup 方法)

(pstats.Stats 方法)

(tarfile.TarFile 方法)

(tkinter.ttk.Notebook 方法)

(在 audioop 模块中)

(在 operator 模块中)

add_alias() (在 email.charset 模块中)

add_alternative() (email.message.EmailMessage 方法)

add_argument() (argparse.ArgumentParser 方法)

add_argument_group() (argparse.ArgumentParser 方法)

add_attachment() (email.message.EmailMessage 方法)

add_cgi_vars() (wsgiref.handlers.BaseHandler 方法)

add_charset() (在 email.charset 模块中)

add_child_handler() (asyncio.AbstractChildWatcher 方法)

add_codec() (在 email.charset 模块中)

add_cookie_header() (http.cookiejar.CookieJar 方法)

add_data() (在 msilib 模块中)

add_dll_directory() (在 os 模块中)

add_done_callback() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

add_fallback() (gettext.NullTranslations 方法)

add_file() (msilib.Directory 方法)

add_flag() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

add_folder() (mailbox.Maildir 方法)

(mailbox.MH 方法)

add_get_handler() (email.contentmanager.ContentManager 方法)

add_handler() (urllib.request.OpenerDirector 方法)

add_header() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(urllib.request.Request 方法)

(wsgiref.headers.Headers 方法)

add_history() (在 readline 模块中)

add_include_dir() (distutils.ccompiler.CCompiler 方法)

add_label() (mailbox.BabylMessage 方法)

add_library() (distutils.ccompiler.CCompiler 方法)

add_library_dir() (distutils.ccompiler.CCompiler 方法)

add_link_object() (distutils.ccompiler.CCompiler 方法)

add_mutually_exclusive_group() (argparse.ArgumentParser 方法)

add_option() (optparse.OptionParser 方法)

add_parent() (urllib.request.BaseHandler 方法)

add_password() (urllib.request.HTTPPasswordMgr 方法)

(urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

add_reader() (asyncio.loop 方法)

add_related() (email.message.EmailMessage 方法)

add_runtime_library_dir() (distutils.ccompiler.CCompiler 方法)

add_section() (configparser.ConfigParser 方法)

(configparser.RawConfigParser 方法)

add_sequence() (mailbox.MHMessage 方法)

add_set_handler() (email.contentmanager.ContentManager 方法)

add_signal_handler() (asyncio.loop 方法)

add_stream() (在 msilib 模块中)

add_subparsers() (argparse.ArgumentParser 方法)

add_tables() (在 msilib 模块中)

add_type() (在 mimetypes 模块中)

add_unredirected_header() (urllib.request.Request 方法)

add_writer() (asyncio.loop 方法)

addAsyncCleanup() (unittest.IsolatedAsyncioTestCase 方法)

addaudithook() (在 sys 模块中)

addch() (curses.window 方法)

addClassCleanup() (unittest.TestCase 类方法)

addCleanup() (unittest.TestCase 方法)

addcomponent() (turtle.Shape 方法)

addError() (unittest.TestResult 方法)

addExpectedFailure() (unittest.TestResult 方法)

addFailure() (unittest.TestResult 方法)

addfile() (tarfile.TarFile 方法)

addFilter() (logging.Handler 方法)

(logging.Logger 方法)

addHandler() (logging.Logger 方法)

addinfourl (urllib.response 中的类)

addition

addLevelName() (在 logging 模块中)

addModuleCleanup() (在 unittest 模块中)

addnstr() (curses.window 方法)

AddPackagePath() (在 modulefinder 模块中)

addr (smtpd.SMTPChannel 属性)

addr_spec (email.headerregistry.Address 属性)

Address (email.headerregistry 中的类)

address (email.headerregistry.SingleAddressHeader 属性)

(multiprocessing.connection.Listener 属性)

(multiprocessing.managers.BaseManager 属性)

address_exclude() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

address_family (socketserver.BaseServer 属性)

address_string() (http.server.BaseHTTPRequestHandler 方法)

addresses (email.headerregistry.AddressHeader 属性)

(email.headerregistry.Group 属性)

AddressHeader (email.headerregistry 中的类)

addressof() (在 ctypes 模块中)

AddressValueError

addshape() (在 turtle 模块中)

addsitedir() (在 site 模块中)

addSkip() (unittest.TestResult 方法)

addstr() (curses.window 方法)

addSubTest() (unittest.TestResult 方法)

addSuccess() (unittest.TestResult 方法)

addTest() (unittest.TestSuite 方法)

addTests() (unittest.TestSuite 方法)

addTypeEqualityFunc() (unittest.TestCase 方法)

addUnexpectedSuccess() (unittest.TestResult 方法)

adjust_int_max_str_digits() (在 test.support 模块中)

adjusted() (decimal.Decimal 方法)

adler32() (在 zlib 模块中)

ADPCM, Intel/DVI

adpcm2lin() (在 audioop 模块中)

AF_ALG() (在 socket 模块中)

AF_CAN() (在 socket 模块中)

AF_INET() (在 socket 模块中)

AF_INET6() (在 socket 模块中)

AF_LINK() (在 socket 模块中)

AF_PACKET() (在 socket 模块中)

AF_QIPCRTR() (在 socket 模块中)

AF_RDS() (在 socket 模块中)

AF_UNIX() (在 socket 模块中)

AF_VSOCK() (在 socket 模块中)

aifc

模块

aifc() (aifc.aifc 方法)

AIFF, [1]

aiff() (aifc.aifc 方法)

AIFF-C, [1]

aiter()

內置函数

alarm() (在 signal 模块中)

alaw2lin() (在 audioop 模块中)

ALERT_DESCRIPTION_HANDSHAKE_FAILURE() (在 ssl 模块中)

ALERT_DESCRIPTION_INTERNAL_ERROR() (在 ssl 模块中)

AlertDescription (ssl 中的类)

algorithms_available() (在 hashlib 模块中)

algorithms_guaranteed() (在 hashlib 模块中)

Alias

Generic

alias (ast 中的类)

(pdb command)

alignment() (在 ctypes 模块中)

alive (weakref.finalize 属性)

all()

內置函数

all_errors() (在 ftplib 模块中)

all_features() (在 xml.sax.handler 模块中)

all_frames (tracemalloc.Filter 属性)

all_properties() (在 xml.sax.handler 模块中)

all_suffixes() (在 importlib.machinery 模块中)

all_tasks() (在 asyncio 模块中)

allocate_lock() (在 _thread 模块中)

allocfunc (C type)

ALLOW_MISSING() (在 os.path 模块中)

allow_reuse_address (socketserver.BaseServer 属性)

allowed_domains() (http.cookiejar.DefaultCookiePolicy 方法)

alt() (在 curses.ascii 模块中)

ALT_DIGITS() (在 locale 模块中)

altsep() (在 os 模块中)

altzone() (在 time 模块中)

ALWAYS_EQ() (在 test.support 模块中)

ALWAYS_TYPED_ACTIONS (optparse.Option 属性)

AMPER() (在 token 模块中)

AMPEREQUAL() (在 token 模块中)

anchor (pathlib.PurePath 属性)

and

bitwise

运算符, [1], [2]

And (ast 中的类)

and_() (在 operator 模块中)

anext()

內置函数

AnnAssign (ast 中的类)

annotated

assignment

Annotated() (在 typing 模块中)

annotation

type annotation; type hint

annotation (inspect.Parameter 属性)

annotation -- 标注

annotations

function, [1]

announce() (distutils.ccompiler.CCompiler 方法)

anonymous

function

answer_challenge() (在 multiprocessing.connection 模块中)

anticipate_failure() (在 test.support 模块中)

any()

內置函数

Any() (在 typing 模块中)

ANY() (在 unittest.mock 模块中)

AnyStr() (在 typing 模块中)

api_version() (在 sys 模块中)

apilevel() (在 sqlite3 模块中)

apop() (poplib.POP3 方法)

APPDATA

append() (array.array 方法)

(collections.deque 方法)

(email.header.Header 方法)

(imaplib.IMAP4 方法)

(msilib.CAB 方法)

(pipes.Template 方法)

(sequence method)

(xml.etree.ElementTree.Element 方法)

append_history_file() (在 readline 模块中)

appendChild() (xml.dom.Node 方法)

appendleft() (collections.deque 方法)

application_uri() (在 wsgiref.util 模块中)

apply (2to3 fixer)

apply() (multiprocessing.pool.Pool 方法)

apply_async() (multiprocessing.pool.Pool 方法)

apply_defaults() (inspect.BoundArguments 方法)

architecture() (在 platform 模块中)

archive (zipimport.zipimporter 属性)

aRepr() (在 reprlib 模块中)

arg (ast 中的类)

argparse

模块

args (BaseException 属性)

(functools.partial 属性)

(inspect.BoundArguments 属性)

(pdb command)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

(typing.ParamSpec 属性)

args_from_interpreter_flags() (在 test.support 模块中)

argtypes (ctypes._FuncPtr 属性)

argument

call semantics

difference from parameter

function

function definition

argument -- 参数

ArgumentDefaultsHelpFormatter (argparse 中的类)

ArgumentError

ArgumentParser (argparse 中的类)

arguments (ast 中的类)

(inspect.BoundArguments 属性)

argv (in module sys)

argv() (在 sys 模块中)

arithmetic

conversion

operation, binary

operation, unary

ArithmeticError

array

模块, [1], [2]

array (array 中的类)

Array (ctypes 中的类)

Array() (multiprocessing.managers.SyncManager 方法)

(在 multiprocessing 模块中)

(在 multiprocessing.sharedctypes 模块中)

arrays

arraysize (sqlite3.Cursor 属性)

article() (nntplib.NNTP 方法)

as

except clause

import statement

match statement

with statement

关键字, [1], [2], [3]

AS pattern, OR pattern, capture pattern, wildcard pattern

as_bytes() (email.message.EmailMessage 方法)

(email.message.Message 方法)

as_completed() (在 asyncio 模块中)

(在 concurrent.futures 模块中)

as_file() (在 importlib.resources 模块中)

as_integer_ratio() (decimal.Decimal 方法)

(float 方法)

(fractions.Fraction 方法)

(int 方法)

as_posix() (pathlib.PurePath 方法)

as_string() (email.message.EmailMessage 方法)

(email.message.Message 方法)

as_tuple() (decimal.Decimal 方法)

as_uri() (pathlib.PurePath 方法)

ASCII, [1]

ascii

內置函数

ascii()

內置函数

ascii() (在 curses.ascii 模块中)

ASCII() (在 re 模块中)

ascii_letters() (在 string 模块中)

ascii_lowercase() (在 string 模块中)

ascii_uppercase() (在 string 模块中)

asctime() (在 time 模块中)

asdict() (在 dataclasses 模块中)

asend() (agen 方法)

asin() (在 cmath 模块中)

(在 math 模块中)

asinh() (在 cmath 模块中)

(在 math 模块中)

askcolor() (在 tkinter.colorchooser 模块中)

askdirectory() (在 tkinter.filedialog 模块中)

askfloat() (在 tkinter.simpledialog 模块中)

askinteger() (在 tkinter.simpledialog 模块中)

askokcancel() (在 tkinter.messagebox 模块中)

askopenfile() (在 tkinter.filedialog 模块中)

askopenfilename() (在 tkinter.filedialog 模块中)

askopenfilenames() (在 tkinter.filedialog 模块中)

askopenfiles() (在 tkinter.filedialog 模块中)

askquestion() (在 tkinter.messagebox 模块中)

askretrycancel() (在 tkinter.messagebox 模块中)

asksaveasfile() (在 tkinter.filedialog 模块中)

asksaveasfilename() (在 tkinter.filedialog 模块中)

askstring() (在 tkinter.simpledialog 模块中)

askyesno() (在 tkinter.messagebox 模块中)

askyesnocancel() (在 tkinter.messagebox 模块中)

assert

语句, [1]

Assert (ast 中的类)

assert_any_await() (unittest.mock.AsyncMock 方法)

assert_any_call() (unittest.mock.Mock 方法)

assert_awaited() (unittest.mock.AsyncMock 方法)

assert_awaited_once() (unittest.mock.AsyncMock 方法)

assert_awaited_once_with() (unittest.mock.AsyncMock 方法)

assert_awaited_with() (unittest.mock.AsyncMock 方法)

assert_called() (unittest.mock.Mock 方法)

assert_called_once() (unittest.mock.Mock 方法)

assert_called_once_with() (unittest.mock.Mock 方法)

assert_called_with() (unittest.mock.Mock 方法)

assert_has_awaits() (unittest.mock.AsyncMock 方法)

assert_has_calls() (unittest.mock.Mock 方法)

assert_not_awaited() (unittest.mock.AsyncMock 方法)

assert_not_called() (unittest.mock.Mock 方法)

assert_python_failure() (在 test.support.script_helper 模块中)

assert_python_ok() (在 test.support.script_helper 模块中)

assertAlmostEqual() (unittest.TestCase 方法)

assertCountEqual() (unittest.TestCase 方法)

assertDictEqual() (unittest.TestCase 方法)

assertEqual() (unittest.TestCase 方法)

assertFalse() (unittest.TestCase 方法)

assertGreater() (unittest.TestCase 方法)

assertGreaterEqual() (unittest.TestCase 方法)

assertIn() (unittest.TestCase 方法)

assertInBytecode() (test.support.bytecode_helper.BytecodeTestCase 方法)

AssertionError

例外

assertions

debugging

assertIs() (unittest.TestCase 方法)

assertIsInstance() (unittest.TestCase 方法)

assertIsNone() (unittest.TestCase 方法)

assertIsNot() (unittest.TestCase 方法)

assertIsNotNone() (unittest.TestCase 方法)

assertLess() (unittest.TestCase 方法)

assertLessEqual() (unittest.TestCase 方法)

assertListEqual() (unittest.TestCase 方法)

assertLogs() (unittest.TestCase 方法)

assertMultiLineEqual() (unittest.TestCase 方法)

assertNoLogs() (unittest.TestCase 方法)

assertNotAlmostEqual() (unittest.TestCase 方法)

assertNotEqual() (unittest.TestCase 方法)

assertNotIn() (unittest.TestCase 方法)

assertNotInBytecode() (test.support.bytecode_helper.BytecodeTestCase 方法)

assertNotIsInstance() (unittest.TestCase 方法)

assertNotRegex() (unittest.TestCase 方法)

assertRaises() (unittest.TestCase 方法)

assertRaisesRegex() (unittest.TestCase 方法)

assertRegex() (unittest.TestCase 方法)

asserts (2to3 fixer)

assertSequenceEqual() (unittest.TestCase 方法)

assertSetEqual() (unittest.TestCase 方法)

assertTrue() (unittest.TestCase 方法)

assertTupleEqual() (unittest.TestCase 方法)

assertWarns() (unittest.TestCase 方法)

assertWarnsRegex() (unittest.TestCase 方法)

Assign (ast 中的类)

assignment

annotated

attribute, [1]

augmented

class attribute

class instance attribute

slice

slicing

statement, [1]

subscript

subscription

target list

assignment expression

ast

模块

AST (ast 中的类)

ast command line option

--help

--include-attributes

--indent <indent>

--mode <mode>

--no-type-comments

-a

-h

-i <indent>

-m <mode>

astimezone() (datetime.datetime 方法)

astuple() (在 dataclasses 模块中)

async

关键字

async def

语句

async for

in comprehensions

语句

async with

语句

ASYNC() (在 token 模块中)

async_chat (asynchat 中的类)

async_chat.ac_in_buffer_size() (在 asynchat 模块中)

async_chat.ac_out_buffer_size() (在 asynchat 模块中)

AsyncContextDecorator (contextlib 中的类)

AsyncContextManager (typing 中的类)

asynccontextmanager() (在 contextlib 模块中)

AsyncExitStack (contextlib 中的类)

AsyncFor (ast 中的类)

AsyncFunctionDef (ast 中的类)

AsyncGenerator (collections.abc 中的类)

(typing 中的类)

AsyncGeneratorType() (在 types 模块中)

asynchat

模块

asynchronous context manager -- 异步上下文管理器

asynchronous generator

asynchronous iterator

function

asynchronous generator -- 异步生成器

asynchronous generator iterator -- 异步生成器迭代器

asynchronous iterable -- 异步可迭代对象

asynchronous iterator -- 异步迭代器

asynchronous-generator

对象

asyncio

模块

asyncio.subprocess.DEVNULL (內置变量)

asyncio.subprocess.PIPE (內置变量)

asyncio.subprocess.Process (內置类)

asyncio.subprocess.STDOUT (內置变量)

AsyncIterable (collections.abc 中的类)

(typing 中的类)

AsyncIterator (collections.abc 中的类)

(typing 中的类)

AsyncMock (unittest.mock 中的类)

asyncore

模块

AsyncResult (multiprocessing.pool 中的类)

asyncSetUp() (unittest.IsolatedAsyncioTestCase 方法)

asyncTearDown() (unittest.IsolatedAsyncioTestCase 方法)

AsyncWith (ast 中的类)

AT() (在 token 模块中)

at_eof() (asyncio.StreamReader 方法)

atan() (在 cmath 模块中)

(在 math 模块中)

atan2() (在 math 模块中)

atanh() (在 cmath 模块中)

(在 math 模块中)

ATEQUAL() (在 token 模块中)

atexit

模块

atexit (weakref.finalize 属性)

athrow() (agen 方法)

atof() (在 locale 模块中)

atoi() (在 locale 模块中)

atom

attach() (email.message.Message 方法)

attach_loop() (asyncio.AbstractChildWatcher 方法)

attach_mock() (unittest.mock.Mock 方法)

AttlistDeclHandler() (xml.parsers.expat.xmlparser 方法)

attrgetter() (在 operator 模块中)

attrib (xml.etree.ElementTree.Element 属性)

attribute

assignment, [1]

assignment, class

assignment, class instance

class

class instance

deletion

generic special

reference

special

Attribute (ast 中的类)

attribute -- 属性

AttributeError

例外

attributes (xml.dom.Node 属性)

AttributesImpl (xml.sax.xmlreader 中的类)

AttributesNSImpl (xml.sax.xmlreader 中的类)

attroff() (curses.window 方法)

attron() (curses.window 方法)

attrset() (curses.window 方法)

Audio Interchange File Format, [1]

AUDIO_FILE_ENCODING_ADPCM_G721() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ADPCM_G722() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ADPCM_G723_3() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ADPCM_G723_5() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ALAW_8() (在 sunau 模块中)

AUDIO_FILE_ENCODING_DOUBLE() (在 sunau 模块中)

AUDIO_FILE_ENCODING_FLOAT() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_16() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_24() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_32() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_8() (在 sunau 模块中)

AUDIO_FILE_ENCODING_MULAW_8() (在 sunau 模块中)

AUDIO_FILE_MAGIC() (在 sunau 模块中)

AUDIODEV

audioop

模块

audit events

audit() (在 sys 模块中)

auditing

AugAssign (ast 中的类)

augmented

assignment

auth() (ftplib.FTP_TLS 方法)

(smtplib.SMTP 方法)

authenticate() (imaplib.IMAP4 方法)

AuthenticationError

authenticators() (netrc.netrc 方法)

authkey (multiprocessing.Process 属性)

auto (enum 中的类)

autorange() (timeit.Timer 方法)

available_timezones() (在 zoneinfo 模块中)

avg() (在 audioop 模块中)

avgpp() (在 audioop 模块中)

avoids_symlink_attacks (shutil.rmtree 属性)

await

in comprehensions

关键字, [1]

Await (ast 中的类)

AWAIT() (在 token 模块中)

await_args (unittest.mock.AsyncMock 属性)

await_args_list (unittest.mock.AsyncMock 属性)

await_count (unittest.mock.AsyncMock 属性)

Awaitable (collections.abc 中的类)

(typing 中的类)

awaitable -- 可等待对象

索引 – B

b"

bytes literal

b'

bytes literal

b16decode() (在 base64 模块中)

b16encode() (在 base64 模块中)

b2a_base64() (在 binascii 模块中)

b2a_hex() (在 binascii 模块中)

b2a_hqx() (在 binascii 模块中)

b2a_qp() (在 binascii 模块中)

b2a_uu() (在 binascii 模块中)

b32decode() (在 base64 模块中)

b32encode() (在 base64 模块中)

b32hexdecode() (在 base64 模块中)

b32hexencode() (在 base64 模块中)

b64decode() (在 base64 模块中)

b64encode() (在 base64 模块中)

b85decode() (在 base64 模块中)

b85encode() (在 base64 模块中)

Babyl (mailbox 中的类)

BabylMessage (mailbox 中的类)

back() (在 turtle 模块中)

backslash character

backslashreplace

error handler's name

backslashreplace_errors() (在 codecs 模块中)

backup() (sqlite3.Connection 方法)

backward() (在 turtle 模块中)

BadGzipFile

BadStatusLine

BadZipFile

BadZipfile

Balloon (tkinter.tix 中的类)

Barrier (multiprocessing 中的类)

(threading 中的类)

Barrier() (multiprocessing.managers.SyncManager 方法)

base64

encoding

模块, [1]

base_exec_prefix() (在 sys 模块中)

base_prefix() (在 sys 模块中)

BaseCGIHandler (wsgiref.handlers 中的类)

BaseCookie (http.cookies 中的类)

BaseException

BaseHandler (urllib.request 中的类)

(wsgiref.handlers 中的类)

BaseHeader (email.headerregistry 中的类)

BaseHTTPRequestHandler (http.server 中的类)

BaseManager (multiprocessing.managers 中的类)

basename() (在 os.path 模块中)

BaseProtocol (asyncio 中的类)

BaseProxy (multiprocessing.managers 中的类)

BaseRequestHandler (socketserver 中的类)

BaseRotatingHandler (logging.handlers 中的类)

BaseSelector (selectors 中的类)

BaseServer (socketserver 中的类)

basestring (2to3 fixer)

BaseTransport (asyncio 中的类)

basicConfig() (在 logging 模块中)

BasicContext (decimal 中的类)

BasicInterpolation (configparser 中的类)

BasicTestRunner (test.support 中的类)

baudrate() (在 curses 模块中)

bbox() (tkinter.ttk.Treeview 方法)

BDADDR_ANY() (在 socket 模块中)

BDADDR_LOCAL() (在 socket 模块中)

bdb

模块, [1]

Bdb (bdb 中的类)

BdbQuit

BDFL

bdist_msi (distutils.command.bdist_msi 中的类)

beep() (在 curses 模块中)

Beep() (在 winsound 模块中)

BEFORE_ASYNC_WITH (opcode)

begin_fill() (在 turtle 模块中)

begin_poly() (在 turtle 模块中)

below() (curses.panel.Panel 方法)

BELOW_NORMAL_PRIORITY_CLASS() (在 subprocess 模块中)

Benchmarking

benchmarking, [1], [2]

betavariate() (在 random 模块中)

bgcolor() (在 turtle 模块中)

bgpic() (在 turtle 模块中)

bias() (在 audioop 模块中)

bidirectional() (在 unicodedata 模块中)

bigaddrspacetest() (在 test.support 模块中)

BigEndianStructure (ctypes 中的类)

bigmemtest() (在 test.support 模块中)

bin()

內置函数

binary

arithmetic operation

bitwise operation

data, packing

literals

Binary (msilib 中的类)

(xmlrpc.client 中的类)

binary file -- 二进制文件

binary literal

binary mode

binary semaphores

BINARY_ADD (opcode)

BINARY_AND (opcode)

BINARY_FLOOR_DIVIDE (opcode)

BINARY_LSHIFT (opcode)

BINARY_MATRIX_MULTIPLY (opcode)

BINARY_MODULO (opcode)

BINARY_MULTIPLY (opcode)

BINARY_OR (opcode)

BINARY_POWER (opcode)

BINARY_RSHIFT (opcode)

BINARY_SUBSCR (opcode)

BINARY_SUBTRACT (opcode)

BINARY_TRUE_DIVIDE (opcode)

BINARY_XOR (opcode)

binaryfunc (C type)

BinaryIO (typing 中的类)

binascii

模块

bind (widgets)

bind() (asyncore.dispatcher 方法)

(inspect.Signature 方法)

(socket.socket 方法)

bind_partial() (inspect.Signature 方法)

bind_port() (在 test.support.socket_helper 模块中)

bind_textdomain_codeset() (在 gettext 模块中)

bind_unix_socket() (在 test.support.socket_helper 模块中)

binding

global name

name, [1], [2], [3], [4], [5], [6]

bindtextdomain() (在 gettext 模块中)

(在 locale 模块中)

binhex

模块, [1]

binhex() (在 binhex 模块中)

BinOp (ast 中的类)

bisect

模块

bisect() (在 bisect 模块中)

bisect_left() (在 bisect 模块中)

bisect_right() (在 bisect 模块中)

bit_count() (int 方法)

bit_length() (int 方法)

BitAnd (ast 中的类)

bitmap() (msilib.Dialog 方法)

BitOr (ast 中的类)

bitwise

and

operation, binary

operation, unary

operations

or

xor

BitXor (ast 中的类)

bk() (在 turtle 模块中)

bkgd() (curses.window 方法)

bkgdset() (curses.window 方法)

blake2b() (在 hashlib 模块中)

blake2b, blake2s

blake2b.MAX_DIGEST_SIZE() (在 hashlib 模块中)

blake2b.MAX_KEY_SIZE() (在 hashlib 模块中)

blake2b.PERSON_SIZE() (在 hashlib 模块中)

blake2b.SALT_SIZE() (在 hashlib 模块中)

blake2s() (在 hashlib 模块中)

blake2s.MAX_DIGEST_SIZE() (在 hashlib 模块中)

blake2s.MAX_KEY_SIZE() (在 hashlib 模块中)

blake2s.PERSON_SIZE() (在 hashlib 模块中)

blake2s.SALT_SIZE() (在 hashlib 模块中)

blank line

block

code

block_size (hmac.HMAC 属性)

blocked_domains() (http.cookiejar.DefaultCookiePolicy 方法)

BlockingIOError, [1]

blocksize (http.client.HTTPConnection 属性)

BNF, [1]

body() (nntplib.NNTP 方法)

(tkinter.simpledialog.Dialog 方法)

body_encode() (email.charset.Charset 方法)

body_encoding (email.charset.Charset 属性)

body_line_iterator() (在 email.iterators 模块中)

BOLD() (在 tkinter.font 模块中)

BOM() (在 codecs 模块中)

BOM_BE() (在 codecs 模块中)

BOM_LE() (在 codecs 模块中)

BOM_UTF16() (在 codecs 模块中)

BOM_UTF16_BE() (在 codecs 模块中)

BOM_UTF16_LE() (在 codecs 模块中)

BOM_UTF32() (在 codecs 模块中)

BOM_UTF32_BE() (在 codecs 模块中)

BOM_UTF32_LE() (在 codecs 模块中)

BOM_UTF8() (在 codecs 模块中)

bool (內置类)

Boolean

operation

operations, [1]

type

values

对象, [1]

BOOLEAN_STATES (configparser.ConfigParser 属性)

BoolOp (ast 中的类)

bootstrap() (在 ensurepip 模块中)

border() (curses.window 方法)

borrowed reference -- 借入引用

bottom() (curses.panel.Panel 方法)

bottom_panel() (在 curses.panel 模块中)

BoundArguments (inspect 中的类)

BoundaryError

BoundedSemaphore (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

BoundedSemaphore() (multiprocessing.managers.SyncManager 方法)

box() (curses.window 方法)

bpbynumber (bdb.Breakpoint 属性)

bpformat() (bdb.Breakpoint 方法)

bplist (bdb.Breakpoint 属性)

bpprint() (bdb.Breakpoint 方法)

break

语句, [1], [2], [3], [4]

Break (ast 中的类)

break (pdb command)

break_anywhere() (bdb.Bdb 方法)

break_here() (bdb.Bdb 方法)

break_long_words (textwrap.TextWrapper 属性)

break_on_hyphens (textwrap.TextWrapper 属性)

Breakpoint (bdb 中的类)

breakpoint()

內置函数

breakpointhook() (在 sys 模块中)

breakpoints

broadcast_address (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

broken (threading.Barrier 属性)

BrokenBarrierError

BrokenExecutor

BrokenPipeError

BrokenProcessPool

BrokenThreadPool

BROWSER, [1]

BsdDbShelf (shelve 中的类)

buf (multiprocessing.shared_memory.SharedMemory 属性)

buffer (2to3 fixer)

(io.TextIOBase 属性)

(unittest.TestResult 属性)

buffer interface

(see buffer protocol)

buffer object

(see buffer protocol)

buffer protocol

binary sequence types

str (built-in class)

buffer size, I/O

buffer_info() (array.array 方法)

buffer_size (xml.parsers.expat.xmlparser 属性)

buffer_text (xml.parsers.expat.xmlparser 属性)

buffer_updated() (asyncio.BufferedProtocol 方法)

buffer_used (xml.parsers.expat.xmlparser 属性)

BufferedIOBase (io 中的类)

BufferedProtocol (asyncio 中的类)

BufferedRandom (io 中的类)

BufferedReader (io 中的类)

BufferedRWPair (io 中的类)

BufferedWriter (io 中的类)

BufferError

BufferingFormatter (logging 中的类)

BufferingHandler (logging.handlers 中的类)

BufferTooShort

bufsize() (ossaudiodev.oss_audio_device 方法)

BUILD_CONST_KEY_MAP (opcode)

BUILD_LIST (opcode)

BUILD_MAP (opcode)

build_opener() (在 urllib.request 模块中)

build_py (distutils.command.build_py 中的类)

build_py_2to3 (distutils.command.build_py 中的类)

BUILD_SET (opcode)

BUILD_SLICE (opcode)

BUILD_STRING (opcode)

BUILD_TUPLE (opcode)

built-in

method

types

built-in function

call

对象, [1]

built-in method

call

对象, [1]

builtin_module_names() (在 sys 模块中)

BuiltinFunctionType() (在 types 模块中)

BuiltinImporter (importlib.machinery 中的类)

BuiltinMethodType() (在 types 模块中)

builtins

模块, [1], [2], [3], [4], [5]

ButtonBox (tkinter.tix 中的类)

buttonbox() (tkinter.simpledialog.Dialog 方法)

bye() (在 turtle 模块中)

byref() (在 ctypes 模块中)

byte

byte-code

file, [1]

byte_compile() (在 distutils.util 模块中)

bytearray

formatting

interpolation

methods

对象, [1], [2], [3]

bytearray (內置类)

bytecode

Bytecode (dis 中的类)

bytecode -- 字节码

Bytecode.codeobj() (在 dis 模块中)

Bytecode.first_line() (在 dis 模块中)

BYTECODE_SUFFIXES() (在 importlib.machinery 模块中)

BytecodeTestCase (test.support.bytecode_helper 中的类)

byteorder() (在 sys 模块中)

bytes

formatting

interpolation

methods

str (built-in class)

內置函数, [1]

对象, [1], [2]

bytes (uuid.UUID 属性)

(內置类)

bytes literal

bytes-like object -- 字节型对象

bytes_le (uuid.UUID 属性)

BytesFeedParser (email.parser 中的类)

BytesGenerator (email.generator 中的类)

BytesHeaderParser (email.parser 中的类)

BytesIO (io 中的类)

BytesParser (email.parser 中的类)

ByteString (collections.abc 中的类)

(typing 中的类)

byteswap() (array.array 方法)

(在 audioop 模块中)

BytesWarning

bz2

模块

BZ2Compressor (bz2 中的类)

BZ2Decompressor (bz2 中的类)

BZ2File (bz2 中的类)

索引 – C

C

language, [1], [2], [3], [4]

structures

C-contiguous, [1]

C14NWriterTarget (xml.etree.ElementTree 中的类)

c_bool (ctypes 中的类)

C_BUILTIN() (在 imp 模块中)

c_byte (ctypes 中的类)

c_char (ctypes 中的类)

c_char_p (ctypes 中的类)

c_contiguous (memoryview 属性)

c_double (ctypes 中的类)

C_EXTENSION() (在 imp 模块中)

c_float (ctypes 中的类)

c_int (ctypes 中的类)

c_int16 (ctypes 中的类)

c_int32 (ctypes 中的类)

c_int64 (ctypes 中的类)

c_int8 (ctypes 中的类)

c_long (ctypes 中的类)

c_longdouble (ctypes 中的类)

c_longlong (ctypes 中的类)

c_short (ctypes 中的类)

c_size_t (ctypes 中的类)

c_ssize_t (ctypes 中的类)

c_ubyte (ctypes 中的类)

c_uint (ctypes 中的类)

c_uint16 (ctypes 中的类)

c_uint32 (ctypes 中的类)

c_uint64 (ctypes 中的类)

c_uint8 (ctypes 中的类)

c_ulong (ctypes 中的类)

c_ulonglong (ctypes 中的类)

c_ushort (ctypes 中的类)

c_void_p (ctypes 中的类)

c_wchar (ctypes 中的类)

c_wchar_p (ctypes 中的类)

CAB (msilib 中的类)

cache() (在 functools 模块中)

cache_from_source() (在 imp 模块中)

(在 importlib.util 模块中)

cached (importlib.machinery.ModuleSpec 属性)

cached_property() (在 functools 模块中)

CacheFTPHandler (urllib.request 中的类)

calcobjsize() (在 test.support 模块中)

calcsize() (在 struct 模块中)

calcvobjsize() (在 test.support 模块中)

calendar

模块

Calendar (calendar 中的类)

calendar() (在 calendar 模块中)

call

built-in function

built-in method

class instance

class object, [1], [2]

function, [1], [2]

instance, [1]

method

procedure

user-defined function

Call (ast 中的类)

call() (在 subprocess 模块中)

(在 unittest.mock 模块中)

call_args (unittest.mock.Mock 属性)

call_args_list (unittest.mock.Mock 属性)

call_at() (asyncio.loop 方法)

call_count (unittest.mock.Mock 属性)

call_exception_handler() (asyncio.loop 方法)

CALL_FUNCTION (opcode)

CALL_FUNCTION_EX (opcode)

CALL_FUNCTION_KW (opcode)

call_later() (asyncio.loop 方法)

call_list() (unittest.mock.call 方法)

CALL_METHOD (opcode)

call_soon() (asyncio.loop 方法)

call_soon_threadsafe() (asyncio.loop 方法)

call_tracing() (在 sys 模块中)

callable

对象, [1]

Callable (collections.abc 中的类)

callable -- 可调用对象

callable()

內置函数

Callable() (在 typing 模块中)

CallableProxyType() (在 weakref 模块中)

callback (optparse.Option 属性)

callback -- 回调

callback() (contextlib.ExitStack 方法)

callback_args (optparse.Option 属性)

callback_kwargs (optparse.Option 属性)

callbacks() (在 gc 模块中)

called (unittest.mock.Mock 属性)

CalledProcessError

calloc()

CAN_BCM() (在 socket 模块中)

can_change_color() (在 curses 模块中)

can_fetch() (urllib.robotparser.RobotFileParser 方法)

CAN_ISOTP() (在 socket 模块中)

CAN_J1939() (在 socket 模块中)

CAN_RAW_FD_FRAMES() (在 socket 模块中)

CAN_RAW_JOIN_FILTERS() (在 socket 模块中)

can_symlink() (在 test.support.os_helper 模块中)

can_write_eof() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

can_xattr() (在 test.support.os_helper 模块中)

cancel() (asyncio.Future 方法)

(asyncio.Handle 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

(sched.scheduler 方法)

(threading.Timer 方法)

(tkinter.dnd.DndHandler 方法)

cancel_command() (tkinter.filedialog.FileDialog 方法)

cancel_dump_traceback_later() (在 faulthandler 模块中)

cancel_join_thread() (multiprocessing.Queue 方法)

cancelled() (asyncio.Future 方法)

(asyncio.Handle 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

CancelledError, [1]

CannotSendHeader

CannotSendRequest

canonic() (bdb.Bdb 方法)

canonical() (decimal.Context 方法)

(decimal.Decimal 方法)

canonicalize() (在 xml.etree.ElementTree 模块中)

capa() (poplib.POP3 方法)

capitalize() (bytearray 方法)

(bytes 方法)

(str 方法)

Capsule

对象

captured_stderr() (在 test.support 模块中)

captured_stdin() (在 test.support 模块中)

captured_stdout() (在 test.support 模块中)

captureWarnings() (在 logging 模块中)

capwords() (在 string 模块中)

case

match

关键字

case block

casefold() (str 方法)

cast() (memoryview 方法)

(在 ctypes 模块中)

(在 typing 模块中)

cat() (在 nis 模块中)

catch_threading_exception() (在 test.support.threading_helper 模块中)

catch_unraisable_exception() (在 test.support 模块中)

catch_warnings (warnings 中的类)

category() (在 unicodedata 模块中)

cbreak() (在 curses 模块中)

CC

ccc() (ftplib.FTP_TLS 方法)

CCompiler (distutils.ccompiler 中的类)

cdf() (statistics.NormalDist 方法)

CDLL (ctypes 中的类)

ceil() (in module math)

(在 math 模块中)

CellType() (在 types 模块中)

center() (bytearray 方法)

(bytes 方法)

(str 方法)

CERT_NONE() (在 ssl 模块中)

CERT_OPTIONAL() (在 ssl 模块中)

CERT_REQUIRED() (在 ssl 模块中)

cert_store_stats() (ssl.SSLContext 方法)

cert_time_to_seconds() (在 ssl 模块中)

CertificateError

certificates

CFLAGS, [1], [2], [3], [4], [5], [6], [7]

CFLAGS_NODIST, [1], [2]

CFUNCTYPE() (在 ctypes 模块中)

cget() (tkinter.font.Font 方法)

CGI

debugging

exceptions

protocol

security

tracebacks

cgi

模块

cgi_directories (http.server.CGIHTTPRequestHandler 属性)

CGIHandler (wsgiref.handlers 中的类)

CGIHTTPRequestHandler (http.server 中的类)

cgitb

模块

CGIXMLRPCRequestHandler (xmlrpc.server 中的类)

chain() (在 itertools 模块中)

chaining

comparisons, [1]

exception

ChainMap (collections 中的类)

(typing 中的类)

change_cwd() (在 test.support.os_helper 模块中)

change_root() (在 distutils.util 模块中)

CHANNEL_BINDING_TYPES() (在 ssl 模块中)

channel_class (smtpd.SMTPServer 属性)

channels() (ossaudiodev.oss_audio_device 方法)

CHAR_MAX() (在 locale 模块中)

character, [1], [2]

CharacterDataHandler() (xml.parsers.expat.xmlparser 方法)

characters() (xml.sax.handler.ContentHandler 方法)

characters_written (BlockingIOError 属性)

Charset (email.charset 中的类)

charset() (gettext.NullTranslations 方法)

chdir() (在 os 模块中)

check (lzma.LZMADecompressor 属性)

check() (imaplib.IMAP4 方法)

(在 tabnanny 模块中)

check__all__() (在 test.support 模块中)

check_call() (在 subprocess 模块中)

check_disallow_instantiation() (在 test.support 模块中)

check_environ() (在 distutils.util 模块中)

check_free_after_iterating() (在 test.support 模块中)

check_hostname (ssl.SSLContext 属性)

check_impl_detail() (在 test.support 模块中)

check_no_resource_warning() (在 test.support.warnings_helper 模块中)

check_output() (doctest.OutputChecker 方法)

(在 subprocess 模块中)

check_returncode() (subprocess.CompletedProcess 方法)

check_syntax_error() (在 test.support 模块中)

check_syntax_warning() (在 test.support.warnings_helper 模块中)

check_unused_args() (string.Formatter 方法)

check_warnings() (在 test.support.warnings_helper 模块中)

checkbox() (msilib.Dialog 方法)

checkcache() (在 linecache 模块中)

CHECKED_HASH (py_compile.PycInvalidationMode 属性)

checkfuncname() (在 bdb 模块中)

CheckList (tkinter.tix 中的类)

checksizeof() (在 test.support 模块中)

checksum

Cyclic Redundancy Check

chflags() (在 os 模块中)

chgat() (curses.window 方法)

childNodes (xml.dom.Node 属性)

ChildProcessError

children (pyclbr.Class 属性)

(pyclbr.Function 属性)

(tkinter.Tk 属性)

chmod() (pathlib.Path 方法)

(在 os 模块中)

choice() (在 random 模块中)

(在 secrets 模块中)

choices (optparse.Option 属性)

choices() (在 random 模块中)

Chooser (tkinter.colorchooser 中的类)

chown() (在 os 模块中)

(在 shutil 模块中)

chr

內置函数

chr()

內置函数

chroot() (在 os 模块中)

chunk

模块

Chunk (chunk 中的类)

cipher

DES

cipher() (ssl.SSLSocket 方法)

circle() (在 turtle 模块中)

CIRCUMFLEX() (在 token 模块中)

CIRCUMFLEXEQUAL() (在 token 模块中)

Clamped (decimal 中的类)

class

attribute

attribute assignment

body

constructor

definition, [1]

instance

name

对象, [1], [2]

语句

Class (symtable 中的类)

class instance

attribute

attribute assignment

call

对象, [1], [2]

class object

call, [1], [2]

class variable -- 类变量

ClassDef (ast 中的类)

classmethod

內置函数

classmethod()

內置函数

ClassMethodDescriptorType() (在 types 模块中)

ClassVar() (在 typing 模块中)

clause

CLD_CONTINUED() (在 os 模块中)

CLD_DUMPED() (在 os 模块中)

CLD_EXITED() (在 os 模块中)

CLD_KILLED() (在 os 模块中)

CLD_STOPPED() (在 os 模块中)

CLD_TRAPPED() (在 os 模块中)

clean() (mailbox.Maildir 方法)

cleandoc() (在 inspect 模块中)

CleanImport (test.support.import_helper 中的类)

cleanup functions

clear (pdb command)

Clear Breakpoint

clear() (asyncio.Event 方法)

(collections.deque 方法)

(curses.window 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(frame 方法)

(frozenset 方法)

(http.cookiejar.CookieJar 方法)

(mailbox.Mailbox 方法)

(sequence method)

(threading.Event 方法)

(xml.etree.ElementTree.Element 方法)

(在 turtle 模块中)

clear_all_breaks() (bdb.Bdb 方法)

clear_all_file_breaks() (bdb.Bdb 方法)

clear_bpbynumber() (bdb.Bdb 方法)

clear_break() (bdb.Bdb 方法)

clear_cache() (zoneinfo.ZoneInfo 类方法)

(在 filecmp 模块中)

clear_content() (email.message.EmailMessage 方法)

clear_flags() (decimal.Context 方法)

clear_frames() (在 traceback 模块中)

clear_history() (在 readline 模块中)

clear_session_cookies() (http.cookiejar.CookieJar 方法)

clear_traces() (在 tracemalloc 模块中)

clear_traps() (decimal.Context 方法)

clearcache() (在 linecache 模块中)

ClearData() (msilib.Record 方法)

clearok() (curses.window 方法)

clearscreen() (在 turtle 模块中)

clearstamp() (在 turtle 模块中)

clearstamps() (在 turtle 模块中)

Client() (在 multiprocessing.connection 模块中)

client_address (http.server.BaseHTTPRequestHandler 属性)

CLOCK_BOOTTIME() (在 time 模块中)

clock_getres() (在 time 模块中)

clock_gettime() (在 time 模块中)

clock_gettime_ns() (在 time 模块中)

CLOCK_HIGHRES() (在 time 模块中)

CLOCK_MONOTONIC() (在 time 模块中)

CLOCK_MONOTONIC_RAW() (在 time 模块中)

CLOCK_PROCESS_CPUTIME_ID() (在 time 模块中)

CLOCK_PROF() (在 time 模块中)

CLOCK_REALTIME() (在 time 模块中)

clock_settime() (在 time 模块中)

clock_settime_ns() (在 time 模块中)

CLOCK_TAI() (在 time 模块中)

CLOCK_THREAD_CPUTIME_ID() (在 time 模块中)

CLOCK_UPTIME() (在 time 模块中)

CLOCK_UPTIME_RAW() (在 time 模块中)

clone() (email.generator.BytesGenerator 方法)

(email.generator.Generator 方法)

(email.policy.Policy 方法)

(pipes.Template 方法)

(在 turtle 模块中)

cloneNode() (xml.dom.Node 方法)

close() (aifc.aifc 方法)

(asyncio.AbstractChildWatcher 方法)

(asyncio.BaseTransport 方法)

(asyncio.loop 方法)

(asyncio.Server 方法)

(asyncio.StreamWriter 方法)

(asyncio.SubprocessTransport 方法)

(asyncore.dispatcher 方法)

(chunk.Chunk 方法)

(contextlib.ExitStack 方法)

(coroutine 方法)

(dbm.dumb.dumbdbm 方法)

(dbm.gnu.gdbm 方法)

(dbm.ndbm.ndbm 方法)

(distutils.text_file.TextFile 方法)

(email.parser.BytesFeedParser 方法)

(ftplib.FTP 方法)

(generator 方法)

(html.parser.HTMLParser 方法)

(http.client.HTTPConnection 方法)

(imaplib.IMAP4 方法)

(in module os)

(io.IOBase 方法)

(logging.FileHandler 方法)

(logging.Handler 方法)

(logging.handlers.MemoryHandler 方法)

(logging.handlers.NTEventLogHandler 方法)

(logging.handlers.SocketHandler 方法)

(logging.handlers.SysLogHandler 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.MH 方法)

(mmap.mmap 方法)

Close() (msilib.Database 方法)

(msilib.View 方法)

close() (multiprocessing.connection.Connection 方法)

(multiprocessing.connection.Listener 方法)

(multiprocessing.pool.Pool 方法)

(multiprocessing.Process 方法)

(multiprocessing.Queue 方法)

(multiprocessing.shared_memory.SharedMemory 方法)

(multiprocessing.SimpleQueue 方法)

(os.scandir 方法)

(ossaudiodev.oss_audio_device 方法)

(ossaudiodev.oss_mixer_device 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.kqueue 方法)

(selectors.BaseSelector 方法)

(shelve.Shelf 方法)

(socket.socket 方法)

(sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

(sunau.AU_read 方法)

(sunau.AU_write 方法)

(tarfile.TarFile 方法)

(telnetlib.Telnet 方法)

(urllib.request.BaseHandler 方法)

(wave.Wave_read 方法)

(wave.Wave_write 方法)

Close() (winreg.PyHKEY 方法)

close() (xml.etree.ElementTree.TreeBuilder 方法)

(xml.etree.ElementTree.XMLParser 方法)

(xml.etree.ElementTree.XMLPullParser 方法)

(xml.sax.xmlreader.IncrementalParser 方法)

(zipfile.ZipFile 方法)

(在 fileinput 模块中)

(在 os 模块中)

(在 socket 模块中)

close_connection (http.server.BaseHTTPRequestHandler 属性)

close_when_done() (asynchat.async_chat 方法)

closed (http.client.HTTPResponse 属性)

(io.IOBase 属性)

(mmap.mmap 属性)

(ossaudiodev.oss_audio_device 属性)

(select.devpoll 属性)

(select.epoll 属性)

(select.kqueue 属性)

CloseKey() (在 winreg 模块中)

closelog() (在 syslog 模块中)

closerange() (在 os 模块中)

closing() (在 contextlib 模块中)

clrtobot() (curses.window 方法)

clrtoeol() (curses.window 方法)

cmath

模块

cmd

模块, [1]

Cmd (cmd 中的类)

cmd (subprocess.CalledProcessError 属性)

(subprocess.TimeoutExpired 属性)

cmdloop() (cmd.Cmd 方法)

cmdqueue (cmd.Cmd 属性)

cmp() (在 filecmp 模块中)

cmp_op() (在 dis 模块中)

cmp_to_key() (在 functools 模块中)

cmpfiles() (在 filecmp 模块中)

CMSG_LEN() (在 socket 模块中)

CMSG_SPACE() (在 socket 模块中)

co_argcount (code object attribute)

CO_ASYNC_GENERATOR() (在 inspect 模块中)

co_cellvars (code object attribute)

co_code (code object attribute)

co_consts (code object attribute)

CO_COROUTINE() (在 inspect 模块中)

co_filename (code object attribute)

co_firstlineno (code object attribute)

co_flags (code object attribute)

co_freevars (code object attribute)

CO_FUTURE_DIVISION (C var)

CO_GENERATOR() (在 inspect 模块中)

CO_ITERABLE_COROUTINE() (在 inspect 模块中)

co_kwonlyargcount (code object attribute)

co_lnotab (code object attribute)

co_name (code object attribute)

co_names (code object attribute)

CO_NESTED() (在 inspect 模块中)

CO_NEWLOCALS() (在 inspect 模块中)

co_nlocals (code object attribute)

CO_NOFREE() (在 inspect 模块中)

CO_OPTIMIZED() (在 inspect 模块中)

co_posonlyargcount (code object attribute)

co_stacksize (code object attribute)

CO_VARARGS() (在 inspect 模块中)

CO_VARKEYWORDS() (在 inspect 模块中)

co_varnames (code object attribute)

code

block

模块

code (SystemExit 属性)

(urllib.error.HTTPError 属性)

(urllib.response.addinfourl 属性)

(xml.etree.ElementTree.ParseError 属性)

(xml.parsers.expat.ExpatError 属性)

code object, [1], [2], [3]

code_info() (在 dis 模块中)

CodecInfo (codecs 中的类)

Codecs

decode

encode

codecs

模块

coded_value (http.cookies.Morsel 属性)

codeop

模块

codepoint2name() (在 html.entities 模块中)

codes() (在 xml.parsers.expat.errors 模块中)

CODESET() (在 locale 模块中)

CodeType (types 中的类)

coding

style

coercion -- 强制类型转换

col_offset (ast.AST 属性)

collapse_addresses() (在 ipaddress 模块中)

collapse_rfc2231_value() (在 email.utils 模块中)

collect() (在 gc 模块中)

collect_incoming_data() (asynchat.async_chat 方法)

Collection (collections.abc 中的类)

(typing 中的类)

collections

模块

collections.abc

模块

colno (json.JSONDecodeError 属性)

(re.error 属性)

COLON() (在 token 模块中)

COLONEQUAL() (在 token 模块中)

color() (在 turtle 模块中)

color_content() (在 curses 模块中)

color_pair() (在 curses 模块中)

colormode() (在 turtle 模块中)

colorsys

模块

COLS, [1]

column() (tkinter.ttk.Treeview 方法)

COLUMNS, [1]

columns (os.terminal_size 属性)

comb() (在 math 模块中)

combinations() (在 itertools 模块中)

combinations_with_replacement() (在 itertools 模块中)

combine() (datetime.datetime 类方法)

combining() (在 unicodedata 模块中)

ComboBox (tkinter.tix 中的类)

Combobox (tkinter.ttk 中的类)

comma

trailing

COMMA() (在 token 模块中)

Command (distutils.cmd 中的类)

(distutils.core 中的类)

command (http.server.BaseHTTPRequestHandler 属性)

command line

command line option

--check-hash-based-pycs default|always|never

--disable-ipv6

--disable-test-modules

--enable-big-digits=[15|30]

--enable-framework

--enable-framework=INSTALLDIR

--enable-loadable-sqlite-extensions

--enable-optimizations

--enable-profiling

--enable-shared

--enable-universalsdk

--enable-universalsdk=SDKDIR

--exec-prefix=EPREFIX

--help

--prefix=PREFIX

--version

--with-address-sanitizer

--with-assertions

--with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2

--with-computed-gotos

--with-cxx-main

--with-cxx-main=COMPILER

--with-dbmliborder=db1:db2:...

--with-dtrace

--with-ensurepip=[upgrade|install|no]

--with-framework-name=FRAMEWORK

--with-hash-algorithm=[fnv|siphash24]

--with-libc=STRING

--with-libm=STRING

--with-libs='lib1 ...'

--with-lto

--with-memory-sanitizer

--with-openssl-rpath=[no|auto|DIR]

--with-openssl=DIR

--with-platlibdir=DIRNAME

--with-pydebug

--with-readline=editline

--with-ssl-default-suites=[python|openssl|STRING]

--with-suffix=SUFFIX

--with-system-expat

--with-system-ffi

--with-system-libmpdec

--with-tcltk-includes='-I...'

--with-tcltk-libs='-L...'

--with-trace-refs

--with-tzpath=<list of absolute paths separated by pathsep>

--with-undefined-behavior-sanitizer

--with-universal-archs=ARCH

--with-valgrind

--with-wheel-pkg-dir=PATH

--without-c-locale-coercion

--without-decimal-contextvar

--without-doc-strings

--without-pymalloc

--without-readline

--without-static-libpython

-?

-b

-B

-c <command>

-d

-E

-h

-i

-I

-J

-m <module-name>

-O

-OO

-q

-R

-s

-S

-u

-V

-v

-W arg

-x

-X

CommandCompiler (codeop 中的类)

commands (pdb command)

comment

(http.cookiejar.Cookie 属性)

(zipfile.ZipFile 属性)

(zipfile.ZipInfo 属性)

comment() (xml.etree.ElementTree.TreeBuilder 方法)

(xml.sax.handler.LexicalHandler 方法)

COMMENT() (在 token 模块中)

Comment() (在 xml.etree.ElementTree 模块中)

comment_url (http.cookiejar.Cookie 属性)

commenters (shlex.shlex 属性)

CommentHandler() (xml.parsers.expat.xmlparser 方法)

commit() (msilib.CAB 方法)

Commit() (msilib.Database 方法)

commit() (sqlite3.Connection 方法)

common (filecmp.dircmp 属性)

Common Gateway Interface

common_dirs (filecmp.dircmp 属性)

common_files (filecmp.dircmp 属性)

common_funny (filecmp.dircmp 属性)

common_types() (在 mimetypes 模块中)

commonpath() (在 os.path 模块中)

commonprefix() (在 os.path 模块中)

communicate() (asyncio.subprocess.Process 方法)

(subprocess.Popen 方法)

Compare (ast 中的类)

compare() (decimal.Context 方法)

(decimal.Decimal 方法)

(difflib.Differ 方法)

compare_digest() (在 hmac 模块中)

(在 secrets 模块中)

compare_networks() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

COMPARE_OP (opcode)

compare_signal() (decimal.Context 方法)

(decimal.Decimal 方法)

compare_to() (tracemalloc.Snapshot 方法)

compare_total() (decimal.Context 方法)

(decimal.Decimal 方法)

compare_total_mag() (decimal.Context 方法)

(decimal.Decimal 方法)

comparing

objects

comparison

operator

COMPARISON_FLAGS() (在 doctest 模块中)

comparisons

chaining, [1]

Compat32 (email.policy 中的类)

compat32() (在 email.policy 模块中)

compile

內置函数, [1], [2], [3]

Compile (codeop 中的类)

compile()

內置函数

compile() (distutils.ccompiler.CCompiler 方法)

(在 py_compile 模块中)

(在 re 模块中)

compile_command() (在 code 模块中)

(在 codeop 模块中)

compile_dir() (在 compileall 模块中)

compile_file() (在 compileall 模块中)

compile_path() (在 compileall 模块中)

compileall

模块

compileall command line option

--hardlink-dupes

--invalidation-mode [timestamp|checked-hash|unchecked-hash]

-b

-d destdir

-e dir

-f

-i list

-j N

-l

-o level

-p prepend_prefix

-q

-r

-s strip_prefix

-x regex

directory ...

file ...

complete() (rlcompleter.Completer 方法)

complete_statement() (在 sqlite3 模块中)

completedefault() (cmd.Cmd 方法)

CompletedProcess (subprocess 中的类)

complex

number

內置函数, [1]

对象

Complex (numbers 中的类)

complex (內置类)

complex literal

complex number

literals

对象, [1]

complex number -- 复数

compound

statement

comprehension (ast 中的类)

comprehensions

dictionary

list

set

compress() (bz2.BZ2Compressor 方法)

(lzma.LZMACompressor 方法)

(zlib.Compress 方法)

(在 bz2 模块中)

(在 gzip 模块中)

(在 itertools 模块中)

(在 lzma 模块中)

(在 zlib 模块中)

compress_size (zipfile.ZipInfo 属性)

compress_type (zipfile.ZipInfo 属性)

compressed (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

compression() (ssl.SSLSocket 方法)

CompressionError

compressobj() (在 zlib 模块中)

COMSPEC, [1]

concat() (在 operator 模块中)

Concatenate() (在 typing 模块中)

concatenation

operation

concurrent.futures

模块

cond (bdb.Breakpoint 属性)

Condition (asyncio 中的类)

(multiprocessing 中的类)

condition (pdb command)

Condition (threading 中的类)

condition() (msilib.Control 方法)

Condition() (multiprocessing.managers.SyncManager 方法)

Conditional

expression

conditional

expression

config() (tkinter.font.Font 方法)

configparser

模块

ConfigParser (configparser 中的类)

configuration

file

file, debugger

file, path

configuration information

configure() (tkinter.ttk.Style 方法)

configure_mock() (unittest.mock.Mock 方法)

confstr() (在 os 模块中)

confstr_names() (在 os 模块中)

conjugate() (complex number method)

(decimal.Decimal 方法)

(numbers.Complex 方法)

conn (smtpd.SMTPChannel 属性)

connect() (asyncore.dispatcher 方法)

(ftplib.FTP 方法)

(http.client.HTTPConnection 方法)

(multiprocessing.managers.BaseManager 方法)

(smtplib.SMTP 方法)

(socket.socket 方法)

(在 sqlite3 模块中)

connect_accepted_socket() (asyncio.loop 方法)

connect_ex() (socket.socket 方法)

connect_read_pipe() (asyncio.loop 方法)

connect_write_pipe() (asyncio.loop 方法)

Connection (multiprocessing.connection 中的类)

(sqlite3 中的类)

connection (sqlite3.Cursor 属性)

connection_lost() (asyncio.BaseProtocol 方法)

connection_made() (asyncio.BaseProtocol 方法)

ConnectionAbortedError

ConnectionError

ConnectionRefusedError

ConnectionResetError

ConnectRegistry() (在 winreg 模块中)

const (optparse.Option 属性)

constant

Constant (ast 中的类)

constructor

class

constructor() (在 copyreg 模块中)

consumed (asyncio.LimitOverrunError 属性)

container, [1]

iteration over

Container (collections.abc 中的类)

(typing 中的类)

contains() (在 operator 模块中)

CONTAINS_OP (opcode)

content type

MIME

content_disposition (email.headerregistry.ContentDispositionHeader 属性)

content_manager (email.policy.EmailPolicy 属性)

content_type (email.headerregistry.ContentTypeHeader 属性)

ContentDispositionHeader (email.headerregistry 中的类)

ContentHandler (xml.sax.handler 中的类)

ContentManager (email.contentmanager 中的类)

contents (ctypes._Pointer 属性)

contents() (importlib.abc.ResourceReader 方法)

(在 importlib.resources 模块中)

ContentTooShortError

ContentTransferEncoding (email.headerregistry 中的类)

ContentTypeHeader (email.headerregistry 中的类)

Context (contextvars 中的类)

(decimal 中的类)

context (ssl.SSLSocket 属性)

context management protocol

context manager, [1]

context manager -- 上下文管理器

context variable -- 上下文变量

context_diff() (在 difflib 模块中)

ContextDecorator (contextlib 中的类)

contextlib

模块

ContextManager (typing 中的类)

contextmanager() (在 contextlib 模块中)

ContextVar (contextvars 中的类)

contextvars

模块

contiguous

(memoryview 属性)

contiguous -- 连续

continue

语句, [1], [2], [3], [4]

Continue (ast 中的类)

continue (pdb command)

Control (msilib 中的类)

(tkinter.tix 中的类)

control() (msilib.Dialog 方法)

(select.kqueue 方法)

controlnames() (在 curses.ascii 模块中)

controls() (ossaudiodev.oss_mixer_device 方法)

conversion

arithmetic

string, [1]

ConversionError

conversions

numeric

convert_arg_line_to_args() (argparse.ArgumentParser 方法)

convert_field() (string.Formatter 方法)

convert_path() (在 distutils.util 模块中)

Cookie (http.cookiejar 中的类)

CookieError

CookieJar (http.cookiejar 中的类)

cookiejar (urllib.request.HTTPCookieProcessor 属性)

CookiePolicy (http.cookiejar 中的类)

Coordinated Universal Time

Copy

copy

protocol

模块, [1]

copy() (collections.deque 方法)

(contextvars.Context 方法)

(decimal.Context 方法)

(dict 方法)

(frozenset 方法)

(hashlib.hash 方法)

(hmac.HMAC 方法)

(http.cookies.Morsel 方法)

(imaplib.IMAP4 方法)

(pipes.Template 方法)

(sequence method)

(tkinter.font.Font 方法)

(types.MappingProxyType 方法)

(zlib.Compress 方法)

(zlib.Decompress 方法)

(在 copy 模块中)

(在 multiprocessing.sharedctypes 模块中)

(在 shutil 模块中)

copy2() (在 shutil 模块中)

copy_abs() (decimal.Context 方法)

(decimal.Decimal 方法)

copy_context() (在 contextvars 模块中)

copy_decimal() (decimal.Context 方法)

COPY_DICT_WITHOUT_KEYS (opcode)

copy_file() (在 distutils.file_util 模块中)

copy_file_range() (在 os 模块中)

copy_location() (在 ast 模块中)

copy_negate() (decimal.Context 方法)

(decimal.Decimal 方法)

copy_sign() (decimal.Context 方法)

(decimal.Decimal 方法)

copy_tree() (在 distutils.dir_util 模块中)

copyfile() (在 shutil 模块中)

copyfileobj() (在 shutil 模块中)

copying files

copymode() (在 shutil 模块中)

copyreg

模块

copyright (in module sys)

(內置变量)

copyright() (在 sys 模块中)

copysign() (在 math 模块中)

copystat() (在 shutil 模块中)

copytree() (在 shutil 模块中)

coroutine, [1]

function

Coroutine (collections.abc 中的类)

(typing 中的类)

coroutine -- 协程

coroutine function -- 协程函数

coroutine() (在 asyncio 模块中)

(在 types 模块中)

CoroutineType() (在 types 模块中)

correlation() (在 statistics 模块中)

cos() (在 cmath 模块中)

(在 math 模块中)

cosh() (在 cmath 模块中)

(在 math 模块中)

count (tracemalloc.Statistic 属性)

(tracemalloc.StatisticDiff 属性)

count() (array.array 方法)

(bytearray 方法)

(bytes 方法)

(collections.deque 方法)

(multiprocessing.shared_memory.ShareableList 方法)

(sequence method)

(str 方法)

(在 itertools 模块中)

count_diff (tracemalloc.StatisticDiff 属性)

Counter (collections 中的类)

(typing 中的类)

countOf() (在 operator 模块中)

countTestCases() (unittest.TestCase 方法)

(unittest.TestSuite 方法)

covariance() (在 statistics 模块中)

CoverageResults (trace 中的类)

CPP

CPPFLAGS, [1], [2], [3]

cProfile

模块

CPU time, [1]

cpu_count() (在 multiprocessing 模块中)

(在 os 模块中)

CPython

cpython_only() (在 test.support 模块中)

crawl_delay() (urllib.robotparser.RobotFileParser 方法)

CRC (zipfile.ZipInfo 属性)

crc32() (在 binascii 模块中)

(在 zlib 模块中)

crc_hqx() (在 binascii 模块中)

create() (imaplib.IMAP4 方法)

(venv.EnvBuilder 方法)

(在 venv 模块中)

create_aggregate() (sqlite3.Connection 方法)

create_archive() (在 zipapp 模块中)

create_autospec() (在 unittest.mock 模块中)

CREATE_BREAKAWAY_FROM_JOB() (在 subprocess 模块中)

create_collation() (sqlite3.Connection 方法)

create_configuration() (venv.EnvBuilder 方法)

create_connection() (asyncio.loop 方法)

(在 socket 模块中)

create_datagram_endpoint() (asyncio.loop 方法)

create_decimal() (decimal.Context 方法)

create_decimal_from_float() (decimal.Context 方法)

create_default_context() (在 ssl 模块中)

CREATE_DEFAULT_ERROR_MODE() (在 subprocess 模块中)

create_empty_file() (在 test.support.os_helper 模块中)

create_function() (sqlite3.Connection 方法)

create_future() (asyncio.loop 方法)

create_module() (importlib.abc.Loader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(zipimport.zipimporter 方法)

CREATE_NEW_CONSOLE() (在 subprocess 模块中)

CREATE_NEW_PROCESS_GROUP() (在 subprocess 模块中)

CREATE_NO_WINDOW() (在 subprocess 模块中)

create_server() (asyncio.loop 方法)

(在 socket 模块中)

create_shortcut()

內置函数

create_socket() (asyncore.dispatcher 方法)

create_static_lib() (distutils.ccompiler.CCompiler 方法)

create_stats() (profile.Profile 方法)

create_string_buffer() (在 ctypes 模块中)

create_subprocess_exec() (在 asyncio 模块中)

create_subprocess_shell() (在 asyncio 模块中)

create_system (zipfile.ZipInfo 属性)

create_task() (asyncio.loop 方法)

(在 asyncio 模块中)

create_tree() (在 distutils.dir_util 模块中)

create_unicode_buffer() (在 ctypes 模块中)

create_unix_connection() (asyncio.loop 方法)

create_unix_server() (asyncio.loop 方法)

create_version (zipfile.ZipInfo 属性)

createAttribute() (xml.dom.Document 方法)

createAttributeNS() (xml.dom.Document 方法)

createComment() (xml.dom.Document 方法)

createDocument() (xml.dom.DOMImplementation 方法)

createDocumentType() (xml.dom.DOMImplementation 方法)

createElement() (xml.dom.Document 方法)

createElementNS() (xml.dom.Document 方法)

createfilehandler() (tkinter.Widget.tk 方法)

CreateKey() (在 winreg 模块中)

CreateKeyEx() (在 winreg 模块中)

createLock() (logging.Handler 方法)

(logging.NullHandler 方法)

createProcessingInstruction() (xml.dom.Document 方法)

CreateRecord() (在 msilib 模块中)

createSocket() (logging.handlers.SocketHandler 方法)

createTextNode() (xml.dom.Document 方法)

credits (內置变量)

critical() (logging.Logger 方法)

(在 logging 模块中)

CRNCYSTR() (在 locale 模块中)

cross() (在 audioop 模块中)

crypt

模块, [1]

crypt() (在 crypt 模块中)

crypt(3), [1], [2]

cryptography

cssclass_month (calendar.HTMLCalendar 属性)

cssclass_month_head (calendar.HTMLCalendar 属性)

cssclass_noday (calendar.HTMLCalendar 属性)

cssclass_year (calendar.HTMLCalendar 属性)

cssclass_year_head (calendar.HTMLCalendar 属性)

cssclasses (calendar.HTMLCalendar 属性)

cssclasses_weekday_head (calendar.HTMLCalendar 属性)

csv

模块

cte (email.headerregistry.ContentTransferEncoding 属性)

cte_type (email.policy.Policy 属性)

ctermid() (在 os 模块中)

ctime() (datetime.date 方法)

(datetime.datetime 方法)

(在 time 模块中)

ctrl() (在 curses.ascii 模块中)

CTRL_BREAK_EVENT() (在 signal 模块中)

CTRL_C_EVENT() (在 signal 模块中)

ctypes

模块

curdir() (在 os 模块中)

currency() (在 locale 模块中)

current() (tkinter.ttk.Combobox 方法)

current_process() (在 multiprocessing 模块中)

current_task() (在 asyncio 模块中)

current_thread() (在 threading 模块中)

CurrentByteIndex (xml.parsers.expat.xmlparser 属性)

CurrentColumnNumber (xml.parsers.expat.xmlparser 属性)

currentframe() (在 inspect 模块中)

CurrentLineNumber (xml.parsers.expat.xmlparser 属性)

curs_set() (在 curses 模块中)

curses

模块

curses.ascii

模块

curses.panel

模块

curses.textpad

模块

Cursor (sqlite3 中的类)

cursor() (sqlite3.Connection 方法)

cursyncup() (curses.window 方法)

customize_compiler() (在 distutils.sysconfig 模块中)

Cut

cwd() (ftplib.FTP 方法)

(pathlib.Path 类方法)

cycle() (在 itertools 模块中)

CycleError

Cyclic Redundancy Check

索引 – D

D_FMT() (在 locale 模块中)

D_T_FMT() (在 locale 模块中)

daemon (multiprocessing.Process 属性)

(threading.Thread 属性)

dangling

else

data

packing binary

tabular

type

type, immutable

data (collections.UserDict 属性)

(collections.UserList 属性)

(collections.UserString 属性)

(select.kevent 属性)

(selectors.SelectorKey 属性)

(urllib.request.Request 属性)

(xml.dom.Comment 属性)

(xml.dom.ProcessingInstruction 属性)

(xml.dom.Text 属性)

(xmlrpc.client.Binary 属性)

data() (xml.etree.ElementTree.TreeBuilder 方法)

data_filter() (在 tarfile 模块中)

data_open() (urllib.request.DataHandler 方法)

data_received() (asyncio.Protocol 方法)

database

Unicode

DatabaseError

databases

dataclass() (在 dataclasses 模块中)

dataclasses

模块

DataError

datagram_received() (asyncio.DatagramProtocol 方法)

DatagramHandler (logging.handlers 中的类)

DatagramProtocol (asyncio 中的类)

DatagramRequestHandler (socketserver 中的类)

DatagramTransport (asyncio 中的类)

DataHandler (urllib.request 中的类)

date (datetime 中的类)

date() (datetime.datetime 方法)

(nntplib.NNTP 方法)

date_time (zipfile.ZipInfo 属性)

date_time_string() (http.server.BaseHTTPRequestHandler 方法)

DateHeader (email.headerregistry 中的类)

datetime

模块

datetime (datetime 中的类)

(email.headerregistry.DateHeader 属性)

DateTime (xmlrpc.client 中的类)

datum

day (datetime.date 属性)

(datetime.datetime 属性)

day_abbr() (在 calendar 模块中)

day_name() (在 calendar 模块中)

Daylight Saving Time

daylight() (在 time 模块中)

DbfilenameShelf (shelve 中的类)

dbm

模块

dbm.dumb

模块

dbm.gnu

模块, [1], [2]

dbm.ndbm

模块, [1], [2]

dcgettext() (在 locale 模块中)

deallocation, object

debug (imaplib.IMAP4 属性)

(pdb command)

(shlex.shlex 属性)

(zipfile.ZipFile 属性)

debug() (logging.Logger 方法)

(pipes.Template 方法)

(unittest.TestCase 方法)

(unittest.TestSuite 方法)

(在 doctest 模块中)

(在 logging 模块中)

DEBUG() (在 re 模块中)

DEBUG_BYTECODE_SUFFIXES() (在 importlib.machinery 模块中)

DEBUG_COLLECTABLE() (在 gc 模块中)

DEBUG_LEAK() (在 gc 模块中)

debug_print() (distutils.ccompiler.CCompiler 方法)

DEBUG_SAVEALL() (在 gc 模块中)

debug_src() (在 doctest 模块中)

DEBUG_STATS() (在 gc 模块中)

DEBUG_UNCOLLECTABLE() (在 gc 模块中)

debugger, [1], [2], [3]

configuration file

debugging

assertions

CGI

DebuggingServer (smtpd 中的类)

debuglevel (http.client.HTTPResponse 属性)

DebugRunner (doctest 中的类)

decimal

模块

Decimal (decimal 中的类)

decimal literal

decimal() (在 unicodedata 模块中)

DecimalException (decimal 中的类)

decode

Codecs

decode (codecs.CodecInfo 属性)

decode() (bytearray 方法)

(bytes 方法)

(codecs.Codec 方法)

(codecs.IncrementalDecoder 方法)

(json.JSONDecoder 方法)

(xmlrpc.client.Binary 方法)

(xmlrpc.client.DateTime 方法)

(在 base64 模块中)

(在 codecs 模块中)

(在 quopri 模块中)

(在 uu 模块中)

decode_header() (在 email.header 模块中)

(在 nntplib 模块中)

decode_params() (在 email.utils 模块中)

decode_rfc2231() (在 email.utils 模块中)

decode_source() (在 importlib.util 模块中)

decodebytes() (在 base64 模块中)

DecodedGenerator (email.generator 中的类)

decodestring() (在 quopri 模块中)

decomposition() (在 unicodedata 模块中)

decompress() (bz2.BZ2Decompressor 方法)

(lzma.LZMADecompressor 方法)

(zlib.Decompress 方法)

(在 bz2 模块中)

(在 gzip 模块中)

(在 lzma 模块中)

(在 zlib 模块中)

decompressobj() (在 zlib 模块中)

decorator -- 装饰器

DEDENT token, [1]

dedent() (在 textwrap 模块中)

DEDENT() (在 token 模块中)

deepcopy() (在 copy 模块中)

def

语句

def_prog_mode() (在 curses 模块中)

def_shell_mode() (在 curses 模块中)

default

parameter value

default (inspect.Parameter 属性)

(optparse.Option 属性)

default() (cmd.Cmd 方法)

(json.JSONEncoder 方法)

(在 email.policy 模块中)

DEFAULT() (在 unittest.mock 模块中)

DEFAULT_BUFFER_SIZE() (在 io 模块中)

default_bufsize() (在 xml.dom.pulldom 模块中)

default_exception_handler() (asyncio.loop 方法)

default_factory (collections.defaultdict 属性)

DEFAULT_FORMAT() (在 tarfile 模块中)

DEFAULT_IGNORES() (在 filecmp 模块中)

default_open() (urllib.request.BaseHandler 方法)

DEFAULT_PROTOCOL() (在 pickle 模块中)

default_timer() (在 timeit 模块中)

DefaultContext (decimal 中的类)

DefaultCookiePolicy (http.cookiejar 中的类)

defaultdict (collections 中的类)

DefaultDict (typing 中的类)

DefaultEventLoopPolicy (asyncio 中的类)

DefaultHandler() (xml.parsers.expat.xmlparser 方法)

DefaultHandlerExpand() (xml.parsers.expat.xmlparser 方法)

defaults() (configparser.ConfigParser 方法)

DefaultSelector (selectors 中的类)

defaultTestLoader() (在 unittest 模块中)

defaultTestResult() (unittest.TestCase 方法)

defects (email.headerregistry.BaseHeader 属性)

(email.message.EmailMessage 属性)

(email.message.Message 属性)

define_macro() (distutils.ccompiler.CCompiler 方法)

definition

class, [1]

function, [1]

defpath() (在 os 模块中)

DefragResult (urllib.parse 中的类)

DefragResultBytes (urllib.parse 中的类)

degrees() (在 math 模块中)

(在 turtle 模块中)

del

语句, [1], [2], [3]

Del (ast 中的类)

del_param() (email.message.EmailMessage 方法)

(email.message.Message 方法)

delattr()

內置函数

delay() (在 turtle 模块中)

delay_output() (在 curses 模块中)

delayload (http.cookiejar.FileCookieJar 属性)

delch() (curses.window 方法)

dele() (poplib.POP3 方法)

Delete (ast 中的类)

delete() (ftplib.FTP 方法)

(imaplib.IMAP4 方法)

(tkinter.ttk.Treeview 方法)

DELETE_ATTR (opcode)

DELETE_DEREF (opcode)

DELETE_FAST (opcode)

DELETE_GLOBAL (opcode)

DELETE_NAME (opcode)

DELETE_SUBSCR (opcode)

deleteacl() (imaplib.IMAP4 方法)

deletefilehandler() (tkinter.Widget.tk 方法)

DeleteKey() (在 winreg 模块中)

DeleteKeyEx() (在 winreg 模块中)

deleteln() (curses.window 方法)

deleteMe() (bdb.Breakpoint 方法)

DeleteValue() (在 winreg 模块中)

deletion

attribute

target

target list

delimiter (csv.Dialect 属性)

delimiters

delitem() (在 operator 模块中)

deliver_challenge() (在 multiprocessing.connection 模块中)

delocalize() (在 locale 模块中)

demo_app() (在 wsgiref.simple_server 模块中)

denominator (fractions.Fraction 属性)

(numbers.Rational 属性)

DeprecationWarning

deque (collections 中的类)

Deque (typing 中的类)

dequeue() (logging.handlers.QueueListener 方法)

DER_cert_to_PEM_cert() (在 ssl 模块中)

derwin() (curses.window 方法)

DES

cipher

descrgetfunc (C type)

description (inspect.Parameter.kind 属性)

(sqlite3.Cursor 属性)

description() (nntplib.NNTP 方法)

descriptions() (nntplib.NNTP 方法)

descriptor -- 描述器

descrsetfunc (C type)

dest (optparse.Option 属性)

destructor, [1]

(C type)

detach() (io.BufferedIOBase 方法)

(io.TextIOBase 方法)

(socket.socket 方法)

(tkinter.ttk.Treeview 方法)

(weakref.finalize 方法)

Detach() (winreg.PyHKEY 方法)

DETACHED_PROCESS() (在 subprocess 模块中)

detect_api_mismatch() (在 test.support 模块中)

detect_encoding() (在 tokenize 模块中)

detect_language() (distutils.ccompiler.CCompiler 方法)

deterministic profiling

device_encoding() (在 os 模块中)

devnull() (在 os 模块中)

DEVNULL() (在 subprocess 模块中)

devpoll() (在 select 模块中)

DevpollSelector (selectors 中的类)

dgettext() (在 gettext 模块中)

(在 locale 模块中)

Dialect (csv 中的类)

dialect (csv.csvreader 属性)

(csv.csvwriter 属性)

Dialog (msilib 中的类)

(tkinter.commondialog 中的类)

(tkinter.simpledialog 中的类)

dict (2to3 fixer)

Dict (ast 中的类)

(typing 中的类)

dict (內置类)

dict() (multiprocessing.managers.SyncManager 方法)

DICT_MERGE (opcode)

DICT_UPDATE (opcode)

DictComp (ast 中的类)

dictConfig() (在 logging.config 模块中)

dictionary

comprehensions

display

type, operations on

对象, [1], [2], [3], [4], [5], [6], [7]

dictionary -- 字典

dictionary comprehension -- 字典推导式

dictionary view -- 字典视图

DictReader (csv 中的类)

DictWriter (csv 中的类)

diff_bytes() (在 difflib 模块中)

diff_files (filecmp.dircmp 属性)

Differ (difflib 中的类)

difference() (frozenset 方法)

difference_update() (frozenset 方法)

difflib

模块

digest() (hashlib.hash 方法)

(hashlib.shake 方法)

(hmac.HMAC 方法)

(在 hmac 模块中)

digest_size (hmac.HMAC 属性)

digit() (在 unicodedata 模块中)

digits() (在 string 模块中)

dir()

內置函数

dir() (ftplib.FTP 方法)

dircmp (filecmp 中的类)

directory

changing

creating

deleting, [1]

site-packages

traversal, [1]

walking, [1]

Directory (msilib 中的类)

(tkinter.filedialog 中的类)

directory ...

compileall command line option

directory_created()

內置函数

DirEntry (os 中的类)

DirList (tkinter.tix 中的类)

dirname() (在 os.path 模块中)

dirs_double_event() (tkinter.filedialog.FileDialog 方法)

dirs_select_event() (tkinter.filedialog.FileDialog 方法)

DirSelectBox (tkinter.tix 中的类)

DirSelectDialog (tkinter.tix 中的类)

DirsOnSysPath (test.support.import_helper 中的类)

DirTree (tkinter.tix 中的类)

dis

模块

dis() (dis.Bytecode 方法)

(在 dis 模块中)

(在 pickletools 模块中)

disable (pdb command)

disable() (bdb.Breakpoint 方法)

(profile.Profile 方法)

(在 faulthandler 模块中)

(在 gc 模块中)

(在 logging 模块中)

disable_faulthandler() (在 test.support 模块中)

disable_gc() (在 test.support 模块中)

disable_interspersed_args() (optparse.OptionParser 方法)

DisableReflectionKey() (在 winreg 模块中)

disassemble() (在 dis 模块中)

discard (http.cookiejar.Cookie 属性)

discard() (frozenset 方法)

(mailbox.Mailbox 方法)

(mailbox.MH 方法)

discard_buffers() (asynchat.async_chat 方法)

disco() (在 dis 模块中)

discover() (unittest.TestLoader 方法)

disk_usage() (在 shutil 模块中)

dispatch_call() (bdb.Bdb 方法)

dispatch_exception() (bdb.Bdb 方法)

dispatch_line() (bdb.Bdb 方法)

dispatch_return() (bdb.Bdb 方法)

dispatch_table (pickle.Pickler 属性)

dispatcher (asyncore 中的类)

dispatcher_with_send (asyncore 中的类)

DISPLAY

display

dictionary

list

set

display (pdb command)

display_name (email.headerregistry.Address 属性)

(email.headerregistry.Group 属性)

displayhook() (在 sys 模块中)

dist() (在 math 模块中)

distance() (在 turtle 模块中)

distb() (在 dis 模块中)

Distribution (distutils.core 中的类)

distutils

模块

distutils.archive_util

模块

distutils.bcppcompiler

模块

distutils.ccompiler

模块

distutils.cmd

模块

distutils.command

模块

distutils.command.bdist

模块

distutils.command.bdist_dumb

模块

distutils.command.bdist_msi

模块

distutils.command.bdist_packager

模块

distutils.command.bdist_rpm

模块

distutils.command.build

模块

distutils.command.build_clib

模块

distutils.command.build_ext

模块

distutils.command.build_py

模块

distutils.command.build_scripts

模块

distutils.command.check

模块

distutils.command.clean

模块

distutils.command.config

模块

distutils.command.install

模块

distutils.command.install_data

模块

distutils.command.install_headers

模块

distutils.command.install_lib

模块

distutils.command.install_scripts

模块

distutils.command.register

模块

distutils.command.sdist

模块

distutils.core

模块

distutils.cygwinccompiler

模块

distutils.debug

模块

distutils.dep_util

模块

distutils.dir_util

模块

distutils.dist

模块

distutils.errors

模块

distutils.extension

模块

distutils.fancy_getopt

模块

distutils.file_util

模块

distutils.filelist

模块

distutils.log

模块

distutils.msvccompiler

模块

distutils.spawn

模块

distutils.sysconfig

模块

distutils.text_file

模块

distutils.unixccompiler

模块

distutils.util

模块

distutils.version

模块

DISTUTILS_DEBUG

Div (ast 中的类)

divide() (decimal.Context 方法)

divide_int() (decimal.Context 方法)

division

DivisionByZero (decimal 中的类)

divmod

內置函数, [1], [2]

divmod()

內置函数

divmod() (decimal.Context 方法)

DllCanUnloadNow() (在 ctypes 模块中)

DllGetClassObject() (在 ctypes 模块中)

dllhandle() (在 sys 模块中)

dnd_start() (在 tkinter.dnd 模块中)

DndHandler (tkinter.dnd 中的类)

dngettext() (在 gettext 模块中)

dnpgettext() (在 gettext 模块中)

do_clear() (bdb.Bdb 方法)

do_command() (curses.textpad.Textbox 方法)

do_GET() (http.server.SimpleHTTPRequestHandler 方法)

do_handshake() (ssl.SSLSocket 方法)

do_HEAD() (http.server.SimpleHTTPRequestHandler 方法)

do_POST() (http.server.CGIHTTPRequestHandler 方法)

doc (json.JSONDecodeError 属性)

doc_header (cmd.Cmd 属性)

DocCGIXMLRPCRequestHandler (xmlrpc.server 中的类)

DocFileSuite() (在 doctest 模块中)

doClassCleanups() (unittest.TestCase 类方法)

doCleanups() (unittest.TestCase 方法)

docmd() (smtplib.SMTP 方法)

docstring

(doctest.DocTest 属性)

docstring -- 文档字符串

docstrings, [1]

doctest

模块

DocTest (doctest 中的类)

DocTestFailure

DocTestFinder (doctest 中的类)

DocTestParser (doctest 中的类)

DocTestRunner (doctest 中的类)

DocTestSuite() (在 doctest 模块中)

doctype() (xml.etree.ElementTree.TreeBuilder 方法)

documentation

generation

online

documentation string

documentation strings, [1]

documentElement (xml.dom.Document 属性)

DocXMLRPCRequestHandler (xmlrpc.server 中的类)

DocXMLRPCServer (xmlrpc.server 中的类)

domain (email.headerregistry.Address 属性)

(tracemalloc.DomainFilter 属性)

(tracemalloc.Filter 属性)

(tracemalloc.Trace 属性)

domain_initial_dot (http.cookiejar.Cookie 属性)

domain_return_ok() (http.cookiejar.CookiePolicy 方法)

domain_specified (http.cookiejar.Cookie 属性)

DomainFilter (tracemalloc 中的类)

DomainLiberal (http.cookiejar.DefaultCookiePolicy 属性)

DomainRFC2965Match (http.cookiejar.DefaultCookiePolicy 属性)

DomainStrict (http.cookiejar.DefaultCookiePolicy 属性)

DomainStrictNoDots (http.cookiejar.DefaultCookiePolicy 属性)

DomainStrictNonDomain (http.cookiejar.DefaultCookiePolicy 属性)

DOMEventStream (xml.dom.pulldom 中的类)

DOMException

doModuleCleanups() (在 unittest 模块中)

DomstringSizeErr

done() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

(graphlib.TopologicalSorter 方法)

(xdrlib.Unpacker 方法)

(在 turtle 模块中)

DONT_ACCEPT_BLANKLINE() (在 doctest 模块中)

DONT_ACCEPT_TRUE_FOR_1() (在 doctest 模块中)

dont_write_bytecode() (在 sys 模块中)

doRollover() (logging.handlers.RotatingFileHandler 方法)

(logging.handlers.TimedRotatingFileHandler 方法)

DOT() (在 token 模块中)

dot() (在 turtle 模块中)

DOTALL() (在 re 模块中)

doublequote (csv.Dialect 属性)

DOUBLESLASH() (在 token 模块中)

DOUBLESLASHEQUAL() (在 token 模块中)

DOUBLESTAR() (在 token 模块中)

DOUBLESTAREQUAL() (在 token 模块中)

doupdate() (在 curses 模块中)

down (pdb command)

down() (在 turtle 模块中)

dpgettext() (在 gettext 模块中)

drain() (asyncio.StreamWriter 方法)

drive (pathlib.PurePath 属性)

drop_whitespace (textwrap.TextWrapper 属性)

dropwhile() (在 itertools 模块中)

dst() (datetime.datetime 方法)

(datetime.time 方法)

(datetime.timezone 方法)

(datetime.tzinfo 方法)

DTDHandler (xml.sax.handler 中的类)

duck-typing -- 鸭子类型

dump() (pickle.Pickler 方法)

(tracemalloc.Snapshot 方法)

(在 ast 模块中)

(在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

(在 xml.etree.ElementTree 模块中)

dump_stats() (profile.Profile 方法)

(pstats.Stats 方法)

dump_traceback() (在 faulthandler 模块中)

dump_traceback_later() (在 faulthandler 模块中)

dumps() (在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

(在 xmlrpc.client 模块中)

dup() (socket.socket 方法)

(在 os 模块中)

dup2() (在 os 模块中)

DUP_TOP (opcode)

DUP_TOP_TWO (opcode)

DuplicateOptionError

DuplicateSectionError

dwFlags (subprocess.STARTUPINFO 属性)

DynamicClassAttribute() (在 types 模块中)

索引 – E

e

in numeric literal

e() (在 cmath 模块中)

(在 math 模块中)

E2BIG() (在 errno 模块中)

EACCES() (在 errno 模块中)

EADDRINUSE() (在 errno 模块中)

EADDRNOTAVAIL() (在 errno 模块中)

EADV() (在 errno 模块中)

EAFNOSUPPORT() (在 errno 模块中)

EAFP

EAGAIN() (在 errno 模块中)

EALREADY() (在 errno 模块中)

east_asian_width() (在 unicodedata 模块中)

EBADE() (在 errno 模块中)

EBADF() (在 errno 模块中)

EBADFD() (在 errno 模块中)

EBADMSG() (在 errno 模块中)

EBADR() (在 errno 模块中)

EBADRQC() (在 errno 模块中)

EBADSLT() (在 errno 模块中)

EBFONT() (在 errno 模块中)

EBUSY() (在 errno 模块中)

ECHILD() (在 errno 模块中)

echo() (在 curses 模块中)

echochar() (curses.window 方法)

ECHRNG() (在 errno 模块中)

ECOMM() (在 errno 模块中)

ECONNABORTED() (在 errno 模块中)

ECONNREFUSED() (在 errno 模块中)

ECONNRESET() (在 errno 模块中)

EDEADLK() (在 errno 模块中)

EDEADLOCK() (在 errno 模块中)

EDESTADDRREQ() (在 errno 模块中)

edit() (curses.textpad.Textbox 方法)

EDOM() (在 errno 模块中)

EDOTDOT() (在 errno 模块中)

EDQUOT() (在 errno 模块中)

EEXIST() (在 errno 模块中)

EFAULT() (在 errno 模块中)

EFBIG() (在 errno 模块中)

EFD_CLOEXEC() (在 os 模块中)

EFD_NONBLOCK() (在 os 模块中)

EFD_SEMAPHORE() (在 os 模块中)

effective() (在 bdb 模块中)

ehlo() (smtplib.SMTP 方法)

ehlo_or_helo_if_needed() (smtplib.SMTP 方法)

EHOSTDOWN() (在 errno 模块中)

EHOSTUNREACH() (在 errno 模块中)

EIDRM() (在 errno 模块中)

EILSEQ() (在 errno 模块中)

EINPROGRESS() (在 errno 模块中)

EINTR() (在 errno 模块中)

EINVAL() (在 errno 模块中)

EIO() (在 errno 模块中)

EISCONN() (在 errno 模块中)

EISDIR() (在 errno 模块中)

EISNAM() (在 errno 模块中)

EL2HLT() (在 errno 模块中)

EL2NSYNC() (在 errno 模块中)

EL3HLT() (在 errno 模块中)

EL3RST() (在 errno 模块中)

Element (xml.etree.ElementTree 中的类)

element_create() (tkinter.ttk.Style 方法)

element_names() (tkinter.ttk.Style 方法)

element_options() (tkinter.ttk.Style 方法)

ElementDeclHandler() (xml.parsers.expat.xmlparser 方法)

elements() (collections.Counter 方法)

ElementTree (xml.etree.ElementTree 中的类)

ELIBACC() (在 errno 模块中)

ELIBBAD() (在 errno 模块中)

ELIBEXEC() (在 errno 模块中)

ELIBMAX() (在 errno 模块中)

ELIBSCN() (在 errno 模块中)

elif

关键字

Ellinghouse, Lance

Ellipsis

对象

Ellipsis (內置变量)

ELLIPSIS() (在 doctest 模块中)

(在 token 模块中)

EllipsisType() (在 types 模块中)

ELNRNG() (在 errno 模块中)

ELOOP() (在 errno 模块中)

else

conditional expression

dangling

关键字, [1], [2], [3], [4], [5]

email

模块

email.charset

模块

email.contentmanager

模块

email.encoders

模块

email.errors

模块

email.generator

模块

email.header

模块

email.headerregistry

模块

email.iterators

模块

email.message

模块

email.mime

模块

email.parser

模块

email.policy

模块

email.utils

模块

EmailMessage (email.message 中的类)

EmailPolicy (email.policy 中的类)

EMFILE() (在 errno 模块中)

emit() (logging.FileHandler 方法)

(logging.Handler 方法)

(logging.handlers.BufferingHandler 方法)

(logging.handlers.DatagramHandler 方法)

(logging.handlers.HTTPHandler 方法)

(logging.handlers.NTEventLogHandler 方法)

(logging.handlers.QueueHandler 方法)

(logging.handlers.RotatingFileHandler 方法)

(logging.handlers.SMTPHandler 方法)

(logging.handlers.SocketHandler 方法)

(logging.handlers.SysLogHandler 方法)

(logging.handlers.TimedRotatingFileHandler 方法)

(logging.handlers.WatchedFileHandler 方法)

(logging.NullHandler 方法)

(logging.StreamHandler 方法)

EMLINK() (在 errno 模块中)

Empty

empty

list

tuple, [1]

empty (inspect.Parameter 属性)

(inspect.Signature 属性)

empty() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(multiprocessing.SimpleQueue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

(sched.scheduler 方法)

EMPTY_NAMESPACE() (在 xml.dom 模块中)

emptyline() (cmd.Cmd 方法)

EMSGSIZE() (在 errno 模块中)

EMULTIHOP() (在 errno 模块中)

enable (pdb command)

enable() (bdb.Breakpoint 方法)

(imaplib.IMAP4 方法)

(profile.Profile 方法)

(在 cgitb 模块中)

(在 faulthandler 模块中)

(在 gc 模块中)

enable_callback_tracebacks() (在 sqlite3 模块中)

enable_interspersed_args() (optparse.OptionParser 方法)

enable_load_extension() (sqlite3.Connection 方法)

enable_traversal() (tkinter.ttk.Notebook 方法)

ENABLE_USER_SITE() (在 site 模块中)

EnableControlFlowGuard

enabled (bdb.Breakpoint 属性)

EnableReflectionKey() (在 winreg 模块中)

ENAMETOOLONG() (在 errno 模块中)

ENAVAIL() (在 errno 模块中)

enclose() (curses.window 方法)

encode

Codecs

encode (codecs.CodecInfo 属性)

encode() (codecs.Codec 方法)

(codecs.IncrementalEncoder 方法)

(email.header.Header 方法)

(json.JSONEncoder 方法)

(str 方法)

(xmlrpc.client.Binary 方法)

(xmlrpc.client.DateTime 方法)

(在 base64 模块中)

(在 codecs 模块中)

(在 quopri 模块中)

(在 uu 模块中)

encode_7or8bit() (在 email.encoders 模块中)

encode_base64() (在 email.encoders 模块中)

encode_noop() (在 email.encoders 模块中)

encode_quopri() (在 email.encoders 模块中)

encode_rfc2231() (在 email.utils 模块中)

encodebytes() (在 base64 模块中)

EncodedFile() (在 codecs 模块中)

encodePriority() (logging.handlers.SysLogHandler 方法)

encodestring() (在 quopri 模块中)

encoding

base64

quoted-printable

encoding (curses.window 属性)

(io.TextIOBase 属性)

(UnicodeError 属性)

encoding declarations (source file)

ENCODING() (在 tarfile 模块中)

(在 token 模块中)

encodings.idna

模块

encodings.mbcs

模块

encodings.utf_8_sig

模块

encodings_map (mimetypes.MimeTypes 属性)

encodings_map() (在 mimetypes 模块中)

EncodingWarning

end (UnicodeError 属性)

end() (re.Match 方法)

(xml.etree.ElementTree.TreeBuilder 方法)

END_ASYNC_FOR (opcode)

end_col_offset (ast.AST 属性)

end_fill() (在 turtle 模块中)

end_headers() (http.server.BaseHTTPRequestHandler 方法)

end_lineno (ast.AST 属性)

(SyntaxError 属性)

(traceback.TracebackException 属性)

end_ns() (xml.etree.ElementTree.TreeBuilder 方法)

end_offset (SyntaxError 属性)

(traceback.TracebackException 属性)

end_poly() (在 turtle 模块中)

endCDATA() (xml.sax.handler.LexicalHandler 方法)

EndCdataSectionHandler() (xml.parsers.expat.xmlparser 方法)

EndDoctypeDeclHandler() (xml.parsers.expat.xmlparser 方法)

endDocument() (xml.sax.handler.ContentHandler 方法)

endDTD() (xml.sax.handler.LexicalHandler 方法)

endElement() (xml.sax.handler.ContentHandler 方法)

EndElementHandler() (xml.parsers.expat.xmlparser 方法)

endElementNS() (xml.sax.handler.ContentHandler 方法)

endheaders() (http.client.HTTPConnection 方法)

ENDMARKER() (在 token 模块中)

EndNamespaceDeclHandler() (xml.parsers.expat.xmlparser 方法)

endpos (re.Match 属性)

endPrefixMapping() (xml.sax.handler.ContentHandler 方法)

endswith() (bytearray 方法)

(bytes 方法)

(str 方法)

endwin() (在 curses 模块中)

ENETDOWN() (在 errno 模块中)

ENETRESET() (在 errno 模块中)

ENETUNREACH() (在 errno 模块中)

ENFILE() (在 errno 模块中)

ENOANO() (在 errno 模块中)

ENOBUFS() (在 errno 模块中)

ENOCSI() (在 errno 模块中)

ENODATA() (在 errno 模块中)

ENODEV() (在 errno 模块中)

ENOENT() (在 errno 模块中)

ENOEXEC() (在 errno 模块中)

ENOLCK() (在 errno 模块中)

ENOLINK() (在 errno 模块中)

ENOMEM() (在 errno 模块中)

ENOMSG() (在 errno 模块中)

ENONET() (在 errno 模块中)

ENOPKG() (在 errno 模块中)

ENOPROTOOPT() (在 errno 模块中)

ENOSPC() (在 errno 模块中)

ENOSR() (在 errno 模块中)

ENOSTR() (在 errno 模块中)

ENOSYS() (在 errno 模块中)

ENOTBLK() (在 errno 模块中)

ENOTCONN() (在 errno 模块中)

ENOTDIR() (在 errno 模块中)

ENOTEMPTY() (在 errno 模块中)

ENOTNAM() (在 errno 模块中)

ENOTSOCK() (在 errno 模块中)

ENOTTY() (在 errno 模块中)

ENOTUNIQ() (在 errno 模块中)

enqueue() (logging.handlers.QueueHandler 方法)

enqueue_sentinel() (logging.handlers.QueueListener 方法)

ensure_directories() (venv.EnvBuilder 方法)

ensure_future() (在 asyncio 模块中)

ensurepip

模块

enter() (sched.scheduler 方法)

enter_async_context() (contextlib.AsyncExitStack 方法)

enter_context() (contextlib.ExitStack 方法)

enterabs() (sched.scheduler 方法)

entities (xml.dom.DocumentType 属性)

EntityDeclHandler() (xml.parsers.expat.xmlparser 方法)

entitydefs() (在 html.entities 模块中)

EntityResolver (xml.sax.handler 中的类)

enum

模块

Enum (enum 中的类)

enum_certificates() (在 ssl 模块中)

enum_crls() (在 ssl 模块中)

enumerate()

內置函数

enumerate() (在 threading 模块中)

EnumKey() (在 winreg 模块中)

EnumValue() (在 winreg 模块中)

EnvBuilder (venv 中的类)

environ() (在 os 模块中)

(在 posix 模块中)

environb() (在 os 模块中)

environment

environment variables

deleting

setting

EnvironmentError

Environments

virtual

EnvironmentVarGuard (test.support.os_helper 中的类)

ENXIO() (在 errno 模块中)

eof (bz2.BZ2Decompressor 属性)

(lzma.LZMADecompressor 属性)

(shlex.shlex 属性)

(ssl.MemoryBIO 属性)

(zlib.Decompress 属性)

eof_received() (asyncio.BufferedProtocol 方法)

(asyncio.Protocol 方法)

EOFError

(built-in exception)

EOPNOTSUPP() (在 errno 模块中)

EOVERFLOW() (在 errno 模块中)

EPERM() (在 errno 模块中)

EPFNOSUPPORT() (在 errno 模块中)

epilogue (email.message.EmailMessage 属性)

(email.message.Message 属性)

EPIPE() (在 errno 模块中)

epoch

epoll() (在 select 模块中)

EpollSelector (selectors 中的类)

EPROTO() (在 errno 模块中)

EPROTONOSUPPORT() (在 errno 模块中)

EPROTOTYPE() (在 errno 模块中)

Eq (ast 中的类)

eq() (在 operator 模块中)

EQEQUAL() (在 token 模块中)

EQUAL() (在 token 模块中)

ERA() (在 locale 模块中)

ERA_D_FMT() (在 locale 模块中)

ERA_D_T_FMT() (在 locale 模块中)

ERA_T_FMT() (在 locale 模块中)

ERANGE() (在 errno 模块中)

erase() (curses.window 方法)

erasechar() (在 curses 模块中)

EREMCHG() (在 errno 模块中)

EREMOTE() (在 errno 模块中)

EREMOTEIO() (在 errno 模块中)

ERESTART() (在 errno 模块中)

erf() (在 math 模块中)

erfc() (在 math 模块中)

EROFS() (在 errno 模块中)

ERR() (在 curses 模块中)

errcheck (ctypes._FuncPtr 属性)

errcode (xmlrpc.client.ProtocolError 属性)

errmsg (xmlrpc.client.ProtocolError 属性)

errno

模块, [1]

errno (OSError 属性)

Error, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13]

error, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]

error handler's name

backslashreplace

ignore

namereplace

replace

strict

surrogateescape

surrogatepass

xmlcharrefreplace

error handling

error() (argparse.ArgumentParser 方法)

(logging.Logger 方法)

(urllib.request.OpenerDirector 方法)

(xml.sax.handler.ErrorHandler 方法)

(在 logging 模块中)

error_body (wsgiref.handlers.BaseHandler 属性)

error_content_type (http.server.BaseHTTPRequestHandler 属性)

error_headers (wsgiref.handlers.BaseHandler 属性)

error_leader() (shlex.shlex 方法)

error_message_format (http.server.BaseHTTPRequestHandler 属性)

error_output() (wsgiref.handlers.BaseHandler 方法)

error_perm

error_proto, [1]

error_received() (asyncio.DatagramProtocol 方法)

error_reply

error_status (wsgiref.handlers.BaseHandler 属性)

error_temp

ErrorByteIndex (xml.parsers.expat.xmlparser 属性)

ErrorCode (xml.parsers.expat.xmlparser 属性)

errorcode() (在 errno 模块中)

ErrorColumnNumber (xml.parsers.expat.xmlparser 属性)

ErrorHandler (xml.sax.handler 中的类)

errorlevel (tarfile.TarFile 属性)

ErrorLineNumber (xml.parsers.expat.xmlparser 属性)

Errors

logging

errors

(io.TextIOBase 属性)

(unittest.TestLoader 属性)

(unittest.TestResult 属性)

ErrorString() (在 xml.parsers.expat 模块中)

ERRORTOKEN() (在 token 模块中)

escape (shlex.shlex 属性)

escape sequence

escape() (在 glob 模块中)

(在 html 模块中)

(在 re 模块中)

(在 xml.sax.saxutils 模块中)

escapechar (csv.Dialect 属性)

escapedquotes (shlex.shlex 属性)

ESHUTDOWN() (在 errno 模块中)

ESOCKTNOSUPPORT() (在 errno 模块中)

ESPIPE() (在 errno 模块中)

ESRCH() (在 errno 模块中)

ESRMNT() (在 errno 模块中)

ESTALE() (在 errno 模块中)

ESTRPIPE() (在 errno 模块中)

ETIME() (在 errno 模块中)

ETIMEDOUT() (在 errno 模块中)

Etiny() (decimal.Context 方法)

ETOOMANYREFS() (在 errno 模块中)

Etop() (decimal.Context 方法)

ETXTBSY() (在 errno 模块中)

EUCLEAN() (在 errno 模块中)

EUNATCH() (在 errno 模块中)

EUSERS() (在 errno 模块中)

eval

內置函数, [1], [2], [3], [4]

eval()

內置函数

evaluation

order

Event (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

event scheduling

event() (msilib.Control 方法)

Event() (multiprocessing.managers.SyncManager 方法)

eventfd() (在 os 模块中)

eventfd_read() (在 os 模块中)

eventfd_write() (在 os 模块中)

events (selectors.SelectorKey 属性)

(widgets)

EWOULDBLOCK() (在 errno 模块中)

EX_CANTCREAT() (在 os 模块中)

EX_CONFIG() (在 os 模块中)

EX_DATAERR() (在 os 模块中)

EX_IOERR() (在 os 模块中)

EX_NOHOST() (在 os 模块中)

EX_NOINPUT() (在 os 模块中)

EX_NOPERM() (在 os 模块中)

EX_NOTFOUND() (在 os 模块中)

EX_NOUSER() (在 os 模块中)

EX_OK() (在 os 模块中)

EX_OSERR() (在 os 模块中)

EX_OSFILE() (在 os 模块中)

EX_PROTOCOL() (在 os 模块中)

EX_SOFTWARE() (在 os 模块中)

EX_TEMPFAIL() (在 os 模块中)

EX_UNAVAILABLE() (在 os 模块中)

EX_USAGE() (在 os 模块中)

Example (doctest 中的类)

example (doctest.DocTestFailure 属性)

(doctest.UnexpectedException 属性)

examples (doctest.DocTest 属性)

exc_info (doctest.UnexpectedException 属性)

(in module sys)

exc_info() (in module sys)

(在 sys 模块中)

exc_msg (doctest.Example 属性)

exc_type (traceback.TracebackException 属性)

excel (csv 中的类)

excel_tab (csv 中的类)

except

关键字

语句

except (2to3 fixer)

ExceptHandler (ast 中的类)

excepthook() (in module sys)

(在 sys 模块中)

(在 threading 模块中)

Exception

exception, [1]

chaining

handler

raising

exception handler

exception() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

(logging.Logger 方法)

(在 logging 模块中)

EXCEPTION() (在 tkinter 模块中)

exceptions

in CGI scripts

exclusive

or

EXDEV() (在 errno 模块中)

exec

內置函数, [1], [2]

exec (2to3 fixer)

exec()

內置函数

exec_module() (importlib.abc.InspectLoader 方法)

(importlib.abc.Loader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(zipimport.zipimporter 方法)

EXEC_PREFIX() (在 distutils.sysconfig 模块中)

exec_prefix() (在 sys 模块中)

execfile (2to3 fixer)

execl() (在 os 模块中)

execle() (在 os 模块中)

execlp() (在 os 模块中)

execlpe() (在 os 模块中)

executable (in module sys)

Executable Zip Files

executable() (在 sys 模块中)

executable_filename() (distutils.ccompiler.CCompiler 方法)

execute() (distutils.ccompiler.CCompiler 方法)

Execute() (msilib.View 方法)

execute() (sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

(在 distutils.util 模块中)

executemany() (sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

executescript() (sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

execution

frame, [1]

restricted

stack

execution model

ExecutionLoader (importlib.abc 中的类)

Executor (concurrent.futures 中的类)

execv() (在 os 模块中)

execve() (在 os 模块中)

execvp() (在 os 模块中)

execvpe() (在 os 模块中)

ExFileSelectBox (tkinter.tix 中的类)

EXFULL() (在 errno 模块中)

exists() (pathlib.Path 方法)

(tkinter.ttk.Treeview 方法)

(zipfile.Path 方法)

(在 os.path 模块中)

exit (內置变量)

exit()

(argparse.ArgumentParser 方法)

(在 _thread 模块中)

(在 sys 模块中)

exitcode (multiprocessing.Process 属性)

exitfunc (2to3 fixer)

exitonclick() (在 turtle 模块中)

ExitStack (contextlib 中的类)

exp() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 cmath 模块中)

(在 math 模块中)

expand() (re.Match 方法)

expand_tabs (textwrap.TextWrapper 属性)

ExpandEnvironmentStrings() (在 winreg 模块中)

expandNode() (xml.dom.pulldom.DOMEventStream 方法)

expandtabs() (bytearray 方法)

(bytes 方法)

(str 方法)

expanduser() (pathlib.Path 方法)

(在 os.path 模块中)

expandvars() (在 os.path 模块中)

Expat

ExpatError

expect() (telnetlib.Telnet 方法)

expected (asyncio.IncompleteReadError 属性)

expectedFailure() (在 unittest 模块中)

expectedFailures (unittest.TestResult 属性)

expires (http.cookiejar.Cookie 属性)

exploded (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

expm1() (在 math 模块中)

expovariate() (在 random 模块中)

Expr (ast 中的类)

expression

Conditional

conditional

generator

lambda, [1]

list, [1], [2]

statement

yield

expression -- 表达式

expunge() (imaplib.IMAP4 方法)

extend() (array.array 方法)

(collections.deque 方法)

(sequence method)

(xml.etree.ElementTree.Element 方法)

extend_path() (在 pkgutil 模块中)

EXTENDED_ARG (opcode)

ExtendedContext (decimal 中的类)

ExtendedInterpolation (configparser 中的类)

extendleft() (collections.deque 方法)

extension

module

Extension (distutils.core 中的类)

extension module -- 扩展模块

EXTENSION_SUFFIXES() (在 importlib.machinery 模块中)

ExtensionFileLoader (importlib.machinery 中的类)

extensions_map (http.server.SimpleHTTPRequestHandler 属性)

External Data Representation, [1]

external_attr (zipfile.ZipInfo 属性)

ExternalClashError

ExternalEntityParserCreate() (xml.parsers.expat.xmlparser 方法)

ExternalEntityRefHandler() (xml.parsers.expat.xmlparser 方法)

extra (zipfile.ZipInfo 属性)

extract() (tarfile.TarFile 方法)

(traceback.StackSummary 类方法)

(zipfile.ZipFile 方法)

extract_cookies() (http.cookiejar.CookieJar 方法)

extract_stack() (在 traceback 模块中)

extract_tb() (在 traceback 模块中)

extract_version (zipfile.ZipInfo 属性)

extractall() (tarfile.TarFile 方法)

(zipfile.ZipFile 方法)

ExtractError

extractfile() (tarfile.TarFile 方法)

extraction_filter (tarfile.TarFile 属性)

extsep() (在 os 模块中)

索引 – F

f"

formatted string literal

f'

formatted string literal

f-string

f-string -- f-字符串

f_back (frame attribute)

f_builtins (frame attribute)

f_code (frame attribute)

f_contiguous (memoryview 属性)

f_globals (frame attribute)

f_lasti (frame attribute)

f_lineno (frame attribute)

f_locals (frame attribute)

F_LOCK() (在 os 模块中)

F_OK() (在 os 模块中)

F_TEST() (在 os 模块中)

F_TLOCK() (在 os 模块中)

f_trace (frame attribute)

f_trace_lines (frame attribute)

f_trace_opcodes (frame attribute)

F_ULOCK() (在 os 模块中)

fabs() (在 math 模块中)

factorial() (在 math 模块中)

factory() (importlib.util.LazyLoader 类方法)

fail() (unittest.TestCase 方法)

FAIL_FAST() (在 doctest 模块中)

failfast (unittest.TestResult 属性)

failureException (unittest.TestCase 属性)

failures (unittest.TestResult 属性)

FakePath (test.support.os_helper 中的类)

False, [1], [2]

false

False (Built-in object)

(內置变量)

families() (在 tkinter.font 模块中)

family (socket.socket 属性)

fancy_getopt() (在 distutils.fancy_getopt 模块中)

FancyGetopt (distutils.fancy_getopt 中的类)

FancyURLopener (urllib.request 中的类)

fast (pickle.Pickler 属性)

FastChildWatcher (asyncio 中的类)

fatalError() (xml.sax.handler.ErrorHandler 方法)

Fault (xmlrpc.client 中的类)

faultCode (xmlrpc.client.Fault 属性)

faulthandler

模块

faultString (xmlrpc.client.Fault 属性)

fchdir() (在 os 模块中)

fchmod() (在 os 模块中)

fchown() (在 os 模块中)

FCICreate() (在 msilib 模块中)

fcntl

模块

fcntl() (在 fcntl 模块中)

fd (selectors.SelectorKey 属性)

fd() (在 turtle 模块中)

fd_count() (在 test.support.os_helper 模块中)

fdatasync() (在 os 模块中)

fdopen() (在 os 模块中)

Feature (msilib 中的类)

feature_external_ges() (在 xml.sax.handler 模块中)

feature_external_pes() (在 xml.sax.handler 模块中)

feature_namespace_prefixes() (在 xml.sax.handler 模块中)

feature_namespaces() (在 xml.sax.handler 模块中)

feature_string_interning() (在 xml.sax.handler 模块中)

feature_validation() (在 xml.sax.handler 模块中)

feed() (email.parser.BytesFeedParser 方法)

(html.parser.HTMLParser 方法)

(xml.etree.ElementTree.XMLParser 方法)

(xml.etree.ElementTree.XMLPullParser 方法)

(xml.sax.xmlreader.IncrementalParser 方法)

FeedParser (email.parser 中的类)

fetch() (imaplib.IMAP4 方法)

Fetch() (msilib.View 方法)

fetchall() (sqlite3.Cursor 方法)

fetchmany() (sqlite3.Cursor 方法)

fetchone() (sqlite3.Cursor 方法)

fflags (select.kevent 属性)

Field (dataclasses 中的类)

field() (在 dataclasses 模块中)

field_size_limit() (在 csv 模块中)

fieldnames (csv.DictReader 属性)

fields (uuid.UUID 属性)

fields() (在 dataclasses 模块中)

file

.ini

.pdbrc

byte-code, [1]

configuration

copying

debugger configuration

gzip command line option

large files

mime.types

modes

path configuration

plist

temporary

对象, [1]

file (bdb.Breakpoint 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

file ...

compileall command line option

file control

UNIX

file name

temporary

file object

io module

open() built-in function

file object -- 文件对象

file-like object -- 文件型对象

FILE_ATTRIBUTE_ARCHIVE() (在 stat 模块中)

FILE_ATTRIBUTE_COMPRESSED() (在 stat 模块中)

FILE_ATTRIBUTE_DEVICE() (在 stat 模块中)

FILE_ATTRIBUTE_DIRECTORY() (在 stat 模块中)

FILE_ATTRIBUTE_ENCRYPTED() (在 stat 模块中)

FILE_ATTRIBUTE_HIDDEN() (在 stat 模块中)

FILE_ATTRIBUTE_INTEGRITY_STREAM() (在 stat 模块中)

FILE_ATTRIBUTE_NO_SCRUB_DATA() (在 stat 模块中)

FILE_ATTRIBUTE_NORMAL() (在 stat 模块中)

FILE_ATTRIBUTE_NOT_CONTENT_INDEXED() (在 stat 模块中)

FILE_ATTRIBUTE_OFFLINE() (在 stat 模块中)

FILE_ATTRIBUTE_READONLY() (在 stat 模块中)

FILE_ATTRIBUTE_REPARSE_POINT() (在 stat 模块中)

FILE_ATTRIBUTE_SPARSE_FILE() (在 stat 模块中)

FILE_ATTRIBUTE_SYSTEM() (在 stat 模块中)

FILE_ATTRIBUTE_TEMPORARY() (在 stat 模块中)

FILE_ATTRIBUTE_VIRTUAL() (在 stat 模块中)

file_created()

內置函数

file_dispatcher (asyncore 中的类)

file_open() (urllib.request.FileHandler 方法)

file_size (zipfile.ZipInfo 属性)

file_wrapper (asyncore 中的类)

filecmp

模块

fileConfig() (在 logging.config 模块中)

FileCookieJar (http.cookiejar 中的类)

FileDialog (tkinter.filedialog 中的类)

FileEntry (tkinter.tix 中的类)

FileExistsError

FileFinder (importlib.machinery 中的类)

FileHandler (logging 中的类)

(urllib.request 中的类)

fileinput

模块

FileInput (fileinput 中的类)

FileIO (io 中的类)

filelineno() (在 fileinput 模块中)

FileLoader (importlib.abc 中的类)

filemode() (在 stat 模块中)

filename (doctest.DocTest 属性)

(http.cookiejar.FileCookieJar 属性)

(OSError 属性)

(SyntaxError 属性)

(traceback.TracebackException 属性)

(tracemalloc.Frame 属性)

(zipfile.ZipFile 属性)

(zipfile.ZipInfo 属性)

filename() (在 fileinput 模块中)

filename2 (OSError 属性)

filename_only() (在 tabnanny 模块中)

filename_pattern (tracemalloc.Filter 属性)

filenames

pathname expansion

wildcard expansion

fileno() (http.client.HTTPResponse 方法)

(io.IOBase 方法)

(multiprocessing.connection.Connection 方法)

(ossaudiodev.oss_audio_device 方法)

(ossaudiodev.oss_mixer_device 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.kqueue 方法)

(selectors.DevpollSelector 方法)

(selectors.EpollSelector 方法)

(selectors.KqueueSelector 方法)

(socket.socket 方法)

(socketserver.BaseServer 方法)

(telnetlib.Telnet 方法)

(在 fileinput 模块中)

FileNotFoundError

fileobj (selectors.SelectorKey 属性)

files() (在 importlib.resources 模块中)

files_double_event() (tkinter.filedialog.FileDialog 方法)

files_select_event() (tkinter.filedialog.FileDialog 方法)

FileSelectBox (tkinter.tix 中的类)

filesystem encoding and error handler -- 文件系统编码格式与错误处理器

FileType (argparse 中的类)

FileWrapper (wsgiref.util 中的类)

fill() (textwrap.TextWrapper 方法)

(在 textwrap 模块中)

fillcolor() (在 turtle 模块中)

filling() (在 turtle 模块中)

filter (2to3 fixer)

Filter (logging 中的类)

filter (select.kevent 属性)

Filter (tracemalloc 中的类)

filter()

內置函数

filter() (logging.Filter 方法)

(logging.Handler 方法)

(logging.Logger 方法)

(在 curses 模块中)

(在 fnmatch 模块中)

filter_command() (tkinter.filedialog.FileDialog 方法)

FILTER_DIR() (在 unittest.mock 模块中)

filter_traces() (tracemalloc.Snapshot 方法)

FilterError

filterfalse() (在 itertools 模块中)

filterwarnings() (在 warnings 模块中)

Final() (在 typing 模块中)

final() (在 typing 模块中)

finalization, of objects

finalize (weakref 中的类)

finalize_options() (distutils.cmd.Command 方法)

finalizer

finally

关键字, [1], [2], [3], [4]

find() (bytearray 方法)

(bytes 方法)

(doctest.DocTestFinder 方法)

(mmap.mmap 方法)

(str 方法)

(xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

(在 gettext 模块中)

find_class() (pickle protocol)

(pickle.Unpickler 方法)

find_library() (在 ctypes.util 模块中)

find_library_file() (distutils.ccompiler.CCompiler 方法)

find_loader() (importlib.abc.PathEntryFinder 方法)

(importlib.machinery.FileFinder 方法)

(zipimport.zipimporter 方法)

(在 importlib 模块中)

(在 pkgutil 模块中)

find_longest_match() (difflib.SequenceMatcher 方法)

find_module() (imp.NullImporter 方法)

(importlib.abc.Finder 方法)

(importlib.abc.MetaPathFinder 方法)

(importlib.abc.PathEntryFinder 方法)

(importlib.machinery.PathFinder 类方法)

(zipimport.zipimporter 方法)

(在 imp 模块中)

find_msvcrt() (在 ctypes.util 模块中)

find_spec

finder

find_spec() (importlib.abc.MetaPathFinder 方法)

(importlib.abc.PathEntryFinder 方法)

(importlib.machinery.FileFinder 方法)

(importlib.machinery.PathFinder 类方法)

(zipimport.zipimporter 方法)

(在 importlib.util 模块中)

find_unused_port() (在 test.support.socket_helper 模块中)

find_user_password() (urllib.request.HTTPPasswordMgr 方法)

(urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

findall() (re.Pattern 方法)

(xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

(在 re 模块中)

findCaller() (logging.Logger 方法)

finder

find_spec

Finder (importlib.abc 中的类)

finder -- 查找器

findfactor() (在 audioop 模块中)

findfile() (在 test.support 模块中)

findfit() (在 audioop 模块中)

finditer() (re.Pattern 方法)

(在 re 模块中)

findlabels() (在 dis 模块中)

findlinestarts() (在 dis 模块中)

findmatch() (在 mailcap 模块中)

findmax() (在 audioop 模块中)

findtext() (xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

finish() (socketserver.BaseRequestHandler 方法)

(tkinter.dnd.DndHandler 方法)

finish_request() (socketserver.BaseServer 方法)

firstChild (xml.dom.Node 属性)

firstkey() (dbm.gnu.gdbm 方法)

firstweekday() (在 calendar 模块中)

fix_missing_locations() (在 ast 模块中)

fix_sentence_endings (textwrap.TextWrapper 属性)

Flag (enum 中的类)

flag_bits (zipfile.ZipInfo 属性)

flags (re.Pattern 属性)

(select.kevent 属性)

flags() (在 sys 模块中)

flash() (在 curses 模块中)

flatten() (email.generator.BytesGenerator 方法)

(email.generator.Generator 方法)

flattening

objects

float

內置函数, [1], [2]

float (內置类)

float_info() (在 sys 模块中)

float_repr_style() (在 sys 模块中)

floating point

literals

number

对象, [1], [2]

floating point literal

FloatingPointError

FloatOperation (decimal 中的类)

flock() (在 fcntl 模块中)

floor division -- 向下取整除法

floor() (in module math)

(在 math 模块中)

FloorDiv (ast 中的类)

floordiv() (在 operator 模块中)

flush() (bz2.BZ2Compressor 方法)

(io.BufferedWriter 方法)

(io.IOBase 方法)

(logging.Handler 方法)

(logging.handlers.BufferingHandler 方法)

(logging.handlers.MemoryHandler 方法)

(logging.StreamHandler 方法)

(lzma.LZMACompressor 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.MH 方法)

(mmap.mmap 方法)

(xml.etree.ElementTree.XMLParser 方法)

(xml.etree.ElementTree.XMLPullParser 方法)

(zlib.Compress 方法)

(zlib.Decompress 方法)

flush_headers() (http.server.BaseHTTPRequestHandler 方法)

flushinp() (在 curses 模块中)

FlushKey() (在 winreg 模块中)

fma() (decimal.Context 方法)

(decimal.Decimal 方法)

fmean() (在 statistics 模块中)

fmod() (在 math 模块中)

FMT_BINARY() (在 plistlib 模块中)

FMT_XML() (在 plistlib 模块中)

fnmatch

模块

fnmatch() (在 fnmatch 模块中)

fnmatchcase() (在 fnmatch 模块中)

focus() (tkinter.ttk.Treeview 方法)

fold (datetime.datetime 属性)

(datetime.time 属性)

fold() (email.headerregistry.BaseHeader 方法)

(email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

fold_binary() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

Font (tkinter.font 中的类)

for

in comprehensions

语句, [1], [2], [3]

For (ast 中的类)

FOR_ITER (opcode)

forget() (tkinter.ttk.Notebook 方法)

(在 test.support.import_helper 模块中)

fork() (在 os 模块中)

(在 pty 模块中)

ForkingMixIn (socketserver 中的类)

ForkingTCPServer (socketserver 中的类)

ForkingUDPServer (socketserver 中的类)

forkpty() (在 os 模块中)

form

lambda

Form (tkinter.tix 中的类)

format (memoryview 属性)

(multiprocessing.shared_memory.ShareableList 属性)

(struct.Struct 属性)

format()

內置函数

format() (built-in function)

__str__() (object method)

format() (logging.BufferingFormatter 方法)

(logging.Formatter 方法)

(logging.Handler 方法)

(pprint.PrettyPrinter 方法)

(str 方法)

(string.Formatter 方法)

(traceback.StackSummary 方法)

(traceback.TracebackException 方法)

(tracemalloc.Traceback 方法)

(在 locale 模块中)

format_datetime() (在 email.utils 模块中)

format_exc() (在 traceback 模块中)

format_exception() (在 traceback 模块中)

format_exception_only() (traceback.TracebackException 方法)

(在 traceback 模块中)

format_field() (string.Formatter 方法)

format_help() (argparse.ArgumentParser 方法)

format_list() (在 traceback 模块中)

format_map() (str 方法)

format_stack() (在 traceback 模块中)

format_stack_entry() (bdb.Bdb 方法)

format_string() (在 locale 模块中)

format_tb() (在 traceback 模块中)

format_usage() (argparse.ArgumentParser 方法)

FORMAT_VALUE (opcode)

formataddr() (在 email.utils 模块中)

formatargspec() (在 inspect 模块中)

formatargvalues() (在 inspect 模块中)

formatdate() (在 email.utils 模块中)

FormatError

FormatError() (在 ctypes 模块中)

formatException() (logging.Formatter 方法)

formatFooter() (logging.BufferingFormatter 方法)

formatHeader() (logging.BufferingFormatter 方法)

formatmonth() (calendar.HTMLCalendar 方法)

(calendar.TextCalendar 方法)

formatStack() (logging.Formatter 方法)

formatted string literal

FormattedValue (ast 中的类)

Formatter (logging 中的类)

(string 中的类)

formatTime() (logging.Formatter 方法)

formatting

bytearray (%)

bytes (%)

formatting, string (%)

formatwarning() (在 warnings 模块中)

formatyear() (calendar.HTMLCalendar 方法)

(calendar.TextCalendar 方法)

formatyearpage() (calendar.HTMLCalendar 方法)

Fortran contiguous, [1]

forward() (在 turtle 模块中)

ForwardRef (typing 中的类)

found_terminator() (asynchat.async_chat 方法)

fpathconf() (在 os 模块中)

fqdn (smtpd.SMTPChannel 属性)

Fraction (fractions 中的类)

fractions

模块

frame

execution, [1]

对象

frame (tkinter.scrolledtext.ScrolledText 属性)

Frame (tracemalloc 中的类)

FrameSummary (traceback 中的类)

FrameType() (在 types 模块中)

free

variable

free()

freedesktop_os_release() (在 platform 模块中)

freefunc (C type)

freeze utility

freeze() (在 gc 模块中)

freeze_support() (在 multiprocessing 模块中)

frexp() (在 math 模块中)

FRIDAY() (在 calendar 模块中)

from

import statement, [1]

yield from expression

关键字, [1]

from_address() (ctypes._CData 方法)

from_buffer() (ctypes._CData 方法)

from_buffer_copy() (ctypes._CData 方法)

from_bytes() (int 类方法)

from_callable() (inspect.Signature 类方法)

from_decimal() (fractions.Fraction 类方法)

from_exception() (traceback.TracebackException 类方法)

from_file() (zipfile.ZipInfo 类方法)

(zoneinfo.ZoneInfo 类方法)

from_float() (decimal.Decimal 类方法)

(fractions.Fraction 类方法)

from_iterable() (itertools.chain 类方法)

from_list() (traceback.StackSummary 类方法)

from_param() (ctypes._CData 方法)

from_samples() (statistics.NormalDist 类方法)

from_traceback() (dis.Bytecode 类方法)

frombuf() (tarfile.TarInfo 类方法)

frombytes() (array.array 方法)

fromfd() (select.epoll 方法)

(select.kqueue 方法)

(在 socket 模块中)

fromfile() (array.array 方法)

fromhex() (bytearray 类方法)

(bytes 类方法)

(float 类方法)

fromisocalendar() (datetime.date 类方法)

(datetime.datetime 类方法)

fromisoformat() (datetime.date 类方法)

(datetime.datetime 类方法)

(datetime.time 类方法)

fromkeys() (collections.Counter 方法)

(dict 类方法)

fromlist() (array.array 方法)

fromordinal() (datetime.date 类方法)

(datetime.datetime 类方法)

fromshare() (在 socket 模块中)

fromstring() (在 xml.etree.ElementTree 模块中)

fromstringlist() (在 xml.etree.ElementTree 模块中)

fromtarfile() (tarfile.TarInfo 类方法)

fromtimestamp() (datetime.date 类方法)

(datetime.datetime 类方法)

fromunicode() (array.array 方法)

fromutc() (datetime.timezone 方法)

(datetime.tzinfo 方法)

FrozenImporter (importlib.machinery 中的类)

FrozenInstanceError

frozenset

对象, [1]

FrozenSet (typing 中的类)

frozenset (內置类)

fs_is_case_insensitive() (在 test.support.os_helper 模块中)

FS_NONASCII() (在 test.support.os_helper 模块中)

fsdecode() (在 os 模块中)

fsencode() (在 os 模块中)

fspath() (在 os 模块中)

fstat() (在 os 模块中)

fstatvfs() (在 os 模块中)

fstring

fsum() (在 math 模块中)

fsync() (在 os 模块中)

FTP

ftplib (standard module)

protocol, [1]

FTP (ftplib 中的类)

ftp_open() (urllib.request.FTPHandler 方法)

FTP_TLS (ftplib 中的类)

FTPHandler (urllib.request 中的类)

ftplib

模块

ftruncate() (在 os 模块中)

Full

full() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

full_url (urllib.request.Request 属性)

fullmatch() (re.Pattern 方法)

(在 re 模块中)

fully_trusted_filter() (在 tarfile 模块中)

func (functools.partial 属性)

funcattrs (2to3 fixer)

funcname (bdb.Breakpoint 属性)

function

annotations, [1]

anonymous

argument

call, [1], [2]

call, user-defined

definition, [1]

generator, [1]

name, [1]

user-defined

对象, [1], [2], [3], [4], [5]

Function (symtable 中的类)

function -- 函数

function annotation -- 函数标注

FunctionDef (ast 中的类)

FunctionTestCase (unittest 中的类)

FunctionType() (在 types 模块中)

functools

模块

funny_files (filecmp.dircmp 属性)

future

statement

future (2to3 fixer)

Future (asyncio 中的类)

(concurrent.futures 中的类)

FutureWarning

fwalk() (在 os 模块中)

索引 – G

G.722

gaierror

gamma() (在 math 模块中)

gammavariate() (在 random 模块中)

garbage collection

garbage collection -- 垃圾回收

garbage() (在 gc 模块中)

gather() (curses.textpad.Textbox 方法)

(在 asyncio 模块中)

gauss() (在 random 模块中)

gc

模块

gc_collect() (在 test.support 模块中)

gcd() (在 math 模块中)

ge() (在 operator 模块中)

gen_lib_options() (在 distutils.ccompiler 模块中)

gen_preprocess_options() (在 distutils.ccompiler 模块中)

GEN_START (opcode)

gen_uuid() (在 msilib 模块中)

generate_help() (distutils.fancy_getopt.FancyGetopt 方法)

generate_tokens() (在 tokenize 模块中)

generator

expression

function, [1], [2]

iterator, [1]

对象, [1], [2]

Generator (collections.abc 中的类)

(email.generator 中的类)

(typing 中的类)

generator -- 生成器

generator expression

generator expression -- 生成器表达式

generator iterator -- 生成器迭代器

GeneratorExit

例外, [1]

GeneratorExp (ast 中的类)

GeneratorType() (在 types 模块中)

Generic

Alias

generic

special attribute

Generic (typing 中的类)

generic function -- 泛型函数

generic type -- 泛型

generic_visit() (ast.NodeVisitor 方法)

GenericAlias

对象

GenericAlias (types 中的类)

genops() (在 pickletools 模块中)

geometric_mean() (在 statistics 模块中)

get() (asyncio.Queue 方法)

(configparser.ConfigParser 方法)

(contextvars.Context 方法)

(contextvars.ContextVar 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(multiprocessing.pool.AsyncResult 方法)

(multiprocessing.Queue 方法)

(multiprocessing.SimpleQueue 方法)

(ossaudiodev.oss_mixer_device 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

(tkinter.ttk.Combobox 方法)

(tkinter.ttk.Spinbox 方法)

(types.MappingProxyType 方法)

(xml.etree.ElementTree.Element 方法)

(在 webbrowser 模块中)

GET_AITER (opcode)

get_all() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(wsgiref.headers.Headers 方法)

get_all_breaks() (bdb.Bdb 方法)

get_all_start_methods() (在 multiprocessing 模块中)

GET_ANEXT (opcode)

get_annotations() (在 inspect 模块中)

get_app() (wsgiref.simple_server.WSGIServer 方法)

get_archive_formats() (在 shutil 模块中)

get_args() (在 typing 模块中)

get_asyncgen_hooks() (在 sys 模块中)

get_attribute() (在 test.support 模块中)

GET_AWAITABLE (opcode)

get_begidx() (在 readline 模块中)

get_blocking() (在 os 模块中)

get_body() (email.message.EmailMessage 方法)

get_body_encoding() (email.charset.Charset 方法)

get_boundary() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_bpbynumber() (bdb.Bdb 方法)

get_break() (bdb.Bdb 方法)

get_breaks() (bdb.Bdb 方法)

get_buffer() (asyncio.BufferedProtocol 方法)

(xdrlib.Packer 方法)

(xdrlib.Unpacker 方法)

get_bytes() (mailbox.Mailbox 方法)

get_ca_certs() (ssl.SSLContext 方法)

get_cache_token() (在 abc 模块中)

get_channel_binding() (ssl.SSLSocket 方法)

get_charset() (email.message.Message 方法)

get_charsets() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_child_watcher() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

get_children() (symtable.SymbolTable 方法)

(tkinter.ttk.Treeview 方法)

get_ciphers() (ssl.SSLContext 方法)

get_clock_info() (在 time 模块中)

get_close_matches() (在 difflib 模块中)

get_code() (importlib.abc.InspectLoader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

get_completer() (在 readline 模块中)

get_completer_delims() (在 readline 模块中)

get_completion_type() (在 readline 模块中)

get_config_h_filename() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_config_var() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_config_vars() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_content() (email.contentmanager.ContentManager 方法)

(email.message.EmailMessage 方法)

(在 email.contentmanager 模块中)

get_content_charset() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_disposition() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_maintype() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_subtype() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_type() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_context() (在 multiprocessing 模块中)

get_coro() (asyncio.Task 方法)

get_coroutine_origin_tracking_depth() (在 sys 模块中)

get_count() (在 gc 模块中)

get_current_history_length() (在 readline 模块中)

get_data() (importlib.abc.FileLoader 方法)

(importlib.abc.ResourceLoader 方法)

(zipimport.zipimporter 方法)

(在 pkgutil 模块中)

get_date() (mailbox.MaildirMessage 方法)

get_debug() (asyncio.loop 方法)

(在 gc 模块中)

get_default() (argparse.ArgumentParser 方法)

get_default_compiler() (在 distutils.ccompiler 模块中)

get_default_domain() (在 nis 模块中)

get_default_scheme() (在 sysconfig 模块中)

get_default_type() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_default_verify_paths() (在 ssl 模块中)

get_dialect() (在 csv 模块中)

get_disassembly_as_string() (test.support.bytecode_helper.BytecodeTestCase 方法)

get_docstring() (在 ast 模块中)

get_doctest() (doctest.DocTestParser 方法)

get_endidx() (在 readline 模块中)

get_environ() (wsgiref.simple_server.WSGIRequestHandler 方法)

get_errno() (在 ctypes 模块中)

get_escdelay() (在 curses 模块中)

get_event_loop() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

get_event_loop_policy() (在 asyncio 模块中)

get_examples() (doctest.DocTestParser 方法)

get_exception_handler() (asyncio.loop 方法)

get_exec_path() (在 os 模块中)

get_extra_info() (asyncio.BaseTransport 方法)

(asyncio.StreamWriter 方法)

get_field() (string.Formatter 方法)

get_file() (mailbox.Babyl 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.mbox 方法)

(mailbox.MH 方法)

(mailbox.MMDF 方法)

get_file_breaks() (bdb.Bdb 方法)

get_filename() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(importlib.abc.ExecutionLoader 方法)

(importlib.abc.FileLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(zipimport.zipimporter 方法)

get_filter() (tkinter.filedialog.FileDialog 方法)

get_flags() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

get_folder() (mailbox.Maildir 方法)

(mailbox.MH 方法)

get_frees() (symtable.Function 方法)

get_freeze_count() (在 gc 模块中)

get_from() (mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

get_full_url() (urllib.request.Request 方法)

get_globals() (symtable.Function 方法)

get_grouped_opcodes() (difflib.SequenceMatcher 方法)

get_handle_inheritable() (在 os 模块中)

get_header() (urllib.request.Request 方法)

get_history_item() (在 readline 模块中)

get_history_length() (在 readline 模块中)

get_id() (symtable.SymbolTable 方法)

get_ident() (在 _thread 模块中)

(在 threading 模块中)

get_identifiers() (symtable.SymbolTable 方法)

get_importer() (在 pkgutil 模块中)

get_info() (mailbox.MaildirMessage 方法)

get_inheritable() (socket.socket 方法)

(在 os 模块中)

get_instructions() (在 dis 模块中)

get_int_max_str_digits() (在 sys 模块中)

get_interpreter() (在 zipapp 模块中)

GET_ITER (opcode)

get_key() (selectors.BaseSelector 方法)

get_labels() (mailbox.Babyl 方法)

(mailbox.BabylMessage 方法)

get_last_error() (在 ctypes 模块中)

GET_LEN (opcode)

get_line_buffer() (在 readline 模块中)

get_lineno() (symtable.SymbolTable 方法)

get_loader() (在 pkgutil 模块中)

get_locals() (symtable.Function 方法)

get_logger() (在 multiprocessing 模块中)

get_loop() (asyncio.Future 方法)

(asyncio.Server 方法)

get_magic() (在 imp 模块中)

get_makefile_filename() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_map() (selectors.BaseSelector 方法)

get_matching_blocks() (difflib.SequenceMatcher 方法)

get_message() (mailbox.Mailbox 方法)

get_method() (urllib.request.Request 方法)

get_methods() (symtable.Class 方法)

get_mixed_type_key() (在 ipaddress 模块中)

get_name() (asyncio.Task 方法)

(symtable.Symbol 方法)

(symtable.SymbolTable 方法)

get_namespace() (symtable.Symbol 方法)

get_namespaces() (symtable.Symbol 方法)

get_native_id() (在 _thread 模块中)

(在 threading 模块中)

get_nonlocals() (symtable.Function 方法)

get_nonstandard_attr() (http.cookiejar.Cookie 方法)

get_nowait() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

get_object_traceback() (在 tracemalloc 模块中)

get_objects() (在 gc 模块中)

get_opcodes() (difflib.SequenceMatcher 方法)

get_option() (optparse.OptionParser 方法)

get_option_group() (optparse.OptionParser 方法)

get_option_order() (distutils.fancy_getopt.FancyGetopt 方法)

get_origin() (在 typing 模块中)

get_original_stdout() (在 test.support 模块中)

get_osfhandle() (在 msvcrt 模块中)

get_output_charset() (email.charset.Charset 方法)

get_param() (email.message.Message 方法)

get_parameters() (symtable.Function 方法)

get_params() (email.message.Message 方法)

get_path() (在 sysconfig 模块中)

get_path_names() (在 sysconfig 模块中)

get_paths() (在 sysconfig 模块中)

get_payload() (email.message.Message 方法)

get_pid() (asyncio.SubprocessTransport 方法)

get_pipe_transport() (asyncio.SubprocessTransport 方法)

get_platform() (在 distutils.util 模块中)

(在 sysconfig 模块中)

get_poly() (在 turtle 模块中)

get_position() (xdrlib.Unpacker 方法)

get_preferred_scheme() (在 sysconfig 模块中)

get_protocol() (asyncio.BaseTransport 方法)

get_python_inc() (在 distutils.sysconfig 模块中)

get_python_lib() (在 distutils.sysconfig 模块中)

get_python_version() (在 sysconfig 模块中)

get_ready() (graphlib.TopologicalSorter 方法)

get_recsrc() (ossaudiodev.oss_mixer_device 方法)

get_referents() (在 gc 模块中)

get_referrers() (在 gc 模块中)

get_request() (socketserver.BaseServer 方法)

get_returncode() (asyncio.SubprocessTransport 方法)

get_running_loop() (在 asyncio 模块中)

get_scheme() (wsgiref.handlers.BaseHandler 方法)

get_scheme_names() (在 sysconfig 模块中)

get_selection() (tkinter.filedialog.FileDialog 方法)

get_sequences() (mailbox.MH 方法)

(mailbox.MHMessage 方法)

get_server() (multiprocessing.managers.BaseManager 方法)

get_server_certificate() (在 ssl 模块中)

get_shapepoly() (在 turtle 模块中)

get_socket() (telnetlib.Telnet 方法)

get_source() (importlib.abc.InspectLoader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

get_source_segment() (在 ast 模块中)

get_special_folder_path()

內置函数

get_stack() (asyncio.Task 方法)

(bdb.Bdb 方法)

get_start_method() (在 multiprocessing 模块中)

get_starttag_text() (html.parser.HTMLParser 方法)

get_stats() (在 gc 模块中)

get_stats_profile() (pstats.Stats 方法)

get_stderr() (wsgiref.handlers.BaseHandler 方法)

(wsgiref.simple_server.WSGIRequestHandler 方法)

get_stdin() (wsgiref.handlers.BaseHandler 方法)

get_string() (mailbox.Mailbox 方法)

get_subdir() (mailbox.MaildirMessage 方法)

get_suffixes() (在 imp 模块中)

get_symbols() (symtable.SymbolTable 方法)

get_tabsize() (在 curses 模块中)

get_tag() (在 imp 模块中)

get_task_factory() (asyncio.loop 方法)

get_terminal_size() (在 os 模块中)

(在 shutil 模块中)

get_terminator() (asynchat.async_chat 方法)

get_threshold() (在 gc 模块中)

get_token() (shlex.shlex 方法)

get_traceback_limit() (在 tracemalloc 模块中)

get_traced_memory() (在 tracemalloc 模块中)

get_tracemalloc_memory() (在 tracemalloc 模块中)

get_type() (symtable.SymbolTable 方法)

get_type_hints() (在 typing 模块中)

get_unixfrom() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_unpack_formats() (在 shutil 模块中)

get_usage() (optparse.OptionParser 方法)

get_value() (string.Formatter 方法)

get_version() (optparse.OptionParser 方法)

get_visible() (mailbox.BabylMessage 方法)

get_wch() (curses.window 方法)

get_write_buffer_limits() (asyncio.WriteTransport 方法)

get_write_buffer_size() (asyncio.WriteTransport 方法)

GET_YIELD_FROM_ITER (opcode)

getacl() (imaplib.IMAP4 方法)

getaddresses() (在 email.utils 模块中)

getaddrinfo() (asyncio.loop 方法)

(在 socket 模块中)

getallocatedblocks() (在 sys 模块中)

getandroidapilevel() (在 sys 模块中)

getannotation() (imaplib.IMAP4 方法)

getargspec() (在 inspect 模块中)

getargvalues() (在 inspect 模块中)

getatime() (在 os.path 模块中)

getattr()

內置函数

getattr_static() (在 inspect 模块中)

getattrfunc (C type)

getAttribute() (xml.dom.Element 方法)

getAttributeNode() (xml.dom.Element 方法)

getAttributeNodeNS() (xml.dom.Element 方法)

getAttributeNS() (xml.dom.Element 方法)

getattrofunc (C type)

GetBase() (xml.parsers.expat.xmlparser 方法)

getbegyx() (curses.window 方法)

getbkgd() (curses.window 方法)

getblocking() (socket.socket 方法)

getboolean() (configparser.ConfigParser 方法)

getbuffer() (io.BytesIO 方法)

getbufferproc (C type)

getByteStream() (xml.sax.xmlreader.InputSource 方法)

getcallargs() (在 inspect 模块中)

getcanvas() (在 turtle 模块中)

getcapabilities() (nntplib.NNTP 方法)

getcaps() (在 mailcap 模块中)

getch() (curses.window 方法)

(在 msvcrt 模块中)

getCharacterStream() (xml.sax.xmlreader.InputSource 方法)

getche() (在 msvcrt 模块中)

getChild() (logging.Logger 方法)

getclasstree() (在 inspect 模块中)

getclosurevars() (在 inspect 模块中)

getcode() (http.client.HTTPResponse 方法)

(urllib.response.addinfourl 方法)

GetColumnInfo() (msilib.View 方法)

getColumnNumber() (xml.sax.xmlreader.Locator 方法)

getcomments() (在 inspect 模块中)

getcompname() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getcomptype() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getContentHandler() (xml.sax.xmlreader.XMLReader 方法)

getcontext() (在 decimal 模块中)

getcoroutinelocals() (在 inspect 模块中)

getcoroutinestate() (在 inspect 模块中)

getctime() (在 os.path 模块中)

getcwd() (在 os 模块中)

getcwdb() (在 os 模块中)

getcwdu (2to3 fixer)

getdecoder() (在 codecs 模块中)

getdefaultencoding() (在 sys 模块中)

getdefaultlocale() (在 locale 模块中)

getdefaulttimeout() (在 socket 模块中)

getdlopenflags() (在 sys 模块中)

getdoc() (在 inspect 模块中)

getDOMImplementation() (在 xml.dom 模块中)

getDTDHandler() (xml.sax.xmlreader.XMLReader 方法)

getEffectiveLevel() (logging.Logger 方法)

getegid() (在 os 模块中)

getElementsByTagName() (xml.dom.Document 方法)

(xml.dom.Element 方法)

getElementsByTagNameNS() (xml.dom.Document 方法)

(xml.dom.Element 方法)

getencoder() (在 codecs 模块中)

getEncoding() (xml.sax.xmlreader.InputSource 方法)

getEntityResolver() (xml.sax.xmlreader.XMLReader 方法)

getenv() (在 os 模块中)

getenvb() (在 os 模块中)

getErrorHandler() (xml.sax.xmlreader.XMLReader 方法)

geteuid() (在 os 模块中)

getEvent() (xml.dom.pulldom.DOMEventStream 方法)

getEventCategory() (logging.handlers.NTEventLogHandler 方法)

getEventType() (logging.handlers.NTEventLogHandler 方法)

getException() (xml.sax.SAXException 方法)

getFeature() (xml.sax.xmlreader.XMLReader 方法)

GetFieldCount() (msilib.Record 方法)

getfile() (在 inspect 模块中)

getFilesToDelete() (logging.handlers.TimedRotatingFileHandler 方法)

getfilesystemencodeerrors() (在 sys 模块中)

getfilesystemencoding() (在 sys 模块中)

getfirst() (cgi.FieldStorage 方法)

getfloat() (configparser.ConfigParser 方法)

getfmts() (ossaudiodev.oss_audio_device 方法)

getfqdn() (在 socket 模块中)

getframeinfo() (在 inspect 模块中)

getframerate() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getfullargspec() (在 inspect 模块中)

getgeneratorlocals() (在 inspect 模块中)

getgeneratorstate() (在 inspect 模块中)

getgid() (在 os 模块中)

getgrall() (在 grp 模块中)

getgrgid() (在 grp 模块中)

getgrnam() (在 grp 模块中)

getgrouplist() (在 os 模块中)

getgroups() (在 os 模块中)

getheader() (http.client.HTTPResponse 方法)

getheaders() (http.client.HTTPResponse 方法)

gethostbyaddr() (in module socket)

(在 socket 模块中)

gethostbyname() (在 socket 模块中)

gethostbyname_ex() (在 socket 模块中)

gethostname() (in module socket)

(在 socket 模块中)

getincrementaldecoder() (在 codecs 模块中)

getincrementalencoder() (在 codecs 模块中)

getinfo() (zipfile.ZipFile 方法)

getinnerframes() (在 inspect 模块中)

GetInputContext() (xml.parsers.expat.xmlparser 方法)

getint() (configparser.ConfigParser 方法)

GetInteger() (msilib.Record 方法)

getitem() (在 operator 模块中)

getiterfunc (C type)

getitimer() (在 signal 模块中)

getkey() (curses.window 方法)

GetLastError() (在 ctypes 模块中)

getLength() (xml.sax.xmlreader.Attributes 方法)

getLevelName() (在 logging 模块中)

getline() (在 linecache 模块中)

getLineNumber() (xml.sax.xmlreader.Locator 方法)

getlist() (cgi.FieldStorage 方法)

getloadavg() (在 os 模块中)

getlocale() (在 locale 模块中)

getLogger() (在 logging 模块中)

getLoggerClass() (在 logging 模块中)

getlogin() (在 os 模块中)

getLogRecordFactory() (在 logging 模块中)

getmark() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getmarkers() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getmaxyx() (curses.window 方法)

getmember() (tarfile.TarFile 方法)

getmembers() (tarfile.TarFile 方法)

(在 inspect 模块中)

getMessage() (logging.LogRecord 方法)

(xml.sax.SAXException 方法)

getMessageID() (logging.handlers.NTEventLogHandler 方法)

getmodule() (在 inspect 模块中)

getmodulename() (在 inspect 模块中)

getmouse() (在 curses 模块中)

getmro() (在 inspect 模块中)

getmtime() (在 os.path 模块中)

getname() (chunk.Chunk 方法)

getName() (threading.Thread 方法)

getNameByQName() (xml.sax.xmlreader.AttributesNS 方法)

getnameinfo() (asyncio.loop 方法)

(在 socket 模块中)

getnames() (tarfile.TarFile 方法)

getNames() (xml.sax.xmlreader.Attributes 方法)

getnchannels() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getnframes() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getnode

getnode() (在 uuid 模块中)

getopt

模块

getopt() (distutils.fancy_getopt.FancyGetopt 方法)

(在 getopt 模块中)

GetoptError

getouterframes() (在 inspect 模块中)

getoutput() (在 subprocess 模块中)

getpagesize() (在 resource 模块中)

getparams() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getparyx() (curses.window 方法)

getpass

模块

getpass() (在 getpass 模块中)

GetPassWarning

getpeercert() (ssl.SSLSocket 方法)

getpeername() (socket.socket 方法)

getpen() (在 turtle 模块中)

getpgid() (在 os 模块中)

getpgrp() (在 os 模块中)

getpid() (在 os 模块中)

getpos() (html.parser.HTMLParser 方法)

getppid() (在 os 模块中)

getpreferredencoding() (在 locale 模块中)

getpriority() (在 os 模块中)

getprofile() (在 sys 模块中)

(在 threading 模块中)

GetProperty() (msilib.SummaryInformation 方法)

getProperty() (xml.sax.xmlreader.XMLReader 方法)

GetPropertyCount() (msilib.SummaryInformation 方法)

getprotobyname() (在 socket 模块中)

getproxies() (在 urllib.request 模块中)

getPublicId() (xml.sax.xmlreader.InputSource 方法)

(xml.sax.xmlreader.Locator 方法)

getpwall() (在 pwd 模块中)

getpwnam() (在 pwd 模块中)

getpwuid() (在 pwd 模块中)

getQNameByName() (xml.sax.xmlreader.AttributesNS 方法)

getQNames() (xml.sax.xmlreader.AttributesNS 方法)

getquota() (imaplib.IMAP4 方法)

getquotaroot() (imaplib.IMAP4 方法)

getrandbits() (在 random 模块中)

getrandom() (在 os 模块中)

getreader() (在 codecs 模块中)

getrecursionlimit() (在 sys 模块中)

getrefcount() (在 sys 模块中)

GetReparseDeferralEnabled() (xml.parsers.expat.xmlparser 方法)

getresgid() (在 os 模块中)

getresponse() (http.client.HTTPConnection 方法)

getresuid() (在 os 模块中)

getrlimit() (在 resource 模块中)

getroot() (xml.etree.ElementTree.ElementTree 方法)

getrusage() (在 resource 模块中)

getsample() (在 audioop 模块中)

getsampwidth() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getscreen() (在 turtle 模块中)

getservbyname() (在 socket 模块中)

getservbyport() (在 socket 模块中)

GetSetDescriptorType() (在 types 模块中)

getshapes() (在 turtle 模块中)

getsid() (在 os 模块中)

getsignal() (在 signal 模块中)

getsitepackages() (在 site 模块中)

getsize() (chunk.Chunk 方法)

(在 os.path 模块中)

getsizeof() (在 sys 模块中)

getsockname() (socket.socket 方法)

getsockopt() (socket.socket 方法)

getsource() (在 inspect 模块中)

getsourcefile() (在 inspect 模块中)

getsourcelines() (在 inspect 模块中)

getspall() (在 spwd 模块中)

getspnam() (在 spwd 模块中)

getstate() (codecs.IncrementalDecoder 方法)

(codecs.IncrementalEncoder 方法)

(在 random 模块中)

getstatusoutput() (在 subprocess 模块中)

getstr() (curses.window 方法)

GetString() (msilib.Record 方法)

getSubject() (logging.handlers.SMTPHandler 方法)

GetSummaryInformation() (msilib.Database 方法)

getswitchinterval() (在 sys 模块中)

getSystemId() (xml.sax.xmlreader.InputSource 方法)

(xml.sax.xmlreader.Locator 方法)

getsyx() (在 curses 模块中)

gettarinfo() (tarfile.TarFile 方法)

gettempdir() (在 tempfile 模块中)

gettempdirb() (在 tempfile 模块中)

gettempprefix() (在 tempfile 模块中)

gettempprefixb() (在 tempfile 模块中)

getTestCaseNames() (unittest.TestLoader 方法)

gettext

模块

gettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

(在 locale 模块中)

gettimeout() (socket.socket 方法)

gettrace() (在 sys 模块中)

(在 threading 模块中)

getturtle() (在 turtle 模块中)

getType() (xml.sax.xmlreader.Attributes 方法)

getuid() (在 os 模块中)

geturl() (http.client.HTTPResponse 方法)

(urllib.parse.urllib.parse.SplitResult 方法)

(urllib.response.addinfourl 方法)

getuser() (在 getpass 模块中)

getuserbase() (在 site 模块中)

getusersitepackages() (在 site 模块中)

getvalue() (io.BytesIO 方法)

(io.StringIO 方法)

getValue() (xml.sax.xmlreader.Attributes 方法)

getValueByQName() (xml.sax.xmlreader.AttributesNS 方法)

getwch() (在 msvcrt 模块中)

getwche() (在 msvcrt 模块中)

getweakrefcount() (在 weakref 模块中)

getweakrefs() (在 weakref 模块中)

getwelcome() (ftplib.FTP 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

getwin() (在 curses 模块中)

getwindowsversion() (在 sys 模块中)

getwriter() (在 codecs 模块中)

getxattr() (在 os 模块中)

getyx() (curses.window 方法)

gid (tarfile.TarInfo 属性)

GIL

glob

模块, [1]

glob() (msilib.Directory 方法)

(pathlib.Path 方法)

(在 glob 模块中)

global

name binding

namespace

语句, [1]

Global (ast 中的类)

global interpreter lock

global interpreter lock -- 全局解释器锁

globals()

內置函数

globs (doctest.DocTest 属性)

gmtime() (在 time 模块中)

gname (tarfile.TarInfo 属性)

GNOME

GNU_FORMAT() (在 tarfile 模块中)

gnu_getopt() (在 getopt 模块中)

GNUTranslations (gettext 中的类)

go() (tkinter.filedialog.FileDialog 方法)

got (doctest.DocTestFailure 属性)

goto() (在 turtle 模块中)

grammar

Graphical User Interface

graphlib

模块

GREATER() (在 token 模块中)

GREATEREQUAL() (在 token 模块中)

Greenwich Mean Time

GRND_NONBLOCK() (在 os 模块中)

GRND_RANDOM() (在 os 模块中)

Group (email.headerregistry 中的类)

group() (nntplib.NNTP 方法)

(pathlib.Path 方法)

(re.Match 方法)

groupby() (在 itertools 模块中)

groupdict() (re.Match 方法)

groupindex (re.Pattern 属性)

grouping

groups (email.headerregistry.AddressHeader 属性)

(re.Pattern 属性)

groups() (re.Match 方法)

grp

模块

Gt (ast 中的类)

gt() (在 operator 模块中)

GtE (ast 中的类)

guard

guess_all_extensions() (mimetypes.MimeTypes 方法)

(在 mimetypes 模块中)

guess_extension() (mimetypes.MimeTypes 方法)

(在 mimetypes 模块中)

guess_scheme() (在 wsgiref.util 模块中)

guess_type() (mimetypes.MimeTypes 方法)

(在 mimetypes 模块中)

GUI

gzip

模块

gzip command line option

--best

--decompress

--fast

--help

-d

-h

file

GzipFile (gzip 中的类)

索引 – H

halfdelay() (在 curses 模块中)

Handle (asyncio 中的类)

handle an exception

handle() (http.server.BaseHTTPRequestHandler 方法)

(logging.Handler 方法)

(logging.handlers.QueueListener 方法)

(logging.Logger 方法)

(logging.NullHandler 方法)

(socketserver.BaseRequestHandler 方法)

(wsgiref.simple_server.WSGIRequestHandler 方法)

handle_accept() (asyncore.dispatcher 方法)

handle_accepted() (asyncore.dispatcher 方法)

handle_charref() (html.parser.HTMLParser 方法)

handle_close() (asyncore.dispatcher 方法)

handle_comment() (html.parser.HTMLParser 方法)

handle_connect() (asyncore.dispatcher 方法)

handle_data() (html.parser.HTMLParser 方法)

handle_decl() (html.parser.HTMLParser 方法)

handle_defect() (email.policy.Policy 方法)

handle_endtag() (html.parser.HTMLParser 方法)

handle_entityref() (html.parser.HTMLParser 方法)

handle_error() (asyncore.dispatcher 方法)

(socketserver.BaseServer 方法)

handle_expect_100() (http.server.BaseHTTPRequestHandler 方法)

handle_expt() (asyncore.dispatcher 方法)

handle_one_request() (http.server.BaseHTTPRequestHandler 方法)

handle_pi() (html.parser.HTMLParser 方法)

handle_read() (asyncore.dispatcher 方法)

handle_request() (socketserver.BaseServer 方法)

(xmlrpc.server.CGIXMLRPCRequestHandler 方法)

handle_startendtag() (html.parser.HTMLParser 方法)

handle_starttag() (html.parser.HTMLParser 方法)

handle_timeout() (socketserver.BaseServer 方法)

handle_write() (asyncore.dispatcher 方法)

handleError() (logging.Handler 方法)

(logging.handlers.SocketHandler 方法)

handler

exception

Handler (logging 中的类)

handler() (在 cgitb 模块中)

hardlink_to() (pathlib.Path 方法)

harmonic_mean() (在 statistics 模块中)

HAS_ALPN() (在 ssl 模块中)

has_children() (symtable.SymbolTable 方法)

has_colors() (在 curses 模块中)

has_dualstack_ipv6() (在 socket 模块中)

HAS_ECDH() (在 ssl 模块中)

has_extended_color_support() (在 curses 模块中)

has_extn() (smtplib.SMTP 方法)

has_function() (distutils.ccompiler.CCompiler 方法)

has_header() (csv.Sniffer 方法)

(urllib.request.Request 方法)

has_ic() (在 curses 模块中)

has_il() (在 curses 模块中)

has_ipv6() (在 socket 模块中)

has_key (2to3 fixer)

has_key() (在 curses 模块中)

has_location (importlib.machinery.ModuleSpec 属性)

HAS_NEVER_CHECK_COMMON_NAME() (在 ssl 模块中)

has_nonstandard_attr() (http.cookiejar.Cookie 方法)

HAS_NPN() (在 ssl 模块中)

has_option() (configparser.ConfigParser 方法)

(optparse.OptionParser 方法)

has_section() (configparser.ConfigParser 方法)

HAS_SNI() (在 ssl 模块中)

HAS_SSLv2() (在 ssl 模块中)

HAS_SSLv3() (在 ssl 模块中)

has_ticket (ssl.SSLSession 属性)

HAS_TLSv1() (在 ssl 模块中)

HAS_TLSv1_1() (在 ssl 模块中)

HAS_TLSv1_2() (在 ssl 模块中)

HAS_TLSv1_3() (在 ssl 模块中)

hasattr()

內置函数

hasAttribute() (xml.dom.Element 方法)

hasAttributeNS() (xml.dom.Element 方法)

hasAttributes() (xml.dom.Node 方法)

hasChildNodes() (xml.dom.Node 方法)

hascompare() (在 dis 模块中)

hasconst() (在 dis 模块中)

hasFeature() (xml.dom.DOMImplementation 方法)

hasfree() (在 dis 模块中)

hash

內置函数, [1], [2], [3]

hash character

hash()

內置函数

hash-based pyc -- 基于哈希的 pyc

hash.block_size() (在 hashlib 模块中)

hash.digest_size() (在 hashlib 模块中)

hash_info() (在 sys 模块中)

hashable

Hashable (collections.abc 中的类)

(typing 中的类)

hashable -- 可哈希

hasHandlers() (logging.Logger 方法)

hashfunc (C type)

hashlib

模块

hasjabs() (在 dis 模块中)

hasjrel() (在 dis 模块中)

haslocal() (在 dis 模块中)

hasname() (在 dis 模块中)

HAVE_ARGUMENT (opcode)

HAVE_CONTEXTVAR() (在 decimal 模块中)

HAVE_DOCSTRINGS() (在 test.support 模块中)

HAVE_THREADS() (在 decimal 模块中)

HCI_DATA_DIR() (在 socket 模块中)

HCI_FILTER() (在 socket 模块中)

HCI_TIME_STAMP() (在 socket 模块中)

head() (nntplib.NNTP 方法)

Header (email.header 中的类)

header_encode() (email.charset.Charset 方法)

header_encode_lines() (email.charset.Charset 方法)

header_encoding (email.charset.Charset 属性)

header_factory (email.policy.EmailPolicy 属性)

header_fetch_parse() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

header_items() (urllib.request.Request 方法)

header_max_count() (email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

header_offset (zipfile.ZipInfo 属性)

header_source_parse() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

header_store_parse() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

HeaderError

HeaderParseError

HeaderParser (email.parser 中的类)

HeaderRegistry (email.headerregistry 中的类)

headers

MIME, [1]

headers (http.client.HTTPResponse 属性)

(http.server.BaseHTTPRequestHandler 属性)

(urllib.error.HTTPError 属性)

(urllib.response.addinfourl 属性)

Headers (wsgiref.headers 中的类)

headers (xmlrpc.client.ProtocolError 属性)

HeaderWriteError

heading() (tkinter.ttk.Treeview 方法)

(在 turtle 模块中)

heapify() (在 heapq 模块中)

heapmin() (在 msvcrt 模块中)

heappop() (在 heapq 模块中)

heappush() (在 heapq 模块中)

heappushpop() (在 heapq 模块中)

heapq

模块

heapreplace() (在 heapq 模块中)

helo() (smtplib.SMTP 方法)

help

online

內置函数

help (optparse.Option 属性)

(pdb command)

help()

內置函数

help() (nntplib.NNTP 方法)

herror

hex (uuid.UUID 属性)

hex()

內置函数

hex() (bytearray 方法)

(bytes 方法)

(float 方法)

(memoryview 方法)

hexadecimal

literals

hexadecimal literal

hexbin() (在 binhex 模块中)

hexdigest() (hashlib.hash 方法)

(hashlib.shake 方法)

(hmac.HMAC 方法)

hexdigits() (在 string 模块中)

hexlify() (在 binascii 模块中)

hexversion() (在 sys 模块中)

hidden() (curses.panel.Panel 方法)

hide() (curses.panel.Panel 方法)

(tkinter.ttk.Notebook 方法)

hide_cookie2 (http.cookiejar.CookiePolicy 属性)

hideturtle() (在 turtle 模块中)

hierarchy

type

HierarchyRequestErr

HIGH_PRIORITY_CLASS() (在 subprocess 模块中)

HIGHEST_PROTOCOL() (在 pickle 模块中)

hits (bdb.Breakpoint 属性)

HKEY_CLASSES_ROOT() (在 winreg 模块中)

HKEY_CURRENT_CONFIG() (在 winreg 模块中)

HKEY_CURRENT_USER() (在 winreg 模块中)

HKEY_DYN_DATA() (在 winreg 模块中)

HKEY_LOCAL_MACHINE() (在 winreg 模块中)

HKEY_PERFORMANCE_DATA() (在 winreg 模块中)

HKEY_USERS() (在 winreg 模块中)

hline() (curses.window 方法)

HList (tkinter.tix 中的类)

hls_to_rgb() (在 colorsys 模块中)

hmac

模块

HOME, [1], [2], [3], [4], [5], [6], [7], [8], [9]

home() (pathlib.Path 类方法)

(在 turtle 模块中)

HOMEDRIVE, [1]

HOMEPATH, [1]

hook_compressed() (在 fileinput 模块中)

hook_encoded() (在 fileinput 模块中)

hooks

import

meta

path

host (urllib.request.Request 属性)

hostmask (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

hostname_checks_common_name (ssl.SSLContext 属性)

hosts (netrc.netrc 属性)

hosts() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

hour (datetime.datetime 属性)

(datetime.time 属性)

HRESULT (ctypes 中的类)

hStdError (subprocess.STARTUPINFO 属性)

hStdInput (subprocess.STARTUPINFO 属性)

hStdOutput (subprocess.STARTUPINFO 属性)

hsv_to_rgb() (在 colorsys 模块中)

ht() (在 turtle 模块中)

HTML, [1]

html

模块

html() (在 cgitb 模块中)

html.entities

模块

html.parser

模块

html5() (在 html.entities 模块中)

HTMLCalendar (calendar 中的类)

HtmlDiff (difflib 中的类)

HTMLParser (html.parser 中的类)

htonl() (在 socket 模块中)

htons() (在 socket 模块中)

HTTP

http (standard module)

http.client (standard module)

protocol, [1], [2], [3], [4], [5]

http

模块

HTTP() (在 email.policy 模块中)

http.client

模块

http.cookiejar

模块

http.cookies

模块

http.server

security

模块

http_error_301() (urllib.request.HTTPRedirectHandler 方法)

http_error_302() (urllib.request.HTTPRedirectHandler 方法)

http_error_303() (urllib.request.HTTPRedirectHandler 方法)

http_error_307() (urllib.request.HTTPRedirectHandler 方法)

http_error_401() (urllib.request.HTTPBasicAuthHandler 方法)

(urllib.request.HTTPDigestAuthHandler 方法)

http_error_407() (urllib.request.ProxyBasicAuthHandler 方法)

(urllib.request.ProxyDigestAuthHandler 方法)

http_error_auth_reqed() (urllib.request.AbstractBasicAuthHandler 方法)

(urllib.request.AbstractDigestAuthHandler 方法)

http_error_default() (urllib.request.BaseHandler 方法)

http_open() (urllib.request.HTTPHandler 方法)

HTTP_PORT() (在 http.client 模块中)

http_proxy, [1], [2]

http_response() (urllib.request.HTTPErrorProcessor 方法)

http_version (wsgiref.handlers.BaseHandler 属性)

HTTPBasicAuthHandler (urllib.request 中的类)

HTTPConnection (http.client 中的类)

HTTPCookieProcessor (urllib.request 中的类)

httpd

HTTPDefaultErrorHandler (urllib.request 中的类)

HTTPDigestAuthHandler (urllib.request 中的类)

HTTPError

HTTPErrorProcessor (urllib.request 中的类)

HTTPException

HTTPHandler (logging.handlers 中的类)

(urllib.request 中的类)

HTTPPasswordMgr (urllib.request 中的类)

HTTPPasswordMgrWithDefaultRealm (urllib.request 中的类)

HTTPPasswordMgrWithPriorAuth (urllib.request 中的类)

HTTPRedirectHandler (urllib.request 中的类)

HTTPResponse (http.client 中的类)

https_open() (urllib.request.HTTPSHandler 方法)

HTTPS_PORT() (在 http.client 模块中)

https_response() (urllib.request.HTTPErrorProcessor 方法)

HTTPSConnection (http.client 中的类)

HTTPServer (http.server 中的类)

HTTPSHandler (urllib.request 中的类)

HTTPStatus (http 中的类)

hypot() (在 math 模块中)

索引 – I

I() (在 re 模块中)

I/O control

buffering, [1]

POSIX

tty

UNIX

iadd() (在 operator 模块中)

iand() (在 operator 模块中)

iconcat() (在 operator 模块中)

id

內置函数

id (ssl.SSLSession 属性)

id()

內置函数

id() (unittest.TestCase 方法)

idcok() (curses.window 方法)

ident (select.kevent 属性)

(threading.Thread 属性)

identchars (cmd.Cmd 属性)

identifier, [1]

identify() (tkinter.ttk.Notebook 方法)

(tkinter.ttk.Treeview 方法)

(tkinter.ttk.Widget 方法)

identify_column() (tkinter.ttk.Treeview 方法)

identify_element() (tkinter.ttk.Treeview 方法)

identify_region() (tkinter.ttk.Treeview 方法)

identify_row() (tkinter.ttk.Treeview 方法)

identity

test

identity of an object

idioms (2to3 fixer)

IDLE, [1]

IDLE_PRIORITY_CLASS() (在 subprocess 模块中)

idlelib

模块

IDLESTARTUP

idlok() (curses.window 方法)

if

conditional expression

in comprehensions

关键字

语句, [1]

If (ast 中的类)

if_indextoname() (在 socket 模块中)

if_nameindex() (在 socket 模块中)

if_nametoindex() (在 socket 模块中)

IfExp (ast 中的类)

ifloordiv() (在 operator 模块中)

iglob() (在 glob 模块中)

ignorableWhitespace() (xml.sax.handler.ContentHandler 方法)

ignore

error handler's name

ignore (bdb.Breakpoint 属性)

(pdb command)

ignore_errors() (在 codecs 模块中)

IGNORE_EXCEPTION_DETAIL() (在 doctest 模块中)

ignore_patterns() (在 shutil 模块中)

ignore_warnings() (在 test.support.warnings_helper 模块中)

IGNORECASE() (在 re 模块中)

ihave() (nntplib.NNTP 方法)

IISCGIHandler (wsgiref.handlers 中的类)

ilshift() (在 operator 模块中)

imag (numbers.Complex 属性)

imaginary literal

imap() (multiprocessing.pool.Pool 方法)

IMAP4

protocol

IMAP4 (imaplib 中的类)

IMAP4.abort

IMAP4.error

IMAP4.readonly

IMAP4_SSL

protocol

IMAP4_SSL (imaplib 中的类)

IMAP4_stream

protocol

IMAP4_stream (imaplib 中的类)

imap_unordered() (multiprocessing.pool.Pool 方法)

imaplib

模块

imatmul() (在 operator 模块中)

imghdr

模块

immedok() (curses.window 方法)

immutable

data type

object, [1]

sequence types

对象

immutable -- 不可变对象

immutable object

immutable sequence

对象

immutable types

subclassing

imod() (在 operator 模块中)

imp

模块, [1]

ImpImporter (pkgutil 中的类)

impl_detail() (在 test.support 模块中)

implementation() (在 sys 模块中)

ImpLoader (pkgutil 中的类)

import

hooks

语句, [1], [2], [3], [4]

import (2to3 fixer)

Import (ast 中的类)

import hooks

import machinery

import path -- 导入路径

import_fresh_module() (在 test.support.import_helper 模块中)

IMPORT_FROM (opcode)

import_module() (在 importlib 模块中)

(在 test.support.import_helper 模块中)

IMPORT_NAME (opcode)

IMPORT_STAR (opcode)

importer -- 导入器

ImportError

例外

ImportFrom (ast 中的类)

importing -- 导入

importlib

模块

importlib.abc

模块

importlib.machinery

模块

importlib.metadata

模块

importlib.resources

模块

importlib.util

模块

imports (2to3 fixer)

imports2 (2to3 fixer)

ImportWarning

ImproperConnectionState

imul() (在 operator 模块中)

in

关键字

运算符, [1], [2]

In (ast 中的类)

in_dll() (ctypes._CData 方法)

in_table_a1() (在 stringprep 模块中)

in_table_b1() (在 stringprep 模块中)

in_table_c11() (在 stringprep 模块中)

in_table_c11_c12() (在 stringprep 模块中)

in_table_c12() (在 stringprep 模块中)

in_table_c21() (在 stringprep 模块中)

in_table_c21_c22() (在 stringprep 模块中)

in_table_c22() (在 stringprep 模块中)

in_table_c3() (在 stringprep 模块中)

in_table_c4() (在 stringprep 模块中)

in_table_c5() (在 stringprep 模块中)

in_table_c6() (在 stringprep 模块中)

in_table_c7() (在 stringprep 模块中)

in_table_c8() (在 stringprep 模块中)

in_table_c9() (在 stringprep 模块中)

in_table_d1() (在 stringprep 模块中)

in_table_d2() (在 stringprep 模块中)

in_transaction (sqlite3.Connection 属性)

inch() (curses.window 方法)

inclusive

or

inclusive (tracemalloc.DomainFilter 属性)

(tracemalloc.Filter 属性)

Incomplete

IncompleteRead

IncompleteReadError

incr_item(), [1]

increment_lineno() (在 ast 模块中)

IncrementalDecoder (codecs 中的类)

incrementaldecoder (codecs.CodecInfo 属性)

IncrementalEncoder (codecs 中的类)

incrementalencoder (codecs.CodecInfo 属性)

IncrementalNewlineDecoder (io 中的类)

IncrementalParser (xml.sax.xmlreader 中的类)

indent (doctest.Example 属性)

INDENT token

indent() (在 textwrap 模块中)

INDENT() (在 token 模块中)

indent() (在 xml.etree.ElementTree 模块中)

indentation

IndentationError

index operation

index() (array.array 方法)

(bytearray 方法)

(bytes 方法)

(collections.deque 方法)

(multiprocessing.shared_memory.ShareableList 方法)

(sequence method)

(str 方法)

(tkinter.ttk.Notebook 方法)

(tkinter.ttk.Treeview 方法)

(在 operator 模块中)

IndexError

indexOf() (在 operator 模块中)

IndexSizeErr

indices() (slice 方法)

inet_aton() (在 socket 模块中)

inet_ntoa() (在 socket 模块中)

inet_ntop() (在 socket 模块中)

inet_pton() (在 socket 模块中)

Inexact (decimal 中的类)

inf() (在 cmath 模块中)

(在 math 模块中)

infile

json.tool command line option

infile (shlex.shlex 属性)

Infinity

infj() (在 cmath 模块中)

info() (dis.Bytecode 方法)

(gettext.NullTranslations 方法)

(http.client.HTTPResponse 方法)

(logging.Logger 方法)

(urllib.response.addinfourl 方法)

(在 logging 模块中)

infolist() (zipfile.ZipFile 方法)

inheritance

ini file

init() (在 mimetypes 模块中)

init_color() (在 curses 模块中)

init_database() (在 msilib 模块中)

init_pair() (在 curses 模块中)

inited() (在 mimetypes 模块中)

initgroups() (在 os 模块中)

initial_indent (textwrap.TextWrapper 属性)

initialize_options() (distutils.cmd.Command 方法)

initproc (C type)

initscr() (在 curses 模块中)

inode() (os.DirEntry 方法)

INPLACE_ADD (opcode)

INPLACE_AND (opcode)

INPLACE_FLOOR_DIVIDE (opcode)

INPLACE_LSHIFT (opcode)

INPLACE_MATRIX_MULTIPLY (opcode)

INPLACE_MODULO (opcode)

INPLACE_MULTIPLY (opcode)

INPLACE_OR (opcode)

INPLACE_POWER (opcode)

INPLACE_RSHIFT (opcode)

INPLACE_SUBTRACT (opcode)

INPLACE_TRUE_DIVIDE (opcode)

INPLACE_XOR (opcode)

input

(2to3 fixer)

input()

內置函数

input() (在 fileinput 模块中)

input_charset (email.charset.Charset 属性)

input_codec (email.charset.Charset 属性)

InputOnly (tkinter.tix 中的类)

InputSource (xml.sax.xmlreader 中的类)

inquiry (C type)

insch() (curses.window 方法)

insdelln() (curses.window 方法)

insert() (array.array 方法)

(collections.deque 方法)

(sequence method)

(tkinter.ttk.Notebook 方法)

(tkinter.ttk.Treeview 方法)

(xml.etree.ElementTree.Element 方法)

insert_text() (在 readline 模块中)

insertBefore() (xml.dom.Node 方法)

insertln() (curses.window 方法)

insnstr() (curses.window 方法)

insort() (在 bisect 模块中)

insort_left() (在 bisect 模块中)

insort_right() (在 bisect 模块中)

inspect

模块

inspect command line option

--details

InspectLoader (importlib.abc 中的类)

insstr() (curses.window 方法)

install() (gettext.NullTranslations 方法)

(在 gettext 模块中)

install_opener() (在 urllib.request 模块中)

install_scripts() (venv.EnvBuilder 方法)

installHandler() (在 unittest 模块中)

instance

call, [1]

class

对象, [1], [2]

instancemethod

对象

instate() (tkinter.ttk.Widget 方法)

instr() (curses.window 方法)

instream (shlex.shlex 属性)

Instruction (dis 中的类)

Instruction.arg() (在 dis 模块中)

Instruction.argrepr() (在 dis 模块中)

Instruction.argval() (在 dis 模块中)

Instruction.is_jump_target() (在 dis 模块中)

Instruction.offset() (在 dis 模块中)

Instruction.opcode() (在 dis 模块中)

Instruction.opname() (在 dis 模块中)

Instruction.starts_line() (在 dis 模块中)

int

內置函数, [1], [2]

int (uuid.UUID 属性)

(內置类)

Int2AP() (在 imaplib 模块中)

int_info() (在 sys 模块中)

integer

literals

representation

types, operations on

对象, [1], [2]

integer literal

Integral (numbers 中的类)

Integrated Development Environment

IntegrityError

Intel/DVI ADPCM

IntEnum (enum 中的类)

interact (pdb command)

interact() (code.InteractiveConsole 方法)

(telnetlib.Telnet 方法)

(在 code 模块中)

interactive -- 交互

interactive mode

InteractiveConsole (code 中的类)

InteractiveInterpreter (code 中的类)

InterfaceError

intern (2to3 fixer)

intern() (在 sys 模块中)

internal type

internal_attr (zipfile.ZipInfo 属性)

Internaldate2tuple() (在 imaplib 模块中)

InternalError

internalSubset (xml.dom.DocumentType 属性)

Internet

INTERNET_TIMEOUT() (在 test.support 模块中)

interpolated string literal

interpolation

bytearray (%)

bytes (%)

interpolation, string (%)

InterpolationDepthError

InterpolationError

InterpolationMissingOptionError

InterpolationSyntaxError

interpreted -- 解释型

interpreter

interpreter lock

interpreter prompts

interpreter shutdown -- 解释器关闭

interpreter_requires_environment() (在 test.support.script_helper 模块中)

interrupt() (sqlite3.Connection 方法)

interrupt_main() (在 _thread 模块中)

InterruptedError

intersection() (frozenset 方法)

intersection_update() (frozenset 方法)

IntFlag (enum 中的类)

intro (cmd.Cmd 属性)

InuseAttributeErr

inv() (在 operator 模块中)

inv_cdf() (statistics.NormalDist 方法)

InvalidAccessErr

invalidate_caches() (importlib.abc.MetaPathFinder 方法)

(importlib.abc.PathEntryFinder 方法)

(importlib.machinery.FileFinder 方法)

(importlib.machinery.PathFinder 类方法)

(zipimport.zipimporter 方法)

(在 importlib 模块中)

InvalidCharacterErr

InvalidModificationErr

InvalidOperation (decimal 中的类)

InvalidStateErr

InvalidStateError, [1]

InvalidTZPathWarning

InvalidURL

inversion

Invert (ast 中的类)

invert() (在 operator 模块中)

invocation

io

模块, [1]

IO (typing 中的类)

io.StringIO

对象

IO_REPARSE_TAG_APPEXECLINK() (在 stat 模块中)

IO_REPARSE_TAG_MOUNT_POINT() (在 stat 模块中)

IO_REPARSE_TAG_SYMLINK() (在 stat 模块中)

IOBase (io 中的类)

ioctl() (socket.socket 方法)

(在 fcntl 模块中)

IOCTL_VM_SOCKETS_GET_LOCAL_CID() (在 socket 模块中)

IOError

ior() (在 operator 模块中)

ip (ipaddress.IPv4Interface 属性)

(ipaddress.IPv6Interface 属性)

ip_address() (在 ipaddress 模块中)

ip_interface() (在 ipaddress 模块中)

ip_network() (在 ipaddress 模块中)

ipaddress

模块

ipow() (在 operator 模块中)

ipv4_mapped (ipaddress.IPv6Address 属性)

IPv4Address (ipaddress 中的类)

IPv4Interface (ipaddress 中的类)

IPv4Network (ipaddress 中的类)

IPV6_ENABLED() (在 test.support.socket_helper 模块中)

IPv6Address (ipaddress 中的类)

IPv6Interface (ipaddress 中的类)

IPv6Network (ipaddress 中的类)

irrefutable case block

irshift() (在 operator 模块中)

is

运算符, [1]

Is (ast 中的类)

is not

运算符, [1]

is_() (在 operator 模块中)

is_absolute() (pathlib.PurePath 方法)

is_active() (asyncio.AbstractChildWatcher 方法)

(graphlib.TopologicalSorter 方法)

is_alive() (multiprocessing.Process 方法)

(threading.Thread 方法)

is_android() (在 test.support 模块中)

is_annotated() (symtable.Symbol 方法)

is_assigned() (symtable.Symbol 方法)

is_async (pyclbr.Function 属性)

is_attachment() (email.message.EmailMessage 方法)

is_authenticated() (urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

is_block_device() (pathlib.Path 方法)

is_blocked() (http.cookiejar.DefaultCookiePolicy 方法)

is_canonical() (decimal.Context 方法)

(decimal.Decimal 方法)

is_char_device() (pathlib.Path 方法)

IS_CHARACTER_JUNK() (在 difflib 模块中)

is_check_supported() (在 lzma 模块中)

is_closed() (asyncio.loop 方法)

is_closing() (asyncio.BaseTransport 方法)

(asyncio.StreamWriter 方法)

is_dataclass() (在 dataclasses 模块中)

is_declared_global() (symtable.Symbol 方法)

is_dir() (importlib.abc.Traversable 方法)

(os.DirEntry 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

(zipfile.ZipInfo 方法)

is_enabled() (在 faulthandler 模块中)

is_expired() (http.cookiejar.Cookie 方法)

is_fifo() (pathlib.Path 方法)

is_file() (importlib.abc.Traversable 方法)

(os.DirEntry 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

is_finalized() (在 gc 模块中)

is_finalizing() (在 sys 模块中)

is_finite() (decimal.Context 方法)

(decimal.Decimal 方法)

is_free() (symtable.Symbol 方法)

is_global (ipaddress.IPv4Address 属性)

(ipaddress.IPv6Address 属性)

is_global() (symtable.Symbol 方法)

is_hop_by_hop() (在 wsgiref.util 模块中)

is_imported() (symtable.Symbol 方法)

is_infinite() (decimal.Context 方法)

(decimal.Decimal 方法)

is_integer() (float 方法)

is_jython() (在 test.support 模块中)

IS_LINE_JUNK() (在 difflib 模块中)

is_linetouched() (curses.window 方法)

is_link_local (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_local() (symtable.Symbol 方法)

is_loopback (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_mount() (pathlib.Path 方法)

is_multicast (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_multipart() (email.message.EmailMessage 方法)

(email.message.Message 方法)

is_namespace() (symtable.Symbol 方法)

is_nan() (decimal.Context 方法)

(decimal.Decimal 方法)

is_nested() (symtable.SymbolTable 方法)

is_nonlocal() (symtable.Symbol 方法)

is_normal() (decimal.Context 方法)

(decimal.Decimal 方法)

is_normalized() (在 unicodedata 模块中)

is_not() (在 operator 模块中)

is_not_allowed() (http.cookiejar.DefaultCookiePolicy 方法)

IS_OP (opcode)

is_optimized() (symtable.SymbolTable 方法)

is_package() (importlib.abc.InspectLoader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

is_parameter() (symtable.Symbol 方法)

is_private (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_python_build() (在 sysconfig 模块中)

is_qnan() (decimal.Context 方法)

(decimal.Decimal 方法)

is_reading() (asyncio.ReadTransport 方法)

is_referenced() (symtable.Symbol 方法)

is_relative_to() (pathlib.PurePath 方法)

is_reserved (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_reserved() (pathlib.PurePath 方法)

is_resource() (importlib.abc.ResourceReader 方法)

(在 importlib.resources 模块中)

is_resource_enabled() (在 test.support 模块中)

is_running() (asyncio.loop 方法)

is_safe (uuid.UUID 属性)

is_serving() (asyncio.Server 方法)

is_set() (asyncio.Event 方法)

(threading.Event 方法)

is_signed() (decimal.Context 方法)

(decimal.Decimal 方法)

is_site_local (ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_skipped_line() (bdb.Bdb 方法)

is_snan() (decimal.Context 方法)

(decimal.Decimal 方法)

is_socket() (pathlib.Path 方法)

is_subnormal() (decimal.Context 方法)

(decimal.Decimal 方法)

is_symlink() (os.DirEntry 方法)

(pathlib.Path 方法)

is_tarfile() (在 tarfile 模块中)

is_term_resized() (在 curses 模块中)

is_tracing() (在 tracemalloc 模块中)

is_tracked() (在 gc 模块中)

is_typeddict() (在 typing 模块中)

is_unspecified (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_wintouched() (curses.window 方法)

is_zero() (decimal.Context 方法)

(decimal.Decimal 方法)

is_zipfile() (在 zipfile 模块中)

isabs() (在 os.path 模块中)

isabstract() (在 inspect 模块中)

IsADirectoryError

isalnum() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isalpha() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isascii() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isasyncgen() (在 inspect 模块中)

isasyncgenfunction() (在 inspect 模块中)

isatty() (chunk.Chunk 方法)

(io.IOBase 方法)

(在 os 模块中)

isawaitable() (在 inspect 模块中)

isblank() (在 curses.ascii 模块中)

isblk() (tarfile.TarInfo 方法)

isbuiltin() (在 inspect 模块中)

ischr() (tarfile.TarInfo 方法)

isclass() (在 inspect 模块中)

isclose() (在 cmath 模块中)

(在 math 模块中)

iscntrl() (在 curses.ascii 模块中)

iscode() (在 inspect 模块中)

iscoroutine() (在 asyncio 模块中)

(在 inspect 模块中)

iscoroutinefunction() (在 asyncio 模块中)

(在 inspect 模块中)

isctrl() (在 curses.ascii 模块中)

isDaemon() (threading.Thread 方法)

isdatadescriptor() (在 inspect 模块中)

isdecimal() (str 方法)

isdev() (tarfile.TarInfo 方法)

isdigit() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isdir() (tarfile.TarInfo 方法)

(在 os.path 模块中)

isdisjoint() (frozenset 方法)

isdown() (在 turtle 模块中)

iselement() (在 xml.etree.ElementTree 模块中)

isenabled() (在 gc 模块中)

isEnabledFor() (logging.Logger 方法)

isendwin() (在 curses 模块中)

ISEOF() (在 token 模块中)

isfifo() (tarfile.TarInfo 方法)

isfile() (tarfile.TarInfo 方法)

(在 os.path 模块中)

isfinite() (在 cmath 模块中)

(在 math 模块中)

isfirstline() (在 fileinput 模块中)

isframe() (在 inspect 模块中)

isfunction() (在 inspect 模块中)

isfuture() (在 asyncio 模块中)

isgenerator() (在 inspect 模块中)

isgeneratorfunction() (在 inspect 模块中)

isgetsetdescriptor() (在 inspect 模块中)

isgraph() (在 curses.ascii 模块中)

isidentifier() (str 方法)

isinf() (在 cmath 模块中)

(在 math 模块中)

isinstance (2to3 fixer)

isinstance()

內置函数

iskeyword() (在 keyword 模块中)

isleap() (在 calendar 模块中)

islice() (在 itertools 模块中)

islink() (在 os.path 模块中)

islnk() (tarfile.TarInfo 方法)

islower() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

ismemberdescriptor() (在 inspect 模块中)

ismeta() (在 curses.ascii 模块中)

ismethod() (在 inspect 模块中)

ismethoddescriptor() (在 inspect 模块中)

ismodule() (在 inspect 模块中)

ismount() (在 os.path 模块中)

isnan() (在 cmath 模块中)

(在 math 模块中)

ISNONTERMINAL() (在 token 模块中)

IsNot (ast 中的类)

isnumeric() (str 方法)

isocalendar() (datetime.date 方法)

(datetime.datetime 方法)

isoformat() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

IsolatedAsyncioTestCase (unittest 中的类)

isolation_level (sqlite3.Connection 属性)

isoweekday() (datetime.date 方法)

(datetime.datetime 方法)

isprint() (在 curses.ascii 模块中)

isprintable() (str 方法)

ispunct() (在 curses.ascii 模块中)

isqrt() (在 math 模块中)

isreadable() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

isrecursive() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

isreg() (tarfile.TarInfo 方法)

isReservedKey() (http.cookies.Morsel 方法)

isroutine() (在 inspect 模块中)

isSameNode() (xml.dom.Node 方法)

issoftkeyword() (在 keyword 模块中)

isspace() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isstdin() (在 fileinput 模块中)

issubclass()

內置函数

issubset() (frozenset 方法)

issuperset() (frozenset 方法)

issym() (tarfile.TarInfo 方法)

ISTERMINAL() (在 token 模块中)

istitle() (bytearray 方法)

(bytes 方法)

(str 方法)

istraceback() (在 inspect 模块中)

isub() (在 operator 模块中)

isupper() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isvisible() (在 turtle 模块中)

isxdigit() (在 curses.ascii 模块中)

ITALIC() (在 tkinter.font 模块中)

item

sequence

string

item selection

item() (tkinter.ttk.Treeview 方法)

(xml.dom.NamedNodeMap 方法)

(xml.dom.NodeList 方法)

itemgetter() (在 operator 模块中)

items() (configparser.ConfigParser 方法)

(contextvars.Context 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(types.MappingProxyType 方法)

(xml.etree.ElementTree.Element 方法)

itemsize (array.array 属性)

(memoryview 属性)

ItemsView (collections.abc 中的类)

(typing 中的类)

iter()

內置函数

iter() (xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

iter_attachments() (email.message.EmailMessage 方法)

iter_child_nodes() (在 ast 模块中)

iter_fields() (在 ast 模块中)

iter_importers() (在 pkgutil 模块中)

iter_modules() (在 pkgutil 模块中)

iter_parts() (email.message.EmailMessage 方法)

iter_unpack() (struct.Struct 方法)

(在 struct 模块中)

iterable

unpacking

Iterable (collections.abc 中的类)

(typing 中的类)

iterable -- 可迭代对象

Iterator (collections.abc 中的类)

(typing 中的类)

iterator -- 迭代器

iterator protocol

iterdecode() (在 codecs 模块中)

iterdir() (importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

iterdump() (sqlite3.Connection 方法)

iterencode() (json.JSONEncoder 方法)

(在 codecs 模块中)

iterfind() (xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

iteritems() (mailbox.Mailbox 方法)

iterkeys() (mailbox.Mailbox 方法)

itermonthdates() (calendar.Calendar 方法)

itermonthdays() (calendar.Calendar 方法)

itermonthdays2() (calendar.Calendar 方法)

itermonthdays3() (calendar.Calendar 方法)

itermonthdays4() (calendar.Calendar 方法)

iternextfunc (C type)

iterparse() (在 xml.etree.ElementTree 模块中)

itertext() (xml.etree.ElementTree.Element 方法)

itertools

模块

itertools (2to3 fixer)

itertools_imports (2to3 fixer)

itervalues() (mailbox.Mailbox 方法)

iterweekdays() (calendar.Calendar 方法)

ITIMER_PROF() (在 signal 模块中)

ITIMER_REAL() (在 signal 模块中)

ITIMER_VIRTUAL() (在 signal 模块中)

ItimerError

itruediv() (在 operator 模块中)

ixor() (在 operator 模块中)

索引 – J

j

in numeric literal

Jansen, Jack

Java

language

java_ver() (在 platform 模块中)

join() (asyncio.Queue 方法)

(bytearray 方法)

(bytes 方法)

(multiprocessing.JoinableQueue 方法)

(multiprocessing.pool.Pool 方法)

(multiprocessing.Process 方法)

(queue.Queue 方法)

(str 方法)

(threading.Thread 方法)

(在 os.path 模块中)

(在 shlex 模块中)

join_thread() (multiprocessing.Queue 方法)

(在 test.support.threading_helper 模块中)

JoinableQueue (multiprocessing 中的类)

JoinedStr (ast 中的类)

joinpath() (importlib.abc.Traversable 方法)

(pathlib.PurePath 方法)

(zipfile.Path 方法)

js_output() (http.cookies.BaseCookie 方法)

(http.cookies.Morsel 方法)

json

模块, [1]

json.tool

模块

json.tool command line option

--compact

--help

--indent

--json-lines

--no-ensure-ascii

--no-indent

--sort-keys

--tab

-h

infile

outfile

JSONDecodeError

JSONDecoder (json 中的类)

JSONEncoder (json 中的类)

jump (pdb command)

JUMP_ABSOLUTE (opcode)

JUMP_FORWARD (opcode)

JUMP_IF_FALSE_OR_POP (opcode)

JUMP_IF_NOT_EXC_MATCH (opcode)

JUMP_IF_TRUE_OR_POP (opcode)

索引 – K

kbhit() (在 msvcrt 模块中)

KDEDIR

kevent() (在 select 模块中)

key

(http.cookies.Morsel 属性)

(zoneinfo.ZoneInfo 属性)

key function -- 键函数

key/datum pair

KEY_ALL_ACCESS() (在 winreg 模块中)

KEY_CREATE_LINK() (在 winreg 模块中)

KEY_CREATE_SUB_KEY() (在 winreg 模块中)

KEY_ENUMERATE_SUB_KEYS() (在 winreg 模块中)

KEY_EXECUTE() (在 winreg 模块中)

KEY_NOTIFY() (在 winreg 模块中)

KEY_QUERY_VALUE() (在 winreg 模块中)

KEY_READ() (在 winreg 模块中)

KEY_SET_VALUE() (在 winreg 模块中)

KEY_WOW64_32KEY() (在 winreg 模块中)

KEY_WOW64_64KEY() (在 winreg 模块中)

KEY_WRITE() (在 winreg 模块中)

KeyboardInterrupt

(built-in exception), [1], [2]

KeyError

keylog_filename (ssl.SSLContext 属性)

keyname() (在 curses 模块中)

keypad() (curses.window 方法)

keyrefs() (weakref.WeakKeyDictionary 方法)

keys() (contextvars.Context 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(sqlite3.Row 方法)

(types.MappingProxyType 方法)

(xml.etree.ElementTree.Element 方法)

KeysView (collections.abc 中的类)

(typing 中的类)

keyword, [1]

模块

keyword (ast 中的类)

keyword argument -- 关键字参数

keywords (functools.partial 属性)

kill() (asyncio.subprocess.Process 方法)

(asyncio.SubprocessTransport 方法)

(multiprocessing.Process 方法)

(subprocess.Popen 方法)

(在 os 模块中)

kill_python() (在 test.support.script_helper 模块中)

killchar() (在 curses 模块中)

killpg() (在 os 模块中)

kind (inspect.Parameter 属性)

knownfiles() (在 mimetypes 模块中)

kqueue() (在 select 模块中)

KqueueSelector (selectors 中的类)

KW_ONLY() (在 dataclasses 模块中)

kwargs (inspect.BoundArguments 属性)

(typing.ParamSpec 属性)

kwlist() (在 keyword 模块中)

索引 – L

L() (在 re 模块中)

LabelEntry (tkinter.tix 中的类)

LabelFrame (tkinter.tix 中的类)

lambda

expression, [1]

form

Lambda (ast 中的类)

LambdaType() (在 types 模块中)

LANG, [1], [2], [3], [4]

LANGUAGE, [1]

language

C, [1], [2], [3], [4]

Java

large files

LARGEST() (在 test.support 模块中)

LargeZipFile

last() (nntplib.NNTP 方法)

last_accepted (multiprocessing.connection.Listener 属性)

last_traceback (in module sys)

last_traceback() (在 sys 模块中)

last_type() (在 sys 模块中)

last_value() (在 sys 模块中)

lastChild (xml.dom.Node 属性)

lastcmd (cmd.Cmd 属性)

lastgroup (re.Match 属性)

lastindex (re.Match 属性)

lastResort() (在 logging 模块中)

lastrowid (sqlite3.Cursor 属性)

layout() (tkinter.ttk.Style 方法)

lazycache() (在 linecache 模块中)

LazyLoader (importlib.util 中的类)

LBRACE() (在 token 模块中)

LBYL

LC_ALL, [1]

LC_ALL() (在 locale 模块中)

LC_COLLATE() (在 locale 模块中)

LC_CTYPE() (在 locale 模块中)

LC_MESSAGES, [1]

LC_MESSAGES() (在 locale 模块中)

LC_MONETARY() (在 locale 模块中)

LC_NUMERIC() (在 locale 模块中)

LC_TIME() (在 locale 模块中)

lchflags() (在 os 模块中)

lchmod() (pathlib.Path 方法)

(在 os 模块中)

lchown() (在 os 模块中)

lcm() (在 math 模块中)

LDCXXSHARED

ldexp() (在 math 模块中)

LDFLAGS, [1], [2], [3], [4], [5], [6], [7]

LDFLAGS_NODIST, [1]

ldgettext() (在 gettext 模块中)

ldngettext() (在 gettext 模块中)

le() (在 operator 模块中)

leading whitespace

leapdays() (在 calendar 模块中)

leaveok() (curses.window 方法)

left (filecmp.dircmp 属性)

left() (在 turtle 模块中)

left_list (filecmp.dircmp 属性)

left_only (filecmp.dircmp 属性)

LEFTSHIFT() (在 token 模块中)

LEFTSHIFTEQUAL() (在 token 模块中)

len

內置函数, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

len()

內置函数

lenfunc (C type)

length (xml.dom.NamedNodeMap 属性)

(xml.dom.NodeList 属性)

length_hint() (在 operator 模块中)

LESS() (在 token 模块中)

LESSEQUAL() (在 token 模块中)

lexical analysis

lexical definitions

LexicalHandler (xml.sax.handler 中的类)

lexists() (在 os.path 模块中)

lgamma() (在 math 模块中)

lgettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

lib2to3

模块

libc_ver() (在 platform 模块中)

library (ssl.SSLError 属性)

library() (在 dbm.ndbm 模块中)

library_dir_option() (distutils.ccompiler.CCompiler 方法)

library_filename() (distutils.ccompiler.CCompiler 方法)

library_option() (distutils.ccompiler.CCompiler 方法)

LibraryLoader (ctypes 中的类)

license (內置变量)

LifoQueue (asyncio 中的类)

(queue 中的类)

light-weight processes

limit_denominator() (fractions.Fraction 方法)

LimitOverrunError

lin2adpcm() (在 audioop 模块中)

lin2alaw() (在 audioop 模块中)

lin2lin() (在 audioop 模块中)

lin2ulaw() (在 audioop 模块中)

line (bdb.Breakpoint 属性)

line continuation

line joining, [1]

line structure

line() (msilib.Dialog 方法)

line-buffered I/O

line_buffering (io.TextIOWrapper 属性)

line_num (csv.csvreader 属性)

linear_regression() (在 statistics 模块中)

linecache

模块

lineno (ast.AST 属性)

(doctest.DocTest 属性)

(doctest.Example 属性)

(json.JSONDecodeError 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

(re.error 属性)

(shlex.shlex 属性)

(SyntaxError 属性)

(traceback.TracebackException 属性)

(tracemalloc.Filter 属性)

(tracemalloc.Frame 属性)

(xml.parsers.expat.ExpatError 属性)

lineno() (在 fileinput 模块中)

LINES, [1], [2], [3], [4]

lines (os.terminal_size 属性)

linesep (email.policy.Policy 属性)

linesep() (在 os 模块中)

lineterminator (csv.Dialect 属性)

LineTooLong

link() (distutils.ccompiler.CCompiler 方法)

(在 os 模块中)

link_executable() (distutils.ccompiler.CCompiler 方法)

link_shared_lib() (distutils.ccompiler.CCompiler 方法)

link_shared_object() (distutils.ccompiler.CCompiler 方法)

link_to() (pathlib.Path 方法)

LinkFallbackError

linkname (tarfile.TarInfo 属性)

LinkOutsideDestinationError

list

assignment, target

comprehensions

deletion target

display

empty

expression, [1], [2]

target, [1]

type, operations on

对象, [1], [2], [3], [4], [5], [6], [7], [8]

List (ast 中的类)

list (pdb command)

List (typing 中的类)

list (內置类)

list comprehension -- 列表推导式

list() (imaplib.IMAP4 方法)

(multiprocessing.managers.SyncManager 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

(tarfile.TarFile 方法)

LIST_APPEND (opcode)

list_dialects() (在 csv 模块中)

LIST_EXTEND (opcode)

list_folders() (mailbox.Maildir 方法)

(mailbox.MH 方法)

LIST_TO_TUPLE (opcode)

ListComp (ast 中的类)

listdir() (在 os 模块中)

listen() (asyncore.dispatcher 方法)

(socket.socket 方法)

(在 logging.config 模块中)

(在 turtle 模块中)

listener (logging.handlers.QueueHandler 属性)

Listener (multiprocessing.connection 中的类)

listMethods() (xmlrpc.client.ServerProxy.system 方法)

ListNoteBook (tkinter.tix 中的类)

listxattr() (在 os 模块中)

literal, [1]

Literal() (在 typing 模块中)

literal_eval() (在 ast 模块中)

literals

binary

complex number

floating point

hexadecimal

integer

numeric

octal

LittleEndianStructure (ctypes 中的类)

ljust() (bytearray 方法)

(bytes 方法)

(str 方法)

LK_LOCK() (在 msvcrt 模块中)

LK_NBLCK() (在 msvcrt 模块中)

LK_NBRLCK() (在 msvcrt 模块中)

LK_RLCK() (在 msvcrt 模块中)

LK_UNLCK() (在 msvcrt 模块中)

ll (pdb command)

LMTP (smtplib 中的类)

ln() (decimal.Context 方法)

(decimal.Decimal 方法)

LNAME

lngettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

Load (ast 中的类)

load() (http.cookiejar.FileCookieJar 方法)

(http.cookies.BaseCookie 方法)

(pickle.Unpickler 方法)

(tracemalloc.Snapshot 类方法)

(在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

LOAD_ASSERTION_ERROR (opcode)

LOAD_ATTR (opcode)

LOAD_BUILD_CLASS (opcode)

load_cert_chain() (ssl.SSLContext 方法)

LOAD_CLASSDEREF (opcode)

LOAD_CLOSURE (opcode)

LOAD_CONST (opcode)

load_default_certs() (ssl.SSLContext 方法)

LOAD_DEREF (opcode)

load_dh_params() (ssl.SSLContext 方法)

load_extension() (sqlite3.Connection 方法)

LOAD_FAST (opcode)

LOAD_GLOBAL (opcode)

LOAD_METHOD (opcode)

load_module() (importlib.abc.FileLoader 方法)

(importlib.abc.InspectLoader 方法)

(importlib.abc.Loader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

(在 imp 模块中)

LOAD_NAME (opcode)

load_package_tests() (在 test.support 模块中)

load_verify_locations() (ssl.SSLContext 方法)

loader

Loader (importlib.abc 中的类)

loader (importlib.machinery.ModuleSpec 属性)

loader -- 加载器

loader_state (importlib.machinery.ModuleSpec 属性)

LoadError

LoadFileDialog (tkinter.filedialog 中的类)

LoadKey() (在 winreg 模块中)

LoadLibrary() (ctypes.LibraryLoader 方法)

loads() (在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

(在 xmlrpc.client 模块中)

loadTestsFromModule() (unittest.TestLoader 方法)

loadTestsFromName() (unittest.TestLoader 方法)

loadTestsFromNames() (unittest.TestLoader 方法)

loadTestsFromTestCase() (unittest.TestLoader 方法)

local (threading 中的类)

localcontext() (在 decimal 模块中)

locale

模块

locale encoding -- 语言区域编码格式

LOCALE() (在 re 模块中)

localeconv() (在 locale 模块中)

LocaleHTMLCalendar (calendar 中的类)

LocaleTextCalendar (calendar 中的类)

localize() (在 locale 模块中)

localName (xml.dom.Attr 属性)

(xml.dom.Node 属性)

locals()

內置函数

localtime() (在 email.utils 模块中)

(在 time 模块中)

Locator (xml.sax.xmlreader 中的类)

Lock (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

lock() (mailbox.Babyl 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.mbox 方法)

(mailbox.MH 方法)

(mailbox.MMDF 方法)

Lock() (multiprocessing.managers.SyncManager 方法)

lock, interpreter

lock_held() (在 imp 模块中)

locked() (_thread.lock 方法)

(asyncio.Condition 方法)

(asyncio.Lock 方法)

(asyncio.Semaphore 方法)

(threading.Lock 方法)

lockf() (在 fcntl 模块中)

(在 os 模块中)

locking() (在 msvcrt 模块中)

LockType() (在 _thread 模块中)

log() (logging.Logger 方法)

(在 cmath 模块中)

(在 logging 模块中)

(在 math 模块中)

log10() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 cmath 模块中)

(在 math 模块中)

log1p() (在 math 模块中)

log2() (在 math 模块中)

log_date_time_string() (http.server.BaseHTTPRequestHandler 方法)

log_error() (http.server.BaseHTTPRequestHandler 方法)

log_exception() (wsgiref.handlers.BaseHandler 方法)

log_message() (http.server.BaseHTTPRequestHandler 方法)

log_request() (http.server.BaseHTTPRequestHandler 方法)

log_to_stderr() (在 multiprocessing 模块中)

logb() (decimal.Context 方法)

(decimal.Decimal 方法)

Logger (logging 中的类)

LoggerAdapter (logging 中的类)

logging

Errors

模块

logging.config

模块

logging.handlers

模块

logical line

logical_and() (decimal.Context 方法)

(decimal.Decimal 方法)

logical_invert() (decimal.Context 方法)

(decimal.Decimal 方法)

logical_or() (decimal.Context 方法)

(decimal.Decimal 方法)

logical_xor() (decimal.Context 方法)

(decimal.Decimal 方法)

login() (ftplib.FTP 方法)

(imaplib.IMAP4 方法)

(nntplib.NNTP 方法)

(smtplib.SMTP 方法)

login_cram_md5() (imaplib.IMAP4 方法)

LOGNAME, [1]

lognormvariate() (在 random 模块中)

logout() (imaplib.IMAP4 方法)

LogRecord (logging 中的类)

long (2to3 fixer)

long integer

对象

LONG_MAX

LONG_TIMEOUT() (在 test.support 模块中)

longMessage (unittest.TestCase 属性)

longname() (在 curses 模块中)

lookup() (symtable.SymbolTable 方法)

(tkinter.ttk.Style 方法)

(在 codecs 模块中)

(在 unicodedata 模块中)

lookup_error() (在 codecs 模块中)

LookupError

loop

over mutable sequence

statement, [1], [2], [3]

loop control

target

loop() (在 asyncore 模块中)

LOOPBACK_TIMEOUT() (在 test.support 模块中)

lower() (bytearray 方法)

(bytes 方法)

(str 方法)

LPAR() (在 token 模块中)

lpAttributeList (subprocess.STARTUPINFO 属性)

lru_cache() (在 functools 模块中)

lseek() (在 os 模块中)

LShift (ast 中的类)

lshift() (在 operator 模块中)

LSQB() (在 token 模块中)

lstat() (pathlib.Path 方法)

(在 os 模块中)

lstrip() (bytearray 方法)

(bytes 方法)

(str 方法)

lsub() (imaplib.IMAP4 方法)

Lt (ast 中的类)

lt() (在 operator 模块中)

(在 turtle 模块中)

LtE (ast 中的类)

LWPCookieJar (http.cookiejar 中的类)

lzma

模块

LZMACompressor (lzma 中的类)

LZMADecompressor (lzma 中的类)

LZMAError

LZMAFile (lzma 中的类)

索引 – M

M() (在 re 模块中)

mac_ver() (在 platform 模块中)

machine() (在 platform 模块中)

macros (netrc.netrc 属性)

MADV_AUTOSYNC() (在 mmap 模块中)

MADV_CORE() (在 mmap 模块中)

MADV_DODUMP() (在 mmap 模块中)

MADV_DOFORK() (在 mmap 模块中)

MADV_DONTDUMP() (在 mmap 模块中)

MADV_DONTFORK() (在 mmap 模块中)

MADV_DONTNEED() (在 mmap 模块中)

MADV_FREE() (在 mmap 模块中)

MADV_FREE_REUSABLE() (在 mmap 模块中)

MADV_FREE_REUSE() (在 mmap 模块中)

MADV_HUGEPAGE() (在 mmap 模块中)

MADV_HWPOISON() (在 mmap 模块中)

MADV_MERGEABLE() (在 mmap 模块中)

MADV_NOCORE() (在 mmap 模块中)

MADV_NOHUGEPAGE() (在 mmap 模块中)

MADV_NORMAL() (在 mmap 模块中)

MADV_NOSYNC() (在 mmap 模块中)

MADV_PROTECT() (在 mmap 模块中)

MADV_RANDOM() (在 mmap 模块中)

MADV_REMOVE() (在 mmap 模块中)

MADV_SEQUENTIAL() (在 mmap 模块中)

MADV_SOFT_OFFLINE() (在 mmap 模块中)

MADV_UNMERGEABLE() (在 mmap 模块中)

MADV_WILLNEED() (在 mmap 模块中)

madvise() (mmap.mmap 方法)

magic

method

magic method -- 魔术方法

MAGIC_NUMBER() (在 importlib.util 模块中)

MagicMock (unittest.mock 中的类)

mailbox

模块

Mailbox (mailbox 中的类)

mailcap

模块

Maildir (mailbox 中的类)

MaildirMessage (mailbox 中的类)

mailfrom (smtpd.SMTPChannel 属性)

MailmanProxy (smtpd 中的类)

main(), [1], [2]

(在 site 模块中)

(在 unittest 模块中)

main_thread() (在 threading 模块中)

mainloop() (在 turtle 模块中)

maintype (email.headerregistry.ContentTypeHeader 属性)

major (email.headerregistry.MIMEVersionHeader 属性)

major() (在 os 模块中)

make_alternative() (email.message.EmailMessage 方法)

make_archive() (在 distutils.archive_util 模块中)

(在 shutil 模块中)

make_bad_fd() (在 test.support.os_helper 模块中)

make_cookies() (http.cookiejar.CookieJar 方法)

make_dataclass() (在 dataclasses 模块中)

make_file() (difflib.HtmlDiff 方法)

MAKE_FUNCTION (opcode)

make_header() (在 email.header 模块中)

make_legacy_pyc() (在 test.support.import_helper 模块中)

make_mixed() (email.message.EmailMessage 方法)

make_msgid() (在 email.utils 模块中)

make_parser() (在 xml.sax 模块中)

make_pkg() (在 test.support.script_helper 模块中)

make_related() (email.message.EmailMessage 方法)

make_script() (在 test.support.script_helper 模块中)

make_server() (在 wsgiref.simple_server 模块中)

make_table() (difflib.HtmlDiff 方法)

make_tarball() (在 distutils.archive_util 模块中)

make_zip_pkg() (在 test.support.script_helper 模块中)

make_zip_script() (在 test.support.script_helper 模块中)

make_zipfile() (在 distutils.archive_util 模块中)

makedev() (在 os 模块中)

makedirs() (在 os 模块中)

makeelement() (xml.etree.ElementTree.Element 方法)

makefile() (socket method)

(socket.socket 方法)

makeLogRecord() (在 logging 模块中)

makePickle() (logging.handlers.SocketHandler 方法)

makeRecord() (logging.Logger 方法)

makeSocket() (logging.handlers.DatagramHandler 方法)

(logging.handlers.SocketHandler 方法)

maketrans() (bytearray 静态方法)

(bytes 静态方法)

(str 静态方法)

malloc()

mangle_from_ (email.policy.Compat32 属性)

(email.policy.Policy 属性)

mangling

name, [1]

map (2to3 fixer)

map()

內置函数

map() (concurrent.futures.Executor 方法)

(multiprocessing.pool.Pool 方法)

(tkinter.ttk.Style 方法)

MAP_ADD (opcode)

MAP_ANON() (在 mmap 模块中)

MAP_ANONYMOUS() (在 mmap 模块中)

map_async() (multiprocessing.pool.Pool 方法)

MAP_DENYWRITE() (在 mmap 模块中)

MAP_EXECUTABLE() (在 mmap 模块中)

MAP_POPULATE() (在 mmap 模块中)

MAP_PRIVATE() (在 mmap 模块中)

MAP_SHARED() (在 mmap 模块中)

map_table_b2() (在 stringprep 模块中)

map_table_b3() (在 stringprep 模块中)

map_to_type() (email.headerregistry.HeaderRegistry 方法)

mapLogRecord() (logging.handlers.HTTPHandler 方法)

mapping

types, operations on

对象, [1], [2], [3], [4], [5]

Mapping (collections.abc 中的类)

(typing 中的类)

mapping -- 映射

mapping() (msilib.Control 方法)

MappingProxyType (types 中的类)

MappingView (collections.abc 中的类)

(typing 中的类)

mapPriority() (logging.handlers.SysLogHandler 方法)

maps (collections.ChainMap 属性)

maps() (在 nis 模块中)

marshal

模块

marshalling

objects

masking

operations

master (tkinter.Tk 属性)

match

case

语句

Match (ast 中的类)

(typing 中的类)

match() (pathlib.PurePath 方法)

(re.Pattern 方法)

(在 nis 模块中)

(在 re 模块中)

match_case (ast 中的类)

MATCH_CLASS (opcode)

match_hostname() (在 ssl 模块中)

MATCH_KEYS (opcode)

MATCH_MAPPING (opcode)

MATCH_SEQUENCE (opcode)

match_test() (在 test.support 模块中)

match_value() (test.support.Matcher 方法)

MatchAs (ast 中的类)

MatchClass (ast 中的类)

Matcher (test.support 中的类)

matches() (test.support.Matcher 方法)

MatchMapping (ast 中的类)

MatchOr (ast 中的类)

MatchSequence (ast 中的类)

MatchSingleton (ast 中的类)

MatchStar (ast 中的类)

MatchValue (ast 中的类)

math

模块, [1], [2]

matmul() (在 operator 模块中)

MatMult (ast 中的类)

matrix multiplication

max

內置函数

max (datetime.date 属性)

(datetime.datetime 属性)

(datetime.time 属性)

(datetime.timedelta 属性)

max()

內置函数

max() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 audioop 模块中)

max_count (email.headerregistry.BaseHeader 属性)

MAX_EMAX() (在 decimal 模块中)

MAX_INTERPOLATION_DEPTH() (在 configparser 模块中)

max_line_length (email.policy.Policy 属性)

max_lines (textwrap.TextWrapper 属性)

max_mag() (decimal.Context 方法)

(decimal.Decimal 方法)

max_memuse() (在 test.support 模块中)

MAX_PREC() (在 decimal 模块中)

max_prefixlen (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

MAX_Py_ssize_t() (在 test.support 模块中)

maxarray (reprlib.Repr 属性)

maxdeque (reprlib.Repr 属性)

maxdict (reprlib.Repr 属性)

maxDiff (unittest.TestCase 属性)

maxfrozenset (reprlib.Repr 属性)

MAXIMUM_SUPPORTED (ssl.TLSVersion 属性)

maximum_version (ssl.SSLContext 属性)

maxlen (collections.deque 属性)

maxlevel (reprlib.Repr 属性)

maxlist (reprlib.Repr 属性)

maxlong (reprlib.Repr 属性)

maxother (reprlib.Repr 属性)

maxpp() (在 audioop 模块中)

maxset (reprlib.Repr 属性)

maxsize (asyncio.Queue 属性)

maxsize() (在 sys 模块中)

maxstring (reprlib.Repr 属性)

maxtuple (reprlib.Repr 属性)

maxunicode() (在 sys 模块中)

MAXYEAR() (在 datetime 模块中)

MB_ICONASTERISK() (在 winsound 模块中)

MB_ICONEXCLAMATION() (在 winsound 模块中)

MB_ICONHAND() (在 winsound 模块中)

MB_ICONQUESTION() (在 winsound 模块中)

MB_OK() (在 winsound 模块中)

mbox (mailbox 中的类)

mboxMessage (mailbox 中的类)

mean (statistics.NormalDist 属性)

mean() (在 statistics 模块中)

measure() (tkinter.font.Font 方法)

median (statistics.NormalDist 属性)

median() (在 statistics 模块中)

median_grouped() (在 statistics 模块中)

median_high() (在 statistics 模块中)

median_low() (在 statistics 模块中)

MemberDescriptorType() (在 types 模块中)

membership

test

memfd_create() (在 os 模块中)

memmove() (在 ctypes 模块中)

MemoryBIO (ssl 中的类)

MemoryError

MemoryHandler (logging.handlers 中的类)

memoryview

对象, [1]

memoryview (內置类)

memset() (在 ctypes 模块中)

merge() (在 heapq 模块中)

Message (email.message 中的类)

(mailbox 中的类)

(tkinter.messagebox 中的类)

message digest, MD5

message_factory (email.policy.Policy 属性)

message_from_binary_file() (在 email 模块中)

message_from_bytes() (在 email 模块中)

message_from_file() (在 email 模块中)

message_from_string() (在 email 模块中)

MessageBeep() (在 winsound 模块中)

MessageClass (http.server.BaseHTTPRequestHandler 属性)

MessageError

MessageParseError

messages() (在 xml.parsers.expat.errors 模块中)

meta

hooks

meta hooks

meta path finder -- 元路径查找器

meta() (在 curses 模块中)

meta_path() (在 sys 模块中)

metaclass

(2to3 fixer)

metaclass -- 元类

metaclass hint

MetaPathFinder (importlib.abc 中的类)

metavar (optparse.Option 属性)

MetavarTypeHelpFormatter (argparse 中的类)

Meter (tkinter.tix 中的类)

METH_CLASS (內置变量)

METH_COEXIST (內置变量)

METH_FASTCALL (內置变量)

METH_NOARGS (內置变量)

METH_O (內置变量)

METH_STATIC (內置变量)

METH_VARARGS (內置变量)

method

built-in

call

magic

special

user-defined

对象, [1], [2], [3], [4], [5]

method (urllib.request.Request 属性)

method -- 方法

method resolution order -- 方法解析顺序

METHOD_BLOWFISH() (在 crypt 模块中)

method_calls (unittest.mock.Mock 属性)

METHOD_CRYPT() (在 crypt 模块中)

METHOD_MD5() (在 crypt 模块中)

METHOD_SHA256() (在 crypt 模块中)

METHOD_SHA512() (在 crypt 模块中)

methodattrs (2to3 fixer)

methodcaller() (在 operator 模块中)

MethodDescriptorType() (在 types 模块中)

methodHelp() (xmlrpc.client.ServerProxy.system 方法)

methods

bytearray

bytes

string

methods (pyclbr.Class 属性)

methods() (在 crypt 模块中)

methodSignature() (xmlrpc.client.ServerProxy.system 方法)

MethodType (in module types), [1]

MethodType() (在 types 模块中)

MethodWrapperType() (在 types 模块中)

metrics() (tkinter.font.Font 方法)

MFD_ALLOW_SEALING() (在 os 模块中)

MFD_CLOEXEC() (在 os 模块中)

MFD_HUGE_16GB() (在 os 模块中)

MFD_HUGE_16MB() (在 os 模块中)

MFD_HUGE_1GB() (在 os 模块中)

MFD_HUGE_1MB() (在 os 模块中)

MFD_HUGE_256MB() (在 os 模块中)

MFD_HUGE_2GB() (在 os 模块中)

MFD_HUGE_2MB() (在 os 模块中)

MFD_HUGE_32MB() (在 os 模块中)

MFD_HUGE_512KB() (在 os 模块中)

MFD_HUGE_512MB() (在 os 模块中)

MFD_HUGE_64KB() (在 os 模块中)

MFD_HUGE_8MB() (在 os 模块中)

MFD_HUGE_MASK() (在 os 模块中)

MFD_HUGE_SHIFT() (在 os 模块中)

MFD_HUGETLB() (在 os 模块中)

MH (mailbox 中的类)

MHMessage (mailbox 中的类)

microsecond (datetime.datetime 属性)

(datetime.time 属性)

MIME

base64 encoding

content type

headers, [1]

quoted-printable encoding

MIMEApplication (email.mime.application 中的类)

MIMEAudio (email.mime.audio 中的类)

MIMEBase (email.mime.base 中的类)

MIMEImage (email.mime.image 中的类)

MIMEMessage (email.mime.message 中的类)

MIMEMultipart (email.mime.multipart 中的类)

MIMENonMultipart (email.mime.nonmultipart 中的类)

MIMEPart (email.message 中的类)

MIMEText (email.mime.text 中的类)

mimetypes

模块

MimeTypes (mimetypes 中的类)

MIMEVersionHeader (email.headerregistry 中的类)

min

內置函数

min (datetime.date 属性)

(datetime.datetime 属性)

(datetime.time 属性)

(datetime.timedelta 属性)

min()

內置函数

min() (decimal.Context 方法)

(decimal.Decimal 方法)

MIN_EMIN() (在 decimal 模块中)

MIN_ETINY() (在 decimal 模块中)

min_mag() (decimal.Context 方法)

(decimal.Decimal 方法)

MINEQUAL() (在 token 模块中)

MINIMUM_SUPPORTED (ssl.TLSVersion 属性)

minimum_version (ssl.SSLContext 属性)

minmax() (在 audioop 模块中)

minor (email.headerregistry.MIMEVersionHeader 属性)

minor() (在 os 模块中)

minus

minus() (decimal.Context 方法)

MINUS() (在 token 模块中)

minute (datetime.datetime 属性)

(datetime.time 属性)

MINYEAR() (在 datetime 模块中)

mirrored() (在 unicodedata 模块中)

misc_header (cmd.Cmd 属性)

MISSING (contextvars.Token 属性)

MISSING() (在 dataclasses 模块中)

MISSING_C_DOCSTRINGS() (在 test.support 模块中)

missing_compiler_executable() (在 test.support 模块中)

MissingSectionHeaderError

MIXERDEV

mkd() (ftplib.FTP 方法)

mkdir() (pathlib.Path 方法)

(在 os 模块中)

mkdtemp() (在 tempfile 模块中)

mkfifo() (在 os 模块中)

mknod() (在 os 模块中)

mkpath() (distutils.ccompiler.CCompiler 方法)

(在 distutils.dir_util 模块中)

mksalt() (在 crypt 模块中)

mkstemp() (在 tempfile 模块中)

mktemp() (在 tempfile 模块中)

mktime() (在 time 模块中)

mktime_tz() (在 email.utils 模块中)

mlsd() (ftplib.FTP 方法)

mmap

模块

mmap (mmap 中的类)

MMDF (mailbox 中的类)

MMDFMessage (mailbox 中的类)

Mock (unittest.mock 中的类)

mock_add_spec() (unittest.mock.Mock 方法)

mock_calls (unittest.mock.Mock 属性)

mock_open() (在 unittest.mock 模块中)

Mod (ast 中的类)

mod() (在 operator 模块中)

mode (io.FileIO 属性)

(ossaudiodev.oss_audio_device 属性)

(statistics.NormalDist 属性)

(tarfile.TarInfo 属性)

mode() (在 statistics 模块中)

(在 turtle 模块中)

modes

file

modf() (在 math 模块中)

modified() (urllib.robotparser.RobotFileParser 方法)

Modify() (msilib.View 方法)

modify() (select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(selectors.BaseSelector 方法)

module

extension

importing

namespace

search path, [1], [2], [3], [4], [5], [6], [7]

对象, [1], [2]

module (pyclbr.Class 属性)

(pyclbr.Function 属性)

Module browser

module spec

module spec -- 模块规格

module_for_loader() (在 importlib.util 模块中)

module_from_spec() (在 importlib.util 模块中)

module_repr() (importlib.abc.Loader 方法)

modulefinder

模块

ModuleFinder (modulefinder 中的类)

ModuleInfo (pkgutil 中的类)

ModuleNotFoundError

modules (in module sys), [1]

(modulefinder.ModuleFinder 属性)

modules() (在 sys 模块中)

modules_cleanup() (在 test.support.import_helper 模块中)

modules_setup() (在 test.support.import_helper 模块中)

ModuleSpec (importlib.machinery 中的类)

ModuleType (in module types)

(types 中的类)

modulo

MONDAY() (在 calendar 模块中)

monotonic() (在 time 模块中)

monotonic_ns() (在 time 模块中)

month (datetime.date 属性)

(datetime.datetime 属性)

month() (在 calendar 模块中)

month_abbr() (在 calendar 模块中)

month_name() (在 calendar 模块中)

monthcalendar() (在 calendar 模块中)

monthdatescalendar() (calendar.Calendar 方法)

monthdays2calendar() (calendar.Calendar 方法)

monthdayscalendar() (calendar.Calendar 方法)

monthrange() (在 calendar 模块中)

Morsel (http.cookies 中的类)

most_common() (collections.Counter 方法)

mouseinterval() (在 curses 模块中)

mousemask() (在 curses 模块中)

move() (curses.panel.Panel 方法)

(curses.window 方法)

(mmap.mmap 方法)

(tkinter.ttk.Treeview 方法)

(在 shutil 模块中)

move_file() (distutils.ccompiler.CCompiler 方法)

(在 distutils.file_util 模块中)

move_to_end() (collections.OrderedDict 方法)

MozillaCookieJar (http.cookiejar 中的类)

MRO

mro() (class 方法)

msg (http.client.HTTPResponse 属性)

(json.JSONDecodeError 属性)

(re.error 属性)

(traceback.TracebackException 属性)

msg() (telnetlib.Telnet 方法)

msi

msilib

模块

msvcrt

模块

mt_interact() (telnetlib.Telnet 方法)

mtime (gzip.GzipFile 属性)

(tarfile.TarInfo 属性)

mtime() (urllib.robotparser.RobotFileParser 方法)

mul() (在 audioop 模块中)

(在 operator 模块中)

Mult (ast 中的类)

MultiCall (xmlrpc.client 中的类)

MULTILINE() (在 re 模块中)

MultiLoopChildWatcher (asyncio 中的类)

multimode() (在 statistics 模块中)

MultipartConversionError

multiplication

multiply() (decimal.Context 方法)

multiprocessing

模块

multiprocessing.connection

模块

multiprocessing.dummy

模块

multiprocessing.Manager()

內置函数

multiprocessing.managers

模块

multiprocessing.pool

模块

multiprocessing.shared_memory

模块

multiprocessing.sharedctypes

模块

mutable

sequence types

对象, [1], [2]

mutable -- 可变对象

mutable object

mutable sequence

loop over

对象

MutableMapping (collections.abc 中的类)

(typing 中的类)

MutableSequence (collections.abc 中的类)

(typing 中的类)

MutableSet (collections.abc 中的类)

(typing 中的类)

mvderwin() (curses.window 方法)

mvwin() (curses.window 方法)

myrights() (imaplib.IMAP4 方法)

索引 – N

N_TOKENS() (在 token 模块中)

n_waiting (threading.Barrier 属性)

name, [1], [2]

binding, [1], [2], [3], [4], [5], [6]

binding, global

class

function, [1]

mangling, [1]

rebinding

unbinding

Name (ast 中的类)

name (codecs.CodecInfo 属性)

(contextvars.ContextVar 属性)

(doctest.DocTest 属性)

(email.headerregistry.BaseHeader 属性)

(gzip.GzipFile 属性)

(hashlib.hash 属性)

(hmac.HMAC 属性)

(http.cookiejar.Cookie 属性)

(importlib.abc.FileLoader 属性)

(importlib.machinery.ExtensionFileLoader 属性)

(importlib.machinery.ModuleSpec 属性)

(importlib.machinery.SourceFileLoader 属性)

(importlib.machinery.SourcelessFileLoader 属性)

(inspect.Parameter 属性)

(io.FileIO 属性)

(multiprocessing.Process 属性)

(multiprocessing.shared_memory.SharedMemory 属性)

(os.DirEntry 属性)

(ossaudiodev.oss_audio_device 属性)

(pathlib.PurePath 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

(tarfile.TarInfo 属性)

(threading.Thread 属性)

(xml.dom.Attr 属性)

(xml.dom.DocumentType 属性)

(zipfile.Path 属性)

name() (importlib.abc.Traversable 方法)

(在 os 模块中)

NAME() (在 token 模块中)

name() (在 unicodedata 模块中)

name2codepoint() (在 html.entities 模块中)

named expression

Named Shared Memory

named tuple -- 具名元组

NamedExpr (ast 中的类)

NamedTemporaryFile() (在 tempfile 模块中)

NamedTuple (typing 中的类)

namedtuple() (在 collections 模块中)

NameError

例外

NameError (built-in exception)

namelist() (zipfile.ZipFile 方法)

nameprep() (在 encodings.idna 模块中)

namer (logging.handlers.BaseRotatingHandler 属性)

namereplace

error handler's name

namereplace_errors() (在 codecs 模块中)

names

private

names() (在 tkinter.font 模块中)

namespace

global

module

package

Namespace (argparse 中的类)

(multiprocessing.managers 中的类)

namespace -- 命名空间

namespace package -- 命名空间包

namespace() (imaplib.IMAP4 方法)

Namespace() (multiprocessing.managers.SyncManager 方法)

NAMESPACE_DNS() (在 uuid 模块中)

NAMESPACE_OID() (在 uuid 模块中)

NAMESPACE_URL() (在 uuid 模块中)

NAMESPACE_X500() (在 uuid 模块中)

NamespaceErr

namespaceURI (xml.dom.Node 属性)

nametofont() (在 tkinter.font 模块中)

NaN

nan() (在 cmath 模块中)

(在 math 模块中)

nanj() (在 cmath 模块中)

NannyNag

napms() (在 curses 模块中)

nargs (optparse.Option 属性)

native_id (threading.Thread 属性)

nbytes (memoryview 属性)

ncurses_version() (在 curses 模块中)

ndiff() (在 difflib 模块中)

ndim (memoryview 属性)

ne (2to3 fixer)

ne() (在 operator 模块中)

needs_input (bz2.BZ2Decompressor 属性)

(lzma.LZMADecompressor 属性)

neg() (在 operator 模块中)

negation

nested scope -- 嵌套作用域

netmask (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

NetmaskValueError

netrc

模块

netrc (netrc 中的类)

NetrcParseError

netscape (http.cookiejar.CookiePolicy 属性)

network (ipaddress.IPv4Interface 属性)

(ipaddress.IPv6Interface 属性)

Network News Transfer Protocol

network_address (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

NEVER_EQ() (在 test.support 模块中)

new() (在 hashlib 模块中)

(在 hmac 模块中)

new-style class -- 新式类

new_child() (collections.ChainMap 方法)

new_class() (在 types 模块中)

new_compiler() (在 distutils.ccompiler 模块中)

new_event_loop() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

new_module() (在 imp 模块中)

new_panel() (在 curses.panel 模块中)

newer() (在 distutils.dep_util 模块中)

newer_group() (在 distutils.dep_util 模块中)

newer_pairwise() (在 distutils.dep_util 模块中)

newfunc (C type)

newgroups() (nntplib.NNTP 方法)

NEWLINE token, [1]

NEWLINE() (在 token 模块中)

newlines (io.TextIOBase 属性)

newnews() (nntplib.NNTP 方法)

newpad() (在 curses 模块中)

NewType (typing 中的类)

newwin() (在 curses 模块中)

next (2to3 fixer)

(pdb command)

next()

內置函数

next() (nntplib.NNTP 方法)

(tarfile.TarFile 方法)

(tkinter.ttk.Treeview 方法)

next_minus() (decimal.Context 方法)

(decimal.Decimal 方法)

next_plus() (decimal.Context 方法)

(decimal.Decimal 方法)

next_toward() (decimal.Context 方法)

(decimal.Decimal 方法)

nextafter() (在 math 模块中)

nextfile() (在 fileinput 模块中)

nextkey() (dbm.gnu.gdbm 方法)

nextSibling (xml.dom.Node 属性)

ngettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

nice() (在 os 模块中)

nis

模块

nl() (在 curses 模块中)

NL() (在 token 模块中)

nl_langinfo() (在 locale 模块中)

nlargest() (在 heapq 模块中)

nlst() (ftplib.FTP 方法)

NNTP

protocol

NNTP (nntplib 中的类)

nntp_implementation (nntplib.NNTP 属性)

NNTP_SSL (nntplib 中的类)

nntp_version (nntplib.NNTP 属性)

NNTPDataError

NNTPError

nntplib

模块

NNTPPermanentError

NNTPProtocolError

NNTPReplyError

NNTPTemporaryError

no_cache() (zoneinfo.ZoneInfo 类方法)

no_proxy

no_tracing() (在 test.support 模块中)

no_type_check() (在 typing 模块中)

no_type_check_decorator() (在 typing 模块中)

nocbreak() (在 curses 模块中)

NoDataAllowedErr

node() (在 platform 模块中)

nodelay() (curses.window 方法)

nodeName (xml.dom.Node 属性)

NodeTransformer (ast 中的类)

nodeType (xml.dom.Node 属性)

nodeValue (xml.dom.Node 属性)

NodeVisitor (ast 中的类)

noecho() (在 curses 模块中)

NOEXPR() (在 locale 模块中)

NoModificationAllowedErr

nonblock() (ossaudiodev.oss_audio_device 方法)

NonCallableMagicMock (unittest.mock 中的类)

NonCallableMock (unittest.mock 中的类)

None

对象, [1], [2]

None (Built-in object)

(內置变量)

NoneType() (在 types 模块中)

nonl() (在 curses 模块中)

nonlocal

语句

Nonlocal (ast 中的类)

nonzero (2to3 fixer)

noop() (imaplib.IMAP4 方法)

(poplib.POP3 方法)

NoOptionError

NOP (opcode)

noqiflush() (在 curses 模块中)

noraw() (在 curses 模块中)

NoReturn() (在 typing 模块中)

NORMAL() (在 tkinter.font 模块中)

NORMAL_PRIORITY_CLASS() (在 subprocess 模块中)

NormalDist (statistics 中的类)

normalize() (decimal.Context 方法)

(decimal.Decimal 方法)

(xml.dom.Node 方法)

(在 locale 模块中)

(在 unicodedata 模块中)

NORMALIZE_WHITESPACE() (在 doctest 模块中)

normalvariate() (在 random 模块中)

normcase() (在 os.path 模块中)

normpath() (在 os.path 模块中)

NoSectionError

NoSuchMailboxError

not

运算符, [1]

Not (ast 中的类)

not in

运算符, [1], [2]

not_() (在 operator 模块中)

NotADirectoryError

notation

notationDecl() (xml.sax.handler.DTDHandler 方法)

NotationDeclHandler() (xml.parsers.expat.xmlparser 方法)

notations (xml.dom.DocumentType 属性)

NotConnected

NoteBook (tkinter.tix 中的类)

Notebook (tkinter.ttk 中的类)

NotEmptyError

NotEq (ast 中的类)

NOTEQUAL() (在 token 模块中)

NotFoundErr

notify() (asyncio.Condition 方法)

(threading.Condition 方法)

notify_all() (asyncio.Condition 方法)

(threading.Condition 方法)

notimeout() (curses.window 方法)

NotImplemented

对象

NotImplemented (內置变量)

NotImplementedError

NotImplementedType() (在 types 模块中)

NotIn (ast 中的类)

NotStandaloneHandler() (xml.parsers.expat.xmlparser 方法)

NotSupportedErr

NotSupportedError

noutrefresh() (curses.window 方法)

now() (datetime.datetime 类方法)

npgettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

NSIG() (在 signal 模块中)

nsmallest() (在 heapq 模块中)

NT_OFFSET() (在 token 模块中)

NTEventLogHandler (logging.handlers 中的类)

ntohl() (在 socket 模块中)

ntohs() (在 socket 模块中)

ntransfercmd() (ftplib.FTP 方法)

null

operation, [1]

nullcontext() (在 contextlib 模块中)

NullHandler (logging 中的类)

NullImporter (imp 中的类)

NullTranslations (gettext 中的类)

num_addresses (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

num_tickets (ssl.SSLContext 属性)

number

complex

floating point

Number (numbers 中的类)

NUMBER() (在 token 模块中)

number_class() (decimal.Context 方法)

(decimal.Decimal 方法)

numbers

模块

numerator (fractions.Fraction 属性)

(numbers.Rational 属性)

numeric

conversions

literals

object

types, operations on

对象, [1], [2], [3]

numeric literal

numeric() (在 unicodedata 模块中)

numinput() (在 turtle 模块中)

numliterals (2to3 fixer)

索引 – O

O_APPEND() (在 os 模块中)

O_ASYNC() (在 os 模块中)

O_BINARY() (在 os 模块中)

O_CLOEXEC() (在 os 模块中)

O_CREAT() (在 os 模块中)

O_DIRECT() (在 os 模块中)

O_DIRECTORY() (在 os 模块中)

O_DSYNC() (在 os 模块中)

O_EVTONLY() (在 os 模块中)

O_EXCL() (在 os 模块中)

O_EXLOCK() (在 os 模块中)

O_FSYNC() (在 os 模块中)

O_NDELAY() (在 os 模块中)

O_NOATIME() (在 os 模块中)

O_NOCTTY() (在 os 模块中)

O_NOFOLLOW() (在 os 模块中)

O_NOFOLLOW_ANY() (在 os 模块中)

O_NOINHERIT() (在 os 模块中)

O_NONBLOCK() (在 os 模块中)

O_PATH() (在 os 模块中)

O_RANDOM() (在 os 模块中)

O_RDONLY() (在 os 模块中)

O_RDWR() (在 os 模块中)

O_RSYNC() (在 os 模块中)

O_SEQUENTIAL() (在 os 模块中)

O_SHLOCK() (在 os 模块中)

O_SHORT_LIVED() (在 os 模块中)

O_SYMLINK() (在 os 模块中)

O_SYNC() (在 os 模块中)

O_TEMPORARY() (在 os 模块中)

O_TEXT() (在 os 模块中)

O_TMPFILE() (在 os 模块中)

O_TRUNC() (在 os 模块中)

O_WRONLY() (在 os 模块中)

obj (memoryview 属性)

object

code, [1], [2], [3]

deallocation

finalization

immutable, [1]

numeric

object (UnicodeError 属性)

(內置类)

object -- 对象

object.__match_args__ (內置变量)

object.__slots__ (內置变量)

object_filenames() (distutils.ccompiler.CCompiler 方法)

objects

comparing

flattening

marshalling

persistent

pickling

serializing

objobjargproc (C type)

objobjproc (C type)

obufcount() (ossaudiodev.oss_audio_device 方法)

obuffree() (ossaudiodev.oss_audio_device 方法)

oct()

內置函数

octal

literals

octal literal

octdigits() (在 string 模块中)

offset (SyntaxError 属性)

(traceback.TracebackException 属性)

(xml.parsers.expat.ExpatError 属性)

OK() (在 curses 模块中)

ok_command() (tkinter.filedialog.LoadFileDialog 方法)

(tkinter.filedialog.SaveFileDialog 方法)

ok_event() (tkinter.filedialog.FileDialog 方法)

old_value (contextvars.Token 属性)

OleDLL (ctypes 中的类)

on_motion() (tkinter.dnd.DndHandler 方法)

on_release() (tkinter.dnd.DndHandler 方法)

onclick() (在 turtle 模块中)

ondrag() (在 turtle 模块中)

onecmd() (cmd.Cmd 方法)

onkey() (在 turtle 模块中)

onkeypress() (在 turtle 模块中)

onkeyrelease() (在 turtle 模块中)

onrelease() (在 turtle 模块中)

onscreenclick() (在 turtle 模块中)

ontimer() (在 turtle 模块中)

OP() (在 token 模块中)

OP_ALL() (在 ssl 模块中)

OP_CIPHER_SERVER_PREFERENCE() (在 ssl 模块中)

OP_ENABLE_MIDDLEBOX_COMPAT() (在 ssl 模块中)

OP_IGNORE_UNEXPECTED_EOF() (在 ssl 模块中)

OP_NO_COMPRESSION() (在 ssl 模块中)

OP_NO_RENEGOTIATION() (在 ssl 模块中)

OP_NO_SSLv2() (在 ssl 模块中)

OP_NO_SSLv3() (在 ssl 模块中)

OP_NO_TICKET() (在 ssl 模块中)

OP_NO_TLSv1() (在 ssl 模块中)

OP_NO_TLSv1_1() (在 ssl 模块中)

OP_NO_TLSv1_2() (在 ssl 模块中)

OP_NO_TLSv1_3() (在 ssl 模块中)

OP_SINGLE_DH_USE() (在 ssl 模块中)

OP_SINGLE_ECDH_USE() (在 ssl 模块中)

open

內置函数, [1]

Open (tkinter.filedialog 中的类)

open()

內置函数

open() (distutils.text_file.TextFile 方法)

(imaplib.IMAP4 方法)

(importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(pipes.Template 方法)

(tarfile.TarFile 类方法)

(telnetlib.Telnet 方法)

(urllib.request.OpenerDirector 方法)

(urllib.request.URLopener 方法)

(webbrowser.controller 方法)

(zipfile.Path 方法)

(zipfile.ZipFile 方法)

(在 aifc 模块中)

(在 bz2 模块中)

(在 codecs 模块中)

(在 dbm 模块中)

(在 dbm.dumb 模块中)

(在 dbm.gnu 模块中)

(在 dbm.ndbm 模块中)

(在 gzip 模块中)

(在 io 模块中)

(在 lzma 模块中)

(在 os 模块中)

(在 ossaudiodev 模块中)

(在 shelve 模块中)

(在 sunau 模块中)

(在 tarfile 模块中)

(在 tokenize 模块中)

(在 wave 模块中)

(在 webbrowser 模块中)

open_binary() (在 importlib.resources 模块中)

open_code() (在 io 模块中)

open_connection() (在 asyncio 模块中)

open_new() (webbrowser.controller 方法)

(在 webbrowser 模块中)

open_new_tab() (webbrowser.controller 方法)

(在 webbrowser 模块中)

open_osfhandle() (在 msvcrt 模块中)

open_resource() (importlib.abc.ResourceReader 方法)

open_text() (在 importlib.resources 模块中)

open_unix_connection() (在 asyncio 模块中)

open_unknown() (urllib.request.URLopener 方法)

open_urlresource() (在 test.support 模块中)

OpenDatabase() (在 msilib 模块中)

OpenerDirector (urllib.request 中的类)

OpenKey() (在 winreg 模块中)

OpenKeyEx() (在 winreg 模块中)

openlog() (在 syslog 模块中)

openmixer() (在 ossaudiodev 模块中)

openpty() (在 os 模块中)

(在 pty 模块中)

OpenSSL

(use in module hashlib)

(use in module ssl)

OPENSSL_VERSION() (在 ssl 模块中)

OPENSSL_VERSION_INFO() (在 ssl 模块中)

OPENSSL_VERSION_NUMBER() (在 ssl 模块中)

OpenView() (msilib.Database 方法)

operation

binary arithmetic

binary bitwise

Boolean

concatenation

null, [1]

power

repetition

shifting

slice

subscript

unary arithmetic

unary bitwise

OperationalError

operations

bitwise

Boolean, [1]

masking

shifting

operations on

dictionary type

integer types

list type

mapping types

numeric types

sequence types, [1]

operator

+ (plus), [1], [2]

- (minus), [1], [2]

comparison

overloading

precedence

ternary

模块

operator (2to3 fixer)

operators

opmap() (在 dis 模块中)

opname() (在 dis 模块中)

OPT

optim_args_from_interpreter_flags() (在 test.support 模块中)

optimize() (在 pickletools 模块中)

OPTIMIZED_BYTECODE_SUFFIXES() (在 importlib.machinery 模块中)

Optional() (在 typing 模块中)

OptionGroup (optparse 中的类)

OptionMenu (tkinter.tix 中的类)

OptionParser (optparse 中的类)

options (doctest.Example 属性)

Options (ssl 中的类)

options (ssl.SSLContext 属性)

options() (configparser.ConfigParser 方法)

optionxform() (configparser.ConfigParser 方法)

optparse

模块

or

bitwise

exclusive

inclusive

运算符, [1], [2]

Or (ast 中的类)

or_() (在 operator 模块中)

ord

內置函数

ord()

內置函数

order

evaluation

ordered_attributes (xml.parsers.expat.xmlparser 属性)

OrderedDict (collections 中的类)

(typing 中的类)

orig_argv() (在 sys 模块中)

origin (importlib.machinery.ModuleSpec 属性)

origin_req_host (urllib.request.Request 属性)

origin_server (wsgiref.handlers.BaseHandler 属性)

os

模块, [1]

os.path

模块

os_environ (wsgiref.handlers.BaseHandler 属性)

OSError

ossaudiodev

模块

OSSAudioError

outfile

json.tool command line option

output

standard

output (subprocess.CalledProcessError 属性)

(subprocess.TimeoutExpired 属性)

(unittest.TestCase 属性)

output() (http.cookies.BaseCookie 方法)

(http.cookies.Morsel 方法)

output_charset (email.charset.Charset 属性)

output_charset() (gettext.NullTranslations 方法)

output_codec (email.charset.Charset 属性)

output_difference() (doctest.OutputChecker 方法)

OutputChecker (doctest 中的类)

OutputString() (http.cookies.Morsel 方法)

OutsideDestinationError

over() (nntplib.NNTP 方法)

Overflow (decimal 中的类)

OverflowError

(built-in exception), [1], [2], [3], [4], [5]

overlap() (statistics.NormalDist 方法)

overlaps() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

overlay() (curses.window 方法)

overload() (在 typing 模块中)

overloading

operator

overwrite() (curses.window 方法)

owner() (pathlib.Path 方法)

索引 – P

p (pdb command)

P_ALL() (在 os 模块中)

P_DETACH() (在 os 模块中)

P_NOWAIT() (在 os 模块中)

P_NOWAITO() (在 os 模块中)

P_OVERLAY() (在 os 模块中)

P_PGID() (在 os 模块中)

P_PID() (在 os 模块中)

P_PIDFD() (在 os 模块中)

P_WAIT() (在 os 模块中)

pack() (mailbox.MH 方法)

(struct.Struct 方法)

(在 struct 模块中)

pack_array() (xdrlib.Packer 方法)

pack_bytes() (xdrlib.Packer 方法)

pack_double() (xdrlib.Packer 方法)

pack_farray() (xdrlib.Packer 方法)

pack_float() (xdrlib.Packer 方法)

pack_fopaque() (xdrlib.Packer 方法)

pack_fstring() (xdrlib.Packer 方法)

pack_into() (struct.Struct 方法)

(在 struct 模块中)

pack_list() (xdrlib.Packer 方法)

pack_opaque() (xdrlib.Packer 方法)

pack_string() (xdrlib.Packer 方法)

package, [1]

namespace

portion

regular

package variable

__all__

Package() (在 importlib.resources 模块中)

packed (ipaddress.IPv4Address 属性)

(ipaddress.IPv6Address 属性)

Packer (xdrlib 中的类)

packing

binary data

packing (widgets)

PAGER

pair_content() (在 curses 模块中)

pair_number() (在 curses 模块中)

pairwise() (在 itertools 模块中)

PanedWindow (tkinter.tix 中的类)

parameter

call semantics

difference from argument

function definition

value, default

Parameter (inspect 中的类)

parameter -- 形参

ParameterizedMIMEHeader (email.headerregistry 中的类)

parameters (inspect.Signature 属性)

params (email.headerregistry.ParameterizedMIMEHeader 属性)

ParamSpec (typing 中的类)

ParamSpecArgs() (在 typing 模块中)

ParamSpecKwargs() (在 typing 模块中)

paramstyle() (在 sqlite3 模块中)

pardir() (在 os 模块中)

paren (2to3 fixer)

parent (importlib.machinery.ModuleSpec 属性)

(pathlib.PurePath 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

(urllib.request.BaseHandler 属性)

parent() (tkinter.ttk.Treeview 方法)

parent_process() (在 multiprocessing 模块中)

parenthesized form

parentNode (xml.dom.Node 属性)

parents (collections.ChainMap 属性)

(pathlib.PurePath 属性)

paretovariate() (在 random 模块中)

parse() (doctest.DocTestParser 方法)

(email.parser.BytesParser 方法)

(email.parser.Parser 方法)

(string.Formatter 方法)

(urllib.robotparser.RobotFileParser 方法)

(xml.etree.ElementTree.ElementTree 方法)

Parse() (xml.parsers.expat.xmlparser 方法)

parse() (xml.sax.xmlreader.XMLReader 方法)

(在 ast 模块中)

(在 cgi 模块中)

(在 xml.dom.minidom 模块中)

(在 xml.dom.pulldom 模块中)

(在 xml.etree.ElementTree 模块中)

(在 xml.sax 模块中)

parse_and_bind() (在 readline 模块中)

parse_args() (argparse.ArgumentParser 方法)

PARSE_COLNAMES() (在 sqlite3 模块中)

parse_config_h() (在 sysconfig 模块中)

PARSE_DECLTYPES() (在 sqlite3 模块中)

parse_header() (在 cgi 模块中)

parse_headers() (在 http.client 模块中)

parse_intermixed_args() (argparse.ArgumentParser 方法)

parse_known_args() (argparse.ArgumentParser 方法)

parse_known_intermixed_args() (argparse.ArgumentParser 方法)

parse_multipart() (在 cgi 模块中)

parse_qs() (在 urllib.parse 模块中)

parse_qsl() (在 urllib.parse 模块中)

parseaddr() (在 email.utils 模块中)

parsebytes() (email.parser.BytesParser 方法)

parsedate() (在 email.utils 模块中)

parsedate_to_datetime() (在 email.utils 模块中)

parsedate_tz() (在 email.utils 模块中)

ParseError (xml.etree.ElementTree 中的类)

ParseFile() (xml.parsers.expat.xmlparser 方法)

ParseFlags() (在 imaplib 模块中)

parser

Parser (email.parser 中的类)

ParserCreate() (在 xml.parsers.expat 模块中)

ParseResult (urllib.parse 中的类)

ParseResultBytes (urllib.parse 中的类)

parsestr() (email.parser.Parser 方法)

parseString() (在 xml.dom.minidom 模块中)

(在 xml.dom.pulldom 模块中)

(在 xml.sax 模块中)

parsing

URL

ParsingError

partial (asyncio.IncompleteReadError 属性)

partial() (imaplib.IMAP4 方法)

(在 functools 模块中)

partialmethod (functools 中的类)

parties (threading.Barrier 属性)

partition() (bytearray 方法)

(bytes 方法)

(str 方法)

parts (pathlib.PurePath 属性)

pass

语句

Pass (ast 中的类)

pass_() (poplib.POP3 方法)

Paste

patch() (在 test.support 模块中)

(在 unittest.mock 模块中)

patch.dict() (在 unittest.mock 模块中)

patch.multiple() (在 unittest.mock 模块中)

patch.object() (在 unittest.mock 模块中)

patch.stopall() (在 unittest.mock 模块中)

PATH, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40]

path

configuration file

hooks

module search, [1], [2], [3], [4], [5], [6], [7]

operations, [1]

path (http.cookiejar.Cookie 属性)

(http.server.BaseHTTPRequestHandler 属性)

(importlib.abc.FileLoader 属性)

(importlib.machinery.ExtensionFileLoader 属性)

(importlib.machinery.FileFinder 属性)

(importlib.machinery.SourceFileLoader 属性)

(importlib.machinery.SourcelessFileLoader 属性)

(in module sys), [1], [2], [3]

(os.DirEntry 属性)

Path (pathlib 中的类)

(zipfile 中的类)

path based finder

path based finder -- 基于路径的查找器

Path browser

path entry -- 路径入口

path entry finder -- 路径入口查找器

path entry hook -- 路径入口钩子

path hooks

path() (在 importlib.resources 模块中)

(在 sys 模块中)

path-like object -- 路径类对象

path_hook() (importlib.machinery.FileFinder 类方法)

path_hooks() (在 sys 模块中)

path_importer_cache() (在 sys 模块中)

path_mtime() (importlib.abc.SourceLoader 方法)

path_return_ok() (http.cookiejar.CookiePolicy 方法)

path_stats() (importlib.abc.SourceLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

pathconf() (在 os 模块中)

pathconf_names() (在 os 模块中)

PathEntryFinder (importlib.abc 中的类)

PATHEXT, [1], [2]

PathFinder (importlib.machinery 中的类)

pathlib

模块

PathLike (os 中的类)

pathname2url() (在 urllib.request 模块中)

pathsep() (在 os 模块中)

pattern (re.error 属性)

(re.Pattern 属性)

Pattern (typing 中的类)

pattern matching

pause() (在 signal 模块中)

pause_reading() (asyncio.ReadTransport 方法)

pause_writing() (asyncio.BaseProtocol 方法)

PAX_FORMAT() (在 tarfile 模块中)

pax_headers (tarfile.TarFile 属性)

(tarfile.TarInfo 属性)

pbkdf2_hmac() (在 hashlib 模块中)

pd() (在 turtle 模块中)

pdb

模块

Pdb (class in pdb)

(pdb 中的类)

pdf() (statistics.NormalDist 方法)

peek() (bz2.BZ2File 方法)

(gzip.GzipFile 方法)

(io.BufferedReader 方法)

(lzma.LZMAFile 方法)

(weakref.finalize 方法)

peer (smtpd.SMTPChannel 属性)

PEM_cert_to_DER_cert() (在 ssl 模块中)

pen() (在 turtle 模块中)

pencolor() (在 turtle 模块中)

pending (ssl.MemoryBIO 属性)

pending() (ssl.SSLSocket 方法)

PendingDeprecationWarning

pendown() (在 turtle 模块中)

pensize() (在 turtle 模块中)

penup() (在 turtle 模块中)

PEP

PERCENT() (在 token 模块中)

PERCENTEQUAL() (在 token 模块中)

perf_counter() (在 time 模块中)

perf_counter_ns() (在 time 模块中)

Performance

perm() (在 math 模块中)

PermissionError

permutations() (在 itertools 模块中)

Persist() (msilib.SummaryInformation 方法)

persistence

persistent

objects

persistent_id (pickle protocol)

persistent_id() (pickle.Pickler 方法)

persistent_load (pickle protocol)

persistent_load() (pickle.Unpickler 方法)

PF_CAN() (在 socket 模块中)

PF_PACKET() (在 socket 模块中)

PF_RDS() (在 socket 模块中)

pformat() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

pgettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

PGO() (在 test.support 模块中)

phase() (在 cmath 模块中)

Philbrick, Geoff

physical line, [1], [2]

pi() (xml.etree.ElementTree.TreeBuilder 方法)

(在 cmath 模块中)

(在 math 模块中)

pickle

模块, [1], [2], [3], [4]

pickle() (在 copyreg 模块中)

PickleBuffer (pickle 中的类)

PickleError

Pickler (pickle 中的类)

pickletools

模块

pickletools command line option

--annotate

--indentlevel=<num>

--memo

--output=<file>

--preamble=<preamble>

-a

-l

-m

-o

-p

pickling

objects

PicklingError

pid (asyncio.subprocess.Process 属性)

(multiprocessing.Process 属性)

(subprocess.Popen 属性)

pidfd_open() (在 os 模块中)

pidfd_send_signal() (在 signal 模块中)

PidfdChildWatcher (asyncio 中的类)

PIP_USER

Pipe() (在 multiprocessing 模块中)

pipe() (在 os 模块中)

PIPE() (在 subprocess 模块中)

pipe2() (在 os 模块中)

PIPE_BUF() (在 select 模块中)

pipe_connection_lost() (asyncio.SubprocessProtocol 方法)

pipe_data_received() (asyncio.SubprocessProtocol 方法)

PIPE_MAX_SIZE() (在 test.support 模块中)

pipes

模块

PKG_DIRECTORY() (在 imp 模块中)

pkgutil

模块

placeholder (textwrap.TextWrapper 属性)

PLAT

platform

模块

platform (in module sys)

platform() (在 platform 模块中)

(在 sys 模块中)

platlibdir() (在 sys 模块中)

PlaySound() (在 winsound 模块中)

plist

file

plistlib

模块

plock() (在 os 模块中)

plus

plus() (decimal.Context 方法)

PLUS() (在 token 模块中)

PLUSEQUAL() (在 token 模块中)

pm() (在 pdb 模块中)

POINTER() (在 ctypes 模块中)

pointer() (在 ctypes 模块中)

polar() (在 cmath 模块中)

Policy (email.policy 中的类)

poll() (multiprocessing.connection.Connection 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(subprocess.Popen 方法)

(在 select 模块中)

PollSelector (selectors 中的类)

Pool (multiprocessing.pool 中的类)

pop() (array.array 方法)

(collections.deque 方法)

(dict 方法)

(frozenset 方法)

(mailbox.Mailbox 方法)

(sequence method)

POP3

protocol

POP3 (poplib 中的类)

POP3_SSL (poplib 中的类)

pop_all() (contextlib.ExitStack 方法)

POP_BLOCK (opcode)

POP_EXCEPT (opcode)

POP_JUMP_IF_FALSE (opcode)

POP_JUMP_IF_TRUE (opcode)

pop_source() (shlex.shlex 方法)

POP_TOP (opcode)

Popen (subprocess 中的类)

popen() (in module os), [1]

(在 os 模块中)

popitem() (collections.OrderedDict 方法)

(dict 方法)

(mailbox.Mailbox 方法)

popleft() (collections.deque 方法)

poplib

模块

PopupMenu (tkinter.tix 中的类)

port (http.cookiejar.Cookie 属性)

port_specified (http.cookiejar.Cookie 属性)

portion

package

portion -- 部分

pos (json.JSONDecodeError 属性)

(re.error 属性)

(re.Match 属性)

pos() (在 operator 模块中)

(在 turtle 模块中)

position (xml.etree.ElementTree.ParseError 属性)

position() (在 turtle 模块中)

positional argument -- 位置参数

POSIX

I/O control

threads

posix

模块

POSIX Shared Memory

POSIX_FADV_DONTNEED() (在 os 模块中)

POSIX_FADV_NOREUSE() (在 os 模块中)

POSIX_FADV_NORMAL() (在 os 模块中)

POSIX_FADV_RANDOM() (在 os 模块中)

POSIX_FADV_SEQUENTIAL() (在 os 模块中)

POSIX_FADV_WILLNEED() (在 os 模块中)

posix_fadvise() (在 os 模块中)

posix_fallocate() (在 os 模块中)

posix_spawn() (在 os 模块中)

POSIX_SPAWN_CLOSE() (在 os 模块中)

POSIX_SPAWN_DUP2() (在 os 模块中)

POSIX_SPAWN_OPEN() (在 os 模块中)

posix_spawnp() (在 os 模块中)

POSIXLY_CORRECT

PosixPath (pathlib 中的类)

post() (nntplib.NNTP 方法)

(ossaudiodev.oss_audio_device 方法)

post_handshake_auth (ssl.SSLContext 属性)

post_mortem() (在 pdb 模块中)

post_setup() (venv.EnvBuilder 方法)

postcmd() (cmd.Cmd 方法)

postloop() (cmd.Cmd 方法)

pow

內置函数, [1], [2], [3], [4], [5]

Pow (ast 中的类)

pow()

內置函数

pow() (在 math 模块中)

(在 operator 模块中)

power

operation

power() (decimal.Context 方法)

pp (pdb command)

pp() (在 pprint 模块中)

pprint

模块

pprint() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

prcal() (在 calendar 模块中)

pread() (在 os 模块中)

preadv() (在 os 模块中)

preamble (email.message.EmailMessage 属性)

(email.message.Message 属性)

precedence

operator

precmd() (cmd.Cmd 方法)

prefix (xml.dom.Attr 属性)

(xml.dom.Node 属性)

(zipimport.zipimporter 属性)

PREFIX() (在 distutils.sysconfig 模块中)

prefix() (在 sys 模块中)

PREFIXES() (在 site 模块中)

prefixlen (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

preloop() (cmd.Cmd 方法)

prepare() (graphlib.TopologicalSorter 方法)

(logging.handlers.QueueHandler 方法)

(logging.handlers.QueueListener 方法)

prepare_class() (在 types 模块中)

prepare_input_source() (在 xml.sax.saxutils 模块中)

PrepareProtocol (sqlite3 中的类)

prepend() (pipes.Template 方法)

preprocess() (distutils.ccompiler.CCompiler 方法)

PrettyPrinter (pprint 中的类)

prev() (tkinter.ttk.Treeview 方法)

previousSibling (xml.dom.Node 属性)

primary

print

內置函数

print (2to3 fixer)

print()

內置函数

print() (built-in function)

__str__() (object method)

print_callees() (pstats.Stats 方法)

print_callers() (pstats.Stats 方法)

print_directory() (在 cgi 模块中)

print_environ() (在 cgi 模块中)

print_environ_usage() (在 cgi 模块中)

print_exc() (timeit.Timer 方法)

(在 traceback 模块中)

print_exception() (在 traceback 模块中)

PRINT_EXPR (opcode)

print_form() (在 cgi 模块中)

print_help() (argparse.ArgumentParser 方法)

print_last() (在 traceback 模块中)

print_stack() (asyncio.Task 方法)

(在 traceback 模块中)

print_stats() (profile.Profile 方法)

(pstats.Stats 方法)

print_tb() (在 traceback 模块中)

print_usage() (argparse.ArgumentParser 方法)

(optparse.OptionParser 方法)

print_version() (optparse.OptionParser 方法)

print_warning() (在 test.support 模块中)

printable() (在 string 模块中)

printdir() (zipfile.ZipFile 方法)

printf-style formatting, [1]

PRIO_PGRP() (在 os 模块中)

PRIO_PROCESS() (在 os 模块中)

PRIO_USER() (在 os 模块中)

PriorityQueue (asyncio 中的类)

(queue 中的类)

private

names

prlimit() (在 resource 模块中)

prmonth() (calendar.TextCalendar 方法)

(在 calendar 模块中)

ProactorEventLoop (asyncio 中的类)

procedure

call

process

group, [1]

id

id of parent

killing, [1]

scheduling priority, [1]

signalling, [1]

Process (multiprocessing 中的类)

process() (logging.LoggerAdapter 方法)

process_exited() (asyncio.SubprocessProtocol 方法)

process_message() (smtpd.SMTPServer 方法)

process_request() (socketserver.BaseServer 方法)

process_time() (在 time 模块中)

process_time_ns() (在 time 模块中)

process_tokens() (在 tabnanny 模块中)

ProcessError

processes, light-weight

processingInstruction() (xml.sax.handler.ContentHandler 方法)

ProcessingInstruction() (在 xml.etree.ElementTree 模块中)

ProcessingInstructionHandler() (xml.parsers.expat.xmlparser 方法)

ProcessLookupError

processor time, [1]

processor() (在 platform 模块中)

ProcessPoolExecutor (concurrent.futures 中的类)

prod() (在 math 模块中)

product() (在 itertools 模块中)

profile

模块

Profile (profile 中的类)

profile function, [1], [2], [3]

PROFILE_TASK

profiler, [1]

profiling, deterministic

program

ProgrammingError

Progressbar (tkinter.ttk 中的类)

prompt (cmd.Cmd 属性)

prompt_user_passwd() (urllib.request.FancyURLopener 方法)

prompts, interpreter

propagate (logging.Logger 属性)

property (內置类)

property list

property_declaration_handler() (在 xml.sax.handler 模块中)

property_dom_node() (在 xml.sax.handler 模块中)

property_lexical_handler() (在 xml.sax.handler 模块中)

property_xml_string() (在 xml.sax.handler 模块中)

PropertyMock (unittest.mock 中的类)

prot_c() (ftplib.FTP_TLS 方法)

prot_p() (ftplib.FTP_TLS 方法)

proto (socket.socket 属性)

protocol

CGI

context management

copy

FTP, [1]

HTTP, [1], [2], [3], [4], [5]

IMAP4

IMAP4_SSL

IMAP4_stream

iterator

NNTP

POP3

SMTP

Telnet

Protocol (asyncio 中的类)

protocol (ssl.SSLContext 属性)

Protocol (typing 中的类)

PROTOCOL_SSLv2() (在 ssl 模块中)

PROTOCOL_SSLv23() (在 ssl 模块中)

PROTOCOL_SSLv3() (在 ssl 模块中)

PROTOCOL_TLS() (在 ssl 模块中)

PROTOCOL_TLS_CLIENT() (在 ssl 模块中)

PROTOCOL_TLS_SERVER() (在 ssl 模块中)

PROTOCOL_TLSv1() (在 ssl 模块中)

PROTOCOL_TLSv1_1() (在 ssl 模块中)

PROTOCOL_TLSv1_2() (在 ssl 模块中)

protocol_version (http.server.BaseHTTPRequestHandler 属性)

PROTOCOL_VERSION (imaplib.IMAP4 属性)

ProtocolError (xmlrpc.client 中的类)

provisional API -- 暂定 API

provisional package -- 暂定包

proxy() (在 weakref 模块中)

proxyauth() (imaplib.IMAP4 方法)

ProxyBasicAuthHandler (urllib.request 中的类)

ProxyDigestAuthHandler (urllib.request 中的类)

ProxyHandler (urllib.request 中的类)

ProxyType() (在 weakref 模块中)

ProxyTypes() (在 weakref 模块中)

pryear() (calendar.TextCalendar 方法)

ps1() (在 sys 模块中)

ps2() (在 sys 模块中)

pstats

模块

pstdev() (在 statistics 模块中)

pthread_getcpuclockid() (在 time 模块中)

pthread_kill() (在 signal 模块中)

pthread_sigmask() (在 signal 模块中)

pthreads

pty

模块, [1]

pu() (在 turtle 模块中)

publicId (xml.dom.DocumentType 属性)

PullDom (xml.dom.pulldom 中的类)

punctuation() (在 string 模块中)

punctuation_chars (shlex.shlex 属性)

PurePath (pathlib 中的类)

PurePosixPath (pathlib 中的类)

PureProxy (smtpd 中的类)

PureWindowsPath (pathlib 中的类)

purge() (在 re 模块中)

Purpose.CLIENT_AUTH() (在 ssl 模块中)

Purpose.SERVER_AUTH() (在 ssl 模块中)

push() (asynchat.async_chat 方法)

(code.InteractiveConsole 方法)

(contextlib.ExitStack 方法)

push_async_callback() (contextlib.AsyncExitStack 方法)

push_async_exit() (contextlib.AsyncExitStack 方法)

push_source() (shlex.shlex 方法)

push_token() (shlex.shlex 方法)

push_with_producer() (asynchat.async_chat 方法)

pushbutton() (msilib.Dialog 方法)

put() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(multiprocessing.SimpleQueue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

put_nowait() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

putch() (在 msvcrt 模块中)

putenv() (在 os 模块中)

putheader() (http.client.HTTPConnection 方法)

putp() (在 curses 模块中)

putrequest() (http.client.HTTPConnection 方法)

putwch() (在 msvcrt 模块中)

putwin() (curses.window 方法)

pvariance() (在 statistics 模块中)

pwd

模块, [1]

pwd() (ftplib.FTP 方法)

pwrite() (在 os 模块中)

pwritev() (在 os 模块中)

Py_ABS (C macro)

Py_AddPendingCall (C function)

Py_AddPendingCall()

Py_AtExit (C function)

PY_AUDIT_READ

Py_BEGIN_ALLOW_THREADS

(C macro)

Py_BLOCK_THREADS (C macro)

Py_buffer (C type)

Py_buffer.buf (C member)

Py_buffer.format (C member)

Py_buffer.internal (C member)

Py_buffer.itemsize (C member)

Py_buffer.len (C member)

Py_buffer.ndim (C member)

Py_buffer.obj (C member)

Py_buffer.readonly (C member)

Py_buffer.shape (C member)

Py_buffer.strides (C member)

Py_buffer.suboffsets (C member)

Py_BuildValue (C function)

Py_BytesMain (C function)

Py_BytesWarningFlag (C var)

Py_CHARMASK (C macro)

Py_CLEAR (C function)

py_compile

模块

PY_COMPILED() (在 imp 模块中)

Py_CompileString (C function)

Py_CompileString(), [1], [2]

Py_CompileStringExFlags (C function)

Py_CompileStringFlags (C function)

Py_CompileStringObject (C function)

Py_complex (C type)

Py_DebugFlag (C var)

Py_DecodeLocale (C function)

Py_DECREF (C function)

Py_DecRef (C function)

Py_DECREF()

Py_DEPRECATED (C macro)

Py_DontWriteBytecodeFlag (C var)

Py_Ellipsis (C var)

Py_EncodeLocale (C function)

Py_END_ALLOW_THREADS

(C macro)

Py_EndInterpreter (C function)

Py_EnterRecursiveCall (C function)

Py_eval_input (C var)

Py_Exit (C function)

Py_False (C var)

Py_FatalError (C function)

Py_FatalError()

Py_FdIsInteractive (C function)

Py_file_input (C var)

Py_Finalize (C function)

Py_FinalizeEx (C function)

Py_FinalizeEx(), [1], [2], [3], [4]

PY_FROZEN() (在 imp 模块中)

Py_FrozenFlag (C var)

Py_GenericAlias (C function)

Py_GenericAliasType (C var)

Py_GetArgcArgv (C function)

Py_GetBuildInfo (C function)

Py_GetCompiler (C function)

Py_GetCopyright (C function)

Py_GETENV (C macro)

Py_GetExecPrefix (C function)

Py_GetExecPrefix()

Py_GetPath (C function)

Py_GetPath(), [1], [2]

Py_GetPlatform (C function)

Py_GetPrefix (C function)

Py_GetPrefix()

Py_GetProgramFullPath (C function)

Py_GetProgramFullPath()

Py_GetProgramName (C function)

Py_GetPythonHome (C function)

Py_GetVersion (C function)

Py_HashRandomizationFlag (C var)

Py_IgnoreEnvironmentFlag (C var)

Py_INCREF (C function)

Py_IncRef (C function)

Py_INCREF()

Py_Initialize (C function)

Py_Initialize(), [1], [2], [3]

Py_InitializeEx (C function)

Py_InitializeFromConfig (C function)

Py_InspectFlag (C var)

Py_InteractiveFlag (C var)

Py_Is (C function)

Py_IS_TYPE (C function)

Py_IsFalse (C function)

Py_IsInitialized (C function)

Py_IsInitialized()

Py_IsNone (C function)

Py_IsolatedFlag (C var)

Py_IsTrue (C function)

Py_LeaveRecursiveCall (C function)

Py_LegacyWindowsFSEncodingFlag (C var)

Py_LegacyWindowsStdioFlag (C var)

Py_LIMITED_API (C macro)

Py_Main (C function)

PY_MAJOR_VERSION (C macro)

Py_MAX (C macro)

Py_MEMBER_SIZE (C macro)

PY_MICRO_VERSION (C macro)

Py_MIN (C macro)

PY_MINOR_VERSION (C macro)

Py_mod_create (C macro)

Py_mod_create.create_module (C function)

Py_mod_exec (C macro)

Py_mod_exec.exec_module (C function)

Py_NewInterpreter (C function)

Py_NewRef (C function)

Py_None (C var)

Py_NoSiteFlag (C var)

Py_NotImplemented (C var)

Py_NoUserSiteDirectory (C var)

py_object (ctypes 中的类)

Py_OptimizeFlag (C var)

Py_PreInitialize (C function)

Py_PreInitializeFromArgs (C function)

Py_PreInitializeFromBytesArgs (C function)

Py_PRINT_RAW

PY_PYTHON

Py_QuietFlag (C var)

Py_REFCNT (C function)

PY_RELEASE_LEVEL (C macro)

PY_RELEASE_SERIAL (C macro)

Py_ReprEnter (C function)

Py_ReprLeave (C function)

Py_RETURN_FALSE (C macro)

Py_RETURN_NONE (C macro)

Py_RETURN_NOTIMPLEMENTED (C macro)

Py_RETURN_TRUE (C macro)

Py_RunMain (C function)

Py_SET_REFCNT (C function)

Py_SET_SIZE (C function)

Py_SET_TYPE (C function)

Py_SetPath (C function)

Py_SetPath()

Py_SetProgramName (C function)

Py_SetProgramName(), [1], [2], [3]

Py_SetPythonHome (C function)

Py_SetStandardStreamEncoding (C function)

Py_single_input (C var)

Py_SIZE (C function)

PY_SOURCE() (在 imp 模块中)

Py_ssize_t (C type)

PY_SSIZE_T_MAX

Py_STRINGIFY (C macro)

Py_TPFLAGS_BASE_EXC_SUBCLASS (內置变量)

Py_TPFLAGS_BASETYPE (內置变量)

Py_TPFLAGS_BYTES_SUBCLASS (內置变量)

Py_TPFLAGS_DEFAULT (內置变量)

Py_TPFLAGS_DICT_SUBCLASS (內置变量)

Py_TPFLAGS_DISALLOW_INSTANTIATION (內置变量)

Py_TPFLAGS_HAVE_FINALIZE (內置变量)

Py_TPFLAGS_HAVE_GC (內置变量)

Py_TPFLAGS_HAVE_VECTORCALL (內置变量)

Py_TPFLAGS_HEAPTYPE (內置变量)

Py_TPFLAGS_IMMUTABLETYPE (內置变量)

Py_TPFLAGS_LIST_SUBCLASS (內置变量)

Py_TPFLAGS_LONG_SUBCLASS (內置变量)

Py_TPFLAGS_MAPPING (內置变量)

Py_TPFLAGS_METHOD_DESCRIPTOR (內置变量)

Py_TPFLAGS_READY (內置变量)

Py_TPFLAGS_READYING (內置变量)

Py_TPFLAGS_SEQUENCE (內置变量)

Py_TPFLAGS_TUPLE_SUBCLASS (內置变量)

Py_TPFLAGS_TYPE_SUBCLASS (內置变量)

Py_TPFLAGS_UNICODE_SUBCLASS (內置变量)

Py_tracefunc (C type)

Py_True (C var)

Py_tss_NEEDS_INIT (C macro)

Py_tss_t (C type)

Py_TYPE (C function)

Py_UCS1 (C type)

Py_UCS2 (C type)

Py_UCS4 (C type)

Py_UNBLOCK_THREADS (C macro)

Py_UnbufferedStdioFlag (C var)

Py_UNICODE (C type)

Py_UNICODE_IS_HIGH_SURROGATE (C macro)

Py_UNICODE_IS_LOW_SURROGATE (C macro)

Py_UNICODE_IS_SURROGATE (C macro)

Py_UNICODE_ISALNUM (C function)

Py_UNICODE_ISALPHA (C function)

Py_UNICODE_ISDECIMAL (C function)

Py_UNICODE_ISDIGIT (C function)

Py_UNICODE_ISLINEBREAK (C function)

Py_UNICODE_ISLOWER (C function)

Py_UNICODE_ISNUMERIC (C function)

Py_UNICODE_ISPRINTABLE (C function)

Py_UNICODE_ISSPACE (C function)

Py_UNICODE_ISTITLE (C function)

Py_UNICODE_ISUPPER (C function)

Py_UNICODE_JOIN_SURROGATES (C macro)

Py_UNICODE_TODECIMAL (C function)

Py_UNICODE_TODIGIT (C function)

Py_UNICODE_TOLOWER (C function)

Py_UNICODE_TONUMERIC (C function)

Py_UNICODE_TOTITLE (C function)

Py_UNICODE_TOUPPER (C function)

Py_UNREACHABLE (C macro)

Py_UNUSED (C macro)

Py_VaBuildValue (C function)

PY_VECTORCALL_ARGUMENTS_OFFSET (C macro)

Py_VerboseFlag (C var)

PY_VERSION_HEX (C macro)

Py_VISIT (C function)

Py_XDECREF (C function)

Py_XDECREF()

Py_XINCREF (C function)

Py_XNewRef (C function)

PyAIter_Check (C function)

PyAnySet_Check (C function)

PyAnySet_CheckExact (C function)

PyArg_Parse (C function)

PyArg_ParseTuple (C function)

PyArg_ParseTuple()

PyArg_ParseTupleAndKeywords (C function)

PyArg_ParseTupleAndKeywords()

PyArg_UnpackTuple (C function)

PyArg_ValidateKeywordArguments (C function)

PyArg_VaParse (C function)

PyArg_VaParseTupleAndKeywords (C function)

PyASCIIObject (C type)

PyAsyncMethods (C type)

PyAsyncMethods.am_aiter (C member)

PyAsyncMethods.am_anext (C member)

PyAsyncMethods.am_await (C member)

PyAsyncMethods.am_send (C member)

PyBool_Check (C function)

PyBool_FromLong (C function)

PyBUF_ANY_CONTIGUOUS (C macro)

PyBUF_C_CONTIGUOUS (C macro)

PyBUF_CONTIG (C macro)

PyBUF_CONTIG_RO (C macro)

PyBUF_F_CONTIGUOUS (C macro)

PyBUF_FORMAT (C macro)

PyBUF_FULL (C macro)

PyBUF_FULL_RO (C macro)

PyBUF_INDIRECT (C macro)

PyBUF_ND (C macro)

PyBUF_RECORDS (C macro)

PyBUF_RECORDS_RO (C macro)

PyBUF_SIMPLE (C macro)

PyBUF_STRIDED (C macro)

PyBUF_STRIDED_RO (C macro)

PyBUF_STRIDES (C macro)

PyBUF_WRITABLE (C macro)

PyBuffer_FillContiguousStrides (C function)

PyBuffer_FillInfo (C function)

PyBuffer_FromContiguous (C function)

PyBuffer_GetPointer (C function)

PyBuffer_IsContiguous (C function)

PyBuffer_Release (C function)

PyBuffer_SizeFromFormat (C function)

PyBuffer_ToContiguous (C function)

PyBufferProcs

(C type)

PyBufferProcs.bf_getbuffer (C member)

PyBufferProcs.bf_releasebuffer (C member)

PyByteArray_AS_STRING (C function)

PyByteArray_AsString (C function)

PyByteArray_Check (C function)

PyByteArray_CheckExact (C function)

PyByteArray_Concat (C function)

PyByteArray_FromObject (C function)

PyByteArray_FromStringAndSize (C function)

PyByteArray_GET_SIZE (C function)

PyByteArray_Resize (C function)

PyByteArray_Size (C function)

PyByteArray_Type (C var)

PyByteArrayObject (C type)

PyBytes_AS_STRING (C function)

PyBytes_AsString (C function)

PyBytes_AsStringAndSize (C function)

PyBytes_Check (C function)

PyBytes_CheckExact (C function)

PyBytes_Concat (C function)

PyBytes_ConcatAndDel (C function)

PyBytes_FromFormat (C function)

PyBytes_FromFormatV (C function)

PyBytes_FromObject (C function)

PyBytes_FromString (C function)

PyBytes_FromStringAndSize (C function)

PyBytes_GET_SIZE (C function)

PyBytes_Size (C function)

PyBytes_Type (C var)

PyBytesObject (C type)

pycache_prefix() (在 sys 模块中)

PyCallable_Check (C function)

PyCallIter_Check (C function)

PyCallIter_New (C function)

PyCallIter_Type (C var)

PyCapsule (C type)

PyCapsule_CheckExact (C function)

PyCapsule_Destructor (C type)

PyCapsule_GetContext (C function)

PyCapsule_GetDestructor (C function)

PyCapsule_GetName (C function)

PyCapsule_GetPointer (C function)

PyCapsule_Import (C function)

PyCapsule_IsValid (C function)

PyCapsule_New (C function)

PyCapsule_SetContext (C function)

PyCapsule_SetDestructor (C function)

PyCapsule_SetName (C function)

PyCapsule_SetPointer (C function)

PyCell_Check (C function)

PyCell_GET (C function)

PyCell_Get (C function)

PyCell_New (C function)

PyCell_SET (C function)

PyCell_Set (C function)

PyCell_Type (C var)

PyCellObject (C type)

PyCF_ALLOW_TOP_LEVEL_AWAIT() (在 ast 模块中)

PyCF_ONLY_AST() (在 ast 模块中)

PyCF_TYPE_COMMENTS() (在 ast 模块中)

PyCFunction (C type)

PyCFunctionWithKeywords (C type)

PycInvalidationMode (py_compile 中的类)

pyclbr

模块

PyCMethod (C type)

PyCode_Addr2Line (C function)

PyCode_Check (C function)

PyCode_GetNumFree (C function)

PyCode_New (C function)

PyCode_NewEmpty (C function)

PyCode_NewWithPosOnlyArgs (C function)

PyCode_Type (C var)

PyCodec_BackslashReplaceErrors (C function)

PyCodec_Decode (C function)

PyCodec_Decoder (C function)

PyCodec_Encode (C function)

PyCodec_Encoder (C function)

PyCodec_IgnoreErrors (C function)

PyCodec_IncrementalDecoder (C function)

PyCodec_IncrementalEncoder (C function)

PyCodec_KnownEncoding (C function)

PyCodec_LookupError (C function)

PyCodec_NameReplaceErrors (C function)

PyCodec_Register (C function)

PyCodec_RegisterError (C function)

PyCodec_ReplaceErrors (C function)

PyCodec_StreamReader (C function)

PyCodec_StreamWriter (C function)

PyCodec_StrictErrors (C function)

PyCodec_Unregister (C function)

PyCodec_XMLCharRefReplaceErrors (C function)

PyCodeObject (C type)

PyCompactUnicodeObject (C type)

PyCompileError

PyCompilerFlags (C struct)

PyCompilerFlags.cf_feature_version (C member)

PyCompilerFlags.cf_flags (C member)

PyComplex_AsCComplex (C function)

PyComplex_Check (C function)

PyComplex_CheckExact (C function)

PyComplex_FromCComplex (C function)

PyComplex_FromDoubles (C function)

PyComplex_ImagAsDouble (C function)

PyComplex_RealAsDouble (C function)

PyComplex_Type (C var)

PyComplexObject (C type)

PyConfig (C type)

PyConfig.argv (C member)

PyConfig.base_exec_prefix (C member)

PyConfig.base_executable (C member)

PyConfig.base_prefix (C member)

PyConfig.buffered_stdio (C member)

PyConfig.bytes_warning (C member)

PyConfig.check_hash_pycs_mode (C member)

PyConfig.configure_c_stdio (C member)

PyConfig.dev_mode (C member)

PyConfig.dump_refs (C member)

PyConfig.exec_prefix (C member)

PyConfig.executable (C member)

PyConfig.faulthandler (C member)

PyConfig.filesystem_encoding (C member)

PyConfig.filesystem_errors (C member)

PyConfig.hash_seed (C member)

PyConfig.home (C member)

PyConfig.import_time (C member)

PyConfig.inspect (C member)

PyConfig.install_signal_handlers (C member)

PyConfig.interactive (C member)

PyConfig.isolated (C member)

PyConfig.legacy_windows_stdio (C member)

PyConfig.malloc_stats (C member)

PyConfig.module_search_paths (C member)

PyConfig.module_search_paths_set (C member)

PyConfig.optimization_level (C member)

PyConfig.orig_argv (C member)

PyConfig.parse_argv (C member)

PyConfig.parser_debug (C member)

PyConfig.pathconfig_warnings (C member)

PyConfig.platlibdir (C member)

PyConfig.prefix (C member)

PyConfig.program_name (C member)

PyConfig.pycache_prefix (C member)

PyConfig.PyConfig_Clear (C function)

PyConfig.PyConfig_InitIsolatedConfig (C function)

PyConfig.PyConfig_InitPythonConfig (C function)

PyConfig.PyConfig_Read (C function)

PyConfig.PyConfig_SetArgv (C function)

PyConfig.PyConfig_SetBytesArgv (C function)

PyConfig.PyConfig_SetBytesString (C function)

PyConfig.PyConfig_SetString (C function)

PyConfig.PyConfig_SetWideStringList (C function)

PyConfig.pythonpath_env (C member)

PyConfig.quiet (C member)

PyConfig.run_command (C member)

PyConfig.run_filename (C member)

PyConfig.run_module (C member)

PyConfig.show_ref_count (C member)

PyConfig.site_import (C member)

PyConfig.skip_source_first_line (C member)

PyConfig.stdio_encoding (C member)

PyConfig.stdio_errors (C member)

PyConfig.tracemalloc (C member)

PyConfig.use_environment (C member)

PyConfig.use_hash_seed (C member)

PyConfig.user_site_directory (C member)

PyConfig.verbose (C member)

PyConfig.warn_default_encoding (C member)

PyConfig.warnoptions (C member)

PyConfig.write_bytecode (C member)

PyConfig.xoptions (C member)

PyContext (C type)

PyContext_CheckExact (C function)

PyContext_Copy (C function)

PyContext_CopyCurrent (C function)

PyContext_Enter (C function)

PyContext_Exit (C function)

PyContext_New (C function)

PyContext_Type (C var)

PyContextToken (C type)

PyContextToken_CheckExact (C function)

PyContextToken_Type (C var)

PyContextVar (C type)

PyContextVar_CheckExact (C function)

PyContextVar_Get (C function)

PyContextVar_New (C function)

PyContextVar_Reset (C function)

PyContextVar_Set (C function)

PyContextVar_Type (C var)

PyCoro_CheckExact (C function)

PyCoro_New (C function)

PyCoro_Type (C var)

PyCoroObject (C type)

PyDate_Check (C function)

PyDate_CheckExact (C function)

PyDate_FromDate (C function)

PyDate_FromTimestamp (C function)

PyDateTime_Check (C function)

PyDateTime_CheckExact (C function)

PyDateTime_DATE_GET_FOLD (C function)

PyDateTime_DATE_GET_HOUR (C function)

PyDateTime_DATE_GET_MICROSECOND (C function)

PyDateTime_DATE_GET_MINUTE (C function)

PyDateTime_DATE_GET_SECOND (C function)

PyDateTime_DATE_GET_TZINFO (C function)

PyDateTime_DELTA_GET_DAYS (C function)

PyDateTime_DELTA_GET_MICROSECONDS (C function)

PyDateTime_DELTA_GET_SECONDS (C function)

PyDateTime_FromDateAndTime (C function)

PyDateTime_FromDateAndTimeAndFold (C function)

PyDateTime_FromTimestamp (C function)

PyDateTime_GET_DAY (C function)

PyDateTime_GET_MONTH (C function)

PyDateTime_GET_YEAR (C function)

PyDateTime_TIME_GET_FOLD (C function)

PyDateTime_TIME_GET_HOUR (C function)

PyDateTime_TIME_GET_MICROSECOND (C function)

PyDateTime_TIME_GET_MINUTE (C function)

PyDateTime_TIME_GET_SECOND (C function)

PyDateTime_TIME_GET_TZINFO (C function)

PyDateTime_TimeZone_UTC (C var)

PyDelta_Check (C function)

PyDelta_CheckExact (C function)

PyDelta_FromDSU (C function)

PyDescr_IsData (C function)

PyDescr_NewClassMethod (C function)

PyDescr_NewGetSet (C function)

PyDescr_NewMember (C function)

PyDescr_NewMethod (C function)

PyDescr_NewWrapper (C function)

PyDict_Check (C function)

PyDict_CheckExact (C function)

PyDict_Clear (C function)

PyDict_Contains (C function)

PyDict_Copy (C function)

PyDict_DelItem (C function)

PyDict_DelItemString (C function)

PyDict_GetItem (C function)

PyDict_GetItemString (C function)

PyDict_GetItemWithError (C function)

PyDict_Items (C function)

PyDict_Keys (C function)

PyDict_Merge (C function)

PyDict_MergeFromSeq2 (C function)

PyDict_New (C function)

PyDict_Next (C function)

PyDict_SetDefault (C function)

PyDict_SetItem (C function)

PyDict_SetItemString (C function)

PyDict_Size (C function)

PyDict_Type (C var)

PyDict_Update (C function)

PyDict_Values (C function)

PyDictObject (C type)

PyDictProxy_New (C function)

PyDLL (ctypes 中的类)

pydoc

模块

PyDoc_STR (C macro)

PyDoc_STRVAR (C macro)

PyErr_BadArgument (C function)

PyErr_BadInternalCall (C function)

PyErr_CheckSignals (C function)

PyErr_Clear (C function)

PyErr_Clear(), [1]

PyErr_ExceptionMatches (C function)

PyErr_ExceptionMatches()

PyErr_Fetch (C function)

PyErr_Fetch()

PyErr_Format (C function)

PyErr_FormatV (C function)

PyErr_GetExcInfo (C function)

PyErr_GivenExceptionMatches (C function)

PyErr_NewException (C function)

PyErr_NewExceptionWithDoc (C function)

PyErr_NoMemory (C function)

PyErr_NormalizeException (C function)

PyErr_Occurred (C function)

PyErr_Occurred()

PyErr_Print (C function)

PyErr_PrintEx (C function)

PyErr_ResourceWarning (C function)

PyErr_Restore (C function)

PyErr_Restore()

PyErr_SetExcFromWindowsErr (C function)

PyErr_SetExcFromWindowsErrWithFilename (C function)

PyErr_SetExcFromWindowsErrWithFilenameObject (C function)

PyErr_SetExcFromWindowsErrWithFilenameObjects (C function)

PyErr_SetExcInfo (C function)

PyErr_SetFromErrno (C function)

PyErr_SetFromErrnoWithFilename (C function)

PyErr_SetFromErrnoWithFilenameObject (C function)

PyErr_SetFromErrnoWithFilenameObjects (C function)

PyErr_SetFromWindowsErr (C function)

PyErr_SetFromWindowsErrWithFilename (C function)

PyErr_SetImportError (C function)

PyErr_SetImportErrorSubclass (C function)

PyErr_SetInterrupt (C function)

PyErr_SetInterruptEx (C function)

PyErr_SetNone (C function)

PyErr_SetObject (C function)

PyErr_SetString (C function)

PyErr_SetString()

PyErr_SyntaxLocation (C function)

PyErr_SyntaxLocationEx (C function)

PyErr_SyntaxLocationObject (C function)

PyErr_WarnEx (C function)

PyErr_WarnExplicit (C function)

PyErr_WarnExplicitObject (C function)

PyErr_WarnFormat (C function)

PyErr_WriteUnraisable (C function)

PyEval_AcquireLock (C function)

PyEval_AcquireThread (C function)

PyEval_AcquireThread()

PyEval_EvalCode (C function)

PyEval_EvalCodeEx (C function)

PyEval_EvalFrame (C function)

PyEval_EvalFrameEx (C function)

PyEval_GetBuiltins (C function)

PyEval_GetFrame (C function)

PyEval_GetFuncDesc (C function)

PyEval_GetFuncName (C function)

PyEval_GetGlobals (C function)

PyEval_GetLocals (C function)

PyEval_InitThreads (C function)

PyEval_InitThreads()

PyEval_MergeCompilerFlags (C function)

PyEval_ReleaseLock (C function)

PyEval_ReleaseThread (C function)

PyEval_ReleaseThread()

PyEval_RestoreThread (C function)

PyEval_RestoreThread(), [1]

PyEval_SaveThread (C function)

PyEval_SaveThread(), [1]

PyEval_SetProfile (C function)

PyEval_SetTrace (C function)

PyEval_ThreadsInitialized (C function)

PyExc_ArithmeticError

PyExc_AssertionError

PyExc_AttributeError

PyExc_BaseException

PyExc_BlockingIOError

PyExc_BrokenPipeError

PyExc_BufferError

PyExc_BytesWarning

PyExc_ChildProcessError

PyExc_ConnectionAbortedError

PyExc_ConnectionError

PyExc_ConnectionRefusedError

PyExc_ConnectionResetError

PyExc_DeprecationWarning

PyExc_EnvironmentError

PyExc_EOFError

PyExc_Exception

PyExc_FileExistsError

PyExc_FileNotFoundError

PyExc_FloatingPointError

PyExc_FutureWarning

PyExc_GeneratorExit

PyExc_ImportError

PyExc_ImportWarning

PyExc_IndentationError

PyExc_IndexError

PyExc_InterruptedError

PyExc_IOError

PyExc_IsADirectoryError

PyExc_KeyboardInterrupt

PyExc_KeyError

PyExc_LookupError

PyExc_MemoryError

PyExc_ModuleNotFoundError

PyExc_NameError

PyExc_NotADirectoryError

PyExc_NotImplementedError

PyExc_OSError

PyExc_OverflowError

PyExc_PendingDeprecationWarning

PyExc_PermissionError

PyExc_ProcessLookupError

PyExc_RecursionError

PyExc_ReferenceError

PyExc_ResourceWarning

PyExc_RuntimeError

PyExc_RuntimeWarning

PyExc_StopAsyncIteration

PyExc_StopIteration

PyExc_SyntaxError

PyExc_SyntaxWarning

PyExc_SystemError

PyExc_SystemExit

PyExc_TabError

PyExc_TimeoutError

PyExc_TypeError

PyExc_UnboundLocalError

PyExc_UnicodeDecodeError

PyExc_UnicodeEncodeError

PyExc_UnicodeError

PyExc_UnicodeTranslateError

PyExc_UnicodeWarning

PyExc_UserWarning

PyExc_ValueError

PyExc_Warning

PyExc_WindowsError

PyExc_ZeroDivisionError

PyException_GetCause (C function)

PyException_GetContext (C function)

PyException_GetTraceback (C function)

PyException_SetCause (C function)

PyException_SetContext (C function)

PyException_SetTraceback (C function)

pyexpat

模块

PyFile_FromFd (C function)

PyFile_GetLine (C function)

PyFile_SetOpenCodeHook (C function)

PyFile_WriteObject (C function)

PyFile_WriteString (C function)

PyFloat_AS_DOUBLE (C function)

PyFloat_AsDouble (C function)

PyFloat_Check (C function)

PyFloat_CheckExact (C function)

PyFloat_FromDouble (C function)

PyFloat_FromString (C function)

PyFloat_GetInfo (C function)

PyFloat_GetMax (C function)

PyFloat_GetMin (C function)

PyFloat_Type (C var)

PyFloatObject (C type)

PyFrame_GetBack (C function)

PyFrame_GetCode (C function)

PyFrame_GetLineNumber (C function)

PyFrameObject (C type)

PyFrozenSet_Check (C function)

PyFrozenSet_CheckExact (C function)

PyFrozenSet_New (C function)

PyFrozenSet_Type (C var)

PyFunction_Check (C function)

PyFunction_GetAnnotations (C function)

PyFunction_GetClosure (C function)

PyFunction_GetCode (C function)

PyFunction_GetDefaults (C function)

PyFunction_GetGlobals (C function)

PyFunction_GetModule (C function)

PyFunction_New (C function)

PyFunction_NewWithQualName (C function)

PyFunction_SetAnnotations (C function)

PyFunction_SetClosure (C function)

PyFunction_SetDefaults (C function)

PyFunction_Type (C var)

PyFunctionObject (C type)

PYFUNCTYPE() (在 ctypes 模块中)

PyGC_Collect (C function)

PyGC_Disable (C function)

PyGC_Enable (C function)

PyGC_IsEnabled (C function)

PyGen_Check (C function)

PyGen_CheckExact (C function)

PyGen_New (C function)

PyGen_NewWithQualName (C function)

PyGen_Type (C var)

PyGenObject (C type)

PyGetSetDef (C type)

PyGILState_Check (C function)

PyGILState_Ensure (C function)

PyGILState_GetThisThreadState (C function)

PyGILState_Release (C function)

PyImport_AddModule (C function)

PyImport_AddModuleObject (C function)

PyImport_AppendInittab (C function)

PyImport_ExecCodeModule (C function)

PyImport_ExecCodeModuleEx (C function)

PyImport_ExecCodeModuleObject (C function)

PyImport_ExecCodeModuleWithPathnames (C function)

PyImport_ExtendInittab (C function)

PyImport_FrozenModules (C var)

PyImport_GetImporter (C function)

PyImport_GetMagicNumber (C function)

PyImport_GetMagicTag (C function)

PyImport_GetModule (C function)

PyImport_GetModuleDict (C function)

PyImport_Import (C function)

PyImport_ImportFrozenModule (C function)

PyImport_ImportFrozenModuleObject (C function)

PyImport_ImportModule (C function)

PyImport_ImportModuleEx (C function)

PyImport_ImportModuleLevel (C function)

PyImport_ImportModuleLevelObject (C function)

PyImport_ImportModuleNoBlock (C function)

PyImport_ReloadModule (C function)

PyIndex_Check (C function)

PyInit_modulename (C function)

PyInstanceMethod_Check (C function)

PyInstanceMethod_Function (C function)

PyInstanceMethod_GET_FUNCTION (C function)

PyInstanceMethod_New (C function)

PyInstanceMethod_Type (C var)

PyInterpreterState (C type)

PyInterpreterState_Clear (C function)

PyInterpreterState_Delete (C function)

PyInterpreterState_Get (C function)

PyInterpreterState_GetDict (C function)

PyInterpreterState_GetID (C function)

PyInterpreterState_Head (C function)

PyInterpreterState_Main (C function)

PyInterpreterState_New (C function)

PyInterpreterState_Next (C function)

PyInterpreterState_ThreadHead (C function)

PyIter_Check (C function)

PyIter_Next (C function)

PyIter_Send (C function)

PyList_Append (C function)

PyList_AsTuple (C function)

PyList_Check (C function)

PyList_CheckExact (C function)

PyList_GET_ITEM (C function)

PyList_GET_SIZE (C function)

PyList_GetItem (C function)

PyList_GetItem()

PyList_GetSlice (C function)

PyList_Insert (C function)

PyList_New (C function)

PyList_Reverse (C function)

PyList_SET_ITEM (C function)

PyList_SetItem (C function)

PyList_SetItem()

PyList_SetSlice (C function)

PyList_Size (C function)

PyList_Sort (C function)

PyList_Type (C var)

PyListObject (C type)

PyLong_AsDouble (C function)

PyLong_AsLong (C function)

PyLong_AsLongAndOverflow (C function)

PyLong_AsLongLong (C function)

PyLong_AsLongLongAndOverflow (C function)

PyLong_AsSize_t (C function)

PyLong_AsSsize_t (C function)

PyLong_AsUnsignedLong (C function)

PyLong_AsUnsignedLongLong (C function)

PyLong_AsUnsignedLongLongMask (C function)

PyLong_AsUnsignedLongMask (C function)

PyLong_AsVoidPtr (C function)

PyLong_Check (C function)

PyLong_CheckExact (C function)

PyLong_FromDouble (C function)

PyLong_FromLong (C function)

PyLong_FromLongLong (C function)

PyLong_FromSize_t (C function)

PyLong_FromSsize_t (C function)

PyLong_FromString (C function)

PyLong_FromUnicodeObject (C function)

PyLong_FromUnsignedLong (C function)

PyLong_FromUnsignedLongLong (C function)

PyLong_FromVoidPtr (C function)

PyLong_Type (C var)

PyLongObject (C type)

PyMapping_Check (C function)

PyMapping_DelItem (C function)

PyMapping_DelItemString (C function)

PyMapping_GetItemString (C function)

PyMapping_HasKey (C function)

PyMapping_HasKeyString (C function)

PyMapping_Items (C function)

PyMapping_Keys (C function)

PyMapping_Length (C function)

PyMapping_SetItemString (C function)

PyMapping_Size (C function)

PyMapping_Values (C function)

PyMappingMethods (C type)

PyMappingMethods.mp_ass_subscript (C member)

PyMappingMethods.mp_length (C member)

PyMappingMethods.mp_subscript (C member)

PyMarshal_ReadLastObjectFromFile (C function)

PyMarshal_ReadLongFromFile (C function)

PyMarshal_ReadObjectFromFile (C function)

PyMarshal_ReadObjectFromString (C function)

PyMarshal_ReadShortFromFile (C function)

PyMarshal_WriteLongToFile (C function)

PyMarshal_WriteObjectToFile (C function)

PyMarshal_WriteObjectToString (C function)

PyMem_Calloc (C function)

PyMem_Del (C function)

PyMem_Free (C function)

PyMem_GetAllocator (C function)

PyMem_Malloc (C function)

PyMem_New (C function)

PyMem_RawCalloc (C function)

PyMem_RawFree (C function)

PyMem_RawMalloc (C function)

PyMem_RawRealloc (C function)

PyMem_Realloc (C function)

PyMem_Resize (C function)

PyMem_SetAllocator (C function)

PyMem_SetupDebugHooks (C function)

PyMemAllocatorDomain (C type)

PyMemAllocatorDomain.PYMEM_DOMAIN_MEM (C macro)

PyMemAllocatorDomain.PYMEM_DOMAIN_OBJ (C macro)

PyMemAllocatorDomain.PYMEM_DOMAIN_RAW (C macro)

PyMemAllocatorEx (C type)

PyMember_GetOne (C function)

PyMember_SetOne (C function)

PyMemberDef (C type)

PyMemoryView_Check (C function)

PyMemoryView_FromBuffer (C function)

PyMemoryView_FromMemory (C function)

PyMemoryView_FromObject (C function)

PyMemoryView_GET_BASE (C function)

PyMemoryView_GET_BUFFER (C function)

PyMemoryView_GetContiguous (C function)

PyMethod_Check (C function)

PyMethod_Function (C function)

PyMethod_GET_FUNCTION (C function)

PyMethod_GET_SELF (C function)

PyMethod_New (C function)

PyMethod_Self (C function)

PyMethod_Type (C var)

PyMethodDef (C type)

PyMethodDef.ml_doc (C member)

PyMethodDef.ml_flags (C member)

PyMethodDef.ml_meth (C member)

PyMethodDef.ml_name (C member)

PyModule_AddFunctions (C function)

PyModule_AddIntConstant (C function)

PyModule_AddIntMacro (C function)

PyModule_AddObject (C function)

PyModule_AddObjectRef (C function)

PyModule_AddStringConstant (C function)

PyModule_AddStringMacro (C function)

PyModule_AddType (C function)

PyModule_Check (C function)

PyModule_CheckExact (C function)

PyModule_Create (C function)

PyModule_Create2 (C function)

PyModule_ExecDef (C function)

PyModule_FromDefAndSpec (C function)

PyModule_FromDefAndSpec2 (C function)

PyModule_GetDef (C function)

PyModule_GetDict (C function)

PyModule_GetFilename (C function)

PyModule_GetFilenameObject (C function)

PyModule_GetName (C function)

PyModule_GetNameObject (C function)

PyModule_GetState (C function)

PyModule_New (C function)

PyModule_NewObject (C function)

PyModule_SetDocString (C function)

PyModule_Type (C var)

PyModuleDef (C type)

PyModuleDef.m_base (C member)

PyModuleDef.m_clear (C member)

PyModuleDef.m_doc (C member)

PyModuleDef.m_free (C member)

PyModuleDef.m_methods (C member)

PyModuleDef.m_name (C member)

PyModuleDef.m_size (C member)

PyModuleDef.m_slots (C member)

PyModuleDef.m_slots.m_reload (C member)

PyModuleDef.m_traverse (C member)

PyModuleDef_Init (C function)

PyModuleDef_Slot (C type)

PyModuleDef_Slot.slot (C member)

PyModuleDef_Slot.value (C member)

PyNumber_Absolute (C function)

PyNumber_Add (C function)

PyNumber_And (C function)

PyNumber_AsSsize_t (C function)

PyNumber_Check (C function)

PyNumber_Divmod (C function)

PyNumber_Float (C function)

PyNumber_FloorDivide (C function)

PyNumber_Index (C function)

PyNumber_InPlaceAdd (C function)

PyNumber_InPlaceAnd (C function)

PyNumber_InPlaceFloorDivide (C function)

PyNumber_InPlaceLshift (C function)

PyNumber_InPlaceMatrixMultiply (C function)

PyNumber_InPlaceMultiply (C function)

PyNumber_InPlaceOr (C function)

PyNumber_InPlacePower (C function)

PyNumber_InPlaceRemainder (C function)

PyNumber_InPlaceRshift (C function)

PyNumber_InPlaceSubtract (C function)

PyNumber_InPlaceTrueDivide (C function)

PyNumber_InPlaceXor (C function)

PyNumber_Invert (C function)

PyNumber_Long (C function)

PyNumber_Lshift (C function)

PyNumber_MatrixMultiply (C function)

PyNumber_Multiply (C function)

PyNumber_Negative (C function)

PyNumber_Or (C function)

PyNumber_Positive (C function)

PyNumber_Power (C function)

PyNumber_Remainder (C function)

PyNumber_Rshift (C function)

PyNumber_Subtract (C function)

PyNumber_ToBase (C function)

PyNumber_TrueDivide (C function)

PyNumber_Xor (C function)

PyNumberMethods (C type)

PyNumberMethods.nb_absolute (C member)

PyNumberMethods.nb_add (C member)

PyNumberMethods.nb_and (C member)

PyNumberMethods.nb_bool (C member)

PyNumberMethods.nb_divmod (C member)

PyNumberMethods.nb_float (C member)

PyNumberMethods.nb_floor_divide (C member)

PyNumberMethods.nb_index (C member)

PyNumberMethods.nb_inplace_add (C member)

PyNumberMethods.nb_inplace_and (C member)

PyNumberMethods.nb_inplace_floor_divide (C member)

PyNumberMethods.nb_inplace_lshift (C member)

PyNumberMethods.nb_inplace_matrix_multiply (C member)

PyNumberMethods.nb_inplace_multiply (C member)

PyNumberMethods.nb_inplace_or (C member)

PyNumberMethods.nb_inplace_power (C member)

PyNumberMethods.nb_inplace_remainder (C member)

PyNumberMethods.nb_inplace_rshift (C member)

PyNumberMethods.nb_inplace_subtract (C member)

PyNumberMethods.nb_inplace_true_divide (C member)

PyNumberMethods.nb_inplace_xor (C member)

PyNumberMethods.nb_int (C member)

PyNumberMethods.nb_invert (C member)

PyNumberMethods.nb_lshift (C member)

PyNumberMethods.nb_matrix_multiply (C member)

PyNumberMethods.nb_multiply (C member)

PyNumberMethods.nb_negative (C member)

PyNumberMethods.nb_or (C member)

PyNumberMethods.nb_positive (C member)

PyNumberMethods.nb_power (C member)

PyNumberMethods.nb_remainder (C member)

PyNumberMethods.nb_reserved (C member)

PyNumberMethods.nb_rshift (C member)

PyNumberMethods.nb_subtract (C member)

PyNumberMethods.nb_true_divide (C member)

PyNumberMethods.nb_xor (C member)

PyObject (C type)

PyObject._ob_next (C member)

PyObject._ob_prev (C member)

PyObject.ob_refcnt (C member)

PyObject.ob_type (C member)

PyObject_AsCharBuffer (C function)

PyObject_ASCII (C function)

PyObject_AsFileDescriptor (C function)

PyObject_AsReadBuffer (C function)

PyObject_AsWriteBuffer (C function)

PyObject_Bytes (C function)

PyObject_Call (C function)

PyObject_CallFunction (C function)

PyObject_CallFunctionObjArgs (C function)

PyObject_CallMethod (C function)

PyObject_CallMethodNoArgs (C function)

PyObject_CallMethodObjArgs (C function)

PyObject_CallMethodOneArg (C function)

PyObject_CallNoArgs (C function)

PyObject_CallObject (C function)

PyObject_CallObject()

PyObject_Calloc (C function)

PyObject_CallOneArg (C function)

PyObject_CheckBuffer (C function)

PyObject_CheckReadBuffer (C function)

PyObject_ClearWeakRefs (C function)

PyObject_Del (C function)

PyObject_DelAttr (C function)

PyObject_DelAttrString (C function)

PyObject_DelItem (C function)

PyObject_Dir (C function)

PyObject_Format (C function)

PyObject_Free (C function)

PyObject_GC_Del (C function)

PyObject_GC_IsFinalized (C function)

PyObject_GC_IsTracked (C function)

PyObject_GC_New (C function)

PyObject_GC_NewVar (C function)

PyObject_GC_Resize (C function)

PyObject_GC_Track (C function)

PyObject_GC_UnTrack (C function)

PyObject_GenericGetAttr (C function)

PyObject_GenericGetDict (C function)

PyObject_GenericSetAttr (C function)

PyObject_GenericSetDict (C function)

PyObject_GetAIter (C function)

PyObject_GetArenaAllocator (C function)

PyObject_GetAttr (C function)

PyObject_GetAttrString (C function)

PyObject_GetBuffer (C function)

PyObject_GetItem (C function)

PyObject_GetIter (C function)

PyObject_HasAttr (C function)

PyObject_HasAttrString (C function)

PyObject_Hash (C function)

PyObject_HashNotImplemented (C function)

PyObject_HEAD (C macro)

PyObject_HEAD_INIT (C macro)

PyObject_Init (C function)

PyObject_InitVar (C function)

PyObject_IS_GC (C function)

PyObject_IsInstance (C function)

PyObject_IsSubclass (C function)

PyObject_IsTrue (C function)

PyObject_Length (C function)

PyObject_LengthHint (C function)

PyObject_Malloc (C function)

PyObject_New (C function)

PyObject_NewVar (C function)

PyObject_Not (C function)

PyObject_Print (C function)

PyObject_Realloc (C function)

PyObject_Repr (C function)

PyObject_RichCompare (C function)

PyObject_RichCompareBool (C function)

PyObject_SetArenaAllocator (C function)

PyObject_SetAttr (C function)

PyObject_SetAttrString (C function)

PyObject_SetItem (C function)

PyObject_Size (C function)

PyObject_Str (C function)

PyObject_Type (C function)

PyObject_TypeCheck (C function)

PyObject_VAR_HEAD (C macro)

PyObject_Vectorcall (C function)

PyObject_VectorcallDict (C function)

PyObject_VectorcallMethod (C function)

PyObjectArenaAllocator (C type)

PyOS_AfterFork (C function)

PyOS_AfterFork_Child (C function)

PyOS_AfterFork_Parent (C function)

PyOS_BeforeFork (C function)

PyOS_CheckStack (C function)

PyOS_double_to_string (C function)

PyOS_FSPath (C function)

PyOS_getsig (C function)

PyOS_InputHook (C var)

PyOS_ReadlineFunctionPointer (C var)

PyOS_setsig (C function)

PyOS_snprintf (C function)

PyOS_stricmp (C function)

PyOS_string_to_double (C function)

PyOS_strnicmp (C function)

PyOS_vsnprintf (C function)

PyPI

(see Python Package Index (PyPI))

PyPreConfig (C type)

PyPreConfig.allocator (C member)

PyPreConfig.coerce_c_locale (C member)

PyPreConfig.coerce_c_locale_warn (C member)

PyPreConfig.configure_locale (C member)

PyPreConfig.dev_mode (C member)

PyPreConfig.isolated (C member)

PyPreConfig.legacy_windows_fs_encoding (C member)

PyPreConfig.parse_argv (C member)

PyPreConfig.PyPreConfig_InitIsolatedConfig (C function)

PyPreConfig.PyPreConfig_InitPythonConfig (C function)

PyPreConfig.use_environment (C member)

PyPreConfig.utf8_mode (C member)

PyProperty_Type (C var)

PyRun_AnyFile (C function)

PyRun_AnyFileEx (C function)

PyRun_AnyFileExFlags (C function)

PyRun_AnyFileFlags (C function)

PyRun_File (C function)

PyRun_FileEx (C function)

PyRun_FileExFlags (C function)

PyRun_FileFlags (C function)

PyRun_InteractiveLoop (C function)

PyRun_InteractiveLoopFlags (C function)

PyRun_InteractiveOne (C function)

PyRun_InteractiveOneFlags (C function)

PyRun_SimpleFile (C function)

PyRun_SimpleFileEx (C function)

PyRun_SimpleFileExFlags (C function)

PyRun_SimpleString (C function)

PyRun_SimpleStringFlags (C function)

PyRun_String (C function)

PyRun_StringFlags (C function)

PySendResult (C type)

PySeqIter_Check (C function)

PySeqIter_New (C function)

PySeqIter_Type (C var)

PySequence_Check (C function)

PySequence_Concat (C function)

PySequence_Contains (C function)

PySequence_Count (C function)

PySequence_DelItem (C function)

PySequence_DelSlice (C function)

PySequence_Fast (C function)

PySequence_Fast_GET_ITEM (C function)

PySequence_Fast_GET_SIZE (C function)

PySequence_Fast_ITEMS (C function)

PySequence_GetItem (C function)

PySequence_GetItem()

PySequence_GetSlice (C function)

PySequence_Index (C function)

PySequence_InPlaceConcat (C function)

PySequence_InPlaceRepeat (C function)

PySequence_ITEM (C function)

PySequence_Length (C function)

PySequence_List (C function)

PySequence_Repeat (C function)

PySequence_SetItem (C function)

PySequence_SetSlice (C function)

PySequence_Size (C function)

PySequence_Tuple (C function)

PySequenceMethods (C type)

PySequenceMethods.sq_ass_item (C member)

PySequenceMethods.sq_concat (C member)

PySequenceMethods.sq_contains (C member)

PySequenceMethods.sq_inplace_concat (C member)

PySequenceMethods.sq_inplace_repeat (C member)

PySequenceMethods.sq_item (C member)

PySequenceMethods.sq_length (C member)

PySequenceMethods.sq_repeat (C member)

PySet_Add (C function)

PySet_Check (C function)

PySet_CheckExact (C function)

PySet_Clear (C function)

PySet_Contains (C function)

PySet_Discard (C function)

PySet_GET_SIZE (C function)

PySet_New (C function)

PySet_Pop (C function)

PySet_Size (C function)

PySet_Type (C var)

PySetObject (C type)

PySignal_SetWakeupFd (C function)

PySlice_AdjustIndices (C function)

PySlice_Check (C function)

PySlice_GetIndices (C function)

PySlice_GetIndicesEx (C function)

PySlice_New (C function)

PySlice_Type (C var)

PySlice_Unpack (C function)

PyState_AddModule (C function)

PyState_FindModule (C function)

PyState_RemoveModule (C function)

PyStatus (C type)

PyStatus.err_msg (C member)

PyStatus.exitcode (C member)

PyStatus.func (C member)

PyStatus.Py_ExitStatusException (C function)

PyStatus.PyStatus_Error (C function)

PyStatus.PyStatus_Exception (C function)

PyStatus.PyStatus_Exit (C function)

PyStatus.PyStatus_IsError (C function)

PyStatus.PyStatus_IsExit (C function)

PyStatus.PyStatus_NoMemory (C function)

PyStatus.PyStatus_Ok (C function)

PyStructSequence_Desc (C type)

PyStructSequence_Field (C type)

PyStructSequence_GET_ITEM (C function)

PyStructSequence_GetItem (C function)

PyStructSequence_InitType (C function)

PyStructSequence_InitType2 (C function)

PyStructSequence_New (C function)

PyStructSequence_NewType (C function)

PyStructSequence_SET_ITEM (C function)

PyStructSequence_SetItem (C function)

PyStructSequence_UnnamedField (C var)

PySys_AddAuditHook (C function)

PySys_AddWarnOption (C function)

PySys_AddWarnOptionUnicode (C function)

PySys_AddXOption (C function)

PySys_Audit (C function)

PySys_FormatStderr (C function)

PySys_FormatStdout (C function)

PySys_GetObject (C function)

PySys_GetXOptions (C function)

PySys_ResetWarnOptions (C function)

PySys_SetArgv (C function)

PySys_SetArgv()

PySys_SetArgvEx (C function)

PySys_SetArgvEx(), [1]

PySys_SetObject (C function)

PySys_SetPath (C function)

PySys_WriteStderr (C function)

PySys_WriteStdout (C function)

Python 3000

Python Editor

Python Package Index (PyPI)

Python 提高建议

PEP 1, [1], [2]

PEP 100

PEP 11, [1], [2], [3], [4], [5]

PEP 201

PEP 205, [1]

PEP 207, [1]

PEP 208

PEP 217

PEP 218, [1], [2]

PEP 227, [1], [2]

PEP 229

PEP 230

PEP 232

PEP 234

PEP 235

PEP 236, [1], [2], [3]

PEP 237, [1], [2], [3], [4], [5]

PEP 238, [1], [2], [3], [4], [5], [6]

PEP 241, [1], [2]

PEP 243

PEP 246, [1]

PEP 247

PEP 249, [1], [2], [3], [4], [5], [6]

PEP 252, [1], [2]

PEP 253, [1], [2], [3], [4]

PEP 255, [1], [2], [3], [4], [5]

PEP 261, [1]

PEP 263, [1], [2], [3], [4], [5], [6]

PEP 264

PEP 273, [1], [2], [3]

PEP 274

PEP 277

PEP 278, [1]

PEP 279

PEP 282, [1], [2], [3], [4]

PEP 285, [1]

PEP 288

PEP 289, [1], [2]

PEP 292, [1]

PEP 293

PEP 3000

PEP 301, [1]

PEP 302, [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], [31], [32], [33], [34], [35], [36]

PEP 307, [1], [2], [3]

PEP 308, [1], [2]

PEP 309

PEP 3100

PEP 3101, [1], [2], [3], [4]

PEP 3102

PEP 3104, [1]

PEP 3105, [1], [2]

PEP 3106

PEP 3107, [1], [2], [3], [4]

PEP 3108, [1], [2]

PEP 3109, [1]

PEP 3110, [1], [2]

PEP 3111

PEP 3112, [1]

PEP 3113

PEP 3114

PEP 3115, [1], [2], [3], [4]

PEP 3116, [1], [2]

PEP 3118, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PEP 3119, [1], [2], [3], [4], [5]

PEP 3120, [1], [2]

PEP 3121, [1], [2]

PEP 3123

PEP 3127

PEP 3129, [1]

PEP 3131, [1], [2]

PEP 3132, [1]

PEP 3134, [1], [2], [3]

PEP 3135, [1]

PEP 3137

PEP 3138

PEP 314, [1]

PEP 3141, [1], [2]

PEP 3147, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19], [20], [21], [22]

PEP 3148, [1]

PEP 3149, [1], [2]

PEP 3151, [1], [2], [3], [4], [5]

PEP 3154, [1], [2], [3]

PEP 3155, [1]

PEP 3156, [1], [2], [3], [4]

PEP 318, [1], [2], [3]

PEP 322, [1]

PEP 324, [1]

PEP 325

PEP 327

PEP 328, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PEP 331

PEP 333, [1]

PEP 3333, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15]

PEP 338, [1], [2], [3]

PEP 339

PEP 341

PEP 342, [1], [2], [3], [4], [5], [6]

PEP 343, [1], [2], [3], [4], [5], [6], [7]

PEP 347

PEP 352, [1], [2]

PEP 353, [1], [2], [3], [4], [5]

PEP 356

PEP 357

PEP 361

PEP 362, [1], [2], [3]

PEP 366, [1], [2], [3], [4], [5], [6]

PEP 370, [1], [2], [3], [4]

PEP 371

PEP 372, [1]

PEP 373

PEP 378, [1], [2]

PEP 380, [1]

PEP 383, [1], [2], [3], [4], [5]

PEP 384, [1], [2]

PEP 385

PEP 387, [1], [2]

PEP 389, [1]

PEP 391, [1]

PEP 392

PEP 393, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

PEP 397, [1], [2]

PEP 398

PEP 4

PEP 405, [1]

PEP 409

PEP 411, [1], [2], [3], [4]

PEP 412, [1]

PEP 414, [1]

PEP 418

PEP 420, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 421, [1], [2]

PEP 424, [1]

PEP 427

PEP 428, [1], [2]

PEP 429

PEP 432, [1], [2], [3]

PEP 434, [1]

PEP 435, [1], [2]

PEP 436, [1], [2]

PEP 441, [1]

PEP 442, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 443, [1], [2]

PEP 445, [1], [2], [3]

PEP 446, [1], [2], [3]

PEP 448, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 450, [1], [2]

PEP 451, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 453, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PEP 454, [1], [2]

PEP 456, [1]

PEP 461, [1], [2]

PEP 465, [1], [2]

PEP 466, [1], [2], [3]

PEP 468, [1], [2]

PEP 471, [1], [2]

PEP 475, [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]

PEP 476

PEP 477

PEP 478

PEP 479, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

PEP 483, [1], [2], [3]

PEP 484, [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]

PEP 485, [1], [2], [3], [4]

PEP 486, [1], [2]

PEP 487, [1], [2], [3], [4], [5], [6]

PEP 488, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 489, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40], [41], [42], [43], [44], [45], [46], [47], [48], [49], [50], [51], [52], [53], [54], [55], [56], [57], [58], [59], [60], [61]

PEP 492, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19], [20], [21], [22]

PEP 493

PEP 494

PEP 495, [1], [2], [3]

PEP 498, [1], [2], [3], [4]

PEP 5, [1]

PEP 506, [1], [2]

PEP 511

PEP 514

PEP 515, [1], [2], [3], [4]

PEP 519, [1], [2], [3], [4], [5], [6], [7]

PEP 520

PEP 523, [1], [2], [3], [4], [5], [6], [7]

PEP 524, [1], [2], [3], [4], [5]

PEP 525, [1], [2], [3], [4], [5], [6], [7]

PEP 526, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17]

PEP 528, [1], [2], [3]

PEP 529, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

PEP 530, [1], [2], [3]

PEP 538, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 539, [1], [2], [3]

PEP 540, [1], [2], [3], [4]

PEP 544, [1], [2], [3]

PEP 545, [1]

PEP 552, [1], [2], [3], [4], [5], [6]

PEP 553, [1]

PEP 557, [1]

PEP 560, [1], [2], [3], [4], [5], [6]

PEP 562, [1], [2], [3]

PEP 563, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 564, [1], [2], [3]

PEP 565, [1]

PEP 566, [1], [2]

PEP 567, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PEP 570, [1], [2], [3]

PEP 572, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 573, [1], [2], [3], [4]

PEP 574, [1], [2]

PEP 578, [1], [2], [3]

PEP 584, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]

PEP 585, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40], [41], [42], [43], [44], [45]

PEP 586, [1], [2], [3], [4]

PEP 587, [1], [2], [3], [4]

PEP 589, [1], [2]

PEP 590, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 591, [1], [2], [3]

PEP 593, [1], [2], [3], [4], [5]

PEP 594, [1], [2]

PEP 594#aifc

PEP 594#asynchat

PEP 594#asyncore

PEP 594#audioop

PEP 594#cgi

PEP 594#cgitb

PEP 594#chunk

PEP 594#crypt

PEP 594#imghdr

PEP 594#mailcap

PEP 594#msilib

PEP 594#nis

PEP 594#ossaudiodev

PEP 594#pipes

PEP 594#smtpd

PEP 594#sndhdr

PEP 594#spwd

PEP 594#sunau

PEP 594#telnetlib

PEP 594#uu-and-the-uu-encoding

PEP 594#xdrlib

PEP 596

PEP 597, [1], [2]

PEP 6

PEP 602, [1]

PEP 604, [1], [2], [3], [4], [5], [6]

PEP 612, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

PEP 613, [1], [2], [3], [4]

PEP 614, [1], [2], [3], [4]

PEP 615, [1], [2], [3]

PEP 616, [1], [2]

PEP 617, [1], [2], [3], [4], [5], [6]

PEP 618, [1], [2]

PEP 623, [1], [2], [3]

PEP 624

PEP 626, [1]

PEP 628, [1], [2]

PEP 632, [1]

PEP 634, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 635, [1]

PEP 636, [1], [2], [3], [4]

PEP 644, [1], [2], [3], [4], [5]

PEP 647, [1], [2], [3], [4]

PEP 649

PEP 652, [1]

PEP 7, [1], [2], [3]

PEP 706, [1]

PEP 8, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PYTHON*, [1], [2], [3], [4], [5], [6]

python--m-py_compile command line option

-

--quiet

-q

<file> ... <fileN>

python_branch() (在 platform 模块中)

python_build() (在 platform 模块中)

python_compiler() (在 platform 模块中)

PYTHON_DOM

python_implementation() (在 platform 模块中)

python_is_optimized() (在 test.support 模块中)

python_revision() (在 platform 模块中)

python_version() (在 platform 模块中)

python_version_tuple() (在 platform 模块中)

PYTHONASYNCIODEBUG, [1], [2]

PYTHONBREAKPOINT, [1], [2], [3]

PYTHONCASEOK, [1], [2], [3]

PYTHONCOERCECLOCALE, [1], [2], [3]

PYTHONDEBUG, [1], [2]

PYTHONDEVMODE, [1]

PYTHONDOCS

PYTHONDONTWRITEBYTECODE, [1], [2], [3], [4], [5], [6]

PYTHONDUMPREFS, [1], [2], [3], [4]

PYTHONEXECUTABLE

PYTHONFAULTHANDLER, [1], [2], [3]

PYTHONHASHSEED, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PYTHONHOME, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]

Pythonic

PYTHONINSPECT, [1], [2], [3]

PYTHONINTMAXSTRDIGITS, [1], [2], [3], [4]

PYTHONIOENCODING, [1], [2], [3], [4], [5], [6], [7]

PYTHONLEGACYWINDOWSFSENCODING, [1], [2], [3]

PYTHONLEGACYWINDOWSSTDIO, [1], [2], [3], [4]

PYTHONMALLOC, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PYTHONMALLOC`（例如：``PYTHONMALLOC=malloc`

PYTHONMALLOCSTATS, [1], [2]

PYTHONNOUSERSITE, [1], [2], [3]

PYTHONOPTIMIZE, [1], [2]

PYTHONPATH, [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]

PYTHONPLATLIBDIR, [1]

PYTHONPROFILEIMPORTTIME, [1], [2], [3]

PYTHONPYCACHEPREFIX, [1], [2], [3], [4]

PYTHONREGRTEST_UNICODE_GUARD

PYTHONSHOWALLOCCOUNT

PYTHONSHOWREFCOUNT

PYTHONSTARTUP, [1], [2], [3], [4], [5], [6], [7]

PYTHONTHREADDEBUG, [1], [2]

PYTHONTRACEMALLOC, [1], [2], [3]

PYTHONTZPATH

PYTHONUNBUFFERED, [1], [2], [3], [4]

PYTHONUSERBASE, [1], [2]

PYTHONUSERSITE

PYTHONUTF8, [1], [2], [3], [4], [5], [6], [7]

PYTHONVERBOSE, [1], [2]

PYTHONWARNDEFAULTENCODING, [1], [2], [3]

PYTHONWARNINGS, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

PyThread_create_key (C function)

PyThread_delete_key (C function)

PyThread_delete_key_value (C function)

PyThread_get_key_value (C function)

PyThread_ReInitTLS (C function)

PyThread_set_key_value (C function)

PyThread_tss_alloc (C function)

PyThread_tss_create (C function)

PyThread_tss_delete (C function)

PyThread_tss_free (C function)

PyThread_tss_get (C function)

PyThread_tss_is_created (C function)

PyThread_tss_set (C function)

PyThreadState, [1]

(C type)

PyThreadState_Clear (C function)

PyThreadState_Delete (C function)

PyThreadState_DeleteCurrent (C function)

PyThreadState_Get (C function)

PyThreadState_GetDict (C function)

PyThreadState_GetFrame (C function)

PyThreadState_GetID (C function)

PyThreadState_GetInterpreter (C function)

PyThreadState_New (C function)

PyThreadState_Next (C function)

PyThreadState_SetAsyncExc (C function)

PyThreadState_Swap (C function)

PyTime_Check (C function)

PyTime_CheckExact (C function)

PyTime_FromTime (C function)

PyTime_FromTimeAndFold (C function)

PyTimeZone_FromOffset (C function)

PyTimeZone_FromOffsetAndName (C function)

PyTrace_C_CALL (C var)

PyTrace_C_EXCEPTION (C var)

PyTrace_C_RETURN (C var)

PyTrace_CALL (C var)

PyTrace_EXCEPTION (C var)

PyTrace_LINE (C var)

PyTrace_OPCODE (C var)

PyTrace_RETURN (C var)

PyTraceMalloc_Track (C function)

PyTraceMalloc_Untrack (C function)

PyTuple_Check (C function)

PyTuple_CheckExact (C function)

PyTuple_GET_ITEM (C function)

PyTuple_GET_SIZE (C function)

PyTuple_GetItem (C function)

PyTuple_GetSlice (C function)

PyTuple_New (C function)

PyTuple_Pack (C function)

PyTuple_SET_ITEM (C function)

PyTuple_SetItem (C function)

PyTuple_SetItem()

PyTuple_Size (C function)

PyTuple_Type (C var)

PyTupleObject (C type)

PyType_Check (C function)

PyType_CheckExact (C function)

PyType_ClearCache (C function)

PyType_FromModuleAndSpec (C function)

PyType_FromSpec (C function)

PyType_FromSpecWithBases (C function)

PyType_GenericAlloc (C function)

PyType_GenericNew (C function)

PyType_GetFlags (C function)

PyType_GetModule (C function)

PyType_GetModuleState (C function)

PyType_GetSlot (C function)

PyType_HasFeature (C function)

PyType_IS_GC (C function)

PyType_IsSubtype (C function)

PyType_Modified (C function)

PyType_Ready (C function)

PyType_Slot (C type)

PyType_Slot.PyType_Slot.pfunc (C member)

PyType_Slot.PyType_Slot.slot (C member)

PyType_Spec (C type)

PyType_Spec.PyType_Spec.basicsize (C member)

PyType_Spec.PyType_Spec.flags (C member)

PyType_Spec.PyType_Spec.itemsize (C member)

PyType_Spec.PyType_Spec.name (C member)

PyType_Spec.PyType_Spec.slots (C member)

PyType_Type (C var)

PyTypeObject (C type)

PyTypeObject.tp_alloc (C member)

PyTypeObject.tp_as_async (C member)

PyTypeObject.tp_as_buffer (C member)

PyTypeObject.tp_as_mapping (C member)

PyTypeObject.tp_as_number (C member)

PyTypeObject.tp_as_sequence (C member)

PyTypeObject.tp_base (C member)

PyTypeObject.tp_bases (C member)

PyTypeObject.tp_basicsize (C member)

PyTypeObject.tp_cache (C member)

PyTypeObject.tp_call (C member)

PyTypeObject.tp_clear (C member)

PyTypeObject.tp_dealloc (C member)

PyTypeObject.tp_del (C member)

PyTypeObject.tp_descr_get (C member)

PyTypeObject.tp_descr_set (C member)

PyTypeObject.tp_dict (C member)

PyTypeObject.tp_dictoffset (C member)

PyTypeObject.tp_doc (C member)

PyTypeObject.tp_finalize (C member)

PyTypeObject.tp_flags (C member)

PyTypeObject.tp_free (C member)

PyTypeObject.tp_getattr (C member)

PyTypeObject.tp_getattro (C member)

PyTypeObject.tp_getset (C member)

PyTypeObject.tp_hash (C member)

PyTypeObject.tp_init (C member)

PyTypeObject.tp_is_gc (C member)

PyTypeObject.tp_itemsize (C member)

PyTypeObject.tp_iter (C member)

PyTypeObject.tp_iternext (C member)

PyTypeObject.tp_members (C member)

PyTypeObject.tp_methods (C member)

PyTypeObject.tp_mro (C member)

PyTypeObject.tp_name (C member)

PyTypeObject.tp_new (C member)

PyTypeObject.tp_repr (C member)

PyTypeObject.tp_richcompare (C member)

PyTypeObject.tp_richcompare.Py_RETURN_RICHCOMPARE (C macro)

PyTypeObject.tp_setattr (C member)

PyTypeObject.tp_setattro (C member)

PyTypeObject.tp_str (C member)

PyTypeObject.tp_subclasses (C member)

PyTypeObject.tp_traverse (C member)

PyTypeObject.tp_vectorcall (C member)

PyTypeObject.tp_vectorcall_offset (C member)

PyTypeObject.tp_version_tag (C member)

PyTypeObject.tp_weaklist (C member)

PyTypeObject.tp_weaklistoffset (C member)

PyTZInfo_Check (C function)

PyTZInfo_CheckExact (C function)

PyUnicode_1BYTE_DATA (C function)

PyUnicode_1BYTE_KIND (C macro)

PyUnicode_2BYTE_DATA (C function)

PyUnicode_2BYTE_KIND (C macro)

PyUnicode_4BYTE_DATA (C function)

PyUnicode_4BYTE_KIND (C macro)

PyUnicode_AS_DATA (C function)

PyUnicode_AS_UNICODE (C function)

PyUnicode_AsASCIIString (C function)

PyUnicode_AsCharmapString (C function)

PyUnicode_AsEncodedString (C function)

PyUnicode_AsLatin1String (C function)

PyUnicode_AsMBCSString (C function)

PyUnicode_AsRawUnicodeEscapeString (C function)

PyUnicode_AsUCS4 (C function)

PyUnicode_AsUCS4Copy (C function)

PyUnicode_AsUnicode (C function)

PyUnicode_AsUnicodeAndSize (C function)

PyUnicode_AsUnicodeEscapeString (C function)

PyUnicode_AsUTF16String (C function)

PyUnicode_AsUTF32String (C function)

PyUnicode_AsUTF8 (C function)

PyUnicode_AsUTF8AndSize (C function)

PyUnicode_AsUTF8String (C function)

PyUnicode_AsWideChar (C function)

PyUnicode_AsWideCharString (C function)

PyUnicode_Check (C function)

PyUnicode_CheckExact (C function)

PyUnicode_Compare (C function)

PyUnicode_CompareWithASCIIString (C function)

PyUnicode_Concat (C function)

PyUnicode_Contains (C function)

PyUnicode_CopyCharacters (C function)

PyUnicode_Count (C function)

PyUnicode_DATA (C function)

PyUnicode_Decode (C function)

PyUnicode_DecodeASCII (C function)

PyUnicode_DecodeCharmap (C function)

PyUnicode_DecodeFSDefault (C function)

PyUnicode_DecodeFSDefaultAndSize (C function)

PyUnicode_DecodeLatin1 (C function)

PyUnicode_DecodeLocale (C function)

PyUnicode_DecodeLocaleAndSize (C function)

PyUnicode_DecodeMBCS (C function)

PyUnicode_DecodeMBCSStateful (C function)

PyUnicode_DecodeRawUnicodeEscape (C function)

PyUnicode_DecodeUnicodeEscape (C function)

PyUnicode_DecodeUTF16 (C function)

PyUnicode_DecodeUTF16Stateful (C function)

PyUnicode_DecodeUTF32 (C function)

PyUnicode_DecodeUTF32Stateful (C function)

PyUnicode_DecodeUTF7 (C function)

PyUnicode_DecodeUTF7Stateful (C function)

PyUnicode_DecodeUTF8 (C function)

PyUnicode_DecodeUTF8Stateful (C function)

PyUnicode_Encode (C function)

PyUnicode_EncodeASCII (C function)

PyUnicode_EncodeCharmap (C function)

PyUnicode_EncodeCodePage (C function)

PyUnicode_EncodeFSDefault (C function)

PyUnicode_EncodeLatin1 (C function)

PyUnicode_EncodeLocale (C function)

PyUnicode_EncodeMBCS (C function)

PyUnicode_EncodeRawUnicodeEscape (C function)

PyUnicode_EncodeUnicodeEscape (C function)

PyUnicode_EncodeUTF16 (C function)

PyUnicode_EncodeUTF32 (C function)

PyUnicode_EncodeUTF7 (C function)

PyUnicode_EncodeUTF8 (C function)

PyUnicode_Fill (C function)

PyUnicode_Find (C function)

PyUnicode_FindChar (C function)

PyUnicode_Format (C function)

PyUnicode_FromEncodedObject (C function)

PyUnicode_FromFormat (C function)

PyUnicode_FromFormatV (C function)

PyUnicode_FromKindAndData (C function)

PyUnicode_FromObject (C function)

PyUnicode_FromString (C function)

PyUnicode_FromString()

PyUnicode_FromStringAndSize (C function)

PyUnicode_FromUnicode (C function)

PyUnicode_FromWideChar (C function)

PyUnicode_FSConverter (C function)

PyUnicode_FSDecoder (C function)

PyUnicode_GET_DATA_SIZE (C function)

PyUnicode_GET_LENGTH (C function)

PyUnicode_GET_SIZE (C function)

PyUnicode_GetLength (C function)

PyUnicode_GetSize (C function)

PyUnicode_InternFromString (C function)

PyUnicode_InternInPlace (C function)

PyUnicode_IsIdentifier (C function)

PyUnicode_Join (C function)

PyUnicode_KIND (C function)

PyUnicode_MAX_CHAR_VALUE (C macro)

PyUnicode_New (C function)

PyUnicode_READ (C function)

PyUnicode_READ_CHAR (C function)

PyUnicode_ReadChar (C function)

PyUnicode_READY (C function)

PyUnicode_Replace (C function)

PyUnicode_RichCompare (C function)

PyUnicode_Split (C function)

PyUnicode_Splitlines (C function)

PyUnicode_Substring (C function)

PyUnicode_Tailmatch (C function)

PyUnicode_TransformDecimalToASCII (C function)

PyUnicode_Translate (C function)

PyUnicode_TranslateCharmap (C function)

PyUnicode_Type (C var)

PyUnicode_WCHAR_KIND (C macro)

PyUnicode_WRITE (C function)

PyUnicode_WriteChar (C function)

PyUnicodeDecodeError_Create (C function)

PyUnicodeDecodeError_GetEncoding (C function)

PyUnicodeDecodeError_GetEnd (C function)

PyUnicodeDecodeError_GetObject (C function)

PyUnicodeDecodeError_GetReason (C function)

PyUnicodeDecodeError_GetStart (C function)

PyUnicodeDecodeError_SetEnd (C function)

PyUnicodeDecodeError_SetReason (C function)

PyUnicodeDecodeError_SetStart (C function)

PyUnicodeEncodeError_Create (C function)

PyUnicodeEncodeError_GetEncoding (C function)

PyUnicodeEncodeError_GetEnd (C function)

PyUnicodeEncodeError_GetObject (C function)

PyUnicodeEncodeError_GetReason (C function)

PyUnicodeEncodeError_GetStart (C function)

PyUnicodeEncodeError_SetEnd (C function)

PyUnicodeEncodeError_SetReason (C function)

PyUnicodeEncodeError_SetStart (C function)

PyUnicodeObject (C type)

PyUnicodeTranslateError_Create (C function)

PyUnicodeTranslateError_GetEnd (C function)

PyUnicodeTranslateError_GetObject (C function)

PyUnicodeTranslateError_GetReason (C function)

PyUnicodeTranslateError_GetStart (C function)

PyUnicodeTranslateError_SetEnd (C function)

PyUnicodeTranslateError_SetReason (C function)

PyUnicodeTranslateError_SetStart (C function)

PyVarObject (C type)

PyVarObject.ob_size (C member)

PyVarObject_HEAD_INIT (C macro)

PyVectorcall_Call (C function)

PyVectorcall_Function (C function)

PyVectorcall_NARGS (C function)

PyWeakref_Check (C function)

PyWeakref_CheckProxy (C function)

PyWeakref_CheckRef (C function)

PyWeakref_GET_OBJECT (C function)

PyWeakref_GetObject (C function)

PyWeakref_NewProxy (C function)

PyWeakref_NewRef (C function)

PyWideStringList (C type)

PyWideStringList.items (C member)

PyWideStringList.length (C member)

PyWideStringList.PyWideStringList_Append (C function)

PyWideStringList.PyWideStringList_Insert (C function)

PyWrapper_New (C function)

PyZipFile (zipfile 中的类)

索引 – Q

qiflush() (在 curses 模块中)

QName (xml.etree.ElementTree 中的类)

qsize() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

qualified name -- 限定名称

quantiles() (statistics.NormalDist 方法)

(在 statistics 模块中)

quantize() (decimal.Context 方法)

(decimal.Decimal 方法)

QueryInfoKey() (在 winreg 模块中)

QueryReflectionKey() (在 winreg 模块中)

QueryValue() (在 winreg 模块中)

QueryValueEx() (在 winreg 模块中)

queue

模块

Queue (asyncio 中的类)

(multiprocessing 中的类)

(queue 中的类)

queue (sched.scheduler 属性)

Queue() (multiprocessing.managers.SyncManager 方法)

QueueEmpty

QueueFull

QueueHandler (logging.handlers 中的类)

QueueListener (logging.handlers 中的类)

quick_ratio() (difflib.SequenceMatcher 方法)

quit (pdb command)

(內置变量)

quit() (ftplib.FTP 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

(smtplib.SMTP 方法)

(tkinter.filedialog.FileDialog 方法)

quopri

模块

quote() (在 email.utils 模块中)

(在 shlex 模块中)

(在 urllib.parse 模块中)

QUOTE_ALL() (在 csv 模块中)

quote_from_bytes() (在 urllib.parse 模块中)

QUOTE_MINIMAL() (在 csv 模块中)

QUOTE_NONE() (在 csv 模块中)

QUOTE_NONNUMERIC() (在 csv 模块中)

quote_plus() (在 urllib.parse 模块中)

quoteattr() (在 xml.sax.saxutils 模块中)

quotechar (csv.Dialect 属性)

quoted-printable

encoding

quotes (shlex.shlex 属性)

quoting (csv.Dialect 属性)

索引 – R

r"

raw string literal

r'

raw string literal

R_OK() (在 os 模块中)

radians() (在 math 模块中)

(在 turtle 模块中)

RadioButtonGroup (msilib 中的类)

radiogroup() (msilib.Dialog 方法)

radix() (decimal.Context 方法)

(decimal.Decimal 方法)

RADIXCHAR() (在 locale 模块中)

raise

语句, [1]

raise (2to3 fixer)

Raise (ast 中的类)

raise an exception

raise_on_defect (email.policy.Policy 属性)

raise_signal() (在 signal 模块中)

RAISE_VARARGS (opcode)

raising

exception

RAND_add() (在 ssl 模块中)

RAND_bytes() (在 ssl 模块中)

RAND_pseudo_bytes() (在 ssl 模块中)

RAND_status() (在 ssl 模块中)

randbelow() (在 secrets 模块中)

randbits() (在 secrets 模块中)

randbytes() (在 random 模块中)

randint() (在 random 模块中)

random

模块

Random (random 中的类)

random() (在 random 模块中)

randrange() (在 random 模块中)

range

內置函数

对象

range (內置类)

RARROW() (在 token 模块中)

ratecv() (在 audioop 模块中)

ratio() (difflib.SequenceMatcher 方法)

Rational (numbers 中的类)

raw (io.BufferedIOBase 属性)

raw string

raw() (pickle.PickleBuffer 方法)

(在 curses 模块中)

raw_data_manager() (在 email.contentmanager 模块中)

raw_decode() (json.JSONDecoder 方法)

raw_input (2to3 fixer)

raw_input() (code.InteractiveConsole 方法)

RawArray() (在 multiprocessing.sharedctypes 模块中)

RawConfigParser (configparser 中的类)

RawDescriptionHelpFormatter (argparse 中的类)

RawIOBase (io 中的类)

RawPen (turtle 中的类)

RawTextHelpFormatter (argparse 中的类)

RawTurtle (turtle 中的类)

RawValue() (在 multiprocessing.sharedctypes 模块中)

RBRACE() (在 token 模块中)

rcpttos (smtpd.SMTPChannel 属性)

re

模块, [1], [2]

re (re.Match 属性)

read() (asyncio.StreamReader 方法)

(chunk.Chunk 方法)

(codecs.StreamReader 方法)

(configparser.ConfigParser 方法)

(http.client.HTTPResponse 方法)

(imaplib.IMAP4 方法)

(io.BufferedIOBase 方法)

(io.BufferedReader 方法)

(io.RawIOBase 方法)

(io.TextIOBase 方法)

(mimetypes.MimeTypes 方法)

(mmap.mmap 方法)

(ossaudiodev.oss_audio_device 方法)

(ssl.MemoryBIO 方法)

(ssl.SSLSocket 方法)

(urllib.robotparser.RobotFileParser 方法)

(zipfile.ZipFile 方法)

(在 os 模块中)

read1() (io.BufferedIOBase 方法)

(io.BufferedReader 方法)

(io.BytesIO 方法)

read_all() (telnetlib.Telnet 方法)

read_binary() (在 importlib.resources 模块中)

read_byte() (mmap.mmap 方法)

read_bytes() (importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

read_dict() (configparser.ConfigParser 方法)

read_eager() (telnetlib.Telnet 方法)

read_environ() (在 wsgiref.handlers 模块中)

read_events() (xml.etree.ElementTree.XMLPullParser 方法)

read_file() (configparser.ConfigParser 方法)

read_history_file() (在 readline 模块中)

read_init_file() (在 readline 模块中)

read_lazy() (telnetlib.Telnet 方法)

read_mime_types() (在 mimetypes 模块中)

READ_RESTRICTED

read_sb_data() (telnetlib.Telnet 方法)

read_some() (telnetlib.Telnet 方法)

read_string() (configparser.ConfigParser 方法)

read_text() (importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

(在 importlib.resources 模块中)

read_token() (shlex.shlex 方法)

read_until() (telnetlib.Telnet 方法)

read_very_eager() (telnetlib.Telnet 方法)

read_very_lazy() (telnetlib.Telnet 方法)

read_windows_registry() (mimetypes.MimeTypes 方法)

readable() (asyncore.dispatcher 方法)

(io.IOBase 方法)

READABLE() (在 tkinter 模块中)

readall() (io.RawIOBase 方法)

reader() (在 csv 模块中)

ReadError

readexactly() (asyncio.StreamReader 方法)

readfp() (configparser.ConfigParser 方法)

(mimetypes.MimeTypes 方法)

readframes() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

readinto() (http.client.HTTPResponse 方法)

(io.BufferedIOBase 方法)

(io.RawIOBase 方法)

readinto1() (io.BufferedIOBase 方法)

(io.BytesIO 方法)

readline

模块

readline() (asyncio.StreamReader 方法)

(codecs.StreamReader 方法)

(distutils.text_file.TextFile 方法)

(imaplib.IMAP4 方法)

(io.IOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

readlines() (codecs.StreamReader 方法)

(distutils.text_file.TextFile 方法)

(io.IOBase 方法)

readlink() (pathlib.Path 方法)

(在 os 模块中)

readmodule() (在 pyclbr 模块中)

readmodule_ex() (在 pyclbr 模块中)

READONLY

readonly (memoryview 属性)

ReadTransport (asyncio 中的类)

readuntil() (asyncio.StreamReader 方法)

readv() (在 os 模块中)

ready() (multiprocessing.pool.AsyncResult 方法)

Real (numbers 中的类)

real (numbers.Complex 属性)

Real Media File Format

real_max_memuse() (在 test.support 模块中)

real_quick_ratio() (difflib.SequenceMatcher 方法)

realloc()

realpath() (在 os.path 模块中)

REALTIME_PRIORITY_CLASS() (在 subprocess 模块中)

reap_children() (在 test.support 模块中)

reap_threads() (在 test.support.threading_helper 模块中)

reason (http.client.HTTPResponse 属性)

(ssl.SSLError 属性)

(UnicodeError 属性)

(urllib.error.HTTPError 属性)

(urllib.error.URLError 属性)

reattach() (tkinter.ttk.Treeview 方法)

rebinding

name

reccontrols() (ossaudiodev.oss_mixer_device 方法)

received_data (smtpd.SMTPChannel 属性)

received_lines (smtpd.SMTPChannel 属性)

recent() (imaplib.IMAP4 方法)

reconfigure() (io.TextIOWrapper 方法)

record_original_stdout() (在 test.support 模块中)

records (unittest.TestCase 属性)

rect() (在 cmath 模块中)

rectangle() (在 curses.textpad 模块中)

RecursionError

recursive_repr() (在 reprlib 模块中)

recv() (asyncore.dispatcher 方法)

(multiprocessing.connection.Connection 方法)

(socket.socket 方法)

recv_bytes() (multiprocessing.connection.Connection 方法)

recv_bytes_into() (multiprocessing.connection.Connection 方法)

recv_fds() (在 socket 模块中)

recv_into() (socket.socket 方法)

recvfrom() (socket.socket 方法)

recvfrom_into() (socket.socket 方法)

recvmsg() (socket.socket 方法)

recvmsg_into() (socket.socket 方法)

redirect_request() (urllib.request.HTTPRedirectHandler 方法)

redirect_stderr() (在 contextlib 模块中)

redirect_stdout() (在 contextlib 模块中)

redisplay() (在 readline 模块中)

redrawln() (curses.window 方法)

redrawwin() (curses.window 方法)

reduce (2to3 fixer)

reduce() (在 functools 模块中)

reducer_override() (pickle.Pickler 方法)

ref (weakref 中的类)

refcount_test() (在 test.support 模块中)

reference

attribute

reference count -- 引用计数

reference counting

ReferenceError

ReferenceType() (在 weakref 模块中)

refold_source (email.policy.EmailPolicy 属性)

refresh() (curses.window 方法)

REG_BINARY() (在 winreg 模块中)

REG_DWORD() (在 winreg 模块中)

REG_DWORD_BIG_ENDIAN() (在 winreg 模块中)

REG_DWORD_LITTLE_ENDIAN() (在 winreg 模块中)

REG_EXPAND_SZ() (在 winreg 模块中)

REG_FULL_RESOURCE_DESCRIPTOR() (在 winreg 模块中)

REG_LINK() (在 winreg 模块中)

REG_MULTI_SZ() (在 winreg 模块中)

REG_NONE() (在 winreg 模块中)

REG_QWORD() (在 winreg 模块中)

REG_QWORD_LITTLE_ENDIAN() (在 winreg 模块中)

REG_RESOURCE_LIST() (在 winreg 模块中)

REG_RESOURCE_REQUIREMENTS_LIST() (在 winreg 模块中)

REG_SZ() (在 winreg 模块中)

register() (abc.ABCMeta 方法)

(multiprocessing.managers.BaseManager 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(selectors.BaseSelector 方法)

(在 atexit 模块中)

(在 codecs 模块中)

(在 faulthandler 模块中)

(在 webbrowser 模块中)

register_adapter() (在 sqlite3 模块中)

register_archive_format() (在 shutil 模块中)

register_at_fork() (在 os 模块中)

register_converter() (在 sqlite3 模块中)

register_defect() (email.policy.Policy 方法)

register_dialect() (在 csv 模块中)

register_error() (在 codecs 模块中)

register_function() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_instance() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_introspection_functions() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_multicall_functions() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_namespace() (在 xml.etree.ElementTree 模块中)

register_optionflag() (在 doctest 模块中)

register_shape() (在 turtle 模块中)

register_unpack_format() (在 shutil 模块中)

registerDOMImplementation() (在 xml.dom 模块中)

registerResult() (在 unittest 模块中)

regular

package

regular package -- 常规包

relative

import

URL

relative_to() (pathlib.PurePath 方法)

release() (_thread.lock 方法)

(asyncio.Condition 方法)

(asyncio.Lock 方法)

(asyncio.Semaphore 方法)

(logging.Handler 方法)

(memoryview 方法)

(multiprocessing.Lock 方法)

(multiprocessing.RLock 方法)

(pickle.PickleBuffer 方法)

(threading.Condition 方法)

(threading.Lock 方法)

(threading.RLock 方法)

(threading.Semaphore 方法)

(在 platform 模块中)

release_lock() (在 imp 模块中)

releasebufferproc (C type)

reload (2to3 fixer)

reload() (在 imp 模块中)

(在 importlib 模块中)

relpath() (在 os.path 模块中)

remainder() (decimal.Context 方法)

(在 math 模块中)

remainder_near() (decimal.Context 方法)

(decimal.Decimal 方法)

RemoteDisconnected

remove() (array.array 方法)

(collections.deque 方法)

(frozenset 方法)

(mailbox.Mailbox 方法)

(mailbox.MH 方法)

(sequence method)

(xml.etree.ElementTree.Element 方法)

(在 os 模块中)

remove_child_handler() (asyncio.AbstractChildWatcher 方法)

remove_done_callback() (asyncio.Future 方法)

(asyncio.Task 方法)

remove_flag() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

remove_folder() (mailbox.Maildir 方法)

(mailbox.MH 方法)

remove_header() (urllib.request.Request 方法)

remove_history_item() (在 readline 模块中)

remove_label() (mailbox.BabylMessage 方法)

remove_option() (configparser.ConfigParser 方法)

(optparse.OptionParser 方法)

remove_pyc() (msilib.Directory 方法)

remove_reader() (asyncio.loop 方法)

remove_section() (configparser.ConfigParser 方法)

remove_sequence() (mailbox.MHMessage 方法)

remove_signal_handler() (asyncio.loop 方法)

remove_tree() (在 distutils.dir_util 模块中)

remove_writer() (asyncio.loop 方法)

removeAttribute() (xml.dom.Element 方法)

removeAttributeNode() (xml.dom.Element 方法)

removeAttributeNS() (xml.dom.Element 方法)

removeChild() (xml.dom.Node 方法)

removedirs() (在 os 模块中)

removeFilter() (logging.Handler 方法)

(logging.Logger 方法)

removeHandler() (logging.Logger 方法)

(在 unittest 模块中)

removeprefix() (bytearray 方法)

(bytes 方法)

(str 方法)

removeResult() (在 unittest 模块中)

removesuffix() (bytearray 方法)

(bytes 方法)

(str 方法)

removexattr() (在 os 模块中)

rename() (ftplib.FTP 方法)

(imaplib.IMAP4 方法)

(pathlib.Path 方法)

(在 os 模块中)

renames (2to3 fixer)

renames() (在 os 模块中)

reopenIfNeeded() (logging.handlers.WatchedFileHandler 方法)

reorganize() (dbm.gnu.gdbm 方法)

repeat() (timeit.Timer 方法)

(在 itertools 模块中)

(在 timeit 模块中)

repetition

operation

replace

error handler's name

replace() (bytearray 方法)

(bytes 方法)

(curses.panel.Panel 方法)

(datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(inspect.Parameter 方法)

(inspect.Signature 方法)

(pathlib.Path 方法)

(str 方法)

(types.CodeType 方法)

(在 dataclasses 模块中)

(在 os 模块中)

replace_errors() (在 codecs 模块中)

replace_header() (email.message.EmailMessage 方法)

(email.message.Message 方法)

replace_history_item() (在 readline 模块中)

replace_whitespace (textwrap.TextWrapper 属性)

replaceChild() (xml.dom.Node 方法)

ReplacePackage() (在 modulefinder 模块中)

report() (filecmp.dircmp 方法)

(modulefinder.ModuleFinder 方法)

REPORT_CDIFF() (在 doctest 模块中)

report_failure() (doctest.DocTestRunner 方法)

report_full_closure() (filecmp.dircmp 方法)

REPORT_NDIFF() (在 doctest 模块中)

REPORT_ONLY_FIRST_FAILURE() (在 doctest 模块中)

report_partial_closure() (filecmp.dircmp 方法)

report_start() (doctest.DocTestRunner 方法)

report_success() (doctest.DocTestRunner 方法)

REPORT_UDIFF() (在 doctest 模块中)

report_unexpected_exception() (doctest.DocTestRunner 方法)

REPORTING_FLAGS() (在 doctest 模块中)

repr

內置函数, [1], [2], [3]

repr (2to3 fixer)

Repr (reprlib 中的类)

repr()

內置函数

repr() (built-in function)

__repr__() (object method)

repr() (reprlib.Repr 方法)

(在 reprlib 模块中)

repr1() (reprlib.Repr 方法)

representation

integer

reprfunc (C type)

reprlib

模块

Request (urllib.request 中的类)

request() (http.client.HTTPConnection 方法)

request_queue_size (socketserver.BaseServer 属性)

request_rate() (urllib.robotparser.RobotFileParser 方法)

request_uri() (在 wsgiref.util 模块中)

request_version (http.server.BaseHTTPRequestHandler 属性)

RequestHandlerClass (socketserver.BaseServer 属性)

requestline (http.server.BaseHTTPRequestHandler 属性)

requires() (在 test.support 模块中)

requires_bz2() (在 test.support 模块中)

requires_docstrings() (在 test.support 模块中)

requires_freebsd_version() (在 test.support 模块中)

requires_gzip() (在 test.support 模块中)

requires_IEEE_754() (在 test.support 模块中)

requires_linux_version() (在 test.support 模块中)

requires_lzma() (在 test.support 模块中)

requires_mac_version() (在 test.support 模块中)

requires_resource() (在 test.support 模块中)

requires_zlib() (在 test.support 模块中)

RERAISE (opcode)

reserved (zipfile.ZipInfo 属性)

reserved word

RESERVED_FUTURE() (在 uuid 模块中)

RESERVED_MICROSOFT() (在 uuid 模块中)

RESERVED_NCS() (在 uuid 模块中)

reset() (bdb.Bdb 方法)

(codecs.IncrementalDecoder 方法)

(codecs.IncrementalEncoder 方法)

(codecs.StreamReader 方法)

(codecs.StreamWriter 方法)

(contextvars.ContextVar 方法)

(html.parser.HTMLParser 方法)

(ossaudiodev.oss_audio_device 方法)

(pipes.Template 方法)

(threading.Barrier 方法)

(xdrlib.Packer 方法)

(xdrlib.Unpacker 方法)

(xml.dom.pulldom.DOMEventStream 方法)

(xml.sax.xmlreader.IncrementalParser 方法)

(在 turtle 模块中)

reset_mock() (unittest.mock.AsyncMock 方法)

(unittest.mock.Mock 方法)

reset_peak() (在 tracemalloc 模块中)

reset_prog_mode() (在 curses 模块中)

reset_shell_mode() (在 curses 模块中)

reset_tzpath() (在 zoneinfo 模块中)

resetbuffer() (code.InteractiveConsole 方法)

resetlocale() (在 locale 模块中)

resetscreen() (在 turtle 模块中)

resetty() (在 curses 模块中)

resetwarnings() (在 warnings 模块中)

resize() (curses.window 方法)

(mmap.mmap 方法)

(在 ctypes 模块中)

resize_term() (在 curses 模块中)

resizemode() (在 turtle 模块中)

resizeterm() (在 curses 模块中)

resolution (datetime.date 属性)

(datetime.datetime 属性)

(datetime.time 属性)

(datetime.timedelta 属性)

resolve() (pathlib.Path 方法)

resolve_bases() (在 types 模块中)

resolve_name() (在 importlib.util 模块中)

(在 pkgutil 模块中)

resolveEntity() (xml.sax.handler.EntityResolver 方法)

resource

模块

Resource() (在 importlib.resources 模块中)

resource_path() (importlib.abc.ResourceReader 方法)

ResourceDenied

ResourceLoader (importlib.abc 中的类)

ResourceReader (importlib.abc 中的类)

ResourceWarning

response (nntplib.NNTPError 属性)

response() (imaplib.IMAP4 方法)

ResponseNotReady

responses (http.server.BaseHTTPRequestHandler 属性)

responses() (在 http.client 模块中)

restart (pdb command)

restore() (test.support.SaveSignals 方法)

(在 difflib 模块中)

RESTRICTED

restricted

execution

restype (ctypes._FuncPtr 属性)

result() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

results() (trace.Trace 方法)

resume_reading() (asyncio.ReadTransport 方法)

resume_writing() (asyncio.BaseProtocol 方法)

retr() (poplib.POP3 方法)

retrbinary() (ftplib.FTP 方法)

retrieve() (urllib.request.URLopener 方法)

retrlines() (ftplib.FTP 方法)

return

语句, [1], [2]

Return (ast 中的类)

return (pdb command)

return_annotation (inspect.Signature 属性)

return_ok() (http.cookiejar.CookiePolicy 方法)

RETURN_VALUE (opcode)

return_value (unittest.mock.Mock 属性)

returncode (asyncio.subprocess.Process 属性)

(subprocess.CalledProcessError 属性)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

retval (pdb command)

reverse() (array.array 方法)

(collections.deque 方法)

(sequence method)

(在 audioop 模块中)

reverse_order() (pstats.Stats 方法)

reverse_pointer (ipaddress.IPv4Address 属性)

(ipaddress.IPv6Address 属性)

reversed()

內置函数

Reversible (collections.abc 中的类)

(typing 中的类)

revert() (http.cookiejar.FileCookieJar 方法)

rewind() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

RFC

RFC 1014, [1]

RFC 1123

RFC 1321

RFC 1422, [1]

RFC 1521, [1], [2]

RFC 1522, [1], [2]

RFC 1524, [1]

RFC 1730

RFC 1738

RFC 1750

RFC 1766, [1]

RFC 1808, [1], [2]

RFC 1832, [1]

RFC 1869, [1]

RFC 1870, [1], [2]

RFC 1939, [1]

RFC 2033

RFC 2045, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

RFC 2045#section-6.8

RFC 2046, [1], [2]

RFC 2047, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

RFC 2060, [1]

RFC 2068

RFC 2104, [1]

RFC 2109, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

RFC 2183, [1], [2]

RFC 2231, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

RFC 2295

RFC 2324

RFC 2342, [1]

RFC 2368

RFC 2373, [1], [2]

RFC 2396, [1], [2], [3], [4]

RFC 2397

RFC 2449

RFC 2487

RFC 2595, [1]

RFC 2616, [1], [2], [3], [4], [5], [6], [7], [8], [9]

RFC 2640, [1], [2], [3], [4]

RFC 2732, [1], [2]

RFC 2818, [1]

RFC 2821

RFC 2822, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18]

RFC 2964

RFC 2965, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19]

RFC 2980, [1]

RFC 3164

RFC 3171

RFC 3207

RFC 3280

RFC 3330

RFC 3339

RFC 3454, [1]

RFC 3490, [1], [2], [3]

RFC 3490#section-3.1

RFC 3492, [1]

RFC 3493

RFC 3501

RFC 3542, [1]

RFC 3548

RFC 3596#section-2.5

RFC 3659

RFC 3879

RFC 3927

RFC 3977, [1], [2], [3], [4]

RFC 3986, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 4007, [1]

RFC 4086

RFC 4122, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 4180

RFC 4193

RFC 4217

RFC 4291, [1], [2]

RFC 4380

RFC 4627, [1]

RFC 4642

RFC 4648, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 4954, [1]

RFC 5161, [1]

RFC 5246, [1]

RFC 5280, [1], [2], [3], [4]

RFC 5321, [1], [2], [3], [4]

RFC 5322, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19], [20], [21], [22], [23]

RFC 5424, [1], [2], [3], [4]

RFC 5424#section-6

RFC 5735

RFC 5891

RFC 5895

RFC 5929

RFC 6066, [1], [2]

RFC 6125, [1]

RFC 6152, [1]

RFC 6531, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 6532, [1], [2], [3], [4]

RFC 6585

RFC 6855, [1], [2], [3]

RFC 6856, [1]

RFC 7159, [1], [2]

RFC 7230, [1]

RFC 7231, [1], [2]

RFC 7238

RFC 7301, [1], [2]

RFC 7525

RFC 7540

RFC 7693

RFC 7725

RFC 7914

RFC 821, [1]

RFC 822, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

RFC 8297

RFC 8305, [1]

RFC 8470

RFC 854, [1]

RFC 959

RFC 977

rfc2109 (http.cookiejar.Cookie 属性)

rfc2109_as_netscape (http.cookiejar.DefaultCookiePolicy 属性)

rfc2965 (http.cookiejar.CookiePolicy 属性)

rfc822_escape() (在 distutils.util 模块中)

RFC_4122() (在 uuid 模块中)

rfile (http.server.BaseHTTPRequestHandler 属性)

rfind() (bytearray 方法)

(bytes 方法)

(mmap.mmap 方法)

(str 方法)

rgb_to_hls() (在 colorsys 模块中)

rgb_to_hsv() (在 colorsys 模块中)

rgb_to_yiq() (在 colorsys 模块中)

rglob() (pathlib.Path 方法)

richcmpfunc (C type)

right (filecmp.dircmp 属性)

right() (在 turtle 模块中)

right_list (filecmp.dircmp 属性)

right_only (filecmp.dircmp 属性)

RIGHTSHIFT() (在 token 模块中)

RIGHTSHIFTEQUAL() (在 token 模块中)

rindex() (bytearray 方法)

(bytes 方法)

(str 方法)

rjust() (bytearray 方法)

(bytes 方法)

(str 方法)

rlcompleter

模块

rlecode_hqx() (在 binascii 模块中)

rledecode_hqx() (在 binascii 模块中)

RLIM_INFINITY() (在 resource 模块中)

RLIMIT_AS() (在 resource 模块中)

RLIMIT_CORE() (在 resource 模块中)

RLIMIT_CPU() (在 resource 模块中)

RLIMIT_DATA() (在 resource 模块中)

RLIMIT_FSIZE() (在 resource 模块中)

RLIMIT_KQUEUES() (在 resource 模块中)

RLIMIT_MEMLOCK() (在 resource 模块中)

RLIMIT_MSGQUEUE() (在 resource 模块中)

RLIMIT_NICE() (在 resource 模块中)

RLIMIT_NOFILE() (在 resource 模块中)

RLIMIT_NPROC() (在 resource 模块中)

RLIMIT_NPTS() (在 resource 模块中)

RLIMIT_OFILE() (在 resource 模块中)

RLIMIT_RSS() (在 resource 模块中)

RLIMIT_RTPRIO() (在 resource 模块中)

RLIMIT_RTTIME() (在 resource 模块中)

RLIMIT_SBSIZE() (在 resource 模块中)

RLIMIT_SIGPENDING() (在 resource 模块中)

RLIMIT_STACK() (在 resource 模块中)

RLIMIT_SWAP() (在 resource 模块中)

RLIMIT_VMEM() (在 resource 模块中)

RLock (multiprocessing 中的类)

(threading 中的类)

RLock() (multiprocessing.managers.SyncManager 方法)

rmd() (ftplib.FTP 方法)

rmdir() (pathlib.Path 方法)

(在 os 模块中)

(在 test.support.os_helper 模块中)

RMFF

rms() (在 audioop 模块中)

rmtree() (在 shutil 模块中)

(在 test.support.os_helper 模块中)

RobotFileParser (urllib.robotparser 中的类)

robots.txt

rollback() (sqlite3.Connection 方法)

ROMAN() (在 tkinter.font 模块中)

root (pathlib.PurePath 属性)

ROT_FOUR (opcode)

ROT_N (opcode)

ROT_THREE (opcode)

ROT_TWO (opcode)

rotate() (collections.deque 方法)

(decimal.Context 方法)

(decimal.Decimal 方法)

(logging.handlers.BaseRotatingHandler 方法)

RotatingFileHandler (logging.handlers 中的类)

rotation_filename() (logging.handlers.BaseRotatingHandler 方法)

rotator (logging.handlers.BaseRotatingHandler 属性)

round

內置函数

round()

內置函数

ROUND_05UP() (在 decimal 模块中)

ROUND_CEILING() (在 decimal 模块中)

ROUND_DOWN() (在 decimal 模块中)

ROUND_FLOOR() (在 decimal 模块中)

ROUND_HALF_DOWN() (在 decimal 模块中)

ROUND_HALF_EVEN() (在 decimal 模块中)

ROUND_HALF_UP() (在 decimal 模块中)

ROUND_UP() (在 decimal 模块中)

Rounded (decimal 中的类)

Row (sqlite3 中的类)

row_factory (sqlite3.Connection 属性)

(sqlite3.Cursor 属性)

rowcount (sqlite3.Cursor 属性)

RPAR() (在 token 模块中)

rpartition() (bytearray 方法)

(bytes 方法)

(str 方法)

rpc_paths (xmlrpc.server.SimpleXMLRPCRequestHandler 属性)

rpop() (poplib.POP3 方法)

rset() (poplib.POP3 方法)

RShift (ast 中的类)

rshift() (在 operator 模块中)

rsplit() (bytearray 方法)

(bytes 方法)

(str 方法)

RSQB() (在 token 模块中)

rstrip() (bytearray 方法)

(bytes 方法)

(str 方法)

rt() (在 turtle 模块中)

RTLD_DEEPBIND() (在 os 模块中)

RTLD_GLOBAL() (在 os 模块中)

RTLD_LAZY() (在 os 模块中)

RTLD_LOCAL() (在 os 模块中)

RTLD_NODELETE() (在 os 模块中)

RTLD_NOLOAD() (在 os 模块中)

RTLD_NOW() (在 os 模块中)

ruler (cmd.Cmd 属性)

run (pdb command)

Run script

run() (bdb.Bdb 方法)

(contextvars.Context 方法)

(distutils.cmd.Command 方法)

(doctest.DocTestRunner 方法)

(multiprocessing.Process 方法)

(pdb.Pdb 方法)

(profile.Profile 方法)

(sched.scheduler 方法)

(test.support.BasicTestRunner 方法)

(threading.Thread 方法)

(trace.Trace 方法)

(unittest.IsolatedAsyncioTestCase 方法)

(unittest.TestCase 方法)

(unittest.TestSuite 方法)

(unittest.TextTestRunner 方法)

(wsgiref.handlers.BaseHandler 方法)

(在 asyncio 模块中)

(在 pdb 模块中)

(在 profile 模块中)

(在 subprocess 模块中)

run_coroutine_threadsafe() (在 asyncio 模块中)

run_docstring_examples() (在 doctest 模块中)

run_doctest() (在 test.support 模块中)

run_forever() (asyncio.loop 方法)

run_in_executor() (asyncio.loop 方法)

run_in_subinterp() (在 test.support 模块中)

run_module() (在 runpy 模块中)

run_path() (在 runpy 模块中)

run_python_until_end() (在 test.support.script_helper 模块中)

run_script() (modulefinder.ModuleFinder 方法)

run_setup() (在 distutils.core 模块中)

run_unittest() (在 test.support 模块中)

run_until_complete() (asyncio.loop 方法)

run_with_locale() (在 test.support 模块中)

run_with_tz() (在 test.support 模块中)

runcall() (bdb.Bdb 方法)

(pdb.Pdb 方法)

(profile.Profile 方法)

(在 pdb 模块中)

runcode() (code.InteractiveInterpreter 方法)

runctx() (bdb.Bdb 方法)

(profile.Profile 方法)

(trace.Trace 方法)

(在 profile 模块中)

runeval() (bdb.Bdb 方法)

(pdb.Pdb 方法)

(在 pdb 模块中)

runfunc() (trace.Trace 方法)

running() (concurrent.futures.Future 方法)

runpy

模块

runsource() (code.InteractiveInterpreter 方法)

runtime_checkable() (在 typing 模块中)

runtime_library_dir_option() (distutils.ccompiler.CCompiler 方法)

RuntimeError

RuntimeWarning

RUSAGE_BOTH() (在 resource 模块中)

RUSAGE_CHILDREN() (在 resource 模块中)

RUSAGE_SELF() (在 resource 模块中)

RUSAGE_THREAD() (在 resource 模块中)

RWF_APPEND() (在 os 模块中)

RWF_DSYNC() (在 os 模块中)

RWF_HIPRI() (在 os 模块中)

RWF_NOWAIT() (在 os 模块中)

RWF_SYNC() (在 os 模块中)

索引 – S

S() (在 re 模块中)

S_ENFMT() (在 stat 模块中)

S_IEXEC() (在 stat 模块中)

S_IFBLK() (在 stat 模块中)

S_IFCHR() (在 stat 模块中)

S_IFDIR() (在 stat 模块中)

S_IFDOOR() (在 stat 模块中)

S_IFIFO() (在 stat 模块中)

S_IFLNK() (在 stat 模块中)

S_IFMT() (在 stat 模块中)

S_IFPORT() (在 stat 模块中)

S_IFREG() (在 stat 模块中)

S_IFSOCK() (在 stat 模块中)

S_IFWHT() (在 stat 模块中)

S_IMODE() (在 stat 模块中)

S_IREAD() (在 stat 模块中)

S_IRGRP() (在 stat 模块中)

S_IROTH() (在 stat 模块中)

S_IRUSR() (在 stat 模块中)

S_IRWXG() (在 stat 模块中)

S_IRWXO() (在 stat 模块中)

S_IRWXU() (在 stat 模块中)

S_ISBLK() (在 stat 模块中)

S_ISCHR() (在 stat 模块中)

S_ISDIR() (在 stat 模块中)

S_ISDOOR() (在 stat 模块中)

S_ISFIFO() (在 stat 模块中)

S_ISGID() (在 stat 模块中)

S_ISLNK() (在 stat 模块中)

S_ISPORT() (在 stat 模块中)

S_ISREG() (在 stat 模块中)

S_ISSOCK() (在 stat 模块中)

S_ISUID() (在 stat 模块中)

S_ISVTX() (在 stat 模块中)

S_ISWHT() (在 stat 模块中)

S_IWGRP() (在 stat 模块中)

S_IWOTH() (在 stat 模块中)

S_IWRITE() (在 stat 模块中)

S_IWUSR() (在 stat 模块中)

S_IXGRP() (在 stat 模块中)

S_IXOTH() (在 stat 模块中)

S_IXUSR() (在 stat 模块中)

safe (uuid.SafeUUID 属性)

safe_substitute() (string.Template 方法)

SafeChildWatcher (asyncio 中的类)

saferepr() (在 pprint 模块中)

SafeUUID (uuid 中的类)

same_files (filecmp.dircmp 属性)

same_quantum() (decimal.Context 方法)

(decimal.Decimal 方法)

samefile() (pathlib.Path 方法)

(在 os.path 模块中)

SameFileError

sameopenfile() (在 os.path 模块中)

samestat() (在 os.path 模块中)

sample() (在 random 模块中)

samples() (statistics.NormalDist 方法)

SATURDAY() (在 calendar 模块中)

save() (http.cookiejar.FileCookieJar 方法)

(test.support.SaveSignals 方法)

SaveAs (tkinter.filedialog 中的类)

SAVEDCWD() (在 test.support.os_helper 模块中)

SaveFileDialog (tkinter.filedialog 中的类)

SaveKey() (在 winreg 模块中)

SaveSignals (test.support 中的类)

savetty() (在 curses 模块中)

SAX2DOM (xml.dom.pulldom 中的类)

SAXException

SAXNotRecognizedException

SAXNotSupportedException

SAXParseException

scaleb() (decimal.Context 方法)

(decimal.Decimal 方法)

scandir() (在 os 模块中)

scanf()

sched

模块

SCHED_BATCH() (在 os 模块中)

SCHED_FIFO() (在 os 模块中)

sched_get_priority_max() (在 os 模块中)

sched_get_priority_min() (在 os 模块中)

sched_getaffinity() (在 os 模块中)

sched_getparam() (在 os 模块中)

sched_getscheduler() (在 os 模块中)

SCHED_IDLE() (在 os 模块中)

SCHED_OTHER() (在 os 模块中)

sched_param (os 中的类)

sched_priority (os.sched_param 属性)

SCHED_RESET_ON_FORK() (在 os 模块中)

SCHED_RR() (在 os 模块中)

sched_rr_get_interval() (在 os 模块中)

sched_setaffinity() (在 os 模块中)

sched_setparam() (在 os 模块中)

sched_setscheduler() (在 os 模块中)

SCHED_SPORADIC() (在 os 模块中)

sched_yield() (在 os 模块中)

scheduler (sched 中的类)

schema() (在 msilib 模块中)

scope, [1]

scope_id (ipaddress.IPv6Address 属性)

Screen (turtle 中的类)

screensize() (在 turtle 模块中)

script_from_examples() (在 doctest 模块中)

scroll() (curses.window 方法)

ScrolledCanvas (turtle 中的类)

ScrolledText (tkinter.scrolledtext 中的类)

scrollok() (curses.window 方法)

scrypt() (在 hashlib 模块中)

sdterr

stdin stdout

seal() (在 unittest.mock 模块中)

search

path, module, [1], [2], [3], [4], [5], [6], [7]

search() (imaplib.IMAP4 方法)

(re.Pattern 方法)

(在 re 模块中)

second (datetime.datetime 属性)

(datetime.time 属性)

seconds since the epoch

secrets

模块

SECTCRE (configparser.ConfigParser 属性)

sections() (configparser.ConfigParser 方法)

secure (http.cookiejar.Cookie 属性)

secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512

Secure Sockets Layer

security

CGI

http.server

security considerations

security_level (ssl.SSLContext 属性)

see() (tkinter.ttk.Treeview 方法)

seed() (在 random 模块中)

seek() (chunk.Chunk 方法)

(io.IOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

SEEK_CUR() (在 os 模块中)

SEEK_END() (在 os 模块中)

SEEK_SET() (在 os 模块中)

seekable() (io.IOBase 方法)

seen_greeting (smtpd.SMTPChannel 属性)

select

模块

Select (tkinter.tix 中的类)

select() (imaplib.IMAP4 方法)

(selectors.BaseSelector 方法)

(tkinter.ttk.Notebook 方法)

(在 select 模块中)

selected_alpn_protocol() (ssl.SSLSocket 方法)

selected_npn_protocol() (ssl.SSLSocket 方法)

selection() (tkinter.ttk.Treeview 方法)

selection_add() (tkinter.ttk.Treeview 方法)

selection_remove() (tkinter.ttk.Treeview 方法)

selection_set() (tkinter.ttk.Treeview 方法)

selection_toggle() (tkinter.ttk.Treeview 方法)

selector (urllib.request.Request 属性)

SelectorEventLoop (asyncio 中的类)

SelectorKey (selectors 中的类)

selectors

模块

SelectSelector (selectors 中的类)

Semaphore (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

Semaphore() (multiprocessing.managers.SyncManager 方法)

semaphores, binary

SEMI() (在 token 模块中)

send() (asyncore.dispatcher 方法)

(coroutine 方法)

(generator 方法)

(http.client.HTTPConnection 方法)

(imaplib.IMAP4 方法)

(logging.handlers.DatagramHandler 方法)

(logging.handlers.SocketHandler 方法)

(multiprocessing.connection.Connection 方法)

(socket.socket 方法)

send_bytes() (multiprocessing.connection.Connection 方法)

send_error() (http.server.BaseHTTPRequestHandler 方法)

send_fds() (在 socket 模块中)

send_header() (http.server.BaseHTTPRequestHandler 方法)

send_message() (smtplib.SMTP 方法)

send_response() (http.server.BaseHTTPRequestHandler 方法)

send_response_only() (http.server.BaseHTTPRequestHandler 方法)

send_signal() (asyncio.subprocess.Process 方法)

(asyncio.SubprocessTransport 方法)

(subprocess.Popen 方法)

sendall() (socket.socket 方法)

sendcmd() (ftplib.FTP 方法)

sendfile() (asyncio.loop 方法)

(socket.socket 方法)

(wsgiref.handlers.BaseHandler 方法)

(在 os 模块中)

SendfileNotAvailableError

sendfunc (C type)

sendmail() (smtplib.SMTP 方法)

sendmsg() (socket.socket 方法)

sendmsg_afalg() (socket.socket 方法)

sendto() (asyncio.DatagramTransport 方法)

(socket.socket 方法)

sentinel (multiprocessing.Process 属性)

sentinel() (在 unittest.mock 模块中)

sep() (在 os 模块中)

sequence

item

iteration

types, immutable

types, mutable

types, operations on, [1]

对象, [1], [2], [3], [4], [5], [6], [7], [8]

Sequence (collections.abc 中的类)

(typing 中的类)

sequence() (在 msilib 模块中)

SequenceMatcher (difflib 中的类)

serializing

objects

serve_forever() (asyncio.Server 方法)

(socketserver.BaseServer 方法)

server

WWW, [1]

Server (asyncio 中的类)

server (http.server.BaseHTTPRequestHandler 属性)

server_activate() (socketserver.BaseServer 方法)

server_address (socketserver.BaseServer 属性)

server_bind() (socketserver.BaseServer 方法)

server_close() (socketserver.BaseServer 方法)

server_hostname (ssl.SSLSocket 属性)

server_side (ssl.SSLSocket 属性)

server_software (wsgiref.handlers.BaseHandler 属性)

server_version (http.server.BaseHTTPRequestHandler 属性)

(http.server.SimpleHTTPRequestHandler 属性)

ServerProxy (xmlrpc.client 中的类)

service_actions() (socketserver.BaseServer 方法)

session (ssl.SSLSocket 属性)

session_reused (ssl.SSLSocket 属性)

session_stats() (ssl.SSLContext 方法)

set

comprehensions

display

对象, [1], [2], [3]

Set (ast 中的类)

(collections.abc 中的类)

(typing 中的类)

set (內置类)

Set Breakpoint

set comprehension -- 集合推导式

set type

对象

set() (asyncio.Event 方法)

(configparser.ConfigParser 方法)

(configparser.RawConfigParser 方法)

(contextvars.ContextVar 方法)

(http.cookies.Morsel 方法)

(ossaudiodev.oss_mixer_device 方法)

(test.support.os_helper.EnvironmentVarGuard 方法)

(threading.Event 方法)

(tkinter.ttk.Combobox 方法)

(tkinter.ttk.Spinbox 方法)

(tkinter.ttk.Treeview 方法)

(xml.etree.ElementTree.Element 方法)

SET_ADD (opcode)

set_all()

set_allowed_domains() (http.cookiejar.DefaultCookiePolicy 方法)

set_alpn_protocols() (ssl.SSLContext 方法)

set_app() (wsgiref.simple_server.WSGIServer 方法)

set_asyncgen_hooks() (在 sys 模块中)

set_authorizer() (sqlite3.Connection 方法)

set_auto_history() (在 readline 模块中)

set_blocked_domains() (http.cookiejar.DefaultCookiePolicy 方法)

set_blocking() (在 os 模块中)

set_boundary() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_break() (bdb.Bdb 方法)

set_charset() (email.message.Message 方法)

set_child_watcher() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

set_children() (tkinter.ttk.Treeview 方法)

set_ciphers() (ssl.SSLContext 方法)

set_completer() (在 readline 模块中)

set_completer_delims() (在 readline 模块中)

set_completion_display_matches_hook() (在 readline 模块中)

set_content() (email.contentmanager.ContentManager 方法)

(email.message.EmailMessage 方法)

(在 email.contentmanager 模块中)

set_continue() (bdb.Bdb 方法)

set_cookie() (http.cookiejar.CookieJar 方法)

set_cookie_if_ok() (http.cookiejar.CookieJar 方法)

set_coroutine_origin_tracking_depth() (在 sys 模块中)

set_current() (msilib.Feature 方法)

set_data() (importlib.abc.SourceLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

set_date() (mailbox.MaildirMessage 方法)

set_debug() (asyncio.loop 方法)

(在 gc 模块中)

set_debuglevel() (ftplib.FTP 方法)

(http.client.HTTPConnection 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

(smtplib.SMTP 方法)

(telnetlib.Telnet 方法)

set_default_executor() (asyncio.loop 方法)

set_default_type() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_default_verify_paths() (ssl.SSLContext 方法)

set_defaults() (argparse.ArgumentParser 方法)

(optparse.OptionParser 方法)

set_ecdh_curve() (ssl.SSLContext 方法)

set_errno() (在 ctypes 模块中)

set_escdelay() (在 curses 模块中)

set_event_loop() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

set_event_loop_policy() (在 asyncio 模块中)

set_exception() (asyncio.Future 方法)

(concurrent.futures.Future 方法)

set_exception_handler() (asyncio.loop 方法)

set_executable() (在 multiprocessing 模块中)

set_executables() (distutils.ccompiler.CCompiler 方法)

set_filter() (tkinter.filedialog.FileDialog 方法)

set_flags() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

set_from() (mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

set_handle_inheritable() (在 os 模块中)

set_history_length() (在 readline 模块中)

set_include_dirs() (distutils.ccompiler.CCompiler 方法)

set_info() (mailbox.MaildirMessage 方法)

set_inheritable() (socket.socket 方法)

(在 os 模块中)

set_int_max_str_digits() (在 sys 模块中)

set_labels() (mailbox.BabylMessage 方法)

set_last_error() (在 ctypes 模块中)

set_libraries() (distutils.ccompiler.CCompiler 方法)

set_library_dirs() (distutils.ccompiler.CCompiler 方法)

set_link_objects() (distutils.ccompiler.CCompiler 方法)

set_literal (2to3 fixer)

set_loader() (在 importlib.util 模块中)

set_match_tests() (在 test.support 模块中)

set_memlimit() (在 test.support 模块中)

set_name() (asyncio.Task 方法)

set_next() (bdb.Bdb 方法)

set_nonstandard_attr() (http.cookiejar.Cookie 方法)

set_npn_protocols() (ssl.SSLContext 方法)

set_ok() (http.cookiejar.CookiePolicy 方法)

set_option_negotiation_callback() (telnetlib.Telnet 方法)

set_output_charset() (gettext.NullTranslations 方法)

set_package() (在 importlib.util 模块中)

set_param() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_pasv() (ftplib.FTP 方法)

set_payload() (email.message.Message 方法)

set_policy() (http.cookiejar.CookieJar 方法)

set_position() (xdrlib.Unpacker 方法)

set_pre_input_hook() (在 readline 模块中)

set_progress_handler() (sqlite3.Connection 方法)

set_protocol() (asyncio.BaseTransport 方法)

set_proxy() (urllib.request.Request 方法)

set_python_build() (在 distutils.sysconfig 模块中)

set_quit() (bdb.Bdb 方法)

set_recsrc() (ossaudiodev.oss_mixer_device 方法)

set_result() (asyncio.Future 方法)

(concurrent.futures.Future 方法)

set_return() (bdb.Bdb 方法)

set_running_or_notify_cancel() (concurrent.futures.Future 方法)

set_runtime_library_dirs() (distutils.ccompiler.CCompiler 方法)

set_selection() (tkinter.filedialog.FileDialog 方法)

set_seq1() (difflib.SequenceMatcher 方法)

set_seq2() (difflib.SequenceMatcher 方法)

set_seqs() (difflib.SequenceMatcher 方法)

set_sequences() (mailbox.MH 方法)

(mailbox.MHMessage 方法)

set_server_documentation() (xmlrpc.server.DocCGIXMLRPCRequestHandler 方法)

(xmlrpc.server.DocXMLRPCServer 方法)

set_server_name() (xmlrpc.server.DocCGIXMLRPCRequestHandler 方法)

(xmlrpc.server.DocXMLRPCServer 方法)

set_server_title() (xmlrpc.server.DocCGIXMLRPCRequestHandler 方法)

(xmlrpc.server.DocXMLRPCServer 方法)

set_servername_callback (ssl.SSLContext 属性)

set_start_method() (在 multiprocessing 模块中)

set_startup_hook() (在 readline 模块中)

set_step() (bdb.Bdb 方法)

set_subdir() (mailbox.MaildirMessage 方法)

set_tabsize() (在 curses 模块中)

set_task_factory() (asyncio.loop 方法)

set_terminator() (asynchat.async_chat 方法)

set_threshold() (在 gc 模块中)

set_trace() (bdb.Bdb 方法)

(pdb.Pdb 方法)

(在 bdb 模块中)

(在 pdb 模块中)

set_trace_callback() (sqlite3.Connection 方法)

set_tunnel() (http.client.HTTPConnection 方法)

set_type() (email.message.Message 方法)

set_unittest_reportflags() (在 doctest 模块中)

set_unixfrom() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_until() (bdb.Bdb 方法)

SET_UPDATE (opcode)

set_url() (urllib.robotparser.RobotFileParser 方法)

set_usage() (optparse.OptionParser 方法)

set_userptr() (curses.panel.Panel 方法)

set_visible() (mailbox.BabylMessage 方法)

set_wakeup_fd() (在 signal 模块中)

set_write_buffer_limits() (asyncio.WriteTransport 方法)

setacl() (imaplib.IMAP4 方法)

SetAllocTrackerActivationThreshold() (xml.parsers.expat.xmlparser 方法)

SetAllocTrackerMaximumAmplification() (xml.parsers.expat.xmlparser 方法)

setannotation() (imaplib.IMAP4 方法)

setattr()

內置函数

setattrfunc (C type)

setAttribute() (xml.dom.Element 方法)

setAttributeNode() (xml.dom.Element 方法)

setAttributeNodeNS() (xml.dom.Element 方法)

setAttributeNS() (xml.dom.Element 方法)

setattrofunc (C type)

SetBase() (xml.parsers.expat.xmlparser 方法)

setblocking() (socket.socket 方法)

setByteStream() (xml.sax.xmlreader.InputSource 方法)

setcbreak() (在 tty 模块中)

setCharacterStream() (xml.sax.xmlreader.InputSource 方法)

SetComp (ast 中的类)

setcomptype() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setContentHandler() (xml.sax.xmlreader.XMLReader 方法)

setcontext() (在 decimal 模块中)

setDaemon() (threading.Thread 方法)

setdefault() (dict 方法)

(http.cookies.Morsel 方法)

setdefaulttimeout() (在 socket 模块中)

setdlopenflags() (在 sys 模块中)

setDocumentLocator() (xml.sax.handler.ContentHandler 方法)

setDTDHandler() (xml.sax.xmlreader.XMLReader 方法)

setegid() (在 os 模块中)

setEncoding() (xml.sax.xmlreader.InputSource 方法)

setEntityResolver() (xml.sax.xmlreader.XMLReader 方法)

setErrorHandler() (xml.sax.xmlreader.XMLReader 方法)

seteuid() (在 os 模块中)

setFeature() (xml.sax.xmlreader.XMLReader 方法)

setfirstweekday() (在 calendar 模块中)

setfmt() (ossaudiodev.oss_audio_device 方法)

setFormatter() (logging.Handler 方法)

setframerate() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setgid() (在 os 模块中)

setgroups() (在 os 模块中)

seth() (在 turtle 模块中)

setheading() (在 turtle 模块中)

sethostname() (在 socket 模块中)

setinputsizes() (sqlite3.Cursor 方法)

SetInteger() (msilib.Record 方法)

setitem() (在 operator 模块中)

setitimer() (在 signal 模块中)

setLevel() (logging.Handler 方法)

(logging.Logger 方法)

setLocale() (xml.sax.xmlreader.XMLReader 方法)

setlocale() (在 locale 模块中)

setLoggerClass() (在 logging 模块中)

setlogmask() (在 syslog 模块中)

setLogRecordFactory() (在 logging 模块中)

setmark() (aifc.aifc 方法)

setMaxConns() (urllib.request.CacheFTPHandler 方法)

setmode() (在 msvcrt 模块中)

setName() (threading.Thread 方法)

setnchannels() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setnframes() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setoutputsize() (sqlite3.Cursor 方法)

SetParamEntityParsing() (xml.parsers.expat.xmlparser 方法)

setparameters() (ossaudiodev.oss_audio_device 方法)

setparams() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setpassword() (zipfile.ZipFile 方法)

setpgid() (在 os 模块中)

setpgrp() (在 os 模块中)

setpos() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

(在 turtle 模块中)

setposition() (在 turtle 模块中)

setpriority() (在 os 模块中)

setprofile() (在 sys 模块中)

(在 threading 模块中)

SetProperty() (msilib.SummaryInformation 方法)

setProperty() (xml.sax.xmlreader.XMLReader 方法)

setPublicId() (xml.sax.xmlreader.InputSource 方法)

setquota() (imaplib.IMAP4 方法)

setraw() (在 tty 模块中)

setrecursionlimit() (在 sys 模块中)

setregid() (在 os 模块中)

SetReparseDeferralEnabled() (xml.parsers.expat.xmlparser 方法)

setresgid() (在 os 模块中)

setresuid() (在 os 模块中)

setreuid() (在 os 模块中)

setrlimit() (在 resource 模块中)

setsampwidth() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setscrreg() (curses.window 方法)

setsid() (在 os 模块中)

setsockopt() (socket.socket 方法)

setstate() (codecs.IncrementalDecoder 方法)

(codecs.IncrementalEncoder 方法)

(在 random 模块中)

setStream() (logging.StreamHandler 方法)

SetStream() (msilib.Record 方法)

SetString() (msilib.Record 方法)

setswitchinterval() (in module sys)

(在 sys 模块中)

(在 test.support 模块中)

setSystemId() (xml.sax.xmlreader.InputSource 方法)

setsyx() (在 curses 模块中)

setTarget() (logging.handlers.MemoryHandler 方法)

settiltangle() (在 turtle 模块中)

settimeout() (socket.socket 方法)

setTimeout() (urllib.request.CacheFTPHandler 方法)

settrace() (在 sys 模块中)

(在 threading 模块中)

setuid() (在 os 模块中)

setundobuffer() (在 turtle 模块中)

setup() (socketserver.BaseRequestHandler 方法)

setUp() (unittest.TestCase 方法)

setup() (在 distutils.core 模块中)

(在 turtle 模块中)

SETUP_ANNOTATIONS (opcode)

SETUP_ASYNC_WITH (opcode)

setup_environ() (wsgiref.handlers.BaseHandler 方法)

SETUP_FINALLY (opcode)

setup_python() (venv.EnvBuilder 方法)

setup_scripts() (venv.EnvBuilder 方法)

setup_testing_defaults() (在 wsgiref.util 模块中)

SETUP_WITH (opcode)

setUpClass() (unittest.TestCase 方法)

setupterm() (在 curses 模块中)

SetValue() (在 winreg 模块中)

SetValueEx() (在 winreg 模块中)

setworldcoordinates() (在 turtle 模块中)

setx() (在 turtle 模块中)

setxattr() (在 os 模块中)

sety() (在 turtle 模块中)

SF_APPEND() (在 stat 模块中)

SF_ARCHIVED() (在 stat 模块中)

SF_IMMUTABLE() (在 stat 模块中)

SF_MNOWAIT() (在 os 模块中)

SF_NODISKIO() (在 os 模块中)

SF_NOUNLINK() (在 stat 模块中)

SF_SNAPSHOT() (在 stat 模块中)

SF_SYNC() (在 os 模块中)

shape (memoryview 属性)

Shape (turtle 中的类)

shape() (在 turtle 模块中)

shapesize() (在 turtle 模块中)

shapetransform() (在 turtle 模块中)

share() (socket.socket 方法)

ShareableList (multiprocessing.shared_memory 中的类)

ShareableList() (multiprocessing.managers.SharedMemoryManager 方法)

Shared Memory

shared_ciphers() (ssl.SSLSocket 方法)

shared_object_filename() (distutils.ccompiler.CCompiler 方法)

SharedMemory (multiprocessing.shared_memory 中的类)

SharedMemory() (multiprocessing.managers.SharedMemoryManager 方法)

SharedMemoryManager (multiprocessing.managers 中的类)

shearfactor() (在 turtle 模块中)

Shelf (shelve 中的类)

shelve

模块, [1]

shield() (在 asyncio 模块中)

shift() (decimal.Context 方法)

(decimal.Decimal 方法)

shift_path_info() (在 wsgiref.util 模块中)

shifting

operation

operations

shlex

模块

shlex (shlex 中的类)

shm (multiprocessing.shared_memory.ShareableList 属性)

SHORT_TIMEOUT() (在 test.support 模块中)

shortDescription() (unittest.TestCase 方法)

shorten() (在 textwrap 模块中)

shouldFlush() (logging.handlers.BufferingHandler 方法)

(logging.handlers.MemoryHandler 方法)

shouldStop (unittest.TestResult 属性)

show() (curses.panel.Panel 方法)

(tkinter.commondialog.Dialog 方法)

show_code() (在 dis 模块中)

show_compilers() (在 distutils.ccompiler 模块中)

showerror() (在 tkinter.messagebox 模块中)

showinfo() (在 tkinter.messagebox 模块中)

showsyntaxerror() (code.InteractiveInterpreter 方法)

showtraceback() (code.InteractiveInterpreter 方法)

showturtle() (在 turtle 模块中)

showwarning() (在 tkinter.messagebox 模块中)

(在 warnings 模块中)

shuffle() (在 random 模块中)

shutdown() (concurrent.futures.Executor 方法)

(imaplib.IMAP4 方法)

(multiprocessing.managers.BaseManager 方法)

(socket.socket 方法)

(socketserver.BaseServer 方法)

(在 logging 模块中)

shutdown_asyncgens() (asyncio.loop 方法)

shutdown_default_executor() (asyncio.loop 方法)

shutil

模块

side_effect (unittest.mock.Mock 属性)

SIG_BLOCK() (在 signal 模块中)

SIG_DFL() (在 signal 模块中)

SIG_IGN() (在 signal 模块中)

SIG_SETMASK() (在 signal 模块中)

SIG_UNBLOCK() (在 signal 模块中)

SIGABRT() (在 signal 模块中)

SIGALRM() (在 signal 模块中)

SIGBREAK() (在 signal 模块中)

SIGBUS() (在 signal 模块中)

SIGCHLD() (在 signal 模块中)

SIGCLD() (在 signal 模块中)

SIGCONT() (在 signal 模块中)

SIGFPE() (在 signal 模块中)

SIGHUP() (在 signal 模块中)

SIGILL() (在 signal 模块中)

SIGINT, [1]

SIGINT() (在 signal 模块中)

siginterrupt() (在 signal 模块中)

SIGKILL() (在 signal 模块中)

signal

模块, [1], [2], [3], [4]

signal() (在 signal 模块中)

Signature (inspect 中的类)

signature (inspect.BoundArguments 属性)

signature() (在 inspect 模块中)

sigpending() (在 signal 模块中)

SIGPIPE() (在 signal 模块中)

SIGSEGV() (在 signal 模块中)

SIGTERM() (在 signal 模块中)

sigtimedwait() (在 signal 模块中)

SIGUSR1() (在 signal 模块中)

SIGUSR2() (在 signal 模块中)

sigwait() (在 signal 模块中)

sigwaitinfo() (在 signal 模块中)

SIGWINCH() (在 signal 模块中)

simple

statement

Simple Mail Transfer Protocol

SimpleCookie (http.cookies 中的类)

simplefilter() (在 warnings 模块中)

SimpleHandler (wsgiref.handlers 中的类)

SimpleHTTPRequestHandler (http.server 中的类)

SimpleNamespace (types 中的类)

SimpleQueue (multiprocessing 中的类)

(queue 中的类)

SimpleXMLRPCRequestHandler (xmlrpc.server 中的类)

SimpleXMLRPCServer (xmlrpc.server 中的类)

sin() (在 cmath 模块中)

(在 math 模块中)

single dispatch -- 单分派

SingleAddressHeader (email.headerregistry 中的类)

singledispatch() (在 functools 模块中)

singledispatchmethod (functools 中的类)

singleton

tuple

sinh() (在 cmath 模块中)

(在 math 模块中)

SIO_KEEPALIVE_VALS() (在 socket 模块中)

SIO_LOOPBACK_FAST_PATH() (在 socket 模块中)

SIO_RCVALL() (在 socket 模块中)

site

模块

site command line option

--user-base

--user-site

site-packages

directory

site_maps() (urllib.robotparser.RobotFileParser 方法)

sitecustomize

模块

sixtofour (ipaddress.IPv6Address 属性)

size (multiprocessing.shared_memory.SharedMemory 属性)

(struct.Struct 属性)

(tarfile.TarInfo 属性)

(tracemalloc.Statistic 属性)

(tracemalloc.StatisticDiff 属性)

(tracemalloc.Trace 属性)

size() (ftplib.FTP 方法)

(mmap.mmap 方法)

size_diff (tracemalloc.StatisticDiff 属性)

SIZE_MAX

Sized (collections.abc 中的类)

(typing 中的类)

sizeof() (在 ctypes 模块中)

skip() (chunk.Chunk 方法)

SKIP() (在 doctest 模块中)

skip() (在 unittest 模块中)

skip_if_broken_multiprocessing_synchronize() (在 test.support 模块中)

skip_unless_bind_unix_socket() (在 test.support.socket_helper 模块中)

skip_unless_symlink() (在 test.support.os_helper 模块中)

skip_unless_xattr() (在 test.support.os_helper 模块中)

skipIf() (在 unittest 模块中)

skipinitialspace (csv.Dialect 属性)

skipped (unittest.TestResult 属性)

skippedEntity() (xml.sax.handler.ContentHandler 方法)

SkipTest

skipTest() (unittest.TestCase 方法)

skipUnless() (在 unittest 模块中)

SLASH() (在 token 模块中)

SLASHEQUAL() (在 token 模块中)

slave() (nntplib.NNTP 方法)

sleep() (在 asyncio 模块中)

(在 time 模块中)

slice

assignment

operation

內置函数, [1]

对象

Slice (ast 中的类)

slice (內置类)

slice -- 切片

slicing, [1], [2]

assignment

SMALLEST() (在 test.support 模块中)

SMTP

protocol

SMTP (smtplib 中的类)

SMTP() (在 email.policy 模块中)

smtp_server (smtpd.SMTPChannel 属性)

SMTP_SSL (smtplib 中的类)

smtp_state (smtpd.SMTPChannel 属性)

SMTPAuthenticationError

SMTPChannel (smtpd 中的类)

SMTPConnectError

smtpd

模块

SMTPDataError

SMTPException

SMTPHandler (logging.handlers 中的类)

SMTPHeloError

smtplib

模块

SMTPNotSupportedError

SMTPRecipientsRefused

SMTPResponseException

SMTPSenderRefused

SMTPServer (smtpd 中的类)

SMTPServerDisconnected

SMTPUTF8() (在 email.policy 模块中)

Snapshot (tracemalloc 中的类)

SND_ALIAS() (在 winsound 模块中)

SND_ASYNC() (在 winsound 模块中)

SND_FILENAME() (在 winsound 模块中)

SND_LOOP() (在 winsound 模块中)

SND_MEMORY() (在 winsound 模块中)

SND_NODEFAULT() (在 winsound 模块中)

SND_NOSTOP() (在 winsound 模块中)

SND_NOWAIT() (在 winsound 模块中)

SND_PURGE() (在 winsound 模块中)

sndhdr

模块

sni_callback (ssl.SSLContext 属性)

sniff() (csv.Sniffer 方法)

Sniffer (csv 中的类)

sock_accept() (asyncio.loop 方法)

SOCK_CLOEXEC() (在 socket 模块中)

sock_connect() (asyncio.loop 方法)

SOCK_DGRAM() (在 socket 模块中)

SOCK_MAX_SIZE() (在 test.support 模块中)

SOCK_NONBLOCK() (在 socket 模块中)

SOCK_RAW() (在 socket 模块中)

SOCK_RDM() (在 socket 模块中)

sock_recv() (asyncio.loop 方法)

sock_recv_into() (asyncio.loop 方法)

sock_sendall() (asyncio.loop 方法)

sock_sendfile() (asyncio.loop 方法)

SOCK_SEQPACKET() (在 socket 模块中)

SOCK_STREAM() (在 socket 模块中)

socket

对象

模块, [1]

socket (socket 中的类)

(socketserver.BaseServer 属性)

socket() (imaplib.IMAP4 方法)

(in module socket)

socket_type (socketserver.BaseServer 属性)

SocketHandler (logging.handlers 中的类)

socketpair() (在 socket 模块中)

sockets (asyncio.Server 属性)

socketserver

模块

SocketType() (在 socket 模块中)

soft keyword

SOFT_KEYWORD() (在 token 模块中)

softkwlist() (在 keyword 模块中)

SOL_ALG() (在 socket 模块中)

SOL_RDS() (在 socket 模块中)

SOMAXCONN() (在 socket 模块中)

sort() (imaplib.IMAP4 方法)

(list 方法)

sort_stats() (pstats.Stats 方法)

sortdict() (在 test.support 模块中)

sorted()

內置函数

sortTestMethodsUsing (unittest.TestLoader 属性)

source (doctest.Example 属性)

(pdb command)

(shlex.shlex 属性)

source character set

SOURCE_DATE_EPOCH, [1], [2], [3], [4], [5], [6]

source_from_cache() (在 imp 模块中)

(在 importlib.util 模块中)

source_hash() (在 importlib.util 模块中)

SOURCE_SUFFIXES() (在 importlib.machinery 模块中)

source_to_code() (importlib.abc.InspectLoader 静态方法)

SourceFileLoader (importlib.machinery 中的类)

sourcehook() (shlex.shlex 方法)

SourcelessFileLoader (importlib.machinery 中的类)

SourceLoader (importlib.abc 中的类)

space

in printf-style formatting, [1]

in string formatting

span() (re.Match 方法)

spawn() (distutils.ccompiler.CCompiler 方法)

(在 pty 模块中)

spawn_python() (在 test.support.script_helper 模块中)

spawnl() (在 os 模块中)

spawnle() (在 os 模块中)

spawnlp() (在 os 模块中)

spawnlpe() (在 os 模块中)

spawnv() (在 os 模块中)

spawnve() (在 os 模块中)

spawnvp() (在 os 模块中)

spawnvpe() (在 os 模块中)

spec_from_file_location() (在 importlib.util 模块中)

spec_from_loader() (在 importlib.util 模块中)

special

attribute

attribute, generic

method

special method -- 特殊方法

SpecialFileError

specified_attributes (xml.parsers.expat.xmlparser 属性)

speed() (ossaudiodev.oss_audio_device 方法)

(在 turtle 模块中)

Spinbox (tkinter.ttk 中的类)

splice() (在 os 模块中)

SPLICE_F_MORE() (在 os 模块中)

SPLICE_F_MOVE() (在 os 模块中)

SPLICE_F_NONBLOCK() (在 os 模块中)

split() (bytearray 方法)

(bytes 方法)

(re.Pattern 方法)

(str 方法)

(在 os.path 模块中)

(在 re 模块中)

(在 shlex 模块中)

split_quoted() (在 distutils.util 模块中)

splitdrive() (在 os.path 模块中)

splitext() (在 os.path 模块中)

splitlines() (bytearray 方法)

(bytes 方法)

(str 方法)

SplitResult (urllib.parse 中的类)

SplitResultBytes (urllib.parse 中的类)

SpooledTemporaryFile (tempfile 中的类)

sprintf-style formatting, [1]

spwd

模块

sqlite3

模块

SQLITE_DENY() (在 sqlite3 模块中)

SQLITE_IGNORE() (在 sqlite3 模块中)

SQLITE_OK() (在 sqlite3 模块中)

sqlite_version() (在 sqlite3 模块中)

sqlite_version_info() (在 sqlite3 模块中)

sqrt() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 cmath 模块中)

(在 math 模块中)

ssizeargfunc (C type)

ssizeobjargproc (C type)

SSL

ssl

模块

ssl_version (ftplib.FTP_TLS 属性)

SSLCertVerificationError

SSLContext (ssl 中的类)

SSLEOFError

SSLError

SSLErrorNumber (ssl 中的类)

SSLKEYLOGFILE, [1]

SSLObject (ssl 中的类)

sslobject_class (ssl.SSLContext 属性)

SSLSession (ssl 中的类)

SSLSocket (ssl 中的类)

sslsocket_class (ssl.SSLContext 属性)

SSLSyscallError

SSLv3 (ssl.TLSVersion 属性)

SSLWantReadError

SSLWantWriteError

SSLZeroReturnError

st() (在 turtle 模块中)

st_atime (os.stat_result 属性)

ST_ATIME() (在 stat 模块中)

st_atime_ns (os.stat_result 属性)

st_birthtime (os.stat_result 属性)

st_blksize (os.stat_result 属性)

st_blocks (os.stat_result 属性)

st_creator (os.stat_result 属性)

st_ctime (os.stat_result 属性)

ST_CTIME() (在 stat 模块中)

st_ctime_ns (os.stat_result 属性)

st_dev (os.stat_result 属性)

ST_DEV() (在 stat 模块中)

st_file_attributes (os.stat_result 属性)

st_flags (os.stat_result 属性)

st_fstype (os.stat_result 属性)

st_gen (os.stat_result 属性)

st_gid (os.stat_result 属性)

ST_GID() (在 stat 模块中)

st_ino (os.stat_result 属性)

ST_INO() (在 stat 模块中)

st_mode (os.stat_result 属性)

ST_MODE() (在 stat 模块中)

st_mtime (os.stat_result 属性)

ST_MTIME() (在 stat 模块中)

st_mtime_ns (os.stat_result 属性)

st_nlink (os.stat_result 属性)

ST_NLINK() (在 stat 模块中)

st_rdev (os.stat_result 属性)

st_reparse_tag (os.stat_result 属性)

st_rsize (os.stat_result 属性)

st_size (os.stat_result 属性)

ST_SIZE() (在 stat 模块中)

st_type (os.stat_result 属性)

st_uid (os.stat_result 属性)

ST_UID() (在 stat 模块中)

stack

execution

trace

stack (traceback.TracebackException 属性)

stack viewer

stack() (在 inspect 模块中)

stack_effect() (在 dis 模块中)

stack_size() (在 _thread 模块中)

(在 threading 模块中)

stackable

streams

StackSummary (traceback 中的类)

stamp() (在 turtle 模块中)

standard

output

Standard C

standard input

standard_b64decode() (在 base64 模块中)

standard_b64encode() (在 base64 模块中)

standarderror (2to3 fixer)

standend() (curses.window 方法)

standout() (curses.window 方法)

STAR() (在 token 模块中)

STAREQUAL() (在 token 模块中)

starmap() (multiprocessing.pool.Pool 方法)

(在 itertools 模块中)

starmap_async() (multiprocessing.pool.Pool 方法)

Starred (ast 中的类)

start (range 属性)

(slice object attribute), [1]

(UnicodeError 属性)

start() (logging.handlers.QueueListener 方法)

(multiprocessing.managers.BaseManager 方法)

(multiprocessing.Process 方法)

(re.Match 方法)

(threading.Thread 方法)

(tkinter.ttk.Progressbar 方法)

(xml.etree.ElementTree.TreeBuilder 方法)

(在 tracemalloc 模块中)

start_color() (在 curses 模块中)

start_component() (msilib.Directory 方法)

start_new_thread() (在 _thread 模块中)

start_ns() (xml.etree.ElementTree.TreeBuilder 方法)

start_server() (在 asyncio 模块中)

start_serving() (asyncio.Server 方法)

start_threads() (在 test.support.threading_helper 模块中)

start_tls() (asyncio.loop 方法)

start_unix_server() (在 asyncio 模块中)

startCDATA() (xml.sax.handler.LexicalHandler 方法)

StartCdataSectionHandler() (xml.parsers.expat.xmlparser 方法)

StartDoctypeDeclHandler() (xml.parsers.expat.xmlparser 方法)

startDocument() (xml.sax.handler.ContentHandler 方法)

startDTD() (xml.sax.handler.LexicalHandler 方法)

startElement() (xml.sax.handler.ContentHandler 方法)

StartElementHandler() (xml.parsers.expat.xmlparser 方法)

startElementNS() (xml.sax.handler.ContentHandler 方法)

STARTF_USESHOWWINDOW() (在 subprocess 模块中)

STARTF_USESTDHANDLES() (在 subprocess 模块中)

startfile() (在 os 模块中)

StartNamespaceDeclHandler() (xml.parsers.expat.xmlparser 方法)

startPrefixMapping() (xml.sax.handler.ContentHandler 方法)

startswith() (bytearray 方法)

(bytes 方法)

(str 方法)

startTest() (unittest.TestResult 方法)

startTestRun() (unittest.TestResult 方法)

starttls() (imaplib.IMAP4 方法)

(nntplib.NNTP 方法)

(smtplib.SMTP 方法)

STARTUPINFO (subprocess 中的类)

stat

模块, [1]

stat() (nntplib.NNTP 方法)

(os.DirEntry 方法)

(pathlib.Path 方法)

(poplib.POP3 方法)

(在 os 模块中)

stat_result (os 中的类)

state() (tkinter.ttk.Widget 方法)

statement

assignment, [1]

assignment, annotated

assignment, augmented

compound

expression

future

loop, [1], [2], [3]

simple

statement -- 语句

statement grouping

static_order() (graphlib.TopologicalSorter 方法)

staticmethod

內置函数

staticmethod()

內置函数

Statistic (tracemalloc 中的类)

StatisticDiff (tracemalloc 中的类)

statistics

模块

statistics() (tracemalloc.Snapshot 方法)

StatisticsError

Stats (pstats 中的类)

status (http.client.HTTPResponse 属性)

(urllib.response.addinfourl 属性)

status() (imaplib.IMAP4 方法)

statvfs() (在 os 模块中)

STD_ERROR_HANDLE() (在 subprocess 模块中)

STD_INPUT_HANDLE() (在 subprocess 模块中)

STD_OUTPUT_HANDLE() (在 subprocess 模块中)

StdButtonBox (tkinter.tix 中的类)

stderr (asyncio.subprocess.Process 属性)

(in module sys), [1]

(subprocess.CalledProcessError 属性)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

(subprocess.TimeoutExpired 属性)

stderr() (在 sys 模块中)

stdev (statistics.NormalDist 属性)

stdev() (在 statistics 模块中)

stdin

stdout sdterr

stdin (asyncio.subprocess.Process 属性)

(in module sys), [1]

(subprocess.Popen 属性)

stdin() (在 sys 模块中)

stdio

stdlib_module_names() (在 sys 模块中)

stdout

sdterr, stdin

stdout (asyncio.subprocess.Process 属性)

(in module sys), [1]

(subprocess.CalledProcessError 属性)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

(subprocess.TimeoutExpired 属性)

STDOUT() (在 subprocess 模块中)

stdout() (在 sys 模块中)

stem (pathlib.PurePath 属性)

step (pdb command)

(range 属性)

(slice object attribute), [1]

step() (tkinter.ttk.Progressbar 方法)

stereocontrols() (ossaudiodev.oss_mixer_device 方法)

stls() (poplib.POP3 方法)

stop (range 属性)

(slice object attribute), [1]

stop() (asyncio.loop 方法)

(logging.handlers.QueueListener 方法)

(tkinter.ttk.Progressbar 方法)

(unittest.TestResult 方法)

(在 tracemalloc 模块中)

stop_here() (bdb.Bdb 方法)

StopAsyncIteration

例外

StopIteration

例外, [1]

stopListening() (在 logging.config 模块中)

stopTest() (unittest.TestResult 方法)

stopTestRun() (unittest.TestResult 方法)

storbinary() (ftplib.FTP 方法)

Store (ast 中的类)

store() (imaplib.IMAP4 方法)

STORE_ACTIONS (optparse.Option 属性)

STORE_ATTR (opcode)

STORE_DEREF (opcode)

STORE_FAST (opcode)

STORE_GLOBAL (opcode)

STORE_NAME (opcode)

STORE_SUBSCR (opcode)

storlines() (ftplib.FTP 方法)

str (built-in class)

(see also string)

str (內置类)

str() (在 locale 模块中)

strcoll() (在 locale 模块中)

StreamError

StreamHandler (logging 中的类)

StreamReader (asyncio 中的类)

(codecs 中的类)

streamreader (codecs.CodecInfo 属性)

StreamReaderWriter (codecs 中的类)

StreamRecoder (codecs 中的类)

StreamRequestHandler (socketserver 中的类)

streams

stackable

StreamWriter (asyncio 中的类)

(codecs 中的类)

streamwriter (codecs.CodecInfo 属性)

strerror (OSError 属性)

strerror()

(在 os 模块中)

strftime() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(在 time 模块中)

strict

error handler's name

strict (csv.Dialect 属性)

strict() (在 email.policy 模块中)

strict_domain (http.cookiejar.DefaultCookiePolicy 属性)

strict_errors() (在 codecs 模块中)

strict_ns_domain (http.cookiejar.DefaultCookiePolicy 属性)

strict_ns_set_initial_dollar (http.cookiejar.DefaultCookiePolicy 属性)

strict_ns_set_path (http.cookiejar.DefaultCookiePolicy 属性)

strict_ns_unverifiable (http.cookiejar.DefaultCookiePolicy 属性)

strict_rfc2965_unverifiable (http.cookiejar.DefaultCookiePolicy 属性)

strides (memoryview 属性)

string

__format__() (object method)

__str__() (object method)

conversion, [1]

format() (built-in function)

formatted literal

formatting, printf

immutable sequences

interpolated literal

interpolation, printf

item

methods

object representation

PyObject_Str (C function)

str (built-in class)

str() (built-in function)

text sequence type

对象, [1], [2]

模块, [1]

string (re.Match 属性)

string literal

STRING() (在 token 模块中)

string_at() (在 ctypes 模块中)

StringIO (io 中的类)

stringprep

模块

strings, documentation, [1]

strip() (bytearray 方法)

(bytes 方法)

(str 方法)

strip_dirs() (pstats.Stats 方法)

stripspaces (curses.textpad.Textbox 属性)

strong reference -- 强引用

strptime() (datetime.datetime 类方法)

(在 time 模块中)

strsignal() (在 signal 模块中)

strtobool() (在 distutils.util 模块中)

struct

模块, [1]

Struct (struct 中的类)

struct_time (time 中的类)

Structure (ctypes 中的类)

structures

C

strxfrm() (在 locale 模块中)

style

coding

Style (tkinter.ttk 中的类)

Sub (ast 中的类)

sub() (re.Pattern 方法)

(在 operator 模块中)

(在 re 模块中)

sub_commands (distutils.cmd.Command 属性)

subclassing

immutable types

subdirs (filecmp.dircmp 属性)

SubElement() (在 xml.etree.ElementTree 模块中)

submit() (concurrent.futures.Executor 方法)

submodule_search_locations (importlib.machinery.ModuleSpec 属性)

subn() (re.Pattern 方法)

(在 re 模块中)

subnet_of() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

subnets() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

Subnormal (decimal 中的类)

suboffsets (memoryview 属性)

subpad() (curses.window 方法)

subprocess

模块

subprocess_exec() (asyncio.loop 方法)

subprocess_shell() (asyncio.loop 方法)

SubprocessError

SubprocessProtocol (asyncio 中的类)

SubprocessTransport (asyncio 中的类)

subscribe() (imaplib.IMAP4 方法)

subscript

assignment

operation

Subscript (ast 中的类)

subscription, [1], [2], [3]

assignment

subsequent_indent (textwrap.TextWrapper 属性)

subst_vars() (在 distutils.util 模块中)

substitute() (string.Template 方法)

subTest() (unittest.TestCase 方法)

subtract() (collections.Counter 方法)

(decimal.Context 方法)

subtraction

subtype (email.headerregistry.ContentTypeHeader 属性)

subwin() (curses.window 方法)

successful() (multiprocessing.pool.AsyncResult 方法)

suffix (pathlib.PurePath 属性)

suffix_map (mimetypes.MimeTypes 属性)

suffix_map() (在 mimetypes 模块中)

suffixes (pathlib.PurePath 属性)

suite

suiteClass (unittest.TestLoader 属性)

sum()

內置函数

sum_list()

sum_sequence(), [1]

summarize() (doctest.DocTestRunner 方法)

summarize_address_range() (在 ipaddress 模块中)

sunau

模块

SUNDAY() (在 calendar 模块中)

super (pyclbr.Class 属性)

(內置类)

supernet() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

supernet_of() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

supports_bytes_environ() (在 os 模块中)

supports_dir_fd() (在 os 模块中)

supports_effective_ids() (在 os 模块中)

supports_fd() (在 os 模块中)

supports_follow_symlinks() (在 os 模块中)

supports_unicode_filenames() (在 os.path 模块中)

SupportsAbs (typing 中的类)

SupportsBytes (typing 中的类)

SupportsComplex (typing 中的类)

SupportsFloat (typing 中的类)

SupportsIndex (typing 中的类)

SupportsInt (typing 中的类)

SupportsRound (typing 中的类)

suppress() (在 contextlib 模块中)

SuppressCrashReport (test.support 中的类)

surrogateescape

error handler's name

surrogatepass

error handler's name

SW_HIDE() (在 subprocess 模块中)

swap_attr() (在 test.support 模块中)

swap_item() (在 test.support 模块中)

swapcase() (bytearray 方法)

(bytes 方法)

(str 方法)

Symbol (symtable 中的类)

SymbolTable (symtable 中的类)

symlink() (在 os 模块中)

symlink_to() (pathlib.Path 方法)

symmetric_difference() (frozenset 方法)

symmetric_difference_update() (frozenset 方法)

symtable

模块

symtable() (在 symtable 模块中)

sync() (dbm.dumb.dumbdbm 方法)

(dbm.gnu.gdbm 方法)

(ossaudiodev.oss_audio_device 方法)

(shelve.Shelf 方法)

(在 os 模块中)

syncdown() (curses.window 方法)

synchronized() (在 multiprocessing.sharedctypes 模块中)

SyncManager (multiprocessing.managers 中的类)

syncok() (curses.window 方法)

syncup() (curses.window 方法)

syntax

SyntaxErr

SyntaxError

SyntaxWarning

sys

模块, [1], [2], [3], [4], [5], [6], [7]

sys.exc_info

sys.last_traceback

sys.meta_path

sys.modules

sys.path

sys.path_hooks

sys.path_importer_cache

sys.stderr

sys.stdin

sys.stdout

sys_exc (2to3 fixer)

sys_version (http.server.BaseHTTPRequestHandler 属性)

sysconf() (在 os 模块中)

sysconf_names() (在 os 模块中)

sysconfig

模块

syslog

模块

syslog() (在 syslog 模块中)

SysLogHandler (logging.handlers 中的类)

system() (在 os 模块中)

(在 platform 模块中)

system_alias() (在 platform 模块中)

system_must_validate_cert() (在 test.support 模块中)

SystemError

(built-in exception), [1]

SystemExit

(built-in exception)

systemId (xml.dom.DocumentType 属性)

SystemRandom (random 中的类)

(secrets 中的类)

SystemRoot

索引 – T

T_FMT() (在 locale 模块中)

T_FMT_AMPM() (在 locale 模块中)

tab

tab() (tkinter.ttk.Notebook 方法)

TabError

tabnanny

模块

tabs() (tkinter.ttk.Notebook 方法)

tabsize (textwrap.TextWrapper 属性)

tabular

data

tag (xml.etree.ElementTree.Element 属性)

tag_bind() (tkinter.ttk.Treeview 方法)

tag_configure() (tkinter.ttk.Treeview 方法)

tag_has() (tkinter.ttk.Treeview 方法)

tagName (xml.dom.Element 属性)

tail (xml.etree.ElementTree.Element 属性)

take_snapshot() (在 tracemalloc 模块中)

takewhile() (在 itertools 模块中)

tan() (在 cmath 模块中)

(在 math 模块中)

tanh() (在 cmath 模块中)

(在 math 模块中)

tar_filter() (在 tarfile 模块中)

TarError

tarfile

模块

TarFile (tarfile 中的类)

tarfile command line option

--create <tarfile> <source1> ... <sourceN>

--extract <tarfile> [<output_dir>]

--filter <filtername>

--list <tarfile>

--test <tarfile>

--verbose

-c <tarfile> <source1> ... <sourceN>

-e <tarfile> [<output_dir>]

-l <tarfile>

-t <tarfile>

-v

target

deletion

list, [1]

list assignment

list, deletion

loop control

target (xml.dom.ProcessingInstruction 属性)

TarInfo (tarfile 中的类)

tarinfo (tarfile.FilterError 属性)

Task (asyncio 中的类)

task_done() (asyncio.Queue 方法)

(multiprocessing.JoinableQueue 方法)

(queue.Queue 方法)

tau() (在 cmath 模块中)

(在 math 模块中)

tb_frame (traceback attribute)

tb_lasti (traceback attribute)

tb_lineno (traceback attribute)

tb_locals (unittest.TestResult 属性)

tb_next (traceback attribute)

tbreak (pdb command)

tcdrain() (在 termios 模块中)

tcflow() (在 termios 模块中)

tcflush() (在 termios 模块中)

tcgetattr() (在 termios 模块中)

tcgetpgrp() (在 os 模块中)

Tcl() (在 tkinter 模块中)

TCL_LIBRARY

TCPServer (socketserver 中的类)

tcsendbreak() (在 termios 模块中)

tcsetattr() (在 termios 模块中)

tcsetpgrp() (在 os 模块中)

tearDown() (unittest.TestCase 方法)

tearDownClass() (unittest.TestCase 方法)

tee() (在 itertools 模块中)

tell() (aifc.aifc 方法)

(chunk.Chunk 方法)

(io.IOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

(sunau.AU_read 方法)

(sunau.AU_write 方法)

(wave.Wave_read 方法)

(wave.Wave_write 方法)

Telnet (telnetlib 中的类)

telnetlib

模块

TEMP, [1]

temp_cwd() (在 test.support.os_helper 模块中)

temp_dir() (在 test.support.os_helper 模块中)

temp_umask() (在 test.support.os_helper 模块中)

tempdir() (在 tempfile 模块中)

tempfile

模块

Template (pipes 中的类)

(string 中的类)

template (string.Template 属性)

temporary

file

file name

temporary (bdb.Breakpoint 属性)

TemporaryDirectory (tempfile 中的类)

TemporaryFile() (在 tempfile 模块中)

teredo (ipaddress.IPv6Address 属性)

TERM, [1]

termattrs() (在 curses 模块中)

terminal_size (os 中的类)

terminate() (asyncio.subprocess.Process 方法)

(asyncio.SubprocessTransport 方法)

(multiprocessing.pool.Pool 方法)

(multiprocessing.Process 方法)

(subprocess.Popen 方法)

termination model

terminator (logging.StreamHandler 属性)

termios

模块

termname() (在 curses 模块中)

ternary

operator

ternaryfunc (C type)

test

identity

membership

模块

test (doctest.DocTestFailure 属性)

(doctest.UnexpectedException 属性)

test() (在 cgi 模块中)

test.support

模块

test.support.bytecode_helper

模块

test.support.import_helper

模块

test.support.os_helper

模块

test.support.script_helper

模块

test.support.socket_helper

模块

test.support.threading_helper

模块

test.support.warnings_helper

模块

TEST_DATA_DIR() (在 test.support 模块中)

TEST_HOME_DIR() (在 test.support 模块中)

TEST_HTTP_URL() (在 test.support 模块中)

TEST_SUPPORT_DIR() (在 test.support 模块中)

TestCase (unittest 中的类)

TestFailed

testfile() (在 doctest 模块中)

TESTFN() (在 test.support.os_helper 模块中)

TESTFN_NONASCII() (在 test.support.os_helper 模块中)

TESTFN_UNDECODABLE() (在 test.support.os_helper 模块中)

TESTFN_UNENCODABLE() (在 test.support.os_helper 模块中)

TESTFN_UNICODE() (在 test.support.os_helper 模块中)

TestLoader (unittest 中的类)

testMethodPrefix (unittest.TestLoader 属性)

testmod() (在 doctest 模块中)

testNamePatterns (unittest.TestLoader 属性)

TestResult (unittest 中的类)

tests() (在 imghdr 模块中)

testsource() (在 doctest 模块中)

testsRun (unittest.TestResult 属性)

TestSuite (unittest 中的类)

testzip() (zipfile.ZipFile 方法)

text (SyntaxError 属性)

(traceback.TracebackException 属性)

Text (typing 中的类)

text (xml.etree.ElementTree.Element 属性)

text encoding -- 文本编码格式

text file -- 文本文件

text mode

text() (msilib.Dialog 方法)

(在 cgitb 模块中)

(在 msilib 模块中)

text_encoding() (在 io 模块中)

text_factory (sqlite3.Connection 属性)

Textbox (curses.textpad 中的类)

TextCalendar (calendar 中的类)

textdomain() (在 gettext 模块中)

(在 locale 模块中)

TextFile (distutils.text_file 中的类)

textinput() (在 turtle 模块中)

TextIO (typing 中的类)

TextIOBase (io 中的类)

TextIOWrapper (io 中的类)

TextTestResult (unittest 中的类)

TextTestRunner (unittest 中的类)

textwrap

模块

TextWrapper (textwrap 中的类)

theme_create() (tkinter.ttk.Style 方法)

theme_names() (tkinter.ttk.Style 方法)

theme_settings() (tkinter.ttk.Style 方法)

theme_use() (tkinter.ttk.Style 方法)

THOUSEP() (在 locale 模块中)

Thread (threading 中的类)

thread() (imaplib.IMAP4 方法)

thread_info() (在 sys 模块中)

thread_time() (在 time 模块中)

thread_time_ns() (在 time 模块中)

ThreadedChildWatcher (asyncio 中的类)

threading

模块

threading_cleanup() (在 test.support.threading_helper 模块中)

threading_setup() (在 test.support.threading_helper 模块中)

ThreadingHTTPServer (http.server 中的类)

ThreadingMixIn (socketserver 中的类)

ThreadingTCPServer (socketserver 中的类)

ThreadingUDPServer (socketserver 中的类)

ThreadPool (multiprocessing.pool 中的类)

ThreadPoolExecutor (concurrent.futures 中的类)

threads

POSIX

threadsafety() (在 sqlite3 模块中)

throw (2to3 fixer)

throw() (coroutine 方法)

(generator 方法)

THURSDAY() (在 calendar 模块中)

ticket_lifetime_hint (ssl.SSLSession 属性)

tigetflag() (在 curses 模块中)

tigetnum() (在 curses 模块中)

tigetstr() (在 curses 模块中)

TILDE() (在 token 模块中)

tilt() (在 turtle 模块中)

tiltangle() (在 turtle 模块中)

time

模块

time (datetime 中的类)

(ssl.SSLSession 属性)

time() (asyncio.loop 方法)

(datetime.datetime 方法)

(在 time 模块中)

Time2Internaldate() (在 imaplib 模块中)

time_ns() (在 time 模块中)

timedelta (datetime 中的类)

TimedRotatingFileHandler (logging.handlers 中的类)

timegm() (在 calendar 模块中)

timeit

模块

timeit command line option

--help

--number=N

--process

--repeat=N

--setup=S

--unit=U

--verbose

-h

-n N

-p

-r N

-s S

-u

-v

timeit() (timeit.Timer 方法)

(在 timeit 模块中)

timeout

(socketserver.BaseServer 属性)

(ssl.SSLSession 属性)

(subprocess.TimeoutExpired 属性)

timeout() (curses.window 方法)

TIMEOUT_MAX() (在 _thread 模块中)

(在 threading 模块中)

TimeoutError, [1], [2], [3]

TimeoutExpired

Timer (threading 中的类)

(timeit 中的类)

TimerHandle (asyncio 中的类)

times() (在 os 模块中)

TIMESTAMP (py_compile.PycInvalidationMode 属性)

timestamp() (datetime.datetime 方法)

timetuple() (datetime.date 方法)

(datetime.datetime 方法)

timetz() (datetime.datetime 方法)

timezone (datetime 中的类)

timezone() (在 time 模块中)

title() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 turtle 模块中)

Tix

tix_addbitmapdir() (tkinter.tix.tixCommand 方法)

tix_cget() (tkinter.tix.tixCommand 方法)

tix_configure() (tkinter.tix.tixCommand 方法)

tix_filedialog() (tkinter.tix.tixCommand 方法)

tix_getbitmap() (tkinter.tix.tixCommand 方法)

tix_getimage() (tkinter.tix.tixCommand 方法)

tix_option_get() (tkinter.tix.tixCommand 方法)

tix_resetoptions() (tkinter.tix.tixCommand 方法)

tixCommand (tkinter.tix 中的类)

Tk

(tkinter 中的类)

(tkinter.tix 中的类)

tk (tkinter.Tk 属性)

Tk Option Data Types

TK_LIBRARY

Tkinter

tkinter

模块

tkinter.colorchooser

模块

tkinter.commondialog

模块

tkinter.dnd

模块

tkinter.filedialog

模块

tkinter.font

模块

tkinter.messagebox

模块

tkinter.scrolledtext

模块

tkinter.simpledialog

模块

tkinter.tix

模块

tkinter.ttk

模块

TList (tkinter.tix 中的类)

TLS

TLSv1 (ssl.TLSVersion 属性)

TLSv1_1 (ssl.TLSVersion 属性)

TLSv1_2 (ssl.TLSVersion 属性)

TLSv1_3 (ssl.TLSVersion 属性)

TLSVersion (ssl 中的类)

TMP

TMPDIR

to_bytes() (int 方法)

to_eng_string() (decimal.Context 方法)

(decimal.Decimal 方法)

to_integral() (decimal.Decimal 方法)

to_integral_exact() (decimal.Context 方法)

(decimal.Decimal 方法)

to_integral_value() (decimal.Decimal 方法)

to_sci_string() (decimal.Context 方法)

to_thread() (在 asyncio 模块中)

ToASCII() (在 encodings.idna 模块中)

tobuf() (tarfile.TarInfo 方法)

tobytes() (array.array 方法)

(memoryview 方法)

today() (datetime.date 类方法)

(datetime.datetime 类方法)

tofile() (array.array 方法)

tok_name() (在 token 模块中)

token

模块

Token (contextvars 中的类)

token (shlex.shlex 属性)

token_bytes() (在 secrets 模块中)

token_hex() (在 secrets 模块中)

token_urlsafe() (在 secrets 模块中)

TokenError

tokenize

模块

tokenize command line option

--exact

--help

-e

-h

tokenize() (在 tokenize 模块中)

tolist() (array.array 方法)

(memoryview 方法)

tomono() (在 audioop 模块中)

toordinal() (datetime.date 方法)

(datetime.datetime 方法)

top() (curses.panel.Panel 方法)

(poplib.POP3 方法)

top_panel() (在 curses.panel 模块中)

TopologicalSorter (graphlib 中的类)

toprettyxml() (xml.dom.minidom.Node 方法)

toreadonly() (memoryview 方法)

tostereo() (在 audioop 模块中)

tostring() (在 xml.etree.ElementTree 模块中)

tostringlist() (在 xml.etree.ElementTree 模块中)

total() (collections.Counter 方法)

total_changes (sqlite3.Connection 属性)

total_nframe (tracemalloc.Traceback 属性)

total_ordering() (在 functools 模块中)

total_seconds() (datetime.timedelta 方法)

touch() (pathlib.Path 方法)

touchline() (curses.window 方法)

touchwin() (curses.window 方法)

tounicode() (array.array 方法)

ToUnicode() (在 encodings.idna 模块中)

towards() (在 turtle 模块中)

toxml() (xml.dom.minidom.Node 方法)

tparm() (在 curses 模块中)

trace

stack

模块

Trace (trace 中的类)

(tracemalloc 中的类)

trace command line option

--count

--coverdir=<dir>

--file=<file>

--help

--ignore-dir=<dir>

--ignore-module=<mod>

--listfuncs

--missing

--no-report

--report

--summary

--timing

--trace

--trackcalls

--version

-c

-C

-f

-g

-l

-m

-r

-R

-s

-t

-T

trace function, [1], [2], [3]

trace() (在 inspect 模块中)

trace_dispatch() (bdb.Bdb 方法)

traceback

对象, [1], [2], [3], [4]

模块

Traceback (tracemalloc 中的类)

traceback (tracemalloc.Statistic 属性)

(tracemalloc.StatisticDiff 属性)

(tracemalloc.Trace 属性)

traceback_limit (tracemalloc.Snapshot 属性)

(wsgiref.handlers.BaseHandler 属性)

TracebackException (traceback 中的类)

tracebacklimit() (在 sys 模块中)

tracebacks

in CGI scripts

TracebackType (types 中的类)

tracemalloc

模块

tracer() (在 turtle 模块中)

traces (tracemalloc.Snapshot 属性)

trailing

comma

transfercmd() (ftplib.FTP 方法)

transient_internet() (在 test.support.socket_helper 模块中)

translate() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 fnmatch 模块中)

translation() (在 gettext 模块中)

Transport (asyncio 中的类)

transport (asyncio.StreamWriter 属性)

Transport Layer Security

Traversable (importlib.abc 中的类)

TraversableResources (importlib.abc 中的类)

traverseproc (C type)

Tree (tkinter.tix 中的类)

TreeBuilder (xml.etree.ElementTree 中的类)

Treeview (tkinter.ttk 中的类)

triangular() (在 random 模块中)

triple-quoted string

triple-quoted string -- 三引号字符串

True, [1], [2]

true

True (內置变量)

truediv() (在 operator 模块中)

trunc() (in module math)

(在 math 模块中)

truncate() (io.IOBase 方法)

(在 os 模块中)

truth

value

truth() (在 operator 模块中)

try

语句, [1], [2]

Try (ast 中的类)

ttk

tty

I/O control

模块

ttyname() (在 os 模块中)

TUESDAY() (在 calendar 模块中)

tuple

empty, [1]

singleton

內置函数, [1]

对象, [1], [2], [3], [4], [5], [6]

Tuple (ast 中的类)

tuple (內置类)

Tuple() (在 typing 模块中)

tuple_params (2to3 fixer)

turtle

模块

Turtle (turtle 中的类)

turtledemo

模块

turtles() (在 turtle 模块中)

TurtleScreen (turtle 中的类)

turtlesize() (在 turtle 模块中)

type, [1]

Boolean

data

hierarchy

immutable data

operations on dictionary

operations on list

union

內置函数, [1], [2], [3]

对象, [1], [2]

type (optparse.Option 属性)

(socket.socket 属性)

(tarfile.TarInfo 属性)

Type (typing 中的类)

type (urllib.request.Request 属性)

(內置类)

type alias -- 类型别名

type hint -- 类型注解

type of an object

type_check_only() (在 typing 模块中)

TYPE_CHECKER (optparse.Option 属性)

TYPE_CHECKING() (在 typing 模块中)

type_comment (ast.arg 属性)

(ast.Assign 属性)

(ast.For 属性)

(ast.FunctionDef 属性)

(ast.With 属性)

TYPE_COMMENT() (在 token 模块中)

TYPE_IGNORE() (在 token 模块中)

typeahead() (在 curses 模块中)

TypeAlias() (在 typing 模块中)

typecode (array.array 属性)

typecodes() (在 array 模块中)

TYPED_ACTIONS (optparse.Option 属性)

typed_subpart_iterator() (在 email.iterators 模块中)

TypedDict (typing 中的类)

TypeError

例外

TypeGuard() (在 typing 模块中)

types

built-in

immutable sequence

mutable sequence

operations on integer

operations on mapping

operations on numeric

operations on sequence, [1]

模块, [1]

types (2to3 fixer)

TYPES (optparse.Option 属性)

types, internal

types_map (mimetypes.MimeTypes 属性)

types_map() (在 mimetypes 模块中)

types_map_inv (mimetypes.MimeTypes 属性)

TypeVar (typing 中的类)

typing

模块

TZ, [1], [2], [3], [4], [5]

tzinfo (datetime 中的类)

(datetime.datetime 属性)

(datetime.time 属性)

tzname() (datetime.datetime 方法)

(datetime.time 方法)

(datetime.timezone 方法)

(datetime.tzinfo 方法)

(在 time 模块中)

TZPATH() (在 zoneinfo 模块中)

tzset() (在 time 模块中)

索引 – U

u"

string literal

u'

string literal

u-LAW, [1], [2]

UAdd (ast 中的类)

ucd_3_2_0() (在 unicodedata 模块中)

udata (select.kevent 属性)

UDPServer (socketserver 中的类)

UF_APPEND() (在 stat 模块中)

UF_COMPRESSED() (在 stat 模块中)

UF_HIDDEN() (在 stat 模块中)

UF_IMMUTABLE() (在 stat 模块中)

UF_NODUMP() (在 stat 模块中)

UF_NOUNLINK() (在 stat 模块中)

UF_OPAQUE() (在 stat 模块中)

UID (plistlib 中的类)

uid (tarfile.TarInfo 属性)

uid() (imaplib.IMAP4 方法)

uidl() (poplib.POP3 方法)

ulaw2lin() (在 audioop 模块中)

ULONG_MAX

ulp() (在 math 模块中)

umask() (在 os 模块中)

unalias (pdb command)

uname (tarfile.TarInfo 属性)

uname() (在 os 模块中)

(在 platform 模块中)

unary

arithmetic operation

bitwise operation

UNARY_INVERT (opcode)

UNARY_NEGATIVE (opcode)

UNARY_NOT (opcode)

UNARY_POSITIVE (opcode)

unaryfunc (C type)

UnaryOp (ast 中的类)

unbinding

name

UnboundLocalError, [1]

unbuffered I/O

UNC paths

and os.makedirs()

UNCHECKED_HASH (py_compile.PycInvalidationMode 属性)

unconsumed_tail (zlib.Decompress 属性)

unctrl() (在 curses 模块中)

(在 curses.ascii 模块中)

undefine_macro() (distutils.ccompiler.CCompiler 方法)

Underflow (decimal 中的类)

undisplay (pdb command)

undo() (在 turtle 模块中)

undobufferentries() (在 turtle 模块中)

undoc_header (cmd.Cmd 属性)

unescape() (在 html 模块中)

(在 xml.sax.saxutils 模块中)

UnexpectedException

unexpectedSuccesses (unittest.TestResult 属性)

unfreeze() (在 gc 模块中)

unget_wch() (在 curses 模块中)

ungetch() (在 curses 模块中)

(在 msvcrt 模块中)

ungetmouse() (在 curses 模块中)

ungetwch() (在 msvcrt 模块中)

unhexlify() (在 binascii 模块中)

Unicode, [1], [2]

database

unicode (2to3 fixer)

Unicode Consortium

unicodedata

模块

UnicodeDecodeError

UnicodeEncodeError

UnicodeError

UnicodeTranslateError

UnicodeWarning

unidata_version() (在 unicodedata 模块中)

unified_diff() (在 difflib 模块中)

uniform() (在 random 模块中)

UnimplementedFileMode

Union

对象

union

type

Union (ctypes 中的类)

union() (frozenset 方法)

Union() (在 typing 模块中)

UnionType (types 中的类)

unique() (在 enum 模块中)

unittest

模块

unittest command line option

--buffer

--catch

--failfast

--locals

-b

-c

-f

-k

unittest-discover command line option

--pattern pattern

--start-directory directory

--top-level-directory directory

--verbose

-p

-s

-t

-v

unittest.mock

模块

universal newlines

bytearray.splitlines method

bytes.splitlines method

csv.reader function

importlib.abc.InspectLoader.get_source method

io.IncrementalNewlineDecoder class

io.TextIOWrapper class

open() built-in function

str.splitlines method

subprocess module

What's new, [1], [2], [3]

universal newlines -- 通用换行

UNIX

file control

I/O control

unix_dialect (csv 中的类)

unix_shell() (在 test.support 模块中)

UnixDatagramServer (socketserver 中的类)

UnixStreamServer (socketserver 中的类)

unknown (uuid.SafeUUID 属性)

unknown_decl() (html.parser.HTMLParser 方法)

unknown_open() (urllib.request.BaseHandler 方法)

(urllib.request.UnknownHandler 方法)

UnknownHandler (urllib.request 中的类)

UnknownProtocol

UnknownTransferEncoding

unlink() (multiprocessing.shared_memory.SharedMemory 方法)

(pathlib.Path 方法)

(xml.dom.minidom.Node 方法)

(在 os 模块中)

(在 test.support.os_helper 模块中)

unload() (在 test.support.import_helper 模块中)

unlock() (mailbox.Babyl 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.mbox 方法)

(mailbox.MH 方法)

(mailbox.MMDF 方法)

unpack() (struct.Struct 方法)

(在 struct 模块中)

unpack_archive() (在 shutil 模块中)

unpack_array() (xdrlib.Unpacker 方法)

unpack_bytes() (xdrlib.Unpacker 方法)

unpack_double() (xdrlib.Unpacker 方法)

UNPACK_EX (opcode)

unpack_farray() (xdrlib.Unpacker 方法)

unpack_float() (xdrlib.Unpacker 方法)

unpack_fopaque() (xdrlib.Unpacker 方法)

unpack_from() (struct.Struct 方法)

(在 struct 模块中)

unpack_fstring() (xdrlib.Unpacker 方法)

unpack_list() (xdrlib.Unpacker 方法)

unpack_opaque() (xdrlib.Unpacker 方法)

UNPACK_SEQUENCE (opcode)

unpack_string() (xdrlib.Unpacker 方法)

Unpacker (xdrlib 中的类)

unpacking

dictionary

in function calls

iterable

unparse() (在 ast 模块中)

unparsedEntityDecl() (xml.sax.handler.DTDHandler 方法)

UnparsedEntityDeclHandler() (xml.parsers.expat.xmlparser 方法)

Unpickler (pickle 中的类)

UnpicklingError

unquote() (在 email.utils 模块中)

(在 urllib.parse 模块中)

unquote_plus() (在 urllib.parse 模块中)

unquote_to_bytes() (在 urllib.parse 模块中)

unraisablehook() (在 sys 模块中)

unreachable object

unreadline() (distutils.text_file.TextFile 方法)

unrecognized escape sequence

unregister() (select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(selectors.BaseSelector 方法)

(在 atexit 模块中)

(在 codecs 模块中)

(在 faulthandler 模块中)

unregister_archive_format() (在 shutil 模块中)

unregister_dialect() (在 csv 模块中)

unregister_unpack_format() (在 shutil 模块中)

unsafe (uuid.SafeUUID 属性)

unselect() (imaplib.IMAP4 方法)

unset() (test.support.os_helper.EnvironmentVarGuard 方法)

unsetenv() (在 os 模块中)

UnstructuredHeader (email.headerregistry 中的类)

unsubscribe() (imaplib.IMAP4 方法)

UnsupportedOperation

until (pdb command)

untokenize() (在 tokenize 模块中)

untouchwin() (curses.window 方法)

unused_data (bz2.BZ2Decompressor 属性)

(lzma.LZMADecompressor 属性)

(zlib.Decompress 属性)

unverifiable (urllib.request.Request 属性)

unwrap() (ssl.SSLSocket 方法)

(在 inspect 模块中)

(在 urllib.parse 模块中)

up (pdb command)

up() (在 turtle 模块中)

update() (collections.Counter 方法)

(dict 方法)

(frozenset 方法)

(hashlib.hash 方法)

(hmac.HMAC 方法)

(http.cookies.Morsel 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(trace.CoverageResults 方法)

(在 turtle 模块中)

update_abstractmethods() (在 abc 模块中)

update_authenticated() (urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

update_lines_cols() (在 curses 模块中)

update_panels() (在 curses.panel 模块中)

update_visible() (mailbox.BabylMessage 方法)

update_wrapper() (在 functools 模块中)

upgrade_dependencies() (venv.EnvBuilder 方法)

upper() (bytearray 方法)

(bytes 方法)

(str 方法)

urandom() (在 os 模块中)

URL, [1], [2], [3]

parsing

relative

url (http.client.HTTPResponse 属性)

(urllib.response.addinfourl 属性)

(xmlrpc.client.ProtocolError 属性)

url2pathname() (在 urllib.request 模块中)

urlcleanup() (在 urllib.request 模块中)

urldefrag() (在 urllib.parse 模块中)

urlencode() (在 urllib.parse 模块中)

URLError

urljoin() (在 urllib.parse 模块中)

urllib

模块

urllib (2to3 fixer)

urllib.error

模块

urllib.parse

模块

urllib.request

模块, [1]

urllib.response

模块

urllib.robotparser

模块

urlopen() (在 urllib.request 模块中)

URLopener (urllib.request 中的类)

urlparse() (在 urllib.parse 模块中)

urlretrieve() (在 urllib.request 模块中)

urlsafe_b64decode() (在 base64 模块中)

urlsafe_b64encode() (在 base64 模块中)

urlsplit() (在 urllib.parse 模块中)

urlunparse() (在 urllib.parse 模块中)

urlunsplit() (在 urllib.parse 模块中)

urn (uuid.UUID 属性)

use_default_colors() (在 curses 模块中)

use_env() (在 curses 模块中)

use_rawinput (cmd.Cmd 属性)

UseForeignDTD() (xml.parsers.expat.xmlparser 方法)

USER

user

effective id

id

id, setting

user() (poplib.POP3 方法)

user-defined

function

function call

method

user-defined function

对象, [1], [2]

user-defined method

对象

USER_BASE

USER_BASE() (在 site 模块中)

user_call() (bdb.Bdb 方法)

user_exception() (bdb.Bdb 方法)

user_line() (bdb.Bdb 方法)

user_return() (bdb.Bdb 方法)

USER_SITE() (在 site 模块中)

usercustomize

模块

UserDict (collections 中的类)

UserList (collections 中的类)

USERNAME, [1], [2]

username (email.headerregistry.Address 属性)

USERPROFILE, [1], [2], [3], [4]

userptr() (curses.panel.Panel 方法)

UserString (collections 中的类)

UserWarning

USTAR_FORMAT() (在 tarfile 模块中)

USub (ast 中的类)

UTC

utc (datetime.timezone 属性)

utcfromtimestamp() (datetime.datetime 类方法)

utcnow() (datetime.datetime 类方法)

utcoffset() (datetime.datetime 方法)

(datetime.time 方法)

(datetime.timezone 方法)

(datetime.tzinfo 方法)

utctimetuple() (datetime.datetime 方法)

utf8 (email.policy.EmailPolicy 属性)

utf8() (poplib.POP3 方法)

utf8_enabled (imaplib.IMAP4 属性)

utime() (在 os 模块中)

uu

模块, [1]

uuid

模块

UUID (uuid 中的类)

uuid1

uuid1() (在 uuid 模块中)

uuid3

uuid3() (在 uuid 模块中)

uuid4

uuid4() (在 uuid 模块中)

uuid5

uuid5() (在 uuid 模块中)

UuidCreate() (在 msilib 模块中)

索引 – V

v4_int_to_packed() (在 ipaddress 模块中)

v6_int_to_packed() (在 ipaddress 模块中)

valid_signals() (在 signal 模块中)

validator() (在 wsgiref.validate 模块中)

value

default parameter

truth

value (ctypes._SimpleCData 属性)

(http.cookiejar.Cookie 属性)

(http.cookies.Morsel 属性)

(xml.dom.Attr 属性)

value of an object

Value() (multiprocessing.managers.SyncManager 方法)

(在 multiprocessing 模块中)

(在 multiprocessing.sharedctypes 模块中)

value_decode() (http.cookies.BaseCookie 方法)

value_encode() (http.cookies.BaseCookie 方法)

ValueError

例外

valuerefs() (weakref.WeakValueDictionary 方法)

values

Boolean

writing

values() (contextvars.Context 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(types.MappingProxyType 方法)

ValuesView (collections.abc 中的类)

(typing 中的类)

var (contextvars.Token 属性)

variable

free

variable annotation -- 变量标注

variance (statistics.NormalDist 属性)

variance() (在 statistics 模块中)

variant (uuid.UUID 属性)

vars()

內置函数

vbar (tkinter.scrolledtext.ScrolledText 属性)

VBAR() (在 token 模块中)

VBAREQUAL() (在 token 模块中)

Vec2D (turtle 中的类)

vectorcallfunc (C type)

venv

模块

VERBOSE() (在 re 模块中)

verbose() (在 tabnanny 模块中)

(在 test.support 模块中)

verify() (smtplib.SMTP 方法)

VERIFY_ALLOW_PROXY_CERTS() (在 ssl 模块中)

verify_client_post_handshake() (ssl.SSLSocket 方法)

verify_code (ssl.SSLCertVerificationError 属性)

VERIFY_CRL_CHECK_CHAIN() (在 ssl 模块中)

VERIFY_CRL_CHECK_LEAF() (在 ssl 模块中)

VERIFY_DEFAULT() (在 ssl 模块中)

verify_flags (ssl.SSLContext 属性)

verify_generated_headers (email.policy.Policy 属性)

verify_message (ssl.SSLCertVerificationError 属性)

verify_mode (ssl.SSLContext 属性)

verify_request() (socketserver.BaseServer 方法)

VERIFY_X509_PARTIAL_CHAIN() (在 ssl 模块中)

VERIFY_X509_STRICT() (在 ssl 模块中)

VERIFY_X509_TRUSTED_FIRST() (在 ssl 模块中)

VerifyFlags (ssl 中的类)

VerifyMode (ssl 中的类)

version (email.headerregistry.MIMEVersionHeader 属性)

(http.client.HTTPResponse 属性)

(http.cookiejar.Cookie 属性)

(in module sys), [1], [2]

(ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

(urllib.request.URLopener 属性)

(uuid.UUID 属性)

version() (ssl.SSLSocket 方法)

(在 curses 模块中)

(在 ensurepip 模块中)

(在 marshal 模块中)

(在 platform 模块中)

(在 sqlite3 模块中)

(在 sys 模块中)

version_info() (在 sqlite3 模块中)

(在 sys 模块中)

version_string() (http.server.BaseHTTPRequestHandler 方法)

vformat() (string.Formatter 方法)

virtual

Environments

virtual environment -- 虚拟环境

virtual machine -- 虚拟机

visit() (ast.NodeVisitor 方法)

visitproc (C type)

vline() (curses.window 方法)

voidcmd() (ftplib.FTP 方法)

volume (zipfile.ZipInfo 属性)

vonmisesvariate() (在 random 模块中)

索引 – W

W_OK() (在 os 模块中)

wait() (asyncio.Condition 方法)

(asyncio.Event 方法)

(asyncio.subprocess.Process 方法)

(multiprocessing.pool.AsyncResult 方法)

(subprocess.Popen 方法)

(threading.Barrier 方法)

(threading.Condition 方法)

(threading.Event 方法)

(在 asyncio 模块中)

(在 concurrent.futures 模块中)

(在 multiprocessing.connection 模块中)

(在 os 模块中)

wait3() (在 os 模块中)

wait4() (在 os 模块中)

wait_closed() (asyncio.Server 方法)

(asyncio.StreamWriter 方法)

wait_for() (asyncio.Condition 方法)

(threading.Condition 方法)

(在 asyncio 模块中)

wait_process() (在 test.support 模块中)

wait_threads_exit() (在 test.support.threading_helper 模块中)

waitid() (在 os 模块中)

waitpid() (在 os 模块中)

waitstatus_to_exitcode() (在 os 模块中)

walk() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(在 ast 模块中)

(在 os 模块中)

walk_packages() (在 pkgutil 模块中)

walk_stack() (在 traceback 模块中)

walk_tb() (在 traceback 模块中)

walrus operator

want (doctest.Example 属性)

warn() (distutils.ccompiler.CCompiler 方法)

(distutils.text_file.TextFile 方法)

(在 warnings 模块中)

warn_explicit() (在 warnings 模块中)

Warning, [1]

warning() (logging.Logger 方法)

(xml.sax.handler.ErrorHandler 方法)

(在 logging 模块中)

warnings

模块

WarningsRecorder (test.support.warnings_helper 中的类)

warnoptions() (在 sys 模块中)

wasSuccessful() (unittest.TestResult 方法)

WatchedFileHandler (logging.handlers 中的类)

wave

模块

WCONTINUED() (在 os 模块中)

WCOREDUMP() (在 os 模块中)

WeakKeyDictionary (weakref 中的类)

WeakMethod (weakref 中的类)

weakref

模块

WeakSet (weakref 中的类)

WeakValueDictionary (weakref 中的类)

webbrowser

模块

WEDNESDAY() (在 calendar 模块中)

weekday() (datetime.date 方法)

(datetime.datetime 方法)

(在 calendar 模块中)

weekheader() (在 calendar 模块中)

weibullvariate() (在 random 模块中)

WEXITED() (在 os 模块中)

WEXITSTATUS() (在 os 模块中)

wfile (http.server.BaseHTTPRequestHandler 属性)

what() (在 imghdr 模块中)

(在 sndhdr 模块中)

whathdr() (在 sndhdr 模块中)

whatis (pdb command)

when() (asyncio.TimerHandle 方法)

where (pdb command)

which() (在 shutil 模块中)

whichdb() (在 dbm 模块中)

while

语句, [1], [2], [3]

While (ast 中的类)

whitespace (shlex.shlex 属性)

whitespace() (在 string 模块中)

whitespace_split (shlex.shlex 属性)

Widget (tkinter.ttk 中的类)

width (textwrap.TextWrapper 属性)

width() (在 turtle 模块中)

WIFCONTINUED() (在 os 模块中)

WIFEXITED() (在 os 模块中)

WIFSIGNALED() (在 os 模块中)

WIFSTOPPED() (在 os 模块中)

win32_edition() (在 platform 模块中)

win32_is_iot() (在 platform 模块中)

win32_ver() (在 platform 模块中)

WinDLL (ctypes 中的类)

window manager (widgets)

window() (curses.panel.Panel 方法)

window_height() (在 turtle 模块中)

window_width() (在 turtle 模块中)

Windows

Windows ini file

WindowsError

WindowsPath (pathlib 中的类)

WindowsProactorEventLoopPolicy (asyncio 中的类)

WindowsRegistryFinder (importlib.machinery 中的类)

WindowsSelectorEventLoopPolicy (asyncio 中的类)

winerror (OSError 属性)

WinError() (在 ctypes 模块中)

WINFUNCTYPE() (在 ctypes 模块中)

winreg

模块

WinSock

winsound

模块

winver() (在 sys 模块中)

with

语句, [1]

With (ast 中的类)

WITH_EXCEPT_START (opcode)

with_hostmask (ipaddress.IPv4Interface 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Interface 属性)

(ipaddress.IPv6Network 属性)

with_name() (pathlib.PurePath 方法)

with_netmask (ipaddress.IPv4Interface 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Interface 属性)

(ipaddress.IPv6Network 属性)

with_prefixlen (ipaddress.IPv4Interface 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Interface 属性)

(ipaddress.IPv6Network 属性)

with_pymalloc() (在 test.support 模块中)

with_stem() (pathlib.PurePath 方法)

with_suffix() (pathlib.PurePath 方法)

with_traceback() (BaseException 方法)

withitem (ast 中的类)

WNOHANG() (在 os 模块中)

WNOWAIT() (在 os 模块中)

wordchars (shlex.shlex 属性)

World Wide Web, [1], [2]

wrap() (textwrap.TextWrapper 方法)

(在 textwrap 模块中)

wrap_bio() (ssl.SSLContext 方法)

wrap_future() (在 asyncio 模块中)

wrap_socket() (ssl.SSLContext 方法)

(在 ssl 模块中)

wrap_text() (在 distutils.fancy_getopt 模块中)

wrapper() (在 curses 模块中)

WrapperDescriptorType() (在 types 模块中)

wraps() (在 functools 模块中)

writable() (asyncore.dispatcher 方法)

(io.IOBase 方法)

WRITABLE() (在 tkinter 模块中)

write() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

(code.InteractiveInterpreter 方法)

(codecs.StreamWriter 方法)

(configparser.ConfigParser 方法)

(email.generator.BytesGenerator 方法)

(email.generator.Generator 方法)

(io.BufferedIOBase 方法)

(io.BufferedWriter 方法)

(io.RawIOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

(ossaudiodev.oss_audio_device 方法)

(ssl.MemoryBIO 方法)

(ssl.SSLSocket 方法)

(telnetlib.Telnet 方法)

(xml.etree.ElementTree.ElementTree 方法)

(zipfile.ZipFile 方法)

(在 os 模块中)

(在 turtle 模块中)

write_byte() (mmap.mmap 方法)

write_bytes() (pathlib.Path 方法)

write_docstringdict() (在 turtle 模块中)

write_eof() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

(ssl.MemoryBIO 方法)

write_file() (在 distutils.file_util 模块中)

write_history_file() (在 readline 模块中)

WRITE_RESTRICTED

write_results() (trace.CoverageResults 方法)

write_text() (pathlib.Path 方法)

write_through (io.TextIOWrapper 属性)

writeall() (ossaudiodev.oss_audio_device 方法)

writeframes() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

writeframesraw() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

writeheader() (csv.DictWriter 方法)

writelines() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

(codecs.StreamWriter 方法)

(io.IOBase 方法)

writepy() (zipfile.PyZipFile 方法)

writer() (在 csv 模块中)

writerow() (csv.csvwriter 方法)

writerows() (csv.csvwriter 方法)

writestr() (zipfile.ZipFile 方法)

WriteTransport (asyncio 中的类)

writev() (在 os 模块中)

writexml() (xml.dom.minidom.Node 方法)

writing

values

WrongDocumentErr

ws_comma (2to3 fixer)

wsgi_file_wrapper (wsgiref.handlers.BaseHandler 属性)

wsgi_multiprocess (wsgiref.handlers.BaseHandler 属性)

wsgi_multithread (wsgiref.handlers.BaseHandler 属性)

wsgi_run_once (wsgiref.handlers.BaseHandler 属性)

wsgiref

模块

wsgiref.handlers

模块

wsgiref.headers

模块

wsgiref.simple_server

模块

wsgiref.util

模块

wsgiref.validate

模块

WSGIRequestHandler (wsgiref.simple_server 中的类)

WSGIServer (wsgiref.simple_server 中的类)

wShowWindow (subprocess.STARTUPINFO 属性)

WSTOPPED() (在 os 模块中)

WSTOPSIG() (在 os 模块中)

wstring_at() (在 ctypes 模块中)

WTERMSIG() (在 os 模块中)

WUNTRACED() (在 os 模块中)

WWW, [1], [2]

server, [1]

索引 – X

X() (在 re 模块中)

X509 certificate

X_OK() (在 os 模块中)

xatom() (imaplib.IMAP4 方法)

XATTR_CREATE() (在 os 模块中)

XATTR_REPLACE() (在 os 模块中)

XATTR_SIZE_MAX() (在 os 模块中)

xcor() (在 turtle 模块中)

XDR

xdrlib

模块

xhdr() (nntplib.NNTP 方法)

XHTML

XHTML_NAMESPACE() (在 xml.dom 模块中)

xml

模块

XML() (在 xml.etree.ElementTree 模块中)

xml.dom

模块

xml.dom.minidom

模块

xml.dom.pulldom

模块

xml.etree.ElementInclude.default_loader()

內置函数

xml.etree.ElementInclude.include()

內置函数

xml.etree.ElementTree

模块

xml.parsers.expat

模块

xml.parsers.expat.errors

模块

xml.parsers.expat.model

模块

xml.sax

模块

xml.sax.handler

模块

xml.sax.saxutils

模块

xml.sax.xmlreader

模块

XML_ERROR_ABORTED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_ASYNC_ENTITY() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_BAD_CHAR_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_BINARY_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_DUPLICATE_ATTRIBUTE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_ENTITY_DECLARED_IN_PE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_EXTERNAL_ENTITY_HANDLING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_FEATURE_REQUIRES_XML_DTD() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_FINISHED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_INCOMPLETE_PE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_INCORRECT_ENCODING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_INVALID_TOKEN() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_JUNK_AFTER_DOC_ELEMENT() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_MISPLACED_XML_PI() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NO_ELEMENTS() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NO_MEMORY() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NOT_STANDALONE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NOT_SUSPENDED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_PARAM_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_PARTIAL_CHAR() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_PUBLICID() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_RECURSIVE_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_SUSPEND_PE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_SUSPENDED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_SYNTAX() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_TAG_MISMATCH() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_TEXT_DECL() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNBOUND_PREFIX() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNCLOSED_CDATA_SECTION() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNCLOSED_TOKEN() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNDECLARING_PREFIX() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNDEFINED_ENTITY() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNEXPECTED_STATE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNKNOWN_ENCODING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_XML_DECL() (在 xml.parsers.expat.errors 模块中)

XML_NAMESPACE() (在 xml.dom 模块中)

xmlcharrefreplace

error handler's name

xmlcharrefreplace_errors() (在 codecs 模块中)

XmlDeclHandler() (xml.parsers.expat.xmlparser 方法)

XMLFilterBase (xml.sax.saxutils 中的类)

XMLGenerator (xml.sax.saxutils 中的类)

XMLID() (在 xml.etree.ElementTree 模块中)

XMLNS_NAMESPACE() (在 xml.dom 模块中)

XMLParser (xml.etree.ElementTree 中的类)

XMLParserType() (在 xml.parsers.expat 模块中)

XMLPullParser (xml.etree.ElementTree 中的类)

XMLReader (xml.sax.xmlreader 中的类)

xmlrpc.client

模块

xmlrpc.server

模块

xor

bitwise

xor() (在 operator 模块中)

xover() (nntplib.NNTP 方法)

xrange (2to3 fixer)

xreadlines (2to3 fixer)

xview() (tkinter.ttk.Treeview 方法)

索引 – Y

ycor() (在 turtle 模块中)

year (datetime.date 属性)

(datetime.datetime 属性)

Year 2038

yeardatescalendar() (calendar.Calendar 方法)

yeardays2calendar() (calendar.Calendar 方法)

yeardayscalendar() (calendar.Calendar 方法)

YESEXPR() (在 locale 模块中)

yield

examples

expression

yield from (in What's New)

关键字

语句

Yield (ast 中的类)

YIELD_FROM (opcode)

YIELD_VALUE (opcode)

YieldFrom (ast 中的类)

yiq_to_rgb() (在 colorsys 模块中)

yview() (tkinter.ttk.Treeview 方法)

索引 – Z

Zen of Python -- Python 之禅

ZeroDivisionError

例外

zfill() (bytearray 方法)

(bytes 方法)

(str 方法)

zip (2to3 fixer)

zip()

內置函数

ZIP_BZIP2() (在 zipfile 模块中)

ZIP_DEFLATED() (在 zipfile 模块中)

zip_longest() (在 itertools 模块中)

ZIP_LZMA() (在 zipfile 模块中)

ZIP_STORED() (在 zipfile 模块中)

zipapp

模块

zipapp command line option

--compress

--help

--info

--main=<mainfn>

--output=<output>

--python=<interpreter>

-c

-h

-m <mainfn>

-o <output>

-p <interpreter>

zipfile

模块

ZipFile (zipfile 中的类)

zipfile command line option

--create <zipfile> <source1> ... <sourceN>

--extract <zipfile> <output_dir>

--list <zipfile>

--test <zipfile>

-c <zipfile> <source1> ... <sourceN>

-e <zipfile> <output_dir>

-l <zipfile>

-t <zipfile>

zipimport

模块

zipimporter (zipimport 中的类)

ZipImportError

ZipInfo (zipfile 中的类)

zlib

模块

ZLIB_RUNTIME_VERSION() (在 zlib 模块中)

ZLIB_VERSION() (在 zlib 模块中)

zoneinfo

模块

ZoneInfo (zoneinfo 中的类)

ZoneInfoNotFoundError

zscore() (statistics.NormalDist 方法)

索引 – _

_ (underscore)

gettext

in numeric literal, [1]

in string formatting

_, identifiers

__, identifiers

__abs__() (object 方法)

(在 operator 模块中)

__add__() (object 方法)

(在 operator 模块中)

__aenter__() (object 方法)

__aexit__() (object 方法)

__aiter__() (object 方法)

__all__

(optional module attribute)

(package variable)

__and__() (object 方法)

(在 operator 模块中)

__anext__() (agen 方法)

(object 方法)

__annotations__ (class attribute)

(function attribute)

(module attribute)

__args__ (genericalias 属性)

__await__() (object 方法)

__bases__ (class attribute)

(class 属性)

__bool__() (object method)

(object 方法)

__breakpointhook__() (在 sys 模块中)

__bytes__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(object 方法)

__cached__

__call__() (email.headerregistry.HeaderRegistry 方法)

(object method)

(object 方法)

(weakref.finalize 方法)

__callback__ (weakref.ref 属性)

__cause__ (exception attribute)

(traceback.TracebackException 属性)

__ceil__() (fractions.Fraction 方法)

(object 方法)

__class__ (instance attribute)

(instance 属性)

(method cell)

(module attribute)

(unittest.mock.Mock 属性)

__class_getitem__() (object 类方法)

__classcell__ (class namespace entry)

__closure__ (function attribute)

__code__ (function attribute)

(function object attribute)

__complex__() (object 方法)

__concat__() (在 operator 模块中)

__contains__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(object 方法)

(在 operator 模块中)

__context__ (exception attribute)

(traceback.TracebackException 属性)

__copy__() (copy protocol)

__debug__

(內置变量)

__deepcopy__() (copy protocol)

__defaults__ (function attribute)

__del__() (io.IOBase 方法)

(object 方法)

__delattr__() (object 方法)

__delete__() (object 方法)

__delitem__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mailbox.MH 方法)

(object 方法)

(在 operator 模块中)

__dict__ (class attribute)

(function attribute)

(instance attribute)

(module attribute), [1]

(object 属性)

__dir__ (module attribute)

__dir__() (object 方法)

(unittest.mock.Mock 方法)

__displayhook__() (在 sys 模块中)

__divmod__() (object 方法)

__doc__ (class attribute)

(function attribute)

(method attribute)

(module attribute), [1]

(types.ModuleType 属性)

__enter__() (contextmanager 方法)

(object 方法)

(winreg.PyHKEY 方法)

__eq__() (email.charset.Charset 方法)

(email.header.Header 方法)

(instance method)

(memoryview 方法)

(object 方法)

(在 operator 模块中)

__excepthook__() (在 sys 模块中)

(在 threading 模块中)

__exit__() (contextmanager 方法)

(object 方法)

(winreg.PyHKEY 方法)

__file__

(module attribute), [1], [2]

__float__() (object 方法)

__floor__() (fractions.Fraction 方法)

(object 方法)

__floordiv__() (object 方法)

(在 operator 模块中)

__format__

__format__() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(ipaddress.IPv4Address 方法)

(ipaddress.IPv6Address 方法)

(object 方法)

__fspath__() (os.PathLike 方法)

__func__ (method attribute)

__future__

future statement

模块

__ge__() (instance method)

(object 方法)

(在 operator 模块中)

__get__() (object 方法)

__getattr__ (module attribute)

__getattr__() (object 方法)

__getattribute__() (object 方法)

__getitem__() (email.headerregistry.HeaderRegistry 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mapping object method)

(object 方法)

(re.Match 方法)

(在 operator 模块中)

__getnewargs__() (object 方法)

__getnewargs_ex__() (object 方法)

__getstate__() (copy protocol)

(object 方法)

__globals__ (function attribute)

__gt__() (instance method)

(object 方法)

(在 operator 模块中)

__hash__() (object 方法)

__iadd__() (object 方法)

(在 operator 模块中)

__iand__() (object 方法)

(在 operator 模块中)

__iconcat__() (在 operator 模块中)

__ifloordiv__() (object 方法)

(在 operator 模块中)

__ilshift__() (object 方法)

(在 operator 模块中)

__imatmul__() (object 方法)

(在 operator 模块中)

__imod__() (object 方法)

(在 operator 模块中)

__import__

內置函数

__import__()

內置函数

__import__() (在 importlib 模块中)

__imul__() (object 方法)

(在 operator 模块中)

__index__() (object 方法)

(在 operator 模块中)

__init__() (difflib.HtmlDiff 方法)

(logging.Handler 方法)

(logging.logging.Formatter 方法)

(object 方法)

__init_subclass__() (object 类方法)

__instancecheck__() (class 方法)

__int__() (object 方法)

__interactivehook__() (在 sys 模块中)

__inv__() (在 operator 模块中)

__invert__() (object 方法)

(在 operator 模块中)

__ior__() (object 方法)

(在 operator 模块中)

__ipow__() (object 方法)

(在 operator 模块中)

__irshift__() (object 方法)

(在 operator 模块中)

__isub__() (object 方法)

(在 operator 模块中)

__iter__() (container 方法)

(iterator 方法)

(mailbox.Mailbox 方法)

(object 方法)

(unittest.TestSuite 方法)

__itruediv__() (object 方法)

(在 operator 模块中)

__ixor__() (object 方法)

(在 operator 模块中)

__kwdefaults__ (function attribute)

__le__() (instance method)

(object 方法)

(在 operator 模块中)

__len__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mapping object method)

(object 方法)

__length_hint__() (object 方法)

__loader__

(module attribute)

(types.ModuleType 属性)

__lshift__() (object 方法)

(在 operator 模块中)

__lt__() (instance method)

(object 方法)

(在 operator 模块中)

__main__

模块, [1], [2], [3], [4], [5], [6], [7], [8]

__matmul__() (object 方法)

(在 operator 模块中)

__missing__()

(collections.defaultdict 方法)

(object 方法)

__mod__() (object 方法)

(在 operator 模块中)

__module__ (class attribute)

(function attribute)

(method attribute)

__mro__ (class 属性)

__mul__() (object 方法)

(在 operator 模块中)

__name__

(class attribute)

(definition 属性)

(function attribute)

(method attribute)

(module attribute), [1], [2]

(types.ModuleType 属性)

__ne__() (email.charset.Charset 方法)

(email.header.Header 方法)

(instance method)

(object 方法)

(在 operator 模块中)

__neg__() (object 方法)

(在 operator 模块中)

__new__() (object 方法)

__next__() (csv.csvreader 方法)

(generator 方法)

(iterator 方法)

__not__() (在 operator 模块中)

__optional_keys__ (typing.TypedDict 属性)

__or__() (object 方法)

(在 operator 模块中)

__origin__ (genericalias 属性)

__package__

(module attribute)

(types.ModuleType 属性)

__parameters__ (genericalias 属性)

__path__

__pos__() (object 方法)

(在 operator 模块中)

__pow__() (object 方法)

(在 operator 模块中)

__prepare__ (metaclass method)

__PYVENV_LAUNCHER__, [1]

__qualname__ (definition 属性)

__radd__() (object 方法)

__rand__() (object 方法)

__rdivmod__() (object 方法)

__reduce__() (object 方法)

__reduce_ex__() (object 方法)

__repr__() (multiprocessing.managers.BaseProxy 方法)

(netrc.netrc 方法)

(object 方法)

__required_keys__ (typing.TypedDict 属性)

__reversed__() (object 方法)

__rfloordiv__() (object 方法)

__rlshift__() (object 方法)

__rmatmul__() (object 方法)

__rmod__() (object 方法)

__rmul__() (object 方法)

__ror__() (object 方法)

__round__() (fractions.Fraction 方法)

(object 方法)

__rpow__() (object 方法)

__rrshift__() (object 方法)

__rshift__() (object 方法)

(在 operator 模块中)

__rsub__() (object 方法)

__rtruediv__() (object 方法)

__rxor__() (object 方法)

__self__ (method attribute)

__set__() (object 方法)

__set_name__() (object 方法)

__setattr__() (object 方法)

__setitem__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(object 方法)

(在 operator 模块中)

__setstate__() (copy protocol)

(object 方法)

__slots__

__spec__

(types.ModuleType 属性)

__stderr__() (在 sys 模块中)

__stdin__() (在 sys 模块中)

__stdout__() (在 sys 模块中)

__str__() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(email.charset.Charset 方法)

(email.header.Header 方法)

(email.headerregistry.Address 方法)

(email.headerregistry.Group 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(multiprocessing.managers.BaseProxy 方法)

(object 方法)

__sub__() (object 方法)

(在 operator 模块中)

__subclasscheck__() (class 方法)

__subclasses__() (class 方法)

__subclasshook__() (abc.ABCMeta 方法)

__suppress_context__ (traceback.TracebackException 属性)

__total__ (typing.TypedDict 属性)

__traceback__ (exception attribute)

__truediv__() (importlib.abc.Traversable 方法)

(object 方法)

(在 operator 模块中)

__trunc__() (object 方法)

__unraisablehook__() (在 sys 模块中)

__xor__() (object 方法)

(在 operator 模块中)

_anonymous_ (ctypes.Structure 属性)

_asdict() (collections.somenamedtuple 方法)

_b_base_ (ctypes._CData 属性)

_b_needsfree_ (ctypes._CData 属性)

_callmethod() (multiprocessing.managers.BaseProxy 方法)

_CData (ctypes 中的类)

_clear_type_cache() (在 sys 模块中)

_current_exceptions() (在 sys 模块中)

_current_frames() (在 sys 模块中)

_debugmallocstats() (在 sys 模块中)

_enablelegacywindowsfsencoding() (在 sys 模块中)

_exit() (在 os 模块中)

_field_defaults (collections.somenamedtuple 属性)

_fields (ast.AST 属性)

(collections.somenamedtuple 属性)

_fields_ (ctypes.Structure 属性)

_flush() (wsgiref.handlers.BaseHandler 方法)

_frozen (C struct)

_FuncPtr (ctypes 中的类)

_get_child_mock() (unittest.mock.Mock 方法)

_get_preferred_schemes() (在 sysconfig 模块中)

_getframe() (在 sys 模块中)

_getvalue() (multiprocessing.managers.BaseProxy 方法)

_handle (ctypes.PyDLL 属性)

_inittab (C struct)

_length_ (ctypes.Array 属性)

_locale

模块

_make() (collections.somenamedtuple 类方法)

_makeResult() (unittest.TextTestRunner 方法)

_name (ctypes.PyDLL 属性)

_objects (ctypes._CData 属性)

_pack_ (ctypes.Structure 属性)

_parse() (gettext.NullTranslations 方法)

_Pointer (ctypes 中的类)

_Py_c_diff (C function)

_Py_c_neg (C function)

_Py_c_pow (C function)

_Py_c_prod (C function)

_Py_c_quot (C function)

_Py_c_sum (C function)

_Py_InitializeMain (C function)

_Py_NoneStruct (C var)

_PyBytes_Resize (C function)

_PyCFunctionFast (C type)

_PyCFunctionFastWithKeywords (C type)

_PyFrameEvalFunction (C type)

_PyInterpreterState_GetEvalFrameFunc (C function)

_PyInterpreterState_SetEvalFrameFunc (C function)

_PyObject_New (C function)

_PyObject_NewVar (C function)

_PyTuple_Resize (C function)

_replace() (collections.somenamedtuple 方法)

_setroot() (xml.etree.ElementTree.ElementTree 方法)

_SimpleCData (ctypes 中的类)

_structure() (在 email.iterators 模块中)

_thread

模块, [1]

_type_ (ctypes._Pointer 属性)

(ctypes.Array 属性)

_write() (wsgiref.handlers.BaseHandler 方法)

_xoptions() (在 sys 模块中)

索引

符号 | _ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | 例 | 內 | 关 | 包 | 对 | 模 | 环 | 语 | 运

符号

! (exclamation)

in a command interpreter

in curses module

in formatted string literal

in glob-style wildcards, [1]

in string formatting

in struct format strings

! (pdb command)

! patterns

!=

运算符, [1]

" (double quote)

string literal

"""

string literal

# (hash)

comment, [1], [2]

in doctests

in printf-style formatting, [1]

in regular expressions

in string formatting

source encoding declaration

$ (dollar)

environment variables expansion

in regular expressions

in template strings

interpolation in configuration files

% (percent)

datetime format, [1], [2]

environment variables expansion (Windows), [1]

interpolation in configuration files

printf-style formatting, [1]

运算符, [1]

%=

augmented assignment

%APPDATA%

& (ampersand)

运算符, [1]

&=

augmented assignment

' (single quote)

string literal

'''

string literal

() (parentheses)

call

class definition

function definition

generator expression

in assignment target list

in printf-style formatting, [1]

in regular expressions

tuple display

(?

in regular expressions

(?!

in regular expressions

(?#

in regular expressions

(?(

in regular expressions

(?:

in regular expressions

(?<!

in regular expressions

(?<=

in regular expressions

(?=

in regular expressions

(?P<

in regular expressions

(?P=

in regular expressions

* (asterisk)

function definition

import statement

in argparse module

in assignment target list

in AST grammar

in expression lists

in function calls, [1]

in glob-style wildcards, [1]

in printf-style formatting, [1]

in regular expressions

运算符, [1]

**

function definition

in dictionary displays

in function calls, [1]

in glob-style wildcards

运算符, [1]

**=

augmented assignment

*=

augmented assignment

*?

in regular expressions

+ (plus)

binary operator, [1]

in argparse module

in doctests

in printf-style formatting, [1]

in regular expressions

in string formatting

unary operator, [1]

+=

augmented assignment

+?

in regular expressions

, (comma)

argument list

expression list, [1], [2], [3], [4]

identifier list, [1]

import statement

in dictionary displays

in string formatting

in target list

parameter list

slicing

with statement

-

python--m-py_compile command line option

- (minus)

binary operator, [1]

in doctests

in glob-style wildcards, [1]

in printf-style formatting, [1]

in regular expressions

in string formatting

unary operator, [1]

--annotate

pickletools command line option

--best

gzip command line option

--buffer

unittest command line option

--catch

unittest command line option

--check-hash-based-pycs default|always|never

command line option

--compact

json.tool command line option

--compress

zipapp command line option

--count

trace command line option

--coverdir=<dir>

trace command line option

--create <tarfile> <source1> ... <sourceN>

tarfile command line option

--create <zipfile> <source1> ... <sourceN>

zipfile command line option

--decompress

gzip command line option

--details

inspect command line option

--disable-ipv6

command line option

--disable-test-modules

command line option

--enable-big-digits=[15|30]

command line option

--enable-framework

command line option

--enable-framework=INSTALLDIR

command line option

--enable-loadable-sqlite-extensions

command line option

--enable-optimizations

command line option

--enable-profiling

command line option

--enable-shared

command line option

--enable-universalsdk

command line option

--enable-universalsdk=SDKDIR

command line option

--exact

tokenize command line option

--exec-prefix=EPREFIX

command line option

--extract <tarfile> [<output_dir>]

tarfile command line option

--extract <zipfile> <output_dir>

zipfile command line option

--failfast

unittest command line option

--fast

gzip command line option

--file=<file>

trace command line option

--filter <filtername>

tarfile command line option

--hardlink-dupes

compileall command line option

--help

ast command line option

command line option

gzip command line option

json.tool command line option

timeit command line option

tokenize command line option

trace command line option

zipapp command line option

--ignore-dir=<dir>

trace command line option

--ignore-module=<mod>

trace command line option

--include-attributes

ast command line option

--indent

json.tool command line option

--indent <indent>

ast command line option

--indentlevel=<num>

pickletools command line option

--info

zipapp command line option

--invalidation-mode [timestamp|checked-hash|unchecked-hash]

compileall command line option

--json-lines

json.tool command line option

--list <tarfile>

tarfile command line option

--list <zipfile>

zipfile command line option

--listfuncs

trace command line option

--locals

unittest command line option

--main=<mainfn>

zipapp command line option

--memo

pickletools command line option

--missing

trace command line option

--mode <mode>

ast command line option

--no-ensure-ascii

json.tool command line option

--no-indent

json.tool command line option

--no-report

trace command line option

--no-type-comments

ast command line option

--number=N

timeit command line option

--output=<file>

pickletools command line option

--output=<output>

zipapp command line option

--pattern pattern

unittest-discover command line option

--preamble=<preamble>

pickletools command line option

--prefix=PREFIX

command line option

--process

timeit command line option

--python=<interpreter>

zipapp command line option

--quiet

python--m-py_compile command line option

--repeat=N

timeit command line option

--report

trace command line option

--setup=S

timeit command line option

--sort-keys

json.tool command line option

--start-directory directory

unittest-discover command line option

--summary

trace command line option

--tab

json.tool command line option

--test <tarfile>

tarfile command line option

--test <zipfile>

zipfile command line option

--timing

trace command line option

--top-level-directory directory

unittest-discover command line option

--trace

trace command line option

--trackcalls

trace command line option

--unit=U

timeit command line option

--user-base

site command line option

--user-site

site command line option

--verbose

tarfile command line option

timeit command line option

unittest-discover command line option

--version

command line option

trace command line option

--with-address-sanitizer

command line option

--with-assertions

command line option

--with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2

command line option

--with-computed-gotos

command line option

--with-cxx-main

command line option

--with-cxx-main=COMPILER

command line option

--with-dbmliborder=db1:db2:...

command line option

--with-dtrace

command line option

--with-ensurepip=[upgrade|install|no]

command line option

--with-framework-name=FRAMEWORK

command line option

--with-hash-algorithm=[fnv|siphash24]

command line option

--with-libc=STRING

command line option

--with-libm=STRING

command line option

--with-libs='lib1 ...'

command line option

--with-lto

command line option

--with-memory-sanitizer

command line option

--with-openssl-rpath=[no|auto|DIR]

command line option

--with-openssl=DIR

command line option

--with-platlibdir=DIRNAME

command line option

--with-pydebug

command line option

--with-readline=editline

command line option

--with-ssl-default-suites=[python|openssl|STRING]

command line option

--with-suffix=SUFFIX

command line option

--with-system-expat

command line option

--with-system-ffi

command line option

--with-system-libmpdec

command line option

--with-tcltk-includes='-I...'

command line option

--with-tcltk-libs='-L...'

command line option

--with-trace-refs

command line option

--with-tzpath=<list of absolute paths separated by pathsep>

command line option

--with-undefined-behavior-sanitizer

command line option

--with-universal-archs=ARCH

command line option

--with-valgrind

command line option

--with-wheel-pkg-dir=PATH

command line option

--without-c-locale-coercion

command line option

--without-decimal-contextvar

command line option

--without-doc-strings

command line option

--without-pymalloc

command line option

--without-readline

command line option

--without-static-libpython

command line option

-=

augmented assignment

->

function annotations, [1]

-?

command line option

-a

ast command line option

pickletools command line option

-B

command line option

-b

command line option

compileall command line option

unittest command line option

-C

trace command line option

-c

trace command line option

unittest command line option

zipapp command line option

-c <command>

command line option

-c <tarfile> <source1> ... <sourceN>

tarfile command line option

-c <zipfile> <source1> ... <sourceN>

zipfile command line option

-d

command line option

gzip command line option

-d destdir

compileall command line option

-E

command line option

-e

tokenize command line option

-e <tarfile> [<output_dir>]

tarfile command line option

-e <zipfile> <output_dir>

zipfile command line option

-e dir

compileall command line option

-f

compileall command line option

trace command line option

unittest command line option

-g

trace command line option

-h

ast command line option

command line option

gzip command line option

json.tool command line option

timeit command line option

tokenize command line option

zipapp command line option

-I

command line option

-i

command line option

-i <indent>

ast command line option

-i list

compileall command line option

-J

command line option

-j N

compileall command line option

-k

unittest command line option

-l

compileall command line option

pickletools command line option

trace command line option

-l <tarfile>

tarfile command line option

-l <zipfile>

zipfile command line option

-m

pickletools command line option

trace command line option

-m <mainfn>

zipapp command line option

-m <mode>

ast command line option

-m <module-name>

command line option

-n N

timeit command line option

-O

command line option

-o

pickletools command line option

-o <output>

zipapp command line option

-o level

compileall command line option

-OO

command line option

-p

pickletools command line option

timeit command line option

unittest-discover command line option

-p <interpreter>

zipapp command line option

-p prepend_prefix

compileall command line option

-q

command line option

compileall command line option

python--m-py_compile command line option

-R

command line option

trace command line option

-r

compileall command line option

trace command line option

-r N

timeit command line option

-S

command line option

-s

command line option

trace command line option

unittest-discover command line option

-s S

timeit command line option

-s strip_prefix

compileall command line option

-T

trace command line option

-t

trace command line option

unittest-discover command line option

-t <tarfile>

tarfile command line option

-t <zipfile>

zipfile command line option

-u

command line option

timeit command line option

-V

command line option

-v

command line option

tarfile command line option

timeit command line option

unittest-discover command line option

-W arg

command line option

-X

command line option

-x

command line option

-x regex

compileall command line option

. (dot)

attribute reference

in glob-style wildcards

in numeric literal

in pathnames, [1]

in printf-style formatting, [1]

in regular expressions

in string formatting

..

in pathnames

...

ellipsis literal, [1], [2]

in doctests

interpreter prompt, [1]

placeholder, [1], [2]

.ini

file

.pdbrc

file

/ (slash)

function definition

in pathnames, [1]

运算符, [1]

//

运算符, [1]

//=

augmented assignment

/=

augmented assignment

0b

integer literal

0o

integer literal

0x

integer literal

2-digit years

2to3

: (colon)

annotated variable

compound statement, [1], [2], [3], [4], [5], [6], [7]

function annotations, [1]

in dictionary expressions

in formatted string literal

in SQL statements

in string formatting

lambda expression

path separator (POSIX)

slicing

:= (colon equals)

; (semicolon), [1]

< (less)

in string formatting

in struct format strings

运算符, [1]

<<

运算符, [1]

<<=

augmented assignment

<=

运算符, [1]

<BLANKLINE>

<file> ... <fileN>

python--m-py_compile command line option

= (equals)

assignment statement

class definition

for help in debugging using string literals

function definition

in function calls

in string formatting

in struct format strings

==

运算符, [1]

> (greater)

in string formatting

in struct format strings

运算符, [1]

>=

运算符, [1]

>>

运算符, [1]

>>=

augmented assignment

>>>

interpreter prompt, [1]

? (question mark)

in a command interpreter

in argparse module

in AST grammar

in glob-style wildcards, [1]

in regular expressions

in SQL statements

in struct format strings, [1]

replacement character

??

in regular expressions

@ (at)

class definition

function definition

in struct format strings

运算符

[] (square brackets)

in assignment target list

in glob-style wildcards, [1]

in regular expressions

in string formatting

list expression

subscription

\ (backslash)

escape sequence, [1]

in pathnames (Windows)

in regular expressions, [1], [2]

\\

escape sequence

in regular expressions

\A

in regular expressions

\a

escape sequence

in regular expressions

\B

in regular expressions

\b

escape sequence

in regular expressions, [1]

\D

in regular expressions

\d

in regular expressions

\f

escape sequence

in regular expressions

\g

in regular expressions

\N

escape sequence, [1]

in regular expressions

\n

escape sequence

in regular expressions

\r

escape sequence

in regular expressions

\S

in regular expressions

\s

in regular expressions

\t

escape sequence

in regular expressions

\U

escape sequence, [1]

in regular expressions

\u

escape sequence, [1]

in regular expressions

\v

escape sequence

in regular expressions

\W

in regular expressions

\w

in regular expressions

\x

escape sequence, [1]

in regular expressions

\Z

in regular expressions

^ (caret)

in curses module

in regular expressions, [1]

in string formatting

marker, [1]

运算符, [1]

^=

augmented assignment

{} (curly brackets)

dictionary expression

in formatted string literal

in regular expressions

in string formatting

set expression

| (vertical bar)

in regular expressions

运算符, [1]

|=

augmented assignment

~ (tilde)

home directory expansion

运算符, [1]

_

_ (underscore)

gettext

in numeric literal, [1]

in string formatting

_, identifiers

__, identifiers

__abs__() (object 方法)

(在 operator 模块中)

__add__() (object 方法)

(在 operator 模块中)

__aenter__() (object 方法)

__aexit__() (object 方法)

__aiter__() (object 方法)

__all__

(optional module attribute)

(package variable)

__and__() (object 方法)

(在 operator 模块中)

__anext__() (agen 方法)

(object 方法)

__annotations__ (class attribute)

(function attribute)

(module attribute)

__args__ (genericalias 属性)

__await__() (object 方法)

__bases__ (class attribute)

(class 属性)

__bool__() (object method)

(object 方法)

__breakpointhook__() (在 sys 模块中)

__bytes__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(object 方法)

__cached__

__call__() (email.headerregistry.HeaderRegistry 方法)

(object method)

(object 方法)

(weakref.finalize 方法)

__callback__ (weakref.ref 属性)

__cause__ (exception attribute)

(traceback.TracebackException 属性)

__ceil__() (fractions.Fraction 方法)

(object 方法)

__class__ (instance attribute)

(instance 属性)

(method cell)

(module attribute)

(unittest.mock.Mock 属性)

__class_getitem__() (object 类方法)

__classcell__ (class namespace entry)

__closure__ (function attribute)

__code__ (function attribute)

(function object attribute)

__complex__() (object 方法)

__concat__() (在 operator 模块中)

__contains__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(object 方法)

(在 operator 模块中)

__context__ (exception attribute)

(traceback.TracebackException 属性)

__copy__() (copy protocol)

__debug__

(內置变量)

__deepcopy__() (copy protocol)

__defaults__ (function attribute)

__del__() (io.IOBase 方法)

(object 方法)

__delattr__() (object 方法)

__delete__() (object 方法)

__delitem__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mailbox.MH 方法)

(object 方法)

(在 operator 模块中)

__dict__ (class attribute)

(function attribute)

(instance attribute)

(module attribute), [1]

(object 属性)

__dir__ (module attribute)

__dir__() (object 方法)

(unittest.mock.Mock 方法)

__displayhook__() (在 sys 模块中)

__divmod__() (object 方法)

__doc__ (class attribute)

(function attribute)

(method attribute)

(module attribute), [1]

(types.ModuleType 属性)

__enter__() (contextmanager 方法)

(object 方法)

(winreg.PyHKEY 方法)

__eq__() (email.charset.Charset 方法)

(email.header.Header 方法)

(instance method)

(memoryview 方法)

(object 方法)

(在 operator 模块中)

__excepthook__() (在 sys 模块中)

(在 threading 模块中)

__exit__() (contextmanager 方法)

(object 方法)

(winreg.PyHKEY 方法)

__file__

(module attribute), [1], [2]

__float__() (object 方法)

__floor__() (fractions.Fraction 方法)

(object 方法)

__floordiv__() (object 方法)

(在 operator 模块中)

__format__

__format__() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(ipaddress.IPv4Address 方法)

(ipaddress.IPv6Address 方法)

(object 方法)

__fspath__() (os.PathLike 方法)

__func__ (method attribute)

__future__

future statement

模块

__ge__() (instance method)

(object 方法)

(在 operator 模块中)

__get__() (object 方法)

__getattr__ (module attribute)

__getattr__() (object 方法)

__getattribute__() (object 方法)

__getitem__() (email.headerregistry.HeaderRegistry 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mapping object method)

(object 方法)

(re.Match 方法)

(在 operator 模块中)

__getnewargs__() (object 方法)

__getnewargs_ex__() (object 方法)

__getstate__() (copy protocol)

(object 方法)

__globals__ (function attribute)

__gt__() (instance method)

(object 方法)

(在 operator 模块中)

__hash__() (object 方法)

__iadd__() (object 方法)

(在 operator 模块中)

__iand__() (object 方法)

(在 operator 模块中)

__iconcat__() (在 operator 模块中)

__ifloordiv__() (object 方法)

(在 operator 模块中)

__ilshift__() (object 方法)

(在 operator 模块中)

__imatmul__() (object 方法)

(在 operator 模块中)

__imod__() (object 方法)

(在 operator 模块中)

__import__

內置函数

__import__()

內置函数

__import__() (在 importlib 模块中)

__imul__() (object 方法)

(在 operator 模块中)

__index__() (object 方法)

(在 operator 模块中)

__init__() (difflib.HtmlDiff 方法)

(logging.Handler 方法)

(logging.logging.Formatter 方法)

(object 方法)

__init_subclass__() (object 类方法)

__instancecheck__() (class 方法)

__int__() (object 方法)

__interactivehook__() (在 sys 模块中)

__inv__() (在 operator 模块中)

__invert__() (object 方法)

(在 operator 模块中)

__ior__() (object 方法)

(在 operator 模块中)

__ipow__() (object 方法)

(在 operator 模块中)

__irshift__() (object 方法)

(在 operator 模块中)

__isub__() (object 方法)

(在 operator 模块中)

__iter__() (container 方法)

(iterator 方法)

(mailbox.Mailbox 方法)

(object 方法)

(unittest.TestSuite 方法)

__itruediv__() (object 方法)

(在 operator 模块中)

__ixor__() (object 方法)

(在 operator 模块中)

__kwdefaults__ (function attribute)

__le__() (instance method)

(object 方法)

(在 operator 模块中)

__len__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mapping object method)

(object 方法)

__length_hint__() (object 方法)

__loader__

(module attribute)

(types.ModuleType 属性)

__lshift__() (object 方法)

(在 operator 模块中)

__lt__() (instance method)

(object 方法)

(在 operator 模块中)

__main__

模块, [1], [2], [3], [4], [5], [6], [7], [8]

__matmul__() (object 方法)

(在 operator 模块中)

__missing__()

(collections.defaultdict 方法)

(object 方法)

__mod__() (object 方法)

(在 operator 模块中)

__module__ (class attribute)

(function attribute)

(method attribute)

__mro__ (class 属性)

__mul__() (object 方法)

(在 operator 模块中)

__name__

(class attribute)

(definition 属性)

(function attribute)

(method attribute)

(module attribute), [1], [2]

(types.ModuleType 属性)

__ne__() (email.charset.Charset 方法)

(email.header.Header 方法)

(instance method)

(object 方法)

(在 operator 模块中)

__neg__() (object 方法)

(在 operator 模块中)

__new__() (object 方法)

__next__() (csv.csvreader 方法)

(generator 方法)

(iterator 方法)

__not__() (在 operator 模块中)

__optional_keys__ (typing.TypedDict 属性)

__or__() (object 方法)

(在 operator 模块中)

__origin__ (genericalias 属性)

__package__

(module attribute)

(types.ModuleType 属性)

__parameters__ (genericalias 属性)

__path__

__pos__() (object 方法)

(在 operator 模块中)

__pow__() (object 方法)

(在 operator 模块中)

__prepare__ (metaclass method)

__PYVENV_LAUNCHER__, [1]

__qualname__ (definition 属性)

__radd__() (object 方法)

__rand__() (object 方法)

__rdivmod__() (object 方法)

__reduce__() (object 方法)

__reduce_ex__() (object 方法)

__repr__() (multiprocessing.managers.BaseProxy 方法)

(netrc.netrc 方法)

(object 方法)

__required_keys__ (typing.TypedDict 属性)

__reversed__() (object 方法)

__rfloordiv__() (object 方法)

__rlshift__() (object 方法)

__rmatmul__() (object 方法)

__rmod__() (object 方法)

__rmul__() (object 方法)

__ror__() (object 方法)

__round__() (fractions.Fraction 方法)

(object 方法)

__rpow__() (object 方法)

__rrshift__() (object 方法)

__rshift__() (object 方法)

(在 operator 模块中)

__rsub__() (object 方法)

__rtruediv__() (object 方法)

__rxor__() (object 方法)

__self__ (method attribute)

__set__() (object 方法)

__set_name__() (object 方法)

__setattr__() (object 方法)

__setitem__() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(object 方法)

(在 operator 模块中)

__setstate__() (copy protocol)

(object 方法)

__slots__

__spec__

(types.ModuleType 属性)

__stderr__() (在 sys 模块中)

__stdin__() (在 sys 模块中)

__stdout__() (在 sys 模块中)

__str__() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(email.charset.Charset 方法)

(email.header.Header 方法)

(email.headerregistry.Address 方法)

(email.headerregistry.Group 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(multiprocessing.managers.BaseProxy 方法)

(object 方法)

__sub__() (object 方法)

(在 operator 模块中)

__subclasscheck__() (class 方法)

__subclasses__() (class 方法)

__subclasshook__() (abc.ABCMeta 方法)

__suppress_context__ (traceback.TracebackException 属性)

__total__ (typing.TypedDict 属性)

__traceback__ (exception attribute)

__truediv__() (importlib.abc.Traversable 方法)

(object 方法)

(在 operator 模块中)

__trunc__() (object 方法)

__unraisablehook__() (在 sys 模块中)

__xor__() (object 方法)

(在 operator 模块中)

_anonymous_ (ctypes.Structure 属性)

_asdict() (collections.somenamedtuple 方法)

_b_base_ (ctypes._CData 属性)

_b_needsfree_ (ctypes._CData 属性)

_callmethod() (multiprocessing.managers.BaseProxy 方法)

_CData (ctypes 中的类)

_clear_type_cache() (在 sys 模块中)

_current_exceptions() (在 sys 模块中)

_current_frames() (在 sys 模块中)

_debugmallocstats() (在 sys 模块中)

_enablelegacywindowsfsencoding() (在 sys 模块中)

_exit() (在 os 模块中)

_field_defaults (collections.somenamedtuple 属性)

_fields (ast.AST 属性)

(collections.somenamedtuple 属性)

_fields_ (ctypes.Structure 属性)

_flush() (wsgiref.handlers.BaseHandler 方法)

_frozen (C struct)

_FuncPtr (ctypes 中的类)

_get_child_mock() (unittest.mock.Mock 方法)

_get_preferred_schemes() (在 sysconfig 模块中)

_getframe() (在 sys 模块中)

_getvalue() (multiprocessing.managers.BaseProxy 方法)

_handle (ctypes.PyDLL 属性)

_inittab (C struct)

_length_ (ctypes.Array 属性)

_locale

模块

_make() (collections.somenamedtuple 类方法)

_makeResult() (unittest.TextTestRunner 方法)

_name (ctypes.PyDLL 属性)

_objects (ctypes._CData 属性)

_pack_ (ctypes.Structure 属性)

_parse() (gettext.NullTranslations 方法)

_Pointer (ctypes 中的类)

_Py_c_diff (C function)

_Py_c_neg (C function)

_Py_c_pow (C function)

_Py_c_prod (C function)

_Py_c_quot (C function)

_Py_c_sum (C function)

_Py_InitializeMain (C function)

_Py_NoneStruct (C var)

_PyBytes_Resize (C function)

_PyCFunctionFast (C type)

_PyCFunctionFastWithKeywords (C type)

_PyFrameEvalFunction (C type)

_PyInterpreterState_GetEvalFrameFunc (C function)

_PyInterpreterState_SetEvalFrameFunc (C function)

_PyObject_New (C function)

_PyObject_NewVar (C function)

_PyTuple_Resize (C function)

_replace() (collections.somenamedtuple 方法)

_setroot() (xml.etree.ElementTree.ElementTree 方法)

_SimpleCData (ctypes 中的类)

_structure() (在 email.iterators 模块中)

_thread

模块, [1]

_type_ (ctypes._Pointer 属性)

(ctypes.Array 属性)

_write() (wsgiref.handlers.BaseHandler 方法)

_xoptions() (在 sys 模块中)

A

A() (在 re 模块中)

A-LAW, [1]

a-LAW

a2b_base64() (在 binascii 模块中)

a2b_hex() (在 binascii 模块中)

a2b_hqx() (在 binascii 模块中)

a2b_qp() (在 binascii 模块中)

a2b_uu() (在 binascii 模块中)

a85decode() (在 base64 模块中)

a85encode() (在 base64 模块中)

abc

模块

ABC (abc 中的类)

ABCMeta (abc 中的类)

abiflags() (在 sys 模块中)

abort()

(asyncio.DatagramTransport 方法)

(asyncio.WriteTransport 方法)

(ftplib.FTP 方法)

(threading.Barrier 方法)

(在 os 模块中)

above() (curses.panel.Panel 方法)

ABOVE_NORMAL_PRIORITY_CLASS() (在 subprocess 模块中)

abs

內置函数, [1]

abs()

內置函数

abs() (decimal.Context 方法)

(在 operator 模块中)

AbsoluteLinkError

AbsolutePathError

abspath() (在 os.path 模块中)

abstract base class -- 抽象基类

AbstractAsyncContextManager (contextlib 中的类)

AbstractBasicAuthHandler (urllib.request 中的类)

AbstractChildWatcher (asyncio 中的类)

abstractclassmethod() (在 abc 模块中)

AbstractContextManager (contextlib 中的类)

AbstractDigestAuthHandler (urllib.request 中的类)

AbstractEventLoop (asyncio 中的类)

AbstractEventLoopPolicy (asyncio 中的类)

abstractmethod() (在 abc 模块中)

abstractproperty() (在 abc 模块中)

AbstractSet (typing 中的类)

abstractstaticmethod() (在 abc 模块中)

accept() (asyncore.dispatcher 方法)

(multiprocessing.connection.Listener 方法)

(socket.socket 方法)

access() (在 os 模块中)

accumulate() (在 itertools 模块中)

aclose() (agen 方法)

(contextlib.AsyncExitStack 方法)

aclosing() (在 contextlib 模块中)

acos() (在 cmath 模块中)

(在 math 模块中)

acosh() (在 cmath 模块中)

(在 math 模块中)

acquire() (_thread.lock 方法)

(asyncio.Condition 方法)

(asyncio.Lock 方法)

(asyncio.Semaphore 方法)

(logging.Handler 方法)

(multiprocessing.Lock 方法)

(multiprocessing.RLock 方法)

(threading.Condition 方法)

(threading.Lock 方法)

(threading.RLock 方法)

(threading.Semaphore 方法)

acquire_lock() (在 imp 模块中)

Action (argparse 中的类)

action (optparse.Option 属性)

ACTIONS (optparse.Option 属性)

active_children() (在 multiprocessing 模块中)

active_count() (在 threading 模块中)

actual() (tkinter.font.Font 方法)

Add (ast 中的类)

add() (decimal.Context 方法)

(frozenset 方法)

(graphlib.TopologicalSorter 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(msilib.RadioButtonGroup 方法)

(pstats.Stats 方法)

(tarfile.TarFile 方法)

(tkinter.ttk.Notebook 方法)

(在 audioop 模块中)

(在 operator 模块中)

add_alias() (在 email.charset 模块中)

add_alternative() (email.message.EmailMessage 方法)

add_argument() (argparse.ArgumentParser 方法)

add_argument_group() (argparse.ArgumentParser 方法)

add_attachment() (email.message.EmailMessage 方法)

add_cgi_vars() (wsgiref.handlers.BaseHandler 方法)

add_charset() (在 email.charset 模块中)

add_child_handler() (asyncio.AbstractChildWatcher 方法)

add_codec() (在 email.charset 模块中)

add_cookie_header() (http.cookiejar.CookieJar 方法)

add_data() (在 msilib 模块中)

add_dll_directory() (在 os 模块中)

add_done_callback() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

add_fallback() (gettext.NullTranslations 方法)

add_file() (msilib.Directory 方法)

add_flag() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

add_folder() (mailbox.Maildir 方法)

(mailbox.MH 方法)

add_get_handler() (email.contentmanager.ContentManager 方法)

add_handler() (urllib.request.OpenerDirector 方法)

add_header() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(urllib.request.Request 方法)

(wsgiref.headers.Headers 方法)

add_history() (在 readline 模块中)

add_include_dir() (distutils.ccompiler.CCompiler 方法)

add_label() (mailbox.BabylMessage 方法)

add_library() (distutils.ccompiler.CCompiler 方法)

add_library_dir() (distutils.ccompiler.CCompiler 方法)

add_link_object() (distutils.ccompiler.CCompiler 方法)

add_mutually_exclusive_group() (argparse.ArgumentParser 方法)

add_option() (optparse.OptionParser 方法)

add_parent() (urllib.request.BaseHandler 方法)

add_password() (urllib.request.HTTPPasswordMgr 方法)

(urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

add_reader() (asyncio.loop 方法)

add_related() (email.message.EmailMessage 方法)

add_runtime_library_dir() (distutils.ccompiler.CCompiler 方法)

add_section() (configparser.ConfigParser 方法)

(configparser.RawConfigParser 方法)

add_sequence() (mailbox.MHMessage 方法)

add_set_handler() (email.contentmanager.ContentManager 方法)

add_signal_handler() (asyncio.loop 方法)

add_stream() (在 msilib 模块中)

add_subparsers() (argparse.ArgumentParser 方法)

add_tables() (在 msilib 模块中)

add_type() (在 mimetypes 模块中)

add_unredirected_header() (urllib.request.Request 方法)

add_writer() (asyncio.loop 方法)

addAsyncCleanup() (unittest.IsolatedAsyncioTestCase 方法)

addaudithook() (在 sys 模块中)

addch() (curses.window 方法)

addClassCleanup() (unittest.TestCase 类方法)

addCleanup() (unittest.TestCase 方法)

addcomponent() (turtle.Shape 方法)

addError() (unittest.TestResult 方法)

addExpectedFailure() (unittest.TestResult 方法)

addFailure() (unittest.TestResult 方法)

addfile() (tarfile.TarFile 方法)

addFilter() (logging.Handler 方法)

(logging.Logger 方法)

addHandler() (logging.Logger 方法)

addinfourl (urllib.response 中的类)

addition

addLevelName() (在 logging 模块中)

addModuleCleanup() (在 unittest 模块中)

addnstr() (curses.window 方法)

AddPackagePath() (在 modulefinder 模块中)

addr (smtpd.SMTPChannel 属性)

addr_spec (email.headerregistry.Address 属性)

Address (email.headerregistry 中的类)

address (email.headerregistry.SingleAddressHeader 属性)

(multiprocessing.connection.Listener 属性)

(multiprocessing.managers.BaseManager 属性)

address_exclude() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

address_family (socketserver.BaseServer 属性)

address_string() (http.server.BaseHTTPRequestHandler 方法)

addresses (email.headerregistry.AddressHeader 属性)

(email.headerregistry.Group 属性)

AddressHeader (email.headerregistry 中的类)

addressof() (在 ctypes 模块中)

AddressValueError

addshape() (在 turtle 模块中)

addsitedir() (在 site 模块中)

addSkip() (unittest.TestResult 方法)

addstr() (curses.window 方法)

addSubTest() (unittest.TestResult 方法)

addSuccess() (unittest.TestResult 方法)

addTest() (unittest.TestSuite 方法)

addTests() (unittest.TestSuite 方法)

addTypeEqualityFunc() (unittest.TestCase 方法)

addUnexpectedSuccess() (unittest.TestResult 方法)

adjust_int_max_str_digits() (在 test.support 模块中)

adjusted() (decimal.Decimal 方法)

adler32() (在 zlib 模块中)

ADPCM, Intel/DVI

adpcm2lin() (在 audioop 模块中)

AF_ALG() (在 socket 模块中)

AF_CAN() (在 socket 模块中)

AF_INET() (在 socket 模块中)

AF_INET6() (在 socket 模块中)

AF_LINK() (在 socket 模块中)

AF_PACKET() (在 socket 模块中)

AF_QIPCRTR() (在 socket 模块中)

AF_RDS() (在 socket 模块中)

AF_UNIX() (在 socket 模块中)

AF_VSOCK() (在 socket 模块中)

aifc

模块

aifc() (aifc.aifc 方法)

AIFF, [1]

aiff() (aifc.aifc 方法)

AIFF-C, [1]

aiter()

內置函数

alarm() (在 signal 模块中)

alaw2lin() (在 audioop 模块中)

ALERT_DESCRIPTION_HANDSHAKE_FAILURE() (在 ssl 模块中)

ALERT_DESCRIPTION_INTERNAL_ERROR() (在 ssl 模块中)

AlertDescription (ssl 中的类)

algorithms_available() (在 hashlib 模块中)

algorithms_guaranteed() (在 hashlib 模块中)

Alias

Generic

alias (ast 中的类)

(pdb command)

alignment() (在 ctypes 模块中)

alive (weakref.finalize 属性)

all()

內置函数

all_errors() (在 ftplib 模块中)

all_features() (在 xml.sax.handler 模块中)

all_frames (tracemalloc.Filter 属性)

all_properties() (在 xml.sax.handler 模块中)

all_suffixes() (在 importlib.machinery 模块中)

all_tasks() (在 asyncio 模块中)

allocate_lock() (在 _thread 模块中)

allocfunc (C type)

ALLOW_MISSING() (在 os.path 模块中)

allow_reuse_address (socketserver.BaseServer 属性)

allowed_domains() (http.cookiejar.DefaultCookiePolicy 方法)

alt() (在 curses.ascii 模块中)

ALT_DIGITS() (在 locale 模块中)

altsep() (在 os 模块中)

altzone() (在 time 模块中)

ALWAYS_EQ() (在 test.support 模块中)

ALWAYS_TYPED_ACTIONS (optparse.Option 属性)

AMPER() (在 token 模块中)

AMPEREQUAL() (在 token 模块中)

anchor (pathlib.PurePath 属性)

and

bitwise

运算符, [1], [2]

And (ast 中的类)

and_() (在 operator 模块中)

anext()

內置函数

AnnAssign (ast 中的类)

annotated

assignment

Annotated() (在 typing 模块中)

annotation

type annotation; type hint

annotation (inspect.Parameter 属性)

annotation -- 标注

annotations

function, [1]

announce() (distutils.ccompiler.CCompiler 方法)

anonymous

function

answer_challenge() (在 multiprocessing.connection 模块中)

anticipate_failure() (在 test.support 模块中)

any()

內置函数

Any() (在 typing 模块中)

ANY() (在 unittest.mock 模块中)

AnyStr() (在 typing 模块中)

api_version() (在 sys 模块中)

apilevel() (在 sqlite3 模块中)

apop() (poplib.POP3 方法)

APPDATA

append() (array.array 方法)

(collections.deque 方法)

(email.header.Header 方法)

(imaplib.IMAP4 方法)

(msilib.CAB 方法)

(pipes.Template 方法)

(sequence method)

(xml.etree.ElementTree.Element 方法)

append_history_file() (在 readline 模块中)

appendChild() (xml.dom.Node 方法)

appendleft() (collections.deque 方法)

application_uri() (在 wsgiref.util 模块中)

apply (2to3 fixer)

apply() (multiprocessing.pool.Pool 方法)

apply_async() (multiprocessing.pool.Pool 方法)

apply_defaults() (inspect.BoundArguments 方法)

architecture() (在 platform 模块中)

archive (zipimport.zipimporter 属性)

aRepr() (在 reprlib 模块中)

arg (ast 中的类)

argparse

模块

args (BaseException 属性)

(functools.partial 属性)

(inspect.BoundArguments 属性)

(pdb command)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

(typing.ParamSpec 属性)

args_from_interpreter_flags() (在 test.support 模块中)

argtypes (ctypes._FuncPtr 属性)

argument

call semantics

difference from parameter

function

function definition

argument -- 参数

ArgumentDefaultsHelpFormatter (argparse 中的类)

ArgumentError

ArgumentParser (argparse 中的类)

arguments (ast 中的类)

(inspect.BoundArguments 属性)

argv (in module sys)

argv() (在 sys 模块中)

arithmetic

conversion

operation, binary

operation, unary

ArithmeticError

array

模块, [1], [2]

array (array 中的类)

Array (ctypes 中的类)

Array() (multiprocessing.managers.SyncManager 方法)

(在 multiprocessing 模块中)

(在 multiprocessing.sharedctypes 模块中)

arrays

arraysize (sqlite3.Cursor 属性)

article() (nntplib.NNTP 方法)

as

except clause

import statement

match statement

with statement

关键字, [1], [2], [3]

AS pattern, OR pattern, capture pattern, wildcard pattern

as_bytes() (email.message.EmailMessage 方法)

(email.message.Message 方法)

as_completed() (在 asyncio 模块中)

(在 concurrent.futures 模块中)

as_file() (在 importlib.resources 模块中)

as_integer_ratio() (decimal.Decimal 方法)

(float 方法)

(fractions.Fraction 方法)

(int 方法)

as_posix() (pathlib.PurePath 方法)

as_string() (email.message.EmailMessage 方法)

(email.message.Message 方法)

as_tuple() (decimal.Decimal 方法)

as_uri() (pathlib.PurePath 方法)

ASCII, [1]

ascii

內置函数

ascii()

內置函数

ascii() (在 curses.ascii 模块中)

ASCII() (在 re 模块中)

ascii_letters() (在 string 模块中)

ascii_lowercase() (在 string 模块中)

ascii_uppercase() (在 string 模块中)

asctime() (在 time 模块中)

asdict() (在 dataclasses 模块中)

asend() (agen 方法)

asin() (在 cmath 模块中)

(在 math 模块中)

asinh() (在 cmath 模块中)

(在 math 模块中)

askcolor() (在 tkinter.colorchooser 模块中)

askdirectory() (在 tkinter.filedialog 模块中)

askfloat() (在 tkinter.simpledialog 模块中)

askinteger() (在 tkinter.simpledialog 模块中)

askokcancel() (在 tkinter.messagebox 模块中)

askopenfile() (在 tkinter.filedialog 模块中)

askopenfilename() (在 tkinter.filedialog 模块中)

askopenfilenames() (在 tkinter.filedialog 模块中)

askopenfiles() (在 tkinter.filedialog 模块中)

askquestion() (在 tkinter.messagebox 模块中)

askretrycancel() (在 tkinter.messagebox 模块中)

asksaveasfile() (在 tkinter.filedialog 模块中)

asksaveasfilename() (在 tkinter.filedialog 模块中)

askstring() (在 tkinter.simpledialog 模块中)

askyesno() (在 tkinter.messagebox 模块中)

askyesnocancel() (在 tkinter.messagebox 模块中)

assert

语句, [1]

Assert (ast 中的类)

assert_any_await() (unittest.mock.AsyncMock 方法)

assert_any_call() (unittest.mock.Mock 方法)

assert_awaited() (unittest.mock.AsyncMock 方法)

assert_awaited_once() (unittest.mock.AsyncMock 方法)

assert_awaited_once_with() (unittest.mock.AsyncMock 方法)

assert_awaited_with() (unittest.mock.AsyncMock 方法)

assert_called() (unittest.mock.Mock 方法)

assert_called_once() (unittest.mock.Mock 方法)

assert_called_once_with() (unittest.mock.Mock 方法)

assert_called_with() (unittest.mock.Mock 方法)

assert_has_awaits() (unittest.mock.AsyncMock 方法)

assert_has_calls() (unittest.mock.Mock 方法)

assert_not_awaited() (unittest.mock.AsyncMock 方法)

assert_not_called() (unittest.mock.Mock 方法)

assert_python_failure() (在 test.support.script_helper 模块中)

assert_python_ok() (在 test.support.script_helper 模块中)

assertAlmostEqual() (unittest.TestCase 方法)

assertCountEqual() (unittest.TestCase 方法)

assertDictEqual() (unittest.TestCase 方法)

assertEqual() (unittest.TestCase 方法)

assertFalse() (unittest.TestCase 方法)

assertGreater() (unittest.TestCase 方法)

assertGreaterEqual() (unittest.TestCase 方法)

assertIn() (unittest.TestCase 方法)

assertInBytecode() (test.support.bytecode_helper.BytecodeTestCase 方法)

AssertionError

例外

assertions

debugging

assertIs() (unittest.TestCase 方法)

assertIsInstance() (unittest.TestCase 方法)

assertIsNone() (unittest.TestCase 方法)

assertIsNot() (unittest.TestCase 方法)

assertIsNotNone() (unittest.TestCase 方法)

assertLess() (unittest.TestCase 方法)

assertLessEqual() (unittest.TestCase 方法)

assertListEqual() (unittest.TestCase 方法)

assertLogs() (unittest.TestCase 方法)

assertMultiLineEqual() (unittest.TestCase 方法)

assertNoLogs() (unittest.TestCase 方法)

assertNotAlmostEqual() (unittest.TestCase 方法)

assertNotEqual() (unittest.TestCase 方法)

assertNotIn() (unittest.TestCase 方法)

assertNotInBytecode() (test.support.bytecode_helper.BytecodeTestCase 方法)

assertNotIsInstance() (unittest.TestCase 方法)

assertNotRegex() (unittest.TestCase 方法)

assertRaises() (unittest.TestCase 方法)

assertRaisesRegex() (unittest.TestCase 方法)

assertRegex() (unittest.TestCase 方法)

asserts (2to3 fixer)

assertSequenceEqual() (unittest.TestCase 方法)

assertSetEqual() (unittest.TestCase 方法)

assertTrue() (unittest.TestCase 方法)

assertTupleEqual() (unittest.TestCase 方法)

assertWarns() (unittest.TestCase 方法)

assertWarnsRegex() (unittest.TestCase 方法)

Assign (ast 中的类)

assignment

annotated

attribute, [1]

augmented

class attribute

class instance attribute

slice

slicing

statement, [1]

subscript

subscription

target list

assignment expression

ast

模块

AST (ast 中的类)

ast command line option

--help

--include-attributes

--indent <indent>

--mode <mode>

--no-type-comments

-a

-h

-i <indent>

-m <mode>

astimezone() (datetime.datetime 方法)

astuple() (在 dataclasses 模块中)

async

关键字

async def

语句

async for

in comprehensions

语句

async with

语句

ASYNC() (在 token 模块中)

async_chat (asynchat 中的类)

async_chat.ac_in_buffer_size() (在 asynchat 模块中)

async_chat.ac_out_buffer_size() (在 asynchat 模块中)

AsyncContextDecorator (contextlib 中的类)

AsyncContextManager (typing 中的类)

asynccontextmanager() (在 contextlib 模块中)

AsyncExitStack (contextlib 中的类)

AsyncFor (ast 中的类)

AsyncFunctionDef (ast 中的类)

AsyncGenerator (collections.abc 中的类)

(typing 中的类)

AsyncGeneratorType() (在 types 模块中)

asynchat

模块

asynchronous context manager -- 异步上下文管理器

asynchronous generator

asynchronous iterator

function

asynchronous generator -- 异步生成器

asynchronous generator iterator -- 异步生成器迭代器

asynchronous iterable -- 异步可迭代对象

asynchronous iterator -- 异步迭代器

asynchronous-generator

对象

asyncio

模块

asyncio.subprocess.DEVNULL (內置变量)

asyncio.subprocess.PIPE (內置变量)

asyncio.subprocess.Process (內置类)

asyncio.subprocess.STDOUT (內置变量)

AsyncIterable (collections.abc 中的类)

(typing 中的类)

AsyncIterator (collections.abc 中的类)

(typing 中的类)

AsyncMock (unittest.mock 中的类)

asyncore

模块

AsyncResult (multiprocessing.pool 中的类)

asyncSetUp() (unittest.IsolatedAsyncioTestCase 方法)

asyncTearDown() (unittest.IsolatedAsyncioTestCase 方法)

AsyncWith (ast 中的类)

AT() (在 token 模块中)

at_eof() (asyncio.StreamReader 方法)

atan() (在 cmath 模块中)

(在 math 模块中)

atan2() (在 math 模块中)

atanh() (在 cmath 模块中)

(在 math 模块中)

ATEQUAL() (在 token 模块中)

atexit

模块

atexit (weakref.finalize 属性)

athrow() (agen 方法)

atof() (在 locale 模块中)

atoi() (在 locale 模块中)

atom

attach() (email.message.Message 方法)

attach_loop() (asyncio.AbstractChildWatcher 方法)

attach_mock() (unittest.mock.Mock 方法)

AttlistDeclHandler() (xml.parsers.expat.xmlparser 方法)

attrgetter() (在 operator 模块中)

attrib (xml.etree.ElementTree.Element 属性)

attribute

assignment, [1]

assignment, class

assignment, class instance

class

class instance

deletion

generic special

reference

special

Attribute (ast 中的类)

attribute -- 属性

AttributeError

例外

attributes (xml.dom.Node 属性)

AttributesImpl (xml.sax.xmlreader 中的类)

AttributesNSImpl (xml.sax.xmlreader 中的类)

attroff() (curses.window 方法)

attron() (curses.window 方法)

attrset() (curses.window 方法)

Audio Interchange File Format, [1]

AUDIO_FILE_ENCODING_ADPCM_G721() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ADPCM_G722() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ADPCM_G723_3() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ADPCM_G723_5() (在 sunau 模块中)

AUDIO_FILE_ENCODING_ALAW_8() (在 sunau 模块中)

AUDIO_FILE_ENCODING_DOUBLE() (在 sunau 模块中)

AUDIO_FILE_ENCODING_FLOAT() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_16() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_24() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_32() (在 sunau 模块中)

AUDIO_FILE_ENCODING_LINEAR_8() (在 sunau 模块中)

AUDIO_FILE_ENCODING_MULAW_8() (在 sunau 模块中)

AUDIO_FILE_MAGIC() (在 sunau 模块中)

AUDIODEV

audioop

模块

audit events

audit() (在 sys 模块中)

auditing

AugAssign (ast 中的类)

augmented

assignment

auth() (ftplib.FTP_TLS 方法)

(smtplib.SMTP 方法)

authenticate() (imaplib.IMAP4 方法)

AuthenticationError

authenticators() (netrc.netrc 方法)

authkey (multiprocessing.Process 属性)

auto (enum 中的类)

autorange() (timeit.Timer 方法)

available_timezones() (在 zoneinfo 模块中)

avg() (在 audioop 模块中)

avgpp() (在 audioop 模块中)

avoids_symlink_attacks (shutil.rmtree 属性)

await

in comprehensions

关键字, [1]

Await (ast 中的类)

AWAIT() (在 token 模块中)

await_args (unittest.mock.AsyncMock 属性)

await_args_list (unittest.mock.AsyncMock 属性)

await_count (unittest.mock.AsyncMock 属性)

Awaitable (collections.abc 中的类)

(typing 中的类)

awaitable -- 可等待对象

B

b"

bytes literal

b'

bytes literal

b16decode() (在 base64 模块中)

b16encode() (在 base64 模块中)

b2a_base64() (在 binascii 模块中)

b2a_hex() (在 binascii 模块中)

b2a_hqx() (在 binascii 模块中)

b2a_qp() (在 binascii 模块中)

b2a_uu() (在 binascii 模块中)

b32decode() (在 base64 模块中)

b32encode() (在 base64 模块中)

b32hexdecode() (在 base64 模块中)

b32hexencode() (在 base64 模块中)

b64decode() (在 base64 模块中)

b64encode() (在 base64 模块中)

b85decode() (在 base64 模块中)

b85encode() (在 base64 模块中)

Babyl (mailbox 中的类)

BabylMessage (mailbox 中的类)

back() (在 turtle 模块中)

backslash character

backslashreplace

error handler's name

backslashreplace_errors() (在 codecs 模块中)

backup() (sqlite3.Connection 方法)

backward() (在 turtle 模块中)

BadGzipFile

BadStatusLine

BadZipFile

BadZipfile

Balloon (tkinter.tix 中的类)

Barrier (multiprocessing 中的类)

(threading 中的类)

Barrier() (multiprocessing.managers.SyncManager 方法)

base64

encoding

模块, [1]

base_exec_prefix() (在 sys 模块中)

base_prefix() (在 sys 模块中)

BaseCGIHandler (wsgiref.handlers 中的类)

BaseCookie (http.cookies 中的类)

BaseException

BaseHandler (urllib.request 中的类)

(wsgiref.handlers 中的类)

BaseHeader (email.headerregistry 中的类)

BaseHTTPRequestHandler (http.server 中的类)

BaseManager (multiprocessing.managers 中的类)

basename() (在 os.path 模块中)

BaseProtocol (asyncio 中的类)

BaseProxy (multiprocessing.managers 中的类)

BaseRequestHandler (socketserver 中的类)

BaseRotatingHandler (logging.handlers 中的类)

BaseSelector (selectors 中的类)

BaseServer (socketserver 中的类)

basestring (2to3 fixer)

BaseTransport (asyncio 中的类)

basicConfig() (在 logging 模块中)

BasicContext (decimal 中的类)

BasicInterpolation (configparser 中的类)

BasicTestRunner (test.support 中的类)

baudrate() (在 curses 模块中)

bbox() (tkinter.ttk.Treeview 方法)

BDADDR_ANY() (在 socket 模块中)

BDADDR_LOCAL() (在 socket 模块中)

bdb

模块, [1]

Bdb (bdb 中的类)

BdbQuit

BDFL

bdist_msi (distutils.command.bdist_msi 中的类)

beep() (在 curses 模块中)

Beep() (在 winsound 模块中)

BEFORE_ASYNC_WITH (opcode)

begin_fill() (在 turtle 模块中)

begin_poly() (在 turtle 模块中)

below() (curses.panel.Panel 方法)

BELOW_NORMAL_PRIORITY_CLASS() (在 subprocess 模块中)

Benchmarking

benchmarking, [1], [2]

betavariate() (在 random 模块中)

bgcolor() (在 turtle 模块中)

bgpic() (在 turtle 模块中)

bias() (在 audioop 模块中)

bidirectional() (在 unicodedata 模块中)

bigaddrspacetest() (在 test.support 模块中)

BigEndianStructure (ctypes 中的类)

bigmemtest() (在 test.support 模块中)

bin()

內置函数

binary

arithmetic operation

bitwise operation

data, packing

literals

Binary (msilib 中的类)

(xmlrpc.client 中的类)

binary file -- 二进制文件

binary literal

binary mode

binary semaphores

BINARY_ADD (opcode)

BINARY_AND (opcode)

BINARY_FLOOR_DIVIDE (opcode)

BINARY_LSHIFT (opcode)

BINARY_MATRIX_MULTIPLY (opcode)

BINARY_MODULO (opcode)

BINARY_MULTIPLY (opcode)

BINARY_OR (opcode)

BINARY_POWER (opcode)

BINARY_RSHIFT (opcode)

BINARY_SUBSCR (opcode)

BINARY_SUBTRACT (opcode)

BINARY_TRUE_DIVIDE (opcode)

BINARY_XOR (opcode)

binaryfunc (C type)

BinaryIO (typing 中的类)

binascii

模块

bind (widgets)

bind() (asyncore.dispatcher 方法)

(inspect.Signature 方法)

(socket.socket 方法)

bind_partial() (inspect.Signature 方法)

bind_port() (在 test.support.socket_helper 模块中)

bind_textdomain_codeset() (在 gettext 模块中)

bind_unix_socket() (在 test.support.socket_helper 模块中)

binding

global name

name, [1], [2], [3], [4], [5], [6]

bindtextdomain() (在 gettext 模块中)

(在 locale 模块中)

binhex

模块, [1]

binhex() (在 binhex 模块中)

BinOp (ast 中的类)

bisect

模块

bisect() (在 bisect 模块中)

bisect_left() (在 bisect 模块中)

bisect_right() (在 bisect 模块中)

bit_count() (int 方法)

bit_length() (int 方法)

BitAnd (ast 中的类)

bitmap() (msilib.Dialog 方法)

BitOr (ast 中的类)

bitwise

and

operation, binary

operation, unary

operations

or

xor

BitXor (ast 中的类)

bk() (在 turtle 模块中)

bkgd() (curses.window 方法)

bkgdset() (curses.window 方法)

blake2b() (在 hashlib 模块中)

blake2b, blake2s

blake2b.MAX_DIGEST_SIZE() (在 hashlib 模块中)

blake2b.MAX_KEY_SIZE() (在 hashlib 模块中)

blake2b.PERSON_SIZE() (在 hashlib 模块中)

blake2b.SALT_SIZE() (在 hashlib 模块中)

blake2s() (在 hashlib 模块中)

blake2s.MAX_DIGEST_SIZE() (在 hashlib 模块中)

blake2s.MAX_KEY_SIZE() (在 hashlib 模块中)

blake2s.PERSON_SIZE() (在 hashlib 模块中)

blake2s.SALT_SIZE() (在 hashlib 模块中)

blank line

block

code

block_size (hmac.HMAC 属性)

blocked_domains() (http.cookiejar.DefaultCookiePolicy 方法)

BlockingIOError, [1]

blocksize (http.client.HTTPConnection 属性)

BNF, [1]

body() (nntplib.NNTP 方法)

(tkinter.simpledialog.Dialog 方法)

body_encode() (email.charset.Charset 方法)

body_encoding (email.charset.Charset 属性)

body_line_iterator() (在 email.iterators 模块中)

BOLD() (在 tkinter.font 模块中)

BOM() (在 codecs 模块中)

BOM_BE() (在 codecs 模块中)

BOM_LE() (在 codecs 模块中)

BOM_UTF16() (在 codecs 模块中)

BOM_UTF16_BE() (在 codecs 模块中)

BOM_UTF16_LE() (在 codecs 模块中)

BOM_UTF32() (在 codecs 模块中)

BOM_UTF32_BE() (在 codecs 模块中)

BOM_UTF32_LE() (在 codecs 模块中)

BOM_UTF8() (在 codecs 模块中)

bool (內置类)

Boolean

operation

operations, [1]

type

values

对象, [1]

BOOLEAN_STATES (configparser.ConfigParser 属性)

BoolOp (ast 中的类)

bootstrap() (在 ensurepip 模块中)

border() (curses.window 方法)

borrowed reference -- 借入引用

bottom() (curses.panel.Panel 方法)

bottom_panel() (在 curses.panel 模块中)

BoundArguments (inspect 中的类)

BoundaryError

BoundedSemaphore (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

BoundedSemaphore() (multiprocessing.managers.SyncManager 方法)

box() (curses.window 方法)

bpbynumber (bdb.Breakpoint 属性)

bpformat() (bdb.Breakpoint 方法)

bplist (bdb.Breakpoint 属性)

bpprint() (bdb.Breakpoint 方法)

break

语句, [1], [2], [3], [4]

Break (ast 中的类)

break (pdb command)

break_anywhere() (bdb.Bdb 方法)

break_here() (bdb.Bdb 方法)

break_long_words (textwrap.TextWrapper 属性)

break_on_hyphens (textwrap.TextWrapper 属性)

Breakpoint (bdb 中的类)

breakpoint()

內置函数

breakpointhook() (在 sys 模块中)

breakpoints

broadcast_address (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

broken (threading.Barrier 属性)

BrokenBarrierError

BrokenExecutor

BrokenPipeError

BrokenProcessPool

BrokenThreadPool

BROWSER, [1]

BsdDbShelf (shelve 中的类)

buf (multiprocessing.shared_memory.SharedMemory 属性)

buffer (2to3 fixer)

(io.TextIOBase 属性)

(unittest.TestResult 属性)

buffer interface

(see buffer protocol)

buffer object

(see buffer protocol)

buffer protocol

binary sequence types

str (built-in class)

buffer size, I/O

buffer_info() (array.array 方法)

buffer_size (xml.parsers.expat.xmlparser 属性)

buffer_text (xml.parsers.expat.xmlparser 属性)

buffer_updated() (asyncio.BufferedProtocol 方法)

buffer_used (xml.parsers.expat.xmlparser 属性)

BufferedIOBase (io 中的类)

BufferedProtocol (asyncio 中的类)

BufferedRandom (io 中的类)

BufferedReader (io 中的类)

BufferedRWPair (io 中的类)

BufferedWriter (io 中的类)

BufferError

BufferingFormatter (logging 中的类)

BufferingHandler (logging.handlers 中的类)

BufferTooShort

bufsize() (ossaudiodev.oss_audio_device 方法)

BUILD_CONST_KEY_MAP (opcode)

BUILD_LIST (opcode)

BUILD_MAP (opcode)

build_opener() (在 urllib.request 模块中)

build_py (distutils.command.build_py 中的类)

build_py_2to3 (distutils.command.build_py 中的类)

BUILD_SET (opcode)

BUILD_SLICE (opcode)

BUILD_STRING (opcode)

BUILD_TUPLE (opcode)

built-in

method

types

built-in function

call

对象, [1]

built-in method

call

对象, [1]

builtin_module_names() (在 sys 模块中)

BuiltinFunctionType() (在 types 模块中)

BuiltinImporter (importlib.machinery 中的类)

BuiltinMethodType() (在 types 模块中)

builtins

模块, [1], [2], [3], [4], [5]

ButtonBox (tkinter.tix 中的类)

buttonbox() (tkinter.simpledialog.Dialog 方法)

bye() (在 turtle 模块中)

byref() (在 ctypes 模块中)

byte

byte-code

file, [1]

byte_compile() (在 distutils.util 模块中)

bytearray

formatting

interpolation

methods

对象, [1], [2], [3]

bytearray (內置类)

bytecode

Bytecode (dis 中的类)

bytecode -- 字节码

Bytecode.codeobj() (在 dis 模块中)

Bytecode.first_line() (在 dis 模块中)

BYTECODE_SUFFIXES() (在 importlib.machinery 模块中)

BytecodeTestCase (test.support.bytecode_helper 中的类)

byteorder() (在 sys 模块中)

bytes

formatting

interpolation

methods

str (built-in class)

內置函数, [1]

对象, [1], [2]

bytes (uuid.UUID 属性)

(內置类)

bytes literal

bytes-like object -- 字节型对象

bytes_le (uuid.UUID 属性)

BytesFeedParser (email.parser 中的类)

BytesGenerator (email.generator 中的类)

BytesHeaderParser (email.parser 中的类)

BytesIO (io 中的类)

BytesParser (email.parser 中的类)

ByteString (collections.abc 中的类)

(typing 中的类)

byteswap() (array.array 方法)

(在 audioop 模块中)

BytesWarning

bz2

模块

BZ2Compressor (bz2 中的类)

BZ2Decompressor (bz2 中的类)

BZ2File (bz2 中的类)

C

C

language, [1], [2], [3], [4]

structures

C-contiguous, [1]

C14NWriterTarget (xml.etree.ElementTree 中的类)

c_bool (ctypes 中的类)

C_BUILTIN() (在 imp 模块中)

c_byte (ctypes 中的类)

c_char (ctypes 中的类)

c_char_p (ctypes 中的类)

c_contiguous (memoryview 属性)

c_double (ctypes 中的类)

C_EXTENSION() (在 imp 模块中)

c_float (ctypes 中的类)

c_int (ctypes 中的类)

c_int16 (ctypes 中的类)

c_int32 (ctypes 中的类)

c_int64 (ctypes 中的类)

c_int8 (ctypes 中的类)

c_long (ctypes 中的类)

c_longdouble (ctypes 中的类)

c_longlong (ctypes 中的类)

c_short (ctypes 中的类)

c_size_t (ctypes 中的类)

c_ssize_t (ctypes 中的类)

c_ubyte (ctypes 中的类)

c_uint (ctypes 中的类)

c_uint16 (ctypes 中的类)

c_uint32 (ctypes 中的类)

c_uint64 (ctypes 中的类)

c_uint8 (ctypes 中的类)

c_ulong (ctypes 中的类)

c_ulonglong (ctypes 中的类)

c_ushort (ctypes 中的类)

c_void_p (ctypes 中的类)

c_wchar (ctypes 中的类)

c_wchar_p (ctypes 中的类)

CAB (msilib 中的类)

cache() (在 functools 模块中)

cache_from_source() (在 imp 模块中)

(在 importlib.util 模块中)

cached (importlib.machinery.ModuleSpec 属性)

cached_property() (在 functools 模块中)

CacheFTPHandler (urllib.request 中的类)

calcobjsize() (在 test.support 模块中)

calcsize() (在 struct 模块中)

calcvobjsize() (在 test.support 模块中)

calendar

模块

Calendar (calendar 中的类)

calendar() (在 calendar 模块中)

call

built-in function

built-in method

class instance

class object, [1], [2]

function, [1], [2]

instance, [1]

method

procedure

user-defined function

Call (ast 中的类)

call() (在 subprocess 模块中)

(在 unittest.mock 模块中)

call_args (unittest.mock.Mock 属性)

call_args_list (unittest.mock.Mock 属性)

call_at() (asyncio.loop 方法)

call_count (unittest.mock.Mock 属性)

call_exception_handler() (asyncio.loop 方法)

CALL_FUNCTION (opcode)

CALL_FUNCTION_EX (opcode)

CALL_FUNCTION_KW (opcode)

call_later() (asyncio.loop 方法)

call_list() (unittest.mock.call 方法)

CALL_METHOD (opcode)

call_soon() (asyncio.loop 方法)

call_soon_threadsafe() (asyncio.loop 方法)

call_tracing() (在 sys 模块中)

callable

对象, [1]

Callable (collections.abc 中的类)

callable -- 可调用对象

callable()

內置函数

Callable() (在 typing 模块中)

CallableProxyType() (在 weakref 模块中)

callback (optparse.Option 属性)

callback -- 回调

callback() (contextlib.ExitStack 方法)

callback_args (optparse.Option 属性)

callback_kwargs (optparse.Option 属性)

callbacks() (在 gc 模块中)

called (unittest.mock.Mock 属性)

CalledProcessError

calloc()

CAN_BCM() (在 socket 模块中)

can_change_color() (在 curses 模块中)

can_fetch() (urllib.robotparser.RobotFileParser 方法)

CAN_ISOTP() (在 socket 模块中)

CAN_J1939() (在 socket 模块中)

CAN_RAW_FD_FRAMES() (在 socket 模块中)

CAN_RAW_JOIN_FILTERS() (在 socket 模块中)

can_symlink() (在 test.support.os_helper 模块中)

can_write_eof() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

can_xattr() (在 test.support.os_helper 模块中)

cancel() (asyncio.Future 方法)

(asyncio.Handle 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

(sched.scheduler 方法)

(threading.Timer 方法)

(tkinter.dnd.DndHandler 方法)

cancel_command() (tkinter.filedialog.FileDialog 方法)

cancel_dump_traceback_later() (在 faulthandler 模块中)

cancel_join_thread() (multiprocessing.Queue 方法)

cancelled() (asyncio.Future 方法)

(asyncio.Handle 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

CancelledError, [1]

CannotSendHeader

CannotSendRequest

canonic() (bdb.Bdb 方法)

canonical() (decimal.Context 方法)

(decimal.Decimal 方法)

canonicalize() (在 xml.etree.ElementTree 模块中)

capa() (poplib.POP3 方法)

capitalize() (bytearray 方法)

(bytes 方法)

(str 方法)

Capsule

对象

captured_stderr() (在 test.support 模块中)

captured_stdin() (在 test.support 模块中)

captured_stdout() (在 test.support 模块中)

captureWarnings() (在 logging 模块中)

capwords() (在 string 模块中)

case

match

关键字

case block

casefold() (str 方法)

cast() (memoryview 方法)

(在 ctypes 模块中)

(在 typing 模块中)

cat() (在 nis 模块中)

catch_threading_exception() (在 test.support.threading_helper 模块中)

catch_unraisable_exception() (在 test.support 模块中)

catch_warnings (warnings 中的类)

category() (在 unicodedata 模块中)

cbreak() (在 curses 模块中)

CC

ccc() (ftplib.FTP_TLS 方法)

CCompiler (distutils.ccompiler 中的类)

cdf() (statistics.NormalDist 方法)

CDLL (ctypes 中的类)

ceil() (in module math)

(在 math 模块中)

CellType() (在 types 模块中)

center() (bytearray 方法)

(bytes 方法)

(str 方法)

CERT_NONE() (在 ssl 模块中)

CERT_OPTIONAL() (在 ssl 模块中)

CERT_REQUIRED() (在 ssl 模块中)

cert_store_stats() (ssl.SSLContext 方法)

cert_time_to_seconds() (在 ssl 模块中)

CertificateError

certificates

CFLAGS, [1], [2], [3], [4], [5], [6], [7]

CFLAGS_NODIST, [1], [2]

CFUNCTYPE() (在 ctypes 模块中)

cget() (tkinter.font.Font 方法)

CGI

debugging

exceptions

protocol

security

tracebacks

cgi

模块

cgi_directories (http.server.CGIHTTPRequestHandler 属性)

CGIHandler (wsgiref.handlers 中的类)

CGIHTTPRequestHandler (http.server 中的类)

cgitb

模块

CGIXMLRPCRequestHandler (xmlrpc.server 中的类)

chain() (在 itertools 模块中)

chaining

comparisons, [1]

exception

ChainMap (collections 中的类)

(typing 中的类)

change_cwd() (在 test.support.os_helper 模块中)

change_root() (在 distutils.util 模块中)

CHANNEL_BINDING_TYPES() (在 ssl 模块中)

channel_class (smtpd.SMTPServer 属性)

channels() (ossaudiodev.oss_audio_device 方法)

CHAR_MAX() (在 locale 模块中)

character, [1], [2]

CharacterDataHandler() (xml.parsers.expat.xmlparser 方法)

characters() (xml.sax.handler.ContentHandler 方法)

characters_written (BlockingIOError 属性)

Charset (email.charset 中的类)

charset() (gettext.NullTranslations 方法)

chdir() (在 os 模块中)

check (lzma.LZMADecompressor 属性)

check() (imaplib.IMAP4 方法)

(在 tabnanny 模块中)

check__all__() (在 test.support 模块中)

check_call() (在 subprocess 模块中)

check_disallow_instantiation() (在 test.support 模块中)

check_environ() (在 distutils.util 模块中)

check_free_after_iterating() (在 test.support 模块中)

check_hostname (ssl.SSLContext 属性)

check_impl_detail() (在 test.support 模块中)

check_no_resource_warning() (在 test.support.warnings_helper 模块中)

check_output() (doctest.OutputChecker 方法)

(在 subprocess 模块中)

check_returncode() (subprocess.CompletedProcess 方法)

check_syntax_error() (在 test.support 模块中)

check_syntax_warning() (在 test.support.warnings_helper 模块中)

check_unused_args() (string.Formatter 方法)

check_warnings() (在 test.support.warnings_helper 模块中)

checkbox() (msilib.Dialog 方法)

checkcache() (在 linecache 模块中)

CHECKED_HASH (py_compile.PycInvalidationMode 属性)

checkfuncname() (在 bdb 模块中)

CheckList (tkinter.tix 中的类)

checksizeof() (在 test.support 模块中)

checksum

Cyclic Redundancy Check

chflags() (在 os 模块中)

chgat() (curses.window 方法)

childNodes (xml.dom.Node 属性)

ChildProcessError

children (pyclbr.Class 属性)

(pyclbr.Function 属性)

(tkinter.Tk 属性)

chmod() (pathlib.Path 方法)

(在 os 模块中)

choice() (在 random 模块中)

(在 secrets 模块中)

choices (optparse.Option 属性)

choices() (在 random 模块中)

Chooser (tkinter.colorchooser 中的类)

chown() (在 os 模块中)

(在 shutil 模块中)

chr

內置函数

chr()

內置函数

chroot() (在 os 模块中)

chunk

模块

Chunk (chunk 中的类)

cipher

DES

cipher() (ssl.SSLSocket 方法)

circle() (在 turtle 模块中)

CIRCUMFLEX() (在 token 模块中)

CIRCUMFLEXEQUAL() (在 token 模块中)

Clamped (decimal 中的类)

class

attribute

attribute assignment

body

constructor

definition, [1]

instance

name

对象, [1], [2]

语句

Class (symtable 中的类)

class instance

attribute

attribute assignment

call

对象, [1], [2]

class object

call, [1], [2]

class variable -- 类变量

ClassDef (ast 中的类)

classmethod

內置函数

classmethod()

內置函数

ClassMethodDescriptorType() (在 types 模块中)

ClassVar() (在 typing 模块中)

clause

CLD_CONTINUED() (在 os 模块中)

CLD_DUMPED() (在 os 模块中)

CLD_EXITED() (在 os 模块中)

CLD_KILLED() (在 os 模块中)

CLD_STOPPED() (在 os 模块中)

CLD_TRAPPED() (在 os 模块中)

clean() (mailbox.Maildir 方法)

cleandoc() (在 inspect 模块中)

CleanImport (test.support.import_helper 中的类)

cleanup functions

clear (pdb command)

Clear Breakpoint

clear() (asyncio.Event 方法)

(collections.deque 方法)

(curses.window 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(frame 方法)

(frozenset 方法)

(http.cookiejar.CookieJar 方法)

(mailbox.Mailbox 方法)

(sequence method)

(threading.Event 方法)

(xml.etree.ElementTree.Element 方法)

(在 turtle 模块中)

clear_all_breaks() (bdb.Bdb 方法)

clear_all_file_breaks() (bdb.Bdb 方法)

clear_bpbynumber() (bdb.Bdb 方法)

clear_break() (bdb.Bdb 方法)

clear_cache() (zoneinfo.ZoneInfo 类方法)

(在 filecmp 模块中)

clear_content() (email.message.EmailMessage 方法)

clear_flags() (decimal.Context 方法)

clear_frames() (在 traceback 模块中)

clear_history() (在 readline 模块中)

clear_session_cookies() (http.cookiejar.CookieJar 方法)

clear_traces() (在 tracemalloc 模块中)

clear_traps() (decimal.Context 方法)

clearcache() (在 linecache 模块中)

ClearData() (msilib.Record 方法)

clearok() (curses.window 方法)

clearscreen() (在 turtle 模块中)

clearstamp() (在 turtle 模块中)

clearstamps() (在 turtle 模块中)

Client() (在 multiprocessing.connection 模块中)

client_address (http.server.BaseHTTPRequestHandler 属性)

CLOCK_BOOTTIME() (在 time 模块中)

clock_getres() (在 time 模块中)

clock_gettime() (在 time 模块中)

clock_gettime_ns() (在 time 模块中)

CLOCK_HIGHRES() (在 time 模块中)

CLOCK_MONOTONIC() (在 time 模块中)

CLOCK_MONOTONIC_RAW() (在 time 模块中)

CLOCK_PROCESS_CPUTIME_ID() (在 time 模块中)

CLOCK_PROF() (在 time 模块中)

CLOCK_REALTIME() (在 time 模块中)

clock_settime() (在 time 模块中)

clock_settime_ns() (在 time 模块中)

CLOCK_TAI() (在 time 模块中)

CLOCK_THREAD_CPUTIME_ID() (在 time 模块中)

CLOCK_UPTIME() (在 time 模块中)

CLOCK_UPTIME_RAW() (在 time 模块中)

clone() (email.generator.BytesGenerator 方法)

(email.generator.Generator 方法)

(email.policy.Policy 方法)

(pipes.Template 方法)

(在 turtle 模块中)

cloneNode() (xml.dom.Node 方法)

close() (aifc.aifc 方法)

(asyncio.AbstractChildWatcher 方法)

(asyncio.BaseTransport 方法)

(asyncio.loop 方法)

(asyncio.Server 方法)

(asyncio.StreamWriter 方法)

(asyncio.SubprocessTransport 方法)

(asyncore.dispatcher 方法)

(chunk.Chunk 方法)

(contextlib.ExitStack 方法)

(coroutine 方法)

(dbm.dumb.dumbdbm 方法)

(dbm.gnu.gdbm 方法)

(dbm.ndbm.ndbm 方法)

(distutils.text_file.TextFile 方法)

(email.parser.BytesFeedParser 方法)

(ftplib.FTP 方法)

(generator 方法)

(html.parser.HTMLParser 方法)

(http.client.HTTPConnection 方法)

(imaplib.IMAP4 方法)

(in module os)

(io.IOBase 方法)

(logging.FileHandler 方法)

(logging.Handler 方法)

(logging.handlers.MemoryHandler 方法)

(logging.handlers.NTEventLogHandler 方法)

(logging.handlers.SocketHandler 方法)

(logging.handlers.SysLogHandler 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.MH 方法)

(mmap.mmap 方法)

Close() (msilib.Database 方法)

(msilib.View 方法)

close() (multiprocessing.connection.Connection 方法)

(multiprocessing.connection.Listener 方法)

(multiprocessing.pool.Pool 方法)

(multiprocessing.Process 方法)

(multiprocessing.Queue 方法)

(multiprocessing.shared_memory.SharedMemory 方法)

(multiprocessing.SimpleQueue 方法)

(os.scandir 方法)

(ossaudiodev.oss_audio_device 方法)

(ossaudiodev.oss_mixer_device 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.kqueue 方法)

(selectors.BaseSelector 方法)

(shelve.Shelf 方法)

(socket.socket 方法)

(sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

(sunau.AU_read 方法)

(sunau.AU_write 方法)

(tarfile.TarFile 方法)

(telnetlib.Telnet 方法)

(urllib.request.BaseHandler 方法)

(wave.Wave_read 方法)

(wave.Wave_write 方法)

Close() (winreg.PyHKEY 方法)

close() (xml.etree.ElementTree.TreeBuilder 方法)

(xml.etree.ElementTree.XMLParser 方法)

(xml.etree.ElementTree.XMLPullParser 方法)

(xml.sax.xmlreader.IncrementalParser 方法)

(zipfile.ZipFile 方法)

(在 fileinput 模块中)

(在 os 模块中)

(在 socket 模块中)

close_connection (http.server.BaseHTTPRequestHandler 属性)

close_when_done() (asynchat.async_chat 方法)

closed (http.client.HTTPResponse 属性)

(io.IOBase 属性)

(mmap.mmap 属性)

(ossaudiodev.oss_audio_device 属性)

(select.devpoll 属性)

(select.epoll 属性)

(select.kqueue 属性)

CloseKey() (在 winreg 模块中)

closelog() (在 syslog 模块中)

closerange() (在 os 模块中)

closing() (在 contextlib 模块中)

clrtobot() (curses.window 方法)

clrtoeol() (curses.window 方法)

cmath

模块

cmd

模块, [1]

Cmd (cmd 中的类)

cmd (subprocess.CalledProcessError 属性)

(subprocess.TimeoutExpired 属性)

cmdloop() (cmd.Cmd 方法)

cmdqueue (cmd.Cmd 属性)

cmp() (在 filecmp 模块中)

cmp_op() (在 dis 模块中)

cmp_to_key() (在 functools 模块中)

cmpfiles() (在 filecmp 模块中)

CMSG_LEN() (在 socket 模块中)

CMSG_SPACE() (在 socket 模块中)

co_argcount (code object attribute)

CO_ASYNC_GENERATOR() (在 inspect 模块中)

co_cellvars (code object attribute)

co_code (code object attribute)

co_consts (code object attribute)

CO_COROUTINE() (在 inspect 模块中)

co_filename (code object attribute)

co_firstlineno (code object attribute)

co_flags (code object attribute)

co_freevars (code object attribute)

CO_FUTURE_DIVISION (C var)

CO_GENERATOR() (在 inspect 模块中)

CO_ITERABLE_COROUTINE() (在 inspect 模块中)

co_kwonlyargcount (code object attribute)

co_lnotab (code object attribute)

co_name (code object attribute)

co_names (code object attribute)

CO_NESTED() (在 inspect 模块中)

CO_NEWLOCALS() (在 inspect 模块中)

co_nlocals (code object attribute)

CO_NOFREE() (在 inspect 模块中)

CO_OPTIMIZED() (在 inspect 模块中)

co_posonlyargcount (code object attribute)

co_stacksize (code object attribute)

CO_VARARGS() (在 inspect 模块中)

CO_VARKEYWORDS() (在 inspect 模块中)

co_varnames (code object attribute)

code

block

模块

code (SystemExit 属性)

(urllib.error.HTTPError 属性)

(urllib.response.addinfourl 属性)

(xml.etree.ElementTree.ParseError 属性)

(xml.parsers.expat.ExpatError 属性)

code object, [1], [2], [3]

code_info() (在 dis 模块中)

CodecInfo (codecs 中的类)

Codecs

decode

encode

codecs

模块

coded_value (http.cookies.Morsel 属性)

codeop

模块

codepoint2name() (在 html.entities 模块中)

codes() (在 xml.parsers.expat.errors 模块中)

CODESET() (在 locale 模块中)

CodeType (types 中的类)

coding

style

coercion -- 强制类型转换

col_offset (ast.AST 属性)

collapse_addresses() (在 ipaddress 模块中)

collapse_rfc2231_value() (在 email.utils 模块中)

collect() (在 gc 模块中)

collect_incoming_data() (asynchat.async_chat 方法)

Collection (collections.abc 中的类)

(typing 中的类)

collections

模块

collections.abc

模块

colno (json.JSONDecodeError 属性)

(re.error 属性)

COLON() (在 token 模块中)

COLONEQUAL() (在 token 模块中)

color() (在 turtle 模块中)

color_content() (在 curses 模块中)

color_pair() (在 curses 模块中)

colormode() (在 turtle 模块中)

colorsys

模块

COLS, [1]

column() (tkinter.ttk.Treeview 方法)

COLUMNS, [1]

columns (os.terminal_size 属性)

comb() (在 math 模块中)

combinations() (在 itertools 模块中)

combinations_with_replacement() (在 itertools 模块中)

combine() (datetime.datetime 类方法)

combining() (在 unicodedata 模块中)

ComboBox (tkinter.tix 中的类)

Combobox (tkinter.ttk 中的类)

comma

trailing

COMMA() (在 token 模块中)

Command (distutils.cmd 中的类)

(distutils.core 中的类)

command (http.server.BaseHTTPRequestHandler 属性)

command line

command line option

--check-hash-based-pycs default|always|never

--disable-ipv6

--disable-test-modules

--enable-big-digits=[15|30]

--enable-framework

--enable-framework=INSTALLDIR

--enable-loadable-sqlite-extensions

--enable-optimizations

--enable-profiling

--enable-shared

--enable-universalsdk

--enable-universalsdk=SDKDIR

--exec-prefix=EPREFIX

--help

--prefix=PREFIX

--version

--with-address-sanitizer

--with-assertions

--with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2

--with-computed-gotos

--with-cxx-main

--with-cxx-main=COMPILER

--with-dbmliborder=db1:db2:...

--with-dtrace

--with-ensurepip=[upgrade|install|no]

--with-framework-name=FRAMEWORK

--with-hash-algorithm=[fnv|siphash24]

--with-libc=STRING

--with-libm=STRING

--with-libs='lib1 ...'

--with-lto

--with-memory-sanitizer

--with-openssl-rpath=[no|auto|DIR]

--with-openssl=DIR

--with-platlibdir=DIRNAME

--with-pydebug

--with-readline=editline

--with-ssl-default-suites=[python|openssl|STRING]

--with-suffix=SUFFIX

--with-system-expat

--with-system-ffi

--with-system-libmpdec

--with-tcltk-includes='-I...'

--with-tcltk-libs='-L...'

--with-trace-refs

--with-tzpath=<list of absolute paths separated by pathsep>

--with-undefined-behavior-sanitizer

--with-universal-archs=ARCH

--with-valgrind

--with-wheel-pkg-dir=PATH

--without-c-locale-coercion

--without-decimal-contextvar

--without-doc-strings

--without-pymalloc

--without-readline

--without-static-libpython

-?

-b

-B

-c <command>

-d

-E

-h

-i

-I

-J

-m <module-name>

-O

-OO

-q

-R

-s

-S

-u

-V

-v

-W arg

-x

-X

CommandCompiler (codeop 中的类)

commands (pdb command)

comment

(http.cookiejar.Cookie 属性)

(zipfile.ZipFile 属性)

(zipfile.ZipInfo 属性)

comment() (xml.etree.ElementTree.TreeBuilder 方法)

(xml.sax.handler.LexicalHandler 方法)

COMMENT() (在 token 模块中)

Comment() (在 xml.etree.ElementTree 模块中)

comment_url (http.cookiejar.Cookie 属性)

commenters (shlex.shlex 属性)

CommentHandler() (xml.parsers.expat.xmlparser 方法)

commit() (msilib.CAB 方法)

Commit() (msilib.Database 方法)

commit() (sqlite3.Connection 方法)

common (filecmp.dircmp 属性)

Common Gateway Interface

common_dirs (filecmp.dircmp 属性)

common_files (filecmp.dircmp 属性)

common_funny (filecmp.dircmp 属性)

common_types() (在 mimetypes 模块中)

commonpath() (在 os.path 模块中)

commonprefix() (在 os.path 模块中)

communicate() (asyncio.subprocess.Process 方法)

(subprocess.Popen 方法)

Compare (ast 中的类)

compare() (decimal.Context 方法)

(decimal.Decimal 方法)

(difflib.Differ 方法)

compare_digest() (在 hmac 模块中)

(在 secrets 模块中)

compare_networks() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

COMPARE_OP (opcode)

compare_signal() (decimal.Context 方法)

(decimal.Decimal 方法)

compare_to() (tracemalloc.Snapshot 方法)

compare_total() (decimal.Context 方法)

(decimal.Decimal 方法)

compare_total_mag() (decimal.Context 方法)

(decimal.Decimal 方法)

comparing

objects

comparison

operator

COMPARISON_FLAGS() (在 doctest 模块中)

comparisons

chaining, [1]

Compat32 (email.policy 中的类)

compat32() (在 email.policy 模块中)

compile

內置函数, [1], [2], [3]

Compile (codeop 中的类)

compile()

內置函数

compile() (distutils.ccompiler.CCompiler 方法)

(在 py_compile 模块中)

(在 re 模块中)

compile_command() (在 code 模块中)

(在 codeop 模块中)

compile_dir() (在 compileall 模块中)

compile_file() (在 compileall 模块中)

compile_path() (在 compileall 模块中)

compileall

模块

compileall command line option

--hardlink-dupes

--invalidation-mode [timestamp|checked-hash|unchecked-hash]

-b

-d destdir

-e dir

-f

-i list

-j N

-l

-o level

-p prepend_prefix

-q

-r

-s strip_prefix

-x regex

directory ...

file ...

complete() (rlcompleter.Completer 方法)

complete_statement() (在 sqlite3 模块中)

completedefault() (cmd.Cmd 方法)

CompletedProcess (subprocess 中的类)

complex

number

內置函数, [1]

对象

Complex (numbers 中的类)

complex (內置类)

complex literal

complex number

literals

对象, [1]

complex number -- 复数

compound

statement

comprehension (ast 中的类)

comprehensions

dictionary

list

set

compress() (bz2.BZ2Compressor 方法)

(lzma.LZMACompressor 方法)

(zlib.Compress 方法)

(在 bz2 模块中)

(在 gzip 模块中)

(在 itertools 模块中)

(在 lzma 模块中)

(在 zlib 模块中)

compress_size (zipfile.ZipInfo 属性)

compress_type (zipfile.ZipInfo 属性)

compressed (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

compression() (ssl.SSLSocket 方法)

CompressionError

compressobj() (在 zlib 模块中)

COMSPEC, [1]

concat() (在 operator 模块中)

Concatenate() (在 typing 模块中)

concatenation

operation

concurrent.futures

模块

cond (bdb.Breakpoint 属性)

Condition (asyncio 中的类)

(multiprocessing 中的类)

condition (pdb command)

Condition (threading 中的类)

condition() (msilib.Control 方法)

Condition() (multiprocessing.managers.SyncManager 方法)

Conditional

expression

conditional

expression

config() (tkinter.font.Font 方法)

configparser

模块

ConfigParser (configparser 中的类)

configuration

file

file, debugger

file, path

configuration information

configure() (tkinter.ttk.Style 方法)

configure_mock() (unittest.mock.Mock 方法)

confstr() (在 os 模块中)

confstr_names() (在 os 模块中)

conjugate() (complex number method)

(decimal.Decimal 方法)

(numbers.Complex 方法)

conn (smtpd.SMTPChannel 属性)

connect() (asyncore.dispatcher 方法)

(ftplib.FTP 方法)

(http.client.HTTPConnection 方法)

(multiprocessing.managers.BaseManager 方法)

(smtplib.SMTP 方法)

(socket.socket 方法)

(在 sqlite3 模块中)

connect_accepted_socket() (asyncio.loop 方法)

connect_ex() (socket.socket 方法)

connect_read_pipe() (asyncio.loop 方法)

connect_write_pipe() (asyncio.loop 方法)

Connection (multiprocessing.connection 中的类)

(sqlite3 中的类)

connection (sqlite3.Cursor 属性)

connection_lost() (asyncio.BaseProtocol 方法)

connection_made() (asyncio.BaseProtocol 方法)

ConnectionAbortedError

ConnectionError

ConnectionRefusedError

ConnectionResetError

ConnectRegistry() (在 winreg 模块中)

const (optparse.Option 属性)

constant

Constant (ast 中的类)

constructor

class

constructor() (在 copyreg 模块中)

consumed (asyncio.LimitOverrunError 属性)

container, [1]

iteration over

Container (collections.abc 中的类)

(typing 中的类)

contains() (在 operator 模块中)

CONTAINS_OP (opcode)

content type

MIME

content_disposition (email.headerregistry.ContentDispositionHeader 属性)

content_manager (email.policy.EmailPolicy 属性)

content_type (email.headerregistry.ContentTypeHeader 属性)

ContentDispositionHeader (email.headerregistry 中的类)

ContentHandler (xml.sax.handler 中的类)

ContentManager (email.contentmanager 中的类)

contents (ctypes._Pointer 属性)

contents() (importlib.abc.ResourceReader 方法)

(在 importlib.resources 模块中)

ContentTooShortError

ContentTransferEncoding (email.headerregistry 中的类)

ContentTypeHeader (email.headerregistry 中的类)

Context (contextvars 中的类)

(decimal 中的类)

context (ssl.SSLSocket 属性)

context management protocol

context manager, [1]

context manager -- 上下文管理器

context variable -- 上下文变量

context_diff() (在 difflib 模块中)

ContextDecorator (contextlib 中的类)

contextlib

模块

ContextManager (typing 中的类)

contextmanager() (在 contextlib 模块中)

ContextVar (contextvars 中的类)

contextvars

模块

contiguous

(memoryview 属性)

contiguous -- 连续

continue

语句, [1], [2], [3], [4]

Continue (ast 中的类)

continue (pdb command)

Control (msilib 中的类)

(tkinter.tix 中的类)

control() (msilib.Dialog 方法)

(select.kqueue 方法)

controlnames() (在 curses.ascii 模块中)

controls() (ossaudiodev.oss_mixer_device 方法)

conversion

arithmetic

string, [1]

ConversionError

conversions

numeric

convert_arg_line_to_args() (argparse.ArgumentParser 方法)

convert_field() (string.Formatter 方法)

convert_path() (在 distutils.util 模块中)

Cookie (http.cookiejar 中的类)

CookieError

CookieJar (http.cookiejar 中的类)

cookiejar (urllib.request.HTTPCookieProcessor 属性)

CookiePolicy (http.cookiejar 中的类)

Coordinated Universal Time

Copy

copy

protocol

模块, [1]

copy() (collections.deque 方法)

(contextvars.Context 方法)

(decimal.Context 方法)

(dict 方法)

(frozenset 方法)

(hashlib.hash 方法)

(hmac.HMAC 方法)

(http.cookies.Morsel 方法)

(imaplib.IMAP4 方法)

(pipes.Template 方法)

(sequence method)

(tkinter.font.Font 方法)

(types.MappingProxyType 方法)

(zlib.Compress 方法)

(zlib.Decompress 方法)

(在 copy 模块中)

(在 multiprocessing.sharedctypes 模块中)

(在 shutil 模块中)

copy2() (在 shutil 模块中)

copy_abs() (decimal.Context 方法)

(decimal.Decimal 方法)

copy_context() (在 contextvars 模块中)

copy_decimal() (decimal.Context 方法)

COPY_DICT_WITHOUT_KEYS (opcode)

copy_file() (在 distutils.file_util 模块中)

copy_file_range() (在 os 模块中)

copy_location() (在 ast 模块中)

copy_negate() (decimal.Context 方法)

(decimal.Decimal 方法)

copy_sign() (decimal.Context 方法)

(decimal.Decimal 方法)

copy_tree() (在 distutils.dir_util 模块中)

copyfile() (在 shutil 模块中)

copyfileobj() (在 shutil 模块中)

copying files

copymode() (在 shutil 模块中)

copyreg

模块

copyright (in module sys)

(內置变量)

copyright() (在 sys 模块中)

copysign() (在 math 模块中)

copystat() (在 shutil 模块中)

copytree() (在 shutil 模块中)

coroutine, [1]

function

Coroutine (collections.abc 中的类)

(typing 中的类)

coroutine -- 协程

coroutine function -- 协程函数

coroutine() (在 asyncio 模块中)

(在 types 模块中)

CoroutineType() (在 types 模块中)

correlation() (在 statistics 模块中)

cos() (在 cmath 模块中)

(在 math 模块中)

cosh() (在 cmath 模块中)

(在 math 模块中)

count (tracemalloc.Statistic 属性)

(tracemalloc.StatisticDiff 属性)

count() (array.array 方法)

(bytearray 方法)

(bytes 方法)

(collections.deque 方法)

(multiprocessing.shared_memory.ShareableList 方法)

(sequence method)

(str 方法)

(在 itertools 模块中)

count_diff (tracemalloc.StatisticDiff 属性)

Counter (collections 中的类)

(typing 中的类)

countOf() (在 operator 模块中)

countTestCases() (unittest.TestCase 方法)

(unittest.TestSuite 方法)

covariance() (在 statistics 模块中)

CoverageResults (trace 中的类)

CPP

CPPFLAGS, [1], [2], [3]

cProfile

模块

CPU time, [1]

cpu_count() (在 multiprocessing 模块中)

(在 os 模块中)

CPython

cpython_only() (在 test.support 模块中)

crawl_delay() (urllib.robotparser.RobotFileParser 方法)

CRC (zipfile.ZipInfo 属性)

crc32() (在 binascii 模块中)

(在 zlib 模块中)

crc_hqx() (在 binascii 模块中)

create() (imaplib.IMAP4 方法)

(venv.EnvBuilder 方法)

(在 venv 模块中)

create_aggregate() (sqlite3.Connection 方法)

create_archive() (在 zipapp 模块中)

create_autospec() (在 unittest.mock 模块中)

CREATE_BREAKAWAY_FROM_JOB() (在 subprocess 模块中)

create_collation() (sqlite3.Connection 方法)

create_configuration() (venv.EnvBuilder 方法)

create_connection() (asyncio.loop 方法)

(在 socket 模块中)

create_datagram_endpoint() (asyncio.loop 方法)

create_decimal() (decimal.Context 方法)

create_decimal_from_float() (decimal.Context 方法)

create_default_context() (在 ssl 模块中)

CREATE_DEFAULT_ERROR_MODE() (在 subprocess 模块中)

create_empty_file() (在 test.support.os_helper 模块中)

create_function() (sqlite3.Connection 方法)

create_future() (asyncio.loop 方法)

create_module() (importlib.abc.Loader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(zipimport.zipimporter 方法)

CREATE_NEW_CONSOLE() (在 subprocess 模块中)

CREATE_NEW_PROCESS_GROUP() (在 subprocess 模块中)

CREATE_NO_WINDOW() (在 subprocess 模块中)

create_server() (asyncio.loop 方法)

(在 socket 模块中)

create_shortcut()

內置函数

create_socket() (asyncore.dispatcher 方法)

create_static_lib() (distutils.ccompiler.CCompiler 方法)

create_stats() (profile.Profile 方法)

create_string_buffer() (在 ctypes 模块中)

create_subprocess_exec() (在 asyncio 模块中)

create_subprocess_shell() (在 asyncio 模块中)

create_system (zipfile.ZipInfo 属性)

create_task() (asyncio.loop 方法)

(在 asyncio 模块中)

create_tree() (在 distutils.dir_util 模块中)

create_unicode_buffer() (在 ctypes 模块中)

create_unix_connection() (asyncio.loop 方法)

create_unix_server() (asyncio.loop 方法)

create_version (zipfile.ZipInfo 属性)

createAttribute() (xml.dom.Document 方法)

createAttributeNS() (xml.dom.Document 方法)

createComment() (xml.dom.Document 方法)

createDocument() (xml.dom.DOMImplementation 方法)

createDocumentType() (xml.dom.DOMImplementation 方法)

createElement() (xml.dom.Document 方法)

createElementNS() (xml.dom.Document 方法)

createfilehandler() (tkinter.Widget.tk 方法)

CreateKey() (在 winreg 模块中)

CreateKeyEx() (在 winreg 模块中)

createLock() (logging.Handler 方法)

(logging.NullHandler 方法)

createProcessingInstruction() (xml.dom.Document 方法)

CreateRecord() (在 msilib 模块中)

createSocket() (logging.handlers.SocketHandler 方法)

createTextNode() (xml.dom.Document 方法)

credits (內置变量)

critical() (logging.Logger 方法)

(在 logging 模块中)

CRNCYSTR() (在 locale 模块中)

cross() (在 audioop 模块中)

crypt

模块, [1]

crypt() (在 crypt 模块中)

crypt(3), [1], [2]

cryptography

cssclass_month (calendar.HTMLCalendar 属性)

cssclass_month_head (calendar.HTMLCalendar 属性)

cssclass_noday (calendar.HTMLCalendar 属性)

cssclass_year (calendar.HTMLCalendar 属性)

cssclass_year_head (calendar.HTMLCalendar 属性)

cssclasses (calendar.HTMLCalendar 属性)

cssclasses_weekday_head (calendar.HTMLCalendar 属性)

csv

模块

cte (email.headerregistry.ContentTransferEncoding 属性)

cte_type (email.policy.Policy 属性)

ctermid() (在 os 模块中)

ctime() (datetime.date 方法)

(datetime.datetime 方法)

(在 time 模块中)

ctrl() (在 curses.ascii 模块中)

CTRL_BREAK_EVENT() (在 signal 模块中)

CTRL_C_EVENT() (在 signal 模块中)

ctypes

模块

curdir() (在 os 模块中)

currency() (在 locale 模块中)

current() (tkinter.ttk.Combobox 方法)

current_process() (在 multiprocessing 模块中)

current_task() (在 asyncio 模块中)

current_thread() (在 threading 模块中)

CurrentByteIndex (xml.parsers.expat.xmlparser 属性)

CurrentColumnNumber (xml.parsers.expat.xmlparser 属性)

currentframe() (在 inspect 模块中)

CurrentLineNumber (xml.parsers.expat.xmlparser 属性)

curs_set() (在 curses 模块中)

curses

模块

curses.ascii

模块

curses.panel

模块

curses.textpad

模块

Cursor (sqlite3 中的类)

cursor() (sqlite3.Connection 方法)

cursyncup() (curses.window 方法)

customize_compiler() (在 distutils.sysconfig 模块中)

Cut

cwd() (ftplib.FTP 方法)

(pathlib.Path 类方法)

cycle() (在 itertools 模块中)

CycleError

Cyclic Redundancy Check

D

D_FMT() (在 locale 模块中)

D_T_FMT() (在 locale 模块中)

daemon (multiprocessing.Process 属性)

(threading.Thread 属性)

dangling

else

data

packing binary

tabular

type

type, immutable

data (collections.UserDict 属性)

(collections.UserList 属性)

(collections.UserString 属性)

(select.kevent 属性)

(selectors.SelectorKey 属性)

(urllib.request.Request 属性)

(xml.dom.Comment 属性)

(xml.dom.ProcessingInstruction 属性)

(xml.dom.Text 属性)

(xmlrpc.client.Binary 属性)

data() (xml.etree.ElementTree.TreeBuilder 方法)

data_filter() (在 tarfile 模块中)

data_open() (urllib.request.DataHandler 方法)

data_received() (asyncio.Protocol 方法)

database

Unicode

DatabaseError

databases

dataclass() (在 dataclasses 模块中)

dataclasses

模块

DataError

datagram_received() (asyncio.DatagramProtocol 方法)

DatagramHandler (logging.handlers 中的类)

DatagramProtocol (asyncio 中的类)

DatagramRequestHandler (socketserver 中的类)

DatagramTransport (asyncio 中的类)

DataHandler (urllib.request 中的类)

date (datetime 中的类)

date() (datetime.datetime 方法)

(nntplib.NNTP 方法)

date_time (zipfile.ZipInfo 属性)

date_time_string() (http.server.BaseHTTPRequestHandler 方法)

DateHeader (email.headerregistry 中的类)

datetime

模块

datetime (datetime 中的类)

(email.headerregistry.DateHeader 属性)

DateTime (xmlrpc.client 中的类)

datum

day (datetime.date 属性)

(datetime.datetime 属性)

day_abbr() (在 calendar 模块中)

day_name() (在 calendar 模块中)

Daylight Saving Time

daylight() (在 time 模块中)

DbfilenameShelf (shelve 中的类)

dbm

模块

dbm.dumb

模块

dbm.gnu

模块, [1], [2]

dbm.ndbm

模块, [1], [2]

dcgettext() (在 locale 模块中)

deallocation, object

debug (imaplib.IMAP4 属性)

(pdb command)

(shlex.shlex 属性)

(zipfile.ZipFile 属性)

debug() (logging.Logger 方法)

(pipes.Template 方法)

(unittest.TestCase 方法)

(unittest.TestSuite 方法)

(在 doctest 模块中)

(在 logging 模块中)

DEBUG() (在 re 模块中)

DEBUG_BYTECODE_SUFFIXES() (在 importlib.machinery 模块中)

DEBUG_COLLECTABLE() (在 gc 模块中)

DEBUG_LEAK() (在 gc 模块中)

debug_print() (distutils.ccompiler.CCompiler 方法)

DEBUG_SAVEALL() (在 gc 模块中)

debug_src() (在 doctest 模块中)

DEBUG_STATS() (在 gc 模块中)

DEBUG_UNCOLLECTABLE() (在 gc 模块中)

debugger, [1], [2], [3]

configuration file

debugging

assertions

CGI

DebuggingServer (smtpd 中的类)

debuglevel (http.client.HTTPResponse 属性)

DebugRunner (doctest 中的类)

decimal

模块

Decimal (decimal 中的类)

decimal literal

decimal() (在 unicodedata 模块中)

DecimalException (decimal 中的类)

decode

Codecs

decode (codecs.CodecInfo 属性)

decode() (bytearray 方法)

(bytes 方法)

(codecs.Codec 方法)

(codecs.IncrementalDecoder 方法)

(json.JSONDecoder 方法)

(xmlrpc.client.Binary 方法)

(xmlrpc.client.DateTime 方法)

(在 base64 模块中)

(在 codecs 模块中)

(在 quopri 模块中)

(在 uu 模块中)

decode_header() (在 email.header 模块中)

(在 nntplib 模块中)

decode_params() (在 email.utils 模块中)

decode_rfc2231() (在 email.utils 模块中)

decode_source() (在 importlib.util 模块中)

decodebytes() (在 base64 模块中)

DecodedGenerator (email.generator 中的类)

decodestring() (在 quopri 模块中)

decomposition() (在 unicodedata 模块中)

decompress() (bz2.BZ2Decompressor 方法)

(lzma.LZMADecompressor 方法)

(zlib.Decompress 方法)

(在 bz2 模块中)

(在 gzip 模块中)

(在 lzma 模块中)

(在 zlib 模块中)

decompressobj() (在 zlib 模块中)

decorator -- 装饰器

DEDENT token, [1]

dedent() (在 textwrap 模块中)

DEDENT() (在 token 模块中)

deepcopy() (在 copy 模块中)

def

语句

def_prog_mode() (在 curses 模块中)

def_shell_mode() (在 curses 模块中)

default

parameter value

default (inspect.Parameter 属性)

(optparse.Option 属性)

default() (cmd.Cmd 方法)

(json.JSONEncoder 方法)

(在 email.policy 模块中)

DEFAULT() (在 unittest.mock 模块中)

DEFAULT_BUFFER_SIZE() (在 io 模块中)

default_bufsize() (在 xml.dom.pulldom 模块中)

default_exception_handler() (asyncio.loop 方法)

default_factory (collections.defaultdict 属性)

DEFAULT_FORMAT() (在 tarfile 模块中)

DEFAULT_IGNORES() (在 filecmp 模块中)

default_open() (urllib.request.BaseHandler 方法)

DEFAULT_PROTOCOL() (在 pickle 模块中)

default_timer() (在 timeit 模块中)

DefaultContext (decimal 中的类)

DefaultCookiePolicy (http.cookiejar 中的类)

defaultdict (collections 中的类)

DefaultDict (typing 中的类)

DefaultEventLoopPolicy (asyncio 中的类)

DefaultHandler() (xml.parsers.expat.xmlparser 方法)

DefaultHandlerExpand() (xml.parsers.expat.xmlparser 方法)

defaults() (configparser.ConfigParser 方法)

DefaultSelector (selectors 中的类)

defaultTestLoader() (在 unittest 模块中)

defaultTestResult() (unittest.TestCase 方法)

defects (email.headerregistry.BaseHeader 属性)

(email.message.EmailMessage 属性)

(email.message.Message 属性)

define_macro() (distutils.ccompiler.CCompiler 方法)

definition

class, [1]

function, [1]

defpath() (在 os 模块中)

DefragResult (urllib.parse 中的类)

DefragResultBytes (urllib.parse 中的类)

degrees() (在 math 模块中)

(在 turtle 模块中)

del

语句, [1], [2], [3]

Del (ast 中的类)

del_param() (email.message.EmailMessage 方法)

(email.message.Message 方法)

delattr()

內置函数

delay() (在 turtle 模块中)

delay_output() (在 curses 模块中)

delayload (http.cookiejar.FileCookieJar 属性)

delch() (curses.window 方法)

dele() (poplib.POP3 方法)

Delete (ast 中的类)

delete() (ftplib.FTP 方法)

(imaplib.IMAP4 方法)

(tkinter.ttk.Treeview 方法)

DELETE_ATTR (opcode)

DELETE_DEREF (opcode)

DELETE_FAST (opcode)

DELETE_GLOBAL (opcode)

DELETE_NAME (opcode)

DELETE_SUBSCR (opcode)

deleteacl() (imaplib.IMAP4 方法)

deletefilehandler() (tkinter.Widget.tk 方法)

DeleteKey() (在 winreg 模块中)

DeleteKeyEx() (在 winreg 模块中)

deleteln() (curses.window 方法)

deleteMe() (bdb.Breakpoint 方法)

DeleteValue() (在 winreg 模块中)

deletion

attribute

target

target list

delimiter (csv.Dialect 属性)

delimiters

delitem() (在 operator 模块中)

deliver_challenge() (在 multiprocessing.connection 模块中)

delocalize() (在 locale 模块中)

demo_app() (在 wsgiref.simple_server 模块中)

denominator (fractions.Fraction 属性)

(numbers.Rational 属性)

DeprecationWarning

deque (collections 中的类)

Deque (typing 中的类)

dequeue() (logging.handlers.QueueListener 方法)

DER_cert_to_PEM_cert() (在 ssl 模块中)

derwin() (curses.window 方法)

DES

cipher

descrgetfunc (C type)

description (inspect.Parameter.kind 属性)

(sqlite3.Cursor 属性)

description() (nntplib.NNTP 方法)

descriptions() (nntplib.NNTP 方法)

descriptor -- 描述器

descrsetfunc (C type)

dest (optparse.Option 属性)

destructor, [1]

(C type)

detach() (io.BufferedIOBase 方法)

(io.TextIOBase 方法)

(socket.socket 方法)

(tkinter.ttk.Treeview 方法)

(weakref.finalize 方法)

Detach() (winreg.PyHKEY 方法)

DETACHED_PROCESS() (在 subprocess 模块中)

detect_api_mismatch() (在 test.support 模块中)

detect_encoding() (在 tokenize 模块中)

detect_language() (distutils.ccompiler.CCompiler 方法)

deterministic profiling

device_encoding() (在 os 模块中)

devnull() (在 os 模块中)

DEVNULL() (在 subprocess 模块中)

devpoll() (在 select 模块中)

DevpollSelector (selectors 中的类)

dgettext() (在 gettext 模块中)

(在 locale 模块中)

Dialect (csv 中的类)

dialect (csv.csvreader 属性)

(csv.csvwriter 属性)

Dialog (msilib 中的类)

(tkinter.commondialog 中的类)

(tkinter.simpledialog 中的类)

dict (2to3 fixer)

Dict (ast 中的类)

(typing 中的类)

dict (內置类)

dict() (multiprocessing.managers.SyncManager 方法)

DICT_MERGE (opcode)

DICT_UPDATE (opcode)

DictComp (ast 中的类)

dictConfig() (在 logging.config 模块中)

dictionary

comprehensions

display

type, operations on

对象, [1], [2], [3], [4], [5], [6], [7]

dictionary -- 字典

dictionary comprehension -- 字典推导式

dictionary view -- 字典视图

DictReader (csv 中的类)

DictWriter (csv 中的类)

diff_bytes() (在 difflib 模块中)

diff_files (filecmp.dircmp 属性)

Differ (difflib 中的类)

difference() (frozenset 方法)

difference_update() (frozenset 方法)

difflib

模块

digest() (hashlib.hash 方法)

(hashlib.shake 方法)

(hmac.HMAC 方法)

(在 hmac 模块中)

digest_size (hmac.HMAC 属性)

digit() (在 unicodedata 模块中)

digits() (在 string 模块中)

dir()

內置函数

dir() (ftplib.FTP 方法)

dircmp (filecmp 中的类)

directory

changing

creating

deleting, [1]

site-packages

traversal, [1]

walking, [1]

Directory (msilib 中的类)

(tkinter.filedialog 中的类)

directory ...

compileall command line option

directory_created()

內置函数

DirEntry (os 中的类)

DirList (tkinter.tix 中的类)

dirname() (在 os.path 模块中)

dirs_double_event() (tkinter.filedialog.FileDialog 方法)

dirs_select_event() (tkinter.filedialog.FileDialog 方法)

DirSelectBox (tkinter.tix 中的类)

DirSelectDialog (tkinter.tix 中的类)

DirsOnSysPath (test.support.import_helper 中的类)

DirTree (tkinter.tix 中的类)

dis

模块

dis() (dis.Bytecode 方法)

(在 dis 模块中)

(在 pickletools 模块中)

disable (pdb command)

disable() (bdb.Breakpoint 方法)

(profile.Profile 方法)

(在 faulthandler 模块中)

(在 gc 模块中)

(在 logging 模块中)

disable_faulthandler() (在 test.support 模块中)

disable_gc() (在 test.support 模块中)

disable_interspersed_args() (optparse.OptionParser 方法)

DisableReflectionKey() (在 winreg 模块中)

disassemble() (在 dis 模块中)

discard (http.cookiejar.Cookie 属性)

discard() (frozenset 方法)

(mailbox.Mailbox 方法)

(mailbox.MH 方法)

discard_buffers() (asynchat.async_chat 方法)

disco() (在 dis 模块中)

discover() (unittest.TestLoader 方法)

disk_usage() (在 shutil 模块中)

dispatch_call() (bdb.Bdb 方法)

dispatch_exception() (bdb.Bdb 方法)

dispatch_line() (bdb.Bdb 方法)

dispatch_return() (bdb.Bdb 方法)

dispatch_table (pickle.Pickler 属性)

dispatcher (asyncore 中的类)

dispatcher_with_send (asyncore 中的类)

DISPLAY

display

dictionary

list

set

display (pdb command)

display_name (email.headerregistry.Address 属性)

(email.headerregistry.Group 属性)

displayhook() (在 sys 模块中)

dist() (在 math 模块中)

distance() (在 turtle 模块中)

distb() (在 dis 模块中)

Distribution (distutils.core 中的类)

distutils

模块

distutils.archive_util

模块

distutils.bcppcompiler

模块

distutils.ccompiler

模块

distutils.cmd

模块

distutils.command

模块

distutils.command.bdist

模块

distutils.command.bdist_dumb

模块

distutils.command.bdist_msi

模块

distutils.command.bdist_packager

模块

distutils.command.bdist_rpm

模块

distutils.command.build

模块

distutils.command.build_clib

模块

distutils.command.build_ext

模块

distutils.command.build_py

模块

distutils.command.build_scripts

模块

distutils.command.check

模块

distutils.command.clean

模块

distutils.command.config

模块

distutils.command.install

模块

distutils.command.install_data

模块

distutils.command.install_headers

模块

distutils.command.install_lib

模块

distutils.command.install_scripts

模块

distutils.command.register

模块

distutils.command.sdist

模块

distutils.core

模块

distutils.cygwinccompiler

模块

distutils.debug

模块

distutils.dep_util

模块

distutils.dir_util

模块

distutils.dist

模块

distutils.errors

模块

distutils.extension

模块

distutils.fancy_getopt

模块

distutils.file_util

模块

distutils.filelist

模块

distutils.log

模块

distutils.msvccompiler

模块

distutils.spawn

模块

distutils.sysconfig

模块

distutils.text_file

模块

distutils.unixccompiler

模块

distutils.util

模块

distutils.version

模块

DISTUTILS_DEBUG

Div (ast 中的类)

divide() (decimal.Context 方法)

divide_int() (decimal.Context 方法)

division

DivisionByZero (decimal 中的类)

divmod

內置函数, [1], [2]

divmod()

內置函数

divmod() (decimal.Context 方法)

DllCanUnloadNow() (在 ctypes 模块中)

DllGetClassObject() (在 ctypes 模块中)

dllhandle() (在 sys 模块中)

dnd_start() (在 tkinter.dnd 模块中)

DndHandler (tkinter.dnd 中的类)

dngettext() (在 gettext 模块中)

dnpgettext() (在 gettext 模块中)

do_clear() (bdb.Bdb 方法)

do_command() (curses.textpad.Textbox 方法)

do_GET() (http.server.SimpleHTTPRequestHandler 方法)

do_handshake() (ssl.SSLSocket 方法)

do_HEAD() (http.server.SimpleHTTPRequestHandler 方法)

do_POST() (http.server.CGIHTTPRequestHandler 方法)

doc (json.JSONDecodeError 属性)

doc_header (cmd.Cmd 属性)

DocCGIXMLRPCRequestHandler (xmlrpc.server 中的类)

DocFileSuite() (在 doctest 模块中)

doClassCleanups() (unittest.TestCase 类方法)

doCleanups() (unittest.TestCase 方法)

docmd() (smtplib.SMTP 方法)

docstring

(doctest.DocTest 属性)

docstring -- 文档字符串

docstrings, [1]

doctest

模块

DocTest (doctest 中的类)

DocTestFailure

DocTestFinder (doctest 中的类)

DocTestParser (doctest 中的类)

DocTestRunner (doctest 中的类)

DocTestSuite() (在 doctest 模块中)

doctype() (xml.etree.ElementTree.TreeBuilder 方法)

documentation

generation

online

documentation string

documentation strings, [1]

documentElement (xml.dom.Document 属性)

DocXMLRPCRequestHandler (xmlrpc.server 中的类)

DocXMLRPCServer (xmlrpc.server 中的类)

domain (email.headerregistry.Address 属性)

(tracemalloc.DomainFilter 属性)

(tracemalloc.Filter 属性)

(tracemalloc.Trace 属性)

domain_initial_dot (http.cookiejar.Cookie 属性)

domain_return_ok() (http.cookiejar.CookiePolicy 方法)

domain_specified (http.cookiejar.Cookie 属性)

DomainFilter (tracemalloc 中的类)

DomainLiberal (http.cookiejar.DefaultCookiePolicy 属性)

DomainRFC2965Match (http.cookiejar.DefaultCookiePolicy 属性)

DomainStrict (http.cookiejar.DefaultCookiePolicy 属性)

DomainStrictNoDots (http.cookiejar.DefaultCookiePolicy 属性)

DomainStrictNonDomain (http.cookiejar.DefaultCookiePolicy 属性)

DOMEventStream (xml.dom.pulldom 中的类)

DOMException

doModuleCleanups() (在 unittest 模块中)

DomstringSizeErr

done() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

(graphlib.TopologicalSorter 方法)

(xdrlib.Unpacker 方法)

(在 turtle 模块中)

DONT_ACCEPT_BLANKLINE() (在 doctest 模块中)

DONT_ACCEPT_TRUE_FOR_1() (在 doctest 模块中)

dont_write_bytecode() (在 sys 模块中)

doRollover() (logging.handlers.RotatingFileHandler 方法)

(logging.handlers.TimedRotatingFileHandler 方法)

DOT() (在 token 模块中)

dot() (在 turtle 模块中)

DOTALL() (在 re 模块中)

doublequote (csv.Dialect 属性)

DOUBLESLASH() (在 token 模块中)

DOUBLESLASHEQUAL() (在 token 模块中)

DOUBLESTAR() (在 token 模块中)

DOUBLESTAREQUAL() (在 token 模块中)

doupdate() (在 curses 模块中)

down (pdb command)

down() (在 turtle 模块中)

dpgettext() (在 gettext 模块中)

drain() (asyncio.StreamWriter 方法)

drive (pathlib.PurePath 属性)

drop_whitespace (textwrap.TextWrapper 属性)

dropwhile() (在 itertools 模块中)

dst() (datetime.datetime 方法)

(datetime.time 方法)

(datetime.timezone 方法)

(datetime.tzinfo 方法)

DTDHandler (xml.sax.handler 中的类)

duck-typing -- 鸭子类型

dump() (pickle.Pickler 方法)

(tracemalloc.Snapshot 方法)

(在 ast 模块中)

(在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

(在 xml.etree.ElementTree 模块中)

dump_stats() (profile.Profile 方法)

(pstats.Stats 方法)

dump_traceback() (在 faulthandler 模块中)

dump_traceback_later() (在 faulthandler 模块中)

dumps() (在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

(在 xmlrpc.client 模块中)

dup() (socket.socket 方法)

(在 os 模块中)

dup2() (在 os 模块中)

DUP_TOP (opcode)

DUP_TOP_TWO (opcode)

DuplicateOptionError

DuplicateSectionError

dwFlags (subprocess.STARTUPINFO 属性)

DynamicClassAttribute() (在 types 模块中)

E

e

in numeric literal

e() (在 cmath 模块中)

(在 math 模块中)

E2BIG() (在 errno 模块中)

EACCES() (在 errno 模块中)

EADDRINUSE() (在 errno 模块中)

EADDRNOTAVAIL() (在 errno 模块中)

EADV() (在 errno 模块中)

EAFNOSUPPORT() (在 errno 模块中)

EAFP

EAGAIN() (在 errno 模块中)

EALREADY() (在 errno 模块中)

east_asian_width() (在 unicodedata 模块中)

EBADE() (在 errno 模块中)

EBADF() (在 errno 模块中)

EBADFD() (在 errno 模块中)

EBADMSG() (在 errno 模块中)

EBADR() (在 errno 模块中)

EBADRQC() (在 errno 模块中)

EBADSLT() (在 errno 模块中)

EBFONT() (在 errno 模块中)

EBUSY() (在 errno 模块中)

ECHILD() (在 errno 模块中)

echo() (在 curses 模块中)

echochar() (curses.window 方法)

ECHRNG() (在 errno 模块中)

ECOMM() (在 errno 模块中)

ECONNABORTED() (在 errno 模块中)

ECONNREFUSED() (在 errno 模块中)

ECONNRESET() (在 errno 模块中)

EDEADLK() (在 errno 模块中)

EDEADLOCK() (在 errno 模块中)

EDESTADDRREQ() (在 errno 模块中)

edit() (curses.textpad.Textbox 方法)

EDOM() (在 errno 模块中)

EDOTDOT() (在 errno 模块中)

EDQUOT() (在 errno 模块中)

EEXIST() (在 errno 模块中)

EFAULT() (在 errno 模块中)

EFBIG() (在 errno 模块中)

EFD_CLOEXEC() (在 os 模块中)

EFD_NONBLOCK() (在 os 模块中)

EFD_SEMAPHORE() (在 os 模块中)

effective() (在 bdb 模块中)

ehlo() (smtplib.SMTP 方法)

ehlo_or_helo_if_needed() (smtplib.SMTP 方法)

EHOSTDOWN() (在 errno 模块中)

EHOSTUNREACH() (在 errno 模块中)

EIDRM() (在 errno 模块中)

EILSEQ() (在 errno 模块中)

EINPROGRESS() (在 errno 模块中)

EINTR() (在 errno 模块中)

EINVAL() (在 errno 模块中)

EIO() (在 errno 模块中)

EISCONN() (在 errno 模块中)

EISDIR() (在 errno 模块中)

EISNAM() (在 errno 模块中)

EL2HLT() (在 errno 模块中)

EL2NSYNC() (在 errno 模块中)

EL3HLT() (在 errno 模块中)

EL3RST() (在 errno 模块中)

Element (xml.etree.ElementTree 中的类)

element_create() (tkinter.ttk.Style 方法)

element_names() (tkinter.ttk.Style 方法)

element_options() (tkinter.ttk.Style 方法)

ElementDeclHandler() (xml.parsers.expat.xmlparser 方法)

elements() (collections.Counter 方法)

ElementTree (xml.etree.ElementTree 中的类)

ELIBACC() (在 errno 模块中)

ELIBBAD() (在 errno 模块中)

ELIBEXEC() (在 errno 模块中)

ELIBMAX() (在 errno 模块中)

ELIBSCN() (在 errno 模块中)

elif

关键字

Ellinghouse, Lance

Ellipsis

对象

Ellipsis (內置变量)

ELLIPSIS() (在 doctest 模块中)

(在 token 模块中)

EllipsisType() (在 types 模块中)

ELNRNG() (在 errno 模块中)

ELOOP() (在 errno 模块中)

else

conditional expression

dangling

关键字, [1], [2], [3], [4], [5]

email

模块

email.charset

模块

email.contentmanager

模块

email.encoders

模块

email.errors

模块

email.generator

模块

email.header

模块

email.headerregistry

模块

email.iterators

模块

email.message

模块

email.mime

模块

email.parser

模块

email.policy

模块

email.utils

模块

EmailMessage (email.message 中的类)

EmailPolicy (email.policy 中的类)

EMFILE() (在 errno 模块中)

emit() (logging.FileHandler 方法)

(logging.Handler 方法)

(logging.handlers.BufferingHandler 方法)

(logging.handlers.DatagramHandler 方法)

(logging.handlers.HTTPHandler 方法)

(logging.handlers.NTEventLogHandler 方法)

(logging.handlers.QueueHandler 方法)

(logging.handlers.RotatingFileHandler 方法)

(logging.handlers.SMTPHandler 方法)

(logging.handlers.SocketHandler 方法)

(logging.handlers.SysLogHandler 方法)

(logging.handlers.TimedRotatingFileHandler 方法)

(logging.handlers.WatchedFileHandler 方法)

(logging.NullHandler 方法)

(logging.StreamHandler 方法)

EMLINK() (在 errno 模块中)

Empty

empty

list

tuple, [1]

empty (inspect.Parameter 属性)

(inspect.Signature 属性)

empty() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(multiprocessing.SimpleQueue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

(sched.scheduler 方法)

EMPTY_NAMESPACE() (在 xml.dom 模块中)

emptyline() (cmd.Cmd 方法)

EMSGSIZE() (在 errno 模块中)

EMULTIHOP() (在 errno 模块中)

enable (pdb command)

enable() (bdb.Breakpoint 方法)

(imaplib.IMAP4 方法)

(profile.Profile 方法)

(在 cgitb 模块中)

(在 faulthandler 模块中)

(在 gc 模块中)

enable_callback_tracebacks() (在 sqlite3 模块中)

enable_interspersed_args() (optparse.OptionParser 方法)

enable_load_extension() (sqlite3.Connection 方法)

enable_traversal() (tkinter.ttk.Notebook 方法)

ENABLE_USER_SITE() (在 site 模块中)

EnableControlFlowGuard

enabled (bdb.Breakpoint 属性)

EnableReflectionKey() (在 winreg 模块中)

ENAMETOOLONG() (在 errno 模块中)

ENAVAIL() (在 errno 模块中)

enclose() (curses.window 方法)

encode

Codecs

encode (codecs.CodecInfo 属性)

encode() (codecs.Codec 方法)

(codecs.IncrementalEncoder 方法)

(email.header.Header 方法)

(json.JSONEncoder 方法)

(str 方法)

(xmlrpc.client.Binary 方法)

(xmlrpc.client.DateTime 方法)

(在 base64 模块中)

(在 codecs 模块中)

(在 quopri 模块中)

(在 uu 模块中)

encode_7or8bit() (在 email.encoders 模块中)

encode_base64() (在 email.encoders 模块中)

encode_noop() (在 email.encoders 模块中)

encode_quopri() (在 email.encoders 模块中)

encode_rfc2231() (在 email.utils 模块中)

encodebytes() (在 base64 模块中)

EncodedFile() (在 codecs 模块中)

encodePriority() (logging.handlers.SysLogHandler 方法)

encodestring() (在 quopri 模块中)

encoding

base64

quoted-printable

encoding (curses.window 属性)

(io.TextIOBase 属性)

(UnicodeError 属性)

encoding declarations (source file)

ENCODING() (在 tarfile 模块中)

(在 token 模块中)

encodings.idna

模块

encodings.mbcs

模块

encodings.utf_8_sig

模块

encodings_map (mimetypes.MimeTypes 属性)

encodings_map() (在 mimetypes 模块中)

EncodingWarning

end (UnicodeError 属性)

end() (re.Match 方法)

(xml.etree.ElementTree.TreeBuilder 方法)

END_ASYNC_FOR (opcode)

end_col_offset (ast.AST 属性)

end_fill() (在 turtle 模块中)

end_headers() (http.server.BaseHTTPRequestHandler 方法)

end_lineno (ast.AST 属性)

(SyntaxError 属性)

(traceback.TracebackException 属性)

end_ns() (xml.etree.ElementTree.TreeBuilder 方法)

end_offset (SyntaxError 属性)

(traceback.TracebackException 属性)

end_poly() (在 turtle 模块中)

endCDATA() (xml.sax.handler.LexicalHandler 方法)

EndCdataSectionHandler() (xml.parsers.expat.xmlparser 方法)

EndDoctypeDeclHandler() (xml.parsers.expat.xmlparser 方法)

endDocument() (xml.sax.handler.ContentHandler 方法)

endDTD() (xml.sax.handler.LexicalHandler 方法)

endElement() (xml.sax.handler.ContentHandler 方法)

EndElementHandler() (xml.parsers.expat.xmlparser 方法)

endElementNS() (xml.sax.handler.ContentHandler 方法)

endheaders() (http.client.HTTPConnection 方法)

ENDMARKER() (在 token 模块中)

EndNamespaceDeclHandler() (xml.parsers.expat.xmlparser 方法)

endpos (re.Match 属性)

endPrefixMapping() (xml.sax.handler.ContentHandler 方法)

endswith() (bytearray 方法)

(bytes 方法)

(str 方法)

endwin() (在 curses 模块中)

ENETDOWN() (在 errno 模块中)

ENETRESET() (在 errno 模块中)

ENETUNREACH() (在 errno 模块中)

ENFILE() (在 errno 模块中)

ENOANO() (在 errno 模块中)

ENOBUFS() (在 errno 模块中)

ENOCSI() (在 errno 模块中)

ENODATA() (在 errno 模块中)

ENODEV() (在 errno 模块中)

ENOENT() (在 errno 模块中)

ENOEXEC() (在 errno 模块中)

ENOLCK() (在 errno 模块中)

ENOLINK() (在 errno 模块中)

ENOMEM() (在 errno 模块中)

ENOMSG() (在 errno 模块中)

ENONET() (在 errno 模块中)

ENOPKG() (在 errno 模块中)

ENOPROTOOPT() (在 errno 模块中)

ENOSPC() (在 errno 模块中)

ENOSR() (在 errno 模块中)

ENOSTR() (在 errno 模块中)

ENOSYS() (在 errno 模块中)

ENOTBLK() (在 errno 模块中)

ENOTCONN() (在 errno 模块中)

ENOTDIR() (在 errno 模块中)

ENOTEMPTY() (在 errno 模块中)

ENOTNAM() (在 errno 模块中)

ENOTSOCK() (在 errno 模块中)

ENOTTY() (在 errno 模块中)

ENOTUNIQ() (在 errno 模块中)

enqueue() (logging.handlers.QueueHandler 方法)

enqueue_sentinel() (logging.handlers.QueueListener 方法)

ensure_directories() (venv.EnvBuilder 方法)

ensure_future() (在 asyncio 模块中)

ensurepip

模块

enter() (sched.scheduler 方法)

enter_async_context() (contextlib.AsyncExitStack 方法)

enter_context() (contextlib.ExitStack 方法)

enterabs() (sched.scheduler 方法)

entities (xml.dom.DocumentType 属性)

EntityDeclHandler() (xml.parsers.expat.xmlparser 方法)

entitydefs() (在 html.entities 模块中)

EntityResolver (xml.sax.handler 中的类)

enum

模块

Enum (enum 中的类)

enum_certificates() (在 ssl 模块中)

enum_crls() (在 ssl 模块中)

enumerate()

內置函数

enumerate() (在 threading 模块中)

EnumKey() (在 winreg 模块中)

EnumValue() (在 winreg 模块中)

EnvBuilder (venv 中的类)

environ() (在 os 模块中)

(在 posix 模块中)

environb() (在 os 模块中)

environment

environment variables

deleting

setting

EnvironmentError

Environments

virtual

EnvironmentVarGuard (test.support.os_helper 中的类)

ENXIO() (在 errno 模块中)

eof (bz2.BZ2Decompressor 属性)

(lzma.LZMADecompressor 属性)

(shlex.shlex 属性)

(ssl.MemoryBIO 属性)

(zlib.Decompress 属性)

eof_received() (asyncio.BufferedProtocol 方法)

(asyncio.Protocol 方法)

EOFError

(built-in exception)

EOPNOTSUPP() (在 errno 模块中)

EOVERFLOW() (在 errno 模块中)

EPERM() (在 errno 模块中)

EPFNOSUPPORT() (在 errno 模块中)

epilogue (email.message.EmailMessage 属性)

(email.message.Message 属性)

EPIPE() (在 errno 模块中)

epoch

epoll() (在 select 模块中)

EpollSelector (selectors 中的类)

EPROTO() (在 errno 模块中)

EPROTONOSUPPORT() (在 errno 模块中)

EPROTOTYPE() (在 errno 模块中)

Eq (ast 中的类)

eq() (在 operator 模块中)

EQEQUAL() (在 token 模块中)

EQUAL() (在 token 模块中)

ERA() (在 locale 模块中)

ERA_D_FMT() (在 locale 模块中)

ERA_D_T_FMT() (在 locale 模块中)

ERA_T_FMT() (在 locale 模块中)

ERANGE() (在 errno 模块中)

erase() (curses.window 方法)

erasechar() (在 curses 模块中)

EREMCHG() (在 errno 模块中)

EREMOTE() (在 errno 模块中)

EREMOTEIO() (在 errno 模块中)

ERESTART() (在 errno 模块中)

erf() (在 math 模块中)

erfc() (在 math 模块中)

EROFS() (在 errno 模块中)

ERR() (在 curses 模块中)

errcheck (ctypes._FuncPtr 属性)

errcode (xmlrpc.client.ProtocolError 属性)

errmsg (xmlrpc.client.ProtocolError 属性)

errno

模块, [1]

errno (OSError 属性)

Error, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13]

error, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]

error handler's name

backslashreplace

ignore

namereplace

replace

strict

surrogateescape

surrogatepass

xmlcharrefreplace

error handling

error() (argparse.ArgumentParser 方法)

(logging.Logger 方法)

(urllib.request.OpenerDirector 方法)

(xml.sax.handler.ErrorHandler 方法)

(在 logging 模块中)

error_body (wsgiref.handlers.BaseHandler 属性)

error_content_type (http.server.BaseHTTPRequestHandler 属性)

error_headers (wsgiref.handlers.BaseHandler 属性)

error_leader() (shlex.shlex 方法)

error_message_format (http.server.BaseHTTPRequestHandler 属性)

error_output() (wsgiref.handlers.BaseHandler 方法)

error_perm

error_proto, [1]

error_received() (asyncio.DatagramProtocol 方法)

error_reply

error_status (wsgiref.handlers.BaseHandler 属性)

error_temp

ErrorByteIndex (xml.parsers.expat.xmlparser 属性)

ErrorCode (xml.parsers.expat.xmlparser 属性)

errorcode() (在 errno 模块中)

ErrorColumnNumber (xml.parsers.expat.xmlparser 属性)

ErrorHandler (xml.sax.handler 中的类)

errorlevel (tarfile.TarFile 属性)

ErrorLineNumber (xml.parsers.expat.xmlparser 属性)

Errors

logging

errors

(io.TextIOBase 属性)

(unittest.TestLoader 属性)

(unittest.TestResult 属性)

ErrorString() (在 xml.parsers.expat 模块中)

ERRORTOKEN() (在 token 模块中)

escape (shlex.shlex 属性)

escape sequence

escape() (在 glob 模块中)

(在 html 模块中)

(在 re 模块中)

(在 xml.sax.saxutils 模块中)

escapechar (csv.Dialect 属性)

escapedquotes (shlex.shlex 属性)

ESHUTDOWN() (在 errno 模块中)

ESOCKTNOSUPPORT() (在 errno 模块中)

ESPIPE() (在 errno 模块中)

ESRCH() (在 errno 模块中)

ESRMNT() (在 errno 模块中)

ESTALE() (在 errno 模块中)

ESTRPIPE() (在 errno 模块中)

ETIME() (在 errno 模块中)

ETIMEDOUT() (在 errno 模块中)

Etiny() (decimal.Context 方法)

ETOOMANYREFS() (在 errno 模块中)

Etop() (decimal.Context 方法)

ETXTBSY() (在 errno 模块中)

EUCLEAN() (在 errno 模块中)

EUNATCH() (在 errno 模块中)

EUSERS() (在 errno 模块中)

eval

內置函数, [1], [2], [3], [4]

eval()

內置函数

evaluation

order

Event (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

event scheduling

event() (msilib.Control 方法)

Event() (multiprocessing.managers.SyncManager 方法)

eventfd() (在 os 模块中)

eventfd_read() (在 os 模块中)

eventfd_write() (在 os 模块中)

events (selectors.SelectorKey 属性)

(widgets)

EWOULDBLOCK() (在 errno 模块中)

EX_CANTCREAT() (在 os 模块中)

EX_CONFIG() (在 os 模块中)

EX_DATAERR() (在 os 模块中)

EX_IOERR() (在 os 模块中)

EX_NOHOST() (在 os 模块中)

EX_NOINPUT() (在 os 模块中)

EX_NOPERM() (在 os 模块中)

EX_NOTFOUND() (在 os 模块中)

EX_NOUSER() (在 os 模块中)

EX_OK() (在 os 模块中)

EX_OSERR() (在 os 模块中)

EX_OSFILE() (在 os 模块中)

EX_PROTOCOL() (在 os 模块中)

EX_SOFTWARE() (在 os 模块中)

EX_TEMPFAIL() (在 os 模块中)

EX_UNAVAILABLE() (在 os 模块中)

EX_USAGE() (在 os 模块中)

Example (doctest 中的类)

example (doctest.DocTestFailure 属性)

(doctest.UnexpectedException 属性)

examples (doctest.DocTest 属性)

exc_info (doctest.UnexpectedException 属性)

(in module sys)

exc_info() (in module sys)

(在 sys 模块中)

exc_msg (doctest.Example 属性)

exc_type (traceback.TracebackException 属性)

excel (csv 中的类)

excel_tab (csv 中的类)

except

关键字

语句

except (2to3 fixer)

ExceptHandler (ast 中的类)

excepthook() (in module sys)

(在 sys 模块中)

(在 threading 模块中)

Exception

exception, [1]

chaining

handler

raising

exception handler

exception() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

(logging.Logger 方法)

(在 logging 模块中)

EXCEPTION() (在 tkinter 模块中)

exceptions

in CGI scripts

exclusive

or

EXDEV() (在 errno 模块中)

exec

內置函数, [1], [2]

exec (2to3 fixer)

exec()

內置函数

exec_module() (importlib.abc.InspectLoader 方法)

(importlib.abc.Loader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(zipimport.zipimporter 方法)

EXEC_PREFIX() (在 distutils.sysconfig 模块中)

exec_prefix() (在 sys 模块中)

execfile (2to3 fixer)

execl() (在 os 模块中)

execle() (在 os 模块中)

execlp() (在 os 模块中)

execlpe() (在 os 模块中)

executable (in module sys)

Executable Zip Files

executable() (在 sys 模块中)

executable_filename() (distutils.ccompiler.CCompiler 方法)

execute() (distutils.ccompiler.CCompiler 方法)

Execute() (msilib.View 方法)

execute() (sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

(在 distutils.util 模块中)

executemany() (sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

executescript() (sqlite3.Connection 方法)

(sqlite3.Cursor 方法)

execution

frame, [1]

restricted

stack

execution model

ExecutionLoader (importlib.abc 中的类)

Executor (concurrent.futures 中的类)

execv() (在 os 模块中)

execve() (在 os 模块中)

execvp() (在 os 模块中)

execvpe() (在 os 模块中)

ExFileSelectBox (tkinter.tix 中的类)

EXFULL() (在 errno 模块中)

exists() (pathlib.Path 方法)

(tkinter.ttk.Treeview 方法)

(zipfile.Path 方法)

(在 os.path 模块中)

exit (內置变量)

exit()

(argparse.ArgumentParser 方法)

(在 _thread 模块中)

(在 sys 模块中)

exitcode (multiprocessing.Process 属性)

exitfunc (2to3 fixer)

exitonclick() (在 turtle 模块中)

ExitStack (contextlib 中的类)

exp() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 cmath 模块中)

(在 math 模块中)

expand() (re.Match 方法)

expand_tabs (textwrap.TextWrapper 属性)

ExpandEnvironmentStrings() (在 winreg 模块中)

expandNode() (xml.dom.pulldom.DOMEventStream 方法)

expandtabs() (bytearray 方法)

(bytes 方法)

(str 方法)

expanduser() (pathlib.Path 方法)

(在 os.path 模块中)

expandvars() (在 os.path 模块中)

Expat

ExpatError

expect() (telnetlib.Telnet 方法)

expected (asyncio.IncompleteReadError 属性)

expectedFailure() (在 unittest 模块中)

expectedFailures (unittest.TestResult 属性)

expires (http.cookiejar.Cookie 属性)

exploded (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

expm1() (在 math 模块中)

expovariate() (在 random 模块中)

Expr (ast 中的类)

expression

Conditional

conditional

generator

lambda, [1]

list, [1], [2]

statement

yield

expression -- 表达式

expunge() (imaplib.IMAP4 方法)

extend() (array.array 方法)

(collections.deque 方法)

(sequence method)

(xml.etree.ElementTree.Element 方法)

extend_path() (在 pkgutil 模块中)

EXTENDED_ARG (opcode)

ExtendedContext (decimal 中的类)

ExtendedInterpolation (configparser 中的类)

extendleft() (collections.deque 方法)

extension

module

Extension (distutils.core 中的类)

extension module -- 扩展模块

EXTENSION_SUFFIXES() (在 importlib.machinery 模块中)

ExtensionFileLoader (importlib.machinery 中的类)

extensions_map (http.server.SimpleHTTPRequestHandler 属性)

External Data Representation, [1]

external_attr (zipfile.ZipInfo 属性)

ExternalClashError

ExternalEntityParserCreate() (xml.parsers.expat.xmlparser 方法)

ExternalEntityRefHandler() (xml.parsers.expat.xmlparser 方法)

extra (zipfile.ZipInfo 属性)

extract() (tarfile.TarFile 方法)

(traceback.StackSummary 类方法)

(zipfile.ZipFile 方法)

extract_cookies() (http.cookiejar.CookieJar 方法)

extract_stack() (在 traceback 模块中)

extract_tb() (在 traceback 模块中)

extract_version (zipfile.ZipInfo 属性)

extractall() (tarfile.TarFile 方法)

(zipfile.ZipFile 方法)

ExtractError

extractfile() (tarfile.TarFile 方法)

extraction_filter (tarfile.TarFile 属性)

extsep() (在 os 模块中)

F

f"

formatted string literal

f'

formatted string literal

f-string

f-string -- f-字符串

f_back (frame attribute)

f_builtins (frame attribute)

f_code (frame attribute)

f_contiguous (memoryview 属性)

f_globals (frame attribute)

f_lasti (frame attribute)

f_lineno (frame attribute)

f_locals (frame attribute)

F_LOCK() (在 os 模块中)

F_OK() (在 os 模块中)

F_TEST() (在 os 模块中)

F_TLOCK() (在 os 模块中)

f_trace (frame attribute)

f_trace_lines (frame attribute)

f_trace_opcodes (frame attribute)

F_ULOCK() (在 os 模块中)

fabs() (在 math 模块中)

factorial() (在 math 模块中)

factory() (importlib.util.LazyLoader 类方法)

fail() (unittest.TestCase 方法)

FAIL_FAST() (在 doctest 模块中)

failfast (unittest.TestResult 属性)

failureException (unittest.TestCase 属性)

failures (unittest.TestResult 属性)

FakePath (test.support.os_helper 中的类)

False, [1], [2]

false

False (Built-in object)

(內置变量)

families() (在 tkinter.font 模块中)

family (socket.socket 属性)

fancy_getopt() (在 distutils.fancy_getopt 模块中)

FancyGetopt (distutils.fancy_getopt 中的类)

FancyURLopener (urllib.request 中的类)

fast (pickle.Pickler 属性)

FastChildWatcher (asyncio 中的类)

fatalError() (xml.sax.handler.ErrorHandler 方法)

Fault (xmlrpc.client 中的类)

faultCode (xmlrpc.client.Fault 属性)

faulthandler

模块

faultString (xmlrpc.client.Fault 属性)

fchdir() (在 os 模块中)

fchmod() (在 os 模块中)

fchown() (在 os 模块中)

FCICreate() (在 msilib 模块中)

fcntl

模块

fcntl() (在 fcntl 模块中)

fd (selectors.SelectorKey 属性)

fd() (在 turtle 模块中)

fd_count() (在 test.support.os_helper 模块中)

fdatasync() (在 os 模块中)

fdopen() (在 os 模块中)

Feature (msilib 中的类)

feature_external_ges() (在 xml.sax.handler 模块中)

feature_external_pes() (在 xml.sax.handler 模块中)

feature_namespace_prefixes() (在 xml.sax.handler 模块中)

feature_namespaces() (在 xml.sax.handler 模块中)

feature_string_interning() (在 xml.sax.handler 模块中)

feature_validation() (在 xml.sax.handler 模块中)

feed() (email.parser.BytesFeedParser 方法)

(html.parser.HTMLParser 方法)

(xml.etree.ElementTree.XMLParser 方法)

(xml.etree.ElementTree.XMLPullParser 方法)

(xml.sax.xmlreader.IncrementalParser 方法)

FeedParser (email.parser 中的类)

fetch() (imaplib.IMAP4 方法)

Fetch() (msilib.View 方法)

fetchall() (sqlite3.Cursor 方法)

fetchmany() (sqlite3.Cursor 方法)

fetchone() (sqlite3.Cursor 方法)

fflags (select.kevent 属性)

Field (dataclasses 中的类)

field() (在 dataclasses 模块中)

field_size_limit() (在 csv 模块中)

fieldnames (csv.DictReader 属性)

fields (uuid.UUID 属性)

fields() (在 dataclasses 模块中)

file

.ini

.pdbrc

byte-code, [1]

configuration

copying

debugger configuration

gzip command line option

large files

mime.types

modes

path configuration

plist

temporary

对象, [1]

file (bdb.Breakpoint 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

file ...

compileall command line option

file control

UNIX

file name

temporary

file object

io module

open() built-in function

file object -- 文件对象

file-like object -- 文件型对象

FILE_ATTRIBUTE_ARCHIVE() (在 stat 模块中)

FILE_ATTRIBUTE_COMPRESSED() (在 stat 模块中)

FILE_ATTRIBUTE_DEVICE() (在 stat 模块中)

FILE_ATTRIBUTE_DIRECTORY() (在 stat 模块中)

FILE_ATTRIBUTE_ENCRYPTED() (在 stat 模块中)

FILE_ATTRIBUTE_HIDDEN() (在 stat 模块中)

FILE_ATTRIBUTE_INTEGRITY_STREAM() (在 stat 模块中)

FILE_ATTRIBUTE_NO_SCRUB_DATA() (在 stat 模块中)

FILE_ATTRIBUTE_NORMAL() (在 stat 模块中)

FILE_ATTRIBUTE_NOT_CONTENT_INDEXED() (在 stat 模块中)

FILE_ATTRIBUTE_OFFLINE() (在 stat 模块中)

FILE_ATTRIBUTE_READONLY() (在 stat 模块中)

FILE_ATTRIBUTE_REPARSE_POINT() (在 stat 模块中)

FILE_ATTRIBUTE_SPARSE_FILE() (在 stat 模块中)

FILE_ATTRIBUTE_SYSTEM() (在 stat 模块中)

FILE_ATTRIBUTE_TEMPORARY() (在 stat 模块中)

FILE_ATTRIBUTE_VIRTUAL() (在 stat 模块中)

file_created()

內置函数

file_dispatcher (asyncore 中的类)

file_open() (urllib.request.FileHandler 方法)

file_size (zipfile.ZipInfo 属性)

file_wrapper (asyncore 中的类)

filecmp

模块

fileConfig() (在 logging.config 模块中)

FileCookieJar (http.cookiejar 中的类)

FileDialog (tkinter.filedialog 中的类)

FileEntry (tkinter.tix 中的类)

FileExistsError

FileFinder (importlib.machinery 中的类)

FileHandler (logging 中的类)

(urllib.request 中的类)

fileinput

模块

FileInput (fileinput 中的类)

FileIO (io 中的类)

filelineno() (在 fileinput 模块中)

FileLoader (importlib.abc 中的类)

filemode() (在 stat 模块中)

filename (doctest.DocTest 属性)

(http.cookiejar.FileCookieJar 属性)

(OSError 属性)

(SyntaxError 属性)

(traceback.TracebackException 属性)

(tracemalloc.Frame 属性)

(zipfile.ZipFile 属性)

(zipfile.ZipInfo 属性)

filename() (在 fileinput 模块中)

filename2 (OSError 属性)

filename_only() (在 tabnanny 模块中)

filename_pattern (tracemalloc.Filter 属性)

filenames

pathname expansion

wildcard expansion

fileno() (http.client.HTTPResponse 方法)

(io.IOBase 方法)

(multiprocessing.connection.Connection 方法)

(ossaudiodev.oss_audio_device 方法)

(ossaudiodev.oss_mixer_device 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.kqueue 方法)

(selectors.DevpollSelector 方法)

(selectors.EpollSelector 方法)

(selectors.KqueueSelector 方法)

(socket.socket 方法)

(socketserver.BaseServer 方法)

(telnetlib.Telnet 方法)

(在 fileinput 模块中)

FileNotFoundError

fileobj (selectors.SelectorKey 属性)

files() (在 importlib.resources 模块中)

files_double_event() (tkinter.filedialog.FileDialog 方法)

files_select_event() (tkinter.filedialog.FileDialog 方法)

FileSelectBox (tkinter.tix 中的类)

filesystem encoding and error handler -- 文件系统编码格式与错误处理器

FileType (argparse 中的类)

FileWrapper (wsgiref.util 中的类)

fill() (textwrap.TextWrapper 方法)

(在 textwrap 模块中)

fillcolor() (在 turtle 模块中)

filling() (在 turtle 模块中)

filter (2to3 fixer)

Filter (logging 中的类)

filter (select.kevent 属性)

Filter (tracemalloc 中的类)

filter()

內置函数

filter() (logging.Filter 方法)

(logging.Handler 方法)

(logging.Logger 方法)

(在 curses 模块中)

(在 fnmatch 模块中)

filter_command() (tkinter.filedialog.FileDialog 方法)

FILTER_DIR() (在 unittest.mock 模块中)

filter_traces() (tracemalloc.Snapshot 方法)

FilterError

filterfalse() (在 itertools 模块中)

filterwarnings() (在 warnings 模块中)

Final() (在 typing 模块中)

final() (在 typing 模块中)

finalization, of objects

finalize (weakref 中的类)

finalize_options() (distutils.cmd.Command 方法)

finalizer

finally

关键字, [1], [2], [3], [4]

find() (bytearray 方法)

(bytes 方法)

(doctest.DocTestFinder 方法)

(mmap.mmap 方法)

(str 方法)

(xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

(在 gettext 模块中)

find_class() (pickle protocol)

(pickle.Unpickler 方法)

find_library() (在 ctypes.util 模块中)

find_library_file() (distutils.ccompiler.CCompiler 方法)

find_loader() (importlib.abc.PathEntryFinder 方法)

(importlib.machinery.FileFinder 方法)

(zipimport.zipimporter 方法)

(在 importlib 模块中)

(在 pkgutil 模块中)

find_longest_match() (difflib.SequenceMatcher 方法)

find_module() (imp.NullImporter 方法)

(importlib.abc.Finder 方法)

(importlib.abc.MetaPathFinder 方法)

(importlib.abc.PathEntryFinder 方法)

(importlib.machinery.PathFinder 类方法)

(zipimport.zipimporter 方法)

(在 imp 模块中)

find_msvcrt() (在 ctypes.util 模块中)

find_spec

finder

find_spec() (importlib.abc.MetaPathFinder 方法)

(importlib.abc.PathEntryFinder 方法)

(importlib.machinery.FileFinder 方法)

(importlib.machinery.PathFinder 类方法)

(zipimport.zipimporter 方法)

(在 importlib.util 模块中)

find_unused_port() (在 test.support.socket_helper 模块中)

find_user_password() (urllib.request.HTTPPasswordMgr 方法)

(urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

findall() (re.Pattern 方法)

(xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

(在 re 模块中)

findCaller() (logging.Logger 方法)

finder

find_spec

Finder (importlib.abc 中的类)

finder -- 查找器

findfactor() (在 audioop 模块中)

findfile() (在 test.support 模块中)

findfit() (在 audioop 模块中)

finditer() (re.Pattern 方法)

(在 re 模块中)

findlabels() (在 dis 模块中)

findlinestarts() (在 dis 模块中)

findmatch() (在 mailcap 模块中)

findmax() (在 audioop 模块中)

findtext() (xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

finish() (socketserver.BaseRequestHandler 方法)

(tkinter.dnd.DndHandler 方法)

finish_request() (socketserver.BaseServer 方法)

firstChild (xml.dom.Node 属性)

firstkey() (dbm.gnu.gdbm 方法)

firstweekday() (在 calendar 模块中)

fix_missing_locations() (在 ast 模块中)

fix_sentence_endings (textwrap.TextWrapper 属性)

Flag (enum 中的类)

flag_bits (zipfile.ZipInfo 属性)

flags (re.Pattern 属性)

(select.kevent 属性)

flags() (在 sys 模块中)

flash() (在 curses 模块中)

flatten() (email.generator.BytesGenerator 方法)

(email.generator.Generator 方法)

flattening

objects

float

內置函数, [1], [2]

float (內置类)

float_info() (在 sys 模块中)

float_repr_style() (在 sys 模块中)

floating point

literals

number

对象, [1], [2]

floating point literal

FloatingPointError

FloatOperation (decimal 中的类)

flock() (在 fcntl 模块中)

floor division -- 向下取整除法

floor() (in module math)

(在 math 模块中)

FloorDiv (ast 中的类)

floordiv() (在 operator 模块中)

flush() (bz2.BZ2Compressor 方法)

(io.BufferedWriter 方法)

(io.IOBase 方法)

(logging.Handler 方法)

(logging.handlers.BufferingHandler 方法)

(logging.handlers.MemoryHandler 方法)

(logging.StreamHandler 方法)

(lzma.LZMACompressor 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.MH 方法)

(mmap.mmap 方法)

(xml.etree.ElementTree.XMLParser 方法)

(xml.etree.ElementTree.XMLPullParser 方法)

(zlib.Compress 方法)

(zlib.Decompress 方法)

flush_headers() (http.server.BaseHTTPRequestHandler 方法)

flushinp() (在 curses 模块中)

FlushKey() (在 winreg 模块中)

fma() (decimal.Context 方法)

(decimal.Decimal 方法)

fmean() (在 statistics 模块中)

fmod() (在 math 模块中)

FMT_BINARY() (在 plistlib 模块中)

FMT_XML() (在 plistlib 模块中)

fnmatch

模块

fnmatch() (在 fnmatch 模块中)

fnmatchcase() (在 fnmatch 模块中)

focus() (tkinter.ttk.Treeview 方法)

fold (datetime.datetime 属性)

(datetime.time 属性)

fold() (email.headerregistry.BaseHeader 方法)

(email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

fold_binary() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

Font (tkinter.font 中的类)

for

in comprehensions

语句, [1], [2], [3]

For (ast 中的类)

FOR_ITER (opcode)

forget() (tkinter.ttk.Notebook 方法)

(在 test.support.import_helper 模块中)

fork() (在 os 模块中)

(在 pty 模块中)

ForkingMixIn (socketserver 中的类)

ForkingTCPServer (socketserver 中的类)

ForkingUDPServer (socketserver 中的类)

forkpty() (在 os 模块中)

form

lambda

Form (tkinter.tix 中的类)

format (memoryview 属性)

(multiprocessing.shared_memory.ShareableList 属性)

(struct.Struct 属性)

format()

內置函数

format() (built-in function)

__str__() (object method)

format() (logging.BufferingFormatter 方法)

(logging.Formatter 方法)

(logging.Handler 方法)

(pprint.PrettyPrinter 方法)

(str 方法)

(string.Formatter 方法)

(traceback.StackSummary 方法)

(traceback.TracebackException 方法)

(tracemalloc.Traceback 方法)

(在 locale 模块中)

format_datetime() (在 email.utils 模块中)

format_exc() (在 traceback 模块中)

format_exception() (在 traceback 模块中)

format_exception_only() (traceback.TracebackException 方法)

(在 traceback 模块中)

format_field() (string.Formatter 方法)

format_help() (argparse.ArgumentParser 方法)

format_list() (在 traceback 模块中)

format_map() (str 方法)

format_stack() (在 traceback 模块中)

format_stack_entry() (bdb.Bdb 方法)

format_string() (在 locale 模块中)

format_tb() (在 traceback 模块中)

format_usage() (argparse.ArgumentParser 方法)

FORMAT_VALUE (opcode)

formataddr() (在 email.utils 模块中)

formatargspec() (在 inspect 模块中)

formatargvalues() (在 inspect 模块中)

formatdate() (在 email.utils 模块中)

FormatError

FormatError() (在 ctypes 模块中)

formatException() (logging.Formatter 方法)

formatFooter() (logging.BufferingFormatter 方法)

formatHeader() (logging.BufferingFormatter 方法)

formatmonth() (calendar.HTMLCalendar 方法)

(calendar.TextCalendar 方法)

formatStack() (logging.Formatter 方法)

formatted string literal

FormattedValue (ast 中的类)

Formatter (logging 中的类)

(string 中的类)

formatTime() (logging.Formatter 方法)

formatting

bytearray (%)

bytes (%)

formatting, string (%)

formatwarning() (在 warnings 模块中)

formatyear() (calendar.HTMLCalendar 方法)

(calendar.TextCalendar 方法)

formatyearpage() (calendar.HTMLCalendar 方法)

Fortran contiguous, [1]

forward() (在 turtle 模块中)

ForwardRef (typing 中的类)

found_terminator() (asynchat.async_chat 方法)

fpathconf() (在 os 模块中)

fqdn (smtpd.SMTPChannel 属性)

Fraction (fractions 中的类)

fractions

模块

frame

execution, [1]

对象

frame (tkinter.scrolledtext.ScrolledText 属性)

Frame (tracemalloc 中的类)

FrameSummary (traceback 中的类)

FrameType() (在 types 模块中)

free

variable

free()

freedesktop_os_release() (在 platform 模块中)

freefunc (C type)

freeze utility

freeze() (在 gc 模块中)

freeze_support() (在 multiprocessing 模块中)

frexp() (在 math 模块中)

FRIDAY() (在 calendar 模块中)

from

import statement, [1]

yield from expression

关键字, [1]

from_address() (ctypes._CData 方法)

from_buffer() (ctypes._CData 方法)

from_buffer_copy() (ctypes._CData 方法)

from_bytes() (int 类方法)

from_callable() (inspect.Signature 类方法)

from_decimal() (fractions.Fraction 类方法)

from_exception() (traceback.TracebackException 类方法)

from_file() (zipfile.ZipInfo 类方法)

(zoneinfo.ZoneInfo 类方法)

from_float() (decimal.Decimal 类方法)

(fractions.Fraction 类方法)

from_iterable() (itertools.chain 类方法)

from_list() (traceback.StackSummary 类方法)

from_param() (ctypes._CData 方法)

from_samples() (statistics.NormalDist 类方法)

from_traceback() (dis.Bytecode 类方法)

frombuf() (tarfile.TarInfo 类方法)

frombytes() (array.array 方法)

fromfd() (select.epoll 方法)

(select.kqueue 方法)

(在 socket 模块中)

fromfile() (array.array 方法)

fromhex() (bytearray 类方法)

(bytes 类方法)

(float 类方法)

fromisocalendar() (datetime.date 类方法)

(datetime.datetime 类方法)

fromisoformat() (datetime.date 类方法)

(datetime.datetime 类方法)

(datetime.time 类方法)

fromkeys() (collections.Counter 方法)

(dict 类方法)

fromlist() (array.array 方法)

fromordinal() (datetime.date 类方法)

(datetime.datetime 类方法)

fromshare() (在 socket 模块中)

fromstring() (在 xml.etree.ElementTree 模块中)

fromstringlist() (在 xml.etree.ElementTree 模块中)

fromtarfile() (tarfile.TarInfo 类方法)

fromtimestamp() (datetime.date 类方法)

(datetime.datetime 类方法)

fromunicode() (array.array 方法)

fromutc() (datetime.timezone 方法)

(datetime.tzinfo 方法)

FrozenImporter (importlib.machinery 中的类)

FrozenInstanceError

frozenset

对象, [1]

FrozenSet (typing 中的类)

frozenset (內置类)

fs_is_case_insensitive() (在 test.support.os_helper 模块中)

FS_NONASCII() (在 test.support.os_helper 模块中)

fsdecode() (在 os 模块中)

fsencode() (在 os 模块中)

fspath() (在 os 模块中)

fstat() (在 os 模块中)

fstatvfs() (在 os 模块中)

fstring

fsum() (在 math 模块中)

fsync() (在 os 模块中)

FTP

ftplib (standard module)

protocol, [1]

FTP (ftplib 中的类)

ftp_open() (urllib.request.FTPHandler 方法)

FTP_TLS (ftplib 中的类)

FTPHandler (urllib.request 中的类)

ftplib

模块

ftruncate() (在 os 模块中)

Full

full() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

full_url (urllib.request.Request 属性)

fullmatch() (re.Pattern 方法)

(在 re 模块中)

fully_trusted_filter() (在 tarfile 模块中)

func (functools.partial 属性)

funcattrs (2to3 fixer)

funcname (bdb.Breakpoint 属性)

function

annotations, [1]

anonymous

argument

call, [1], [2]

call, user-defined

definition, [1]

generator, [1]

name, [1]

user-defined

对象, [1], [2], [3], [4], [5]

Function (symtable 中的类)

function -- 函数

function annotation -- 函数标注

FunctionDef (ast 中的类)

FunctionTestCase (unittest 中的类)

FunctionType() (在 types 模块中)

functools

模块

funny_files (filecmp.dircmp 属性)

future

statement

future (2to3 fixer)

Future (asyncio 中的类)

(concurrent.futures 中的类)

FutureWarning

fwalk() (在 os 模块中)

G

G.722

gaierror

gamma() (在 math 模块中)

gammavariate() (在 random 模块中)

garbage collection

garbage collection -- 垃圾回收

garbage() (在 gc 模块中)

gather() (curses.textpad.Textbox 方法)

(在 asyncio 模块中)

gauss() (在 random 模块中)

gc

模块

gc_collect() (在 test.support 模块中)

gcd() (在 math 模块中)

ge() (在 operator 模块中)

gen_lib_options() (在 distutils.ccompiler 模块中)

gen_preprocess_options() (在 distutils.ccompiler 模块中)

GEN_START (opcode)

gen_uuid() (在 msilib 模块中)

generate_help() (distutils.fancy_getopt.FancyGetopt 方法)

generate_tokens() (在 tokenize 模块中)

generator

expression

function, [1], [2]

iterator, [1]

对象, [1], [2]

Generator (collections.abc 中的类)

(email.generator 中的类)

(typing 中的类)

generator -- 生成器

generator expression

generator expression -- 生成器表达式

generator iterator -- 生成器迭代器

GeneratorExit

例外, [1]

GeneratorExp (ast 中的类)

GeneratorType() (在 types 模块中)

Generic

Alias

generic

special attribute

Generic (typing 中的类)

generic function -- 泛型函数

generic type -- 泛型

generic_visit() (ast.NodeVisitor 方法)

GenericAlias

对象

GenericAlias (types 中的类)

genops() (在 pickletools 模块中)

geometric_mean() (在 statistics 模块中)

get() (asyncio.Queue 方法)

(configparser.ConfigParser 方法)

(contextvars.Context 方法)

(contextvars.ContextVar 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(multiprocessing.pool.AsyncResult 方法)

(multiprocessing.Queue 方法)

(multiprocessing.SimpleQueue 方法)

(ossaudiodev.oss_mixer_device 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

(tkinter.ttk.Combobox 方法)

(tkinter.ttk.Spinbox 方法)

(types.MappingProxyType 方法)

(xml.etree.ElementTree.Element 方法)

(在 webbrowser 模块中)

GET_AITER (opcode)

get_all() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(wsgiref.headers.Headers 方法)

get_all_breaks() (bdb.Bdb 方法)

get_all_start_methods() (在 multiprocessing 模块中)

GET_ANEXT (opcode)

get_annotations() (在 inspect 模块中)

get_app() (wsgiref.simple_server.WSGIServer 方法)

get_archive_formats() (在 shutil 模块中)

get_args() (在 typing 模块中)

get_asyncgen_hooks() (在 sys 模块中)

get_attribute() (在 test.support 模块中)

GET_AWAITABLE (opcode)

get_begidx() (在 readline 模块中)

get_blocking() (在 os 模块中)

get_body() (email.message.EmailMessage 方法)

get_body_encoding() (email.charset.Charset 方法)

get_boundary() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_bpbynumber() (bdb.Bdb 方法)

get_break() (bdb.Bdb 方法)

get_breaks() (bdb.Bdb 方法)

get_buffer() (asyncio.BufferedProtocol 方法)

(xdrlib.Packer 方法)

(xdrlib.Unpacker 方法)

get_bytes() (mailbox.Mailbox 方法)

get_ca_certs() (ssl.SSLContext 方法)

get_cache_token() (在 abc 模块中)

get_channel_binding() (ssl.SSLSocket 方法)

get_charset() (email.message.Message 方法)

get_charsets() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_child_watcher() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

get_children() (symtable.SymbolTable 方法)

(tkinter.ttk.Treeview 方法)

get_ciphers() (ssl.SSLContext 方法)

get_clock_info() (在 time 模块中)

get_close_matches() (在 difflib 模块中)

get_code() (importlib.abc.InspectLoader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

get_completer() (在 readline 模块中)

get_completer_delims() (在 readline 模块中)

get_completion_type() (在 readline 模块中)

get_config_h_filename() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_config_var() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_config_vars() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_content() (email.contentmanager.ContentManager 方法)

(email.message.EmailMessage 方法)

(在 email.contentmanager 模块中)

get_content_charset() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_disposition() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_maintype() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_subtype() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_content_type() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_context() (在 multiprocessing 模块中)

get_coro() (asyncio.Task 方法)

get_coroutine_origin_tracking_depth() (在 sys 模块中)

get_count() (在 gc 模块中)

get_current_history_length() (在 readline 模块中)

get_data() (importlib.abc.FileLoader 方法)

(importlib.abc.ResourceLoader 方法)

(zipimport.zipimporter 方法)

(在 pkgutil 模块中)

get_date() (mailbox.MaildirMessage 方法)

get_debug() (asyncio.loop 方法)

(在 gc 模块中)

get_default() (argparse.ArgumentParser 方法)

get_default_compiler() (在 distutils.ccompiler 模块中)

get_default_domain() (在 nis 模块中)

get_default_scheme() (在 sysconfig 模块中)

get_default_type() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_default_verify_paths() (在 ssl 模块中)

get_dialect() (在 csv 模块中)

get_disassembly_as_string() (test.support.bytecode_helper.BytecodeTestCase 方法)

get_docstring() (在 ast 模块中)

get_doctest() (doctest.DocTestParser 方法)

get_endidx() (在 readline 模块中)

get_environ() (wsgiref.simple_server.WSGIRequestHandler 方法)

get_errno() (在 ctypes 模块中)

get_escdelay() (在 curses 模块中)

get_event_loop() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

get_event_loop_policy() (在 asyncio 模块中)

get_examples() (doctest.DocTestParser 方法)

get_exception_handler() (asyncio.loop 方法)

get_exec_path() (在 os 模块中)

get_extra_info() (asyncio.BaseTransport 方法)

(asyncio.StreamWriter 方法)

get_field() (string.Formatter 方法)

get_file() (mailbox.Babyl 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.mbox 方法)

(mailbox.MH 方法)

(mailbox.MMDF 方法)

get_file_breaks() (bdb.Bdb 方法)

get_filename() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(importlib.abc.ExecutionLoader 方法)

(importlib.abc.FileLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(zipimport.zipimporter 方法)

get_filter() (tkinter.filedialog.FileDialog 方法)

get_flags() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

get_folder() (mailbox.Maildir 方法)

(mailbox.MH 方法)

get_frees() (symtable.Function 方法)

get_freeze_count() (在 gc 模块中)

get_from() (mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

get_full_url() (urllib.request.Request 方法)

get_globals() (symtable.Function 方法)

get_grouped_opcodes() (difflib.SequenceMatcher 方法)

get_handle_inheritable() (在 os 模块中)

get_header() (urllib.request.Request 方法)

get_history_item() (在 readline 模块中)

get_history_length() (在 readline 模块中)

get_id() (symtable.SymbolTable 方法)

get_ident() (在 _thread 模块中)

(在 threading 模块中)

get_identifiers() (symtable.SymbolTable 方法)

get_importer() (在 pkgutil 模块中)

get_info() (mailbox.MaildirMessage 方法)

get_inheritable() (socket.socket 方法)

(在 os 模块中)

get_instructions() (在 dis 模块中)

get_int_max_str_digits() (在 sys 模块中)

get_interpreter() (在 zipapp 模块中)

GET_ITER (opcode)

get_key() (selectors.BaseSelector 方法)

get_labels() (mailbox.Babyl 方法)

(mailbox.BabylMessage 方法)

get_last_error() (在 ctypes 模块中)

GET_LEN (opcode)

get_line_buffer() (在 readline 模块中)

get_lineno() (symtable.SymbolTable 方法)

get_loader() (在 pkgutil 模块中)

get_locals() (symtable.Function 方法)

get_logger() (在 multiprocessing 模块中)

get_loop() (asyncio.Future 方法)

(asyncio.Server 方法)

get_magic() (在 imp 模块中)

get_makefile_filename() (在 distutils.sysconfig 模块中)

(在 sysconfig 模块中)

get_map() (selectors.BaseSelector 方法)

get_matching_blocks() (difflib.SequenceMatcher 方法)

get_message() (mailbox.Mailbox 方法)

get_method() (urllib.request.Request 方法)

get_methods() (symtable.Class 方法)

get_mixed_type_key() (在 ipaddress 模块中)

get_name() (asyncio.Task 方法)

(symtable.Symbol 方法)

(symtable.SymbolTable 方法)

get_namespace() (symtable.Symbol 方法)

get_namespaces() (symtable.Symbol 方法)

get_native_id() (在 _thread 模块中)

(在 threading 模块中)

get_nonlocals() (symtable.Function 方法)

get_nonstandard_attr() (http.cookiejar.Cookie 方法)

get_nowait() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

get_object_traceback() (在 tracemalloc 模块中)

get_objects() (在 gc 模块中)

get_opcodes() (difflib.SequenceMatcher 方法)

get_option() (optparse.OptionParser 方法)

get_option_group() (optparse.OptionParser 方法)

get_option_order() (distutils.fancy_getopt.FancyGetopt 方法)

get_origin() (在 typing 模块中)

get_original_stdout() (在 test.support 模块中)

get_osfhandle() (在 msvcrt 模块中)

get_output_charset() (email.charset.Charset 方法)

get_param() (email.message.Message 方法)

get_parameters() (symtable.Function 方法)

get_params() (email.message.Message 方法)

get_path() (在 sysconfig 模块中)

get_path_names() (在 sysconfig 模块中)

get_paths() (在 sysconfig 模块中)

get_payload() (email.message.Message 方法)

get_pid() (asyncio.SubprocessTransport 方法)

get_pipe_transport() (asyncio.SubprocessTransport 方法)

get_platform() (在 distutils.util 模块中)

(在 sysconfig 模块中)

get_poly() (在 turtle 模块中)

get_position() (xdrlib.Unpacker 方法)

get_preferred_scheme() (在 sysconfig 模块中)

get_protocol() (asyncio.BaseTransport 方法)

get_python_inc() (在 distutils.sysconfig 模块中)

get_python_lib() (在 distutils.sysconfig 模块中)

get_python_version() (在 sysconfig 模块中)

get_ready() (graphlib.TopologicalSorter 方法)

get_recsrc() (ossaudiodev.oss_mixer_device 方法)

get_referents() (在 gc 模块中)

get_referrers() (在 gc 模块中)

get_request() (socketserver.BaseServer 方法)

get_returncode() (asyncio.SubprocessTransport 方法)

get_running_loop() (在 asyncio 模块中)

get_scheme() (wsgiref.handlers.BaseHandler 方法)

get_scheme_names() (在 sysconfig 模块中)

get_selection() (tkinter.filedialog.FileDialog 方法)

get_sequences() (mailbox.MH 方法)

(mailbox.MHMessage 方法)

get_server() (multiprocessing.managers.BaseManager 方法)

get_server_certificate() (在 ssl 模块中)

get_shapepoly() (在 turtle 模块中)

get_socket() (telnetlib.Telnet 方法)

get_source() (importlib.abc.InspectLoader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

get_source_segment() (在 ast 模块中)

get_special_folder_path()

內置函数

get_stack() (asyncio.Task 方法)

(bdb.Bdb 方法)

get_start_method() (在 multiprocessing 模块中)

get_starttag_text() (html.parser.HTMLParser 方法)

get_stats() (在 gc 模块中)

get_stats_profile() (pstats.Stats 方法)

get_stderr() (wsgiref.handlers.BaseHandler 方法)

(wsgiref.simple_server.WSGIRequestHandler 方法)

get_stdin() (wsgiref.handlers.BaseHandler 方法)

get_string() (mailbox.Mailbox 方法)

get_subdir() (mailbox.MaildirMessage 方法)

get_suffixes() (在 imp 模块中)

get_symbols() (symtable.SymbolTable 方法)

get_tabsize() (在 curses 模块中)

get_tag() (在 imp 模块中)

get_task_factory() (asyncio.loop 方法)

get_terminal_size() (在 os 模块中)

(在 shutil 模块中)

get_terminator() (asynchat.async_chat 方法)

get_threshold() (在 gc 模块中)

get_token() (shlex.shlex 方法)

get_traceback_limit() (在 tracemalloc 模块中)

get_traced_memory() (在 tracemalloc 模块中)

get_tracemalloc_memory() (在 tracemalloc 模块中)

get_type() (symtable.SymbolTable 方法)

get_type_hints() (在 typing 模块中)

get_unixfrom() (email.message.EmailMessage 方法)

(email.message.Message 方法)

get_unpack_formats() (在 shutil 模块中)

get_usage() (optparse.OptionParser 方法)

get_value() (string.Formatter 方法)

get_version() (optparse.OptionParser 方法)

get_visible() (mailbox.BabylMessage 方法)

get_wch() (curses.window 方法)

get_write_buffer_limits() (asyncio.WriteTransport 方法)

get_write_buffer_size() (asyncio.WriteTransport 方法)

GET_YIELD_FROM_ITER (opcode)

getacl() (imaplib.IMAP4 方法)

getaddresses() (在 email.utils 模块中)

getaddrinfo() (asyncio.loop 方法)

(在 socket 模块中)

getallocatedblocks() (在 sys 模块中)

getandroidapilevel() (在 sys 模块中)

getannotation() (imaplib.IMAP4 方法)

getargspec() (在 inspect 模块中)

getargvalues() (在 inspect 模块中)

getatime() (在 os.path 模块中)

getattr()

內置函数

getattr_static() (在 inspect 模块中)

getattrfunc (C type)

getAttribute() (xml.dom.Element 方法)

getAttributeNode() (xml.dom.Element 方法)

getAttributeNodeNS() (xml.dom.Element 方法)

getAttributeNS() (xml.dom.Element 方法)

getattrofunc (C type)

GetBase() (xml.parsers.expat.xmlparser 方法)

getbegyx() (curses.window 方法)

getbkgd() (curses.window 方法)

getblocking() (socket.socket 方法)

getboolean() (configparser.ConfigParser 方法)

getbuffer() (io.BytesIO 方法)

getbufferproc (C type)

getByteStream() (xml.sax.xmlreader.InputSource 方法)

getcallargs() (在 inspect 模块中)

getcanvas() (在 turtle 模块中)

getcapabilities() (nntplib.NNTP 方法)

getcaps() (在 mailcap 模块中)

getch() (curses.window 方法)

(在 msvcrt 模块中)

getCharacterStream() (xml.sax.xmlreader.InputSource 方法)

getche() (在 msvcrt 模块中)

getChild() (logging.Logger 方法)

getclasstree() (在 inspect 模块中)

getclosurevars() (在 inspect 模块中)

getcode() (http.client.HTTPResponse 方法)

(urllib.response.addinfourl 方法)

GetColumnInfo() (msilib.View 方法)

getColumnNumber() (xml.sax.xmlreader.Locator 方法)

getcomments() (在 inspect 模块中)

getcompname() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getcomptype() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getContentHandler() (xml.sax.xmlreader.XMLReader 方法)

getcontext() (在 decimal 模块中)

getcoroutinelocals() (在 inspect 模块中)

getcoroutinestate() (在 inspect 模块中)

getctime() (在 os.path 模块中)

getcwd() (在 os 模块中)

getcwdb() (在 os 模块中)

getcwdu (2to3 fixer)

getdecoder() (在 codecs 模块中)

getdefaultencoding() (在 sys 模块中)

getdefaultlocale() (在 locale 模块中)

getdefaulttimeout() (在 socket 模块中)

getdlopenflags() (在 sys 模块中)

getdoc() (在 inspect 模块中)

getDOMImplementation() (在 xml.dom 模块中)

getDTDHandler() (xml.sax.xmlreader.XMLReader 方法)

getEffectiveLevel() (logging.Logger 方法)

getegid() (在 os 模块中)

getElementsByTagName() (xml.dom.Document 方法)

(xml.dom.Element 方法)

getElementsByTagNameNS() (xml.dom.Document 方法)

(xml.dom.Element 方法)

getencoder() (在 codecs 模块中)

getEncoding() (xml.sax.xmlreader.InputSource 方法)

getEntityResolver() (xml.sax.xmlreader.XMLReader 方法)

getenv() (在 os 模块中)

getenvb() (在 os 模块中)

getErrorHandler() (xml.sax.xmlreader.XMLReader 方法)

geteuid() (在 os 模块中)

getEvent() (xml.dom.pulldom.DOMEventStream 方法)

getEventCategory() (logging.handlers.NTEventLogHandler 方法)

getEventType() (logging.handlers.NTEventLogHandler 方法)

getException() (xml.sax.SAXException 方法)

getFeature() (xml.sax.xmlreader.XMLReader 方法)

GetFieldCount() (msilib.Record 方法)

getfile() (在 inspect 模块中)

getFilesToDelete() (logging.handlers.TimedRotatingFileHandler 方法)

getfilesystemencodeerrors() (在 sys 模块中)

getfilesystemencoding() (在 sys 模块中)

getfirst() (cgi.FieldStorage 方法)

getfloat() (configparser.ConfigParser 方法)

getfmts() (ossaudiodev.oss_audio_device 方法)

getfqdn() (在 socket 模块中)

getframeinfo() (在 inspect 模块中)

getframerate() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getfullargspec() (在 inspect 模块中)

getgeneratorlocals() (在 inspect 模块中)

getgeneratorstate() (在 inspect 模块中)

getgid() (在 os 模块中)

getgrall() (在 grp 模块中)

getgrgid() (在 grp 模块中)

getgrnam() (在 grp 模块中)

getgrouplist() (在 os 模块中)

getgroups() (在 os 模块中)

getheader() (http.client.HTTPResponse 方法)

getheaders() (http.client.HTTPResponse 方法)

gethostbyaddr() (in module socket)

(在 socket 模块中)

gethostbyname() (在 socket 模块中)

gethostbyname_ex() (在 socket 模块中)

gethostname() (in module socket)

(在 socket 模块中)

getincrementaldecoder() (在 codecs 模块中)

getincrementalencoder() (在 codecs 模块中)

getinfo() (zipfile.ZipFile 方法)

getinnerframes() (在 inspect 模块中)

GetInputContext() (xml.parsers.expat.xmlparser 方法)

getint() (configparser.ConfigParser 方法)

GetInteger() (msilib.Record 方法)

getitem() (在 operator 模块中)

getiterfunc (C type)

getitimer() (在 signal 模块中)

getkey() (curses.window 方法)

GetLastError() (在 ctypes 模块中)

getLength() (xml.sax.xmlreader.Attributes 方法)

getLevelName() (在 logging 模块中)

getline() (在 linecache 模块中)

getLineNumber() (xml.sax.xmlreader.Locator 方法)

getlist() (cgi.FieldStorage 方法)

getloadavg() (在 os 模块中)

getlocale() (在 locale 模块中)

getLogger() (在 logging 模块中)

getLoggerClass() (在 logging 模块中)

getlogin() (在 os 模块中)

getLogRecordFactory() (在 logging 模块中)

getmark() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getmarkers() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getmaxyx() (curses.window 方法)

getmember() (tarfile.TarFile 方法)

getmembers() (tarfile.TarFile 方法)

(在 inspect 模块中)

getMessage() (logging.LogRecord 方法)

(xml.sax.SAXException 方法)

getMessageID() (logging.handlers.NTEventLogHandler 方法)

getmodule() (在 inspect 模块中)

getmodulename() (在 inspect 模块中)

getmouse() (在 curses 模块中)

getmro() (在 inspect 模块中)

getmtime() (在 os.path 模块中)

getname() (chunk.Chunk 方法)

getName() (threading.Thread 方法)

getNameByQName() (xml.sax.xmlreader.AttributesNS 方法)

getnameinfo() (asyncio.loop 方法)

(在 socket 模块中)

getnames() (tarfile.TarFile 方法)

getNames() (xml.sax.xmlreader.Attributes 方法)

getnchannels() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getnframes() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getnode

getnode() (在 uuid 模块中)

getopt

模块

getopt() (distutils.fancy_getopt.FancyGetopt 方法)

(在 getopt 模块中)

GetoptError

getouterframes() (在 inspect 模块中)

getoutput() (在 subprocess 模块中)

getpagesize() (在 resource 模块中)

getparams() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getparyx() (curses.window 方法)

getpass

模块

getpass() (在 getpass 模块中)

GetPassWarning

getpeercert() (ssl.SSLSocket 方法)

getpeername() (socket.socket 方法)

getpen() (在 turtle 模块中)

getpgid() (在 os 模块中)

getpgrp() (在 os 模块中)

getpid() (在 os 模块中)

getpos() (html.parser.HTMLParser 方法)

getppid() (在 os 模块中)

getpreferredencoding() (在 locale 模块中)

getpriority() (在 os 模块中)

getprofile() (在 sys 模块中)

(在 threading 模块中)

GetProperty() (msilib.SummaryInformation 方法)

getProperty() (xml.sax.xmlreader.XMLReader 方法)

GetPropertyCount() (msilib.SummaryInformation 方法)

getprotobyname() (在 socket 模块中)

getproxies() (在 urllib.request 模块中)

getPublicId() (xml.sax.xmlreader.InputSource 方法)

(xml.sax.xmlreader.Locator 方法)

getpwall() (在 pwd 模块中)

getpwnam() (在 pwd 模块中)

getpwuid() (在 pwd 模块中)

getQNameByName() (xml.sax.xmlreader.AttributesNS 方法)

getQNames() (xml.sax.xmlreader.AttributesNS 方法)

getquota() (imaplib.IMAP4 方法)

getquotaroot() (imaplib.IMAP4 方法)

getrandbits() (在 random 模块中)

getrandom() (在 os 模块中)

getreader() (在 codecs 模块中)

getrecursionlimit() (在 sys 模块中)

getrefcount() (在 sys 模块中)

GetReparseDeferralEnabled() (xml.parsers.expat.xmlparser 方法)

getresgid() (在 os 模块中)

getresponse() (http.client.HTTPConnection 方法)

getresuid() (在 os 模块中)

getrlimit() (在 resource 模块中)

getroot() (xml.etree.ElementTree.ElementTree 方法)

getrusage() (在 resource 模块中)

getsample() (在 audioop 模块中)

getsampwidth() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

getscreen() (在 turtle 模块中)

getservbyname() (在 socket 模块中)

getservbyport() (在 socket 模块中)

GetSetDescriptorType() (在 types 模块中)

getshapes() (在 turtle 模块中)

getsid() (在 os 模块中)

getsignal() (在 signal 模块中)

getsitepackages() (在 site 模块中)

getsize() (chunk.Chunk 方法)

(在 os.path 模块中)

getsizeof() (在 sys 模块中)

getsockname() (socket.socket 方法)

getsockopt() (socket.socket 方法)

getsource() (在 inspect 模块中)

getsourcefile() (在 inspect 模块中)

getsourcelines() (在 inspect 模块中)

getspall() (在 spwd 模块中)

getspnam() (在 spwd 模块中)

getstate() (codecs.IncrementalDecoder 方法)

(codecs.IncrementalEncoder 方法)

(在 random 模块中)

getstatusoutput() (在 subprocess 模块中)

getstr() (curses.window 方法)

GetString() (msilib.Record 方法)

getSubject() (logging.handlers.SMTPHandler 方法)

GetSummaryInformation() (msilib.Database 方法)

getswitchinterval() (在 sys 模块中)

getSystemId() (xml.sax.xmlreader.InputSource 方法)

(xml.sax.xmlreader.Locator 方法)

getsyx() (在 curses 模块中)

gettarinfo() (tarfile.TarFile 方法)

gettempdir() (在 tempfile 模块中)

gettempdirb() (在 tempfile 模块中)

gettempprefix() (在 tempfile 模块中)

gettempprefixb() (在 tempfile 模块中)

getTestCaseNames() (unittest.TestLoader 方法)

gettext

模块

gettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

(在 locale 模块中)

gettimeout() (socket.socket 方法)

gettrace() (在 sys 模块中)

(在 threading 模块中)

getturtle() (在 turtle 模块中)

getType() (xml.sax.xmlreader.Attributes 方法)

getuid() (在 os 模块中)

geturl() (http.client.HTTPResponse 方法)

(urllib.parse.urllib.parse.SplitResult 方法)

(urllib.response.addinfourl 方法)

getuser() (在 getpass 模块中)

getuserbase() (在 site 模块中)

getusersitepackages() (在 site 模块中)

getvalue() (io.BytesIO 方法)

(io.StringIO 方法)

getValue() (xml.sax.xmlreader.Attributes 方法)

getValueByQName() (xml.sax.xmlreader.AttributesNS 方法)

getwch() (在 msvcrt 模块中)

getwche() (在 msvcrt 模块中)

getweakrefcount() (在 weakref 模块中)

getweakrefs() (在 weakref 模块中)

getwelcome() (ftplib.FTP 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

getwin() (在 curses 模块中)

getwindowsversion() (在 sys 模块中)

getwriter() (在 codecs 模块中)

getxattr() (在 os 模块中)

getyx() (curses.window 方法)

gid (tarfile.TarInfo 属性)

GIL

glob

模块, [1]

glob() (msilib.Directory 方法)

(pathlib.Path 方法)

(在 glob 模块中)

global

name binding

namespace

语句, [1]

Global (ast 中的类)

global interpreter lock

global interpreter lock -- 全局解释器锁

globals()

內置函数

globs (doctest.DocTest 属性)

gmtime() (在 time 模块中)

gname (tarfile.TarInfo 属性)

GNOME

GNU_FORMAT() (在 tarfile 模块中)

gnu_getopt() (在 getopt 模块中)

GNUTranslations (gettext 中的类)

go() (tkinter.filedialog.FileDialog 方法)

got (doctest.DocTestFailure 属性)

goto() (在 turtle 模块中)

grammar

Graphical User Interface

graphlib

模块

GREATER() (在 token 模块中)

GREATEREQUAL() (在 token 模块中)

Greenwich Mean Time

GRND_NONBLOCK() (在 os 模块中)

GRND_RANDOM() (在 os 模块中)

Group (email.headerregistry 中的类)

group() (nntplib.NNTP 方法)

(pathlib.Path 方法)

(re.Match 方法)

groupby() (在 itertools 模块中)

groupdict() (re.Match 方法)

groupindex (re.Pattern 属性)

grouping

groups (email.headerregistry.AddressHeader 属性)

(re.Pattern 属性)

groups() (re.Match 方法)

grp

模块

Gt (ast 中的类)

gt() (在 operator 模块中)

GtE (ast 中的类)

guard

guess_all_extensions() (mimetypes.MimeTypes 方法)

(在 mimetypes 模块中)

guess_extension() (mimetypes.MimeTypes 方法)

(在 mimetypes 模块中)

guess_scheme() (在 wsgiref.util 模块中)

guess_type() (mimetypes.MimeTypes 方法)

(在 mimetypes 模块中)

GUI

gzip

模块

gzip command line option

--best

--decompress

--fast

--help

-d

-h

file

GzipFile (gzip 中的类)

H

halfdelay() (在 curses 模块中)

Handle (asyncio 中的类)

handle an exception

handle() (http.server.BaseHTTPRequestHandler 方法)

(logging.Handler 方法)

(logging.handlers.QueueListener 方法)

(logging.Logger 方法)

(logging.NullHandler 方法)

(socketserver.BaseRequestHandler 方法)

(wsgiref.simple_server.WSGIRequestHandler 方法)

handle_accept() (asyncore.dispatcher 方法)

handle_accepted() (asyncore.dispatcher 方法)

handle_charref() (html.parser.HTMLParser 方法)

handle_close() (asyncore.dispatcher 方法)

handle_comment() (html.parser.HTMLParser 方法)

handle_connect() (asyncore.dispatcher 方法)

handle_data() (html.parser.HTMLParser 方法)

handle_decl() (html.parser.HTMLParser 方法)

handle_defect() (email.policy.Policy 方法)

handle_endtag() (html.parser.HTMLParser 方法)

handle_entityref() (html.parser.HTMLParser 方法)

handle_error() (asyncore.dispatcher 方法)

(socketserver.BaseServer 方法)

handle_expect_100() (http.server.BaseHTTPRequestHandler 方法)

handle_expt() (asyncore.dispatcher 方法)

handle_one_request() (http.server.BaseHTTPRequestHandler 方法)

handle_pi() (html.parser.HTMLParser 方法)

handle_read() (asyncore.dispatcher 方法)

handle_request() (socketserver.BaseServer 方法)

(xmlrpc.server.CGIXMLRPCRequestHandler 方法)

handle_startendtag() (html.parser.HTMLParser 方法)

handle_starttag() (html.parser.HTMLParser 方法)

handle_timeout() (socketserver.BaseServer 方法)

handle_write() (asyncore.dispatcher 方法)

handleError() (logging.Handler 方法)

(logging.handlers.SocketHandler 方法)

handler

exception

Handler (logging 中的类)

handler() (在 cgitb 模块中)

hardlink_to() (pathlib.Path 方法)

harmonic_mean() (在 statistics 模块中)

HAS_ALPN() (在 ssl 模块中)

has_children() (symtable.SymbolTable 方法)

has_colors() (在 curses 模块中)

has_dualstack_ipv6() (在 socket 模块中)

HAS_ECDH() (在 ssl 模块中)

has_extended_color_support() (在 curses 模块中)

has_extn() (smtplib.SMTP 方法)

has_function() (distutils.ccompiler.CCompiler 方法)

has_header() (csv.Sniffer 方法)

(urllib.request.Request 方法)

has_ic() (在 curses 模块中)

has_il() (在 curses 模块中)

has_ipv6() (在 socket 模块中)

has_key (2to3 fixer)

has_key() (在 curses 模块中)

has_location (importlib.machinery.ModuleSpec 属性)

HAS_NEVER_CHECK_COMMON_NAME() (在 ssl 模块中)

has_nonstandard_attr() (http.cookiejar.Cookie 方法)

HAS_NPN() (在 ssl 模块中)

has_option() (configparser.ConfigParser 方法)

(optparse.OptionParser 方法)

has_section() (configparser.ConfigParser 方法)

HAS_SNI() (在 ssl 模块中)

HAS_SSLv2() (在 ssl 模块中)

HAS_SSLv3() (在 ssl 模块中)

has_ticket (ssl.SSLSession 属性)

HAS_TLSv1() (在 ssl 模块中)

HAS_TLSv1_1() (在 ssl 模块中)

HAS_TLSv1_2() (在 ssl 模块中)

HAS_TLSv1_3() (在 ssl 模块中)

hasattr()

內置函数

hasAttribute() (xml.dom.Element 方法)

hasAttributeNS() (xml.dom.Element 方法)

hasAttributes() (xml.dom.Node 方法)

hasChildNodes() (xml.dom.Node 方法)

hascompare() (在 dis 模块中)

hasconst() (在 dis 模块中)

hasFeature() (xml.dom.DOMImplementation 方法)

hasfree() (在 dis 模块中)

hash

內置函数, [1], [2], [3]

hash character

hash()

內置函数

hash-based pyc -- 基于哈希的 pyc

hash.block_size() (在 hashlib 模块中)

hash.digest_size() (在 hashlib 模块中)

hash_info() (在 sys 模块中)

hashable

Hashable (collections.abc 中的类)

(typing 中的类)

hashable -- 可哈希

hasHandlers() (logging.Logger 方法)

hashfunc (C type)

hashlib

模块

hasjabs() (在 dis 模块中)

hasjrel() (在 dis 模块中)

haslocal() (在 dis 模块中)

hasname() (在 dis 模块中)

HAVE_ARGUMENT (opcode)

HAVE_CONTEXTVAR() (在 decimal 模块中)

HAVE_DOCSTRINGS() (在 test.support 模块中)

HAVE_THREADS() (在 decimal 模块中)

HCI_DATA_DIR() (在 socket 模块中)

HCI_FILTER() (在 socket 模块中)

HCI_TIME_STAMP() (在 socket 模块中)

head() (nntplib.NNTP 方法)

Header (email.header 中的类)

header_encode() (email.charset.Charset 方法)

header_encode_lines() (email.charset.Charset 方法)

header_encoding (email.charset.Charset 属性)

header_factory (email.policy.EmailPolicy 属性)

header_fetch_parse() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

header_items() (urllib.request.Request 方法)

header_max_count() (email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

header_offset (zipfile.ZipInfo 属性)

header_source_parse() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

header_store_parse() (email.policy.Compat32 方法)

(email.policy.EmailPolicy 方法)

(email.policy.Policy 方法)

HeaderError

HeaderParseError

HeaderParser (email.parser 中的类)

HeaderRegistry (email.headerregistry 中的类)

headers

MIME, [1]

headers (http.client.HTTPResponse 属性)

(http.server.BaseHTTPRequestHandler 属性)

(urllib.error.HTTPError 属性)

(urllib.response.addinfourl 属性)

Headers (wsgiref.headers 中的类)

headers (xmlrpc.client.ProtocolError 属性)

HeaderWriteError

heading() (tkinter.ttk.Treeview 方法)

(在 turtle 模块中)

heapify() (在 heapq 模块中)

heapmin() (在 msvcrt 模块中)

heappop() (在 heapq 模块中)

heappush() (在 heapq 模块中)

heappushpop() (在 heapq 模块中)

heapq

模块

heapreplace() (在 heapq 模块中)

helo() (smtplib.SMTP 方法)

help

online

內置函数

help (optparse.Option 属性)

(pdb command)

help()

內置函数

help() (nntplib.NNTP 方法)

herror

hex (uuid.UUID 属性)

hex()

內置函数

hex() (bytearray 方法)

(bytes 方法)

(float 方法)

(memoryview 方法)

hexadecimal

literals

hexadecimal literal

hexbin() (在 binhex 模块中)

hexdigest() (hashlib.hash 方法)

(hashlib.shake 方法)

(hmac.HMAC 方法)

hexdigits() (在 string 模块中)

hexlify() (在 binascii 模块中)

hexversion() (在 sys 模块中)

hidden() (curses.panel.Panel 方法)

hide() (curses.panel.Panel 方法)

(tkinter.ttk.Notebook 方法)

hide_cookie2 (http.cookiejar.CookiePolicy 属性)

hideturtle() (在 turtle 模块中)

hierarchy

type

HierarchyRequestErr

HIGH_PRIORITY_CLASS() (在 subprocess 模块中)

HIGHEST_PROTOCOL() (在 pickle 模块中)

hits (bdb.Breakpoint 属性)

HKEY_CLASSES_ROOT() (在 winreg 模块中)

HKEY_CURRENT_CONFIG() (在 winreg 模块中)

HKEY_CURRENT_USER() (在 winreg 模块中)

HKEY_DYN_DATA() (在 winreg 模块中)

HKEY_LOCAL_MACHINE() (在 winreg 模块中)

HKEY_PERFORMANCE_DATA() (在 winreg 模块中)

HKEY_USERS() (在 winreg 模块中)

hline() (curses.window 方法)

HList (tkinter.tix 中的类)

hls_to_rgb() (在 colorsys 模块中)

hmac

模块

HOME, [1], [2], [3], [4], [5], [6], [7], [8], [9]

home() (pathlib.Path 类方法)

(在 turtle 模块中)

HOMEDRIVE, [1]

HOMEPATH, [1]

hook_compressed() (在 fileinput 模块中)

hook_encoded() (在 fileinput 模块中)

hooks

import

meta

path

host (urllib.request.Request 属性)

hostmask (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

hostname_checks_common_name (ssl.SSLContext 属性)

hosts (netrc.netrc 属性)

hosts() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

hour (datetime.datetime 属性)

(datetime.time 属性)

HRESULT (ctypes 中的类)

hStdError (subprocess.STARTUPINFO 属性)

hStdInput (subprocess.STARTUPINFO 属性)

hStdOutput (subprocess.STARTUPINFO 属性)

hsv_to_rgb() (在 colorsys 模块中)

ht() (在 turtle 模块中)

HTML, [1]

html

模块

html() (在 cgitb 模块中)

html.entities

模块

html.parser

模块

html5() (在 html.entities 模块中)

HTMLCalendar (calendar 中的类)

HtmlDiff (difflib 中的类)

HTMLParser (html.parser 中的类)

htonl() (在 socket 模块中)

htons() (在 socket 模块中)

HTTP

http (standard module)

http.client (standard module)

protocol, [1], [2], [3], [4], [5]

http

模块

HTTP() (在 email.policy 模块中)

http.client

模块

http.cookiejar

模块

http.cookies

模块

http.server

security

模块

http_error_301() (urllib.request.HTTPRedirectHandler 方法)

http_error_302() (urllib.request.HTTPRedirectHandler 方法)

http_error_303() (urllib.request.HTTPRedirectHandler 方法)

http_error_307() (urllib.request.HTTPRedirectHandler 方法)

http_error_401() (urllib.request.HTTPBasicAuthHandler 方法)

(urllib.request.HTTPDigestAuthHandler 方法)

http_error_407() (urllib.request.ProxyBasicAuthHandler 方法)

(urllib.request.ProxyDigestAuthHandler 方法)

http_error_auth_reqed() (urllib.request.AbstractBasicAuthHandler 方法)

(urllib.request.AbstractDigestAuthHandler 方法)

http_error_default() (urllib.request.BaseHandler 方法)

http_open() (urllib.request.HTTPHandler 方法)

HTTP_PORT() (在 http.client 模块中)

http_proxy, [1], [2]

http_response() (urllib.request.HTTPErrorProcessor 方法)

http_version (wsgiref.handlers.BaseHandler 属性)

HTTPBasicAuthHandler (urllib.request 中的类)

HTTPConnection (http.client 中的类)

HTTPCookieProcessor (urllib.request 中的类)

httpd

HTTPDefaultErrorHandler (urllib.request 中的类)

HTTPDigestAuthHandler (urllib.request 中的类)

HTTPError

HTTPErrorProcessor (urllib.request 中的类)

HTTPException

HTTPHandler (logging.handlers 中的类)

(urllib.request 中的类)

HTTPPasswordMgr (urllib.request 中的类)

HTTPPasswordMgrWithDefaultRealm (urllib.request 中的类)

HTTPPasswordMgrWithPriorAuth (urllib.request 中的类)

HTTPRedirectHandler (urllib.request 中的类)

HTTPResponse (http.client 中的类)

https_open() (urllib.request.HTTPSHandler 方法)

HTTPS_PORT() (在 http.client 模块中)

https_response() (urllib.request.HTTPErrorProcessor 方法)

HTTPSConnection (http.client 中的类)

HTTPServer (http.server 中的类)

HTTPSHandler (urllib.request 中的类)

HTTPStatus (http 中的类)

hypot() (在 math 模块中)

I

I() (在 re 模块中)

I/O control

buffering, [1]

POSIX

tty

UNIX

iadd() (在 operator 模块中)

iand() (在 operator 模块中)

iconcat() (在 operator 模块中)

id

內置函数

id (ssl.SSLSession 属性)

id()

內置函数

id() (unittest.TestCase 方法)

idcok() (curses.window 方法)

ident (select.kevent 属性)

(threading.Thread 属性)

identchars (cmd.Cmd 属性)

identifier, [1]

identify() (tkinter.ttk.Notebook 方法)

(tkinter.ttk.Treeview 方法)

(tkinter.ttk.Widget 方法)

identify_column() (tkinter.ttk.Treeview 方法)

identify_element() (tkinter.ttk.Treeview 方法)

identify_region() (tkinter.ttk.Treeview 方法)

identify_row() (tkinter.ttk.Treeview 方法)

identity

test

identity of an object

idioms (2to3 fixer)

IDLE, [1]

IDLE_PRIORITY_CLASS() (在 subprocess 模块中)

idlelib

模块

IDLESTARTUP

idlok() (curses.window 方法)

if

conditional expression

in comprehensions

关键字

语句, [1]

If (ast 中的类)

if_indextoname() (在 socket 模块中)

if_nameindex() (在 socket 模块中)

if_nametoindex() (在 socket 模块中)

IfExp (ast 中的类)

ifloordiv() (在 operator 模块中)

iglob() (在 glob 模块中)

ignorableWhitespace() (xml.sax.handler.ContentHandler 方法)

ignore

error handler's name

ignore (bdb.Breakpoint 属性)

(pdb command)

ignore_errors() (在 codecs 模块中)

IGNORE_EXCEPTION_DETAIL() (在 doctest 模块中)

ignore_patterns() (在 shutil 模块中)

ignore_warnings() (在 test.support.warnings_helper 模块中)

IGNORECASE() (在 re 模块中)

ihave() (nntplib.NNTP 方法)

IISCGIHandler (wsgiref.handlers 中的类)

ilshift() (在 operator 模块中)

imag (numbers.Complex 属性)

imaginary literal

imap() (multiprocessing.pool.Pool 方法)

IMAP4

protocol

IMAP4 (imaplib 中的类)

IMAP4.abort

IMAP4.error

IMAP4.readonly

IMAP4_SSL

protocol

IMAP4_SSL (imaplib 中的类)

IMAP4_stream

protocol

IMAP4_stream (imaplib 中的类)

imap_unordered() (multiprocessing.pool.Pool 方法)

imaplib

模块

imatmul() (在 operator 模块中)

imghdr

模块

immedok() (curses.window 方法)

immutable

data type

object, [1]

sequence types

对象

immutable -- 不可变对象

immutable object

immutable sequence

对象

immutable types

subclassing

imod() (在 operator 模块中)

imp

模块, [1]

ImpImporter (pkgutil 中的类)

impl_detail() (在 test.support 模块中)

implementation() (在 sys 模块中)

ImpLoader (pkgutil 中的类)

import

hooks

语句, [1], [2], [3], [4]

import (2to3 fixer)

Import (ast 中的类)

import hooks

import machinery

import path -- 导入路径

import_fresh_module() (在 test.support.import_helper 模块中)

IMPORT_FROM (opcode)

import_module() (在 importlib 模块中)

(在 test.support.import_helper 模块中)

IMPORT_NAME (opcode)

IMPORT_STAR (opcode)

importer -- 导入器

ImportError

例外

ImportFrom (ast 中的类)

importing -- 导入

importlib

模块

importlib.abc

模块

importlib.machinery

模块

importlib.metadata

模块

importlib.resources

模块

importlib.util

模块

imports (2to3 fixer)

imports2 (2to3 fixer)

ImportWarning

ImproperConnectionState

imul() (在 operator 模块中)

in

关键字

运算符, [1], [2]

In (ast 中的类)

in_dll() (ctypes._CData 方法)

in_table_a1() (在 stringprep 模块中)

in_table_b1() (在 stringprep 模块中)

in_table_c11() (在 stringprep 模块中)

in_table_c11_c12() (在 stringprep 模块中)

in_table_c12() (在 stringprep 模块中)

in_table_c21() (在 stringprep 模块中)

in_table_c21_c22() (在 stringprep 模块中)

in_table_c22() (在 stringprep 模块中)

in_table_c3() (在 stringprep 模块中)

in_table_c4() (在 stringprep 模块中)

in_table_c5() (在 stringprep 模块中)

in_table_c6() (在 stringprep 模块中)

in_table_c7() (在 stringprep 模块中)

in_table_c8() (在 stringprep 模块中)

in_table_c9() (在 stringprep 模块中)

in_table_d1() (在 stringprep 模块中)

in_table_d2() (在 stringprep 模块中)

in_transaction (sqlite3.Connection 属性)

inch() (curses.window 方法)

inclusive

or

inclusive (tracemalloc.DomainFilter 属性)

(tracemalloc.Filter 属性)

Incomplete

IncompleteRead

IncompleteReadError

incr_item(), [1]

increment_lineno() (在 ast 模块中)

IncrementalDecoder (codecs 中的类)

incrementaldecoder (codecs.CodecInfo 属性)

IncrementalEncoder (codecs 中的类)

incrementalencoder (codecs.CodecInfo 属性)

IncrementalNewlineDecoder (io 中的类)

IncrementalParser (xml.sax.xmlreader 中的类)

indent (doctest.Example 属性)

INDENT token

indent() (在 textwrap 模块中)

INDENT() (在 token 模块中)

indent() (在 xml.etree.ElementTree 模块中)

indentation

IndentationError

index operation

index() (array.array 方法)

(bytearray 方法)

(bytes 方法)

(collections.deque 方法)

(multiprocessing.shared_memory.ShareableList 方法)

(sequence method)

(str 方法)

(tkinter.ttk.Notebook 方法)

(tkinter.ttk.Treeview 方法)

(在 operator 模块中)

IndexError

indexOf() (在 operator 模块中)

IndexSizeErr

indices() (slice 方法)

inet_aton() (在 socket 模块中)

inet_ntoa() (在 socket 模块中)

inet_ntop() (在 socket 模块中)

inet_pton() (在 socket 模块中)

Inexact (decimal 中的类)

inf() (在 cmath 模块中)

(在 math 模块中)

infile

json.tool command line option

infile (shlex.shlex 属性)

Infinity

infj() (在 cmath 模块中)

info() (dis.Bytecode 方法)

(gettext.NullTranslations 方法)

(http.client.HTTPResponse 方法)

(logging.Logger 方法)

(urllib.response.addinfourl 方法)

(在 logging 模块中)

infolist() (zipfile.ZipFile 方法)

inheritance

ini file

init() (在 mimetypes 模块中)

init_color() (在 curses 模块中)

init_database() (在 msilib 模块中)

init_pair() (在 curses 模块中)

inited() (在 mimetypes 模块中)

initgroups() (在 os 模块中)

initial_indent (textwrap.TextWrapper 属性)

initialize_options() (distutils.cmd.Command 方法)

initproc (C type)

initscr() (在 curses 模块中)

inode() (os.DirEntry 方法)

INPLACE_ADD (opcode)

INPLACE_AND (opcode)

INPLACE_FLOOR_DIVIDE (opcode)

INPLACE_LSHIFT (opcode)

INPLACE_MATRIX_MULTIPLY (opcode)

INPLACE_MODULO (opcode)

INPLACE_MULTIPLY (opcode)

INPLACE_OR (opcode)

INPLACE_POWER (opcode)

INPLACE_RSHIFT (opcode)

INPLACE_SUBTRACT (opcode)

INPLACE_TRUE_DIVIDE (opcode)

INPLACE_XOR (opcode)

input

(2to3 fixer)

input()

內置函数

input() (在 fileinput 模块中)

input_charset (email.charset.Charset 属性)

input_codec (email.charset.Charset 属性)

InputOnly (tkinter.tix 中的类)

InputSource (xml.sax.xmlreader 中的类)

inquiry (C type)

insch() (curses.window 方法)

insdelln() (curses.window 方法)

insert() (array.array 方法)

(collections.deque 方法)

(sequence method)

(tkinter.ttk.Notebook 方法)

(tkinter.ttk.Treeview 方法)

(xml.etree.ElementTree.Element 方法)

insert_text() (在 readline 模块中)

insertBefore() (xml.dom.Node 方法)

insertln() (curses.window 方法)

insnstr() (curses.window 方法)

insort() (在 bisect 模块中)

insort_left() (在 bisect 模块中)

insort_right() (在 bisect 模块中)

inspect

模块

inspect command line option

--details

InspectLoader (importlib.abc 中的类)

insstr() (curses.window 方法)

install() (gettext.NullTranslations 方法)

(在 gettext 模块中)

install_opener() (在 urllib.request 模块中)

install_scripts() (venv.EnvBuilder 方法)

installHandler() (在 unittest 模块中)

instance

call, [1]

class

对象, [1], [2]

instancemethod

对象

instate() (tkinter.ttk.Widget 方法)

instr() (curses.window 方法)

instream (shlex.shlex 属性)

Instruction (dis 中的类)

Instruction.arg() (在 dis 模块中)

Instruction.argrepr() (在 dis 模块中)

Instruction.argval() (在 dis 模块中)

Instruction.is_jump_target() (在 dis 模块中)

Instruction.offset() (在 dis 模块中)

Instruction.opcode() (在 dis 模块中)

Instruction.opname() (在 dis 模块中)

Instruction.starts_line() (在 dis 模块中)

int

內置函数, [1], [2]

int (uuid.UUID 属性)

(內置类)

Int2AP() (在 imaplib 模块中)

int_info() (在 sys 模块中)

integer

literals

representation

types, operations on

对象, [1], [2]

integer literal

Integral (numbers 中的类)

Integrated Development Environment

IntegrityError

Intel/DVI ADPCM

IntEnum (enum 中的类)

interact (pdb command)

interact() (code.InteractiveConsole 方法)

(telnetlib.Telnet 方法)

(在 code 模块中)

interactive -- 交互

interactive mode

InteractiveConsole (code 中的类)

InteractiveInterpreter (code 中的类)

InterfaceError

intern (2to3 fixer)

intern() (在 sys 模块中)

internal type

internal_attr (zipfile.ZipInfo 属性)

Internaldate2tuple() (在 imaplib 模块中)

InternalError

internalSubset (xml.dom.DocumentType 属性)

Internet

INTERNET_TIMEOUT() (在 test.support 模块中)

interpolated string literal

interpolation

bytearray (%)

bytes (%)

interpolation, string (%)

InterpolationDepthError

InterpolationError

InterpolationMissingOptionError

InterpolationSyntaxError

interpreted -- 解释型

interpreter

interpreter lock

interpreter prompts

interpreter shutdown -- 解释器关闭

interpreter_requires_environment() (在 test.support.script_helper 模块中)

interrupt() (sqlite3.Connection 方法)

interrupt_main() (在 _thread 模块中)

InterruptedError

intersection() (frozenset 方法)

intersection_update() (frozenset 方法)

IntFlag (enum 中的类)

intro (cmd.Cmd 属性)

InuseAttributeErr

inv() (在 operator 模块中)

inv_cdf() (statistics.NormalDist 方法)

InvalidAccessErr

invalidate_caches() (importlib.abc.MetaPathFinder 方法)

(importlib.abc.PathEntryFinder 方法)

(importlib.machinery.FileFinder 方法)

(importlib.machinery.PathFinder 类方法)

(zipimport.zipimporter 方法)

(在 importlib 模块中)

InvalidCharacterErr

InvalidModificationErr

InvalidOperation (decimal 中的类)

InvalidStateErr

InvalidStateError, [1]

InvalidTZPathWarning

InvalidURL

inversion

Invert (ast 中的类)

invert() (在 operator 模块中)

invocation

io

模块, [1]

IO (typing 中的类)

io.StringIO

对象

IO_REPARSE_TAG_APPEXECLINK() (在 stat 模块中)

IO_REPARSE_TAG_MOUNT_POINT() (在 stat 模块中)

IO_REPARSE_TAG_SYMLINK() (在 stat 模块中)

IOBase (io 中的类)

ioctl() (socket.socket 方法)

(在 fcntl 模块中)

IOCTL_VM_SOCKETS_GET_LOCAL_CID() (在 socket 模块中)

IOError

ior() (在 operator 模块中)

ip (ipaddress.IPv4Interface 属性)

(ipaddress.IPv6Interface 属性)

ip_address() (在 ipaddress 模块中)

ip_interface() (在 ipaddress 模块中)

ip_network() (在 ipaddress 模块中)

ipaddress

模块

ipow() (在 operator 模块中)

ipv4_mapped (ipaddress.IPv6Address 属性)

IPv4Address (ipaddress 中的类)

IPv4Interface (ipaddress 中的类)

IPv4Network (ipaddress 中的类)

IPV6_ENABLED() (在 test.support.socket_helper 模块中)

IPv6Address (ipaddress 中的类)

IPv6Interface (ipaddress 中的类)

IPv6Network (ipaddress 中的类)

irrefutable case block

irshift() (在 operator 模块中)

is

运算符, [1]

Is (ast 中的类)

is not

运算符, [1]

is_() (在 operator 模块中)

is_absolute() (pathlib.PurePath 方法)

is_active() (asyncio.AbstractChildWatcher 方法)

(graphlib.TopologicalSorter 方法)

is_alive() (multiprocessing.Process 方法)

(threading.Thread 方法)

is_android() (在 test.support 模块中)

is_annotated() (symtable.Symbol 方法)

is_assigned() (symtable.Symbol 方法)

is_async (pyclbr.Function 属性)

is_attachment() (email.message.EmailMessage 方法)

is_authenticated() (urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

is_block_device() (pathlib.Path 方法)

is_blocked() (http.cookiejar.DefaultCookiePolicy 方法)

is_canonical() (decimal.Context 方法)

(decimal.Decimal 方法)

is_char_device() (pathlib.Path 方法)

IS_CHARACTER_JUNK() (在 difflib 模块中)

is_check_supported() (在 lzma 模块中)

is_closed() (asyncio.loop 方法)

is_closing() (asyncio.BaseTransport 方法)

(asyncio.StreamWriter 方法)

is_dataclass() (在 dataclasses 模块中)

is_declared_global() (symtable.Symbol 方法)

is_dir() (importlib.abc.Traversable 方法)

(os.DirEntry 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

(zipfile.ZipInfo 方法)

is_enabled() (在 faulthandler 模块中)

is_expired() (http.cookiejar.Cookie 方法)

is_fifo() (pathlib.Path 方法)

is_file() (importlib.abc.Traversable 方法)

(os.DirEntry 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

is_finalized() (在 gc 模块中)

is_finalizing() (在 sys 模块中)

is_finite() (decimal.Context 方法)

(decimal.Decimal 方法)

is_free() (symtable.Symbol 方法)

is_global (ipaddress.IPv4Address 属性)

(ipaddress.IPv6Address 属性)

is_global() (symtable.Symbol 方法)

is_hop_by_hop() (在 wsgiref.util 模块中)

is_imported() (symtable.Symbol 方法)

is_infinite() (decimal.Context 方法)

(decimal.Decimal 方法)

is_integer() (float 方法)

is_jython() (在 test.support 模块中)

IS_LINE_JUNK() (在 difflib 模块中)

is_linetouched() (curses.window 方法)

is_link_local (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_local() (symtable.Symbol 方法)

is_loopback (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_mount() (pathlib.Path 方法)

is_multicast (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_multipart() (email.message.EmailMessage 方法)

(email.message.Message 方法)

is_namespace() (symtable.Symbol 方法)

is_nan() (decimal.Context 方法)

(decimal.Decimal 方法)

is_nested() (symtable.SymbolTable 方法)

is_nonlocal() (symtable.Symbol 方法)

is_normal() (decimal.Context 方法)

(decimal.Decimal 方法)

is_normalized() (在 unicodedata 模块中)

is_not() (在 operator 模块中)

is_not_allowed() (http.cookiejar.DefaultCookiePolicy 方法)

IS_OP (opcode)

is_optimized() (symtable.SymbolTable 方法)

is_package() (importlib.abc.InspectLoader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.ExtensionFileLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

is_parameter() (symtable.Symbol 方法)

is_private (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_python_build() (在 sysconfig 模块中)

is_qnan() (decimal.Context 方法)

(decimal.Decimal 方法)

is_reading() (asyncio.ReadTransport 方法)

is_referenced() (symtable.Symbol 方法)

is_relative_to() (pathlib.PurePath 方法)

is_reserved (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_reserved() (pathlib.PurePath 方法)

is_resource() (importlib.abc.ResourceReader 方法)

(在 importlib.resources 模块中)

is_resource_enabled() (在 test.support 模块中)

is_running() (asyncio.loop 方法)

is_safe (uuid.UUID 属性)

is_serving() (asyncio.Server 方法)

is_set() (asyncio.Event 方法)

(threading.Event 方法)

is_signed() (decimal.Context 方法)

(decimal.Decimal 方法)

is_site_local (ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_skipped_line() (bdb.Bdb 方法)

is_snan() (decimal.Context 方法)

(decimal.Decimal 方法)

is_socket() (pathlib.Path 方法)

is_subnormal() (decimal.Context 方法)

(decimal.Decimal 方法)

is_symlink() (os.DirEntry 方法)

(pathlib.Path 方法)

is_tarfile() (在 tarfile 模块中)

is_term_resized() (在 curses 模块中)

is_tracing() (在 tracemalloc 模块中)

is_tracked() (在 gc 模块中)

is_typeddict() (在 typing 模块中)

is_unspecified (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

is_wintouched() (curses.window 方法)

is_zero() (decimal.Context 方法)

(decimal.Decimal 方法)

is_zipfile() (在 zipfile 模块中)

isabs() (在 os.path 模块中)

isabstract() (在 inspect 模块中)

IsADirectoryError

isalnum() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isalpha() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isascii() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isasyncgen() (在 inspect 模块中)

isasyncgenfunction() (在 inspect 模块中)

isatty() (chunk.Chunk 方法)

(io.IOBase 方法)

(在 os 模块中)

isawaitable() (在 inspect 模块中)

isblank() (在 curses.ascii 模块中)

isblk() (tarfile.TarInfo 方法)

isbuiltin() (在 inspect 模块中)

ischr() (tarfile.TarInfo 方法)

isclass() (在 inspect 模块中)

isclose() (在 cmath 模块中)

(在 math 模块中)

iscntrl() (在 curses.ascii 模块中)

iscode() (在 inspect 模块中)

iscoroutine() (在 asyncio 模块中)

(在 inspect 模块中)

iscoroutinefunction() (在 asyncio 模块中)

(在 inspect 模块中)

isctrl() (在 curses.ascii 模块中)

isDaemon() (threading.Thread 方法)

isdatadescriptor() (在 inspect 模块中)

isdecimal() (str 方法)

isdev() (tarfile.TarInfo 方法)

isdigit() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isdir() (tarfile.TarInfo 方法)

(在 os.path 模块中)

isdisjoint() (frozenset 方法)

isdown() (在 turtle 模块中)

iselement() (在 xml.etree.ElementTree 模块中)

isenabled() (在 gc 模块中)

isEnabledFor() (logging.Logger 方法)

isendwin() (在 curses 模块中)

ISEOF() (在 token 模块中)

isfifo() (tarfile.TarInfo 方法)

isfile() (tarfile.TarInfo 方法)

(在 os.path 模块中)

isfinite() (在 cmath 模块中)

(在 math 模块中)

isfirstline() (在 fileinput 模块中)

isframe() (在 inspect 模块中)

isfunction() (在 inspect 模块中)

isfuture() (在 asyncio 模块中)

isgenerator() (在 inspect 模块中)

isgeneratorfunction() (在 inspect 模块中)

isgetsetdescriptor() (在 inspect 模块中)

isgraph() (在 curses.ascii 模块中)

isidentifier() (str 方法)

isinf() (在 cmath 模块中)

(在 math 模块中)

isinstance (2to3 fixer)

isinstance()

內置函数

iskeyword() (在 keyword 模块中)

isleap() (在 calendar 模块中)

islice() (在 itertools 模块中)

islink() (在 os.path 模块中)

islnk() (tarfile.TarInfo 方法)

islower() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

ismemberdescriptor() (在 inspect 模块中)

ismeta() (在 curses.ascii 模块中)

ismethod() (在 inspect 模块中)

ismethoddescriptor() (在 inspect 模块中)

ismodule() (在 inspect 模块中)

ismount() (在 os.path 模块中)

isnan() (在 cmath 模块中)

(在 math 模块中)

ISNONTERMINAL() (在 token 模块中)

IsNot (ast 中的类)

isnumeric() (str 方法)

isocalendar() (datetime.date 方法)

(datetime.datetime 方法)

isoformat() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

IsolatedAsyncioTestCase (unittest 中的类)

isolation_level (sqlite3.Connection 属性)

isoweekday() (datetime.date 方法)

(datetime.datetime 方法)

isprint() (在 curses.ascii 模块中)

isprintable() (str 方法)

ispunct() (在 curses.ascii 模块中)

isqrt() (在 math 模块中)

isreadable() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

isrecursive() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

isreg() (tarfile.TarInfo 方法)

isReservedKey() (http.cookies.Morsel 方法)

isroutine() (在 inspect 模块中)

isSameNode() (xml.dom.Node 方法)

issoftkeyword() (在 keyword 模块中)

isspace() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isstdin() (在 fileinput 模块中)

issubclass()

內置函数

issubset() (frozenset 方法)

issuperset() (frozenset 方法)

issym() (tarfile.TarInfo 方法)

ISTERMINAL() (在 token 模块中)

istitle() (bytearray 方法)

(bytes 方法)

(str 方法)

istraceback() (在 inspect 模块中)

isub() (在 operator 模块中)

isupper() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 curses.ascii 模块中)

isvisible() (在 turtle 模块中)

isxdigit() (在 curses.ascii 模块中)

ITALIC() (在 tkinter.font 模块中)

item

sequence

string

item selection

item() (tkinter.ttk.Treeview 方法)

(xml.dom.NamedNodeMap 方法)

(xml.dom.NodeList 方法)

itemgetter() (在 operator 模块中)

items() (configparser.ConfigParser 方法)

(contextvars.Context 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(types.MappingProxyType 方法)

(xml.etree.ElementTree.Element 方法)

itemsize (array.array 属性)

(memoryview 属性)

ItemsView (collections.abc 中的类)

(typing 中的类)

iter()

內置函数

iter() (xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

iter_attachments() (email.message.EmailMessage 方法)

iter_child_nodes() (在 ast 模块中)

iter_fields() (在 ast 模块中)

iter_importers() (在 pkgutil 模块中)

iter_modules() (在 pkgutil 模块中)

iter_parts() (email.message.EmailMessage 方法)

iter_unpack() (struct.Struct 方法)

(在 struct 模块中)

iterable

unpacking

Iterable (collections.abc 中的类)

(typing 中的类)

iterable -- 可迭代对象

Iterator (collections.abc 中的类)

(typing 中的类)

iterator -- 迭代器

iterator protocol

iterdecode() (在 codecs 模块中)

iterdir() (importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

iterdump() (sqlite3.Connection 方法)

iterencode() (json.JSONEncoder 方法)

(在 codecs 模块中)

iterfind() (xml.etree.ElementTree.Element 方法)

(xml.etree.ElementTree.ElementTree 方法)

iteritems() (mailbox.Mailbox 方法)

iterkeys() (mailbox.Mailbox 方法)

itermonthdates() (calendar.Calendar 方法)

itermonthdays() (calendar.Calendar 方法)

itermonthdays2() (calendar.Calendar 方法)

itermonthdays3() (calendar.Calendar 方法)

itermonthdays4() (calendar.Calendar 方法)

iternextfunc (C type)

iterparse() (在 xml.etree.ElementTree 模块中)

itertext() (xml.etree.ElementTree.Element 方法)

itertools

模块

itertools (2to3 fixer)

itertools_imports (2to3 fixer)

itervalues() (mailbox.Mailbox 方法)

iterweekdays() (calendar.Calendar 方法)

ITIMER_PROF() (在 signal 模块中)

ITIMER_REAL() (在 signal 模块中)

ITIMER_VIRTUAL() (在 signal 模块中)

ItimerError

itruediv() (在 operator 模块中)

ixor() (在 operator 模块中)

J

j

in numeric literal

Jansen, Jack

Java

language

java_ver() (在 platform 模块中)

join() (asyncio.Queue 方法)

(bytearray 方法)

(bytes 方法)

(multiprocessing.JoinableQueue 方法)

(multiprocessing.pool.Pool 方法)

(multiprocessing.Process 方法)

(queue.Queue 方法)

(str 方法)

(threading.Thread 方法)

(在 os.path 模块中)

(在 shlex 模块中)

join_thread() (multiprocessing.Queue 方法)

(在 test.support.threading_helper 模块中)

JoinableQueue (multiprocessing 中的类)

JoinedStr (ast 中的类)

joinpath() (importlib.abc.Traversable 方法)

(pathlib.PurePath 方法)

(zipfile.Path 方法)

js_output() (http.cookies.BaseCookie 方法)

(http.cookies.Morsel 方法)

json

模块, [1]

json.tool

模块

json.tool command line option

--compact

--help

--indent

--json-lines

--no-ensure-ascii

--no-indent

--sort-keys

--tab

-h

infile

outfile

JSONDecodeError

JSONDecoder (json 中的类)

JSONEncoder (json 中的类)

jump (pdb command)

JUMP_ABSOLUTE (opcode)

JUMP_FORWARD (opcode)

JUMP_IF_FALSE_OR_POP (opcode)

JUMP_IF_NOT_EXC_MATCH (opcode)

JUMP_IF_TRUE_OR_POP (opcode)

K

kbhit() (在 msvcrt 模块中)

KDEDIR

kevent() (在 select 模块中)

key

(http.cookies.Morsel 属性)

(zoneinfo.ZoneInfo 属性)

key function -- 键函数

key/datum pair

KEY_ALL_ACCESS() (在 winreg 模块中)

KEY_CREATE_LINK() (在 winreg 模块中)

KEY_CREATE_SUB_KEY() (在 winreg 模块中)

KEY_ENUMERATE_SUB_KEYS() (在 winreg 模块中)

KEY_EXECUTE() (在 winreg 模块中)

KEY_NOTIFY() (在 winreg 模块中)

KEY_QUERY_VALUE() (在 winreg 模块中)

KEY_READ() (在 winreg 模块中)

KEY_SET_VALUE() (在 winreg 模块中)

KEY_WOW64_32KEY() (在 winreg 模块中)

KEY_WOW64_64KEY() (在 winreg 模块中)

KEY_WRITE() (在 winreg 模块中)

KeyboardInterrupt

(built-in exception), [1], [2]

KeyError

keylog_filename (ssl.SSLContext 属性)

keyname() (在 curses 模块中)

keypad() (curses.window 方法)

keyrefs() (weakref.WeakKeyDictionary 方法)

keys() (contextvars.Context 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(sqlite3.Row 方法)

(types.MappingProxyType 方法)

(xml.etree.ElementTree.Element 方法)

KeysView (collections.abc 中的类)

(typing 中的类)

keyword, [1]

模块

keyword (ast 中的类)

keyword argument -- 关键字参数

keywords (functools.partial 属性)

kill() (asyncio.subprocess.Process 方法)

(asyncio.SubprocessTransport 方法)

(multiprocessing.Process 方法)

(subprocess.Popen 方法)

(在 os 模块中)

kill_python() (在 test.support.script_helper 模块中)

killchar() (在 curses 模块中)

killpg() (在 os 模块中)

kind (inspect.Parameter 属性)

knownfiles() (在 mimetypes 模块中)

kqueue() (在 select 模块中)

KqueueSelector (selectors 中的类)

KW_ONLY() (在 dataclasses 模块中)

kwargs (inspect.BoundArguments 属性)

(typing.ParamSpec 属性)

kwlist() (在 keyword 模块中)

L

L() (在 re 模块中)

LabelEntry (tkinter.tix 中的类)

LabelFrame (tkinter.tix 中的类)

lambda

expression, [1]

form

Lambda (ast 中的类)

LambdaType() (在 types 模块中)

LANG, [1], [2], [3], [4]

LANGUAGE, [1]

language

C, [1], [2], [3], [4]

Java

large files

LARGEST() (在 test.support 模块中)

LargeZipFile

last() (nntplib.NNTP 方法)

last_accepted (multiprocessing.connection.Listener 属性)

last_traceback (in module sys)

last_traceback() (在 sys 模块中)

last_type() (在 sys 模块中)

last_value() (在 sys 模块中)

lastChild (xml.dom.Node 属性)

lastcmd (cmd.Cmd 属性)

lastgroup (re.Match 属性)

lastindex (re.Match 属性)

lastResort() (在 logging 模块中)

lastrowid (sqlite3.Cursor 属性)

layout() (tkinter.ttk.Style 方法)

lazycache() (在 linecache 模块中)

LazyLoader (importlib.util 中的类)

LBRACE() (在 token 模块中)

LBYL

LC_ALL, [1]

LC_ALL() (在 locale 模块中)

LC_COLLATE() (在 locale 模块中)

LC_CTYPE() (在 locale 模块中)

LC_MESSAGES, [1]

LC_MESSAGES() (在 locale 模块中)

LC_MONETARY() (在 locale 模块中)

LC_NUMERIC() (在 locale 模块中)

LC_TIME() (在 locale 模块中)

lchflags() (在 os 模块中)

lchmod() (pathlib.Path 方法)

(在 os 模块中)

lchown() (在 os 模块中)

lcm() (在 math 模块中)

LDCXXSHARED

ldexp() (在 math 模块中)

LDFLAGS, [1], [2], [3], [4], [5], [6], [7]

LDFLAGS_NODIST, [1]

ldgettext() (在 gettext 模块中)

ldngettext() (在 gettext 模块中)

le() (在 operator 模块中)

leading whitespace

leapdays() (在 calendar 模块中)

leaveok() (curses.window 方法)

left (filecmp.dircmp 属性)

left() (在 turtle 模块中)

left_list (filecmp.dircmp 属性)

left_only (filecmp.dircmp 属性)

LEFTSHIFT() (在 token 模块中)

LEFTSHIFTEQUAL() (在 token 模块中)

len

內置函数, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

len()

內置函数

lenfunc (C type)

length (xml.dom.NamedNodeMap 属性)

(xml.dom.NodeList 属性)

length_hint() (在 operator 模块中)

LESS() (在 token 模块中)

LESSEQUAL() (在 token 模块中)

lexical analysis

lexical definitions

LexicalHandler (xml.sax.handler 中的类)

lexists() (在 os.path 模块中)

lgamma() (在 math 模块中)

lgettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

lib2to3

模块

libc_ver() (在 platform 模块中)

library (ssl.SSLError 属性)

library() (在 dbm.ndbm 模块中)

library_dir_option() (distutils.ccompiler.CCompiler 方法)

library_filename() (distutils.ccompiler.CCompiler 方法)

library_option() (distutils.ccompiler.CCompiler 方法)

LibraryLoader (ctypes 中的类)

license (內置变量)

LifoQueue (asyncio 中的类)

(queue 中的类)

light-weight processes

limit_denominator() (fractions.Fraction 方法)

LimitOverrunError

lin2adpcm() (在 audioop 模块中)

lin2alaw() (在 audioop 模块中)

lin2lin() (在 audioop 模块中)

lin2ulaw() (在 audioop 模块中)

line (bdb.Breakpoint 属性)

line continuation

line joining, [1]

line structure

line() (msilib.Dialog 方法)

line-buffered I/O

line_buffering (io.TextIOWrapper 属性)

line_num (csv.csvreader 属性)

linear_regression() (在 statistics 模块中)

linecache

模块

lineno (ast.AST 属性)

(doctest.DocTest 属性)

(doctest.Example 属性)

(json.JSONDecodeError 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

(re.error 属性)

(shlex.shlex 属性)

(SyntaxError 属性)

(traceback.TracebackException 属性)

(tracemalloc.Filter 属性)

(tracemalloc.Frame 属性)

(xml.parsers.expat.ExpatError 属性)

lineno() (在 fileinput 模块中)

LINES, [1], [2], [3], [4]

lines (os.terminal_size 属性)

linesep (email.policy.Policy 属性)

linesep() (在 os 模块中)

lineterminator (csv.Dialect 属性)

LineTooLong

link() (distutils.ccompiler.CCompiler 方法)

(在 os 模块中)

link_executable() (distutils.ccompiler.CCompiler 方法)

link_shared_lib() (distutils.ccompiler.CCompiler 方法)

link_shared_object() (distutils.ccompiler.CCompiler 方法)

link_to() (pathlib.Path 方法)

LinkFallbackError

linkname (tarfile.TarInfo 属性)

LinkOutsideDestinationError

list

assignment, target

comprehensions

deletion target

display

empty

expression, [1], [2]

target, [1]

type, operations on

对象, [1], [2], [3], [4], [5], [6], [7], [8]

List (ast 中的类)

list (pdb command)

List (typing 中的类)

list (內置类)

list comprehension -- 列表推导式

list() (imaplib.IMAP4 方法)

(multiprocessing.managers.SyncManager 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

(tarfile.TarFile 方法)

LIST_APPEND (opcode)

list_dialects() (在 csv 模块中)

LIST_EXTEND (opcode)

list_folders() (mailbox.Maildir 方法)

(mailbox.MH 方法)

LIST_TO_TUPLE (opcode)

ListComp (ast 中的类)

listdir() (在 os 模块中)

listen() (asyncore.dispatcher 方法)

(socket.socket 方法)

(在 logging.config 模块中)

(在 turtle 模块中)

listener (logging.handlers.QueueHandler 属性)

Listener (multiprocessing.connection 中的类)

listMethods() (xmlrpc.client.ServerProxy.system 方法)

ListNoteBook (tkinter.tix 中的类)

listxattr() (在 os 模块中)

literal, [1]

Literal() (在 typing 模块中)

literal_eval() (在 ast 模块中)

literals

binary

complex number

floating point

hexadecimal

integer

numeric

octal

LittleEndianStructure (ctypes 中的类)

ljust() (bytearray 方法)

(bytes 方法)

(str 方法)

LK_LOCK() (在 msvcrt 模块中)

LK_NBLCK() (在 msvcrt 模块中)

LK_NBRLCK() (在 msvcrt 模块中)

LK_RLCK() (在 msvcrt 模块中)

LK_UNLCK() (在 msvcrt 模块中)

ll (pdb command)

LMTP (smtplib 中的类)

ln() (decimal.Context 方法)

(decimal.Decimal 方法)

LNAME

lngettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

Load (ast 中的类)

load() (http.cookiejar.FileCookieJar 方法)

(http.cookies.BaseCookie 方法)

(pickle.Unpickler 方法)

(tracemalloc.Snapshot 类方法)

(在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

LOAD_ASSERTION_ERROR (opcode)

LOAD_ATTR (opcode)

LOAD_BUILD_CLASS (opcode)

load_cert_chain() (ssl.SSLContext 方法)

LOAD_CLASSDEREF (opcode)

LOAD_CLOSURE (opcode)

LOAD_CONST (opcode)

load_default_certs() (ssl.SSLContext 方法)

LOAD_DEREF (opcode)

load_dh_params() (ssl.SSLContext 方法)

load_extension() (sqlite3.Connection 方法)

LOAD_FAST (opcode)

LOAD_GLOBAL (opcode)

LOAD_METHOD (opcode)

load_module() (importlib.abc.FileLoader 方法)

(importlib.abc.InspectLoader 方法)

(importlib.abc.Loader 方法)

(importlib.abc.SourceLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

(importlib.machinery.SourcelessFileLoader 方法)

(zipimport.zipimporter 方法)

(在 imp 模块中)

LOAD_NAME (opcode)

load_package_tests() (在 test.support 模块中)

load_verify_locations() (ssl.SSLContext 方法)

loader

Loader (importlib.abc 中的类)

loader (importlib.machinery.ModuleSpec 属性)

loader -- 加载器

loader_state (importlib.machinery.ModuleSpec 属性)

LoadError

LoadFileDialog (tkinter.filedialog 中的类)

LoadKey() (在 winreg 模块中)

LoadLibrary() (ctypes.LibraryLoader 方法)

loads() (在 json 模块中)

(在 marshal 模块中)

(在 pickle 模块中)

(在 plistlib 模块中)

(在 xmlrpc.client 模块中)

loadTestsFromModule() (unittest.TestLoader 方法)

loadTestsFromName() (unittest.TestLoader 方法)

loadTestsFromNames() (unittest.TestLoader 方法)

loadTestsFromTestCase() (unittest.TestLoader 方法)

local (threading 中的类)

localcontext() (在 decimal 模块中)

locale

模块

locale encoding -- 语言区域编码格式

LOCALE() (在 re 模块中)

localeconv() (在 locale 模块中)

LocaleHTMLCalendar (calendar 中的类)

LocaleTextCalendar (calendar 中的类)

localize() (在 locale 模块中)

localName (xml.dom.Attr 属性)

(xml.dom.Node 属性)

locals()

內置函数

localtime() (在 email.utils 模块中)

(在 time 模块中)

Locator (xml.sax.xmlreader 中的类)

Lock (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

lock() (mailbox.Babyl 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.mbox 方法)

(mailbox.MH 方法)

(mailbox.MMDF 方法)

Lock() (multiprocessing.managers.SyncManager 方法)

lock, interpreter

lock_held() (在 imp 模块中)

locked() (_thread.lock 方法)

(asyncio.Condition 方法)

(asyncio.Lock 方法)

(asyncio.Semaphore 方法)

(threading.Lock 方法)

lockf() (在 fcntl 模块中)

(在 os 模块中)

locking() (在 msvcrt 模块中)

LockType() (在 _thread 模块中)

log() (logging.Logger 方法)

(在 cmath 模块中)

(在 logging 模块中)

(在 math 模块中)

log10() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 cmath 模块中)

(在 math 模块中)

log1p() (在 math 模块中)

log2() (在 math 模块中)

log_date_time_string() (http.server.BaseHTTPRequestHandler 方法)

log_error() (http.server.BaseHTTPRequestHandler 方法)

log_exception() (wsgiref.handlers.BaseHandler 方法)

log_message() (http.server.BaseHTTPRequestHandler 方法)

log_request() (http.server.BaseHTTPRequestHandler 方法)

log_to_stderr() (在 multiprocessing 模块中)

logb() (decimal.Context 方法)

(decimal.Decimal 方法)

Logger (logging 中的类)

LoggerAdapter (logging 中的类)

logging

Errors

模块

logging.config

模块

logging.handlers

模块

logical line

logical_and() (decimal.Context 方法)

(decimal.Decimal 方法)

logical_invert() (decimal.Context 方法)

(decimal.Decimal 方法)

logical_or() (decimal.Context 方法)

(decimal.Decimal 方法)

logical_xor() (decimal.Context 方法)

(decimal.Decimal 方法)

login() (ftplib.FTP 方法)

(imaplib.IMAP4 方法)

(nntplib.NNTP 方法)

(smtplib.SMTP 方法)

login_cram_md5() (imaplib.IMAP4 方法)

LOGNAME, [1]

lognormvariate() (在 random 模块中)

logout() (imaplib.IMAP4 方法)

LogRecord (logging 中的类)

long (2to3 fixer)

long integer

对象

LONG_MAX

LONG_TIMEOUT() (在 test.support 模块中)

longMessage (unittest.TestCase 属性)

longname() (在 curses 模块中)

lookup() (symtable.SymbolTable 方法)

(tkinter.ttk.Style 方法)

(在 codecs 模块中)

(在 unicodedata 模块中)

lookup_error() (在 codecs 模块中)

LookupError

loop

over mutable sequence

statement, [1], [2], [3]

loop control

target

loop() (在 asyncore 模块中)

LOOPBACK_TIMEOUT() (在 test.support 模块中)

lower() (bytearray 方法)

(bytes 方法)

(str 方法)

LPAR() (在 token 模块中)

lpAttributeList (subprocess.STARTUPINFO 属性)

lru_cache() (在 functools 模块中)

lseek() (在 os 模块中)

LShift (ast 中的类)

lshift() (在 operator 模块中)

LSQB() (在 token 模块中)

lstat() (pathlib.Path 方法)

(在 os 模块中)

lstrip() (bytearray 方法)

(bytes 方法)

(str 方法)

lsub() (imaplib.IMAP4 方法)

Lt (ast 中的类)

lt() (在 operator 模块中)

(在 turtle 模块中)

LtE (ast 中的类)

LWPCookieJar (http.cookiejar 中的类)

lzma

模块

LZMACompressor (lzma 中的类)

LZMADecompressor (lzma 中的类)

LZMAError

LZMAFile (lzma 中的类)

M

M() (在 re 模块中)

mac_ver() (在 platform 模块中)

machine() (在 platform 模块中)

macros (netrc.netrc 属性)

MADV_AUTOSYNC() (在 mmap 模块中)

MADV_CORE() (在 mmap 模块中)

MADV_DODUMP() (在 mmap 模块中)

MADV_DOFORK() (在 mmap 模块中)

MADV_DONTDUMP() (在 mmap 模块中)

MADV_DONTFORK() (在 mmap 模块中)

MADV_DONTNEED() (在 mmap 模块中)

MADV_FREE() (在 mmap 模块中)

MADV_FREE_REUSABLE() (在 mmap 模块中)

MADV_FREE_REUSE() (在 mmap 模块中)

MADV_HUGEPAGE() (在 mmap 模块中)

MADV_HWPOISON() (在 mmap 模块中)

MADV_MERGEABLE() (在 mmap 模块中)

MADV_NOCORE() (在 mmap 模块中)

MADV_NOHUGEPAGE() (在 mmap 模块中)

MADV_NORMAL() (在 mmap 模块中)

MADV_NOSYNC() (在 mmap 模块中)

MADV_PROTECT() (在 mmap 模块中)

MADV_RANDOM() (在 mmap 模块中)

MADV_REMOVE() (在 mmap 模块中)

MADV_SEQUENTIAL() (在 mmap 模块中)

MADV_SOFT_OFFLINE() (在 mmap 模块中)

MADV_UNMERGEABLE() (在 mmap 模块中)

MADV_WILLNEED() (在 mmap 模块中)

madvise() (mmap.mmap 方法)

magic

method

magic method -- 魔术方法

MAGIC_NUMBER() (在 importlib.util 模块中)

MagicMock (unittest.mock 中的类)

mailbox

模块

Mailbox (mailbox 中的类)

mailcap

模块

Maildir (mailbox 中的类)

MaildirMessage (mailbox 中的类)

mailfrom (smtpd.SMTPChannel 属性)

MailmanProxy (smtpd 中的类)

main(), [1], [2]

(在 site 模块中)

(在 unittest 模块中)

main_thread() (在 threading 模块中)

mainloop() (在 turtle 模块中)

maintype (email.headerregistry.ContentTypeHeader 属性)

major (email.headerregistry.MIMEVersionHeader 属性)

major() (在 os 模块中)

make_alternative() (email.message.EmailMessage 方法)

make_archive() (在 distutils.archive_util 模块中)

(在 shutil 模块中)

make_bad_fd() (在 test.support.os_helper 模块中)

make_cookies() (http.cookiejar.CookieJar 方法)

make_dataclass() (在 dataclasses 模块中)

make_file() (difflib.HtmlDiff 方法)

MAKE_FUNCTION (opcode)

make_header() (在 email.header 模块中)

make_legacy_pyc() (在 test.support.import_helper 模块中)

make_mixed() (email.message.EmailMessage 方法)

make_msgid() (在 email.utils 模块中)

make_parser() (在 xml.sax 模块中)

make_pkg() (在 test.support.script_helper 模块中)

make_related() (email.message.EmailMessage 方法)

make_script() (在 test.support.script_helper 模块中)

make_server() (在 wsgiref.simple_server 模块中)

make_table() (difflib.HtmlDiff 方法)

make_tarball() (在 distutils.archive_util 模块中)

make_zip_pkg() (在 test.support.script_helper 模块中)

make_zip_script() (在 test.support.script_helper 模块中)

make_zipfile() (在 distutils.archive_util 模块中)

makedev() (在 os 模块中)

makedirs() (在 os 模块中)

makeelement() (xml.etree.ElementTree.Element 方法)

makefile() (socket method)

(socket.socket 方法)

makeLogRecord() (在 logging 模块中)

makePickle() (logging.handlers.SocketHandler 方法)

makeRecord() (logging.Logger 方法)

makeSocket() (logging.handlers.DatagramHandler 方法)

(logging.handlers.SocketHandler 方法)

maketrans() (bytearray 静态方法)

(bytes 静态方法)

(str 静态方法)

malloc()

mangle_from_ (email.policy.Compat32 属性)

(email.policy.Policy 属性)

mangling

name, [1]

map (2to3 fixer)

map()

內置函数

map() (concurrent.futures.Executor 方法)

(multiprocessing.pool.Pool 方法)

(tkinter.ttk.Style 方法)

MAP_ADD (opcode)

MAP_ANON() (在 mmap 模块中)

MAP_ANONYMOUS() (在 mmap 模块中)

map_async() (multiprocessing.pool.Pool 方法)

MAP_DENYWRITE() (在 mmap 模块中)

MAP_EXECUTABLE() (在 mmap 模块中)

MAP_POPULATE() (在 mmap 模块中)

MAP_PRIVATE() (在 mmap 模块中)

MAP_SHARED() (在 mmap 模块中)

map_table_b2() (在 stringprep 模块中)

map_table_b3() (在 stringprep 模块中)

map_to_type() (email.headerregistry.HeaderRegistry 方法)

mapLogRecord() (logging.handlers.HTTPHandler 方法)

mapping

types, operations on

对象, [1], [2], [3], [4], [5]

Mapping (collections.abc 中的类)

(typing 中的类)

mapping -- 映射

mapping() (msilib.Control 方法)

MappingProxyType (types 中的类)

MappingView (collections.abc 中的类)

(typing 中的类)

mapPriority() (logging.handlers.SysLogHandler 方法)

maps (collections.ChainMap 属性)

maps() (在 nis 模块中)

marshal

模块

marshalling

objects

masking

operations

master (tkinter.Tk 属性)

match

case

语句

Match (ast 中的类)

(typing 中的类)

match() (pathlib.PurePath 方法)

(re.Pattern 方法)

(在 nis 模块中)

(在 re 模块中)

match_case (ast 中的类)

MATCH_CLASS (opcode)

match_hostname() (在 ssl 模块中)

MATCH_KEYS (opcode)

MATCH_MAPPING (opcode)

MATCH_SEQUENCE (opcode)

match_test() (在 test.support 模块中)

match_value() (test.support.Matcher 方法)

MatchAs (ast 中的类)

MatchClass (ast 中的类)

Matcher (test.support 中的类)

matches() (test.support.Matcher 方法)

MatchMapping (ast 中的类)

MatchOr (ast 中的类)

MatchSequence (ast 中的类)

MatchSingleton (ast 中的类)

MatchStar (ast 中的类)

MatchValue (ast 中的类)

math

模块, [1], [2]

matmul() (在 operator 模块中)

MatMult (ast 中的类)

matrix multiplication

max

內置函数

max (datetime.date 属性)

(datetime.datetime 属性)

(datetime.time 属性)

(datetime.timedelta 属性)

max()

內置函数

max() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 audioop 模块中)

max_count (email.headerregistry.BaseHeader 属性)

MAX_EMAX() (在 decimal 模块中)

MAX_INTERPOLATION_DEPTH() (在 configparser 模块中)

max_line_length (email.policy.Policy 属性)

max_lines (textwrap.TextWrapper 属性)

max_mag() (decimal.Context 方法)

(decimal.Decimal 方法)

max_memuse() (在 test.support 模块中)

MAX_PREC() (在 decimal 模块中)

max_prefixlen (ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

MAX_Py_ssize_t() (在 test.support 模块中)

maxarray (reprlib.Repr 属性)

maxdeque (reprlib.Repr 属性)

maxdict (reprlib.Repr 属性)

maxDiff (unittest.TestCase 属性)

maxfrozenset (reprlib.Repr 属性)

MAXIMUM_SUPPORTED (ssl.TLSVersion 属性)

maximum_version (ssl.SSLContext 属性)

maxlen (collections.deque 属性)

maxlevel (reprlib.Repr 属性)

maxlist (reprlib.Repr 属性)

maxlong (reprlib.Repr 属性)

maxother (reprlib.Repr 属性)

maxpp() (在 audioop 模块中)

maxset (reprlib.Repr 属性)

maxsize (asyncio.Queue 属性)

maxsize() (在 sys 模块中)

maxstring (reprlib.Repr 属性)

maxtuple (reprlib.Repr 属性)

maxunicode() (在 sys 模块中)

MAXYEAR() (在 datetime 模块中)

MB_ICONASTERISK() (在 winsound 模块中)

MB_ICONEXCLAMATION() (在 winsound 模块中)

MB_ICONHAND() (在 winsound 模块中)

MB_ICONQUESTION() (在 winsound 模块中)

MB_OK() (在 winsound 模块中)

mbox (mailbox 中的类)

mboxMessage (mailbox 中的类)

mean (statistics.NormalDist 属性)

mean() (在 statistics 模块中)

measure() (tkinter.font.Font 方法)

median (statistics.NormalDist 属性)

median() (在 statistics 模块中)

median_grouped() (在 statistics 模块中)

median_high() (在 statistics 模块中)

median_low() (在 statistics 模块中)

MemberDescriptorType() (在 types 模块中)

membership

test

memfd_create() (在 os 模块中)

memmove() (在 ctypes 模块中)

MemoryBIO (ssl 中的类)

MemoryError

MemoryHandler (logging.handlers 中的类)

memoryview

对象, [1]

memoryview (內置类)

memset() (在 ctypes 模块中)

merge() (在 heapq 模块中)

Message (email.message 中的类)

(mailbox 中的类)

(tkinter.messagebox 中的类)

message digest, MD5

message_factory (email.policy.Policy 属性)

message_from_binary_file() (在 email 模块中)

message_from_bytes() (在 email 模块中)

message_from_file() (在 email 模块中)

message_from_string() (在 email 模块中)

MessageBeep() (在 winsound 模块中)

MessageClass (http.server.BaseHTTPRequestHandler 属性)

MessageError

MessageParseError

messages() (在 xml.parsers.expat.errors 模块中)

meta

hooks

meta hooks

meta path finder -- 元路径查找器

meta() (在 curses 模块中)

meta_path() (在 sys 模块中)

metaclass

(2to3 fixer)

metaclass -- 元类

metaclass hint

MetaPathFinder (importlib.abc 中的类)

metavar (optparse.Option 属性)

MetavarTypeHelpFormatter (argparse 中的类)

Meter (tkinter.tix 中的类)

METH_CLASS (內置变量)

METH_COEXIST (內置变量)

METH_FASTCALL (內置变量)

METH_NOARGS (內置变量)

METH_O (內置变量)

METH_STATIC (內置变量)

METH_VARARGS (內置变量)

method

built-in

call

magic

special

user-defined

对象, [1], [2], [3], [4], [5]

method (urllib.request.Request 属性)

method -- 方法

method resolution order -- 方法解析顺序

METHOD_BLOWFISH() (在 crypt 模块中)

method_calls (unittest.mock.Mock 属性)

METHOD_CRYPT() (在 crypt 模块中)

METHOD_MD5() (在 crypt 模块中)

METHOD_SHA256() (在 crypt 模块中)

METHOD_SHA512() (在 crypt 模块中)

methodattrs (2to3 fixer)

methodcaller() (在 operator 模块中)

MethodDescriptorType() (在 types 模块中)

methodHelp() (xmlrpc.client.ServerProxy.system 方法)

methods

bytearray

bytes

string

methods (pyclbr.Class 属性)

methods() (在 crypt 模块中)

methodSignature() (xmlrpc.client.ServerProxy.system 方法)

MethodType (in module types), [1]

MethodType() (在 types 模块中)

MethodWrapperType() (在 types 模块中)

metrics() (tkinter.font.Font 方法)

MFD_ALLOW_SEALING() (在 os 模块中)

MFD_CLOEXEC() (在 os 模块中)

MFD_HUGE_16GB() (在 os 模块中)

MFD_HUGE_16MB() (在 os 模块中)

MFD_HUGE_1GB() (在 os 模块中)

MFD_HUGE_1MB() (在 os 模块中)

MFD_HUGE_256MB() (在 os 模块中)

MFD_HUGE_2GB() (在 os 模块中)

MFD_HUGE_2MB() (在 os 模块中)

MFD_HUGE_32MB() (在 os 模块中)

MFD_HUGE_512KB() (在 os 模块中)

MFD_HUGE_512MB() (在 os 模块中)

MFD_HUGE_64KB() (在 os 模块中)

MFD_HUGE_8MB() (在 os 模块中)

MFD_HUGE_MASK() (在 os 模块中)

MFD_HUGE_SHIFT() (在 os 模块中)

MFD_HUGETLB() (在 os 模块中)

MH (mailbox 中的类)

MHMessage (mailbox 中的类)

microsecond (datetime.datetime 属性)

(datetime.time 属性)

MIME

base64 encoding

content type

headers, [1]

quoted-printable encoding

MIMEApplication (email.mime.application 中的类)

MIMEAudio (email.mime.audio 中的类)

MIMEBase (email.mime.base 中的类)

MIMEImage (email.mime.image 中的类)

MIMEMessage (email.mime.message 中的类)

MIMEMultipart (email.mime.multipart 中的类)

MIMENonMultipart (email.mime.nonmultipart 中的类)

MIMEPart (email.message 中的类)

MIMEText (email.mime.text 中的类)

mimetypes

模块

MimeTypes (mimetypes 中的类)

MIMEVersionHeader (email.headerregistry 中的类)

min

內置函数

min (datetime.date 属性)

(datetime.datetime 属性)

(datetime.time 属性)

(datetime.timedelta 属性)

min()

內置函数

min() (decimal.Context 方法)

(decimal.Decimal 方法)

MIN_EMIN() (在 decimal 模块中)

MIN_ETINY() (在 decimal 模块中)

min_mag() (decimal.Context 方法)

(decimal.Decimal 方法)

MINEQUAL() (在 token 模块中)

MINIMUM_SUPPORTED (ssl.TLSVersion 属性)

minimum_version (ssl.SSLContext 属性)

minmax() (在 audioop 模块中)

minor (email.headerregistry.MIMEVersionHeader 属性)

minor() (在 os 模块中)

minus

minus() (decimal.Context 方法)

MINUS() (在 token 模块中)

minute (datetime.datetime 属性)

(datetime.time 属性)

MINYEAR() (在 datetime 模块中)

mirrored() (在 unicodedata 模块中)

misc_header (cmd.Cmd 属性)

MISSING (contextvars.Token 属性)

MISSING() (在 dataclasses 模块中)

MISSING_C_DOCSTRINGS() (在 test.support 模块中)

missing_compiler_executable() (在 test.support 模块中)

MissingSectionHeaderError

MIXERDEV

mkd() (ftplib.FTP 方法)

mkdir() (pathlib.Path 方法)

(在 os 模块中)

mkdtemp() (在 tempfile 模块中)

mkfifo() (在 os 模块中)

mknod() (在 os 模块中)

mkpath() (distutils.ccompiler.CCompiler 方法)

(在 distutils.dir_util 模块中)

mksalt() (在 crypt 模块中)

mkstemp() (在 tempfile 模块中)

mktemp() (在 tempfile 模块中)

mktime() (在 time 模块中)

mktime_tz() (在 email.utils 模块中)

mlsd() (ftplib.FTP 方法)

mmap

模块

mmap (mmap 中的类)

MMDF (mailbox 中的类)

MMDFMessage (mailbox 中的类)

Mock (unittest.mock 中的类)

mock_add_spec() (unittest.mock.Mock 方法)

mock_calls (unittest.mock.Mock 属性)

mock_open() (在 unittest.mock 模块中)

Mod (ast 中的类)

mod() (在 operator 模块中)

mode (io.FileIO 属性)

(ossaudiodev.oss_audio_device 属性)

(statistics.NormalDist 属性)

(tarfile.TarInfo 属性)

mode() (在 statistics 模块中)

(在 turtle 模块中)

modes

file

modf() (在 math 模块中)

modified() (urllib.robotparser.RobotFileParser 方法)

Modify() (msilib.View 方法)

modify() (select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(selectors.BaseSelector 方法)

module

extension

importing

namespace

search path, [1], [2], [3], [4], [5], [6], [7]

对象, [1], [2]

module (pyclbr.Class 属性)

(pyclbr.Function 属性)

Module browser

module spec

module spec -- 模块规格

module_for_loader() (在 importlib.util 模块中)

module_from_spec() (在 importlib.util 模块中)

module_repr() (importlib.abc.Loader 方法)

modulefinder

模块

ModuleFinder (modulefinder 中的类)

ModuleInfo (pkgutil 中的类)

ModuleNotFoundError

modules (in module sys), [1]

(modulefinder.ModuleFinder 属性)

modules() (在 sys 模块中)

modules_cleanup() (在 test.support.import_helper 模块中)

modules_setup() (在 test.support.import_helper 模块中)

ModuleSpec (importlib.machinery 中的类)

ModuleType (in module types)

(types 中的类)

modulo

MONDAY() (在 calendar 模块中)

monotonic() (在 time 模块中)

monotonic_ns() (在 time 模块中)

month (datetime.date 属性)

(datetime.datetime 属性)

month() (在 calendar 模块中)

month_abbr() (在 calendar 模块中)

month_name() (在 calendar 模块中)

monthcalendar() (在 calendar 模块中)

monthdatescalendar() (calendar.Calendar 方法)

monthdays2calendar() (calendar.Calendar 方法)

monthdayscalendar() (calendar.Calendar 方法)

monthrange() (在 calendar 模块中)

Morsel (http.cookies 中的类)

most_common() (collections.Counter 方法)

mouseinterval() (在 curses 模块中)

mousemask() (在 curses 模块中)

move() (curses.panel.Panel 方法)

(curses.window 方法)

(mmap.mmap 方法)

(tkinter.ttk.Treeview 方法)

(在 shutil 模块中)

move_file() (distutils.ccompiler.CCompiler 方法)

(在 distutils.file_util 模块中)

move_to_end() (collections.OrderedDict 方法)

MozillaCookieJar (http.cookiejar 中的类)

MRO

mro() (class 方法)

msg (http.client.HTTPResponse 属性)

(json.JSONDecodeError 属性)

(re.error 属性)

(traceback.TracebackException 属性)

msg() (telnetlib.Telnet 方法)

msi

msilib

模块

msvcrt

模块

mt_interact() (telnetlib.Telnet 方法)

mtime (gzip.GzipFile 属性)

(tarfile.TarInfo 属性)

mtime() (urllib.robotparser.RobotFileParser 方法)

mul() (在 audioop 模块中)

(在 operator 模块中)

Mult (ast 中的类)

MultiCall (xmlrpc.client 中的类)

MULTILINE() (在 re 模块中)

MultiLoopChildWatcher (asyncio 中的类)

multimode() (在 statistics 模块中)

MultipartConversionError

multiplication

multiply() (decimal.Context 方法)

multiprocessing

模块

multiprocessing.connection

模块

multiprocessing.dummy

模块

multiprocessing.Manager()

內置函数

multiprocessing.managers

模块

multiprocessing.pool

模块

multiprocessing.shared_memory

模块

multiprocessing.sharedctypes

模块

mutable

sequence types

对象, [1], [2]

mutable -- 可变对象

mutable object

mutable sequence

loop over

对象

MutableMapping (collections.abc 中的类)

(typing 中的类)

MutableSequence (collections.abc 中的类)

(typing 中的类)

MutableSet (collections.abc 中的类)

(typing 中的类)

mvderwin() (curses.window 方法)

mvwin() (curses.window 方法)

myrights() (imaplib.IMAP4 方法)

N

N_TOKENS() (在 token 模块中)

n_waiting (threading.Barrier 属性)

name, [1], [2]

binding, [1], [2], [3], [4], [5], [6]

binding, global

class

function, [1]

mangling, [1]

rebinding

unbinding

Name (ast 中的类)

name (codecs.CodecInfo 属性)

(contextvars.ContextVar 属性)

(doctest.DocTest 属性)

(email.headerregistry.BaseHeader 属性)

(gzip.GzipFile 属性)

(hashlib.hash 属性)

(hmac.HMAC 属性)

(http.cookiejar.Cookie 属性)

(importlib.abc.FileLoader 属性)

(importlib.machinery.ExtensionFileLoader 属性)

(importlib.machinery.ModuleSpec 属性)

(importlib.machinery.SourceFileLoader 属性)

(importlib.machinery.SourcelessFileLoader 属性)

(inspect.Parameter 属性)

(io.FileIO 属性)

(multiprocessing.Process 属性)

(multiprocessing.shared_memory.SharedMemory 属性)

(os.DirEntry 属性)

(ossaudiodev.oss_audio_device 属性)

(pathlib.PurePath 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

(tarfile.TarInfo 属性)

(threading.Thread 属性)

(xml.dom.Attr 属性)

(xml.dom.DocumentType 属性)

(zipfile.Path 属性)

name() (importlib.abc.Traversable 方法)

(在 os 模块中)

NAME() (在 token 模块中)

name() (在 unicodedata 模块中)

name2codepoint() (在 html.entities 模块中)

named expression

Named Shared Memory

named tuple -- 具名元组

NamedExpr (ast 中的类)

NamedTemporaryFile() (在 tempfile 模块中)

NamedTuple (typing 中的类)

namedtuple() (在 collections 模块中)

NameError

例外

NameError (built-in exception)

namelist() (zipfile.ZipFile 方法)

nameprep() (在 encodings.idna 模块中)

namer (logging.handlers.BaseRotatingHandler 属性)

namereplace

error handler's name

namereplace_errors() (在 codecs 模块中)

names

private

names() (在 tkinter.font 模块中)

namespace

global

module

package

Namespace (argparse 中的类)

(multiprocessing.managers 中的类)

namespace -- 命名空间

namespace package -- 命名空间包

namespace() (imaplib.IMAP4 方法)

Namespace() (multiprocessing.managers.SyncManager 方法)

NAMESPACE_DNS() (在 uuid 模块中)

NAMESPACE_OID() (在 uuid 模块中)

NAMESPACE_URL() (在 uuid 模块中)

NAMESPACE_X500() (在 uuid 模块中)

NamespaceErr

namespaceURI (xml.dom.Node 属性)

nametofont() (在 tkinter.font 模块中)

NaN

nan() (在 cmath 模块中)

(在 math 模块中)

nanj() (在 cmath 模块中)

NannyNag

napms() (在 curses 模块中)

nargs (optparse.Option 属性)

native_id (threading.Thread 属性)

nbytes (memoryview 属性)

ncurses_version() (在 curses 模块中)

ndiff() (在 difflib 模块中)

ndim (memoryview 属性)

ne (2to3 fixer)

ne() (在 operator 模块中)

needs_input (bz2.BZ2Decompressor 属性)

(lzma.LZMADecompressor 属性)

neg() (在 operator 模块中)

negation

nested scope -- 嵌套作用域

netmask (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

NetmaskValueError

netrc

模块

netrc (netrc 中的类)

NetrcParseError

netscape (http.cookiejar.CookiePolicy 属性)

network (ipaddress.IPv4Interface 属性)

(ipaddress.IPv6Interface 属性)

Network News Transfer Protocol

network_address (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

NEVER_EQ() (在 test.support 模块中)

new() (在 hashlib 模块中)

(在 hmac 模块中)

new-style class -- 新式类

new_child() (collections.ChainMap 方法)

new_class() (在 types 模块中)

new_compiler() (在 distutils.ccompiler 模块中)

new_event_loop() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

new_module() (在 imp 模块中)

new_panel() (在 curses.panel 模块中)

newer() (在 distutils.dep_util 模块中)

newer_group() (在 distutils.dep_util 模块中)

newer_pairwise() (在 distutils.dep_util 模块中)

newfunc (C type)

newgroups() (nntplib.NNTP 方法)

NEWLINE token, [1]

NEWLINE() (在 token 模块中)

newlines (io.TextIOBase 属性)

newnews() (nntplib.NNTP 方法)

newpad() (在 curses 模块中)

NewType (typing 中的类)

newwin() (在 curses 模块中)

next (2to3 fixer)

(pdb command)

next()

內置函数

next() (nntplib.NNTP 方法)

(tarfile.TarFile 方法)

(tkinter.ttk.Treeview 方法)

next_minus() (decimal.Context 方法)

(decimal.Decimal 方法)

next_plus() (decimal.Context 方法)

(decimal.Decimal 方法)

next_toward() (decimal.Context 方法)

(decimal.Decimal 方法)

nextafter() (在 math 模块中)

nextfile() (在 fileinput 模块中)

nextkey() (dbm.gnu.gdbm 方法)

nextSibling (xml.dom.Node 属性)

ngettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

nice() (在 os 模块中)

nis

模块

nl() (在 curses 模块中)

NL() (在 token 模块中)

nl_langinfo() (在 locale 模块中)

nlargest() (在 heapq 模块中)

nlst() (ftplib.FTP 方法)

NNTP

protocol

NNTP (nntplib 中的类)

nntp_implementation (nntplib.NNTP 属性)

NNTP_SSL (nntplib 中的类)

nntp_version (nntplib.NNTP 属性)

NNTPDataError

NNTPError

nntplib

模块

NNTPPermanentError

NNTPProtocolError

NNTPReplyError

NNTPTemporaryError

no_cache() (zoneinfo.ZoneInfo 类方法)

no_proxy

no_tracing() (在 test.support 模块中)

no_type_check() (在 typing 模块中)

no_type_check_decorator() (在 typing 模块中)

nocbreak() (在 curses 模块中)

NoDataAllowedErr

node() (在 platform 模块中)

nodelay() (curses.window 方法)

nodeName (xml.dom.Node 属性)

NodeTransformer (ast 中的类)

nodeType (xml.dom.Node 属性)

nodeValue (xml.dom.Node 属性)

NodeVisitor (ast 中的类)

noecho() (在 curses 模块中)

NOEXPR() (在 locale 模块中)

NoModificationAllowedErr

nonblock() (ossaudiodev.oss_audio_device 方法)

NonCallableMagicMock (unittest.mock 中的类)

NonCallableMock (unittest.mock 中的类)

None

对象, [1], [2]

None (Built-in object)

(內置变量)

NoneType() (在 types 模块中)

nonl() (在 curses 模块中)

nonlocal

语句

Nonlocal (ast 中的类)

nonzero (2to3 fixer)

noop() (imaplib.IMAP4 方法)

(poplib.POP3 方法)

NoOptionError

NOP (opcode)

noqiflush() (在 curses 模块中)

noraw() (在 curses 模块中)

NoReturn() (在 typing 模块中)

NORMAL() (在 tkinter.font 模块中)

NORMAL_PRIORITY_CLASS() (在 subprocess 模块中)

NormalDist (statistics 中的类)

normalize() (decimal.Context 方法)

(decimal.Decimal 方法)

(xml.dom.Node 方法)

(在 locale 模块中)

(在 unicodedata 模块中)

NORMALIZE_WHITESPACE() (在 doctest 模块中)

normalvariate() (在 random 模块中)

normcase() (在 os.path 模块中)

normpath() (在 os.path 模块中)

NoSectionError

NoSuchMailboxError

not

运算符, [1]

Not (ast 中的类)

not in

运算符, [1], [2]

not_() (在 operator 模块中)

NotADirectoryError

notation

notationDecl() (xml.sax.handler.DTDHandler 方法)

NotationDeclHandler() (xml.parsers.expat.xmlparser 方法)

notations (xml.dom.DocumentType 属性)

NotConnected

NoteBook (tkinter.tix 中的类)

Notebook (tkinter.ttk 中的类)

NotEmptyError

NotEq (ast 中的类)

NOTEQUAL() (在 token 模块中)

NotFoundErr

notify() (asyncio.Condition 方法)

(threading.Condition 方法)

notify_all() (asyncio.Condition 方法)

(threading.Condition 方法)

notimeout() (curses.window 方法)

NotImplemented

对象

NotImplemented (內置变量)

NotImplementedError

NotImplementedType() (在 types 模块中)

NotIn (ast 中的类)

NotStandaloneHandler() (xml.parsers.expat.xmlparser 方法)

NotSupportedErr

NotSupportedError

noutrefresh() (curses.window 方法)

now() (datetime.datetime 类方法)

npgettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

NSIG() (在 signal 模块中)

nsmallest() (在 heapq 模块中)

NT_OFFSET() (在 token 模块中)

NTEventLogHandler (logging.handlers 中的类)

ntohl() (在 socket 模块中)

ntohs() (在 socket 模块中)

ntransfercmd() (ftplib.FTP 方法)

null

operation, [1]

nullcontext() (在 contextlib 模块中)

NullHandler (logging 中的类)

NullImporter (imp 中的类)

NullTranslations (gettext 中的类)

num_addresses (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

num_tickets (ssl.SSLContext 属性)

number

complex

floating point

Number (numbers 中的类)

NUMBER() (在 token 模块中)

number_class() (decimal.Context 方法)

(decimal.Decimal 方法)

numbers

模块

numerator (fractions.Fraction 属性)

(numbers.Rational 属性)

numeric

conversions

literals

object

types, operations on

对象, [1], [2], [3]

numeric literal

numeric() (在 unicodedata 模块中)

numinput() (在 turtle 模块中)

numliterals (2to3 fixer)

O

O_APPEND() (在 os 模块中)

O_ASYNC() (在 os 模块中)

O_BINARY() (在 os 模块中)

O_CLOEXEC() (在 os 模块中)

O_CREAT() (在 os 模块中)

O_DIRECT() (在 os 模块中)

O_DIRECTORY() (在 os 模块中)

O_DSYNC() (在 os 模块中)

O_EVTONLY() (在 os 模块中)

O_EXCL() (在 os 模块中)

O_EXLOCK() (在 os 模块中)

O_FSYNC() (在 os 模块中)

O_NDELAY() (在 os 模块中)

O_NOATIME() (在 os 模块中)

O_NOCTTY() (在 os 模块中)

O_NOFOLLOW() (在 os 模块中)

O_NOFOLLOW_ANY() (在 os 模块中)

O_NOINHERIT() (在 os 模块中)

O_NONBLOCK() (在 os 模块中)

O_PATH() (在 os 模块中)

O_RANDOM() (在 os 模块中)

O_RDONLY() (在 os 模块中)

O_RDWR() (在 os 模块中)

O_RSYNC() (在 os 模块中)

O_SEQUENTIAL() (在 os 模块中)

O_SHLOCK() (在 os 模块中)

O_SHORT_LIVED() (在 os 模块中)

O_SYMLINK() (在 os 模块中)

O_SYNC() (在 os 模块中)

O_TEMPORARY() (在 os 模块中)

O_TEXT() (在 os 模块中)

O_TMPFILE() (在 os 模块中)

O_TRUNC() (在 os 模块中)

O_WRONLY() (在 os 模块中)

obj (memoryview 属性)

object

code, [1], [2], [3]

deallocation

finalization

immutable, [1]

numeric

object (UnicodeError 属性)

(內置类)

object -- 对象

object.__match_args__ (內置变量)

object.__slots__ (內置变量)

object_filenames() (distutils.ccompiler.CCompiler 方法)

objects

comparing

flattening

marshalling

persistent

pickling

serializing

objobjargproc (C type)

objobjproc (C type)

obufcount() (ossaudiodev.oss_audio_device 方法)

obuffree() (ossaudiodev.oss_audio_device 方法)

oct()

內置函数

octal

literals

octal literal

octdigits() (在 string 模块中)

offset (SyntaxError 属性)

(traceback.TracebackException 属性)

(xml.parsers.expat.ExpatError 属性)

OK() (在 curses 模块中)

ok_command() (tkinter.filedialog.LoadFileDialog 方法)

(tkinter.filedialog.SaveFileDialog 方法)

ok_event() (tkinter.filedialog.FileDialog 方法)

old_value (contextvars.Token 属性)

OleDLL (ctypes 中的类)

on_motion() (tkinter.dnd.DndHandler 方法)

on_release() (tkinter.dnd.DndHandler 方法)

onclick() (在 turtle 模块中)

ondrag() (在 turtle 模块中)

onecmd() (cmd.Cmd 方法)

onkey() (在 turtle 模块中)

onkeypress() (在 turtle 模块中)

onkeyrelease() (在 turtle 模块中)

onrelease() (在 turtle 模块中)

onscreenclick() (在 turtle 模块中)

ontimer() (在 turtle 模块中)

OP() (在 token 模块中)

OP_ALL() (在 ssl 模块中)

OP_CIPHER_SERVER_PREFERENCE() (在 ssl 模块中)

OP_ENABLE_MIDDLEBOX_COMPAT() (在 ssl 模块中)

OP_IGNORE_UNEXPECTED_EOF() (在 ssl 模块中)

OP_NO_COMPRESSION() (在 ssl 模块中)

OP_NO_RENEGOTIATION() (在 ssl 模块中)

OP_NO_SSLv2() (在 ssl 模块中)

OP_NO_SSLv3() (在 ssl 模块中)

OP_NO_TICKET() (在 ssl 模块中)

OP_NO_TLSv1() (在 ssl 模块中)

OP_NO_TLSv1_1() (在 ssl 模块中)

OP_NO_TLSv1_2() (在 ssl 模块中)

OP_NO_TLSv1_3() (在 ssl 模块中)

OP_SINGLE_DH_USE() (在 ssl 模块中)

OP_SINGLE_ECDH_USE() (在 ssl 模块中)

open

內置函数, [1]

Open (tkinter.filedialog 中的类)

open()

內置函数

open() (distutils.text_file.TextFile 方法)

(imaplib.IMAP4 方法)

(importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(pipes.Template 方法)

(tarfile.TarFile 类方法)

(telnetlib.Telnet 方法)

(urllib.request.OpenerDirector 方法)

(urllib.request.URLopener 方法)

(webbrowser.controller 方法)

(zipfile.Path 方法)

(zipfile.ZipFile 方法)

(在 aifc 模块中)

(在 bz2 模块中)

(在 codecs 模块中)

(在 dbm 模块中)

(在 dbm.dumb 模块中)

(在 dbm.gnu 模块中)

(在 dbm.ndbm 模块中)

(在 gzip 模块中)

(在 io 模块中)

(在 lzma 模块中)

(在 os 模块中)

(在 ossaudiodev 模块中)

(在 shelve 模块中)

(在 sunau 模块中)

(在 tarfile 模块中)

(在 tokenize 模块中)

(在 wave 模块中)

(在 webbrowser 模块中)

open_binary() (在 importlib.resources 模块中)

open_code() (在 io 模块中)

open_connection() (在 asyncio 模块中)

open_new() (webbrowser.controller 方法)

(在 webbrowser 模块中)

open_new_tab() (webbrowser.controller 方法)

(在 webbrowser 模块中)

open_osfhandle() (在 msvcrt 模块中)

open_resource() (importlib.abc.ResourceReader 方法)

open_text() (在 importlib.resources 模块中)

open_unix_connection() (在 asyncio 模块中)

open_unknown() (urllib.request.URLopener 方法)

open_urlresource() (在 test.support 模块中)

OpenDatabase() (在 msilib 模块中)

OpenerDirector (urllib.request 中的类)

OpenKey() (在 winreg 模块中)

OpenKeyEx() (在 winreg 模块中)

openlog() (在 syslog 模块中)

openmixer() (在 ossaudiodev 模块中)

openpty() (在 os 模块中)

(在 pty 模块中)

OpenSSL

(use in module hashlib)

(use in module ssl)

OPENSSL_VERSION() (在 ssl 模块中)

OPENSSL_VERSION_INFO() (在 ssl 模块中)

OPENSSL_VERSION_NUMBER() (在 ssl 模块中)

OpenView() (msilib.Database 方法)

operation

binary arithmetic

binary bitwise

Boolean

concatenation

null, [1]

power

repetition

shifting

slice

subscript

unary arithmetic

unary bitwise

OperationalError

operations

bitwise

Boolean, [1]

masking

shifting

operations on

dictionary type

integer types

list type

mapping types

numeric types

sequence types, [1]

operator

+ (plus), [1], [2]

- (minus), [1], [2]

comparison

overloading

precedence

ternary

模块

operator (2to3 fixer)

operators

opmap() (在 dis 模块中)

opname() (在 dis 模块中)

OPT

optim_args_from_interpreter_flags() (在 test.support 模块中)

optimize() (在 pickletools 模块中)

OPTIMIZED_BYTECODE_SUFFIXES() (在 importlib.machinery 模块中)

Optional() (在 typing 模块中)

OptionGroup (optparse 中的类)

OptionMenu (tkinter.tix 中的类)

OptionParser (optparse 中的类)

options (doctest.Example 属性)

Options (ssl 中的类)

options (ssl.SSLContext 属性)

options() (configparser.ConfigParser 方法)

optionxform() (configparser.ConfigParser 方法)

optparse

模块

or

bitwise

exclusive

inclusive

运算符, [1], [2]

Or (ast 中的类)

or_() (在 operator 模块中)

ord

內置函数

ord()

內置函数

order

evaluation

ordered_attributes (xml.parsers.expat.xmlparser 属性)

OrderedDict (collections 中的类)

(typing 中的类)

orig_argv() (在 sys 模块中)

origin (importlib.machinery.ModuleSpec 属性)

origin_req_host (urllib.request.Request 属性)

origin_server (wsgiref.handlers.BaseHandler 属性)

os

模块, [1]

os.path

模块

os_environ (wsgiref.handlers.BaseHandler 属性)

OSError

ossaudiodev

模块

OSSAudioError

outfile

json.tool command line option

output

standard

output (subprocess.CalledProcessError 属性)

(subprocess.TimeoutExpired 属性)

(unittest.TestCase 属性)

output() (http.cookies.BaseCookie 方法)

(http.cookies.Morsel 方法)

output_charset (email.charset.Charset 属性)

output_charset() (gettext.NullTranslations 方法)

output_codec (email.charset.Charset 属性)

output_difference() (doctest.OutputChecker 方法)

OutputChecker (doctest 中的类)

OutputString() (http.cookies.Morsel 方法)

OutsideDestinationError

over() (nntplib.NNTP 方法)

Overflow (decimal 中的类)

OverflowError

(built-in exception), [1], [2], [3], [4], [5]

overlap() (statistics.NormalDist 方法)

overlaps() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

overlay() (curses.window 方法)

overload() (在 typing 模块中)

overloading

operator

overwrite() (curses.window 方法)

owner() (pathlib.Path 方法)

P

p (pdb command)

P_ALL() (在 os 模块中)

P_DETACH() (在 os 模块中)

P_NOWAIT() (在 os 模块中)

P_NOWAITO() (在 os 模块中)

P_OVERLAY() (在 os 模块中)

P_PGID() (在 os 模块中)

P_PID() (在 os 模块中)

P_PIDFD() (在 os 模块中)

P_WAIT() (在 os 模块中)

pack() (mailbox.MH 方法)

(struct.Struct 方法)

(在 struct 模块中)

pack_array() (xdrlib.Packer 方法)

pack_bytes() (xdrlib.Packer 方法)

pack_double() (xdrlib.Packer 方法)

pack_farray() (xdrlib.Packer 方法)

pack_float() (xdrlib.Packer 方法)

pack_fopaque() (xdrlib.Packer 方法)

pack_fstring() (xdrlib.Packer 方法)

pack_into() (struct.Struct 方法)

(在 struct 模块中)

pack_list() (xdrlib.Packer 方法)

pack_opaque() (xdrlib.Packer 方法)

pack_string() (xdrlib.Packer 方法)

package, [1]

namespace

portion

regular

package variable

__all__

Package() (在 importlib.resources 模块中)

packed (ipaddress.IPv4Address 属性)

(ipaddress.IPv6Address 属性)

Packer (xdrlib 中的类)

packing

binary data

packing (widgets)

PAGER

pair_content() (在 curses 模块中)

pair_number() (在 curses 模块中)

pairwise() (在 itertools 模块中)

PanedWindow (tkinter.tix 中的类)

parameter

call semantics

difference from argument

function definition

value, default

Parameter (inspect 中的类)

parameter -- 形参

ParameterizedMIMEHeader (email.headerregistry 中的类)

parameters (inspect.Signature 属性)

params (email.headerregistry.ParameterizedMIMEHeader 属性)

ParamSpec (typing 中的类)

ParamSpecArgs() (在 typing 模块中)

ParamSpecKwargs() (在 typing 模块中)

paramstyle() (在 sqlite3 模块中)

pardir() (在 os 模块中)

paren (2to3 fixer)

parent (importlib.machinery.ModuleSpec 属性)

(pathlib.PurePath 属性)

(pyclbr.Class 属性)

(pyclbr.Function 属性)

(urllib.request.BaseHandler 属性)

parent() (tkinter.ttk.Treeview 方法)

parent_process() (在 multiprocessing 模块中)

parenthesized form

parentNode (xml.dom.Node 属性)

parents (collections.ChainMap 属性)

(pathlib.PurePath 属性)

paretovariate() (在 random 模块中)

parse() (doctest.DocTestParser 方法)

(email.parser.BytesParser 方法)

(email.parser.Parser 方法)

(string.Formatter 方法)

(urllib.robotparser.RobotFileParser 方法)

(xml.etree.ElementTree.ElementTree 方法)

Parse() (xml.parsers.expat.xmlparser 方法)

parse() (xml.sax.xmlreader.XMLReader 方法)

(在 ast 模块中)

(在 cgi 模块中)

(在 xml.dom.minidom 模块中)

(在 xml.dom.pulldom 模块中)

(在 xml.etree.ElementTree 模块中)

(在 xml.sax 模块中)

parse_and_bind() (在 readline 模块中)

parse_args() (argparse.ArgumentParser 方法)

PARSE_COLNAMES() (在 sqlite3 模块中)

parse_config_h() (在 sysconfig 模块中)

PARSE_DECLTYPES() (在 sqlite3 模块中)

parse_header() (在 cgi 模块中)

parse_headers() (在 http.client 模块中)

parse_intermixed_args() (argparse.ArgumentParser 方法)

parse_known_args() (argparse.ArgumentParser 方法)

parse_known_intermixed_args() (argparse.ArgumentParser 方法)

parse_multipart() (在 cgi 模块中)

parse_qs() (在 urllib.parse 模块中)

parse_qsl() (在 urllib.parse 模块中)

parseaddr() (在 email.utils 模块中)

parsebytes() (email.parser.BytesParser 方法)

parsedate() (在 email.utils 模块中)

parsedate_to_datetime() (在 email.utils 模块中)

parsedate_tz() (在 email.utils 模块中)

ParseError (xml.etree.ElementTree 中的类)

ParseFile() (xml.parsers.expat.xmlparser 方法)

ParseFlags() (在 imaplib 模块中)

parser

Parser (email.parser 中的类)

ParserCreate() (在 xml.parsers.expat 模块中)

ParseResult (urllib.parse 中的类)

ParseResultBytes (urllib.parse 中的类)

parsestr() (email.parser.Parser 方法)

parseString() (在 xml.dom.minidom 模块中)

(在 xml.dom.pulldom 模块中)

(在 xml.sax 模块中)

parsing

URL

ParsingError

partial (asyncio.IncompleteReadError 属性)

partial() (imaplib.IMAP4 方法)

(在 functools 模块中)

partialmethod (functools 中的类)

parties (threading.Barrier 属性)

partition() (bytearray 方法)

(bytes 方法)

(str 方法)

parts (pathlib.PurePath 属性)

pass

语句

Pass (ast 中的类)

pass_() (poplib.POP3 方法)

Paste

patch() (在 test.support 模块中)

(在 unittest.mock 模块中)

patch.dict() (在 unittest.mock 模块中)

patch.multiple() (在 unittest.mock 模块中)

patch.object() (在 unittest.mock 模块中)

patch.stopall() (在 unittest.mock 模块中)

PATH, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40]

path

configuration file

hooks

module search, [1], [2], [3], [4], [5], [6], [7]

operations, [1]

path (http.cookiejar.Cookie 属性)

(http.server.BaseHTTPRequestHandler 属性)

(importlib.abc.FileLoader 属性)

(importlib.machinery.ExtensionFileLoader 属性)

(importlib.machinery.FileFinder 属性)

(importlib.machinery.SourceFileLoader 属性)

(importlib.machinery.SourcelessFileLoader 属性)

(in module sys), [1], [2], [3]

(os.DirEntry 属性)

Path (pathlib 中的类)

(zipfile 中的类)

path based finder

path based finder -- 基于路径的查找器

Path browser

path entry -- 路径入口

path entry finder -- 路径入口查找器

path entry hook -- 路径入口钩子

path hooks

path() (在 importlib.resources 模块中)

(在 sys 模块中)

path-like object -- 路径类对象

path_hook() (importlib.machinery.FileFinder 类方法)

path_hooks() (在 sys 模块中)

path_importer_cache() (在 sys 模块中)

path_mtime() (importlib.abc.SourceLoader 方法)

path_return_ok() (http.cookiejar.CookiePolicy 方法)

path_stats() (importlib.abc.SourceLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

pathconf() (在 os 模块中)

pathconf_names() (在 os 模块中)

PathEntryFinder (importlib.abc 中的类)

PATHEXT, [1], [2]

PathFinder (importlib.machinery 中的类)

pathlib

模块

PathLike (os 中的类)

pathname2url() (在 urllib.request 模块中)

pathsep() (在 os 模块中)

pattern (re.error 属性)

(re.Pattern 属性)

Pattern (typing 中的类)

pattern matching

pause() (在 signal 模块中)

pause_reading() (asyncio.ReadTransport 方法)

pause_writing() (asyncio.BaseProtocol 方法)

PAX_FORMAT() (在 tarfile 模块中)

pax_headers (tarfile.TarFile 属性)

(tarfile.TarInfo 属性)

pbkdf2_hmac() (在 hashlib 模块中)

pd() (在 turtle 模块中)

pdb

模块

Pdb (class in pdb)

(pdb 中的类)

pdf() (statistics.NormalDist 方法)

peek() (bz2.BZ2File 方法)

(gzip.GzipFile 方法)

(io.BufferedReader 方法)

(lzma.LZMAFile 方法)

(weakref.finalize 方法)

peer (smtpd.SMTPChannel 属性)

PEM_cert_to_DER_cert() (在 ssl 模块中)

pen() (在 turtle 模块中)

pencolor() (在 turtle 模块中)

pending (ssl.MemoryBIO 属性)

pending() (ssl.SSLSocket 方法)

PendingDeprecationWarning

pendown() (在 turtle 模块中)

pensize() (在 turtle 模块中)

penup() (在 turtle 模块中)

PEP

PERCENT() (在 token 模块中)

PERCENTEQUAL() (在 token 模块中)

perf_counter() (在 time 模块中)

perf_counter_ns() (在 time 模块中)

Performance

perm() (在 math 模块中)

PermissionError

permutations() (在 itertools 模块中)

Persist() (msilib.SummaryInformation 方法)

persistence

persistent

objects

persistent_id (pickle protocol)

persistent_id() (pickle.Pickler 方法)

persistent_load (pickle protocol)

persistent_load() (pickle.Unpickler 方法)

PF_CAN() (在 socket 模块中)

PF_PACKET() (在 socket 模块中)

PF_RDS() (在 socket 模块中)

pformat() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

pgettext() (gettext.GNUTranslations 方法)

(gettext.NullTranslations 方法)

(在 gettext 模块中)

PGO() (在 test.support 模块中)

phase() (在 cmath 模块中)

Philbrick, Geoff

physical line, [1], [2]

pi() (xml.etree.ElementTree.TreeBuilder 方法)

(在 cmath 模块中)

(在 math 模块中)

pickle

模块, [1], [2], [3], [4]

pickle() (在 copyreg 模块中)

PickleBuffer (pickle 中的类)

PickleError

Pickler (pickle 中的类)

pickletools

模块

pickletools command line option

--annotate

--indentlevel=<num>

--memo

--output=<file>

--preamble=<preamble>

-a

-l

-m

-o

-p

pickling

objects

PicklingError

pid (asyncio.subprocess.Process 属性)

(multiprocessing.Process 属性)

(subprocess.Popen 属性)

pidfd_open() (在 os 模块中)

pidfd_send_signal() (在 signal 模块中)

PidfdChildWatcher (asyncio 中的类)

PIP_USER

Pipe() (在 multiprocessing 模块中)

pipe() (在 os 模块中)

PIPE() (在 subprocess 模块中)

pipe2() (在 os 模块中)

PIPE_BUF() (在 select 模块中)

pipe_connection_lost() (asyncio.SubprocessProtocol 方法)

pipe_data_received() (asyncio.SubprocessProtocol 方法)

PIPE_MAX_SIZE() (在 test.support 模块中)

pipes

模块

PKG_DIRECTORY() (在 imp 模块中)

pkgutil

模块

placeholder (textwrap.TextWrapper 属性)

PLAT

platform

模块

platform (in module sys)

platform() (在 platform 模块中)

(在 sys 模块中)

platlibdir() (在 sys 模块中)

PlaySound() (在 winsound 模块中)

plist

file

plistlib

模块

plock() (在 os 模块中)

plus

plus() (decimal.Context 方法)

PLUS() (在 token 模块中)

PLUSEQUAL() (在 token 模块中)

pm() (在 pdb 模块中)

POINTER() (在 ctypes 模块中)

pointer() (在 ctypes 模块中)

polar() (在 cmath 模块中)

Policy (email.policy 中的类)

poll() (multiprocessing.connection.Connection 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(subprocess.Popen 方法)

(在 select 模块中)

PollSelector (selectors 中的类)

Pool (multiprocessing.pool 中的类)

pop() (array.array 方法)

(collections.deque 方法)

(dict 方法)

(frozenset 方法)

(mailbox.Mailbox 方法)

(sequence method)

POP3

protocol

POP3 (poplib 中的类)

POP3_SSL (poplib 中的类)

pop_all() (contextlib.ExitStack 方法)

POP_BLOCK (opcode)

POP_EXCEPT (opcode)

POP_JUMP_IF_FALSE (opcode)

POP_JUMP_IF_TRUE (opcode)

pop_source() (shlex.shlex 方法)

POP_TOP (opcode)

Popen (subprocess 中的类)

popen() (in module os), [1]

(在 os 模块中)

popitem() (collections.OrderedDict 方法)

(dict 方法)

(mailbox.Mailbox 方法)

popleft() (collections.deque 方法)

poplib

模块

PopupMenu (tkinter.tix 中的类)

port (http.cookiejar.Cookie 属性)

port_specified (http.cookiejar.Cookie 属性)

portion

package

portion -- 部分

pos (json.JSONDecodeError 属性)

(re.error 属性)

(re.Match 属性)

pos() (在 operator 模块中)

(在 turtle 模块中)

position (xml.etree.ElementTree.ParseError 属性)

position() (在 turtle 模块中)

positional argument -- 位置参数

POSIX

I/O control

threads

posix

模块

POSIX Shared Memory

POSIX_FADV_DONTNEED() (在 os 模块中)

POSIX_FADV_NOREUSE() (在 os 模块中)

POSIX_FADV_NORMAL() (在 os 模块中)

POSIX_FADV_RANDOM() (在 os 模块中)

POSIX_FADV_SEQUENTIAL() (在 os 模块中)

POSIX_FADV_WILLNEED() (在 os 模块中)

posix_fadvise() (在 os 模块中)

posix_fallocate() (在 os 模块中)

posix_spawn() (在 os 模块中)

POSIX_SPAWN_CLOSE() (在 os 模块中)

POSIX_SPAWN_DUP2() (在 os 模块中)

POSIX_SPAWN_OPEN() (在 os 模块中)

posix_spawnp() (在 os 模块中)

POSIXLY_CORRECT

PosixPath (pathlib 中的类)

post() (nntplib.NNTP 方法)

(ossaudiodev.oss_audio_device 方法)

post_handshake_auth (ssl.SSLContext 属性)

post_mortem() (在 pdb 模块中)

post_setup() (venv.EnvBuilder 方法)

postcmd() (cmd.Cmd 方法)

postloop() (cmd.Cmd 方法)

pow

內置函数, [1], [2], [3], [4], [5]

Pow (ast 中的类)

pow()

內置函数

pow() (在 math 模块中)

(在 operator 模块中)

power

operation

power() (decimal.Context 方法)

pp (pdb command)

pp() (在 pprint 模块中)

pprint

模块

pprint() (pprint.PrettyPrinter 方法)

(在 pprint 模块中)

prcal() (在 calendar 模块中)

pread() (在 os 模块中)

preadv() (在 os 模块中)

preamble (email.message.EmailMessage 属性)

(email.message.Message 属性)

precedence

operator

precmd() (cmd.Cmd 方法)

prefix (xml.dom.Attr 属性)

(xml.dom.Node 属性)

(zipimport.zipimporter 属性)

PREFIX() (在 distutils.sysconfig 模块中)

prefix() (在 sys 模块中)

PREFIXES() (在 site 模块中)

prefixlen (ipaddress.IPv4Network 属性)

(ipaddress.IPv6Network 属性)

preloop() (cmd.Cmd 方法)

prepare() (graphlib.TopologicalSorter 方法)

(logging.handlers.QueueHandler 方法)

(logging.handlers.QueueListener 方法)

prepare_class() (在 types 模块中)

prepare_input_source() (在 xml.sax.saxutils 模块中)

PrepareProtocol (sqlite3 中的类)

prepend() (pipes.Template 方法)

preprocess() (distutils.ccompiler.CCompiler 方法)

PrettyPrinter (pprint 中的类)

prev() (tkinter.ttk.Treeview 方法)

previousSibling (xml.dom.Node 属性)

primary

print

內置函数

print (2to3 fixer)

print()

內置函数

print() (built-in function)

__str__() (object method)

print_callees() (pstats.Stats 方法)

print_callers() (pstats.Stats 方法)

print_directory() (在 cgi 模块中)

print_environ() (在 cgi 模块中)

print_environ_usage() (在 cgi 模块中)

print_exc() (timeit.Timer 方法)

(在 traceback 模块中)

print_exception() (在 traceback 模块中)

PRINT_EXPR (opcode)

print_form() (在 cgi 模块中)

print_help() (argparse.ArgumentParser 方法)

print_last() (在 traceback 模块中)

print_stack() (asyncio.Task 方法)

(在 traceback 模块中)

print_stats() (profile.Profile 方法)

(pstats.Stats 方法)

print_tb() (在 traceback 模块中)

print_usage() (argparse.ArgumentParser 方法)

(optparse.OptionParser 方法)

print_version() (optparse.OptionParser 方法)

print_warning() (在 test.support 模块中)

printable() (在 string 模块中)

printdir() (zipfile.ZipFile 方法)

printf-style formatting, [1]

PRIO_PGRP() (在 os 模块中)

PRIO_PROCESS() (在 os 模块中)

PRIO_USER() (在 os 模块中)

PriorityQueue (asyncio 中的类)

(queue 中的类)

private

names

prlimit() (在 resource 模块中)

prmonth() (calendar.TextCalendar 方法)

(在 calendar 模块中)

ProactorEventLoop (asyncio 中的类)

procedure

call

process

group, [1]

id

id of parent

killing, [1]

scheduling priority, [1]

signalling, [1]

Process (multiprocessing 中的类)

process() (logging.LoggerAdapter 方法)

process_exited() (asyncio.SubprocessProtocol 方法)

process_message() (smtpd.SMTPServer 方法)

process_request() (socketserver.BaseServer 方法)

process_time() (在 time 模块中)

process_time_ns() (在 time 模块中)

process_tokens() (在 tabnanny 模块中)

ProcessError

processes, light-weight

processingInstruction() (xml.sax.handler.ContentHandler 方法)

ProcessingInstruction() (在 xml.etree.ElementTree 模块中)

ProcessingInstructionHandler() (xml.parsers.expat.xmlparser 方法)

ProcessLookupError

processor time, [1]

processor() (在 platform 模块中)

ProcessPoolExecutor (concurrent.futures 中的类)

prod() (在 math 模块中)

product() (在 itertools 模块中)

profile

模块

Profile (profile 中的类)

profile function, [1], [2], [3]

PROFILE_TASK

profiler, [1]

profiling, deterministic

program

ProgrammingError

Progressbar (tkinter.ttk 中的类)

prompt (cmd.Cmd 属性)

prompt_user_passwd() (urllib.request.FancyURLopener 方法)

prompts, interpreter

propagate (logging.Logger 属性)

property (內置类)

property list

property_declaration_handler() (在 xml.sax.handler 模块中)

property_dom_node() (在 xml.sax.handler 模块中)

property_lexical_handler() (在 xml.sax.handler 模块中)

property_xml_string() (在 xml.sax.handler 模块中)

PropertyMock (unittest.mock 中的类)

prot_c() (ftplib.FTP_TLS 方法)

prot_p() (ftplib.FTP_TLS 方法)

proto (socket.socket 属性)

protocol

CGI

context management

copy

FTP, [1]

HTTP, [1], [2], [3], [4], [5]

IMAP4

IMAP4_SSL

IMAP4_stream

iterator

NNTP

POP3

SMTP

Telnet

Protocol (asyncio 中的类)

protocol (ssl.SSLContext 属性)

Protocol (typing 中的类)

PROTOCOL_SSLv2() (在 ssl 模块中)

PROTOCOL_SSLv23() (在 ssl 模块中)

PROTOCOL_SSLv3() (在 ssl 模块中)

PROTOCOL_TLS() (在 ssl 模块中)

PROTOCOL_TLS_CLIENT() (在 ssl 模块中)

PROTOCOL_TLS_SERVER() (在 ssl 模块中)

PROTOCOL_TLSv1() (在 ssl 模块中)

PROTOCOL_TLSv1_1() (在 ssl 模块中)

PROTOCOL_TLSv1_2() (在 ssl 模块中)

protocol_version (http.server.BaseHTTPRequestHandler 属性)

PROTOCOL_VERSION (imaplib.IMAP4 属性)

ProtocolError (xmlrpc.client 中的类)

provisional API -- 暂定 API

provisional package -- 暂定包

proxy() (在 weakref 模块中)

proxyauth() (imaplib.IMAP4 方法)

ProxyBasicAuthHandler (urllib.request 中的类)

ProxyDigestAuthHandler (urllib.request 中的类)

ProxyHandler (urllib.request 中的类)

ProxyType() (在 weakref 模块中)

ProxyTypes() (在 weakref 模块中)

pryear() (calendar.TextCalendar 方法)

ps1() (在 sys 模块中)

ps2() (在 sys 模块中)

pstats

模块

pstdev() (在 statistics 模块中)

pthread_getcpuclockid() (在 time 模块中)

pthread_kill() (在 signal 模块中)

pthread_sigmask() (在 signal 模块中)

pthreads

pty

模块, [1]

pu() (在 turtle 模块中)

publicId (xml.dom.DocumentType 属性)

PullDom (xml.dom.pulldom 中的类)

punctuation() (在 string 模块中)

punctuation_chars (shlex.shlex 属性)

PurePath (pathlib 中的类)

PurePosixPath (pathlib 中的类)

PureProxy (smtpd 中的类)

PureWindowsPath (pathlib 中的类)

purge() (在 re 模块中)

Purpose.CLIENT_AUTH() (在 ssl 模块中)

Purpose.SERVER_AUTH() (在 ssl 模块中)

push() (asynchat.async_chat 方法)

(code.InteractiveConsole 方法)

(contextlib.ExitStack 方法)

push_async_callback() (contextlib.AsyncExitStack 方法)

push_async_exit() (contextlib.AsyncExitStack 方法)

push_source() (shlex.shlex 方法)

push_token() (shlex.shlex 方法)

push_with_producer() (asynchat.async_chat 方法)

pushbutton() (msilib.Dialog 方法)

put() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(multiprocessing.SimpleQueue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

put_nowait() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

putch() (在 msvcrt 模块中)

putenv() (在 os 模块中)

putheader() (http.client.HTTPConnection 方法)

putp() (在 curses 模块中)

putrequest() (http.client.HTTPConnection 方法)

putwch() (在 msvcrt 模块中)

putwin() (curses.window 方法)

pvariance() (在 statistics 模块中)

pwd

模块, [1]

pwd() (ftplib.FTP 方法)

pwrite() (在 os 模块中)

pwritev() (在 os 模块中)

Py_ABS (C macro)

Py_AddPendingCall (C function)

Py_AddPendingCall()

Py_AtExit (C function)

PY_AUDIT_READ

Py_BEGIN_ALLOW_THREADS

(C macro)

Py_BLOCK_THREADS (C macro)

Py_buffer (C type)

Py_buffer.buf (C member)

Py_buffer.format (C member)

Py_buffer.internal (C member)

Py_buffer.itemsize (C member)

Py_buffer.len (C member)

Py_buffer.ndim (C member)

Py_buffer.obj (C member)

Py_buffer.readonly (C member)

Py_buffer.shape (C member)

Py_buffer.strides (C member)

Py_buffer.suboffsets (C member)

Py_BuildValue (C function)

Py_BytesMain (C function)

Py_BytesWarningFlag (C var)

Py_CHARMASK (C macro)

Py_CLEAR (C function)

py_compile

模块

PY_COMPILED() (在 imp 模块中)

Py_CompileString (C function)

Py_CompileString(), [1], [2]

Py_CompileStringExFlags (C function)

Py_CompileStringFlags (C function)

Py_CompileStringObject (C function)

Py_complex (C type)

Py_DebugFlag (C var)

Py_DecodeLocale (C function)

Py_DECREF (C function)

Py_DecRef (C function)

Py_DECREF()

Py_DEPRECATED (C macro)

Py_DontWriteBytecodeFlag (C var)

Py_Ellipsis (C var)

Py_EncodeLocale (C function)

Py_END_ALLOW_THREADS

(C macro)

Py_EndInterpreter (C function)

Py_EnterRecursiveCall (C function)

Py_eval_input (C var)

Py_Exit (C function)

Py_False (C var)

Py_FatalError (C function)

Py_FatalError()

Py_FdIsInteractive (C function)

Py_file_input (C var)

Py_Finalize (C function)

Py_FinalizeEx (C function)

Py_FinalizeEx(), [1], [2], [3], [4]

PY_FROZEN() (在 imp 模块中)

Py_FrozenFlag (C var)

Py_GenericAlias (C function)

Py_GenericAliasType (C var)

Py_GetArgcArgv (C function)

Py_GetBuildInfo (C function)

Py_GetCompiler (C function)

Py_GetCopyright (C function)

Py_GETENV (C macro)

Py_GetExecPrefix (C function)

Py_GetExecPrefix()

Py_GetPath (C function)

Py_GetPath(), [1], [2]

Py_GetPlatform (C function)

Py_GetPrefix (C function)

Py_GetPrefix()

Py_GetProgramFullPath (C function)

Py_GetProgramFullPath()

Py_GetProgramName (C function)

Py_GetPythonHome (C function)

Py_GetVersion (C function)

Py_HashRandomizationFlag (C var)

Py_IgnoreEnvironmentFlag (C var)

Py_INCREF (C function)

Py_IncRef (C function)

Py_INCREF()

Py_Initialize (C function)

Py_Initialize(), [1], [2], [3]

Py_InitializeEx (C function)

Py_InitializeFromConfig (C function)

Py_InspectFlag (C var)

Py_InteractiveFlag (C var)

Py_Is (C function)

Py_IS_TYPE (C function)

Py_IsFalse (C function)

Py_IsInitialized (C function)

Py_IsInitialized()

Py_IsNone (C function)

Py_IsolatedFlag (C var)

Py_IsTrue (C function)

Py_LeaveRecursiveCall (C function)

Py_LegacyWindowsFSEncodingFlag (C var)

Py_LegacyWindowsStdioFlag (C var)

Py_LIMITED_API (C macro)

Py_Main (C function)

PY_MAJOR_VERSION (C macro)

Py_MAX (C macro)

Py_MEMBER_SIZE (C macro)

PY_MICRO_VERSION (C macro)

Py_MIN (C macro)

PY_MINOR_VERSION (C macro)

Py_mod_create (C macro)

Py_mod_create.create_module (C function)

Py_mod_exec (C macro)

Py_mod_exec.exec_module (C function)

Py_NewInterpreter (C function)

Py_NewRef (C function)

Py_None (C var)

Py_NoSiteFlag (C var)

Py_NotImplemented (C var)

Py_NoUserSiteDirectory (C var)

py_object (ctypes 中的类)

Py_OptimizeFlag (C var)

Py_PreInitialize (C function)

Py_PreInitializeFromArgs (C function)

Py_PreInitializeFromBytesArgs (C function)

Py_PRINT_RAW

PY_PYTHON

Py_QuietFlag (C var)

Py_REFCNT (C function)

PY_RELEASE_LEVEL (C macro)

PY_RELEASE_SERIAL (C macro)

Py_ReprEnter (C function)

Py_ReprLeave (C function)

Py_RETURN_FALSE (C macro)

Py_RETURN_NONE (C macro)

Py_RETURN_NOTIMPLEMENTED (C macro)

Py_RETURN_TRUE (C macro)

Py_RunMain (C function)

Py_SET_REFCNT (C function)

Py_SET_SIZE (C function)

Py_SET_TYPE (C function)

Py_SetPath (C function)

Py_SetPath()

Py_SetProgramName (C function)

Py_SetProgramName(), [1], [2], [3]

Py_SetPythonHome (C function)

Py_SetStandardStreamEncoding (C function)

Py_single_input (C var)

Py_SIZE (C function)

PY_SOURCE() (在 imp 模块中)

Py_ssize_t (C type)

PY_SSIZE_T_MAX

Py_STRINGIFY (C macro)

Py_TPFLAGS_BASE_EXC_SUBCLASS (內置变量)

Py_TPFLAGS_BASETYPE (內置变量)

Py_TPFLAGS_BYTES_SUBCLASS (內置变量)

Py_TPFLAGS_DEFAULT (內置变量)

Py_TPFLAGS_DICT_SUBCLASS (內置变量)

Py_TPFLAGS_DISALLOW_INSTANTIATION (內置变量)

Py_TPFLAGS_HAVE_FINALIZE (內置变量)

Py_TPFLAGS_HAVE_GC (內置变量)

Py_TPFLAGS_HAVE_VECTORCALL (內置变量)

Py_TPFLAGS_HEAPTYPE (內置变量)

Py_TPFLAGS_IMMUTABLETYPE (內置变量)

Py_TPFLAGS_LIST_SUBCLASS (內置变量)

Py_TPFLAGS_LONG_SUBCLASS (內置变量)

Py_TPFLAGS_MAPPING (內置变量)

Py_TPFLAGS_METHOD_DESCRIPTOR (內置变量)

Py_TPFLAGS_READY (內置变量)

Py_TPFLAGS_READYING (內置变量)

Py_TPFLAGS_SEQUENCE (內置变量)

Py_TPFLAGS_TUPLE_SUBCLASS (內置变量)

Py_TPFLAGS_TYPE_SUBCLASS (內置变量)

Py_TPFLAGS_UNICODE_SUBCLASS (內置变量)

Py_tracefunc (C type)

Py_True (C var)

Py_tss_NEEDS_INIT (C macro)

Py_tss_t (C type)

Py_TYPE (C function)

Py_UCS1 (C type)

Py_UCS2 (C type)

Py_UCS4 (C type)

Py_UNBLOCK_THREADS (C macro)

Py_UnbufferedStdioFlag (C var)

Py_UNICODE (C type)

Py_UNICODE_IS_HIGH_SURROGATE (C macro)

Py_UNICODE_IS_LOW_SURROGATE (C macro)

Py_UNICODE_IS_SURROGATE (C macro)

Py_UNICODE_ISALNUM (C function)

Py_UNICODE_ISALPHA (C function)

Py_UNICODE_ISDECIMAL (C function)

Py_UNICODE_ISDIGIT (C function)

Py_UNICODE_ISLINEBREAK (C function)

Py_UNICODE_ISLOWER (C function)

Py_UNICODE_ISNUMERIC (C function)

Py_UNICODE_ISPRINTABLE (C function)

Py_UNICODE_ISSPACE (C function)

Py_UNICODE_ISTITLE (C function)

Py_UNICODE_ISUPPER (C function)

Py_UNICODE_JOIN_SURROGATES (C macro)

Py_UNICODE_TODECIMAL (C function)

Py_UNICODE_TODIGIT (C function)

Py_UNICODE_TOLOWER (C function)

Py_UNICODE_TONUMERIC (C function)

Py_UNICODE_TOTITLE (C function)

Py_UNICODE_TOUPPER (C function)

Py_UNREACHABLE (C macro)

Py_UNUSED (C macro)

Py_VaBuildValue (C function)

PY_VECTORCALL_ARGUMENTS_OFFSET (C macro)

Py_VerboseFlag (C var)

PY_VERSION_HEX (C macro)

Py_VISIT (C function)

Py_XDECREF (C function)

Py_XDECREF()

Py_XINCREF (C function)

Py_XNewRef (C function)

PyAIter_Check (C function)

PyAnySet_Check (C function)

PyAnySet_CheckExact (C function)

PyArg_Parse (C function)

PyArg_ParseTuple (C function)

PyArg_ParseTuple()

PyArg_ParseTupleAndKeywords (C function)

PyArg_ParseTupleAndKeywords()

PyArg_UnpackTuple (C function)

PyArg_ValidateKeywordArguments (C function)

PyArg_VaParse (C function)

PyArg_VaParseTupleAndKeywords (C function)

PyASCIIObject (C type)

PyAsyncMethods (C type)

PyAsyncMethods.am_aiter (C member)

PyAsyncMethods.am_anext (C member)

PyAsyncMethods.am_await (C member)

PyAsyncMethods.am_send (C member)

PyBool_Check (C function)

PyBool_FromLong (C function)

PyBUF_ANY_CONTIGUOUS (C macro)

PyBUF_C_CONTIGUOUS (C macro)

PyBUF_CONTIG (C macro)

PyBUF_CONTIG_RO (C macro)

PyBUF_F_CONTIGUOUS (C macro)

PyBUF_FORMAT (C macro)

PyBUF_FULL (C macro)

PyBUF_FULL_RO (C macro)

PyBUF_INDIRECT (C macro)

PyBUF_ND (C macro)

PyBUF_RECORDS (C macro)

PyBUF_RECORDS_RO (C macro)

PyBUF_SIMPLE (C macro)

PyBUF_STRIDED (C macro)

PyBUF_STRIDED_RO (C macro)

PyBUF_STRIDES (C macro)

PyBUF_WRITABLE (C macro)

PyBuffer_FillContiguousStrides (C function)

PyBuffer_FillInfo (C function)

PyBuffer_FromContiguous (C function)

PyBuffer_GetPointer (C function)

PyBuffer_IsContiguous (C function)

PyBuffer_Release (C function)

PyBuffer_SizeFromFormat (C function)

PyBuffer_ToContiguous (C function)

PyBufferProcs

(C type)

PyBufferProcs.bf_getbuffer (C member)

PyBufferProcs.bf_releasebuffer (C member)

PyByteArray_AS_STRING (C function)

PyByteArray_AsString (C function)

PyByteArray_Check (C function)

PyByteArray_CheckExact (C function)

PyByteArray_Concat (C function)

PyByteArray_FromObject (C function)

PyByteArray_FromStringAndSize (C function)

PyByteArray_GET_SIZE (C function)

PyByteArray_Resize (C function)

PyByteArray_Size (C function)

PyByteArray_Type (C var)

PyByteArrayObject (C type)

PyBytes_AS_STRING (C function)

PyBytes_AsString (C function)

PyBytes_AsStringAndSize (C function)

PyBytes_Check (C function)

PyBytes_CheckExact (C function)

PyBytes_Concat (C function)

PyBytes_ConcatAndDel (C function)

PyBytes_FromFormat (C function)

PyBytes_FromFormatV (C function)

PyBytes_FromObject (C function)

PyBytes_FromString (C function)

PyBytes_FromStringAndSize (C function)

PyBytes_GET_SIZE (C function)

PyBytes_Size (C function)

PyBytes_Type (C var)

PyBytesObject (C type)

pycache_prefix() (在 sys 模块中)

PyCallable_Check (C function)

PyCallIter_Check (C function)

PyCallIter_New (C function)

PyCallIter_Type (C var)

PyCapsule (C type)

PyCapsule_CheckExact (C function)

PyCapsule_Destructor (C type)

PyCapsule_GetContext (C function)

PyCapsule_GetDestructor (C function)

PyCapsule_GetName (C function)

PyCapsule_GetPointer (C function)

PyCapsule_Import (C function)

PyCapsule_IsValid (C function)

PyCapsule_New (C function)

PyCapsule_SetContext (C function)

PyCapsule_SetDestructor (C function)

PyCapsule_SetName (C function)

PyCapsule_SetPointer (C function)

PyCell_Check (C function)

PyCell_GET (C function)

PyCell_Get (C function)

PyCell_New (C function)

PyCell_SET (C function)

PyCell_Set (C function)

PyCell_Type (C var)

PyCellObject (C type)

PyCF_ALLOW_TOP_LEVEL_AWAIT() (在 ast 模块中)

PyCF_ONLY_AST() (在 ast 模块中)

PyCF_TYPE_COMMENTS() (在 ast 模块中)

PyCFunction (C type)

PyCFunctionWithKeywords (C type)

PycInvalidationMode (py_compile 中的类)

pyclbr

模块

PyCMethod (C type)

PyCode_Addr2Line (C function)

PyCode_Check (C function)

PyCode_GetNumFree (C function)

PyCode_New (C function)

PyCode_NewEmpty (C function)

PyCode_NewWithPosOnlyArgs (C function)

PyCode_Type (C var)

PyCodec_BackslashReplaceErrors (C function)

PyCodec_Decode (C function)

PyCodec_Decoder (C function)

PyCodec_Encode (C function)

PyCodec_Encoder (C function)

PyCodec_IgnoreErrors (C function)

PyCodec_IncrementalDecoder (C function)

PyCodec_IncrementalEncoder (C function)

PyCodec_KnownEncoding (C function)

PyCodec_LookupError (C function)

PyCodec_NameReplaceErrors (C function)

PyCodec_Register (C function)

PyCodec_RegisterError (C function)

PyCodec_ReplaceErrors (C function)

PyCodec_StreamReader (C function)

PyCodec_StreamWriter (C function)

PyCodec_StrictErrors (C function)

PyCodec_Unregister (C function)

PyCodec_XMLCharRefReplaceErrors (C function)

PyCodeObject (C type)

PyCompactUnicodeObject (C type)

PyCompileError

PyCompilerFlags (C struct)

PyCompilerFlags.cf_feature_version (C member)

PyCompilerFlags.cf_flags (C member)

PyComplex_AsCComplex (C function)

PyComplex_Check (C function)

PyComplex_CheckExact (C function)

PyComplex_FromCComplex (C function)

PyComplex_FromDoubles (C function)

PyComplex_ImagAsDouble (C function)

PyComplex_RealAsDouble (C function)

PyComplex_Type (C var)

PyComplexObject (C type)

PyConfig (C type)

PyConfig.argv (C member)

PyConfig.base_exec_prefix (C member)

PyConfig.base_executable (C member)

PyConfig.base_prefix (C member)

PyConfig.buffered_stdio (C member)

PyConfig.bytes_warning (C member)

PyConfig.check_hash_pycs_mode (C member)

PyConfig.configure_c_stdio (C member)

PyConfig.dev_mode (C member)

PyConfig.dump_refs (C member)

PyConfig.exec_prefix (C member)

PyConfig.executable (C member)

PyConfig.faulthandler (C member)

PyConfig.filesystem_encoding (C member)

PyConfig.filesystem_errors (C member)

PyConfig.hash_seed (C member)

PyConfig.home (C member)

PyConfig.import_time (C member)

PyConfig.inspect (C member)

PyConfig.install_signal_handlers (C member)

PyConfig.interactive (C member)

PyConfig.isolated (C member)

PyConfig.legacy_windows_stdio (C member)

PyConfig.malloc_stats (C member)

PyConfig.module_search_paths (C member)

PyConfig.module_search_paths_set (C member)

PyConfig.optimization_level (C member)

PyConfig.orig_argv (C member)

PyConfig.parse_argv (C member)

PyConfig.parser_debug (C member)

PyConfig.pathconfig_warnings (C member)

PyConfig.platlibdir (C member)

PyConfig.prefix (C member)

PyConfig.program_name (C member)

PyConfig.pycache_prefix (C member)

PyConfig.PyConfig_Clear (C function)

PyConfig.PyConfig_InitIsolatedConfig (C function)

PyConfig.PyConfig_InitPythonConfig (C function)

PyConfig.PyConfig_Read (C function)

PyConfig.PyConfig_SetArgv (C function)

PyConfig.PyConfig_SetBytesArgv (C function)

PyConfig.PyConfig_SetBytesString (C function)

PyConfig.PyConfig_SetString (C function)

PyConfig.PyConfig_SetWideStringList (C function)

PyConfig.pythonpath_env (C member)

PyConfig.quiet (C member)

PyConfig.run_command (C member)

PyConfig.run_filename (C member)

PyConfig.run_module (C member)

PyConfig.show_ref_count (C member)

PyConfig.site_import (C member)

PyConfig.skip_source_first_line (C member)

PyConfig.stdio_encoding (C member)

PyConfig.stdio_errors (C member)

PyConfig.tracemalloc (C member)

PyConfig.use_environment (C member)

PyConfig.use_hash_seed (C member)

PyConfig.user_site_directory (C member)

PyConfig.verbose (C member)

PyConfig.warn_default_encoding (C member)

PyConfig.warnoptions (C member)

PyConfig.write_bytecode (C member)

PyConfig.xoptions (C member)

PyContext (C type)

PyContext_CheckExact (C function)

PyContext_Copy (C function)

PyContext_CopyCurrent (C function)

PyContext_Enter (C function)

PyContext_Exit (C function)

PyContext_New (C function)

PyContext_Type (C var)

PyContextToken (C type)

PyContextToken_CheckExact (C function)

PyContextToken_Type (C var)

PyContextVar (C type)

PyContextVar_CheckExact (C function)

PyContextVar_Get (C function)

PyContextVar_New (C function)

PyContextVar_Reset (C function)

PyContextVar_Set (C function)

PyContextVar_Type (C var)

PyCoro_CheckExact (C function)

PyCoro_New (C function)

PyCoro_Type (C var)

PyCoroObject (C type)

PyDate_Check (C function)

PyDate_CheckExact (C function)

PyDate_FromDate (C function)

PyDate_FromTimestamp (C function)

PyDateTime_Check (C function)

PyDateTime_CheckExact (C function)

PyDateTime_DATE_GET_FOLD (C function)

PyDateTime_DATE_GET_HOUR (C function)

PyDateTime_DATE_GET_MICROSECOND (C function)

PyDateTime_DATE_GET_MINUTE (C function)

PyDateTime_DATE_GET_SECOND (C function)

PyDateTime_DATE_GET_TZINFO (C function)

PyDateTime_DELTA_GET_DAYS (C function)

PyDateTime_DELTA_GET_MICROSECONDS (C function)

PyDateTime_DELTA_GET_SECONDS (C function)

PyDateTime_FromDateAndTime (C function)

PyDateTime_FromDateAndTimeAndFold (C function)

PyDateTime_FromTimestamp (C function)

PyDateTime_GET_DAY (C function)

PyDateTime_GET_MONTH (C function)

PyDateTime_GET_YEAR (C function)

PyDateTime_TIME_GET_FOLD (C function)

PyDateTime_TIME_GET_HOUR (C function)

PyDateTime_TIME_GET_MICROSECOND (C function)

PyDateTime_TIME_GET_MINUTE (C function)

PyDateTime_TIME_GET_SECOND (C function)

PyDateTime_TIME_GET_TZINFO (C function)

PyDateTime_TimeZone_UTC (C var)

PyDelta_Check (C function)

PyDelta_CheckExact (C function)

PyDelta_FromDSU (C function)

PyDescr_IsData (C function)

PyDescr_NewClassMethod (C function)

PyDescr_NewGetSet (C function)

PyDescr_NewMember (C function)

PyDescr_NewMethod (C function)

PyDescr_NewWrapper (C function)

PyDict_Check (C function)

PyDict_CheckExact (C function)

PyDict_Clear (C function)

PyDict_Contains (C function)

PyDict_Copy (C function)

PyDict_DelItem (C function)

PyDict_DelItemString (C function)

PyDict_GetItem (C function)

PyDict_GetItemString (C function)

PyDict_GetItemWithError (C function)

PyDict_Items (C function)

PyDict_Keys (C function)

PyDict_Merge (C function)

PyDict_MergeFromSeq2 (C function)

PyDict_New (C function)

PyDict_Next (C function)

PyDict_SetDefault (C function)

PyDict_SetItem (C function)

PyDict_SetItemString (C function)

PyDict_Size (C function)

PyDict_Type (C var)

PyDict_Update (C function)

PyDict_Values (C function)

PyDictObject (C type)

PyDictProxy_New (C function)

PyDLL (ctypes 中的类)

pydoc

模块

PyDoc_STR (C macro)

PyDoc_STRVAR (C macro)

PyErr_BadArgument (C function)

PyErr_BadInternalCall (C function)

PyErr_CheckSignals (C function)

PyErr_Clear (C function)

PyErr_Clear(), [1]

PyErr_ExceptionMatches (C function)

PyErr_ExceptionMatches()

PyErr_Fetch (C function)

PyErr_Fetch()

PyErr_Format (C function)

PyErr_FormatV (C function)

PyErr_GetExcInfo (C function)

PyErr_GivenExceptionMatches (C function)

PyErr_NewException (C function)

PyErr_NewExceptionWithDoc (C function)

PyErr_NoMemory (C function)

PyErr_NormalizeException (C function)

PyErr_Occurred (C function)

PyErr_Occurred()

PyErr_Print (C function)

PyErr_PrintEx (C function)

PyErr_ResourceWarning (C function)

PyErr_Restore (C function)

PyErr_Restore()

PyErr_SetExcFromWindowsErr (C function)

PyErr_SetExcFromWindowsErrWithFilename (C function)

PyErr_SetExcFromWindowsErrWithFilenameObject (C function)

PyErr_SetExcFromWindowsErrWithFilenameObjects (C function)

PyErr_SetExcInfo (C function)

PyErr_SetFromErrno (C function)

PyErr_SetFromErrnoWithFilename (C function)

PyErr_SetFromErrnoWithFilenameObject (C function)

PyErr_SetFromErrnoWithFilenameObjects (C function)

PyErr_SetFromWindowsErr (C function)

PyErr_SetFromWindowsErrWithFilename (C function)

PyErr_SetImportError (C function)

PyErr_SetImportErrorSubclass (C function)

PyErr_SetInterrupt (C function)

PyErr_SetInterruptEx (C function)

PyErr_SetNone (C function)

PyErr_SetObject (C function)

PyErr_SetString (C function)

PyErr_SetString()

PyErr_SyntaxLocation (C function)

PyErr_SyntaxLocationEx (C function)

PyErr_SyntaxLocationObject (C function)

PyErr_WarnEx (C function)

PyErr_WarnExplicit (C function)

PyErr_WarnExplicitObject (C function)

PyErr_WarnFormat (C function)

PyErr_WriteUnraisable (C function)

PyEval_AcquireLock (C function)

PyEval_AcquireThread (C function)

PyEval_AcquireThread()

PyEval_EvalCode (C function)

PyEval_EvalCodeEx (C function)

PyEval_EvalFrame (C function)

PyEval_EvalFrameEx (C function)

PyEval_GetBuiltins (C function)

PyEval_GetFrame (C function)

PyEval_GetFuncDesc (C function)

PyEval_GetFuncName (C function)

PyEval_GetGlobals (C function)

PyEval_GetLocals (C function)

PyEval_InitThreads (C function)

PyEval_InitThreads()

PyEval_MergeCompilerFlags (C function)

PyEval_ReleaseLock (C function)

PyEval_ReleaseThread (C function)

PyEval_ReleaseThread()

PyEval_RestoreThread (C function)

PyEval_RestoreThread(), [1]

PyEval_SaveThread (C function)

PyEval_SaveThread(), [1]

PyEval_SetProfile (C function)

PyEval_SetTrace (C function)

PyEval_ThreadsInitialized (C function)

PyExc_ArithmeticError

PyExc_AssertionError

PyExc_AttributeError

PyExc_BaseException

PyExc_BlockingIOError

PyExc_BrokenPipeError

PyExc_BufferError

PyExc_BytesWarning

PyExc_ChildProcessError

PyExc_ConnectionAbortedError

PyExc_ConnectionError

PyExc_ConnectionRefusedError

PyExc_ConnectionResetError

PyExc_DeprecationWarning

PyExc_EnvironmentError

PyExc_EOFError

PyExc_Exception

PyExc_FileExistsError

PyExc_FileNotFoundError

PyExc_FloatingPointError

PyExc_FutureWarning

PyExc_GeneratorExit

PyExc_ImportError

PyExc_ImportWarning

PyExc_IndentationError

PyExc_IndexError

PyExc_InterruptedError

PyExc_IOError

PyExc_IsADirectoryError

PyExc_KeyboardInterrupt

PyExc_KeyError

PyExc_LookupError

PyExc_MemoryError

PyExc_ModuleNotFoundError

PyExc_NameError

PyExc_NotADirectoryError

PyExc_NotImplementedError

PyExc_OSError

PyExc_OverflowError

PyExc_PendingDeprecationWarning

PyExc_PermissionError

PyExc_ProcessLookupError

PyExc_RecursionError

PyExc_ReferenceError

PyExc_ResourceWarning

PyExc_RuntimeError

PyExc_RuntimeWarning

PyExc_StopAsyncIteration

PyExc_StopIteration

PyExc_SyntaxError

PyExc_SyntaxWarning

PyExc_SystemError

PyExc_SystemExit

PyExc_TabError

PyExc_TimeoutError

PyExc_TypeError

PyExc_UnboundLocalError

PyExc_UnicodeDecodeError

PyExc_UnicodeEncodeError

PyExc_UnicodeError

PyExc_UnicodeTranslateError

PyExc_UnicodeWarning

PyExc_UserWarning

PyExc_ValueError

PyExc_Warning

PyExc_WindowsError

PyExc_ZeroDivisionError

PyException_GetCause (C function)

PyException_GetContext (C function)

PyException_GetTraceback (C function)

PyException_SetCause (C function)

PyException_SetContext (C function)

PyException_SetTraceback (C function)

pyexpat

模块

PyFile_FromFd (C function)

PyFile_GetLine (C function)

PyFile_SetOpenCodeHook (C function)

PyFile_WriteObject (C function)

PyFile_WriteString (C function)

PyFloat_AS_DOUBLE (C function)

PyFloat_AsDouble (C function)

PyFloat_Check (C function)

PyFloat_CheckExact (C function)

PyFloat_FromDouble (C function)

PyFloat_FromString (C function)

PyFloat_GetInfo (C function)

PyFloat_GetMax (C function)

PyFloat_GetMin (C function)

PyFloat_Type (C var)

PyFloatObject (C type)

PyFrame_GetBack (C function)

PyFrame_GetCode (C function)

PyFrame_GetLineNumber (C function)

PyFrameObject (C type)

PyFrozenSet_Check (C function)

PyFrozenSet_CheckExact (C function)

PyFrozenSet_New (C function)

PyFrozenSet_Type (C var)

PyFunction_Check (C function)

PyFunction_GetAnnotations (C function)

PyFunction_GetClosure (C function)

PyFunction_GetCode (C function)

PyFunction_GetDefaults (C function)

PyFunction_GetGlobals (C function)

PyFunction_GetModule (C function)

PyFunction_New (C function)

PyFunction_NewWithQualName (C function)

PyFunction_SetAnnotations (C function)

PyFunction_SetClosure (C function)

PyFunction_SetDefaults (C function)

PyFunction_Type (C var)

PyFunctionObject (C type)

PYFUNCTYPE() (在 ctypes 模块中)

PyGC_Collect (C function)

PyGC_Disable (C function)

PyGC_Enable (C function)

PyGC_IsEnabled (C function)

PyGen_Check (C function)

PyGen_CheckExact (C function)

PyGen_New (C function)

PyGen_NewWithQualName (C function)

PyGen_Type (C var)

PyGenObject (C type)

PyGetSetDef (C type)

PyGILState_Check (C function)

PyGILState_Ensure (C function)

PyGILState_GetThisThreadState (C function)

PyGILState_Release (C function)

PyImport_AddModule (C function)

PyImport_AddModuleObject (C function)

PyImport_AppendInittab (C function)

PyImport_ExecCodeModule (C function)

PyImport_ExecCodeModuleEx (C function)

PyImport_ExecCodeModuleObject (C function)

PyImport_ExecCodeModuleWithPathnames (C function)

PyImport_ExtendInittab (C function)

PyImport_FrozenModules (C var)

PyImport_GetImporter (C function)

PyImport_GetMagicNumber (C function)

PyImport_GetMagicTag (C function)

PyImport_GetModule (C function)

PyImport_GetModuleDict (C function)

PyImport_Import (C function)

PyImport_ImportFrozenModule (C function)

PyImport_ImportFrozenModuleObject (C function)

PyImport_ImportModule (C function)

PyImport_ImportModuleEx (C function)

PyImport_ImportModuleLevel (C function)

PyImport_ImportModuleLevelObject (C function)

PyImport_ImportModuleNoBlock (C function)

PyImport_ReloadModule (C function)

PyIndex_Check (C function)

PyInit_modulename (C function)

PyInstanceMethod_Check (C function)

PyInstanceMethod_Function (C function)

PyInstanceMethod_GET_FUNCTION (C function)

PyInstanceMethod_New (C function)

PyInstanceMethod_Type (C var)

PyInterpreterState (C type)

PyInterpreterState_Clear (C function)

PyInterpreterState_Delete (C function)

PyInterpreterState_Get (C function)

PyInterpreterState_GetDict (C function)

PyInterpreterState_GetID (C function)

PyInterpreterState_Head (C function)

PyInterpreterState_Main (C function)

PyInterpreterState_New (C function)

PyInterpreterState_Next (C function)

PyInterpreterState_ThreadHead (C function)

PyIter_Check (C function)

PyIter_Next (C function)

PyIter_Send (C function)

PyList_Append (C function)

PyList_AsTuple (C function)

PyList_Check (C function)

PyList_CheckExact (C function)

PyList_GET_ITEM (C function)

PyList_GET_SIZE (C function)

PyList_GetItem (C function)

PyList_GetItem()

PyList_GetSlice (C function)

PyList_Insert (C function)

PyList_New (C function)

PyList_Reverse (C function)

PyList_SET_ITEM (C function)

PyList_SetItem (C function)

PyList_SetItem()

PyList_SetSlice (C function)

PyList_Size (C function)

PyList_Sort (C function)

PyList_Type (C var)

PyListObject (C type)

PyLong_AsDouble (C function)

PyLong_AsLong (C function)

PyLong_AsLongAndOverflow (C function)

PyLong_AsLongLong (C function)

PyLong_AsLongLongAndOverflow (C function)

PyLong_AsSize_t (C function)

PyLong_AsSsize_t (C function)

PyLong_AsUnsignedLong (C function)

PyLong_AsUnsignedLongLong (C function)

PyLong_AsUnsignedLongLongMask (C function)

PyLong_AsUnsignedLongMask (C function)

PyLong_AsVoidPtr (C function)

PyLong_Check (C function)

PyLong_CheckExact (C function)

PyLong_FromDouble (C function)

PyLong_FromLong (C function)

PyLong_FromLongLong (C function)

PyLong_FromSize_t (C function)

PyLong_FromSsize_t (C function)

PyLong_FromString (C function)

PyLong_FromUnicodeObject (C function)

PyLong_FromUnsignedLong (C function)

PyLong_FromUnsignedLongLong (C function)

PyLong_FromVoidPtr (C function)

PyLong_Type (C var)

PyLongObject (C type)

PyMapping_Check (C function)

PyMapping_DelItem (C function)

PyMapping_DelItemString (C function)

PyMapping_GetItemString (C function)

PyMapping_HasKey (C function)

PyMapping_HasKeyString (C function)

PyMapping_Items (C function)

PyMapping_Keys (C function)

PyMapping_Length (C function)

PyMapping_SetItemString (C function)

PyMapping_Size (C function)

PyMapping_Values (C function)

PyMappingMethods (C type)

PyMappingMethods.mp_ass_subscript (C member)

PyMappingMethods.mp_length (C member)

PyMappingMethods.mp_subscript (C member)

PyMarshal_ReadLastObjectFromFile (C function)

PyMarshal_ReadLongFromFile (C function)

PyMarshal_ReadObjectFromFile (C function)

PyMarshal_ReadObjectFromString (C function)

PyMarshal_ReadShortFromFile (C function)

PyMarshal_WriteLongToFile (C function)

PyMarshal_WriteObjectToFile (C function)

PyMarshal_WriteObjectToString (C function)

PyMem_Calloc (C function)

PyMem_Del (C function)

PyMem_Free (C function)

PyMem_GetAllocator (C function)

PyMem_Malloc (C function)

PyMem_New (C function)

PyMem_RawCalloc (C function)

PyMem_RawFree (C function)

PyMem_RawMalloc (C function)

PyMem_RawRealloc (C function)

PyMem_Realloc (C function)

PyMem_Resize (C function)

PyMem_SetAllocator (C function)

PyMem_SetupDebugHooks (C function)

PyMemAllocatorDomain (C type)

PyMemAllocatorDomain.PYMEM_DOMAIN_MEM (C macro)

PyMemAllocatorDomain.PYMEM_DOMAIN_OBJ (C macro)

PyMemAllocatorDomain.PYMEM_DOMAIN_RAW (C macro)

PyMemAllocatorEx (C type)

PyMember_GetOne (C function)

PyMember_SetOne (C function)

PyMemberDef (C type)

PyMemoryView_Check (C function)

PyMemoryView_FromBuffer (C function)

PyMemoryView_FromMemory (C function)

PyMemoryView_FromObject (C function)

PyMemoryView_GET_BASE (C function)

PyMemoryView_GET_BUFFER (C function)

PyMemoryView_GetContiguous (C function)

PyMethod_Check (C function)

PyMethod_Function (C function)

PyMethod_GET_FUNCTION (C function)

PyMethod_GET_SELF (C function)

PyMethod_New (C function)

PyMethod_Self (C function)

PyMethod_Type (C var)

PyMethodDef (C type)

PyMethodDef.ml_doc (C member)

PyMethodDef.ml_flags (C member)

PyMethodDef.ml_meth (C member)

PyMethodDef.ml_name (C member)

PyModule_AddFunctions (C function)

PyModule_AddIntConstant (C function)

PyModule_AddIntMacro (C function)

PyModule_AddObject (C function)

PyModule_AddObjectRef (C function)

PyModule_AddStringConstant (C function)

PyModule_AddStringMacro (C function)

PyModule_AddType (C function)

PyModule_Check (C function)

PyModule_CheckExact (C function)

PyModule_Create (C function)

PyModule_Create2 (C function)

PyModule_ExecDef (C function)

PyModule_FromDefAndSpec (C function)

PyModule_FromDefAndSpec2 (C function)

PyModule_GetDef (C function)

PyModule_GetDict (C function)

PyModule_GetFilename (C function)

PyModule_GetFilenameObject (C function)

PyModule_GetName (C function)

PyModule_GetNameObject (C function)

PyModule_GetState (C function)

PyModule_New (C function)

PyModule_NewObject (C function)

PyModule_SetDocString (C function)

PyModule_Type (C var)

PyModuleDef (C type)

PyModuleDef.m_base (C member)

PyModuleDef.m_clear (C member)

PyModuleDef.m_doc (C member)

PyModuleDef.m_free (C member)

PyModuleDef.m_methods (C member)

PyModuleDef.m_name (C member)

PyModuleDef.m_size (C member)

PyModuleDef.m_slots (C member)

PyModuleDef.m_slots.m_reload (C member)

PyModuleDef.m_traverse (C member)

PyModuleDef_Init (C function)

PyModuleDef_Slot (C type)

PyModuleDef_Slot.slot (C member)

PyModuleDef_Slot.value (C member)

PyNumber_Absolute (C function)

PyNumber_Add (C function)

PyNumber_And (C function)

PyNumber_AsSsize_t (C function)

PyNumber_Check (C function)

PyNumber_Divmod (C function)

PyNumber_Float (C function)

PyNumber_FloorDivide (C function)

PyNumber_Index (C function)

PyNumber_InPlaceAdd (C function)

PyNumber_InPlaceAnd (C function)

PyNumber_InPlaceFloorDivide (C function)

PyNumber_InPlaceLshift (C function)

PyNumber_InPlaceMatrixMultiply (C function)

PyNumber_InPlaceMultiply (C function)

PyNumber_InPlaceOr (C function)

PyNumber_InPlacePower (C function)

PyNumber_InPlaceRemainder (C function)

PyNumber_InPlaceRshift (C function)

PyNumber_InPlaceSubtract (C function)

PyNumber_InPlaceTrueDivide (C function)

PyNumber_InPlaceXor (C function)

PyNumber_Invert (C function)

PyNumber_Long (C function)

PyNumber_Lshift (C function)

PyNumber_MatrixMultiply (C function)

PyNumber_Multiply (C function)

PyNumber_Negative (C function)

PyNumber_Or (C function)

PyNumber_Positive (C function)

PyNumber_Power (C function)

PyNumber_Remainder (C function)

PyNumber_Rshift (C function)

PyNumber_Subtract (C function)

PyNumber_ToBase (C function)

PyNumber_TrueDivide (C function)

PyNumber_Xor (C function)

PyNumberMethods (C type)

PyNumberMethods.nb_absolute (C member)

PyNumberMethods.nb_add (C member)

PyNumberMethods.nb_and (C member)

PyNumberMethods.nb_bool (C member)

PyNumberMethods.nb_divmod (C member)

PyNumberMethods.nb_float (C member)

PyNumberMethods.nb_floor_divide (C member)

PyNumberMethods.nb_index (C member)

PyNumberMethods.nb_inplace_add (C member)

PyNumberMethods.nb_inplace_and (C member)

PyNumberMethods.nb_inplace_floor_divide (C member)

PyNumberMethods.nb_inplace_lshift (C member)

PyNumberMethods.nb_inplace_matrix_multiply (C member)

PyNumberMethods.nb_inplace_multiply (C member)

PyNumberMethods.nb_inplace_or (C member)

PyNumberMethods.nb_inplace_power (C member)

PyNumberMethods.nb_inplace_remainder (C member)

PyNumberMethods.nb_inplace_rshift (C member)

PyNumberMethods.nb_inplace_subtract (C member)

PyNumberMethods.nb_inplace_true_divide (C member)

PyNumberMethods.nb_inplace_xor (C member)

PyNumberMethods.nb_int (C member)

PyNumberMethods.nb_invert (C member)

PyNumberMethods.nb_lshift (C member)

PyNumberMethods.nb_matrix_multiply (C member)

PyNumberMethods.nb_multiply (C member)

PyNumberMethods.nb_negative (C member)

PyNumberMethods.nb_or (C member)

PyNumberMethods.nb_positive (C member)

PyNumberMethods.nb_power (C member)

PyNumberMethods.nb_remainder (C member)

PyNumberMethods.nb_reserved (C member)

PyNumberMethods.nb_rshift (C member)

PyNumberMethods.nb_subtract (C member)

PyNumberMethods.nb_true_divide (C member)

PyNumberMethods.nb_xor (C member)

PyObject (C type)

PyObject._ob_next (C member)

PyObject._ob_prev (C member)

PyObject.ob_refcnt (C member)

PyObject.ob_type (C member)

PyObject_AsCharBuffer (C function)

PyObject_ASCII (C function)

PyObject_AsFileDescriptor (C function)

PyObject_AsReadBuffer (C function)

PyObject_AsWriteBuffer (C function)

PyObject_Bytes (C function)

PyObject_Call (C function)

PyObject_CallFunction (C function)

PyObject_CallFunctionObjArgs (C function)

PyObject_CallMethod (C function)

PyObject_CallMethodNoArgs (C function)

PyObject_CallMethodObjArgs (C function)

PyObject_CallMethodOneArg (C function)

PyObject_CallNoArgs (C function)

PyObject_CallObject (C function)

PyObject_CallObject()

PyObject_Calloc (C function)

PyObject_CallOneArg (C function)

PyObject_CheckBuffer (C function)

PyObject_CheckReadBuffer (C function)

PyObject_ClearWeakRefs (C function)

PyObject_Del (C function)

PyObject_DelAttr (C function)

PyObject_DelAttrString (C function)

PyObject_DelItem (C function)

PyObject_Dir (C function)

PyObject_Format (C function)

PyObject_Free (C function)

PyObject_GC_Del (C function)

PyObject_GC_IsFinalized (C function)

PyObject_GC_IsTracked (C function)

PyObject_GC_New (C function)

PyObject_GC_NewVar (C function)

PyObject_GC_Resize (C function)

PyObject_GC_Track (C function)

PyObject_GC_UnTrack (C function)

PyObject_GenericGetAttr (C function)

PyObject_GenericGetDict (C function)

PyObject_GenericSetAttr (C function)

PyObject_GenericSetDict (C function)

PyObject_GetAIter (C function)

PyObject_GetArenaAllocator (C function)

PyObject_GetAttr (C function)

PyObject_GetAttrString (C function)

PyObject_GetBuffer (C function)

PyObject_GetItem (C function)

PyObject_GetIter (C function)

PyObject_HasAttr (C function)

PyObject_HasAttrString (C function)

PyObject_Hash (C function)

PyObject_HashNotImplemented (C function)

PyObject_HEAD (C macro)

PyObject_HEAD_INIT (C macro)

PyObject_Init (C function)

PyObject_InitVar (C function)

PyObject_IS_GC (C function)

PyObject_IsInstance (C function)

PyObject_IsSubclass (C function)

PyObject_IsTrue (C function)

PyObject_Length (C function)

PyObject_LengthHint (C function)

PyObject_Malloc (C function)

PyObject_New (C function)

PyObject_NewVar (C function)

PyObject_Not (C function)

PyObject_Print (C function)

PyObject_Realloc (C function)

PyObject_Repr (C function)

PyObject_RichCompare (C function)

PyObject_RichCompareBool (C function)

PyObject_SetArenaAllocator (C function)

PyObject_SetAttr (C function)

PyObject_SetAttrString (C function)

PyObject_SetItem (C function)

PyObject_Size (C function)

PyObject_Str (C function)

PyObject_Type (C function)

PyObject_TypeCheck (C function)

PyObject_VAR_HEAD (C macro)

PyObject_Vectorcall (C function)

PyObject_VectorcallDict (C function)

PyObject_VectorcallMethod (C function)

PyObjectArenaAllocator (C type)

PyOS_AfterFork (C function)

PyOS_AfterFork_Child (C function)

PyOS_AfterFork_Parent (C function)

PyOS_BeforeFork (C function)

PyOS_CheckStack (C function)

PyOS_double_to_string (C function)

PyOS_FSPath (C function)

PyOS_getsig (C function)

PyOS_InputHook (C var)

PyOS_ReadlineFunctionPointer (C var)

PyOS_setsig (C function)

PyOS_snprintf (C function)

PyOS_stricmp (C function)

PyOS_string_to_double (C function)

PyOS_strnicmp (C function)

PyOS_vsnprintf (C function)

PyPI

(see Python Package Index (PyPI))

PyPreConfig (C type)

PyPreConfig.allocator (C member)

PyPreConfig.coerce_c_locale (C member)

PyPreConfig.coerce_c_locale_warn (C member)

PyPreConfig.configure_locale (C member)

PyPreConfig.dev_mode (C member)

PyPreConfig.isolated (C member)

PyPreConfig.legacy_windows_fs_encoding (C member)

PyPreConfig.parse_argv (C member)

PyPreConfig.PyPreConfig_InitIsolatedConfig (C function)

PyPreConfig.PyPreConfig_InitPythonConfig (C function)

PyPreConfig.use_environment (C member)

PyPreConfig.utf8_mode (C member)

PyProperty_Type (C var)

PyRun_AnyFile (C function)

PyRun_AnyFileEx (C function)

PyRun_AnyFileExFlags (C function)

PyRun_AnyFileFlags (C function)

PyRun_File (C function)

PyRun_FileEx (C function)

PyRun_FileExFlags (C function)

PyRun_FileFlags (C function)

PyRun_InteractiveLoop (C function)

PyRun_InteractiveLoopFlags (C function)

PyRun_InteractiveOne (C function)

PyRun_InteractiveOneFlags (C function)

PyRun_SimpleFile (C function)

PyRun_SimpleFileEx (C function)

PyRun_SimpleFileExFlags (C function)

PyRun_SimpleString (C function)

PyRun_SimpleStringFlags (C function)

PyRun_String (C function)

PyRun_StringFlags (C function)

PySendResult (C type)

PySeqIter_Check (C function)

PySeqIter_New (C function)

PySeqIter_Type (C var)

PySequence_Check (C function)

PySequence_Concat (C function)

PySequence_Contains (C function)

PySequence_Count (C function)

PySequence_DelItem (C function)

PySequence_DelSlice (C function)

PySequence_Fast (C function)

PySequence_Fast_GET_ITEM (C function)

PySequence_Fast_GET_SIZE (C function)

PySequence_Fast_ITEMS (C function)

PySequence_GetItem (C function)

PySequence_GetItem()

PySequence_GetSlice (C function)

PySequence_Index (C function)

PySequence_InPlaceConcat (C function)

PySequence_InPlaceRepeat (C function)

PySequence_ITEM (C function)

PySequence_Length (C function)

PySequence_List (C function)

PySequence_Repeat (C function)

PySequence_SetItem (C function)

PySequence_SetSlice (C function)

PySequence_Size (C function)

PySequence_Tuple (C function)

PySequenceMethods (C type)

PySequenceMethods.sq_ass_item (C member)

PySequenceMethods.sq_concat (C member)

PySequenceMethods.sq_contains (C member)

PySequenceMethods.sq_inplace_concat (C member)

PySequenceMethods.sq_inplace_repeat (C member)

PySequenceMethods.sq_item (C member)

PySequenceMethods.sq_length (C member)

PySequenceMethods.sq_repeat (C member)

PySet_Add (C function)

PySet_Check (C function)

PySet_CheckExact (C function)

PySet_Clear (C function)

PySet_Contains (C function)

PySet_Discard (C function)

PySet_GET_SIZE (C function)

PySet_New (C function)

PySet_Pop (C function)

PySet_Size (C function)

PySet_Type (C var)

PySetObject (C type)

PySignal_SetWakeupFd (C function)

PySlice_AdjustIndices (C function)

PySlice_Check (C function)

PySlice_GetIndices (C function)

PySlice_GetIndicesEx (C function)

PySlice_New (C function)

PySlice_Type (C var)

PySlice_Unpack (C function)

PyState_AddModule (C function)

PyState_FindModule (C function)

PyState_RemoveModule (C function)

PyStatus (C type)

PyStatus.err_msg (C member)

PyStatus.exitcode (C member)

PyStatus.func (C member)

PyStatus.Py_ExitStatusException (C function)

PyStatus.PyStatus_Error (C function)

PyStatus.PyStatus_Exception (C function)

PyStatus.PyStatus_Exit (C function)

PyStatus.PyStatus_IsError (C function)

PyStatus.PyStatus_IsExit (C function)

PyStatus.PyStatus_NoMemory (C function)

PyStatus.PyStatus_Ok (C function)

PyStructSequence_Desc (C type)

PyStructSequence_Field (C type)

PyStructSequence_GET_ITEM (C function)

PyStructSequence_GetItem (C function)

PyStructSequence_InitType (C function)

PyStructSequence_InitType2 (C function)

PyStructSequence_New (C function)

PyStructSequence_NewType (C function)

PyStructSequence_SET_ITEM (C function)

PyStructSequence_SetItem (C function)

PyStructSequence_UnnamedField (C var)

PySys_AddAuditHook (C function)

PySys_AddWarnOption (C function)

PySys_AddWarnOptionUnicode (C function)

PySys_AddXOption (C function)

PySys_Audit (C function)

PySys_FormatStderr (C function)

PySys_FormatStdout (C function)

PySys_GetObject (C function)

PySys_GetXOptions (C function)

PySys_ResetWarnOptions (C function)

PySys_SetArgv (C function)

PySys_SetArgv()

PySys_SetArgvEx (C function)

PySys_SetArgvEx(), [1]

PySys_SetObject (C function)

PySys_SetPath (C function)

PySys_WriteStderr (C function)

PySys_WriteStdout (C function)

Python 3000

Python Editor

Python Package Index (PyPI)

Python 提高建议

PEP 1, [1], [2]

PEP 100

PEP 11, [1], [2], [3], [4], [5]

PEP 201

PEP 205, [1]

PEP 207, [1]

PEP 208

PEP 217

PEP 218, [1], [2]

PEP 227, [1], [2]

PEP 229

PEP 230

PEP 232

PEP 234

PEP 235

PEP 236, [1], [2], [3]

PEP 237, [1], [2], [3], [4], [5]

PEP 238, [1], [2], [3], [4], [5], [6]

PEP 241, [1], [2]

PEP 243

PEP 246, [1]

PEP 247

PEP 249, [1], [2], [3], [4], [5], [6]

PEP 252, [1], [2]

PEP 253, [1], [2], [3], [4]

PEP 255, [1], [2], [3], [4], [5]

PEP 261, [1]

PEP 263, [1], [2], [3], [4], [5], [6]

PEP 264

PEP 273, [1], [2], [3]

PEP 274

PEP 277

PEP 278, [1]

PEP 279

PEP 282, [1], [2], [3], [4]

PEP 285, [1]

PEP 288

PEP 289, [1], [2]

PEP 292, [1]

PEP 293

PEP 3000

PEP 301, [1]

PEP 302, [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], [31], [32], [33], [34], [35], [36]

PEP 307, [1], [2], [3]

PEP 308, [1], [2]

PEP 309

PEP 3100

PEP 3101, [1], [2], [3], [4]

PEP 3102

PEP 3104, [1]

PEP 3105, [1], [2]

PEP 3106

PEP 3107, [1], [2], [3], [4]

PEP 3108, [1], [2]

PEP 3109, [1]

PEP 3110, [1], [2]

PEP 3111

PEP 3112, [1]

PEP 3113

PEP 3114

PEP 3115, [1], [2], [3], [4]

PEP 3116, [1], [2]

PEP 3118, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PEP 3119, [1], [2], [3], [4], [5]

PEP 3120, [1], [2]

PEP 3121, [1], [2]

PEP 3123

PEP 3127

PEP 3129, [1]

PEP 3131, [1], [2]

PEP 3132, [1]

PEP 3134, [1], [2], [3]

PEP 3135, [1]

PEP 3137

PEP 3138

PEP 314, [1]

PEP 3141, [1], [2]

PEP 3147, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19], [20], [21], [22]

PEP 3148, [1]

PEP 3149, [1], [2]

PEP 3151, [1], [2], [3], [4], [5]

PEP 3154, [1], [2], [3]

PEP 3155, [1]

PEP 3156, [1], [2], [3], [4]

PEP 318, [1], [2], [3]

PEP 322, [1]

PEP 324, [1]

PEP 325

PEP 327

PEP 328, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PEP 331

PEP 333, [1]

PEP 3333, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15]

PEP 338, [1], [2], [3]

PEP 339

PEP 341

PEP 342, [1], [2], [3], [4], [5], [6]

PEP 343, [1], [2], [3], [4], [5], [6], [7]

PEP 347

PEP 352, [1], [2]

PEP 353, [1], [2], [3], [4], [5]

PEP 356

PEP 357

PEP 361

PEP 362, [1], [2], [3]

PEP 366, [1], [2], [3], [4], [5], [6]

PEP 370, [1], [2], [3], [4]

PEP 371

PEP 372, [1]

PEP 373

PEP 378, [1], [2]

PEP 380, [1]

PEP 383, [1], [2], [3], [4], [5]

PEP 384, [1], [2]

PEP 385

PEP 387, [1], [2]

PEP 389, [1]

PEP 391, [1]

PEP 392

PEP 393, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

PEP 397, [1], [2]

PEP 398

PEP 4

PEP 405, [1]

PEP 409

PEP 411, [1], [2], [3], [4]

PEP 412, [1]

PEP 414, [1]

PEP 418

PEP 420, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 421, [1], [2]

PEP 424, [1]

PEP 427

PEP 428, [1], [2]

PEP 429

PEP 432, [1], [2], [3]

PEP 434, [1]

PEP 435, [1], [2]

PEP 436, [1], [2]

PEP 441, [1]

PEP 442, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 443, [1], [2]

PEP 445, [1], [2], [3]

PEP 446, [1], [2], [3]

PEP 448, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 450, [1], [2]

PEP 451, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 453, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PEP 454, [1], [2]

PEP 456, [1]

PEP 461, [1], [2]

PEP 465, [1], [2]

PEP 466, [1], [2], [3]

PEP 468, [1], [2]

PEP 471, [1], [2]

PEP 475, [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]

PEP 476

PEP 477

PEP 478

PEP 479, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

PEP 483, [1], [2], [3]

PEP 484, [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]

PEP 485, [1], [2], [3], [4]

PEP 486, [1], [2]

PEP 487, [1], [2], [3], [4], [5], [6]

PEP 488, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 489, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40], [41], [42], [43], [44], [45], [46], [47], [48], [49], [50], [51], [52], [53], [54], [55], [56], [57], [58], [59], [60], [61]

PEP 492, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19], [20], [21], [22]

PEP 493

PEP 494

PEP 495, [1], [2], [3]

PEP 498, [1], [2], [3], [4]

PEP 5, [1]

PEP 506, [1], [2]

PEP 511

PEP 514

PEP 515, [1], [2], [3], [4]

PEP 519, [1], [2], [3], [4], [5], [6], [7]

PEP 520

PEP 523, [1], [2], [3], [4], [5], [6], [7]

PEP 524, [1], [2], [3], [4], [5]

PEP 525, [1], [2], [3], [4], [5], [6], [7]

PEP 526, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17]

PEP 528, [1], [2], [3]

PEP 529, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

PEP 530, [1], [2], [3]

PEP 538, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 539, [1], [2], [3]

PEP 540, [1], [2], [3], [4]

PEP 544, [1], [2], [3]

PEP 545, [1]

PEP 552, [1], [2], [3], [4], [5], [6]

PEP 553, [1]

PEP 557, [1]

PEP 560, [1], [2], [3], [4], [5], [6]

PEP 562, [1], [2], [3]

PEP 563, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 564, [1], [2], [3]

PEP 565, [1]

PEP 566, [1], [2]

PEP 567, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PEP 570, [1], [2], [3]

PEP 572, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 573, [1], [2], [3], [4]

PEP 574, [1], [2]

PEP 578, [1], [2], [3]

PEP 584, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]

PEP 585, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40], [41], [42], [43], [44], [45]

PEP 586, [1], [2], [3], [4]

PEP 587, [1], [2], [3], [4]

PEP 589, [1], [2]

PEP 590, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

PEP 591, [1], [2], [3]

PEP 593, [1], [2], [3], [4], [5]

PEP 594, [1], [2]

PEP 594#aifc

PEP 594#asynchat

PEP 594#asyncore

PEP 594#audioop

PEP 594#cgi

PEP 594#cgitb

PEP 594#chunk

PEP 594#crypt

PEP 594#imghdr

PEP 594#mailcap

PEP 594#msilib

PEP 594#nis

PEP 594#ossaudiodev

PEP 594#pipes

PEP 594#smtpd

PEP 594#sndhdr

PEP 594#spwd

PEP 594#sunau

PEP 594#telnetlib

PEP 594#uu-and-the-uu-encoding

PEP 594#xdrlib

PEP 596

PEP 597, [1], [2]

PEP 6

PEP 602, [1]

PEP 604, [1], [2], [3], [4], [5], [6]

PEP 612, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

PEP 613, [1], [2], [3], [4]

PEP 614, [1], [2], [3], [4]

PEP 615, [1], [2], [3]

PEP 616, [1], [2]

PEP 617, [1], [2], [3], [4], [5], [6]

PEP 618, [1], [2]

PEP 623, [1], [2], [3]

PEP 624

PEP 626, [1]

PEP 628, [1], [2]

PEP 632, [1]

PEP 634, [1], [2], [3], [4], [5], [6], [7], [8]

PEP 635, [1]

PEP 636, [1], [2], [3], [4]

PEP 644, [1], [2], [3], [4], [5]

PEP 647, [1], [2], [3], [4]

PEP 649

PEP 652, [1]

PEP 7, [1], [2], [3]

PEP 706, [1]

PEP 8, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PYTHON*, [1], [2], [3], [4], [5], [6]

python--m-py_compile command line option

-

--quiet

-q

<file> ... <fileN>

python_branch() (在 platform 模块中)

python_build() (在 platform 模块中)

python_compiler() (在 platform 模块中)

PYTHON_DOM

python_implementation() (在 platform 模块中)

python_is_optimized() (在 test.support 模块中)

python_revision() (在 platform 模块中)

python_version() (在 platform 模块中)

python_version_tuple() (在 platform 模块中)

PYTHONASYNCIODEBUG, [1], [2]

PYTHONBREAKPOINT, [1], [2], [3]

PYTHONCASEOK, [1], [2], [3]

PYTHONCOERCECLOCALE, [1], [2], [3]

PYTHONDEBUG, [1], [2]

PYTHONDEVMODE, [1]

PYTHONDOCS

PYTHONDONTWRITEBYTECODE, [1], [2], [3], [4], [5], [6]

PYTHONDUMPREFS, [1], [2], [3], [4]

PYTHONEXECUTABLE

PYTHONFAULTHANDLER, [1], [2], [3]

PYTHONHASHSEED, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PYTHONHOME, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]

Pythonic

PYTHONINSPECT, [1], [2], [3]

PYTHONINTMAXSTRDIGITS, [1], [2], [3], [4]

PYTHONIOENCODING, [1], [2], [3], [4], [5], [6], [7]

PYTHONLEGACYWINDOWSFSENCODING, [1], [2], [3]

PYTHONLEGACYWINDOWSSTDIO, [1], [2], [3], [4]

PYTHONMALLOC, [1], [2], [3], [4], [5], [6], [7], [8], [9]

PYTHONMALLOC`（例如：``PYTHONMALLOC=malloc`

PYTHONMALLOCSTATS, [1], [2]

PYTHONNOUSERSITE, [1], [2], [3]

PYTHONOPTIMIZE, [1], [2]

PYTHONPATH, [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]

PYTHONPLATLIBDIR, [1]

PYTHONPROFILEIMPORTTIME, [1], [2], [3]

PYTHONPYCACHEPREFIX, [1], [2], [3], [4]

PYTHONREGRTEST_UNICODE_GUARD

PYTHONSHOWALLOCCOUNT

PYTHONSHOWREFCOUNT

PYTHONSTARTUP, [1], [2], [3], [4], [5], [6], [7]

PYTHONTHREADDEBUG, [1], [2]

PYTHONTRACEMALLOC, [1], [2], [3]

PYTHONTZPATH

PYTHONUNBUFFERED, [1], [2], [3], [4]

PYTHONUSERBASE, [1], [2]

PYTHONUSERSITE

PYTHONUTF8, [1], [2], [3], [4], [5], [6], [7]

PYTHONVERBOSE, [1], [2]

PYTHONWARNDEFAULTENCODING, [1], [2], [3]

PYTHONWARNINGS, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

PyThread_create_key (C function)

PyThread_delete_key (C function)

PyThread_delete_key_value (C function)

PyThread_get_key_value (C function)

PyThread_ReInitTLS (C function)

PyThread_set_key_value (C function)

PyThread_tss_alloc (C function)

PyThread_tss_create (C function)

PyThread_tss_delete (C function)

PyThread_tss_free (C function)

PyThread_tss_get (C function)

PyThread_tss_is_created (C function)

PyThread_tss_set (C function)

PyThreadState, [1]

(C type)

PyThreadState_Clear (C function)

PyThreadState_Delete (C function)

PyThreadState_DeleteCurrent (C function)

PyThreadState_Get (C function)

PyThreadState_GetDict (C function)

PyThreadState_GetFrame (C function)

PyThreadState_GetID (C function)

PyThreadState_GetInterpreter (C function)

PyThreadState_New (C function)

PyThreadState_Next (C function)

PyThreadState_SetAsyncExc (C function)

PyThreadState_Swap (C function)

PyTime_Check (C function)

PyTime_CheckExact (C function)

PyTime_FromTime (C function)

PyTime_FromTimeAndFold (C function)

PyTimeZone_FromOffset (C function)

PyTimeZone_FromOffsetAndName (C function)

PyTrace_C_CALL (C var)

PyTrace_C_EXCEPTION (C var)

PyTrace_C_RETURN (C var)

PyTrace_CALL (C var)

PyTrace_EXCEPTION (C var)

PyTrace_LINE (C var)

PyTrace_OPCODE (C var)

PyTrace_RETURN (C var)

PyTraceMalloc_Track (C function)

PyTraceMalloc_Untrack (C function)

PyTuple_Check (C function)

PyTuple_CheckExact (C function)

PyTuple_GET_ITEM (C function)

PyTuple_GET_SIZE (C function)

PyTuple_GetItem (C function)

PyTuple_GetSlice (C function)

PyTuple_New (C function)

PyTuple_Pack (C function)

PyTuple_SET_ITEM (C function)

PyTuple_SetItem (C function)

PyTuple_SetItem()

PyTuple_Size (C function)

PyTuple_Type (C var)

PyTupleObject (C type)

PyType_Check (C function)

PyType_CheckExact (C function)

PyType_ClearCache (C function)

PyType_FromModuleAndSpec (C function)

PyType_FromSpec (C function)

PyType_FromSpecWithBases (C function)

PyType_GenericAlloc (C function)

PyType_GenericNew (C function)

PyType_GetFlags (C function)

PyType_GetModule (C function)

PyType_GetModuleState (C function)

PyType_GetSlot (C function)

PyType_HasFeature (C function)

PyType_IS_GC (C function)

PyType_IsSubtype (C function)

PyType_Modified (C function)

PyType_Ready (C function)

PyType_Slot (C type)

PyType_Slot.PyType_Slot.pfunc (C member)

PyType_Slot.PyType_Slot.slot (C member)

PyType_Spec (C type)

PyType_Spec.PyType_Spec.basicsize (C member)

PyType_Spec.PyType_Spec.flags (C member)

PyType_Spec.PyType_Spec.itemsize (C member)

PyType_Spec.PyType_Spec.name (C member)

PyType_Spec.PyType_Spec.slots (C member)

PyType_Type (C var)

PyTypeObject (C type)

PyTypeObject.tp_alloc (C member)

PyTypeObject.tp_as_async (C member)

PyTypeObject.tp_as_buffer (C member)

PyTypeObject.tp_as_mapping (C member)

PyTypeObject.tp_as_number (C member)

PyTypeObject.tp_as_sequence (C member)

PyTypeObject.tp_base (C member)

PyTypeObject.tp_bases (C member)

PyTypeObject.tp_basicsize (C member)

PyTypeObject.tp_cache (C member)

PyTypeObject.tp_call (C member)

PyTypeObject.tp_clear (C member)

PyTypeObject.tp_dealloc (C member)

PyTypeObject.tp_del (C member)

PyTypeObject.tp_descr_get (C member)

PyTypeObject.tp_descr_set (C member)

PyTypeObject.tp_dict (C member)

PyTypeObject.tp_dictoffset (C member)

PyTypeObject.tp_doc (C member)

PyTypeObject.tp_finalize (C member)

PyTypeObject.tp_flags (C member)

PyTypeObject.tp_free (C member)

PyTypeObject.tp_getattr (C member)

PyTypeObject.tp_getattro (C member)

PyTypeObject.tp_getset (C member)

PyTypeObject.tp_hash (C member)

PyTypeObject.tp_init (C member)

PyTypeObject.tp_is_gc (C member)

PyTypeObject.tp_itemsize (C member)

PyTypeObject.tp_iter (C member)

PyTypeObject.tp_iternext (C member)

PyTypeObject.tp_members (C member)

PyTypeObject.tp_methods (C member)

PyTypeObject.tp_mro (C member)

PyTypeObject.tp_name (C member)

PyTypeObject.tp_new (C member)

PyTypeObject.tp_repr (C member)

PyTypeObject.tp_richcompare (C member)

PyTypeObject.tp_richcompare.Py_RETURN_RICHCOMPARE (C macro)

PyTypeObject.tp_setattr (C member)

PyTypeObject.tp_setattro (C member)

PyTypeObject.tp_str (C member)

PyTypeObject.tp_subclasses (C member)

PyTypeObject.tp_traverse (C member)

PyTypeObject.tp_vectorcall (C member)

PyTypeObject.tp_vectorcall_offset (C member)

PyTypeObject.tp_version_tag (C member)

PyTypeObject.tp_weaklist (C member)

PyTypeObject.tp_weaklistoffset (C member)

PyTZInfo_Check (C function)

PyTZInfo_CheckExact (C function)

PyUnicode_1BYTE_DATA (C function)

PyUnicode_1BYTE_KIND (C macro)

PyUnicode_2BYTE_DATA (C function)

PyUnicode_2BYTE_KIND (C macro)

PyUnicode_4BYTE_DATA (C function)

PyUnicode_4BYTE_KIND (C macro)

PyUnicode_AS_DATA (C function)

PyUnicode_AS_UNICODE (C function)

PyUnicode_AsASCIIString (C function)

PyUnicode_AsCharmapString (C function)

PyUnicode_AsEncodedString (C function)

PyUnicode_AsLatin1String (C function)

PyUnicode_AsMBCSString (C function)

PyUnicode_AsRawUnicodeEscapeString (C function)

PyUnicode_AsUCS4 (C function)

PyUnicode_AsUCS4Copy (C function)

PyUnicode_AsUnicode (C function)

PyUnicode_AsUnicodeAndSize (C function)

PyUnicode_AsUnicodeEscapeString (C function)

PyUnicode_AsUTF16String (C function)

PyUnicode_AsUTF32String (C function)

PyUnicode_AsUTF8 (C function)

PyUnicode_AsUTF8AndSize (C function)

PyUnicode_AsUTF8String (C function)

PyUnicode_AsWideChar (C function)

PyUnicode_AsWideCharString (C function)

PyUnicode_Check (C function)

PyUnicode_CheckExact (C function)

PyUnicode_Compare (C function)

PyUnicode_CompareWithASCIIString (C function)

PyUnicode_Concat (C function)

PyUnicode_Contains (C function)

PyUnicode_CopyCharacters (C function)

PyUnicode_Count (C function)

PyUnicode_DATA (C function)

PyUnicode_Decode (C function)

PyUnicode_DecodeASCII (C function)

PyUnicode_DecodeCharmap (C function)

PyUnicode_DecodeFSDefault (C function)

PyUnicode_DecodeFSDefaultAndSize (C function)

PyUnicode_DecodeLatin1 (C function)

PyUnicode_DecodeLocale (C function)

PyUnicode_DecodeLocaleAndSize (C function)

PyUnicode_DecodeMBCS (C function)

PyUnicode_DecodeMBCSStateful (C function)

PyUnicode_DecodeRawUnicodeEscape (C function)

PyUnicode_DecodeUnicodeEscape (C function)

PyUnicode_DecodeUTF16 (C function)

PyUnicode_DecodeUTF16Stateful (C function)

PyUnicode_DecodeUTF32 (C function)

PyUnicode_DecodeUTF32Stateful (C function)

PyUnicode_DecodeUTF7 (C function)

PyUnicode_DecodeUTF7Stateful (C function)

PyUnicode_DecodeUTF8 (C function)

PyUnicode_DecodeUTF8Stateful (C function)

PyUnicode_Encode (C function)

PyUnicode_EncodeASCII (C function)

PyUnicode_EncodeCharmap (C function)

PyUnicode_EncodeCodePage (C function)

PyUnicode_EncodeFSDefault (C function)

PyUnicode_EncodeLatin1 (C function)

PyUnicode_EncodeLocale (C function)

PyUnicode_EncodeMBCS (C function)

PyUnicode_EncodeRawUnicodeEscape (C function)

PyUnicode_EncodeUnicodeEscape (C function)

PyUnicode_EncodeUTF16 (C function)

PyUnicode_EncodeUTF32 (C function)

PyUnicode_EncodeUTF7 (C function)

PyUnicode_EncodeUTF8 (C function)

PyUnicode_Fill (C function)

PyUnicode_Find (C function)

PyUnicode_FindChar (C function)

PyUnicode_Format (C function)

PyUnicode_FromEncodedObject (C function)

PyUnicode_FromFormat (C function)

PyUnicode_FromFormatV (C function)

PyUnicode_FromKindAndData (C function)

PyUnicode_FromObject (C function)

PyUnicode_FromString (C function)

PyUnicode_FromString()

PyUnicode_FromStringAndSize (C function)

PyUnicode_FromUnicode (C function)

PyUnicode_FromWideChar (C function)

PyUnicode_FSConverter (C function)

PyUnicode_FSDecoder (C function)

PyUnicode_GET_DATA_SIZE (C function)

PyUnicode_GET_LENGTH (C function)

PyUnicode_GET_SIZE (C function)

PyUnicode_GetLength (C function)

PyUnicode_GetSize (C function)

PyUnicode_InternFromString (C function)

PyUnicode_InternInPlace (C function)

PyUnicode_IsIdentifier (C function)

PyUnicode_Join (C function)

PyUnicode_KIND (C function)

PyUnicode_MAX_CHAR_VALUE (C macro)

PyUnicode_New (C function)

PyUnicode_READ (C function)

PyUnicode_READ_CHAR (C function)

PyUnicode_ReadChar (C function)

PyUnicode_READY (C function)

PyUnicode_Replace (C function)

PyUnicode_RichCompare (C function)

PyUnicode_Split (C function)

PyUnicode_Splitlines (C function)

PyUnicode_Substring (C function)

PyUnicode_Tailmatch (C function)

PyUnicode_TransformDecimalToASCII (C function)

PyUnicode_Translate (C function)

PyUnicode_TranslateCharmap (C function)

PyUnicode_Type (C var)

PyUnicode_WCHAR_KIND (C macro)

PyUnicode_WRITE (C function)

PyUnicode_WriteChar (C function)

PyUnicodeDecodeError_Create (C function)

PyUnicodeDecodeError_GetEncoding (C function)

PyUnicodeDecodeError_GetEnd (C function)

PyUnicodeDecodeError_GetObject (C function)

PyUnicodeDecodeError_GetReason (C function)

PyUnicodeDecodeError_GetStart (C function)

PyUnicodeDecodeError_SetEnd (C function)

PyUnicodeDecodeError_SetReason (C function)

PyUnicodeDecodeError_SetStart (C function)

PyUnicodeEncodeError_Create (C function)

PyUnicodeEncodeError_GetEncoding (C function)

PyUnicodeEncodeError_GetEnd (C function)

PyUnicodeEncodeError_GetObject (C function)

PyUnicodeEncodeError_GetReason (C function)

PyUnicodeEncodeError_GetStart (C function)

PyUnicodeEncodeError_SetEnd (C function)

PyUnicodeEncodeError_SetReason (C function)

PyUnicodeEncodeError_SetStart (C function)

PyUnicodeObject (C type)

PyUnicodeTranslateError_Create (C function)

PyUnicodeTranslateError_GetEnd (C function)

PyUnicodeTranslateError_GetObject (C function)

PyUnicodeTranslateError_GetReason (C function)

PyUnicodeTranslateError_GetStart (C function)

PyUnicodeTranslateError_SetEnd (C function)

PyUnicodeTranslateError_SetReason (C function)

PyUnicodeTranslateError_SetStart (C function)

PyVarObject (C type)

PyVarObject.ob_size (C member)

PyVarObject_HEAD_INIT (C macro)

PyVectorcall_Call (C function)

PyVectorcall_Function (C function)

PyVectorcall_NARGS (C function)

PyWeakref_Check (C function)

PyWeakref_CheckProxy (C function)

PyWeakref_CheckRef (C function)

PyWeakref_GET_OBJECT (C function)

PyWeakref_GetObject (C function)

PyWeakref_NewProxy (C function)

PyWeakref_NewRef (C function)

PyWideStringList (C type)

PyWideStringList.items (C member)

PyWideStringList.length (C member)

PyWideStringList.PyWideStringList_Append (C function)

PyWideStringList.PyWideStringList_Insert (C function)

PyWrapper_New (C function)

PyZipFile (zipfile 中的类)

Q

qiflush() (在 curses 模块中)

QName (xml.etree.ElementTree 中的类)

qsize() (asyncio.Queue 方法)

(multiprocessing.Queue 方法)

(queue.Queue 方法)

(queue.SimpleQueue 方法)

qualified name -- 限定名称

quantiles() (statistics.NormalDist 方法)

(在 statistics 模块中)

quantize() (decimal.Context 方法)

(decimal.Decimal 方法)

QueryInfoKey() (在 winreg 模块中)

QueryReflectionKey() (在 winreg 模块中)

QueryValue() (在 winreg 模块中)

QueryValueEx() (在 winreg 模块中)

queue

模块

Queue (asyncio 中的类)

(multiprocessing 中的类)

(queue 中的类)

queue (sched.scheduler 属性)

Queue() (multiprocessing.managers.SyncManager 方法)

QueueEmpty

QueueFull

QueueHandler (logging.handlers 中的类)

QueueListener (logging.handlers 中的类)

quick_ratio() (difflib.SequenceMatcher 方法)

quit (pdb command)

(內置变量)

quit() (ftplib.FTP 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

(smtplib.SMTP 方法)

(tkinter.filedialog.FileDialog 方法)

quopri

模块

quote() (在 email.utils 模块中)

(在 shlex 模块中)

(在 urllib.parse 模块中)

QUOTE_ALL() (在 csv 模块中)

quote_from_bytes() (在 urllib.parse 模块中)

QUOTE_MINIMAL() (在 csv 模块中)

QUOTE_NONE() (在 csv 模块中)

QUOTE_NONNUMERIC() (在 csv 模块中)

quote_plus() (在 urllib.parse 模块中)

quoteattr() (在 xml.sax.saxutils 模块中)

quotechar (csv.Dialect 属性)

quoted-printable

encoding

quotes (shlex.shlex 属性)

quoting (csv.Dialect 属性)

R

r"

raw string literal

r'

raw string literal

R_OK() (在 os 模块中)

radians() (在 math 模块中)

(在 turtle 模块中)

RadioButtonGroup (msilib 中的类)

radiogroup() (msilib.Dialog 方法)

radix() (decimal.Context 方法)

(decimal.Decimal 方法)

RADIXCHAR() (在 locale 模块中)

raise

语句, [1]

raise (2to3 fixer)

Raise (ast 中的类)

raise an exception

raise_on_defect (email.policy.Policy 属性)

raise_signal() (在 signal 模块中)

RAISE_VARARGS (opcode)

raising

exception

RAND_add() (在 ssl 模块中)

RAND_bytes() (在 ssl 模块中)

RAND_pseudo_bytes() (在 ssl 模块中)

RAND_status() (在 ssl 模块中)

randbelow() (在 secrets 模块中)

randbits() (在 secrets 模块中)

randbytes() (在 random 模块中)

randint() (在 random 模块中)

random

模块

Random (random 中的类)

random() (在 random 模块中)

randrange() (在 random 模块中)

range

內置函数

对象

range (內置类)

RARROW() (在 token 模块中)

ratecv() (在 audioop 模块中)

ratio() (difflib.SequenceMatcher 方法)

Rational (numbers 中的类)

raw (io.BufferedIOBase 属性)

raw string

raw() (pickle.PickleBuffer 方法)

(在 curses 模块中)

raw_data_manager() (在 email.contentmanager 模块中)

raw_decode() (json.JSONDecoder 方法)

raw_input (2to3 fixer)

raw_input() (code.InteractiveConsole 方法)

RawArray() (在 multiprocessing.sharedctypes 模块中)

RawConfigParser (configparser 中的类)

RawDescriptionHelpFormatter (argparse 中的类)

RawIOBase (io 中的类)

RawPen (turtle 中的类)

RawTextHelpFormatter (argparse 中的类)

RawTurtle (turtle 中的类)

RawValue() (在 multiprocessing.sharedctypes 模块中)

RBRACE() (在 token 模块中)

rcpttos (smtpd.SMTPChannel 属性)

re

模块, [1], [2]

re (re.Match 属性)

read() (asyncio.StreamReader 方法)

(chunk.Chunk 方法)

(codecs.StreamReader 方法)

(configparser.ConfigParser 方法)

(http.client.HTTPResponse 方法)

(imaplib.IMAP4 方法)

(io.BufferedIOBase 方法)

(io.BufferedReader 方法)

(io.RawIOBase 方法)

(io.TextIOBase 方法)

(mimetypes.MimeTypes 方法)

(mmap.mmap 方法)

(ossaudiodev.oss_audio_device 方法)

(ssl.MemoryBIO 方法)

(ssl.SSLSocket 方法)

(urllib.robotparser.RobotFileParser 方法)

(zipfile.ZipFile 方法)

(在 os 模块中)

read1() (io.BufferedIOBase 方法)

(io.BufferedReader 方法)

(io.BytesIO 方法)

read_all() (telnetlib.Telnet 方法)

read_binary() (在 importlib.resources 模块中)

read_byte() (mmap.mmap 方法)

read_bytes() (importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

read_dict() (configparser.ConfigParser 方法)

read_eager() (telnetlib.Telnet 方法)

read_environ() (在 wsgiref.handlers 模块中)

read_events() (xml.etree.ElementTree.XMLPullParser 方法)

read_file() (configparser.ConfigParser 方法)

read_history_file() (在 readline 模块中)

read_init_file() (在 readline 模块中)

read_lazy() (telnetlib.Telnet 方法)

read_mime_types() (在 mimetypes 模块中)

READ_RESTRICTED

read_sb_data() (telnetlib.Telnet 方法)

read_some() (telnetlib.Telnet 方法)

read_string() (configparser.ConfigParser 方法)

read_text() (importlib.abc.Traversable 方法)

(pathlib.Path 方法)

(zipfile.Path 方法)

(在 importlib.resources 模块中)

read_token() (shlex.shlex 方法)

read_until() (telnetlib.Telnet 方法)

read_very_eager() (telnetlib.Telnet 方法)

read_very_lazy() (telnetlib.Telnet 方法)

read_windows_registry() (mimetypes.MimeTypes 方法)

readable() (asyncore.dispatcher 方法)

(io.IOBase 方法)

READABLE() (在 tkinter 模块中)

readall() (io.RawIOBase 方法)

reader() (在 csv 模块中)

ReadError

readexactly() (asyncio.StreamReader 方法)

readfp() (configparser.ConfigParser 方法)

(mimetypes.MimeTypes 方法)

readframes() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

readinto() (http.client.HTTPResponse 方法)

(io.BufferedIOBase 方法)

(io.RawIOBase 方法)

readinto1() (io.BufferedIOBase 方法)

(io.BytesIO 方法)

readline

模块

readline() (asyncio.StreamReader 方法)

(codecs.StreamReader 方法)

(distutils.text_file.TextFile 方法)

(imaplib.IMAP4 方法)

(io.IOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

readlines() (codecs.StreamReader 方法)

(distutils.text_file.TextFile 方法)

(io.IOBase 方法)

readlink() (pathlib.Path 方法)

(在 os 模块中)

readmodule() (在 pyclbr 模块中)

readmodule_ex() (在 pyclbr 模块中)

READONLY

readonly (memoryview 属性)

ReadTransport (asyncio 中的类)

readuntil() (asyncio.StreamReader 方法)

readv() (在 os 模块中)

ready() (multiprocessing.pool.AsyncResult 方法)

Real (numbers 中的类)

real (numbers.Complex 属性)

Real Media File Format

real_max_memuse() (在 test.support 模块中)

real_quick_ratio() (difflib.SequenceMatcher 方法)

realloc()

realpath() (在 os.path 模块中)

REALTIME_PRIORITY_CLASS() (在 subprocess 模块中)

reap_children() (在 test.support 模块中)

reap_threads() (在 test.support.threading_helper 模块中)

reason (http.client.HTTPResponse 属性)

(ssl.SSLError 属性)

(UnicodeError 属性)

(urllib.error.HTTPError 属性)

(urllib.error.URLError 属性)

reattach() (tkinter.ttk.Treeview 方法)

rebinding

name

reccontrols() (ossaudiodev.oss_mixer_device 方法)

received_data (smtpd.SMTPChannel 属性)

received_lines (smtpd.SMTPChannel 属性)

recent() (imaplib.IMAP4 方法)

reconfigure() (io.TextIOWrapper 方法)

record_original_stdout() (在 test.support 模块中)

records (unittest.TestCase 属性)

rect() (在 cmath 模块中)

rectangle() (在 curses.textpad 模块中)

RecursionError

recursive_repr() (在 reprlib 模块中)

recv() (asyncore.dispatcher 方法)

(multiprocessing.connection.Connection 方法)

(socket.socket 方法)

recv_bytes() (multiprocessing.connection.Connection 方法)

recv_bytes_into() (multiprocessing.connection.Connection 方法)

recv_fds() (在 socket 模块中)

recv_into() (socket.socket 方法)

recvfrom() (socket.socket 方法)

recvfrom_into() (socket.socket 方法)

recvmsg() (socket.socket 方法)

recvmsg_into() (socket.socket 方法)

redirect_request() (urllib.request.HTTPRedirectHandler 方法)

redirect_stderr() (在 contextlib 模块中)

redirect_stdout() (在 contextlib 模块中)

redisplay() (在 readline 模块中)

redrawln() (curses.window 方法)

redrawwin() (curses.window 方法)

reduce (2to3 fixer)

reduce() (在 functools 模块中)

reducer_override() (pickle.Pickler 方法)

ref (weakref 中的类)

refcount_test() (在 test.support 模块中)

reference

attribute

reference count -- 引用计数

reference counting

ReferenceError

ReferenceType() (在 weakref 模块中)

refold_source (email.policy.EmailPolicy 属性)

refresh() (curses.window 方法)

REG_BINARY() (在 winreg 模块中)

REG_DWORD() (在 winreg 模块中)

REG_DWORD_BIG_ENDIAN() (在 winreg 模块中)

REG_DWORD_LITTLE_ENDIAN() (在 winreg 模块中)

REG_EXPAND_SZ() (在 winreg 模块中)

REG_FULL_RESOURCE_DESCRIPTOR() (在 winreg 模块中)

REG_LINK() (在 winreg 模块中)

REG_MULTI_SZ() (在 winreg 模块中)

REG_NONE() (在 winreg 模块中)

REG_QWORD() (在 winreg 模块中)

REG_QWORD_LITTLE_ENDIAN() (在 winreg 模块中)

REG_RESOURCE_LIST() (在 winreg 模块中)

REG_RESOURCE_REQUIREMENTS_LIST() (在 winreg 模块中)

REG_SZ() (在 winreg 模块中)

register() (abc.ABCMeta 方法)

(multiprocessing.managers.BaseManager 方法)

(select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(selectors.BaseSelector 方法)

(在 atexit 模块中)

(在 codecs 模块中)

(在 faulthandler 模块中)

(在 webbrowser 模块中)

register_adapter() (在 sqlite3 模块中)

register_archive_format() (在 shutil 模块中)

register_at_fork() (在 os 模块中)

register_converter() (在 sqlite3 模块中)

register_defect() (email.policy.Policy 方法)

register_dialect() (在 csv 模块中)

register_error() (在 codecs 模块中)

register_function() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_instance() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_introspection_functions() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_multicall_functions() (xmlrpc.server.CGIXMLRPCRequestHandler 方法)

(xmlrpc.server.SimpleXMLRPCServer 方法)

register_namespace() (在 xml.etree.ElementTree 模块中)

register_optionflag() (在 doctest 模块中)

register_shape() (在 turtle 模块中)

register_unpack_format() (在 shutil 模块中)

registerDOMImplementation() (在 xml.dom 模块中)

registerResult() (在 unittest 模块中)

regular

package

regular package -- 常规包

relative

import

URL

relative_to() (pathlib.PurePath 方法)

release() (_thread.lock 方法)

(asyncio.Condition 方法)

(asyncio.Lock 方法)

(asyncio.Semaphore 方法)

(logging.Handler 方法)

(memoryview 方法)

(multiprocessing.Lock 方法)

(multiprocessing.RLock 方法)

(pickle.PickleBuffer 方法)

(threading.Condition 方法)

(threading.Lock 方法)

(threading.RLock 方法)

(threading.Semaphore 方法)

(在 platform 模块中)

release_lock() (在 imp 模块中)

releasebufferproc (C type)

reload (2to3 fixer)

reload() (在 imp 模块中)

(在 importlib 模块中)

relpath() (在 os.path 模块中)

remainder() (decimal.Context 方法)

(在 math 模块中)

remainder_near() (decimal.Context 方法)

(decimal.Decimal 方法)

RemoteDisconnected

remove() (array.array 方法)

(collections.deque 方法)

(frozenset 方法)

(mailbox.Mailbox 方法)

(mailbox.MH 方法)

(sequence method)

(xml.etree.ElementTree.Element 方法)

(在 os 模块中)

remove_child_handler() (asyncio.AbstractChildWatcher 方法)

remove_done_callback() (asyncio.Future 方法)

(asyncio.Task 方法)

remove_flag() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

remove_folder() (mailbox.Maildir 方法)

(mailbox.MH 方法)

remove_header() (urllib.request.Request 方法)

remove_history_item() (在 readline 模块中)

remove_label() (mailbox.BabylMessage 方法)

remove_option() (configparser.ConfigParser 方法)

(optparse.OptionParser 方法)

remove_pyc() (msilib.Directory 方法)

remove_reader() (asyncio.loop 方法)

remove_section() (configparser.ConfigParser 方法)

remove_sequence() (mailbox.MHMessage 方法)

remove_signal_handler() (asyncio.loop 方法)

remove_tree() (在 distutils.dir_util 模块中)

remove_writer() (asyncio.loop 方法)

removeAttribute() (xml.dom.Element 方法)

removeAttributeNode() (xml.dom.Element 方法)

removeAttributeNS() (xml.dom.Element 方法)

removeChild() (xml.dom.Node 方法)

removedirs() (在 os 模块中)

removeFilter() (logging.Handler 方法)

(logging.Logger 方法)

removeHandler() (logging.Logger 方法)

(在 unittest 模块中)

removeprefix() (bytearray 方法)

(bytes 方法)

(str 方法)

removeResult() (在 unittest 模块中)

removesuffix() (bytearray 方法)

(bytes 方法)

(str 方法)

removexattr() (在 os 模块中)

rename() (ftplib.FTP 方法)

(imaplib.IMAP4 方法)

(pathlib.Path 方法)

(在 os 模块中)

renames (2to3 fixer)

renames() (在 os 模块中)

reopenIfNeeded() (logging.handlers.WatchedFileHandler 方法)

reorganize() (dbm.gnu.gdbm 方法)

repeat() (timeit.Timer 方法)

(在 itertools 模块中)

(在 timeit 模块中)

repetition

operation

replace

error handler's name

replace() (bytearray 方法)

(bytes 方法)

(curses.panel.Panel 方法)

(datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(inspect.Parameter 方法)

(inspect.Signature 方法)

(pathlib.Path 方法)

(str 方法)

(types.CodeType 方法)

(在 dataclasses 模块中)

(在 os 模块中)

replace_errors() (在 codecs 模块中)

replace_header() (email.message.EmailMessage 方法)

(email.message.Message 方法)

replace_history_item() (在 readline 模块中)

replace_whitespace (textwrap.TextWrapper 属性)

replaceChild() (xml.dom.Node 方法)

ReplacePackage() (在 modulefinder 模块中)

report() (filecmp.dircmp 方法)

(modulefinder.ModuleFinder 方法)

REPORT_CDIFF() (在 doctest 模块中)

report_failure() (doctest.DocTestRunner 方法)

report_full_closure() (filecmp.dircmp 方法)

REPORT_NDIFF() (在 doctest 模块中)

REPORT_ONLY_FIRST_FAILURE() (在 doctest 模块中)

report_partial_closure() (filecmp.dircmp 方法)

report_start() (doctest.DocTestRunner 方法)

report_success() (doctest.DocTestRunner 方法)

REPORT_UDIFF() (在 doctest 模块中)

report_unexpected_exception() (doctest.DocTestRunner 方法)

REPORTING_FLAGS() (在 doctest 模块中)

repr

內置函数, [1], [2], [3]

repr (2to3 fixer)

Repr (reprlib 中的类)

repr()

內置函数

repr() (built-in function)

__repr__() (object method)

repr() (reprlib.Repr 方法)

(在 reprlib 模块中)

repr1() (reprlib.Repr 方法)

representation

integer

reprfunc (C type)

reprlib

模块

Request (urllib.request 中的类)

request() (http.client.HTTPConnection 方法)

request_queue_size (socketserver.BaseServer 属性)

request_rate() (urllib.robotparser.RobotFileParser 方法)

request_uri() (在 wsgiref.util 模块中)

request_version (http.server.BaseHTTPRequestHandler 属性)

RequestHandlerClass (socketserver.BaseServer 属性)

requestline (http.server.BaseHTTPRequestHandler 属性)

requires() (在 test.support 模块中)

requires_bz2() (在 test.support 模块中)

requires_docstrings() (在 test.support 模块中)

requires_freebsd_version() (在 test.support 模块中)

requires_gzip() (在 test.support 模块中)

requires_IEEE_754() (在 test.support 模块中)

requires_linux_version() (在 test.support 模块中)

requires_lzma() (在 test.support 模块中)

requires_mac_version() (在 test.support 模块中)

requires_resource() (在 test.support 模块中)

requires_zlib() (在 test.support 模块中)

RERAISE (opcode)

reserved (zipfile.ZipInfo 属性)

reserved word

RESERVED_FUTURE() (在 uuid 模块中)

RESERVED_MICROSOFT() (在 uuid 模块中)

RESERVED_NCS() (在 uuid 模块中)

reset() (bdb.Bdb 方法)

(codecs.IncrementalDecoder 方法)

(codecs.IncrementalEncoder 方法)

(codecs.StreamReader 方法)

(codecs.StreamWriter 方法)

(contextvars.ContextVar 方法)

(html.parser.HTMLParser 方法)

(ossaudiodev.oss_audio_device 方法)

(pipes.Template 方法)

(threading.Barrier 方法)

(xdrlib.Packer 方法)

(xdrlib.Unpacker 方法)

(xml.dom.pulldom.DOMEventStream 方法)

(xml.sax.xmlreader.IncrementalParser 方法)

(在 turtle 模块中)

reset_mock() (unittest.mock.AsyncMock 方法)

(unittest.mock.Mock 方法)

reset_peak() (在 tracemalloc 模块中)

reset_prog_mode() (在 curses 模块中)

reset_shell_mode() (在 curses 模块中)

reset_tzpath() (在 zoneinfo 模块中)

resetbuffer() (code.InteractiveConsole 方法)

resetlocale() (在 locale 模块中)

resetscreen() (在 turtle 模块中)

resetty() (在 curses 模块中)

resetwarnings() (在 warnings 模块中)

resize() (curses.window 方法)

(mmap.mmap 方法)

(在 ctypes 模块中)

resize_term() (在 curses 模块中)

resizemode() (在 turtle 模块中)

resizeterm() (在 curses 模块中)

resolution (datetime.date 属性)

(datetime.datetime 属性)

(datetime.time 属性)

(datetime.timedelta 属性)

resolve() (pathlib.Path 方法)

resolve_bases() (在 types 模块中)

resolve_name() (在 importlib.util 模块中)

(在 pkgutil 模块中)

resolveEntity() (xml.sax.handler.EntityResolver 方法)

resource

模块

Resource() (在 importlib.resources 模块中)

resource_path() (importlib.abc.ResourceReader 方法)

ResourceDenied

ResourceLoader (importlib.abc 中的类)

ResourceReader (importlib.abc 中的类)

ResourceWarning

response (nntplib.NNTPError 属性)

response() (imaplib.IMAP4 方法)

ResponseNotReady

responses (http.server.BaseHTTPRequestHandler 属性)

responses() (在 http.client 模块中)

restart (pdb command)

restore() (test.support.SaveSignals 方法)

(在 difflib 模块中)

RESTRICTED

restricted

execution

restype (ctypes._FuncPtr 属性)

result() (asyncio.Future 方法)

(asyncio.Task 方法)

(concurrent.futures.Future 方法)

results() (trace.Trace 方法)

resume_reading() (asyncio.ReadTransport 方法)

resume_writing() (asyncio.BaseProtocol 方法)

retr() (poplib.POP3 方法)

retrbinary() (ftplib.FTP 方法)

retrieve() (urllib.request.URLopener 方法)

retrlines() (ftplib.FTP 方法)

return

语句, [1], [2]

Return (ast 中的类)

return (pdb command)

return_annotation (inspect.Signature 属性)

return_ok() (http.cookiejar.CookiePolicy 方法)

RETURN_VALUE (opcode)

return_value (unittest.mock.Mock 属性)

returncode (asyncio.subprocess.Process 属性)

(subprocess.CalledProcessError 属性)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

retval (pdb command)

reverse() (array.array 方法)

(collections.deque 方法)

(sequence method)

(在 audioop 模块中)

reverse_order() (pstats.Stats 方法)

reverse_pointer (ipaddress.IPv4Address 属性)

(ipaddress.IPv6Address 属性)

reversed()

內置函数

Reversible (collections.abc 中的类)

(typing 中的类)

revert() (http.cookiejar.FileCookieJar 方法)

rewind() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

RFC

RFC 1014, [1]

RFC 1123

RFC 1321

RFC 1422, [1]

RFC 1521, [1], [2]

RFC 1522, [1], [2]

RFC 1524, [1]

RFC 1730

RFC 1738

RFC 1750

RFC 1766, [1]

RFC 1808, [1], [2]

RFC 1832, [1]

RFC 1869, [1]

RFC 1870, [1], [2]

RFC 1939, [1]

RFC 2033

RFC 2045, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

RFC 2045#section-6.8

RFC 2046, [1], [2]

RFC 2047, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12]

RFC 2060, [1]

RFC 2068

RFC 2104, [1]

RFC 2109, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

RFC 2183, [1], [2]

RFC 2231, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14]

RFC 2295

RFC 2324

RFC 2342, [1]

RFC 2368

RFC 2373, [1], [2]

RFC 2396, [1], [2], [3], [4]

RFC 2397

RFC 2449

RFC 2487

RFC 2595, [1]

RFC 2616, [1], [2], [3], [4], [5], [6], [7], [8], [9]

RFC 2640, [1], [2], [3], [4]

RFC 2732, [1], [2]

RFC 2818, [1]

RFC 2821

RFC 2822, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18]

RFC 2964

RFC 2965, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19]

RFC 2980, [1]

RFC 3164

RFC 3171

RFC 3207

RFC 3280

RFC 3330

RFC 3339

RFC 3454, [1]

RFC 3490, [1], [2], [3]

RFC 3490#section-3.1

RFC 3492, [1]

RFC 3493

RFC 3501

RFC 3542, [1]

RFC 3548

RFC 3596#section-2.5

RFC 3659

RFC 3879

RFC 3927

RFC 3977, [1], [2], [3], [4]

RFC 3986, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 4007, [1]

RFC 4086

RFC 4122, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 4180

RFC 4193

RFC 4217

RFC 4291, [1], [2]

RFC 4380

RFC 4627, [1]

RFC 4642

RFC 4648, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 4954, [1]

RFC 5161, [1]

RFC 5246, [1]

RFC 5280, [1], [2], [3], [4]

RFC 5321, [1], [2], [3], [4]

RFC 5322, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17], [18], [19], [20], [21], [22], [23]

RFC 5424, [1], [2], [3], [4]

RFC 5424#section-6

RFC 5735

RFC 5891

RFC 5895

RFC 5929

RFC 6066, [1], [2]

RFC 6125, [1]

RFC 6152, [1]

RFC 6531, [1], [2], [3], [4], [5], [6], [7], [8]

RFC 6532, [1], [2], [3], [4]

RFC 6585

RFC 6855, [1], [2], [3]

RFC 6856, [1]

RFC 7159, [1], [2]

RFC 7230, [1]

RFC 7231, [1], [2]

RFC 7238

RFC 7301, [1], [2]

RFC 7525

RFC 7540

RFC 7693

RFC 7725

RFC 7914

RFC 821, [1]

RFC 822, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

RFC 8297

RFC 8305, [1]

RFC 8470

RFC 854, [1]

RFC 959

RFC 977

rfc2109 (http.cookiejar.Cookie 属性)

rfc2109_as_netscape (http.cookiejar.DefaultCookiePolicy 属性)

rfc2965 (http.cookiejar.CookiePolicy 属性)

rfc822_escape() (在 distutils.util 模块中)

RFC_4122() (在 uuid 模块中)

rfile (http.server.BaseHTTPRequestHandler 属性)

rfind() (bytearray 方法)

(bytes 方法)

(mmap.mmap 方法)

(str 方法)

rgb_to_hls() (在 colorsys 模块中)

rgb_to_hsv() (在 colorsys 模块中)

rgb_to_yiq() (在 colorsys 模块中)

rglob() (pathlib.Path 方法)

richcmpfunc (C type)

right (filecmp.dircmp 属性)

right() (在 turtle 模块中)

right_list (filecmp.dircmp 属性)

right_only (filecmp.dircmp 属性)

RIGHTSHIFT() (在 token 模块中)

RIGHTSHIFTEQUAL() (在 token 模块中)

rindex() (bytearray 方法)

(bytes 方法)

(str 方法)

rjust() (bytearray 方法)

(bytes 方法)

(str 方法)

rlcompleter

模块

rlecode_hqx() (在 binascii 模块中)

rledecode_hqx() (在 binascii 模块中)

RLIM_INFINITY() (在 resource 模块中)

RLIMIT_AS() (在 resource 模块中)

RLIMIT_CORE() (在 resource 模块中)

RLIMIT_CPU() (在 resource 模块中)

RLIMIT_DATA() (在 resource 模块中)

RLIMIT_FSIZE() (在 resource 模块中)

RLIMIT_KQUEUES() (在 resource 模块中)

RLIMIT_MEMLOCK() (在 resource 模块中)

RLIMIT_MSGQUEUE() (在 resource 模块中)

RLIMIT_NICE() (在 resource 模块中)

RLIMIT_NOFILE() (在 resource 模块中)

RLIMIT_NPROC() (在 resource 模块中)

RLIMIT_NPTS() (在 resource 模块中)

RLIMIT_OFILE() (在 resource 模块中)

RLIMIT_RSS() (在 resource 模块中)

RLIMIT_RTPRIO() (在 resource 模块中)

RLIMIT_RTTIME() (在 resource 模块中)

RLIMIT_SBSIZE() (在 resource 模块中)

RLIMIT_SIGPENDING() (在 resource 模块中)

RLIMIT_STACK() (在 resource 模块中)

RLIMIT_SWAP() (在 resource 模块中)

RLIMIT_VMEM() (在 resource 模块中)

RLock (multiprocessing 中的类)

(threading 中的类)

RLock() (multiprocessing.managers.SyncManager 方法)

rmd() (ftplib.FTP 方法)

rmdir() (pathlib.Path 方法)

(在 os 模块中)

(在 test.support.os_helper 模块中)

RMFF

rms() (在 audioop 模块中)

rmtree() (在 shutil 模块中)

(在 test.support.os_helper 模块中)

RobotFileParser (urllib.robotparser 中的类)

robots.txt

rollback() (sqlite3.Connection 方法)

ROMAN() (在 tkinter.font 模块中)

root (pathlib.PurePath 属性)

ROT_FOUR (opcode)

ROT_N (opcode)

ROT_THREE (opcode)

ROT_TWO (opcode)

rotate() (collections.deque 方法)

(decimal.Context 方法)

(decimal.Decimal 方法)

(logging.handlers.BaseRotatingHandler 方法)

RotatingFileHandler (logging.handlers 中的类)

rotation_filename() (logging.handlers.BaseRotatingHandler 方法)

rotator (logging.handlers.BaseRotatingHandler 属性)

round

內置函数

round()

內置函数

ROUND_05UP() (在 decimal 模块中)

ROUND_CEILING() (在 decimal 模块中)

ROUND_DOWN() (在 decimal 模块中)

ROUND_FLOOR() (在 decimal 模块中)

ROUND_HALF_DOWN() (在 decimal 模块中)

ROUND_HALF_EVEN() (在 decimal 模块中)

ROUND_HALF_UP() (在 decimal 模块中)

ROUND_UP() (在 decimal 模块中)

Rounded (decimal 中的类)

Row (sqlite3 中的类)

row_factory (sqlite3.Connection 属性)

(sqlite3.Cursor 属性)

rowcount (sqlite3.Cursor 属性)

RPAR() (在 token 模块中)

rpartition() (bytearray 方法)

(bytes 方法)

(str 方法)

rpc_paths (xmlrpc.server.SimpleXMLRPCRequestHandler 属性)

rpop() (poplib.POP3 方法)

rset() (poplib.POP3 方法)

RShift (ast 中的类)

rshift() (在 operator 模块中)

rsplit() (bytearray 方法)

(bytes 方法)

(str 方法)

RSQB() (在 token 模块中)

rstrip() (bytearray 方法)

(bytes 方法)

(str 方法)

rt() (在 turtle 模块中)

RTLD_DEEPBIND() (在 os 模块中)

RTLD_GLOBAL() (在 os 模块中)

RTLD_LAZY() (在 os 模块中)

RTLD_LOCAL() (在 os 模块中)

RTLD_NODELETE() (在 os 模块中)

RTLD_NOLOAD() (在 os 模块中)

RTLD_NOW() (在 os 模块中)

ruler (cmd.Cmd 属性)

run (pdb command)

Run script

run() (bdb.Bdb 方法)

(contextvars.Context 方法)

(distutils.cmd.Command 方法)

(doctest.DocTestRunner 方法)

(multiprocessing.Process 方法)

(pdb.Pdb 方法)

(profile.Profile 方法)

(sched.scheduler 方法)

(test.support.BasicTestRunner 方法)

(threading.Thread 方法)

(trace.Trace 方法)

(unittest.IsolatedAsyncioTestCase 方法)

(unittest.TestCase 方法)

(unittest.TestSuite 方法)

(unittest.TextTestRunner 方法)

(wsgiref.handlers.BaseHandler 方法)

(在 asyncio 模块中)

(在 pdb 模块中)

(在 profile 模块中)

(在 subprocess 模块中)

run_coroutine_threadsafe() (在 asyncio 模块中)

run_docstring_examples() (在 doctest 模块中)

run_doctest() (在 test.support 模块中)

run_forever() (asyncio.loop 方法)

run_in_executor() (asyncio.loop 方法)

run_in_subinterp() (在 test.support 模块中)

run_module() (在 runpy 模块中)

run_path() (在 runpy 模块中)

run_python_until_end() (在 test.support.script_helper 模块中)

run_script() (modulefinder.ModuleFinder 方法)

run_setup() (在 distutils.core 模块中)

run_unittest() (在 test.support 模块中)

run_until_complete() (asyncio.loop 方法)

run_with_locale() (在 test.support 模块中)

run_with_tz() (在 test.support 模块中)

runcall() (bdb.Bdb 方法)

(pdb.Pdb 方法)

(profile.Profile 方法)

(在 pdb 模块中)

runcode() (code.InteractiveInterpreter 方法)

runctx() (bdb.Bdb 方法)

(profile.Profile 方法)

(trace.Trace 方法)

(在 profile 模块中)

runeval() (bdb.Bdb 方法)

(pdb.Pdb 方法)

(在 pdb 模块中)

runfunc() (trace.Trace 方法)

running() (concurrent.futures.Future 方法)

runpy

模块

runsource() (code.InteractiveInterpreter 方法)

runtime_checkable() (在 typing 模块中)

runtime_library_dir_option() (distutils.ccompiler.CCompiler 方法)

RuntimeError

RuntimeWarning

RUSAGE_BOTH() (在 resource 模块中)

RUSAGE_CHILDREN() (在 resource 模块中)

RUSAGE_SELF() (在 resource 模块中)

RUSAGE_THREAD() (在 resource 模块中)

RWF_APPEND() (在 os 模块中)

RWF_DSYNC() (在 os 模块中)

RWF_HIPRI() (在 os 模块中)

RWF_NOWAIT() (在 os 模块中)

RWF_SYNC() (在 os 模块中)

S

S() (在 re 模块中)

S_ENFMT() (在 stat 模块中)

S_IEXEC() (在 stat 模块中)

S_IFBLK() (在 stat 模块中)

S_IFCHR() (在 stat 模块中)

S_IFDIR() (在 stat 模块中)

S_IFDOOR() (在 stat 模块中)

S_IFIFO() (在 stat 模块中)

S_IFLNK() (在 stat 模块中)

S_IFMT() (在 stat 模块中)

S_IFPORT() (在 stat 模块中)

S_IFREG() (在 stat 模块中)

S_IFSOCK() (在 stat 模块中)

S_IFWHT() (在 stat 模块中)

S_IMODE() (在 stat 模块中)

S_IREAD() (在 stat 模块中)

S_IRGRP() (在 stat 模块中)

S_IROTH() (在 stat 模块中)

S_IRUSR() (在 stat 模块中)

S_IRWXG() (在 stat 模块中)

S_IRWXO() (在 stat 模块中)

S_IRWXU() (在 stat 模块中)

S_ISBLK() (在 stat 模块中)

S_ISCHR() (在 stat 模块中)

S_ISDIR() (在 stat 模块中)

S_ISDOOR() (在 stat 模块中)

S_ISFIFO() (在 stat 模块中)

S_ISGID() (在 stat 模块中)

S_ISLNK() (在 stat 模块中)

S_ISPORT() (在 stat 模块中)

S_ISREG() (在 stat 模块中)

S_ISSOCK() (在 stat 模块中)

S_ISUID() (在 stat 模块中)

S_ISVTX() (在 stat 模块中)

S_ISWHT() (在 stat 模块中)

S_IWGRP() (在 stat 模块中)

S_IWOTH() (在 stat 模块中)

S_IWRITE() (在 stat 模块中)

S_IWUSR() (在 stat 模块中)

S_IXGRP() (在 stat 模块中)

S_IXOTH() (在 stat 模块中)

S_IXUSR() (在 stat 模块中)

safe (uuid.SafeUUID 属性)

safe_substitute() (string.Template 方法)

SafeChildWatcher (asyncio 中的类)

saferepr() (在 pprint 模块中)

SafeUUID (uuid 中的类)

same_files (filecmp.dircmp 属性)

same_quantum() (decimal.Context 方法)

(decimal.Decimal 方法)

samefile() (pathlib.Path 方法)

(在 os.path 模块中)

SameFileError

sameopenfile() (在 os.path 模块中)

samestat() (在 os.path 模块中)

sample() (在 random 模块中)

samples() (statistics.NormalDist 方法)

SATURDAY() (在 calendar 模块中)

save() (http.cookiejar.FileCookieJar 方法)

(test.support.SaveSignals 方法)

SaveAs (tkinter.filedialog 中的类)

SAVEDCWD() (在 test.support.os_helper 模块中)

SaveFileDialog (tkinter.filedialog 中的类)

SaveKey() (在 winreg 模块中)

SaveSignals (test.support 中的类)

savetty() (在 curses 模块中)

SAX2DOM (xml.dom.pulldom 中的类)

SAXException

SAXNotRecognizedException

SAXNotSupportedException

SAXParseException

scaleb() (decimal.Context 方法)

(decimal.Decimal 方法)

scandir() (在 os 模块中)

scanf()

sched

模块

SCHED_BATCH() (在 os 模块中)

SCHED_FIFO() (在 os 模块中)

sched_get_priority_max() (在 os 模块中)

sched_get_priority_min() (在 os 模块中)

sched_getaffinity() (在 os 模块中)

sched_getparam() (在 os 模块中)

sched_getscheduler() (在 os 模块中)

SCHED_IDLE() (在 os 模块中)

SCHED_OTHER() (在 os 模块中)

sched_param (os 中的类)

sched_priority (os.sched_param 属性)

SCHED_RESET_ON_FORK() (在 os 模块中)

SCHED_RR() (在 os 模块中)

sched_rr_get_interval() (在 os 模块中)

sched_setaffinity() (在 os 模块中)

sched_setparam() (在 os 模块中)

sched_setscheduler() (在 os 模块中)

SCHED_SPORADIC() (在 os 模块中)

sched_yield() (在 os 模块中)

scheduler (sched 中的类)

schema() (在 msilib 模块中)

scope, [1]

scope_id (ipaddress.IPv6Address 属性)

Screen (turtle 中的类)

screensize() (在 turtle 模块中)

script_from_examples() (在 doctest 模块中)

scroll() (curses.window 方法)

ScrolledCanvas (turtle 中的类)

ScrolledText (tkinter.scrolledtext 中的类)

scrollok() (curses.window 方法)

scrypt() (在 hashlib 模块中)

sdterr

stdin stdout

seal() (在 unittest.mock 模块中)

search

path, module, [1], [2], [3], [4], [5], [6], [7]

search() (imaplib.IMAP4 方法)

(re.Pattern 方法)

(在 re 模块中)

second (datetime.datetime 属性)

(datetime.time 属性)

seconds since the epoch

secrets

模块

SECTCRE (configparser.ConfigParser 属性)

sections() (configparser.ConfigParser 方法)

secure (http.cookiejar.Cookie 属性)

secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512

Secure Sockets Layer

security

CGI

http.server

security considerations

security_level (ssl.SSLContext 属性)

see() (tkinter.ttk.Treeview 方法)

seed() (在 random 模块中)

seek() (chunk.Chunk 方法)

(io.IOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

SEEK_CUR() (在 os 模块中)

SEEK_END() (在 os 模块中)

SEEK_SET() (在 os 模块中)

seekable() (io.IOBase 方法)

seen_greeting (smtpd.SMTPChannel 属性)

select

模块

Select (tkinter.tix 中的类)

select() (imaplib.IMAP4 方法)

(selectors.BaseSelector 方法)

(tkinter.ttk.Notebook 方法)

(在 select 模块中)

selected_alpn_protocol() (ssl.SSLSocket 方法)

selected_npn_protocol() (ssl.SSLSocket 方法)

selection() (tkinter.ttk.Treeview 方法)

selection_add() (tkinter.ttk.Treeview 方法)

selection_remove() (tkinter.ttk.Treeview 方法)

selection_set() (tkinter.ttk.Treeview 方法)

selection_toggle() (tkinter.ttk.Treeview 方法)

selector (urllib.request.Request 属性)

SelectorEventLoop (asyncio 中的类)

SelectorKey (selectors 中的类)

selectors

模块

SelectSelector (selectors 中的类)

Semaphore (asyncio 中的类)

(multiprocessing 中的类)

(threading 中的类)

Semaphore() (multiprocessing.managers.SyncManager 方法)

semaphores, binary

SEMI() (在 token 模块中)

send() (asyncore.dispatcher 方法)

(coroutine 方法)

(generator 方法)

(http.client.HTTPConnection 方法)

(imaplib.IMAP4 方法)

(logging.handlers.DatagramHandler 方法)

(logging.handlers.SocketHandler 方法)

(multiprocessing.connection.Connection 方法)

(socket.socket 方法)

send_bytes() (multiprocessing.connection.Connection 方法)

send_error() (http.server.BaseHTTPRequestHandler 方法)

send_fds() (在 socket 模块中)

send_header() (http.server.BaseHTTPRequestHandler 方法)

send_message() (smtplib.SMTP 方法)

send_response() (http.server.BaseHTTPRequestHandler 方法)

send_response_only() (http.server.BaseHTTPRequestHandler 方法)

send_signal() (asyncio.subprocess.Process 方法)

(asyncio.SubprocessTransport 方法)

(subprocess.Popen 方法)

sendall() (socket.socket 方法)

sendcmd() (ftplib.FTP 方法)

sendfile() (asyncio.loop 方法)

(socket.socket 方法)

(wsgiref.handlers.BaseHandler 方法)

(在 os 模块中)

SendfileNotAvailableError

sendfunc (C type)

sendmail() (smtplib.SMTP 方法)

sendmsg() (socket.socket 方法)

sendmsg_afalg() (socket.socket 方法)

sendto() (asyncio.DatagramTransport 方法)

(socket.socket 方法)

sentinel (multiprocessing.Process 属性)

sentinel() (在 unittest.mock 模块中)

sep() (在 os 模块中)

sequence

item

iteration

types, immutable

types, mutable

types, operations on, [1]

对象, [1], [2], [3], [4], [5], [6], [7], [8]

Sequence (collections.abc 中的类)

(typing 中的类)

sequence() (在 msilib 模块中)

SequenceMatcher (difflib 中的类)

serializing

objects

serve_forever() (asyncio.Server 方法)

(socketserver.BaseServer 方法)

server

WWW, [1]

Server (asyncio 中的类)

server (http.server.BaseHTTPRequestHandler 属性)

server_activate() (socketserver.BaseServer 方法)

server_address (socketserver.BaseServer 属性)

server_bind() (socketserver.BaseServer 方法)

server_close() (socketserver.BaseServer 方法)

server_hostname (ssl.SSLSocket 属性)

server_side (ssl.SSLSocket 属性)

server_software (wsgiref.handlers.BaseHandler 属性)

server_version (http.server.BaseHTTPRequestHandler 属性)

(http.server.SimpleHTTPRequestHandler 属性)

ServerProxy (xmlrpc.client 中的类)

service_actions() (socketserver.BaseServer 方法)

session (ssl.SSLSocket 属性)

session_reused (ssl.SSLSocket 属性)

session_stats() (ssl.SSLContext 方法)

set

comprehensions

display

对象, [1], [2], [3]

Set (ast 中的类)

(collections.abc 中的类)

(typing 中的类)

set (內置类)

Set Breakpoint

set comprehension -- 集合推导式

set type

对象

set() (asyncio.Event 方法)

(configparser.ConfigParser 方法)

(configparser.RawConfigParser 方法)

(contextvars.ContextVar 方法)

(http.cookies.Morsel 方法)

(ossaudiodev.oss_mixer_device 方法)

(test.support.os_helper.EnvironmentVarGuard 方法)

(threading.Event 方法)

(tkinter.ttk.Combobox 方法)

(tkinter.ttk.Spinbox 方法)

(tkinter.ttk.Treeview 方法)

(xml.etree.ElementTree.Element 方法)

SET_ADD (opcode)

set_all()

set_allowed_domains() (http.cookiejar.DefaultCookiePolicy 方法)

set_alpn_protocols() (ssl.SSLContext 方法)

set_app() (wsgiref.simple_server.WSGIServer 方法)

set_asyncgen_hooks() (在 sys 模块中)

set_authorizer() (sqlite3.Connection 方法)

set_auto_history() (在 readline 模块中)

set_blocked_domains() (http.cookiejar.DefaultCookiePolicy 方法)

set_blocking() (在 os 模块中)

set_boundary() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_break() (bdb.Bdb 方法)

set_charset() (email.message.Message 方法)

set_child_watcher() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

set_children() (tkinter.ttk.Treeview 方法)

set_ciphers() (ssl.SSLContext 方法)

set_completer() (在 readline 模块中)

set_completer_delims() (在 readline 模块中)

set_completion_display_matches_hook() (在 readline 模块中)

set_content() (email.contentmanager.ContentManager 方法)

(email.message.EmailMessage 方法)

(在 email.contentmanager 模块中)

set_continue() (bdb.Bdb 方法)

set_cookie() (http.cookiejar.CookieJar 方法)

set_cookie_if_ok() (http.cookiejar.CookieJar 方法)

set_coroutine_origin_tracking_depth() (在 sys 模块中)

set_current() (msilib.Feature 方法)

set_data() (importlib.abc.SourceLoader 方法)

(importlib.machinery.SourceFileLoader 方法)

set_date() (mailbox.MaildirMessage 方法)

set_debug() (asyncio.loop 方法)

(在 gc 模块中)

set_debuglevel() (ftplib.FTP 方法)

(http.client.HTTPConnection 方法)

(nntplib.NNTP 方法)

(poplib.POP3 方法)

(smtplib.SMTP 方法)

(telnetlib.Telnet 方法)

set_default_executor() (asyncio.loop 方法)

set_default_type() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_default_verify_paths() (ssl.SSLContext 方法)

set_defaults() (argparse.ArgumentParser 方法)

(optparse.OptionParser 方法)

set_ecdh_curve() (ssl.SSLContext 方法)

set_errno() (在 ctypes 模块中)

set_escdelay() (在 curses 模块中)

set_event_loop() (asyncio.AbstractEventLoopPolicy 方法)

(在 asyncio 模块中)

set_event_loop_policy() (在 asyncio 模块中)

set_exception() (asyncio.Future 方法)

(concurrent.futures.Future 方法)

set_exception_handler() (asyncio.loop 方法)

set_executable() (在 multiprocessing 模块中)

set_executables() (distutils.ccompiler.CCompiler 方法)

set_filter() (tkinter.filedialog.FileDialog 方法)

set_flags() (mailbox.MaildirMessage 方法)

(mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

set_from() (mailbox.mboxMessage 方法)

(mailbox.MMDFMessage 方法)

set_handle_inheritable() (在 os 模块中)

set_history_length() (在 readline 模块中)

set_include_dirs() (distutils.ccompiler.CCompiler 方法)

set_info() (mailbox.MaildirMessage 方法)

set_inheritable() (socket.socket 方法)

(在 os 模块中)

set_int_max_str_digits() (在 sys 模块中)

set_labels() (mailbox.BabylMessage 方法)

set_last_error() (在 ctypes 模块中)

set_libraries() (distutils.ccompiler.CCompiler 方法)

set_library_dirs() (distutils.ccompiler.CCompiler 方法)

set_link_objects() (distutils.ccompiler.CCompiler 方法)

set_literal (2to3 fixer)

set_loader() (在 importlib.util 模块中)

set_match_tests() (在 test.support 模块中)

set_memlimit() (在 test.support 模块中)

set_name() (asyncio.Task 方法)

set_next() (bdb.Bdb 方法)

set_nonstandard_attr() (http.cookiejar.Cookie 方法)

set_npn_protocols() (ssl.SSLContext 方法)

set_ok() (http.cookiejar.CookiePolicy 方法)

set_option_negotiation_callback() (telnetlib.Telnet 方法)

set_output_charset() (gettext.NullTranslations 方法)

set_package() (在 importlib.util 模块中)

set_param() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_pasv() (ftplib.FTP 方法)

set_payload() (email.message.Message 方法)

set_policy() (http.cookiejar.CookieJar 方法)

set_position() (xdrlib.Unpacker 方法)

set_pre_input_hook() (在 readline 模块中)

set_progress_handler() (sqlite3.Connection 方法)

set_protocol() (asyncio.BaseTransport 方法)

set_proxy() (urllib.request.Request 方法)

set_python_build() (在 distutils.sysconfig 模块中)

set_quit() (bdb.Bdb 方法)

set_recsrc() (ossaudiodev.oss_mixer_device 方法)

set_result() (asyncio.Future 方法)

(concurrent.futures.Future 方法)

set_return() (bdb.Bdb 方法)

set_running_or_notify_cancel() (concurrent.futures.Future 方法)

set_runtime_library_dirs() (distutils.ccompiler.CCompiler 方法)

set_selection() (tkinter.filedialog.FileDialog 方法)

set_seq1() (difflib.SequenceMatcher 方法)

set_seq2() (difflib.SequenceMatcher 方法)

set_seqs() (difflib.SequenceMatcher 方法)

set_sequences() (mailbox.MH 方法)

(mailbox.MHMessage 方法)

set_server_documentation() (xmlrpc.server.DocCGIXMLRPCRequestHandler 方法)

(xmlrpc.server.DocXMLRPCServer 方法)

set_server_name() (xmlrpc.server.DocCGIXMLRPCRequestHandler 方法)

(xmlrpc.server.DocXMLRPCServer 方法)

set_server_title() (xmlrpc.server.DocCGIXMLRPCRequestHandler 方法)

(xmlrpc.server.DocXMLRPCServer 方法)

set_servername_callback (ssl.SSLContext 属性)

set_start_method() (在 multiprocessing 模块中)

set_startup_hook() (在 readline 模块中)

set_step() (bdb.Bdb 方法)

set_subdir() (mailbox.MaildirMessage 方法)

set_tabsize() (在 curses 模块中)

set_task_factory() (asyncio.loop 方法)

set_terminator() (asynchat.async_chat 方法)

set_threshold() (在 gc 模块中)

set_trace() (bdb.Bdb 方法)

(pdb.Pdb 方法)

(在 bdb 模块中)

(在 pdb 模块中)

set_trace_callback() (sqlite3.Connection 方法)

set_tunnel() (http.client.HTTPConnection 方法)

set_type() (email.message.Message 方法)

set_unittest_reportflags() (在 doctest 模块中)

set_unixfrom() (email.message.EmailMessage 方法)

(email.message.Message 方法)

set_until() (bdb.Bdb 方法)

SET_UPDATE (opcode)

set_url() (urllib.robotparser.RobotFileParser 方法)

set_usage() (optparse.OptionParser 方法)

set_userptr() (curses.panel.Panel 方法)

set_visible() (mailbox.BabylMessage 方法)

set_wakeup_fd() (在 signal 模块中)

set_write_buffer_limits() (asyncio.WriteTransport 方法)

setacl() (imaplib.IMAP4 方法)

SetAllocTrackerActivationThreshold() (xml.parsers.expat.xmlparser 方法)

SetAllocTrackerMaximumAmplification() (xml.parsers.expat.xmlparser 方法)

setannotation() (imaplib.IMAP4 方法)

setattr()

內置函数

setattrfunc (C type)

setAttribute() (xml.dom.Element 方法)

setAttributeNode() (xml.dom.Element 方法)

setAttributeNodeNS() (xml.dom.Element 方法)

setAttributeNS() (xml.dom.Element 方法)

setattrofunc (C type)

SetBase() (xml.parsers.expat.xmlparser 方法)

setblocking() (socket.socket 方法)

setByteStream() (xml.sax.xmlreader.InputSource 方法)

setcbreak() (在 tty 模块中)

setCharacterStream() (xml.sax.xmlreader.InputSource 方法)

SetComp (ast 中的类)

setcomptype() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setContentHandler() (xml.sax.xmlreader.XMLReader 方法)

setcontext() (在 decimal 模块中)

setDaemon() (threading.Thread 方法)

setdefault() (dict 方法)

(http.cookies.Morsel 方法)

setdefaulttimeout() (在 socket 模块中)

setdlopenflags() (在 sys 模块中)

setDocumentLocator() (xml.sax.handler.ContentHandler 方法)

setDTDHandler() (xml.sax.xmlreader.XMLReader 方法)

setegid() (在 os 模块中)

setEncoding() (xml.sax.xmlreader.InputSource 方法)

setEntityResolver() (xml.sax.xmlreader.XMLReader 方法)

setErrorHandler() (xml.sax.xmlreader.XMLReader 方法)

seteuid() (在 os 模块中)

setFeature() (xml.sax.xmlreader.XMLReader 方法)

setfirstweekday() (在 calendar 模块中)

setfmt() (ossaudiodev.oss_audio_device 方法)

setFormatter() (logging.Handler 方法)

setframerate() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setgid() (在 os 模块中)

setgroups() (在 os 模块中)

seth() (在 turtle 模块中)

setheading() (在 turtle 模块中)

sethostname() (在 socket 模块中)

setinputsizes() (sqlite3.Cursor 方法)

SetInteger() (msilib.Record 方法)

setitem() (在 operator 模块中)

setitimer() (在 signal 模块中)

setLevel() (logging.Handler 方法)

(logging.Logger 方法)

setLocale() (xml.sax.xmlreader.XMLReader 方法)

setlocale() (在 locale 模块中)

setLoggerClass() (在 logging 模块中)

setlogmask() (在 syslog 模块中)

setLogRecordFactory() (在 logging 模块中)

setmark() (aifc.aifc 方法)

setMaxConns() (urllib.request.CacheFTPHandler 方法)

setmode() (在 msvcrt 模块中)

setName() (threading.Thread 方法)

setnchannels() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setnframes() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setoutputsize() (sqlite3.Cursor 方法)

SetParamEntityParsing() (xml.parsers.expat.xmlparser 方法)

setparameters() (ossaudiodev.oss_audio_device 方法)

setparams() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setpassword() (zipfile.ZipFile 方法)

setpgid() (在 os 模块中)

setpgrp() (在 os 模块中)

setpos() (aifc.aifc 方法)

(sunau.AU_read 方法)

(wave.Wave_read 方法)

(在 turtle 模块中)

setposition() (在 turtle 模块中)

setpriority() (在 os 模块中)

setprofile() (在 sys 模块中)

(在 threading 模块中)

SetProperty() (msilib.SummaryInformation 方法)

setProperty() (xml.sax.xmlreader.XMLReader 方法)

setPublicId() (xml.sax.xmlreader.InputSource 方法)

setquota() (imaplib.IMAP4 方法)

setraw() (在 tty 模块中)

setrecursionlimit() (在 sys 模块中)

setregid() (在 os 模块中)

SetReparseDeferralEnabled() (xml.parsers.expat.xmlparser 方法)

setresgid() (在 os 模块中)

setresuid() (在 os 模块中)

setreuid() (在 os 模块中)

setrlimit() (在 resource 模块中)

setsampwidth() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

setscrreg() (curses.window 方法)

setsid() (在 os 模块中)

setsockopt() (socket.socket 方法)

setstate() (codecs.IncrementalDecoder 方法)

(codecs.IncrementalEncoder 方法)

(在 random 模块中)

setStream() (logging.StreamHandler 方法)

SetStream() (msilib.Record 方法)

SetString() (msilib.Record 方法)

setswitchinterval() (in module sys)

(在 sys 模块中)

(在 test.support 模块中)

setSystemId() (xml.sax.xmlreader.InputSource 方法)

setsyx() (在 curses 模块中)

setTarget() (logging.handlers.MemoryHandler 方法)

settiltangle() (在 turtle 模块中)

settimeout() (socket.socket 方法)

setTimeout() (urllib.request.CacheFTPHandler 方法)

settrace() (在 sys 模块中)

(在 threading 模块中)

setuid() (在 os 模块中)

setundobuffer() (在 turtle 模块中)

setup() (socketserver.BaseRequestHandler 方法)

setUp() (unittest.TestCase 方法)

setup() (在 distutils.core 模块中)

(在 turtle 模块中)

SETUP_ANNOTATIONS (opcode)

SETUP_ASYNC_WITH (opcode)

setup_environ() (wsgiref.handlers.BaseHandler 方法)

SETUP_FINALLY (opcode)

setup_python() (venv.EnvBuilder 方法)

setup_scripts() (venv.EnvBuilder 方法)

setup_testing_defaults() (在 wsgiref.util 模块中)

SETUP_WITH (opcode)

setUpClass() (unittest.TestCase 方法)

setupterm() (在 curses 模块中)

SetValue() (在 winreg 模块中)

SetValueEx() (在 winreg 模块中)

setworldcoordinates() (在 turtle 模块中)

setx() (在 turtle 模块中)

setxattr() (在 os 模块中)

sety() (在 turtle 模块中)

SF_APPEND() (在 stat 模块中)

SF_ARCHIVED() (在 stat 模块中)

SF_IMMUTABLE() (在 stat 模块中)

SF_MNOWAIT() (在 os 模块中)

SF_NODISKIO() (在 os 模块中)

SF_NOUNLINK() (在 stat 模块中)

SF_SNAPSHOT() (在 stat 模块中)

SF_SYNC() (在 os 模块中)

shape (memoryview 属性)

Shape (turtle 中的类)

shape() (在 turtle 模块中)

shapesize() (在 turtle 模块中)

shapetransform() (在 turtle 模块中)

share() (socket.socket 方法)

ShareableList (multiprocessing.shared_memory 中的类)

ShareableList() (multiprocessing.managers.SharedMemoryManager 方法)

Shared Memory

shared_ciphers() (ssl.SSLSocket 方法)

shared_object_filename() (distutils.ccompiler.CCompiler 方法)

SharedMemory (multiprocessing.shared_memory 中的类)

SharedMemory() (multiprocessing.managers.SharedMemoryManager 方法)

SharedMemoryManager (multiprocessing.managers 中的类)

shearfactor() (在 turtle 模块中)

Shelf (shelve 中的类)

shelve

模块, [1]

shield() (在 asyncio 模块中)

shift() (decimal.Context 方法)

(decimal.Decimal 方法)

shift_path_info() (在 wsgiref.util 模块中)

shifting

operation

operations

shlex

模块

shlex (shlex 中的类)

shm (multiprocessing.shared_memory.ShareableList 属性)

SHORT_TIMEOUT() (在 test.support 模块中)

shortDescription() (unittest.TestCase 方法)

shorten() (在 textwrap 模块中)

shouldFlush() (logging.handlers.BufferingHandler 方法)

(logging.handlers.MemoryHandler 方法)

shouldStop (unittest.TestResult 属性)

show() (curses.panel.Panel 方法)

(tkinter.commondialog.Dialog 方法)

show_code() (在 dis 模块中)

show_compilers() (在 distutils.ccompiler 模块中)

showerror() (在 tkinter.messagebox 模块中)

showinfo() (在 tkinter.messagebox 模块中)

showsyntaxerror() (code.InteractiveInterpreter 方法)

showtraceback() (code.InteractiveInterpreter 方法)

showturtle() (在 turtle 模块中)

showwarning() (在 tkinter.messagebox 模块中)

(在 warnings 模块中)

shuffle() (在 random 模块中)

shutdown() (concurrent.futures.Executor 方法)

(imaplib.IMAP4 方法)

(multiprocessing.managers.BaseManager 方法)

(socket.socket 方法)

(socketserver.BaseServer 方法)

(在 logging 模块中)

shutdown_asyncgens() (asyncio.loop 方法)

shutdown_default_executor() (asyncio.loop 方法)

shutil

模块

side_effect (unittest.mock.Mock 属性)

SIG_BLOCK() (在 signal 模块中)

SIG_DFL() (在 signal 模块中)

SIG_IGN() (在 signal 模块中)

SIG_SETMASK() (在 signal 模块中)

SIG_UNBLOCK() (在 signal 模块中)

SIGABRT() (在 signal 模块中)

SIGALRM() (在 signal 模块中)

SIGBREAK() (在 signal 模块中)

SIGBUS() (在 signal 模块中)

SIGCHLD() (在 signal 模块中)

SIGCLD() (在 signal 模块中)

SIGCONT() (在 signal 模块中)

SIGFPE() (在 signal 模块中)

SIGHUP() (在 signal 模块中)

SIGILL() (在 signal 模块中)

SIGINT, [1]

SIGINT() (在 signal 模块中)

siginterrupt() (在 signal 模块中)

SIGKILL() (在 signal 模块中)

signal

模块, [1], [2], [3], [4]

signal() (在 signal 模块中)

Signature (inspect 中的类)

signature (inspect.BoundArguments 属性)

signature() (在 inspect 模块中)

sigpending() (在 signal 模块中)

SIGPIPE() (在 signal 模块中)

SIGSEGV() (在 signal 模块中)

SIGTERM() (在 signal 模块中)

sigtimedwait() (在 signal 模块中)

SIGUSR1() (在 signal 模块中)

SIGUSR2() (在 signal 模块中)

sigwait() (在 signal 模块中)

sigwaitinfo() (在 signal 模块中)

SIGWINCH() (在 signal 模块中)

simple

statement

Simple Mail Transfer Protocol

SimpleCookie (http.cookies 中的类)

simplefilter() (在 warnings 模块中)

SimpleHandler (wsgiref.handlers 中的类)

SimpleHTTPRequestHandler (http.server 中的类)

SimpleNamespace (types 中的类)

SimpleQueue (multiprocessing 中的类)

(queue 中的类)

SimpleXMLRPCRequestHandler (xmlrpc.server 中的类)

SimpleXMLRPCServer (xmlrpc.server 中的类)

sin() (在 cmath 模块中)

(在 math 模块中)

single dispatch -- 单分派

SingleAddressHeader (email.headerregistry 中的类)

singledispatch() (在 functools 模块中)

singledispatchmethod (functools 中的类)

singleton

tuple

sinh() (在 cmath 模块中)

(在 math 模块中)

SIO_KEEPALIVE_VALS() (在 socket 模块中)

SIO_LOOPBACK_FAST_PATH() (在 socket 模块中)

SIO_RCVALL() (在 socket 模块中)

site

模块

site command line option

--user-base

--user-site

site-packages

directory

site_maps() (urllib.robotparser.RobotFileParser 方法)

sitecustomize

模块

sixtofour (ipaddress.IPv6Address 属性)

size (multiprocessing.shared_memory.SharedMemory 属性)

(struct.Struct 属性)

(tarfile.TarInfo 属性)

(tracemalloc.Statistic 属性)

(tracemalloc.StatisticDiff 属性)

(tracemalloc.Trace 属性)

size() (ftplib.FTP 方法)

(mmap.mmap 方法)

size_diff (tracemalloc.StatisticDiff 属性)

SIZE_MAX

Sized (collections.abc 中的类)

(typing 中的类)

sizeof() (在 ctypes 模块中)

skip() (chunk.Chunk 方法)

SKIP() (在 doctest 模块中)

skip() (在 unittest 模块中)

skip_if_broken_multiprocessing_synchronize() (在 test.support 模块中)

skip_unless_bind_unix_socket() (在 test.support.socket_helper 模块中)

skip_unless_symlink() (在 test.support.os_helper 模块中)

skip_unless_xattr() (在 test.support.os_helper 模块中)

skipIf() (在 unittest 模块中)

skipinitialspace (csv.Dialect 属性)

skipped (unittest.TestResult 属性)

skippedEntity() (xml.sax.handler.ContentHandler 方法)

SkipTest

skipTest() (unittest.TestCase 方法)

skipUnless() (在 unittest 模块中)

SLASH() (在 token 模块中)

SLASHEQUAL() (在 token 模块中)

slave() (nntplib.NNTP 方法)

sleep() (在 asyncio 模块中)

(在 time 模块中)

slice

assignment

operation

內置函数, [1]

对象

Slice (ast 中的类)

slice (內置类)

slice -- 切片

slicing, [1], [2]

assignment

SMALLEST() (在 test.support 模块中)

SMTP

protocol

SMTP (smtplib 中的类)

SMTP() (在 email.policy 模块中)

smtp_server (smtpd.SMTPChannel 属性)

SMTP_SSL (smtplib 中的类)

smtp_state (smtpd.SMTPChannel 属性)

SMTPAuthenticationError

SMTPChannel (smtpd 中的类)

SMTPConnectError

smtpd

模块

SMTPDataError

SMTPException

SMTPHandler (logging.handlers 中的类)

SMTPHeloError

smtplib

模块

SMTPNotSupportedError

SMTPRecipientsRefused

SMTPResponseException

SMTPSenderRefused

SMTPServer (smtpd 中的类)

SMTPServerDisconnected

SMTPUTF8() (在 email.policy 模块中)

Snapshot (tracemalloc 中的类)

SND_ALIAS() (在 winsound 模块中)

SND_ASYNC() (在 winsound 模块中)

SND_FILENAME() (在 winsound 模块中)

SND_LOOP() (在 winsound 模块中)

SND_MEMORY() (在 winsound 模块中)

SND_NODEFAULT() (在 winsound 模块中)

SND_NOSTOP() (在 winsound 模块中)

SND_NOWAIT() (在 winsound 模块中)

SND_PURGE() (在 winsound 模块中)

sndhdr

模块

sni_callback (ssl.SSLContext 属性)

sniff() (csv.Sniffer 方法)

Sniffer (csv 中的类)

sock_accept() (asyncio.loop 方法)

SOCK_CLOEXEC() (在 socket 模块中)

sock_connect() (asyncio.loop 方法)

SOCK_DGRAM() (在 socket 模块中)

SOCK_MAX_SIZE() (在 test.support 模块中)

SOCK_NONBLOCK() (在 socket 模块中)

SOCK_RAW() (在 socket 模块中)

SOCK_RDM() (在 socket 模块中)

sock_recv() (asyncio.loop 方法)

sock_recv_into() (asyncio.loop 方法)

sock_sendall() (asyncio.loop 方法)

sock_sendfile() (asyncio.loop 方法)

SOCK_SEQPACKET() (在 socket 模块中)

SOCK_STREAM() (在 socket 模块中)

socket

对象

模块, [1]

socket (socket 中的类)

(socketserver.BaseServer 属性)

socket() (imaplib.IMAP4 方法)

(in module socket)

socket_type (socketserver.BaseServer 属性)

SocketHandler (logging.handlers 中的类)

socketpair() (在 socket 模块中)

sockets (asyncio.Server 属性)

socketserver

模块

SocketType() (在 socket 模块中)

soft keyword

SOFT_KEYWORD() (在 token 模块中)

softkwlist() (在 keyword 模块中)

SOL_ALG() (在 socket 模块中)

SOL_RDS() (在 socket 模块中)

SOMAXCONN() (在 socket 模块中)

sort() (imaplib.IMAP4 方法)

(list 方法)

sort_stats() (pstats.Stats 方法)

sortdict() (在 test.support 模块中)

sorted()

內置函数

sortTestMethodsUsing (unittest.TestLoader 属性)

source (doctest.Example 属性)

(pdb command)

(shlex.shlex 属性)

source character set

SOURCE_DATE_EPOCH, [1], [2], [3], [4], [5], [6]

source_from_cache() (在 imp 模块中)

(在 importlib.util 模块中)

source_hash() (在 importlib.util 模块中)

SOURCE_SUFFIXES() (在 importlib.machinery 模块中)

source_to_code() (importlib.abc.InspectLoader 静态方法)

SourceFileLoader (importlib.machinery 中的类)

sourcehook() (shlex.shlex 方法)

SourcelessFileLoader (importlib.machinery 中的类)

SourceLoader (importlib.abc 中的类)

space

in printf-style formatting, [1]

in string formatting

span() (re.Match 方法)

spawn() (distutils.ccompiler.CCompiler 方法)

(在 pty 模块中)

spawn_python() (在 test.support.script_helper 模块中)

spawnl() (在 os 模块中)

spawnle() (在 os 模块中)

spawnlp() (在 os 模块中)

spawnlpe() (在 os 模块中)

spawnv() (在 os 模块中)

spawnve() (在 os 模块中)

spawnvp() (在 os 模块中)

spawnvpe() (在 os 模块中)

spec_from_file_location() (在 importlib.util 模块中)

spec_from_loader() (在 importlib.util 模块中)

special

attribute

attribute, generic

method

special method -- 特殊方法

SpecialFileError

specified_attributes (xml.parsers.expat.xmlparser 属性)

speed() (ossaudiodev.oss_audio_device 方法)

(在 turtle 模块中)

Spinbox (tkinter.ttk 中的类)

splice() (在 os 模块中)

SPLICE_F_MORE() (在 os 模块中)

SPLICE_F_MOVE() (在 os 模块中)

SPLICE_F_NONBLOCK() (在 os 模块中)

split() (bytearray 方法)

(bytes 方法)

(re.Pattern 方法)

(str 方法)

(在 os.path 模块中)

(在 re 模块中)

(在 shlex 模块中)

split_quoted() (在 distutils.util 模块中)

splitdrive() (在 os.path 模块中)

splitext() (在 os.path 模块中)

splitlines() (bytearray 方法)

(bytes 方法)

(str 方法)

SplitResult (urllib.parse 中的类)

SplitResultBytes (urllib.parse 中的类)

SpooledTemporaryFile (tempfile 中的类)

sprintf-style formatting, [1]

spwd

模块

sqlite3

模块

SQLITE_DENY() (在 sqlite3 模块中)

SQLITE_IGNORE() (在 sqlite3 模块中)

SQLITE_OK() (在 sqlite3 模块中)

sqlite_version() (在 sqlite3 模块中)

sqlite_version_info() (在 sqlite3 模块中)

sqrt() (decimal.Context 方法)

(decimal.Decimal 方法)

(在 cmath 模块中)

(在 math 模块中)

ssizeargfunc (C type)

ssizeobjargproc (C type)

SSL

ssl

模块

ssl_version (ftplib.FTP_TLS 属性)

SSLCertVerificationError

SSLContext (ssl 中的类)

SSLEOFError

SSLError

SSLErrorNumber (ssl 中的类)

SSLKEYLOGFILE, [1]

SSLObject (ssl 中的类)

sslobject_class (ssl.SSLContext 属性)

SSLSession (ssl 中的类)

SSLSocket (ssl 中的类)

sslsocket_class (ssl.SSLContext 属性)

SSLSyscallError

SSLv3 (ssl.TLSVersion 属性)

SSLWantReadError

SSLWantWriteError

SSLZeroReturnError

st() (在 turtle 模块中)

st_atime (os.stat_result 属性)

ST_ATIME() (在 stat 模块中)

st_atime_ns (os.stat_result 属性)

st_birthtime (os.stat_result 属性)

st_blksize (os.stat_result 属性)

st_blocks (os.stat_result 属性)

st_creator (os.stat_result 属性)

st_ctime (os.stat_result 属性)

ST_CTIME() (在 stat 模块中)

st_ctime_ns (os.stat_result 属性)

st_dev (os.stat_result 属性)

ST_DEV() (在 stat 模块中)

st_file_attributes (os.stat_result 属性)

st_flags (os.stat_result 属性)

st_fstype (os.stat_result 属性)

st_gen (os.stat_result 属性)

st_gid (os.stat_result 属性)

ST_GID() (在 stat 模块中)

st_ino (os.stat_result 属性)

ST_INO() (在 stat 模块中)

st_mode (os.stat_result 属性)

ST_MODE() (在 stat 模块中)

st_mtime (os.stat_result 属性)

ST_MTIME() (在 stat 模块中)

st_mtime_ns (os.stat_result 属性)

st_nlink (os.stat_result 属性)

ST_NLINK() (在 stat 模块中)

st_rdev (os.stat_result 属性)

st_reparse_tag (os.stat_result 属性)

st_rsize (os.stat_result 属性)

st_size (os.stat_result 属性)

ST_SIZE() (在 stat 模块中)

st_type (os.stat_result 属性)

st_uid (os.stat_result 属性)

ST_UID() (在 stat 模块中)

stack

execution

trace

stack (traceback.TracebackException 属性)

stack viewer

stack() (在 inspect 模块中)

stack_effect() (在 dis 模块中)

stack_size() (在 _thread 模块中)

(在 threading 模块中)

stackable

streams

StackSummary (traceback 中的类)

stamp() (在 turtle 模块中)

standard

output

Standard C

standard input

standard_b64decode() (在 base64 模块中)

standard_b64encode() (在 base64 模块中)

standarderror (2to3 fixer)

standend() (curses.window 方法)

standout() (curses.window 方法)

STAR() (在 token 模块中)

STAREQUAL() (在 token 模块中)

starmap() (multiprocessing.pool.Pool 方法)

(在 itertools 模块中)

starmap_async() (multiprocessing.pool.Pool 方法)

Starred (ast 中的类)

start (range 属性)

(slice object attribute), [1]

(UnicodeError 属性)

start() (logging.handlers.QueueListener 方法)

(multiprocessing.managers.BaseManager 方法)

(multiprocessing.Process 方法)

(re.Match 方法)

(threading.Thread 方法)

(tkinter.ttk.Progressbar 方法)

(xml.etree.ElementTree.TreeBuilder 方法)

(在 tracemalloc 模块中)

start_color() (在 curses 模块中)

start_component() (msilib.Directory 方法)

start_new_thread() (在 _thread 模块中)

start_ns() (xml.etree.ElementTree.TreeBuilder 方法)

start_server() (在 asyncio 模块中)

start_serving() (asyncio.Server 方法)

start_threads() (在 test.support.threading_helper 模块中)

start_tls() (asyncio.loop 方法)

start_unix_server() (在 asyncio 模块中)

startCDATA() (xml.sax.handler.LexicalHandler 方法)

StartCdataSectionHandler() (xml.parsers.expat.xmlparser 方法)

StartDoctypeDeclHandler() (xml.parsers.expat.xmlparser 方法)

startDocument() (xml.sax.handler.ContentHandler 方法)

startDTD() (xml.sax.handler.LexicalHandler 方法)

startElement() (xml.sax.handler.ContentHandler 方法)

StartElementHandler() (xml.parsers.expat.xmlparser 方法)

startElementNS() (xml.sax.handler.ContentHandler 方法)

STARTF_USESHOWWINDOW() (在 subprocess 模块中)

STARTF_USESTDHANDLES() (在 subprocess 模块中)

startfile() (在 os 模块中)

StartNamespaceDeclHandler() (xml.parsers.expat.xmlparser 方法)

startPrefixMapping() (xml.sax.handler.ContentHandler 方法)

startswith() (bytearray 方法)

(bytes 方法)

(str 方法)

startTest() (unittest.TestResult 方法)

startTestRun() (unittest.TestResult 方法)

starttls() (imaplib.IMAP4 方法)

(nntplib.NNTP 方法)

(smtplib.SMTP 方法)

STARTUPINFO (subprocess 中的类)

stat

模块, [1]

stat() (nntplib.NNTP 方法)

(os.DirEntry 方法)

(pathlib.Path 方法)

(poplib.POP3 方法)

(在 os 模块中)

stat_result (os 中的类)

state() (tkinter.ttk.Widget 方法)

statement

assignment, [1]

assignment, annotated

assignment, augmented

compound

expression

future

loop, [1], [2], [3]

simple

statement -- 语句

statement grouping

static_order() (graphlib.TopologicalSorter 方法)

staticmethod

內置函数

staticmethod()

內置函数

Statistic (tracemalloc 中的类)

StatisticDiff (tracemalloc 中的类)

statistics

模块

statistics() (tracemalloc.Snapshot 方法)

StatisticsError

Stats (pstats 中的类)

status (http.client.HTTPResponse 属性)

(urllib.response.addinfourl 属性)

status() (imaplib.IMAP4 方法)

statvfs() (在 os 模块中)

STD_ERROR_HANDLE() (在 subprocess 模块中)

STD_INPUT_HANDLE() (在 subprocess 模块中)

STD_OUTPUT_HANDLE() (在 subprocess 模块中)

StdButtonBox (tkinter.tix 中的类)

stderr (asyncio.subprocess.Process 属性)

(in module sys), [1]

(subprocess.CalledProcessError 属性)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

(subprocess.TimeoutExpired 属性)

stderr() (在 sys 模块中)

stdev (statistics.NormalDist 属性)

stdev() (在 statistics 模块中)

stdin

stdout sdterr

stdin (asyncio.subprocess.Process 属性)

(in module sys), [1]

(subprocess.Popen 属性)

stdin() (在 sys 模块中)

stdio

stdlib_module_names() (在 sys 模块中)

stdout

sdterr, stdin

stdout (asyncio.subprocess.Process 属性)

(in module sys), [1]

(subprocess.CalledProcessError 属性)

(subprocess.CompletedProcess 属性)

(subprocess.Popen 属性)

(subprocess.TimeoutExpired 属性)

STDOUT() (在 subprocess 模块中)

stdout() (在 sys 模块中)

stem (pathlib.PurePath 属性)

step (pdb command)

(range 属性)

(slice object attribute), [1]

step() (tkinter.ttk.Progressbar 方法)

stereocontrols() (ossaudiodev.oss_mixer_device 方法)

stls() (poplib.POP3 方法)

stop (range 属性)

(slice object attribute), [1]

stop() (asyncio.loop 方法)

(logging.handlers.QueueListener 方法)

(tkinter.ttk.Progressbar 方法)

(unittest.TestResult 方法)

(在 tracemalloc 模块中)

stop_here() (bdb.Bdb 方法)

StopAsyncIteration

例外

StopIteration

例外, [1]

stopListening() (在 logging.config 模块中)

stopTest() (unittest.TestResult 方法)

stopTestRun() (unittest.TestResult 方法)

storbinary() (ftplib.FTP 方法)

Store (ast 中的类)

store() (imaplib.IMAP4 方法)

STORE_ACTIONS (optparse.Option 属性)

STORE_ATTR (opcode)

STORE_DEREF (opcode)

STORE_FAST (opcode)

STORE_GLOBAL (opcode)

STORE_NAME (opcode)

STORE_SUBSCR (opcode)

storlines() (ftplib.FTP 方法)

str (built-in class)

(see also string)

str (內置类)

str() (在 locale 模块中)

strcoll() (在 locale 模块中)

StreamError

StreamHandler (logging 中的类)

StreamReader (asyncio 中的类)

(codecs 中的类)

streamreader (codecs.CodecInfo 属性)

StreamReaderWriter (codecs 中的类)

StreamRecoder (codecs 中的类)

StreamRequestHandler (socketserver 中的类)

streams

stackable

StreamWriter (asyncio 中的类)

(codecs 中的类)

streamwriter (codecs.CodecInfo 属性)

strerror (OSError 属性)

strerror()

(在 os 模块中)

strftime() (datetime.date 方法)

(datetime.datetime 方法)

(datetime.time 方法)

(在 time 模块中)

strict

error handler's name

strict (csv.Dialect 属性)

strict() (在 email.policy 模块中)

strict_domain (http.cookiejar.DefaultCookiePolicy 属性)

strict_errors() (在 codecs 模块中)

strict_ns_domain (http.cookiejar.DefaultCookiePolicy 属性)

strict_ns_set_initial_dollar (http.cookiejar.DefaultCookiePolicy 属性)

strict_ns_set_path (http.cookiejar.DefaultCookiePolicy 属性)

strict_ns_unverifiable (http.cookiejar.DefaultCookiePolicy 属性)

strict_rfc2965_unverifiable (http.cookiejar.DefaultCookiePolicy 属性)

strides (memoryview 属性)

string

__format__() (object method)

__str__() (object method)

conversion, [1]

format() (built-in function)

formatted literal

formatting, printf

immutable sequences

interpolated literal

interpolation, printf

item

methods

object representation

PyObject_Str (C function)

str (built-in class)

str() (built-in function)

text sequence type

对象, [1], [2]

模块, [1]

string (re.Match 属性)

string literal

STRING() (在 token 模块中)

string_at() (在 ctypes 模块中)

StringIO (io 中的类)

stringprep

模块

strings, documentation, [1]

strip() (bytearray 方法)

(bytes 方法)

(str 方法)

strip_dirs() (pstats.Stats 方法)

stripspaces (curses.textpad.Textbox 属性)

strong reference -- 强引用

strptime() (datetime.datetime 类方法)

(在 time 模块中)

strsignal() (在 signal 模块中)

strtobool() (在 distutils.util 模块中)

struct

模块, [1]

Struct (struct 中的类)

struct_time (time 中的类)

Structure (ctypes 中的类)

structures

C

strxfrm() (在 locale 模块中)

style

coding

Style (tkinter.ttk 中的类)

Sub (ast 中的类)

sub() (re.Pattern 方法)

(在 operator 模块中)

(在 re 模块中)

sub_commands (distutils.cmd.Command 属性)

subclassing

immutable types

subdirs (filecmp.dircmp 属性)

SubElement() (在 xml.etree.ElementTree 模块中)

submit() (concurrent.futures.Executor 方法)

submodule_search_locations (importlib.machinery.ModuleSpec 属性)

subn() (re.Pattern 方法)

(在 re 模块中)

subnet_of() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

subnets() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

Subnormal (decimal 中的类)

suboffsets (memoryview 属性)

subpad() (curses.window 方法)

subprocess

模块

subprocess_exec() (asyncio.loop 方法)

subprocess_shell() (asyncio.loop 方法)

SubprocessError

SubprocessProtocol (asyncio 中的类)

SubprocessTransport (asyncio 中的类)

subscribe() (imaplib.IMAP4 方法)

subscript

assignment

operation

Subscript (ast 中的类)

subscription, [1], [2], [3]

assignment

subsequent_indent (textwrap.TextWrapper 属性)

subst_vars() (在 distutils.util 模块中)

substitute() (string.Template 方法)

subTest() (unittest.TestCase 方法)

subtract() (collections.Counter 方法)

(decimal.Context 方法)

subtraction

subtype (email.headerregistry.ContentTypeHeader 属性)

subwin() (curses.window 方法)

successful() (multiprocessing.pool.AsyncResult 方法)

suffix (pathlib.PurePath 属性)

suffix_map (mimetypes.MimeTypes 属性)

suffix_map() (在 mimetypes 模块中)

suffixes (pathlib.PurePath 属性)

suite

suiteClass (unittest.TestLoader 属性)

sum()

內置函数

sum_list()

sum_sequence(), [1]

summarize() (doctest.DocTestRunner 方法)

summarize_address_range() (在 ipaddress 模块中)

sunau

模块

SUNDAY() (在 calendar 模块中)

super (pyclbr.Class 属性)

(內置类)

supernet() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

supernet_of() (ipaddress.IPv4Network 方法)

(ipaddress.IPv6Network 方法)

supports_bytes_environ() (在 os 模块中)

supports_dir_fd() (在 os 模块中)

supports_effective_ids() (在 os 模块中)

supports_fd() (在 os 模块中)

supports_follow_symlinks() (在 os 模块中)

supports_unicode_filenames() (在 os.path 模块中)

SupportsAbs (typing 中的类)

SupportsBytes (typing 中的类)

SupportsComplex (typing 中的类)

SupportsFloat (typing 中的类)

SupportsIndex (typing 中的类)

SupportsInt (typing 中的类)

SupportsRound (typing 中的类)

suppress() (在 contextlib 模块中)

SuppressCrashReport (test.support 中的类)

surrogateescape

error handler's name

surrogatepass

error handler's name

SW_HIDE() (在 subprocess 模块中)

swap_attr() (在 test.support 模块中)

swap_item() (在 test.support 模块中)

swapcase() (bytearray 方法)

(bytes 方法)

(str 方法)

Symbol (symtable 中的类)

SymbolTable (symtable 中的类)

symlink() (在 os 模块中)

symlink_to() (pathlib.Path 方法)

symmetric_difference() (frozenset 方法)

symmetric_difference_update() (frozenset 方法)

symtable

模块

symtable() (在 symtable 模块中)

sync() (dbm.dumb.dumbdbm 方法)

(dbm.gnu.gdbm 方法)

(ossaudiodev.oss_audio_device 方法)

(shelve.Shelf 方法)

(在 os 模块中)

syncdown() (curses.window 方法)

synchronized() (在 multiprocessing.sharedctypes 模块中)

SyncManager (multiprocessing.managers 中的类)

syncok() (curses.window 方法)

syncup() (curses.window 方法)

syntax

SyntaxErr

SyntaxError

SyntaxWarning

sys

模块, [1], [2], [3], [4], [5], [6], [7]

sys.exc_info

sys.last_traceback

sys.meta_path

sys.modules

sys.path

sys.path_hooks

sys.path_importer_cache

sys.stderr

sys.stdin

sys.stdout

sys_exc (2to3 fixer)

sys_version (http.server.BaseHTTPRequestHandler 属性)

sysconf() (在 os 模块中)

sysconf_names() (在 os 模块中)

sysconfig

模块

syslog

模块

syslog() (在 syslog 模块中)

SysLogHandler (logging.handlers 中的类)

system() (在 os 模块中)

(在 platform 模块中)

system_alias() (在 platform 模块中)

system_must_validate_cert() (在 test.support 模块中)

SystemError

(built-in exception), [1]

SystemExit

(built-in exception)

systemId (xml.dom.DocumentType 属性)

SystemRandom (random 中的类)

(secrets 中的类)

SystemRoot

T

T_FMT() (在 locale 模块中)

T_FMT_AMPM() (在 locale 模块中)

tab

tab() (tkinter.ttk.Notebook 方法)

TabError

tabnanny

模块

tabs() (tkinter.ttk.Notebook 方法)

tabsize (textwrap.TextWrapper 属性)

tabular

data

tag (xml.etree.ElementTree.Element 属性)

tag_bind() (tkinter.ttk.Treeview 方法)

tag_configure() (tkinter.ttk.Treeview 方法)

tag_has() (tkinter.ttk.Treeview 方法)

tagName (xml.dom.Element 属性)

tail (xml.etree.ElementTree.Element 属性)

take_snapshot() (在 tracemalloc 模块中)

takewhile() (在 itertools 模块中)

tan() (在 cmath 模块中)

(在 math 模块中)

tanh() (在 cmath 模块中)

(在 math 模块中)

tar_filter() (在 tarfile 模块中)

TarError

tarfile

模块

TarFile (tarfile 中的类)

tarfile command line option

--create <tarfile> <source1> ... <sourceN>

--extract <tarfile> [<output_dir>]

--filter <filtername>

--list <tarfile>

--test <tarfile>

--verbose

-c <tarfile> <source1> ... <sourceN>

-e <tarfile> [<output_dir>]

-l <tarfile>

-t <tarfile>

-v

target

deletion

list, [1]

list assignment

list, deletion

loop control

target (xml.dom.ProcessingInstruction 属性)

TarInfo (tarfile 中的类)

tarinfo (tarfile.FilterError 属性)

Task (asyncio 中的类)

task_done() (asyncio.Queue 方法)

(multiprocessing.JoinableQueue 方法)

(queue.Queue 方法)

tau() (在 cmath 模块中)

(在 math 模块中)

tb_frame (traceback attribute)

tb_lasti (traceback attribute)

tb_lineno (traceback attribute)

tb_locals (unittest.TestResult 属性)

tb_next (traceback attribute)

tbreak (pdb command)

tcdrain() (在 termios 模块中)

tcflow() (在 termios 模块中)

tcflush() (在 termios 模块中)

tcgetattr() (在 termios 模块中)

tcgetpgrp() (在 os 模块中)

Tcl() (在 tkinter 模块中)

TCL_LIBRARY

TCPServer (socketserver 中的类)

tcsendbreak() (在 termios 模块中)

tcsetattr() (在 termios 模块中)

tcsetpgrp() (在 os 模块中)

tearDown() (unittest.TestCase 方法)

tearDownClass() (unittest.TestCase 方法)

tee() (在 itertools 模块中)

tell() (aifc.aifc 方法)

(chunk.Chunk 方法)

(io.IOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

(sunau.AU_read 方法)

(sunau.AU_write 方法)

(wave.Wave_read 方法)

(wave.Wave_write 方法)

Telnet (telnetlib 中的类)

telnetlib

模块

TEMP, [1]

temp_cwd() (在 test.support.os_helper 模块中)

temp_dir() (在 test.support.os_helper 模块中)

temp_umask() (在 test.support.os_helper 模块中)

tempdir() (在 tempfile 模块中)

tempfile

模块

Template (pipes 中的类)

(string 中的类)

template (string.Template 属性)

temporary

file

file name

temporary (bdb.Breakpoint 属性)

TemporaryDirectory (tempfile 中的类)

TemporaryFile() (在 tempfile 模块中)

teredo (ipaddress.IPv6Address 属性)

TERM, [1]

termattrs() (在 curses 模块中)

terminal_size (os 中的类)

terminate() (asyncio.subprocess.Process 方法)

(asyncio.SubprocessTransport 方法)

(multiprocessing.pool.Pool 方法)

(multiprocessing.Process 方法)

(subprocess.Popen 方法)

termination model

terminator (logging.StreamHandler 属性)

termios

模块

termname() (在 curses 模块中)

ternary

operator

ternaryfunc (C type)

test

identity

membership

模块

test (doctest.DocTestFailure 属性)

(doctest.UnexpectedException 属性)

test() (在 cgi 模块中)

test.support

模块

test.support.bytecode_helper

模块

test.support.import_helper

模块

test.support.os_helper

模块

test.support.script_helper

模块

test.support.socket_helper

模块

test.support.threading_helper

模块

test.support.warnings_helper

模块

TEST_DATA_DIR() (在 test.support 模块中)

TEST_HOME_DIR() (在 test.support 模块中)

TEST_HTTP_URL() (在 test.support 模块中)

TEST_SUPPORT_DIR() (在 test.support 模块中)

TestCase (unittest 中的类)

TestFailed

testfile() (在 doctest 模块中)

TESTFN() (在 test.support.os_helper 模块中)

TESTFN_NONASCII() (在 test.support.os_helper 模块中)

TESTFN_UNDECODABLE() (在 test.support.os_helper 模块中)

TESTFN_UNENCODABLE() (在 test.support.os_helper 模块中)

TESTFN_UNICODE() (在 test.support.os_helper 模块中)

TestLoader (unittest 中的类)

testMethodPrefix (unittest.TestLoader 属性)

testmod() (在 doctest 模块中)

testNamePatterns (unittest.TestLoader 属性)

TestResult (unittest 中的类)

tests() (在 imghdr 模块中)

testsource() (在 doctest 模块中)

testsRun (unittest.TestResult 属性)

TestSuite (unittest 中的类)

testzip() (zipfile.ZipFile 方法)

text (SyntaxError 属性)

(traceback.TracebackException 属性)

Text (typing 中的类)

text (xml.etree.ElementTree.Element 属性)

text encoding -- 文本编码格式

text file -- 文本文件

text mode

text() (msilib.Dialog 方法)

(在 cgitb 模块中)

(在 msilib 模块中)

text_encoding() (在 io 模块中)

text_factory (sqlite3.Connection 属性)

Textbox (curses.textpad 中的类)

TextCalendar (calendar 中的类)

textdomain() (在 gettext 模块中)

(在 locale 模块中)

TextFile (distutils.text_file 中的类)

textinput() (在 turtle 模块中)

TextIO (typing 中的类)

TextIOBase (io 中的类)

TextIOWrapper (io 中的类)

TextTestResult (unittest 中的类)

TextTestRunner (unittest 中的类)

textwrap

模块

TextWrapper (textwrap 中的类)

theme_create() (tkinter.ttk.Style 方法)

theme_names() (tkinter.ttk.Style 方法)

theme_settings() (tkinter.ttk.Style 方法)

theme_use() (tkinter.ttk.Style 方法)

THOUSEP() (在 locale 模块中)

Thread (threading 中的类)

thread() (imaplib.IMAP4 方法)

thread_info() (在 sys 模块中)

thread_time() (在 time 模块中)

thread_time_ns() (在 time 模块中)

ThreadedChildWatcher (asyncio 中的类)

threading

模块

threading_cleanup() (在 test.support.threading_helper 模块中)

threading_setup() (在 test.support.threading_helper 模块中)

ThreadingHTTPServer (http.server 中的类)

ThreadingMixIn (socketserver 中的类)

ThreadingTCPServer (socketserver 中的类)

ThreadingUDPServer (socketserver 中的类)

ThreadPool (multiprocessing.pool 中的类)

ThreadPoolExecutor (concurrent.futures 中的类)

threads

POSIX

threadsafety() (在 sqlite3 模块中)

throw (2to3 fixer)

throw() (coroutine 方法)

(generator 方法)

THURSDAY() (在 calendar 模块中)

ticket_lifetime_hint (ssl.SSLSession 属性)

tigetflag() (在 curses 模块中)

tigetnum() (在 curses 模块中)

tigetstr() (在 curses 模块中)

TILDE() (在 token 模块中)

tilt() (在 turtle 模块中)

tiltangle() (在 turtle 模块中)

time

模块

time (datetime 中的类)

(ssl.SSLSession 属性)

time() (asyncio.loop 方法)

(datetime.datetime 方法)

(在 time 模块中)

Time2Internaldate() (在 imaplib 模块中)

time_ns() (在 time 模块中)

timedelta (datetime 中的类)

TimedRotatingFileHandler (logging.handlers 中的类)

timegm() (在 calendar 模块中)

timeit

模块

timeit command line option

--help

--number=N

--process

--repeat=N

--setup=S

--unit=U

--verbose

-h

-n N

-p

-r N

-s S

-u

-v

timeit() (timeit.Timer 方法)

(在 timeit 模块中)

timeout

(socketserver.BaseServer 属性)

(ssl.SSLSession 属性)

(subprocess.TimeoutExpired 属性)

timeout() (curses.window 方法)

TIMEOUT_MAX() (在 _thread 模块中)

(在 threading 模块中)

TimeoutError, [1], [2], [3]

TimeoutExpired

Timer (threading 中的类)

(timeit 中的类)

TimerHandle (asyncio 中的类)

times() (在 os 模块中)

TIMESTAMP (py_compile.PycInvalidationMode 属性)

timestamp() (datetime.datetime 方法)

timetuple() (datetime.date 方法)

(datetime.datetime 方法)

timetz() (datetime.datetime 方法)

timezone (datetime 中的类)

timezone() (在 time 模块中)

title() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 turtle 模块中)

Tix

tix_addbitmapdir() (tkinter.tix.tixCommand 方法)

tix_cget() (tkinter.tix.tixCommand 方法)

tix_configure() (tkinter.tix.tixCommand 方法)

tix_filedialog() (tkinter.tix.tixCommand 方法)

tix_getbitmap() (tkinter.tix.tixCommand 方法)

tix_getimage() (tkinter.tix.tixCommand 方法)

tix_option_get() (tkinter.tix.tixCommand 方法)

tix_resetoptions() (tkinter.tix.tixCommand 方法)

tixCommand (tkinter.tix 中的类)

Tk

(tkinter 中的类)

(tkinter.tix 中的类)

tk (tkinter.Tk 属性)

Tk Option Data Types

TK_LIBRARY

Tkinter

tkinter

模块

tkinter.colorchooser

模块

tkinter.commondialog

模块

tkinter.dnd

模块

tkinter.filedialog

模块

tkinter.font

模块

tkinter.messagebox

模块

tkinter.scrolledtext

模块

tkinter.simpledialog

模块

tkinter.tix

模块

tkinter.ttk

模块

TList (tkinter.tix 中的类)

TLS

TLSv1 (ssl.TLSVersion 属性)

TLSv1_1 (ssl.TLSVersion 属性)

TLSv1_2 (ssl.TLSVersion 属性)

TLSv1_3 (ssl.TLSVersion 属性)

TLSVersion (ssl 中的类)

TMP

TMPDIR

to_bytes() (int 方法)

to_eng_string() (decimal.Context 方法)

(decimal.Decimal 方法)

to_integral() (decimal.Decimal 方法)

to_integral_exact() (decimal.Context 方法)

(decimal.Decimal 方法)

to_integral_value() (decimal.Decimal 方法)

to_sci_string() (decimal.Context 方法)

to_thread() (在 asyncio 模块中)

ToASCII() (在 encodings.idna 模块中)

tobuf() (tarfile.TarInfo 方法)

tobytes() (array.array 方法)

(memoryview 方法)

today() (datetime.date 类方法)

(datetime.datetime 类方法)

tofile() (array.array 方法)

tok_name() (在 token 模块中)

token

模块

Token (contextvars 中的类)

token (shlex.shlex 属性)

token_bytes() (在 secrets 模块中)

token_hex() (在 secrets 模块中)

token_urlsafe() (在 secrets 模块中)

TokenError

tokenize

模块

tokenize command line option

--exact

--help

-e

-h

tokenize() (在 tokenize 模块中)

tolist() (array.array 方法)

(memoryview 方法)

tomono() (在 audioop 模块中)

toordinal() (datetime.date 方法)

(datetime.datetime 方法)

top() (curses.panel.Panel 方法)

(poplib.POP3 方法)

top_panel() (在 curses.panel 模块中)

TopologicalSorter (graphlib 中的类)

toprettyxml() (xml.dom.minidom.Node 方法)

toreadonly() (memoryview 方法)

tostereo() (在 audioop 模块中)

tostring() (在 xml.etree.ElementTree 模块中)

tostringlist() (在 xml.etree.ElementTree 模块中)

total() (collections.Counter 方法)

total_changes (sqlite3.Connection 属性)

total_nframe (tracemalloc.Traceback 属性)

total_ordering() (在 functools 模块中)

total_seconds() (datetime.timedelta 方法)

touch() (pathlib.Path 方法)

touchline() (curses.window 方法)

touchwin() (curses.window 方法)

tounicode() (array.array 方法)

ToUnicode() (在 encodings.idna 模块中)

towards() (在 turtle 模块中)

toxml() (xml.dom.minidom.Node 方法)

tparm() (在 curses 模块中)

trace

stack

模块

Trace (trace 中的类)

(tracemalloc 中的类)

trace command line option

--count

--coverdir=<dir>

--file=<file>

--help

--ignore-dir=<dir>

--ignore-module=<mod>

--listfuncs

--missing

--no-report

--report

--summary

--timing

--trace

--trackcalls

--version

-c

-C

-f

-g

-l

-m

-r

-R

-s

-t

-T

trace function, [1], [2], [3]

trace() (在 inspect 模块中)

trace_dispatch() (bdb.Bdb 方法)

traceback

对象, [1], [2], [3], [4]

模块

Traceback (tracemalloc 中的类)

traceback (tracemalloc.Statistic 属性)

(tracemalloc.StatisticDiff 属性)

(tracemalloc.Trace 属性)

traceback_limit (tracemalloc.Snapshot 属性)

(wsgiref.handlers.BaseHandler 属性)

TracebackException (traceback 中的类)

tracebacklimit() (在 sys 模块中)

tracebacks

in CGI scripts

TracebackType (types 中的类)

tracemalloc

模块

tracer() (在 turtle 模块中)

traces (tracemalloc.Snapshot 属性)

trailing

comma

transfercmd() (ftplib.FTP 方法)

transient_internet() (在 test.support.socket_helper 模块中)

translate() (bytearray 方法)

(bytes 方法)

(str 方法)

(在 fnmatch 模块中)

translation() (在 gettext 模块中)

Transport (asyncio 中的类)

transport (asyncio.StreamWriter 属性)

Transport Layer Security

Traversable (importlib.abc 中的类)

TraversableResources (importlib.abc 中的类)

traverseproc (C type)

Tree (tkinter.tix 中的类)

TreeBuilder (xml.etree.ElementTree 中的类)

Treeview (tkinter.ttk 中的类)

triangular() (在 random 模块中)

triple-quoted string

triple-quoted string -- 三引号字符串

True, [1], [2]

true

True (內置变量)

truediv() (在 operator 模块中)

trunc() (in module math)

(在 math 模块中)

truncate() (io.IOBase 方法)

(在 os 模块中)

truth

value

truth() (在 operator 模块中)

try

语句, [1], [2]

Try (ast 中的类)

ttk

tty

I/O control

模块

ttyname() (在 os 模块中)

TUESDAY() (在 calendar 模块中)

tuple

empty, [1]

singleton

內置函数, [1]

对象, [1], [2], [3], [4], [5], [6]

Tuple (ast 中的类)

tuple (內置类)

Tuple() (在 typing 模块中)

tuple_params (2to3 fixer)

turtle

模块

Turtle (turtle 中的类)

turtledemo

模块

turtles() (在 turtle 模块中)

TurtleScreen (turtle 中的类)

turtlesize() (在 turtle 模块中)

type, [1]

Boolean

data

hierarchy

immutable data

operations on dictionary

operations on list

union

內置函数, [1], [2], [3]

对象, [1], [2]

type (optparse.Option 属性)

(socket.socket 属性)

(tarfile.TarInfo 属性)

Type (typing 中的类)

type (urllib.request.Request 属性)

(內置类)

type alias -- 类型别名

type hint -- 类型注解

type of an object

type_check_only() (在 typing 模块中)

TYPE_CHECKER (optparse.Option 属性)

TYPE_CHECKING() (在 typing 模块中)

type_comment (ast.arg 属性)

(ast.Assign 属性)

(ast.For 属性)

(ast.FunctionDef 属性)

(ast.With 属性)

TYPE_COMMENT() (在 token 模块中)

TYPE_IGNORE() (在 token 模块中)

typeahead() (在 curses 模块中)

TypeAlias() (在 typing 模块中)

typecode (array.array 属性)

typecodes() (在 array 模块中)

TYPED_ACTIONS (optparse.Option 属性)

typed_subpart_iterator() (在 email.iterators 模块中)

TypedDict (typing 中的类)

TypeError

例外

TypeGuard() (在 typing 模块中)

types

built-in

immutable sequence

mutable sequence

operations on integer

operations on mapping

operations on numeric

operations on sequence, [1]

模块, [1]

types (2to3 fixer)

TYPES (optparse.Option 属性)

types, internal

types_map (mimetypes.MimeTypes 属性)

types_map() (在 mimetypes 模块中)

types_map_inv (mimetypes.MimeTypes 属性)

TypeVar (typing 中的类)

typing

模块

TZ, [1], [2], [3], [4], [5]

tzinfo (datetime 中的类)

(datetime.datetime 属性)

(datetime.time 属性)

tzname() (datetime.datetime 方法)

(datetime.time 方法)

(datetime.timezone 方法)

(datetime.tzinfo 方法)

(在 time 模块中)

TZPATH() (在 zoneinfo 模块中)

tzset() (在 time 模块中)

U

u"

string literal

u'

string literal

u-LAW, [1], [2]

UAdd (ast 中的类)

ucd_3_2_0() (在 unicodedata 模块中)

udata (select.kevent 属性)

UDPServer (socketserver 中的类)

UF_APPEND() (在 stat 模块中)

UF_COMPRESSED() (在 stat 模块中)

UF_HIDDEN() (在 stat 模块中)

UF_IMMUTABLE() (在 stat 模块中)

UF_NODUMP() (在 stat 模块中)

UF_NOUNLINK() (在 stat 模块中)

UF_OPAQUE() (在 stat 模块中)

UID (plistlib 中的类)

uid (tarfile.TarInfo 属性)

uid() (imaplib.IMAP4 方法)

uidl() (poplib.POP3 方法)

ulaw2lin() (在 audioop 模块中)

ULONG_MAX

ulp() (在 math 模块中)

umask() (在 os 模块中)

unalias (pdb command)

uname (tarfile.TarInfo 属性)

uname() (在 os 模块中)

(在 platform 模块中)

unary

arithmetic operation

bitwise operation

UNARY_INVERT (opcode)

UNARY_NEGATIVE (opcode)

UNARY_NOT (opcode)

UNARY_POSITIVE (opcode)

unaryfunc (C type)

UnaryOp (ast 中的类)

unbinding

name

UnboundLocalError, [1]

unbuffered I/O

UNC paths

and os.makedirs()

UNCHECKED_HASH (py_compile.PycInvalidationMode 属性)

unconsumed_tail (zlib.Decompress 属性)

unctrl() (在 curses 模块中)

(在 curses.ascii 模块中)

undefine_macro() (distutils.ccompiler.CCompiler 方法)

Underflow (decimal 中的类)

undisplay (pdb command)

undo() (在 turtle 模块中)

undobufferentries() (在 turtle 模块中)

undoc_header (cmd.Cmd 属性)

unescape() (在 html 模块中)

(在 xml.sax.saxutils 模块中)

UnexpectedException

unexpectedSuccesses (unittest.TestResult 属性)

unfreeze() (在 gc 模块中)

unget_wch() (在 curses 模块中)

ungetch() (在 curses 模块中)

(在 msvcrt 模块中)

ungetmouse() (在 curses 模块中)

ungetwch() (在 msvcrt 模块中)

unhexlify() (在 binascii 模块中)

Unicode, [1], [2]

database

unicode (2to3 fixer)

Unicode Consortium

unicodedata

模块

UnicodeDecodeError

UnicodeEncodeError

UnicodeError

UnicodeTranslateError

UnicodeWarning

unidata_version() (在 unicodedata 模块中)

unified_diff() (在 difflib 模块中)

uniform() (在 random 模块中)

UnimplementedFileMode

Union

对象

union

type

Union (ctypes 中的类)

union() (frozenset 方法)

Union() (在 typing 模块中)

UnionType (types 中的类)

unique() (在 enum 模块中)

unittest

模块

unittest command line option

--buffer

--catch

--failfast

--locals

-b

-c

-f

-k

unittest-discover command line option

--pattern pattern

--start-directory directory

--top-level-directory directory

--verbose

-p

-s

-t

-v

unittest.mock

模块

universal newlines

bytearray.splitlines method

bytes.splitlines method

csv.reader function

importlib.abc.InspectLoader.get_source method

io.IncrementalNewlineDecoder class

io.TextIOWrapper class

open() built-in function

str.splitlines method

subprocess module

What's new, [1], [2], [3]

universal newlines -- 通用换行

UNIX

file control

I/O control

unix_dialect (csv 中的类)

unix_shell() (在 test.support 模块中)

UnixDatagramServer (socketserver 中的类)

UnixStreamServer (socketserver 中的类)

unknown (uuid.SafeUUID 属性)

unknown_decl() (html.parser.HTMLParser 方法)

unknown_open() (urllib.request.BaseHandler 方法)

(urllib.request.UnknownHandler 方法)

UnknownHandler (urllib.request 中的类)

UnknownProtocol

UnknownTransferEncoding

unlink() (multiprocessing.shared_memory.SharedMemory 方法)

(pathlib.Path 方法)

(xml.dom.minidom.Node 方法)

(在 os 模块中)

(在 test.support.os_helper 模块中)

unload() (在 test.support.import_helper 模块中)

unlock() (mailbox.Babyl 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(mailbox.mbox 方法)

(mailbox.MH 方法)

(mailbox.MMDF 方法)

unpack() (struct.Struct 方法)

(在 struct 模块中)

unpack_archive() (在 shutil 模块中)

unpack_array() (xdrlib.Unpacker 方法)

unpack_bytes() (xdrlib.Unpacker 方法)

unpack_double() (xdrlib.Unpacker 方法)

UNPACK_EX (opcode)

unpack_farray() (xdrlib.Unpacker 方法)

unpack_float() (xdrlib.Unpacker 方法)

unpack_fopaque() (xdrlib.Unpacker 方法)

unpack_from() (struct.Struct 方法)

(在 struct 模块中)

unpack_fstring() (xdrlib.Unpacker 方法)

unpack_list() (xdrlib.Unpacker 方法)

unpack_opaque() (xdrlib.Unpacker 方法)

UNPACK_SEQUENCE (opcode)

unpack_string() (xdrlib.Unpacker 方法)

Unpacker (xdrlib 中的类)

unpacking

dictionary

in function calls

iterable

unparse() (在 ast 模块中)

unparsedEntityDecl() (xml.sax.handler.DTDHandler 方法)

UnparsedEntityDeclHandler() (xml.parsers.expat.xmlparser 方法)

Unpickler (pickle 中的类)

UnpicklingError

unquote() (在 email.utils 模块中)

(在 urllib.parse 模块中)

unquote_plus() (在 urllib.parse 模块中)

unquote_to_bytes() (在 urllib.parse 模块中)

unraisablehook() (在 sys 模块中)

unreachable object

unreadline() (distutils.text_file.TextFile 方法)

unrecognized escape sequence

unregister() (select.devpoll 方法)

(select.epoll 方法)

(select.poll 方法)

(selectors.BaseSelector 方法)

(在 atexit 模块中)

(在 codecs 模块中)

(在 faulthandler 模块中)

unregister_archive_format() (在 shutil 模块中)

unregister_dialect() (在 csv 模块中)

unregister_unpack_format() (在 shutil 模块中)

unsafe (uuid.SafeUUID 属性)

unselect() (imaplib.IMAP4 方法)

unset() (test.support.os_helper.EnvironmentVarGuard 方法)

unsetenv() (在 os 模块中)

UnstructuredHeader (email.headerregistry 中的类)

unsubscribe() (imaplib.IMAP4 方法)

UnsupportedOperation

until (pdb command)

untokenize() (在 tokenize 模块中)

untouchwin() (curses.window 方法)

unused_data (bz2.BZ2Decompressor 属性)

(lzma.LZMADecompressor 属性)

(zlib.Decompress 属性)

unverifiable (urllib.request.Request 属性)

unwrap() (ssl.SSLSocket 方法)

(在 inspect 模块中)

(在 urllib.parse 模块中)

up (pdb command)

up() (在 turtle 模块中)

update() (collections.Counter 方法)

(dict 方法)

(frozenset 方法)

(hashlib.hash 方法)

(hmac.HMAC 方法)

(http.cookies.Morsel 方法)

(mailbox.Mailbox 方法)

(mailbox.Maildir 方法)

(trace.CoverageResults 方法)

(在 turtle 模块中)

update_abstractmethods() (在 abc 模块中)

update_authenticated() (urllib.request.HTTPPasswordMgrWithPriorAuth 方法)

update_lines_cols() (在 curses 模块中)

update_panels() (在 curses.panel 模块中)

update_visible() (mailbox.BabylMessage 方法)

update_wrapper() (在 functools 模块中)

upgrade_dependencies() (venv.EnvBuilder 方法)

upper() (bytearray 方法)

(bytes 方法)

(str 方法)

urandom() (在 os 模块中)

URL, [1], [2], [3]

parsing

relative

url (http.client.HTTPResponse 属性)

(urllib.response.addinfourl 属性)

(xmlrpc.client.ProtocolError 属性)

url2pathname() (在 urllib.request 模块中)

urlcleanup() (在 urllib.request 模块中)

urldefrag() (在 urllib.parse 模块中)

urlencode() (在 urllib.parse 模块中)

URLError

urljoin() (在 urllib.parse 模块中)

urllib

模块

urllib (2to3 fixer)

urllib.error

模块

urllib.parse

模块

urllib.request

模块, [1]

urllib.response

模块

urllib.robotparser

模块

urlopen() (在 urllib.request 模块中)

URLopener (urllib.request 中的类)

urlparse() (在 urllib.parse 模块中)

urlretrieve() (在 urllib.request 模块中)

urlsafe_b64decode() (在 base64 模块中)

urlsafe_b64encode() (在 base64 模块中)

urlsplit() (在 urllib.parse 模块中)

urlunparse() (在 urllib.parse 模块中)

urlunsplit() (在 urllib.parse 模块中)

urn (uuid.UUID 属性)

use_default_colors() (在 curses 模块中)

use_env() (在 curses 模块中)

use_rawinput (cmd.Cmd 属性)

UseForeignDTD() (xml.parsers.expat.xmlparser 方法)

USER

user

effective id

id

id, setting

user() (poplib.POP3 方法)

user-defined

function

function call

method

user-defined function

对象, [1], [2]

user-defined method

对象

USER_BASE

USER_BASE() (在 site 模块中)

user_call() (bdb.Bdb 方法)

user_exception() (bdb.Bdb 方法)

user_line() (bdb.Bdb 方法)

user_return() (bdb.Bdb 方法)

USER_SITE() (在 site 模块中)

usercustomize

模块

UserDict (collections 中的类)

UserList (collections 中的类)

USERNAME, [1], [2]

username (email.headerregistry.Address 属性)

USERPROFILE, [1], [2], [3], [4]

userptr() (curses.panel.Panel 方法)

UserString (collections 中的类)

UserWarning

USTAR_FORMAT() (在 tarfile 模块中)

USub (ast 中的类)

UTC

utc (datetime.timezone 属性)

utcfromtimestamp() (datetime.datetime 类方法)

utcnow() (datetime.datetime 类方法)

utcoffset() (datetime.datetime 方法)

(datetime.time 方法)

(datetime.timezone 方法)

(datetime.tzinfo 方法)

utctimetuple() (datetime.datetime 方法)

utf8 (email.policy.EmailPolicy 属性)

utf8() (poplib.POP3 方法)

utf8_enabled (imaplib.IMAP4 属性)

utime() (在 os 模块中)

uu

模块, [1]

uuid

模块

UUID (uuid 中的类)

uuid1

uuid1() (在 uuid 模块中)

uuid3

uuid3() (在 uuid 模块中)

uuid4

uuid4() (在 uuid 模块中)

uuid5

uuid5() (在 uuid 模块中)

UuidCreate() (在 msilib 模块中)

V

v4_int_to_packed() (在 ipaddress 模块中)

v6_int_to_packed() (在 ipaddress 模块中)

valid_signals() (在 signal 模块中)

validator() (在 wsgiref.validate 模块中)

value

default parameter

truth

value (ctypes._SimpleCData 属性)

(http.cookiejar.Cookie 属性)

(http.cookies.Morsel 属性)

(xml.dom.Attr 属性)

value of an object

Value() (multiprocessing.managers.SyncManager 方法)

(在 multiprocessing 模块中)

(在 multiprocessing.sharedctypes 模块中)

value_decode() (http.cookies.BaseCookie 方法)

value_encode() (http.cookies.BaseCookie 方法)

ValueError

例外

valuerefs() (weakref.WeakValueDictionary 方法)

values

Boolean

writing

values() (contextvars.Context 方法)

(dict 方法)

(email.message.EmailMessage 方法)

(email.message.Message 方法)

(mailbox.Mailbox 方法)

(types.MappingProxyType 方法)

ValuesView (collections.abc 中的类)

(typing 中的类)

var (contextvars.Token 属性)

variable

free

variable annotation -- 变量标注

variance (statistics.NormalDist 属性)

variance() (在 statistics 模块中)

variant (uuid.UUID 属性)

vars()

內置函数

vbar (tkinter.scrolledtext.ScrolledText 属性)

VBAR() (在 token 模块中)

VBAREQUAL() (在 token 模块中)

Vec2D (turtle 中的类)

vectorcallfunc (C type)

venv

模块

VERBOSE() (在 re 模块中)

verbose() (在 tabnanny 模块中)

(在 test.support 模块中)

verify() (smtplib.SMTP 方法)

VERIFY_ALLOW_PROXY_CERTS() (在 ssl 模块中)

verify_client_post_handshake() (ssl.SSLSocket 方法)

verify_code (ssl.SSLCertVerificationError 属性)

VERIFY_CRL_CHECK_CHAIN() (在 ssl 模块中)

VERIFY_CRL_CHECK_LEAF() (在 ssl 模块中)

VERIFY_DEFAULT() (在 ssl 模块中)

verify_flags (ssl.SSLContext 属性)

verify_generated_headers (email.policy.Policy 属性)

verify_message (ssl.SSLCertVerificationError 属性)

verify_mode (ssl.SSLContext 属性)

verify_request() (socketserver.BaseServer 方法)

VERIFY_X509_PARTIAL_CHAIN() (在 ssl 模块中)

VERIFY_X509_STRICT() (在 ssl 模块中)

VERIFY_X509_TRUSTED_FIRST() (在 ssl 模块中)

VerifyFlags (ssl 中的类)

VerifyMode (ssl 中的类)

version (email.headerregistry.MIMEVersionHeader 属性)

(http.client.HTTPResponse 属性)

(http.cookiejar.Cookie 属性)

(in module sys), [1], [2]

(ipaddress.IPv4Address 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Address 属性)

(ipaddress.IPv6Network 属性)

(urllib.request.URLopener 属性)

(uuid.UUID 属性)

version() (ssl.SSLSocket 方法)

(在 curses 模块中)

(在 ensurepip 模块中)

(在 marshal 模块中)

(在 platform 模块中)

(在 sqlite3 模块中)

(在 sys 模块中)

version_info() (在 sqlite3 模块中)

(在 sys 模块中)

version_string() (http.server.BaseHTTPRequestHandler 方法)

vformat() (string.Formatter 方法)

virtual

Environments

virtual environment -- 虚拟环境

virtual machine -- 虚拟机

visit() (ast.NodeVisitor 方法)

visitproc (C type)

vline() (curses.window 方法)

voidcmd() (ftplib.FTP 方法)

volume (zipfile.ZipInfo 属性)

vonmisesvariate() (在 random 模块中)

W

W_OK() (在 os 模块中)

wait() (asyncio.Condition 方法)

(asyncio.Event 方法)

(asyncio.subprocess.Process 方法)

(multiprocessing.pool.AsyncResult 方法)

(subprocess.Popen 方法)

(threading.Barrier 方法)

(threading.Condition 方法)

(threading.Event 方法)

(在 asyncio 模块中)

(在 concurrent.futures 模块中)

(在 multiprocessing.connection 模块中)

(在 os 模块中)

wait3() (在 os 模块中)

wait4() (在 os 模块中)

wait_closed() (asyncio.Server 方法)

(asyncio.StreamWriter 方法)

wait_for() (asyncio.Condition 方法)

(threading.Condition 方法)

(在 asyncio 模块中)

wait_process() (在 test.support 模块中)

wait_threads_exit() (在 test.support.threading_helper 模块中)

waitid() (在 os 模块中)

waitpid() (在 os 模块中)

waitstatus_to_exitcode() (在 os 模块中)

walk() (email.message.EmailMessage 方法)

(email.message.Message 方法)

(在 ast 模块中)

(在 os 模块中)

walk_packages() (在 pkgutil 模块中)

walk_stack() (在 traceback 模块中)

walk_tb() (在 traceback 模块中)

walrus operator

want (doctest.Example 属性)

warn() (distutils.ccompiler.CCompiler 方法)

(distutils.text_file.TextFile 方法)

(在 warnings 模块中)

warn_explicit() (在 warnings 模块中)

Warning, [1]

warning() (logging.Logger 方法)

(xml.sax.handler.ErrorHandler 方法)

(在 logging 模块中)

warnings

模块

WarningsRecorder (test.support.warnings_helper 中的类)

warnoptions() (在 sys 模块中)

wasSuccessful() (unittest.TestResult 方法)

WatchedFileHandler (logging.handlers 中的类)

wave

模块

WCONTINUED() (在 os 模块中)

WCOREDUMP() (在 os 模块中)

WeakKeyDictionary (weakref 中的类)

WeakMethod (weakref 中的类)

weakref

模块

WeakSet (weakref 中的类)

WeakValueDictionary (weakref 中的类)

webbrowser

模块

WEDNESDAY() (在 calendar 模块中)

weekday() (datetime.date 方法)

(datetime.datetime 方法)

(在 calendar 模块中)

weekheader() (在 calendar 模块中)

weibullvariate() (在 random 模块中)

WEXITED() (在 os 模块中)

WEXITSTATUS() (在 os 模块中)

wfile (http.server.BaseHTTPRequestHandler 属性)

what() (在 imghdr 模块中)

(在 sndhdr 模块中)

whathdr() (在 sndhdr 模块中)

whatis (pdb command)

when() (asyncio.TimerHandle 方法)

where (pdb command)

which() (在 shutil 模块中)

whichdb() (在 dbm 模块中)

while

语句, [1], [2], [3]

While (ast 中的类)

whitespace (shlex.shlex 属性)

whitespace() (在 string 模块中)

whitespace_split (shlex.shlex 属性)

Widget (tkinter.ttk 中的类)

width (textwrap.TextWrapper 属性)

width() (在 turtle 模块中)

WIFCONTINUED() (在 os 模块中)

WIFEXITED() (在 os 模块中)

WIFSIGNALED() (在 os 模块中)

WIFSTOPPED() (在 os 模块中)

win32_edition() (在 platform 模块中)

win32_is_iot() (在 platform 模块中)

win32_ver() (在 platform 模块中)

WinDLL (ctypes 中的类)

window manager (widgets)

window() (curses.panel.Panel 方法)

window_height() (在 turtle 模块中)

window_width() (在 turtle 模块中)

Windows

Windows ini file

WindowsError

WindowsPath (pathlib 中的类)

WindowsProactorEventLoopPolicy (asyncio 中的类)

WindowsRegistryFinder (importlib.machinery 中的类)

WindowsSelectorEventLoopPolicy (asyncio 中的类)

winerror (OSError 属性)

WinError() (在 ctypes 模块中)

WINFUNCTYPE() (在 ctypes 模块中)

winreg

模块

WinSock

winsound

模块

winver() (在 sys 模块中)

with

语句, [1]

With (ast 中的类)

WITH_EXCEPT_START (opcode)

with_hostmask (ipaddress.IPv4Interface 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Interface 属性)

(ipaddress.IPv6Network 属性)

with_name() (pathlib.PurePath 方法)

with_netmask (ipaddress.IPv4Interface 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Interface 属性)

(ipaddress.IPv6Network 属性)

with_prefixlen (ipaddress.IPv4Interface 属性)

(ipaddress.IPv4Network 属性)

(ipaddress.IPv6Interface 属性)

(ipaddress.IPv6Network 属性)

with_pymalloc() (在 test.support 模块中)

with_stem() (pathlib.PurePath 方法)

with_suffix() (pathlib.PurePath 方法)

with_traceback() (BaseException 方法)

withitem (ast 中的类)

WNOHANG() (在 os 模块中)

WNOWAIT() (在 os 模块中)

wordchars (shlex.shlex 属性)

World Wide Web, [1], [2]

wrap() (textwrap.TextWrapper 方法)

(在 textwrap 模块中)

wrap_bio() (ssl.SSLContext 方法)

wrap_future() (在 asyncio 模块中)

wrap_socket() (ssl.SSLContext 方法)

(在 ssl 模块中)

wrap_text() (在 distutils.fancy_getopt 模块中)

wrapper() (在 curses 模块中)

WrapperDescriptorType() (在 types 模块中)

wraps() (在 functools 模块中)

writable() (asyncore.dispatcher 方法)

(io.IOBase 方法)

WRITABLE() (在 tkinter 模块中)

write() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

(code.InteractiveInterpreter 方法)

(codecs.StreamWriter 方法)

(configparser.ConfigParser 方法)

(email.generator.BytesGenerator 方法)

(email.generator.Generator 方法)

(io.BufferedIOBase 方法)

(io.BufferedWriter 方法)

(io.RawIOBase 方法)

(io.TextIOBase 方法)

(mmap.mmap 方法)

(ossaudiodev.oss_audio_device 方法)

(ssl.MemoryBIO 方法)

(ssl.SSLSocket 方法)

(telnetlib.Telnet 方法)

(xml.etree.ElementTree.ElementTree 方法)

(zipfile.ZipFile 方法)

(在 os 模块中)

(在 turtle 模块中)

write_byte() (mmap.mmap 方法)

write_bytes() (pathlib.Path 方法)

write_docstringdict() (在 turtle 模块中)

write_eof() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

(ssl.MemoryBIO 方法)

write_file() (在 distutils.file_util 模块中)

write_history_file() (在 readline 模块中)

WRITE_RESTRICTED

write_results() (trace.CoverageResults 方法)

write_text() (pathlib.Path 方法)

write_through (io.TextIOWrapper 属性)

writeall() (ossaudiodev.oss_audio_device 方法)

writeframes() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

writeframesraw() (aifc.aifc 方法)

(sunau.AU_write 方法)

(wave.Wave_write 方法)

writeheader() (csv.DictWriter 方法)

writelines() (asyncio.StreamWriter 方法)

(asyncio.WriteTransport 方法)

(codecs.StreamWriter 方法)

(io.IOBase 方法)

writepy() (zipfile.PyZipFile 方法)

writer() (在 csv 模块中)

writerow() (csv.csvwriter 方法)

writerows() (csv.csvwriter 方法)

writestr() (zipfile.ZipFile 方法)

WriteTransport (asyncio 中的类)

writev() (在 os 模块中)

writexml() (xml.dom.minidom.Node 方法)

writing

values

WrongDocumentErr

ws_comma (2to3 fixer)

wsgi_file_wrapper (wsgiref.handlers.BaseHandler 属性)

wsgi_multiprocess (wsgiref.handlers.BaseHandler 属性)

wsgi_multithread (wsgiref.handlers.BaseHandler 属性)

wsgi_run_once (wsgiref.handlers.BaseHandler 属性)

wsgiref

模块

wsgiref.handlers

模块

wsgiref.headers

模块

wsgiref.simple_server

模块

wsgiref.util

模块

wsgiref.validate

模块

WSGIRequestHandler (wsgiref.simple_server 中的类)

WSGIServer (wsgiref.simple_server 中的类)

wShowWindow (subprocess.STARTUPINFO 属性)

WSTOPPED() (在 os 模块中)

WSTOPSIG() (在 os 模块中)

wstring_at() (在 ctypes 模块中)

WTERMSIG() (在 os 模块中)

WUNTRACED() (在 os 模块中)

WWW, [1], [2]

server, [1]

X

X() (在 re 模块中)

X509 certificate

X_OK() (在 os 模块中)

xatom() (imaplib.IMAP4 方法)

XATTR_CREATE() (在 os 模块中)

XATTR_REPLACE() (在 os 模块中)

XATTR_SIZE_MAX() (在 os 模块中)

xcor() (在 turtle 模块中)

XDR

xdrlib

模块

xhdr() (nntplib.NNTP 方法)

XHTML

XHTML_NAMESPACE() (在 xml.dom 模块中)

xml

模块

XML() (在 xml.etree.ElementTree 模块中)

xml.dom

模块

xml.dom.minidom

模块

xml.dom.pulldom

模块

xml.etree.ElementInclude.default_loader()

內置函数

xml.etree.ElementInclude.include()

內置函数

xml.etree.ElementTree

模块

xml.parsers.expat

模块

xml.parsers.expat.errors

模块

xml.parsers.expat.model

模块

xml.sax

模块

xml.sax.handler

模块

xml.sax.saxutils

模块

xml.sax.xmlreader

模块

XML_ERROR_ABORTED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_ASYNC_ENTITY() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_BAD_CHAR_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_BINARY_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_DUPLICATE_ATTRIBUTE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_ENTITY_DECLARED_IN_PE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_EXTERNAL_ENTITY_HANDLING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_FEATURE_REQUIRES_XML_DTD() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_FINISHED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_INCOMPLETE_PE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_INCORRECT_ENCODING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_INVALID_TOKEN() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_JUNK_AFTER_DOC_ELEMENT() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_MISPLACED_XML_PI() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NO_ELEMENTS() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NO_MEMORY() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NOT_STANDALONE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_NOT_SUSPENDED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_PARAM_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_PARTIAL_CHAR() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_PUBLICID() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_RECURSIVE_ENTITY_REF() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_SUSPEND_PE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_SUSPENDED() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_SYNTAX() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_TAG_MISMATCH() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_TEXT_DECL() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNBOUND_PREFIX() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNCLOSED_CDATA_SECTION() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNCLOSED_TOKEN() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNDECLARING_PREFIX() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNDEFINED_ENTITY() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNEXPECTED_STATE() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_UNKNOWN_ENCODING() (在 xml.parsers.expat.errors 模块中)

XML_ERROR_XML_DECL() (在 xml.parsers.expat.errors 模块中)

XML_NAMESPACE() (在 xml.dom 模块中)

xmlcharrefreplace

error handler's name

xmlcharrefreplace_errors() (在 codecs 模块中)

XmlDeclHandler() (xml.parsers.expat.xmlparser 方法)

XMLFilterBase (xml.sax.saxutils 中的类)

XMLGenerator (xml.sax.saxutils 中的类)

XMLID() (在 xml.etree.ElementTree 模块中)

XMLNS_NAMESPACE() (在 xml.dom 模块中)

XMLParser (xml.etree.ElementTree 中的类)

XMLParserType() (在 xml.parsers.expat 模块中)

XMLPullParser (xml.etree.ElementTree 中的类)

XMLReader (xml.sax.xmlreader 中的类)

xmlrpc.client

模块

xmlrpc.server

模块

xor

bitwise

xor() (在 operator 模块中)

xover() (nntplib.NNTP 方法)

xrange (2to3 fixer)

xreadlines (2to3 fixer)

xview() (tkinter.ttk.Treeview 方法)

Y

ycor() (在 turtle 模块中)

year (datetime.date 属性)

(datetime.datetime 属性)

Year 2038

yeardatescalendar() (calendar.Calendar 方法)

yeardays2calendar() (calendar.Calendar 方法)

yeardayscalendar() (calendar.Calendar 方法)

YESEXPR() (在 locale 模块中)

yield

examples

expression

yield from (in What's New)

关键字

语句

Yield (ast 中的类)

YIELD_FROM (opcode)

YIELD_VALUE (opcode)

YieldFrom (ast 中的类)

yiq_to_rgb() (在 colorsys 模块中)

yview() (tkinter.ttk.Treeview 方法)

Z

Zen of Python -- Python 之禅

ZeroDivisionError

例外

zfill() (bytearray 方法)

(bytes 方法)

(str 方法)

zip (2to3 fixer)

zip()

內置函数

ZIP_BZIP2() (在 zipfile 模块中)

ZIP_DEFLATED() (在 zipfile 模块中)

zip_longest() (在 itertools 模块中)

ZIP_LZMA() (在 zipfile 模块中)

ZIP_STORED() (在 zipfile 模块中)

zipapp

模块

zipapp command line option

--compress

--help

--info

--main=<mainfn>

--output=<output>

--python=<interpreter>

-c

-h

-m <mainfn>

-o <output>

-p <interpreter>

zipfile

模块

ZipFile (zipfile 中的类)

zipfile command line option

--create <zipfile> <source1> ... <sourceN>

--extract <zipfile> <output_dir>

--list <zipfile>

--test <zipfile>

-c <zipfile> <source1> ... <sourceN>

-e <zipfile> <output_dir>

-l <zipfile>

-t <zipfile>

zipimport

模块

zipimporter (zipimport 中的类)

ZipImportError

ZipInfo (zipfile 中的类)

zlib

模块

ZLIB_RUNTIME_VERSION() (在 zlib 模块中)

ZLIB_VERSION() (在 zlib 模块中)

zoneinfo

模块

ZoneInfo (zoneinfo 中的类)

ZoneInfoNotFoundError

zscore() (statistics.NormalDist 方法)

例

例外

AssertionError

AttributeError

GeneratorExit, [1]

ImportError

NameError

StopAsyncIteration

StopIteration, [1]

TypeError

ValueError

ZeroDivisionError

內

內置函数

__import__

__import__()

abs, [1]

abs()

aiter()

all()

anext()

any()

ascii

ascii()

bin()

breakpoint()

bytes, [1]

callable()

chr

chr()

classmethod

classmethod()

compile, [1], [2], [3]

compile()

complex, [1]

create_shortcut()

delattr()

dir()

directory_created()

divmod, [1], [2]

divmod()

enumerate()

eval, [1], [2], [3], [4]

eval()

exec, [1], [2]

exec()

file_created()

filter()

float, [1], [2]

format()

get_special_folder_path()

getattr()

globals()

hasattr()

hash, [1], [2], [3]

hash()

help

help()

hex()

id

id()

input()

int, [1], [2]

isinstance()

issubclass()

iter()

len, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

len()

locals()

map()

max

max()

min

min()

multiprocessing.Manager()

next()

oct()

open, [1]

open()

ord

ord()

pow, [1], [2], [3], [4], [5]

pow()

print

print()

range

repr, [1], [2], [3]

repr()

reversed()

round

round()

setattr()

slice, [1]

sorted()

staticmethod

staticmethod()

sum()

tuple, [1]

type, [1], [2], [3]

vars()

xml.etree.ElementInclude.default_loader()

xml.etree.ElementInclude.include()

zip()

关

关键字

as, [1], [2], [3]

async

await, [1]

case

elif

else, [1], [2], [3], [4], [5]

except

finally, [1], [2], [3], [4]

from, [1]

if

in

yield

包

包

对

对象

asynchronous-generator

Boolean, [1]

built-in function, [1]

built-in method, [1]

bytearray, [1], [2], [3]

bytes, [1], [2]

callable, [1]

Capsule

class, [1], [2]

class instance, [1], [2]

complex

complex number, [1]

dictionary, [1], [2], [3], [4], [5], [6], [7]

Ellipsis

file, [1]

floating point, [1], [2]

frame

frozenset, [1]

function, [1], [2], [3], [4], [5]

generator, [1], [2]

GenericAlias

immutable

immutable sequence

instance, [1], [2]

instancemethod

integer, [1], [2]

io.StringIO

list, [1], [2], [3], [4], [5], [6], [7], [8]

long integer

mapping, [1], [2], [3], [4], [5]

memoryview, [1]

method, [1], [2], [3], [4], [5]

module, [1], [2]

mutable, [1], [2]

mutable sequence

None, [1], [2]

NotImplemented

numeric, [1], [2], [3]

range

sequence, [1], [2], [3], [4], [5], [6], [7], [8]

set, [1], [2], [3]

set type

slice

socket

string, [1], [2]

traceback, [1], [2], [3], [4]

tuple, [1], [2], [3], [4], [5], [6]

type, [1], [2]

Union

user-defined function, [1], [2]

user-defined method

模

模块

__future__

__main__, [1], [2], [3], [4], [5], [6], [7], [8]

_locale

_thread, [1]

abc

aifc

argparse

array, [1], [2]

ast

asynchat

asyncio

asyncore

atexit

audioop

base64, [1]

bdb, [1]

binascii

binhex, [1]

bisect

builtins, [1], [2], [3], [4], [5]

bz2

calendar

cgi

cgitb

chunk

cmath

cmd, [1]

code

codecs

codeop

collections

collections.abc

colorsys

compileall

concurrent.futures

configparser

contextlib

contextvars

copy, [1]

copyreg

cProfile

crypt, [1]

csv

ctypes

curses

curses.ascii

curses.panel

curses.textpad

dataclasses

datetime

dbm

dbm.dumb

dbm.gnu, [1], [2]

dbm.ndbm, [1], [2]

decimal

difflib

dis

distutils

distutils.archive_util

distutils.bcppcompiler

distutils.ccompiler

distutils.cmd

distutils.command

distutils.command.bdist

distutils.command.bdist_dumb

distutils.command.bdist_msi

distutils.command.bdist_packager

distutils.command.bdist_rpm

distutils.command.build

distutils.command.build_clib

distutils.command.build_ext

distutils.command.build_py

distutils.command.build_scripts

distutils.command.check

distutils.command.clean

distutils.command.config

distutils.command.install

distutils.command.install_data

distutils.command.install_headers

distutils.command.install_lib

distutils.command.install_scripts

distutils.command.register

distutils.command.sdist

distutils.core

distutils.cygwinccompiler

distutils.debug

distutils.dep_util

distutils.dir_util

distutils.dist

distutils.errors

distutils.extension

distutils.fancy_getopt

distutils.file_util

distutils.filelist

distutils.log

distutils.msvccompiler

distutils.spawn

distutils.sysconfig

distutils.text_file

distutils.unixccompiler

distutils.util

distutils.version

doctest

email

email.charset

email.contentmanager

email.encoders

email.errors

email.generator

email.header

email.headerregistry

email.iterators

email.message

email.mime

email.parser

email.policy

email.utils

encodings.idna

encodings.mbcs

encodings.utf_8_sig

ensurepip

enum

errno, [1]

faulthandler

fcntl

filecmp

fileinput

fnmatch

fractions

ftplib

functools

gc

getopt

getpass

gettext

glob, [1]

graphlib

grp

gzip

hashlib

heapq

hmac

html

html.entities

html.parser

http

http.client

http.cookiejar

http.cookies

http.server

idlelib

imaplib

imghdr

imp, [1]

importlib

importlib.abc

importlib.machinery

importlib.metadata

importlib.resources

importlib.util

inspect

io, [1]

ipaddress

itertools

json, [1]

json.tool

keyword

lib2to3

linecache

locale

logging

logging.config

logging.handlers

lzma

mailbox

mailcap

marshal

math, [1], [2]

mimetypes

mmap

modulefinder

msilib

msvcrt

multiprocessing

multiprocessing.connection

multiprocessing.dummy

multiprocessing.managers

multiprocessing.pool

multiprocessing.shared_memory

multiprocessing.sharedctypes

netrc

nis

nntplib

numbers

operator

optparse

os, [1]

os.path

ossaudiodev

pathlib

pdb

pickle, [1], [2], [3], [4]

pickletools

pipes

pkgutil

platform

plistlib

poplib

posix

pprint

profile

pstats

pty, [1]

pwd, [1]

py_compile

pyclbr

pydoc

pyexpat

queue

quopri

random

re, [1], [2]

readline

reprlib

resource

rlcompleter

runpy

sched

secrets

select

selectors

shelve, [1]

shlex

shutil

signal, [1], [2], [3], [4]

site

sitecustomize

smtpd

smtplib

sndhdr

socket, [1]

socketserver

spwd

sqlite3

ssl

stat, [1]

statistics

string, [1]

stringprep

struct, [1]

subprocess

sunau

symtable

sys, [1], [2], [3], [4], [5], [6], [7]

sysconfig

syslog

tabnanny

tarfile

telnetlib

tempfile

termios

test

test.support

test.support.bytecode_helper

test.support.import_helper

test.support.os_helper

test.support.script_helper

test.support.socket_helper

test.support.threading_helper

test.support.warnings_helper

textwrap

threading

time

timeit

tkinter

tkinter.colorchooser

tkinter.commondialog

tkinter.dnd

tkinter.filedialog

tkinter.font

tkinter.messagebox

tkinter.scrolledtext

tkinter.simpledialog

tkinter.tix

tkinter.ttk

token

tokenize

trace

traceback

tracemalloc

tty

turtle

turtledemo

types, [1]

typing

unicodedata

unittest

unittest.mock

urllib

urllib.error

urllib.parse

urllib.request, [1]

urllib.response

urllib.robotparser

usercustomize

uu, [1]

uuid

venv

warnings

wave

weakref

webbrowser

winreg

winsound

wsgiref

wsgiref.handlers

wsgiref.headers

wsgiref.simple_server

wsgiref.util

wsgiref.validate

xdrlib

xml

xml.dom

xml.dom.minidom

xml.dom.pulldom

xml.etree.ElementTree

xml.parsers.expat

xml.parsers.expat.errors

xml.parsers.expat.model

xml.sax

xml.sax.handler

xml.sax.saxutils

xml.sax.xmlreader

xmlrpc.client

xmlrpc.server

zipapp

zipfile

zipimport

zlib

zoneinfo

环

环境变量

%APPDATA%

__PYVENV_LAUNCHER__, [1]

APPDATA

AUDIODEV

BASECFLAGS

BASECPPFLAGS

BLDSHARED

BROWSER, [1]

CC, [1]

CCSHARED

CFLAGS, [1], [2], [3], [4], [5], [6], [7], [8]

CFLAGS_ALIASING

CFLAGS_NODIST, [1], [2], [3]

CFLAGSFORSHARED

COLS, [1]

COLUMNS, [1]

COMSPEC, [1]

CONFIGURE_CFLAGS

CONFIGURE_CFLAGS_NODIST

CONFIGURE_CPPFLAGS

CONFIGURE_LDFLAGS

CONFIGURE_LDFLAGS_NODIST

CPP

CPPFLAGS, [1], [2], [3], [4]

CXX

DISPLAY

DISTUTILS_DEBUG

EnableControlFlowGuard

EXTRA_CFLAGS

HOME, [1], [2], [3], [4], [5], [6], [7], [8], [9]

HOMEDRIVE, [1]

HOMEPATH, [1]

http_proxy, [1], [2]

IDLESTARTUP

KDEDIR

LANG, [1], [2], [3], [4]

LANGUAGE, [1]

LC_ALL, [1]

LC_MESSAGES, [1]

LDCXXSHARED

LDFLAGS, [1], [2], [3], [4], [5], [6], [7], [8]

LDFLAGS_NODIST, [1], [2]

LDSHARED

LIBS

LINES, [1], [2], [3], [4]

LINKCC

LNAME

LOGNAME, [1]

MAINCC

MIXERDEV

no_proxy

OPT, [1]

PAGER

PATH, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40]

PATHEXT, [1], [2]

PIP_USER

PLAT

POSIXLY_CORRECT

PROFILE_TASK, [1]

PURIFY

PY_BUILTIN_MODULE_CFLAGS

PY_CFLAGS

PY_CFLAGS_NODIST

PY_CORE_CFLAGS

PY_CORE_LDFLAGS

PY_CPPFLAGS

PY_LDFLAGS

PY_LDFLAGS_NODIST

PY_PYTHON

PY_STDMODULE_CFLAGS

PYTHON*, [1], [2], [3], [4], [5], [6]

PYTHON_DOM

PYTHONASYNCIODEBUG, [1], [2], [3]

PYTHONBREAKPOINT, [1], [2], [3], [4]

PYTHONCASEOK, [1], [2], [3], [4]

PYTHONCOERCECLOCALE, [1], [2], [3], [4]

PYTHONDEBUG, [1], [2], [3]

PYTHONDEVMODE, [1], [2]

PYTHONDOCS

PYTHONDONTWRITEBYTECODE, [1], [2], [3], [4], [5], [6], [7]

PYTHONDUMPREFS, [1], [2], [3], [4], [5]

PYTHONEXECUTABLE, [1]

PYTHONFAULTHANDLER, [1], [2], [3], [4]

PYTHONHASHSEED, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PYTHONHOME, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17]

PYTHONINSPECT, [1], [2], [3], [4]

PYTHONINTMAXSTRDIGITS, [1], [2], [3], [4], [5]

PYTHONIOENCODING, [1], [2], [3], [4], [5], [6], [7], [8]

PYTHONLEGACYWINDOWSFSENCODING, [1], [2], [3], [4]

PYTHONLEGACYWINDOWSSTDIO, [1], [2], [3], [4], [5]

PYTHONMALLOC, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PYTHONMALLOC`（例如：``PYTHONMALLOC=malloc`

PYTHONMALLOCSTATS, [1], [2], [3]

PYTHONNOUSERSITE, [1], [2], [3], [4]

PYTHONOPTIMIZE, [1], [2], [3]

PYTHONPATH, [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]

PYTHONPLATLIBDIR, [1], [2]

PYTHONPROFILEIMPORTTIME, [1], [2], [3], [4]

PYTHONPYCACHEPREFIX, [1], [2], [3], [4], [5]

PYTHONREGRTEST_UNICODE_GUARD

PYTHONSHOWALLOCCOUNT

PYTHONSHOWREFCOUNT

PYTHONSTARTUP, [1], [2], [3], [4], [5], [6], [7], [8]

PYTHONTHREADDEBUG, [1], [2], [3]

PYTHONTRACEMALLOC, [1], [2], [3], [4]

PYTHONTZPATH, [1]

PYTHONUNBUFFERED, [1], [2], [3], [4], [5]

PYTHONUSERBASE, [1], [2], [3]

PYTHONUSERSITE

PYTHONUTF8, [1], [2], [3], [4], [5], [6], [7], [8]

PYTHONVERBOSE, [1], [2], [3]

PYTHONWARNDEFAULTENCODING, [1], [2], [3], [4]

PYTHONWARNINGS, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13]

SOURCE_DATE_EPOCH, [1], [2], [3], [4], [5], [6]

SSLKEYLOGFILE, [1]

SystemRoot

TCL_LIBRARY

TEMP, [1]

TERM, [1]

TK_LIBRARY

TMP

TMPDIR

TZ, [1], [2], [3], [4], [5]

USER

USER_BASE

USERNAME, [1], [2]

USERPROFILE, [1], [2], [3], [4]

语

语句

assert, [1]

async def

async for

async with

break, [1], [2], [3], [4]

class

continue, [1], [2], [3], [4]

def

del, [1], [2], [3]

except

for, [1], [2], [3]

global, [1]

if, [1]

import, [1], [2], [3], [4]

match

nonlocal

pass

raise, [1]

return, [1], [2]

try, [1], [2]

while, [1], [2], [3]

with, [1]

yield

运

运算符

!=, [1]

% (percent), [1]

& (ampersand), [1]

* (asterisk), [1]

, [1]

/ (slash), [1]

//, [1]

< (less), [1]

<<, [1]

<=, [1]

==, [1]

> (greater), [1]

>=, [1]

>>, [1]

@ (at)

^ (caret), [1]

| (vertical bar), [1]

~ (tilde), [1]

and, [1], [2]

in, [1], [2]

is, [1]

is not, [1]

not, [1]

not in, [1], [2]

or, [1], [2]

索引 – 例

例外

AssertionError

AttributeError

GeneratorExit, [1]

ImportError

NameError

StopAsyncIteration

StopIteration, [1]

TypeError

ValueError

ZeroDivisionError

索引 – 內

內置函数

__import__

__import__()

abs, [1]

abs()

aiter()

all()

anext()

any()

ascii

ascii()

bin()

breakpoint()

bytes, [1]

callable()

chr

chr()

classmethod

classmethod()

compile, [1], [2], [3]

compile()

complex, [1]

create_shortcut()

delattr()

dir()

directory_created()

divmod, [1], [2]

divmod()

enumerate()

eval, [1], [2], [3], [4]

eval()

exec, [1], [2]

exec()

file_created()

filter()

float, [1], [2]

format()

get_special_folder_path()

getattr()

globals()

hasattr()

hash, [1], [2], [3]

hash()

help

help()

hex()

id

id()

input()

int, [1], [2]

isinstance()

issubclass()

iter()

len, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11]

len()

locals()

map()

max

max()

min

min()

multiprocessing.Manager()

next()

oct()

open, [1]

open()

ord

ord()

pow, [1], [2], [3], [4], [5]

pow()

print

print()

range

repr, [1], [2], [3]

repr()

reversed()

round

round()

setattr()

slice, [1]

sorted()

staticmethod

staticmethod()

sum()

tuple, [1]

type, [1], [2], [3]

vars()

xml.etree.ElementInclude.default_loader()

xml.etree.ElementInclude.include()

zip()

索引 – 关

关键字

as, [1], [2], [3]

async

await, [1]

case

elif

else, [1], [2], [3], [4], [5]

except

finally, [1], [2], [3], [4]

from, [1]

if

in

yield

索引 – 包

包

索引 – 对

对象

asynchronous-generator

Boolean, [1]

built-in function, [1]

built-in method, [1]

bytearray, [1], [2], [3]

bytes, [1], [2]

callable, [1]

Capsule

class, [1], [2]

class instance, [1], [2]

complex

complex number, [1]

dictionary, [1], [2], [3], [4], [5], [6], [7]

Ellipsis

file, [1]

floating point, [1], [2]

frame

frozenset, [1]

function, [1], [2], [3], [4], [5]

generator, [1], [2]

GenericAlias

immutable

immutable sequence

instance, [1], [2]

instancemethod

integer, [1], [2]

io.StringIO

list, [1], [2], [3], [4], [5], [6], [7], [8]

long integer

mapping, [1], [2], [3], [4], [5]

memoryview, [1]

method, [1], [2], [3], [4], [5]

module, [1], [2]

mutable, [1], [2]

mutable sequence

None, [1], [2]

NotImplemented

numeric, [1], [2], [3]

range

sequence, [1], [2], [3], [4], [5], [6], [7], [8]

set, [1], [2], [3]

set type

slice

socket

string, [1], [2]

traceback, [1], [2], [3], [4]

tuple, [1], [2], [3], [4], [5], [6]

type, [1], [2]

Union

user-defined function, [1], [2]

user-defined method

索引 – 模

模块

__future__

__main__, [1], [2], [3], [4], [5], [6], [7], [8]

_locale

_thread, [1]

abc

aifc

argparse

array, [1], [2]

ast

asynchat

asyncio

asyncore

atexit

audioop

base64, [1]

bdb, [1]

binascii

binhex, [1]

bisect

builtins, [1], [2], [3], [4], [5]

bz2

calendar

cgi

cgitb

chunk

cmath

cmd, [1]

code

codecs

codeop

collections

collections.abc

colorsys

compileall

concurrent.futures

configparser

contextlib

contextvars

copy, [1]

copyreg

cProfile

crypt, [1]

csv

ctypes

curses

curses.ascii

curses.panel

curses.textpad

dataclasses

datetime

dbm

dbm.dumb

dbm.gnu, [1], [2]

dbm.ndbm, [1], [2]

decimal

difflib

dis

distutils

distutils.archive_util

distutils.bcppcompiler

distutils.ccompiler

distutils.cmd

distutils.command

distutils.command.bdist

distutils.command.bdist_dumb

distutils.command.bdist_msi

distutils.command.bdist_packager

distutils.command.bdist_rpm

distutils.command.build

distutils.command.build_clib

distutils.command.build_ext

distutils.command.build_py

distutils.command.build_scripts

distutils.command.check

distutils.command.clean

distutils.command.config

distutils.command.install

distutils.command.install_data

distutils.command.install_headers

distutils.command.install_lib

distutils.command.install_scripts

distutils.command.register

distutils.command.sdist

distutils.core

distutils.cygwinccompiler

distutils.debug

distutils.dep_util

distutils.dir_util

distutils.dist

distutils.errors

distutils.extension

distutils.fancy_getopt

distutils.file_util

distutils.filelist

distutils.log

distutils.msvccompiler

distutils.spawn

distutils.sysconfig

distutils.text_file

distutils.unixccompiler

distutils.util

distutils.version

doctest

email

email.charset

email.contentmanager

email.encoders

email.errors

email.generator

email.header

email.headerregistry

email.iterators

email.message

email.mime

email.parser

email.policy

email.utils

encodings.idna

encodings.mbcs

encodings.utf_8_sig

ensurepip

enum

errno, [1]

faulthandler

fcntl

filecmp

fileinput

fnmatch

fractions

ftplib

functools

gc

getopt

getpass

gettext

glob, [1]

graphlib

grp

gzip

hashlib

heapq

hmac

html

html.entities

html.parser

http

http.client

http.cookiejar

http.cookies

http.server

idlelib

imaplib

imghdr

imp, [1]

importlib

importlib.abc

importlib.machinery

importlib.metadata

importlib.resources

importlib.util

inspect

io, [1]

ipaddress

itertools

json, [1]

json.tool

keyword

lib2to3

linecache

locale

logging

logging.config

logging.handlers

lzma

mailbox

mailcap

marshal

math, [1], [2]

mimetypes

mmap

modulefinder

msilib

msvcrt

multiprocessing

multiprocessing.connection

multiprocessing.dummy

multiprocessing.managers

multiprocessing.pool

multiprocessing.shared_memory

multiprocessing.sharedctypes

netrc

nis

nntplib

numbers

operator

optparse

os, [1]

os.path

ossaudiodev

pathlib

pdb

pickle, [1], [2], [3], [4]

pickletools

pipes

pkgutil

platform

plistlib

poplib

posix

pprint

profile

pstats

pty, [1]

pwd, [1]

py_compile

pyclbr

pydoc

pyexpat

queue

quopri

random

re, [1], [2]

readline

reprlib

resource

rlcompleter

runpy

sched

secrets

select

selectors

shelve, [1]

shlex

shutil

signal, [1], [2], [3], [4]

site

sitecustomize

smtpd

smtplib

sndhdr

socket, [1]

socketserver

spwd

sqlite3

ssl

stat, [1]

statistics

string, [1]

stringprep

struct, [1]

subprocess

sunau

symtable

sys, [1], [2], [3], [4], [5], [6], [7]

sysconfig

syslog

tabnanny

tarfile

telnetlib

tempfile

termios

test

test.support

test.support.bytecode_helper

test.support.import_helper

test.support.os_helper

test.support.script_helper

test.support.socket_helper

test.support.threading_helper

test.support.warnings_helper

textwrap

threading

time

timeit

tkinter

tkinter.colorchooser

tkinter.commondialog

tkinter.dnd

tkinter.filedialog

tkinter.font

tkinter.messagebox

tkinter.scrolledtext

tkinter.simpledialog

tkinter.tix

tkinter.ttk

token

tokenize

trace

traceback

tracemalloc

tty

turtle

turtledemo

types, [1]

typing

unicodedata

unittest

unittest.mock

urllib

urllib.error

urllib.parse

urllib.request, [1]

urllib.response

urllib.robotparser

usercustomize

uu, [1]

uuid

venv

warnings

wave

weakref

webbrowser

winreg

winsound

wsgiref

wsgiref.handlers

wsgiref.headers

wsgiref.simple_server

wsgiref.util

wsgiref.validate

xdrlib

xml

xml.dom

xml.dom.minidom

xml.dom.pulldom

xml.etree.ElementTree

xml.parsers.expat

xml.parsers.expat.errors

xml.parsers.expat.model

xml.sax

xml.sax.handler

xml.sax.saxutils

xml.sax.xmlreader

xmlrpc.client

xmlrpc.server

zipapp

zipfile

zipimport

zlib

zoneinfo

索引 – 环

环境变量

%APPDATA%

__PYVENV_LAUNCHER__, [1]

APPDATA

AUDIODEV

BASECFLAGS

BASECPPFLAGS

BLDSHARED

BROWSER, [1]

CC, [1]

CCSHARED

CFLAGS, [1], [2], [3], [4], [5], [6], [7], [8]

CFLAGS_ALIASING

CFLAGS_NODIST, [1], [2], [3]

CFLAGSFORSHARED

COLS, [1]

COLUMNS, [1]

COMSPEC, [1]

CONFIGURE_CFLAGS

CONFIGURE_CFLAGS_NODIST

CONFIGURE_CPPFLAGS

CONFIGURE_LDFLAGS

CONFIGURE_LDFLAGS_NODIST

CPP

CPPFLAGS, [1], [2], [3], [4]

CXX

DISPLAY

DISTUTILS_DEBUG

EnableControlFlowGuard

EXTRA_CFLAGS

HOME, [1], [2], [3], [4], [5], [6], [7], [8], [9]

HOMEDRIVE, [1]

HOMEPATH, [1]

http_proxy, [1], [2]

IDLESTARTUP

KDEDIR

LANG, [1], [2], [3], [4]

LANGUAGE, [1]

LC_ALL, [1]

LC_MESSAGES, [1]

LDCXXSHARED

LDFLAGS, [1], [2], [3], [4], [5], [6], [7], [8]

LDFLAGS_NODIST, [1], [2]

LDSHARED

LIBS

LINES, [1], [2], [3], [4]

LINKCC

LNAME

LOGNAME, [1]

MAINCC

MIXERDEV

no_proxy

OPT, [1]

PAGER

PATH, [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], [31], [32], [33], [34], [35], [36], [37], [38], [39], [40]

PATHEXT, [1], [2]

PIP_USER

PLAT

POSIXLY_CORRECT

PROFILE_TASK, [1]

PURIFY

PY_BUILTIN_MODULE_CFLAGS

PY_CFLAGS

PY_CFLAGS_NODIST

PY_CORE_CFLAGS

PY_CORE_LDFLAGS

PY_CPPFLAGS

PY_LDFLAGS

PY_LDFLAGS_NODIST

PY_PYTHON

PY_STDMODULE_CFLAGS

PYTHON*, [1], [2], [3], [4], [5], [6]

PYTHON_DOM

PYTHONASYNCIODEBUG, [1], [2], [3]

PYTHONBREAKPOINT, [1], [2], [3], [4]

PYTHONCASEOK, [1], [2], [3], [4]

PYTHONCOERCECLOCALE, [1], [2], [3], [4]

PYTHONDEBUG, [1], [2], [3]

PYTHONDEVMODE, [1], [2]

PYTHONDOCS

PYTHONDONTWRITEBYTECODE, [1], [2], [3], [4], [5], [6], [7]

PYTHONDUMPREFS, [1], [2], [3], [4], [5]

PYTHONEXECUTABLE, [1]

PYTHONFAULTHANDLER, [1], [2], [3], [4]

PYTHONHASHSEED, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PYTHONHOME, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16], [17]

PYTHONINSPECT, [1], [2], [3], [4]

PYTHONINTMAXSTRDIGITS, [1], [2], [3], [4], [5]

PYTHONIOENCODING, [1], [2], [3], [4], [5], [6], [7], [8]

PYTHONLEGACYWINDOWSFSENCODING, [1], [2], [3], [4]

PYTHONLEGACYWINDOWSSTDIO, [1], [2], [3], [4], [5]

PYTHONMALLOC, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

PYTHONMALLOC`（例如：``PYTHONMALLOC=malloc`

PYTHONMALLOCSTATS, [1], [2], [3]

PYTHONNOUSERSITE, [1], [2], [3], [4]

PYTHONOPTIMIZE, [1], [2], [3]

PYTHONPATH, [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]

PYTHONPLATLIBDIR, [1], [2]

PYTHONPROFILEIMPORTTIME, [1], [2], [3], [4]

PYTHONPYCACHEPREFIX, [1], [2], [3], [4], [5]

PYTHONREGRTEST_UNICODE_GUARD

PYTHONSHOWALLOCCOUNT

PYTHONSHOWREFCOUNT

PYTHONSTARTUP, [1], [2], [3], [4], [5], [6], [7], [8]

PYTHONTHREADDEBUG, [1], [2], [3]

PYTHONTRACEMALLOC, [1], [2], [3], [4]

PYTHONTZPATH, [1]

PYTHONUNBUFFERED, [1], [2], [3], [4], [5]

PYTHONUSERBASE, [1], [2], [3]

PYTHONUSERSITE

PYTHONUTF8, [1], [2], [3], [4], [5], [6], [7], [8]

PYTHONVERBOSE, [1], [2], [3]

PYTHONWARNDEFAULTENCODING, [1], [2], [3], [4]

PYTHONWARNINGS, [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13]

SOURCE_DATE_EPOCH, [1], [2], [3], [4], [5], [6]

SSLKEYLOGFILE, [1]

SystemRoot

TCL_LIBRARY

TEMP, [1]

TERM, [1]

TK_LIBRARY

TMP

TMPDIR

TZ, [1], [2], [3], [4], [5]

USER

USER_BASE

USERNAME, [1], [2]

USERPROFILE, [1], [2], [3], [4]

索引 – 符号

! (exclamation)

in a command interpreter

in curses module

in formatted string literal

in glob-style wildcards, [1]

in string formatting

in struct format strings

! (pdb command)

! patterns

!=

运算符, [1]

" (double quote)

string literal

"""

string literal

# (hash)

comment, [1], [2]

in doctests

in printf-style formatting, [1]

in regular expressions

in string formatting

source encoding declaration

$ (dollar)

environment variables expansion

in regular expressions

in template strings

interpolation in configuration files

% (percent)

datetime format, [1], [2]

environment variables expansion (Windows), [1]

interpolation in configuration files

printf-style formatting, [1]

运算符, [1]

%=

augmented assignment

%APPDATA%

& (ampersand)

运算符, [1]

&=

augmented assignment

' (single quote)

string literal

'''

string literal

() (parentheses)

call

class definition

function definition

generator expression

in assignment target list

in printf-style formatting, [1]

in regular expressions

tuple display

(?

in regular expressions

(?!

in regular expressions

(?#

in regular expressions

(?(

in regular expressions

(?:

in regular expressions

(?<!

in regular expressions

(?<=

in regular expressions

(?=

in regular expressions

(?P<

in regular expressions

(?P=

in regular expressions

* (asterisk)

function definition

import statement

in argparse module

in assignment target list

in AST grammar

in expression lists

in function calls, [1]

in glob-style wildcards, [1]

in printf-style formatting, [1]

in regular expressions

运算符, [1]

**

function definition

in dictionary displays

in function calls, [1]

in glob-style wildcards

运算符, [1]

**=

augmented assignment

*=

augmented assignment

*?

in regular expressions

+ (plus)

binary operator, [1]

in argparse module

in doctests

in printf-style formatting, [1]

in regular expressions

in string formatting

unary operator, [1]

+=

augmented assignment

+?

in regular expressions

, (comma)

argument list

expression list, [1], [2], [3], [4]

identifier list, [1]

import statement

in dictionary displays

in string formatting

in target list

parameter list

slicing

with statement

-

python--m-py_compile command line option

- (minus)

binary operator, [1]

in doctests

in glob-style wildcards, [1]

in printf-style formatting, [1]

in regular expressions

in string formatting

unary operator, [1]

--annotate

pickletools command line option

--best

gzip command line option

--buffer

unittest command line option

--catch

unittest command line option

--check-hash-based-pycs default|always|never

command line option

--compact

json.tool command line option

--compress

zipapp command line option

--count

trace command line option

--coverdir=<dir>

trace command line option

--create <tarfile> <source1> ... <sourceN>

tarfile command line option

--create <zipfile> <source1> ... <sourceN>

zipfile command line option

--decompress

gzip command line option

--details

inspect command line option

--disable-ipv6

command line option

--disable-test-modules

command line option

--enable-big-digits=[15|30]

command line option

--enable-framework

command line option

--enable-framework=INSTALLDIR

command line option

--enable-loadable-sqlite-extensions

command line option

--enable-optimizations

command line option

--enable-profiling

command line option

--enable-shared

command line option

--enable-universalsdk

command line option

--enable-universalsdk=SDKDIR

command line option

--exact

tokenize command line option

--exec-prefix=EPREFIX

command line option

--extract <tarfile> [<output_dir>]

tarfile command line option

--extract <zipfile> <output_dir>

zipfile command line option

--failfast

unittest command line option

--fast

gzip command line option

--file=<file>

trace command line option

--filter <filtername>

tarfile command line option

--hardlink-dupes

compileall command line option

--help

ast command line option

command line option

gzip command line option

json.tool command line option

timeit command line option

tokenize command line option

trace command line option

zipapp command line option

--ignore-dir=<dir>

trace command line option

--ignore-module=<mod>

trace command line option

--include-attributes

ast command line option

--indent

json.tool command line option

--indent <indent>

ast command line option

--indentlevel=<num>

pickletools command line option

--info

zipapp command line option

--invalidation-mode [timestamp|checked-hash|unchecked-hash]

compileall command line option

--json-lines

json.tool command line option

--list <tarfile>

tarfile command line option

--list <zipfile>

zipfile command line option

--listfuncs

trace command line option

--locals

unittest command line option

--main=<mainfn>

zipapp command line option

--memo

pickletools command line option

--missing

trace command line option

--mode <mode>

ast command line option

--no-ensure-ascii

json.tool command line option

--no-indent

json.tool command line option

--no-report

trace command line option

--no-type-comments

ast command line option

--number=N

timeit command line option

--output=<file>

pickletools command line option

--output=<output>

zipapp command line option

--pattern pattern

unittest-discover command line option

--preamble=<preamble>

pickletools command line option

--prefix=PREFIX

command line option

--process

timeit command line option

--python=<interpreter>

zipapp command line option

--quiet

python--m-py_compile command line option

--repeat=N

timeit command line option

--report

trace command line option

--setup=S

timeit command line option

--sort-keys

json.tool command line option

--start-directory directory

unittest-discover command line option

--summary

trace command line option

--tab

json.tool command line option

--test <tarfile>

tarfile command line option

--test <zipfile>

zipfile command line option

--timing

trace command line option

--top-level-directory directory

unittest-discover command line option

--trace

trace command line option

--trackcalls

trace command line option

--unit=U

timeit command line option

--user-base

site command line option

--user-site

site command line option

--verbose

tarfile command line option

timeit command line option

unittest-discover command line option

--version

command line option

trace command line option

--with-address-sanitizer

command line option

--with-assertions

command line option

--with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2

command line option

--with-computed-gotos

command line option

--with-cxx-main

command line option

--with-cxx-main=COMPILER

command line option

--with-dbmliborder=db1:db2:...

command line option

--with-dtrace

command line option

--with-ensurepip=[upgrade|install|no]

command line option

--with-framework-name=FRAMEWORK

command line option

--with-hash-algorithm=[fnv|siphash24]

command line option

--with-libc=STRING

command line option

--with-libm=STRING

command line option

--with-libs='lib1 ...'

command line option

--with-lto

command line option

--with-memory-sanitizer

command line option

--with-openssl-rpath=[no|auto|DIR]

command line option

--with-openssl=DIR

command line option

--with-platlibdir=DIRNAME

command line option

--with-pydebug

command line option

--with-readline=editline

command line option

--with-ssl-default-suites=[python|openssl|STRING]

command line option

--with-suffix=SUFFIX

command line option

--with-system-expat

command line option

--with-system-ffi

command line option

--with-system-libmpdec

command line option

--with-tcltk-includes='-I...'

command line option

--with-tcltk-libs='-L...'

command line option

--with-trace-refs

command line option

--with-tzpath=<list of absolute paths separated by pathsep>

command line option

--with-undefined-behavior-sanitizer

command line option

--with-universal-archs=ARCH

command line option

--with-valgrind

command line option

--with-wheel-pkg-dir=PATH

command line option

--without-c-locale-coercion

command line option

--without-decimal-contextvar

command line option

--without-doc-strings

command line option

--without-pymalloc

command line option

--without-readline

command line option

--without-static-libpython

command line option

-=

augmented assignment

->

function annotations, [1]

-?

command line option

-a

ast command line option

pickletools command line option

-B

command line option

-b

command line option

compileall command line option

unittest command line option

-C

trace command line option

-c

trace command line option

unittest command line option

zipapp command line option

-c <command>

command line option

-c <tarfile> <source1> ... <sourceN>

tarfile command line option

-c <zipfile> <source1> ... <sourceN>

zipfile command line option

-d

command line option

gzip command line option

-d destdir

compileall command line option

-E

command line option

-e

tokenize command line option

-e <tarfile> [<output_dir>]

tarfile command line option

-e <zipfile> <output_dir>

zipfile command line option

-e dir

compileall command line option

-f

compileall command line option

trace command line option

unittest command line option

-g

trace command line option

-h

ast command line option

command line option

gzip command line option

json.tool command line option

timeit command line option

tokenize command line option

zipapp command line option

-I

command line option

-i

command line option

-i <indent>

ast command line option

-i list

compileall command line option

-J

command line option

-j N

compileall command line option

-k

unittest command line option

-l

compileall command line option

pickletools command line option

trace command line option

-l <tarfile>

tarfile command line option

-l <zipfile>

zipfile command line option

-m

pickletools command line option

trace command line option

-m <mainfn>

zipapp command line option

-m <mode>

ast command line option

-m <module-name>

command line option

-n N

timeit command line option

-O

command line option

-o

pickletools command line option

-o <output>

zipapp command line option

-o level

compileall command line option

-OO

command line option

-p

pickletools command line option

timeit command line option

unittest-discover command line option

-p <interpreter>

zipapp command line option

-p prepend_prefix

compileall command line option

-q

command line option

compileall command line option

python--m-py_compile command line option

-R

command line option

trace command line option

-r

compileall command line option

trace command line option

-r N

timeit command line option

-S

command line option

-s

command line option

trace command line option

unittest-discover command line option

-s S

timeit command line option

-s strip_prefix

compileall command line option

-T

trace command line option

-t

trace command line option

unittest-discover command line option

-t <tarfile>

tarfile command line option

-t <zipfile>

zipfile command line option

-u

command line option

timeit command line option

-V

command line option

-v

command line option

tarfile command line option

timeit command line option

unittest-discover command line option

-W arg

command line option

-X

command line option

-x

command line option

-x regex

compileall command line option

. (dot)

attribute reference

in glob-style wildcards

in numeric literal

in pathnames, [1]

in printf-style formatting, [1]

in regular expressions

in string formatting

..

in pathnames

...

ellipsis literal, [1], [2]

in doctests

interpreter prompt, [1]

placeholder, [1], [2]

.ini

file

.pdbrc

file

/ (slash)

function definition

in pathnames, [1]

运算符, [1]

//

运算符, [1]

//=

augmented assignment

/=

augmented assignment

0b

integer literal

0o

integer literal

0x

integer literal

2-digit years

2to3

: (colon)

annotated variable

compound statement, [1], [2], [3], [4], [5], [6], [7]

function annotations, [1]

in dictionary expressions

in formatted string literal

in SQL statements

in string formatting

lambda expression

path separator (POSIX)

slicing

:= (colon equals)

; (semicolon), [1]

< (less)

in string formatting

in struct format strings

运算符, [1]

<<

运算符, [1]

<<=

augmented assignment

<=

运算符, [1]

<BLANKLINE>

<file> ... <fileN>

python--m-py_compile command line option

= (equals)

assignment statement

class definition

for help in debugging using string literals

function definition

in function calls

in string formatting

in struct format strings

==

运算符, [1]

> (greater)

in string formatting

in struct format strings

运算符, [1]

>=

运算符, [1]

>>

运算符, [1]

>>=

augmented assignment

>>>

interpreter prompt, [1]

? (question mark)

in a command interpreter

in argparse module

in AST grammar

in glob-style wildcards, [1]

in regular expressions

in SQL statements

in struct format strings, [1]

replacement character

??

in regular expressions

@ (at)

class definition

function definition

in struct format strings

运算符

[] (square brackets)

in assignment target list

in glob-style wildcards, [1]

in regular expressions

in string formatting

list expression

subscription

\ (backslash)

escape sequence, [1]

in pathnames (Windows)

in regular expressions, [1], [2]

\\

escape sequence

in regular expressions

\A

in regular expressions

\a

escape sequence

in regular expressions

\B

in regular expressions

\b

escape sequence

in regular expressions, [1]

\D

in regular expressions

\d

in regular expressions

\f

escape sequence

in regular expressions

\g

in regular expressions

\N

escape sequence, [1]

in regular expressions

\n

escape sequence

in regular expressions

\r

escape sequence

in regular expressions

\S

in regular expressions

\s

in regular expressions

\t

escape sequence

in regular expressions

\U

escape sequence, [1]

in regular expressions

\u

escape sequence, [1]

in regular expressions

\v

escape sequence

in regular expressions

\W

in regular expressions

\w

in regular expressions

\x

escape sequence, [1]

in regular expressions

\Z

in regular expressions

^ (caret)

in curses module

in regular expressions, [1]

in string formatting

marker, [1]

运算符, [1]

^=

augmented assignment

{} (curly brackets)

dictionary expression

in formatted string literal

in regular expressions

in string formatting

set expression

| (vertical bar)

in regular expressions

运算符, [1]

|=

augmented assignment

~ (tilde)

home directory expansion

运算符, [1]

索引 – 语

语句

assert, [1]

async def

async for

async with

break, [1], [2], [3], [4]

class

continue, [1], [2], [3], [4]

def

del, [1], [2], [3]

except

for, [1], [2], [3]

global, [1]

if, [1]

import, [1], [2], [3], [4]

match

nonlocal

pass

raise, [1]

return, [1], [2]

try, [1], [2]

while, [1], [2], [3]

with, [1]

yield

索引 – 运

运算符

!=, [1]

% (percent), [1]

& (ampersand), [1]

* (asterisk), [1]

, [1]

/ (slash), [1]

//, [1]

< (less), [1]

<<, [1]

<=, [1]

==, [1]

> (greater), [1]

>=, [1]

>>, [1]

@ (at)

^ (caret), [1]

| (vertical bar), [1]

~ (tilde), [1]

and, [1], [2]

in, [1], [2]

is, [1]

is not, [1]

not, [1]

not in, [1], [2]

or, [1], [2]

Python 3.10.20 文档

欢迎！这里是 Python 3.10.20 的官方文档。

按章节浏览文档：

Python 3.10 有什么新变化？
或显示自 2.0 以来的全部新变化

教程
从这里看起

标准库参考
放在枕边作为参考

语言参考
讲解基础内容和基本语法

Python安装和使用
各种操作系统的介绍都有

Python 指南
深入了解特定主题

安装 Python 模块
从官方的 PyPI 或者其他来源安装模块

分发 Python 模块
发布模块，供其他人安装

扩展和嵌入
给 C/C++ 程序员的教程

Python/C API 接口
给 C/C++ 程序员的参考手册

常见问题
经常被问到的问题（答案也有！）

索引和表格：

全局模块索引
快速查找所有的模块

总目录
所有的函数、类、术语

术语对照表
解释最重要的术语

搜索页
搜索本文档

完整目录
列出所有的章节和子章节

元信息：

报告 Bug 向文档提交贡献 关于本文档 | Python 的历史和许可证 版权所有

注解

这篇文档是历史遗留文档，在 https://setuptools.readthedocs.io/en/latest/setuptools.html 上的 setuptools 文档独立涵盖此处包含的所有相关信息之后，将不再单独作为正式文档保留。

Python 包索引（PyPI）

Python 包索引 (PyPI) [https://pypi.org] 存储描述与 distutils 和其他发布工具一起打包的发行版的元数据，以及分发存档本身。

供参考的最新 PyPI 文档可以在 阅读 Python 打包用户指南 找到。

上传包到包索引

供参考的最新 PyPI 文档可以在 阅读 Python 打包用户指南 找到。